diff --git a/generated/addons/log.out b/generated/addons/log.out index c863282943..fc8dd0a4dd 100644 --- a/generated/addons/log.out +++ b/generated/addons/log.out @@ -3,22 +3,22 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Installing AutoRest extension '@autorest/modelerfour' (* -> 4.23.5) -info | Installed AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Installing AutoRest extension '@autorest/modelerfour' (* -> 4.23.6) +info | Installed AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.addons-2018-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.addons/supportproviders/supportplantypes under path '/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}' has no body defined. -info | autorest.bicep took 12ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.addons-2017-05-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CanonicalSupportPlanStatusItem' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json:300:7 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.addons/supportproviders/supportplantypes under path '/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}' has no body defined. -info | autorest.bicep took 2ms -info | Autorest completed in 7.65s. 4 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 6.74s. 4 files generated. diff --git a/generated/addons/microsoft.addons/2018-03-01/types.md b/generated/addons/microsoft.addons/2018-03-01/types.md index e79b7b5355..4c3aa097bd 100644 --- a/generated/addons/microsoft.addons/2018-03-01/types.md +++ b/generated/addons/microsoft.addons/2018-03-01/types.md @@ -14,13 +14,13 @@ * **ApiVersion**: 2018-03-01 * **Output**: [CanonicalSupportPlanInfoDefinition](#canonicalsupportplaninfodefinition)[] -## CanonicalSupportPlanProperties -### Properties -* **provisioningState**: 'Cancelled' | 'Cancelling' | 'Downgrading' | 'Failed' | 'Purchasing' | 'Succeeded' | 'Upgrading' | string (ReadOnly): The provisioning state of the resource. - ## CanonicalSupportPlanInfoDefinition ### Properties * **enabled**: bool (ReadOnly): Flag to indicate if this support plan type is currently enabled for the subscription. * **oneTimeCharge**: 'no' | 'onEnabled' | 'onReenabled' | string (ReadOnly): The one time charge status for the subscription. * **supportPlanType**: 'advanced' | 'essential' | 'standard' | string (ReadOnly): Support plan type. +## CanonicalSupportPlanProperties +### Properties +* **provisioningState**: 'Cancelled' | 'Cancelling' | 'Downgrading' | 'Failed' | 'Purchasing' | 'Succeeded' | 'Upgrading' | string (ReadOnly): The provisioning state of the resource. + diff --git a/generated/adp/log.out b/generated/adp/log.out index ad674e1b2a..d8f35a222c 100644 --- a/generated/adp/log.out +++ b/generated/adp/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.autonomousdevelopmentplatform-2020-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Tags' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json:605:5 @@ -33,10 +33,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefi warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json:1003:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.autonomousdevelopmentplatform-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AccountCheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json:650:5 @@ -46,8 +46,8 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.autonomousdevelopmentplatform-2021-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 8.11s. 6 files generated. +info | Autorest completed in 7.64s. 6 files generated. diff --git a/generated/adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.md b/generated/adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.md index e38127b033..df03d70354 100644 --- a/generated/adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.md +++ b/generated/adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.md @@ -26,6 +26,17 @@ * **accountId**: string (ReadOnly): The account's data-plane ID * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called. +## DataPoolLocation +### Properties +* **name**: string (Required): The location name + +## DataPoolProperties +### Properties +* **dataPoolId**: string (ReadOnly): The Data Pool's data-plane ID +* **locations**: [DataPoolLocation](#datapoollocation)[]: Gets or sets the collection of locations where Data Pool resources should be created. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -40,14 +51,3 @@ ### Additional Properties * **Additional Properties Type**: string -## DataPoolProperties -### Properties -* **dataPoolId**: string (ReadOnly): The Data Pool's data-plane ID -* **locations**: [DataPoolLocation](#datapoollocation)[]: Gets or sets the collection of locations where Data Pool resources should be created. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. - -## DataPoolLocation -### Properties -* **name**: string (Required): The location name - diff --git a/generated/adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.md b/generated/adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.md index 99d5eb3ebe..7a3543cb6e 100644 --- a/generated/adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.md +++ b/generated/adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.md @@ -26,19 +26,17 @@ * **accountId**: string (ReadOnly): The account's data-plane ID * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called -## SystemData +## DataPoolEncryption ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **keyName**: string (Required): The name of Key Vault key +* **keyVaultUri**: string (Required): The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location +* **keyVersion**: string: The version of Key Vault key +* **userAssignedIdentity**: string (Required): The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover -## TrackedResourceTags +## DataPoolLocation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **encryption**: [DataPoolEncryption](#datapoolencryption): Encryption properties of a Data Pool +* **name**: string (Required): The location name ## DataPoolProperties ### Properties @@ -47,15 +45,17 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -## DataPoolLocation +## SystemData ### Properties -* **encryption**: [DataPoolEncryption](#datapoolencryption): Encryption properties of a Data Pool -* **name**: string (Required): The location name +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DataPoolEncryption +## TrackedResourceTags ### Properties -* **keyName**: string (Required): The name of Key Vault key -* **keyVaultUri**: string (Required): The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location -* **keyVersion**: string: The version of Key Vault key -* **userAssignedIdentity**: string (Required): The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.md b/generated/adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.md index b2ebf4f9ac..8ea11155c7 100644 --- a/generated/adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.md +++ b/generated/adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.md @@ -27,19 +27,19 @@ * **accountId**: string (ReadOnly): The account's data-plane ID * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called -## SystemData +## DataPoolEncryption ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **keyName**: string (Required): The name of Key Vault key +* **keyVaultUri**: string (Required): The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location +* **keyVersion**: string: The version of Key Vault key +* **userAssignedIdentity**: string (Required): The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover -## TrackedResourceTags +## DataPoolLocation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **encryption**: [DataPoolEncryption](#datapoolencryption): Encryption properties of a Data Pool +* **name**: string (Required): The location name +* **storageAccountCount**: int: The amount of storage accounts provisioned per Data Pool. Default: 5 +* **storageSku**: [StorageSku](#storagesku): The Storage SKU. ## DataPoolProperties ### Properties @@ -48,25 +48,25 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called * **tags**: [Tags](#tags): Resource tags -## DataPoolLocation +## StorageSku ### Properties -* **encryption**: [DataPoolEncryption](#datapoolencryption): Encryption properties of a Data Pool -* **name**: string (Required): The location name -* **storageAccountCount**: int: The amount of storage accounts provisioned per Data Pool. Default: 5 -* **storageSku**: [StorageSku](#storagesku): The Storage SKU. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_Gzrs' | 'Standard_LRS' | 'Standard_Ragrs' | 'Standard_Ragzrs' | 'Standard_ZRS' | string (Required): The SKU name -## DataPoolEncryption +## SystemData ### Properties -* **keyName**: string (Required): The name of Key Vault key -* **keyVaultUri**: string (Required): The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location -* **keyVersion**: string: The version of Key Vault key -* **userAssignedIdentity**: string (Required): The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## StorageSku +## Tags ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_Gzrs' | 'Standard_LRS' | 'Standard_Ragrs' | 'Standard_Ragzrs' | 'Standard_ZRS' | string (Required): The SKU name +### Additional Properties +* **Additional Properties Type**: string -## Tags +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/advisor/log.out b/generated/advisor/log.out index c6986115e6..2ce20e0e7a 100644 --- a/generated/advisor/log.out +++ b/generated/advisor/log.out @@ -3,30 +3,30 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.advisor-2022-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.advisor-2020-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.advisor-2020-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/advisor/resource-manager/Microsoft.Advisor/stable/2020-01-01/advisor.json:1189:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.advisor-2017-04-19"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/advisor.json:936:5 @@ -36,7 +36,7 @@ warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourc info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.advisor-2017-03-31"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/advisor.json:515:5 @@ -44,10 +44,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.advisor-2016-07-12-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json:526:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 11.24s. 8 files generated. +info | Autorest completed in 10.88s. 8 files generated. diff --git a/generated/agrifood/log.out b/generated/agrifood/log.out index b59989f2a4..8ba023e3a1 100644 --- a/generated/agrifood/log.out +++ b/generated/agrifood/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.agfoodplatform-2020-05-12-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16,9 +16,9 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.agfoodplatform/farmbeats/extensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}' has no body defined. info | autorest.bicep took 11ms -info | Autorest completed in 5.09s. 2 files generated. +info | Autorest completed in 4.8s. 2 files generated. diff --git a/generated/agrifood/microsoft.agfoodplatform/2020-05-12-preview/types.md b/generated/agrifood/microsoft.agfoodplatform/2020-05-12-preview/types.md index a5f34e29d8..c5146de040 100644 --- a/generated/agrifood/microsoft.agfoodplatform/2020-05-12-preview/types.md +++ b/generated/agrifood/microsoft.agfoodplatform/2020-05-12-preview/types.md @@ -23,6 +23,14 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.AgFoodPlatform/farmBeats/extensions' (ReadOnly, DeployTimeConstant): The resource type +## ExtensionProperties +### Properties +* **extensionApiDocsLink**: string (ReadOnly): Extension api docs link. +* **extensionAuthLink**: string (ReadOnly): Extension auth link. +* **extensionCategory**: string (ReadOnly): Extension category. e.g. weather/sensor/satellite. +* **extensionId**: string (ReadOnly): Extension Id. +* **installedExtensionVersion**: string (ReadOnly): Installed extension version. + ## FarmBeatsProperties ### Properties * **instanceUri**: string (ReadOnly): Uri of the FarmBeats instance. @@ -42,11 +50,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ExtensionProperties -### Properties -* **extensionApiDocsLink**: string (ReadOnly): Extension api docs link. -* **extensionAuthLink**: string (ReadOnly): Extension auth link. -* **extensionCategory**: string (ReadOnly): Extension category. e.g. weather/sensor/satellite. -* **extensionId**: string (ReadOnly): Extension Id. -* **installedExtensionVersion**: string (ReadOnly): Installed extension version. - diff --git a/generated/alertsmanagement/log.out b/generated/alertsmanagement/log.out index 28e0395eb4..379f9017f9 100644 --- a/generated/alertsmanagement/log.out +++ b/generated/alertsmanagement/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.alertsmanagement-2021-08-08"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'errorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-08-08/AlertProcessingRules.json:392:5 @@ -30,7 +30,7 @@ info | Processing batch task - {"tag":"microsoft.alertsmanagement-2019-05-05- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json:684:5 @@ -88,7 +88,7 @@ info | Processing batch task - {"tag":"microsoft.alertsmanagement-2021-08-08- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'errorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertProcessingRules.json:392:5 @@ -103,12 +103,12 @@ warning | PreCheck/SchemaMissingType | The schema 'PatchProperties' with an unde warning | PreCheck/SchemaMissingType | The schema 'PatchObject' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertProcessingRules.json:806:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.alertsmanagement-2019-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json:726:5 @@ -173,7 +173,7 @@ info | Processing batch task - {"tag":"microsoft.alertsmanagement-2021-04-01" warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ActionGroupsInformation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2021-04-01/SmartDetectorAlertRulesApi.json:340:5 @@ -198,7 +198,7 @@ info | Processing batch task - {"tag":"microsoft.alertsmanagement-2021-01-01- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-01-01-preview/AlertsManagement.json:57:5 @@ -209,12 +209,12 @@ warning | PreCheck/SchemaMissingType | The schema 'SmartDetectionMigrationReques warning | PreCheck/SchemaMissingType | The schema 'MigrationStatusResponseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-01-01-preview/MigrateFromSmartDetections.json:154:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.alertsmanagement-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ActionGroupsInformation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json:329:5 @@ -234,12 +234,12 @@ warning | PreCheck/SchemaMissingType | The schema 'AlertRulePatchProperties' wit - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json:569:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.alertsmanagement-2018-05-05"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json:866:5 @@ -277,7 +277,7 @@ info | Processing batch task - {"tag":"microsoft.alertsmanagement-2018-05-05- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json:761:5 @@ -321,4 +321,4 @@ warning | PreCheck/SchemaMissingType | The schema 'smartGroup' with an undefined - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json:1473:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 18.84s. 12 files generated. +info | Autorest completed in 17.89s. 12 files generated. diff --git a/generated/alertsmanagement/microsoft.alertsmanagement/2019-03-01/types.md b/generated/alertsmanagement/microsoft.alertsmanagement/2019-03-01/types.md index 4b0ad3c998..38ef382b55 100644 --- a/generated/alertsmanagement/microsoft.alertsmanagement/2019-03-01/types.md +++ b/generated/alertsmanagement/microsoft.alertsmanagement/2019-03-01/types.md @@ -9,6 +9,12 @@ * **properties**: [AlertRuleProperties](#alertruleproperties): The alert rule properties. * **type**: 'microsoft.alertsManagement/smartDetectorAlertRules' (ReadOnly, DeployTimeConstant): The resource type +## ActionGroupsInformation +### Properties +* **customEmailSubject**: string: An optional custom email subject to use in email notifications. +* **customWebhookPayload**: string: An optional custom web-hook payload to use in web-hook notifications. +* **groupIds**: string[] (Required): The Action Group resource IDs. + ## AlertRuleProperties ### Properties * **actionGroups**: [ActionGroupsInformation](#actiongroupsinformation) (Required): The Action Groups information, used by the alert rule. @@ -20,12 +26,6 @@ * **state**: 'Disabled' | 'Enabled' | string (Required): The alert rule state. * **throttling**: [ThrottlingInformation](#throttlinginformation): Optional throttling information for the alert rule. -## ActionGroupsInformation -### Properties -* **customEmailSubject**: string: An optional custom email subject to use in email notifications. -* **customWebhookPayload**: string: An optional custom web-hook payload to use in web-hook notifications. -* **groupIds**: string[] (Required): The Action Group resource IDs. - ## Detector ### Properties * **description**: string: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector diff --git a/generated/alertsmanagement/microsoft.alertsmanagement/2019-05-05-preview/types.md b/generated/alertsmanagement/microsoft.alertsmanagement/2019-05-05-preview/types.md index 976f1ed7e6..e39f339c82 100644 --- a/generated/alertsmanagement/microsoft.alertsmanagement/2019-05-05-preview/types.md +++ b/generated/alertsmanagement/microsoft.alertsmanagement/2019-05-05-preview/types.md @@ -38,6 +38,11 @@ * **type**: 'Suppression' (Required): Indicates type of action rule +## Condition +### Properties +* **operator**: 'Contains' | 'DoesNotContain' | 'Equals' | 'NotEquals' | string: operator for a given condition +* **values**: string[]: list of values to match for a given condition. + ## Conditions ### Properties * **alertContext**: [Condition](#condition): condition to trigger an action rule @@ -48,10 +53,10 @@ * **severity**: [Condition](#condition): condition to trigger an action rule * **targetResourceType**: [Condition](#condition): condition to trigger an action rule -## Condition +## ManagedResourceTags ### Properties -* **operator**: 'Contains' | 'DoesNotContain' | 'Equals' | 'NotEquals' | string: operator for a given condition -* **values**: string[]: list of values to match for a given condition. +### Additional Properties +* **Additional Properties Type**: string ## Scope ### Properties @@ -71,8 +76,3 @@ * **startDate**: string: Start date for suppression * **startTime**: string: Start time for suppression -## ManagedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/alertsmanagement/microsoft.alertsmanagement/2019-06-01/types.md b/generated/alertsmanagement/microsoft.alertsmanagement/2019-06-01/types.md index 80c11fc9c0..29d352f9b9 100644 --- a/generated/alertsmanagement/microsoft.alertsmanagement/2019-06-01/types.md +++ b/generated/alertsmanagement/microsoft.alertsmanagement/2019-06-01/types.md @@ -11,6 +11,12 @@ * **tags**: [AzureResourceTags](#azureresourcetags): The resource tags. * **type**: 'microsoft.alertsManagement/smartDetectorAlertRules' (ReadOnly, DeployTimeConstant): The resource type +## ActionGroupsInformation +### Properties +* **customEmailSubject**: string: An optional custom email subject to use in email notifications. +* **customWebhookPayload**: string: An optional custom web-hook payload to use in web-hook notifications. +* **groupIds**: string[] (Required): The Action Group resource IDs. + ## AlertRuleProperties ### Properties * **actionGroups**: [ActionGroupsInformation](#actiongroupsinformation) (Required): The Action Groups information, used by the alert rule. @@ -22,11 +28,10 @@ * **state**: 'Disabled' | 'Enabled' | string (Required): The alert rule state. * **throttling**: [ThrottlingInformation](#throttlinginformation): Optional throttling information for the alert rule. -## ActionGroupsInformation +## AzureResourceTags ### Properties -* **customEmailSubject**: string: An optional custom email subject to use in email notifications. -* **customWebhookPayload**: string: An optional custom web-hook payload to use in web-hook notifications. -* **groupIds**: string[] (Required): The Action Group resource IDs. +### Additional Properties +* **Additional Properties Type**: string ## Detector ### Properties @@ -46,8 +51,3 @@ ### Properties * **duration**: string: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes -## AzureResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/alertsmanagement/microsoft.alertsmanagement/2021-04-01/types.md b/generated/alertsmanagement/microsoft.alertsmanagement/2021-04-01/types.md index 83310f2ade..736947bf93 100644 --- a/generated/alertsmanagement/microsoft.alertsmanagement/2021-04-01/types.md +++ b/generated/alertsmanagement/microsoft.alertsmanagement/2021-04-01/types.md @@ -11,6 +11,12 @@ * **tags**: [AzureResourceTags](#azureresourcetags): The resource tags. * **type**: 'microsoft.alertsManagement/smartDetectorAlertRules' (ReadOnly, DeployTimeConstant): The resource type +## ActionGroupsInformation +### Properties +* **customEmailSubject**: string: An optional custom email subject to use in email notifications. +* **customWebhookPayload**: string: An optional custom web-hook payload to use in web-hook notifications. +* **groupIds**: string[] (Required): The Action Group resource IDs. + ## AlertRuleProperties ### Properties * **actionGroups**: [ActionGroupsInformation](#actiongroupsinformation) (Required): The Action Groups information, used by the alert rule. @@ -22,11 +28,10 @@ * **state**: 'Disabled' | 'Enabled' | string (Required): The alert rule state. * **throttling**: [ThrottlingInformation](#throttlinginformation): Optional throttling information for the alert rule. -## ActionGroupsInformation +## AzureResourceTags ### Properties -* **customEmailSubject**: string: An optional custom email subject to use in email notifications. -* **customWebhookPayload**: string: An optional custom web-hook payload to use in web-hook notifications. -* **groupIds**: string[] (Required): The Action Group resource IDs. +### Additional Properties +* **Additional Properties Type**: string ## Detector ### Properties @@ -56,8 +61,3 @@ ### Properties * **duration**: string: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes -## AzureResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08-preview/types.md b/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08-preview/types.md index b4b7b1b873..c664b4c9bf 100644 --- a/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08-preview/types.md +++ b/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08-preview/types.md @@ -12,15 +12,6 @@ * **tags**: [ManagedResourceTags](#managedresourcetags): Resource tags * **type**: 'Microsoft.AlertsManagement/actionRules' (ReadOnly, DeployTimeConstant): The resource type -## AlertProcessingRuleProperties -### Properties -* **actions**: [Action](#action)[] (Required): Actions to be applied. -* **conditions**: [Condition](#condition)[]: Conditions in alert instance to be matched for a given alert processing rule. Default value is all. Multiple values could be provided with comma separation. -* **description**: string: Description of alert processing rule. -* **enabled**: bool: Indicates if the given alert processing rule is enabled or disabled. -* **schedule**: [Schedule](#schedule): Scheduling configuration for a given alert processing rule. -* **scopes**: string[] (Required): List of ARM IDs which will be the target of the given alert processing rule. - ## Action * **Discriminator**: actionType @@ -35,18 +26,25 @@ * **actionType**: 'RemoveAllActionGroups' (Required): Action that should be applied. +## AlertProcessingRuleProperties +### Properties +* **actions**: [Action](#action)[] (Required): Actions to be applied. +* **conditions**: [Condition](#condition)[]: Conditions in alert instance to be matched for a given alert processing rule. Default value is all. Multiple values could be provided with comma separation. +* **description**: string: Description of alert processing rule. +* **enabled**: bool: Indicates if the given alert processing rule is enabled or disabled. +* **schedule**: [Schedule](#schedule): Scheduling configuration for a given alert processing rule. +* **scopes**: string[] (Required): List of ARM IDs which will be the target of the given alert processing rule. + ## Condition ### Properties * **field**: 'AlertContext' | 'AlertRuleId' | 'AlertRuleName' | 'Description' | 'MonitorCondition' | 'MonitorService' | 'Severity' | 'SignalType' | 'TargetResource' | 'TargetResourceGroup' | 'TargetResourceType' | string: Field for a given condition. * **operator**: 'Contains' | 'DoesNotContain' | 'Equals' | 'NotEquals' | string: Operator for a given condition. * **values**: string[]: List of values to match for a given condition. -## Schedule +## ManagedResourceTags ### Properties -* **effectiveFrom**: string: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. -* **effectiveUntil**: string: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. -* **recurrences**: [Recurrence](#recurrence)[]: List of recurrences. -* **timeZone**: string: Scheduling time zone. +### Additional Properties +* **Additional Properties Type**: string ## Recurrence * **Discriminator**: recurrenceType @@ -69,6 +67,13 @@ * **recurrenceType**: 'Weekly' (Required): Specifies when the recurrence should be applied. +## Schedule +### Properties +* **effectiveFrom**: string: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. +* **effectiveUntil**: string: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. +* **recurrences**: [Recurrence](#recurrence)[]: List of recurrences. +* **timeZone**: string: Scheduling time zone. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -78,8 +83,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ManagedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08/types.md b/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08/types.md index 519b93a2f7..cdc53d676d 100644 --- a/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08/types.md +++ b/generated/alertsmanagement/microsoft.alertsmanagement/2021-08-08/types.md @@ -12,15 +12,6 @@ * **tags**: [ManagedResourceTags](#managedresourcetags): Resource tags * **type**: 'Microsoft.AlertsManagement/actionRules' (ReadOnly, DeployTimeConstant): The resource type -## AlertProcessingRuleProperties -### Properties -* **actions**: [Action](#action)[] (Required): Actions to be applied. -* **conditions**: [Condition](#condition)[]: Conditions in alert instance to be matched for a given alert processing rule. Default value is all. Multiple values could be provided with comma separation. -* **description**: string: Description of alert processing rule. -* **enabled**: bool: Indicates if the given alert processing rule is enabled or disabled. -* **schedule**: [Schedule](#schedule): Scheduling configuration for a given alert processing rule. -* **scopes**: string[] (Required): List of ARM IDs which will be the target of the given alert processing rule. - ## Action * **Discriminator**: actionType @@ -35,18 +26,25 @@ * **actionType**: 'RemoveAllActionGroups' (Required): Action that should be applied. +## AlertProcessingRuleProperties +### Properties +* **actions**: [Action](#action)[] (Required): Actions to be applied. +* **conditions**: [Condition](#condition)[]: Conditions in alert instance to be matched for a given alert processing rule. Default value is all. Multiple values could be provided with comma separation. +* **description**: string: Description of alert processing rule. +* **enabled**: bool: Indicates if the given alert processing rule is enabled or disabled. +* **schedule**: [Schedule](#schedule): Scheduling configuration for a given alert processing rule. +* **scopes**: string[] (Required): List of ARM IDs which will be the target of the given alert processing rule. + ## Condition ### Properties * **field**: 'AlertContext' | 'AlertRuleId' | 'AlertRuleName' | 'Description' | 'MonitorCondition' | 'MonitorService' | 'Severity' | 'SignalType' | 'TargetResource' | 'TargetResourceGroup' | 'TargetResourceType' | string: Field for a given condition. * **operator**: 'Contains' | 'DoesNotContain' | 'Equals' | 'NotEquals' | string: Operator for a given condition. * **values**: string[]: List of values to match for a given condition. -## Schedule +## ManagedResourceTags ### Properties -* **effectiveFrom**: string: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. -* **effectiveUntil**: string: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. -* **recurrences**: [Recurrence](#recurrence)[]: List of recurrences. -* **timeZone**: string: Scheduling time zone. +### Additional Properties +* **Additional Properties Type**: string ## Recurrence * **Discriminator**: recurrenceType @@ -69,6 +67,13 @@ * **recurrenceType**: 'Weekly' (Required): Specifies when the recurrence should be applied. +## Schedule +### Properties +* **effectiveFrom**: string: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. +* **effectiveUntil**: string: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. +* **recurrences**: [Recurrence](#recurrence)[]: List of recurrences. +* **timeZone**: string: Scheduling time zone. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -78,8 +83,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ManagedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/analysisservices/log.out b/generated/analysisservices/log.out index b688adebc6..564a7a30ee 100644 --- a/generated/analysisservices/log.out +++ b/generated/analysisservices/log.out @@ -4,10 +4,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.analysisservices-2017-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json:830:9 @@ -22,10 +22,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorDetail' with an undefine warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json:1533:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.analysisservices-2017-07-14"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationDetail-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json:807:9 @@ -41,7 +41,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.analysisservices-2016-05-16"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationDetail-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json:721:9 @@ -56,4 +56,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AnalysisServicesServer' has a property 'sku' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from AnalysisServicesServer info | autorest.bicep took 1ms -info | Autorest completed in 8.38s. 6 files generated. +info | Autorest completed in 8.33s. 6 files generated. diff --git a/generated/analysisservices/microsoft.analysisservices/2016-05-16/types.md b/generated/analysisservices/microsoft.analysisservices/2016-05-16/types.md index 63f5107816..07fcb4040f 100644 --- a/generated/analysisservices/microsoft.analysisservices/2016-05-16/types.md +++ b/generated/analysisservices/microsoft.analysisservices/2016-05-16/types.md @@ -22,10 +22,6 @@ * **serverMonitorMode**: int: The server monitor mode for AS server * **state**: 'Deleting' | 'Failed' | 'Paused' | 'Pausing' | 'Preparing' | 'Provisioning' | 'Resuming' | 'Scaling' | 'Succeeded' | 'Suspended' | 'Suspending' | 'Updating' | string (ReadOnly): The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. -## ServerAdministrators -### Properties -* **members**: string[]: An array of administrator user identities. - ## ResourceSku ### Properties * **capacity**: int: The number of instances in the read only query pool. @@ -37,3 +33,7 @@ ### Additional Properties * **Additional Properties Type**: string +## ServerAdministrators +### Properties +* **members**: string[]: An array of administrator user identities. + diff --git a/generated/analysisservices/microsoft.analysisservices/2017-07-14/types.md b/generated/analysisservices/microsoft.analysisservices/2017-07-14/types.md index 6c19f0173d..89b674646c 100644 --- a/generated/analysisservices/microsoft.analysisservices/2017-07-14/types.md +++ b/generated/analysisservices/microsoft.analysisservices/2017-07-14/types.md @@ -28,16 +28,16 @@ * **serverMonitorMode**: int: The server monitor mode for AS server * **state**: 'Deleting' | 'Failed' | 'Paused' | 'Pausing' | 'Preparing' | 'Provisioning' | 'Resuming' | 'Scaling' | 'Succeeded' | 'Suspended' | 'Suspending' | 'Updating' | string (ReadOnly): The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. -## ServerAdministrators -### Properties -* **members**: string[]: An array of administrator user identities. - ## GatewayDetails ### Properties * **dmtsClusterUri**: string (ReadOnly): Uri of the DMTS cluster. * **gatewayObjectId**: string (ReadOnly): Gateway object id from in the DMTS cluster for the gateway resource. * **gatewayResourceId**: string: Gateway resource to be associated with the server. +## GatewayListStatusLive +### Properties +* **status**: '0' (ReadOnly): Live message of list gateway. Status: 0 - Live + ## ResourceSku ### Properties * **name**: string (Required): Name of the SKU level. @@ -48,7 +48,7 @@ ### Additional Properties * **Additional Properties Type**: string -## GatewayListStatusLive +## ServerAdministrators ### Properties -* **status**: '0' (ReadOnly): Live message of list gateway. Status: 0 - Live +* **members**: string[]: An array of administrator user identities. diff --git a/generated/analysisservices/microsoft.analysisservices/2017-08-01/types.md b/generated/analysisservices/microsoft.analysisservices/2017-08-01/types.md index 70e136dca0..dc4164747d 100644 --- a/generated/analysisservices/microsoft.analysisservices/2017-08-01/types.md +++ b/generated/analysisservices/microsoft.analysisservices/2017-08-01/types.md @@ -31,20 +31,15 @@ * **sku**: [ResourceSku](#resourcesku): Represents the SKU name and Azure pricing tier for Analysis Services resource. * **state**: 'Deleting' | 'Failed' | 'Paused' | 'Pausing' | 'Preparing' | 'Provisioning' | 'Resuming' | 'Scaling' | 'Succeeded' | 'Suspended' | 'Suspending' | 'Updating' | string (ReadOnly): The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. -## ServerAdministrators -### Properties -* **members**: string[]: An array of administrator user identities. - ## GatewayDetails ### Properties * **dmtsClusterUri**: string (ReadOnly): Uri of the DMTS cluster. * **gatewayObjectId**: string (ReadOnly): Gateway object id from in the DMTS cluster for the gateway resource. * **gatewayResourceId**: string: Gateway resource to be associated with the server. -## IPv4FirewallSettings +## GatewayListStatusLive ### Properties -* **enablePowerBIService**: bool: The indicator of enabling PBI service. -* **firewallRules**: [IPv4FirewallRule](#ipv4firewallrule)[]: An array of firewall rules. +* **status**: '0' (ReadOnly): Live message of list gateway. Status: 0 - Live ## IPv4FirewallRule ### Properties @@ -52,6 +47,11 @@ * **rangeEnd**: string: The end range of IPv4. * **rangeStart**: string: The start range of IPv4. +## IPv4FirewallSettings +### Properties +* **enablePowerBIService**: bool: The indicator of enabling PBI service. +* **firewallRules**: [IPv4FirewallRule](#ipv4firewallrule)[]: An array of firewall rules. + ## ResourceSku ### Properties * **capacity**: int: The number of instances in the read only query pool. @@ -63,7 +63,7 @@ ### Additional Properties * **Additional Properties Type**: string -## GatewayListStatusLive +## ServerAdministrators ### Properties -* **status**: '0' (ReadOnly): Live message of list gateway. Status: 0 - Live +* **members**: string[]: An array of administrator user identities. diff --git a/generated/apimanagement/log.out b/generated/apimanagement/log.out index 95a13d5518..84c480a045 100644 --- a/generated/apimanagement/log.out +++ b/generated/apimanagement/log.out @@ -40,7 +40,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.apimanagement-2021-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -80,7 +80,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-12-01-preview/apimanagement.json:38:5 @@ -747,7 +747,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipiente info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 62ms +info | autorest.bicep took 47ms info | Processing batch task - {"tag":"microsoft.apimanagement-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -787,7 +787,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json:38:5 @@ -1441,7 +1441,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipiente info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 38ms +info | autorest.bicep took 43ms info | Processing batch task - {"tag":"microsoft.apimanagement-2021-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1481,7 +1481,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/apimanagement.json:38:5 @@ -2133,7 +2133,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipiente info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 34ms +info | autorest.bicep took 39ms info | Processing batch task - {"tag":"microsoft.apimanagement-2021-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2173,7 +2173,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/apimanagement.json:38:5 @@ -2817,7 +2817,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 34ms +info | autorest.bicep took 25ms info | Processing batch task - {"tag":"microsoft.apimanagement-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2857,7 +2857,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2020-12-01/apimanagement.json:38:5 @@ -3497,7 +3497,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 31ms +info | autorest.bicep took 41ms info | Processing batch task - {"tag":"microsoft.apimanagement-2020-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3537,7 +3537,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimanagement.json:38:5 @@ -4173,7 +4173,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 34ms +info | autorest.bicep took 49ms info | Processing batch task - {"tag":"microsoft.apimanagement-2019-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4213,7 +4213,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/apimanagement.json:38:5 @@ -4778,7 +4778,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 28ms +info | autorest.bicep took 32ms info | Processing batch task - {"tag":"microsoft.apimanagement-2019-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4818,7 +4818,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimanagement.json:38:5 @@ -5366,7 +5366,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 24ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.apimanagement-2019-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -5406,7 +5406,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/apimanagement.json:38:5 @@ -5910,7 +5910,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 16ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.apimanagement-2018-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -5950,7 +5950,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimanagement.json:38:5 @@ -6450,7 +6450,7 @@ info | Resource type microsoft.apimanagement/service/notifications/recipientu info | Resource type microsoft.apimanagement/service/notifications/recipientemails under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}' has no body defined. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. -info | autorest.bicep took 22ms +info | autorest.bicep took 18ms info | Processing batch task - {"tag":"microsoft.apimanagement-2018-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -6490,7 +6490,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimanagement.json:387:5 @@ -7014,7 +7014,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimanagement.json:352:5 @@ -7480,7 +7480,7 @@ info | Resource type microsoft.apimanagement/service/products/groups under pa info | Resource type microsoft.apimanagement/service/apis/tags under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}' has no body defined. info | Resource type microsoft.apimanagement/service/apis/operations/tags under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/tags under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}' has no body defined. -info | autorest.bicep took 14ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.apimanagement-2016-10-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -7520,7 +7520,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimanagement.json:122:5 @@ -7802,7 +7802,7 @@ warning | DeprecatedConfig | Using directive.32.suppress which is deprecated and warning | DeprecatedConfig | Using directive.33.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.34.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OAuth2AuthenticationSettingsContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimanagement.json:4956:5 @@ -7989,5 +7989,5 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.apimanagement/service/products/apis under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}' has no body defined. info | Resource type microsoft.apimanagement/service/products/groups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}' has no body defined. info | Resource type microsoft.apimanagement/service/groups/users under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}' has no body defined. -info | autorest.bicep took 11ms -info | Autorest completed in 238.21s. 28 files generated. +info | autorest.bicep took 8ms +info | Autorest completed in 228.04s. 28 files generated. diff --git a/generated/apimanagement/microsoft.apimanagement/2016-07-07/types.md b/generated/apimanagement/microsoft.apimanagement/2016-07-07/types.md index 0384f634d0..ad06d7950e 100644 --- a/generated/apimanagement/microsoft.apimanagement/2016-07-07/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2016-07-07/types.md @@ -219,6 +219,19 @@ * **state**: 'Active' | 'Blocked': User state. * **type**: 'Microsoft.ApiManagement/service/users' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalRegion +### Properties +* **location**: string (Required): The location name of the additional region among Azure Data center regions. +* **skuType**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. +* **skuUnitCount**: int: 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. +* **staticIPs**: string[] (ReadOnly): Static IP addresses of the location's virtual machines. +* **vpnconfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. + +## ApiManagementServiceBaseParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ApiManagementServiceProperties ### Properties * **additionalLocations**: [AdditionalRegion](#additionalregion)[]: Additional datacenter locations of the API Management service. @@ -238,31 +251,19 @@ * **vpnconfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **vpnType**: 'External' | 'Internal' | 'None': 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 the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified. -## AdditionalRegion -### Properties -* **location**: string (Required): The location name of the additional region among Azure Data center regions. -* **skuType**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. -* **skuUnitCount**: int: 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. -* **staticIPs**: string[] (ReadOnly): Static IP addresses of the location's virtual machines. -* **vpnconfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. - -## VirtualNetworkConfiguration -### Properties -* **location**: string: The location of the virtual network. -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: 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}. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - ## ApiManagementServicePropertiesCustomProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostnameConfiguration +## ApiManagementServiceSkuProperties ### Properties -* **certificate**: [CertificateInformation](#certificateinformation) (Required): SSL certificate information. -* **hostname**: string (Required): Hostname. -* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. +* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. +* **name**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. ## CertificateInformation ### Properties @@ -270,37 +271,22 @@ * **subject**: string (Required): Subject of the certificate. * **thumbprint**: string (Required): Thumbprint of the certificate. -## ApiManagementServiceSkuProperties +## HostnameConfiguration ### Properties -* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. -* **name**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. +* **certificate**: [CertificateInformation](#certificateinformation) (Required): SSL certificate information. +* **hostname**: string (Required): Hostname. +* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. -## ApiManagementServiceBaseParametersTags +## LoggerCreateParametersCredentials ### Properties ### Additional Properties * **Additional Properties Type**: string -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - ## OAuth2AuthenticationSettingsContract ### Properties * **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. * **scope**: string (WriteOnly): operations scope. -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - ## ParameterContract ### Properties * **defaultValue**: string: Default parameter value. @@ -315,24 +301,38 @@ * **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. * **sample**: string: An example of the representation. +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + ## ResultContract ### Properties * **description**: string: Operation response description. * **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. * **statusCode**: int (Required): Operation response HTTP status code. +## SubscriptionKeyParameterNamesContract +### Properties +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. + ## TokenBodyParameterContract ### Properties * **name**: string (Required): body parameter name. * **value**: string (Required): body parameter value. -## LoggerCreateParametersCredentials -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## UserIdentityContract ### Properties * **id**: string (ReadOnly): Identifier value within provider. * **provider**: string (ReadOnly): Identity provider name. +## VirtualNetworkConfiguration +### Properties +* **location**: string: The location of the virtual network. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: 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}. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. + diff --git a/generated/apimanagement/microsoft.apimanagement/2016-10-10/types.md b/generated/apimanagement/microsoft.apimanagement/2016-10-10/types.md index c197331766..e78ced5ee0 100644 --- a/generated/apimanagement/microsoft.apimanagement/2016-10-10/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2016-10-10/types.md @@ -238,6 +238,14 @@ * **state**: 'Active' | 'Blocked': User state. * **type**: 'Microsoft.ApiManagement/service/users' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalRegion +### Properties +* **location**: string (Required): The location name of the additional region among Azure Data center regions. +* **skuType**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. +* **skuUnitCount**: int: 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. +* **staticIPs**: string[] (ReadOnly): Static IP addresses of the location's virtual machines. +* **vpnconfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. + ## ApiManagementServiceProperties ### Properties * **additionalLocations**: [AdditionalRegion](#additionalregion)[]: Additional datacenter locations of the API Management service. @@ -257,31 +265,34 @@ * **vpnconfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **vpnType**: 'External' | 'Internal' | 'None': 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 the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified. -## AdditionalRegion +## ApiManagementServicePropertiesCustomProperties ### Properties -* **location**: string (Required): The location name of the additional region among Azure Data center regions. -* **skuType**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. -* **skuUnitCount**: int: 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. -* **staticIPs**: string[] (ReadOnly): Static IP addresses of the location's virtual machines. -* **vpnconfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkConfiguration +## ApiManagementServiceSkuProperties ### Properties -* **location**: string: The location of the virtual network. -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. +* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. +* **name**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. -## ApiManagementServicePropertiesCustomProperties +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + +## BackendCredentialsContractHeader ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: string[] -## HostnameConfiguration +## BackendCredentialsContractQuery ### Properties -* **certificate**: [CertificateInformation](#certificateinformation) (Required): SSL certificate information. -* **hostname**: string (Required): Hostname. -* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. +### Additional Properties +* **Additional Properties Type**: string[] + +## BackendProperties +### Properties +* **skipCertificateChainValidation**: bool: Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. +* **skipCertificateNameValidation**: bool: Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host. ## CertificateInformation ### Properties @@ -289,37 +300,22 @@ * **subject**: string (Required): Subject of the certificate. * **thumbprint**: string (Required): Thumbprint of the certificate. -## ApiManagementServiceSkuProperties +## HostnameConfiguration ### Properties -* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. -* **name**: 'Developer' | 'Premium' | 'Standard' (Required): The SKU type in the location. +* **certificate**: [CertificateInformation](#certificateinformation) (Required): SSL certificate information. +* **hostname**: string (Required): Hostname. +* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. -## ResourceTags +## LoggerCreateParametersCredentials ### Properties ### Additional Properties * **Additional Properties Type**: string -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - ## OAuth2AuthenticationSettingsContract ### Properties * **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. * **scope**: string (WriteOnly): operations scope. -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - ## ParameterContract ### Properties * **defaultValue**: string: Default parameter value. @@ -334,39 +330,43 @@ * **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. * **sample**: string: An example of the representation. -## ResultContract -### Properties -* **description**: string: Operation response description. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. - -## TokenBodyParameterContract +## RequestContract ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. -## BackendCredentialsContractHeader +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: string[] +* **Additional Properties Type**: string -## BackendProperties +## ResultContract ### Properties -* **skipCertificateChainValidation**: bool: Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. -* **skipCertificateNameValidation**: bool: Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host. +* **description**: string: Operation response description. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. -## BackendCredentialsContractQuery +## SubscriptionKeyParameterNamesContract ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## LoggerCreateParametersCredentials +## TokenBodyParameterContract ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserIdentityContract ### Properties * **id**: string (ReadOnly): Identifier value within provider. * **provider**: string (ReadOnly): Identity provider name. +## VirtualNetworkConfiguration +### Properties +* **location**: string: The location of the virtual network. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. + diff --git a/generated/apimanagement/microsoft.apimanagement/2017-03-01/types.md b/generated/apimanagement/microsoft.apimanagement/2017-03-01/types.md index 5e2af25a99..a5afab9d8d 100644 --- a/generated/apimanagement/microsoft.apimanagement/2017-03-01/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2017-03-01/types.md @@ -389,33 +389,6 @@ * **properties**: [UserCreateParameterProperties](#usercreateparameterproperties): Parameters supplied to the Create User operation. * **type**: 'Microsoft.ApiManagement/service/users' (ReadOnly, DeployTimeConstant): The resource type -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. - -## ApiManagementServiceProperties -### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **staticIps**: string[] (ReadOnly): Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. - ## AdditionalLocation ### Properties * **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Region. @@ -424,59 +397,6 @@ * **staticIps**: string[] (ReadOnly): Static IP addresses of the location's virtual machines. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. -* **name**: 'Basic' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation) (ReadOnly): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The local certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation) (ReadOnly): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **keyVaultId**: 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* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiVersionSetContractProperties -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **displayName**: string (Required, WriteOnly): Name of API Version Set -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required, WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -497,106 +417,52 @@ * **type**: 'http' | 'soap' | string (WriteOnly): Type of API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContract -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource ID. -* **name**: string (ReadOnly, WriteOnly): Resource name. -* **properties**: [ApiVersionSetContractProperties](#apiversionsetcontractproperties) (WriteOnly): Properties of an API Version Set. -* **type**: string (ReadOnly, WriteOnly): Resource type for API Management resource. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL * **wsdlServiceName**: string (WriteOnly): Name of service to import from WSDL -## DiagnosticContractProperties -### Properties -* **enabled**: bool (Required): Indicates whether a diagnostic should receive data or not. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +### Additional Properties +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **staticIps**: string[] (ReadOnly): Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **policyContent**: string (Required): Json escaped Xml Encoded contents of the Policy. +* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. +* **name**: 'Basic' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (Required): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -605,21 +471,24 @@ * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties +## ApiVersionSetContract ### Properties -* **contentType**: string (Required): 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). -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. +* **id**: string (ReadOnly, WriteOnly): Resource ID. +* **name**: string (ReadOnly, WriteOnly): Resource name. +* **properties**: [ApiVersionSetContractProperties](#apiversionsetcontractproperties) (WriteOnly): Properties of an API Version Set. +* **type**: string (ReadOnly, WriteOnly): Resource type for API Management resource. -## SchemaDocumentProperties +## ApiVersionSetContractProperties ### Properties -* **value**: string: Json escaped string defining the document representing the Schema. +* **description**: string (WriteOnly): Description of API Version Set. +* **displayName**: string (Required, WriteOnly): Name of API Version Set +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required, WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. -## TagDescriptionBaseProperties +## AuthenticationSettingsContract ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. ## AuthorizationServerContractProperties ### Properties @@ -640,10 +509,10 @@ * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -664,11 +533,6 @@ * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -683,6 +547,12 @@ ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. @@ -691,22 +561,18 @@ * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation) (ReadOnly): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The local certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (Required, WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -715,6 +581,46 @@ * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. +## CertificateInformation +### Properties +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. + +## DiagnosticContractProperties +### Properties +* **enabled**: bool (Required): Indicates whether a diagnostic should receive data or not. + +## EmailTemplateParametersContractProperties +### Properties +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. + +## GroupContract +### Properties +* **id**: string (ReadOnly): Resource ID. +* **name**: string (ReadOnly): Resource name. +* **properties**: [GroupContractProperties](#groupcontractproperties) (ReadOnly): Group contract Properties. +* **type**: string (ReadOnly): Resource type for API Management resource. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -723,6 +629,17 @@ * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation) (ReadOnly): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **keyVaultId**: 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* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. + ## IdentityProviderContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -734,6 +651,27 @@ * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string: Identity Provider Type identifier. +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials) (Required): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -771,10 +709,10 @@ Instrumentation key for applicationInsights logger. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. ## OpenidConnectProviderContractProperties ### Properties @@ -784,6 +722,30 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PolicyContractProperties +### Properties +* **policyContent**: string (Required): Json escaped Xml Encoded contents of the Policy. + ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -791,14 +753,6 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for user registration. - ## PortalSigninSettingProperties ### Properties * **enabled**: bool: Redirect Anonymous users to the Sign-In page. @@ -808,12 +762,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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. @@ -831,6 +779,46 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the property list. * **value**: string (Required): Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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). +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **value**: string: Json escaped string defining the document representing the Schema. + ## SubscriptionCreateParameterProperties ### Properties * **createdDate**: string (ReadOnly): Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. @@ -846,20 +834,36 @@ Instrumentation key for applicationInsights logger. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator. * **userId**: string (Required): User (user id path) for whom subscription is being created in form /users/{uid} -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (Required): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -874,23 +878,19 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContract +## UserIdentityContract ### Properties -* **id**: string (ReadOnly): Resource ID. -* **name**: string (ReadOnly): Resource name. -* **properties**: [GroupContractProperties](#groupcontractproperties) (ReadOnly): Group contract Properties. -* **type**: string (ReadOnly): Resource type for API Management resource. +* **id**: string: Identifier value within provider. +* **provider**: string: Identity provider name. -## GroupContractProperties +## VirtualNetworkConfiguration ### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## UserIdentityContract +## X509CertificateName ### Properties -* **id**: string: Identifier value within provider. -* **provider**: string: Identity provider name. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2018-01-01/types.md b/generated/apimanagement/microsoft.apimanagement/2018-01-01/types.md index d76cdfd7e4..7ed470d81e 100644 --- a/generated/apimanagement/microsoft.apimanagement/2018-01-01/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2018-01-01/types.md @@ -389,34 +389,6 @@ * **properties**: [UserCreateParameterProperties](#usercreateparameterproperties): Parameters supplied to the Create User operation. * **type**: 'Microsoft.ApiManagement/service/users' (ReadOnly, DeployTimeConstant): The resource type -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. - -## ApiManagementServiceProperties -### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. - ## AdditionalLocation ### Properties * **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Region. @@ -426,59 +398,6 @@ * **sku**: [ApiManagementServiceSkuProperties](#apimanagementserviceskuproperties) (Required): API Management service resource SKU properties. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. -* **name**: 'Basic' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **keyVaultId**: 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* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiVersionSetContractProperties -### Properties -* **description**: string: Description of API Version Set. -* **displayName**: string (Required): Name of API Version Set -* **versionHeaderName**: string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -504,115 +423,53 @@ * **type**: 'http' | 'soap' | string (WriteOnly): Type of API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **subscriptionKeyRequired**: bool (WriteOnly): 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. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL * **wsdlServiceName**: string (WriteOnly): Name of service to import from WSDL -## DiagnosticContractProperties -### Properties -* **enabled**: bool (Required): Indicates whether a diagnostic should receive data or not. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +### Additional Properties +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **contentFormat**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **policyContent**: string (Required): Json escaped Xml Encoded contents of the Policy. +* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. +* **name**: 'Basic' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (Required): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -621,21 +478,27 @@ * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties +## ApiVersionSetContractDetails ### Properties -* **contentType**: string (Required): 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). -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. -## SchemaDocumentProperties +## ApiVersionSetContractProperties ### Properties -* **value**: string: Json escaped string defining the document representing the Schema. +* **description**: string: Description of API Version Set. +* **displayName**: string (Required): Name of API Version Set +* **versionHeaderName**: string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. -## TagDescriptionBaseProperties +## AuthenticationSettingsContract ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **subscriptionKeyRequired**: bool (WriteOnly): 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. ## AuthorizationServerContractProperties ### Properties @@ -656,10 +519,10 @@ * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -680,11 +543,6 @@ * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -699,6 +557,12 @@ ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. @@ -707,22 +571,18 @@ * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (Required, WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -731,6 +591,39 @@ * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. +## CertificateInformation +### Properties +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. + +## DiagnosticContractProperties +### Properties +* **enabled**: bool (Required): Indicates whether a diagnostic should receive data or not. + +## EmailTemplateParametersContractProperties +### Properties +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -739,6 +632,17 @@ * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **keyVaultId**: 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* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. + ## IdentityProviderContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -750,6 +654,27 @@ * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string: Identity Provider Type identifier. +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials) (Required): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -769,10 +694,15 @@ Instrumentation key for applicationInsights logger. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -782,6 +712,31 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PolicyContractProperties +### Properties +* **contentFormat**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **policyContent**: string (Required): Json escaped Xml Encoded contents of the Policy. + ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -789,14 +744,6 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for user registration. - ## PortalSigninSettingProperties ### Properties * **enabled**: bool: Redirect Anonymous users to the Sign-In page. @@ -806,12 +753,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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. @@ -829,6 +770,46 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the property list. * **value**: string (Required): Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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). +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **value**: string: Json escaped string defining the document representing the Schema. + ## SubscriptionCreateParameterProperties ### Properties * **createdDate**: string (ReadOnly): Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. @@ -844,20 +825,36 @@ Instrumentation key for applicationInsights logger. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator. * **userId**: string (Required): User (user id path) for whom subscription is being created in form /users/{uid} -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (Required): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -872,16 +869,19 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. +## VirtualNetworkConfiguration +### Properties +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. + +## X509CertificateName +### Properties +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. + diff --git a/generated/apimanagement/microsoft.apimanagement/2018-06-01-preview/types.md b/generated/apimanagement/microsoft.apimanagement/2018-06-01-preview/types.md index daa19f334c..4755eaaec7 100644 --- a/generated/apimanagement/microsoft.apimanagement/2018-06-01-preview/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2018-06-01-preview/types.md @@ -382,34 +382,6 @@ * **properties**: [UserCreateParameterProperties](#usercreateparameterproperties): Parameters supplied to the Create User operation. * **type**: 'Microsoft.ApiManagement/service/users' (ReadOnly, DeployTimeConstant): The resource type -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. - -## ApiManagementServiceProperties -### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. - ## AdditionalLocation ### Properties * **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Region. @@ -419,59 +391,6 @@ * **sku**: [ApiManagementServiceSkuProperties](#apimanagementserviceskuproperties) (Required): API Management service resource SKU properties. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **keyVaultId**: 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* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiVersionSetContractProperties -### Properties -* **description**: string: Description of API Version Set. -* **displayName**: string (Required): Name of API Version Set -* **versionHeaderName**: string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -498,139 +417,53 @@ * **type**: 'http' | 'soap' | string (WriteOnly): Type of API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **subscriptionKeyRequired**: bool (WriteOnly): 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. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL * **wsdlServiceName**: string (WriteOnly): Name of service to import from WSDL -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **enableHttpCorrelationHeaders**: bool: Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **loggerId**: string (Required): Resource Id of a target logger. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +### Additional Properties +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **contentFormat**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **policyContent**: string (Required): Json escaped Xml Encoded contents of the Policy. +* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -639,21 +472,27 @@ * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties +## ApiVersionSetContractDetails ### Properties -* **contentType**: string (Required): 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). -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. -## SchemaDocumentProperties +## ApiVersionSetContractProperties ### Properties -* **value**: string: Json escaped string defining the document representing the Schema. +* **description**: string: Description of API Version Set. +* **displayName**: string (Required): Name of API Version Set +* **versionHeaderName**: string: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. -## TagDescriptionBaseProperties +## AuthenticationSettingsContract ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **subscriptionKeyRequired**: bool (WriteOnly): 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. ## AuthorizationServerContractProperties ### Properties @@ -674,10 +513,10 @@ * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -698,11 +537,6 @@ * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -713,22 +547,9 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BackendProperties -### Properties -* **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. - -## BackendServiceFabricClusterProperties -### Properties -* **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. -* **managementEndpoints**: string[] (Required): The cluster management endpoint. -* **maxPartitionResolutionRetries**: int: Maximum number of retries while attempting resolve the partition. -* **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication -* **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection - -## X509CertificateName +## BackendProperties ### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. +* **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. ## BackendProxyContract ### Properties @@ -736,17 +557,36 @@ * **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. * **username**: string: Username to connect to the WebProxy server +## BackendServiceFabricClusterProperties +### Properties +* **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. +* **managementEndpoints**: string[] (Required): The cluster management endpoint. +* **maxPartitionResolutionRetries**: int: Maximum number of retries while attempting resolve the partition. +* **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication +* **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection + ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache * **description**: string: Cache description * **resourceId**: string: Original uri of entity in external system cache points to +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (Required, WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -755,6 +595,44 @@ * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. +## CertificateInformation +### Properties +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. + +## DiagnosticContractProperties +### Properties +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **enableHttpCorrelationHeaders**: bool: Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **loggerId**: string (Required): Resource Id of a target logger. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. + +## EmailTemplateParametersContractProperties +### Properties +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -763,6 +641,22 @@ * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **keyVaultId**: 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* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'Management' | 'Portal' | 'Proxy' | 'Scm' (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -775,6 +669,27 @@ * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials) (Required): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -795,10 +710,15 @@ Instrumentation key for applicationInsights logger. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -808,6 +728,36 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **contentFormat**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **policyContent**: string (Required): Json escaped Xml Encoded contents of the Policy. + ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -815,14 +765,6 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for user registration. - ## PortalSigninSettingProperties ### Properties * **enabled**: bool: Redirect Anonymous users to the Sign-In page. @@ -832,12 +774,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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. @@ -855,6 +791,51 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the property list. * **value**: string (Required): Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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). +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **value**: string: Json escaped string defining the document representing the Schema. + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -871,20 +852,36 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -899,16 +896,19 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. +## VirtualNetworkConfiguration +### Properties +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. + +## X509CertificateName +### Properties +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. + diff --git a/generated/apimanagement/microsoft.apimanagement/2019-01-01/types.md b/generated/apimanagement/microsoft.apimanagement/2019-01-01/types.md index 7614b64bf9..3b3e540324 100644 --- a/generated/apimanagement/microsoft.apimanagement/2019-01-01/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2019-01-01/types.md @@ -383,36 +383,6 @@ * **properties**: [UserCreateParameterProperties](#usercreateparameterproperties): Parameters supplied to the Create User operation. * **type**: 'Microsoft.ApiManagement/service/users' (ReadOnly, DeployTimeConstant): The resource type -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. - -## ApiManagementServiceProperties -### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. -* **developerPortalUrl**: string (ReadOnly): Developer Portal endpoint URL of the API Management service. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. - ## AdditionalLocation ### Properties * **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Region. @@ -422,51 +392,6 @@ * **sku**: [ApiManagementServiceSkuProperties](#apimanagementserviceskuproperties) (Required): API Management service resource SKU properties. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **keyVaultId**: 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* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -494,35 +419,6 @@ * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -532,107 +428,50 @@ ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **enableHttpCorrelationHeaders**: bool: Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **loggerId**: string (Required): Resource Id of a target logger. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +### Additional Properties +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'SystemAssigned' | string (Required): The identity type. Currently the only supported type is 'SystemAssigned'. -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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. +* **developerPortalUrl**: string (ReadOnly): Developer Portal endpoint URL of the API Management service. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int: Capacity of the SKU (number of deployed units of the SKU). +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -641,21 +480,14 @@ * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaCreateOrUpdateProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. - -## SchemaDocumentProperties -### Properties -* **value**: string (WriteOnly): Json escaped string defining the document representing the Schema. - -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -665,6 +497,11 @@ * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -684,10 +521,10 @@ * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -708,11 +545,6 @@ * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -727,6 +559,12 @@ ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. @@ -735,28 +573,28 @@ * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache * **description**: string: Cache description * **resourceId**: string: Original uri of entity in external system cache points to +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (Required, WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -765,6 +603,46 @@ * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. +## CertificateInformation +### Properties +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. + +## DiagnosticContractProperties +### Properties +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **enableHttpCorrelationHeaders**: bool: Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **loggerId**: string (Required): Resource Id of a target logger. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. + +## EmailTemplateParametersContractProperties +### Properties +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -773,6 +651,22 @@ * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **keyVaultId**: 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* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -786,6 +680,27 @@ * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials) (Required): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -806,10 +721,15 @@ Instrumentation key for applicationInsights logger. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -819,6 +739,36 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. + ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -826,14 +776,6 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for user registration. - ## PortalSigninSettingProperties ### Properties * **enabled**: bool: Redirect Anonymous users to the Sign-In page. @@ -843,12 +785,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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. @@ -866,6 +802,51 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the property list. * **value**: string (Required): Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaCreateOrUpdateProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **value**: string (WriteOnly): Json escaped string defining the document representing the Schema. + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -882,20 +863,36 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -911,16 +908,19 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. +## VirtualNetworkConfiguration +### Properties +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. + +## X509CertificateName +### Properties +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. + diff --git a/generated/apimanagement/microsoft.apimanagement/2019-12-01-preview/types.md b/generated/apimanagement/microsoft.apimanagement/2019-12-01-preview/types.md index dfe0793c6a..324c412d09 100644 --- a/generated/apimanagement/microsoft.apimanagement/2019-12-01-preview/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2019-12-01-preview/types.md @@ -450,51 +450,12 @@ * **ApiVersion**: 2019-12-01-preview * **Output**: [PropertyValueContract](#propertyvaluecontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. - -## ApiManagementServiceProperties +## AccessInformationContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Identifier. +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -506,55 +467,6 @@ dictionary key references will be ARM resource ids in the form: * **sku**: [ApiManagementServiceSkuProperties](#apimanagementserviceskuproperties) (Required): API Management service resource SKU properties. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **keyVaultId**: 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* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -582,35 +494,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -620,107 +503,61 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. +### Additional Properties +* **Additional Properties Type**: string -## ParameterContract +## ApiManagementServiceIdentity ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## RepresentationContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -729,23 +566,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. - -## SchemaDocumentProperties +## ApiVersionConstraint ### Properties -* **definitions**: any: Any object -* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -755,6 +587,15 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -774,10 +615,10 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -798,11 +639,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -817,6 +653,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. @@ -825,28 +667,28 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache * **description**: string: Cache description * **resourceId**: string: Original uri of entity in external system cache points to +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (Required, WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -855,21 +697,54 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## GatewayContractProperties +## CertificateInformation ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## ResourceLocationDataContract +## ClientSecretContract ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. -## AssociationContractProperties +## ClientSecretContract ### Properties -* **provisioningState**: 'created': Provisioning state. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## DiagnosticContractProperties +### Properties +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. + +## EmailTemplateParametersContractProperties +### Properties +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. + +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. ## GatewayHostnameConfigurationContractProperties ### Properties @@ -877,6 +752,19 @@ dictionary key references will be ARM resource ids in the form: * **hostname**: string: Hostname value. Supports valid domain name, partial or full wildcard * **negotiateClientCertificate**: bool: Determines whether gateway requests client certificate +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -885,6 +773,22 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **keyVaultId**: 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* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -898,6 +802,27 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials) (Required): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -925,10 +850,15 @@ Instrumentation key for applicationInsights logger. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -938,6 +868,36 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. + ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -945,13 +905,9 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -962,12 +918,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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. @@ -978,6 +928,63 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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. * **terms**: 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. +## PropertyValueContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **definitions**: any: Any object +* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -994,20 +1001,42 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. + +## SubscriptionsDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1023,53 +1052,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Identifier. -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## PropertyValueContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2019-12-01/types.md b/generated/apimanagement/microsoft.apimanagement/2019-12-01/types.md index 4cb71272b3..8cfc2886f2 100644 --- a/generated/apimanagement/microsoft.apimanagement/2019-12-01/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2019-12-01/types.md @@ -468,51 +468,12 @@ * **ApiVersion**: 2019-12-01 * **Output**: [PropertyValueContract](#propertyvaluecontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. - -## ApiManagementServiceProperties +## AccessInformationContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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.

Note: next ciphers can't be disabled since they are required by Azure CloudService internal components:
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Identifier. +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -524,55 +485,6 @@ dictionary key references will be ARM resource ids in the form: * **sku**: [ApiManagementServiceSkuProperties](#apimanagementserviceskuproperties) (Required): API Management service resource SKU properties. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **keyVaultId**: 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* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -600,35 +512,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -638,107 +521,61 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. +### Additional Properties +* **Additional Properties Type**: string -## ParameterContract +## ApiManagementServiceIdentity ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## RepresentationContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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.

Note: next ciphers can't be disabled since they are required by Azure CloudService internal components:
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -747,23 +584,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. - -## SchemaDocumentProperties +## ApiVersionConstraint ### Properties -* **definitions**: any: Any object -* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -773,6 +605,15 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -792,10 +633,10 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -816,11 +657,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -835,6 +671,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificatethumbprint**: string (Required): The client certificate thumbprint for the management endpoint. @@ -843,28 +685,28 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache * **description**: string: Cache description * **resourceId**: string: Original uri of entity in external system cache points to +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (Required, WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -873,6 +715,29 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. +## CertificateInformation +### Properties +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + ## ContentTypeContractProperties ### Properties * **description**: string (ReadOnly): Content type description. @@ -881,26 +746,36 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any (ReadOnly): Any object * **version**: string (ReadOnly): Content type version. -## ContentItemContractProperties +## DiagnosticContractProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## GatewayContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. -## ResourceLocationDataContract +## EmailTemplateUpdateParameterProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. -## AssociationContractProperties +## GatewayContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. ## GatewayHostnameConfigurationContractProperties ### Properties @@ -908,6 +783,19 @@ dictionary key references will be ARM resource ids in the form: * **hostname**: string: Hostname value. Supports valid domain name, partial or full wildcard * **negotiateClientCertificate**: bool: Determines whether gateway requests client certificate +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -916,6 +804,22 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **keyVaultId**: 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* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -929,6 +833,27 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials) (Required): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -956,10 +881,15 @@ Instrumentation key for applicationInsights logger. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -969,6 +899,36 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. + ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -976,13 +936,9 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -993,12 +949,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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. @@ -1009,6 +959,63 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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. * **terms**: 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. +## PropertyValueContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **definitions**: any: Any object +* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -1025,20 +1032,42 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. + +## SubscriptionsDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1054,53 +1083,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Identifier. -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## PropertyValueContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2020-06-01-preview/types.md b/generated/apimanagement/microsoft.apimanagement/2020-06-01-preview/types.md index 885c748e8a..5dcd0a5d4e 100644 --- a/generated/apimanagement/microsoft.apimanagement/2020-06-01-preview/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2020-06-01-preview/types.md @@ -496,52 +496,20 @@ * **ApiVersion**: 2020-06-01-preview * **Output**: [NamedValueSecretContract](#namedvaluesecretcontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties +## AccessInformationCreateParameterProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **enabled**: bool: Determines whether direct access is enabled. +* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string: Principal (User) Identifier. +* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -## ApiManagementServiceProperties +## AccessInformationSecretsContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string (ReadOnly): Principal (User) Identifier. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -554,56 +522,6 @@ dictionary key references will be ARM resource ids in the form: * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **zones**: string[]: A list of availability zones denoting where the resource needs to come from. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. -* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -631,35 +549,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -669,119 +558,62 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **dataMasking**: [DataMasking](#datamasking) -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## DataMasking -### Properties -* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers -* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters - -## DataMaskingEntity -### Properties -* **mode**: 'Hide' | 'Mask' | string: Data masking mode. -* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. +### Additional Properties +* **Additional Properties Type**: string -## ParameterContract +## ApiManagementServiceIdentity ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## RepresentationContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -790,23 +622,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. - -## SchemaDocumentProperties +## ApiVersionConstraint ### Properties -* **definitions**: any: Any object -* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -816,6 +643,15 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -835,10 +671,16 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## AuthorizationServerSecretsContract ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. +* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. +* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + +## BackendAuthorizationHeaderCredentials +### Properties +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -860,11 +702,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -879,6 +716,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificateId**: string: The client certificate id for the management endpoint. @@ -888,22 +731,15 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache @@ -911,6 +747,13 @@ dictionary key references will be ARM resource ids in the form: * **resourceId**: string: Original uri of entity in external system cache points to * **useFromLocation**: string (Required): Location identifier to use cache from (should be either 'default' or valid Azure region identifier) +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -920,17 +763,24 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## KeyVaultContractCreateProperties +## CertificateInformation ### Properties -* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. -* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. -* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## KeyVaultLastAccessStatusContractProperties +## ClientSecretContract ### Properties -* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. -* **message**: string (ReadOnly): Details of the error else empty. -* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any ## ContentTypeContractProperties ### Properties @@ -940,31 +790,52 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any (ReadOnly): Any object * **version**: string (ReadOnly): Content type version. -## ContentItemContractProperties +## DataMasking ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers +* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters -## GatewayContractProperties +## DataMaskingEntity ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **mode**: 'Hide' | 'Mask' | string: Data masking mode. +* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). -## ResourceLocationDataContract +## DiagnosticContractProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## AssociationContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. ## GatewayCertificateAuthorityContractProperties ### Properties * **isTrusted**: bool: Determines whether certificate authority is trusted. +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. + ## GatewayHostnameConfigurationContractProperties ### Properties * **certificateId**: string: Identifier of Certificate entity that will be used for TLS connection establishment @@ -974,6 +845,19 @@ dictionary key references will be ARM resource ids in the form: * **tls10Enabled**: bool: Specifies if TLS 1.0 is supported * **tls11Enabled**: bool: Specifies if TLS 1.1 is supported +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -982,6 +866,24 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. +* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **dataMasking**: [DataMasking](#datamasking) +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -995,6 +897,39 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + +## KeyVaultContractCreateProperties +### Properties +* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. +* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. +* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi + +## KeyVaultLastAccessStatusContractProperties +### Properties +* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. +* **message**: string (ReadOnly): Details of the error else empty. +* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -1017,16 +952,25 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. * **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +## NamedValueSecretContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + ## NotificationContractProperties ### Properties * **description**: string (ReadOnly): Description of the Notification. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -1036,14 +980,35 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. -## PortalRevisionContractProperties +## OperationContractProperties ### Properties -* **createdDateTime**: string (ReadOnly): Portal revision creation date and time. -* **description**: string: Portal revision description. -* **isCurrent**: bool: Indicates if the Portal Revision is public. -* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Portal revision publishing status -* **statusDetails**: string (ReadOnly): Portal revision publishing status details. -* **updatedDateTime**: string (ReadOnly): Last updated date and time. +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. ## PortalDelegationSettingsProperties ### Properties @@ -1052,13 +1017,18 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties +## PortalRevisionContractProperties ### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. +* **createdDateTime**: string (ReadOnly): Portal revision creation date and time. +* **description**: string: Portal revision description. +* **isCurrent**: bool: Indicates if the Portal Revision is public. +* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Portal revision publishing status +* **statusDetails**: string (ReadOnly): Portal revision publishing status details. +* **updatedDateTime**: string (ReadOnly): Last updated date and time. -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -1069,12 +1039,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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 false. @@ -1085,6 +1049,59 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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 false. * **terms**: 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. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **definitions**: any: Any object +* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -1101,27 +1118,42 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. -## AccessInformationCreateParameterProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **enabled**: bool: Determines whether direct access is enabled. -* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string: Principal (User) Identifier. -* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1137,56 +1169,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## AuthorizationServerSecretsContract -### Properties -* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. -* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. -* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationSecretsContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string (ReadOnly): Principal (User) Identifier. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## NamedValueSecretContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2020-12-01/types.md b/generated/apimanagement/microsoft.apimanagement/2020-12-01/types.md index 12133ce7be..4d1e011101 100644 --- a/generated/apimanagement/microsoft.apimanagement/2020-12-01/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2020-12-01/types.md @@ -496,52 +496,21 @@ * **ApiVersion**: 2020-12-01 * **Output**: [NamedValueSecretContract](#namedvaluesecretcontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties +## AccessInformationCreateParameterProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **enabled**: bool: Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string: Principal (User) Identifier. +* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -## ApiManagementServiceProperties +## AccessInformationSecretsContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string (ReadOnly): Principal (User) Identifier. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -554,56 +523,6 @@ dictionary key references will be ARM resource ids in the form: * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **zones**: string[]: A list of availability zones denoting where the resource needs to come from. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. -* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## ApimResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiCreateOrUpdateProperties ### Properties * **apiRevision**: string (WriteOnly): Describes the Revision of the Api. If no value is provided, default revision 1 is created @@ -631,35 +550,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -669,119 +559,62 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **dataMasking**: [DataMasking](#datamasking) -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## DataMasking -### Properties -* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers -* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters - -## DataMaskingEntity -### Properties -* **mode**: 'Hide' | 'Mask' | string: Data masking mode. -* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. +### Additional Properties +* **Additional Properties Type**: string -## ParameterContract +## ApiManagementServiceIdentity ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **type**: string (Required): Parameter type. -* **values**: string[]: Parameter values. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## RepresentationContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **sample**: string: An example of the representation. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -790,23 +623,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. - -## SchemaDocumentProperties +## ApiVersionConstraint ### Properties -* **definitions**: any: Any object -* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -816,6 +644,15 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -835,10 +672,16 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## AuthorizationServerSecretsContract ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. +* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. +* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + +## BackendAuthorizationHeaderCredentials +### Properties +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -860,11 +703,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -879,6 +717,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificateId**: string: The client certificate id for the management endpoint. @@ -888,22 +732,15 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache @@ -911,6 +748,13 @@ dictionary key references will be ARM resource ids in the form: * **resourceId**: string: Original uri of entity in external system cache points to * **useFromLocation**: string (Required): Location identifier to use cache from (should be either 'default' or valid Azure region identifier) +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -920,17 +764,24 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## KeyVaultContractCreateProperties +## CertificateInformation ### Properties -* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. -* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. -* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## KeyVaultLastAccessStatusContractProperties +## ClientSecretContract ### Properties -* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. -* **message**: string (ReadOnly): Details of the error else empty. -* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any ## ContentTypeContractProperties ### Properties @@ -940,31 +791,52 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any (ReadOnly): Any object * **version**: string (ReadOnly): Content type version. -## ContentItemContractProperties +## DataMasking ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers +* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters -## GatewayContractProperties +## DataMaskingEntity ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **mode**: 'Hide' | 'Mask' | string: Data masking mode. +* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). -## ResourceLocationDataContract +## DiagnosticContractProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## AssociationContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. ## GatewayCertificateAuthorityContractProperties ### Properties * **isTrusted**: bool: Determines whether certificate authority is trusted. +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. + ## GatewayHostnameConfigurationContractProperties ### Properties * **certificateId**: string: Identifier of Certificate entity that will be used for TLS connection establishment @@ -974,6 +846,19 @@ dictionary key references will be ARM resource ids in the form: * **tls10Enabled**: bool: Specifies if TLS 1.0 is supported * **tls11Enabled**: bool: Specifies if TLS 1.1 is supported +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -982,6 +867,24 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. +* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **dataMasking**: [DataMasking](#datamasking) +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -995,6 +898,39 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + +## KeyVaultContractCreateProperties +### Properties +* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. +* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. +* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires Api Management service to be configured with aka.ms/apimmsi + +## KeyVaultLastAccessStatusContractProperties +### Properties +* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. +* **message**: string (ReadOnly): Details of the error else empty. +* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -1017,16 +953,25 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. * **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +## NamedValueSecretContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + ## NotificationContractProperties ### Properties * **description**: string (ReadOnly): Description of the Notification. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -1036,14 +981,35 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. -## PortalRevisionContractProperties +## OperationContractProperties ### Properties -* **createdDateTime**: string (ReadOnly): Portal revision creation date and time. -* **description**: string: Portal revision description. -* **isCurrent**: bool: Indicates if the Portal Revision is public. -* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Portal revision publishing status -* **statusDetails**: string (ReadOnly): Portal revision publishing status details. -* **updatedDateTime**: string (ReadOnly): Last updated date and time. +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **type**: string (Required): Parameter type. +* **values**: string[]: Parameter values. + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. ## PortalDelegationSettingsProperties ### Properties @@ -1052,13 +1018,18 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties +## PortalRevisionContractProperties ### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. +* **createdDateTime**: string (ReadOnly): Portal revision creation date and time. +* **description**: string: Portal revision description. +* **isCurrent**: bool: Indicates if the Portal Revision is public. +* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Portal revision publishing status +* **statusDetails**: string (ReadOnly): Portal revision publishing status details. +* **updatedDateTime**: string (ReadOnly): Last updated date and time. -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -1069,12 +1040,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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 false. @@ -1085,6 +1050,59 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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 false. * **terms**: 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. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **sample**: string: An example of the representation. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **definitions**: any: Any object +* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -1101,28 +1119,42 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by Api Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. -## AccessInformationCreateParameterProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **enabled**: bool: Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string: Principal (User) Identifier. -* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1138,56 +1170,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## AuthorizationServerSecretsContract -### Properties -* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. -* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. -* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationSecretsContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string (ReadOnly): Principal (User) Identifier. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## NamedValueSecretContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2021-01-01-preview/types.md b/generated/apimanagement/microsoft.apimanagement/2021-01-01-preview/types.md index 1b4c8673f7..85063c04d9 100644 --- a/generated/apimanagement/microsoft.apimanagement/2021-01-01-preview/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2021-01-01-preview/types.md @@ -496,53 +496,21 @@ * **ApiVersion**: 2021-01-01-preview * **Output**: [NamedValueSecretContract](#namedvaluesecretcontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties +## AccessInformationCreateParameterProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **enabled**: bool: Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string: Principal (User) Identifier. +* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -## ApiManagementServiceProperties +## AccessInformationSecretsContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. -* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string (ReadOnly): Principal (User) Identifier. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -556,57 +524,11 @@ dictionary key references will be ARM resource ids in the form: * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **zones**: string[]: A list of availability zones denoting where the resource needs to come from. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. -* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. -* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## ApimResourceTags +## ApiContactInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address +* **name**: string (WriteOnly): The identifying name of the contact person/organization +* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL ## ApiCreateOrUpdateProperties ### Properties @@ -639,46 +561,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## ApiContactInformation -### Properties -* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address -* **name**: string (WriteOnly): The identifying name of the contact person/organization -* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL - -## ApiLicenseInformation -### Properties -* **name**: string (WriteOnly): The license name used for the API -* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -688,133 +570,68 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **dataMasking**: [DataMasking](#datamasking) -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## DataMasking -### Properties -* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers -* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters - -## DataMaskingEntity -### Properties -* **mode**: 'Hide' | 'Mask' | string: Data masking mode. -* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiLicenseInformation ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **schemaId**: string: Schema identifier. -* **type**: string (Required): Parameter type. -* **typeName**: string: Type name defined by the schema. -* **values**: string[]: Parameter values. +* **name**: string (WriteOnly): The license name used for the API +* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL -## ParameterExamplesContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) - -## ParameterExampleContract -### Properties -* **description**: string: Long description for the example -* **externalValue**: string: A URL that points to the literal example -* **summary**: string: Short description for the example -* **value**: any: Anything +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## ResponseContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## PolicyContractProperties +## ApiManagementServiceProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. +* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## TagContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **displayName**: string (ReadOnly): Tag name. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. + +## ApimResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -823,18 +640,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties +## ApiVersionConstraint ### Properties -* **contentType**: string (Required): 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`. -* **document**: any: Any object +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -844,6 +661,15 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -863,10 +689,16 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## AuthorizationServerSecretsContract ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. +* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. +* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + +## BackendAuthorizationHeaderCredentials +### Properties +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -888,11 +720,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -907,6 +734,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificateId**: string: The client certificate id for the management endpoint. @@ -916,22 +749,15 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache @@ -939,6 +765,13 @@ dictionary key references will be ARM resource ids in the form: * **resourceId**: string: Original uri of entity in external system cache points to * **useFromLocation**: string (Required): Location identifier to use cache from (should be either 'default' or valid Azure region identifier) +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -948,17 +781,24 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## KeyVaultContractCreateProperties +## CertificateInformation ### Properties -* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. -* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. -* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## KeyVaultLastAccessStatusContractProperties +## ClientSecretContract ### Properties -* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. -* **message**: string (ReadOnly): Details of the error else empty. -* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any ## ContentTypeContractProperties ### Properties @@ -968,31 +808,52 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any (ReadOnly): Any object * **version**: string (ReadOnly): Content type version. -## ContentItemContractProperties +## DataMasking ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers +* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters -## GatewayContractProperties +## DataMaskingEntity ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **mode**: 'Hide' | 'Mask' | string: Data masking mode. +* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). -## ResourceLocationDataContract +## DiagnosticContractProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## AssociationContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. ## GatewayCertificateAuthorityContractProperties ### Properties * **isTrusted**: bool: Determines whether certificate authority is trusted. +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. + ## GatewayHostnameConfigurationContractProperties ### Properties * **certificateId**: string: Identifier of Certificate entity that will be used for TLS connection establishment @@ -1002,26 +863,92 @@ dictionary key references will be ARM resource ids in the form: * **tls10Enabled**: bool: Specifies if TLS 1.0 is supported * **tls11Enabled**: bool: Specifies if TLS 1.1 is supported -## GroupCreateParametersProperties +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + +## GroupCreateParametersProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string: Group description. +* **displayName**: string (Required): Group name. +* **externalId**: 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. +* **type**: 'custom' | 'external' | 'system': Group type. + +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. +* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. +* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **dataMasking**: [DataMasking](#datamasking) +* **headers**: string[]: Array of HTTP Headers to log. + +## IdentityProviderCreateContractProperties +### Properties +* **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. +* **authority**: string: OpenID Connect discovery endpoint hostname for AAD or AAD B2C. +* **clientId**: string (Required): 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. +* **clientSecret**: string (Required): 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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **passwordResetPolicyName**: string: Password Reset Policy Name. Only applies to AAD B2C Identity Provider. +* **profileEditingPolicyName**: string: Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. +* **signinPolicyName**: string: Signin Policy Name. Only applies to AAD B2C Identity Provider. +* **signinTenant**: string: The TenantId to use instead of Common when logging into Active Directory +* **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. +* **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string + +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + +## KeyVaultContractCreateProperties ### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string: Group description. -* **displayName**: string (Required): Group name. -* **externalId**: 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. -* **type**: 'custom' | 'external' | 'system': Group type. +* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. +* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. +* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi -## IdentityProviderCreateContractProperties +## KeyVaultLastAccessStatusContractProperties ### Properties -* **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. -* **authority**: string: OpenID Connect discovery endpoint hostname for AAD or AAD B2C. -* **clientId**: string (Required): 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. -* **clientSecret**: string (Required): 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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **passwordResetPolicyName**: string: Password Reset Policy Name. Only applies to AAD B2C Identity Provider. -* **profileEditingPolicyName**: string: Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. -* **signinPolicyName**: string: Signin Policy Name. Only applies to AAD B2C Identity Provider. -* **signinTenant**: string: The TenantId to use instead of Common when logging into Active Directory -* **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. -* **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. +* **message**: string (ReadOnly): Details of the error else empty. +* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ## LoggerContractProperties ### Properties @@ -1045,16 +972,25 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. * **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +## NamedValueSecretContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + ## NotificationContractProperties ### Properties * **description**: string (ReadOnly): Description of the Notification. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -1064,14 +1000,50 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. -## PortalRevisionContractProperties +## OperationContractProperties ### Properties -* **createdDateTime**: string (ReadOnly): Portal's revision creation date and time. -* **description**: string: Portal revision description. -* **isCurrent**: bool: Indicates if the portal's revision is public. -* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Status of the portal's revision. -* **statusDetails**: string (ReadOnly): Portal revision publishing status details. -* **updatedDateTime**: string (ReadOnly): Last updated date and time. +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **schemaId**: string: Schema identifier. +* **type**: string (Required): Parameter type. +* **typeName**: string: Type name defined by the schema. +* **values**: string[]: Parameter values. + +## ParameterExampleContract +### Properties +* **description**: string: Long description for the example +* **externalValue**: string: A URL that points to the literal example +* **summary**: string: Short description for the example +* **value**: any: Anything + +## ParameterExamplesContract +### Properties +### Additional Properties +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. ## PortalDelegationSettingsProperties ### Properties @@ -1080,13 +1052,18 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties +## PortalRevisionContractProperties ### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. +* **createdDateTime**: string (ReadOnly): Portal's revision creation date and time. +* **description**: string: Portal revision description. +* **isCurrent**: bool: Indicates if the portal's revision is public. +* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Status of the portal's revision. +* **statusDetails**: string (ReadOnly): Portal revision publishing status details. +* **updatedDateTime**: string (ReadOnly): Last updated date and time. -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -1097,12 +1074,6 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties -### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. - ## ProductContractProperties ### Properties * **approvalRequired**: bool: 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 false. @@ -1113,6 +1084,53 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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 false. * **terms**: 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. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: any: Any object + ## SubscriptionCreateParameterProperties ### Properties * **allowTracing**: bool: Determines whether tracing can be enabled @@ -1129,28 +1147,42 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. -## AccessInformationCreateParameterProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **enabled**: bool: Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string: Principal (User) Identifier. -* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1166,56 +1198,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## AuthorizationServerSecretsContract -### Properties -* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. -* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. -* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationSecretsContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string (ReadOnly): Principal (User) Identifier. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## NamedValueSecretContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2021-04-01-preview/types.md b/generated/apimanagement/microsoft.apimanagement/2021-04-01-preview/types.md index 7f3920a340..b26747bc86 100644 --- a/generated/apimanagement/microsoft.apimanagement/2021-04-01-preview/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2021-04-01-preview/types.md @@ -515,56 +515,21 @@ * **ApiVersion**: 2021-04-01-preview * **Output**: [NamedValueSecretContract](#namedvaluesecretcontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties +## AccessInformationCreateParameterProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **enabled**: bool: Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string: Principal (User) Identifier. +* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -## ApiManagementServiceProperties +## AccessInformationSecretsContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **platformVersion**: 'mtv1' | 'stv1' | 'stv2' | 'undetermined' | string (ReadOnly): Compute Platform Version running the service. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateEndpointConnections**: [RemotePrivateEndpointConnectionWrapper](#remoteprivateendpointconnectionwrapper)[]: List of Private Endpoint Connections of this service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. -* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string (ReadOnly): Principal (User) Identifier. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -579,90 +544,11 @@ dictionary key references will be ARM resource ids in the form: * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **zones**: string[]: A list of availability zones denoting where the resource needs to come from. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. -* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. -* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## RemotePrivateEndpointConnectionWrapper -### Properties -* **id**: string: Private Endpoint connection resource id -* **name**: string: Private Endpoint Connection Name -* **properties**: [PrivateEndpointConnectionWrapperProperties](#privateendpointconnectionwrapperproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string: Private Endpoint Connection Resource Type - -## PrivateEndpointConnectionWrapperProperties -### Properties -* **groupIds**: string[] (ReadOnly): All the Group ids. -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: string (ReadOnly): The provisioning state of the private endpoint connection resource. - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ApimResourceTags +## ApiContactInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address +* **name**: string (WriteOnly): The identifying name of the contact person/organization +* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL ## ApiCreateOrUpdateProperties ### Properties @@ -696,46 +582,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## ApiContactInformation -### Properties -* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address -* **name**: string (WriteOnly): The identifying name of the contact person/organization -* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL - -## ApiLicenseInformation -### Properties -* **name**: string (WriteOnly): The license name used for the API -* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -745,139 +591,71 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **dataMasking**: [DataMasking](#datamasking) -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## DataMasking -### Properties -* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers -* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters - -## DataMaskingEntity -### Properties -* **mode**: 'Hide' | 'Mask' | string: Data masking mode. -* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiLicenseInformation ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **schemaId**: string: Schema identifier. -* **type**: string (Required): Parameter type. -* **typeName**: string: Type name defined by the schema. -* **values**: string[]: Parameter values. +* **name**: string (WriteOnly): The license name used for the API +* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL -## ParameterExamplesContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) - -## ParameterExampleContract -### Properties -* **description**: string: Long description for the example -* **externalValue**: string: A URL that points to the literal example -* **summary**: string: Short description for the example -* **value**: any: Anything +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## ParameterExamplesContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **platformVersion**: 'mtv1' | 'stv1' | 'stv2' | 'undetermined' | string (ReadOnly): Compute Platform Version running the service. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateEndpointConnections**: [RemotePrivateEndpointConnectionWrapper](#remoteprivateendpointconnectionwrapper)[]: List of Private Endpoint Connections of this service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. +* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -897,13 +675,18 @@ dictionary key references will be ARM resource ids in the form: * **definitions**: any: Any object * **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. -## TagDescriptionBaseProperties +## ApiVersionConstraint ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. + +## ApiVersionSetContractDetails +### Properties +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -913,6 +696,19 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## ArmIdWrapper +### Properties +* **id**: string (ReadOnly) + +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -932,10 +728,16 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## AuthorizationServerSecretsContract ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. +* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. +* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + +## BackendAuthorizationHeaderCredentials +### Properties +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -957,11 +759,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -976,6 +773,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificateId**: string: The client certificate id for the management endpoint. @@ -985,22 +788,15 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache @@ -1008,6 +804,13 @@ dictionary key references will be ARM resource ids in the form: * **resourceId**: string: Original uri of entity in external system cache points to * **useFromLocation**: string (Required): Location identifier to use cache from (should be either 'default' or valid Azure region identifier) +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -1017,17 +820,24 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## KeyVaultContractCreateProperties +## CertificateInformation ### Properties -* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. -* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. -* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## KeyVaultLastAccessStatusContractProperties +## ClientSecretContract ### Properties -* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. -* **message**: string (ReadOnly): Details of the error else empty. -* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any ## ContentTypeContractProperties ### Properties @@ -1037,31 +847,52 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any (ReadOnly): Any object * **version**: string (ReadOnly): Content type version. -## ContentItemContractProperties +## DataMasking ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers +* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters -## GatewayContractProperties +## DataMaskingEntity ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **mode**: 'Hide' | 'Mask' | string: Data masking mode. +* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). -## ResourceLocationDataContract +## DiagnosticContractProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## AssociationContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. ## GatewayCertificateAuthorityContractProperties ### Properties * **isTrusted**: bool: Determines whether certificate authority is trusted. +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. + ## GatewayHostnameConfigurationContractProperties ### Properties * **certificateId**: string: Identifier of Certificate entity that will be used for TLS connection establishment @@ -1071,6 +902,19 @@ dictionary key references will be ARM resource ids in the form: * **tls10Enabled**: bool: Specifies if TLS 1.0 is supported * **tls11Enabled**: bool: Specifies if TLS 1.1 is supported +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -1079,6 +923,26 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. +* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. +* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **dataMasking**: [DataMasking](#datamasking) +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -1092,46 +956,145 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string -## LoggerContractProperties +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + +## KeyVaultContractCreateProperties +### Properties +* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. +* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. +* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi + +## KeyVaultLastAccessStatusContractProperties +### Properties +* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. +* **message**: string (ReadOnly): Details of the error else empty. +* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + +## LoggerContractProperties +### Properties +* **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. +Instrumentation key for applicationInsights logger. +* **description**: string: Logger description. +* **isBuffered**: bool: Whether records are buffered in the logger before publishing. Default is assumed to be true. +* **loggerType**: 'applicationInsights' | 'azureEventHub' | 'azureMonitor' | string (Required): Logger type. +* **resourceId**: string: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). + +## LoggerContractPropertiesCredentials +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## NamedValueCreateContractProperties +### Properties +* **displayName**: string (Required): Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. +* **keyVault**: [KeyVaultContractCreateProperties](#keyvaultcontractcreateproperties): Create keyVault contract details. +* **secret**: bool: Determines whether the value is a secret and should be encrypted or not. Default value is false. +* **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. +* **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + +## NamedValueSecretContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + +## NotificationContractProperties +### Properties +* **description**: string (ReadOnly): Description of the Notification. +* **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. +* **title**: string (ReadOnly): Title of the Notification. + +## OAuth2AuthenticationSettingsContract +### Properties +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. + +## OpenidConnectProviderContractProperties +### Properties +* **clientId**: string (Required): Client ID of developer console which is the client application. +* **clientSecret**: string: Client Secret of developer console which is the client application. +* **description**: string: User-friendly description of OpenID Connect Provider. +* **displayName**: string (Required): User-friendly OpenID Connect Provider name. +* **metadataEndpoint**: string (Required): Metadata endpoint URI. + +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract ### Properties -* **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. -Instrumentation key for applicationInsights logger. -* **description**: string: Logger description. -* **isBuffered**: bool: Whether records are buffered in the logger before publishing. Default is assumed to be true. -* **loggerType**: 'applicationInsights' | 'azureEventHub' | 'azureMonitor' | string (Required): Logger type. -* **resourceId**: string: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **schemaId**: string: Schema identifier. +* **type**: string (Required): Parameter type. +* **typeName**: string: Type name defined by the schema. +* **values**: string[]: Parameter values. -## LoggerContractPropertiesCredentials +## ParameterExampleContract +### Properties +* **description**: string: Long description for the example +* **externalValue**: string: A URL that points to the literal example +* **summary**: string: Short description for the example +* **value**: any: Anything + +## ParameterExamplesContract ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) -## NamedValueCreateContractProperties +## ParameterExamplesContract ### Properties -* **displayName**: string (Required): Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. -* **keyVault**: [KeyVaultContractCreateProperties](#keyvaultcontractcreateproperties): Create keyVault contract details. -* **secret**: bool: Determines whether the value is a secret and should be encrypted or not. Default value is false. -* **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. -* **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +### Additional Properties +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) -## NotificationContractProperties +## PipelineDiagnosticSettings ### Properties -* **description**: string (ReadOnly): Description of the Notification. -* **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. -* **title**: string (ReadOnly): Title of the Notification. +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -## RecipientsContractProperties +## PolicyContractProperties ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. -## OpenidConnectProviderContractProperties +## PortalDelegationSettingsProperties ### Properties -* **clientId**: string (Required): Client ID of developer console which is the client application. -* **clientSecret**: string: Client Secret of developer console which is the client application. -* **description**: string: User-friendly description of OpenID Connect Provider. -* **displayName**: string (Required): User-friendly OpenID Connect Provider name. -* **metadataEndpoint**: string (Required): Metadata endpoint URI. +* **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. +* **url**: string: A delegation Url. +* **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. +* **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ## PortalRevisionContractProperties ### Properties @@ -1142,20 +1105,9 @@ Instrumentation key for applicationInsights logger. * **statusDetails**: string (ReadOnly): Portal revision publishing status details. * **updatedDateTime**: string (ReadOnly): Last updated date and time. -## PortalDelegationSettingsProperties -### Properties -* **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. -* **url**: string: A delegation Url. -* **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. -* **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. - -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -1166,11 +1118,9 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties +## PrivateEndpoint ### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnectionRequestProperties ### Properties @@ -1178,9 +1128,18 @@ Instrumentation key for applicationInsights logger. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateEndpointConnectionWrapperProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **groupIds**: string[] (ReadOnly): All the Group ids. +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: string (ReadOnly): The provisioning state of the private endpoint connection resource. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ProductContractProperties ### Properties @@ -1192,6 +1151,56 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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 false. * **terms**: 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. +## RecipientsContractProperties +### Properties +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RemotePrivateEndpointConnectionWrapper +### Properties +* **id**: string: Private Endpoint connection resource id +* **name**: string: Private Endpoint Connection Name +* **properties**: [PrivateEndpointConnectionWrapperProperties](#privateendpointconnectionwrapperproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string: Private Endpoint Connection Resource Type + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + ## SchemaContractProperties ### Properties * **description**: string: Free-form schema entity description. @@ -1215,28 +1224,51 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. -## AccessInformationCreateParameterProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **enabled**: bool: Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string: Principal (User) Identifier. -* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1252,56 +1284,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## AuthorizationServerSecretsContract -### Properties -* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. -* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. -* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationSecretsContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string (ReadOnly): Principal (User) Identifier. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## NamedValueSecretContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2021-08-01/types.md b/generated/apimanagement/microsoft.apimanagement/2021-08-01/types.md index b8f5621627..07a05ac800 100644 --- a/generated/apimanagement/microsoft.apimanagement/2021-08-01/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2021-08-01/types.md @@ -515,56 +515,21 @@ * **ApiVersion**: 2021-08-01 * **Output**: [NamedValueSecretContract](#namedvaluesecretcontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties +## AccessInformationCreateParameterProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **enabled**: bool: Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string: Principal (User) Identifier. +* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -## ApiManagementServiceProperties +## AccessInformationSecretsContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **platformVersion**: 'mtv1' | 'stv1' | 'stv2' | 'undetermined' | string (ReadOnly): Compute Platform Version running the service. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateEndpointConnections**: [RemotePrivateEndpointConnectionWrapper](#remoteprivateendpointconnectionwrapper)[]: List of Private Endpoint Connections of this service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. -* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string (ReadOnly): Principal (User) Identifier. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -579,90 +544,11 @@ dictionary key references will be ARM resource ids in the form: * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **zones**: string[]: A list of availability zones denoting where the resource needs to come from. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. -* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. -* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## RemotePrivateEndpointConnectionWrapper -### Properties -* **id**: string: Private Endpoint connection resource id -* **name**: string: Private Endpoint Connection Name -* **properties**: [PrivateEndpointConnectionWrapperProperties](#privateendpointconnectionwrapperproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string: Private Endpoint Connection Resource Type - -## PrivateEndpointConnectionWrapperProperties -### Properties -* **groupIds**: string[] (ReadOnly): All the Group ids. -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: string (ReadOnly): The provisioning state of the private endpoint connection resource. - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ApimResourceTags +## ApiContactInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address +* **name**: string (WriteOnly): The identifying name of the contact person/organization +* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL ## ApiCreateOrUpdateProperties ### Properties @@ -696,46 +582,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## ApiContactInformation -### Properties -* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address -* **name**: string (WriteOnly): The identifying name of the contact person/organization -* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL - -## ApiLicenseInformation -### Properties -* **name**: string (WriteOnly): The license name used for the API -* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -745,139 +591,71 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **dataMasking**: [DataMasking](#datamasking) -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## DataMasking -### Properties -* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers -* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters - -## DataMaskingEntity -### Properties -* **mode**: 'Hide' | 'Mask' | string: Data masking mode. -* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiLicenseInformation ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **schemaId**: string: Schema identifier. -* **type**: string (Required): Parameter type. -* **typeName**: string: Type name defined by the schema. -* **values**: string[]: Parameter values. +* **name**: string (WriteOnly): The license name used for the API +* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL -## ParameterExamplesContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) - -## ParameterExampleContract -### Properties -* **description**: string: Long description for the example -* **externalValue**: string: A URL that points to the literal example -* **summary**: string: Short description for the example -* **value**: any: Anything +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## ParameterExamplesContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **platformVersion**: 'mtv1' | 'stv1' | 'stv2' | 'undetermined' | string (ReadOnly): Compute Platform Version running the service. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateEndpointConnections**: [RemotePrivateEndpointConnectionWrapper](#remoteprivateendpointconnectionwrapper)[]: List of Private Endpoint Connections of this service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. +* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -886,24 +664,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Api Schema Document Properties. - -## SchemaDocumentProperties +## ApiVersionConstraint ### Properties -* **components**: any: Any object -* **definitions**: any: Any object -* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -913,6 +685,19 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## ArmIdWrapper +### Properties +* **id**: string (ReadOnly) + +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -932,10 +717,16 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## AuthorizationServerSecretsContract +### Properties +* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. +* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. +* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + +## BackendAuthorizationHeaderCredentials ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -957,11 +748,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -976,6 +762,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificateId**: string: The client certificate id for the management endpoint. @@ -985,22 +777,15 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache @@ -1008,6 +793,13 @@ dictionary key references will be ARM resource ids in the form: * **resourceId**: string: Original uri of entity in external system cache points to * **useFromLocation**: string (Required): Location identifier to use cache from (should be either 'default' or valid Azure region identifier) +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -1017,17 +809,24 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## KeyVaultContractCreateProperties +## CertificateInformation ### Properties -* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. -* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. -* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## KeyVaultLastAccessStatusContractProperties +## ClientSecretContract ### Properties -* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. -* **message**: string (ReadOnly): Details of the error else empty. -* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any ## ContentTypeContractProperties ### Properties @@ -1037,31 +836,52 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any (ReadOnly): Any object * **version**: string (ReadOnly): Content type version. -## ContentItemContractProperties +## DataMasking ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers +* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters -## GatewayContractProperties +## DataMaskingEntity ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **mode**: 'Hide' | 'Mask' | string: Data masking mode. +* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). -## ResourceLocationDataContract +## DiagnosticContractProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## AssociationContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. ## GatewayCertificateAuthorityContractProperties ### Properties * **isTrusted**: bool: Determines whether certificate authority is trusted. +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. + ## GatewayHostnameConfigurationContractProperties ### Properties * **certificateId**: string: Identifier of Certificate entity that will be used for TLS connection establishment @@ -1071,6 +891,26 @@ dictionary key references will be ARM resource ids in the form: * **tls10Enabled**: bool: Specifies if TLS 1.0 is supported * **tls11Enabled**: bool: Specifies if TLS 1.1 is supported +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GlobalSchemaContractProperties +### Properties +* **description**: string: Free-form schema entity description. +* **document**: any: Any object +* **schemaType**: 'json' | 'xml' | string (Required): Schema Type. Immutable. +* **value**: any: Anything + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -1079,6 +919,26 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. +* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. +* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **dataMasking**: [DataMasking](#datamasking) +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -1092,46 +952,145 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string -## LoggerContractProperties +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + +## KeyVaultContractCreateProperties +### Properties +* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. +* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. +* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi + +## KeyVaultLastAccessStatusContractProperties +### Properties +* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. +* **message**: string (ReadOnly): Details of the error else empty. +* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + +## LoggerContractProperties +### Properties +* **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. +Instrumentation key for applicationInsights logger. +* **description**: string: Logger description. +* **isBuffered**: bool: Whether records are buffered in the logger before publishing. Default is assumed to be true. +* **loggerType**: 'applicationInsights' | 'azureEventHub' | 'azureMonitor' | string (Required): Logger type. +* **resourceId**: string: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). + +## LoggerContractPropertiesCredentials +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## NamedValueCreateContractProperties +### Properties +* **displayName**: string (Required): Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. +* **keyVault**: [KeyVaultContractCreateProperties](#keyvaultcontractcreateproperties): Create keyVault contract details. +* **secret**: bool: Determines whether the value is a secret and should be encrypted or not. Default value is false. +* **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. +* **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. + +## NamedValueSecretContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + +## NotificationContractProperties +### Properties +* **description**: string (ReadOnly): Description of the Notification. +* **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. +* **title**: string (ReadOnly): Title of the Notification. + +## OAuth2AuthenticationSettingsContract +### Properties +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. + +## OpenidConnectProviderContractProperties +### Properties +* **clientId**: string (Required): Client ID of developer console which is the client application. +* **clientSecret**: string: Client Secret of developer console which is the client application. +* **description**: string: User-friendly description of OpenID Connect Provider. +* **displayName**: string (Required): User-friendly OpenID Connect Provider name. +* **metadataEndpoint**: string (Required): Metadata endpoint URI. + +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **schemaId**: string: Schema identifier. +* **type**: string (Required): Parameter type. +* **typeName**: string: Type name defined by the schema. +* **values**: string[]: Parameter values. + +## ParameterExampleContract ### Properties -* **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. -Instrumentation key for applicationInsights logger. -* **description**: string: Logger description. -* **isBuffered**: bool: Whether records are buffered in the logger before publishing. Default is assumed to be true. -* **loggerType**: 'applicationInsights' | 'azureEventHub' | 'azureMonitor' | string (Required): Logger type. -* **resourceId**: string: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource). +* **description**: string: Long description for the example +* **externalValue**: string: A URL that points to the literal example +* **summary**: string: Short description for the example +* **value**: any: Anything -## LoggerContractPropertiesCredentials +## ParameterExamplesContract ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) -## NamedValueCreateContractProperties +## ParameterExamplesContract ### Properties -* **displayName**: string (Required): Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. -* **keyVault**: [KeyVaultContractCreateProperties](#keyvaultcontractcreateproperties): Create keyVault contract details. -* **secret**: bool: Determines whether the value is a secret and should be encrypted or not. Default value is false. -* **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. -* **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +### Additional Properties +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) -## NotificationContractProperties +## PipelineDiagnosticSettings ### Properties -* **description**: string (ReadOnly): Description of the Notification. -* **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. -* **title**: string (ReadOnly): Title of the Notification. +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -## RecipientsContractProperties +## PolicyContractProperties ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. -## OpenidConnectProviderContractProperties +## PortalDelegationSettingsProperties ### Properties -* **clientId**: string (Required): Client ID of developer console which is the client application. -* **clientSecret**: string: Client Secret of developer console which is the client application. -* **description**: string: User-friendly description of OpenID Connect Provider. -* **displayName**: string (Required): User-friendly OpenID Connect Provider name. -* **metadataEndpoint**: string (Required): Metadata endpoint URI. +* **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. +* **url**: string: A delegation Url. +* **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. +* **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ## PortalRevisionContractProperties ### Properties @@ -1142,20 +1101,9 @@ Instrumentation key for applicationInsights logger. * **statusDetails**: string (ReadOnly): Portal revision publishing status details. * **updatedDateTime**: string (ReadOnly): Last updated date and time. -## PortalDelegationSettingsProperties -### Properties -* **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. -* **url**: string: A delegation Url. -* **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. -* **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. - -## SubscriptionsDelegationSettingsProperties -### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. - -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -1166,11 +1114,9 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties +## PrivateEndpoint ### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnectionRequestProperties ### Properties @@ -1178,9 +1124,18 @@ Instrumentation key for applicationInsights logger. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateEndpointConnectionWrapperProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **groupIds**: string[] (ReadOnly): All the Group ids. +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: string (ReadOnly): The provisioning state of the private endpoint connection resource. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ProductContractProperties ### Properties @@ -1192,12 +1147,66 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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 false. * **terms**: 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. -## GlobalSchemaContractProperties +## RecipientsContractProperties ### Properties -* **description**: string: Free-form schema entity description. -* **document**: any: Any object -* **schemaType**: 'json' | 'xml' | string (Required): Schema Type. Immutable. -* **value**: any: Anything +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RemotePrivateEndpointConnectionWrapper +### Properties +* **id**: string: Private Endpoint connection resource id +* **name**: string: Private Endpoint Connection Name +* **properties**: [PrivateEndpointConnectionWrapperProperties](#privateendpointconnectionwrapperproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string: Private Endpoint Connection Resource Type + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Api Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **components**: any: Any object +* **definitions**: any: Any object +* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ## SubscriptionCreateParameterProperties ### Properties @@ -1215,28 +1224,51 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. -## AccessInformationCreateParameterProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **enabled**: bool: Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string: Principal (User) Identifier. -* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1252,56 +1284,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## AuthorizationServerSecretsContract -### Properties -* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. -* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. -* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationSecretsContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string (ReadOnly): Principal (User) Identifier. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## NamedValueSecretContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/apimanagement/microsoft.apimanagement/2021-12-01-preview/types.md b/generated/apimanagement/microsoft.apimanagement/2021-12-01-preview/types.md index ae71c449cc..0db78fa364 100644 --- a/generated/apimanagement/microsoft.apimanagement/2021-12-01-preview/types.md +++ b/generated/apimanagement/microsoft.apimanagement/2021-12-01-preview/types.md @@ -538,56 +538,21 @@ * **ApiVersion**: 2021-12-01-preview * **Output**: [NamedValueSecretContract](#namedvaluesecretcontract) -## ApiManagementServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. -* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. - -## ApiManagementServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties +## AccessInformationCreateParameterProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **enabled**: bool: Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string: Principal (User) Identifier. +* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -## ApiManagementServiceProperties +## AccessInformationSecretsContract ### Properties -* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. -* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. -* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. -* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 -* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. -* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. -* **enableClientCertificate**: bool: 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. -* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. -* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. -* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. -* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. -* **notificationSenderEmail**: string: Email address from which the notification will be sent. -* **platformVersion**: 'mtv1' | 'stv1' | 'stv2' | 'undetermined' | string (ReadOnly): Compute Platform Version running the service. -* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. -* **privateEndpointConnections**: [RemotePrivateEndpointConnectionWrapper](#remoteprivateendpointconnectionwrapper)[]: List of Private Endpoint Connections of this service. -* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. -* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. -* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. -* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' -* **publisherEmail**: string (Required): Publisher email. -* **publisherName**: string (Required): Publisher name. -* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. -* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. -* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. -* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. -* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. +* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. +* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') +* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **principalId**: string (ReadOnly): Principal (User) Identifier. +* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. ## AdditionalLocation ### Properties @@ -602,90 +567,11 @@ dictionary key references will be ARM resource ids in the form: * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. * **zones**: string[]: A list of availability zones denoting where the resource needs to come from. -## ApiManagementServiceSkuProperties -### Properties -* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. -* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. - -## VirtualNetworkConfiguration -### Properties -* **subnetname**: string (ReadOnly): The name of the subnet. -* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. -* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. - -## ApiVersionConstraint -### Properties -* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. - -## CertificateConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. - -## CertificateInformation -### Properties -* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. -* **subject**: string (Required): Subject of the certificate. -* **thumbprint**: string (Required): Thumbprint of the certificate. - -## ApiManagementServiceBasePropertiesCustomProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostnameConfiguration -### Properties -* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. -* **certificatePassword**: string: Certificate Password. -* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. -* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. -* **defaultSslBinding**: bool: 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. -* **encodedCertificate**: string: Base64 Encoded certificate. -* **hostName**: string (Required): Hostname to configure on the Api Management service. -* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. -* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* -* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. -* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. - -## RemotePrivateEndpointConnectionWrapper -### Properties -* **id**: string: Private Endpoint connection resource id -* **name**: string: Private Endpoint Connection Name -* **properties**: [PrivateEndpointConnectionWrapperProperties](#privateendpointconnectionwrapperproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string: Private Endpoint Connection Resource Type - -## PrivateEndpointConnectionWrapperProperties -### Properties -* **groupIds**: string[] (ReadOnly): All the Group ids. -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: string (ReadOnly): The provisioning state of the private endpoint connection resource. - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ApimResourceTags +## ApiContactInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address +* **name**: string (WriteOnly): The identifying name of the contact person/organization +* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL ## ApiCreateOrUpdateProperties ### Properties @@ -719,46 +605,6 @@ dictionary key references will be ARM resource ids in the form: * **value**: string (WriteOnly): Content value when Importing an API. * **wsdlSelector**: [ApiCreateOrUpdatePropertiesWsdlSelector](#apicreateorupdatepropertieswsdlselector) (WriteOnly): Criteria to limit import of WSDL to a subset of the document. -## ApiVersionSetContractDetails -### Properties -* **description**: string (WriteOnly): Description of API Version Set. -* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. -* **name**: string (WriteOnly): The display Name of the API Version Set. -* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. -* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. -* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - -## AuthenticationSettingsContract -### Properties -* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. -* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. - -## OAuth2AuthenticationSettingsContract -### Properties -* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. -* **scope**: string (WriteOnly): operations scope. - -## OpenIdAuthenticationSettingsContract -### Properties -* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. -* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. - -## ApiContactInformation -### Properties -* **email**: string (WriteOnly): The email address of the contact person/organization. MUST be in the format of an email address -* **name**: string (WriteOnly): The identifying name of the contact person/organization -* **url**: string (WriteOnly): The URL pointing to the contact information. MUST be in the format of a URL - -## ApiLicenseInformation -### Properties -* **name**: string (WriteOnly): The license name used for the API -* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL - -## SubscriptionKeyParameterNamesContract -### Properties -* **header**: string (WriteOnly): Subscription key header name. -* **query**: string (WriteOnly): Subscription key query string parameter name. - ## ApiCreateOrUpdatePropertiesWsdlSelector ### Properties * **wsdlEndpointName**: string (WriteOnly): Name of endpoint(port) to import from WSDL @@ -768,139 +614,71 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **link**: string (ReadOnly): Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes. -## DiagnosticContractProperties -### Properties -* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. -* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. -* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. -* **logClientIp**: bool: Log the ClientIP. Default is false. -* **loggerId**: string (Required): Resource Id of a target logger. -* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. -* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. -* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. - -## PipelineDiagnosticSettings -### Properties -* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. -* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. - -## HttpMessageDiagnostic -### Properties -* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. -* **dataMasking**: [DataMasking](#datamasking) -* **headers**: string[]: Array of HTTP Headers to log. - -## BodyDiagnosticSettings -### Properties -* **bytes**: int: Number of request body bytes to log. - -## DataMasking -### Properties -* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers -* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters - -## DataMaskingEntity -### Properties -* **mode**: 'Hide' | 'Mask' | string: Data masking mode. -* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). - -## SamplingSettings -### Properties -* **percentage**: int: Rate of sampling for fixed-rate sampling. -* **samplingType**: 'fixed' | string: Sampling type. - -## IssueContractProperties -### Properties -* **apiId**: string: A resource identifier for the API the issue was created for. -* **createdDate**: string: Date and time when the issue was created. -* **description**: string (Required): Text describing the issue. -* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. -* **title**: string (Required): The issue title. -* **userId**: string (Required): A resource identifier for the user created the issue. - -## IssueAttachmentContractProperties -### Properties -* **content**: string (Required): An HTTP link or Base64-encoded binary data. -* **contentFormat**: string (Required): 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. -* **title**: string (Required): Filename by which the binary data will be saved. - -## IssueCommentContractProperties -### Properties -* **createdDate**: string: Date and time when the comment was created. -* **text**: string (Required): Comment text. -* **userId**: string (Required): A resource identifier for the user who left the comment. - -## OperationContractProperties -### Properties -* **description**: string: Description of the operation. May include HTML formatting tags. -* **displayName**: string (Required): Operation Name. -* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. -* **policies**: string: Operation Policies -* **request**: [RequestContract](#requestcontract): Operation request details. -* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. -* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. -* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} - -## RequestContract -### Properties -* **description**: string: Operation request description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. -* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. - -## ParameterContract +## ApiLicenseInformation ### Properties -* **defaultValue**: string: Default parameter value. -* **description**: string: Parameter description. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **name**: string (Required): Parameter name. -* **required**: bool: Specifies whether parameter is required or not. -* **schemaId**: string: Schema identifier. -* **type**: string (Required): Parameter type. -* **typeName**: string: Type name defined by the schema. -* **values**: string[]: Parameter values. +* **name**: string (WriteOnly): The license name used for the API +* **url**: string (WriteOnly): A URL to the license used for the API. MUST be in the format of a URL -## ParameterExamplesContract +## ApiManagementServiceBasePropertiesCustomProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) - -## ParameterExampleContract -### Properties -* **description**: string: Long description for the example -* **externalValue**: string: A URL that points to the literal example -* **summary**: string: Short description for the example -* **value**: any: Anything +* **Additional Properties Type**: string -## RepresentationContract +## ApiManagementServiceIdentity ### Properties -* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. -* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. -* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. -* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. -* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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 service. +* **userAssignedIdentities**: [ApiManagementServiceIdentityUserAssignedIdentities](#apimanagementserviceidentityuserassignedidentities): The list of user 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}'. -## ParameterExamplesContract +## ApiManagementServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ResponseContract +## ApiManagementServiceProperties ### Properties -* **description**: string: Operation response description. -* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. -* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. -* **statusCode**: int (Required): Operation response HTTP status code. +* **additionalLocations**: [AdditionalLocation](#additionallocation)[]: Additional datacenter locations of the API Management service. +* **apiVersionConstraint**: [ApiVersionConstraint](#apiversionconstraint): Control Plane Apis version constraint for the API Management service. +* **certificates**: [CertificateConfiguration](#certificateconfiguration)[]: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. +* **createdAtUtc**: string (ReadOnly): Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **customProperties**: [ApiManagementServiceBasePropertiesCustomProperties](#apimanagementservicebasepropertiescustomproperties): 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 them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384 +* **developerPortalUrl**: string (ReadOnly): DEveloper Portal endpoint URL of the API Management service. +* **disableGateway**: bool: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. +* **enableClientCertificate**: bool: 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. +* **gatewayRegionalUrl**: string (ReadOnly): Gateway URL of the API Management service in the Default Region. +* **gatewayUrl**: string (ReadOnly): Gateway URL of the API Management service. +* **hostnameConfigurations**: [HostnameConfiguration](#hostnameconfiguration)[]: Custom hostname configuration of the API Management service. +* **managementApiUrl**: string (ReadOnly): Management API endpoint URL of the API Management service. +* **notificationSenderEmail**: string: Email address from which the notification will be sent. +* **platformVersion**: 'mtv1' | 'stv1' | 'stv2' | 'undetermined' | string (ReadOnly): Compute Platform Version running the service. +* **portalUrl**: string (ReadOnly): Publisher portal endpoint Url of the API Management service. +* **privateEndpointConnections**: [RemotePrivateEndpointConnectionWrapper](#remoteprivateendpointconnectionwrapper)[]: List of Private Endpoint Connections of this service. +* **privateIPAddresses**: string[] (ReadOnly): Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. +* **provisioningState**: string (ReadOnly): The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. +* **publicIPAddresses**: string[] (ReadOnly): Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. +* **publicIpAddressId**: string: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' +* **publisherEmail**: string (Required): Publisher email. +* **publisherName**: string (Required): Publisher name. +* **restore**: bool: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. +* **scmUrl**: string (ReadOnly): SCM endpoint URL of the API Management service. +* **targetProvisioningState**: string (ReadOnly): The provisioning state of the API Management service, which is targeted by the long running operation started on the service. +* **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): Configuration of a virtual network to which API Management service is deployed. +* **virtualNetworkType**: 'External' | 'Internal' | 'None' | 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. -## PolicyContractProperties +## ApiManagementServiceSkuProperties ### Properties -* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. -* **value**: string (Required): Contents of the Policy as defined by the format. +* **capacity**: int (Required): Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. +* **name**: 'Basic' | 'Consumption' | 'Developer' | 'Isolated' | 'Premium' | 'Standard' | string (Required): Name of the Sku. -## TagContractProperties +## ApimResourceTags ### Properties -* **displayName**: string (ReadOnly): Tag name. +### Additional Properties +* **Additional Properties Type**: string ## ApiReleaseContractProperties ### Properties @@ -909,24 +687,18 @@ dictionary key references will be ARM resource ids in the form: * **notes**: string: Release Notes * **updatedDateTime**: string (ReadOnly): The time the API release was updated. -## SchemaContractProperties -### Properties -* **contentType**: string (Required): 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`. -* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Api Schema Document Properties. - -## SchemaDocumentProperties +## ApiVersionConstraint ### Properties -* **components**: any: Any object -* **definitions**: any: Any object -* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. +* **minApiVersion**: string: Limit control plane API calls to API Management service with version equal to or newer than this value. -## TagDescriptionBaseProperties +## ApiVersionSetContractDetails ### Properties -* **description**: string: Description of the Tag. -* **displayName**: string (ReadOnly): Tag name. -* **externalDocsDescription**: string: Description of the external resources describing the tag. -* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. -* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} +* **description**: string (WriteOnly): Description of API Version Set. +* **id**: string (WriteOnly): Identifier for existing API Version Set. Omit this value to create a new Version Set. +* **name**: string (WriteOnly): The display Name of the API Version Set. +* **versionHeaderName**: string (WriteOnly): Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. +* **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (WriteOnly): An value that determines where the API Version identifier will be located in a HTTP request. +* **versionQueryName**: string (WriteOnly): Name of query parameter that indicates the API Version if versioningScheme is set to `query`. ## ApiVersionSetContractProperties ### Properties @@ -936,6 +708,19 @@ dictionary key references will be ARM resource ids in the form: * **versioningScheme**: 'Header' | 'Query' | 'Segment' | string (Required): An value that determines where the API Version identifier will be located in a HTTP request. * **versionQueryName**: string: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. +## ArmIdWrapper +### Properties +* **id**: string (ReadOnly) + +## AssociationContractProperties +### Properties +* **provisioningState**: 'created': Provisioning state. + +## AuthenticationSettingsContract +### Properties +* **oAuth2**: [OAuth2AuthenticationSettingsContract](#oauth2authenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. +* **openid**: [OpenIdAuthenticationSettingsContract](#openidauthenticationsettingscontract) (WriteOnly): API OAuth2 Authentication settings details. + ## AuthorizationServerContractProperties ### Properties * **authorizationEndpoint**: string (Required): OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. @@ -955,10 +740,16 @@ dictionary key references will be ARM resource ids in the form: * **tokenBodyParameters**: [TokenBodyParameterContract](#tokenbodyparametercontract)[]: 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"}. * **tokenEndpoint**: string: OAuth token endpoint. Contains absolute URI to entity being referenced. -## TokenBodyParameterContract +## AuthorizationServerSecretsContract ### Properties -* **name**: string (Required): body parameter name. -* **value**: string (Required): body parameter value. +* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. +* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. +* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. + +## BackendAuthorizationHeaderCredentials +### Properties +* **parameter**: string (Required): Authentication Parameter value. +* **scheme**: string (Required): Authentication Scheme name. ## BackendContractProperties ### Properties @@ -980,11 +771,6 @@ dictionary key references will be ARM resource ids in the form: * **header**: [BackendCredentialsContractHeader](#backendcredentialscontractheader): Header Parameter description. * **query**: [BackendCredentialsContractQuery](#backendcredentialscontractquery): Query Parameter description. -## BackendAuthorizationHeaderCredentials -### Properties -* **parameter**: string (Required): Authentication Parameter value. -* **scheme**: string (Required): Authentication Scheme name. - ## BackendCredentialsContractHeader ### Properties ### Additional Properties @@ -999,6 +785,12 @@ dictionary key references will be ARM resource ids in the form: ### Properties * **serviceFabricCluster**: [BackendServiceFabricClusterProperties](#backendservicefabricclusterproperties): Properties of the Service Fabric Type Backend. +## BackendProxyContract +### Properties +* **password**: string: Password to connect to the WebProxy Server +* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. +* **username**: string: Username to connect to the WebProxy server + ## BackendServiceFabricClusterProperties ### Properties * **clientCertificateId**: string: The client certificate id for the management endpoint. @@ -1008,22 +800,15 @@ dictionary key references will be ARM resource ids in the form: * **serverCertificateThumbprints**: string[]: Thumbprints of certificates cluster management service uses for tls communication * **serverX509Names**: [X509CertificateName](#x509certificatename)[]: Server X509 Certificate Names Collection -## X509CertificateName -### Properties -* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. -* **name**: string: Common Name of the Certificate. - -## BackendProxyContract -### Properties -* **password**: string: Password to connect to the WebProxy Server -* **url**: string (Required): WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. -* **username**: string: Username to connect to the WebProxy server - ## BackendTlsProperties ### Properties * **validateCertificateChain**: bool: Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. * **validateCertificateName**: bool: Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. +## BodyDiagnosticSettings +### Properties +* **bytes**: int: Number of request body bytes to log. + ## CacheContractProperties ### Properties * **connectionString**: string (Required): Runtime connection string to cache @@ -1031,6 +816,13 @@ dictionary key references will be ARM resource ids in the form: * **resourceId**: string: Original uri of entity in external system cache points to * **useFromLocation**: string (Required): Location identifier to use cache from (should be either 'default' or valid Azure region identifier) +## CertificateConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **storeName**: 'CertificateAuthority' | 'Root' | string (Required): The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. + ## CertificateCreateOrUpdateProperties ### Properties * **data**: string (WriteOnly): Base 64 encoded certificate using the application/x-pkcs12 representation. @@ -1040,17 +832,24 @@ dictionary key references will be ARM resource ids in the form: * **subject**: string (ReadOnly): Subject attribute of the certificate. * **thumbprint**: string (ReadOnly): Thumbprint of the certificate. -## KeyVaultContractCreateProperties +## CertificateInformation ### Properties -* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. -* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. -* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi +* **expiry**: string (Required): Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **subject**: string (Required): Subject of the certificate. +* **thumbprint**: string (Required): Thumbprint of the certificate. -## KeyVaultLastAccessStatusContractProperties +## ClientSecretContract ### Properties -* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. -* **message**: string (ReadOnly): Details of the error else empty. -* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ClientSecretContract +### Properties +* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. + +## ContentItemContractProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any ## ContentTypeContractProperties ### Properties @@ -1060,31 +859,52 @@ dictionary key references will be ARM resource ids in the form: * **schema**: any: Any object * **version**: string: Content type version. -## ContentItemContractProperties +## DataMasking ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **headers**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for headers +* **queryParams**: [DataMaskingEntity](#datamaskingentity)[]: Masking settings for Url query parameters -## GatewayContractProperties +## DataMaskingEntity ### Properties -* **description**: string: Gateway description -* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. +* **mode**: 'Hide' | 'Mask' | string: Data masking mode. +* **value**: string: The name of an entity to mask (e.g. a name of a header or a query parameter). -## ResourceLocationDataContract +## DiagnosticContractProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located. -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **alwaysLog**: 'allErrors' | string: Specifies for what type of messages sampling settings should not apply. +* **backend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **frontend**: [PipelineDiagnosticSettings](#pipelinediagnosticsettings): Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. +* **httpCorrelationProtocol**: 'Legacy' | 'None' | 'W3C' | string: Sets correlation protocol to use for Application Insights diagnostics. +* **logClientIp**: bool: Log the ClientIP. Default is false. +* **loggerId**: string (Required): Resource Id of a target logger. +* **operationNameFormat**: 'Name' | 'Url' | string: The format of the Operation Name for Application Insights telemetries. Default is Name. +* **sampling**: [SamplingSettings](#samplingsettings): Sampling settings for Diagnostic. +* **verbosity**: 'error' | 'information' | 'verbose' | string: The verbosity level applied to traces emitted by trace policies. -## AssociationContractProperties +## EmailTemplateParametersContractProperties ### Properties -* **provisioningState**: 'created': Provisioning state. +* **description**: string: Template parameter description. +* **name**: string: Template parameter name. +* **title**: string: Template parameter title. + +## EmailTemplateUpdateParameterProperties +### Properties +* **body**: string: Email Template Body. This should be a valid XDocument +* **description**: string: Description of the Email Template. +* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. +* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. +* **subject**: string: Subject of the Template. +* **title**: string: Title of the Template. ## GatewayCertificateAuthorityContractProperties ### Properties * **isTrusted**: bool: Determines whether certificate authority is trusted. +## GatewayContractProperties +### Properties +* **description**: string: Gateway description +* **locationData**: [ResourceLocationDataContract](#resourcelocationdatacontract): Resource location data properties. + ## GatewayHostnameConfigurationContractProperties ### Properties * **certificateId**: string: Identifier of Certificate entity that will be used for TLS connection establishment @@ -1094,6 +914,26 @@ dictionary key references will be ARM resource ids in the form: * **tls10Enabled**: bool: Specifies if TLS 1.0 is supported * **tls11Enabled**: bool: Specifies if TLS 1.1 is supported +## GatewayKeysContract +### Properties +* **primary**: string (ReadOnly): Primary gateway key. +* **secondary**: string (ReadOnly): Secondary gateway key. + +## GlobalSchemaContractProperties +### Properties +* **description**: string: Free-form schema entity description. +* **document**: any: Any object +* **schemaType**: 'json' | 'xml' | string (Required): Schema Type. Immutable. +* **value**: any: Anything + +## GroupContractProperties +### Properties +* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. +* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. +* **displayName**: string (ReadOnly): Group name. +* **externalId**: string (ReadOnly): For 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. +* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. + ## GroupCreateParametersProperties ### Properties * **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. @@ -1102,6 +942,26 @@ dictionary key references will be ARM resource ids in the form: * **externalId**: 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. * **type**: 'custom' | 'external' | 'system': Group type. +## HostnameConfiguration +### Properties +* **certificate**: [CertificateInformation](#certificateinformation): SSL certificate information. +* **certificatePassword**: string: Certificate Password. +* **certificateSource**: 'BuiltIn' | 'Custom' | 'KeyVault' | 'Managed' | string: Certificate Source. +* **certificateStatus**: 'Completed' | 'Failed' | 'InProgress' | string: Certificate Status. +* **defaultSslBinding**: bool: 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. +* **encodedCertificate**: string: Base64 Encoded certificate. +* **hostName**: string (Required): Hostname to configure on the Api Management service. +* **identityClientId**: string: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. +* **keyVaultId**: 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 aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* +* **negotiateClientCertificate**: bool: Specify true to always negotiate client certificate on the hostname. Default Value is false. +* **type**: 'DeveloperPortal' | 'Management' | 'Portal' | 'Proxy' | 'Scm' | string (Required): Hostname type. + +## HttpMessageDiagnostic +### Properties +* **body**: [BodyDiagnosticSettings](#bodydiagnosticsettings): Body logging settings. +* **dataMasking**: [DataMasking](#datamasking) +* **headers**: string[]: Array of HTTP Headers to log. + ## IdentityProviderCreateContractProperties ### Properties * **allowedTenants**: string[]: List of Allowed Tenants when configuring Azure Active Directory login. @@ -1116,6 +976,39 @@ dictionary key references will be ARM resource ids in the form: * **signupPolicyName**: string: Signup Policy Name. Only applies to AAD B2C Identity Provider. * **type**: 'aad' | 'aadB2C' | 'facebook' | 'google' | 'microsoft' | 'twitter' | string +## IssueAttachmentContractProperties +### Properties +* **content**: string (Required): An HTTP link or Base64-encoded binary data. +* **contentFormat**: string (Required): 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. +* **title**: string (Required): Filename by which the binary data will be saved. + +## IssueCommentContractProperties +### Properties +* **createdDate**: string: Date and time when the comment was created. +* **text**: string (Required): Comment text. +* **userId**: string (Required): A resource identifier for the user who left the comment. + +## IssueContractProperties +### Properties +* **apiId**: string: A resource identifier for the API the issue was created for. +* **createdDate**: string: Date and time when the issue was created. +* **description**: string (Required): Text describing the issue. +* **state**: 'closed' | 'open' | 'proposed' | 'removed' | 'resolved' | string: Status of the issue. +* **title**: string (Required): The issue title. +* **userId**: string (Required): A resource identifier for the user created the issue. + +## KeyVaultContractCreateProperties +### Properties +* **identityClientId**: string: Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. +* **lastStatus**: [KeyVaultLastAccessStatusContractProperties](#keyvaultlastaccessstatuscontractproperties) (ReadOnly): Issue contract Update Properties. +* **secretIdentifier**: string: Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi + +## KeyVaultLastAccessStatusContractProperties +### Properties +* **code**: string (ReadOnly): Last status code for sync and refresh of secret from key vault. +* **message**: string (ReadOnly): Details of the error else empty. +* **timeStampUtc**: string (ReadOnly): Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. + ## LoggerContractProperties ### Properties * **credentials**: [LoggerContractPropertiesCredentials](#loggercontractpropertiescredentials): The name and SendRule connection string of the event hub for azureEventHub logger. @@ -1138,16 +1031,25 @@ Instrumentation key for applicationInsights logger. * **tags**: string[]: Optional tags that when provided can be used to filter the NamedValue list. * **value**: string: Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +## NamedValueSecretContract +### Properties +* **value**: string (ReadOnly): This is secret value of the NamedValue entity. + ## NotificationContractProperties ### Properties * **description**: string (ReadOnly): Description of the Notification. * **recipients**: [RecipientsContractProperties](#recipientscontractproperties) (ReadOnly): Notification Parameter contract. * **title**: string (ReadOnly): Title of the Notification. -## RecipientsContractProperties +## OAuth2AuthenticationSettingsContract ### Properties -* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. -* **users**: string[] (ReadOnly): List of Users subscribed for the notification. +* **authorizationServerId**: string (WriteOnly): OAuth authorization server identifier. +* **scope**: string (WriteOnly): operations scope. + +## OpenIdAuthenticationSettingsContract +### Properties +* **bearerTokenSendingMethods**: 'authorizationHeader' | 'query' | string[] (WriteOnly): How to send token to the server. +* **openidProviderId**: string (WriteOnly): OAuth authorization server identifier. ## OpenidConnectProviderContractProperties ### Properties @@ -1157,21 +1059,62 @@ Instrumentation key for applicationInsights logger. * **displayName**: string (Required): User-friendly OpenID Connect Provider name. * **metadataEndpoint**: string (Required): Metadata endpoint URI. +## OperationContractProperties +### Properties +* **description**: string: Description of the operation. May include HTML formatting tags. +* **displayName**: string (Required): Operation Name. +* **method**: string (Required): A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. +* **policies**: string: Operation Policies +* **request**: [RequestContract](#requestcontract): Operation request details. +* **responses**: [ResponseContract](#responsecontract)[]: Array of Operation responses. +* **templateParameters**: [ParameterContract](#parametercontract)[]: Collection of URL template parameters. +* **urlTemplate**: string (Required): Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} + +## ParameterContract +### Properties +* **defaultValue**: string: Default parameter value. +* **description**: string: Parameter description. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **name**: string (Required): Parameter name. +* **required**: bool: Specifies whether parameter is required or not. +* **schemaId**: string: Schema identifier. +* **type**: string (Required): Parameter type. +* **typeName**: string: Type name defined by the schema. +* **values**: string[]: Parameter values. + +## ParameterExampleContract +### Properties +* **description**: string: Long description for the example +* **externalValue**: string: A URL that points to the literal example +* **summary**: string: Short description for the example +* **value**: any: Anything + +## ParameterExamplesContract +### Properties +### Additional Properties +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) + +## ParameterExamplesContract +### Properties +### Additional Properties +* **Additional Properties Type**: [ParameterExampleContract](#parameterexamplecontract) + +## PipelineDiagnosticSettings +### Properties +* **request**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. +* **response**: [HttpMessageDiagnostic](#httpmessagediagnostic): Http message diagnostic settings. + +## PolicyContractProperties +### Properties +* **format**: 'rawxml' | 'rawxml-link' | 'xml' | 'xml-link' | string: Format of the policyContent. +* **value**: string (Required): Contents of the Policy as defined by the format. + ## PolicyFragmentContractProperties ### Properties * **description**: string: Policy fragment description. * **format**: 'rawxml' | 'xml' | string * **value**: string (Required): Contents of the policy fragment. -## PortalConfigProperties -### Properties -* **cors**: [PortalConfigCorsProperties](#portalconfigcorsproperties): The developer portal Cross-Origin Resource Sharing (CORS) settings. -* **csp**: [PortalConfigCspProperties](#portalconfigcspproperties): The developer portal Content Security Policy (CSP) settings. -* **delegation**: [PortalConfigDelegationProperties](#portalconfigdelegationproperties) -* **enableBasicAuth**: bool: Enable or disable Basic authentication method. -* **signin**: [PortalConfigPropertiesSignin](#portalconfigpropertiessignin) -* **signup**: [PortalConfigPropertiesSignup](#portalconfigpropertiessignup) - ## PortalConfigCorsProperties ### Properties * **allowedOrigins**: string[]: Allowed origins, e.g. `https://trusted.com`. @@ -1189,6 +1132,15 @@ Instrumentation key for applicationInsights logger. * **delegationUrl**: string: A delegation endpoint URL. * **validationKey**: string: A base64-encoded validation key to ensure requests originate from Azure API Management service. +## PortalConfigProperties +### Properties +* **cors**: [PortalConfigCorsProperties](#portalconfigcorsproperties): The developer portal Cross-Origin Resource Sharing (CORS) settings. +* **csp**: [PortalConfigCspProperties](#portalconfigcspproperties): The developer portal Content Security Policy (CSP) settings. +* **delegation**: [PortalConfigDelegationProperties](#portalconfigdelegationproperties) +* **enableBasicAuth**: bool: Enable or disable Basic authentication method. +* **signin**: [PortalConfigPropertiesSignin](#portalconfigpropertiessignin) +* **signup**: [PortalConfigPropertiesSignup](#portalconfigpropertiessignup) + ## PortalConfigPropertiesSignin ### Properties * **require**: bool: Redirect anonymous users to the sign-in page. @@ -1202,15 +1154,6 @@ Instrumentation key for applicationInsights logger. * **requireConsent**: bool: Ask user for consent to the terms of service. * **text**: string: A terms of service text. -## PortalRevisionContractProperties -### Properties -* **createdDateTime**: string (ReadOnly): Portal's revision creation date and time. -* **description**: string: Portal revision description. -* **isCurrent**: bool: Indicates if the portal's revision is public. -* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Status of the portal's revision. -* **statusDetails**: string (ReadOnly): Portal revision publishing status details. -* **updatedDateTime**: string (ReadOnly): Last updated date and time. - ## PortalDelegationSettingsProperties ### Properties * **subscriptions**: [SubscriptionsDelegationSettingsProperties](#subscriptionsdelegationsettingsproperties): Subscriptions delegation settings properties. @@ -1218,13 +1161,18 @@ Instrumentation key for applicationInsights logger. * **userRegistration**: [RegistrationDelegationSettingsProperties](#registrationdelegationsettingsproperties): User registration delegation settings properties. * **validationKey**: string: A base64-encoded validation key to validate, that a request is coming from Azure API Management. -## SubscriptionsDelegationSettingsProperties +## PortalRevisionContractProperties ### Properties -* **enabled**: bool: Enable or disable delegation for subscriptions. +* **createdDateTime**: string (ReadOnly): Portal's revision creation date and time. +* **description**: string: Portal revision description. +* **isCurrent**: bool: Indicates if the portal's revision is public. +* **status**: 'completed' | 'failed' | 'pending' | 'publishing' | string (ReadOnly): Status of the portal's revision. +* **statusDetails**: string (ReadOnly): Portal revision publishing status details. +* **updatedDateTime**: string (ReadOnly): Last updated date and time. -## RegistrationDelegationSettingsProperties +## PortalSettingValidationKeyContract ### Properties -* **enabled**: bool: Enable or disable delegation for user registration. +* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. ## PortalSigninSettingProperties ### Properties @@ -1235,11 +1183,9 @@ Instrumentation key for applicationInsights logger. * **enabled**: bool: Allow users to sign up on a developer portal. * **termsOfService**: [TermsOfServiceProperties](#termsofserviceproperties): Terms of service contract properties. -## TermsOfServiceProperties +## PrivateEndpoint ### Properties -* **consentRequired**: bool: Ask user for consent to the terms of service. -* **enabled**: bool: Display terms of service during a sign-up process. -* **text**: string: A terms of service text. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnectionRequestProperties ### Properties @@ -1247,9 +1193,18 @@ Instrumentation key for applicationInsights logger. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateEndpointConnectionWrapperProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **groupIds**: string[] (ReadOnly): All the Group ids. +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: string (ReadOnly): The provisioning state of the private endpoint connection resource. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ProductContractProperties ### Properties @@ -1261,12 +1216,78 @@ Instrumentation key for applicationInsights logger. * **subscriptionsLimit**: int: 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 false. * **terms**: 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. -## GlobalSchemaContractProperties +## RecipientsContractProperties ### Properties -* **description**: string: Free-form schema entity description. -* **document**: any: Any object -* **schemaType**: 'json' | 'xml' | string (Required): Schema Type. Immutable. -* **value**: any: Anything +* **emails**: string[] (ReadOnly): List of Emails subscribed for the notification. +* **users**: string[] (ReadOnly): List of Users subscribed for the notification. + +## RegistrationDelegationSettingsProperties +### Properties +* **enabled**: bool: Enable or disable delegation for user registration. + +## RemotePrivateEndpointConnectionWrapper +### Properties +* **id**: string: Private Endpoint connection resource id +* **name**: string: Private Endpoint Connection Name +* **properties**: [PrivateEndpointConnectionWrapperProperties](#privateendpointconnectionwrapperproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string: Private Endpoint Connection Resource Type + +## RepresentationContract +### Properties +* **contentType**: string (Required): Specifies a registered or custom content type for this representation, e.g. application/xml. +* **examples**: [ParameterExamplesContract](#parameterexamplescontract): Parameter examples. +* **formParameters**: [ParameterContract](#parametercontract)[]: Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. +* **schemaId**: string: Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. +* **typeName**: string: Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. + +## RequestContract +### Properties +* **description**: string: Operation request description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation request headers. +* **queryParameters**: [ParameterContract](#parametercontract)[]: Collection of operation request query parameters. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation request representations. + +## ResourceCollection +### Properties +* **count**: int (ReadOnly): Total record count number. +* **nextLink**: string (ReadOnly): Next page link if any. +* **value**: [ResourceCollectionValueItem](#resourcecollectionvalueitem)[] (ReadOnly): A collection of resources. + +## ResourceCollectionValueItem +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## ResourceLocationDataContract +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located. +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## ResponseContract +### Properties +* **description**: string: Operation response description. +* **headers**: [ParameterContract](#parametercontract)[]: Collection of operation response headers. +* **representations**: [RepresentationContract](#representationcontract)[]: Collection of operation response representations. +* **statusCode**: int (Required): Operation response HTTP status code. + +## SamplingSettings +### Properties +* **percentage**: int: Rate of sampling for fixed-rate sampling. +* **samplingType**: 'fixed' | string: Sampling type. + +## SchemaContractProperties +### Properties +* **contentType**: string (Required): 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`. +* **document**: [SchemaDocumentProperties](#schemadocumentproperties): Api Schema Document Properties. + +## SchemaDocumentProperties +### Properties +* **components**: any: Any object +* **definitions**: any: Any object +* **value**: string: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. ## SubscriptionCreateParameterProperties ### Properties @@ -1284,28 +1305,51 @@ Instrumentation key for applicationInsights logger. * **state**: 'active' | 'cancelled' | 'expired' | 'rejected' | 'submitted' | 'suspended': Subscription 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. * **stateComment**: string (ReadOnly): Optional subscription comment added by an administrator when the state is changed to the 'rejected'. -## EmailTemplateUpdateParameterProperties +## SubscriptionKeyParameterNamesContract ### Properties -* **body**: string: Email Template Body. This should be a valid XDocument -* **description**: string: Description of the Email Template. -* **isDefault**: bool (ReadOnly): Whether the template is the default template provided by API Management or has been edited. -* **parameters**: [EmailTemplateParametersContractProperties](#emailtemplateparameterscontractproperties)[]: Email Template Parameter values. -* **subject**: string: Subject of the Template. -* **title**: string: Title of the Template. +* **header**: string (WriteOnly): Subscription key header name. +* **query**: string (WriteOnly): Subscription key query string parameter name. -## EmailTemplateParametersContractProperties +## SubscriptionKeysContract ### Properties -* **description**: string: Template parameter description. -* **name**: string: Template parameter name. -* **title**: string: Template parameter title. +* **primaryKey**: string (ReadOnly): Subscription primary key. +* **secondaryKey**: string (ReadOnly): Subscription secondary key. -## AccessInformationCreateParameterProperties +## SubscriptionsDelegationSettingsProperties ### Properties -* **enabled**: bool: Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (WriteOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string: Principal (User) Identifier. -* **secondaryKey**: string (WriteOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **enabled**: bool: Enable or disable delegation for subscriptions. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TagContractProperties +### Properties +* **displayName**: string (ReadOnly): Tag name. + +## TagDescriptionBaseProperties +### Properties +* **description**: string: Description of the Tag. +* **displayName**: string (ReadOnly): Tag name. +* **externalDocsDescription**: string: Description of the external resources describing the tag. +* **externalDocsUrl**: string: Absolute URL of external resources describing the tag. +* **tagId**: string (ReadOnly): Identifier of the tag in the form of /tags/{tagId} + +## TermsOfServiceProperties +### Properties +* **consentRequired**: bool: Ask user for consent to the terms of service. +* **enabled**: bool: Display terms of service during a sign-up process. +* **text**: string: A terms of service text. + +## TokenBodyParameterContract +### Properties +* **name**: string (Required): body parameter name. +* **value**: string (Required): body parameter value. ## UserCreateParameterProperties ### Properties @@ -1321,68 +1365,24 @@ Instrumentation key for applicationInsights logger. * **registrationDate**: string (ReadOnly): Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. * **state**: 'active' | 'blocked' | 'deleted' | 'pending' | 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. -## GroupContractProperties -### Properties -* **builtIn**: bool (ReadOnly): true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. -* **description**: string (ReadOnly): Group description. Can contain HTML formatting tags. -* **displayName**: string (ReadOnly): Group name. -* **externalId**: string (ReadOnly): For 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. -* **type**: 'custom' | 'external' | 'system' (ReadOnly): Group type. - ## UserIdentityContract ### Properties * **id**: string: Identifier value within provider. * **provider**: string: Identity provider name. -## GatewayKeysContract -### Properties -* **primary**: string (ReadOnly): Primary gateway key. -* **secondary**: string (ReadOnly): Secondary gateway key. - -## ResourceCollection -### Properties -* **count**: int (ReadOnly): Total record count number. -* **nextLink**: string (ReadOnly): Next page link if any. -* **value**: [ResourceCollectionValueItem](#resourcecollectionvalueitem)[] (ReadOnly): A collection of resources. - -## ResourceCollectionValueItem -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## AuthorizationServerSecretsContract -### Properties -* **clientSecret**: string (ReadOnly): oAuth Authorization Server Secrets. -* **resourceOwnerPassword**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. -* **resourceOwnerUsername**: string (ReadOnly): Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## ClientSecretContract -### Properties -* **clientSecret**: string (ReadOnly): Client or app secret used in IdentityProviders, Aad, OpenID or OAuth. - -## PortalSettingValidationKeyContract -### Properties -* **validationKey**: string (ReadOnly): This is secret value of the validation key in portal settings. - -## SubscriptionKeysContract +## UserIdentityProperties ### Properties -* **primaryKey**: string (ReadOnly): Subscription primary key. -* **secondaryKey**: string (ReadOnly): Subscription secondary key. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## AccessInformationSecretsContract +## VirtualNetworkConfiguration ### Properties -* **enabled**: bool (ReadOnly): Determines whether direct access is enabled. -* **id**: string (ReadOnly): Access Information type ('access' or 'gitAccess') -* **primaryKey**: string (ReadOnly): Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. -* **principalId**: string (ReadOnly): Principal (User) Identifier. -* **secondaryKey**: string (ReadOnly): Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. +* **subnetname**: string (ReadOnly): The name of the subnet. +* **subnetResourceId**: string: The full resource ID of a subnet in a virtual network to deploy the API Management service in. +* **vnetid**: string (ReadOnly): The virtual network ID. This is typically a GUID. Expect a null GUID by default. -## NamedValueSecretContract +## X509CertificateName ### Properties -* **value**: string (ReadOnly): This is secret value of the NamedValue entity. +* **issuerCertificateThumbprint**: string: Thumbprint for the Issuer of the Certificate. +* **name**: string: Common Name of the Certificate. diff --git a/generated/app/log.out b/generated/app/log.out index 347005caf2..91f38ec2d5 100644 --- a/generated/app/log.out +++ b/generated/app/log.out @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.app-2022-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -32,11 +32,11 @@ warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 23ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.app-2022-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -52,9 +52,9 @@ warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 11ms -info | Autorest completed in 11.92s. 4 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 11.25s. 4 files generated. diff --git a/generated/app/microsoft.app/2022-01-01-preview/types.md b/generated/app/microsoft.app/2022-01-01-preview/types.md index a0a6a90fd8..7b7b1a61fc 100644 --- a/generated/app/microsoft.app/2022-01-01-preview/types.md +++ b/generated/app/microsoft.app/2022-01-01-preview/types.md @@ -87,91 +87,139 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [SecretsCollection](#secretscollection) -## ManagedServiceIdentity +## AllowedAudiencesValidation ### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## UserAssignedIdentities +## AllowedPrincipals ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **groups**: string[]: The list of the allowed groups. +* **identities**: string[]: The list of the allowed identities. -## UserAssignedIdentity +## Apple ### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider -## ContainerAppProperties +## AppleRegistration ### Properties -* **configuration**: [Configuration](#configuration): Non versioned Container App configuration properties that define the mutable settings of a Container app -* **customDomainVerificationId**: string (ReadOnly): Id used to verify domain name ownership -* **latestRevisionFqdn**: string (ReadOnly): Fully Qualified Domain Name of the latest revision of the Container App. -* **latestRevisionName**: string (ReadOnly): Name of the latest revision of the Container App. -* **managedEnvironmentId**: string: Resource ID of the Container App's environment. -* **outboundIPAddresses**: string[] (ReadOnly): Outbound IP Addresses for container app. -* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Container App. -* **template**: [Template](#template): Container App versioned application definition. -Defines the desired state of an immutable revision. -Any changes to this section Will result in a new revision being created +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. -## Configuration +## AppLogsConfiguration ### Properties -* **activeRevisionsMode**: 'multiple' | 'single' | string: ActiveRevisionsMode controls how active revisions are handled for the Container app: -Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode -* **dapr**: [Dapr](#dapr): Container App Dapr configuration. -* **ingress**: [Ingress](#ingress): Container App Ingress configuration. -* **registries**: [RegistryCredentials](#registrycredentials)[]: Collection of private container registry credentials for containers used by the Container app -* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Container app +* **destination**: string: Logs destination +* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration): Log analytics configuration -## Dapr +## AppRegistration ### Properties -* **appId**: string: Dapr application identifier -* **appPort**: int: Tells Dapr which port your application is listening on -* **appProtocol**: 'grpc' | 'http' | string: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http -* **enabled**: bool: Boolean indicating if the Dapr side car is enabled +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. -## Ingress +## AuthConfigProperties ### Properties -* **allowInsecure**: bool: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections -* **customDomains**: [CustomDomain](#customdomain)[]: custom domain bindings for Container Apps' hostnames. -* **external**: bool: Bool indicating if app exposes an external http endpoint -* **fqdn**: string (ReadOnly): Hostname. -* **targetPort**: int: Target Port in containers for traffic from ingress -* **traffic**: [TrafficWeight](#trafficweight)[]: Traffic weights for app's revisions -* **transport**: 'auto' | 'http' | 'http2' | string: Ingress transport protocol +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of ContainerApp Service Authentication/Authorization. -## CustomDomain +## AuthPlatform ### Properties -* **bindingType**: 'Disabled' | 'SniEnabled' | string: Custom Domain binding type. -* **certificateId**: string (Required): Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. -* **name**: string (Required): Hostname. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## TrafficWeight +## AzureActiveDirectory ### Properties -* **latestRevision**: bool: Indicates that the traffic weight belongs to a latest stable revision -* **revisionName**: string: Name of a revision -* **weight**: int: Traffic weight assigned to a revision +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. -## RegistryCredentials +## AzureActiveDirectoryLogin ### Properties -* **passwordSecretRef**: string: The name of the Secret that contains the registry login password -* **server**: string: Container Registry Server -* **username**: string: Container Registry Username +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". -## Secret +## AzureActiveDirectoryRegistration ### Properties -* **name**: string: Secret Name. -* **value**: string (WriteOnly): Secret Value. +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 -## Template +## AzureActiveDirectoryValidation ### Properties -* **containers**: [Container](#container)[]: List of container definitions for the Container App. -* **revisionSuffix**: string: User friendly suffix that is appended to the revision name -* **scale**: [Scale](#scale): Container App scaling configurations. -* **volumes**: [Volume](#volume)[]: List of volume definitions for the Container App. +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. + +## AzureCredentials +### Properties +* **clientId**: string (WriteOnly): Client Id. +* **clientSecret**: string (WriteOnly): Client Secret. +* **subscriptionId**: string: Subscription Id. +* **tenantId**: string (WriteOnly): Tenant Id. + +## AzureFileProperties +### Properties +* **accessMode**: 'ReadOnly' | 'ReadWrite' | string: Access mode for storage +* **accountKey**: string: Storage account key for azure file. +* **accountName**: string: Storage account name for azure file. +* **shareName**: string: Azure file share name. + +## AzureStaticWebApps +### Properties +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider + +## AzureStaticWebAppsRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. + +## CertificateProperties +### Properties +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **password**: string (WriteOnly): Certificate password. +* **provisioningState**: 'Canceled' | 'DeleteFailed' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Provisioning state of the certificate. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. +* **value**: any (WriteOnly): PFX or PEM blob + +## ClientRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## Configuration +### Properties +* **activeRevisionsMode**: 'multiple' | 'single' | string: ActiveRevisionsMode controls how active revisions are handled for the Container app: +Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode +* **dapr**: [Dapr](#dapr): Container App Dapr configuration. +* **ingress**: [Ingress](#ingress): Container App Ingress configuration. +* **registries**: [RegistryCredentials](#registrycredentials)[]: Collection of private container registry credentials for containers used by the Container app +* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Container app ## Container ### Properties @@ -184,12 +232,6 @@ Any changes to this section Will result in a new revision being created * **resources**: [ContainerResources](#containerresources): Container App container resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: Container volume mounts. -## EnvironmentVar -### Properties -* **name**: string: Environment variable name. -* **secretRef**: string: Name of the Container App secret from which to pull the environment variable value. -* **value**: string: Non-secret environment variable value. - ## ContainerAppProbe ### Properties * **failureThreshold**: int: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. @@ -220,40 +262,68 @@ Any changes to this section Will result in a new revision being created * **host**: string: Optional: Host name to connect to, defaults to the pod IP. * **port**: int (Required): Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +## ContainerAppProperties +### Properties +* **configuration**: [Configuration](#configuration): Non versioned Container App configuration properties that define the mutable settings of a Container app +* **customDomainVerificationId**: string (ReadOnly): Id used to verify domain name ownership +* **latestRevisionFqdn**: string (ReadOnly): Fully Qualified Domain Name of the latest revision of the Container App. +* **latestRevisionName**: string (ReadOnly): Name of the latest revision of the Container App. +* **managedEnvironmentId**: string: Resource ID of the Container App's environment. +* **outboundIPAddresses**: string[] (ReadOnly): Outbound IP Addresses for container app. +* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Container App. +* **template**: [Template](#template): Container App versioned application definition. +Defines the desired state of an immutable revision. +Any changes to this section Will result in a new revision being created + +## ContainerAppSecret +### Properties +* **name**: string (ReadOnly): Secret Name. +* **value**: string (ReadOnly): Secret Value. + ## ContainerResources ### Properties * **cpu**: int: Required CPU in cores, e.g. 0.5 * **ephemeralStorage**: string (ReadOnly): Ephemeral Storage, e.g. "1Gi" * **memory**: string: Required memory, e.g. "250Mb" -## VolumeMount +## CookieExpiration ### Properties -* **mountPath**: string: Path within the container at which the volume should be mounted.Must not contain ':'. -* **volumeName**: string: This must match the Name of a Volume. +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. -## Scale +## CustomDomain ### Properties -* **maxReplicas**: int: Optional. Maximum number of container replicas. Defaults to 10 if not set. -* **minReplicas**: int: Optional. Minimum number of container replicas. -* **rules**: [ScaleRule](#scalerule)[]: Scaling rules. +* **bindingType**: 'Disabled' | 'SniEnabled' | string: Custom Domain binding type. +* **certificateId**: string (Required): Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. +* **name**: string (Required): Hostname. -## ScaleRule +## CustomHostnameAnalysisResult ### Properties -* **azureQueue**: [QueueScaleRule](#queuescalerule): Container App container Azure Queue based scaling rule. -* **custom**: [CustomScaleRule](#customscalerule): Container App container Custom scaling rule. -* **http**: [HttpScaleRule](#httpscalerule): Container App container Custom scaling rule. -* **name**: string: Scale Rule Name +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [CustomHostnameAnalysisResultProperties](#customhostnameanalysisresultproperties) (ReadOnly): CustomHostnameAnalysisResult resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## QueueScaleRule +## CustomHostnameAnalysisResultProperties ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the queue scale rule. -* **queueLength**: int: Queue length. -* **queueName**: string: Queue name. +* **alternateCNameRecords**: string[] (ReadOnly): Alternate CName records visible for this hostname. +* **alternateTxtRecords**: string[] (ReadOnly): Alternate TXT records visible for this hostname. +* **aRecords**: string[] (ReadOnly): A records visible for this hostname. +* **cNameRecords**: string[] (ReadOnly): CName records visible for this hostname. +* **conflictingContainerAppResourceId**: string (ReadOnly): Name of the conflicting Container App on the Managed Environment if it's within the same subscription. +* **customDomainVerificationFailureInfo**: [DefaultErrorResponse](#defaulterrorresponse) (ReadOnly): App Service error response. +* **customDomainVerificationTest**: 'Failed' | 'Passed' | 'Skipped' (ReadOnly): DNS verification test result. +* **hasConflictOnManagedEnvironment**: bool (ReadOnly): true if there is a conflict on the Container App's managed environment; otherwise, false. +* **hostName**: string (ReadOnly): Host name that was analyzed +* **isHostnameAlreadyVerified**: bool (ReadOnly): true if hostname is already verified; otherwise, false. +* **txtRecords**: string[] (ReadOnly): TXT records visible for this hostname. -## ScaleRuleAuth +## CustomOpenIdConnectProvider ### Properties -* **secretRef**: string: Name of the Container App secret from which to pull the auth params. -* **triggerParameter**: string: Trigger Parameter that uses the secret +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. ## CustomScaleRule ### Properties @@ -267,43 +337,86 @@ eg: azure-servicebus, redis etc. ### Additional Properties * **Additional Properties Type**: string -## HttpScaleRule +## Dapr ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. -* **metadata**: [HttpScaleRuleMetadata](#httpscalerulemetadata): Metadata properties to describe http scale rule. +* **appId**: string: Dapr application identifier +* **appPort**: int: Tells Dapr which port your application is listening on +* **appProtocol**: 'grpc' | 'http' | string: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http +* **enabled**: bool: Boolean indicating if the Dapr side car is enabled -## HttpScaleRuleMetadata +## DaprComponentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **componentType**: string: Component type +* **ignoreErrors**: bool: Boolean describing if the component errors are ignores +* **initTimeout**: string: Initialization timeout +* **metadata**: [DaprMetadata](#daprmetadata)[]: Component metadata +* **scopes**: string[]: Names of container apps that can use this Dapr component +* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Dapr component +* **version**: string: Component version -## Volume +## DaprMetadata ### Properties -* **name**: string: Volume name. -* **storageName**: string: Name of storage resource. No need to provide for EmptyDir. -* **storageType**: 'AzureFile' | 'EmptyDir' | string: Storage type for the volume. If not provided, use EmptyDir. +* **name**: string: Metadata property name. +* **secretRef**: string: Name of the Dapr Component secret from which to pull the metadata property value. +* **value**: string: Metadata property value. -## SystemData +## DefaultAuthorizationPolicy ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. +* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. -## TrackedResourceTags +## DefaultErrorResponse ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **error**: [DefaultErrorResponseError](#defaulterrorresponseerror) (ReadOnly): Error model. -## AuthConfigProperties +## DefaultErrorResponseError ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of ContainerApp Service Authentication/Authorization. +* **code**: string (ReadOnly): Standardized string to programmatically identify the error. +* **details**: [DefaultErrorResponseErrorDetailsItem](#defaulterrorresponseerrordetailsitem)[] (ReadOnly): Details or the error +* **innererror**: string (ReadOnly): More information to debug error. +* **message**: string (ReadOnly): Detailed error description and debugging information. +* **target**: string (ReadOnly): Detailed error description and debugging information. + +## DefaultErrorResponseErrorDetailsItem +### Properties +* **code**: string (ReadOnly): Standardized string to programmatically identify the error. +* **message**: string (ReadOnly): Detailed error description and debugging information. +* **target**: string (ReadOnly): Detailed error description and debugging information. + +## EnvironmentVar +### Properties +* **name**: string: Environment variable name. +* **secretRef**: string: Name of the Container App secret from which to pull the environment variable value. +* **value**: string: Non-secret environment variable value. + +## Facebook +### Properties +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets + +## ForwardProxy +### Properties +* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. +* **customHostHeaderName**: string: The name of the header containing the host of the request. +* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. + +## GitHub +### Properties +* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets + +## GithubActionConfiguration +### Properties +* **azureCredentials**: [AzureCredentials](#azurecredentials): Container App credentials. +* **dockerfilePath**: string: Docker file path +* **os**: string: Operation system +* **publishType**: string: Code or Image +* **registryInfo**: [RegistryInfo](#registryinfo): Container App registry information. +* **runtimeStack**: string: Runtime stack +* **runtimeVersion**: string: Runtime Version ## GlobalValidation ### Properties @@ -313,18 +426,29 @@ This setting is only needed if multiple providers are configured and the unauthe action is set to "RedirectToLoginPage". * **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. +## Google +### Properties +* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. + +## HttpScaleRule +### Properties +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. +* **metadata**: [HttpScaleRuleMetadata](#httpscalerulemetadata): Metadata properties to describe http scale rule. + +## HttpScaleRuleMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## HttpSettings ### Properties * **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. * **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. * **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## ForwardProxy -### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. -* **customHostHeaderName**: string: The name of the header containing the host of the request. -* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. - ## HttpSettingsRoutes ### Properties * **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. @@ -341,106 +465,74 @@ configuration settings of the custom Open ID Connect provider. * **google**: [Google](#google): The configuration settings of the Google provider. * **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## Apple -### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider - -## LoginScopes -### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. - -## AppleRegistration -### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. - -## AzureActiveDirectory -### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. - -## AzureActiveDirectoryLogin -### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". - -## AzureActiveDirectoryRegistration +## IdentityProvidersCustomOpenIdConnectProviders ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## AzureActiveDirectoryValidation +## Ingress ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +* **allowInsecure**: bool: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections +* **customDomains**: [CustomDomain](#customdomain)[]: custom domain bindings for Container Apps' hostnames. +* **external**: bool: Bool indicating if app exposes an external http endpoint +* **fqdn**: string (ReadOnly): Hostname. +* **targetPort**: int: Target Port in containers for traffic from ingress +* **traffic**: [TrafficWeight](#trafficweight)[]: Traffic weights for app's revisions +* **transport**: 'auto' | 'http' | 'http2' | string: Ingress transport protocol -## DefaultAuthorizationPolicy +## JwtClaimChecks ### Properties -* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. -* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## AllowedPrincipals +## LogAnalyticsConfiguration ### Properties -* **groups**: string[]: The list of the allowed groups. -* **identities**: string[]: The list of the allowed identities. +* **customerId**: string: Log analytics customer id +* **sharedKey**: string (WriteOnly): Log analytics customer key -## JwtClaimChecks +## Login ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **allowedExternalRedirectUrls**: 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. +* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. +* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. +* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. +* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. -## AzureStaticWebApps +## LoginRoutes ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## AzureStaticWebAppsRegistration +## LoginScopes ### Properties -* **clientId**: string: The Client ID of the app used for login. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## IdentityProvidersCustomOpenIdConnectProviders +## ManagedEnvironmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration): Configuration of application logs +* **daprAIInstrumentationKey**: string: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry +* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster +* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation +* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' | string (ReadOnly): Provisioning state of the Environment. +* **staticIp**: string (ReadOnly): Static IP of the Environment +* **vnetConfiguration**: [VnetConfiguration](#vnetconfiguration): Configuration properties for apps environment to join a Virtual Network -## CustomOpenIdConnectProvider +## ManagedEnvironmentStorageProperties ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **azureFile**: [AzureFileProperties](#azurefileproperties): Azure File Properties. -## OpenIdConnectLogin +## ManagedServiceIdentity ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. -## OpenIdConnectRegistration +## Nonce ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. ## OpenIdConnectClientCredential ### Properties @@ -455,82 +547,61 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **tokenEndpoint**: string: The endpoint to be used to request a token. * **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## Facebook -### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets - -## AppRegistration -### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. - -## GitHub -### Properties -* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets - -## ClientRegistration +## OpenIdConnectLogin ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## Google +## OpenIdConnectRegistration ### Properties -* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. -## AllowedAudiencesValidation +## QueueScaleRule ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the queue scale rule. +* **queueLength**: int: Queue length. +* **queueName**: string: Queue name. -## Twitter +## RegistryCredentials ### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. +* **passwordSecretRef**: string: The name of the Secret that contains the registry login password +* **server**: string: Container Registry Server +* **username**: string: Container Registry Username -## TwitterRegistration +## RegistryInfo ### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **registryPassword**: string (WriteOnly): registry secret. +* **registryUrl**: string: registry server Url. +* **registryUserName**: string: registry username. -## Login +## Scale ### Properties -* **allowedExternalRedirectUrls**: 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. -* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. -* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. -* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. -* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. +* **maxReplicas**: int: Optional. Maximum number of container replicas. Defaults to 10 if not set. +* **minReplicas**: int: Optional. Minimum number of container replicas. +* **rules**: [ScaleRule](#scalerule)[]: Scaling rules. -## CookieExpiration +## ScaleRule ### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. +* **azureQueue**: [QueueScaleRule](#queuescalerule): Container App container Azure Queue based scaling rule. +* **custom**: [CustomScaleRule](#customscalerule): Container App container Custom scaling rule. +* **http**: [HttpScaleRule](#httpscalerule): Container App container Custom scaling rule. +* **name**: string: Scale Rule Name -## Nonce +## ScaleRuleAuth ### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. +* **secretRef**: string: Name of the Container App secret from which to pull the auth params. +* **triggerParameter**: string: Trigger Parameter that uses the secret -## LoginRoutes +## Secret ### Properties -* **logoutEndpoint**: string: The endpoint at which a logout request should be made. +* **name**: string: Secret Name. +* **value**: string (WriteOnly): Secret Value. -## AuthPlatform +## SecretsCollection ### Properties -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **value**: [ContainerAppSecret](#containerappsecret)[] (ReadOnly): Collection of resources. ## SourceControlProperties ### Properties @@ -539,154 +610,83 @@ The setting in this value can control the behavior of certain features in the Au * **operationState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Current provisioning State of the operation * **repoUrl**: string: The repo url which will be integrated to ContainerApp. -## GithubActionConfiguration -### Properties -* **azureCredentials**: [AzureCredentials](#azurecredentials): Container App credentials. -* **dockerfilePath**: string: Docker file path -* **os**: string: Operation system -* **publishType**: string: Code or Image -* **registryInfo**: [RegistryInfo](#registryinfo): Container App registry information. -* **runtimeStack**: string: Runtime stack -* **runtimeVersion**: string: Runtime Version - -## AzureCredentials -### Properties -* **clientId**: string (WriteOnly): Client Id. -* **clientSecret**: string (WriteOnly): Client Secret. -* **subscriptionId**: string: Subscription Id. -* **tenantId**: string (WriteOnly): Tenant Id. - -## RegistryInfo -### Properties -* **registryPassword**: string (WriteOnly): registry secret. -* **registryUrl**: string: registry server Url. -* **registryUserName**: string: registry username. - -## ManagedEnvironmentProperties -### Properties -* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration): Configuration of application logs -* **daprAIInstrumentationKey**: string: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry -* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster -* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation -* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' | string (ReadOnly): Provisioning state of the Environment. -* **staticIp**: string (ReadOnly): Static IP of the Environment -* **vnetConfiguration**: [VnetConfiguration](#vnetconfiguration): Configuration properties for apps environment to join a Virtual Network - -## AppLogsConfiguration -### Properties -* **destination**: string: Logs destination -* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration): Log analytics configuration - -## LogAnalyticsConfiguration +## SystemData ### Properties -* **customerId**: string: Log analytics customer id -* **sharedKey**: string (WriteOnly): Log analytics customer key +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## VnetConfiguration +## Template ### Properties -* **dockerBridgeCidr**: string: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. -* **infrastructureSubnetId**: string: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. -* **internal**: bool: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if enabling this property -* **platformReservedCidr**: string: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. -* **platformReservedDnsIP**: string: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. -* **runtimeSubnetId**: string: Resource ID of a subnet that Container App containers are injected into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. Must not overlap with any other provided IP ranges. +* **containers**: [Container](#container)[]: List of container definitions for the Container App. +* **revisionSuffix**: string: User friendly suffix that is appended to the revision name +* **scale**: [Scale](#scale): Container App scaling configurations. +* **volumes**: [Volume](#volume)[]: List of volume definitions for the Container App. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **password**: string (WriteOnly): Certificate password. -* **provisioningState**: 'Canceled' | 'DeleteFailed' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Provisioning state of the certificate. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. -* **value**: any (WriteOnly): PFX or PEM blob - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DaprComponentProperties -### Properties -* **componentType**: string: Component type -* **ignoreErrors**: bool: Boolean describing if the component errors are ignores -* **initTimeout**: string: Initialization timeout -* **metadata**: [DaprMetadata](#daprmetadata)[]: Component metadata -* **scopes**: string[]: Names of container apps that can use this Dapr component -* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Dapr component -* **version**: string: Component version - -## DaprMetadata -### Properties -* **name**: string: Metadata property name. -* **secretRef**: string: Name of the Dapr Component secret from which to pull the metadata property value. -* **value**: string: Metadata property value. - -## ManagedEnvironmentStorageProperties +## TrackedResourceTags ### Properties -* **azureFile**: [AzureFileProperties](#azurefileproperties): Azure File Properties. +### Additional Properties +* **Additional Properties Type**: string -## AzureFileProperties +## TrafficWeight ### Properties -* **accessMode**: 'ReadOnly' | 'ReadWrite' | string: Access mode for storage -* **accountKey**: string: Storage account key for azure file. -* **accountName**: string: Storage account name for azure file. -* **shareName**: string: Azure file share name. +* **latestRevision**: bool: Indicates that the traffic weight belongs to a latest stable revision +* **revisionName**: string: Name of a revision +* **weight**: int: Traffic weight assigned to a revision -## CustomHostnameAnalysisResult +## Twitter ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [CustomHostnameAnalysisResultProperties](#customhostnameanalysisresultproperties) (ReadOnly): CustomHostnameAnalysisResult resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## CustomHostnameAnalysisResultProperties +## TwitterRegistration ### Properties -* **alternateCNameRecords**: string[] (ReadOnly): Alternate CName records visible for this hostname. -* **alternateTxtRecords**: string[] (ReadOnly): Alternate TXT records visible for this hostname. -* **aRecords**: string[] (ReadOnly): A records visible for this hostname. -* **cNameRecords**: string[] (ReadOnly): CName records visible for this hostname. -* **conflictingContainerAppResourceId**: string (ReadOnly): Name of the conflicting Container App on the Managed Environment if it's within the same subscription. -* **customDomainVerificationFailureInfo**: [DefaultErrorResponse](#defaulterrorresponse) (ReadOnly): App Service error response. -* **customDomainVerificationTest**: 'Failed' | 'Passed' | 'Skipped' (ReadOnly): DNS verification test result. -* **hasConflictOnManagedEnvironment**: bool (ReadOnly): true if there is a conflict on the Container App's managed environment; otherwise, false. -* **hostName**: string (ReadOnly): Host name that was analyzed -* **isHostnameAlreadyVerified**: bool (ReadOnly): true if hostname is already verified; otherwise, false. -* **txtRecords**: string[] (ReadOnly): TXT records visible for this hostname. +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. -## DefaultErrorResponse +## UserAssignedIdentities ### Properties -* **error**: [DefaultErrorResponseError](#defaulterrorresponseerror) (ReadOnly): Error model. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## DefaultErrorResponseError +## UserAssignedIdentity ### Properties -* **code**: string (ReadOnly): Standardized string to programmatically identify the error. -* **details**: [DefaultErrorResponseErrorDetailsItem](#defaulterrorresponseerrordetailsitem)[] (ReadOnly): Details or the error -* **innererror**: string (ReadOnly): More information to debug error. -* **message**: string (ReadOnly): Detailed error description and debugging information. -* **target**: string (ReadOnly): Detailed error description and debugging information. +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. -## DefaultErrorResponseErrorDetailsItem +## VnetConfiguration ### Properties -* **code**: string (ReadOnly): Standardized string to programmatically identify the error. -* **message**: string (ReadOnly): Detailed error description and debugging information. -* **target**: string (ReadOnly): Detailed error description and debugging information. +* **dockerBridgeCidr**: string: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. +* **infrastructureSubnetId**: string: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. +* **internal**: bool: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if enabling this property +* **platformReservedCidr**: string: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. +* **platformReservedDnsIP**: string: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. +* **runtimeSubnetId**: string: Resource ID of a subnet that Container App containers are injected into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. Must not overlap with any other provided IP ranges. -## SecretsCollection +## Volume ### Properties -* **value**: [ContainerAppSecret](#containerappsecret)[] (ReadOnly): Collection of resources. +* **name**: string: Volume name. +* **storageName**: string: Name of storage resource. No need to provide for EmptyDir. +* **storageType**: 'AzureFile' | 'EmptyDir' | string: Storage type for the volume. If not provided, use EmptyDir. -## ContainerAppSecret +## VolumeMount ### Properties -* **name**: string (ReadOnly): Secret Name. -* **value**: string (ReadOnly): Secret Value. +* **mountPath**: string: Path within the container at which the volume should be mounted.Must not contain ':'. +* **volumeName**: string: This must match the Name of a Volume. diff --git a/generated/app/microsoft.app/2022-03-01/types.md b/generated/app/microsoft.app/2022-03-01/types.md index 134f26ccaf..c3afb9451a 100644 --- a/generated/app/microsoft.app/2022-03-01/types.md +++ b/generated/app/microsoft.app/2022-03-01/types.md @@ -92,93 +92,139 @@ * **ApiVersion**: 2022-03-01 * **Output**: [DaprSecretsCollection](#daprsecretscollection) -## ManagedServiceIdentity +## AllowedAudiencesValidation ### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## UserAssignedIdentities +## AllowedPrincipals ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **groups**: string[]: The list of the allowed groups. +* **identities**: string[]: The list of the allowed identities. -## UserAssignedIdentity +## Apple ### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider -## ContainerAppProperties +## AppleRegistration ### Properties -* **configuration**: [Configuration](#configuration): Non versioned Container App configuration properties that define the mutable settings of a Container app -* **customDomainVerificationId**: string (ReadOnly): Id used to verify domain name ownership -* **latestRevisionFqdn**: string (ReadOnly): Fully Qualified Domain Name of the latest revision of the Container App. -* **latestRevisionName**: string (ReadOnly): Name of the latest revision of the Container App. -* **managedEnvironmentId**: string: Resource ID of the Container App's environment. -* **outboundIPAddresses**: string[] (ReadOnly): Outbound IP Addresses for container app. -* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Container App. -* **template**: [Template](#template): Container App versioned application definition. -Defines the desired state of an immutable revision. -Any changes to this section Will result in a new revision being created +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. -## Configuration +## AppLogsConfiguration ### Properties -* **activeRevisionsMode**: 'multiple' | 'single' | string: ActiveRevisionsMode controls how active revisions are handled for the Container app: -Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. -* **dapr**: [Dapr](#dapr): Container App Dapr configuration. -* **ingress**: [Ingress](#ingress): Container App Ingress configuration. -* **registries**: [RegistryCredentials](#registrycredentials)[]: Collection of private container registry credentials for containers used by the Container app -* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Container app +* **destination**: string: Logs destination +* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration): Log analytics configuration -## Dapr +## AppRegistration ### Properties -* **appId**: string: Dapr application identifier -* **appPort**: int: Tells Dapr which port your application is listening on -* **appProtocol**: 'grpc' | 'http' | string: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http -* **enabled**: bool: Boolean indicating if the Dapr side car is enabled +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. -## Ingress +## AuthConfigProperties ### Properties -* **allowInsecure**: bool: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections -* **customDomains**: [CustomDomain](#customdomain)[]: custom domain bindings for Container Apps' hostnames. -* **external**: bool: Bool indicating if app exposes an external http endpoint -* **fqdn**: string (ReadOnly): Hostname. -* **targetPort**: int: Target Port in containers for traffic from ingress -* **traffic**: [TrafficWeight](#trafficweight)[]: Traffic weights for app's revisions -* **transport**: 'auto' | 'http' | 'http2' | string: Ingress transport protocol +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of ContainerApp Service Authentication/Authorization. -## CustomDomain +## AuthPlatform ### Properties -* **bindingType**: 'Disabled' | 'SniEnabled' | string: Custom Domain binding type. -* **certificateId**: string (Required): Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. -* **name**: string (Required): Hostname. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## TrafficWeight +## AzureActiveDirectory ### Properties -* **label**: string: Associates a traffic label with a revision -* **latestRevision**: bool: Indicates that the traffic weight belongs to a latest stable revision -* **revisionName**: string: Name of a revision -* **weight**: int: Traffic weight assigned to a revision +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. -## RegistryCredentials +## AzureActiveDirectoryLogin ### Properties -* **identity**: string: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' -* **passwordSecretRef**: string: The name of the Secret that contains the registry login password -* **server**: string: Container Registry Server -* **username**: string: Container Registry Username +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". -## Secret +## AzureActiveDirectoryRegistration ### Properties -* **name**: string: Secret Name. -* **value**: string (WriteOnly): Secret Value. +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 -## Template +## AzureActiveDirectoryValidation ### Properties -* **containers**: [Container](#container)[]: List of container definitions for the Container App. -* **revisionSuffix**: string: User friendly suffix that is appended to the revision name -* **scale**: [Scale](#scale): Container App scaling configurations. -* **volumes**: [Volume](#volume)[]: List of volume definitions for the Container App. +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. + +## AzureCredentials +### Properties +* **clientId**: string (WriteOnly): Client Id. +* **clientSecret**: string (WriteOnly): Client Secret. +* **subscriptionId**: string: Subscription Id. +* **tenantId**: string (WriteOnly): Tenant Id. + +## AzureFileProperties +### Properties +* **accessMode**: 'ReadOnly' | 'ReadWrite' | string: Access mode for storage +* **accountKey**: string: Storage account key for azure file. +* **accountName**: string: Storage account name for azure file. +* **shareName**: string: Azure file share name. + +## AzureStaticWebApps +### Properties +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider + +## AzureStaticWebAppsRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. + +## CertificateProperties +### Properties +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **password**: string (WriteOnly): Certificate password. +* **provisioningState**: 'Canceled' | 'DeleteFailed' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Provisioning state of the certificate. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. +* **value**: any (WriteOnly): PFX or PEM blob + +## ClientRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## Configuration +### Properties +* **activeRevisionsMode**: 'multiple' | 'single' | string: ActiveRevisionsMode controls how active revisions are handled for the Container app: +Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. +* **dapr**: [Dapr](#dapr): Container App Dapr configuration. +* **ingress**: [Ingress](#ingress): Container App Ingress configuration. +* **registries**: [RegistryCredentials](#registrycredentials)[]: Collection of private container registry credentials for containers used by the Container app +* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Container app ## Container ### Properties @@ -191,12 +237,6 @@ Any changes to this section Will result in a new revision being created * **resources**: [ContainerResources](#containerresources): Container App container resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: Container volume mounts. -## EnvironmentVar -### Properties -* **name**: string: Environment variable name. -* **secretRef**: string: Name of the Container App secret from which to pull the environment variable value. -* **value**: string: Non-secret environment variable value. - ## ContainerAppProbe ### Properties * **failureThreshold**: int: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. @@ -227,40 +267,68 @@ Any changes to this section Will result in a new revision being created * **host**: string: Optional: Host name to connect to, defaults to the pod IP. * **port**: int (Required): Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +## ContainerAppProperties +### Properties +* **configuration**: [Configuration](#configuration): Non versioned Container App configuration properties that define the mutable settings of a Container app +* **customDomainVerificationId**: string (ReadOnly): Id used to verify domain name ownership +* **latestRevisionFqdn**: string (ReadOnly): Fully Qualified Domain Name of the latest revision of the Container App. +* **latestRevisionName**: string (ReadOnly): Name of the latest revision of the Container App. +* **managedEnvironmentId**: string: Resource ID of the Container App's environment. +* **outboundIPAddresses**: string[] (ReadOnly): Outbound IP Addresses for container app. +* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Container App. +* **template**: [Template](#template): Container App versioned application definition. +Defines the desired state of an immutable revision. +Any changes to this section Will result in a new revision being created + +## ContainerAppSecret +### Properties +* **name**: string (ReadOnly): Secret Name. +* **value**: string (ReadOnly): Secret Value. + ## ContainerResources ### Properties * **cpu**: int: Required CPU in cores, e.g. 0.5 * **ephemeralStorage**: string (ReadOnly): Ephemeral Storage, e.g. "1Gi" * **memory**: string: Required memory, e.g. "250Mb" -## VolumeMount +## CookieExpiration ### Properties -* **mountPath**: string: Path within the container at which the volume should be mounted.Must not contain ':'. -* **volumeName**: string: This must match the Name of a Volume. +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. -## Scale +## CustomDomain ### Properties -* **maxReplicas**: int: Optional. Maximum number of container replicas. Defaults to 10 if not set. -* **minReplicas**: int: Optional. Minimum number of container replicas. -* **rules**: [ScaleRule](#scalerule)[]: Scaling rules. +* **bindingType**: 'Disabled' | 'SniEnabled' | string: Custom Domain binding type. +* **certificateId**: string (Required): Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. +* **name**: string (Required): Hostname. -## ScaleRule +## CustomHostnameAnalysisResult ### Properties -* **azureQueue**: [QueueScaleRule](#queuescalerule): Container App container Azure Queue based scaling rule. -* **custom**: [CustomScaleRule](#customscalerule): Container App container Custom scaling rule. -* **http**: [HttpScaleRule](#httpscalerule): Container App container Custom scaling rule. -* **name**: string: Scale Rule Name +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [CustomHostnameAnalysisResultProperties](#customhostnameanalysisresultproperties) (ReadOnly): CustomHostnameAnalysisResult resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## QueueScaleRule +## CustomHostnameAnalysisResultProperties ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the queue scale rule. -* **queueLength**: int: Queue length. -* **queueName**: string: Queue name. +* **alternateCNameRecords**: string[] (ReadOnly): Alternate CName records visible for this hostname. +* **alternateTxtRecords**: string[] (ReadOnly): Alternate TXT records visible for this hostname. +* **aRecords**: string[] (ReadOnly): A records visible for this hostname. +* **cNameRecords**: string[] (ReadOnly): CName records visible for this hostname. +* **conflictingContainerAppResourceId**: string (ReadOnly): Name of the conflicting Container App on the Managed Environment if it's within the same subscription. +* **customDomainVerificationFailureInfo**: [DefaultErrorResponse](#defaulterrorresponse) (ReadOnly): App Service error response. +* **customDomainVerificationTest**: 'Failed' | 'Passed' | 'Skipped' (ReadOnly): DNS verification test result. +* **hasConflictOnManagedEnvironment**: bool (ReadOnly): true if there is a conflict on the Container App's managed environment; otherwise, false. +* **hostName**: string (ReadOnly): Host name that was analyzed +* **isHostnameAlreadyVerified**: bool (ReadOnly): true if hostname is already verified; otherwise, false. +* **txtRecords**: string[] (ReadOnly): TXT records visible for this hostname. -## ScaleRuleAuth +## CustomOpenIdConnectProvider ### Properties -* **secretRef**: string: Name of the Container App secret from which to pull the auth params. -* **triggerParameter**: string: Trigger Parameter that uses the secret +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. ## CustomScaleRule ### Properties @@ -274,43 +342,91 @@ eg: azure-servicebus, redis etc. ### Additional Properties * **Additional Properties Type**: string -## HttpScaleRule +## Dapr ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. -* **metadata**: [HttpScaleRuleMetadata](#httpscalerulemetadata): Metadata properties to describe http scale rule. +* **appId**: string: Dapr application identifier +* **appPort**: int: Tells Dapr which port your application is listening on +* **appProtocol**: 'grpc' | 'http' | string: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http +* **enabled**: bool: Boolean indicating if the Dapr side car is enabled -## HttpScaleRuleMetadata +## DaprComponentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **componentType**: string: Component type +* **ignoreErrors**: bool: Boolean describing if the component errors are ignores +* **initTimeout**: string: Initialization timeout +* **metadata**: [DaprMetadata](#daprmetadata)[]: Component metadata +* **scopes**: string[]: Names of container apps that can use this Dapr component +* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Dapr component +* **version**: string: Component version -## Volume +## DaprMetadata ### Properties -* **name**: string: Volume name. -* **storageName**: string: Name of storage resource. No need to provide for EmptyDir. -* **storageType**: 'AzureFile' | 'EmptyDir' | string: Storage type for the volume. If not provided, use EmptyDir. +* **name**: string: Metadata property name. +* **secretRef**: string: Name of the Dapr Component secret from which to pull the metadata property value. +* **value**: string: Metadata property value. -## SystemData +## DaprSecretsCollection ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **value**: [Secret](#secret)[] (ReadOnly): Collection of secrets used by a Dapr component -## TrackedResourceTags +## DefaultAuthorizationPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. +* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. -## AuthConfigProperties +## DefaultErrorResponse ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of ContainerApp Service Authentication/Authorization. +* **error**: [DefaultErrorResponseError](#defaulterrorresponseerror) (ReadOnly): Error model. + +## DefaultErrorResponseError +### Properties +* **code**: string (ReadOnly): Standardized string to programmatically identify the error. +* **details**: [DefaultErrorResponseErrorDetailsItem](#defaulterrorresponseerrordetailsitem)[] (ReadOnly): Details or the error +* **innererror**: string (ReadOnly): More information to debug error. +* **message**: string (ReadOnly): Detailed error description and debugging information. +* **target**: string (ReadOnly): Detailed error description and debugging information. + +## DefaultErrorResponseErrorDetailsItem +### Properties +* **code**: string (ReadOnly): Standardized string to programmatically identify the error. +* **message**: string (ReadOnly): Detailed error description and debugging information. +* **target**: string (ReadOnly): Detailed error description and debugging information. + +## EnvironmentVar +### Properties +* **name**: string: Environment variable name. +* **secretRef**: string: Name of the Container App secret from which to pull the environment variable value. +* **value**: string: Non-secret environment variable value. + +## Facebook +### Properties +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets + +## ForwardProxy +### Properties +* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. +* **customHostHeaderName**: string: The name of the header containing the host of the request. +* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. + +## GitHub +### Properties +* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets + +## GithubActionConfiguration +### Properties +* **azureCredentials**: [AzureCredentials](#azurecredentials): Container App credentials. +* **contextPath**: string: Context path +* **image**: string: Image name +* **os**: string: Operation system +* **publishType**: string: Code or Image +* **registryInfo**: [RegistryInfo](#registryinfo): Container App registry information. +* **runtimeStack**: string: Runtime stack +* **runtimeVersion**: string: Runtime version ## GlobalValidation ### Properties @@ -320,18 +436,29 @@ This setting is only needed if multiple providers are configured and the unauthe action is set to "RedirectToLoginPage". * **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. +## Google +### Properties +* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. + +## HttpScaleRule +### Properties +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. +* **metadata**: [HttpScaleRuleMetadata](#httpscalerulemetadata): Metadata properties to describe http scale rule. + +## HttpScaleRuleMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## HttpSettings ### Properties * **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. * **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. * **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## ForwardProxy -### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. -* **customHostHeaderName**: string: The name of the header containing the host of the request. -* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. - ## HttpSettingsRoutes ### Properties * **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. @@ -348,106 +475,76 @@ configuration settings of the custom Open ID Connect provider. * **google**: [Google](#google): The configuration settings of the Google provider. * **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## Apple -### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider - -## LoginScopes -### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. - -## AppleRegistration -### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. - -## AzureActiveDirectory -### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. - -## AzureActiveDirectoryLogin -### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". - -## AzureActiveDirectoryRegistration +## IdentityProvidersCustomOpenIdConnectProviders ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## AzureActiveDirectoryValidation +## Ingress ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +* **allowInsecure**: bool: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections +* **customDomains**: [CustomDomain](#customdomain)[]: custom domain bindings for Container Apps' hostnames. +* **external**: bool: Bool indicating if app exposes an external http endpoint +* **fqdn**: string (ReadOnly): Hostname. +* **targetPort**: int: Target Port in containers for traffic from ingress +* **traffic**: [TrafficWeight](#trafficweight)[]: Traffic weights for app's revisions +* **transport**: 'auto' | 'http' | 'http2' | string: Ingress transport protocol -## DefaultAuthorizationPolicy +## JwtClaimChecks ### Properties -* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. -* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## AllowedPrincipals +## LogAnalyticsConfiguration ### Properties -* **groups**: string[]: The list of the allowed groups. -* **identities**: string[]: The list of the allowed identities. +* **customerId**: string: Log analytics customer id +* **sharedKey**: string (WriteOnly): Log analytics customer key -## JwtClaimChecks +## Login ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **allowedExternalRedirectUrls**: 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. +* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. +* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. +* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. +* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. -## AzureStaticWebApps +## LoginRoutes ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## AzureStaticWebAppsRegistration +## LoginScopes ### Properties -* **clientId**: string: The Client ID of the app used for login. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## IdentityProvidersCustomOpenIdConnectProviders +## ManagedEnvironmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration): Configuration of application logs +* **daprAIConnectionString**: string: Application Insights connection string used by Dapr to export Service to Service communication telemetry +* **daprAIInstrumentationKey**: string: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry +* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster +* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation +* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' | string (ReadOnly): Provisioning state of the Environment. +* **staticIp**: string (ReadOnly): Static IP of the Environment +* **vnetConfiguration**: [VnetConfiguration](#vnetconfiguration): Configuration properties for apps environment to join a Virtual Network +* **zoneRedundant**: bool: Whether or not this Managed Environment is zone-redundant. -## CustomOpenIdConnectProvider +## ManagedEnvironmentStorageProperties ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **azureFile**: [AzureFileProperties](#azurefileproperties): Azure File Properties. -## OpenIdConnectLogin +## ManagedServiceIdentity ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. -## OpenIdConnectRegistration +## Nonce ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. ## OpenIdConnectClientCredential ### Properties @@ -462,82 +559,62 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **tokenEndpoint**: string: The endpoint to be used to request a token. * **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## Facebook -### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets - -## AppRegistration -### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. - -## GitHub -### Properties -* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets - -## ClientRegistration +## OpenIdConnectLogin ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## Google +## OpenIdConnectRegistration ### Properties -* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. -## AllowedAudiencesValidation +## QueueScaleRule ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the queue scale rule. +* **queueLength**: int: Queue length. +* **queueName**: string: Queue name. -## Twitter +## RegistryCredentials ### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. +* **identity**: string: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' +* **passwordSecretRef**: string: The name of the Secret that contains the registry login password +* **server**: string: Container Registry Server +* **username**: string: Container Registry Username -## TwitterRegistration +## RegistryInfo ### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **registryPassword**: string (WriteOnly): registry secret. +* **registryUrl**: string: registry server Url. +* **registryUserName**: string: registry username. -## Login +## Scale ### Properties -* **allowedExternalRedirectUrls**: 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. -* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. -* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. -* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. -* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. +* **maxReplicas**: int: Optional. Maximum number of container replicas. Defaults to 10 if not set. +* **minReplicas**: int: Optional. Minimum number of container replicas. +* **rules**: [ScaleRule](#scalerule)[]: Scaling rules. -## CookieExpiration +## ScaleRule ### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. +* **azureQueue**: [QueueScaleRule](#queuescalerule): Container App container Azure Queue based scaling rule. +* **custom**: [CustomScaleRule](#customscalerule): Container App container Custom scaling rule. +* **http**: [HttpScaleRule](#httpscalerule): Container App container Custom scaling rule. +* **name**: string: Scale Rule Name -## Nonce +## ScaleRuleAuth ### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. +* **secretRef**: string: Name of the Container App secret from which to pull the auth params. +* **triggerParameter**: string: Trigger Parameter that uses the secret -## LoginRoutes +## Secret ### Properties -* **logoutEndpoint**: string: The endpoint at which a logout request should be made. +* **name**: string: Secret Name. +* **value**: string (WriteOnly): Secret Value. -## AuthPlatform +## SecretsCollection ### Properties -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **value**: [ContainerAppSecret](#containerappsecret)[] (ReadOnly): Collection of resources. ## SourceControlProperties ### Properties @@ -546,161 +623,84 @@ The setting in this value can control the behavior of certain features in the Au * **operationState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Current provisioning State of the operation * **repoUrl**: string: The repo url which will be integrated to ContainerApp. -## GithubActionConfiguration -### Properties -* **azureCredentials**: [AzureCredentials](#azurecredentials): Container App credentials. -* **contextPath**: string: Context path -* **image**: string: Image name -* **os**: string: Operation system -* **publishType**: string: Code or Image -* **registryInfo**: [RegistryInfo](#registryinfo): Container App registry information. -* **runtimeStack**: string: Runtime stack -* **runtimeVersion**: string: Runtime version - -## AzureCredentials -### Properties -* **clientId**: string (WriteOnly): Client Id. -* **clientSecret**: string (WriteOnly): Client Secret. -* **subscriptionId**: string: Subscription Id. -* **tenantId**: string (WriteOnly): Tenant Id. - -## RegistryInfo -### Properties -* **registryPassword**: string (WriteOnly): registry secret. -* **registryUrl**: string: registry server Url. -* **registryUserName**: string: registry username. - -## ManagedEnvironmentProperties -### Properties -* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration): Configuration of application logs -* **daprAIConnectionString**: string: Application Insights connection string used by Dapr to export Service to Service communication telemetry -* **daprAIInstrumentationKey**: string: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry -* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster -* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation -* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' | string (ReadOnly): Provisioning state of the Environment. -* **staticIp**: string (ReadOnly): Static IP of the Environment -* **vnetConfiguration**: [VnetConfiguration](#vnetconfiguration): Configuration properties for apps environment to join a Virtual Network -* **zoneRedundant**: bool: Whether or not this Managed Environment is zone-redundant. - -## AppLogsConfiguration -### Properties -* **destination**: string: Logs destination -* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration): Log analytics configuration - -## LogAnalyticsConfiguration +## SystemData ### Properties -* **customerId**: string: Log analytics customer id -* **sharedKey**: string (WriteOnly): Log analytics customer key +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## VnetConfiguration +## Template ### Properties -* **dockerBridgeCidr**: string: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. -* **infrastructureSubnetId**: string: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. -* **internal**: bool: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if enabling this property -* **platformReservedCidr**: string: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. -* **platformReservedDnsIP**: string: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. -* **runtimeSubnetId**: string: Resource ID of a subnet that Container App containers are injected into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. Must not overlap with any other provided IP ranges. +* **containers**: [Container](#container)[]: List of container definitions for the Container App. +* **revisionSuffix**: string: User friendly suffix that is appended to the revision name +* **scale**: [Scale](#scale): Container App scaling configurations. +* **volumes**: [Volume](#volume)[]: List of volume definitions for the Container App. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **password**: string (WriteOnly): Certificate password. -* **provisioningState**: 'Canceled' | 'DeleteFailed' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Provisioning state of the certificate. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. -* **value**: any (WriteOnly): PFX or PEM blob - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DaprComponentProperties -### Properties -* **componentType**: string: Component type -* **ignoreErrors**: bool: Boolean describing if the component errors are ignores -* **initTimeout**: string: Initialization timeout -* **metadata**: [DaprMetadata](#daprmetadata)[]: Component metadata -* **scopes**: string[]: Names of container apps that can use this Dapr component -* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Dapr component -* **version**: string: Component version - -## DaprMetadata -### Properties -* **name**: string: Metadata property name. -* **secretRef**: string: Name of the Dapr Component secret from which to pull the metadata property value. -* **value**: string: Metadata property value. - -## ManagedEnvironmentStorageProperties -### Properties -* **azureFile**: [AzureFileProperties](#azurefileproperties): Azure File Properties. - -## AzureFileProperties +## TrackedResourceTags ### Properties -* **accessMode**: 'ReadOnly' | 'ReadWrite' | string: Access mode for storage -* **accountKey**: string: Storage account key for azure file. -* **accountName**: string: Storage account name for azure file. -* **shareName**: string: Azure file share name. +### Additional Properties +* **Additional Properties Type**: string -## CustomHostnameAnalysisResult +## TrafficWeight ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [CustomHostnameAnalysisResultProperties](#customhostnameanalysisresultproperties) (ReadOnly): CustomHostnameAnalysisResult resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **label**: string: Associates a traffic label with a revision +* **latestRevision**: bool: Indicates that the traffic weight belongs to a latest stable revision +* **revisionName**: string: Name of a revision +* **weight**: int: Traffic weight assigned to a revision -## CustomHostnameAnalysisResultProperties +## Twitter ### Properties -* **alternateCNameRecords**: string[] (ReadOnly): Alternate CName records visible for this hostname. -* **alternateTxtRecords**: string[] (ReadOnly): Alternate TXT records visible for this hostname. -* **aRecords**: string[] (ReadOnly): A records visible for this hostname. -* **cNameRecords**: string[] (ReadOnly): CName records visible for this hostname. -* **conflictingContainerAppResourceId**: string (ReadOnly): Name of the conflicting Container App on the Managed Environment if it's within the same subscription. -* **customDomainVerificationFailureInfo**: [DefaultErrorResponse](#defaulterrorresponse) (ReadOnly): App Service error response. -* **customDomainVerificationTest**: 'Failed' | 'Passed' | 'Skipped' (ReadOnly): DNS verification test result. -* **hasConflictOnManagedEnvironment**: bool (ReadOnly): true if there is a conflict on the Container App's managed environment; otherwise, false. -* **hostName**: string (ReadOnly): Host name that was analyzed -* **isHostnameAlreadyVerified**: bool (ReadOnly): true if hostname is already verified; otherwise, false. -* **txtRecords**: string[] (ReadOnly): TXT records visible for this hostname. +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## DefaultErrorResponse +## TwitterRegistration ### Properties -* **error**: [DefaultErrorResponseError](#defaulterrorresponseerror) (ReadOnly): Error model. +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. -## DefaultErrorResponseError +## UserAssignedIdentities ### Properties -* **code**: string (ReadOnly): Standardized string to programmatically identify the error. -* **details**: [DefaultErrorResponseErrorDetailsItem](#defaulterrorresponseerrordetailsitem)[] (ReadOnly): Details or the error -* **innererror**: string (ReadOnly): More information to debug error. -* **message**: string (ReadOnly): Detailed error description and debugging information. -* **target**: string (ReadOnly): Detailed error description and debugging information. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## DefaultErrorResponseErrorDetailsItem +## UserAssignedIdentity ### Properties -* **code**: string (ReadOnly): Standardized string to programmatically identify the error. -* **message**: string (ReadOnly): Detailed error description and debugging information. -* **target**: string (ReadOnly): Detailed error description and debugging information. +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. -## SecretsCollection +## VnetConfiguration ### Properties -* **value**: [ContainerAppSecret](#containerappsecret)[] (ReadOnly): Collection of resources. +* **dockerBridgeCidr**: string: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. +* **infrastructureSubnetId**: string: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. +* **internal**: bool: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if enabling this property +* **platformReservedCidr**: string: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. +* **platformReservedDnsIP**: string: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. +* **runtimeSubnetId**: string: Resource ID of a subnet that Container App containers are injected into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. Must not overlap with any other provided IP ranges. -## ContainerAppSecret +## Volume ### Properties -* **name**: string (ReadOnly): Secret Name. -* **value**: string (ReadOnly): Secret Value. +* **name**: string: Volume name. +* **storageName**: string: Name of storage resource. No need to provide for EmptyDir. +* **storageType**: 'AzureFile' | 'EmptyDir' | string: Storage type for the volume. If not provided, use EmptyDir. -## DaprSecretsCollection +## VolumeMount ### Properties -* **value**: [Secret](#secret)[] (ReadOnly): Collection of secrets used by a Dapr component +* **mountPath**: string: Path within the container at which the volume should be mounted.Must not contain ':'. +* **volumeName**: string: This must match the Name of a Volume. diff --git a/generated/appconfiguration/log.out b/generated/appconfiguration/log.out index 8aa4badc54..442cb70ff1 100644 --- a/generated/appconfiguration/log.out +++ b/generated/appconfiguration/log.out @@ -9,7 +9,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.appconfiguration-2021-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18,7 +18,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json:1902:5 @@ -34,14 +34,14 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json:1681:5 warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json:1714:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.appconfiguration-2020-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -50,7 +50,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json:1647:5 @@ -68,14 +68,14 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json:1363:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json:1376:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.appconfiguration-2019-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -84,14 +84,14 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json:1348:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json:1361:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.appconfiguration-2019-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -100,7 +100,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.json:878:5 @@ -116,7 +116,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2019-10-01/appconfiguration.json:965:5 @@ -124,4 +124,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2019-10-01/appconfiguration.json:978:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 16.63s. 14 files generated. +info | Autorest completed in 15.86s. 14 files generated. diff --git a/generated/appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.md b/generated/appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.md index 5057b210a0..0d8089577f 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.md @@ -22,22 +22,6 @@ * **Input**: [ListKeyValueParameters](#listkeyvalueparameters) * **Output**: [KeyValue](#keyvalue) -## ConfigurationStoreProperties -### Properties -* **creationDate**: string (ReadOnly): The creation date of configuration store. -* **endpoint**: string (ReadOnly): The DNS endpoint where the configuration store API will be available. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiKeyListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. - ## ApiKey ### Properties * **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. @@ -47,10 +31,16 @@ * **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. * **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## ListKeyValueParameters +## ApiKeyListResult ### Properties -* **key**: string (Required, WriteOnly): The key to retrieve. -* **label**: string (WriteOnly): The label of the key. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. + +## ConfigurationStoreProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of configuration store. +* **endpoint**: string (ReadOnly): The DNS endpoint where the configuration store API will be available. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. ## KeyValue ### Properties @@ -72,3 +62,13 @@ A locked key-value may not be modified until it is unlocked. ### Additional Properties * **Additional Properties Type**: string +## ListKeyValueParameters +### Properties +* **key**: string (Required, WriteOnly): The key to retrieve. +* **label**: string (WriteOnly): The label of the key. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/appconfiguration/microsoft.appconfiguration/2019-10-01/types.md b/generated/appconfiguration/microsoft.appconfiguration/2019-10-01/types.md index ea854e073c..166c115b84 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2019-10-01/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2019-10-01/types.md @@ -24,43 +24,6 @@ * **Input**: [ListKeyValueParameters](#listkeyvalueparameters) * **Output**: [KeyValue](#keyvalue) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ResourceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) - -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## ConfigurationStoreProperties -### Properties -* **creationDate**: string (ReadOnly): The creation date of configuration store. -* **endpoint**: string (ReadOnly): The DNS endpoint where the configuration store API will be available. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. - -## Sku -### Properties -* **name**: string (Required): The SKU name of the configuration store. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiKeyListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. - ## ApiKey ### Properties * **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. @@ -70,10 +33,16 @@ * **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. * **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## ListKeyValueParameters +## ApiKeyListResult ### Properties -* **key**: string (Required, WriteOnly): The key to retrieve. -* **label**: string (WriteOnly): The label of the key. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. + +## ConfigurationStoreProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of configuration store. +* **endpoint**: string (ReadOnly): The DNS endpoint where the configuration store API will be available. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. ## KeyValue ### Properties @@ -95,3 +64,34 @@ A locked key-value may not be modified until it is unlocked. ### Additional Properties * **Additional Properties Type**: string +## ListKeyValueParameters +### Properties +* **key**: string (Required, WriteOnly): The key to retrieve. +* **label**: string (WriteOnly): The label of the key. + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ResourceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: string (Required): The SKU name of the configuration store. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. + diff --git a/generated/appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.md b/generated/appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.md index b424549972..ca33e0dadf 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.md @@ -33,22 +33,19 @@ * **Input**: [ListKeyValueParameters](#listkeyvalueparameters) * **Output**: [KeyValue](#keyvalue) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ResourceIdentityUserAssignedIdentities +## ApiKey ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. +* **id**: string (ReadOnly): The key ID. +* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. +* **name**: string (ReadOnly): A name for the key describing its usage. +* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. +* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## UserIdentity +## ApiKeyListResult ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. ## ConfigurationStoreProperties ### Properties @@ -63,17 +60,39 @@ ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. +## KeyValue +### Properties +* **contentType**: string (ReadOnly): The content type of the key-value's value. +Providing a proper content-type can enable transformations of values when they are retrieved by applications. +* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. +* **key**: string (ReadOnly): The primary identifier of a key-value. +The key is used in unison with the label to uniquely identify a key-value. +* **label**: string (ReadOnly): A value used to group key-values. +The label is used in unison with the key to uniquely identify a key-value. +* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. +* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. +A locked key-value may not be modified until it is unlocked. +* **tags**: [KeyValueTags](#keyvaluetags) (ReadOnly): A dictionary of tags that can help identify what a key-value may be applicable for. +* **value**: string (ReadOnly): The value of the key-value. + +## KeyValueTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## KeyVaultProperties ### Properties * **identityClientId**: string: The client id of the identity which will be used to access key vault. * **keyIdentifier**: string: The URI of the key vault key used to encrypt data. -## PrivateEndpointConnectionReference +## ListKeyValueParameters ### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. +* **key**: string (Required, WriteOnly): The key to retrieve. +* **label**: string (WriteOnly): The label of the key. + +## PrivateEndpoint +### Properties +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -81,9 +100,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. -## PrivateEndpoint +## PrivateEndpointConnectionReference ### Properties -* **id**: string: The resource Id for private endpoint +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. ## PrivateLinkServiceConnectionState ### Properties @@ -91,51 +113,29 @@ * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## Sku +## ResourceIdentity ### Properties -* **name**: string (Required): The SKU name of the configuration store. +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ResourceTags +## ResourceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApiKeyListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. - -## ApiKey -### Properties -* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. -* **id**: string (ReadOnly): The key ID. -* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. -* **name**: string (ReadOnly): A name for the key describing its usage. -* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. -* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ListKeyValueParameters +## ResourceTags ### Properties -* **key**: string (Required, WriteOnly): The key to retrieve. -* **label**: string (WriteOnly): The label of the key. +### Additional Properties +* **Additional Properties Type**: string -## KeyValue +## Sku ### Properties -* **contentType**: string (ReadOnly): The content type of the key-value's value. -Providing a proper content-type can enable transformations of values when they are retrieved by applications. -* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. -* **key**: string (ReadOnly): The primary identifier of a key-value. -The key is used in unison with the label to uniquely identify a key-value. -* **label**: string (ReadOnly): A value used to group key-values. -The label is used in unison with the key to uniquely identify a key-value. -* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. -* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. -A locked key-value may not be modified until it is unlocked. -* **tags**: [KeyValueTags](#keyvaluetags) (ReadOnly): A dictionary of tags that can help identify what a key-value may be applicable for. -* **value**: string (ReadOnly): The value of the key-value. +* **name**: string (Required): The SKU name of the configuration store. -## KeyValueTags +## UserIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/appconfiguration/microsoft.appconfiguration/2020-06-01/types.md b/generated/appconfiguration/microsoft.appconfiguration/2020-06-01/types.md index 6aa6061b0a..d804026668 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2020-06-01/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2020-06-01/types.md @@ -33,22 +33,19 @@ * **Input**: [ListKeyValueParameters](#listkeyvalueparameters) * **Output**: [KeyValue](#keyvalue) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ResourceIdentityUserAssignedIdentities +## ApiKey ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. +* **id**: string (ReadOnly): The key ID. +* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. +* **name**: string (ReadOnly): A name for the key describing its usage. +* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. +* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## UserIdentity +## ApiKeyListResult ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. ## ConfigurationStoreProperties ### Properties @@ -63,17 +60,39 @@ ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. +## KeyValue +### Properties +* **contentType**: string (ReadOnly): The content type of the key-value's value. +Providing a proper content-type can enable transformations of values when they are retrieved by applications. +* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. +* **key**: string (ReadOnly): The primary identifier of a key-value. +The key is used in unison with the label to uniquely identify a key-value. +* **label**: string (ReadOnly): A value used to group key-values. +The label is used in unison with the key to uniquely identify a key-value. +* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. +* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. +A locked key-value may not be modified until it is unlocked. +* **tags**: [KeyValueTags](#keyvaluetags) (ReadOnly): A dictionary of tags that can help identify what a key-value may be applicable for. +* **value**: string (ReadOnly): The value of the key-value. + +## KeyValueTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## KeyVaultProperties ### Properties * **identityClientId**: string: The client id of the identity which will be used to access key vault. * **keyIdentifier**: string: The URI of the key vault key used to encrypt data. -## PrivateEndpointConnectionReference +## ListKeyValueParameters ### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. +* **key**: string (Required, WriteOnly): The key to retrieve. +* **label**: string (WriteOnly): The label of the key. + +## PrivateEndpoint +### Properties +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -81,9 +100,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. -## PrivateEndpoint +## PrivateEndpointConnectionReference ### Properties -* **id**: string: The resource Id for private endpoint +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. ## PrivateLinkServiceConnectionState ### Properties @@ -91,51 +113,29 @@ * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## Sku +## ResourceIdentity ### Properties -* **name**: string (Required): The SKU name of the configuration store. +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ResourceTags +## ResourceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApiKeyListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. - -## ApiKey -### Properties -* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. -* **id**: string (ReadOnly): The key ID. -* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. -* **name**: string (ReadOnly): A name for the key describing its usage. -* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. -* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ListKeyValueParameters +## ResourceTags ### Properties -* **key**: string (Required, WriteOnly): The key to retrieve. -* **label**: string (WriteOnly): The label of the key. +### Additional Properties +* **Additional Properties Type**: string -## KeyValue +## Sku ### Properties -* **contentType**: string (ReadOnly): The content type of the key-value's value. -Providing a proper content-type can enable transformations of values when they are retrieved by applications. -* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. -* **key**: string (ReadOnly): The primary identifier of a key-value. -The key is used in unison with the label to uniquely identify a key-value. -* **label**: string (ReadOnly): A value used to group key-values. -The label is used in unison with the key to uniquely identify a key-value. -* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. -* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. -A locked key-value may not be modified until it is unlocked. -* **tags**: [KeyValueTags](#keyvaluetags) (ReadOnly): A dictionary of tags that can help identify what a key-value may be applicable for. -* **value**: string (ReadOnly): The value of the key-value. +* **name**: string (Required): The SKU name of the configuration store. -## KeyValueTags +## UserIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.md b/generated/appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.md index c220d37955..c6f61b1304 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.md @@ -36,22 +36,19 @@ * **ApiVersion**: 2020-07-01-preview * **Output**: [ApiKeyListResult](#apikeylistresult) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ResourceIdentityUserAssignedIdentities +## ApiKey ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. +* **id**: string (ReadOnly): The key ID. +* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. +* **name**: string (ReadOnly): A name for the key describing its usage. +* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. +* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## UserIdentity +## ApiKeyListResult ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. ## ConfigurationStoreProperties ### Properties @@ -66,17 +63,34 @@ ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. +## KeyValueProperties +### Properties +* **contentType**: string: The content type of the key-value's value. +Providing a proper content-type can enable transformations of values when they are retrieved by applications. +* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. +* **key**: string (ReadOnly): The primary identifier of a key-value. +The key is used in unison with the label to uniquely identify a key-value. +* **label**: string (ReadOnly): A value used to group key-values. +The label is used in unison with the key to uniquely identify a key-value. +* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. +* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. +A locked key-value may not be modified until it is unlocked. +* **tags**: [KeyValuePropertiesTags](#keyvaluepropertiestags): A dictionary of tags that can help identify what a key-value may be applicable for. +* **value**: string: The value of the key-value. + +## KeyValuePropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## KeyVaultProperties ### Properties * **identityClientId**: string: The client id of the identity which will be used to access key vault. * **keyIdentifier**: string: The URI of the key vault key used to encrypt data. -## PrivateEndpointConnectionReference +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -84,9 +98,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. -## PrivateEndpoint +## PrivateEndpointConnectionReference ### Properties -* **id**: string: The resource Id for private endpoint +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. ## PrivateLinkServiceConnectionState ### Properties @@ -94,46 +111,29 @@ * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## Sku +## ResourceIdentity ### Properties -* **name**: string (Required): The SKU name of the configuration store. +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ResourceTags +## ResourceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## KeyValueProperties -### Properties -* **contentType**: string: The content type of the key-value's value. -Providing a proper content-type can enable transformations of values when they are retrieved by applications. -* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. -* **key**: string (ReadOnly): The primary identifier of a key-value. -The key is used in unison with the label to uniquely identify a key-value. -* **label**: string (ReadOnly): A value used to group key-values. -The label is used in unison with the key to uniquely identify a key-value. -* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. -* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. -A locked key-value may not be modified until it is unlocked. -* **tags**: [KeyValuePropertiesTags](#keyvaluepropertiestags): A dictionary of tags that can help identify what a key-value may be applicable for. -* **value**: string: The value of the key-value. +* **Additional Properties Type**: [UserIdentity](#useridentity) -## KeyValuePropertiesTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApiKeyListResult +## Sku ### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. +* **name**: string (Required): The SKU name of the configuration store. -## ApiKey +## UserIdentity ### Properties -* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. -* **id**: string (ReadOnly): The key ID. -* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. -* **name**: string (ReadOnly): A name for the key describing its usage. -* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. -* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.md b/generated/appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.md index 0f6ecd785b..fc90d04d74 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.md @@ -37,22 +37,19 @@ * **ApiVersion**: 2021-03-01-preview * **Output**: [ApiKeyListResult](#apikeylistresult) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ResourceIdentityUserAssignedIdentities +## ApiKey ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. +* **id**: string (ReadOnly): The key ID. +* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. +* **name**: string (ReadOnly): A name for the key describing its usage. +* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. +* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## UserIdentity +## ApiKeyListResult ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. ## ConfigurationStoreProperties ### Properties @@ -68,17 +65,34 @@ ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. +## KeyValueProperties +### Properties +* **contentType**: string: The content type of the key-value's value. +Providing a proper content-type can enable transformations of values when they are retrieved by applications. +* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. +* **key**: string (ReadOnly): The primary identifier of a key-value. +The key is used in unison with the label to uniquely identify a key-value. +* **label**: string (ReadOnly): A value used to group key-values. +The label is used in unison with the key to uniquely identify a key-value. +* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. +* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. +A locked key-value may not be modified until it is unlocked. +* **tags**: [KeyValuePropertiesTags](#keyvaluepropertiestags): A dictionary of tags that can help identify what a key-value may be applicable for. +* **value**: string: The value of the key-value. + +## KeyValuePropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## KeyVaultProperties ### Properties * **identityClientId**: string: The client id of the identity which will be used to access key vault. * **keyIdentifier**: string: The URI of the key vault key used to encrypt data. -## PrivateEndpointConnectionReference +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -86,9 +100,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. -## PrivateEndpoint +## PrivateEndpointConnectionReference ### Properties -* **id**: string: The resource Id for private endpoint +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. ## PrivateLinkServiceConnectionState ### Properties @@ -96,6 +113,18 @@ * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ResourceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) + ## Sku ### Properties * **name**: string (Required): The SKU name of the configuration store. @@ -114,37 +143,8 @@ ### Additional Properties * **Additional Properties Type**: string -## KeyValueProperties -### Properties -* **contentType**: string: The content type of the key-value's value. -Providing a proper content-type can enable transformations of values when they are retrieved by applications. -* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. -* **key**: string (ReadOnly): The primary identifier of a key-value. -The key is used in unison with the label to uniquely identify a key-value. -* **label**: string (ReadOnly): A value used to group key-values. -The label is used in unison with the key to uniquely identify a key-value. -* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. -* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. -A locked key-value may not be modified until it is unlocked. -* **tags**: [KeyValuePropertiesTags](#keyvaluepropertiestags): A dictionary of tags that can help identify what a key-value may be applicable for. -* **value**: string: The value of the key-value. - -## KeyValuePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiKeyListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. - -## ApiKey +## UserIdentity ### Properties -* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. -* **id**: string (ReadOnly): The key ID. -* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. -* **name**: string (ReadOnly): A name for the key describing its usage. -* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. -* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.md b/generated/appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.md index 1be7e254dc..76daad9c79 100644 --- a/generated/appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.md +++ b/generated/appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.md @@ -37,22 +37,19 @@ * **ApiVersion**: 2021-10-01-preview * **Output**: [ApiKeyListResult](#apikeylistresult) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ResourceIdentityUserAssignedIdentities +## ApiKey ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. +* **id**: string (ReadOnly): The key ID. +* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. +* **name**: string (ReadOnly): A name for the key describing its usage. +* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. +* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. -## UserIdentity +## ApiKeyListResult ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. ## ConfigurationStoreProperties ### Properties @@ -71,17 +68,34 @@ ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. +## KeyValueProperties +### Properties +* **contentType**: string: The content type of the key-value's value. +Providing a proper content-type can enable transformations of values when they are retrieved by applications. +* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. +* **key**: string (ReadOnly): The primary identifier of a key-value. +The key is used in unison with the label to uniquely identify a key-value. +* **label**: string (ReadOnly): A value used to group key-values. +The label is used in unison with the key to uniquely identify a key-value. +* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. +* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. +A locked key-value may not be modified until it is unlocked. +* **tags**: [KeyValuePropertiesTags](#keyvaluepropertiestags): A dictionary of tags that can help identify what a key-value may be applicable for. +* **value**: string: The value of the key-value. + +## KeyValuePropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## KeyVaultProperties ### Properties * **identityClientId**: string: The client id of the identity which will be used to access key vault. * **keyIdentifier**: string: The URI of the key vault key used to encrypt data. -## PrivateEndpointConnectionReference +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -89,9 +103,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the configuration store. -## PrivateEndpoint +## PrivateEndpointConnectionReference ### Properties -* **id**: string: The resource Id for private endpoint +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. ## PrivateLinkServiceConnectionState ### Properties @@ -99,6 +116,18 @@ * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identities. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ResourceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) + ## Sku ### Properties * **name**: string (Required): The SKU name of the configuration store. @@ -117,37 +146,8 @@ ### Additional Properties * **Additional Properties Type**: string -## KeyValueProperties -### Properties -* **contentType**: string: The content type of the key-value's value. -Providing a proper content-type can enable transformations of values when they are retrieved by applications. -* **eTag**: string (ReadOnly): An ETag indicating the state of a key-value within a configuration store. -* **key**: string (ReadOnly): The primary identifier of a key-value. -The key is used in unison with the label to uniquely identify a key-value. -* **label**: string (ReadOnly): A value used to group key-values. -The label is used in unison with the key to uniquely identify a key-value. -* **lastModified**: string (ReadOnly): The last time a modifying operation was performed on the given key-value. -* **locked**: bool (ReadOnly): A value indicating whether the key-value is locked. -A locked key-value may not be modified until it is unlocked. -* **tags**: [KeyValuePropertiesTags](#keyvaluepropertiestags): A dictionary of tags that can help identify what a key-value may be applicable for. -* **value**: string: The value of the key-value. - -## KeyValuePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiKeyListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [ApiKey](#apikey)[] (ReadOnly): The collection value. - -## ApiKey +## UserIdentity ### Properties -* **connectionString**: string (ReadOnly): A connection string that can be used by supporting clients for authentication. -* **id**: string (ReadOnly): The key ID. -* **lastModified**: string (ReadOnly): The last time any of the key's properties were modified. -* **name**: string (ReadOnly): A name for the key describing its usage. -* **readOnly**: bool (ReadOnly): Whether this key can only be used for read operations. -* **value**: string (ReadOnly): The value of the key that is used for authentication purposes. +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/applicationinsights/log.out b/generated/applicationinsights/log.out index 059f61e3ea..4440ebbcb4 100644 --- a/generated/applicationinsights/log.out +++ b/generated/applicationinsights/log.out @@ -63,7 +63,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.insights-2015-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -126,7 +126,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json:92:9 @@ -215,7 +215,7 @@ warning | Modeler/MissingType | The schema 'ComponentPurgeBodyFilters-value' has file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/Annotations': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/currentbillingfeatures': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 16ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.insights-2020-11-20"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -278,7 +278,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WorkbookTemplateResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-11-20/workbookTemplates_API.json:252:5 @@ -366,7 +366,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MyWorkbookResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json:321:5 @@ -489,7 +489,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WorkbookResource-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-08-01/workbooks_API.json:430:9 @@ -559,7 +559,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComponentsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/components_API.json:390:5 @@ -651,7 +651,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms @@ -717,10 +717,10 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.insights-2018-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -783,7 +783,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComponentsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json:333:5 @@ -889,7 +889,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms @@ -955,7 +955,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -1021,7 +1021,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorFieldContract' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-10-20/workbookOperations_API.json:97:5 @@ -1144,7 +1144,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WebtestsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-10-05-preview/webTests_API.json:329:5 @@ -1161,7 +1161,7 @@ warning | PreCheck/SchemaMissingType | The schema 'WebTest' with an undefined ty warning | PreCheck/SchemaMissingType | The schema 'WebTestProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-10-05-preview/webTests_API.json:425:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.insights-2020-02-10-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1224,7 +1224,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -1290,7 +1290,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComponentsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json:369:5 @@ -1319,7 +1319,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ComponentPurgeStatusResponse' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'ComponentPurgeBodyFilters-value' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2019-10-17-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1382,7 +1382,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WorkbookTemplateResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/workbookTemplates_API.json:252:5 @@ -1405,7 +1405,7 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkbookError' with an undefi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.insights-2018-06-17-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1468,7 +1468,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json:270:5 @@ -1491,7 +1491,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbookOperations_API.json:111:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.insights-2017-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1554,7 +1554,7 @@ warning | DeprecatedConfig | Using directive.57.suppress which is deprecated and warning | DeprecatedConfig | Using directive.58.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.59.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/eaSubscriptionMigration_API.json:141:5 @@ -1564,5 +1564,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/componentFeaturesAndPricing_API.json:152:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/microsoft.insights/listMigrationdate': Unable to find type segments -info | autorest.bicep took 4ms -info | Autorest completed in 35.63s. 26 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 33.88s. 26 files generated. diff --git a/generated/applicationinsights/microsoft.insights/2015-05-01/types.md b/generated/applicationinsights/microsoft.insights/2015-05-01/types.md index b56f362b29..843cafcb47 100644 --- a/generated/applicationinsights/microsoft.insights/2015-05-01/types.md +++ b/generated/applicationinsights/microsoft.insights/2015-05-01/types.md @@ -145,6 +145,21 @@ * **tags**: [WorkbookResourceTags](#workbookresourcetags): Resource tags * **type**: 'microsoft.insights/workbooks' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationInsightsComponentAnalyticsItemProperties +### Properties +* **functionAlias**: string: A function alias, used when the type of the item is Function + +## ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions +### Properties +* **Description**: string: The rule description +* **DisplayName**: string: The rule name as it is displayed in UI +* **HelpUrl**: string: URL which displays additional info about the proactive detection rule +* **IsEnabledByDefault**: bool: A flag indicating whether the rule is enabled by default +* **IsHidden**: bool: A flag indicating whether the rule is hidden (from the UI) +* **IsInPreview**: bool: A flag indicating whether the rule is in preview +* **Name**: string: The rule name +* **SupportsEmailNotifications**: bool: A flag indicating whether email notifications are supported for detections for this rule + ## ApplicationInsightsComponentProperties ### Properties * **AppId**: string (ReadOnly): Application Insights Unique ID for your Application. @@ -166,31 +181,11 @@ * **SamplingPercentage**: int: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. * **TenantId**: string (ReadOnly): Azure Tenant Id. -## PrivateLinkScopedResource -### Properties -* **ResourceId**: string: The full resource Id of the private link scope resource. -* **ScopeId**: string: The private link scope unique Identifier. - ## ComponentsResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationInsightsComponentAnalyticsItemProperties -### Properties -* **functionAlias**: string: A function alias, used when the type of the item is Function - -## ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions -### Properties -* **Description**: string: The rule description -* **DisplayName**: string: The rule name as it is displayed in UI -* **HelpUrl**: string: URL which displays additional info about the proactive detection rule -* **IsEnabledByDefault**: bool: A flag indicating whether the rule is enabled by default -* **IsHidden**: bool: A flag indicating whether the rule is hidden (from the UI) -* **IsInPreview**: bool: A flag indicating whether the rule is in preview -* **Name**: string: The rule name -* **SupportsEmailNotifications**: bool: A flag indicating whether email notifications are supported for detections for this rule - ## MyWorkbookProperties ### Properties * **category**: string (Required): Workbook category, as defined by the user at creation time. @@ -207,6 +202,15 @@ ### Additional Properties * **Additional Properties Type**: string +## PrivateLinkScopedResource +### Properties +* **ResourceId**: string: The full resource Id of the private link scope resource. +* **ScopeId**: string: The private link scope unique Identifier. + +## WebTestGeolocation +### Properties +* **Id**: string: Location ID for the webtest to run from. + ## WebTestProperties ### Properties * **Configuration**: [WebTestPropertiesConfiguration](#webtestpropertiesconfiguration): An XML configuration specification for a WebTest. @@ -225,10 +229,6 @@ ### Properties * **WebTest**: string: The XML specification of a WebTest to run against an application. -## WebTestGeolocation -### Properties -* **Id**: string: Location ID for the webtest to run from. - ## WebtestsResourceTags ### Properties ### Additional Properties diff --git a/generated/applicationinsights/microsoft.insights/2018-05-01-preview/types.md b/generated/applicationinsights/microsoft.insights/2018-05-01-preview/types.md index b77f4dcfaf..8942a32f0e 100644 --- a/generated/applicationinsights/microsoft.insights/2018-05-01-preview/types.md +++ b/generated/applicationinsights/microsoft.insights/2018-05-01-preview/types.md @@ -34,6 +34,26 @@ * **tags**: [WebtestsResourceTags](#webtestsresourcetags): Resource tags * **type**: 'Microsoft.Insights/webtests' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationInsightsComponentProactiveDetectionConfigurationProperties +### Properties +* **CustomEmails**: string[]: Custom email addresses for this rule notifications +* **Enabled**: bool: A flag that indicates whether this rule is enabled by the user +* **LastUpdatedTime**: string (ReadOnly): The last time this rule was updated +* **Name**: string (ReadOnly): The rule name +* **RuleDefinitions**: [ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions](#applicationinsightscomponentproactivedetectionconfigurationpropertiesruledefinitions): Static definitions of the ProactiveDetection configuration rule (same values for all components). +* **SendEmailsToSubscriptionOwners**: bool: A flag that indicated whether notifications on this rule should be sent to subscription owners + +## ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions +### Properties +* **Description**: string: The rule description +* **DisplayName**: string: The rule name as it is displayed in UI +* **HelpUrl**: string: URL which displays additional info about the proactive detection rule +* **IsEnabledByDefault**: bool: A flag indicating whether the rule is enabled by default +* **IsHidden**: bool: A flag indicating whether the rule is hidden (from the UI) +* **IsInPreview**: bool: A flag indicating whether the rule is in preview +* **Name**: string: The rule name +* **SupportsEmailNotifications**: bool: A flag indicating whether email notifications are supported for detections for this rule + ## ApplicationInsightsComponentProperties ### Properties * **AppId**: string (ReadOnly): Application Insights Unique ID for your Application. @@ -57,35 +77,24 @@ * **SamplingPercentage**: int: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. * **TenantId**: string (ReadOnly): Azure Tenant Id. -## PrivateLinkScopedResource -### Properties -* **ResourceId**: string: The full resource Id of the private link scope resource. -* **ScopeId**: string: The private link scope unique Identifier. - ## ComponentsResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationInsightsComponentProactiveDetectionConfigurationProperties +## HeaderField ### Properties -* **CustomEmails**: string[]: Custom email addresses for this rule notifications -* **Enabled**: bool: A flag that indicates whether this rule is enabled by the user -* **LastUpdatedTime**: string (ReadOnly): The last time this rule was updated -* **Name**: string (ReadOnly): The rule name -* **RuleDefinitions**: [ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions](#applicationinsightscomponentproactivedetectionconfigurationpropertiesruledefinitions): Static definitions of the ProactiveDetection configuration rule (same values for all components). -* **SendEmailsToSubscriptionOwners**: bool: A flag that indicated whether notifications on this rule should be sent to subscription owners +* **key**: string: The name of the header. +* **value**: string: The value of the header. -## ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions +## PrivateLinkScopedResource ### Properties -* **Description**: string: The rule description -* **DisplayName**: string: The rule name as it is displayed in UI -* **HelpUrl**: string: URL which displays additional info about the proactive detection rule -* **IsEnabledByDefault**: bool: A flag indicating whether the rule is enabled by default -* **IsHidden**: bool: A flag indicating whether the rule is hidden (from the UI) -* **IsInPreview**: bool: A flag indicating whether the rule is in preview -* **Name**: string: The rule name -* **SupportsEmailNotifications**: bool: A flag indicating whether email notifications are supported for detections for this rule +* **ResourceId**: string: The full resource Id of the private link scope resource. +* **ScopeId**: string: The private link scope unique Identifier. + +## WebTestGeolocation +### Properties +* **Id**: string: Location ID for the WebTest to run from. ## WebTestProperties ### Properties @@ -107,10 +116,6 @@ ### Properties * **WebTest**: string: The XML specification of a WebTest to run against an application. -## WebTestGeolocation -### Properties -* **Id**: string: Location ID for the WebTest to run from. - ## WebTestPropertiesRequest ### Properties * **FollowRedirects**: bool: Follow redirects for this web test. @@ -120,11 +125,6 @@ * **RequestBody**: string: Base64 encoded string body to send with this web test. * **RequestUrl**: string: Url location to test. -## HeaderField -### Properties -* **key**: string: The name of the header. -* **value**: string: The value of the header. - ## WebTestPropertiesValidationRules ### Properties * **ContentValidation**: [WebTestPropertiesValidationRulesContentValidation](#webtestpropertiesvalidationrulescontentvalidation): The collection of content validation properties diff --git a/generated/applicationinsights/microsoft.insights/2018-06-17-preview/types.md b/generated/applicationinsights/microsoft.insights/2018-06-17-preview/types.md index 1c597ca560..c666212881 100644 --- a/generated/applicationinsights/microsoft.insights/2018-06-17-preview/types.md +++ b/generated/applicationinsights/microsoft.insights/2018-06-17-preview/types.md @@ -12,6 +12,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'microsoft.insights/workbooks' (ReadOnly, DeployTimeConstant): The resource type +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## WorkbookProperties ### Properties * **category**: string (Required): Workbook category, as defined by the user at creation time. @@ -23,8 +28,3 @@ * **userId**: string (ReadOnly): Unique user id of the specific user that owns this workbook. * **version**: string: Workbook version -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/applicationinsights/microsoft.insights/2019-10-17-preview/types.md b/generated/applicationinsights/microsoft.insights/2019-10-17-preview/types.md index f83b1c87ff..f9d0ab75bb 100644 --- a/generated/applicationinsights/microsoft.insights/2019-10-17-preview/types.md +++ b/generated/applicationinsights/microsoft.insights/2019-10-17-preview/types.md @@ -11,14 +11,6 @@ * **tags**: [WorkbookTemplateResourceTags](#workbooktemplateresourcetags): Resource tags * **type**: 'microsoft.insights/workbooktemplates' (ReadOnly, DeployTimeConstant): The resource type -## WorkbookTemplateProperties -### Properties -* **author**: string: Information about the author of the workbook template. -* **galleries**: [WorkbookTemplateGallery](#workbooktemplategallery)[] (Required): Workbook galleries supported by the template. -* **localized**: [WorkbookTemplatePropertiesLocalized](#workbooktemplatepropertieslocalized): Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. -* **priority**: int: Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. -* **templateData**: any (Required): Any object - ## WorkbookTemplateGallery ### Properties * **category**: string: Category for the gallery. @@ -27,16 +19,24 @@ * **resourceType**: string: Azure resource type supported by the gallery. * **type**: string: Type of workbook supported by the workbook template. -## WorkbookTemplatePropertiesLocalized -### Properties -### Additional Properties -* **Additional Properties Type**: [WorkbookTemplateLocalizedGallery](#workbooktemplatelocalizedgallery)[] - ## WorkbookTemplateLocalizedGallery ### Properties * **galleries**: [WorkbookTemplateGallery](#workbooktemplategallery)[]: Workbook galleries supported by the template. * **templateData**: any: Any object +## WorkbookTemplateProperties +### Properties +* **author**: string: Information about the author of the workbook template. +* **galleries**: [WorkbookTemplateGallery](#workbooktemplategallery)[] (Required): Workbook galleries supported by the template. +* **localized**: [WorkbookTemplatePropertiesLocalized](#workbooktemplatepropertieslocalized): Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. +* **priority**: int: Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. +* **templateData**: any (Required): Any object + +## WorkbookTemplatePropertiesLocalized +### Properties +### Additional Properties +* **Additional Properties Type**: [WorkbookTemplateLocalizedGallery](#workbooktemplatelocalizedgallery)[] + ## WorkbookTemplateResourceTags ### Properties ### Additional Properties diff --git a/generated/applicationinsights/microsoft.insights/2020-02-02-preview/types.md b/generated/applicationinsights/microsoft.insights/2020-02-02-preview/types.md index 57c5dca1c4..8eb9244ba4 100644 --- a/generated/applicationinsights/microsoft.insights/2020-02-02-preview/types.md +++ b/generated/applicationinsights/microsoft.insights/2020-02-02-preview/types.md @@ -41,13 +41,13 @@ * **TenantId**: string (ReadOnly): Azure Tenant Id. * **WorkspaceResourceId**: 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. -## PrivateLinkScopedResource -### Properties -* **ResourceId**: string: The full resource Id of the private link scope resource. -* **ScopeId**: string: The private link scope unique Identifier. - ## ComponentsResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## PrivateLinkScopedResource +### Properties +* **ResourceId**: string: The full resource Id of the private link scope resource. +* **ScopeId**: string: The private link scope unique Identifier. + diff --git a/generated/applicationinsights/microsoft.insights/2020-02-02/types.md b/generated/applicationinsights/microsoft.insights/2020-02-02/types.md index 44af21e4b8..0abdfcff19 100644 --- a/generated/applicationinsights/microsoft.insights/2020-02-02/types.md +++ b/generated/applicationinsights/microsoft.insights/2020-02-02/types.md @@ -41,13 +41,13 @@ * **TenantId**: string (ReadOnly): Azure Tenant Id. * **WorkspaceResourceId**: 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. -## PrivateLinkScopedResource -### Properties -* **ResourceId**: string: The full resource Id of the private link scope resource. -* **ScopeId**: string: The private link scope unique Identifier. - ## ComponentsResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## PrivateLinkScopedResource +### Properties +* **ResourceId**: string: The full resource Id of the private link scope resource. +* **ScopeId**: string: The private link scope unique Identifier. + diff --git a/generated/applicationinsights/microsoft.insights/2020-10-05-preview/types.md b/generated/applicationinsights/microsoft.insights/2020-10-05-preview/types.md index b9b97a2170..cb5cef3731 100644 --- a/generated/applicationinsights/microsoft.insights/2020-10-05-preview/types.md +++ b/generated/applicationinsights/microsoft.insights/2020-10-05-preview/types.md @@ -12,6 +12,15 @@ * **tags**: [WebtestsResourceTags](#webtestsresourcetags): Resource tags * **type**: 'Microsoft.Insights/webtests' (ReadOnly, DeployTimeConstant): The resource type +## HeaderField +### Properties +* **key**: string: The name of the header. +* **value**: string: The value of the header. + +## WebTestGeolocation +### Properties +* **Id**: string: Location ID for the WebTest to run from. + ## WebTestProperties ### Properties * **Configuration**: [WebTestPropertiesConfiguration](#webtestpropertiesconfiguration): An XML configuration specification for a WebTest. @@ -32,10 +41,6 @@ ### Properties * **WebTest**: string: The XML specification of a WebTest to run against an application. -## WebTestGeolocation -### Properties -* **Id**: string: Location ID for the WebTest to run from. - ## WebTestPropertiesRequest ### Properties * **FollowRedirects**: bool: Follow redirects for this web test. @@ -45,11 +50,6 @@ * **RequestBody**: string: Base64 encoded string body to send with this web test. * **RequestUrl**: string: Url location to test. -## HeaderField -### Properties -* **key**: string: The name of the header. -* **value**: string: The value of the header. - ## WebTestPropertiesValidationRules ### Properties * **ContentValidation**: [WebTestPropertiesValidationRulesContentValidation](#webtestpropertiesvalidationrulescontentvalidation): The collection of content validation properties diff --git a/generated/applicationinsights/microsoft.insights/2020-10-20/types.md b/generated/applicationinsights/microsoft.insights/2020-10-20/types.md index c7776ebdd6..fba6c351a7 100644 --- a/generated/applicationinsights/microsoft.insights/2020-10-20/types.md +++ b/generated/applicationinsights/microsoft.insights/2020-10-20/types.md @@ -28,21 +28,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Insights/workbooks' (ReadOnly, DeployTimeConstant): The resource type -## MyWorkbookResourceEtag -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MyWorkbookManagedIdentity ### Properties * **type**: 'None' | 'UserAssigned' | string: The identity type. * **userAssignedIdentities**: [MyWorkbookUserAssignedIdentities](#myworkbookuserassignedidentities): Customer Managed Identity -## MyWorkbookUserAssignedIdentities -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. - ## MyWorkbookProperties ### Properties * **category**: string (Required): Workbook category, as defined by the user at creation time. @@ -55,27 +45,36 @@ * **userId**: string (ReadOnly): Unique user id of the specific user that owns this private workbook. * **version**: string: This instance's version of the data model. This can change as new features are added that can be marked private workbook. +## MyWorkbookResourceEtag +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## MyWorkbookResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## MyWorkbookUserAssignedIdentities +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. + ## ResourceEtag ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## WorkbookManagedIdentity ### Properties * **type**: 'None' | 'UserAssigned' | string: The identity type. * **userAssignedIdentities**: [WorkbookUserAssignedIdentities](#workbookuserassignedidentities): Customer Managed Identity -## WorkbookUserAssignedIdentities -### Properties -* **clientId**: string (ReadOnly): The client ID of resource. -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. - ## WorkbookProperties ### Properties * **category**: string (Required): Workbook category, as defined by the user at creation time. @@ -88,8 +87,9 @@ * **userId**: string (ReadOnly): Unique user id of the specific user that owns this workbook. * **version**: string: Workbook version -## ResourceTags +## WorkbookUserAssignedIdentities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of resource. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. diff --git a/generated/applicationinsights/microsoft.insights/2020-11-20/types.md b/generated/applicationinsights/microsoft.insights/2020-11-20/types.md index 355d198121..fabd984b18 100644 --- a/generated/applicationinsights/microsoft.insights/2020-11-20/types.md +++ b/generated/applicationinsights/microsoft.insights/2020-11-20/types.md @@ -11,14 +11,6 @@ * **tags**: [WorkbookTemplateResourceTags](#workbooktemplateresourcetags): Resource tags * **type**: 'Microsoft.Insights/workbooktemplates' (ReadOnly, DeployTimeConstant): The resource type -## WorkbookTemplateProperties -### Properties -* **author**: string: Information about the author of the workbook template. -* **galleries**: [WorkbookTemplateGallery](#workbooktemplategallery)[] (Required): Workbook galleries supported by the template. -* **localized**: [WorkbookTemplatePropertiesLocalized](#workbooktemplatepropertieslocalized): Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. -* **priority**: int: Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. -* **templateData**: any (Required): Any object - ## WorkbookTemplateGallery ### Properties * **category**: string: Category for the gallery. @@ -27,16 +19,24 @@ * **resourceType**: string: Azure resource type supported by the gallery. * **type**: string: Type of workbook supported by the workbook template. -## WorkbookTemplatePropertiesLocalized -### Properties -### Additional Properties -* **Additional Properties Type**: [WorkbookTemplateLocalizedGallery](#workbooktemplatelocalizedgallery)[] - ## WorkbookTemplateLocalizedGallery ### Properties * **galleries**: [WorkbookTemplateGallery](#workbooktemplategallery)[]: Workbook galleries supported by the template. * **templateData**: any: Any object +## WorkbookTemplateProperties +### Properties +* **author**: string: Information about the author of the workbook template. +* **galleries**: [WorkbookTemplateGallery](#workbooktemplategallery)[] (Required): Workbook galleries supported by the template. +* **localized**: [WorkbookTemplatePropertiesLocalized](#workbooktemplatepropertieslocalized): Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. +* **priority**: int: Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. +* **templateData**: any (Required): Any object + +## WorkbookTemplatePropertiesLocalized +### Properties +### Additional Properties +* **Additional Properties Type**: [WorkbookTemplateLocalizedGallery](#workbooktemplatelocalizedgallery)[] + ## WorkbookTemplateResourceTags ### Properties ### Additional Properties diff --git a/generated/applicationinsights/microsoft.insights/2021-03-08/types.md b/generated/applicationinsights/microsoft.insights/2021-03-08/types.md index 99aac579b2..9aaefb9906 100644 --- a/generated/applicationinsights/microsoft.insights/2021-03-08/types.md +++ b/generated/applicationinsights/microsoft.insights/2021-03-08/types.md @@ -30,21 +30,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Insights/workbooks' (ReadOnly, DeployTimeConstant): The resource type -## MyWorkbookResourceEtag -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MyWorkbookManagedIdentity ### Properties * **type**: 'None' | 'UserAssigned' | string: The identity type. * **userAssignedIdentities**: [MyWorkbookUserAssignedIdentities](#myworkbookuserassignedidentities): Customer Managed Identity -## MyWorkbookUserAssignedIdentities -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. - ## MyWorkbookProperties ### Properties * **category**: string (Required): Workbook category, as defined by the user at creation time. @@ -57,36 +47,45 @@ * **userId**: string (ReadOnly): Unique user id of the specific user that owns this private workbook. * **version**: string: This instance's version of the data model. This can change as new features are added that can be marked private workbook. -## SystemData +## MyWorkbookResourceEtag ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### Additional Properties +* **Additional Properties Type**: string ## MyWorkbookResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## MyWorkbookUserAssignedIdentities +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. + ## ResourceEtag ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## WorkbookManagedIdentity ### Properties * **type**: 'None' | 'UserAssigned' | string: The identity type. * **userAssignedIdentities**: [WorkbookUserAssignedIdentities](#workbookuserassignedidentities): Customer Managed Identity -## WorkbookUserAssignedIdentities -### Properties -* **clientId**: string (ReadOnly): The client ID of resource. -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. - ## WorkbookProperties ### Properties * **category**: string (Required): Workbook category, as defined by the user at creation time. @@ -101,8 +100,9 @@ * **userId**: string (ReadOnly): Unique user id of the specific user that owns this workbook. * **version**: string: Workbook version -## ResourceTags +## WorkbookUserAssignedIdentities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of resource. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. diff --git a/generated/applicationinsights/microsoft.insights/2021-08-01/types.md b/generated/applicationinsights/microsoft.insights/2021-08-01/types.md index cc5e8a9169..0899ef5e97 100644 --- a/generated/applicationinsights/microsoft.insights/2021-08-01/types.md +++ b/generated/applicationinsights/microsoft.insights/2021-08-01/types.md @@ -15,12 +15,19 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Insights/workbooks' (ReadOnly, DeployTimeConstant): The resource type -## WorkbookResourceIdentity +## SystemData ### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## UserAssignedIdentities ### Properties @@ -46,17 +53,10 @@ * **userId**: string (ReadOnly): Unique user id of the specific user that owns this workbook. * **version**: string: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## WorkbookResourceIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. diff --git a/generated/appplatform/log.out b/generated/appplatform/log.out index 2388ef6c6c..14d1fdd6bb 100644 --- a/generated/appplatform/log.out +++ b/generated/appplatform/log.out @@ -6,13 +6,13 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.appplatform-2022-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.appplatform/spring/serviceregistries under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}' has no body defined. @@ -25,20 +25,20 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.appplatform/spring/serviceregistries under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}' has no body defined. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 26ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.appplatform-2021-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-09-01-preview/appplatform.json:5385:5 @@ -52,7 +52,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-06-01-preview/appplatform.json:4590:5 @@ -60,13 +60,13 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-06-01-preview/appplatform.json:4600:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 13ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.appplatform-2020-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json:4510:5 @@ -80,7 +80,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json:4519:5 @@ -88,5 +88,5 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json:4529:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms -info | Autorest completed in 31.07s. 12 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 29.83s. 12 files generated. diff --git a/generated/appplatform/microsoft.appplatform/2020-07-01/types.md b/generated/appplatform/microsoft.appplatform/2020-07-01/types.md index 982ef653db..9f2874c9c2 100644 --- a/generated/appplatform/microsoft.appplatform/2020-07-01/types.md +++ b/generated/appplatform/microsoft.appplatform/2020-07-01/types.md @@ -83,52 +83,6 @@ * **ApiVersion**: 2020-07-01 * **Output**: [TestKeys](#testkeys) -## ClusterResourceProperties -### Properties -* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload -* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service -* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource -* **version**: int (ReadOnly): Version of the Service - -## NetworkProfile -### Properties -* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps -* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps -* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. -* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. -* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR -* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime -* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime - -## NetworkProfileOutboundIPs -### Properties -* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. - -## RequiredTraffic -### Properties -* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic -* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic -* **ips**: string[] (ReadOnly): The ip list of required traffic -* **port**: int (ReadOnly): The port of required traffic -* **protocol**: string (ReadOnly): The protocol of required traffic - -## Sku -### Properties -* **capacity**: int: Current capacity of the target resource -* **name**: string: Name of the Sku -* **tier**: string: Tier of the Sku - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentityProperties -### Properties -* **principalId**: string: Principal Id -* **tenantId**: string: Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity - ## AppResourceProperties ### Properties * **activeDeploymentName**: string: Name of the active deployment of the App @@ -141,17 +95,6 @@ * **temporaryDisk**: [TemporaryDisk](#temporarydisk): Temporary disk payload * **url**: string (ReadOnly): URL of the App -## PersistentDisk -### Properties -* **mountPath**: string: Mount path of the persistent disk -* **sizeInGB**: int: Size of the persistent disk in GB -* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB - -## TemporaryDisk -### Properties -* **mountPath**: string: Mount path of the temporary disk -* **sizeInGB**: int: Size of the temporary disk in GB - ## BindingResourceProperties ### Properties * **bindingParameters**: [BindingResourcePropertiesBindingParameters](#bindingresourcepropertiesbindingparameters): Binding parameters of the Binding resource @@ -168,53 +111,6 @@ ### Additional Properties * **Additional Properties Type**: any -## DeploymentResourceProperties -### Properties -* **active**: bool (ReadOnly): Indicates whether the Deployment is active -* **appName**: string (ReadOnly): App name of the deployment -* **createdTime**: string (ReadOnly): Date time when the resource is created -* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload -* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment -* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment -* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment - -## DeploymentSettings -### Properties -* **cpu**: int: Required CPU, basic tier should be 1, standard tier should be in range (1, 4) -* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables -* **jvmOptions**: string: JVM parameter -* **memoryInGB**: int: Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) -* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root -* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version - -## DeploymentSettingsEnvironmentVariables -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DeploymentInstance -### Properties -* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance -* **name**: string (ReadOnly): Name of the deployment instance -* **reason**: string (ReadOnly): Failed reason of the deployment instance -* **startTime**: string (ReadOnly): Start time of the deployment instance -* **status**: string (ReadOnly): Status of the deployment instance - -## UserSourceInfo -### Properties -* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be -the relative path to the target module/project. -* **relativePath**: string: Relative path of the storage which stores the source -* **type**: 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded -* **version**: string: Version of the source - -## CustomDomainProperties -### Properties -* **appName**: string (ReadOnly): The app name of domain. -* **certName**: string: The bound certificate name of domain. -* **thumbprint**: string: The thumbprint of bound certificate. - ## CertificateProperties ### Properties * **activateDate**: string (ReadOnly): The activate date of certificate. @@ -228,15 +124,12 @@ the relative path to the target module/project. * **thumbprint**: string (ReadOnly): The thumbprint of certificate. * **vaultUri**: string (Required): The vault uri of user key vault. -## ConfigServerProperties -### Properties -* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. -* **error**: [Error](#error): The error code compose of code and message. -* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. - -## ConfigServerSettings +## ClusterResourceProperties ### Properties -* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. +* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload +* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service +* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource +* **version**: int (ReadOnly): Version of the Service ## ConfigServerGitProperty ### Properties @@ -251,6 +144,60 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. +## ConfigServerProperties +### Properties +* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. +* **error**: [Error](#error): The error code compose of code and message. +* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. + +## ConfigServerSettings +### Properties +* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. + +## CustomDomainProperties +### Properties +* **appName**: string (ReadOnly): The app name of domain. +* **certName**: string: The bound certificate name of domain. +* **thumbprint**: string: The thumbprint of bound certificate. + +## DeploymentInstance +### Properties +* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance +* **name**: string (ReadOnly): Name of the deployment instance +* **reason**: string (ReadOnly): Failed reason of the deployment instance +* **startTime**: string (ReadOnly): Start time of the deployment instance +* **status**: string (ReadOnly): Status of the deployment instance + +## DeploymentResourceProperties +### Properties +* **active**: bool (ReadOnly): Indicates whether the Deployment is active +* **appName**: string (ReadOnly): App name of the deployment +* **createdTime**: string (ReadOnly): Date time when the resource is created +* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload +* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment +* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment +* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment + +## DeploymentSettings +### Properties +* **cpu**: int: Required CPU, basic tier should be 1, standard tier should be in range (1, 4) +* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables +* **jvmOptions**: string: JVM parameter +* **memoryInGB**: int: Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) +* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root +* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version + +## DeploymentSettingsEnvironmentVariables +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Error +### Properties +* **code**: string: The code of error. +* **message**: string: The message of error. + ## GitPatternRepository ### Properties * **hostKey**: string: Public sshKey of git repository. @@ -265,10 +212,11 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## Error +## ManagedIdentityProperties ### Properties -* **code**: string: The code of error. -* **message**: string: The message of error. +* **principalId**: string: Principal Id +* **tenantId**: string: Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity ## MonitoringSettingProperties ### Properties @@ -277,6 +225,45 @@ the relative path to the target module/project. * **provisioningState**: 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Monitoring Setting. * **traceEnabled**: bool: Indicates whether enable the trace functionality +## NetworkProfile +### Properties +* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps +* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps +* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. +* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. +* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR +* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime +* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime + +## NetworkProfileOutboundIPs +### Properties +* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. + +## PersistentDisk +### Properties +* **mountPath**: string: Mount path of the persistent disk +* **sizeInGB**: int: Size of the persistent disk in GB +* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB + +## RequiredTraffic +### Properties +* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic +* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic +* **ips**: string[] (ReadOnly): The ip list of required traffic +* **port**: int (ReadOnly): The port of required traffic +* **protocol**: string (ReadOnly): The protocol of required traffic + +## Sku +### Properties +* **capacity**: int: Current capacity of the target resource +* **name**: string: Name of the Sku +* **tier**: string: Tier of the Sku + +## TemporaryDisk +### Properties +* **mountPath**: string: Mount path of the temporary disk +* **sizeInGB**: int: Size of the temporary disk in GB + ## TestKeys ### Properties * **enabled**: bool (ReadOnly): Indicates whether the test endpoint feature enabled or not @@ -285,3 +272,16 @@ the relative path to the target module/project. * **secondaryKey**: string (ReadOnly): Secondary key * **secondaryTestEndpoint**: string (ReadOnly): Secondary test endpoint +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserSourceInfo +### Properties +* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be +the relative path to the target module/project. +* **relativePath**: string: Relative path of the storage which stores the source +* **type**: 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded +* **version**: string: Version of the source + diff --git a/generated/appplatform/microsoft.appplatform/2020-11-01-preview/types.md b/generated/appplatform/microsoft.appplatform/2020-11-01-preview/types.md index 9b9c64a2cc..f005b71af7 100644 --- a/generated/appplatform/microsoft.appplatform/2020-11-01-preview/types.md +++ b/generated/appplatform/microsoft.appplatform/2020-11-01-preview/types.md @@ -83,51 +83,9 @@ * **ApiVersion**: 2020-11-01-preview * **Output**: [TestKeys](#testkeys) -## ClusterResourceProperties -### Properties -* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload -* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service -* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource -* **version**: int (ReadOnly): Version of the Service - -## NetworkProfile -### Properties -* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps -* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps -* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. -* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. -* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR -* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime -* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime - -## NetworkProfileOutboundIPs -### Properties -* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. - -## RequiredTraffic -### Properties -* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic -* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic -* **ips**: string[] (ReadOnly): The ip list of required traffic -* **port**: int (ReadOnly): The port of required traffic -* **protocol**: string (ReadOnly): The protocol of required traffic - -## Sku -### Properties -* **capacity**: int: Current capacity of the target resource -* **name**: string: Name of the Sku -* **tier**: string: Tier of the Sku - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentityProperties +## ApplicationInsightsAgentVersions ### Properties -* **principalId**: string: Principal Id -* **tenantId**: string: Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity +* **java**: string (ReadOnly): Indicates the version of application insight java agent ## AppResourceProperties ### Properties @@ -142,17 +100,6 @@ * **temporaryDisk**: [TemporaryDisk](#temporarydisk): Temporary disk payload * **url**: string (ReadOnly): URL of the App -## PersistentDisk -### Properties -* **mountPath**: string: Mount path of the persistent disk -* **sizeInGB**: int: Size of the persistent disk in GB -* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB - -## TemporaryDisk -### Properties -* **mountPath**: string: Mount path of the temporary disk -* **sizeInGB**: int: Size of the temporary disk in GB - ## BindingResourceProperties ### Properties * **bindingParameters**: [BindingResourcePropertiesBindingParameters](#bindingresourcepropertiesbindingparameters): Binding parameters of the Binding resource @@ -169,53 +116,6 @@ ### Additional Properties * **Additional Properties Type**: any -## DeploymentResourceProperties -### Properties -* **active**: bool (ReadOnly): Indicates whether the Deployment is active -* **appName**: string (ReadOnly): App name of the deployment -* **createdTime**: string (ReadOnly): Date time when the resource is created -* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload -* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment -* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment -* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment - -## DeploymentSettings -### Properties -* **cpu**: int: Required CPU, basic tier should be 1, standard tier should be in range (1, 4) -* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables -* **jvmOptions**: string: JVM parameter -* **memoryInGB**: int: Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) -* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root -* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version - -## DeploymentSettingsEnvironmentVariables -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DeploymentInstance -### Properties -* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance -* **name**: string (ReadOnly): Name of the deployment instance -* **reason**: string (ReadOnly): Failed reason of the deployment instance -* **startTime**: string (ReadOnly): Start time of the deployment instance -* **status**: string (ReadOnly): Status of the deployment instance - -## UserSourceInfo -### Properties -* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be -the relative path to the target module/project. -* **relativePath**: string: Relative path of the storage which stores the source -* **type**: 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded -* **version**: string: Version of the source - -## CustomDomainProperties -### Properties -* **appName**: string (ReadOnly): The app name of domain. -* **certName**: string: The bound certificate name of domain. -* **thumbprint**: string: The thumbprint of bound certificate. - ## CertificateProperties ### Properties * **activateDate**: string (ReadOnly): The activate date of certificate. @@ -229,15 +129,12 @@ the relative path to the target module/project. * **thumbprint**: string (ReadOnly): The thumbprint of certificate. * **vaultUri**: string (Required): The vault uri of user key vault. -## ConfigServerProperties -### Properties -* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. -* **error**: [Error](#error): The error code compose of code and message. -* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. - -## ConfigServerSettings +## ClusterResourceProperties ### Properties -* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. +* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload +* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service +* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource +* **version**: int (ReadOnly): Version of the Service ## ConfigServerGitProperty ### Properties @@ -252,6 +149,60 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. +## ConfigServerProperties +### Properties +* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. +* **error**: [Error](#error): The error code compose of code and message. +* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. + +## ConfigServerSettings +### Properties +* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. + +## CustomDomainProperties +### Properties +* **appName**: string (ReadOnly): The app name of domain. +* **certName**: string: The bound certificate name of domain. +* **thumbprint**: string: The thumbprint of bound certificate. + +## DeploymentInstance +### Properties +* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance +* **name**: string (ReadOnly): Name of the deployment instance +* **reason**: string (ReadOnly): Failed reason of the deployment instance +* **startTime**: string (ReadOnly): Start time of the deployment instance +* **status**: string (ReadOnly): Status of the deployment instance + +## DeploymentResourceProperties +### Properties +* **active**: bool (ReadOnly): Indicates whether the Deployment is active +* **appName**: string (ReadOnly): App name of the deployment +* **createdTime**: string (ReadOnly): Date time when the resource is created +* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload +* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment +* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment +* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment + +## DeploymentSettings +### Properties +* **cpu**: int: Required CPU, basic tier should be 1, standard tier should be in range (1, 4) +* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables +* **jvmOptions**: string: JVM parameter +* **memoryInGB**: int: Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) +* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root +* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version + +## DeploymentSettingsEnvironmentVariables +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Error +### Properties +* **code**: string: The code of error. +* **message**: string: The message of error. + ## GitPatternRepository ### Properties * **hostKey**: string: Public sshKey of git repository. @@ -266,10 +217,11 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## Error +## ManagedIdentityProperties ### Properties -* **code**: string: The code of error. -* **message**: string: The message of error. +* **principalId**: string: Principal Id +* **tenantId**: string: Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity ## MonitoringSettingProperties ### Properties @@ -280,9 +232,44 @@ the relative path to the target module/project. * **provisioningState**: 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Monitoring Setting. * **traceEnabled**: bool: Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not -## ApplicationInsightsAgentVersions +## NetworkProfile ### Properties -* **java**: string (ReadOnly): Indicates the version of application insight java agent +* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps +* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps +* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. +* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. +* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR +* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime +* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime + +## NetworkProfileOutboundIPs +### Properties +* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. + +## PersistentDisk +### Properties +* **mountPath**: string: Mount path of the persistent disk +* **sizeInGB**: int: Size of the persistent disk in GB +* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB + +## RequiredTraffic +### Properties +* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic +* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic +* **ips**: string[] (ReadOnly): The ip list of required traffic +* **port**: int (ReadOnly): The port of required traffic +* **protocol**: string (ReadOnly): The protocol of required traffic + +## Sku +### Properties +* **capacity**: int: Current capacity of the target resource +* **name**: string: Name of the Sku +* **tier**: string: Tier of the Sku + +## TemporaryDisk +### Properties +* **mountPath**: string: Mount path of the temporary disk +* **sizeInGB**: int: Size of the temporary disk in GB ## TestKeys ### Properties @@ -292,3 +279,16 @@ the relative path to the target module/project. * **secondaryKey**: string (ReadOnly): Secondary key * **secondaryTestEndpoint**: string (ReadOnly): Secondary test endpoint +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserSourceInfo +### Properties +* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be +the relative path to the target module/project. +* **relativePath**: string: Relative path of the storage which stores the source +* **type**: 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded +* **version**: string: Version of the source + diff --git a/generated/appplatform/microsoft.appplatform/2021-06-01-preview/types.md b/generated/appplatform/microsoft.appplatform/2021-06-01-preview/types.md index e1c7d47c0e..b4d0aed6a4 100644 --- a/generated/appplatform/microsoft.appplatform/2021-06-01-preview/types.md +++ b/generated/appplatform/microsoft.appplatform/2021-06-01-preview/types.md @@ -83,51 +83,9 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [TestKeys](#testkeys) -## ClusterResourceProperties -### Properties -* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload -* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service -* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource -* **version**: int (ReadOnly): Version of the Service - -## NetworkProfile -### Properties -* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps -* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps -* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. -* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. -* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR -* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime -* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime - -## NetworkProfileOutboundIPs -### Properties -* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. - -## RequiredTraffic -### Properties -* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic -* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic -* **ips**: string[] (ReadOnly): The ip list of required traffic -* **port**: int (ReadOnly): The port of required traffic -* **protocol**: string (ReadOnly): The protocol of required traffic - -## Sku -### Properties -* **capacity**: int: Current capacity of the target resource -* **name**: string: Name of the Sku -* **tier**: string: Tier of the Sku - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentityProperties +## ApplicationInsightsAgentVersions ### Properties -* **principalId**: string: Principal Id -* **tenantId**: string: Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity +* **java**: string (ReadOnly): Indicates the version of application insight java agent ## AppResourceProperties ### Properties @@ -142,17 +100,6 @@ * **temporaryDisk**: [TemporaryDisk](#temporarydisk): Temporary disk payload * **url**: string (ReadOnly): URL of the App -## PersistentDisk -### Properties -* **mountPath**: string: Mount path of the persistent disk -* **sizeInGB**: int: Size of the persistent disk in GB -* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB - -## TemporaryDisk -### Properties -* **mountPath**: string: Mount path of the temporary disk -* **sizeInGB**: int: Size of the temporary disk in GB - ## BindingResourceProperties ### Properties * **bindingParameters**: [BindingResourcePropertiesBindingParameters](#bindingresourcepropertiesbindingparameters): Binding parameters of the Binding resource @@ -169,53 +116,48 @@ ### Additional Properties * **Additional Properties Type**: any -## DeploymentResourceProperties -### Properties -* **active**: bool (ReadOnly): Indicates whether the Deployment is active -* **appName**: string (ReadOnly): App name of the deployment -* **createdTime**: string (ReadOnly): Date time when the resource is created -* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload -* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment -* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment -* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment - -## DeploymentSettings +## CertificateProperties ### Properties -* **cpu**: int: Required CPU. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the CPU size. -* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables -* **jvmOptions**: string: JVM parameter -* **memoryInGB**: int: Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the the memory size. -* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root -* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload -* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version +* **activateDate**: string (ReadOnly): The activate date of certificate. +* **certVersion**: string: The certificate version of key vault. +* **dnsNames**: string[] (ReadOnly): The domain list of certificate. +* **expirationDate**: string (ReadOnly): The expiration date of certificate. +* **issuedDate**: string (ReadOnly): The issue date of certificate. +* **issuer**: string (ReadOnly): The issuer of certificate. +* **keyVaultCertName**: string (Required): The certificate name of key vault. +* **subjectName**: string (ReadOnly): The subject name of certificate. +* **thumbprint**: string (ReadOnly): The thumbprint of certificate. +* **vaultUri**: string (Required): The vault uri of user key vault. -## DeploymentSettingsEnvironmentVariables +## ClusterResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload +* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service +* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource +* **version**: int (ReadOnly): Version of the Service -## ResourceRequests +## ConfigServerGitProperty ### Properties -* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. -* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. +* **hostKey**: string: Public sshKey of git repository. +* **hostKeyAlgorithm**: string: SshKey algorithm of git repository. +* **label**: string: Label of the repository +* **password**: string: Password of git repository basic auth. +* **privateKey**: string: Private sshKey algorithm of git repository. +* **repositories**: [GitPatternRepository](#gitpatternrepository)[]: Repositories of git. +* **searchPaths**: string[]: Searching path of the repository +* **strictHostKeyChecking**: bool: Strict host key checking or not. +* **uri**: string (Required): URI of the repository +* **username**: string: Username of git repository basic auth. -## DeploymentInstance +## ConfigServerProperties ### Properties -* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance -* **name**: string (ReadOnly): Name of the deployment instance -* **reason**: string (ReadOnly): Failed reason of the deployment instance -* **startTime**: string (ReadOnly): Start time of the deployment instance -* **status**: string (ReadOnly): Status of the deployment instance +* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. +* **error**: [Error](#error): The error code compose of code and message. +* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. -## UserSourceInfo +## ConfigServerSettings ### Properties -* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be -the relative path to the target module/project. -* **customContainer**: [CustomContainer](#customcontainer): Custom container payload -* **relativePath**: string: Relative path of the storage which stores the source -* **type**: 'Container' | 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded -* **version**: string: Version of the source +* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. ## CustomContainer ### Properties @@ -225,52 +167,50 @@ the relative path to the target module/project. * **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry * **server**: string: The name of the registry that contains the container image -## ImageRegistryCredential -### Properties -* **password**: string: The password of the image registry credential -* **username**: string: The username of the image registry credential - ## CustomDomainProperties ### Properties * **appName**: string (ReadOnly): The app name of domain. * **certName**: string: The bound certificate name of domain. * **thumbprint**: string: The thumbprint of bound certificate. -## CertificateProperties +## DeploymentInstance ### Properties -* **activateDate**: string (ReadOnly): The activate date of certificate. -* **certVersion**: string: The certificate version of key vault. -* **dnsNames**: string[] (ReadOnly): The domain list of certificate. -* **expirationDate**: string (ReadOnly): The expiration date of certificate. -* **issuedDate**: string (ReadOnly): The issue date of certificate. -* **issuer**: string (ReadOnly): The issuer of certificate. -* **keyVaultCertName**: string (Required): The certificate name of key vault. -* **subjectName**: string (ReadOnly): The subject name of certificate. -* **thumbprint**: string (ReadOnly): The thumbprint of certificate. -* **vaultUri**: string (Required): The vault uri of user key vault. +* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance +* **name**: string (ReadOnly): Name of the deployment instance +* **reason**: string (ReadOnly): Failed reason of the deployment instance +* **startTime**: string (ReadOnly): Start time of the deployment instance +* **status**: string (ReadOnly): Status of the deployment instance -## ConfigServerProperties +## DeploymentResourceProperties ### Properties -* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. -* **error**: [Error](#error): The error code compose of code and message. -* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. +* **active**: bool (ReadOnly): Indicates whether the Deployment is active +* **appName**: string (ReadOnly): App name of the deployment +* **createdTime**: string (ReadOnly): Date time when the resource is created +* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload +* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment +* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment +* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment -## ConfigServerSettings +## DeploymentSettings ### Properties -* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. +* **cpu**: int: Required CPU. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the CPU size. +* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables +* **jvmOptions**: string: JVM parameter +* **memoryInGB**: int: Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the the memory size. +* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root +* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload +* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version -## ConfigServerGitProperty +## DeploymentSettingsEnvironmentVariables ### Properties -* **hostKey**: string: Public sshKey of git repository. -* **hostKeyAlgorithm**: string: SshKey algorithm of git repository. -* **label**: string: Label of the repository -* **password**: string: Password of git repository basic auth. -* **privateKey**: string: Private sshKey algorithm of git repository. -* **repositories**: [GitPatternRepository](#gitpatternrepository)[]: Repositories of git. -* **searchPaths**: string[]: Searching path of the repository -* **strictHostKeyChecking**: bool: Strict host key checking or not. -* **uri**: string (Required): URI of the repository -* **username**: string: Username of git repository basic auth. +### Additional Properties +* **Additional Properties Type**: string + +## Error +### Properties +* **code**: string: The code of error. +* **message**: string: The message of error. ## GitPatternRepository ### Properties @@ -286,10 +226,16 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## Error +## ImageRegistryCredential ### Properties -* **code**: string: The code of error. -* **message**: string: The message of error. +* **password**: string: The password of the image registry credential +* **username**: string: The username of the image registry credential + +## ManagedIdentityProperties +### Properties +* **principalId**: string: Principal Id +* **tenantId**: string: Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity ## MonitoringSettingProperties ### Properties @@ -300,9 +246,49 @@ the relative path to the target module/project. * **provisioningState**: 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Monitoring Setting. * **traceEnabled**: bool: Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not -## ApplicationInsightsAgentVersions +## NetworkProfile ### Properties -* **java**: string (ReadOnly): Indicates the version of application insight java agent +* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps +* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps +* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. +* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. +* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR +* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime +* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime + +## NetworkProfileOutboundIPs +### Properties +* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. + +## PersistentDisk +### Properties +* **mountPath**: string: Mount path of the persistent disk +* **sizeInGB**: int: Size of the persistent disk in GB +* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB + +## RequiredTraffic +### Properties +* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic +* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic +* **ips**: string[] (ReadOnly): The ip list of required traffic +* **port**: int (ReadOnly): The port of required traffic +* **protocol**: string (ReadOnly): The protocol of required traffic + +## ResourceRequests +### Properties +* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. +* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. + +## Sku +### Properties +* **capacity**: int: Current capacity of the target resource +* **name**: string: Name of the Sku +* **tier**: string: Tier of the Sku + +## TemporaryDisk +### Properties +* **mountPath**: string: Mount path of the temporary disk +* **sizeInGB**: int: Size of the temporary disk in GB ## TestKeys ### Properties @@ -312,3 +298,17 @@ the relative path to the target module/project. * **secondaryKey**: string (ReadOnly): Secondary key * **secondaryTestEndpoint**: string (ReadOnly): Secondary test endpoint +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserSourceInfo +### Properties +* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be +the relative path to the target module/project. +* **customContainer**: [CustomContainer](#customcontainer): Custom container payload +* **relativePath**: string: Relative path of the storage which stores the source +* **type**: 'Container' | 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded +* **version**: string: Version of the source + diff --git a/generated/appplatform/microsoft.appplatform/2021-09-01-preview/types.md b/generated/appplatform/microsoft.appplatform/2021-09-01-preview/types.md index 2c03ba7bd5..d1755d8487 100644 --- a/generated/appplatform/microsoft.appplatform/2021-09-01-preview/types.md +++ b/generated/appplatform/microsoft.appplatform/2021-09-01-preview/types.md @@ -93,52 +93,9 @@ * **ApiVersion**: 2021-09-01-preview * **Output**: [TestKeys](#testkeys) -## ClusterResourceProperties -### Properties -* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload -* **powerState**: 'Running' | 'Stopped' | string (ReadOnly): Power state of the Service -* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Starting' | 'Stopping' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service -* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource -* **version**: int (ReadOnly): Version of the Service - -## NetworkProfile -### Properties -* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps -* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps -* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. -* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. -* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR -* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime -* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime - -## NetworkProfileOutboundIPs -### Properties -* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. - -## RequiredTraffic -### Properties -* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic -* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic -* **ips**: string[] (ReadOnly): The ip list of required traffic -* **port**: int (ReadOnly): The port of required traffic -* **protocol**: string (ReadOnly): The protocol of required traffic - -## Sku -### Properties -* **capacity**: int: Current capacity of the target resource -* **name**: string: Name of the Sku -* **tier**: string: Tier of the Sku - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentityProperties +## ApplicationInsightsAgentVersions ### Properties -* **principalId**: string: Principal Id -* **tenantId**: string: Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity +* **java**: string (ReadOnly): Indicates the version of application insight java agent ## AppResourceProperties ### Properties @@ -155,40 +112,6 @@ * **temporaryDisk**: [TemporaryDisk](#temporarydisk): Temporary disk payload * **url**: string (ReadOnly): URL of the App -## CustomPersistentDiskResource -### Properties -* **customPersistentDiskProperties**: [CustomPersistentDiskProperties](#custompersistentdiskproperties): Custom persistent disk resource payload. -* **storageId**: string (Required): The resource id of Azure Spring Cloud Storage resource. - -## CustomPersistentDiskProperties -* **Discriminator**: type - -### Base Properties -* **mountOptions**: string[]: These are the mount options for a persistent disk. -* **mountPath**: string (Required): The mount path of the persistent disk. -* **readOnly**: bool: Indicates whether the persistent disk is a readOnly one. -### AzureFileVolume -#### Properties -* **shareName**: string (Required): The share name of the Azure File share. -* **type**: 'AzureFileVolume' (Required): The type of the underlying resource to mount as a persistent disk. - - -## LoadedCertificate -### Properties -* **loadTrustStore**: bool: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. -* **resourceId**: string (Required): Resource Id of loaded certificate - -## PersistentDisk -### Properties -* **mountPath**: string: Mount path of the persistent disk -* **sizeInGB**: int: Size of the persistent disk in GB -* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB - -## TemporaryDisk -### Properties -* **mountPath**: string: Mount path of the temporary disk -* **sizeInGB**: int: Size of the temporary disk in GB - ## BindingResourceProperties ### Properties * **bindingParameters**: [BindingResourcePropertiesBindingParameters](#bindingresourcepropertiesbindingparameters): Binding parameters of the Binding resource @@ -205,78 +128,6 @@ ### Additional Properties * **Additional Properties Type**: any -## DeploymentResourceProperties -### Properties -* **active**: bool (ReadOnly): Indicates whether the Deployment is active -* **appName**: string (ReadOnly): App name of the deployment -* **createdTime**: string (ReadOnly): Date time when the resource is created -* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload -* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment -* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment -* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment - -## DeploymentSettings -### Properties -* **containerProbeSettings**: [DeploymentSettingsContainerProbeSettings](#deploymentsettingscontainerprobesettings): Container liveness and readiness probe settings -* **cpu**: int: Required CPU. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-09-01-preview. Please use the resourceRequests field to set the CPU size. -* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables -* **jvmOptions**: string: JVM parameter -* **memoryInGB**: int: Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-09-01-preview. Please use the resourceRequests field to set the the memory size. -* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root -* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload -* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version - -## DeploymentSettingsContainerProbeSettings -### Properties -* **disableProbe**: bool: Indicates whether disable the liveness and readiness probe - -## DeploymentSettingsEnvironmentVariables -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceRequests -### Properties -* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. -* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. - -## DeploymentInstance -### Properties -* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance -* **name**: string (ReadOnly): Name of the deployment instance -* **reason**: string (ReadOnly): Failed reason of the deployment instance -* **startTime**: string (ReadOnly): Start time of the deployment instance -* **status**: string (ReadOnly): Status of the deployment instance - -## UserSourceInfo -### Properties -* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be -the relative path to the target module/project. -* **customContainer**: [CustomContainer](#customcontainer): Custom container payload -* **relativePath**: string: Relative path of the storage which stores the source -* **type**: 'Container' | 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded -* **version**: string: Version of the source - -## CustomContainer -### Properties -* **args**: string[]: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. -* **command**: string[]: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. -* **containerImage**: string: Container image of the custom container. This should be in the form of : without the server name of the registry -* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry -* **server**: string: The name of the registry that contains the container image - -## ImageRegistryCredential -### Properties -* **password**: string: The password of the image registry credential -* **username**: string: The username of the image registry credential - -## CustomDomainProperties -### Properties -* **appName**: string (ReadOnly): The app name of domain. -* **certName**: string: The bound certificate name of domain. -* **thumbprint**: string: The thumbprint of bound certificate. - ## CertificateProperties * **Discriminator**: type @@ -302,15 +153,13 @@ the relative path to the target module/project. * **vaultUri**: string (Required): The vault uri of user key vault. -## ConfigServerProperties -### Properties -* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. -* **error**: [Error](#error): The error code compose of code and message. -* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. - -## ConfigServerSettings +## ClusterResourceProperties ### Properties -* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. +* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload +* **powerState**: 'Running' | 'Stopped' | string (ReadOnly): Power state of the Service +* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Starting' | 'Stopping' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service +* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource +* **version**: int (ReadOnly): Version of the Service ## ConfigServerGitProperty ### Properties @@ -325,6 +174,92 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. +## ConfigServerProperties +### Properties +* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. +* **error**: [Error](#error): The error code compose of code and message. +* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. + +## ConfigServerSettings +### Properties +* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. + +## CustomContainer +### Properties +* **args**: string[]: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. +* **command**: string[]: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. +* **containerImage**: string: Container image of the custom container. This should be in the form of : without the server name of the registry +* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry +* **server**: string: The name of the registry that contains the container image + +## CustomDomainProperties +### Properties +* **appName**: string (ReadOnly): The app name of domain. +* **certName**: string: The bound certificate name of domain. +* **thumbprint**: string: The thumbprint of bound certificate. + +## CustomPersistentDiskProperties +* **Discriminator**: type + +### Base Properties +* **mountOptions**: string[]: These are the mount options for a persistent disk. +* **mountPath**: string (Required): The mount path of the persistent disk. +* **readOnly**: bool: Indicates whether the persistent disk is a readOnly one. +### AzureFileVolume +#### Properties +* **shareName**: string (Required): The share name of the Azure File share. +* **type**: 'AzureFileVolume' (Required): The type of the underlying resource to mount as a persistent disk. + + +## CustomPersistentDiskResource +### Properties +* **customPersistentDiskProperties**: [CustomPersistentDiskProperties](#custompersistentdiskproperties): Custom persistent disk resource payload. +* **storageId**: string (Required): The resource id of Azure Spring Cloud Storage resource. + +## DeploymentInstance +### Properties +* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance +* **name**: string (ReadOnly): Name of the deployment instance +* **reason**: string (ReadOnly): Failed reason of the deployment instance +* **startTime**: string (ReadOnly): Start time of the deployment instance +* **status**: string (ReadOnly): Status of the deployment instance + +## DeploymentResourceProperties +### Properties +* **active**: bool (ReadOnly): Indicates whether the Deployment is active +* **appName**: string (ReadOnly): App name of the deployment +* **createdTime**: string (ReadOnly): Date time when the resource is created +* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload +* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment +* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment +* **status**: 'Allocating' | 'Compiling' | 'Failed' | 'Running' | 'Stopped' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the Deployment + +## DeploymentSettings +### Properties +* **containerProbeSettings**: [DeploymentSettingsContainerProbeSettings](#deploymentsettingscontainerprobesettings): Container liveness and readiness probe settings +* **cpu**: int: Required CPU. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-09-01-preview. Please use the resourceRequests field to set the CPU size. +* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables +* **jvmOptions**: string: JVM parameter +* **memoryInGB**: int: Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-09-01-preview. Please use the resourceRequests field to set the the memory size. +* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root +* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload +* **runtimeVersion**: 'Java_11' | 'Java_8' | 'NetCore_31' | string: Runtime version + +## DeploymentSettingsContainerProbeSettings +### Properties +* **disableProbe**: bool: Indicates whether disable the liveness and readiness probe + +## DeploymentSettingsEnvironmentVariables +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Error +### Properties +* **code**: string: The code of error. +* **message**: string: The message of error. + ## GitPatternRepository ### Properties * **hostKey**: string: Public sshKey of git repository. @@ -339,10 +274,21 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## Error +## ImageRegistryCredential ### Properties -* **code**: string: The code of error. -* **message**: string: The message of error. +* **password**: string: The password of the image registry credential +* **username**: string: The username of the image registry credential + +## LoadedCertificate +### Properties +* **loadTrustStore**: bool: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. +* **resourceId**: string (Required): Resource Id of loaded certificate + +## ManagedIdentityProperties +### Properties +* **principalId**: string: Principal Id +* **tenantId**: string: Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity ## MonitoringSettingProperties ### Properties @@ -353,9 +299,44 @@ the relative path to the target module/project. * **provisioningState**: 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Monitoring Setting. * **traceEnabled**: bool: Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not -## ApplicationInsightsAgentVersions +## NetworkProfile ### Properties -* **java**: string (ReadOnly): Indicates the version of application insight java agent +* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps +* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps +* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. +* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. +* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR +* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime +* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime + +## NetworkProfileOutboundIPs +### Properties +* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. + +## PersistentDisk +### Properties +* **mountPath**: string: Mount path of the persistent disk +* **sizeInGB**: int: Size of the persistent disk in GB +* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB + +## RequiredTraffic +### Properties +* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic +* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic +* **ips**: string[] (ReadOnly): The ip list of required traffic +* **port**: int (ReadOnly): The port of required traffic +* **protocol**: string (ReadOnly): The protocol of required traffic + +## ResourceRequests +### Properties +* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. +* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. + +## Sku +### Properties +* **capacity**: int: Current capacity of the target resource +* **name**: string: Name of the Sku +* **tier**: string: Tier of the Sku ## StorageProperties * **Discriminator**: storageType @@ -377,6 +358,11 @@ the relative path to the target module/project. * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TemporaryDisk +### Properties +* **mountPath**: string: Mount path of the temporary disk +* **sizeInGB**: int: Size of the temporary disk in GB + ## TestKeys ### Properties * **enabled**: bool (ReadOnly): Indicates whether the test endpoint feature enabled or not @@ -385,3 +371,17 @@ the relative path to the target module/project. * **secondaryKey**: string (ReadOnly): Secondary key * **secondaryTestEndpoint**: string (ReadOnly): Secondary test endpoint +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserSourceInfo +### Properties +* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be +the relative path to the target module/project. +* **customContainer**: [CustomContainer](#customcontainer): Custom container payload +* **relativePath**: string: Relative path of the storage which stores the source +* **type**: 'Container' | 'Jar' | 'NetCoreZip' | 'Source' | string: Type of the source uploaded +* **version**: string: Version of the source + diff --git a/generated/appplatform/microsoft.appplatform/2022-01-01-preview/types.md b/generated/appplatform/microsoft.appplatform/2022-01-01-preview/types.md index 1af2113213..3d15374ed0 100644 --- a/generated/appplatform/microsoft.appplatform/2022-01-01-preview/types.md +++ b/generated/appplatform/microsoft.appplatform/2022-01-01-preview/types.md @@ -213,57 +213,24 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [TestKeys](#testkeys) -## ClusterResourceProperties -### Properties -* **fqdn**: string (ReadOnly): Fully qualified dns name of the service instance -* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload -* **powerState**: 'Running' | 'Stopped' | string (ReadOnly): Power state of the Service -* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Starting' | 'Stopping' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service -* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource -* **version**: int (ReadOnly): Version of the Service -* **zoneRedundant**: bool - -## NetworkProfile -### Properties -* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps -* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps -* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. -* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. -* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR -* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime -* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime - -## NetworkProfileOutboundIPs -### Properties -* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. - -## RequiredTraffic +## AddonProfile ### Properties -* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic -* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic -* **ips**: string[] (ReadOnly): The ip list of required traffic -* **port**: int (ReadOnly): The port of required traffic -* **protocol**: string (ReadOnly): The protocol of required traffic +### Additional Properties +* **Additional Properties Type**: any -## Sku +## AddonProfile ### Properties -* **capacity**: int: Current capacity of the target resource -* **name**: string: Name of the Sku -* **tier**: string: Tier of the Sku +### Additional Properties +* **Additional Properties Type**: any -## SystemData +## ApiPortalCustomDomainProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **thumbprint**: string: The thumbprint of bound certificate. -## TrackedResourceTags +## ApiPortalInstance ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): Name of the API portal instance +* **status**: string (ReadOnly): Status of the API portal instance ## ApiPortalProperties ### Properties @@ -277,32 +244,14 @@ * **ssoProperties**: [SsoProperties](#ssoproperties): Single sign-on related configuration * **url**: string (ReadOnly): URL of the API portal, exposed when 'public' is true. -## ApiPortalInstance -### Properties -* **name**: string (ReadOnly): Name of the API portal instance -* **status**: string (ReadOnly): Status of the API portal instance - ## ApiPortalResourceRequests ### Properties * **cpu**: string (ReadOnly): Cpu allocated to each API portal instance * **memory**: string (ReadOnly): Memory allocated to each API portal instance -## SsoProperties -### Properties -* **clientId**: string: The public identifier for the application -* **clientSecret**: string: The secret known only to the application and the authorization server -* **issuerUri**: string: The URI of Issuer Identifier -* **scope**: string[]: It defines the specific actions applications can be allowed to do on a user's behalf - -## ApiPortalCustomDomainProperties -### Properties -* **thumbprint**: string: The thumbprint of bound certificate. - -## ManagedIdentityProperties +## ApplicationInsightsAgentVersions ### Properties -* **principalId**: string: Principal Id -* **tenantId**: string: Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity +* **java**: string (ReadOnly): Indicates the version of application insight java agent ## AppResourceProperties ### Properties @@ -323,45 +272,6 @@ ### Additional Properties * **Additional Properties Type**: [AddonProfile](#addonprofile) -## AddonProfile -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## CustomPersistentDiskResource -### Properties -* **customPersistentDiskProperties**: [CustomPersistentDiskProperties](#custompersistentdiskproperties): Custom persistent disk resource payload. -* **storageId**: string (Required): The resource id of Azure Spring Cloud Storage resource. - -## CustomPersistentDiskProperties -* **Discriminator**: type - -### Base Properties -* **mountOptions**: string[]: These are the mount options for a persistent disk. -* **mountPath**: string (Required): The mount path of the persistent disk. -* **readOnly**: bool: Indicates whether the persistent disk is a readOnly one. -### AzureFileVolume -#### Properties -* **shareName**: string (Required): The share name of the Azure File share. -* **type**: 'AzureFileVolume' (Required): The type of the underlying resource to mount as a persistent disk. - - -## LoadedCertificate -### Properties -* **loadTrustStore**: bool: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. -* **resourceId**: string (Required): Resource Id of loaded certificate - -## PersistentDisk -### Properties -* **mountPath**: string: Mount path of the persistent disk -* **sizeInGB**: int: Size of the persistent disk in GB -* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB - -## TemporaryDisk -### Properties -* **mountPath**: string: Mount path of the temporary disk -* **sizeInGB**: int: Size of the temporary disk in GB - ## BindingResourceProperties ### Properties * **bindingParameters**: [BindingResourcePropertiesBindingParameters](#bindingresourcepropertiesbindingparameters): Binding parameters of the Binding resource @@ -378,139 +288,26 @@ ### Additional Properties * **Additional Properties Type**: any -## DeploymentResourceProperties -### Properties -* **active**: bool: Indicates whether the Deployment is active -* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload -* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment -* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment -* **status**: 'Running' | 'Stopped' | string (ReadOnly): Status of the Deployment - -## DeploymentSettings -### Properties -* **addonConfigs**: [DeploymentSettingsAddonConfigs](#deploymentsettingsaddonconfigs): Collection of addons -* **containerProbeSettings**: [ContainerProbeSettings](#containerprobesettings): Container liveness and readiness probe settings -* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables -* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload - -## DeploymentSettingsAddonConfigs -### Properties -### Additional Properties -* **Additional Properties Type**: [AddonProfile](#addonprofile) - -## AddonProfile -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## ContainerProbeSettings -### Properties -* **disableProbe**: bool: Indicates whether disable the liveness and readiness probe - -## DeploymentSettingsEnvironmentVariables -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceRequests -### Properties -* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. -* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. - -## DeploymentInstance -### Properties -* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance -* **name**: string (ReadOnly): Name of the deployment instance -* **reason**: string (ReadOnly): Failed reason of the deployment instance -* **startTime**: string (ReadOnly): Start time of the deployment instance -* **status**: string (ReadOnly): Status of the deployment instance -* **zone**: string (ReadOnly): Availability zone information of the deployment instance - -## UserSourceInfo -* **Discriminator**: type - -### Base Properties -* **version**: string: Version of the source -### BuildResultUserSourceInfo -#### Properties -* **buildResultId**: string: Resource id of an existing succeeded build result under the same Spring instance. -* **type**: 'BuildResult' (Required): Type of the source uploaded - -### CustomContainerUserSourceInfo -#### Properties -* **customContainer**: [CustomContainer](#customcontainer): Custom container payload -* **type**: 'Container' (Required): Type of the source uploaded - -### JarUploadedUserSourceInfo -#### Properties -* **jvmOptions**: string: JVM parameter -* **runtimeVersion**: string: Runtime version of the Jar file -* **type**: 'Jar' (Required): Type of the source uploaded - -### NetCoreZipUploadedUserSourceInfo -#### Properties -* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root -* **runtimeVersion**: string: Runtime version of the .Net file -* **type**: 'NetCoreZip' (Required): Type of the source uploaded - -### SourceUploadedUserSourceInfo -#### Properties -* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be -the relative path to the target module/project. -* **runtimeVersion**: string: Runtime version of the source file -* **type**: 'Source' (Required): Type of the source uploaded - - -## CustomContainer -### Properties -* **args**: string[]: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. -* **command**: string[]: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. -* **containerImage**: string: Container image of the custom container. This should be in the form of : without the server name of the registry -* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry -* **server**: string: The name of the registry that contains the container image - -## ImageRegistryCredential -### Properties -* **password**: string: The password of the image registry credential -* **username**: string: The username of the image registry credential - -## CustomDomainProperties -### Properties -* **appName**: string (ReadOnly): The app name of domain. -* **certName**: string: The bound certificate name of domain. -* **thumbprint**: string: The thumbprint of bound certificate. - -## BuildServiceAgentPoolProperties -### Properties -* **poolSize**: [BuildServiceAgentPoolSizeProperties](#buildserviceagentpoolsizeproperties): Build service agent pool size properties -* **provisioningState**: string (ReadOnly): Provisioning state of the build service agent pool - -## BuildServiceAgentPoolSizeProperties -### Properties -* **cpu**: string (ReadOnly): The cpu property of build service agent pool size -* **memory**: string (ReadOnly): The memory property of build service agent pool size -* **name**: string: The name of build service agent pool size - ## BuilderProperties ### Properties * **buildpackGroups**: [BuildpacksGroupProperties](#buildpacksgroupproperties)[]: Builder buildpack groups. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Builder provision status. * **stack**: [StackProperties](#stackproperties): KPack ClusterStack properties payload -## BuildpacksGroupProperties +## BuildpackBindingLaunchProperties ### Properties -* **buildpacks**: [BuildpackProperties](#buildpackproperties)[]: Buildpacks in the buildpack group -* **name**: string: Buildpack group name +* **properties**: [BuildpackBindingLaunchProperties](#buildpackbindinglaunchproperties): Non-sensitive properties for launchProperties +* **secrets**: [BuildpackBindingLaunchPropertiesSecrets](#buildpackbindinglaunchpropertiessecrets): Sensitive properties for launchProperties -## BuildpackProperties +## BuildpackBindingLaunchProperties ### Properties -* **id**: string: Id of the buildpack +### Additional Properties +* **Additional Properties Type**: string -## StackProperties +## BuildpackBindingLaunchPropertiesSecrets ### Properties -* **id**: string: Id of the ClusterStack. -* **version**: string: Version of the ClusterStack +### Additional Properties +* **Additional Properties Type**: string ## BuildpackBindingProperties ### Properties @@ -518,20 +315,14 @@ the relative path to the target module/project. * **launchProperties**: [BuildpackBindingLaunchProperties](#buildpackbindinglaunchproperties): Buildpack Binding Launch Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Buildpack Binding. -## BuildpackBindingLaunchProperties -### Properties -* **properties**: [BuildpackBindingLaunchProperties](#buildpackbindinglaunchproperties): Non-sensitive properties for launchProperties -* **secrets**: [BuildpackBindingLaunchPropertiesSecrets](#buildpackbindinglaunchpropertiessecrets): Sensitive properties for launchProperties - -## BuildpackBindingLaunchProperties +## BuildpackProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Id of the buildpack -## BuildpackBindingLaunchPropertiesSecrets +## BuildpacksGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **buildpacks**: [BuildpackProperties](#buildpackproperties)[]: Buildpacks in the buildpack group +* **name**: string: Buildpack group name ## BuildProperties ### Properties @@ -547,9 +338,16 @@ the relative path to the target module/project. ### Additional Properties * **Additional Properties Type**: string -## TriggeredBuildResult +## BuildServiceAgentPoolProperties ### Properties -* **id**: string: The unique build id of this build result +* **poolSize**: [BuildServiceAgentPoolSizeProperties](#buildserviceagentpoolsizeproperties): Build service agent pool size properties +* **provisioningState**: string (ReadOnly): Provisioning state of the build service agent pool + +## BuildServiceAgentPoolSizeProperties +### Properties +* **cpu**: string (ReadOnly): The cpu property of build service agent pool size +* **memory**: string (ReadOnly): The memory property of build service agent pool size +* **name**: string: The name of build service agent pool size ## CertificateProperties * **Discriminator**: type @@ -576,15 +374,15 @@ the relative path to the target module/project. * **vaultUri**: string (Required): The vault uri of user key vault. -## ConfigServerProperties -### Properties -* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. -* **error**: [Error](#error): The error code compose of code and message. -* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. - -## ConfigServerSettings +## ClusterResourceProperties ### Properties -* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. +* **fqdn**: string (ReadOnly): Fully qualified dns name of the service instance +* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload +* **powerState**: 'Running' | 'Stopped' | string (ReadOnly): Power state of the Service +* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Starting' | 'Stopping' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service +* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource +* **version**: int (ReadOnly): Version of the Service +* **zoneRedundant**: bool ## ConfigServerGitProperty ### Properties @@ -599,77 +397,131 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## GitPatternRepository +## ConfigServerProperties +### Properties +* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. +* **error**: [Error](#error): The error code compose of code and message. +* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. + +## ConfigServerSettings +### Properties +* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. + +## ConfigurationServiceGitProperty +### Properties +* **repositories**: [ConfigurationServiceGitRepository](#configurationservicegitrepository)[]: Repositories of Application Configuration Service git property. + +## ConfigurationServiceGitRepository ### Properties * **hostKey**: string: Public sshKey of git repository. * **hostKeyAlgorithm**: string: SshKey algorithm of git repository. -* **label**: string: Label of the repository +* **label**: string (Required): Label of the repository * **name**: string (Required): Name of the repository * **password**: string: Password of git repository basic auth. -* **pattern**: string[]: Collection of pattern of the repository +* **patterns**: string[] (Required): Collection of patterns of the repository * **privateKey**: string: Private sshKey algorithm of git repository. * **searchPaths**: string[]: Searching path of the repository * **strictHostKeyChecking**: bool: Strict host key checking or not. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## Error +## ConfigurationServiceInstance ### Properties -* **code**: string: The code of error. -* **message**: string: The message of error. +* **name**: string (ReadOnly): Name of the Application Configuration Service instance +* **status**: string (ReadOnly): Status of the Application Configuration Service instance ## ConfigurationServiceProperties ### Properties -* **instances**: [ConfigurationServiceInstance](#configurationserviceinstance)[] (ReadOnly): Collection of instances belong to Application Configuration Service. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Application Configuration Service. -* **resourceRequests**: [ConfigurationServiceResourceRequests](#configurationserviceresourcerequests) (ReadOnly): Resource request payload of Application Configuration Service -* **settings**: [ConfigurationServiceSettings](#configurationservicesettings): The settings of Application Configuration Service. +* **instances**: [ConfigurationServiceInstance](#configurationserviceinstance)[] (ReadOnly): Collection of instances belong to Application Configuration Service. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Application Configuration Service. +* **resourceRequests**: [ConfigurationServiceResourceRequests](#configurationserviceresourcerequests) (ReadOnly): Resource request payload of Application Configuration Service +* **settings**: [ConfigurationServiceSettings](#configurationservicesettings): The settings of Application Configuration Service. + +## ConfigurationServiceResourceRequests +### Properties +* **cpu**: string (ReadOnly): Cpu allocated to each Application Configuration Service instance +* **instanceCount**: int (ReadOnly): Instance count of the Application Configuration Service +* **memory**: string (ReadOnly): Memory allocated to each Application Configuration Service instance + +## ConfigurationServiceSettings +### Properties +* **gitProperty**: [ConfigurationServiceGitProperty](#configurationservicegitproperty): Property of git environment. + +## ContainerProbeSettings +### Properties +* **disableProbe**: bool: Indicates whether disable the liveness and readiness probe + +## CustomContainer +### Properties +* **args**: string[]: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. +* **command**: string[]: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. +* **containerImage**: string: Container image of the custom container. This should be in the form of : without the server name of the registry +* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry +* **server**: string: The name of the registry that contains the container image + +## CustomDomainProperties +### Properties +* **appName**: string (ReadOnly): The app name of domain. +* **certName**: string: The bound certificate name of domain. +* **thumbprint**: string: The thumbprint of bound certificate. + +## CustomPersistentDiskProperties +* **Discriminator**: type + +### Base Properties +* **mountOptions**: string[]: These are the mount options for a persistent disk. +* **mountPath**: string (Required): The mount path of the persistent disk. +* **readOnly**: bool: Indicates whether the persistent disk is a readOnly one. +### AzureFileVolume +#### Properties +* **shareName**: string (Required): The share name of the Azure File share. +* **type**: 'AzureFileVolume' (Required): The type of the underlying resource to mount as a persistent disk. + + +## CustomPersistentDiskResource +### Properties +* **customPersistentDiskProperties**: [CustomPersistentDiskProperties](#custompersistentdiskproperties): Custom persistent disk resource payload. +* **storageId**: string (Required): The resource id of Azure Spring Cloud Storage resource. -## ConfigurationServiceInstance +## DeploymentInstance ### Properties -* **name**: string (ReadOnly): Name of the Application Configuration Service instance -* **status**: string (ReadOnly): Status of the Application Configuration Service instance +* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance +* **name**: string (ReadOnly): Name of the deployment instance +* **reason**: string (ReadOnly): Failed reason of the deployment instance +* **startTime**: string (ReadOnly): Start time of the deployment instance +* **status**: string (ReadOnly): Status of the deployment instance +* **zone**: string (ReadOnly): Availability zone information of the deployment instance -## ConfigurationServiceResourceRequests +## DeploymentResourceProperties ### Properties -* **cpu**: string (ReadOnly): Cpu allocated to each Application Configuration Service instance -* **instanceCount**: int (ReadOnly): Instance count of the Application Configuration Service -* **memory**: string (ReadOnly): Memory allocated to each Application Configuration Service instance +* **active**: bool: Indicates whether the Deployment is active +* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload +* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment +* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment +* **status**: 'Running' | 'Stopped' | string (ReadOnly): Status of the Deployment -## ConfigurationServiceSettings +## DeploymentSettings ### Properties -* **gitProperty**: [ConfigurationServiceGitProperty](#configurationservicegitproperty): Property of git environment. +* **addonConfigs**: [DeploymentSettingsAddonConfigs](#deploymentsettingsaddonconfigs): Collection of addons +* **containerProbeSettings**: [ContainerProbeSettings](#containerprobesettings): Container liveness and readiness probe settings +* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables +* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload -## ConfigurationServiceGitProperty +## DeploymentSettingsAddonConfigs ### Properties -* **repositories**: [ConfigurationServiceGitRepository](#configurationservicegitrepository)[]: Repositories of Application Configuration Service git property. +### Additional Properties +* **Additional Properties Type**: [AddonProfile](#addonprofile) -## ConfigurationServiceGitRepository +## DeploymentSettingsEnvironmentVariables ### Properties -* **hostKey**: string: Public sshKey of git repository. -* **hostKeyAlgorithm**: string: SshKey algorithm of git repository. -* **label**: string (Required): Label of the repository -* **name**: string (Required): Name of the repository -* **password**: string: Password of git repository basic auth. -* **patterns**: string[] (Required): Collection of patterns of the repository -* **privateKey**: string: Private sshKey algorithm of git repository. -* **searchPaths**: string[]: Searching path of the repository -* **strictHostKeyChecking**: bool: Strict host key checking or not. -* **uri**: string (Required): URI of the repository -* **username**: string: Username of git repository basic auth. +### Additional Properties +* **Additional Properties Type**: string -## GatewayProperties +## Error ### Properties -* **apiMetadataProperties**: [GatewayApiMetadataProperties](#gatewayapimetadataproperties): API metadata property for Spring Cloud Gateway -* **corsProperties**: [GatewayCorsProperties](#gatewaycorsproperties): Cross-Origin Resource Sharing property -* **httpsOnly**: bool: Indicate if only https is allowed. -* **instances**: [GatewayInstance](#gatewayinstance)[] (ReadOnly): Collection of instances belong to Spring Cloud Gateway. -* **operatorProperties**: [GatewayOperatorProperties](#gatewayoperatorproperties) (ReadOnly): Properties of the Spring Cloud Gateway Operator. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Spring Cloud Gateway. -* **public**: bool: Indicates whether the Spring Cloud Gateway exposes endpoint. -* **resourceRequests**: [GatewayResourceRequests](#gatewayresourcerequests): Resource request payload of Spring Cloud Gateway. -* **ssoProperties**: [SsoProperties](#ssoproperties): Single sign-on related configuration -* **url**: string (ReadOnly): URL of the Spring Cloud Gateway, exposed when 'public' is true. +* **code**: string: The code of error. +* **message**: string: The message of error. ## GatewayApiMetadataProperties ### Properties @@ -679,6 +531,18 @@ the relative path to the target module/project. * **title**: string: Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`) * **version**: string: Version of APIs available on this Gateway instance (default: `unspecified`). +## GatewayApiRoute +### Properties +* **description**: string: A description, will be applied to methods in the generated OpenAPI documentation. +* **filters**: string[]: To modify the request before sending it to the target endpoint, or the received response. +* **order**: int: Route processing order. +* **predicates**: string[]: A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. +* **ssoEnabled**: bool: Enable sso validation. +* **tags**: string[]: Classification tags, will be applied to methods in the generated OpenAPI documentation. +* **title**: string: A title, will be applied to methods in the generated OpenAPI documentation. +* **tokenRelay**: bool: Pass currently-authenticated user's identity token to application service, default is 'false' +* **uri**: string: Full uri, will override `appName`. + ## GatewayCorsProperties ### Properties * **allowCredentials**: bool: Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`. @@ -688,6 +552,10 @@ the relative path to the target module/project. * **exposedHeaders**: string[]: HTTP response headers to expose for cross-site requests. * **maxAge**: int: How long, in seconds, the response from a pre-flight request can be cached by clients. +## GatewayCustomDomainProperties +### Properties +* **thumbprint**: string: The thumbprint of bound certificate. + ## GatewayInstance ### Properties * **name**: string (ReadOnly): Name of the Spring Cloud Gateway instance @@ -704,32 +572,59 @@ the relative path to the target module/project. * **instanceCount**: int (ReadOnly): Instance count of the Spring Cloud Gateway Operator. * **memory**: string (ReadOnly): Memory allocated to each Spring Cloud Gateway Operator instance. +## GatewayProperties +### Properties +* **apiMetadataProperties**: [GatewayApiMetadataProperties](#gatewayapimetadataproperties): API metadata property for Spring Cloud Gateway +* **corsProperties**: [GatewayCorsProperties](#gatewaycorsproperties): Cross-Origin Resource Sharing property +* **httpsOnly**: bool: Indicate if only https is allowed. +* **instances**: [GatewayInstance](#gatewayinstance)[] (ReadOnly): Collection of instances belong to Spring Cloud Gateway. +* **operatorProperties**: [GatewayOperatorProperties](#gatewayoperatorproperties) (ReadOnly): Properties of the Spring Cloud Gateway Operator. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Spring Cloud Gateway. +* **public**: bool: Indicates whether the Spring Cloud Gateway exposes endpoint. +* **resourceRequests**: [GatewayResourceRequests](#gatewayresourcerequests): Resource request payload of Spring Cloud Gateway. +* **ssoProperties**: [SsoProperties](#ssoproperties): Single sign-on related configuration +* **url**: string (ReadOnly): URL of the Spring Cloud Gateway, exposed when 'public' is true. + ## GatewayResourceRequests ### Properties * **cpu**: string: Cpu allocated to each Spring Cloud Gateway instance. * **memory**: string: Memory allocated to each Spring Cloud Gateway instance. -## GatewayCustomDomainProperties -### Properties -* **thumbprint**: string: The thumbprint of bound certificate. - ## GatewayRouteConfigProperties ### Properties * **appResourceId**: string: The resource Id of the Azure Spring Cloud app, required unless route defines `uri`. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Spring Cloud Gateway. * **routes**: [GatewayApiRoute](#gatewayapiroute)[]: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`. -## GatewayApiRoute +## GitPatternRepository ### Properties -* **description**: string: A description, will be applied to methods in the generated OpenAPI documentation. -* **filters**: string[]: To modify the request before sending it to the target endpoint, or the received response. -* **order**: int: Route processing order. -* **predicates**: string[]: A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. -* **ssoEnabled**: bool: Enable sso validation. -* **tags**: string[]: Classification tags, will be applied to methods in the generated OpenAPI documentation. -* **title**: string: A title, will be applied to methods in the generated OpenAPI documentation. -* **tokenRelay**: bool: Pass currently-authenticated user's identity token to application service, default is 'false' -* **uri**: string: Full uri, will override `appName`. +* **hostKey**: string: Public sshKey of git repository. +* **hostKeyAlgorithm**: string: SshKey algorithm of git repository. +* **label**: string: Label of the repository +* **name**: string (Required): Name of the repository +* **password**: string: Password of git repository basic auth. +* **pattern**: string[]: Collection of pattern of the repository +* **privateKey**: string: Private sshKey algorithm of git repository. +* **searchPaths**: string[]: Searching path of the repository +* **strictHostKeyChecking**: bool: Strict host key checking or not. +* **uri**: string (Required): URI of the repository +* **username**: string: Username of git repository basic auth. + +## ImageRegistryCredential +### Properties +* **password**: string: The password of the image registry credential +* **username**: string: The username of the image registry credential + +## LoadedCertificate +### Properties +* **loadTrustStore**: bool: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. +* **resourceId**: string (Required): Resource Id of loaded certificate + +## ManagedIdentityProperties +### Properties +* **principalId**: string: Principal Id +* **tenantId**: string: Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity ## MonitoringSettingProperties ### Properties @@ -740,27 +635,74 @@ the relative path to the target module/project. * **provisioningState**: 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Monitoring Setting. * **traceEnabled**: bool: Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not -## ApplicationInsightsAgentVersions +## NetworkProfile ### Properties -* **java**: string (ReadOnly): Indicates the version of application insight java agent +* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps +* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps +* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. +* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. +* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR +* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime +* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime -## ServiceRegistryProperties +## NetworkProfileOutboundIPs ### Properties -* **instances**: [ServiceRegistryInstance](#serviceregistryinstance)[] (ReadOnly): Collection of instances belong to Service Registry. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Service Registry. -* **resourceRequests**: [ServiceRegistryResourceRequests](#serviceregistryresourcerequests) (ReadOnly): Resource request payload of Service Registry +* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. + +## PersistentDisk +### Properties +* **mountPath**: string: Mount path of the persistent disk +* **sizeInGB**: int: Size of the persistent disk in GB +* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB + +## RequiredTraffic +### Properties +* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic +* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic +* **ips**: string[] (ReadOnly): The ip list of required traffic +* **port**: int (ReadOnly): The port of required traffic +* **protocol**: string (ReadOnly): The protocol of required traffic + +## ResourceRequests +### Properties +* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. +* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. ## ServiceRegistryInstance ### Properties * **name**: string (ReadOnly): Name of the Service Registry instance * **status**: string (ReadOnly): Status of the Service Registry instance +## ServiceRegistryProperties +### Properties +* **instances**: [ServiceRegistryInstance](#serviceregistryinstance)[] (ReadOnly): Collection of instances belong to Service Registry. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Service Registry. +* **resourceRequests**: [ServiceRegistryResourceRequests](#serviceregistryresourcerequests) (ReadOnly): Resource request payload of Service Registry + ## ServiceRegistryResourceRequests ### Properties * **cpu**: string (ReadOnly): Cpu allocated to each Service Registry instance * **instanceCount**: int (ReadOnly): Instance count of the Service Registry * **memory**: string (ReadOnly): Memory allocated to each Service Registry instance +## Sku +### Properties +* **capacity**: int: Current capacity of the target resource +* **name**: string: Name of the Sku +* **tier**: string: Tier of the Sku + +## SsoProperties +### Properties +* **clientId**: string: The public identifier for the application +* **clientSecret**: string: The secret known only to the application and the authorization server +* **issuerUri**: string: The URI of Issuer Identifier +* **scope**: string[]: It defines the specific actions applications can be allowed to do on a user's behalf + +## StackProperties +### Properties +* **id**: string: Id of the ClusterStack. +* **version**: string: Version of the ClusterStack + ## StorageProperties * **Discriminator**: storageType @@ -772,6 +714,20 @@ the relative path to the target module/project. * **storageType**: 'StorageAccount' (Required): The type of the storage. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + +## TemporaryDisk +### Properties +* **mountPath**: string: Mount path of the temporary disk +* **sizeInGB**: int: Size of the temporary disk in GB + ## TestKeys ### Properties * **enabled**: bool (ReadOnly): Indicates whether the test endpoint feature enabled or not @@ -780,3 +736,47 @@ the relative path to the target module/project. * **secondaryKey**: string (ReadOnly): Secondary key * **secondaryTestEndpoint**: string (ReadOnly): Secondary test endpoint +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TriggeredBuildResult +### Properties +* **id**: string: The unique build id of this build result + +## UserSourceInfo +* **Discriminator**: type + +### Base Properties +* **version**: string: Version of the source +### BuildResultUserSourceInfo +#### Properties +* **buildResultId**: string: Resource id of an existing succeeded build result under the same Spring instance. +* **type**: 'BuildResult' (Required): Type of the source uploaded + +### CustomContainerUserSourceInfo +#### Properties +* **customContainer**: [CustomContainer](#customcontainer): Custom container payload +* **type**: 'Container' (Required): Type of the source uploaded + +### JarUploadedUserSourceInfo +#### Properties +* **jvmOptions**: string: JVM parameter +* **runtimeVersion**: string: Runtime version of the Jar file +* **type**: 'Jar' (Required): Type of the source uploaded + +### NetCoreZipUploadedUserSourceInfo +#### Properties +* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root +* **runtimeVersion**: string: Runtime version of the .Net file +* **type**: 'NetCoreZip' (Required): Type of the source uploaded + +### SourceUploadedUserSourceInfo +#### Properties +* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be +the relative path to the target module/project. +* **runtimeVersion**: string: Runtime version of the source file +* **type**: 'Source' (Required): Type of the source uploaded + + diff --git a/generated/appplatform/microsoft.appplatform/2022-03-01-preview/types.md b/generated/appplatform/microsoft.appplatform/2022-03-01-preview/types.md index 571e5d3201..41181bcdd5 100644 --- a/generated/appplatform/microsoft.appplatform/2022-03-01-preview/types.md +++ b/generated/appplatform/microsoft.appplatform/2022-03-01-preview/types.md @@ -213,57 +213,24 @@ * **ApiVersion**: 2022-03-01-preview * **Output**: [TestKeys](#testkeys) -## ClusterResourceProperties -### Properties -* **fqdn**: string (ReadOnly): Fully qualified dns name of the service instance -* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload -* **powerState**: 'Running' | 'Stopped' | string (ReadOnly): Power state of the Service -* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Starting' | 'Stopping' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service -* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource -* **version**: int (ReadOnly): Version of the Service -* **zoneRedundant**: bool - -## NetworkProfile -### Properties -* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps -* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps -* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. -* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. -* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR -* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime -* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime - -## NetworkProfileOutboundIPs -### Properties -* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. - -## RequiredTraffic +## AddonProfile ### Properties -* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic -* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic -* **ips**: string[] (ReadOnly): The ip list of required traffic -* **port**: int (ReadOnly): The port of required traffic -* **protocol**: string (ReadOnly): The protocol of required traffic +### Additional Properties +* **Additional Properties Type**: any -## Sku +## AddonProfile ### Properties -* **capacity**: int: Current capacity of the target resource -* **name**: string: Name of the Sku -* **tier**: string: Tier of the Sku +### Additional Properties +* **Additional Properties Type**: any -## SystemData +## ApiPortalCustomDomainProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **thumbprint**: string: The thumbprint of bound certificate. -## TrackedResourceTags +## ApiPortalInstance ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): Name of the API portal instance +* **status**: string (ReadOnly): Status of the API portal instance ## ApiPortalProperties ### Properties @@ -277,43 +244,14 @@ * **ssoProperties**: [SsoProperties](#ssoproperties): Single sign-on related configuration * **url**: string (ReadOnly): URL of the API portal, exposed when 'public' is true. -## ApiPortalInstance -### Properties -* **name**: string (ReadOnly): Name of the API portal instance -* **status**: string (ReadOnly): Status of the API portal instance - ## ApiPortalResourceRequests ### Properties * **cpu**: string (ReadOnly): Cpu allocated to each API portal instance * **memory**: string (ReadOnly): Memory allocated to each API portal instance -## SsoProperties -### Properties -* **clientId**: string: The public identifier for the application -* **clientSecret**: string: The secret known only to the application and the authorization server -* **issuerUri**: string: The URI of Issuer Identifier -* **scope**: string[]: It defines the specific actions applications can be allowed to do on a user's behalf - -## ApiPortalCustomDomainProperties -### Properties -* **thumbprint**: string: The thumbprint of bound certificate. - -## ManagedIdentityProperties -### Properties -* **principalId**: string: Principal Id of system-assigned managed identity. -* **tenantId**: string: Tenant Id of system-assigned managed identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): User-assigned managed identities in key-value map. The key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## UserAssignedManagedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) - -## UserAssignedManagedIdentity +## ApplicationInsightsAgentVersions ### Properties -* **clientId**: string (ReadOnly): Client Id of user-assigned managed identity. -* **principalId**: string (ReadOnly): Principal Id of user-assigned managed identity. +* **java**: string (ReadOnly): Indicates the version of application insight java agent ## AppResourceProperties ### Properties @@ -334,45 +272,6 @@ ### Additional Properties * **Additional Properties Type**: [AddonProfile](#addonprofile) -## AddonProfile -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## CustomPersistentDiskResource -### Properties -* **customPersistentDiskProperties**: [CustomPersistentDiskProperties](#custompersistentdiskproperties): Custom persistent disk resource payload. -* **storageId**: string (Required): The resource id of Azure Spring Cloud Storage resource. - -## CustomPersistentDiskProperties -* **Discriminator**: type - -### Base Properties -* **mountOptions**: string[]: These are the mount options for a persistent disk. -* **mountPath**: string (Required): The mount path of the persistent disk. -* **readOnly**: bool: Indicates whether the persistent disk is a readOnly one. -### AzureFileVolume -#### Properties -* **shareName**: string (Required): The share name of the Azure File share. -* **type**: 'AzureFileVolume' (Required): The type of the underlying resource to mount as a persistent disk. - - -## LoadedCertificate -### Properties -* **loadTrustStore**: bool: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. -* **resourceId**: string (Required): Resource Id of loaded certificate - -## PersistentDisk -### Properties -* **mountPath**: string: Mount path of the persistent disk -* **sizeInGB**: int: Size of the persistent disk in GB -* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB - -## TemporaryDisk -### Properties -* **mountPath**: string: Mount path of the temporary disk -* **sizeInGB**: int: Size of the temporary disk in GB - ## BindingResourceProperties ### Properties * **bindingParameters**: [BindingResourcePropertiesBindingParameters](#bindingresourcepropertiesbindingparameters): Binding parameters of the Binding resource @@ -389,140 +288,26 @@ ### Additional Properties * **Additional Properties Type**: any -## DeploymentResourceProperties -### Properties -* **active**: bool: Indicates whether the Deployment is active -* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload -* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment -* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment -* **status**: 'Running' | 'Stopped' | string (ReadOnly): Status of the Deployment - -## DeploymentSettings -### Properties -* **addonConfigs**: [DeploymentSettingsAddonConfigs](#deploymentsettingsaddonconfigs): Collection of addons -* **containerProbeSettings**: [ContainerProbeSettings](#containerprobesettings): Container liveness and readiness probe settings -* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables -* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload - -## DeploymentSettingsAddonConfigs -### Properties -### Additional Properties -* **Additional Properties Type**: [AddonProfile](#addonprofile) - -## AddonProfile -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## ContainerProbeSettings -### Properties -* **disableProbe**: bool: Indicates whether disable the liveness and readiness probe - -## DeploymentSettingsEnvironmentVariables -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceRequests -### Properties -* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. -* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. - -## DeploymentInstance -### Properties -* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance -* **name**: string (ReadOnly): Name of the deployment instance -* **reason**: string (ReadOnly): Failed reason of the deployment instance -* **startTime**: string (ReadOnly): Start time of the deployment instance -* **status**: string (ReadOnly): Status of the deployment instance -* **zone**: string (ReadOnly): Availability zone information of the deployment instance - -## UserSourceInfo -* **Discriminator**: type - -### Base Properties -* **version**: string: Version of the source -### BuildResultUserSourceInfo -#### Properties -* **buildResultId**: string: Resource id of an existing succeeded build result under the same Spring instance. -* **type**: 'BuildResult' (Required): Type of the source uploaded - -### CustomContainerUserSourceInfo -#### Properties -* **customContainer**: [CustomContainer](#customcontainer): Custom container payload -* **type**: 'Container' (Required): Type of the source uploaded - -### JarUploadedUserSourceInfo -#### Properties -* **jvmOptions**: string: JVM parameter -* **runtimeVersion**: string: Runtime version of the Jar file -* **type**: 'Jar' (Required): Type of the source uploaded - -### NetCoreZipUploadedUserSourceInfo -#### Properties -* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root -* **runtimeVersion**: string: Runtime version of the .Net file -* **type**: 'NetCoreZip' (Required): Type of the source uploaded - -### SourceUploadedUserSourceInfo -#### Properties -* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be -the relative path to the target module/project. -* **runtimeVersion**: string: Runtime version of the source file -* **type**: 'Source' (Required): Type of the source uploaded - - -## CustomContainer -### Properties -* **args**: string[]: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. -* **command**: string[]: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. -* **containerImage**: string: Container image of the custom container. This should be in the form of : without the server name of the registry -* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry -* **languageFramework**: string: Language framework of the container image uploaded -* **server**: string: The name of the registry that contains the container image - -## ImageRegistryCredential -### Properties -* **password**: string: The password of the image registry credential -* **username**: string: The username of the image registry credential - -## CustomDomainProperties -### Properties -* **appName**: string (ReadOnly): The app name of domain. -* **certName**: string: The bound certificate name of domain. -* **thumbprint**: string: The thumbprint of bound certificate. - -## BuildServiceAgentPoolProperties -### Properties -* **poolSize**: [BuildServiceAgentPoolSizeProperties](#buildserviceagentpoolsizeproperties): Build service agent pool size properties -* **provisioningState**: string (ReadOnly): Provisioning state of the build service agent pool - -## BuildServiceAgentPoolSizeProperties -### Properties -* **cpu**: string (ReadOnly): The cpu property of build service agent pool size -* **memory**: string (ReadOnly): The memory property of build service agent pool size -* **name**: string: The name of build service agent pool size - ## BuilderProperties ### Properties * **buildpackGroups**: [BuildpacksGroupProperties](#buildpacksgroupproperties)[]: Builder buildpack groups. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Builder provision status. * **stack**: [StackProperties](#stackproperties): KPack ClusterStack properties payload -## BuildpacksGroupProperties +## BuildpackBindingLaunchProperties ### Properties -* **buildpacks**: [BuildpackProperties](#buildpackproperties)[]: Buildpacks in the buildpack group -* **name**: string: Buildpack group name +* **properties**: [BuildpackBindingLaunchProperties](#buildpackbindinglaunchproperties): Non-sensitive properties for launchProperties +* **secrets**: [BuildpackBindingLaunchPropertiesSecrets](#buildpackbindinglaunchpropertiessecrets): Sensitive properties for launchProperties -## BuildpackProperties +## BuildpackBindingLaunchProperties ### Properties -* **id**: string: Id of the buildpack +### Additional Properties +* **Additional Properties Type**: string -## StackProperties +## BuildpackBindingLaunchPropertiesSecrets ### Properties -* **id**: string: Id of the ClusterStack. -* **version**: string: Version of the ClusterStack +### Additional Properties +* **Additional Properties Type**: string ## BuildpackBindingProperties ### Properties @@ -530,20 +315,14 @@ the relative path to the target module/project. * **launchProperties**: [BuildpackBindingLaunchProperties](#buildpackbindinglaunchproperties): Buildpack Binding Launch Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Buildpack Binding. -## BuildpackBindingLaunchProperties -### Properties -* **properties**: [BuildpackBindingLaunchProperties](#buildpackbindinglaunchproperties): Non-sensitive properties for launchProperties -* **secrets**: [BuildpackBindingLaunchPropertiesSecrets](#buildpackbindinglaunchpropertiessecrets): Sensitive properties for launchProperties - -## BuildpackBindingLaunchProperties +## BuildpackProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Id of the buildpack -## BuildpackBindingLaunchPropertiesSecrets +## BuildpacksGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **buildpacks**: [BuildpackProperties](#buildpackproperties)[]: Buildpacks in the buildpack group +* **name**: string: Buildpack group name ## BuildProperties ### Properties @@ -559,9 +338,16 @@ the relative path to the target module/project. ### Additional Properties * **Additional Properties Type**: string -## TriggeredBuildResult +## BuildServiceAgentPoolProperties ### Properties -* **id**: string: The unique build id of this build result +* **poolSize**: [BuildServiceAgentPoolSizeProperties](#buildserviceagentpoolsizeproperties): Build service agent pool size properties +* **provisioningState**: string (ReadOnly): Provisioning state of the build service agent pool + +## BuildServiceAgentPoolSizeProperties +### Properties +* **cpu**: string (ReadOnly): The cpu property of build service agent pool size +* **memory**: string (ReadOnly): The memory property of build service agent pool size +* **name**: string: The name of build service agent pool size ## CertificateProperties * **Discriminator**: type @@ -588,15 +374,15 @@ the relative path to the target module/project. * **vaultUri**: string (Required): The vault uri of user key vault. -## ConfigServerProperties -### Properties -* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. -* **error**: [Error](#error): The error code compose of code and message. -* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. - -## ConfigServerSettings +## ClusterResourceProperties ### Properties -* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. +* **fqdn**: string (ReadOnly): Fully qualified dns name of the service instance +* **networkProfile**: [NetworkProfile](#networkprofile): Service network profile payload +* **powerState**: 'Running' | 'Stopped' | string (ReadOnly): Power state of the Service +* **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MoveFailed' | 'Moved' | 'Moving' | 'Starting' | 'Stopping' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Service +* **serviceId**: string (ReadOnly): ServiceInstanceEntity GUID which uniquely identifies a created resource +* **version**: int (ReadOnly): Version of the Service +* **zoneRedundant**: bool ## ConfigServerGitProperty ### Properties @@ -611,24 +397,38 @@ the relative path to the target module/project. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## GitPatternRepository +## ConfigServerProperties +### Properties +* **configServer**: [ConfigServerSettings](#configserversettings): The settings of config server. +* **error**: [Error](#error): The error code compose of code and message. +* **provisioningState**: 'Deleted' | 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the config server. + +## ConfigServerSettings +### Properties +* **gitProperty**: [ConfigServerGitProperty](#configservergitproperty): Property of git. + +## ConfigurationServiceGitProperty +### Properties +* **repositories**: [ConfigurationServiceGitRepository](#configurationservicegitrepository)[]: Repositories of Application Configuration Service git property. + +## ConfigurationServiceGitRepository ### Properties * **hostKey**: string: Public sshKey of git repository. * **hostKeyAlgorithm**: string: SshKey algorithm of git repository. -* **label**: string: Label of the repository +* **label**: string (Required): Label of the repository * **name**: string (Required): Name of the repository * **password**: string: Password of git repository basic auth. -* **pattern**: string[]: Collection of pattern of the repository +* **patterns**: string[] (Required): Collection of patterns of the repository * **privateKey**: string: Private sshKey algorithm of git repository. * **searchPaths**: string[]: Searching path of the repository * **strictHostKeyChecking**: bool: Strict host key checking or not. * **uri**: string (Required): URI of the repository * **username**: string: Username of git repository basic auth. -## Error +## ConfigurationServiceInstance ### Properties -* **code**: string: The code of error. -* **message**: string: The message of error. +* **name**: string (ReadOnly): Name of the Application Configuration Service instance +* **status**: string (ReadOnly): Status of the Application Configuration Service instance ## ConfigurationServiceProperties ### Properties @@ -637,51 +437,92 @@ the relative path to the target module/project. * **resourceRequests**: [ConfigurationServiceResourceRequests](#configurationserviceresourcerequests) (ReadOnly): Resource request payload of Application Configuration Service * **settings**: [ConfigurationServiceSettings](#configurationservicesettings): The settings of Application Configuration Service. -## ConfigurationServiceInstance +## ConfigurationServiceResourceRequests ### Properties -* **name**: string (ReadOnly): Name of the Application Configuration Service instance -* **status**: string (ReadOnly): Status of the Application Configuration Service instance +* **cpu**: string (ReadOnly): Cpu allocated to each Application Configuration Service instance +* **instanceCount**: int (ReadOnly): Instance count of the Application Configuration Service +* **memory**: string (ReadOnly): Memory allocated to each Application Configuration Service instance + +## ConfigurationServiceSettings +### Properties +* **gitProperty**: [ConfigurationServiceGitProperty](#configurationservicegitproperty): Property of git environment. + +## ContainerProbeSettings +### Properties +* **disableProbe**: bool: Indicates whether disable the liveness and readiness probe + +## CustomContainer +### Properties +* **args**: string[]: Arguments to the entrypoint. The docker image's CMD is used if this is not provided. +* **command**: string[]: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. +* **containerImage**: string: Container image of the custom container. This should be in the form of : without the server name of the registry +* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Credential of the image registry +* **languageFramework**: string: Language framework of the container image uploaded +* **server**: string: The name of the registry that contains the container image + +## CustomDomainProperties +### Properties +* **appName**: string (ReadOnly): The app name of domain. +* **certName**: string: The bound certificate name of domain. +* **thumbprint**: string: The thumbprint of bound certificate. + +## CustomPersistentDiskProperties +* **Discriminator**: type + +### Base Properties +* **mountOptions**: string[]: These are the mount options for a persistent disk. +* **mountPath**: string (Required): The mount path of the persistent disk. +* **readOnly**: bool: Indicates whether the persistent disk is a readOnly one. +### AzureFileVolume +#### Properties +* **shareName**: string (Required): The share name of the Azure File share. +* **type**: 'AzureFileVolume' (Required): The type of the underlying resource to mount as a persistent disk. + + +## CustomPersistentDiskResource +### Properties +* **customPersistentDiskProperties**: [CustomPersistentDiskProperties](#custompersistentdiskproperties): Custom persistent disk resource payload. +* **storageId**: string (Required): The resource id of Azure Spring Cloud Storage resource. + +## DeploymentInstance +### Properties +* **discoveryStatus**: string (ReadOnly): Discovery status of the deployment instance +* **name**: string (ReadOnly): Name of the deployment instance +* **reason**: string (ReadOnly): Failed reason of the deployment instance +* **startTime**: string (ReadOnly): Start time of the deployment instance +* **status**: string (ReadOnly): Status of the deployment instance +* **zone**: string (ReadOnly): Availability zone information of the deployment instance -## ConfigurationServiceResourceRequests +## DeploymentResourceProperties ### Properties -* **cpu**: string (ReadOnly): Cpu allocated to each Application Configuration Service instance -* **instanceCount**: int (ReadOnly): Instance count of the Application Configuration Service -* **memory**: string (ReadOnly): Memory allocated to each Application Configuration Service instance +* **active**: bool: Indicates whether the Deployment is active +* **deploymentSettings**: [DeploymentSettings](#deploymentsettings): Deployment settings payload +* **instances**: [DeploymentInstance](#deploymentinstance)[] (ReadOnly): Collection of instances belong to the Deployment +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Deployment +* **source**: [UserSourceInfo](#usersourceinfo): Source information for a deployment +* **status**: 'Running' | 'Stopped' | string (ReadOnly): Status of the Deployment -## ConfigurationServiceSettings +## DeploymentSettings ### Properties -* **gitProperty**: [ConfigurationServiceGitProperty](#configurationservicegitproperty): Property of git environment. +* **addonConfigs**: [DeploymentSettingsAddonConfigs](#deploymentsettingsaddonconfigs): Collection of addons +* **containerProbeSettings**: [ContainerProbeSettings](#containerprobesettings): Container liveness and readiness probe settings +* **environmentVariables**: [DeploymentSettingsEnvironmentVariables](#deploymentsettingsenvironmentvariables): Collection of environment variables +* **resourceRequests**: [ResourceRequests](#resourcerequests): Deployment resource request payload -## ConfigurationServiceGitProperty +## DeploymentSettingsAddonConfigs ### Properties -* **repositories**: [ConfigurationServiceGitRepository](#configurationservicegitrepository)[]: Repositories of Application Configuration Service git property. +### Additional Properties +* **Additional Properties Type**: [AddonProfile](#addonprofile) -## ConfigurationServiceGitRepository +## DeploymentSettingsEnvironmentVariables ### Properties -* **hostKey**: string: Public sshKey of git repository. -* **hostKeyAlgorithm**: string: SshKey algorithm of git repository. -* **label**: string (Required): Label of the repository -* **name**: string (Required): Name of the repository -* **password**: string: Password of git repository basic auth. -* **patterns**: string[] (Required): Collection of patterns of the repository -* **privateKey**: string: Private sshKey algorithm of git repository. -* **searchPaths**: string[]: Searching path of the repository -* **strictHostKeyChecking**: bool: Strict host key checking or not. -* **uri**: string (Required): URI of the repository -* **username**: string: Username of git repository basic auth. +### Additional Properties +* **Additional Properties Type**: string -## GatewayProperties +## Error ### Properties -* **apiMetadataProperties**: [GatewayApiMetadataProperties](#gatewayapimetadataproperties): API metadata property for Spring Cloud Gateway -* **corsProperties**: [GatewayCorsProperties](#gatewaycorsproperties): Cross-Origin Resource Sharing property -* **httpsOnly**: bool: Indicate if only https is allowed. -* **instances**: [GatewayInstance](#gatewayinstance)[] (ReadOnly): Collection of instances belong to Spring Cloud Gateway. -* **operatorProperties**: [GatewayOperatorProperties](#gatewayoperatorproperties) (ReadOnly): Properties of the Spring Cloud Gateway Operator. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Spring Cloud Gateway. -* **public**: bool: Indicates whether the Spring Cloud Gateway exposes endpoint. -* **resourceRequests**: [GatewayResourceRequests](#gatewayresourcerequests): Resource request payload of Spring Cloud Gateway. -* **ssoProperties**: [SsoProperties](#ssoproperties): Single sign-on related configuration -* **url**: string (ReadOnly): URL of the Spring Cloud Gateway, exposed when 'public' is true. +* **code**: string: The code of error. +* **message**: string: The message of error. ## GatewayApiMetadataProperties ### Properties @@ -691,6 +532,18 @@ the relative path to the target module/project. * **title**: string: Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`) * **version**: string: Version of APIs available on this Gateway instance (default: `unspecified`). +## GatewayApiRoute +### Properties +* **description**: string: A description, will be applied to methods in the generated OpenAPI documentation. +* **filters**: string[]: To modify the request before sending it to the target endpoint, or the received response. +* **order**: int: Route processing order. +* **predicates**: string[]: A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. +* **ssoEnabled**: bool: Enable sso validation. +* **tags**: string[]: Classification tags, will be applied to methods in the generated OpenAPI documentation. +* **title**: string: A title, will be applied to methods in the generated OpenAPI documentation. +* **tokenRelay**: bool: Pass currently-authenticated user's identity token to application service, default is 'false' +* **uri**: string: Full uri, will override `appName`. + ## GatewayCorsProperties ### Properties * **allowCredentials**: bool: Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`. @@ -700,6 +553,10 @@ the relative path to the target module/project. * **exposedHeaders**: string[]: HTTP response headers to expose for cross-site requests. * **maxAge**: int: How long, in seconds, the response from a pre-flight request can be cached by clients. +## GatewayCustomDomainProperties +### Properties +* **thumbprint**: string: The thumbprint of bound certificate. + ## GatewayInstance ### Properties * **name**: string (ReadOnly): Name of the Spring Cloud Gateway instance @@ -716,32 +573,60 @@ the relative path to the target module/project. * **instanceCount**: int (ReadOnly): Instance count of the Spring Cloud Gateway Operator. * **memory**: string (ReadOnly): Memory allocated to each Spring Cloud Gateway Operator instance. +## GatewayProperties +### Properties +* **apiMetadataProperties**: [GatewayApiMetadataProperties](#gatewayapimetadataproperties): API metadata property for Spring Cloud Gateway +* **corsProperties**: [GatewayCorsProperties](#gatewaycorsproperties): Cross-Origin Resource Sharing property +* **httpsOnly**: bool: Indicate if only https is allowed. +* **instances**: [GatewayInstance](#gatewayinstance)[] (ReadOnly): Collection of instances belong to Spring Cloud Gateway. +* **operatorProperties**: [GatewayOperatorProperties](#gatewayoperatorproperties) (ReadOnly): Properties of the Spring Cloud Gateway Operator. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Spring Cloud Gateway. +* **public**: bool: Indicates whether the Spring Cloud Gateway exposes endpoint. +* **resourceRequests**: [GatewayResourceRequests](#gatewayresourcerequests): Resource request payload of Spring Cloud Gateway. +* **ssoProperties**: [SsoProperties](#ssoproperties): Single sign-on related configuration +* **url**: string (ReadOnly): URL of the Spring Cloud Gateway, exposed when 'public' is true. + ## GatewayResourceRequests ### Properties * **cpu**: string: Cpu allocated to each Spring Cloud Gateway instance. * **memory**: string: Memory allocated to each Spring Cloud Gateway instance. -## GatewayCustomDomainProperties -### Properties -* **thumbprint**: string: The thumbprint of bound certificate. - ## GatewayRouteConfigProperties ### Properties * **appResourceId**: string: The resource Id of the Azure Spring Cloud app, required unless route defines `uri`. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Spring Cloud Gateway. * **routes**: [GatewayApiRoute](#gatewayapiroute)[]: Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`. -## GatewayApiRoute +## GitPatternRepository ### Properties -* **description**: string: A description, will be applied to methods in the generated OpenAPI documentation. -* **filters**: string[]: To modify the request before sending it to the target endpoint, or the received response. -* **order**: int: Route processing order. -* **predicates**: string[]: A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. -* **ssoEnabled**: bool: Enable sso validation. -* **tags**: string[]: Classification tags, will be applied to methods in the generated OpenAPI documentation. -* **title**: string: A title, will be applied to methods in the generated OpenAPI documentation. -* **tokenRelay**: bool: Pass currently-authenticated user's identity token to application service, default is 'false' -* **uri**: string: Full uri, will override `appName`. +* **hostKey**: string: Public sshKey of git repository. +* **hostKeyAlgorithm**: string: SshKey algorithm of git repository. +* **label**: string: Label of the repository +* **name**: string (Required): Name of the repository +* **password**: string: Password of git repository basic auth. +* **pattern**: string[]: Collection of pattern of the repository +* **privateKey**: string: Private sshKey algorithm of git repository. +* **searchPaths**: string[]: Searching path of the repository +* **strictHostKeyChecking**: bool: Strict host key checking or not. +* **uri**: string (Required): URI of the repository +* **username**: string: Username of git repository basic auth. + +## ImageRegistryCredential +### Properties +* **password**: string: The password of the image registry credential +* **username**: string: The username of the image registry credential + +## LoadedCertificate +### Properties +* **loadTrustStore**: bool: Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. +* **resourceId**: string (Required): Resource Id of loaded certificate + +## ManagedIdentityProperties +### Properties +* **principalId**: string: Principal Id of system-assigned managed identity. +* **tenantId**: string: Tenant Id of system-assigned managed identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Type of the managed identity +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): User-assigned managed identities in key-value map. The key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ## MonitoringSettingProperties ### Properties @@ -752,27 +637,74 @@ the relative path to the target module/project. * **provisioningState**: 'Failed' | 'NotAvailable' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Monitoring Setting. * **traceEnabled**: bool: Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not -## ApplicationInsightsAgentVersions +## NetworkProfile ### Properties -* **java**: string (ReadOnly): Indicates the version of application insight java agent +* **appNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Apps +* **appSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps +* **outboundIPs**: [NetworkProfileOutboundIPs](#networkprofileoutboundips) (ReadOnly): Desired outbound IP resources for Azure Spring Cloud instance. +* **requiredTraffics**: [RequiredTraffic](#requiredtraffic)[] (ReadOnly): Required inbound or outbound traffics for Azure Spring Cloud instance. +* **serviceCidr**: string: Azure Spring Cloud service reserved CIDR +* **serviceRuntimeNetworkResourceGroup**: string: Name of the resource group containing network resources of Azure Spring Cloud Service Runtime +* **serviceRuntimeSubnetId**: string: Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime -## ServiceRegistryProperties +## NetworkProfileOutboundIPs ### Properties -* **instances**: [ServiceRegistryInstance](#serviceregistryinstance)[] (ReadOnly): Collection of instances belong to Service Registry. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Service Registry. -* **resourceRequests**: [ServiceRegistryResourceRequests](#serviceregistryresourcerequests) (ReadOnly): Resource request payload of Service Registry +* **publicIPs**: string[] (ReadOnly): A list of public IP addresses. + +## PersistentDisk +### Properties +* **mountPath**: string: Mount path of the persistent disk +* **sizeInGB**: int: Size of the persistent disk in GB +* **usedInGB**: int (ReadOnly): Size of the used persistent disk in GB + +## RequiredTraffic +### Properties +* **direction**: 'Inbound' | 'Outbound' | string (ReadOnly): The direction of required traffic +* **fqdns**: string[] (ReadOnly): The FQDN list of required traffic +* **ips**: string[] (ReadOnly): The ip list of required traffic +* **port**: int (ReadOnly): The port of required traffic +* **protocol**: string (ReadOnly): The protocol of required traffic + +## ResourceRequests +### Properties +* **cpu**: string: Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. +* **memory**: string: Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. ## ServiceRegistryInstance ### Properties * **name**: string (ReadOnly): Name of the Service Registry instance * **status**: string (ReadOnly): Status of the Service Registry instance +## ServiceRegistryProperties +### Properties +* **instances**: [ServiceRegistryInstance](#serviceregistryinstance)[] (ReadOnly): Collection of instances belong to Service Registry. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of the Service Registry. +* **resourceRequests**: [ServiceRegistryResourceRequests](#serviceregistryresourcerequests) (ReadOnly): Resource request payload of Service Registry + ## ServiceRegistryResourceRequests ### Properties * **cpu**: string (ReadOnly): Cpu allocated to each Service Registry instance * **instanceCount**: int (ReadOnly): Instance count of the Service Registry * **memory**: string (ReadOnly): Memory allocated to each Service Registry instance +## Sku +### Properties +* **capacity**: int: Current capacity of the target resource +* **name**: string: Name of the Sku +* **tier**: string: Tier of the Sku + +## SsoProperties +### Properties +* **clientId**: string: The public identifier for the application +* **clientSecret**: string: The secret known only to the application and the authorization server +* **issuerUri**: string: The URI of Issuer Identifier +* **scope**: string[]: It defines the specific actions applications can be allowed to do on a user's behalf + +## StackProperties +### Properties +* **id**: string: Id of the ClusterStack. +* **version**: string: Version of the ClusterStack + ## StorageProperties * **Discriminator**: storageType @@ -784,6 +716,20 @@ the relative path to the target module/project. * **storageType**: 'StorageAccount' (Required): The type of the storage. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + +## TemporaryDisk +### Properties +* **mountPath**: string: Mount path of the temporary disk +* **sizeInGB**: int: Size of the temporary disk in GB + ## TestKeys ### Properties * **enabled**: bool (ReadOnly): Indicates whether the test endpoint feature enabled or not @@ -792,3 +738,57 @@ the relative path to the target module/project. * **secondaryKey**: string (ReadOnly): Secondary key * **secondaryTestEndpoint**: string (ReadOnly): Secondary test endpoint +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TriggeredBuildResult +### Properties +* **id**: string: The unique build id of this build result + +## UserAssignedManagedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) + +## UserAssignedManagedIdentity +### Properties +* **clientId**: string (ReadOnly): Client Id of user-assigned managed identity. +* **principalId**: string (ReadOnly): Principal Id of user-assigned managed identity. + +## UserSourceInfo +* **Discriminator**: type + +### Base Properties +* **version**: string: Version of the source +### BuildResultUserSourceInfo +#### Properties +* **buildResultId**: string: Resource id of an existing succeeded build result under the same Spring instance. +* **type**: 'BuildResult' (Required): Type of the source uploaded + +### CustomContainerUserSourceInfo +#### Properties +* **customContainer**: [CustomContainer](#customcontainer): Custom container payload +* **type**: 'Container' (Required): Type of the source uploaded + +### JarUploadedUserSourceInfo +#### Properties +* **jvmOptions**: string: JVM parameter +* **runtimeVersion**: string: Runtime version of the Jar file +* **type**: 'Jar' (Required): Type of the source uploaded + +### NetCoreZipUploadedUserSourceInfo +#### Properties +* **netCoreMainEntryPath**: string: The path to the .NET executable relative to zip root +* **runtimeVersion**: string: Runtime version of the .Net file +* **type**: 'NetCoreZip' (Required): Type of the source uploaded + +### SourceUploadedUserSourceInfo +#### Properties +* **artifactSelector**: string: Selector for the artifact to be used for the deployment for multi-module projects. This should be +the relative path to the target module/project. +* **runtimeVersion**: string: Runtime version of the source file +* **type**: 'Source' (Required): Type of the source uploaded + + diff --git a/generated/attestation/log.out b/generated/attestation/log.out index 24f6af78a5..215f2156fc 100644 --- a/generated/attestation/log.out +++ b/generated/attestation/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.attestation-2018-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/attestation/resource-manager/Microsoft.Attestation/stable/2018-09-01-preview/attestation.json:427:5 @@ -28,7 +28,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.attestation-2020-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/attestation/resource-manager/Microsoft.Attestation/stable/2020-10-01/attestation.json:612:5 @@ -47,10 +47,10 @@ warning | PreCheck/SchemaMissingType | The schema 'AttestationServiceCreationPar warning | PreCheck/SchemaMissingType | The schema 'AttestationServiceCreationSpecificParams' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/attestation/resource-manager/Microsoft.Attestation/stable/2020-10-01/attestation.json:802:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.attestation-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/attestation/resource-manager/Microsoft.Attestation/preview/2021-06-01-preview/attestation.json:654:5 @@ -69,5 +69,5 @@ warning | PreCheck/SchemaMissingType | The schema 'AttestationServiceCreationPar warning | PreCheck/SchemaMissingType | The schema 'AttestationServiceCreationSpecificParams' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/attestation/resource-manager/Microsoft.Attestation/preview/2021-06-01-preview/attestation.json:859:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 7.99s. 6 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 7.61s. 6 files generated. diff --git a/generated/attestation/microsoft.attestation/2018-09-01-preview/types.md b/generated/attestation/microsoft.attestation/2018-09-01-preview/types.md index 1ed22e3d02..ec89760676 100644 --- a/generated/attestation/microsoft.attestation/2018-09-01-preview/types.md +++ b/generated/attestation/microsoft.attestation/2018-09-01-preview/types.md @@ -11,6 +11,11 @@ * **tags**: [AttestationServiceCreationParamsTags](#attestationservicecreationparamstags): The tags that will be assigned to the attestation service instance. * **type**: 'Microsoft.Attestation/attestationProviders' (ReadOnly, DeployTimeConstant): The resource type +## AttestationServiceCreationParamsTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## AttestationServiceCreationSpecificParams ### Properties * **attestationPolicy**: string (WriteOnly): Name of attestation policy. @@ -19,14 +24,6 @@ * **status**: 'Error' | 'NotReady' | 'Ready' | string (ReadOnly): Status of attestation service. * **trustModel**: string (ReadOnly): Trust model for the attestation service instance. -## JsonWebKeySet -### Properties -* **keys**: [JsonWebKey](#jsonwebkey)[] (WriteOnly): The value of the "keys" parameter is an array of JWK values. By -default, the order of the JWK values within the array does not imply -an order of preference among them, although applications of JWK Sets -can choose to assign a meaning to the order for their purposes, if -desired. - ## JsonWebKey ### Properties * **alg**: string (WriteOnly): The "alg" (algorithm) parameter identifies the algorithm intended for @@ -72,8 +69,11 @@ The PKIX certificate containing the key value MUST be the first certificate. * **y**: string (WriteOnly): Y coordinate for the Elliptic Curve point -## AttestationServiceCreationParamsTags +## JsonWebKeySet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keys**: [JsonWebKey](#jsonwebkey)[] (WriteOnly): The value of the "keys" parameter is an array of JWK values. By +default, the order of the JWK values within the array does not imply +an order of preference among them, although applications of JWK Sets +can choose to assign a meaning to the order for their purposes, if +desired. diff --git a/generated/attestation/microsoft.attestation/2020-10-01/types.md b/generated/attestation/microsoft.attestation/2020-10-01/types.md index e8d5fd7191..d23b10ab55 100644 --- a/generated/attestation/microsoft.attestation/2020-10-01/types.md +++ b/generated/attestation/microsoft.attestation/2020-10-01/types.md @@ -21,6 +21,11 @@ * **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. * **type**: 'Microsoft.Attestation/attestationProviders/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type +## AttestationServiceCreationParamsTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## AttestationServiceCreationSpecificParams ### Properties * **attestUri**: string (ReadOnly): Gets the uri of attestation service @@ -29,14 +34,6 @@ * **status**: 'Error' | 'NotReady' | 'Ready' | string (ReadOnly): Status of attestation service. * **trustModel**: string (ReadOnly): Trust model for the attestation provider. -## JsonWebKeySet -### Properties -* **keys**: [JsonWebKey](#jsonwebkey)[] (WriteOnly): The value of the "keys" parameter is an array of JWK values. By -default, the order of the JWK values within the array does not imply -an order of preference among them, although applications of JWK Sets -can choose to assign a meaning to the order for their purposes, if -desired. - ## JsonWebKey ### Properties * **alg**: string (WriteOnly): The "alg" (algorithm) parameter identifies the algorithm intended for @@ -82,6 +79,18 @@ The PKIX certificate containing the key value MUST be the first certificate. * **y**: string (WriteOnly): Y coordinate for the Elliptic Curve point +## JsonWebKeySet +### Properties +* **keys**: [JsonWebKey](#jsonwebkey)[] (WriteOnly): The value of the "keys" parameter is an array of JWK values. By +default, the order of the JWK values within the array does not imply +an order of preference among them, although applications of JWK Sets +can choose to assign a meaning to the order for their purposes, if +desired. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -95,10 +104,6 @@ certificate. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. @@ -114,8 +119,3 @@ certificate. * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## AttestationServiceCreationParamsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/attestation/microsoft.attestation/2021-06-01-preview/types.md b/generated/attestation/microsoft.attestation/2021-06-01-preview/types.md index 24a93a3608..926975667f 100644 --- a/generated/attestation/microsoft.attestation/2021-06-01-preview/types.md +++ b/generated/attestation/microsoft.attestation/2021-06-01-preview/types.md @@ -21,6 +21,11 @@ * **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. * **type**: 'Microsoft.Attestation/attestationProviders/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type +## AttestationServiceCreationParamsTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## AttestationServiceCreationSpecificParams ### Properties * **attestUri**: string (ReadOnly): Gets the uri of attestation service @@ -30,14 +35,6 @@ * **status**: 'Error' | 'NotReady' | 'Ready' | string (ReadOnly): Status of attestation service. * **trustModel**: string (ReadOnly): Trust model for the attestation provider. -## JsonWebKeySet -### Properties -* **keys**: [JsonWebKey](#jsonwebkey)[] (WriteOnly): The value of the "keys" parameter is an array of JWK values. By -default, the order of the JWK values within the array does not imply -an order of preference among them, although applications of JWK Sets -can choose to assign a meaning to the order for their purposes, if -desired. - ## JsonWebKey ### Properties * **alg**: string (WriteOnly): The "alg" (algorithm) parameter identifies the algorithm intended for @@ -83,6 +80,18 @@ The PKIX certificate containing the key value MUST be the first certificate. * **y**: string (WriteOnly): Y coordinate for the Elliptic Curve point +## JsonWebKeySet +### Properties +* **keys**: [JsonWebKey](#jsonwebkey)[] (WriteOnly): The value of the "keys" parameter is an array of JWK values. By +default, the order of the JWK values within the array does not imply +an order of preference among them, although applications of JWK Sets +can choose to assign a meaning to the order for their purposes, if +desired. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -96,10 +105,6 @@ certificate. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. @@ -115,8 +120,3 @@ certificate. * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## AttestationServiceCreationParamsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/authorization/log.out b/generated/authorization/log.out index 4a7dacb7f3..6b5ee96b48 100644 --- a/generated/authorization/log.out +++ b/generated/authorization/log.out @@ -20,7 +20,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.authorization-2015-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -40,7 +40,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RoleDefinitionFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization-RoleDefinitionsCalls.json:398:5 @@ -82,7 +82,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ClassicAdministratorListResul - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json:113:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{roleAssignmentId}': Unable to locate "/providers/" segment -info | autorest.bicep took 17ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.authorization-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -102,7 +102,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 8ms @@ -125,10 +125,10 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.authorization-2021-11-16-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -148,7 +148,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'AccessReviewDecisionResourceAzureRole' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-11-16-preview/authorization-AccessReviewCalls.json:2328:9 @@ -158,7 +158,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'AccessReviewDecisionServic - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-11-16-preview/authorization-AccessReviewCalls.json:2402:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AccessReviewDecisionResourceAzureRole' has a property 'displayName' that is already declared the parent schema 'AccessReviewDecisionResource' but isn't significantly different. The property has been removed from AccessReviewDecisionResourceAzureRole -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.authorization-2021-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -178,14 +178,14 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'AccessReviewDecisionUserIdentity' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json:1855:9 warning | PreCheck/EmptyParentSchemaWarning | Schema 'AccessReviewDecisionServicePrincipalIdentity' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json:1876:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.authorization-2021-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -205,7 +205,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AccessReviewScheduleDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json:1050:5 @@ -254,7 +254,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'AccessReviewDecisionUserId warning | PreCheck/EmptyParentSchemaWarning | Schema 'AccessReviewDecisionServicePrincipalIdentity' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json:1660:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.authorization-2021-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -274,7 +274,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentApprovalActorIdentity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-01-01-preview/authorization-RoleAssignmentApprovalCalls.json:664:5 @@ -291,7 +291,7 @@ warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentApprovalStepPro warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentApprovalStepListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-01-01-preview/authorization-RoleAssignmentApprovalCalls.json:842:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.authorization-2018-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -311,14 +311,14 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'UserDecisionTarget' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/authorization-AccessReviewCalls.json:1565:9 warning | PreCheck/EmptyParentSchemaWarning | Schema 'ServicePrincipalDecisionTarget' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-05-01-preview/authorization-AccessReviewCalls.json:1596:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.authorization-2018-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -338,7 +338,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -361,7 +361,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json:547:5 @@ -397,7 +397,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{roleAssignmentId}': Unable to locate "/providers/" segment @@ -421,10 +421,10 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.authorization-2015-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -444,7 +444,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -467,11 +467,11 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{roleAssignmentId}': Unable to locate "/providers/" segment -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.authorization-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -491,7 +491,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{roleId}': Unable to locate "/providers/" segment @@ -515,11 +515,11 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{roleAssignmentId}': Unable to locate "/providers/" segment -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.authorization-2018-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -539,7 +539,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json:547:5 @@ -575,7 +575,7 @@ warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RoleAssignmentsCalls.json:551:5 @@ -591,5 +591,5 @@ warning | PreCheck/SchemaMissingType | The schema 'RoleAssignmentCreateParameter - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/authorization/resource-manager/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RoleAssignmentsCalls.json:643:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{roleAssignmentId}': Unable to locate "/providers/" segment -info | autorest.bicep took 2ms -info | Autorest completed in 40.64s. 30 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 39.58s. 30 files generated. diff --git a/generated/authorization/microsoft.authorization/2015-07-01/types.md b/generated/authorization/microsoft.authorization/2015-07-01/types.md index b41d63d44b..ad3f125fba 100644 --- a/generated/authorization/microsoft.authorization/2015-07-01/types.md +++ b/generated/authorization/microsoft.authorization/2015-07-01/types.md @@ -18,6 +18,11 @@ * **properties**: [RoleDefinitionProperties](#roledefinitionproperties): Role definition properties. * **type**: 'Microsoft.Authorization/roleDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Permission +### Properties +* **actions**: string[]: Allowed actions. +* **notActions**: string[]: Denied actions. + ## RoleAssignmentProperties ### Properties * **principalId**: string (Required): The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group. @@ -32,8 +37,3 @@ * **roleName**: string: The role name. * **type**: string: The role type. -## Permission -### Properties -* **actions**: string[]: Allowed actions. -* **notActions**: string[]: Denied actions. - diff --git a/generated/authorization/microsoft.authorization/2018-01-01-preview/types.md b/generated/authorization/microsoft.authorization/2018-01-01-preview/types.md index 1ae9fa142c..0e663be5bc 100644 --- a/generated/authorization/microsoft.authorization/2018-01-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2018-01-01-preview/types.md @@ -18,6 +18,13 @@ * **properties**: [RoleDefinitionProperties](#roledefinitionproperties): Role definition properties. * **type**: 'Microsoft.Authorization/roleDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Permission +### Properties +* **actions**: string[]: Allowed actions. +* **dataActions**: string[]: Allowed Data actions. +* **notActions**: string[]: Denied actions. +* **notDataActions**: string[]: Denied Data actions. + ## RoleAssignmentProperties ### Properties * **canDelegate**: bool: The delegation flag used for creating a role assignment @@ -33,10 +40,3 @@ * **roleName**: string: The role name. * **type**: string: The role type. -## Permission -### Properties -* **actions**: string[]: Allowed actions. -* **dataActions**: string[]: Allowed Data actions. -* **notActions**: string[]: Denied actions. -* **notDataActions**: string[]: Denied Data actions. - diff --git a/generated/authorization/microsoft.authorization/2018-05-01-preview/types.md b/generated/authorization/microsoft.authorization/2018-05-01-preview/types.md index c61802574e..d9f80e5ffd 100644 --- a/generated/authorization/microsoft.authorization/2018-05-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2018-05-01-preview/types.md @@ -57,6 +57,28 @@ * **startDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to be start. * **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly, WriteOnly): This read-only field specifies the status of an access review instance. +## AccessReviewRecurrencePattern +### Properties +* **interval**: int (WriteOnly): The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. +* **type**: 'absoluteMonthly' | 'weekly' | string (WriteOnly): The recurrence type : weekly, monthly, etc. + +## AccessReviewRecurrenceRange +### Properties +* **endDate**: string (WriteOnly): The DateTime when the review is scheduled to end. Required if type is endDate +* **numberOfOccurrences**: int (WriteOnly): The number of times to repeat the access review. Required and must be positive if type is numbered. +* **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. +* **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. + +## AccessReviewRecurrenceSettings +### Properties +* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. +* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. + +## AccessReviewReviewer +### Properties +* **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) +* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal + ## AccessReviewScheduleDefinitionProperties ### Properties * **createdBy**: [AccessReviewActorIdentity](#accessreviewactoridentity) (ReadOnly): Details of the actor identity @@ -70,17 +92,6 @@ * **settings**: [AccessReviewScheduleSettings](#accessreviewschedulesettings) (ReadOnly): Settings of an Access Review. * **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly): This read-only field specifies the status of an accessReview. -## AccessReviewReviewer -### Properties -* **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) -* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal - -## AccessReviewScope -### Properties -* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review -* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created -* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed - ## AccessReviewScheduleSettings ### Properties * **autoApplyDecisionsEnabled**: bool (WriteOnly): Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review. @@ -93,20 +104,9 @@ * **recurrence**: [AccessReviewRecurrenceSettings](#accessreviewrecurrencesettings) (WriteOnly): Recurrence Settings of an Access Review Schedule Definition. * **reminderNotificationsEnabled**: bool (WriteOnly): Flag to indicate whether sending reminder emails to reviewers are enabled. -## AccessReviewRecurrenceSettings -### Properties -* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. -* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. - -## AccessReviewRecurrencePattern -### Properties -* **interval**: int (WriteOnly): The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. -* **type**: 'absoluteMonthly' | 'weekly' | string (WriteOnly): The recurrence type : weekly, monthly, etc. - -## AccessReviewRecurrenceRange +## AccessReviewScope ### Properties -* **endDate**: string (WriteOnly): The DateTime when the review is scheduled to end. Required if type is endDate -* **numberOfOccurrences**: int (WriteOnly): The number of times to repeat the access review. Required and must be positive if type is numbered. -* **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. -* **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. +* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review +* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created +* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed diff --git a/generated/authorization/microsoft.authorization/2020-10-01-preview/types.md b/generated/authorization/microsoft.authorization/2020-10-01-preview/types.md index 77f80001d2..f62d917ad4 100644 --- a/generated/authorization/microsoft.authorization/2020-10-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2020-10-01-preview/types.md @@ -36,6 +36,62 @@ * **properties**: [RoleManagementPolicyAssignmentProperties](#rolemanagementpolicyassignmentproperties): Role management policy assignment properties with scope. * **type**: 'Microsoft.Authorization/roleManagementPolicyAssignments' (ReadOnly, DeployTimeConstant): The resource type +## ExpandedProperties +### Properties +* **principal**: [ExpandedPropertiesPrincipal](#expandedpropertiesprincipal): Details of the principal +* **roleDefinition**: [ExpandedPropertiesRoleDefinition](#expandedpropertiesroledefinition): Details of role definition +* **scope**: [ExpandedPropertiesScope](#expandedpropertiesscope): Details of the resource scope + +## ExpandedPropertiesPrincipal +### Properties +* **displayName**: string: Display name of the principal +* **email**: string: Email id of the principal +* **id**: string: Id of the principal +* **type**: string: Type of the principal + +## ExpandedPropertiesRoleDefinition +### Properties +* **displayName**: string: Display name of the role definition +* **id**: string: Id of the role definition +* **type**: string: Type of the role definition + +## ExpandedPropertiesScope +### Properties +* **displayName**: string: Display name of the resource +* **id**: string: Scope id of the resource +* **type**: string: Type of the resource + +## PolicyAssignmentProperties +### Properties +* **policy**: [PolicyAssignmentPropertiesPolicy](#policyassignmentpropertiespolicy): Details of the policy +* **roleDefinition**: [PolicyAssignmentPropertiesRoleDefinition](#policyassignmentpropertiesroledefinition): Details of role definition +* **scope**: [PolicyAssignmentPropertiesScope](#policyassignmentpropertiesscope): Details of the resource scope + +## PolicyAssignmentPropertiesPolicy +### Properties +* **id**: string: Id of the policy +* **lastModifiedBy**: [Principal](#principal) (ReadOnly): The name of the entity last modified it +* **lastModifiedDateTime**: string: The last modified date time. + +## PolicyAssignmentPropertiesRoleDefinition +### Properties +* **displayName**: string: Display name of the role definition +* **id**: string: Id of the role definition +* **type**: string: Type of the role definition + +## PolicyAssignmentPropertiesScope +### Properties +* **displayName**: string: Display name of the resource +* **id**: string: Scope id of the resource +* **type**: string: Type of the resource + +## Principal +### Properties +* **displayName**: string: The name of the principal made changes +* **email**: string: Email of principal +* **id**: string: The id of the principal made changes +* **type**: string: Type of principal such as user , group etc + ## RoleAssignmentProperties ### Properties * **condition**: string: The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' @@ -72,31 +128,6 @@ * **targetRoleAssignmentScheduleInstanceId**: string: The role assignment schedule instance id being updated * **ticketInfo**: [RoleAssignmentScheduleRequestPropertiesTicketInfo](#roleassignmentschedulerequestpropertiesticketinfo): Ticket Info of the role assignment -## ExpandedProperties -### Properties -* **principal**: [ExpandedPropertiesPrincipal](#expandedpropertiesprincipal): Details of the principal -* **roleDefinition**: [ExpandedPropertiesRoleDefinition](#expandedpropertiesroledefinition): Details of role definition -* **scope**: [ExpandedPropertiesScope](#expandedpropertiesscope): Details of the resource scope - -## ExpandedPropertiesPrincipal -### Properties -* **displayName**: string: Display name of the principal -* **email**: string: Email id of the principal -* **id**: string: Id of the principal -* **type**: string: Type of the principal - -## ExpandedPropertiesRoleDefinition -### Properties -* **displayName**: string: Display name of the role definition -* **id**: string: Id of the role definition -* **type**: string: Type of the role definition - -## ExpandedPropertiesScope -### Properties -* **displayName**: string: Display name of the resource -* **id**: string: Scope id of the resource -* **type**: string: Type of the resource - ## RoleAssignmentScheduleRequestPropertiesScheduleInfo ### Properties * **expiration**: [RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration](#roleassignmentschedulerequestpropertiesscheduleinfoexpiration): Expiration of the role assignment schedule @@ -156,34 +187,3 @@ * **roleDefinitionId**: string: The role definition of management policy assignment. * **scope**: string: The role management policy scope. -## PolicyAssignmentProperties -### Properties -* **policy**: [PolicyAssignmentPropertiesPolicy](#policyassignmentpropertiespolicy): Details of the policy -* **roleDefinition**: [PolicyAssignmentPropertiesRoleDefinition](#policyassignmentpropertiesroledefinition): Details of role definition -* **scope**: [PolicyAssignmentPropertiesScope](#policyassignmentpropertiesscope): Details of the resource scope - -## PolicyAssignmentPropertiesPolicy -### Properties -* **id**: string: Id of the policy -* **lastModifiedBy**: [Principal](#principal) (ReadOnly): The name of the entity last modified it -* **lastModifiedDateTime**: string: The last modified date time. - -## Principal -### Properties -* **displayName**: string: The name of the principal made changes -* **email**: string: Email of principal -* **id**: string: The id of the principal made changes -* **type**: string: Type of principal such as user , group etc - -## PolicyAssignmentPropertiesRoleDefinition -### Properties -* **displayName**: string: Display name of the role definition -* **id**: string: Id of the role definition -* **type**: string: Type of the role definition - -## PolicyAssignmentPropertiesScope -### Properties -* **displayName**: string: Display name of the resource -* **id**: string: Scope id of the resource -* **type**: string: Type of the resource - diff --git a/generated/authorization/microsoft.authorization/2020-10-01/types.md b/generated/authorization/microsoft.authorization/2020-10-01/types.md index 2e47fa9744..0f507c1ec0 100644 --- a/generated/authorization/microsoft.authorization/2020-10-01/types.md +++ b/generated/authorization/microsoft.authorization/2020-10-01/types.md @@ -27,26 +27,22 @@ * **properties**: [RoleManagementPolicyAssignmentProperties](#rolemanagementpolicyassignmentproperties): Role management policy assignment properties with scope. * **type**: 'Microsoft.Authorization/roleManagementPolicyAssignments' (ReadOnly, DeployTimeConstant): The resource type -## RoleAssignmentScheduleRequestProperties +## ApprovalSettings ### Properties -* **approvalId**: string (ReadOnly): The approvalId of the role assignment schedule request. -* **condition**: string: The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' -* **conditionVersion**: string: Version of the condition. Currently accepted value is '2.0' -* **createdOn**: string (ReadOnly): DateTime when role assignment schedule request was created -* **expandedProperties**: [ExpandedProperties](#expandedproperties) (ReadOnly) -* **justification**: string: Justification for the role assignment -* **linkedRoleEligibilityScheduleId**: string: The linked role eligibility schedule id - to activate an eligibility. -* **principalId**: string (Required): The principal ID. -* **principalType**: 'Device' | 'ForeignGroup' | 'Group' | 'ServicePrincipal' | 'User' | string (ReadOnly): The principal type of the assigned principal ID. -* **requestorId**: string (ReadOnly): Id of the user who created this request -* **requestType**: 'AdminAssign' | 'AdminExtend' | 'AdminRemove' | 'AdminRenew' | 'AdminUpdate' | 'SelfActivate' | 'SelfDeactivate' | 'SelfExtend' | 'SelfRenew' | string (Required): The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc -* **roleDefinitionId**: string (Required): The role definition ID. -* **scheduleInfo**: [RoleAssignmentScheduleRequestPropertiesScheduleInfo](#roleassignmentschedulerequestpropertiesscheduleinfo): Schedule info of the role assignment schedule -* **scope**: string (ReadOnly): The role assignment schedule request scope. -* **status**: 'Accepted' | 'AdminApproved' | 'AdminDenied' | 'Canceled' | 'Denied' | 'Failed' | 'FailedAsResourceIsLocked' | 'Granted' | 'Invalid' | 'PendingAdminDecision' | 'PendingApproval' | 'PendingApprovalProvisioning' | 'PendingEvaluation' | 'PendingExternalProvisioning' | 'PendingProvisioning' | 'PendingRevocation' | 'PendingScheduleCreation' | 'Provisioned' | 'ProvisioningStarted' | 'Revoked' | 'ScheduleCreated' | 'TimedOut' | string (ReadOnly): The status of the role assignment schedule. -* **targetRoleAssignmentScheduleId**: string: The resultant role assignment schedule id or the role assignment schedule id being updated -* **targetRoleAssignmentScheduleInstanceId**: string: The role assignment schedule instance id being updated -* **ticketInfo**: [RoleAssignmentScheduleRequestPropertiesTicketInfo](#roleassignmentschedulerequestpropertiesticketinfo): Ticket Info of the role assignment +* **approvalMode**: 'NoApproval' | 'Parallel' | 'Serial' | 'SingleStage' | string: The type of rule +* **approvalStages**: [ApprovalStage](#approvalstage)[]: The approval stages of the request. +* **isApprovalRequired**: bool: Determines whether approval is required or not. +* **isApprovalRequiredForExtension**: bool: Determines whether approval is required for assignment extension. +* **isRequestorJustificationRequired**: bool: Determine whether requestor justification is required. + +## ApprovalStage +### Properties +* **approvalStageTimeOutInDays**: int: The time in days when approval request would be timed out +* **escalationApprovers**: [UserSet](#userset)[]: The escalation approver of the request. +* **escalationTimeInMinutes**: int: The time in minutes when the approval request would be escalated if the primary approver does not approve +* **isApproverJustificationRequired**: bool: Determines whether approver need to provide justification for his decision. +* **isEscalationEnabled**: bool: The value determine whether escalation feature is enabled. +* **primaryApprovers**: [UserSet](#userset)[]: The primary approver of the request. ## ExpandedProperties ### Properties @@ -73,6 +69,58 @@ * **id**: string: Scope id of the resource * **type**: string: Type of the resource +## PolicyAssignmentProperties +### Properties +* **policy**: [PolicyAssignmentPropertiesPolicy](#policyassignmentpropertiespolicy): Details of the policy +* **roleDefinition**: [PolicyAssignmentPropertiesRoleDefinition](#policyassignmentpropertiesroledefinition): Details of role definition +* **scope**: [PolicyAssignmentPropertiesScope](#policyassignmentpropertiesscope): Details of the resource scope + +## PolicyAssignmentPropertiesPolicy +### Properties +* **id**: string: Id of the policy +* **lastModifiedBy**: [Principal](#principal) (ReadOnly): The name of the entity last modified it +* **lastModifiedDateTime**: string: The last modified date time. + +## PolicyAssignmentPropertiesRoleDefinition +### Properties +* **displayName**: string: Display name of the role definition +* **id**: string: Id of the role definition +* **type**: string: Type of the role definition + +## PolicyAssignmentPropertiesScope +### Properties +* **displayName**: string: Display name of the resource +* **id**: string: Scope id of the resource +* **type**: string: Type of the resource + +## Principal +### Properties +* **displayName**: string: The name of the principal made changes +* **email**: string: Email of principal +* **id**: string: The id of the principal made changes +* **type**: string: Type of principal such as user , group etc + +## RoleAssignmentScheduleRequestProperties +### Properties +* **approvalId**: string (ReadOnly): The approvalId of the role assignment schedule request. +* **condition**: string: The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' +* **conditionVersion**: string: Version of the condition. Currently accepted value is '2.0' +* **createdOn**: string (ReadOnly): DateTime when role assignment schedule request was created +* **expandedProperties**: [ExpandedProperties](#expandedproperties) (ReadOnly) +* **justification**: string: Justification for the role assignment +* **linkedRoleEligibilityScheduleId**: string: The linked role eligibility schedule id - to activate an eligibility. +* **principalId**: string (Required): The principal ID. +* **principalType**: 'Device' | 'ForeignGroup' | 'Group' | 'ServicePrincipal' | 'User' | string (ReadOnly): The principal type of the assigned principal ID. +* **requestorId**: string (ReadOnly): Id of the user who created this request +* **requestType**: 'AdminAssign' | 'AdminExtend' | 'AdminRemove' | 'AdminRenew' | 'AdminUpdate' | 'SelfActivate' | 'SelfDeactivate' | 'SelfExtend' | 'SelfRenew' | string (Required): The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc +* **roleDefinitionId**: string (Required): The role definition ID. +* **scheduleInfo**: [RoleAssignmentScheduleRequestPropertiesScheduleInfo](#roleassignmentschedulerequestpropertiesscheduleinfo): Schedule info of the role assignment schedule +* **scope**: string (ReadOnly): The role assignment schedule request scope. +* **status**: 'Accepted' | 'AdminApproved' | 'AdminDenied' | 'Canceled' | 'Denied' | 'Failed' | 'FailedAsResourceIsLocked' | 'Granted' | 'Invalid' | 'PendingAdminDecision' | 'PendingApproval' | 'PendingApprovalProvisioning' | 'PendingEvaluation' | 'PendingExternalProvisioning' | 'PendingProvisioning' | 'PendingRevocation' | 'PendingScheduleCreation' | 'Provisioned' | 'ProvisioningStarted' | 'Revoked' | 'ScheduleCreated' | 'TimedOut' | string (ReadOnly): The status of the role assignment schedule. +* **targetRoleAssignmentScheduleId**: string: The resultant role assignment schedule id or the role assignment schedule id being updated +* **targetRoleAssignmentScheduleInstanceId**: string: The role assignment schedule instance id being updated +* **ticketInfo**: [RoleAssignmentScheduleRequestPropertiesTicketInfo](#roleassignmentschedulerequestpropertiesticketinfo): Ticket Info of the role assignment + ## RoleAssignmentScheduleRequestPropertiesScheduleInfo ### Properties * **expiration**: [RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration](#roleassignmentschedulerequestpropertiesscheduleinfoexpiration): Expiration of the role assignment schedule @@ -180,23 +228,6 @@ * **operations**: string[]: The type of operation. * **targetObjects**: string[]: The list of target objects. -## ApprovalSettings -### Properties -* **approvalMode**: 'NoApproval' | 'Parallel' | 'Serial' | 'SingleStage' | string: The type of rule -* **approvalStages**: [ApprovalStage](#approvalstage)[]: The approval stages of the request. -* **isApprovalRequired**: bool: Determines whether approval is required or not. -* **isApprovalRequiredForExtension**: bool: Determines whether approval is required for assignment extension. -* **isRequestorJustificationRequired**: bool: Determine whether requestor justification is required. - -## ApprovalStage -### Properties -* **approvalStageTimeOutInDays**: int: The time in days when approval request would be timed out -* **escalationApprovers**: [UserSet](#userset)[]: The escalation approver of the request. -* **escalationTimeInMinutes**: int: The time in minutes when the approval request would be escalated if the primary approver does not approve -* **isApproverJustificationRequired**: bool: Determines whether approver need to provide justification for his decision. -* **isEscalationEnabled**: bool: The value determine whether escalation feature is enabled. -* **primaryApprovers**: [UserSet](#userset)[]: The primary approver of the request. - ## UserSet ### Properties * **description**: string: The description of the user. @@ -204,34 +235,3 @@ * **isBackup**: bool: The value indicating whether the user is a backup fallback approver * **userType**: 'Group' | 'User' | string: The type of user. -## PolicyAssignmentProperties -### Properties -* **policy**: [PolicyAssignmentPropertiesPolicy](#policyassignmentpropertiespolicy): Details of the policy -* **roleDefinition**: [PolicyAssignmentPropertiesRoleDefinition](#policyassignmentpropertiesroledefinition): Details of role definition -* **scope**: [PolicyAssignmentPropertiesScope](#policyassignmentpropertiesscope): Details of the resource scope - -## PolicyAssignmentPropertiesPolicy -### Properties -* **id**: string: Id of the policy -* **lastModifiedBy**: [Principal](#principal) (ReadOnly): The name of the entity last modified it -* **lastModifiedDateTime**: string: The last modified date time. - -## Principal -### Properties -* **displayName**: string: The name of the principal made changes -* **email**: string: Email of principal -* **id**: string: The id of the principal made changes -* **type**: string: Type of principal such as user , group etc - -## PolicyAssignmentPropertiesRoleDefinition -### Properties -* **displayName**: string: Display name of the role definition -* **id**: string: Id of the role definition -* **type**: string: Type of the role definition - -## PolicyAssignmentPropertiesScope -### Properties -* **displayName**: string: Display name of the resource -* **id**: string: Scope id of the resource -* **type**: string: Type of the resource - diff --git a/generated/authorization/microsoft.authorization/2021-01-01-preview/types.md b/generated/authorization/microsoft.authorization/2021-01-01-preview/types.md index 2664bd1492..ea65c7b26b 100644 --- a/generated/authorization/microsoft.authorization/2021-01-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2021-01-01-preview/types.md @@ -16,6 +16,13 @@ * **status**: 'Completed' | 'Completing' | 'Escalated' | 'Escalating' | 'Expired' | 'InProgress' | 'Initializing' | 'NotStarted' | string (ReadOnly, WriteOnly): This read-only field specifies the status of an approval. * **type**: 'Microsoft.Authorization/roleAssignmentApprovals/stages' (ReadOnly, DeployTimeConstant): The resource type +## RoleAssignmentApprovalActorIdentity +### Properties +* **principalId**: string (ReadOnly, WriteOnly): The identity id +* **principalName**: string (ReadOnly, WriteOnly): The identity display name +* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal +* **userPrincipalName**: string (ReadOnly, WriteOnly): The user principal name(if valid) + ## RoleAssignmentApprovalStepProperties ### Properties * **assignedToMe**: bool (ReadOnly): Indicates whether the stage is assigned to me for review @@ -26,10 +33,3 @@ * **reviewResult**: 'Approve' | 'Deny' | 'NotReviewed' | string (ReadOnly): The decision on the approval stage. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny * **status**: 'Completed' | 'Completing' | 'Escalated' | 'Escalating' | 'Expired' | 'InProgress' | 'Initializing' | 'NotStarted' | string (ReadOnly): This read-only field specifies the status of an approval. -## RoleAssignmentApprovalActorIdentity -### Properties -* **principalId**: string (ReadOnly, WriteOnly): The identity id -* **principalName**: string (ReadOnly, WriteOnly): The identity display name -* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal -* **userPrincipalName**: string (ReadOnly, WriteOnly): The user principal name(if valid) - diff --git a/generated/authorization/microsoft.authorization/2021-03-01-preview/types.md b/generated/authorization/microsoft.authorization/2021-03-01-preview/types.md index 34a90ebc02..fe083e906f 100644 --- a/generated/authorization/microsoft.authorization/2021-03-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2021-03-01-preview/types.md @@ -38,11 +38,6 @@ * **reminderNotificationsEnabled**: bool (WriteOnly): Flag to indicate whether sending reminder emails to reviewers are enabled. * **type**: 'Microsoft.Authorization/accessReviewScheduleSettings' (ReadOnly, DeployTimeConstant): The resource type -## AccessReviewReviewer -### Properties -* **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) -* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal - ## AccessReviewActorIdentity ### Properties * **principalId**: string (ReadOnly, WriteOnly): The identity id @@ -63,6 +58,28 @@ * **startDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to be start. * **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly, WriteOnly): This read-only field specifies the status of an access review instance. +## AccessReviewRecurrencePattern +### Properties +* **interval**: int (WriteOnly): The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. +* **type**: 'absoluteMonthly' | 'weekly' | string (WriteOnly): The recurrence type : weekly, monthly, etc. + +## AccessReviewRecurrenceRange +### Properties +* **endDate**: string (WriteOnly): The DateTime when the review is scheduled to end. Required if type is endDate +* **numberOfOccurrences**: int (WriteOnly): The number of times to repeat the access review. Required and must be positive if type is numbered. +* **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. +* **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. + +## AccessReviewRecurrenceSettings +### Properties +* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. +* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. + +## AccessReviewReviewer +### Properties +* **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) +* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal + ## AccessReviewScheduleDefinitionProperties ### Properties * **backupReviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (ReadOnly): This is the collection of backup reviewers. @@ -77,14 +94,6 @@ * **settings**: [AccessReviewScheduleSettings](#accessreviewschedulesettings) (ReadOnly): Settings of an Access Review. * **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly): This read-only field specifies the status of an accessReview. -## AccessReviewScope -### Properties -* **assignmentState**: 'active' | 'eligible' | string (ReadOnly, WriteOnly): The role assignment state eligible/active to review -* **inactiveDuration**: string (WriteOnly): Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) -* **principalType**: 'guestUser' | 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review -* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created -* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed - ## AccessReviewScheduleSettings ### Properties * **autoApplyDecisionsEnabled**: bool (WriteOnly): Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review. @@ -97,20 +106,11 @@ * **recurrence**: [AccessReviewRecurrenceSettings](#accessreviewrecurrencesettings) (WriteOnly): Recurrence Settings of an Access Review Schedule Definition. * **reminderNotificationsEnabled**: bool (WriteOnly): Flag to indicate whether sending reminder emails to reviewers are enabled. -## AccessReviewRecurrenceSettings -### Properties -* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. -* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. - -## AccessReviewRecurrencePattern -### Properties -* **interval**: int (WriteOnly): The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. -* **type**: 'absoluteMonthly' | 'weekly' | string (WriteOnly): The recurrence type : weekly, monthly, etc. - -## AccessReviewRecurrenceRange +## AccessReviewScope ### Properties -* **endDate**: string (WriteOnly): The DateTime when the review is scheduled to end. Required if type is endDate -* **numberOfOccurrences**: int (WriteOnly): The number of times to repeat the access review. Required and must be positive if type is numbered. -* **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. -* **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. +* **assignmentState**: 'active' | 'eligible' | string (ReadOnly, WriteOnly): The role assignment state eligible/active to review +* **inactiveDuration**: string (WriteOnly): Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) +* **principalType**: 'guestUser' | 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review +* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created +* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed diff --git a/generated/authorization/microsoft.authorization/2021-07-01-preview/types.md b/generated/authorization/microsoft.authorization/2021-07-01-preview/types.md index 69fdc6d06c..d5712a2ef5 100644 --- a/generated/authorization/microsoft.authorization/2021-07-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2021-07-01-preview/types.md @@ -54,11 +54,6 @@ * **reminderNotificationsEnabled**: bool (WriteOnly): Flag to indicate whether sending reminder emails to reviewers are enabled. * **type**: 'Microsoft.Authorization/accessReviewScheduleSettings' (ReadOnly, DeployTimeConstant): The resource type -## AccessReviewReviewer -### Properties -* **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) -* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal - ## AccessReviewActorIdentity ### Properties * **principalId**: string (ReadOnly, WriteOnly): The identity id @@ -82,6 +77,28 @@ * **startDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to be start. * **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly, WriteOnly): This read-only field specifies the status of an access review instance. +## AccessReviewRecurrencePattern +### Properties +* **interval**: int (WriteOnly): The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. +* **type**: 'absoluteMonthly' | 'weekly' | string (WriteOnly): The recurrence type : weekly, monthly, etc. + +## AccessReviewRecurrenceRange +### Properties +* **endDate**: string (WriteOnly): The DateTime when the review is scheduled to end. Required if type is endDate +* **numberOfOccurrences**: int (WriteOnly): The number of times to repeat the access review. Required and must be positive if type is numbered. +* **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. +* **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. + +## AccessReviewRecurrenceSettings +### Properties +* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. +* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. + +## AccessReviewReviewer +### Properties +* **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) +* **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal + ## AccessReviewScheduleDefinitionProperties ### Properties * **backupReviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (ReadOnly): This is the collection of backup reviewers. @@ -96,15 +113,6 @@ * **settings**: [AccessReviewScheduleSettings](#accessreviewschedulesettings) (ReadOnly): Settings of an Access Review. * **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly): This read-only field specifies the status of an accessReview. -## AccessReviewScope -### Properties -* **assignmentState**: 'active' | 'eligible' | string (ReadOnly, WriteOnly): The role assignment state eligible/active to review -* **expandNestedMemberships**: bool (WriteOnly): Flag to indicate whether to expand nested memberships or not. -* **inactiveDuration**: string (WriteOnly): Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) -* **principalType**: 'guestUser' | 'redeemedGuestUser' | 'servicePrincipal' | 'user' | 'user,group' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review -* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created -* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed - ## AccessReviewScheduleSettings ### Properties * **autoApplyDecisionsEnabled**: bool (WriteOnly): Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review. @@ -118,20 +126,12 @@ * **recurrence**: [AccessReviewRecurrenceSettings](#accessreviewrecurrencesettings) (WriteOnly): Recurrence Settings of an Access Review Schedule Definition. * **reminderNotificationsEnabled**: bool (WriteOnly): Flag to indicate whether sending reminder emails to reviewers are enabled. -## AccessReviewRecurrenceSettings -### Properties -* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. -* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. - -## AccessReviewRecurrencePattern -### Properties -* **interval**: int (WriteOnly): The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. -* **type**: 'absoluteMonthly' | 'weekly' | string (WriteOnly): The recurrence type : weekly, monthly, etc. - -## AccessReviewRecurrenceRange +## AccessReviewScope ### Properties -* **endDate**: string (WriteOnly): The DateTime when the review is scheduled to end. Required if type is endDate -* **numberOfOccurrences**: int (WriteOnly): The number of times to repeat the access review. Required and must be positive if type is numbered. -* **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. -* **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. +* **assignmentState**: 'active' | 'eligible' | string (ReadOnly, WriteOnly): The role assignment state eligible/active to review +* **expandNestedMemberships**: bool (WriteOnly): Flag to indicate whether to expand nested memberships or not. +* **inactiveDuration**: string (WriteOnly): Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) +* **principalType**: 'guestUser' | 'redeemedGuestUser' | 'servicePrincipal' | 'user' | 'user,group' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review +* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created +* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed diff --git a/generated/authorization/microsoft.authorization/2021-11-16-preview/types.md b/generated/authorization/microsoft.authorization/2021-11-16-preview/types.md index 672aaf2121..e5575b7e84 100644 --- a/generated/authorization/microsoft.authorization/2021-11-16-preview/types.md +++ b/generated/authorization/microsoft.authorization/2021-11-16-preview/types.md @@ -80,6 +80,19 @@ * **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal * **userPrincipalName**: string (ReadOnly, WriteOnly): The user principal name(if valid) +## AccessReviewHistoryDefinitionProperties +### Properties +* **createdBy**: [AccessReviewActorIdentity](#accessreviewactoridentity) (ReadOnly): Details of the actor identity +* **createdDateTime**: string (ReadOnly): Date time when history definition was created +* **decisions**: 'Approve' | 'Deny' | 'DontKnow' | 'NotNotified' | 'NotReviewed' | string[] (ReadOnly): Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request. +* **displayName**: string (ReadOnly): The display name for the history definition. +* **instances**: [AccessReviewHistoryInstance](#accessreviewhistoryinstance)[] (ReadOnly): Set of access review history instances for this history definition. +* **reviewHistoryPeriodEndDateTime**: string (ReadOnly): Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports. +* **reviewHistoryPeriodStartDateTime**: string (ReadOnly): Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports. +* **scopes**: [AccessReviewScope](#accessreviewscope)[] (ReadOnly): A collection of scopes used when selecting review history data +* **settings**: [AccessReviewHistoryScheduleSettings](#accessreviewhistoryschedulesettings) (ReadOnly): Recurrence settings of an Access Review History Definition. +* **status**: 'Done' | 'Error' | 'InProgress' | 'Requested' | string (ReadOnly): This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. + ## AccessReviewHistoryInstance ### Properties * **id**: string (ReadOnly, WriteOnly): The access review history definition instance id. @@ -98,32 +111,26 @@ * **runDateTime**: string (WriteOnly): Date time when the history data report is scheduled to be generated. * **status**: 'Done' | 'Error' | 'InProgress' | 'Requested' | string (ReadOnly, WriteOnly): This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. -## AccessReviewHistoryDefinitionProperties +## AccessReviewHistoryScheduleSettings ### Properties -* **createdBy**: [AccessReviewActorIdentity](#accessreviewactoridentity) (ReadOnly): Details of the actor identity -* **createdDateTime**: string (ReadOnly): Date time when history definition was created -* **decisions**: 'Approve' | 'Deny' | 'DontKnow' | 'NotNotified' | 'NotReviewed' | string[] (ReadOnly): Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request. -* **displayName**: string (ReadOnly): The display name for the history definition. -* **instances**: [AccessReviewHistoryInstance](#accessreviewhistoryinstance)[] (ReadOnly): Set of access review history instances for this history definition. -* **reviewHistoryPeriodEndDateTime**: string (ReadOnly): Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports. -* **reviewHistoryPeriodStartDateTime**: string (ReadOnly): Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports. -* **scopes**: [AccessReviewScope](#accessreviewscope)[] (ReadOnly): A collection of scopes used when selecting review history data -* **settings**: [AccessReviewHistoryScheduleSettings](#accessreviewhistoryschedulesettings) (ReadOnly): Recurrence settings of an Access Review History Definition. -* **status**: 'Done' | 'Error' | 'InProgress' | 'Requested' | string (ReadOnly): This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error. +* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. +* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. -## AccessReviewScope +## AccessReviewInstance ### Properties -* **assignmentState**: 'active' | 'eligible' | string (ReadOnly, WriteOnly): The role assignment state eligible/active to review -* **expandNestedMemberships**: bool (WriteOnly): Flag to indicate whether to expand nested memberships or not. -* **inactiveDuration**: string (WriteOnly): Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) -* **principalType**: 'guestUser' | 'redeemedGuestUser' | 'servicePrincipal' | 'user' | 'user,group' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review -* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created -* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed +* **id**: string (ReadOnly, WriteOnly): The access review instance id. +* **name**: string (ReadOnly, WriteOnly): The access review instance name. +* **properties**: [AccessReviewInstanceProperties](#accessreviewinstanceproperties) (WriteOnly): Access Review Instance properties. +* **type**: string (ReadOnly, WriteOnly): The resource type. -## AccessReviewHistoryScheduleSettings +## AccessReviewInstanceProperties ### Properties -* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. -* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. +* **backupReviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (WriteOnly): This is the collection of backup reviewers. +* **endDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to end. +* **reviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (WriteOnly): This is the collection of reviewers. +* **reviewersType**: 'Assigned' | 'Managers' | 'Self' | string (ReadOnly, WriteOnly): This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. +* **startDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to be start. +* **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly, WriteOnly): This read-only field specifies the status of an access review instance. ## AccessReviewRecurrencePattern ### Properties @@ -137,27 +144,16 @@ * **startDate**: string (WriteOnly): The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. * **type**: 'endDate' | 'noEnd' | 'numbered' | string (WriteOnly): The recurrence range type. The possible values are: endDate, noEnd, numbered. +## AccessReviewRecurrenceSettings +### Properties +* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. +* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. + ## AccessReviewReviewer ### Properties * **principalId**: string (WriteOnly): The id of the reviewer(user/servicePrincipal) * **principalType**: 'servicePrincipal' | 'user' | string (ReadOnly, WriteOnly): The identity type : user/servicePrincipal -## AccessReviewInstance -### Properties -* **id**: string (ReadOnly, WriteOnly): The access review instance id. -* **name**: string (ReadOnly, WriteOnly): The access review instance name. -* **properties**: [AccessReviewInstanceProperties](#accessreviewinstanceproperties) (WriteOnly): Access Review Instance properties. -* **type**: string (ReadOnly, WriteOnly): The resource type. - -## AccessReviewInstanceProperties -### Properties -* **backupReviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (WriteOnly): This is the collection of backup reviewers. -* **endDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to end. -* **reviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (WriteOnly): This is the collection of reviewers. -* **reviewersType**: 'Assigned' | 'Managers' | 'Self' | string (ReadOnly, WriteOnly): This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. -* **startDateTime**: string (WriteOnly): The DateTime when the review instance is scheduled to be start. -* **status**: 'Applied' | 'Applying' | 'AutoReviewed' | 'AutoReviewing' | 'Completed' | 'Completing' | 'InProgress' | 'Initializing' | 'NotStarted' | 'Scheduled' | 'Starting' | string (ReadOnly, WriteOnly): This read-only field specifies the status of an access review instance. - ## AccessReviewScheduleDefinitionProperties ### Properties * **backupReviewers**: [AccessReviewReviewer](#accessreviewreviewer)[] (ReadOnly): This is the collection of backup reviewers. @@ -185,8 +181,12 @@ * **recurrence**: [AccessReviewRecurrenceSettings](#accessreviewrecurrencesettings) (WriteOnly): Recurrence Settings of an Access Review Schedule Definition. * **reminderNotificationsEnabled**: bool (WriteOnly): Flag to indicate whether sending reminder emails to reviewers are enabled. -## AccessReviewRecurrenceSettings +## AccessReviewScope ### Properties -* **pattern**: [AccessReviewRecurrencePattern](#accessreviewrecurrencepattern) (WriteOnly): Recurrence Pattern of an Access Review Schedule Definition. -* **range**: [AccessReviewRecurrenceRange](#accessreviewrecurrencerange) (WriteOnly): Recurrence Range of an Access Review Schedule Definition. +* **assignmentState**: 'active' | 'eligible' | string (ReadOnly, WriteOnly): The role assignment state eligible/active to review +* **expandNestedMemberships**: bool (WriteOnly): Flag to indicate whether to expand nested memberships or not. +* **inactiveDuration**: string (WriteOnly): Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) +* **principalType**: 'guestUser' | 'redeemedGuestUser' | 'servicePrincipal' | 'user' | 'user,group' | string (ReadOnly, WriteOnly): The identity type user/servicePrincipal to review +* **resourceId**: string (ReadOnly, WriteOnly): ResourceId in which this review is getting created +* **roleDefinitionId**: string (ReadOnly, WriteOnly): This is used to indicate the role being reviewed diff --git a/generated/authorization/microsoft.authorization/2022-04-01-preview/types.md b/generated/authorization/microsoft.authorization/2022-04-01-preview/types.md index 13b0f7be8a..8d9b9ff00a 100644 --- a/generated/authorization/microsoft.authorization/2022-04-01-preview/types.md +++ b/generated/authorization/microsoft.authorization/2022-04-01-preview/types.md @@ -18,27 +18,6 @@ * **properties**: [RoleEligibilityScheduleRequestProperties](#roleeligibilityschedulerequestproperties): Role eligibility schedule request properties with scope. * **type**: 'Microsoft.Authorization/roleEligibilityScheduleRequests' (ReadOnly, DeployTimeConstant): The resource type -## RoleAssignmentScheduleRequestProperties -### Properties -* **approvalId**: string (ReadOnly): The approvalId of the role assignment schedule request. -* **condition**: string: The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' -* **conditionVersion**: string: Version of the condition. Currently accepted value is '2.0' -* **createdOn**: string (ReadOnly): DateTime when role assignment schedule request was created -* **expandedProperties**: [ExpandedProperties](#expandedproperties) (ReadOnly): Expanded info of resource, role and principal -* **justification**: string: Justification for the role assignment -* **linkedRoleEligibilityScheduleId**: string: The linked role eligibility schedule id - to activate an eligibility. -* **principalId**: string (Required): The principal ID. -* **principalType**: 'Device' | 'ForeignGroup' | 'Group' | 'ServicePrincipal' | 'User' | string (ReadOnly): The principal type of the assigned principal ID. -* **requestorId**: string (ReadOnly): Id of the user who created this request -* **requestType**: 'AdminAssign' | 'AdminExtend' | 'AdminRemove' | 'AdminRenew' | 'AdminUpdate' | 'SelfActivate' | 'SelfDeactivate' | 'SelfExtend' | 'SelfRenew' | string (Required): The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc -* **roleDefinitionId**: string (Required): The role definition ID. -* **scheduleInfo**: [RoleAssignmentScheduleRequestPropertiesScheduleInfo](#roleassignmentschedulerequestpropertiesscheduleinfo): Schedule info of the role assignment schedule -* **scope**: string (ReadOnly): The role assignment schedule request scope. -* **status**: 'Accepted' | 'AdminApproved' | 'AdminDenied' | 'Canceled' | 'Denied' | 'Failed' | 'FailedAsResourceIsLocked' | 'Granted' | 'Invalid' | 'PendingAdminDecision' | 'PendingApproval' | 'PendingApprovalProvisioning' | 'PendingEvaluation' | 'PendingExternalProvisioning' | 'PendingProvisioning' | 'PendingRevocation' | 'PendingScheduleCreation' | 'Provisioned' | 'ProvisioningStarted' | 'Revoked' | 'ScheduleCreated' | 'TimedOut' | string (ReadOnly): The status of the role assignment schedule request. -* **targetRoleAssignmentScheduleId**: string: The resultant role assignment schedule id or the role assignment schedule id being updated -* **targetRoleAssignmentScheduleInstanceId**: string: The role assignment schedule instance id being updated -* **ticketInfo**: [RoleAssignmentScheduleRequestPropertiesTicketInfo](#roleassignmentschedulerequestpropertiesticketinfo): Ticket Info of the role assignment - ## ExpandedProperties ### Properties * **principal**: [ExpandedPropertiesPrincipal](#expandedpropertiesprincipal): Details of the principal @@ -64,6 +43,27 @@ * **id**: string: Scope id of the resource * **type**: string: Type of the resource +## RoleAssignmentScheduleRequestProperties +### Properties +* **approvalId**: string (ReadOnly): The approvalId of the role assignment schedule request. +* **condition**: string: The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' +* **conditionVersion**: string: Version of the condition. Currently accepted value is '2.0' +* **createdOn**: string (ReadOnly): DateTime when role assignment schedule request was created +* **expandedProperties**: [ExpandedProperties](#expandedproperties) (ReadOnly): Expanded info of resource, role and principal +* **justification**: string: Justification for the role assignment +* **linkedRoleEligibilityScheduleId**: string: The linked role eligibility schedule id - to activate an eligibility. +* **principalId**: string (Required): The principal ID. +* **principalType**: 'Device' | 'ForeignGroup' | 'Group' | 'ServicePrincipal' | 'User' | string (ReadOnly): The principal type of the assigned principal ID. +* **requestorId**: string (ReadOnly): Id of the user who created this request +* **requestType**: 'AdminAssign' | 'AdminExtend' | 'AdminRemove' | 'AdminRenew' | 'AdminUpdate' | 'SelfActivate' | 'SelfDeactivate' | 'SelfExtend' | 'SelfRenew' | string (Required): The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc +* **roleDefinitionId**: string (Required): The role definition ID. +* **scheduleInfo**: [RoleAssignmentScheduleRequestPropertiesScheduleInfo](#roleassignmentschedulerequestpropertiesscheduleinfo): Schedule info of the role assignment schedule +* **scope**: string (ReadOnly): The role assignment schedule request scope. +* **status**: 'Accepted' | 'AdminApproved' | 'AdminDenied' | 'Canceled' | 'Denied' | 'Failed' | 'FailedAsResourceIsLocked' | 'Granted' | 'Invalid' | 'PendingAdminDecision' | 'PendingApproval' | 'PendingApprovalProvisioning' | 'PendingEvaluation' | 'PendingExternalProvisioning' | 'PendingProvisioning' | 'PendingRevocation' | 'PendingScheduleCreation' | 'Provisioned' | 'ProvisioningStarted' | 'Revoked' | 'ScheduleCreated' | 'TimedOut' | string (ReadOnly): The status of the role assignment schedule request. +* **targetRoleAssignmentScheduleId**: string: The resultant role assignment schedule id or the role assignment schedule id being updated +* **targetRoleAssignmentScheduleInstanceId**: string: The role assignment schedule instance id being updated +* **ticketInfo**: [RoleAssignmentScheduleRequestPropertiesTicketInfo](#roleassignmentschedulerequestpropertiesticketinfo): Ticket Info of the role assignment + ## RoleAssignmentScheduleRequestPropertiesScheduleInfo ### Properties * **expiration**: [RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration](#roleassignmentschedulerequestpropertiesscheduleinfoexpiration): Expiration of the role assignment schedule diff --git a/generated/automanage/log.out b/generated/automanage/log.out index 4f731c0491..ab5392a680 100644 --- a/generated/automanage/log.out +++ b/generated/automanage/log.out @@ -6,25 +6,25 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.automanage-2021-04-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.automanage-2020-06-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Account' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json:989:5 @@ -62,5 +62,5 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json:1335:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms -info | Autorest completed in 8.03s. 4 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 7.74s. 4 files generated. diff --git a/generated/automanage/microsoft.automanage/2020-06-30-preview/types.md b/generated/automanage/microsoft.automanage/2020-06-30-preview/types.md index dcfb65a897..0e186e01cc 100644 --- a/generated/automanage/microsoft.automanage/2020-06-30-preview/types.md +++ b/generated/automanage/microsoft.automanage/2020-06-30-preview/types.md @@ -37,10 +37,9 @@ * **tenantId**: string (ReadOnly): The tenant id associated with the Automanage account. * **type**: 'None' | 'SystemAssigned': The type of identity used for the Automanage account. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. -## TrackedResourceTags +## ConfigurationProfileAssignmentCompliance ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **updateStatus**: 'Created' | 'Failed' | 'Succeeded' | string (ReadOnly): The state of compliance, which only appears in the response. ## ConfigurationProfileAssignmentProperties ### Properties @@ -51,15 +50,6 @@ * **provisioningState**: 'Created' | 'Failed' | 'Succeeded' | string (ReadOnly): The state of onboarding, which only appears in the response. * **targetId**: string: The target VM resource URI -## ConfigurationProfileAssignmentCompliance -### Properties -* **updateStatus**: 'Created' | 'Failed' | 'Succeeded' | string (ReadOnly): The state of compliance, which only appears in the response. - -## ConfigurationProfilePreferenceProperties -### Properties -* **antiMalware**: [ConfigurationProfilePreferenceAntiMalware](#configurationprofilepreferenceantimalware): Automanage configuration profile Antimalware preferences. -* **vmBackup**: [ConfigurationProfilePreferenceVmBackup](#configurationprofilepreferencevmbackup): Automanage configuration profile VM Backup preferences. - ## ConfigurationProfilePreferenceAntiMalware ### Properties * **enableRealTimeProtection**: 'False' | 'True' | string: Enables or disables Real Time Protection @@ -69,6 +59,11 @@ * **scanTimeInMinutes**: string: Schedule scan settings time * **scanType**: 'Full' | 'Quick' | string: Type of scheduled scan +## ConfigurationProfilePreferenceProperties +### Properties +* **antiMalware**: [ConfigurationProfilePreferenceAntiMalware](#configurationprofilepreferenceantimalware): Automanage configuration profile Antimalware preferences. +* **vmBackup**: [ConfigurationProfilePreferenceVmBackup](#configurationprofilepreferencevmbackup): Automanage configuration profile VM Backup preferences. + ## ConfigurationProfilePreferenceVmBackup ### Properties * **instantRpRetentionRangeInDays**: int: Instant RP retention policy range in days @@ -81,3 +76,8 @@ ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/automanage/microsoft.automanage/2021-04-30-preview/types.md b/generated/automanage/microsoft.automanage/2021-04-30-preview/types.md index ce6f9ddd50..3568e91dbb 100644 --- a/generated/automanage/microsoft.automanage/2021-04-30-preview/types.md +++ b/generated/automanage/microsoft.automanage/2021-04-30-preview/types.md @@ -34,6 +34,11 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Automanage/configurationProfiles/versions' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProfileAssignmentProfileOverrides +### Properties +### Additional Properties +* **Additional Properties Type**: any + ## ConfigurationProfileAssignmentProperties ### Properties * **configurationProfile**: string: The Automanage configurationProfile ARM Resource URI. @@ -41,10 +46,10 @@ * **status**: string (ReadOnly): The status of onboarding, which only appears in the response. * **targetId**: string: The target VM resource URI -## ConfigurationProfileAssignmentProfileOverrides +## ConfigurationProfileProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **configuration**: any: Any object +* **overrides**: any[]: The custom overrides for configuration profile ## SystemData ### Properties @@ -55,11 +60,6 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ConfigurationProfileProperties -### Properties -* **configuration**: any: Any object -* **overrides**: any[]: The custom overrides for configuration profile - ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/automation/log.out b/generated/automation/log.out index 7e9e82ead5..1fbfd60c80 100644 --- a/generated/automation/log.out +++ b/generated/automation/log.out @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.automation-2015-10-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -32,7 +32,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutomationAccount' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/account.json:500:5 @@ -391,7 +391,7 @@ warning | Modeler/MissingType | The schema 'ScheduleCreateOrUpdateProperties-int warning | Modeler/MissingType | The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json#/components/schemas/ScheduleProperties-interval info | Resource type microsoft.automation/automationaccounts/runbooks/draft under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content' has no body defined. -info | autorest.bicep took 21ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.automation-2017-05-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -407,7 +407,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'softwareUpdateConfigurationProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json:310:5 @@ -513,7 +513,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DscNodeReportListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json:581:5 @@ -588,7 +588,7 @@ warning | PreCheck/SchemaMissingType | The schema 'NodeCount' with an undefined warning | PreCheck/SchemaMissingType | The schema 'NodeCountProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json:120:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.automation-2018-06-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -604,7 +604,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobStream' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/runbook.json:1040:5 @@ -692,7 +692,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/Superflous type information | 'The schema paths·r1whch·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-automation-automationaccounts-automationaccountname-runbooks-runbookname-draft-content·get·responses·200·content·text-powershell·schema with 'type: string', format: binary' will be treated as a binary blob for binary media types. warning | Modeler/Superflous type information | 'The schema paths·1tf2s8z·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-automation-automationaccounts-automationaccountname-runbooks-runbookname-content·get·responses·200·content·text-powershell·schema with 'type: string', format: binary' will be treated as a binary blob for binary media types. info | Resource type microsoft.automation/automationaccounts/runbooks/draft under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content' has no body defined. -info | autorest.bicep took 5ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.automation-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -708,7 +708,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobStream' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/runbook.json:1037:5 @@ -1172,7 +1172,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ActivityParameter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/python2package.json:312:5 @@ -1526,7 +1526,7 @@ warning | Modeler/MissingType | The schema 'ScheduleCreateOrUpdateProperties-int warning | Modeler/MissingType | The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/schedule.json#/components/schemas/ScheduleProperties-interval warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.automation-2021-06-22"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1542,7 +1542,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutomationAccount' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/account.json:469:5 @@ -1596,7 +1596,7 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridRunbookWorker' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/hybridRunbookWorker.json:351:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.automation-2022-01-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1612,8 +1612,8 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 59.81s. 14 files generated. +info | Autorest completed in 57.08s. 14 files generated. diff --git a/generated/automation/microsoft.automation/2015-10-31/types.md b/generated/automation/microsoft.automation/2015-10-31/types.md index 3c1ef8ff66..05cf63f5c0 100644 --- a/generated/automation/microsoft.automation/2015-10-31/types.md +++ b/generated/automation/microsoft.automation/2015-10-31/types.md @@ -201,26 +201,31 @@ * **ApiVersion**: 2015-10-31 * **Output**: [KeyListResult](#keylistresult) -## AutomationAccountCreateOrUpdateProperties +## AdvancedSchedule ### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string (ReadOnly): Gets or sets the description. -* **lastModifiedBy**: string (ReadOnly): Gets or sets the last modified by. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. -* **sku**: [Sku](#sku): The account SKU. -* **state**: 'Ok' | 'Suspended' | 'Unavailable' | string (ReadOnly): Gets status of account. +* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. +* **weekDays**: string[]: Days of the week that the job should execute on. -## Sku +## AdvancedScheduleMonthlyOccurrence ### Properties -* **capacity**: int: Gets or sets the SKU capacity. -* **family**: string: Gets or sets the SKU family. -* **name**: 'Basic' | 'Free' | string (Required): Gets or sets the SKU name of the account. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 ## AutomationAccountCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## AutomationAccountCreateOrUpdateProperties +### Properties +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string (ReadOnly): Gets or sets the description. +* **lastModifiedBy**: string (ReadOnly): Gets or sets the last modified by. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. +* **sku**: [Sku](#sku): The account SKU. +* **state**: 'Ok' | 'Suspended' | 'Unavailable' | string (ReadOnly): Gets status of account. + ## CertificateCreateOrUpdateProperties ### Properties * **base64Value**: string (Required, WriteOnly): Gets or sets the base64 encoded value of the certificate. @@ -231,6 +236,67 @@ * **lastModifiedTime**: string (ReadOnly): Gets the last modified time. * **thumbprint**: string: Gets or sets the thumbprint of the certificate. +## ConnectionCreateOrUpdateProperties +### Properties +* **connectionType**: [ConnectionTypeAssociationProperty](#connectiontypeassociationproperty) (Required): The connection type property associated with the entity. +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string: Gets or sets the description of the connection. +* **fieldDefinitionValues**: [ConnectionCreateOrUpdatePropertiesFieldDefinitionValues](#connectioncreateorupdatepropertiesfielddefinitionvalues): Gets or sets the field definition properties of the connection. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. + +## ConnectionCreateOrUpdatePropertiesFieldDefinitionValues +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ConnectionTypeAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the connection type. + +## ConnectionTypeCreateOrUpdateProperties +### Properties +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string (ReadOnly): Gets or sets the description. +* **fieldDefinitions**: [ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions](#connectiontypecreateorupdatepropertiesfielddefinitions) (Required): Gets or sets the field definitions of the connection type. +* **isGlobal**: bool: Gets or sets a Boolean value to indicate if the connection type is global. +* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. + +## ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions +### Properties +### Additional Properties +* **Additional Properties Type**: [FieldDefinition](#fielddefinition) + +## ContentHash +### Properties +* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. +* **value**: string (Required): Gets or sets expected hash value of the content. + +## ContentLink +### Properties +* **contentHash**: [ContentHash](#contenthash): Definition of the runbook property type. +* **uri**: string: Gets or sets the uri of the runbook content. +* **version**: string: Gets or sets the version of the content. + +## ContentSource +### Properties +* **hash**: [ContentHash](#contenthash): Definition of the runbook property type. +* **type**: 'embeddedContent' | 'uri' | string: Gets or sets the content source type. +* **value**: string: Gets or sets the value of the content. This is based on the content source type. +* **version**: string: Gets or sets the version of the content. + +## CredentialCreateOrUpdateProperties +### Properties +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string: Gets or sets the description of the credential. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. +* **password**: string (Required, WriteOnly): Gets or sets the password of the credential. +* **userName**: string (Required): Gets or sets the user name of the credential. + +## DscCompilationJobCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DscCompilationJobCreateProperties ### Properties * **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. @@ -249,16 +315,16 @@ * **status**: 'Activating' | 'Blocked' | 'Completed' | 'Disconnected' | 'Failed' | 'New' | 'Removing' | 'Resuming' | 'Running' | 'Stopped' | 'Stopping' | 'Suspended' | 'Suspending' | string (ReadOnly): Gets or sets the status of the job. * **statusDetails**: string (ReadOnly): Gets or sets the status details of the job. -## DscConfigurationAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the Dsc configuration. - ## DscCompilationJobCreatePropertiesParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## DscCompilationJobCreateParametersTags +## DscConfigurationAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the Dsc configuration. + +## DscConfigurationCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -289,67 +355,12 @@ * **position**: int: Get or sets the position of the parameter. * **type**: string: Gets or sets the type of the parameter. -## ContentSource -### Properties -* **hash**: [ContentHash](#contenthash): Definition of the runbook property type. -* **type**: 'embeddedContent' | 'uri' | string: Gets or sets the content source type. -* **value**: string: Gets or sets the value of the content. This is based on the content source type. -* **version**: string: Gets or sets the version of the content. - -## ContentHash -### Properties -* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. -* **value**: string (Required): Gets or sets expected hash value of the content. - -## DscConfigurationCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionCreateOrUpdateProperties -### Properties -* **connectionType**: [ConnectionTypeAssociationProperty](#connectiontypeassociationproperty) (Required): The connection type property associated with the entity. -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the connection. -* **fieldDefinitionValues**: [ConnectionCreateOrUpdatePropertiesFieldDefinitionValues](#connectioncreateorupdatepropertiesfielddefinitionvalues): Gets or sets the field definition properties of the connection. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. - -## ConnectionTypeAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the connection type. - -## ConnectionCreateOrUpdatePropertiesFieldDefinitionValues -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionTypeCreateOrUpdateProperties -### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string (ReadOnly): Gets or sets the description. -* **fieldDefinitions**: [ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions](#connectiontypecreateorupdatepropertiesfielddefinitions) (Required): Gets or sets the field definitions of the connection type. -* **isGlobal**: bool: Gets or sets a Boolean value to indicate if the connection type is global. -* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. - -## ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions -### Properties -### Additional Properties -* **Additional Properties Type**: [FieldDefinition](#fielddefinition) - ## FieldDefinition ### Properties * **isEncrypted**: bool: Gets or sets the isEncrypted flag of the connection field definition. * **isOptional**: bool: Gets or sets the isOptional flag of the connection field definition. * **type**: string (Required): Gets or sets the type of the connection field definition. -## CredentialCreateOrUpdateProperties -### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the credential. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. -* **password**: string (Required, WriteOnly): Gets or sets the password of the credential. -* **userName**: string (Required): Gets or sets the user name of the credential. - ## JobCreateProperties ### Properties * **creationTime**: string (ReadOnly): Gets or sets the creation time of the job. @@ -374,14 +385,6 @@ ### Additional Properties * **Additional Properties Type**: string -## RunbookAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the runbook. - -## ScheduleAssociationProperty -### Properties -* **name**: string (ReadOnly): Gets or sets the name of the Schedule. - ## JobScheduleCreateProperties ### Properties * **jobScheduleId**: string (ReadOnly): Gets or sets the id of job schedule. @@ -395,6 +398,21 @@ ### Additional Properties * **Additional Properties Type**: string +## Key +### Properties +* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. +* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. +* **Value**: string (ReadOnly): Value of the Automation Key used for registration. + +## KeyListResult +### Properties +* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. + +## ModuleCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ModuleCreateOrUpdateProperties ### Properties * **activityCount**: int (ReadOnly): Gets or sets the activity count of the module. @@ -409,18 +427,16 @@ * **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. * **version**: string (ReadOnly): Gets or sets the version of the module. -## ContentLink -### Properties -* **contentHash**: [ContentHash](#contenthash): Definition of the runbook property type. -* **uri**: string: Gets or sets the uri of the runbook content. -* **version**: string: Gets or sets the version of the content. - ## ModuleErrorInfo ### Properties * **code**: string (ReadOnly): Gets or sets the error code. * **message**: string (ReadOnly): Gets or sets the error message. -## ModuleCreateOrUpdateParametersTags +## RunbookAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the runbook. + +## RunbookCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -469,15 +485,9 @@ ### Additional Properties * **Additional Properties Type**: [RunbookParameter](#runbookparameter) -## RunbookCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TestJobCreateParameters +## ScheduleAssociationProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): Gets or sets the name of the Schedule. ## ScheduleCreateOrUpdateProperties ### Properties @@ -496,16 +506,21 @@ * **startTimeOffsetMinutes**: int (ReadOnly): Gets the start time's offset in minutes. * **timeZone**: string: Gets or sets the time zone of the schedule. -## AdvancedSchedule +## Sku ### Properties -* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. -* **weekDays**: string[]: Days of the week that the job should execute on. +* **capacity**: int: Gets or sets the SKU capacity. +* **family**: string: Gets or sets the SKU family. +* **name**: 'Basic' | 'Free' | string (Required): Gets or sets the SKU name of the account. -## AdvancedScheduleMonthlyOccurrence +## TestJobCreateParameters ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## VariableCreateOrUpdateProperties ### Properties @@ -532,11 +547,6 @@ ### Additional Properties * **Additional Properties Type**: string -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WebhookCreateOrUpdateProperties ### Properties * **creationTime**: string (ReadOnly): Gets or sets the creation time. @@ -556,13 +566,3 @@ ### Additional Properties * **Additional Properties Type**: string -## KeyListResult -### Properties -* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. - -## Key -### Properties -* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. -* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. -* **Value**: string (ReadOnly): Value of the Automation Key used for registration. - diff --git a/generated/automation/microsoft.automation/2017-05-15-preview/types.md b/generated/automation/microsoft.automation/2017-05-15-preview/types.md index da4374370b..537375d5ee 100644 --- a/generated/automation/microsoft.automation/2017-05-15-preview/types.md +++ b/generated/automation/microsoft.automation/2017-05-15-preview/types.md @@ -36,6 +36,28 @@ * **properties**: [SourceControlSyncJobCreateProperties](#sourcecontrolsyncjobcreateproperties) (Required): Definition of create source control sync job properties. * **type**: 'Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs' (ReadOnly, DeployTimeConstant): The resource type +## AdvancedSchedule +### Properties +* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. +* **weekDays**: string[]: Days of the week that the job should execute on. + +## AdvancedScheduleMonthlyOccurrence +### Properties +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 + +## AzureQueryProperties +### Properties +* **locations**: string[]: List of locations to scope the query to. +* **scope**: string[]: List of Subscription or Resource Group ARM Ids. +* **tagSettings**: [TagSettingsProperties](#tagsettingsproperties): Tag filter information for the VM. + +## ErrorResponse +### Properties +* **code**: string: Error code +* **message**: string: Error message indicating why the operation failed. + ## JobCreateProperties ### Properties * **creationTime**: string (ReadOnly): Gets or sets the creation time of the job. @@ -58,26 +80,21 @@ ### Additional Properties * **Additional Properties Type**: string -## RunbookAssociationProperty +## LinuxProperties ### Properties -* **name**: string: Gets or sets the name of the runbook. +* **excludedPackageNameMasks**: string[]: packages excluded from the software update configuration. +* **includedPackageClassifications**: 'Critical' | 'Other' | 'Security' | 'Unclassified' | string: Update classifications included in the software update configuration. +* **includedPackageNameMasks**: string[]: packages included from the software update configuration. +* **rebootSetting**: string: Reboot setting for the software update configuration. -## SoftwareUpdateConfigurationProperties +## NonAzureQueryProperties ### Properties -* **createdBy**: string (ReadOnly): CreatedBy property, which only appears in the response. -* **creationTime**: string (ReadOnly): Creation time of the resource, which only appears in the response. -* **error**: [ErrorResponse](#errorresponse): Error response of an operation failure -* **lastModifiedBy**: string (ReadOnly): LastModifiedBy property, which only appears in the response. -* **lastModifiedTime**: string (ReadOnly): Last time resource was modified, which only appears in the response. -* **provisioningState**: string (ReadOnly): Provisioning state for the software update configuration, which only appears in the response. -* **scheduleInfo**: [ScheduleProperties](#scheduleproperties) (Required): Definition of schedule parameters. -* **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. -* **updateConfiguration**: [UpdateConfiguration](#updateconfiguration) (Required): Update specific properties of the software update configuration. +* **functionAlias**: string: Log Analytics Saved Search name. +* **workspaceId**: string: Workspace Id for Log Analytics in which the saved Search is resided. -## ErrorResponse +## RunbookAssociationProperty ### Properties -* **code**: string: Error code -* **message**: string: Error message indicating why the operation failed. +* **name**: string: Gets or sets the name of the runbook. ## ScheduleProperties ### Properties @@ -96,82 +113,23 @@ * **startTimeOffsetMinutes**: int (ReadOnly): Gets the start time's offset in minutes. * **timeZone**: string: Gets or sets the time zone of the schedule. -## AdvancedSchedule -### Properties -* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. -* **weekDays**: string[]: Days of the week that the job should execute on. - -## AdvancedScheduleMonthlyOccurrence +## SoftwareUpdateConfigurationProperties ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 +* **createdBy**: string (ReadOnly): CreatedBy property, which only appears in the response. +* **creationTime**: string (ReadOnly): Creation time of the resource, which only appears in the response. +* **error**: [ErrorResponse](#errorresponse): Error response of an operation failure +* **lastModifiedBy**: string (ReadOnly): LastModifiedBy property, which only appears in the response. +* **lastModifiedTime**: string (ReadOnly): Last time resource was modified, which only appears in the response. +* **provisioningState**: string (ReadOnly): Provisioning state for the software update configuration, which only appears in the response. +* **scheduleInfo**: [ScheduleProperties](#scheduleproperties) (Required): Definition of schedule parameters. +* **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. +* **updateConfiguration**: [UpdateConfiguration](#updateconfiguration) (Required): Update specific properties of the software update configuration. ## SoftwareUpdateConfigurationTasks ### Properties * **postTask**: [TaskProperties](#taskproperties): Task properties of the software update configuration. * **preTask**: [TaskProperties](#taskproperties): Task properties of the software update configuration. -## TaskProperties -### Properties -* **parameters**: [TaskPropertiesParameters](#taskpropertiesparameters): Gets or sets the parameters of the task. -* **source**: string: Gets or sets the name of the runbook. - -## TaskPropertiesParameters -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## UpdateConfiguration -### Properties -* **azureVirtualMachines**: string[]: List of azure resource Ids for azure virtual machines targeted by the software update configuration. -* **duration**: 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 -* **linux**: [LinuxProperties](#linuxproperties): Linux specific update configuration. -* **nonAzureComputerNames**: string[]: List of names of non-azure machines targeted by the software update configuration. -* **operatingSystem**: 'Linux' | 'Windows' (Required): Target operating system for the software update configuration. -* **targets**: [TargetProperties](#targetproperties): Group specific to the update configuration. -* **windows**: [WindowsProperties](#windowsproperties): Windows specific update configuration. - -## LinuxProperties -### Properties -* **excludedPackageNameMasks**: string[]: packages excluded from the software update configuration. -* **includedPackageClassifications**: 'Critical' | 'Other' | 'Security' | 'Unclassified' | string: Update classifications included in the software update configuration. -* **includedPackageNameMasks**: string[]: packages included from the software update configuration. -* **rebootSetting**: string: Reboot setting for the software update configuration. - -## TargetProperties -### Properties -* **azureQueries**: [AzureQueryProperties](#azurequeryproperties)[]: List of Azure queries in the software update configuration. -* **nonAzureQueries**: [NonAzureQueryProperties](#nonazurequeryproperties)[]: List of non Azure queries in the software update configuration. - -## AzureQueryProperties -### Properties -* **locations**: string[]: List of locations to scope the query to. -* **scope**: string[]: List of Subscription or Resource Group ARM Ids. -* **tagSettings**: [TagSettingsProperties](#tagsettingsproperties): Tag filter information for the VM. - -## TagSettingsProperties -### Properties -* **filterOperator**: 'All' | 'Any': Filter VMs by Any or All specified tags. -* **tags**: [TagSettingsPropertiesTags](#tagsettingspropertiestags): Dictionary of tags with its list of values. - -## TagSettingsPropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string[] - -## NonAzureQueryProperties -### Properties -* **functionAlias**: string: Log Analytics Saved Search name. -* **workspaceId**: string: Workspace Id for Log Analytics in which the saved Search is resided. - -## WindowsProperties -### Properties -* **excludedKbNumbers**: string[]: KB numbers excluded from the software update configuration. -* **includedKbNumbers**: string[]: KB numbers included from the software update configuration. -* **includedUpdateClassifications**: 'Critical' | 'Definition' | 'FeaturePack' | 'Security' | 'ServicePack' | 'Tools' | 'Unclassified' | 'UpdateRollup' | 'Updates' | string: Update classification included in the software update configuration. A comma separated string with required values -* **rebootSetting**: string: Reboot setting for the software update configuration. - ## SourceControlCreateOrUpdateProperties ### Properties * **autoSync**: bool: The auto async of the source control. Default is false. @@ -202,3 +160,45 @@ * **startTime**: string (ReadOnly): The start time of the job. * **syncType**: 'FullSync' | 'PartialSync' | string (ReadOnly): The sync type. +## TagSettingsProperties +### Properties +* **filterOperator**: 'All' | 'Any': Filter VMs by Any or All specified tags. +* **tags**: [TagSettingsPropertiesTags](#tagsettingspropertiestags): Dictionary of tags with its list of values. + +## TagSettingsPropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## TargetProperties +### Properties +* **azureQueries**: [AzureQueryProperties](#azurequeryproperties)[]: List of Azure queries in the software update configuration. +* **nonAzureQueries**: [NonAzureQueryProperties](#nonazurequeryproperties)[]: List of non Azure queries in the software update configuration. + +## TaskProperties +### Properties +* **parameters**: [TaskPropertiesParameters](#taskpropertiesparameters): Gets or sets the parameters of the task. +* **source**: string: Gets or sets the name of the runbook. + +## TaskPropertiesParameters +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpdateConfiguration +### Properties +* **azureVirtualMachines**: string[]: List of azure resource Ids for azure virtual machines targeted by the software update configuration. +* **duration**: 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 +* **linux**: [LinuxProperties](#linuxproperties): Linux specific update configuration. +* **nonAzureComputerNames**: string[]: List of names of non-azure machines targeted by the software update configuration. +* **operatingSystem**: 'Linux' | 'Windows' (Required): Target operating system for the software update configuration. +* **targets**: [TargetProperties](#targetproperties): Group specific to the update configuration. +* **windows**: [WindowsProperties](#windowsproperties): Windows specific update configuration. + +## WindowsProperties +### Properties +* **excludedKbNumbers**: string[]: KB numbers excluded from the software update configuration. +* **includedKbNumbers**: string[]: KB numbers included from the software update configuration. +* **includedUpdateClassifications**: 'Critical' | 'Definition' | 'FeaturePack' | 'Security' | 'ServicePack' | 'Tools' | 'Unclassified' | 'UpdateRollup' | 'Updates' | string: Update classification included in the software update configuration. A comma separated string with required values +* **rebootSetting**: string: Reboot setting for the software update configuration. + diff --git a/generated/automation/microsoft.automation/2018-01-15/types.md b/generated/automation/microsoft.automation/2018-01-15/types.md index 553d4cd5dc..4fb5948f0e 100644 --- a/generated/automation/microsoft.automation/2018-01-15/types.md +++ b/generated/automation/microsoft.automation/2018-01-15/types.md @@ -21,6 +21,23 @@ * **tags**: [DscNodeConfigurationCreateOrUpdateParametersTags](#dscnodeconfigurationcreateorupdateparameterstags) (WriteOnly): Gets or sets the tags attached to the resource. * **type**: 'Microsoft.Automation/automationAccounts/nodeConfigurations' (ReadOnly, DeployTimeConstant): The resource type +## ContentHash +### Properties +* **algorithm**: string (Required, WriteOnly): Gets or sets the content hash algorithm used to hash the content. +* **value**: string (Required, WriteOnly): Gets or sets expected hash value of the content. + +## ContentSource +### Properties +* **hash**: [ContentHash](#contenthash) (WriteOnly): Definition of the runbook property type. +* **type**: 'embeddedContent' | 'uri' | string (WriteOnly): Gets or sets the content source type. +* **value**: string (WriteOnly): Gets or sets the value of the content. This is based on the content source type. +* **version**: string (WriteOnly): Gets or sets the version of the content. + +## DscCompilationJobCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DscCompilationJobCreateProperties ### Properties * **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. @@ -39,19 +56,14 @@ * **status**: 'Activating' | 'Blocked' | 'Completed' | 'Disconnected' | 'Failed' | 'New' | 'Removing' | 'Resuming' | 'Running' | 'Stopped' | 'Stopping' | 'Suspended' | 'Suspending' | string (ReadOnly): Gets or sets the status of the job. * **statusDetails**: string (ReadOnly): Gets or sets the status details of the job. -## DscConfigurationAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the Dsc configuration. - ## DscCompilationJobCreatePropertiesParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## DscCompilationJobCreateParametersTags +## DscConfigurationAssociationProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Gets or sets the name of the Dsc configuration. ## DscNodeConfigurationCreateOrUpdateParametersProperties ### Properties @@ -62,18 +74,6 @@ * **nodeCount**: int (ReadOnly): Number of nodes with this node configuration assigned * **source**: [ContentSource](#contentsource) (Required): Definition of the content source. -## ContentSource -### Properties -* **hash**: [ContentHash](#contenthash) (WriteOnly): Definition of the runbook property type. -* **type**: 'embeddedContent' | 'uri' | string (WriteOnly): Gets or sets the content source type. -* **value**: string (WriteOnly): Gets or sets the value of the content. This is based on the content source type. -* **version**: string (WriteOnly): Gets or sets the version of the content. - -## ContentHash -### Properties -* **algorithm**: string (Required, WriteOnly): Gets or sets the content hash algorithm used to hash the content. -* **value**: string (Required, WriteOnly): Gets or sets expected hash value of the content. - ## DscNodeConfigurationCreateOrUpdateParametersTags ### Properties ### Additional Properties diff --git a/generated/automation/microsoft.automation/2018-06-30/types.md b/generated/automation/microsoft.automation/2018-06-30/types.md index bde83f8147..f75d441614 100644 --- a/generated/automation/microsoft.automation/2018-06-30/types.md +++ b/generated/automation/microsoft.automation/2018-06-30/types.md @@ -55,19 +55,10 @@ * **type**: 'Microsoft.Automation/automationAccounts/runbooks/draft' (ReadOnly, DeployTimeConstant): The resource type -## PythonPackageCreateProperties +## ContentHash ### Properties -* **activityCount**: int (ReadOnly): Gets or sets the activity count of the module. -* **contentLink**: [ContentLink](#contentlink) (Required): Definition of the content link. -* **creationTime**: string (ReadOnly): Gets or sets the creation time. -* **description**: string (ReadOnly): Gets or sets the description. -* **error**: [ModuleErrorInfo](#moduleerrorinfo) (ReadOnly): Definition of the module error info type. -* **isComposite**: bool (ReadOnly): Gets or sets type of module, if its composite or not. -* **isGlobal**: bool (ReadOnly): Gets or sets the isGlobal flag of the module. -* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. -* **provisioningState**: 'ActivitiesStored' | 'Cancelled' | 'ConnectionTypeImported' | 'ContentDownloaded' | 'ContentRetrieved' | 'ContentStored' | 'ContentValidated' | 'Created' | 'Creating' | 'Failed' | 'ModuleDataStored' | 'ModuleImportRunbookComplete' | 'RunningImportModuleRunbook' | 'StartingImportModuleRunbook' | 'Succeeded' | 'Updating' (ReadOnly): Gets or sets the provisioning state of the module. -* **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. -* **version**: string (ReadOnly): Gets or sets the version of the module. +* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. +* **value**: string (Required): Gets or sets expected hash value of the content. ## ContentLink ### Properties @@ -75,11 +66,6 @@ * **uri**: string: Gets or sets the uri of the runbook content. * **version**: string: Gets or sets the version of the content. -## ContentHash -### Properties -* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. -* **value**: string (Required): Gets or sets expected hash value of the content. - ## ModuleErrorInfo ### Properties * **code**: string (ReadOnly): Gets or sets the error code. @@ -90,6 +76,25 @@ ### Additional Properties * **Additional Properties Type**: string +## PythonPackageCreateProperties +### Properties +* **activityCount**: int (ReadOnly): Gets or sets the activity count of the module. +* **contentLink**: [ContentLink](#contentlink) (Required): Definition of the content link. +* **creationTime**: string (ReadOnly): Gets or sets the creation time. +* **description**: string (ReadOnly): Gets or sets the description. +* **error**: [ModuleErrorInfo](#moduleerrorinfo) (ReadOnly): Definition of the module error info type. +* **isComposite**: bool (ReadOnly): Gets or sets type of module, if its composite or not. +* **isGlobal**: bool (ReadOnly): Gets or sets the isGlobal flag of the module. +* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. +* **provisioningState**: 'ActivitiesStored' | 'Cancelled' | 'ConnectionTypeImported' | 'ContentDownloaded' | 'ContentRetrieved' | 'ContentStored' | 'ContentValidated' | 'Created' | 'Creating' | 'Failed' | 'ModuleDataStored' | 'ModuleImportRunbookComplete' | 'RunningImportModuleRunbook' | 'StartingImportModuleRunbook' | 'Succeeded' | 'Updating' (ReadOnly): Gets or sets the provisioning state of the module. +* **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. +* **version**: string (ReadOnly): Gets or sets the version of the module. + +## RunbookCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## RunbookCreateOrUpdateProperties ### Properties * **creationTime**: string (ReadOnly): Gets or sets the creation time. @@ -134,11 +139,6 @@ ### Additional Properties * **Additional Properties Type**: [RunbookParameter](#runbookparameter) -## RunbookCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TestJobCreateParameters ### Properties ### Additional Properties diff --git a/generated/automation/microsoft.automation/2019-06-01/types.md b/generated/automation/microsoft.automation/2019-06-01/types.md index 7ced0ec902..452dcafb4b 100644 --- a/generated/automation/microsoft.automation/2019-06-01/types.md +++ b/generated/automation/microsoft.automation/2019-06-01/types.md @@ -228,6 +228,22 @@ * **ApiVersion**: 2019-06-01 * **Output**: [KeyListResult](#keylistresult) +## AdvancedSchedule +### Properties +* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. +* **weekDays**: string[]: Days of the week that the job should execute on. + +## AdvancedScheduleMonthlyOccurrence +### Properties +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 + +## AutomationAccountCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## AutomationAccountCreateOrUpdateProperties ### Properties * **creationTime**: string (ReadOnly): Gets the creation time. @@ -237,16 +253,11 @@ * **sku**: [Sku](#sku): The account SKU. * **state**: 'Ok' | 'Suspended' | 'Unavailable' | string (ReadOnly): Gets status of account. -## Sku -### Properties -* **capacity**: int: Gets or sets the SKU capacity. -* **family**: string: Gets or sets the SKU family. -* **name**: 'Basic' | 'Free' | string (Required): Gets or sets the SKU name of the account. - -## AutomationAccountCreateOrUpdateParametersTags +## AzureQueryProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **locations**: string[]: List of locations to scope the query to. +* **scope**: string[]: List of Subscription or Resource Group ARM Ids. +* **tagSettings**: [TagSettingsProperties](#tagsettingsproperties): Tag filter information for the VM. ## CertificateCreateOrUpdateProperties ### Properties @@ -258,6 +269,67 @@ * **lastModifiedTime**: string (ReadOnly): Gets the last modified time. * **thumbprint**: string: Gets or sets the thumbprint of the certificate. +## ConnectionCreateOrUpdateProperties +### Properties +* **connectionType**: [ConnectionTypeAssociationProperty](#connectiontypeassociationproperty) (Required): The connection type property associated with the entity. +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string: Gets or sets the description of the connection. +* **fieldDefinitionValues**: [ConnectionCreateOrUpdatePropertiesFieldDefinitionValues](#connectioncreateorupdatepropertiesfielddefinitionvalues): Gets or sets the field definition properties of the connection. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. + +## ConnectionCreateOrUpdatePropertiesFieldDefinitionValues +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ConnectionTypeAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the connection type. + +## ConnectionTypeCreateOrUpdateProperties +### Properties +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string (ReadOnly): Gets or sets the description. +* **fieldDefinitions**: [ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions](#connectiontypecreateorupdatepropertiesfielddefinitions) (Required): Gets or sets the field definitions of the connection type. +* **isGlobal**: bool: Gets or sets a Boolean value to indicate if the connection type is global. +* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. + +## ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions +### Properties +### Additional Properties +* **Additional Properties Type**: [FieldDefinition](#fielddefinition) + +## ContentHash +### Properties +* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. +* **value**: string (Required): Gets or sets expected hash value of the content. + +## ContentLink +### Properties +* **contentHash**: [ContentHash](#contenthash): Definition of the runbook property type. +* **uri**: string: Gets or sets the uri of the runbook content. +* **version**: string: Gets or sets the version of the content. + +## ContentSource +### Properties +* **hash**: [ContentHash](#contenthash) (WriteOnly): Definition of the runbook property type. +* **type**: 'embeddedContent' | 'uri' | string (WriteOnly): Gets or sets the content source type. +* **value**: string (WriteOnly): Gets or sets the value of the content. This is based on the content source type. +* **version**: string (WriteOnly): Gets or sets the version of the content. + +## CredentialCreateOrUpdateProperties +### Properties +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string: Gets or sets the description of the credential. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. +* **password**: string (Required, WriteOnly): Gets or sets the password of the credential. +* **userName**: string (Required): Gets or sets the user name of the credential. + +## DscCompilationJobCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DscCompilationJobCreateProperties ### Properties * **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. @@ -276,16 +348,16 @@ * **status**: 'Activating' | 'Blocked' | 'Completed' | 'Disconnected' | 'Failed' | 'New' | 'Removing' | 'Resuming' | 'Running' | 'Stopped' | 'Stopping' | 'Suspended' | 'Suspending' | string (ReadOnly): Gets or sets the status of the job. * **statusDetails**: string (ReadOnly): Gets or sets the status details of the job. -## DscConfigurationAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the Dsc configuration. - ## DscCompilationJobCreatePropertiesParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## DscCompilationJobCreateParametersTags +## DscConfigurationAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the Dsc configuration. + +## DscConfigurationCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -316,52 +388,24 @@ * **position**: int: Get or sets the position of the parameter. * **type**: string: Gets or sets the type of the parameter. -## ContentSource -### Properties -* **hash**: [ContentHash](#contenthash) (WriteOnly): Definition of the runbook property type. -* **type**: 'embeddedContent' | 'uri' | string (WriteOnly): Gets or sets the content source type. -* **value**: string (WriteOnly): Gets or sets the value of the content. This is based on the content source type. -* **version**: string (WriteOnly): Gets or sets the version of the content. - -## ContentHash -### Properties -* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. -* **value**: string (Required): Gets or sets expected hash value of the content. - -## DscConfigurationCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionCreateOrUpdateProperties -### Properties -* **connectionType**: [ConnectionTypeAssociationProperty](#connectiontypeassociationproperty) (Required): The connection type property associated with the entity. -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the connection. -* **fieldDefinitionValues**: [ConnectionCreateOrUpdatePropertiesFieldDefinitionValues](#connectioncreateorupdatepropertiesfielddefinitionvalues): Gets or sets the field definition properties of the connection. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. - -## ConnectionTypeAssociationProperty +## DscNodeConfigurationCreateOrUpdateParametersProperties ### Properties -* **name**: string: Gets or sets the name of the connection type. +* **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. +* **creationTime**: string (ReadOnly): Gets or sets creation time. +* **incrementNodeConfigurationBuild**: bool: If a new build version of NodeConfiguration is required. +* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. +* **nodeCount**: int (ReadOnly): Number of nodes with this node configuration assigned +* **source**: [ContentSource](#contentsource) (Required): Definition of the content source. -## ConnectionCreateOrUpdatePropertiesFieldDefinitionValues +## DscNodeConfigurationCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionTypeCreateOrUpdateProperties -### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string (ReadOnly): Gets or sets the description. -* **fieldDefinitions**: [ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions](#connectiontypecreateorupdatepropertiesfielddefinitions) (Required): Gets or sets the field definitions of the connection type. -* **isGlobal**: bool: Gets or sets a Boolean value to indicate if the connection type is global. -* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. - -## ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions +## ErrorResponse ### Properties -### Additional Properties -* **Additional Properties Type**: [FieldDefinition](#fielddefinition) +* **code**: string: Error code +* **message**: string: Error message indicating why the operation failed. ## FieldDefinition ### Properties @@ -369,14 +413,6 @@ * **isOptional**: bool: Gets or sets the isOptional flag of the connection field definition. * **type**: string (Required): Gets or sets the type of the connection field definition. -## CredentialCreateOrUpdateProperties -### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the credential. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. -* **password**: string (Required, WriteOnly): Gets or sets the password of the credential. -* **userName**: string (Required): Gets or sets the user name of the credential. - ## JobCreateProperties ### Properties * **creationTime**: string (ReadOnly): Gets or sets the creation time of the job. @@ -399,10 +435,6 @@ ### Additional Properties * **Additional Properties Type**: string -## RunbookAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the runbook. - ## JobScheduleCreateProperties ### Properties * **jobScheduleId**: string (ReadOnly): Gets or sets the id of job schedule. @@ -416,9 +448,27 @@ ### Additional Properties * **Additional Properties Type**: string -## ScheduleAssociationProperty +## Key ### Properties -* **name**: string: Gets or sets the name of the Schedule. +* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. +* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. +* **Value**: string (ReadOnly): Value of the Automation Key used for registration. + +## KeyListResult +### Properties +* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. + +## LinuxProperties +### Properties +* **excludedPackageNameMasks**: string[]: packages excluded from the software update configuration. +* **includedPackageClassifications**: 'Critical' | 'Other' | 'Security' | 'Unclassified' | string: Update classifications included in the software update configuration. +* **includedPackageNameMasks**: string[]: packages included from the software update configuration. +* **rebootSetting**: string: Reboot setting for the software update configuration. + +## ModuleCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ModuleCreateOrUpdateProperties ### Properties @@ -434,32 +484,17 @@ * **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. * **version**: string (ReadOnly): Gets or sets the version of the module. -## ContentLink -### Properties -* **contentHash**: [ContentHash](#contenthash): Definition of the runbook property type. -* **uri**: string: Gets or sets the uri of the runbook content. -* **version**: string: Gets or sets the version of the content. - ## ModuleErrorInfo ### Properties * **code**: string (ReadOnly): Gets or sets the error code. * **message**: string (ReadOnly): Gets or sets the error message. -## ModuleCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DscNodeConfigurationCreateOrUpdateParametersProperties +## NonAzureQueryProperties ### Properties -* **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. -* **creationTime**: string (ReadOnly): Gets or sets creation time. -* **incrementNodeConfigurationBuild**: bool: If a new build version of NodeConfiguration is required. -* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. -* **nodeCount**: int (ReadOnly): Number of nodes with this node configuration assigned -* **source**: [ContentSource](#contentsource) (Required): Definition of the content source. +* **functionAlias**: string: Log Analytics Saved Search name. +* **workspaceId**: string: Workspace Id for Log Analytics in which the saved Search is resided. -## DscNodeConfigurationCreateOrUpdateParametersTags +## PythonPackageCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -478,7 +513,11 @@ * **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. * **version**: string (ReadOnly): Gets or sets the version of the module. -## PythonPackageCreateParametersTags +## RunbookAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the runbook. + +## RunbookCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -527,15 +566,9 @@ ### Additional Properties * **Additional Properties Type**: [RunbookParameter](#runbookparameter) -## RunbookCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TestJobCreateParameters +## ScheduleAssociationProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Gets or sets the name of the Schedule. ## ScheduleCreateOrUpdateProperties ### Properties @@ -554,16 +587,11 @@ * **startTimeOffsetMinutes**: int (ReadOnly): Gets the start time's offset in minutes. * **timeZone**: string: Gets or sets the time zone of the schedule. -## AdvancedSchedule -### Properties -* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. -* **weekDays**: string[]: Days of the week that the job should execute on. - -## AdvancedScheduleMonthlyOccurrence +## Sku ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 +* **capacity**: int: Gets or sets the SKU capacity. +* **family**: string: Gets or sets the SKU family. +* **name**: 'Basic' | 'Free' | string (Required): Gets or sets the SKU name of the account. ## SoftwareUpdateConfigurationProperties ### Properties @@ -577,10 +605,40 @@ * **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. * **updateConfiguration**: [UpdateConfiguration](#updateconfiguration) (Required): Update specific properties of the software update configuration. -## ErrorResponse +## SoftwareUpdateConfigurationTasks ### Properties -* **code**: string: Error code -* **message**: string: Error message indicating why the operation failed. +* **postTask**: [TaskProperties](#taskproperties): Task properties of the software update configuration. +* **preTask**: [TaskProperties](#taskproperties): Task properties of the software update configuration. + +## SourceControlCreateOrUpdateProperties +### Properties +* **autoSync**: bool: The auto async of the source control. Default is false. +* **branch**: string: The repo branch of the source control. Include branch as empty string for VsoTfvc. +* **creationTime**: string (ReadOnly): The creation time. +* **description**: string: The user description of the source control. +* **folderPath**: string: The folder path of the source control. Path must be relative. +* **lastModifiedTime**: string (ReadOnly): The last modified time. +* **publishRunbook**: bool: The auto publish of the source control. Default is true. +* **repoUrl**: string: The repo url of the source control. +* **securityToken**: [SourceControlSecurityTokenProperties](#sourcecontrolsecuritytokenproperties) (WriteOnly) +* **sourceType**: 'GitHub' | 'VsoGit' | 'VsoTfvc' | string: The source type. Must be one of VsoGit, VsoTfvc, GitHub. + +## SourceControlSecurityTokenProperties +### Properties +* **accessToken**: string (WriteOnly): The access token. +* **refreshToken**: string (WriteOnly): The refresh token. +* **tokenType**: 'Oauth' | 'PersonalAccessToken' | string (WriteOnly): The token type. Must be either PersonalAccessToken or Oauth. + +## SourceControlSyncJobCreateProperties +### Properties +* **commitId**: string (Required, WriteOnly): The commit id of the source control sync job. If not syncing to a commitId, enter an empty string. +* **creationTime**: string (ReadOnly): The creation time of the job. +* **endTime**: string (ReadOnly): The end time of the job. +* **exception**: string (ReadOnly): The exceptions that occurred while running the sync job. +* **provisioningState**: 'Completed' | 'Failed' | 'Running' | string (ReadOnly): The provisioning state of the job. +* **sourceControlSyncJobId**: string (ReadOnly): The source control sync job id. +* **startTime**: string (ReadOnly): The start time of the job. +* **syncType**: 'FullSync' | 'PartialSync' | string (ReadOnly): The sync type. ## SUCScheduleProperties ### Properties @@ -599,10 +657,20 @@ * **startTimeOffsetMinutes**: int (ReadOnly): Gets the start time's offset in minutes. * **timeZone**: string: Gets or sets the time zone of the schedule. -## SoftwareUpdateConfigurationTasks +## TagSettingsProperties ### Properties -* **postTask**: [TaskProperties](#taskproperties): Task properties of the software update configuration. -* **preTask**: [TaskProperties](#taskproperties): Task properties of the software update configuration. +* **filterOperator**: 'All' | 'Any': Filter VMs by Any or All specified tags. +* **tags**: [TagSettingsPropertiesTags](#tagsettingspropertiestags): Dictionary of tags with its list of values. + +## TagSettingsPropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## TargetProperties +### Properties +* **azureQueries**: [AzureQueryProperties](#azurequeryproperties)[]: List of Azure queries in the software update configuration. +* **nonAzureQueries**: [NonAzureQueryProperties](#nonazurequeryproperties)[]: List of non Azure queries in the software update configuration. ## TaskProperties ### Properties @@ -614,6 +682,11 @@ ### Additional Properties * **Additional Properties Type**: string +## TestJobCreateParameters +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UpdateConfiguration ### Properties * **azureVirtualMachines**: string[]: List of azure resource Ids for azure virtual machines targeted by the software update configuration. @@ -624,76 +697,6 @@ * **targets**: [TargetProperties](#targetproperties): Group specific to the update configuration. * **windows**: [WindowsProperties](#windowsproperties): Windows specific update configuration. -## LinuxProperties -### Properties -* **excludedPackageNameMasks**: string[]: packages excluded from the software update configuration. -* **includedPackageClassifications**: 'Critical' | 'Other' | 'Security' | 'Unclassified' | string: Update classifications included in the software update configuration. -* **includedPackageNameMasks**: string[]: packages included from the software update configuration. -* **rebootSetting**: string: Reboot setting for the software update configuration. - -## TargetProperties -### Properties -* **azureQueries**: [AzureQueryProperties](#azurequeryproperties)[]: List of Azure queries in the software update configuration. -* **nonAzureQueries**: [NonAzureQueryProperties](#nonazurequeryproperties)[]: List of non Azure queries in the software update configuration. - -## AzureQueryProperties -### Properties -* **locations**: string[]: List of locations to scope the query to. -* **scope**: string[]: List of Subscription or Resource Group ARM Ids. -* **tagSettings**: [TagSettingsProperties](#tagsettingsproperties): Tag filter information for the VM. - -## TagSettingsProperties -### Properties -* **filterOperator**: 'All' | 'Any': Filter VMs by Any or All specified tags. -* **tags**: [TagSettingsPropertiesTags](#tagsettingspropertiestags): Dictionary of tags with its list of values. - -## TagSettingsPropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string[] - -## NonAzureQueryProperties -### Properties -* **functionAlias**: string: Log Analytics Saved Search name. -* **workspaceId**: string: Workspace Id for Log Analytics in which the saved Search is resided. - -## WindowsProperties -### Properties -* **excludedKbNumbers**: string[]: KB numbers excluded from the software update configuration. -* **includedKbNumbers**: string[]: KB numbers included from the software update configuration. -* **includedUpdateClassifications**: 'Critical' | 'Definition' | 'FeaturePack' | 'Security' | 'ServicePack' | 'Tools' | 'Unclassified' | 'UpdateRollup' | 'Updates' | string: Update classification included in the software update configuration. A comma separated string with required values -* **rebootSetting**: string: Reboot setting for the software update configuration. - -## SourceControlCreateOrUpdateProperties -### Properties -* **autoSync**: bool: The auto async of the source control. Default is false. -* **branch**: string: The repo branch of the source control. Include branch as empty string for VsoTfvc. -* **creationTime**: string (ReadOnly): The creation time. -* **description**: string: The user description of the source control. -* **folderPath**: string: The folder path of the source control. Path must be relative. -* **lastModifiedTime**: string (ReadOnly): The last modified time. -* **publishRunbook**: bool: The auto publish of the source control. Default is true. -* **repoUrl**: string: The repo url of the source control. -* **securityToken**: [SourceControlSecurityTokenProperties](#sourcecontrolsecuritytokenproperties) (WriteOnly) -* **sourceType**: 'GitHub' | 'VsoGit' | 'VsoTfvc' | string: The source type. Must be one of VsoGit, VsoTfvc, GitHub. - -## SourceControlSecurityTokenProperties -### Properties -* **accessToken**: string (WriteOnly): The access token. -* **refreshToken**: string (WriteOnly): The refresh token. -* **tokenType**: 'Oauth' | 'PersonalAccessToken' | string (WriteOnly): The token type. Must be either PersonalAccessToken or Oauth. - -## SourceControlSyncJobCreateProperties -### Properties -* **commitId**: string (Required, WriteOnly): The commit id of the source control sync job. If not syncing to a commitId, enter an empty string. -* **creationTime**: string (ReadOnly): The creation time of the job. -* **endTime**: string (ReadOnly): The end time of the job. -* **exception**: string (ReadOnly): The exceptions that occurred while running the sync job. -* **provisioningState**: 'Completed' | 'Failed' | 'Running' | string (ReadOnly): The provisioning state of the job. -* **sourceControlSyncJobId**: string (ReadOnly): The source control sync job id. -* **startTime**: string (ReadOnly): The start time of the job. -* **syncType**: 'FullSync' | 'PartialSync' | string (ReadOnly): The sync type. - ## VariableCreateOrUpdateProperties ### Properties * **creationTime**: string (ReadOnly): Gets or sets the creation time. @@ -724,13 +727,10 @@ ### Additional Properties * **Additional Properties Type**: string -## KeyListResult -### Properties -* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. - -## Key +## WindowsProperties ### Properties -* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. -* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. -* **Value**: string (ReadOnly): Value of the Automation Key used for registration. +* **excludedKbNumbers**: string[]: KB numbers excluded from the software update configuration. +* **includedKbNumbers**: string[]: KB numbers included from the software update configuration. +* **includedUpdateClassifications**: 'Critical' | 'Definition' | 'FeaturePack' | 'Security' | 'ServicePack' | 'Tools' | 'Unclassified' | 'UpdateRollup' | 'Updates' | string: Update classification included in the software update configuration. A comma separated string with required values +* **rebootSetting**: string: Reboot setting for the software update configuration. diff --git a/generated/automation/microsoft.automation/2020-01-13-preview/types.md b/generated/automation/microsoft.automation/2020-01-13-preview/types.md index 21d2cb7918..f23d4de903 100644 --- a/generated/automation/microsoft.automation/2020-01-13-preview/types.md +++ b/generated/automation/microsoft.automation/2020-01-13-preview/types.md @@ -165,22 +165,21 @@ * **ApiVersion**: 2020-01-13-preview * **Output**: [KeyListResult](#keylistresult) -## Identity +## AdvancedSchedule ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. +* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. +* **weekDays**: string[]: Days of the week that the job should execute on. -## IdentityUserAssignedIdentities +## AdvancedScheduleMonthlyOccurrence ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## AutomationAccountCreateOrUpdateParametersTags ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string ## AutomationAccountCreateOrUpdateProperties ### Properties @@ -194,65 +193,81 @@ * **sku**: [Sku](#sku): The account SKU. * **state**: 'Ok' | 'Suspended' | 'Unavailable' | string (ReadOnly): Gets status of account. -## EncryptionProperties +## CertificateCreateOrUpdateProperties ### Properties -* **identity**: [EncryptionPropertiesIdentity](#encryptionpropertiesidentity): User identity used for CMK. -* **keySource**: 'Microsoft.Automation' | 'Microsoft.Keyvault': Encryption Key Source -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. +* **base64Value**: string (Required, WriteOnly): Gets or sets the base64 encoded value of the certificate. +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string: Gets or sets the description of the certificate. +* **expiryTime**: string (ReadOnly): Gets the expiry time of the certificate. +* **isExportable**: bool: Gets or sets the is exportable flag of the certificate. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. +* **thumbprint**: string: Gets or sets the thumbprint of the certificate. -## EncryptionPropertiesIdentity +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **userAssignedIdentity**: any: Any object +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## KeyVaultProperties +## ConnectionCreateOrUpdateProperties ### Properties -* **keyName**: string: The name of key used to encrypt data. -* **keyvaultUri**: string: The URI of the key vault key used to encrypt data. -* **keyVersion**: string: The key version of the key used to encrypt data. +* **connectionType**: [ConnectionTypeAssociationProperty](#connectiontypeassociationproperty) (Required): The connection type property associated with the entity. +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string: Gets or sets the description of the connection. +* **fieldDefinitionValues**: [ConnectionCreateOrUpdatePropertiesFieldDefinitionValues](#connectioncreateorupdatepropertiesfielddefinitionvalues): Gets or sets the field definition properties of the connection. +* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. -## PrivateEndpointConnection +## ConnectionCreateOrUpdatePropertiesFieldDefinitionValues ### Properties -* **id**: string (ReadOnly): Fully qualified resource Id for the resource -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnectionProperties +## ConnectionTypeAssociationProperty ### Properties -* **groupIds**: string[]: Gets the groupIds. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty): Connection State of the Private Endpoint Connection. +* **name**: string: Gets or sets the name of the connection type. -## PrivateEndpointProperty +## ConnectionTypeCreateOrUpdateProperties ### Properties -* **id**: string: Resource id of the private endpoint. +* **creationTime**: string (ReadOnly): Gets the creation time. +* **description**: string (ReadOnly): Gets or sets the description. +* **fieldDefinitions**: [ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions](#connectiontypecreateorupdatepropertiesfielddefinitions) (Required): Gets or sets the field definitions of the connection type. +* **isGlobal**: bool: Gets or sets a Boolean value to indicate if the connection type is global. +* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. -## PrivateLinkServiceConnectionStateProperty +## ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: [FieldDefinition](#fielddefinition) -## Sku +## ContentHash ### Properties -* **capacity**: int: Gets or sets the SKU capacity. -* **family**: string: Gets or sets the SKU family. -* **name**: 'Basic' | 'Free' | string (Required): Gets or sets the SKU name of the account. +* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. +* **value**: string (Required): Gets or sets expected hash value of the content. -## AutomationAccountCreateOrUpdateParametersTags +## ContentLink ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **contentHash**: [ContentHash](#contenthash): Definition of the runbook property type. +* **uri**: string: Gets or sets the uri of the runbook content. +* **version**: string: Gets or sets the version of the content. -## CertificateCreateOrUpdateProperties +## ContentSource +### Properties +* **hash**: [ContentHash](#contenthash) (WriteOnly): Definition of the runbook property type. +* **type**: 'embeddedContent' | 'uri' | string (WriteOnly): Gets or sets the content source type. +* **value**: string (WriteOnly): Gets or sets the value of the content. This is based on the content source type. +* **version**: string (WriteOnly): Gets or sets the version of the content. + +## CredentialCreateOrUpdateProperties ### Properties -* **base64Value**: string (Required, WriteOnly): Gets or sets the base64 encoded value of the certificate. * **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the certificate. -* **expiryTime**: string (ReadOnly): Gets the expiry time of the certificate. -* **isExportable**: bool: Gets or sets the is exportable flag of the certificate. +* **description**: string: Gets or sets the description of the credential. * **lastModifiedTime**: string (ReadOnly): Gets the last modified time. -* **thumbprint**: string: Gets or sets the thumbprint of the certificate. +* **password**: string (Required, WriteOnly): Gets or sets the password of the credential. +* **userName**: string (Required): Gets or sets the user name of the credential. + +## DscCompilationJobCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## DscCompilationJobCreateProperties ### Properties @@ -272,49 +287,38 @@ * **status**: 'Activating' | 'Blocked' | 'Completed' | 'Disconnected' | 'Failed' | 'New' | 'Removing' | 'Resuming' | 'Running' | 'Stopped' | 'Stopping' | 'Suspended' | 'Suspending' | string (ReadOnly): Gets or sets the status of the job. * **statusDetails**: string (ReadOnly): Gets or sets the status details of the job. -## DscConfigurationAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the Dsc configuration. - ## DscCompilationJobCreatePropertiesParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## DscCompilationJobCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionCreateOrUpdateProperties +## DscConfigurationAssociationProperty ### Properties -* **connectionType**: [ConnectionTypeAssociationProperty](#connectiontypeassociationproperty) (Required): The connection type property associated with the entity. -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the connection. -* **fieldDefinitionValues**: [ConnectionCreateOrUpdatePropertiesFieldDefinitionValues](#connectioncreateorupdatepropertiesfielddefinitionvalues): Gets or sets the field definition properties of the connection. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. +* **name**: string: Gets or sets the name of the Dsc configuration. -## ConnectionTypeAssociationProperty +## DscNodeConfigurationCreateOrUpdateParametersProperties ### Properties -* **name**: string: Gets or sets the name of the connection type. +* **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. +* **creationTime**: string (ReadOnly): Gets or sets creation time. +* **incrementNodeConfigurationBuild**: bool: If a new build version of NodeConfiguration is required. +* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. +* **nodeCount**: int (ReadOnly): Number of nodes with this node configuration assigned +* **source**: [ContentSource](#contentsource) (Required): Definition of the content source. -## ConnectionCreateOrUpdatePropertiesFieldDefinitionValues +## DscNodeConfigurationCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionTypeCreateOrUpdateProperties +## EncryptionProperties ### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string (ReadOnly): Gets or sets the description. -* **fieldDefinitions**: [ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions](#connectiontypecreateorupdatepropertiesfielddefinitions) (Required): Gets or sets the field definitions of the connection type. -* **isGlobal**: bool: Gets or sets a Boolean value to indicate if the connection type is global. -* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. +* **identity**: [EncryptionPropertiesIdentity](#encryptionpropertiesidentity): User identity used for CMK. +* **keySource**: 'Microsoft.Automation' | 'Microsoft.Keyvault': Encryption Key Source +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. -## ConnectionTypeCreateOrUpdatePropertiesFieldDefinitions +## EncryptionPropertiesIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [FieldDefinition](#fielddefinition) +* **userAssignedIdentity**: any: Any object ## FieldDefinition ### Properties @@ -322,13 +326,17 @@ * **isOptional**: bool: Gets or sets the isOptional flag of the connection field definition. * **type**: string (Required): Gets or sets the type of the connection field definition. -## CredentialCreateOrUpdateProperties +## Identity ### Properties -* **creationTime**: string (ReadOnly): Gets the creation time. -* **description**: string: Gets or sets the description of the credential. -* **lastModifiedTime**: string (ReadOnly): Gets the last modified time. -* **password**: string (Required, WriteOnly): Gets or sets the password of the credential. -* **userName**: string (Required): Gets or sets the user name of the credential. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) ## JobScheduleCreateProperties ### Properties @@ -343,13 +351,26 @@ ### Additional Properties * **Additional Properties Type**: string -## RunbookAssociationProperty +## Key ### Properties -* **name**: string: Gets or sets the name of the runbook. +* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. +* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. +* **Value**: string (ReadOnly): Value of the Automation Key used for registration. -## ScheduleAssociationProperty +## KeyListResult ### Properties -* **name**: string: Gets or sets the name of the Schedule. +* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. + +## KeyVaultProperties +### Properties +* **keyName**: string: The name of key used to encrypt data. +* **keyvaultUri**: string: The URI of the key vault key used to encrypt data. +* **keyVersion**: string: The key version of the key used to encrypt data. + +## ModuleCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ModuleCreateOrUpdateProperties ### Properties @@ -365,44 +386,35 @@ * **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. * **version**: string (ReadOnly): Gets or sets the version of the module. -## ContentLink -### Properties -* **contentHash**: [ContentHash](#contenthash): Definition of the runbook property type. -* **uri**: string: Gets or sets the uri of the runbook content. -* **version**: string: Gets or sets the version of the content. - -## ContentHash -### Properties -* **algorithm**: string (Required): Gets or sets the content hash algorithm used to hash the content. -* **value**: string (Required): Gets or sets expected hash value of the content. - ## ModuleErrorInfo ### Properties * **code**: string (ReadOnly): Gets or sets the error code. * **message**: string (ReadOnly): Gets or sets the error message. -## ModuleCreateOrUpdateParametersTags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource Id for the resource +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. -## DscNodeConfigurationCreateOrUpdateParametersProperties +## PrivateEndpointConnectionProperties ### Properties -* **configuration**: [DscConfigurationAssociationProperty](#dscconfigurationassociationproperty) (Required): The Dsc configuration property associated with the entity. -* **creationTime**: string (ReadOnly): Gets or sets creation time. -* **incrementNodeConfigurationBuild**: bool: If a new build version of NodeConfiguration is required. -* **lastModifiedTime**: string (ReadOnly): Gets or sets the last modified time. -* **nodeCount**: int (ReadOnly): Number of nodes with this node configuration assigned -* **source**: [ContentSource](#contentsource) (Required): Definition of the content source. +* **groupIds**: string[]: Gets the groupIds. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty): Connection State of the Private Endpoint Connection. -## ContentSource +## PrivateEndpointProperty ### Properties -* **hash**: [ContentHash](#contenthash) (WriteOnly): Definition of the runbook property type. -* **type**: 'embeddedContent' | 'uri' | string (WriteOnly): Gets or sets the content source type. -* **value**: string (WriteOnly): Gets or sets the value of the content. This is based on the content source type. -* **version**: string (WriteOnly): Gets or sets the version of the content. +* **id**: string: Resource id of the private endpoint. -## DscNodeConfigurationCreateOrUpdateParametersTags +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PythonPackageCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -421,10 +433,13 @@ * **sizeInBytes**: int (ReadOnly): Gets or sets the size in bytes of the module. * **version**: string (ReadOnly): Gets or sets the version of the module. -## PythonPackageCreateParametersTags +## RunbookAssociationProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Gets or sets the name of the runbook. + +## ScheduleAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the Schedule. ## ScheduleCreateOrUpdateProperties ### Properties @@ -443,16 +458,11 @@ * **startTimeOffsetMinutes**: int (ReadOnly): Gets the start time's offset in minutes. * **timeZone**: string: Gets or sets the time zone of the schedule. -## AdvancedSchedule -### Properties -* **monthDays**: int[]: Days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [AdvancedScheduleMonthlyOccurrence](#advancedschedulemonthlyoccurrence)[]: Occurrences of days within a month. -* **weekDays**: string[]: Days of the week that the job should execute on. - -## AdvancedScheduleMonthlyOccurrence +## Sku ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **occurrence**: int: Occurrence of the week within the month. Must be between 1 and 5 +* **capacity**: int: Gets or sets the SKU capacity. +* **family**: string: Gets or sets the SKU family. +* **name**: 'Basic' | 'Free' | string (Required): Gets or sets the SKU name of the account. ## SourceControlCreateOrUpdateProperties ### Properties @@ -514,13 +524,3 @@ ### Additional Properties * **Additional Properties Type**: string -## KeyListResult -### Properties -* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. - -## Key -### Properties -* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. -* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. -* **Value**: string (ReadOnly): Value of the Automation Key used for registration. - diff --git a/generated/automation/microsoft.automation/2021-06-22/types.md b/generated/automation/microsoft.automation/2021-06-22/types.md index 63a61dfb5b..b9ece60297 100644 --- a/generated/automation/microsoft.automation/2021-06-22/types.md +++ b/generated/automation/microsoft.automation/2021-06-22/types.md @@ -41,22 +41,10 @@ * **ApiVersion**: 2021-06-22 * **Output**: [KeyListResult](#keylistresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. - -## IdentityUserAssignedIdentities +## AutomationAccountCreateOrUpdateParametersTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) - -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **Additional Properties Type**: string ## AutomationAccountCreateOrUpdateProperties ### Properties @@ -72,6 +60,11 @@ * **sku**: [Sku](#sku): The account SKU. * **state**: 'Ok' | 'Suspended' | 'Unavailable' | string (ReadOnly): Gets status of account. +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + ## EncryptionProperties ### Properties * **identity**: [EncryptionPropertiesIdentity](#encryptionpropertiesidentity): User identity used for CMK. @@ -82,6 +75,44 @@ ### Properties * **userAssignedIdentity**: any: Any object +## HybridRunbookWorkerCreateOrUpdateParameters +### Properties +* **ip**: string (ReadOnly): Gets or sets the assigned machine IP address. +* **lastSeenDateTime**: string (ReadOnly): Last Heartbeat from the Worker +* **registeredDateTime**: string (ReadOnly): Gets or sets the registration time of the worker machine. +* **vmResourceId**: string: Azure Resource Manager Id for a virtual machine. +* **workerName**: string (ReadOnly): Name of the HybridWorker. +* **workerType**: 'HybridV1' | 'HybridV2' | string (ReadOnly): Type of the HybridWorker. + +## HybridRunbookWorkerLegacy +### Properties +* **ip**: string (ReadOnly): Gets or sets the assigned machine IP address. +* **lastSeenDateTime**: string (ReadOnly): Last Heartbeat from the Worker +* **name**: string (ReadOnly): Gets or sets the worker machine name. +* **registrationTime**: string (ReadOnly): Gets or sets the registration time of the worker machine. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + +## Key +### Properties +* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. +* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. +* **Value**: string (ReadOnly): Value of the Automation Key used for registration. + +## KeyListResult +### Properties +* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. + ## KeyVaultProperties ### Properties * **keyName**: string: The name of key used to encrypt data. @@ -111,6 +142,10 @@ * **description**: string (ReadOnly): The private link service connection description. * **status**: string (ReadOnly): The private link service connection status. +## RunAsCredentialAssociationProperty +### Properties +* **name**: string: Gets or sets the name of the credential. + ## Sku ### Properties * **capacity**: int: Gets or sets the SKU capacity. @@ -126,38 +161,3 @@ * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## AutomationAccountCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RunAsCredentialAssociationProperty -### Properties -* **name**: string: Gets or sets the name of the credential. - -## HybridRunbookWorkerLegacy -### Properties -* **ip**: string (ReadOnly): Gets or sets the assigned machine IP address. -* **lastSeenDateTime**: string (ReadOnly): Last Heartbeat from the Worker -* **name**: string (ReadOnly): Gets or sets the worker machine name. -* **registrationTime**: string (ReadOnly): Gets or sets the registration time of the worker machine. - -## HybridRunbookWorkerCreateOrUpdateParameters -### Properties -* **ip**: string (ReadOnly): Gets or sets the assigned machine IP address. -* **lastSeenDateTime**: string (ReadOnly): Last Heartbeat from the Worker -* **registeredDateTime**: string (ReadOnly): Gets or sets the registration time of the worker machine. -* **vmResourceId**: string: Azure Resource Manager Id for a virtual machine. -* **workerName**: string (ReadOnly): Name of the HybridWorker. -* **workerType**: 'HybridV1' | 'HybridV2' | string (ReadOnly): Type of the HybridWorker. - -## KeyListResult -### Properties -* **keys**: [Key](#key)[] (ReadOnly): Lists the automation keys. - -## Key -### Properties -* **KeyName**: 'Primary' | 'Secondary' | string (ReadOnly): Automation key name. -* **Permissions**: 'Full' | 'Read' | string (ReadOnly): Automation key permissions. -* **Value**: string (ReadOnly): Value of the Automation Key used for registration. - diff --git a/generated/azsadmin/log.out b/generated/azsadmin/log.out index 299f4061f1..461716f277 100644 --- a/generated/azsadmin/log.out +++ b/generated/azsadmin/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.subscriptions-2015-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16,11 +16,11 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubscriptionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json:216:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}': Unable to locate "/providers/" segment info | autorest.bicep took 2ms -info | Autorest completed in 4.77s. 0 files generated. +info | Autorest completed in 4.55s. 0 files generated. diff --git a/generated/azure-kusto/log.out b/generated/azure-kusto/log.out index 7c32dedaa6..8538d8f67a 100644 --- a/generated/azure-kusto/log.out +++ b/generated/azure-kusto/log.out @@ -11,7 +11,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.kusto-2022-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -21,7 +21,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2022-02-01/kusto.json:3626:5 @@ -124,7 +124,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2021-08-27/kusto.json:3525:5 @@ -217,7 +217,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationResultErrorPropertie warning | PreCheck/SchemaMissingType | The schema 'TableLevelSharingProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2021-08-27/kusto.json:5902:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.kusto-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -227,7 +227,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2021-01-01/kusto.json:2832:5 @@ -320,7 +320,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationResultErrorPropertie warning | PreCheck/SchemaMissingType | The schema 'TableLevelSharingProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2021-01-01/kusto.json:4800:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.kusto-2020-09-18"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -330,7 +330,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-09-18/kusto.json:2437:5 @@ -423,7 +423,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/kusto.json:2437:5 @@ -516,7 +516,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-02-15/kusto.json:2424:5 @@ -599,7 +599,7 @@ warning | PreCheck/SchemaMissingType | The schema 'KeyVaultProperties' with an u warning | PreCheck/SchemaMissingType | The schema 'LanguageExtensionsList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-02-15/kusto.json:4152:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.kusto-2019-11-09"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -609,7 +609,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-11-09/kusto.json:2275:5 @@ -690,7 +690,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined t warning | PreCheck/SchemaMissingType | The schema 'KeyVaultProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-11-09/kusto.json:3937:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.kusto-2019-09-07"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -700,7 +700,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-09-07/kusto.json:1717:5 @@ -771,7 +771,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined t warning | PreCheck/SchemaMissingType | The schema 'KeyVaultProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-09-07/kusto.json:3039:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.kusto-2019-05-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -781,7 +781,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-05-15/kusto.json:1400:5 @@ -836,7 +836,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-05-15/kusto.json:2421:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.kusto-2019-01-21"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -846,7 +846,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/kusto.json:1400:5 @@ -907,7 +907,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/preview/2018-09-07-preview/kusto.json:1346:5 @@ -955,4 +955,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azure-kusto/resource-manager/Microsoft.Kusto/preview/2018-09-07-preview/kusto.json:2032:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 38.1s. 22 files generated. +info | Autorest completed in 36.78s. 22 files generated. diff --git a/generated/azure-kusto/microsoft.kusto/2018-09-07-preview/types.md b/generated/azure-kusto/microsoft.kusto/2018-09-07-preview/types.md index 78cabde37e..cccac6fa19 100644 --- a/generated/azure-kusto/microsoft.kusto/2018-09-07-preview/types.md +++ b/generated/azure-kusto/microsoft.kusto/2018-09-07-preview/types.md @@ -40,6 +40,12 @@ * **ApiVersion**: 2018-09-07-preview * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) +## AzureSku +### Properties +* **capacity**: int: SKU capacity. +* **name**: 'D13_v2' | 'D14_v2' | 'KC16' | 'KC8' | 'KS16' | 'KS8' | 'L16' | 'L8' | string (Required): SKU name. +* **tier**: 'Standard' | string (Required): SKU tier. + ## ClusterProperties ### Properties * **dataIngestionUri**: string (ReadOnly): The cluster data ingestion URI. @@ -48,20 +54,18 @@ * **trustedExternalTenants**: [TrustedExternalTenant](#trustedexternaltenant)[]: The cluster's external tenants. * **uri**: string (ReadOnly): The cluster URI. -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## AzureSku +## DatabasePrincipal ### Properties -* **capacity**: int: SKU capacity. -* **name**: 'D13_v2' | 'D14_v2' | 'KC16' | 'KC8' | 'KS16' | 'KS8' | 'L16' | 'L8' | string (Required): SKU name. -* **tier**: 'Standard' | string (Required): SKU tier. +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## TrackedResourceTags +## DatabasePrincipalListResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. ## DatabaseProperties ### Properties @@ -74,11 +78,6 @@ ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## EventHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The event hub consumer group. @@ -87,16 +86,17 @@ * **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalListResult +## TrackedResourceTags ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +### Additional Properties +* **Additional Properties Type**: string -## DatabasePrincipal +## TrackedResourceTags ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. diff --git a/generated/azure-kusto/microsoft.kusto/2019-01-21/types.md b/generated/azure-kusto/microsoft.kusto/2019-01-21/types.md index a598414c46..6a09a55235 100644 --- a/generated/azure-kusto/microsoft.kusto/2019-01-21/types.md +++ b/generated/azure-kusto/microsoft.kusto/2019-01-21/types.md @@ -48,6 +48,12 @@ * **ApiVersion**: 2019-01-21 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) +## AzureSku +### Properties +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. + ## ClusterProperties ### Properties * **dataIngestionUri**: string (ReadOnly): The cluster data ingestion URI. @@ -56,20 +62,18 @@ * **trustedExternalTenants**: [TrustedExternalTenant](#trustedexternaltenant)[]: The cluster's external tenants. * **uri**: string (ReadOnly): The cluster URI. -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## AzureSku +## DatabasePrincipal ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## TrackedResourceTags +## DatabasePrincipalListResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. ## DatabaseProperties ### Properties @@ -99,16 +103,12 @@ * **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalListResult +## TrackedResourceTags ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +### Additional Properties +* **Additional Properties Type**: string -## DatabasePrincipal +## TrustedExternalTenant ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **value**: string: GUID representing an external tenant. diff --git a/generated/azure-kusto/microsoft.kusto/2019-05-15/types.md b/generated/azure-kusto/microsoft.kusto/2019-05-15/types.md index 038df5b68b..fcb52567b7 100644 --- a/generated/azure-kusto/microsoft.kusto/2019-05-15/types.md +++ b/generated/azure-kusto/microsoft.kusto/2019-05-15/types.md @@ -54,6 +54,12 @@ * **ApiVersion**: 2019-05-15 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) +## AzureSku +### Properties +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. + ## ClusterProperties ### Properties * **dataIngestionUri**: string (ReadOnly): The cluster data ingestion URI. @@ -66,33 +72,19 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku +## DatabasePrincipal ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## TrackedResourceTags +## DatabasePrincipalListResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. ## DatabaseProperties ### Properties @@ -133,17 +125,25 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy name * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalListResult +## OptimizedAutoscale ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. -## DatabasePrincipal +## TrackedResourceTags ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. + +## VirtualNetworkConfiguration +### Properties +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2019-09-07/types.md b/generated/azure-kusto/microsoft.kusto/2019-09-07/types.md index b8e7f2290e..bd9380bee7 100644 --- a/generated/azure-kusto/microsoft.kusto/2019-09-07/types.md +++ b/generated/azure-kusto/microsoft.kusto/2019-09-07/types.md @@ -81,22 +81,19 @@ * **ApiVersion**: 2019-09-07 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. - -## IdentityUserAssignedIdentities +## AttachedDatabaseConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## AzureSku ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. ## ClusterProperties ### Properties @@ -111,69 +108,29 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## KeyVaultProperties -### Properties -* **keyName**: string (Required): The name of the key vault key. -* **keyVaultUri**: string (Required): The Uri of the key vault. -* **keyVersion**: string (Required): The version of the key vault key. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku -### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. - -## TrackedResourceTags +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipal ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalListResult ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **consumerGroup**: string (Required): The event hub consumer group. @@ -192,6 +149,28 @@ * **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -202,27 +181,48 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy name * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## FollowerDatabaseListResult +## KeyVaultProperties ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **keyName**: string (Required): The name of the key vault key. +* **keyVaultUri**: string (Required): The Uri of the key vault. +* **keyVersion**: string (Required): The version of the key vault key. -## FollowerDatabaseDefinition +## OptimizedAutoscale ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. -## DatabasePrincipalListResult +## ReadOnlyFollowingDatabaseProperties ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## DatabasePrincipal +## ReadWriteDatabaseProperties ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. + +## VirtualNetworkConfiguration +### Properties +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2019-11-09/types.md b/generated/azure-kusto/microsoft.kusto/2019-11-09/types.md index a5c2077efc..2b6f687ee1 100644 --- a/generated/azure-kusto/microsoft.kusto/2019-11-09/types.md +++ b/generated/azure-kusto/microsoft.kusto/2019-11-09/types.md @@ -99,22 +99,29 @@ * **ApiVersion**: 2019-11-09 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AttachedDatabaseConfigurationProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -## IdentityUserAssignedIdentities +## AzureSku ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## ClusterPrincipalProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -130,70 +137,39 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## KeyVaultProperties -### Properties -* **keyName**: string (Required): The name of the key vault key. -* **keyVaultUri**: string (Required): The Uri of the key vault. -* **keyVersion**: string (Required): The version of the key vault key. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TrackedResourceTags +## DatabasePrincipal ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipalListResult ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: string (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **consumerGroup**: string (Required): The event hub consumer group. @@ -213,6 +189,28 @@ * **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -223,47 +221,49 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalProperties +## KeyVaultProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **keyName**: string (Required): The name of the key vault key. +* **keyVaultUri**: string (Required): The Uri of the key vault. +* **keyVersion**: string (Required): The version of the key vault key. -## ClusterPrincipalProperties +## OptimizedAutoscale ### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. + +## ReadOnlyFollowingDatabaseProperties +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## FollowerDatabaseListResult +## ReadWriteDatabaseProperties ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: string (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## FollowerDatabaseDefinition +## TrackedResourceTags ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +### Additional Properties +* **Additional Properties Type**: string -## DatabasePrincipalListResult +## TrustedExternalTenant ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **value**: string: GUID representing an external tenant. -## DatabasePrincipal +## VirtualNetworkConfiguration ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2020-02-15/types.md b/generated/azure-kusto/microsoft.kusto/2020-02-15/types.md index 18ab4027b6..95ff6bd041 100644 --- a/generated/azure-kusto/microsoft.kusto/2020-02-15/types.md +++ b/generated/azure-kusto/microsoft.kusto/2020-02-15/types.md @@ -104,22 +104,29 @@ * **ApiVersion**: 2020-02-15 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AttachedDatabaseConfigurationProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -## IdentityUserAssignedIdentities +## AzureSku ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## ClusterPrincipalProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -137,78 +144,39 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## KeyVaultProperties -### Properties -* **keyName**: string (Required): The name of the key vault key. -* **keyVaultUri**: string (Required): The Uri of the key vault. -* **keyVersion**: string (Required): The version of the key vault key. - -## LanguageExtensionsList -### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. - -## LanguageExtension -### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TrackedResourceTags +## DatabasePrincipal ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipalListResult ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **consumerGroup**: string (Required): The event hub consumer group. @@ -228,6 +196,28 @@ * **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -238,51 +228,61 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalProperties -### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal - -## ClusterPrincipalProperties +## KeyVaultProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **keyName**: string (Required): The name of the key vault key. +* **keyVaultUri**: string (Required): The Uri of the key vault. +* **keyVersion**: string (Required): The version of the key vault key. -## FollowerDatabaseListResult +## LanguageExtension ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. -## FollowerDatabaseDefinition +## LanguageExtensionsList ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. ## LanguageExtensionsList ### Properties * **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. -## DatabasePrincipalListResult +## OptimizedAutoscale ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. -## DatabasePrincipal +## ReadOnlyFollowingDatabaseProperties ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## ReadWriteDatabaseProperties +### Properties +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. + +## VirtualNetworkConfiguration +### Properties +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2020-06-14/types.md b/generated/azure-kusto/microsoft.kusto/2020-06-14/types.md index 30c4e28252..7ca62bd34d 100644 --- a/generated/azure-kusto/microsoft.kusto/2020-06-14/types.md +++ b/generated/azure-kusto/microsoft.kusto/2020-06-14/types.md @@ -104,22 +104,29 @@ * **ApiVersion**: 2020-06-14 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AttachedDatabaseConfigurationProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -## IdentityUserAssignedIdentities +## AzureSku ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## ClusterPrincipalProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -138,78 +145,39 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## KeyVaultProperties -### Properties -* **keyName**: string (Required): The name of the key vault key. -* **keyVaultUri**: string (Required): The Uri of the key vault. -* **keyVersion**: string (Required): The version of the key vault key. - -## LanguageExtensionsList -### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. - -## LanguageExtension -### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TrackedResourceTags +## DatabasePrincipal ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipalListResult ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. @@ -231,6 +199,28 @@ * **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -241,51 +231,61 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalProperties -### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal - -## ClusterPrincipalProperties +## KeyVaultProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **keyName**: string (Required): The name of the key vault key. +* **keyVaultUri**: string (Required): The Uri of the key vault. +* **keyVersion**: string (Required): The version of the key vault key. -## FollowerDatabaseListResult +## LanguageExtension ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. -## FollowerDatabaseDefinition +## LanguageExtensionsList ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. ## LanguageExtensionsList ### Properties * **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. -## DatabasePrincipalListResult +## OptimizedAutoscale ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. -## DatabasePrincipal +## ReadOnlyFollowingDatabaseProperties ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## ReadWriteDatabaseProperties +### Properties +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. + +## VirtualNetworkConfiguration +### Properties +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2020-09-18/types.md b/generated/azure-kusto/microsoft.kusto/2020-09-18/types.md index b32bfca460..938755d8c0 100644 --- a/generated/azure-kusto/microsoft.kusto/2020-09-18/types.md +++ b/generated/azure-kusto/microsoft.kusto/2020-09-18/types.md @@ -104,22 +104,29 @@ * **ApiVersion**: 2020-09-18 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AttachedDatabaseConfigurationProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -## IdentityUserAssignedIdentities +## AzureSku ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## ClusterPrincipalProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -139,79 +146,39 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## KeyVaultProperties -### Properties -* **keyName**: string (Required): The name of the key vault key. -* **keyVaultUri**: string (Required): The Uri of the key vault. -* **keyVersion**: string: The version of the key vault key. -* **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. - -## LanguageExtensionsList -### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. - -## LanguageExtension -### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TrackedResourceTags +## DatabasePrincipal ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipalListResult ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. @@ -235,6 +202,28 @@ * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -246,51 +235,62 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalProperties -### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal - -## ClusterPrincipalProperties +## KeyVaultProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **keyName**: string (Required): The name of the key vault key. +* **keyVaultUri**: string (Required): The Uri of the key vault. +* **keyVersion**: string: The version of the key vault key. +* **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. -## FollowerDatabaseListResult +## LanguageExtension ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. -## FollowerDatabaseDefinition +## LanguageExtensionsList ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. ## LanguageExtensionsList ### Properties * **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. -## DatabasePrincipalListResult +## OptimizedAutoscale ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. -## DatabasePrincipal +## ReadOnlyFollowingDatabaseProperties ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewers' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## ReadWriteDatabaseProperties +### Properties +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. + +## VirtualNetworkConfiguration +### Properties +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2021-01-01/types.md b/generated/azure-kusto/microsoft.kusto/2021-01-01/types.md index 9a57daec6b..5ec96f2d4d 100644 --- a/generated/azure-kusto/microsoft.kusto/2021-01-01/types.md +++ b/generated/azure-kusto/microsoft.kusto/2021-01-01/types.md @@ -115,22 +115,30 @@ * **ApiVersion**: 2021-01-01 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AttachedDatabaseConfigurationProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database -## IdentityUserAssignedIdentities +## AzureSku ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## ClusterPrincipalProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -150,89 +158,39 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## KeyVaultProperties -### Properties -* **keyName**: string (Required): The name of the key vault key. -* **keyVaultUri**: string (Required): The Uri of the key vault. -* **keyVersion**: string: The version of the key vault key. -* **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. - -## LanguageExtensionsList -### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. - -## LanguageExtension -### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku -### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. - -## TrackedResourceTags +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipal ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## TableLevelSharingProperties +## DatabasePrincipalListResult ### Properties -* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database -* **externalTablesToInclude**: string[]: List of external tables to include in the follower database -* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database -* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database -* **tablesToExclude**: string[]: List of tables to exclude from the follower database -* **tablesToInclude**: string[]: List of tables to include in the follower database +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. @@ -257,6 +215,28 @@ * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -268,15 +248,49 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalProperties +## KeyVaultProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **keyName**: string (Required): The name of the key vault key. +* **keyVaultUri**: string (Required): The Uri of the key vault. +* **keyVersion**: string: The version of the key vault key. +* **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. + +## LanguageExtension +### Properties +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. + +## LanguageExtensionsList +### Properties +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. + +## LanguageExtensionsList +### Properties +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. + +## OptimizedAutoscale +### Properties +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. + +## ReadOnlyFollowingDatabaseProperties +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. + +## ReadWriteDatabaseProperties +### Properties +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. ## ScriptProperties ### Properties @@ -295,41 +309,27 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ClusterPrincipalProperties -### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal - -## FollowerDatabaseListResult -### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. - -## FollowerDatabaseDefinition +## TableLevelSharingProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database +* **externalTablesToInclude**: string[]: List of external tables to include in the follower database +* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database +* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database +* **tablesToExclude**: string[]: List of tables to exclude from the follower database +* **tablesToInclude**: string[]: List of tables to include in the follower database -## LanguageExtensionsList +## TrackedResourceTags ### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. +### Additional Properties +* **Additional Properties Type**: string -## DatabasePrincipalListResult +## TrustedExternalTenant ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **value**: string: GUID representing an external tenant. -## DatabasePrincipal +## VirtualNetworkConfiguration ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2021-08-27/types.md b/generated/azure-kusto/microsoft.kusto/2021-08-27/types.md index 65afbe6d14..afafaed43f 100644 --- a/generated/azure-kusto/microsoft.kusto/2021-08-27/types.md +++ b/generated/azure-kusto/microsoft.kusto/2021-08-27/types.md @@ -136,22 +136,34 @@ * **ApiVersion**: 2021-08-27 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AcceptedAudiences ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **value**: string: GUID or valid URL representing an accepted audience. -## IdentityUserAssignedIdentities +## AttachedDatabaseConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## AzureSku ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. + +## ClusterPrincipalProperties +### Properties +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -177,102 +189,39 @@ * **uri**: string (ReadOnly): The cluster URI. * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## AcceptedAudiences -### Properties -* **value**: string: GUID or valid URL representing an accepted audience. - -## KeyVaultProperties -### Properties -* **keyName**: string: The name of the key vault key. -* **keyVaultUri**: string: The Uri of the key vault. -* **keyVersion**: string: The version of the key vault key. -* **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. - -## LanguageExtensionsList -### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. - -## LanguageExtension -### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. - -## OptimizedAutoscale -### Properties -* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. -* **maximum**: int (Required): Maximum allowed instances count. -* **minimum**: int (Required): Minimum allowed instances count. -* **version**: int (Required): The version of the template defined, for instance 1. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku -### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## AttachedDatabaseConfigurationProperties +## DatabasePrincipal ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. -## TableLevelSharingProperties +## DatabasePrincipalListResult ### Properties -* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database -* **externalTablesToInclude**: string[]: List of external tables to include in the follower database -* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database -* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database -* **tablesToExclude**: string[]: List of tables to exclude from the follower database -* **tablesToInclude**: string[]: List of tables to include in the follower database +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. -## ReadOnlyFollowingDatabaseProperties +## DatabasePrincipalProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster -* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## DatabaseStatistics ### Properties * **size**: int: The database size - the total size of compressed data and index in bytes. -## ReadWriteDatabaseProperties -### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. - ## EventGridConnectionProperties ### Properties * **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. @@ -297,6 +246,28 @@ * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + ## IotHubConnectionProperties ### Properties * **consumerGroup**: string (Required): The iot hub consumer group. @@ -308,23 +279,24 @@ * **sharedAccessPolicyName**: string (Required): The name of the share access policy * **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## DatabasePrincipalProperties +## KeyVaultProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **keyName**: string: The name of the key vault key. +* **keyVaultUri**: string: The Uri of the key vault. +* **keyVersion**: string: The version of the key vault key. +* **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. -## ScriptProperties +## LanguageExtension ### Properties -* **continueOnErrors**: bool: Flag that indicates whether to continue if one of the command fails. -* **forceUpdateTag**: string: A unique string. If changed the script will be applied again. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **scriptUrl**: string (Required): The url to the KQL script blob file. -* **scriptUrlSasToken**: string (Required, WriteOnly): The SaS token. +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. + +## LanguageExtensionsList +### Properties +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. + +## LanguageExtensionsList +### Properties +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. ## ManagedPrivateEndpointProperties ### Properties @@ -334,15 +306,12 @@ * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. * **requestMessage**: string: The user request message. -## ClusterPrincipalProperties +## OptimizedAutoscale ### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **isEnabled**: bool (Required): A boolean value that indicate if the optimized autoscale feature is enabled or not. +* **maximum**: int (Required): Maximum allowed instances count. +* **minimum**: int (Required): Minimum allowed instances count. +* **version**: int (Required): The version of the template defined, for instance 1. ## PrivateEndpointConnectionProperties ### Properties @@ -361,31 +330,62 @@ * **description**: string: The private link service connection description. * **status**: string: The private link service connection status. -## FollowerDatabaseListResult +## ReadOnlyFollowingDatabaseProperties ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **leaderClusterResourceId**: string (ReadOnly): The name of the leader cluster +* **principalsModificationKind**: 'None' | 'Replace' | 'Union' | string (ReadOnly): The principals modification kind of the database +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## FollowerDatabaseDefinition +## ReadWriteDatabaseProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## LanguageExtensionsList +## ScriptProperties ### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. +* **continueOnErrors**: bool: Flag that indicates whether to continue if one of the command fails. +* **forceUpdateTag**: string: A unique string. If changed the script will be applied again. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **scriptUrl**: string (Required): The url to the KQL script blob file. +* **scriptUrlSasToken**: string (Required, WriteOnly): The SaS token. -## DatabasePrincipalListResult +## SystemData ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DatabasePrincipal +## TableLevelSharingProperties ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database +* **externalTablesToInclude**: string[]: List of external tables to include in the follower database +* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database +* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database +* **tablesToExclude**: string[]: List of tables to exclude from the follower database +* **tablesToInclude**: string[]: List of tables to include in the follower database + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrustedExternalTenant +### Properties +* **value**: string: GUID representing an external tenant. + +## VirtualNetworkConfiguration +### Properties +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azure-kusto/microsoft.kusto/2022-02-01/types.md b/generated/azure-kusto/microsoft.kusto/2022-02-01/types.md index 6e56677fc1..de5acab978 100644 --- a/generated/azure-kusto/microsoft.kusto/2022-02-01/types.md +++ b/generated/azure-kusto/microsoft.kusto/2022-02-01/types.md @@ -136,22 +136,35 @@ * **ApiVersion**: 2022-02-01 * **Output**: [DatabasePrincipalListResult](#databaseprincipallistresult) -## Identity +## AcceptedAudiences ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. +* **value**: string: GUID or valid URL representing an accepted audience. -## IdentityUserAssignedIdentities +## AttachedDatabaseConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. +* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties +## AzureSku ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_D16d_v5' | 'Standard_D32d_v4' | 'Standard_D32d_v5' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16ads_v5' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E16as_v5+3TB_PS' | 'Standard_E16as_v5+4TB_PS' | 'Standard_E16s_v4+3TB_PS' | 'Standard_E16s_v4+4TB_PS' | 'Standard_E16s_v5+3TB_PS' | 'Standard_E16s_v5+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E2ads_v5' | 'Standard_E4a_v4' | 'Standard_E4ads_v5' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8ads_v5' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_E8as_v5+1TB_PS' | 'Standard_E8as_v5+2TB_PS' | 'Standard_E8s_v4+1TB_PS' | 'Standard_E8s_v4+2TB_PS' | 'Standard_E8s_v5+1TB_PS' | 'Standard_E8s_v5+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. + +## ClusterPrincipalProperties +### Properties +* **aadObjectId**: string (ReadOnly): The service principal object id in AAD (Azure active directory) +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal ## ClusterProperties ### Properties @@ -180,9 +193,103 @@ * **virtualClusterGraduationProperties**: string (WriteOnly): Virtual Cluster graduation properties * **virtualNetworkConfiguration**: [VirtualNetworkConfiguration](#virtualnetworkconfiguration): A class that contains virtual network definition. -## AcceptedAudiences +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **value**: string: GUID or valid URL representing an accepted audience. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## DatabasePrincipal +### Properties +* **appId**: string (ReadOnly): Application id - relevant only for application principal type. +* **email**: string (ReadOnly): Database principal email if exists. +* **fqn**: string (ReadOnly): Database principal fully qualified name. +* **name**: string (ReadOnly): Database principal name. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. +* **tenantName**: string (ReadOnly): The tenant name of the principal +* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. + +## DatabasePrincipalListResult +### Properties +* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. + +## DatabasePrincipalProperties +### Properties +* **aadObjectId**: string (ReadOnly): The service principal object id in AAD (Azure active directory) +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal + +## DatabaseStatistics +### Properties +* **size**: int: The database size - the total size of compressed data and index in bytes. + +## EventGridConnectionProperties +### Properties +* **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. +* **consumerGroup**: string (Required): The event hub consumer group. +* **databaseRouting**: 'Multi' | 'Single' | string: Indication for database routing information from the data connection, by default only database routing information is allowed +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventGridResourceId**: string: The resource ID of the event grid that is subscribed to the storage account events. +* **eventHubResourceId**: string (Required): The resource ID where the event grid is configured to send events. +* **ignoreFirstRecord**: bool: A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file +* **managedIdentityObjectId**: string (ReadOnly): The object ID of managedIdentityResourceId +* **managedIdentityResourceId**: string: Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **storageAccountResourceId**: string (Required): The resource ID of the storage account where the data resides. +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. + +## EventHubConnectionProperties +### Properties +* **compression**: 'GZip' | 'None' | string: The compression type +* **consumerGroup**: string (Required): The event hub consumer group. +* **databaseRouting**: 'Multi' | 'Single' | string: Indication for database routing information from the data connection, by default only database routing information is allowed +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventHubResourceId**: string (Required): The resource ID of the event hub to be used to create a data connection. +* **eventSystemProperties**: string[]: System properties of the event hub +* **managedIdentityObjectId**: string (ReadOnly): The object ID of the managedIdentityResourceId +* **managedIdentityResourceId**: string: Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. + +## FollowerDatabaseDefinition +### Properties +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): 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. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) + +## IotHubConnectionProperties +### Properties +* **consumerGroup**: string (Required): The iot hub consumer group. +* **databaseRouting**: 'Multi' | 'Single' | string: Indication for database routing information from the data connection, by default only database routing information is allowed +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventSystemProperties**: string[]: System properties of the iot hub +* **iotHubResourceId**: string (Required): The resource ID of the Iot hub to be used to create a data connection. +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **sharedAccessPolicyName**: string (Required): The name of the share access policy +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. ## KeyVaultProperties ### Properties @@ -191,13 +298,25 @@ * **keyVersion**: string: The version of the key vault key. * **userIdentity**: string: The user assigned identity (ARM resource id) that has access to the key. +## LanguageExtension +### Properties +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. + ## LanguageExtensionsList ### Properties * **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. -## LanguageExtension +## LanguageExtensionsList ### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. + +## ManagedPrivateEndpointProperties +### Properties +* **groupId**: string (Required): The groupId in which the managed private endpoint is created. +* **privateLinkResourceId**: string (Required): The ARM resource ID of the resource for which the managed private endpoint is created. +* **privateLinkResourceRegion**: string: The region of the resource to which the managed private endpoint is created. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **requestMessage**: string: The user request message. ## OptimizedAutoscale ### Properties @@ -231,54 +350,6 @@ * **description**: string: The private link service connection description. * **status**: string: The private link service connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrustedExternalTenant -### Properties -* **value**: string: GUID representing an external tenant. - -## VirtualNetworkConfiguration -### Properties -* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. -* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. -* **subnetId**: string (Required): The subnet resource id. - -## AzureSku -### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_D16d_v5' | 'Standard_D32d_v4' | 'Standard_D32d_v5' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16ads_v5' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E16as_v5+3TB_PS' | 'Standard_E16as_v5+4TB_PS' | 'Standard_E16s_v4+3TB_PS' | 'Standard_E16s_v4+4TB_PS' | 'Standard_E16s_v5+3TB_PS' | 'Standard_E16s_v5+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E2ads_v5' | 'Standard_E4a_v4' | 'Standard_E4ads_v5' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8ads_v5' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_E8as_v5+1TB_PS' | 'Standard_E8as_v5+2TB_PS' | 'Standard_E8s_v4+1TB_PS' | 'Standard_E8s_v4+2TB_PS' | 'Standard_E8s_v5+1TB_PS' | 'Standard_E8s_v5+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AttachedDatabaseConfigurationProperties -### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the cluster. -* **clusterResourceId**: string (Required): The resource id of the cluster where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database - -## TableLevelSharingProperties -### Properties -* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database -* **externalTablesToInclude**: string[]: List of external tables to include in the follower database -* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database -* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database -* **tablesToExclude**: string[]: List of tables to exclude from the follower database -* **tablesToInclude**: string[]: List of tables to include in the follower database - ## ReadOnlyFollowingDatabaseProperties ### Properties * **attachedDatabaseConfigurationName**: string (ReadOnly): The name of the attached database configuration cluster @@ -289,10 +360,6 @@ * **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. * **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## DatabaseStatistics -### Properties -* **size**: int: The database size - the total size of compressed data and index in bytes. - ## ReadWriteDatabaseProperties ### Properties * **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. @@ -301,59 +368,6 @@ * **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. * **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## EventGridConnectionProperties -### Properties -* **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. -* **consumerGroup**: string (Required): The event hub consumer group. -* **databaseRouting**: 'Multi' | 'Single' | string: Indication for database routing information from the data connection, by default only database routing information is allowed -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventGridResourceId**: string: The resource ID of the event grid that is subscribed to the storage account events. -* **eventHubResourceId**: string (Required): The resource ID where the event grid is configured to send events. -* **ignoreFirstRecord**: bool: A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file -* **managedIdentityObjectId**: string (ReadOnly): The object ID of managedIdentityResourceId -* **managedIdentityResourceId**: string: Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **storageAccountResourceId**: string (Required): The resource ID of the storage account where the data resides. -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. - -## EventHubConnectionProperties -### Properties -* **compression**: 'GZip' | 'None' | string: The compression type -* **consumerGroup**: string (Required): The event hub consumer group. -* **databaseRouting**: 'Multi' | 'Single' | string: Indication for database routing information from the data connection, by default only database routing information is allowed -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventHubResourceId**: string (Required): The resource ID of the event hub to be used to create a data connection. -* **eventSystemProperties**: string[]: System properties of the event hub -* **managedIdentityObjectId**: string (ReadOnly): The object ID of the managedIdentityResourceId -* **managedIdentityResourceId**: string: Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id. -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. - -## IotHubConnectionProperties -### Properties -* **consumerGroup**: string (Required): The iot hub consumer group. -* **databaseRouting**: 'Multi' | 'Single' | string: Indication for database routing information from the data connection, by default only database routing information is allowed -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventSystemProperties**: string[]: System properties of the iot hub -* **iotHubResourceId**: string (Required): The resource ID of the Iot hub to be used to create a data connection. -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **sharedAccessPolicyName**: string (Required): The name of the share access policy -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. - -## DatabasePrincipalProperties -### Properties -* **aadObjectId**: string (ReadOnly): The service principal object id in AAD (Azure active directory) -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal - ## ScriptProperties ### Properties * **continueOnErrors**: bool: Flag that indicates whether to continue if one of the command fails. @@ -363,50 +377,36 @@ * **scriptUrl**: string: The url to the KQL script blob file. Must not be used together with scriptContent property * **scriptUrlSasToken**: string (WriteOnly): The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. -## ManagedPrivateEndpointProperties -### Properties -* **groupId**: string (Required): The groupId in which the managed private endpoint is created. -* **privateLinkResourceId**: string (Required): The ARM resource ID of the resource for which the managed private endpoint is created. -* **privateLinkResourceRegion**: string: The region of the resource to which the managed private endpoint is created. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **requestMessage**: string: The user request message. - -## ClusterPrincipalProperties -### Properties -* **aadObjectId**: string (ReadOnly): The service principal object id in AAD (Azure active directory) -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal - -## FollowerDatabaseListResult +## SystemData ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## FollowerDatabaseDefinition +## TableLevelSharingProperties ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database +* **externalTablesToInclude**: string[]: List of external tables to include in the follower database +* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database +* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database +* **tablesToExclude**: string[]: List of tables to exclude from the follower database +* **tablesToInclude**: string[]: List of tables to include in the follower database -## LanguageExtensionsList +## TrackedResourceTags ### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. +### Additional Properties +* **Additional Properties Type**: string -## DatabasePrincipalListResult +## TrustedExternalTenant ### Properties -* **value**: [DatabasePrincipal](#databaseprincipal)[] (ReadOnly): The list of Kusto database principals. +* **value**: string: GUID representing an external tenant. -## DatabasePrincipal +## VirtualNetworkConfiguration ### Properties -* **appId**: string (ReadOnly): Application id - relevant only for application principal type. -* **email**: string (ReadOnly): Database principal email if exists. -* **fqn**: string (ReadOnly): Database principal fully qualified name. -* **name**: string (ReadOnly): Database principal name. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (ReadOnly): Database principal role. -* **tenantName**: string (ReadOnly): The tenant name of the principal -* **type**: 'App' | 'Group' | 'User' | string (ReadOnly): Database principal type. +* **dataManagementPublicIpId**: string (Required): Data management's service public IP address resource id. +* **enginePublicIpId**: string (Required): Engine service's public IP address resource id. +* **subnetId**: string (Required): The subnet resource id. diff --git a/generated/azureactivedirectory/log.out b/generated/azureactivedirectory/log.out index b5de3f4f59..c5920afe6b 100644 --- a/generated/azureactivedirectory/log.out +++ b/generated/azureactivedirectory/log.out @@ -11,7 +11,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.aadiam-2017-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -22,7 +22,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2017-04-01-preview/azureactivedirectory.json:254:5 @@ -43,7 +43,7 @@ warning | PreCheck/SchemaMissingType | The schema 'DiagnosticSettingsCategory' w warning | PreCheck/SchemaMissingType | The schema 'DiagnosticSettingsCategoryResourceCollection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2017-04-01-preview/azureactivedirectory.json:517:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.aadiam-2020-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -54,7 +54,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureADMetricsPropertiesFormat' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json:339:5 @@ -63,7 +63,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefi warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json:379:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.aadiam-2020-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -74,7 +74,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json:410:5 @@ -93,7 +93,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' @@ -110,7 +110,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json:254:5 @@ -132,4 +132,4 @@ warning | PreCheck/SchemaMissingType | The schema 'DiagnosticSettingsCategoryRes - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json:513:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 10.06s. 10 files generated. +info | Autorest completed in 9.8s. 10 files generated. diff --git a/generated/azureactivedirectory/microsoft.aadiam/2020-03-01/types.md b/generated/azureactivedirectory/microsoft.aadiam/2020-03-01/types.md index 01b992d829..1b5ae6bc44 100644 --- a/generated/azureactivedirectory/microsoft.aadiam/2020-03-01/types.md +++ b/generated/azureactivedirectory/microsoft.aadiam/2020-03-01/types.md @@ -24,10 +24,9 @@ * **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. * **type**: 'microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## PrivateLinkPolicyTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Full identifier of the private endpoint resource. ## PrivateEndpointConnectionProperties ### Properties @@ -36,9 +35,16 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkPolicyTags ### Properties -* **id**: string: Full identifier of the private endpoint resource. +### Additional Properties +* **Additional Properties Type**: string + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval or rejection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## TagsResource ### Properties @@ -49,9 +55,3 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval or rejection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - diff --git a/generated/azurearcdata/log.out b/generated/azurearcdata/log.out index 56067dc57e..56815c03ad 100644 --- a/generated/azurearcdata/log.out +++ b/generated/azurearcdata/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.azurearcdata-2022-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -17,10 +17,10 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 17ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.azurearcdata-2021-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -32,7 +32,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.azurearcdata-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -41,10 +41,10 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.azurearcdata-2021-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -53,11 +53,11 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.azurearcdata-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 4ms -info | Autorest completed in 14.84s. 10 files generated. +info | Autorest completed in 14.25s. 10 files generated. diff --git a/generated/azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.md b/generated/azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.md index fa8e48b665..8cd7132b04 100644 --- a/generated/azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.md +++ b/generated/azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.md @@ -53,10 +53,10 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureArcData/sqlServerInstances' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation +## BasicLoginInformation ### Properties -* **name**: string: The name of the extended location. -* **type**: 'CustomLocation' | string: The type of extendedLocation. +* **password**: string (WriteOnly): Login password. +* **username**: string: Login username. ## DataControllerProperties ### Properties @@ -69,10 +69,10 @@ * **uploadServicePrincipal**: [UploadServicePrincipal](#uploadserviceprincipal): Service principal for uploading billing, metrics and logs. * **uploadWatermark**: [UploadWatermark](#uploadwatermark): Properties on upload watermark. Mostly timestamp for each upload data type -## BasicLoginInformation +## ExtendedLocation ### Properties -* **password**: string (WriteOnly): Login password. -* **username**: string: Login username. +* **name**: string: The name of the extended location. +* **type**: 'CustomLocation' | string: The type of extendedLocation. ## LogAnalyticsWorkspaceConfig ### Properties @@ -85,33 +85,6 @@ * **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing * **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded -## UploadServicePrincipal -### Properties -* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ -* **clientId**: string: Client ID of the service principal for uploading data. -* **clientSecret**: string (WriteOnly): Secret of the service principal -* **tenantId**: string: Tenant ID of the service principal. - -## UploadWatermark -### Properties -* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time -* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time -* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## PostgresInstanceProperties ### Properties * **admin**: string: The instance admin @@ -130,11 +103,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Hyperscale': This field is required to be implemented by the Resource Provider if the service has more than one tier. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlManagedInstanceProperties ### Properties * **admin**: string: The instance admin user @@ -155,11 +123,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'BusinessCritical' | 'GeneralPurpose': This field is required to be implemented by the Resource Provider if the service has more than one tier. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlServerInstanceProperties ### Properties * **collation**: string: SQL Server collation. @@ -178,8 +141,45 @@ * **vCore**: string: The number of logical processors used by the SQL Server instance. * **version**: string: SQL Server version. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UploadServicePrincipal +### Properties +* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ +* **clientId**: string: Client ID of the service principal for uploading data. +* **clientSecret**: string (WriteOnly): Secret of the service principal +* **tenantId**: string: Tenant ID of the service principal. + +## UploadWatermark +### Properties +* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time +* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time +* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time + diff --git a/generated/azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.md b/generated/azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.md index f04de45d75..ed012802a6 100644 --- a/generated/azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.md +++ b/generated/azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.md @@ -53,10 +53,10 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureArcData/sqlServerInstances' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation +## BasicLoginInformation ### Properties -* **name**: string: The name of the extended location. -* **type**: 'CustomLocation' | string: The type of extendedLocation. +* **password**: string (WriteOnly): Login password. +* **username**: string: Login username. ## DataControllerProperties ### Properties @@ -70,10 +70,10 @@ * **uploadServicePrincipal**: [UploadServicePrincipal](#uploadserviceprincipal): Service principal for uploading billing, metrics and logs. * **uploadWatermark**: [UploadWatermark](#uploadwatermark): Properties on upload watermark. Mostly timestamp for each upload data type -## BasicLoginInformation +## ExtendedLocation ### Properties -* **password**: string (WriteOnly): Login password. -* **username**: string: Login username. +* **name**: string: The name of the extended location. +* **type**: 'CustomLocation' | string: The type of extendedLocation. ## LogAnalyticsWorkspaceConfig ### Properties @@ -86,33 +86,6 @@ * **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing * **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded -## UploadServicePrincipal -### Properties -* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ -* **clientId**: string: Client ID of the service principal for uploading data. -* **clientSecret**: string (WriteOnly): Secret of the service principal -* **tenantId**: string: Tenant ID of the service principal. - -## UploadWatermark -### Properties -* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time -* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time -* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## PostgresInstanceProperties ### Properties * **admin**: string: The instance admin @@ -131,11 +104,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Hyperscale': This field is required to be implemented by the Resource Provider if the service has more than one tier. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlManagedInstanceProperties ### Properties * **admin**: string: The instance admin user @@ -157,11 +125,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'BusinessCritical' | 'GeneralPurpose': The tier for this managed instance. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlServerInstanceProperties ### Properties * **azureDefenderStatus**: string: Status of Azure Defender. @@ -182,8 +145,45 @@ * **vCore**: string: The number of logical processors used by the SQL Server instance. * **version**: string: SQL Server version. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UploadServicePrincipal +### Properties +* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ +* **clientId**: string: Client ID of the service principal for uploading data. +* **clientSecret**: string (WriteOnly): Secret of the service principal +* **tenantId**: string: Tenant ID of the service principal. + +## UploadWatermark +### Properties +* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time +* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time +* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time + diff --git a/generated/azurearcdata/microsoft.azurearcdata/2021-08-01/types.md b/generated/azurearcdata/microsoft.azurearcdata/2021-08-01/types.md index 0e4a79fdd8..0bd110dff3 100644 --- a/generated/azurearcdata/microsoft.azurearcdata/2021-08-01/types.md +++ b/generated/azurearcdata/microsoft.azurearcdata/2021-08-01/types.md @@ -39,10 +39,10 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureArcData/sqlServerInstances' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation +## BasicLoginInformation ### Properties -* **name**: string: The name of the extended location. -* **type**: 'CustomLocation' | string: The type of extendedLocation. +* **password**: string (WriteOnly): Login password. +* **username**: string: Login username. ## DataControllerProperties ### Properties @@ -58,75 +58,27 @@ * **uploadServicePrincipal**: [UploadServicePrincipal](#uploadserviceprincipal): Service principal for uploading billing, metrics and logs. * **uploadWatermark**: [UploadWatermark](#uploadwatermark): Properties on upload watermark. Mostly timestamp for each upload data type -## BasicLoginInformation -### Properties -* **password**: string (WriteOnly): Login password. -* **username**: string: Login username. - -## LogAnalyticsWorkspaceConfig -### Properties -* **primaryKey**: string (WriteOnly): Primary key of the workspace -* **workspaceId**: string: Azure Log Analytics workspace ID - -## OnPremiseProperty -### Properties -* **id**: string (Required): A globally unique ID identifying the associated Kubernetes cluster -* **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing -* **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded - -## UploadServicePrincipal -### Properties -* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ -* **clientId**: string: Client ID of the service principal for uploading data. -* **clientSecret**: string (WriteOnly): Secret of the service principal -* **tenantId**: string: Tenant ID of the service principal. - -## UploadWatermark -### Properties -* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time -* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time -* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time - -## SystemData +## ExtendedLocation ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **name**: string: The name of the extended location. +* **type**: 'CustomLocation' | string: The type of extendedLocation. -## TrackedResourceTags +## K8SResourceRequirements ### Properties +* **limits**: [K8SResourceRequirementsLimits](#k8sresourcerequirementslimits): Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. +* **requests**: [K8SResourceRequirementsRequests](#k8sresourcerequirementsrequests): Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ### Additional Properties -* **Additional Properties Type**: string - -## SqlManagedInstanceProperties -### Properties -* **admin**: string: The instance admin user -* **basicLoginInformation**: [BasicLoginInformation](#basiclogininformation): Username and password for basic login authentication. -* **clusterId**: string: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. -* **dataControllerId**: string: null -* **endTime**: string: The instance end time -* **extensionId**: string: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. -* **k8sRaw**: [SqlManagedInstanceK8SRaw](#sqlmanagedinstancek8sraw): The raw kubernetes information. -* **lastUploadedDate**: string: Last uploaded date from Kubernetes cluster. Defaults to current date time -* **licenseType**: 'BasePrice' | 'LicenseIncluded': The license type to apply for this managed instance. -* **provisioningState**: string (ReadOnly) -* **startTime**: string: The instance start time +* **Additional Properties Type**: any -## SqlManagedInstanceK8SRaw +## K8SResourceRequirementsLimits ### Properties -* **spec**: [SqlManagedInstanceK8SSpec](#sqlmanagedinstancek8sspec): The kubernetes spec information. ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string -## SqlManagedInstanceK8SSpec +## K8SResourceRequirementsRequests ### Properties -* **replicas**: int: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. -* **scheduling**: [K8SScheduling](#k8sscheduling): The kubernetes scheduling information. ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string ## K8SScheduling ### Properties @@ -140,22 +92,43 @@ ### Additional Properties * **Additional Properties Type**: any -## K8SResourceRequirements +## LogAnalyticsWorkspaceConfig ### Properties -* **limits**: [K8SResourceRequirementsLimits](#k8sresourcerequirementslimits): Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. -* **requests**: [K8SResourceRequirementsRequests](#k8sresourcerequirementsrequests): Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. +* **primaryKey**: string (WriteOnly): Primary key of the workspace +* **workspaceId**: string: Azure Log Analytics workspace ID + +## OnPremiseProperty +### Properties +* **id**: string (Required): A globally unique ID identifying the associated Kubernetes cluster +* **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing +* **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded + +## SqlManagedInstanceK8SRaw +### Properties +* **spec**: [SqlManagedInstanceK8SSpec](#sqlmanagedinstancek8sspec): The kubernetes spec information. ### Additional Properties * **Additional Properties Type**: any -## K8SResourceRequirementsLimits +## SqlManagedInstanceK8SSpec ### Properties +* **replicas**: int: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. +* **scheduling**: [K8SScheduling](#k8sscheduling): The kubernetes scheduling information. ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any -## K8SResourceRequirementsRequests +## SqlManagedInstanceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **admin**: string: The instance admin user +* **basicLoginInformation**: [BasicLoginInformation](#basiclogininformation): Username and password for basic login authentication. +* **clusterId**: string: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. +* **dataControllerId**: string: null +* **endTime**: string: The instance end time +* **extensionId**: string: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. +* **k8sRaw**: [SqlManagedInstanceK8SRaw](#sqlmanagedinstancek8sraw): The raw kubernetes information. +* **lastUploadedDate**: string: Last uploaded date from Kubernetes cluster. Defaults to current date time +* **licenseType**: 'BasePrice' | 'LicenseIncluded': The license type to apply for this managed instance. +* **provisioningState**: string (ReadOnly) +* **startTime**: string: The instance start time ## SqlManagedInstanceSku ### Properties @@ -166,11 +139,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'BusinessCritical' | 'GeneralPurpose': The pricing tier for the instance. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlServerInstanceProperties ### Properties * **azureDefenderStatus**: 'Protected' | 'Unknown' | 'Unprotected' | string: Status of Azure Defender. @@ -191,8 +159,40 @@ * **vCore**: string: The number of logical processors used by the SQL Server instance. * **version**: 'SQL Server 2016' | 'SQL Server 2017' | 'SQL Server 2019' | string: SQL Server version. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UploadServicePrincipal +### Properties +* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ +* **clientId**: string: Client ID of the service principal for uploading data. +* **clientSecret**: string (WriteOnly): Secret of the service principal +* **tenantId**: string: Tenant ID of the service principal. + +## UploadWatermark +### Properties +* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time +* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time +* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time + diff --git a/generated/azurearcdata/microsoft.azurearcdata/2021-11-01/types.md b/generated/azurearcdata/microsoft.azurearcdata/2021-11-01/types.md index 59dd5f6fb0..d726959de0 100644 --- a/generated/azurearcdata/microsoft.azurearcdata/2021-11-01/types.md +++ b/generated/azurearcdata/microsoft.azurearcdata/2021-11-01/types.md @@ -39,10 +39,10 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureArcData/sqlServerInstances' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation +## BasicLoginInformation ### Properties -* **name**: string: The name of the extended location. -* **type**: 'CustomLocation' | string: The type of extendedLocation. +* **password**: string (WriteOnly): Login password. +* **username**: string: Login username. ## DataControllerProperties ### Properties @@ -60,75 +60,27 @@ * **uploadServicePrincipal**: [UploadServicePrincipal](#uploadserviceprincipal): Service principal for uploading billing, metrics and logs. * **uploadWatermark**: [UploadWatermark](#uploadwatermark): Properties on upload watermark. Mostly timestamp for each upload data type -## BasicLoginInformation -### Properties -* **password**: string (WriteOnly): Login password. -* **username**: string: Login username. - -## LogAnalyticsWorkspaceConfig -### Properties -* **primaryKey**: string (WriteOnly): Primary key of the workspace -* **workspaceId**: string: Azure Log Analytics workspace ID - -## OnPremiseProperty -### Properties -* **id**: string (Required): A globally unique ID identifying the associated Kubernetes cluster -* **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing -* **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded - -## UploadServicePrincipal -### Properties -* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ -* **clientId**: string: Client ID of the service principal for uploading data. -* **clientSecret**: string (WriteOnly): Secret of the service principal -* **tenantId**: string: Tenant ID of the service principal. - -## UploadWatermark -### Properties -* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time -* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time -* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time - -## SystemData +## ExtendedLocation ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **name**: string: The name of the extended location. +* **type**: 'CustomLocation' | string: The type of extendedLocation. -## TrackedResourceTags +## K8SResourceRequirements ### Properties +* **limits**: [K8SResourceRequirementsLimits](#k8sresourcerequirementslimits): Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. +* **requests**: [K8SResourceRequirementsRequests](#k8sresourcerequirementsrequests): Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. ### Additional Properties -* **Additional Properties Type**: string - -## SqlManagedInstanceProperties -### Properties -* **admin**: string: The instance admin user -* **basicLoginInformation**: [BasicLoginInformation](#basiclogininformation): Username and password for basic login authentication. -* **clusterId**: string: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. -* **dataControllerId**: string: null -* **endTime**: string: The instance end time -* **extensionId**: string: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. -* **k8sRaw**: [SqlManagedInstanceK8SRaw](#sqlmanagedinstancek8sraw): The raw kubernetes information. -* **lastUploadedDate**: string: Last uploaded date from Kubernetes cluster. Defaults to current date time -* **licenseType**: 'BasePrice' | 'DisasterRecovery' | 'LicenseIncluded' | string: The license type to apply for this managed instance. -* **provisioningState**: string (ReadOnly) -* **startTime**: string: The instance start time +* **Additional Properties Type**: any -## SqlManagedInstanceK8SRaw +## K8SResourceRequirementsLimits ### Properties -* **spec**: [SqlManagedInstanceK8SSpec](#sqlmanagedinstancek8sspec): The kubernetes spec information. ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string -## SqlManagedInstanceK8SSpec +## K8SResourceRequirementsRequests ### Properties -* **replicas**: int: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. -* **scheduling**: [K8SScheduling](#k8sscheduling): The kubernetes scheduling information. ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string ## K8SScheduling ### Properties @@ -142,22 +94,43 @@ ### Additional Properties * **Additional Properties Type**: any -## K8SResourceRequirements +## LogAnalyticsWorkspaceConfig ### Properties -* **limits**: [K8SResourceRequirementsLimits](#k8sresourcerequirementslimits): Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. -* **requests**: [K8SResourceRequirementsRequests](#k8sresourcerequirementsrequests): Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. +* **primaryKey**: string (WriteOnly): Primary key of the workspace +* **workspaceId**: string: Azure Log Analytics workspace ID + +## OnPremiseProperty +### Properties +* **id**: string (Required): A globally unique ID identifying the associated Kubernetes cluster +* **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing +* **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded + +## SqlManagedInstanceK8SRaw +### Properties +* **spec**: [SqlManagedInstanceK8SSpec](#sqlmanagedinstancek8sspec): The kubernetes spec information. ### Additional Properties * **Additional Properties Type**: any -## K8SResourceRequirementsLimits +## SqlManagedInstanceK8SSpec ### Properties +* **replicas**: int: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. +* **scheduling**: [K8SScheduling](#k8sscheduling): The kubernetes scheduling information. ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any -## K8SResourceRequirementsRequests +## SqlManagedInstanceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **admin**: string: The instance admin user +* **basicLoginInformation**: [BasicLoginInformation](#basiclogininformation): Username and password for basic login authentication. +* **clusterId**: string: If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. +* **dataControllerId**: string: null +* **endTime**: string: The instance end time +* **extensionId**: string: If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. +* **k8sRaw**: [SqlManagedInstanceK8SRaw](#sqlmanagedinstancek8sraw): The raw kubernetes information. +* **lastUploadedDate**: string: Last uploaded date from Kubernetes cluster. Defaults to current date time +* **licenseType**: 'BasePrice' | 'DisasterRecovery' | 'LicenseIncluded' | string: The license type to apply for this managed instance. +* **provisioningState**: string (ReadOnly) +* **startTime**: string: The instance start time ## SqlManagedInstanceSku ### Properties @@ -168,11 +141,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'BusinessCritical' | 'GeneralPurpose': The pricing tier for the instance. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlServerInstanceProperties ### Properties * **azureDefenderStatus**: 'Protected' | 'Unknown' | 'Unprotected' | string: Status of Azure Defender. @@ -193,8 +161,40 @@ * **vCore**: string: The number of logical processors used by the SQL Server instance. * **version**: 'SQL Server 2016' | 'SQL Server 2017' | 'SQL Server 2019' | string: SQL Server version. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UploadServicePrincipal +### Properties +* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ +* **clientId**: string: Client ID of the service principal for uploading data. +* **clientSecret**: string (WriteOnly): Secret of the service principal +* **tenantId**: string: Tenant ID of the service principal. + +## UploadWatermark +### Properties +* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time +* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time +* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time + diff --git a/generated/azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.md b/generated/azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.md index 1e6a5a22e3..8b9d35699b 100644 --- a/generated/azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.md +++ b/generated/azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.md @@ -63,10 +63,58 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureArcData/sqlServerInstances' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation +## ActiveDirectoryConnectorDNSDetails ### Properties -* **name**: string: The name of the extended location. -* **type**: 'CustomLocation' | string: The type of extendedLocation. +* **domainName**: string: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. +* **nameserverIPAddresses**: string[] (Required): List of Active Directory DNS server IP addresses. +* **preferK8sDnsForPtrLookups**: bool: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. +* **replicas**: int: Replica count for DNS proxy service. Default value is 1. + +## ActiveDirectoryConnectorDomainDetails +### Properties +* **domainControllers**: [ActiveDirectoryDomainControllers](#activedirectorydomaincontrollers) (Required): Details about the Active Directory domain controllers associated with this AD connector instance +* **netbiosDomainName**: string: NETBIOS name of the Active Directory domain. +* **ouDistinguishedName**: string: The distinguished name of the Active Directory Organizational Unit. +* **realm**: string (Required): Name (uppercase) of the Active Directory domain that this AD connector will be associated with. +* **serviceAccountProvisioning**: 'automatic' | 'manual' | string: The service account provisioning mode for this Active Directory connector. + +## ActiveDirectoryConnectorProperties +### Properties +* **domainServiceAccountLoginInformation**: [BasicLoginInformation](#basiclogininformation): Username and password for basic login authentication. +* **provisioningState**: string (ReadOnly): The provisioning state of the Active Directory connector resource. +* **spec**: [ActiveDirectoryConnectorSpec](#activedirectoryconnectorspec) (Required): The specifications of the AD Kubernetes resource. +* **status**: [ActiveDirectoryConnectorStatus](#activedirectoryconnectorstatus): The status of the Kubernetes custom resource. + +## ActiveDirectoryConnectorSpec +### Properties +* **activeDirectory**: [ActiveDirectoryConnectorDomainDetails](#activedirectoryconnectordomaindetails) (Required): Active Directory domain details +* **dns**: [ActiveDirectoryConnectorDNSDetails](#activedirectoryconnectordnsdetails) (Required): DNS server details + +## ActiveDirectoryConnectorStatus +### Properties +* **lastUpdateTime**: string: The time that the custom resource was last updated. +* **observedGeneration**: int: The version of the replicaSet associated with the AD connector custom resource. +* **state**: string: The state of the AD connector custom resource. +### Additional Properties +* **Additional Properties Type**: any + +## ActiveDirectoryDomainController +### Properties +* **hostname**: string (Required): Fully-qualified domain name of a domain controller in the AD domain. + +## ActiveDirectoryDomainControllers +### Properties +* **primaryDomainController**: [ActiveDirectoryDomainController](#activedirectorydomaincontroller): Information about a domain controller in the AD domain. +* **secondaryDomainControllers**: [ActiveDirectoryDomainController](#activedirectorydomaincontroller)[]: Information about the secondary domain controllers in the AD domain. + +## ActiveDirectoryInformation +### Properties +* **keytabInformation**: [KeytabInformation](#keytabinformation): Keytab used for authenticate with Active Directory. + +## BasicLoginInformation +### Properties +* **password**: string (WriteOnly): Login password. +* **username**: string: Login username. ## DataControllerProperties ### Properties @@ -84,92 +132,54 @@ * **uploadServicePrincipal**: [UploadServicePrincipal](#uploadserviceprincipal): Service principal for uploading billing, metrics and logs. * **uploadWatermark**: [UploadWatermark](#uploadwatermark): Properties on upload watermark. Mostly timestamp for each upload data type -## BasicLoginInformation -### Properties -* **password**: string (WriteOnly): Login password. -* **username**: string: Login username. - -## LogAnalyticsWorkspaceConfig -### Properties -* **primaryKey**: string (WriteOnly): Primary key of the workspace -* **workspaceId**: string: Azure Log Analytics workspace ID - -## OnPremiseProperty -### Properties -* **id**: string (Required): A globally unique ID identifying the associated Kubernetes cluster -* **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing -* **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded - -## UploadServicePrincipal -### Properties -* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ -* **clientId**: string: Client ID of the service principal for uploading data. -* **clientSecret**: string (WriteOnly): Secret of the service principal -* **tenantId**: string: Tenant ID of the service principal. - -## UploadWatermark +## ExtendedLocation ### Properties -* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time -* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time -* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time +* **name**: string: The name of the extended location. +* **type**: 'CustomLocation' | string: The type of extendedLocation. -## SystemData +## K8SResourceRequirements ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **limits**: [K8SResourceRequirementsLimits](#k8sresourcerequirementslimits): Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. +* **requests**: [K8SResourceRequirementsRequests](#k8sresourcerequirementsrequests): Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. +### Additional Properties +* **Additional Properties Type**: any -## TrackedResourceTags +## K8SResourceRequirementsLimits ### Properties ### Additional Properties * **Additional Properties Type**: string -## ActiveDirectoryConnectorProperties -### Properties -* **domainServiceAccountLoginInformation**: [BasicLoginInformation](#basiclogininformation): Username and password for basic login authentication. -* **provisioningState**: string (ReadOnly): The provisioning state of the Active Directory connector resource. -* **spec**: [ActiveDirectoryConnectorSpec](#activedirectoryconnectorspec) (Required): The specifications of the AD Kubernetes resource. -* **status**: [ActiveDirectoryConnectorStatus](#activedirectoryconnectorstatus): The status of the Kubernetes custom resource. - -## ActiveDirectoryConnectorSpec +## K8SResourceRequirementsRequests ### Properties -* **activeDirectory**: [ActiveDirectoryConnectorDomainDetails](#activedirectoryconnectordomaindetails) (Required): Active Directory domain details -* **dns**: [ActiveDirectoryConnectorDNSDetails](#activedirectoryconnectordnsdetails) (Required): DNS server details +### Additional Properties +* **Additional Properties Type**: string -## ActiveDirectoryConnectorDomainDetails +## K8SScheduling ### Properties -* **domainControllers**: [ActiveDirectoryDomainControllers](#activedirectorydomaincontrollers) (Required): Details about the Active Directory domain controllers associated with this AD connector instance -* **netbiosDomainName**: string: NETBIOS name of the Active Directory domain. -* **ouDistinguishedName**: string: The distinguished name of the Active Directory Organizational Unit. -* **realm**: string (Required): Name (uppercase) of the Active Directory domain that this AD connector will be associated with. -* **serviceAccountProvisioning**: 'automatic' | 'manual' | string: The service account provisioning mode for this Active Directory connector. +* **default**: [K8SSchedulingOptions](#k8sschedulingoptions): The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service +### Additional Properties +* **Additional Properties Type**: any -## ActiveDirectoryDomainControllers +## K8SSchedulingOptions ### Properties -* **primaryDomainController**: [ActiveDirectoryDomainController](#activedirectorydomaincontroller): Information about a domain controller in the AD domain. -* **secondaryDomainControllers**: [ActiveDirectoryDomainController](#activedirectorydomaincontroller)[]: Information about the secondary domain controllers in the AD domain. +* **resources**: [K8SResourceRequirements](#k8sresourcerequirements): The kubernetes resource limits and requests used to restrict or reserve resource usage. +### Additional Properties +* **Additional Properties Type**: any -## ActiveDirectoryDomainController +## KeytabInformation ### Properties -* **hostname**: string (Required): Fully-qualified domain name of a domain controller in the AD domain. +* **keytab**: string (WriteOnly): A base64-encoded keytab. -## ActiveDirectoryConnectorDNSDetails +## LogAnalyticsWorkspaceConfig ### Properties -* **domainName**: string: DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. -* **nameserverIPAddresses**: string[] (Required): List of Active Directory DNS server IP addresses. -* **preferK8sDnsForPtrLookups**: bool: Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. -* **replicas**: int: Replica count for DNS proxy service. Default value is 1. +* **primaryKey**: string (WriteOnly): Primary key of the workspace +* **workspaceId**: string: Azure Log Analytics workspace ID -## ActiveDirectoryConnectorStatus +## OnPremiseProperty ### Properties -* **lastUpdateTime**: string: The time that the custom resource was last updated. -* **observedGeneration**: int: The version of the replicaSet associated with the AD connector custom resource. -* **state**: string: The state of the AD connector custom resource. -### Additional Properties -* **Additional Properties Type**: any +* **id**: string (Required): A globally unique ID identifying the associated Kubernetes cluster +* **publicSigningKey**: string (Required): Certificate that contains the Kubernetes cluster public key used to verify signing +* **signingCertificateThumbprint**: string: Unique thumbprint returned to customer to verify the certificate being uploaded ## PostgresInstanceProperties ### Properties @@ -189,10 +199,18 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Hyperscale': This field is required to be implemented by the Resource Provider if the service has more than one tier. -## TrackedResourceTags +## SqlManagedInstanceK8SRaw ### Properties +* **spec**: [SqlManagedInstanceK8SSpec](#sqlmanagedinstancek8sspec): The kubernetes spec information. ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any + +## SqlManagedInstanceK8SSpec +### Properties +* **replicas**: int: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. +* **scheduling**: [K8SScheduling](#k8sscheduling): The kubernetes scheduling information. +### Additional Properties +* **Additional Properties Type**: any ## SqlManagedInstanceProperties ### Properties @@ -209,56 +227,6 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the Arc-enabled SQL Managed Instance resource. * **startTime**: string: The instance start time -## ActiveDirectoryInformation -### Properties -* **keytabInformation**: [KeytabInformation](#keytabinformation): Keytab used for authenticate with Active Directory. - -## KeytabInformation -### Properties -* **keytab**: string (WriteOnly): A base64-encoded keytab. - -## SqlManagedInstanceK8SRaw -### Properties -* **spec**: [SqlManagedInstanceK8SSpec](#sqlmanagedinstancek8sspec): The kubernetes spec information. -### Additional Properties -* **Additional Properties Type**: any - -## SqlManagedInstanceK8SSpec -### Properties -* **replicas**: int: This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. -* **scheduling**: [K8SScheduling](#k8sscheduling): The kubernetes scheduling information. -### Additional Properties -* **Additional Properties Type**: any - -## K8SScheduling -### Properties -* **default**: [K8SSchedulingOptions](#k8sschedulingoptions): The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service -### Additional Properties -* **Additional Properties Type**: any - -## K8SSchedulingOptions -### Properties -* **resources**: [K8SResourceRequirements](#k8sresourcerequirements): The kubernetes resource limits and requests used to restrict or reserve resource usage. -### Additional Properties -* **Additional Properties Type**: any - -## K8SResourceRequirements -### Properties -* **limits**: [K8SResourceRequirementsLimits](#k8sresourcerequirementslimits): Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. -* **requests**: [K8SResourceRequirementsRequests](#k8sresourcerequirementsrequests): Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. -### Additional Properties -* **Additional Properties Type**: any - -## K8SResourceRequirementsLimits -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## K8SResourceRequirementsRequests -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlManagedInstanceSku ### Properties * **capacity**: int: The SKU capacity @@ -268,11 +236,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'BusinessCritical' | 'GeneralPurpose': The pricing tier for the instance. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlServerInstanceProperties ### Properties * **azureDefenderStatus**: 'Protected' | 'Unknown' | 'Unprotected' | string: Status of Azure Defender. @@ -294,8 +257,45 @@ * **vCore**: string: The number of logical processors used by the SQL Server instance. * **version**: 'SQL Server 2012' | 'SQL Server 2014' | 'SQL Server 2016' | 'SQL Server 2017' | 'SQL Server 2019' | 'SQL Server 2022' | 'Unknown' | string: SQL Server version. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UploadServicePrincipal +### Properties +* **authority**: string: Authority for the service principal. Example: https://login.microsoftonline.com/ +* **clientId**: string: Client ID of the service principal for uploading data. +* **clientSecret**: string (WriteOnly): Secret of the service principal +* **tenantId**: string: Tenant ID of the service principal. + +## UploadWatermark +### Properties +* **logs**: string: Last uploaded date for logs from kubernetes cluster. Defaults to current date time +* **metrics**: string: Last uploaded date for metrics from kubernetes cluster. Defaults to current date time +* **usages**: string: Last uploaded date for usages from kubernetes cluster. Defaults to current date time + diff --git a/generated/azuredata/log.out b/generated/azuredata/log.out index 694bfaf0a3..6fcbee7da9 100644 --- a/generated/azuredata/log.out +++ b/generated/azuredata/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.azuredata-2019-07-24-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceModelWithAllowedPropertySet' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json:573:5 @@ -33,5 +33,5 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json:1122:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms -info | Autorest completed in 4.82s. 2 files generated. +info | autorest.bicep took 18ms +info | Autorest completed in 4.95s. 2 files generated. diff --git a/generated/azuredata/microsoft.azuredata/2019-07-24-preview/types.md b/generated/azuredata/microsoft.azuredata/2019-07-24-preview/types.md index d8d97865fc..c9e0208679 100644 --- a/generated/azuredata/microsoft.azuredata/2019-07-24-preview/types.md +++ b/generated/azuredata/microsoft.azuredata/2019-07-24-preview/types.md @@ -21,6 +21,14 @@ * **properties**: [SqlServerProperties](#sqlserverproperties): The SQL server properties. * **type**: 'Microsoft.AzureData/sqlServerRegistrations/sqlServers' (ReadOnly, DeployTimeConstant): The resource type +## SqlServerProperties +### Properties +* **cores**: int: Cores of the Sql Server. +* **edition**: string: Sql Server Edition. +* **propertyBag**: string: Sql Server Json Property Bag. +* **registrationID**: string: ID for Parent Sql Server Registration. +* **version**: string: Version of the Sql Server. + ## SqlServerRegistrationProperties ### Properties * **propertyBag**: string: Optional Properties as JSON string @@ -41,11 +49,3 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlServerProperties -### Properties -* **cores**: int: Cores of the Sql Server. -* **edition**: string: Sql Server Edition. -* **propertyBag**: string: Sql Server Json Property Bag. -* **registrationID**: string: ID for Parent Sql Server Registration. -* **version**: string: Version of the Sql Server. - diff --git a/generated/azurestack/log.out b/generated/azurestack/log.out index b46c688e6e..2f7b97b01b 100644 --- a/generated/azurestack/log.out +++ b/generated/azurestack/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.azurestack-2016-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeviceConfiguration' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Product.json:680:5 @@ -15,10 +15,10 @@ warning | PreCheck/SchemaMissingType | The schema 'MarketplaceProductLogUpdate' warning | PreCheck/SchemaMissingType | The schema 'ProductLog' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Product.json:728:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.azurestack-2017-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/AzureStack.json:226:5 @@ -35,10 +35,10 @@ warning | PreCheck/SchemaMissingType | The schema 'MarketplaceProductLogUpdate' warning | PreCheck/SchemaMissingType | The schema 'ProductLog' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json:734:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.azurestack-2020-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/AzureStack.json:234:5 @@ -55,5 +55,5 @@ warning | PreCheck/SchemaMissingType | The schema 'MarketplaceProductLogUpdate' warning | PreCheck/SchemaMissingType | The schema 'ProductLog' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Product.json:731:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 9.68s. 6 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 9.72s. 6 files generated. diff --git a/generated/azurestack/microsoft.azurestack/2016-01-01/types.md b/generated/azurestack/microsoft.azurestack/2016-01-01/types.md index 8efb4e3b68..32654e4ff7 100644 --- a/generated/azurestack/microsoft.azurestack/2016-01-01/types.md +++ b/generated/azurestack/microsoft.azurestack/2016-01-01/types.md @@ -17,17 +17,10 @@ * **ApiVersion**: 2016-01-01 * **Output**: [ExtendedProduct](#extendedproduct) -## RegistrationParameterProperties -### Properties -* **billingModel**: string (ReadOnly): Specifies the billing mode for the Azure Stack registration. -* **cloudId**: string (ReadOnly): The identifier of the registered Azure Stack. -* **objectId**: string (ReadOnly): The object identifier associated with the Azure Stack connecting to Azure. -* **registrationToken**: string (Required, WriteOnly): The token identifying registered Azure Stack - -## TrackedResourceTags +## DataDiskImage ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lun**: int (ReadOnly): The LUN. +* **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. ## ExtendedProduct ### Properties @@ -47,16 +40,23 @@ * **vmOsType**: 'Linux' | 'None' | 'Windows' | string (ReadOnly): Operating system type (Windows or Linux). * **vmScaleSetEnabled**: bool (ReadOnly): Indicates if virtual machine Scale Set is enabled in the specified product. -## DataDiskImage -### Properties -* **lun**: int (ReadOnly): The LUN. -* **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. - ## OsDiskImage ### Properties * **operatingSystem**: 'Linux' | 'None' | 'Windows' | string (ReadOnly): Operating system type (Windows or Linux). * **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. +## RegistrationParameterProperties +### Properties +* **billingModel**: string (ReadOnly): Specifies the billing mode for the Azure Stack registration. +* **cloudId**: string (ReadOnly): The identifier of the registered Azure Stack. +* **objectId**: string (ReadOnly): The object identifier associated with the Azure Stack connecting to Azure. +* **registrationToken**: string (Required, WriteOnly): The token identifying registered Azure Stack + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Uri ### Properties * **uri**: string (ReadOnly): The URI. diff --git a/generated/azurestack/microsoft.azurestack/2017-06-01/types.md b/generated/azurestack/microsoft.azurestack/2017-06-01/types.md index 664af44040..73d0f23883 100644 --- a/generated/azurestack/microsoft.azurestack/2017-06-01/types.md +++ b/generated/azurestack/microsoft.azurestack/2017-06-01/types.md @@ -27,22 +27,15 @@ * **ApiVersion**: 2017-06-01 * **Output**: [ExtendedProduct](#extendedproduct) -## RegistrationParameterProperties -### Properties -* **billingModel**: string (ReadOnly): Specifies the billing mode for the Azure Stack registration. -* **cloudId**: string (ReadOnly): The identifier of the registered Azure Stack. -* **objectId**: string (ReadOnly): The object identifier associated with the Azure Stack connecting to Azure. -* **registrationToken**: string (Required, WriteOnly): The token identifying registered Azure Stack - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CustomerSubscriptionProperties ### Properties * **tenantId**: string: Tenant Id. +## DataDiskImage +### Properties +* **lun**: int (ReadOnly): The LUN. +* **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. + ## ExtendedProduct ### Properties * **galleryPackageBlobSasUri**: string (ReadOnly): The URI to the .azpkg file that provides information required for showing product in the gallery. @@ -61,16 +54,23 @@ * **vmOsType**: 'Linux' | 'None' | 'Windows' | string (ReadOnly): Operating system type (Windows or Linux). * **vmScaleSetEnabled**: bool (ReadOnly): Indicates if virtual machine Scale Set is enabled in the specified product. -## DataDiskImage -### Properties -* **lun**: int (ReadOnly): The LUN. -* **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. - ## OsDiskImage ### Properties * **operatingSystem**: 'Linux' | 'None' | 'Windows' | string (ReadOnly): Operating system type (Windows or Linux). * **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. +## RegistrationParameterProperties +### Properties +* **billingModel**: string (ReadOnly): Specifies the billing mode for the Azure Stack registration. +* **cloudId**: string (ReadOnly): The identifier of the registered Azure Stack. +* **objectId**: string (ReadOnly): The object identifier associated with the Azure Stack connecting to Azure. +* **registrationToken**: string (Required, WriteOnly): The token identifying registered Azure Stack + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Uri ### Properties * **uri**: string (ReadOnly): The URI. diff --git a/generated/azurestack/microsoft.azurestack/2020-06-01-preview/types.md b/generated/azurestack/microsoft.azurestack/2020-06-01-preview/types.md index 5ad7d8e9bc..ce176ad4ed 100644 --- a/generated/azurestack/microsoft.azurestack/2020-06-01-preview/types.md +++ b/generated/azurestack/microsoft.azurestack/2020-06-01-preview/types.md @@ -44,46 +44,15 @@ * **ApiVersion**: 2020-06-01-preview * **Output**: [ExtendedProduct](#extendedproduct) -## LinkedSubscriptionParameterProperties -### Properties -* **deviceConnectionStatus**: string (ReadOnly): The status of the remote management connection of the Azure Stack device. -* **deviceId**: string (ReadOnly): The identifier of the Azure Stack device for remote management. -* **deviceLinkState**: string (ReadOnly): The connection state of the Azure Stack device. -* **deviceObjectId**: string (ReadOnly): The object identifier associated with the Azure Stack device connecting to Azure. -* **lastConnectedTime**: string (ReadOnly): The last remote management connection time for the Azure Stack device connected to the linked subscription resource. -* **linkedSubscriptionId**: string (Required): The identifier associated with the device subscription. -* **registrationResourceId**: string (Required): The identifier associated with the device registration. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RegistrationParameterProperties -### Properties -* **billingModel**: string (ReadOnly): Specifies the billing mode for the Azure Stack registration. -* **cloudId**: string (ReadOnly): The identifier of the registered Azure Stack. -* **objectId**: string (ReadOnly): The object identifier associated with the Azure Stack connecting to Azure. -* **registrationToken**: string (Required, WriteOnly): The token identifying registered Azure Stack - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CustomerSubscriptionProperties ### Properties * **tenantId**: string: Tenant Id. +## DataDiskImage +### Properties +* **lun**: int (ReadOnly): The LUN. +* **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. + ## ExtendedProduct ### Properties * **galleryPackageBlobSasUri**: string (ReadOnly): The URI to the .azpkg file that provides information required for showing product in the gallery. @@ -102,16 +71,47 @@ * **vmOsType**: 'Linux' | 'None' | 'Windows' | string (ReadOnly): Operating system type (Windows or Linux). * **vmScaleSetEnabled**: bool (ReadOnly): Indicates if virtual machine Scale Set is enabled in the specified product. -## DataDiskImage +## LinkedSubscriptionParameterProperties ### Properties -* **lun**: int (ReadOnly): The LUN. -* **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. +* **deviceConnectionStatus**: string (ReadOnly): The status of the remote management connection of the Azure Stack device. +* **deviceId**: string (ReadOnly): The identifier of the Azure Stack device for remote management. +* **deviceLinkState**: string (ReadOnly): The connection state of the Azure Stack device. +* **deviceObjectId**: string (ReadOnly): The object identifier associated with the Azure Stack device connecting to Azure. +* **lastConnectedTime**: string (ReadOnly): The last remote management connection time for the Azure Stack device connected to the linked subscription resource. +* **linkedSubscriptionId**: string (Required): The identifier associated with the device subscription. +* **registrationResourceId**: string (Required): The identifier associated with the device registration. ## OsDiskImage ### Properties * **operatingSystem**: 'Linux' | 'None' | 'Windows' | string (ReadOnly): Operating system type (Windows or Linux). * **sourceBlobSasUri**: string (ReadOnly): SAS key for source blob. +## RegistrationParameterProperties +### Properties +* **billingModel**: string (ReadOnly): Specifies the billing mode for the Azure Stack registration. +* **cloudId**: string (ReadOnly): The identifier of the registered Azure Stack. +* **objectId**: string (ReadOnly): The object identifier associated with the Azure Stack connecting to Azure. +* **registrationToken**: string (Required, WriteOnly): The token identifying registered Azure Stack + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Uri ### Properties * **uri**: string (ReadOnly): The URI. diff --git a/generated/azurestackhci/log.out b/generated/azurestackhci/log.out index 5c78bfeb8d..69322257b9 100644 --- a/generated/azurestackhci/log.out +++ b/generated/azurestackhci/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.azurestackhci-2022-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -17,7 +17,7 @@ info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.azurestackhci-2022-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -26,16 +26,16 @@ info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.azurestackhci-2021-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.azurestackhci-2021-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -44,15 +44,15 @@ info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.azurestackhci-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.azurestackhci-2020-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms -info | Autorest completed in 14.52s. 12 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 14.34s. 12 files generated. diff --git a/generated/azurestackhci/microsoft.azurestackhci/2020-03-01-preview/types.md b/generated/azurestackhci/microsoft.azurestackhci/2020-03-01-preview/types.md index 3a5834931f..3148006fe0 100644 --- a/generated/azurestackhci/microsoft.azurestackhci/2020-03-01-preview/types.md +++ b/generated/azurestackhci/microsoft.azurestackhci/2020-03-01-preview/types.md @@ -11,6 +11,18 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureStackHCI/clusters' (ReadOnly, DeployTimeConstant): The resource type +## ClusterNode +### Properties +* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. +* **id**: int (ReadOnly): Id of the node in the cluster. +* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. +* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). +* **model**: string (ReadOnly): Model name of the cluster node hardware. +* **name**: string (ReadOnly): Name of the cluster node. +* **osName**: string (ReadOnly): Operating system running on the cluster node. +* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. +* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. + ## ClusterProperties ### Properties * **aadClientId**: string (Required): App id of cluster AAD identity. @@ -33,18 +45,6 @@ * **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. * **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. -## ClusterNode -### Properties -* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. -* **id**: int (ReadOnly): Id of the node in the cluster. -* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. -* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). -* **model**: string (ReadOnly): Model name of the cluster node hardware. -* **name**: string (ReadOnly): Name of the cluster node. -* **osName**: string (ReadOnly): Operating system running on the cluster node. -* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. -* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. - ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/azurestackhci/microsoft.azurestackhci/2020-10-01/types.md b/generated/azurestackhci/microsoft.azurestackhci/2020-10-01/types.md index 2730ca8e12..c9be72cdaa 100644 --- a/generated/azurestackhci/microsoft.azurestackhci/2020-10-01/types.md +++ b/generated/azurestackhci/microsoft.azurestackhci/2020-10-01/types.md @@ -12,6 +12,18 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.AzureStackHCI/clusters' (ReadOnly, DeployTimeConstant): The resource type +## ClusterNode +### Properties +* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. +* **id**: int (ReadOnly): Id of the node in the cluster. +* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. +* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). +* **model**: string (ReadOnly): Model name of the cluster node hardware. +* **name**: string (ReadOnly): Name of the cluster node. +* **osName**: string (ReadOnly): Operating system running on the cluster node. +* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. +* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. + ## ClusterProperties ### Properties * **aadClientId**: string (Required): App id of cluster AAD identity. @@ -34,18 +46,6 @@ * **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. * **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. -## ClusterNode -### Properties -* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. -* **id**: int (ReadOnly): Id of the node in the cluster. -* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. -* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). -* **model**: string (ReadOnly): Model name of the cluster node hardware. -* **name**: string (ReadOnly): Name of the cluster node. -* **osName**: string (ReadOnly): Operating system running on the cluster node. -* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. -* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.md b/generated/azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.md index 88790f14e5..ae3f2bde4a 100644 --- a/generated/azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.md +++ b/generated/azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.md @@ -32,6 +32,25 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.AzureStackHCI/clusters/arcSettings/extensions' (ReadOnly, DeployTimeConstant): The resource type +## ArcSettingProperties +### Properties +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. +* **arcInstanceResourceGroup**: string (ReadOnly): The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. +* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. + +## ClusterNode +### Properties +* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. +* **id**: int (ReadOnly): Id of the node in the cluster. +* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. +* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). +* **model**: string (ReadOnly): Model name of the cluster node hardware. +* **name**: string (ReadOnly): Name of the cluster node. +* **osName**: string (ReadOnly): Operating system running on the cluster node. +* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. +* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. + ## ClusterProperties ### Properties * **aadClientId**: string (Required): App id of cluster AAD identity. @@ -55,52 +74,6 @@ * **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. * **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. -## ClusterNode -### Properties -* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. -* **id**: int (ReadOnly): Id of the node in the cluster. -* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. -* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). -* **model**: string (ReadOnly): Model name of the cluster node hardware. -* **name**: string (ReadOnly): Name of the cluster node. -* **osName**: string (ReadOnly): Operating system running on the cluster node. -* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. -* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ArcSettingProperties -### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. -* **arcInstanceResourceGroup**: string (ReadOnly): The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. -* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. - -## PerNodeState -### Properties -* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. -* **name**: string (ReadOnly): Name of the Node in HCI Cluster -* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. - -## ExtensionProperties -### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. -* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. -* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. - ## ExtensionParameters ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -111,9 +84,36 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## ExtensionProperties +### Properties +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. +* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. +* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. + ## PerNodeExtensionState ### Properties * **extension**: string (ReadOnly): Fully qualified resource ID for the particular Arc Extension on this node. * **name**: string (ReadOnly): Name of the node in HCI Cluster. * **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc Extension in this node. +## PerNodeState +### Properties +* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. +* **name**: string (ReadOnly): Name of the Node in HCI Cluster +* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/azurestackhci/microsoft.azurestackhci/2021-09-01/types.md b/generated/azurestackhci/microsoft.azurestackhci/2021-09-01/types.md index f45b3fa94e..97d1806e5f 100644 --- a/generated/azurestackhci/microsoft.azurestackhci/2021-09-01/types.md +++ b/generated/azurestackhci/microsoft.azurestackhci/2021-09-01/types.md @@ -32,37 +32,18 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.AzureStackHCI/clusters/arcSettings/extensions' (ReadOnly, DeployTimeConstant): The resource type -## ClusterProperties +## ArcSettingProperties ### Properties -* **aadClientId**: string (Required): App id of cluster AAD identity. -* **aadTenantId**: string (Required): Tenant id of cluster AAD identity. -* **billingModel**: string (ReadOnly): Type of billing applied to the resource. -* **cloudId**: string (ReadOnly): Unique, immutable resource id. -* **cloudManagementEndpoint**: string: Endpoint configured for management from the Azure portal. -* **desiredProperties**: [ClusterDesiredProperties](#clusterdesiredproperties): Desired properties of the cluster. -* **lastBillingTimestamp**: string (ReadOnly): Most recent billing meter timestamp. -* **lastSyncTimestamp**: string (ReadOnly): Most recent cluster sync timestamp. +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. +* **arcInstanceResourceGroup**: string (ReadOnly): The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. +* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. * **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. -* **registrationTimestamp**: string (ReadOnly): First cluster sync timestamp. -* **reportedProperties**: [ClusterReportedProperties](#clusterreportedproperties) (ReadOnly): Properties reported by cluster agent. -* **status**: 'ConnectedRecently' | 'Disconnected' | 'Error' | 'NotConnectedRecently' | 'NotYetRegistered' | string (ReadOnly): Status of the cluster agent. -* **trialDaysRemaining**: int (ReadOnly): Number of days remaining in the trial period. ## ClusterDesiredProperties ### Properties * **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. * **windowsServerSubscription**: 'Disabled' | 'Enabled' | string: Desired state of Windows Server Subscription. -## ClusterReportedProperties -### Properties -* **clusterId**: string (ReadOnly): Unique id generated by the on-prem cluster. -* **clusterName**: string (ReadOnly): Name of the on-prem cluster connected to this resource. -* **clusterVersion**: string (ReadOnly): Version of the cluster software. -* **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. -* **imdsAttestation**: 'Disabled' | 'Enabled' | string (ReadOnly): IMDS attestation status of the cluster. -* **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. -* **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. - ## ClusterNode ### Properties * **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. @@ -76,39 +57,31 @@ * **serialNumber**: string (ReadOnly): Immutable id of the cluster node. * **windowsServerSubscription**: 'Disabled' | 'Enabled' | string (ReadOnly): Desired state of Windows Server Subscription. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ArcSettingProperties +## ClusterProperties ### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. -* **arcInstanceResourceGroup**: string (ReadOnly): The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. -* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. +* **aadClientId**: string (Required): App id of cluster AAD identity. +* **aadTenantId**: string (Required): Tenant id of cluster AAD identity. +* **billingModel**: string (ReadOnly): Type of billing applied to the resource. +* **cloudId**: string (ReadOnly): Unique, immutable resource id. +* **cloudManagementEndpoint**: string: Endpoint configured for management from the Azure portal. +* **desiredProperties**: [ClusterDesiredProperties](#clusterdesiredproperties): Desired properties of the cluster. +* **lastBillingTimestamp**: string (ReadOnly): Most recent billing meter timestamp. +* **lastSyncTimestamp**: string (ReadOnly): Most recent cluster sync timestamp. * **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. +* **registrationTimestamp**: string (ReadOnly): First cluster sync timestamp. +* **reportedProperties**: [ClusterReportedProperties](#clusterreportedproperties) (ReadOnly): Properties reported by cluster agent. +* **status**: 'ConnectedRecently' | 'Disconnected' | 'Error' | 'NotConnectedRecently' | 'NotYetRegistered' | string (ReadOnly): Status of the cluster agent. +* **trialDaysRemaining**: int (ReadOnly): Number of days remaining in the trial period. -## PerNodeState -### Properties -* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. -* **name**: string (ReadOnly): Name of the Node in HCI Cluster -* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. - -## ExtensionProperties +## ClusterReportedProperties ### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. -* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. -* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. +* **clusterId**: string (ReadOnly): Unique id generated by the on-prem cluster. +* **clusterName**: string (ReadOnly): Name of the on-prem cluster connected to this resource. +* **clusterVersion**: string (ReadOnly): Version of the cluster software. +* **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. +* **imdsAttestation**: 'Disabled' | 'Enabled' | string (ReadOnly): IMDS attestation status of the cluster. +* **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. +* **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. ## ExtensionParameters ### Properties @@ -120,9 +93,36 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## ExtensionProperties +### Properties +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. +* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. +* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. + ## PerNodeExtensionState ### Properties * **extension**: string (ReadOnly): Fully qualified resource ID for the particular Arc Extension on this node. * **name**: string (ReadOnly): Name of the node in HCI Cluster. * **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc Extension in this node. +## PerNodeState +### Properties +* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. +* **name**: string (ReadOnly): Name of the Node in HCI Cluster +* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/azurestackhci/microsoft.azurestackhci/2022-01-01/types.md b/generated/azurestackhci/microsoft.azurestackhci/2022-01-01/types.md index 578d31606c..a34049ffb0 100644 --- a/generated/azurestackhci/microsoft.azurestackhci/2022-01-01/types.md +++ b/generated/azurestackhci/microsoft.azurestackhci/2022-01-01/types.md @@ -32,37 +32,18 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.AzureStackHCI/clusters/arcSettings/extensions' (ReadOnly, DeployTimeConstant): The resource type -## ClusterProperties +## ArcSettingProperties ### Properties -* **aadClientId**: string (Required): App id of cluster AAD identity. -* **aadTenantId**: string (Required): Tenant id of cluster AAD identity. -* **billingModel**: string (ReadOnly): Type of billing applied to the resource. -* **cloudId**: string (ReadOnly): Unique, immutable resource id. -* **cloudManagementEndpoint**: string: Endpoint configured for management from the Azure portal. -* **desiredProperties**: [ClusterDesiredProperties](#clusterdesiredproperties): Desired properties of the cluster. -* **lastBillingTimestamp**: string (ReadOnly): Most recent billing meter timestamp. -* **lastSyncTimestamp**: string (ReadOnly): Most recent cluster sync timestamp. +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. +* **arcInstanceResourceGroup**: string: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. +* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. * **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. -* **registrationTimestamp**: string (ReadOnly): First cluster sync timestamp. -* **reportedProperties**: [ClusterReportedProperties](#clusterreportedproperties) (ReadOnly): Properties reported by cluster agent. -* **status**: 'ConnectedRecently' | 'Disconnected' | 'Error' | 'NotConnectedRecently' | 'NotYetRegistered' | string (ReadOnly): Status of the cluster agent. -* **trialDaysRemaining**: int (ReadOnly): Number of days remaining in the trial period. ## ClusterDesiredProperties ### Properties * **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. * **windowsServerSubscription**: 'Disabled' | 'Enabled' | string: Desired state of Windows Server Subscription. -## ClusterReportedProperties -### Properties -* **clusterId**: string (ReadOnly): Unique id generated by the on-prem cluster. -* **clusterName**: string (ReadOnly): Name of the on-prem cluster connected to this resource. -* **clusterVersion**: string (ReadOnly): Version of the cluster software. -* **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. -* **imdsAttestation**: 'Disabled' | 'Enabled' | string (ReadOnly): IMDS attestation status of the cluster. -* **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. -* **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. - ## ClusterNode ### Properties * **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. @@ -76,39 +57,31 @@ * **serialNumber**: string (ReadOnly): Immutable id of the cluster node. * **windowsServerSubscription**: 'Disabled' | 'Enabled' | string (ReadOnly): Desired state of Windows Server Subscription. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ArcSettingProperties +## ClusterProperties ### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. -* **arcInstanceResourceGroup**: string: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. -* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. +* **aadClientId**: string (Required): App id of cluster AAD identity. +* **aadTenantId**: string (Required): Tenant id of cluster AAD identity. +* **billingModel**: string (ReadOnly): Type of billing applied to the resource. +* **cloudId**: string (ReadOnly): Unique, immutable resource id. +* **cloudManagementEndpoint**: string: Endpoint configured for management from the Azure portal. +* **desiredProperties**: [ClusterDesiredProperties](#clusterdesiredproperties): Desired properties of the cluster. +* **lastBillingTimestamp**: string (ReadOnly): Most recent billing meter timestamp. +* **lastSyncTimestamp**: string (ReadOnly): Most recent cluster sync timestamp. * **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. +* **registrationTimestamp**: string (ReadOnly): First cluster sync timestamp. +* **reportedProperties**: [ClusterReportedProperties](#clusterreportedproperties) (ReadOnly): Properties reported by cluster agent. +* **status**: 'ConnectedRecently' | 'Disconnected' | 'Error' | 'NotConnectedRecently' | 'NotYetRegistered' | string (ReadOnly): Status of the cluster agent. +* **trialDaysRemaining**: int (ReadOnly): Number of days remaining in the trial period. -## PerNodeState -### Properties -* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. -* **name**: string (ReadOnly): Name of the Node in HCI Cluster -* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. - -## ExtensionProperties +## ClusterReportedProperties ### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. -* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. -* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. +* **clusterId**: string (ReadOnly): Unique id generated by the on-prem cluster. +* **clusterName**: string (ReadOnly): Name of the on-prem cluster connected to this resource. +* **clusterVersion**: string (ReadOnly): Version of the cluster software. +* **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. +* **imdsAttestation**: 'Disabled' | 'Enabled' | string (ReadOnly): IMDS attestation status of the cluster. +* **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. +* **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. ## ExtensionParameters ### Properties @@ -120,9 +93,36 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## ExtensionProperties +### Properties +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. +* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. +* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. + ## PerNodeExtensionState ### Properties * **extension**: string (ReadOnly): Fully qualified resource ID for the particular Arc Extension on this node. * **name**: string (ReadOnly): Name of the node in HCI Cluster. * **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc Extension in this node. +## PerNodeState +### Properties +* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. +* **name**: string (ReadOnly): Name of the Node in HCI Cluster +* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/azurestackhci/microsoft.azurestackhci/2022-03-01/types.md b/generated/azurestackhci/microsoft.azurestackhci/2022-03-01/types.md index 62ff64018b..f62372c631 100644 --- a/generated/azurestackhci/microsoft.azurestackhci/2022-03-01/types.md +++ b/generated/azurestackhci/microsoft.azurestackhci/2022-03-01/types.md @@ -32,6 +32,35 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.AzureStackHCI/clusters/arcSettings/extensions' (ReadOnly, DeployTimeConstant): The resource type +## ArcSettingProperties +### Properties +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. +* **arcApplicationClientId**: string: App id of arc AAD identity. +* **arcApplicationObjectId**: string: Object id of arc AAD identity. +* **arcApplicationTenantId**: string: Tenant id of arc AAD identity. +* **arcInstanceResourceGroup**: string: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. +* **arcServicePrincipalObjectId**: string: Object id of arc AAD service principal. +* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. + +## ClusterDesiredProperties +### Properties +* **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. +* **windowsServerSubscription**: 'Disabled' | 'Enabled' | string: Desired state of Windows Server Subscription. + +## ClusterNode +### Properties +* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. +* **id**: int (ReadOnly): Id of the node in the cluster. +* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. +* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). +* **model**: string (ReadOnly): Model name of the cluster node hardware. +* **name**: string (ReadOnly): Name of the cluster node. +* **osName**: string (ReadOnly): Operating system running on the cluster node. +* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. +* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. +* **windowsServerSubscription**: 'Disabled' | 'Enabled' | string (ReadOnly): Desired state of Windows Server Subscription. + ## ClusterProperties ### Properties * **aadApplicationObjectId**: string: Object id of cluster AAD identity. @@ -51,11 +80,6 @@ * **status**: 'ConnectedRecently' | 'Disconnected' | 'Error' | 'NotConnectedRecently' | 'NotYetRegistered' | string (ReadOnly): Status of the cluster agent. * **trialDaysRemaining**: int (ReadOnly): Number of days remaining in the trial period. -## ClusterDesiredProperties -### Properties -* **diagnosticLevel**: 'Basic' | 'Enhanced' | 'Off' | string: Desired level of diagnostic data emitted by the cluster. -* **windowsServerSubscription**: 'Disabled' | 'Enabled' | string: Desired state of Windows Server Subscription. - ## ClusterReportedProperties ### Properties * **clusterId**: string (ReadOnly): Unique id generated by the on-prem cluster. @@ -66,57 +90,6 @@ * **lastUpdated**: string (ReadOnly): Last time the cluster reported the data. * **nodes**: [ClusterNode](#clusternode)[] (ReadOnly): List of nodes reported by the cluster. -## ClusterNode -### Properties -* **coreCount**: int (ReadOnly): Number of physical cores on the cluster node. -* **id**: int (ReadOnly): Id of the node in the cluster. -* **manufacturer**: string (ReadOnly): Manufacturer of the cluster node hardware. -* **memoryInGiB**: int (ReadOnly): Total available memory on the cluster node (in GiB). -* **model**: string (ReadOnly): Model name of the cluster node hardware. -* **name**: string (ReadOnly): Name of the cluster node. -* **osName**: string (ReadOnly): Operating system running on the cluster node. -* **osVersion**: string (ReadOnly): Version of the operating system running on the cluster node. -* **serialNumber**: string (ReadOnly): Immutable id of the cluster node. -* **windowsServerSubscription**: 'Disabled' | 'Enabled' | string (ReadOnly): Desired state of Windows Server Subscription. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ArcSettingProperties -### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc agent across the nodes in this HCI cluster. -* **arcApplicationClientId**: string: App id of arc AAD identity. -* **arcApplicationObjectId**: string: Object id of arc AAD identity. -* **arcApplicationTenantId**: string: Tenant id of arc AAD identity. -* **arcInstanceResourceGroup**: string: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. -* **arcServicePrincipalObjectId**: string: Object id of arc AAD service principal. -* **perNodeDetails**: [PerNodeState](#pernodestate)[] (ReadOnly): State of Arc agent in each of the nodes. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. - -## PerNodeState -### Properties -* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. -* **name**: string (ReadOnly): Name of the Node in HCI Cluster -* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. - -## ExtensionProperties -### Properties -* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. -* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. -* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. - ## ExtensionParameters ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -127,9 +100,36 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## ExtensionProperties +### Properties +* **aggregateState**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'PartiallyConnected' | 'PartiallySucceeded' | 'Succeeded' | 'Updating' | string (ReadOnly): Aggregate state of Arc Extensions across the nodes in this HCI cluster. +* **extensionParameters**: [ExtensionParameters](#extensionparameters): Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute. +* **perNodeExtensionDetails**: [PerNodeExtensionState](#pernodeextensionstate)[] (ReadOnly): State of Arc Extension in each of the nodes. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state of the ArcSetting proxy resource. + ## PerNodeExtensionState ### Properties * **extension**: string (ReadOnly): Fully qualified resource ID for the particular Arc Extension on this node. * **name**: string (ReadOnly): Name of the node in HCI Cluster. * **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc Extension in this node. +## PerNodeState +### Properties +* **arcInstance**: string (ReadOnly): Fully qualified resource ID for the Arc agent of this node. +* **name**: string (ReadOnly): Name of the Node in HCI Cluster +* **state**: 'Canceled' | 'Connected' | 'Creating' | 'Deleted' | 'Deleting' | 'Disconnected' | 'Error' | 'Failed' | 'Moving' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): State of Arc agent in this node. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/baremetalinfrastructure/log.out b/generated/baremetalinfrastructure/log.out index 854005134d..3551307166 100644 --- a/generated/baremetalinfrastructure/log.out +++ b/generated/baremetalinfrastructure/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.baremetalinfrastructure-2021-08-09"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBareMetalInstancesListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json:251:5 @@ -33,10 +33,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefi warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2021-08-09/baremetalinfrastructure.json:606:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.baremetalinfrastructure-2020-08-06-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBareMetalInstancesListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json:433:5 @@ -64,4 +64,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an unde - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json:788:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 6.1s. 0 files generated. +info | Autorest completed in 6.02s. 0 files generated. diff --git a/generated/batch/log.out b/generated/batch/log.out index bc63ae7bfb..348f9d9bb6 100644 --- a/generated/batch/log.out +++ b/generated/batch/log.out @@ -11,7 +11,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.batch-2022-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -22,12 +22,12 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 20ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.batch-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -38,12 +38,12 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.batch-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -54,7 +54,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2021-01-01/BatchManagement.json:2240:5 @@ -254,7 +254,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/BatchManagement.json:2215:5 @@ -435,7 +435,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CIFSMountConfiguration' with warning | PreCheck/SchemaMissingType | The schema 'AzureFileShareConfiguration' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/BatchManagement.json:5011:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.batch-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -446,7 +446,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json:2215:5 @@ -627,7 +627,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CIFSMountConfiguration' with warning | PreCheck/SchemaMissingType | The schema 'AzureFileShareConfiguration' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json:5011:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.batch-2020-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -638,7 +638,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2020-03-01/BatchManagement.json:2200:5 @@ -817,7 +817,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CIFSMountConfiguration' with warning | PreCheck/SchemaMissingType | The schema 'AzureFileShareConfiguration' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2020-03-01/BatchManagement.json:4939:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.batch-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -828,7 +828,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2019-08-01/BatchManagement.json:1930:5 @@ -994,7 +994,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2019-04-01/BatchManagement.json:1927:5 @@ -1150,7 +1150,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json:1927:5 @@ -1293,7 +1293,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityParamete warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json:4052:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.batch-2017-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1304,7 +1304,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json:1898:5 @@ -1440,7 +1440,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json:3662:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.batch/batchaccounts/applications/versions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}/versions/{version}' has no body defined. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.batch-2017-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1451,7 +1451,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2017-05-01/BatchManagement.json:1029:5 @@ -1507,7 +1507,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2017-05-01/BatchManagement.json:1596:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.batch/batchaccounts/applications/versions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}/versions/{version}' has no body defined. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.batch-2017-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1518,7 +1518,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2017-01-01/BatchManagement.json:1103:5 @@ -1575,7 +1575,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutoStorageBaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/batch/resource-manager/Microsoft.Batch/stable/2015-12-01/BatchManagement.json:1084:5 @@ -1618,4 +1618,4 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.batch/batchaccounts/applications/versions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationId}/versions/{version}' has no body defined. info | autorest.bicep took 2ms -info | Autorest completed in 46.1s. 26 files generated. +info | Autorest completed in 45.27s. 26 files generated. diff --git a/generated/batch/microsoft.batch/2015-12-01/types.md b/generated/batch/microsoft.batch/2015-12-01/types.md index aa717b2bb9..edc6220063 100644 --- a/generated/batch/microsoft.batch/2015-12-01/types.md +++ b/generated/batch/microsoft.batch/2015-12-01/types.md @@ -42,6 +42,21 @@ * **ApiVersion**: 2015-12-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) +## ApplicationPackage +### Properties +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **id**: string (ReadOnly): The ID of the application. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'active' | 'pending' | 'unmapped' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The storage URL at which the application package is stored. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the storage URL will expire. +* **version**: string (ReadOnly): The version of the application package. + +## AutoStorageBaseProperties +### Properties +* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. +* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto storage account. + ## BatchAccountBaseProperties ### Properties * **accountEndpoint**: string (ReadOnly): The endpoint used by this account to interact with the Batch services. @@ -51,26 +66,11 @@ * **poolQuota**: int (ReadOnly): The pool quota for this Batch account. * **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -## AutoStorageBaseProperties -### Properties -* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. -* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto storage account. - ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationPackage -### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **id**: string (ReadOnly): The ID of the application. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'active' | 'pending' | 'unmapped' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The storage URL at which the application package is stored. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the storage URL will expire. -* **version**: string (ReadOnly): The version of the application package. - ## BatchAccountKeys ### Properties * **primary**: string (ReadOnly): The primary key associated with the account. diff --git a/generated/batch/microsoft.batch/2017-01-01/types.md b/generated/batch/microsoft.batch/2017-01-01/types.md index 014c0d9eb5..44a32533a0 100644 --- a/generated/batch/microsoft.batch/2017-01-01/types.md +++ b/generated/batch/microsoft.batch/2017-01-01/types.md @@ -42,6 +42,21 @@ * **ApiVersion**: 2017-01-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) +## ApplicationPackage +### Properties +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **id**: string (ReadOnly): The ID of the application. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'active' | 'pending' | 'unmapped' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The storage URL at which the application package is stored. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the storage URL will expire. +* **version**: string (ReadOnly): The version of the application package. + +## AutoStorageBaseProperties +### Properties +* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. +* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto storage account. + ## BatchAccountBaseProperties ### Properties * **accountEndpoint**: string (ReadOnly): The endpoint used by this account to interact with the Batch services. @@ -53,33 +68,18 @@ * **poolQuota**: int (ReadOnly): The pool quota for this Batch account. * **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -## AutoStorageBaseProperties -### Properties -* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. -* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto storage account. - -## KeyVaultReference -### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The Url of the Azure key vault associated with the Batch account. - ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationPackage -### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **id**: string (ReadOnly): The ID of the application. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'active' | 'pending' | 'unmapped' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The storage URL at which the application package is stored. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the storage URL will expire. -* **version**: string (ReadOnly): The version of the application package. - ## BatchAccountKeys ### Properties * **primary**: string (ReadOnly): The primary key associated with the account. * **secondary**: string (ReadOnly): The secondary key associated with the account. +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The Url of the Azure key vault associated with the Batch account. + diff --git a/generated/batch/microsoft.batch/2017-05-01/types.md b/generated/batch/microsoft.batch/2017-05-01/types.md index 2ffbf5e1b8..508090b60a 100644 --- a/generated/batch/microsoft.batch/2017-05-01/types.md +++ b/generated/batch/microsoft.batch/2017-05-01/types.md @@ -42,42 +42,37 @@ * **ApiVersion**: 2017-05-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountCreateProperties +## ApplicationPackage ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for this Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): The dedicated core quota for this Batch account. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): The low-priority core quota for this Batch account. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for this Batch account. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **id**: string (ReadOnly): The ID of the application. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'active' | 'pending' | 'unmapped' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **version**: string (ReadOnly): The version of the application package. ## AutoStorageBaseProperties ### Properties * **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## KeyVaultReference -### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. - ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationPackage +## BatchAccountCreateProperties ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **id**: string (ReadOnly): The ID of the application. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'active' | 'pending' | 'unmapped' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -* **version**: string (ReadOnly): The version of the application package. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for this Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): The dedicated core quota for this Batch account. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): The low-priority core quota for this Batch account. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for this Batch account. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource ## BatchAccountKeys ### Properties @@ -85,3 +80,8 @@ * **primary**: string (ReadOnly): The primary key associated with the account. * **secondary**: string (ReadOnly): The secondary key associated with the account. +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + diff --git a/generated/batch/microsoft.batch/2017-09-01/types.md b/generated/batch/microsoft.batch/2017-09-01/types.md index 8ff181ae26..7632ba7b92 100644 --- a/generated/batch/microsoft.batch/2017-09-01/types.md +++ b/generated/batch/microsoft.batch/2017-09-01/types.md @@ -62,42 +62,73 @@ * **ApiVersion**: 2017-09-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountCreateProperties +## ApplicationPackage ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for this Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): The dedicated core quota for this Batch account. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): The low-priority core quota for this Batch account. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for this Batch account. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **id**: string (ReadOnly): The ID of the application. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' | 'Unmapped' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **version**: string (ReadOnly): The version of the application package. + +## ApplicationPackageReference +### Properties +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. + +## AutoScaleRun +### Properties +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. ## AutoStorageBaseProperties ### Properties * **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## KeyVaultReference +## AutoUserSpecification ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **elevationLevel**: 'Admin' | 'NonAdmin': Values are: + + NonAdmin - The user is a standard user without elevated access. + Admin - The user is a user with elevated access and operates with full Administrator permissions. +* **scope**: 'Pool' | 'Task': 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. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationPackage +## BatchAccountCreateProperties ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **id**: string (ReadOnly): The ID of the application. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' | 'Unmapped' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -* **version**: string (ReadOnly): The version of the application package. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for this Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): The dedicated core quota for this Batch account. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): The low-priority core quota for this Batch account. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for this Batch account. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource + +## BatchAccountKeys +### Properties +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -121,64 +152,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Values are: - - Steady - The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes. - Resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool. - Stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: 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. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **maxTasksPerNode**: int: The maximum number of tasks that can run concurrently on a single compute node in the pool. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): Values are: - - Succeeded - The pool is available to run tasks subject to the availability of compute nodes. - Deleting - The user has requested that the pool be deleted, but the delete operation has not yet completed. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -192,29 +165,12 @@ You can specify more than one visibility in this collection. The default is all accounts. -## DeploymentConfiguration -### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. - ## CloudServiceConfiguration ### Properties * **currentOSVersion**: string: 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. * **osFamily**: string (Required): 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). * **targetOSVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **osDisk**: [OSDisk](#osdisk): Settings for the operating system disk of the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## DataDisk ### Properties * **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Values are: @@ -226,6 +182,35 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Values are: + + Requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. Remove nodes as soon as tasks have been terminated. + Terminate - Terminate running tasks. The tasks will not run again. Remove nodes as soon as tasks have been terminated. + TaskCompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. + RetainedData - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. + ## ImageReference ### Properties * **id**: string: 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 . @@ -234,17 +219,25 @@ * **sku**: string: For example, 14.04.0-LTS or 2012-R2-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## OSDisk +## InboundNatPool ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Values are: +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. - 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. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. -## WindowsConfiguration +## LinuxUserConfiguration ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -256,24 +249,63 @@ * **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. * **subnetId**: 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 +## NetworkSecurityGroupRule +### Properties +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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. +* **sourceAddressPrefix**: string (Required): 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. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': 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. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. + ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Values are: -## NetworkSecurityGroupRule + Steady - The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes. + Resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool. + Stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: 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. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **maxTasksPerNode**: int: The maximum number of tasks that can run concurrently on a single compute node in the pool. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): Values are: + + Succeeded - The pool is available to run tasks subject to the availability of compute nodes. + Deleting - The user has requested that the pool be deleted, but the delete operation has not yet completed. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). + +## ResizeError ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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. -* **sourceAddressPrefix**: string (Required): 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. +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. ## ResizeOperationStatus ### Properties @@ -289,34 +321,17 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **blobSource**: string (Required): 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. +* **fileMode**: 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. +* **filePath**: string (Required): The location on the compute node to which to download the file, relative to the task's working directory. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Values are: - - Requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. Remove nodes as soon as tasks have been terminated. - Terminate - Terminate running tasks. The tasks will not run again. Remove nodes as soon as tasks have been terminated. - TaskCompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed. - RetainedData - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -326,30 +341,6 @@ * **userIdentity**: [UserIdentity](#useridentity): Specify either the userName or autoUser property, but not both. * **waitForSuccess**: bool: 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. -## EnvironmentSetting -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. - -## ResourceFile -### Properties -* **blobSource**: string (Required): 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. -* **fileMode**: 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. -* **filePath**: string (Required): The location on the compute node to which to download the file, relative to the task's working directory. - -## UserIdentity -### Properties -* **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. -* **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. - -## AutoUserSpecification -### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': Values are: - - NonAdmin - The user is a standard user without elevated access. - Admin - The user is a user with elevated access and operates with full Administrator permissions. -* **scope**: 'Pool' | 'Task': 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. - ## TaskSchedulingPolicy ### Properties * **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. @@ -364,15 +355,24 @@ * **name**: string (Required): The name of the user account. * **password**: string (Required): The password for the user account. -## LinuxUserConfiguration +## UserIdentity ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. +* **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## BatchAccountKeys +## VirtualMachineConfiguration ### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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. +* **nodeAgentSkuId**: string (Required): 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. +* **osDisk**: [OSDisk](#osdisk): Settings for the operating system disk of the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. + +## WindowsConfiguration +### Properties +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. diff --git a/generated/batch/microsoft.batch/2018-12-01/types.md b/generated/batch/microsoft.batch/2018-12-01/types.md index 3b7706688a..79b5390df9 100644 --- a/generated/batch/microsoft.batch/2018-12-01/types.md +++ b/generated/batch/microsoft.batch/2018-12-01/types.md @@ -56,46 +56,74 @@ * **ApiVersion**: 2018-12-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountCreateProperties +## ApplicationPackageProperties ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for this Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): The dedicated core quota for this Batch account. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): The low-priority core quota for this Batch account. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for this Batch account. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. + +## ApplicationPackageReference +### Properties +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. + +## ApplicationProperties +### Properties +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. + +## AutoScaleRun +### Properties +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. ## AutoStorageBaseProperties ### Properties * **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## KeyVaultReference +## AutoUserSpecification ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is task. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationProperties +## BatchAccountCreateProperties ### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for this Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): The dedicated core quota for this Batch account. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): The low-priority core quota for this Batch account. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for this Batch account. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -## ApplicationPackageProperties +## BatchAccountKeys ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -111,57 +139,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: 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. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **maxTasksPerNode**: int: The maximum number of tasks that can run concurrently on a single compute node in the pool. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -169,28 +146,11 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration -### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. - ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## ContainerConfiguration ### Properties * **containerImageNames**: string[]: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. @@ -210,6 +170,30 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. + ## ImageReference ### Properties * **id**: string: 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 . @@ -218,9 +202,25 @@ * **sku**: string: For example, 14.04.0-LTS or 2012-R2-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## WindowsConfiguration +## InboundNatPool ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -232,24 +232,48 @@ * **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. * **subnetId**: 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 +## NetworkSecurityGroupRule +### Properties +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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. +* **sourceAddressPrefix**: string (Required): 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. + ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: 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. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **maxTasksPerNode**: int: The maximum number of tasks that can run concurrently on a single compute node in the pool. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## NetworkSecurityGroupRule +## ResizeError ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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. -* **sourceAddressPrefix**: string (Required): 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. +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. ## ResizeOperationStatus ### Properties @@ -260,29 +284,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -299,30 +314,6 @@ * **imageName**: string (Required): This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. * **registry**: [ContainerRegistry](#containerregistry): A private container registry. -## EnvironmentSetting -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. - -## ResourceFile -### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. - -## UserIdentity -### Properties -* **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. -* **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. - -## AutoUserSpecification -### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is task. - ## TaskSchedulingPolicy ### Properties * **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. @@ -335,19 +326,28 @@ * **password**: string (Required): The password for the user account. * **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. -## LinuxUserConfiguration +## UserIdentity ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. +* **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## WindowsUserConfiguration +## VirtualMachineConfiguration ### Properties -* **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## BatchAccountKeys + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. + +## WindowsConfiguration ### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. + +## WindowsUserConfiguration +### Properties +* **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. diff --git a/generated/batch/microsoft.batch/2019-04-01/types.md b/generated/batch/microsoft.batch/2019-04-01/types.md index e54eeb7e8e..044d790c25 100644 --- a/generated/batch/microsoft.batch/2019-04-01/types.md +++ b/generated/batch/microsoft.batch/2019-04-01/types.md @@ -56,53 +56,76 @@ * **ApiVersion**: 2019-04-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountCreateProperties +## ApplicationPackageProperties ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. + +## ApplicationPackageReference +### Properties +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. + +## ApplicationProperties +### Properties +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. + +## AutoScaleRun +### Properties +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. ## AutoStorageBaseProperties ### Properties * **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## VirtualMachineFamilyCoreQuota -### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. - -## KeyVaultReference +## AutoUserSpecification ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is task. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationProperties +## BatchAccountCreateProperties ### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -## ApplicationPackageProperties +## BatchAccountKeys ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -118,57 +141,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -176,28 +148,11 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration -### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. - ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## ContainerConfiguration ### Properties * **containerImageNames**: string[]: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. @@ -217,6 +172,30 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. + ## ImageReference ### Properties * **id**: string: 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 . @@ -225,9 +204,25 @@ * **sku**: string: For example, 14.04.0-LTS or 2012-R2-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## WindowsConfiguration +## InboundNatPool ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -239,24 +234,48 @@ * **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. * **subnetId**: 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 +## NetworkSecurityGroupRule +### Properties +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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. +* **sourceAddressPrefix**: string (Required): 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. + ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## NetworkSecurityGroupRule +## ResizeError ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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. -* **sourceAddressPrefix**: string (Required): 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. +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. ## ResizeOperationStatus ### Properties @@ -267,29 +286,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -306,55 +316,45 @@ * **imageName**: string (Required): This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. * **registry**: [ContainerRegistry](#containerregistry): A private container registry. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is task. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy -### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. -## UserAccount +## VirtualMachineFamilyCoreQuota ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2019-08-01/types.md b/generated/batch/microsoft.batch/2019-08-01/types.md index a52997bc8b..249203a1f9 100644 --- a/generated/batch/microsoft.batch/2019-08-01/types.md +++ b/generated/batch/microsoft.batch/2019-08-01/types.md @@ -56,53 +56,93 @@ * **ApiVersion**: 2019-08-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountCreateProperties +## ApplicationPackageProperties ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. + +## ApplicationPackageReference +### Properties +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. + +## ApplicationProperties +### Properties +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. + +## AutoScaleRun +### Properties +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. ## AutoStorageBaseProperties ### Properties * **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## VirtualMachineFamilyCoreQuota +## AutoUserSpecification ### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. -## KeyVaultReference +## AzureBlobFileSystemConfiguration ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. + +## AzureFileShareConfiguration +### Properties +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationProperties +## BatchAccountCreateProperties ### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -## ApplicationPackageProperties +## BatchAccountKeys ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -118,58 +158,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -177,28 +165,19 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## ContainerConfiguration ### Properties * **containerImageNames**: string[]: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. @@ -218,6 +197,30 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. + ## ImageReference ### Properties * **id**: string: This property is mutually exclusive with other properties. For Virtual Machine Image it must be in the same region and subscription as the Azure Batch account. For SIG image it must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. @@ -226,9 +229,25 @@ * **sku**: string: For example, 18.04-LTS or 2019-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## WindowsConfiguration +## InboundNatPool ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -242,30 +261,18 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration -### Properties -* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. - -## AzureFileShareConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPs**: string[]: The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. +* **subnetId**: 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 -## CifsMountConfiguration +## NetworkSecurityGroupRule ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ## NFSMountConfiguration ### Properties @@ -273,31 +280,43 @@ * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -## NetworkConfiguration -### Properties -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPs**: string[]: The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. -* **subnetId**: 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 - ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## NetworkSecurityGroupRule +## ResizeError ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. ## ResizeOperationStatus ### Properties @@ -308,29 +327,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriority nodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -348,55 +358,45 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy -### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. -## UserAccount +## VirtualMachineFamilyCoreQuota ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2020-03-01/types.md b/generated/batch/microsoft.batch/2020-03-01/types.md index 6763ad968a..ce4138113b 100644 --- a/generated/batch/microsoft.batch/2020-03-01/types.md +++ b/generated/batch/microsoft.batch/2020-03-01/types.md @@ -56,89 +56,96 @@ * **ApiVersion**: 2020-03-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountCreateProperties +## ApplicationPackageProperties ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **encryption**: [EncryptionProperties](#encryptionproperties) -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -## AutoStorageBaseProperties +## ApplicationPackageReference ### Properties -* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. -* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. -## VirtualMachineFamilyCoreQuota +## ApplicationProperties ### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. -## EncryptionProperties +## AutoScaleRun ### Properties -* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. -## KeyVaultProperties +## AutoScaleRunError ### Properties -* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053 +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. -## KeyVaultReference +## AutoScaleSettings ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. -## PrivateEndpointConnection +## AutoStorageBaseProperties ### Properties -* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. -* **id**: string (ReadOnly): The ID of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. -* **type**: string (ReadOnly): The type of the resource. +* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. +* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## PrivateEndpointConnectionProperties +## AutoUserSpecification ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. -## PrivateEndpoint +## AzureBlobFileSystemConfiguration ### Properties -* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. +* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. -## PrivateLinkServiceConnectionState +## AzureFileShareConfiguration ### Properties -* **actionRequired**: string (ReadOnly): Action required on the private connection state -* **description**: string (ReadOnly): Description of the private Connection state -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationProperties +## BatchAccountCreateProperties ### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **encryption**: [EncryptionProperties](#encryptionproperties) +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. -## ApplicationPackageProperties +## BatchAccountKeys ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -154,58 +161,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -213,29 +168,19 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## ContainerConfiguration ### Properties * **containerImageNames**: string[]: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. @@ -255,10 +200,39 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + ## DiskEncryptionConfiguration ### Properties * **targets**: 'OsDisk' | 'TemporaryDisk'[]: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. +## EncryptionProperties +### Properties +* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. + ## ImageReference ### Properties * **id**: string: This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. @@ -267,9 +241,29 @@ * **sku**: string: For example, 18.04-LTS or 2019-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## WindowsConfiguration +## InboundNatPool ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. + +## KeyVaultProperties +### Properties +* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053 + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -283,68 +277,92 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. +* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration -## AzureFileShareConfiguration +## NetworkSecurityGroupRule ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. -## CifsMountConfiguration +## NFSMountConfiguration ### Properties * **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. -## NFSMountConfiguration +## PoolEndpointConfiguration ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. -## NetworkConfiguration +## PoolProperties ### Properties -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. -* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## PoolEndpointConfiguration +## PrivateEndpoint ### Properties -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. +* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. -## InboundNatPool +## PrivateEndpointConnection ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. +* **id**: string (ReadOnly): The ID of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. +* **type**: string (ReadOnly): The type of the resource. -## NetworkSecurityGroupRule +## PrivateEndpointConnectionProperties ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): Action required on the private connection state +* **description**: string (ReadOnly): Description of the private Connection state +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection ## PublicIPAddressConfiguration ### Properties * **ipAddressIds**: string[]: The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. * **provision**: 'BatchManaged' | 'NoPublicIPAddresses' | 'UserManaged': The provisioning type for Public IP Addresses for the Batch Pool. +## ResizeError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + ## ResizeOperationStatus ### Properties * **errors**: [ResizeError](#resizeerror)[]: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. @@ -354,29 +372,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -394,55 +403,46 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy -### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. -## UserAccount +## VirtualMachineFamilyCoreQuota ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2020-05-01/types.md b/generated/batch/microsoft.batch/2020-05-01/types.md index 1787b4e99e..3ef265c368 100644 --- a/generated/batch/microsoft.batch/2020-05-01/types.md +++ b/generated/batch/microsoft.batch/2020-05-01/types.md @@ -57,99 +57,102 @@ * **ApiVersion**: 2020-05-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' (Required): The type of identity used for the Batch account. - -## BatchAccountCreateProperties +## ApplicationPackageProperties ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -## AutoStorageBaseProperties +## ApplicationPackageReference ### Properties -* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. -* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. -## VirtualMachineFamilyCoreQuota +## ApplicationProperties ### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. -## EncryptionProperties +## AutoScaleRun ### Properties -* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. -## KeyVaultProperties +## AutoScaleRunError ### Properties -* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: - - The Batch Account has a System Assigned identity - The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions - The KeyVault has soft-delete and purge protection enabled +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. -## KeyVaultReference +## AutoScaleSettings ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. -## PrivateEndpointConnection +## AutoStorageBaseProperties ### Properties -* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. -* **id**: string (ReadOnly): The ID of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. -* **type**: string (ReadOnly): The type of the resource. +* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. +* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## PrivateEndpointConnectionProperties +## AutoUserSpecification ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. -## PrivateEndpoint +## AzureBlobFileSystemConfiguration ### Properties -* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. +* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. -## PrivateLinkServiceConnectionState +## AzureFileShareConfiguration ### Properties -* **actionRequired**: string (ReadOnly): Action required on the private connection state -* **description**: string (ReadOnly): Description of the private Connection state -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationProperties +## BatchAccountCreateProperties ### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. -## ApplicationPackageProperties +## BatchAccountIdentity ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' (Required): The type of identity used for the Batch account. + +## BatchAccountKeys +### Properties +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -165,58 +168,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -224,29 +175,19 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## ContainerConfiguration ### Properties * **containerImageNames**: string[]: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. @@ -266,10 +207,39 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + ## DiskEncryptionConfiguration ### Properties * **targets**: 'OsDisk' | 'TemporaryDisk'[]: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. +## EncryptionProperties +### Properties +* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. + ## ImageReference ### Properties * **id**: string: This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. @@ -278,9 +248,33 @@ * **sku**: string: For example, 18.04-LTS or 2019-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## WindowsConfiguration +## InboundNatPool ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. + +## KeyVaultProperties +### Properties +* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: + + The Batch Account has a System Assigned identity + The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions + The KeyVault has soft-delete and purge protection enabled + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -294,68 +288,92 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. +* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration -## AzureFileShareConfiguration +## NetworkSecurityGroupRule ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. -## CifsMountConfiguration +## NFSMountConfiguration ### Properties * **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. -## NFSMountConfiguration +## PoolEndpointConfiguration ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. -## NetworkConfiguration +## PoolProperties ### Properties -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. -* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **maxTasksPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## PoolEndpointConfiguration +## PrivateEndpoint ### Properties -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. +* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. -## InboundNatPool +## PrivateEndpointConnection ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. +* **id**: string (ReadOnly): The ID of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. +* **type**: string (ReadOnly): The type of the resource. -## NetworkSecurityGroupRule +## PrivateEndpointConnectionProperties ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): Action required on the private connection state +* **description**: string (ReadOnly): Description of the private Connection state +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection ## PublicIPAddressConfiguration ### Properties * **ipAddressIds**: string[]: The number of IPs specified here limits the maximum size of the Pool - 50 dedicated nodes or 20 low-priority nodes can be allocated for each public IP. For example, a pool needing 150 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. * **provision**: 'BatchManaged' | 'NoPublicIPAddresses' | 'UserManaged': The provisioning type for Public IP Addresses for the Batch Pool. +## ResizeError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + ## ResizeOperationStatus ### Properties * **errors**: [ResizeError](#resizeerror)[]: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. @@ -365,29 +383,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -405,55 +414,46 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy -### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. -## UserAccount +## VirtualMachineFamilyCoreQuota ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2020-09-01/types.md b/generated/batch/microsoft.batch/2020-09-01/types.md index 40ba6e0f2b..911ee51e30 100644 --- a/generated/batch/microsoft.batch/2020-09-01/types.md +++ b/generated/batch/microsoft.batch/2020-09-01/types.md @@ -57,99 +57,102 @@ * **ApiVersion**: 2020-09-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' (Required): The type of identity used for the Batch account. - -## BatchAccountCreateProperties +## ApplicationPackageProperties ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -## AutoStorageBaseProperties +## ApplicationPackageReference ### Properties -* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. -* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. -## VirtualMachineFamilyCoreQuota +## ApplicationProperties ### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. -## EncryptionProperties +## AutoScaleRun ### Properties -* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. -## KeyVaultProperties +## AutoScaleRunError ### Properties -* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: - - The Batch Account has a System Assigned identity - The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions - The KeyVault has soft-delete and purge protection enabled +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. -## KeyVaultReference +## AutoScaleSettings ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. -## PrivateEndpointConnection +## AutoStorageBaseProperties ### Properties -* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. -* **id**: string (ReadOnly): The ID of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. -* **type**: string (ReadOnly): The type of the resource. +* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. +* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## PrivateEndpointConnectionProperties +## AutoUserSpecification ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. -## PrivateEndpoint +## AzureBlobFileSystemConfiguration ### Properties -* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. +* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. -## PrivateLinkServiceConnectionState +## AzureFileShareConfiguration ### Properties -* **actionRequired**: string (ReadOnly): Action required on the private connection state -* **description**: string (ReadOnly): Description of the private Connection state -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ## BatchAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationProperties +## BatchAccountCreateProperties ### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. -## ApplicationPackageProperties +## BatchAccountIdentity ### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' (Required): The type of identity used for the Batch account. + +## BatchAccountKeys +### Properties +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. ## CertificateCreateOrUpdateProperties ### Properties @@ -165,58 +168,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -224,29 +175,19 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration -### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. - ## ContainerConfiguration ### Properties * **containerImageNames**: string[]: This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. @@ -266,10 +207,39 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + ## DiskEncryptionConfiguration ### Properties * **targets**: 'OsDisk' | 'TemporaryDisk'[]: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. +## EncryptionProperties +### Properties +* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. + ## ImageReference ### Properties * **id**: string: This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. @@ -278,9 +248,33 @@ * **sku**: string: For example, 18.04-LTS or 2019-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## WindowsConfiguration +## InboundNatPool ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. + +## KeyVaultProperties +### Properties +* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: + + The Batch Account has a System Assigned identity + The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions + The KeyVault has soft-delete and purge protection enabled + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -294,68 +288,92 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. +* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration -## AzureFileShareConfiguration +## NetworkSecurityGroupRule ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. -## CifsMountConfiguration +## NFSMountConfiguration ### Properties * **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. -## NFSMountConfiguration +## PoolEndpointConfiguration ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. -## NetworkConfiguration +## PoolProperties ### Properties -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. -* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## PoolEndpointConfiguration +## PrivateEndpoint ### Properties -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. +* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. -## InboundNatPool +## PrivateEndpointConnection ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. +* **id**: string (ReadOnly): The ID of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. +* **type**: string (ReadOnly): The type of the resource. -## NetworkSecurityGroupRule +## PrivateEndpointConnectionProperties ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): Action required on the private connection state +* **description**: string (ReadOnly): Description of the private Connection state +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection ## PublicIPAddressConfiguration ### Properties * **ipAddressIds**: string[]: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. * **provision**: 'BatchManaged' | 'NoPublicIPAddresses' | 'UserManaged': The provisioning type for Public IP Addresses for the Batch Pool. +## ResizeError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + ## ResizeOperationStatus ### Properties * **errors**: [ResizeError](#resizeerror)[]: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. @@ -365,29 +383,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -405,55 +414,46 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy -### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. -## UserAccount +## VirtualMachineFamilyCoreQuota ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2021-01-01/types.md b/generated/batch/microsoft.batch/2021-01-01/types.md index 0684a3fd2d..f901002ca4 100644 --- a/generated/batch/microsoft.batch/2021-01-01/types.md +++ b/generated/batch/microsoft.batch/2021-01-01/types.md @@ -58,22 +58,73 @@ * **ApiVersion**: 2021-01-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountIdentity +## ApplicationPackageProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): The type of identity used for the Batch account. -* **userAssignedIdentities**: [BatchAccountIdentityUserAssignedIdentities](#batchaccountidentityuserassignedidentities): The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -## BatchAccountIdentityUserAssignedIdentities +## ApplicationPackageReference ### Properties -### Additional Properties -* **Additional Properties Type**: [Components19E4Rl9SchemasBatchaccountidentityPropertiesUserassignedidentitiesAdditionalproperties](#components19e4rl9schemasbatchaccountidentitypropertiesuserassignedidentitiesadditionalproperties) +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. -## Components19E4Rl9SchemasBatchaccountidentityPropertiesUserassignedidentitiesAdditionalproperties +## ApplicationProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. + +## AutoScaleRun +### Properties +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. + +## AutoStorageBaseProperties +### Properties +* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. +* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. + +## AutoUserSpecification +### Properties +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. + +## AzureBlobFileSystemConfiguration +### Properties +* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. + +## AzureFileShareConfiguration +### Properties +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. + +## BatchAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## BatchAccountCreateProperties ### Properties @@ -92,76 +143,33 @@ * **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource * **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. -## AutoStorageBaseProperties -### Properties -* **lastKeySync**: string (ReadOnly): The UTC time at which storage keys were last synchronized with the Batch account. -* **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. - -## VirtualMachineFamilyCoreQuota -### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. - -## EncryptionProperties -### Properties -* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. - -## KeyVaultProperties -### Properties -* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: - - The Batch Account has a System Assigned identity - The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions - The KeyVault has soft-delete and purge protection enabled - -## KeyVaultReference -### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. - -## PrivateEndpointConnection +## BatchAccountIdentity ### Properties -* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. -* **id**: string (ReadOnly): The ID of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. -* **type**: string (ReadOnly): The type of the resource. +* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): The type of identity used for the Batch account. +* **userAssignedIdentities**: [BatchAccountIdentityUserAssignedIdentities](#batchaccountidentityuserassignedidentities): The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## PrivateEndpointConnectionProperties +## BatchAccountIdentityUserAssignedIdentities ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. +### Additional Properties +* **Additional Properties Type**: [Components19E4Rl9SchemasBatchaccountidentityPropertiesUserassignedidentitiesAdditionalproperties](#components19e4rl9schemasbatchaccountidentitypropertiesuserassignedidentitiesadditionalproperties) -## PrivateEndpoint +## BatchAccountKeys ### Properties -* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. -## PrivateLinkServiceConnectionState +## BatchPoolIdentity ### Properties -* **actionRequired**: string (ReadOnly): Action required on the private connection state -* **description**: string (ReadOnly): Description of the private Connection state -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection +* **type**: 'None' | 'UserAssigned' (Required): The type of identity used for the Batch Pool. +* **userAssignedIdentities**: [BatchPoolIdentityUserAssignedIdentities](#batchpoolidentityuserassignedidentities): The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## BatchAccountCreateParametersTags +## BatchPoolIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApplicationProperties -### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. - -## ApplicationPackageProperties -### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **Additional Properties Type**: [Components81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties](#components81xseeschemasbatchpoolidentitypropertiesuserassignedidentitiesadditionalproperties) ## CertificateCreateOrUpdateProperties ### Properties @@ -177,73 +185,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## BatchPoolIdentity -### Properties -* **type**: 'None' | 'UserAssigned' (Required): The type of identity used for the Batch Pool. -* **userAssignedIdentities**: [BatchPoolIdentityUserAssignedIdentities](#batchpoolidentityuserassignedidentities): The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## BatchPoolIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties](#components81xseeschemasbatchpoolidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -251,30 +192,28 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration +## Components19E4Rl9SchemasBatchaccountidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. -* **extensions**: [VMExtension](#vmextension)[]: If specified, the extensions mentioned in this configuration will be installed on each node. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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: +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. - Windows_Server - The on-premises license is for Windows Server. - Windows_Client - The on-premises license is for Windows Client. -* **nodeAgentSkuId**: string (Required): 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. -* **nodePlacementConfiguration**: [NodePlacementConfiguration](#nodeplacementconfiguration): Allocation configuration used by Batch Service to provision the nodes. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. +## Components81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## ContainerConfiguration ### Properties @@ -295,20 +234,38 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + ## DiskEncryptionConfiguration ### Properties * **targets**: 'OsDisk' | 'TemporaryDisk'[]: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. -## VMExtension +## EncryptionProperties ### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **name**: string (Required): The name of the virtual machine extension. -* **protectedSettings**: any: Any object -* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. -* **publisher**: string (Required): The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string (Required): The type of the extensions. -* **typeHandlerVersion**: string: The version of script handler. +* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ## ImageReference ### Properties @@ -318,13 +275,33 @@ * **sku**: string: For example, 18.04-LTS or 2019-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## NodePlacementConfiguration +## InboundNatPool ### Properties -* **policy**: 'Regional' | 'Zonal': The default value is regional. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. -## WindowsConfiguration +## KeyVaultProperties ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: + + The Batch Account has a System Assigned identity + The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions + The KeyVault has soft-delete and purge protection enabled + +## KeyVaultReference +### Properties +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. + +## LinuxUserConfiguration +### Properties +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -338,30 +315,18 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration -### Properties -* **accountKey**: string: This property is mutually exclusive with sasKey and one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with accountKey and one must be specified. - -## AzureFileShareConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. +* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration -## CifsMountConfiguration +## NetworkSecurityGroupRule ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. ## NFSMountConfiguration ### Properties @@ -369,37 +334,77 @@ * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -## NetworkConfiguration +## NodePlacementConfiguration ### Properties -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. -* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration +* **policy**: 'Regional' | 'Zonal': The default value is regional. ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## NetworkSecurityGroupRule +## PrivateEndpoint ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. + +## PrivateEndpointConnection +### Properties +* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. +* **id**: string (ReadOnly): The ID of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. +* **type**: string (ReadOnly): The type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): Action required on the private connection state +* **description**: string (ReadOnly): Description of the private Connection state +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection ## PublicIPAddressConfiguration ### Properties * **ipAddressIds**: string[]: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. * **provision**: 'BatchManaged' | 'NoPublicIPAddresses' | 'UserManaged': The provisioning type for Public IP Addresses for the Batch Pool. +## ResizeError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + ## ResizeOperationStatus ### Properties * **errors**: [ResizeError](#resizeerror)[]: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. @@ -409,29 +414,20 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -449,55 +445,59 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it 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. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable 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 and list permissions on the blob, or set the ACL for the blob or its container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. +* **extensions**: [VMExtension](#vmextension)[]: If specified, the extensions mentioned in this configuration will be installed on each node. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **nodePlacementConfiguration**: [NodePlacementConfiguration](#nodeplacementconfiguration): Allocation configuration used by Batch Service to provision the nodes. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. + +## VirtualMachineFamilyCoreQuota ### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## UserAccount +## VMExtension ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **autoUpgradeMinorVersion**: bool: 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. +* **name**: string (Required): The name of the virtual machine extension. +* **protectedSettings**: any: Any object +* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. +* **publisher**: string (Required): The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string (Required): The type of the extensions. +* **typeHandlerVersion**: string: The version of script handler. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2021-06-01/types.md b/generated/batch/microsoft.batch/2021-06-01/types.md index 568129b9aa..4668be1ed3 100644 --- a/generated/batch/microsoft.batch/2021-06-01/types.md +++ b/generated/batch/microsoft.batch/2021-06-01/types.md @@ -58,40 +58,41 @@ * **ApiVersion**: 2021-06-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountIdentity +## ApplicationPackageProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): The type of identity used for the Batch account. -* **userAssignedIdentities**: [BatchAccountIdentityUserAssignedIdentities](#batchaccountidentityuserassignedidentities): The list of user identities associated with the Batch account. +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -## BatchAccountIdentityUserAssignedIdentities +## ApplicationPackageReference ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. -## UserAssignedIdentities +## ApplicationProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. -## BatchAccountCreateProperties +## AutoScaleRun ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **allowedAuthenticationModes**: 'AAD' | 'SharedKey' | 'TaskAuthenticationToken'[]: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. ## AutoStorageBaseProperties ### Properties @@ -100,75 +101,79 @@ * **nodeIdentityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## ComputeNodeIdentityReference +## AutoUserSpecification ### Properties -* **resourceId**: string: The ARM resource id of the user assigned identity. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. -## VirtualMachineFamilyCoreQuota +## AzureBlobFileSystemConfiguration ### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. +* **accountKey**: string: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. -## EncryptionProperties +## AzureFileShareConfiguration ### Properties -* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -## KeyVaultProperties +## BatchAccountCreateParametersTags ### Properties -* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: - - The Batch Account has a System Assigned identity - The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions - The KeyVault has soft-delete and purge protection enabled +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultReference +## BatchAccountCreateProperties ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **allowedAuthenticationModes**: 'AAD' | 'SharedKey' | 'TaskAuthenticationToken'[]: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. -## PrivateEndpointConnection +## BatchAccountIdentity ### Properties -* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. -* **id**: string (ReadOnly): The ID of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. -* **type**: string (ReadOnly): The type of the resource. +* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): The type of identity used for the Batch account. +* **userAssignedIdentities**: [BatchAccountIdentityUserAssignedIdentities](#batchaccountidentityuserassignedidentities): The list of user identities associated with the Batch account. -## PrivateEndpointConnectionProperties +## BatchAccountIdentityUserAssignedIdentities ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) -## PrivateEndpoint +## BatchAccountKeys ### Properties -* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. -## PrivateLinkServiceConnectionState +## BatchPoolIdentity ### Properties -* **actionRequired**: string (ReadOnly): Action required on the private connection state -* **description**: string (ReadOnly): Description of the private Connection state -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection +* **type**: 'None' | 'UserAssigned' (Required): The type of identity used for the Batch Pool. +* **userAssignedIdentities**: [BatchPoolIdentityUserAssignedIdentities](#batchpoolidentityuserassignedidentities): The list of user identities associated with the Batch pool. -## BatchAccountCreateParametersTags +## BatchPoolIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApplicationProperties -### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. - -## ApplicationPackageProperties -### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) ## CertificateCreateOrUpdateProperties ### Properties @@ -184,68 +189,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## BatchPoolIdentity -### Properties -* **type**: 'None' | 'UserAssigned' (Required): The type of identity used for the Batch Pool. -* **userAssignedIdentities**: [BatchPoolIdentityUserAssignedIdentities](#batchpoolidentityuserassignedidentities): The list of user identities associated with the Batch pool. - -## BatchPoolIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of low-priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -253,31 +196,22 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration +## ComputeNodeIdentityReference ### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. -* **extensions**: [VMExtension](#vmextension)[]: If specified, the extensions mentioned in this configuration will be installed on each node. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **nodePlacementConfiguration**: [NodePlacementConfiguration](#nodeplacementconfiguration): Allocation configuration used by Batch Service to provision the nodes. -* **osDisk**: [OSDisk](#osdisk): Settings for the operating system disk of the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. +* **resourceId**: string: The ARM resource id of the user assigned identity. ## ContainerConfiguration ### Properties @@ -299,20 +233,42 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + +## DiffDiskSettings +### Properties +* **placement**: 'CacheDisk': This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + ## DiskEncryptionConfiguration ### Properties * **targets**: 'OsDisk' | 'TemporaryDisk'[]: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. -## VMExtension +## EncryptionProperties ### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **name**: string (Required): The name of the virtual machine extension. -* **protectedSettings**: any: Any object -* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. -* **publisher**: string (Required): The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string (Required): The type of the extensions. -* **typeHandlerVersion**: string: The version of script handler. +* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ## ImageReference ### Properties @@ -322,21 +278,33 @@ * **sku**: string: For example, 18.04-LTS or 2019-Datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## NodePlacementConfiguration +## InboundNatPool ### Properties -* **policy**: 'Regional' | 'Zonal': The default value is regional. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. -## OSDisk +## KeyVaultProperties ### Properties -* **ephemeralOSDiskSettings**: [DiffDiskSettings](#diffdisksettings): Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. +* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: -## DiffDiskSettings + The Batch Account has a System Assigned identity + The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions + The KeyVault has soft-delete and purge protection enabled + +## KeyVaultReference ### Properties -* **placement**: 'CacheDisk': This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. -## WindowsConfiguration +## LinuxUserConfiguration ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -350,69 +318,100 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. +* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration -## AzureFileShareConfiguration +## NetworkSecurityGroupRule ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. -## CifsMountConfiguration +## NFSMountConfiguration ### Properties * **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. -## NFSMountConfiguration +## NodePlacementConfiguration ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. +* **policy**: 'Regional' | 'Zonal': The default value is regional. -## NetworkConfiguration +## OSDisk ### Properties -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. -* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration +* **ephemeralOSDiskSettings**: [DiffDiskSettings](#diffdisksettings): Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of low-priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## NetworkSecurityGroupRule +## PrivateEndpoint ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. + +## PrivateEndpointConnection +### Properties +* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. +* **id**: string (ReadOnly): The ID of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. +* **type**: string (ReadOnly): The type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): Action required on the private connection state +* **description**: string (ReadOnly): Description of the private Connection state +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection ## PublicIPAddressConfiguration ### Properties * **ipAddressIds**: string[]: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. * **provision**: 'BatchManaged' | 'NoPublicIPAddresses' | 'UserManaged': The provisioning type for Public IP Addresses for the Batch Pool. +## ResizeError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + ## ResizeOperationStatus ### Properties * **errors**: [ResizeError](#resizeerror)[]: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. @@ -422,29 +421,21 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. +* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -462,56 +453,65 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. -* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. + +## UserAssignedIdentities +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. +* **extensions**: [VMExtension](#vmextension)[]: If specified, the extensions mentioned in this configuration will be installed on each node. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **nodePlacementConfiguration**: [NodePlacementConfiguration](#nodeplacementconfiguration): Allocation configuration used by Batch Service to provision the nodes. +* **osDisk**: [OSDisk](#osdisk): Settings for the operating system disk of the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. + +## VirtualMachineFamilyCoreQuota ### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## UserAccount +## VMExtension ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **autoUpgradeMinorVersion**: bool: 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. +* **name**: string (Required): The name of the virtual machine extension. +* **protectedSettings**: any: Any object +* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. +* **publisher**: string (Required): The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string (Required): The type of the extensions. +* **typeHandlerVersion**: string: The version of script handler. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/batch/microsoft.batch/2022-01-01/types.md b/generated/batch/microsoft.batch/2022-01-01/types.md index 8f58342b71..df82f96a69 100644 --- a/generated/batch/microsoft.batch/2022-01-01/types.md +++ b/generated/batch/microsoft.batch/2022-01-01/types.md @@ -58,40 +58,41 @@ * **ApiVersion**: 2022-01-01 * **Output**: [BatchAccountKeys](#batchaccountkeys) -## BatchAccountIdentity +## ApplicationPackageProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): The type of identity used for the Batch account. -* **userAssignedIdentities**: [BatchAccountIdentityUserAssignedIdentities](#batchaccountidentityuserassignedidentities): The list of user identities associated with the Batch account. +* **format**: string (ReadOnly): The format of the application package, if the package is active. +* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. +* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. +* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. +* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. -## BatchAccountIdentityUserAssignedIdentities +## ApplicationPackageReference ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) +* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. +* **version**: 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. -## UserAssignedIdentities +## ApplicationProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. +* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. +* **displayName**: string: The display name for the application. -## BatchAccountCreateProperties +## AutoScaleRun ### Properties -* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. -* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. -* **allowedAuthenticationModes**: 'AAD' | 'SharedKey' | 'TaskAuthenticationToken'[]: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. -* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. -* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. -* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. -* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. -* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. -* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. -* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource -* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. +* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. +* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. +* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. + +## AutoScaleRunError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + +## AutoScaleSettings +### Properties +* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). +* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. ## AutoStorageBaseProperties ### Properties @@ -100,75 +101,79 @@ * **nodeIdentityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. * **storageAccountId**: string (Required): The resource ID of the storage account to be used for auto-storage account. -## ComputeNodeIdentityReference +## AutoUserSpecification ### Properties -* **resourceId**: string: The ARM resource id of the user assigned identity. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. -## VirtualMachineFamilyCoreQuota +## AzureBlobFileSystemConfiguration ### Properties -* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. -* **name**: string (ReadOnly): The Virtual Machine family name. +* **accountKey**: string: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. +* **accountName**: string (Required): The Azure Storage Account name. +* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **containerName**: string (Required): The Azure Blob Storage Container name. +* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **sasKey**: string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. -## EncryptionProperties +## AzureFileShareConfiguration ### Properties -* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. +* **accountKey**: string (Required): The Azure Storage account key. +* **accountName**: string (Required): The Azure Storage account name. +* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -## KeyVaultProperties +## BatchAccountCreateParametersTags ### Properties -* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: - - The Batch Account has a System Assigned identity - The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions - The KeyVault has soft-delete and purge protection enabled +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultReference +## BatchAccountCreateProperties ### Properties -* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. -* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. +* **accountEndpoint**: string (ReadOnly): The account endpoint used to interact with the Batch service. +* **activeJobAndJobScheduleQuota**: int (ReadOnly): The active job and job schedule quota for the Batch account. +* **allowedAuthenticationModes**: 'AAD' | 'SharedKey' | 'TaskAuthenticationToken'[]: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. +* **autoStorage**: [AutoStorageBaseProperties](#autostoragebaseproperties): The properties related to the auto-storage account. +* **dedicatedCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamily**: [VirtualMachineFamilyCoreQuota](#virtualmachinefamilycorequota)[] (ReadOnly): A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **dedicatedCoreQuotaPerVMFamilyEnforced**: bool (ReadOnly): Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply. +* **encryption**: [EncryptionProperties](#encryptionproperties): Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. +* **keyVaultReference**: [KeyVaultReference](#keyvaultreference): Identifies the Azure key vault associated with a Batch account. +* **lowPriorityCoreQuota**: int (ReadOnly): For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. +* **poolAllocationMode**: 'BatchService' | 'UserSubscription': The allocation mode for creating pools in the Batch account. +* **poolQuota**: int (ReadOnly): The pool quota for the Batch account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections associated with the Batch account +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Succeeded' (ReadOnly): The provisioned state of the resource +* **publicNetworkAccess**: 'Disabled' | 'Enabled': The network access type for operating on the resources in the Batch account. -## PrivateEndpointConnection +## BatchAccountIdentity ### Properties -* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. -* **id**: string (ReadOnly): The ID of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. -* **type**: string (ReadOnly): The type of the resource. +* **principalId**: string (ReadOnly): The principal id of the Batch account. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): The type of identity used for the Batch account. +* **userAssignedIdentities**: [BatchAccountIdentityUserAssignedIdentities](#batchaccountidentityuserassignedidentities): The list of user identities associated with the Batch account. -## PrivateEndpointConnectionProperties +## BatchAccountIdentityUserAssignedIdentities ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) -## PrivateEndpoint +## BatchAccountKeys ### Properties -* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. +* **accountName**: string (ReadOnly): The Batch account name. +* **primary**: string (ReadOnly): The primary key associated with the account. +* **secondary**: string (ReadOnly): The secondary key associated with the account. -## PrivateLinkServiceConnectionState +## BatchPoolIdentity ### Properties -* **actionRequired**: string (ReadOnly): Action required on the private connection state -* **description**: string (ReadOnly): Description of the private Connection state -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection +* **type**: 'None' | 'UserAssigned' (Required): The type of identity used for the Batch Pool. +* **userAssignedIdentities**: [BatchPoolIdentityUserAssignedIdentities](#batchpoolidentityuserassignedidentities): The list of user identities associated with the Batch pool. -## BatchAccountCreateParametersTags +## BatchPoolIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApplicationProperties -### Properties -* **allowUpdates**: bool: A value indicating whether packages within the application may be overwritten using the same version string. -* **defaultVersion**: string: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. -* **displayName**: string: The display name for the application. - -## ApplicationPackageProperties -### Properties -* **format**: string (ReadOnly): The format of the application package, if the package is active. -* **lastActivationTime**: string (ReadOnly): The time at which the package was last activated, if the package is active. -* **state**: 'Active' | 'Pending' (ReadOnly): The current state of the application package. -* **storageUrl**: string (ReadOnly): The URL for the application package in Azure Storage. -* **storageUrlExpiry**: string (ReadOnly): The UTC time at which the Azure Storage URL will expire. +* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) ## CertificateCreateOrUpdateProperties ### Properties @@ -184,68 +189,6 @@ * **thumbprint**: string: This must match the thumbprint from the name. * **thumbprintAlgorithm**: string: This must match the first portion of the certificate name. Currently required to be 'SHA1'. -## DeleteCertificateError -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - -## BatchPoolIdentity -### Properties -* **type**: 'None' | 'UserAssigned' (Required): The type of identity used for the Batch Pool. -* **userAssignedIdentities**: [BatchPoolIdentityUserAssignedIdentities](#batchpoolidentityuserassignedidentities): The list of user identities associated with the Batch pool. - -## BatchPoolIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentities](#userassignedidentities) - -## PoolProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. -* **applicationLicenses**: string[]: 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. -* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. -* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. -* **certificates**: [CertificateReference](#certificatereference)[]: 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. -* **creationTime**: string (ReadOnly): The creation time of the pool. -* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. -* **currentLowPriorityNodes**: int (ReadOnly): The number of Spot/low-priority compute nodes currently in the pool. -* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. -* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. -* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. -* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. -* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. -* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. -* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. -* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). -* **scaleSettings**: [ScaleSettings](#scalesettings): 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. -* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. -* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. -* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. -* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. -* **vmSize**: 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). - -## ApplicationPackageReference -### Properties -* **id**: string (Required): The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. -* **version**: 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. - -## AutoScaleRun -### Properties -* **error**: [AutoScaleRunError](#autoscalerunerror): An error that occurred when autoscaling a pool. -* **evaluationTime**: string (Required): The time at which the autoscale formula was last evaluated. -* **results**: string: Each variable value is returned in the form $variable=value, and variables are separated by semicolons. - -## AutoScaleRunError -### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [AutoScaleRunError](#autoscalerunerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. - ## CertificateReference ### Properties * **id**: string (Required): The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. @@ -253,31 +196,22 @@ * **storeName**: 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. * **visibility**: 'RemoteUser' | 'StartTask' | 'Task'[]: Which user accounts on the compute node should have access to the private data of the certificate. -## DeploymentConfiguration +## CifsMountConfiguration ### Properties -* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. -* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. +* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. +* **password**: string (Required): The password to use for authentication against the CIFS file system. +* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **source**: string (Required): The URI of the file system to mount. +* **username**: string (Required): The user to use for authentication against the CIFS file system. ## CloudServiceConfiguration ### Properties * **osFamily**: string (Required): 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. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). * **osVersion**: string: The default value is * which specifies the latest operating system version for the specified OS family. -## VirtualMachineConfiguration +## ComputeNodeIdentityReference ### Properties -* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. -* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. -* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. -* **extensions**: [VMExtension](#vmextension)[]: If specified, the extensions mentioned in this configuration will be installed on each node. -* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. -* **licenseType**: 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. -* **nodeAgentSkuId**: string (Required): 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. -* **nodePlacementConfiguration**: [NodePlacementConfiguration](#nodeplacementconfiguration): Allocation configuration used by Batch Service to provision the nodes. -* **osDisk**: [OSDisk](#osdisk): Settings for the operating system disk of the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. +* **resourceId**: string: The ARM resource id of the user assigned identity. ## ContainerConfiguration ### Properties @@ -299,20 +233,42 @@ * **lun**: int (Required): The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': The storage account type for use in creating data disks. +## DeleteCertificateError +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [DeleteCertificateError](#deletecertificateerror)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## DeploymentConfiguration +### Properties +* **cloudServiceConfiguration**: [CloudServiceConfiguration](#cloudserviceconfiguration): The configuration for nodes in a pool based on the Azure Cloud Services platform. +* **virtualMachineConfiguration**: [VirtualMachineConfiguration](#virtualmachineconfiguration): The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. + +## DiffDiskSettings +### Properties +* **placement**: 'CacheDisk': This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + ## DiskEncryptionConfiguration ### Properties * **targets**: 'OsDisk' | 'TemporaryDisk'[]: On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. -## VMExtension +## EncryptionProperties ### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **name**: string (Required): The name of the virtual machine extension. -* **protectedSettings**: any: Any object -* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. -* **publisher**: string (Required): The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string (Required): The type of the extensions. -* **typeHandlerVersion**: string: The version of script handler. +* **keySource**: 'Microsoft.Batch' | 'Microsoft.KeyVault': Type of the key source. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. + +## EnvironmentSetting +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string: The value of the environment variable. + +## FixedScaleSettings +### Properties +* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. +* **resizeTimeout**: 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). +* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. +* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. ## ImageReference ### Properties @@ -322,21 +278,33 @@ * **sku**: string: For example, 18.04-LTS or 2022-datacenter. * **version**: string: A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -## NodePlacementConfiguration +## InboundNatPool ### Properties -* **policy**: 'Regional' | 'Zonal': The default value is regional. +* **backendPort**: int (Required): 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. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **name**: string (Required): 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. +* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. +* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. -## OSDisk +## KeyVaultProperties ### Properties -* **ephemeralOSDiskSettings**: [DiffDiskSettings](#diffdisksettings): Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. +* **keyIdentifier**: string: Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: -## DiffDiskSettings + The Batch Account has a System Assigned identity + The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions + The KeyVault has soft-delete and purge protection enabled + +## KeyVaultReference ### Properties -* **placement**: 'CacheDisk': This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **id**: string (Required): The resource ID of the Azure key vault associated with the Batch account. +* **url**: string (Required): The URL of the Azure key vault associated with the Batch account. -## WindowsConfiguration +## LinuxUserConfiguration ### Properties -* **enableAutomaticUpdates**: bool: If omitted, the default value is true. +* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. +* **sshPrivateKey**: 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). +* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ## MetadataItem ### Properties @@ -350,70 +318,101 @@ * **cifsMountConfiguration**: [CifsMountConfiguration](#cifsmountconfiguration): Information used to connect to a CIFS file system. * **nfsMountConfiguration**: [NFSMountConfiguration](#nfsmountconfiguration): Information used to connect to an NFS file system. -## AzureBlobFileSystemConfiguration +## NetworkConfiguration ### Properties -* **accountKey**: string: This property is mutually exclusive with both sasKey and identity; exactly one must be specified. -* **accountName**: string (Required): The Azure Storage Account name. -* **blobfuseOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **containerName**: string (Required): The Azure Blob Storage Container name. -* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **sasKey**: string: This property is mutually exclusive with both accountKey and identity; exactly one must be specified. +* **dynamicVNetAssignmentScope**: 'job' | 'none': The scope of dynamic vnet assignment. +* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. +* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. +* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration -## AzureFileShareConfiguration +## NetworkSecurityGroupRule ### Properties -* **accountKey**: string (Required): The Azure Storage account key. -* **accountName**: string (Required): The Azure Storage account name. -* **azureFileUrl**: string (Required): This is of the form 'https://{account}.file.core.windows.net/'. -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. +* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. +* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. -## CifsMountConfiguration +## NFSMountConfiguration ### Properties * **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **password**: string (Required): The password to use for authentication against the CIFS file system. * **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. * **source**: string (Required): The URI of the file system to mount. -* **username**: string (Required): The user to use for authentication against the CIFS file system. -## NFSMountConfiguration +## NodePlacementConfiguration ### Properties -* **mountOptions**: string: These are 'net use' options in Windows and 'mount' options in Linux. -* **relativeMountPath**: string (Required): All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. -* **source**: string (Required): The URI of the file system to mount. +* **policy**: 'Regional' | 'Zonal': The default value is regional. -## NetworkConfiguration +## OSDisk ### Properties -* **dynamicVNetAssignmentScope**: 'job' | 'none': The scope of dynamic vnet assignment. -* **endpointConfiguration**: [PoolEndpointConfiguration](#poolendpointconfiguration): The endpoint configuration for a pool. -* **publicIPAddressConfiguration**: [PublicIPAddressConfiguration](#publicipaddressconfiguration): The public IP Address configuration of the networking configuration of a Pool. -* **subnetId**: 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. 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 cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration +* **ephemeralOSDiskSettings**: [DiffDiskSettings](#diffdisksettings): Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. ## PoolEndpointConfiguration ### Properties * **inboundNatPools**: [InboundNatPool](#inboundnatpool)[] (Required): 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. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. -## InboundNatPool +## PoolProperties ### Properties -* **backendPort**: int (Required): 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. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **name**: string (Required): 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. -* **networkSecurityGroupRules**: [NetworkSecurityGroupRule](#networksecuritygrouprule)[]: 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. -* **protocol**: 'TCP' | 'UDP' (Required): The protocol of the endpoint. +* **allocationState**: 'Resizing' | 'Steady' | 'Stopping' (ReadOnly): Whether the pool is resizing. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current allocation state. +* **applicationLicenses**: string[]: 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. +* **applicationPackages**: [ApplicationPackageReference](#applicationpackagereference)[]: Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. +* **autoScaleRun**: [AutoScaleRun](#autoscalerun) (ReadOnly): The results and errors from an execution of a pool autoscale formula. +* **certificates**: [CertificateReference](#certificatereference)[]: 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. +* **creationTime**: string (ReadOnly): The creation time of the pool. +* **currentDedicatedNodes**: int (ReadOnly): The number of compute nodes currently in the pool. +* **currentLowPriorityNodes**: int (ReadOnly): The number of Spot/low-priority compute nodes currently in the pool. +* **deploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Deployment configuration properties. +* **displayName**: string: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. +* **interNodeCommunication**: 'Disabled' | 'Enabled': 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'. +* **lastModified**: string (ReadOnly): This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state. +* **metadata**: [MetadataItem](#metadataitem)[]: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. +* **mountConfiguration**: [MountConfiguration](#mountconfiguration)[]: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for a pool. +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The current state of the pool. +* **provisioningStateTransitionTime**: string (ReadOnly): The time at which the pool entered its current state. +* **resizeOperationStatus**: [ResizeOperationStatus](#resizeoperationstatus) (ReadOnly): Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). +* **scaleSettings**: [ScaleSettings](#scalesettings): 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. +* **startTask**: [StartTask](#starttask): In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. +* **taskSchedulingPolicy**: [TaskSchedulingPolicy](#taskschedulingpolicy): Specifies how tasks should be distributed across compute nodes. +* **taskSlotsPerNode**: int: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. +* **userAccounts**: [UserAccount](#useraccount)[]: The list of user accounts to be created on each node in the pool. +* **vmSize**: 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). -## NetworkSecurityGroupRule +## PrivateEndpoint ### Properties -* **access**: 'Allow' | 'Deny' (Required): The action that should be taken for a specified IP address, subnet range or tag. -* **priority**: int (Required): 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 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRanges**: string[]: Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. +* **id**: string (ReadOnly): The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. + +## PrivateEndpointConnection +### Properties +* **etag**: string (ReadOnly): The ETag of the resource, used for concurrency statements. +* **id**: string (ReadOnly): The ID of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Private endpoint connection properties. +* **type**: string (ReadOnly): The type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The private endpoint of the private endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state of the private endpoint connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The provisioning state of the private endpoint connection. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): Action required on the private connection state +* **description**: string (ReadOnly): Description of the private Connection state +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' (ReadOnly): The status of the Batch private endpoint connection ## PublicIPAddressConfiguration ### Properties * **ipAddressIds**: string[]: The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. * **provision**: 'BatchManaged' | 'NoPublicIPAddresses' | 'UserManaged': The provisioning type for Public IP Addresses for the Batch Pool. +## ResizeError +### Properties +* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. +* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. + ## ResizeOperationStatus ### Properties * **errors**: [ResizeError](#resizeerror)[]: This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. @@ -423,29 +422,21 @@ * **targetDedicatedNodes**: int: The desired number of dedicated compute nodes in the pool. * **targetLowPriorityNodes**: int: The desired number of Spot/low-priority compute nodes in the pool. -## ResizeError +## ResourceFile ### Properties -* **code**: string (Required): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [ResizeError](#resizeerror)[]: Additional details about the error. -* **message**: string (Required): A message describing the error, intended to be suitable for display in a user interface. +* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. +* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. +* **fileMode**: 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. +* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). +* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. +* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. +* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. ## ScaleSettings ### Properties * **autoScale**: [AutoScaleSettings](#autoscalesettings): AutoScale settings for the pool. * **fixedScale**: [FixedScaleSettings](#fixedscalesettings): Fixed scale settings for the pool. -## AutoScaleSettings -### Properties -* **evaluationInterval**: string: If omitted, the default value is 15 minutes (PT15M). -* **formula**: string (Required): A formula for the desired number of compute nodes in the pool. - -## FixedScaleSettings -### Properties -* **nodeDeallocationOption**: 'Requeue' | 'RetainedData' | 'TaskCompletion' | 'Terminate': Determines what to do with a node and its running task(s) after it has been selected for deallocation. -* **resizeTimeout**: 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). -* **targetDedicatedNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. -* **targetLowPriorityNodes**: int: At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. - ## StartTask ### Properties * **commandLine**: string: 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. @@ -463,56 +454,65 @@ * **registry**: [ContainerRegistry](#containerregistry): A private container registry. * **workingDirectory**: 'ContainerImageDefault' | 'TaskWorkingDirectory': A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. -## EnvironmentSetting +## TaskSchedulingPolicy ### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string: The value of the environment variable. +* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. -## ResourceFile +## UserAccount ### Properties -* **autoStorageContainerName**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. -* **blobPrefix**: string: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. -* **fileMode**: 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. -* **filePath**: string: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). -* **httpUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. -* **identityReference**: [ComputeNodeIdentityReference](#computenodeidentityreference): The reference to a user assigned identity associated with the Batch pool which a compute node will use. -* **storageContainerUrl**: string: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. +* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. +* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. +* **name**: string (Required): The name of the user account. +* **password**: string (Required): The password for the user account. +* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. + +## UserAssignedIdentities +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## UserIdentity ### Properties * **autoUser**: [AutoUserSpecification](#autouserspecification): Specifies the parameters for the auto user that runs a task on the Batch service. * **userName**: string: The userName and autoUser properties are mutually exclusive; you must specify one but not both. -## AutoUserSpecification +## VirtualMachineConfiguration ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **scope**: 'Pool' | 'Task': The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. +* **containerConfiguration**: [ContainerConfiguration](#containerconfiguration): The configuration for container-enabled pools. +* **dataDisks**: [DataDisk](#datadisk)[]: This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. +* **diskEncryptionConfiguration**: [DiskEncryptionConfiguration](#diskencryptionconfiguration): The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. +* **extensions**: [VMExtension](#vmextension)[]: If specified, the extensions mentioned in this configuration will be installed on each node. +* **imageReference**: [ImageReference](#imagereference) (Required): A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. +* **licenseType**: 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: -## TaskSchedulingPolicy + Windows_Server - The on-premises license is for Windows Server. + Windows_Client - The on-premises license is for Windows Client. +* **nodeAgentSkuId**: string (Required): 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. +* **nodePlacementConfiguration**: [NodePlacementConfiguration](#nodeplacementconfiguration): Allocation configuration used by Batch Service to provision the nodes. +* **osDisk**: [OSDisk](#osdisk): Settings for the operating system disk of the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Windows operating system settings to apply to the virtual machine. + +## VirtualMachineFamilyCoreQuota ### Properties -* **nodeFillType**: 'Pack' | 'Spread' (Required): How tasks should be distributed across compute nodes. +* **coreQuota**: int (ReadOnly): The core quota for the VM family for the Batch account. +* **name**: string (ReadOnly): The Virtual Machine family name. -## UserAccount +## VMExtension ### Properties -* **elevationLevel**: 'Admin' | 'NonAdmin': The elevation level of the user. -* **linuxUserConfiguration**: [LinuxUserConfiguration](#linuxuserconfiguration): Properties used to create a user account on a Linux node. -* **name**: string (Required): The name of the user account. -* **password**: string (Required): The password for the user account. -* **windowsUserConfiguration**: [WindowsUserConfiguration](#windowsuserconfiguration): Properties used to create a user account on a Windows node. +* **autoUpgradeMinorVersion**: bool: 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. +* **name**: string (Required): The name of the virtual machine extension. +* **protectedSettings**: any: Any object +* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. +* **publisher**: string (Required): The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string (Required): The type of the extensions. +* **typeHandlerVersion**: string: The version of script handler. -## LinuxUserConfiguration +## WindowsConfiguration ### Properties -* **gid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. -* **sshPrivateKey**: 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). -* **uid**: int: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. +* **enableAutomaticUpdates**: bool: If omitted, the default value is true. ## WindowsUserConfiguration ### Properties * **loginMode**: 'Batch' | 'Interactive': Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. -## BatchAccountKeys -### Properties -* **accountName**: string (ReadOnly): The Batch account name. -* **primary**: string (ReadOnly): The primary key associated with the account. -* **secondary**: string (ReadOnly): The secondary key associated with the account. - diff --git a/generated/billing/log.out b/generated/billing/log.out index 6868813924..6991e1295b 100644 --- a/generated/billing/log.out +++ b/generated/billing/log.out @@ -5,20 +5,20 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.billing-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.billing-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CustomerListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json:3670:5 @@ -135,12 +135,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ReservationSkuProperty' with warning | PreCheck/SchemaMissingType | The schema 'ReservationProperty' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json:6494:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.billing-2018-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'EnrollmentAccountListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json:222:5 @@ -191,15 +191,15 @@ info | Processing batch task - {"tag":"microsoft.billing-2020-09-01-preview"} warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.billing-2020-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms @@ -207,7 +207,7 @@ info | Processing batch task - {"tag":"microsoft.billing-2019-10-01-preview"} warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CustomerListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json:5609:5 @@ -343,7 +343,7 @@ info | Processing batch task - {"tag":"microsoft.billing-2018-11-01-preview"} warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2018-11-01-preview/billing.json:4122:5 @@ -465,7 +465,7 @@ info | Processing batch task - {"tag":"microsoft.billing-2017-04-24-preview"} warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BillingPeriodsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json:349:5 @@ -486,12 +486,12 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json:549:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.billing-2017-02-27-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DownloadUrl' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2017-02-27-preview/billing.json:225:5 @@ -509,4 +509,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/billing/resource-manager/Microsoft.Billing/preview/2017-02-27-preview/billing.json:373:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 28.59s. 12 files generated. +info | Autorest completed in 28.09s. 12 files generated. diff --git a/generated/billing/microsoft.billing/2018-11-01-preview/types.md b/generated/billing/microsoft.billing/2018-11-01-preview/types.md index 95d0bc9088..666cc1b82d 100644 --- a/generated/billing/microsoft.billing/2018-11-01-preview/types.md +++ b/generated/billing/microsoft.billing/2018-11-01-preview/types.md @@ -36,18 +36,6 @@ * **properties**: [LineOfCreditProperties](#lineofcreditproperties): The properties of the line of credit. * **type**: 'Microsoft.Billing/billingAccounts/lineOfCredit' (ReadOnly, DeployTimeConstant): The resource type -## BillingProfileProperties -### Properties -* **address**: [Address](#address): Address details. -* **currency**: string (ReadOnly): The currency associated with the billing profile. -* **displayName**: string: The billing profile name. -* **enabledAzureSKUs**: [EnabledAzureSKUs](#enabledazureskus)[]: Information about the product. -* **invoiceDay**: int (ReadOnly): Invoice day. -* **invoiceEmailOptIn**: bool (ReadOnly): If the billing profile is opted in to receive invoices via email. -* **invoiceSections**: [InvoiceSection](#invoicesection)[]: The invoice sections associated to the billing profile. -* **isClassic**: bool (ReadOnly): Is OMS bootstrapped billing profile. -* **poNumber**: string: Purchase order number. - ## Address ### Properties * **addressLine1**: string: Address Line1. @@ -61,6 +49,30 @@ * **postalCode**: string: Address Postal Code. * **region**: string: Address Region. +## Amount +### Properties +* **currency**: string (ReadOnly): The currency for the amount value. +* **value**: int: Amount value. + +## BillingProfile +### Properties +* **id**: string (ReadOnly): Resource Id. +* **name**: string (ReadOnly): Resource name. +* **properties**: [BillingProfileProperties](#billingprofileproperties): The properties of the billing profile. +* **type**: string (ReadOnly): Resource type. + +## BillingProfileProperties +### Properties +* **address**: [Address](#address): Address details. +* **currency**: string (ReadOnly): The currency associated with the billing profile. +* **displayName**: string: The billing profile name. +* **enabledAzureSKUs**: [EnabledAzureSKUs](#enabledazureskus)[]: Information about the product. +* **invoiceDay**: int (ReadOnly): Invoice day. +* **invoiceEmailOptIn**: bool (ReadOnly): If the billing profile is opted in to receive invoices via email. +* **invoiceSections**: [InvoiceSection](#invoicesection)[]: The invoice sections associated to the billing profile. +* **isClassic**: bool (ReadOnly): Is OMS bootstrapped billing profile. +* **poNumber**: string: Purchase order number. + ## EnabledAzureSKUs ### Properties * **skuDescription**: string (ReadOnly): The sku description. @@ -78,19 +90,6 @@ * **billingProfiles**: [BillingProfile](#billingprofile)[]: The billing profiles associated to the billing account. * **displayName**: string: The name of the InvoiceSection. -## BillingProfile -### Properties -* **id**: string (ReadOnly): Resource Id. -* **name**: string (ReadOnly): Resource name. -* **properties**: [BillingProfileProperties](#billingprofileproperties): The properties of the billing profile. -* **type**: string (ReadOnly): Resource type. - -## PolicyProperties -### Properties -* **marketplacePurchasesAllowed**: bool: The marketplacePurchasesAllowed flag. -* **reservationPurchasesAllowed**: bool: The reservationPurchasesAllowed flag. -* **subscriptionOwnerCanViewCharges**: bool: The subscriptionOwnerCanViewCharges flag. - ## LineOfCreditProperties ### Properties * **creditLimit**: [Amount](#amount): The Amount. @@ -98,8 +97,9 @@ * **remainingBalance**: [Amount](#amount) (ReadOnly): The Amount. * **status**: 'Approved' | 'Rejected' | string: The line of credit status. -## Amount +## PolicyProperties ### Properties -* **currency**: string (ReadOnly): The currency for the amount value. -* **value**: int: Amount value. +* **marketplacePurchasesAllowed**: bool: The marketplacePurchasesAllowed flag. +* **reservationPurchasesAllowed**: bool: The reservationPurchasesAllowed flag. +* **subscriptionOwnerCanViewCharges**: bool: The subscriptionOwnerCanViewCharges flag. diff --git a/generated/billing/microsoft.billing/2019-10-01-preview/types.md b/generated/billing/microsoft.billing/2019-10-01-preview/types.md index b4e7a055be..c71a9d5075 100644 --- a/generated/billing/microsoft.billing/2019-10-01-preview/types.md +++ b/generated/billing/microsoft.billing/2019-10-01-preview/types.md @@ -118,38 +118,6 @@ * **statusReasonCode**: 'PastDue' | 'SpendingLimitExpired' | 'SpendingLimitReached' | string (ReadOnly): Reason for the specified billing profile status. * **targetClouds**: 'USGov' | 'USNat' | 'USSec' | string[] (ReadOnly): Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. -## IndirectRelationshipInfo -### Properties -* **billingAccountName**: string (ReadOnly): The billing account name of the partner or the customer for an indirect motion. -* **billingProfileName**: string (ReadOnly): The billing profile name of the partner or the customer for an indirect motion. -* **displayName**: string (ReadOnly): The display name of the partner or customer for an indirect motion. - -## InvoiceSection -### Properties -* **id**: string (ReadOnly): Resource Id. -* **name**: string (ReadOnly): Resource name. -* **properties**: [InvoiceSectionProperties](#invoicesectionproperties) (ReadOnly): The properties of an invoice section. -* **type**: string (ReadOnly): Resource type. - -## InvoiceSectionProperties -### Properties -* **displayName**: string (ReadOnly): The name of the invoice section. -* **state**: 'Active' | 'Restricted' | string (ReadOnly): Identifies the state of an invoice section. -* **targetCloud**: 'USGov' | 'USNat' | 'USSec' | string (ReadOnly): Possible cloud environments. - -## InstructionProperties -### Properties -* **amount**: int (Required): The amount budgeted for this billing instruction. -* **creationDate**: string: The date this billing instruction was created. -* **endDate**: string (Required): The date this billing instruction is no longer in effect. -* **startDate**: string (Required): The date this billing instruction goes into effect. - -## PolicyProperties -### Properties -* **marketplacePurchases**: 'AllAllowed' | 'NotAllowed' | 'OnlyFreeAllowed' | string: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. -* **reservationPurchases**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether Azure reservation purchases are allowed for a billing profile. -* **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. - ## BillingRoleAssignmentProperties ### Properties * **createdByPrincipalId**: string (ReadOnly): The principal Id of the user who created the role assignment. @@ -168,11 +136,37 @@ ### Properties * **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. +## IndirectRelationshipInfo +### Properties +* **billingAccountName**: string (ReadOnly): The billing account name of the partner or the customer for an indirect motion. +* **billingProfileName**: string (ReadOnly): The billing profile name of the partner or the customer for an indirect motion. +* **displayName**: string (ReadOnly): The display name of the partner or customer for an indirect motion. + +## InstructionProperties +### Properties +* **amount**: int (Required): The amount budgeted for this billing instruction. +* **creationDate**: string: The date this billing instruction was created. +* **endDate**: string (Required): The date this billing instruction is no longer in effect. +* **startDate**: string (Required): The date this billing instruction goes into effect. + +## InvoiceSection +### Properties +* **id**: string (ReadOnly): Resource Id. +* **name**: string (ReadOnly): Resource name. +* **properties**: [InvoiceSectionProperties](#invoicesectionproperties) (ReadOnly): The properties of an invoice section. +* **type**: string (ReadOnly): Resource type. + ## InvoiceSectionListWithCreateSubPermissionResult ### Properties * **nextLink**: string (ReadOnly): The link (url) to the next page of results. * **value**: [InvoiceSectionWithCreateSubPermission](#invoicesectionwithcreatesubpermission)[] (ReadOnly): The list of invoice section properties with create subscription permission. +## InvoiceSectionProperties +### Properties +* **displayName**: string (ReadOnly): The name of the invoice section. +* **state**: 'Active' | 'Restricted' | string (ReadOnly): Identifies the state of an invoice section. +* **targetCloud**: 'USGov' | 'USNat' | 'USSec' | string (ReadOnly): Possible cloud environments. + ## InvoiceSectionWithCreateSubPermission ### Properties * **billingProfileDisplayName**: string (ReadOnly): The name of the billing profile for the invoice section. @@ -184,3 +178,9 @@ * **invoiceSectionDisplayName**: string (ReadOnly): The name of the invoice section. * **invoiceSectionId**: string (ReadOnly): The ID of the invoice section. +## PolicyProperties +### Properties +* **marketplacePurchases**: 'AllAllowed' | 'NotAllowed' | 'OnlyFreeAllowed' | string: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. +* **reservationPurchases**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether Azure reservation purchases are allowed for a billing profile. +* **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. + diff --git a/generated/billing/microsoft.billing/2020-05-01/types.md b/generated/billing/microsoft.billing/2020-05-01/types.md index 8f8fc8c93a..5ee757a0ef 100644 --- a/generated/billing/microsoft.billing/2020-05-01/types.md +++ b/generated/billing/microsoft.billing/2020-05-01/types.md @@ -50,6 +50,28 @@ * **ApiVersion**: 2020-05-01 * **Output**: [InvoiceSectionListWithCreateSubPermissionResult](#invoicesectionlistwithcreatesubpermissionresult) +## AddressDetails +### Properties +* **addressLine1**: string (Required): Address line 1. +* **addressLine2**: string: Address line 2. +* **addressLine3**: string: Address line 3. +* **city**: string: Address city. +* **companyName**: string: Company name. +* **country**: string (Required): Country code uses ISO2, 2-digit format. +* **district**: string: Address district. +* **email**: string: Email address. +* **firstName**: string: First name. +* **lastName**: string: Last name. +* **middleName**: string: Middle name. +* **phoneNumber**: string: Phone number. +* **postalCode**: string: Postal code. +* **region**: string: Address region. + +## AzurePlan +### Properties +* **skuDescription**: string (ReadOnly): The sku description. +* **skuId**: string: The sku id. + ## BillingProfileProperties ### Properties * **billingRelationshipType**: 'CSPPartner' | 'Direct' | 'IndirectCustomer' | 'IndirectPartner' | string (ReadOnly): Identifies which services and purchases are paid by a billing profile. @@ -70,27 +92,14 @@ * **tags**: [BillingProfilePropertiesTags](#billingprofilepropertiestags): Tags of billing profiles. * **targetClouds**: 'USGov' | 'USNat' | 'USSec' | string[] (ReadOnly): Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. -## AddressDetails +## BillingProfilePropertiesTags ### Properties -* **addressLine1**: string (Required): Address line 1. -* **addressLine2**: string: Address line 2. -* **addressLine3**: string: Address line 3. -* **city**: string: Address city. -* **companyName**: string: Company name. -* **country**: string (Required): Country code uses ISO2, 2-digit format. -* **district**: string: Address district. -* **email**: string: Email address. -* **firstName**: string: First name. -* **lastName**: string: Last name. -* **middleName**: string: Middle name. -* **phoneNumber**: string: Phone number. -* **postalCode**: string: Postal code. -* **region**: string: Address region. +### Additional Properties +* **Additional Properties Type**: string -## AzurePlan +## CustomerPolicyProperties ### Properties -* **skuDescription**: string (ReadOnly): The sku description. -* **skuId**: string: The sku id. +* **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ## IndirectRelationshipInfo ### Properties @@ -98,10 +107,12 @@ * **billingProfileName**: string: The billing profile name of the partner or the customer for an indirect motion. * **displayName**: string: The display name of the partner or customer for an indirect motion. -## InvoiceSectionsOnExpand +## InstructionProperties ### Properties -* **hasMoreResults**: bool (ReadOnly): Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. -* **value**: [InvoiceSection](#invoicesection)[]: The invoice sections associated to the billing profile. +* **amount**: int (Required): The amount budgeted for this billing instruction. +* **creationDate**: string: The date this billing instruction was created. +* **endDate**: string (Required): The date this billing instruction is no longer in effect. +* **startDate**: string (Required): The date this billing instruction goes into effect. ## InvoiceSection ### Properties @@ -110,6 +121,11 @@ * **properties**: [InvoiceSectionProperties](#invoicesectionproperties): The properties of an invoice section. * **type**: string (ReadOnly): Resource type. +## InvoiceSectionListWithCreateSubPermissionResult +### Properties +* **nextLink**: string (ReadOnly): The link (url) to the next page of results. +* **value**: [InvoiceSectionWithCreateSubPermission](#invoicesectionwithcreatesubpermission)[] (ReadOnly): The list of invoice section properties with create subscription permission. + ## InvoiceSectionProperties ### Properties * **displayName**: string: The name of the invoice section. @@ -129,32 +145,10 @@ ### Additional Properties * **Additional Properties Type**: string -## BillingProfilePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstructionProperties -### Properties -* **amount**: int (Required): The amount budgeted for this billing instruction. -* **creationDate**: string: The date this billing instruction was created. -* **endDate**: string (Required): The date this billing instruction is no longer in effect. -* **startDate**: string (Required): The date this billing instruction goes into effect. - -## PolicyProperties -### Properties -* **marketplacePurchases**: 'AllAllowed' | 'NotAllowed' | 'OnlyFreeAllowed' | string: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. -* **reservationPurchases**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether Azure reservation purchases are allowed for a billing profile. -* **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. - -## CustomerPolicyProperties -### Properties -* **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. - -## InvoiceSectionListWithCreateSubPermissionResult +## InvoiceSectionsOnExpand ### Properties -* **nextLink**: string (ReadOnly): The link (url) to the next page of results. -* **value**: [InvoiceSectionWithCreateSubPermission](#invoicesectionwithcreatesubpermission)[] (ReadOnly): The list of invoice section properties with create subscription permission. +* **hasMoreResults**: bool (ReadOnly): Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. +* **value**: [InvoiceSection](#invoicesection)[]: The invoice sections associated to the billing profile. ## InvoiceSectionWithCreateSubPermission ### Properties @@ -169,3 +163,9 @@ * **invoiceSectionId**: string (ReadOnly): The ID of the invoice section. * **invoiceSectionSystemId**: string (ReadOnly): The system generated unique identifier for an invoice section. +## PolicyProperties +### Properties +* **marketplacePurchases**: 'AllAllowed' | 'NotAllowed' | 'OnlyFreeAllowed' | string: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. +* **reservationPurchases**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether Azure reservation purchases are allowed for a billing profile. +* **viewCharges**: 'Allowed' | 'NotAllowed' | string: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. + diff --git a/generated/billing/microsoft.billing/2021-10-01/types.md b/generated/billing/microsoft.billing/2021-10-01/types.md index eea2218c98..b1387db3b9 100644 --- a/generated/billing/microsoft.billing/2021-10-01/types.md +++ b/generated/billing/microsoft.billing/2021-10-01/types.md @@ -9,6 +9,11 @@ * **properties**: [BillingSubscriptionAliasProperties](#billingsubscriptionaliasproperties): Billing subscription alias properties. * **type**: 'Microsoft.Billing/billingAccounts/billingSubscriptionAliases' (ReadOnly, DeployTimeConstant): The resource type +## Amount +### Properties +* **currency**: string (ReadOnly): The currency for the amount value. +* **value**: int (ReadOnly): Amount value. + ## BillingSubscriptionAliasProperties ### Properties * **autoRenew**: 'Off' | 'On' | string: Indicates whether auto renewal is turned on or off for a subscription. @@ -59,11 +64,6 @@ * **enrollmentAccountStartDate**: string (ReadOnly): The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. * **subscriptionEnrollmentAccountStatus**: 'Active' | 'Cancelled' | 'Deleted' | 'Expired' | 'TransferredOut' | 'Transferring' | string (ReadOnly): The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. -## Amount -### Properties -* **currency**: string (ReadOnly): The currency for the amount value. -* **value**: int (ReadOnly): Amount value. - ## NextBillingCycleDetails ### Properties * **billingFrequency**: string (ReadOnly): The billing frequency of the subscription in the next billing cycle. diff --git a/generated/blockchain/log.out b/generated/blockchain/log.out index 7937b1fca6..e27de6fbe7 100644 --- a/generated/blockchain/log.out +++ b/generated/blockchain/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.blockchain-2018-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms -info | Autorest completed in 5.15s. 2 files generated. +info | autorest.bicep took 13ms +info | Autorest completed in 5.06s. 2 files generated. diff --git a/generated/blockchain/microsoft.blockchain/2018-06-01-preview/types.md b/generated/blockchain/microsoft.blockchain/2018-06-01-preview/types.md index 639c7405ef..ff2937e9ba 100644 --- a/generated/blockchain/microsoft.blockchain/2018-06-01-preview/types.md +++ b/generated/blockchain/microsoft.blockchain/2018-06-01-preview/types.md @@ -37,6 +37,23 @@ * **ApiVersion**: 2018-06-01-preview * **Output**: [ConsortiumCollection](#consortiumcollection) +## ApiKey +### Properties +* **keyName**: string (ReadOnly): Gets or sets the API key name. +* **value**: string (ReadOnly): Gets or sets the API key value. + +## ApiKeyCollection +### Properties +* **keys**: [ApiKey](#apikey)[] (ReadOnly): Gets or sets the collection of API key. + +## ApiKeyCollection +### Properties +* **keys**: [ApiKey](#apikey)[] (ReadOnly): Gets or sets the collection of API key. + +## BlockchainMemberNodesSku +### Properties +* **capacity**: int: Gets or sets the nodes capacity. + ## BlockchainMemberProperties ### Properties * **consortium**: string: Gets or sets the consortium for the blockchain member. @@ -54,16 +71,21 @@ * **userName**: string (ReadOnly): Gets the auth user name of the blockchain member. * **validatorNodesSku**: [BlockchainMemberNodesSku](#blockchainmembernodessku): Payload of the blockchain member nodes Sku for a blockchain member. +## Consortium +### Properties +* **name**: string (ReadOnly): Gets or sets the blockchain member name. +* **protocol**: 'Corda' | 'NotSpecified' | 'Parity' | 'Quorum' | string (ReadOnly): Gets or sets the blockchain protocol. + +## ConsortiumCollection +### Properties +* **value**: [Consortium](#consortium)[] (ReadOnly): Gets or sets the collection of consortiums. + ## FirewallRule ### Properties * **endIpAddress**: string: Gets or sets the end IP address of the firewall rule range. * **ruleName**: string: Gets or sets the name of the firewall rules. * **startIpAddress**: string: Gets or sets the start IP address of the firewall rule range. -## BlockchainMemberNodesSku -### Properties -* **capacity**: int: Gets or sets the nodes capacity. - ## Sku ### Properties * **name**: string: Gets or sets Sku name @@ -83,25 +105,3 @@ * **publicKey**: string (ReadOnly): Gets or sets the transaction node public key. * **userName**: string (ReadOnly): Gets or sets the transaction node dns endpoint basic auth user name. -## ApiKeyCollection -### Properties -* **keys**: [ApiKey](#apikey)[] (ReadOnly): Gets or sets the collection of API key. - -## ApiKey -### Properties -* **keyName**: string (ReadOnly): Gets or sets the API key name. -* **value**: string (ReadOnly): Gets or sets the API key value. - -## ApiKeyCollection -### Properties -* **keys**: [ApiKey](#apikey)[] (ReadOnly): Gets or sets the collection of API key. - -## ConsortiumCollection -### Properties -* **value**: [Consortium](#consortium)[] (ReadOnly): Gets or sets the collection of consortiums. - -## Consortium -### Properties -* **name**: string (ReadOnly): Gets or sets the blockchain member name. -* **protocol**: 'Corda' | 'NotSpecified' | 'Parity' | 'Quorum' | string (ReadOnly): Gets or sets the blockchain protocol. - diff --git a/generated/blueprint/log.out b/generated/blueprint/log.out index c19bbf1724..e669ed6c64 100644 --- a/generated/blueprint/log.out +++ b/generated/blueprint/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.blueprint-2017-11-11-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json:725:5 @@ -38,7 +38,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. info | Resource type microsoft.blueprint/blueprints/versions under path '/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}' has no body defined. -info | autorest.bicep took 14ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.blueprint-2018-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -46,7 +46,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json:860:5 @@ -69,5 +69,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms -info | Autorest completed in 8.31s. 4 files generated. +info | autorest.bicep took 8ms +info | Autorest completed in 8.24s. 4 files generated. diff --git a/generated/blueprint/microsoft.blueprint/2017-11-11-preview/types.md b/generated/blueprint/microsoft.blueprint/2017-11-11-preview/types.md index 345816b7da..196b20ba96 100644 --- a/generated/blueprint/microsoft.blueprint/2017-11-11-preview/types.md +++ b/generated/blueprint/microsoft.blueprint/2017-11-11-preview/types.md @@ -54,11 +54,9 @@ * **properties**: [PublishedBlueprintProperties](#publishedblueprintproperties) (ReadOnly): Schema for published Blueprint properties. * **type**: 'Microsoft.Blueprint/blueprints/versions' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity +## AssignmentLockSettings ### Properties -* **principalId**: string: Azure Active Directory principal ID associated with this Identity. -* **tenantId**: string: ID of the Azure Active Directory. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (Required): Type of the Managed Service Identity. +* **mode**: 'AllResources' | 'None' | string: Lock mode. ## AssignmentProperties ### Properties @@ -71,29 +69,6 @@ * **resourceGroups**: [ResourceGroupValueCollection](#resourcegroupvaluecollection) (Required): A dictionary which maps resource group placeholders to the resource groups which will be created. * **status**: [AssignmentStatus](#assignmentstatus) (ReadOnly): The status of Blueprint assignment. This field is readonly. -## AssignmentLockSettings -### Properties -* **mode**: 'AllResources' | 'None' | string: Lock mode. - -## ParameterValueCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterValueBase](#parametervaluebase) - -## ParameterValueBase -### Properties -* **description**: string: Optional property, just to establish ParameterValueBase as a BaseClass. - -## ResourceGroupValueCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ResourceGroupValue](#resourcegroupvalue) - -## ResourceGroupValue -### Properties -* **location**: string: Location of the resource group -* **name**: string: Name of the resource group - ## AssignmentStatus ### Properties * **lastModified**: string (ReadOnly): Last modified time of this blueprint. @@ -110,10 +85,16 @@ * **targetScope**: 'managementGroup' | 'subscription' | string: The scope where this Blueprint can be applied. * **versions**: any: Any object -## ParameterDefinitionCollection +## BlueprintStatus ### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) +* **lastModified**: string (ReadOnly): Last modified time of this blueprint. +* **timeCreated**: string (ReadOnly): Creation time of this blueprint. + +## ManagedServiceIdentity +### Properties +* **principalId**: string: Azure Active Directory principal ID associated with this Identity. +* **tenantId**: string: ID of the Azure Active Directory. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (Required): Type of the Managed Service Identity. ## ParameterDefinition ### Properties @@ -122,65 +103,49 @@ * **metadata**: [ParameterDefinitionMetadata](#parameterdefinitionmetadata): User-friendly properties for this parameter. * **type**: 'array' | 'bool' | 'int' | 'object' | 'secureObject' | 'secureString' | 'string' | string (Required): Allowed data types for Azure Resource Manager template parameters. -## ParameterDefinitionMetadata +## ParameterDefinitionCollection ### Properties -* **description**: string: Description of this parameter/resourceGroup. -* **displayName**: string: DisplayName of this parameter/resourceGroup. -* **strongType**: string: StrongType for UI to render rich experience during assignment time. +### Additional Properties +* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) -## ResourceGroupDefinitionCollection +## ParameterDefinitionCollection ### Properties ### Additional Properties -* **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) +* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) -## ResourceGroupDefinition +## ParameterDefinitionMetadata ### Properties -* **dependsOn**: string[]: Artifacts which need to be deployed before this resource group. -* **location**: string: Location of this resourceGroup, leave empty if the resource group location will be specified during the Blueprint assignment. -* **metadata**: [ParameterDefinitionMetadata](#parameterdefinitionmetadata): User-friendly properties for this parameter. -* **name**: string: Name of this resourceGroup, leave empty if the resource group name will be specified during the Blueprint assignment. +* **description**: string: Description of this parameter/resourceGroup. +* **displayName**: string: DisplayName of this parameter/resourceGroup. +* **strongType**: string: StrongType for UI to render rich experience during assignment time. -## BlueprintStatus +## ParameterValueBase ### Properties -* **lastModified**: string (ReadOnly): Last modified time of this blueprint. -* **timeCreated**: string (ReadOnly): Creation time of this blueprint. +* **description**: string: Optional property, just to establish ParameterValueBase as a BaseClass. -## PolicyAssignmentArtifactProperties +## ParameterValueCollection ### Properties -* **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. -* **description**: string: Multi-line explain this resource. -* **displayName**: string: One-liner string explain this resource. -* **parameters**: [ParameterValueCollection](#parametervaluecollection) (Required): A dictionary for parameters and their corresponding values. -* **policyDefinitionId**: string (Required): Azure resource ID of the policy definition. -* **resourceGroup**: string: Name of the resource group placeholder to which the policy will be assigned. +### Additional Properties +* **Additional Properties Type**: [ParameterValueBase](#parametervaluebase) ## ParameterValueCollection ### Properties ### Additional Properties * **Additional Properties Type**: [ParameterValueBase](#parametervaluebase) -## RoleAssignmentArtifactProperties +## ParameterValueCollection ### Properties -* **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. -* **description**: string: Multi-line explain this resource. -* **displayName**: string: One-liner string explain this resource. -* **principalIds**: any (Required): Anything -* **resourceGroup**: string: RoleAssignment will be scope to this resourceGroup, if left empty, it would scope to the subscription. -* **roleDefinitionId**: string (Required): Azure resource ID of the RoleDefinition. +### Additional Properties +* **Additional Properties Type**: [ParameterValueBase](#parametervaluebase) -## TemplateArtifactProperties +## PolicyAssignmentArtifactProperties ### Properties * **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. * **description**: string: Multi-line explain this resource. * **displayName**: string: One-liner string explain this resource. * **parameters**: [ParameterValueCollection](#parametervaluecollection) (Required): A dictionary for parameters and their corresponding values. -* **resourceGroup**: string: If applicable, the name of the resource group placeholder to which the template will be deployed. -* **template**: any (Required): Any object - -## ParameterValueCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterValueBase](#parametervaluebase) +* **policyDefinitionId**: string (Required): Azure resource ID of the policy definition. +* **resourceGroup**: string: Name of the resource group placeholder to which the policy will be assigned. ## PublishedBlueprintProperties ### Properties @@ -193,13 +158,48 @@ * **status**: [BlueprintStatus](#blueprintstatus) (ReadOnly): The status of the blueprint. This field is readonly. * **targetScope**: 'managementGroup' | 'subscription' | string (ReadOnly): The scope where this Blueprint can be applied. -## ParameterDefinitionCollection +## ResourceGroupDefinition +### Properties +* **dependsOn**: string[]: Artifacts which need to be deployed before this resource group. +* **location**: string: Location of this resourceGroup, leave empty if the resource group location will be specified during the Blueprint assignment. +* **metadata**: [ParameterDefinitionMetadata](#parameterdefinitionmetadata): User-friendly properties for this parameter. +* **name**: string: Name of this resourceGroup, leave empty if the resource group name will be specified during the Blueprint assignment. + +## ResourceGroupDefinitionCollection ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) +* **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) ## ResourceGroupDefinitionCollection ### Properties ### Additional Properties * **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) +## ResourceGroupValue +### Properties +* **location**: string: Location of the resource group +* **name**: string: Name of the resource group + +## ResourceGroupValueCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ResourceGroupValue](#resourcegroupvalue) + +## RoleAssignmentArtifactProperties +### Properties +* **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. +* **description**: string: Multi-line explain this resource. +* **displayName**: string: One-liner string explain this resource. +* **principalIds**: any (Required): Anything +* **resourceGroup**: string: RoleAssignment will be scope to this resourceGroup, if left empty, it would scope to the subscription. +* **roleDefinitionId**: string (Required): Azure resource ID of the RoleDefinition. + +## TemplateArtifactProperties +### Properties +* **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. +* **description**: string: Multi-line explain this resource. +* **displayName**: string: One-liner string explain this resource. +* **parameters**: [ParameterValueCollection](#parametervaluecollection) (Required): A dictionary for parameters and their corresponding values. +* **resourceGroup**: string: If applicable, the name of the resource group placeholder to which the template will be deployed. +* **template**: any (Required): Any object + diff --git a/generated/blueprint/microsoft.blueprint/2018-11-01-preview/types.md b/generated/blueprint/microsoft.blueprint/2018-11-01-preview/types.md index 0545852c68..935814cda8 100644 --- a/generated/blueprint/microsoft.blueprint/2018-11-01-preview/types.md +++ b/generated/blueprint/microsoft.blueprint/2018-11-01-preview/types.md @@ -54,22 +54,11 @@ * **properties**: [PublishedBlueprintProperties](#publishedblueprintproperties) (Required): Schema for published blueprint definition properties. * **type**: 'Microsoft.Blueprint/blueprints/versions' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string: Azure Active Directory principal ID associated with this Identity. -* **tenantId**: string: ID of the Azure Active Directory. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (Required): Type of the managed identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AssignmentLockSettings ### Properties -* **clientId**: string: Client App Id associated with this identity. -* **principalId**: string: Azure Active Directory principal ID associated with this Identity. +* **excludedActions**: string[]: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. +* **excludedPrincipals**: string[]: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. +* **mode**: 'AllResourcesDoNotDelete' | 'AllResourcesReadOnly' | 'None' | string: Lock mode. ## AssignmentProperties ### Properties @@ -83,42 +72,16 @@ * **scope**: string: The target subscription scope of the blueprint assignment (format: '/subscriptions/{subscriptionId}'). For management group level assignments, the property is required. * **status**: [AssignmentStatus](#assignmentstatus) (ReadOnly): The status of a blueprint assignment. This field is readonly. -## AssignmentLockSettings -### Properties -* **excludedActions**: string[]: List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. -* **excludedPrincipals**: string[]: List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. -* **mode**: 'AllResourcesDoNotDelete' | 'AllResourcesReadOnly' | 'None' | string: Lock mode. - ## AssignmentPropertiesParameters ### Properties ### Additional Properties * **Additional Properties Type**: [ParameterValue](#parametervalue) -## ParameterValue -### Properties -* **reference**: [SecretValueReference](#secretvaluereference): Reference to a Key Vault secret. -* **value**: any: Any object - -## SecretValueReference -### Properties -* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required): Specifies the link to a Key Vault. -* **secretName**: string (Required): Name of the secret. -* **secretVersion**: string: The version of the secret to use. If left blank, the latest version of the secret is used. - -## KeyVaultReference -### Properties -* **id**: string (Required): Azure resource ID of the Key Vault. - ## AssignmentPropertiesResourceGroups ### Properties ### Additional Properties * **Additional Properties Type**: [ResourceGroupValue](#resourcegroupvalue) -## ResourceGroupValue -### Properties -* **location**: string: Location of the resource group. -* **name**: string: Name of the resource group. - ## AssignmentStatus ### Properties * **lastModified**: string (ReadOnly): Last modified time of this blueprint definition. @@ -136,10 +99,26 @@ * **targetScope**: 'managementGroup' | 'subscription' | string: The scope where this blueprint definition can be assigned. * **versions**: any: Any object -## SharedBlueprintPropertiesParameters +## BlueprintStatus +### Properties +* **lastModified**: string (ReadOnly): Last modified time of this blueprint definition. +* **timeCreated**: string (ReadOnly): Creation time of this blueprint definition. + +## KeyVaultReference +### Properties +* **id**: string (Required): Azure resource ID of the Key Vault. + +## ManagedServiceIdentity +### Properties +* **principalId**: string: Azure Active Directory principal ID associated with this Identity. +* **tenantId**: string: ID of the Azure Active Directory. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (Required): Type of the managed identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ParameterDefinition ### Properties @@ -154,10 +133,35 @@ * **displayName**: string: DisplayName of this parameter/resourceGroup. * **strongType**: string: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location. -## SharedBlueprintPropertiesResourceGroups +## ParameterValue +### Properties +* **reference**: [SecretValueReference](#secretvaluereference): Reference to a Key Vault secret. +* **value**: any: Any object + +## PolicyAssignmentArtifactProperties +### Properties +* **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. +* **description**: string: Multi-line explain this resource. +* **displayName**: string: One-liner string explain this resource. +* **parameters**: [PolicyAssignmentArtifactPropertiesParameters](#policyassignmentartifactpropertiesparameters) (Required): Parameter values for the policy definition. +* **policyDefinitionId**: string (Required): Azure resource ID of the policy definition. +* **resourceGroup**: string: Name of the resource group placeholder to which the policy will be assigned. + +## PolicyAssignmentArtifactPropertiesParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) +* **Additional Properties Type**: [ParameterValue](#parametervalue) + +## PublishedBlueprintProperties +### Properties +* **blueprintName**: string: Name of the published blueprint definition. +* **changeNotes**: string: Version-specific change notes. +* **description**: string: Multi-line explain this resource. +* **displayName**: string: One-liner string explain this resource. +* **parameters**: [SharedBlueprintPropertiesParameters](#sharedblueprintpropertiesparameters): Parameters required by this blueprint definition. +* **resourceGroups**: [SharedBlueprintPropertiesResourceGroups](#sharedblueprintpropertiesresourcegroups): Resource group placeholders defined by this blueprint definition. +* **status**: [BlueprintStatus](#blueprintstatus) (ReadOnly): The status of the blueprint. This field is readonly. +* **targetScope**: 'managementGroup' | 'subscription' | string: The scope where this blueprint definition can be assigned. ## ResourceGroupDefinition ### Properties @@ -172,33 +176,45 @@ ### Additional Properties * **Additional Properties Type**: string -## BlueprintStatus +## ResourceGroupValue ### Properties -* **lastModified**: string (ReadOnly): Last modified time of this blueprint definition. -* **timeCreated**: string (ReadOnly): Creation time of this blueprint definition. +* **location**: string: Location of the resource group. +* **name**: string: Name of the resource group. -## PolicyAssignmentArtifactProperties +## RoleAssignmentArtifactProperties ### Properties * **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. * **description**: string: Multi-line explain this resource. * **displayName**: string: One-liner string explain this resource. -* **parameters**: [PolicyAssignmentArtifactPropertiesParameters](#policyassignmentartifactpropertiesparameters) (Required): Parameter values for the policy definition. -* **policyDefinitionId**: string (Required): Azure resource ID of the policy definition. -* **resourceGroup**: string: Name of the resource group placeholder to which the policy will be assigned. +* **principalIds**: any (Required): Anything +* **resourceGroup**: string: RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription. +* **roleDefinitionId**: string (Required): Azure resource ID of the RoleDefinition. -## PolicyAssignmentArtifactPropertiesParameters +## SecretValueReference +### Properties +* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required): Specifies the link to a Key Vault. +* **secretName**: string (Required): Name of the secret. +* **secretVersion**: string: The version of the secret to use. If left blank, the latest version of the secret is used. + +## SharedBlueprintPropertiesParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterValue](#parametervalue) +* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) -## RoleAssignmentArtifactProperties +## SharedBlueprintPropertiesParameters ### Properties -* **dependsOn**: string[]: Artifacts which need to be deployed before the specified artifact. -* **description**: string: Multi-line explain this resource. -* **displayName**: string: One-liner string explain this resource. -* **principalIds**: any (Required): Anything -* **resourceGroup**: string: RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription. -* **roleDefinitionId**: string (Required): Azure resource ID of the RoleDefinition. +### Additional Properties +* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) + +## SharedBlueprintPropertiesResourceGroups +### Properties +### Additional Properties +* **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) + +## SharedBlueprintPropertiesResourceGroups +### Properties +### Additional Properties +* **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) ## TemplateArtifactProperties ### Properties @@ -214,24 +230,8 @@ ### Additional Properties * **Additional Properties Type**: [ParameterValue](#parametervalue) -## PublishedBlueprintProperties -### Properties -* **blueprintName**: string: Name of the published blueprint definition. -* **changeNotes**: string: Version-specific change notes. -* **description**: string: Multi-line explain this resource. -* **displayName**: string: One-liner string explain this resource. -* **parameters**: [SharedBlueprintPropertiesParameters](#sharedblueprintpropertiesparameters): Parameters required by this blueprint definition. -* **resourceGroups**: [SharedBlueprintPropertiesResourceGroups](#sharedblueprintpropertiesresourcegroups): Resource group placeholders defined by this blueprint definition. -* **status**: [BlueprintStatus](#blueprintstatus) (ReadOnly): The status of the blueprint. This field is readonly. -* **targetScope**: 'managementGroup' | 'subscription' | string: The scope where this blueprint definition can be assigned. - -## SharedBlueprintPropertiesParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterDefinition](#parameterdefinition) - -## SharedBlueprintPropertiesResourceGroups +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [ResourceGroupDefinition](#resourcegroupdefinition) +* **clientId**: string: Client App Id associated with this identity. +* **principalId**: string: Azure Active Directory principal ID associated with this Identity. diff --git a/generated/botservice/log.out b/generated/botservice/log.out index 3594239e53..baeb28e2f8 100644 --- a/generated/botservice/log.out +++ b/generated/botservice/log.out @@ -18,7 +18,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.botservice-2021-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -36,7 +36,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json:1423:5 @@ -111,7 +111,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionList warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders': Unable to find type segments -info | autorest.bicep took 23ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.botservice-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -129,7 +129,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json:1147:5 @@ -195,7 +195,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorBody' with an undefined - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json:2667:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders': Unable to find type segments -info | autorest.bicep took 7ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.botservice-2020-06-02"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -213,7 +213,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json:1111:5 @@ -279,7 +279,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorBody' with an undefined - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json:2318:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders': Unable to find type segments -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.botservice-2018-07-12"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -297,7 +297,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/botservice.json:1307:5 @@ -379,7 +379,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json:1018:5 @@ -438,5 +438,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorBody' with an undefined warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | ? | Operation 'Bots/GetCheckNameAvailability' really should not have a media type (because there should be no body) warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders': Unable to find type segments -info | autorest.bicep took 14ms -info | Autorest completed in 16.48s. 10 files generated. +info | autorest.bicep took 16ms +info | Autorest completed in 15.9s. 10 files generated. diff --git a/generated/botservice/microsoft.botservice/2017-12-01/types.md b/generated/botservice/microsoft.botservice/2017-12-01/types.md index 9d0184f044..49c36ab125 100644 --- a/generated/botservice/microsoft.botservice/2017-12-01/types.md +++ b/generated/botservice/microsoft.botservice/2017-12-01/types.md @@ -52,6 +52,18 @@ * **ApiVersion**: 2017-12-01 * **Output**: [ConnectionSetting](#connectionsetting) +## BotChannel +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [Channel](#channel) (ReadOnly): Channel definition +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + ## BotProperties ### Properties * **configuredChannels**: string[] (ReadOnly): Collection of channels for which the bot is configured @@ -68,16 +80,6 @@ * **luisKey**: string: The LUIS Key * **msaAppId**: string (Required): Microsoft App Id for the bot -## Sku -### Properties -* **name**: 'F0' | 'S1' | string (Required): The name of SKU. -* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## Channel * **Discriminator**: channelName @@ -133,6 +135,33 @@ * **properties**: [WebChatChannelProperties](#webchatchannelproperties): The parameters to provide for the Web Chat channel. +## ConnectionSetting +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + +## ConnectionSettingParameter +### Properties +* **key**: string: Key for the Connection Setting Parameter. +* **value**: string: Value associated with the Connection Setting Parameter. + +## ConnectionSettingProperties +### Properties +* **clientId**: string: Client Id associated with the Connection Setting. +* **clientSecret**: string: Client Secret associated with the Connection Setting +* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting +* **scopes**: string: Scopes associated with the Connection Setting +* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting +* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting +* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. + ## DirectLineChannelProperties ### Properties * **sites**: [DirectLineSite](#directlinesite)[]: The list of Direct Line sites @@ -183,6 +212,36 @@ * **enableVideo**: bool: Enable video for Microsoft Teams channel * **isEnabled**: bool (Required): Whether this channel is enabled for the bot +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: 'F0' | 'S1' | string (Required): The name of SKU. +* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. + ## SkypeChannelProperties ### Properties * **callingWebHook**: string: Calling web hook for Skype channel @@ -235,62 +294,3 @@ * **siteId**: string (ReadOnly): Site Id * **siteName**: string (Required): Site name -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSettingProperties -### Properties -* **clientId**: string: Client Id associated with the Connection Setting. -* **clientSecret**: string: Client Secret associated with the Connection Setting -* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting -* **scopes**: string: Scopes associated with the Connection Setting -* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting -* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting -* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. - -## ConnectionSettingParameter -### Properties -* **key**: string: Key for the Connection Setting Parameter. -* **value**: string: Value associated with the Connection Setting Parameter. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BotChannel -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [Channel](#channel) (ReadOnly): Channel definition -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSetting -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/botservice/microsoft.botservice/2018-07-12/types.md b/generated/botservice/microsoft.botservice/2018-07-12/types.md index 323ae7013c..01235eff16 100644 --- a/generated/botservice/microsoft.botservice/2018-07-12/types.md +++ b/generated/botservice/microsoft.botservice/2018-07-12/types.md @@ -66,6 +66,18 @@ * **ApiVersion**: 2018-07-12 * **Output**: [ConnectionSetting](#connectionsetting) +## BotChannel +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [Channel](#channel) (ReadOnly): Channel definition +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + ## BotProperties ### Properties * **configuredChannels**: string[] (ReadOnly): Collection of channels for which the bot is configured @@ -82,16 +94,6 @@ * **luisKey**: string: The LUIS Key * **msaAppId**: string (Required): Microsoft App Id for the bot -## Sku -### Properties -* **name**: 'F0' | 'S1' | string (Required): The name of SKU. -* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## Channel * **Discriminator**: channelName @@ -147,6 +149,33 @@ * **properties**: [WebChatChannelProperties](#webchatchannelproperties): The parameters to provide for the Web Chat channel. +## ConnectionSetting +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + +## ConnectionSettingParameter +### Properties +* **key**: string: Key for the Connection Setting Parameter. +* **value**: string: Value associated with the Connection Setting Parameter. + +## ConnectionSettingProperties +### Properties +* **clientId**: string: Client Id associated with the Connection Setting. +* **clientSecret**: string: Client Secret associated with the Connection Setting +* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting +* **scopes**: string: Scopes associated with the Connection Setting +* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting +* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting +* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. + ## DirectLineChannelProperties ### Properties * **sites**: [DirectLineSite](#directlinesite)[]: The list of Direct Line sites @@ -169,6 +198,19 @@ * **isEnabled**: bool (Required): Whether this channel is enabled for the bot * **password**: string (Required): The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty. +## EnterpriseChannelNode +### Properties +* **azureLocation**: string (Required): The location of the Enterprise Channel Node. +* **azureSku**: string (Required): The sku of the Enterprise Channel Node. +* **id**: string (ReadOnly): Id of Enterprise Channel Node. This is generated by the Bot Framework. +* **name**: string (Required): The name of the Enterprise Channel Node. +* **state**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'StartFailed' | 'Started' | 'Starting' | 'StopFailed' | 'Stopped' | 'Stopping' | string: The current state of the Enterprise Channel Node. + +## EnterpriseChannelProperties +### Properties +* **nodes**: [EnterpriseChannelNode](#enterprisechannelnode)[] (Required): The nodes associated with the Enterprise Channel. +* **state**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'StartFailed' | 'Started' | 'Starting' | 'StopFailed' | 'Stopped' | 'Stopping' | string: The current state of the Enterprise Channel. + ## FacebookChannelProperties ### Properties * **appId**: string (Required): Facebook application id @@ -196,6 +238,41 @@ * **enableCalling**: bool: Enable calling for Microsoft Teams channel * **isEnabled**: bool (Required): Whether this channel is enabled for the bot +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: 'F0' | 'S1' | string (Required): The name of SKU. +* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. + ## SkypeChannelProperties ### Properties * **callingWebHook**: string: Calling web hook for Skype channel @@ -248,80 +325,3 @@ * **siteId**: string (ReadOnly): Site Id * **siteName**: string (Required): Site name -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSettingProperties -### Properties -* **clientId**: string: Client Id associated with the Connection Setting. -* **clientSecret**: string: Client Secret associated with the Connection Setting -* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting -* **scopes**: string: Scopes associated with the Connection Setting -* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting -* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting -* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. - -## ConnectionSettingParameter -### Properties -* **key**: string: Key for the Connection Setting Parameter. -* **value**: string: Value associated with the Connection Setting Parameter. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EnterpriseChannelProperties -### Properties -* **nodes**: [EnterpriseChannelNode](#enterprisechannelnode)[] (Required): The nodes associated with the Enterprise Channel. -* **state**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'StartFailed' | 'Started' | 'Starting' | 'StopFailed' | 'Stopped' | 'Stopping' | string: The current state of the Enterprise Channel. - -## EnterpriseChannelNode -### Properties -* **azureLocation**: string (Required): The location of the Enterprise Channel Node. -* **azureSku**: string (Required): The sku of the Enterprise Channel Node. -* **id**: string (ReadOnly): Id of Enterprise Channel Node. This is generated by the Bot Framework. -* **name**: string (Required): The name of the Enterprise Channel Node. -* **state**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'StartFailed' | 'Started' | 'Starting' | 'StopFailed' | 'Stopped' | 'Stopping' | string: The current state of the Enterprise Channel Node. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BotChannel -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [Channel](#channel) (ReadOnly): Channel definition -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSetting -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/botservice/microsoft.botservice/2020-06-02/types.md b/generated/botservice/microsoft.botservice/2020-06-02/types.md index de3e7488c7..9f79d33c17 100644 --- a/generated/botservice/microsoft.botservice/2020-06-02/types.md +++ b/generated/botservice/microsoft.botservice/2020-06-02/types.md @@ -52,6 +52,25 @@ * **ApiVersion**: 2020-06-02 * **Output**: [ConnectionSetting](#connectionsetting) +## AlexaChannelProperties +### Properties +* **alexaSkillId**: string (Required): The Alexa skill Id +* **isEnabled**: bool (Required): Whether this channel is enabled for the bot +* **serviceEndpointUri**: string (ReadOnly): Full Uri used to configured the skill in Alexa +* **urlFragment**: string (ReadOnly): Url fragment used in part of the Uri configured in Alexa + +## BotChannel +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [Channel](#channel) (ReadOnly): Channel definition +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + ## BotProperties ### Properties * **cmekKeyVaultUrl**: string: The CMK Url @@ -70,16 +89,6 @@ * **luisKey**: string: The LUIS Key * **msaAppId**: string (Required): Microsoft App Id for the bot -## Sku -### Properties -* **name**: 'F0' | 'S1' | string (Required): The name of SKU. -* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## Channel * **Discriminator**: channelName @@ -150,12 +159,32 @@ * **properties**: [WebChatChannelProperties](#webchatchannelproperties): The parameters to provide for the Web Chat channel. -## AlexaChannelProperties +## ConnectionSetting ### Properties -* **alexaSkillId**: string (Required): The Alexa skill Id -* **isEnabled**: bool (Required): Whether this channel is enabled for the bot -* **serviceEndpointUri**: string (ReadOnly): Full Uri used to configured the skill in Alexa -* **urlFragment**: string (ReadOnly): Url fragment used in part of the Uri configured in Alexa +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + +## ConnectionSettingParameter +### Properties +* **key**: string: Key for the Connection Setting Parameter. +* **value**: string: Value associated with the Connection Setting Parameter. + +## ConnectionSettingProperties +### Properties +* **clientId**: string: Client Id associated with the Connection Setting. +* **clientSecret**: string: Client Secret associated with the Connection Setting +* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting +* **scopes**: string: Scopes associated with the Connection Setting +* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting +* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting +* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. ## DirectLineChannelProperties ### Properties @@ -226,6 +255,36 @@ * **enableCalling**: bool: Enable calling for Microsoft Teams channel * **isEnabled**: bool (Required): Whether this channel is enabled for the bot +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: 'F0' | 'S1' | string (Required): The name of SKU. +* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. + ## SkypeChannelProperties ### Properties * **callingWebHook**: string: Calling web hook for Skype channel @@ -279,62 +338,3 @@ * **siteId**: string (ReadOnly): Site Id * **siteName**: string (Required): Site name -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSettingProperties -### Properties -* **clientId**: string: Client Id associated with the Connection Setting. -* **clientSecret**: string: Client Secret associated with the Connection Setting -* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting -* **scopes**: string: Scopes associated with the Connection Setting -* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting -* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting -* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. - -## ConnectionSettingParameter -### Properties -* **key**: string: Key for the Connection Setting Parameter. -* **value**: string: Value associated with the Connection Setting Parameter. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BotChannel -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [Channel](#channel) (ReadOnly): Channel definition -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSetting -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/botservice/microsoft.botservice/2021-03-01/types.md b/generated/botservice/microsoft.botservice/2021-03-01/types.md index 0a5f54fd61..2a00017260 100644 --- a/generated/botservice/microsoft.botservice/2021-03-01/types.md +++ b/generated/botservice/microsoft.botservice/2021-03-01/types.md @@ -55,6 +55,13 @@ * **ApiVersion**: 2021-03-01 * **Output**: [ConnectionSetting](#connectionsetting) +## AlexaChannelProperties +### Properties +* **alexaSkillId**: string (Required): The Alexa skill Id +* **isEnabled**: bool (Required): Whether this channel is enabled for the bot +* **serviceEndpointUri**: string (ReadOnly): Full Uri used to configured the skill in Alexa +* **urlFragment**: string (ReadOnly): Url fragment used in part of the Uri configured in Alexa + ## BotProperties ### Properties * **allSettings**: [BotPropertiesAllSettings](#botpropertiesallsettings): Contains resource all settings defined as key/value pairs. @@ -101,16 +108,6 @@ ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **name**: 'F0' | 'S1' | string (Required): The name of SKU. -* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## Channel * **Discriminator**: channelName @@ -184,12 +181,48 @@ * **properties**: [WebChatChannelProperties](#webchatchannelproperties): The parameters to provide for the Web Chat channel. -## AlexaChannelProperties +## ChannelSettings ### Properties -* **alexaSkillId**: string (Required): The Alexa skill Id -* **isEnabled**: bool (Required): Whether this channel is enabled for the bot -* **serviceEndpointUri**: string (ReadOnly): Full Uri used to configured the skill in Alexa -* **urlFragment**: string (ReadOnly): Url fragment used in part of the Uri configured in Alexa +* **botIconUrl**: string (ReadOnly): The bot icon url +* **botId**: string (ReadOnly): The bot id +* **channelDisplayName**: string (ReadOnly): The channel display name +* **channelId**: string (ReadOnly): The channel id +* **disableLocalAuth**: bool (ReadOnly): Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. +* **extensionKey1**: string (ReadOnly): The extensionKey1 +* **extensionKey2**: string (ReadOnly): The extensionKey2 +* **isEnabled**: bool (ReadOnly): Whether this channel is enabled for the bot +* **sites**: [Site](#site)[] (ReadOnly): The list of sites + +## ConnectionSetting +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. +* **zones**: string[] (ReadOnly): Entity zones + +## ConnectionSettingParameter +### Properties +* **key**: string: Key for the Connection Setting Parameter. +* **value**: string: Value associated with the Connection Setting Parameter. + +## ConnectionSettingProperties +### Properties +* **clientId**: string: Client Id associated with the Connection Setting. +* **clientSecret**: string: Client Secret associated with the Connection Setting +* **id**: string: Id associated with the Connection Setting. +* **name**: string: Name associated with the Connection Setting. +* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting +* **provisioningState**: string: Provisioning state of the resource +* **scopes**: string: Scopes associated with the Connection Setting +* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting +* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting +* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. ## DirectLineChannelProperties ### Properties @@ -257,6 +290,24 @@ * **channelSecret**: string: Secret for the line channel registration * **generatedId**: string (ReadOnly): Id generated for the line channel registration +## ListChannelWithKeysResponse +### Properties +* **changedTime**: string (ReadOnly): Changed time of the resource +* **entityTag**: string (ReadOnly): Entity tag of the resource +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [Channel](#channel) (ReadOnly): Channel definition +* **provisioningState**: string (ReadOnly): Provisioning state of the resource +* **resource**: [Channel](#channel) (ReadOnly): Channel definition +* **setting**: [ChannelSettings](#channelsettings) (ReadOnly): Channel settings definition +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. +* **zones**: string[] (ReadOnly): Entity zones + ## MsTeamsChannelProperties ### Properties * **acceptedTerms**: bool: Whether this channel accepted terms @@ -266,6 +317,52 @@ * **incomingCallRoute**: string: Webhook for Microsoft Teams channel calls * **isEnabled**: bool (Required): Whether this channel is enabled for the bot +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Site +### Properties +* **eTag**: string (ReadOnly): Entity Tag +* **isBlockUserUploadEnabled**: bool (ReadOnly): Whether this site is enabled for block user upload. +* **isEnabled**: bool (ReadOnly): Whether this site is enabled for DirectLine channel. +* **isSecureSiteEnabled**: bool (ReadOnly): Whether this site is enabled for authentication with Bot Framework. +* **isTokenEnabled**: bool (ReadOnly): Whether this site is token enabled for channel +* **isV1Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. +* **isV3Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. +* **isWebchatPreviewEnabled**: bool (ReadOnly): Whether this site is enabled for preview versions of Webchat +* **key**: string (ReadOnly): Primary key. Value only returned through POST to the action Channel List API, otherwise empty. +* **key2**: string (ReadOnly): Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. +* **siteId**: string (ReadOnly): Site Id +* **siteName**: string (ReadOnly): Site name +* **trustedOrigins**: string[] (ReadOnly): List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. + +## Sku +### Properties +* **name**: 'F0' | 'S1' | string (Required): The name of SKU. +* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. + ## SkypeChannelProperties ### Properties * **callingWebHook**: string: Calling web hook for Skype channel @@ -320,100 +417,3 @@ * **siteId**: string (ReadOnly): Site Id * **siteName**: string (Required): Site name -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSettingProperties -### Properties -* **clientId**: string: Client Id associated with the Connection Setting. -* **clientSecret**: string: Client Secret associated with the Connection Setting -* **id**: string: Id associated with the Connection Setting. -* **name**: string: Name associated with the Connection Setting. -* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting -* **provisioningState**: string: Provisioning state of the resource -* **scopes**: string: Scopes associated with the Connection Setting -* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting -* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting -* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. - -## ConnectionSettingParameter -### Properties -* **key**: string: Key for the Connection Setting Parameter. -* **value**: string: Value associated with the Connection Setting Parameter. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListChannelWithKeysResponse -### Properties -* **changedTime**: string (ReadOnly): Changed time of the resource -* **entityTag**: string (ReadOnly): Entity tag of the resource -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [Channel](#channel) (ReadOnly): Channel definition -* **provisioningState**: string (ReadOnly): Provisioning state of the resource -* **resource**: [Channel](#channel) (ReadOnly): Channel definition -* **setting**: [ChannelSettings](#channelsettings) (ReadOnly): Channel settings definition -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. -* **zones**: string[] (ReadOnly): Entity zones - -## ChannelSettings -### Properties -* **botIconUrl**: string (ReadOnly): The bot icon url -* **botId**: string (ReadOnly): The bot id -* **channelDisplayName**: string (ReadOnly): The channel display name -* **channelId**: string (ReadOnly): The channel id -* **disableLocalAuth**: bool (ReadOnly): Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. -* **extensionKey1**: string (ReadOnly): The extensionKey1 -* **extensionKey2**: string (ReadOnly): The extensionKey2 -* **isEnabled**: bool (ReadOnly): Whether this channel is enabled for the bot -* **sites**: [Site](#site)[] (ReadOnly): The list of sites - -## Site -### Properties -* **eTag**: string (ReadOnly): Entity Tag -* **isBlockUserUploadEnabled**: bool (ReadOnly): Whether this site is enabled for block user upload. -* **isEnabled**: bool (ReadOnly): Whether this site is enabled for DirectLine channel. -* **isSecureSiteEnabled**: bool (ReadOnly): Whether this site is enabled for authentication with Bot Framework. -* **isTokenEnabled**: bool (ReadOnly): Whether this site is token enabled for channel -* **isV1Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. -* **isV3Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. -* **isWebchatPreviewEnabled**: bool (ReadOnly): Whether this site is enabled for preview versions of Webchat -* **key**: string (ReadOnly): Primary key. Value only returned through POST to the action Channel List API, otherwise empty. -* **key2**: string (ReadOnly): Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. -* **siteId**: string (ReadOnly): Site Id -* **siteName**: string (ReadOnly): Site name -* **trustedOrigins**: string[] (ReadOnly): List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSetting -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. -* **zones**: string[] (ReadOnly): Entity zones - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/botservice/microsoft.botservice/2021-05-01-preview/types.md b/generated/botservice/microsoft.botservice/2021-05-01-preview/types.md index d92e576ee4..fc825d06b7 100644 --- a/generated/botservice/microsoft.botservice/2021-05-01-preview/types.md +++ b/generated/botservice/microsoft.botservice/2021-05-01-preview/types.md @@ -64,6 +64,13 @@ * **ApiVersion**: 2021-05-01-preview * **Output**: [ConnectionSetting](#connectionsetting) +## AlexaChannelProperties +### Properties +* **alexaSkillId**: string (Required): The Alexa skill Id +* **isEnabled**: bool (Required): Whether this channel is enabled for the bot +* **serviceEndpointUri**: string (ReadOnly): Full Uri used to configured the skill in Alexa +* **urlFragment**: string (ReadOnly): Url fragment used in part of the Uri configured in Alexa + ## BotProperties ### Properties * **allSettings**: [BotPropertiesAllSettings](#botpropertiesallsettings): Contains resource all settings defined as key/value pairs. @@ -111,39 +118,6 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## Sku -### Properties -* **name**: 'F0' | 'S1' | string (Required): The name of SKU. -* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## Channel * **Discriminator**: channelName @@ -217,12 +191,48 @@ * **properties**: [WebChatChannelProperties](#webchatchannelproperties): The parameters to provide for the Web Chat channel. -## AlexaChannelProperties +## ChannelSettings ### Properties -* **alexaSkillId**: string (Required): The Alexa skill Id -* **isEnabled**: bool (Required): Whether this channel is enabled for the bot -* **serviceEndpointUri**: string (ReadOnly): Full Uri used to configured the skill in Alexa -* **urlFragment**: string (ReadOnly): Url fragment used in part of the Uri configured in Alexa +* **botIconUrl**: string (ReadOnly): The bot icon url +* **botId**: string (ReadOnly): The bot id +* **channelDisplayName**: string (ReadOnly): The channel display name +* **channelId**: string (ReadOnly): The channel id +* **disableLocalAuth**: bool (ReadOnly): Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. +* **extensionKey1**: string (ReadOnly): The extensionKey1 +* **extensionKey2**: string (ReadOnly): The extensionKey2 +* **isEnabled**: bool (ReadOnly): Whether this channel is enabled for the bot +* **sites**: [Site](#site)[] (ReadOnly): The list of sites + +## ConnectionSetting +### Properties +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. +* **zones**: string[] (ReadOnly): Entity zones + +## ConnectionSettingParameter +### Properties +* **key**: string: Key for the Connection Setting Parameter. +* **value**: string: Value associated with the Connection Setting Parameter. + +## ConnectionSettingProperties +### Properties +* **clientId**: string: Client Id associated with the Connection Setting. +* **clientSecret**: string: Client Secret associated with the Connection Setting +* **id**: string: Id associated with the Connection Setting. +* **name**: string: Name associated with the Connection Setting. +* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting +* **provisioningState**: string: Provisioning state of the resource +* **scopes**: string: Scopes associated with the Connection Setting +* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting +* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting +* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. ## DirectLineChannelProperties ### Properties @@ -290,6 +300,24 @@ * **channelSecret**: string: Secret for the line channel registration * **generatedId**: string (ReadOnly): Id generated for the line channel registration +## ListChannelWithKeysResponse +### Properties +* **changedTime**: string (ReadOnly): Changed time of the resource +* **entityTag**: string (ReadOnly): Entity tag of the resource +* **etag**: string (ReadOnly): Entity Tag +* **id**: string (ReadOnly): Specifies the resource ID. +* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service +* **location**: string (ReadOnly): Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [Channel](#channel) (ReadOnly): Channel definition +* **provisioningState**: string (ReadOnly): Provisioning state of the resource +* **resource**: [Channel](#channel) (ReadOnly): Channel definition +* **setting**: [ChannelSettings](#channelsettings) (ReadOnly): Channel settings definition +* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. +* **zones**: string[] (ReadOnly): Entity zones + ## MsTeamsChannelProperties ### Properties * **acceptedTerms**: bool: Whether this channel accepted terms @@ -299,6 +327,75 @@ * **incomingCallRoute**: string: Webhook for Microsoft Teams channel calls * **isEnabled**: bool (Required): Whether this channel is enabled for the bot +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Site +### Properties +* **eTag**: string (ReadOnly): Entity Tag +* **isBlockUserUploadEnabled**: bool (ReadOnly): Whether this site is enabled for block user upload. +* **isEnabled**: bool (ReadOnly): Whether this site is enabled for DirectLine channel. +* **isSecureSiteEnabled**: bool (ReadOnly): Whether this site is enabled for authentication with Bot Framework. +* **isTokenEnabled**: bool (ReadOnly): Whether this site is token enabled for channel +* **isV1Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. +* **isV3Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. +* **isWebchatPreviewEnabled**: bool (ReadOnly): Whether this site is enabled for preview versions of Webchat +* **key**: string (ReadOnly): Primary key. Value only returned through POST to the action Channel List API, otherwise empty. +* **key2**: string (ReadOnly): Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. +* **siteId**: string (ReadOnly): Site Id +* **siteName**: string (ReadOnly): Site name +* **trustedOrigins**: string[] (ReadOnly): List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. + +## Sku +### Properties +* **name**: 'F0' | 'S1' | string (Required): The name of SKU. +* **tier**: 'Free' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. + ## SkypeChannelProperties ### Properties * **callingWebHook**: string: Calling web hook for Skype channel @@ -354,100 +451,3 @@ * **siteId**: string (ReadOnly): Site Id * **siteName**: string (Required): Site name -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSettingProperties -### Properties -* **clientId**: string: Client Id associated with the Connection Setting. -* **clientSecret**: string: Client Secret associated with the Connection Setting -* **id**: string: Id associated with the Connection Setting. -* **name**: string: Name associated with the Connection Setting. -* **parameters**: [ConnectionSettingParameter](#connectionsettingparameter)[]: Service Provider Parameters associated with the Connection Setting -* **provisioningState**: string: Provisioning state of the resource -* **scopes**: string: Scopes associated with the Connection Setting -* **serviceProviderDisplayName**: string: Service Provider Display Name associated with the Connection Setting -* **serviceProviderId**: string: Service Provider Id associated with the Connection Setting -* **settingId**: string (ReadOnly): Setting Id set by the service for the Connection Setting. - -## ConnectionSettingParameter -### Properties -* **key**: string: Key for the Connection Setting Parameter. -* **value**: string: Value associated with the Connection Setting Parameter. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListChannelWithKeysResponse -### Properties -* **changedTime**: string (ReadOnly): Changed time of the resource -* **entityTag**: string (ReadOnly): Entity tag of the resource -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [Channel](#channel) (ReadOnly): Channel definition -* **provisioningState**: string (ReadOnly): Provisioning state of the resource -* **resource**: [Channel](#channel) (ReadOnly): Channel definition -* **setting**: [ChannelSettings](#channelsettings) (ReadOnly): Channel settings definition -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. -* **zones**: string[] (ReadOnly): Entity zones - -## ChannelSettings -### Properties -* **botIconUrl**: string (ReadOnly): The bot icon url -* **botId**: string (ReadOnly): The bot id -* **channelDisplayName**: string (ReadOnly): The channel display name -* **channelId**: string (ReadOnly): The channel id -* **disableLocalAuth**: bool (ReadOnly): Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. -* **extensionKey1**: string (ReadOnly): The extensionKey1 -* **extensionKey2**: string (ReadOnly): The extensionKey2 -* **isEnabled**: bool (ReadOnly): Whether this channel is enabled for the bot -* **sites**: [Site](#site)[] (ReadOnly): The list of sites - -## Site -### Properties -* **eTag**: string (ReadOnly): Entity Tag -* **isBlockUserUploadEnabled**: bool (ReadOnly): Whether this site is enabled for block user upload. -* **isEnabled**: bool (ReadOnly): Whether this site is enabled for DirectLine channel. -* **isSecureSiteEnabled**: bool (ReadOnly): Whether this site is enabled for authentication with Bot Framework. -* **isTokenEnabled**: bool (ReadOnly): Whether this site is token enabled for channel -* **isV1Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. -* **isV3Enabled**: bool (ReadOnly): Whether this site is enabled for Bot Framework V1 protocol. -* **isWebchatPreviewEnabled**: bool (ReadOnly): Whether this site is enabled for preview versions of Webchat -* **key**: string (ReadOnly): Primary key. Value only returned through POST to the action Channel List API, otherwise empty. -* **key2**: string (ReadOnly): Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. -* **siteId**: string (ReadOnly): Site Id -* **siteName**: string (ReadOnly): Site name -* **trustedOrigins**: string[] (ReadOnly): List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionSetting -### Properties -* **etag**: string (ReadOnly): Entity Tag -* **id**: string (ReadOnly): Specifies the resource ID. -* **kind**: 'azurebot' | 'bot' | 'designer' | 'function' | 'sdk' | string (ReadOnly): Indicates the type of bot service -* **location**: string (ReadOnly): Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [ConnectionSettingProperties](#connectionsettingproperties) (ReadOnly): Properties for a Connection Setting Item -* **sku**: [Sku](#sku) (ReadOnly): The SKU of the cognitive services account. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. -* **zones**: string[] (ReadOnly): Entity zones - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/cdn/log.out b/generated/cdn/log.out index 7255c40825..0ce36689a6 100644 --- a/generated/cdn/log.out +++ b/generated/cdn/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.cdn-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/afdx.json:3978:5 @@ -280,11 +280,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'DeliveryRuleAction' - x-ms-enum: => {"name":"DeliveryRuleAction","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DeliveryRuleAction' -> 'DeliveryRuleActionAutoGenerated' info | Resource type microsoft.cdn/profiles/rulesets under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}' has no body defined. -info | autorest.bicep took 33ms +info | autorest.bicep took 38ms info | Processing batch task - {"tag":"microsoft.cdn-2020-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-09-01/cdn.json:2460:5 @@ -556,11 +556,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'DeliveryRuleAction' - x-ms-enum: => {"name":"DeliveryRuleAction","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DeliveryRuleAction' -> 'DeliveryRuleActionAutoGenerated' info | Resource type microsoft.cdn/profiles/rulesets under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}' has no body defined. -info | autorest.bicep took 42ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.cdn-2020-04-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json:2460:5 @@ -753,11 +753,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'DeliveryRuleAction' - enum: => ["CacheExpiration","CacheKeyQueryString","ModifyRequestHeader","ModifyResponseHeader","UrlRedirect","UrlRewrite","UrlSigning"] - x-ms-enum: => {"name":"DeliveryRuleAction","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DeliveryRuleAction' -> 'DeliveryRuleActionAutoGenerated' -info | autorest.bicep took 14ms +info | autorest.bicep took 18ms info | Processing batch task - {"tag":"microsoft.cdn-2019-12-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json:2460:5 @@ -914,11 +914,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'DeliveryRuleAction' - enum: => ["CacheExpiration","CacheKeyQueryString","ModifyRequestHeader","ModifyResponseHeader","UrlRedirect","UrlRewrite","OriginGroupOverride"] - x-ms-enum: => {"name":"DeliveryRuleAction","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DeliveryRuleAction' -> 'DeliveryRuleActionAutoGenerated' -info | autorest.bicep took 12ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.cdn-2019-06-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json:1992:5 @@ -1093,7 +1093,7 @@ info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.cdn-2019-06-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/preview/2019-06-15-preview/cdn.json:1990:5 @@ -1264,11 +1264,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'DeliveryRuleAction' - enum: => ["CacheExpiration","CacheKeyQueryString","ModifyRequestHeader","ModifyResponseHeader","UrlRedirect","UrlRewrite"] - x-ms-enum: => {"name":"DeliveryRuleAction","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DeliveryRuleAction' -> 'DeliveryRuleActionAutoGenerated' -info | autorest.bicep took 22ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.cdn-2019-04-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json:1992:5 @@ -1409,11 +1409,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'DeliveryRuleAction' - enum: => ["CacheExpiration","CacheKeyQueryString","ModifyRequestHeader","ModifyResponseHeader","UrlRedirect","UrlRewrite"] - x-ms-enum: => {"name":"DeliveryRuleAction","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DeliveryRuleAction' -> 'DeliveryRuleActionAutoGenerated' -info | autorest.bicep took 8ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.cdn-2017-10-12"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json:1990:5 @@ -1480,11 +1480,11 @@ warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an unde warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json:3300:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.cdn-2017-04-02"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json:1933:5 @@ -1525,11 +1525,11 @@ warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an unde warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json:2861:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.cdn-2016-10-02"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json:1705:5 @@ -1566,11 +1566,11 @@ warning | PreCheck/SchemaMissingType | The schema 'EdgeNodeProperties' with an u warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json:2504:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.cdn-2016-04-02"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-04-02/cdn.json:1677:5 @@ -1603,11 +1603,11 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-04-02/cdn.json:2365:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.cdn-2015-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2015-06-01/cdn.json:1673:5 @@ -1643,4 +1643,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cdn/resource-manager/Microsoft.Cdn/stable/2015-06-01/cdn.json:2375:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 55.87s. 24 files generated. +info | Autorest completed in 55.58s. 24 files generated. diff --git a/generated/cdn/microsoft.cdn/2015-06-01/types.md b/generated/cdn/microsoft.cdn/2015-06-01/types.md index f1bc58fb0a..5208627ef8 100644 --- a/generated/cdn/microsoft.cdn/2015-06-01/types.md +++ b/generated/cdn/microsoft.cdn/2015-06-01/types.md @@ -40,17 +40,24 @@ * **properties**: [OriginPropertiesParameters](#originpropertiesparameters) * **type**: 'Microsoft.Cdn/profiles/endpoints/origins' (ReadOnly, DeployTimeConstant): The resource type -## ProfilePropertiesCreateParameters +## CustomDomainPropertiesParameters ### Properties +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. * **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' (ReadOnly): Resource status of the profile. -* **sku**: [Sku](#sku) (Required): The SKU (pricing tier) of the CDN profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the custom domain. -## Sku +## DeepCreatedOrigin ### Properties -* **name**: 'Premium' | 'Standard': Name of the pricing tier +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of deep created origin on a CDN endpoint. -## ProfileCreateParametersTags +## DeepCreatedOriginProperties +### Properties +* **hostName**: string (Required): The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 + +## EndpointCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -69,33 +76,26 @@ * **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines the query string caching behavior. * **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): Resource status of the endpoint. -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of deep created origin on a CDN endpoint. - -## DeepCreatedOriginProperties +## OriginPropertiesParameters ### Properties * **hostName**: string (Required): The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the origin. -## EndpointCreateParametersTags +## ProfileCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CustomDomainPropertiesParameters +## ProfilePropertiesCreateParameters ### Properties -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. * **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' (ReadOnly): Resource status of the profile. +* **sku**: [Sku](#sku) (Required): The SKU (pricing tier) of the CDN profile. -## OriginPropertiesParameters +## Sku ### Properties -* **hostName**: string (Required): The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the origin. +* **name**: 'Premium' | 'Standard': Name of the pricing tier diff --git a/generated/cdn/microsoft.cdn/2016-04-02/types.md b/generated/cdn/microsoft.cdn/2016-04-02/types.md index 21950130c3..33f254fa5a 100644 --- a/generated/cdn/microsoft.cdn/2016-04-02/types.md +++ b/generated/cdn/microsoft.cdn/2016-04-02/types.md @@ -41,16 +41,24 @@ * **properties**: [OriginPropertiesParameters](#originpropertiesparameters) * **type**: 'Microsoft.Cdn/profiles/endpoints/origins' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties +## CustomDomainPropertiesParameters ### Properties +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. * **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' (ReadOnly): Resource status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the custom domain. -## Sku +## DeepCreatedOrigin ### Properties -* **name**: 'Custom_Verizon' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_Verizon': Name of the pricing tier +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of deep created origin on a CDN endpoint. -## ProfileCreateParametersTags +## DeepCreatedOriginProperties +### Properties +* **hostName**: string (Required): The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 + +## EndpointCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -69,33 +77,25 @@ * **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines the query string caching behavior. * **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): Resource status of the endpoint. -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of deep created origin on a CDN endpoint. - -## DeepCreatedOriginProperties +## OriginPropertiesParameters ### Properties * **hostName**: string (Required): The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the origin. -## EndpointCreateParametersTags +## ProfileCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CustomDomainPropertiesParameters +## ProfileProperties ### Properties -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. * **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' (ReadOnly): Resource status of the profile. -## OriginPropertiesParameters +## Sku ### Properties -* **hostName**: string (Required): The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning status of the resource. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' (ReadOnly): Resource status of the origin. +* **name**: 'Custom_Verizon' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_Verizon': Name of the pricing tier diff --git a/generated/cdn/microsoft.cdn/2016-10-02/types.md b/generated/cdn/microsoft.cdn/2016-10-02/types.md index e87ee3681c..5a5eb78143 100644 --- a/generated/cdn/microsoft.cdn/2016-10-02/types.md +++ b/generated/cdn/microsoft.cdn/2016-10-02/types.md @@ -34,19 +34,24 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags. * **type**: 'Microsoft.Cdn/profiles/endpoints/customDomains' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties +## CustomDomainPropertiesParameters ### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning state of Custom Https of the custom domain. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## Sku +## DeepCreatedOrigin ### Properties -* **name**: 'Custom_Verizon' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Verizon' | string: Name of the pricing tier. +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of origin Properties of the origin created on the CDN endpoint. -## ResourceTags +## DeepCreatedOriginProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hostName**: string (Required): The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 ## EndpointProperties ### Properties @@ -70,32 +75,27 @@ * **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. * **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of origin Properties of the origin created on the CDN endpoint. - -## DeepCreatedOriginProperties +## ProfileProperties ### Properties -* **hostName**: string (Required): The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CustomDomainPropertiesParameters +## ResourceTags ### Properties -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning state of Custom Https of the custom domain. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Verizon' | string: Name of the pricing tier. + diff --git a/generated/cdn/microsoft.cdn/2017-04-02/types.md b/generated/cdn/microsoft.cdn/2017-04-02/types.md index c381502c27..88dc02764a 100644 --- a/generated/cdn/microsoft.cdn/2017-04-02/types.md +++ b/generated/cdn/microsoft.cdn/2017-04-02/types.md @@ -32,19 +32,25 @@ * **properties**: [CustomDomainPropertiesParameters](#customdomainpropertiesparameters): The JSON object that contains the properties of the custom domain to create. * **type**: 'Microsoft.Cdn/profiles/endpoints/customDomains' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties +## CustomDomainPropertiesParameters ### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## Sku +## DeepCreatedOrigin ### Properties -* **name**: 'Custom_Verizon' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Verizon' | string: Name of the pricing tier. +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. -## TrackedResourceTags +## DeepCreatedOriginProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 ## EndpointProperties ### Properties @@ -69,28 +75,22 @@ * **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. * **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) -## DeepCreatedOrigin +## ProfileProperties ### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. -## DeepCreatedOriginProperties +## Sku ### Properties -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 +* **name**: 'Custom_Verizon' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Verizon' | string: Name of the pricing tier. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CustomDomainPropertiesParameters +## TrackedResourceTags ### Properties -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/cdn/microsoft.cdn/2017-10-12/types.md b/generated/cdn/microsoft.cdn/2017-10-12/types.md index 2249c4786a..dd6faf04a4 100644 --- a/generated/cdn/microsoft.cdn/2017-10-12/types.md +++ b/generated/cdn/microsoft.cdn/2017-10-12/types.md @@ -32,42 +32,32 @@ * **properties**: [CustomDomainPropertiesParameters](#customdomainpropertiesparameters): The JSON object that contains the properties of the custom domain to create. * **type**: 'Microsoft.Cdn/profiles/endpoints/customDomains' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. - -## Sku +## CacheExpirationActionParameters ### Properties -* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. +* **@odata.type**: 'Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests that include query strings. +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## TrackedResourceTags +## CustomDomainPropertiesParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## EndpointProperties +## DeepCreatedOrigin ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## DeepCreatedOriginProperties ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 ## DeliveryRule ### Properties @@ -85,13 +75,6 @@ * **parameters**: [CacheExpirationActionParameters](#cacheexpirationactionparameters) (Required): Defines the parameters for the cache expiration action. -## CacheExpirationActionParameters -### Properties -* **@odata.type**: 'Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests that include query strings. -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - ## DeliveryRuleCondition * **Discriminator**: name @@ -107,16 +90,28 @@ * **parameters**: [UrlPathConditionParameters](#urlpathconditionparameters) (Required): Defines the parameters for the URL path condition. -## UrlFileExtensionConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: 'Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionConditionParameters' | string (Required) -* **extensions**: string[] (Required): A list of extensions for the condition of the delivery rule. +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. -## UrlPathConditionParameters +## EndpointPropertiesUpdateParametersDeliveryPolicy ### Properties -* **@odata.type**: 'Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathConditionParameters' | string (Required) -* **matchType**: 'Literal' | 'Wildcard' | string (Required): The match type for the condition of the delivery rule -* **path**: string (Required): A URL path for the condition of the delivery rule +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. ## GeoFilter ### Properties @@ -124,28 +119,33 @@ * **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. * **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) -## DeepCreatedOrigin +## ProfileProperties ### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. -## DeepCreatedOriginProperties +## Sku ### Properties -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 +* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CustomDomainPropertiesParameters +## TrackedResourceTags ### Properties -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. +### Additional Properties +* **Additional Properties Type**: string + +## UrlFileExtensionConditionParameters +### Properties +* **@odata.type**: 'Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionConditionParameters' | string (Required) +* **extensions**: string[] (Required): A list of extensions for the condition of the delivery rule. + +## UrlPathConditionParameters +### Properties +* **@odata.type**: 'Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathConditionParameters' | string (Required) +* **matchType**: 'Literal' | 'Wildcard' | string (Required): The match type for the condition of the delivery rule +* **path**: string (Required): A URL path for the condition of the delivery rule diff --git a/generated/cdn/microsoft.cdn/2019-04-15/types.md b/generated/cdn/microsoft.cdn/2019-04-15/types.md index df84011239..24472a4f2f 100644 --- a/generated/cdn/microsoft.cdn/2019-04-15/types.md +++ b/generated/cdn/microsoft.cdn/2019-04-15/types.md @@ -32,42 +32,70 @@ * **properties**: [CustomDomainPropertiesParameters](#customdomainpropertiesparameters): The JSON object that contains the properties of the custom domain to create. * **type**: 'Microsoft.Cdn/profiles/endpoints/customDomains' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties +## CacheExpirationActionParameters ### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## Sku +## CacheKeyQueryStringActionParameters ### Properties -* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -## TrackedResourceTags +## CdnCertificateSourceParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) +* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used -## EndpointProperties +## CookiesMatchConditionParameters ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched +* **selector**: string: Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## EndpointPropertiesUpdateParametersDeliveryPolicy +## CustomDomainHttpsParameters +* **Discriminator**: certificateSource + +### Base Properties +* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https +* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. +### UserManagedHttpsParameters +#### Properties +* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. + +### CdnManagedHttpsParameters +#### Properties +* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. + + +## CustomDomainPropertiesParameters ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. + +## DeepCreatedOrigin +### Properties +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. + +## DeepCreatedOriginProperties +### Properties +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 ## DeliveryRule ### Properties @@ -111,43 +139,6 @@ * **parameters**: [UrlRewriteActionParameters](#urlrewriteactionparameters) (Required): Defines the parameters for the url rewrite action. -## CacheExpirationActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - -## CacheKeyQueryStringActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests - -## HeaderActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **value**: string: Value for the specified action - -## UrlRedirectActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. - -## UrlRewriteActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) -* **destination**: string (Required): Define the destination path for be used in the rewrite. This will overwrite the source pattern -* **preserveUnmatchedPath**: bool: If True, the remaining path after the source pattern will be appended to the new destination path. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use "/" as the source pattern value. To match only the root directory and re-write this path, use the origin path field - ## DeliveryRuleCondition * **Discriminator**: name @@ -223,14 +214,41 @@ * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## CookiesMatchConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched -* **selector**: string: Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. + +## EndpointPropertiesUpdateParametersDeliveryPolicy +### Properties +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. + +## GeoFilter +### Properties +* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. +* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. +* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +## HeaderActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **value**: string: Value for the specified action ## HttpVersionMatchConditionParameters ### Properties @@ -247,6 +265,17 @@ * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## KeyVaultCertificateSourceParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) +* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate +* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate + ## PostArgsMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) @@ -256,6 +285,11 @@ * **selector**: string: Name of PostArg to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## ProfileProperties +### Properties +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. + ## QueryStringMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) @@ -311,6 +345,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UrlFileExtensionMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) @@ -335,68 +383,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Wildcard' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## GeoFilter -### Properties -* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. -* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. -* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) - -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. - -## DeepCreatedOriginProperties -### Properties -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CustomDomainPropertiesParameters -### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - -## CustomDomainHttpsParameters -* **Discriminator**: certificateSource - -### Base Properties -* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https -* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. -### UserManagedHttpsParameters -#### Properties -* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. - -### CdnManagedHttpsParameters -#### Properties -* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. - - -## KeyVaultCertificateSourceParameters +## UrlRedirectActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) -* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate -* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. -## CdnCertificateSourceParameters +## UrlRewriteActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) -* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) +* **destination**: string (Required): Define the destination path for be used in the rewrite. This will overwrite the source pattern +* **preserveUnmatchedPath**: bool: If True, the remaining path after the source pattern will be appended to the new destination path. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use "/" as the source pattern value. To match only the root directory and re-write this path, use the origin path field diff --git a/generated/cdn/microsoft.cdn/2019-06-15-preview/types.md b/generated/cdn/microsoft.cdn/2019-06-15-preview/types.md index 39a6541567..51a612e306 100644 --- a/generated/cdn/microsoft.cdn/2019-06-15-preview/types.md +++ b/generated/cdn/microsoft.cdn/2019-06-15-preview/types.md @@ -45,127 +45,96 @@ * **properties**: [CustomDomainPropertiesParameters](#customdomainpropertiesparameters): The JSON object that contains the properties of the custom domain to create. * **type**: 'Microsoft.Cdn/profiles/endpoints/customDomains' (ReadOnly, DeployTimeConstant): The resource type -## CdnWebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList +## CacheExpirationActionParameters ### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## CustomRule +## CacheKeyQueryStringActionParameters ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -## MatchCondition +## CdnCertificateSourceParameters ### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) +* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used ## CdnEndpoint ### Properties * **id**: string: ARM Resource ID string. -## ManagedRuleSetList +## CdnWebApplicationFirewallPolicyProperties ### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -## ManagedRuleSet +## CookiesMatchConditionParameters ### Properties -* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) +* **matchValues**: string[] (Required): The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched +* **selector**: string (Required): Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms -## ManagedRuleGroupOverride -### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +## CustomDomainHttpsParameters +* **Discriminator**: certificateSource -## ManagedRuleOverride -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. -* **ruleId**: string (Required): Identifier for the managed rule. +### Base Properties +* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https +* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. +### UserManagedHttpsParameters +#### Properties +* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. -## PolicySettings -### Properties -* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. -* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. -* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. -* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +### CdnManagedHttpsParameters +#### Properties +* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. -## RateLimitRuleList + +## CustomDomainPropertiesParameters ### Properties -* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## RateLimitRule +## CustomRule ### Properties * **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. * **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. * **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. * **name**: string (Required): Defines the name of the custom rule * **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules -* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. -* **rateLimitThreshold**: int (Required): Defines rate limit threshold. - -## Sku -### Properties -* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProfileProperties -### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. - -## TrackedResourceTags +## CustomRuleList ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **rules**: [CustomRule](#customrule)[]: List of rules -## EndpointProperties +## DeepCreatedOrigin ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. -* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## DeepCreatedOriginProperties ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 ## DeliveryRule ### Properties @@ -209,43 +178,6 @@ * **parameters**: [UrlRewriteActionParameters](#urlrewriteactionparameters) (Required): Defines the parameters for the url rewrite action. -## CacheExpirationActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - -## CacheKeyQueryStringActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests - -## HeaderActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **value**: string: Value for the specified action - -## UrlRedirectActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. - -## UrlRewriteActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) -* **destination**: string (Required): Define the destination path for be used in the rewrite. This will overwrite the source pattern -* **preserveUnmatchedPath**: bool: If True, the remaining path after the source pattern will be appended to the new destination path. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use "/" as the source pattern value. To match only the root directory and re-write this path, use the origin path field - ## DeliveryRuleCondition * **Discriminator**: name @@ -321,14 +253,46 @@ * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## CookiesMatchConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) -* **matchValues**: string[] (Required): The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched -* **selector**: string (Required): Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) + +## EndpointPropertiesUpdateParametersDeliveryPolicy +### Properties +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. + +## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink +### Properties +* **id**: string: Resource ID. + +## GeoFilter +### Properties +* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. +* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. +* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +## HeaderActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **value**: string: Value for the specified action ## HttpVersionMatchConditionParameters ### Properties @@ -345,6 +309,56 @@ * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms +## KeyVaultCertificateSourceParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) +* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate +* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate + +## ManagedRuleGroupOverride +### Properties +* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. + +## ManagedRuleOverride +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. +* **ruleId**: string (Required): Identifier for the managed rule. + +## ManagedRuleSet +### Properties +* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. + +## MatchCondition +### Properties +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. + +## PolicySettings +### Properties +* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. +* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. +* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. +* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. + ## PostArgsMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) @@ -354,6 +368,11 @@ * **selector**: string (Required): Name of PostArg to be matched * **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms +## ProfileProperties +### Properties +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. + ## QueryStringMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) @@ -362,6 +381,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms +## RateLimitRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. +* **rateLimitThreshold**: int (Required): Defines rate limit threshold. + +## RateLimitRuleList +### Properties +* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules + ## RemoteAddressMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' | string (Required) @@ -409,6 +442,25 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UrlFileExtensionMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) @@ -433,72 +485,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Wildcard' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'Uppercase' | string[]: List of transforms -## GeoFilter -### Properties -* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. -* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. -* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) - -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. - -## DeepCreatedOriginProperties -### Properties -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 - -## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink -### Properties -* **id**: string: Resource ID. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CustomDomainPropertiesParameters -### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - -## CustomDomainHttpsParameters -* **Discriminator**: certificateSource - -### Base Properties -* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https -* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. -### UserManagedHttpsParameters -#### Properties -* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. - -### CdnManagedHttpsParameters -#### Properties -* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. - - -## KeyVaultCertificateSourceParameters +## UrlRedirectActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) -* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate -* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. -## CdnCertificateSourceParameters +## UrlRewriteActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) -* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) +* **destination**: string (Required): Define the destination path for be used in the rewrite. This will overwrite the source pattern +* **preserveUnmatchedPath**: bool: If True, the remaining path after the source pattern will be appended to the new destination path. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use "/" as the source pattern value. To match only the root directory and re-write this path, use the origin path field diff --git a/generated/cdn/microsoft.cdn/2019-06-15/types.md b/generated/cdn/microsoft.cdn/2019-06-15/types.md index 249c29fae3..37e6403914 100644 --- a/generated/cdn/microsoft.cdn/2019-06-15/types.md +++ b/generated/cdn/microsoft.cdn/2019-06-15/types.md @@ -45,127 +45,96 @@ * **properties**: [CustomDomainPropertiesParameters](#customdomainpropertiesparameters): The JSON object that contains the properties of the custom domain to create. * **type**: 'Microsoft.Cdn/profiles/endpoints/customDomains' (ReadOnly, DeployTimeConstant): The resource type -## CdnWebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList +## CacheExpirationActionParameters ### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## CustomRule +## CacheKeyQueryStringActionParameters ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -## MatchCondition +## CdnCertificateSourceParameters ### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) +* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used ## CdnEndpoint ### Properties * **id**: string: ARM Resource ID string. -## ManagedRuleSetList +## CdnWebApplicationFirewallPolicyProperties ### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -## ManagedRuleSet +## CookiesMatchConditionParameters ### Properties -* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched +* **selector**: string: Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## ManagedRuleGroupOverride -### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +## CustomDomainHttpsParameters +* **Discriminator**: certificateSource -## ManagedRuleOverride -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. -* **ruleId**: string (Required): Identifier for the managed rule. +### Base Properties +* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https +* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. +### UserManagedHttpsParameters +#### Properties +* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. -## PolicySettings -### Properties -* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. -* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. -* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. -* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +### CdnManagedHttpsParameters +#### Properties +* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. -## RateLimitRuleList + +## CustomDomainPropertiesParameters ### Properties -* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## RateLimitRule +## CustomRule ### Properties * **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. * **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. * **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. * **name**: string (Required): Defines the name of the custom rule * **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules -* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. -* **rateLimitThreshold**: int (Required): Defines rate limit threshold. - -## Sku -### Properties -* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProfileProperties -### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. - -## TrackedResourceTags +## CustomRuleList ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **rules**: [CustomRule](#customrule)[]: List of rules -## EndpointProperties +## DeepCreatedOrigin ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. -* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) +* **name**: string (Required): Origin name +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## DeepCreatedOriginProperties ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 ## DeliveryRule ### Properties @@ -209,43 +178,6 @@ * **parameters**: [UrlRewriteActionParameters](#urlrewriteactionparameters) (Required): Defines the parameters for the url rewrite action. -## CacheExpirationActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - -## CacheKeyQueryStringActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests - -## HeaderActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **value**: string: Value for the specified action - -## UrlRedirectActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. - -## UrlRewriteActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) -* **destination**: string (Required): Define the destination path for be used in the rewrite. This will overwrite the source pattern -* **preserveUnmatchedPath**: bool: If True, the remaining path after the source pattern will be appended to the new destination path. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use "/" as the source pattern value. To match only the root directory and re-write this path, use the origin path field - ## DeliveryRuleCondition * **Discriminator**: name @@ -321,14 +253,46 @@ * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## CookiesMatchConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched -* **selector**: string: Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) + +## EndpointPropertiesUpdateParametersDeliveryPolicy +### Properties +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. + +## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink +### Properties +* **id**: string: Resource ID. + +## GeoFilter +### Properties +* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. +* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. +* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +## HeaderActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **value**: string: Value for the specified action ## HttpVersionMatchConditionParameters ### Properties @@ -345,6 +309,56 @@ * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## KeyVaultCertificateSourceParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) +* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate +* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate + +## ManagedRuleGroupOverride +### Properties +* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. + +## ManagedRuleOverride +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. +* **ruleId**: string (Required): Identifier for the managed rule. + +## ManagedRuleSet +### Properties +* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. + +## MatchCondition +### Properties +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. + +## PolicySettings +### Properties +* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. +* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. +* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. +* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. + ## PostArgsMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) @@ -354,6 +368,11 @@ * **selector**: string: Name of PostArg to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## ProfileProperties +### Properties +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. + ## QueryStringMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) @@ -362,6 +381,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## RateLimitRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. +* **rateLimitThreshold**: int (Required): Defines rate limit threshold. + +## RateLimitRuleList +### Properties +* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules + ## RemoteAddressMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' | string (Required) @@ -409,6 +442,25 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UrlFileExtensionMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) @@ -433,72 +485,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Wildcard' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## GeoFilter -### Properties -* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. -* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. -* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) - -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. - -## DeepCreatedOriginProperties -### Properties -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535 -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535 - -## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink -### Properties -* **id**: string: Resource ID. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CustomDomainPropertiesParameters -### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - -## CustomDomainHttpsParameters -* **Discriminator**: certificateSource - -### Base Properties -* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https -* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. -### UserManagedHttpsParameters -#### Properties -* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. - -### CdnManagedHttpsParameters -#### Properties -* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. - - -## KeyVaultCertificateSourceParameters +## UrlRedirectActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) -* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate -* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. -## CdnCertificateSourceParameters +## UrlRewriteActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) -* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) +* **destination**: string (Required): Define the destination path for be used in the rewrite. This will overwrite the source pattern +* **preserveUnmatchedPath**: bool: If True, the remaining path after the source pattern will be appended to the new destination path. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. Currently, source pattern uses a prefix-based match. To match all URL paths, use "/" as the source pattern value. To match only the root directory and re-write this path, use the origin path field diff --git a/generated/cdn/microsoft.cdn/2019-12-31/types.md b/generated/cdn/microsoft.cdn/2019-12-31/types.md index f0723b263f..699917014b 100644 --- a/generated/cdn/microsoft.cdn/2019-12-31/types.md +++ b/generated/cdn/microsoft.cdn/2019-12-31/types.md @@ -50,48 +50,86 @@ * **properties**: [OriginProperties](#originproperties): The JSON object that contains the properties of the origin. * **type**: 'Microsoft.Cdn/profiles/endpoints/origins' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties +## CacheExpirationActionParameters ### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## Sku +## CacheKeyQueryStringActionParameters ### Properties -* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -## TrackedResourceTags +## CdnCertificateSourceParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) +* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used -## EndpointProperties +## CookiesMatchConditionParameters ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. -* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint can only be set allowed when endpoint uses single origin. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched +* **selector**: string: Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## ResourceReference +## CustomDomainHttpsParameters +* **Discriminator**: certificateSource + +### Base Properties +* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https +* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. +### UserManagedHttpsParameters +#### Properties +* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. + +### CdnManagedHttpsParameters +#### Properties +* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. + + +## CustomDomainPropertiesParameters ### Properties -* **id**: string: Resource ID. +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## DeepCreatedOrigin ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **name**: string (Required): Origin name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. + +## DeepCreatedOriginGroup +### Properties +* **name**: string (Required): Origin group name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. + +## DeepCreatedOriginGroupProperties +### Properties +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. +* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. + +## DeepCreatedOriginProperties +### Properties +* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. If endpoint uses multiple origins for load balancing, then the host header at endpoint is ignored and this one is considered. +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ## DeliveryRule ### Properties @@ -140,48 +178,6 @@ * **parameters**: [UrlRewriteActionParameters](#urlrewriteactionparameters) (Required): Defines the parameters for the url rewrite action. -## CacheExpirationActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - -## CacheKeyQueryStringActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests - -## HeaderActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **value**: string: Value for the specified action - -## OriginGroupOverrideActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters' | string (Required) -* **originGroup**: [ResourceReference](#resourcereference) (Required): Reference to another resource. - -## UrlRedirectActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. - -## UrlRewriteActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) -* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. -* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. - ## DeliveryRuleCondition * **Discriminator**: name @@ -257,14 +253,55 @@ * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## CookiesMatchConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched -* **selector**: string: Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. +* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint can only be set allowed when endpoint uses single origin. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. + +## EndpointPropertiesUpdateParametersDeliveryPolicy +### Properties +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. + +## GeoFilter +### Properties +* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. +* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. +* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +## HeaderActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **value**: string: Value for the specified action + +## HealthProbeParameters +### Properties +* **probeIntervalInSeconds**: int: The number of seconds between health probes.Default is 240sec. +* **probePath**: string: The path relative to the origin that is used to determine the health of the origin. +* **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. +* **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. + +## HttpErrorRangeParameters +### Properties +* **begin**: int: The inclusive start of the http status code range. +* **end**: int: The inclusive end of the http status code range. ## HttpVersionMatchConditionParameters ### Properties @@ -281,6 +318,43 @@ * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## KeyVaultCertificateSourceParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) +* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate +* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate + +## OriginGroupOverrideActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters' | string (Required) +* **originGroup**: [ResourceReference](#resourcereference) (Required): Reference to another resource. + +## OriginGroupProperties +### Properties +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **origins**: [ResourceReference](#resourcereference)[]: The source of the content being delivered via CDN within given origin group. +* **provisioningState**: string (ReadOnly): Provisioning status of the origin group. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin group. +* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. + +## OriginProperties +### Properties +* **enabled**: bool: Origin is enabled for load balancing or not +* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. If endpoint uses multiple origins for load balancing, then the host header at endpoint is ignored and this one is considered. +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 +* **provisioningState**: string (ReadOnly): Provisioning status of the origin. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 + ## PostArgsMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) @@ -290,6 +364,11 @@ * **selector**: string: Name of PostArg to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## ProfileProperties +### Properties +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. + ## QueryStringMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) @@ -345,6 +424,30 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## ResourceReference +### Properties +* **id**: string: Resource ID. + +## ResponseBasedOriginErrorDetectionParameters +### Properties +* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. +* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy +* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. + +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UrlFileExtensionMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) @@ -369,123 +472,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Wildcard' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## GeoFilter -### Properties -* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. -* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. -* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) - -## DeepCreatedOriginGroup -### Properties -* **name**: string (Required): Origin group name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. - -## DeepCreatedOriginGroupProperties -### Properties -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. -* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. - -## HealthProbeParameters -### Properties -* **probeIntervalInSeconds**: int: The number of seconds between health probes.Default is 240sec. -* **probePath**: string: The path relative to the origin that is used to determine the health of the origin. -* **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. -* **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. - -## ResponseBasedOriginErrorDetectionParameters -### Properties -* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. -* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy -* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. - -## HttpErrorRangeParameters -### Properties -* **begin**: int: The inclusive start of the http status code range. -* **end**: int: The inclusive end of the http status code range. - -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. - -## DeepCreatedOriginProperties -### Properties -* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. If endpoint uses multiple origins for load balancing, then the host header at endpoint is ignored and this one is considered. -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CustomDomainPropertiesParameters -### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - -## CustomDomainHttpsParameters -* **Discriminator**: certificateSource - -### Base Properties -* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https -* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. -### UserManagedHttpsParameters -#### Properties -* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. - -### CdnManagedHttpsParameters -#### Properties -* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. - - -## KeyVaultCertificateSourceParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) -* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate -* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate - -## CdnCertificateSourceParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) -* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used - -## OriginGroupProperties +## UrlRedirectActionParameters ### Properties -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[]: The source of the content being delivered via CDN within given origin group. -* **provisioningState**: string (ReadOnly): Provisioning status of the origin group. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin group. -* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. -## OriginProperties +## UrlRewriteActionParameters ### Properties -* **enabled**: bool: Origin is enabled for load balancing or not -* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. If endpoint uses multiple origins for load balancing, then the host header at endpoint is ignored and this one is considered. -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 -* **provisioningState**: string (ReadOnly): Provisioning status of the origin. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) +* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. +* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. diff --git a/generated/cdn/microsoft.cdn/2020-04-15/types.md b/generated/cdn/microsoft.cdn/2020-04-15/types.md index 28fef13814..494c4cb322 100644 --- a/generated/cdn/microsoft.cdn/2020-04-15/types.md +++ b/generated/cdn/microsoft.cdn/2020-04-15/types.md @@ -63,134 +63,116 @@ * **properties**: [OriginProperties](#originproperties): The JSON object that contains the properties of the origin. * **type**: 'Microsoft.Cdn/profiles/endpoints/origins' (ReadOnly, DeployTimeConstant): The resource type -## CdnWebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList +## CacheExpirationActionParameters ### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## CustomRule +## CacheKeyQueryStringActionParameters ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -## MatchCondition +## CdnCertificateSourceParameters ### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) +* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used ## CdnEndpoint ### Properties * **id**: string: ARM Resource ID string. -## ManagedRuleSetList +## CdnWebApplicationFirewallPolicyProperties ### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -## ManagedRuleSet +## CookiesMatchConditionParameters ### Properties -* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched +* **selector**: string: Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## ManagedRuleGroupOverride -### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +## CustomDomainHttpsParameters +* **Discriminator**: certificateSource -## ManagedRuleOverride -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. -* **ruleId**: string (Required): Identifier for the managed rule. +### Base Properties +* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https +* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. +### UserManagedHttpsParameters +#### Properties +* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. -## PolicySettings -### Properties -* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. -* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. -* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. -* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +### CdnManagedHttpsParameters +#### Properties +* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. -## RateLimitRuleList + +## CustomDomainPropertiesParameters ### Properties -* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## RateLimitRule +## CustomRule ### Properties * **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. * **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. * **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. * **name**: string (Required): Defines the name of the custom rule * **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules -* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. -* **rateLimitThreshold**: int (Required): Defines rate limit threshold. - -## Sku -### Properties -* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## ProfileProperties +## CustomRuleList ### Properties -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **rules**: [CustomRule](#customrule)[]: List of rules -## TrackedResourceTags +## DeepCreatedOrigin ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): Origin name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. -## EndpointProperties +## DeepCreatedOriginGroup ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. -* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. -* **urlSigningKeys**: [UrlSigningKey](#urlsigningkey)[]: List of keys used to validate the signed URL hashes. -* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) +* **name**: string (Required): Origin group name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. -## ResourceReference +## DeepCreatedOriginGroupProperties ### Properties -* **id**: string: Resource ID. +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. +* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## DeepCreatedOriginProperties ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. +* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' +* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. +* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated +* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ## DeliveryRule ### Properties @@ -239,56 +221,6 @@ * **parameters**: [UrlSigningActionParameters](#urlsigningactionparameters) (Required): Defines the parameters for the Url Signing action. -## CacheExpirationActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - -## CacheKeyQueryStringActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests - -## HeaderActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **value**: string: Value for the specified action - -## UrlRedirectActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. - -## UrlRewriteActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) -* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. -* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. - -## UrlSigningActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters' | string -* **algorithm**: 'SHA256' | string: Algorithm to use for URL signing -* **ipSubnets**: string[]: Match values to match against. Supports CIDR ranges (both IPv4 and IPv6). -* **keyId**: string (Required): Id reference of the key to be used to verify the hash and should be defined in UrlSigningKeys -* **parameterNameOverride**: [UrlSigningParamIdentifier](#urlsigningparamidentifier)[]: Defines which query string parameters in the url to be considered for expires, key id etc. - -## UrlSigningParamIdentifier -### Properties -* **paramIndicator**: 'Expires' | 'KeyId' | 'Signature' | string (Required): Indicates the purpose of the parameter -* **paramName**: string (Required): Parameter name - ## DeliveryRuleCondition * **Discriminator**: name @@ -364,30 +296,162 @@ * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## CookiesMatchConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched -* **selector**: string: Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. +* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **urlSigningKeys**: [UrlSigningKey](#urlsigningkey)[]: List of keys used to validate the signed URL hashes. +* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) -## HttpVersionMatchConditionParameters +## EndpointPropertiesUpdateParametersDeliveryPolicy ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. -## IsDeviceMatchConditionParameters +## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters' | string (Required) +* **id**: string: Resource ID. + +## GeoFilter +### Properties +* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. +* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. +* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) + +## HeaderActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **value**: string: Value for the specified action + +## HealthProbeParameters +### Properties +* **probeIntervalInSeconds**: int: The number of seconds between health probes.Default is 240sec. +* **probePath**: string: The path relative to the origin that is used to determine the health of the origin. +* **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. +* **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. + +## HttpErrorRangeParameters +### Properties +* **begin**: int: The inclusive start of the http status code range. +* **end**: int: The inclusive end of the http status code range. + +## HttpVersionMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched + +## IsDeviceMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters' | string (Required) * **matchValues**: 'Desktop' | 'Mobile' | string[]: The match value for the condition of the delivery rule * **negateCondition**: bool: Describes if this is negate condition or not * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## KeyVaultCertificateSourceParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) +* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate +* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate + +## KeyVaultSigningKeyParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultSigningKeyParameters' | string (Required) +* **resourceGroupName**: string (Required): Resource group of the user's Key Vault containing the secret +* **secretName**: string (Required): The name of secret in Key Vault. +* **secretVersion**: string (Required): The version(GUID) of secret in Key Vault. +* **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the secret +* **vaultName**: string (Required): The name of the user's Key Vault containing the secret + +## ManagedRuleGroupOverride +### Properties +* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. + +## ManagedRuleOverride +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. +* **ruleId**: string (Required): Identifier for the managed rule. + +## ManagedRuleSet +### Properties +* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. + +## MatchCondition +### Properties +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. + +## OriginGroupProperties +### Properties +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **origins**: [ResourceReference](#resourcereference)[]: The source of the content being delivered via CDN within given origin group. +* **provisioningState**: string (ReadOnly): Provisioning status of the origin group. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin group. +* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. + +## OriginProperties +### Properties +* **enabled**: bool: Origin is enabled for load balancing or not +* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 +* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The approval status for the connection to the Private Link +* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' +* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. +* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated +* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **provisioningState**: string (ReadOnly): Provisioning status of the origin. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 + +## PolicySettings +### Properties +* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. +* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. +* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. +* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. + ## PostArgsMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) @@ -397,6 +461,11 @@ * **selector**: string: Name of PostArg to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## ProfileProperties +### Properties +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. + ## QueryStringMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) @@ -405,6 +474,20 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## RateLimitRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. +* **rateLimitThreshold**: int (Required): Defines rate limit threshold. + +## RateLimitRuleList +### Properties +* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules + ## RemoteAddressMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' | string (Required) @@ -452,6 +535,35 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +## ResourceReference +### Properties +* **id**: string: Resource ID. + +## ResponseBasedOriginErrorDetectionParameters +### Properties +* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. +* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy +* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. + +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'Standard_Akamai' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UrlFileExtensionMatchConditionParameters ### Properties * **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) @@ -476,150 +588,38 @@ * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Wildcard' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## GeoFilter -### Properties -* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. -* **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. -* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) - -## DeepCreatedOriginGroup -### Properties -* **name**: string (Required): Origin group name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. - -## DeepCreatedOriginGroupProperties -### Properties -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. -* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. - -## HealthProbeParameters -### Properties -* **probeIntervalInSeconds**: int: The number of seconds between health probes.Default is 240sec. -* **probePath**: string: The path relative to the origin that is used to determine the health of the origin. -* **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. -* **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. - -## ResponseBasedOriginErrorDetectionParameters -### Properties -* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. -* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy -* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. - -## HttpErrorRangeParameters +## UrlRedirectActionParameters ### Properties -* **begin**: int: The inclusive start of the http status code range. -* **end**: int: The inclusive end of the http status code range. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. -## DeepCreatedOrigin +## UrlRewriteActionParameters ### Properties -* **name**: string (Required): Origin name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) +* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. +* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. -## DeepCreatedOriginProperties +## UrlSigningActionParameters ### Properties -* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. -* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' -* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. -* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated -* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters' | string +* **algorithm**: 'SHA256' | string: Algorithm to use for URL signing +* **ipSubnets**: string[]: Match values to match against. Supports CIDR ranges (both IPv4 and IPv6). +* **keyId**: string (Required): Id reference of the key to be used to verify the hash and should be defined in UrlSigningKeys +* **parameterNameOverride**: [UrlSigningParamIdentifier](#urlsigningparamidentifier)[]: Defines which query string parameters in the url to be considered for expires, key id etc. ## UrlSigningKey ### Properties * **keyId**: string (Required): Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. * **keySourceParameters**: [KeyVaultSigningKeyParameters](#keyvaultsigningkeyparameters) (Required): Describes the parameters for using a user's KeyVault for URL Signing Key. -## KeyVaultSigningKeyParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultSigningKeyParameters' | string (Required) -* **resourceGroupName**: string (Required): Resource group of the user's Key Vault containing the secret -* **secretName**: string (Required): The name of secret in Key Vault. -* **secretVersion**: string (Required): The version(GUID) of secret in Key Vault. -* **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the secret -* **vaultName**: string (Required): The name of the user's Key Vault containing the secret - -## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink -### Properties -* **id**: string: Resource ID. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CustomDomainPropertiesParameters -### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - -## CustomDomainHttpsParameters -* **Discriminator**: certificateSource - -### Base Properties -* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https -* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. -### UserManagedHttpsParameters -#### Properties -* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. - -### CdnManagedHttpsParameters -#### Properties -* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. - - -## KeyVaultCertificateSourceParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) -* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate -* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate - -## CdnCertificateSourceParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) -* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used - -## OriginGroupProperties -### Properties -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[]: The source of the content being delivered via CDN within given origin group. -* **provisioningState**: string (ReadOnly): Provisioning status of the origin group. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin group. -* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. - -## OriginProperties +## UrlSigningParamIdentifier ### Properties -* **enabled**: bool: Origin is enabled for load balancing or not -* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 -* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The approval status for the connection to the Private Link -* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' -* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. -* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated -* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' -* **provisioningState**: string (ReadOnly): Provisioning status of the origin. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **paramIndicator**: 'Expires' | 'KeyId' | 'Signature' | string (Required): Indicates the purpose of the parameter +* **paramName**: string (Required): Parameter name diff --git a/generated/cdn/microsoft.cdn/2020-09-01/types.md b/generated/cdn/microsoft.cdn/2020-09-01/types.md index 4d01413c7f..511852eda7 100644 --- a/generated/cdn/microsoft.cdn/2020-09-01/types.md +++ b/generated/cdn/microsoft.cdn/2020-09-01/types.md @@ -161,200 +161,169 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data * **type**: 'Microsoft.Cdn/profiles/securityPolicies' (ReadOnly, DeployTimeConstant): The resource type -## CdnWebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - -## CustomRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules - -## MatchCondition -### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. - -## CdnEndpoint +## AFDDomainHttpsParameters ### Properties -* **id**: string: ARM Resource ID string. +* **certificateType**: 'CustomerCertificate' | 'ManagedCertificate' | string (Required): Defines the source of the SSL certificate. +* **minimumTlsVersion**: 'TLS10' | 'TLS12': TLS protocol version that will be used for Https +* **secret**: [ResourceReference](#resourcereference): Reference to another resource. -## ManagedRuleSetList +## AFDDomainProperties ### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. +* **azureDnsZone**: [ResourceReference](#resourcereference): Reference to another resource. +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **domainValidationState**: 'Approved' | 'Pending' | 'PendingRevalidation' | 'Submitting' | 'TimedOut' | 'Unknown' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. +* **hostName**: string (Required): The host name of the domain. Must be a domain name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **tlsSettings**: [AFDDomainHttpsParameters](#afddomainhttpsparameters): The JSON object that contains the properties to secure a domain. +* **validationProperties**: [DomainValidationProperties](#domainvalidationproperties) (ReadOnly): The JSON object that contains the properties to validate a domain. -## ManagedRuleSet +## AFDEndpointProperties ### Properties -* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **originResponseTimeoutSeconds**: int: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -## ManagedRuleGroupOverride +## AFDOriginGroupProperties ### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **loadBalancingSettings**: [LoadBalancingSettingsParameters](#loadbalancingsettingsparameters): Round-Robin load balancing settings for a backend pool +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **responseBasedAfdOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **sessionAffinityState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. -## ManagedRuleOverride +## AFDOriginProperties ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. -* **ruleId**: string (Required): Identifier for the managed rule. +* **azureOrigin**: [ResourceReference](#resourcereference): Reference to another resource. +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **sharedPrivateLinkResource**: [SharedPrivateLinkResourceProperties](#sharedprivatelinkresourceproperties): Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin. +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 -## PolicySettings +## CacheExpirationActionParameters ### Properties -* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. -* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. -* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. -* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -## RateLimitRuleList +## CacheKeyQueryStringActionParameters ### Properties -* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -## RateLimitRule +## CdnCertificateSourceParameters ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules -* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. -* **rateLimitThreshold**: int (Required): Defines rate limit threshold. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) +* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used -## Sku +## CdnEndpoint ### Properties -* **name**: 'Custom_Verizon' | 'Premium_AzureFrontDoor' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'StandardPlus_955BandWidth_ChinaCdn' | 'StandardPlus_AvgBandWidth_ChinaCdn' | 'StandardPlus_ChinaCdn' | 'Standard_955BandWidth_ChinaCdn' | 'Standard_Akamai' | 'Standard_AvgBandWidth_ChinaCdn' | 'Standard_AzureFrontDoor' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. +* **id**: string: ARM Resource ID string. -## SystemData +## CdnWebApplicationFirewallPolicyProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -## TrackedResourceTags +## CompressionSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. -## ProfileProperties +## CookiesMatchConditionParameters ### Properties -* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## CustomDomainHttpsParameters +* **Discriminator**: certificateSource -## AFDEndpointProperties -### Properties -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **originResponseTimeoutSeconds**: int: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +### Base Properties +* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https +* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. +### UserManagedHttpsParameters +#### Properties +* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### CdnManagedHttpsParameters +#### Properties +* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. +* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. -## RouteProperties -### Properties -* **compressionSettings**: [CompressionSettings](#compressionsettings): settings for compression. -* **customDomains**: [ResourceReference](#resourcereference)[]: Domains referenced by this endpoint. -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **forwardingProtocol**: 'HttpOnly' | 'HttpsOnly' | 'MatchRequest' | string: Protocol this rule will use when forwarding traffic to backends. -* **httpsRedirect**: 'Disabled' | 'Enabled' | string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. -* **linkToDefaultDomain**: 'Disabled' | 'Enabled' | string: whether this route will be linked to the default endpoint domain. -* **originGroup**: [ResourceReference](#resourcereference): Reference to another resource. -* **originPath**: string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **patternsToMatch**: string[]: The route patterns of the rule. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **queryStringCachingBehavior**: 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **ruleSets**: [ResourceReference](#resourcereference)[]: rule sets referenced by this endpoint. -* **supportedProtocols**: 'Http' | 'Https' | string[]: List of supported protocols for this route. -## CompressionSettings +## CustomDomainPropertiesParameters ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## ResourceReference +## CustomRule ### Properties -* **id**: string: Resource ID. +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules -## AFDDomainProperties +## CustomRuleList ### Properties -* **azureDnsZone**: [ResourceReference](#resourcereference): Reference to another resource. -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **domainValidationState**: 'Approved' | 'Pending' | 'PendingRevalidation' | 'Submitting' | 'TimedOut' | 'Unknown' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. -* **hostName**: string (Required): The host name of the domain. Must be a domain name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **tlsSettings**: [AFDDomainHttpsParameters](#afddomainhttpsparameters): The JSON object that contains the properties to secure a domain. -* **validationProperties**: [DomainValidationProperties](#domainvalidationproperties) (ReadOnly): The JSON object that contains the properties to validate a domain. +* **rules**: [CustomRule](#customrule)[]: List of rules -## AFDDomainHttpsParameters +## DeepCreatedOrigin ### Properties -* **certificateType**: 'CustomerCertificate' | 'ManagedCertificate' | string (Required): Defines the source of the SSL certificate. -* **minimumTlsVersion**: 'TLS10' | 'TLS12': TLS protocol version that will be used for Https -* **secret**: [ResourceReference](#resourcereference): Reference to another resource. +* **name**: string (Required): Origin name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. -## DomainValidationProperties +## DeepCreatedOriginGroup ### Properties -* **expirationDate**: string (ReadOnly): The date time that the token expires -* **validationToken**: string (ReadOnly): Challenge used for DNS TXT record or file based validation +* **name**: string (Required): Origin group name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. -## EndpointProperties +## DeepCreatedOriginGroupProperties ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. -* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. -* **urlSigningKeys**: [UrlSigningKey](#urlsigningkey)[]: List of keys used to validate the signed URL hashes. -* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. +* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## DeepCreatedOriginProperties ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. +* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' +* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. +* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated +* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ## DeliveryRule ### Properties @@ -405,61 +374,8 @@ ### UrlSigningAction #### Properties * **name**: 'UrlSigning' (Required): The name of the action for the delivery rule. -* **parameters**: [UrlSigningActionParameters](#urlsigningactionparameters) (Required): Defines the parameters for the Url Signing action. - - -## CacheExpirationActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheExpirationActionParameters' | string (Required) -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. - -## CacheKeyQueryStringActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests - -## HeaderActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **value**: string: Value for the specified action - -## OriginGroupOverrideActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters' | string (Required) -* **originGroup**: [ResourceReference](#resourcereference) (Required): Reference to another resource. - -## UrlRedirectActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. - -## UrlRewriteActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) -* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. -* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. - -## UrlSigningActionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters' | string (Required) -* **algorithm**: 'SHA256' | string: Algorithm to use for URL signing -* **parameterNameOverride**: [UrlSigningParamIdentifier](#urlsigningparamidentifier)[]: Defines which query string parameters in the url to be considered for expires, key id etc. - -## UrlSigningParamIdentifier -### Properties -* **paramIndicator**: 'Expires' | 'KeyId' | 'Signature' | string (Required): Indicates the purpose of the parameter -* **paramName**: string (Required): Parameter name +* **parameters**: [UrlSigningActionParameters](#urlsigningactionparameters) (Required): Defines the parameters for the Url Signing action. + ## DeliveryRuleCondition * **Discriminator**: name @@ -536,117 +452,41 @@ * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## CookiesMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleCookiesConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## HttpVersionMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched - -## IsDeviceMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters' | string (Required) -* **matchValues**: 'Desktop' | 'Mobile' | string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## PostArgsMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Name of PostArg to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## QueryStringMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## RemoteAddressMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' | string (Required) -* **matchValues**: 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. -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'GeoMatch' | 'IPMatch' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## RequestBodyMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## RequestHeaderMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Name of Header to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## RequestMethodMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters' | string (Required) -* **matchValues**: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'TRACE' | string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched - -## RequestSchemeMatchConditionParameters -### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters' | string (Required) -* **matchValues**: 'HTTP' | 'HTTPS' | string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched - -## RequestUriMatchConditionParameters +## DomainValidationProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **expirationDate**: string (ReadOnly): The date time that the token expires +* **validationToken**: string (ReadOnly): Challenge used for DNS TXT record or file based validation -## UrlFileExtensionMatchConditionParameters +## EndpointProperties ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. +* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **urlSigningKeys**: [UrlSigningKey](#urlsigningkey)[]: List of keys used to validate the signed URL hashes. +* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) -## UrlFileNameMatchConditionParameters +## EndpointPropertiesUpdateParametersDeliveryPolicy ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. -## UrlPathMatchConditionParameters +## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters' | string (Required) -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | 'Wildcard' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **id**: string: Resource ID. ## GeoFilter ### Properties @@ -654,17 +494,12 @@ * **countryCodes**: string[] (Required): Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. * **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) -## DeepCreatedOriginGroup -### Properties -* **name**: string (Required): Origin group name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. - -## DeepCreatedOriginGroupProperties +## HeaderActionParameters ### Properties -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. -* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHeaderActionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **value**: string: Value for the specified action ## HealthProbeParameters ### Properties @@ -673,40 +508,36 @@ * **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. * **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. -## ResponseBasedOriginErrorDetectionParameters -### Properties -* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. -* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy -* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. - ## HttpErrorRangeParameters ### Properties * **begin**: int: The inclusive start of the http status code range. * **end**: int: The inclusive end of the http status code range. -## DeepCreatedOrigin +## HttpVersionMatchConditionParameters ### Properties -* **name**: string (Required): Origin name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleHttpVersionConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched -## DeepCreatedOriginProperties +## IsDeviceMatchConditionParameters ### Properties -* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. -* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' -* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. -* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated -* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleIsDeviceConditionParameters' | string (Required) +* **matchValues**: 'Desktop' | 'Mobile' | string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## UrlSigningKey +## KeyVaultCertificateSourceParameters ### Properties -* **keyId**: string (Required): Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. -* **keySourceParameters**: [KeyVaultSigningKeyParameters](#keyvaultsigningkeyparameters) (Required): Describes the parameters for using a user's KeyVault for URL Signing Key. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) +* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate +* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate ## KeyVaultSigningKeyParameters ### Properties @@ -717,57 +548,47 @@ * **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the secret * **vaultName**: string (Required): The name of the user's Key Vault containing the secret -## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink +## LoadBalancingSettingsParameters ### Properties -* **id**: string: Resource ID. +* **additionalLatencyInMilliseconds**: int: The additional latency in milliseconds for probes to fall into the lowest latency bucket +* **sampleSize**: int: The number of samples to consider for load balancing decisions +* **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## TrackedResourceTags +## ManagedRuleGroupOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## CustomDomainPropertiesParameters +## ManagedRuleOverride ### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - -## CustomDomainHttpsParameters -* **Discriminator**: certificateSource - -### Base Properties -* **minimumTlsVersion**: 'None' | 'TLS10' | 'TLS12' (ReadOnly): TLS protocol version that will be used for Https -* **protocolType**: 'IPBased' | 'ServerNameIndication' | string (ReadOnly): Defines the TLS extension protocol that is used for secure delivery. -### UserManagedHttpsParameters -#### Properties -* **certificateSource**: 'AzureKeyVault' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters) (ReadOnly): Describes the parameters for using a user's KeyVault certificate for securing custom domain. +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. +* **ruleId**: string (Required): Identifier for the managed rule. -### CdnManagedHttpsParameters -#### Properties -* **certificateSource**: 'Cdn' (Required): Defines the source of the SSL certificate. -* **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (ReadOnly): Defines the parameters for using CDN managed certificate for securing custom domain. +## ManagedRuleSet +### Properties +* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. -## KeyVaultCertificateSourceParameters +## MatchCondition ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.KeyVaultCertificateSourceParameters' | string (ReadOnly) -* **deleteRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (ReadOnly): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (ReadOnly): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string (ReadOnly): The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (ReadOnly): Subscription Id of the user's Key Vault containing the SSL certificate -* **updateRule**: 'NoAction' | string (ReadOnly): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (ReadOnly): The name of the user's Key Vault containing the SSL certificate +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'HttpVersion' | 'IsDevice' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RemoteAddress' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestScheme' | 'RequestUri' | 'SocketAddr' | 'UrlFileExtension' | 'UrlFileName' | 'UrlPath' | string (Required): The name of the condition for the delivery rule. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## CdnCertificateSourceParameters +## OriginGroupOverrideActionParameters ### Properties -* **@odata.type**: '#Microsoft.Azure.Cdn.Models.CdnCertificateSourceParameters' | string (ReadOnly) -* **certificateType**: 'Dedicated' | 'Shared' | string (ReadOnly): Type of certificate used +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleOriginGroupOverrideActionParameters' | string (Required) +* **originGroup**: [ResourceReference](#resourcereference) (Required): Reference to another resource. ## OriginGroupProperties ### Properties @@ -795,48 +616,124 @@ * **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. * **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 -## AFDOriginGroupProperties +## PolicySettings ### Properties -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **loadBalancingSettings**: [LoadBalancingSettingsParameters](#loadbalancingsettingsparameters): Round-Robin load balancing settings for a backend pool -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **responseBasedAfdOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **sessionAffinityState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. +* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. +* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. +* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. +* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -## LoadBalancingSettingsParameters +## PostArgsMatchConditionParameters ### Properties -* **additionalLatencyInMilliseconds**: int: The additional latency in milliseconds for probes to fall into the lowest latency bucket -* **sampleSize**: int: The number of samples to consider for load balancing decisions -* **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRulePostArgsConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Name of PostArg to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## AFDOriginProperties +## ProfileProperties ### Properties -* **azureOrigin**: [ResourceReference](#resourcereference): Reference to another resource. -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **sharedPrivateLinkResource**: [SharedPrivateLinkResourceProperties](#sharedprivatelinkresourceproperties): Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin. -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. -## SharedPrivateLinkResourceProperties +## QueryStringMatchConditionParameters ### Properties -* **groupId**: string: The group id from the provider of resource the shared private link resource is for. -* **privateLink**: [ResourceReference](#resourcereference): Reference to another resource. -* **privateLinkLocation**: string: The location of the shared private link resource -* **requestMessage**: string: The request message for requesting approval of the shared private link resource. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout': Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleQueryStringConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## RuleSetProperties +## RateLimitRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. +* **rateLimitThreshold**: int (Required): Defines rate limit threshold. + +## RateLimitRuleList +### Properties +* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules + +## RemoteAddressMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRemoteAddressConditionParameters' | string (Required) +* **matchValues**: 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. +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'GeoMatch' | 'IPMatch' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## RequestBodyMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestBodyConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## RequestHeaderMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestHeaderConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Name of Header to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## RequestMethodMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestMethodConditionParameters' | string (Required) +* **matchValues**: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'TRACE' | string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched + +## RequestSchemeMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestSchemeConditionParameters' | string (Required) +* **matchValues**: 'HTTP' | 'HTTPS' | string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched + +## RequestUriMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleRequestUriConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## ResourceReference +### Properties +* **id**: string: Resource ID. + +## ResponseBasedOriginErrorDetectionParameters +### Properties +* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. +* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy +* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. + +## RouteProperties ### Properties +* **compressionSettings**: [CompressionSettings](#compressionsettings): settings for compression. +* **customDomains**: [ResourceReference](#resourcereference)[]: Domains referenced by this endpoint. * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **forwardingProtocol**: 'HttpOnly' | 'HttpsOnly' | 'MatchRequest' | string: Protocol this rule will use when forwarding traffic to backends. +* **httpsRedirect**: 'Disabled' | 'Enabled' | string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. +* **linkToDefaultDomain**: 'Disabled' | 'Enabled' | string: whether this route will be linked to the default endpoint domain. +* **originGroup**: [ResourceReference](#resourcereference): Reference to another resource. +* **originPath**: string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **patternsToMatch**: string[]: The route patterns of the rule. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **queryStringCachingBehavior**: 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **ruleSets**: [ResourceReference](#resourcereference)[]: rule sets referenced by this endpoint. +* **supportedProtocols**: 'Http' | 'Https' | string[]: List of supported protocols for this route. ## RuleProperties ### Properties @@ -847,10 +744,9 @@ * **order**: int: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -## SecretProperties +## RuleSetProperties ### Properties * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **parameters**: [SecretParameters](#secretparameters): The json object containing secret parameters * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status ## SecretParameters @@ -878,10 +774,10 @@ * **type**: 'UrlSigningKey' (Required): The type of the Secret to create. -## SecurityPolicyProperties +## SecretProperties ### Properties * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **parameters**: [SecurityPolicyParameters](#securitypolicyparameters): The json object containing security policy parameters +* **parameters**: [SecretParameters](#secretparameters): The json object containing secret parameters * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status ## SecurityPolicyParameters @@ -895,8 +791,112 @@ * **wafPolicy**: [ResourceReference](#resourcereference): Reference to another resource. +## SecurityPolicyProperties +### Properties +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **parameters**: [SecurityPolicyParameters](#securitypolicyparameters): The json object containing security policy parameters +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status + ## SecurityPolicyWebApplicationFirewallAssociation ### Properties * **domains**: [ResourceReference](#resourcereference)[]: List of domains. * **patternsToMatch**: string[]: List of paths +## SharedPrivateLinkResourceProperties +### Properties +* **groupId**: string: The group id from the provider of resource the shared private link resource is for. +* **privateLink**: [ResourceReference](#resourcereference): Reference to another resource. +* **privateLinkLocation**: string: The location of the shared private link resource +* **requestMessage**: string: The request message for requesting approval of the shared private link resource. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout': Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. + +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_AzureFrontDoor' | 'Premium_ChinaCdn' | 'Premium_Verizon' | 'StandardPlus_955BandWidth_ChinaCdn' | 'StandardPlus_AvgBandWidth_ChinaCdn' | 'StandardPlus_ChinaCdn' | 'Standard_955BandWidth_ChinaCdn' | 'Standard_Akamai' | 'Standard_AvgBandWidth_ChinaCdn' | 'Standard_AzureFrontDoor' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UrlFileExtensionMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## UrlFileNameMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlFilenameConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## UrlPathMatchConditionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlPathMatchConditionParameters' | string (Required) +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | 'Wildcard' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## UrlRedirectActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRedirectActionParameters' | string (Required) +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. + +## UrlRewriteActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlRewriteActionParameters' | string (Required) +* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. +* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. + +## UrlSigningActionParameters +### Properties +* **@odata.type**: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters' | string (Required) +* **algorithm**: 'SHA256' | string: Algorithm to use for URL signing +* **parameterNameOverride**: [UrlSigningParamIdentifier](#urlsigningparamidentifier)[]: Defines which query string parameters in the url to be considered for expires, key id etc. + +## UrlSigningKey +### Properties +* **keyId**: string (Required): Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. +* **keySourceParameters**: [KeyVaultSigningKeyParameters](#keyvaultsigningkeyparameters) (Required): Describes the parameters for using a user's KeyVault for URL Signing Key. + +## UrlSigningParamIdentifier +### Properties +* **paramIndicator**: 'Expires' | 'KeyId' | 'Signature' | string (Required): Indicates the purpose of the parameter +* **paramName**: string (Required): Parameter name + diff --git a/generated/cdn/microsoft.cdn/2021-06-01/types.md b/generated/cdn/microsoft.cdn/2021-06-01/types.md index 66261b3106..9f0c9e01de 100644 --- a/generated/cdn/microsoft.cdn/2021-06-01/types.md +++ b/generated/cdn/microsoft.cdn/2021-06-01/types.md @@ -186,114 +186,28 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data * **type**: 'Microsoft.Cdn/profiles/securityPolicies' (ReadOnly, DeployTimeConstant): The resource type -## CdnWebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - -## CustomRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules - -## MatchCondition -### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Match variable to compare against. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. - -## CdnEndpoint -### Properties -* **id**: string: ARM Resource ID string. - -## ManagedRuleSetList -### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. - -## ManagedRuleSet -### Properties -* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. - -## ManagedRuleGroupOverride -### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. - -## ManagedRuleOverride -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. -* **ruleId**: string (Required): Identifier for the managed rule. - -## PolicySettings -### Properties -* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. -* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. -* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. -* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. - -## RateLimitRuleList -### Properties -* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules - -## RateLimitRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string (Required): Defines the name of the custom rule -* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules -* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. -* **rateLimitThreshold**: int (Required): Defines rate limit threshold. - -## Sku -### Properties -* **name**: 'Custom_Verizon' | 'Premium_AzureFrontDoor' | 'Premium_Verizon' | 'StandardPlus_955BandWidth_ChinaCdn' | 'StandardPlus_AvgBandWidth_ChinaCdn' | 'StandardPlus_ChinaCdn' | 'Standard_955BandWidth_ChinaCdn' | 'Standard_Akamai' | 'Standard_AvgBandWidth_ChinaCdn' | 'Standard_AzureFrontDoor' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources - -## TrackedResourceTags +## ActivatedResourceReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. +* **isActive**: bool (ReadOnly): Whether the resource is active or inactive -## ProfileProperties +## AFDDomainHttpsParameters ### Properties -* **frontDoorId**: string (ReadOnly): The Id of the frontdoor. -* **originResponseTimeoutSeconds**: int: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. -* **provisioningState**: string (ReadOnly): Provisioning status of the profile. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. +* **certificateType**: 'AzureFirstPartyManagedCertificate' | 'CustomerCertificate' | 'ManagedCertificate' | string (Required): Defines the source of the SSL certificate. +* **minimumTlsVersion**: 'TLS10' | 'TLS12': TLS protocol version that will be used for Https +* **secret**: [ResourceReference](#resourcereference): Reference to another resource. -## TrackedResourceTags +## AFDDomainProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureDnsZone**: [ResourceReference](#resourcereference): Reference to another resource. +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **domainValidationState**: 'Approved' | 'InternalError' | 'Pending' | 'PendingRevalidation' | 'RefreshingValidationToken' | 'Rejected' | 'Submitting' | 'TimedOut' | 'Unknown' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. +* **hostName**: string (Required): The host name of the domain. Must be a domain name. +* **preValidatedCustomDomainResourceId**: [ResourceReference](#resourcereference): Reference to another resource. +* **profileName**: string (ReadOnly): The name of the profile which holds the domain. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **tlsSettings**: [AFDDomainHttpsParameters](#afddomainhttpsparameters): The JSON object that contains the properties to secure a domain. +* **validationProperties**: [DomainValidationProperties](#domainvalidationproperties) (ReadOnly): The JSON object that contains the properties to validate a domain. ## AFDEndpointProperties ### Properties @@ -304,27 +218,31 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **profileName**: string (ReadOnly): The name of the profile which holds the endpoint. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -## TrackedResourceTags +## AFDOriginGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **loadBalancingSettings**: [LoadBalancingSettingsParameters](#loadbalancingsettingsparameters): Round-Robin load balancing settings for a backend pool +* **profileName**: string (ReadOnly): The name of the profile which holds the origin group. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **sessionAffinityState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. -## RouteProperties +## AFDOriginProperties ### Properties -* **cacheConfiguration**: [AfdRouteCacheConfiguration](#afdroutecacheconfiguration): Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. -* **customDomains**: [ActivatedResourceReference](#activatedresourcereference)[]: Domains referenced by this endpoint. +* **azureOrigin**: [ResourceReference](#resourcereference): Reference to another resource. * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) * **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **endpointName**: string (ReadOnly): The name of the endpoint which holds the route. -* **forwardingProtocol**: 'HttpOnly' | 'HttpsOnly' | 'MatchRequest' | string: Protocol this rule will use when forwarding traffic to backends. -* **httpsRedirect**: 'Disabled' | 'Enabled' | string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. -* **linkToDefaultDomain**: 'Disabled' | 'Enabled' | string: whether this route will be linked to the default endpoint domain. -* **originGroup**: [ResourceReference](#resourcereference): Reference to another resource. -* **originPath**: string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **patternsToMatch**: string[]: The route patterns of the rule. +* **enforceCertificateNameCheck**: bool: Whether to enable certificate name check at origin level +* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originGroupName**: string (ReadOnly): The name of the origin group which contains this origin. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **ruleSets**: [ResourceReference](#resourcereference)[]: rule sets referenced by this endpoint. -* **supportedProtocols**: 'Http' | 'Https' | string[]: List of supported protocols for this route. +* **sharedPrivateLinkResource**: [SharedPrivateLinkResourceProperties](#sharedprivatelinkresourceproperties): Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin. +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ## AfdRouteCacheConfiguration ### Properties @@ -332,65 +250,67 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **queryParameters**: string: query parameters to include or exclude (comma separated). * **queryStringCachingBehavior**: 'IgnoreQueryString' | 'IgnoreSpecifiedQueryStrings' | 'IncludeSpecifiedQueryStrings' | 'UseQueryString' | string: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. -## CompressionSettings +## CacheConfiguration ### Properties -* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. +* **cacheBehavior**: 'HonorOrigin' | 'OverrideAlways' | 'OverrideIfOriginMissing' | string: Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **isCompressionEnabled**: 'Disabled' | 'Enabled' | string: Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringCachingBehavior**: 'IgnoreQueryString' | 'IgnoreSpecifiedQueryStrings' | 'IncludeSpecifiedQueryStrings' | 'UseQueryString' | string: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. -## ActivatedResourceReference +## CacheExpirationActionParameters ### Properties -* **id**: string: Resource ID. -* **isActive**: bool (ReadOnly): Whether the resource is active or inactive +* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests +* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss +* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. +* **typeName**: 'DeliveryRuleCacheExpirationActionParameters' | string (Required) -## ResourceReference +## CacheKeyQueryStringActionParameters ### Properties -* **id**: string: Resource ID. +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests +* **typeName**: 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) -## AFDDomainProperties +## CdnCertificateSourceParameters ### Properties -* **azureDnsZone**: [ResourceReference](#resourcereference): Reference to another resource. -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **domainValidationState**: 'Approved' | 'InternalError' | 'Pending' | 'PendingRevalidation' | 'RefreshingValidationToken' | 'Rejected' | 'Submitting' | 'TimedOut' | 'Unknown' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. -* **hostName**: string (Required): The host name of the domain. Must be a domain name. -* **preValidatedCustomDomainResourceId**: [ResourceReference](#resourcereference): Reference to another resource. -* **profileName**: string (ReadOnly): The name of the profile which holds the domain. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **tlsSettings**: [AFDDomainHttpsParameters](#afddomainhttpsparameters): The JSON object that contains the properties to secure a domain. -* **validationProperties**: [DomainValidationProperties](#domainvalidationproperties) (ReadOnly): The JSON object that contains the properties to validate a domain. +* **certificateType**: 'Dedicated' | 'Shared' | string (Required): Type of certificate used +* **typeName**: 'CdnCertificateSourceParameters' | string (Required) -## AFDDomainHttpsParameters +## CdnEndpoint ### Properties -* **certificateType**: 'AzureFirstPartyManagedCertificate' | 'CustomerCertificate' | 'ManagedCertificate' | string (Required): Defines the source of the SSL certificate. -* **minimumTlsVersion**: 'TLS10' | 'TLS12': TLS protocol version that will be used for Https -* **secret**: [ResourceReference](#resourcereference): Reference to another resource. +* **id**: string: ARM Resource ID string. -## DomainValidationProperties +## CdnWebApplicationFirewallPolicyProperties ### Properties -* **expirationDate**: string (ReadOnly): The date time that the token expires -* **validationToken**: string (ReadOnly): Challenge used for DNS TXT record or file based validation +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **endpointLinks**: [CdnEndpoint](#cdnendpoint)[] (ReadOnly): Describes Azure CDN endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **rateLimitRules**: [RateLimitRuleList](#ratelimitrulelist): Defines contents of rate limit rules +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -## EndpointProperties +## ClientPortMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleClientPortConditionParameters' | string (Required) + +## CompressionSettings ### Properties * **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. -* **customDomains**: [CustomDomain](#customdomain)[] (ReadOnly): The custom domains under the endpoint. -* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. -* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. -* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ -* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net -* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. -* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. -* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. -* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. -* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. -* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. -* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. -* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. -* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. -* **urlSigningKeys**: [UrlSigningKey](#urlsigningkey)[]: List of keys used to validate the signed URL hashes. -* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. + +## CookiesMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Name of Cookies to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleCookiesConditionParameters' | string (Required) ## CustomDomain ### Properties @@ -400,16 +320,6 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data * **type**: string (ReadOnly): Resource type. -## CustomDomainProperties -### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. - ## CustomDomainHttpsParameters * **Discriminator**: certificateSource @@ -427,26 +337,69 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **certificateSourceParameters**: [CdnCertificateSourceParameters](#cdncertificatesourceparameters) (Required): Defines the parameters for using CDN managed certificate for securing custom domain. -## KeyVaultCertificateSourceParameters +## CustomDomainProperties ### Properties -* **deleteRule**: 'NoAction' | string (Required): Describes the action that shall be taken when the certificate is removed from Key Vault. -* **resourceGroupName**: string (Required): Resource group of the user's Key Vault containing the SSL certificate -* **secretName**: string (Required): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. -* **secretVersion**: string: The version(GUID) of Key Vault Secret in Key Vault. -* **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the SSL certificate -* **typeName**: 'KeyVaultCertificateSourceParameters' | string (Required) -* **updateRule**: 'NoAction' | string (Required): Describes the action that shall be taken when the certificate is updated in Key Vault. -* **vaultName**: string (Required): The name of the user's Key Vault containing the SSL certificate +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## CdnCertificateSourceParameters +## CustomDomainPropertiesParameters ### Properties -* **certificateType**: 'Dedicated' | 'Shared' | string (Required): Type of certificate used -* **typeName**: 'CdnCertificateSourceParameters' | string (Required) +* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. +* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. +* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. -## EndpointPropertiesUpdateParametersDeliveryPolicy +## CustomRule ### Properties -* **description**: string: User-friendly description of the policy. -* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules + +## CustomRuleList +### Properties +* **rules**: [CustomRule](#customrule)[]: List of rules + +## DeepCreatedOrigin +### Properties +* **name**: string (Required): Origin name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. + +## DeepCreatedOriginGroup +### Properties +* **name**: string (Required): Origin group name which must be unique within the endpoint. +* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. + +## DeepCreatedOriginGroupProperties +### Properties +* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. +* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. +* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. +* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. + +## DeepCreatedOriginProperties +### Properties +* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. +* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. +* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. +* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. +* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The approval status for the connection to the Private Link +* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' +* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. +* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated +* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ## DeliveryRule ### Properties @@ -505,78 +458,6 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **parameters**: [UrlSigningActionParameters](#urlsigningactionparameters) (Required): Defines the parameters for the Url Signing action. -## CacheExpirationActionParameters -### Properties -* **cacheBehavior**: 'BypassCache' | 'Override' | 'SetIfMissing' | string (Required): Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **cacheType**: 'All' | string (Required): The level at which the content needs to be cached. -* **typeName**: 'DeliveryRuleCacheExpirationActionParameters' | string (Required) - -## CacheKeyQueryStringActionParameters -### Properties -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringBehavior**: 'Exclude' | 'ExcludeAll' | 'Include' | 'IncludeAll' | string (Required): Caching behavior for the requests -* **typeName**: 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters' | string (Required) - -## HeaderActionParameters -### Properties -* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform -* **headerName**: string (Required): Name of the header to modify -* **typeName**: 'DeliveryRuleHeaderActionParameters' | string (Required) -* **value**: string: Value for the specified action - -## OriginGroupOverrideActionParameters -### Properties -* **originGroup**: [ResourceReference](#resourcereference) (Required): Reference to another resource. -* **typeName**: 'DeliveryRuleOriginGroupOverrideActionParameters' | string (Required) - -## RouteConfigurationOverrideActionParameters -### Properties -* **cacheConfiguration**: [CacheConfiguration](#cacheconfiguration): Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. -* **originGroupOverride**: [OriginGroupOverride](#origingroupoverride): Defines the parameters for the origin group override configuration. -* **typeName**: 'DeliveryRuleRouteConfigurationOverrideActionParameters' | string (Required) - -## CacheConfiguration -### Properties -* **cacheBehavior**: 'HonorOrigin' | 'OverrideAlways' | 'OverrideIfOriginMissing' | string: Caching behavior for the requests -* **cacheDuration**: string: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss -* **isCompressionEnabled**: 'Disabled' | 'Enabled' | string: Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryStringCachingBehavior**: 'IgnoreQueryString' | 'IgnoreSpecifiedQueryStrings' | 'IncludeSpecifiedQueryStrings' | 'UseQueryString' | string: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. - -## OriginGroupOverride -### Properties -* **forwardingProtocol**: 'HttpOnly' | 'HttpsOnly' | 'MatchRequest' | string: Protocol this rule will use when forwarding traffic to backends. -* **originGroup**: [ResourceReference](#resourcereference): Reference to another resource. - -## UrlRedirectActionParameters -### Properties -* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. -* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. -* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. -* **customQueryString**: 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. ? and & will be added automatically so do not include them. -* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest -* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. -* **typeName**: 'DeliveryRuleUrlRedirectActionParameters' | string (Required) - -## UrlRewriteActionParameters -### Properties -* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. -* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. -* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. -* **typeName**: 'DeliveryRuleUrlRewriteActionParameters' | string (Required) - -## UrlSigningActionParameters -### Properties -* **algorithm**: 'SHA256' | string: Algorithm to use for URL signing -* **parameterNameOverride**: [UrlSigningParamIdentifier](#urlsigningparamidentifier)[]: Defines which query string parameters in the url to be considered for expires, key id etc. -* **typeName**: 'DeliveryRuleUrlSigningActionParameters' | string (Required) - -## UrlSigningParamIdentifier -### Properties -* **paramIndicator**: 'Expires' | 'KeyId' | 'Signature' | string (Required): Indicates the purpose of the parameter -* **paramName**: string (Required): Parameter name - ## DeliveryRuleCondition * **Discriminator**: name @@ -677,321 +558,312 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **parameters**: [UrlPathMatchConditionParameters](#urlpathmatchconditionparameters) (Required): Defines the parameters for UrlPath match conditions -## ClientPortMatchConditionParameters -### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleClientPortConditionParameters' | string (Required) - -## CookiesMatchConditionParameters +## DomainValidationProperties ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Name of Cookies to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleCookiesConditionParameters' | string (Required) +* **expirationDate**: string (ReadOnly): The date time that the token expires +* **validationToken**: string (ReadOnly): Challenge used for DNS TXT record or file based validation -## HostNameMatchConditionParameters +## EndpointProperties ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleHostNameConditionParameters' | string (Required) +* **contentTypesToCompress**: string[]: List of content types on which compression applies. The value should be a valid MIME type. +* **customDomains**: [CustomDomain](#customdomain)[] (ReadOnly): The custom domains under the endpoint. +* **defaultOriginGroup**: [ResourceReference](#resourcereference): Reference to another resource. +* **deliveryPolicy**: [EndpointPropertiesUpdateParametersDeliveryPolicy](#endpointpropertiesupdateparametersdeliverypolicy): A policy that specifies the delivery rules to be used for an endpoint. +* **geoFilters**: [GeoFilter](#geofilter)[]: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ +* **hostName**: string (ReadOnly): The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net +* **isCompressionEnabled**: bool: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. +* **isHttpAllowed**: bool: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **isHttpsAllowed**: bool: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. +* **optimizationType**: 'DynamicSiteAcceleration' | 'GeneralMediaStreaming' | 'GeneralWebDelivery' | 'LargeFileDownload' | 'VideoOnDemandMediaStreaming' | string: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. +* **originGroups**: [DeepCreatedOriginGroup](#deepcreatedorigingroup)[]: The origin groups comprising of origins that are used for load balancing the traffic based on availability. +* **originHostHeader**: string: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. +* **originPath**: string: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **origins**: [DeepCreatedOrigin](#deepcreatedorigin)[] (Required): The source of the content being delivered via CDN. +* **probePath**: string: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. +* **provisioningState**: string (ReadOnly): Provisioning status of the endpoint. +* **queryStringCachingBehavior**: 'BypassCaching' | 'IgnoreQueryString' | 'NotSet' | 'UseQueryString': Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Resource status of the endpoint. +* **urlSigningKeys**: [UrlSigningKey](#urlsigningkey)[]: List of keys used to validate the signed URL hashes. +* **webApplicationFirewallPolicyLink**: [EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink](#endpointpropertiesupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for the endpoint (if applicable) -## HttpVersionMatchConditionParameters +## EndpointPropertiesUpdateParametersDeliveryPolicy ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleHttpVersionConditionParameters' | string (Required) +* **description**: string: User-friendly description of the policy. +* **rules**: [DeliveryRule](#deliveryrule)[] (Required): A list of the delivery rules. -## IsDeviceMatchConditionParameters +## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink ### Properties -* **matchValues**: 'Desktop' | 'Mobile' | string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleIsDeviceConditionParameters' | string (Required) +* **id**: string: Resource ID. -## PostArgsMatchConditionParameters +## GeoFilter ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Name of PostArg to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRulePostArgsConditionParameters' | string (Required) +* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. +* **countryCodes**: string[] (Required): Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. +* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) -## QueryStringMatchConditionParameters +## HeaderActionParameters ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleQueryStringConditionParameters' | string (Required) +* **headerAction**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Action to perform +* **headerName**: string (Required): Name of the header to modify +* **typeName**: 'DeliveryRuleHeaderActionParameters' | string (Required) +* **value**: string: Value for the specified action -## RemoteAddressMatchConditionParameters +## HealthProbeParameters ### Properties -* **matchValues**: 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. -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'GeoMatch' | 'IPMatch' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleRemoteAddressConditionParameters' | string (Required) +* **probeIntervalInSeconds**: int: The number of seconds between health probes.Default is 240sec. +* **probePath**: string: The path relative to the origin that is used to determine the health of the origin. +* **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. +* **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. -## RequestBodyMatchConditionParameters +## HostNameMatchConditionParameters ### Properties * **matchValues**: string[]: The match value for the condition of the delivery rule * **negateCondition**: bool: Describes if this is negate condition or not * **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleRequestBodyConditionParameters' | string (Required) +* **typeName**: 'DeliveryRuleHostNameConditionParameters' | string (Required) -## RequestHeaderMatchConditionParameters +## HttpErrorRangeParameters ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Name of Header to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleRequestHeaderConditionParameters' | string (Required) +* **begin**: int: The inclusive start of the http status code range. +* **end**: int: The inclusive end of the http status code range. -## RequestMethodMatchConditionParameters +## HttpVersionMatchConditionParameters ### Properties -* **matchValues**: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'TRACE' | string[]: The match value for the condition of the delivery rule +* **matchValues**: string[]: The match value for the condition of the delivery rule * **negateCondition**: bool: Describes if this is negate condition or not * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleRequestMethodConditionParameters' | string (Required) +* **typeName**: 'DeliveryRuleHttpVersionConditionParameters' | string (Required) -## RequestSchemeMatchConditionParameters +## IsDeviceMatchConditionParameters ### Properties -* **matchValues**: 'HTTP' | 'HTTPS' | string[]: The match value for the condition of the delivery rule +* **matchValues**: 'Desktop' | 'Mobile' | string[]: The match value for the condition of the delivery rule * **negateCondition**: bool: Describes if this is negate condition or not * **operator**: 'Equal' | string (Required): Describes operator to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleRequestSchemeConditionParameters' | string (Required) +* **typeName**: 'DeliveryRuleIsDeviceConditionParameters' | string (Required) -## RequestUriMatchConditionParameters +## KeyVaultCertificateSourceParameters ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleRequestUriConditionParameters' | string (Required) +* **deleteRule**: 'NoAction' | string (Required): Describes the action that shall be taken when the certificate is removed from Key Vault. +* **resourceGroupName**: string (Required): Resource group of the user's Key Vault containing the SSL certificate +* **secretName**: string (Required): The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. +* **secretVersion**: string: The version(GUID) of Key Vault Secret in Key Vault. +* **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the SSL certificate +* **typeName**: 'KeyVaultCertificateSourceParameters' | string (Required) +* **updateRule**: 'NoAction' | string (Required): Describes the action that shall be taken when the certificate is updated in Key Vault. +* **vaultName**: string (Required): The name of the user's Key Vault containing the SSL certificate -## ServerPortMatchConditionParameters +## KeyVaultSigningKeyParameters ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleServerPortConditionParameters' | string (Required) +* **resourceGroupName**: string (Required): Resource group of the user's Key Vault containing the secret +* **secretName**: string (Required): The name of secret in Key Vault. +* **secretVersion**: string (Required): The version(GUID) of secret in Key Vault. +* **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the secret +* **typeName**: 'KeyVaultSigningKeyParameters' | string (Required) +* **vaultName**: string (Required): The name of the user's Key Vault containing the secret -## SocketAddrMatchConditionParameters +## LoadBalancingSettingsParameters ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'IPMatch' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleSocketAddrConditionParameters' | string (Required) +* **additionalLatencyInMilliseconds**: int: The additional latency in milliseconds for probes to fall into the lowest latency bucket +* **sampleSize**: int: The number of samples to consider for load balancing decisions +* **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## SslProtocolMatchConditionParameters +## ManagedRuleGroupOverride ### Properties -* **matchValues**: 'TLSv1' | 'TLSv1.1' | 'TLSv1.2' | string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Equal' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleSslProtocolConditionParameters' | string (Required) +* **ruleGroupName**: string (Required): Describes the managed rule group within the rule set to override +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## UrlFileExtensionMatchConditionParameters +## ManagedRuleOverride ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. +* **ruleId**: string (Required): Identifier for the managed rule. -## UrlFileNameMatchConditionParameters +## ManagedRuleSet ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleUrlFilenameConditionParameters' | string (Required) +* **anomalyScore**: int: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## UrlPathMatchConditionParameters +## ManagedRuleSetList ### Properties -* **matchValues**: string[]: The match value for the condition of the delivery rule -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | 'Wildcard' | string (Required): Describes operator to be matched -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -* **typeName**: 'DeliveryRuleUrlPathMatchConditionParameters' | string (Required) +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. -## GeoFilter +## MatchCondition ### Properties -* **action**: 'Allow' | 'Block' (Required): Action of the geo filter, i.e. allow or block access. -* **countryCodes**: string[] (Required): Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. -* **relativePath**: string (Required): Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Match variable to compare against. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## DeepCreatedOriginGroup +## OriginGroupOverride ### Properties -* **name**: string (Required): Origin group name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginGroupProperties](#deepcreatedorigingroupproperties): Properties of the origin group created on the CDN endpoint. +* **forwardingProtocol**: 'HttpOnly' | 'HttpsOnly' | 'MatchRequest' | string: Protocol this rule will use when forwarding traffic to backends. +* **originGroup**: [ResourceReference](#resourcereference): Reference to another resource. -## DeepCreatedOriginGroupProperties +## OriginGroupOverrideActionParameters +### Properties +* **originGroup**: [ResourceReference](#resourcereference) (Required): Reference to another resource. +* **typeName**: 'DeliveryRuleOriginGroupOverrideActionParameters' | string (Required) + +## OriginGroupProperties ### Properties * **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[] (Required): The source of the content being delivered via CDN within given origin group. +* **origins**: [ResourceReference](#resourcereference)[]: The source of the content being delivered via CDN within given origin group. +* **provisioningState**: string (ReadOnly): Provisioning status of the origin group. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin group. * **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. * **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. -## HealthProbeParameters -### Properties -* **probeIntervalInSeconds**: int: The number of seconds between health probes.Default is 240sec. -* **probePath**: string: The path relative to the origin that is used to determine the health of the origin. -* **probeProtocol**: 'Http' | 'Https' | 'NotSet': Protocol to use for health probe. -* **probeRequestType**: 'GET' | 'HEAD' | 'NotSet': The type of health probe request that is made. - -## ResponseBasedOriginErrorDetectionParameters -### Properties -* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. -* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy -* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. - -## HttpErrorRangeParameters -### Properties -* **begin**: int: The inclusive start of the http status code range. -* **end**: int: The inclusive end of the http status code range. - -## DeepCreatedOrigin -### Properties -* **name**: string (Required): Origin name which must be unique within the endpoint. -* **properties**: [DeepCreatedOriginProperties](#deepcreatedoriginproperties): Properties of the origin created on the CDN endpoint. - -## DeepCreatedOriginProperties +## OriginProperties ### Properties -* **enabled**: bool: Origin is enabled for load balancing or not. By default, origin is always enabled. -* **hostName**: string (Required): The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. +* **enabled**: bool: Origin is enabled for load balancing or not +* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. * **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. * **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. +* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint +* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 * **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The approval status for the connection to the Private Link * **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' * **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. * **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated * **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **provisioningState**: string (ReadOnly): Provisioning status of the origin. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. * **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 -## UrlSigningKey +## PolicySettings ### Properties -* **keyId**: string (Required): Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. -* **keySourceParameters**: [KeyVaultSigningKeyParameters](#keyvaultsigningkeyparameters) (Required): Describes the parameters for using a user's KeyVault for URL Signing Key. +* **defaultCustomBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. +* **defaultCustomBlockResponseStatusCode**: int: If the action type is block, this field defines the default customer overridable http response status code. +* **defaultRedirectUrl**: string: If action type is redirect, this field represents the default redirect URL for the client. +* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -## KeyVaultSigningKeyParameters +## PostArgsMatchConditionParameters ### Properties -* **resourceGroupName**: string (Required): Resource group of the user's Key Vault containing the secret -* **secretName**: string (Required): The name of secret in Key Vault. -* **secretVersion**: string (Required): The version(GUID) of secret in Key Vault. -* **subscriptionId**: string (Required): Subscription Id of the user's Key Vault containing the secret -* **typeName**: 'KeyVaultSigningKeyParameters' | string (Required) -* **vaultName**: string (Required): The name of the user's Key Vault containing the secret +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Name of PostArg to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRulePostArgsConditionParameters' | string (Required) -## EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink +## ProfileProperties ### Properties -* **id**: string: Resource ID. +* **frontDoorId**: string (ReadOnly): The Id of the frontdoor. +* **originResponseTimeoutSeconds**: int: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. +* **provisioningState**: string (ReadOnly): Provisioning status of the profile. +* **resourceState**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | string (ReadOnly): Resource status of the profile. + +## QueryStringMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleQueryStringConditionParameters' | string (Required) + +## RateLimitRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string (Required): Defines the name of the custom rule +* **priority**: int (Required): Defines in what order this rule be evaluated in the overall list of custom rules +* **rateLimitDurationInMinutes**: int (Required): Defines rate limit duration. Default is 1 minute. +* **rateLimitThreshold**: int (Required): Defines rate limit threshold. + +## RateLimitRuleList +### Properties +* **rules**: [RateLimitRule](#ratelimitrule)[]: List of rules + +## RemoteAddressMatchConditionParameters +### Properties +* **matchValues**: 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. +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'GeoMatch' | 'IPMatch' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleRemoteAddressConditionParameters' | string (Required) -## TrackedResourceTags +## RequestBodyMatchConditionParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleRequestBodyConditionParameters' | string (Required) -## CustomDomainPropertiesParameters +## RequestHeaderMatchConditionParameters ### Properties -* **customHttpsParameters**: [CustomDomainHttpsParameters](#customdomainhttpsparameters) (ReadOnly): The JSON object that contains the properties to secure a custom domain. -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the custom domain. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string (Required): The host name of the custom domain. Must be a domain name. -* **provisioningState**: string (ReadOnly): Provisioning status of the custom domain. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the custom domain. -* **validationData**: string (ReadOnly): Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Name of Header to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleRequestHeaderConditionParameters' | string (Required) -## OriginGroupProperties +## RequestMethodMatchConditionParameters ### Properties -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **origins**: [ResourceReference](#resourcereference)[]: The source of the content being delivered via CDN within given origin group. -* **provisioningState**: string (ReadOnly): Provisioning status of the origin group. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin group. -* **responseBasedOriginErrorDetectionSettings**: [ResponseBasedOriginErrorDetectionParameters](#responsebasedoriginerrordetectionparameters): The JSON object that contains the properties to determine origin health using real requests/responses. -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. +* **matchValues**: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'TRACE' | string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleRequestMethodConditionParameters' | string (Required) -## OriginProperties +## RequestSchemeMatchConditionParameters ### Properties -* **enabled**: bool: Origin is enabled for load balancing or not -* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 -* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The approval status for the connection to the Private Link -* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' -* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link. -* **privateLinkLocation**: string: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated -* **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' -* **provisioningState**: string (ReadOnly): Provisioning status of the origin. -* **resourceState**: 'Active' | 'Creating' | 'Deleting' | string (ReadOnly): Resource status of the origin. -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **matchValues**: 'HTTP' | 'HTTPS' | string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleRequestSchemeConditionParameters' | string (Required) -## AFDOriginGroupProperties +## RequestUriMatchConditionParameters ### Properties -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **healthProbeSettings**: [HealthProbeParameters](#healthprobeparameters): The JSON object that contains the properties to send health probes to origin. -* **loadBalancingSettings**: [LoadBalancingSettingsParameters](#loadbalancingsettingsparameters): Round-Robin load balancing settings for a backend pool -* **profileName**: string (ReadOnly): The name of the profile which holds the origin group. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **sessionAffinityState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **trafficRestorationTimeToHealedOrNewEndpointsInMinutes**: int: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleRequestUriConditionParameters' | string (Required) -## LoadBalancingSettingsParameters +## ResourceReference ### Properties -* **additionalLatencyInMilliseconds**: int: The additional latency in milliseconds for probes to fall into the lowest latency bucket -* **sampleSize**: int: The number of samples to consider for load balancing decisions -* **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed +* **id**: string: Resource ID. -## AFDOriginProperties +## ResponseBasedOriginErrorDetectionParameters ### Properties -* **azureOrigin**: [ResourceReference](#resourcereference): Reference to another resource. -* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **enforceCertificateNameCheck**: bool: Whether to enable certificate name check at origin level -* **hostName**: string: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. -* **httpPort**: int: The value of the HTTP port. Must be between 1 and 65535. -* **httpsPort**: int: The value of the HTTPS port. Must be between 1 and 65535. -* **originGroupName**: string (ReadOnly): The name of the origin group which contains this origin. -* **originHostHeader**: string: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint -* **priority**: int: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status -* **sharedPrivateLinkResource**: [SharedPrivateLinkResourceProperties](#sharedprivatelinkresourceproperties): Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin. -* **weight**: int: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 +* **httpErrorRanges**: [HttpErrorRangeParameters](#httperrorrangeparameters)[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. +* **responseBasedDetectedErrorTypes**: 'None' | 'TcpAndHttpErrors' | 'TcpErrorsOnly': Type of response errors for real user requests for which origin will be deemed unhealthy +* **responseBasedFailoverThresholdPercentage**: int: The percentage of failed requests in the sample where failover should trigger. -## SharedPrivateLinkResourceProperties +## RouteConfigurationOverrideActionParameters ### Properties -* **groupId**: string: The group id from the provider of resource the shared private link resource is for. -* **privateLink**: [ResourceReference](#resourcereference): Reference to another resource. -* **privateLinkLocation**: string: The location of the shared private link resource -* **requestMessage**: string: The request message for requesting approval of the shared private link resource. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout': Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. +* **cacheConfiguration**: [CacheConfiguration](#cacheconfiguration): Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. +* **originGroupOverride**: [OriginGroupOverride](#origingroupoverride): Defines the parameters for the origin group override configuration. +* **typeName**: 'DeliveryRuleRouteConfigurationOverrideActionParameters' | string (Required) -## RuleSetProperties +## RouteProperties ### Properties +* **cacheConfiguration**: [AfdRouteCacheConfiguration](#afdroutecacheconfiguration): Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. +* **customDomains**: [ActivatedResourceReference](#activatedresourcereference)[]: Domains referenced by this endpoint. * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **profileName**: string (ReadOnly): The name of the profile which holds the rule set. +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **endpointName**: string (ReadOnly): The name of the endpoint which holds the route. +* **forwardingProtocol**: 'HttpOnly' | 'HttpsOnly' | 'MatchRequest' | string: Protocol this rule will use when forwarding traffic to backends. +* **httpsRedirect**: 'Disabled' | 'Enabled' | string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. +* **linkToDefaultDomain**: 'Disabled' | 'Enabled' | string: whether this route will be linked to the default endpoint domain. +* **originGroup**: [ResourceReference](#resourcereference): Reference to another resource. +* **originPath**: string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. +* **patternsToMatch**: string[]: The route patterns of the rule. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status +* **ruleSets**: [ResourceReference](#resourcereference)[]: rule sets referenced by this endpoint. +* **supportedProtocols**: 'Http' | 'Https' | string[]: List of supported protocols for this route. ## RuleProperties ### Properties @@ -1003,11 +875,10 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status * **ruleSetName**: string (ReadOnly): The name of the rule set containing the rule. -## SecretProperties +## RuleSetProperties ### Properties * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) -* **parameters**: [SecretParameters](#secretparameters): The json object containing secret parameters -* **profileName**: string (ReadOnly): The name of the profile which holds the secret. +* **profileName**: string (ReadOnly): The name of the profile which holds the rule set. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status ## SecretParameters @@ -1044,6 +915,13 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **type**: 'UrlSigningKey' (Required): The type of the secret resource. +## SecretProperties +### Properties +* **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) +* **parameters**: [SecretParameters](#secretparameters): The json object containing secret parameters +* **profileName**: string (ReadOnly): The name of the profile which holds the secret. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status + ## SecurityPolicyProperties ### Properties * **deploymentStatus**: 'Failed' | 'InProgress' | 'NotStarted' | 'Succeeded' | string (ReadOnly) @@ -1067,3 +945,125 @@ StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming * **domains**: [ActivatedResourceReference](#activatedresourcereference)[]: List of domains. * **patternsToMatch**: string[]: List of paths +## ServerPortMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleServerPortConditionParameters' | string (Required) + +## SharedPrivateLinkResourceProperties +### Properties +* **groupId**: string: The group id from the provider of resource the shared private link resource is for. +* **privateLink**: [ResourceReference](#resourcereference): Reference to another resource. +* **privateLinkLocation**: string: The location of the shared private link resource +* **requestMessage**: string: The request message for requesting approval of the shared private link resource. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout': Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. + +## Sku +### Properties +* **name**: 'Custom_Verizon' | 'Premium_AzureFrontDoor' | 'Premium_Verizon' | 'StandardPlus_955BandWidth_ChinaCdn' | 'StandardPlus_AvgBandWidth_ChinaCdn' | 'StandardPlus_ChinaCdn' | 'Standard_955BandWidth_ChinaCdn' | 'Standard_Akamai' | 'Standard_AvgBandWidth_ChinaCdn' | 'Standard_AzureFrontDoor' | 'Standard_ChinaCdn' | 'Standard_Microsoft' | 'Standard_Verizon' | string: Name of the pricing tier. + +## SocketAddrMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'IPMatch' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleSocketAddrConditionParameters' | string (Required) + +## SslProtocolMatchConditionParameters +### Properties +* **matchValues**: 'TLSv1' | 'TLSv1.1' | 'TLSv1.2' | string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Equal' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleSslProtocolConditionParameters' | string (Required) + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UrlFileExtensionMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleUrlFileExtensionMatchConditionParameters' | string (Required) + +## UrlFileNameMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleUrlFilenameConditionParameters' | string (Required) + +## UrlPathMatchConditionParameters +### Properties +* **matchValues**: string[]: The match value for the condition of the delivery rule +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | 'Wildcard' | string (Required): Describes operator to be matched +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **typeName**: 'DeliveryRuleUrlPathMatchConditionParameters' | string (Required) + +## UrlRedirectActionParameters +### Properties +* **customFragment**: string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. +* **customHostname**: string: Host to redirect. Leave empty to use the incoming host as the destination host. +* **customPath**: string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. +* **customQueryString**: 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. ? and & will be added automatically so do not include them. +* **destinationProtocol**: 'Http' | 'Https' | 'MatchRequest' | string: Protocol to use for the redirect. The default value is MatchRequest +* **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string (Required): The redirect type the rule will use when redirecting traffic. +* **typeName**: 'DeliveryRuleUrlRedirectActionParameters' | string (Required) + +## UrlRewriteActionParameters +### Properties +* **destination**: string (Required): Define the relative URL to which the above requests will be rewritten by. +* **preserveUnmatchedPath**: bool: Whether to preserve unmatched path. Default value is true. +* **sourcePattern**: string (Required): define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. +* **typeName**: 'DeliveryRuleUrlRewriteActionParameters' | string (Required) + +## UrlSigningActionParameters +### Properties +* **algorithm**: 'SHA256' | string: Algorithm to use for URL signing +* **parameterNameOverride**: [UrlSigningParamIdentifier](#urlsigningparamidentifier)[]: Defines which query string parameters in the url to be considered for expires, key id etc. +* **typeName**: 'DeliveryRuleUrlSigningActionParameters' | string (Required) + +## UrlSigningKey +### Properties +* **keyId**: string (Required): Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. +* **keySourceParameters**: [KeyVaultSigningKeyParameters](#keyvaultsigningkeyparameters) (Required): Describes the parameters for using a user's KeyVault for URL Signing Key. + +## UrlSigningParamIdentifier +### Properties +* **paramIndicator**: 'Expires' | 'KeyId' | 'Signature' | string (Required): Indicates the purpose of the parameter +* **paramName**: string (Required): Parameter name + diff --git a/generated/changeanalysis/log.out b/generated/changeanalysis/log.out index 74cca4eb3c..64370a361e 100644 --- a/generated/changeanalysis/log.out +++ b/generated/changeanalysis/log.out @@ -4,18 +4,18 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.changeanalysis-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.changeanalysis-2021-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceGraphChangeData-beforeSnapshot' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json:511:9 @@ -26,8 +26,8 @@ info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.changeanalysis-2021-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 7.26s. 2 files generated. +info | Autorest completed in 7.31s. 2 files generated. diff --git a/generated/changeanalysis/microsoft.changeanalysis/2020-04-01-preview/types.md b/generated/changeanalysis/microsoft.changeanalysis/2020-04-01-preview/types.md index 6f9bdc8940..0b46d1f28f 100644 --- a/generated/changeanalysis/microsoft.changeanalysis/2020-04-01-preview/types.md +++ b/generated/changeanalysis/microsoft.changeanalysis/2020-04-01-preview/types.md @@ -12,11 +12,11 @@ * **systemData**: [SystemData](#systemdata): Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources * **type**: 'Microsoft.ChangeAnalysis/profile' (ReadOnly, DeployTimeConstant): The resource type -## ResourceIdentity +## AzureMonitorWorkspaceProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. -* **type**: 'None' | 'SystemAssigned' | string: 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 any identities. +* **includeChangeDetails**: 'Exclude' | 'Include' | 'None' | string: The mode of includeChangeDetails feature. The flag configures whether to include or exclude content of the change before and after values. +* **workspaceId**: string: The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace. +* **workspaceResourceId**: string: The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName} ## ConfigurationProfileResourceProperties ### Properties @@ -27,11 +27,11 @@ * **activationState**: 'Disabled' | 'Enabled' | 'None' | string: The state of notifications feature. * **azureMonitorWorkspaceProperties**: [AzureMonitorWorkspaceProperties](#azuremonitorworkspaceproperties): Configuration properties of an Azure Monitor workspace that receives change notifications. -## AzureMonitorWorkspaceProperties +## ResourceIdentity ### Properties -* **includeChangeDetails**: 'Exclude' | 'Include' | 'None' | string: The mode of includeChangeDetails feature. The flag configures whether to include or exclude content of the change before and after values. -* **workspaceId**: string: The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace. -* **workspaceResourceId**: string: The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName} +* **principalId**: string (ReadOnly): The principal id of the identity. This property will only be provided for a system-assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. +* **type**: 'None' | 'SystemAssigned' | string: 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 any identities. ## SystemData ### Properties diff --git a/generated/chaos/log.out b/generated/chaos/log.out index 2295014587..12ef7fc785 100644 --- a/generated/chaos/log.out +++ b/generated/chaos/log.out @@ -7,15 +7,15 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.chaos-2021-09-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms -info | Autorest completed in 5.73s. 2 files generated. +info | autorest.bicep took 14ms +info | Autorest completed in 5.58s. 2 files generated. diff --git a/generated/chaos/microsoft.chaos/2021-09-15-preview/types.md b/generated/chaos/microsoft.chaos/2021-09-15-preview/types.md index 7070cc358b..c85f3f5486 100644 --- a/generated/chaos/microsoft.chaos/2021-09-15-preview/types.md +++ b/generated/chaos/microsoft.chaos/2021-09-15-preview/types.md @@ -34,39 +34,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Chaos/targets/capabilities' (ReadOnly, DeployTimeConstant): The resource type -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): GUID that represents the principal ID of this resource identity. -* **tenantId**: string (ReadOnly): GUID that represents the tenant ID of this resource identity. -* **type**: 'None' | 'SystemAssigned' (Required): String of the resource identity type. - -## ExperimentProperties -### Properties -* **selectors**: [Selector](#selector)[] (Required): List of selectors. -* **startOnCreation**: bool: A boolean value that indicates if experiment should be started on creation or not. -* **steps**: [Step](#step)[] (Required): List of steps. - -## Selector -### Properties -* **id**: string (Required): String of the selector ID. -* **targets**: [TargetReference](#targetreference)[] (Required): List of Target references. -* **type**: 'List' | 'Percent' | 'Random' | 'Tag' (Required): Enum of the selector type. - -## TargetReference -### Properties -* **id**: string (Required): String of the resource ID of a Target resource. -* **type**: 'ChaosTarget' (Required): Enum of the Target reference type. - -## Step -### Properties -* **branches**: [Branch](#branch)[] (Required): List of branches. -* **name**: string (Required): String of the step name. - -## Branch -### Properties -* **actions**: [Action](#action)[] (Required): List of actions. -* **name**: string (Required): String of the branch name. - ## Action * **Discriminator**: type @@ -91,11 +58,47 @@ * **type**: 'discrete' (Required): Enum that discriminates between action models. +## Branch +### Properties +* **actions**: [Action](#action)[] (Required): List of actions. +* **name**: string (Required): String of the branch name. + +## CapabilityProperties +### Properties +* **description**: string (ReadOnly): Localized string of the description. +* **parametersSchema**: string (ReadOnly): String that represents a URL. +* **publisher**: string (ReadOnly): String of the Publisher that this Capability extends. +* **targetType**: string (ReadOnly): String of the Target Type that this Capability extends. +* **urn**: string (ReadOnly): String that represents a URN. + +## ExperimentProperties +### Properties +* **selectors**: [Selector](#selector)[] (Required): List of selectors. +* **startOnCreation**: bool: A boolean value that indicates if experiment should be started on creation or not. +* **steps**: [Step](#step)[] (Required): List of steps. + ## KeyValuePair ### Properties * **key**: string (Required): The name of the setting for the action. * **value**: string (Required): The value of the setting for the action. +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): GUID that represents the principal ID of this resource identity. +* **tenantId**: string (ReadOnly): GUID that represents the tenant ID of this resource identity. +* **type**: 'None' | 'SystemAssigned' (Required): String of the resource identity type. + +## Selector +### Properties +* **id**: string (Required): String of the selector ID. +* **targets**: [TargetReference](#targetreference)[] (Required): List of Target references. +* **type**: 'List' | 'Percent' | 'Random' | 'Tag' (Required): Enum of the selector type. + +## Step +### Properties +* **branches**: [Branch](#branch)[] (Required): List of branches. +* **name**: string (Required): String of the step name. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -105,21 +108,18 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TargetProperties ### Properties ### Additional Properties * **Additional Properties Type**: any -## CapabilityProperties +## TargetReference ### Properties -* **description**: string (ReadOnly): Localized string of the description. -* **parametersSchema**: string (ReadOnly): String that represents a URL. -* **publisher**: string (ReadOnly): String of the Publisher that this Capability extends. -* **targetType**: string (ReadOnly): String of the Target Type that this Capability extends. -* **urn**: string (ReadOnly): String that represents a URN. +* **id**: string (Required): String of the resource ID of a Target resource. +* **type**: 'ChaosTarget' (Required): Enum of the Target reference type. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/cloudshell/log.out b/generated/cloudshell/log.out index acb503c36e..9718e3934e 100644 --- a/generated/cloudshell/log.out +++ b/generated/cloudshell/log.out @@ -3,15 +3,15 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.portal-2018-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. warning | Modeler/MissingType | The schema 'Resource' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/CloudShell.json#/components/schemas/Resource info | Resource type microsoft.portal/locations/consoles under path '/providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}' has no body defined. -info | autorest.bicep took 15ms -info | Autorest completed in 4.76s. 2 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 4.54s. 2 files generated. diff --git a/generated/cloudshell/microsoft.portal/2018-10-01/types.md b/generated/cloudshell/microsoft.portal/2018-10-01/types.md index 0561cba5c2..4ba1a9c9bc 100644 --- a/generated/cloudshell/microsoft.portal/2018-10-01/types.md +++ b/generated/cloudshell/microsoft.portal/2018-10-01/types.md @@ -48,14 +48,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Failed' | 'NotSpecified' | 'Pending' | 'Repairing' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the console. * **uri**: string (ReadOnly): Uri of the console. -## UserProperties -### Properties -* **preferredLocation**: string (Required): The preferred location of the cloud shell. -* **preferredOsType**: 'Linux' | 'Windows' | string (Required): The operating system type of the cloud shell. -* **preferredShellType**: 'bash' | 'powershell' | 'pwsh' | string (Required): The shell type of the cloud shell. -* **storageProfile**: [StorageProfile](#storageprofile) (Required): The storage profile of the user settings. -* **terminalSettings**: [TerminalSettings](#terminalsettings) (Required): Settings for terminal appearance. - ## StorageProfile ### Properties * **diskSizeInGB**: int: Size of file share @@ -67,3 +59,11 @@ * **fontSize**: 'Large' | 'Medium' | 'NotSpecified' | 'Small' | string: Size of terminal font. * **fontStyle**: 'Courier' | 'Monospace' | 'NotSpecified' | string: Style of terminal font. +## UserProperties +### Properties +* **preferredLocation**: string (Required): The preferred location of the cloud shell. +* **preferredOsType**: 'Linux' | 'Windows' | string (Required): The operating system type of the cloud shell. +* **preferredShellType**: 'bash' | 'powershell' | 'pwsh' | string (Required): The shell type of the cloud shell. +* **storageProfile**: [StorageProfile](#storageprofile) (Required): The storage profile of the user settings. +* **terminalSettings**: [TerminalSettings](#terminalsettings) (Required): Settings for terminal appearance. + diff --git a/generated/cognitiveservices/log.out b/generated/cognitiveservices/log.out index 13a1763282..af3e37374a 100644 --- a/generated/cognitiveservices/log.out +++ b/generated/cognitiveservices/log.out @@ -3,35 +3,35 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.cognitiveservices-2022-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.cognitiveservices-2021-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2021-10-01/cognitiveservices.json:1476:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.cognitiveservices-2021-04-30"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2021-04-30/cognitiveservices.json:1043:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.cognitiveservices-2017-04-18"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json:898:5 @@ -113,7 +113,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.cognitiveservices-2016-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CognitiveServicesAccountCreateParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json:481:5 @@ -140,5 +140,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorBody' with an undefined warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'CognitiveServicesAccountPropertiesCreateParameters' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json#/components/schemas/CognitiveServicesAccountPropertiesCreateParameters -info | autorest.bicep took 2ms -info | Autorest completed in 15.82s. 10 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 15.53s. 10 files generated. diff --git a/generated/cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.md b/generated/cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.md index eb2d7f0b2a..f6ff0e577a 100644 --- a/generated/cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.md +++ b/generated/cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.md @@ -19,11 +19,6 @@ * **ApiVersion**: 2016-02-01-preview * **Output**: [CognitiveServicesAccountKeys](#cognitiveservicesaccountkeys) -## Sku -### Properties -* **name**: 'F0' | 'P0' | 'P1' | 'P2' | 'S0' | 'S1' | 'S2' | 'S3' | 'S4' | 'S5' | 'S6' | string (Required): Gets or sets the sku name. Required for account creation, optional for update. -* **tier**: 'Free' | 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. - ## CognitiveServicesAccountCreateParametersTags ### Properties ### Additional Properties @@ -34,3 +29,8 @@ * **key1**: string (ReadOnly): Gets the value of key 1. * **key2**: string (ReadOnly): Gets the value of key 2. +## Sku +### Properties +* **name**: 'F0' | 'P0' | 'P1' | 'P2' | 'S0' | 'S1' | 'S2' | 'S3' | 'S4' | 'S5' | 'S6' | string (Required): Gets or sets the sku name. Required for account creation, optional for update. +* **tier**: 'Free' | 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + diff --git a/generated/cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.md b/generated/cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.md index 92dfea5afa..08a4ba4bfe 100644 --- a/generated/cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.md +++ b/generated/cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.md @@ -31,22 +31,23 @@ * **ApiVersion**: 2017-04-18 * **Output**: [CognitiveServicesAccountKeys](#cognitiveservicesaccountkeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} - -## IdentityUserAssignedIdentities +## CognitiveServicesAccountApiProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **aadClientId**: string: (Metrics Advisor Only) The Azure AD Client Id (Application Id). +* **aadTenantId**: string: (Metrics Advisor Only) The Azure AD Tenant Id. +* **eventHubConnectionString**: string: (Personalization Only) The flag to enable statistics of Bing Search. +* **qnaAzureSearchEndpointId**: string: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. +* **qnaAzureSearchEndpointKey**: string: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. +* **qnaRuntimeEndpoint**: string: (QnAMaker Only) The runtime endpoint of QnAMaker. +* **statisticsEnabled**: bool: (Bing Search Only) The flag to enable statistics of Bing Search. +* **storageAccountConnectionString**: string: (Personalization Only) The storage account connection string. +* **superUser**: string: (Metrics Advisor Only) The super user of Metrics Advisor. +* **websiteName**: string: (Metrics Advisor Only) The website name of Metrics Advisor. -## UserAssignedIdentity +## CognitiveServicesAccountKeys ### Properties -* **clientId**: string: Client App Id associated with this identity. -* **principalId**: string: Azure Active Directory principal ID associated with this Identity. +* **key1**: string (ReadOnly): Gets the value of key 1. +* **key2**: string (ReadOnly): Gets the value of key 2. ## CognitiveServicesAccountProperties ### Properties @@ -65,29 +66,38 @@ * **skuChangeInfo**: [CognitiveServicesAccountSkuChangeInfo](#cognitiveservicesaccountskuchangeinfo) (ReadOnly): Sku change info of account. * **userOwnedStorage**: [UserOwnedStorage](#userownedstorage)[]: The storage accounts for this resource. -## CognitiveServicesAccountApiProperties +## CognitiveServicesAccountSkuChangeInfo ### Properties -* **aadClientId**: string: (Metrics Advisor Only) The Azure AD Client Id (Application Id). -* **aadTenantId**: string: (Metrics Advisor Only) The Azure AD Tenant Id. -* **eventHubConnectionString**: string: (Personalization Only) The flag to enable statistics of Bing Search. -* **qnaAzureSearchEndpointId**: string: (QnAMaker Only) The Azure Search endpoint id of QnAMaker. -* **qnaAzureSearchEndpointKey**: string: (QnAMaker Only) The Azure Search endpoint key of QnAMaker. -* **qnaRuntimeEndpoint**: string: (QnAMaker Only) The runtime endpoint of QnAMaker. -* **statisticsEnabled**: bool: (Bing Search Only) The flag to enable statistics of Bing Search. -* **storageAccountConnectionString**: string: (Personalization Only) The storage account connection string. -* **superUser**: string: (Metrics Advisor Only) The super user of Metrics Advisor. -* **websiteName**: string: (Metrics Advisor Only) The website name of Metrics Advisor. +* **countOfDowngrades**: int (ReadOnly): Gets the count of downgrades. +* **countOfUpgradesAfterDowngrades**: int (ReadOnly): Gets the count of upgrades after downgrades. +* **lastChangeDate**: string (ReadOnly): Gets the last change date. -## SkuCapability +## CognitiveServicesAccountTags ### Properties -* **name**: string: The name of the SkuCapability. -* **value**: string: The value of the SkuCapability. +### Additional Properties +* **Additional Properties Type**: string ## Encryption ### Properties * **keySource**: 'Microsoft.CognitiveServices' | 'Microsoft.KeyVault' | string: Enumerates the possible value of keySource for Encryption * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties +## Identity +### Properties +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## IpRule +### Properties +* **value**: string (Required): 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). + ## KeyVaultProperties ### Properties * **keyName**: string: Name of the Key from KeyVault @@ -100,15 +110,9 @@ * **ipRules**: [IpRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IpRule -### Properties -* **value**: string (Required): 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). - -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. -* **state**: string: Gets the state of virtual network rule. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -125,38 +129,34 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## CognitiveServicesAccountSkuChangeInfo +## Sku ### Properties -* **countOfDowngrades**: int (ReadOnly): Gets the count of downgrades. -* **countOfUpgradesAfterDowngrades**: int (ReadOnly): Gets the count of upgrades after downgrades. -* **lastChangeDate**: string (ReadOnly): Gets the last change date. +* **name**: string (Required): The name of SKU. +* **tier**: 'Enterprise' | 'Free' | 'Premium' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. -## UserOwnedStorage +## SkuCapability ### Properties -* **resourceId**: string: Full resource id of a Microsoft.Storage resource. +* **name**: string: The name of the SkuCapability. +* **value**: string: The value of the SkuCapability. -## Sku +## UserAssignedIdentity ### Properties -* **name**: string (Required): The name of SKU. -* **tier**: 'Enterprise' | 'Free' | 'Premium' | 'Standard' | string (ReadOnly): Gets the sku tier. This is based on the SKU name. +* **clientId**: string: Client App Id associated with this identity. +* **principalId**: string: Azure Active Directory principal ID associated with this Identity. -## CognitiveServicesAccountTags +## UserOwnedStorage ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceId**: string: Full resource id of a Microsoft.Storage resource. -## CognitiveServicesAccountKeys +## VirtualNetworkRule ### Properties -* **key1**: string (ReadOnly): Gets the value of key 1. -* **key2**: string (ReadOnly): Gets the value of key 2. +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. +* **state**: string: Gets the state of virtual network rule. diff --git a/generated/cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.md b/generated/cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.md index 3805ffd261..7f622a4d7e 100644 --- a/generated/cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.md +++ b/generated/cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.md @@ -33,23 +33,6 @@ * **ApiVersion**: 2021-04-30 * **Output**: [ApiKeys](#apikeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): Client App Id associated with this identity. -* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this Identity. - ## AccountProperties ### Properties * **allowedFqdnList**: string[]: Array of AccountPropertiesAllowedFqdnListItem @@ -75,6 +58,21 @@ * **skuChangeInfo**: [SkuChangeInfo](#skuchangeinfo) (ReadOnly): Sku change info of account. * **userOwnedStorage**: [UserOwnedStorage](#userownedstorage)[]: The storage accounts for this resource. +## AccountPropertiesEndpoints +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AccountTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApiKeys +### Properties +* **key1**: string (ReadOnly): Gets the value of key 1. +* **key2**: string (ReadOnly): Gets the value of key 2. + ## ApiProperties ### Properties * **aadClientId**: string: (Metrics Advisor Only) The Azure AD Client Id (Application Id). @@ -96,29 +94,26 @@ * **renewalPeriod**: int: The renewal period in seconds of Call Rate Limit. * **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## ThrottlingRule +## Encryption ### Properties -* **count**: int -* **dynamicThrottlingEnabled**: bool -* **key**: string -* **matchPatterns**: [RequestMatchPattern](#requestmatchpattern)[]: Array of RequestMatchPattern -* **minCount**: int -* **renewalPeriod**: int +* **keySource**: 'Microsoft.CognitiveServices' | 'Microsoft.KeyVault' | string: Enumerates the possible value of keySource for Encryption +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties -## RequestMatchPattern +## Identity ### Properties -* **method**: string -* **path**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} -## SkuCapability +## IdentityUserAssignedIdentities ### Properties -* **name**: string: The name of the SkuCapability. -* **value**: string: The value of the SkuCapability. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## Encryption +## IpRule ### Properties -* **keySource**: 'Microsoft.CognitiveServices' | 'Microsoft.KeyVault' | string: Enumerates the possible value of keySource for Encryption -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties +* **value**: string (Required): 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). ## KeyVaultProperties ### Properties @@ -127,26 +122,15 @@ * **keyVaultUri**: string: Uri of KeyVault * **keyVersion**: string: Version of the Key from KeyVault -## AccountPropertiesEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## NetworkRuleSet ### Properties * **defaultAction**: 'Allow' | 'Deny' | string: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. * **ipRules**: [IpRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IpRule -### Properties -* **value**: string (Required): 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). - -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. -* **state**: string: Gets the state of virtual network rule. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -165,16 +149,42 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## QuotaLimit +### Properties +* **count**: int +* **renewalPeriod**: int +* **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule + +## RequestMatchPattern +### Properties +* **method**: string +* **path**: string + +## Sku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Enterprise' | 'Free' | 'Premium' | 'Standard' | string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## SkuCapability +### Properties +* **name**: string: The name of the SkuCapability. +* **value**: string: The value of the SkuCapability. + +## SkuChangeInfo +### Properties +* **countOfDowngrades**: int: Gets the count of downgrades. +* **countOfUpgradesAfterDowngrades**: int: Gets the count of upgrades after downgrades. +* **lastChangeDate**: string: Gets the last change date. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -184,38 +194,28 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## QuotaLimit +## ThrottlingRule ### Properties * **count**: int +* **dynamicThrottlingEnabled**: bool +* **key**: string +* **matchPatterns**: [RequestMatchPattern](#requestmatchpattern)[]: Array of RequestMatchPattern +* **minCount**: int * **renewalPeriod**: int -* **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## SkuChangeInfo +## UserAssignedIdentity ### Properties -* **countOfDowngrades**: int: Gets the count of downgrades. -* **countOfUpgradesAfterDowngrades**: int: Gets the count of upgrades after downgrades. -* **lastChangeDate**: string: Gets the last change date. +* **clientId**: string (ReadOnly): Client App Id associated with this identity. +* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this Identity. ## UserOwnedStorage ### Properties * **identityClientId**: string * **resourceId**: string: Full resource id of a Microsoft.Storage resource. -## Sku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Enterprise' | 'Free' | 'Premium' | 'Standard' | string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## AccountTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApiKeys +## VirtualNetworkRule ### Properties -* **key1**: string (ReadOnly): Gets the value of key 1. -* **key2**: string (ReadOnly): Gets the value of key 2. +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. +* **state**: string: Gets the state of virtual network rule. diff --git a/generated/cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.md b/generated/cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.md index 902230bdab..52188c08fe 100644 --- a/generated/cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.md +++ b/generated/cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.md @@ -55,23 +55,6 @@ * **ApiVersion**: 2021-10-01 * **Output**: [ApiKeys](#apikeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): Client App Id associated with this identity. -* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this Identity. - ## AccountProperties ### Properties * **allowedFqdnList**: string[]: Array of AccountPropertiesAllowedFqdnListItem @@ -97,6 +80,21 @@ * **skuChangeInfo**: [SkuChangeInfo](#skuchangeinfo) (ReadOnly): Sku change info of account. * **userOwnedStorage**: [UserOwnedStorage](#userownedstorage)[]: The storage accounts for this resource. +## AccountPropertiesEndpoints +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AccountTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApiKeys +### Properties +* **key1**: string (ReadOnly): Gets the value of key 1. +* **key2**: string (ReadOnly): Gets the value of key 2. + ## ApiProperties ### Properties * **aadClientId**: string: (Metrics Advisor Only) The Azure AD Client Id (Application Id). @@ -118,30 +116,66 @@ * **renewalPeriod**: int: The renewal period in seconds of Call Rate Limit. * **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## ThrottlingRule +## CommitmentPeriod ### Properties -* **count**: int -* **dynamicThrottlingEnabled**: bool -* **key**: string -* **matchPatterns**: [RequestMatchPattern](#requestmatchpattern)[]: Array of RequestMatchPattern -* **minCount**: int -* **renewalPeriod**: int +* **count**: int: Commitment period commitment count. +* **endDate**: string (ReadOnly): Commitment period end date. +* **quota**: [CommitmentQuota](#commitmentquota) (ReadOnly): Cognitive Services account commitment quota. +* **startDate**: string (ReadOnly): Commitment period start date. +* **tier**: string: Commitment period commitment tier. -## RequestMatchPattern +## CommitmentPlanProperties ### Properties -* **method**: string -* **path**: string +* **autoRenew**: bool: AutoRenew commitment plan. +* **current**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. +* **hostingModel**: 'ConnectedContainer' | 'DisconnectedContainer' | 'Web' | string: Account hosting model. +* **last**: [CommitmentPeriod](#commitmentperiod) (ReadOnly): Cognitive Services account commitment period. +* **next**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. +* **planType**: string: Commitment plan type. -## SkuCapability +## CommitmentQuota ### Properties -* **name**: string: The name of the SkuCapability. -* **value**: string: The value of the SkuCapability. +* **quantity**: int: Commitment quota quantity. +* **unit**: string: Commitment quota unit. + +## DeploymentModel +### Properties +* **format**: string: Deployment model format. +* **name**: string: Deployment model name. +* **version**: string: Deployment model version. + +## DeploymentProperties +### Properties +* **model**: [DeploymentModel](#deploymentmodel): Properties of Cognitive Services account deployment model. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Gets the status of the resource at the time the operation was called. +* **scaleSettings**: [DeploymentScaleSettings](#deploymentscalesettings): Properties of Cognitive Services account deployment model. + +## DeploymentScaleSettings +### Properties +* **capacity**: int: Deployment capacity. +* **scaleType**: 'Manual' | string: Deployment scale type. ## Encryption ### Properties * **keySource**: 'Microsoft.CognitiveServices' | 'Microsoft.KeyVault' | string: Enumerates the possible value of keySource for Encryption * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## IpRule +### Properties +* **value**: string (Required): 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). + ## KeyVaultProperties ### Properties * **identityClientId**: string @@ -149,26 +183,15 @@ * **keyVaultUri**: string: Uri of KeyVault * **keyVersion**: string: Version of the Key from KeyVault -## AccountPropertiesEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## NetworkRuleSet ### Properties * **defaultAction**: 'Allow' | 'Deny' | string: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. * **ipRules**: [IpRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IpRule -### Properties -* **value**: string (Required): 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). - -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. -* **state**: string: Gets the state of virtual network rule. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -187,41 +210,22 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## QuotaLimit ### Properties * **count**: int * **renewalPeriod**: int * **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## SkuChangeInfo -### Properties -* **countOfDowngrades**: int: Gets the count of downgrades. -* **countOfUpgradesAfterDowngrades**: int: Gets the count of upgrades after downgrades. -* **lastChangeDate**: string: Gets the last change date. - -## UserOwnedStorage +## RequestMatchPattern ### Properties -* **identityClientId**: string -* **resourceId**: string: Full resource id of a Microsoft.Storage resource. +* **method**: string +* **path**: string ## Sku ### Properties @@ -231,52 +235,48 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Enterprise' | 'Free' | 'Premium' | 'Standard' | string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. -## AccountTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CommitmentPlanProperties +## SkuCapability ### Properties -* **autoRenew**: bool: AutoRenew commitment plan. -* **current**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. -* **hostingModel**: 'ConnectedContainer' | 'DisconnectedContainer' | 'Web' | string: Account hosting model. -* **last**: [CommitmentPeriod](#commitmentperiod) (ReadOnly): Cognitive Services account commitment period. -* **next**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. -* **planType**: string: Commitment plan type. +* **name**: string: The name of the SkuCapability. +* **value**: string: The value of the SkuCapability. -## CommitmentPeriod +## SkuChangeInfo ### Properties -* **count**: int: Commitment period commitment count. -* **endDate**: string (ReadOnly): Commitment period end date. -* **quota**: [CommitmentQuota](#commitmentquota) (ReadOnly): Cognitive Services account commitment quota. -* **startDate**: string (ReadOnly): Commitment period start date. -* **tier**: string: Commitment period commitment tier. +* **countOfDowngrades**: int: Gets the count of downgrades. +* **countOfUpgradesAfterDowngrades**: int: Gets the count of upgrades after downgrades. +* **lastChangeDate**: string: Gets the last change date. -## CommitmentQuota +## SystemData ### Properties -* **quantity**: int: Commitment quota quantity. -* **unit**: string: Commitment quota unit. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DeploymentProperties +## ThrottlingRule ### Properties -* **model**: [DeploymentModel](#deploymentmodel): Properties of Cognitive Services account deployment model. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Gets the status of the resource at the time the operation was called. -* **scaleSettings**: [DeploymentScaleSettings](#deploymentscalesettings): Properties of Cognitive Services account deployment model. +* **count**: int +* **dynamicThrottlingEnabled**: bool +* **key**: string +* **matchPatterns**: [RequestMatchPattern](#requestmatchpattern)[]: Array of RequestMatchPattern +* **minCount**: int +* **renewalPeriod**: int -## DeploymentModel +## UserAssignedIdentity ### Properties -* **format**: string: Deployment model format. -* **name**: string: Deployment model name. -* **version**: string: Deployment model version. +* **clientId**: string (ReadOnly): Client App Id associated with this identity. +* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this Identity. -## DeploymentScaleSettings +## UserOwnedStorage ### Properties -* **capacity**: int: Deployment capacity. -* **scaleType**: 'Manual' | string: Deployment scale type. +* **identityClientId**: string +* **resourceId**: string: Full resource id of a Microsoft.Storage resource. -## ApiKeys +## VirtualNetworkRule ### Properties -* **key1**: string (ReadOnly): Gets the value of key 1. -* **key2**: string (ReadOnly): Gets the value of key 2. +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. +* **state**: string: Gets the state of virtual network rule. diff --git a/generated/cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.md b/generated/cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.md index 7a9f4460e6..0f1a4676d6 100644 --- a/generated/cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.md +++ b/generated/cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.md @@ -55,23 +55,6 @@ * **ApiVersion**: 2022-03-01 * **Output**: [ApiKeys](#apikeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): Client App Id associated with this identity. -* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this Identity. - ## AccountProperties ### Properties * **allowedFqdnList**: string[]: Array of AccountPropertiesAllowedFqdnListItem @@ -100,6 +83,21 @@ * **skuChangeInfo**: [SkuChangeInfo](#skuchangeinfo) (ReadOnly): Sku change info of account. * **userOwnedStorage**: [UserOwnedStorage](#userownedstorage)[]: The storage accounts for this resource. +## AccountPropertiesEndpoints +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AccountTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApiKeys +### Properties +* **key1**: string (ReadOnly): Gets the value of key 1. +* **key2**: string (ReadOnly): Gets the value of key 2. + ## ApiProperties ### Properties * **aadClientId**: string: (Metrics Advisor Only) The Azure AD Client Id (Application Id). @@ -121,30 +119,67 @@ * **renewalPeriod**: int: The renewal period in seconds of Call Rate Limit. * **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## ThrottlingRule +## CommitmentPeriod ### Properties -* **count**: int -* **dynamicThrottlingEnabled**: bool -* **key**: string -* **matchPatterns**: [RequestMatchPattern](#requestmatchpattern)[]: Array of RequestMatchPattern -* **minCount**: int -* **renewalPeriod**: int +* **count**: int: Commitment period commitment count. +* **endDate**: string (ReadOnly): Commitment period end date. +* **quota**: [CommitmentQuota](#commitmentquota) (ReadOnly): Cognitive Services account commitment quota. +* **startDate**: string (ReadOnly): Commitment period start date. +* **tier**: string: Commitment period commitment tier. -## RequestMatchPattern +## CommitmentPlanProperties ### Properties -* **method**: string -* **path**: string +* **autoRenew**: bool: AutoRenew commitment plan. +* **current**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. +* **hostingModel**: 'ConnectedContainer' | 'DisconnectedContainer' | 'Web' | string: Account hosting model. +* **last**: [CommitmentPeriod](#commitmentperiod) (ReadOnly): Cognitive Services account commitment period. +* **next**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. +* **planType**: string: Commitment plan type. -## SkuCapability +## CommitmentQuota ### Properties -* **name**: string: The name of the SkuCapability. -* **value**: string: The value of the SkuCapability. +* **quantity**: int: Commitment quota quantity. +* **unit**: string: Commitment quota unit. + +## DeploymentModel +### Properties +* **format**: string: Deployment model format. +* **name**: string: Deployment model name. +* **version**: string: Deployment model version. + +## DeploymentProperties +### Properties +* **model**: [DeploymentModel](#deploymentmodel): Properties of Cognitive Services account deployment model. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Gets the status of the resource at the time the operation was called. +* **scaleSettings**: [DeploymentScaleSettings](#deploymentscalesettings): Properties of Cognitive Services account deployment model. + +## DeploymentScaleSettings +### Properties +* **activeCapacity**: int (ReadOnly): Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. +* **capacity**: int: Deployment capacity. +* **scaleType**: 'Manual' | string: Deployment scale type. ## Encryption ### Properties * **keySource**: 'Microsoft.CognitiveServices' | 'Microsoft.KeyVault' | string: Enumerates the possible value of keySource for Encryption * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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} + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## IpRule +### Properties +* **value**: string (Required): 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). + ## KeyVaultProperties ### Properties * **identityClientId**: string @@ -152,26 +187,15 @@ * **keyVaultUri**: string: Uri of KeyVault * **keyVersion**: string: Version of the Key from KeyVault -## AccountPropertiesEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## NetworkRuleSet ### Properties * **defaultAction**: 'Allow' | 'Deny' | string: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. * **ipRules**: [IpRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IpRule -### Properties -* **value**: string (Required): 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). - -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. -* **state**: string: Gets the state of virtual network rule. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -190,41 +214,22 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## QuotaLimit ### Properties * **count**: int * **renewalPeriod**: int * **rules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## SkuChangeInfo -### Properties -* **countOfDowngrades**: int: Gets the count of downgrades. -* **countOfUpgradesAfterDowngrades**: int: Gets the count of upgrades after downgrades. -* **lastChangeDate**: string: Gets the last change date. - -## UserOwnedStorage +## RequestMatchPattern ### Properties -* **identityClientId**: string -* **resourceId**: string: Full resource id of a Microsoft.Storage resource. +* **method**: string +* **path**: string ## Sku ### Properties @@ -234,53 +239,48 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Enterprise' | 'Free' | 'Premium' | 'Standard' | string: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. -## AccountTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CommitmentPlanProperties +## SkuCapability ### Properties -* **autoRenew**: bool: AutoRenew commitment plan. -* **current**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. -* **hostingModel**: 'ConnectedContainer' | 'DisconnectedContainer' | 'Web' | string: Account hosting model. -* **last**: [CommitmentPeriod](#commitmentperiod) (ReadOnly): Cognitive Services account commitment period. -* **next**: [CommitmentPeriod](#commitmentperiod): Cognitive Services account commitment period. -* **planType**: string: Commitment plan type. +* **name**: string: The name of the SkuCapability. +* **value**: string: The value of the SkuCapability. -## CommitmentPeriod +## SkuChangeInfo ### Properties -* **count**: int: Commitment period commitment count. -* **endDate**: string (ReadOnly): Commitment period end date. -* **quota**: [CommitmentQuota](#commitmentquota) (ReadOnly): Cognitive Services account commitment quota. -* **startDate**: string (ReadOnly): Commitment period start date. -* **tier**: string: Commitment period commitment tier. +* **countOfDowngrades**: int: Gets the count of downgrades. +* **countOfUpgradesAfterDowngrades**: int: Gets the count of upgrades after downgrades. +* **lastChangeDate**: string: Gets the last change date. -## CommitmentQuota +## SystemData ### Properties -* **quantity**: int: Commitment quota quantity. -* **unit**: string: Commitment quota unit. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DeploymentProperties +## ThrottlingRule ### Properties -* **model**: [DeploymentModel](#deploymentmodel): Properties of Cognitive Services account deployment model. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Gets the status of the resource at the time the operation was called. -* **scaleSettings**: [DeploymentScaleSettings](#deploymentscalesettings): Properties of Cognitive Services account deployment model. +* **count**: int +* **dynamicThrottlingEnabled**: bool +* **key**: string +* **matchPatterns**: [RequestMatchPattern](#requestmatchpattern)[]: Array of RequestMatchPattern +* **minCount**: int +* **renewalPeriod**: int -## DeploymentModel +## UserAssignedIdentity ### Properties -* **format**: string: Deployment model format. -* **name**: string: Deployment model name. -* **version**: string: Deployment model version. +* **clientId**: string (ReadOnly): Client App Id associated with this identity. +* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this Identity. -## DeploymentScaleSettings +## UserOwnedStorage ### Properties -* **activeCapacity**: int (ReadOnly): Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. -* **capacity**: int: Deployment capacity. -* **scaleType**: 'Manual' | string: Deployment scale type. +* **identityClientId**: string +* **resourceId**: string: Full resource id of a Microsoft.Storage resource. -## ApiKeys +## VirtualNetworkRule ### Properties -* **key1**: string (ReadOnly): Gets the value of key 1. -* **key2**: string (ReadOnly): Gets the value of key 2. +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Ignore missing vnet service endpoint or not. +* **state**: string: Gets the state of virtual network rule. diff --git a/generated/commerce/log.out b/generated/commerce/log.out index 3fc1562d3e..4836fe4266 100644 --- a/generated/commerce/log.out +++ b/generated/commerce/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.commerce-2015-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'InfoField' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json:152:5 @@ -39,5 +39,5 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'OfferTermInfo' (6 d - enum: => ["Recurring Charge","Monetary Commitment","Monetary Credit"] - x-ms-enum: => {"name":"OfferTermInfo","modelAsString":false} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'OfferTermInfo' -> 'OfferTermInfoAutoGenerated' -info | autorest.bicep took 1ms -info | Autorest completed in 4.48s. 0 files generated. +info | autorest.bicep took 0ms +info | Autorest completed in 4.47s. 0 files generated. diff --git a/generated/communication/log.out b/generated/communication/log.out index cafa0087bf..c76e8b6fe0 100644 --- a/generated/communication/log.out +++ b/generated/communication/log.out @@ -3,19 +3,19 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.communication-2020-08-20"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.communication-2020-08-20-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse-error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json:646:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Autorest completed in 6.48s. 4 files generated. diff --git a/generated/communication/microsoft.communication/2020-08-20-preview/types.md b/generated/communication/microsoft.communication/2020-08-20-preview/types.md index d014a9fbb0..dbb03d6a44 100644 --- a/generated/communication/microsoft.communication/2020-08-20-preview/types.md +++ b/generated/communication/microsoft.communication/2020-08-20-preview/types.md @@ -16,6 +16,13 @@ * **ApiVersion**: 2020-08-20-preview * **Output**: [CommunicationServiceKeys](#communicationservicekeys) +## CommunicationServiceKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + ## CommunicationServiceProperties ### Properties * **dataLocation**: string (Required): The location where the communication service stores its data at rest. @@ -30,10 +37,3 @@ ### Additional Properties * **Additional Properties Type**: string -## CommunicationServiceKeys -### Properties -* **primaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. - diff --git a/generated/communication/microsoft.communication/2020-08-20/types.md b/generated/communication/microsoft.communication/2020-08-20/types.md index cafc99c612..935dfe88db 100644 --- a/generated/communication/microsoft.communication/2020-08-20/types.md +++ b/generated/communication/microsoft.communication/2020-08-20/types.md @@ -17,6 +17,13 @@ * **ApiVersion**: 2020-08-20 * **Output**: [CommunicationServiceKeys](#communicationservicekeys) +## CommunicationServiceKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + ## CommunicationServiceProperties ### Properties * **dataLocation**: string (Required): The location where the communication service stores its data at rest. @@ -40,10 +47,3 @@ ### Additional Properties * **Additional Properties Type**: string -## CommunicationServiceKeys -### Properties -* **primaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): CommunicationService connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. - diff --git a/generated/compute/log.out b/generated/compute/log.out index a289bceee6..9d8dec97bf 100644 --- a/generated/compute/log.out +++ b/generated/compute/log.out @@ -51,7 +51,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.compute-2021-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -102,7 +102,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RestorePointCollectionSourceProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json:9700:5 @@ -622,7 +622,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 41ms +info | autorest.bicep took 56ms info | Processing batch task - {"tag":"microsoft.compute-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -673,7 +673,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceSkuCapacity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/skus.json:89:5 @@ -1394,7 +1394,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 37ms +info | autorest.bicep took 42ms info | Processing batch task - {"tag":"microsoft.compute-2021-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1445,7 +1445,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-12-01/disk.json:1858:5 @@ -1560,7 +1560,7 @@ warning | PreCheck/SchemaMissingType | The schema 'InnerError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'ExtendedLocation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-12-01/disk.json:3744:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.compute-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1611,7 +1611,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Gallery' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json:1735:5 @@ -1724,7 +1724,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SharingUpdate' with an undefi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'SharingProfile-communityGalleryInfo' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json#/components/schemas/SharingProfile-communityGalleryInfo -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.compute-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1775,7 +1775,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/BinarySchema | 'The schema paths·1djjsnh·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-compute-cloudservices-cloudservicename-roleinstances-roleinstancename-remotedesktopfile·get·responses·200·content·application-x_rdp·schema with 'type: file', format: binary' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/cloudService.json:465:11 @@ -2308,7 +2308,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 28ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.compute-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2359,7 +2359,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json:1852:5 @@ -2474,7 +2474,7 @@ warning | PreCheck/SchemaMissingType | The schema 'InnerError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'ExtendedLocation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json:3692:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.compute-2021-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2525,7 +2525,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/disk.json:1834:5 @@ -3157,7 +3157,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 41ms +info | autorest.bicep took 32ms info | Processing batch task - {"tag":"microsoft.compute-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3208,10 +3208,10 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.compute-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3262,7 +3262,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceSkuCapacity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json:83:5 @@ -3283,7 +3283,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkuRestrictionInfo' w warning | PreCheck/SchemaMissingType | The schema 'ResourceSkusResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-04-01/skus.json:354:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.compute-2020-09-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3334,7 +3334,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Gallery' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-09-30/gallery.json:1711:5 @@ -3770,7 +3770,7 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CloudError' -> warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ApiError' -> 'ApiErrorAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ApiError' -> 'ApiErrorAutoGenerated2' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ApiError' -> 'ApiErrorAutoGenerated3' -info | autorest.bicep took 10ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.compute-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3821,7 +3821,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/disk.json:1825:5 @@ -4411,7 +4411,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 24ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.compute-2019-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4462,7 +4462,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Gallery' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/gallery.json:1608:5 @@ -4969,7 +4969,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 22ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.compute-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5020,7 +5020,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComputeOperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json:6403:5 @@ -5477,7 +5477,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 23ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.containerservice-2017-01-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5528,7 +5528,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json:268:5 @@ -5612,7 +5612,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/BinarySchema | 'The schema paths·1djjsnh·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-compute-cloudservices-cloudservicename-roleinstances-roleinstancename-remotedesktopfile·get·responses·200·content·application-x_rdp·schema with 'type: file', format: binary' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/preview/2020-10-01-preview/cloudService.json:434:11 @@ -5668,7 +5668,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-30/disk.json:1349:5 @@ -5763,7 +5763,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ApiErrorBase' with an undefin warning | PreCheck/SchemaMissingType | The schema 'InnerError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-30/disk.json:2684:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.compute-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5814,7 +5814,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json:1301:5 @@ -5907,7 +5907,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ApiErrorBase' with an undefin warning | PreCheck/SchemaMissingType | The schema 'InnerError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json:2574:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.compute-2019-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5958,7 +5958,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-11-01/disk.json:972:5 @@ -6029,7 +6029,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ApiErrorBase' with an undefin warning | PreCheck/SchemaMissingType | The schema 'InnerError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-11-01/disk.json:1946:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.compute-2019-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6080,7 +6080,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComputeOperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json:5714:5 @@ -6631,7 +6631,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 22ms +info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.compute-2019-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6682,7 +6682,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComputeOperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json:5203:5 @@ -7187,7 +7187,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 22ms +info | autorest.bicep took 25ms info | Processing batch task - {"tag":"microsoft.compute-2018-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -7238,7 +7238,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComputeOperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json:4586:5 @@ -7587,7 +7587,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 11ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.compute-2017-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -7638,7 +7638,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceSkuCapacity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2017-09-01/skus.json:73:5 @@ -7708,7 +7708,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2018-09-30/disk.json:690:5 @@ -7806,7 +7806,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Gallery' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json:785:5 @@ -8255,7 +8255,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 20ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.compute-2018-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -8306,7 +8306,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComputeOperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json:4464:5 @@ -8679,7 +8679,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.compute-2017-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -8730,7 +8730,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComputeOperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json:4383:5 @@ -9069,7 +9069,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.compute-2017-03-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -9120,7 +9120,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json:696:5 @@ -9485,7 +9485,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 15ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.containerservice-2016-09-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -9536,7 +9536,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json:225:5 @@ -9620,7 +9620,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'InstanceViewStatus' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json:3124:5 @@ -9897,7 +9897,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 10ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.compute-2016-03-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -9948,7 +9948,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'InstanceViewStatus' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json:2742:5 @@ -10208,7 +10208,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json:220:5 @@ -10288,7 +10288,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json:212:5 @@ -10368,7 +10368,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'InstanceViewStatus' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json:2661:5 @@ -10571,5 +10571,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms -info | Autorest completed in 258.96s. 60 files generated. +info | autorest.bicep took 6ms +info | Autorest completed in 251.72s. 60 files generated. diff --git a/generated/compute/microsoft.compute/2015-06-15/types.md b/generated/compute/microsoft.compute/2015-06-15/types.md index 5d0c218917..4cde11d184 100644 --- a/generated/compute/microsoft.compute/2015-06-15/types.md +++ b/generated/compute/microsoft.compute/2015-06-15/types.md @@ -47,6 +47,17 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -54,99 +65,74 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## InstanceViewStatus -### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. - -## SubResource -### Properties -* **id**: string: Resource Id - -## ResourceTags +## BootDiagnostics ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## Plan +## BootDiagnosticsInstanceView ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -## VirtualMachineProperties +## DataDisk ### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **name**: string (Required): The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. ## DiagnosticsProfile ### Properties * **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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 -### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. - -## HardwareProfile +## DiskEncryptionSettings ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | 'Standard_A1' | 'Standard_A10' | 'Standard_A11' | 'Standard_A2' | 'Standard_A3' | 'Standard_A4' | 'Standard_A5' | 'Standard_A6' | 'Standard_A7' | 'Standard_A8' | 'Standard_A9' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS12' | 'Standard_DS13' | 'Standard_DS14' | 'Standard_DS2' | 'Standard_DS3' | 'Standard_DS4' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | string: 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) +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference) (Required): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## VirtualMachineInstanceView +## DiskInstanceView ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **name**: string: The disk name. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## BootDiagnosticsInstanceView +## HardwareProfile ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | 'Standard_A1' | 'Standard_A10' | 'Standard_A11' | 'Standard_A2' | 'Standard_A3' | 'Standard_A4' | 'Standard_A5' | 'Standard_A6' | 'Standard_A7' | 'Standard_A8' | 'Standard_A9' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS12' | 'Standard_DS13' | 'Standard_DS14' | 'Standard_DS2' | 'Standard_DS3' | 'Standard_DS4' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | string: 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) -## DiskInstanceView +## ImageReference ### Properties -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## VirtualMachineExtensionInstanceView +## InstanceViewStatus ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## VirtualMachineAgentInstanceView +## KeyVaultKeyReference ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## VirtualMachineExtensionHandlerInstanceView +## KeyVaultSecretReference ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## NetworkProfile +## LinuxConfiguration ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure ## NetworkInterfaceReference ### Properties @@ -157,6 +143,21 @@ ### Properties * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **name**: string (Required): The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. + ## OSProfile ### Properties * **adminPassword**: string: 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) @@ -167,53 +168,52 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ResourceTags ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +### Additional Properties +* **Additional Properties Type**: string -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
} +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +### Additional Properties +* **Additional Properties Type**: string -## AdditionalUnattendContent +## Sku ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** -## WinRMConfiguration +## SshConfiguration ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## WinRMListener +## SshPublicKey ### Properties -* **certificateUrl**: 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":""
} -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -221,53 +221,33 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **name**: string (Required): The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. - -## VirtualHardDisk +## SubResource ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **id**: string: Resource Id -## ImageReference +## UpgradePolicy ### Properties -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **mode**: 'Automatic' | 'Manual': 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. -## OSDisk +## VaultCertificate ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **name**: string (Required): The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
} -## DiskEncryptionSettings +## VaultSecretGroup ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference) (Required): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## KeyVaultSecretReference +## VirtualHardDisk ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **uri**: string: Specifies the virtual hard disk's uri. -## KeyVaultKeyReference +## VirtualMachineAgentInstanceView ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -278,6 +258,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -290,42 +284,28 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetProperties -### Properties -* **overProvision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **provisioningState**: string: The provisioning state, which only appears in the response. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic or manual. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. - -## UpgradePolicy -### Properties -* **mode**: 'Automatic' | 'Manual': 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. - -## VirtualMachineScaleSetVMProfile +## VirtualMachineInstanceView ### Properties -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineProperties ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: 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 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. ## VirtualMachineScaleSetExtension ### Properties @@ -333,6 +313,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: Whether the extension handler should be automatically upgraded across minor versions. @@ -343,9 +327,17 @@ * **type**: string: The type of the extension handler. * **typeHandlerVersion**: string: The type version of the extension handler. -## VirtualMachineScaleSetNetworkProfile +## VirtualMachineScaleSetIPConfiguration ### Properties -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +* **id**: string: Resource Id +* **name**: string (Required): The IP configuration name. +* **properties**: [VirtualMachineScaleSetIPConfigurationProperties](#virtualmachinescalesetipconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration properties. + +## VirtualMachineScaleSetIPConfigurationProperties +### Properties +* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: The load balancer backend address pools. +* **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: The load balancer inbound nat pools. +* **subnet**: [ApiEntityReference](#apientityreference) (Required): The API entity reference. ## VirtualMachineScaleSetNetworkConfiguration ### Properties @@ -358,21 +350,18 @@ * **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): The virtual machine scale set IP Configuration. * **primary**: bool: Whether this is a primary NIC on a virtual machine. -## VirtualMachineScaleSetIPConfiguration -### Properties -* **id**: string: Resource Id -* **name**: string (Required): The IP configuration name. -* **properties**: [VirtualMachineScaleSetIPConfigurationProperties](#virtualmachinescalesetipconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration properties. - -## VirtualMachineScaleSetIPConfigurationProperties +## VirtualMachineScaleSetNetworkProfile ### Properties -* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: The load balancer backend address pools. -* **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: The load balancer inbound nat pools. -* **subnet**: [ApiEntityReference](#apientityreference) (Required): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## ApiEntityReference +## VirtualMachineScaleSetOSDisk ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **name**: string (Required): The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhdContainers**: string[]: The list of virtual hard disk container uris. ## VirtualMachineScaleSetOSProfile ### Properties @@ -384,28 +373,39 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The List of certificates for addition to the VM. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +## VirtualMachineScaleSetProperties +### Properties +* **overProvision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **provisioningState**: string: The provisioning state, which only appears in the response. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic or manual. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. + ## VirtualMachineScaleSetStorageProfile ### Properties * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetOSDisk +## VirtualMachineScaleSetVMProfile ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **name**: string (Required): The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhdContainers**: string[]: The list of virtual hard disk container uris. +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## Sku +## WindowsConfiguration ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
} +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** diff --git a/generated/compute/microsoft.compute/2016-03-30/types.md b/generated/compute/microsoft.compute/2016-03-30/types.md index 77c706daf5..b982ed6a01 100644 --- a/generated/compute/microsoft.compute/2016-03-30/types.md +++ b/generated/compute/microsoft.compute/2016-03-30/types.md @@ -49,6 +49,17 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -56,106 +67,74 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## InstanceViewStatus -### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. - -## SubResource -### Properties -* **id**: string: Resource Id - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineIdentity +## BootDiagnostics ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. -* **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## Plan +## BootDiagnosticsInstanceView ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -## VirtualMachineProperties +## DataDisk ### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **name**: string (Required): The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. ## DiagnosticsProfile ### Properties * **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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 -### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. - -## HardwareProfile +## DiskEncryptionSettings ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | 'Standard_A1' | 'Standard_A10' | 'Standard_A11' | 'Standard_A2' | 'Standard_A3' | 'Standard_A4' | 'Standard_A5' | 'Standard_A6' | 'Standard_A7' | 'Standard_A8' | 'Standard_A9' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | string: 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) +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## VirtualMachineInstanceView +## DiskInstanceView ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **name**: string: The disk name. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## BootDiagnosticsInstanceView +## HardwareProfile ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | 'Standard_A1' | 'Standard_A10' | 'Standard_A11' | 'Standard_A2' | 'Standard_A3' | 'Standard_A4' | 'Standard_A5' | 'Standard_A6' | 'Standard_A7' | 'Standard_A8' | 'Standard_A9' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | string: 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) -## DiskInstanceView +## ImageReference ### Properties -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## VirtualMachineExtensionInstanceView +## InstanceViewStatus ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## VirtualMachineAgentInstanceView +## KeyVaultKeyReference ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## VirtualMachineExtensionHandlerInstanceView +## KeyVaultSecretReference ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## NetworkProfile +## LinuxConfiguration ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure ## NetworkInterfaceReference ### Properties @@ -166,6 +145,21 @@ ### Properties * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **name**: string (Required): The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. + ## OSProfile ### Properties * **adminPassword**: string: 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) @@ -176,53 +170,52 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ResourceTags ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +### Additional Properties +* **Additional Properties Type**: string -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
} +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +### Additional Properties +* **Additional Properties Type**: string -## AdditionalUnattendContent +## Sku ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** -## WinRMConfiguration +## SshConfiguration ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## WinRMListener +## SshPublicKey ### Properties -* **certificateUrl**: 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":""
} -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -230,53 +223,33 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **name**: string (Required): The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. - -## VirtualHardDisk +## SubResource ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **id**: string: Resource Id -## ImageReference +## UpgradePolicy ### Properties -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **mode**: 'Automatic' | 'Manual': 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. -## OSDisk +## VaultCertificate ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **name**: string (Required): The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk) (Required): Describes the uri of a disk. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
} -## DiskEncryptionSettings +## VaultSecretGroup ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## KeyVaultSecretReference +## VirtualHardDisk ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **uri**: string: Specifies the virtual hard disk's uri. -## KeyVaultKeyReference +## VirtualMachineAgentInstanceView ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -287,6 +260,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -299,48 +286,35 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. * **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. -## VirtualMachineScaleSetProperties -### Properties -* **overProvision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic or manual. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. - -## UpgradePolicy -### Properties -* **mode**: 'Automatic' | 'Manual': 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. - -## VirtualMachineScaleSetVMProfile +## VirtualMachineInstanceView ### Properties -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineProperties ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: 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 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ## VirtualMachineScaleSetExtension ### Properties @@ -348,6 +322,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: Whether the extension handler should be automatically upgraded across minor versions. @@ -358,20 +336,11 @@ * **type**: string: The type of the extension handler. * **typeHandlerVersion**: string: The type version of the extension handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## VirtualMachineScaleSetNetworkConfiguration -### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. - -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentity ### Properties -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): The virtual machine scale set IP Configuration. -* **primary**: bool: Whether this is a primary NIC on a virtual machine. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. +* **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -386,9 +355,29 @@ * **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: The load balancer inbound nat pools. * **subnet**: [ApiEntityReference](#apientityreference) (Required): The API entity reference. -## ApiEntityReference +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. + +## VirtualMachineScaleSetNetworkConfigurationProperties +### Properties +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): The virtual machine scale set IP Configuration. +* **primary**: bool: Whether this is a primary NIC on a virtual machine. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. + +## VirtualMachineScaleSetOSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **name**: string (Required): The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhdContainers**: string[]: The list of virtual hard disk container uris. ## VirtualMachineScaleSetOSProfile ### Properties @@ -400,28 +389,39 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The List of certificates for addition to the VM. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +## VirtualMachineScaleSetProperties +### Properties +* **overProvision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic or manual. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. + ## VirtualMachineScaleSetStorageProfile ### Properties * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetOSDisk +## VirtualMachineScaleSetVMProfile ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **name**: string (Required): The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhdContainers**: string[]: The list of virtual hard disk container uris. +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## Sku +## WindowsConfiguration ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
} +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** diff --git a/generated/compute/microsoft.compute/2016-04-30-preview/types.md b/generated/compute/microsoft.compute/2016-04-30-preview/types.md index 62a6648610..5adaec854c 100644 --- a/generated/compute/microsoft.compute/2016-04-30-preview/types.md +++ b/generated/compute/microsoft.compute/2016-04-30-preview/types.md @@ -84,6 +84,17 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + ## AvailabilitySetProperties ### Properties * **managed**: bool: If the availability set supports managed disks. @@ -92,28 +103,49 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## InstanceViewStatus +## BootDiagnostics ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## SubResource +## BootDiagnosticsInstanceView ### Properties -* **id**: string: Resource Id +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -## Sku +## CreationData ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' (Required): This enumerates the possible sources of a disk's creation. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **sourceResourceId**: 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. +* **sourceUri**: 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. +* **storageAccountId**: 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 -## ResourceTags +## DataDisk ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. + +## DiagnosticsProfile +### Properties +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. + +## DiskEncryptionSettings +### Properties +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DiskProperties ### Properties @@ -126,54 +158,15 @@ * **provisioningState**: string (ReadOnly): The disk provisioning state. * **timeCreated**: string (ReadOnly): The time when the disk was created. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' (Required): This enumerates the possible sources of a disk's creation. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **sourceResourceId**: 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. -* **sourceUri**: 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. -* **storageAccountId**: 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 - -## ImageDiskReference -### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. - ## EncryptionSettings ### Properties * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **enabled**: bool: 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. * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference -### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault -### Properties -* **id**: string: Resource Id - -## KeyVaultAndKeyReference -### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ImageProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. - -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk) (Required): Describes an Operating System disk. +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | 'Standard_A1' | 'Standard_A10' | 'Standard_A11' | 'Standard_A2' | 'Standard_A3' | 'Standard_A4' | 'Standard_A5' | 'Standard_A6' | 'Standard_A7' | 'Standard_A8' | 'Standard_A9' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | string: 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) ## ImageDataDisk ### Properties @@ -184,6 +177,11 @@ * **managedDisk**: [SubResource](#subresource) * **snapshot**: [SubResource](#subresource) +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -194,108 +192,87 @@ * **osType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. * **snapshot**: [SubResource](#subresource) -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineIdentity +## ImageProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. -* **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## Plan +## ImageReference ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## VirtualMachineProperties +## ImageStorageProfile ### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk) (Required): Describes an Operating System disk. -## DiagnosticsProfile +## InstanceViewStatus ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## BootDiagnostics +## KeyVaultAndKeyReference ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## HardwareProfile +## KeyVaultAndSecretReference ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | 'Standard_A1' | 'Standard_A10' | 'Standard_A11' | 'Standard_A2' | 'Standard_A3' | 'Standard_A4' | 'Standard_A5' | 'Standard_A6' | 'Standard_A7' | 'Standard_A8' | 'Standard_A9' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | string: 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) +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## VirtualMachineInstanceView +## KeyVaultKeyReference ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## BootDiagnosticsInstanceView +## KeyVaultSecretReference ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## DiskInstanceView +## LinuxConfiguration ### Properties -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## VirtualMachineExtensionInstanceView +## ManagedDiskParameters ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. -## VirtualMachineAgentInstanceView +## NetworkInterfaceReference ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## VirtualMachineExtensionHandlerInstanceView +## NetworkInterfaceReferenceProperties ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. ## NetworkProfile ### Properties * **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. -## NetworkInterfaceReference -### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. - -## NetworkInterfaceReferenceProperties +## OSDisk ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. ## OSProfile ### Properties @@ -307,53 +284,71 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ResourceTags ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +### Additional Properties +* **Additional Properties Type**: string -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
} +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** -## AdditionalUnattendContent +## SourceVault ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **id**: string: Resource Id -## WinRMConfiguration +## SshConfiguration ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## WinRMListener +## SshPublicKey ### Properties -* **certificateUrl**: 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":""
} -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -361,61 +356,33 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. - -## VirtualHardDisk -### Properties -* **uri**: string: Specifies the virtual hard disk's uri. - -## ManagedDiskParameters +## SubResource ### Properties * **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. -## ImageReference +## UpgradePolicy ### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **mode**: 'Automatic' | 'Manual': 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. -## OSDisk +## VaultCertificate ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
} -## DiskEncryptionSettings +## VaultSecretGroup ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## KeyVaultSecretReference +## VirtualHardDisk ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **uri**: string: Specifies the virtual hard disk's uri. -## KeyVaultKeyReference +## VirtualMachineAgentInstanceView ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -426,6 +393,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -438,49 +419,44 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. * **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. -## VirtualMachineScaleSetProperties -### Properties -* **overProvision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic or manual. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. - -## UpgradePolicy +## VirtualMachineInstanceView ### Properties -* **mode**: 'Automatic' | 'Manual': 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. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: 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 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. ## VirtualMachineScaleSetExtension ### Properties @@ -488,6 +464,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -498,20 +478,11 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## VirtualMachineScaleSetNetworkConfiguration -### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. - -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentity ### Properties -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): The virtual machine scale set IP Configuration. -* **primary**: bool: Whether this is a primary NIC on a virtual machine. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. +* **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -526,9 +497,34 @@ * **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: The load balancer inbound nat pools. * **subnet**: [ApiEntityReference](#apientityreference) (Required): The API entity reference. -## ApiEntityReference +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. + +## VirtualMachineScaleSetNetworkConfiguration +### Properties +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. + +## VirtualMachineScaleSetNetworkConfigurationProperties +### Properties +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): The virtual machine scale set IP Configuration. +* **primary**: bool: Whether this is a primary NIC on a virtual machine. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. + +## VirtualMachineScaleSetOSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhdContainers**: string[]: The list of virtual hard disk container uris. ## VirtualMachineScaleSetOSProfile ### Properties @@ -540,37 +536,41 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The List of certificates for addition to the VM. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +## VirtualMachineScaleSetProperties +### Properties +* **overProvision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic or manual. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. + ## VirtualMachineScaleSetStorageProfile ### Properties * **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: The data disks. * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetVMProfile ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## VirtualMachineScaleSetManagedDiskParameters +## WindowsConfiguration ### Properties -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS': Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## VirtualMachineScaleSetOSDisk +## WinRMConfiguration ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhdContainers**: string[]: The list of virtual hard disk container uris. +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners -## ResourceTags +## WinRMListener ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateUrl**: 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":""
} +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** diff --git a/generated/compute/microsoft.compute/2017-03-30/types.md b/generated/compute/microsoft.compute/2017-03-30/types.md index ce31e656ff..28cd6acd36 100644 --- a/generated/compute/microsoft.compute/2017-03-30/types.md +++ b/generated/compute/microsoft.compute/2017-03-30/types.md @@ -100,6 +100,17 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: 'Microsoft.Compute/virtualMachineScaleSets/extensions' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -107,37 +118,15 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## InstanceViewStatus -### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. - -## SubResource -### Properties -* **id**: string: Resource Id - -## Sku -### Properties -* **capacity**: int: 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. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** - -## ResourceTags +## BootDiagnostics ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## DiskProperties +## BootDiagnosticsInstanceView ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskSizeGB**: int: 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. -* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot -* **osType**: 'Linux' | 'Windows': The Operating System type. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. ## CreationData ### Properties @@ -147,51 +136,56 @@ * **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. * **storageAccountId**: 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 -## ImageDiskReference +## DataDisk ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -## EncryptionSettings +## DiagnosticsProfile ### Properties -* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key -* **enabled**: bool: 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. -* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## KeyVaultAndSecretReference +## DiskEncryptionSettings ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## SourceVault +## DiskInstanceView ### Properties -* **id**: string: Resource Id +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## KeyVaultAndKeyReference +## DiskProperties ### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskSizeGB**: int: 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. +* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot +* **osType**: 'Linux' | 'Windows': The Operating System type. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. ## DiskSku ### Properties * **name**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ImageProperties +## EncryptionSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key +* **enabled**: bool: 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. +* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk) (Required): Describes an Operating System disk. +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | 'Standard_H16' | 'Standard_H16m' | 'Standard_H16mr' | 'Standard_H16r' | 'Standard_H8' | 'Standard_H8m' | 'Standard_L16s' | 'Standard_L32s' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_NC12' | 'Standard_NC24' | 'Standard_NC24r' | 'Standard_NC6' | 'Standard_NV12' | 'Standard_NV24' | 'Standard_NV6' | string: 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) ## ImageDataDisk ### Properties @@ -203,6 +197,11 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -214,101 +213,57 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. -* **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. - -## Plan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. - -## VirtualMachineProperties -### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## DiagnosticsProfile +## ImageProperties ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## BootDiagnostics +## ImageReference ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## HardwareProfile +## ImageStorageProfile ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Standard_G1' | 'Standard_G2' | 'Standard_G3' | 'Standard_G4' | 'Standard_G5' | 'Standard_GS1' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | 'Standard_H16' | 'Standard_H16m' | 'Standard_H16mr' | 'Standard_H16r' | 'Standard_H8' | 'Standard_H8m' | 'Standard_L16s' | 'Standard_L32s' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_NC12' | 'Standard_NC24' | 'Standard_NC24r' | 'Standard_NC6' | 'Standard_NV12' | 'Standard_NV24' | 'Standard_NV6' | string: 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) +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk) (Required): Describes an Operating System disk. -## VirtualMachineInstanceView +## InstanceViewStatus ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## BootDiagnosticsInstanceView +## KeyVaultAndKeyReference ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DiskInstanceView +## KeyVaultAndSecretReference ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DiskEncryptionSettings +## KeyVaultKeyReference ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) ## KeyVaultSecretReference ### Properties * **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. * **sourceVault**: [SubResource](#subresource) (Required) -## KeyVaultKeyReference -### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) - -## VirtualMachineExtensionInstanceView +## LinuxConfiguration ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure ## MaintenanceRedeployStatus ### Properties @@ -320,21 +275,10 @@ * **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. * **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## VirtualMachineAgentInstanceView -### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. - -## VirtualMachineExtensionHandlerInstanceView -### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## NetworkProfile +## ManagedDiskParameters ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. ## NetworkInterfaceReference ### Properties @@ -345,6 +289,22 @@ ### Properties * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The Operating System type. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. + ## OSProfile ### Properties * **adminPassword**: string: 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) @@ -355,53 +315,78 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ResourceTags ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +### Additional Properties +* **Additional Properties Type**: string -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
} +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +### Additional Properties +* **Additional Properties Type**: string -## AdditionalUnattendContent +## ResourceTags ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +### Additional Properties +* **Additional Properties Type**: string -## WinRMConfiguration +## ResourceTags ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +### Additional Properties +* **Additional Properties Type**: string -## WinRMListener +## ResourceTags ### Properties -* **certificateUrl**: 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":""
} -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

Possible values are:
**http**

**https** +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradePolicy +### Properties +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). + +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** + +## SourceVault +### Properties +* **id**: string: Resource Id + +## SshConfiguration +### Properties +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. + +## SshPublicKey +### Properties +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -409,45 +394,35 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk +## SubResource ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **id**: string: Resource Id -## VirtualHardDisk +## UpgradePolicy ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## ManagedDiskParameters +## VaultCertificate ### Properties -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
} -## ImageReference +## VaultSecretGroup ### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The Operating System type. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -458,6 +433,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -470,61 +459,45 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. * **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. -## VirtualMachineScaleSetProperties -### Properties -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. - -## UpgradePolicy -### Properties -* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties +* **availabilitySet**: [SubResource](#subresource) * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. ## VirtualMachineScaleSetExtension ### Properties @@ -532,6 +505,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -543,14 +520,31 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile +## VirtualMachineScaleSetIdentity ### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. +* **type**: 'SystemAssigned': The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. -## ApiEntityReference +## VirtualMachineScaleSetIPConfiguration ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **id**: string: Resource Id +* **name**: string (Required): The IP configuration name. +* **properties**: [VirtualMachineScaleSetIPConfigurationProperties](#virtualmachinescalesetipconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration properties. + +## VirtualMachineScaleSetIPConfigurationProperties +### Properties +* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: 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. +* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: 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. +* **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: 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 +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. + +## VirtualMachineScaleSetManagedDiskParameters +### Properties +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. ## VirtualMachineScaleSetNetworkConfiguration ### Properties @@ -558,6 +552,10 @@ * **name**: string (Required): The network configuration name. * **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +## VirtualMachineScaleSetNetworkConfigurationDnsSettings +### Properties +* **dnsServers**: string[]: List of DNS servers IP addresses + ## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties * **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. @@ -566,49 +564,53 @@ * **networkSecurityGroup**: [SubResource](#subresource) * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetNetworkProfile ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## VirtualMachineScaleSetIPConfiguration +## VirtualMachineScaleSetOSDisk ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The IP configuration name. -* **properties**: [VirtualMachineScaleSetIPConfigurationProperties](#virtualmachinescalesetipconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration properties. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The Operating System type. +* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. -## VirtualMachineScaleSetIPConfigurationProperties +## VirtualMachineScaleSetOSProfile ### Properties -* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: 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. -* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: 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. -* **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: 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 -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. + +## VirtualMachineScaleSetProperties +### Properties +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. ## VirtualMachineScaleSetPublicIPAddressConfiguration ### Properties * **name**: string (Required): The publicIP address configuration name. * **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. - ## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings ### Properties * **domainNameLabel**: string (Required): 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 -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. ## VirtualMachineScaleSetStorageProfile ### Properties @@ -616,31 +618,29 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetVMProfile ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## VirtualMachineScaleSetManagedDiskParameters +## WindowsConfiguration ### Properties -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: The sku name. +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## VirtualMachineScaleSetOSDisk +## WinRMConfiguration ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' (Required): 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. -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The Operating System type. -* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners -## ResourceTags +## WinRMListener ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2017-12-01/types.md b/generated/compute/microsoft.compute/2017-12-01/types.md index 460f265ea3..cac4210359 100644 --- a/generated/compute/microsoft.compute/2017-12-01/types.md +++ b/generated/compute/microsoft.compute/2017-12-01/types.md @@ -88,6 +88,21 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## AutoOSUpgradePolicy +### Properties +* **disableAutoRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -95,40 +110,47 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## InstanceViewStatus +## BootDiagnostics ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## SubResource +## BootDiagnosticsInstanceView ### Properties -* **id**: string: Resource Id +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -## Sku +## DataDisk ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## DiagnosticsProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## ImageProperties +## DiskEncryptionSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## ImageStorageProfile +## DiskInstanceView ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## HardwareProfile +### Properties +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) ## ImageDataDisk ### Properties @@ -151,100 +173,48 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineIdentity -### Properties -* **identityIds**: string[]: 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}'. -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. - -## Plan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. - -## VirtualMachineProperties -### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## DiagnosticsProfile -### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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 -### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. - -## HardwareProfile +## ImageProperties ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## VirtualMachineInstanceView +## ImageReference ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## BootDiagnosticsInstanceView +## ImageStorageProfile ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## DiskInstanceView +## InstanceViewStatus ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## DiskEncryptionSettings +## KeyVaultKeyReference ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) ## KeyVaultSecretReference ### Properties * **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. * **sourceVault**: [SubResource](#subresource) (Required) -## KeyVaultKeyReference -### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) - -## VirtualMachineExtensionInstanceView +## LinuxConfiguration ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure ## MaintenanceRedeployStatus ### Properties @@ -256,21 +226,10 @@ * **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. * **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## VirtualMachineAgentInstanceView -### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. - -## VirtualMachineExtensionHandlerInstanceView -### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## NetworkProfile +## ManagedDiskParameters ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. ## NetworkInterfaceReference ### Properties @@ -281,6 +240,23 @@ ### Properties * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + ## OSProfile ### Properties * **adminPassword**: string: 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) @@ -291,53 +267,69 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ResourceTags ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +### Additional Properties +* **Additional Properties Type**: string -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +### Additional Properties +* **Additional Properties Type**: string -## AdditionalUnattendContent +## ResourceTags ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +### Additional Properties +* **Additional Properties Type**: string -## WinRMConfiguration +## ResourceTags ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +### Additional Properties +* **Additional Properties Type**: string -## WinRMListener +## RollingUpgradePolicy ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). + +## Sku +### Properties +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** + +## SshConfiguration +### Properties +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. + +## SshPublicKey +### Properties +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -345,47 +337,36 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk +## SubResource ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **id**: string: Resource Id -## VirtualHardDisk +## UpgradePolicy ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. +* **autoOSUpgradePolicy**: [AutoOSUpgradePolicy](#autoosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## ManagedDiskParameters +## VaultCertificate ### Properties -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## ImageReference +## VaultSecretGroup ### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -396,6 +377,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -408,71 +403,54 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **identityIds**: string[]: 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}'. -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **identityIds**: string[]: 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}'. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. * **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -## VirtualMachineScaleSetProperties -### Properties -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## UpgradePolicy -### Properties -* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. -* **autoOSUpgradePolicy**: [AutoOSUpgradePolicy](#autoosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutoOSUpgradePolicy -### Properties -* **disableAutoRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. - -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties +* **availabilitySet**: [SubResource](#subresource) * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -480,6 +458,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -491,14 +473,32 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile +## VirtualMachineScaleSetIdentity ### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +* **identityIds**: string[]: 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}'. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -## ApiEntityReference +## VirtualMachineScaleSetIPConfiguration ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **id**: string: Resource Id +* **name**: string (Required): The IP configuration name. +* **properties**: [VirtualMachineScaleSetIPConfigurationProperties](#virtualmachinescalesetipconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration properties. + +## VirtualMachineScaleSetIPConfigurationProperties +### Properties +* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: 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. +* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: 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. +* **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: 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 +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. + +## VirtualMachineScaleSetManagedDiskParameters +### Properties +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. ## VirtualMachineScaleSetNetworkConfiguration ### Properties @@ -506,6 +506,10 @@ * **name**: string (Required): The network configuration name. * **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +## VirtualMachineScaleSetNetworkConfigurationDnsSettings +### Properties +* **dnsServers**: string[]: List of DNS servers IP addresses + ## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties * **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. @@ -515,49 +519,56 @@ * **networkSecurityGroup**: [SubResource](#subresource) * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetNetworkProfile ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## VirtualMachineScaleSetIPConfiguration +## VirtualMachineScaleSetOSDisk ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The IP configuration name. -* **properties**: [VirtualMachineScaleSetIPConfigurationProperties](#virtualmachinescalesetipconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration properties. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## VirtualMachineScaleSetIPConfigurationProperties +## VirtualMachineScaleSetOSProfile ### Properties -* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: 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. -* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: 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. -* **loadBalancerInboundNatPools**: [SubResource](#subresource)[]: 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 -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. + +## VirtualMachineScaleSetProperties +### Properties +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. ## VirtualMachineScaleSetPublicIPAddressConfiguration ### Properties * **name**: string (Required): The publicIP address configuration name. * **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. - ## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings ### Properties * **domainNameLabel**: string (Required): 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 -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. ## VirtualMachineScaleSetStorageProfile ### Properties @@ -565,35 +576,30 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetDataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## VirtualMachineScaleSetManagedDiskParameters -### Properties -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. - -## VirtualMachineScaleSetOSDisk +## VirtualMachineScaleSetVMInstanceView ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. +* **platformFaultDomain**: int: The Fault Domain count. +* **platformUpdateDomain**: int: The Update Domain count. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## ResourceTags +## VirtualMachineScaleSetVMProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. ## VirtualMachineScaleSetVMProperties ### Properties @@ -609,26 +615,20 @@ * **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. * **vmId**: string (ReadOnly): Azure VM unique ID. -## VirtualMachineScaleSetVMInstanceView +## WindowsConfiguration ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. -* **platformFaultDomain**: int: The Fault Domain count. -* **platformUpdateDomain**: int: The Update Domain count. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## VirtualMachineHealthStatus +## WinRMConfiguration ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners -## ResourceTags +## WinRMListener ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2018-04-01/types.md b/generated/compute/microsoft.compute/2018-04-01/types.md index 6adbe09a25..86e602370f 100644 --- a/generated/compute/microsoft.compute/2018-04-01/types.md +++ b/generated/compute/microsoft.compute/2018-04-01/types.md @@ -127,45 +127,39 @@ * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[] (ReadOnly): The virtual machine zones. -## AvailabilitySetProperties +## AdditionalUnattendContent ### Properties -* **platformFaultDomainCount**: int: Fault Domain count. -* **platformUpdateDomainCount**: int: Update Domain count. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. -* **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. -## SubResource +## ApiEntityReference ### Properties -* **id**: string: Resource Id +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... -## InstanceViewStatus +## AutoOSUpgradePolicy ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **disableAutoRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -## Sku +## AvailabilitySetProperties ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **platformFaultDomainCount**: int: Fault Domain count. +* **platformUpdateDomainCount**: int: Update Domain count. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. +* **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## ResourceTags +## BootDiagnostics ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## DiskProperties +## BootDiagnosticsInstanceView ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskSizeGB**: int: 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. -* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. ## CreationData ### Properties @@ -175,52 +169,57 @@ * **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. * **storageAccountId**: 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 -## ImageDiskReference +## DataDisk ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## EncryptionSettings +## DiagnosticsProfile ### Properties -* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key -* **enabled**: bool: 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. -* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## KeyVaultAndSecretReference +## DiskEncryptionSettings ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## SourceVault +## DiskInstanceView ### Properties -* **id**: string: Resource Id +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## KeyVaultAndKeyReference +## DiskProperties ### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskSizeGB**: int: 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. +* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. ## DiskSku ### Properties * **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ImageProperties +## EncryptionSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key +* **enabled**: bool: 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. +* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) ## ImageDataDisk ### Properties @@ -232,6 +231,11 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -243,124 +247,58 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProximityPlacementGroupProperties -### Properties -* **availabilitySets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SnapshotSku -### Properties -* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineIdentity -### Properties -* **identityIds**: string[]: 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}'. -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. - -## Plan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. - -## VirtualMachineProperties -### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## DiagnosticsProfile +## ImageProperties ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## BootDiagnostics +## ImageReference ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## HardwareProfile +## ImageStorageProfile ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## VirtualMachineInstanceView +## InstanceViewStatus ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## BootDiagnosticsInstanceView +## KeyVaultAndKeyReference ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DiskInstanceView +## KeyVaultAndSecretReference ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DiskEncryptionSettings +## KeyVaultKeyReference ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) ## KeyVaultSecretReference ### Properties * **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. * **sourceVault**: [SubResource](#subresource) (Required) -## KeyVaultKeyReference -### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) - -## VirtualMachineExtensionInstanceView +## LinuxConfiguration ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure ## MaintenanceRedeployStatus ### Properties @@ -372,21 +310,10 @@ * **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. * **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## VirtualMachineAgentInstanceView -### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. - -## VirtualMachineExtensionHandlerInstanceView -### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## NetworkProfile +## ManagedDiskParameters ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. ## NetworkInterfaceReference ### Properties @@ -397,6 +324,23 @@ ### Properties * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + ## OSProfile ### Properties * **adminPassword**: string: 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) @@ -407,53 +351,100 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ProximityPlacementGroupProperties ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +* **availabilitySets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +### Additional Properties +* **Additional Properties Type**: string -## AdditionalUnattendContent +## ResourceTags ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +### Additional Properties +* **Additional Properties Type**: string -## WinRMConfiguration +## ResourceTags ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +### Additional Properties +* **Additional Properties Type**: string -## WinRMListener +## ResourceTags ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradePolicy +### Properties +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). + +## Sku +### Properties +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** + +## SnapshotSku +### Properties +* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. + +## SourceVault +### Properties +* **id**: string: Resource Id + +## SshConfiguration +### Properties +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. + +## SshPublicKey +### Properties +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -461,47 +452,36 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk +## SubResource ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **id**: string: Resource Id -## VirtualHardDisk +## UpgradePolicy ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. +* **autoOSUpgradePolicy**: [AutoOSUpgradePolicy](#autoosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## ManagedDiskParameters +## VaultCertificate ### Properties -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## ImageReference +## VaultSecretGroup ### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -512,84 +492,81 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type -## VirtualMachineExtensionProperties +## VirtualMachineExtensionHandlerInstanceView ### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. -* **instanceView**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview): The instance view of a virtual machine extension. -* **protectedSettings**: any: Any object -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **settings**: any: Any object +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity +## VirtualMachineExtensionInstanceView ### Properties -* **identityIds**: string[]: 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}'. -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetProperties +## VirtualMachineExtensionProperties ### Properties -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **autoUpgradeMinorVersion**: bool: 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. +* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. +* **instanceView**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview): The instance view of a virtual machine extension. +* **protectedSettings**: any: Any object * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. +* **publisher**: string: The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. -## UpgradePolicy +## VirtualMachineHealthStatus ### Properties -* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. -* **autoOSUpgradePolicy**: [AutoOSUpgradePolicy](#autoosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## AutoOSUpgradePolicy +## VirtualMachineIdentity ### Properties -* **disableAutoRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **identityIds**: string[]: 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}'. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties +* **availabilitySet**: [SubResource](#subresource) * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -597,6 +574,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -608,33 +589,12 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration -### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. - -## VirtualMachineScaleSetNetworkConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. - -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentity ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **identityIds**: string[]: 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}'. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -652,55 +612,38 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -714,24 +657,48 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -747,12 +714,45 @@ * **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. * **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineHealthStatus +## VirtualMachineScaleSetVMProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## ResourceTags +## VirtualMachineScaleSetVMProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: 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 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + +## WindowsConfiguration +### Properties +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM + +## WinRMConfiguration +### Properties +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2018-06-01/types.md b/generated/compute/microsoft.compute/2018-06-01/types.md index e6fb19d8cb..447ac795ca 100644 --- a/generated/compute/microsoft.compute/2018-06-01/types.md +++ b/generated/compute/microsoft.compute/2018-06-01/types.md @@ -160,47 +160,43 @@ * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[] (ReadOnly): The virtual machine zones. -## AvailabilitySetProperties +## AdditionalCapabilities ### Properties -* **platformFaultDomainCount**: int: Fault Domain count. -* **platformUpdateDomainCount**: int: Update Domain count. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. -* **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. +* **ultraSSDEnabled**: bool: 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. -## SubResource +## AdditionalUnattendContent ### Properties -* **id**: string: Resource Id +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. -## InstanceViewStatus +## ApiEntityReference ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... -## Sku +## AutoOSUpgradePolicy ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **disableAutoRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -## ResourceTags +## AvailabilitySetProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **platformFaultDomainCount**: int: Fault Domain count. +* **platformUpdateDomainCount**: int: Update Domain count. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. +* **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## DiskProperties +## BootDiagnostics ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskIOPSReadWrite**: int: 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). -* **diskMBpsReadWrite**: int: 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). -* **diskSizeGB**: int: 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. -* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot -* **osType**: 'Linux' | 'Windows': 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** -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. + +## BootDiagnosticsInstanceView +### Properties +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. ## CreationData ### Properties @@ -210,55 +206,83 @@ * **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. * **storageAccountId**: 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 -## ImageDiskReference +## DataDisk ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## EncryptionSettings +## DiagnosticsProfile ### Properties -* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key -* **enabled**: bool: 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. -* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## KeyVaultAndSecretReference +## DiffDiskSettings ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -## SourceVault +## Disallowed ### Properties -* **id**: string: Resource Id +* **diskTypes**: string[]: A list of disk types. -## KeyVaultAndKeyReference +## DiskEncryptionSettings ### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## DiskProperties +### Properties +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskIOPSReadWrite**: int: 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). +* **diskMBpsReadWrite**: int: 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). +* **diskSizeGB**: int: 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. +* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot +* **osType**: 'Linux' | 'Windows': 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** +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. ## DiskSku ### Properties * **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## EncryptionSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key +* **enabled**: bool: 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. +* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## GalleryProperties +## GalleryArtifactSource ### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **managedImage**: [ManagedArtifact](#managedartifact) (Required): The managed artifact. + +## GalleryDataDiskImage +### Properties +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **lun**: int (ReadOnly): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. ## GalleryIdentifier ### Properties * **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## ResourceTags +## GalleryImageIdentifier ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery Image Definition offer. +* **publisher**: string (Required): The name of the gallery Image Definition publisher. +* **sku**: string (Required): The name of the gallery Image Definition SKU. ## GalleryImageProperties ### Properties @@ -275,37 +299,6 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed -### Properties -* **diskTypes**: string[]: A list of disk types. - -## GalleryImageIdentifier -### Properties -* **offer**: string (Required): The name of the gallery Image Definition offer. -* **publisher**: string (Required): The name of the gallery Image Definition publisher. -* **sku**: string (Required): The name of the gallery Image Definition SKU. - -## ImagePurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: The product ID. -* **publisher**: string: The publisher ID. - -## RecommendedMachineConfiguration -### Properties -* **memory**: [ResourceRange](#resourcerange): Describes the resource range. -* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. - -## ResourceRange -### Properties -* **max**: int: The maximum number of the resource. -* **min**: int: The minimum number of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryImageVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -322,63 +315,25 @@ * **source**: [GalleryArtifactSource](#galleryartifactsource) (Required): The source image from which the Image Version is going to be created. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## GalleryArtifactSource -### Properties -* **managedImage**: [ManagedArtifact](#managedartifact) (Required): The managed artifact. - -## ManagedArtifact -### Properties -* **id**: string (Required): The managed artifact id. - -## TargetRegion -### Properties -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. - -## ReplicationStatus -### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. - -## RegionalReplicationStatus -### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. - ## GalleryImageVersionStorageProfile ### Properties * **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[] (ReadOnly): A list of data disk images. * **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage) (ReadOnly): This is the OS disk image. -## GalleryDataDiskImage -### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (ReadOnly): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. - ## GalleryOSDiskImage ### Properties * **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' * **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ImageProperties +## GalleryProperties ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) ## ImageDataDisk ### Properties @@ -390,6 +345,11 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -401,58 +361,122 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. -## ResourceTags +## ImageProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ProximityPlacementGroupProperties +## ImagePurchasePlan ### Properties -* **availabilitySets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **name**: string: The plan ID. +* **product**: string: The product ID. +* **publisher**: string: The publisher ID. -## ResourceTags +## ImageReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## SnapshotProperties +## ImageStorageProfile ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskSizeGB**: int: 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. -* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot -* **osType**: 'Linux' | 'Windows': 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** -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## SnapshotSku +## InstanceViewStatus ### Properties -* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## ResourceTags +## KeyVaultAndKeyReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## VirtualMachineIdentity +## KeyVaultAndSecretReference ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## VirtualMachineIdentityUserAssignedIdentities +## KeyVaultKeyReference ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## UserAssignedIdentitiesValue +## KeyVaultSecretReference ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) + +## LinuxConfiguration +### Properties +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure + +## MaintenanceRedeployStatus +### Properties +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. + +## ManagedArtifact +### Properties +* **id**: string (Required): The managed artifact id. + +## ManagedDiskParameters +### Properties +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. + +## NetworkInterfaceReference +### Properties +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. + +## NetworkInterfaceReferenceProperties +### Properties +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': 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** +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## OSProfile +### Properties +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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). +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. ## Plan ### Properties @@ -461,140 +485,130 @@ * **promotionCode**: string: The promotion code. * **publisher**: string: The publisher ID. -## VirtualMachineProperties +## ProximityPlacementGroupProperties ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +* **availabilitySets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## AdditionalCapabilities +## RecommendedMachineConfiguration ### Properties -* **ultraSSDEnabled**: bool: 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. +* **memory**: [ResourceRange](#resourcerange): Describes the resource range. +* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. -## DiagnosticsProfile +## RegionalReplicationStatus ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. -## BootDiagnostics +## ReplicationStatus ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. -## HardwareProfile +## ResourceRange ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +* **max**: int: The maximum number of the resource. +* **min**: int: The minimum number of the resource. -## VirtualMachineInstanceView +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnosticsInstanceView +## ResourceTags ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## DiskInstanceView +## ResourceTags ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionInstanceView +## ResourceTags ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## MaintenanceRedeployStatus +## ResourceTags ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineAgentInstanceView +## ResourceTags ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionHandlerInstanceView +## ResourceTags ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## NetworkProfile +## ResourceTags ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## NetworkInterfaceReference +## ResourceTags ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +### Additional Properties +* **Additional Properties Type**: string -## NetworkInterfaceReferenceProperties +## ResourceTags ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: string -## OSProfile +## RollingUpgradePolicy ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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). -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). -## LinuxConfiguration +## Sku ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** + +## SnapshotProperties +### Properties +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskSizeGB**: int: 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. +* **encryptionSettings**: [EncryptionSettings](#encryptionsettings): Encryption settings for disk or snapshot +* **osType**: 'Linux' | 'Windows': 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** +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. + +## SnapshotSku +### Properties +* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. + +## SourceVault +### Properties +* **id**: string: Resource Id ## SshConfiguration ### Properties @@ -605,92 +619,52 @@ * **keyData**: string: 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). * **path**: 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 -## VaultSecretGroup +## StorageProfile ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **dataDisks**: [DataDisk](#datadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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). -## VaultCertificate +## SubResource ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +* **id**: string: Resource Id -## WindowsConfiguration +## TargetRegion ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -## AdditionalUnattendContent +## UpgradePolicy ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. +* **autoOSUpgradePolicy**: [AutoOSUpgradePolicy](#autoosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## WinRMConfiguration +## UserAssignedIdentitiesValue ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## WinRMListener +## VaultCertificate ### Properties +* **certificateStore**: string: 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. * **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** - -## StorageProfile -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk +## VaultSecretGroup ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. ## VirtualHardDisk ### Properties * **uri**: string: Specifies the virtual hard disk's uri. -## ManagedDiskParameters -### Properties -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. - -## ImageReference -### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. - -## OSDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': 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** -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## DiffDiskSettings +## VirtualMachineAgentInstanceView ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -701,6 +675,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -713,83 +701,61 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. - -## VirtualMachineScaleSetIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties -### Properties -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. +## VirtualMachineHealthStatus +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## UpgradePolicy +## VirtualMachineIdentity ### Properties -* **automaticOSUpgrade**: bool: Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. -* **autoOSUpgradePolicy**: [AutoOSUpgradePolicy](#autoosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## AutoOSUpgradePolicy +## VirtualMachineIdentityUserAssignedIdentities ### Properties -* **disableAutoRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -797,6 +763,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -809,33 +779,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -854,56 +813,38 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -918,25 +859,49 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -952,12 +917,47 @@ * **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. * **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineHealthStatus +## VirtualMachineScaleSetVMProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## ResourceTags +## VirtualMachineScaleSetVMProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: 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 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + +## WindowsConfiguration +### Properties +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: Indicates whether virtual machine is enabled for automatic updates. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM + +## WinRMConfiguration +### Properties +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2018-09-30/types.md b/generated/compute/microsoft.compute/2018-09-30/types.md index 85d06f5d48..5837798cf5 100644 --- a/generated/compute/microsoft.compute/2018-09-30/types.md +++ b/generated/compute/microsoft.compute/2018-09-30/types.md @@ -27,6 +27,14 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type +## CreationData +### Properties +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: 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 + ## DiskProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -40,18 +48,10 @@ * **provisioningState**: string (ReadOnly): The disk provisioning state. * **timeCreated**: string (ReadOnly): The time when the disk was created. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: 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 - -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## EncryptionSettingsCollection ### Properties @@ -63,24 +63,25 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference -### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault +## ImageDiskReference ### Properties -* **id**: string: Resource Id +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. ## KeyVaultAndKeyReference ### Properties * **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault * **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DiskSku +## KeyVaultAndSecretReference ### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -102,8 +103,7 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id diff --git a/generated/compute/microsoft.compute/2018-10-01/types.md b/generated/compute/microsoft.compute/2018-10-01/types.md index bec6f2e4fe..037de420db 100644 --- a/generated/compute/microsoft.compute/2018-10-01/types.md +++ b/generated/compute/microsoft.compute/2018-10-01/types.md @@ -100,6 +100,31 @@ * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[] (ReadOnly): The virtual machine zones. +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -108,40 +133,52 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## BootDiagnostics ### Properties -* **id**: string: Resource Id +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## InstanceViewStatus +## BootDiagnosticsInstanceView ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## Sku +## DataDisk ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## DiagnosticsProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## ImageProperties +## DiffDiskSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -## ImageStorageProfile +## DiskEncryptionSettings ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## HardwareProfile +### Properties +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) ## ImageDataDisk ### Properties @@ -164,129 +201,49 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProximityPlacementGroupProperties -### Properties -* **availabilitySets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. - -## VirtualMachineIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) - -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## Plan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. - -## VirtualMachineProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## AdditionalCapabilities -### Properties -* **ultraSSDEnabled**: bool: 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. - -## DiagnosticsProfile -### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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 -### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. - -## HardwareProfile +## ImageProperties ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## VirtualMachineInstanceView +## ImageReference ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## BootDiagnosticsInstanceView +## ImageStorageProfile ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## DiskInstanceView +## InstanceViewStatus ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## DiskEncryptionSettings +## KeyVaultKeyReference ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) ## KeyVaultSecretReference ### Properties * **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. * **sourceVault**: [SubResource](#subresource) (Required) -## KeyVaultKeyReference -### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) - -## VirtualMachineExtensionInstanceView +## LinuxConfiguration ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure ## MaintenanceRedeployStatus ### Properties @@ -298,21 +255,10 @@ * **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. * **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## VirtualMachineAgentInstanceView -### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. - -## VirtualMachineExtensionHandlerInstanceView -### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## NetworkProfile +## ManagedDiskParameters ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. ## NetworkInterfaceReference ### Properties @@ -323,6 +269,24 @@ ### Properties * **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + ## OSProfile ### Properties * **adminPassword**: string: 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) @@ -334,54 +298,81 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## Plan ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ProximityPlacementGroupProperties ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +* **availabilitySets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SshPublicKey +## ResourceTags ### Properties -* **keyData**: string: 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). -* **path**: 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 +### Additional Properties +* **Additional Properties Type**: string -## VaultSecretGroup +## ResourceTags ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +### Additional Properties +* **Additional Properties Type**: string -## VaultCertificate +## ResourceTags ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +### Additional Properties +* **Additional Properties Type**: string -## WindowsConfiguration +## ResourceTags ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +### Additional Properties +* **Additional Properties Type**: string -## AdditionalUnattendContent +## ResourceTags ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +### Additional Properties +* **Additional Properties Type**: string -## WinRMConfiguration +## ResourceTags ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +### Additional Properties +* **Additional Properties Type**: string -## WinRMListener +## ResourceTags ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradePolicy +### Properties +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). + +## Sku +### Properties +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** + +## SshConfiguration +### Properties +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. + +## SshPublicKey +### Properties +* **keyData**: string: 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). +* **path**: 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 ## StorageProfile ### Properties @@ -389,52 +380,40 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk +## SubResource ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **id**: string: Resource Id -## VirtualHardDisk +## UpgradePolicy ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## ManagedDiskParameters +## UserAssignedIdentitiesValue ### Properties -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ImageReference +## VaultCertificate ### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## OSDisk +## VaultSecretGroup ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## DiffDiskSettings +## VirtualHardDisk ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -445,6 +424,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -457,90 +450,61 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. - -## VirtualMachineScaleSetIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties -### Properties -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy +## VirtualMachineHealthStatus ### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## UpgradePolicy +## VirtualMachineIdentity ### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## AutomaticOSUpgradePolicy +## VirtualMachineIdentityUserAssignedIdentities ### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -548,6 +512,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -560,33 +528,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -605,56 +562,38 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -669,25 +608,51 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -703,12 +668,47 @@ * **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. * **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineHealthStatus +## VirtualMachineScaleSetVMProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | string: Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -## ResourceTags +## VirtualMachineScaleSetVMProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: 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 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + +## WindowsConfiguration +### Properties +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM + +## WinRMConfiguration +### Properties +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2019-03-01/types.md b/generated/compute/microsoft.compute/2019-03-01/types.md index 049e76f16c..7b8df48b69 100644 --- a/generated/compute/microsoft.compute/2019-03-01/types.md +++ b/generated/compute/microsoft.compute/2019-03-01/types.md @@ -206,6 +206,31 @@ * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[] (ReadOnly): The virtual machine zones. +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -214,43 +239,20 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource -### Properties -* **id**: string: Resource Id - -## InstanceViewStatus -### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. - -## Sku +## BillingProfile ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **maxPrice**: int: 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. -## ResourceTags +## BootDiagnostics ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## DiskProperties +## BootDiagnosticsInstanceView ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskIOPSReadWrite**: int: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. -* **diskSizeGB**: int: 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. -* **diskState**: 'ActiveSAS' | 'ActiveUpload' | 'Attached' | 'ReadyToUpload' | 'Reserved' | 'Unattached' | string (ReadOnly): The state of the disk. -* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot -* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. -* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. ## CreationData ### Properties @@ -262,60 +264,104 @@ * **storageAccountId**: 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 * **uploadSizeBytes**: int: 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). -## ImageDiskReference +## DataDisk ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## EncryptionSettingsCollection +## DedicatedHostAllocatableVM ### Properties -* **enabled**: bool (Required): 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. -* **encryptionSettings**: [EncryptionSettingsElement](#encryptionsettingselement)[]: A collection of encryption settings, one for each disk volume. -* **encryptionSettingsVersion**: 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. +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. -## EncryptionSettingsElement +## DedicatedHostAvailableCapacity ### Properties -* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key -* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. -## KeyVaultAndSecretReference +## DedicatedHostGroupProperties ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. -## SourceVault +## DedicatedHostInstanceView ### Properties -* **id**: string: Resource Id +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## KeyVaultAndKeyReference +## DedicatedHostProperties ### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. +* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. +* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. +* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** +* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. +* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## DiskSku +## DiagnosticsProfile ### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## ResourceTags +## DiffDiskSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -## GalleryProperties +## Disallowed ### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **diskTypes**: string[]: A list of disk types. -## GalleryIdentifier +## DiskEncryptionSettings ### Properties -* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## ResourceTags +## DiskInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## DiskProperties +### Properties +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskIOPSReadWrite**: int: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. +* **diskSizeGB**: int: 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. +* **diskState**: 'ActiveSAS' | 'ActiveUpload' | 'Attached' | 'ReadyToUpload' | 'Reserved' | 'Unattached' | string (ReadOnly): The state of the disk. +* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot +* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. + +## DiskSku +### Properties +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. + +## EncryptionSettingsCollection +### Properties +* **enabled**: bool (Required): 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. +* **encryptionSettings**: [EncryptionSettingsElement](#encryptionsettingselement)[]: A collection of encryption settings, one for each disk volume. +* **encryptionSettingsVersion**: 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. + +## EncryptionSettingsElement +### Properties +* **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key +* **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey ## GalleryApplicationProperties ### Properties @@ -326,11 +372,6 @@ * **releaseNoteUri**: string: The release note uri. * **supportedOSType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -349,39 +390,25 @@ * **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## UserArtifactManage -### Properties -* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. -* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. -* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. - -## UserArtifactSource -### Properties -* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. -* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. - -## TargetRegion +## GalleryArtifactSource ### Properties -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -* **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. +* **managedImage**: [ManagedArtifact](#managedartifact) (Required): The managed artifact. -## ReplicationStatus +## GalleryDataDiskImage ### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **lun**: int (ReadOnly): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -## RegionalReplicationStatus +## GalleryIdentifier ### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. +* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## ResourceTags +## GalleryImageIdentifier ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery Image Definition offer. +* **publisher**: string (Required): The name of the gallery Image Definition publisher. +* **sku**: string (Required): The name of the gallery Image Definition SKU. ## GalleryImageProperties ### Properties @@ -398,37 +425,6 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed -### Properties -* **diskTypes**: string[]: A list of disk types. - -## GalleryImageIdentifier -### Properties -* **offer**: string (Required): The name of the gallery Image Definition offer. -* **publisher**: string (Required): The name of the gallery Image Definition publisher. -* **sku**: string (Required): The name of the gallery Image Definition SKU. - -## ImagePurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: The product ID. -* **publisher**: string: The publisher ID. - -## RecommendedMachineConfiguration -### Properties -* **memory**: [ResourceRange](#resourcerange): Describes the resource range. -* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. - -## ResourceRange -### Properties -* **max**: int: The maximum number of the resource. -* **min**: int: The minimum number of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryImageVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -446,118 +442,177 @@ * **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## GalleryArtifactSource +## GalleryImageVersionStorageProfile ### Properties -* **managedImage**: [ManagedArtifact](#managedartifact) (Required): The managed artifact. +* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[] (ReadOnly): A list of data disk images. +* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage) (ReadOnly): This is the OS disk image. -## ManagedArtifact +## GalleryOSDiskImage ### Properties -* **id**: string (Required): The managed artifact id. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -## GalleryImageVersionStorageProfile +## GalleryProperties ### Properties -* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[] (ReadOnly): A list of data disk images. -* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage) (ReadOnly): This is the OS disk image. +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -## GalleryDataDiskImage +## HardwareProfile ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (ReadOnly): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) -## GalleryOSDiskImage +## ImageDataDisk ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' (ReadOnly): The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [SubResource](#subresource) +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## ResourceTags +## ImageDiskReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. -## DedicatedHostGroupProperties +## ImageOSDisk ### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskSizeGB**: int: 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 +* **managedDisk**: [SubResource](#subresource) +* **osState**: 'Generalized' | 'Specialized' (Required): The OS State. +* **osType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## SubResourceReadOnly +## ImageProperties ### Properties -* **id**: string (ReadOnly): Resource Id +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ResourceTags +## ImagePurchasePlan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The plan ID. +* **product**: string: The product ID. +* **publisher**: string: The publisher ID. -## DedicatedHostProperties +## ImageReference ### Properties -* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. -* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. -* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. -* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** -* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. -* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## DedicatedHostInstanceView +## ImageStorageProfile ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## DedicatedHostAvailableCapacity +## InstanceViewStatus ### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## DedicatedHostAllocatableVM +## KeyVaultAndKeyReference ### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ResourceTags +## KeyVaultAndSecretReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ImageProperties +## KeyVaultKeyReference ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ImageStorageProfile +## KeyVaultSecretReference ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ImageDataDisk +## LinuxConfiguration ### Properties -* **blobUri**: string: The Virtual Hard Disk. -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [SubResource](#subresource) -* **snapshot**: [SubResource](#subresource) +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure + +## MaintenanceRedeployStatus +### Properties +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. + +## ManagedArtifact +### Properties +* **id**: string (Required): The managed artifact id. + +## ManagedDiskParameters +### Properties +* **id**: string: Resource Id * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## ImageOSDisk +## NetworkInterfaceReference +### Properties +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. + +## NetworkInterfaceReferenceProperties +### Properties +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk ### Properties -* **blobUri**: string: The Virtual Hard Disk. * **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskSizeGB**: int: 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 -* **managedDisk**: [SubResource](#subresource) -* **osState**: 'Generalized' | 'Specialized' (Required): The OS State. -* **osType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. -* **snapshot**: [SubResource](#subresource) -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## OSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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). +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required from the virtual machine. +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. + +## Plan +### Properties +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. ## ProximityPlacementGroupProperties ### Properties @@ -566,203 +621,155 @@ * **virtualMachines**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. * **virtualMachineScaleSets**: [SubResource](#subresource)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## ResourceTags +## RecommendedMachineConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **memory**: [ResourceRange](#resourcerange): Describes the resource range. +* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. -## SnapshotProperties +## RegionalReplicationStatus ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. -* **diskSizeGB**: int: 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. -* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot -* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. -* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. -* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. -## SnapshotSku +## ReplicationStatus ### Properties -* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. + +## ResourceRange +### Properties +* **max**: int: The maximum number of the resource. +* **min**: int: The minimum number of the resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. - -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) - -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **Additional Properties Type**: string -## Plan +## ResourceTags ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineProperties +## ResourceTags ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +### Additional Properties +* **Additional Properties Type**: string -## AdditionalCapabilities +## ResourceTags ### Properties -* **ultraSSDEnabled**: bool: 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. +### Additional Properties +* **Additional Properties Type**: string -## BillingProfile +## ResourceTags ### Properties -* **maxPrice**: int: 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. +### Additional Properties +* **Additional Properties Type**: string -## DiagnosticsProfile +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnostics +## ResourceTags ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +### Additional Properties +* **Additional Properties Type**: string -## HardwareProfile +## ResourceTags ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineInstanceView +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnosticsInstanceView +## ResourceTags ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## DiskInstanceView +## ResourceTags ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionInstanceView +## ResourceTags ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## MaintenanceRedeployStatus +## ResourceTags ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineAgentInstanceView +## RollingUpgradePolicy ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). -## VirtualMachineExtensionHandlerInstanceView +## ScaleInPolicy ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## NetworkProfile +## ScheduledEventsProfile ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## NetworkInterfaceReference +## Sku ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## NetworkInterfaceReferenceProperties +## SnapshotProperties ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. +* **diskSizeGB**: int: 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. +* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot +* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. +* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## OSProfile +## SnapshotSku ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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). -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required from the virtual machine. -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. -## LinuxConfiguration +## SourceVault ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **id**: string: Resource Id ## SshConfiguration ### Properties @@ -773,93 +780,72 @@ * **keyData**: string: 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). * **path**: 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 -## VaultSecretGroup +## StorageProfile ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **dataDisks**: [DataDisk](#datadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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). -## VaultCertificate +## SubResource ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +* **id**: string: Resource Id -## WindowsConfiguration +## SubResourceReadOnly ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **id**: string (ReadOnly): Resource Id -## AdditionalUnattendContent +## TargetRegion ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. +* **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -## WinRMConfiguration +## TerminateNotificationProfile ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) -## WinRMListener +## UpgradePolicy ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## StorageProfile +## UserArtifactManage ### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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). +* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. +* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. +* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. -## DataDisk +## UserArtifactSource ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. +* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. -## VirtualHardDisk +## UserAssignedIdentitiesValue ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedDiskParameters +## VaultCertificate ### Properties -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## ImageReference +## VaultSecretGroup ### Properties -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **uri**: string: Specifies the virtual hard disk's uri. -## DiffDiskSettings +## VirtualMachineAgentInstanceView ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -870,6 +856,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -882,97 +882,67 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. * **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetIdentityUserAssignedIdentities +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    - -## UpgradePolicy -### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutomaticOSUpgradePolicy -### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) * **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. * **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. * **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -980,6 +950,10 @@ * **name**: string: The name of the extension. * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -992,33 +966,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1037,26 +1000,51 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration +## VirtualMachineScaleSetIpTag ### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPPrefix**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **domainNameLabel**: string (Required): 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 +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetIpTag +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. +* **dnsServers**: string[]: List of DNS servers IP addresses + +## VirtualMachineScaleSetNetworkConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. + +## VirtualMachineScaleSetOSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetOSProfile ### Properties @@ -1068,14 +1056,37 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## ScheduledEventsProfile +## VirtualMachineScaleSetProperties ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. -## TerminateNotificationProfile +## VirtualMachineScaleSetPublicIPAddressConfiguration ### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPPrefix**: [SubResource](#subresource) ## VirtualMachineScaleSetStorageProfile ### Properties @@ -1083,37 +1094,36 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetDataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetVMInstanceView ### Properties -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. +* **platformFaultDomain**: int: The Fault Domain count. +* **platformUpdateDomain**: int: The Update Domain count. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineScaleSetOSDisk +## VirtualMachineScaleSetVMNetworkProfileConfiguration ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## ResourceTags +## VirtualMachineScaleSetVMProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. ## VirtualMachineScaleSetVMProperties ### Properties @@ -1133,35 +1143,25 @@ * **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. * **vmId**: string (ReadOnly): Azure VM unique ID. -## VirtualMachineScaleSetVMInstanceView -### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. -* **platformFaultDomain**: int: The Fault Domain count. -* **platformUpdateDomain**: int: The Update Domain count. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. - -## VirtualMachineHealthStatus +## VirtualMachineScaleSetVMProtectionPolicy ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. +* **protectFromScaleSetActions**: bool: 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. -## VirtualMachineScaleSetVMNetworkProfileConfiguration +## WindowsConfiguration ### Properties -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## VirtualMachineScaleSetVMProtectionPolicy +## WinRMConfiguration ### Properties -* **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. -* **protectFromScaleSetActions**: bool: 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. +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners -## ResourceTags +## WinRMListener ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2019-07-01/types.md b/generated/compute/microsoft.compute/2019-07-01/types.md index d698e3e764..c0e514d3a0 100644 --- a/generated/compute/microsoft.compute/2019-07-01/types.md +++ b/generated/compute/microsoft.compute/2019-07-01/types.md @@ -229,6 +229,31 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -237,54 +262,104 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## BillingProfile ### Properties -* **id**: string: Resource Id +* **maxPrice**: int: 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. -## InstanceViewStatus +## BootDiagnostics ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## Sku +## BootDiagnosticsInstanceView ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## CreationData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). -## EncryptionSetIdentity +## DataDisk ### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## EncryptionSetProperties +## DedicatedHostAllocatableVM ### Properties -* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. -## KeyVaultAndKeyReference +## DedicatedHostAvailableCapacity ### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. -## SourceVault +## DedicatedHostGroupProperties +### Properties +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. + +## DedicatedHostInstanceView +### Properties +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## DedicatedHostProperties +### Properties +* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. +* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. +* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. +* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** +* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. +* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. + +## DiagnosticsProfile +### Properties +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. + +## DiffDiskSettings +### Properties +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. + +## Disallowed +### Properties +* **diskTypes**: string[]: A list of disk types. + +## DiskEncryptionSetParameters ### Properties * **id**: string: Resource Id -## ResourceTags +## DiskEncryptionSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DiskProperties ### Properties @@ -302,26 +377,28 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). - -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformKey' | string (Required): The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -333,36 +410,6 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference -### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## DiskSku -### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GalleryProperties -### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. - -## GalleryIdentifier -### Properties -* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationProperties ### Properties * **description**: string: The description of this gallery Application Definition resource. This property is updatable. @@ -372,11 +419,6 @@ * **releaseNoteUri**: string: The release note uri. * **supportedOSType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -395,39 +437,26 @@ * **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## UserArtifactManage -### Properties -* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. -* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. -* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. - -## UserArtifactSource -### Properties -* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. -* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. - -## TargetRegion +## GalleryArtifactVersionSource ### Properties -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -* **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. +* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image. -## ReplicationStatus +## GalleryDataDiskImage ### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## RegionalReplicationStatus +## GalleryIdentifier ### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. +* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## ResourceTags +## GalleryImageIdentifier ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery Image Definition offer. +* **publisher**: string (Required): The name of the gallery Image Definition publisher. +* **sku**: string (Required): The name of the gallery Image Definition SKU. ## GalleryImageProperties ### Properties @@ -445,170 +474,195 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed +## GalleryImageVersionProperties ### Properties -* **diskTypes**: string[]: A list of disk types. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **publishingProfile**: [GalleryImageVersionPublishingProfile](#galleryimageversionpublishingprofile): The publishing profile of a gallery Image Version. +* **replicationStatus**: [ReplicationStatus](#replicationstatus) (ReadOnly): This is the replication status of the gallery Image Version. +* **storageProfile**: [GalleryImageVersionStorageProfile](#galleryimageversionstorageprofile) (Required): This is the storage profile of a Gallery Image Version. -## GalleryImageIdentifier +## GalleryImageVersionPublishingProfile ### Properties -* **offer**: string (Required): The name of the gallery Image Definition offer. -* **publisher**: string (Required): The name of the gallery Image Definition publisher. -* **sku**: string (Required): The name of the gallery Image Definition SKU. +* **endOfLifeDate**: string: The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable. +* **excludeFromLatest**: bool: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. +* **publishedDate**: string (ReadOnly): The timestamp for when the gallery Image Version is published. +* **replicaCount**: int: 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. +* **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. +* **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## ImagePurchasePlan +## GalleryImageVersionStorageProfile ### Properties -* **name**: string: The plan ID. -* **product**: string: The product ID. -* **publisher**: string: The publisher ID. +* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[]: A list of data disk images. +* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## RecommendedMachineConfiguration +## GalleryOSDiskImage ### Properties -* **memory**: [ResourceRange](#resourcerange): Describes the resource range. -* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## ResourceRange +## GalleryProperties ### Properties -* **max**: int: The maximum number of the resource. -* **min**: int: The minimum number of the resource. +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -## ResourceTags +## HardwareProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) -## GalleryImageVersionProperties +## ImageDataDisk ### Properties -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -* **publishingProfile**: [GalleryImageVersionPublishingProfile](#galleryimageversionpublishingprofile): The publishing profile of a gallery Image Version. -* **replicationStatus**: [ReplicationStatus](#replicationstatus) (ReadOnly): This is the replication status of the gallery Image Version. -* **storageProfile**: [GalleryImageVersionStorageProfile](#galleryimageversionstorageprofile) (Required): This is the storage profile of a Gallery Image Version. +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [SubResource](#subresource) +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## GalleryImageVersionPublishingProfile +## ImageDiskReference ### Properties -* **endOfLifeDate**: string: The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable. -* **excludeFromLatest**: bool: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. -* **publishedDate**: string (ReadOnly): The timestamp for when the gallery Image Version is published. -* **replicaCount**: int: 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. -* **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -* **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. -## GalleryImageVersionStorageProfile +## ImageOSDisk ### Properties -* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[]: A list of data disk images. -* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **diskSizeGB**: int: 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 +* **managedDisk**: [SubResource](#subresource) +* **osState**: 'Generalized' | 'Specialized' (Required): The OS State. +* **osType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## GalleryDataDiskImage +## ImageProperties ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## GalleryArtifactVersionSource +## ImagePurchasePlan ### Properties -* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image. +* **name**: string: The plan ID. +* **product**: string: The product ID. +* **publisher**: string: The publisher ID. -## GalleryOSDiskImage +## ImageReference ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## ResourceTags +## ImageStorageProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## DedicatedHostGroupProperties +## InstanceViewStatus ### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## SubResourceReadOnly +## KeyVaultAndKeyReference ### Properties -* **id**: string (ReadOnly): Resource Id +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ResourceTags +## KeyVaultAndSecretReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DedicatedHostProperties +## KeyVaultKeyReference ### Properties -* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. -* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. -* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. -* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** -* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. -* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## DedicatedHostInstanceView +## KeyVaultSecretReference ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## DedicatedHostAvailableCapacity +## LinuxConfiguration ### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## DedicatedHostAllocatableVM +## MaintenanceRedeployStatus ### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## ResourceTags +## ManagedDiskParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## ImageProperties +## NetworkInterfaceReference ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## ImageStorageProfile +## NetworkInterfaceReferenceProperties ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## ImageDataDisk +## NetworkProfile ### Properties -* **blobUri**: string: The Virtual Hard Disk. -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [SubResource](#subresource) -* **snapshot**: [SubResource](#subresource) -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. -## DiskEncryptionSetParameters +## OSDisk ### Properties -* **id**: string: Resource Id +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ImageOSDisk +## OSProfile ### Properties -* **blobUri**: string: The Virtual Hard Disk. -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **diskSizeGB**: int: 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 -* **managedDisk**: [SubResource](#subresource) -* **osState**: 'Generalized' | 'Specialized' (Required): The OS State. -* **osType**: 'Linux' | 'Windows' (Required): The operating system of the osDiskImage. -* **snapshot**: [SubResource](#subresource) -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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). +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## ResourceTags +## Plan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. ## ProximityPlacementGroupProperties ### Properties @@ -618,209 +672,166 @@ * **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. * **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SubResourceWithColocationStatus +## RecommendedMachineConfiguration ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **id**: string: Resource Id +* **memory**: [ResourceRange](#resourcerange): Describes the resource range. +* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. -## ResourceTags +## RegionalReplicationStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. -## SnapshotProperties +## ReplicationStatus ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. -* **diskSizeGB**: int: 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. -* **encryption**: [Encryption](#encryption): Encryption at rest settings for disk or snapshot -* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot -* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. -* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk was created. -* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. -## SnapshotSku +## ResourceRange ### Properties -* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **max**: int: The maximum number of the resource. +* **min**: int: The minimum number of the resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity +## ResourceTags ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **Additional Properties Type**: string -## UserAssignedIdentitiesValue +## ResourceTags ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string -## Plan +## ResourceTags ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineProperties +## ResourceTags ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +### Additional Properties +* **Additional Properties Type**: string -## AdditionalCapabilities +## ResourceTags ### Properties -* **ultraSSDEnabled**: bool: 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. +### Additional Properties +* **Additional Properties Type**: string -## BillingProfile +## ResourceTags ### Properties -* **maxPrice**: int: 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. +### Additional Properties +* **Additional Properties Type**: string -## DiagnosticsProfile +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnostics +## ResourceTags ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +### Additional Properties +* **Additional Properties Type**: string -## HardwareProfile +## ResourceTags ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineInstanceView +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnosticsInstanceView +## ResourceTags ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## DiskInstanceView +## ResourceTags ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionInstanceView +## ResourceTags ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## MaintenanceRedeployStatus +## ResourceTags ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineAgentInstanceView +## RollingUpgradePolicy ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). -## VirtualMachineExtensionHandlerInstanceView +## ScaleInPolicy ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## NetworkProfile +## ScheduledEventsProfile ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## NetworkInterfaceReference +## Sku ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## NetworkInterfaceReferenceProperties +## SnapshotProperties ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. +* **diskSizeGB**: int: 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. +* **encryption**: [Encryption](#encryption): Encryption at rest settings for disk or snapshot +* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot +* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. +* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk was created. +* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## OSProfile +## SnapshotSku ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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). -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. -## LinuxConfiguration +## SourceVault ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **id**: string: Resource Id ## SshConfiguration ### Properties @@ -831,97 +842,77 @@ * **keyData**: string: 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). * **path**: 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 -## VaultSecretGroup +## StorageProfile ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **dataDisks**: [DataDisk](#datadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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 +* **osDisk**: [OSDisk](#osdisk): 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). -## VaultCertificate +## SubResource ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +* **id**: string: Resource Id -## WindowsConfiguration +## SubResourceReadOnly ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **provisionVMAgent**: bool: 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. -* **timeZone**: 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). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **id**: string (ReadOnly): Resource Id -## AdditionalUnattendContent +## SubResourceWithColocationStatus ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id -## WinRMConfiguration +## TargetRegion ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. +* **storageAccountType**: 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -## WinRMListener +## TerminateNotificationProfile ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) -## StorageProfile +## UpgradePolicy ### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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 -* **osDisk**: [OSDisk](#osdisk): 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). +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## DataDisk +## UserArtifactManage ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. +* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. +* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. -## VirtualHardDisk +## UserArtifactSource ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. +* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. -## ManagedDiskParameters +## UserAssignedIdentitiesValue ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ImageReference +## VaultCertificate ### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## OSDisk +## VaultSecretGroup ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## DiffDiskSettings +## VirtualHardDisk ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -932,6 +923,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -944,97 +949,69 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. * **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetIdentityUserAssignedIdentities +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    - -## UpgradePolicy -### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutomaticOSUpgradePolicy -### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) * **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. * **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. * **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -1043,6 +1020,10 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1055,33 +1036,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1100,69 +1070,39 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile -### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. - -## ScheduledEventsProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## TerminateNotificationProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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 -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkProfile ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -1177,28 +1117,54 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: 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 -* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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 +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -1214,26 +1180,60 @@ * **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. * **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineHealthStatus -### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. - ## VirtualMachineScaleSetVMNetworkProfileConfiguration ### Properties * **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +## VirtualMachineScaleSetVMProfile +### Properties +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. + +## VirtualMachineScaleSetVMProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: 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 +* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + ## VirtualMachineScaleSetVMProtectionPolicy ### Properties * **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. * **protectFromScaleSetActions**: bool: 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. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **provisionVMAgent**: bool: 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. +* **timeZone**: 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). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2019-11-01/types.md b/generated/compute/microsoft.compute/2019-11-01/types.md index 0114de285e..2de9cf7b5d 100644 --- a/generated/compute/microsoft.compute/2019-11-01/types.md +++ b/generated/compute/microsoft.compute/2019-11-01/types.md @@ -40,31 +40,16 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type -## EncryptionSetIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. - -## EncryptionSetProperties -### Properties -* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. - -## KeyVaultAndKeyReference -### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault -### Properties -* **id**: string: Resource Id - -## ResourceTags +## CreationData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). ## DiskProperties ### Properties @@ -86,27 +71,28 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). - -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -118,25 +104,40 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + +## KeyVaultAndKeyReference +### Properties +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + ## KeyVaultAndSecretReference ### Properties * **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault * **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ShareInfoElement +## ResourceTags ### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. +### Additional Properties +* **Additional Properties Type**: string -## DiskSku +## ResourceTags ### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ShareInfoElement +### Properties +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. + ## SnapshotProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -156,8 +157,7 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id diff --git a/generated/compute/microsoft.compute/2019-12-01/types.md b/generated/compute/microsoft.compute/2019-12-01/types.md index 6ba0f5f2c0..90534f15c2 100644 --- a/generated/compute/microsoft.compute/2019-12-01/types.md +++ b/generated/compute/microsoft.compute/2019-12-01/types.md @@ -201,6 +201,31 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -209,43 +234,105 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## BillingProfile ### Properties -* **id**: string: Resource Id +* **maxPrice**: int: 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. -## InstanceViewStatus +## BootDiagnostics ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. -## Sku +## BootDiagnosticsInstanceView ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. +* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## DataDisk ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## GalleryProperties +## DataDiskImageEncryption ### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -## GalleryIdentifier +## DedicatedHostAllocatableVM ### Properties -* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. -## ResourceTags +## DedicatedHostAvailableCapacity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. + +## DedicatedHostGroupProperties +### Properties +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. + +## DedicatedHostInstanceView +### Properties +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## DedicatedHostProperties +### Properties +* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. +* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. +* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. +* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** +* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. +* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. + +## DiagnosticsProfile +### Properties +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. + +## DiffDiskSettings +### Properties +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + +## Disallowed +### Properties +* **diskTypes**: string[]: A list of disk types. + +## DiskEncryptionSetParameters +### Properties +* **id**: string: Resource Id + +## DiskEncryptionSettings +### Properties +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## EncryptionImages +### Properties +* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. +* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. ## GalleryApplicationProperties ### Properties @@ -256,11 +343,6 @@ * **releaseNoteUri**: string: The release note uri. * **supportedOSType**: 'Linux' | 'Windows' (Required): This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -279,54 +361,26 @@ * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## UserArtifactManage -### Properties -* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. -* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. -* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. - -## UserArtifactSource -### Properties -* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. -* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. - -## TargetRegion -### Properties -* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. - -## EncryptionImages +## GalleryArtifactVersionSource ### Properties -* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. -* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. +* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image. -## DataDiskImageEncryption +## GalleryDataDiskImage ### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' * **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## OSDiskImageEncryption -### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. - -## ReplicationStatus -### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. - -## RegionalReplicationStatus +## GalleryIdentifier ### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. +* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## ResourceTags +## GalleryImageIdentifier ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery Image Definition offer. +* **publisher**: string (Required): The name of the gallery Image Definition publisher. +* **sku**: string (Required): The name of the gallery Image Definition SKU. ## GalleryImageProperties ### Properties @@ -344,37 +398,6 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed -### Properties -* **diskTypes**: string[]: A list of disk types. - -## GalleryImageIdentifier -### Properties -* **offer**: string (Required): The name of the gallery Image Definition offer. -* **publisher**: string (Required): The name of the gallery Image Definition publisher. -* **sku**: string (Required): The name of the gallery Image Definition SKU. - -## ImagePurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: The product ID. -* **publisher**: string: The publisher ID. - -## RecommendedMachineConfiguration -### Properties -* **memory**: [ResourceRange](#resourcerange): Describes the resource range. -* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. - -## ResourceRange -### Properties -* **max**: int: The maximum number of the resource. -* **min**: int: The minimum number of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryImageVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -397,117 +420,162 @@ * **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. * **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## GalleryDataDiskImage +## GalleryOSDiskImage ### Properties * **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. * **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. * **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## GalleryArtifactVersionSource +## GalleryProperties ### Properties -* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image. +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -## GalleryOSDiskImage +## HardwareProfile ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) -## ResourceTags +## ImageDataDisk ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [SubResource](#subresource) +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## DedicatedHostGroupProperties +## ImageOSDisk ### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. - -## SubResourceReadOnly +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **diskSizeGB**: int: 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 +* **managedDisk**: [SubResource](#subresource) +* **osState**: 'Generalized' | 'Specialized' (Required): This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. +* **osType**: 'Linux' | 'Windows' (Required): This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types + +## ImageProperties ### Properties -* **id**: string (ReadOnly): Resource Id +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ResourceTags +## ImagePurchasePlan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The plan ID. +* **product**: string: The product ID. +* **publisher**: string: The publisher ID. -## DedicatedHostProperties +## ImageReference ### Properties -* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. -* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. -* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. -* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** -* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. -* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## DedicatedHostInstanceView +## ImageStorageProfile ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## DedicatedHostAvailableCapacity +## InstanceViewStatus ### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## DedicatedHostAllocatableVM +## KeyVaultKeyReference ### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ResourceTags +## KeyVaultSecretReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ImageProperties +## LinuxConfiguration ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## ImageStorageProfile +## MaintenanceRedeployStatus ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## ImageDataDisk +## ManagedDiskParameters ### Properties -* **blobUri**: string: The Virtual Hard Disk. -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** * **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [SubResource](#subresource) -* **snapshot**: [SubResource](#subresource) +* **id**: string: Resource Id * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## DiskEncryptionSetParameters +## NetworkInterfaceReference ### Properties * **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## ImageOSDisk +## NetworkInterfaceReferenceProperties +### Properties +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk ### Properties -* **blobUri**: string: The Virtual Hard Disk. * **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **diskSizeGB**: int: 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 -* **managedDisk**: [SubResource](#subresource) -* **osState**: 'Generalized' | 'Specialized' (Required): This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. -* **osType**: 'Linux' | 'Windows' (Required): This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** -* **snapshot**: [SubResource](#subresource) -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## OSDiskImageEncryption ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. + +## OSProfile +### Properties +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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). +* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. + +## Plan +### Properties +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. ## ProximityPlacementGroupProperties ### Properties @@ -517,194 +585,133 @@ * **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. * **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SubResourceWithColocationStatus +## RecommendedMachineConfiguration ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **id**: string: Resource Id +* **memory**: [ResourceRange](#resourcerange): Describes the resource range. +* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. -## ResourceTags +## RegionalReplicationStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery Image Version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. -## SshPublicKeyResourceProperties +## ReplicationStatus ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. + +## ResourceRange +### Properties +* **max**: int: The maximum number of the resource. +* **min**: int: The minimum number of the resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. - -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) - -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## Plan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. - -## VirtualMachineProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: 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 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## AdditionalCapabilities -### Properties -* **ultraSSDEnabled**: bool: 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. +* **Additional Properties Type**: string -## BillingProfile +## ResourceTags ### Properties -* **maxPrice**: int: 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. +### Additional Properties +* **Additional Properties Type**: string -## DiagnosticsProfile +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnostics +## ResourceTags ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot. +### Additional Properties +* **Additional Properties Type**: string -## HardwareProfile +## ResourceTags ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: 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) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineInstanceView +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnosticsInstanceView +## ResourceTags ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI. -* **serialConsoleLogBlobUri**: string (ReadOnly): The Linux serial console log blob Uri. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## DiskInstanceView +## ResourceTags ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionInstanceView +## ResourceTags ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## MaintenanceRedeployStatus +## ResourceTags ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineAgentInstanceView +## ResourceTags ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionHandlerInstanceView +## ResourceTags ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## NetworkProfile +## ResourceTags ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## NetworkInterfaceReference +## RollingUpgradePolicy ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). -## NetworkInterfaceReferenceProperties +## ScaleInPolicy ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## OSProfile +## ScheduledEventsProfile ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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). -* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## LinuxConfiguration +## Sku ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** ## SshConfiguration ### Properties @@ -715,98 +722,82 @@ * **keyData**: string: 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). * **path**: 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 -## VaultSecretGroup +## SshPublicKeyResourceProperties ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. -## VaultCertificate +## StorageProfile ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +* **dataDisks**: [DataDisk](#datadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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). -## WindowsConfiguration +## SubResource ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **provisionVMAgent**: bool: 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. -* **timeZone**: 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). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **id**: string: Resource Id -## AdditionalUnattendContent +## SubResourceReadOnly ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **id**: string (ReadOnly): Resource Id -## WinRMConfiguration +## SubResourceWithColocationStatus ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id -## WinRMListener +## TargetRegion ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -## StorageProfile +## TerminateNotificationProfile ### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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). +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) -## DataDisk +## UpgradePolicy ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## VirtualHardDisk +## UserArtifactManage ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. +* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. +* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. -## ManagedDiskParameters +## UserArtifactSource ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. +* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. -## ImageReference +## UserAssignedIdentitiesValue ### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## OSDisk +## VaultCertificate ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## DiffDiskSettings +## VaultSecretGroup ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. + +## VirtualHardDisk +### Properties +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -817,6 +808,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -829,97 +834,69 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## VirtualMachineScaleSetIdentity +## VirtualMachineIdentity ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. * **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetIdentityUserAssignedIdentities +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    - -## UpgradePolicy -### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutomaticOSUpgradePolicy -### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## RollingUpgradePolicy +## VirtualMachineInstanceView ### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -## VirtualMachineScaleSetVMProfile +## VirtualMachineProperties ### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) * **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. * **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. * **licenseType**: 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 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. * **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -928,6 +905,10 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -940,33 +921,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -985,69 +955,39 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile -### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. - -## ScheduledEventsProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## TerminateNotificationProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkProfile ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -1062,28 +1002,54 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: 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 -* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -1099,26 +1065,60 @@ * **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. * **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineHealthStatus -### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. - ## VirtualMachineScaleSetVMNetworkProfileConfiguration ### Properties * **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +## VirtualMachineScaleSetVMProfile +### Properties +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: 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 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. + +## VirtualMachineScaleSetVMProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: 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 +* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + ## VirtualMachineScaleSetVMProtectionPolicy ### Properties * **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. * **protectFromScaleSetActions**: bool: 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. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **provisionVMAgent**: bool: 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. +* **timeZone**: 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). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2020-05-01/types.md b/generated/compute/microsoft.compute/2020-05-01/types.md index f53458623e..5aa5c2d538 100644 --- a/generated/compute/microsoft.compute/2020-05-01/types.md +++ b/generated/compute/microsoft.compute/2020-05-01/types.md @@ -51,67 +51,23 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type +## CreationData +### Properties +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). + ## DiskAccessProperties ### Properties * **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. * **provisioningState**: string (ReadOnly): The disk access resource provisioning state. * **timeCreated**: string (ReadOnly): The time when the disk access was created. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionSetIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. - -## EncryptionSetProperties -### Properties -* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. -* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. - -## KeyVaultAndKeyReference -### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault -### Properties -* **id**: string: Resource Id - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DiskProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -134,27 +90,29 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). - -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -166,25 +124,68 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + +## KeyVaultAndKeyReference +### Properties +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + ## KeyVaultAndSecretReference ### Properties * **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault * **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ShareInfoElement +## PrivateEndpoint ### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## DiskSku +## PrivateEndpointConnection ### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ShareInfoElement +### Properties +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. + ## SnapshotProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -206,8 +207,7 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id diff --git a/generated/compute/microsoft.compute/2020-06-01/types.md b/generated/compute/microsoft.compute/2020-06-01/types.md index 7e62ca05ef..7aa363486b 100644 --- a/generated/compute/microsoft.compute/2020-06-01/types.md +++ b/generated/compute/microsoft.compute/2020-06-01/types.md @@ -166,6 +166,45 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## ApiError +### Properties +* **code**: string: The error code. +* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details +* **innererror**: [InnerError](#innererror): Inner error details. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApiErrorBase +### Properties +* **code**: string: The error code. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -174,28 +213,59 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## AvailablePatchSummary ### Properties -* **id**: string: Resource Id +* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. +* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", or "CompletedWithWarnings." -## InstanceViewStatus +## BillingProfile ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **maxPrice**: int: 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. -## Sku +## BootDiagnostics ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. -## ResourceTags +## BootDiagnosticsInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. + +## DataDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## DedicatedHostAllocatableVM +### Properties +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. + +## DedicatedHostAvailableCapacity +### Properties +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. + +## DedicatedHostGroupInstanceView +### Properties +* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. ## DedicatedHostGroupProperties ### Properties @@ -204,13 +274,11 @@ * **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. * **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. -## SubResourceReadOnly -### Properties -* **id**: string (ReadOnly): Resource Id - -## DedicatedHostGroupInstanceView +## DedicatedHostInstanceView ### Properties -* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DedicatedHostInstanceViewWithName ### Properties @@ -219,20 +287,6 @@ * **name**: string (ReadOnly): The name of the dedicated host. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## DedicatedHostAvailableCapacity -### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. - -## DedicatedHostAllocatableVM -### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DedicatedHostProperties ### Properties * **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. @@ -244,29 +298,34 @@ * **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. * **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## DedicatedHostInstanceView +## DiagnosticsProfile ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## ResourceTags +## DiffDiskSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements -## ImageProperties +## DiskEncryptionSetParameters ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **id**: string: Resource Id -## ImageStorageProfile +## DiskEncryptionSettings ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## HardwareProfile +### Properties +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes).

    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/en-us/rest/api/compute/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).

    This list of sizes is no longer updated and the **VirtualMachineSizeTypes** string constants will be removed from the subsequent REST API specification. Use [List all available virtual machine sizes in a region]( https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list) to get the latest sizes. ## ImageDataDisk ### Properties @@ -279,10 +338,6 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## DiskEncryptionSetParameters -### Properties -* **id**: string: Resource Id - ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -295,320 +350,254 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProximityPlacementGroupProperties +## ImageProperties ### Properties -* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## SubResourceWithColocationStatus +## ImageReference ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. * **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## ResourceTags +## ImageStorageProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## SshPublicKeyResourceProperties +## InnerError ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. -## ResourceTags +## InstanceViewStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## VirtualMachineIdentity +## KeyVaultKeyReference ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## VirtualMachineIdentityUserAssignedIdentities +## KeyVaultSecretReference ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## UserAssignedIdentitiesValue +## LastPatchInstallationSummary ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. +* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. +* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions +* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. +* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. +* **rebootStatus**: 'Completed' | 'Failed' | 'NotNeeded' | 'Required' | 'Started' | string (ReadOnly): The reboot status of the machine after the patch operation. It will be in "NotNeeded" status if reboot is not needed after the patch operation. "Required" will be the status once the patch is applied and machine is required to reboot. "Started" will be the reboot status when the machine has started to reboot. "Failed" will be the status if the machine is failed to reboot. "Completed" will be the status once the machine is rebooted successfully +* **startedBy**: string (ReadOnly): The person or system account that started the operation +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", or "CompletedWithWarnings." -## Plan +## LinuxConfiguration ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## VirtualMachineProperties +## MaintenanceRedeployStatus ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **hostGroup**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## AdditionalCapabilities -### Properties -* **ultraSSDEnabled**: bool: 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. - -## BillingProfile -### Properties -* **maxPrice**: int: 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. - -## DiagnosticsProfile -### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## BootDiagnostics +## ManagedDiskParameters ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## HardwareProfile +## NetworkInterfaceReference ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes).

    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/en-us/rest/api/compute/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).

    This list of sizes is no longer updated and the **VirtualMachineSizeTypes** string constants will be removed from the subsequent REST API specification. Use [List all available virtual machine sizes in a region]( https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list) to get the latest sizes. +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## VirtualMachineInstanceView +## NetworkInterfaceReferenceProperties ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## BootDiagnosticsInstanceView +## NetworkProfile ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. -## DiskInstanceView +## OSDisk ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. * **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. - -## DiskEncryptionSettings -### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key - -## KeyVaultSecretReference -### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) - -## KeyVaultKeyReference -### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## VirtualMachineExtensionInstanceView +## OSProfile ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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). +* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## MaintenanceRedeployStatus +## PatchSettings ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of in-guest patching to IaaS virtual machine.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true -## VirtualMachinePatchStatus +## Plan ### Properties -* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. -* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## AvailablePatchSummary +## ProximityPlacementGroupProperties ### Properties -* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. -* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", or "CompletedWithWarnings." +* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## ApiError +## ResourceTags ### Properties -* **code**: string: The error code. -* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details -* **innererror**: [InnerError](#innererror): Inner error details. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +### Additional Properties +* **Additional Properties Type**: string -## ApiErrorBase +## ResourceTags ### Properties -* **code**: string: The error code. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +### Additional Properties +* **Additional Properties Type**: string -## InnerError +## ResourceTags ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +### Additional Properties +* **Additional Properties Type**: string -## LastPatchInstallationSummary +## ResourceTags ### Properties -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. -* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. -* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions -* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. -* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. -* **rebootStatus**: 'Completed' | 'Failed' | 'NotNeeded' | 'Required' | 'Started' | string (ReadOnly): The reboot status of the machine after the patch operation. It will be in "NotNeeded" status if reboot is not needed after the patch operation. "Required" will be the status once the patch is applied and machine is required to reboot. "Started" will be the reboot status when the machine has started to reboot. "Failed" will be the status if the machine is failed to reboot. "Completed" will be the status once the machine is rebooted successfully -* **startedBy**: string (ReadOnly): The person or system account that started the operation -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", or "CompletedWithWarnings." +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineAgentInstanceView +## ResourceTags ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionHandlerInstanceView +## ResourceTags ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineHealthStatus +## ResourceTags ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## NetworkProfile +## ResourceTags ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## NetworkInterfaceReference +## ResourceTags ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +### Additional Properties +* **Additional Properties Type**: string -## NetworkInterfaceReferenceProperties +## ResourceTags ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: string -## OSProfile +## ResourceTags ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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). -* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +### Additional Properties +* **Additional Properties Type**: string -## LinuxConfiguration +## ResourceTags ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +### Additional Properties +* **Additional Properties Type**: string -## SshConfiguration +## ResourceTags ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +### Additional Properties +* **Additional Properties Type**: string -## SshPublicKey +## RollingUpgradePolicy ### Properties -* **keyData**: string: 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/en-us/azure/virtual-machines/linux/mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). -* **path**: 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 +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). -## VaultSecretGroup +## RunCommandInputParameter ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **name**: string (Required): The run command parameter name. +* **value**: string (Required): The run command parameter value. -## VaultCertificate +## ScaleInPolicy ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## WindowsConfiguration +## ScheduledEventsProfile ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **patchSettings**: [PatchSettings](#patchsettings) -* **provisionVMAgent**: bool: 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. -* **timeZone**: 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). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## AdditionalUnattendContent +## SecurityProfile ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. -## PatchSettings +## Sku ### Properties -* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of in-guest patching to IaaS virtual machine.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## WinRMConfiguration +## SshConfiguration ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## WinRMListener +## SshPublicKey ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **keyData**: string: 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/en-us/azure/virtual-machines/linux/mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). +* **path**: 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 -## SecurityProfile +## SshPublicKeyResourceProperties ### Properties -* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. ## StorageProfile ### Properties @@ -616,58 +605,54 @@ * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [OSDisk](#osdisk): 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). -## DataDisk +## SubResource ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **id**: string: Resource Id -## VirtualHardDisk +## SubResourceReadOnly ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **id**: string (ReadOnly): Resource Id -## ManagedDiskParameters +## SubResourceWithColocationStatus ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. * **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## ImageReference +## TerminateNotificationProfile ### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) -## OSDisk +## UpgradePolicy ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## DiffDiskSettings +## UserAssignedIdentitiesValue ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## VaultCertificate +### Properties +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } + +## VaultSecretGroup +### Properties +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. + +## VirtualHardDisk +### Properties +* **uri**: string: Specifies the virtual hard disk's uri. + +## VirtualMachineAgentInstanceView +### Properties +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -678,6 +663,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -691,34 +690,68 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## VirtualMachineIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## ResourceTags +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## VirtualMachineRunCommandProperties +## VirtualMachineInstanceView ### Properties -* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. -* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. -* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. -* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. -* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. + +## VirtualMachinePatchStatus +### Properties +* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. +* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. + +## VirtualMachineProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) +* **hostGroup**: [SubResource](#subresource) +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. -* **runAsUser**: string: Specifies the user account on the VM when executing the run command. -* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. -* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ## VirtualMachineRunCommandInstanceView ### Properties @@ -731,101 +764,37 @@ * **startTime**: string: Script start time. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## RunCommandInputParameter -### Properties -* **name**: string (Required): The run command parameter name. -* **value**: string (Required): The run command parameter value. - -## VirtualMachineRunCommandScriptSource -### Properties -* **commandId**: string: Specifies a commandId of predefined built-in script. -* **script**: string: Specifies the script content to be executed on the VM. -* **scriptUri**: string: Specifies the script download location. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. - -## VirtualMachineScaleSetIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties +## VirtualMachineRunCommandProperties ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **hostGroup**: [SubResource](#subresource) -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. +* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. +* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. +* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. +* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    - -## UpgradePolicy -### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutomaticOSUpgradePolicy -### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. - -## RollingUpgradePolicy -### Properties -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). +* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. +* **runAsUser**: string: Specifies the user account on the VM when executing the run command. +* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. +* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. -## VirtualMachineScaleSetVMProfile +## VirtualMachineRunCommandScriptSource ### Properties -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **commandId**: string: Specifies a commandId of predefined built-in script. +* **script**: string: Specifies the script content to be executed on the VM. +* **scriptUri**: string: Specifies the script download location. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -834,6 +803,11 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -847,34 +821,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -893,69 +855,40 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile -### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. - -## ScheduledEventsProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## TerminateNotificationProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkProfile ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -970,29 +903,55 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **hostGroup**: [SubResource](#subresource) +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -1013,18 +972,59 @@ ### Properties * **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +## VirtualMachineScaleSetVMProfile +### Properties +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. + +## VirtualMachineScaleSetVMProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + ## VirtualMachineScaleSetVMProtectionPolicy ### Properties * **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. * **protectFromScaleSetActions**: bool: 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. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **patchSettings**: [PatchSettings](#patchsettings) +* **provisionVMAgent**: bool: 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. +* **timeZone**: 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). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2020-06-30/types.md b/generated/compute/microsoft.compute/2020-06-30/types.md index 61465d280c..22bc7028b8 100644 --- a/generated/compute/microsoft.compute/2020-06-30/types.md +++ b/generated/compute/microsoft.compute/2020-06-30/types.md @@ -51,67 +51,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type +## CreationData +### Properties +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). + ## DiskAccessProperties ### Properties * **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. * **provisioningState**: string (ReadOnly): The disk access resource provisioning state. * **timeCreated**: string (ReadOnly): The time when the disk access was created. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionSetIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. - -## EncryptionSetProperties -### Properties -* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. -* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. - -## KeyVaultAndKeyReference -### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault -### Properties -* **id**: string: Resource Id - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DiskProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -135,28 +92,29 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). - -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. +* **previousKeys**: [KeyVaultAndKeyReference](#keyvaultandkeyreference)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -168,25 +126,68 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + +## KeyVaultAndKeyReference +### Properties +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + ## KeyVaultAndSecretReference ### Properties * **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault * **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ShareInfoElement +## PrivateEndpoint ### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## DiskSku +## PrivateEndpointConnection ### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ShareInfoElement +### Properties +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. + ## SnapshotProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -209,8 +210,7 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id diff --git a/generated/compute/microsoft.compute/2020-09-30/types.md b/generated/compute/microsoft.compute/2020-09-30/types.md index 7b2e3978c8..d5f5fc5a6d 100644 --- a/generated/compute/microsoft.compute/2020-09-30/types.md +++ b/generated/compute/microsoft.compute/2020-09-30/types.md @@ -117,71 +117,32 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type -## DiskAccessProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. -* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk access was created. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionSetIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. - -## EncryptionSetProperties -### Properties -* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots -* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. -* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. - -## KeyForDiskEncryptionSet +## CreationData ### Properties -* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault -* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). -## SourceVault +## DataDiskImageEncryption ### Properties -* **id**: string: Resource Id +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -## ResourceTags +## Disallowed ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskTypes**: string[]: A list of disk types. -## ExtendedLocation +## DiskAccessProperties ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. +* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk access was created. ## DiskProperties ### Properties @@ -208,28 +169,34 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData -### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). - -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionImages +### Properties +* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. +* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. + +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots +* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. +* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -241,62 +208,10 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference -### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## KeyVaultAndKeyReference -### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## PurchasePlan -### Properties -* **name**: string (Required): The plan ID. -* **product**: string (Required): Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The Offer Promotion Code. -* **publisher**: string (Required): The publisher ID. - -## ShareInfoElement -### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. - -## DiskSku -### Properties -* **name**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GalleryProperties -### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -* **sharingProfile**: [SharingProfile](#sharingprofile): Profile for gallery sharing to subscription or tenant - -## GalleryIdentifier -### Properties -* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. - -## SharingProfile -### Properties -* **groups**: [SharingProfileGroup](#sharingprofilegroup)[] (ReadOnly): A list of sharing profile groups. -* **permissions**: 'Groups' | 'Private' | string: This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups** - -## SharingProfileGroup -### Properties -* **ids**: string[]: A list of subscription/tenant ids the gallery is aimed to be shared to. -* **type**: 'AADTenants' | 'Subscriptions' | string: This property allows you to specify the type of sharing group.

    Possible values are:

    **Subscriptions**

    **AADTenants** - -## ResourceTags +## ExtendedLocation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. ## GalleryApplicationProperties ### Properties @@ -307,11 +222,6 @@ * **releaseNoteUri**: string: The release note uri. * **supportedOSType**: 'Linux' | 'Windows' (Required): This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -330,54 +240,32 @@ * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## UserArtifactManage -### Properties -* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. -* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. -* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. - -## UserArtifactSource -### Properties -* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. -* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. - -## TargetRegion -### Properties -* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. - -## EncryptionImages +## GalleryArtifactVersionSource ### Properties -* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. -* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. +* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. +* **uri**: string: The uri of the gallery artifact version source. Currently used to specify vhd/blob source. -## DataDiskImageEncryption +## GalleryDataDiskImage ### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' * **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## OSDiskImageEncryption -### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. - -## ReplicationStatus +## GalleryIdentifier ### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. +* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## RegionalReplicationStatus +## GalleryImageFeature ### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery image version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. +* **name**: string: The name of the gallery image feature. +* **value**: string: The value of the gallery image feature. -## ResourceTags +## GalleryImageIdentifier ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery image definition offer. +* **publisher**: string (Required): The name of the gallery image definition publisher. +* **sku**: string (Required): The name of the gallery image definition SKU. ## GalleryImageProperties ### Properties @@ -396,20 +284,45 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed +## GalleryImageVersionProperties ### Properties -* **diskTypes**: string[]: A list of disk types. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **publishingProfile**: [GalleryImageVersionPublishingProfile](#galleryimageversionpublishingprofile): The publishing profile of a gallery image Version. +* **replicationStatus**: [ReplicationStatus](#replicationstatus) (ReadOnly): This is the replication status of the gallery image version. +* **storageProfile**: [GalleryImageVersionStorageProfile](#galleryimageversionstorageprofile) (Required): This is the storage profile of a Gallery Image Version. -## GalleryImageFeature +## GalleryImageVersionPublishingProfile ### Properties -* **name**: string: The name of the gallery image feature. -* **value**: string: The value of the gallery image feature. +* **endOfLifeDate**: string: The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. +* **excludeFromLatest**: bool: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. +* **publishedDate**: string (ReadOnly): The timestamp for when the gallery image version is published. +* **replicaCount**: int: 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. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. +* **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## GalleryImageIdentifier +## GalleryImageVersionStorageProfile ### Properties -* **offer**: string (Required): The name of the gallery image definition offer. -* **publisher**: string (Required): The name of the gallery image definition publisher. -* **sku**: string (Required): The name of the gallery image definition SKU. +* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[]: A list of data disk images. +* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. + +## GalleryOSDiskImage +### Properties +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. + +## GalleryProperties +### Properties +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **sharingProfile**: [SharingProfile](#sharingprofile): Profile for gallery sharing to subscription or tenant + +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. ## ImagePurchasePlan ### Properties @@ -417,11 +330,72 @@ * **product**: string: The product ID. * **publisher**: string: The publisher ID. +## KeyForDiskEncryptionSet +### Properties +* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault +* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + +## KeyVaultAndKeyReference +### Properties +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + +## KeyVaultAndSecretReference +### Properties +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + +## OSDiskImageEncryption +### Properties +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + +## PurchasePlan +### Properties +* **name**: string (Required): The plan ID. +* **product**: string (Required): Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The Offer Promotion Code. +* **publisher**: string (Required): The publisher ID. + ## RecommendedMachineConfiguration ### Properties * **memory**: [ResourceRange](#resourcerange): Describes the resource range. * **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. +## RegionalReplicationStatus +### Properties +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery image version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. + +## ReplicationStatus +### Properties +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. + ## ResourceRange ### Properties * **max**: int: The maximum number of the resource. @@ -432,51 +406,60 @@ ### Additional Properties * **Additional Properties Type**: string -## GalleryImageVersionProperties +## ResourceTags ### Properties -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -* **publishingProfile**: [GalleryImageVersionPublishingProfile](#galleryimageversionpublishingprofile): The publishing profile of a gallery image Version. -* **replicationStatus**: [ReplicationStatus](#replicationstatus) (ReadOnly): This is the replication status of the gallery image version. -* **storageProfile**: [GalleryImageVersionStorageProfile](#galleryimageversionstorageprofile) (Required): This is the storage profile of a Gallery Image Version. +### Additional Properties +* **Additional Properties Type**: string -## GalleryImageVersionPublishingProfile +## ResourceTags ### Properties -* **endOfLifeDate**: string: The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. -* **excludeFromLatest**: bool: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. -* **publishedDate**: string (ReadOnly): The timestamp for when the gallery image version is published. -* **replicaCount**: int: 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. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -* **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. +### Additional Properties +* **Additional Properties Type**: string -## GalleryImageVersionStorageProfile +## ResourceTags ### Properties -* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[]: A list of data disk images. -* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +### Additional Properties +* **Additional Properties Type**: string -## GalleryDataDiskImage +## ResourceTags ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +### Additional Properties +* **Additional Properties Type**: string -## GalleryArtifactVersionSource +## ResourceTags ### Properties -* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. -* **uri**: string: The uri of the gallery artifact version source. Currently used to specify vhd/blob source. +### Additional Properties +* **Additional Properties Type**: string -## GalleryOSDiskImage +## ResourceTags ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ShareInfoElement +### Properties +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. + +## SharingProfile +### Properties +* **groups**: [SharingProfileGroup](#sharingprofilegroup)[] (ReadOnly): A list of sharing profile groups. +* **permissions**: 'Groups' | 'Private' | string: This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups** + +## SharingProfileGroup +### Properties +* **ids**: string[]: A list of subscription/tenant ids the gallery is aimed to be shared to. +* **type**: 'AADTenants' | 'Subscriptions' | string: This property allows you to specify the type of sharing group.

    Possible values are:

    **Subscriptions**

    **AADTenants** + ## SnapshotProperties ### Properties * **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. @@ -500,8 +483,25 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id + +## TargetRegion +### Properties +* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. + +## UserArtifactManage +### Properties +* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. +* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. +* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. + +## UserArtifactSource +### Properties +* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. +* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. diff --git a/generated/compute/microsoft.compute/2020-10-01-preview/types.md b/generated/compute/microsoft.compute/2020-10-01-preview/types.md index cc91069f7e..1a6a658a5c 100644 --- a/generated/compute/microsoft.compute/2020-10-01-preview/types.md +++ b/generated/compute/microsoft.compute/2020-10-01-preview/types.md @@ -19,6 +19,36 @@ * **name**: int (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.Compute/cloudServices/updateDomains' (ReadOnly, DeployTimeConstant): The resource type +## CloudServiceExtensionProfile +### Properties +* **extensions**: [Extension](#extension)[]: List of extensions for the cloud service. + +## CloudServiceExtensionProperties +### Properties +* **autoUpgradeMinorVersion**: bool: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. +* **forceUpdateTag**: string: Tag to force apply the provided public and protected settings. +Changing the tag value allows for re-running the extension without changing any of the public or protected settings. +If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. +If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and +it is up to handler implementation whether to re-run it or not +* **protectedSettings**: string: Protected settings for the extension which are encrypted before sent to the role instance. +* **protectedSettingsFromKeyVault**: [CloudServiceVaultAndSecretReference](#cloudservicevaultandsecretreference) +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string: The name of the extension handler publisher. +* **rolesAppliedTo**: string[]: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. +* **settings**: string: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. +* **type**: string: Specifies the type of the extension. +* **typeHandlerVersion**: string: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. + +## CloudServiceNetworkProfile +### Properties +* **loadBalancerConfigurations**: [LoadBalancerConfiguration](#loadbalancerconfiguration)[]: The list of load balancer configurations for the cloud service. +* **swappableCloudService**: [SubResource](#subresource) + +## CloudServiceOsProfile +### Properties +* **secrets**: [CloudServiceVaultSecretGroup](#cloudservicevaultsecretgroup)[]: Specifies set of certificates that should be installed onto the role instances. + ## CloudServiceProperties ### Properties * **configuration**: string: Specifies the XML service configuration (.cscfg) for the cloud service. @@ -38,45 +68,44 @@ If false, the service model is still deployed, but the code is not run immediate Possible Values are

    **Auto**

    **Manual**

    **Simultaneous**

    If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence. -## CloudServiceExtensionProfile +## CloudServiceRoleProfile ### Properties -* **extensions**: [Extension](#extension)[]: List of extensions for the cloud service. +* **roles**: [CloudServiceRoleProfileProperties](#cloudserviceroleprofileproperties)[]: List of roles for the cloud service. -## Extension +## CloudServiceRoleProfileProperties ### Properties -* **name**: string: The name of the extension. -* **properties**: [CloudServiceExtensionProperties](#cloudserviceextensionproperties): Extension Properties. +* **name**: string: Resource name. +* **sku**: [CloudServiceRoleSku](#cloudservicerolesku): Describes the cloud service role sku. -## CloudServiceExtensionProperties +## CloudServiceRoleSku ### Properties -* **autoUpgradeMinorVersion**: bool: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. -* **forceUpdateTag**: string: Tag to force apply the provided public and protected settings. -Changing the tag value allows for re-running the extension without changing any of the public or protected settings. -If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. -If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and -it is up to handler implementation whether to re-run it or not -* **protectedSettings**: string: Protected settings for the extension which are encrypted before sent to the role instance. -* **protectedSettingsFromKeyVault**: [CloudServiceVaultAndSecretReference](#cloudservicevaultandsecretreference) -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **rolesAppliedTo**: string[]: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. -* **settings**: string: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. -* **type**: string: Specifies the type of the extension. -* **typeHandlerVersion**: string: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. +* **capacity**: int: Specifies the number of role instances in the cloud service. +* **name**: string: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. +* **tier**: string: Specifies the tier of the cloud service. Possible Values are

    **Standard**

    **Basic** + +## CloudServiceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## CloudServiceVaultAndSecretReference ### Properties * **secretUrl**: string * **sourceVault**: [SubResource](#subresource) -## SubResource +## CloudServiceVaultCertificate ### Properties -* **id**: string: Resource Id +* **certificateUrl**: string: This is the URL of a certificate that has been uploaded to Key Vault as a secret. -## CloudServiceNetworkProfile +## CloudServiceVaultSecretGroup ### Properties -* **loadBalancerConfigurations**: [LoadBalancerConfiguration](#loadbalancerconfiguration)[]: The list of load balancer configurations for the cloud service. -* **swappableCloudService**: [SubResource](#subresource) +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [CloudServiceVaultCertificate](#cloudservicevaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. + +## Extension +### Properties +* **name**: string: The name of the extension. +* **properties**: [CloudServiceExtensionProperties](#cloudserviceextensionproperties): Extension Properties. ## LoadBalancerConfiguration ### Properties @@ -98,36 +127,7 @@ it is up to handler implementation whether to re-run it or not * **publicIPAddress**: [SubResource](#subresource) * **subnet**: [SubResource](#subresource) -## CloudServiceOsProfile -### Properties -* **secrets**: [CloudServiceVaultSecretGroup](#cloudservicevaultsecretgroup)[]: Specifies set of certificates that should be installed onto the role instances. - -## CloudServiceVaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [CloudServiceVaultCertificate](#cloudservicevaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. - -## CloudServiceVaultCertificate -### Properties -* **certificateUrl**: string: This is the URL of a certificate that has been uploaded to Key Vault as a secret. - -## CloudServiceRoleProfile -### Properties -* **roles**: [CloudServiceRoleProfileProperties](#cloudserviceroleprofileproperties)[]: List of roles for the cloud service. - -## CloudServiceRoleProfileProperties -### Properties -* **name**: string: Resource name. -* **sku**: [CloudServiceRoleSku](#cloudservicerolesku): Describes the cloud service role sku. - -## CloudServiceRoleSku -### Properties -* **capacity**: int: Specifies the number of role instances in the cloud service. -* **name**: string: The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. -* **tier**: string: Specifies the tier of the cloud service. Possible Values are

    **Standard**

    **Basic** - -## CloudServiceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id diff --git a/generated/compute/microsoft.compute/2020-12-01/types.md b/generated/compute/microsoft.compute/2020-12-01/types.md index 7d0c97c22a..88de95e967 100644 --- a/generated/compute/microsoft.compute/2020-12-01/types.md +++ b/generated/compute/microsoft.compute/2020-12-01/types.md @@ -231,6 +231,45 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## ApiError +### Properties +* **code**: string: The error code. +* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details +* **innererror**: [InnerError](#innererror): Inner error details. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApiErrorBase +### Properties +* **code**: string: The error code. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -239,96 +278,134 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## AvailablePatchSummary ### Properties -* **id**: string: Resource Id +* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. +* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## InstanceViewStatus +## BillingProfile ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **maxPrice**: int: 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. -## Sku +## BootDiagnostics ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. -## ResourceTags +## BootDiagnosticsInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## DiskAccessProperties +## CreationData ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. -* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk access was created. +* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). -## PrivateEndpointConnection +## DataDisk ### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## PrivateEndpointConnectionProperties +## DedicatedHostAllocatableVM ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. -## PrivateEndpoint +## DedicatedHostAvailableCapacity ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. -## PrivateLinkServiceConnectionState +## DedicatedHostGroupInstanceView ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. -## ResourceTags +## DedicatedHostGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. +* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. -## EncryptionSetIdentity +## DedicatedHostInstanceView ### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## EncryptionSetProperties +## DedicatedHostInstanceViewWithName ### Properties -* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots -* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. -* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. -* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. -* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **name**: string (ReadOnly): The name of the dedicated host. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## KeyForDiskEncryptionSet +## DedicatedHostProperties ### Properties -* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. -* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. +* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. +* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. +* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** +* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. +* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## SourceVault +## DiagnosticsProfile +### Properties +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. + +## DiffDiskSettings +### Properties +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + +## DiskAccessProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. +* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk access was created. + +## DiskEncryptionSetParameters ### Properties * **id**: string: Resource Id -## ResourceTags +## DiskEncryptionSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## ExtendedLocation +## DiskInstanceView ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DiskProperties ### Properties @@ -358,28 +435,35 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData +## DiskSecurityProfile ### Properties -* **createOption**: 'Attach' | 'Copy' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). +* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots +* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. +* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. +* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. +* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -391,439 +475,387 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference +## ExtendedLocation ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## KeyVaultAndKeyReference +## HardwareProfile ### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/en-us/rest/api/compute/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. -## PropertyUpdatesInProgress +## ImageDataDisk ### Properties -* **targetTier**: string: The target performance tier of the disk if a tier change operation is in progress. +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [SubResource](#subresource) +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## PurchasePlan +## ImageDiskReference ### Properties -* **name**: string (Required): The plan ID. -* **product**: string (Required): Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The Offer Promotion Code. -* **publisher**: string (Required): The publisher ID. +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. -## DiskSecurityProfile -### Properties -* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. - -## ShareInfoElement +## ImageOSDisk ### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. +* **blobUri**: string: The Virtual Hard Disk. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **diskSizeGB**: int: 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 +* **managedDisk**: [SubResource](#subresource) +* **osState**: 'Generalized' | 'Specialized' (Required): The OS State. +* **osType**: 'Linux' | 'Windows' (Required): The Operating System type. +* **snapshot**: [SubResource](#subresource) +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## DiskSku +## ImageProperties ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ResourceTags +## ImageReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## DedicatedHostGroupProperties +## ImageStorageProfile ### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. -* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## SubResourceReadOnly +## InnerError ### Properties -* **id**: string (ReadOnly): Resource Id +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. -## DedicatedHostGroupInstanceView +## InstanceViewStatus ### Properties -* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## DedicatedHostInstanceViewWithName +## KeyForDiskEncryptionSet ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **name**: string (ReadOnly): The name of the dedicated host. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. +* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DedicatedHostAvailableCapacity +## KeyVaultAndKeyReference ### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DedicatedHostAllocatableVM +## KeyVaultAndSecretReference ### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## ResourceTags +## KeyVaultKeyReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## DedicatedHostProperties +## KeyVaultSecretReference ### Properties -* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. -* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. -* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. -* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** -* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. -* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## DedicatedHostInstanceView +## LastPatchInstallationSummary ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. +* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. +* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions +* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. +* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## ResourceTags +## LinuxConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## ImageProperties +## LinuxPatchSettings ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true -## ImageStorageProfile +## MaintenanceRedeployStatus ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## ImageDataDisk +## ManagedDiskParameters ### Properties -* **blobUri**: string: The Virtual Hard Disk. -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** * **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [SubResource](#subresource) -* **snapshot**: [SubResource](#subresource) -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types - -## DiskEncryptionSetParameters -### Properties * **id**: string: Resource Id - -## ImageOSDisk -### Properties -* **blobUri**: string: The Virtual Hard Disk. -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **diskSizeGB**: int: 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 -* **managedDisk**: [SubResource](#subresource) -* **osState**: 'Generalized' | 'Specialized' (Required): The OS State. -* **osType**: 'Linux' | 'Windows' (Required): The Operating System type. -* **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProximityPlacementGroupProperties +## NetworkInterfaceReference ### Properties -* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## SubResourceWithColocationStatus +## NetworkInterfaceReferenceProperties ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **id**: string: Resource Id +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## ResourceTags +## NetworkProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. -## SnapshotProperties +## OSDisk ### Properties -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskAccessId**: string: ARM id of the DiskAccess resource for using private endpoints on disks. -* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. -* **diskSizeGB**: int: 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. -* **diskState**: 'ActiveSAS' | 'ActiveUpload' | 'Attached' | 'ReadyToUpload' | 'Reserved' | 'Unattached' | string (ReadOnly): This enumerates the possible state of the disk. -* **encryption**: [Encryption](#encryption): Encryption at rest settings for disk or snapshot -* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot -* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. -* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. -* **networkAccessPolicy**: 'AllowAll' | 'AllowPrivate' | 'DenyAll' | string: Policy for accessing the disk via network. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. * **osType**: 'Linux' | 'Windows': The Operating System type. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **purchasePlan**: [PurchasePlan](#purchaseplan): Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. -* **supportsHibernation**: bool: Indicates the OS on a snapshot supports hibernation. -* **timeCreated**: string (ReadOnly): The time when the snapshot was created. -* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## SnapshotSku +## OSProfile ### Properties -* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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). +* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## ResourceTags +## PatchSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. +* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true -## SshPublicKeyResourceProperties +## Plan ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## ResourceTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## VirtualMachineIdentity +## PrivateEndpointConnection ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type -## VirtualMachineIdentityUserAssignedIdentities +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## UserAssignedIdentitiesValue +## PrivateLinkServiceConnectionState ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Plan +## PropertyUpdatesInProgress ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +* **targetTier**: string: The target performance tier of the disk if a tier change operation is in progress. -## VirtualMachineProperties +## ProximityPlacementGroupProperties ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **hostGroup**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## AdditionalCapabilities +## PurchasePlan ### Properties -* **ultraSSDEnabled**: bool: 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. +* **name**: string (Required): The plan ID. +* **product**: string (Required): Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The Offer Promotion Code. +* **publisher**: string (Required): The publisher ID. -## BillingProfile +## ResourceTags ### Properties -* **maxPrice**: int: 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. +### Additional Properties +* **Additional Properties Type**: string -## DiagnosticsProfile +## ResourceTags ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnostics +## ResourceTags ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. +### Additional Properties +* **Additional Properties Type**: string -## HardwareProfile +## ResourceTags ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/en-us/rest/api/compute/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineInstanceView +## ResourceTags ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnosticsInstanceView +## ResourceTags ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## DiskInstanceView +## ResourceTags ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionInstanceView +## ResourceTags ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +### Additional Properties +* **Additional Properties Type**: string -## MaintenanceRedeployStatus +## ResourceTags ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachinePatchStatus +## ResourceTags ### Properties -* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. -* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode -* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. +### Additional Properties +* **Additional Properties Type**: string -## AvailablePatchSummary +## ResourceTags ### Properties -* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. -* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +### Additional Properties +* **Additional Properties Type**: string -## ApiError +## ResourceTags ### Properties -* **code**: string: The error code. -* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details -* **innererror**: [InnerError](#innererror): Inner error details. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +### Additional Properties +* **Additional Properties Type**: string -## ApiErrorBase +## ResourceTags ### Properties -* **code**: string: The error code. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +### Additional Properties +* **Additional Properties Type**: string -## InnerError +## ResourceTags ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +### Additional Properties +* **Additional Properties Type**: string -## LastPatchInstallationSummary +## RollingUpgradePolicy ### Properties -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. -* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. -* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions -* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. -* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). +* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. -## VirtualMachineAgentInstanceView +## RunCommandInputParameter ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **name**: string (Required): The run command parameter name. +* **value**: string (Required): The run command parameter value. -## VirtualMachineExtensionHandlerInstanceView +## ScaleInPolicy ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## VirtualMachineHealthStatus +## ScheduledEventsProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## NetworkProfile +## SecurityProfile ### Properties -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. +* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 -## NetworkInterfaceReference +## ShareInfoElement ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. -## NetworkInterfaceReferenceProperties +## Sku ### Properties -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## OSProfile +## SnapshotProperties ### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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). -* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskAccessId**: string: ARM id of the DiskAccess resource for using private endpoints on disks. +* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. +* **diskSizeGB**: int: 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. +* **diskState**: 'ActiveSAS' | 'ActiveUpload' | 'Attached' | 'ReadyToUpload' | 'Reserved' | 'Unattached' | string (ReadOnly): This enumerates the possible state of the disk. +* **encryption**: [Encryption](#encryption): Encryption at rest settings for disk or snapshot +* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot +* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. +* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. +* **networkAccessPolicy**: 'AllowAll' | 'AllowPrivate' | 'DenyAll' | string: Policy for accessing the disk via network. +* **osType**: 'Linux' | 'Windows': The Operating System type. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **purchasePlan**: [PurchasePlan](#purchaseplan): Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. +* **supportsHibernation**: bool: Indicates the OS on a snapshot supports hibernation. +* **timeCreated**: string (ReadOnly): The time when the snapshot was created. +* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## LinuxConfiguration +## SnapshotSku ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. -## LinuxPatchSettings +## SourceVault ### Properties -* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true +* **id**: string: Resource Id ## SshConfiguration ### Properties @@ -834,116 +866,69 @@ * **keyData**: string: 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/en-us/azure/virtual-machines/linux/mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). * **path**: 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 -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. - -## VaultCertificate -### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    } - -## WindowsConfiguration +## SshPublicKeyResourceProperties ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. -* **provisionVMAgent**: bool: 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. -* **timeZone**: 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). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. -## AdditionalUnattendContent +## StorageProfile ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **dataDisks**: [DataDisk](#datadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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). -## PatchSettings +## SubResource ### Properties -* **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. -* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true +* **id**: string: Resource Id -## WinRMConfiguration +## SubResourceReadOnly ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **id**: string (ReadOnly): Resource Id -## WinRMListener +## SubResourceWithColocationStatus ### Properties -* **certificateUrl**: 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":""
    } -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id -## SecurityProfile +## TerminateNotificationProfile ### Properties -* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. -* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) ## UefiSettings ### Properties * **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 * **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -## StorageProfile -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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). - -## DataDisk +## UpgradePolicy ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## VirtualHardDisk +## UserAssignedIdentitiesValue ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedDiskParameters +## VaultCertificate ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    } -## ImageReference +## VaultSecretGroup ### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The Operating System type. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **uri**: string: Specifies the virtual hard disk's uri. -## DiffDiskSettings +## VirtualMachineAgentInstanceView ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -954,6 +939,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -967,34 +966,70 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## VirtualMachineIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## ResourceTags +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## VirtualMachineRunCommandProperties +## VirtualMachineInstanceView ### Properties -* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. -* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. -* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. -* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. -* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. + +## VirtualMachinePatchStatus +### Properties +* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. +* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode +* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. + +## VirtualMachineProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) +* **hostGroup**: [SubResource](#subresource) +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. -* **runAsUser**: string: Specifies the user account on the VM when executing the run command. -* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. -* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. ## VirtualMachineRunCommandInstanceView ### Properties @@ -1007,104 +1042,37 @@ * **startTime**: string: Script start time. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## RunCommandInputParameter -### Properties -* **name**: string (Required): The run command parameter name. -* **value**: string (Required): The run command parameter value. - -## VirtualMachineRunCommandScriptSource -### Properties -* **commandId**: string: Specifies a commandId of predefined built-in script. -* **script**: string: Specifies the script content to be executed on the VM. -* **scriptUri**: string: Specifies the script download location. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. - -## VirtualMachineScaleSetIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties +## VirtualMachineRunCommandProperties ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **hostGroup**: [SubResource](#subresource) -* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. +* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. +* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. +* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. +* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    - -## UpgradePolicy -### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutomaticOSUpgradePolicy -### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. - -## RollingUpgradePolicy -### Properties -* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). -* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. +* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. +* **runAsUser**: string: Specifies the user account on the VM when executing the run command. +* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. +* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. -## VirtualMachineScaleSetVMProfile +## VirtualMachineRunCommandScriptSource ### Properties -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **commandId**: string: Specifies a commandId of predefined built-in script. +* **script**: string: Specifies the script content to be executed on the VM. +* **scriptUri**: string: Specifies the script download location. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -1113,6 +1081,11 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1126,34 +1099,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1172,69 +1133,40 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile -### Properties -* **adminPassword**: string: 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) -* **adminUsername**: 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) -* **computerNamePrefix**: 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. -* **customData**: 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) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. - -## ScheduledEventsProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types -## TerminateNotificationProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkProfile ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -1249,29 +1181,56 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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) +* **adminUsername**: 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) +* **computerNamePrefix**: 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. +* **customData**: 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) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. -* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **hostGroup**: [SubResource](#subresource) +* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -1292,18 +1251,59 @@ ### Properties * **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +## VirtualMachineScaleSetVMProfile +### Properties +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. + +## VirtualMachineScaleSetVMProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces of the virtual machine. +* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **vmId**: string (ReadOnly): Azure VM unique ID. + ## VirtualMachineScaleSetVMProtectionPolicy ### Properties * **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. * **protectFromScaleSetActions**: bool: 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. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. +* **provisionVMAgent**: bool: 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. +* **timeZone**: 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). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    } +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2021-03-01/types.md b/generated/compute/microsoft.compute/2021-03-01/types.md index f687ef6604..c1ef8c6cf5 100644 --- a/generated/compute/microsoft.compute/2021-03-01/types.md +++ b/generated/compute/microsoft.compute/2021-03-01/types.md @@ -208,6 +208,45 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## ApiErrorAutoGenerated +### Properties +* **code**: string: The error code. +* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details +* **innererror**: [InnerError](#innererror): Inner error details. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApiErrorBase +### Properties +* **code**: string: The error code. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -216,59 +255,36 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource -### Properties -* **id**: string: Resource Id - -## InstanceViewStatus +## AvailablePatchSummary ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. +* **error**: [ApiErrorAutoGenerated](#apierrorautogenerated) (ReadOnly): Api error. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. +* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## Sku +## BillingProfile ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **maxPrice**: int: 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. -## ResourceTags +## BootDiagnostics ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. -## CloudServiceProperties +## BootDiagnosticsInstanceView ### Properties -* **allowModelOverride**: bool: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. -The default value is `false`. -* **configuration**: string: Specifies the XML service configuration (.cscfg) for the cloud service. -* **configurationUrl**: string: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. -This is a write-only property and is not returned in GET calls. -* **extensionProfile**: [CloudServiceExtensionProfile](#cloudserviceextensionprofile): Describes a cloud service extension profile. -* **networkProfile**: [CloudServiceNetworkProfile](#cloudservicenetworkprofile): Network Profile for the cloud service. -* **osProfile**: [CloudServiceOsProfile](#cloudserviceosprofile): Describes the OS profile for the cloud service. -* **packageUrl**: string: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. -This is a write-only property and is not returned in GET calls. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **roleProfile**: [CloudServiceRoleProfile](#cloudserviceroleprofile): Describes the role profile for the cloud service. -* **startCloudService**: bool: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. -If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff. -* **uniqueId**: string (ReadOnly): The unique identifier for the cloud service. -* **upgradeMode**: 'Auto' | 'Manual' | 'Simultaneous' | string: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. -Possible Values are

    **Auto**

    **Manual**

    **Simultaneous**

    -If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence. +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. ## CloudServiceExtensionProfile ### Properties * **extensions**: [Extension](#extension)[]: List of extensions for the cloud service. -## Extension -### Properties -* **name**: string: The name of the extension. -* **properties**: [CloudServiceExtensionProperties](#cloudserviceextensionproperties): Extension Properties. - ## CloudServiceExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. @@ -286,49 +302,35 @@ it is up to handler implementation whether to re-run it or not * **type**: string: Specifies the type of the extension. * **typeHandlerVersion**: string: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. -## CloudServiceVaultAndSecretReference -### Properties -* **secretUrl**: string -* **sourceVault**: [SubResource](#subresource) - ## CloudServiceNetworkProfile ### Properties * **loadBalancerConfigurations**: [LoadBalancerConfiguration](#loadbalancerconfiguration)[]: List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. * **swappableCloudService**: [SubResource](#subresource) -## LoadBalancerConfiguration -### Properties -* **id**: string: Resource Id -* **name**: string (Required): The name of the Load balancer -* **properties**: [LoadBalancerConfigurationProperties](#loadbalancerconfigurationproperties) (Required) - -## LoadBalancerConfigurationProperties -### Properties -* **frontendIPConfigurations**: [LoadBalancerFrontendIPConfiguration](#loadbalancerfrontendipconfiguration)[] (Required): Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. - -## LoadBalancerFrontendIPConfiguration -### Properties -* **name**: string (Required): 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. -* **properties**: [LoadBalancerFrontendIPConfigurationProperties](#loadbalancerfrontendipconfigurationproperties) (Required): Describes a cloud service IP Configuration - -## LoadBalancerFrontendIPConfigurationProperties -### Properties -* **privateIPAddress**: string: The virtual network private IP address of the IP configuration. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - ## CloudServiceOsProfile ### Properties * **secrets**: [CloudServiceVaultSecretGroup](#cloudservicevaultsecretgroup)[]: Specifies set of certificates that should be installed onto the role instances. -## CloudServiceVaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [CloudServiceVaultCertificate](#cloudservicevaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. - -## CloudServiceVaultCertificate +## CloudServiceProperties ### Properties -* **certificateUrl**: string: This is the URL of a certificate that has been uploaded to Key Vault as a secret. +* **allowModelOverride**: bool: (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively. +The default value is `false`. +* **configuration**: string: Specifies the XML service configuration (.cscfg) for the cloud service. +* **configurationUrl**: string: Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. +This is a write-only property and is not returned in GET calls. +* **extensionProfile**: [CloudServiceExtensionProfile](#cloudserviceextensionprofile): Describes a cloud service extension profile. +* **networkProfile**: [CloudServiceNetworkProfile](#cloudservicenetworkprofile): Network Profile for the cloud service. +* **osProfile**: [CloudServiceOsProfile](#cloudserviceosprofile): Describes the OS profile for the cloud service. +* **packageUrl**: string: Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account. +This is a write-only property and is not returned in GET calls. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **roleProfile**: [CloudServiceRoleProfile](#cloudserviceroleprofile): Describes the role profile for the cloud service. +* **startCloudService**: bool: (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`. +If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff. +* **uniqueId**: string (ReadOnly): The unique identifier for the cloud service. +* **upgradeMode**: 'Auto' | 'Manual' | 'Simultaneous' | string: Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains. +Possible Values are

    **Auto**

    **Manual**

    **Simultaneous**

    +If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence. ## CloudServiceRoleProfile ### Properties @@ -350,41 +352,69 @@ it is up to handler implementation whether to re-run it or not ### Additional Properties * **Additional Properties Type**: string -## DedicatedHostGroupProperties +## CloudServiceVaultAndSecretReference ### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. -* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. +* **secretUrl**: string +* **sourceVault**: [SubResource](#subresource) -## SubResourceReadOnly +## CloudServiceVaultCertificate ### Properties -* **id**: string (ReadOnly): Resource Id +* **certificateUrl**: string: This is the URL of a certificate that has been uploaded to Key Vault as a secret. -## DedicatedHostGroupInstanceView +## CloudServiceVaultSecretGroup ### Properties -* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [CloudServiceVaultCertificate](#cloudservicevaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## DedicatedHostInstanceViewWithName +## DataDisk ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **name**: string (ReadOnly): The name of the dedicated host. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## DedicatedHostAllocatableVM +### Properties +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. ## DedicatedHostAvailableCapacity ### Properties * **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. -## DedicatedHostAllocatableVM +## DedicatedHostGroupInstanceView ### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. +* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. -## ResourceTags +## DedicatedHostGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. +* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. + +## DedicatedHostInstanceView +### Properties +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## DedicatedHostInstanceViewWithName +### Properties +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **name**: string (ReadOnly): The name of the dedicated host. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DedicatedHostProperties ### Properties @@ -397,34 +427,44 @@ it is up to handler implementation whether to re-run it or not * **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. * **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## DedicatedHostInstanceView +## DiagnosticsProfile ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## ResourceTags +## DiffDiskSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + +## DiskEncryptionSetParameters +### Properties +* **id**: string: Resource Id + +## DiskEncryptionSettings +### Properties +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ImageProperties +## Extension ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **name**: string: The name of the extension. +* **properties**: [CloudServiceExtensionProperties](#cloudserviceextensionproperties): Extension Properties. -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. ## ImageDataDisk ### Properties @@ -437,10 +477,6 @@ it is up to handler implementation whether to re-run it or not * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## DiskEncryptionSetParameters -### Properties -* **id**: string: Resource Id - ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -453,137 +489,156 @@ it is up to handler implementation whether to re-run it or not * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## ResourceTags +## ImageProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ProximityPlacementGroupProperties +## ImageReference ### Properties -* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## SubResourceWithColocationStatus +## ImageStorageProfile ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **id**: string: Resource Id +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## ResourceTags +## InnerError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. -## RestorePointCollectionProperties +## InstanceViewStatus ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. -* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. -* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. -* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## RestorePoint +## KeyVaultKeyReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string (ReadOnly): Resource name -* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. -* **type**: string (ReadOnly): Resource type +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## RestorePointProperties +## KeyVaultSecretReference ### Properties -* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. -* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. -* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. -* **timeCreated**: string: Gets the creation time of the restore point. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ApiEntityReference +## LastPatchInstallationSummary ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **error**: [ApiErrorAutoGenerated](#apierrorautogenerated) (ReadOnly): Api error. +* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. +* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. +* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions +* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. +* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## RestorePointSourceMetadata +## LinuxConfiguration ### Properties -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **licenseType**: string: Gets the license type, which is for bring your own license scenario. -* **location**: string: Location of the VM from which the restore point was created. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. -* **vmId**: string: Gets the virtual machine unique id. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## DiagnosticsProfile +## LinuxPatchSettings ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. +* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true -## BootDiagnostics +## LoadBalancerConfiguration ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. +* **id**: string: Resource Id +* **name**: string (Required): The name of the Load balancer +* **properties**: [LoadBalancerConfigurationProperties](#loadbalancerconfigurationproperties) (Required) -## HardwareProfile +## LoadBalancerConfigurationProperties ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. +* **frontendIPConfigurations**: [LoadBalancerFrontendIPConfiguration](#loadbalancerfrontendipconfiguration)[] (Required): Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration. -## OSProfile +## LoadBalancerFrontendIPConfiguration ### Properties -* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) -* **adminUsername**: 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. -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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/azure-resource-manager/management/resource-name-rules). -* **customData**: 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://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)

    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/linux/using-cloud-init) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **name**: string (Required): 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. +* **properties**: [LoadBalancerFrontendIPConfigurationProperties](#loadbalancerfrontendipconfigurationproperties) (Required): Describes a cloud service IP Configuration -## LinuxConfiguration +## LoadBalancerFrontendIPConfigurationProperties ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **privateIPAddress**: string: The virtual network private IP address of the IP configuration. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## LinuxPatchSettings +## MaintenanceRedeployStatus ### Properties -* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. -* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## SshConfiguration +## ManagedDiskParameters ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## SshPublicKey +## NetworkInterfaceReference ### Properties -* **keyData**: string: 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/linux/create-ssh-keys-detailed). -* **path**: 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 +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## VaultSecretGroup +## NetworkInterfaceReferenceProperties ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VaultCertificate +## NetworkProfile ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. -## WindowsConfiguration +## OSDisk ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## AdditionalUnattendContent +## OSProfile ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) +* **adminUsername**: 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. +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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/azure-resource-manager/management/resource-name-rules). +* **customData**: 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://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)

    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/linux/using-cloud-init) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. ## PatchSettings ### Properties @@ -591,247 +646,258 @@ it is up to handler implementation whether to re-run it or not * **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. * **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true -## WinRMConfiguration +## Plan ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## WinRMListener +## ProximityPlacementGroupProperties ### Properties -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SecurityProfile +## PublicIPAddressSku ### Properties -* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. -* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 +* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name +* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier -## UefiSettings +## ResourceTags ### Properties -* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVMStorageProfile +## ResourceTags ### Properties -* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. -* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVMDataDisk +## ResourceTags ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. -* **lun**: int: Gets the logical unit number. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. +### Additional Properties +* **Additional Properties Type**: string -## ManagedDiskParameters +## ResourceTags ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVmosDisk +## ResourceTags ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the disk size in GB. -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. -* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## RestorePointCollectionSourceProperties +## ResourceTags ### Properties -* **id**: string: Resource Id of the source resource used to create this restore point collection -* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SshPublicKeyResourceProperties +## ResourceTags ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity +## ResourceTags ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **Additional Properties Type**: string -## UserAssignedIdentitiesValue +## RestorePoint ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **id**: string (ReadOnly): Resource Id +* **name**: string (ReadOnly): Resource name +* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. +* **type**: string (ReadOnly): Resource type -## Plan +## RestorePointCollectionProperties ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. +* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. +* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. +* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. -## VirtualMachineProperties +## RestorePointCollectionSourceProperties +### Properties +* **id**: string: Resource Id of the source resource used to create this restore point collection +* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. + +## RestorePointProperties +### Properties +* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. +* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. +* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. +* **timeCreated**: string: Gets the creation time of the restore point. + +## RestorePointSourceMetadata ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. * **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 * **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **hostGroup**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **licenseType**: string: Gets the license type, which is for bring your own license scenario. +* **location**: string: Location of the VM from which the restore point was created. * **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) * **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. +* **vmId**: string: Gets the virtual machine unique id. -## AdditionalCapabilities +## RestorePointSourceVMDataDisk ### Properties -* **ultraSSDEnabled**: bool: 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. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. +* **lun**: int: Gets the logical unit number. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. -## BillingProfile +## RestorePointSourceVmosDisk ### Properties -* **maxPrice**: int: 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. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the disk size in GB. +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. +* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. -## VirtualMachineInstanceView +## RestorePointSourceVMStorageProfile ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. +* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. -## BootDiagnosticsInstanceView +## RollingUpgradePolicy ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). +* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. -## DiskInstanceView +## RunCommandInputParameter ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **name**: string (Required): The run command parameter name. +* **value**: string (Required): The run command parameter value. -## VirtualMachineExtensionInstanceView +## ScaleInPolicy ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## MaintenanceRedeployStatus +## ScheduledEventsProfile ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## VirtualMachinePatchStatus +## SecurityProfile ### Properties -* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. -* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode -* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. +* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. +* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 -## AvailablePatchSummary +## Sku ### Properties -* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. -* **error**: [ApiErrorAutoGenerated](#apierrorautogenerated) (ReadOnly): Api error. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. -* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## ApiErrorAutoGenerated +## SshConfiguration ### Properties -* **code**: string: The error code. -* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details -* **innererror**: [InnerError](#innererror): Inner error details. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## ApiErrorBase +## SshPublicKey ### Properties -* **code**: string: The error code. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +* **keyData**: string: 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/linux/create-ssh-keys-detailed). +* **path**: 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 -## InnerError +## SshPublicKeyResourceProperties ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. -## LastPatchInstallationSummary +## StorageProfile ### Properties -* **error**: [ApiErrorAutoGenerated](#apierrorautogenerated) (ReadOnly): Api error. -* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. -* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. -* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions -* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. -* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). + +## SubResource +### Properties +* **id**: string: Resource Id + +## SubResourceReadOnly +### Properties +* **id**: string (ReadOnly): Resource Id + +## SubResourceWithColocationStatus +### Properties +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id + +## TerminateNotificationProfile +### Properties +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) + +## UefiSettings +### Properties +* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 + +## UpgradePolicy +### Properties +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. + +## UserAssignedIdentitiesValue +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## VaultCertificate +### Properties +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). + +## VaultSecretGroup +### Properties +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. + +## VirtualHardDisk +### Properties +* **uri**: string: Specifies the virtual hard disk's uri. ## VirtualMachineAgentInstanceView ### Properties @@ -839,21 +905,81 @@ it is up to handler implementation whether to re-run it or not * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. * **vmAgentVersion**: string: The VM Agent full version. +## VirtualMachineExtension +### Properties +* **id**: string (ReadOnly): Resource Id +* **location**: string (Required): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [VirtualMachineExtensionProperties](#virtualmachineextensionproperties): Describes the properties of a Virtual Machine Extension. +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + ## VirtualMachineExtensionHandlerInstanceView ### Properties * **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionProperties +### Properties +* **autoUpgradeMinorVersion**: bool: 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. +* **enableAutomaticUpgrade**: bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. +* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. +* **instanceView**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview): The instance view of a virtual machine extension. +* **protectedSettings**: any: Any object +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string: The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineHealthStatus ### Properties * **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## NetworkProfile +## VirtualMachineIdentity ### Properties -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. + +## VirtualMachineIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) + +## VirtualMachineInstanceView +### Properties +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. + +## VirtualMachineIpTag +### Properties +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. ## VirtualMachineNetworkInterfaceConfiguration ### Properties @@ -891,6 +1017,38 @@ it is up to handler implementation whether to re-run it or not * **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration * **subnet**: [SubResource](#subresource) +## VirtualMachinePatchStatus +### Properties +* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. +* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode +* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. + +## VirtualMachineProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) +* **hostGroup**: [SubResource](#subresource) +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. + ## VirtualMachinePublicIPAddressConfiguration ### Properties * **name**: string (Required): The publicIP address configuration name. @@ -911,127 +1069,16 @@ it is up to handler implementation whether to re-run it or not ### Properties * **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. -## VirtualMachineIpTag -### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name -* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier - -## NetworkInterfaceReference -### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. - -## NetworkInterfaceReferenceProperties -### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. - -## ScheduledEventsProfile -### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) - -## TerminateNotificationProfile -### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) - -## StorageProfile -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). - -## DataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## VirtualHardDisk -### Properties -* **uri**: string: Specifies the virtual hard disk's uri. - -## ImageReference -### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. - -## OSDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## DiffDiskSettings -### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements - -## VirtualMachineExtension -### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (Required): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [VirtualMachineExtensionProperties](#virtualmachineextensionproperties): Describes the properties of a Virtual Machine Extension. -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## VirtualMachineExtensionProperties -### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **enableAutomaticUpgrade**: bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. -* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. -* **instanceView**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview): The instance view of a virtual machine extension. -* **protectedSettings**: any: Any object -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VirtualMachineRunCommandInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endTime**: string: Script end time. +* **error**: string: Script error stream. +* **executionMessage**: string: Communicate script configuration errors or execution messages. +* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. +* **exitCode**: int: Exit code returned from script execution. +* **output**: string: Script output stream. +* **startTime**: string: Script start time. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## VirtualMachineRunCommandProperties ### Properties @@ -1047,116 +1094,23 @@ it is up to handler implementation whether to re-run it or not * **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. * **timeoutInSeconds**: int: The timeout in seconds to execute the run command. -## VirtualMachineRunCommandInstanceView -### Properties -* **endTime**: string: Script end time. -* **error**: string: Script error stream. -* **executionMessage**: string: Communicate script configuration errors or execution messages. -* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. -* **exitCode**: int: Exit code returned from script execution. -* **output**: string: Script output stream. -* **startTime**: string: Script start time. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. - -## RunCommandInputParameter -### Properties -* **name**: string (Required): The run command parameter name. -* **value**: string (Required): The run command parameter value. - -## VirtualMachineRunCommandScriptSource -### Properties -* **commandId**: string: Specifies a commandId of predefined built-in script. -* **script**: string: Specifies the script content to be executed on the VM. -* **scriptUri**: string: Specifies the script download location. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineScaleSetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. - -## VirtualMachineScaleSetIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) - -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## VirtualMachineScaleSetProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. -* **hostGroup**: [SubResource](#subresource) -* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    - -## UpgradePolicy -### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. - -## AutomaticOSUpgradePolicy -### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. - -## RollingUpgradePolicy -### Properties -* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). -* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. - -## VirtualMachineScaleSetVMProfile +## VirtualMachineRunCommandScriptSource ### Properties -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **commandId**: string: Specifies a commandId of predefined built-in script. +* **script**: string: Specifies the script content to be executed on the VM. +* **scriptUri**: string: Specifies the script download location. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -1165,6 +1119,11 @@ it is up to handler implementation whether to re-run it or not * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1178,32 +1137,22 @@ it is up to handler implementation whether to re-run it or not * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1222,62 +1171,42 @@ it is up to handler implementation whether to re-run it or not * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) -* **adminUsername**: 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 -* **computerNamePrefix**: 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. -* **customData**: 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/linux/using-cloud-init) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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/managed-disks-overview). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -1292,30 +1221,58 @@ it is up to handler implementation whether to re-run it or not * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) +* **adminUsername**: 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 +* **computerNamePrefix**: 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. +* **customData**: 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/linux/using-cloud-init) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. -* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **hostGroup**: [SubResource](#subresource) +* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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/managed-disks-overview). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -1336,18 +1293,61 @@ it is up to handler implementation whether to re-run it or not ### Properties * **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +## VirtualMachineScaleSetVMProfile +### Properties +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 + +## VirtualMachineScaleSetVMProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **vmId**: string (ReadOnly): Azure VM unique ID. + ## VirtualMachineScaleSetVMProtectionPolicy ### Properties * **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. * **protectFromScaleSetActions**: bool: 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. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2021-04-01/types.md b/generated/compute/microsoft.compute/2021-04-01/types.md index 5aad5efead..6dcb432d38 100644 --- a/generated/compute/microsoft.compute/2021-04-01/types.md +++ b/generated/compute/microsoft.compute/2021-04-01/types.md @@ -277,6 +277,45 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## ApiError +### Properties +* **code**: string: The error code. +* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details +* **innererror**: [InnerError](#innererror): Inner error details. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApiErrorBase +### Properties +* **code**: string: The error code. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -285,28 +324,35 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## AvailablePatchSummary ### Properties -* **id**: string: Resource Id +* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. +* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## InstanceViewStatus +## BillingProfile ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **maxPrice**: int: 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. -## Sku +## BootDiagnostics ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. -## ResourceTags +## BootDiagnosticsInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. + +## CapacityReservationGroupInstanceView +### Properties +* **capacityReservations**: [CapacityReservationInstanceViewWithName](#capacityreservationinstanceviewwithname)[] (ReadOnly): List of instance view of the capacity reservations under the capacity reservation group. ## CapacityReservationGroupProperties ### Properties @@ -314,13 +360,10 @@ * **instanceView**: [CapacityReservationGroupInstanceView](#capacityreservationgroupinstanceview) (ReadOnly) * **virtualMachinesAssociated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines associated to the capacity reservation group. -## SubResourceReadOnly -### Properties -* **id**: string (ReadOnly): Resource Id - -## CapacityReservationGroupInstanceView +## CapacityReservationInstanceView ### Properties -* **capacityReservations**: [CapacityReservationInstanceViewWithName](#capacityreservationinstanceviewwithname)[] (ReadOnly): List of instance view of the capacity reservations under the capacity reservation group. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. ## CapacityReservationInstanceViewWithName ### Properties @@ -328,14 +371,9 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. * **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. -## CapacityReservationUtilization -### Properties -* **virtualMachinesAllocated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machines resource ids allocated against the capacity reservation. - -## ResourceTags +## CapacityReservationProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacityReservationGroup**: [SubResource](#subresource) ## CapacityReservationProperties ### Properties @@ -345,103 +383,113 @@ * **reservationId**: string (ReadOnly): A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. * **virtualMachinesAssociated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machine resource ids that are associated with the capacity reservation. -## CapacityReservationInstanceView -### Properties -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. - -## ResourceTags +## CapacityReservationUtilization ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **virtualMachinesAllocated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machines resource ids allocated against the capacity reservation. -## ExtendedLocation +## CreationData ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. +* **createOption**: 'Attach' | 'Copy' | 'CopyStart' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). -## DiskAccessProperties +## DataDisk ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. -* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk access was created. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## PrivateEndpointConnection +## DedicatedHostAllocatableVM ### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. -## PrivateEndpointConnectionProperties +## DedicatedHostAvailableCapacity ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. -## PrivateEndpoint +## DedicatedHostGroupInstanceView ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. -## PrivateLinkServiceConnectionState +## DedicatedHostGroupProperties ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. +* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. -## ResourceTags +## DedicatedHostInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## EncryptionSetIdentity +## DedicatedHostInstanceViewWithName ### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **name**: string (ReadOnly): The name of the dedicated host. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## EncryptionSetProperties +## DedicatedHostProperties ### Properties -* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots -* **autoKeyRotationError**: [ApiError](#apierror) (ReadOnly): Api error. -* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. -* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. -* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. -* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. +* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. +* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. +* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. +* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** +* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. +* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## KeyForDiskEncryptionSet +## DiagnosticsProfile ### Properties -* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. -* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## SourceVault +## DiffDiskSettings ### Properties -* **id**: string: Resource Id +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements -## ApiError +## DiskAccessProperties ### Properties -* **code**: string: The error code. -* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details -* **innererror**: [InnerError](#innererror): Inner error details. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. +* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk access was created. -## ApiErrorBase +## DiskEncryptionSetParameters ### Properties -* **code**: string: The error code. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +* **id**: string: Resource Id -## InnerError +## DiskEncryptionSettings ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key -## ResourceTags +## DiskInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DiskProperties ### Properties @@ -474,29 +522,37 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData +## DiskSecurityProfile ### Properties -* **createOption**: 'Attach' | 'Copy' | 'CopyStart' | 'Empty' | 'FromImage' | 'Import' | 'Restore' | 'Upload' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). +* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. -## EncryptionSettingsCollection +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots +* **autoKeyRotationError**: [ApiError](#apierror) (ReadOnly): Api error. +* **encryptionType**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. +* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. +* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. +* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. + +## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. * **encryptionSettings**: [EncryptionSettingsElement](#encryptionsettingselement)[]: A collection of encryption settings, one for each disk volume. @@ -507,115 +563,14 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference -### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## KeyVaultAndKeyReference -### Properties -* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## PropertyUpdatesInProgress -### Properties -* **targetTier**: string: The target performance tier of the disk if a tier change operation is in progress. - -## PurchasePlan -### Properties -* **name**: string (Required): The plan ID. -* **product**: string (Required): Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The Offer Promotion Code. -* **publisher**: string (Required): The publisher ID. - -## DiskSecurityProfile -### Properties -* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. - -## ShareInfoElement -### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. - -## SupportedCapabilities -### Properties -* **acceleratedNetwork**: bool: True if the image from which the OS disk is created supports accelerated networking. - -## DiskSku -### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DedicatedHostGroupProperties -### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. -* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. - -## DedicatedHostGroupInstanceView -### Properties -* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. - -## DedicatedHostInstanceViewWithName -### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **name**: string (ReadOnly): The name of the dedicated host. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. - -## DedicatedHostAvailableCapacity -### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. - -## DedicatedHostAllocatableVM -### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DedicatedHostProperties -### Properties -* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. -* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. -* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. -* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** -* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. -* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. - -## DedicatedHostInstanceView -### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ImageProperties +## ExtendedLocation ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. ## ImageDataDisk ### Properties @@ -628,9 +583,10 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## DiskEncryptionSetParameters +## ImageDiskReference ### Properties -* **id**: string: Resource Id +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. ## ImageOSDisk ### Properties @@ -644,90 +600,79 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProximityPlacementGroupProperties +## ImageProperties ### Properties -* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## SubResourceWithColocationStatus +## ImageReference ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. * **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: 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. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RestorePointCollectionProperties +## ImageStorageProfile ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. -* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. -* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. -* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## RestorePoint +## InnerError ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string (ReadOnly): Resource name -* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. -* **type**: string (ReadOnly): Resource type +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. -## RestorePointProperties +## InstanceViewStatus ### Properties -* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. -* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. -* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. -* **timeCreated**: string: Gets the creation time of the restore point. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## ApiEntityReference +## KeyForDiskEncryptionSet ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. +* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## RestorePointSourceMetadata +## KeyVaultAndKeyReference ### Properties -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **licenseType**: string: Gets the license type, which is for bring your own license scenario. -* **location**: string: Location of the VM from which the restore point was created. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. -* **vmId**: string: Gets the virtual machine unique id. +* **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## DiagnosticsProfile +## KeyVaultAndSecretReference ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} -## BootDiagnostics +## KeyVaultKeyReference ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## HardwareProfile +## KeyVaultSecretReference ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## OSProfile +## LastPatchInstallationSummary ### Properties -* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) -* **adminUsername**: 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. -* **allowExtensionOperations**: bool: 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. -* **computerName**: 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/azure-resource-manager/management/resource-name-rules). -* **customData**: 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://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)

    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/linux/using-cloud-init) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). -* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. +* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. +* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions +* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. +* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ## LinuxConfiguration ### Properties @@ -741,40 +686,64 @@ * **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. * **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true -## SshConfiguration +## MaintenanceRedeployStatus ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## SshPublicKey +## ManagedDiskParameters ### Properties -* **keyData**: string: 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/linux/create-ssh-keys-detailed). -* **path**: 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 +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## VaultSecretGroup +## NetworkInterfaceReference ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## VaultCertificate +## NetworkInterfaceReferenceProperties ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## WindowsConfiguration +## NetworkProfile ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. -## AdditionalUnattendContent +## OSDisk ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The Operating System type. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## OSProfile +### Properties +* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) +* **adminUsername**: 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. +* **allowExtensionOperations**: bool: 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. +* **computerName**: 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/azure-resource-manager/management/resource-name-rules). +* **customData**: 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://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)

    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/linux/using-cloud-init) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). +* **requireGuestProvisionSignal**: bool: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.** +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. ## PatchSettings ### Properties @@ -782,428 +751,372 @@ * **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. * **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true -## WinRMConfiguration +## Plan ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## WinRMListener +## PrivateEndpoint ### Properties -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## SecurityProfile +## PrivateEndpointConnection ### Properties -* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. -* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type -## UefiSettings +## PrivateEndpointConnectionProperties ### Properties -* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## RestorePointSourceVMStorageProfile +## PrivateLinkServiceConnectionState ### Properties -* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. -* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## RestorePointSourceVMDataDisk +## PropertyUpdatesInProgress ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. -* **lun**: int: Gets the logical unit number. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. +* **targetTier**: string: The target performance tier of the disk if a tier change operation is in progress. -## ManagedDiskParameters +## ProximityPlacementGroupProperties ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## RestorePointSourceVmosDisk +## PublicIPAddressSku ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the disk size in GB. -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. -* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. +* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name +* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier -## DiskEncryptionSettings +## PurchasePlan ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +* **name**: string (Required): The plan ID. +* **product**: string (Required): Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The Offer Promotion Code. +* **publisher**: string (Required): The publisher ID. -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## RestorePointCollectionSourceProperties +## ResourceTags ### Properties -* **id**: string: Resource Id of the source resource used to create this restore point collection -* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SnapshotProperties +## ResourceTags ### Properties -* **completionPercent**: int: Percentage complete for the background copy when a resource is created via the CopyStart operation. -* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. -* **diskAccessId**: string: ARM id of the DiskAccess resource for using private endpoints on disks. -* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. -* **diskSizeGB**: int: 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. -* **diskState**: 'ActiveSAS' | 'ActiveSASFrozen' | 'ActiveUpload' | 'Attached' | 'Frozen' | 'ReadyToUpload' | 'Reserved' | 'Unattached' | string (ReadOnly): This enumerates the possible state of the disk. -* **encryption**: [Encryption](#encryption): Encryption at rest settings for disk or snapshot -* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot -* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. -* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. -* **networkAccessPolicy**: 'AllowAll' | 'AllowPrivate' | 'DenyAll' | string: Policy for accessing the disk via network. -* **osType**: 'Linux' | 'Windows': The Operating System type. -* **provisioningState**: string (ReadOnly): The disk provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Policy for controlling export on the disk. -* **purchasePlan**: [PurchasePlan](#purchaseplan): Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. -* **supportedCapabilities**: [SupportedCapabilities](#supportedcapabilities): List of supported capabilities (like accelerated networking) persisted on the disk resource for VM use. -* **supportsHibernation**: bool: Indicates the OS on a snapshot supports hibernation. -* **timeCreated**: string (ReadOnly): The time when the snapshot was created. -* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. +### Additional Properties +* **Additional Properties Type**: string -## SnapshotSku +## ResourceTags ### Properties -* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SshPublicKeyResourceProperties +## ResourceTags ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity +## ResourceTags ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **Additional Properties Type**: string -## UserAssignedIdentitiesValue +## ResourceTags ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string -## Plan +## ResourceTags ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineProperties +## ResourceTags ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **hostGroup**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. +### Additional Properties +* **Additional Properties Type**: string -## AdditionalCapabilities +## ResourceTags ### Properties -* **ultraSSDEnabled**: bool: 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. +### Additional Properties +* **Additional Properties Type**: string -## BillingProfile +## ResourceTags ### Properties -* **maxPrice**: int: 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. +### Additional Properties +* **Additional Properties Type**: string -## CapacityReservationProfile +## ResourceTags ### Properties -* **capacityReservationGroup**: [SubResource](#subresource) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineInstanceView +## ResourceTags ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +### Additional Properties +* **Additional Properties Type**: string -## BootDiagnosticsInstanceView +## ResourceTags ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +### Additional Properties +* **Additional Properties Type**: string -## DiskInstanceView +## ResourceTags ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineExtensionInstanceView +## RestorePoint ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **id**: string (ReadOnly): Resource Id +* **name**: string (ReadOnly): Resource name +* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. +* **type**: string (ReadOnly): Resource type -## MaintenanceRedeployStatus +## RestorePointCollectionProperties ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. +* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. +* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. +* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. -## VirtualMachinePatchStatus +## RestorePointCollectionSourceProperties ### Properties -* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. -* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode -* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. +* **id**: string: Resource Id of the source resource used to create this restore point collection +* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. -## AvailablePatchSummary +## RestorePointProperties ### Properties -* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. -* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. +* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. +* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. +* **timeCreated**: string: Gets the creation time of the restore point. -## LastPatchInstallationSummary +## RestorePointSourceMetadata ### Properties -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. -* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. -* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions -* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. -* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **licenseType**: string: Gets the license type, which is for bring your own license scenario. +* **location**: string: Location of the VM from which the restore point was created. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. +* **vmId**: string: Gets the virtual machine unique id. -## VirtualMachineAgentInstanceView +## RestorePointSourceVMDataDisk ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. +* **lun**: int: Gets the logical unit number. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. -## VirtualMachineExtensionHandlerInstanceView +## RestorePointSourceVmosDisk ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the disk size in GB. +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. +* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. -## VirtualMachineHealthStatus +## RestorePointSourceVMStorageProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. +* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. -## NetworkProfile +## RollingUpgradePolicy ### Properties -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). +* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. -## VirtualMachineNetworkInterfaceConfiguration +## RunCommandInputParameter ### Properties -* **name**: string (Required): The network interface configuration name. -* **properties**: [VirtualMachineNetworkInterfaceConfigurationProperties](#virtualmachinenetworkinterfaceconfigurationproperties): Describes a virtual machine network profile's IP configuration. +* **name**: string (Required): The run command parameter name. +* **value**: string (Required): The run command parameter value. -## VirtualMachineNetworkInterfaceConfigurationProperties +## ScaleInPolicy ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineNetworkInterfaceDnsSettingsConfiguration](#virtualmachinenetworkinterfacednssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. -* **dscpConfiguration**: [SubResource](#subresource) -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineNetworkInterfaceIPConfiguration](#virtualmachinenetworkinterfaceipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## VirtualMachineNetworkInterfaceDnsSettingsConfiguration +## ScheduledEventsProfile ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## VirtualMachineNetworkInterfaceIPConfiguration +## SecurityProfile ### Properties -* **name**: string (Required): The IP configuration name. -* **properties**: [VirtualMachineNetworkInterfaceIPConfigurationProperties](#virtualmachinenetworkinterfaceipconfigurationproperties): Describes a virtual machine network interface IP configuration properties. +* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. +* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 -## VirtualMachineNetworkInterfaceIPConfigurationProperties +## ShareInfoElement ### Properties -* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. -* **applicationSecurityGroups**: [SubResource](#subresource)[]: Specifies an array of references to application security group. -* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration -* **subnet**: [SubResource](#subresource) +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. -## VirtualMachinePublicIPAddressConfiguration +## Sku ### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachinePublicIPAddressConfigurationProperties](#virtualmachinepublicipaddressconfigurationproperties): Describes a virtual machines IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## VirtualMachinePublicIPAddressConfigurationProperties +## SnapshotProperties ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachinePublicIPAddressDnsSettingsConfiguration](#virtualmachinepublicipaddressdnssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineIpTag](#virtualmachineiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Specify the public IP allocation type -* **publicIPPrefix**: [SubResource](#subresource) +* **completionPercent**: int: Percentage complete for the background copy when a resource is created via the CopyStart operation. +* **creationData**: [CreationData](#creationdata) (Required): Data used when creating a disk. +* **diskAccessId**: string: ARM id of the DiskAccess resource for using private endpoints on disks. +* **diskSizeBytes**: int (ReadOnly): The size of the disk in bytes. This field is read only. +* **diskSizeGB**: int: 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. +* **diskState**: 'ActiveSAS' | 'ActiveSASFrozen' | 'ActiveUpload' | 'Attached' | 'Frozen' | 'ReadyToUpload' | 'Reserved' | 'Unattached' | string (ReadOnly): This enumerates the possible state of the disk. +* **encryption**: [Encryption](#encryption): Encryption at rest settings for disk or snapshot +* **encryptionSettingsCollection**: [EncryptionSettingsCollection](#encryptionsettingscollection): Encryption settings for disk or snapshot +* **hyperVGeneration**: 'V1' | 'V2' | string: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. +* **incremental**: bool: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. +* **networkAccessPolicy**: 'AllowAll' | 'AllowPrivate' | 'DenyAll' | string: Policy for accessing the disk via network. +* **osType**: 'Linux' | 'Windows': The Operating System type. +* **provisioningState**: string (ReadOnly): The disk provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Policy for controlling export on the disk. +* **purchasePlan**: [PurchasePlan](#purchaseplan): Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. +* **supportedCapabilities**: [SupportedCapabilities](#supportedcapabilities): List of supported capabilities (like accelerated networking) persisted on the disk resource for VM use. +* **supportsHibernation**: bool: Indicates the OS on a snapshot supports hibernation. +* **timeCreated**: string (ReadOnly): The time when the snapshot was created. +* **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## VirtualMachinePublicIPAddressDnsSettingsConfiguration +## SnapshotSku ### Properties -* **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. +* **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. -## VirtualMachineIpTag +## SourceVault ### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. +* **id**: string: Resource Id -## PublicIPAddressSku +## SpotRestorePolicy ### Properties -* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name -* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier +* **enabled**: bool: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints +* **restoreTimeout**: string: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances -## NetworkInterfaceReference +## SshConfiguration +### Properties +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. + +## SshPublicKey +### Properties +* **keyData**: string: 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/linux/create-ssh-keys-detailed). +* **path**: 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 + +## SshPublicKeyResourceProperties +### Properties +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. + +## StorageProfile +### Properties +* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). + +## SubResource ### Properties * **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## NetworkInterfaceReferenceProperties +## SubResourceReadOnly ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **id**: string (ReadOnly): Resource Id -## ScheduledEventsProfile +## SubResourceWithColocationStatus ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id + +## SupportedCapabilities +### Properties +* **acceleratedNetwork**: bool: True if the image from which the OS disk is created supports accelerated networking. ## TerminateNotificationProfile ### Properties * **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. * **notBeforeTimeout**: 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) -## StorageProfile +## UefiSettings ### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). +* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -## DataDisk +## UpgradePolicy ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## VirtualHardDisk +## UserAssignedIdentitiesValue ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## VaultCertificate +### Properties +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -## ImageReference +## VaultSecretGroup ### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The Operating System type. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **uri**: string: Specifies the virtual hard disk's uri. -## DiffDiskSettings +## VirtualMachineAgentInstanceView ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -1214,6 +1127,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1227,152 +1154,177 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## VirtualMachineIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## ResourceTags +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## VirtualMachineRunCommandProperties +## VirtualMachineInstanceView ### Properties -* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. -* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. -* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. -* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. -* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. -* **runAsUser**: string: Specifies the user account on the VM when executing the run command. -* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. -* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineRunCommandInstanceView +## VirtualMachineIpTag ### Properties -* **endTime**: string: Script end time. -* **error**: string: Script error stream. -* **executionMessage**: string: Communicate script configuration errors or execution messages. -* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. -* **exitCode**: int: Exit code returned from script execution. -* **output**: string: Script output stream. -* **startTime**: string: Script start time. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## RunCommandInputParameter +## VirtualMachineNetworkInterfaceConfiguration ### Properties -* **name**: string (Required): The run command parameter name. -* **value**: string (Required): The run command parameter value. +* **name**: string (Required): The network interface configuration name. +* **properties**: [VirtualMachineNetworkInterfaceConfigurationProperties](#virtualmachinenetworkinterfaceconfigurationproperties): Describes a virtual machine network profile's IP configuration. -## VirtualMachineRunCommandScriptSource +## VirtualMachineNetworkInterfaceConfigurationProperties ### Properties -* **commandId**: string: Specifies a commandId of predefined built-in script. -* **script**: string: Specifies the script content to be executed on the VM. -* **scriptUri**: string: Specifies the script download location. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineNetworkInterfaceDnsSettingsConfiguration](#virtualmachinenetworkinterfacednssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. +* **dscpConfiguration**: [SubResource](#subresource) +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineNetworkInterfaceIPConfiguration](#virtualmachinenetworkinterfaceipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## ResourceTags +## VirtualMachineNetworkInterfaceDnsSettingsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetIdentity +## VirtualMachineNetworkInterfaceIPConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. +* **name**: string (Required): The IP configuration name. +* **properties**: [VirtualMachineNetworkInterfaceIPConfigurationProperties](#virtualmachinenetworkinterfaceipconfigurationproperties): Describes a virtual machine network interface IP configuration properties. -## VirtualMachineScaleSetIdentityUserAssignedIdentities +## VirtualMachineNetworkInterfaceIPConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) +* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. +* **applicationSecurityGroups**: [SubResource](#subresource)[]: Specifies an array of references to application security group. +* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration +* **subnet**: [SubResource](#subresource) -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue +## VirtualMachinePatchStatus ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. +* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode +* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. -## VirtualMachineScaleSetProperties +## VirtualMachineProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **availabilitySet**: [SubResource](#subresource) +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) * **hostGroup**: [SubResource](#subresource) -* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. * **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **spotRestorePolicy**: [SpotRestorePolicy](#spotrestorepolicy): Specifies the Spot-Try-Restore properties for the virtual machine scale set.

    With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). - -## ScaleInPolicy -### Properties -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## SpotRestorePolicy +## VirtualMachinePublicIPAddressConfiguration ### Properties -* **enabled**: bool: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints -* **restoreTimeout**: string: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachinePublicIPAddressConfigurationProperties](#virtualmachinepublicipaddressconfigurationproperties): Describes a virtual machines IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku -## UpgradePolicy +## VirtualMachinePublicIPAddressConfigurationProperties ### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachinePublicIPAddressDnsSettingsConfiguration](#virtualmachinepublicipaddressdnssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineIpTag](#virtualmachineiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Specify the public IP allocation type +* **publicIPPrefix**: [SubResource](#subresource) -## AutomaticOSUpgradePolicy +## VirtualMachinePublicIPAddressDnsSettingsConfiguration ### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +* **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. -## RollingUpgradePolicy +## VirtualMachineRunCommandInstanceView ### Properties -* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). -* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. +* **endTime**: string: Script end time. +* **error**: string: Script error stream. +* **executionMessage**: string: Communicate script configuration errors or execution messages. +* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. +* **exitCode**: int: Exit code returned from script execution. +* **output**: string: Script output stream. +* **startTime**: string: Script start time. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## VirtualMachineScaleSetVMProfile +## VirtualMachineRunCommandProperties ### Properties -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. +* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. +* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. +* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. +* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. +* **runAsUser**: string: Specifies the user account on the VM when executing the run command. +* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. +* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineRunCommandScriptSource ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **commandId**: string: Specifies a commandId of predefined built-in script. +* **script**: string: Specifies the script content to be executed on the VM. +* **scriptUri**: string: Specifies the script download location. + +## VirtualMachineScaleSetDataDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -1381,6 +1333,11 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1394,32 +1351,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1438,62 +1385,42 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration -### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku - -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties -### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) - -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings -### Properties -* **domainNameLabel**: string (Required): 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 - ## VirtualMachineScaleSetIpTag ### Properties * **ipTagType**: string: IP tag type. Example: FirstPartyUsage. * **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetOSProfile +## VirtualMachineScaleSetManagedDiskParameters ### Properties -* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) -* **adminUsername**: 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 -* **computerNamePrefix**: 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. -* **customData**: 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/linux/using-cloud-init) -* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). -* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## VirtualMachineScaleSetStorageProfile +## VirtualMachineScaleSetNetworkConfiguration ### Properties -* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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/managed-disks-overview). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. -## VirtualMachineScaleSetDataDisk +## VirtualMachineScaleSetNetworkConfigurationDnsSettings ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## VirtualMachineScaleSetNetworkProfile +### Properties +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. ## VirtualMachineScaleSetOSDisk ### Properties @@ -1508,30 +1435,59 @@ * **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. * **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. -## ResourceTags +## VirtualMachineScaleSetOSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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/troubleshoot/azure/virtual-machines/reset-rdp)

    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/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) +* **adminUsername**: 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 +* **computerNamePrefix**: 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. +* **customData**: 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/linux/using-cloud-init) +* **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): 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/linux/endorsed-distros). +* **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## VirtualMachineScaleSetVMProperties +## VirtualMachineScaleSetProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **availabilitySet**: [SubResource](#subresource) -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. -* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. -* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **hostGroup**: [SubResource](#subresource) +* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 -* **vmId**: string (ReadOnly): Azure VM unique ID. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **spotRestorePolicy**: [SpotRestorePolicy](#spotrestorepolicy): Specifies the Spot-Try-Restore properties for the virtual machine scale set.

    With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + +## VirtualMachineScaleSetStorageProfile +### Properties +* **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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/managed-disks-overview). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. ## VirtualMachineScaleSetVMInstanceView ### Properties @@ -1552,18 +1508,62 @@ ### Properties * **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +## VirtualMachineScaleSetVMProfile +### Properties +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 + +## VirtualMachineScaleSetVMProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **availabilitySet**: [SubResource](#subresource) +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **instanceView**: [VirtualMachineScaleSetVMInstanceView](#virtualmachinescalesetvminstanceview) (ReadOnly): The instance view of a virtual machine scale set VM. +* **latestModelApplied**: bool (ReadOnly): Specifies whether the latest model has been applied to the virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **modelDefinitionApplied**: string (ReadOnly): Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **networkProfileConfiguration**: [VirtualMachineScaleSetVMNetworkProfileConfiguration](#virtualmachinescalesetvmnetworkprofileconfiguration): Describes a virtual machine scale set VM network profile. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **protectionPolicy**: [VirtualMachineScaleSetVMProtectionPolicy](#virtualmachinescalesetvmprotectionpolicy): The protection policy of a virtual machine scale set VM. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **vmId**: string (ReadOnly): Azure VM unique ID. + ## VirtualMachineScaleSetVMProtectionPolicy ### Properties * **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. * **protectFromScaleSetActions**: bool: 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. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2021-07-01/types.md b/generated/compute/microsoft.compute/2021-07-01/types.md index 9a72ed9ee1..101b386957 100644 --- a/generated/compute/microsoft.compute/2021-07-01/types.md +++ b/generated/compute/microsoft.compute/2021-07-01/types.md @@ -269,6 +269,50 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **hibernationEnabled**: bool: The flag that enables or disables hibernation capability on the VM. +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## ApiError +### Properties +* **code**: string: The error code. +* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details +* **innererror**: [InnerError](#innererror): Inner error details. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApiErrorBase +### Properties +* **code**: string: The error code. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApplicationProfile +### Properties +* **galleryApplications**: [VMGalleryApplication](#vmgalleryapplication)[]: Specifies the gallery applications that should be made available to the VM/VMSS + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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). + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -277,28 +321,35 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## AvailablePatchSummary ### Properties -* **id**: string: Resource Id +* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. +* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## InstanceViewStatus +## BillingProfile ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **maxPrice**: int: 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. -## Sku +## BootDiagnostics ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. -## ResourceTags +## BootDiagnosticsInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. + +## CapacityReservationGroupInstanceView +### Properties +* **capacityReservations**: [CapacityReservationInstanceViewWithName](#capacityreservationinstanceviewwithname)[] (ReadOnly): List of instance view of the capacity reservations under the capacity reservation group. ## CapacityReservationGroupProperties ### Properties @@ -306,13 +357,10 @@ * **instanceView**: [CapacityReservationGroupInstanceView](#capacityreservationgroupinstanceview) (ReadOnly) * **virtualMachinesAssociated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines associated to the capacity reservation group. -## SubResourceReadOnly -### Properties -* **id**: string (ReadOnly): Resource Id - -## CapacityReservationGroupInstanceView +## CapacityReservationInstanceView ### Properties -* **capacityReservations**: [CapacityReservationInstanceViewWithName](#capacityreservationinstanceviewwithname)[] (ReadOnly): List of instance view of the capacity reservations under the capacity reservation group. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. ## CapacityReservationInstanceViewWithName ### Properties @@ -320,14 +368,9 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. * **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. -## CapacityReservationUtilization -### Properties -* **virtualMachinesAllocated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machines resource ids allocated against the capacity reservation. - -## ResourceTags +## CapacityReservationProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacityReservationGroup**: [SubResource](#subresource) ## CapacityReservationProperties ### Properties @@ -337,46 +380,114 @@ * **reservationId**: string (ReadOnly): A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. * **virtualMachinesAssociated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machine resource ids that are associated with the capacity reservation. -## CapacityReservationInstanceView +## CapacityReservationUtilization +### Properties +* **virtualMachinesAllocated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machines resource ids allocated against the capacity reservation. + +## DataDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## DataDiskImageEncryption +### Properties +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. + +## DedicatedHostAllocatableVM +### Properties +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. + +## DedicatedHostAvailableCapacity +### Properties +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. + +## DedicatedHostGroupInstanceView +### Properties +* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. + +## DedicatedHostGroupProperties +### Properties +* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. +* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) +* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. +* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. + +## DedicatedHostInstanceView ### Properties +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. -## ResourceTags +## DedicatedHostInstanceViewWithName ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **name**: string (ReadOnly): The name of the dedicated host. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## GalleryProperties +## DedicatedHostProperties ### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -* **sharingProfile**: [SharingProfile](#sharingprofile): Profile for gallery sharing to subscription or tenant -* **softDeletePolicy**: [SoftDeletePolicy](#softdeletepolicy): Contains information about the soft deletion policy of the gallery. +* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. +* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. +* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. +* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** +* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. +* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## GalleryIdentifier +## DiagnosticsProfile ### Properties -* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. -## SharingProfile +## DiffDiskSettings ### Properties -* **groups**: [SharingProfileGroup](#sharingprofilegroup)[] (ReadOnly): A list of sharing profile groups. -* **permissions**: 'Groups' | 'Private' | string: This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups** +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements -## SharingProfileGroup +## Disallowed ### Properties -* **ids**: string[]: A list of subscription/tenant ids the gallery is aimed to be shared to. -* **type**: 'AADTenants' | 'Subscriptions' | string: This property allows you to specify the type of sharing group.

    Possible values are:

    **Subscriptions**

    **AADTenants** +* **diskTypes**: string[]: A list of disk types. -## SoftDeletePolicy +## DiskEncryptionSetParameters ### Properties -* **isSoftDeleteEnabled**: bool: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. +* **id**: string: Resource Id -## ResourceTags +## DiskEncryptionSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. + +## EncryptionImages +### Properties +* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. +* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. + +## ExtendedLocation +### Properties +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. ## GalleryApplicationProperties ### Properties @@ -387,11 +498,6 @@ * **releaseNoteUri**: string: The release note uri. * **supportedOSType**: 'Linux' | 'Windows' (Required): 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** -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -411,54 +517,32 @@ * **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## UserArtifactManage +## GalleryArtifactVersionSource ### Properties -* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. -* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. -* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. +* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. +* **uri**: string: The uri of the gallery artifact version source. Currently used to specify vhd/blob source. -## UserArtifactSource +## GalleryDataDiskImage ### Properties -* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. -* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## TargetRegion +## GalleryIdentifier ### Properties -* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. +* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## EncryptionImages +## GalleryImageFeature ### Properties -* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. -* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. +* **name**: string: The name of the gallery image feature. +* **value**: string: The value of the gallery image feature. -## DataDiskImageEncryption +## GalleryImageIdentifier ### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. -* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. - -## OSDiskImageEncryption -### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. - -## ReplicationStatus -### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. - -## RegionalReplicationStatus -### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery image version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery image definition offer. +* **publisher**: string (Required): The name of the gallery image definition publisher. +* **sku**: string (Required): The name of the gallery image definition SKU. ## GalleryImageProperties ### Properties @@ -477,42 +561,6 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed -### Properties -* **diskTypes**: string[]: A list of disk types. - -## GalleryImageFeature -### Properties -* **name**: string: The name of the gallery image feature. -* **value**: string: The value of the gallery image feature. - -## GalleryImageIdentifier -### Properties -* **offer**: string (Required): The name of the gallery image definition offer. -* **publisher**: string (Required): The name of the gallery image definition publisher. -* **sku**: string (Required): The name of the gallery image definition SKU. - -## ImagePurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: The product ID. -* **publisher**: string: The publisher ID. - -## RecommendedMachineConfiguration -### Properties -* **memory**: [ResourceRange](#resourcerange): Describes the resource range. -* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. - -## ResourceRange -### Properties -* **max**: int: The maximum number of the resource. -* **min**: int: The minimum number of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryImageVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -536,100 +584,24 @@ * **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. * **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## GalleryDataDiskImage -### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. - -## GalleryArtifactVersionSource -### Properties -* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. -* **uri**: string: The uri of the gallery artifact version source. Currently used to specify vhd/blob source. - ## GalleryOSDiskImage ### Properties * **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' * **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. * **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DedicatedHostGroupProperties -### Properties -* **hosts**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all dedicated hosts in the dedicated host group. -* **instanceView**: [DedicatedHostGroupInstanceView](#dedicatedhostgroupinstanceview) (ReadOnly) -* **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. -* **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. - -## DedicatedHostGroupInstanceView -### Properties -* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. - -## DedicatedHostInstanceViewWithName -### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **name**: string (ReadOnly): The name of the dedicated host. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. - -## DedicatedHostAvailableCapacity -### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. - -## DedicatedHostAllocatableVM -### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DedicatedHostProperties -### Properties -* **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. -* **hostId**: string (ReadOnly): A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host. -* **instanceView**: [DedicatedHostInstanceView](#dedicatedhostinstanceview) (ReadOnly): The instance view of a dedicated host. -* **licenseType**: 'None' | 'Windows_Server_Hybrid' | 'Windows_Server_Perpetual': 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** -* **platformFaultDomain**: int: Fault domain of the dedicated host within a dedicated host group. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **provisioningTime**: string (ReadOnly): The date when the host was first provisioned. -* **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. - -## DedicatedHostInstanceView -### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## ImageProperties +## GalleryProperties ### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **sharingProfile**: [SharingProfile](#sharingprofile): Profile for gallery sharing to subscription or tenant +* **softDeletePolicy**: [SoftDeletePolicy](#softdeletepolicy): Contains information about the soft deletion policy of the gallery. -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. +* **vmSizeProperties**: [VMSizeProperties](#vmsizeproperties): Specifies VM Size Property settings on the virtual machine. ## ImageDataDisk ### Properties @@ -642,10 +614,6 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## DiskEncryptionSetParameters -### Properties -* **id**: string: Resource Id - ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -658,84 +626,134 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## ResourceTags +## ImageProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ProximityPlacementGroupProperties +## ImagePurchasePlan ### Properties -* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **name**: string: The plan ID. +* **product**: string: The product ID. +* **publisher**: string: The publisher ID. -## SubResourceWithColocationStatus +## ImageReference ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. * **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sharedGalleryImageId**: string: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. +* **sku**: string: The image SKU. +* **version**: 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. -## ResourceTags +## ImageStorageProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## RestorePointCollectionProperties +## InnerError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. -* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. -* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. -* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. -## RestorePoint +## InstanceViewStatus ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string (ReadOnly): Resource name -* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. -* **type**: string (ReadOnly): Resource type +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## RestorePointProperties +## KeyVaultKeyReference ### Properties -* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. -* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. -* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. -* **timeCreated**: string: Gets the creation time of the restore point. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ApiEntityReference +## KeyVaultSecretReference ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## RestorePointSourceMetadata +## LastPatchInstallationSummary ### Properties -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **licenseType**: string: Gets the license type, which is for bring your own license scenario. -* **location**: string: Location of the VM from which the restore point was created. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. -* **vmId**: string: Gets the virtual machine unique id. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. +* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. +* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions +* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. +* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## DiagnosticsProfile +## LinuxConfiguration ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## BootDiagnostics +## LinuxPatchSettings ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. +* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. +* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true -## HardwareProfile +## MaintenanceRedeployStatus ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. -* **vmSizeProperties**: [VMSizeProperties](#vmsizeproperties): Specifies VM Size Property settings on the virtual machine. +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## VMSizeProperties +## ManagedDiskParameters ### Properties -* **vCPUsAvailable**: int: Specifies the number of vCPUs available for the VM.

    When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) . -* **vCPUsPerCore**: int: Specifies the vCPU to physical core ratio.

    When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)

    Setting this property to 1 also means that hyper-threading is disabled. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **id**: string: Resource Id +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types + +## NetworkInterfaceReference +### Properties +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. + +## NetworkInterfaceReferenceProperties +### Properties +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. + +## NetworkProfile +### Properties +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': 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** +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## OSDiskImageEncryption +### Properties +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. ## OSProfile ### Properties @@ -749,482 +767,365 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration +## PatchSettings ### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. +* **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. +* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true -## LinuxPatchSettings +## Plan ### Properties -* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. -* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## SshConfiguration +## ProximityPlacementGroupProperties ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. +* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SshPublicKey +## PublicIPAddressSku ### Properties -* **keyData**: string: 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/linux/create-ssh-keys-detailed). -* **path**: 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 +* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name +* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier -## VaultSecretGroup +## RecommendedMachineConfiguration ### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. +* **memory**: [ResourceRange](#resourcerange): Describes the resource range. +* **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. -## VaultCertificate +## RegionalReplicationStatus ### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery image version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. -## WindowsConfiguration +## ReplicationStatus ### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. -## AdditionalUnattendContent +## ResourceRange ### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. +* **max**: int: The maximum number of the resource. +* **min**: int: The minimum number of the resource. -## PatchSettings +## ResourceTags ### Properties -* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. -* **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. -* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true +### Additional Properties +* **Additional Properties Type**: string -## WinRMConfiguration +## ResourceTags ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +### Additional Properties +* **Additional Properties Type**: string -## WinRMListener +## ResourceTags ### Properties -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +### Additional Properties +* **Additional Properties Type**: string -## SecurityProfile +## ResourceTags ### Properties -* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. -* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 +### Additional Properties +* **Additional Properties Type**: string -## UefiSettings +## ResourceTags ### Properties -* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVMStorageProfile +## ResourceTags ### Properties -* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. -* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVMDataDisk +## ResourceTags ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. -* **lun**: int: Gets the logical unit number. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. +### Additional Properties +* **Additional Properties Type**: string -## ManagedDiskParameters +## ResourceTags ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVmosDisk +## ResourceTags ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the disk size in GB. -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. -* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## RestorePointCollectionSourceProperties +## ResourceTags ### Properties -* **id**: string: Resource Id of the source resource used to create this restore point collection -* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SshPublicKeyResourceProperties +## ResourceTags ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity +## ResourceTags ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) +* **Additional Properties Type**: string -## UserAssignedIdentitiesValue +## ResourceTags ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string -## Plan +## ResourceTags ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineProperties +## ResourceTags ### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **hostGroup**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## AdditionalCapabilities -### Properties -* **hibernationEnabled**: bool: The flag that enables or disables hibernation capability on the VM. -* **ultraSSDEnabled**: bool: 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. - -## ApplicationProfile -### Properties -* **galleryApplications**: [VMGalleryApplication](#vmgalleryapplication)[]: Specifies the gallery applications that should be made available to the VM/VMSS - -## VMGalleryApplication -### Properties -* **configurationReference**: string: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided -* **order**: int: Optional, Specifies the order in which the packages have to be installed -* **packageReferenceId**: string (Required): Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} -* **tags**: string: Optional, Specifies a passthrough value for more generic context. - -## BillingProfile -### Properties -* **maxPrice**: int: 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. +### Additional Properties +* **Additional Properties Type**: string -## CapacityReservationProfile +## RestorePoint ### Properties -* **capacityReservationGroup**: [SubResource](#subresource) +* **id**: string (ReadOnly): Resource Id +* **name**: string (ReadOnly): Resource name +* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. +* **type**: string (ReadOnly): Resource type -## VirtualMachineInstanceView +## RestorePointCollectionProperties ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. +* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. +* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. +* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. -## BootDiagnosticsInstanceView +## RestorePointCollectionSourceProperties ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **id**: string: Resource Id of the source resource used to create this restore point collection +* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. -## DiskInstanceView +## RestorePointProperties ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. +* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. +* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. +* **timeCreated**: string: Gets the creation time of the restore point. -## VirtualMachineExtensionInstanceView +## RestorePointSourceMetadata ### Properties -* **name**: string: The virtual machine extension name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **licenseType**: string: Gets the license type, which is for bring your own license scenario. +* **location**: string: Location of the VM from which the restore point was created. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. +* **vmId**: string: Gets the virtual machine unique id. -## MaintenanceRedeployStatus +## RestorePointSourceVMDataDisk ### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. +* **lun**: int: Gets the logical unit number. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. -## VirtualMachinePatchStatus +## RestorePointSourceVmosDisk ### Properties -* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. -* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode -* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the disk size in GB. +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. +* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. -## AvailablePatchSummary +## RestorePointSourceVMStorageProfile ### Properties -* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. -* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. +* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. -## ApiError +## RollingUpgradePolicy ### Properties -* **code**: string: The error code. -* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details -* **innererror**: [InnerError](#innererror): Inner error details. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). +* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. -## ApiErrorBase +## RunCommandInputParameter ### Properties -* **code**: string: The error code. -* **message**: string: The error message. -* **target**: string: The target of the particular error. +* **name**: string (Required): The run command parameter name. +* **value**: string (Required): The run command parameter value. -## InnerError +## ScaleInPolicy ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +* **forceDeletion**: bool: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## LastPatchInstallationSummary +## ScheduledEventsProfile ### Properties -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. -* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. -* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions -* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. -* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## VirtualMachineAgentInstanceView +## SecurityProfile ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **securityType**: 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch. +* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 -## VirtualMachineExtensionHandlerInstanceView +## SharingProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **groups**: [SharingProfileGroup](#sharingprofilegroup)[] (ReadOnly): A list of sharing profile groups. +* **permissions**: 'Groups' | 'Private' | string: This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups** -## VirtualMachineHealthStatus +## SharingProfileGroup ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **ids**: string[]: A list of subscription/tenant ids the gallery is aimed to be shared to. +* **type**: 'AADTenants' | 'Subscriptions' | string: This property allows you to specify the type of sharing group.

    Possible values are:

    **Subscriptions**

    **AADTenants** -## NetworkProfile +## Sku ### Properties -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## VirtualMachineNetworkInterfaceConfiguration +## SoftDeletePolicy ### Properties -* **name**: string (Required): The network interface configuration name. -* **properties**: [VirtualMachineNetworkInterfaceConfigurationProperties](#virtualmachinenetworkinterfaceconfigurationproperties): Describes a virtual machine network profile's IP configuration. +* **isSoftDeleteEnabled**: bool: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. -## VirtualMachineNetworkInterfaceConfigurationProperties +## SpotRestorePolicy ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineNetworkInterfaceDnsSettingsConfiguration](#virtualmachinenetworkinterfacednssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. -* **dscpConfiguration**: [SubResource](#subresource) -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineNetworkInterfaceIPConfiguration](#virtualmachinenetworkinterfaceipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **enabled**: bool: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints +* **restoreTimeout**: string: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances -## VirtualMachineNetworkInterfaceDnsSettingsConfiguration +## SshConfiguration ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## VirtualMachineNetworkInterfaceIPConfiguration +## SshPublicKey ### Properties -* **name**: string (Required): The IP configuration name. -* **properties**: [VirtualMachineNetworkInterfaceIPConfigurationProperties](#virtualmachinenetworkinterfaceipconfigurationproperties): Describes a virtual machine network interface IP configuration properties. +* **keyData**: string: 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/linux/create-ssh-keys-detailed). +* **path**: 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 -## VirtualMachineNetworkInterfaceIPConfigurationProperties +## SshPublicKeyResourceProperties ### Properties -* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. -* **applicationSecurityGroups**: [SubResource](#subresource)[]: Specifies an array of references to application security group. -* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration -* **subnet**: [SubResource](#subresource) +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. -## VirtualMachinePublicIPAddressConfiguration +## StorageProfile ### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachinePublicIPAddressConfigurationProperties](#virtualmachinepublicipaddressconfigurationproperties): Describes a virtual machines IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku +* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). -## VirtualMachinePublicIPAddressConfigurationProperties +## SubResource ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachinePublicIPAddressDnsSettingsConfiguration](#virtualmachinepublicipaddressdnssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineIpTag](#virtualmachineiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Specify the public IP allocation type -* **publicIPPrefix**: [SubResource](#subresource) +* **id**: string: Resource Id -## VirtualMachinePublicIPAddressDnsSettingsConfiguration +## SubResourceReadOnly ### Properties -* **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. +* **id**: string (ReadOnly): Resource Id -## VirtualMachineIpTag +## SubResourceWithColocationStatus ### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id -## PublicIPAddressSku +## TargetRegion ### Properties -* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name -* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier +* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -## NetworkInterfaceReference +## TerminateNotificationProfile ### Properties -* **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. +* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. +* **notBeforeTimeout**: 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) -## NetworkInterfaceReferenceProperties +## UefiSettings ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -## ScheduledEventsProfile +## UpgradePolicy ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## TerminateNotificationProfile +## UserArtifactManage ### Properties -* **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. -* **notBeforeTimeout**: 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) +* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. +* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. +* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. -## StorageProfile +## UserArtifactSource ### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). +* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. +* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. -## DataDisk +## UserAssignedIdentitiesValue ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## VirtualHardDisk +## VaultCertificate ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -## ImageReference +## VaultSecretGroup ### Properties -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sharedGalleryImageId**: string: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. -* **sku**: string: The image SKU. -* **version**: 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. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. -## OSDisk +## VirtualHardDisk ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': 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** -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **uri**: string: Specifies the virtual hard disk's uri. -## DiffDiskSettings +## VirtualMachineAgentInstanceView ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -1235,6 +1136,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1249,154 +1164,178 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## VirtualMachineIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## ResourceTags +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## VirtualMachineRunCommandProperties +## VirtualMachineInstanceView ### Properties -* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. -* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. -* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. -* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. -* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. -* **runAsUser**: string: Specifies the user account on the VM when executing the run command. -* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. -* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineRunCommandInstanceView +## VirtualMachineIpTag ### Properties -* **endTime**: string: Script end time. -* **error**: string: Script error stream. -* **executionMessage**: string: Communicate script configuration errors or execution messages. -* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. -* **exitCode**: int: Exit code returned from script execution. -* **output**: string: Script output stream. -* **startTime**: string: Script start time. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## RunCommandInputParameter +## VirtualMachineNetworkInterfaceConfiguration ### Properties -* **name**: string (Required): The run command parameter name. -* **value**: string (Required): The run command parameter value. +* **name**: string (Required): The network interface configuration name. +* **properties**: [VirtualMachineNetworkInterfaceConfigurationProperties](#virtualmachinenetworkinterfaceconfigurationproperties): Describes a virtual machine network profile's IP configuration. -## VirtualMachineRunCommandScriptSource +## VirtualMachineNetworkInterfaceConfigurationProperties ### Properties -* **commandId**: string: Specifies a commandId of predefined built-in script. -* **script**: string: Specifies the script content to be executed on the VM. -* **scriptUri**: string: Specifies the script download location. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineNetworkInterfaceDnsSettingsConfiguration](#virtualmachinenetworkinterfacednssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. +* **dscpConfiguration**: [SubResource](#subresource) +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineNetworkInterfaceIPConfiguration](#virtualmachinenetworkinterfaceipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## ResourceTags +## VirtualMachineNetworkInterfaceDnsSettingsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetIdentity +## VirtualMachineNetworkInterfaceIPConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. +* **name**: string (Required): The IP configuration name. +* **properties**: [VirtualMachineNetworkInterfaceIPConfigurationProperties](#virtualmachinenetworkinterfaceipconfigurationproperties): Describes a virtual machine network interface IP configuration properties. -## VirtualMachineScaleSetIdentityUserAssignedIdentities +## VirtualMachineNetworkInterfaceIPConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) +* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. +* **applicationSecurityGroups**: [SubResource](#subresource)[]: Specifies an array of references to application security group. +* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration +* **subnet**: [SubResource](#subresource) -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue +## VirtualMachinePatchStatus ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. +* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode +* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. -## VirtualMachineScaleSetProperties +## VirtualMachineProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS +* **availabilitySet**: [SubResource](#subresource) +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) * **hostGroup**: [SubResource](#subresource) -* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. * **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **spotRestorePolicy**: [SpotRestorePolicy](#spotrestorepolicy): Specifies the Spot-Try-Restore properties for the virtual machine scale set.

    With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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). +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## ScaleInPolicy +## VirtualMachinePublicIPAddressConfiguration ### Properties -* **forceDeletion**: bool: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachinePublicIPAddressConfigurationProperties](#virtualmachinepublicipaddressconfigurationproperties): Describes a virtual machines IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku -## SpotRestorePolicy +## VirtualMachinePublicIPAddressConfigurationProperties ### Properties -* **enabled**: bool: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints -* **restoreTimeout**: string: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachinePublicIPAddressDnsSettingsConfiguration](#virtualmachinepublicipaddressdnssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineIpTag](#virtualmachineiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Specify the public IP allocation type +* **publicIPPrefix**: [SubResource](#subresource) -## UpgradePolicy +## VirtualMachinePublicIPAddressDnsSettingsConfiguration ### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. +* **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. -## AutomaticOSUpgradePolicy +## VirtualMachineRunCommandInstanceView ### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +* **endTime**: string: Script end time. +* **error**: string: Script error stream. +* **executionMessage**: string: Communicate script configuration errors or execution messages. +* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. +* **exitCode**: int: Exit code returned from script execution. +* **output**: string: Script output stream. +* **startTime**: string: Script start time. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## RollingUpgradePolicy +## VirtualMachineRunCommandProperties ### Properties -* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). -* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. +* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. +* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. +* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. +* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. +* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. +* **runAsUser**: string: Specifies the user account on the VM when executing the run command. +* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. +* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. -## VirtualMachineScaleSetVMProfile -### Properties -* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +## VirtualMachineRunCommandScriptSource +### Properties +* **commandId**: string: Specifies a commandId of predefined built-in script. +* **script**: string: Specifies the script content to be executed on the VM. +* **scriptUri**: string: Specifies the script download location. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -1405,6 +1344,11 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1419,32 +1363,22 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1463,29 +1397,55 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration +## VirtualMachineScaleSetIpTag ### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +## VirtualMachineScaleSetManagedDiskParameters +### Properties +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types + +## VirtualMachineScaleSetNetworkConfiguration +### Properties +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. + +## VirtualMachineScaleSetNetworkConfigurationDnsSettings +### Properties +* **dnsServers**: string[]: List of DNS servers IP addresses + +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties * **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +## VirtualMachineScaleSetNetworkProfile ### Properties -* **domainNameLabel**: string (Required): 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 +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## VirtualMachineScaleSetIpTag +## VirtualMachineScaleSetOSDisk ### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': 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** +* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetOSProfile ### Properties @@ -1497,46 +1457,85 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +## VirtualMachineScaleSetProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **hostGroup**: [SubResource](#subresource) +* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **spotRestorePolicy**: [SpotRestorePolicy](#spotrestorepolicy): Specifies the Spot-Try-Restore properties for the virtual machine scale set.

    With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + ## VirtualMachineScaleSetStorageProfile ### Properties * **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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/managed-disks-overview). * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetDataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetVMInstanceView ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. +* **platformFaultDomain**: int: The Fault Domain count. +* **platformUpdateDomain**: int: The Update Domain count. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineScaleSetOSDisk +## VirtualMachineScaleSetVMNetworkProfileConfiguration ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': 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** -* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## ResourceTags +## VirtualMachineScaleSetVMProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 ## VirtualMachineScaleSetVMProperties ### Properties @@ -1558,37 +1557,38 @@ * **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 * **vmId**: string (ReadOnly): Azure VM unique ID. -## VirtualMachineScaleSetVMInstanceView +## VirtualMachineScaleSetVMProtectionPolicy ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. -* **platformFaultDomain**: int: The Fault Domain count. -* **platformUpdateDomain**: int: The Update Domain count. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. +* **protectFromScaleSetActions**: bool: 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. -## VirtualMachineScaleSetVMNetworkProfileConfiguration +## VMGalleryApplication ### Properties -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +* **configurationReference**: string: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided +* **order**: int: Optional, Specifies the order in which the packages have to be installed +* **packageReferenceId**: string (Required): Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} +* **tags**: string: Optional, Specifies a passthrough value for more generic context. -## VirtualMachineScaleSetVMProtectionPolicy +## VMSizeProperties ### Properties -* **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. -* **protectFromScaleSetActions**: bool: 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. +* **vCPUsAvailable**: int: Specifies the number of vCPUs available for the VM.

    When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) . +* **vCPUsPerCore**: int: Specifies the vCPU to physical core ratio.

    When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)

    Setting this property to 1 also means that hyper-threading is disabled. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM -## ResourceTags +## WinRMConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2021-08-01/types.md b/generated/compute/microsoft.compute/2021-08-01/types.md index c970944b86..538d7e7159 100644 --- a/generated/compute/microsoft.compute/2021-08-01/types.md +++ b/generated/compute/microsoft.compute/2021-08-01/types.md @@ -63,70 +63,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## DiskAccessProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. -* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk access was created. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionSetIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. - -## EncryptionSetProperties -### Properties -* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots -* **autoKeyRotationError**: [ApiError](#apierror) (ReadOnly): Api error. -* **encryptionType**: 'ConfidentialVmEncryptedWithCustomerKey' | 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. -* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. -* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. -* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. - -## KeyForDiskEncryptionSet -### Properties -* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. -* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault -### Properties -* **id**: string: Resource Id - ## ApiError ### Properties * **code**: string: The error code. @@ -141,15 +77,24 @@ * **message**: string: The error message. * **target**: string: The target of the particular error. -## InnerError +## CreationData ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +* **createOption**: 'Attach' | 'Copy' | 'CopyStart' | 'Empty' | 'FromImage' | 'Import' | 'ImportSecure' | 'Restore' | 'Upload' | 'UploadPreparedSecure' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. +* **securityDataUri**: string: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). -## ResourceTags +## DiskAccessProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. +* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk access was created. ## DiskProperties ### Properties @@ -182,29 +127,37 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData +## DiskSecurityProfile ### Properties -* **createOption**: 'Attach' | 'Copy' | 'CopyStart' | 'Empty' | 'FromImage' | 'Import' | 'ImportSecure' | 'Restore' | 'Upload' | 'UploadPreparedSecure' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. -* **securityDataUri**: string: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). +* **secureVMDiskEncryptionSetId**: string: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key +* **securityType**: 'ConfidentialVM_DiskEncryptedWithCustomerKey' | 'ConfidentialVM_DiskEncryptedWithPlatformKey' | 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' | 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots +* **autoKeyRotationError**: [ApiError](#apierror) (ReadOnly): Api error. +* **encryptionType**: 'ConfidentialVmEncryptedWithCustomerKey' | 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. +* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. +* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. +* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -216,16 +169,59 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference +## ExtendedLocation ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. + +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + +## InnerError +### Properties +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. + +## KeyForDiskEncryptionSet +### Properties +* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. +* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} ## KeyVaultAndKeyReference ### Properties * **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault * **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +## KeyVaultAndSecretReference +### Properties +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + ## PropertyUpdatesInProgress ### Properties * **targetTier**: string: The target performance tier of the disk if a tier change operation is in progress. @@ -237,29 +233,30 @@ * **promotionCode**: string: The Offer Promotion Code. * **publisher**: string (Required): The publisher ID. -## DiskSecurityProfile -### Properties -* **secureVMDiskEncryptionSetId**: string: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key -* **securityType**: 'ConfidentialVM_DiskEncryptedWithCustomerKey' | 'ConfidentialVM_DiskEncryptedWithPlatformKey' | 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' | 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. - -## ShareInfoElement +## ResourceTags ### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. +### Additional Properties +* **Additional Properties Type**: string -## SupportedCapabilities +## ResourceTags ### Properties -* **acceleratedNetwork**: bool: True if the image from which the OS disk is created supports accelerated networking. +### Additional Properties +* **Additional Properties Type**: string -## DiskSku +## ResourceTags ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ShareInfoElement +### Properties +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. + ## SnapshotProperties ### Properties * **completionPercent**: int: Percentage complete for the background copy when a resource is created via the CopyStart operation. @@ -288,8 +285,11 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id + +## SupportedCapabilities +### Properties +* **acceleratedNetwork**: bool: True if the image from which the OS disk is created supports accelerated networking. diff --git a/generated/compute/microsoft.compute/2021-10-01/types.md b/generated/compute/microsoft.compute/2021-10-01/types.md index 4689ad21dd..4627ab334c 100644 --- a/generated/compute/microsoft.compute/2021-10-01/types.md +++ b/generated/compute/microsoft.compute/2021-10-01/types.md @@ -55,49 +55,19 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/galleries/images/versions' (ReadOnly, DeployTimeConstant): The resource type -## GalleryProperties -### Properties -* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. -* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -* **sharingProfile**: [SharingProfile](#sharingprofile): Profile for gallery sharing to subscription or tenant -* **sharingStatus**: [SharingStatus](#sharingstatus) (ReadOnly): Sharing status of current gallery. -* **softDeletePolicy**: [SoftDeletePolicy](#softdeletepolicy): Contains information about the soft deletion policy of the gallery. - -## GalleryIdentifier -### Properties -* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. - -## SharingProfile -### Properties -* **communityGalleryInfo**: any: Anything -* **groups**: [SharingProfileGroup](#sharingprofilegroup)[] (ReadOnly): A list of sharing profile groups. -* **permissions**: 'Groups' | 'Private' | string: This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups** - -## SharingProfileGroup -### Properties -* **ids**: string[]: A list of subscription/tenant ids the gallery is aimed to be shared to. -* **type**: 'AADTenants' | 'Community' | 'Subscriptions' | string: This property allows you to specify the type of sharing group.

    Possible values are:

    **Subscriptions**

    **AADTenants**

    **Community** - -## SharingStatus -### Properties -* **aggregatedState**: 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The sharing state of the gallery, which only appears in the response. -* **summary**: [RegionalSharingStatus](#regionalsharingstatus)[]: Summary of all regional sharing status. - -## RegionalSharingStatus +## DataDiskImageEncryption ### Properties -* **details**: string: Details of gallery regional sharing failure. -* **region**: string: Region name -* **state**: 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The sharing state of the gallery, which only appears in the response. +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -## SoftDeletePolicy +## Disallowed ### Properties -* **isSoftDeleteEnabled**: bool: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. +* **diskTypes**: string[]: A list of disk types. -## ResourceTags +## EncryptionImages ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. +* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. ## GalleryApplicationProperties ### Properties @@ -108,11 +78,6 @@ * **releaseNoteUri**: string: The release note uri. * **supportedOSType**: 'Linux' | 'Windows' (Required): This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux** -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryApplicationVersionProperties ### Properties * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. @@ -133,73 +98,37 @@ * **targetExtendedLocations**: [GalleryTargetExtendedLocation](#gallerytargetextendedlocation)[]: The target extended locations where the Image Version is going to be replicated to. This property is updatable. * **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## UserArtifactManage -### Properties -* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. -* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. -* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. - -## UserArtifactSource -### Properties -* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. -* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. - -## GalleryTargetExtendedLocation -### Properties -* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. -* **extendedLocation**: [GalleryExtendedLocation](#galleryextendedlocation): The name of the extended location. -* **extendedLocationReplicaCount**: int: The number of replicas of the Image Version to be created per extended location. This property is updatable. -* **name**: string: The name of the region. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. - -## EncryptionImages +## GalleryArtifactVersionSource ### Properties -* **dataDiskImages**: [DataDiskImageEncryption](#datadiskimageencryption)[]: A list of encryption specifications for data disk images. -* **osDiskImage**: [OSDiskImageEncryption](#osdiskimageencryption): Contains encryption settings for an OS disk image. +* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. +* **uri**: string: The uri of the gallery artifact version source. Currently used to specify vhd/blob source. -## DataDiskImageEncryption +## GalleryDataDiskImage ### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' * **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. - -## OSDiskImageEncryption -### Properties -* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. -* **securityProfile**: [OSDiskImageSecurityProfile](#osdiskimagesecurityprofile): Contains security profile for an OS disk image. - -## OSDiskImageSecurityProfile -### Properties -* **confidentialVMEncryptionType**: 'EncryptedVMGuestStateOnlyWithPmk' | 'EncryptedWithCmk' | 'EncryptedWithPmk' | string: confidential VM encryption types -* **secureVMDiskEncryptionSetId**: string: secure VM disk encryption set id +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. ## GalleryExtendedLocation ### Properties * **name**: string * **type**: 'EdgeZone' | 'Unknown' | string: It is type of the extended location. -## TargetRegion -### Properties -* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. -* **name**: string (Required): The name of the region. -* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. - -## ReplicationStatus +## GalleryIdentifier ### Properties -* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. -* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. +* **uniqueName**: string (ReadOnly): The unique name of the Shared Image Gallery. This name is generated automatically by Azure. -## RegionalReplicationStatus +## GalleryImageFeature ### Properties -* **details**: string (ReadOnly): The details of the replication status. -* **progress**: int (ReadOnly): It indicates progress of the replication job. -* **region**: string (ReadOnly): The region to which the gallery image version is being replicated to. -* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. +* **name**: string: The name of the gallery image feature. +* **value**: string: The value of the gallery image feature. -## ResourceTags +## GalleryImageIdentifier ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **offer**: string (Required): The name of the gallery image definition offer. +* **publisher**: string (Required): The name of the gallery image definition publisher. +* **sku**: string (Required): The name of the gallery image definition SKU. ## GalleryImageProperties ### Properties @@ -219,20 +148,52 @@ * **recommended**: [RecommendedMachineConfiguration](#recommendedmachineconfiguration): The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. * **releaseNoteUri**: string: The release note uri. -## Disallowed +## GalleryImageVersionProperties ### Properties -* **diskTypes**: string[]: A list of disk types. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **publishingProfile**: [GalleryImageVersionPublishingProfile](#galleryimageversionpublishingprofile): The publishing profile of a gallery image Version. +* **replicationStatus**: [ReplicationStatus](#replicationstatus) (ReadOnly): This is the replication status of the gallery image version. +* **storageProfile**: [GalleryImageVersionStorageProfile](#galleryimageversionstorageprofile) (Required): This is the storage profile of a Gallery Image Version. -## GalleryImageFeature +## GalleryImageVersionPublishingProfile ### Properties -* **name**: string: The name of the gallery image feature. -* **value**: string: The value of the gallery image feature. +* **endOfLifeDate**: string: The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. +* **excludeFromLatest**: bool: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. +* **publishedDate**: string (ReadOnly): The timestamp for when the gallery image version is published. +* **replicaCount**: int: 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. +* **replicationMode**: 'Full' | 'Shallow' | string: Optional parameter which specifies the mode to be used for replication. This property is not updatable. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. +* **targetExtendedLocations**: [GalleryTargetExtendedLocation](#gallerytargetextendedlocation)[]: The target extended locations where the Image Version is going to be replicated to. This property is updatable. +* **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. -## GalleryImageIdentifier +## GalleryImageVersionStorageProfile ### Properties -* **offer**: string (Required): The name of the gallery image definition offer. -* **publisher**: string (Required): The name of the gallery image definition publisher. -* **sku**: string (Required): The name of the gallery image definition SKU. +* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[]: A list of data disk images. +* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. + +## GalleryOSDiskImage +### Properties +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' +* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. +* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. + +## GalleryProperties +### Properties +* **description**: string: The description of this Shared Image Gallery resource. This property is updatable. +* **identifier**: [GalleryIdentifier](#galleryidentifier): Describes the gallery unique name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. +* **sharingProfile**: [SharingProfile](#sharingprofile): Profile for gallery sharing to subscription or tenant +* **sharingStatus**: [SharingStatus](#sharingstatus) (ReadOnly): Sharing status of current gallery. +* **softDeletePolicy**: [SoftDeletePolicy](#softdeletepolicy): Contains information about the soft deletion policy of the gallery. + +## GalleryTargetExtendedLocation +### Properties +* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. +* **extendedLocation**: [GalleryExtendedLocation](#galleryextendedlocation): The name of the extended location. +* **extendedLocationReplicaCount**: int: The number of replicas of the Image Version to be created per extended location. This property is updatable. +* **name**: string: The name of the region. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. ## ImagePurchasePlan ### Properties @@ -240,11 +201,39 @@ * **product**: string: The product ID. * **publisher**: string: The publisher ID. +## OSDiskImageEncryption +### Properties +* **diskEncryptionSetId**: string: A relative URI containing the resource ID of the disk encryption set. +* **securityProfile**: [OSDiskImageSecurityProfile](#osdiskimagesecurityprofile): Contains security profile for an OS disk image. + +## OSDiskImageSecurityProfile +### Properties +* **confidentialVMEncryptionType**: 'EncryptedVMGuestStateOnlyWithPmk' | 'EncryptedWithCmk' | 'EncryptedWithPmk' | string: confidential VM encryption types +* **secureVMDiskEncryptionSetId**: string: secure VM disk encryption set id + ## RecommendedMachineConfiguration ### Properties * **memory**: [ResourceRange](#resourcerange): Describes the resource range. * **vCPUs**: [ResourceRange](#resourcerange): Describes the resource range. +## RegionalReplicationStatus +### Properties +* **details**: string (ReadOnly): The details of the replication status. +* **progress**: int (ReadOnly): It indicates progress of the replication job. +* **region**: string (ReadOnly): The region to which the gallery image version is being replicated to. +* **state**: 'Completed' | 'Failed' | 'Replicating' | 'Unknown' | string (ReadOnly): This is the regional replication state. + +## RegionalSharingStatus +### Properties +* **details**: string: Details of gallery regional sharing failure. +* **region**: string: Region name +* **state**: 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The sharing state of the gallery, which only appears in the response. + +## ReplicationStatus +### Properties +* **aggregatedState**: 'Completed' | 'Failed' | 'InProgress' | 'Unknown' | string (ReadOnly): This is the aggregated replication status based on all the regional replication status flags. +* **summary**: [RegionalReplicationStatus](#regionalreplicationstatus)[] (ReadOnly): This is a summary of replication status for each region. + ## ResourceRange ### Properties * **max**: int: The maximum number of the resource. @@ -255,50 +244,61 @@ ### Additional Properties * **Additional Properties Type**: string -## GalleryImageVersionProperties +## ResourceTags ### Properties -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -* **publishingProfile**: [GalleryImageVersionPublishingProfile](#galleryimageversionpublishingprofile): The publishing profile of a gallery image Version. -* **replicationStatus**: [ReplicationStatus](#replicationstatus) (ReadOnly): This is the replication status of the gallery image version. -* **storageProfile**: [GalleryImageVersionStorageProfile](#galleryimageversionstorageprofile) (Required): This is the storage profile of a Gallery Image Version. +### Additional Properties +* **Additional Properties Type**: string -## GalleryImageVersionPublishingProfile +## ResourceTags ### Properties -* **endOfLifeDate**: string: The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. -* **excludeFromLatest**: bool: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. -* **publishedDate**: string (ReadOnly): The timestamp for when the gallery image version is published. -* **replicaCount**: int: 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. -* **replicationMode**: 'Full' | 'Shallow' | string: Optional parameter which specifies the mode to be used for replication. This property is not updatable. -* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. -* **targetExtendedLocations**: [GalleryTargetExtendedLocation](#gallerytargetextendedlocation)[]: The target extended locations where the Image Version is going to be replicated to. This property is updatable. -* **targetRegions**: [TargetRegion](#targetregion)[]: The target regions where the Image Version is going to be replicated to. This property is updatable. +### Additional Properties +* **Additional Properties Type**: string -## GalleryImageVersionStorageProfile +## ResourceTags ### Properties -* **dataDiskImages**: [GalleryDataDiskImage](#gallerydatadiskimage)[]: A list of data disk images. -* **osDiskImage**: [GalleryOSDiskImage](#galleryosdiskimage): This is the OS disk image. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +### Additional Properties +* **Additional Properties Type**: string -## GalleryDataDiskImage +## ResourceTags ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **lun**: int (Required): This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +### Additional Properties +* **Additional Properties Type**: string -## GalleryArtifactVersionSource +## SharingProfile ### Properties -* **id**: string: The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. -* **uri**: string: The uri of the gallery artifact version source. Currently used to specify vhd/blob source. +* **communityGalleryInfo**: any: Anything +* **groups**: [SharingProfileGroup](#sharingprofilegroup)[] (ReadOnly): A list of sharing profile groups. +* **permissions**: 'Groups' | 'Private' | string: This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups** -## GalleryOSDiskImage +## SharingProfileGroup ### Properties -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite': The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' -* **sizeInGB**: int (ReadOnly): This property indicates the size of the VHD to be created. -* **source**: [GalleryArtifactVersionSource](#galleryartifactversionsource): The gallery artifact version source. +* **ids**: string[]: A list of subscription/tenant ids the gallery is aimed to be shared to. +* **type**: 'AADTenants' | 'Community' | 'Subscriptions' | string: This property allows you to specify the type of sharing group.

    Possible values are:

    **Subscriptions**

    **AADTenants**

    **Community** -## ResourceTags +## SharingStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aggregatedState**: 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The sharing state of the gallery, which only appears in the response. +* **summary**: [RegionalSharingStatus](#regionalsharingstatus)[]: Summary of all regional sharing status. + +## SoftDeletePolicy +### Properties +* **isSoftDeleteEnabled**: bool: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. + +## TargetRegion +### Properties +* **encryption**: [EncryptionImages](#encryptionimages): Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. +* **name**: string (Required): The name of the region. +* **regionalReplicaCount**: int: The number of replicas of the Image Version to be created per region. This property is updatable. +* **storageAccountType**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: Specifies the storage account type to be used to store the image. This property is not updatable. + +## UserArtifactManage +### Properties +* **install**: string (Required): Required. The path and arguments to install the gallery application. This is limited to 4096 characters. +* **remove**: string (Required): Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. +* **update**: string: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. + +## UserArtifactSource +### Properties +* **defaultConfigurationLink**: string: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. +* **mediaLink**: string (Required): Required. The mediaLink of the artifact, must be a readable storage page blob. diff --git a/generated/compute/microsoft.compute/2021-11-01/types.md b/generated/compute/microsoft.compute/2021-11-01/types.md index c2c4c1014e..5a4094a7b8 100644 --- a/generated/compute/microsoft.compute/2021-11-01/types.md +++ b/generated/compute/microsoft.compute/2021-11-01/types.md @@ -214,6 +214,51 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands' (ReadOnly, DeployTimeConstant): The resource type +## AdditionalCapabilities +### Properties +* **hibernationEnabled**: bool: The flag that enables or disables hibernation capability on the VM. +* **ultraSSDEnabled**: bool: 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. + +## AdditionalUnattendContent +### Properties +* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. +* **content**: 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. +* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. +* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. + +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + +## ApiError +### Properties +* **code**: string: The error code. +* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details +* **innererror**: [InnerError](#innererror): Inner error details. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApiErrorBase +### Properties +* **code**: string: The error code. +* **message**: string: The error message. +* **target**: string: The target of the particular error. + +## ApplicationProfile +### Properties +* **galleryApplications**: [VMGalleryApplication](#vmgalleryapplication)[]: Specifies the gallery applications that should be made available to the VM/VMSS + +## AutomaticOSUpgradePolicy +### Properties +* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. +* **enableAutomaticOSUpgrade**: bool: 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. + +## AutomaticRepairsPolicy +### Properties +* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. +* **gracePeriod**: 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 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). +* **repairAction**: 'Reimage' | 'Replace' | 'Restart' | string: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. + ## AvailabilitySetProperties ### Properties * **platformFaultDomainCount**: int: Fault Domain count. @@ -222,28 +267,35 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The resource status information. * **virtualMachines**: [SubResource](#subresource)[]: A list of references to all virtual machines in the availability set. -## SubResource +## AvailablePatchSummary ### Properties -* **id**: string: Resource Id +* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. +* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## InstanceViewStatus +## BillingProfile ### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning': The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. +* **maxPrice**: int: 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. -## Sku +## BootDiagnostics ### Properties -* **capacity**: int: Specifies the number of virtual machines in the scale set. -* **name**: string: The sku name. -* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** +* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. +* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. -## ResourceTags +## BootDiagnosticsInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. + +## CapacityReservationGroupInstanceView +### Properties +* **capacityReservations**: [CapacityReservationInstanceViewWithName](#capacityreservationinstanceviewwithname)[] (ReadOnly): List of instance view of the capacity reservations under the capacity reservation group. ## CapacityReservationGroupProperties ### Properties @@ -251,13 +303,10 @@ * **instanceView**: [CapacityReservationGroupInstanceView](#capacityreservationgroupinstanceview) (ReadOnly) * **virtualMachinesAssociated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines associated to the capacity reservation group. -## SubResourceReadOnly -### Properties -* **id**: string (ReadOnly): Resource Id - -## CapacityReservationGroupInstanceView +## CapacityReservationInstanceView ### Properties -* **capacityReservations**: [CapacityReservationInstanceViewWithName](#capacityreservationinstanceviewwithname)[] (ReadOnly): List of instance view of the capacity reservations under the capacity reservation group. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. ## CapacityReservationInstanceViewWithName ### Properties @@ -265,14 +314,9 @@ * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. * **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. -## CapacityReservationUtilization -### Properties -* **virtualMachinesAllocated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machines resource ids allocated against the capacity reservation. - -## ResourceTags +## CapacityReservationProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacityReservationGroup**: [SubResource](#subresource) ## CapacityReservationProperties ### Properties @@ -283,15 +327,39 @@ * **timeCreated**: string (ReadOnly): Specifies the time at which the Capacity Reservation resource was created.

    Minimum api-version: 2021-11-01. * **virtualMachinesAssociated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machine resource ids that are associated with the capacity reservation. -## CapacityReservationInstanceView +## CapacityReservationUtilization ### Properties -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **utilizationInfo**: [CapacityReservationUtilization](#capacityreservationutilization): Represents the capacity reservation utilization in terms of resources allocated. +* **virtualMachinesAllocated**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of all virtual machines resource ids allocated against the capacity reservation. -## ResourceTags +## DataDisk ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. +* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **lun**: int (Required): 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. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. + +## DedicatedHostAllocatableVM +### Properties +* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. +* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. + +## DedicatedHostAvailableCapacity +### Properties +* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. + +## DedicatedHostGroupInstanceView +### Properties +* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. ## DedicatedHostGroupProperties ### Properties @@ -300,9 +368,11 @@ * **platformFaultDomainCount**: int (Required): Number of fault domains that the host group can span. * **supportAutomaticPlacement**: bool: Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01. -## DedicatedHostGroupInstanceView +## DedicatedHostInstanceView ### Properties -* **hosts**: [DedicatedHostInstanceViewWithName](#dedicatedhostinstanceviewwithname)[]: List of instance view of the dedicated hosts under the dedicated host group. +* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. +* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. ## DedicatedHostInstanceViewWithName ### Properties @@ -311,20 +381,6 @@ * **name**: string (ReadOnly): The name of the dedicated host. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## DedicatedHostAvailableCapacity -### Properties -* **allocatableVMs**: [DedicatedHostAllocatableVM](#dedicatedhostallocatablevm)[]: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. - -## DedicatedHostAllocatableVM -### Properties -* **count**: int: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. -* **vmSize**: string: VM size in terms of which the unutilized capacity is represented. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DedicatedHostProperties ### Properties * **autoReplaceOnFailure**: bool: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. @@ -337,34 +393,45 @@ * **timeCreated**: string (ReadOnly): Specifies the time at which the Dedicated Host resource was created.

    Minimum api-version: 2021-11-01. * **virtualMachines**: [SubResourceReadOnly](#subresourcereadonly)[] (ReadOnly): A list of references to all virtual machines in the Dedicated Host. -## DedicatedHostInstanceView +## DiagnosticsProfile ### Properties -* **assetId**: string (ReadOnly): Specifies the unique id of the dedicated physical machine on which the dedicated host resides. -* **availableCapacity**: [DedicatedHostAvailableCapacity](#dedicatedhostavailablecapacity): Dedicated host unutilized capacity. +* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. + +## DiffDiskSettings +### Properties +* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. +* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements + +## DiskEncryptionSetParameters +### Properties +* **id**: string: Resource Id + +## DiskEncryptionSettings +### Properties +* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret +* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key + +## DiskInstanceView +### Properties +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 +* **name**: string: The disk name. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## ResourceTags +## DiskRestorePointInstanceView ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Disk restore point Id. +* **replicationStatus**: any: Any object ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ImageProperties -### Properties -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **sourceVirtualMachine**: [SubResource](#subresource) -* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. - -## ImageStorageProfile +## HardwareProfile ### Properties -* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). -* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. -* **zoneResilient**: bool: 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). +* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. +* **vmSizeProperties**: [VMSizeProperties](#vmsizeproperties): Specifies VM Size Property settings on the virtual machine. ## ImageDataDisk ### Properties @@ -377,10 +444,6 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## DiskEncryptionSetParameters -### Properties -* **id**: string: Resource Id - ## ImageOSDisk ### Properties * **blobUri**: string: The Virtual Hard Disk. @@ -393,96 +456,126 @@ * **snapshot**: [SubResource](#subresource) * **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## ResourceTags +## ImageProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **sourceVirtualMachine**: [SubResource](#subresource) +* **storageProfile**: [ImageStorageProfile](#imagestorageprofile): Describes a storage profile. -## ProximityPlacementGroupProperties +## ImageReference ### Properties -* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. -* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. -* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. +* **communityGalleryImageId**: string: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. +* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. +* **id**: string: Resource Id +* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sharedGalleryImageId**: string: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. +* **sku**: string: The image SKU. +* **version**: 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. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. -## SubResourceWithColocationStatus +## ImageStorageProfile ### Properties -* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **id**: string: Resource Id +* **dataDisks**: [ImageDataDisk](#imagedatadisk)[]: 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/managed-disks-overview). +* **osDisk**: [ImageOSDisk](#imageosdisk): Describes an Operating System disk. +* **zoneResilient**: bool: 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). -## ResourceTags +## InnerError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. -## RestorePointCollectionProperties +## InstanceViewStatus ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. -* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. -* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. -* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning': The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. -## RestorePoint +## KeyVaultKeyReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string (ReadOnly): Resource name -* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. -* **type**: string (ReadOnly): Resource type +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## RestorePointProperties +## KeyVaultSecretReference ### Properties -* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. -* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. -* **instanceView**: [RestorePointInstanceView](#restorepointinstanceview) (ReadOnly): The instance view of a restore point. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. -* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. -* **sourceRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **timeCreated**: string: Gets the creation time of the restore point. +* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. +* **sourceVault**: [SubResource](#subresource) (Required) -## ApiEntityReference +## LastPatchInstallationSummary ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **error**: [ApiError](#apierror) (ReadOnly): Api error. +* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. +* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. +* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. +* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. +* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions +* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. +* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. +* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. +* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." -## RestorePointInstanceView +## LinuxConfiguration ### Properties -* **diskRestorePoints**: [DiskRestorePointInstanceView](#diskrestorepointinstanceview)[]: The disk restore points information. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. +* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. +* **provisionVMAgent**: bool: 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. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## DiskRestorePointInstanceView +## LinuxPatchSettings ### Properties -* **id**: string: Disk restore point Id. -* **replicationStatus**: any: Any object +* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. +* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true -## RestorePointSourceMetadata +## MaintenanceRedeployStatus ### Properties -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **licenseType**: string: Gets the license type, which is for bring your own license scenario. -* **location**: string: Location of the VM from which the restore point was created. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. -* **vmId**: string: Gets the virtual machine unique id. +* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. +* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. +* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. +* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. +* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. +* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. +* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. -## DiagnosticsProfile +## ManagedDiskParameters ### Properties -* **bootDiagnostics**: [BootDiagnostics](#bootdiagnostics): 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. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **id**: string: Resource Id +* **securityProfile**: [VMDiskSecurityProfile](#vmdisksecurityprofile): Specifies the security profile settings for the managed disk.

    NOTE: It can only be set for Confidential VMs +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types -## BootDiagnostics +## NetworkInterfaceReference ### Properties -* **enabled**: bool: Whether boot diagnostics should be enabled on the Virtual Machine. -* **storageUri**: string: Uri of the storage account to use for placing the console output and screenshot.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used. +* **id**: string: Resource Id +* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## HardwareProfile +## NetworkInterfaceReferenceProperties ### Properties -* **vmSize**: 'Basic_A0' | 'Basic_A1' | 'Basic_A2' | 'Basic_A3' | 'Basic_A4' | 'Standard_A0' | '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_B1ms' | 'Standard_B1s' | 'Standard_B2ms' | 'Standard_B2s' | 'Standard_B4ms' | 'Standard_B8ms' | 'Standard_D1' | 'Standard_D11' | 'Standard_D11_v2' | 'Standard_D12' | 'Standard_D12_v2' | 'Standard_D13' | 'Standard_D13_v2' | 'Standard_D14' | 'Standard_D14_v2' | 'Standard_D15_v2' | 'Standard_D16_v3' | 'Standard_D16s_v3' | 'Standard_D1_v2' | 'Standard_D2' | 'Standard_D2_v2' | 'Standard_D2_v3' | 'Standard_D2s_v3' | 'Standard_D3' | 'Standard_D32_v3' | 'Standard_D32s_v3' | 'Standard_D3_v2' | 'Standard_D4' | 'Standard_D4_v2' | 'Standard_D4_v3' | 'Standard_D4s_v3' | 'Standard_D5_v2' | 'Standard_D64_v3' | 'Standard_D64s_v3' | 'Standard_D8_v3' | 'Standard_D8s_v3' | 'Standard_DS1' | 'Standard_DS11' | 'Standard_DS11_v2' | 'Standard_DS12' | 'Standard_DS12_v2' | 'Standard_DS13' | 'Standard_DS13-2_v2' | 'Standard_DS13-4_v2' | 'Standard_DS13_v2' | 'Standard_DS14' | 'Standard_DS14-4_v2' | 'Standard_DS14-8_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS1_v2' | 'Standard_DS2' | 'Standard_DS2_v2' | 'Standard_DS3' | 'Standard_DS3_v2' | 'Standard_DS4' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16_v3' | 'Standard_E16s_v3' | 'Standard_E2_v3' | 'Standard_E2s_v3' | 'Standard_E32-16_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: Specifies the size of the virtual machine.

    The enum data type is currently deprecated and will be removed by December 23rd 2023.

    Recommended way to get the list of available sizes is using 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/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. -* **vmSizeProperties**: [VMSizeProperties](#vmsizeproperties): Specifies VM Size Property settings on the virtual machine. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VMSizeProperties +## NetworkProfile ### Properties -* **vCPUsAvailable**: int: Specifies the number of vCPUs available for the VM.

    When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) . -* **vCPUsPerCore**: int: Specifies the vCPU to physical core ratio.

    When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)

    Setting this property to 1 also means that hyper-threading is disabled. +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. +* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. + +## OSDisk +### Properties +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## OSProfile ### Properties @@ -496,490 +589,293 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. -## LinuxConfiguration -### Properties -* **disablePasswordAuthentication**: bool: Specifies whether password authentication should be disabled. -* **patchSettings**: [LinuxPatchSettings](#linuxpatchsettings): Specifies settings related to VM Guest Patching on Linux. -* **provisionVMAgent**: bool: 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. -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure - -## LinuxPatchSettings -### Properties -* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. -* **patchMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **ImageDefault** - The virtual machine's default patching configuration is used.

    **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true - -## SshConfiguration -### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. - -## SshPublicKey -### Properties -* **keyData**: string: 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/linux/create-ssh-keys-detailed). -* **path**: 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 - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. - -## VaultCertificate -### Properties -* **certificateStore**: string: 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. -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). - -## WindowsConfiguration -### Properties -* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. -* **enableAutomaticUpdates**: bool: 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. -* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. -* **provisionVMAgent**: bool: 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. -* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). -* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM - -## AdditionalUnattendContent -### Properties -* **componentName**: 'Microsoft-Windows-Shell-Setup': The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. -* **content**: 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. -* **passName**: 'OobeSystem': The pass name. Currently, the only allowable value is OobeSystem. -* **settingName**: 'AutoLogon' | 'FirstLogonCommands': Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - ## PatchSettings ### Properties * **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

    Possible values are:

    **ImageDefault** - You control the timing of patch assessments on a virtual machine.

    **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. * **enableHotpatching**: bool: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. * **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'Manual' | string: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true -## WinRMConfiguration +## Plan ### Properties -* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher ID. -## WinRMListener +## ProximityPlacementGroupProperties ### Properties -* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** +* **availabilitySets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all availability sets in the proximity placement group. +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **proximityPlacementGroupType**: 'Standard' | 'Ultra' | 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. +* **virtualMachines**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machines in the proximity placement group. +* **virtualMachineScaleSets**: [SubResourceWithColocationStatus](#subresourcewithcolocationstatus)[] (ReadOnly): A list of references to all virtual machine scale sets in the proximity placement group. -## SecurityProfile +## PublicIPAddressSku ### Properties -* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **securityType**: 'ConfidentialVM' | 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set. -* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 +* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name +* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier -## UefiSettings +## ResourceTags ### Properties -* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVMStorageProfile +## ResourceTags ### Properties -* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. -* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVMDataDisk +## ResourceTags ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. -* **lun**: int: Gets the logical unit number. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. +### Additional Properties +* **Additional Properties Type**: string -## ManagedDiskParameters +## ResourceTags ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **id**: string: Resource Id -* **securityProfile**: [VMDiskSecurityProfile](#vmdisksecurityprofile): Specifies the security profile settings for the managed disk.

    NOTE: It can only be set for Confidential VMs -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +### Additional Properties +* **Additional Properties Type**: string -## VMDiskSecurityProfile +## ResourceTags ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **securityEncryptionType**: 'DiskWithVMGuestState' | 'VMGuestStateOnly' | string: Specifies the EncryptionType of the managed disk.
    It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob.

    NOTE: It can be set for only Confidential VMs. +### Additional Properties +* **Additional Properties Type**: string -## RestorePointSourceVmosDisk +## ResourceTags ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. -* **diskSizeGB**: int: Gets the disk size in GB. -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: Gets the disk name. -* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. +### Additional Properties +* **Additional Properties Type**: string -## DiskEncryptionSettings +## ResourceTags ### Properties -* **diskEncryptionKey**: [KeyVaultSecretReference](#keyvaultsecretreference): Describes a reference to Key Vault Secret -* **enabled**: bool: Specifies whether disk encryption should be enabled on the virtual machine. -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultSecretReference +## ResourceTags ### Properties -* **secretUrl**: string (Required): The URL referencing a secret in a Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## KeyVaultKeyReference +## ResourceTags ### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [SubResource](#subresource) (Required) +### Additional Properties +* **Additional Properties Type**: string -## RestorePointCollectionSourceProperties +## ResourceTags ### Properties -* **id**: string: Resource Id of the source resource used to create this restore point collection -* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SshPublicKeyResourceProperties +## ResourceTags ### Properties -* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineIdentity +## ResourceTags ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineIdentityUserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) - -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## Plan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher ID. - -## VirtualMachineProperties -### Properties -* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS -* **availabilitySet**: [SubResource](#subresource) -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. -* **host**: [SubResource](#subresource) -* **hostGroup**: [SubResource](#subresource) -* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. -* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **proximityPlacementGroup**: [SubResource](#subresource) -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **timeCreated**: string (ReadOnly): Specifies the time at which the Virtual Machine resource was created.

    Minimum api-version: 2021-11-01. -* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 -* **virtualMachineScaleSet**: [SubResource](#subresource) -* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. - -## AdditionalCapabilities -### Properties -* **hibernationEnabled**: bool: The flag that enables or disables hibernation capability on the VM. -* **ultraSSDEnabled**: bool: 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. - -## ApplicationProfile -### Properties -* **galleryApplications**: [VMGalleryApplication](#vmgalleryapplication)[]: Specifies the gallery applications that should be made available to the VM/VMSS - -## VMGalleryApplication -### Properties -* **configurationReference**: string: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided -* **order**: int: Optional, Specifies the order in which the packages have to be installed -* **packageReferenceId**: string (Required): Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} -* **tags**: string: Optional, Specifies a passthrough value for more generic context. - -## BillingProfile -### Properties -* **maxPrice**: int: 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. +* **Additional Properties Type**: string -## CapacityReservationProfile +## ResourceTags ### Properties -* **capacityReservationGroup**: [SubResource](#subresource) +### Additional Properties +* **Additional Properties Type**: string -## VirtualMachineInstanceView +## RestorePoint ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **computerName**: string: The computer name assigned to the virtual machine. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **osName**: string: The Operating System running on the virtual machine. -* **osVersion**: string: The version of Operating System running on the virtual machine. -* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. -* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. -* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **id**: string (ReadOnly): Resource Id +* **name**: string (ReadOnly): Resource name +* **properties**: [RestorePointProperties](#restorepointproperties): The restore point properties. +* **type**: string (ReadOnly): Resource type -## BootDiagnosticsInstanceView +## RestorePointCollectionProperties ### Properties -* **consoleScreenshotBlobUri**: string (ReadOnly): The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **serialConsoleLogBlobUri**: string (ReadOnly): The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage. -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **provisioningState**: string (ReadOnly): The provisioning state of the restore point collection. +* **restorePointCollectionId**: string (ReadOnly): The unique id of the restore point collection. +* **restorePoints**: [RestorePoint](#restorepoint)[] (ReadOnly): A list containing all restore points created under this restore point collection. +* **source**: [RestorePointCollectionSourceProperties](#restorepointcollectionsourceproperties): The properties of the source resource that this restore point collection is created from. -## DiskInstanceView +## RestorePointCollectionSourceProperties ### Properties -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings)[]: Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 -* **name**: string: The disk name. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **id**: string: Resource Id of the source resource used to create this restore point collection +* **location**: string (ReadOnly): Location of the source resource used to create this restore point collection. -## VirtualMachineExtensionInstanceView +## RestorePointInstanceView ### Properties -* **name**: string: The virtual machine extension name. +* **diskRestorePoints**: [DiskRestorePointInstanceView](#diskrestorepointinstanceview)[]: The disk restore points information. * **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## MaintenanceRedeployStatus -### Properties -* **isCustomerInitiatedMaintenanceAllowed**: bool: True, if customer is allowed to perform Maintenance. -* **lastOperationMessage**: string: Message returned for the last Maintenance Operation. -* **lastOperationResultCode**: 'MaintenanceAborted' | 'MaintenanceCompleted' | 'None' | 'RetryLater': The Last Maintenance Operation Result Code. -* **maintenanceWindowEndTime**: string: End Time for the Maintenance Window. -* **maintenanceWindowStartTime**: string: Start Time for the Maintenance Window. -* **preMaintenanceWindowEndTime**: string: End Time for the Pre Maintenance Window. -* **preMaintenanceWindowStartTime**: string: Start Time for the Pre Maintenance Window. - -## VirtualMachinePatchStatus -### Properties -* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. -* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode -* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. - -## AvailablePatchSummary -### Properties -* **assessmentActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **criticalAndSecurityPatchCount**: int (ReadOnly): The number of critical or security patches that have been detected as available and not yet installed. -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **otherPatchCount**: int (ReadOnly): The number of all available patches excluding critical and security. -* **rebootPending**: bool (ReadOnly): The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." - -## ApiError -### Properties -* **code**: string: The error code. -* **details**: [ApiErrorBase](#apierrorbase)[]: The Api error details -* **innererror**: [InnerError](#innererror): Inner error details. -* **message**: string: The error message. -* **target**: string: The target of the particular error. - -## ApiErrorBase -### Properties -* **code**: string: The error code. -* **message**: string: The error message. -* **target**: string: The target of the particular error. -## InnerError +## RestorePointProperties ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +* **consistencyMode**: 'ApplicationConsistent' | 'CrashConsistent' | 'FileSystemConsistent' | string (ReadOnly): Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details. +* **excludeDisks**: [ApiEntityReference](#apientityreference)[]: List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. +* **instanceView**: [RestorePointInstanceView](#restorepointinstanceview) (ReadOnly): The instance view of a restore point. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the restore point. +* **sourceMetadata**: [RestorePointSourceMetadata](#restorepointsourcemetadata) (ReadOnly): Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. +* **sourceRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **timeCreated**: string: Gets the creation time of the restore point. -## LastPatchInstallationSummary +## RestorePointSourceMetadata ### Properties -* **error**: [ApiError](#apierror) (ReadOnly): Api error. -* **excludedPatchCount**: int (ReadOnly): The number of all available patches but excluded explicitly by a customer-specified exclusion list match. -* **failedPatchCount**: int (ReadOnly): The count of patches that failed installation. -* **installationActivityId**: string (ReadOnly): The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. -* **installedPatchCount**: int (ReadOnly): The count of patches that successfully installed. -* **lastModifiedTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **maintenanceWindowExceeded**: bool (ReadOnly): Describes whether the operation ran out of time before it completed all its intended actions -* **notSelectedPatchCount**: int (ReadOnly): The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. -* **pendingPatchCount**: int (ReadOnly): The number of all available patches expected to be installed over the course of the patch installation operation. -* **startTime**: string (ReadOnly): The UTC timestamp when the operation began. -* **status**: 'CompletedWithWarnings' | 'Failed' | 'InProgress' | 'Succeeded' | 'Unknown' | string (ReadOnly): The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **licenseType**: string: Gets the license type, which is for bring your own license scenario. +* **location**: string: Location of the VM from which the restore point was created. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [RestorePointSourceVMStorageProfile](#restorepointsourcevmstorageprofile): Describes the storage profile. +* **vmId**: string: Gets the virtual machine unique id. -## VirtualMachineAgentInstanceView +## RestorePointSourceVMDataDisk ### Properties -* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgentVersion**: string: The VM Agent full version. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. +* **lun**: int: Gets the logical unit number. +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. -## VirtualMachineExtensionHandlerInstanceView +## RestorePointSourceVmosDisk ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **diskRestorePoint**: [ApiEntityReference](#apientityreference): The API entity reference. +* **diskSizeGB**: int: Gets the disk size in GB. +* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk +* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. +* **name**: string: Gets the disk name. +* **osType**: 'Linux' | 'Windows' | string: Gets the Operating System type. -## VirtualMachineHealthStatus +## RestorePointSourceVMStorageProfile ### Properties -* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. +* **dataDisks**: [RestorePointSourceVMDataDisk](#restorepointsourcevmdatadisk)[]: Gets the data disks of the VM captured at the time of the restore point creation. +* **osDisk**: [RestorePointSourceVmosDisk](#restorepointsourcevmosdisk): Describes an Operating System disk. -## NetworkProfile +## RollingUpgradePolicy ### Properties -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineNetworkInterfaceConfiguration](#virtualmachinenetworkinterfaceconfiguration)[]: Specifies the networking configurations that will be used to create the virtual machine networking resources. -* **networkInterfaces**: [NetworkInterfaceReference](#networkinterfacereference)[]: Specifies the list of resource Ids for the network interfaces associated with the virtual machine. +* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. +* **maxBatchInstancePercent**: int: 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%. +* **maxUnhealthyInstancePercent**: int: 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%. +* **maxUnhealthyUpgradedInstancePercent**: int: 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%. +* **pauseTimeBetweenBatches**: 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). +* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. -## VirtualMachineNetworkInterfaceConfiguration +## RunCommandInputParameter ### Properties -* **name**: string (Required): The network interface configuration name. -* **properties**: [VirtualMachineNetworkInterfaceConfigurationProperties](#virtualmachinenetworkinterfaceconfigurationproperties): Describes a virtual machine network profile's IP configuration. +* **name**: string (Required): The run command parameter name. +* **value**: string (Required): The run command parameter value. -## VirtualMachineNetworkInterfaceConfigurationProperties +## ScaleInPolicy ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineNetworkInterfaceDnsSettingsConfiguration](#virtualmachinenetworkinterfacednssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. -* **dscpConfiguration**: [SubResource](#subresource) -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineNetworkInterfaceIPConfiguration](#virtualmachinenetworkinterfaceipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **forceDeletion**: bool: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) +* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    -## VirtualMachineNetworkInterfaceDnsSettingsConfiguration +## ScheduledEventsProfile ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) -## VirtualMachineNetworkInterfaceIPConfiguration +## SecurityProfile ### Properties -* **name**: string (Required): The IP configuration name. -* **properties**: [VirtualMachineNetworkInterfaceIPConfigurationProperties](#virtualmachinenetworkinterfaceipconfigurationproperties): Describes a virtual machine network interface IP configuration properties. +* **encryptionAtHost**: bool: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **securityType**: 'ConfidentialVM' | 'TrustedLaunch' | string: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

    Default: UefiSettings will not be enabled unless this property is set. +* **uefiSettings**: [UefiSettings](#uefisettings): Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

    Minimum api-version: 2020-12-01 -## VirtualMachineNetworkInterfaceIPConfigurationProperties +## Sku ### Properties -* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. -* **applicationSecurityGroups**: [SubResource](#subresource)[]: Specifies an array of references to application security group. -* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration -* **subnet**: [SubResource](#subresource) +* **capacity**: int: Specifies the number of virtual machines in the scale set. +* **name**: string: The sku name. +* **tier**: string: Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic** -## VirtualMachinePublicIPAddressConfiguration +## SpotRestorePolicy ### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachinePublicIPAddressConfigurationProperties](#virtualmachinepublicipaddressconfigurationproperties): Describes a virtual machines IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. +* **enabled**: bool: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints +* **restoreTimeout**: string: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances -## VirtualMachinePublicIPAddressConfigurationProperties +## SshConfiguration ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachinePublicIPAddressDnsSettingsConfiguration](#virtualmachinepublicipaddressdnssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineIpTag](#virtualmachineiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Specify the public IP allocation type -* **publicIPPrefix**: [SubResource](#subresource) +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. -## VirtualMachinePublicIPAddressDnsSettingsConfiguration +## SshPublicKey ### Properties -* **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. +* **keyData**: string: 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/linux/create-ssh-keys-detailed). +* **path**: 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 -## VirtualMachineIpTag +## SshPublicKeyResourceProperties ### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. +* **publicKey**: string: SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. -## PublicIPAddressSku +## StorageProfile ### Properties -* **name**: 'Basic' | 'Standard' | string: Specify public IP sku name -* **tier**: 'Global' | 'Regional' | string: Specify public IP sku tier +* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). +* **imageReference**: [ImageReference](#imagereference): 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. +* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). -## NetworkInterfaceReference +## SubResource ### Properties * **id**: string: Resource Id -* **properties**: [NetworkInterfaceReferenceProperties](#networkinterfacereferenceproperties): Describes a network interface reference properties. -## NetworkInterfaceReferenceProperties +## SubResourceReadOnly ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **id**: string (ReadOnly): Resource Id -## ScheduledEventsProfile +## SubResourceWithColocationStatus ### Properties -* **terminateNotificationProfile**: [TerminateNotificationProfile](#terminatenotificationprofile) +* **colocationStatus**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **id**: string: Resource Id ## TerminateNotificationProfile ### Properties * **enable**: bool: Specifies whether the Terminate Scheduled event is enabled or disabled. * **notBeforeTimeout**: 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) -## StorageProfile +## UefiSettings ### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: 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/managed-disks-overview). -* **imageReference**: [ImageReference](#imagereference): 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. -* **osDisk**: [OSDisk](#osdisk): 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/managed-disks-overview). +* **secureBootEnabled**: bool: Specifies whether secure boot should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 +* **vTpmEnabled**: bool: Specifies whether vTPM should be enabled on the virtual machine.

    Minimum api-version: 2020-12-01 -## DataDisk +## UpgradePolicy ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **detachOption**: 'ForceDetach' | string: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.

    detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.

    This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. -* **diskIOPSReadWrite**: int (ReadOnly): Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskMBpsReadWrite**: int (ReadOnly): Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **lun**: int (Required): 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. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **toBeDetached**: bool: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. +* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. +* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. -## VirtualHardDisk +## UserAssignedIdentitiesValue ### Properties -* **uri**: string: Specifies the virtual hard disk's uri. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ImageReference +## VaultCertificate ### Properties -* **communityGalleryImageId**: string: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. -* **exactVersion**: string (ReadOnly): Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. -* **id**: string: Resource Id -* **offer**: string: Specifies the offer of the platform image or marketplace image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sharedGalleryImageId**: string: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. -* **sku**: string: The image SKU. -* **version**: 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. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. +* **certificateStore**: string: 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. +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). -## OSDisk +## VaultSecretGroup ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **deleteOption**: 'Delete' | 'Detach' | string: Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:

    **Delete** If this value is used, the managed disk is deleted when VM gets deleted.

    **Detach** If this value is used, the managed disk is retained after VM gets deleted.

    Minimum api-version: 2021-03-01 -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **encryptionSettings**: [DiskEncryptionSettings](#diskencryptionsettings): Describes a Encryption Settings for a Disk -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [ManagedDiskParameters](#manageddiskparameters): The parameters of a managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **sourceVault**: [SubResource](#subresource) +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[]: The list of key vault references in SourceVault which contain certificates. + +## VirtualHardDisk +### Properties +* **uri**: string: Specifies the virtual hard disk's uri. -## DiffDiskSettings +## VirtualMachineAgentInstanceView ### Properties -* **option**: 'Local' | string: Specifies the ephemeral disk option for operating system disk. -* **placement**: 'CacheDisk' | 'ResourceDisk' | string: Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements +* **extensionHandlers**: [VirtualMachineExtensionHandlerInstanceView](#virtualmachineextensionhandlerinstanceview)[]: The virtual machine extension handler instance view. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgentVersion**: string: The VM Agent full version. ## VirtualMachineExtension ### Properties @@ -990,6 +886,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type +## VirtualMachineExtensionHandlerInstanceView +### Properties +* **status**: [InstanceViewStatus](#instanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## VirtualMachineExtensionInstanceView +### Properties +* **name**: string: The virtual machine extension name. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **substatuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## VirtualMachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1005,157 +915,179 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## ResourceTags +## VirtualMachineHealthStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: [InstanceViewStatus](#instanceviewstatus) (ReadOnly): Instance view status. -## ResourceTags +## VirtualMachineIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of virtual machine identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineIdentityUserAssignedIdentities](#virtualmachineidentityuserassignedidentities): 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}'. -## ResourceTags +## VirtualMachineIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## VirtualMachineRunCommandProperties +## VirtualMachineInstanceView ### Properties -* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. -* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. -* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. -* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. -* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. -* **runAsUser**: string: Specifies the user account on the VM when executing the run command. -* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. -* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **computerName**: string: The computer name assigned to the virtual machine. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The virtual machine disk information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **hyperVGeneration**: 'V1' | 'V2' | string: Specifies the HyperVGeneration Type associated with a resource +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **osName**: string: The Operating System running on the virtual machine. +* **osVersion**: string: The version of Operating System running on the virtual machine. +* **patchStatus**: [VirtualMachinePatchStatus](#virtualmachinepatchstatus): The status of virtual machine patch operations. +* **platformFaultDomain**: int: Specifies the fault domain of the virtual machine. +* **platformUpdateDomain**: int: Specifies the update domain of the virtual machine. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineRunCommandInstanceView +## VirtualMachineIpTag ### Properties -* **endTime**: string: Script end time. -* **error**: string: Script error stream. -* **executionMessage**: string: Communicate script configuration errors or execution messages. -* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. -* **exitCode**: int: Exit code returned from script execution. -* **output**: string: Script output stream. -* **startTime**: string: Script start time. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## RunCommandInputParameter +## VirtualMachineNetworkInterfaceConfiguration ### Properties -* **name**: string (Required): The run command parameter name. -* **value**: string (Required): The run command parameter value. +* **name**: string (Required): The network interface configuration name. +* **properties**: [VirtualMachineNetworkInterfaceConfigurationProperties](#virtualmachinenetworkinterfaceconfigurationproperties): Describes a virtual machine network profile's IP configuration. -## VirtualMachineRunCommandScriptSource +## VirtualMachineNetworkInterfaceConfigurationProperties ### Properties -* **commandId**: string: Specifies a commandId of predefined built-in script. -* **script**: string: Specifies the script content to be executed on the VM. -* **scriptUri**: string: Specifies the script download location. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineNetworkInterfaceDnsSettingsConfiguration](#virtualmachinenetworkinterfacednssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. +* **dscpConfiguration**: [SubResource](#subresource) +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineNetworkInterfaceIPConfiguration](#virtualmachinenetworkinterfaceipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## ResourceTags +## VirtualMachineNetworkInterfaceDnsSettingsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServers**: string[]: List of DNS servers IP addresses -## VirtualMachineScaleSetIdentity +## VirtualMachineNetworkInterfaceIPConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. +* **name**: string (Required): The IP configuration name. +* **properties**: [VirtualMachineNetworkInterfaceIPConfigurationProperties](#virtualmachinenetworkinterfaceipconfigurationproperties): Describes a virtual machine network interface IP configuration properties. -## VirtualMachineScaleSetIdentityUserAssignedIdentities +## VirtualMachineNetworkInterfaceIPConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) +* **applicationGatewayBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. +* **applicationSecurityGroups**: [SubResource](#subresource)[]: Specifies an array of references to application security group. +* **loadBalancerBackendAddressPools**: [SubResource](#subresource)[]: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAddressConfiguration**: [VirtualMachinePublicIPAddressConfiguration](#virtualmachinepublicipaddressconfiguration): Describes a virtual machines IP Configuration's PublicIPAddress configuration +* **subnet**: [SubResource](#subresource) -## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue +## VirtualMachinePatchStatus ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **availablePatchSummary**: [AvailablePatchSummary](#availablepatchsummary): Describes the properties of an virtual machine instance view for available patch summary. +* **configurationStatuses**: [InstanceViewStatus](#instanceviewstatus)[] (ReadOnly): The enablement status of the specified patchMode +* **lastPatchInstallationSummary**: [LastPatchInstallationSummary](#lastpatchinstallationsummary): Describes the properties of the last installed patch summary. -## VirtualMachineScaleSetProperties +## VirtualMachineProperties ### Properties * **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. -* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. -* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS +* **availabilitySet**: [SubResource](#subresource) +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Specifies the hardware settings for the virtual machine. +* **host**: [SubResource](#subresource) * **hostGroup**: [SubResource](#subresource) -* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. -* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. -* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **instanceView**: [VirtualMachineInstanceView](#virtualmachineinstanceview) (ReadOnly): The instance view of a virtual machine. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [NetworkProfile](#networkprofile): Specifies the network interfaces or the networking configuration of the virtual machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. +* **platformFaultDomain**: int: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01 +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. * **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. * **proximityPlacementGroup**: [SubResource](#subresource) -* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. -* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. -* **spotRestorePolicy**: [SpotRestorePolicy](#spotrestorepolicy): Specifies the Spot-Try-Restore properties for the virtual machine scale set.

    With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. -* **timeCreated**: string (ReadOnly): Specifies the time at which the Virtual Machine Scale Set resource was created.

    Minimum api-version: 2021-11-01. -* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. -* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. -* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. -* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. - -## AutomaticRepairsPolicy -### Properties -* **enabled**: bool: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. -* **gracePeriod**: 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 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). -* **repairAction**: 'Reimage' | 'Replace' | 'Restart' | string: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **timeCreated**: string (ReadOnly): Specifies the time at which the Virtual Machine resource was created.

    Minimum api-version: 2021-11-01. +* **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **virtualMachineScaleSet**: [SubResource](#subresource) +* **vmId**: string (ReadOnly): Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. -## ScaleInPolicy +## VirtualMachinePublicIPAddressConfiguration ### Properties -* **forceDeletion**: bool: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) -* **rules**: 'Default' | 'NewestVM' | 'OldestVM' | string[]: 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.

    +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachinePublicIPAddressConfigurationProperties](#virtualmachinepublicipaddressconfigurationproperties): Describes a virtual machines IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. -## SpotRestorePolicy +## VirtualMachinePublicIPAddressConfigurationProperties ### Properties -* **enabled**: bool: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints -* **restoreTimeout**: string: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachinePublicIPAddressDnsSettingsConfiguration](#virtualmachinepublicipaddressdnssettingsconfiguration): Describes a virtual machines network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineIpTag](#virtualmachineiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Specify the public IP allocation type +* **publicIPPrefix**: [SubResource](#subresource) -## UpgradePolicy +## VirtualMachinePublicIPAddressDnsSettingsConfiguration ### Properties -* **automaticOSUpgradePolicy**: [AutomaticOSUpgradePolicy](#automaticosupgradepolicy): The configuration parameters used for performing automatic OS upgrade. -* **mode**: 'Automatic' | 'Manual' | 'Rolling': 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. -* **rollingUpgradePolicy**: [RollingUpgradePolicy](#rollingupgradepolicy): The configuration parameters used while performing a rolling upgrade. +* **domainNameLabel**: string (Required): The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. -## AutomaticOSUpgradePolicy +## VirtualMachineRunCommandInstanceView ### Properties -* **disableAutomaticRollback**: bool: Whether OS image rollback feature should be disabled. Default value is false. -* **enableAutomaticOSUpgrade**: bool: 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. +* **endTime**: string: Script end time. +* **error**: string: Script error stream. +* **executionMessage**: string: Communicate script configuration errors or execution messages. +* **executionState**: 'Canceled' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | string: Script execution status. +* **exitCode**: int: Exit code returned from script execution. +* **output**: string: Script output stream. +* **startTime**: string: Script start time. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -## RollingUpgradePolicy +## VirtualMachineRunCommandProperties ### Properties -* **enableCrossZoneUpgrade**: bool: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. -* **maxBatchInstancePercent**: int: 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%. -* **maxUnhealthyInstancePercent**: int: 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%. -* **maxUnhealthyUpgradedInstancePercent**: int: 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%. -* **pauseTimeBetweenBatches**: 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). -* **prioritizeUnhealthyInstances**: bool: Upgrade all unhealthy instances in a scale set before any healthy instances. +* **asyncExecution**: bool: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. +* **errorBlobUri**: string: Specifies the Azure storage blob where script error stream will be uploaded. +* **instanceView**: [VirtualMachineRunCommandInstanceView](#virtualmachineruncommandinstanceview) (ReadOnly): The instance view of a virtual machine run command. +* **outputBlobUri**: string: Specifies the Azure storage blob where script output stream will be uploaded. +* **parameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **protectedParameters**: [RunCommandInputParameter](#runcommandinputparameter)[]: The parameters used by the script. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **runAsPassword**: string: Specifies the user account password on the VM when executing the run command. +* **runAsUser**: string: Specifies the user account on the VM when executing the run command. +* **source**: [VirtualMachineRunCommandScriptSource](#virtualmachineruncommandscriptsource): Describes the script sources for run command. +* **timeoutInSeconds**: int: The timeout in seconds to execute the run command. -## VirtualMachineScaleSetVMProfile +## VirtualMachineRunCommandScriptSource ### Properties -* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS -* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. -* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. -* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. -* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS -* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. -* **hardwareProfile**: [VirtualMachineScaleSetHardwareProfile](#virtualmachinescalesethardwareprofile): Specifies the hardware settings for the virtual machine scale set. -* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 -* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. -* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. -* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. -* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) -* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. -* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. -* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 +* **commandId**: string: Specifies a commandId of predefined built-in script. +* **script**: string: Specifies the script content to be executed on the VM. +* **scriptUri**: string: Specifies the script download location. -## VirtualMachineScaleSetExtensionProfile +## VirtualMachineScaleSetDataDisk ### Properties -* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. -* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diskIOPSReadWrite**: int: 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. +* **diskMBpsReadWrite**: int: 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. +* **diskSizeGB**: int: 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 +* **lun**: int (Required): 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. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetExtension ### Properties @@ -1164,6 +1096,11 @@ * **properties**: [VirtualMachineScaleSetExtensionProperties](#virtualmachinescalesetextensionproperties): Describes the properties of a Virtual Machine Scale Set Extension. * **type**: string (ReadOnly): Resource type +## VirtualMachineScaleSetExtensionProfile +### Properties +* **extensions**: [VirtualMachineScaleSetExtension](#virtualmachinescalesetextension)[]: The virtual machine scale set child extension resources. +* **extensionsTimeBudget**: string: Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01 + ## VirtualMachineScaleSetExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -1183,32 +1120,22 @@ ### Properties * **vmSizeProperties**: [VMSizeProperties](#vmsizeproperties): Specifies VM Size Property settings on the virtual machine. -## VirtualMachineScaleSetNetworkProfile -### Properties -* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. -* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. - -## VirtualMachineScaleSetNetworkConfiguration +## VirtualMachineScaleSetIdentity ### Properties -* **id**: string: Resource Id -* **name**: string (Required): The network configuration name. -* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. +* **principalId**: string (ReadOnly): The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [VirtualMachineScaleSetIdentityUserAssignedIdentities](#virtualmachinescalesetidentityuserassignedidentities): 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}'. -## VirtualMachineScaleSetNetworkConfigurationProperties +## VirtualMachineScaleSetIdentityUserAssignedIdentities ### Properties -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. -* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. -* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. +### Additional Properties +* **Additional Properties Type**: [VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue](#virtualmachinescalesetidentityuserassignedidentitiesvalue) -## VirtualMachineScaleSetNetworkConfigurationDnsSettings +## VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServers**: string[]: List of DNS servers IP addresses +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## VirtualMachineScaleSetIPConfiguration ### Properties @@ -1227,29 +1154,56 @@ * **publicIPAddressConfiguration**: [VirtualMachineScaleSetPublicIPAddressConfiguration](#virtualmachinescalesetpublicipaddressconfiguration): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration * **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. -## VirtualMachineScaleSetPublicIPAddressConfiguration +## VirtualMachineScaleSetIpTag ### Properties -* **name**: string (Required): The publicIP address configuration name. -* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration -* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. +* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. +* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. -## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +## VirtualMachineScaleSetManagedDiskParameters +### Properties +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **securityProfile**: [VMDiskSecurityProfile](#vmdisksecurityprofile): Specifies the security profile settings for the managed disk.

    NOTE: It can only be set for Confidential VMs +* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types + +## VirtualMachineScaleSetNetworkConfiguration +### Properties +* **id**: string: Resource Id +* **name**: string (Required): The network configuration name. +* **properties**: [VirtualMachineScaleSetNetworkConfigurationProperties](#virtualmachinescalesetnetworkconfigurationproperties): Describes a virtual machine scale set network profile's IP configuration. + +## VirtualMachineScaleSetNetworkConfigurationDnsSettings +### Properties +* **dnsServers**: string[]: List of DNS servers IP addresses + +## VirtualMachineScaleSetNetworkConfigurationProperties ### Properties * **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted -* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPPrefix**: [SubResource](#subresource) +* **dnsSettings**: [VirtualMachineScaleSetNetworkConfigurationDnsSettings](#virtualmachinescalesetnetworkconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableFpga**: bool: Specifies whether the network interface is FPGA networking-enabled. +* **enableIPForwarding**: bool: Whether IP forwarding enabled on this NIC. +* **ipConfigurations**: [VirtualMachineScaleSetIPConfiguration](#virtualmachinescalesetipconfiguration)[] (Required): Specifies the IP configurations of the network interface. +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Specifies the primary network interface in case the virtual machine has more than 1 network interface. -## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +## VirtualMachineScaleSetNetworkProfile ### Properties -* **domainNameLabel**: string (Required): 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 +* **healthProbe**: [ApiEntityReference](#apientityreference): The API entity reference. +* **networkApiVersion**: '2020-11-01' | string: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## VirtualMachineScaleSetIpTag +## VirtualMachineScaleSetOSDisk ### Properties -* **ipTagType**: string: IP tag type. Example: FirstPartyUsage. -* **tag**: string: IP tag associated with the public IP. Example: SQL, Storage etc. +* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** +* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. +* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. +* **diskSizeGB**: int: 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 +* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. +* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. +* **name**: string: The disk name. +* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. +* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. +* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. ## VirtualMachineScaleSetOSProfile ### Properties @@ -1262,47 +1216,87 @@ * **secrets**: [VaultSecretGroup](#vaultsecretgroup)[]: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). * **windowsConfiguration**: [WindowsConfiguration](#windowsconfiguration): Specifies Windows operating system settings on the virtual machine. +## VirtualMachineScaleSetProperties +### Properties +* **additionalCapabilities**: [AdditionalCapabilities](#additionalcapabilities): Enables or disables a capability on the virtual machine or virtual machine scale set. +* **automaticRepairsPolicy**: [AutomaticRepairsPolicy](#automaticrepairspolicy): Specifies the configuration parameters for automatic repairs on the virtual machine scale set. +* **doNotRunExtensionsOnOverprovisionedVMs**: bool: 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. +* **hostGroup**: [SubResource](#subresource) +* **orchestrationMode**: 'Flexible' | 'Uniform' | string: Specifies the orchestration mode for the virtual machine scale set. +* **overprovision**: bool: Specifies whether the Virtual Machine Scale Set should be overprovisioned. +* **platformFaultDomainCount**: int: Fault Domain count for each placement group. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **proximityPlacementGroup**: [SubResource](#subresource) +* **scaleInPolicy**: [ScaleInPolicy](#scaleinpolicy): Describes a scale-in policy for a virtual machine scale set. +* **singlePlacementGroup**: bool: When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. +* **spotRestorePolicy**: [SpotRestorePolicy](#spotrestorepolicy): Specifies the Spot-Try-Restore properties for the virtual machine scale set.

    With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. +* **timeCreated**: string (ReadOnly): Specifies the time at which the Virtual Machine Scale Set resource was created.

    Minimum api-version: 2021-11-01. +* **uniqueId**: string (ReadOnly): Specifies the ID which uniquely identifies a Virtual Machine Scale Set. +* **upgradePolicy**: [UpgradePolicy](#upgradepolicy): Describes an upgrade policy - automatic, manual, or rolling. +* **virtualMachineProfile**: [VirtualMachineScaleSetVMProfile](#virtualmachinescalesetvmprofile): Describes a virtual machine scale set virtual machine profile. +* **zoneBalance**: bool: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. + +## VirtualMachineScaleSetPublicIPAddressConfiguration +### Properties +* **name**: string (Required): The publicIP address configuration name. +* **properties**: [VirtualMachineScaleSetPublicIPAddressConfigurationProperties](#virtualmachinescalesetpublicipaddressconfigurationproperties): Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration +* **sku**: [PublicIPAddressSku](#publicipaddresssku): Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. + +## VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings +### Properties +* **domainNameLabel**: string (Required): 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 + +## VirtualMachineScaleSetPublicIPAddressConfigurationProperties +### Properties +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the network interface when the VM is deleted +* **dnsSettings**: [VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings](#virtualmachinescalesetpublicipaddressconfigurationdnssettings): Describes a virtual machines scale sets network configuration's DNS settings. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipTags**: [VirtualMachineScaleSetIpTag](#virtualmachinescalesetiptag)[]: The list of IP tags associated with the public IP address. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPPrefix**: [SubResource](#subresource) + ## VirtualMachineScaleSetStorageProfile ### Properties * **dataDisks**: [VirtualMachineScaleSetDataDisk](#virtualmachinescalesetdatadisk)[]: 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/managed-disks-overview). * **imageReference**: [ImageReference](#imagereference): 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. * **osDisk**: [VirtualMachineScaleSetOSDisk](#virtualmachinescalesetosdisk): Describes a virtual machine scale set operating system disk. -## VirtualMachineScaleSetDataDisk -### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diskIOPSReadWrite**: int: 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. -* **diskMBpsReadWrite**: int: 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. -* **diskSizeGB**: int: 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 -* **lun**: int (Required): 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. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. - -## VirtualMachineScaleSetManagedDiskParameters +## VirtualMachineScaleSetVMInstanceView ### Properties -* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. -* **securityProfile**: [VMDiskSecurityProfile](#vmdisksecurityprofile): Specifies the security profile settings for the managed disk.

    NOTE: It can only be set for Confidential VMs -* **storageAccountType**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | 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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types +* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. +* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. +* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. +* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. +* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. +* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. +* **platformFaultDomain**: int: The Fault Domain count. +* **platformUpdateDomain**: int: The Update Domain count. +* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. +* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. +* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. +* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. -## VirtualMachineScaleSetOSDisk +## VirtualMachineScaleSetVMNetworkProfileConfiguration ### Properties -* **caching**: 'None' | 'ReadOnly' | 'ReadWrite': Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage** -* **createOption**: 'Attach' | 'Empty' | 'FromImage' | string (Required): 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. -* **diffDiskSettings**: [DiffDiskSettings](#diffdisksettings): 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. -* **diskSizeGB**: int: 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 -* **image**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. -* **managedDisk**: [VirtualMachineScaleSetManagedDiskParameters](#virtualmachinescalesetmanageddiskparameters): Describes the parameters of a ScaleSet managed disk. -* **name**: string: The disk name. -* **osType**: 'Linux' | 'Windows': The operating system of the osDiskImage. -* **vhdContainers**: string[]: Specifies the container urls that are used to store operating system disks for the scale set. -* **writeAcceleratorEnabled**: bool: Specifies whether writeAccelerator should be enabled or disabled on the disk. +* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. -## ResourceTags +## VirtualMachineScaleSetVMProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationProfile**: [ApplicationProfile](#applicationprofile): Contains the list of gallery applications that should be made available to the VM/VMSS +* **billingProfile**: [BillingProfile](#billingprofile): Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01. +* **capacityReservation**: [CapacityReservationProfile](#capacityreservationprofile): The parameters of a capacity reservation Profile. +* **diagnosticsProfile**: [DiagnosticsProfile](#diagnosticsprofile): Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15. +* **evictionPolicy**: 'Deallocate' | 'Delete' | string: Specifies the eviction policy for the Azure Spot VM/VMSS +* **extensionProfile**: [VirtualMachineScaleSetExtensionProfile](#virtualmachinescalesetextensionprofile): Describes a virtual machine scale set extension profile. +* **hardwareProfile**: [VirtualMachineScaleSetHardwareProfile](#virtualmachinescalesethardwareprofile): Specifies the hardware settings for the virtual machine scale set. +* **licenseType**: string: Specifies that the image or disk that is being used was licensed on-premises.

    Possible values for Windows Server operating system are:

    Windows_Client

    Windows_Server

    Possible values for Linux Server operating system are:

    RHEL_BYOS (for RHEL)

    SLES_BYOS (for SUSE)

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15 +* **networkProfile**: [VirtualMachineScaleSetNetworkProfile](#virtualmachinescalesetnetworkprofile): Describes a virtual machine scale set network profile. +* **osProfile**: [VirtualMachineScaleSetOSProfile](#virtualmachinescalesetosprofile): Describes a virtual machine scale set OS profile. +* **priority**: 'Low' | 'Regular' | 'Spot' | string: Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS. +* **scheduledEventsProfile**: [ScheduledEventsProfile](#scheduledeventsprofile) +* **securityProfile**: [SecurityProfile](#securityprofile): Specifies the Security profile settings for the virtual machine or virtual machine scale set. +* **storageProfile**: [VirtualMachineScaleSetStorageProfile](#virtualmachinescalesetstorageprofile): Describes a virtual machine scale set storage profile. +* **userData**: string: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 ## VirtualMachineScaleSetVMProperties ### Properties @@ -1324,37 +1318,43 @@ * **userData**: string: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01 * **vmId**: string (ReadOnly): Azure VM unique ID. -## VirtualMachineScaleSetVMInstanceView +## VirtualMachineScaleSetVMProtectionPolicy ### Properties -* **assignedHost**: string (ReadOnly): Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01. -* **bootDiagnostics**: [BootDiagnosticsInstanceView](#bootdiagnosticsinstanceview): The instance view of a virtual machine boot diagnostics. -* **disks**: [DiskInstanceView](#diskinstanceview)[]: The disks information. -* **extensions**: [VirtualMachineExtensionInstanceView](#virtualmachineextensioninstanceview)[]: The extensions information. -* **maintenanceRedeployStatus**: [MaintenanceRedeployStatus](#maintenanceredeploystatus): Maintenance Operation Status. -* **placementGroupId**: string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. -* **platformFaultDomain**: int: The Fault Domain count. -* **platformUpdateDomain**: int: The Update Domain count. -* **rdpThumbPrint**: string: The Remote desktop certificate thumbprint. -* **statuses**: [InstanceViewStatus](#instanceviewstatus)[]: The resource status information. -* **vmAgent**: [VirtualMachineAgentInstanceView](#virtualmachineagentinstanceview): The instance view of the VM Agent running on the virtual machine. -* **vmHealth**: [VirtualMachineHealthStatus](#virtualmachinehealthstatus) (ReadOnly): The health status of the VM. +* **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. +* **protectFromScaleSetActions**: bool: 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. -## VirtualMachineScaleSetVMNetworkProfileConfiguration +## VMDiskSecurityProfile ### Properties -* **networkInterfaceConfigurations**: [VirtualMachineScaleSetNetworkConfiguration](#virtualmachinescalesetnetworkconfiguration)[]: The list of network configurations. +* **diskEncryptionSet**: [DiskEncryptionSetParameters](#diskencryptionsetparameters): 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. +* **securityEncryptionType**: 'DiskWithVMGuestState' | 'VMGuestStateOnly' | string: Specifies the EncryptionType of the managed disk.
    It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob.

    NOTE: It can be set for only Confidential VMs. -## VirtualMachineScaleSetVMProtectionPolicy +## VMGalleryApplication ### Properties -* **protectFromScaleIn**: bool: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. -* **protectFromScaleSetActions**: bool: 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. +* **configurationReference**: string: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided +* **order**: int: Optional, Specifies the order in which the packages have to be installed +* **packageReferenceId**: string (Required): Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} +* **tags**: string: Optional, Specifies a passthrough value for more generic context. -## ResourceTags +## VMSizeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **vCPUsAvailable**: int: Specifies the number of vCPUs available for the VM.

    When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) . +* **vCPUsPerCore**: int: Specifies the vCPU to physical core ratio.

    When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)

    Setting this property to 1 also means that hyper-threading is disabled. -## ResourceTags +## WindowsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalUnattendContent**: [AdditionalUnattendContent](#additionalunattendcontent)[]: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. +* **enableAutomaticUpdates**: bool: 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. +* **patchSettings**: [PatchSettings](#patchsettings): Specifies settings related to VM Guest Patching on Windows. +* **provisionVMAgent**: bool: 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. +* **timeZone**: string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). +* **winRM**: [WinRMConfiguration](#winrmconfiguration): Describes Windows Remote Management configuration of the VM + +## WinRMConfiguration +### Properties +* **listeners**: [WinRMListener](#winrmlistener)[]: The list of Windows Remote Management listeners + +## WinRMListener +### Properties +* **certificateUrl**: 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":""
    }
    To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). +* **protocol**: 'Http' | 'Https': Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https** diff --git a/generated/compute/microsoft.compute/2021-12-01/types.md b/generated/compute/microsoft.compute/2021-12-01/types.md index a1000238ac..6a3b11da6e 100644 --- a/generated/compute/microsoft.compute/2021-12-01/types.md +++ b/generated/compute/microsoft.compute/2021-12-01/types.md @@ -63,70 +63,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Compute/snapshots' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## DiskAccessProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. -* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. -* **timeCreated**: string (ReadOnly): The time when the disk access was created. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): private endpoint connection Id -* **name**: string (ReadOnly): private endpoint connection name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): private endpoint connection type - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionSetIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. - -## EncryptionSetProperties -### Properties -* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots -* **autoKeyRotationError**: [ApiError](#apierror) (ReadOnly): Api error. -* **encryptionType**: 'ConfidentialVmEncryptedWithCustomerKey' | 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. -* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. -* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. -* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. -* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. - -## KeyForDiskEncryptionSet -### Properties -* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. -* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} - -## SourceVault -### Properties -* **id**: string: Resource Id - ## ApiError ### Properties * **code**: string: The error code. @@ -141,15 +77,24 @@ * **message**: string: The error message. * **target**: string: The target of the particular error. -## InnerError +## CreationData ### Properties -* **errordetail**: string: The internal error message or exception dump. -* **exceptiontype**: string: The exception type. +* **createOption**: 'Attach' | 'Copy' | 'CopyStart' | 'Empty' | 'FromImage' | 'Import' | 'ImportSecure' | 'Restore' | 'Upload' | 'UploadPreparedSecure' | string (Required): This enumerates the possible sources of a disk's creation. +* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. +* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. +* **securityDataUri**: string: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. +* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. +* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. +* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. +* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. +* **uploadSizeBytes**: int: 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). -## ResourceTags +## DiskAccessProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported. +* **provisioningState**: string (ReadOnly): The disk access resource provisioning state. +* **timeCreated**: string (ReadOnly): The time when the disk access was created. ## DiskProperties ### Properties @@ -183,29 +128,37 @@ * **timeCreated**: string (ReadOnly): The time when the disk was created. * **uniqueId**: string (ReadOnly): Unique Guid identifying the resource. -## CreationData +## DiskSecurityProfile ### Properties -* **createOption**: 'Attach' | 'Copy' | 'CopyStart' | 'Empty' | 'FromImage' | 'Import' | 'ImportSecure' | 'Restore' | 'Upload' | 'UploadPreparedSecure' | string (Required): This enumerates the possible sources of a disk's creation. -* **galleryImageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **imageReference**: [ImageDiskReference](#imagediskreference): The source image used for creating the disk. -* **logicalSectorSize**: int: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. -* **securityDataUri**: string: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. -* **sourceResourceId**: string: If createOption is Copy, this is the ARM id of the source snapshot or disk. -* **sourceUniqueId**: string (ReadOnly): If this field is set, this is the unique id identifying the source of this resource. -* **sourceUri**: string: If createOption is Import, this is the URI of a blob to be imported into a managed disk. -* **storageAccountId**: string: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. -* **uploadSizeBytes**: int: 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). +* **secureVMDiskEncryptionSetId**: string: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key +* **securityType**: 'ConfidentialVM_DiskEncryptedWithCustomerKey' | 'ConfidentialVM_DiskEncryptedWithPlatformKey' | 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' | 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. -## ImageDiskReference +## DiskSku ### Properties -* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. -* **lun**: int: 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. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. +* **tier**: string (ReadOnly): The sku tier. ## Encryption ### Properties * **diskEncryptionSetId**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. * **type**: 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | 'EncryptionAtRestWithPlatformKey' | string: The type of key used to encrypt the data of the disk. +## EncryptionSetIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. + +## EncryptionSetProperties +### Properties +* **activeKey**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset): Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots +* **autoKeyRotationError**: [ApiError](#apierror) (ReadOnly): Api error. +* **encryptionType**: 'ConfidentialVmEncryptedWithCustomerKey' | 'EncryptionAtRestWithCustomerKey' | 'EncryptionAtRestWithPlatformAndCustomerKeys' | string: The type of key used to encrypt the data of the disk. +* **lastKeyRotationTimestamp**: string (ReadOnly): The time when the active key of this disk encryption set was updated. +* **previousKeys**: [KeyForDiskEncryptionSet](#keyfordiskencryptionset)[] (ReadOnly): A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. +* **provisioningState**: string (ReadOnly): The disk encryption set provisioning state. +* **rotationToLatestKeyVersionEnabled**: bool: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. + ## EncryptionSettingsCollection ### Properties * **enabled**: bool (Required): 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. @@ -217,16 +170,59 @@ * **diskEncryptionKey**: [KeyVaultAndSecretReference](#keyvaultandsecretreference): Key Vault Secret Url and vault id of the encryption key * **keyEncryptionKey**: [KeyVaultAndKeyReference](#keyvaultandkeyreference): Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey -## KeyVaultAndSecretReference +## ExtendedLocation ### Properties -* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault -* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. + +## ImageDiskReference +### Properties +* **id**: string (Required): A relative uri containing either a Platform Image Repository or user image reference. +* **lun**: int: 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. + +## InnerError +### Properties +* **errordetail**: string: The internal error message or exception dump. +* **exceptiontype**: string: The exception type. + +## KeyForDiskEncryptionSet +### Properties +* **keyUrl**: string (Required): Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. +* **sourceVault**: [SourceVault](#sourcevault): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} ## KeyVaultAndKeyReference ### Properties * **keyUrl**: string (Required): Url pointing to a key or secret in KeyVault * **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} +## KeyVaultAndSecretReference +### Properties +* **secretUrl**: string (Required): Url pointing to a key or secret in KeyVault +* **sourceVault**: [SourceVault](#sourcevault) (Required): The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): private endpoint connection Id +* **name**: string (ReadOnly): private endpoint connection name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): private endpoint connection type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + ## PropertyUpdatesInProgress ### Properties * **targetTier**: string: The target performance tier of the disk if a tier change operation is in progress. @@ -238,30 +234,30 @@ * **promotionCode**: string: The Offer Promotion Code. * **publisher**: string (Required): The publisher ID. -## DiskSecurityProfile -### Properties -* **secureVMDiskEncryptionSetId**: string: ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key -* **securityType**: 'ConfidentialVM_DiskEncryptedWithCustomerKey' | 'ConfidentialVM_DiskEncryptedWithPlatformKey' | 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' | 'TrustedLaunch' | string: Specifies the SecurityType of the VM. Applicable for OS disks only. - -## ShareInfoElement +## ResourceTags ### Properties -* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. +### Additional Properties +* **Additional Properties Type**: string -## SupportedCapabilities +## ResourceTags ### Properties -* **acceleratedNetwork**: bool: True if the image from which the OS disk is created supports accelerated networking. -* **architecture**: 'Arm64' | 'x64' | string: CPU architecture supported by an OS disk. +### Additional Properties +* **Additional Properties Type**: string -## DiskSku +## ResourceTags ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'StandardSSD_LRS' | 'StandardSSD_ZRS' | 'Standard_LRS' | 'UltraSSD_LRS' | string: The sku name. -* **tier**: string (ReadOnly): The sku tier. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ShareInfoElement +### Properties +* **vmUri**: string (ReadOnly): A relative URI containing the ID of the VM that has the disk attached. + ## SnapshotProperties ### Properties * **completionPercent**: int: Percentage complete for the background copy when a resource is created via the CopyStart operation. @@ -291,8 +287,12 @@ * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: string (ReadOnly): The sku tier. -## ResourceTags +## SourceVault ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id + +## SupportedCapabilities +### Properties +* **acceleratedNetwork**: bool: True if the image from which the OS disk is created supports accelerated networking. +* **architecture**: 'Arm64' | 'x64' | string: CPU architecture supported by an OS disk. diff --git a/generated/compute/microsoft.containerservice/2015-11-01-preview/types.md b/generated/compute/microsoft.containerservice/2015-11-01-preview/types.md index 1a1b40e016..1bfafa2cf3 100644 --- a/generated/compute/microsoft.containerservice/2015-11-01-preview/types.md +++ b/generated/compute/microsoft.containerservice/2015-11-01-preview/types.md @@ -11,16 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of agent pools -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VM -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for container service master -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for Orchestrator -* **provisioningState**: string (ReadOnly): Gets the provisioning state, which only appears in the response. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows jumpbox - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int: No. of agents (VMs) that will host docker containers @@ -33,24 +23,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics): Describes VM Diagnostics. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool: Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. -* **storageUri**: string (ReadOnly): Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for all Linux VMs * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux based VMs running on Azure -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[]: Gets or sets the list of SSH public keys used to authenticate with Linux based VMs - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container cluster @@ -61,6 +38,29 @@ ### Properties * **orchestratorType**: 'DCOS' | 'Mesos' | 'SwarmPreview': Specifies what orchestrator will be used to manage container cluster resources. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of agent pools +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VM +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for container service master +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for Orchestrator +* **provisioningState**: string (ReadOnly): Gets the provisioning state, which only appears in the response. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows jumpbox + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[]: Gets or sets the list of SSH public keys used to authenticate with Linux based VMs + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool: Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. +* **storageUri**: string (ReadOnly): Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows jumpbox diff --git a/generated/compute/microsoft.containerservice/2016-03-30/types.md b/generated/compute/microsoft.containerservice/2016-03-30/types.md index 8881106e69..05c04bdea3 100644 --- a/generated/compute/microsoft.containerservice/2016-03-30/types.md +++ b/generated/compute/microsoft.containerservice/2016-03-30/types.md @@ -11,16 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int: 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. @@ -33,24 +23,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for all Linux VMs * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -61,6 +38,29 @@ ### Properties * **orchestratorType**: 'DCOS' | 'Swarm' (Required): The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs diff --git a/generated/compute/microsoft.containerservice/2016-09-30/types.md b/generated/compute/microsoft.containerservice/2016-09-30/types.md index 0121d0e2da..9c8441511f 100644 --- a/generated/compute/microsoft.containerservice/2016-09-30/types.md +++ b/generated/compute/microsoft.containerservice/2016-09-30/types.md @@ -11,18 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. -* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int (Required): 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. @@ -39,24 +27,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for Linux VMs. * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -72,6 +47,31 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string (Required): The secret password associated with the service principal. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. +* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs. diff --git a/generated/compute/microsoft.containerservice/2017-01-31/types.md b/generated/compute/microsoft.containerservice/2017-01-31/types.md index 3dbb52bd14..a475bcced9 100644 --- a/generated/compute/microsoft.containerservice/2017-01-31/types.md +++ b/generated/compute/microsoft.containerservice/2017-01-31/types.md @@ -11,18 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. -* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int (Required): 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. @@ -39,24 +27,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for Linux VMs. * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -72,6 +47,31 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string (Required): The secret password associated with the service principal. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. +* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs. diff --git a/generated/confidentialledger/log.out b/generated/confidentialledger/log.out index 8fd18b1fee..ceec81751e 100644 --- a/generated/confidentialledger/log.out +++ b/generated/confidentialledger/log.out @@ -3,17 +3,17 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.confidentialledger-2020-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.confidentialledger-2021-05-13-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms -info | Autorest completed in 6.04s. 4 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 5.78s. 4 files generated. diff --git a/generated/confidentialledger/microsoft.confidentialledger/2020-12-01-preview/types.md b/generated/confidentialledger/microsoft.confidentialledger/2020-12-01-preview/types.md index 32a34c2507..f25771d01a 100644 --- a/generated/confidentialledger/microsoft.confidentialledger/2020-12-01-preview/types.md +++ b/generated/confidentialledger/microsoft.confidentialledger/2020-12-01-preview/types.md @@ -12,6 +12,17 @@ * **tags**: [Tags](#tags): Additional tags for Confidential Ledger * **type**: 'Microsoft.ConfidentialLedger/ledgers' (ReadOnly, DeployTimeConstant): The resource type +## AADBasedSecurityPrincipal +### Properties +* **ledgerRoleName**: 'Administrator' | 'Contributor' | 'Reader' | string: LedgerRole associated with the Security Principal of Ledger +* **principalId**: string: UUID/GUID based Principal Id of the Security Principal +* **tenantId**: string: UUID/GUID based Tenant Id of the Security Principal + +## CertBasedSecurityPrincipal +### Properties +* **cert**: string: Public key of the user cert (.pem or .cer) +* **ledgerRoleName**: 'Administrator' | 'Contributor' | 'Reader' | string: LedgerRole associated with the Security Principal of Ledger + ## LedgerProperties ### Properties * **aadBasedSecurityPrincipals**: [AADBasedSecurityPrincipal](#aadbasedsecurityprincipal)[]: Array of all AAD based Security Principals. @@ -24,17 +35,6 @@ * **ledgerUri**: string (ReadOnly): Endpoint for calling Ledger Service. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Object representing ProvisioningState for Confidential Ledger. -## AADBasedSecurityPrincipal -### Properties -* **ledgerRoleName**: 'Administrator' | 'Contributor' | 'Reader' | string: LedgerRole associated with the Security Principal of Ledger -* **principalId**: string: UUID/GUID based Principal Id of the Security Principal -* **tenantId**: string: UUID/GUID based Tenant Id of the Security Principal - -## CertBasedSecurityPrincipal -### Properties -* **cert**: string: Public key of the user cert (.pem or .cer) -* **ledgerRoleName**: 'Administrator' | 'Contributor' | 'Reader' | string: LedgerRole associated with the Security Principal of Ledger - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/confidentialledger/microsoft.confidentialledger/2021-05-13-preview/types.md b/generated/confidentialledger/microsoft.confidentialledger/2021-05-13-preview/types.md index 044b3372c9..45e8a19840 100644 --- a/generated/confidentialledger/microsoft.confidentialledger/2021-05-13-preview/types.md +++ b/generated/confidentialledger/microsoft.confidentialledger/2021-05-13-preview/types.md @@ -12,17 +12,6 @@ * **tags**: [Tags](#tags): Additional tags for Confidential Ledger * **type**: 'Microsoft.ConfidentialLedger/ledgers' (ReadOnly, DeployTimeConstant): The resource type -## LedgerProperties -### Properties -* **aadBasedSecurityPrincipals**: [AADBasedSecurityPrincipal](#aadbasedsecurityprincipal)[]: Array of all AAD based Security Principals. -* **certBasedSecurityPrincipals**: [CertBasedSecurityPrincipal](#certbasedsecurityprincipal)[]: Array of all cert based Security Principals. -* **identityServiceUri**: string (ReadOnly): Endpoint for accessing network identity. -* **ledgerInternalNamespace**: string (ReadOnly): Internal namespace for the Ledger -* **ledgerName**: string (ReadOnly): Unique name for the Confidential Ledger. -* **ledgerType**: 'Private' | 'Public' | 'Unknown' | string: Type of the ledger. Private means transaction data is encrypted. -* **ledgerUri**: string (ReadOnly): Endpoint for calling Ledger Service. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Object representing ProvisioningState for Confidential Ledger. - ## AADBasedSecurityPrincipal ### Properties * **ledgerRoleName**: 'Administrator' | 'Contributor' | 'Reader' | string: LedgerRole associated with the Security Principal of Ledger @@ -34,6 +23,17 @@ * **cert**: string: Public key of the user cert (.pem or .cer) * **ledgerRoleName**: 'Administrator' | 'Contributor' | 'Reader' | string: LedgerRole associated with the Security Principal of Ledger +## LedgerProperties +### Properties +* **aadBasedSecurityPrincipals**: [AADBasedSecurityPrincipal](#aadbasedsecurityprincipal)[]: Array of all AAD based Security Principals. +* **certBasedSecurityPrincipals**: [CertBasedSecurityPrincipal](#certbasedsecurityprincipal)[]: Array of all cert based Security Principals. +* **identityServiceUri**: string (ReadOnly): Endpoint for accessing network identity. +* **ledgerInternalNamespace**: string (ReadOnly): Internal namespace for the Ledger +* **ledgerName**: string (ReadOnly): Unique name for the Confidential Ledger. +* **ledgerType**: 'Private' | 'Public' | 'Unknown' | string: Type of the ledger. Private means transaction data is encrypted. +* **ledgerUri**: string (ReadOnly): Endpoint for calling Ledger Service. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Object representing ProvisioningState for Confidential Ledger. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/confluent/log.out b/generated/confluent/log.out index ff302d07d2..d217bbe133 100644 --- a/generated/confluent/log.out +++ b/generated/confluent/log.out @@ -3,22 +3,22 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.confluent-2021-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.confluent-2021-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.confluent-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrganizationResourceProperties-offerDetail' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/confluent/resource-manager/Microsoft.Confluent/stable/2020-03-01/confluent.json:782:9 @@ -31,7 +31,7 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'OrganizationRes info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.confluent-2020-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrganizationResourceProperties-offerDetail' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json:774:9 @@ -41,11 +41,11 @@ warning | PreCheck/SchemaMissingType | The schema 'OrganizationResource-properti - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json:812:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'OrganizationResourceProperties' -> 'OrganizationResourcePropertiesAutoGenerated' -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.confluent-2021-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms -info | Autorest completed in 10.51s. 10 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 10.22s. 10 files generated. diff --git a/generated/confluent/microsoft.confluent/2021-03-01-preview/types.md b/generated/confluent/microsoft.confluent/2021-03-01-preview/types.md index b09d78e0e1..9899b616d5 100644 --- a/generated/confluent/microsoft.confluent/2021-03-01-preview/types.md +++ b/generated/confluent/microsoft.confluent/2021-03-01-preview/types.md @@ -33,14 +33,14 @@ * **retrieveDatetime**: string: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. * **signature**: string: Terms signature. -## SystemData +## OfferDetail ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string (Required): Offer Id +* **planId**: string (Required): Offer Plan Id +* **planName**: string (Required): Offer Plan Name +* **publisherId**: string (Required): Publisher Id +* **status**: 'Failed' | 'InProgress' | 'PendingFulfillmentStart' | 'Reinstated' | 'Started' | 'Subscribed' | 'Succeeded' | 'Suspended' | 'Unsubscribed' | 'Updating' | string (ReadOnly): SaaS Offer Status for confluent RP +* **termUnit**: string (Required): Offer Plan Term unit ## OrganizationResourceProperties ### Properties @@ -51,14 +51,19 @@ * **ssoUrl**: string (ReadOnly): SSO url for the Confluent organization. * **userDetail**: [UserDetail](#userdetail) (Required): Subscriber detail -## OfferDetail +## OrganizationResourceTags ### Properties -* **id**: string (Required): Offer Id -* **planId**: string (Required): Offer Plan Id -* **planName**: string (Required): Offer Plan Name -* **publisherId**: string (Required): Publisher Id -* **status**: 'Failed' | 'InProgress' | 'PendingFulfillmentStart' | 'Reinstated' | 'Started' | 'Subscribed' | 'Succeeded' | 'Suspended' | 'Unsubscribed' | 'Updating' | string (ReadOnly): SaaS Offer Status for confluent RP -* **termUnit**: string (Required): Offer Plan Term unit +### Additional Properties +* **Additional Properties Type**: string + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## UserDetail ### Properties @@ -66,8 +71,3 @@ * **firstName**: string: First name * **lastName**: string: Last name -## OrganizationResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/confluent/microsoft.confluent/2021-09-01-preview/types.md b/generated/confluent/microsoft.confluent/2021-09-01-preview/types.md index 3ad83d56e9..5bdd77e5c7 100644 --- a/generated/confluent/microsoft.confluent/2021-09-01-preview/types.md +++ b/generated/confluent/microsoft.confluent/2021-09-01-preview/types.md @@ -33,14 +33,14 @@ * **retrieveDatetime**: string: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. * **signature**: string: Terms signature. -## SystemData +## OfferDetail ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string (Required): Offer Id +* **planId**: string (Required): Offer Plan Id +* **planName**: string (Required): Offer Plan Name +* **publisherId**: string (Required): Publisher Id +* **status**: 'Failed' | 'InProgress' | 'PendingFulfillmentStart' | 'Reinstated' | 'Started' | 'Subscribed' | 'Succeeded' | 'Suspended' | 'Unsubscribed' | 'Updating' | string (ReadOnly): SaaS Offer Status for confluent RP +* **termUnit**: string (Required): Offer Plan Term unit ## OrganizationResourceProperties ### Properties @@ -51,14 +51,19 @@ * **ssoUrl**: string (ReadOnly): SSO url for the Confluent organization. * **userDetail**: [UserDetail](#userdetail) (Required): Subscriber detail -## OfferDetail +## OrganizationResourceTags ### Properties -* **id**: string (Required): Offer Id -* **planId**: string (Required): Offer Plan Id -* **planName**: string (Required): Offer Plan Name -* **publisherId**: string (Required): Publisher Id -* **status**: 'Failed' | 'InProgress' | 'PendingFulfillmentStart' | 'Reinstated' | 'Started' | 'Subscribed' | 'Succeeded' | 'Suspended' | 'Unsubscribed' | 'Updating' | string (ReadOnly): SaaS Offer Status for confluent RP -* **termUnit**: string (Required): Offer Plan Term unit +### Additional Properties +* **Additional Properties Type**: string + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## UserDetail ### Properties @@ -66,8 +71,3 @@ * **firstName**: string: First name * **lastName**: string: Last name -## OrganizationResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/confluent/microsoft.confluent/2021-12-01/types.md b/generated/confluent/microsoft.confluent/2021-12-01/types.md index bf753feebc..c8ef810304 100644 --- a/generated/confluent/microsoft.confluent/2021-12-01/types.md +++ b/generated/confluent/microsoft.confluent/2021-12-01/types.md @@ -33,14 +33,14 @@ * **retrieveDatetime**: string: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. * **signature**: string: Terms signature. -## SystemData +## OfferDetail ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string (Required): Offer Id +* **planId**: string (Required): Offer Plan Id +* **planName**: string (Required): Offer Plan Name +* **publisherId**: string (Required): Publisher Id +* **status**: 'Failed' | 'InProgress' | 'PendingFulfillmentStart' | 'Reinstated' | 'Started' | 'Subscribed' | 'Succeeded' | 'Suspended' | 'Unsubscribed' | 'Updating' | string (ReadOnly): SaaS Offer Status for confluent RP +* **termUnit**: string (Required): Offer Plan Term unit ## OrganizationResourceProperties ### Properties @@ -51,14 +51,19 @@ * **ssoUrl**: string (ReadOnly): SSO url for the Confluent organization. * **userDetail**: [UserDetail](#userdetail) (Required): Subscriber detail -## OfferDetail +## OrganizationResourceTags ### Properties -* **id**: string (Required): Offer Id -* **planId**: string (Required): Offer Plan Id -* **planName**: string (Required): Offer Plan Name -* **publisherId**: string (Required): Publisher Id -* **status**: 'Failed' | 'InProgress' | 'PendingFulfillmentStart' | 'Reinstated' | 'Started' | 'Subscribed' | 'Succeeded' | 'Suspended' | 'Unsubscribed' | 'Updating' | string (ReadOnly): SaaS Offer Status for confluent RP -* **termUnit**: string (Required): Offer Plan Term unit +### Additional Properties +* **Additional Properties Type**: string + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## UserDetail ### Properties @@ -66,8 +71,3 @@ * **firstName**: string: First name * **lastName**: string: Last name -## OrganizationResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/connectedvmware/log.out b/generated/connectedvmware/log.out index dcecf47c87..aec1fd4154 100644 --- a/generated/connectedvmware/log.out +++ b/generated/connectedvmware/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.connectedvmwarevsphere-2020-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MachineExtensionProperties-instanceView' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2020-10-01-preview/connectedvmware.json:6443:9 @@ -14,4 +14,4 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 22ms -info | Autorest completed in 7.77s. 2 files generated. +info | Autorest completed in 7.65s. 2 files generated. diff --git a/generated/connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.md b/generated/connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.md index 230f06dd10..50224041e9 100644 --- a/generated/connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.md +++ b/generated/connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.md @@ -156,11 +156,6 @@ * **tags**: [VirtualNetworkTags](#virtualnetworktags): Gets or sets the Resource tags. * **type**: 'Microsoft.ConnectedVMwarevSphere/virtualNetworks' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation -### Properties -* **name**: string: The extended location name. -* **type**: string: The extended location type. - ## ClusterProperties ### Properties * **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. @@ -174,24 +169,6 @@ * **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. * **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this cluster resides. -## ResourceStatus -### Properties -* **lastUpdatedAt**: string (ReadOnly): The last update time for this condition. -* **message**: string (ReadOnly): A human readable message indicating details about the status. -* **reason**: string (ReadOnly): The reason for the condition's status. -* **severity**: string (ReadOnly): Severity with which to treat failures of this type of condition. -* **status**: string (ReadOnly): Status of the condition. -* **type**: string (ReadOnly): The type of the condition. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## ClusterTags ### Properties ### Additional Properties @@ -213,72 +190,88 @@ ### Additional Properties * **Additional Properties Type**: string -## HostProperties +## ErrorDetail +### Properties +* **code**: string (Required): The error's code. +* **details**: [ErrorDetail](#errordetail)[]: Additional error details. +* **message**: string (Required): A human readable error message. +* **target**: string: Indicates which property in the request is responsible for the error. + +## ExtendedLocation +### Properties +* **name**: string: The extended location name. +* **type**: string: The extended location type. + +## GuestAgentProfile +### Properties +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmUuid**: string (ReadOnly): Specifies the VM's unique SMBIOS ID. + +## GuestAgentProperties ### Properties +* **credentials**: [GuestCredential](#guestcredential): Username / Password Credentials to connect to guest. * **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. -* **inventoryItemId**: string: Gets or sets the inventory Item ID for the host. -* **moName**: string (ReadOnly): Gets or sets the vCenter Managed Object name for the host. -* **moRefId**: string: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host. +* **httpProxyConfig**: [HttpProxyConfiguration](#httpproxyconfiguration): HTTP Proxy configuration for the VM. +* **provisioningAction**: 'install' | 'repair' | 'uninstall' | string: Defines the different types of operations for guest agent. * **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. +* **status**: string (ReadOnly): Gets or sets the guest agent status. * **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. * **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. -* **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this host resides. -## HostTags +## GuestCredential ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: string (WriteOnly): Gets or sets the password to connect with the guest. +* **username**: string: Gets or sets username to connect with the guest. -## ResourcePoolProperties +## HardwareProfile +### Properties +* **cpuHotAddEnabled**: bool (ReadOnly): Gets or sets a value indicating whether virtual processors can be added while this virtual machine is running. +* **cpuHotRemoveEnabled**: bool (ReadOnly): Gets or sets a value indicating whether virtual processors can be removed while this virtual machine is running. +* **memoryHotAddEnabled**: bool (ReadOnly): Gets or sets a value indicating whether memory can be added while this virtual machine is running. +* **memorySizeMB**: int: Gets or sets memory size in MBs for the vm. +* **numCoresPerSocket**: int: Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified. +* **numCPUs**: int: Gets or sets the number of vCPUs for the vm. + +## HostProperties ### Properties -* **cpuLimitMHz**: int (ReadOnly): Gets or sets CPULimitMHz which specifies a CPU usage limit in MHz. -Utilization will not exceed this limit even if there are available resources. -* **cpuReservationMHz**: int (ReadOnly): Gets or sets CPUReservationMHz which specifies the CPU size in MHz that is guaranteed -to be available. -* **cpuSharesLevel**: string (ReadOnly): Gets or sets CPUSharesLevel which specifies the CPU allocation level for this pool. -This property is used in relative allocation between resource consumers. * **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. -* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource pool. -* **memLimitMB**: int (ReadOnly): Gets or sets MemLimitMB specifies a memory usage limit in megabytes. -Utilization will not exceed the specified limit even if there are available resources. -* **memReservationMB**: int (ReadOnly): Gets or sets MemReservationMB which specifies the guaranteed available memory in -megabytes. -* **memSharesLevel**: string (ReadOnly): Gets or sets CPUSharesLevel which specifies the memory allocation level for this pool. -This property is used in relative allocation between resource consumers. -* **moName**: string (ReadOnly): Gets or sets the vCenter Managed Object name for the resource pool. -* **moRefId**: string: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the resource pool. +* **inventoryItemId**: string: Gets or sets the inventory Item ID for the host. +* **moName**: string (ReadOnly): Gets or sets the vCenter Managed Object name for the host. +* **moRefId**: string: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the host. * **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. * **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. * **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. -* **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. +* **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this host resides. -## ResourcePoolTags +## HostTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VCenterProperties +## HttpProxyConfiguration ### Properties -* **connectionStatus**: string (ReadOnly): Gets or sets the connection status to the vCenter. -* **credentials**: [VICredential](#vicredential): Username / Password Credentials to connect to vcenter. -* **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. -* **fqdn**: string (Required): Gets or sets the FQDN/IPAddress of the vCenter. -* **instanceUuid**: string (ReadOnly): Gets or sets the instance UUID of the vCenter. -* **port**: int: Gets or sets the port of the vCenter. +* **httpsProxy**: string: Gets or sets httpsProxy url. + +## HybridIdentityMetadataProperties +### Properties +* **identity**: [Identity](#identity) (ReadOnly): Managed service identity. * **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. -* **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. -* **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. -* **version**: string (ReadOnly): Gets or sets the version of the vCenter. +* **publicKey**: string: Gets or sets the Public Key. +* **vmId**: string: Gets or sets the Vm Id. -## VICredential +## Identity ### Properties -* **password**: string (WriteOnly): Gets or sets the password to connect with the vCenter. -* **username**: string: Gets or sets username to connect with the vCenter. +* **principalId**: string (ReadOnly): The principal id of managed service identity. +* **tenantId**: string (ReadOnly): The tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | string (Required): The type of managed service identity. -## VCenterTags +## InventoryItemDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. +* **moName**: string: Gets or sets the vCenter Managed Object name for the resource. ## InventoryItemProperties * **Discriminator**: inventoryType @@ -340,70 +333,37 @@ Defaults to 1 if unspecified. * **inventoryType**: 'VirtualNetwork' (Required): They inventory type. -## InventoryItemDetails -### Properties -* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. -* **moName**: string: Gets or sets the vCenter Managed Object name for the resource. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal id of managed service identity. -* **tenantId**: string (ReadOnly): The tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | string (Required): The type of managed service identity. - -## VirtualMachineProperties -### Properties -* **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. -* **firmwareType**: 'bios' | 'efi' | string: Firmware type -* **folderPath**: string (ReadOnly): Gets or sets the folder path of the vm. -* **guestAgentProfile**: [GuestAgentProfile](#guestagentprofile): Defines the resource properties. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Defines the resource properties. -* **instanceUuid**: string (ReadOnly): Gets or sets the instance uuid of the vm. -* **inventoryItemId**: string: Gets or sets the inventory Item ID for the virtual machine. -* **moName**: string (ReadOnly): Gets or sets the vCenter Managed Object name for the virtual machine. -* **moRefId**: string: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine. -* **networkProfile**: [NetworkProfile](#networkprofile): Defines the resource properties. -* **osProfile**: [OsProfile](#osprofile): Defines the resource properties. -* **placementProfile**: [PlacementProfile](#placementprofile): Defines the resource properties. -* **powerState**: string (ReadOnly): Gets the power state of the virtual machine. -* **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. -* **resourcePoolId**: string: Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will -deploy. -* **smbiosUuid**: string: Gets or sets the SMBIOS UUID of the vm. -* **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. -* **storageProfile**: [StorageProfile](#storageprofile): Defines the resource properties. -* **templateId**: string: Gets or sets the ARM Id of the template resource to deploy the virtual machine. -* **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. -* **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. -* **vmId**: string (ReadOnly): Gets or sets a unique identifier for the vm resource. - -## GuestAgentProfile +## MachineExtensionInstanceViewStatus ### Properties -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmUuid**: string (ReadOnly): Specifies the VM's unique SMBIOS ID. +* **code**: string (ReadOnly): The status code. +* **displayStatus**: string (ReadOnly): The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning' | string (ReadOnly): The level code. +* **message**: string (ReadOnly): The detailed status message, including for alerts and error messages. +* **time**: string (ReadOnly): The time of the status. -## ErrorDetail +## MachineExtensionProperties ### Properties -* **code**: string (Required): The error's code. -* **details**: [ErrorDetail](#errordetail)[]: Additional error details. -* **message**: string (Required): A human readable error message. -* **target**: string: Indicates which property in the request is responsible for the error. +* **autoUpgradeMinorVersion**: bool: 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. +* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. +* **instanceView**: [MachineExtensionPropertiesInstanceView](#machineextensionpropertiesinstanceview): The machine extension instance view. +* **protectedSettings**: any: Any object +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string: The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. -## HardwareProfile +## MachineExtensionPropertiesInstanceView ### Properties -* **cpuHotAddEnabled**: bool (ReadOnly): Gets or sets a value indicating whether virtual processors can be added while this virtual machine is running. -* **cpuHotRemoveEnabled**: bool (ReadOnly): Gets or sets a value indicating whether virtual processors can be removed while this virtual machine is running. -* **memoryHotAddEnabled**: bool (ReadOnly): Gets or sets a value indicating whether memory can be added while this virtual machine is running. -* **memorySizeMB**: int: Gets or sets memory size in MBs for the vm. -* **numCoresPerSocket**: int: Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified. -* **numCPUs**: int: Gets or sets the number of vCPUs for the vm. +* **name**: string (ReadOnly): The machine extension name. +* **status**: [MachineExtensionInstanceViewStatus](#machineextensioninstanceviewstatus): Instance view status. +* **type**: string (ReadOnly): Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string (ReadOnly): Specifies the version of the script handler. -## NetworkProfile +## MachineExtensionTags ### Properties -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Gets or sets the list of network interfaces associated with the virtual machine. +### Additional Properties +* **Additional Properties Type**: string ## NetworkInterface ### Properties @@ -420,6 +380,16 @@ that the nic is connected to. * **nicType**: 'e1000' | 'e1000e' | 'pcnet32' | 'vmxnet' | 'vmxnet2' | 'vmxnet3' | string: NIC type * **powerOnBoot**: 'disabled' | 'enabled' | string: Defines the options for power on boot. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Gets or sets the list of network interfaces associated with the virtual machine. + +## NicIPAddressSettings +### Properties +* **allocationMethod**: string (ReadOnly): Gets the ip address allocation method. +* **ipAddress**: string (ReadOnly): Gets the ip address for the nic. +* **subnetMask**: string (ReadOnly): Gets the mask. + ## NicIPSettings ### Properties * **allocationMethod**: 'dynamic' | 'linklayer' | 'other' | 'random' | 'static' | 'unset' | string: IP address allocation method. @@ -431,12 +401,6 @@ that the nic is connected to. * **secondaryWinsServer**: string (ReadOnly): Gets or sets the secondary server. * **subnetMask**: string: Gets or sets the mask. -## NicIPAddressSettings -### Properties -* **allocationMethod**: string (ReadOnly): Gets the ip address allocation method. -* **ipAddress**: string (ReadOnly): Gets the ip address for the nic. -* **subnetMask**: string (ReadOnly): Gets the mask. - ## OsProfile ### Properties * **adminPassword**: string (WriteOnly): Gets or sets administrator password. @@ -455,11 +419,80 @@ that the nic is connected to. * **hostId**: string: Gets or sets the ARM Id of the host resource on which this virtual machine will deploy. * **resourcePoolId**: string: Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy. +## ResourcePoolProperties +### Properties +* **cpuLimitMHz**: int (ReadOnly): Gets or sets CPULimitMHz which specifies a CPU usage limit in MHz. +Utilization will not exceed this limit even if there are available resources. +* **cpuReservationMHz**: int (ReadOnly): Gets or sets CPUReservationMHz which specifies the CPU size in MHz that is guaranteed +to be available. +* **cpuSharesLevel**: string (ReadOnly): Gets or sets CPUSharesLevel which specifies the CPU allocation level for this pool. +This property is used in relative allocation between resource consumers. +* **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. +* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource pool. +* **memLimitMB**: int (ReadOnly): Gets or sets MemLimitMB specifies a memory usage limit in megabytes. +Utilization will not exceed the specified limit even if there are available resources. +* **memReservationMB**: int (ReadOnly): Gets or sets MemReservationMB which specifies the guaranteed available memory in +megabytes. +* **memSharesLevel**: string (ReadOnly): Gets or sets CPUSharesLevel which specifies the memory allocation level for this pool. +This property is used in relative allocation between resource consumers. +* **moName**: string (ReadOnly): Gets or sets the vCenter Managed Object name for the resource pool. +* **moRefId**: string: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the resource pool. +* **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. +* **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. +* **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. +* **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. + +## ResourcePoolTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceStatus +### Properties +* **lastUpdatedAt**: string (ReadOnly): The last update time for this condition. +* **message**: string (ReadOnly): A human readable message indicating details about the status. +* **reason**: string (ReadOnly): The reason for the condition's status. +* **severity**: string (ReadOnly): Severity with which to treat failures of this type of condition. +* **status**: string (ReadOnly): Status of the condition. +* **type**: string (ReadOnly): The type of the condition. + ## StorageProfile ### Properties * **disks**: [VirtualDisk](#virtualdisk)[]: Gets or sets the list of virtual disks associated with the virtual machine. * **scsiControllers**: [VirtualScsiController](#virtualscsicontroller)[] (ReadOnly): Gets or sets the list of virtual SCSI controllers associated with the virtual machine. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VCenterProperties +### Properties +* **connectionStatus**: string (ReadOnly): Gets or sets the connection status to the vCenter. +* **credentials**: [VICredential](#vicredential): Username / Password Credentials to connect to vcenter. +* **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. +* **fqdn**: string (Required): Gets or sets the FQDN/IPAddress of the vCenter. +* **instanceUuid**: string (ReadOnly): Gets or sets the instance UUID of the vCenter. +* **port**: int: Gets or sets the port of the vCenter. +* **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. +* **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. +* **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. +* **version**: string (ReadOnly): Gets or sets the version of the vCenter. + +## VCenterTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VICredential +### Properties +* **password**: string (WriteOnly): Gets or sets the password to connect with the vCenter. +* **username**: string: Gets or sets username to connect with the vCenter. + ## VirtualDisk ### Properties * **controllerKey**: int: Gets or sets the controller id. @@ -473,77 +506,36 @@ that the nic is connected to. * **name**: string: Gets or sets the name of the virtual disk. * **unitNumber**: int: Gets or sets the unit number of the disk on the controller. -## VirtualScsiController -### Properties -* **busNumber**: int: Gets or sets the bus number of the controller. -* **controllerKey**: int: Gets or sets the key of the controller. -* **scsiCtlrUnitNumber**: int: Gets or sets the SCSI controller unit number. -* **sharing**: 'noSharing' | 'physicalSharing' | 'virtualSharing' | string: Defines the sharing mode for sharing the SCSI bus. -* **type**: 'buslogic' | 'lsilogic' | 'lsilogicsas' | 'pvscsi' | string: Defines the different types of SCSI controllers. - -## VirtualMachineTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MachineExtensionProperties -### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. -* **instanceView**: [MachineExtensionPropertiesInstanceView](#machineextensionpropertiesinstanceview): The machine extension instance view. -* **protectedSettings**: any: Any object -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## MachineExtensionPropertiesInstanceView -### Properties -* **name**: string (ReadOnly): The machine extension name. -* **status**: [MachineExtensionInstanceViewStatus](#machineextensioninstanceviewstatus): Instance view status. -* **type**: string (ReadOnly): Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string (ReadOnly): Specifies the version of the script handler. - -## MachineExtensionInstanceViewStatus -### Properties -* **code**: string (ReadOnly): The status code. -* **displayStatus**: string (ReadOnly): The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning' | string (ReadOnly): The level code. -* **message**: string (ReadOnly): The detailed status message, including for alerts and error messages. -* **time**: string (ReadOnly): The time of the status. - -## MachineExtensionTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GuestAgentProperties +## VirtualMachineProperties ### Properties -* **credentials**: [GuestCredential](#guestcredential): Username / Password Credentials to connect to guest. * **customResourceName**: string (ReadOnly): Gets the name of the corresponding resource in Kubernetes. -* **httpProxyConfig**: [HttpProxyConfiguration](#httpproxyconfiguration): HTTP Proxy configuration for the VM. -* **provisioningAction**: 'install' | 'repair' | 'uninstall' | string: Defines the different types of operations for guest agent. +* **firmwareType**: 'bios' | 'efi' | string: Firmware type +* **folderPath**: string (ReadOnly): Gets or sets the folder path of the vm. +* **guestAgentProfile**: [GuestAgentProfile](#guestagentprofile): Defines the resource properties. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Defines the resource properties. +* **instanceUuid**: string (ReadOnly): Gets or sets the instance uuid of the vm. +* **inventoryItemId**: string: Gets or sets the inventory Item ID for the virtual machine. +* **moName**: string (ReadOnly): Gets or sets the vCenter Managed Object name for the virtual machine. +* **moRefId**: string: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine. +* **networkProfile**: [NetworkProfile](#networkprofile): Defines the resource properties. +* **osProfile**: [OsProfile](#osprofile): Defines the resource properties. +* **placementProfile**: [PlacementProfile](#placementprofile): Defines the resource properties. +* **powerState**: string (ReadOnly): Gets the power state of the virtual machine. * **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. -* **status**: string (ReadOnly): Gets or sets the guest agent status. +* **resourcePoolId**: string: Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will +deploy. +* **smbiosUuid**: string: Gets or sets the SMBIOS UUID of the vm. * **statuses**: [ResourceStatus](#resourcestatus)[] (ReadOnly): The resource status information. +* **storageProfile**: [StorageProfile](#storageprofile): Defines the resource properties. +* **templateId**: string: Gets or sets the ARM Id of the template resource to deploy the virtual machine. * **uuid**: string (ReadOnly): Gets or sets a unique identifier for this resource. +* **vCenterId**: string: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. +* **vmId**: string (ReadOnly): Gets or sets a unique identifier for the vm resource. -## GuestCredential -### Properties -* **password**: string (WriteOnly): Gets or sets the password to connect with the guest. -* **username**: string: Gets or sets username to connect with the guest. - -## HttpProxyConfiguration -### Properties -* **httpsProxy**: string: Gets or sets httpsProxy url. - -## HybridIdentityMetadataProperties +## VirtualMachineTags ### Properties -* **identity**: [Identity](#identity) (ReadOnly): Managed service identity. -* **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. -* **publicKey**: string: Gets or sets the Public Key. -* **vmId**: string: Gets or sets the Vm Id. +### Additional Properties +* **Additional Properties Type**: string ## VirtualMachineTemplateProperties ### Properties @@ -590,3 +582,11 @@ Defaults to 1 if unspecified. ### Additional Properties * **Additional Properties Type**: string +## VirtualScsiController +### Properties +* **busNumber**: int: Gets or sets the bus number of the controller. +* **controllerKey**: int: Gets or sets the key of the controller. +* **scsiCtlrUnitNumber**: int: Gets or sets the SCSI controller unit number. +* **sharing**: 'noSharing' | 'physicalSharing' | 'virtualSharing' | string: Defines the sharing mode for sharing the SCSI bus. +* **type**: 'buslogic' | 'lsilogic' | 'lsilogicsas' | 'pvscsi' | string: Defines the different types of SCSI controllers. + diff --git a/generated/consumption/log.out b/generated/consumption/log.out index 953b900e21..0feb6ac37d 100644 --- a/generated/consumption/log.out +++ b/generated/consumption/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.consumption-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/consumption.json:1853:5 @@ -121,7 +121,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/consumption.json:1846:5 @@ -230,12 +230,12 @@ warning | PreCheck/SchemaMissingType | The schema 'AmountWithExchangeRate' with warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ReservationRecommendationDetailsModel' has a property 'etag' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ReservationRecommendationDetailsModel warning | PreCheck/PropertyRedeclarationWarning | Schema 'LegacyReservationTransaction' has a property 'properties' that is already declared the parent schema 'ReservationTransaction' but isn't significantly different. The property has been removed from LegacyReservationTransaction -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.consumption-2019-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json:1739:5 @@ -342,12 +342,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ReservationRecommendationDetailsModel' has a property 'etag' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ReservationRecommendationDetailsModel warning | PreCheck/PropertyRedeclarationWarning | Schema 'LegacyReservationTransaction' has a property 'properties' that is already declared the parent schema 'ReservationTransaction' but isn't significantly different. The property has been removed from LegacyReservationTransaction -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.consumption-2019-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json:1739:5 @@ -457,12 +457,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json:5277:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'LegacyReservationTransaction' has a property 'properties' that is already declared the parent schema 'ReservationTransaction' but isn't significantly different. The property has been removed from LegacyReservationTransaction -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.consumption-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-06-01/consumption.json:1376:5 @@ -530,7 +530,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2019-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-05-01/consumption.json:1327:5 @@ -587,12 +587,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceAttributes' with an u warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-05-01/consumption.json:3041:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.consumption-2019-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2019-05-01-preview/consumption.json:1238:5 @@ -651,12 +651,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceAttributes' with an u warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2019-05-01-preview/consumption.json:2938:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.consumption-2019-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2019-04-01-preview/consumption.json:1231:5 @@ -720,7 +720,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2018-11-01-previ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Enrollment' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2018-11-01-preview/consumption.json:510:5 @@ -779,7 +779,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2019-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/consumption.json:1180:5 @@ -839,7 +839,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2017-11-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/consumption.json:309:5 @@ -869,7 +869,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2018-01-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-01-31/consumption.json:1111:5 @@ -912,12 +912,12 @@ warning | PreCheck/SchemaMissingType | The schema 'PriceSheetModel' with an unde warning | PreCheck/SchemaMissingType | The schema 'PriceSheetProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-01-31/consumption.json:2030:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.consumption-2018-03-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json:2277:5 @@ -980,7 +980,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2018-05-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/consumption.json:952:5 @@ -1006,7 +1006,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2018-06-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json:2585:5 @@ -1064,12 +1064,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json:4081:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/costTags': Found mismatch between type segments (1) and name segments (0) -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.consumption-2018-08-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-08-31/consumption.json:2706:5 @@ -1124,12 +1124,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceAttributes' with an u warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-08-31/consumption.json:4255:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.consumption-2018-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json:2888:5 @@ -1193,7 +1193,7 @@ info | Processing batch task - {"tag":"microsoft.consumption-2017-04-24-previ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MeterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json:156:5 @@ -1210,12 +1210,12 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json:398:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.consumption-2017-12-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BudgetsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json:258:5 @@ -1237,4 +1237,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json:502:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 65.03s. 30 files generated. +info | Autorest completed in 62.05s. 30 files generated. diff --git a/generated/consumption/microsoft.consumption/2017-12-30-preview/types.md b/generated/consumption/microsoft.consumption/2017-12-30-preview/types.md index 6f19b9fd9c..0677e7bcff 100644 --- a/generated/consumption/microsoft.consumption/2017-12-30-preview/types.md +++ b/generated/consumption/microsoft.consumption/2017-12-30-preview/types.md @@ -19,16 +19,21 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. -## CurrentSpend -### Properties -* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. -* **unit**: string (ReadOnly): The unit of measure for the budget amount. - ## BudgetPropertiesNotifications ### Properties ### Additional Properties * **Additional Properties Type**: [Notification](#notification) +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + +## CurrentSpend +### Properties +* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. +* **unit**: string (ReadOnly): The unit of measure for the budget amount. + ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -37,8 +42,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2018-01-31/types.md b/generated/consumption/microsoft.consumption/2018-01-31/types.md index c9a6652507..b23a219c3b 100644 --- a/generated/consumption/microsoft.consumption/2018-01-31/types.md +++ b/generated/consumption/microsoft.consumption/2018-01-31/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -31,11 +41,6 @@ * **resourceGroups**: string[]: The list of filters on resource groups, allowed at subscription level only. * **resources**: string[]: The list of filters on resources. -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -45,8 +50,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2018-03-31/types.md b/generated/consumption/microsoft.consumption/2018-03-31/types.md index c956c39f14..02edffca68 100644 --- a/generated/consumption/microsoft.consumption/2018-03-31/types.md +++ b/generated/consumption/microsoft.consumption/2018-03-31/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2018-06-30/types.md b/generated/consumption/microsoft.consumption/2018-06-30/types.md index 2cbf9002a6..da49e5907c 100644 --- a/generated/consumption/microsoft.consumption/2018-06-30/types.md +++ b/generated/consumption/microsoft.consumption/2018-06-30/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2018-08-31/types.md b/generated/consumption/microsoft.consumption/2018-08-31/types.md index 0c070224c7..8afc817606 100644 --- a/generated/consumption/microsoft.consumption/2018-08-31/types.md +++ b/generated/consumption/microsoft.consumption/2018-08-31/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2018-10-01/types.md b/generated/consumption/microsoft.consumption/2018-10-01/types.md index 064c79f11a..f511a695d6 100644 --- a/generated/consumption/microsoft.consumption/2018-10-01/types.md +++ b/generated/consumption/microsoft.consumption/2018-10-01/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-01-01/types.md b/generated/consumption/microsoft.consumption/2019-01-01/types.md index 09d999ae4e..67a5039f43 100644 --- a/generated/consumption/microsoft.consumption/2019-01-01/types.md +++ b/generated/consumption/microsoft.consumption/2019-01-01/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-04-01-preview/types.md b/generated/consumption/microsoft.consumption/2019-04-01-preview/types.md index 93f312fef8..3c34e1ffc6 100644 --- a/generated/consumption/microsoft.consumption/2019-04-01-preview/types.md +++ b/generated/consumption/microsoft.consumption/2019-04-01-preview/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-05-01-preview/types.md b/generated/consumption/microsoft.consumption/2019-05-01-preview/types.md index e82853c0aa..b44b34e7f9 100644 --- a/generated/consumption/microsoft.consumption/2019-05-01-preview/types.md +++ b/generated/consumption/microsoft.consumption/2019-05-01-preview/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-05-01/types.md b/generated/consumption/microsoft.consumption/2019-05-01/types.md index a24ab6c0c2..b7212f2b19 100644 --- a/generated/consumption/microsoft.consumption/2019-05-01/types.md +++ b/generated/consumption/microsoft.consumption/2019-05-01/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. @@ -52,8 +57,3 @@ * **threshold**: int (Required): 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. * **thresholdType**: 'Actual' | string: The type of threshold -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-06-01/types.md b/generated/consumption/microsoft.consumption/2019-06-01/types.md index c4ef3e81a0..f65f74d890 100644 --- a/generated/consumption/microsoft.consumption/2019-06-01/types.md +++ b/generated/consumption/microsoft.consumption/2019-06-01/types.md @@ -20,6 +20,16 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. +## BudgetPropertiesNotifications +### Properties +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) + +## BudgetTimePeriod +### Properties +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. + ## CurrentSpend ### Properties * **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. @@ -37,11 +47,6 @@ ### Additional Properties * **Additional Properties Type**: string[] -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. @@ -51,8 +56,3 @@ * **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. * **threshold**: int (Required): 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. -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-10-01/types.md b/generated/consumption/microsoft.consumption/2019-10-01/types.md index f8e1d31251..ee8a374b6e 100644 --- a/generated/consumption/microsoft.consumption/2019-10-01/types.md +++ b/generated/consumption/microsoft.consumption/2019-10-01/types.md @@ -10,6 +10,24 @@ * **properties**: [BudgetProperties](#budgetproperties): The properties of the budget. * **type**: 'Microsoft.Consumption/budgets' (ReadOnly, DeployTimeConstant): The resource type +## BudgetComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison + +## BudgetFilter +### Properties +* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **not**: [BudgetFilterProperties](#budgetfilterproperties): The Dimensions or Tags to filter a budget by. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + +## BudgetFilterProperties +### Properties +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + ## BudgetProperties ### Properties * **amount**: int (Required): The total amount of cost to track with the budget @@ -21,39 +39,26 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. -## CurrentSpend -### Properties -* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. -* **unit**: string (ReadOnly): The unit of measure for the budget amount. - -## BudgetFilter +## BudgetPropertiesNotifications ### Properties -* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **not**: [BudgetFilterProperties](#budgetfilterproperties): The Dimensions or Tags to filter a budget by. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) -## BudgetFilterProperties +## BudgetTimePeriod ### Properties -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. -## BudgetComparisonExpression +## CurrentSpend ### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison +* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. +* **unit**: string (ReadOnly): The unit of measure for the budget amount. ## ForecastSpend ### Properties * **amount**: int (ReadOnly): The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. * **unit**: string (ReadOnly): The unit of measure for the budget amount. -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. @@ -65,8 +70,3 @@ * **threshold**: int (Required): 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. * **thresholdType**: 'Actual' | string: The type of threshold -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2019-11-01/types.md b/generated/consumption/microsoft.consumption/2019-11-01/types.md index b9179d41a6..7bfc41a8a5 100644 --- a/generated/consumption/microsoft.consumption/2019-11-01/types.md +++ b/generated/consumption/microsoft.consumption/2019-11-01/types.md @@ -10,6 +10,24 @@ * **properties**: [BudgetProperties](#budgetproperties): The properties of the budget. * **type**: 'Microsoft.Consumption/budgets' (ReadOnly, DeployTimeConstant): The resource type +## BudgetComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison + +## BudgetFilter +### Properties +* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **not**: [BudgetFilterProperties](#budgetfilterproperties): The Dimensions or Tags to filter a budget by. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + +## BudgetFilterProperties +### Properties +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + ## BudgetProperties ### Properties * **amount**: int (Required): The total amount of cost to track with the budget @@ -21,39 +39,26 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. -## CurrentSpend -### Properties -* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. -* **unit**: string (ReadOnly): The unit of measure for the budget amount. - -## BudgetFilter +## BudgetPropertiesNotifications ### Properties -* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **not**: [BudgetFilterProperties](#budgetfilterproperties): The Dimensions or Tags to filter a budget by. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) -## BudgetFilterProperties +## BudgetTimePeriod ### Properties -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. -## BudgetComparisonExpression +## CurrentSpend ### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison +* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. +* **unit**: string (ReadOnly): The unit of measure for the budget amount. ## ForecastSpend ### Properties * **amount**: int (ReadOnly): The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. * **unit**: string (ReadOnly): The unit of measure for the budget amount. -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. @@ -64,8 +69,3 @@ * **threshold**: int (Required): 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. * **thresholdType**: 'Actual' | 'Forecasted' | string: The type of threshold -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2021-05-01/types.md b/generated/consumption/microsoft.consumption/2021-05-01/types.md index 0e48e4fc79..b81b9b51a2 100644 --- a/generated/consumption/microsoft.consumption/2021-05-01/types.md +++ b/generated/consumption/microsoft.consumption/2021-05-01/types.md @@ -10,6 +10,24 @@ * **properties**: [BudgetProperties](#budgetproperties): The properties of the budget. * **type**: 'Microsoft.Consumption/budgets' (ReadOnly, DeployTimeConstant): The resource type +## BudgetComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison + +## BudgetFilter +### Properties +* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **not**: [BudgetFilterProperties](#budgetfilterproperties): The Dimensions or Tags to filter a budget by. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + +## BudgetFilterProperties +### Properties +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + ## BudgetProperties ### Properties * **amount**: int (Required): The total amount of cost to track with the budget @@ -21,39 +39,26 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. -## CurrentSpend -### Properties -* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. -* **unit**: string (ReadOnly): The unit of measure for the budget amount. - -## BudgetFilter +## BudgetPropertiesNotifications ### Properties -* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **not**: [BudgetFilterProperties](#budgetfilterproperties): The Dimensions or Tags to filter a budget by. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) -## BudgetFilterProperties +## BudgetTimePeriod ### Properties -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. -## BudgetComparisonExpression +## CurrentSpend ### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison +* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. +* **unit**: string (ReadOnly): The unit of measure for the budget amount. ## ForecastSpend ### Properties * **amount**: int (ReadOnly): The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. * **unit**: string (ReadOnly): The unit of measure for the budget amount. -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. @@ -64,8 +69,3 @@ * **threshold**: int (Required): 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. * **thresholdType**: 'Actual' | string: The type of threshold -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/consumption/microsoft.consumption/2021-10-01/types.md b/generated/consumption/microsoft.consumption/2021-10-01/types.md index fed26db7ea..3d8a32347d 100644 --- a/generated/consumption/microsoft.consumption/2021-10-01/types.md +++ b/generated/consumption/microsoft.consumption/2021-10-01/types.md @@ -10,6 +10,23 @@ * **properties**: [BudgetProperties](#budgetproperties): The properties of the budget. * **type**: 'Microsoft.Consumption/budgets' (ReadOnly, DeployTimeConstant): The resource type +## BudgetComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison + +## BudgetFilter +### Properties +* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + +## BudgetFilterProperties +### Properties +* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. + ## BudgetProperties ### Properties * **amount**: int (Required): The total amount of cost to track with the budget @@ -21,38 +38,26 @@ * **timeGrain**: 'Annually' | 'BillingAnnual' | 'BillingMonth' | 'BillingQuarter' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. -## CurrentSpend -### Properties -* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. -* **unit**: string (ReadOnly): The unit of measure for the budget amount. - -## BudgetFilter +## BudgetPropertiesNotifications ### Properties -* **and**: [BudgetFilterProperties](#budgetfilterproperties)[]: The logical "AND" expression. Must have at least 2 items. -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +### Additional Properties +* **Additional Properties Type**: [Notification](#notification) -## BudgetFilterProperties +## BudgetTimePeriod ### Properties -* **dimensions**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. -* **tags**: [BudgetComparisonExpression](#budgetcomparisonexpression): The comparison expression to be used in the budgets. +* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. +* **startDate**: string (Required): The start date for the budget. -## BudgetComparisonExpression +## CurrentSpend ### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison +* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. +* **unit**: string (ReadOnly): The unit of measure for the budget amount. ## ForecastSpend ### Properties * **amount**: int (ReadOnly): The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. * **unit**: string (ReadOnly): The unit of measure for the budget amount. -## BudgetPropertiesNotifications -### Properties -### Additional Properties -* **Additional Properties Type**: [Notification](#notification) - ## Notification ### Properties * **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. @@ -64,8 +69,3 @@ * **threshold**: int (Required): 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. * **thresholdType**: 'Actual' | 'Forecasted' | string: The type of threshold -## BudgetTimePeriod -### Properties -* **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. -* **startDate**: string (Required): The start date for the budget. - diff --git a/generated/containerinstance/log.out b/generated/containerinstance/log.out index 8c90aca3c8..00bd650e83 100644 --- a/generated/containerinstance/log.out +++ b/generated/containerinstance/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.containerinstance-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json:1090:5 @@ -20,11 +20,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json:2220:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.containerinstance-2021-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-09-01/containerInstance.json:1077:5 @@ -40,7 +40,7 @@ info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.containerinstance-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-07-01/containerInstance.json:1077:5 @@ -52,11 +52,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-07-01/containerInstance.json:2140:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.containerinstance-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json:1037:5 @@ -72,7 +72,7 @@ info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.containerinstance-2020-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2020-11-01/containerInstance.json:1037:5 @@ -84,11 +84,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2020-11-01/containerInstance.json:2080:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.containerinstance-2019-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json:984:5 @@ -100,11 +100,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json:1988:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.containerinstance-2018-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json:998:5 @@ -116,21 +116,21 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json:1869:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.containerinstance-2018-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-09-01/containerInstance.json:735:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.containerinstance-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json:735:5 @@ -140,7 +140,7 @@ info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.containerinstance-2018-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-04-01/containerInstance.json:675:5 @@ -150,7 +150,7 @@ info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerinstance-2018-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2018-02-01-preview/containerInstance.json:664:5 @@ -160,17 +160,17 @@ info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.containerinstance-2017-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GitRepoVolume' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-12-01-preview/containerInstance.json:572:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.containerinstance-2017-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -178,8 +178,8 @@ info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerinstance-2017-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 30.23s. 28 files generated. +info | Autorest completed in 29.18s. 28 files generated. diff --git a/generated/containerinstance/microsoft.containerinstance/2017-08-01-preview/types.md b/generated/containerinstance/microsoft.containerinstance/2017-08-01-preview/types.md index d76ad0f96d..0c796eaac7 100644 --- a/generated/containerinstance/microsoft.containerinstance/2017-08-01-preview/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2017-08-01-preview/types.md @@ -11,6 +11,26 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerEvent +### Properties +* **count**: int: The count of the event. +* **firstTimestamp**: string: The date-time of the earliest logged event. +* **lastTimestamp**: string: The date-time of the latest logged event. +* **message**: string: The event message. +* **type**: string: The event type. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -22,10 +42,9 @@ * **state**: string (ReadOnly): The current state of the container group. This is only valid for the response. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerPort ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **port**: int (Required): The port number exposed within the container group. ## ContainerProperties ### Properties @@ -37,11 +56,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string (Required): The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate): The container instance state. @@ -57,38 +71,10 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. -## ContainerEvent -### Properties -* **count**: int: The count of the event. -* **firstTimestamp**: string: The date-time of the earliest logged event. -* **lastTimestamp**: string: The date-time of the latest logged event. -* **message**: string: The event message. -* **type**: string: The event type. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits -### Properties -* **cpu**: int: The CPU limit of this container instance. -* **memoryInGB**: int: The memory limit in GB of this container instance. - -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount +## EnvironmentVariable ### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. +* **name**: string (Required): The name of the environment variable. +* **value**: string (Required): The value of the environment variable. ## ImageRegistryCredential ### Properties @@ -107,20 +93,34 @@ * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## Volume +## ResourceLimits ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume) (Required): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **name**: string (Required): The name of the volume. +* **cpu**: int: The CPU limit of this container instance. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## AzureFileVolume +## ResourceRequests ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **cpu**: int (Required): The CPU request of this container instance. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. + +## ResourceRequirements +### Properties +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Volume +### Properties +* **azureFile**: [AzureFileVolume](#azurefilevolume) (Required): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **name**: string (Required): The name of the volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. + diff --git a/generated/containerinstance/microsoft.containerinstance/2017-10-01-preview/types.md b/generated/containerinstance/microsoft.containerinstance/2017-10-01-preview/types.md index 75f4d775c4..44259c2664 100644 --- a/generated/containerinstance/microsoft.containerinstance/2017-10-01-preview/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2017-10-01-preview/types.md @@ -11,6 +11,18 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -25,10 +37,15 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. ## ContainerProperties ### Properties @@ -40,11 +57,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string (Required): The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -60,6 +72,11 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string (Required): The value of the environment variable. + ## Event ### Properties * **count**: int: The count of the event. @@ -69,43 +86,12 @@ * **name**: string: The event name. * **type**: string: The event type. -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits -### Properties -* **cpu**: int: The CPU limit of this container instance. -* **memoryInGB**: int: The memory limit in GB of this container instance. - -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - ## ImageRegistryCredential ### Properties * **password**: string: The password for the private registry. * **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". * **username**: string (Required): The username for the private registry. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **ip**: string: The IP exposed to the public internet. @@ -117,21 +103,35 @@ * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## Volume +## ResourceLimits ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **name**: string (Required): The name of the volume. +* **cpu**: int: The CPU limit of this container instance. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## AzureFileVolume +## ResourceRequests ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **cpu**: int (Required): The CPU request of this container instance. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. + +## ResourceRequirements +### Properties +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Volume +### Properties +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **name**: string (Required): The name of the volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. + diff --git a/generated/containerinstance/microsoft.containerinstance/2017-12-01-preview/types.md b/generated/containerinstance/microsoft.containerinstance/2017-12-01-preview/types.md index 13c7e7b1af..4794d3709a 100644 --- a/generated/containerinstance/microsoft.containerinstance/2017-12-01-preview/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2017-12-01-preview/types.md @@ -11,6 +11,18 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -25,10 +37,15 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. ## ContainerProperties ### Properties @@ -40,11 +57,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string (Required): The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -60,6 +72,11 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string (Required): The value of the environment variable. + ## Event ### Properties * **count**: int: The count of the event. @@ -69,31 +86,11 @@ * **name**: string: The event name. * **type**: string: The event type. -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits -### Properties -* **cpu**: int: The CPU limit of this container instance. -* **memoryInGB**: int: The memory limit in GB of this container instance. - -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount +## GitRepoVolume ### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## ImageRegistryCredential ### Properties @@ -101,11 +98,6 @@ * **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". * **username**: string (Required): The username for the private registry. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **ip**: string: The IP exposed to the public internet. @@ -117,34 +109,42 @@ * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## Volume +## ResourceLimits ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int: The CPU limit of this container instance. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## AzureFileVolume +## ResourceRequests ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **cpu**: int (Required): The CPU request of this container instance. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## GitRepoVolume +## ResourceRequirements ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## SecretVolume +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string +## Volume +### Properties +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. + diff --git a/generated/containerinstance/microsoft.containerinstance/2018-02-01-preview/types.md b/generated/containerinstance/microsoft.containerinstance/2018-02-01-preview/types.md index ff22feaf73..93a8712c82 100644 --- a/generated/containerinstance/microsoft.containerinstance/2018-02-01-preview/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2018-02-01-preview/types.md @@ -11,6 +11,18 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -25,10 +37,15 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. ## ContainerProperties ### Properties @@ -40,11 +57,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string (Required): The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -60,6 +72,11 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string (Required): The value of the environment variable. + ## Event ### Properties * **count**: int: The count of the event. @@ -69,31 +86,11 @@ * **name**: string: The event name. * **type**: string: The event type. -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits -### Properties -* **cpu**: int: The CPU limit of this container instance. -* **memoryInGB**: int: The memory limit in GB of this container instance. - -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount +## GitRepoVolume ### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## ImageRegistryCredential ### Properties @@ -101,11 +98,6 @@ * **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". * **username**: string (Required): The username for the private registry. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -119,34 +111,42 @@ * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## Volume +## ResourceLimits ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int: The CPU limit of this container instance. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## AzureFileVolume +## ResourceRequests ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **cpu**: int (Required): The CPU request of this container instance. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## GitRepoVolume +## ResourceRequirements ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## SecretVolume +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string +## Volume +### Properties +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. + diff --git a/generated/containerinstance/microsoft.containerinstance/2018-04-01/types.md b/generated/containerinstance/microsoft.containerinstance/2018-04-01/types.md index d668f1a0d4..227507f591 100644 --- a/generated/containerinstance/microsoft.containerinstance/2018-04-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2018-04-01/types.md @@ -11,6 +11,18 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -25,10 +37,15 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. ## ContainerProperties ### Properties @@ -40,11 +57,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **value**: string (Required): The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -60,6 +72,11 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **value**: string (Required): The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -69,31 +86,11 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits -### Properties -* **cpu**: int: The CPU limit of this container instance. -* **memoryInGB**: int: The memory limit in GB of this container instance. - -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount +## GitRepoVolume ### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## ImageRegistryCredential ### Properties @@ -101,11 +98,6 @@ * **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". * **username**: string (Required): The username for the private registry. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -119,34 +111,42 @@ * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## Volume +## ResourceLimits ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int: The CPU limit of this container instance. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## AzureFileVolume +## ResourceRequests ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **cpu**: int (Required): The CPU request of this container instance. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## GitRepoVolume +## ResourceRequirements ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## SecretVolume +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string +## Volume +### Properties +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. + diff --git a/generated/containerinstance/microsoft.containerinstance/2018-06-01/types.md b/generated/containerinstance/microsoft.containerinstance/2018-06-01/types.md index 4d34106214..2221aed011 100644 --- a/generated/containerinstance/microsoft.containerinstance/2018-06-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2018-06-01/types.md @@ -11,6 +11,26 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -26,10 +46,31 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerHttpGet +### Properties +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -43,12 +84,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -64,6 +99,12 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int: The count of the event. @@ -73,35 +114,35 @@ * **name**: string: The event name. * **type**: string: The event type. -## ContainerProbe +## GitRepoVolume ### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. -## ContainerExec +## ImageRegistryCredential ### Properties -* **command**: string[]: The commands to execute within the container. +* **password**: string: The password for the private registry. +* **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". +* **username**: string (Required): The username for the private registry. -## ContainerHttpGet +## IpAddress ### Properties -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. +* **dnsNameLabel**: string: The Dns name label for the IP. +* **fqdn**: string (ReadOnly): The FQDN for the IP. +* **ip**: string: The IP exposed to the public internet. +* **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. +* **type**: 'Public' | string (Required): Specifies if the IP is exposed to the public internet. -## ContainerPort +## LogAnalytics ### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics -## ResourceRequirements +## Port ### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. +* **port**: int (Required): The port number. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. ## ResourceLimits ### Properties @@ -113,44 +154,20 @@ * **cpu**: int (Required): The CPU request of this container instance. * **memoryInGB**: int (Required): The memory request in GB of this container instance. -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics - -## ImageRegistryCredential -### Properties -* **password**: string: The password for the private registry. -* **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". -* **username**: string (Required): The username for the private registry. - -## ContainerGroupPropertiesInstanceView +## ResourceRequirements ### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## IpAddress +## ResourceTags ### Properties -* **dnsNameLabel**: string: The Dns name label for the IP. -* **fqdn**: string (ReadOnly): The FQDN for the IP. -* **ip**: string: The IP exposed to the public internet. -* **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. -* **type**: 'Public' | string (Required): Specifies if the IP is exposed to the public internet. +### Additional Properties +* **Additional Properties Type**: string -## Port +## SecretVolume ### Properties -* **port**: int (Required): The port number. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. +### Additional Properties +* **Additional Properties Type**: string ## Volume ### Properties @@ -160,26 +177,9 @@ * **name**: string (Required): The name of the volume. * **secret**: [SecretVolume](#secretvolume): The secret volume. -## AzureFileVolume -### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. - -## GitRepoVolume -### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. - -## SecretVolume -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VolumeMount ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2018-09-01/types.md b/generated/containerinstance/microsoft.containerinstance/2018-09-01/types.md index 1cc403f851..dbf0906f04 100644 --- a/generated/containerinstance/microsoft.containerinstance/2018-09-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2018-09-01/types.md @@ -11,6 +11,30 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + +## ContainerGroupNetworkProfile +### Properties +* **id**: string (Required): The identifier for a network profile. + ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -27,10 +51,31 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerHttpGet +### Properties +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -44,12 +89,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -65,6 +104,12 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int: The count of the event. @@ -74,55 +119,25 @@ * **name**: string: The event name. * **type**: string: The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits -### Properties -* **cpu**: int: The CPU limit of this container instance. -* **memoryInGB**: int: The memory limit in GB of this container instance. - -## ResourceRequests +## GitRepoVolume ### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. -## VolumeMount +## ImageRegistryCredential ### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. +* **password**: string: The password for the private registry. +* **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". +* **username**: string (Required): The username for the private registry. -## ContainerGroupDiagnostics +## IpAddress ### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. +* **dnsNameLabel**: string: The Dns name label for the IP. +* **fqdn**: string (ReadOnly): The FQDN for the IP. +* **ip**: string: The IP exposed to the public internet. +* **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. +* **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet. ## LogAnalytics ### Properties @@ -136,62 +151,47 @@ ### Additional Properties * **Additional Properties Type**: string -## ImageRegistryCredential -### Properties -* **password**: string: The password for the private registry. -* **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". -* **username**: string (Required): The username for the private registry. - -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - -## IpAddress -### Properties -* **dnsNameLabel**: string: The Dns name label for the IP. -* **fqdn**: string (ReadOnly): The FQDN for the IP. -* **ip**: string: The IP exposed to the public internet. -* **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. -* **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet. - ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupNetworkProfile +## ResourceLimits ### Properties -* **id**: string (Required): The identifier for a network profile. +* **cpu**: int: The CPU limit of this container instance. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2018-10-01/types.md b/generated/containerinstance/microsoft.containerinstance/2018-10-01/types.md index dedde3ed49..1715b85db6 100644 --- a/generated/containerinstance/microsoft.containerinstance/2018-10-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2018-10-01/types.md @@ -12,6 +12,31 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -24,10 +49,9 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +## ContainerGroupNetworkProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **id**: string (Required): The identifier for a network profile. ## ContainerGroupProperties ### Properties @@ -46,10 +70,31 @@ - `Never` Never restart * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerHttpGet +### Properties +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -63,12 +108,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -84,6 +123,18 @@ * **startTime**: string: The date-time when the container instance state started. * **state**: string: The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int: The count of the event. @@ -93,62 +144,30 @@ * **name**: string: The event name. * **type**: string: The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount +## ImageRegistryCredential ### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. +* **password**: string: The password for the private registry. +* **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". +* **username**: string (Required): The username for the private registry. -## ContainerGroupDiagnostics +## IpAddress ### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. +* **dnsNameLabel**: string: The Dns name label for the IP. +* **fqdn**: string (ReadOnly): The FQDN for the IP. +* **ip**: string: The IP exposed to the public internet. +* **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. +* **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. ## LogAnalytics ### Properties @@ -162,39 +181,37 @@ ### Additional Properties * **Additional Properties Type**: string -## DnsConfiguration +## Port ### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. +* **port**: int (Required): The port number. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ImageRegistryCredential +## ResourceLimits ### Properties -* **password**: string: The password for the private registry. -* **server**: string (Required): The Docker image registry server without a protocol such as "http" and "https". -* **username**: string (Required): The username for the private registry. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## ContainerGroupPropertiesInstanceView +## ResourceRequests ### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## IpAddress +## ResourceRequirements ### Properties -* **dnsNameLabel**: string: The Dns name label for the IP. -* **fqdn**: string (ReadOnly): The FQDN for the IP. -* **ip**: string: The IP exposed to the public internet. -* **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. -* **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## Port +## ResourceTags ### Properties -* **port**: int (Required): The port number. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. +### Additional Properties +* **Additional Properties Type**: string -## ContainerGroupNetworkProfile +## SecretVolume ### Properties -* **id**: string (Required): The identifier for a network profile. +### Additional Properties +* **Additional Properties Type**: string ## Volume ### Properties @@ -204,26 +221,9 @@ * **name**: string (Required): The name of the volume. * **secret**: [SecretVolume](#secretvolume): The secret volume. -## AzureFileVolume -### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. - -## GitRepoVolume -### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. - -## SecretVolume -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## VolumeMount ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2019-12-01/types.md b/generated/containerinstance/microsoft.containerinstance/2019-12-01/types.md index 5f881fb55b..b5cbb1207f 100644 --- a/generated/containerinstance/microsoft.containerinstance/2019-12-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2019-12-01/types.md @@ -12,6 +12,31 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -24,10 +49,9 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +## ContainerGroupNetworkProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **id**: string (Required): The identifier for a network profile. ## ContainerGroupProperties ### Properties @@ -49,10 +73,31 @@ * **sku**: 'Dedicated' | 'Standard' | string: The container group SKU. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerHttpGet +### Properties +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -66,12 +111,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -87,6 +126,24 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EncryptionProperties +### Properties +* **keyName**: string (Required): The encryption key name. +* **keyVersion**: string (Required): The encryption key version. +* **vaultBaseUrl**: string (Required): The keyvault base url. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -96,87 +153,17 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. -* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics - -## LogAnalyticsMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DnsConfiguration -### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. - -## EncryptionProperties -### Properties -* **keyName**: string (Required): The encryption key name. -* **keyVersion**: string (Required): The encryption key version. -* **vaultBaseUrl**: string (Required): The keyvault base url. - ## ImageRegistryCredential ### Properties * **password**: string: The password for the private registry. @@ -203,11 +190,6 @@ * **previousState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. * **restartCount**: int (ReadOnly): The number of times that the init container has been restarted. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -216,43 +198,61 @@ * **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. * **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +## LogAnalytics +### Properties +* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. +* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics + +## LogAnalyticsMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupNetworkProfile +## ResourceLimits ### Properties -* **id**: string (Required): The identifier for a network profile. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2020-11-01/types.md b/generated/containerinstance/microsoft.containerinstance/2020-11-01/types.md index 6b352c03e2..33b5e5abdb 100644 --- a/generated/containerinstance/microsoft.containerinstance/2020-11-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2020-11-01/types.md @@ -12,6 +12,31 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -24,10 +49,9 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +## ContainerGroupNetworkProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **id**: string (Required): The identifier for a network profile. ## ContainerGroupProperties ### Properties @@ -49,10 +73,32 @@ * **sku**: 'Dedicated' | 'Standard' | string: The container group SKU. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerHttpGet +### Properties +* **httpHeaders**: [HttpHeaders](#httpheaders): The HTTP headers. +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -66,12 +112,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -87,6 +127,24 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EncryptionProperties +### Properties +* **keyName**: string (Required): The encryption key name. +* **keyVersion**: string (Required): The encryption key version. +* **vaultBaseUrl**: string (Required): The keyvault base url. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -96,98 +154,21 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **httpHeaders**: [HttpHeaders](#httpheaders): The HTTP headers. -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## HttpHeaders -### Properties -* **name**: string: The header name. -* **value**: string: The header value. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. -* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics -* **workspaceResourceId**: [LogAnalyticsWorkspaceResourceId](#loganalyticsworkspaceresourceid): The workspace resource id for log analytics - -## LogAnalyticsMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LogAnalyticsWorkspaceResourceId -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DnsConfiguration -### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. - -## EncryptionProperties +## HttpHeaders ### Properties -* **keyName**: string (Required): The encryption key name. -* **keyVersion**: string (Required): The encryption key version. -* **vaultBaseUrl**: string (Required): The keyvault base url. +* **name**: string: The header name. +* **value**: string: The header value. ## ImageRegistryCredential ### Properties @@ -215,11 +196,6 @@ * **previousState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. * **restartCount**: int (ReadOnly): The number of times that the init container has been restarted. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -228,43 +204,67 @@ * **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. * **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +## LogAnalytics +### Properties +* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. +* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics +* **workspaceResourceId**: [LogAnalyticsWorkspaceResourceId](#loganalyticsworkspaceresourceid): The workspace resource id for log analytics + +## LogAnalyticsMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## LogAnalyticsWorkspaceResourceId +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupNetworkProfile +## ResourceLimits ### Properties -* **id**: string (Required): The identifier for a network profile. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2021-03-01/types.md b/generated/containerinstance/microsoft.containerinstance/2021-03-01/types.md index 203cecdbf1..defe2a7131 100644 --- a/generated/containerinstance/microsoft.containerinstance/2021-03-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2021-03-01/types.md @@ -12,6 +12,31 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -24,10 +49,9 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +## ContainerGroupNetworkProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **id**: string (Required): The identifier for a network profile. ## ContainerGroupProperties ### Properties @@ -49,10 +73,32 @@ * **sku**: 'Dedicated' | 'Standard' | string: The container group SKU. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerHttpGet +### Properties +* **httpHeaders**: [HttpHeaders](#httpheaders): The HTTP headers. +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -66,12 +112,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -87,6 +127,24 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EncryptionProperties +### Properties +* **keyName**: string (Required): The encryption key name. +* **keyVersion**: string (Required): The encryption key version. +* **vaultBaseUrl**: string (Required): The keyvault base url. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -96,98 +154,21 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **httpHeaders**: [HttpHeaders](#httpheaders): The HTTP headers. -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## HttpHeaders -### Properties -* **name**: string: The header name. -* **value**: string: The header value. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. -* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics -* **workspaceResourceId**: [LogAnalyticsWorkspaceResourceId](#loganalyticsworkspaceresourceid): The workspace resource id for log analytics - -## LogAnalyticsMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LogAnalyticsWorkspaceResourceId -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DnsConfiguration -### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. - -## EncryptionProperties +## HttpHeaders ### Properties -* **keyName**: string (Required): The encryption key name. -* **keyVersion**: string (Required): The encryption key version. -* **vaultBaseUrl**: string (Required): The keyvault base url. +* **name**: string: The header name. +* **value**: string: The header value. ## ImageRegistryCredential ### Properties @@ -215,11 +196,6 @@ * **previousState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. * **restartCount**: int (ReadOnly): The number of times that the init container has been restarted. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -228,43 +204,67 @@ * **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. * **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +## LogAnalytics +### Properties +* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. +* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics +* **workspaceResourceId**: [LogAnalyticsWorkspaceResourceId](#loganalyticsworkspaceresourceid): The workspace resource id for log analytics + +## LogAnalyticsMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## LogAnalyticsWorkspaceResourceId +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupNetworkProfile +## ResourceLimits ### Properties -* **id**: string (Required): The identifier for a network profile. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2021-07-01/types.md b/generated/containerinstance/microsoft.containerinstance/2021-07-01/types.md index f3a0359eec..360ce04c8d 100644 --- a/generated/containerinstance/microsoft.containerinstance/2021-07-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2021-07-01/types.md @@ -12,6 +12,31 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -24,11 +49,6 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -49,10 +69,37 @@ * **subnetIds**: [ContainerGroupSubnetId](#containergroupsubnetid)[]: The subnet resource IDs for a container group. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerGroupSubnetId +### Properties +* **id**: string (Required): Resource ID of virtual network and subnet. +* **name**: string: Friendly name for the subnet. + +## ContainerHttpGet +### Properties +* **httpHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers. +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -66,12 +113,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -87,6 +128,24 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EncryptionProperties +### Properties +* **keyName**: string (Required): The encryption key name. +* **keyVersion**: string (Required): The encryption key version. +* **vaultBaseUrl**: string (Required): The keyvault base url. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -96,93 +155,21 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **httpHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers. -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## HttpHeader -### Properties -* **name**: string: The header name. -* **value**: string: The header value. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. -* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics -* **workspaceResourceId**: string: The workspace resource id for log analytics - -## LogAnalyticsMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DnsConfiguration -### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. - -## EncryptionProperties +## HttpHeader ### Properties -* **keyName**: string (Required): The encryption key name. -* **keyVersion**: string (Required): The encryption key version. -* **vaultBaseUrl**: string (Required): The keyvault base url. +* **name**: string: The header name. +* **value**: string: The header value. ## ImageRegistryCredential ### Properties @@ -212,11 +199,6 @@ * **previousState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. * **restartCount**: int (ReadOnly): The number of times that the init container has been restarted. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -225,44 +207,62 @@ * **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. * **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +## LogAnalytics +### Properties +* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. +* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics +* **workspaceResourceId**: string: The workspace resource id for log analytics + +## LogAnalyticsMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupSubnetId +## ResourceLimits ### Properties -* **id**: string (Required): Resource ID of virtual network and subnet. -* **name**: string: Friendly name for the subnet. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2021-09-01/types.md b/generated/containerinstance/microsoft.containerinstance/2021-09-01/types.md index 57606d4d1f..324abfeb2d 100644 --- a/generated/containerinstance/microsoft.containerinstance/2021-09-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2021-09-01/types.md @@ -13,6 +13,31 @@ * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[]: The zones for the container group. +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -25,11 +50,6 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -50,10 +70,37 @@ * **subnetIds**: [ContainerGroupSubnetId](#containergroupsubnetid)[]: The subnet resource IDs for a container group. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerGroupSubnetId +### Properties +* **id**: string (Required): Resource ID of virtual network and subnet. +* **name**: string: Friendly name for the subnet. + +## ContainerHttpGet +### Properties +* **httpHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers. +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -67,12 +114,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -88,6 +129,24 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EncryptionProperties +### Properties +* **keyName**: string (Required): The encryption key name. +* **keyVersion**: string (Required): The encryption key version. +* **vaultBaseUrl**: string (Required): The keyvault base url. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -97,93 +156,21 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **httpHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers. -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## HttpHeader -### Properties -* **name**: string: The header name. -* **value**: string: The header value. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. -* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics -* **workspaceResourceId**: string: The workspace resource id for log analytics - -## LogAnalyticsMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DnsConfiguration -### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. - -## EncryptionProperties +## HttpHeader ### Properties -* **keyName**: string (Required): The encryption key name. -* **keyVersion**: string (Required): The encryption key version. -* **vaultBaseUrl**: string (Required): The keyvault base url. +* **name**: string: The header name. +* **value**: string: The header value. ## ImageRegistryCredential ### Properties @@ -213,11 +200,6 @@ * **previousState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. * **restartCount**: int (ReadOnly): The number of times that the init container has been restarted. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -226,44 +208,62 @@ * **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. * **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +## LogAnalytics +### Properties +* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. +* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics +* **workspaceResourceId**: string: The workspace resource id for log analytics + +## LogAnalyticsMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupSubnetId +## ResourceLimits ### Properties -* **id**: string (Required): Resource ID of virtual network and subnet. -* **name**: string: Friendly name for the subnet. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerinstance/microsoft.containerinstance/2021-10-01/types.md b/generated/containerinstance/microsoft.containerinstance/2021-10-01/types.md index bb271f8f69..134dc41016 100644 --- a/generated/containerinstance/microsoft.containerinstance/2021-10-01/types.md +++ b/generated/containerinstance/microsoft.containerinstance/2021-10-01/types.md @@ -13,6 +13,31 @@ * **type**: 'Microsoft.ContainerInstance/containerGroups' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[]: The zones for the container group. +## AzureFileVolume +### Properties +* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. +* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. +* **storageAccountKey**: string: The storage account access key used to access the Azure File share. +* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. + +## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## Container +### Properties +* **name**: string (Required): The user-provided name of the container instance. +* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. + +## ContainerExec +### Properties +* **command**: string[]: The commands to execute within the container. + +## ContainerGroupDiagnostics +### Properties +* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. + ## ContainerGroupIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the container group identity. This property will only be provided for a system assigned identity. @@ -25,11 +50,6 @@ ### Additional Properties * **Additional Properties Type**: [Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties](#components10wh5udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - ## ContainerGroupProperties ### Properties * **containers**: [Container](#container)[] (Required): The containers within the container group. @@ -50,10 +70,37 @@ * **subnetIds**: [ContainerGroupSubnetId](#containergroupsubnetid)[]: The subnet resource IDs for a container group. * **volumes**: [Volume](#volume)[]: The list of volumes that can be mounted by containers in this container group. -## Container +## ContainerGroupPropertiesInstanceView ### Properties -* **name**: string (Required): The user-provided name of the container instance. -* **properties**: [ContainerProperties](#containerproperties) (Required): The container instance properties. +* **events**: [Event](#event)[] (ReadOnly): The events of this container group. +* **state**: string (ReadOnly): The state of the container group. Only valid in response. + +## ContainerGroupSubnetId +### Properties +* **id**: string (Required): Resource ID of virtual network and subnet. +* **name**: string: Friendly name for the subnet. + +## ContainerHttpGet +### Properties +* **httpHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers. +* **path**: string: The path to probe. +* **port**: int (Required): The port number to probe. +* **scheme**: 'http' | 'https' | string: The scheme. + +## ContainerPort +### Properties +* **port**: int (Required): The port number exposed within the container group. +* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. + +## ContainerProbe +### Properties +* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe +* **failureThreshold**: int: The failure threshold. +* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe +* **initialDelaySeconds**: int: The initial delay seconds. +* **periodSeconds**: int: The period seconds. +* **successThreshold**: int: The success threshold. +* **timeoutSeconds**: int: The timeout seconds. ## ContainerProperties ### Properties @@ -67,12 +114,6 @@ * **resources**: [ResourceRequirements](#resourcerequirements) (Required): The resource requirements. * **volumeMounts**: [VolumeMount](#volumemount)[]: The volume mounts available to the container instance. -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - ## ContainerPropertiesInstanceView ### Properties * **currentState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. @@ -88,6 +129,24 @@ * **startTime**: string (ReadOnly): The date-time when the container instance state started. * **state**: string (ReadOnly): The state of the container instance. +## DnsConfiguration +### Properties +* **nameServers**: string[] (Required): The DNS servers for the container group. +* **options**: string: The DNS options for the container group. +* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. + +## EncryptionProperties +### Properties +* **keyName**: string (Required): The encryption key name. +* **keyVersion**: string (Required): The encryption key version. +* **vaultBaseUrl**: string (Required): The keyvault base url. + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + ## Event ### Properties * **count**: int (ReadOnly): The count of the event. @@ -97,93 +156,21 @@ * **name**: string (ReadOnly): The event name. * **type**: string (ReadOnly): The event type. -## ContainerProbe -### Properties -* **exec**: [ContainerExec](#containerexec): The container execution command, for liveness or readiness probe -* **failureThreshold**: int: The failure threshold. -* **httpGet**: [ContainerHttpGet](#containerhttpget): The container Http Get settings, for liveness or readiness probe -* **initialDelaySeconds**: int: The initial delay seconds. -* **periodSeconds**: int: The period seconds. -* **successThreshold**: int: The success threshold. -* **timeoutSeconds**: int: The timeout seconds. - -## ContainerExec -### Properties -* **command**: string[]: The commands to execute within the container. - -## ContainerHttpGet -### Properties -* **httpHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers. -* **path**: string: The path to probe. -* **port**: int (Required): The port number to probe. -* **scheme**: 'http' | 'https' | string: The scheme. - -## HttpHeader -### Properties -* **name**: string: The header name. -* **value**: string: The header value. - -## ContainerPort -### Properties -* **port**: int (Required): The port number exposed within the container group. -* **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): The resource limits. -* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. - -## ResourceLimits +## GitRepoVolume ### Properties -* **cpu**: int: The CPU limit of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int: The memory limit in GB of this container instance. +* **directory**: string: 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. +* **repository**: string (Required): Repository URL +* **revision**: string: Commit hash for the specified revision. ## GpuResource ### Properties * **count**: int (Required): The count of the GPU resource. * **sku**: 'K80' | 'P100' | 'V100' | string (Required): The SKU of the GPU resource. -## ResourceRequests -### Properties -* **cpu**: int (Required): The CPU request of this container instance. -* **gpu**: [GpuResource](#gpuresource): The GPU resource. -* **memoryInGB**: int (Required): The memory request in GB of this container instance. - -## VolumeMount -### Properties -* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). -* **name**: string (Required): The name of the volume mount. -* **readOnly**: bool: The flag indicating whether the volume mount is read-only. - -## ContainerGroupDiagnostics -### Properties -* **logAnalytics**: [LogAnalytics](#loganalytics): Container group log analytics information. - -## LogAnalytics -### Properties -* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. -* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. -* **workspaceId**: string (Required): The workspace id for log analytics -* **workspaceKey**: string (Required): The workspace key for log analytics -* **workspaceResourceId**: string: The workspace resource id for log analytics - -## LogAnalyticsMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DnsConfiguration -### Properties -* **nameServers**: string[] (Required): The DNS servers for the container group. -* **options**: string: The DNS options for the container group. -* **searchDomains**: string: The DNS search domains for hostname lookup in the container group. - -## EncryptionProperties +## HttpHeader ### Properties -* **keyName**: string (Required): The encryption key name. -* **keyVersion**: string (Required): The encryption key version. -* **vaultBaseUrl**: string (Required): The keyvault base url. +* **name**: string: The header name. +* **value**: string: The header value. ## ImageRegistryCredential ### Properties @@ -213,11 +200,6 @@ * **previousState**: [ContainerState](#containerstate) (ReadOnly): The container instance state. * **restartCount**: int (ReadOnly): The number of times that the init container has been restarted. -## ContainerGroupPropertiesInstanceView -### Properties -* **events**: [Event](#event)[] (ReadOnly): The events of this container group. -* **state**: string (ReadOnly): The state of the container group. Only valid in response. - ## IpAddress ### Properties * **dnsNameLabel**: string: The Dns name label for the IP. @@ -227,44 +209,62 @@ * **ports**: [Port](#port)[] (Required): The list of ports exposed on the container group. * **type**: 'Private' | 'Public' | string (Required): Specifies if the IP is exposed to the public internet or private VNET. +## LogAnalytics +### Properties +* **logType**: 'ContainerInsights' | 'ContainerInstanceLogs' | string: The log type to be used. +* **metadata**: [LogAnalyticsMetadata](#loganalyticsmetadata): Metadata for log analytics. +* **workspaceId**: string (Required): The workspace id for log analytics +* **workspaceKey**: string (Required): The workspace key for log analytics +* **workspaceResourceId**: string: The workspace resource id for log analytics + +## LogAnalyticsMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Port ### Properties * **port**: int (Required): The port number. * **protocol**: 'TCP' | 'UDP' | string: The protocol associated with the port. -## ContainerGroupSubnetId +## ResourceLimits ### Properties -* **id**: string (Required): Resource ID of virtual network and subnet. -* **name**: string: Friendly name for the subnet. +* **cpu**: int: The CPU limit of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int: The memory limit in GB of this container instance. -## Volume +## ResourceRequests ### Properties -* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. -* **emptyDir**: any: Any object -* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository -* **name**: string (Required): The name of the volume. -* **secret**: [SecretVolume](#secretvolume): The secret volume. +* **cpu**: int (Required): The CPU request of this container instance. +* **gpu**: [GpuResource](#gpuresource): The GPU resource. +* **memoryInGB**: int (Required): The memory request in GB of this container instance. -## AzureFileVolume +## ResourceRequirements ### Properties -* **readOnly**: bool: The flag indicating whether the Azure File shared mounted as a volume is read-only. -* **shareName**: string (Required): The name of the Azure File share to be mounted as a volume. -* **storageAccountKey**: string: The storage account access key used to access the Azure File share. -* **storageAccountName**: string (Required): The name of the storage account that contains the Azure File share. +* **limits**: [ResourceLimits](#resourcelimits): The resource limits. +* **requests**: [ResourceRequests](#resourcerequests) (Required): The resource requests. -## GitRepoVolume +## ResourceTags ### Properties -* **directory**: string: 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. -* **repository**: string (Required): Repository URL -* **revision**: string: Commit hash for the specified revision. +### Additional Properties +* **Additional Properties Type**: string ## SecretVolume ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Volume ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFile**: [AzureFileVolume](#azurefilevolume): The properties of the Azure File volume. Azure File shares are mounted as volumes. +* **emptyDir**: any: Any object +* **gitRepo**: [GitRepoVolume](#gitrepovolume): Represents a volume that is populated with the contents of a git repository +* **name**: string (Required): The name of the volume. +* **secret**: [SecretVolume](#secretvolume): The secret volume. + +## VolumeMount +### Properties +* **mountPath**: string (Required): The path within the container where the volume should be mounted. Must not contain colon (:). +* **name**: string (Required): The name of the volume mount. +* **readOnly**: bool: The flag indicating whether the volume mount is read-only. diff --git a/generated/containerregistry/log.out b/generated/containerregistry/log.out index 8e981172d1..1d475c7cda 100644 --- a/generated/containerregistry/log.out +++ b/generated/containerregistry/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.containerregistry-2021-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-12-01-preview/containerregistry.json:3391:5 @@ -19,10 +19,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseBody' with an un warning | PreCheck/SchemaMissingType | The schema 'InnerErrorDescription' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-12-01-preview/containerregistry.json:6000:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 21ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.containerregistry-2019-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json:2962:5 @@ -38,7 +38,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.containerregistry-2021-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:2022:5 @@ -51,10 +51,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseBody' with an un warning | PreCheck/SchemaMissingType | The schema 'InnerErrorDescription' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json:3269:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.containerregistry-2021-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json:3205:5 @@ -67,10 +67,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseBody' with an un warning | PreCheck/SchemaMissingType | The schema 'InnerErrorDescription' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-08-01-preview/containerregistry.json:5791:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.containerregistry-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json:2629:5 @@ -83,10 +83,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseBody' with an un warning | PreCheck/SchemaMissingType | The schema 'InnerErrorDescription' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json:5775:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 16ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.containerregistry-2020-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2020-11-01-preview/containerregistry.json:2629:5 @@ -99,74 +99,74 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseBody' with an un warning | PreCheck/SchemaMissingType | The schema 'InnerErrorDescription' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2020-11-01-preview/containerregistry.json:5748:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.containerregistry-2019-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-12-01-preview/containerregistry.json:1863:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-12-01-preview/containerregistry.json:4015:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.containerregistry-2019-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json:535:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.containerregistry-2019-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-05-01/containerregistry.json:2388:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerregistry-2019-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json:1981:5 warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json:2020:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.containerregistry-2017-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json:2427:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerregistry-2018-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json:1798:5 warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json:1837:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerregistry-2018-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json:1721:5 warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json:1765:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerregistry-2017-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistryNameCheckRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json:1017:5 @@ -251,10 +251,10 @@ warning | PreCheck/SchemaMissingType | The schema 'Source' with an undefined typ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json:1928:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.containerregistry-2017-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistryNameCheckRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json:397:5 @@ -298,7 +298,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.containerregistry-2016-06-27-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistryNameCheckRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json:314:5 @@ -322,4 +322,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json:474:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 46.11s. 32 files generated. +info | Autorest completed in 45.25s. 32 files generated. diff --git a/generated/containerregistry/microsoft.containerregistry/2016-06-27-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2016-06-27-preview/types.md index 09c5b5eaff..df39a4f46b 100644 --- a/generated/containerregistry/microsoft.containerregistry/2016-06-27-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2016-06-27-preview/types.md @@ -18,13 +18,13 @@ * **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. * **storageAccount**: [StorageAccountProperties](#storageaccountproperties) (Required): The properties of a storage account for a container registry. -## StorageAccountProperties -### Properties -* **accessKey**: string (Required): The access key to the storage account. -* **name**: string (Required): The name of the storage account. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## StorageAccountProperties +### Properties +* **accessKey**: string (Required): The access key to the storage account. +* **name**: string (Required): The name of the storage account. + diff --git a/generated/containerregistry/microsoft.containerregistry/2017-03-01/types.md b/generated/containerregistry/microsoft.containerregistry/2017-03-01/types.md index 1321ec7bcd..027e6ec814 100644 --- a/generated/containerregistry/microsoft.containerregistry/2017-03-01/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2017-03-01/types.md @@ -17,24 +17,6 @@ * **ApiVersion**: 2017-03-01 * **Output**: [RegistryListCredentialsResult](#registrylistcredentialsresult) -## RegistryPropertiesCreateParameters -### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **provisioningState**: 'Creating' | 'Succeeded' (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **storageAccount**: [StorageAccountParameters](#storageaccountparameters) (Required): The parameters of a storage account for a container registry. - -## StorageAccountParameters -### Properties -* **accessKey**: string (Required, WriteOnly): The access key to the storage account. -* **name**: string (Required): The name of the storage account. - -## Sku -### Properties -* **name**: string (Required): The SKU name of the container registry. Required for registry creation. Allowed value: Basic. -* **tier**: 'Basic' | string (ReadOnly): The SKU tier based on the SKU name. - ## RegistryCreateParametersTags ### Properties ### Additional Properties @@ -50,3 +32,21 @@ * **name**: 'password' | 'password2' (ReadOnly): The password name. * **value**: string (ReadOnly): The password value. +## RegistryPropertiesCreateParameters +### Properties +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **provisioningState**: 'Creating' | 'Succeeded' (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **storageAccount**: [StorageAccountParameters](#storageaccountparameters) (Required): The parameters of a storage account for a container registry. + +## Sku +### Properties +* **name**: string (Required): The SKU name of the container registry. Required for registry creation. Allowed value: Basic. +* **tier**: 'Basic' | string (ReadOnly): The SKU tier based on the SKU name. + +## StorageAccountParameters +### Properties +* **accessKey**: string (Required, WriteOnly): The access key to the storage account. +* **name**: string (Required): The name of the storage account. + diff --git a/generated/containerregistry/microsoft.containerregistry/2017-06-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2017-06-01-preview/types.md index 9656683eff..2c7d5da918 100644 --- a/generated/containerregistry/microsoft.containerregistry/2017-06-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2017-06-01-preview/types.md @@ -44,60 +44,53 @@ * **ApiVersion**: 2017-06-01-preview * **Output**: [EventListResult](#eventlistresult) -## RegistryProperties -### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): The properties of a storage account for a container registry. Only applicable to Basic SKU. - -## Status +## Actor ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. -## StorageAccountProperties +## Event ### Properties -* **id**: string (Required): The resource ID of the storage account. +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. -## Sku +## EventContent ### Properties -* **name**: 'Basic' | 'Managed_Basic' | 'Managed_Premium' | 'Managed_Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Managed' | string (ReadOnly): The SKU tier based on the SKU name. +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. -## ResourceTags +## EventListResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. -## ReplicationProperties +## EventRequestMessage ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. -## ResourceTags +## EventRequestMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## WebhookPropertiesCreateParameters -### Properties -* **actions**: 'delete' | 'push' | string[] (Required): The list of actions that trigger the webhook to post notifications. -* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **scope**: 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. -* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. -* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. - -## WebhookPropertiesCreateParametersCustomHeaders +## EventResponseMessage ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. -## WebhookCreateParametersTags +## EventResponseMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -112,38 +105,19 @@ * **name**: 'password' | 'password2' (ReadOnly): The password name. * **value**: string (ReadOnly): The password value. -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent +## RegistryProperties ### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): The properties of a storage account for a container registry. Only applicable to Basic SKU. -## Actor +## ReplicationProperties ### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. ## Request ### Properties @@ -153,11 +127,36 @@ * **method**: string (ReadOnly): The request method that generated the event. * **useragent**: string (ReadOnly): The user agent header of the request. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: 'Basic' | 'Managed_Basic' | 'Managed_Premium' | 'Managed_Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Managed' | string (ReadOnly): The SKU tier based on the SKU name. + ## Source ### Properties * **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. * **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. + +## StorageAccountProperties +### Properties +* **id**: string (Required): The resource ID of the storage account. + ## Target ### Properties * **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. @@ -168,20 +167,21 @@ * **tag**: string (ReadOnly): The tag name. * **url**: string (ReadOnly): The direct URL to the content. -## EventRequestMessageHeaders +## WebhookCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventResponseMessage +## WebhookPropertiesCreateParameters ### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. +* **actions**: 'delete' | 'push' | string[] (Required): The list of actions that trigger the webhook to post notifications. +* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **scope**: 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. +* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. +* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## EventResponseMessageHeaders +## WebhookPropertiesCreateParametersCustomHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/containerregistry/microsoft.containerregistry/2017-10-01/types.md b/generated/containerregistry/microsoft.containerregistry/2017-10-01/types.md index 565427b8da..c693343427 100644 --- a/generated/containerregistry/microsoft.containerregistry/2017-10-01/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2017-10-01/types.md @@ -44,80 +44,67 @@ * **ApiVersion**: 2017-10-01 * **Output**: [EventListResult](#eventlistresult) -## RegistryProperties -### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): The properties of a storage account for a container registry. Only applicable to Classic SKU. - -## NetworkRuleSet -### Properties -* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. - -## IPRule +## Actor ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. -## VirtualNetworkRule +## Event ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. -## Status +## EventContent ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. -## StorageAccountProperties +## EventListResult ### Properties -* **id**: string (Required): The resource ID of the storage account. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. -## Sku +## EventRequestMessage ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. -## ResourceTags +## EventRequestMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## ReplicationProperties +## EventResponseMessage ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. -## ResourceTags +## EventResponseMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## WebhookPropertiesCreateParameters -### Properties -* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. -* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **scope**: 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. -* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. -* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. - -## WebhookPropertiesCreateParametersCustomHeaders +## IPRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## WebhookCreateParametersTags +## NetworkRuleSet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. ## RegistryListCredentialsResult ### Properties @@ -129,38 +116,20 @@ * **name**: 'password' | 'password2' (ReadOnly): The password name. * **value**: string (ReadOnly): The password value. -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent +## RegistryProperties ### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): The properties of a storage account for a container registry. Only applicable to Classic SKU. -## Actor +## ReplicationProperties ### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. ## Request ### Properties @@ -170,11 +139,36 @@ * **method**: string (ReadOnly): The request method that generated the event. * **useragent**: string (ReadOnly): The user agent header of the request. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + ## Source ### Properties * **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. * **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. + +## StorageAccountProperties +### Properties +* **id**: string (Required): The resource ID of the storage account. + ## Target ### Properties * **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. @@ -187,20 +181,26 @@ * **url**: string (ReadOnly): The direct URL to the content. * **version**: string (ReadOnly): The version of the artifact. -## EventRequestMessageHeaders +## VirtualNetworkRule +### Properties +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventResponseMessage +## WebhookPropertiesCreateParameters ### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. +* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. +* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **scope**: 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. +* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. +* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## EventResponseMessageHeaders +## WebhookPropertiesCreateParametersCustomHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/containerregistry/microsoft.containerregistry/2018-02-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2018-02-01-preview/types.md index 96519ce2ae..278b2dc9c2 100644 --- a/generated/containerregistry/microsoft.containerregistry/2018-02-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2018-02-01-preview/types.md @@ -30,40 +30,25 @@ * **ApiVersion**: 2018-02-01-preview * **Output**: [SourceRepositoryProperties](#sourcerepositoryproperties) -## BuildTaskProperties -### Properties -* **alias**: string (Required): The alternative updatable name for a build task. -* **creationDate**: string (ReadOnly): The creation date of build task. -* **platform**: [PlatformProperties](#platformproperties) (Required): The platform properties against which the build has to happen. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of a build. -* **sourceRepository**: [SourceRepositoryProperties](#sourcerepositoryproperties) (Required): The properties of the source code repository. -* **status**: 'Disabled' | 'Enabled' | string: The current status of build task. -* **timeout**: int: Build timeout in seconds. - -## PlatformProperties -### Properties -* **cpu**: int: The CPU configuration in terms of number of cores required for the build. -* **osType**: 'Linux' | 'Windows' | string (Required): The operating system type required for the build. - -## SourceRepositoryProperties +## BaseImageDependency ### Properties -* **isCommitTriggerEnabled**: bool: The value of this property indicates whether the source control commit trigger is enabled or not. -* **repositoryUrl**: string (Required): The full URL to the source code repository -* **sourceControlAuthProperties**: [SourceControlAuthInfo](#sourcecontrolauthinfo): The authorization properties for accessing the source code repository. -* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. +* **digest**: string: The sha256-based digest of the image manifest. +* **registry**: string: The registry login server. +* **repository**: string: The repository name. +* **tag**: string: The tag name. +* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. -## SourceControlAuthInfo +## BuildArgument ### Properties -* **expiresIn**: int: Time in seconds that the token remains valid -* **refreshToken**: string: The refresh token used to refresh the access token. -* **scope**: string: The scope of the access token. -* **token**: string (Required): The access token used to access the source control provider. -* **tokenType**: 'OAuth' | 'PAT' | string: The type of Auth token. +* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. +* **name**: string (Required): The name of the argument. +* **type**: 'DockerBuildArgument' | string (Required): The type of the argument. +* **value**: string (Required): The value of the argument. -## ResourceTags +## BuildArgumentList ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. +* **value**: [BuildArgument](#buildargument)[] (ReadOnly): The collection value. ## BuildStepProperties * **Discriminator**: type @@ -84,25 +69,40 @@ * **type**: 'Docker' (Required): The type of the step. -## BaseImageDependency +## BuildTaskProperties ### Properties -* **digest**: string: The sha256-based digest of the image manifest. -* **registry**: string: The registry login server. -* **repository**: string: The repository name. -* **tag**: string: The tag name. -* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. +* **alias**: string (Required): The alternative updatable name for a build task. +* **creationDate**: string (ReadOnly): The creation date of build task. +* **platform**: [PlatformProperties](#platformproperties) (Required): The platform properties against which the build has to happen. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of a build. +* **sourceRepository**: [SourceRepositoryProperties](#sourcerepositoryproperties) (Required): The properties of the source code repository. +* **status**: 'Disabled' | 'Enabled' | string: The current status of build task. +* **timeout**: int: Build timeout in seconds. -## BuildArgument +## PlatformProperties ### Properties -* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. -* **name**: string (Required): The name of the argument. -* **type**: 'DockerBuildArgument' | string (Required): The type of the argument. -* **value**: string (Required): The value of the argument. +* **cpu**: int: The CPU configuration in terms of number of cores required for the build. +* **osType**: 'Linux' | 'Windows' | string (Required): The operating system type required for the build. -## BuildArgumentList +## ResourceTags ### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next set of paged results. -* **value**: [BuildArgument](#buildargument)[] (ReadOnly): The collection value. +### Additional Properties +* **Additional Properties Type**: string + +## SourceControlAuthInfo +### Properties +* **expiresIn**: int: Time in seconds that the token remains valid +* **refreshToken**: string: The refresh token used to refresh the access token. +* **scope**: string: The scope of the access token. +* **token**: string (Required): The access token used to access the source control provider. +* **tokenType**: 'OAuth' | 'PAT' | string: The type of Auth token. + +## SourceRepositoryProperties +### Properties +* **isCommitTriggerEnabled**: bool: The value of this property indicates whether the source control commit trigger is enabled or not. +* **repositoryUrl**: string (Required): The full URL to the source code repository +* **sourceControlAuthProperties**: [SourceControlAuthInfo](#sourcecontrolauthinfo): The authorization properties for accessing the source code repository. +* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. ## SourceRepositoryProperties ### Properties diff --git a/generated/containerregistry/microsoft.containerregistry/2018-09-01/types.md b/generated/containerregistry/microsoft.containerregistry/2018-09-01/types.md index 5593f9f321..f2eca8e6d2 100644 --- a/generated/containerregistry/microsoft.containerregistry/2018-09-01/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2018-09-01/types.md @@ -26,22 +26,38 @@ * **ApiVersion**: 2018-09-01 * **Output**: [RunGetLogResult](#rungetlogresult) -## TaskProperties -### Properties -* **agentConfiguration**: [AgentProperties](#agentproperties): The properties that determine the run agent configuration. -* **creationDate**: string (ReadOnly): The creation date of task. -* **credentials**: [Credentials](#credentials): The parameters that describes a set of credentials that will be used when a run is invoked. -* **platform**: [PlatformProperties](#platformproperties) (Required): The platform properties against which the run has to happen. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of a run. -* **status**: 'Disabled' | 'Enabled' | string: The current status of task. -* **step**: [TaskStepProperties](#taskstepproperties) (Required): Base properties for any task step. -* **timeout**: int: Run timeout in seconds. -* **trigger**: [TriggerProperties](#triggerproperties): The properties of a trigger. - ## AgentProperties ### Properties * **cpu**: int: The CPU configuration in terms of number of cores required for the run. +## Argument +### Properties +* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. +* **name**: string (Required): The name of the argument. +* **value**: string (Required): The value of the argument. + +## AuthInfo +### Properties +* **expiresIn**: int: Time in seconds that the token remains valid +* **refreshToken**: string: The refresh token used to refresh the access token. +* **scope**: string: The scope of the access token. +* **token**: string (Required): The access token used to access the source control provider. +* **tokenType**: 'OAuth' | 'PAT' | string (Required): The type of Auth token. + +## BaseImageDependency +### Properties +* **digest**: string: The sha256-based digest of the image manifest. +* **registry**: string: The registry login server. +* **repository**: string: The repository name. +* **tag**: string: The tag name. +* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. + +## BaseImageTrigger +### Properties +* **baseImageTriggerType**: 'All' | 'Runtime' | string (Required): The type of the auto trigger for base image dependency updates. +* **name**: string (Required): The name of the trigger. +* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. + ## Credentials ### Properties * **customRegistries**: [CredentialsCustomRegistries](#credentialscustomregistries): Describes the credential parameters for accessing other custom registries. The key @@ -59,6 +75,26 @@ the value of the item will be the registry credentials for accessing the registr * **password**: [SecretObject](#secretobject): Describes the properties of a secret object value. * **userName**: [SecretObject](#secretobject): Describes the properties of a secret object value. +## PlatformProperties +### Properties +* **architecture**: 'amd64' | 'arm' | 'x86' | string: The OS architecture. +* **os**: 'Linux' | 'Windows' | string (Required): The operating system type required for the run. +* **variant**: 'v6' | 'v7' | 'v8' | string: Variant of the CPU. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RunGetLogResult +### Properties +* **logLink**: string (ReadOnly): The link to logs for a run on a azure container registry. + ## SecretObject ### Properties * **type**: 'Opaque' | string: The type of the secret object which determines how the value of the secret object has to be @@ -67,17 +103,57 @@ interpreted. based on the type of the secret object. If the type is Opaque, the value will be used as is without any modification. +## SetValue +### Properties +* **isSecret**: bool: Flag to indicate whether the value represents a secret or not. +* **name**: string (Required): The name of the overridable value. +* **value**: string (Required): The overridable value. + +## SourceProperties +### Properties +* **branch**: string: The branch name of the source code. +* **repositoryUrl**: string (Required): The full URL to the source code repository +* **sourceControlAuthProperties**: [AuthInfo](#authinfo): The authorization properties for accessing the source code repository. +* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. + ## SourceRegistryCredentials ### Properties * **loginMode**: 'Default' | 'None' | string: 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. -## PlatformProperties +## SourceTrigger ### Properties -* **architecture**: 'amd64' | 'arm' | 'x86' | string: The OS architecture. -* **os**: 'Linux' | 'Windows' | string (Required): The operating system type required for the run. -* **variant**: 'v6' | 'v7' | 'v8' | string: Variant of the CPU. +* **name**: string (Required): The name of the trigger. +* **sourceRepository**: [SourceProperties](#sourceproperties) (Required): The properties of the source code repository. +* **sourceTriggerEvents**: 'commit' | 'pullrequest' | string[] (Required): The source event corresponding to the trigger. +* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. + +## SourceUploadDefinition +### Properties +* **relativePath**: string (ReadOnly): The relative path to the source. This is used to submit the subsequent queue build request. +* **uploadUrl**: string (ReadOnly): The URL where the client can upload the source. + +## Task +### Properties +* **id**: string (ReadOnly): The resource ID. +* **location**: string (ReadOnly): The location of the resource. This cannot be changed after the resource is created. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [TaskProperties](#taskproperties) (ReadOnly): The properties of a task. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## TaskProperties +### Properties +* **agentConfiguration**: [AgentProperties](#agentproperties): The properties that determine the run agent configuration. +* **creationDate**: string (ReadOnly): The creation date of task. +* **credentials**: [Credentials](#credentials): The parameters that describes a set of credentials that will be used when a run is invoked. +* **platform**: [PlatformProperties](#platformproperties) (Required): The platform properties against which the run has to happen. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of a run. +* **status**: 'Disabled' | 'Enabled' | string: The current status of task. +* **step**: [TaskStepProperties](#taskstepproperties) (Required): Base properties for any task step. +* **timeout**: int: Run timeout in seconds. +* **trigger**: [TriggerProperties](#triggerproperties): The properties of a trigger. ## TaskStepProperties * **Discriminator**: type @@ -111,84 +187,8 @@ the source registry during the run. * **valuesFilePath**: string: The task values/parameters file path relative to the source context. -## BaseImageDependency -### Properties -* **digest**: string: The sha256-based digest of the image manifest. -* **registry**: string: The registry login server. -* **repository**: string: The repository name. -* **tag**: string: The tag name. -* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. - -## Argument -### Properties -* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. -* **name**: string (Required): The name of the argument. -* **value**: string (Required): The value of the argument. - -## SetValue -### Properties -* **isSecret**: bool: Flag to indicate whether the value represents a secret or not. -* **name**: string (Required): The name of the overridable value. -* **value**: string (Required): The overridable value. - ## TriggerProperties ### Properties * **baseImageTrigger**: [BaseImageTrigger](#baseimagetrigger): The trigger based on base image dependency. * **sourceTriggers**: [SourceTrigger](#sourcetrigger)[]: The collection of triggers based on source code repository. -## BaseImageTrigger -### Properties -* **baseImageTriggerType**: 'All' | 'Runtime' | string (Required): The type of the auto trigger for base image dependency updates. -* **name**: string (Required): The name of the trigger. -* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. - -## SourceTrigger -### Properties -* **name**: string (Required): The name of the trigger. -* **sourceRepository**: [SourceProperties](#sourceproperties) (Required): The properties of the source code repository. -* **sourceTriggerEvents**: 'commit' | 'pullrequest' | string[] (Required): The source event corresponding to the trigger. -* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. - -## SourceProperties -### Properties -* **branch**: string: The branch name of the source code. -* **repositoryUrl**: string (Required): The full URL to the source code repository -* **sourceControlAuthProperties**: [AuthInfo](#authinfo): The authorization properties for accessing the source code repository. -* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. - -## AuthInfo -### Properties -* **expiresIn**: int: Time in seconds that the token remains valid -* **refreshToken**: string: The refresh token used to refresh the access token. -* **scope**: string: The scope of the access token. -* **token**: string (Required): The access token used to access the source control provider. -* **tokenType**: 'OAuth' | 'PAT' | string (Required): The type of Auth token. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SourceUploadDefinition -### Properties -* **relativePath**: string (ReadOnly): The relative path to the source. This is used to submit the subsequent queue build request. -* **uploadUrl**: string (ReadOnly): The URL where the client can upload the source. - -## Task -### Properties -* **id**: string (ReadOnly): The resource ID. -* **location**: string (ReadOnly): The location of the resource. This cannot be changed after the resource is created. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [TaskProperties](#taskproperties) (ReadOnly): The properties of a task. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RunGetLogResult -### Properties -* **logLink**: string (ReadOnly): The link to logs for a run on a azure container registry. - diff --git a/generated/containerregistry/microsoft.containerregistry/2019-04-01/types.md b/generated/containerregistry/microsoft.containerregistry/2019-04-01/types.md index 1c75649032..859d69b9f9 100644 --- a/generated/containerregistry/microsoft.containerregistry/2019-04-01/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2019-04-01/types.md @@ -27,41 +27,37 @@ * **ApiVersion**: 2019-04-01 * **Output**: [RunGetLogResult](#rungetlogresult) -## IdentityProperties +## AgentProperties ### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityPropertiesUserAssignedIdentities](#identitypropertiesuserassignedidentities): The list of user 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}'. +* **cpu**: int: The CPU configuration in terms of number of cores required for the run. -## IdentityPropertiesUserAssignedIdentities +## Argument ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. +* **name**: string (Required): The name of the argument. +* **value**: string (Required): The value of the argument. -## UserIdentityProperties +## AuthInfo ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **expiresIn**: int: Time in seconds that the token remains valid +* **refreshToken**: string: The refresh token used to refresh the access token. +* **scope**: string: The scope of the access token. +* **token**: string (Required): The access token used to access the source control provider. +* **tokenType**: 'OAuth' | 'PAT' | string (Required): The type of Auth token. -## TaskProperties +## BaseImageDependency ### Properties -* **agentConfiguration**: [AgentProperties](#agentproperties): The properties that determine the run agent configuration. -* **creationDate**: string (ReadOnly): The creation date of task. -* **credentials**: [Credentials](#credentials): The parameters that describes a set of credentials that will be used when a run is invoked. -* **platform**: [PlatformProperties](#platformproperties) (Required): The platform properties against which the run has to happen. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of a run. -* **status**: 'Disabled' | 'Enabled' | string: The current status of task. -* **step**: [TaskStepProperties](#taskstepproperties) (Required): Base properties for any task step. -* **timeout**: int: Run timeout in seconds. -* **trigger**: [TriggerProperties](#triggerproperties): The properties of a trigger. +* **digest**: string: The sha256-based digest of the image manifest. +* **registry**: string: The registry login server. +* **repository**: string: The repository name. +* **tag**: string: The tag name. +* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. -## AgentProperties +## BaseImageTrigger ### Properties -* **cpu**: int: The CPU configuration in terms of number of cores required for the run. +* **baseImageTriggerType**: 'All' | 'Runtime' | string (Required): The type of the auto trigger for base image dependency updates. +* **name**: string (Required): The name of the trigger. +* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. ## Credentials ### Properties @@ -85,6 +81,41 @@ source of authentication used for accessing the registry. * **password**: [SecretObject](#secretobject): Describes the properties of a secret object value. * **userName**: [SecretObject](#secretobject): Describes the properties of a secret object value. +## IdentityProperties +### Properties +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityPropertiesUserAssignedIdentities](#identitypropertiesuserassignedidentities): The list of user 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}'. + +## IdentityPropertiesUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) + +## PlatformProperties +### Properties +* **architecture**: 'amd64' | 'arm' | 'x86' | string: The OS architecture. +* **os**: 'Linux' | 'Windows' | string (Required): The operating system type required for the run. +* **variant**: 'v6' | 'v7' | 'v8' | string: Variant of the CPU. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RunGetLogResult +### Properties +* **logLink**: string (ReadOnly): The link to logs for a run on a azure container registry. + ## SecretObject ### Properties * **type**: 'Opaque' | 'Vaultsecret' | string: The type of the secret object which determines how the value of the secret object has to be @@ -93,17 +124,58 @@ interpreted. based on the type of the secret object. If the type is Opaque, the value will be used as is without any modification. +## SetValue +### Properties +* **isSecret**: bool: Flag to indicate whether the value represents a secret or not. +* **name**: string (Required): The name of the overridable value. +* **value**: string (Required): The overridable value. + +## SourceProperties +### Properties +* **branch**: string: The branch name of the source code. +* **repositoryUrl**: string (Required): The full URL to the source code repository +* **sourceControlAuthProperties**: [AuthInfo](#authinfo): The authorization properties for accessing the source code repository. +* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. + ## SourceRegistryCredentials ### Properties * **loginMode**: 'Default' | 'None' | string: 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. -## PlatformProperties +## SourceTrigger ### Properties -* **architecture**: 'amd64' | 'arm' | 'x86' | string: The OS architecture. -* **os**: 'Linux' | 'Windows' | string (Required): The operating system type required for the run. -* **variant**: 'v6' | 'v7' | 'v8' | string: Variant of the CPU. +* **name**: string (Required): The name of the trigger. +* **sourceRepository**: [SourceProperties](#sourceproperties) (Required): The properties of the source code repository. +* **sourceTriggerEvents**: 'commit' | 'pullrequest' | string[] (Required): The source event corresponding to the trigger. +* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. + +## SourceUploadDefinition +### Properties +* **relativePath**: string (ReadOnly): The relative path to the source. This is used to submit the subsequent queue build request. +* **uploadUrl**: string (ReadOnly): The URL where the client can upload the source. + +## Task +### Properties +* **id**: string (ReadOnly): The resource ID. +* **identity**: [IdentityProperties](#identityproperties) (ReadOnly): Managed identity for the resource. +* **location**: string (ReadOnly): The location of the resource. This cannot be changed after the resource is created. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [TaskProperties](#taskproperties) (ReadOnly): The properties of a task. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## TaskProperties +### Properties +* **agentConfiguration**: [AgentProperties](#agentproperties): The properties that determine the run agent configuration. +* **creationDate**: string (ReadOnly): The creation date of task. +* **credentials**: [Credentials](#credentials): The parameters that describes a set of credentials that will be used when a run is invoked. +* **platform**: [PlatformProperties](#platformproperties) (Required): The platform properties against which the run has to happen. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of a run. +* **status**: 'Disabled' | 'Enabled' | string: The current status of task. +* **step**: [TaskStepProperties](#taskstepproperties) (Required): Base properties for any task step. +* **timeout**: int: Run timeout in seconds. +* **trigger**: [TriggerProperties](#triggerproperties): The properties of a trigger. ## TaskStepProperties * **Discriminator**: type @@ -137,92 +209,20 @@ the source registry during the run. * **valuesFilePath**: string: The task values/parameters file path relative to the source context. -## BaseImageDependency -### Properties -* **digest**: string: The sha256-based digest of the image manifest. -* **registry**: string: The registry login server. -* **repository**: string: The repository name. -* **tag**: string: The tag name. -* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. - -## Argument -### Properties -* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. -* **name**: string (Required): The name of the argument. -* **value**: string (Required): The value of the argument. - -## SetValue -### Properties -* **isSecret**: bool: Flag to indicate whether the value represents a secret or not. -* **name**: string (Required): The name of the overridable value. -* **value**: string (Required): The overridable value. - -## TriggerProperties -### Properties -* **baseImageTrigger**: [BaseImageTrigger](#baseimagetrigger): The trigger based on base image dependency. -* **sourceTriggers**: [SourceTrigger](#sourcetrigger)[]: The collection of triggers based on source code repository. -* **timerTriggers**: [TimerTrigger](#timertrigger)[]: The collection of timer triggers. - -## BaseImageTrigger -### Properties -* **baseImageTriggerType**: 'All' | 'Runtime' | string (Required): The type of the auto trigger for base image dependency updates. -* **name**: string (Required): The name of the trigger. -* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. - -## SourceTrigger -### Properties -* **name**: string (Required): The name of the trigger. -* **sourceRepository**: [SourceProperties](#sourceproperties) (Required): The properties of the source code repository. -* **sourceTriggerEvents**: 'commit' | 'pullrequest' | string[] (Required): The source event corresponding to the trigger. -* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. - -## SourceProperties -### Properties -* **branch**: string: The branch name of the source code. -* **repositoryUrl**: string (Required): The full URL to the source code repository -* **sourceControlAuthProperties**: [AuthInfo](#authinfo): The authorization properties for accessing the source code repository. -* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. - -## AuthInfo -### Properties -* **expiresIn**: int: Time in seconds that the token remains valid -* **refreshToken**: string: The refresh token used to refresh the access token. -* **scope**: string: The scope of the access token. -* **token**: string (Required): The access token used to access the source control provider. -* **tokenType**: 'OAuth' | 'PAT' | string (Required): The type of Auth token. - ## TimerTrigger ### Properties * **name**: string (Required): The name of the trigger. * **schedule**: string (Required): The CRON expression for the task schedule * **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SourceUploadDefinition -### Properties -* **relativePath**: string (ReadOnly): The relative path to the source. This is used to submit the subsequent queue build request. -* **uploadUrl**: string (ReadOnly): The URL where the client can upload the source. - -## Task -### Properties -* **id**: string (ReadOnly): The resource ID. -* **identity**: [IdentityProperties](#identityproperties) (ReadOnly): Managed identity for the resource. -* **location**: string (ReadOnly): The location of the resource. This cannot be changed after the resource is created. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [TaskProperties](#taskproperties) (ReadOnly): The properties of a task. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## ResourceTags +## TriggerProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **baseImageTrigger**: [BaseImageTrigger](#baseimagetrigger): The trigger based on base image dependency. +* **sourceTriggers**: [SourceTrigger](#sourcetrigger)[]: The collection of triggers based on source code repository. +* **timerTriggers**: [TimerTrigger](#timertrigger)[]: The collection of timer triggers. -## RunGetLogResult +## UserIdentityProperties ### Properties -* **logLink**: string (ReadOnly): The link to logs for a run on a azure container registry. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. diff --git a/generated/containerregistry/microsoft.containerregistry/2019-05-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2019-05-01-preview/types.md index d0f21eb0c3..b8117a2e77 100644 --- a/generated/containerregistry/microsoft.containerregistry/2019-05-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2019-05-01-preview/types.md @@ -20,6 +20,11 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.ContainerRegistry/registries/tokens' (ReadOnly, DeployTimeConstant): The resource type +## ActiveDirectoryObject +### Properties +* **objectId**: string: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. +* **tenantId**: string: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. + ## ScopeMapProperties ### Properties * **actions**: string[] (Required): The list of scoped permissions for registry artifacts. @@ -39,13 +44,12 @@ repositories/repository-name/metadata/write * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. -## TokenProperties +## TokenCertificate ### Properties -* **creationDate**: string (ReadOnly): The creation date of scope map. -* **credentials**: [TokenCredentialsProperties](#tokencredentialsproperties): The properties of the credentials that can be used for authenticating the token. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. -* **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. +* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. +* **expiry**: string: The expiry datetime of the certificate. +* **name**: 'certificate1' | 'certificate2' | string +* **thumbprint**: string: The thumbprint of the certificate. ## TokenCredentialsProperties ### Properties @@ -53,18 +57,6 @@ repositories/repository-name/metadata/write * **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate * **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword -## ActiveDirectoryObject -### Properties -* **objectId**: string: The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry. -* **tenantId**: string: The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry. - -## TokenCertificate -### Properties -* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. -* **expiry**: string: The expiry datetime of the certificate. -* **name**: 'certificate1' | 'certificate2' | string -* **thumbprint**: string: The thumbprint of the certificate. - ## TokenPassword ### Properties * **creationTime**: string: The creation datetime of the password. @@ -72,3 +64,11 @@ repositories/repository-name/metadata/write * **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" * **value**: string (ReadOnly): The password value. +## TokenProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of scope map. +* **credentials**: [TokenCredentialsProperties](#tokencredentialsproperties): The properties of the credentials that can be used for authenticating the token. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. +* **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. + diff --git a/generated/containerregistry/microsoft.containerregistry/2019-05-01/types.md b/generated/containerregistry/microsoft.containerregistry/2019-05-01/types.md index d034ca0c16..f465782ce5 100644 --- a/generated/containerregistry/microsoft.containerregistry/2019-05-01/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2019-05-01/types.md @@ -44,102 +44,77 @@ * **ApiVersion**: 2019-05-01 * **Output**: [EventListResult](#eventlistresult) -## RegistryProperties -### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): The properties of a storage account for a container registry. Only applicable to Classic SKU. - -## NetworkRuleSet -### Properties -* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. - -## IPRule -### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. - -## Policies -### Properties -* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. -* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. - -## QuarantinePolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## RetentionPolicy +## Actor ### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. -## TrustPolicy +## Event ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. -## Status +## EventContent ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. -## StorageAccountProperties +## EventListResult ### Properties -* **id**: string (Required): The resource ID of the storage account. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. -## Sku +## EventRequestMessage ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. -## ResourceTags +## EventRequestMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## ReplicationProperties +## EventResponseMessage ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. -## ResourceTags +## EventResponseMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## WebhookPropertiesCreateParameters +## IPRule ### Properties -* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. -* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. -* **scope**: 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. -* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. -* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## WebhookPropertiesCreateParametersCustomHeaders +## NetworkRuleSet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. -## WebhookCreateParametersTags +## Policies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. +* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. + +## QuarantinePolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. ## RegistryListCredentialsResult ### Properties @@ -151,38 +126,21 @@ * **name**: 'password' | 'password2' (ReadOnly): The password name. * **value**: string (ReadOnly): The password value. -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent +## RegistryProperties ### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): The properties of a storage account for a container registry. Only applicable to Classic SKU. -## Actor +## ReplicationProperties ### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. ## Request ### Properties @@ -192,11 +150,42 @@ * **method**: string (ReadOnly): The request method that generated the event. * **useragent**: string (ReadOnly): The user agent header of the request. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionPolicy +### Properties +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + +## Sku +### Properties +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + ## Source ### Properties * **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. * **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. + +## StorageAccountProperties +### Properties +* **id**: string (Required): The resource ID of the storage account. + ## Target ### Properties * **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. @@ -209,20 +198,31 @@ * **url**: string (ReadOnly): The direct URL to the content. * **version**: string (ReadOnly): The version of the artifact. -## EventRequestMessageHeaders +## TrustPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventResponseMessage +## WebhookPropertiesCreateParameters ### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. +* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. +* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the container registry at the time the operation was called. +* **scope**: 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. +* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. +* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## EventResponseMessageHeaders +## WebhookPropertiesCreateParametersCustomHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/containerregistry/microsoft.containerregistry/2019-06-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2019-06-01-preview/types.md index d4d1371633..5912133a48 100644 --- a/generated/containerregistry/microsoft.containerregistry/2019-06-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2019-06-01-preview/types.md @@ -70,19 +70,65 @@ * **tier**: string: The Tier of agent machine * **virtualNetworkSubnetResourceId**: string: The Virtual Network Subnet Resource Id of the agent machine -## SystemData +## AgentPoolQueueStatus ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **count**: int (ReadOnly): The number of pending runs in the queue -## ResourceTags +## AgentProperties +### Properties +* **cpu**: int: The CPU configuration in terms of number of cores required for the run. + +## Argument +### Properties +* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. +* **name**: string (Required): The name of the argument. +* **value**: string (Required): The value of the argument. + +## AuthInfo +### Properties +* **expiresIn**: int: Time in seconds that the token remains valid +* **refreshToken**: string: The refresh token used to refresh the access token. +* **scope**: string: The scope of the access token. +* **token**: string (Required): The access token used to access the source control provider. +* **tokenType**: 'OAuth' | 'PAT' | string (Required): The type of Auth token. + +## BaseImageDependency +### Properties +* **digest**: string: The sha256-based digest of the image manifest. +* **registry**: string: The registry login server. +* **repository**: string: The repository name. +* **tag**: string: The tag name. +* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. + +## BaseImageTrigger +### Properties +* **baseImageTriggerType**: 'All' | 'Runtime' | string (Required): The type of the auto trigger for base image dependency updates. +* **name**: string (Required): The name of the trigger. +* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. +* **updateTriggerEndpoint**: string: The endpoint URL for receiving update triggers. +* **updateTriggerPayloadType**: 'Default' | 'Token' | string: Type of Payload body for Base image update triggers. + +## Credentials +### Properties +* **customRegistries**: [CredentialsCustomRegistries](#credentialscustomregistries): 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. +* **sourceRegistry**: [SourceRegistryCredentials](#sourceregistrycredentials): Describes the credential parameters for accessing the source registry. + +## CredentialsCustomRegistries ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [CustomRegistryCredentials](#customregistrycredentials) + +## CustomRegistryCredentials +### Properties +* **identity**: string: Indicates the managed identity assigned to the custom credential. If a user-assigned identity +this value is the Client ID. If a system-assigned identity, the value will be `system`. In +the case of a system-assigned identity, the Client ID will be determined by the runner. This +identity may be used to authenticate to key vault to retrieve credentials or it may be the only +source of authentication used for accessing the registry. +* **password**: [SecretObject](#secretobject): Describes the properties of a secret object value. +* **userName**: [SecretObject](#secretobject): Describes the properties of a secret object value. ## IdentityProperties ### Properties @@ -99,17 +145,87 @@ dictionary key references will be ARM resource ids in the form: ### Additional Properties * **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## UserIdentityProperties +## ImageDescriptor ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **digest**: string: The sha256-based digest of the image manifest. +* **registry**: string: The registry login server. +* **repository**: string: The repository name. +* **tag**: string: The tag name. -## TaskRunProperties +## ImageUpdateTrigger ### Properties -* **forceUpdateTag**: string: How the run should be forced to rerun even if the run request configuration has not changed -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of this agent pool -* **runRequest**: [RunRequest](#runrequest): The request parameters for scheduling a run. -* **runResult**: [Run](#run) (ReadOnly): Run resource properties +* **id**: string: The unique ID of the trigger. +* **images**: [ImageDescriptor](#imagedescriptor)[]: The list of image updates that caused the build. +* **timestamp**: string: The timestamp when the image update happened. + +## OverrideTaskStepProperties +### Properties +* **arguments**: [Argument](#argument)[]: Gets or sets the collection of override arguments to be used when +executing a build step. +* **contextPath**: string: The source context against which run has to be queued. +* **file**: string: The file against which run has to be queued. +* **target**: string: The name of the target build stage for the docker build. +* **updateTriggerToken**: string: Base64 encoded update trigger token that will be attached with the base image trigger webhook. +* **values**: [SetValue](#setvalue)[]: The collection of overridable values that can be passed when running a Task. + +## PlatformProperties +### Properties +* **architecture**: '386' | 'amd64' | 'arm' | 'arm64' | 'x86' | string: The OS architecture. +* **os**: 'Linux' | 'Windows' | string (Required): The OS of agent machine +* **variant**: 'v6' | 'v7' | 'v8' | string: Variant of the CPU. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Run +### Properties +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [RunProperties](#runproperties): The properties for a run. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## RunGetLogResult +### Properties +* **logArtifactLink**: string (ReadOnly): The link to logs in registry for a run on a azure container registry. +* **logLink**: string (ReadOnly): The link to logs for a run on a azure container registry. + +## RunProperties +### Properties +* **agentConfiguration**: [AgentProperties](#agentproperties): The properties that determine the run agent configuration. +* **agentPoolName**: string: The dedicated agent pool for the run. +* **createTime**: string: The time the run was scheduled. +* **customRegistries**: string[]: The list of custom registries that were logged in during this run. +* **finishTime**: string: The time the run finished. +* **imageUpdateTrigger**: [ImageUpdateTrigger](#imageupdatetrigger): The image update trigger that caused a build. +* **isArchiveEnabled**: bool: The value that indicates whether archiving is enabled or not. +* **lastUpdatedTime**: string: The last updated time for the run. +* **logArtifact**: [ImageDescriptor](#imagedescriptor) (ReadOnly): Properties for a registry image. +* **outputImages**: [ImageDescriptor](#imagedescriptor)[]: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. +* **platform**: [PlatformProperties](#platformproperties): The platform properties against which the run has to happen. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of this agent pool +* **runErrorMessage**: string (ReadOnly): The error message received from backend systems after the run is scheduled. +* **runId**: string: The unique identifier for the run. +* **runType**: 'AutoBuild' | 'AutoRun' | 'QuickBuild' | 'QuickRun' | string: The type of run. +* **sourceRegistryAuth**: string: The scope of the credentials that were used to login to the source registry during this run. +* **sourceTrigger**: [SourceTriggerDescriptor](#sourcetriggerdescriptor): The source trigger that caused a run. +* **startTime**: string: The time the run started. +* **status**: 'Canceled' | 'Error' | 'Failed' | 'Queued' | 'Running' | 'Started' | 'Succeeded' | 'Timeout' | string: The current status of the run. +* **task**: string: The task against which run was scheduled. +* **timerTrigger**: [TimerTriggerDescriptor](#timertriggerdescriptor) +* **updateTriggerToken**: string: The update trigger token passed for the Run. ## RunRequest * **Discriminator**: type @@ -167,38 +283,6 @@ If it is relative URL, the relative path should be obtained from calling listBui * **type**: 'TaskRunRequest' (Required): The type of the run request. -## AgentProperties -### Properties -* **cpu**: int: The CPU configuration in terms of number of cores required for the run. - -## Argument -### Properties -* **isSecret**: bool: Flag to indicate whether the argument represents a secret and want to be removed from build logs. -* **name**: string (Required): The name of the argument. -* **value**: string (Required): The value of the argument. - -## Credentials -### Properties -* **customRegistries**: [CredentialsCustomRegistries](#credentialscustomregistries): 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. -* **sourceRegistry**: [SourceRegistryCredentials](#sourceregistrycredentials): Describes the credential parameters for accessing the source registry. - -## CredentialsCustomRegistries -### Properties -### Additional Properties -* **Additional Properties Type**: [CustomRegistryCredentials](#customregistrycredentials) - -## CustomRegistryCredentials -### Properties -* **identity**: string: Indicates the managed identity assigned to the custom credential. If a user-assigned identity -this value is the Client ID. If a system-assigned identity, the value will be `system`. In -the case of a system-assigned identity, the Client ID will be determined by the runner. This -identity may be used to authenticate to key vault to retrieve credentials or it may be the only -source of authentication used for accessing the registry. -* **password**: [SecretObject](#secretobject): Describes the properties of a secret object value. -* **userName**: [SecretObject](#secretobject): Describes the properties of a secret object value. - ## SecretObject ### Properties * **type**: 'Opaque' | 'Vaultsecret' | string: The type of the secret object which determines how the value of the secret object has to be @@ -207,79 +291,31 @@ interpreted. based on the type of the secret object. If the type is Opaque, the value will be used as is without any modification. -## SourceRegistryCredentials -### Properties -* **loginMode**: 'Default' | 'None' | string: 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. - -## PlatformProperties -### Properties -* **architecture**: '386' | 'amd64' | 'arm' | 'arm64' | 'x86' | string: The OS architecture. -* **os**: 'Linux' | 'Windows' | string (Required): The OS of agent machine -* **variant**: 'v6' | 'v7' | 'v8' | string: Variant of the CPU. - ## SetValue ### Properties * **isSecret**: bool: Flag to indicate whether the value represents a secret or not. * **name**: string (Required): The name of the overridable value. * **value**: string (Required): The overridable value. -## OverrideTaskStepProperties -### Properties -* **arguments**: [Argument](#argument)[]: Gets or sets the collection of override arguments to be used when -executing a build step. -* **contextPath**: string: The source context against which run has to be queued. -* **file**: string: The file against which run has to be queued. -* **target**: string: The name of the target build stage for the docker build. -* **updateTriggerToken**: string: Base64 encoded update trigger token that will be attached with the base image trigger webhook. -* **values**: [SetValue](#setvalue)[]: The collection of overridable values that can be passed when running a Task. - -## Run -### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [RunProperties](#runproperties): The properties for a run. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## RunProperties +## SourceProperties ### Properties -* **agentConfiguration**: [AgentProperties](#agentproperties): The properties that determine the run agent configuration. -* **agentPoolName**: string: The dedicated agent pool for the run. -* **createTime**: string: The time the run was scheduled. -* **customRegistries**: string[]: The list of custom registries that were logged in during this run. -* **finishTime**: string: The time the run finished. -* **imageUpdateTrigger**: [ImageUpdateTrigger](#imageupdatetrigger): The image update trigger that caused a build. -* **isArchiveEnabled**: bool: The value that indicates whether archiving is enabled or not. -* **lastUpdatedTime**: string: The last updated time for the run. -* **logArtifact**: [ImageDescriptor](#imagedescriptor) (ReadOnly): Properties for a registry image. -* **outputImages**: [ImageDescriptor](#imagedescriptor)[]: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. -* **platform**: [PlatformProperties](#platformproperties): The platform properties against which the run has to happen. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of this agent pool -* **runErrorMessage**: string (ReadOnly): The error message received from backend systems after the run is scheduled. -* **runId**: string: The unique identifier for the run. -* **runType**: 'AutoBuild' | 'AutoRun' | 'QuickBuild' | 'QuickRun' | string: The type of run. -* **sourceRegistryAuth**: string: The scope of the credentials that were used to login to the source registry during this run. -* **sourceTrigger**: [SourceTriggerDescriptor](#sourcetriggerdescriptor): The source trigger that caused a run. -* **startTime**: string: The time the run started. -* **status**: 'Canceled' | 'Error' | 'Failed' | 'Queued' | 'Running' | 'Started' | 'Succeeded' | 'Timeout' | string: The current status of the run. -* **task**: string: The task against which run was scheduled. -* **timerTrigger**: [TimerTriggerDescriptor](#timertriggerdescriptor) -* **updateTriggerToken**: string: The update trigger token passed for the Run. +* **branch**: string: The branch name of the source code. +* **repositoryUrl**: string (Required): The full URL to the source code repository +* **sourceControlAuthProperties**: [AuthInfo](#authinfo): The authorization properties for accessing the source code repository. +* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. -## ImageUpdateTrigger +## SourceRegistryCredentials ### Properties -* **id**: string: The unique ID of the trigger. -* **images**: [ImageDescriptor](#imagedescriptor)[]: The list of image updates that caused the build. -* **timestamp**: string: The timestamp when the image update happened. +* **loginMode**: 'Default' | 'None' | string: 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. -## ImageDescriptor +## SourceTrigger ### Properties -* **digest**: string: The sha256-based digest of the image manifest. -* **registry**: string: The registry login server. -* **repository**: string: The repository name. -* **tag**: string: The tag name. +* **name**: string (Required): The name of the trigger. +* **sourceRepository**: [SourceProperties](#sourceproperties) (Required): The properties of the source code repository. +* **sourceTriggerEvents**: 'commit' | 'pullrequest' | string[] (Required): The source event corresponding to the trigger. +* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. ## SourceTriggerDescriptor ### Properties @@ -291,10 +327,30 @@ executing a build step. * **pullRequestId**: string: The unique ID that identifies pull request. * **repositoryUrl**: string: The repository URL. -## TimerTriggerDescriptor +## SourceUploadDefinition ### Properties -* **scheduleOccurrence**: string: The occurrence that triggered the run. -* **timerTriggerName**: string: The timer trigger name that caused the run. +* **relativePath**: string (ReadOnly): The relative path to the source. This is used to submit the subsequent queue build request. +* **uploadUrl**: string (ReadOnly): The URL where the client can upload the source. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + +## Task +### Properties +* **id**: string (ReadOnly): The resource ID. +* **identity**: [IdentityProperties](#identityproperties) (ReadOnly): Managed identity for the resource. +* **location**: string (ReadOnly): The location of the resource. This cannot be changed after the resource is created. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [TaskProperties](#taskproperties) (ReadOnly): The properties of a task. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. ## TaskProperties ### Properties @@ -311,6 +367,23 @@ executing a build step. * **timeout**: int: Run timeout in seconds. * **trigger**: [TriggerProperties](#triggerproperties): The properties of a trigger. +## TaskRun +### Properties +* **id**: string (ReadOnly): The resource ID. +* **identity**: [IdentityProperties](#identityproperties) (ReadOnly): Managed identity for the resource. +* **location**: string (ReadOnly): The location of the resource +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [TaskRunProperties](#taskrunproperties) (ReadOnly): The properties of task run. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## TaskRunProperties +### Properties +* **forceUpdateTag**: string: How the run should be forced to rerun even if the run request configuration has not changed +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of this agent pool +* **runRequest**: [RunRequest](#runrequest): The request parameters for scheduling a run. +* **runResult**: [Run](#run) (ReadOnly): Run resource properties + ## TaskStepProperties * **Discriminator**: type @@ -343,98 +416,25 @@ executing a build step. * **valuesFilePath**: string: The task values/parameters file path relative to the source context. -## BaseImageDependency -### Properties -* **digest**: string: The sha256-based digest of the image manifest. -* **registry**: string: The registry login server. -* **repository**: string: The repository name. -* **tag**: string: The tag name. -* **type**: 'BuildTime' | 'RunTime' | string: The type of the base image dependency. - -## TriggerProperties -### Properties -* **baseImageTrigger**: [BaseImageTrigger](#baseimagetrigger): The trigger based on base image dependency. -* **sourceTriggers**: [SourceTrigger](#sourcetrigger)[]: The collection of triggers based on source code repository. -* **timerTriggers**: [TimerTrigger](#timertrigger)[]: The collection of timer triggers. - -## BaseImageTrigger -### Properties -* **baseImageTriggerType**: 'All' | 'Runtime' | string (Required): The type of the auto trigger for base image dependency updates. -* **name**: string (Required): The name of the trigger. -* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. -* **updateTriggerEndpoint**: string: The endpoint URL for receiving update triggers. -* **updateTriggerPayloadType**: 'Default' | 'Token' | string: Type of Payload body for Base image update triggers. - -## SourceTrigger -### Properties -* **name**: string (Required): The name of the trigger. -* **sourceRepository**: [SourceProperties](#sourceproperties) (Required): The properties of the source code repository. -* **sourceTriggerEvents**: 'commit' | 'pullrequest' | string[] (Required): The source event corresponding to the trigger. -* **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. - -## SourceProperties -### Properties -* **branch**: string: The branch name of the source code. -* **repositoryUrl**: string (Required): The full URL to the source code repository -* **sourceControlAuthProperties**: [AuthInfo](#authinfo): The authorization properties for accessing the source code repository. -* **sourceControlType**: 'Github' | 'VisualStudioTeamService' | string (Required): The type of source control service. - -## AuthInfo -### Properties -* **expiresIn**: int: Time in seconds that the token remains valid -* **refreshToken**: string: The refresh token used to refresh the access token. -* **scope**: string: The scope of the access token. -* **token**: string (Required): The access token used to access the source control provider. -* **tokenType**: 'OAuth' | 'PAT' | string (Required): The type of Auth token. - ## TimerTrigger ### Properties * **name**: string (Required): The name of the trigger. * **schedule**: string (Required): The CRON expression for the task schedule * **status**: 'Disabled' | 'Enabled' | string: The current status of trigger. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SourceUploadDefinition -### Properties -* **relativePath**: string (ReadOnly): The relative path to the source. This is used to submit the subsequent queue build request. -* **uploadUrl**: string (ReadOnly): The URL where the client can upload the source. - -## TaskRun -### Properties -* **id**: string (ReadOnly): The resource ID. -* **identity**: [IdentityProperties](#identityproperties) (ReadOnly): Managed identity for the resource. -* **location**: string (ReadOnly): The location of the resource -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [TaskRunProperties](#taskrunproperties) (ReadOnly): The properties of task run. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## Task -### Properties -* **id**: string (ReadOnly): The resource ID. -* **identity**: [IdentityProperties](#identityproperties) (ReadOnly): Managed identity for the resource. -* **location**: string (ReadOnly): The location of the resource. This cannot be changed after the resource is created. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [TaskProperties](#taskproperties) (ReadOnly): The properties of a task. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## ResourceTags +## TimerTriggerDescriptor ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **scheduleOccurrence**: string: The occurrence that triggered the run. +* **timerTriggerName**: string: The timer trigger name that caused the run. -## RunGetLogResult +## TriggerProperties ### Properties -* **logArtifactLink**: string (ReadOnly): The link to logs in registry for a run on a azure container registry. -* **logLink**: string (ReadOnly): The link to logs for a run on a azure container registry. +* **baseImageTrigger**: [BaseImageTrigger](#baseimagetrigger): The trigger based on base image dependency. +* **sourceTriggers**: [SourceTrigger](#sourcetrigger)[]: The collection of triggers based on source code repository. +* **timerTriggers**: [TimerTrigger](#timertrigger)[]: The collection of timer triggers. -## AgentPoolQueueStatus +## UserIdentityProperties ### Properties -* **count**: int (ReadOnly): The number of pending runs in the queue +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. diff --git a/generated/containerregistry/microsoft.containerregistry/2019-12-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2019-12-01-preview/types.md index 1cb88857e4..0b8112ab52 100644 --- a/generated/containerregistry/microsoft.containerregistry/2019-12-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2019-12-01-preview/types.md @@ -92,137 +92,58 @@ * **ApiVersion**: 2019-12-01-preview * **Output**: [EventListResult](#eventlistresult) -## IdentityProperties -### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityPropertiesUserAssignedIdentities](#identitypropertiesuserassignedidentities): The list of user 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}'. - -## IdentityPropertiesUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. - -## RegistryProperties +## Actor ### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. -* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. ## EncryptionProperty ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) * **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. -## KeyVaultProperties -### Properties -* **identity**: string: The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string: Key vault uri to access the encryption key. -* **keyRotationEnabled**: bool (ReadOnly): Auto key rotation status for a CMK enabled registry. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. -* **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. - -## NetworkRuleSet -### Properties -* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. - -## IPRule -### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. - -## Policies -### Properties -* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. -* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. - -## QuarantinePolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## RetentionPolicy -### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## TrustPolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): The properties of a private endpoint connection. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## PrivateEndpointConnectionProperties +## Event ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. -## PrivateEndpoint +## EventContent ### Properties -* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. -## PrivateLinkServiceConnectionState +## EventListResult ### Properties -* **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. -## SystemData +## EventRequestMessage ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. -## Status +## EventRequestMessageHeaders ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +### Additional Properties +* **Additional Properties Type**: string -## Sku +## EventResponseMessage ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. -## ResourceTags +## EventResponseMessageHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -241,6 +162,21 @@ dictionary key references will be ARM resource ids in the form: When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" +## IdentityProperties +### Properties +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityPropertiesUserAssignedIdentities](#identitypropertiesuserassignedidentities): The list of user 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}'. + +## IdentityPropertiesUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) + ## ImportPipelineProperties ### Properties * **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. @@ -256,13 +192,24 @@ When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/co When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" -## PipelineTriggerProperties +## IPRule ### Properties -* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## PipelineSourceTriggerProperties +## KeyVaultProperties ### Properties -* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. +* **identity**: string: The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string: Key vault uri to access the encryption key. +* **keyRotationEnabled**: bool (ReadOnly): Auto key rotation status for a CMK enabled registry. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. +* **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. + +## NetworkRuleSet +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. ## PipelineRunProperties ### Properties @@ -282,16 +229,6 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) * **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) -## PipelineRunSourceProperties -### Properties -* **name**: string: The name of the source. -* **type**: 'AzureStorageBlob' | string: The type of the source. - -## PipelineRunTargetProperties -### Properties -* **name**: string: The name of the target. -* **type**: 'AzureStorageBlob' | string: The type of the target. - ## PipelineRunResponse ### Properties * **catalogDigest**: string: The digest of the tar used to transfer the artifacts. @@ -305,47 +242,69 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. * **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) -## ProgressProperties +## PipelineRunSourceProperties ### Properties -* **percentage**: string: The percentage complete of the copy operation. +* **name**: string: The name of the source. +* **type**: 'AzureStorageBlob' | string: The type of the source. -## PipelineTriggerDescriptor +## PipelineRunTargetProperties ### Properties -* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) +* **name**: string: The name of the target. +* **type**: 'AzureStorageBlob' | string: The type of the target. ## PipelineSourceTriggerDescriptor ### Properties * **timestamp**: string: The timestamp when the source update happened. -## ReplicationProperties +## PipelineSourceTriggerProperties ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. -* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. -## ResourceTags +## PipelineTriggerDescriptor ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) -## WebhookPropertiesCreateParameters +## PipelineTriggerProperties ### Properties -* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. -* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) + +## Policies +### Properties +* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. +* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. + +## PrivateEndpoint +### Properties +* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): The properties of a private endpoint connection. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. -* **scope**: 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. -* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. -* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## WebhookPropertiesCreateParametersCustomHeaders +## PrivateLinkServiceConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## WebhookCreateParametersTags +## ProgressProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **percentage**: string: The percentage complete of the copy operation. + +## QuarantinePolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. ## RegistryListCredentialsResult ### Properties @@ -357,38 +316,27 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **name**: 'password' | 'password2' (ReadOnly): The password name. * **value**: string (ReadOnly): The password value. -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent +## RegistryProperties ### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. +* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -## Actor +## ReplicationProperties ### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. +* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. ## Request ### Properties @@ -398,11 +346,47 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **method**: string (ReadOnly): The request method that generated the event. * **useragent**: string (ReadOnly): The user agent header of the request. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionPolicy +### Properties +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + +## Sku +### Properties +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + ## Source ### Properties * **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. * **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + ## Target ### Properties * **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. @@ -415,20 +399,36 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **url**: string (ReadOnly): The direct URL to the content. * **version**: string (ReadOnly): The version of the artifact. -## EventRequestMessageHeaders +## TrustPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventResponseMessage +## WebhookPropertiesCreateParameters ### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. +* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. +* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the pipeline at the time the operation was called. +* **scope**: 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. +* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. +* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## EventResponseMessageHeaders +## WebhookPropertiesCreateParametersCustomHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/containerregistry/microsoft.containerregistry/2020-11-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2020-11-01-preview/types.md index 69f6163fd8..97fe12a1bd 100644 --- a/generated/containerregistry/microsoft.containerregistry/2020-11-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2020-11-01-preview/types.md @@ -122,142 +122,13 @@ * **ApiVersion**: 2020-11-01-preview * **Output**: [EventListResult](#eventlistresult) -## IdentityProperties -### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityPropertiesUserAssignedIdentities](#identitypropertiesuserassignedidentities): The list of user 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}'. - -## IdentityPropertiesUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. - -## RegistryProperties -### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. -* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry - -## EncryptionProperty -### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) -* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. - -## KeyVaultProperties -### Properties -* **identity**: string: The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string: Key vault uri to access the encryption key. -* **keyRotationEnabled**: bool (ReadOnly): Auto key rotation status for a CMK enabled registry. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. -* **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. - -## NetworkRuleSet -### Properties -* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. - -## IPRule -### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. - -## Policies -### Properties -* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. -* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. - -## QuarantinePolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## RetentionPolicy -### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## TrustPolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): The resource ID. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): The properties of a private endpoint connection. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. - -## PrivateEndpoint -### Properties -* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. - -## Status -### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. - -## Sku +## ActivationProperties ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. -## ResourceTags +## Actor ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. ## ConnectedRegistryProperties ### Properties @@ -273,51 +144,57 @@ dictionary key references will be ARM resource ids in the form: * **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. * **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. -## ActivationProperties +## EncryptionProperty ### Properties -* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) +* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. -## LoggingProperties +## Event ### Properties -* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. -* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. -## LoginServerProperties +## EventContent ### Properties -* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. -* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. -## TlsProperties +## EventListResult ### Properties -* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. -* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. -## TlsCertificateProperties +## EventRequestMessage ### Properties -* **location**: string (ReadOnly): Indicates the location of the certificates. -* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. -## ParentProperties +## EventRequestMessageHeaders ### Properties -* **id**: string: The resource ID of the parent to which the connected registry will be associated. -* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. +### Additional Properties +* **Additional Properties Type**: string -## SyncProperties +## EventResponseMessage ### Properties -* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. -* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. -* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. -* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. -## StatusDetailProperties +## EventResponseMessageHeaders ### Properties -* **code**: string (ReadOnly): The code of the status. -* **correlationId**: string (ReadOnly): The correlation ID of the status. -* **description**: string (ReadOnly): The description of the status. -* **timestamp**: string (ReadOnly): The timestamp of the status. -* **type**: string (ReadOnly): The component of the connected registry corresponding to the status. +### Additional Properties +* **Additional Properties Type**: string ## ExportPipelineProperties ### Properties @@ -333,6 +210,21 @@ dictionary key references will be ARM resource ids in the form: When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" +## IdentityProperties +### Properties +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityPropertiesUserAssignedIdentities](#identitypropertiesuserassignedidentities): The list of user 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}'. + +## IdentityPropertiesUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) + ## ImportPipelineProperties ### Properties * **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. @@ -348,13 +240,39 @@ When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/co When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" -## PipelineTriggerProperties +## IPRule ### Properties -* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## PipelineSourceTriggerProperties +## KeyVaultProperties ### Properties -* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. +* **identity**: string: The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string: Key vault uri to access the encryption key. +* **keyRotationEnabled**: bool (ReadOnly): Auto key rotation status for a CMK enabled registry. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. +* **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. + +## LoggingProperties +### Properties +* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. +* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. + +## LoginServerProperties +### Properties +* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. +* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. + +## NetworkRuleSet +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. + +## ParentProperties +### Properties +* **id**: string: The resource ID of the parent to which the connected registry will be associated. +* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. ## PipelineRunProperties ### Properties @@ -374,17 +292,7 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) * **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) -## PipelineRunSourceProperties -### Properties -* **name**: string: The name of the source. -* **type**: 'AzureStorageBlob' | string: The type of the source. - -## PipelineRunTargetProperties -### Properties -* **name**: string: The name of the target. -* **type**: 'AzureStorageBlob' | string: The type of the target. - -## PipelineRunResponse +## PipelineRunResponse ### Properties * **catalogDigest**: string: The digest of the tar used to transfer the artifacts. * **finishTime**: string: The time the pipeline run finished. @@ -397,85 +305,69 @@ Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). * **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. * **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) -## ProgressProperties +## PipelineRunSourceProperties ### Properties -* **percentage**: string: The percentage complete of the copy operation. +* **name**: string: The name of the source. +* **type**: 'AzureStorageBlob' | string: The type of the source. -## PipelineTriggerDescriptor +## PipelineRunTargetProperties ### Properties -* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) +* **name**: string: The name of the target. +* **type**: 'AzureStorageBlob' | string: The type of the target. ## PipelineSourceTriggerDescriptor ### Properties * **timestamp**: string: The timestamp when the source update happened. -## ReplicationProperties +## PipelineSourceTriggerProperties ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. -## ResourceTags +## PipelineTriggerDescriptor ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) -## ScopeMapProperties +## PipelineTriggerProperties ### Properties -* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. -E.g. repositories/repository-name/content/read, -repositories/repository-name/metadata/write -* **creationDate**: string (ReadOnly): The creation date of scope map. -* **description**: string: The user friendly description of the scope map. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. +* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) -## TokenProperties +## Policies ### Properties -* **creationDate**: string (ReadOnly): The creation date of scope map. -* **credentials**: [TokenCredentialsProperties](#tokencredentialsproperties): The properties of the credentials that can be used for authenticating the token. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. -* **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. +* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. +* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. -## TokenCredentialsProperties +## PrivateEndpoint ### Properties -* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate -* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword +* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. -## TokenCertificate +## PrivateEndpointConnection ### Properties -* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. -* **expiry**: string: The expiry datetime of the certificate. -* **name**: 'certificate1' | 'certificate2' | string -* **thumbprint**: string: The thumbprint of the certificate. +* **id**: string (ReadOnly): The resource ID. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): The properties of a private endpoint connection. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. -## TokenPassword +## PrivateEndpointConnectionProperties ### Properties -* **creationTime**: string: The creation datetime of the password. -* **expiry**: string: The expiry datetime of the password. -* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" -* **value**: string (ReadOnly): The password value. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## WebhookPropertiesCreateParameters +## PrivateLinkServiceConnectionState ### Properties -* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. -* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **scope**: 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. -* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. -* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. +* **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## WebhookPropertiesCreateParametersCustomHeaders +## ProgressProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **percentage**: string: The percentage complete of the copy operation. -## WebhookCreateParametersTags +## QuarantinePolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. ## RegistryListCredentialsResult ### Properties @@ -487,38 +379,30 @@ repositories/repository-name/metadata/write * **name**: 'password' | 'password2' (ReadOnly): The password name. * **value**: string (ReadOnly): The password value. -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent +## RegistryProperties ### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. +* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## Actor +## ReplicationProperties ### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry ## Request ### Properties @@ -528,11 +412,74 @@ repositories/repository-name/metadata/write * **method**: string (ReadOnly): The request method that generated the event. * **useragent**: string (ReadOnly): The user agent header of the request. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionPolicy +### Properties +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + +## ScopeMapProperties +### Properties +* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. +E.g. repositories/repository-name/content/read, +repositories/repository-name/metadata/write +* **creationDate**: string (ReadOnly): The creation date of scope map. +* **description**: string: The user friendly description of the scope map. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. + +## Sku +### Properties +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + ## Source ### Properties * **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. * **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. + +## StatusDetailProperties +### Properties +* **code**: string (ReadOnly): The code of the status. +* **correlationId**: string (ReadOnly): The correlation ID of the status. +* **description**: string (ReadOnly): The description of the status. +* **timestamp**: string (ReadOnly): The timestamp of the status. +* **type**: string (ReadOnly): The component of the connected registry corresponding to the status. + +## SyncProperties +### Properties +* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. +* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. +* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. +* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + ## Target ### Properties * **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. @@ -545,20 +492,73 @@ repositories/repository-name/metadata/write * **url**: string (ReadOnly): The direct URL to the content. * **version**: string (ReadOnly): The version of the artifact. -## EventRequestMessageHeaders +## TlsCertificateProperties +### Properties +* **location**: string (ReadOnly): Indicates the location of the certificates. +* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. + +## TlsProperties +### Properties +* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. +* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. + +## TokenCertificate +### Properties +* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. +* **expiry**: string: The expiry datetime of the certificate. +* **name**: 'certificate1' | 'certificate2' | string +* **thumbprint**: string: The thumbprint of the certificate. + +## TokenCredentialsProperties +### Properties +* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate +* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword + +## TokenPassword +### Properties +* **creationTime**: string: The creation datetime of the password. +* **expiry**: string: The expiry datetime of the password. +* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" +* **value**: string (ReadOnly): The password value. + +## TokenProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of scope map. +* **credentials**: [TokenCredentialsProperties](#tokencredentialsproperties): The properties of the credentials that can be used for authenticating the token. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. +* **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. + +## TrustPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventResponseMessage +## WebhookPropertiesCreateParameters ### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. +* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. +* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **scope**: 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. +* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. +* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## EventResponseMessageHeaders +## WebhookPropertiesCreateParametersCustomHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/containerregistry/microsoft.containerregistry/2021-06-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2021-06-01-preview/types.md index f4e815b568..0c8e0743d8 100644 --- a/generated/containerregistry/microsoft.containerregistry/2021-06-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2021-06-01-preview/types.md @@ -122,6 +122,98 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [EventListResult](#eventlistresult) +## ActivationProperties +### Properties +* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. + +## Actor +### Properties +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. + +## ConnectedRegistryProperties +### Properties +* **activation**: [ActivationProperties](#activationproperties) (ReadOnly): The activation properties of the connected registry. +* **clientTokenIds**: string[]: The list of the ACR token resource IDs used to authenticate clients to the connected registry. +* **connectionState**: 'Offline' | 'Online' | 'Syncing' | 'Unhealthy' | string (ReadOnly): The current connection state of the connected registry. +* **lastActivityTime**: string (ReadOnly): The last activity time of the connected registry. +* **logging**: [LoggingProperties](#loggingproperties): The logging properties of the connected registry. +* **loginServer**: [LoginServerProperties](#loginserverproperties): The login server properties of the connected registry. +* **mode**: 'Mirror' | 'Registry' | string (Required): The mode of the connected registry resource that indicates the permissions of the registry. +* **parent**: [ParentProperties](#parentproperties) (Required): The properties of the connected registry parent. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. +* **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) +* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. + +## Event +### Properties +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. + +## EventContent +### Properties +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. + +## EventListResult +### Properties +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. + +## EventRequestMessage +### Properties +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventRequestMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventResponseMessage +### Properties +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventResponseMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ExportPipelineProperties +### Properties +* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties) (Required): The properties of the export pipeline target. + +## ExportPipelineTargetProperties +### Properties +* **keyVaultUri**: string (Required): They key vault secret uri to obtain the target storage SAS token. +* **type**: string: The type of target for the export pipeline. +* **uri**: string: The target uri of the export pipeline. +When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" +When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" + +## ExportPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + ## IdentityProperties ### Properties * **principalId**: string: The principal ID of resource identity. @@ -137,33 +229,25 @@ dictionary key references will be ARM resource ids in the form: ### Additional Properties * **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## UserIdentityProperties +## ImportPipelineProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties) (Required): The properties of the import pipeline source. +* **trigger**: [PipelineTriggerProperties](#pipelinetriggerproperties) -## RegistryProperties +## ImportPipelineSourceProperties ### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. -* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **keyVaultUri**: string (Required): They key vault secret uri to obtain the source storage SAS token. +* **type**: 'AzureStorageBlobContainer' | string: The type of source for the import pipeline. +* **uri**: string: The source uri of the import pipeline. +When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" +When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" -## EncryptionProperty +## IPRule ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) -* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ## KeyVaultProperties ### Properties @@ -173,47 +257,94 @@ dictionary key references will be ARM resource ids in the form: * **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. * **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. +## LoggingProperties +### Properties +* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. +* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. + +## LoginServerProperties +### Properties +* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. +* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. + ## NetworkRuleSet ### Properties * **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. * **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. -## IPRule +## ParentProperties ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. +* **id**: string: The resource ID of the parent to which the connected registry will be associated. +* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. -## VirtualNetworkRule +## PipelineRunProperties ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **forceUpdateTag**: string: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **request**: [PipelineRunRequest](#pipelinerunrequest): The request properties provided for a pipeline run. +* **response**: [PipelineRunResponse](#pipelinerunresponse) (ReadOnly): The response properties returned for a pipeline run. -## Policies +## PipelineRunRequest ### Properties -* **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. -* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. -* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. +* **artifacts**: string[]: List of source artifacts to be transferred by the pipeline. +Specify an image by repository ('hello-world'). This will use the 'latest' tag. +Specify an image by tag ('hello-world:latest'). +Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). +* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. +* **pipelineResourceId**: string: The resource ID of the pipeline to run. +* **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) +* **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) -## ExportPolicy +## PipelineRunResponse ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. +* **finishTime**: string: The time the pipeline run finished. +* **importedArtifacts**: string[]: The artifacts imported in the pipeline run. +* **pipelineRunErrorMessage**: string: The detailed error message for the pipeline run in the case of failure. +* **progress**: [ProgressProperties](#progressproperties) +* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties): The properties of the import pipeline source. +* **startTime**: string: The time the pipeline run started. +* **status**: string: The current status of the pipeline run. +* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. +* **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) -## QuarantinePolicy +## PipelineRunSourceProperties ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string: The name of the source. +* **type**: 'AzureStorageBlob' | string: The type of the source. -## RetentionPolicy +## PipelineRunTargetProperties ### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string: The name of the target. +* **type**: 'AzureStorageBlob' | string: The type of the target. -## TrustPolicy +## PipelineSourceTriggerDescriptor ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. +* **timestamp**: string: The timestamp when the source update happened. + +## PipelineSourceTriggerProperties +### Properties +* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. + +## PipelineTriggerDescriptor +### Properties +* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) + +## PipelineTriggerProperties +### Properties +* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) + +## Policies +### Properties +* **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. +* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. +* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. + +## PrivateEndpoint +### Properties +* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. ## PrivateEndpointConnection ### Properties @@ -229,92 +360,104 @@ dictionary key references will be ARM resource ids in the form: * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ProgressProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **percentage**: string: The percentage complete of the copy operation. -## Status +## QuarantinePolicy ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## Sku +## RegistryListCredentialsResult ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. +* **username**: string (ReadOnly): The username for a container registry. -## ResourceTags +## RegistryPassword ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'password' | 'password2' (ReadOnly): The password name. +* **value**: string (ReadOnly): The password value. -## ConnectedRegistryProperties +## RegistryProperties ### Properties -* **activation**: [ActivationProperties](#activationproperties) (ReadOnly): The activation properties of the connected registry. -* **clientTokenIds**: string[]: The list of the ACR token resource IDs used to authenticate clients to the connected registry. -* **connectionState**: 'Offline' | 'Online' | 'Syncing' | 'Unhealthy' | string (ReadOnly): The current connection state of the connected registry. -* **lastActivityTime**: string (ReadOnly): The last activity time of the connected registry. -* **logging**: [LoggingProperties](#loggingproperties): The logging properties of the connected registry. -* **loginServer**: [LoginServerProperties](#loginserverproperties): The login server properties of the connected registry. -* **mode**: 'Mirror' | 'Registry' | string (Required): The mode of the connected registry resource that indicates the permissions of the registry. -* **parent**: [ParentProperties](#parentproperties) (Required): The properties of the connected registry parent. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. +* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. -* **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## ActivationProperties +## ReplicationProperties ### Properties -* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## LoggingProperties +## Request ### Properties -* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. -* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. +* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. +* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. +* **id**: string (ReadOnly): The ID of the request that initiated the event. +* **method**: string (ReadOnly): The request method that generated the event. +* **useragent**: string (ReadOnly): The user agent header of the request. -## LoginServerProperties +## ResourceTags ### Properties -* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. -* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. +### Additional Properties +* **Additional Properties Type**: string -## TlsProperties +## ResourceTags ### Properties -* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. -* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. +### Additional Properties +* **Additional Properties Type**: string -## TlsCertificateProperties +## RetentionPolicy ### Properties -* **location**: string (ReadOnly): Indicates the location of the certificates. -* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## ParentProperties +## ScopeMapProperties ### Properties -* **id**: string: The resource ID of the parent to which the connected registry will be associated. -* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. +* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. +E.g. repositories/repository-name/content/read, +repositories/repository-name/metadata/write +* **creationDate**: string (ReadOnly): The creation date of scope map. +* **description**: string: The user friendly description of the scope map. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. -## SyncProperties +## Sku ### Properties -* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. -* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. -* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. -* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + +## Source +### Properties +* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. +* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. + +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. ## StatusDetailProperties ### Properties @@ -324,117 +467,64 @@ dictionary key references will be ARM resource ids in the form: * **timestamp**: string (ReadOnly): The timestamp of the status. * **type**: string (ReadOnly): The component of the connected registry corresponding to the status. -## ExportPipelineProperties -### Properties -* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties) (Required): The properties of the export pipeline target. - -## ExportPipelineTargetProperties -### Properties -* **keyVaultUri**: string (Required): They key vault secret uri to obtain the target storage SAS token. -* **type**: string: The type of target for the export pipeline. -* **uri**: string: The target uri of the export pipeline. -When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" -When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" - -## ImportPipelineProperties -### Properties -* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties) (Required): The properties of the import pipeline source. -* **trigger**: [PipelineTriggerProperties](#pipelinetriggerproperties) - -## ImportPipelineSourceProperties -### Properties -* **keyVaultUri**: string (Required): They key vault secret uri to obtain the source storage SAS token. -* **type**: 'AzureStorageBlobContainer' | string: The type of source for the import pipeline. -* **uri**: string: The source uri of the import pipeline. -When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" -When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" - -## PipelineTriggerProperties -### Properties -* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) - -## PipelineSourceTriggerProperties -### Properties -* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. - -## PipelineRunProperties -### Properties -* **forceUpdateTag**: string: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **request**: [PipelineRunRequest](#pipelinerunrequest): The request properties provided for a pipeline run. -* **response**: [PipelineRunResponse](#pipelinerunresponse) (ReadOnly): The response properties returned for a pipeline run. - -## PipelineRunRequest -### Properties -* **artifacts**: string[]: List of source artifacts to be transferred by the pipeline. -Specify an image by repository ('hello-world'). This will use the 'latest' tag. -Specify an image by tag ('hello-world:latest'). -Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). -* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. -* **pipelineResourceId**: string: The resource ID of the pipeline to run. -* **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) -* **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) - -## PipelineRunSourceProperties -### Properties -* **name**: string: The name of the source. -* **type**: 'AzureStorageBlob' | string: The type of the source. - -## PipelineRunTargetProperties +## SyncProperties ### Properties -* **name**: string: The name of the target. -* **type**: 'AzureStorageBlob' | string: The type of the target. +* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. +* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. +* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. +* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. -## PipelineRunResponse +## SystemData ### Properties -* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. -* **finishTime**: string: The time the pipeline run finished. -* **importedArtifacts**: string[]: The artifacts imported in the pipeline run. -* **pipelineRunErrorMessage**: string: The detailed error message for the pipeline run in the case of failure. -* **progress**: [ProgressProperties](#progressproperties) -* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties): The properties of the import pipeline source. -* **startTime**: string: The time the pipeline run started. -* **status**: string: The current status of the pipeline run. -* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. -* **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. -## ProgressProperties +## Target ### Properties -* **percentage**: string: The percentage complete of the copy operation. +* **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. +* **length**: int (ReadOnly): The number of bytes of the content. Same as Size field. +* **mediaType**: string (ReadOnly): The MIME type of the referenced object. +* **name**: string (ReadOnly): The name of the artifact. +* **repository**: string (ReadOnly): The repository name. +* **size**: int (ReadOnly): The number of bytes of the content. Same as Length field. +* **tag**: string (ReadOnly): The tag name. +* **url**: string (ReadOnly): The direct URL to the content. +* **version**: string (ReadOnly): The version of the artifact. -## PipelineTriggerDescriptor +## TlsCertificateProperties ### Properties -* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) +* **location**: string (ReadOnly): Indicates the location of the certificates. +* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. -## PipelineSourceTriggerDescriptor +## TlsProperties ### Properties -* **timestamp**: string: The timestamp when the source update happened. +* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. +* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. -## ReplicationProperties +## TokenCertificate ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. +* **expiry**: string: The expiry datetime of the certificate. +* **name**: 'certificate1' | 'certificate2' | string +* **thumbprint**: string: The thumbprint of the certificate. -## ResourceTags +## TokenCredentialsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate +* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword -## ScopeMapProperties +## TokenPassword ### Properties -* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. -E.g. repositories/repository-name/content/read, -repositories/repository-name/metadata/write -* **creationDate**: string (ReadOnly): The creation date of scope map. -* **description**: string: The user friendly description of the scope map. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. +* **creationTime**: string: The creation datetime of the password. +* **expiry**: string: The expiry datetime of the password. +* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" +* **value**: string (ReadOnly): The password value. ## TokenProperties ### Properties @@ -444,24 +534,25 @@ repositories/repository-name/metadata/write * **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. * **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. -## TokenCredentialsProperties +## TrustPolicy ### Properties -* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate -* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. -## TokenCertificate +## UserIdentityProperties ### Properties -* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. -* **expiry**: string: The expiry datetime of the certificate. -* **name**: 'certificate1' | 'certificate2' | string -* **thumbprint**: string: The thumbprint of the certificate. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## TokenPassword +## VirtualNetworkRule ### Properties -* **creationTime**: string: The creation datetime of the password. -* **expiry**: string: The expiry datetime of the password. -* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" -* **value**: string (ReadOnly): The password value. +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## WebhookPropertiesCreateParameters ### Properties @@ -477,94 +568,3 @@ repositories/repository-name/metadata/write ### Additional Properties * **Additional Properties Type**: string -## WebhookCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RegistryListCredentialsResult -### Properties -* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. -* **username**: string (ReadOnly): The username for a container registry. - -## RegistryPassword -### Properties -* **name**: 'password' | 'password2' (ReadOnly): The password name. -* **value**: string (ReadOnly): The password value. - -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent -### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. - -## Actor -### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. - -## Request -### Properties -* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. -* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. -* **id**: string (ReadOnly): The ID of the request that initiated the event. -* **method**: string (ReadOnly): The request method that generated the event. -* **useragent**: string (ReadOnly): The user agent header of the request. - -## Source -### Properties -* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. -* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. - -## Target -### Properties -* **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. -* **length**: int (ReadOnly): The number of bytes of the content. Same as Size field. -* **mediaType**: string (ReadOnly): The MIME type of the referenced object. -* **name**: string (ReadOnly): The name of the artifact. -* **repository**: string (ReadOnly): The repository name. -* **size**: int (ReadOnly): The number of bytes of the content. Same as Length field. -* **tag**: string (ReadOnly): The tag name. -* **url**: string (ReadOnly): The direct URL to the content. -* **version**: string (ReadOnly): The version of the artifact. - -## EventRequestMessageHeaders -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventResponseMessage -### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventResponseMessageHeaders -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/containerregistry/microsoft.containerregistry/2021-08-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2021-08-01-preview/types.md index 5b7ca519e9..d7ad336dd6 100644 --- a/generated/containerregistry/microsoft.containerregistry/2021-08-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2021-08-01-preview/types.md @@ -122,6 +122,99 @@ * **ApiVersion**: 2021-08-01-preview * **Output**: [EventListResult](#eventlistresult) +## ActivationProperties +### Properties +* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. + +## Actor +### Properties +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. + +## ConnectedRegistryProperties +### Properties +* **activation**: [ActivationProperties](#activationproperties) (ReadOnly): The activation properties of the connected registry. +* **clientTokenIds**: string[]: The list of the ACR token resource IDs used to authenticate clients to the connected registry. +* **connectionState**: 'Offline' | 'Online' | 'Syncing' | 'Unhealthy' | string (ReadOnly): The current connection state of the connected registry. +* **lastActivityTime**: string (ReadOnly): The last activity time of the connected registry. +* **logging**: [LoggingProperties](#loggingproperties): The logging properties of the connected registry. +* **loginServer**: [LoginServerProperties](#loginserverproperties): The login server properties of the connected registry. +* **mode**: 'Mirror' | 'ReadOnly' | 'ReadWrite' | 'Registry' | string (Required): The mode of the connected registry resource that indicates the permissions of the registry. +* **notificationsList**: string[]: The list of notifications subscription information for the connected registry. +* **parent**: [ParentProperties](#parentproperties) (Required): The properties of the connected registry parent. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. +* **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) +* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. + +## Event +### Properties +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. + +## EventContent +### Properties +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. + +## EventListResult +### Properties +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. + +## EventRequestMessage +### Properties +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventRequestMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventResponseMessage +### Properties +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventResponseMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ExportPipelineProperties +### Properties +* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties) (Required): The properties of the export pipeline target. + +## ExportPipelineTargetProperties +### Properties +* **keyVaultUri**: string (Required): They key vault secret uri to obtain the target storage SAS token. +* **type**: string: The type of target for the export pipeline. +* **uri**: string: The target uri of the export pipeline. +When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" +When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" + +## ExportPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + ## IdentityProperties ### Properties * **principalId**: string: The principal ID of resource identity. @@ -137,33 +230,25 @@ dictionary key references will be ARM resource ids in the form: ### Additional Properties * **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## UserIdentityProperties +## ImportPipelineProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties) (Required): The properties of the import pipeline source. +* **trigger**: [PipelineTriggerProperties](#pipelinetriggerproperties) -## RegistryProperties +## ImportPipelineSourceProperties ### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. -* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **keyVaultUri**: string (Required): They key vault secret uri to obtain the source storage SAS token. +* **type**: 'AzureStorageBlobContainer' | string: The type of source for the import pipeline. +* **uri**: string: The source uri of the import pipeline. +When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" +When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" -## EncryptionProperty +## IPRule ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) -* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ## KeyVaultProperties ### Properties @@ -173,47 +258,94 @@ dictionary key references will be ARM resource ids in the form: * **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. * **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. +## LoggingProperties +### Properties +* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. +* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. + +## LoginServerProperties +### Properties +* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. +* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. + ## NetworkRuleSet ### Properties * **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. * **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. -## IPRule +## ParentProperties ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. +* **id**: string: The resource ID of the parent to which the connected registry will be associated. +* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. -## VirtualNetworkRule +## PipelineRunProperties ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **forceUpdateTag**: string: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **request**: [PipelineRunRequest](#pipelinerunrequest): The request properties provided for a pipeline run. +* **response**: [PipelineRunResponse](#pipelinerunresponse) (ReadOnly): The response properties returned for a pipeline run. -## Policies +## PipelineRunRequest ### Properties -* **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. -* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. -* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. +* **artifacts**: string[]: List of source artifacts to be transferred by the pipeline. +Specify an image by repository ('hello-world'). This will use the 'latest' tag. +Specify an image by tag ('hello-world:latest'). +Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). +* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. +* **pipelineResourceId**: string: The resource ID of the pipeline to run. +* **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) +* **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) -## ExportPolicy +## PipelineRunResponse ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. +* **finishTime**: string: The time the pipeline run finished. +* **importedArtifacts**: string[]: The artifacts imported in the pipeline run. +* **pipelineRunErrorMessage**: string: The detailed error message for the pipeline run in the case of failure. +* **progress**: [ProgressProperties](#progressproperties) +* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties): The properties of the import pipeline source. +* **startTime**: string: The time the pipeline run started. +* **status**: string: The current status of the pipeline run. +* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. +* **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) -## QuarantinePolicy +## PipelineRunSourceProperties ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string: The name of the source. +* **type**: 'AzureStorageBlob' | string: The type of the source. -## RetentionPolicy +## PipelineRunTargetProperties ### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string: The name of the target. +* **type**: 'AzureStorageBlob' | string: The type of the target. -## TrustPolicy +## PipelineSourceTriggerDescriptor ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. +* **timestamp**: string: The timestamp when the source update happened. + +## PipelineSourceTriggerProperties +### Properties +* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. + +## PipelineTriggerDescriptor +### Properties +* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) + +## PipelineTriggerProperties +### Properties +* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) + +## Policies +### Properties +* **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. +* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. +* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. + +## PrivateEndpoint +### Properties +* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. ## PrivateEndpointConnection ### Properties @@ -229,93 +361,104 @@ dictionary key references will be ARM resource ids in the form: * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ProgressProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **percentage**: string: The percentage complete of the copy operation. -## Status +## QuarantinePolicy ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## Sku +## RegistryListCredentialsResult ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. +* **username**: string (ReadOnly): The username for a container registry. -## ResourceTags +## RegistryPassword ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'password' | 'password2' (ReadOnly): The password name. +* **value**: string (ReadOnly): The password value. -## ConnectedRegistryProperties +## RegistryProperties ### Properties -* **activation**: [ActivationProperties](#activationproperties) (ReadOnly): The activation properties of the connected registry. -* **clientTokenIds**: string[]: The list of the ACR token resource IDs used to authenticate clients to the connected registry. -* **connectionState**: 'Offline' | 'Online' | 'Syncing' | 'Unhealthy' | string (ReadOnly): The current connection state of the connected registry. -* **lastActivityTime**: string (ReadOnly): The last activity time of the connected registry. -* **logging**: [LoggingProperties](#loggingproperties): The logging properties of the connected registry. -* **loginServer**: [LoginServerProperties](#loginserverproperties): The login server properties of the connected registry. -* **mode**: 'Mirror' | 'ReadOnly' | 'ReadWrite' | 'Registry' | string (Required): The mode of the connected registry resource that indicates the permissions of the registry. -* **notificationsList**: string[]: The list of notifications subscription information for the connected registry. -* **parent**: [ParentProperties](#parentproperties) (Required): The properties of the connected registry parent. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. +* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. -* **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## ActivationProperties +## ReplicationProperties ### Properties -* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## LoggingProperties +## Request ### Properties -* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. -* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. +* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. +* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. +* **id**: string (ReadOnly): The ID of the request that initiated the event. +* **method**: string (ReadOnly): The request method that generated the event. +* **useragent**: string (ReadOnly): The user agent header of the request. -## LoginServerProperties +## ResourceTags ### Properties -* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. -* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. +### Additional Properties +* **Additional Properties Type**: string -## TlsProperties +## ResourceTags ### Properties -* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. -* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. +### Additional Properties +* **Additional Properties Type**: string -## TlsCertificateProperties +## RetentionPolicy ### Properties -* **location**: string (ReadOnly): Indicates the location of the certificates. -* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## ParentProperties +## ScopeMapProperties ### Properties -* **id**: string: The resource ID of the parent to which the connected registry will be associated. -* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. +* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. +E.g. repositories/repository-name/content/read, +repositories/repository-name/metadata/write +* **creationDate**: string (ReadOnly): The creation date of scope map. +* **description**: string: The user friendly description of the scope map. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. -## SyncProperties +## Sku ### Properties -* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. -* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. -* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. -* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + +## Source +### Properties +* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. +* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. + +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. ## StatusDetailProperties ### Properties @@ -325,117 +468,64 @@ dictionary key references will be ARM resource ids in the form: * **timestamp**: string (ReadOnly): The timestamp of the status. * **type**: string (ReadOnly): The component of the connected registry corresponding to the status. -## ExportPipelineProperties -### Properties -* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties) (Required): The properties of the export pipeline target. - -## ExportPipelineTargetProperties -### Properties -* **keyVaultUri**: string (Required): They key vault secret uri to obtain the target storage SAS token. -* **type**: string: The type of target for the export pipeline. -* **uri**: string: The target uri of the export pipeline. -When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" -When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" - -## ImportPipelineProperties -### Properties -* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties) (Required): The properties of the import pipeline source. -* **trigger**: [PipelineTriggerProperties](#pipelinetriggerproperties) - -## ImportPipelineSourceProperties -### Properties -* **keyVaultUri**: string (Required): They key vault secret uri to obtain the source storage SAS token. -* **type**: 'AzureStorageBlobContainer' | string: The type of source for the import pipeline. -* **uri**: string: The source uri of the import pipeline. -When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" -When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" - -## PipelineTriggerProperties -### Properties -* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) - -## PipelineSourceTriggerProperties -### Properties -* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. - -## PipelineRunProperties -### Properties -* **forceUpdateTag**: string: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **request**: [PipelineRunRequest](#pipelinerunrequest): The request properties provided for a pipeline run. -* **response**: [PipelineRunResponse](#pipelinerunresponse) (ReadOnly): The response properties returned for a pipeline run. - -## PipelineRunRequest -### Properties -* **artifacts**: string[]: List of source artifacts to be transferred by the pipeline. -Specify an image by repository ('hello-world'). This will use the 'latest' tag. -Specify an image by tag ('hello-world:latest'). -Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). -* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. -* **pipelineResourceId**: string: The resource ID of the pipeline to run. -* **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) -* **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) - -## PipelineRunSourceProperties -### Properties -* **name**: string: The name of the source. -* **type**: 'AzureStorageBlob' | string: The type of the source. - -## PipelineRunTargetProperties +## SyncProperties ### Properties -* **name**: string: The name of the target. -* **type**: 'AzureStorageBlob' | string: The type of the target. +* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. +* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. +* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. +* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. -## PipelineRunResponse +## SystemData ### Properties -* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. -* **finishTime**: string: The time the pipeline run finished. -* **importedArtifacts**: string[]: The artifacts imported in the pipeline run. -* **pipelineRunErrorMessage**: string: The detailed error message for the pipeline run in the case of failure. -* **progress**: [ProgressProperties](#progressproperties) -* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties): The properties of the import pipeline source. -* **startTime**: string: The time the pipeline run started. -* **status**: string: The current status of the pipeline run. -* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. -* **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. -## ProgressProperties +## Target ### Properties -* **percentage**: string: The percentage complete of the copy operation. +* **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. +* **length**: int (ReadOnly): The number of bytes of the content. Same as Size field. +* **mediaType**: string (ReadOnly): The MIME type of the referenced object. +* **name**: string (ReadOnly): The name of the artifact. +* **repository**: string (ReadOnly): The repository name. +* **size**: int (ReadOnly): The number of bytes of the content. Same as Length field. +* **tag**: string (ReadOnly): The tag name. +* **url**: string (ReadOnly): The direct URL to the content. +* **version**: string (ReadOnly): The version of the artifact. -## PipelineTriggerDescriptor +## TlsCertificateProperties ### Properties -* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) +* **location**: string (ReadOnly): Indicates the location of the certificates. +* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. -## PipelineSourceTriggerDescriptor +## TlsProperties ### Properties -* **timestamp**: string: The timestamp when the source update happened. +* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. +* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. -## ReplicationProperties +## TokenCertificate ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. +* **expiry**: string: The expiry datetime of the certificate. +* **name**: 'certificate1' | 'certificate2' | string +* **thumbprint**: string: The thumbprint of the certificate. -## ResourceTags +## TokenCredentialsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate +* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword -## ScopeMapProperties +## TokenPassword ### Properties -* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. -E.g. repositories/repository-name/content/read, -repositories/repository-name/metadata/write -* **creationDate**: string (ReadOnly): The creation date of scope map. -* **description**: string: The user friendly description of the scope map. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. +* **creationTime**: string: The creation datetime of the password. +* **expiry**: string: The expiry datetime of the password. +* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" +* **value**: string (ReadOnly): The password value. ## TokenProperties ### Properties @@ -445,24 +535,25 @@ repositories/repository-name/metadata/write * **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. * **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. -## TokenCredentialsProperties +## TrustPolicy ### Properties -* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate -* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. -## TokenCertificate +## UserIdentityProperties ### Properties -* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. -* **expiry**: string: The expiry datetime of the certificate. -* **name**: 'certificate1' | 'certificate2' | string -* **thumbprint**: string: The thumbprint of the certificate. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## TokenPassword +## VirtualNetworkRule ### Properties -* **creationTime**: string: The creation datetime of the password. -* **expiry**: string: The expiry datetime of the password. -* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" -* **value**: string (ReadOnly): The password value. +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## WebhookPropertiesCreateParameters ### Properties @@ -478,94 +569,3 @@ repositories/repository-name/metadata/write ### Additional Properties * **Additional Properties Type**: string -## WebhookCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RegistryListCredentialsResult -### Properties -* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. -* **username**: string (ReadOnly): The username for a container registry. - -## RegistryPassword -### Properties -* **name**: 'password' | 'password2' (ReadOnly): The password name. -* **value**: string (ReadOnly): The password value. - -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent -### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. - -## Actor -### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. - -## Request -### Properties -* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. -* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. -* **id**: string (ReadOnly): The ID of the request that initiated the event. -* **method**: string (ReadOnly): The request method that generated the event. -* **useragent**: string (ReadOnly): The user agent header of the request. - -## Source -### Properties -* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. -* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. - -## Target -### Properties -* **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. -* **length**: int (ReadOnly): The number of bytes of the content. Same as Size field. -* **mediaType**: string (ReadOnly): The MIME type of the referenced object. -* **name**: string (ReadOnly): The name of the artifact. -* **repository**: string (ReadOnly): The repository name. -* **size**: int (ReadOnly): The number of bytes of the content. Same as Length field. -* **tag**: string (ReadOnly): The tag name. -* **url**: string (ReadOnly): The direct URL to the content. -* **version**: string (ReadOnly): The version of the artifact. - -## EventRequestMessageHeaders -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventResponseMessage -### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventResponseMessageHeaders -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/containerregistry/microsoft.containerregistry/2021-09-01/types.md b/generated/containerregistry/microsoft.containerregistry/2021-09-01/types.md index 98a50bff85..05ebc18172 100644 --- a/generated/containerregistry/microsoft.containerregistry/2021-09-01/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2021-09-01/types.md @@ -58,6 +58,66 @@ * **ApiVersion**: 2021-09-01 * **Output**: [EventListResult](#eventlistresult) +## Actor +### Properties +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) +* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. + +## Event +### Properties +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. + +## EventContent +### Properties +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. + +## EventListResult +### Properties +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. + +## EventRequestMessage +### Properties +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventRequestMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventResponseMessage +### Properties +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventResponseMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ExportPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + ## IdentityProperties ### Properties * **principalId**: string: The principal ID of resource identity. @@ -73,32 +133,10 @@ dictionary key references will be ARM resource ids in the form: ### Additional Properties * **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. - -## RegistryProperties -### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. -* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of private endpoint connection resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry - -## EncryptionProperty +## IPRule ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) -* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. +* **action**: 'Allow' | string: The action of IP ACL rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ## KeyVaultProperties ### Properties @@ -113,11 +151,6 @@ dictionary key references will be ARM resource ids in the form: * **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. * **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. -## IPRule -### Properties -* **action**: 'Allow' | string: The action of IP ACL rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - ## Policies ### Properties * **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. @@ -125,24 +158,9 @@ dictionary key references will be ARM resource ids in the form: * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. * **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. -## ExportPolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## QuarantinePolicy -### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## RetentionPolicy -### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. - -## TrustPolicy +## PrivateEndpoint ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. +* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. ## PrivateEndpointConnection ### Properties @@ -158,40 +176,42 @@ dictionary key references will be ARM resource ids in the form: * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of private endpoint connection resource. -## PrivateEndpoint -### Properties -* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## QuarantinePolicy ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## Status +## RegistryListCredentialsResult ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. +* **username**: string (ReadOnly): The username for a container registry. -## Sku +## RegistryPassword ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **name**: 'password' | 'password2' (ReadOnly): The password name. +* **value**: string (ReadOnly): The password value. -## ResourceTags +## RegistryProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. +* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of private endpoint connection resource. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry ## ReplicationProperties ### Properties @@ -200,85 +220,54 @@ dictionary key references will be ARM resource ids in the form: * **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. * **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WebhookPropertiesCreateParameters +## Request ### Properties -* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. -* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of private endpoint connection resource. -* **scope**: 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. -* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. -* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. +* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. +* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. +* **id**: string (ReadOnly): The ID of the request that initiated the event. +* **method**: string (ReadOnly): The request method that generated the event. +* **useragent**: string (ReadOnly): The user agent header of the request. -## WebhookPropertiesCreateParametersCustomHeaders +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WebhookCreateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## RegistryListCredentialsResult -### Properties -* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. -* **username**: string (ReadOnly): The username for a container registry. - -## RegistryPassword -### Properties -* **name**: 'password' | 'password2' (ReadOnly): The password name. -* **value**: string (ReadOnly): The password value. - -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage +## RetentionPolicy ### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## EventContent +## Sku ### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. -## Actor +## Source ### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. +* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. +* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. -## Request +## Status ### Properties -* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. -* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. -* **id**: string (ReadOnly): The ID of the request that initiated the event. -* **method**: string (ReadOnly): The request method that generated the event. -* **useragent**: string (ReadOnly): The user agent header of the request. +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. -## Source +## SystemData ### Properties -* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. -* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. ## Target ### Properties @@ -292,20 +281,31 @@ dictionary key references will be ARM resource ids in the form: * **url**: string (ReadOnly): The direct URL to the content. * **version**: string (ReadOnly): The version of the artifact. -## EventRequestMessageHeaders +## TrustPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## WebhookCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventResponseMessage +## WebhookPropertiesCreateParameters ### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. +* **actions**: 'chart_delete' | 'chart_push' | 'delete' | 'push' | 'quarantine' | string[] (Required): The list of actions that trigger the webhook to post notifications. +* **customHeaders**: [WebhookPropertiesCreateParametersCustomHeaders](#webhookpropertiescreateparameterscustomheaders) (WriteOnly): Custom headers that will be added to the webhook notifications. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of private endpoint connection resource. +* **scope**: 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. +* **serviceUri**: string (Required, WriteOnly): The service URI for the webhook to post notifications. +* **status**: 'disabled' | 'enabled' | string: The status of the webhook at the time the operation was called. -## EventResponseMessageHeaders +## WebhookPropertiesCreateParametersCustomHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/containerregistry/microsoft.containerregistry/2021-12-01-preview/types.md b/generated/containerregistry/microsoft.containerregistry/2021-12-01-preview/types.md index 5463cdb7c8..9b2e1678d5 100644 --- a/generated/containerregistry/microsoft.containerregistry/2021-12-01-preview/types.md +++ b/generated/containerregistry/microsoft.containerregistry/2021-12-01-preview/types.md @@ -122,6 +122,99 @@ * **ApiVersion**: 2021-12-01-preview * **Output**: [EventListResult](#eventlistresult) +## ActivationProperties +### Properties +* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. + +## Actor +### Properties +* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. + +## ConnectedRegistryProperties +### Properties +* **activation**: [ActivationProperties](#activationproperties) (ReadOnly): The activation properties of the connected registry. +* **clientTokenIds**: string[]: The list of the ACR token resource IDs used to authenticate clients to the connected registry. +* **connectionState**: 'Offline' | 'Online' | 'Syncing' | 'Unhealthy' | string (ReadOnly): The current connection state of the connected registry. +* **lastActivityTime**: string (ReadOnly): The last activity time of the connected registry. +* **logging**: [LoggingProperties](#loggingproperties): The logging properties of the connected registry. +* **loginServer**: [LoginServerProperties](#loginserverproperties): The login server properties of the connected registry. +* **mode**: 'Mirror' | 'ReadOnly' | 'ReadWrite' | 'Registry' | string (Required): The mode of the connected registry resource that indicates the permissions of the registry. +* **notificationsList**: string[]: The list of notifications subscription information for the connected registry. +* **parent**: [ParentProperties](#parentproperties) (Required): The properties of the connected registry parent. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. +* **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) +* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. + +## Event +### Properties +* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. +* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. +* **id**: string (ReadOnly): The event ID. + +## EventContent +### Properties +* **action**: string (ReadOnly): The action that encompasses the provided event. +* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. +* **id**: string (ReadOnly): The event ID. +* **request**: [Request](#request) (ReadOnly): The request that generated the event. +* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. +* **target**: [Target](#target) (ReadOnly): The target of the event. +* **timestamp**: string (ReadOnly): The time at which the event occurred. + +## EventListResult +### Properties +* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. +* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. + +## EventRequestMessage +### Properties +* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. +* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. +* **method**: string (ReadOnly): The HTTP method used to send the event request message. +* **requestUri**: string (ReadOnly): The URI used to send the event request message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventRequestMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventResponseMessage +### Properties +* **content**: string (ReadOnly): The content of the event response message. +* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. +* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. +* **statusCode**: string (ReadOnly): The status code of the event response message. +* **version**: string (ReadOnly): The HTTP message version. + +## EventResponseMessageHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ExportPipelineProperties +### Properties +* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties) (Required): The properties of the export pipeline target. + +## ExportPipelineTargetProperties +### Properties +* **keyVaultUri**: string (Required): They key vault secret uri to obtain the target storage SAS token. +* **type**: string: The type of target for the export pipeline. +* **uri**: string: The target uri of the export pipeline. +When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" +When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" + +## ExportPolicy +### Properties +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. + ## IdentityProperties ### Properties * **principalId**: string: The principal ID of resource identity. @@ -137,33 +230,25 @@ dictionary key references will be ARM resource ids in the form: ### Additional Properties * **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## UserIdentityProperties +## ImportPipelineProperties ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties) (Required): The properties of the import pipeline source. +* **trigger**: [PipelineTriggerProperties](#pipelinetriggerproperties) -## RegistryProperties +## ImportPipelineSourceProperties ### Properties -* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. -* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. -* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. -* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. -* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. -* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. -* **policies**: [Policies](#policies): The policies for a container registry. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **keyVaultUri**: string (Required): They key vault secret uri to obtain the source storage SAS token. +* **type**: 'AzureStorageBlobContainer' | string: The type of source for the import pipeline. +* **uri**: string: The source uri of the import pipeline. +When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" +When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" -## EncryptionProperty +## IPRule ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) -* **status**: 'disabled' | 'enabled' | string: Indicates whether or not the encryption is enabled for container registry. +* **action**: 'Allow' | string: The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ## KeyVaultProperties ### Properties @@ -173,47 +258,94 @@ dictionary key references will be ARM resource ids in the form: * **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of the last successful key rotation. * **versionedKeyIdentifier**: string (ReadOnly): The fully qualified key identifier that includes the version of the key that is actually used for encryption. +## LoggingProperties +### Properties +* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. +* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. + +## LoginServerProperties +### Properties +* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. +* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. + ## NetworkRuleSet ### Properties * **defaultAction**: 'Allow' | 'Deny' | string (Required): The default action of allow or deny when no other rules match. * **ipRules**: [IPRule](#iprule)[]: The IP ACL rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The virtual network rules. -## IPRule +## ParentProperties ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. +* **id**: string: The resource ID of the parent to which the connected registry will be associated. +* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. -## VirtualNetworkRule +## PipelineRunProperties ### Properties -* **action**: 'Allow' | string: The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **forceUpdateTag**: string: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **request**: [PipelineRunRequest](#pipelinerunrequest): The request properties provided for a pipeline run. +* **response**: [PipelineRunResponse](#pipelinerunresponse) (ReadOnly): The response properties returned for a pipeline run. -## Policies +## PipelineRunRequest ### Properties -* **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. -* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. -* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. +* **artifacts**: string[]: List of source artifacts to be transferred by the pipeline. +Specify an image by repository ('hello-world'). This will use the 'latest' tag. +Specify an image by tag ('hello-world:latest'). +Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). +* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. +* **pipelineResourceId**: string: The resource ID of the pipeline to run. +* **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) +* **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) -## ExportPolicy +## PipelineRunResponse ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. +* **finishTime**: string: The time the pipeline run finished. +* **importedArtifacts**: string[]: The artifacts imported in the pipeline run. +* **pipelineRunErrorMessage**: string: The detailed error message for the pipeline run in the case of failure. +* **progress**: [ProgressProperties](#progressproperties) +* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties): The properties of the import pipeline source. +* **startTime**: string: The time the pipeline run started. +* **status**: string: The current status of the pipeline run. +* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. +* **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) -## QuarantinePolicy +## PipelineRunSourceProperties ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string: The name of the source. +* **type**: 'AzureStorageBlob' | string: The type of the source. -## RetentionPolicy +## PipelineRunTargetProperties ### Properties -* **days**: int: The number of days to retain an untagged manifest after which it gets purged. -* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **name**: string: The name of the target. +* **type**: 'AzureStorageBlob' | string: The type of the target. -## TrustPolicy +## PipelineSourceTriggerDescriptor ### Properties -* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -* **type**: 'Notary' | string: The type of trust policy. +* **timestamp**: string: The timestamp when the source update happened. + +## PipelineSourceTriggerProperties +### Properties +* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. + +## PipelineTriggerDescriptor +### Properties +* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) + +## PipelineTriggerProperties +### Properties +* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) + +## Policies +### Properties +* **exportPolicy**: [ExportPolicy](#exportpolicy): The export policy for a container registry. +* **quarantinePolicy**: [QuarantinePolicy](#quarantinepolicy): The quarantine policy for a container registry. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): The retention policy for a container registry. +* **trustPolicy**: [TrustPolicy](#trustpolicy): The content trust policy for a container registry. + +## PrivateEndpoint +### Properties +* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. ## PrivateEndpointConnection ### Properties @@ -229,93 +361,104 @@ dictionary key references will be ARM resource ids in the form: * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The state of a private link service connection. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: This is private endpoint resource created with Microsoft.Network resource provider. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | 'Recreate' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The description for connection status. For example if connection is rejected it can indicate reason for rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ProgressProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. +* **percentage**: string: The percentage complete of the copy operation. -## Status +## QuarantinePolicy ### Properties -* **displayStatus**: string (ReadOnly): The short label for the status. -* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. -* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## Sku +## RegistryListCredentialsResult ### Properties -* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. -* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. +* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. +* **username**: string (ReadOnly): The username for a container registry. -## ResourceTags +## RegistryPassword ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'password' | 'password2' (ReadOnly): The password name. +* **value**: string (ReadOnly): The password value. -## ConnectedRegistryProperties +## RegistryProperties ### Properties -* **activation**: [ActivationProperties](#activationproperties) (ReadOnly): The activation properties of the connected registry. -* **clientTokenIds**: string[]: The list of the ACR token resource IDs used to authenticate clients to the connected registry. -* **connectionState**: 'Offline' | 'Online' | 'Syncing' | 'Unhealthy' | string (ReadOnly): The current connection state of the connected registry. -* **lastActivityTime**: string (ReadOnly): The last activity time of the connected registry. -* **logging**: [LoggingProperties](#loggingproperties): The logging properties of the connected registry. -* **loginServer**: [LoginServerProperties](#loginserverproperties): The login server properties of the connected registry. -* **mode**: 'Mirror' | 'ReadOnly' | 'ReadWrite' | 'Registry' | string (Required): The mode of the connected registry resource that indicates the permissions of the registry. -* **notificationsList**: string[]: The list of notifications subscription information for the connected registry. -* **parent**: [ParentProperties](#parentproperties) (Required): The properties of the connected registry parent. +* **adminUserEnabled**: bool: The value that indicates whether the admin user is enabled. +* **anonymousPullEnabled**: bool: Enables registry-wide pull from unauthenticated clients. +* **creationDate**: string (ReadOnly): The creation date of the container registry in ISO8601 format. +* **dataEndpointEnabled**: bool: Enable a single data endpoint per region for serving data. +* **dataEndpointHostNames**: string[] (ReadOnly): List of host names that will serve data when dataEndpointEnabled is true. +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **loginServer**: string (ReadOnly): The URL that can be used to log into the container registry. +* **networkRuleBypassOptions**: 'AzureServices' | 'None' | string: Whether to allow trusted Azure services to access a network restricted registry. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): The network rule set for a container registry. +* **policies**: [Policies](#policies): The policies for a container registry. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections for a container registry. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **statusDetails**: [StatusDetailProperties](#statusdetailproperties)[] (ReadOnly): The list of current statuses of the connected registry. -* **version**: string (ReadOnly): The current version of ACR runtime on the connected registry. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the container registry. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## ActivationProperties +## ReplicationProperties ### Properties -* **status**: 'Active' | 'Inactive' | string (ReadOnly): The activation status of the connected registry. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. +* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry -## LoggingProperties +## Request ### Properties -* **auditLogStatus**: 'Disabled' | 'Enabled' | string: Indicates whether audit logs are enabled on the connected registry. -* **logLevel**: 'Debug' | 'Error' | 'Information' | 'None' | 'Warning' | string: The verbosity of logs persisted on the connected registry. +* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. +* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. +* **id**: string (ReadOnly): The ID of the request that initiated the event. +* **method**: string (ReadOnly): The request method that generated the event. +* **useragent**: string (ReadOnly): The user agent header of the request. -## LoginServerProperties +## ResourceTags ### Properties -* **host**: string (ReadOnly): The host of the connected registry. Can be FQDN or IP. -* **tls**: [TlsProperties](#tlsproperties) (ReadOnly): The TLS properties of the connected registry login server. +### Additional Properties +* **Additional Properties Type**: string -## TlsProperties +## ResourceTags ### Properties -* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. -* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. +### Additional Properties +* **Additional Properties Type**: string -## TlsCertificateProperties +## RetentionPolicy ### Properties -* **location**: string (ReadOnly): Indicates the location of the certificates. -* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. +* **days**: int: The number of days to retain an untagged manifest after which it gets purged. +* **lastUpdatedTime**: string (ReadOnly): The timestamp when the policy was last updated. +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. -## ParentProperties +## ScopeMapProperties ### Properties -* **id**: string: The resource ID of the parent to which the connected registry will be associated. -* **syncProperties**: [SyncProperties](#syncproperties) (Required): The sync properties of the connected registry with its parent. +* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. +E.g. repositories/repository-name/content/read, +repositories/repository-name/metadata/write +* **creationDate**: string (ReadOnly): The creation date of scope map. +* **description**: string: The user friendly description of the scope map. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. -## SyncProperties +## Sku ### Properties -* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. -* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. -* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. -* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. -* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. +* **name**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (Required): The SKU name of the container registry. Required for registry creation. +* **tier**: 'Basic' | 'Classic' | 'Premium' | 'Standard' | string (ReadOnly): The SKU tier based on the SKU name. + +## Source +### Properties +* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. +* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. + +## Status +### Properties +* **displayStatus**: string (ReadOnly): The short label for the status. +* **message**: string (ReadOnly): The detailed message for the status, including alerts and error messages. +* **timestamp**: string (ReadOnly): The timestamp when the status was changed to the current value. ## StatusDetailProperties ### Properties @@ -325,117 +468,64 @@ dictionary key references will be ARM resource ids in the form: * **timestamp**: string (ReadOnly): The timestamp of the status. * **type**: string (ReadOnly): The component of the connected registry corresponding to the status. -## ExportPipelineProperties -### Properties -* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties) (Required): The properties of the export pipeline target. - -## ExportPipelineTargetProperties -### Properties -* **keyVaultUri**: string (Required): They key vault secret uri to obtain the target storage SAS token. -* **type**: string: The type of target for the export pipeline. -* **uri**: string: The target uri of the export pipeline. -When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" -When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" - -## ImportPipelineProperties -### Properties -* **options**: 'ContinueOnErrors' | 'DeleteSourceBlobOnSuccess' | 'OverwriteBlobs' | 'OverwriteTags' | string[]: The list of all options configured for the pipeline. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties) (Required): The properties of the import pipeline source. -* **trigger**: [PipelineTriggerProperties](#pipelinetriggerproperties) - -## ImportPipelineSourceProperties -### Properties -* **keyVaultUri**: string (Required): They key vault secret uri to obtain the source storage SAS token. -* **type**: 'AzureStorageBlobContainer' | string: The type of source for the import pipeline. -* **uri**: string: The source uri of the import pipeline. -When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" -When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" - -## PipelineTriggerProperties -### Properties -* **sourceTrigger**: [PipelineSourceTriggerProperties](#pipelinesourcetriggerproperties) - -## PipelineSourceTriggerProperties -### Properties -* **status**: 'Disabled' | 'Enabled' | string (Required): The current status of the source trigger. - -## PipelineRunProperties -### Properties -* **forceUpdateTag**: string: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **request**: [PipelineRunRequest](#pipelinerunrequest): The request properties provided for a pipeline run. -* **response**: [PipelineRunResponse](#pipelinerunresponse) (ReadOnly): The response properties returned for a pipeline run. - -## PipelineRunRequest -### Properties -* **artifacts**: string[]: List of source artifacts to be transferred by the pipeline. -Specify an image by repository ('hello-world'). This will use the 'latest' tag. -Specify an image by tag ('hello-world:latest'). -Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). -* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. -* **pipelineResourceId**: string: The resource ID of the pipeline to run. -* **source**: [PipelineRunSourceProperties](#pipelinerunsourceproperties) -* **target**: [PipelineRunTargetProperties](#pipelineruntargetproperties) - -## PipelineRunSourceProperties -### Properties -* **name**: string: The name of the source. -* **type**: 'AzureStorageBlob' | string: The type of the source. - -## PipelineRunTargetProperties +## SyncProperties ### Properties -* **name**: string: The name of the target. -* **type**: 'AzureStorageBlob' | string: The type of the target. +* **gatewayEndpoint**: string (ReadOnly): The gateway endpoint used by the connected registry to communicate with its parent. +* **lastSyncTime**: string (ReadOnly): The last time a sync occurred between the connected registry and its parent. +* **messageTtl**: string (Required): The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **schedule**: string: The cron expression indicating the schedule that the connected registry will sync with its parent. +* **syncWindow**: string: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. +* **tokenId**: string (Required): The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. -## PipelineRunResponse +## SystemData ### Properties -* **catalogDigest**: string: The digest of the tar used to transfer the artifacts. -* **finishTime**: string: The time the pipeline run finished. -* **importedArtifacts**: string[]: The artifacts imported in the pipeline run. -* **pipelineRunErrorMessage**: string: The detailed error message for the pipeline run in the case of failure. -* **progress**: [ProgressProperties](#progressproperties) -* **source**: [ImportPipelineSourceProperties](#importpipelinesourceproperties): The properties of the import pipeline source. -* **startTime**: string: The time the pipeline run started. -* **status**: string: The current status of the pipeline run. -* **target**: [ExportPipelineTargetProperties](#exportpipelinetargetproperties): The properties of the export pipeline target. -* **trigger**: [PipelineTriggerDescriptor](#pipelinetriggerdescriptor) +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. -## ProgressProperties +## Target ### Properties -* **percentage**: string: The percentage complete of the copy operation. +* **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. +* **length**: int (ReadOnly): The number of bytes of the content. Same as Size field. +* **mediaType**: string (ReadOnly): The MIME type of the referenced object. +* **name**: string (ReadOnly): The name of the artifact. +* **repository**: string (ReadOnly): The repository name. +* **size**: int (ReadOnly): The number of bytes of the content. Same as Length field. +* **tag**: string (ReadOnly): The tag name. +* **url**: string (ReadOnly): The direct URL to the content. +* **version**: string (ReadOnly): The version of the artifact. -## PipelineTriggerDescriptor +## TlsCertificateProperties ### Properties -* **sourceTrigger**: [PipelineSourceTriggerDescriptor](#pipelinesourcetriggerdescriptor) +* **location**: string (ReadOnly): Indicates the location of the certificates. +* **type**: 'LocalDirectory' | string (ReadOnly): The type of certificate location. -## PipelineSourceTriggerDescriptor +## TlsProperties ### Properties -* **timestamp**: string: The timestamp when the source update happened. +* **certificate**: [TlsCertificateProperties](#tlscertificateproperties) (ReadOnly): The TLS certificate properties of the connected registry login server. +* **status**: 'Disabled' | 'Enabled' | string (ReadOnly): Indicates whether HTTPS is enabled for the login server. -## ReplicationProperties +## TokenCertificate ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **regionEndpointEnabled**: bool: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. -* **status**: [Status](#status) (ReadOnly): The status of an Azure resource at the time the operation was called. -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string: Whether or not zone redundancy is enabled for this container registry +* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. +* **expiry**: string: The expiry datetime of the certificate. +* **name**: 'certificate1' | 'certificate2' | string +* **thumbprint**: string: The thumbprint of the certificate. -## ResourceTags +## TokenCredentialsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate +* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword -## ScopeMapProperties +## TokenPassword ### Properties -* **actions**: string[] (Required): The list of scoped permissions for registry artifacts. -E.g. repositories/repository-name/content/read, -repositories/repository-name/metadata/write -* **creationDate**: string (ReadOnly): The creation date of scope map. -* **description**: string: The user friendly description of the scope map. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **type**: string (ReadOnly): The type of the scope map. E.g. BuildIn scope map. +* **creationTime**: string: The creation datetime of the password. +* **expiry**: string: The expiry datetime of the password. +* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" +* **value**: string (ReadOnly): The password value. ## TokenProperties ### Properties @@ -445,24 +535,25 @@ repositories/repository-name/metadata/write * **scopeMapId**: string: The resource ID of the scope map to which the token will be associated with. * **status**: 'disabled' | 'enabled' | string: The status of the token example enabled or disabled. -## TokenCredentialsProperties +## TrustPolicy ### Properties -* **certificates**: [TokenCertificate](#tokencertificate)[]: Array of TokenCertificate -* **passwords**: [TokenPassword](#tokenpassword)[]: Array of TokenPassword +* **status**: 'disabled' | 'enabled' | string: The value that indicates whether the policy is enabled or not. +* **type**: 'Notary' | string: The type of trust policy. -## TokenCertificate +## UserIdentityProperties ### Properties -* **encodedPemCertificate**: string: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. -* **expiry**: string: The expiry datetime of the certificate. -* **name**: 'certificate1' | 'certificate2' | string -* **thumbprint**: string: The thumbprint of the certificate. +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. -## TokenPassword +## VirtualNetworkRule ### Properties -* **creationTime**: string: The creation datetime of the password. -* **expiry**: string: The expiry datetime of the password. -* **name**: 'password1' | 'password2' | string: The password name "password1" or "password2" -* **value**: string (ReadOnly): The password value. +* **action**: 'Allow' | string: The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. + +## WebhookCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## WebhookPropertiesCreateParameters ### Properties @@ -478,94 +569,3 @@ repositories/repository-name/metadata/write ### Additional Properties * **Additional Properties Type**: string -## WebhookCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RegistryListCredentialsResult -### Properties -* **passwords**: [RegistryPassword](#registrypassword)[] (ReadOnly): The list of passwords for a container registry. -* **username**: string (ReadOnly): The username for a container registry. - -## RegistryPassword -### Properties -* **name**: 'password' | 'password2' (ReadOnly): The password name. -* **value**: string (ReadOnly): The password value. - -## EventListResult -### Properties -* **nextLink**: string (ReadOnly): The URI that can be used to request the next list of events. -* **value**: [Event](#event)[] (ReadOnly): The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. - -## Event -### Properties -* **eventRequestMessage**: [EventRequestMessage](#eventrequestmessage) (ReadOnly): The event request message sent to the service URI. -* **eventResponseMessage**: [EventResponseMessage](#eventresponsemessage) (ReadOnly): The event response message received from the service URI. -* **id**: string (ReadOnly): The event ID. - -## EventRequestMessage -### Properties -* **content**: [EventContent](#eventcontent) (ReadOnly): The content of the event request message. -* **headers**: [EventRequestMessageHeaders](#eventrequestmessageheaders) (ReadOnly): The headers of the event request message. -* **method**: string (ReadOnly): The HTTP method used to send the event request message. -* **requestUri**: string (ReadOnly): The URI used to send the event request message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventContent -### Properties -* **action**: string (ReadOnly): The action that encompasses the provided event. -* **actor**: [Actor](#actor) (ReadOnly): The agent that initiated the event. For most situations, this could be from the authorization context of the request. -* **id**: string (ReadOnly): The event ID. -* **request**: [Request](#request) (ReadOnly): The request that generated the event. -* **source**: [Source](#source) (ReadOnly): The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. -* **target**: [Target](#target) (ReadOnly): The target of the event. -* **timestamp**: string (ReadOnly): The time at which the event occurred. - -## Actor -### Properties -* **name**: string (ReadOnly): The subject or username associated with the request context that generated the event. - -## Request -### Properties -* **addr**: string (ReadOnly): The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. -* **host**: string (ReadOnly): The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. -* **id**: string (ReadOnly): The ID of the request that initiated the event. -* **method**: string (ReadOnly): The request method that generated the event. -* **useragent**: string (ReadOnly): The user agent header of the request. - -## Source -### Properties -* **addr**: string (ReadOnly): The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. -* **instanceID**: string (ReadOnly): The running instance of an application. Changes after each restart. - -## Target -### Properties -* **digest**: string (ReadOnly): The digest of the content, as defined by the Registry V2 HTTP API Specification. -* **length**: int (ReadOnly): The number of bytes of the content. Same as Size field. -* **mediaType**: string (ReadOnly): The MIME type of the referenced object. -* **name**: string (ReadOnly): The name of the artifact. -* **repository**: string (ReadOnly): The repository name. -* **size**: int (ReadOnly): The number of bytes of the content. Same as Length field. -* **tag**: string (ReadOnly): The tag name. -* **url**: string (ReadOnly): The direct URL to the content. -* **version**: string (ReadOnly): The version of the artifact. - -## EventRequestMessageHeaders -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventResponseMessage -### Properties -* **content**: string (ReadOnly): The content of the event response message. -* **headers**: [EventResponseMessageHeaders](#eventresponsemessageheaders) (ReadOnly): The headers of the event response message. -* **reasonPhrase**: string (ReadOnly): The reason phrase of the event response message. -* **statusCode**: string (ReadOnly): The status code of the event response message. -* **version**: string (ReadOnly): The HTTP message version. - -## EventResponseMessageHeaders -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/containerservice/log.out b/generated/containerservice/log.out index d289a3942a..428e100999 100644 --- a/generated/containerservice/log.out +++ b/generated/containerservice/log.out @@ -27,7 +27,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.containerservice-2022-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -54,14 +54,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterAddonProfile-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-03-01/managedClusters.json:4207:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 23ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.containerservice-2022-03-02-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -88,14 +88,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterAddonProfile-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-03-02-preview/managedClusters.json:4518:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 21ms +info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.containerservice-2022-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -122,14 +122,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterAddonProfile-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-02-01/managedClusters.json:4307:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.containerservice-2022-02-02-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -156,14 +156,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterAddonProfile-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json:4547:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 18ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.containerservice-2022-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -190,7 +190,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-01-01/managedClusters.json:2222:5 @@ -356,7 +356,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-01-02-preview/managedClusters.json:2240:5 @@ -522,7 +522,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2021-11-01-preview/managedClusters.json:2231:5 @@ -688,7 +688,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-10-01/managedClusters.json:2219:5 @@ -827,7 +827,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OSOptionProfile' with an unde warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 10ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.containerservice-2021-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -854,7 +854,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-09-01/managedClusters.json:2205:5 @@ -993,7 +993,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OSOptionProfile' with an unde warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 17ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.containerservice-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1020,7 +1020,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-08-01/managedClusters.json:2196:5 @@ -1159,7 +1159,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OSOptionProfile' with an unde warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.containerservice-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1186,7 +1186,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json:1917:5 @@ -1325,7 +1325,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OSOptionProfile' with an unde warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.containerservice-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1352,7 +1352,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-05-01/managedClusters.json:1911:5 @@ -1495,7 +1495,7 @@ warning | PreCheck/SchemaMissingType | The schema 'OSOptionProfile' with an unde warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 15ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.containerservice-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1522,7 +1522,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-03-01/managedClusters.json:1872:5 @@ -1692,7 +1692,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-02-01/managedClusters.json:1696:5 @@ -1821,7 +1821,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.containerservice-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1848,7 +1848,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-12-01/managedClusters.json:1684:5 @@ -1977,7 +1977,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.containerservice-2020-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2004,7 +2004,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-11-01/managedClusters.json:1475:5 @@ -2123,7 +2123,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 21ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.containerservice-2019-04-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2150,7 +2150,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json:344:5 @@ -2212,7 +2212,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json:257:5 @@ -2274,7 +2274,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrchestratorProfile' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-08-01/location.json:76:5 @@ -2402,7 +2402,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json:1472:5 @@ -2538,7 +2538,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json:1286:5 @@ -2645,7 +2645,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.containerservice-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2672,7 +2672,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json:1229:5 @@ -2779,7 +2779,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.containerservice-2020-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2806,7 +2806,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json:1021:5 @@ -2913,7 +2913,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.containerservice-2020-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -2940,7 +2940,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json:1020:5 @@ -3045,7 +3045,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterSKU' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.containerservice-2020-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3072,7 +3072,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json:1020:5 @@ -3200,7 +3200,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json:1017:5 @@ -3328,7 +3328,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/managedClusters.json:1017:5 @@ -3429,7 +3429,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.containerservice-2019-10-27-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3456,7 +3456,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2019-10-27-preview/openShiftManagedClusters.json:347:5 @@ -3495,7 +3495,7 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsObject' with an undefined warning | PreCheck/SchemaMissingType | The schema 'OpenShiftManagedClusterListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2019-10-27-preview/openShiftManagedClusters.json:797:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.containerservice-2019-09-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3522,7 +3522,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2019-09-30/openShiftManagedClusters.json:344:5 @@ -3559,7 +3559,7 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsObject' with an undefined warning | PreCheck/SchemaMissingType | The schema 'OpenShiftManagedClusterListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2019-09-30/openShiftManagedClusters.json:785:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.containerservice-2019-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3586,7 +3586,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-10-01/managedClusters.json:1017:5 @@ -3679,7 +3679,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.containerservice-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3706,7 +3706,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrchestratorProfile' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-06-01/location.json:76:5 @@ -3795,7 +3795,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.containerservice-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -3822,7 +3822,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-04-01/managedClusters.json:840:5 @@ -3930,7 +3930,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json:344:5 @@ -3992,7 +3992,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-02-01/managedClusters.json:971:5 @@ -4065,7 +4065,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.containerservice-2017-09-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4092,7 +4092,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrchestratorProfile' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json:76:5 @@ -4130,7 +4130,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json:660:5 @@ -4195,7 +4195,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.containerservice-2018-03-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4222,7 +4222,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json:648:5 @@ -4283,7 +4283,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CredentialResults' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.containerservice-2017-08-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4310,7 +4310,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json:412:5 @@ -4352,7 +4352,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedClusterUpgradeProfile' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json:1078:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.containerservice-2017-01-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4379,7 +4379,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json:273:5 @@ -4439,7 +4439,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json:230:5 @@ -4499,7 +4499,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json:225:5 @@ -4529,4 +4529,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ContainerServiceProperties' w - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json:510:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 149.73s. 80 files generated. +info | Autorest completed in 140.98s. 80 files generated. diff --git a/generated/containerservice/microsoft.containerservice/2016-03-30/types.md b/generated/containerservice/microsoft.containerservice/2016-03-30/types.md index 8881106e69..05c04bdea3 100644 --- a/generated/containerservice/microsoft.containerservice/2016-03-30/types.md +++ b/generated/containerservice/microsoft.containerservice/2016-03-30/types.md @@ -11,16 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int: 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. @@ -33,24 +23,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for all Linux VMs * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -61,6 +38,29 @@ ### Properties * **orchestratorType**: 'DCOS' | 'Swarm' (Required): The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs diff --git a/generated/containerservice/microsoft.containerservice/2016-09-30/types.md b/generated/containerservice/microsoft.containerservice/2016-09-30/types.md index 0121d0e2da..9c8441511f 100644 --- a/generated/containerservice/microsoft.containerservice/2016-09-30/types.md +++ b/generated/containerservice/microsoft.containerservice/2016-09-30/types.md @@ -11,18 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. -* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int (Required): 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. @@ -39,24 +27,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for Linux VMs. * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -72,6 +47,31 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string (Required): The secret password associated with the service principal. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. +* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs. diff --git a/generated/containerservice/microsoft.containerservice/2017-01-31/types.md b/generated/containerservice/microsoft.containerservice/2017-01-31/types.md index 3dbb52bd14..a475bcced9 100644 --- a/generated/containerservice/microsoft.containerservice/2017-01-31/types.md +++ b/generated/containerservice/microsoft.containerservice/2017-01-31/types.md @@ -11,18 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. -* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int (Required): 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. @@ -39,24 +27,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for Linux VMs. * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -72,6 +47,31 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string (Required): The secret password associated with the service principal. +## ContainerServiceProperties +### Properties +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[] (Required): Properties of the agent pool. +* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile) +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): the list of SSH public keys used to authenticate with Linux-based VMs. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. + ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs. diff --git a/generated/containerservice/microsoft.containerservice/2017-07-01/types.md b/generated/containerservice/microsoft.containerservice/2017-07-01/types.md index c4e10289ac..431f2b5ff2 100644 --- a/generated/containerservice/microsoft.containerservice/2017-07-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2017-07-01/types.md @@ -11,18 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/containerServices' (ReadOnly, DeployTimeConstant): The resource type -## ContainerServiceProperties -### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[]: Properties of the agent pool. -* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. -* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile): Profile for diagnostics on the container service cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. -* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. -* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile) (Required): Profile for the container service orchestrator. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified. -* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. - ## ContainerServiceAgentPoolProfile ### Properties * **count**: int: 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. @@ -44,24 +32,11 @@ ### Properties * **vmDiagnostics**: [ContainerServiceVMDiagnostics](#containerservicevmdiagnostics) (Required): Profile for diagnostics on the container service VMs. -## ContainerServiceVMDiagnostics -### Properties -* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. -* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. - ## ContainerServiceLinuxProfile ### Properties * **adminUsername**: string (Required): The administrator username to use for Linux VMs. * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - ## ContainerServiceMasterProfile ### Properties * **count**: int: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. @@ -84,17 +59,42 @@ * **keyVaultSecretRef**: [KeyVaultSecretRef](#keyvaultsecretref): Reference to a secret stored in Azure Key Vault. * **secret**: string: The secret password associated with the service principal in plain text. -## KeyVaultSecretRef +## ContainerServiceProperties ### Properties -* **secretName**: string (Required): The secret name. -* **vaultID**: string (Required): Key vault identifier. -* **version**: string: The secret version. +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[]: Properties of the agent pool. +* **customProfile**: [ContainerServiceCustomProfile](#containerservicecustomprofile): Properties to configure a custom container service cluster. +* **diagnosticsProfile**: [ContainerServiceDiagnosticsProfile](#containerservicediagnosticsprofile): Profile for diagnostics on the container service cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile) (Required): Profile for Linux VMs in the container service cluster. +* **masterProfile**: [ContainerServiceMasterProfile](#containerservicemasterprofile) (Required): Profile for the container service master. +* **orchestratorProfile**: [ContainerServiceOrchestratorProfile](#containerserviceorchestratorprofile) (Required): Profile for the container service orchestrator. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified. +* **windowsProfile**: [ContainerServiceWindowsProfile](#containerservicewindowsprofile): Profile for Windows VMs in the container service cluster. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## ContainerServiceVMDiagnostics +### Properties +* **enabled**: bool (Required): Whether the VM diagnostic agent is provisioned on the VM. +* **storageUri**: string (ReadOnly): The URI of the storage account where diagnostics are stored. ## ContainerServiceWindowsProfile ### Properties * **adminPassword**: string (Required): The administrator password to use for Windows VMs. * **adminUsername**: string (Required): The administrator username to use for Windows VMs. +## KeyVaultSecretRef +### Properties +* **secretName**: string (Required): The secret name. +* **vaultID**: string (Required): Key vault identifier. +* **version**: string: The secret version. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2017-08-31/types.md b/generated/containerservice/microsoft.containerservice/2017-08-31/types.md index d8cedf75d0..d3c34f526a 100644 --- a/generated/containerservice/microsoft.containerservice/2017-08-31/types.md +++ b/generated/containerservice/microsoft.containerservice/2017-08-31/types.md @@ -16,15 +16,9 @@ * **ApiVersion**: 2017-08-31 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterProperties +## AccessProfile ### Properties -* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[]: Properties of the agent pool. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. ## ContainerServiceAgentPoolProfile ### Properties @@ -44,6 +38,12 @@ * **adminUsername**: string (Required): The administrator username to use for Linux VMs. * **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. +## ContainerServicePrincipalProfile +### Properties +* **clientId**: string (Required): The ID for the service principal. +* **keyVaultSecretRef**: [KeyVaultSecretRef](#keyvaultsecretref): Reference to a secret stored in Azure Key Vault. +* **secret**: string: The secret password associated with the service principal in plain text. + ## ContainerServiceSshConfiguration ### Properties * **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. @@ -52,23 +52,12 @@ ### Properties * **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. -## ContainerServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **keyVaultSecretRef**: [KeyVaultSecretRef](#keyvaultsecretref): Reference to a secret stored in Azure Key Vault. -* **secret**: string: The secret password associated with the service principal in plain text. - ## KeyVaultSecretRef ### Properties * **secretName**: string (Required): The secret name. * **vaultID**: string (Required): Key vault identifier. * **version**: string: The secret version. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ManagedClusterAccessProfile ### Properties * **id**: string (ReadOnly): Resource Id @@ -78,9 +67,20 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags * **type**: string (ReadOnly): Resource type -## AccessProfile +## ManagedClusterProperties ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **agentPoolProfiles**: [ContainerServiceAgentPoolProfile](#containerserviceagentpoolprofile)[]: Properties of the agent pool. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ContainerServicePrincipalProfile](#containerserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2018-03-31/types.md b/generated/containerservice/microsoft.containerservice/2018-03-31/types.md index 6006e0a121..151587dc20 100644 --- a/generated/containerservice/microsoft.containerservice/2018-03-31/types.md +++ b/generated/containerservice/microsoft.containerservice/2018-03-31/types.md @@ -26,20 +26,44 @@ * **ApiVersion**: 2018-03-31 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterProperties +## AccessProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. Currently only one agent pool can exist. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string (ReadOnly): Name of the resource group containing agent pool nodes. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -48,10 +72,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -74,27 +102,25 @@ * **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 (Required): Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey +## ManagedClusterProperties ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. Currently only one agent pool can exist. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string (ReadOnly): Name of the resource group containing agent pool nodes. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -## ContainerServiceNetworkProfile +## ManagedClusterPropertiesAddonProfiles ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) ## ManagedClusterServicePrincipalProfile ### Properties @@ -106,32 +132,6 @@ ### Additional Properties * **Additional Properties Type**: string -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile -### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## AccessProfile -### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2018-08-01-preview/types.md b/generated/containerservice/microsoft.containerservice/2018-08-01-preview/types.md index e0df70985a..5b9f32cd5a 100644 --- a/generated/containerservice/microsoft.containerservice/2018-08-01-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2018-08-01-preview/types.md @@ -26,20 +26,44 @@ * **ApiVersion**: 2018-08-01-preview * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterProperties +## AccessProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string (ReadOnly): Name of the resource group containing agent pool nodes. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -48,10 +72,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -77,27 +105,25 @@ * **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 (Required): Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey +## ManagedClusterProperties ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string (ReadOnly): Name of the resource group containing agent pool nodes. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -## ContainerServiceNetworkProfile +## ManagedClusterPropertiesAddonProfiles ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) ## ManagedClusterServicePrincipalProfile ### Properties @@ -109,32 +135,6 @@ ### Additional Properties * **Additional Properties Type**: string -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile -### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## AccessProfile -### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2018-09-30-preview/types.md b/generated/containerservice/microsoft.containerservice/2018-09-30-preview/types.md index 0e0ff27312..670e31f817 100644 --- a/generated/containerservice/microsoft.containerservice/2018-09-30-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2018-09-30-preview/types.md @@ -12,24 +12,10 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/openShiftManagedClusters' (ReadOnly, DeployTimeConstant): The resource type -## PurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The plan ID. - -## OpenShiftManagedClusterProperties +## NetworkProfile ### Properties -* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. -* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. -* **fqdn**: string: User-specified FQDN for OpenShift API server loadbalancer internal hostname. -* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. -* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration -* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **publicHostname**: string: Optional user-specified FQDN for OpenShift API server. -* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). +* **peerVnetId**: string: CIDR of the Vnet to peer. +* **vnetCidr**: string: CIDR for the OpenShift Vnet. ## OpenShiftManagedClusterAgentPoolProfile ### Properties @@ -44,11 +30,6 @@ ### Properties * **identityProviders**: [OpenShiftManagedClusterIdentityProvider](#openshiftmanagedclusteridentityprovider)[]: Type of authentication profile to use. -## OpenShiftManagedClusterIdentityProvider -### Properties -* **name**: string: Name of the provider. -* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. - ## OpenShiftManagedClusterBaseIdentityProvider * **Discriminator**: kind @@ -62,6 +43,11 @@ * **tenantId**: string: The tenantId associated with the provider. +## OpenShiftManagedClusterIdentityProvider +### Properties +* **name**: string: Name of the provider. +* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. + ## OpenShiftManagedClusterMasterPoolProfile ### Properties * **count**: int (Required): Number of masters (VMs) to host docker containers. The default value is 3. @@ -70,10 +56,17 @@ * **subnetCidr**: string: Subnet CIDR for the peering. * **vmSize**: 'Standard_D16s_v3' | 'Standard_D2s_v3' | 'Standard_D32s_v3' | 'Standard_D4s_v3' | 'Standard_D64s_v3' | 'Standard_D8s_v3' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16s_v3' | 'Standard_E20s_v3' | 'Standard_E32s_v3' | 'Standard_E4s_v3' | 'Standard_E64s_v3' | 'Standard_E8s_v3' | 'Standard_F16s' | 'Standard_F16s_v2' | 'Standard_F32s_v2' | 'Standard_F64s_v2' | 'Standard_F72s_v2' | 'Standard_F8s' | 'Standard_F8s_v2' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | 'Standard_L16s' | 'Standard_L32s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): Size of OpenShift VMs. -## NetworkProfile +## OpenShiftManagedClusterProperties ### Properties -* **peerVnetId**: string: CIDR of the Vnet to peer. -* **vnetCidr**: string: CIDR for the OpenShift Vnet. +* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. +* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. +* **fqdn**: string: User-specified FQDN for OpenShift API server loadbalancer internal hostname. +* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. +* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration +* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **publicHostname**: string: Optional user-specified FQDN for OpenShift API server. +* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). ## OpenShiftRouterProfile ### Properties @@ -81,6 +74,13 @@ * **name**: string: Name of the router profile. * **publicSubdomain**: string: DNS subdomain for OpenShift router. +## PurchasePlan +### Properties +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The plan ID. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-02-01/types.md b/generated/containerservice/microsoft.containerservice/2019-02-01/types.md index e61ae40b48..838bb4e27e 100644 --- a/generated/containerservice/microsoft.containerservice/2019-02-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-02-01/types.md @@ -35,22 +35,44 @@ * **ApiVersion**: 2019-02-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterProperties +## AccessProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAuthorizedIPRanges**: string[]: (PREVIEW) Authorized IP Ranges to kubernetes API server. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string (ReadOnly): Name of the resource group containing agent pool nodes. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -59,10 +81,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -91,38 +117,6 @@ * **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 (Required): Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. - -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ManagedClusterAgentPoolProfileProperties ### Properties * **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. @@ -139,31 +133,37 @@ * **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 (Required): Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## ManagedClusterProperties ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAuthorizedIPRanges**: string[]: (PREVIEW) Authorized IP Ranges to kubernetes API server. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string (ReadOnly): Name of the resource group containing agent pool nodes. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -## CredentialResults +## ManagedClusterPropertiesAddonProfiles ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAccessProfile +## ManagedClusterServicePrincipalProfile ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-04-01/types.md b/generated/containerservice/microsoft.containerservice/2019-04-01/types.md index b514cf8741..97558bf7ee 100644 --- a/generated/containerservice/microsoft.containerservice/2019-04-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-04-01/types.md @@ -36,30 +36,45 @@ * **ApiVersion**: 2019-04-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAuthorizedIPRanges**: string[]: (PREVIEW) Authorized IP Ranges to kubernetes API server. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -68,10 +83,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -100,44 +119,6 @@ * **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 (Required): Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. - -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ManagedClusterAgentPoolProfileProperties ### Properties * **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. @@ -154,31 +135,50 @@ * **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 (Required): Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## CredentialResults +## ManagedClusterIdentity ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. -## CredentialResult +## ManagedClusterProperties ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAuthorizedIPRanges**: string[]: (PREVIEW) Authorized IP Ranges to kubernetes API server. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## CredentialResults +## ManagedClusterPropertiesAddonProfiles ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAccessProfile +## ManagedClusterServicePrincipalProfile ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## AccessProfile +## ManagedClusterWindowsProfile ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-04-30/types.md b/generated/containerservice/microsoft.containerservice/2019-04-30/types.md index 17321c9dbe..f10468c730 100644 --- a/generated/containerservice/microsoft.containerservice/2019-04-30/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-04-30/types.md @@ -12,25 +12,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/openShiftManagedClusters' (ReadOnly, DeployTimeConstant): The resource type -## PurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The plan ID. - -## OpenShiftManagedClusterProperties +## NetworkProfile ### Properties -* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. -* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. -* **clusterVersion**: string (ReadOnly): Version of OpenShift specified when creating the cluster. -* **fqdn**: string (ReadOnly): Service generated FQDN for OpenShift API server loadbalancer internal hostname. -* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. -* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration -* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **publicHostname**: string (ReadOnly): Service generated FQDN for OpenShift API server. -* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). +* **peerVnetId**: string: CIDR of the Vnet to peer. +* **vnetCidr**: string: CIDR for the OpenShift Vnet. +* **vnetId**: string: ID of the Vnet created for OSA cluster. ## OpenShiftManagedClusterAgentPoolProfile ### Properties @@ -45,11 +31,6 @@ ### Properties * **identityProviders**: [OpenShiftManagedClusterIdentityProvider](#openshiftmanagedclusteridentityprovider)[]: Type of authentication profile to use. -## OpenShiftManagedClusterIdentityProvider -### Properties -* **name**: string: Name of the provider. -* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. - ## OpenShiftManagedClusterBaseIdentityProvider * **Discriminator**: kind @@ -63,6 +44,11 @@ * **tenantId**: string: The tenantId associated with the provider. +## OpenShiftManagedClusterIdentityProvider +### Properties +* **name**: string: Name of the provider. +* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. + ## OpenShiftManagedClusterMasterPoolProfile ### Properties * **count**: int (Required): Number of masters (VMs) to host docker containers. The default value is 3. @@ -71,11 +57,18 @@ * **subnetCidr**: string: Subnet CIDR for the peering. * **vmSize**: 'Standard_D16s_v3' | 'Standard_D2s_v3' | 'Standard_D32s_v3' | 'Standard_D4s_v3' | 'Standard_D64s_v3' | 'Standard_D8s_v3' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16s_v3' | 'Standard_E20s_v3' | 'Standard_E32s_v3' | 'Standard_E4s_v3' | 'Standard_E64s_v3' | 'Standard_E8s_v3' | 'Standard_F16s' | 'Standard_F16s_v2' | 'Standard_F32s_v2' | 'Standard_F64s_v2' | 'Standard_F72s_v2' | 'Standard_F8s' | 'Standard_F8s_v2' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | 'Standard_L16s' | 'Standard_L32s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): Size of OpenShift VMs. -## NetworkProfile +## OpenShiftManagedClusterProperties ### Properties -* **peerVnetId**: string: CIDR of the Vnet to peer. -* **vnetCidr**: string: CIDR for the OpenShift Vnet. -* **vnetId**: string: ID of the Vnet created for OSA cluster. +* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. +* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. +* **clusterVersion**: string (ReadOnly): Version of OpenShift specified when creating the cluster. +* **fqdn**: string (ReadOnly): Service generated FQDN for OpenShift API server loadbalancer internal hostname. +* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. +* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration +* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **publicHostname**: string (ReadOnly): Service generated FQDN for OpenShift API server. +* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). ## OpenShiftRouterProfile ### Properties @@ -83,6 +76,13 @@ * **name**: string: Name of the router profile. * **publicSubdomain**: string (ReadOnly): DNS subdomain for OpenShift router. +## PurchasePlan +### Properties +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The plan ID. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-06-01/types.md b/generated/containerservice/microsoft.containerservice/2019-06-01/types.md index 8dd272fd31..72eaaf5f9d 100644 --- a/generated/containerservice/microsoft.containerservice/2019-06-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-06-01/types.md @@ -36,30 +36,45 @@ * **ApiVersion**: 2019-06-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAuthorizedIPRanges**: string[]: (PREVIEW) Authorized IP Ranges to kubernetes API server. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -68,10 +83,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -104,44 +123,6 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. - -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ManagedClusterAgentPoolProfileProperties ### Properties * **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. @@ -162,31 +143,50 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. -## CredentialResults +## ManagedClusterIdentity ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. -## CredentialResult +## ManagedClusterProperties ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAuthorizedIPRanges**: string[]: (PREVIEW) Authorized IP Ranges to kubernetes API server. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## CredentialResults +## ManagedClusterPropertiesAddonProfiles ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAccessProfile +## ManagedClusterServicePrincipalProfile ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## AccessProfile +## ManagedClusterWindowsProfile ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-08-01/types.md b/generated/containerservice/microsoft.containerservice/2019-08-01/types.md index a02e533195..042983e505 100644 --- a/generated/containerservice/microsoft.containerservice/2019-08-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-08-01/types.md @@ -36,30 +36,46 @@ * **ApiVersion**: 2019-08-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -68,10 +84,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -104,34 +124,36 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: 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. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. VirtualMachineScaleSets type is still in PREVIEW. +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAPIServerAccessProfile ### Properties * **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -140,10 +162,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -156,6 +174,30 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. + +## ManagedClusterPropertiesAddonProfiles +### Properties +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) + ## ManagedClusterServicePrincipalProfile ### Properties * **clientId**: string (Required): The ID for the service principal. @@ -166,57 +208,15 @@ * **adminPassword**: string: 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!" * **adminUsername**: string (Required): 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 +## ResourceReference +### Properties +* **id**: string: The fully qualified Azure resource id. + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: 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. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. VirtualMachineScaleSets type is still in PREVIEW. -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile -### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## AccessProfile -### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-09-30-preview/types.md b/generated/containerservice/microsoft.containerservice/2019-09-30-preview/types.md index 63170a61f8..098b84c110 100644 --- a/generated/containerservice/microsoft.containerservice/2019-09-30-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-09-30-preview/types.md @@ -12,26 +12,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/openShiftManagedClusters' (ReadOnly, DeployTimeConstant): The resource type -## PurchasePlan -### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The plan ID. - -## OpenShiftManagedClusterProperties +## NetworkProfile ### Properties -* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. -* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. -* **clusterVersion**: string (ReadOnly): Version of OpenShift specified when creating the cluster. -* **fqdn**: string (ReadOnly): Service generated FQDN for OpenShift API server loadbalancer internal hostname. -* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. -* **monitorProfile**: [OpenShiftManagedClusterMonitorProfile](#openshiftmanagedclustermonitorprofile): Defines the configuration for Log Analytics integration. -* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration -* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **publicHostname**: string (ReadOnly): Service generated FQDN for OpenShift API server. -* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). +* **peerVnetId**: string: CIDR of the Vnet to peer. +* **vnetCidr**: string: CIDR for the OpenShift Vnet. +* **vnetId**: string: ID of the Vnet created for OSA cluster. ## OpenShiftManagedClusterAgentPoolProfile ### Properties @@ -46,11 +31,6 @@ ### Properties * **identityProviders**: [OpenShiftManagedClusterIdentityProvider](#openshiftmanagedclusteridentityprovider)[]: Type of authentication profile to use. -## OpenShiftManagedClusterIdentityProvider -### Properties -* **name**: string: Name of the provider. -* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. - ## OpenShiftManagedClusterBaseIdentityProvider * **Discriminator**: kind @@ -64,6 +44,11 @@ * **tenantId**: string: The tenantId associated with the provider. +## OpenShiftManagedClusterIdentityProvider +### Properties +* **name**: string: Name of the provider. +* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. + ## OpenShiftManagedClusterMasterPoolProfile ### Properties * **count**: int (Required): Number of masters (VMs) to host docker containers. The default value is 3. @@ -77,11 +62,19 @@ * **enabled**: bool: If the Log analytics integration should be turned on or off * **workspaceResourceID**: string: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with. -## NetworkProfile +## OpenShiftManagedClusterProperties ### Properties -* **peerVnetId**: string: CIDR of the Vnet to peer. -* **vnetCidr**: string: CIDR for the OpenShift Vnet. -* **vnetId**: string: ID of the Vnet created for OSA cluster. +* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. +* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. +* **clusterVersion**: string (ReadOnly): Version of OpenShift specified when creating the cluster. +* **fqdn**: string (ReadOnly): Service generated FQDN for OpenShift API server loadbalancer internal hostname. +* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. +* **monitorProfile**: [OpenShiftManagedClusterMonitorProfile](#openshiftmanagedclustermonitorprofile): Defines the configuration for Log Analytics integration. +* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration +* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **publicHostname**: string (ReadOnly): Service generated FQDN for OpenShift API server. +* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). ## OpenShiftRouterProfile ### Properties @@ -89,6 +82,13 @@ * **name**: string: Name of the router profile. * **publicSubdomain**: string (ReadOnly): DNS subdomain for OpenShift router. +## PurchasePlan +### Properties +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The plan ID. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-10-01/types.md b/generated/containerservice/microsoft.containerservice/2019-10-01/types.md index 3720a0152a..4e94cde567 100644 --- a/generated/containerservice/microsoft.containerservice/2019-10-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-10-01/types.md @@ -41,31 +41,50 @@ * **ApiVersion**: 2019-10-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -74,10 +93,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -110,34 +133,36 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: 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. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. VirtualMachineScaleSets type is still in PREVIEW. +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAPIServerAccessProfile ### Properties * **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -146,10 +171,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -162,6 +183,31 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. + +## ManagedClusterPropertiesAddonProfiles +### Properties +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) + ## ManagedClusterServicePrincipalProfile ### Properties * **clientId**: string (Required): The ID for the service principal. @@ -172,61 +218,15 @@ * **adminPassword**: string: 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!" * **adminUsername**: string (Required): 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 +## ResourceReference +### Properties +* **id**: string: The fully qualified Azure resource id. + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: 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. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. VirtualMachineScaleSets type is still in PREVIEW. -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile -### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## AccessProfile -### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-10-27-preview/types.md b/generated/containerservice/microsoft.containerservice/2019-10-27-preview/types.md index 9aca1e81fd..9ca340b7ed 100644 --- a/generated/containerservice/microsoft.containerservice/2019-10-27-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-10-27-preview/types.md @@ -12,27 +12,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.ContainerService/openShiftManagedClusters' (ReadOnly, DeployTimeConstant): The resource type -## PurchasePlan +## NetworkProfile ### Properties -* **name**: string: The plan ID. -* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The plan ID. +* **managementSubnetCidr**: string: CIDR of subnet used to create PLS needed for management of the cluster +* **vnetCidr**: string: CIDR for the OpenShift Vnet. +* **vnetId**: string: ID of the Vnet created for OSA cluster. -## OpenShiftManagedClusterProperties +## OpenShiftAPIProperties ### Properties -* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. -* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. -* **clusterVersion**: string (ReadOnly): Version of OpenShift specified when creating the cluster. -* **fqdn**: string (ReadOnly): Service generated FQDN for OpenShift API server loadbalancer internal hostname. -* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. -* **monitorProfile**: [OpenShiftManagedClusterMonitorProfile](#openshiftmanagedclustermonitorprofile): Defines the configuration for Log Analytics integration. -* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration -* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **publicHostname**: string (ReadOnly): Service generated FQDN or private IP for OpenShift API server. -* **refreshCluster**: bool: Allows node rotation -* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). +* **privateApiServer**: bool: Specifies if API server is public or private. ## OpenShiftManagedClusterAgentPoolProfile ### Properties @@ -47,11 +35,6 @@ ### Properties * **identityProviders**: [OpenShiftManagedClusterIdentityProvider](#openshiftmanagedclusteridentityprovider)[]: Type of authentication profile to use. -## OpenShiftManagedClusterIdentityProvider -### Properties -* **name**: string: Name of the provider. -* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. - ## OpenShiftManagedClusterBaseIdentityProvider * **Discriminator**: kind @@ -65,6 +48,11 @@ * **tenantId**: string: The tenantId associated with the provider. +## OpenShiftManagedClusterIdentityProvider +### Properties +* **name**: string: Name of the provider. +* **provider**: [OpenShiftManagedClusterBaseIdentityProvider](#openshiftmanagedclusterbaseidentityprovider): Structure for any Identity provider. + ## OpenShiftManagedClusterMasterPoolProfile ### Properties * **apiProperties**: [OpenShiftAPIProperties](#openshiftapiproperties): Defines further properties on the API. @@ -72,20 +60,25 @@ * **subnetCidr**: string: Subnet CIDR for the peering. * **vmSize**: 'Standard_D16s_v3' | 'Standard_D2s_v3' | 'Standard_D32s_v3' | 'Standard_D4s_v3' | 'Standard_D64s_v3' | 'Standard_D8s_v3' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS14_v2' | 'Standard_DS15_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_E16s_v3' | 'Standard_E20s_v3' | 'Standard_E32s_v3' | 'Standard_E4s_v3' | 'Standard_E64s_v3' | 'Standard_E8s_v3' | 'Standard_F16s' | 'Standard_F16s_v2' | 'Standard_F32s_v2' | 'Standard_F64s_v2' | 'Standard_F72s_v2' | 'Standard_F8s' | 'Standard_F8s_v2' | 'Standard_GS2' | 'Standard_GS3' | 'Standard_GS4' | 'Standard_GS5' | 'Standard_L16s' | 'Standard_L32s' | 'Standard_L4s' | 'Standard_L8s' | string (Required): Size of OpenShift VMs. -## OpenShiftAPIProperties -### Properties -* **privateApiServer**: bool: Specifies if API server is public or private. - ## OpenShiftManagedClusterMonitorProfile ### Properties * **enabled**: bool: If the Log analytics integration should be turned on or off * **workspaceResourceID**: string: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with. -## NetworkProfile +## OpenShiftManagedClusterProperties ### Properties -* **managementSubnetCidr**: string: CIDR of subnet used to create PLS needed for management of the cluster -* **vnetCidr**: string: CIDR for the OpenShift Vnet. -* **vnetId**: string: ID of the Vnet created for OSA cluster. +* **agentPoolProfiles**: [OpenShiftManagedClusterAgentPoolProfile](#openshiftmanagedclusteragentpoolprofile)[]: Configuration of OpenShift cluster VMs. +* **authProfile**: [OpenShiftManagedClusterAuthProfile](#openshiftmanagedclusterauthprofile): Defines all possible authentication profiles for the OpenShift cluster. +* **clusterVersion**: string (ReadOnly): Version of OpenShift specified when creating the cluster. +* **fqdn**: string (ReadOnly): Service generated FQDN for OpenShift API server loadbalancer internal hostname. +* **masterPoolProfile**: [OpenShiftManagedClusterMasterPoolProfile](#openshiftmanagedclustermasterpoolprofile): OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs. +* **monitorProfile**: [OpenShiftManagedClusterMonitorProfile](#openshiftmanagedclustermonitorprofile): Defines the configuration for Log Analytics integration. +* **networkProfile**: [NetworkProfile](#networkprofile): Represents the OpenShift networking configuration +* **openShiftVersion**: string (Required): Version of OpenShift specified when creating the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **publicHostname**: string (ReadOnly): Service generated FQDN or private IP for OpenShift API server. +* **refreshCluster**: bool: Allows node rotation +* **routerProfiles**: [OpenShiftRouterProfile](#openshiftrouterprofile)[]: Configuration for OpenShift router(s). ## OpenShiftRouterProfile ### Properties @@ -93,6 +86,13 @@ * **name**: string: Name of the router profile. * **publicSubdomain**: string (ReadOnly): DNS subdomain for OpenShift router. +## PurchasePlan +### Properties +* **name**: string: The plan ID. +* **product**: string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The plan ID. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/containerservice/microsoft.containerservice/2019-11-01/types.md b/generated/containerservice/microsoft.containerservice/2019-11-01/types.md index a7407266a4..64bfb20cfe 100644 --- a/generated/containerservice/microsoft.containerservice/2019-11-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2019-11-01/types.md @@ -41,32 +41,51 @@ * **ApiVersion**: 2019-11-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -75,10 +94,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -120,56 +143,58 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: 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. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAPIServerAccessProfile -### Properties -* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. -* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. - -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. +* **Additional Properties Type**: string -## ContainerServiceSshConfiguration +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. +### Additional Properties +* **Additional Properties Type**: string -## ContainerServiceSshPublicKey +## ManagedClusterAPIServerAccessProfile ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. +* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -180,10 +205,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -196,82 +217,61 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterProperties ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: 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. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. * **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## CredentialResult +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## CredentialResults +## ManagedClusterServicePrincipalProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## CredentialResults +## ManagedClusterWindowsProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-01-01/types.md b/generated/containerservice/microsoft.containerservice/2020-01-01/types.md index aa08b56d62..e07cccb533 100644 --- a/generated/containerservice/microsoft.containerservice/2020-01-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-01-01/types.md @@ -41,33 +41,51 @@ * **ApiVersion**: 2020-01-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -76,10 +94,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -121,56 +143,58 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: 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. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAPIServerAccessProfile -### Properties -* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. -* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. - -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. +* **Additional Properties Type**: string -## ContainerServiceSshConfiguration +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. +### Additional Properties +* **Additional Properties Type**: string -## ContainerServiceSshPublicKey +## ManagedClusterAPIServerAccessProfile ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. +* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -181,10 +205,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -197,82 +217,62 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterProperties ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: 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. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. * **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Low' | 'Regular' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## CredentialResult +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## CredentialResults +## ManagedClusterServicePrincipalProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## CredentialResults +## ManagedClusterWindowsProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-02-01/types.md b/generated/containerservice/microsoft.containerservice/2020-02-01/types.md index 86176f5ba0..3f3ee90bd9 100644 --- a/generated/containerservice/microsoft.containerservice/2020-02-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-02-01/types.md @@ -41,34 +41,52 @@ * **ApiVersion**: 2020-02-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -77,10 +95,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -123,68 +145,59 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: 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. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot or low priority virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Low' | 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAPIServerAccessProfile -### Properties -* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. -* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. - -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **max-graceful-termination-sec**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string - -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. +* **Additional Properties Type**: string -## ContainerServiceSshConfiguration +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. +### Additional Properties +* **Additional Properties Type**: string -## ContainerServiceSshPublicKey +## ManagedClusterAPIServerAccessProfile ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. +* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -195,10 +208,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -211,83 +220,74 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterProperties ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: 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. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. * **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot or low priority virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Low' | 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterPropertiesAutoScalerProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **max-graceful-termination-sec**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string -## CredentialResults +## ManagedClusterPropertiesIdentityProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## CredentialResult +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## CredentialResults +## ManagedClusterServicePrincipalProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## CredentialResults +## ManagedClusterWindowsProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-03-01/types.md b/generated/containerservice/microsoft.containerservice/2020-03-01/types.md index b91748c762..d5043c29a3 100644 --- a/generated/containerservice/microsoft.containerservice/2020-03-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-03-01/types.md @@ -42,34 +42,52 @@ * **ApiVersion**: 2020-03-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## ContainerServiceLinuxProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -80,10 +98,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -127,69 +149,60 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot or low priority virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Low' | 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterAPIServerAccessProfile -### Properties -* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. -* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. - -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string -* **max-graceful-termination-sec**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string - -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. +* **Additional Properties Type**: string -## ContainerServiceSshConfiguration +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. +### Additional Properties +* **Additional Properties Type**: string -## ContainerServiceSshPublicKey +## ManagedClusterAPIServerAccessProfile ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. +* **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -200,10 +213,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -216,89 +225,80 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ManagedClusterSKU +## ManagedClusterProperties ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ResourceTags +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot or low priority virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Low' | 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesAutoScalerProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **balance-similar-node-groups**: string +* **max-graceful-termination-sec**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## CredentialResults +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## CredentialResult +## ManagedClusterServicePrincipalProfile ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## CredentialResults +## ManagedClusterSKU ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## CredentialResults +## ManagedClusterWindowsProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-04-01/types.md b/generated/containerservice/microsoft.containerservice/2020-04-01/types.md index 37df63b5fb..57fa9cb29e 100644 --- a/generated/containerservice/microsoft.containerservice/2020-04-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-04-01/types.md @@ -42,34 +42,56 @@ * **ApiVersion**: 2020-04-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned': 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. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterProperties +## AgentPoolUpgradeSettings ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -80,10 +102,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -129,6 +155,37 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string: Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + +## ManagedClusterAgentPoolProfilePropertiesNodeLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties @@ -139,63 +196,21 @@ ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties * **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string -* **max-graceful-termination-sec**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string - -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile +## ManagedClusterIdentity ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned': 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. ## ManagedClusterLoadBalancerProfile ### Properties @@ -206,10 +221,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -222,91 +233,80 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile -### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. - -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 - -## ManagedClusterSKU +## ManagedClusterProperties ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ResourceTags +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string: Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesAutoScalerProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **balance-similar-node-groups**: string +* **max-graceful-termination-sec**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## CredentialResults +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## CredentialResult +## ManagedClusterServicePrincipalProfile ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## CredentialResults +## ManagedClusterSKU ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## CredentialResults +## ManagedClusterWindowsProfile ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-06-01/types.md b/generated/containerservice/microsoft.containerservice/2020-06-01/types.md index c6b108cccc..021a4bc8b0 100644 --- a/generated/containerservice/microsoft.containerservice/2020-06-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-06-01/types.md @@ -51,45 +51,56 @@ * **ApiVersion**: 2020-06-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterIdentityUserAssignedIdentitiesValue](#managedclusteridentityuserassignedidentitiesvalue) +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default -## ManagedClusterIdentityUserAssignedIdentitiesValue +## ContainerServiceLinuxProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ManagedClusterProperties +## ContainerServiceNetworkProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -101,10 +112,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -151,6 +166,38 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string: Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + +## ManagedClusterAgentPoolProfilePropertiesNodeLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties @@ -161,63 +208,32 @@ ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties * **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ManagedClusterPropertiesAutoScalerProfile +## ManagedClusterIdentity ### Properties -* **balance-similar-node-groups**: string -* **max-graceful-termination-sec**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **Additional Properties Type**: [ManagedClusterIdentityUserAssignedIdentitiesValue](#managedclusteridentityuserassignedidentitiesvalue) -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## ManagedClusterLoadBalancerProfile ### Properties @@ -228,10 +244,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -244,107 +256,95 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile +## ManagedClusterProperties ### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ManagedClusterWindowsProfile +## ManagedClusterPropertiesAddonProfiles ### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterSKU +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **balance-similar-node-groups**: string +* **max-graceful-termination-sec**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string -## ResourceTags +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string: Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterServicePrincipalProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterSKU ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## PrivateEndpointConnectionProperties +## ManagedClusterWindowsProfile ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 ## PrivateEndpoint ### Properties * **id**: string: The resource Id for private endpoint +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-07-01/types.md b/generated/containerservice/microsoft.containerservice/2020-07-01/types.md index 5343997a14..743729091f 100644 --- a/generated/containerservice/microsoft.containerservice/2020-07-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-07-01/types.md @@ -51,45 +51,56 @@ * **ApiVersion**: 2020-07-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterIdentityUserAssignedIdentitiesValue](#managedclusteridentityuserassignedidentitiesvalue) +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default -## ManagedClusterIdentityUserAssignedIdentitiesValue +## ContainerServiceLinuxProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ManagedClusterProperties +## ContainerServiceNetworkProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -101,10 +112,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -151,6 +166,38 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string (ReadOnly): Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + +## ManagedClusterAgentPoolProfilePropertiesNodeLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties @@ -161,63 +208,32 @@ ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties * **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. -## ManagedClusterPropertiesAutoScalerProfile +## ManagedClusterIdentity ### Properties -* **balance-similar-node-groups**: string -* **max-graceful-termination-sec**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) - -## ManagedClusterPropertiesIdentityProfileValue -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **Additional Properties Type**: [ManagedClusterIdentityUserAssignedIdentitiesValue](#managedclusteridentityuserassignedidentitiesvalue) -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentitiesValue ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## ManagedClusterLoadBalancerProfile ### Properties @@ -228,10 +244,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -244,108 +256,96 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterServicePrincipalProfile +## ManagedClusterProperties ### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ManagedClusterWindowsProfile +## ManagedClusterPropertiesAddonProfiles ### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterSKU +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **balance-similar-node-groups**: string +* **max-graceful-termination-sec**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string -## ResourceTags +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterPropertiesIdentityProfileValue](#managedclusterpropertiesidentityprofilevalue) -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterPropertiesIdentityProfileValue ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string (ReadOnly): Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterServicePrincipalProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterSKU ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## PrivateEndpointConnectionProperties +## ManagedClusterWindowsProfile ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. ## PrivateEndpoint ### Properties * **id**: string: The resource Id for private endpoint +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-09-01/types.md b/generated/containerservice/microsoft.containerservice/2020-09-01/types.md index e8f6160d36..9c7b0c58a6 100644 --- a/generated/containerservice/microsoft.containerservice/2020-09-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-09-01/types.md @@ -51,46 +51,56 @@ * **ApiVersion**: 2020-09-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterIdentityUserAssignedIdentitiesValue](#managedclusteridentityuserassignedidentitiesvalue) +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default -## ManagedClusterIdentityUserAssignedIdentitiesValue +## ContainerServiceLinuxProfile ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. -## ManagedClusterProperties +## ContainerServiceNetworkProfile ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. ## ManagedClusterAADProfile ### Properties @@ -102,10 +112,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -154,29 +168,127 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +## ManagedClusterAgentPoolProfileProperties +### Properties +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string (ReadOnly): Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. + ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties * **authorizedIPRanges**: string[]: Authorized IP Ranges to kubernetes API server. * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. +## ManagedClusterIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ManagedClusterIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ManagedClusterIdentityUserAssignedIdentitiesValue](#managedclusteridentityuserassignedidentitiesvalue) + +## ManagedClusterIdentityUserAssignedIdentitiesValue +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## ManagedClusterLoadBalancerProfile +### Properties +* **allocatedOutboundPorts**: int: Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster load balancer. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes. +* **managedOutboundIPs**: [ManagedClusterLoadBalancerProfileManagedOutboundIPs](#managedclusterloadbalancerprofilemanagedoutboundips): Desired managed outbound IPs for the cluster load balancer. +* **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. +* **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. + +## ManagedClusterLoadBalancerProfileManagedOutboundIPs +### Properties +* **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. + +## ManagedClusterLoadBalancerProfileOutboundIPPrefixes +### Properties +* **publicIPPrefixes**: [ResourceReference](#resourcereference)[]: A list of public IP prefix resources. + +## ManagedClusterLoadBalancerProfileOutboundIPs +### Properties +* **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. + +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. + +## ManagedClusterPropertiesAddonProfiles +### Properties +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) + ## ManagedClusterPropertiesAutoScalerProfile ### Properties * **balance-similar-node-groups**: string @@ -207,116 +319,29 @@ * **objectId**: string: The object id of the user assigned identity. * **resourceId**: string: The resource id of the user assigned identity. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. - -## ManagedClusterLoadBalancerProfile -### Properties -* **allocatedOutboundPorts**: int: Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster load balancer. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes. -* **managedOutboundIPs**: [ManagedClusterLoadBalancerProfileManagedOutboundIPs](#managedclusterloadbalancerprofilemanagedoutboundips): Desired managed outbound IPs for the cluster load balancer. -* **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. -* **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. - -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - -## ManagedClusterLoadBalancerProfileManagedOutboundIPs -### Properties -* **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. - -## ManagedClusterLoadBalancerProfileOutboundIPPrefixes -### Properties -* **publicIPPrefixes**: [ResourceReference](#resourcereference)[]: A list of public IP prefix resources. - -## ManagedClusterLoadBalancerProfileOutboundIPs -### Properties -* **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. - ## ManagedClusterServicePrincipalProfile ### Properties * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: Name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterWindowsProfile ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string (ReadOnly): Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: VNet SubnetID specifies the VNet's subnet identifier. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -324,44 +349,19 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: The resource Id for private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## ManagedClusterAccessProfile +## ResourceReference ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **id**: string: The fully qualified Azure resource id. -## AccessProfile +## ResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/containerservice/microsoft.containerservice/2020-11-01/types.md b/generated/containerservice/microsoft.containerservice/2020-11-01/types.md index c7d38fc78f..6509ed94ac 100644 --- a/generated/containerservice/microsoft.containerservice/2020-11-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-11-01/types.md @@ -51,48 +51,96 @@ * **ApiVersion**: 2020-11-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default + +## CloudError +### Properties +* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. + +## CloudErrorBody +### Properties +* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. +* **message**: string: A message describing the error, intended to be suitable for display in a user interface. +* **target**: string: The target of the particular error. For example, the name of the property in error. ## Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterProperties +## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## KubeletConfig +### Properties +* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. +* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. +* **cpuManagerPolicy**: string: CPU Manager policy to use. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. +* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. +* **topologyManagerPolicy**: string: Topology Manager policy to use. + +## LinuxOSConfig +### Properties +* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. +* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. ## ManagedClusterAADProfile ### Properties @@ -104,10 +152,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -159,72 +211,57 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. -* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. -* **cpuManagerPolicy**: string: CPU Manager policy to use. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. -* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. -* **topologyManagerPolicy**: string: Topology Manager policy to use. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. -* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpRmem**: int: Sysctl setting net.ipv4.tcp_rmem. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netIpv4TcpWmem**: int: Sysctl setting net.ipv4.tcp_wmem. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string (ReadOnly): Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -232,65 +269,21 @@ * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. * **privateDNSZone**: string: Private dns zone mode for private cluster. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string -* **expander**: 'least-waste' | 'most-pods' | 'random' | string -* **max-empty-bulk-delete**: string -* **max-graceful-termination-sec**: string -* **max-total-unready-percentage**: string -* **new-pod-scale-up-delay**: string -* **ok-total-unready-count**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string -* **skip-nodes-with-local-storage**: string -* **skip-nodes-with-system-pods**: string - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'none' | 'patch' | 'rapid' | 'stable' | string: upgrade channel for auto upgrade. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) - -## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) ## ManagedClusterLoadBalancerProfile ### Properties @@ -301,10 +294,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -317,12 +306,6 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterPodIdentityProfile -### Properties -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. - ## ManagedClusterPodIdentity ### Properties * **identity**: [UserAssignedIdentity](#userassignedidentity) (Required) @@ -331,100 +314,105 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## UserAssignedIdentity +## ManagedClusterPodIdentityException ### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. +* **name**: string (Required): Name of the pod identity exception. +* **namespace**: string (Required): Namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): Pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. ## ManagedClusterPodIdentityProvisioningInfo ### Properties * **error**: [CloudError](#clouderror): An error response from the Container service. -## CloudError +## ManagedClusterProperties ### Properties -* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## CloudErrorBody +## ManagedClusterPropertiesAddonProfiles ### Properties -* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. -* **message**: string: A message describing the error, intended to be suitable for display in a user interface. -* **target**: string: The target of the particular error. For example, the name of the property in error. +### Additional Properties +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterPodIdentityException +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **name**: string (Required): Name of the pod identity exception. -* **namespace**: string (Required): Namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): Pod labels to match. +* **balance-similar-node-groups**: string +* **expander**: 'least-waste' | 'most-pods' | 'random' | string +* **max-empty-bulk-delete**: string +* **max-graceful-termination-sec**: string +* **max-total-unready-percentage**: string +* **new-pod-scale-up-delay**: string +* **ok-total-unready-count**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string +* **skip-nodes-with-local-storage**: string +* **skip-nodes-with-system-pods**: string -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) ## ManagedClusterServicePrincipalProfile ### Properties * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: Name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterWindowsProfile ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string (ReadOnly): Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -432,47 +420,59 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: The resource Id for private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult -### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResults +## ResourceReference ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **id**: string: The fully qualified Azure resource id. -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## ManagedClusterAccessProfile +## ResourceTags ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +### Additional Properties +* **Additional Properties Type**: string -## AccessProfile +## SysctlConfig ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpRmem**: int: Sysctl setting net.ipv4.tcp_rmem. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netIpv4TcpWmem**: int: Sysctl setting net.ipv4.tcp_wmem. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ResourceTags +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2020-12-01/types.md b/generated/containerservice/microsoft.containerservice/2020-12-01/types.md index bfdb81bfdc..f4293004f5 100644 --- a/generated/containerservice/microsoft.containerservice/2020-12-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2020-12-01/types.md @@ -61,48 +61,104 @@ * **ApiVersion**: 2020-12-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default + +## CloudError +### Properties +* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. + +## CloudErrorBody +### Properties +* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. +* **message**: string: A message describing the error, intended to be suitable for display in a user interface. +* **target**: string: The target of the particular error. For example, the name of the property in error. ## Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterProperties +## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## KubeletConfig +### Properties +* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. +* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. +* **cpuManagerPolicy**: string: CPU Manager policy to use. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. +* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: Topology Manager policy to use. + +## LinuxOSConfig +### Properties +* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. +* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. + +## MaintenanceConfigurationProperties +### Properties +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: Weekday time slots allowed to upgrade. ## ManagedClusterAADProfile ### Properties @@ -114,10 +170,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -171,75 +231,59 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. -* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. -* **cpuManagerPolicy**: string: CPU Manager policy to use. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. -* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: Topology Manager policy to use. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. -* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: Whether to enable EncryptionAtHost +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. +* **kubeletDiskType**: 'OS' | string: KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, resulting in Kubelet using the OS disk for data. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string (ReadOnly): Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -247,68 +291,23 @@ * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. * **privateDNSZone**: string: Private dns zone mode for private cluster. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string -* **max-empty-bulk-delete**: string -* **max-graceful-termination-sec**: string -* **max-node-provision-time**: string -* **max-total-unready-percentage**: string -* **new-pod-scale-up-delay**: string -* **ok-total-unready-count**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string -* **skip-nodes-with-local-storage**: string -* **skip-nodes-with-system-pods**: string - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'none' | 'patch' | 'rapid' | 'stable' | string: upgrade channel for auto upgrade. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ManagedClusterIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) +* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) -## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. - -## ManagedClusterLoadBalancerProfile +## ManagedClusterLoadBalancerProfile ### Properties * **allocatedOutboundPorts**: int: Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. * **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster load balancer. @@ -317,10 +316,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -333,12 +328,6 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterPodIdentityProfile -### Properties -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. - ## ManagedClusterPodIdentity ### Properties * **identity**: [UserAssignedIdentity](#userassignedidentity) (Required) @@ -347,27 +336,6 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## UserAssignedIdentity -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ManagedClusterPodIdentityProvisioningInfo -### Properties -* **error**: [CloudError](#clouderror): An error response from the Container service. - -## CloudError -### Properties -* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. - -## CloudErrorBody -### Properties -* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. -* **message**: string: A message describing the error, intended to be suitable for display in a user interface. -* **target**: string: The target of the particular error. For example, the name of the property in error. - ## ManagedClusterPodIdentityException ### Properties * **name**: string (Required): Name of the pod identity exception. @@ -379,94 +347,95 @@ ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterServicePrincipalProfile +## ManagedClusterPodIdentityProfile ### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. -## ManagedClusterWindowsProfile +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. +* **error**: [CloudError](#clouderror): An error response from the Container service. -## ManagedClusterSKU +## ManagedClusterProperties ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ResourceTags +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: Whether to enable EncryptionAtHost -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. -* **kubeletDiskType**: 'OS' | string: KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, resulting in Kubelet using the OS disk for data. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string (ReadOnly): Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **balance-similar-node-groups**: string +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string +* **max-empty-bulk-delete**: string +* **max-graceful-termination-sec**: string +* **max-node-provision-time**: string +* **max-total-unready-percentage**: string +* **new-pod-scale-up-delay**: string +* **ok-total-unready-count**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string +* **skip-nodes-with-local-storage**: string +* **skip-nodes-with-system-pods**: string -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterServicePrincipalProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## MaintenanceConfigurationProperties +## ManagedClusterSKU ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: Weekday time slots allowed to upgrade. +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## TimeSpan +## ManagedClusterWindowsProfile ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. -## TimeInWeek +## PowerState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: hour slots in a day. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## SystemData +## PrivateEndpoint ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -474,47 +443,78 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: The resource Id for private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults +## ResourceReference ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **id**: string: The fully qualified Azure resource id. -## CredentialResult +## ResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ManagedClusterAccessProfile +## SystemData ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessProfile +## TimeInWeek ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: hour slots in a day. -## ResourceTags +## TimeSpan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: string: The end of a time span +* **start**: string: The start of a time span + +## UserAssignedIdentity +### Properties +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2021-02-01/types.md b/generated/containerservice/microsoft.containerservice/2021-02-01/types.md index 6155cb8abe..0e3b2ef80d 100644 --- a/generated/containerservice/microsoft.containerservice/2021-02-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-02-01/types.md @@ -61,50 +61,104 @@ * **ApiVersion**: 2021-02-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default + +## CloudError +### Properties +* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. + +## CloudErrorBody +### Properties +* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. +* **message**: string: A message describing the error, intended to be suitable for display in a user interface. +* **target**: string: The target of the particular error. For example, the name of the property in error. ## Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterProperties +## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): FQDN for the master pool which used by proxy config. -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **fqdnSubdomain**: string: FQDN subdomain specified when creating private cluster with custom private dns zone. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## KubeletConfig +### Properties +* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. +* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. +* **cpuManagerPolicy**: string: CPU Manager policy to use. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. +* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: Topology Manager policy to use. + +## LinuxOSConfig +### Properties +* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. +* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. + +## MaintenanceConfigurationProperties +### Properties +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: Weekday time slots allowed to upgrade. ## ManagedClusterAADProfile ### Properties @@ -116,10 +170,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -174,75 +232,60 @@ * **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: Size of agent VMs. * **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. -* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. -* **cpuManagerPolicy**: string: CPU Manager policy to use. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. -* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: Topology Manager policy to use. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. -* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: Whether to enable EncryptionAtHost +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Allowed values: 'OS', 'Temporary' (preview). +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string (ReadOnly): Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: Public IP Prefix ID. VM nodes use IPs assigned from this Public IP Prefix. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **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: Size of agent VMs. +* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -250,66 +293,21 @@ * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. * **privateDNSZone**: string: Private dns zone mode for private cluster. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string -* **max-empty-bulk-delete**: string -* **max-graceful-termination-sec**: string -* **max-node-provision-time**: string -* **max-total-unready-percentage**: string -* **new-pod-scale-up-delay**: string -* **ok-total-unready-count**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string -* **skip-nodes-with-local-storage**: string -* **skip-nodes-with-system-pods**: string - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'none' | 'patch' | 'rapid' | 'stable' | string: upgrade channel for auto upgrade. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) ## ManagedClusterLoadBalancerProfile ### Properties @@ -320,10 +318,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -336,13 +330,6 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Customer consent for enabling AAD pod identity addon in cluster using Kubenet network plugin. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. - ## ManagedClusterPodIdentity ### Properties * **identity**: [UserAssignedIdentity](#userassignedidentity) (Required) @@ -351,27 +338,6 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## UserAssignedIdentity -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ManagedClusterPodIdentityProvisioningInfo -### Properties -* **error**: [CloudError](#clouderror): An error response from the Container service. - -## CloudError -### Properties -* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. - -## CloudErrorBody -### Properties -* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. -* **message**: string: A message describing the error, intended to be suitable for display in a user interface. -* **target**: string: The target of the particular error. For example, the name of the property in error. - ## ManagedClusterPodIdentityException ### Properties * **name**: string (Required): Name of the pod identity exception. @@ -383,95 +349,98 @@ ### Additional Properties * **Additional Properties Type**: string -## ManagedClusterServicePrincipalProfile +## ManagedClusterPodIdentityProfile ### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. +* **allowNetworkPluginKubenet**: bool: Customer consent for enabling AAD pod identity addon in cluster using Kubenet network plugin. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. -## ManagedClusterWindowsProfile +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. +* **error**: [CloudError](#clouderror): An error response from the Container service. -## ManagedClusterSKU +## ManagedClusterProperties ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): FQDN for the master pool which used by proxy config. +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **fqdnSubdomain**: string: FQDN subdomain specified when creating private cluster with custom private dns zone. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ResourceTags +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: Whether to enable EncryptionAtHost -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Allowed values: 'OS', 'Temporary' (preview). -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string (ReadOnly): Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: Public IP Prefix ID. VM nodes use IPs assigned from this Public IP Prefix. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **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: Size of agent VMs. -* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **balance-similar-node-groups**: string +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string +* **max-empty-bulk-delete**: string +* **max-graceful-termination-sec**: string +* **max-node-provision-time**: string +* **max-total-unready-percentage**: string +* **new-pod-scale-up-delay**: string +* **ok-total-unready-count**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string +* **skip-nodes-with-local-storage**: string +* **skip-nodes-with-system-pods**: string -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterServicePrincipalProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## MaintenanceConfigurationProperties +## ManagedClusterSKU ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: Weekday time slots allowed to upgrade. +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## TimeSpan +## ManagedClusterWindowsProfile ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. -## TimeInWeek +## PowerState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: hour slots in a day. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## SystemData +## PrivateEndpoint ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -479,47 +448,78 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: The resource Id for private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults +## ResourceReference ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **id**: string: The fully qualified Azure resource id. -## CredentialResult +## ResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ManagedClusterAccessProfile +## SystemData ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessProfile +## TimeInWeek ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: hour slots in a day. -## ResourceTags +## TimeSpan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: string: The end of a time span +* **start**: string: The start of a time span + +## UserAssignedIdentity +### Properties +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2021-03-01/types.md b/generated/containerservice/microsoft.containerservice/2021-03-01/types.md index ecaf4b86ea..96ffe1a945 100644 --- a/generated/containerservice/microsoft.containerservice/2021-03-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-03-01/types.md @@ -62,58 +62,109 @@ * **ApiVersion**: 2021-03-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ExtendedLocation +## AccessProfile ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentity +## AgentPoolUpgradeSettings ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default -## ManagedClusterIdentityUserAssignedIdentities +## CloudError ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. + +## CloudErrorBody +### Properties +* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. +* **message**: string: A message describing the error, intended to be suitable for display in a user interface. +* **target**: string: The target of the particular error. For example, the name of the property in error. ## Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterProperties +## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): FQDN for the master pool which used by proxy config. -* **disableLocalAccounts**: bool: If set to true, getting static credential will be disabled for this cluster. Expected to only be used for AAD clusters. -* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. -* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): FQDN for the master pool. -* **fqdnSubdomain**: string: FQDN subdomain specified when creating private cluster with custom private dns zone. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Configurations for provisioning the cluster with HTTP proxy servers. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. +* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## ExtendedLocation +### Properties +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. + +## KubeletConfig +### Properties +* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. +* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. +* **cpuManagerPolicy**: string: CPU Manager policy to use. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. +* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: Topology Manager policy to use. + +## LinuxOSConfig +### Properties +* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. +* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. + +## MaintenanceConfigurationProperties +### Properties +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: Weekday time slots allowed to upgrade. ## ManagedClusterAADProfile ### Properties @@ -125,10 +176,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -186,75 +241,63 @@ * **vmSize**: string: Size of agent VMs. * **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowlist of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: Enable CPU CFS quota enforcement for containers that specify CPU limits. -* **cpuCfsQuotaPeriod**: string: Sets CPU CFS quota period value. -* **cpuManagerPolicy**: string: CPU Manager policy to use. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: The percent of disk usage after which image garbage collection is always run. -* **imageGcLowThreshold**: int: The percent of disk usage before which image garbage collection is never run. -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: Topology Manager policy to use. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: SwapFileSizeMB specifies size in MB of a swap file will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Transparent Huge Page defrag configuration. -* **transparentHugePageEnabled**: string: Transparent Huge Page enabled configuration. - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: Whether to enable EncryptionAtHost +* **enableFIPS**: bool: Whether to use FIPS enabled OS +* **enableNodePublicIP**: bool: Enable public IP for nodes +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Allowed values: 'OS', 'Temporary' (preview). +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. +* **maxCount**: int: Maximum number of nodes for auto-scaling +* **maxPods**: int: Maximum number of pods that can run on a node. +* **minCount**: int: Minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. +* **nodeImageVersion**: string (ReadOnly): Version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: Public IP Prefix ID. VM nodes use IPs assigned from this Public IP Prefix. +* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. +* **osDiskSizeGB**: int: 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. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner for Linux OSType. Not applicable to Windows OSType. +* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. +* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. +* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. +* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: Size of agent VMs. +* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -262,27 +305,7 @@ * **enablePrivateCluster**: bool: Whether to create the cluster as a private cluster or not. * **privateDNSZone**: string: Private dns zone mode for private cluster. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string -* **max-empty-bulk-delete**: string -* **max-graceful-termination-sec**: string -* **max-node-provision-time**: string -* **max-total-unready-percentage**: string -* **new-pod-scale-up-delay**: string -* **ok-total-unready-count**: string -* **scale-down-delay-after-add**: string -* **scale-down-delay-after-delete**: string -* **scale-down-delay-after-failure**: string -* **scale-down-unneeded-time**: string -* **scale-down-unready-time**: string -* **scale-down-utilization-threshold**: string -* **scan-interval**: string -* **skip-nodes-with-local-storage**: string -* **skip-nodes-with-system-pods**: string - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: upgrade channel for auto upgrade. @@ -293,42 +316,17 @@ * **noProxy**: string[]: Endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) - -## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The load balancer sku for the managed cluster. -* **networkMode**: 'bridge' | 'transparent' | string: Network mode used for building Kubernetes network. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: The outbound (egress) routing method. -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) ## ManagedClusterLoadBalancerProfile ### Properties @@ -339,10 +337,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -355,13 +349,6 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Customer consent for enabling AAD pod identity addon in cluster using Kubenet network plugin. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. - ## ManagedClusterPodIdentity ### Properties * **bindingSelector**: string: Binding selector to use for the AzureIdentityBinding resource. @@ -371,27 +358,6 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## UserAssignedIdentity -### Properties -* **clientId**: string: The client id of the user assigned identity. -* **objectId**: string: The object id of the user assigned identity. -* **resourceId**: string: The resource id of the user assigned identity. - -## ManagedClusterPodIdentityProvisioningInfo -### Properties -* **error**: [CloudError](#clouderror): An error response from the Container service. - -## CloudError -### Properties -* **error**: [CloudErrorBody](#clouderrorbody): An error response from the Container service. - -## CloudErrorBody -### Properties -* **code**: string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [CloudErrorBody](#clouderrorbody)[]: A list of additional details about the error. -* **message**: string: A message describing the error, intended to be suitable for display in a user interface. -* **target**: string: The target of the particular error. For example, the name of the property in error. - ## ManagedClusterPodIdentityException ### Properties * **name**: string (Required): Name of the pod identity exception. @@ -403,108 +369,102 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkResource -### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: RequiredMembers of the resource -* **type**: string: The resource type. - -## ManagedClusterServicePrincipalProfile +## ManagedClusterPodIdentityProfile ### Properties -* **clientId**: string (Required): The ID for the service principal. -* **secret**: string: The secret password associated with the service principal in plain text. +* **allowNetworkPluginKubenet**: bool: Customer consent for enabling AAD pod identity addon in cluster using Kubenet network plugin. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: User assigned pod identity settings. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: User assigned pod identity exception settings. -## ManagedClusterWindowsProfile +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **enableCSIProxy**: bool: Whether to enable CSI proxy. -* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. +* **error**: [CloudError](#clouderror): An error response from the Container service. -## ManagedClusterSKU +## ManagedClusterProperties ### Properties -* **name**: 'Basic' | string: Name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): AADProfile specifies attributes for Azure Active Directory integration. +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): Profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: Properties of the agent pool. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): FQDN for the master pool which used by proxy config. +* **disableLocalAccounts**: bool: If set to true, getting static credential will be disabled for this cluster. Expected to only be used for AAD clusters. +* **diskEncryptionSetID**: string: ResourceId of the disk encryption set to use for enabling encryption at rest. +* **dnsPrefix**: string: DNS prefix specified when creating the managed cluster. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): FQDN for the master pool. +* **fqdnSubdomain**: string: FQDN subdomain specified when creating private cluster with custom private dns zone. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Configurations for provisioning the cluster with HTTP proxy servers. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: Version of Kubernetes specified when creating the managed cluster. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: Name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile) +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the container service cluster. -## ResourceTags +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **availabilityZones**: string[]: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: Whether to enable EncryptionAtHost -* **enableFIPS**: bool: Whether to use FIPS enabled OS -* **enableNodePublicIP**: bool: Enable public IP for nodes -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): Kubelet configurations of agent nodes. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Allowed values: 'OS', 'Temporary' (preview). -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): OS configurations of Linux agent nodes. -* **maxCount**: int: Maximum number of nodes for auto-scaling -* **maxPods**: int: Maximum number of pods that can run on a node. -* **minCount**: int: Minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: AgentPoolMode represents mode of an agent pool. -* **nodeImageVersion**: string (ReadOnly): Version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): Agent pool node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: Public IP Prefix ID. VM nodes use IPs assigned from this Public IP Prefix. -* **nodeTaints**: string[]: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Version of orchestrator specified when creating the managed cluster. -* **osDiskSizeGB**: int: 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. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: OSDiskType represents the type of an OS disk on an agent pool. -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner for Linux OSType. Not applicable to Windows OSType. -* **osType**: 'Linux' | 'Windows' | string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. -* **podSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. -* **scaleSetPriority**: 'Regular' | 'Spot' | string: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. -* **spotMaxPrice**: int: SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): Agent pool tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: AgentPoolType represents types of an agent pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: Size of agent VMs. -* **vnetSubnetID**: string: specifies a subnet's resource id with subscription, resource group, vnet and subnet name +* **balance-similar-node-groups**: string +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string +* **max-empty-bulk-delete**: string +* **max-graceful-termination-sec**: string +* **max-node-provision-time**: string +* **max-total-unready-percentage**: string +* **new-pod-scale-up-delay**: string +* **ok-total-unready-count**: string +* **scale-down-delay-after-add**: string +* **scale-down-delay-after-delete**: string +* **scale-down-delay-after-failure**: string +* **scale-down-unneeded-time**: string +* **scale-down-unready-time**: string +* **scale-down-utilization-threshold**: string +* **scan-interval**: string +* **skip-nodes-with-local-storage**: string +* **skip-nodes-with-system-pods**: string -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterPropertiesIdentityProfile ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedClusterServicePrincipalProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (Required): The ID for the service principal. +* **secret**: string: The secret password associated with the service principal in plain text. -## MaintenanceConfigurationProperties +## ManagedClusterSKU ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: Weekday time slots allowed to upgrade. +* **name**: 'Basic' | string: Name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: Tier of a managed cluster SKU. -## TimeSpan +## ManagedClusterWindowsProfile ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **enableCSIProxy**: bool: Whether to enable CSI proxy. +* **licenseType**: 'None' | 'Windows_Server' | string: The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs. -## TimeInWeek +## PowerState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: hour slots in a day. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## SystemData +## PrivateEndpoint ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The resource Id for private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -512,47 +472,87 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource Id for private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults +## ResourceReference ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **id**: string: The fully qualified Azure resource id. -## CredentialResult +## ResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ManagedClusterAccessProfile +## SystemData ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessProfile +## TimeInWeek ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: hour slots in a day. -## ResourceTags +## TimeSpan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: string: The end of a time span +* **start**: string: The start of a time span + +## UserAssignedIdentity +### Properties +* **clientId**: string: The client id of the user assigned identity. +* **objectId**: string: The object id of the user assigned identity. +* **resourceId**: string: The resource id of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2021-05-01/types.md b/generated/containerservice/microsoft.containerservice/2021-05-01/types.md index 8cd0dcfd95..ac0d43e60e 100644 --- a/generated/containerservice/microsoft.containerservice/2021-05-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-05-01/types.md @@ -62,58 +62,98 @@ * **ApiVersion**: 2021-05-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## ManagedClusterIdentity +## AccessProfile ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. -## ManagedClusterIdentityUserAssignedIdentities +## AgentPoolUpgradeSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade ## Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterProperties +## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## ExtendedLocation +### Properties +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. + +## KubeletConfig +### Properties +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. + +## LinuxOSConfig +### Properties +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). + +## MaintenanceConfigurationProperties +### Properties +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -125,10 +165,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -187,75 +231,64 @@ * **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -264,26 +297,6 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -295,42 +308,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) - -## ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [Components1Umhcm8SchemasManagedclusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#components1umhcm8schemasmanagedclusteridentitypropertiesuserassignedidentitiesadditionalproperties) ## ManagedClusterLoadBalancerProfile ### Properties @@ -341,10 +329,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -357,13 +341,6 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. - ## ManagedClusterPodIdentity ### Properties * **bindingSelector**: string: The binding selector to use for the AzureIdentityBinding resource. @@ -373,15 +350,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## UserAssignedIdentity +## ManagedClusterPodIdentityException ### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityExceptionPodLabels ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -394,120 +379,95 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsQit0EtSchemasManagedclusterpropertiesPropertiesIdentityprofileAdditionalproperties](#componentsqit0etschemasmanagedclusterpropertiespropertiesidentityprofileadditionalproperties) ## ManagedClusterServicePrincipalProfile ### Properties * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). -* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: The name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} - -## ManagedClusterAgentPoolProfilePropertiesNodeLabels -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfilePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MaintenanceConfigurationProperties -### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. - -## TimeSpan +## ManagedClusterWindowsProfile ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). +* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## TimeInWeek +## PowerState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## SystemData +## PrivateEndpoint ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The resource ID of the private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -515,47 +475,87 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource ID of the private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults +## ResourceReference ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **id**: string: The fully qualified Azure resource id. -## CredentialResult +## ResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ManagedClusterAccessProfile +## SystemData ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessProfile +## TimeInWeek ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ResourceTags +## TimeSpan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: string: The end of a time span +* **start**: string: The start of a time span + +## UserAssignedIdentity +### Properties +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2021-07-01/types.md b/generated/containerservice/microsoft.containerservice/2021-07-01/types.md index fe40232219..39bd46a1c4 100644 --- a/generated/containerservice/microsoft.containerservice/2021-07-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-07-01/types.md @@ -62,59 +62,88 @@ * **ApiVersion**: 2021-07-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -126,10 +155,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -189,75 +222,65 @@ * **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -266,26 +289,6 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -297,45 +300,19 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ManagedClusterIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. - -## ManagedClusterLoadBalancerProfile +## ManagedClusterLoadBalancerProfile ### Properties * **allocatedOutboundPorts**: int: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. * **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster load balancer. @@ -344,10 +321,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -360,22 +333,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -386,9 +352,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -401,25 +381,71 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -435,96 +461,30 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). -* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: The name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} - -## ManagedClusterAgentPoolProfilePropertiesNodeLabels -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfilePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MaintenanceConfigurationProperties +## ManagedClusterWindowsProfile ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). +* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## TimeSpan +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TimeInWeek +## PowerState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## SystemData +## PrivateEndpoint ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The resource ID of the private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -532,47 +492,87 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource ID of the private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## CredentialResults +## ResourceReference ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **id**: string: The fully qualified Azure resource id. -## CredentialResult +## ResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ManagedClusterAccessProfile +## SystemData ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessProfile +## TimeInWeek ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ResourceTags +## TimeSpan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: string: The end of a time span +* **start**: string: The start of a time span + +## UserAssignedIdentity +### Properties +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2021-08-01/types.md b/generated/containerservice/microsoft.containerservice/2021-08-01/types.md index 4787fd5a83..84c1a4a9d0 100644 --- a/generated/containerservice/microsoft.containerservice/2021-08-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-08-01/types.md @@ -74,60 +74,92 @@ * **ApiVersion**: 2021-08-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Default value is 'Enabled' (case insensitive). Could be set to 'Disabled' to enable private cluster -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -139,10 +171,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -204,79 +240,67 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Desired Number of agents (VMs) specified to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -286,26 +310,6 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -317,43 +321,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -365,10 +343,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -381,22 +355,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -407,9 +374,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -422,25 +403,72 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Default value is 'Enabled' (case insensitive). Could be set to 'Disabled' to enable private cluster +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -456,98 +484,30 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). -* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: The name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Desired Number of agents (VMs) specified to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. - -## ManagedClusterAgentPoolProfilePropertiesNodeLabels -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfilePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MaintenanceConfigurationProperties +## ManagedClusterWindowsProfile ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). +* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## TimeSpan +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TimeInWeek +## PowerState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## SystemData +## PrivateEndpoint ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The resource ID of the private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -555,57 +515,97 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource ID of the private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SnapshotProperties +## ResourceReference ### Properties -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. +* **id**: string: The fully qualified Azure resource id. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CredentialResults +## ResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResult +## ResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## CredentialResults +## SnapshotProperties ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## ManagedClusterAccessProfile +## SystemData ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessProfile +## TimeInWeek ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ResourceTags +## TimeSpan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: string: The end of a time span +* **start**: string: The start of a time span + +## UserAssignedIdentity +### Properties +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. diff --git a/generated/containerservice/microsoft.containerservice/2021-09-01/types.md b/generated/containerservice/microsoft.containerservice/2021-09-01/types.md index 6a072e5e37..5e809fccef 100644 --- a/generated/containerservice/microsoft.containerservice/2021-09-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-09-01/types.md @@ -74,60 +74,92 @@ * **ApiVersion**: 2021-09-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Default value is 'Enabled' (case insensitive). Could be set to 'Disabled' to enable private cluster -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -139,10 +171,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -204,79 +240,67 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -286,26 +310,6 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - ## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -317,43 +321,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -365,10 +343,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -381,22 +355,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -407,9 +374,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -422,25 +403,72 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Default value is 'Enabled' (case insensitive). Could be set to 'Disabled' to enable private cluster +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -456,6 +484,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -464,112 +497,57 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource ID of the private endpoint -## MaintenanceConfigurationProperties +## PrivateEndpointConnectionProperties ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## TimeSpan +## PrivateLinkResource ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. -## TimeInWeek +## PrivateLinkServiceConnectionState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **description**: string: The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ResourceReference ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The fully qualified Azure resource id. -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## ResourceTags ### Properties -* **id**: string: The resource ID of the private endpoint +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **description**: string: The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string ## SnapshotProperties ### Properties @@ -582,43 +560,65 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2021-10-01/types.md b/generated/containerservice/microsoft.containerservice/2021-10-01/types.md index 0f50fefbcc..825b45dbc2 100644 --- a/generated/containerservice/microsoft.containerservice/2021-10-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-10-01/types.md @@ -74,60 +74,95 @@ * **ApiVersion**: 2021-10-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -139,10 +174,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -204,79 +243,67 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -286,27 +313,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -317,46 +324,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -368,10 +346,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -385,22 +359,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -411,9 +378,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -426,25 +407,72 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -460,6 +488,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -468,112 +501,57 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource ID of the private endpoint -## MaintenanceConfigurationProperties +## PrivateEndpointConnectionProperties ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## TimeSpan +## PrivateLinkResource ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. -## TimeInWeek +## PrivateLinkServiceConnectionState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **description**: string: The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ResourceReference ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The fully qualified Azure resource id. -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## ResourceTags ### Properties -* **id**: string: The resource ID of the private endpoint +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **description**: string: The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string ## SnapshotProperties ### Properties @@ -586,43 +564,65 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2021-11-01-preview/types.md b/generated/containerservice/microsoft.containerservice/2021-11-01-preview/types.md index ecb1c5c594..633b4f5514 100644 --- a/generated/containerservice/microsoft.containerservice/2021-11-01-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2021-11-01-preview/types.md @@ -74,63 +74,95 @@ * **ApiVersion**: 2021-11-01-preview * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -142,10 +174,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -209,79 +245,69 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -291,27 +317,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -322,46 +328,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -373,10 +350,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -390,28 +363,21 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. +## ManagedClusterManagedOutboundIPProfile +### Properties +* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. + ## ManagedClusterNATGatewayProfile ### Properties * **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. * **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. * **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. -## ManagedClusterManagedOutboundIPProfile -### Properties -* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. - ## ManagedClusterOidcIssuerProfile ### Properties * **enabled**: bool: Whether the OIDC issuer is enabled. * **issuerURL**: string (ReadOnly): The OIDC issuer url of the Managed Cluster. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. - ## ManagedClusterPodIdentity ### Properties * **bindingSelector**: string: The binding selector to use for the AzureIdentityBinding resource. @@ -421,9 +387,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -436,25 +416,75 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -470,6 +500,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -478,114 +513,57 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource ID of the private endpoint -## MaintenanceConfigurationProperties +## PrivateEndpointConnectionProperties ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## TimeSpan +## PrivateLinkResource ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. -## TimeInWeek +## PrivateLinkServiceConnectionState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **description**: string: The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ResourceReference ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The fully qualified Azure resource id. -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## ResourceTags ### Properties -* **id**: string: The resource ID of the private endpoint +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **description**: string: The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string ## SnapshotProperties ### Properties @@ -598,43 +576,65 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2022-01-01/types.md b/generated/containerservice/microsoft.containerservice/2022-01-01/types.md index fab624926f..84d9e2384b 100644 --- a/generated/containerservice/microsoft.containerservice/2022-01-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2022-01-01/types.md @@ -74,60 +74,95 @@ * **ApiVersion**: 2022-01-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -139,10 +174,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -204,79 +243,67 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -286,27 +313,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -317,46 +324,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -368,10 +346,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -385,22 +359,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -411,9 +378,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -426,25 +407,72 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -460,6 +488,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -468,112 +501,57 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource ID of the private endpoint -## MaintenanceConfigurationProperties +## PrivateEndpointConnectionProperties ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## TimeSpan +## PrivateLinkResource ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. -## TimeInWeek +## PrivateLinkServiceConnectionState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **description**: string: The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ResourceReference ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The fully qualified Azure resource id. -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## ResourceTags ### Properties -* **id**: string: The resource ID of the private endpoint +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **description**: string: The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string ## SnapshotProperties ### Properties @@ -586,43 +564,65 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2022-01-02-preview/types.md b/generated/containerservice/microsoft.containerservice/2022-01-02-preview/types.md index 2a1204b5d4..d6eb7f3ae5 100644 --- a/generated/containerservice/microsoft.containerservice/2022-01-02-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2022-01-02-preview/types.md @@ -74,63 +74,95 @@ * **ApiVersion**: 2022-01-02-preview * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -142,10 +174,14 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Resource Id +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type ## ManagedClusterAddonProfile ### Properties @@ -210,79 +246,70 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **hostGroupID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -292,27 +319,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -323,46 +330,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -374,10 +352,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -391,28 +365,21 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. +## ManagedClusterManagedOutboundIPProfile +### Properties +* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. + ## ManagedClusterNATGatewayProfile ### Properties * **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. * **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. * **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. -## ManagedClusterManagedOutboundIPProfile -### Properties -* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. - ## ManagedClusterOidcIssuerProfile ### Properties * **enabled**: bool: Whether the OIDC issuer is enabled. * **issuerURL**: string (ReadOnly): The OIDC issuer url of the Managed Cluster. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. - ## ManagedClusterPodIdentity ### Properties * **bindingSelector**: string: The binding selector to use for the AzureIdentityBinding resource. @@ -422,9 +389,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -437,25 +418,75 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -471,6 +502,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -479,115 +515,57 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **hostGroupID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PowerState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource ID of the private endpoint -## MaintenanceConfigurationProperties +## PrivateEndpointConnectionProperties ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## TimeSpan +## PrivateLinkResource ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. -## TimeInWeek +## PrivateLinkServiceConnectionState ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **description**: string: The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## SystemData +## ResourceReference ### Properties -* **createdAt**: string: The UTC timestamp of resource creation. -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string: The fully qualified Azure resource id. -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## ResourceTags ### Properties -* **id**: string: The resource ID of the private endpoint +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **description**: string: The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string ## SnapshotProperties ### Properties @@ -600,43 +578,65 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The UTC timestamp of resource creation. +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Resource Id -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2022-02-01/types.md b/generated/containerservice/microsoft.containerservice/2022-02-01/types.md index 2696476e04..f79933bf09 100644 --- a/generated/containerservice/microsoft.containerservice/2022-02-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2022-02-01/types.md @@ -75,60 +75,95 @@ * **ApiVersion**: 2022-02-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -140,10 +175,15 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): The name of the resource +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ## ManagedClusterAddonProfile ### Properties @@ -205,79 +245,67 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -287,27 +315,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -318,46 +326,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -369,10 +348,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -386,22 +361,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -412,9 +380,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -427,25 +409,72 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -461,6 +490,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -469,112 +503,57 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ManagedClusterAgentPoolProfileProperties +## PowerState ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource ID of the private endpoint -## ManagedClusterAgentPoolProfilePropertiesTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## MaintenanceConfigurationProperties +## PrivateLinkResource ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. -## TimeSpan +## PrivateLinkServiceConnectionState ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **description**: string: The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## TimeInWeek +## ResourceReference ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **id**: string: The fully qualified Azure resource id. -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## ResourceTags ### Properties -* **id**: string: The resource ID of the private endpoint +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **description**: string: The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string ## SnapshotProperties ### Properties @@ -587,44 +566,65 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): The name of the resource -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2022-02-02-preview/types.md b/generated/containerservice/microsoft.containerservice/2022-02-02-preview/types.md index 623c619ece..e4b82bf743 100644 --- a/generated/containerservice/microsoft.containerservice/2022-02-02-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2022-02-02-preview/types.md @@ -87,63 +87,100 @@ * **ApiVersion**: 2022-02-02-preview * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## AzureKeyVaultKms +### Properties +* **enabled**: bool: Whether to enable Azure Key Vault key management service. The default is false. +* **keyId**: string: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -155,10 +192,15 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **location**: string (ReadOnly): Resource location +* **name**: string (ReadOnly): The name of the resource +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ## ManagedClusterAddonProfile ### Properties @@ -223,79 +265,70 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **hostGroupID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -305,27 +338,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -336,46 +349,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -387,10 +371,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -404,28 +384,21 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. +## ManagedClusterManagedOutboundIPProfile +### Properties +* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. + ## ManagedClusterNATGatewayProfile ### Properties * **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. * **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. * **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. -## ManagedClusterManagedOutboundIPProfile -### Properties -* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. - ## ManagedClusterOidcIssuerProfile ### Properties * **enabled**: bool: Whether the OIDC issuer is enabled. * **issuerURL**: string (ReadOnly): The OIDC issuer url of the Managed Cluster. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. - ## ManagedClusterPodIdentity ### Properties * **bindingSelector**: string: The binding selector to use for the AzureIdentityBinding resource. @@ -435,9 +408,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -450,25 +437,82 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesForSnapshot +### Properties +* **enableRbac**: bool: Whether the cluster has enabled Kubernetes Role-Based Access Control or not. +* **kubernetesVersion**: string: The current kubernetes version. +* **networkProfile**: [NetworkProfileForSnapshot](#networkprofileforsnapshot) (ReadOnly): network profile for managed cluster snapshot, these properties are read only. +* **sku**: [ManagedClusterSKU](#managedclustersku): The SKU of a Managed Cluster. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -480,118 +524,49 @@ * **enabled**: bool: Whether to enable Azure Defender * **logAnalyticsWorkspaceResourceId**: string: Resource ID of the Log Analytics workspace to be associated with Azure Defender. When Azure Defender is enabled, this field is required and must be a valid workspace resource ID. When Azure Defender is disabled, leave the field empty. -## AzureKeyVaultKms -### Properties -* **enabled**: bool: Whether to enable Azure Key Vault key management service. The default is false. -* **keyId**: string: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. - ## ManagedClusterServicePrincipalProfile ### Properties * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). -* **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. -* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. - -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: The name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterSnapshotProperties ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. * **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **hostGroupID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **managedClusterPropertiesReadOnly**: [ManagedClusterPropertiesForSnapshot](#managedclusterpropertiesforsnapshot) (ReadOnly): managed cluster properties for snapshot, these properties are read only. +* **snapshotType**: 'ManagedCluster' | 'NodePool' | string: The type of a snapshot. The default is NodePool. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterWindowsProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). +* **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. +* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## MaintenanceConfigurationProperties +## NetworkProfileForSnapshot ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -## TimeSpan +## PowerState ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## TimeInWeek +## PrivateEndpoint ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **id**: string: The resource ID of the private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -599,34 +574,38 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource ID of the private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## ManagedClusterSnapshotProperties +## ResourceReference ### Properties -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **managedClusterPropertiesReadOnly**: [ManagedClusterPropertiesForSnapshot](#managedclusterpropertiesforsnapshot) (ReadOnly): managed cluster properties for snapshot, these properties are read only. -* **snapshotType**: 'ManagedCluster' | 'NodePool' | string: The type of a snapshot. The default is NodePool. +* **id**: string: The fully qualified Azure resource id. -## ManagedClusterPropertiesForSnapshot +## ResourceTags ### Properties -* **enableRbac**: bool: Whether the cluster has enabled Kubernetes Role-Based Access Control or not. -* **kubernetesVersion**: string: The current kubernetes version. -* **networkProfile**: [NetworkProfileForSnapshot](#networkprofileforsnapshot) (ReadOnly): network profile for managed cluster snapshot, these properties are read only. -* **sku**: [ManagedClusterSKU](#managedclustersku): The SKU of a Managed Cluster. +### Additional Properties +* **Additional Properties Type**: string -## NetworkProfileForSnapshot +## ResourceTags ### Properties -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -644,44 +623,65 @@ * **snapshotType**: 'ManagedCluster' | 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults -### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. - -## CredentialResult +## SysctlConfig ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## ManagedClusterAccessProfile +## TimeSpan ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **location**: string (ReadOnly): Resource location -* **name**: string (ReadOnly): The name of the resource -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## AccessProfile +## UserAssignedIdentity ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. -## ResourceTags +## WindowsGmsaProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. diff --git a/generated/containerservice/microsoft.containerservice/2022-03-01/types.md b/generated/containerservice/microsoft.containerservice/2022-03-01/types.md index 0e3794e039..3d8f67f8e0 100644 --- a/generated/containerservice/microsoft.containerservice/2022-03-01/types.md +++ b/generated/containerservice/microsoft.containerservice/2022-03-01/types.md @@ -75,60 +75,95 @@ * **ApiVersion**: 2022-03-01 * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -140,10 +175,15 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **location**: string (ReadOnly): The geo-location where the resource lives +* **name**: string (ReadOnly): The name of the resource +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [TrackedResourceTags](#trackedresourcetags) (ReadOnly): Resource tags. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ## ManagedClusterAddonProfile ### Properties @@ -205,79 +245,67 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -287,27 +315,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -318,46 +326,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. - -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey +## ManagedClusterIdentity ### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ContainerServiceNetworkProfile +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterLoadBalancerProfile ### Properties @@ -369,10 +348,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -386,22 +361,15 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. -## ManagedClusterNATGatewayProfile -### Properties -* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. -* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. -* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. - ## ManagedClusterManagedOutboundIPProfile ### Properties * **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. -## ManagedClusterPodIdentityProfile +## ManagedClusterNATGatewayProfile ### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. +* **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. +* **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. +* **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. ## ManagedClusterPodIdentity ### Properties @@ -412,9 +380,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -427,25 +409,72 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -461,6 +490,11 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. +## ManagedClusterSKU +### Properties +* **name**: 'Basic' | string: The name of a managed cluster SKU. +* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. + ## ManagedClusterWindowsProfile ### Properties * **adminPassword**: string: 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!" @@ -469,97 +503,18 @@ * **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. * **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - -## ManagedClusterSKU -### Properties -* **name**: 'Basic' | string: The name of a managed cluster SKU. -* **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties -### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. - -## ManagedClusterAgentPoolProfilePropertiesNodeLabels -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfilePropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MaintenanceConfigurationProperties +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## TimeSpan +## PowerState ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## TimeInWeek +## PrivateEndpoint ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **id**: string: The resource ID of the private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -567,15 +522,24 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource ID of the private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. +## ResourceReference +### Properties +* **id**: string: The fully qualified Azure resource id. + ## SnapshotProperties ### Properties * **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. @@ -587,44 +551,80 @@ * **snapshotType**: 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CredentialResults +## SysctlConfig ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResult +## SystemData ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResults +## TimeInWeek ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## CredentialResults +## TimeSpan ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## ManagedClusterAccessProfile +## TrackedResourceTags ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **location**: string (ReadOnly): The geo-location where the resource lives -* **name**: string (ReadOnly): The name of the resource -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [TrackedResourceTags](#trackedresourcetags) (ReadOnly): Resource tags. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +### Additional Properties +* **Additional Properties Type**: string -## AccessProfile +## TrackedResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentity +### Properties +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. + +## WindowsGmsaProfile +### Properties +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. + diff --git a/generated/containerservice/microsoft.containerservice/2022-03-02-preview/types.md b/generated/containerservice/microsoft.containerservice/2022-03-02-preview/types.md index 1c3bd700fe..517f69a678 100644 --- a/generated/containerservice/microsoft.containerservice/2022-03-02-preview/types.md +++ b/generated/containerservice/microsoft.containerservice/2022-03-02-preview/types.md @@ -87,65 +87,100 @@ * **ApiVersion**: 2022-03-02-preview * **Output**: [ManagedClusterAccessProfile](#managedclusteraccessprofile) +## AccessProfile +### Properties +* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## AgentPoolUpgradeSettings +### Properties +* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade + +## AzureKeyVaultKms +### Properties +* **enabled**: bool: Whether to enable Azure Key Vault key management service. The default is false. +* **keyId**: string: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. + +## ContainerServiceLinuxProfile +### Properties +* **adminUsername**: string (Required): The administrator username to use for Linux VMs. +* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. + +## ContainerServiceNetworkProfile +### Properties +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. +* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. +* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). +* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. +* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. + +## ContainerServiceSshConfiguration +### Properties +* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. + +## ContainerServiceSshPublicKey +### Properties +* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. + +## CreationData +### Properties +* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. + +## CredentialResult +### Properties +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + +## CredentialResults +### Properties +* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. + ## ExtendedLocation ### Properties * **name**: string: The name of the extended location. * **type**: 'EdgeZone' | string: The type of extendedLocation. -## ManagedClusterIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). -* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ManagedClusterIdentityUserAssignedIdentities +## KubeletConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) +* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). +* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. +* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. +* **cpuCfsQuota**: bool: The default is true. +* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. +* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. +* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. +* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% +* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% +* **podMaxPids**: int: The maximum number of processes per pod. +* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. -## ManagedServiceIdentityUserAssignedIdentitiesValue +## LinuxOSConfig ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. +* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. +* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). +* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -## ManagedClusterProperties +## MaintenanceConfigurationProperties ### Properties -* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). -* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. -* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. -* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. -* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled -* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. -* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. -* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). -* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' -* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. -* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. -* **enablePodSecurityPolicy**: bool: (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. -* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. -* **fqdn**: string (ReadOnly): The FQDN of the master pool. -* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. -* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. -* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. -* **ingressProfile**: [ManagedClusterIngressProfile](#managedclusteringressprofile): Ingress profile for the container service cluster. -* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. -* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. -* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. -* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. -* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. -* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. -* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. -* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster -* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. -* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. -* **provisioningState**: string (ReadOnly): The current provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS -* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. -* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. -* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. +* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. +* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. ## ManagedClusterAADProfile ### Properties @@ -157,10 +192,15 @@ * **serverAppSecret**: string: The server AAD application secret. * **tenantID**: string: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. -## ManagedClusterPropertiesAddonProfiles +## ManagedClusterAccessProfile ### Properties -### Additional Properties -* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **location**: string (ReadOnly): The geo-location where the resource lives +* **name**: string (ReadOnly): The name of the resource +* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [TrackedResourceTags](#trackedresourcetags) (ReadOnly): Resource tags. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ## ManagedClusterAddonProfile ### Properties @@ -226,79 +266,71 @@ * **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} * **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. -## CreationData -### Properties -* **sourceResourceId**: string: This is the ARM ID of the source object to be used to create the target object. - -## KubeletConfig -### Properties -* **allowedUnsafeSysctls**: string[]: Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). -* **containerLogMaxFiles**: int: The maximum number of container log files that can be present for a container. The number must be ≥ 2. -* **containerLogMaxSizeMB**: int: The maximum size (e.g. 10Mi) of container log file before it is rotated. -* **cpuCfsQuota**: bool: The default is true. -* **cpuCfsQuotaPeriod**: string: The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. -* **cpuManagerPolicy**: string: The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. -* **failSwapOn**: bool: If set to true it will make the Kubelet fail to start if swap is enabled on the node. -* **imageGcHighThreshold**: int: To disable image garbage collection, set to 100. The default is 85% -* **imageGcLowThreshold**: int: This cannot be set higher than imageGcHighThreshold. The default is 80% -* **podMaxPids**: int: The maximum number of processes per pod. -* **topologyManagerPolicy**: string: For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. - -## LinuxOSConfig -### Properties -* **swapFileSizeMB**: int: The size in MB of a swap file that will be created on each node. -* **sysctls**: [SysctlConfig](#sysctlconfig): Sysctl settings for Linux agent nodes. -* **transparentHugePageDefrag**: string: Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). -* **transparentHugePageEnabled**: string: Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). - -## SysctlConfig +## ManagedClusterAgentPoolProfileProperties ### Properties -* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. -* **fsFileMax**: int: Sysctl setting fs.file-max. -* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. -* **fsNrOpen**: int: Sysctl setting fs.nr_open. -* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. -* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. -* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. -* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. -* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. -* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. -* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. -* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. -* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. -* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. -* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. -* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. -* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. -* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. -* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. -* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. -* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. -* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. -* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. -* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. -* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. -* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. -* **vmSwappiness**: int: Sysctl setting vm.swappiness. -* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. +* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. +* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate +* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **currentOrchestratorVersion**: string: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used. +* **enableAutoScaling**: bool: Whether to enable auto-scaler +* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption +* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. +* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. +* **enableUltraSSD**: bool: Whether to enable UltraSSD +* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. +* **hostGroupID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). +* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. +* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. +* **maxCount**: int: The maximum number of nodes for auto-scaling +* **maxPods**: int: The maximum number of pods that can run on a node. +* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). +* **minCount**: int: The minimum number of nodes for auto-scaling +* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools +* **nodeImageVersion**: string (ReadOnly): The version of node image +* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. +* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} +* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. +* **orchestratorVersion**: string: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). +* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. +* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). +* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. +* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. +* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. +* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. +* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). +* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) +* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. +* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) +* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. +* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. +* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool +* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions +* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} +* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. ## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties ### Additional Properties * **Additional Properties Type**: string -## PowerState +## ManagedClusterAgentPoolProfilePropertiesNodeLabels ### Properties -* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAgentPoolProfilePropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AgentPoolUpgradeSettings +## ManagedClusterAgentPoolProfilePropertiesTags ### Properties -* **maxSurge**: string: This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade +### Additional Properties +* **Additional Properties Type**: string ## ManagedClusterAPIServerAccessProfile ### Properties @@ -308,27 +340,7 @@ * **enablePrivateClusterPublicFQDN**: bool: Whether to create additional public FQDN for private cluster or not. * **privateDNSZone**: string: The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. -## ManagedClusterPropertiesAutoScalerProfile -### Properties -* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' -* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. -* **max-empty-bulk-delete**: string: The default is 10. -* **max-graceful-termination-sec**: string: The default is 600. -* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. -* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). -* **ok-total-unready-count**: string: This must be an integer. The default is 3. -* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. -* **scale-down-utilization-threshold**: string: The default is '0.5'. -* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. -* **skip-nodes-with-local-storage**: string: The default is true. -* **skip-nodes-with-system-pods**: string: The default is true. - -## ManagedClusterAutoUpgradeProfile +## ManagedClusterAutoUpgradeProfile ### Properties * **upgradeChannel**: 'node-image' | 'none' | 'patch' | 'rapid' | 'stable' | string: For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). @@ -340,16 +352,17 @@ * **noProxy**: string[]: The endpoints that should not go through proxy. * **trustedCa**: string: Alternative CA cert to use for connecting to proxy servers. -## ManagedClusterPropertiesIdentityProfile +## ManagedClusterIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by master components. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by master components. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned': For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). +* **userAssignedIdentities**: [ManagedClusterIdentityUserAssignedIdentities](#managedclusteridentityuserassignedidentities): The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## UserAssignedIdentity +## ManagedClusterIdentityUserAssignedIdentities ### Properties -* **clientId**: string: The client ID of the user assigned identity. -* **objectId**: string: The object ID of the user assigned identity. -* **resourceId**: string: The resource ID of the user assigned identity. +### Additional Properties +* **Additional Properties Type**: [ManagedServiceIdentityUserAssignedIdentitiesValue](#managedserviceidentityuserassignedidentitiesvalue) ## ManagedClusterIngressProfile ### Properties @@ -360,36 +373,6 @@ * **dnsZoneResourceId**: string: Resource ID of the DNS Zone to be associated with the web app. Used only when Web App Routing is enabled. * **enabled**: bool: Whether to enable Web App Routing. -## ContainerServiceLinuxProfile -### Properties -* **adminUsername**: string (Required): The administrator username to use for Linux VMs. -* **ssh**: [ContainerServiceSshConfiguration](#containerservicesshconfiguration) (Required): SSH configuration for Linux-based VMs running on Azure. - -## ContainerServiceSshConfiguration -### Properties -* **publicKeys**: [ContainerServiceSshPublicKey](#containerservicesshpublickey)[] (Required): The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. - -## ContainerServiceSshPublicKey -### Properties -* **keyData**: string (Required): Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. - -## ContainerServiceNetworkProfile -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **ipFamilies**: 'IPv4' | 'IPv6' | string[]: IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. -* **loadBalancerProfile**: [ManagedClusterLoadBalancerProfile](#managedclusterloadbalancerprofile): Profile of the managed cluster load balancer. -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **natGatewayProfile**: [ManagedClusterNATGatewayProfile](#managedclusternatgatewayprofile): Profile of the managed cluster NAT gateway. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -* **outboundType**: 'loadBalancer' | 'managedNATGateway' | 'userAssignedNATGateway' | 'userDefinedRouting' | string: This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). -* **podCidr**: string: A CIDR notation IP range from which to assign pod IPs when kubenet is used. -* **podCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **serviceCidrs**: string[]: One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. - ## ManagedClusterLoadBalancerProfile ### Properties * **allocatedOutboundPorts**: int: The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. @@ -400,10 +383,6 @@ * **outboundIPPrefixes**: [ManagedClusterLoadBalancerProfileOutboundIPPrefixes](#managedclusterloadbalancerprofileoutboundipprefixes): Desired outbound IP Prefix resources for the cluster load balancer. * **outboundIPs**: [ManagedClusterLoadBalancerProfileOutboundIPs](#managedclusterloadbalancerprofileoutboundips): Desired outbound IP resources for the cluster load balancer. -## ResourceReference -### Properties -* **id**: string: The fully qualified Azure resource id. - ## ManagedClusterLoadBalancerProfileManagedOutboundIPs ### Properties * **count**: int: The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. @@ -417,28 +396,21 @@ ### Properties * **publicIPs**: [ResourceReference](#resourcereference)[]: A list of public IP resources. +## ManagedClusterManagedOutboundIPProfile +### Properties +* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. + ## ManagedClusterNATGatewayProfile ### Properties * **effectiveOutboundIPs**: [ResourceReference](#resourcereference)[]: The effective outbound IP resources of the cluster NAT gateway. * **idleTimeoutInMinutes**: int: Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. * **managedOutboundIPProfile**: [ManagedClusterManagedOutboundIPProfile](#managedclustermanagedoutboundipprofile): Profile of the managed outbound IP resources of the managed cluster. -## ManagedClusterManagedOutboundIPProfile -### Properties -* **count**: int: The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. - ## ManagedClusterOidcIssuerProfile ### Properties * **enabled**: bool: Whether the OIDC issuer is enabled. * **issuerURL**: string (ReadOnly): The OIDC issuer url of the Managed Cluster. -## ManagedClusterPodIdentityProfile -### Properties -* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. -* **enabled**: bool: Whether the pod identity addon is enabled. -* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. -* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. - ## ManagedClusterPodIdentity ### Properties * **bindingSelector**: string: The binding selector to use for the AzureIdentityBinding resource. @@ -448,9 +420,23 @@ * **provisioningInfo**: [ManagedClusterPodIdentityProvisioningInfo](#managedclusterpodidentityprovisioninginfo) (ReadOnly) * **provisioningState**: 'Assigned' | 'Deleting' | 'Failed' | 'Updating' | string (ReadOnly): The current provisioning state of the pod identity. -## ManagedClusterPodIdentityProvisioningInfo +## ManagedClusterPodIdentityException ### Properties -* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. +* **name**: string (Required): The name of the pod identity exception. +* **namespace**: string (Required): The namespace of the pod identity exception. +* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. + +## ManagedClusterPodIdentityExceptionPodLabels +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedClusterPodIdentityProfile +### Properties +* **allowNetworkPluginKubenet**: bool: Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. +* **enabled**: bool: Whether the pod identity addon is enabled. +* **userAssignedIdentities**: [ManagedClusterPodIdentity](#managedclusterpodidentity)[]: The pod identities to use in the cluster. +* **userAssignedIdentityExceptions**: [ManagedClusterPodIdentityException](#managedclusterpodidentityexception)[]: The pod identity exceptions to allow. ## ManagedClusterPodIdentityProvisioningError ### Properties @@ -463,25 +449,84 @@ * **message**: string: A message describing the error, intended to be suitable for display in a user interface. * **target**: string: The target of the particular error. For example, the name of the property in error. -## ManagedClusterPodIdentityException +## ManagedClusterPodIdentityProvisioningInfo ### Properties -* **name**: string (Required): The name of the pod identity exception. -* **namespace**: string (Required): The namespace of the pod identity exception. -* **podLabels**: [ManagedClusterPodIdentityExceptionPodLabels](#managedclusterpodidentityexceptionpodlabels) (Required): The pod labels to match. +* **error**: [ManagedClusterPodIdentityProvisioningError](#managedclusterpodidentityprovisioningerror): An error response from the pod identity provisioning. -## ManagedClusterPodIdentityExceptionPodLabels +## ManagedClusterProperties +### Properties +* **aadProfile**: [ManagedClusterAADProfile](#managedclusteraadprofile): For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). +* **addonProfiles**: [ManagedClusterPropertiesAddonProfiles](#managedclusterpropertiesaddonprofiles): The profile of managed cluster add-on. +* **agentPoolProfiles**: [ManagedClusterAgentPoolProfile](#managedclusteragentpoolprofile)[]: The agent pool properties. +* **apiServerAccessProfile**: [ManagedClusterAPIServerAccessProfile](#managedclusterapiserveraccessprofile): Access profile for managed cluster API server. +* **autoScalerProfile**: [ManagedClusterPropertiesAutoScalerProfile](#managedclusterpropertiesautoscalerprofile): Parameters to be applied to the cluster-autoscaler when enabled +* **autoUpgradeProfile**: [ManagedClusterAutoUpgradeProfile](#managedclusterautoupgradeprofile): Auto upgrade profile for a managed cluster. +* **azurePortalFQDN**: string (ReadOnly): The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. +* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. +* **currentKubernetesVersion**: string (ReadOnly): The version of Kubernetes the Managed Cluster is running. +* **disableLocalAccounts**: bool: If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview). +* **diskEncryptionSetID**: string: This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}' +* **dnsPrefix**: string: This cannot be updated once the Managed Cluster has been created. +* **enableNamespaceResources**: bool: The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource. +* **enablePodSecurityPolicy**: bool: (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. +* **enableRBAC**: bool: Whether to enable Kubernetes Role-Based Access Control. +* **fqdn**: string (ReadOnly): The FQDN of the master pool. +* **fqdnSubdomain**: string: This cannot be updated once the Managed Cluster has been created. +* **httpProxyConfig**: [ManagedClusterHttpProxyConfig](#managedclusterhttpproxyconfig): Cluster HTTP proxy configuration. +* **identityProfile**: [ManagedClusterPropertiesIdentityProfile](#managedclusterpropertiesidentityprofile): Identities associated with the cluster. +* **ingressProfile**: [ManagedClusterIngressProfile](#managedclusteringressprofile): Ingress profile for the container service cluster. +* **kubernetesVersion**: string: When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details. +* **linuxProfile**: [ContainerServiceLinuxProfile](#containerservicelinuxprofile): Profile for Linux VMs in the container service cluster. +* **maxAgentPools**: int (ReadOnly): The max number of agent pools for the managed cluster. +* **networkProfile**: [ContainerServiceNetworkProfile](#containerservicenetworkprofile): Profile of network configuration. +* **nodeResourceGroup**: string: The name of the resource group containing agent pool nodes. +* **oidcIssuerProfile**: [ManagedClusterOidcIssuerProfile](#managedclusteroidcissuerprofile): The OIDC issuer profile of the Managed Cluster. +* **podIdentityProfile**: [ManagedClusterPodIdentityProfile](#managedclusterpodidentityprofile): See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. +* **powerState**: [PowerState](#powerstate) (ReadOnly): Describes the Power State of the cluster +* **privateFQDN**: string (ReadOnly): The FQDN of private cluster. +* **privateLinkResources**: [PrivateLinkResource](#privatelinkresource)[]: Private link resources associated with the cluster. +* **provisioningState**: string (ReadOnly): The current provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or deny public network access for AKS +* **securityProfile**: [ManagedClusterSecurityProfile](#managedclustersecurityprofile): Security profile for the container service cluster. +* **servicePrincipalProfile**: [ManagedClusterServicePrincipalProfile](#managedclusterserviceprincipalprofile): Information about a service principal identity for the cluster to use for manipulating Azure APIs. +* **windowsProfile**: [ManagedClusterWindowsProfile](#managedclusterwindowsprofile): Profile for Windows VMs in the managed cluster. + +## ManagedClusterPropertiesAddonProfiles ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ManagedClusterAddonProfile](#managedclusteraddonprofile) -## PrivateLinkResource +## ManagedClusterPropertiesAutoScalerProfile ### Properties -* **groupId**: string: The group ID of the resource. -* **id**: string: The ID of the private link resource. -* **name**: string: The name of the private link resource. -* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. -* **requiredMembers**: string[]: The RequiredMembers of the resource -* **type**: string: The resource type. +* **balance-similar-node-groups**: string: Valid values are 'true' and 'false' +* **expander**: 'least-waste' | 'most-pods' | 'priority' | 'random' | string: If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. +* **max-empty-bulk-delete**: string: The default is 10. +* **max-graceful-termination-sec**: string: The default is 600. +* **max-node-provision-time**: string: The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **max-total-unready-percentage**: string: The default is 45. The maximum is 100 and the minimum is 0. +* **new-pod-scale-up-delay**: string: For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). +* **ok-total-unready-count**: string: This must be an integer. The default is 3. +* **scale-down-delay-after-add**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-delete**: string: The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-delay-after-failure**: string: The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unneeded-time**: string: The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-unready-time**: string: The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. +* **scale-down-utilization-threshold**: string: The default is '0.5'. +* **scan-interval**: string: The default is '10'. Values must be an integer number of seconds. +* **skip-nodes-with-local-storage**: string: The default is true. +* **skip-nodes-with-system-pods**: string: The default is true. + +## ManagedClusterPropertiesForSnapshot +### Properties +* **enableRbac**: bool: Whether the cluster has enabled Kubernetes Role-Based Access Control or not. +* **kubernetesVersion**: string: The current kubernetes version. +* **networkProfile**: [NetworkProfileForSnapshot](#networkprofileforsnapshot) (ReadOnly): network profile for managed cluster snapshot, these properties are read only. +* **sku**: [ManagedClusterSKU](#managedclustersku): The SKU of a Managed Cluster. + +## ManagedClusterPropertiesIdentityProfile +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## ManagedClusterSecurityProfile ### Properties @@ -494,11 +539,6 @@ * **enabled**: bool: Whether to enable Azure Defender * **logAnalyticsWorkspaceResourceId**: string: Resource ID of the Log Analytics workspace to be associated with Azure Defender. When Azure Defender is enabled, this field is required and must be a valid workspace resource ID. When Azure Defender is disabled, leave the field empty. -## AzureKeyVaultKms -### Properties -* **enabled**: bool: Whether to enable Azure Key Vault key management service. The default is false. -* **keyId**: string: Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. - ## ManagedClusterSecurityProfileWorkloadIdentity ### Properties * **enabled**: bool: Whether to enable Workload Identity @@ -508,109 +548,44 @@ * **clientId**: string (Required): The ID for the service principal. * **secret**: string: The secret password associated with the service principal in plain text. -## ManagedClusterWindowsProfile -### Properties -* **adminPassword**: string: 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!" -* **adminUsername**: string (Required): 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 -* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). -* **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. -* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. - -## WindowsGmsaProfile -### Properties -* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. -* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. -* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. - ## ManagedClusterSKU ### Properties * **name**: 'Basic' | string: The name of a managed cluster SKU. * **tier**: 'Free' | 'Paid' | string: If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedClusterAgentPoolProfileProperties +## ManagedClusterSnapshotProperties ### Properties -* **availabilityZones**: string[]: The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. -* **capacityReservationGroupID**: string: Capacity Reservation Group ID for AgentPool to associate -* **count**: int: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. * **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **currentOrchestratorVersion**: string: If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used. -* **enableAutoScaling**: bool: Whether to enable auto-scaler -* **enableEncryptionAtHost**: bool: This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption -* **enableFIPS**: bool: See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. -* **enableNodePublicIP**: bool: Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. -* **enableUltraSSD**: bool: Whether to enable UltraSSD -* **gpuInstanceProfile**: 'MIG1g' | 'MIG2g' | 'MIG3g' | 'MIG4g' | 'MIG7g' | string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. -* **hostGroupID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). -* **kubeletConfig**: [KubeletConfig](#kubeletconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **kubeletDiskType**: 'OS' | 'Temporary' | string: Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. -* **linuxOSConfig**: [LinuxOSConfig](#linuxosconfig): See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. -* **maxCount**: int: The maximum number of nodes for auto-scaling -* **maxPods**: int: The maximum number of pods that can run on a node. -* **messageOfTheDay**: string: A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). -* **minCount**: int: The minimum number of nodes for auto-scaling -* **mode**: 'System' | 'User' | string: A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools -* **nodeImageVersion**: string (ReadOnly): The version of node image -* **nodeLabels**: [ManagedClusterAgentPoolProfilePropertiesNodeLabels](#managedclusteragentpoolprofilepropertiesnodelabels): The node labels to be persisted across all nodes in agent pool. -* **nodePublicIPPrefixID**: string: This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} -* **nodeTaints**: string[]: The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. -* **orchestratorVersion**: string: Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). -* **osDiskSizeGB**: int: OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. -* **osDiskType**: 'Ephemeral' | 'Managed' | string: The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). -* **osSKU**: 'CBLMariner' | 'Ubuntu' | string: Specifies an OS SKU. This value must not be specified if OSType is Windows. -* **osType**: 'Linux' | 'Windows' | string: The operating system type. The default is Linux. -* **podSubnetID**: string: If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **powerState**: [PowerState](#powerstate): Describes the Power State of the cluster -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state. -* **proximityPlacementGroupID**: string: The ID for Proximity Placement Group. -* **scaleDownMode**: 'Deallocate' | 'Delete' | string: Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing). -* **scaleSetEvictionPolicy**: 'Deallocate' | 'Delete' | string: The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms) -* **scaleSetPriority**: 'Regular' | 'Spot' | string: The Virtual Machine Scale Set priority. -* **spotMaxPrice**: int: Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) -* **tags**: [ManagedClusterAgentPoolProfilePropertiesTags](#managedclusteragentpoolprofilepropertiestags): The tags to be persisted on the agent pool virtual machine scale set. -* **type**: 'AvailabilitySet' | 'VirtualMachineScaleSets' | string: The type of Agent Pool. -* **upgradeSettings**: [AgentPoolUpgradeSettings](#agentpoolupgradesettings): Settings for upgrading an agentpool -* **vmSize**: string: VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions -* **vnetSubnetID**: string: If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} -* **workloadRuntime**: 'OCIContainer' | 'WasmWasi' | string: Determines the type of workload a node can run. +* **managedClusterPropertiesReadOnly**: [ManagedClusterPropertiesForSnapshot](#managedclusterpropertiesforsnapshot) (ReadOnly): managed cluster properties for snapshot, these properties are read only. +* **snapshotType**: 'ManagedCluster' | 'NodePool' | string: The type of a snapshot. The default is NodePool. -## ManagedClusterAgentPoolProfilePropertiesNodeLabels +## ManagedClusterWindowsProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminPassword**: string: 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!" +* **adminUsername**: string (Required): 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 +* **enableCSIProxy**: bool: For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). +* **gmsaProfile**: [WindowsGmsaProfile](#windowsgmsaprofile): Windows gMSA Profile in the managed cluster. +* **licenseType**: 'None' | 'Windows_Server' | string: The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. -## ManagedClusterAgentPoolProfilePropertiesTags +## ManagedServiceIdentityUserAssignedIdentitiesValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## MaintenanceConfigurationProperties +## NetworkProfileForSnapshot ### Properties -* **notAllowedTime**: [TimeSpan](#timespan)[]: Time slots on which upgrade is not allowed. -* **timeInWeek**: [TimeInWeek](#timeinweek)[]: If two array entries specify the same day of the week, the applied configuration is the union of times in both entries. +* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. +* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. +* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. +* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. -## TimeSpan +## PowerState ### Properties -* **end**: string: The end of a time span -* **start**: string: The start of a time span +* **code**: 'Running' | 'Stopped' | string: Tells whether the cluster is Running or Stopped -## TimeInWeek +## PrivateEndpoint ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. -* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. +* **id**: string: The resource ID of the private endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -618,39 +593,23 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The state of a private link service connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateLinkResource ### Properties -* **id**: string: The resource ID of the private endpoint +* **groupId**: string: The group ID of the resource. +* **id**: string: The ID of the private link resource. +* **name**: string: The name of the private link resource. +* **privateLinkServiceID**: string (ReadOnly): The private link service ID of the resource, this field is exposed only to NRP internally. +* **requiredMembers**: string[]: The RequiredMembers of the resource +* **type**: string: The resource type. ## PrivateLinkServiceConnectionState ### Properties * **description**: string: The private link service connection description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private link service connection status. -## ManagedClusterSnapshotProperties -### Properties -* **creationData**: [CreationData](#creationdata): Data used when creating a target resource from a source resource. -* **managedClusterPropertiesReadOnly**: [ManagedClusterPropertiesForSnapshot](#managedclusterpropertiesforsnapshot) (ReadOnly): managed cluster properties for snapshot, these properties are read only. -* **snapshotType**: 'ManagedCluster' | 'NodePool' | string: The type of a snapshot. The default is NodePool. - -## ManagedClusterPropertiesForSnapshot -### Properties -* **enableRbac**: bool: Whether the cluster has enabled Kubernetes Role-Based Access Control or not. -* **kubernetesVersion**: string: The current kubernetes version. -* **networkProfile**: [NetworkProfileForSnapshot](#networkprofileforsnapshot) (ReadOnly): network profile for managed cluster snapshot, these properties are read only. -* **sku**: [ManagedClusterSKU](#managedclustersku): The SKU of a Managed Cluster. - -## NetworkProfileForSnapshot -### Properties -* **loadBalancerSku**: 'basic' | 'standard' | string: The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. -* **networkMode**: 'bridge' | 'transparent' | string: This cannot be specified if networkPlugin is anything other than 'azure'. -* **networkPlugin**: 'azure' | 'kubenet' | 'none' | string: Network plugin used for building the Kubernetes network. -* **networkPolicy**: 'azure' | 'calico' | string: Network policy used for building the Kubernetes network. - -## TrackedResourceTags +## ResourceReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The fully qualified Azure resource id. ## SnapshotProperties ### Properties @@ -663,44 +622,85 @@ * **snapshotType**: 'ManagedCluster' | 'NodePool' | string: The type of a snapshot. The default is NodePool. * **vmSize**: string (ReadOnly): The size of the VM. -## TrackedResourceTags +## SysctlConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **fsAioMaxNr**: int: Sysctl setting fs.aio-max-nr. +* **fsFileMax**: int: Sysctl setting fs.file-max. +* **fsInotifyMaxUserWatches**: int: Sysctl setting fs.inotify.max_user_watches. +* **fsNrOpen**: int: Sysctl setting fs.nr_open. +* **kernelThreadsMax**: int: Sysctl setting kernel.threads-max. +* **netCoreNetdevMaxBacklog**: int: Sysctl setting net.core.netdev_max_backlog. +* **netCoreOptmemMax**: int: Sysctl setting net.core.optmem_max. +* **netCoreRmemDefault**: int: Sysctl setting net.core.rmem_default. +* **netCoreRmemMax**: int: Sysctl setting net.core.rmem_max. +* **netCoreSomaxconn**: int: Sysctl setting net.core.somaxconn. +* **netCoreWmemDefault**: int: Sysctl setting net.core.wmem_default. +* **netCoreWmemMax**: int: Sysctl setting net.core.wmem_max. +* **netIpv4IpLocalPortRange**: string: Sysctl setting net.ipv4.ip_local_port_range. +* **netIpv4NeighDefaultGcThresh1**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh1. +* **netIpv4NeighDefaultGcThresh2**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh2. +* **netIpv4NeighDefaultGcThresh3**: int: Sysctl setting net.ipv4.neigh.default.gc_thresh3. +* **netIpv4TcpFinTimeout**: int: Sysctl setting net.ipv4.tcp_fin_timeout. +* **netIpv4TcpkeepaliveIntvl**: int: Sysctl setting net.ipv4.tcp_keepalive_intvl. +* **netIpv4TcpKeepaliveProbes**: int: Sysctl setting net.ipv4.tcp_keepalive_probes. +* **netIpv4TcpKeepaliveTime**: int: Sysctl setting net.ipv4.tcp_keepalive_time. +* **netIpv4TcpMaxSynBacklog**: int: Sysctl setting net.ipv4.tcp_max_syn_backlog. +* **netIpv4TcpMaxTwBuckets**: int: Sysctl setting net.ipv4.tcp_max_tw_buckets. +* **netIpv4TcpTwReuse**: bool: Sysctl setting net.ipv4.tcp_tw_reuse. +* **netNetfilterNfConntrackBuckets**: int: Sysctl setting net.netfilter.nf_conntrack_buckets. +* **netNetfilterNfConntrackMax**: int: Sysctl setting net.netfilter.nf_conntrack_max. +* **vmMaxMapCount**: int: Sysctl setting vm.max_map_count. +* **vmSwappiness**: int: Sysctl setting vm.swappiness. +* **vmVfsCachePressure**: int: Sysctl setting vm.vfs_cache_pressure. -## CredentialResults +## SystemData ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CredentialResult +## TimeInWeek ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: The weekday enum. +* **hourSlots**: int[]: Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. -## CredentialResults +## TimeSpan ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +* **end**: string: The end of a time span +* **start**: string: The start of a time span -## CredentialResults +## TrackedResourceTags ### Properties -* **kubeconfigs**: [CredentialResult](#credentialresult)[] (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string -## ManagedClusterAccessProfile +## TrackedResourceTags ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **location**: string (ReadOnly): The geo-location where the resource lives -* **name**: string (ReadOnly): The name of the resource -* **properties**: [AccessProfile](#accessprofile) (ReadOnly): Profile for enabling a user to access a managed cluster. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [TrackedResourceTags](#trackedresourcetags) (ReadOnly): Resource tags. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +### Additional Properties +* **Additional Properties Type**: string -## AccessProfile +## TrackedResourceTags ### Properties -* **kubeConfig**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentity +### Properties +* **clientId**: string: The client ID of the user assigned identity. +* **objectId**: string: The object ID of the user assigned identity. +* **resourceId**: string: The resource ID of the user assigned identity. + +## WindowsGmsaProfile +### Properties +* **dnsServer**: string: Specifies the DNS server for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. +* **enabled**: bool: Specifies whether to enable Windows gMSA in the managed cluster. +* **rootDomainName**: string: Specifies the root domain name for Windows gMSA.

    Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. + diff --git a/generated/cosmos-db/log.out b/generated/cosmos-db/log.out index fd706794b4..2aa4c32459 100644 --- a/generated/cosmos-db/log.out +++ b/generated/cosmos-db/log.out @@ -28,7 +28,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.documentdb-2022-02-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -56,7 +56,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-02-15-preview/cosmos-db.json:6123:5 @@ -203,7 +203,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountGetResu warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountCreateUpdateParameters' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountCreateUpdateParameters warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 46ms +info | autorest.bicep took 42ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-11-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -231,7 +231,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-11-15-preview/cosmos-db.json:5781:5 @@ -378,7 +378,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountGetResu warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountCreateUpdateParameters' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountCreateUpdateParameters warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 38ms +info | autorest.bicep took 44ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-10-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -406,7 +406,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-10-15/cosmos-db.json:5126:5 @@ -541,7 +541,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SqlRoleDefinitionListResult' warning | PreCheck/SchemaMissingType | The schema 'SqlRoleAssignmentListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-10-15/rbac.json:541:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 21ms +info | autorest.bicep took 28ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-10-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -569,7 +569,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-10-15-preview/cosmos-db.json:5781:5 @@ -716,7 +716,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountGetResu warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountCreateUpdateParameters' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountCreateUpdateParameters warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 25ms +info | autorest.bicep took 40ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -744,7 +744,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json:5639:5 @@ -888,7 +888,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountGetResults' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountGetResults warning | PreCheck/PropertyRedeclarationWarning | Schema 'DatabaseAccountCreateUpdateParameters' has a property 'identity' that is already declared the parent schema 'ARMResourceProperties' but isn't significantly different. The property has been removed from DatabaseAccountCreateUpdateParameters warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 18ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-06-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -916,7 +916,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-06-15/cosmos-db.json:5054:5 @@ -1051,7 +1051,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SqlRoleDefinitionListResult' warning | PreCheck/SchemaMissingType | The schema 'SqlRoleAssignmentListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-06-15/rbac.json:541:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 25ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-05-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1079,7 +1079,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json:5051:5 @@ -1214,7 +1214,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SqlRoleDefinitionListResult' warning | PreCheck/SchemaMissingType | The schema 'SqlRoleAssignmentListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/rbac.json:541:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 23ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-04-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1242,7 +1242,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-04-15/cosmos-db.json:5051:5 @@ -1377,7 +1377,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SqlRoleDefinitionListResult' warning | PreCheck/SchemaMissingType | The schema 'SqlRoleAssignmentListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-04-15/rbac.json:541:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1405,7 +1405,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-04-01-preview/cosmos-db.json:5280:5 @@ -1563,7 +1563,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ServiceResourceListResult' wi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-04-01-preview/services.json:319:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 17ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-03-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1591,7 +1591,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-03-15/cosmos-db.json:5051:5 @@ -1732,7 +1732,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ErrorResponse' (10 - properties.additionalInfo: => {"x-ms-identifiers":[],"$ref":"#/components/schemas/schemas:500","description":"The error additional info.","readOnly":true} - title: => "Error Response" warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorResponse' -> 'ErrorResponseAutoGenerated' -info | autorest.bicep took 16ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1760,7 +1760,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-03-01-preview/cosmos-db.json:5228:5 @@ -1915,7 +1915,7 @@ warning | PreCheck/SchemaMissingType | The schema 'RestorableMongodbCollectionsL warning | PreCheck/SchemaMissingType | The schema 'RestorableMongodbResourcesListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2021-03-01-preview/restorable.json:682:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.documentdb-2021-01-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1943,7 +1943,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-01-15/cosmos-db.json:5051:5 @@ -2084,7 +2084,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ErrorResponse' (10 - properties.additionalInfo: => {"x-ms-identifiers":[],"$ref":"#/components/schemas/schemas:497","description":"The error additional info.","readOnly":true} - title: => "Error Response" warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorResponse' -> 'ErrorResponseAutoGenerated' -info | autorest.bicep took 25ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.documentdb-2020-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2112,7 +2112,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-09-01/cosmos-db.json:5051:5 @@ -2251,7 +2251,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ErrorResponse' (10 - properties.additionalInfo: => {"x-ms-identifiers":[],"$ref":"#/components/schemas/schemas:464","description":"The error additional info.","readOnly":true} - title: => "Error Response" warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorResponse' -> 'ErrorResponseAutoGenerated' -info | autorest.bicep took 12ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.documentdb-2019-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2279,12 +2279,12 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json:216:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.documentdb-2020-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2312,7 +2312,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json:4304:5 @@ -2467,7 +2467,7 @@ warning | PreCheck/SchemaMissingType | The schema 'RestorableMongodbResourcesLis warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts -info | autorest.bicep took 17ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.documentdb-2020-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2495,7 +2495,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json:4931:5 @@ -2650,7 +2650,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json:4931:5 @@ -2777,7 +2777,7 @@ warning | PreCheck/SchemaMissingType | The schema 'NotebookWorkspaceConnectionIn warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts -info | autorest.bicep took 11ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.documentdb-2019-12-12"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2805,7 +2805,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json:4187:5 @@ -2914,7 +2914,7 @@ warning | PreCheck/SchemaMissingType | The schema 'NotebookWorkspaceConnectionIn warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts -info | autorest.bicep took 17ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.documentdb-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2942,7 +2942,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json:4187:5 @@ -3079,7 +3079,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json:3653:5 @@ -3156,7 +3156,7 @@ warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts warning | Modeler/MissingType | The schema 'GremlinDatabaseProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json#/components/schemas/GremlinDatabaseProperties-_ts -info | autorest.bicep took 9ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.documentdb-2014-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3184,7 +3184,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json:3653:5 @@ -3261,7 +3261,7 @@ warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts warning | Modeler/MissingType | The schema 'GremlinDatabaseProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json#/components/schemas/GremlinDatabaseProperties-_ts -info | autorest.bicep took 9ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.documentdb-2015-11-06"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3289,7 +3289,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json:3653:5 @@ -3366,7 +3366,7 @@ warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts warning | Modeler/MissingType | The schema 'GremlinDatabaseProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json#/components/schemas/GremlinDatabaseProperties-_ts -info | autorest.bicep took 6ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.documentdb-2016-03-19"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3394,7 +3394,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json:3653:5 @@ -3471,7 +3471,7 @@ warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts warning | Modeler/MissingType | The schema 'GremlinDatabaseProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json#/components/schemas/GremlinDatabaseProperties-_ts -info | autorest.bicep took 8ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.documentdb-2016-03-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3499,7 +3499,7 @@ warning | DeprecatedConfig | Using directive.22.suppress which is deprecated and warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseAccountsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json:3653:5 @@ -3576,5 +3576,5 @@ warning | Modeler/MissingType | The schema 'ExtendedResourceProperties-_ts' has file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json#/components/schemas/ExtendedResourceProperties-_ts warning | Modeler/MissingType | The schema 'GremlinDatabaseProperties-_ts' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json#/components/schemas/GremlinDatabaseProperties-_ts -info | autorest.bicep took 6ms -info | Autorest completed in 172.74s. 48 files generated. +info | autorest.bicep took 12ms +info | Autorest completed in 165.51s. 48 files generated. diff --git a/generated/cosmos-db/microsoft.documentdb/2015-04-01/types.md b/generated/cosmos-db/microsoft.documentdb/2015-04-01/types.md index 1418887e2a..a7e1672243 100644 --- a/generated/cosmos-db/microsoft.documentdb/2015-04-01/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2015-04-01/types.md @@ -176,177 +176,173 @@ * **ApiVersion**: 2015-04-01 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy +## CassandraKeyspaceCreateUpdateProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object -## FailoverPolicy +## CassandraKeyspaceResource ### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace -## Location +## CassandraPartitionKey ### Properties -* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int (WriteOnly): 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. -* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string (WriteOnly): The name of the region. -* **provisioningState**: string (ReadOnly, WriteOnly): 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. +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key -## VirtualNetworkRule +## CassandraSchema ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. +* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. -## Tags +## CassandraTableCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object +* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema -## SqlDatabaseCreateUpdateProperties +## CassandraTableResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (ReadOnly): Name of the Cosmos DB SQL database -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object +* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema -## CreateUpdateOptions +## ClusterKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" -## SqlDatabaseResource +## Column ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column +* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. -## MongoDBCollectionCreateUpdateProperties +## ConsistencyPolicy ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object -* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## MongoIndex +## ContainerPartitionKey ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options +* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning +* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned -## MongoIndexKeys +## CreateUpdateOptions ### Properties -* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service +### Additional Properties +* **Additional Properties Type**: string -## MongoIndexOptions +## CreateUpdateOptions ### Properties -* **expireAfterSeconds**: int (WriteOnly): Expire after seconds -* **unique**: bool (WriteOnly): Is unique or not +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## MongoDBCollectionResource +## CreateUpdateOptions ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys -* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind +### Additional Properties +* **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ThroughputUpdateProperties +## DatabaseAccountConnectionString ### Properties -* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object -* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## SqlContainerCreateUpdateProperties +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. + +## GremlinGraphCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB SQL container +* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic -* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. - -## ExcludedPath +## GremlinGraphResource ### Properties -* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. +* **defaultTtl**: int (WriteOnly): Default time to live +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ## IncludedPath ### Properties @@ -359,71 +355,108 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string (WriteOnly): Indicates the type of index. * **precision**: int (WriteOnly): The precision of the index. -1 is maximum precision. -## CreateUpdateOptions +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic +* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. -## ContainerPartitionKey +## Location ### Properties -* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning -* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned +* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int (WriteOnly): 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. +* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string (WriteOnly): The name of the region. +* **provisioningState**: string (ReadOnly, WriteOnly): 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. -## SqlContainerResource +## MongoDBCollectionCreateUpdateProperties ### Properties -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. -* **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object +* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKeyPolicy +## MongoDBCollectionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys +* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKey +## MongoIndex ### Properties -* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service +* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options -## Tags +## MongoIndexKeys +### Properties +* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int (WriteOnly): Expire after seconds +* **unique**: bool (WriteOnly): Is unique or not + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SqlContainerCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (ReadOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GremlinGraphResource +## SqlContainerResource ### Properties * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. * **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +## SqlDatabaseCreateUpdateProperties +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (ReadOnly): Name of the Cosmos DB SQL database +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object + +## SqlDatabaseResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database + +## TableCreateUpdateProperties +### Properties +* **id**: string (ReadOnly): Name of the Cosmos DB table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object + +## TableResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -439,21 +472,11 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceCreateUpdateProperties -### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceResource -### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace - ## Tags ### Properties ### Additional Properties @@ -464,44 +487,15 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraTableCreateUpdateProperties -### Properties -* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object -* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraTableResource -### Properties -* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. -* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. - -## ClusterKey -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" - -## Column -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column -* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column - -## CassandraPartitionKey +## Tags ### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -513,20 +507,20 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -538,19 +532,25 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## ThroughputResource ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountConnectionString +## ThroughputUpdateProperties ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object +* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountListKeysResult +## UniqueKey ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2015-04-08/types.md b/generated/cosmos-db/microsoft.documentdb/2015-04-08/types.md index c9747627e7..8b93696877 100644 --- a/generated/cosmos-db/microsoft.documentdb/2015-04-08/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2015-04-08/types.md @@ -176,177 +176,173 @@ * **ApiVersion**: 2015-04-08 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy +## CassandraKeyspaceCreateUpdateProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object -## FailoverPolicy +## CassandraKeyspaceResource ### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace -## Location +## CassandraPartitionKey ### Properties -* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int (WriteOnly): 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. -* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string (WriteOnly): The name of the region. -* **provisioningState**: string (ReadOnly, WriteOnly): 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. +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key -## VirtualNetworkRule +## CassandraSchema ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. +* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. -## Tags +## CassandraTableCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object +* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema -## SqlDatabaseCreateUpdateProperties +## CassandraTableResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (ReadOnly): Name of the Cosmos DB SQL database -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object +* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema -## CreateUpdateOptions +## ClusterKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" -## SqlDatabaseResource +## Column ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column +* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. -## MongoDBCollectionCreateUpdateProperties +## ConsistencyPolicy ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object -* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## MongoIndex +## ContainerPartitionKey ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options +* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning +* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned -## MongoIndexKeys +## CreateUpdateOptions ### Properties -* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service +### Additional Properties +* **Additional Properties Type**: string -## MongoIndexOptions +## CreateUpdateOptions ### Properties -* **expireAfterSeconds**: int (WriteOnly): Expire after seconds -* **unique**: bool (WriteOnly): Is unique or not +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## MongoDBCollectionResource +## CreateUpdateOptions ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys -* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind +### Additional Properties +* **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ThroughputUpdateProperties +## DatabaseAccountConnectionString ### Properties -* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object -* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## SqlContainerCreateUpdateProperties +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. + +## GremlinGraphCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB SQL container +* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic -* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. - -## ExcludedPath +## GremlinGraphResource ### Properties -* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. +* **defaultTtl**: int (WriteOnly): Default time to live +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ## IncludedPath ### Properties @@ -359,71 +355,108 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string (WriteOnly): Indicates the type of index. * **precision**: int (WriteOnly): The precision of the index. -1 is maximum precision. -## CreateUpdateOptions +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic +* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. -## ContainerPartitionKey +## Location ### Properties -* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning -* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned +* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int (WriteOnly): 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. +* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string (WriteOnly): The name of the region. +* **provisioningState**: string (ReadOnly, WriteOnly): 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. -## SqlContainerResource +## MongoDBCollectionCreateUpdateProperties ### Properties -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. -* **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object +* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKeyPolicy +## MongoDBCollectionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys +* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKey +## MongoIndex ### Properties -* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service +* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options -## Tags +## MongoIndexKeys +### Properties +* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int (WriteOnly): Expire after seconds +* **unique**: bool (WriteOnly): Is unique or not + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SqlContainerCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (ReadOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GremlinGraphResource +## SqlContainerResource ### Properties * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. * **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +## SqlDatabaseCreateUpdateProperties +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (ReadOnly): Name of the Cosmos DB SQL database +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object + +## SqlDatabaseResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database + +## TableCreateUpdateProperties +### Properties +* **id**: string (ReadOnly): Name of the Cosmos DB table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object + +## TableResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -439,21 +472,11 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceCreateUpdateProperties -### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceResource -### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace - ## Tags ### Properties ### Additional Properties @@ -464,44 +487,15 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraTableCreateUpdateProperties -### Properties -* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object -* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraTableResource -### Properties -* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. -* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. - -## ClusterKey -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" - -## Column -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column -* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column - -## CassandraPartitionKey +## Tags ### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -513,20 +507,20 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -538,19 +532,25 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## ThroughputResource ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountConnectionString +## ThroughputUpdateProperties ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object +* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountListKeysResult +## UniqueKey ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2015-11-06/types.md b/generated/cosmos-db/microsoft.documentdb/2015-11-06/types.md index 6fa819a49b..be4d32796c 100644 --- a/generated/cosmos-db/microsoft.documentdb/2015-11-06/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2015-11-06/types.md @@ -176,177 +176,173 @@ * **ApiVersion**: 2015-11-06 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy +## CassandraKeyspaceCreateUpdateProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object -## FailoverPolicy +## CassandraKeyspaceResource ### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace -## Location +## CassandraPartitionKey ### Properties -* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int (WriteOnly): 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. -* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string (WriteOnly): The name of the region. -* **provisioningState**: string (ReadOnly, WriteOnly): 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. +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key -## VirtualNetworkRule +## CassandraSchema ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. +* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. -## Tags +## CassandraTableCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object +* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema -## SqlDatabaseCreateUpdateProperties +## CassandraTableResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (ReadOnly): Name of the Cosmos DB SQL database -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object +* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema -## CreateUpdateOptions +## ClusterKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" -## SqlDatabaseResource +## Column ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column +* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. -## MongoDBCollectionCreateUpdateProperties +## ConsistencyPolicy ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object -* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## MongoIndex +## ContainerPartitionKey ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options +* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning +* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned -## MongoIndexKeys +## CreateUpdateOptions ### Properties -* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service +### Additional Properties +* **Additional Properties Type**: string -## MongoIndexOptions +## CreateUpdateOptions ### Properties -* **expireAfterSeconds**: int (WriteOnly): Expire after seconds -* **unique**: bool (WriteOnly): Is unique or not +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## MongoDBCollectionResource +## CreateUpdateOptions ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys -* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind +### Additional Properties +* **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ThroughputUpdateProperties +## DatabaseAccountConnectionString ### Properties -* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object -* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## SqlContainerCreateUpdateProperties +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. + +## GremlinGraphCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB SQL container +* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic -* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. - -## ExcludedPath +## GremlinGraphResource ### Properties -* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. +* **defaultTtl**: int (WriteOnly): Default time to live +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ## IncludedPath ### Properties @@ -359,71 +355,108 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string (WriteOnly): Indicates the type of index. * **precision**: int (WriteOnly): The precision of the index. -1 is maximum precision. -## CreateUpdateOptions +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic +* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. -## ContainerPartitionKey +## Location ### Properties -* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning -* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned +* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int (WriteOnly): 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. +* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string (WriteOnly): The name of the region. +* **provisioningState**: string (ReadOnly, WriteOnly): 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. -## SqlContainerResource +## MongoDBCollectionCreateUpdateProperties ### Properties -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. -* **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object +* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKeyPolicy +## MongoDBCollectionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys +* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKey +## MongoIndex ### Properties -* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service +* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options -## Tags +## MongoIndexKeys +### Properties +* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int (WriteOnly): Expire after seconds +* **unique**: bool (WriteOnly): Is unique or not + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SqlContainerCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (ReadOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GremlinGraphResource +## SqlContainerResource ### Properties * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. * **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +## SqlDatabaseCreateUpdateProperties +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (ReadOnly): Name of the Cosmos DB SQL database +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object + +## SqlDatabaseResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database + +## TableCreateUpdateProperties +### Properties +* **id**: string (ReadOnly): Name of the Cosmos DB table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object + +## TableResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -439,21 +472,11 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceCreateUpdateProperties -### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceResource -### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace - ## Tags ### Properties ### Additional Properties @@ -464,44 +487,15 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraTableCreateUpdateProperties -### Properties -* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object -* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraTableResource -### Properties -* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. -* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. - -## ClusterKey -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" - -## Column -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column -* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column - -## CassandraPartitionKey +## Tags ### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -513,20 +507,20 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -538,19 +532,25 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## ThroughputResource ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountConnectionString +## ThroughputUpdateProperties ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object +* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountListKeysResult +## UniqueKey ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2016-03-19/types.md b/generated/cosmos-db/microsoft.documentdb/2016-03-19/types.md index e633d5c859..274acc5e92 100644 --- a/generated/cosmos-db/microsoft.documentdb/2016-03-19/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2016-03-19/types.md @@ -176,177 +176,173 @@ * **ApiVersion**: 2016-03-19 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy +## CassandraKeyspaceCreateUpdateProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object -## FailoverPolicy +## CassandraKeyspaceResource ### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace -## Location +## CassandraPartitionKey ### Properties -* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int (WriteOnly): 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. -* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string (WriteOnly): The name of the region. -* **provisioningState**: string (ReadOnly, WriteOnly): 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. +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key -## VirtualNetworkRule +## CassandraSchema ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. +* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. -## Tags +## CassandraTableCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object +* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema -## SqlDatabaseCreateUpdateProperties +## CassandraTableResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (ReadOnly): Name of the Cosmos DB SQL database -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object +* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema -## CreateUpdateOptions +## ClusterKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" -## SqlDatabaseResource +## Column ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column +* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. -## MongoDBCollectionCreateUpdateProperties +## ConsistencyPolicy ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object -* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## MongoIndex +## ContainerPartitionKey ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options +* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning +* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned -## MongoIndexKeys +## CreateUpdateOptions ### Properties -* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service +### Additional Properties +* **Additional Properties Type**: string -## MongoIndexOptions +## CreateUpdateOptions ### Properties -* **expireAfterSeconds**: int (WriteOnly): Expire after seconds -* **unique**: bool (WriteOnly): Is unique or not +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## MongoDBCollectionResource +## CreateUpdateOptions ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys -* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind +### Additional Properties +* **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ThroughputUpdateProperties +## DatabaseAccountConnectionString ### Properties -* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object -* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## SqlContainerCreateUpdateProperties +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. + +## GremlinGraphCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB SQL container +* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic -* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. - -## ExcludedPath +## GremlinGraphResource ### Properties -* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. +* **defaultTtl**: int (WriteOnly): Default time to live +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ## IncludedPath ### Properties @@ -359,71 +355,108 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string (WriteOnly): Indicates the type of index. * **precision**: int (WriteOnly): The precision of the index. -1 is maximum precision. -## CreateUpdateOptions +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic +* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. -## ContainerPartitionKey +## Location ### Properties -* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning -* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned +* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int (WriteOnly): 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. +* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string (WriteOnly): The name of the region. +* **provisioningState**: string (ReadOnly, WriteOnly): 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. -## SqlContainerResource +## MongoDBCollectionCreateUpdateProperties ### Properties -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. -* **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object +* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKeyPolicy +## MongoDBCollectionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys +* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKey +## MongoIndex ### Properties -* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service +* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options -## Tags +## MongoIndexKeys +### Properties +* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int (WriteOnly): Expire after seconds +* **unique**: bool (WriteOnly): Is unique or not + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SqlContainerCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (ReadOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GremlinGraphResource +## SqlContainerResource ### Properties * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. * **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +## SqlDatabaseCreateUpdateProperties +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (ReadOnly): Name of the Cosmos DB SQL database +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object + +## SqlDatabaseResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database + +## TableCreateUpdateProperties +### Properties +* **id**: string (ReadOnly): Name of the Cosmos DB table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object + +## TableResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -439,21 +472,11 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceCreateUpdateProperties -### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceResource -### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace - ## Tags ### Properties ### Additional Properties @@ -464,44 +487,15 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraTableCreateUpdateProperties -### Properties -* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object -* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraTableResource -### Properties -* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. -* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. - -## ClusterKey -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" - -## Column -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column -* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column - -## CassandraPartitionKey +## Tags ### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -513,20 +507,20 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -538,19 +532,25 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## ThroughputResource ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountConnectionString +## ThroughputUpdateProperties ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object +* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountListKeysResult +## UniqueKey ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2016-03-31/types.md b/generated/cosmos-db/microsoft.documentdb/2016-03-31/types.md index 77145ded98..ff5caf87f2 100644 --- a/generated/cosmos-db/microsoft.documentdb/2016-03-31/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2016-03-31/types.md @@ -176,177 +176,173 @@ * **ApiVersion**: 2016-03-31 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy +## CassandraKeyspaceCreateUpdateProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object -## FailoverPolicy +## CassandraKeyspaceResource ### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace -## Location +## CassandraPartitionKey ### Properties -* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int (WriteOnly): 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. -* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string (WriteOnly): The name of the region. -* **provisioningState**: string (ReadOnly, WriteOnly): 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. +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key -## VirtualNetworkRule +## CassandraSchema ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. +* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. -## Tags +## CassandraTableCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object +* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema -## SqlDatabaseCreateUpdateProperties +## CassandraTableResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (ReadOnly): Name of the Cosmos DB SQL database -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object +* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema -## CreateUpdateOptions +## ClusterKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" -## SqlDatabaseResource +## Column ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database +* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column +* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. -## MongoDBCollectionCreateUpdateProperties +## ConsistencyPolicy ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object -* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## MongoIndex +## ContainerPartitionKey ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options +* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning +* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned -## MongoIndexKeys +## CreateUpdateOptions ### Properties -* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service +### Additional Properties +* **Additional Properties Type**: string -## MongoIndexOptions +## CreateUpdateOptions ### Properties -* **expireAfterSeconds**: int (WriteOnly): Expire after seconds -* **unique**: bool (WriteOnly): Is unique or not +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## MongoDBCollectionResource +## CreateUpdateOptions ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys -* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind +### Additional Properties +* **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ShardKeys +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## ThroughputUpdateProperties +## DatabaseAccountConnectionString ### Properties -* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object -* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **locations**: [Location](#location)[] (Required, WriteOnly): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## SqlContainerCreateUpdateProperties +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. + +## GremlinGraphCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB SQL container +* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string (WriteOnly): The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string (WriteOnly): The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string (WriteOnly): Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic -* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. - -## ExcludedPath +## GremlinGraphResource ### Properties -* **path**: string (WriteOnly): The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. +* **defaultTtl**: int (WriteOnly): Default time to live +* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ## IncludedPath ### Properties @@ -359,71 +355,108 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string (WriteOnly): Indicates the type of index. * **precision**: int (WriteOnly): The precision of the index. -1 is maximum precision. -## CreateUpdateOptions +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool (WriteOnly): Indicates if the indexing policy is automatic +* **excludedPaths**: [ExcludedPath](#excludedpath)[] (WriteOnly): List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[] (WriteOnly): List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string (WriteOnly): Indicates the indexing mode. -## ContainerPartitionKey +## Location ### Properties -* **kind**: 'Hash' | 'Range' | string (WriteOnly): Indicates the kind of algorithm used for partitioning -* **paths**: string[] (WriteOnly): List of paths using which data within the container can be partitioned +* **documentEndpoint**: string (ReadOnly, WriteOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int (WriteOnly): 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. +* **id**: string (ReadOnly, WriteOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool (WriteOnly): Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string (WriteOnly): The name of the region. +* **provisioningState**: string (ReadOnly, WriteOnly): 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. -## SqlContainerResource +## MongoDBCollectionCreateUpdateProperties ### Properties -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. -* **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +* **id**: string (ReadOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (ReadOnly): List of index keys +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required, WriteOnly): Cosmos DB MongoDB collection resource object +* **shardKey**: [ShardKeys](#shardkeys) (ReadOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKeyPolicy +## MongoDBCollectionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **id**: string (Required, WriteOnly): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[] (WriteOnly): List of index keys +* **shardKey**: [ShardKeys](#shardkeys) (WriteOnly): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKey +## MongoIndex ### Properties -* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service +* **key**: [MongoIndexKeys](#mongoindexkeys) (WriteOnly): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions) (WriteOnly): Cosmos DB MongoDB collection index options -## Tags +## MongoIndexKeys +### Properties +* **keys**: string[] (WriteOnly): List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int (WriteOnly): Expire after seconds +* **unique**: bool (WriteOnly): Is unique or not + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SqlContainerCreateUpdateProperties ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (ReadOnly): The conflict resolution policy for the container. * **defaultTtl**: int (ReadOnly): Default time to live -* **id**: string (ReadOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (ReadOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (ReadOnly): Cosmos DB indexing policy * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (ReadOnly): The configuration of the partition key to be used for partitioning data into multiple partitions -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required, WriteOnly): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required, WriteOnly): Cosmos DB SQL container resource object * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (ReadOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GremlinGraphResource +## SqlContainerResource ### Properties * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy) (WriteOnly): The conflict resolution policy for the container. * **defaultTtl**: int (WriteOnly): Default time to live -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Gremlin graph +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy) (WriteOnly): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey) (WriteOnly): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy) (WriteOnly): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +## SqlDatabaseCreateUpdateProperties +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (ReadOnly): Name of the Cosmos DB SQL database +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required, WriteOnly): Cosmos DB SQL database id object + +## SqlDatabaseResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB SQL database + +## TableCreateUpdateProperties +### Properties +* **id**: string (ReadOnly): Name of the Cosmos DB table +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object + +## TableResource +### Properties +* **id**: string (Required, WriteOnly): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -439,21 +472,11 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceCreateUpdateProperties -### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra keyspace -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required, WriteOnly): Cosmos DB Cassandra keyspace id object - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraKeyspaceResource -### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra keyspace - ## Tags ### Properties ### Additional Properties @@ -464,44 +487,15 @@ ### Additional Properties * **Additional Properties Type**: string -## CassandraTableCreateUpdateProperties -### Properties -* **defaultTtl**: int (ReadOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (ReadOnly): Name of the Cosmos DB Cassandra table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required, WriteOnly): Cosmos DB Cassandra table id object -* **schema**: [CassandraSchema](#cassandraschema) (ReadOnly): Cosmos DB Cassandra table schema - -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CassandraTableResource -### Properties -* **defaultTtl**: int (WriteOnly): Time to live of the Cosmos DB Cassandra table -* **id**: string (Required, WriteOnly): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema) (WriteOnly): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[] (WriteOnly): List of cluster key. -* **columns**: [Column](#column)[] (WriteOnly): List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[] (WriteOnly): List of partition key. - -## ClusterKey -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string (WriteOnly): Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" - -## Column -### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table column -* **type**: string (WriteOnly): Type of the Cosmos DB Cassandra table column - -## CassandraPartitionKey +## Tags ### Properties -* **name**: string (WriteOnly): Name of the Cosmos DB Cassandra table partition key +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -513,20 +507,20 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **id**: string (ReadOnly): Name of the Cosmos DB table -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required, WriteOnly): Cosmos DB table id object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **id**: string (Required, WriteOnly): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -538,19 +532,25 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## ThroughputResource ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **throughput**: int (Required, WriteOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountConnectionString +## ThroughputUpdateProperties ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **resource**: [ThroughputResource](#throughputresource) (Required, WriteOnly): Cosmos DB resource throughput object +* **throughput**: int (ReadOnly): Value of the Cosmos DB resource throughput -## DatabaseAccountListKeysResult +## UniqueKey ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **paths**: string[] (WriteOnly): List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[] (WriteOnly): List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2019-08-01/types.md b/generated/cosmos-db/microsoft.documentdb/2019-08-01/types.md index e15de10380..16c9973f56 100644 --- a/generated/cosmos-db/microsoft.documentdb/2019-08-01/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2019-08-01/types.md @@ -267,71 +267,15 @@ * **ApiVersion**: 2019-08-01 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -339,21 +283,21 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraTableResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -363,12 +307,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -379,183 +317,198 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## CompositePath ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsUpdateProperties +## ConsistencyPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ThroughputSettingsResource +## ContainerPartitionKey ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int (Required): Value of the Cosmos DB resource throughput +* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **version**: int: Indicates the version of the partition key definition -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinDatabaseCreateUpdateProperties +## CreateUpdateOptions ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinDatabaseResource +## CreateUpdateOptions ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB Gremlin database +### Additional Properties +* **Additional Properties Type**: string -## Tags +## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## CreateUpdateOptions ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +### Additional Properties +* **Additional Properties Type**: string ## CreateUpdateOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphResource +## CreateUpdateOptions ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string -## ConflictResolutionPolicy +## CreateUpdateOptions ### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. +### Additional Properties +* **Additional Properties Type**: string -## IndexingPolicy +## CreateUpdateOptions ### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics +### Additional Properties +* **Additional Properties Type**: string -## CompositePath +## CreateUpdateOptions ### Properties -* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +### Additional Properties +* **Additional Properties Type**: string -## ExcludedPath +## DatabaseAccountConnectionString ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## IncludedPath +## DatabaseAccountCreateUpdateProperties ### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Indexes +## DatabaseAccountListConnectionStringsResult ### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## SpatialSpec +## DatabaseAccountListKeysResult ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## ContainerPartitionKey +## ExcludedPath ### Properties -* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **version**: int: Indicates the version of the partition key definition +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## UniqueKeyPolicy +## FailoverPolicy ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## UniqueKey +## GremlinDatabaseCreateUpdateProperties ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## Tags +## GremlinDatabaseResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags +## GremlinGraphCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## Tags +## GremlinGraphResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## MongoDBDatabaseCreateUpdateProperties +## IncludedPath ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## CreateUpdateOptions +## Indexes ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## MongoDBDatabaseResource +## IndexingPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## Location ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. ## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -565,6 +518,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -579,41 +544,48 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## SpatialSpec ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type -## NotebookWorkspaceProperties +## SqlContainerCreateUpdateProperties ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object + +## SqlContainerResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB SQL container +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. ## SqlDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## CreateUpdateOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlDatabaseResource ### Properties * **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. @@ -623,55 +595,78 @@ * **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. * **id**: string (Required): Name of the Cosmos DB SQL database -## Tags +## SqlStoredProcedureCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## SqlContainerCreateUpdateProperties +## SqlStoredProcedureResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure + +## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## CreateUpdateOptions +## SqlTriggerResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## SqlContainerResource +## SqlUserDefinedFunctionCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object + +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction + +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB table ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -683,48 +678,40 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -736,22 +723,20 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## CreateUpdateOptions +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -763,24 +748,39 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## ThroughputSettingsResource ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int (Required): Value of the Cosmos DB resource throughput -## DatabaseAccountListKeysResult +## ThroughputSettingsUpdateProperties ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2019-12-12/types.md b/generated/cosmos-db/microsoft.documentdb/2019-12-12/types.md index d8beb4b5c1..00c44604be 100644 --- a/generated/cosmos-db/microsoft.documentdb/2019-12-12/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2019-12-12/types.md @@ -267,73 +267,19 @@ * **ApiVersion**: 2019-12-12 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties +## AutoUpgradePolicyResource ### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **throughput**: string (WriteOnly): Request Units per second. For example, "throughput": "10000". -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -341,10 +287,15 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -360,12 +311,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -376,53 +321,81 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## CompositePath ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsUpdateProperties +## ConsistencyPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or provisionedThroughputSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ThroughputSettingsResource +## ContainerPartitionKey ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **provisionedThroughputSettings**: [ProvisionedThroughputSettingsResource](#provisionedthroughputsettingsresource): Cosmos DB provisioned throughput settings object -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or provisionedThroughputSettings is required, but not both. +* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **version**: int: Indicates the version of the partition key definition -## ProvisionedThroughputSettingsResource +## CreateUpdateOptions ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **throughput**: string (WriteOnly): Request Units per second. For example, "throughput": "10000". +### Additional Properties +* **Additional Properties Type**: string -## AutoUpgradePolicyResource +## DatabaseAccountConnectionString ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputPolicyResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## Tags +## DatabaseAccountListKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -436,11 +409,6 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -458,30 +426,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -493,70 +437,49 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## Location ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. -## MongoDBDatabaseCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## MongoDBDatabaseResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## MongoDBCollectionCreateUpdateProperties +## MongoDBDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## MongoDBCollectionResource +## MongoDBDatabaseResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **id**: string (Required): Name of the Cosmos DB MongoDB database ## MongoIndex ### Properties @@ -572,50 +495,32 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. ## NotebookWorkspaceProperties ### Properties * **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. * **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource +## ProvisionedThroughputSettingsResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -633,10 +538,19 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -651,16 +565,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -676,11 +580,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -694,6 +593,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -704,17 +615,15 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -726,24 +635,115 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **provisionedThroughputSettings**: [ProvisionedThroughputSettingsResource](#provisionedthroughputsettingsresource): Cosmos DB provisioned throughput settings object +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or provisionedThroughputSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or provisionedThroughputSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2020-03-01/types.md b/generated/cosmos-db/microsoft.documentdb/2020-03-01/types.md index ecdd261a43..d48b65412a 100644 --- a/generated/cosmos-db/microsoft.documentdb/2020-03-01/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2020-03-01/types.md @@ -267,96 +267,19 @@ * **ApiVersion**: 2020-03-01 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties +## AutoUpgradePolicyResource ### Properties -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRangeFilter**: 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. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **status**: string (ReadOnly): The private link service connection status. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **throughput**: string: Request Units per second. For example, "throughput": "10000". -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -364,10 +287,15 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -383,12 +311,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -399,53 +321,83 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## CompositePath ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsUpdateProperties +## ConsistencyPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or provisionedThroughputSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ThroughputSettingsResource +## ContainerPartitionKey ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **provisionedThroughputSettings**: [ProvisionedThroughputSettingsResource](#provisionedthroughputsettingsresource): Cosmos DB provisioned throughput settings object -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or provisionedThroughputSettings is required, but not both. +* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **version**: int: Indicates the version of the partition key definition -## ProvisionedThroughputSettingsResource +## CreateUpdateOptions ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **throughput**: string: Request Units per second. For example, "throughput": "10000". +### Additional Properties +* **Additional Properties Type**: string -## AutoUpgradePolicyResource +## DatabaseAccountConnectionString ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## ThroughputPolicyResource +## DatabaseAccountCreateUpdateProperties ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRangeFilter**: 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. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## Tags +## DatabaseAccountListKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -459,11 +411,6 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -481,30 +428,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -516,56 +439,23 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MongoDBDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object - -## MongoDBDatabaseResource +## IndexingPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## Location ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -581,6 +471,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -595,50 +497,53 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## Tags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -## NotebookWorkspaceProperties +## PrivateEndpointProperty ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **id**: string (ReadOnly): Resource id of the private endpoint. -## SqlDatabaseCreateUpdateProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **status**: string (ReadOnly): The private link service connection status. -## SqlDatabaseResource +## ProvisionedThroughputSettingsResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -656,10 +561,19 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -674,16 +588,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -699,11 +603,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -717,6 +616,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -727,17 +638,15 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -749,24 +658,115 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **provisionedThroughputSettings**: [ProvisionedThroughputSettingsResource](#provisionedthroughputsettingsresource): Cosmos DB provisioned throughput settings object +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or provisionedThroughputSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or provisionedThroughputSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2020-04-01/types.md b/generated/cosmos-db/microsoft.documentdb/2020-04-01/types.md index cf9ad677a3..af56094a87 100644 --- a/generated/cosmos-db/microsoft.documentdb/2020-04-01/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2020-04-01/types.md @@ -267,119 +267,33 @@ * **ApiVersion**: 2020-04-01 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **apiProperties**: [ApiProperties](#apiproperties) -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## ApiProperties ### Properties * **serverVersion**: '3.2' | '3.6' | string: Describes the ServerVersion of an a MongoDB account. -## Capability -### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". - -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. - -## PrivateEndpointProperty +## AutoscaleSettings ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## PrivateLinkServiceConnectionStateProperty +## AutoscaleSettingsResource ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **status**: string (ReadOnly): The private link service connection status. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## VirtualNetworkRule +## AutoUpgradePolicyResource ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy -## Tags +## Capability ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -387,10 +301,15 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -407,12 +326,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -423,53 +336,94 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## CompositePath ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsUpdateProperties +## ConsistencyPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ThroughputSettingsResource +## ContainerPartitionKey ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **version**: int: Indicates the version of the partition key definition -## AutoscaleSettingsResource +## CorsPolicy ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## AutoUpgradePolicyResource +## CreateUpdateOptions ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## ThroughputPolicyResource +## DatabaseAccountConnectionString ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiProperties**: [ApiProperties](#apiproperties) +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -483,11 +437,6 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -505,30 +454,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -540,56 +465,27 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MongoDBDatabaseCreateUpdateProperties +## IndexingPolicy ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## MongoDBDatabaseResource +## IpAddressOrRange ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## Tags +## Location ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -606,6 +502,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -620,50 +528,47 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## NotebookWorkspaceProperties +## PrivateEndpointConnectionProperties ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -## SqlDatabaseCreateUpdateProperties +## PrivateEndpointProperty ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **id**: string (ReadOnly): Resource id of the private endpoint. -## SqlDatabaseResource +## PrivateLinkServiceConnectionStateProperty ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -682,10 +587,19 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -700,16 +614,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -725,11 +629,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -743,6 +642,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -753,17 +664,15 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -775,24 +684,115 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2020-06-01-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2020-06-01-preview/types.md index b895898762..f4f0f88076 100644 --- a/generated/cosmos-db/microsoft.documentdb/2020-06-01-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2020-06-01-preview/types.md @@ -308,67 +308,23 @@ * **ApiVersion**: 2020-06-01-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity +## ApiProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **serverVersion**: '3.2' | '3.6' | string: Describes the ServerVersion of an a MongoDB account. -## ManagedServiceIdentityUserAssignedIdentities +## AutoscaleSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettingsResource ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## DatabaseAccountCreateUpdateProperties -* **Discriminator**: createMode - -### Base Properties -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **instanceId**: string (ReadOnly): A unique identifier assigned to the database account -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **restoreParameters**: [RestoreParameters](#restoreparameters) (ReadOnly): Parameters to indicate the information about the restore. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -### DefaultRequestDatabaseAccountCreateUpdateProperties -#### Properties -* **createMode**: 'Default' (Required): Enum to indicate the mode of account creation. - -### RestoreReqeustDatabaseAccountCreateUpdateProperties -#### Properties -* **createMode**: 'Restore' (Required): Enum to indicate the mode of account creation. -* **restoreParameters**: [RestoreParameters](#restoreparameters) (WriteOnly): Parameters to indicate the information about the restore. - +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -384,115 +340,15 @@ * **type**: 'Periodic' (Required): Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **status**: string (ReadOnly): The private link service connection status. - -## RestoreParameters -### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[] (ReadOnly): List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string (ReadOnly): Describes the mode of the restore. -* **restoreSource**: string (ReadOnly): The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string (ReadOnly): Time to which the account has to be restored (ISO-8601 format). - -## DatabaseRestoreResource -### Properties -* **collectionNames**: string[] (ReadOnly): The names of the collections available for restore. -* **databaseName**: string (ReadOnly): The name of the database available for restore. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -500,10 +356,15 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -520,12 +381,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -536,53 +391,118 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## CorsPolicy ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## ThroughputPolicyResource +## CreateUpdateOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties +* **Discriminator**: createMode + +### Base Properties +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **instanceId**: string (ReadOnly): A unique identifier assigned to the database account +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **restoreParameters**: [RestoreParameters](#restoreparameters) (ReadOnly): Parameters to indicate the information about the restore. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +### DefaultRequestDatabaseAccountCreateUpdateProperties +#### Properties +* **createMode**: 'Default' (Required): Enum to indicate the mode of account creation. + +### RestoreReqeustDatabaseAccountCreateUpdateProperties +#### Properties +* **createMode**: 'Restore' (Required): Enum to indicate the mode of account creation. +* **restoreParameters**: [RestoreParameters](#restoreparameters) (WriteOnly): Parameters to indicate the information about the restore. + + +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## DatabaseRestoreResource +### Properties +* **collectionNames**: string[] (ReadOnly): The names of the collections available for restore. +* **databaseName**: string (ReadOnly): The name of the database available for restore. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -596,11 +516,6 @@ * **_ts**: any (ReadOnly): Anything * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -618,11 +533,16 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy +## IncludedPath ### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## Indexes +### Properties +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. ## IndexingPolicy ### Properties @@ -633,184 +553,266 @@ * **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. * **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## CompositePath +## IpAddressOrRange ### Properties -* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## ExcludedPath +## Location ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## IncludedPath +## ManagedServiceIdentity ### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Indexes +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## SpatialSpec +## MongoDBCollectionCreateUpdateProperties ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## ContainerPartitionKey +## MongoDBCollectionResource ### Properties -* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **version**: int: Indicates the version of the partition key definition +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **analyticalStorageTtl**: int: Analytical TTL. +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## UniqueKeyPolicy +## MongoDBDatabaseCreateUpdateProperties ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## UniqueKey +## MongoDBDatabaseResource ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## Tags +## MongoIndex ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## Tags +## MongoIndexKeys +### Properties +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not + +## NotebookWorkspaceConnectionInfoResult +### Properties +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. + +## NotebookWorkspaceProperties +### Properties +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. + +## PeriodicModeProperties +### Properties +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. + +## Permission +### Properties +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **status**: string (ReadOnly): The private link service connection status. + +## RestoreParameters +### Properties +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[] (ReadOnly): List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string (ReadOnly): Describes the mode of the restore. +* **restoreSource**: string (ReadOnly): The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string (ReadOnly): Time to which the account has to be restored (ISO-8601 format). + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## SpatialSpec ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type -## MongoDBDatabaseCreateUpdateProperties +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## MongoDBDatabaseResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB SQL container +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## MongoDBCollectionCreateUpdateProperties +## SqlDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## MongoDBCollectionResource +## SqlDatabaseResource ### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## MongoIndex +## SqlRoleAssignmentResource ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## MongoIndexKeys +## SqlRoleDefinitionResource ### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## MongoIndexOptions +## SqlStoredProcedureCreateUpdateProperties ### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## ShardKeys +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags +## SqlTriggerCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## Tags +## SqlTriggerResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## NotebookWorkspaceProperties +## SqlUserDefinedFunctionResource ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## SqlDatabaseCreateUpdateProperties +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. + +## TableCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## SqlDatabaseResource +## TableResource ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: any (ReadOnly): Anything -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **id**: string (Required): Name of the Cosmos DB table ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -822,38 +824,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required, WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -865,35 +859,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (Required): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: any (ReadOnly): Anything -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -905,24 +894,35 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## ThroughputPolicyResource ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## DatabaseAccountListConnectionStringsResult +## ThroughputSettingsResource ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: any (ReadOnly): Anything +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountConnectionString +## ThroughputSettingsUpdateProperties ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListKeysResult +## UniqueKey ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2020-09-01/types.md b/generated/cosmos-db/microsoft.documentdb/2020-09-01/types.md index 387836a5a8..9ce49db0bb 100644 --- a/generated/cosmos-db/microsoft.documentdb/2020-09-01/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2020-09-01/types.md @@ -267,38 +267,24 @@ * **ApiVersion**: 2020-09-01 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## DatabaseAccountCreateUpdateProperties -### Properties -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. - ## ApiProperties ### Properties * **serverVersion**: '3.2' | '3.6' | string: Describes the ServerVersion of an a MongoDB account. +## AutoscaleSettings +### Properties +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. + +## AutoscaleSettingsResource +### Properties +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + ## BackupPolicy * **Discriminator**: type @@ -313,93 +299,15 @@ * **type**: 'Periodic' (Required): Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **status**: string (ReadOnly): The private link service connection status. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -407,10 +315,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -427,12 +340,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -443,53 +350,95 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## CompositePath ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## Tags +## ConflictResolutionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsUpdateProperties +## ConsistencyPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ThroughputSettingsResource +## ContainerPartitionKey ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **version**: int: Indicates the version of the partition key definition -## AutoscaleSettingsResource +## CorsPolicy ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## AutoUpgradePolicyResource +## CreateUpdateOptions ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## ThroughputPolicyResource +## DatabaseAccountConnectionString ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## Tags +## DatabaseAccountListConnectionStringsResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -503,11 +452,6 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -525,30 +469,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'Ascending' | 'Descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -560,56 +480,27 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'Range' | string: Indicates the kind of algorithm used for partitioning -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MongoDBDatabaseCreateUpdateProperties +## IndexingPolicy ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'Consistent' | 'Lazy' | 'None' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## MongoDBDatabaseResource +## IpAddressOrRange ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## Tags +## Location ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -626,6 +517,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -640,50 +543,52 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PeriodicModeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## NotebookWorkspaceProperties +## PrivateEndpointConnectionProperties ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -## SqlDatabaseCreateUpdateProperties +## PrivateEndpointProperty ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **id**: string (ReadOnly): Resource id of the private endpoint. -## SqlDatabaseResource +## PrivateLinkServiceConnectionStateProperty ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -702,10 +607,19 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -720,16 +634,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -745,11 +649,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -763,6 +662,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -773,17 +684,15 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -795,24 +704,115 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-01-15/types.md b/generated/cosmos-db/microsoft.documentdb/2021-01-15/types.md index 0ffc0583d8..c1eb4962db 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-01-15/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-01-15/types.md @@ -277,56 +277,23 @@ * **ApiVersion**: 2021-01-15 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## ApiProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettings ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## DatabaseAccountCreateUpdateProperties +## AutoscaleSettingsResource ### Properties -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. -* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -342,96 +309,15 @@ * **type**: 'Periodic' (Required): Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -439,10 +325,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -459,12 +350,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -475,53 +360,103 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## CorsPolicy ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## ThroughputPolicyResource +## CreateUpdateOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. +* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. + +## DatabaseAccountListConnectionStringsResult +### Properties +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -535,11 +470,6 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -557,30 +487,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -592,57 +498,39 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## IpAddressOrRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## MongoDBDatabaseCreateUpdateProperties +## Location ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## MongoDBDatabaseResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -659,6 +547,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -673,50 +573,55 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PeriodicModeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## NotebookWorkspaceProperties +## PrivateEndpointConnectionProperties ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## SqlDatabaseCreateUpdateProperties +## PrivateEndpointProperty ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **id**: string (ReadOnly): Resource id of the private endpoint. -## SqlDatabaseResource +## PrivateLinkServiceConnectionStateProperty ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -735,10 +640,19 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -753,16 +667,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -778,11 +682,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -796,6 +695,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -806,17 +717,15 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -828,24 +737,115 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-03-01-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2021-03-01-preview/types.md index 9e924aa0c5..2bb05f55ad 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-03-01-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-03-01-preview/types.md @@ -338,22 +338,87 @@ * **ApiVersion**: 2021-03-01-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity +## ApiProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## ManagedServiceIdentityUserAssignedIdentities +## AutoscaleSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettingsResource ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + +## BackupPolicy +* **Discriminator**: type + +### Base Properties +### ContinuousModeBackupPolicy +#### Properties +* **type**: 'Continuous' (Required): Describes the mode of backups. + +### PeriodicModeBackupPolicy +#### Properties +* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup +* **type**: 'Periodic' (Required): Describes the mode of backups. + + +## Capability +### Properties +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". + +## CassandraKeyspaceCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object + +## CassandraKeyspaceResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace + +## CassandraPartitionKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. + +## CassandraTableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object + +## CassandraTableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table +* **id**: string (Required): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClusterKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ## ClusterResourceProperties ### Properties @@ -373,27 +438,57 @@ * **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. * **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. -## Certificate +## Column ### Properties -* **pem**: string: PEM formatted public key. +* **name**: string: Name of the Cosmos DB Cassandra table column +* **type**: string: Type of the Cosmos DB Cassandra table column -## SeedNode +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **ipAddress**: string: IP address of this seed node. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## DataCenterResourceProperties +## ConflictResolutionPolicy ### Properties -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. + +## ConsistencyPolicy +### Properties +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. + +## ContainerPartitionKey +### Properties +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition + +## CorsPolicy +### Properties +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. + +## CreateUpdateOptions +### Properties +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. + +## DatabaseAccountConnectionString +### Properties +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string ## DatabaseAccountCreateUpdateProperties * **Discriminator**: createMode @@ -438,47 +533,34 @@ * **restoreParameters**: [RestoreParameters](#restoreparameters) (WriteOnly): Parameters to indicate the information about the restore. -## ApiProperties +## DatabaseAccountListConnectionStringsResult ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. - -## BackupPolicy -* **Discriminator**: type - -### Base Properties -### ContinuousModeBackupPolicy -#### Properties -* **type**: 'Continuous' (Required): Describes the mode of backups. - -### PeriodicModeBackupPolicy -#### Properties -* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup -* **type**: 'Periodic' (Required): Describes the mode of backups. - +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## PeriodicModeProperties +## DatabaseAccountListKeysResult ### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## Capability +## DatabaseRestoreResource ### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". +* **collectionNames**: string[] (ReadOnly): The names of the collections available for restore. +* **databaseName**: string (ReadOnly): The name of the database available for restore. -## ConsistencyPolicy +## DataCenterResourceProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. -## CorsPolicy +## ExcludedPath ### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ## FailoverPolicy ### Properties @@ -486,330 +568,295 @@ * **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. * **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## IpAddressOrRange +## GremlinDatabaseCreateUpdateProperties ### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## Location +## GremlinDatabaseResource ### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## PrivateEndpointConnection +## GremlinGraphCreateUpdateProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## PrivateEndpointConnectionProperties +## GremlinGraphResource ### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## PrivateEndpointProperty +## IncludedPath ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## PrivateLinkServiceConnectionStateProperty +## Indexes ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## RestoreParameters +## IndexingPolicy ### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[] (ReadOnly): List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string (ReadOnly): Describes the mode of the restore. -* **restoreSource**: string (ReadOnly): The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string (ReadOnly): Time to which the account has to be restored (ISO-8601 format). +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## DatabaseRestoreResource +## IpAddressOrRange ### Properties -* **collectionNames**: string[] (ReadOnly): The names of the collections available for restore. -* **databaseName**: string (ReadOnly): The name of the database available for restore. +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## VirtualNetworkRule +## Location ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## SystemData +## ManagedServiceIdentity ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## CassandraKeyspaceCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object - -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CassandraKeyspaceResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **analyticalStorageTtl**: int: Analytical TTL. +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## CassandraTableCreateUpdateProperties +## MongoDBDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## CassandraTableResource +## MongoDBDatabaseResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table -* **id**: string (Required): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## ClusterKey +## MongoIndex ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## Column +## MongoIndexKeys ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table column -* **type**: string: Type of the Cosmos DB Cassandra table column +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service -## CassandraPartitionKey +## MongoIndexOptions ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not -## Tags +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## ThroughputSettingsUpdateProperties +## NotebookWorkspaceProperties ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## ThroughputSettingsResource +## PeriodicModeProperties ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## AutoscaleSettingsResource +## Permission ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## AutoUpgradePolicyResource +## PrivateEndpointConnection ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ThroughputPolicyResource +## PrivateEndpointConnectionProperties ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## Tags +## PrivateEndpointProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## GremlinDatabaseCreateUpdateProperties +## RestoreParameters ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[] (ReadOnly): List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string (ReadOnly): Describes the mode of the restore. +* **restoreSource**: string (ReadOnly): The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string (ReadOnly): Time to which the account has to be restored (ISO-8601 format). -## GremlinDatabaseResource +## SeedNode ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Gremlin database +* **ipAddress**: string: IP address of this seed node. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## GremlinGraphResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. * **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **id**: string (Required): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## IncludedPath -### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## Indexes -### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. - -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey +## SqlDatabaseCreateUpdateProperties ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## UniqueKeyPolicy +## SqlDatabaseResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## UniqueKey +## SqlRoleAssignmentResource ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## Tags +## SqlRoleDefinitionResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## Tags +## SqlStoredProcedureCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## Tags +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## MongoDBDatabaseCreateUpdateProperties +## SqlTriggerCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## MongoDBDatabaseResource +## SqlTriggerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBCollectionCreateUpdateProperties +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## MongoDBCollectionResource +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## MongoIndex +## SystemData ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoIndexKeys +## TableCreateUpdateProperties ### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoIndexOptions +## TableResource ### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -829,65 +876,40 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceProperties -### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. - -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource +## Tags ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -899,38 +921,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -942,64 +956,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-03-15/types.md b/generated/cosmos-db/microsoft.documentdb/2021-03-15/types.md index 55a20fb8be..9907a465c8 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-03-15/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-03-15/types.md @@ -277,57 +277,23 @@ * **ApiVersion**: 2021-03-15 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## ApiProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettings ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## DatabaseAccountCreateUpdateProperties +## AutoscaleSettingsResource ### Properties -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. -* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -343,96 +309,15 @@ * **type**: 'Periodic' (Required): Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -440,10 +325,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -460,12 +350,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -476,53 +360,104 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## CorsPolicy ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## ThroughputPolicyResource +## CreateUpdateOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. +* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. + +## DatabaseAccountListConnectionStringsResult +### Properties +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -536,11 +471,6 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -558,30 +488,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -593,57 +499,39 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## IpAddressOrRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## MongoDBDatabaseCreateUpdateProperties +## Location ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## MongoDBDatabaseResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -660,6 +548,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -674,50 +574,55 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PeriodicModeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## NotebookWorkspaceProperties +## PrivateEndpointConnectionProperties ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## SqlDatabaseCreateUpdateProperties +## PrivateEndpointProperty ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **id**: string (ReadOnly): Resource id of the private endpoint. -## SqlDatabaseResource +## PrivateLinkServiceConnectionStateProperty ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -736,10 +641,19 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -754,16 +668,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -779,11 +683,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -797,6 +696,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -807,17 +718,15 @@ ### Additional Properties * **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -829,24 +738,115 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-04-01-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2021-04-01-preview/types.md index 47338224d7..39a305f1e0 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-04-01-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-04-01-preview/types.md @@ -347,22 +347,87 @@ * **ApiVersion**: 2021-04-01-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity +## ApiProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## ManagedServiceIdentityUserAssignedIdentities +## AutoscaleSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettingsResource ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + +## BackupPolicy +* **Discriminator**: type + +### Base Properties +### ContinuousModeBackupPolicy +#### Properties +* **type**: 'Continuous' (Required): Describes the mode of backups. + +### PeriodicModeBackupPolicy +#### Properties +* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup +* **type**: 'Periodic' (Required): Describes the mode of backups. + + +## Capability +### Properties +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". + +## CassandraKeyspaceCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object + +## CassandraKeyspaceResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace + +## CassandraPartitionKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. + +## CassandraTableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object + +## CassandraTableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table +* **id**: string (Required): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClusterKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ## ClusterResourceProperties ### Properties @@ -382,27 +447,57 @@ * **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. * **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. -## Certificate +## Column ### Properties -* **pem**: string: PEM formatted public key. +* **name**: string: Name of the Cosmos DB Cassandra table column +* **type**: string: Type of the Cosmos DB Cassandra table column -## SeedNode +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **ipAddress**: string: IP address of this seed node. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## DataCenterResourceProperties +## ConflictResolutionPolicy ### Properties -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. + +## ConsistencyPolicy +### Properties +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. + +## ContainerPartitionKey +### Properties +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition + +## CorsPolicy +### Properties +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. + +## CreateUpdateOptions +### Properties +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. + +## DatabaseAccountConnectionString +### Properties +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string ## DatabaseAccountCreateUpdateProperties * **Discriminator**: createMode @@ -448,47 +543,34 @@ * **restoreParameters**: [RestoreParameters](#restoreparameters) (WriteOnly): Parameters to indicate the information about the restore. -## ApiProperties +## DatabaseAccountListConnectionStringsResult ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. - -## BackupPolicy -* **Discriminator**: type - -### Base Properties -### ContinuousModeBackupPolicy -#### Properties -* **type**: 'Continuous' (Required): Describes the mode of backups. - -### PeriodicModeBackupPolicy -#### Properties -* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup -* **type**: 'Periodic' (Required): Describes the mode of backups. - +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## PeriodicModeProperties +## DatabaseAccountListKeysResult ### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## Capability +## DatabaseRestoreResource ### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". +* **collectionNames**: string[] (ReadOnly): The names of the collections available for restore. +* **databaseName**: string (ReadOnly): The name of the database available for restore. -## ConsistencyPolicy +## DataCenterResourceProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. -## CorsPolicy +## ExcludedPath ### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ## FailoverPolicy ### Properties @@ -496,330 +578,304 @@ * **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. * **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## IpAddressOrRange +## GremlinDatabaseCreateUpdateProperties ### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## Location +## GremlinDatabaseResource ### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## PrivateEndpointConnection +## GremlinGraphCreateUpdateProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## PrivateEndpointConnectionProperties +## GremlinGraphResource ### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## PrivateEndpointProperty +## IncludedPath ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## PrivateLinkServiceConnectionStateProperty +## Indexes ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## RestoreParameters +## IndexingPolicy ### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[] (ReadOnly): List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string (ReadOnly): Describes the mode of the restore. -* **restoreSource**: string (ReadOnly): The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string (ReadOnly): Time to which the account has to be restored (ISO-8601 format). +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## DatabaseRestoreResource +## IpAddressOrRange ### Properties -* **collectionNames**: string[] (ReadOnly): The names of the collections available for restore. -* **databaseName**: string (ReadOnly): The name of the database available for restore. +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## VirtualNetworkRule +## Location ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## SystemData +## ManagedServiceIdentity ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## CassandraKeyspaceCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object - -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CassandraKeyspaceResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **analyticalStorageTtl**: int: Analytical TTL. +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## CassandraTableCreateUpdateProperties +## MongoDBDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## CassandraTableResource +## MongoDBDatabaseResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table -* **id**: string (Required): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## CassandraSchema +## MongoIndex ### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## ClusterKey +## MongoIndexKeys ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service -## Column +## MongoIndexOptions ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table column -* **type**: string: Type of the Cosmos DB Cassandra table column +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not -## CassandraPartitionKey +## NotebookWorkspaceConnectionInfoResult ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## ThroughputSettingsUpdateProperties +## PeriodicModeProperties ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## ThroughputSettingsResource +## Permission ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## AutoscaleSettingsResource +## PrivateEndpointConnection ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## AutoUpgradePolicyResource +## PrivateEndpointConnectionProperties ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## ThroughputPolicyResource +## PrivateEndpointProperty ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## RestoreParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[] (ReadOnly): List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string (ReadOnly): Describes the mode of the restore. +* **restoreSource**: string (ReadOnly): The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string (ReadOnly): Time to which the account has to be restored (ISO-8601 format). -## GremlinDatabaseCreateUpdateProperties +## SeedNode ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object +* **ipAddress**: string: IP address of this seed node. -## GremlinDatabaseResource +## ServiceResourceCreateUpdateProperties ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Gremlin database +* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). +* **instanceCount**: int: Instance count for the service. +* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. +* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. +### Additional Properties +* **Additional Properties Type**: any -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## GremlinGraphResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. * **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **id**: string (Required): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## IncludedPath -### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## Indexes -### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. - -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey +## SqlDatabaseCreateUpdateProperties ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## Tags +## SqlDatabaseResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## Tags +## SqlRoleAssignmentResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## Tags +## SqlRoleDefinitionResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## MongoDBDatabaseCreateUpdateProperties +## SqlStoredProcedureCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## MongoDBDatabaseResource +## SqlStoredProcedureResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags +## SqlTriggerCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## MongoDBCollectionCreateUpdateProperties +## SqlTriggerResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBCollectionResource +## SqlUserDefinedFunctionCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object + +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## MongoIndex +## SystemData ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoIndexKeys +## TableCreateUpdateProperties ### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoIndexOptions +## TableResource ### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -839,74 +895,40 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceProperties -### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. - -## ServiceResourceCreateUpdateProperties +## Tags ### Properties -* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). -* **instanceCount**: int: Instance count for the service. -* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. -* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. ### Additional Properties -* **Additional Properties Type**: any - -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource -### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -918,38 +940,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -961,64 +975,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-04-15/types.md b/generated/cosmos-db/microsoft.documentdb/2021-04-15/types.md index 9011f3d4fb..73c272a604 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-04-15/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-04-15/types.md @@ -295,57 +295,23 @@ * **ApiVersion**: 2021-04-15 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## ApiProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettings ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## DatabaseAccountCreateUpdateProperties +## AutoscaleSettingsResource ### Properties -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. -* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -361,96 +327,15 @@ * **type**: 'Periodic' (Required): Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -458,10 +343,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -478,12 +368,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -494,53 +378,104 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## CorsPolicy ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## ThroughputPolicyResource +## CreateUpdateOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. +* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. + +## DatabaseAccountListConnectionStringsResult +### Properties +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -554,11 +489,6 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -576,30 +506,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -611,57 +517,39 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## IpAddressOrRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## MongoDBDatabaseCreateUpdateProperties +## Location ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## MongoDBDatabaseResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -678,6 +566,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -692,50 +592,60 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PeriodicModeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -## Tags +## Permission ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## NotebookWorkspaceProperties +## PrivateEndpointConnection ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## SqlDatabaseCreateUpdateProperties +## PrivateEndpointConnectionProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## SqlDatabaseResource +## PrivateEndpointProperty ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -754,10 +664,32 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database + +## SqlRoleAssignmentResource +### Properties +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. + +## SqlRoleDefinitionResource +### Properties +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -772,16 +704,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -797,11 +719,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -815,6 +732,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -825,35 +754,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -865,24 +789,100 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-05-15/types.md b/generated/cosmos-db/microsoft.documentdb/2021-05-15/types.md index c15f02b8fd..acfe08de86 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-05-15/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-05-15/types.md @@ -295,62 +295,27 @@ * **ApiVersion**: 2021-05-15 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AnalyticalStorageConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## ApiProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## DatabaseAccountCreateUpdateProperties +## AutoscaleSettings ### Properties -* **analyticalStorageConfiguration**: [AnalyticalStorageConfiguration](#analyticalstorageconfiguration): Analytical storage specific properties. -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. -* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## AnalyticalStorageConfiguration +## AutoscaleSettingsResource ### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -366,96 +331,15 @@ * **type**: 'Periodic' (Required): Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -463,10 +347,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -483,12 +372,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -499,53 +382,105 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## CorsPolicy ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## ThroughputPolicyResource +## CreateUpdateOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **analyticalStorageConfiguration**: [AnalyticalStorageConfiguration](#analyticalstorageconfiguration): Analytical storage specific properties. +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. +* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. + +## DatabaseAccountListConnectionStringsResult +### Properties +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -559,11 +494,6 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -581,30 +511,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -616,57 +522,39 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey -### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition - -## UniqueKeyPolicy -### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. - -## UniqueKey -### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags +## IndexingPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## IpAddressOrRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## MongoDBDatabaseCreateUpdateProperties +## Location ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## MongoDBDatabaseResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) ## MongoDBCollectionCreateUpdateProperties ### Properties @@ -683,6 +571,18 @@ * **indexes**: [MongoIndex](#mongoindex)[]: List of index keys * **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database + ## MongoIndex ### Properties * **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object @@ -697,50 +597,60 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## Tags +## PeriodicModeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -## Tags +## Permission ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## NotebookWorkspaceProperties +## PrivateEndpointConnection ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## SqlDatabaseCreateUpdateProperties +## PrivateEndpointConnectionProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## SqlDatabaseResource +## PrivateEndpointProperty ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. + +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + ## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -759,10 +669,32 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## Tags +## SqlDatabaseCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object + +## SqlDatabaseResource +### Properties +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database + +## SqlRoleAssignmentResource +### Properties +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. + +## SqlRoleDefinitionResource +### Properties +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -777,16 +709,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -802,11 +724,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -820,6 +737,18 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -830,35 +759,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -870,24 +794,100 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-06-15/types.md b/generated/cosmos-db/microsoft.documentdb/2021-06-15/types.md index 89b2a37a5f..e632493a12 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-06-15/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-06-15/types.md @@ -296,66 +296,27 @@ * **ApiVersion**: 2021-06-15 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AnalyticalStorageConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## ApiProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## DatabaseAccountCreateUpdateProperties +## AutoscaleSettings ### Properties -* **analyticalStorageConfiguration**: [AnalyticalStorageConfiguration](#analyticalstorageconfiguration): Analytical storage specific properties. -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **createMode**: 'Default' | 'Restore' | string: Enum to indicate the mode of account creation. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **disableLocalAuth**: bool: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **instanceId**: string (ReadOnly): A unique identifier assigned to the database account -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. -* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **restoreParameters**: [RestoreParameters](#restoreparameters): Parameters to indicate the information about the restore. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## AnalyticalStorageConfiguration +## AutoscaleSettingsResource ### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -378,117 +339,15 @@ * **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. * **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. - -## RestoreParameters -### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. -* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). - -## DatabaseRestoreResource -### Properties -* **collectionNames**: string[]: The names of the collections available for restore. -* **databaseName**: string: The name of the database available for restore. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -496,10 +355,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -516,12 +380,6 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key @@ -532,53 +390,114 @@ * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## CorsPolicy ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## ThroughputPolicyResource +## CreateUpdateOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## Tags +## DatabaseAccountCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **analyticalStorageConfiguration**: [AnalyticalStorageConfiguration](#analyticalstorageconfiguration): Analytical storage specific properties. +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **createMode**: 'Default' | 'Restore' | string: Enum to indicate the mode of account creation. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **disableLocalAuth**: bool: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **instanceId**: string (ReadOnly): A unique identifier assigned to the database account +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. +* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **restoreParameters**: [RestoreParameters](#restoreparameters): Parameters to indicate the information about the restore. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. + +## DatabaseAccountListConnectionStringsResult +### Properties +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. + +## DatabaseAccountListKeysResult +### Properties +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. + +## DatabaseRestoreResource +### Properties +* **collectionNames**: string[]: The names of the collections available for restore. +* **databaseName**: string: The name of the database available for restore. + +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -592,11 +511,6 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GremlinGraphCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -614,11 +528,16 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy +## IncludedPath ### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## Indexes +### Properties +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. ## IndexingPolicy ### Properties @@ -629,108 +548,241 @@ * **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. * **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## CompositePath +## IpAddressOrRange ### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## ExcludedPath +## Location ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## IncludedPath +## ManagedServiceIdentity ### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Indexes +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) + +## MongoDBCollectionCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object + +## MongoDBCollectionResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind + +## MongoDBDatabaseCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object + +## MongoDBDatabaseResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database + +## MongoIndex +### Properties +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options + +## MongoIndexKeys +### Properties +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service + +## MongoIndexOptions +### Properties +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not + +## NotebookWorkspaceConnectionInfoResult +### Properties +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. + +## NotebookWorkspaceProperties +### Properties +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. + +## PeriodicModeProperties +### Properties +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained + +## Permission +### Properties +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. + +## RestoreParameters +### Properties +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. +* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). + +## ShardKeys +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SpatialSpec ### Properties * **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) * **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type -## ContainerPartitionKey +## SqlContainerCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object + +## SqlContainerResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB SQL container +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. + +## SqlDatabaseCreateUpdateProperties ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## UniqueKeyPolicy +## SqlDatabaseResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## UniqueKey +## SqlRoleAssignmentResource ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## Tags +## SqlRoleDefinitionResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## Tags +## SqlStoredProcedureCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## Tags +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## MongoDBDatabaseCreateUpdateProperties +## SqlTriggerCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## MongoDBDatabaseResource +## SqlTriggerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBCollectionCreateUpdateProperties +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## MongoDBCollectionResource +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## MongoIndex +## SystemData ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoIndexKeys +## TableCreateUpdateProperties ### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoIndexOptions +## TableResource ### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -750,65 +802,35 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceProperties -### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. - -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource -### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database - ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -820,38 +842,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -863,64 +877,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-07-01-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2021-07-01-preview/types.md index 8ed09adfee..2ccf820ed2 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-07-01-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-07-01-preview/types.md @@ -383,22 +383,111 @@ * **ApiVersion**: 2021-07-01-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedServiceIdentity +## AnalyticalStorageConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. -## ManagedServiceIdentityUserAssignedIdentities +## ApiProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoscaleSettings ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. + +## AutoscaleSettingsResource +### Properties +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + +## BackupPolicy +* **Discriminator**: type + +### Base Properties +* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. +### ContinuousModeBackupPolicy +#### Properties +* **type**: 'Continuous' (Required): Describes the mode of backups. + +### PeriodicModeBackupPolicy +#### Properties +* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup +* **type**: 'Periodic' (Required): Describes the mode of backups. + + +## BackupPolicyMigrationState +### Properties +* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). +* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. +* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. + +## Capability +### Properties +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". + +## CassandraKeyspaceCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object + +## CassandraKeyspaceResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace + +## CassandraPartitionKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. + +## CassandraTableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object + +## CassandraTableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table +* **id**: string (Required): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema + +## CassandraViewCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object + +## CassandraViewResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra view +* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClusterKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ## ClusterResourceProperties ### Properties @@ -418,27 +507,57 @@ * **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. * **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. -## Certificate +## Column ### Properties -* **pem**: string: PEM formatted public key. +* **name**: string: Name of the Cosmos DB Cassandra table column +* **type**: string: Type of the Cosmos DB Cassandra table column -## SeedNode +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **ipAddress**: string: IP address of this seed node. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## DataCenterResourceProperties +## ConflictResolutionPolicy ### Properties -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. + +## ConsistencyPolicy +### Properties +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. + +## ContainerPartitionKey +### Properties +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition + +## CorsPolicy +### Properties +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. + +## CreateUpdateOptions +### Properties +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. + +## DatabaseAccountConnectionString +### Properties +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string ## DatabaseAccountCreateUpdateProperties ### Properties @@ -477,430 +596,352 @@ * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. * **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## AnalyticalStorageConfiguration -### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. - -## ApiProperties -### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. - -## BackupPolicy -* **Discriminator**: type - -### Base Properties -* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. -### ContinuousModeBackupPolicy -#### Properties -* **type**: 'Continuous' (Required): Describes the mode of backups. - -### PeriodicModeBackupPolicy -#### Properties -* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup -* **type**: 'Periodic' (Required): Describes the mode of backups. - - -## BackupPolicyMigrationState -### Properties -* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). -* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. -* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. - -## PeriodicModeProperties +## DatabaseAccountListConnectionStringsResult ### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## Capability +## DatabaseAccountListKeysResult ### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## ConsistencyPolicy +## DatabaseRestoreResource ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **collectionNames**: string[]: The names of the collections available for restore. +* **databaseName**: string: The name of the database available for restore. -## CorsPolicy +## DataCenterResourceProperties ### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. ## DiagnosticLogSettings ### Properties * **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. +## ExcludedPath +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + ## FailoverPolicy ### Properties * **failoverPriority**: int (ReadOnly): 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. * **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. * **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## IpAddressOrRange +## GraphResource ### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. +* **id**: string (Required): Name of the Cosmos DB Graph -## Location +## GraphResourceCreateUpdateProperties ### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object -## PrivateEndpointConnection +## GremlinDatabaseCreateUpdateProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## RestoreParameters +## GremlinDatabaseResource ### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. -* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## DatabaseRestoreResource +## GremlinGraphCreateUpdateProperties ### Properties -* **collectionNames**: string[]: The names of the collections available for restore. -* **databaseName**: string: The name of the database available for restore. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## VirtualNetworkRule +## GremlinGraphResource ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## SystemData +## IncludedPath ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## Tags +## Indexes ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## CassandraKeyspaceCreateUpdateProperties +## IndexingPolicy ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## CreateUpdateOptions +## IpAddressOrRange ### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## AutoscaleSettings +## Location ### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## CassandraKeyspaceResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## CassandraTableCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CassandraTableResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **analyticalStorageTtl**: int: Analytical TTL. -* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table -* **id**: string (Required): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. - -## ClusterKey -### Properties -* **name**: string: Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" - -## Column -### Properties -* **name**: string: Name of the Cosmos DB Cassandra table column -* **type**: string: Type of the Cosmos DB Cassandra table column - -## CassandraPartitionKey -### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## ThroughputSettingsUpdateProperties +## MongoDBDatabaseCreateUpdateProperties ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## ThroughputSettingsResource +## MongoDBDatabaseResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## AutoscaleSettingsResource +## MongoIndex ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## AutoUpgradePolicyResource +## MongoIndexKeys ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service -## ThroughputPolicyResource +## MongoIndexOptions ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not -## Tags +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## Tags +## NotebookWorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## CassandraViewCreateUpdateProperties +## PeriodicModeProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## CassandraViewResource +## Permission ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra view -* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## Tags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## GraphResourceCreateUpdateProperties +## PrivateEndpointProperty ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object +* **id**: string (ReadOnly): Resource id of the private endpoint. -## GraphResource +## PrivateLinkServiceConnectionStateProperty ### Properties -* **id**: string (Required): Name of the Cosmos DB Graph +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## RestoreParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. +* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). -## GremlinDatabaseCreateUpdateProperties +## SeedNode ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object +* **ipAddress**: string: IP address of this seed node. -## GremlinDatabaseResource +## ServiceResourceCreateUpdateProperties ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Gremlin database +* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). +* **instanceCount**: int: Instance count for the service. +* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. +* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. +### Additional Properties +* **Additional Properties Type**: any -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## GremlinGraphResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. * **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **id**: string (Required): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## IncludedPath -### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## Indexes -### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. - -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey +## SqlDatabaseCreateUpdateProperties ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## UniqueKeyPolicy +## SqlDatabaseResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## UniqueKey +## SqlRoleAssignmentResource ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## Tags +## SqlRoleDefinitionResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## Tags +## SqlStoredProcedureCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## Tags +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## MongoDBDatabaseCreateUpdateProperties +## SqlTriggerCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## MongoDBDatabaseResource +## SqlTriggerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBCollectionCreateUpdateProperties +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## MongoDBCollectionResource +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## MongoIndex +## SystemData ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoIndexKeys +## TableCreateUpdateProperties ### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoIndexOptions +## TableResource ### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -920,74 +961,55 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceProperties +## Tags ### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. +### Additional Properties +* **Additional Properties Type**: string -## ServiceResourceCreateUpdateProperties +## Tags ### Properties -* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). -* **instanceCount**: int: Instance count for the service. -* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. -* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string -## SqlDatabaseCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlDatabaseResource +## Tags ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -999,38 +1021,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -1042,64 +1056,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-10-15-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2021-10-15-preview/types.md index 7f6ed7b154..6ff0327add 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-10-15-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-10-15-preview/types.md @@ -419,11 +419,139 @@ * **ApiVersion**: 2021-10-15-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedCassandraManagedServiceIdentity +## AnalyticalStorageConfiguration ### Properties -* **principalId**: string (ReadOnly): The object id of the identity resource. -* **tenantId**: string (ReadOnly): The tenant id of the resource. -* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. + +## ApiProperties +### Properties +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. + +## AuthenticationMethodLdapProperties +### Properties +* **searchBaseDistinguishedName**: string: Distinguished name of the object to start the recursive search of users from. +* **searchFilterTemplate**: string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. +* **serverCertificates**: [Certificate](#certificate)[]: Array of Certificate +* **serverHostname**: string: Hostname of the LDAP server. +* **serverPort**: int: Port of the LDAP server. +* **serviceUserDistinguishedName**: string: Distinguished name of the look up user account, who can look up user details on authentication. +* **serviceUserPassword**: string: Password of the look up user. + +## AutoscaleSettings +### Properties +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. + +## AutoscaleSettingsResource +### Properties +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + +## BackupPolicy +* **Discriminator**: type + +### Base Properties +* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. +### ContinuousModeBackupPolicy +#### Properties +* **type**: 'Continuous' (Required): Describes the mode of backups. + +### PeriodicModeBackupPolicy +#### Properties +* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup +* **type**: 'Periodic' (Required): Describes the mode of backups. + + +## BackupPolicyMigrationState +### Properties +* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). +* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. +* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. + +## Capability +### Properties +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". + +## Capacity +### Properties +* **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. + +## CassandraKeyspaceCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object + +## CassandraKeyspaceResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace + +## CassandraPartitionKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. + +## CassandraTableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object + +## CassandraTableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table +* **id**: string (Required): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema + +## CassandraViewCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object + +## CassandraViewResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra view +* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClientEncryptionKeyCreateUpdateProperties +### Properties +* **resource**: [ClientEncryptionKeyResource](#clientencryptionkeyresource) (Required): Cosmos DB client encryption key resource object. + +## ClientEncryptionKeyResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **encryptionAlgorithm**: string: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. +* **id**: string: Name of the ClientEncryptionKey +* **keyWrapMetadata**: [KeyWrapMetadata](#keywrapmetadata): Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. +* **wrappedDataEncryptionKey**: any: Wrapped (encrypted) form of the key represented as a byte array. + +## ClusterKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ## ClusterResourceProperties ### Properties @@ -445,61 +573,57 @@ * **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. * **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. -## Certificate +## Column ### Properties -* **pem**: string: PEM formatted public key. +* **name**: string: Name of the Cosmos DB Cassandra table column +* **type**: string: Type of the Cosmos DB Cassandra table column -## SeedNode +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **ipAddress**: string: IP address of this seed node. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## DataCenterResourceProperties +## ConflictResolutionPolicy ### Properties -* **authenticationMethodLdapProperties**: [AuthenticationMethodLdapProperties](#authenticationmethodldapproperties): Ldap authentication method properties. This feature is in preview. -* **availabilityZone**: bool: If the data center has Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. -* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. -* **diskSku**: string: Disk SKU used for data centers. Default value is P30. -* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. -* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## AuthenticationMethodLdapProperties +## ConsistencyPolicy ### Properties -* **searchBaseDistinguishedName**: string: Distinguished name of the object to start the recursive search of users from. -* **searchFilterTemplate**: string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. -* **serverCertificates**: [Certificate](#certificate)[]: Array of Certificate -* **serverHostname**: string: Hostname of the LDAP server. -* **serverPort**: int: Port of the LDAP server. -* **serviceUserDistinguishedName**: string: Distinguished name of the look up user account, who can look up user details on authentication. -* **serviceUserPassword**: string: Password of the look up user. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ManagedServiceIdentity +## ContainerPartitionKey ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## ManagedServiceIdentityUserAssignedIdentities +## CorsPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## CreateUpdateOptions ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. + +## DatabaseAccountConnectionString +### Properties +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string ## DatabaseAccountCreateUpdateProperties ### Properties @@ -539,66 +663,78 @@ * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. * **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## AnalyticalStorageConfiguration +## DatabaseAccountListConnectionStringsResult ### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## ApiProperties +## DatabaseAccountListKeysResult ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## BackupPolicy -* **Discriminator**: type +## DatabaseRestoreResource +### Properties +* **collectionNames**: string[]: The names of the collections available for restore. +* **databaseName**: string: The name of the database available for restore. + +## DataCenterResourceProperties +### Properties +* **authenticationMethodLdapProperties**: [AuthenticationMethodLdapProperties](#authenticationmethodldapproperties): Ldap authentication method properties. This feature is in preview. +* **availabilityZone**: bool: If the data center has Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. +* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. +* **diskSku**: string: Disk SKU used for data centers. Default value is P30. +* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 + +## DataTransferDataSourceSink +* **Discriminator**: component ### Base Properties -* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. -### ContinuousModeBackupPolicy +### AzureBlobDataTransferDataSourceSink #### Properties -* **type**: 'Continuous' (Required): Describes the mode of backups. +* **component**: 'AzureBlobStorage' (Required) +* **containerName**: string (Required) +* **endpointUrl**: string -### PeriodicModeBackupPolicy +### CosmosCassandraDataTransferDataSourceSink #### Properties -* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup -* **type**: 'Periodic' (Required): Describes the mode of backups. - - -## BackupPolicyMigrationState -### Properties -* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). -* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. -* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. - -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. +* **component**: 'CosmosDBCassandra' (Required) +* **keyspaceName**: string (Required) +* **tableName**: string (Required) -## Capability -### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## Capacity +## DataTransferJobProperties ### Properties -* **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. +* **destination**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error Response. +* **jobName**: string (ReadOnly): Job Name +* **lastUpdatedUtcTime**: string (ReadOnly): Last Updated Time (ISO-8601 format). +* **percentageComplete**: int (ReadOnly): Percentage of completion. +* **source**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink +* **status**: string (ReadOnly): Job Status +* **workerCount**: int: Worker count -## ConsistencyPolicy +## DiagnosticLogSettings ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. -## CorsPolicy +## ErrorResponse ### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. +* **code**: string: Error code. +* **message**: string: Error message indicating why the operation failed. -## DiagnosticLogSettings +## ExcludedPath ### Properties -* **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ## FailoverPolicy ### Properties @@ -606,400 +742,357 @@ * **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. * **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location +## GraphResource ### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **id**: string (Required): Name of the Cosmos DB Graph -## PrivateEndpointConnection +## GraphResourceCreateUpdateProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object -## PrivateEndpointConnectionProperties +## GremlinDatabaseCreateUpdateProperties ### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## PrivateEndpointProperty +## GremlinDatabaseResource ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## PrivateLinkServiceConnectionStateProperty +## GremlinGraphCreateUpdateProperties ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## RestoreParameters +## GremlinGraphResource ### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. -* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## DatabaseRestoreResource +## IncludedPath ### Properties -* **collectionNames**: string[]: The names of the collections available for restore. -* **databaseName**: string: The name of the database available for restore. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## VirtualNetworkRule +## Indexes ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## SystemData +## IndexingPolicy ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## IpAddressOrRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## CassandraKeyspaceCreateUpdateProperties +## KeyWrapMetadata ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object +* **name**: string: The name of associated KeyEncryptionKey (aka CustomerManagedKey). +* **type**: string: ProviderName of KeyStoreProvider. +* **value**: string: Reference / link to the KeyEncryptionKey. -## CreateUpdateOptions +## Location ### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## AutoscaleSettings +## ManagedCassandraManagedServiceIdentity ### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. +* **principalId**: string (ReadOnly): The object id of the identity resource. +* **tenantId**: string (ReadOnly): The tenant id of the resource. +* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. -## CassandraKeyspaceResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## CassandraTableCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CassandraTableResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **analyticalStorageTtl**: int: Analytical TTL. -* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table -* **id**: string (Required): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## CassandraSchema +## MongoDBDatabaseCreateUpdateProperties ### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## ClusterKey +## MongoDBDatabaseResource ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## Column +## MongoIndex ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table column -* **type**: string: Type of the Cosmos DB Cassandra table column +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## CassandraPartitionKey +## MongoIndexKeys ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service -## Tags +## MongoIndexOptions ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not -## ThroughputSettingsUpdateProperties +## MongoRoleDefinitionResource ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **databaseName**: string: The database name for which access is being granted for this Role Definition. +* **privileges**: [Privilege](#privilege)[]: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **roles**: [Role](#role)[]: The set of roles inherited by this Role Definition. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## ThroughputSettingsResource +## MongoUserDefinitionResource ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **customData**: string: A custom definition for the USer Definition. +* **databaseName**: string: The database name for which access is being granted for this User Definition. +* **mechanisms**: string: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. +* **password**: string: The password for User Definition. Response does not contain user password. +* **roles**: [Role](#role)[]: The set of roles inherited by the User Definition. +* **userName**: string: The user name for User Definition. -## AutoscaleSettingsResource +## NotebookWorkspaceConnectionInfoResult ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## AutoUpgradePolicyResource +## NotebookWorkspaceProperties ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## ThroughputPolicyResource +## PeriodicModeProperties ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## Tags +## Permission ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## CassandraViewCreateUpdateProperties +## PrivateEndpointConnectionProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## CassandraViewResource +## PrivateEndpointProperty ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra view -* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## Privilege ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: string[]: An array of actions that are allowed. +* **resource**: [PrivilegeResource](#privilegeresource): An Azure Cosmos DB Mongo DB Resource. -## DataTransferJobProperties +## PrivilegeResource ### Properties -* **destination**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error Response. -* **jobName**: string (ReadOnly): Job Name -* **lastUpdatedUtcTime**: string (ReadOnly): Last Updated Time (ISO-8601 format). -* **percentageComplete**: int (ReadOnly): Percentage of completion. -* **source**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink -* **status**: string (ReadOnly): Job Status -* **workerCount**: int: Worker count - -## DataTransferDataSourceSink -* **Discriminator**: component - -### Base Properties -### AzureBlobDataTransferDataSourceSink -#### Properties -* **component**: 'AzureBlobStorage' (Required) -* **containerName**: string (Required) -* **endpointUrl**: string - -### CosmosCassandraDataTransferDataSourceSink -#### Properties -* **component**: 'CosmosDBCassandra' (Required) -* **keyspaceName**: string (Required) -* **tableName**: string (Required) - +* **collection**: string: The collection name the role is applied. +* **db**: string: The database name the role is applied. -## ErrorResponse +## RestoreParameters ### Properties -* **code**: string: Error code. -* **message**: string: Error message indicating why the operation failed. +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. +* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). -## GraphResourceCreateUpdateProperties +## Role ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object +* **db**: string: The database name the role is applied. +* **role**: string: The role name. -## GraphResource +## SeedNode ### Properties -* **id**: string (Required): Name of the Cosmos DB Graph +* **ipAddress**: string: IP address of this seed node. -## Tags +## ServiceResourceCreateUpdateProperties ### Properties +* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). +* **instanceCount**: int: Instance count for the service. +* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. +* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. ### Additional Properties -* **Additional Properties Type**: string - -## GremlinDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object - -## GremlinDatabaseResource -### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Gremlin database +* **Additional Properties Type**: any -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## GremlinGraphResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. * **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **id**: string (Required): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## IncludedPath -### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## Indexes +## SqlDatabaseCreateUpdateProperties ### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## SpatialSpec +## SqlDatabaseResource ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## ContainerPartitionKey +## SqlRoleAssignmentResource ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## UniqueKeyPolicy +## SqlRoleDefinitionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## UniqueKey +## SqlStoredProcedureCreateUpdateProperties ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## Tags +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags +## SqlTriggerCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## Tags +## SqlTriggerResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBDatabaseCreateUpdateProperties +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## MongoDBDatabaseResource +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## Tags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoDBCollectionCreateUpdateProperties +## TableCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoDBCollectionResource +## TableResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind - -## MongoIndex -### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options - -## MongoIndexKeys -### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service - -## MongoIndexOptions -### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1019,126 +1112,55 @@ ### Additional Properties * **Additional Properties Type**: string -## MongoRoleDefinitionResource -### Properties -* **databaseName**: string: The database name for which access is being granted for this Role Definition. -* **privileges**: [Privilege](#privilege)[]: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **roles**: [Role](#role)[]: The set of roles inherited by this Role Definition. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. - -## Privilege -### Properties -* **actions**: string[]: An array of actions that are allowed. -* **resource**: [PrivilegeResource](#privilegeresource): An Azure Cosmos DB Mongo DB Resource. - -## PrivilegeResource -### Properties -* **collection**: string: The collection name the role is applied. -* **db**: string: The database name the role is applied. - -## Role -### Properties -* **db**: string: The database name the role is applied. -* **role**: string: The role name. - -## MongoUserDefinitionResource -### Properties -* **customData**: string: A custom definition for the USer Definition. -* **databaseName**: string: The database name for which access is being granted for this User Definition. -* **mechanisms**: string: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. -* **password**: string: The password for User Definition. Response does not contain user password. -* **roles**: [Role](#role)[]: The set of roles inherited by the User Definition. -* **userName**: string: The user name for User Definition. - -## NotebookWorkspaceProperties -### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. - -## ServiceResourceCreateUpdateProperties +## Tags ### Properties -* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). -* **instanceCount**: int: Instance count for the service. -* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. -* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. ### Additional Properties -* **Additional Properties Type**: any - -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource -### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ClientEncryptionKeyCreateUpdateProperties +## Tags ### Properties -* **resource**: [ClientEncryptionKeyResource](#clientencryptionkeyresource) (Required): Cosmos DB client encryption key resource object. +### Additional Properties +* **Additional Properties Type**: string -## ClientEncryptionKeyResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **encryptionAlgorithm**: string: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. -* **id**: string: Name of the ClientEncryptionKey -* **keyWrapMetadata**: [KeyWrapMetadata](#keywrapmetadata): Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. -* **wrappedDataEncryptionKey**: any: Wrapped (encrypted) form of the key represented as a byte array. +### Additional Properties +* **Additional Properties Type**: string -## KeyWrapMetadata +## Tags ### Properties -* **name**: string: The name of associated KeyEncryptionKey (aka CustomerManagedKey). -* **type**: string: ProviderName of KeyStoreProvider. -* **value**: string: Reference / link to the KeyEncryptionKey. +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -1150,38 +1172,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -1193,64 +1207,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-10-15/types.md b/generated/cosmos-db/microsoft.documentdb/2021-10-15/types.md index 6b8b70a04b..c015dcbec6 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-10-15/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-10-15/types.md @@ -317,11 +317,102 @@ * **ApiVersion**: 2021-10-15 * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedCassandraManagedServiceIdentity +## AnalyticalStorageConfiguration ### Properties -* **principalId**: string (ReadOnly): The object id of the identity resource. -* **tenantId**: string (ReadOnly): The tenant id of the resource. -* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. + +## ApiProperties +### Properties +* **serverVersion**: '3.2' | '3.6' | '4.0' | '4.2' | string: Describes the ServerVersion of an a MongoDB account. + +## AutoscaleSettings +### Properties +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. + +## AutoscaleSettingsResource +### Properties +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + +## BackupPolicy +* **Discriminator**: type + +### Base Properties +* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. +### ContinuousModeBackupPolicy +#### Properties +* **type**: 'Continuous' (Required): Describes the mode of backups. + +### PeriodicModeBackupPolicy +#### Properties +* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup +* **type**: 'Periodic' (Required): Describes the mode of backups. + + +## BackupPolicyMigrationState +### Properties +* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). +* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. +* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. + +## Capability +### Properties +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". + +## Capacity +### Properties +* **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. + +## CassandraKeyspaceCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object + +## CassandraKeyspaceResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace + +## CassandraPartitionKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. + +## CassandraTableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object + +## CassandraTableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table +* **id**: string (Required): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClusterKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ## ClusterResourceProperties ### Properties @@ -343,50 +434,57 @@ * **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. * **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. -## Certificate +## Column ### Properties -* **pem**: string: PEM formatted public key. +* **name**: string: Name of the Cosmos DB Cassandra table column +* **type**: string: Type of the Cosmos DB Cassandra table column -## SeedNode +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **ipAddress**: string: IP address of this seed node. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## DataCenterResourceProperties +## ConflictResolutionPolicy ### Properties -* **availabilityZone**: bool: If the azure data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. -* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. -* **diskSku**: string: Disk SKU used for data centers. Default value is P30. -* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. -* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ManagedServiceIdentity +## ConsistencyPolicy ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ManagedServiceIdentityUserAssignedIdentities +## ContainerPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## CorsPolicy ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. + +## CreateUpdateOptions +### Properties +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. + +## DatabaseAccountConnectionString +### Properties +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string ## DatabaseAccountCreateUpdateProperties ### Properties @@ -425,62 +523,40 @@ * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. * **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## AnalyticalStorageConfiguration -### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. - -## ApiProperties -### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | '4.2' | string: Describes the ServerVersion of an a MongoDB account. - -## BackupPolicy -* **Discriminator**: type - -### Base Properties -* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. -### ContinuousModeBackupPolicy -#### Properties -* **type**: 'Continuous' (Required): Describes the mode of backups. - -### PeriodicModeBackupPolicy -#### Properties -* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup -* **type**: 'Periodic' (Required): Describes the mode of backups. - - -## BackupPolicyMigrationState -### Properties -* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). -* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. -* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. - -## PeriodicModeProperties +## DatabaseAccountListConnectionStringsResult ### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## Capability +## DatabaseAccountListKeysResult ### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## Capacity +## DatabaseRestoreResource ### Properties -* **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. +* **collectionNames**: string[]: The names of the collections available for restore. +* **databaseName**: string: The name of the database available for restore. -## ConsistencyPolicy +## DataCenterResourceProperties ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **availabilityZone**: bool: If the azure data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. +* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. +* **diskSku**: string: Disk SKU used for data centers. Default value is P30. +* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 -## CorsPolicy +## ExcludedPath ### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ## FailoverPolicy ### Properties @@ -488,330 +564,301 @@ * **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. * **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location +## GremlinDatabaseCreateUpdateProperties ### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## PrivateEndpointConnection +## GremlinDatabaseResource ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## PrivateEndpointConnectionProperties +## GremlinGraphCreateUpdateProperties ### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## PrivateEndpointProperty +## GremlinGraphResource ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## PrivateLinkServiceConnectionStateProperty +## IncludedPath ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## RestoreParameters +## Indexes ### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. -* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. -* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## DatabaseRestoreResource +## IndexingPolicy ### Properties -* **collectionNames**: string[]: The names of the collections available for restore. -* **databaseName**: string: The name of the database available for restore. +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## VirtualNetworkRule +## IpAddressOrRange ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## SystemData +## Location ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## Tags +## ManagedCassandraManagedServiceIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The object id of the identity resource. +* **tenantId**: string (ReadOnly): The tenant id of the resource. +* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. -## CassandraKeyspaceCreateUpdateProperties +## ManagedServiceIdentity ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## CreateUpdateOptions +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## AutoscaleSettings +## MongoDBCollectionCreateUpdateProperties ### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CassandraKeyspaceResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **analyticalStorageTtl**: int: Analytical TTL. +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## CassandraTableCreateUpdateProperties +## MongoDBDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## CassandraTableResource +## MongoDBDatabaseResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table -* **id**: string (Required): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema - -## CassandraSchema -### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## ClusterKey +## MongoIndex ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## Column +## MongoIndexKeys ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table column -* **type**: string: Type of the Cosmos DB Cassandra table column +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service -## CassandraPartitionKey +## MongoIndexOptions ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not -## Tags +## NotebookWorkspaceConnectionInfoResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## ThroughputSettingsUpdateProperties +## NotebookWorkspaceProperties ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## ThroughputSettingsResource +## PeriodicModeProperties ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## AutoscaleSettingsResource +## Permission ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## AutoUpgradePolicyResource +## PrivateEndpointConnection ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ThroughputPolicyResource +## PrivateEndpointConnectionProperties ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## Tags +## PrivateEndpointProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## GremlinDatabaseCreateUpdateProperties +## RestoreParameters ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. +* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. +* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). -## GremlinDatabaseResource +## SeedNode ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Gremlin database +* **ipAddress**: string: IP address of this seed node. -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## GremlinGraphResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. * **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **id**: string (Required): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## IncludedPath -### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## Indexes -### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. - -## SpatialSpec -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type - -## ContainerPartitionKey +## SqlDatabaseCreateUpdateProperties ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## UniqueKeyPolicy +## SqlDatabaseResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## UniqueKey +## SqlRoleAssignmentResource ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## Tags +## SqlRoleDefinitionResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## Tags +## SqlStoredProcedureCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## Tags +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## MongoDBDatabaseCreateUpdateProperties +## SqlTriggerCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## MongoDBDatabaseResource +## SqlTriggerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBCollectionCreateUpdateProperties +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## MongoDBCollectionResource +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## MongoIndex +## SystemData ### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoIndexKeys +## TableCreateUpdateProperties ### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoIndexOptions +## TableResource ### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -831,65 +878,40 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceProperties -### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. - -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource +## Tags ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -901,38 +923,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -944,64 +958,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2021-11-15-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2021-11-15-preview/types.md index 428afe181a..ea9620da17 100644 --- a/generated/cosmos-db/microsoft.documentdb/2021-11-15-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2021-11-15-preview/types.md @@ -419,11 +419,139 @@ * **ApiVersion**: 2021-11-15-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedCassandraManagedServiceIdentity +## AnalyticalStorageConfiguration ### Properties -* **principalId**: string (ReadOnly): The object id of the identity resource. -* **tenantId**: string (ReadOnly): The tenant id of the resource. -* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. + +## ApiProperties +### Properties +* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. + +## AuthenticationMethodLdapProperties +### Properties +* **searchBaseDistinguishedName**: string: Distinguished name of the object to start the recursive search of users from. +* **searchFilterTemplate**: string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. +* **serverCertificates**: [Certificate](#certificate)[]: Array of Certificate +* **serverHostname**: string: Hostname of the LDAP server. +* **serverPort**: int: Port of the LDAP server. +* **serviceUserDistinguishedName**: string: Distinguished name of the look up user account, who can look up user details on authentication. +* **serviceUserPassword**: string: Password of the look up user. + +## AutoscaleSettings +### Properties +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. + +## AutoscaleSettingsResource +### Properties +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. + +## AutoUpgradePolicyResource +### Properties +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy + +## BackupPolicy +* **Discriminator**: type + +### Base Properties +* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. +### ContinuousModeBackupPolicy +#### Properties +* **type**: 'Continuous' (Required): Describes the mode of backups. + +### PeriodicModeBackupPolicy +#### Properties +* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup +* **type**: 'Periodic' (Required): Describes the mode of backups. + + +## BackupPolicyMigrationState +### Properties +* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). +* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. +* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. + +## Capability +### Properties +* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". + +## Capacity +### Properties +* **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. + +## CassandraKeyspaceCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object + +## CassandraKeyspaceResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace + +## CassandraPartitionKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. + +## CassandraTableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object + +## CassandraTableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. +* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table +* **id**: string (Required): Name of the Cosmos DB Cassandra table +* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema + +## CassandraViewCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object + +## CassandraViewResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra view +* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClientEncryptionKeyCreateUpdateProperties +### Properties +* **resource**: [ClientEncryptionKeyResource](#clientencryptionkeyresource) (Required): Cosmos DB client encryption key resource object. + +## ClientEncryptionKeyResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **encryptionAlgorithm**: string: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. +* **id**: string: Name of the ClientEncryptionKey +* **keyWrapMetadata**: [KeyWrapMetadata](#keywrapmetadata): Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. +* **wrappedDataEncryptionKey**: any: Wrapped (encrypted) form of the key represented as a byte array. + +## ClusterKey +### Properties +* **name**: string: Name of the Cosmos DB Cassandra table cluster key +* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" ## ClusterResourceProperties ### Properties @@ -445,61 +573,57 @@ * **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. * **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. -## Certificate +## Column ### Properties -* **pem**: string: PEM formatted public key. +* **name**: string: Name of the Cosmos DB Cassandra table column +* **type**: string: Type of the Cosmos DB Cassandra table column -## SeedNode +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **ipAddress**: string: IP address of this seed node. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## DataCenterResourceProperties +## ConflictResolutionPolicy ### Properties -* **authenticationMethodLdapProperties**: [AuthenticationMethodLdapProperties](#authenticationmethodldapproperties): Ldap authentication method properties. This feature is in preview. -* **availabilityZone**: bool: If the data center has Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. -* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. -* **diskSku**: string: Disk SKU used for data centers. Default value is P30. -* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. -* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## AuthenticationMethodLdapProperties +## ConsistencyPolicy ### Properties -* **searchBaseDistinguishedName**: string: Distinguished name of the object to start the recursive search of users from. -* **searchFilterTemplate**: string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. -* **serverCertificates**: [Certificate](#certificate)[]: Array of Certificate -* **serverHostname**: string: Hostname of the LDAP server. -* **serverPort**: int: Port of the LDAP server. -* **serviceUserDistinguishedName**: string: Distinguished name of the look up user account, who can look up user details on authentication. -* **serviceUserPassword**: string: Password of the look up user. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## ManagedServiceIdentity +## ContainerPartitionKey ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## ManagedServiceIdentityUserAssignedIdentities +## CorsPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## CreateUpdateOptions ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. + +## DatabaseAccountConnectionString +### Properties +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string ## DatabaseAccountCreateUpdateProperties ### Properties @@ -540,66 +664,84 @@ * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. * **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## AnalyticalStorageConfiguration +## DatabaseAccountListConnectionStringsResult ### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## ApiProperties +## DatabaseAccountListKeysResult ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | string: Describes the ServerVersion of an a MongoDB account. +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## BackupPolicy -* **Discriminator**: type +## DatabaseRestoreResource +### Properties +* **collectionNames**: string[]: The names of the collections available for restore. +* **databaseName**: string: The name of the database available for restore. + +## DataCenterResourceProperties +### Properties +* **authenticationMethodLdapProperties**: [AuthenticationMethodLdapProperties](#authenticationmethodldapproperties): Ldap authentication method properties. This feature is in preview. +* **availabilityZone**: bool: If the data center has Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. +* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. +* **diskSku**: string: Disk SKU used for data centers. Default value is P30. +* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 + +## DataTransferDataSourceSink +* **Discriminator**: component ### Base Properties -* **migrationState**: [BackupPolicyMigrationState](#backuppolicymigrationstate): The object representing the state of the migration between the backup policies. -### ContinuousModeBackupPolicy +### AzureBlobDataTransferDataSourceSink #### Properties -* **type**: 'Continuous' (Required): Describes the mode of backups. +* **component**: 'AzureBlobStorage' (Required) +* **containerName**: string (Required) +* **endpointUrl**: string -### PeriodicModeBackupPolicy +### CosmosCassandraDataTransferDataSourceSink #### Properties -* **periodicModeProperties**: [PeriodicModeProperties](#periodicmodeproperties): Configuration values for periodic mode backup -* **type**: 'Periodic' (Required): Describes the mode of backups. - - -## BackupPolicyMigrationState -### Properties -* **startTime**: string: Time at which the backup policy migration started (ISO-8601 format). -* **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. -* **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. +* **component**: 'CosmosDBCassandra' (Required) +* **keyspaceName**: string (Required) +* **tableName**: string (Required) -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. +### CosmosSqlDataTransferDataSourceSink +#### Properties +* **component**: 'CosmosDBSql' (Required) +* **containerName**: string (Required) +* **databaseName**: string (Required) -## Capability -### Properties -* **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". -## Capacity +## DataTransferJobProperties ### Properties -* **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. +* **destination**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error Response. +* **jobName**: string (ReadOnly): Job Name +* **lastUpdatedUtcTime**: string (ReadOnly): Last Updated Time (ISO-8601 format). +* **percentageComplete**: int (ReadOnly): Percentage of completion. +* **source**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink +* **status**: string (ReadOnly): Job Status +* **workerCount**: int: Worker count -## ConsistencyPolicy +## DiagnosticLogSettings ### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. +* **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. -## CorsPolicy +## ErrorResponse ### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. +* **code**: string: Error code. +* **message**: string: Error message indicating why the operation failed. -## DiagnosticLogSettings +## ExcludedPath ### Properties -* **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) ## FailoverPolicy ### Properties @@ -607,413 +749,365 @@ * **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. * **locationName**: string (ReadOnly): The name of the region in which the database account exists. -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location +## GraphResource ### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **id**: string (Required): Name of the Cosmos DB Graph -## PrivateEndpointConnection +## GraphResourceCreateUpdateProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object -## PrivateEndpointConnectionProperties +## GremlinDatabaseCreateUpdateProperties ### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object -## PrivateEndpointProperty +## GremlinDatabaseResource ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Gremlin database -## PrivateLinkServiceConnectionStateProperty +## GremlinDatabaseRestoreResource ### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. +* **databaseName**: string: The name of the gremlin database available for restore. +* **graphNames**: string[]: The names of the graphs available for restore. -## RestoreParameters +## GremlinGraphCreateUpdateProperties ### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. -* **gremlinDatabasesToRestore**: [GremlinDatabaseRestoreResource](#gremlindatabaserestoreresource)[]: List of specific gremlin databases available for restore. -* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. -* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). -* **tablesToRestore**: string[]: List of specific tables available for restore. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object -## DatabaseRestoreResource +## GremlinGraphResource ### Properties -* **collectionNames**: string[]: The names of the collections available for restore. -* **databaseName**: string: The name of the database available for restore. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. +* **defaultTtl**: int: Default time to live +* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy +* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions +* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## GremlinDatabaseRestoreResource +## IncludedPath ### Properties -* **databaseName**: string: The name of the gremlin database available for restore. -* **graphNames**: string[]: The names of the graphs available for restore. +* **indexes**: [Indexes](#indexes)[]: List of indexes for this path +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## VirtualNetworkRule +## Indexes ### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. +* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. +* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. +* **precision**: int: The precision of the index. -1 is maximum precision. -## SystemData +## IndexingPolicy ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## Tags +## IpAddressOrRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## CassandraKeyspaceCreateUpdateProperties +## KeyWrapMetadata ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object +* **algorithm**: string: Algorithm used in wrapping and unwrapping of the data encryption key. +* **name**: string: The name of associated KeyEncryptionKey (aka CustomerManagedKey). +* **type**: string: ProviderName of KeyStoreProvider. +* **value**: string: Reference / link to the KeyEncryptionKey. -## CreateUpdateOptions +## Location ### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## AutoscaleSettings +## ManagedCassandraManagedServiceIdentity ### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. +* **principalId**: string (ReadOnly): The object id of the identity resource. +* **tenantId**: string (ReadOnly): The tenant id of the resource. +* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. -## CassandraKeyspaceResource +## ManagedServiceIdentity ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra keyspace +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## CassandraTableCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraTableResource](#cassandratableresource) (Required): Cosmos DB Cassandra table resource object +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## CassandraTableResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **analyticalStorageTtl**: int: Analytical TTL. -* **defaultTtl**: int: Time to live of the Cosmos DB Cassandra table -* **id**: string (Required): Name of the Cosmos DB Cassandra table -* **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## CassandraSchema +## MongoDBDatabaseCreateUpdateProperties ### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## ClusterKey +## MongoDBDatabaseResource ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table cluster key -* **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB MongoDB database -## Column +## MongoIndex ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table column -* **type**: string: Type of the Cosmos DB Cassandra table column +* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object +* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options -## CassandraPartitionKey +## MongoIndexKeys ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service -## Tags +## MongoIndexOptions ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **expireAfterSeconds**: int: Expire after seconds +* **unique**: bool: Is unique or not -## ThroughputSettingsUpdateProperties +## MongoRoleDefinitionResource ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **databaseName**: string: The database name for which access is being granted for this Role Definition. +* **privileges**: [Privilege](#privilege)[]: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **roles**: [Role](#role)[]: The set of roles inherited by this Role Definition. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## ThroughputSettingsResource +## MongoUserDefinitionResource ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **customData**: string: A custom definition for the USer Definition. +* **databaseName**: string: The database name for which access is being granted for this User Definition. +* **mechanisms**: string: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. +* **password**: string: The password for User Definition. Response does not contain user password. +* **roles**: [Role](#role)[]: The set of roles inherited by the User Definition. +* **userName**: string: The user name for User Definition. -## AutoscaleSettingsResource +## NotebookWorkspaceConnectionInfoResult ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -## AutoUpgradePolicyResource +## NotebookWorkspaceProperties ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## ThroughputPolicyResource +## PeriodicModeProperties ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## Tags +## Permission ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## Tags +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## CassandraViewCreateUpdateProperties +## PrivateEndpointConnectionProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. -## CassandraViewResource +## PrivateEndpointProperty ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra view -* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view +* **id**: string (ReadOnly): Resource id of the private endpoint. -## Tags +## PrivateLinkServiceConnectionStateProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. -## Tags +## Privilege ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: string[]: An array of actions that are allowed. +* **resource**: [PrivilegeResource](#privilegeresource): An Azure Cosmos DB Mongo DB Resource. -## DataTransferJobProperties +## PrivilegeResource ### Properties -* **destination**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error Response. -* **jobName**: string (ReadOnly): Job Name -* **lastUpdatedUtcTime**: string (ReadOnly): Last Updated Time (ISO-8601 format). -* **percentageComplete**: int (ReadOnly): Percentage of completion. -* **source**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink -* **status**: string (ReadOnly): Job Status -* **workerCount**: int: Worker count - -## DataTransferDataSourceSink -* **Discriminator**: component - -### Base Properties -### AzureBlobDataTransferDataSourceSink -#### Properties -* **component**: 'AzureBlobStorage' (Required) -* **containerName**: string (Required) -* **endpointUrl**: string - -### CosmosCassandraDataTransferDataSourceSink -#### Properties -* **component**: 'CosmosDBCassandra' (Required) -* **keyspaceName**: string (Required) -* **tableName**: string (Required) - -### CosmosSqlDataTransferDataSourceSink -#### Properties -* **component**: 'CosmosDBSql' (Required) -* **containerName**: string (Required) -* **databaseName**: string (Required) - +* **collection**: string: The collection name the role is applied. +* **db**: string: The database name the role is applied. -## ErrorResponse +## RestoreParameters ### Properties -* **code**: string: Error code. -* **message**: string: Error message indicating why the operation failed. +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. +* **gremlinDatabasesToRestore**: [GremlinDatabaseRestoreResource](#gremlindatabaserestoreresource)[]: List of specific gremlin databases available for restore. +* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. +* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). +* **tablesToRestore**: string[]: List of specific tables available for restore. -## GraphResourceCreateUpdateProperties +## Role ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object +* **db**: string: The database name the role is applied. +* **role**: string: The role name. -## GraphResource +## SeedNode ### Properties -* **id**: string (Required): Name of the Cosmos DB Graph +* **ipAddress**: string: IP address of this seed node. -## Tags +## ServiceResourceCreateUpdateProperties ### Properties +* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). +* **instanceCount**: int: Instance count for the service. +* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. +* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. ### Additional Properties -* **Additional Properties Type**: string - -## GremlinDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinDatabaseResource](#gremlindatabaseresource) (Required): Cosmos DB Gremlin database resource object - -## GremlinDatabaseResource -### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Gremlin database +* **Additional Properties Type**: any -## Tags +## ShardKeys ### Properties ### Additional Properties * **Additional Properties Type**: string -## GremlinGraphCreateUpdateProperties +## SpatialSpec +### Properties +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type + +## SqlContainerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GremlinGraphResource](#gremlingraphresource) (Required): Cosmos DB Gremlin graph resource object +* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object -## GremlinGraphResource +## SqlContainerResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **analyticalStorageTtl**: int: Analytical TTL. * **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. * **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB Gremlin graph +* **id**: string (Required): Name of the Cosmos DB SQL container * **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## IncludedPath -### Properties -* **indexes**: [Indexes](#indexes)[]: List of indexes for this path -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## Indexes +## SqlDatabaseCreateUpdateProperties ### Properties -* **dataType**: 'LineString' | 'MultiPolygon' | 'Number' | 'Point' | 'Polygon' | 'String' | string: The datatype for which the indexing behavior is applied to. -* **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. -* **precision**: int: The precision of the index. -1 is maximum precision. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## SpatialSpec +## SqlDatabaseResource ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## ContainerPartitionKey +## SqlRoleAssignmentResource ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. -## UniqueKeyPolicy +## SqlRoleDefinitionResource ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## UniqueKey +## SqlStoredProcedureCreateUpdateProperties ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object -## Tags +## SqlStoredProcedureResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Stored Procedure +* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags +## SqlTriggerCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object -## Tags +## SqlTriggerResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **body**: string: Body of the Trigger +* **id**: string (Required): Name of the Cosmos DB SQL trigger +* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with +* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## MongoDBDatabaseCreateUpdateProperties +## SqlUserDefinedFunctionCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object -## MongoDBDatabaseResource +## SqlUserDefinedFunctionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database +* **body**: string: Body of the User Defined Function +* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction -## Tags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## MongoDBCollectionCreateUpdateProperties +## TableCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object -## MongoDBCollectionResource +## TableResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind - -## MongoIndex -### Properties -* **key**: [MongoIndexKeys](#mongoindexkeys): Cosmos DB MongoDB collection resource object -* **options**: [MongoIndexOptions](#mongoindexoptions): Cosmos DB MongoDB collection index options - -## MongoIndexKeys -### Properties -* **keys**: string[]: List of keys for each MongoDB collection in the Azure Cosmos DB service - -## MongoIndexOptions -### Properties -* **expireAfterSeconds**: int: Expire after seconds -* **unique**: bool: Is unique or not +* **id**: string (Required): Name of the Cosmos DB table -## ShardKeys +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1033,127 +1127,55 @@ ### Additional Properties * **Additional Properties Type**: string -## MongoRoleDefinitionResource -### Properties -* **databaseName**: string: The database name for which access is being granted for this Role Definition. -* **privileges**: [Privilege](#privilege)[]: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **roles**: [Role](#role)[]: The set of roles inherited by this Role Definition. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. - -## Privilege -### Properties -* **actions**: string[]: An array of actions that are allowed. -* **resource**: [PrivilegeResource](#privilegeresource): An Azure Cosmos DB Mongo DB Resource. - -## PrivilegeResource -### Properties -* **collection**: string: The collection name the role is applied. -* **db**: string: The database name the role is applied. - -## Role -### Properties -* **db**: string: The database name the role is applied. -* **role**: string: The role name. - -## MongoUserDefinitionResource -### Properties -* **customData**: string: A custom definition for the USer Definition. -* **databaseName**: string: The database name for which access is being granted for this User Definition. -* **mechanisms**: string: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. -* **password**: string: The password for User Definition. Response does not contain user password. -* **roles**: [Role](#role)[]: The set of roles inherited by the User Definition. -* **userName**: string: The user name for User Definition. - -## NotebookWorkspaceProperties -### Properties -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. -* **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. - -## ServiceResourceCreateUpdateProperties +## Tags ### Properties -* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). -* **instanceCount**: int: Instance count for the service. -* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. -* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. ### Additional Properties -* **Additional Properties Type**: any - -## SqlDatabaseCreateUpdateProperties -### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object - -## SqlDatabaseResource -### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ClientEncryptionKeyCreateUpdateProperties +## Tags ### Properties -* **resource**: [ClientEncryptionKeyResource](#clientencryptionkeyresource) (Required): Cosmos DB client encryption key resource object. +### Additional Properties +* **Additional Properties Type**: string -## ClientEncryptionKeyResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **encryptionAlgorithm**: string: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. -* **id**: string: Name of the ClientEncryptionKey -* **keyWrapMetadata**: [KeyWrapMetadata](#keywrapmetadata): Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. -* **wrappedDataEncryptionKey**: any: Wrapped (encrypted) form of the key represented as a byte array. +### Additional Properties +* **Additional Properties Type**: string -## KeyWrapMetadata +## Tags ### Properties -* **algorithm**: string: Algorithm used in wrapping and unwrapping of the data encryption key. -* **name**: string: The name of associated KeyEncryptionKey (aka CustomerManagedKey). -* **type**: string: ProviderName of KeyStoreProvider. -* **value**: string: Reference / link to the KeyEncryptionKey. +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlContainerResource](#sqlcontainerresource) (Required): Cosmos DB SQL container resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlContainerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **conflictResolutionPolicy**: [ConflictResolutionPolicy](#conflictresolutionpolicy): The conflict resolution policy for the container. -* **defaultTtl**: int: Default time to live -* **id**: string (Required): Name of the Cosmos DB SQL container -* **indexingPolicy**: [IndexingPolicy](#indexingpolicy): Cosmos DB indexing policy -* **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions -* **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlStoredProcedureCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlStoredProcedureResource](#sqlstoredprocedureresource) (Required): Cosmos DB SQL storedProcedure resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlStoredProcedureResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Stored Procedure -* **id**: string (Required): Name of the Cosmos DB SQL storedProcedure +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -1165,38 +1187,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlTriggerCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlTriggerResource](#sqltriggerresource) (Required): Cosmos DB SQL trigger resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlTriggerResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the Trigger -* **id**: string (Required): Name of the Cosmos DB SQL trigger -* **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with -* **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlUserDefinedFunctionCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlUserDefinedFunctionResource](#sqluserdefinedfunctionresource) (Required): Cosmos DB SQL userDefinedFunction resource object +### Additional Properties +* **Additional Properties Type**: string -## SqlUserDefinedFunctionResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **body**: string: Body of the User Defined Function -* **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -1208,64 +1222,50 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## ThroughputPolicyResource ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not -## TableResource +## ThroughputSettingsResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. -## NotebookWorkspaceConnectionInfoResult +## ThroughputSettingsUpdateProperties ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. -## DatabaseAccountListConnectionStringsResult +## UniqueKey ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service -## DatabaseAccountConnectionString +## UniqueKeyPolicy ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. -## DatabaseAccountListKeysResult +## VirtualNetworkRule ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cosmos-db/microsoft.documentdb/2022-02-15-preview/types.md b/generated/cosmos-db/microsoft.documentdb/2022-02-15-preview/types.md index dd393c5681..27f3c21cf5 100644 --- a/generated/cosmos-db/microsoft.documentdb/2022-02-15-preview/types.md +++ b/generated/cosmos-db/microsoft.documentdb/2022-02-15-preview/types.md @@ -419,60 +419,13 @@ * **ApiVersion**: 2022-02-15-preview * **Output**: [DatabaseAccountListKeysResult](#databaseaccountlistkeysresult) -## ManagedCassandraManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the identity resource. -* **tenantId**: string (ReadOnly): The tenant id of the resource. -* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. - -## ClusterResourceProperties -### Properties -* **authenticationMethod**: 'Cassandra' | 'Ldap' | 'None' | string: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. 'Ldap' is in preview. -* **cassandraAuditLoggingEnabled**: bool: Whether Cassandra audit logging is enabled -* **cassandraVersion**: string: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. -* **clientCertificates**: [Certificate](#certificate)[]: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. -* **clusterNameOverride**: string: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. -* **deallocated**: bool: Whether the cluster and associated data centers has been deallocated. -* **delegatedManagementSubnetId**: string: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' -* **externalGossipCertificates**: [Certificate](#certificate)[]: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. -* **externalSeedNodes**: [SeedNode](#seednode)[]: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. -* **gossipCertificates**: [Certificate](#certificate)[] (ReadOnly): List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. -* **hoursBetweenBackups**: int: Number of hours to wait between taking a backup of the cluster. -* **initialCassandraAdminPassword**: string (WriteOnly): Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. -* **prometheusEndpoint**: [SeedNode](#seednode) -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **repairEnabled**: bool: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. -* **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. - -## Certificate -### Properties -* **pem**: string: PEM formatted public key. - -## SeedNode -### Properties -* **ipAddress**: string: IP address of this seed node. - -## Tags +## AnalyticalStorageConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. -## DataCenterResourceProperties +## ApiProperties ### Properties -* **authenticationMethodLdapProperties**: [AuthenticationMethodLdapProperties](#authenticationmethodldapproperties): Ldap authentication method properties. This feature is in preview. -* **availabilityZone**: bool: If the data center has Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. -* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. -* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. -* **dataCenterLocation**: string: The region this data center should be created in. -* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. -* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. -* **diskSku**: string: Disk SKU used for data centers. Default value is P30. -* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. -* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. -* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. -* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 +* **serverVersion**: '3.2' | '3.6' | '4.0' | '4.2' | string: Describes the ServerVersion of an a MongoDB account. ## AuthenticationMethodLdapProperties ### Properties @@ -484,69 +437,19 @@ * **serviceUserDistinguishedName**: string: Distinguished name of the look up user account, who can look up user details on authentication. * **serviceUserPassword**: string: Password of the look up user. -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## DatabaseAccountCreateUpdateProperties +## AutoscaleSettings ### Properties -* **analyticalStorageConfiguration**: [AnalyticalStorageConfiguration](#analyticalstorageconfiguration): Analytical storage specific properties. -* **apiProperties**: [ApiProperties](#apiproperties) -* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. -* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account -* **capacity**: [Capacity](#capacity): The object that represents all properties related to capacity enforcement on an account. -* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. -* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. -* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. -* **createMode**: 'Default' | 'Restore' | string: Enum to indicate the mode of account creation. -* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. -* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. -* **diagnosticLogSettings**: [DiagnosticLogSettings](#diagnosticlogsettings): Indicates what diagnostic log settings are to be enabled. -* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys -* **disableLocalAuth**: bool: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. -* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. -* **enableAutomaticFailover**: bool: 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. -* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account -* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. -* **enableMaterializedViews**: bool: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account -* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations -* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. -* **instanceId**: string (ReadOnly): A unique identifier assigned to the database account -* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. -* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. -* **keyVaultKeyUri**: string: The URI of the key vault -* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. -* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. -* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed -* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. -* **restoreParameters**: [RestoreParameters](#restoreparameters): Parameters to indicate the information about the restore. -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. -* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. +* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. -## AnalyticalStorageConfiguration +## AutoscaleSettingsResource ### Properties -* **schemaType**: 'FullFidelity' | 'WellDefined' | string: Describes the types of schema for analytical storage. +* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy +* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. +* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. -## ApiProperties +## AutoUpgradePolicyResource ### Properties -* **serverVersion**: '3.2' | '3.6' | '4.0' | '4.2' | string: Describes the ServerVersion of an a MongoDB account. +* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy ## BackupPolicy * **Discriminator**: type @@ -570,16 +473,6 @@ * **status**: 'Completed' | 'Failed' | 'InProgress' | 'Invalid' | string: Describes the status of migration between backup policy types. * **targetType**: 'Continuous' | 'Periodic' | string: Describes the mode of backups. -## ContinuousModeProperties -### Properties -* **tier**: 'Continuous30Days' | 'Continuous7Days' | string: Enum to indicate type of Continuous backup tier. - -## PeriodicModeProperties -### Properties -* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups -* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained -* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. - ## Capability ### Properties * **name**: string: Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". @@ -588,119 +481,11 @@ ### Properties * **totalThroughputLimit**: int: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. -## ConsistencyPolicy -### Properties -* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. -* **maxIntervalInSeconds**: int: 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'. -* **maxStalenessPrefix**: int: 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'. - -## CorsPolicy -### Properties -* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. -* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. -* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. -* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. -* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. - -## DiagnosticLogSettings -### Properties -* **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. - -## FailoverPolicy -### Properties -* **failoverPriority**: int (ReadOnly): 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. -* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. -* **locationName**: string (ReadOnly): The name of the region in which the database account exists. - -## IpAddressOrRange -### Properties -* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. - -## Location -### Properties -* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ -* **failoverPriority**: int: 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. -* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. -* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region -* **locationName**: string: The name of the region. -* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **groupId**: string (ReadOnly): Group id of the private endpoint. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) -* **description**: string (ReadOnly): The private link service connection description. -* **status**: string (ReadOnly): The private link service connection status. - -## RestoreParameters -### Properties -* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. -* **gremlinDatabasesToRestore**: [GremlinDatabaseRestoreResource](#gremlindatabaserestoreresource)[]: List of specific gremlin databases available for restore. -* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. -* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} -* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). -* **tablesToRestore**: string[]: List of specific tables available for restore. - -## DatabaseRestoreResource -### Properties -* **collectionNames**: string[]: The names of the collections available for restore. -* **databaseName**: string: The name of the database available for restore. - -## GremlinDatabaseRestoreResource -### Properties -* **databaseName**: string: The name of the gremlin database available for restore. -* **graphNames**: string[]: The names of the graphs available for restore. - -## VirtualNetworkRule -### Properties -* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. -* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CassandraKeyspaceCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" * **resource**: [CassandraKeyspaceResource](#cassandrakeyspaceresource) (Required): Cosmos DB Cassandra keyspace resource object -## CreateUpdateOptions -### Properties -* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) -* **throughput**: int: Request Units per second. For example, "throughput": 10000. - -## AutoscaleSettings -### Properties -* **maxThroughput**: int: Represents maximum throughput, the resource can scale up to. - ## CassandraKeyspaceResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. @@ -708,10 +493,15 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Cassandra keyspace -## Tags +## CassandraPartitionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the Cosmos DB Cassandra table partition key + +## CassandraSchema +### Properties +* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. +* **columns**: [Column](#column)[]: List of Cassandra table columns. +* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. ## CassandraTableCreateUpdateProperties ### Properties @@ -728,104 +518,200 @@ * **id**: string (Required): Name of the Cosmos DB Cassandra table * **schema**: [CassandraSchema](#cassandraschema): Cosmos DB Cassandra table schema -## CassandraSchema +## CassandraViewCreateUpdateProperties ### Properties -* **clusterKeys**: [ClusterKey](#clusterkey)[]: List of cluster key. -* **columns**: [Column](#column)[]: List of Cassandra table columns. -* **partitionKeys**: [CassandraPartitionKey](#cassandrapartitionkey)[]: List of partition key. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object + +## CassandraViewResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB Cassandra view +* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view + +## Certificate +### Properties +* **pem**: string: PEM formatted public key. + +## ClientEncryptionIncludedPath +### Properties +* **clientEncryptionKeyId**: string (Required): The identifier of the Client Encryption Key to be used to encrypt the path. +* **encryptionAlgorithm**: string (Required): The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. +* **encryptionType**: string (Required): The type of encryption to be performed. Eg - Deterministic, Randomized. +* **path**: string (Required): Path that needs to be encrypted. + +## ClientEncryptionKeyCreateUpdateProperties +### Properties +* **resource**: [ClientEncryptionKeyResource](#clientencryptionkeyresource) (Required): Cosmos DB client encryption key resource object. + +## ClientEncryptionKeyResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **encryptionAlgorithm**: string: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. +* **id**: string: Name of the ClientEncryptionKey +* **keyWrapMetadata**: [KeyWrapMetadata](#keywrapmetadata): Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. +* **wrappedDataEncryptionKey**: any: Wrapped (encrypted) form of the key represented as a byte array. + +## ClientEncryptionPolicy +### Properties +* **includedPaths**: [ClientEncryptionIncludedPath](#clientencryptionincludedpath)[] (Required): Paths of the item that need encryption along with path-specific settings. +* **policyFormatVersion**: int: Version of the client encryption policy definition. Please note, user passed value is ignored. Default policy version is 1. ## ClusterKey ### Properties * **name**: string: Name of the Cosmos DB Cassandra table cluster key * **orderBy**: string: Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" +## ClusterResourceProperties +### Properties +* **authenticationMethod**: 'Cassandra' | 'Ldap' | 'None' | string: Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. 'Ldap' is in preview. +* **cassandraAuditLoggingEnabled**: bool: Whether Cassandra audit logging is enabled +* **cassandraVersion**: string: Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. +* **clientCertificates**: [Certificate](#certificate)[]: List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. +* **clusterNameOverride**: string: If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. +* **deallocated**: bool: Whether the cluster and associated data centers has been deallocated. +* **delegatedManagementSubnetId**: string: Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' +* **externalGossipCertificates**: [Certificate](#certificate)[]: List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. +* **externalSeedNodes**: [SeedNode](#seednode)[]: List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. +* **gossipCertificates**: [Certificate](#certificate)[] (ReadOnly): List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. +* **hoursBetweenBackups**: int: Number of hours to wait between taking a backup of the cluster. +* **initialCassandraAdminPassword**: string (WriteOnly): Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'. +* **prometheusEndpoint**: [SeedNode](#seednode) +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **repairEnabled**: bool: Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. +* **restoreFromBackupId**: string (WriteOnly): To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. + ## Column ### Properties * **name**: string: Name of the Cosmos DB Cassandra table column * **type**: string: Type of the Cosmos DB Cassandra table column -## CassandraPartitionKey +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **name**: string: Name of the Cosmos DB Cassandra table partition key +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## Tags +## CompositePath ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -## ThroughputSettingsUpdateProperties +## ConflictResolutionPolicy ### Properties -* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. +* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. +* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. +* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. -## ThroughputSettingsResource +## ConsistencyPolicy ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object -* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource -* **offerReplacePending**: string (ReadOnly): The throughput replace is pending -* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. +* **defaultConsistencyLevel**: 'BoundedStaleness' | 'ConsistentPrefix' | 'Eventual' | 'Session' | 'Strong' (Required): The default consistency level and configuration settings of the Cosmos DB account. +* **maxIntervalInSeconds**: int: 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'. +* **maxStalenessPrefix**: int: 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'. -## AutoscaleSettingsResource +## ContainerPartitionKey ### Properties -* **autoUpgradePolicy**: [AutoUpgradePolicyResource](#autoupgradepolicyresource): Cosmos DB resource auto-upgrade policy -* **maxThroughput**: int (Required): Represents maximum throughput container can scale up to. -* **targetMaxThroughput**: int (ReadOnly): Represents target maximum throughput container can scale up to once offer is no longer in pending state. +* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create +* **paths**: string[]: List of paths using which data within the container can be partitioned +* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key +* **version**: int: Indicates the version of the partition key definition -## AutoUpgradePolicyResource +## ContinuousModeProperties ### Properties -* **throughputPolicy**: [ThroughputPolicyResource](#throughputpolicyresource): Cosmos DB resource throughput policy +* **tier**: 'Continuous30Days' | 'Continuous7Days' | string: Enum to indicate type of Continuous backup tier. -## ThroughputPolicyResource +## CorsPolicy ### Properties -* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. -* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not +* **allowedHeaders**: string: The request headers that the origin domain may specify on the CORS request. +* **allowedMethods**: string: The methods (HTTP request verbs) that the origin domain may use for a CORS request. +* **allowedOrigins**: string (Required): The origin domains that are permitted to make a request against the service via CORS. +* **exposedHeaders**: string: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. +* **maxAgeInSeconds**: int: The maximum amount time that a browser should cache the preflight OPTIONS request. -## Tags +## CreateUpdateOptions ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoscaleSettings**: [AutoscaleSettings](#autoscalesettings) +* **throughput**: int: Request Units per second. For example, "throughput": 10000. -## Tags +## DatabaseAccountConnectionString ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string (ReadOnly): Value of the connection string +* **description**: string (ReadOnly): Description of the connection string -## CassandraViewCreateUpdateProperties +## DatabaseAccountCreateUpdateProperties ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [CassandraViewResource](#cassandraviewresource) (Required): Cosmos DB Cassandra view resource object +* **analyticalStorageConfiguration**: [AnalyticalStorageConfiguration](#analyticalstorageconfiguration): Analytical storage specific properties. +* **apiProperties**: [ApiProperties](#apiproperties) +* **backupPolicy**: [BackupPolicy](#backuppolicy): The object representing the policy for taking backups on an account. +* **capabilities**: [Capability](#capability)[]: List of Cosmos DB capabilities for the account +* **capacity**: [Capacity](#capacity): The object that represents all properties related to capacity enforcement on an account. +* **connectorOffer**: 'Small' | string: The cassandra connector offer type for the Cosmos DB C* database account. +* **consistencyPolicy**: [ConsistencyPolicy](#consistencypolicy): The consistency policy for the Cosmos DB database account. +* **cors**: [CorsPolicy](#corspolicy)[]: The CORS policy for the Cosmos DB database account. +* **createMode**: 'Default' | 'Restore' | string: Enum to indicate the mode of account creation. +* **databaseAccountOfferType**: 'Standard' (Required): The offer type for the Cosmos DB database account. +* **defaultIdentity**: string: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more. +* **diagnosticLogSettings**: [DiagnosticLogSettings](#diagnosticlogsettings): Indicates what diagnostic log settings are to be enabled. +* **disableKeyBasedMetadataWriteAccess**: bool: Disable write operations on metadata resources (databases, containers, throughput) via account keys +* **disableLocalAuth**: bool: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the Cosmos DB database account. +* **enableAnalyticalStorage**: bool: Flag to indicate whether to enable storage analytics. +* **enableAutomaticFailover**: bool: 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. +* **enableCassandraConnector**: bool: Enables the cassandra connector on the Cosmos DB C* account +* **enableFreeTier**: bool: Flag to indicate whether Free Tier is enabled. +* **enableMaterializedViews**: bool: Flag to indicate whether to enable MaterializedViews on the Cosmos DB account +* **enableMultipleWriteLocations**: bool: Enables the account to write in multiple locations +* **failoverPolicies**: [FailoverPolicy](#failoverpolicy)[] (ReadOnly): An array that contains the regions ordered by their failover priorities. +* **instanceId**: string (ReadOnly): A unique identifier assigned to the database account +* **ipRules**: [IpAddressOrRange](#ipaddressorrange)[]: Array of IpAddressOrRange objects. +* **isVirtualNetworkFilterEnabled**: bool: Flag to indicate whether to enable/disable Virtual Network ACL rules. +* **keyVaultKeyUri**: string: The URI of the key vault +* **locations**: [Location](#location)[] (Required): An array that contains the georeplication locations enabled for the Cosmos DB account. +* **networkAclBypass**: 'AzureServices' | 'None': Indicates what services are allowed to bypass firewall checks. +* **networkAclBypassResourceIds**: string[]: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of Private Endpoint Connections configured for the Cosmos DB account. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed +* **readLocations**: [Location](#location)[] (ReadOnly): An array that contains of the read locations enabled for the Cosmos DB account. +* **restoreParameters**: [RestoreParameters](#restoreparameters): Parameters to indicate the information about the restore. +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: List of Virtual Network ACL rules configured for the Cosmos DB account. +* **writeLocations**: [Location](#location)[] (ReadOnly): An array that contains the write location for the Cosmos DB account. -## CassandraViewResource +## DatabaseAccountListConnectionStringsResult ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB Cassandra view -* **viewDefinition**: string (Required): View Definition of the Cosmos DB Cassandra view +* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. -## Tags +## DatabaseAccountListKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. +* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. +* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. +* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. -## Tags +## DatabaseRestoreResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **collectionNames**: string[]: The names of the collections available for restore. +* **databaseName**: string: The name of the database available for restore. -## DataTransferJobProperties +## DataCenterResourceProperties ### Properties -* **destination**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error Response. -* **jobName**: string (ReadOnly): Job Name -* **lastUpdatedUtcTime**: string (ReadOnly): Last Updated Time (ISO-8601 format). -* **processedCount**: int (ReadOnly): Processed Count. -* **source**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink -* **status**: string (ReadOnly): Job Status -* **totalCount**: int (ReadOnly): Total Count. -* **workerCount**: int: Worker count +* **authenticationMethodLdapProperties**: [AuthenticationMethodLdapProperties](#authenticationmethodldapproperties): Ldap authentication method properties. This feature is in preview. +* **availabilityZone**: bool: If the data center has Availability Zone feature, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. +* **backupStorageCustomerKeyUri**: string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account. +* **base64EncodedCassandraYamlFragment**: string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. +* **dataCenterLocation**: string: The region this data center should be created in. +* **delegatedSubnetId**: string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. +* **diskCapacity**: int: Number of disk used for data centers. Default value is 4. +* **diskSku**: string: Disk SKU used for data centers. Default value is P30. +* **managedDiskCustomerKeyUri**: string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. +* **nodeCount**: int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The status of the resource at the time the operation was called. +* **seedNodes**: [SeedNode](#seednode)[] (ReadOnly): IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. +* **sku**: string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 ## DataTransferDataSourceSink * **Discriminator**: component @@ -850,24 +736,45 @@ * **databaseName**: string (Required) +## DataTransferJobProperties +### Properties +* **destination**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error Response. +* **jobName**: string (ReadOnly): Job Name +* **lastUpdatedUtcTime**: string (ReadOnly): Last Updated Time (ISO-8601 format). +* **processedCount**: int (ReadOnly): Processed Count. +* **source**: [DataTransferDataSourceSink](#datatransferdatasourcesink) (Required): Base class for all DataTransfer source/sink +* **status**: string (ReadOnly): Job Status +* **totalCount**: int (ReadOnly): Total Count. +* **workerCount**: int: Worker count + +## DiagnosticLogSettings +### Properties +* **enableFullTextQuery**: 'False' | 'None' | 'True': Describe the level of detail with which queries are to be logged. + ## ErrorResponse ### Properties * **code**: string: Error code. * **message**: string: Error message indicating why the operation failed. -## GraphResourceCreateUpdateProperties +## ExcludedPath ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) + +## FailoverPolicy +### Properties +* **failoverPriority**: int (ReadOnly): 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. +* **id**: string (ReadOnly): The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. +* **locationName**: string (ReadOnly): The name of the region in which the database account exists. ## GraphResource ### Properties * **id**: string (Required): Name of the Cosmos DB Graph -## Tags +## GraphResourceCreateUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [GraphResource](#graphresource) (Required): Cosmos DB Graph resource object ## GremlinDatabaseCreateUpdateProperties ### Properties @@ -881,10 +788,10 @@ * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. * **id**: string (Required): Name of the Cosmos DB Gremlin database -## Tags +## GremlinDatabaseRestoreResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databaseName**: string: The name of the gremlin database available for restore. +* **graphNames**: string[]: The names of the graphs available for restore. ## GremlinGraphCreateUpdateProperties ### Properties @@ -903,30 +810,6 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ConflictResolutionPolicy -### Properties -* **conflictResolutionPath**: string: The conflict resolution path in the case of LastWriterWins mode. -* **conflictResolutionProcedure**: string: The procedure to resolve conflicts in the case of custom mode. -* **mode**: 'Custom' | 'LastWriterWins' | string: Indicates the conflict resolution mode. - -## IndexingPolicy -### Properties -* **automatic**: bool: Indicates if the indexing policy is automatic -* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list -* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing -* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing -* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. -* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics - -## CompositePath -### Properties -* **order**: 'ascending' | 'descending' | string: Sort order for composite paths. -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - -## ExcludedPath -### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) - ## IncludedPath ### Properties * **indexes**: [Indexes](#indexes)[]: List of indexes for this path @@ -938,72 +821,79 @@ * **kind**: 'Hash' | 'Range' | 'Spatial' | string: Indicates the type of index. * **precision**: int: The precision of the index. -1 is maximum precision. -## SpatialSpec +## IndexingPolicy ### Properties -* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) -* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type +* **automatic**: bool: Indicates if the indexing policy is automatic +* **compositeIndexes**: [CompositePath](#compositepath)[][]: List of composite path list +* **excludedPaths**: [ExcludedPath](#excludedpath)[]: List of paths to exclude from indexing +* **includedPaths**: [IncludedPath](#includedpath)[]: List of paths to include in the indexing +* **indexingMode**: 'consistent' | 'lazy' | 'none' | string: Indicates the indexing mode. +* **spatialIndexes**: [SpatialSpec](#spatialspec)[]: List of spatial specifics -## ContainerPartitionKey +## IpAddressOrRange ### Properties -* **kind**: 'Hash' | 'MultiHash' | 'Range' | string: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create -* **paths**: string[]: List of paths using which data within the container can be partitioned -* **systemKey**: bool (ReadOnly): Indicates if the container is using a system generated partition key -* **version**: int: Indicates the version of the partition key definition +* **ipAddressOrRange**: string: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. -## UniqueKeyPolicy +## KeyWrapMetadata ### Properties -* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. +* **algorithm**: string: Algorithm used in wrapping and unwrapping of the data encryption key. +* **name**: string: The name of associated KeyEncryptionKey (aka CustomerManagedKey). +* **type**: string: ProviderName of KeyStoreProvider. +* **value**: string: Reference / link to the KeyEncryptionKey. -## UniqueKey +## Location ### Properties -* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service +* **documentEndpoint**: string (ReadOnly): The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ +* **failoverPriority**: int: 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. +* **id**: string (ReadOnly): The unique identifier of the region within the database account. Example: <accountName>-<locationName>. +* **isZoneRedundant**: bool: Flag to indicate whether or not this region is an AvailabilityZone region +* **locationName**: string: The name of the region. +* **provisioningState**: string (ReadOnly): 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. 'DeletionFailed' – the Cosmos DB account deletion failed. -## Tags +## ManagedCassandraManagedServiceIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The object id of the identity resource. +* **tenantId**: string (ReadOnly): The tenant id of the resource. +* **type**: 'None' | 'SystemAssigned' | string: The type of the resource. -## Tags +## ManagedServiceIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': 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 service. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## Tags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## MongoDBDatabaseCreateUpdateProperties +## MongoDBCollectionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object +* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object -## MongoDBDatabaseResource +## MongoDBCollectionResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB MongoDB database - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **analyticalStorageTtl**: int: Analytical TTL. +* **id**: string (Required): Name of the Cosmos DB MongoDB collection +* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys +* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind -## MongoDBCollectionCreateUpdateProperties +## MongoDBDatabaseCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [MongoDBCollectionResource](#mongodbcollectionresource) (Required): Cosmos DB MongoDB collection resource object +* **resource**: [MongoDBDatabaseResource](#mongodbdatabaseresource) (Required): Cosmos DB MongoDB database resource object -## MongoDBCollectionResource +## MongoDBDatabaseResource ### Properties * **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. * **_rid**: string (ReadOnly): A system generated property. A unique identifier. * **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **analyticalStorageTtl**: int: Analytical TTL. -* **id**: string (Required): Name of the Cosmos DB MongoDB collection -* **indexes**: [MongoIndex](#mongoindex)[]: List of index keys -* **shardKey**: [ShardKeys](#shardkeys): The shard key and partition kind pair, only support "Hash" partition kind +* **id**: string (Required): Name of the Cosmos DB MongoDB database ## MongoIndex ### Properties @@ -1019,26 +909,6 @@ * **expireAfterSeconds**: int: Expire after seconds * **unique**: bool: Is unique or not -## ShardKeys -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MongoRoleDefinitionResource ### Properties * **databaseName**: string: The database name for which access is being granted for this Role Definition. @@ -1047,21 +917,6 @@ * **roles**: [Role](#role)[]: The set of roles inherited by this Role Definition. * **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. -## Privilege -### Properties -* **actions**: string[]: An array of actions that are allowed. -* **resource**: [PrivilegeResource](#privilegeresource): An Azure Cosmos DB Mongo DB Resource. - -## PrivilegeResource -### Properties -* **collection**: string: The collection name the role is applied. -* **db**: string: The database name the role is applied. - -## Role -### Properties -* **db**: string: The database name the role is applied. -* **role**: string: The role name. - ## MongoUserDefinitionResource ### Properties * **customData**: string: A custom definition for the USer Definition. @@ -1071,59 +926,97 @@ * **roles**: [Role](#role)[]: The set of roles inherited by the User Definition. * **userName**: string: The user name for User Definition. +## NotebookWorkspaceConnectionInfoResult +### Properties +* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). +* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. + ## NotebookWorkspaceProperties ### Properties * **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. * **status**: string (ReadOnly): Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating. -## ServiceResourceCreateUpdateProperties +## PeriodicModeProperties ### Properties -* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). -* **instanceCount**: int: Instance count for the service. -* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. -* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. -### Additional Properties -* **Additional Properties Type**: any +* **backupIntervalInMinutes**: int: An integer representing the interval in minutes between two backups +* **backupRetentionIntervalInHours**: int: An integer representing the time (in hours) that each backup is retained +* **backupStorageRedundancy**: 'Geo' | 'Local' | 'Zone' | string: Enum to indicate type of backup storage redundancy. -## SqlDatabaseCreateUpdateProperties +## Permission ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object +* **dataActions**: string[]: An array of data actions that are allowed. +* **notDataActions**: string[]: An array of data actions that are denied. -## SqlDatabaseResource +## PrivateEndpointConnection ### Properties -* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. -* **id**: string (Required): Name of the Cosmos DB SQL database +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## Tags +## PrivateEndpointConnectionProperties +### Properties +* **groupId**: string (ReadOnly): Group id of the private endpoint. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly): Private endpoint which the connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly): Connection State of the Private Endpoint Connection. +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): Any action that is required beyond basic workflow (approve/ reject/ disconnect) +* **description**: string (ReadOnly): The private link service connection description. +* **status**: string (ReadOnly): The private link service connection status. + +## Privilege +### Properties +* **actions**: string[]: An array of actions that are allowed. +* **resource**: [PrivilegeResource](#privilegeresource): An Azure Cosmos DB Mongo DB Resource. + +## PrivilegeResource +### Properties +* **collection**: string: The collection name the role is applied. +* **db**: string: The database name the role is applied. + +## RestoreParameters +### Properties +* **databasesToRestore**: [DatabaseRestoreResource](#databaserestoreresource)[]: List of specific databases available for restore. +* **gremlinDatabasesToRestore**: [GremlinDatabaseRestoreResource](#gremlindatabaserestoreresource)[]: List of specific gremlin databases available for restore. +* **restoreMode**: 'PointInTime' | string: Describes the mode of the restore. +* **restoreSource**: string: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} +* **restoreTimestampInUtc**: string: Time to which the account has to be restored (ISO-8601 format). +* **tablesToRestore**: string[]: List of specific tables available for restore. + +## Role +### Properties +* **db**: string: The database name the role is applied. +* **role**: string: The role name. + +## SeedNode ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddress**: string: IP address of this seed node. -## ClientEncryptionKeyCreateUpdateProperties +## ServiceResourceCreateUpdateProperties ### Properties -* **resource**: [ClientEncryptionKeyResource](#clientencryptionkeyresource) (Required): Cosmos DB client encryption key resource object. +* **creationTime**: string (ReadOnly): Time of the last state change (ISO-8601 format). +* **instanceCount**: int: Instance count for the service. +* **instanceSize**: 'Cosmos.D16s' | 'Cosmos.D4s' | 'Cosmos.D8s' | string: Instance type for the service. +* **status**: 'Creating' | 'Deleting' | 'Error' | 'Running' | 'Stopped' | 'Updating' | string (ReadOnly): Describes the status of a service. +### Additional Properties +* **Additional Properties Type**: any -## ClientEncryptionKeyResource +## ShardKeys ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **encryptionAlgorithm**: string: Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. -* **id**: string: Name of the ClientEncryptionKey -* **keyWrapMetadata**: [KeyWrapMetadata](#keywrapmetadata): Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. -* **wrappedDataEncryptionKey**: any: Wrapped (encrypted) form of the key represented as a byte array. +### Additional Properties +* **Additional Properties Type**: string -## KeyWrapMetadata +## SpatialSpec ### Properties -* **algorithm**: string: Algorithm used in wrapping and unwrapping of the data encryption key. -* **name**: string: The name of associated KeyEncryptionKey (aka CustomerManagedKey). -* **type**: string: ProviderName of KeyStoreProvider. -* **value**: string: Reference / link to the KeyEncryptionKey. +* **path**: string: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) +* **types**: 'LineString' | 'MultiPolygon' | 'Point' | 'Polygon' | string[]: List of path's spatial type ## SqlContainerCreateUpdateProperties ### Properties @@ -1144,22 +1037,32 @@ * **partitionKey**: [ContainerPartitionKey](#containerpartitionkey): The configuration of the partition key to be used for partitioning data into multiple partitions * **uniqueKeyPolicy**: [UniqueKeyPolicy](#uniquekeypolicy): The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. -## ClientEncryptionPolicy +## SqlDatabaseCreateUpdateProperties ### Properties -* **includedPaths**: [ClientEncryptionIncludedPath](#clientencryptionincludedpath)[] (Required): Paths of the item that need encryption along with path-specific settings. -* **policyFormatVersion**: int: Version of the client encryption policy definition. Please note, user passed value is ignored. Default policy version is 1. +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [SqlDatabaseResource](#sqldatabaseresource) (Required): Cosmos DB SQL database resource object -## ClientEncryptionIncludedPath +## SqlDatabaseResource ### Properties -* **clientEncryptionKeyId**: string (Required): The identifier of the Client Encryption Key to be used to encrypt the path. -* **encryptionAlgorithm**: string (Required): The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. -* **encryptionType**: string (Required): The type of encryption to be performed. Eg - Deterministic, Randomized. -* **path**: string (Required): Path that needs to be encrypted. +* **_colls**: string (ReadOnly): A system generated property that specified the addressable path of the collections resource. +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **_users**: string (ReadOnly): A system generated property that specifies the addressable path of the users resource. +* **id**: string (Required): Name of the Cosmos DB SQL database -## Tags +## SqlRoleAssignmentResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. +* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. +* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. + +## SqlRoleDefinitionResource +### Properties +* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. +* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. +* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. +* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. ## SqlStoredProcedureCreateUpdateProperties ### Properties @@ -1174,16 +1077,6 @@ * **body**: string: Body of the Stored Procedure * **id**: string (Required): Name of the Cosmos DB SQL storedProcedure -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlTriggerCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -1199,11 +1092,6 @@ * **triggerOperation**: 'All' | 'Create' | 'Delete' | 'Replace' | 'Update' | string: The operation the trigger is associated with * **triggerType**: 'Post' | 'Pre' | string: Type of the Trigger -## Tags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SqlUserDefinedFunctionCreateUpdateProperties ### Properties * **options**: [CreateUpdateOptions](#createupdateoptions) (WriteOnly): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" @@ -1217,6 +1105,27 @@ * **body**: string: Body of the User Defined Function * **id**: string (Required): Name of the Cosmos DB SQL userDefinedFunction +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. + +## TableCreateUpdateProperties +### Properties +* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" +* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object + +## TableResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **id**: string (Required): Name of the Cosmos DB table + ## Tags ### Properties ### Additional Properties @@ -1227,35 +1136,30 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlRoleAssignmentResource +## Tags ### Properties -* **principalId**: string: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. -* **roleDefinitionId**: string: The unique identifier for the associated Role Definition. -* **scope**: string: The data plane resource path for which access is being granted through this Role Assignment. +### Additional Properties +* **Additional Properties Type**: string -## SqlRoleDefinitionResource +## Tags ### Properties -* **assignableScopes**: string[]: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. -* **permissions**: [Permission](#permission)[]: The set of operations allowed through this Role Definition. -* **roleName**: string: A user-friendly name for the Role Definition. Must be unique for the database account. -* **type**: 'BuiltInRole' | 'CustomRole': Indicates whether the Role Definition was built-in or user created. +### Additional Properties +* **Additional Properties Type**: string -## Permission +## Tags ### Properties -* **dataActions**: string[]: An array of data actions that are allowed. -* **notDataActions**: string[]: An array of data actions that are denied. +### Additional Properties +* **Additional Properties Type**: string -## TableCreateUpdateProperties +## Tags ### Properties -* **options**: [CreateUpdateOptions](#createupdateoptions): CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" -* **resource**: [TableResource](#tableresource) (Required): Cosmos DB table resource object +### Additional Properties +* **Additional Properties Type**: string -## TableResource +## Tags ### Properties -* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. -* **_rid**: string (ReadOnly): A system generated property. A unique identifier. -* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. -* **id**: string (Required): Name of the Cosmos DB table +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties @@ -1267,24 +1171,120 @@ ### Additional Properties * **Additional Properties Type**: string -## NotebookWorkspaceConnectionInfoResult +## Tags ### Properties -* **authToken**: string (ReadOnly): Specifies auth token used for connecting to Notebook server (uses token-based auth). -* **notebookServerEndpoint**: string (ReadOnly): Specifies the endpoint of Notebook server. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListConnectionStringsResult +## Tags ### Properties -* **connectionStrings**: [DatabaseAccountConnectionString](#databaseaccountconnectionstring)[] (ReadOnly): An array that contains the connection strings for the Cosmos DB account. +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountConnectionString +## Tags ### Properties -* **connectionString**: string (ReadOnly): Value of the connection string -* **description**: string (ReadOnly): Description of the connection string +### Additional Properties +* **Additional Properties Type**: string -## DatabaseAccountListKeysResult +## Tags ### Properties -* **primaryMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-write key. -* **primaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the primary read-only key. -* **secondaryMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-write key. -* **secondaryReadonlyMasterKey**: string (ReadOnly): Base 64 encoded value of the secondary read-only key. +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThroughputPolicyResource +### Properties +* **incrementPercent**: int: Represents the percentage by which throughput can increase every time throughput policy kicks in. +* **isEnabled**: bool: Determines whether the ThroughputPolicy is active or not + +## ThroughputSettingsResource +### Properties +* **_etag**: string (ReadOnly): A system generated property representing the resource etag required for optimistic concurrency control. +* **_rid**: string (ReadOnly): A system generated property. A unique identifier. +* **_ts**: int (ReadOnly): A system generated property that denotes the last updated timestamp of the resource. +* **autoscaleSettings**: [AutoscaleSettingsResource](#autoscalesettingsresource): Cosmos DB provisioned throughput settings object +* **minimumThroughput**: string (ReadOnly): The minimum throughput of the resource +* **offerReplacePending**: string (ReadOnly): The throughput replace is pending +* **throughput**: int: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. + +## ThroughputSettingsUpdateProperties +### Properties +* **resource**: [ThroughputSettingsResource](#throughputsettingsresource) (Required): Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. + +## UniqueKey +### Properties +* **paths**: string[]: List of paths must be unique for each document in the Azure Cosmos DB service + +## UniqueKeyPolicy +### Properties +* **uniqueKeys**: [UniqueKey](#uniquekey)[]: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. + +## VirtualNetworkRule +### Properties +* **id**: string: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. +* **ignoreMissingVNetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/cost-management/log.out b/generated/cost-management/log.out index 2e6162a250..6ac94f2bd5 100644 --- a/generated/cost-management/log.out +++ b/generated/cost-management/log.out @@ -25,7 +25,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.costmanagement-2022-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -50,10 +50,10 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.costmanagement-2022-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -78,7 +78,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 12ms @@ -106,7 +106,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GenerateDetailedCostReportDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.generatedetailedcostreport.json:223:5 @@ -129,7 +129,7 @@ warning | Modeler/MissingType | The schema 'AlertProperties-details-meterFilterI file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/AlertProperties-details-meterFilterItem warning | Modeler/MissingType | The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.costmanagement-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -154,7 +154,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-01-01/costmanagement.exports.json:406:5 @@ -177,7 +177,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefin warning | PreCheck/SchemaMissingType | The schema 'Status' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-01-01/costmanagement.generatedetailedcostreport.json:366:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.costmanagement-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -202,7 +202,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ReportConfigDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json:1136:5 @@ -298,7 +298,7 @@ warning | Modeler/MissingType | The schema 'QueryProperties-rows-itemsItem' has warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ReportConfigDefinition' -> 'ReportConfigDefinitionAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ReportConfigDataset' -> 'ReportConfigDatasetAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ReportConfigFilter' -> 'ReportConfigFilterAutoGenerated' -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.costmanagement-2020-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -323,7 +323,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2020-12-01-preview/costmanagement.exports.json:406:5 @@ -371,7 +371,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2020-03-01-preview/costallocation.json:253:5 @@ -401,7 +401,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ReportConfigDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json:1439:5 @@ -539,7 +539,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json:678:5 @@ -609,7 +609,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json:609:5 @@ -679,7 +679,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorBase' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json:594:5 @@ -724,7 +724,7 @@ warning | PreCheck/SchemaMissingType | The schema 'CurrentSpend' with an undefin warning | PreCheck/SchemaMissingType | The schema 'Notification' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json:1337:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.costmanagement-2019-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -749,7 +749,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json:585:5 @@ -819,7 +819,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorBase' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json:1928:5 @@ -873,7 +873,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem info | Resource type microsoft.costmanagement/externalsubscriptions under path '/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.costmanagement-2018-05-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -898,7 +898,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json:811:5 @@ -939,7 +939,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.costmanagement-2018-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -964,7 +964,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json:2717:9 @@ -1017,7 +1017,7 @@ warning | PreCheck/SchemaMissingType | The schema 'AlertProperties' with an unde warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.costmanagement-2018-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1042,7 +1042,7 @@ warning | DeprecatedConfig | Using directive.19.suppress which is deprecated and warning | DeprecatedConfig | Using directive.20.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.21.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json:1182:5 @@ -1074,4 +1074,4 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'QueryProperties-rows-itemsItem' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json#/components/schemas/QueryProperties-rows-itemsItem info | autorest.bicep took 0ms -info | Autorest completed in 45.08s. 28 files generated. +info | Autorest completed in 44.13s. 28 files generated. diff --git a/generated/cost-management/microsoft.costmanagement/2018-05-31/types.md b/generated/cost-management/microsoft.costmanagement/2018-05-31/types.md index 4536b77491..135a6794d3 100644 --- a/generated/cost-management/microsoft.costmanagement/2018-05-31/types.md +++ b/generated/cost-management/microsoft.costmanagement/2018-05-31/types.md @@ -10,19 +10,16 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags. * **type**: 'Microsoft.CostManagement/reportconfigs' (ReadOnly, DeployTimeConstant): The resource type -## ReportConfigProperties +## ReportConfigAggregation ### Properties -* **definition**: [ReportConfigDefinition](#reportconfigdefinition) (Required): The definition of a report config. -* **deliveryInfo**: [ReportConfigDeliveryInfo](#reportconfigdeliveryinfo) (Required): The delivery information associated with a report config. -* **format**: 'Csv' | string: The format of the report being delivered. -* **schedule**: [ReportConfigSchedule](#reportconfigschedule): The schedule associated with a report config. +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. -## ReportConfigDefinition +## ReportConfigComparisonExpression ### Properties -* **dataset**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. -* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. -* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. -* **type**: 'Usage' | string (Required): The type of the report. +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## ReportConfigDataset ### Properties @@ -37,15 +34,27 @@ ### Additional Properties * **Additional Properties Type**: [ReportConfigAggregation](#reportconfigaggregation) -## ReportConfigAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## ReportConfigDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. +## ReportConfigDefinition +### Properties +* **dataset**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. +* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. +* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. +* **type**: 'Usage' | string (Required): The type of the report. + +## ReportConfigDeliveryDestination +### Properties +* **container**: string (Required): The name of the container where reports will be uploaded. +* **resourceId**: string (Required): The resource id of the storage account where reports will be delivered. +* **rootFolderPath**: string: The name of the directory where reports will be uploaded. + +## ReportConfigDeliveryInfo +### Properties +* **destination**: [ReportConfigDeliveryDestination](#reportconfigdeliverydestination) (Required): The destination information for the delivery of the report. + ## ReportConfigFilter ### Properties * **and**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -54,31 +63,22 @@ * **or**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tag**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. -## ReportConfigComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## ReportConfigGrouping ### Properties * **columnType**: 'Dimension' | 'Tag' | string (Required): The type of the column in the report. * **name**: string (Required): The name of the column to group. -## ReportConfigTimePeriod -### Properties -* **from**: string (Required): The start date to pull data from. -* **to**: string (Required): The end date to pull data to. - -## ReportConfigDeliveryInfo +## ReportConfigProperties ### Properties -* **destination**: [ReportConfigDeliveryDestination](#reportconfigdeliverydestination) (Required): The destination information for the delivery of the report. +* **definition**: [ReportConfigDefinition](#reportconfigdefinition) (Required): The definition of a report config. +* **deliveryInfo**: [ReportConfigDeliveryInfo](#reportconfigdeliveryinfo) (Required): The delivery information associated with a report config. +* **format**: 'Csv' | string: The format of the report being delivered. +* **schedule**: [ReportConfigSchedule](#reportconfigschedule): The schedule associated with a report config. -## ReportConfigDeliveryDestination +## ReportConfigRecurrencePeriod ### Properties -* **container**: string (Required): The name of the container where reports will be uploaded. -* **resourceId**: string (Required): The resource id of the storage account where reports will be delivered. -* **rootFolderPath**: string: The name of the directory where reports will be uploaded. +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. If not provided, we default this to 10 years from the start date. ## ReportConfigSchedule ### Properties @@ -86,10 +86,10 @@ * **recurrencePeriod**: [ReportConfigRecurrencePeriod](#reportconfigrecurrenceperiod) (Required): The start and end date for recurrence schedule. * **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. -## ReportConfigRecurrencePeriod +## ReportConfigTimePeriod ### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. If not provided, we default this to 10 years from the start date. +* **from**: string (Required): The start date to pull data from. +* **to**: string (Required): The end date to pull data to. ## ResourceTags ### Properties diff --git a/generated/cost-management/microsoft.costmanagement/2018-08-01-preview/types.md b/generated/cost-management/microsoft.costmanagement/2018-08-01-preview/types.md index 82de471fad..06b80c659d 100644 --- a/generated/cost-management/microsoft.costmanagement/2018-08-01-preview/types.md +++ b/generated/cost-management/microsoft.costmanagement/2018-08-01-preview/types.md @@ -22,17 +22,11 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags. * **type**: 'Microsoft.CostManagement/reports' (ReadOnly, DeployTimeConstant): The resource type -## ConnectorProperties +## ConnectorCollectionErrorInfo ### Properties -* **collection**: [ConnectorCollectionInfo](#connectorcollectioninfo) (ReadOnly): Collection and ingestion information -* **createdOn**: string (ReadOnly): Connector definition creation datetime -* **credentialsKey**: string: Credentials authentication key (eg AWS ARN) -* **credentialsSecret**: string (WriteOnly): Credentials secret (eg AWS ExternalId) -* **displayName**: string: Connector DisplayName (defaults to Name) -* **modifiedOn**: string (ReadOnly): Connector last modified datetime -* **providerAccountId**: string (ReadOnly): Connector providerAccountId (determined from credentials) -* **reportId**: string: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) -* **status**: 'active' | 'error' | 'suspended' | string: Connector status +* **errorCode**: string (ReadOnly): Short error message +* **errorMessage**: string (ReadOnly): Detailed error message +* **errorStartTime**: string (ReadOnly): Time the error started occurring (Last time error occurred in lastRun) ## ConnectorCollectionInfo ### Properties @@ -41,30 +35,33 @@ * **lastUpdated**: string (ReadOnly): Last time the external data was updated into Azure * **sourceLastUpdated**: string (ReadOnly): Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) -## ConnectorCollectionErrorInfo -### Properties -* **errorCode**: string (ReadOnly): Short error message -* **errorMessage**: string (ReadOnly): Detailed error message -* **errorStartTime**: string (ReadOnly): Time the error started occurring (Last time error occurred in lastRun) - ## ConnectorDefinitionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ReportProperties +## ConnectorProperties ### Properties -* **definition**: [ReportDefinition](#reportdefinition) (Required): The definition of a report. -* **deliveryInfo**: [ReportDeliveryInfo](#reportdeliveryinfo) (Required): The delivery information associated with a report. -* **format**: 'Csv' | string: The format of the report being delivered. -* **schedule**: [ReportSchedule](#reportschedule): The schedule associated with a report. +* **collection**: [ConnectorCollectionInfo](#connectorcollectioninfo) (ReadOnly): Collection and ingestion information +* **createdOn**: string (ReadOnly): Connector definition creation datetime +* **credentialsKey**: string: Credentials authentication key (eg AWS ARN) +* **credentialsSecret**: string (WriteOnly): Credentials secret (eg AWS ExternalId) +* **displayName**: string: Connector DisplayName (defaults to Name) +* **modifiedOn**: string (ReadOnly): Connector last modified datetime +* **providerAccountId**: string (ReadOnly): Connector providerAccountId (determined from credentials) +* **reportId**: string: Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources) +* **status**: 'active' | 'error' | 'suspended' | string: Connector status -## ReportDefinition +## ReportAggregation ### Properties -* **dataset**: [ReportDataset](#reportdataset): The definition of data present in the report. -* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. -* **timePeriod**: [ReportTimePeriod](#reporttimeperiod): The start and end date for pulling data for the report. -* **type**: 'Usage' | string (Required): The type of the report. +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## ReportComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## ReportDataset ### Properties @@ -79,15 +76,27 @@ ### Additional Properties * **Additional Properties Type**: [ReportAggregation](#reportaggregation) -## ReportAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## ReportDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. +## ReportDefinition +### Properties +* **dataset**: [ReportDataset](#reportdataset): The definition of data present in the report. +* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. +* **timePeriod**: [ReportTimePeriod](#reporttimeperiod): The start and end date for pulling data for the report. +* **type**: 'Usage' | string (Required): The type of the report. + +## ReportDeliveryDestination +### Properties +* **container**: string (Required): The name of the container where reports will be uploaded. +* **resourceId**: string (Required): The resource id of the storage account where reports will be delivered. +* **rootFolderPath**: string: The name of the directory where reports will be uploaded. + +## ReportDeliveryInfo +### Properties +* **destination**: [ReportDeliveryDestination](#reportdeliverydestination) (Required): The destination information for the delivery of the report. + ## ReportFilter ### Properties * **and**: [ReportFilter](#reportfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -96,31 +105,22 @@ * **or**: [ReportFilter](#reportfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tag**: [ReportComparisonExpression](#reportcomparisonexpression): The comparison expression to be used in the report. -## ReportComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## ReportGrouping ### Properties * **name**: string (Required): The name of the column to group. * **type**: 'Dimension' | 'Tag' | string (Required): The type of the column in the report. -## ReportTimePeriod -### Properties -* **from**: string (Required): The start date to pull data from. -* **to**: string (Required): The end date to pull data to. - -## ReportDeliveryInfo +## ReportProperties ### Properties -* **destination**: [ReportDeliveryDestination](#reportdeliverydestination) (Required): The destination information for the delivery of the report. +* **definition**: [ReportDefinition](#reportdefinition) (Required): The definition of a report. +* **deliveryInfo**: [ReportDeliveryInfo](#reportdeliveryinfo) (Required): The delivery information associated with a report. +* **format**: 'Csv' | string: The format of the report being delivered. +* **schedule**: [ReportSchedule](#reportschedule): The schedule associated with a report. -## ReportDeliveryDestination +## ReportRecurrencePeriod ### Properties -* **container**: string (Required): The name of the container where reports will be uploaded. -* **resourceId**: string (Required): The resource id of the storage account where reports will be delivered. -* **rootFolderPath**: string: The name of the directory where reports will be uploaded. +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. ## ReportSchedule ### Properties @@ -128,10 +128,10 @@ * **recurrencePeriod**: [ReportRecurrencePeriod](#reportrecurrenceperiod): The start and end date for recurrence schedule. * **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. -## ReportRecurrencePeriod +## ReportTimePeriod ### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. +* **from**: string (Required): The start date to pull data from. +* **to**: string (Required): The end date to pull data to. ## ResourceTags ### Properties diff --git a/generated/cost-management/microsoft.costmanagement/2019-01-01/types.md b/generated/cost-management/microsoft.costmanagement/2019-01-01/types.md index 8cfa2dcb55..b23f612efc 100644 --- a/generated/cost-management/microsoft.costmanagement/2019-01-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2019-01-01/types.md @@ -10,6 +10,16 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags. * **type**: 'Microsoft.CostManagement/exports' (ReadOnly, DeployTimeConstant): The resource type +## ExportDeliveryDestination +### Properties +* **container**: string (Required): The name of the container where exports will be uploaded. +* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. +* **rootFolderPath**: string: The name of the directory where exports will be uploaded. + +## ExportDeliveryInfo +### Properties +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically. However, API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services . + ## ExportProperties ### Properties * **definition**: [QueryDefinition](#querydefinition) (Required): The definition of a query. @@ -17,12 +27,27 @@ * **format**: 'Csv' | string: The format of the export being delivered. * **schedule**: [ExportSchedule](#exportschedule): The schedule associated with a export. -## QueryDefinition +## ExportRecurrencePeriod ### Properties -* **dataset**: [QueryDataset](#querydataset): The definition of data present in the query. -* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'TheLastWeek' | 'TheLastYear' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. -* **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. -* **type**: 'Usage' | string (Required): The type of the query. +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. + +## ExportSchedule +### Properties +* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. +* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. +* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. + +## QueryAggregation +### Properties +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## QueryComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## QueryDataset ### Properties @@ -38,15 +63,17 @@ ### Additional Properties * **Additional Properties Type**: [QueryAggregation](#queryaggregation) -## QueryAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## QueryDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. +## QueryDefinition +### Properties +* **dataset**: [QueryDataset](#querydataset): The definition of data present in the query. +* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'TheLastWeek' | 'TheLastYear' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. +* **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. +* **type**: 'Usage' | string (Required): The type of the query. + ## QueryFilter ### Properties * **and**: [QueryFilter](#queryfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -55,12 +82,6 @@ * **or**: [QueryFilter](#queryfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tag**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. -## QueryComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## QueryGrouping ### Properties * **name**: string (Required): The name of the column to group. @@ -76,27 +97,6 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. -## ExportDeliveryInfo -### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically. However, API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services . - -## ExportDeliveryDestination -### Properties -* **container**: string (Required): The name of the container where exports will be uploaded. -* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. -* **rootFolderPath**: string: The name of the directory where exports will be uploaded. - -## ExportSchedule -### Properties -* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. -* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. -* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. - -## ExportRecurrencePeriod -### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/cost-management/microsoft.costmanagement/2019-03-01-preview/types.md b/generated/cost-management/microsoft.costmanagement/2019-03-01-preview/types.md index 0e38c09fab..8c6606f629 100644 --- a/generated/cost-management/microsoft.costmanagement/2019-03-01-preview/types.md +++ b/generated/cost-management/microsoft.costmanagement/2019-03-01-preview/types.md @@ -27,6 +27,20 @@ * **properties**: [ShowbackRuleProperties](#showbackruleproperties): The properties of a showback rule. * **type**: 'Microsoft.CostManagement/showbackRules' (ReadOnly, DeployTimeConstant): The resource type +## ConnectorCollectionErrorInfo +### Properties +* **errorCode**: string (ReadOnly): Short error code +* **errorInnerMessage**: string (ReadOnly): External Provider error message +* **errorMessage**: string (ReadOnly): Detailed error message +* **errorStartTime**: string (ReadOnly): Time the error started occurring (Last time error occurred in lastChecked) + +## ConnectorCollectionInfo +### Properties +* **error**: [ConnectorCollectionErrorInfo](#connectorcollectionerrorinfo): Details of any error encountered on last collection attempt +* **lastChecked**: string (ReadOnly): Last time the data acquisition process initiated connecting to the external provider +* **lastUpdated**: string (ReadOnly): Last time the external data was updated into Azure +* **sourceLastUpdated**: string (ReadOnly): Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) + ## ConnectorProperties ### Properties * **billingModel**: 'autoUpgrade' | 'expired' | 'premium' | 'trial' | string: Connector billing model @@ -45,19 +59,26 @@ * **status**: 'active' | 'error' | 'expired' | 'warning' | string (ReadOnly): Connector status * **subscriptionId**: string: Billing SubscriptionId -## ConnectorCollectionInfo +## CostAllocationDetails ### Properties -* **error**: [ConnectorCollectionErrorInfo](#connectorcollectionerrorinfo): Details of any error encountered on last collection attempt -* **lastChecked**: string (ReadOnly): Last time the data acquisition process initiated connecting to the external provider -* **lastUpdated**: string (ReadOnly): Last time the external data was updated into Azure -* **sourceLastUpdated**: string (ReadOnly): Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) +* **policy**: 'Evenly' | 'Fixed' | 'Proportional' | string: Cost allocation policy. -## ConnectorCollectionErrorInfo +## CustomPriceDetails ### Properties -* **errorCode**: string (ReadOnly): Short error code -* **errorInnerMessage**: string (ReadOnly): External Provider error message -* **errorMessage**: string (ReadOnly): Detailed error message -* **errorStartTime**: string (ReadOnly): Time the error started occurring (Last time error occurred in lastChecked) +* **benefits**: 'AHUB' | 'All' | 'None' | 'Reservations' | 'Sum' | string[]: Array of benefits. +* **markups**: [Markup](#markup)[]: List of markups. +* **pricesheet**: string + +## Markup +### Properties +* **percentage**: string + +## Scope +### Properties +* **childScope**: [Scope](#scope): The Scope model definition +* **id**: string: Scope id +* **name**: string: Scope name +* **type**: string: Scope type ## ShowbackRuleProperties * **Discriminator**: ruleType @@ -81,24 +102,3 @@ * **ruleType**: 'CustomPrice' (Required): The rule type of the showback rule solution. -## Scope -### Properties -* **childScope**: [Scope](#scope): The Scope model definition -* **id**: string: Scope id -* **name**: string: Scope name -* **type**: string: Scope type - -## CostAllocationDetails -### Properties -* **policy**: 'Evenly' | 'Fixed' | 'Proportional' | string: Cost allocation policy. - -## CustomPriceDetails -### Properties -* **benefits**: 'AHUB' | 'All' | 'None' | 'Reservations' | 'Sum' | string[]: Array of benefits. -* **markups**: [Markup](#markup)[]: List of markups. -* **pricesheet**: string - -## Markup -### Properties -* **percentage**: string - diff --git a/generated/cost-management/microsoft.costmanagement/2019-04-01-preview/types.md b/generated/cost-management/microsoft.costmanagement/2019-04-01-preview/types.md index d0edda4930..cf23e567a5 100644 --- a/generated/cost-management/microsoft.costmanagement/2019-04-01-preview/types.md +++ b/generated/cost-management/microsoft.costmanagement/2019-04-01-preview/types.md @@ -30,56 +30,20 @@ * **timeGrain**: 'Annually' | 'Monthly' | 'Quarterly' | string (Required): The time covered by a budget. Tracking of the amount will be reset based on the time grain. * **timePeriod**: [BudgetTimePeriod](#budgettimeperiod) (Required): The start and end date for a budget. -## CurrentSpend -### Properties -* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. -* **unit**: string (ReadOnly): The unit of measure for the budget amount. - -## ReportConfigFilter -### Properties -* **and**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "AND" expression. Must have at least 2 items. -* **dimension**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. -* **not**: [ReportConfigFilter](#reportconfigfilter): The filter expression to be used in the report. -* **or**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "OR" expression. Must have at least 2 items. -* **tag**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. - -## ReportConfigComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## BudgetPropertiesNotifications ### Properties ### Additional Properties * **Additional Properties Type**: [Notification](#notification) -## Notification -### Properties -* **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. -* **contactGroups**: string[]: Action groups to send the budget notification to when the threshold is exceeded. -* **contactRoles**: string[]: Contact roles to send the budget notification to when the threshold is exceeded. -* **enabled**: bool (Required): The notification is enabled or not. -* **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. -* **threshold**: int (Required): 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. - ## BudgetTimePeriod ### Properties * **endDate**: string: The end date for the budget. If not provided, we default this to 10 years from the start date. * **startDate**: string (Required): The start date for the budget. -## ViewProperties +## CurrentSpend ### Properties -* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. -* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. -* **createdOn**: string (ReadOnly): Date the user created this view. -* **displayName**: string: User input name of the view. Required. -* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. -* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. -* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. -* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. -* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. -* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. +* **amount**: int (ReadOnly): The total amount of cost which is being tracked by the budget. +* **unit**: string (ReadOnly): The unit of measure for the budget amount. ## KpiProperties ### Properties @@ -87,17 +51,30 @@ * **id**: string: ID of resource related to metric (budget). * **type**: 'Budget' | 'Forecast' | string: KPI type (Forecast, Budget). +## Notification +### Properties +* **contactEmails**: string[] (Required): Email addresses to send the budget notification to when the threshold is exceeded. +* **contactGroups**: string[]: Action groups to send the budget notification to when the threshold is exceeded. +* **contactRoles**: string[]: Contact roles to send the budget notification to when the threshold is exceeded. +* **enabled**: bool (Required): The notification is enabled or not. +* **operator**: 'EqualTo' | 'GreaterThan' | 'GreaterThanOrEqualTo' | string (Required): The comparison operator. +* **threshold**: int (Required): 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. + ## PivotProperties ### Properties * **name**: string: Data field to show in view. * **type**: 'Dimension' | 'TagKey' | string: Data type to show in view. -## ReportConfigDefinition +## ReportConfigAggregation ### Properties -* **dataset**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. -* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. -* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. -* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## ReportConfigComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## ReportConfigDataset ### Properties @@ -113,15 +90,25 @@ ### Additional Properties * **Additional Properties Type**: [ReportConfigAggregation](#reportconfigaggregation) -## ReportConfigAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## ReportConfigDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. +## ReportConfigDefinition +### Properties +* **dataset**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. +* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. +* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. +* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. + +## ReportConfigFilter +### Properties +* **and**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "AND" expression. Must have at least 2 items. +* **dimension**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. +* **not**: [ReportConfigFilter](#reportconfigfilter): The filter expression to be used in the report. +* **or**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "OR" expression. Must have at least 2 items. +* **tag**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. + ## ReportConfigGrouping ### Properties * **name**: string (Required): The name of the column to group. This version supports subscription lowest possible grain. @@ -137,3 +124,16 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. +## ViewProperties +### Properties +* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. +* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. +* **createdOn**: string (ReadOnly): Date the user created this view. +* **displayName**: string: User input name of the view. Required. +* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. +* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. +* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. +* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. +* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. +* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. + diff --git a/generated/cost-management/microsoft.costmanagement/2019-09-01/types.md b/generated/cost-management/microsoft.costmanagement/2019-09-01/types.md index 12f9f0d052..700aadaf52 100644 --- a/generated/cost-management/microsoft.costmanagement/2019-09-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2019-09-01/types.md @@ -10,6 +10,16 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags. * **type**: 'Microsoft.CostManagement/exports' (ReadOnly, DeployTimeConstant): The resource type +## ExportDeliveryDestination +### Properties +* **container**: string (Required): The name of the container where exports will be uploaded. +* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. +* **rootFolderPath**: string: The name of the directory where exports will be uploaded. + +## ExportDeliveryInfo +### Properties +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. + ## ExportProperties ### Properties * **definition**: [QueryDefinition](#querydefinition) (Required): The definition of a query. @@ -17,12 +27,27 @@ * **format**: 'Csv' | string: The format of the export being delivered. * **schedule**: [ExportSchedule](#exportschedule): The schedule associated with a export. -## QueryDefinition +## ExportRecurrencePeriod ### Properties -* **dataset**: [QueryDataset](#querydataset): The definition of data present in the query. -* **timeframe**: 'Custom' | 'MonthToDate' | 'TheLastMonth' | 'TheLastWeek' | 'TheLastYear' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. -* **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. -* **type**: 'Usage' | string (Required): The type of the query. +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. + +## ExportSchedule +### Properties +* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. +* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. +* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. + +## QueryAggregation +### Properties +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## QueryComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## QueryDataset ### Properties @@ -38,15 +63,17 @@ ### Additional Properties * **Additional Properties Type**: [QueryAggregation](#queryaggregation) -## QueryAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## QueryDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. +## QueryDefinition +### Properties +* **dataset**: [QueryDataset](#querydataset): The definition of data present in the query. +* **timeframe**: 'Custom' | 'MonthToDate' | 'TheLastMonth' | 'TheLastWeek' | 'TheLastYear' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. +* **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. +* **type**: 'Usage' | string (Required): The type of the query. + ## QueryFilter ### Properties * **and**: [QueryFilter](#queryfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -55,12 +82,6 @@ * **or**: [QueryFilter](#queryfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tag**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. -## QueryComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## QueryGrouping ### Properties * **name**: string (Required): The name of the column to group. @@ -76,27 +97,6 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. -## ExportDeliveryInfo -### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. - -## ExportDeliveryDestination -### Properties -* **container**: string (Required): The name of the container where exports will be uploaded. -* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. -* **rootFolderPath**: string: The name of the directory where exports will be uploaded. - -## ExportSchedule -### Properties -* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. -* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. -* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. - -## ExportRecurrencePeriod -### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/cost-management/microsoft.costmanagement/2019-10-01/types.md b/generated/cost-management/microsoft.costmanagement/2019-10-01/types.md index 5bb35314ed..c889a70b70 100644 --- a/generated/cost-management/microsoft.costmanagement/2019-10-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2019-10-01/types.md @@ -10,6 +10,16 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags. * **type**: 'Microsoft.CostManagement/exports' (ReadOnly, DeployTimeConstant): The resource type +## ExportDeliveryDestination +### Properties +* **container**: string (Required): The name of the container where exports will be uploaded. +* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. +* **rootFolderPath**: string: The name of the directory where exports will be uploaded. + +## ExportDeliveryInfo +### Properties +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. + ## ExportProperties ### Properties * **definition**: [QueryDefinition](#querydefinition) (Required): The definition of a query. @@ -17,12 +27,27 @@ * **format**: 'Csv' | string: The format of the export being delivered. * **schedule**: [ExportSchedule](#exportschedule): The schedule associated with a export. -## QueryDefinition +## ExportRecurrencePeriod ### Properties -* **dataset**: [QueryDataset](#querydataset): The definition of data present in the query. -* **timeframe**: 'Custom' | 'MonthToDate' | 'TheLastMonth' | 'TheLastWeek' | 'TheLastYear' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. -* **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. -* **type**: 'Usage' | string (Required): The type of the query. +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. + +## ExportSchedule +### Properties +* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. +* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. +* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. + +## QueryAggregation +### Properties +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## QueryComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## QueryDataset ### Properties @@ -38,15 +63,17 @@ ### Additional Properties * **Additional Properties Type**: [QueryAggregation](#queryaggregation) -## QueryAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## QueryDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. +## QueryDefinition +### Properties +* **dataset**: [QueryDataset](#querydataset): The definition of data present in the query. +* **timeframe**: 'Custom' | 'MonthToDate' | 'TheLastMonth' | 'TheLastWeek' | 'TheLastYear' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. +* **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. +* **type**: 'Usage' | string (Required): The type of the query. + ## QueryFilter ### Properties * **and**: [QueryFilter](#queryfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -55,12 +82,6 @@ * **or**: [QueryFilter](#queryfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tag**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. -## QueryComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## QueryGrouping ### Properties * **name**: string (Required): The name of the column to group. @@ -76,27 +97,6 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. -## ExportDeliveryInfo -### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. - -## ExportDeliveryDestination -### Properties -* **container**: string (Required): The name of the container where exports will be uploaded. -* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. -* **rootFolderPath**: string: The name of the directory where exports will be uploaded. - -## ExportSchedule -### Properties -* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. -* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. -* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. - -## ExportRecurrencePeriod -### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/cost-management/microsoft.costmanagement/2019-11-01/types.md b/generated/cost-management/microsoft.costmanagement/2019-11-01/types.md index 4c1085f473..f72e6d859d 100644 --- a/generated/cost-management/microsoft.costmanagement/2019-11-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2019-11-01/types.md @@ -30,12 +30,14 @@ * **properties**: [ViewProperties](#viewproperties): The properties of the view. * **type**: 'Microsoft.CostManagement/views' (ReadOnly, DeployTimeConstant): The resource type -## ExportProperties +## CacheItem ### Properties -* **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of a query. -* **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. -* **format**: 'Csv' | string: The format of the export being delivered. -* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with a export. +* **channel**: string (Required): Indicates the account type. Allowed values include: EA, PAYG, Modern, Internal, Unknown. +* **id**: string (Required): Resource ID used by Resource Manager to uniquely identify the scope. +* **name**: string (Required): Display name for the scope. +* **parent**: string: Resource ID of the parent scope. For instance, subscription's resource ID for a resource group or a management group resource ID for a subscription. +* **status**: string: Indicates the status of the scope. Status only applies to subscriptions and billing accounts. +* **subchannel**: string (Required): Indicates the type of modern account. Allowed values include: Individual, Enterprise, Partner, Indirect, NotApplicable ## ExportDefinition ### Properties @@ -44,120 +46,100 @@ * **timePeriod**: [QueryTimePeriod](#querytimeperiod): The start and end date for pulling data for the query. * **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the query. -## QueryDatasetAutoGenerated -### Properties -* **aggregation**: [QueryDatasetAggregation](#querydatasetaggregation): Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses. -* **configuration**: [QueryDatasetConfiguration](#querydatasetconfiguration): The configuration of dataset in the query. -* **filter**: [QueryFilterAutoGenerated](#queryfilterautogenerated): The filter expression to be used in the export. -* **granularity**: 'Daily' | string: The granularity of rows in the query. -* **grouping**: [QueryGrouping](#querygrouping)[]: Array of group by expression to use in the query. Query can have up to 2 group by clauses. - -## QueryDatasetAggregation +## ExportDeliveryDestination ### Properties -### Additional Properties -* **Additional Properties Type**: [QueryAggregation](#queryaggregation) +* **container**: string (Required): The name of the container where exports will be uploaded. +* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. +* **rootFolderPath**: string: The name of the directory where exports will be uploaded. -## QueryAggregation +## ExportDeliveryInfo ### Properties -* **function**: 'Avg' | 'Max' | 'Min' | 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services . -## QueryDatasetConfiguration +## ExportProperties ### Properties -* **columns**: string[]: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. +* **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of a query. +* **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. +* **format**: 'Csv' | string: The format of the export being delivered. +* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with a export. -## QueryFilterAutoGenerated +## ExportRecurrencePeriod ### Properties -* **and**: [QueryFilterAutoGenerated](#queryfilterautogenerated)[]: The logical "AND" expression. Must have at least 2 items. -* **dimensions**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. -* **or**: [QueryFilterAutoGenerated](#queryfilterautogenerated)[]: The logical "OR" expression. Must have at least 2 items. -* **tags**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. -## QueryComparisonExpression +## ExportSchedule ### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison +* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. +* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. +* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. -## QueryGrouping +## KpiProperties ### Properties -* **name**: string (Required): The name of the column to group. -* **type**: 'Dimension' | 'Tag' | string (Required): The type of the column in the export. +* **enabled**: bool: show the KPI in the UI? +* **id**: string: ID of resource related to metric (budget). +* **type**: 'Budget' | 'Forecast' | string: KPI type (Forecast, Budget). -## QueryTimePeriod +## PivotProperties ### Properties -* **from**: string (Required): The start date to pull data from. -* **to**: string (Required): The end date to pull data to. +* **name**: string: Data field to show in view. +* **type**: 'Dimension' | 'TagKey' | string: Data type to show in view. -## ExportDeliveryInfo +## QueryAggregation ### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services . +* **function**: 'Avg' | 'Max' | 'Min' | 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. -## ExportDeliveryDestination +## QueryComparisonExpression ### Properties -* **container**: string (Required): The name of the container where exports will be uploaded. -* **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. -* **rootFolderPath**: string: The name of the directory where exports will be uploaded. +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison -## ExportSchedule +## QueryDatasetAggregation ### Properties -* **recurrence**: 'Annually' | 'Daily' | 'Monthly' | 'Weekly' | string (Required): The schedule recurrence. -* **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. -* **status**: 'Active' | 'Inactive' | string: The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused. +### Additional Properties +* **Additional Properties Type**: [QueryAggregation](#queryaggregation) -## ExportRecurrencePeriod +## QueryDatasetAutoGenerated ### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. +* **aggregation**: [QueryDatasetAggregation](#querydatasetaggregation): Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses. +* **configuration**: [QueryDatasetConfiguration](#querydatasetconfiguration): The configuration of dataset in the query. +* **filter**: [QueryFilterAutoGenerated](#queryfilterautogenerated): The filter expression to be used in the export. +* **granularity**: 'Daily' | string: The granularity of rows in the query. +* **grouping**: [QueryGrouping](#querygrouping)[]: Array of group by expression to use in the query. Query can have up to 2 group by clauses. -## SettingsProperties +## QueryDatasetConfiguration ### Properties -* **cache**: [CacheItem](#cacheitem)[]: Array of scopes with additional details used by Cost Management in the Azure portal. -* **scope**: string (Required): Sets the default scope the current user will see when they sign into Azure Cost Management in the Azure portal. -* **startOn**: 'LastUsed' | 'ScopePicker' | 'SpecificScope' | string: Indicates what scope Cost Management in the Azure portal should default to. Allowed values: LastUsed. +* **columns**: string[]: Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns. -## CacheItem +## QueryFilterAutoGenerated ### Properties -* **channel**: string (Required): Indicates the account type. Allowed values include: EA, PAYG, Modern, Internal, Unknown. -* **id**: string (Required): Resource ID used by Resource Manager to uniquely identify the scope. -* **name**: string (Required): Display name for the scope. -* **parent**: string: Resource ID of the parent scope. For instance, subscription's resource ID for a resource group or a management group resource ID for a subscription. -* **status**: string: Indicates the status of the scope. Status only applies to subscriptions and billing accounts. -* **subchannel**: string (Required): Indicates the type of modern account. Allowed values include: Individual, Enterprise, Partner, Indirect, NotApplicable +* **and**: [QueryFilterAutoGenerated](#queryfilterautogenerated)[]: The logical "AND" expression. Must have at least 2 items. +* **dimensions**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. +* **or**: [QueryFilterAutoGenerated](#queryfilterautogenerated)[]: The logical "OR" expression. Must have at least 2 items. +* **tags**: [QueryComparisonExpression](#querycomparisonexpression): The comparison expression to be used in the query. -## ViewProperties +## QueryGrouping ### Properties -* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. -* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. -* **createdOn**: string (ReadOnly): Date the user created this view. -* **currency**: string (ReadOnly): Selected currency. -* **dateRange**: string (ReadOnly): Selected date range for viewing cost in. -* **displayName**: string: User input name of the view. Required. -* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. -* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. -* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. -* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. -* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. -* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. +* **name**: string (Required): The name of the column to group. +* **type**: 'Dimension' | 'Tag' | string (Required): The type of the column in the export. -## KpiProperties +## QueryTimePeriod ### Properties -* **enabled**: bool: show the KPI in the UI? -* **id**: string: ID of resource related to metric (budget). -* **type**: 'Budget' | 'Forecast' | string: KPI type (Forecast, Budget). +* **from**: string (Required): The start date to pull data from. +* **to**: string (Required): The end date to pull data to. -## PivotProperties +## ReportConfigAggregation ### Properties -* **name**: string: Data field to show in view. -* **type**: 'Dimension' | 'TagKey' | string: Data type to show in view. +* **function**: 'Avg' | 'Max' | 'Min' | 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. -## ReportConfigDefinition +## ReportConfigComparisonExpression ### Properties -* **dataSet**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. -* **includeMonetaryCommitment**: bool (ReadOnly): Include monetary commitment -* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. -* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. -* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## ReportConfigDataset ### Properties @@ -173,15 +155,18 @@ ### Additional Properties * **Additional Properties Type**: [ReportConfigAggregation](#reportconfigaggregation) -## ReportConfigAggregation -### Properties -* **function**: 'Avg' | 'Max' | 'Min' | 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## ReportConfigDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. +## ReportConfigDefinition +### Properties +* **dataSet**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. +* **includeMonetaryCommitment**: bool (ReadOnly): Include monetary commitment +* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. +* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. +* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. + ## ReportConfigFilter ### Properties * **and**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -191,12 +176,6 @@ * **tags**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. * **tagValue**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. -## ReportConfigComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## ReportConfigGrouping ### Properties * **name**: string (Required): The name of the column to group. This version supports subscription lowest possible grain. @@ -212,3 +191,24 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. +## SettingsProperties +### Properties +* **cache**: [CacheItem](#cacheitem)[]: Array of scopes with additional details used by Cost Management in the Azure portal. +* **scope**: string (Required): Sets the default scope the current user will see when they sign into Azure Cost Management in the Azure portal. +* **startOn**: 'LastUsed' | 'ScopePicker' | 'SpecificScope' | string: Indicates what scope Cost Management in the Azure portal should default to. Allowed values: LastUsed. + +## ViewProperties +### Properties +* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. +* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. +* **createdOn**: string (ReadOnly): Date the user created this view. +* **currency**: string (ReadOnly): Selected currency. +* **dateRange**: string (ReadOnly): Selected date range for viewing cost in. +* **displayName**: string: User input name of the view. Required. +* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. +* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. +* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. +* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. +* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. +* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. + diff --git a/generated/cost-management/microsoft.costmanagement/2020-03-01-preview/types.md b/generated/cost-management/microsoft.costmanagement/2020-03-01-preview/types.md index d1c3247d6f..8a4ce10d1d 100644 --- a/generated/cost-management/microsoft.costmanagement/2020-03-01-preview/types.md +++ b/generated/cost-management/microsoft.costmanagement/2020-03-01-preview/types.md @@ -9,6 +9,16 @@ * **properties**: [CostAllocationRuleProperties](#costallocationruleproperties): The properties of a cost allocation rule * **type**: 'Microsoft.CostManagement/costAllocationRules' (ReadOnly, DeployTimeConstant): The resource type +## CostAllocationProportion +### Properties +* **name**: string (Required): Target resource for cost allocation +* **percentage**: int (Required): Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00. + +## CostAllocationRuleDetails +### Properties +* **sourceResources**: [SourceCostAllocationResource](#sourcecostallocationresource)[]: Source resources for cost allocation. At this time, this list can contain no more than one element. +* **targetResources**: [TargetCostAllocationResource](#targetcostallocationresource)[]: Target resources for cost allocation. At this time, this list can contain no more than one element. + ## CostAllocationRuleProperties ### Properties * **createdDate**: string (ReadOnly): Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. @@ -17,11 +27,6 @@ * **status**: 'Active' | 'NotActive' | 'Processing' | string (Required): Current status of the rule. * **updatedDate**: string (ReadOnly): Time at which the rule was last updated. -## CostAllocationRuleDetails -### Properties -* **sourceResources**: [SourceCostAllocationResource](#sourcecostallocationresource)[]: Source resources for cost allocation. At this time, this list can contain no more than one element. -* **targetResources**: [TargetCostAllocationResource](#targetcostallocationresource)[]: Target resources for cost allocation. At this time, this list can contain no more than one element. - ## SourceCostAllocationResource ### Properties * **name**: string (Required): If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag @@ -35,8 +40,3 @@ * **resourceType**: 'Dimension' | 'Tag' | string (Required): Category of resource to use for allocation. * **values**: [CostAllocationProportion](#costallocationproportion)[] (Required): Target resources for cost allocation. This list cannot contain more than 25 values. -## CostAllocationProportion -### Properties -* **name**: string (Required): Target resource for cost allocation -* **percentage**: int (Required): Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00. - diff --git a/generated/cost-management/microsoft.costmanagement/2020-06-01/types.md b/generated/cost-management/microsoft.costmanagement/2020-06-01/types.md index 69d572d754..ce829c6c2d 100644 --- a/generated/cost-management/microsoft.costmanagement/2020-06-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2020-06-01/types.md @@ -20,21 +20,18 @@ * **properties**: [ViewProperties](#viewproperties): The properties of the view. * **type**: 'Microsoft.CostManagement/views' (ReadOnly, DeployTimeConstant): The resource type -## ExportProperties +## CommonExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. * **format**: 'Csv' | string: The format of the export being delivered. Currently only 'Csv' is supported. * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. -* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. -## ExportDefinition +## ErrorDetails ### Properties -* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. -* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. -* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. -* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the query. +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message indicating why the operation failed. ## ExportDataset ### Properties @@ -45,14 +42,12 @@ ### Properties * **columns**: string[]: Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples). -## ExportTimePeriod -### Properties -* **from**: string (Required): The start date for export data. -* **to**: string (Required): The end date for export data. - -## ExportDeliveryInfo +## ExportDefinition ### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services . +* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. +* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. +* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. +* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the query. ## ExportDeliveryDestination ### Properties @@ -60,9 +55,9 @@ * **resourceId**: string (Required): The resource id of the storage account where exports will be delivered. * **rootFolderPath**: string: The name of the directory where exports will be uploaded. -## ExportExecutionListResult +## ExportDeliveryInfo ### Properties -* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services . ## ExportExecution ### Properties @@ -72,6 +67,10 @@ * **properties**: [ExportExecutionProperties](#exportexecutionproperties): The properties of the export execution. * **type**: string (ReadOnly): Resource type. +## ExportExecutionListResult +### Properties +* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. + ## ExportExecutionProperties ### Properties * **error**: [ErrorDetails](#errordetails): The details of the error. @@ -84,18 +83,19 @@ * **submittedBy**: string: The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'. * **submittedTime**: string: The time when export was queued to be executed. -## ErrorDetails -### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message indicating why the operation failed. - -## CommonExportProperties +## ExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. * **format**: 'Csv' | string: The format of the export being delivered. Currently only 'Csv' is supported. * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. +* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. + +## ExportRecurrencePeriod +### Properties +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. ## ExportSchedule ### Properties @@ -103,23 +103,10 @@ * **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. * **status**: 'Active' | 'Inactive' | string: The status of the export's schedule. If 'Inactive', the export's schedule is paused. -## ExportRecurrencePeriod -### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. - -## ViewProperties +## ExportTimePeriod ### Properties -* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. -* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. -* **createdOn**: string (ReadOnly): Date the user created this view. -* **displayName**: string: User input name of the view. Required. -* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. -* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. -* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. -* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. -* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. -* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. +* **from**: string (Required): The start date for export data. +* **to**: string (Required): The end date for export data. ## KpiProperties ### Properties @@ -132,12 +119,16 @@ * **name**: string: Data field to show in view. * **type**: 'Dimension' | 'TagKey' | string: Data type to show in view. -## ReportConfigDefinition +## ReportConfigAggregation ### Properties -* **dataset**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. -* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. -* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. -* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## ReportConfigComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## ReportConfigDataset ### Properties @@ -153,15 +144,17 @@ ### Additional Properties * **Additional Properties Type**: [ReportConfigAggregation](#reportconfigaggregation) -## ReportConfigAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## ReportConfigDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. +## ReportConfigDefinition +### Properties +* **dataset**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. +* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. +* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. +* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. + ## ReportConfigFilter ### Properties * **and**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -170,12 +163,6 @@ * **or**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tag**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. -## ReportConfigComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## ReportConfigGrouping ### Properties * **name**: string (Required): The name of the column to group. This version supports subscription lowest possible grain. @@ -191,3 +178,16 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. +## ViewProperties +### Properties +* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. +* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. +* **createdOn**: string (ReadOnly): Date the user created this view. +* **displayName**: string: User input name of the view. Required. +* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. +* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. +* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. +* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. +* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. +* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. + diff --git a/generated/cost-management/microsoft.costmanagement/2020-12-01-preview/types.md b/generated/cost-management/microsoft.costmanagement/2020-12-01-preview/types.md index 1fe5c4e315..e823ab6fc0 100644 --- a/generated/cost-management/microsoft.costmanagement/2020-12-01-preview/types.md +++ b/generated/cost-management/microsoft.costmanagement/2020-12-01-preview/types.md @@ -10,21 +10,18 @@ * **properties**: [ExportProperties](#exportproperties): The properties of the export. * **type**: 'Microsoft.CostManagement/exports' (ReadOnly, DeployTimeConstant): The resource type -## ExportProperties +## CommonExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. * **format**: 'Csv' | string: The format of the export being delivered. Currently only 'Csv' is supported. * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. -* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. -## ExportDefinition +## ErrorDetails ### Properties -* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. -* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the export. If custom, then a specific time period must be provided. -* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. -* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message indicating why the operation failed. ## ExportDataset ### Properties @@ -35,14 +32,12 @@ ### Properties * **columns**: string[]: Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples). -## ExportTimePeriod -### Properties -* **from**: string (Required): The start date for export data. -* **to**: string (Required): The end date for export data. - -## ExportDeliveryInfo +## ExportDefinition ### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Azure Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). +* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. +* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the export. If custom, then a specific time period must be provided. +* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. +* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. ## ExportDeliveryDestination ### Properties @@ -52,9 +47,9 @@ * **sasToken**: string (WriteOnly): A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified. * **storageAccount**: string: The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId. -## ExportExecutionListResult +## ExportDeliveryInfo ### Properties -* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Azure Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). ## ExportExecution ### Properties @@ -64,6 +59,10 @@ * **properties**: [ExportExecutionProperties](#exportexecutionproperties): The properties of the export execution. * **type**: string (ReadOnly): Resource type. +## ExportExecutionListResult +### Properties +* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. + ## ExportExecutionProperties ### Properties * **error**: [ErrorDetails](#errordetails): The details of the error. @@ -76,18 +75,19 @@ * **submittedBy**: string: The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'. * **submittedTime**: string: The time when export was queued to be executed. -## ErrorDetails -### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message indicating why the operation failed. - -## CommonExportProperties +## ExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. * **format**: 'Csv' | string: The format of the export being delivered. Currently only 'Csv' is supported. * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. +* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. + +## ExportRecurrencePeriod +### Properties +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. ## ExportSchedule ### Properties @@ -95,8 +95,8 @@ * **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. * **status**: 'Active' | 'Inactive' | string: The status of the export's schedule. If 'Inactive', the export's schedule is paused. -## ExportRecurrencePeriod +## ExportTimePeriod ### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. +* **from**: string (Required): The start date for export data. +* **to**: string (Required): The end date for export data. diff --git a/generated/cost-management/microsoft.costmanagement/2021-01-01/types.md b/generated/cost-management/microsoft.costmanagement/2021-01-01/types.md index 203c3bec60..71ad361bde 100644 --- a/generated/cost-management/microsoft.costmanagement/2021-01-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2021-01-01/types.md @@ -10,7 +10,7 @@ * **properties**: [ExportProperties](#exportproperties): The properties of the export. * **type**: 'Microsoft.CostManagement/exports' (ReadOnly, DeployTimeConstant): The resource type -## ExportProperties +## CommonExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. @@ -18,14 +18,11 @@ * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **partitionData**: bool: If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for modern commerce scopes. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. -* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. -## ExportDefinition +## ErrorDetails ### Properties -* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. -* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the export. If custom, then a specific time period must be provided. -* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. -* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message indicating why the operation failed. ## ExportDataset ### Properties @@ -36,14 +33,12 @@ ### Properties * **columns**: string[]: Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples). -## ExportTimePeriod -### Properties -* **from**: string (Required): The start date for export data. -* **to**: string (Required): The end date for export data. - -## ExportDeliveryInfo +## ExportDefinition ### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Azure Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). +* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. +* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the export. If custom, then a specific time period must be provided. +* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. +* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. ## ExportDeliveryDestination ### Properties @@ -53,9 +48,9 @@ * **sasToken**: string (WriteOnly): A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified. * **storageAccount**: string: The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId. -## ExportExecutionListResult +## ExportDeliveryInfo ### Properties -* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Azure Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). ## ExportExecution ### Properties @@ -65,6 +60,10 @@ * **properties**: [ExportExecutionProperties](#exportexecutionproperties): The properties of the export execution. * **type**: string (ReadOnly): Resource type. +## ExportExecutionListResult +### Properties +* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. + ## ExportExecutionProperties ### Properties * **error**: [ErrorDetails](#errordetails): The details of the error. @@ -77,12 +76,7 @@ * **submittedBy**: string: The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'. * **submittedTime**: string: The time when export was queued to be executed. -## ErrorDetails -### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message indicating why the operation failed. - -## CommonExportProperties +## ExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. @@ -90,6 +84,12 @@ * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **partitionData**: bool: If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for modern commerce scopes. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. +* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. + +## ExportRecurrencePeriod +### Properties +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. ## ExportSchedule ### Properties @@ -97,8 +97,8 @@ * **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. * **status**: 'Active' | 'Inactive' | string: The status of the export's schedule. If 'Inactive', the export's schedule is paused. -## ExportRecurrencePeriod +## ExportTimePeriod ### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. +* **from**: string (Required): The start date for export data. +* **to**: string (Required): The end date for export data. diff --git a/generated/cost-management/microsoft.costmanagement/2021-10-01/types.md b/generated/cost-management/microsoft.costmanagement/2021-10-01/types.md index d083270676..23d68f0570 100644 --- a/generated/cost-management/microsoft.costmanagement/2021-10-01/types.md +++ b/generated/cost-management/microsoft.costmanagement/2021-10-01/types.md @@ -20,7 +20,7 @@ * **properties**: [ViewProperties](#viewproperties): The properties of the view. * **type**: 'Microsoft.CostManagement/views' (ReadOnly, DeployTimeConstant): The resource type -## ExportProperties +## CommonExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. @@ -28,14 +28,11 @@ * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **partitionData**: bool: If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for modern commerce scopes. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. -* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. -## ExportDefinition +## ErrorDetails ### Properties -* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. -* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. -* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. -* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the query. +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message indicating why the operation failed. ## ExportDataset ### Properties @@ -46,14 +43,12 @@ ### Properties * **columns**: string[]: Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples). -## ExportTimePeriod -### Properties -* **from**: string (Required): The start date for export data. -* **to**: string (Required): The end date for export data. - -## ExportDeliveryInfo +## ExportDefinition ### Properties -* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). +* **dataSet**: [ExportDataset](#exportdataset): The definition for data in the export. +* **timeframe**: 'BillingMonthToDate' | 'Custom' | 'MonthToDate' | 'TheLastBillingMonth' | 'TheLastMonth' | 'WeekToDate' | string (Required): The time frame for pulling data for the query. If custom, then a specific time period must be provided. +* **timePeriod**: [ExportTimePeriod](#exporttimeperiod): The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. +* **type**: 'ActualCost' | 'AmortizedCost' | 'Usage' | string (Required): The type of the query. ## ExportDeliveryDestination ### Properties @@ -63,9 +58,9 @@ * **sasToken**: string: A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified. * **storageAccount**: string: The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId. -## ExportExecutionListResult +## ExportDeliveryInfo ### Properties -* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. +* **destination**: [ExportDeliveryDestination](#exportdeliverydestination) (Required): This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). ## ExportExecution ### Properties @@ -75,6 +70,10 @@ * **properties**: [ExportExecutionProperties](#exportexecutionproperties): The properties of the export execution. * **type**: string (ReadOnly): Resource type. +## ExportExecutionListResult +### Properties +* **value**: [ExportExecution](#exportexecution)[] (ReadOnly): A list of export executions. + ## ExportExecutionProperties ### Properties * **error**: [ErrorDetails](#errordetails): The details of the error. @@ -87,12 +86,7 @@ * **submittedBy**: string: The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'. * **submittedTime**: string: The time when export was queued to be executed. -## ErrorDetails -### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message indicating why the operation failed. - -## CommonExportProperties +## ExportProperties ### Properties * **definition**: [ExportDefinition](#exportdefinition) (Required): The definition of an export. * **deliveryInfo**: [ExportDeliveryInfo](#exportdeliveryinfo) (Required): The delivery information associated with a export. @@ -100,6 +94,12 @@ * **nextRunTimeEstimate**: string (ReadOnly): If the export has an active schedule, provides an estimate of the next execution time. * **partitionData**: bool: If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for modern commerce scopes. * **runHistory**: [ExportExecutionListResult](#exportexecutionlistresult): Result of listing the execution history of an export. +* **schedule**: [ExportSchedule](#exportschedule): The schedule associated with the export. + +## ExportRecurrencePeriod +### Properties +* **from**: string (Required): The start date of recurrence. +* **to**: string: The end date of recurrence. ## ExportSchedule ### Properties @@ -107,25 +107,10 @@ * **recurrencePeriod**: [ExportRecurrencePeriod](#exportrecurrenceperiod): The start and end date for recurrence schedule. * **status**: 'Active' | 'Inactive' | string: The status of the export's schedule. If 'Inactive', the export's schedule is paused. -## ExportRecurrencePeriod -### Properties -* **from**: string (Required): The start date of recurrence. -* **to**: string: The end date of recurrence. - -## ViewProperties +## ExportTimePeriod ### Properties -* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. -* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. -* **createdOn**: string (ReadOnly): Date the user created this view. -* **currency**: string (ReadOnly): Currency of the current view. -* **dateRange**: string (ReadOnly): Date range of the current view. -* **displayName**: string: User input name of the view. Required. -* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. -* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. -* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. -* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. -* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. -* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. +* **from**: string (Required): The start date for export data. +* **to**: string (Required): The end date for export data. ## KpiProperties ### Properties @@ -138,13 +123,16 @@ * **name**: string: Data field to show in view. * **type**: 'Dimension' | 'TagKey' | string: Data type to show in view. -## ReportConfigDefinition +## ReportConfigAggregation ### Properties -* **dataSet**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. -* **includeMonetaryCommitment**: bool: If true, report includes monetary commitment. -* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. -* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. -* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. +* **function**: 'Sum' | string (Required): The name of the aggregation function to use. +* **name**: string (Required): The name of the column to aggregate. + +## ReportConfigComparisonExpression +### Properties +* **name**: string (Required): The name of the column to use in comparison. +* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. +* **values**: string[] (Required): Array of values to use for comparison ## ReportConfigDataset ### Properties @@ -160,15 +148,18 @@ ### Additional Properties * **Additional Properties Type**: [ReportConfigAggregation](#reportconfigaggregation) -## ReportConfigAggregation -### Properties -* **function**: 'Sum' | string (Required): The name of the aggregation function to use. -* **name**: string (Required): The name of the column to aggregate. - ## ReportConfigDatasetConfiguration ### Properties * **columns**: string[]: Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. +## ReportConfigDefinition +### Properties +* **dataSet**: [ReportConfigDataset](#reportconfigdataset): The definition of data present in the report. +* **includeMonetaryCommitment**: bool: If true, report includes monetary commitment. +* **timeframe**: 'Custom' | 'MonthToDate' | 'WeekToDate' | 'YearToDate' | string (Required): The time frame for pulling data for the report. If custom, then a specific time period must be provided. +* **timePeriod**: [ReportConfigTimePeriod](#reportconfigtimeperiod): The start and end date for pulling data for the report. +* **type**: 'Usage' | string (Required): The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. + ## ReportConfigFilter ### Properties * **and**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "AND" expression. Must have at least 2 items. @@ -176,12 +167,6 @@ * **or**: [ReportConfigFilter](#reportconfigfilter)[]: The logical "OR" expression. Must have at least 2 items. * **tags**: [ReportConfigComparisonExpression](#reportconfigcomparisonexpression): The comparison expression to be used in the report. -## ReportConfigComparisonExpression -### Properties -* **name**: string (Required): The name of the column to use in comparison. -* **operator**: 'Contains' | 'In' | string (Required): The operator to use for comparison. -* **values**: string[] (Required): Array of values to use for comparison - ## ReportConfigGrouping ### Properties * **name**: string (Required): The name of the column to group. This version supports subscription lowest possible grain. @@ -197,3 +182,18 @@ * **from**: string (Required): The start date to pull data from. * **to**: string (Required): The end date to pull data to. +## ViewProperties +### Properties +* **accumulated**: 'false' | 'true' | string: Show costs accumulated over time. +* **chart**: 'Area' | 'GroupedColumn' | 'Line' | 'StackedColumn' | 'Table' | string: Chart type of the main view in Cost Analysis. Required. +* **createdOn**: string (ReadOnly): Date the user created this view. +* **currency**: string (ReadOnly): Currency of the current view. +* **dateRange**: string (ReadOnly): Date range of the current view. +* **displayName**: string: User input name of the view. Required. +* **kpis**: [KpiProperties](#kpiproperties)[]: List of KPIs to show in Cost Analysis UI. +* **metric**: 'AHUB' | 'ActualCost' | 'AmortizedCost' | string: Metric to use when displaying costs. +* **modifiedOn**: string (ReadOnly): Date when the user last modified this view. +* **pivots**: [PivotProperties](#pivotproperties)[]: Configuration of 3 sub-views in the Cost Analysis UI. +* **query**: [ReportConfigDefinition](#reportconfigdefinition): The definition of a report config. +* **scope**: string: Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. + diff --git a/generated/cost-management/microsoft.costmanagement/2022-04-01-preview/types.md b/generated/cost-management/microsoft.costmanagement/2022-04-01-preview/types.md index b837c79fa9..5a161a9ecc 100644 --- a/generated/cost-management/microsoft.costmanagement/2022-04-01-preview/types.md +++ b/generated/cost-management/microsoft.costmanagement/2022-04-01-preview/types.md @@ -12,16 +12,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.CostManagement/scheduledActions' (ReadOnly, DeployTimeConstant): The resource type -## ScheduledActionProperties -### Properties -* **displayName**: string (Required): Scheduled action name. -* **fileDestination**: [FileDestination](#filedestination): Destination of the view data. Currently only csv format is supported. -* **notification**: [NotificationProperties](#notificationproperties) (Required): The properties of the scheduled action notification. -* **schedule**: [ScheduleProperties](#scheduleproperties) (Required): The properties of the schedule. -* **scope**: string: Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. -* **status**: 'Disabled' | 'Enabled' | string (Required): Status of the scheduled action. -* **viewId**: string (Required): Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' - ## FileDestination ### Properties * **fileFormats**: 'Csv' | string[]: Destination of the view data. Currently only csv format is supported. @@ -32,6 +22,16 @@ * **subject**: string (Required): Subject of the email. Length is limited to 70 characters. * **to**: string[] (Required): Array of email addresses. +## ScheduledActionProperties +### Properties +* **displayName**: string (Required): Scheduled action name. +* **fileDestination**: [FileDestination](#filedestination): Destination of the view data. Currently only csv format is supported. +* **notification**: [NotificationProperties](#notificationproperties) (Required): The properties of the scheduled action notification. +* **schedule**: [ScheduleProperties](#scheduleproperties) (Required): The properties of the schedule. +* **scope**: string: Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope. +* **status**: 'Disabled' | 'Enabled' | string (Required): Status of the scheduled action. +* **viewId**: string (Required): Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample' + ## ScheduleProperties ### Properties * **dayOfMonth**: int: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. diff --git a/generated/cpim/log.out b/generated/cpim/log.out index dcd71e659d..61e9fdaaa9 100644 --- a/generated/cpim/log.out +++ b/generated/cpim/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.azureactivedirectory-2019-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json:470:9 @@ -25,10 +25,10 @@ warning | PreCheck/SchemaMissingType | The schema 'B2CTenantResourceList' with a warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2019-01-01-preview/cpimTenant.json:873:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.azureactivedirectory-2020-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json:346:9 @@ -42,8 +42,8 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.azureactivedirectory-2021-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 7.82s. 6 files generated. +info | Autorest completed in 7.51s. 6 files generated. diff --git a/generated/cpim/microsoft.azureactivedirectory/2019-01-01-preview/types.md b/generated/cpim/microsoft.azureactivedirectory/2019-01-01-preview/types.md index 357afca875..f976087278 100644 --- a/generated/cpim/microsoft.azureactivedirectory/2019-01-01-preview/types.md +++ b/generated/cpim/microsoft.azureactivedirectory/2019-01-01-preview/types.md @@ -12,11 +12,10 @@ * **tags**: [CreateTenantRequestBodyTags](#createtenantrequestbodytags): Resource Tags * **type**: 'Microsoft.AzureActiveDirectory/b2cDirectories' (ReadOnly, DeployTimeConstant): The resource type -## CreateTenantRequestBodyProperties +## B2CResourceSKU ### Properties -* **billingConfig**: [B2CTenantResourcePropertiesBillingConfig](#b2ctenantresourcepropertiesbillingconfig) (ReadOnly): The billing configuration for the tenant. -* **createTenantProperties**: [CreateTenantProperties](#createtenantproperties) (WriteOnly): These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. -* **tenantId**: string (ReadOnly): An identifier of the B2C tenant. +* **name**: 'PremiumP1' | 'PremiumP2' | 'Standard': The name of the SKU for the tenant. +* **tier**: 'A0': The tier of the tenant. ## B2CTenantResourcePropertiesBillingConfig ### Properties @@ -28,10 +27,11 @@ * **countryCode**: string (WriteOnly): Country code of Azure tenant (e.g. 'US'). Refer to [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list. * **displayName**: string (WriteOnly): The display name of the B2C tenant. -## B2CResourceSKU +## CreateTenantRequestBodyProperties ### Properties -* **name**: 'PremiumP1' | 'PremiumP2' | 'Standard': The name of the SKU for the tenant. -* **tier**: 'A0': The tier of the tenant. +* **billingConfig**: [B2CTenantResourcePropertiesBillingConfig](#b2ctenantresourcepropertiesbillingconfig) (ReadOnly): The billing configuration for the tenant. +* **createTenantProperties**: [CreateTenantProperties](#createtenantproperties) (WriteOnly): These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. +* **tenantId**: string (ReadOnly): An identifier of the B2C tenant. ## CreateTenantRequestBodyTags ### Properties diff --git a/generated/cpim/microsoft.azureactivedirectory/2021-04-01/types.md b/generated/cpim/microsoft.azureactivedirectory/2021-04-01/types.md index 8d7afe75c8..486127c1dc 100644 --- a/generated/cpim/microsoft.azureactivedirectory/2021-04-01/types.md +++ b/generated/cpim/microsoft.azureactivedirectory/2021-04-01/types.md @@ -25,11 +25,10 @@ * **tags**: [GuestUsagesResourceTags](#guestusagesresourcetags): Key-value pairs of additional resource provisioning properties. * **type**: 'Microsoft.AzureActiveDirectory/guestUsages' (ReadOnly, DeployTimeConstant): The resource type -## CreateTenantRequestBodyProperties +## B2CResourceSKU ### Properties -* **billingConfig**: [B2CTenantResourcePropertiesBillingConfig](#b2ctenantresourcepropertiesbillingconfig) (ReadOnly): The billing configuration for the tenant. -* **createTenantProperties**: [CreateTenantProperties](#createtenantproperties) (WriteOnly): These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. -* **tenantId**: string (ReadOnly): An identifier of the Azure AD B2C tenant. +* **name**: 'PremiumP1' | 'PremiumP2' | 'Standard' | string: The name of the SKU for the tenant. +* **tier**: 'A0' | string: The tier of the tenant. ## B2CTenantResourcePropertiesBillingConfig ### Properties @@ -41,19 +40,11 @@ * **countryCode**: string (WriteOnly): Country code of Azure tenant (e.g. 'US'). Refer to [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list. * **displayName**: string (WriteOnly): The display name of the Azure AD B2C tenant. -## B2CResourceSKU -### Properties -* **name**: 'PremiumP1' | 'PremiumP2' | 'Standard' | string: The name of the SKU for the tenant. -* **tier**: 'A0' | string: The tier of the tenant. - -## SystemData +## CreateTenantRequestBodyProperties ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **billingConfig**: [B2CTenantResourcePropertiesBillingConfig](#b2ctenantresourcepropertiesbillingconfig) (ReadOnly): The billing configuration for the tenant. +* **createTenantProperties**: [CreateTenantProperties](#createtenantproperties) (WriteOnly): These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. +* **tenantId**: string (ReadOnly): An identifier of the Azure AD B2C tenant. ## CreateTenantRequestBodyTags ### Properties @@ -69,3 +60,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. + diff --git a/generated/customer-insights/log.out b/generated/customer-insights/log.out index 4ad69e1900..b717a1c58a 100644 --- a/generated/customer-insights/log.out +++ b/generated/customer-insights/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.customerinsights-2017-04-26"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'HubBillingInfoFormat' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json:3556:5 @@ -199,7 +199,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.customerinsights-2017-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'HubBillingInfoFormat' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json:3185:5 @@ -372,4 +372,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 9ms -info | Autorest completed in 12.11s. 4 files generated. +info | Autorest completed in 11.58s. 4 files generated. diff --git a/generated/customer-insights/microsoft.customerinsights/2017-01-01/types.md b/generated/customer-insights/microsoft.customerinsights/2017-01-01/types.md index 60cd6d8fa6..21ad2a80d8 100644 --- a/generated/customer-insights/microsoft.customerinsights/2017-01-01/types.md +++ b/generated/customer-insights/microsoft.customerinsights/2017-01-01/types.md @@ -110,21 +110,13 @@ * **properties**: [View](#view): The view in Customer 360 web application. * **type**: 'Microsoft.CustomerInsights/hubs/views' (ReadOnly, DeployTimeConstant): The resource type -## HubPropertiesFormat -### Properties -* **apiEndpoint**: string (ReadOnly): API endpoint URL of the hub. -* **hubBillingInfo**: [HubBillingInfoFormat](#hubbillinginfoformat): Hub billing info. -* **provisioningState**: string (ReadOnly): Provisioning state of the hub. -* **tenantFeatures**: int: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. -* **webEndpoint**: string (ReadOnly): Web endpoint URL of the hub. - -## HubBillingInfoFormat +## AssignmentPrincipal ### Properties -* **maxUnits**: int: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. -* **minUnits**: int: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. -* **skuName**: string: The sku name. +* **principalId**: string (Required): The principal id being assigned to. +* **principalMetadata**: [AssignmentPrincipalMetadata](#assignmentprincipalmetadata): Other metadata for the principal. +* **principalType**: string (Required): The Type of the principal ID. -## ResourceTags +## AssignmentPrincipalMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -150,11 +142,6 @@ * **state**: 'Created' | 'Creating' | 'Deleting' | 'Expiring' | 'Failed' | 'Ready' (ReadOnly): State of connector. * **tenantId**: string (ReadOnly): The hub name. -## ConnectorProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - ## ConnectorMapping ### Properties * **connectorMappingName**: string (ReadOnly): The connector mapping name @@ -173,17 +160,6 @@ * **state**: 'Created' | 'Creating' | 'Expiring' | 'Failed' | 'Ready' | 'Running' | 'Stopped' (ReadOnly): State of connector mapping. * **tenantId**: string (ReadOnly): The hub name. -## ConnectorMappingProperties -### Properties -* **availability**: [ConnectorMappingAvailability](#connectormappingavailability) (Required): Connector mapping property availability. -* **completeOperation**: [ConnectorMappingCompleteOperation](#connectormappingcompleteoperation) (Required): The complete operation. -* **errorManagement**: [ConnectorMappingErrorManagement](#connectormappingerrormanagement) (Required): The error management. -* **fileFilter**: string: The file filter for the mapping. -* **folderPath**: string: The folder path for the mapping. -* **format**: [ConnectorMappingFormat](#connectormappingformat) (Required): Connector mapping property format. -* **hasHeader**: bool: If the file contains a header or not. -* **structure**: [ConnectorMappingStructure](#connectormappingstructure)[] (Required): Ingestion mapping information at property level. - ## ConnectorMappingAvailability ### Properties * **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': The frequency to update. @@ -208,6 +184,17 @@ * **quoteCharacter**: string: Quote character, used to indicate enquoted fields. * **quoteEscapeCharacter**: string: Escape character for quotes, can be the same as the quoteCharacter. +## ConnectorMappingProperties +### Properties +* **availability**: [ConnectorMappingAvailability](#connectormappingavailability) (Required): Connector mapping property availability. +* **completeOperation**: [ConnectorMappingCompleteOperation](#connectormappingcompleteoperation) (Required): The complete operation. +* **errorManagement**: [ConnectorMappingErrorManagement](#connectormappingerrormanagement) (Required): The error management. +* **fileFilter**: string: The file filter for the mapping. +* **folderPath**: string: The folder path for the mapping. +* **format**: [ConnectorMappingFormat](#connectormappingformat) (Required): Connector mapping property format. +* **hasHeader**: bool: If the file contains a header or not. +* **structure**: [ConnectorMappingStructure](#connectormappingstructure)[] (Required): Ingestion mapping information at property level. + ## ConnectorMappingStructure ### Properties * **columnName**: string (Required): The column name of the import file. @@ -215,41 +202,10 @@ * **isEncrypted**: bool: Indicates if the column is encrypted. * **propertyName**: string (Required): The property name of the mapping entity. -## InteractionTypeDefinition -### Properties -* **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. -* **attributes**: [MetadataDefinitionBaseAttributes](#metadatadefinitionbaseattributes): The attributes for the Type. -* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. -* **defaultDataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. -* **description**: [MetadataDefinitionBaseDescription](#metadatadefinitionbasedescription): Localized descriptions for the property. -* **displayName**: [MetadataDefinitionBaseDisplayName](#metadatadefinitionbasedisplayname): Localized display names for the property. -* **entityType**: 'Interaction' | 'None' | 'Profile' | 'Relationship': Type of entity. -* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Profile. -* **idPropertyNames**: string[]: The id property names. Properties which uniquely identify an interaction instance. -* **instancesCount**: int: The instance count. -* **isActivity**: bool: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. -* **largeImage**: string: Large Image associated with the Property or EntityType. -* **lastChangedUtc**: string (ReadOnly): The last changed time for the type definition. -* **localizedAttributes**: [MetadataDefinitionBaseLocalizedAttributes](#metadatadefinitionbaselocalizedattributes): Any custom localized attributes for the Type. -* **mediumImage**: string: Medium Image associated with the Property or EntityType. -* **participantProfiles**: [Participant](#participant)[]: Profiles that participated in the interaction. -* **primaryParticipantProfilePropertyName**: string: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. -* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. -* **schemaItemTypeLink**: string: The schema org link. This helps ACI identify and suggest semantic models. -* **smallImage**: string: Small Image associated with the Property or EntityType. -* **tenantId**: string (ReadOnly): The hub name. -* **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. -* **typeName**: string: The name of the entity. - -## MetadataDefinitionBaseAttributes +## ConnectorProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string[] - -## DataSourcePrecedence -### Properties -* **dataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. -* **precedence**: int: the precedence value. +* **Additional Properties Type**: any ## DataSource ### Properties @@ -259,78 +215,65 @@ * **name**: string (ReadOnly): The data source name * **status**: 'Active' | 'Deleted' | 'None' | string (ReadOnly): The data source status. -## MetadataDefinitionBaseDescription -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MetadataDefinitionBaseDisplayName -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PropertyDefinition -### Properties -* **arrayValueSeparator**: string: Array value separator for properties with isArray set. -* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. -* **enumValidValues**: [ProfileEnumValidValuesFormat](#profileenumvalidvaluesformat)[]: Describes valid values for an enum property. -* **fieldName**: string (Required): Name of the property. -* **fieldType**: string (Required): Type of the property. -* **isArray**: bool: Indicates if the property is actually an array of the fieldType above on the data api. -* **isAvailableInGraph**: bool: Whether property is available in graph or not. -* **isEnum**: bool: Indicates if the property is an enum. -* **isFlagEnum**: bool: Indicates if the property is an flag enum. -* **isImage**: bool: Whether the property is an Image. -* **isLocalizedString**: bool: Whether the property is a localized string. -* **isName**: bool: Whether the property is a name or a part of name. -* **isRequired**: bool: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. -* **maxLength**: int: Max length of string. Used only if type is string. -* **propertyId**: string: The ID associated with the property. -* **schemaItemPropLink**: string: URL encoded schema.org item prop link for the property. - -## ProfileEnumValidValuesFormat +## DataSourcePrecedence ### Properties -* **localizedValueNames**: [ProfileEnumValidValuesFormatLocalizedValueNames](#profileenumvalidvaluesformatlocalizedvaluenames): Localized names of the enum member. -* **value**: int: The integer value of the enum member. +* **dataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. +* **precedence**: int: the precedence value. -## ProfileEnumValidValuesFormatLocalizedValueNames +## DictionaryOfString ### Properties ### Additional Properties * **Additional Properties Type**: string -## MetadataDefinitionBaseLocalizedAttributes -### Properties -### Additional Properties -* **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) - ## DictionaryOfString ### Properties ### Additional Properties * **Additional Properties Type**: string -## Participant +## HubBillingInfoFormat ### Properties -* **description**: [ParticipantDescription](#participantdescription): Localized descriptions. -* **displayName**: [ParticipantDisplayName](#participantdisplayname): Localized display name. -* **participantName**: string (Required): Participant name. -* **participantPropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references. -* **profileTypeName**: string (Required): Profile type name. -* **role**: string: The role that the participant is playing in the interaction. +* **maxUnits**: int: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. +* **minUnits**: int: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. +* **skuName**: string: The sku name. -## ParticipantDescription +## HubPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiEndpoint**: string (ReadOnly): API endpoint URL of the hub. +* **hubBillingInfo**: [HubBillingInfoFormat](#hubbillinginfoformat): Hub billing info. +* **provisioningState**: string (ReadOnly): Provisioning state of the hub. +* **tenantFeatures**: int: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. +* **webEndpoint**: string (ReadOnly): Web endpoint URL of the hub. -## ParticipantDisplayName +## InteractionTypeDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. +* **attributes**: [MetadataDefinitionBaseAttributes](#metadatadefinitionbaseattributes): The attributes for the Type. +* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. +* **defaultDataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. +* **description**: [MetadataDefinitionBaseDescription](#metadatadefinitionbasedescription): Localized descriptions for the property. +* **displayName**: [MetadataDefinitionBaseDisplayName](#metadatadefinitionbasedisplayname): Localized display names for the property. +* **entityType**: 'Interaction' | 'None' | 'Profile' | 'Relationship': Type of entity. +* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Profile. +* **idPropertyNames**: string[]: The id property names. Properties which uniquely identify an interaction instance. +* **instancesCount**: int: The instance count. +* **isActivity**: bool: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. +* **largeImage**: string: Large Image associated with the Property or EntityType. +* **lastChangedUtc**: string (ReadOnly): The last changed time for the type definition. +* **localizedAttributes**: [MetadataDefinitionBaseLocalizedAttributes](#metadatadefinitionbaselocalizedattributes): Any custom localized attributes for the Type. +* **mediumImage**: string: Medium Image associated with the Property or EntityType. +* **participantProfiles**: [Participant](#participant)[]: Profiles that participated in the interaction. +* **primaryParticipantProfilePropertyName**: string: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. +* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **schemaItemTypeLink**: string: The schema org link. This helps ACI identify and suggest semantic models. +* **smallImage**: string: Small Image associated with the Property or EntityType. +* **tenantId**: string (ReadOnly): The hub name. +* **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. +* **typeName**: string: The name of the entity. -## ParticipantPropertyReference +## KpiAlias ### Properties -* **interactionPropertyName**: string (Required): The interaction property that maps to the profile property. -* **profilePropertyName**: string (Required): The profile property that maps to the interaction property. +* **aliasName**: string (Required): KPI alias name. +* **expression**: string (Required): The expression. ## KpiDefinition ### Properties @@ -354,11 +297,6 @@ * **thresHolds**: [KpiThresholds](#kpithresholds): Defines the KPI Threshold limits. * **unit**: string: The unit of measurement for the KPI. -## KpiAlias -### Properties -* **aliasName**: string (Required): KPI alias name. -* **expression**: string (Required): The expression. - ## KpiDefinitionDescription ### Properties ### Additional Properties @@ -419,33 +357,10 @@ ### Additional Properties * **Additional Properties Type**: string -## TypePropertiesMapping -### Properties -* **interactionTypePropertyName**: string (Required): Property name on the source Interaction Type. -* **isProfileTypeId**: bool: Flag to indicate whether the Profile Type property is an id on the Profile Type. -* **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. -* **profileTypePropertyName**: string (Required): Property name on the target Profile Type. - -## ProfileTypeDefinition +## MetadataDefinitionBaseAttributes ### Properties -* **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. -* **attributes**: [MetadataDefinitionBaseAttributes](#metadatadefinitionbaseattributes): The attributes for the Type. -* **description**: [MetadataDefinitionBaseDescription](#metadatadefinitionbasedescription): Localized descriptions for the property. -* **displayName**: [MetadataDefinitionBaseDisplayName](#metadatadefinitionbasedisplayname): Localized display names for the property. -* **entityType**: 'Interaction' | 'None' | 'Profile' | 'Relationship': Type of entity. -* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Profile. -* **instancesCount**: int: The instance count. -* **largeImage**: string: Large Image associated with the Property or EntityType. -* **lastChangedUtc**: string (ReadOnly): The last changed time for the type definition. -* **localizedAttributes**: [MetadataDefinitionBaseLocalizedAttributes](#metadatadefinitionbaselocalizedattributes): Any custom localized attributes for the Type. -* **mediumImage**: string: Medium Image associated with the Property or EntityType. -* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. -* **schemaItemTypeLink**: string: The schema org link. This helps ACI identify and suggest semantic models. -* **smallImage**: string: Small Image associated with the Property or EntityType. -* **strongIds**: [StrongId](#strongid)[]: The strong IDs. -* **tenantId**: string (ReadOnly): The hub name. -* **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. -* **typeName**: string: The name of the entity. +### Additional Properties +* **Additional Properties Type**: string[] ## MetadataDefinitionBaseAttributes ### Properties @@ -457,6 +372,16 @@ ### Additional Properties * **Additional Properties Type**: string +## MetadataDefinitionBaseDescription +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MetadataDefinitionBaseDisplayName +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## MetadataDefinitionBaseDisplayName ### Properties ### Additional Properties @@ -467,57 +392,84 @@ ### Additional Properties * **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) -## DictionaryOfString +## MetadataDefinitionBaseLocalizedAttributes ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) -## StrongId +## Participant ### Properties -* **description**: [StrongIdDescription](#strongiddescription): Localized descriptions. -* **displayName**: [StrongIdDisplayName](#strongiddisplayname): Localized display name. -* **keyPropertyNames**: string[] (Required): The properties which make up the unique ID. -* **strongIdName**: string (Required): The Name identifying the strong ID. +* **description**: [ParticipantDescription](#participantdescription): Localized descriptions. +* **displayName**: [ParticipantDisplayName](#participantdisplayname): Localized display name. +* **participantName**: string (Required): Participant name. +* **participantPropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references. +* **profileTypeName**: string (Required): Profile type name. +* **role**: string: The role that the participant is playing in the interaction. -## StrongIdDescription +## ParticipantDescription ### Properties ### Additional Properties * **Additional Properties Type**: string -## StrongIdDisplayName +## ParticipantDisplayName ### Properties ### Additional Properties * **Additional Properties Type**: string -## RelationshipLinkDefinition +## ParticipantPropertyReference ### Properties -* **description**: [RelationshipLinkDefinitionDescription](#relationshiplinkdefinitiondescription): Localized descriptions for the Relationship Link. -* **displayName**: [RelationshipLinkDefinitionDisplayName](#relationshiplinkdefinitiondisplayname): Localized display name for the Relationship Link. -* **interactionType**: string (Required): The InteractionType associated with the Relationship Link. -* **linkName**: string (ReadOnly): The name of the Relationship Link. -* **mappings**: [RelationshipLinkFieldMapping](#relationshiplinkfieldmapping)[]: The mappings between Interaction and Relationship fields. -* **profilePropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references for the Profile of the Relationship. -* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. -* **relatedProfilePropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references for the Related Profile of the Relationship. -* **relationshipGuidId**: string (ReadOnly): The relationship guid id. -* **relationshipName**: string (Required): The Relationship associated with the Link. -* **tenantId**: string (ReadOnly): The hub name. +* **interactionPropertyName**: string (Required): The interaction property that maps to the profile property. +* **profilePropertyName**: string (Required): The profile property that maps to the interaction property. -## RelationshipLinkDefinitionDescription +## ProfileEnumValidValuesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localizedValueNames**: [ProfileEnumValidValuesFormatLocalizedValueNames](#profileenumvalidvaluesformatlocalizedvaluenames): Localized names of the enum member. +* **value**: int: The integer value of the enum member. -## RelationshipLinkDefinitionDisplayName +## ProfileEnumValidValuesFormatLocalizedValueNames ### Properties ### Additional Properties * **Additional Properties Type**: string -## RelationshipLinkFieldMapping +## ProfileTypeDefinition ### Properties -* **interactionFieldName**: string (Required): The field name on the Interaction Type. -* **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. -* **relationshipFieldName**: string (Required): The field name on the Relationship metadata. +* **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. +* **attributes**: [MetadataDefinitionBaseAttributes](#metadatadefinitionbaseattributes): The attributes for the Type. +* **description**: [MetadataDefinitionBaseDescription](#metadatadefinitionbasedescription): Localized descriptions for the property. +* **displayName**: [MetadataDefinitionBaseDisplayName](#metadatadefinitionbasedisplayname): Localized display names for the property. +* **entityType**: 'Interaction' | 'None' | 'Profile' | 'Relationship': Type of entity. +* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Profile. +* **instancesCount**: int: The instance count. +* **largeImage**: string: Large Image associated with the Property or EntityType. +* **lastChangedUtc**: string (ReadOnly): The last changed time for the type definition. +* **localizedAttributes**: [MetadataDefinitionBaseLocalizedAttributes](#metadatadefinitionbaselocalizedattributes): Any custom localized attributes for the Type. +* **mediumImage**: string: Medium Image associated with the Property or EntityType. +* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **schemaItemTypeLink**: string: The schema org link. This helps ACI identify and suggest semantic models. +* **smallImage**: string: Small Image associated with the Property or EntityType. +* **strongIds**: [StrongId](#strongid)[]: The strong IDs. +* **tenantId**: string (ReadOnly): The hub name. +* **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. +* **typeName**: string: The name of the entity. + +## PropertyDefinition +### Properties +* **arrayValueSeparator**: string: Array value separator for properties with isArray set. +* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. +* **enumValidValues**: [ProfileEnumValidValuesFormat](#profileenumvalidvaluesformat)[]: Describes valid values for an enum property. +* **fieldName**: string (Required): Name of the property. +* **fieldType**: string (Required): Type of the property. +* **isArray**: bool: Indicates if the property is actually an array of the fieldType above on the data api. +* **isAvailableInGraph**: bool: Whether property is available in graph or not. +* **isEnum**: bool: Indicates if the property is an enum. +* **isFlagEnum**: bool: Indicates if the property is an flag enum. +* **isImage**: bool: Whether the property is an Image. +* **isLocalizedString**: bool: Whether the property is a localized string. +* **isName**: bool: Whether the property is a name or a part of name. +* **isRequired**: bool: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. +* **maxLength**: int: Max length of string. Used only if type is string. +* **propertyId**: string: The ID associated with the property. +* **schemaItemPropLink**: string: URL encoded schema.org item prop link for the property. ## RelationshipDefinition ### Properties @@ -544,15 +496,55 @@ ### Additional Properties * **Additional Properties Type**: string -## RelationshipTypeMapping +## RelationshipLinkDefinition ### Properties -* **fieldMappings**: [RelationshipTypeFieldMapping](#relationshiptypefieldmapping)[] (Required): Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. +* **description**: [RelationshipLinkDefinitionDescription](#relationshiplinkdefinitiondescription): Localized descriptions for the Relationship Link. +* **displayName**: [RelationshipLinkDefinitionDisplayName](#relationshiplinkdefinitiondisplayname): Localized display name for the Relationship Link. +* **interactionType**: string (Required): The InteractionType associated with the Relationship Link. +* **linkName**: string (ReadOnly): The name of the Relationship Link. +* **mappings**: [RelationshipLinkFieldMapping](#relationshiplinkfieldmapping)[]: The mappings between Interaction and Relationship fields. +* **profilePropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references for the Profile of the Relationship. +* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **relatedProfilePropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references for the Related Profile of the Relationship. +* **relationshipGuidId**: string (ReadOnly): The relationship guid id. +* **relationshipName**: string (Required): The Relationship associated with the Link. +* **tenantId**: string (ReadOnly): The hub name. + +## RelationshipLinkDefinitionDescription +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RelationshipLinkDefinitionDisplayName +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RelationshipLinkFieldMapping +### Properties +* **interactionFieldName**: string (Required): The field name on the Interaction Type. +* **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. +* **relationshipFieldName**: string (Required): The field name on the Relationship metadata. ## RelationshipTypeFieldMapping ### Properties * **profileFieldName**: string (Required): Specifies the fieldName in profile. * **relatedProfileKeyProperty**: string (Required): Specifies the KeyProperty (from StrongId) of the related profile. +## RelationshipTypeMapping +### Properties +* **fieldMappings**: [RelationshipTypeFieldMapping](#relationshiptypefieldmapping)[] (Required): Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. + +## ResourceSetDescription +### Properties +* **elements**: string[]: The elements included in the set. +* **exceptions**: string[]: The elements that are not included in the set, in case elements contains '*' indicating 'all'. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## RoleAssignment ### Properties * **assignmentName**: string (ReadOnly): The name of the metadata object. @@ -576,11 +568,6 @@ * **views**: [ResourceSetDescription](#resourcesetdescription): The resource set description. * **widgetTypes**: [ResourceSetDescription](#resourcesetdescription): The resource set description. -## ResourceSetDescription -### Properties -* **elements**: string[]: The elements included in the set. -* **exceptions**: string[]: The elements that are not included in the set, in case elements contains '*' indicating 'all'. - ## RoleAssignmentDescription ### Properties ### Additional Properties @@ -591,17 +578,30 @@ ### Additional Properties * **Additional Properties Type**: string -## AssignmentPrincipal +## StrongId ### Properties -* **principalId**: string (Required): The principal id being assigned to. -* **principalMetadata**: [AssignmentPrincipalMetadata](#assignmentprincipalmetadata): Other metadata for the principal. -* **principalType**: string (Required): The Type of the principal ID. +* **description**: [StrongIdDescription](#strongiddescription): Localized descriptions. +* **displayName**: [StrongIdDisplayName](#strongiddisplayname): Localized display name. +* **keyPropertyNames**: string[] (Required): The properties which make up the unique ID. +* **strongIdName**: string (Required): The Name identifying the strong ID. -## AssignmentPrincipalMetadata +## StrongIdDescription ### Properties ### Additional Properties * **Additional Properties Type**: string +## StrongIdDisplayName +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TypePropertiesMapping +### Properties +* **interactionTypePropertyName**: string (Required): Property name on the source Interaction Type. +* **isProfileTypeId**: bool: Flag to indicate whether the Profile Type property is an id on the Profile Type. +* **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. +* **profileTypePropertyName**: string (Required): Property name on the target Profile Type. + ## View ### Properties * **changed**: string (ReadOnly): Date time when view was last modified. diff --git a/generated/customer-insights/microsoft.customerinsights/2017-04-26/types.md b/generated/customer-insights/microsoft.customerinsights/2017-04-26/types.md index 62008fba60..0de963c44b 100644 --- a/generated/customer-insights/microsoft.customerinsights/2017-04-26/types.md +++ b/generated/customer-insights/microsoft.customerinsights/2017-04-26/types.md @@ -119,21 +119,13 @@ * **properties**: [View](#view): The view in Customer 360 web application. * **type**: 'Microsoft.CustomerInsights/hubs/views' (ReadOnly, DeployTimeConstant): The resource type -## HubPropertiesFormat -### Properties -* **apiEndpoint**: string (ReadOnly): API endpoint URL of the hub. -* **hubBillingInfo**: [HubBillingInfoFormat](#hubbillinginfoformat): Hub billing info. -* **provisioningState**: string (ReadOnly): Provisioning state of the hub. -* **tenantFeatures**: int: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. -* **webEndpoint**: string (ReadOnly): Web endpoint URL of the hub. - -## HubBillingInfoFormat +## AssignmentPrincipal ### Properties -* **maxUnits**: int: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. -* **minUnits**: int: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. -* **skuName**: string: The sku name. +* **principalId**: string (Required): The principal id being assigned to. +* **principalMetadata**: [AssignmentPrincipalMetadata](#assignmentprincipalmetadata): Other metadata for the principal. +* **principalType**: string (Required): The Type of the principal ID. -## ResourceTags +## AssignmentPrincipalMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -159,11 +151,6 @@ * **state**: 'Created' | 'Creating' | 'Deleting' | 'Expiring' | 'Failed' | 'Ready' (ReadOnly): State of connector. * **tenantId**: string (ReadOnly): The hub name. -## ConnectorProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - ## ConnectorMapping ### Properties * **connectorMappingName**: string (ReadOnly): The connector mapping name @@ -182,17 +169,6 @@ * **state**: 'Created' | 'Creating' | 'Expiring' | 'Failed' | 'Ready' | 'Running' | 'Stopped' (ReadOnly): State of connector mapping. * **tenantId**: string (ReadOnly): The hub name. -## ConnectorMappingProperties -### Properties -* **availability**: [ConnectorMappingAvailability](#connectormappingavailability) (Required): Connector mapping property availability. -* **completeOperation**: [ConnectorMappingCompleteOperation](#connectormappingcompleteoperation) (Required): The complete operation. -* **errorManagement**: [ConnectorMappingErrorManagement](#connectormappingerrormanagement) (Required): The error management. -* **fileFilter**: string: The file filter for the mapping. -* **folderPath**: string: The folder path for the mapping. -* **format**: [ConnectorMappingFormat](#connectormappingformat) (Required): Connector mapping property format. -* **hasHeader**: bool: If the file contains a header or not. -* **structure**: [ConnectorMappingStructure](#connectormappingstructure)[] (Required): Ingestion mapping information at property level. - ## ConnectorMappingAvailability ### Properties * **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': The frequency to update. @@ -217,6 +193,17 @@ * **quoteCharacter**: string: Quote character, used to indicate enquoted fields. * **quoteEscapeCharacter**: string: Escape character for quotes, can be the same as the quoteCharacter. +## ConnectorMappingProperties +### Properties +* **availability**: [ConnectorMappingAvailability](#connectormappingavailability) (Required): Connector mapping property availability. +* **completeOperation**: [ConnectorMappingCompleteOperation](#connectormappingcompleteoperation) (Required): The complete operation. +* **errorManagement**: [ConnectorMappingErrorManagement](#connectormappingerrormanagement) (Required): The error management. +* **fileFilter**: string: The file filter for the mapping. +* **folderPath**: string: The folder path for the mapping. +* **format**: [ConnectorMappingFormat](#connectormappingformat) (Required): Connector mapping property format. +* **hasHeader**: bool: If the file contains a header or not. +* **structure**: [ConnectorMappingStructure](#connectormappingstructure)[] (Required): Ingestion mapping information at property level. + ## ConnectorMappingStructure ### Properties * **columnName**: string (Required): The column name of the import file. @@ -224,41 +211,10 @@ * **isEncrypted**: bool: Indicates if the column is encrypted. * **propertyName**: string (Required): The property name of the mapping entity. -## InteractionTypeDefinition -### Properties -* **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. -* **attributes**: [MetadataDefinitionBaseAttributes](#metadatadefinitionbaseattributes): The attributes for the Type. -* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. -* **defaultDataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. -* **description**: [MetadataDefinitionBaseDescription](#metadatadefinitionbasedescription): Localized descriptions for the property. -* **displayName**: [MetadataDefinitionBaseDisplayName](#metadatadefinitionbasedisplayname): Localized display names for the property. -* **entityType**: 'Interaction' | 'None' | 'Profile' | 'Relationship': Type of entity. -* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Profile. -* **idPropertyNames**: string[]: The id property names. Properties which uniquely identify an interaction instance. -* **instancesCount**: int: The instance count. -* **isActivity**: bool: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. -* **largeImage**: string: Large Image associated with the Property or EntityType. -* **lastChangedUtc**: string (ReadOnly): The last changed time for the type definition. -* **localizedAttributes**: [MetadataDefinitionBaseLocalizedAttributes](#metadatadefinitionbaselocalizedattributes): Any custom localized attributes for the Type. -* **mediumImage**: string: Medium Image associated with the Property or EntityType. -* **participantProfiles**: [Participant](#participant)[]: Profiles that participated in the interaction. -* **primaryParticipantProfilePropertyName**: string: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. -* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. -* **schemaItemTypeLink**: string: The schema org link. This helps ACI identify and suggest semantic models. -* **smallImage**: string: Small Image associated with the Property or EntityType. -* **tenantId**: string (ReadOnly): The hub name. -* **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. -* **typeName**: string: The name of the entity. - -## MetadataDefinitionBaseAttributes +## ConnectorProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string[] - -## DataSourcePrecedence -### Properties -* **dataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. -* **precedence**: int: the precedence value. +* **Additional Properties Type**: any ## DataSource ### Properties @@ -268,78 +224,65 @@ * **name**: string (ReadOnly): The data source name * **status**: 'Active' | 'Deleted' | 'None' | string (ReadOnly): The data source status. -## MetadataDefinitionBaseDescription -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MetadataDefinitionBaseDisplayName -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PropertyDefinition -### Properties -* **arrayValueSeparator**: string: Array value separator for properties with isArray set. -* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. -* **enumValidValues**: [ProfileEnumValidValuesFormat](#profileenumvalidvaluesformat)[]: Describes valid values for an enum property. -* **fieldName**: string (Required): Name of the property. -* **fieldType**: string (Required): Type of the property. -* **isArray**: bool: Indicates if the property is actually an array of the fieldType above on the data api. -* **isAvailableInGraph**: bool: Whether property is available in graph or not. -* **isEnum**: bool: Indicates if the property is an enum. -* **isFlagEnum**: bool: Indicates if the property is an flag enum. -* **isImage**: bool: Whether the property is an Image. -* **isLocalizedString**: bool: Whether the property is a localized string. -* **isName**: bool: Whether the property is a name or a part of name. -* **isRequired**: bool: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. -* **maxLength**: int: Max length of string. Used only if type is string. -* **propertyId**: string: The ID associated with the property. -* **schemaItemPropLink**: string: URL encoded schema.org item prop link for the property. - -## ProfileEnumValidValuesFormat +## DataSourcePrecedence ### Properties -* **localizedValueNames**: [ProfileEnumValidValuesFormatLocalizedValueNames](#profileenumvalidvaluesformatlocalizedvaluenames): Localized names of the enum member. -* **value**: int: The integer value of the enum member. +* **dataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. +* **precedence**: int: the precedence value. -## ProfileEnumValidValuesFormatLocalizedValueNames +## DictionaryOfString ### Properties ### Additional Properties * **Additional Properties Type**: string -## MetadataDefinitionBaseLocalizedAttributes -### Properties -### Additional Properties -* **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) - ## DictionaryOfString ### Properties ### Additional Properties * **Additional Properties Type**: string -## Participant +## HubBillingInfoFormat ### Properties -* **description**: [ParticipantDescription](#participantdescription): Localized descriptions. -* **displayName**: [ParticipantDisplayName](#participantdisplayname): Localized display name. -* **participantName**: string (Required): Participant name. -* **participantPropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references. -* **profileTypeName**: string (Required): Profile type name. -* **role**: string: The role that the participant is playing in the interaction. +* **maxUnits**: int: The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. +* **minUnits**: int: The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. +* **skuName**: string: The sku name. -## ParticipantDescription +## HubPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiEndpoint**: string (ReadOnly): API endpoint URL of the hub. +* **hubBillingInfo**: [HubBillingInfoFormat](#hubbillinginfoformat): Hub billing info. +* **provisioningState**: string (ReadOnly): Provisioning state of the hub. +* **tenantFeatures**: int: The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0. +* **webEndpoint**: string (ReadOnly): Web endpoint URL of the hub. -## ParticipantDisplayName +## InteractionTypeDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. +* **attributes**: [MetadataDefinitionBaseAttributes](#metadatadefinitionbaseattributes): The attributes for the Type. +* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. +* **defaultDataSource**: [DataSource](#datasource): Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. +* **description**: [MetadataDefinitionBaseDescription](#metadatadefinitionbasedescription): Localized descriptions for the property. +* **displayName**: [MetadataDefinitionBaseDisplayName](#metadatadefinitionbasedisplayname): Localized display names for the property. +* **entityType**: 'Interaction' | 'None' | 'Profile' | 'Relationship': Type of entity. +* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Profile. +* **idPropertyNames**: string[]: The id property names. Properties which uniquely identify an interaction instance. +* **instancesCount**: int: The instance count. +* **isActivity**: bool: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level. +* **largeImage**: string: Large Image associated with the Property or EntityType. +* **lastChangedUtc**: string (ReadOnly): The last changed time for the type definition. +* **localizedAttributes**: [MetadataDefinitionBaseLocalizedAttributes](#metadatadefinitionbaselocalizedattributes): Any custom localized attributes for the Type. +* **mediumImage**: string: Medium Image associated with the Property or EntityType. +* **participantProfiles**: [Participant](#participant)[]: Profiles that participated in the interaction. +* **primaryParticipantProfilePropertyName**: string: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName. +* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **schemaItemTypeLink**: string: The schema org link. This helps ACI identify and suggest semantic models. +* **smallImage**: string: Small Image associated with the Property or EntityType. +* **tenantId**: string (ReadOnly): The hub name. +* **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. +* **typeName**: string: The name of the entity. -## ParticipantPropertyReference +## KpiAlias ### Properties -* **sourcePropertyName**: string (Required): The source property that maps to the target property. -* **targetPropertyName**: string (Required): The target property that maps to the source property. +* **aliasName**: string (Required): KPI alias name. +* **expression**: string (Required): The expression. ## KpiDefinition ### Properties @@ -363,11 +306,6 @@ * **thresHolds**: [KpiThresholds](#kpithresholds): Defines the KPI Threshold limits. * **unit**: string: The unit of measurement for the KPI. -## KpiAlias -### Properties -* **aliasName**: string (Required): KPI alias name. -* **expression**: string (Required): The expression. - ## KpiDefinitionDescription ### Properties ### Additional Properties @@ -430,11 +368,74 @@ ### Additional Properties * **Additional Properties Type**: string -## TypePropertiesMapping +## MetadataDefinitionBaseAttributes ### Properties -* **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. -* **sourcePropertyName**: string (Required): Property name on the source Entity Type. -* **targetPropertyName**: string (Required): Property name on the target Entity Type. +### Additional Properties +* **Additional Properties Type**: string[] + +## MetadataDefinitionBaseAttributes +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## MetadataDefinitionBaseDescription +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MetadataDefinitionBaseDescription +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MetadataDefinitionBaseDisplayName +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MetadataDefinitionBaseDisplayName +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MetadataDefinitionBaseLocalizedAttributes +### Properties +### Additional Properties +* **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) + +## MetadataDefinitionBaseLocalizedAttributes +### Properties +### Additional Properties +* **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) + +## Participant +### Properties +* **description**: [ParticipantDescription](#participantdescription): Localized descriptions. +* **displayName**: [ParticipantDisplayName](#participantdisplayname): Localized display name. +* **participantName**: string (Required): Participant name. +* **participantPropertyReferences**: [ParticipantPropertyReference](#participantpropertyreference)[] (Required): The property references. +* **profileTypeName**: string (Required): Profile type name. +* **role**: string: The role that the participant is playing in the interaction. + +## ParticipantDescription +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ParticipantDisplayName +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ParticipantProfilePropertyReference +### Properties +* **interactionPropertyName**: string (Required): The source interaction property that maps to the target profile property. +* **profilePropertyName**: string (Required): The target profile property that maps to the source interaction property. + +## ParticipantPropertyReference +### Properties +* **sourcePropertyName**: string (Required): The source property that maps to the target property. +* **targetPropertyName**: string (Required): The target property that maps to the source property. ## Prediction ### Properties @@ -489,6 +490,16 @@ ### Additional Properties * **Additional Properties Type**: string +## ProfileEnumValidValuesFormat +### Properties +* **localizedValueNames**: [ProfileEnumValidValuesFormatLocalizedValueNames](#profileenumvalidvaluesformatlocalizedvaluenames): Localized names of the enum member. +* **value**: int: The integer value of the enum member. + +## ProfileEnumValidValuesFormatLocalizedValueNames +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ProfileTypeDefinition ### Properties * **apiEntitySetName**: string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. @@ -510,44 +521,46 @@ * **timestampFieldName**: string: The timestamp property name. Represents the time when the interaction or profile update happened. * **typeName**: string: The name of the entity. -## MetadataDefinitionBaseAttributes -### Properties -### Additional Properties -* **Additional Properties Type**: string[] - -## MetadataDefinitionBaseDescription -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MetadataDefinitionBaseDisplayName -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MetadataDefinitionBaseLocalizedAttributes -### Properties -### Additional Properties -* **Additional Properties Type**: [DictionaryOfString](#dictionaryofstring) - -## DictionaryOfString +## PropertyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **arrayValueSeparator**: string: Array value separator for properties with isArray set. +* **dataSourcePrecedenceRules**: [DataSourcePrecedence](#datasourceprecedence)[] (ReadOnly): This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. +* **enumValidValues**: [ProfileEnumValidValuesFormat](#profileenumvalidvaluesformat)[]: Describes valid values for an enum property. +* **fieldName**: string (Required): Name of the property. +* **fieldType**: string (Required): Type of the property. +* **isArray**: bool: Indicates if the property is actually an array of the fieldType above on the data api. +* **isAvailableInGraph**: bool: Whether property is available in graph or not. +* **isEnum**: bool: Indicates if the property is an enum. +* **isFlagEnum**: bool: Indicates if the property is an flag enum. +* **isImage**: bool: Whether the property is an Image. +* **isLocalizedString**: bool: Whether the property is a localized string. +* **isName**: bool: Whether the property is a name or a part of name. +* **isRequired**: bool: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. +* **maxLength**: int: Max length of string. Used only if type is string. +* **propertyId**: string: The ID associated with the property. +* **schemaItemPropLink**: string: URL encoded schema.org item prop link for the property. -## StrongId +## RelationshipDefinition ### Properties -* **description**: [StrongIdDescription](#strongiddescription): Localized descriptions. -* **displayName**: [StrongIdDisplayName](#strongiddisplayname): Localized display name. -* **keyPropertyNames**: string[] (Required): The properties which make up the unique ID. -* **strongIdName**: string (Required): The Name identifying the strong ID. +* **cardinality**: 'ManyToMany' | 'OneToMany' | 'OneToOne': The Relationship Cardinality. +* **description**: [RelationshipDefinitionDescription](#relationshipdefinitiondescription): Localized descriptions for the Relationship. +* **displayName**: [RelationshipDefinitionDisplayName](#relationshipdefinitiondisplayname): Localized display name for the Relationship. +* **expiryDateTimeUtc**: string: The expiry date time in UTC. +* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Relationship. +* **lookupMappings**: [RelationshipTypeMapping](#relationshiptypemapping)[]: Optional property to be used to map fields in profile to their strong ids in related profile. +* **profileType**: string (Required): Profile type. +* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **relatedProfileType**: string (Required): Related profile being referenced. +* **relationshipGuidId**: string (ReadOnly): The relationship guid id. +* **relationshipName**: string (ReadOnly): The Relationship name. +* **tenantId**: string (ReadOnly): The hub name. -## StrongIdDescription +## RelationshipDefinitionDescription ### Properties ### Additional Properties * **Additional Properties Type**: string -## StrongIdDisplayName +## RelationshipDefinitionDisplayName ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -582,45 +595,25 @@ * **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. * **relationshipFieldName**: string (Required): The field name on the Relationship metadata. -## ParticipantProfilePropertyReference +## RelationshipTypeFieldMapping ### Properties -* **interactionPropertyName**: string (Required): The source interaction property that maps to the target profile property. -* **profilePropertyName**: string (Required): The target profile property that maps to the source interaction property. +* **profileFieldName**: string (Required): Specifies the fieldName in profile. +* **relatedProfileKeyProperty**: string (Required): Specifies the KeyProperty (from StrongId) of the related profile. -## RelationshipDefinition +## RelationshipTypeMapping ### Properties -* **cardinality**: 'ManyToMany' | 'OneToMany' | 'OneToOne': The Relationship Cardinality. -* **description**: [RelationshipDefinitionDescription](#relationshipdefinitiondescription): Localized descriptions for the Relationship. -* **displayName**: [RelationshipDefinitionDisplayName](#relationshipdefinitiondisplayname): Localized display name for the Relationship. -* **expiryDateTimeUtc**: string: The expiry date time in UTC. -* **fields**: [PropertyDefinition](#propertydefinition)[]: The properties of the Relationship. -* **lookupMappings**: [RelationshipTypeMapping](#relationshiptypemapping)[]: Optional property to be used to map fields in profile to their strong ids in related profile. -* **profileType**: string (Required): Profile type. -* **provisioningState**: 'Deleting' | 'Expiring' | 'Failed' | 'HumanIntervention' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Provisioning state. -* **relatedProfileType**: string (Required): Related profile being referenced. -* **relationshipGuidId**: string (ReadOnly): The relationship guid id. -* **relationshipName**: string (ReadOnly): The Relationship name. -* **tenantId**: string (ReadOnly): The hub name. +* **fieldMappings**: [RelationshipTypeFieldMapping](#relationshiptypefieldmapping)[] (Required): Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. -## RelationshipDefinitionDescription +## ResourceSetDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **elements**: string[]: The elements included in the set. +* **exceptions**: string[]: The elements that are not included in the set, in case elements contains '*' indicating 'all'. -## RelationshipDefinitionDisplayName +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## RelationshipTypeMapping -### Properties -* **fieldMappings**: [RelationshipTypeFieldMapping](#relationshiptypefieldmapping)[] (Required): Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. - -## RelationshipTypeFieldMapping -### Properties -* **profileFieldName**: string (Required): Specifies the fieldName in profile. -* **relatedProfileKeyProperty**: string (Required): Specifies the KeyProperty (from StrongId) of the related profile. - ## RoleAssignment ### Properties * **assignmentName**: string (ReadOnly): The name of the metadata object. @@ -644,11 +637,6 @@ * **views**: [ResourceSetDescription](#resourcesetdescription): The resource set description. * **widgetTypes**: [ResourceSetDescription](#resourcesetdescription): The resource set description. -## ResourceSetDescription -### Properties -* **elements**: string[]: The elements included in the set. -* **exceptions**: string[]: The elements that are not included in the set, in case elements contains '*' indicating 'all'. - ## RoleAssignmentDescription ### Properties ### Additional Properties @@ -659,17 +647,29 @@ ### Additional Properties * **Additional Properties Type**: string -## AssignmentPrincipal +## StrongId ### Properties -* **principalId**: string (Required): The principal id being assigned to. -* **principalMetadata**: [AssignmentPrincipalMetadata](#assignmentprincipalmetadata): Other metadata for the principal. -* **principalType**: string (Required): The Type of the principal ID. +* **description**: [StrongIdDescription](#strongiddescription): Localized descriptions. +* **displayName**: [StrongIdDisplayName](#strongiddisplayname): Localized display name. +* **keyPropertyNames**: string[] (Required): The properties which make up the unique ID. +* **strongIdName**: string (Required): The Name identifying the strong ID. -## AssignmentPrincipalMetadata +## StrongIdDescription +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StrongIdDisplayName ### Properties ### Additional Properties * **Additional Properties Type**: string +## TypePropertiesMapping +### Properties +* **linkType**: 'CopyIfNull' | 'UpdateAlways': Link type. +* **sourcePropertyName**: string (Required): Property name on the source Entity Type. +* **targetPropertyName**: string (Required): Property name on the target Entity Type. + ## View ### Properties * **changed**: string (ReadOnly): Date time when view was last modified. diff --git a/generated/customerlockbox/log.out b/generated/customerlockbox/log.out index b651a20959..9842354fe6 100644 --- a/generated/customerlockbox/log.out +++ b/generated/customerlockbox/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.customerlockbox-2018-02-28-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 4.3s. 0 files generated. +info | Autorest completed in 4.19s. 0 files generated. diff --git a/generated/customproviders/log.out b/generated/customproviders/log.out index 4409062e1b..ec7c83db72 100644 --- a/generated/customproviders/log.out +++ b/generated/customproviders/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.customproviders-2018-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ListByCustomRPManifest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/customproviders.json:605:5 @@ -39,5 +39,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefi warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/customproviders.json:945:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms -info | Autorest completed in 4.71s. 2 files generated. +info | autorest.bicep took 20ms +info | Autorest completed in 4.48s. 2 files generated. diff --git a/generated/customproviders/microsoft.customproviders/2018-09-01-preview/types.md b/generated/customproviders/microsoft.customproviders/2018-09-01-preview/types.md index 5a33509738..ca185b52f1 100644 --- a/generated/customproviders/microsoft.customproviders/2018-09-01-preview/types.md +++ b/generated/customproviders/microsoft.customproviders/2018-09-01-preview/types.md @@ -25,6 +25,12 @@ * **provisioningState**: 'Accepted' | 'Deleting' | 'Failed' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioning state of the resource provider. * **targetResourceId**: string: The REST resource instance of the target resource for this association. +## CustomRPActionRouteDefinition +### Properties +* **endpoint**: string (Required): The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') +* **name**: string (Required): The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') +* **routingType**: 'Proxy' | string: The routing types that are supported for action requests. + ## CustomRPManifestProperties ### Properties * **actions**: [CustomRPActionRouteDefinition](#customrpactionroutedefinition)[]: A list of actions that the custom resource provider implements. @@ -32,12 +38,6 @@ * **resourceTypes**: [CustomRPResourceTypeRouteDefinition](#customrpresourcetyperoutedefinition)[]: A list of resource types that the custom resource provider implements. * **validations**: [CustomRPValidations](#customrpvalidations)[]: A list of validations to run on the custom resource provider's requests. -## CustomRPActionRouteDefinition -### Properties -* **endpoint**: string (Required): The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') -* **name**: string (Required): The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') -* **routingType**: 'Proxy' | string: The routing types that are supported for action requests. - ## CustomRPResourceTypeRouteDefinition ### Properties * **endpoint**: string (Required): The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') diff --git a/generated/dashboard/log.out b/generated/dashboard/log.out index 559093d818..231b8e154f 100644 --- a/generated/dashboard/log.out +++ b/generated/dashboard/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.dashboard-2021-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms -info | Autorest completed in 4.58s. 2 files generated. +info | autorest.bicep took 9ms +info | Autorest completed in 4.51s. 2 files generated. diff --git a/generated/dashboard/microsoft.dashboard/2021-09-01-preview/types.md b/generated/dashboard/microsoft.dashboard/2021-09-01-preview/types.md index 94af07d080..495db6d2c0 100644 --- a/generated/dashboard/microsoft.dashboard/2021-09-01-preview/types.md +++ b/generated/dashboard/microsoft.dashboard/2021-09-01-preview/types.md @@ -14,6 +14,19 @@ * **tags**: [ManagedGrafanaTags](#managedgrafanatags): The tags for grafana resource. * **type**: 'Microsoft.Dashboard/grafana' (ReadOnly, DeployTimeConstant): The resource type +## ManagedGrafanaProperties +### Properties +* **autoGeneratedDomainNameLabelScope**: 'TenantReuse' | string +* **endpoint**: string (ReadOnly): The endpoint of the Grafana instance. +* **grafanaVersion**: string (ReadOnly): The Grafana software version. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string +* **zoneRedundancy**: 'Disabled' | 'Enabled' | string + +## ManagedGrafanaTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ManagedIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the system assigned identity. @@ -26,19 +39,6 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ManagedGrafanaProperties -### Properties -* **autoGeneratedDomainNameLabelScope**: 'TenantReuse' | string -* **endpoint**: string (ReadOnly): The endpoint of the Grafana instance. -* **grafanaVersion**: string (ReadOnly): The Grafana software version. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string -* **zoneRedundancy**: 'Disabled' | 'Enabled' | string - ## ResourceSku ### Properties * **name**: string (Required) @@ -52,8 +52,8 @@ * **lastModifiedBy**: string * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string -## ManagedGrafanaTags +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. diff --git a/generated/databox/log.out b/generated/databox/log.out index 937025ef74..09c027558b 100644 --- a/generated/databox/log.out +++ b/generated/databox/log.out @@ -3,26 +3,26 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.databox-2022-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 21ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.databox-2021-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 11ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.databox-2021-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -30,23 +30,23 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.databox-2021-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.databox-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.databox-2020-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -54,26 +54,26 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.databox-2020-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.databox-2019-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databox/resource-manager/Microsoft.DataBox/stable/2019-09-01/databox.json:4074:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.databox-2018-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms -info | Autorest completed in 32.4s. 18 files generated. +info | autorest.bicep took 7ms +info | Autorest completed in 31.04s. 18 files generated. diff --git a/generated/databox/microsoft.databox/2018-01-01/types.md b/generated/databox/microsoft.databox/2018-01-01/types.md index 53116f0cf8..f389c35be5 100644 --- a/generated/databox/microsoft.databox/2018-01-01/types.md +++ b/generated/databox/microsoft.databox/2018-01-01/types.md @@ -17,51 +17,16 @@ * **ApiVersion**: 2018-01-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## JobProperties +## AccountCredentialDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [Error](#error) (ReadOnly): Top level error for the job. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' (ReadOnly): Name of the stage which is in progress. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **destinationAccountDetails**: [DestinationAccountDetails](#destinationaccountdetails)[] (Required): Destination account details. -* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for failure. This is optional. -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress) (Required): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +## ApplianceNetworkConfiguration +### Properties +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. ## ContactDetails ### Properties @@ -72,11 +37,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -101,62 +61,6 @@ * **copyLogLink**: string[] (ReadOnly): Link for copy logs. -## PackageShippingDetails -### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. - -## DestinationAccountDetails -* **Discriminator**: dataDestinationType - -### Base Properties -* **accountId**: string: Arm Id of the destination where the data has to be moved. -### DestinationManagedDiskDetails -#### Properties -* **dataDestinationType**: 'ManagedDisk' (Required): Data Destination Type. -* **resourceGroupId**: string (Required): Destination Resource Group Id where the Compute disks should be created. -* **stagingStorageAccountId**: string (Required): Arm Id of the storage account that can be used to copy the vhd for staging. - -### DestinationStorageAccountDetails -#### Properties -* **dataDestinationType**: 'StorageAccount' (Required): Data Destination Type. -* **storageAccountId**: string (Required): Destination Storage Account Arm Id. - - -## JobErrorDetails -### Properties -* **errorCode**: int (ReadOnly): Code for the error. -* **errorMessage**: string (ReadOnly): Message for the error. -* **exceptionMessage**: string (ReadOnly): Contains the non localized exception message -* **recommendedAction**: string (ReadOnly): Recommended action for the error. - -## JobStages -### Properties -* **displayName**: string (ReadOnly): Display name of the job stage. -* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for the stage. -* **jobStageDetails**: any (ReadOnly): Any object -* **stageName**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' (ReadOnly): Name of the stage which is in progress. -* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | 'SucceededWithErrors' (ReadOnly): Status of the job stage. -* **stageTime**: string (ReadOnly): Time for the job stage in UTC ISO 8601 format. - -## Preferences -### Properties -* **preferredDataCenterRegion**: string[]: Array of PreferencesPreferredDataCenterRegionItem - -## ShippingAddress -### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string (Required): Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. - ## CopyProgress ### Properties * **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. @@ -183,31 +87,101 @@ ### Additional Properties * **Additional Properties Type**: int +## DataBoxHeavySecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DataBoxSecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DestinationAccountDetails +* **Discriminator**: dataDestinationType + +### Base Properties +* **accountId**: string: Arm Id of the destination where the data has to be moved. +### DestinationManagedDiskDetails +#### Properties +* **dataDestinationType**: 'ManagedDisk' (Required): Data Destination Type. +* **resourceGroupId**: string (Required): Destination Resource Group Id where the Compute disks should be created. +* **stagingStorageAccountId**: string (Required): Arm Id of the storage account that can be used to copy the vhd for staging. + +### DestinationStorageAccountDetails +#### Properties +* **dataDestinationType**: 'StorageAccount' (Required): Data Destination Type. +* **storageAccountId**: string (Required): Destination Storage Account Arm Id. + + +## DiskSecret +### Properties +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. + ## Error ### Properties * **code**: string (ReadOnly): Error code that can be used to programmatically identify the error. * **message**: string (ReadOnly): Describes the error in detail and provides debugging information. -## Sku -### Properties -* **displayName**: string: The display name of the sku. -* **family**: string: The sku family. -* **name**: 'DataBox' | 'DataBoxDisk' | 'DataBoxHeavy' (Required) +## JobDetails +* **Discriminator**: jobDetailsType -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **destinationAccountDetails**: [DestinationAccountDetails](#destinationaccountdetails)[] (Required): Destination account details. +* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for failure. This is optional. +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress) (Required): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. -## UnencryptedCredentialsList +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobErrorDetails ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **errorCode**: int (ReadOnly): Code for the error. +* **errorMessage**: string (ReadOnly): Message for the error. +* **exceptionMessage**: string (ReadOnly): Contains the non localized exception message +* **recommendedAction**: string (ReadOnly): Recommended action for the error. -## UnencryptedCredentials +## JobProperties ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [Error](#error) (ReadOnly): Top level error for the job. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' (ReadOnly): Name of the stage which is in progress. ## JobSecrets * **Discriminator**: jobSecretsType @@ -231,19 +205,34 @@ * **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. -## DataBoxSecret +## JobStages ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **displayName**: string (ReadOnly): Display name of the job stage. +* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for the stage. +* **jobStageDetails**: any (ReadOnly): Any object +* **stageName**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' (ReadOnly): Name of the stage which is in progress. +* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | 'SucceededWithErrors' (ReadOnly): Status of the job stage. +* **stageTime**: string (ReadOnly): Time for the job stage in UTC ISO 8601 format. -## AccountCredentialDetails +## NotificationPreference ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. + +## PackageShippingDetails +### Properties +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. + +## Preferences +### Properties +* **preferredDataCenterRegion**: string[]: Array of PreferencesPreferredDataCenterRegionItem + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ShareCredentialDetails ### Properties @@ -253,21 +242,32 @@ * **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. * **userName**: string (ReadOnly): User name for the share. -## ApplianceNetworkConfiguration +## ShippingAddress ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string (Required): Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. -## DiskSecret +## Sku ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **displayName**: string: The display name of the sku. +* **family**: string: The sku family. +* **name**: 'DataBox' | 'DataBoxDisk' | 'DataBoxHeavy' (Required) -## DataBoxHeavySecret +## UnencryptedCredentials ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets + +## UnencryptedCredentialsList +### Properties +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. diff --git a/generated/databox/microsoft.databox/2019-09-01/types.md b/generated/databox/microsoft.databox/2019-09-01/types.md index 08b362ad88..820bffa1f2 100644 --- a/generated/databox/microsoft.databox/2019-09-01/types.md +++ b/generated/databox/microsoft.databox/2019-09-01/types.md @@ -17,60 +17,17 @@ * **ApiVersion**: 2019-09-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## JobProperties +## AccountCredentialDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [Error](#error) (ReadOnly): Top level error for the job. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataDestinationType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Data Destination Type. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## JobDeliveryInfo +## ApplianceNetworkConfiguration ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **destinationAccountDetails**: [DestinationAccountDetails](#destinationaccountdetails)[] (Required): Destination account details. -* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for failure. This is optional. -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress) (Required): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. - +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. ## ContactDetails ### Properties @@ -81,11 +38,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -110,68 +62,6 @@ * **copyLogLink**: string[] (ReadOnly): Link for copy logs. -## PackageShippingDetails -### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. - -## DestinationAccountDetails -* **Discriminator**: dataDestinationType - -### Base Properties -* **accountId**: string: Arm Id of the destination where the data has to be moved. -* **sharePassword**: string: Share password to be shared by all shares in SA. -### DestinationManagedDiskDetails -#### Properties -* **dataDestinationType**: 'ManagedDisk' (Required): Data Destination Type. -* **resourceGroupId**: string (Required): Destination Resource Group Id where the Compute disks should be created. -* **stagingStorageAccountId**: string (Required): Arm Id of the storage account that can be used to copy the vhd for staging. - -### DestinationStorageAccountDetails -#### Properties -* **dataDestinationType**: 'StorageAccount' (Required): Data Destination Type. -* **storageAccountId**: string (Required): Destination Storage Account Arm Id. - - -## JobErrorDetails -### Properties -* **errorCode**: int (ReadOnly): Code for the error. -* **errorMessage**: string (ReadOnly): Message for the error. -* **exceptionMessage**: string (ReadOnly): Contains the non localized exception message -* **recommendedAction**: string (ReadOnly): Recommended action for the error. - -## JobStages -### Properties -* **displayName**: string (ReadOnly): Display name of the job stage. -* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for the stage. -* **jobStageDetails**: any (ReadOnly): Any object -* **stageName**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. -* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | 'SucceededWithErrors' (ReadOnly): Status of the job stage. -* **stageTime**: string (ReadOnly): Time for the job stage in UTC ISO 8601 format. - -## Preferences -### Properties -* **preferredDataCenterRegion**: string[]: Preferred Data Center Region. -* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku - -## TransportPreferences -### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. - -## ShippingAddress -### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string (Required): Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. - ## CopyProgress ### Properties * **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. @@ -203,31 +93,116 @@ ### Additional Properties * **Additional Properties Type**: int +## DataBoxHeavySecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DataBoxSecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DcAccessSecurityCode +### Properties +* **forwardDCAccessCode**: string (ReadOnly): Dc Access Code for dispatching from DC. +* **reverseDCAccessCode**: string (ReadOnly): Dc Access code for dropping off at DC. + +## DestinationAccountDetails +* **Discriminator**: dataDestinationType + +### Base Properties +* **accountId**: string: Arm Id of the destination where the data has to be moved. +* **sharePassword**: string: Share password to be shared by all shares in SA. +### DestinationManagedDiskDetails +#### Properties +* **dataDestinationType**: 'ManagedDisk' (Required): Data Destination Type. +* **resourceGroupId**: string (Required): Destination Resource Group Id where the Compute disks should be created. +* **stagingStorageAccountId**: string (Required): Arm Id of the storage account that can be used to copy the vhd for staging. + +### DestinationStorageAccountDetails +#### Properties +* **dataDestinationType**: 'StorageAccount' (Required): Data Destination Type. +* **storageAccountId**: string (Required): Destination Storage Account Arm Id. + + +## DiskSecret +### Properties +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. + ## Error ### Properties * **code**: string (ReadOnly): Error code that can be used to programmatically identify the error. * **message**: string (ReadOnly): Describes the error in detail and provides debugging information. -## Sku +## JobDeliveryInfo ### Properties -* **displayName**: string: The display name of the sku. -* **family**: string: The sku family. -* **name**: 'DataBox' | 'DataBoxDisk' | 'DataBoxHeavy' (Required) +* **scheduledDateTime**: string: Scheduled date time. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## JobDetails +* **Discriminator**: jobDetailsType -## UnencryptedCredentialsList +### Base Properties +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **destinationAccountDetails**: [DestinationAccountDetails](#destinationaccountdetails)[] (Required): Destination account details. +* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for failure. This is optional. +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress) (Required): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobErrorDetails ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **errorCode**: int (ReadOnly): Code for the error. +* **errorMessage**: string (ReadOnly): Message for the error. +* **exceptionMessage**: string (ReadOnly): Contains the non localized exception message +* **recommendedAction**: string (ReadOnly): Recommended action for the error. -## UnencryptedCredentials +## JobProperties ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [Error](#error) (ReadOnly): Top level error for the job. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. ## JobSecrets * **Discriminator**: jobSecretsType @@ -252,25 +227,35 @@ * **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. -## DcAccessSecurityCode +## JobStages ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Dc Access Code for dispatching from DC. -* **reverseDCAccessCode**: string (ReadOnly): Dc Access code for dropping off at DC. +* **displayName**: string (ReadOnly): Display name of the job stage. +* **errorDetails**: [JobErrorDetails](#joberrordetails)[] (ReadOnly): Error details for the stage. +* **jobStageDetails**: any (ReadOnly): Any object +* **stageName**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. +* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | 'SucceededWithErrors' (ReadOnly): Status of the job stage. +* **stageTime**: string (ReadOnly): Time for the job stage in UTC ISO 8601 format. -## DataBoxSecret +## NotificationPreference ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. -## AccountCredentialDetails +## PackageShippingDetails ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataDestinationType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Data Destination Type. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. + +## Preferences +### Properties +* **preferredDataCenterRegion**: string[]: Preferred Data Center Region. +* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ShareCredentialDetails ### Properties @@ -280,21 +265,36 @@ * **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. * **userName**: string (ReadOnly): User name for the share. -## ApplianceNetworkConfiguration +## ShippingAddress ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string (Required): Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. -## DiskSecret +## Sku ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **displayName**: string: The display name of the sku. +* **family**: string: The sku family. +* **name**: 'DataBox' | 'DataBoxDisk' | 'DataBoxHeavy' (Required) -## DataBoxHeavySecret +## TransportPreferences ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. + +## UnencryptedCredentials +### Properties +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets + +## UnencryptedCredentialsList +### Properties +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. diff --git a/generated/databox/microsoft.databox/2020-04-01/types.md b/generated/databox/microsoft.databox/2020-04-01/types.md index 8c3a58d06c..1d73168829 100644 --- a/generated/databox/microsoft.databox/2020-04-01/types.md +++ b/generated/databox/microsoft.databox/2020-04-01/types.md @@ -18,69 +18,42 @@ * **ApiVersion**: 2020-04-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## JobProperties +## AdditionalErrorInfo ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **info**: any: Any object +* **type**: string: Additional error type. -## JobDeliveryInfo +## ApplianceNetworkConfiguration ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey) (ReadOnly): Encryption key containing details about key to encrypt different keys. -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. +## AzureFileFilterDetails +### Properties +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +## BlobFilterDetails +### Properties +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. +* **code**: string: Cloud error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. +* **message**: string: Cloud error message. +* **target**: string: Cloud error target. ## ContactDetails ### Properties @@ -91,11 +64,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -122,11 +90,24 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. -## DataExportDetails +## CopyProgress ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. -* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. ## DataAccountDetails * **Discriminator**: dataAccountType @@ -145,59 +126,145 @@ * **storageAccountId**: string (Required): Storage Account Resource Id. -## TransferConfiguration +## DataBoxDiskCopyProgress ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy -## TransferConfigurationTransferAllDetails +## DataBoxDiskJobDetailsDisksAndSizeDetails ### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. +### Additional Properties +* **Additional Properties Type**: int -## TransferAllDetails +## DataBoxDiskJobDetailsPreferredDisks ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +### Additional Properties +* **Additional Properties Type**: int -## TransferConfigurationTransferFilterDetails +## DataBoxHeavySecret ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## TransferFilterDetails +## DataBoxSecret ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## AzureFileFilterDetails +## DataExportDetails ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## BlobFilterDetails +## DataImportDetails ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred + +## DcAccessSecurityCode +### Properties +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. + +## DiskSecret +### Properties +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. ## FilterFileDetails ### Properties * **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. * **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## DataImportDetails +## JobDeliveryInfo ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **scheduledDateTime**: string: Scheduled date time. -## PackageShippingDetails +## JobDetails +* **Discriminator**: jobDetailsType + +### Base Properties +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey) (ReadOnly): Encryption key containing details about key to encrypt different keys. +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -213,14 +280,40 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. +## NotificationPreference +### Properties +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. + +## PackageShippingDetails +### Properties +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. + ## Preferences ### Properties * **preferredDataCenterRegion**: string[]: Preferred data center region. * **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## TransportPreferences +## ResourceIdentity ### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ShareCredentialDetails +### Properties +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. ## ShippingAddress ### Properties @@ -235,143 +328,50 @@ * **streetAddress3**: string: Street Address line 3. * **zipExtendedCode**: string: Extended Zip Code. -## CopyProgress -### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. - -## DataBoxDiskCopyProgress -### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy - -## DataBoxDiskJobDetailsDisksAndSizeDetails -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## DataBoxDiskJobDetailsPreferredDisks -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## CloudError -### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. -* **code**: string: Cloud error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. -* **message**: string: Cloud error message. -* **target**: string: Cloud error target. - -## AdditionalErrorInfo -### Properties -* **info**: any: Any object -* **type**: string: Additional error type. - ## Sku ### Properties * **displayName**: string: The display name of the sku. * **family**: string: The sku family. * **name**: 'DataBox' | 'DataBoxDisk' | 'DataBoxHeavy' (Required) -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## UnencryptedCredentialsList -### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. - -## UnencryptedCredentials +## TransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## DcAccessSecurityCode +## TransferConfiguration ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## DataBoxSecret +## TransferConfigurationTransferAllDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## AccountCredentialDetails +## TransferConfigurationTransferFilterDetails ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## ShareCredentialDetails +## TransferFilterDetails ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## ApplianceNetworkConfiguration +## TransportPreferences ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## DiskSecret +## UnencryptedCredentials ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## DataBoxHeavySecret +## UnencryptedCredentialsList ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. diff --git a/generated/databox/microsoft.databox/2020-11-01/types.md b/generated/databox/microsoft.databox/2020-11-01/types.md index 1245d2d8a0..8f9e7bea12 100644 --- a/generated/databox/microsoft.databox/2020-11-01/types.md +++ b/generated/databox/microsoft.databox/2020-11-01/types.md @@ -19,80 +19,42 @@ * **ApiVersion**: 2020-11-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## ResourceIdentityUserAssignedIdentities +## AdditionalErrorInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **info**: any: Any object +* **type**: string: Additional error type. -## UserAssignedIdentity +## ApplianceNetworkConfiguration ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -## JobProperties +## AzureFileFilterDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -## JobDeliveryInfo +## BlobFilterDetails ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. +* **code**: string: Cloud error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. +* **message**: string: Cloud error message. +* **target**: string: Cloud error target. ## ContactDetails ### Properties @@ -103,11 +65,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -134,11 +91,24 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. -## DataExportDetails +## CopyProgress ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. -* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. ## DataAccountDetails * **Discriminator**: dataAccountType @@ -157,59 +127,154 @@ * **storageAccountId**: string (Required): Storage Account Resource Id. -## TransferConfiguration +## DataBoxDiskCopyProgress ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy -## TransferConfigurationTransferAllDetails +## DataBoxDiskJobDetailsDisksAndSizeDetails ### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. +### Additional Properties +* **Additional Properties Type**: int -## TransferAllDetails +## DataBoxDiskJobDetailsPreferredDisks ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +### Additional Properties +* **Additional Properties Type**: int -## TransferConfigurationTransferFilterDetails +## DataBoxHeavySecret ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## TransferFilterDetails +## DataBoxSecret ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## AzureFileFilterDetails +## DataExportDetails ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## BlobFilterDetails +## DataImportDetails ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred + +## DcAccessSecurityCode +### Properties +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. + +## DiskSecret +### Properties +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. + +## EncryptionPreferences +### Properties +* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. ## FilterFileDetails ### Properties * **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. * **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## DataImportDetails +## IdentityProperties ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **type**: string: Managed service identity type. +* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. -## PackageShippingDetails +## JobDeliveryInfo ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **scheduledDateTime**: string: Scheduled date time. + +## JobDetails +* **Discriminator**: jobDetailsType + +### Base Properties +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties +### Properties +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -226,14 +291,16 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. -## IdentityProperties +## NotificationPreference ### Properties -* **type**: string: Managed service identity type. -* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. -## UserAssignedProperties +## PackageShippingDetails ### Properties -* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. ## Preferences ### Properties @@ -241,13 +308,30 @@ * **preferredDataCenterRegion**: string[]: Preferred data center region. * **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## EncryptionPreferences +## ResourceIdentity ### Properties -* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities -## TransportPreferences +## ResourceIdentityUserAssignedIdentities ### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ShareCredentialDetails +### Properties +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. ## ShippingAddress ### Properties @@ -262,55 +346,6 @@ * **streetAddress3**: string: Street Address line 3. * **zipExtendedCode**: string: Extended Zip Code. -## CopyProgress -### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. - -## DataBoxDiskCopyProgress -### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy - -## DataBoxDiskJobDetailsDisksAndSizeDetails -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## DataBoxDiskJobDetailsPreferredDisks -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## CloudError -### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. -* **code**: string: Cloud error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. -* **message**: string: Cloud error message. -* **target**: string: Cloud error target. - -## AdditionalErrorInfo -### Properties -* **info**: any: Any object -* **type**: string: Additional error type. - ## Sku ### Properties * **displayName**: string: The display name of the sku. @@ -326,88 +361,53 @@ Until this is true, the TotalBytesToProcess may not be valid. * **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource * **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity -## ResourceTags +## TransferAllDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## UnencryptedCredentialsList +## TransferConfiguration ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## UnencryptedCredentials +## TransferConfigurationTransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## DcAccessSecurityCode +## TransferConfigurationTransferFilterDetails ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## DataBoxSecret +## TransferFilterDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## AccountCredentialDetails +## TransportPreferences ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## ShareCredentialDetails +## UnencryptedCredentials ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## ApplianceNetworkConfiguration +## UnencryptedCredentialsList ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. -## DiskSecret +## UserAssignedIdentity ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## DataBoxHeavySecret +## UserAssignedProperties ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. diff --git a/generated/databox/microsoft.databox/2021-03-01/types.md b/generated/databox/microsoft.databox/2021-03-01/types.md index 8aff44fc8d..eb5e3613b9 100644 --- a/generated/databox/microsoft.databox/2021-03-01/types.md +++ b/generated/databox/microsoft.databox/2021-03-01/types.md @@ -19,82 +19,42 @@ * **ApiVersion**: 2021-03-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## ResourceIdentityUserAssignedIdentities +## AdditionalErrorInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **info**: any: Any object +* **type**: string: Additional error type. -## UserAssignedIdentity +## ApplianceNetworkConfiguration ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -## JobProperties +## AzureFileFilterDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -## JobDeliveryInfo +## BlobFilterDetails ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **actions**: 'MoveToCleanUpDevice' | 'None' | 'Resume'[] (ReadOnly): Available actions on the job. -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. -* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. +* **code**: string: Cloud error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. +* **message**: string: Cloud error message. +* **target**: string: Cloud error target. ## ContactDetails ### Properties @@ -105,11 +65,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -136,11 +91,24 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. -## DataExportDetails +## CopyProgress ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. -* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. ## DataAccountDetails * **Discriminator**: dataAccountType @@ -159,59 +127,156 @@ * **storageAccountId**: string (Required): Storage Account Resource Id. -## TransferConfiguration +## DataBoxDiskCopyProgress ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy -## TransferConfigurationTransferAllDetails +## DataBoxDiskJobDetailsDisksAndSizeDetails ### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. +### Additional Properties +* **Additional Properties Type**: int -## TransferAllDetails +## DataBoxDiskJobDetailsPreferredDisks ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +### Additional Properties +* **Additional Properties Type**: int -## TransferConfigurationTransferFilterDetails +## DataBoxHeavySecret ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## TransferFilterDetails +## DataBoxSecret ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## AzureFileFilterDetails +## DataExportDetails ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## BlobFilterDetails +## DataImportDetails ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred + +## DcAccessSecurityCode +### Properties +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. + +## DiskSecret +### Properties +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. + +## EncryptionPreferences +### Properties +* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. ## FilterFileDetails ### Properties * **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. * **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## DataImportDetails +## IdentityProperties ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **type**: string: Managed service identity type. +* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. -## PackageShippingDetails +## JobDeliveryInfo ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **scheduledDateTime**: string: Scheduled date time. + +## JobDetails +* **Discriminator**: jobDetailsType + +### Base Properties +* **actions**: 'MoveToCleanUpDevice' | 'None' | 'Resume'[] (ReadOnly): Available actions on the job. +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. +* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties +### Properties +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -228,15 +293,6 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. -## IdentityProperties -### Properties -* **type**: string: Managed service identity type. -* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. - -## UserAssignedProperties -### Properties -* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. - ## LastMitigationActionOnJob ### Properties * **actionDateTimeInUtc**: string: Action performed date time @@ -244,19 +300,47 @@ * **isPerformedByCustomer**: bool: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops +## NotificationPreference +### Properties +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. + +## PackageShippingDetails +### Properties +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. + ## Preferences ### Properties * **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. * **preferredDataCenterRegion**: string[]: Preferred data center region. * **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## EncryptionPreferences +## ResourceIdentity ### Properties -* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities -## TransportPreferences +## ResourceIdentityUserAssignedIdentities ### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ShareCredentialDetails +### Properties +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. ## ShippingAddress ### Properties @@ -271,55 +355,6 @@ possibility is that mitigation might happen by customer or service or by ops * **streetAddress3**: string: Street Address line 3. * **zipExtendedCode**: string: Extended Zip Code. -## CopyProgress -### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. - -## DataBoxDiskCopyProgress -### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy - -## DataBoxDiskJobDetailsDisksAndSizeDetails -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## DataBoxDiskJobDetailsPreferredDisks -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## CloudError -### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. -* **code**: string: Cloud error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. -* **message**: string: Cloud error message. -* **target**: string: Cloud error target. - -## AdditionalErrorInfo -### Properties -* **info**: any: Any object -* **type**: string: Additional error type. - ## Sku ### Properties * **displayName**: string: The display name of the sku. @@ -335,88 +370,53 @@ Until this is true, the TotalBytesToProcess may not be valid. * **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource * **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity -## ResourceTags +## TransferAllDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## UnencryptedCredentialsList +## TransferConfiguration ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## UnencryptedCredentials +## TransferConfigurationTransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## DcAccessSecurityCode +## TransferConfigurationTransferFilterDetails ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## DataBoxSecret +## TransferFilterDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## AccountCredentialDetails +## TransportPreferences ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## ShareCredentialDetails +## UnencryptedCredentials ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## ApplianceNetworkConfiguration +## UnencryptedCredentialsList ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. -## DiskSecret +## UserAssignedIdentity ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## DataBoxHeavySecret +## UserAssignedProperties ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. diff --git a/generated/databox/microsoft.databox/2021-05-01/types.md b/generated/databox/microsoft.databox/2021-05-01/types.md index 374708c7b0..3ef9232298 100644 --- a/generated/databox/microsoft.databox/2021-05-01/types.md +++ b/generated/databox/microsoft.databox/2021-05-01/types.md @@ -19,82 +19,42 @@ * **ApiVersion**: 2021-05-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## ResourceIdentityUserAssignedIdentities +## AdditionalErrorInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **info**: any: Any object +* **type**: string: Additional error type. -## UserAssignedIdentity +## ApplianceNetworkConfiguration ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -## JobProperties +## AzureFileFilterDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -## JobDeliveryInfo +## BlobFilterDetails ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **actions**: 'MoveToCleanUpDevice' | 'None' | 'Resume'[] (ReadOnly): Available actions on the job. -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. -* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. +* **code**: string: Cloud error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. +* **message**: string: Cloud error message. +* **target**: string: Cloud error target. ## ContactDetails ### Properties @@ -105,11 +65,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -136,11 +91,24 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. -## DataExportDetails +## CopyProgress ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. -* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. ## DataAccountDetails * **Discriminator**: dataAccountType @@ -159,59 +127,156 @@ * **storageAccountId**: string (Required): Storage Account Resource Id. -## TransferConfiguration +## DataBoxDiskCopyProgress ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy -## TransferConfigurationTransferAllDetails +## DataBoxDiskJobDetailsDisksAndSizeDetails ### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. +### Additional Properties +* **Additional Properties Type**: int -## TransferAllDetails +## DataBoxDiskJobDetailsPreferredDisks ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +### Additional Properties +* **Additional Properties Type**: int -## TransferConfigurationTransferFilterDetails +## DataBoxHeavySecret ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## TransferFilterDetails +## DataBoxSecret ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. -## AzureFileFilterDetails +## DataExportDetails ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +* **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## BlobFilterDetails +## DataImportDetails ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred + +## DcAccessSecurityCode +### Properties +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. + +## DiskSecret +### Properties +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. + +## EncryptionPreferences +### Properties +* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. ## FilterFileDetails ### Properties * **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. * **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## DataImportDetails +## IdentityProperties ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **type**: string: Managed service identity type. +* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. -## PackageShippingDetails +## JobDeliveryInfo ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **scheduledDateTime**: string: Scheduled date time. + +## JobDetails +* **Discriminator**: jobDetailsType + +### Base Properties +* **actions**: 'MoveToCleanUpDevice' | 'None' | 'Resume'[] (ReadOnly): Available actions on the job. +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. +* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): Shipping details. +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties +### Properties +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -228,15 +293,6 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. -## IdentityProperties -### Properties -* **type**: string: Managed service identity type. -* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. - -## UserAssignedProperties -### Properties -* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. - ## LastMitigationActionOnJob ### Properties * **actionDateTimeInUtc**: string: Action performed date time @@ -244,19 +300,47 @@ * **isPerformedByCustomer**: bool: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops +## NotificationPreference +### Properties +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' (Required): Name of the stage. + +## PackageShippingDetails +### Properties +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. + ## Preferences ### Properties * **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. * **preferredDataCenterRegion**: string[]: Preferred data center region. * **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## EncryptionPreferences +## ResourceIdentity ### Properties -* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities -## TransportPreferences +## ResourceIdentityUserAssignedIdentities ### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ShareCredentialDetails +### Properties +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. ## ShippingAddress ### Properties @@ -271,55 +355,6 @@ possibility is that mitigation might happen by customer or service or by ops * **streetAddress3**: string: Street Address line 3. * **zipExtendedCode**: string: Extended Zip Code. -## CopyProgress -### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. - -## DataBoxDiskCopyProgress -### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'Failed' | 'HardwareError' | 'InProgress' | 'NotReturned' | 'NotStarted' | 'StorageAccountNotAccessible' | 'UnsupportedData' (ReadOnly): The Status of the copy - -## DataBoxDiskJobDetailsDisksAndSizeDetails -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## DataBoxDiskJobDetailsPreferredDisks -### Properties -### Additional Properties -* **Additional Properties Type**: int - -## CloudError -### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. -* **code**: string: Cloud error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. -* **message**: string: Cloud error message. -* **target**: string: Cloud error target. - -## AdditionalErrorInfo -### Properties -* **info**: any: Any object -* **type**: string: Additional error type. - ## Sku ### Properties * **displayName**: string: The display name of the sku. @@ -335,88 +370,53 @@ Until this is true, the TotalBytesToProcess may not be valid. * **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource * **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity -## ResourceTags +## TransferAllDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## UnencryptedCredentialsList +## TransferConfiguration ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## UnencryptedCredentials +## TransferConfigurationTransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## DcAccessSecurityCode +## TransferConfigurationTransferFilterDetails ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## DataBoxSecret +## TransferFilterDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## AccountCredentialDetails +## TransportPreferences ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## ShareCredentialDetails +## UnencryptedCredentials ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## ApplianceNetworkConfiguration +## UnencryptedCredentialsList ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. -## DiskSecret +## UserAssignedIdentity ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## DataBoxHeavySecret +## UserAssignedProperties ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. diff --git a/generated/databox/microsoft.databox/2021-08-01-preview/types.md b/generated/databox/microsoft.databox/2021-08-01-preview/types.md index 53d0ed5d88..c66ddfbedc 100644 --- a/generated/databox/microsoft.databox/2021-08-01-preview/types.md +++ b/generated/databox/microsoft.databox/2021-08-01-preview/types.md @@ -19,94 +19,42 @@ * **ApiVersion**: 2021-08-01-preview * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## ResourceIdentityUserAssignedIdentities +## AdditionalErrorInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **info**: any: Any object +* **type**: string: Additional error type. -## UserAssignedIdentity +## ApplianceNetworkConfiguration ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -## JobProperties +## AzureFileFilterDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'AwaitingShipmentDetails' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'Created' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'PreparingToShipFromAzureDC' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' | 'ShippedToAzureDC' | 'ShippedToCustomer' | string (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -## JobDeliveryInfo +## BlobFilterDetails ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **actions**: 'MoveToCleanUpDevice' | 'None' | 'Resume'[] (ReadOnly): Available actions on the job. -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **datacenterAddress**: [DatacenterAddressResponse](#datacenteraddressresponse) (ReadOnly): Datacenter address for given storage location. -* **dataCenterCode**: 'AM2' | 'AMS06' | 'AMS20' | 'AUH20' | 'AdHoc' | 'BJB' | 'BL20' | 'BL7' | 'BN1' | 'BN7' | 'BOM01' | 'BY1' | 'BY2' | 'BY21' | 'BY24' | 'CBR20' | 'CH1' | 'CPQ02' | 'CPQ20' | 'CWL20' | 'CYS04' | 'DSM05' | 'FRA22' | 'HKG20' | 'Invalid' | 'JNB21' | 'JNB22' | 'LON24' | 'MAA01' | 'MEL23' | 'MNZ21' | 'MWH01' | 'ORK70' | 'OSA20' | 'PAR22' | 'PUS20' | 'SEL20' | 'SEL21' | 'SG2' | 'SHA03' | 'SIN20' | 'SN5' | 'SN6' | 'SN8' | 'SSE90' | 'SYD03' | 'SYD23' | 'TYO01' | 'TYO22' | 'YQB20' | 'YTO20' | 'YTO21' | 'ZRH20' | string (ReadOnly): DataCenter code. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. -* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxCustomerDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxCustomerDiskCopyProgress](#databoxcustomerdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **deliverToDcPackageDetails**: [PackageCarrierInfo](#packagecarrierinfo) (ReadOnly): package carrier info -* **enableManifestBackup**: bool: Flag to indicate if disk manifest should be backed-up in the Storage Account. -* **exportDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection](#databoxcustomerdiskjobdetailsexportdiskdetailscollection) (ReadOnly): Contains the map of disk serial number to the disk details for export jobs. -* **importDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection](#databoxcustomerdiskjobdetailsimportdiskdetailscollection): Contains the map of disk serial number to the disk details for import jobs. -* **jobDetailsType**: 'DataBoxCustomerDisk' (Required): Indicates the type of job details. -* **returnToCustomerPackageDetails**: [PackageCarrierDetails](#packagecarrierdetails) (Required): Package carrier details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. +* **code**: string: Cloud error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. +* **message**: string: Cloud error message. +* **target**: string: Cloud error target. ## ContactDetails ### Properties @@ -117,11 +65,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'Created' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' | 'ShippedToCustomer' | string (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -155,6 +98,106 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. +## CopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataAccountDetails +* **Discriminator**: dataAccountType + +### Base Properties +* **sharePassword**: string (WriteOnly): Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +### ManagedDiskDetails +#### Properties +* **dataAccountType**: 'ManagedDisk' (Required): Account Type of the data to be transferred. +* **resourceGroupId**: string (Required): Resource Group Id of the compute disks. +* **stagingStorageAccountId**: string (Required): Resource Id of the storage account that can be used to copy the vhd for staging. + +### StorageAccountDetails +#### Properties +* **dataAccountType**: 'StorageAccount' (Required): Account Type of the data to be transferred. +* **storageAccountId**: string (Required): Storage Account Resource Id. + + +## DataBoxCustomerDiskCopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **serialNumber**: string (ReadOnly): Disk Serial Number. +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ExportDiskDetails](#exportdiskdetails) + +## DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ImportDiskDetails](#importdiskdetails) + +## DataBoxDiskCopyProgress +### Properties +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy + +## DataBoxDiskJobDetailsDisksAndSizeDetails +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## DataBoxDiskJobDetailsPreferredDisks +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## DataBoxHeavySecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DataBoxSecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + ## DatacenterAddressResponse * **Discriminator**: datacenterAddressType @@ -190,77 +233,149 @@ * **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. * **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## DataAccountDetails -* **Discriminator**: dataAccountType - -### Base Properties -* **sharePassword**: string (WriteOnly): Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -### ManagedDiskDetails -#### Properties -* **dataAccountType**: 'ManagedDisk' (Required): Account Type of the data to be transferred. -* **resourceGroupId**: string (Required): Resource Group Id of the compute disks. -* **stagingStorageAccountId**: string (Required): Resource Id of the storage account that can be used to copy the vhd for staging. - -### StorageAccountDetails -#### Properties -* **dataAccountType**: 'StorageAccount' (Required): Account Type of the data to be transferred. -* **storageAccountId**: string (Required): Storage Account Resource Id. - +## DataImportDetails +### Properties +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. -## TransferConfiguration +## DcAccessSecurityCode ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. -## TransferConfigurationTransferAllDetails +## DiskSecret ### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. -## TransferAllDetails +## EncryptionPreferences ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. -## TransferConfigurationTransferFilterDetails +## ExportDiskDetails ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. +* **manifestFile**: string (ReadOnly): The relative path of the manifest file on the disk. +* **manifestHash**: string (ReadOnly): The Base16-encoded MD5 hash of the manifest file on the disk. -## TransferFilterDetails +## FilterFileDetails ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. +* **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## AzureFileFilterDetails +## IdentityProperties ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **type**: string: Managed service identity type. +* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. -## BlobFilterDetails +## ImportDiskDetails ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. +* **bitLockerKey**: string (Required): BitLocker key used to encrypt the disk. +* **manifestFile**: string (Required): The relative path of the manifest file on the disk. +* **manifestHash**: string (Required): The Base16-encoded MD5 hash of the manifest file on the disk. -## FilterFileDetails +## JobDeliveryInfo ### Properties -* **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. -* **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. +* **scheduledDateTime**: string: Scheduled date time. -## DataImportDetails -### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +## JobDetails +* **Discriminator**: jobDetailsType -## PackageShippingDetails +### Base Properties +* **actions**: 'MoveToCleanUpDevice' | 'None' | 'Resume'[] (ReadOnly): Available actions on the job. +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **datacenterAddress**: [DatacenterAddressResponse](#datacenteraddressresponse) (ReadOnly): Datacenter address for given storage location. +* **dataCenterCode**: 'AM2' | 'AMS06' | 'AMS20' | 'AUH20' | 'AdHoc' | 'BJB' | 'BL20' | 'BL7' | 'BN1' | 'BN7' | 'BOM01' | 'BY1' | 'BY2' | 'BY21' | 'BY24' | 'CBR20' | 'CH1' | 'CPQ02' | 'CPQ20' | 'CWL20' | 'CYS04' | 'DSM05' | 'FRA22' | 'HKG20' | 'Invalid' | 'JNB21' | 'JNB22' | 'LON24' | 'MAA01' | 'MEL23' | 'MNZ21' | 'MWH01' | 'ORK70' | 'OSA20' | 'PAR22' | 'PUS20' | 'SEL20' | 'SEL21' | 'SG2' | 'SHA03' | 'SIN20' | 'SN5' | 'SN6' | 'SN8' | 'SSE90' | 'SYD03' | 'SYD23' | 'TYO01' | 'TYO22' | 'YQB20' | 'YTO20' | 'YTO21' | 'ZRH20' | string (ReadOnly): DataCenter code. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. +* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxCustomerDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxCustomerDiskCopyProgress](#databoxcustomerdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **deliverToDcPackageDetails**: [PackageCarrierInfo](#packagecarrierinfo) (ReadOnly): package carrier info +* **enableManifestBackup**: bool: Flag to indicate if disk manifest should be backed-up in the Storage Account. +* **exportDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection](#databoxcustomerdiskjobdetailsexportdiskdetailscollection) (ReadOnly): Contains the map of disk serial number to the disk details for export jobs. +* **importDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection](#databoxcustomerdiskjobdetailsimportdiskdetailscollection): Contains the map of disk serial number to the disk details for import jobs. +* **jobDetailsType**: 'DataBoxCustomerDisk' (Required): Indicates the type of job details. +* **returnToCustomerPackageDetails**: [PackageCarrierDetails](#packagecarrierdetails) (Required): Package carrier details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'AwaitingShipmentDetails' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'Created' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'PreparingToShipFromAzureDC' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' | 'ShippedToAzureDC' | 'ShippedToCustomer' | string (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### CustomerDiskJobSecrets +#### Properties +* **carrierAccountNumber**: string (ReadOnly): Carrier Account Number of the customer +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **jobSecretsType**: 'DataBoxCustomerDisk' (Required): Used to indicate what type of job secrets object. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -277,15 +392,6 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. -## IdentityProperties -### Properties -* **type**: string: Managed service identity type. -* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. - -## UserAssignedProperties -### Properties -* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. - ## LastMitigationActionOnJob ### Properties * **actionDateTimeInUtc**: string: Action performed date time @@ -293,136 +399,71 @@ * **isPerformedByCustomer**: bool: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops -## Preferences -### Properties -* **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. -* **preferredDataCenterRegion**: string[]: Preferred data center region. -* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku - -## EncryptionPreferences -### Properties -* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. - -## TransportPreferences -### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. - -## ShippingAddress -### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string: Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. - -## CopyProgress +## NotificationPreference ### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'Created' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' | 'ShippedToCustomer' | string (Required): Name of the stage. -## DataBoxCustomerDiskCopyProgress +## PackageCarrierDetails ### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **serialNumber**: string (ReadOnly): Disk Serial Number. -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **carrierAccountNumber**: string: Carrier Account Number of customer for customer disk. +* **carrierName**: string: Name of the carrier. +* **trackingId**: string: Tracking Id of shipment. ## PackageCarrierInfo ### Properties * **carrierName**: string: Name of the carrier. * **trackingId**: string: Tracking Id of shipment. -## DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ExportDiskDetails](#exportdiskdetails) - -## ExportDiskDetails -### Properties -* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. -* **manifestFile**: string (ReadOnly): The relative path of the manifest file on the disk. -* **manifestHash**: string (ReadOnly): The Base16-encoded MD5 hash of the manifest file on the disk. - -## DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ImportDiskDetails](#importdiskdetails) - -## ImportDiskDetails +## PackageShippingDetails ### Properties -* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. -* **bitLockerKey**: string (Required): BitLocker key used to encrypt the disk. -* **manifestFile**: string (Required): The relative path of the manifest file on the disk. -* **manifestHash**: string (Required): The Base16-encoded MD5 hash of the manifest file on the disk. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. -## PackageCarrierDetails +## Preferences ### Properties -* **carrierAccountNumber**: string: Carrier Account Number of customer for customer disk. -* **carrierName**: string: Name of the carrier. -* **trackingId**: string: Tracking Id of shipment. +* **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. +* **preferredDataCenterRegion**: string[]: Preferred data center region. +* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## DataBoxDiskCopyProgress +## ResourceIdentity ### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities -## DataBoxDiskJobDetailsDisksAndSizeDetails +## ResourceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: int +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## DataBoxDiskJobDetailsPreferredDisks +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: int +* **Additional Properties Type**: string -## CloudError +## ShareCredentialDetails ### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Cloud error additional info. -* **code**: string: Cloud error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Cloud error details. -* **message**: string: Cloud error message. -* **target**: string: Cloud error target. +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. -## AdditionalErrorInfo +## ShippingAddress ### Properties -* **info**: any: Any object -* **type**: string: Additional error type. +* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string: Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. ## Sku ### Properties @@ -439,94 +480,53 @@ Until this is true, the TotalBytesToProcess may not be valid. * **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource * **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity -## ResourceTags +## TransferAllDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## UnencryptedCredentialsList +## TransferConfiguration ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## UnencryptedCredentials +## TransferConfigurationTransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Cloud error. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### CustomerDiskJobSecrets -#### Properties -* **carrierAccountNumber**: string (ReadOnly): Carrier Account Number of the customer -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **jobSecretsType**: 'DataBoxCustomerDisk' (Required): Used to indicate what type of job secrets object. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## DcAccessSecurityCode +## TransferConfigurationTransferFilterDetails ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## DataBoxSecret +## TransferFilterDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## AccountCredentialDetails +## TransportPreferences ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## ShareCredentialDetails +## UnencryptedCredentials ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## ApplianceNetworkConfiguration +## UnencryptedCredentialsList ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. -## DiskSecret +## UserAssignedIdentity ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## DataBoxHeavySecret +## UserAssignedProperties ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. diff --git a/generated/databox/microsoft.databox/2021-12-01/types.md b/generated/databox/microsoft.databox/2021-12-01/types.md index b0c39d9e13..75eed1e36a 100644 --- a/generated/databox/microsoft.databox/2021-12-01/types.md +++ b/generated/databox/microsoft.databox/2021-12-01/types.md @@ -19,95 +19,42 @@ * **ApiVersion**: 2021-12-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## ResourceIdentityUserAssignedIdentities +## AdditionalErrorInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **info**: any: Any object +* **type**: string: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). -## UserAssignedIdentity +## ApplianceNetworkConfiguration ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -## JobProperties +## AzureFileFilterDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'AwaitingShipmentDetails' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'Created' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'PreparingToShipFromAzureDC' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' | 'ShippedToAzureDC' | 'ShippedToCustomer' | string (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -## JobDeliveryInfo +## BlobFilterDetails ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **actions**: 'MoveToCleanUpDevice' | 'None' | 'ReachOutToOperation' | 'Restart' | 'Resume'[] (ReadOnly): Available actions on the job. -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **datacenterAddress**: [DatacenterAddressResponse](#datacenteraddressresponse) (ReadOnly): Datacenter address for given storage location. -* **dataCenterCode**: 'AM2' | 'AMS06' | 'AMS20' | 'AUH20' | 'AdHoc' | 'BJB' | 'BJS20' | 'BL20' | 'BL7' | 'BN1' | 'BN7' | 'BOM01' | 'BY1' | 'BY2' | 'BY21' | 'BY24' | 'CBR20' | 'CH1' | 'CPQ02' | 'CPQ20' | 'CWL20' | 'CYS04' | 'DSM05' | 'DUB07' | 'FRA22' | 'HKG20' | 'Invalid' | 'JNB21' | 'JNB22' | 'LON24' | 'MAA01' | 'MEL23' | 'MNZ21' | 'MWH01' | 'ORK70' | 'OSA02' | 'OSA20' | 'OSA22' | 'PAR22' | 'PNQ01' | 'PUS20' | 'SEL20' | 'SEL21' | 'SG2' | 'SHA03' | 'SIN20' | 'SN5' | 'SN6' | 'SN8' | 'SSE90' | 'SVG20' | 'SYD03' | 'SYD23' | 'TYO01' | 'TYO22' | 'YQB20' | 'YTO20' | 'YTO21' | 'ZRH20' | string (ReadOnly): DataCenter code. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. -* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxCustomerDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxCustomerDiskCopyProgress](#databoxcustomerdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **deliverToDcPackageDetails**: [PackageCarrierInfo](#packagecarrierinfo) (ReadOnly): package carrier info -* **enableManifestBackup**: bool: Flag to indicate if disk manifest should be backed-up in the Storage Account. -* **exportDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection](#databoxcustomerdiskjobdetailsexportdiskdetailscollection) (ReadOnly): Contains the map of disk serial number to the disk details for export jobs. -* **importDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection](#databoxcustomerdiskjobdetailsimportdiskdetailscollection): Contains the map of disk serial number to the disk details for import jobs. -* **jobDetailsType**: 'DataBoxCustomerDisk' (Required): Indicates the type of job details. -* **returnToCustomerPackageDetails**: [PackageCarrierDetails](#packagecarrierdetails) (Required): Package carrier details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **granularCopyProgress**: [DataBoxDiskGranularCopyProgress](#databoxdiskgranularcopyprogress)[] (ReadOnly): Copy progress per disk. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Gets or sets additional error info. +* **code**: string: Error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Gets or sets details for the error. +* **message**: string: The error message parsed from the body of the http error response. +* **target**: string: Gets or sets the target of the error. ## ContactDetails ### Properties @@ -118,11 +65,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'Created' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' | 'ShippedToCustomer' | string (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -156,6 +98,127 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. +## CopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataAccountDetails +* **Discriminator**: dataAccountType + +### Base Properties +* **sharePassword**: string (WriteOnly): Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +### ManagedDiskDetails +#### Properties +* **dataAccountType**: 'ManagedDisk' (Required): Account Type of the data to be transferred. +* **resourceGroupId**: string (Required): Resource Group Id of the compute disks. +* **stagingStorageAccountId**: string (Required): Resource Id of the storage account that can be used to copy the vhd for staging. + +### StorageAccountDetails +#### Properties +* **dataAccountType**: 'StorageAccount' (Required): Account Type of the data to be transferred. +* **storageAccountId**: string (Required): Storage Account Resource Id. + + +## DataBoxCustomerDiskCopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **serialNumber**: string (ReadOnly): Disk Serial Number. +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ExportDiskDetails](#exportdiskdetails) + +## DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ImportDiskDetails](#importdiskdetails) + +## DataBoxDiskCopyProgress +### Properties +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy + +## DataBoxDiskGranularCopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **serialNumber**: string (ReadOnly): Disk Serial Number. +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataBoxDiskJobDetailsDisksAndSizeDetails +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## DataBoxDiskJobDetailsPreferredDisks +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## DataBoxHeavySecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DataBoxSecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + ## DatacenterAddressResponse * **Discriminator**: datacenterAddressType @@ -191,77 +254,150 @@ * **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. * **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## DataAccountDetails -* **Discriminator**: dataAccountType - -### Base Properties -* **sharePassword**: string (WriteOnly): Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -### ManagedDiskDetails -#### Properties -* **dataAccountType**: 'ManagedDisk' (Required): Account Type of the data to be transferred. -* **resourceGroupId**: string (Required): Resource Group Id of the compute disks. -* **stagingStorageAccountId**: string (Required): Resource Id of the storage account that can be used to copy the vhd for staging. - -### StorageAccountDetails -#### Properties -* **dataAccountType**: 'StorageAccount' (Required): Account Type of the data to be transferred. -* **storageAccountId**: string (Required): Storage Account Resource Id. +## DataImportDetails +### Properties +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +## DcAccessSecurityCode +### Properties +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. -## TransferConfiguration +## DiskSecret ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. -## TransferConfigurationTransferAllDetails +## EncryptionPreferences ### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. +* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. -## TransferAllDetails +## ExportDiskDetails ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. +* **manifestFile**: string (ReadOnly): The relative path of the manifest file on the disk. +* **manifestHash**: string (ReadOnly): The Base16-encoded MD5 hash of the manifest file on the disk. -## TransferConfigurationTransferFilterDetails +## FilterFileDetails ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. +* **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## TransferFilterDetails +## IdentityProperties ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **type**: string: Managed service identity type. +* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. -## AzureFileFilterDetails +## ImportDiskDetails ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. +* **bitLockerKey**: string (Required): BitLocker key used to encrypt the disk. +* **manifestFile**: string (Required): The relative path of the manifest file on the disk. +* **manifestHash**: string (Required): The Base16-encoded MD5 hash of the manifest file on the disk. -## BlobFilterDetails +## JobDeliveryInfo ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **scheduledDateTime**: string: Scheduled date time. -## FilterFileDetails -### Properties -* **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. -* **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. +## JobDetails +* **Discriminator**: jobDetailsType -## DataImportDetails -### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +### Base Properties +* **actions**: 'MoveToCleanUpDevice' | 'None' | 'ReachOutToOperation' | 'Restart' | 'Resume'[] (ReadOnly): Available actions on the job. +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **datacenterAddress**: [DatacenterAddressResponse](#datacenteraddressresponse) (ReadOnly): Datacenter address for given storage location. +* **dataCenterCode**: 'AM2' | 'AMS06' | 'AMS20' | 'AUH20' | 'AdHoc' | 'BJB' | 'BJS20' | 'BL20' | 'BL7' | 'BN1' | 'BN7' | 'BOM01' | 'BY1' | 'BY2' | 'BY21' | 'BY24' | 'CBR20' | 'CH1' | 'CPQ02' | 'CPQ20' | 'CWL20' | 'CYS04' | 'DSM05' | 'DUB07' | 'FRA22' | 'HKG20' | 'Invalid' | 'JNB21' | 'JNB22' | 'LON24' | 'MAA01' | 'MEL23' | 'MNZ21' | 'MWH01' | 'ORK70' | 'OSA02' | 'OSA20' | 'OSA22' | 'PAR22' | 'PNQ01' | 'PUS20' | 'SEL20' | 'SEL21' | 'SG2' | 'SHA03' | 'SIN20' | 'SN5' | 'SN6' | 'SN8' | 'SSE90' | 'SVG20' | 'SYD03' | 'SYD23' | 'TYO01' | 'TYO22' | 'YQB20' | 'YTO20' | 'YTO21' | 'ZRH20' | string (ReadOnly): DataCenter code. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. +* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. -## PackageShippingDetails +### DataBoxCustomerDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxCustomerDiskCopyProgress](#databoxcustomerdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **deliverToDcPackageDetails**: [PackageCarrierInfo](#packagecarrierinfo) (ReadOnly): package carrier info +* **enableManifestBackup**: bool: Flag to indicate if disk manifest should be backed-up in the Storage Account. +* **exportDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection](#databoxcustomerdiskjobdetailsexportdiskdetailscollection) (ReadOnly): Contains the map of disk serial number to the disk details for export jobs. +* **importDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection](#databoxcustomerdiskjobdetailsimportdiskdetailscollection): Contains the map of disk serial number to the disk details for import jobs. +* **jobDetailsType**: 'DataBoxCustomerDisk' (Required): Indicates the type of job details. +* **returnToCustomerPackageDetails**: [PackageCarrierDetails](#packagecarrierdetails) (Required): Package carrier details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **granularCopyProgress**: [DataBoxDiskGranularCopyProgress](#databoxdiskgranularcopyprogress)[] (ReadOnly): Copy progress per disk. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'AwaitingShipmentDetails' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'Created' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'PreparingToShipFromAzureDC' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' | 'ShippedToAzureDC' | 'ShippedToCustomer' | string (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### CustomerDiskJobSecrets +#### Properties +* **carrierAccountNumber**: string (ReadOnly): Carrier Account Number of the customer +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **jobSecretsType**: 'DataBoxCustomerDisk' (Required): Used to indicate what type of job secrets object. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -278,15 +414,6 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. -## IdentityProperties -### Properties -* **type**: string: Managed service identity type. -* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. - -## UserAssignedProperties -### Properties -* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. - ## LastMitigationActionOnJob ### Properties * **actionDateTimeInUtc**: string: Action performed date time @@ -294,158 +421,72 @@ * **isPerformedByCustomer**: bool: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops -## Preferences -### Properties -* **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. -* **preferredDataCenterRegion**: string[]: Preferred data center region. -* **storageAccountAccessTierPreferences**: 'Archive'[]: Preferences related to the Access Tier of storage accounts. -* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku - -## EncryptionPreferences -### Properties -* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. - -## TransportPreferences -### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. - -## ShippingAddress -### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string: Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. - -## CopyProgress +## NotificationPreference ### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'Created' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' | 'ShippedToCustomer' | string (Required): Name of the stage. -## DataBoxCustomerDiskCopyProgress +## PackageCarrierDetails ### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **serialNumber**: string (ReadOnly): Disk Serial Number. -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **carrierAccountNumber**: string: Carrier Account Number of customer for customer disk. +* **carrierName**: string: Name of the carrier. +* **trackingId**: string: Tracking Id of shipment. ## PackageCarrierInfo ### Properties * **carrierName**: string: Name of the carrier. * **trackingId**: string: Tracking Id of shipment. -## DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ExportDiskDetails](#exportdiskdetails) - -## ExportDiskDetails -### Properties -* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. -* **manifestFile**: string (ReadOnly): The relative path of the manifest file on the disk. -* **manifestHash**: string (ReadOnly): The Base16-encoded MD5 hash of the manifest file on the disk. - -## DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ImportDiskDetails](#importdiskdetails) - -## ImportDiskDetails +## PackageShippingDetails ### Properties -* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. -* **bitLockerKey**: string (Required): BitLocker key used to encrypt the disk. -* **manifestFile**: string (Required): The relative path of the manifest file on the disk. -* **manifestHash**: string (Required): The Base16-encoded MD5 hash of the manifest file on the disk. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. -## PackageCarrierDetails +## Preferences ### Properties -* **carrierAccountNumber**: string: Carrier Account Number of customer for customer disk. -* **carrierName**: string: Name of the carrier. -* **trackingId**: string: Tracking Id of shipment. +* **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. +* **preferredDataCenterRegion**: string[]: Preferred data center region. +* **storageAccountAccessTierPreferences**: 'Archive'[]: Preferences related to the Access Tier of storage accounts. +* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## DataBoxDiskCopyProgress +## ResourceIdentity ### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities -## DataBoxDiskJobDetailsDisksAndSizeDetails +## ResourceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: int - -## DataBoxDiskGranularCopyProgress -### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **serialNumber**: string (ReadOnly): Disk Serial Number. -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## DataBoxDiskJobDetailsPreferredDisks +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: int +* **Additional Properties Type**: string -## CloudError +## ShareCredentialDetails ### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Gets or sets additional error info. -* **code**: string: Error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Gets or sets details for the error. -* **message**: string: The error message parsed from the body of the http error response. -* **target**: string: Gets or sets the target of the error. +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. -## AdditionalErrorInfo +## ShippingAddress ### Properties -* **info**: any: Any object -* **type**: string: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). +* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string: Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. ## Sku ### Properties @@ -462,94 +503,53 @@ Until this is true, the TotalBytesToProcess may not be valid. * **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource * **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity -## ResourceTags +## TransferAllDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## UnencryptedCredentialsList +## TransferConfiguration ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## UnencryptedCredentials +## TransferConfigurationTransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### CustomerDiskJobSecrets -#### Properties -* **carrierAccountNumber**: string (ReadOnly): Carrier Account Number of the customer -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **jobSecretsType**: 'DataBoxCustomerDisk' (Required): Used to indicate what type of job secrets object. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## DcAccessSecurityCode +## TransferConfigurationTransferFilterDetails ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## DataBoxSecret +## TransferFilterDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## AccountCredentialDetails +## TransportPreferences ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## ShareCredentialDetails +## UnencryptedCredentials ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## ApplianceNetworkConfiguration +## UnencryptedCredentialsList ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. -## DiskSecret +## UserAssignedIdentity ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## DataBoxHeavySecret +## UserAssignedProperties ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. diff --git a/generated/databox/microsoft.databox/2022-02-01/types.md b/generated/databox/microsoft.databox/2022-02-01/types.md index c86a570c2d..a07e093aa3 100644 --- a/generated/databox/microsoft.databox/2022-02-01/types.md +++ b/generated/databox/microsoft.databox/2022-02-01/types.md @@ -19,96 +19,42 @@ * **ApiVersion**: 2022-02-01 * **Output**: [UnencryptedCredentialsList](#unencryptedcredentialslist) -## ResourceIdentity +## AccountCredentialDetails ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: string: Identity type -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities +* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. +* **accountName**: string (ReadOnly): Name of the account. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. -## ResourceIdentityUserAssignedIdentities +## AdditionalErrorInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **info**: any: Any object +* **type**: string: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). -## UserAssignedIdentity +## ApplianceNetworkConfiguration ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **macAddress**: string (ReadOnly): Mac Address. +* **name**: string (ReadOnly): Name of the network. -## JobProperties +## AzureFileFilterDetails ### Properties -* **cancellationReason**: string (ReadOnly): Reason for cancellation. -* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. -* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. -* **details**: [JobDetails](#jobdetails): Job details. -* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. -* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. -* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. -* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. -* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job -* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. -* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. -* **status**: 'Aborted' | 'AtAzureDC' | 'AwaitingShipmentDetails' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'Created' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'PreparingToShipFromAzureDC' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' | 'ShippedToAzureDC' | 'ShippedToCustomer' | string (ReadOnly): Name of the stage which is in progress. -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. +* **filePathList**: string[]: List of full path of the files to be transferred. +* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. +* **fileShareList**: string[]: List of file shares to be transferred. -## JobDeliveryInfo +## BlobFilterDetails ### Properties -* **scheduledDateTime**: string: Scheduled date time. - -## JobDetails -* **Discriminator**: jobDetailsType - -### Base Properties -* **actions**: 'MoveToCleanUpDevice' | 'None' | 'ReachOutToOperation' | 'Restart' | 'Resume'[] (ReadOnly): Available actions on the job. -* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs -* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. -* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. -* **datacenterAddress**: [DatacenterAddressResponse](#datacenteraddressresponse) (ReadOnly): Datacenter address for given storage location. -* **dataCenterCode**: 'AM2' | 'AMS06' | 'AMS20' | 'AUH20' | 'AdHoc' | 'BJB' | 'BJS20' | 'BL20' | 'BL7' | 'BN1' | 'BN7' | 'BOM01' | 'BY1' | 'BY2' | 'BY21' | 'BY24' | 'CBR20' | 'CH1' | 'CPQ02' | 'CPQ20' | 'CWL20' | 'CYS04' | 'DSM05' | 'DUB07' | 'FRA22' | 'HKG20' | 'Invalid' | 'JNB21' | 'JNB22' | 'LON24' | 'MAA01' | 'MEL23' | 'MNZ21' | 'MWH01' | 'ORK70' | 'OSA02' | 'OSA20' | 'OSA22' | 'PAR22' | 'PNQ01' | 'PUS20' | 'SEL20' | 'SEL21' | 'SG2' | 'SHA03' | 'SIN20' | 'SN5' | 'SN6' | 'SN8' | 'SSE90' | 'SVG20' | 'SYD03' | 'SYD23' | 'TYO01' | 'TYO22' | 'YQB20' | 'YTO20' | 'YTO21' | 'ZRH20' | string (ReadOnly): DataCenter code. -* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. -* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. -* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details -* **deviceErasureDetails**: [DeviceErasureDetails](#deviceerasuredetails) (ReadOnly): Device erasure details with erasure completion status and erasureordestructionlog sas key -* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. -* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. -* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. -* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job -* **preferences**: [Preferences](#preferences): Preferences related to the order -* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details -* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label -* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. -### DataBoxJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. -* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. - -### DataBoxCustomerDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxCustomerDiskCopyProgress](#databoxcustomerdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **deliverToDcPackageDetails**: [PackageCarrierInfo](#packagecarrierinfo) (ReadOnly): package carrier info -* **enableManifestBackup**: bool: Flag to indicate if disk manifest should be backed-up in the Storage Account. -* **exportDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection](#databoxcustomerdiskjobdetailsexportdiskdetailscollection) (ReadOnly): Contains the map of disk serial number to the disk details for export jobs. -* **importDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection](#databoxcustomerdiskjobdetailsimportdiskdetailscollection): Contains the map of disk serial number to the disk details for import jobs. -* **jobDetailsType**: 'DataBoxCustomerDisk' (Required): Indicates the type of job details. -* **returnToCustomerPackageDetails**: [PackageCarrierDetails](#packagecarrierdetails) (Required): Package carrier details. - -### DataBoxDiskJobDetails -#### Properties -* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. -* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. -* **granularCopyProgress**: [DataBoxDiskGranularCopyProgress](#databoxdiskgranularcopyprogress)[] (ReadOnly): Copy progress per disk. -* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. -* **passkey**: string: User entered passkey for DataBox Disk job. -* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. - -### DataBoxHeavyJobDetails -#### Properties -* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. -* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. +* **blobPathList**: string[]: List of full path of the blobs to be transferred. +* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. +* **containerList**: string[]: List of blob containers to be transferred. +## CloudError +### Properties +* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Gets or sets additional error info. +* **code**: string: Error code. +* **details**: [CloudError](#clouderror)[] (ReadOnly): Gets or sets details for the error. +* **message**: string: The error message parsed from the body of the http error response. +* **target**: string: Gets or sets the target of the error. ## ContactDetails ### Properties @@ -119,11 +65,6 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'AtAzureDC' | 'Created' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' | 'ShippedToCustomer' | string (Required): Name of the stage. - ## CopyLogDetails * **Discriminator**: copyLogDetailsType @@ -157,6 +98,127 @@ * **copyVerboseLogLink**: string[] (ReadOnly): Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. +## CopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataAccountDetails +* **Discriminator**: dataAccountType + +### Base Properties +* **sharePassword**: string (WriteOnly): Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +### ManagedDiskDetails +#### Properties +* **dataAccountType**: 'ManagedDisk' (Required): Account Type of the data to be transferred. +* **resourceGroupId**: string (Required): Resource Group Id of the compute disks. +* **stagingStorageAccountId**: string (Required): Resource Id of the storage account that can be used to copy the vhd for staging. + +### StorageAccountDetails +#### Properties +* **dataAccountType**: 'StorageAccount' (Required): Account Type of the data to be transferred. +* **storageAccountId**: string (Required): Storage Account Resource Id. + + +## DataBoxCustomerDiskCopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **serialNumber**: string (ReadOnly): Disk Serial Number. +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ExportDiskDetails](#exportdiskdetails) + +## DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection +### Properties +### Additional Properties +* **Additional Properties Type**: [ImportDiskDetails](#importdiskdetails) + +## DataBoxDiskCopyProgress +### Properties +* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. +* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. +* **serialNumber**: string (ReadOnly): The serial number of the disk +* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy + +## DataBoxDiskGranularCopyProgress +### Properties +* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. +* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. +* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. +* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. +* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied +* **filesProcessed**: int (ReadOnly): Number of files processed +* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed +* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming +* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming +* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. +Until this is true, the TotalBytesToProcess may not be valid. +* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming +* **serialNumber**: string (ReadOnly): Disk Serial Number. +* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. +* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. +* **totalFilesToProcess**: int (ReadOnly): Total files to process +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. + +## DataBoxDiskJobDetailsDisksAndSizeDetails +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## DataBoxDiskJobDetailsPreferredDisks +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## DataBoxHeavySecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + +## DataBoxSecret +### Properties +* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. +* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. +* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. +* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device +* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. + ## DatacenterAddressResponse * **Discriminator**: datacenterAddressType @@ -192,82 +254,156 @@ * **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. * **transferConfiguration**: [TransferConfiguration](#transferconfiguration) (Required): Configuration for defining the transfer of data. -## DataAccountDetails -* **Discriminator**: dataAccountType - -### Base Properties -* **sharePassword**: string (WriteOnly): Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ -### ManagedDiskDetails -#### Properties -* **dataAccountType**: 'ManagedDisk' (Required): Account Type of the data to be transferred. -* **resourceGroupId**: string (Required): Resource Group Id of the compute disks. -* **stagingStorageAccountId**: string (Required): Resource Id of the storage account that can be used to copy the vhd for staging. - -### StorageAccountDetails -#### Properties -* **dataAccountType**: 'StorageAccount' (Required): Account Type of the data to be transferred. -* **storageAccountId**: string (Required): Storage Account Resource Id. - - -## TransferConfiguration +## DataImportDetails ### Properties -* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll -* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. -* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. +* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred +* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. -## TransferConfigurationTransferAllDetails -### Properties -* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. - -## TransferAllDetails +## DcAccessSecurityCode ### Properties -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred -* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred +* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. +* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. -## TransferConfigurationTransferFilterDetails +## DeviceErasureDetails ### Properties -* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. +* **deviceErasureStatus**: 'Cancelled' | 'Cancelling' | 'CustomerActionPerformed' | 'CustomerActionPerformedForCleanUp' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | 'SucceededWithErrors' | 'SucceededWithWarnings' | 'WaitingForCustomerAction' | 'WaitingForCustomerActionForCleanUp' | 'WaitingForCustomerActionForKek' (ReadOnly): Holds the device erasure completion status +* **erasureOrDestructionCertificateSasKey**: string (ReadOnly): Shared access key to download cleanup or destruction certificate for device -## TransferFilterDetails +## DiskSecret ### Properties -* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files -* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. -* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. +* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. +* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. -## AzureFileFilterDetails +## EncryptionPreferences ### Properties -* **filePathList**: string[]: List of full path of the files to be transferred. -* **filePrefixList**: string[]: Prefix list of the Azure files to be transferred. -* **fileShareList**: string[]: List of file shares to be transferred. +* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. -## BlobFilterDetails +## ExportDiskDetails ### Properties -* **blobPathList**: string[]: List of full path of the blobs to be transferred. -* **blobPrefixList**: string[]: Prefix list of the Azure blobs to be transferred. -* **containerList**: string[]: List of blob containers to be transferred. +* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. +* **manifestFile**: string (ReadOnly): The relative path of the manifest file on the disk. +* **manifestHash**: string (ReadOnly): The Base16-encoded MD5 hash of the manifest file on the disk. ## FilterFileDetails ### Properties * **filterFilePath**: string (Required): Path of the file that contains the details of all items to transfer. * **filterFileType**: 'AzureBlob' | 'AzureFile' (Required): Type of the filter file. -## DataImportDetails +## IdentityProperties ### Properties -* **accountDetails**: [DataAccountDetails](#dataaccountdetails) (Required): Account details of the data to be transferred -* **logCollectionLevel**: 'Error' | 'Verbose': Level of the logs to be collected. +* **type**: string: Managed service identity type. +* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. -## PackageShippingDetails +## ImportDiskDetails ### Properties -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): Tracking Id of shipment. -* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. +* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. +* **bitLockerKey**: string (Required): BitLocker key used to encrypt the disk. +* **manifestFile**: string (Required): The relative path of the manifest file on the disk. +* **manifestHash**: string (Required): The Base16-encoded MD5 hash of the manifest file on the disk. -## DeviceErasureDetails +## JobDeliveryInfo ### Properties -* **deviceErasureStatus**: 'Cancelled' | 'Cancelling' | 'CustomerActionPerformed' | 'CustomerActionPerformedForCleanUp' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | 'SucceededWithErrors' | 'SucceededWithWarnings' | 'WaitingForCustomerAction' | 'WaitingForCustomerActionForCleanUp' | 'WaitingForCustomerActionForKek' (ReadOnly): Holds the device erasure completion status -* **erasureOrDestructionCertificateSasKey**: string (ReadOnly): Shared access key to download cleanup or destruction certificate for device +* **scheduledDateTime**: string: Scheduled date time. + +## JobDetails +* **Discriminator**: jobDetailsType + +### Base Properties +* **actions**: 'MoveToCleanUpDevice' | 'None' | 'ReachOutToOperation' | 'Restart' | 'Resume'[] (ReadOnly): Available actions on the job. +* **chainOfCustodySasKey**: string (ReadOnly): Shared access key to download the chain of custody logs +* **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. +* **copyLogDetails**: [CopyLogDetails](#copylogdetails)[] (ReadOnly): List of copy log details. +* **datacenterAddress**: [DatacenterAddressResponse](#datacenteraddressresponse) (ReadOnly): Datacenter address for given storage location. +* **dataCenterCode**: 'AM2' | 'AMS06' | 'AMS20' | 'AUH20' | 'AdHoc' | 'BJB' | 'BJS20' | 'BL20' | 'BL7' | 'BN1' | 'BN7' | 'BOM01' | 'BY1' | 'BY2' | 'BY21' | 'BY24' | 'CBR20' | 'CH1' | 'CPQ02' | 'CPQ20' | 'CWL20' | 'CYS04' | 'DSM05' | 'DUB07' | 'FRA22' | 'HKG20' | 'Invalid' | 'JNB21' | 'JNB22' | 'LON24' | 'MAA01' | 'MEL23' | 'MNZ21' | 'MWH01' | 'ORK70' | 'OSA02' | 'OSA20' | 'OSA22' | 'PAR22' | 'PNQ01' | 'PUS20' | 'SEL20' | 'SEL21' | 'SG2' | 'SHA03' | 'SIN20' | 'SN5' | 'SN6' | 'SN8' | 'SSE90' | 'SVG20' | 'SYD03' | 'SYD23' | 'TYO01' | 'TYO22' | 'YQB20' | 'YTO20' | 'YTO21' | 'ZRH20' | string (ReadOnly): DataCenter code. +* **dataExportDetails**: [DataExportDetails](#dataexportdetails)[]: Details of the data to be exported from azure. +* **dataImportDetails**: [DataImportDetails](#dataimportdetails)[]: Details of the data to be imported into azure. +* **deliveryPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details +* **deviceErasureDetails**: [DeviceErasureDetails](#deviceerasuredetails) (ReadOnly): Device erasure details with erasure completion status and erasureordestructionlog sas key +* **expectedDataSizeInTeraBytes**: int: The expected size of the data, which needs to be transferred in this job, in terabytes. +* **jobStages**: [JobStages](#jobstages)[] (ReadOnly): List of stages that run in the job. +* **keyEncryptionKey**: [KeyEncryptionKey](#keyencryptionkey): Encryption key containing details about key to encrypt different keys. +* **lastMitigationActionOnJob**: [LastMitigationActionOnJob](#lastmitigationactiononjob) (ReadOnly): Last Mitigation Action Performed On Job +* **preferences**: [Preferences](#preferences): Preferences related to the order +* **returnPackage**: [PackageShippingDetails](#packageshippingdetails) (ReadOnly): package shipping details +* **reverseShipmentLabelSasKey**: string (ReadOnly): Shared access key to download the return shipment label +* **shippingAddress**: [ShippingAddress](#shippingaddress): Shipping address where customer wishes to receive the device. +### DataBoxJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per storage account. +* **devicePassword**: string: Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBox' (Required): Indicates the type of job details. + +### DataBoxCustomerDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxCustomerDiskCopyProgress](#databoxcustomerdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **deliverToDcPackageDetails**: [PackageCarrierInfo](#packagecarrierinfo) (ReadOnly): package carrier info +* **enableManifestBackup**: bool: Flag to indicate if disk manifest should be backed-up in the Storage Account. +* **exportDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection](#databoxcustomerdiskjobdetailsexportdiskdetailscollection) (ReadOnly): Contains the map of disk serial number to the disk details for export jobs. +* **importDiskDetailsCollection**: [DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection](#databoxcustomerdiskjobdetailsimportdiskdetailscollection): Contains the map of disk serial number to the disk details for import jobs. +* **jobDetailsType**: 'DataBoxCustomerDisk' (Required): Indicates the type of job details. +* **returnToCustomerPackageDetails**: [PackageCarrierDetails](#packagecarrierdetails) (Required): Package carrier details. + +### DataBoxDiskJobDetails +#### Properties +* **copyProgress**: [DataBoxDiskCopyProgress](#databoxdiskcopyprogress)[] (ReadOnly): Copy progress per disk. +* **disksAndSizeDetails**: [DataBoxDiskJobDetailsDisksAndSizeDetails](#databoxdiskjobdetailsdisksandsizedetails) (ReadOnly): Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. +* **granularCopyProgress**: [DataBoxDiskGranularCopyProgress](#databoxdiskgranularcopyprogress)[] (ReadOnly): Copy progress per disk. +* **jobDetailsType**: 'DataBoxDisk' (Required): Indicates the type of job details. +* **passkey**: string: User entered passkey for DataBox Disk job. +* **preferredDisks**: [DataBoxDiskJobDetailsPreferredDisks](#databoxdiskjobdetailspreferreddisks): User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. + +### DataBoxHeavyJobDetails +#### Properties +* **copyProgress**: [CopyProgress](#copyprogress)[] (ReadOnly): Copy progress per account. +* **devicePassword**: string: Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ +* **jobDetailsType**: 'DataBoxHeavy' (Required): Indicates the type of job details. + + +## JobProperties +### Properties +* **cancellationReason**: string (ReadOnly): Reason for cancellation. +* **deliveryInfo**: [JobDeliveryInfo](#jobdeliveryinfo): Additional delivery info. +* **deliveryType**: 'NonScheduled' | 'Scheduled': Delivery type of Job. +* **details**: [JobDetails](#jobdetails): Job details. +* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. +* **isCancellable**: bool (ReadOnly): Describes whether the job is cancellable or not. +* **isCancellableWithoutFee**: bool (ReadOnly): Flag to indicate cancellation of scheduled job. +* **isDeletable**: bool (ReadOnly): Describes whether the job is deletable or not. +* **isPrepareToShipEnabled**: bool (ReadOnly): Is Prepare To Ship Enabled on this job +* **isShippingAddressEditable**: bool (ReadOnly): Describes whether the shipping address is editable or not. +* **startTime**: string (ReadOnly): Time at which the job was started in UTC ISO 8601 format. +* **status**: 'Aborted' | 'AtAzureDC' | 'AwaitingShipmentDetails' | 'Cancelled' | 'Completed' | 'CompletedWithErrors' | 'CompletedWithWarnings' | 'Created' | 'DataCopy' | 'Delivered' | 'DeviceOrdered' | 'DevicePrepared' | 'Dispatched' | 'Failed_IssueDetectedAtAzureDC' | 'Failed_IssueReportedAtCustomer' | 'PickedUp' | 'PreparingToShipFromAzureDC' | 'ReadyToDispatchFromAzureDC' | 'ReadyToReceiveAtAzureDC' | 'ShippedToAzureDC' | 'ShippedToCustomer' | string (ReadOnly): Name of the stage which is in progress. +* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (Required): Type of the transfer. + +## JobSecrets +* **Discriminator**: jobSecretsType + +### Base Properties +* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code +* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. +### DataboxJobSecrets +#### Properties +* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. +* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. + +### CustomerDiskJobSecrets +#### Properties +* **carrierAccountNumber**: string (ReadOnly): Carrier Account Number of the customer +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **jobSecretsType**: 'DataBoxCustomerDisk' (Required): Used to indicate what type of job secrets object. + +### DataBoxDiskJobSecrets +#### Properties +* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. +* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. +* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. +* **passKey**: string (ReadOnly): PassKey for the disk Job. + +### DataBoxHeavyJobSecrets +#### Properties +* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. +* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. + ## JobStages ### Properties @@ -284,15 +420,6 @@ * **kekUrl**: string: Key encryption key. It is required in case of Customer managed KekType. * **kekVaultResourceID**: string: Kek vault resource id. It is required in case of Customer managed KekType. -## IdentityProperties -### Properties -* **type**: string: Managed service identity type. -* **userAssigned**: [UserAssignedProperties](#userassignedproperties): User assigned identity properties. - -## UserAssignedProperties -### Properties -* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. - ## LastMitigationActionOnJob ### Properties * **actionDateTimeInUtc**: string: Action performed date time @@ -300,158 +427,72 @@ * **isPerformedByCustomer**: bool: Action performed by customer, possibility is that mitigation might happen by customer or service or by ops -## Preferences -### Properties -* **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. -* **preferredDataCenterRegion**: string[]: Preferred data center region. -* **storageAccountAccessTierPreferences**: 'Archive'[]: Preferences related to the Access Tier of storage accounts. -* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku - -## EncryptionPreferences -### Properties -* **doubleEncryption**: 'Disabled' | 'Enabled': Defines secondary layer of software-based encryption enablement. - -## TransportPreferences -### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. - -## ShippingAddress -### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string: Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. - -## CopyProgress +## NotificationPreference ### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'AtAzureDC' | 'Created' | 'DataCopy' | 'Delivered' | 'DevicePrepared' | 'Dispatched' | 'PickedUp' | 'ShippedToCustomer' | string (Required): Name of the stage. -## DataBoxCustomerDiskCopyProgress +## PackageCarrierDetails ### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **serialNumber**: string (ReadOnly): Disk Serial Number. -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **carrierAccountNumber**: string: Carrier Account Number of customer for customer disk. +* **carrierName**: string: Name of the carrier. +* **trackingId**: string: Tracking Id of shipment. ## PackageCarrierInfo ### Properties * **carrierName**: string: Name of the carrier. * **trackingId**: string: Tracking Id of shipment. -## DataBoxCustomerDiskJobDetailsExportDiskDetailsCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ExportDiskDetails](#exportdiskdetails) - -## ExportDiskDetails -### Properties -* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. -* **manifestFile**: string (ReadOnly): The relative path of the manifest file on the disk. -* **manifestHash**: string (ReadOnly): The Base16-encoded MD5 hash of the manifest file on the disk. - -## DataBoxCustomerDiskJobDetailsImportDiskDetailsCollection -### Properties -### Additional Properties -* **Additional Properties Type**: [ImportDiskDetails](#importdiskdetails) - -## ImportDiskDetails +## PackageShippingDetails ### Properties -* **backupManifestCloudPath**: string (ReadOnly): Path to backed up manifest, only returned if enableManifestBackup is true. -* **bitLockerKey**: string (Required): BitLocker key used to encrypt the disk. -* **manifestFile**: string (Required): The relative path of the manifest file on the disk. -* **manifestHash**: string (Required): The Base16-encoded MD5 hash of the manifest file on the disk. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): Tracking Id of shipment. +* **trackingUrl**: string (ReadOnly): Url where shipment can be tracked. -## PackageCarrierDetails +## Preferences ### Properties -* **carrierAccountNumber**: string: Carrier Account Number of customer for customer disk. -* **carrierName**: string: Name of the carrier. -* **trackingId**: string: Tracking Id of shipment. +* **encryptionPreferences**: [EncryptionPreferences](#encryptionpreferences): Preferences related to the Encryption. +* **preferredDataCenterRegion**: string[]: Preferred data center region. +* **storageAccountAccessTierPreferences**: 'Archive'[]: Preferences related to the Access Tier of storage accounts. +* **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## DataBoxDiskCopyProgress +## ResourceIdentity ### Properties -* **bytesCopied**: int (ReadOnly): Bytes copied during the copy of disk. -* **percentComplete**: int (ReadOnly): Indicates the percentage completed for the copy of the disk. -* **serialNumber**: string (ReadOnly): The serial number of the disk -* **status**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: string: Identity type +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): User Assigned Identities -## DataBoxDiskJobDetailsDisksAndSizeDetails +## ResourceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: int - -## DataBoxDiskGranularCopyProgress -### Properties -* **accountId**: string (ReadOnly): Id of the account where the data needs to be uploaded. -* **bytesProcessed**: int (ReadOnly): To indicate bytes transferred. -* **copyStatus**: 'Completed' | 'CompletedWithErrors' | 'DeviceFormatted' | 'DeviceMetadataModified' | 'DriveCorrupted' | 'DriveNotDetected' | 'DriveNotReceived' | 'Failed' | 'HardwareError' | 'InProgress' | 'MetadataFilesModifiedOrRemoved' | 'NotReturned' | 'NotStarted' | 'OtherServiceError' | 'OtherUserError' | 'StorageAccountNotAccessible' | 'UnsupportedData' | 'UnsupportedDrive' | string (ReadOnly): The Status of the copy -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **directoriesErroredOut**: int (ReadOnly): To indicate directories errored out in the job. -* **filesErroredOut**: int (ReadOnly): Number of files which could not be copied -* **filesProcessed**: int (ReadOnly): Number of files processed -* **invalidDirectoriesProcessed**: int (ReadOnly): To indicate directories renamed -* **invalidFileBytesUploaded**: int (ReadOnly): Total amount of data not adhering to azure naming conventions which were processed by automatic renaming -* **invalidFilesProcessed**: int (ReadOnly): Number of files not adhering to azure naming conventions which were processed by automatic renaming -* **isEnumerationInProgress**: bool (ReadOnly): To indicate if enumeration of data is in progress. -Until this is true, the TotalBytesToProcess may not be valid. -* **renamedContainerCount**: int (ReadOnly): Number of folders not adhering to azure naming conventions which were processed by automatic renaming -* **serialNumber**: string (ReadOnly): Disk Serial Number. -* **storageAccountName**: string (ReadOnly): Name of the storage account. This will be empty for data account types other than storage account. -* **totalBytesToProcess**: int (ReadOnly): Total amount of data to be processed by the job. -* **totalFilesToProcess**: int (ReadOnly): Total files to process -* **transferType**: 'ExportFromAzure' | 'ImportToAzure' (ReadOnly): Type of the transfer. +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## DataBoxDiskJobDetailsPreferredDisks +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: int +* **Additional Properties Type**: string -## CloudError +## ShareCredentialDetails ### Properties -* **additionalInfo**: [AdditionalErrorInfo](#additionalerrorinfo)[] (ReadOnly): Gets or sets additional error info. -* **code**: string: Error code. -* **details**: [CloudError](#clouderror)[] (ReadOnly): Gets or sets details for the error. -* **message**: string: The error message parsed from the body of the http error response. -* **target**: string: Gets or sets the target of the error. +* **password**: string (ReadOnly): Password for the share. +* **shareName**: string (ReadOnly): Name of the share. +* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. +* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. +* **userName**: string (ReadOnly): User name for the share. -## AdditionalErrorInfo +## ShippingAddress ### Properties -* **info**: any: Any object -* **type**: string: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). +* **addressType**: 'Commercial' | 'None' | 'Residential': Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string: Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. ## Sku ### Properties @@ -468,94 +509,53 @@ Until this is true, the TotalBytesToProcess may not be valid. * **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource * **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity -## ResourceTags +## TransferAllDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **transferAllBlobs**: bool: To indicate if all Azure blobs have to be transferred +* **transferAllFiles**: bool: To indicate if all Azure Files have to be transferred -## UnencryptedCredentialsList +## TransferConfiguration ### Properties -* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. -* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. +* **transferAllDetails**: [TransferConfigurationTransferAllDetails](#transferconfigurationtransferalldetails): Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll +* **transferConfigurationType**: 'TransferAll' | 'TransferUsingFilter' (Required): Type of the configuration for transfer. +* **transferFilterDetails**: [TransferConfigurationTransferFilterDetails](#transferconfigurationtransferfilterdetails): Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. -## UnencryptedCredentials +## TransferConfigurationTransferAllDetails ### Properties -* **jobName**: string (ReadOnly): Name of the job. -* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets - -## JobSecrets -* **Discriminator**: jobSecretsType - -### Base Properties -* **dcAccessSecurityCode**: [DcAccessSecurityCode](#dcaccesssecuritycode) (ReadOnly): Dc access security code -* **error**: [CloudError](#clouderror) (ReadOnly): Provides additional information about an http error response. -### DataboxJobSecrets -#### Properties -* **jobSecretsType**: 'DataBox' (Required): Used to indicate what type of job secrets object. -* **podSecrets**: [DataBoxSecret](#databoxsecret)[] (ReadOnly): Contains the list of secret objects for a job. - -### CustomerDiskJobSecrets -#### Properties -* **carrierAccountNumber**: string (ReadOnly): Carrier Account Number of the customer -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **jobSecretsType**: 'DataBoxCustomerDisk' (Required): Used to indicate what type of job secrets object. - -### DataBoxDiskJobSecrets -#### Properties -* **diskSecrets**: [DiskSecret](#disksecret)[] (ReadOnly): Contains the list of secrets object for that device. -* **isPasskeyUserDefined**: bool (ReadOnly): Whether passkey was provided by user. -* **jobSecretsType**: 'DataBoxDisk' (Required): Used to indicate what type of job secrets object. -* **passKey**: string (ReadOnly): PassKey for the disk Job. - -### DataBoxHeavyJobSecrets -#### Properties -* **cabinetPodSecrets**: [DataBoxHeavySecret](#databoxheavysecret)[] (ReadOnly): Contains the list of secret objects for a databox heavy job. -* **jobSecretsType**: 'DataBoxHeavy' (Required): Used to indicate what type of job secrets object. - +* **include**: [TransferAllDetails](#transferalldetails): Details to transfer all data. -## DcAccessSecurityCode +## TransferConfigurationTransferFilterDetails ### Properties -* **forwardDCAccessCode**: string (ReadOnly): Forward Dc access security code. -* **reverseDCAccessCode**: string (ReadOnly): Reverse Dc access security code. +* **include**: [TransferFilterDetails](#transferfilterdetails): Details of the filtering the transfer of data. -## DataBoxSecret +## TransferFilterDetails ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **azureFileFilterDetails**: [AzureFileFilterDetails](#azurefilefilterdetails): Filter details to transfer Azure files +* **blobFilterDetails**: [BlobFilterDetails](#blobfilterdetails): Filter details to transfer Azure Blobs +* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (Required): Type of the account. +* **filterFileDetails**: [FilterFileDetails](#filterfiledetails)[]: Details of the filter files to be used for data transfer. -## AccountCredentialDetails +## TransportPreferences ### Properties -* **accountConnectionString**: string (ReadOnly): Connection string of the account endpoint to use the account as a storage endpoint on the device. -* **accountName**: string (ReadOnly): Name of the account. -* **dataAccountType**: 'ManagedDisk' | 'StorageAccount' (ReadOnly): Type of the account. -* **shareCredentialDetails**: [ShareCredentialDetails](#sharecredentialdetails)[] (ReadOnly): Per share level unencrypted access credentials. +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' (Required): Transport Shipment Type supported for given region. -## ShareCredentialDetails +## UnencryptedCredentials ### Properties -* **password**: string (ReadOnly): Password for the share. -* **shareName**: string (ReadOnly): Name of the share. -* **shareType**: 'AzureFile' | 'BlockBlob' | 'HCS' | 'ManagedDisk' | 'PageBlob' | 'UnknownType' (ReadOnly): Type of the share. -* **supportedAccessProtocols**: 'NFS' | 'SMB'[] (ReadOnly): Access protocols supported on the device. -* **userName**: string (ReadOnly): User name for the share. +* **jobName**: string (ReadOnly): Name of the job. +* **jobSecrets**: [JobSecrets](#jobsecrets) (ReadOnly): The base class for the secrets -## ApplianceNetworkConfiguration +## UnencryptedCredentialsList ### Properties -* **macAddress**: string (ReadOnly): Mac Address. -* **name**: string (ReadOnly): Name of the network. +* **nextLink**: string (ReadOnly): Link for the next set of unencrypted credentials. +* **value**: [UnencryptedCredentials](#unencryptedcredentials)[] (ReadOnly): List of unencrypted credentials. -## DiskSecret +## UserAssignedIdentity ### Properties -* **bitLockerKey**: string (ReadOnly): Bit Locker key of the disk which can be used to unlock the disk to copy data. -* **diskSerialNumber**: string (ReadOnly): Serial number of the assigned disk. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## DataBoxHeavySecret +## UserAssignedProperties ### Properties -* **accountCredentialDetails**: [AccountCredentialDetails](#accountcredentialdetails)[] (ReadOnly): Per account level access credentials. -* **devicePassword**: string (ReadOnly): Password for out of the box experience on device. -* **deviceSerialNumber**: string (ReadOnly): Serial number of the assigned device. -* **encodedValidationCertPubKey**: string (ReadOnly): The base 64 encoded public key to authenticate with the device -* **networkConfigurations**: [ApplianceNetworkConfiguration](#appliancenetworkconfiguration)[] (ReadOnly): Network configuration of the appliance. +* **resourceId**: string: Arm resource id for user assigned identity to be used to fetch MSI token. diff --git a/generated/databoxedge/log.out b/generated/databoxedge/log.out index b874665a69..a178869edc 100644 --- a/generated/databoxedge/log.out +++ b/generated/databoxedge/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.databoxedge-2022-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon @@ -34,7 +34,7 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SystemData' -> info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.databoxedge-2022-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon @@ -61,10 +61,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MECRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 20ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.databoxedge-2021-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon @@ -91,10 +91,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MECRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 13ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.databoxedge-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon @@ -121,10 +121,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MECRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 14ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.databoxedge-2021-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ArcAddon' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from ArcAddon @@ -151,10 +151,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MECRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 12ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.databoxedge-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2021-02-01-preview/databoxedge.json:4388:5 @@ -188,7 +188,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrig info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.databoxedge-2020-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2020-12-01/databoxedge.json:4388:5 @@ -219,10 +219,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MECRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 14ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.databoxedge-2020-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json:4388:5 @@ -256,7 +256,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrig info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.databoxedge-2020-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2020-09-01/databoxedge.json:4388:5 @@ -287,10 +287,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MECRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 14ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.databoxedge-2020-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json:3561:5 @@ -309,7 +309,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrig info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.databoxedge-2019-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json:3522:5 @@ -325,10 +325,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'IoTRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 9ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.databoxedge-2019-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-07-01/databoxedge.json:2944:5 @@ -344,10 +344,10 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'IoTRole' has a propert warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'id' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.databoxedge-2019-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-03-01/databoxedge.json:2895:5 @@ -364,4 +364,4 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrig warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'name' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger warning | PreCheck/PropertyRedeclarationWarning | Schema 'PeriodicTimerEventTrigger' has a property 'type' that is already declared the parent schema 'ARMBaseModel' but isn't significantly different. The property has been removed from PeriodicTimerEventTrigger info | autorest.bicep took 4ms -info | Autorest completed in 74.06s. 26 files generated. +info | Autorest completed in 71.44s. 26 files generated. diff --git a/generated/databoxedge/microsoft.databoxedge/2019-03-01/types.md b/generated/databoxedge/microsoft.databoxedge/2019-03-01/types.md index fe900fd0ff..d6a25b0d6d 100644 --- a/generated/databoxedge/microsoft.databoxedge/2019-03-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2019-03-01/types.md @@ -93,6 +93,51 @@ * **properties**: [UserProperties](#userproperties) (Required): The user properties. * **type**: 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/users' (ReadOnly, DeployTimeConstant): The resource type +## Address +### Properties +* **addressLine1**: string (Required): The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string (Required): The city name. +* **country**: string (Required): The country name. +* **postalCode**: string (Required): The postal code. +* **state**: string (Required): The state name. + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + ## DataBoxEdgeDeviceProperties ### Properties * **configuredRoleTypes**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string[] (ReadOnly): Type of compute roles configured. @@ -109,22 +154,41 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## Sku -### Properties -* **name**: 'Edge' | 'Gateway' | string: SKU name. -* **tier**: 'Standard' | string: The SKU tier. This is based on the SKU name. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## FileSourceInfo ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **shareId**: string (Required): File share ID. + +## FileTriggerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. + +## IoTDeviceInfo +### Properties +* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. +* **deviceId**: string (Required): ID of the IoT device/edge device. +* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. + +## IoTRoleProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). + +## MountPointMap +### Properties +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. ## OrderProperties ### Properties @@ -136,70 +200,39 @@ * **serialNumber**: string (ReadOnly): Serial number of the device. * **shippingAddress**: [Address](#address) (Required): The shipping address of the customer. -## ContactDetails -### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. - ## OrderStatus ### Properties * **comments**: string: Comments related to this status change. * **status**: 'Arriving' | 'AwaitingFulfilment' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. * **updateDateTime**: string (ReadOnly): Time of status update. -## TrackingInfo -### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. - -## Address -### Properties -* **addressLine1**: string (Required): The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string (Required): The city name. -* **country**: string (Required): The country name. -* **postalCode**: string (Required): The postal code. -* **state**: string (Required): The state name. - -## IoTRoleProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## IoTDeviceInfo +## PeriodicTimerProperties ### Properties -* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. -* **deviceId**: string (Required): ID of the IoT device/edge device. -* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. -## Authentication +## PeriodicTimerSourceInfo ### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. -## SymmetricKey +## RefreshDetails ### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **errorManifestFile**: string: Indicates the relative path of the error xml for the last refresh job on this particular share, if any. This could be a failed job or a successful job. +* **inProgressRefreshJobId**: string: If a refresh share job is currently in progress on this share, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. +* **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share, if any.This could be a failed job or a successful job. +* **lastJob**: string: Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job. -## AsymmetricEncryptedSecret +## RoleSinkInfo ### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. +* **roleId**: string (Required): Compute role ID. -## MountPointMap +## ShareAccessRight ### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **shareId**: string (Required): The share ID. ## ShareProperties ### Properties @@ -214,28 +247,10 @@ * **shareStatus**: 'Offline' | 'Online' | string (Required): Current status of the share. * **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). -## AzureContainerInfo -### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. - -## ClientAccessRight -### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. - -## RefreshDetails -### Properties -* **errorManifestFile**: string: Indicates the relative path of the error xml for the last refresh job on this particular share, if any. This could be a failed job or a successful job. -* **inProgressRefreshJobId**: string: If a refresh share job is currently in progress on this share, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. -* **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share, if any.This could be a failed job or a successful job. -* **lastJob**: string: Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job. - -## UserAccessRight +## Sku ### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **name**: 'Edge' | 'Gateway' | string: SKU name. +* **tier**: 'Standard' | string: The SKU tier. This is based on the SKU name. ## StorageAccountCredentialProperties ### Properties @@ -247,39 +262,24 @@ * **sslStatus**: 'Disabled' | 'Enabled' | string (Required): Signifies whether SSL needs to be enabled or not. * **userName**: string: Username for the storage account. -## FileTriggerProperties -### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. - -## RoleSinkInfo -### Properties -* **roleId**: string (Required): Compute role ID. - -## FileSourceInfo +## SymmetricKey ### Properties -* **shareId**: string (Required): File share ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified up to seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties * **encryptedPassword**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[]: List of shares that the user has rights on. This field should not be specified during user creation. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - diff --git a/generated/databoxedge/microsoft.databoxedge/2019-07-01/types.md b/generated/databoxedge/microsoft.databoxedge/2019-07-01/types.md index e0df92a888..4a2e4e846d 100644 --- a/generated/databoxedge/microsoft.databoxedge/2019-07-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2019-07-01/types.md @@ -93,6 +93,51 @@ * **properties**: [UserProperties](#userproperties) (Required): The user properties. * **type**: 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/users' (ReadOnly, DeployTimeConstant): The resource type +## Address +### Properties +* **addressLine1**: string (Required): The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string (Required): The city name. +* **country**: string (Required): The country name. +* **postalCode**: string (Required): The postal code. +* **state**: string (Required): The state name. + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + ## DataBoxEdgeDeviceProperties ### Properties * **configuredRoleTypes**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string[] (ReadOnly): Type of compute roles configured. @@ -110,22 +155,42 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## Sku -### Properties -* **name**: 'Edge' | 'Gateway' | string: SKU name. -* **tier**: 'Standard' | string: The SKU tier. This is based on the SKU name. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## FileSourceInfo ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **shareId**: string (Required): File share ID. + +## FileTriggerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. + +## IoTDeviceInfo +### Properties +* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. +* **deviceId**: string (Required): ID of the IoT device/edge device. +* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. +* **ioTHostHubId**: string: Id of the IoT hub associated to the device. + +## IoTRoleProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). + +## MountPointMap +### Properties +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. ## OrderProperties ### Properties @@ -137,71 +202,39 @@ * **serialNumber**: string (ReadOnly): Serial number of the device. * **shippingAddress**: [Address](#address) (Required): The shipping address of the customer. -## ContactDetails -### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. - ## OrderStatus ### Properties * **comments**: string: Comments related to this status change. * **status**: 'Arriving' | 'AwaitingFulfilment' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. * **updateDateTime**: string (ReadOnly): Time of status update. -## TrackingInfo -### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. - -## Address -### Properties -* **addressLine1**: string (Required): The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string (Required): The city name. -* **country**: string (Required): The country name. -* **postalCode**: string (Required): The postal code. -* **state**: string (Required): The state name. - -## IoTRoleProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## IoTDeviceInfo +## PeriodicTimerProperties ### Properties -* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. -* **deviceId**: string (Required): ID of the IoT device/edge device. -* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. -* **ioTHostHubId**: string: Id of the IoT hub associated to the device. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. -## Authentication +## PeriodicTimerSourceInfo ### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. -## SymmetricKey +## RefreshDetails ### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **errorManifestFile**: string: Indicates the relative path of the error xml for the last refresh job on this particular share, if any. This could be a failed job or a successful job. +* **inProgressRefreshJobId**: string: If a refresh share job is currently in progress on this share, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. +* **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share, if any.This could be a failed job or a successful job. +* **lastJob**: string: Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job. -## AsymmetricEncryptedSecret +## RoleSinkInfo ### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. +* **roleId**: string (Required): Compute role ID. -## MountPointMap +## ShareAccessRight ### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **shareId**: string (Required): The share ID. ## ShareProperties ### Properties @@ -216,28 +249,10 @@ * **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. * **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). -## AzureContainerInfo -### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. - -## ClientAccessRight -### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. - -## RefreshDetails -### Properties -* **errorManifestFile**: string: Indicates the relative path of the error xml for the last refresh job on this particular share, if any. This could be a failed job or a successful job. -* **inProgressRefreshJobId**: string: If a refresh share job is currently in progress on this share, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. -* **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share, if any.This could be a failed job or a successful job. -* **lastJob**: string: Indicates the id of the last refresh job on this particular share,if any. This could be a failed job or a successful job. - -## UserAccessRight +## Sku ### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **name**: 'Edge' | 'Gateway' | string: SKU name. +* **tier**: 'Standard' | string: The SKU tier. This is based on the SKU name. ## StorageAccountCredentialProperties ### Properties @@ -250,39 +265,24 @@ * **storageAccountId**: string: Id of the storage account. * **userName**: string: Username for the storage account. -## FileTriggerProperties -### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. - -## RoleSinkInfo -### Properties -* **roleId**: string (Required): Compute role ID. - -## FileSourceInfo +## SymmetricKey ### Properties -* **shareId**: string (Required): File share ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties * **encryptedPassword**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[]: List of shares that the user has rights on. This field should not be specified during user creation. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - diff --git a/generated/databoxedge/microsoft.databoxedge/2019-08-01/types.md b/generated/databoxedge/microsoft.databoxedge/2019-08-01/types.md index 4d1eb10687..2fcc187c12 100644 --- a/generated/databoxedge/microsoft.databoxedge/2019-08-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2019-08-01/types.md @@ -111,6 +111,58 @@ * **properties**: [UserProperties](#userproperties) (Required): The user properties. * **type**: 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/users' (ReadOnly, DeployTimeConstant): The resource type +## Address +### Properties +* **addressLine1**: string (Required): The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string (Required): The city name. +* **country**: string (Required): The country name. +* **postalCode**: string (Required): The postal code. +* **state**: string (Required): The state name. + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. + ## DataBoxEdgeDeviceProperties ### Properties * **configuredRoleTypes**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string[] (ReadOnly): Type of compute roles configured. @@ -128,22 +180,42 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## Sku -### Properties -* **name**: 'Edge' | 'Gateway' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name -* **tier**: 'Standard' | string: The Sku tier - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## FileSourceInfo ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **shareId**: string (Required): File share ID. + +## FileTriggerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. + +## IoTDeviceInfo +### Properties +* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. +* **deviceId**: string (Required): ID of the IoT device/edge device. +* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. +* **ioTHostHubId**: string: Id for the IoT hub associated to the device. + +## IoTRoleProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). + +## MountPointMap +### Properties +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. ## OrderProperties ### Properties @@ -155,13 +227,6 @@ * **serialNumber**: string (ReadOnly): Serial number of the device. * **shippingAddress**: [Address](#address) (Required): The shipping address of the customer. -## ContactDetails -### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. - ## OrderStatus ### Properties * **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored @@ -175,58 +240,33 @@ by the already existing properties ### Additional Properties * **Additional Properties Type**: string -## TrackingInfo -### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. - -## Address -### Properties -* **addressLine1**: string (Required): The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string (Required): The city name. -* **country**: string (Required): The country name. -* **postalCode**: string (Required): The postal code. -* **state**: string (Required): The state name. - -## IoTRoleProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## IoTDeviceInfo +## PeriodicTimerProperties ### Properties -* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. -* **deviceId**: string (Required): ID of the IoT device/edge device. -* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. -* **ioTHostHubId**: string: Id for the IoT hub associated to the device. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. -## Authentication +## PeriodicTimerSourceInfo ### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. -## SymmetricKey +## RefreshDetails ### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **errorManifestFile**: string: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. +* **inProgressRefreshJobId**: string: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. +* **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. +* **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## AsymmetricEncryptedSecret +## RoleSinkInfo ### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. +* **roleId**: string (Required): Compute role ID. -## MountPointMap +## ShareAccessRight ### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **shareId**: string (Required): The share ID. ## ShareProperties ### Properties @@ -241,28 +281,10 @@ by the already existing properties * **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. * **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). -## AzureContainerInfo -### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. - -## ClientAccessRight -### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. - -## RefreshDetails -### Properties -* **errorManifestFile**: string: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. -* **inProgressRefreshJobId**: string: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. -* **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. -* **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. - -## UserAccessRight +## Sku ### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **name**: 'Edge' | 'Gateway' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name +* **tier**: 'Standard' | string: The Sku tier ## StorageAccountCredentialProperties ### Properties @@ -284,38 +306,21 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties -### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. - -## FileTriggerProperties -### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. - -## RoleSinkInfo -### Properties -* **roleId**: string (Required): Compute role ID. - -## FileSourceInfo +## SymmetricKey ### Properties -* **shareId**: string (Required): File share ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -323,8 +328,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[]: List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - diff --git a/generated/databoxedge/microsoft.databoxedge/2020-05-01-preview/types.md b/generated/databoxedge/microsoft.databoxedge/2020-05-01-preview/types.md index f6b31a3a41..c860ec0c08 100644 --- a/generated/databoxedge/microsoft.databoxedge/2020-05-01-preview/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2020-05-01-preview/types.md @@ -111,32 +111,31 @@ * **properties**: [UserProperties](#userproperties) (Required): The user properties. * **type**: 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/users' (ReadOnly, DeployTimeConstant): The resource type -## DataBoxEdgeDeviceProperties +## Address ### Properties -* **configuredRoleTypes**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string[] (ReadOnly): Type of compute roles configured. -* **culture**: string (ReadOnly): The Data Box Edge/Gateway device culture. -* **dataBoxEdgeDeviceStatus**: 'Disconnected' | 'Maintenance' | 'NeedsAttention' | 'Offline' | 'Online' | 'PartiallyDisconnected' | 'ReadyToSetup' | string: The status of the Data Box Edge/Gateway device. -* **description**: string: The Description of the Data Box Edge/Gateway device. -* **deviceHcsVersion**: string (ReadOnly): The device software version number of the device (eg: 1.2.18105.6). -* **deviceLocalCapacity**: int (ReadOnly): The Data Box Edge/Gateway device local capacity in MB. -* **deviceModel**: string (ReadOnly): The Data Box Edge/Gateway device model. -* **deviceSoftwareVersion**: string (ReadOnly): The Data Box Edge/Gateway device software version. -* **deviceType**: 'DataBoxEdgeDevice' | string (ReadOnly): The type of the Data Box Edge/Gateway device. -* **friendlyName**: string: The Data Box Edge/Gateway device name. -* **modelDescription**: string: The description of the Data Box Edge/Gateway device model. -* **nodeCount**: int (ReadOnly): The number of nodes in the cluster. -* **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. -* **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. +* **addressLine1**: string (Required): The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string (Required): The city name. +* **country**: string (Required): The country name. +* **postalCode**: string (Required): The postal code. +* **state**: string (Required): The state name. -## Sku +## AsymmetricEncryptedSecret ### Properties -* **name**: 'Edge' | 'GPU' | 'Gateway' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. -## DataBoxEdgeDeviceTags +## Authentication ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. ## BandwidthScheduleProperties ### Properties @@ -145,15 +144,10 @@ * **start**: string (Required): The start time of the schedule in UTC. * **stop**: string (Required): The stop time of the schedule in UTC. -## OrderProperties +## ClientAccessRight ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shippingAddress**: [Address](#address) (Required): The shipping address of the customer. +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. ## ContactDetails ### Properties @@ -162,45 +156,50 @@ * **emailList**: string[] (Required): The email list. * **phone**: string (Required): The phone number. -## OrderStatus +## ContainerProperties ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingFulfilment' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. -## OrderStatusAdditionalOrderDetails +## DataBoxEdgeDeviceProperties +### Properties +* **configuredRoleTypes**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string[] (ReadOnly): Type of compute roles configured. +* **culture**: string (ReadOnly): The Data Box Edge/Gateway device culture. +* **dataBoxEdgeDeviceStatus**: 'Disconnected' | 'Maintenance' | 'NeedsAttention' | 'Offline' | 'Online' | 'PartiallyDisconnected' | 'ReadyToSetup' | string: The status of the Data Box Edge/Gateway device. +* **description**: string: The Description of the Data Box Edge/Gateway device. +* **deviceHcsVersion**: string (ReadOnly): The device software version number of the device (eg: 1.2.18105.6). +* **deviceLocalCapacity**: int (ReadOnly): The Data Box Edge/Gateway device local capacity in MB. +* **deviceModel**: string (ReadOnly): The Data Box Edge/Gateway device model. +* **deviceSoftwareVersion**: string (ReadOnly): The Data Box Edge/Gateway device software version. +* **deviceType**: 'DataBoxEdgeDevice' | string (ReadOnly): The type of the Data Box Edge/Gateway device. +* **friendlyName**: string: The Data Box Edge/Gateway device name. +* **modelDescription**: string: The description of the Data Box Edge/Gateway device model. +* **nodeCount**: int (ReadOnly): The number of nodes in the cluster. +* **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. +* **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. + +## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string (Required): The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string (Required): The city name. -* **country**: string (Required): The country name. -* **postalCode**: string (Required): The postal code. -* **state**: string (Required): The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## IoTRoleProperties +## ImageRepositoryCredential ### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the Iot runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. ## IoTDeviceInfo ### Properties @@ -209,31 +208,21 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential +## IoTRoleProperties ### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the IoT role. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the Iot runtime is hosted. +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Role status. +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## MountPointMap ### Properties @@ -243,29 +232,40 @@ by the already existing properties * **roleType**: 'ASA' | 'Cognitive' | 'Functions' | 'IOT' | string (ReadOnly) * **shareId**: string (Required): ID of the share mounted to the role VM. -## ShareProperties +## OrderProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shippingAddress**: [Address](#address) (Required): The shipping address of the customer. -## AzureContainerInfo +## OrderStatus ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingFulfilment' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **updateDateTime**: string (ReadOnly): Time of status update. -## ClientAccessRight +## OrderStatusAdditionalOrderDetails ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. ## RefreshDetails ### Properties @@ -274,10 +274,32 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'Edge' | 'GPU' | 'Gateway' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -299,38 +321,21 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties -### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. - -## FileTriggerProperties -### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. - -## RoleSinkInfo -### Properties -* **roleId**: string (Required): Compute role ID. - -## FileSourceInfo +## SymmetricKey ### Properties -* **shareId**: string (Required): File share ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -338,8 +343,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - diff --git a/generated/databoxedge/microsoft.databoxedge/2020-09-01-preview/types.md b/generated/databoxedge/microsoft.databoxedge/2020-09-01-preview/types.md index 715db8b155..55ff0e0790 100644 --- a/generated/databoxedge/microsoft.databoxedge/2020-09-01-preview/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2020-09-01-preview/types.md @@ -172,11 +172,86 @@ * **ApiVersion**: 2020-09-01-preview * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -197,133 +272,61 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## Sku -### Properties -* **name**: 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## DCAccessCode ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## OrderProperties +## DCAccessCodeProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfilment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -332,48 +335,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -381,28 +358,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -414,17 +374,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -437,35 +400,16 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -473,10 +417,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -484,34 +424,69 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfilment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. ## RefreshDetails ### Properties @@ -520,10 +495,43 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -545,38 +553,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -584,16 +597,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string: Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2020-09-01/types.md b/generated/databoxedge/microsoft.databoxedge/2020-09-01/types.md index f1e0f3e649..778fc0207d 100644 --- a/generated/databoxedge/microsoft.databoxedge/2020-09-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2020-09-01/types.md @@ -172,11 +172,86 @@ * **ApiVersion**: 2020-09-01 * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -197,133 +272,61 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## Sku -### Properties -* **name**: 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## DCAccessCode ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## OrderProperties +## DCAccessCodeProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfilment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -332,48 +335,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -381,28 +358,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -414,17 +374,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -437,35 +400,16 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -473,10 +417,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -484,34 +424,69 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfilment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. ## RefreshDetails ### Properties @@ -520,10 +495,43 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -545,38 +553,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -584,16 +597,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string: Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2020-12-01/types.md b/generated/databoxedge/microsoft.databoxedge/2020-12-01/types.md index c0447ceef2..118b73ff8d 100644 --- a/generated/databoxedge/microsoft.databoxedge/2020-12-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2020-12-01/types.md @@ -172,11 +172,86 @@ * **ApiVersion**: 2020-12-01 * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -197,133 +272,61 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## Sku -### Properties -* **name**: 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## DCAccessCode ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## OrderProperties +## DCAccessCodeProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfilment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -332,48 +335,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -381,28 +358,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -414,17 +374,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -437,35 +400,16 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -473,10 +417,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -484,34 +424,69 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfilment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. ## RefreshDetails ### Properties @@ -520,10 +495,43 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -545,38 +553,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -584,16 +597,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2021-02-01-preview/types.md b/generated/databoxedge/microsoft.databoxedge/2021-02-01-preview/types.md index a573dede05..910c9f86b3 100644 --- a/generated/databoxedge/microsoft.databoxedge/2021-02-01-preview/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2021-02-01-preview/types.md @@ -174,11 +174,86 @@ * **ApiVersion**: 2021-02-01-preview * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -199,133 +274,61 @@ * **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## Sku -### Properties -* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties +## DCAccessCode ### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## OrderProperties +## DCAccessCodeProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -334,48 +337,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -383,28 +360,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -416,17 +376,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -439,6 +402,11 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -446,30 +414,6 @@ by the already existing properties * **resourceUniqueId**: string: Unique Id of the Resource. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -477,10 +421,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -488,34 +428,69 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. ## RefreshDetails ### Properties @@ -524,10 +499,43 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -549,38 +557,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -588,16 +601,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string: Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2021-02-01/types.md b/generated/databoxedge/microsoft.databoxedge/2021-02-01/types.md index 2bbed8d221..89e4e06d4e 100644 --- a/generated/databoxedge/microsoft.databoxedge/2021-02-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2021-02-01/types.md @@ -194,11 +194,86 @@ * **ApiVersion**: 2021-02-01 * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -221,151 +296,69 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## DataResidency -### Properties -* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum - -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## Sku -### Properties -* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. - -## ProactiveLogCollectionSettingsProperties +## DataResidency ### Properties -* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag +* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum -## DiagnosticRemoteSupportSettingsProperties +## DCAccessCode ### Properties -* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## RemoteSupportSettings +## DCAccessCodeProperties ### Properties -* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type -* **expirationTimeStampInUTC**: string: Expiration time stamp -* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## OrderProperties +## DiagnosticRemoteSupportSettingsProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -374,48 +367,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -423,28 +390,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -456,17 +406,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -479,6 +432,11 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -486,30 +444,6 @@ by the already existing properties * **resourceUniqueId**: string: Unique Id of the Resource. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -517,10 +451,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -528,34 +458,73 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. + +## ProactiveLogCollectionSettingsProperties +### Properties +* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag ## RefreshDetails ### Properties @@ -564,10 +533,49 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## RemoteSupportSettings +### Properties +* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type +* **expirationTimeStampInUTC**: string: Expiration time stamp +* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -589,38 +597,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -628,16 +641,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2021-06-01-preview/types.md b/generated/databoxedge/microsoft.databoxedge/2021-06-01-preview/types.md index f518578494..ac855ae388 100644 --- a/generated/databoxedge/microsoft.databoxedge/2021-06-01-preview/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2021-06-01-preview/types.md @@ -195,11 +195,86 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -222,152 +297,69 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## DataResidency -### Properties -* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum - -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## Sku -### Properties -* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. - -## ProactiveLogCollectionSettingsProperties +## DataResidency ### Properties -* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag +* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum -## DiagnosticRemoteSupportSettingsProperties +## DCAccessCode ### Properties -* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## RemoteSupportSettings +## DCAccessCodeProperties ### Properties -* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type -* **expirationTimeStampInUTC**: string: Expiration time stamp -* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## OrderProperties +## DiagnosticRemoteSupportSettingsProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **orderId**: string (ReadOnly): It specify the order resource id. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -376,48 +368,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -425,28 +391,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -458,17 +407,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -481,6 +433,11 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -488,30 +445,6 @@ by the already existing properties * **resourceUniqueId**: string: Unique Id of the Resource. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -519,10 +452,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -530,34 +459,74 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **orderId**: string (ReadOnly): It specify the order resource id. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. + +## ProactiveLogCollectionSettingsProperties +### Properties +* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag ## RefreshDetails ### Properties @@ -566,10 +535,49 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## RemoteSupportSettings +### Properties +* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type +* **expirationTimeStampInUTC**: string: Expiration time stamp +* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -591,38 +599,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -630,16 +643,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2021-06-01/types.md b/generated/databoxedge/microsoft.databoxedge/2021-06-01/types.md index 73cdb01a36..6ecbed1b4c 100644 --- a/generated/databoxedge/microsoft.databoxedge/2021-06-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2021-06-01/types.md @@ -194,11 +194,86 @@ * **ApiVersion**: 2021-06-01 * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -221,151 +296,69 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## DataResidency -### Properties -* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum - -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## Sku -### Properties -* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. - -## ProactiveLogCollectionSettingsProperties +## DataResidency ### Properties -* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag +* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum -## DiagnosticRemoteSupportSettingsProperties +## DCAccessCode ### Properties -* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## RemoteSupportSettings +## DCAccessCodeProperties ### Properties -* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type -* **expirationTimeStampInUTC**: string: Expiration time stamp -* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## OrderProperties +## DiagnosticRemoteSupportSettingsProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -374,48 +367,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -423,28 +390,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -456,17 +406,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -479,6 +432,11 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -486,30 +444,6 @@ by the already existing properties * **resourceUniqueId**: string: Unique Id of the Resource. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -517,10 +451,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -528,34 +458,73 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. + +## ProactiveLogCollectionSettingsProperties +### Properties +* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag ## RefreshDetails ### Properties @@ -564,10 +533,49 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## RemoteSupportSettings +### Properties +* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type +* **expirationTimeStampInUTC**: string: Expiration time stamp +* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_64_1VPU_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -589,38 +597,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -628,16 +641,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2022-03-01/types.md b/generated/databoxedge/microsoft.databoxedge/2022-03-01/types.md index 70855f110b..ab5b9731dc 100644 --- a/generated/databoxedge/microsoft.databoxedge/2022-03-01/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2022-03-01/types.md @@ -195,11 +195,86 @@ * **ApiVersion**: 2022-03-01 * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity +## Address ### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. + +## ArcAddonProperties +### Properties +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version + +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + +## Authentication +### Properties +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. + +## AzureContainerInfo +### Properties +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. + +## BandwidthScheduleProperties +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The bandwidth rate in Mbps. +* **start**: string (Required): The start time of the schedule in UTC. +* **stop**: string (Required): The stop time of the schedule in UTC. + +## ClientAccessRight +### Properties +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. + +## CloudEdgeManagementRoleProperties +### Properties +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status + +## CniConfig +### Properties +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version + +## ComputeResource +### Properties +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ContactDetails +### Properties +* **companyName**: string (Required): The name of the company. +* **contactPerson**: string (Required): The contact person name. +* **emailList**: string[] (Required): The email list. +* **phone**: string (Required): The phone number. + +## ContainerProperties +### Properties +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. ## DataBoxEdgeDeviceProperties ### Properties @@ -222,152 +297,69 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## DataResidency -### Properties -* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum - -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures -### Properties -* **name**: string -* **state**: string - -## ResourceMoveDetails -### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## Sku -### Properties -* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_128_GPU1_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_256_GPU2_Mx1' | 'EP2_64_1VPU_W' | 'EP2_64_Mx1_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgeMR_TCP' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. - ## DataBoxEdgeDeviceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BandwidthScheduleProperties -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The bandwidth rate in Mbps. -* **start**: string (Required): The start time of the schedule in UTC. -* **stop**: string (Required): The stop time of the schedule in UTC. - -## ProactiveLogCollectionSettingsProperties +## DataResidency ### Properties -* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag +* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum -## DiagnosticRemoteSupportSettingsProperties +## DCAccessCode ### Properties -* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## RemoteSupportSettings +## DCAccessCodeProperties ### Properties -* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type -* **expirationTimeStampInUTC**: string: Expiration time stamp -* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## OrderProperties +## DiagnosticRemoteSupportSettingsProperties ### Properties -* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **orderId**: string (ReadOnly): It specify the order resource id. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType -## ContactDetails +## EdgeProfile ### Properties -* **companyName**: string (Required): The name of the company. -* **contactPerson**: string (Required): The contact person name. -* **emailList**: string[] (Required): The email list. -* **phone**: string (Required): The phone number. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## OrderStatus +## EdgeProfileSubscription ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## OrderStatusAdditionalOrderDetails +## EtcdInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## TrackingInfo +## FileSourceInfo ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +* **shareId**: string (Required): File share ID. -## Address +## FileTriggerProperties ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. -## CloudEdgeManagementRoleProperties +## ImageRepositoryCredential ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). +* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **userName**: string (Required): Repository user name. -## IoTRoleProperties +## IoTAddonProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. * **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. * **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). - -## ComputeResource -### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **version**: string (ReadOnly): Version of IoT running on the appliance. ## IoTDeviceInfo ### Properties @@ -376,48 +368,22 @@ by the already existing properties * **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. * **ioTHostHubId**: string: Id for the IoT hub associated to the device. -## Authentication -### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. - -## SymmetricKey -### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. - -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. - ## IoTEdgeAgentInfo ### Properties * **imageName**: string (Required): Name of the IoT edge agent image. * **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. * **tag**: string (Required): Image Tag. -## ImageRepositoryCredential -### Properties -* **imageRepositoryUrl**: string (Required): Image repository url (e.g.: mcr.microsoft.com). -* **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **userName**: string (Required): Repository user name. - -## MountPointMap -### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. - -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -425,28 +391,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **memoryInBytes**: int (ReadOnly): Memory in bytes @@ -458,17 +407,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -481,6 +433,11 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -488,30 +445,6 @@ by the already existing properties * **resourceUniqueId**: string: Unique Id of the Resource. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## IoTAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **version**: string (ReadOnly): Version of IoT running on the appliance. - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -519,10 +452,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -530,34 +459,74 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'Invalid' | 'Master' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails) (Required): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **orderId**: string (ReadOnly): It specify the order resource id. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. + +## ProactiveLogCollectionSettingsProperties +### Properties +* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag ## RefreshDetails ### Properties @@ -566,10 +535,49 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## RemoteSupportSettings +### Properties +* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type +* **expirationTimeStampInUTC**: string: Expiration time stamp +* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_128_GPU1_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_256_GPU2_Mx1' | 'EP2_64_1VPU_W' | 'EP2_64_Mx1_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgeMR_TCP' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -591,38 +599,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -630,16 +643,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databoxedge/microsoft.databoxedge/2022-04-01-preview/types.md b/generated/databoxedge/microsoft.databoxedge/2022-04-01-preview/types.md index b2eda2eb37..745ff984c5 100644 --- a/generated/databoxedge/microsoft.databoxedge/2022-04-01-preview/types.md +++ b/generated/databoxedge/microsoft.databoxedge/2022-04-01-preview/types.md @@ -190,94 +190,42 @@ * **ApiVersion**: 2022-04-01-preview * **Output**: [DCAccessCode](#dcaccesscode) -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): Service Principal Id backing the Msi -* **tenantId**: string (ReadOnly): Home Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type - -## DataBoxEdgeDeviceProperties -### Properties -* **computeVersionInformation**: [ComputeVersionInformation](#computeversioninformation) (ReadOnly): This contains the compute information -* **configuredRoleTypes**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string[] (ReadOnly): Type of compute roles configured. -* **culture**: string (ReadOnly): The Data Box Edge/Gateway device culture. -* **dataBoxEdgeDeviceStatus**: 'Disconnected' | 'Maintenance' | 'NeedsAttention' | 'Offline' | 'Online' | 'PartiallyDisconnected' | 'ReadyToSetup' | string: The status of the Data Box Edge/Gateway device. -* **dataResidency**: [DataResidency](#dataresidency): Wraps data-residency related information for edge-resource and this should be used with ARM layer. -* **description**: string (ReadOnly): The Description of the Data Box Edge/Gateway device. -* **deviceHcsVersion**: string (ReadOnly): The device software version number of the device (eg: 1.2.18105.6). -* **deviceLocalCapacity**: int (ReadOnly): The Data Box Edge/Gateway device local capacity in MB. -* **deviceModel**: string (ReadOnly): The Data Box Edge/Gateway device model. -* **deviceSoftwareVersion**: string (ReadOnly): The Data Box Edge/Gateway device software version. -* **deviceType**: 'DataBoxEdgeDevice' | string (ReadOnly): The type of the Data Box Edge/Gateway device. -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **friendlyName**: string (ReadOnly): The Data Box Edge/Gateway device name. -* **kubernetesPlatform**: string (ReadOnly): Type of Kubernetes Platform -* **modelDescription**: string (ReadOnly): The description of the Data Box Edge/Gateway device model. -* **nodeCount**: int (ReadOnly): The number of nodes in the cluster. -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): Fields for tracking resource move -* **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. - -## ComputeVersionInformation -### Properties -* **azureArcVersion**: string: Azure Arc Version -* **iotEdgeVersion**: string: IOTEdge Version -* **kubernetesVersion**: string: Kubernetes Version - -## DataResidency -### Properties -* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum - -## EdgeProfile -### Properties -* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile - -## EdgeProfileSubscription -### Properties -* **id**: string: ARM ID of the subscription -* **properties**: [SubscriptionProperties](#subscriptionproperties) -* **registrationDate**: string -* **registrationId**: string: Edge Subscription Registration ID -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string -* **subscriptionId**: string - -## SubscriptionProperties -### Properties -* **locationPlacementId**: string -* **quotaId**: string -* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures -* **serializedDetails**: string -* **tenantId**: string - -## SubscriptionRegisteredFeatures +## Address ### Properties -* **name**: string -* **state**: string +* **addressLine1**: string: The address line1. +* **addressLine2**: string: The address line2. +* **addressLine3**: string: The address line3. +* **city**: string: The city name. +* **country**: string (Required): The country name. +* **postalCode**: string: The postal code. +* **state**: string: The state name. -## ResourceMoveDetails +## ArcAddonProperties ### Properties -* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress -* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish +* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State +* **resourceGroupName**: string (Required): Arc resource group name +* **resourceLocation**: string (Required): Arc resource location +* **resourceName**: string (Required): Arc resource Name +* **subscriptionId**: string (Required): Arc resource subscription Id +* **version**: string (ReadOnly): Arc resource version -## SystemData +## AsymmetricEncryptedSecret ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. +* **value**: string (Required): The value of the secret. -## Sku +## Authentication ### Properties -* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_128_GPU1_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_256_GPU2_Mx1' | 'EP2_64_1VPU_W' | 'EP2_64_Mx1_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgeMR_TCP' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. -* **tier**: 'Standard' | string: The Sku tier. +* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. -## DataBoxEdgeDeviceTags +## AzureContainerInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. ## BandwidthScheduleProperties ### Properties @@ -286,31 +234,35 @@ * **start**: string (Required): The start time of the schedule in UTC. * **stop**: string (Required): The stop time of the schedule in UTC. -## ProactiveLogCollectionSettingsProperties +## ClientAccessRight ### Properties -* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag +* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. +* **client**: string (Required): IP of the client. -## DiagnosticRemoteSupportSettingsProperties +## CloudEdgeManagementRoleProperties ### Properties -* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## RemoteSupportSettings +## CniConfig ### Properties -* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type -* **expirationTimeStampInUTC**: string: Expiration time stamp -* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type +* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. +* **podSubnet**: string (ReadOnly): Pod Subnet +* **serviceSubnet**: string (ReadOnly): Service subnet +* **type**: string (ReadOnly): Cni type +* **version**: string (ReadOnly): Cni version -## OrderProperties +## ComputeResource ### Properties -* **contactInformation**: [ContactDetails](#contactdetails): Contains all the contact details of the customer. -* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. -* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. -* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. -* **orderId**: string (ReadOnly): It specify the order resource id. -* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. -* **serialNumber**: string (ReadOnly): Serial number of the device. -* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string -* **shippingAddress**: [Address](#address): The shipping address of the customer. +* **memoryInGB**: int (Required): Memory in GB +* **processorCount**: int (Required): Processor count + +## ComputeVersionInformation +### Properties +* **azureArcVersion**: string: Azure Arc Version +* **iotEdgeVersion**: string: IOTEdge Version +* **kubernetesVersion**: string: Kubernetes Version ## ContactDetails ### Properties @@ -319,85 +271,85 @@ * **emailList**: string[] (Required): The email list. * **phone**: string (Required): The phone number. -## OrderStatus +## ContainerProperties ### Properties -* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored -by the already existing properties -* **comments**: string: Comments related to this status change. -* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. -* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. -* **updateDateTime**: string (ReadOnly): Time of status update. +* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. +* **createdDateTime**: string (ReadOnly): The UTC time when container got created. +* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. -## OrderStatusAdditionalOrderDetails +## DataBoxEdgeDeviceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **computeVersionInformation**: [ComputeVersionInformation](#computeversioninformation) (ReadOnly): This contains the compute information +* **configuredRoleTypes**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string[] (ReadOnly): Type of compute roles configured. +* **culture**: string (ReadOnly): The Data Box Edge/Gateway device culture. +* **dataBoxEdgeDeviceStatus**: 'Disconnected' | 'Maintenance' | 'NeedsAttention' | 'Offline' | 'Online' | 'PartiallyDisconnected' | 'ReadyToSetup' | string: The status of the Data Box Edge/Gateway device. +* **dataResidency**: [DataResidency](#dataresidency): Wraps data-residency related information for edge-resource and this should be used with ARM layer. +* **description**: string (ReadOnly): The Description of the Data Box Edge/Gateway device. +* **deviceHcsVersion**: string (ReadOnly): The device software version number of the device (eg: 1.2.18105.6). +* **deviceLocalCapacity**: int (ReadOnly): The Data Box Edge/Gateway device local capacity in MB. +* **deviceModel**: string (ReadOnly): The Data Box Edge/Gateway device model. +* **deviceSoftwareVersion**: string (ReadOnly): The Data Box Edge/Gateway device software version. +* **deviceType**: 'DataBoxEdgeDevice' | string (ReadOnly): The type of the Data Box Edge/Gateway device. +* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource +* **friendlyName**: string (ReadOnly): The Data Box Edge/Gateway device name. +* **kubernetesPlatform**: string (ReadOnly): Type of Kubernetes Platform +* **modelDescription**: string (ReadOnly): The description of the Data Box Edge/Gateway device model. +* **nodeCount**: int (ReadOnly): The number of nodes in the cluster. +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): Fields for tracking resource move +* **serialNumber**: string (ReadOnly): The Serial Number of Data Box Edge/Gateway device. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **timeZone**: string (ReadOnly): The Data Box Edge/Gateway device timezone. -## TrackingInfo +## DataBoxEdgeDeviceTags ### Properties -* **carrierName**: string: Name of the carrier used in the delivery. -* **serialNumber**: string: Serial number of the device being tracked. -* **trackingId**: string: Tracking ID of the shipment. -* **trackingUrl**: string: Tracking URL of the shipment. +### Additional Properties +* **Additional Properties Type**: string -## Address +## DataResidency ### Properties -* **addressLine1**: string: The address line1. -* **addressLine2**: string: The address line2. -* **addressLine3**: string: The address line3. -* **city**: string: The city name. -* **country**: string (Required): The country name. -* **postalCode**: string: The postal code. -* **state**: string: The state name. +* **type**: 'GeoZoneReplication' | 'ZoneReplication' | string: DataResidencyType enum -## CloudEdgeManagementRoleProperties +## DCAccessCode ### Properties -* **edgeProfile**: [EdgeProfile](#edgeprofile) (ReadOnly): Details about Edge Profile for the resource -* **localManagementStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Local Edge Management Status -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. -## IoTRoleProperties +## DCAccessCodeProperties ### Properties -* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource -* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. -* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. -* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). +* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. -## ComputeResource +## DiagnosticRemoteSupportSettingsProperties ### Properties -* **memoryInGB**: int (Required): Memory in GB -* **processorCount**: int (Required): Processor count +* **remoteSupportSettingsList**: [RemoteSupportSettings](#remotesupportsettings)[]: Remote support settings list according to the RemoteApplicationType -## IoTDeviceInfo +## EdgeProfile ### Properties -* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. -* **deviceId**: string (Required): ID of the IoT device/edge device. -* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. -* **ioTHostHubId**: string: Id for the IoT hub associated to the device. +* **subscription**: [EdgeProfileSubscription](#edgeprofilesubscription): Subscription details for the Edge Profile -## Authentication +## EdgeProfileSubscription ### Properties -* **symmetricKey**: [SymmetricKey](#symmetrickey): Symmetric key for authentication. +* **id**: string: ARM ID of the subscription +* **properties**: [SubscriptionProperties](#subscriptionproperties) +* **registrationDate**: string +* **registrationId**: string: Edge Subscription Registration ID +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'Unregistered' | 'Warned' | string +* **subscriptionId**: string -## SymmetricKey +## EtcdInfo ### Properties -* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. +* **type**: string (ReadOnly): Etcd type +* **version**: string (ReadOnly): Etcd version -## AsymmetricEncryptedSecret +## FileSourceInfo ### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' | string (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. -* **value**: string (Required): The value of the secret. +* **shareId**: string (Required): File share ID. -## IoTEdgeAgentInfo +## FileTriggerProperties ### Properties -* **imageName**: string (Required): Name of the IoT edge agent image. -* **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. -* **tag**: string (Required): Image Tag. +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. ## ImageRepositoryCredential ### Properties @@ -405,22 +357,29 @@ by the already existing properties * **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. * **userName**: string (Required): Repository user name. -## MountPointMap +## IoTDeviceInfo ### Properties -* **mountPoint**: string (ReadOnly): Mount point for the share. -* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. -* **roleId**: string (ReadOnly): ID of the role to which share is mounted. -* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) -* **shareId**: string (Required): ID of the share mounted to the role VM. +* **authentication**: [Authentication](#authentication): Authentication mechanism for IoT devices. +* **deviceId**: string (Required): ID of the IoT device/edge device. +* **ioTHostHub**: string (Required): Host name for the IoT hub associated to the device. +* **ioTHostHubId**: string: Id for the IoT hub associated to the device. + +## IoTEdgeAgentInfo +### Properties +* **imageName**: string (Required): Name of the IoT edge agent image. +* **imageRepository**: [ImageRepositoryCredential](#imagerepositorycredential): Image repository credential. +* **tag**: string (Required): Image Tag. -## KubernetesRoleProperties +## IoTRoleProperties ### Properties +* **computeResource**: [ComputeResource](#computeresource): Compute infrastructure Resource * **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. * **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration -* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **ioTDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. +* **ioTEdgeAgentInfo**: [IoTEdgeAgentInfo](#iotedgeagentinfo): IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. +* **ioTEdgeDeviceDetails**: [IoTDeviceInfo](#iotdeviceinfo) (Required): Metadata of IoT device/IoT Edge device to be configured. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status +* **shareMappings**: [MountPointMap](#mountpointmap)[]: Mount points of shares in role(s). ## KubernetesClusterInfo ### Properties @@ -429,30 +388,11 @@ by the already existing properties * **nodes**: [NodeInfo](#nodeinfo)[] (ReadOnly): Kubernetes cluster nodes * **version**: string (Required): Kubernetes cluster version -## EtcdInfo -### Properties -* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. -* **type**: string (ReadOnly): Etcd type -* **version**: string (ReadOnly): Etcd version - -## NodeInfo -### Properties -* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. -* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. -* **name**: string (ReadOnly): Node name. -* **type**: 'ControlPlane' | 'Invalid' | 'ManagementCluster' | 'Master' | 'NodePool' | 'Worker' | string (ReadOnly): Node type - Master/Worker - ## KubernetesIPConfiguration ### Properties * **ipAddress**: string: IP address of the Kubernetes node. * **port**: string (ReadOnly): Port of the Kubernetes node. -## KubernetesRoleResources -### Properties -* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource -* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource -* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource - ## KubernetesRoleCompute ### Properties * **hugePage1G**: int (ReadOnly): Count of huge pages @@ -466,19 +406,20 @@ by the already existing properties * **cniConfig**: [CniConfig](#cniconfig) (ReadOnly): Cni configuration * **loadBalancerConfig**: [LoadBalancerConfig](#loadbalancerconfig) (ReadOnly): Load balancer configuration -## CniConfig +## KubernetesRoleProperties ### Properties -* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. -* **podSubnet**: string (ReadOnly): Pod Subnet -* **serviceSubnet**: string (ReadOnly): Service subnet -* **type**: string (ReadOnly): Cni type -* **version**: string (ReadOnly): Cni version +* **hostPlatform**: 'Linux' | 'Windows' | string (Required): Host OS supported by the Arc addon. +* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. +* **kubernetesClusterInfo**: [KubernetesClusterInfo](#kubernetesclusterinfo) (Required): Kubernetes cluster configuration +* **kubernetesRoleResources**: [KubernetesRoleResources](#kubernetesroleresources) (Required): Kubernetes role resources +* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): State of Kubernetes deployment +* **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## LoadBalancerConfig +## KubernetesRoleResources ### Properties -* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. -* **type**: string (ReadOnly): Load balancer type -* **version**: string (ReadOnly): Load balancer version +* **compute**: [KubernetesRoleCompute](#kubernetesrolecompute) (Required): Kubernetes role compute resource +* **network**: [KubernetesRoleNetwork](#kubernetesrolenetwork) (ReadOnly): Kubernetes role network resource +* **storage**: [KubernetesRoleStorage](#kubernetesrolestorage): Kubernetes role storage resource ## KubernetesRoleStorage ### Properties @@ -491,6 +432,12 @@ by the already existing properties * **posixCompliant**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): If provisioned storage is posix compliant. * **type**: string (ReadOnly): Storage class type. +## LoadBalancerConfig +### Properties +* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. +* **type**: string (ReadOnly): Load balancer type +* **version**: string (ReadOnly): Load balancer version + ## MECRoleProperties ### Properties * **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -498,21 +445,6 @@ by the already existing properties * **resourceUniqueId**: string: Unique Id of the Resource. * **roleStatus**: 'Disabled' | 'Enabled' | string (Required): Local Edge Management Status -## ArcAddonProperties -### Properties -* **hostPlatform**: 'Linux' | 'Windows' | string (ReadOnly): Host OS supported by the Arc addon. -* **hostPlatformType**: 'KubernetesCluster' | 'LinuxVM' | string (ReadOnly): Platform where the runtime is hosted. -* **provisioningState**: 'Created' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Reconfiguring' | 'Updating' | string (ReadOnly): Addon Provisioning State -* **resourceGroupName**: string (Required): Arc resource group name -* **resourceLocation**: string (Required): Arc resource location -* **resourceName**: string (Required): Arc resource Name -* **subscriptionId**: string (Required): Arc resource subscription Id -* **version**: string (ReadOnly): Arc resource version - -## MonitoringMetricConfigurationProperties -### Properties -* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details - ## MetricConfiguration ### Properties * **counterSets**: [MetricCounterSet](#metriccounterset)[] (Required): Host name for the IoT hub associated to the device. @@ -520,10 +452,6 @@ by the already existing properties * **metricNameSpace**: string: The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified * **resourceId**: string (Required): The Resource ID on which the metrics should be pushed. -## MetricCounterSet -### Properties -* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. - ## MetricCounter ### Properties * **additionalDimensions**: [MetricDimension](#metricdimension)[]: The additional dimensions to be added to metric. @@ -531,34 +459,75 @@ by the already existing properties * **instance**: string: The instance from which counter should be collected. * **name**: string (Required): The counter name. +## MetricCounterSet +### Properties +* **counters**: [MetricCounter](#metriccounter)[] (Required): The counters that should be collected in this set. + ## MetricDimension ### Properties * **sourceName**: string (Required): The dimension value. * **sourceType**: string (Required): The dimension type. -## ShareProperties +## MonitoringMetricConfigurationProperties ### Properties -* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. -* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. -* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). -* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. -* **description**: string: Description for the share. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. -* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. -* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. -* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). +* **metricConfigurations**: [MetricConfiguration](#metricconfiguration)[] (Required): The metrics configuration details -## AzureContainerInfo +## MountPointMap ### Properties -* **containerName**: string (Required): Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **storageAccountCredentialId**: string (Required): ID of the storage account credential used to access storage. +* **mountPoint**: string (ReadOnly): Mount point for the share. +* **mountType**: 'HostPath' | 'Volume' | string (ReadOnly): Mounting type. +* **roleId**: string (ReadOnly): ID of the role to which share is mounted. +* **roleType**: 'ASA' | 'CloudEdgeManagement' | 'Cognitive' | 'Functions' | 'IOT' | 'Kubernetes' | 'MEC' | string (ReadOnly) +* **shareId**: string (Required): ID of the share mounted to the role VM. -## ClientAccessRight +## NodeInfo ### Properties -* **accessPermission**: 'NoAccess' | 'ReadOnly' | 'ReadWrite' | string (Required): Type of access to be allowed for the client. -* **client**: string (Required): IP of the client. +* **componentType**: 'CNI' | 'Cluster' | 'Etcd' | 'Invalid' | 'LoadBalancer' | 'Node' | string (ReadOnly): ComponentType of the Kubernetes node. +* **ipConfiguration**: [KubernetesIPConfiguration](#kubernetesipconfiguration)[]: IP Configuration of the Kubernetes node. +* **name**: string (ReadOnly): Node name. +* **type**: 'ControlPlane' | 'Invalid' | 'ManagementCluster' | 'Master' | 'NodePool' | 'Worker' | string (ReadOnly): Node type - Master/Worker + +## OrderProperties +### Properties +* **contactInformation**: [ContactDetails](#contactdetails): Contains all the contact details of the customer. +* **currentStatus**: [OrderStatus](#orderstatus) (ReadOnly): Represents a single status change. +* **deliveryTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package delivered to the customer whether it has an original or a replacement device. +* **orderHistory**: [OrderStatus](#orderstatus)[] (ReadOnly): List of status changes in the order. +* **orderId**: string (ReadOnly): It specify the order resource id. +* **returnTrackingInfo**: [TrackingInfo](#trackinginfo)[] (ReadOnly): Tracking information for the package returned from the customer whether it has an original or a replacement device. +* **serialNumber**: string (ReadOnly): Serial number of the device. +* **shipmentType**: 'NotApplicable' | 'SelfPickup' | 'ShippedToCustomer' | string +* **shippingAddress**: [Address](#address): The shipping address of the customer. + +## OrderStatus +### Properties +* **additionalOrderDetails**: [OrderStatusAdditionalOrderDetails](#orderstatusadditionalorderdetails) (ReadOnly): Dictionary to hold generic information which is not stored +by the already existing properties +* **comments**: string: Comments related to this status change. +* **status**: 'Arriving' | 'AwaitingDrop' | 'AwaitingFulfillment' | 'AwaitingPickup' | 'AwaitingPreparation' | 'AwaitingReturnShipment' | 'AwaitingShipment' | 'CollectedAtMicrosoft' | 'Declined' | 'Delivered' | 'LostDevice' | 'PickupCompleted' | 'ReplacementRequested' | 'ReturnInitiated' | 'Shipped' | 'ShippedBack' | 'Untracked' | string (Required): Status of the order as per the allowed status types. +* **trackingInformation**: [TrackingInfo](#trackinginfo) (ReadOnly): Tracking courier information. +* **updateDateTime**: string (ReadOnly): Time of status update. + +## OrderStatusAdditionalOrderDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PeriodicTimerProperties +### Properties +* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. +* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. +* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. + +## PeriodicTimerSourceInfo +### Properties +* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. +* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. +* **topic**: string: Topic where periodic events are published to IoT device. + +## ProactiveLogCollectionSettingsProperties +### Properties +* **userConsent**: 'Disabled' | 'Enabled' | string (Required): Proactive diagnostic collection consent flag ## RefreshDetails ### Properties @@ -567,10 +536,49 @@ by the already existing properties * **lastCompletedRefreshJobTimeInUTC**: string: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. * **lastJob**: string: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. -## UserAccessRight +## RemoteSupportSettings +### Properties +* **accessLevel**: 'FullAccess' | 'None' | 'ReadOnly' | 'ReadWrite' | string: Access level allowed for this remote application type +* **expirationTimeStampInUTC**: string: Expiration time stamp +* **remoteApplicationType**: 'AllApplications' | 'LocalUI' | 'Powershell' | 'WAC' | string: Remote application type + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): Service Principal Id backing the Msi +* **tenantId**: string (ReadOnly): Home Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity type + +## ResourceMoveDetails +### Properties +* **operationInProgress**: 'None' | 'ResourceMoveFailed' | 'ResourceMoveInProgress' | string: Denotes whether move operation is in progress +* **operationInProgressLockTimeoutInUTC**: string: Denotes the timeout of the operation to finish + +## RoleSinkInfo +### Properties +* **roleId**: string (Required): Compute role ID. + +## ShareAccessRight ### Properties * **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **userId**: string (Required): User ID (already existing in the device). +* **shareId**: string (Required): The share ID. + +## ShareProperties +### Properties +* **accessProtocol**: 'NFS' | 'SMB' | string (Required): Access protocol to be used by the share. +* **azureContainerInfo**: [AzureContainerInfo](#azurecontainerinfo): Azure container mapping of the endpoint. +* **clientAccessRights**: [ClientAccessRight](#clientaccessright)[]: List of IP addresses and corresponding access rights on the share(required for NFS protocol). +* **dataPolicy**: 'Cloud' | 'Local' | string: Data policy of the share. +* **description**: string: Description for the share. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string (Required): Current monitoring status of the share. +* **refreshDetails**: [RefreshDetails](#refreshdetails): Fields for tracking refresh job on the share or container. +* **shareMappings**: [MountPointMap](#mountpointmap)[] (ReadOnly): Share mount point to the role. +* **shareStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (Required): Current status of the share. +* **userAccessRights**: [UserAccessRight](#useraccessright)[]: Mapping of users and corresponding access rights on the share (required for SMB protocol). + +## Sku +### Properties +* **name**: 'EP2_128_1T4_Mx1_W' | 'EP2_128_GPU1_Mx1_W' | 'EP2_256_2T4_W' | 'EP2_256_GPU2_Mx1' | 'EP2_64_1VPU_W' | 'EP2_64_Mx1_W' | 'Edge' | 'EdgeMR_Mini' | 'EdgeMR_TCP' | 'EdgePR_Base' | 'EdgePR_Base_UPS' | 'EdgeP_Base' | 'EdgeP_High' | 'GPU' | 'Gateway' | 'Management' | 'RCA_Large' | 'RCA_Small' | 'RDC' | 'TCA_Large' | 'TCA_Small' | 'TDC' | 'TEA_1Node' | 'TEA_1Node_Heater' | 'TEA_1Node_UPS' | 'TEA_1Node_UPS_Heater' | 'TEA_4Node_Heater' | 'TEA_4Node_UPS_Heater' | 'TMA' | string: The Sku name. +* **tier**: 'Standard' | string: The Sku tier. ## StorageAccountCredentialProperties ### Properties @@ -592,38 +600,43 @@ by the already existing properties * **storageAccountCredentialId**: string: Storage Account Credential Id * **storageAccountStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string: Current status of the storage account -## ContainerProperties +## SubscriptionProperties ### Properties -* **containerStatus**: 'NeedsAttention' | 'OK' | 'Offline' | 'Unknown' | 'Updating' | string (ReadOnly): Current status of the container. -* **createdDateTime**: string (ReadOnly): The UTC time when container got created. -* **dataFormat**: 'AzureFile' | 'BlockBlob' | 'PageBlob' | string (Required): Storage format used for the file represented by the share. -* **refreshDetails**: [RefreshDetails](#refreshdetails) (ReadOnly): Fields for tracking refresh job on the share or container. +* **locationPlacementId**: string +* **quotaId**: string +* **registeredFeatures**: [SubscriptionRegisteredFeatures](#subscriptionregisteredfeatures)[]: Array of SubscriptionRegisteredFeatures +* **serializedDetails**: string +* **tenantId**: string -## FileTriggerProperties +## SubscriptionRegisteredFeatures ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [FileSourceInfo](#filesourceinfo) (Required): File source details. +* **name**: string +* **state**: string -## RoleSinkInfo +## SymmetricKey ### Properties -* **roleId**: string (Required): Compute role ID. +* **connectionString**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -## FileSourceInfo +## SystemData ### Properties -* **shareId**: string (Required): File share ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PeriodicTimerProperties +## TrackingInfo ### Properties -* **customContextTag**: string: A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module. -* **sinkInfo**: [RoleSinkInfo](#rolesinkinfo) (Required): Compute role against which events will be raised. -* **sourceInfo**: [PeriodicTimerSourceInfo](#periodictimersourceinfo) (Required): Periodic timer event source. +* **carrierName**: string: Name of the carrier used in the delivery. +* **serialNumber**: string: Serial number of the device being tracked. +* **trackingId**: string: Tracking ID of the shipment. +* **trackingUrl**: string: Tracking URL of the shipment. -## PeriodicTimerSourceInfo +## UserAccessRight ### Properties -* **schedule**: string (Required): Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. -* **startTime**: string (Required): The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. -* **topic**: string: Topic where periodic events are published to IoT device. +* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. +* **userId**: string (Required): User ID (already existing in the device). ## UserProperties ### Properties @@ -631,16 +644,3 @@ by the already existing properties * **shareAccessRights**: [ShareAccessRight](#shareaccessright)[] (ReadOnly): List of shares that the user has rights on. This field should not be specified during user creation. * **userType**: 'ARM' | 'LocalManagement' | 'Share' | string (Required): Type of the user. -## ShareAccessRight -### Properties -* **accessType**: 'Change' | 'Custom' | 'Read' | string (Required): Type of access to be allowed on the share for this user. -* **shareId**: string (Required): The share ID. - -## DCAccessCode -### Properties -* **properties**: [DCAccessCodeProperties](#dcaccesscodeproperties) (ReadOnly): DCAccessCode Properties. - -## DCAccessCodeProperties -### Properties -* **authCode**: string (ReadOnly): DCAccess Code for the Self Managed shipment. - diff --git a/generated/databricks/log.out b/generated/databricks/log.out index 011b9d8d7a..d2bca408da 100644 --- a/generated/databricks/log.out +++ b/generated/databricks/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.databricks-2018-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Workspace' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json:366:5 @@ -60,12 +60,12 @@ warning | PreCheck/SchemaMissingType | The schema 'AddressSpace' with an undefin - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json:436:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.databricks-2021-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Workspace' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/databricks.json:701:5 @@ -125,4 +125,4 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'GroupIdInformation' ha warning | PreCheck/PropertyRedeclarationWarning | Schema 'GroupIdInformation' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from GroupIdInformation warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 5ms -info | Autorest completed in 7.36s. 4 files generated. +info | Autorest completed in 7.4s. 4 files generated. diff --git a/generated/databricks/microsoft.databricks/2018-04-01/types.md b/generated/databricks/microsoft.databricks/2018-04-01/types.md index a92e224c95..d6f6c8c2b0 100644 --- a/generated/databricks/microsoft.databricks/2018-04-01/types.md +++ b/generated/databricks/microsoft.databricks/2018-04-01/types.md @@ -21,24 +21,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) (Required): Properties of the virtual network peering. * **type**: 'Microsoft.Databricks/workspaces/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## WorkspaceProperties -### Properties -* **authorizations**: [WorkspaceProviderAuthorization](#workspaceproviderauthorization)[]: The workspace provider authorizations. -* **createdBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. -* **createdDateTime**: string (ReadOnly): The date and time stamp when the workspace was created. -* **managedResourceGroupId**: string (Required): The managed resource group Id. -* **parameters**: [WorkspaceCustomParameters](#workspacecustomparameters): Custom Parameters used for Cluster Creation. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the workspace. -* **storageAccountIdentity**: [ManagedIdentityConfiguration](#managedidentityconfiguration): The Managed Identity details for storage account. -* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. -* **updatedBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. -* **workspaceId**: string (ReadOnly): The unique identifier of the databricks workspace in databricks control plane. -* **workspaceUrl**: string (ReadOnly): The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' - -## WorkspaceProviderAuthorization +## AddressSpace ### Properties -* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. -* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## CreatedBy ### Properties @@ -46,40 +31,6 @@ * **oid**: string (ReadOnly): The Object ID that created the workspace. * **puid**: string (ReadOnly): The Personal Object ID corresponding to the object ID above -## WorkspaceCustomParameters -### Properties -* **amlWorkspaceId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **customPrivateSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **customPublicSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **customVirtualNetworkId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **enableNoPublicIp**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. -* **encryption**: [WorkspaceEncryptionParameter](#workspaceencryptionparameter): The object that contains details of encryption used on the workspace. -* **loadBalancerBackendPoolName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **loadBalancerId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **natGatewayName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **prepareEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. -* **publicIpName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **requireInfrastructureEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. -* **resourceTags**: [WorkspaceCustomObjectParameter](#workspacecustomobjectparameter) (ReadOnly): The value which should be used for this field. -* **storageAccountName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **storageAccountSkuName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **vnetAddressPrefix**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. - -## WorkspaceCustomStringParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: string (Required): The value which should be used for this field. - -## WorkspaceCustomBooleanParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: bool (Required): The value which should be used for this field. - -## WorkspaceEncryptionParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: [Encryption](#encryption): The object that contains details of encryption used on the workspace. - ## Encryption ### Properties * **KeyName**: string: The name of KeyVault key. @@ -87,11 +38,6 @@ * **keyvaulturi**: string: The Uri of KeyVault. * **keyversion**: string: The version of KeyVault key. -## WorkspaceCustomObjectParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: any (Required): Any object - ## ManagedIdentityConfiguration ### Properties * **principalId**: string (ReadOnly): The objectId of the Managed Identity that is linked to the Managed Storage account. @@ -121,10 +67,6 @@ * **remoteVirtualNetwork**: [VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork](#virtualnetworkpeeringpropertiesformatremotevirtualnetwork) (Required): The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). * **useRemoteGateways**: bool: 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. -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - ## VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork ### Properties * **id**: string: The Id of the databricks virtual network. @@ -133,3 +75,61 @@ ### Properties * **id**: string: The Id of the remote virtual network. +## WorkspaceCustomBooleanParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: bool (Required): The value which should be used for this field. + +## WorkspaceCustomObjectParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: any (Required): Any object + +## WorkspaceCustomParameters +### Properties +* **amlWorkspaceId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **customPrivateSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **customPublicSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **customVirtualNetworkId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **enableNoPublicIp**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. +* **encryption**: [WorkspaceEncryptionParameter](#workspaceencryptionparameter): The object that contains details of encryption used on the workspace. +* **loadBalancerBackendPoolName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **loadBalancerId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **natGatewayName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **prepareEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. +* **publicIpName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **requireInfrastructureEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. +* **resourceTags**: [WorkspaceCustomObjectParameter](#workspacecustomobjectparameter) (ReadOnly): The value which should be used for this field. +* **storageAccountName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **storageAccountSkuName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **vnetAddressPrefix**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. + +## WorkspaceCustomStringParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: string (Required): The value which should be used for this field. + +## WorkspaceEncryptionParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: [Encryption](#encryption): The object that contains details of encryption used on the workspace. + +## WorkspaceProperties +### Properties +* **authorizations**: [WorkspaceProviderAuthorization](#workspaceproviderauthorization)[]: The workspace provider authorizations. +* **createdBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. +* **createdDateTime**: string (ReadOnly): The date and time stamp when the workspace was created. +* **managedResourceGroupId**: string (Required): The managed resource group Id. +* **parameters**: [WorkspaceCustomParameters](#workspacecustomparameters): Custom Parameters used for Cluster Creation. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the workspace. +* **storageAccountIdentity**: [ManagedIdentityConfiguration](#managedidentityconfiguration): The Managed Identity details for storage account. +* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. +* **updatedBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. +* **workspaceId**: string (ReadOnly): The unique identifier of the databricks workspace in databricks control plane. +* **workspaceUrl**: string (ReadOnly): The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' + +## WorkspaceProviderAuthorization +### Properties +* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. +* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. + diff --git a/generated/databricks/microsoft.databricks/2021-04-01-preview/types.md b/generated/databricks/microsoft.databricks/2021-04-01-preview/types.md index 11444bb5d6..7022ea4ad0 100644 --- a/generated/databricks/microsoft.databricks/2021-04-01-preview/types.md +++ b/generated/databricks/microsoft.databricks/2021-04-01-preview/types.md @@ -31,28 +31,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) (Required): Properties of the virtual network peering. * **type**: 'Microsoft.Databricks/workspaces/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## WorkspaceProperties -### Properties -* **authorizations**: [WorkspaceProviderAuthorization](#workspaceproviderauthorization)[]: The workspace provider authorizations. -* **createdBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. -* **createdDateTime**: string (ReadOnly): The date and time stamp when the workspace was created. -* **encryption**: [WorkspacePropertiesEncryption](#workspacepropertiesencryption): Encryption properties for databricks workspace -* **managedResourceGroupId**: string (Required): The managed resource group Id. -* **parameters**: [WorkspaceCustomParameters](#workspacecustomparameters): Custom Parameters used for Cluster Creation. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections created on the workspace -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the workspace. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. -* **requiredNsgRules**: 'AllRules' | 'NoAzureDatabricksRules' | 'NoAzureServiceRules' | string: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. -* **storageAccountIdentity**: [ManagedIdentityConfiguration](#managedidentityconfiguration): The Managed Identity details for storage account. -* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. -* **updatedBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. -* **workspaceId**: string (ReadOnly): The unique identifier of the databricks workspace in databricks control plane. -* **workspaceUrl**: string (ReadOnly): The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' - -## WorkspaceProviderAuthorization +## AddressSpace ### Properties -* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. -* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## CreatedBy ### Properties @@ -60,9 +41,12 @@ * **oid**: string (ReadOnly): The Object ID that created the workspace. * **puid**: string (ReadOnly): The Personal Object ID corresponding to the object ID above -## WorkspacePropertiesEncryption +## Encryption ### Properties -* **entities**: [EncryptionEntitiesDefinition](#encryptionentitiesdefinition) (Required): Encryption entities for databricks workspace resource. +* **KeyName**: string: The name of KeyVault key. +* **keySource**: 'Default' | 'Microsoft.Keyvault' | string: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. ## EncryptionEntitiesDefinition ### Properties @@ -79,51 +63,15 @@ * **keyVaultUri**: string (Required): The Uri of KeyVault. * **keyVersion**: string (Required): The version of KeyVault key. -## WorkspaceCustomParameters -### Properties -* **amlWorkspaceId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **customPrivateSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **customPublicSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **customVirtualNetworkId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **enableNoPublicIp**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. -* **encryption**: [WorkspaceEncryptionParameter](#workspaceencryptionparameter): The object that contains details of encryption used on the workspace. -* **loadBalancerBackendPoolName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **loadBalancerId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **natGatewayName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **prepareEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. -* **publicIpName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **requireInfrastructureEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. -* **resourceTags**: [WorkspaceCustomObjectParameter](#workspacecustomobjectparameter) (ReadOnly): The value which should be used for this field. -* **storageAccountName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **storageAccountSkuName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. -* **vnetAddressPrefix**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. - -## WorkspaceCustomStringParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: string (Required): The value which should be used for this field. - -## WorkspaceCustomBooleanParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: bool (Required): The value which should be used for this field. - -## WorkspaceEncryptionParameter -### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: [Encryption](#encryption): The object that contains details of encryption used on the workspace. - -## Encryption +## ManagedIdentityConfiguration ### Properties -* **KeyName**: string: The name of KeyVault key. -* **keySource**: 'Default' | 'Microsoft.Keyvault' | string: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **principalId**: string (ReadOnly): The objectId of the Managed Identity that is linked to the Managed Storage account. +* **tenantId**: string (ReadOnly): The tenant Id where the Managed Identity is created. +* **type**: string (ReadOnly): The type of Identity created. It can be either SystemAssigned or UserAssigned. -## WorkspaceCustomObjectParameter +## PrivateEndpoint ### Properties -* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. -* **value**: any (Required): Any object +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -138,22 +86,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionRequired**: string: Actions required for a private endpoint connection * **description**: string: The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## ManagedIdentityConfiguration -### Properties -* **principalId**: string (ReadOnly): The objectId of the Managed Identity that is linked to the Managed Storage account. -* **tenantId**: string (ReadOnly): The tenant Id where the Managed Identity is created. -* **type**: string (ReadOnly): The type of Identity created. It can be either SystemAssigned or UserAssigned. - ## Sku ### Properties * **name**: string (Required): The SKU name. @@ -186,10 +124,6 @@ * **remoteVirtualNetwork**: [VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork](#virtualnetworkpeeringpropertiesformatremotevirtualnetwork) (Required): The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). * **useRemoteGateways**: bool: 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. -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - ## VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork ### Properties * **id**: string: The Id of the databricks virtual network. @@ -198,3 +132,69 @@ ### Properties * **id**: string: The Id of the remote virtual network. +## WorkspaceCustomBooleanParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: bool (Required): The value which should be used for this field. + +## WorkspaceCustomObjectParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: any (Required): Any object + +## WorkspaceCustomParameters +### Properties +* **amlWorkspaceId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **customPrivateSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **customPublicSubnetName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **customVirtualNetworkId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **enableNoPublicIp**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. +* **encryption**: [WorkspaceEncryptionParameter](#workspaceencryptionparameter): The object that contains details of encryption used on the workspace. +* **loadBalancerBackendPoolName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **loadBalancerId**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **natGatewayName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **prepareEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. +* **publicIpName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **requireInfrastructureEncryption**: [WorkspaceCustomBooleanParameter](#workspacecustombooleanparameter): The value which should be used for this field. +* **resourceTags**: [WorkspaceCustomObjectParameter](#workspacecustomobjectparameter) (ReadOnly): The value which should be used for this field. +* **storageAccountName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **storageAccountSkuName**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. +* **vnetAddressPrefix**: [WorkspaceCustomStringParameter](#workspacecustomstringparameter): The Value. + +## WorkspaceCustomStringParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: string (Required): The value which should be used for this field. + +## WorkspaceEncryptionParameter +### Properties +* **type**: 'Bool' | 'Object' | 'String' | string (ReadOnly): Provisioning status of the workspace. +* **value**: [Encryption](#encryption): The object that contains details of encryption used on the workspace. + +## WorkspaceProperties +### Properties +* **authorizations**: [WorkspaceProviderAuthorization](#workspaceproviderauthorization)[]: The workspace provider authorizations. +* **createdBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. +* **createdDateTime**: string (ReadOnly): The date and time stamp when the workspace was created. +* **encryption**: [WorkspacePropertiesEncryption](#workspacepropertiesencryption): Encryption properties for databricks workspace +* **managedResourceGroupId**: string (Required): The managed resource group Id. +* **parameters**: [WorkspaceCustomParameters](#workspacecustomparameters): Custom Parameters used for Cluster Creation. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections created on the workspace +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the workspace. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. +* **requiredNsgRules**: 'AllRules' | 'NoAzureDatabricksRules' | 'NoAzureServiceRules' | string: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. +* **storageAccountIdentity**: [ManagedIdentityConfiguration](#managedidentityconfiguration): The Managed Identity details for storage account. +* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. +* **updatedBy**: [CreatedBy](#createdby): Provides details of the entity that created/updated the workspace. +* **workspaceId**: string (ReadOnly): The unique identifier of the databricks workspace in databricks control plane. +* **workspaceUrl**: string (ReadOnly): The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' + +## WorkspacePropertiesEncryption +### Properties +* **entities**: [EncryptionEntitiesDefinition](#encryptionentitiesdefinition) (Required): Encryption entities for databricks workspace resource. + +## WorkspaceProviderAuthorization +### Properties +* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. +* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. + diff --git a/generated/datacatalog/log.out b/generated/datacatalog/log.out index d171571658..eafd856389 100644 --- a/generated/datacatalog/log.out +++ b/generated/datacatalog/log.out @@ -6,13 +6,13 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datacatalog-2016-03-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ADCCatalogsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json:263:5 @@ -25,5 +25,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ADCCatalogProperties' with an warning | PreCheck/SchemaMissingType | The schema 'Principals' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json:379:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 8ms info | Autorest completed in 4.36s. 2 files generated. diff --git a/generated/datadog/log.out b/generated/datadog/log.out index 3ec32be531..02b84fa313 100644 --- a/generated/datadog/log.out +++ b/generated/datadog/log.out @@ -3,17 +3,17 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datadog-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 16ms +info | autorest.bicep took 21ms info | Processing batch task - {"tag":"microsoft.datadog-2020-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms -info | Autorest completed in 7.3s. 4 files generated. +info | Autorest completed in 7.09s. 4 files generated. diff --git a/generated/datadog/microsoft.datadog/2020-02-01-preview/types.md b/generated/datadog/microsoft.datadog/2020-02-01-preview/types.md index 9384523b5d..81b647ba53 100644 --- a/generated/datadog/microsoft.datadog/2020-02-01-preview/types.md +++ b/generated/datadog/microsoft.datadog/2020-02-01-preview/types.md @@ -71,48 +71,62 @@ * **retrieveDatetime**: string: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. * **signature**: string: Terms signature. -## IdentityProperties +## DatadogApiKey ### Properties -* **principalId**: string (ReadOnly): The identity ID. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **created**: string (ReadOnly): The time of creation of the API key. +* **createdBy**: string (ReadOnly): The user that created the API key. +* **key**: string (ReadOnly): The value of the API key. +* **name**: string (ReadOnly): The name of the API key. -## MonitorProperties +## DatadogApiKeyListResponse ### Properties -* **datadogOrganizationProperties**: [DatadogOrganizationProperties](#datadogorganizationproperties): Datadog organization properties -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **marketplaceSubscriptionStatus**: 'Active' | 'Provisioning' | 'Suspended' | 'Unsubscribed' | string (ReadOnly): Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) -* **userInfo**: [UserInfo](#userinfo): User info +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [DatadogApiKey](#datadogapikey)[] (ReadOnly): Results of a list operation. -## DatadogOrganizationProperties +## DatadogHost ### Properties -* **apiKey**: string (WriteOnly): Api key associated to the Datadog organization. -* **applicationKey**: string (WriteOnly): Application key associated to the Datadog organization. -* **enterpriseAppId**: string (WriteOnly): The Id of the Enterprise App used for Single sign on. -* **id**: string (ReadOnly): Id of the Datadog organization. -* **linkingAuthCode**: string (WriteOnly): The auth code used to linking to an existing datadog organization. -* **linkingClientId**: string (WriteOnly): The client_id from an existing in exchange for an auth token to link organization. -* **name**: string (ReadOnly): Name of the Datadog organization. -* **redirectUri**: string (WriteOnly): The redirect uri for linking. +* **aliases**: string[] (ReadOnly): The aliases for the host. +* **apps**: string[] (ReadOnly): The Datadog integrations reporting metrics for the host. +* **meta**: [DatadogHostMetadata](#datadoghostmetadata) (ReadOnly) +* **name**: string (ReadOnly): The name of the host. -## UserInfo +## DatadogHostListResponse ### Properties -* **emailAddress**: string: Email of the user used by Datadog for contacting them if needed -* **name**: string: Name of the user -* **phoneNumber**: string: Phone number of the user used by Datadog for contacting them if needed +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [DatadogHost](#datadoghost)[] (ReadOnly): Results of a list operation. -## ResourceSku +## DatadogHostMetadata ### Properties -* **name**: string (Required): Name of the SKU. +* **agentVersion**: string (ReadOnly): The agent version. +* **installMethod**: [DatadogInstallMethod](#datadoginstallmethod) (ReadOnly) +* **logsAgent**: [DatadogLogsAgent](#datadoglogsagent) (ReadOnly) + +## DatadogInstallMethod +### Properties +* **installerVersion**: string (ReadOnly): The installer version. +* **tool**: string (ReadOnly): The tool. +* **toolVersion**: string (ReadOnly): The tool version. + +## DatadogLogsAgent +### Properties +* **transport**: string (ReadOnly): The transport. ## DatadogMonitorResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## DatadogOrganizationProperties +### Properties +* **apiKey**: string (WriteOnly): Api key associated to the Datadog organization. +* **applicationKey**: string (WriteOnly): Application key associated to the Datadog organization. +* **enterpriseAppId**: string (WriteOnly): The Id of the Enterprise App used for Single sign on. +* **id**: string (ReadOnly): Id of the Datadog organization. +* **linkingAuthCode**: string (WriteOnly): The auth code used to linking to an existing datadog organization. +* **linkingClientId**: string (WriteOnly): The client_id from an existing in exchange for an auth token to link organization. +* **name**: string (ReadOnly): Name of the Datadog organization. +* **redirectUri**: string (WriteOnly): The redirect uri for linking. + ## DatadogSingleSignOnProperties ### Properties * **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign-on. @@ -120,88 +134,74 @@ * **singleSignOnState**: 'Disable' | 'Enable' | 'Existing' | 'Initial' | string: Various states of the SSO resource * **singleSignOnUrl**: string (ReadOnly): The login URL specific to this Datadog Organization. -## MonitoringTagRulesProperties -### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **metricRules**: [MetricRules](#metricrules): Set of rules for sending metrics for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) - -## LogRules -### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. -* **sendResourceLogs**: bool: Flag specifying if Azure resource logs should be sent for the Monitor resource. -* **sendSubscriptionLogs**: bool: Flag specifying if Azure subscription logs should be sent for the Monitor resource. - ## FilteringTag ### Properties * **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. * **name**: string: The name (also known as the key) of the tag. * **value**: string: The value of the tag. -## MetricRules -### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. - -## DatadogApiKeyListResponse +## IdentityProperties ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [DatadogApiKey](#datadogapikey)[] (ReadOnly): Results of a list operation. +* **principalId**: string (ReadOnly): The identity ID. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' | 'UserAssigned' | string: Identity type -## DatadogApiKey +## LinkedResource ### Properties -* **created**: string (ReadOnly): The time of creation of the API key. -* **createdBy**: string (ReadOnly): The user that created the API key. -* **key**: string (ReadOnly): The value of the API key. -* **name**: string (ReadOnly): The name of the API key. +* **id**: string (ReadOnly): The ARM id of the linked resource. -## DatadogHostListResponse +## LinkedResourceListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [DatadogHost](#datadoghost)[] (ReadOnly): Results of a list operation. +* **value**: [LinkedResource](#linkedresource)[] (ReadOnly): Results of a list operation. -## DatadogHost +## LogRules ### Properties -* **aliases**: string[] (ReadOnly): The aliases for the host. -* **apps**: string[] (ReadOnly): The Datadog integrations reporting metrics for the host. -* **meta**: [DatadogHostMetadata](#datadoghostmetadata) (ReadOnly) -* **name**: string (ReadOnly): The name of the host. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. +* **sendResourceLogs**: bool: Flag specifying if Azure resource logs should be sent for the Monitor resource. +* **sendSubscriptionLogs**: bool: Flag specifying if Azure subscription logs should be sent for the Monitor resource. -## DatadogHostMetadata +## MetricRules ### Properties -* **agentVersion**: string (ReadOnly): The agent version. -* **installMethod**: [DatadogInstallMethod](#datadoginstallmethod) (ReadOnly) -* **logsAgent**: [DatadogLogsAgent](#datadoglogsagent) (ReadOnly) +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -## DatadogInstallMethod +## MonitoredResource ### Properties -* **installerVersion**: string (ReadOnly): The installer version. -* **tool**: string (ReadOnly): The tool. -* **toolVersion**: string (ReadOnly): The tool version. +* **id**: string (ReadOnly): The ARM id of the resource. +* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). +* **reasonForMetricsStatus**: string (ReadOnly): Reason for why the resource is sending metrics (or why it is not sending). +* **sendingLogs**: bool (ReadOnly): Flag indicating if resource is sending logs to Datadog. +* **sendingMetrics**: bool (ReadOnly): Flag indicating if resource is sending metrics to Datadog. -## DatadogLogsAgent +## MonitoredResourceListResponse ### Properties -* **transport**: string (ReadOnly): The transport. +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## LinkedResourceListResponse +## MonitoringTagRulesProperties ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [LinkedResource](#linkedresource)[] (ReadOnly): Results of a list operation. +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **metricRules**: [MetricRules](#metricrules): Set of rules for sending metrics for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) -## LinkedResource +## MonitorProperties ### Properties -* **id**: string (ReadOnly): The ARM id of the linked resource. +* **datadogOrganizationProperties**: [DatadogOrganizationProperties](#datadogorganizationproperties): Datadog organization properties +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **marketplaceSubscriptionStatus**: 'Active' | 'Provisioning' | 'Suspended' | 'Unsubscribed' | string (ReadOnly): Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) +* **userInfo**: [UserInfo](#userinfo): User info -## MonitoredResourceListResponse +## ResourceSku ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. +* **name**: string (Required): Name of the SKU. -## MonitoredResource +## UserInfo ### Properties -* **id**: string (ReadOnly): The ARM id of the resource. -* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). -* **reasonForMetricsStatus**: string (ReadOnly): Reason for why the resource is sending metrics (or why it is not sending). -* **sendingLogs**: bool (ReadOnly): Flag indicating if resource is sending logs to Datadog. -* **sendingMetrics**: bool (ReadOnly): Flag indicating if resource is sending metrics to Datadog. +* **emailAddress**: string: Email of the user used by Datadog for contacting them if needed +* **name**: string: Name of the user +* **phoneNumber**: string: Phone number of the user used by Datadog for contacting them if needed diff --git a/generated/datadog/microsoft.datadog/2021-03-01/types.md b/generated/datadog/microsoft.datadog/2021-03-01/types.md index d6d387c8c7..497d5d308b 100644 --- a/generated/datadog/microsoft.datadog/2021-03-01/types.md +++ b/generated/datadog/microsoft.datadog/2021-03-01/types.md @@ -75,57 +75,62 @@ * **retrieveDatetime**: string: Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. * **signature**: string: Terms signature. -## SystemData +## DatadogApiKey ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **created**: string (ReadOnly): The time of creation of the API key. +* **createdBy**: string (ReadOnly): The user that created the API key. +* **key**: string (ReadOnly): The value of the API key. +* **name**: string (ReadOnly): The name of the API key. -## IdentityProperties +## DatadogApiKeyListResponse ### Properties -* **principalId**: string (ReadOnly): The identity ID. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' | 'UserAssigned' | string: Identity type +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [DatadogApiKey](#datadogapikey)[] (ReadOnly): Results of a list operation. -## MonitorProperties +## DatadogHost ### Properties -* **datadogOrganizationProperties**: [DatadogOrganizationProperties](#datadogorganizationproperties): Datadog organization properties -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **marketplaceSubscriptionStatus**: 'Active' | 'Provisioning' | 'Suspended' | 'Unsubscribed' | string (ReadOnly): Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) -* **userInfo**: [UserInfo](#userinfo): User info +* **aliases**: string[] (ReadOnly): The aliases for the host. +* **apps**: string[] (ReadOnly): The Datadog integrations reporting metrics for the host. +* **meta**: [DatadogHostMetadata](#datadoghostmetadata) (ReadOnly) +* **name**: string (ReadOnly): The name of the host. -## DatadogOrganizationProperties +## DatadogHostListResponse ### Properties -* **apiKey**: string (WriteOnly): Api key associated to the Datadog organization. -* **applicationKey**: string (WriteOnly): Application key associated to the Datadog organization. -* **enterpriseAppId**: string (WriteOnly): The Id of the Enterprise App used for Single sign on. -* **id**: string (ReadOnly): Id of the Datadog organization. -* **linkingAuthCode**: string (WriteOnly): The auth code used to linking to an existing datadog organization. -* **linkingClientId**: string (WriteOnly): The client_id from an existing in exchange for an auth token to link organization. -* **name**: string (ReadOnly): Name of the Datadog organization. -* **redirectUri**: string (WriteOnly): The redirect uri for linking. +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [DatadogHost](#datadoghost)[] (ReadOnly): Results of a list operation. -## UserInfo +## DatadogHostMetadata ### Properties -* **emailAddress**: string: Email of the user used by Datadog for contacting them if needed -* **name**: string: Name of the user -* **phoneNumber**: string: Phone number of the user used by Datadog for contacting them if needed +* **agentVersion**: string (ReadOnly): The agent version. +* **installMethod**: [DatadogInstallMethod](#datadoginstallmethod) (ReadOnly) +* **logsAgent**: [DatadogLogsAgent](#datadoglogsagent) (ReadOnly) -## ResourceSku +## DatadogInstallMethod ### Properties -* **name**: string (Required): Name of the SKU. +* **installerVersion**: string (ReadOnly): The installer version. +* **tool**: string (ReadOnly): The tool. +* **toolVersion**: string (ReadOnly): The tool version. + +## DatadogLogsAgent +### Properties +* **transport**: string (ReadOnly): The transport. ## DatadogMonitorResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## DatadogOrganizationProperties +### Properties +* **apiKey**: string (WriteOnly): Api key associated to the Datadog organization. +* **applicationKey**: string (WriteOnly): Application key associated to the Datadog organization. +* **enterpriseAppId**: string (WriteOnly): The Id of the Enterprise App used for Single sign on. +* **id**: string (ReadOnly): Id of the Datadog organization. +* **linkingAuthCode**: string (WriteOnly): The auth code used to linking to an existing datadog organization. +* **linkingClientId**: string (WriteOnly): The client_id from an existing in exchange for an auth token to link organization. +* **name**: string (ReadOnly): Name of the Datadog organization. +* **redirectUri**: string (WriteOnly): The redirect uri for linking. + ## DatadogSingleSignOnProperties ### Properties * **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign-on. @@ -133,88 +138,83 @@ * **singleSignOnState**: 'Disable' | 'Enable' | 'Existing' | 'Initial' | string: Various states of the SSO resource * **singleSignOnUrl**: string (ReadOnly): The login URL specific to this Datadog Organization. -## MonitoringTagRulesProperties -### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **metricRules**: [MetricRules](#metricrules): Set of rules for sending metrics for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) - -## LogRules -### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. -* **sendResourceLogs**: bool: Flag specifying if Azure resource logs should be sent for the Monitor resource. -* **sendSubscriptionLogs**: bool: Flag specifying if Azure subscription logs should be sent for the Monitor resource. - ## FilteringTag ### Properties * **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. * **name**: string: The name (also known as the key) of the tag. * **value**: string: The value of the tag. -## MetricRules +## IdentityProperties ### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **principalId**: string (ReadOnly): The identity ID. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' | 'UserAssigned' | string: Identity type -## DatadogApiKeyListResponse +## LinkedResource ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [DatadogApiKey](#datadogapikey)[] (ReadOnly): Results of a list operation. +* **id**: string (ReadOnly): The ARM id of the linked resource. -## DatadogApiKey +## LinkedResourceListResponse ### Properties -* **created**: string (ReadOnly): The time of creation of the API key. -* **createdBy**: string (ReadOnly): The user that created the API key. -* **key**: string (ReadOnly): The value of the API key. -* **name**: string (ReadOnly): The name of the API key. +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [LinkedResource](#linkedresource)[] (ReadOnly): Results of a list operation. -## DatadogHostListResponse +## LogRules ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [DatadogHost](#datadoghost)[] (ReadOnly): Results of a list operation. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. +* **sendResourceLogs**: bool: Flag specifying if Azure resource logs should be sent for the Monitor resource. +* **sendSubscriptionLogs**: bool: Flag specifying if Azure subscription logs should be sent for the Monitor resource. -## DatadogHost +## MetricRules ### Properties -* **aliases**: string[] (ReadOnly): The aliases for the host. -* **apps**: string[] (ReadOnly): The Datadog integrations reporting metrics for the host. -* **meta**: [DatadogHostMetadata](#datadoghostmetadata) (ReadOnly) -* **name**: string (ReadOnly): The name of the host. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -## DatadogHostMetadata +## MonitoredResource ### Properties -* **agentVersion**: string (ReadOnly): The agent version. -* **installMethod**: [DatadogInstallMethod](#datadoginstallmethod) (ReadOnly) -* **logsAgent**: [DatadogLogsAgent](#datadoglogsagent) (ReadOnly) +* **id**: string (ReadOnly): The ARM id of the resource. +* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). +* **reasonForMetricsStatus**: string (ReadOnly): Reason for why the resource is sending metrics (or why it is not sending). +* **sendingLogs**: bool (ReadOnly): Flag indicating if resource is sending logs to Datadog. +* **sendingMetrics**: bool (ReadOnly): Flag indicating if resource is sending metrics to Datadog. -## DatadogInstallMethod +## MonitoredResourceListResponse ### Properties -* **installerVersion**: string (ReadOnly): The installer version. -* **tool**: string (ReadOnly): The tool. -* **toolVersion**: string (ReadOnly): The tool version. +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## DatadogLogsAgent +## MonitoringTagRulesProperties ### Properties -* **transport**: string (ReadOnly): The transport. +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **metricRules**: [MetricRules](#metricrules): Set of rules for sending metrics for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) -## LinkedResourceListResponse +## MonitorProperties ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [LinkedResource](#linkedresource)[] (ReadOnly): Results of a list operation. +* **datadogOrganizationProperties**: [DatadogOrganizationProperties](#datadogorganizationproperties): Datadog organization properties +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **marketplaceSubscriptionStatus**: 'Active' | 'Provisioning' | 'Suspended' | 'Unsubscribed' | string (ReadOnly): Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly) +* **userInfo**: [UserInfo](#userinfo): User info -## LinkedResource +## ResourceSku ### Properties -* **id**: string (ReadOnly): The ARM id of the linked resource. +* **name**: string (Required): Name of the SKU. -## MonitoredResourceListResponse +## SystemData ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## MonitoredResource +## UserInfo ### Properties -* **id**: string (ReadOnly): The ARM id of the resource. -* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). -* **reasonForMetricsStatus**: string (ReadOnly): Reason for why the resource is sending metrics (or why it is not sending). -* **sendingLogs**: bool (ReadOnly): Flag indicating if resource is sending logs to Datadog. -* **sendingMetrics**: bool (ReadOnly): Flag indicating if resource is sending metrics to Datadog. +* **emailAddress**: string: Email of the user used by Datadog for contacting them if needed +* **name**: string: Name of the user +* **phoneNumber**: string: Phone number of the user used by Datadog for contacting them if needed diff --git a/generated/datafactory/log.out b/generated/datafactory/log.out index fe382832ef..1a51e7b543 100644 --- a/generated/datafactory/log.out +++ b/generated/datafactory/log.out @@ -11,7 +11,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datafactory-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -22,7 +22,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json:4370:5 @@ -2064,7 +2064,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 311ms +info | autorest.bicep took 188ms info | Processing batch task - {"tag":"microsoft.datafactory-2017-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2075,7 +2075,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json:2452:5 @@ -2751,5 +2751,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 99ms -info | Autorest completed in 31.33s. 4 files generated. +info | autorest.bicep took 75ms +info | Autorest completed in 30.32s. 4 files generated. diff --git a/generated/datafactory/microsoft.datafactory/2017-09-01-preview/types.md b/generated/datafactory/microsoft.datafactory/2017-09-01-preview/types.md index 28598f4700..920ae656c1 100644 --- a/generated/datafactory/microsoft.datafactory/2017-09-01-preview/types.md +++ b/generated/datafactory/microsoft.datafactory/2017-09-01-preview/types.md @@ -67,358 +67,318 @@ * **ApiVersion**: 2017-09-01-preview * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## FactoryIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'SystemAssigned' (Required): The identity type. Currently the only supported type is 'SystemAssigned'. - -## FactoryProperties -### Properties -* **createTime**: string (ReadOnly): Time the factory was created in ISO8601 format. -* **provisioningState**: string (ReadOnly): Factory provisioning state, example Succeeded. -* **version**: string (ReadOnly): Version of the factory. -* **vstsConfiguration**: [FactoryVstsConfiguration](#factoryvstsconfiguration): Factory's VSTS repo information. - -## FactoryVstsConfiguration -### Properties -* **accountName**: string: VSTS account name. -* **collaborationBranch**: string: VSTS collaboration branch. -* **lastCommitId**: string: VSTS last commit id. -* **projectName**: string: VSTS project name. -* **repositoryName**: string: VSTS repository name. -* **rootFolder**: string: VSTS root folder. -* **tenantId**: string: VSTS tenant id. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Dataset +## Activity * **Discriminator**: type ### Base Properties -* **annotations**: any[]: List of tags that can be used for describing the Dataset. -* **description**: string: Dataset description. -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. -* **structure**: any: Any object -### AmazonMWSObjectDataset +* **dependsOn**: [ActivityDependency](#activitydependency)[]: Activity depends on condition. +* **description**: string: Activity description. +* **name**: string (Required): Activity name. +### AzureMLBatchExecutionActivity #### Properties -* **type**: 'AmazonMWSObject' (Required): Type of dataset. +* **type**: 'AzureMLBatchExecution' (Required): Type of activity. +* **typeProperties**: [AzureMLBatchExecutionActivityTypeProperties](#azuremlbatchexecutionactivitytypeproperties) (Required): Azure ML Batch Execution activity properties. -### AmazonS3Dataset +### AzureMLUpdateResourceActivity #### Properties -* **type**: 'AmazonS3Object' (Required): Type of dataset. -* **typeProperties**: [AmazonS3DatasetTypeProperties](#amazons3datasettypeproperties) (Required): Amazon S3 dataset properties. +* **type**: 'AzureMLUpdateResource' (Required): Type of activity. +* **typeProperties**: [AzureMLUpdateResourceActivityTypeProperties](#azuremlupdateresourceactivitytypeproperties) (Required): Azure ML Update Resource activity properties. -### AzureBlobDataset +### CopyActivity #### Properties -* **type**: 'AzureBlob' (Required): Type of dataset. -* **typeProperties**: [AzureBlobDatasetTypeProperties](#azureblobdatasettypeproperties) (Required): Azure Blob dataset properties. +* **inputs**: [DatasetReference](#datasetreference)[]: List of inputs for the activity. +* **outputs**: [DatasetReference](#datasetreference)[]: List of outputs for the activity. +* **type**: 'Copy' (Required): Type of activity. +* **typeProperties**: [CopyActivityTypeProperties](#copyactivitytypeproperties) (Required): Copy activity properties. -### AzureDataLakeStoreDataset +### CustomActivity #### Properties -* **type**: 'AzureDataLakeStoreFile' (Required): Type of dataset. -* **typeProperties**: [AzureDataLakeStoreDatasetTypeProperties](#azuredatalakestoredatasettypeproperties) (Required): Azure Data Lake Store dataset properties. +* **type**: 'Custom' (Required): Type of activity. +* **typeProperties**: [CustomActivityTypeProperties](#customactivitytypeproperties) (Required): Custom activity properties. -### AzureMySqlTableDataset +### DatabricksNotebookActivity #### Properties -* **type**: 'AzureMySqlTable' (Required): Type of dataset. -* **typeProperties**: [AzureMySqlTableDatasetTypeProperties](#azuremysqltabledatasettypeproperties) (Required): Azure MySQL database dataset properties. +* **type**: 'DatabricksNotebook' (Required): Type of activity. +* **typeProperties**: [DatabricksNotebookActivityTypeProperties](#databricksnotebookactivitytypeproperties) (Required): Databricks Notebook activity properties. -### AzurePostgreSqlTableDataset +### DataLakeAnalyticsUsqlActivity #### Properties -* **type**: 'AzurePostgreSqlTable' (Required): Type of dataset. +* **type**: 'DataLakeAnalyticsU-SQL' (Required): Type of activity. +* **typeProperties**: [DataLakeAnalyticsUsqlActivityTypeProperties](#datalakeanalyticsusqlactivitytypeproperties) (Required): DataLakeAnalyticsU-SQL activity properties. -### AzureSearchIndexDataset +### ExecutePipelineActivity #### Properties -* **type**: 'AzureSearchIndex' (Required): Type of dataset. -* **typeProperties**: [AzureSearchIndexDatasetTypeProperties](#azuresearchindexdatasettypeproperties) (Required): Properties specific to this dataset type. +* **type**: 'ExecutePipeline' (Required): Type of activity. +* **typeProperties**: [ExecutePipelineActivityTypeProperties](#executepipelineactivitytypeproperties) (Required): Execute pipeline activity properties. -### AzureSqlDWTableDataset +### ExecuteSsisPackageActivity #### Properties -* **type**: 'AzureSqlDWTable' (Required): Type of dataset. -* **typeProperties**: [AzureSqlDWTableDatasetTypeProperties](#azuresqldwtabledatasettypeproperties) (Required): Azure SQL Data Warehouse dataset properties. +* **type**: 'ExecuteSSISPackage' (Required): Type of activity. +* **typeProperties**: [ExecuteSsisPackageActivityTypeProperties](#executessispackageactivitytypeproperties) (Required): Execute SSIS package activity properties. -### AzureSqlTableDataset +### FilterActivity #### Properties -* **type**: 'AzureSqlTable' (Required): Type of dataset. -* **typeProperties**: [AzureSqlTableDatasetTypeProperties](#azuresqltabledatasettypeproperties) (Required): Azure SQL dataset properties. +* **type**: 'Filter' (Required): Type of activity. +* **typeProperties**: [FilterActivityTypeProperties](#filteractivitytypeproperties) (Required): Filter activity properties. -### AzureTableDataset +### ForEachActivity #### Properties -* **type**: 'AzureTable' (Required): Type of dataset. -* **typeProperties**: [AzureTableDatasetTypeProperties](#azuretabledatasettypeproperties) (Required): Azure Table dataset properties. +* **type**: 'ForEach' (Required): Type of activity. +* **typeProperties**: [ForEachActivityTypeProperties](#foreachactivitytypeproperties) (Required): ForEach activity properties. -### CassandraTableDataset +### GetMetadataActivity #### Properties -* **type**: 'CassandraTable' (Required): Type of dataset. -* **typeProperties**: [CassandraTableDatasetTypeProperties](#cassandratabledatasettypeproperties) (Required): Cassandra dataset properties. +* **type**: 'GetMetadata' (Required): Type of activity. +* **typeProperties**: [GetMetadataActivityTypeProperties](#getmetadataactivitytypeproperties) (Required): GetMetadata activity properties. -### ConcurObjectDataset +### HDInsightHiveActivity #### Properties -* **type**: 'ConcurObject' (Required): Type of dataset. +* **type**: 'HDInsightHive' (Required): Type of activity. +* **typeProperties**: [HDInsightHiveActivityTypeProperties](#hdinsighthiveactivitytypeproperties) (Required): HDInsight Hive activity properties. -### CouchbaseTableDataset +### HDInsightMapReduceActivity #### Properties -* **type**: 'CouchbaseTable' (Required): Type of dataset. +* **type**: 'HDInsightMapReduce' (Required): Type of activity. +* **typeProperties**: [HDInsightMapReduceActivityTypeProperties](#hdinsightmapreduceactivitytypeproperties) (Required): HDInsight MapReduce activity properties. -### DocumentDbCollectionDataset +### HDInsightPigActivity #### Properties -* **type**: 'DocumentDbCollection' (Required): Type of dataset. -* **typeProperties**: [DocumentDbCollectionDatasetTypeProperties](#documentdbcollectiondatasettypeproperties) (Required): DocumentDB Collection dataset properties. +* **type**: 'HDInsightPig' (Required): Type of activity. +* **typeProperties**: [HDInsightPigActivityTypeProperties](#hdinsightpigactivitytypeproperties) (Required): HDInsight Pig activity properties. -### DrillTableDataset +### HDInsightSparkActivity #### Properties -* **type**: 'DrillTable' (Required): Type of dataset. +* **type**: 'HDInsightSpark' (Required): Type of activity. +* **typeProperties**: [HDInsightSparkActivityTypeProperties](#hdinsightsparkactivitytypeproperties) (Required): HDInsight spark activity properties. -### DynamicsEntityDataset +### HDInsightStreamingActivity #### Properties -* **type**: 'DynamicsEntity' (Required): Type of dataset. -* **typeProperties**: [DynamicsEntityDatasetTypeProperties](#dynamicsentitydatasettypeproperties) (Required): Dynamics entity dataset properties. +* **type**: 'HDInsightStreaming' (Required): Type of activity. +* **typeProperties**: [HDInsightStreamingActivityTypeProperties](#hdinsightstreamingactivitytypeproperties) (Required): HDInsight streaming activity properties. -### EloquaObjectDataset +### IfConditionActivity #### Properties -* **type**: 'EloquaObject' (Required): Type of dataset. +* **type**: 'IfCondition' (Required): Type of activity. +* **typeProperties**: [IfConditionActivityTypeProperties](#ifconditionactivitytypeproperties) (Required): IfCondition activity properties. -### FileShareDataset +### LookupActivity #### Properties -* **type**: 'FileShare' (Required): Type of dataset. -* **typeProperties**: [FileShareDatasetTypeProperties](#filesharedatasettypeproperties) (Required): On-premises file system dataset properties. +* **type**: 'Lookup' (Required): Type of activity. +* **typeProperties**: [LookupActivityTypeProperties](#lookupactivitytypeproperties) (Required): Lookup activity properties. -### GoogleBigQueryObjectDataset +### SqlServerStoredProcedureActivity #### Properties -* **type**: 'GoogleBigQueryObject' (Required): Type of dataset. +* **type**: 'SqlServerStoredProcedure' (Required): Type of activity. +* **typeProperties**: [SqlServerStoredProcedureActivityTypeProperties](#sqlserverstoredprocedureactivitytypeproperties) (Required): SQL stored procedure activity properties. -### GreenplumTableDataset +### UntilActivity #### Properties -* **type**: 'GreenplumTable' (Required): Type of dataset. +* **type**: 'Until' (Required): Type of activity. +* **typeProperties**: [UntilActivityTypeProperties](#untilactivitytypeproperties) (Required): Until activity properties. -### HBaseObjectDataset +### WaitActivity #### Properties -* **type**: 'HBaseObject' (Required): Type of dataset. +* **type**: 'Wait' (Required): Type of activity. +* **typeProperties**: [WaitActivityTypeProperties](#waitactivitytypeproperties) (Required): Wait activity properties. -### HiveObjectDataset +### WebActivity #### Properties -* **type**: 'HiveObject' (Required): Type of dataset. +* **type**: 'WebActivity' (Required): Type of activity. +* **typeProperties**: [WebActivityTypeProperties](#webactivitytypeproperties) (Required): Web activity type properties. -### HttpDataset -#### Properties -* **type**: 'HttpFile' (Required): Type of dataset. -* **typeProperties**: [HttpDatasetTypeProperties](#httpdatasettypeproperties) (Required): Properties specific to this dataset type. -### HubspotObjectDataset -#### Properties -* **type**: 'HubspotObject' (Required): Type of dataset. +## ActivityDependency +### Properties +* **activity**: string (Required): Activity name. +* **dependencyConditions**: 'Completed' | 'Failed' | 'Skipped' | 'Succeeded' | string[] (Required): Match-Condition for the dependency. +### Additional Properties +* **Additional Properties Type**: any -### ImpalaObjectDataset -#### Properties -* **type**: 'ImpalaObject' (Required): Type of dataset. +## AmazonMWSLinkedServiceTypeProperties +### Properties +* **accessKeyId**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **marketplaceID**: any (Required): Any object +* **mwsAuthToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **secretKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **sellerID**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### JiraObjectDataset -#### Properties -* **type**: 'JiraObject' (Required): Type of dataset. +## AmazonRedshiftLinkedServiceTypeProperties +### Properties +* **database**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **server**: any (Required): Any object +* **username**: any: Any object -### MagentoObjectDataset -#### Properties -* **type**: 'MagentoObject' (Required): Type of dataset. +## AmazonS3DatasetTypeProperties +### Properties +* **bucketName**: any (Required): Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **key**: any: Any object +* **prefix**: any: Any object +* **version**: any: Any object -### MariaDBTableDataset -#### Properties -* **type**: 'MariaDBTable' (Required): Type of dataset. +## AmazonS3LinkedServiceTypeProperties +### Properties +* **accessKeyId**: any: Any object +* **encryptedCredential**: any: Any object +* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. -### MarketoObjectDataset -#### Properties -* **type**: 'MarketoObject' (Required): Type of dataset. +## AzureBatchLinkedServiceTypeProperties +### Properties +* **accessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **accountName**: any (Required): Any object +* **batchUri**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **poolName**: any (Required): Any object -### MongoDbCollectionDataset -#### Properties -* **type**: 'MongoDbCollection' (Required): Type of dataset. -* **typeProperties**: [MongoDbCollectionDatasetTypeProperties](#mongodbcollectiondatasettypeproperties) (Required): MongoDB database dataset properties. +## AzureBlobDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileName**: any: Any object +* **folderPath**: any: Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **tableRootLocation**: any: Any object -### NetezzaTableDataset -#### Properties -* **type**: 'NetezzaTable' (Required): Type of dataset. +## AzureDatabricksLinkedServiceTypeProperties +### Properties +* **accessToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **domain**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **existingClusterId**: any: Any object +* **newClusterNodeType**: any: Any object +* **newClusterNumOfWorker**: any: Any object +* **newClusterSparkConf**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf](#azuredatabrickslinkedservicetypepropertiesnewclustersparkconf): a set of optional, user-specified Spark configuration key-value pairs. +* **newClusterVersion**: any: Any object -### ODataResourceDataset -#### Properties -* **type**: 'ODataResource' (Required): Type of dataset. -* **typeProperties**: [ODataResourceDatasetTypeProperties](#odataresourcedatasettypeproperties) (Required): OData dataset properties. - -### OracleTableDataset -#### Properties -* **type**: 'OracleTable' (Required): Type of dataset. -* **typeProperties**: [OracleTableDatasetTypeProperties](#oracletabledatasettypeproperties) (Required): On-premises Oracle dataset properties. - -### PaypalObjectDataset -#### Properties -* **type**: 'PaypalObject' (Required): Type of dataset. - -### PhoenixObjectDataset -#### Properties -* **type**: 'PhoenixObject' (Required): Type of dataset. - -### PrestoObjectDataset -#### Properties -* **type**: 'PrestoObject' (Required): Type of dataset. - -### QuickBooksObjectDataset -#### Properties -* **type**: 'QuickBooksObject' (Required): Type of dataset. - -### RelationalTableDataset -#### Properties -* **type**: 'RelationalTable' (Required): Type of dataset. -* **typeProperties**: [RelationalTableDatasetTypeProperties](#relationaltabledatasettypeproperties) (Required): Relational table dataset properties. - -### ResponsysObjectDataset -#### Properties -* **type**: 'ResponsysObject' (Required): Type of dataset. - -### SalesforceMarketingCloudObjectDataset -#### Properties -* **type**: 'SalesforceMarketingCloudObject' (Required): Type of dataset. - -### SalesforceObjectDataset -#### Properties -* **type**: 'SalesforceObject' (Required): Type of dataset. -* **typeProperties**: [SalesforceObjectDatasetTypeProperties](#salesforceobjectdatasettypeproperties) (Required): Salesforce object dataset properties. - -### SapCloudForCustomerResourceDataset -#### Properties -* **type**: 'SapCloudForCustomerResource' (Required): Type of dataset. -* **typeProperties**: [SapCloudForCustomerResourceDatasetTypeProperties](#sapcloudforcustomerresourcedatasettypeproperties) (Required): Sap Cloud For Customer OData resource dataset properties. - -### SapEccResourceDataset -#### Properties -* **type**: 'SapEccResource' (Required): Type of dataset. -* **typeProperties**: [SapEccResourceDatasetTypeProperties](#sapeccresourcedatasettypeproperties) (Required): Sap ECC OData resource dataset properties. - -### ServiceNowObjectDataset -#### Properties -* **type**: 'ServiceNowObject' (Required): Type of dataset. - -### ShopifyObjectDataset -#### Properties -* **type**: 'ShopifyObject' (Required): Type of dataset. - -### SparkObjectDataset -#### Properties -* **type**: 'SparkObject' (Required): Type of dataset. - -### SqlServerTableDataset -#### Properties -* **type**: 'SqlServerTable' (Required): Type of dataset. -* **typeProperties**: [SqlServerTableDatasetTypeProperties](#sqlservertabledatasettypeproperties) (Required): On-premises SQL Server dataset properties. - -### SquareObjectDataset -#### Properties -* **type**: 'SquareObject' (Required): Type of dataset. - -### VerticaTableDataset -#### Properties -* **type**: 'VerticaTable' (Required): Type of dataset. +## AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf +### Properties +### Additional Properties +* **Additional Properties Type**: any -### WebTableDataset -#### Properties -* **type**: 'WebTable' (Required): Type of dataset. -* **typeProperties**: [WebTableDatasetTypeProperties](#webtabledatasettypeproperties) (Required): Web table dataset properties. +## AzureDataLakeAnalyticsLinkedServiceTypeProperties +### Properties +* **accountName**: any (Required): Any object +* **dataLakeAnalyticsUri**: any: Any object +* **encryptedCredential**: any: Any object +* **resourceGroupName**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **subscriptionId**: any: Any object +* **tenant**: any (Required): Any object -### XeroObjectDataset -#### Properties -* **type**: 'XeroObject' (Required): Type of dataset. +## AzureDataLakeStoreDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileName**: any: Any object +* **folderPath**: any (Required): Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -### ZohoObjectDataset -#### Properties -* **type**: 'ZohoObject' (Required): Type of dataset. +## AzureDataLakeStoreLinkedServiceTypeProperties +### Properties +* **accountName**: any: Any object +* **dataLakeStoreUri**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **resourceGroupName**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **subscriptionId**: any: Any object +* **tenant**: any: Any object +## AzureKeyVaultLinkedServiceTypeProperties +### Properties +* **baseUrl**: any (Required): Any object -## LinkedServiceReference +## AzureMLBatchExecutionActivityTypeProperties ### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference LinkedService name. -* **type**: 'LinkedServiceReference' | string (Required): Linked service reference type. +* **globalParameters**: [AzureMLBatchExecutionActivityTypePropertiesGlobalParameters](#azuremlbatchexecutionactivitytypepropertiesglobalparameters): 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. +* **webServiceInputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs](#azuremlbatchexecutionactivitytypepropertieswebserviceinputs): 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. +* **webServiceOutputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs](#azuremlbatchexecutionactivitytypepropertieswebserviceoutputs): 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. -## ParameterValueSpecification +## AzureMLBatchExecutionActivityTypePropertiesGlobalParameters ### Properties ### Additional Properties * **Additional Properties Type**: any -## ParameterDefinitionSpecification +## AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) +* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) -## ParameterSpecification +## AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs ### Properties -* **defaultValue**: any: Any object -* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'Object' | 'SecureString' | 'String' | string (Required): Parameter type. +### Additional Properties +* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) -## AmazonS3DatasetTypeProperties +## AzureMLLinkedServiceTypeProperties ### Properties -* **bucketName**: any (Required): Any object -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **key**: any: Any object -* **prefix**: any: Any object -* **version**: any: Any object - -## DatasetCompression -* **Discriminator**: type - -### Base Properties -### DatasetBZip2Compression -#### Properties -* **type**: 'BZip2' (Required): Type of dataset compression. - -### DatasetDeflateCompression -#### Properties -* **level**: 'Fastest' | 'Optimal' | string: All available compression levels. -* **type**: 'Deflate' (Required): Type of dataset compression. - -### DatasetGZipCompression -#### Properties -* **level**: 'Fastest' | 'Optimal' | string: All available compression levels. -* **type**: 'GZip' (Required): Type of dataset compression. - -### DatasetZipDeflateCompression -#### Properties -* **level**: 'Fastest' | 'Optimal' | string: All available compression levels. -* **type**: 'ZipDeflate' (Required): Type of dataset compression. - - -## DatasetStorageFormat -* **Discriminator**: type +* **apiKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **mlEndpoint**: any (Required): Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object +* **updateResourceEndpoint**: any: Any object -### Base Properties -* **deserializer**: any: Any object -* **serializer**: any: Any object +## AzureMLUpdateResourceActivityTypeProperties +### Properties +* **trainedModelFilePath**: any (Required): Any object +* **trainedModelLinkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **trainedModelName**: any (Required): Any object -## AzureBlobDatasetTypeProperties +## AzureMLWebServiceFile ### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileName**: any: Any object -* **folderPath**: any: Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **tableRootLocation**: any: Any object +* **filePath**: any (Required): Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -## AzureDataLakeStoreDatasetTypeProperties +## AzureMySqlLinkedServiceTypeProperties ### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileName**: any: Any object -* **folderPath**: any (Required): Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object ## AzureMySqlTableDatasetTypeProperties ### Properties * **tableName**: any: Any object +## AzurePostgreSqlLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object + ## AzureSearchIndexDatasetTypeProperties ### Properties * **indexName**: any (Required): Any object +## AzureSearchLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **key**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object + +## AzureSqlDatabaseLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object + +## AzureSqlDWLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object + ## AzureSqlDWTableDatasetTypeProperties ### Properties * **tableName**: any (Required): Any object @@ -427,765 +387,547 @@ ### Properties * **tableName**: any (Required): Any object +## AzureStorageLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **sasUri**: [SecretBase](#secretbase): The base definition of a secret type. + ## AzureTableDatasetTypeProperties ### Properties * **tableName**: any (Required): Any object +## CassandraLinkedServiceTypeProperties +### Properties +* **authenticationType**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **username**: any: Any object + ## CassandraTableDatasetTypeProperties ### Properties * **keyspace**: any: Any object * **tableName**: any: Any object -## DocumentDbCollectionDatasetTypeProperties -### Properties -* **collectionName**: any (Required): Any object - -## DynamicsEntityDatasetTypeProperties +## ConcurLinkedServiceTypeProperties ### Properties -* **entityName**: any: Any object - -## FileShareDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileFilter**: any: Any object -* **fileName**: any: Any object -* **folderPath**: any: Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. - -## HttpDatasetTypeProperties -### Properties -* **additionalHeaders**: any: Any object -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **relativeUrl**: any: Any object -* **requestBody**: any: Any object -* **requestMethod**: any: Any object - -## MongoDbCollectionDatasetTypeProperties -### Properties -* **collectionName**: any (Required): Any object - -## ODataResourceDatasetTypeProperties -### Properties -* **path**: any: Any object - -## OracleTableDatasetTypeProperties -### Properties -* **tableName**: any (Required): Any object - -## RelationalTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object - -## SalesforceObjectDatasetTypeProperties -### Properties -* **objectApiName**: any: Any object - -## SapCloudForCustomerResourceDatasetTypeProperties -### Properties -* **path**: any (Required): Any object - -## SapEccResourceDatasetTypeProperties -### Properties -* **path**: any (Required): Any object - -## SqlServerTableDatasetTypeProperties -### Properties -* **tableName**: any (Required): Any object +* **clientId**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object -## WebTableDatasetTypeProperties +## CopyActivityTypeProperties ### Properties -* **index**: any (Required): Any object -* **path**: any: Any object +* **cloudDataMovementUnits**: any: Any object +* **enableSkipIncompatibleRow**: any: Any object +* **enableStaging**: any: Any object +* **parallelCopies**: any: Any object +* **redirectIncompatibleRowSettings**: [RedirectIncompatibleRowSettings](#redirectincompatiblerowsettings): Redirect incompatible row settings +* **sink**: [CopySink](#copysink) (Required): A copy activity sink. +* **source**: [CopySource](#copysource) (Required): A copy activity source. +* **stagingSettings**: [StagingSettings](#stagingsettings): Staging settings. +* **translator**: any: Any object -## IntegrationRuntime +## CopySink * **Discriminator**: type ### Base Properties -* **description**: string: Integration runtime description. -### ManagedIntegrationRuntime -#### Properties -* **state**: 'Initial' | 'Limited' | 'NeedRegistration' | 'Offline' | 'Online' | 'Started' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The state of integration runtime. -* **type**: 'Managed' (Required): Type of integration runtime. -* **typeProperties**: [ManagedIntegrationRuntimeTypeProperties](#managedintegrationruntimetypeproperties) (Required): Managed integration runtime type properties. +* **sinkRetryCount**: any: Any object +* **sinkRetryWait**: any: Any object +* **writeBatchSize**: any: Any object +* **writeBatchTimeout**: any: Any object -### SelfHostedIntegrationRuntime -#### Properties -* **type**: 'SelfHosted' (Required): Type of integration runtime. -* **typeProperties**: [LinkedIntegrationRuntimeTypeProperties](#linkedintegrationruntimetypeproperties) (Required): The base definition of a secret type. +## CopySource +* **Discriminator**: type +### Base Properties +* **sourceRetryCount**: any: Any object +* **sourceRetryWait**: any: Any object -## ManagedIntegrationRuntimeTypeProperties +## CosmosDbLinkedServiceTypeProperties ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object -## IntegrationRuntimeComputeProperties +## CouchbaseLinkedServiceTypeProperties ### Properties -* **location**: 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 -* **maxParallelExecutionsPerNode**: int: Maximum parallel executions count per node for managed integration runtime. -* **nodeSize**: string: The node size requirement to managed integration runtime. -* **numberOfNodes**: int: The required number of nodes for managed integration runtime. -* **vNetProperties**: [IntegrationRuntimeVNetProperties](#integrationruntimevnetproperties): VNet properties for managed integration runtime. -### Additional Properties -* **Additional Properties Type**: any +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object -## IntegrationRuntimeVNetProperties +## CustomActivityReferenceObject ### Properties -* **subnet**: string: The name of the subnet this integration runtime will join. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. -### Additional Properties -* **Additional Properties Type**: any +* **datasets**: [DatasetReference](#datasetreference)[]: Dataset references. +* **linkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Linked service references. -## IntegrationRuntimeSsisProperties +## CustomActivityTypeProperties ### Properties -* **catalogInfo**: [IntegrationRuntimeSsisCatalogInfo](#integrationruntimessiscataloginfo): Catalog information for managed dedicated integration runtime. -* **customSetupScriptProperties**: [IntegrationRuntimeCustomSetupScriptProperties](#integrationruntimecustomsetupscriptproperties): Custom setup script properties for a managed dedicated integration runtime. -* **dataProxyProperties**: [IntegrationRuntimeDataProxyProperties](#integrationruntimedataproxyproperties): Data proxy properties for a managed dedicated integration runtime. -* **edition**: 'Enterprise' | 'Standard' | string: The edition for the SSIS Integration Runtime -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: License type for bringing your own license scenario. -### Additional Properties -* **Additional Properties Type**: any +* **command**: any (Required): Any object +* **extendedProperties**: [CustomActivityTypePropertiesExtendedProperties](#customactivitytypepropertiesextendedproperties): 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. +* **folderPath**: any: Any object +* **referenceObjects**: [CustomActivityReferenceObject](#customactivityreferenceobject): Reference objects for custom activity +* **resourceLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -## IntegrationRuntimeSsisCatalogInfo +## CustomActivityTypePropertiesExtendedProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any -## SecureString -### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - -## IntegrationRuntimeCustomSetupScriptProperties +## DatabricksNotebookActivityTypeProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **baseParameters**: [DatabricksNotebookActivityTypePropertiesBaseParameters](#databricksnotebookactivitytypepropertiesbaseparameters): 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. +* **notebookPath**: any (Required): Any object -## IntegrationRuntimeDataProxyProperties +## DatabricksNotebookActivityTypePropertiesBaseParameters ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +### Additional Properties +* **Additional Properties Type**: any -## EntityReference +## DataLakeAnalyticsUsqlActivityTypeProperties ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. +* **compilationMode**: any: Any object +* **degreeOfParallelism**: any: Any object +* **parameters**: [DataLakeAnalyticsUsqlActivityTypePropertiesParameters](#datalakeanalyticsusqlactivitytypepropertiesparameters): Parameters for U-SQL job request. +* **priority**: any: Any object +* **runtimeVersion**: any: Any object +* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **scriptPath**: any (Required): Any object -## LinkedIntegrationRuntimeTypeProperties +## DataLakeAnalyticsUsqlActivityTypePropertiesParameters ### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeProperties](#linkedintegrationruntimeproperties): The base definition of a secret type. - -## LinkedIntegrationRuntimeProperties -* **Discriminator**: authorizationType - -### Base Properties -### LinkedIntegrationRuntimeKey -#### Properties -* **authorizationType**: 'Key' (Required): Type of the secret. -* **key**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. - -### LinkedIntegrationRuntimeRbac -#### Properties -* **authorizationType**: 'RBAC' (Required): Type of the secret. -* **resourceId**: string (Required): The resource ID of the integration runtime to be shared. - +### Additional Properties +* **Additional Properties Type**: any -## LinkedService +## Dataset * **Discriminator**: type ### Base Properties * **annotations**: any[]: List of tags that can be used for describing the Dataset. -* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. -* **description**: string: Linked service description. +* **description**: string: Dataset description. +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. * **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. -### AmazonMWSLinkedService +* **structure**: any: Any object +### AmazonMWSObjectDataset #### Properties -* **type**: 'AmazonMWS' (Required): Type of linked service. -* **typeProperties**: [AmazonMWSLinkedServiceTypeProperties](#amazonmwslinkedservicetypeproperties) (Required): Amazon Marketplace Web Service linked service properties. +* **type**: 'AmazonMWSObject' (Required): Type of dataset. -### AmazonRedshiftLinkedService +### AmazonS3Dataset #### Properties -* **type**: 'AmazonRedshift' (Required): Type of linked service. -* **typeProperties**: [AmazonRedshiftLinkedServiceTypeProperties](#amazonredshiftlinkedservicetypeproperties) (Required): Amazon Redshift linked service properties. +* **type**: 'AmazonS3Object' (Required): Type of dataset. +* **typeProperties**: [AmazonS3DatasetTypeProperties](#amazons3datasettypeproperties) (Required): Amazon S3 dataset properties. -### AmazonS3LinkedService +### AzureBlobDataset #### Properties -* **type**: 'AmazonS3' (Required): Type of linked service. -* **typeProperties**: [AmazonS3LinkedServiceTypeProperties](#amazons3linkedservicetypeproperties) (Required): Amazon S3 linked service properties. +* **type**: 'AzureBlob' (Required): Type of dataset. +* **typeProperties**: [AzureBlobDatasetTypeProperties](#azureblobdatasettypeproperties) (Required): Azure Blob dataset properties. -### AzureBatchLinkedService +### AzureDataLakeStoreDataset #### Properties -* **type**: 'AzureBatch' (Required): Type of linked service. -* **typeProperties**: [AzureBatchLinkedServiceTypeProperties](#azurebatchlinkedservicetypeproperties) (Required): Azure Batch linked service properties. +* **type**: 'AzureDataLakeStoreFile' (Required): Type of dataset. +* **typeProperties**: [AzureDataLakeStoreDatasetTypeProperties](#azuredatalakestoredatasettypeproperties) (Required): Azure Data Lake Store dataset properties. -### AzureDatabricksLinkedService +### AzureMySqlTableDataset #### Properties -* **type**: 'AzureDatabricks' (Required): Type of linked service. -* **typeProperties**: [AzureDatabricksLinkedServiceTypeProperties](#azuredatabrickslinkedservicetypeproperties) (Required): Azure Databricks linked service properties. +* **type**: 'AzureMySqlTable' (Required): Type of dataset. +* **typeProperties**: [AzureMySqlTableDatasetTypeProperties](#azuremysqltabledatasettypeproperties) (Required): Azure MySQL database dataset properties. -### AzureDataLakeAnalyticsLinkedService +### AzurePostgreSqlTableDataset #### Properties -* **type**: 'AzureDataLakeAnalytics' (Required): Type of linked service. -* **typeProperties**: [AzureDataLakeAnalyticsLinkedServiceTypeProperties](#azuredatalakeanalyticslinkedservicetypeproperties) (Required): Azure Data Lake Analytics linked service properties. +* **type**: 'AzurePostgreSqlTable' (Required): Type of dataset. -### AzureDataLakeStoreLinkedService +### AzureSearchIndexDataset #### Properties -* **type**: 'AzureDataLakeStore' (Required): Type of linked service. -* **typeProperties**: [AzureDataLakeStoreLinkedServiceTypeProperties](#azuredatalakestorelinkedservicetypeproperties) (Required): Azure Data Lake Store linked service properties. +* **type**: 'AzureSearchIndex' (Required): Type of dataset. +* **typeProperties**: [AzureSearchIndexDatasetTypeProperties](#azuresearchindexdatasettypeproperties) (Required): Properties specific to this dataset type. -### AzureKeyVaultLinkedService +### AzureSqlDWTableDataset #### Properties -* **type**: 'AzureKeyVault' (Required): Type of linked service. -* **typeProperties**: [AzureKeyVaultLinkedServiceTypeProperties](#azurekeyvaultlinkedservicetypeproperties) (Required): Azure Key Vault linked service properties. +* **type**: 'AzureSqlDWTable' (Required): Type of dataset. +* **typeProperties**: [AzureSqlDWTableDatasetTypeProperties](#azuresqldwtabledatasettypeproperties) (Required): Azure SQL Data Warehouse dataset properties. -### AzureMLLinkedService +### AzureSqlTableDataset #### Properties -* **type**: 'AzureML' (Required): Type of linked service. -* **typeProperties**: [AzureMLLinkedServiceTypeProperties](#azuremllinkedservicetypeproperties) (Required): Azure ML Web Service linked service properties. +* **type**: 'AzureSqlTable' (Required): Type of dataset. +* **typeProperties**: [AzureSqlTableDatasetTypeProperties](#azuresqltabledatasettypeproperties) (Required): Azure SQL dataset properties. -### AzureMySqlLinkedService +### AzureTableDataset #### Properties -* **type**: 'AzureMySql' (Required): Type of linked service. -* **typeProperties**: [AzureMySqlLinkedServiceTypeProperties](#azuremysqllinkedservicetypeproperties) (Required): Azure MySQL database linked service properties. +* **type**: 'AzureTable' (Required): Type of dataset. +* **typeProperties**: [AzureTableDatasetTypeProperties](#azuretabledatasettypeproperties) (Required): Azure Table dataset properties. -### AzurePostgreSqlLinkedService +### CassandraTableDataset #### Properties -* **type**: 'AzurePostgreSql' (Required): Type of linked service. -* **typeProperties**: [AzurePostgreSqlLinkedServiceTypeProperties](#azurepostgresqllinkedservicetypeproperties) (Required): Azure PostgreSQL linked service properties. +* **type**: 'CassandraTable' (Required): Type of dataset. +* **typeProperties**: [CassandraTableDatasetTypeProperties](#cassandratabledatasettypeproperties) (Required): Cassandra dataset properties. -### AzureSearchLinkedService +### ConcurObjectDataset #### Properties -* **type**: 'AzureSearch' (Required): Type of linked service. -* **typeProperties**: [AzureSearchLinkedServiceTypeProperties](#azuresearchlinkedservicetypeproperties) (Required): Windows Azure Search Service linked service properties. +* **type**: 'ConcurObject' (Required): Type of dataset. -### AzureSqlDatabaseLinkedService +### CouchbaseTableDataset #### Properties -* **type**: 'AzureSqlDatabase' (Required): Type of linked service. -* **typeProperties**: [AzureSqlDatabaseLinkedServiceTypeProperties](#azuresqldatabaselinkedservicetypeproperties) (Required): Azure SQL Database linked service properties. +* **type**: 'CouchbaseTable' (Required): Type of dataset. -### AzureSqlDWLinkedService +### DocumentDbCollectionDataset #### Properties -* **type**: 'AzureSqlDW' (Required): Type of linked service. -* **typeProperties**: [AzureSqlDWLinkedServiceTypeProperties](#azuresqldwlinkedservicetypeproperties) (Required): Azure SQL Data Warehouse linked service properties. +* **type**: 'DocumentDbCollection' (Required): Type of dataset. +* **typeProperties**: [DocumentDbCollectionDatasetTypeProperties](#documentdbcollectiondatasettypeproperties) (Required): DocumentDB Collection dataset properties. -### AzureStorageLinkedService +### DrillTableDataset #### Properties -* **type**: 'AzureStorage' (Required): Type of linked service. -* **typeProperties**: [AzureStorageLinkedServiceTypeProperties](#azurestoragelinkedservicetypeproperties) (Required): Azure Storage linked service properties. +* **type**: 'DrillTable' (Required): Type of dataset. -### CassandraLinkedService +### DynamicsEntityDataset #### Properties -* **type**: 'Cassandra' (Required): Type of linked service. -* **typeProperties**: [CassandraLinkedServiceTypeProperties](#cassandralinkedservicetypeproperties) (Required): Cassandra linked service properties. +* **type**: 'DynamicsEntity' (Required): Type of dataset. +* **typeProperties**: [DynamicsEntityDatasetTypeProperties](#dynamicsentitydatasettypeproperties) (Required): Dynamics entity dataset properties. -### ConcurLinkedService +### EloquaObjectDataset #### Properties -* **type**: 'Concur' (Required): Type of linked service. -* **typeProperties**: [ConcurLinkedServiceTypeProperties](#concurlinkedservicetypeproperties) (Required): Concur Service linked service properties. +* **type**: 'EloquaObject' (Required): Type of dataset. -### CosmosDbLinkedService +### FileShareDataset #### Properties -* **type**: 'CosmosDb' (Required): Type of linked service. -* **typeProperties**: [CosmosDbLinkedServiceTypeProperties](#cosmosdblinkedservicetypeproperties) (Required): CosmosDB linked service properties. +* **type**: 'FileShare' (Required): Type of dataset. +* **typeProperties**: [FileShareDatasetTypeProperties](#filesharedatasettypeproperties) (Required): On-premises file system dataset properties. -### CouchbaseLinkedService +### GoogleBigQueryObjectDataset #### Properties -* **type**: 'Couchbase' (Required): Type of linked service. -* **typeProperties**: [CouchbaseLinkedServiceTypeProperties](#couchbaselinkedservicetypeproperties) (Required): Couchbase server linked service properties. +* **type**: 'GoogleBigQueryObject' (Required): Type of dataset. -### CustomDataSourceLinkedService +### GreenplumTableDataset #### Properties -* **type**: 'CustomDataSource' (Required): Type of linked service. -* **typeProperties**: any (Required): Any object +* **type**: 'GreenplumTable' (Required): Type of dataset. -### Db2LinkedService +### HBaseObjectDataset #### Properties -* **type**: 'Db2' (Required): Type of linked service. -* **typeProperties**: [Db2LinkedServiceTypeProperties](#db2linkedservicetypeproperties) (Required): DB2 linked service properties. +* **type**: 'HBaseObject' (Required): Type of dataset. -### DrillLinkedService +### HiveObjectDataset #### Properties -* **type**: 'Drill' (Required): Type of linked service. -* **typeProperties**: [DrillLinkedServiceTypeProperties](#drilllinkedservicetypeproperties) (Required): Drill server linked service properties. +* **type**: 'HiveObject' (Required): Type of dataset. -### DynamicsLinkedService +### HttpDataset #### Properties -* **type**: 'Dynamics' (Required): Type of linked service. -* **typeProperties**: [DynamicsLinkedServiceTypeProperties](#dynamicslinkedservicetypeproperties) (Required): Dynamics linked service properties. +* **type**: 'HttpFile' (Required): Type of dataset. +* **typeProperties**: [HttpDatasetTypeProperties](#httpdatasettypeproperties) (Required): Properties specific to this dataset type. -### EloquaLinkedService +### HubspotObjectDataset #### Properties -* **type**: 'Eloqua' (Required): Type of linked service. -* **typeProperties**: [EloquaLinkedServiceTypeProperties](#eloqualinkedservicetypeproperties) (Required): Eloqua server linked service properties. +* **type**: 'HubspotObject' (Required): Type of dataset. -### FileServerLinkedService +### ImpalaObjectDataset #### Properties -* **type**: 'FileServer' (Required): Type of linked service. -* **typeProperties**: [FileServerLinkedServiceTypeProperties](#fileserverlinkedservicetypeproperties) (Required): File system linked service properties. +* **type**: 'ImpalaObject' (Required): Type of dataset. -### FtpServerLinkedService +### JiraObjectDataset #### Properties -* **type**: 'FtpServer' (Required): Type of linked service. -* **typeProperties**: [FtpServerLinkedServiceTypeProperties](#ftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'JiraObject' (Required): Type of dataset. -### GoogleBigQueryLinkedService +### MagentoObjectDataset #### Properties -* **type**: 'GoogleBigQuery' (Required): Type of linked service. -* **typeProperties**: [GoogleBigQueryLinkedServiceTypeProperties](#googlebigquerylinkedservicetypeproperties) (Required): Google BigQuery service linked service properties. +* **type**: 'MagentoObject' (Required): Type of dataset. -### GreenplumLinkedService +### MariaDBTableDataset #### Properties -* **type**: 'Greenplum' (Required): Type of linked service. -* **typeProperties**: [GreenplumLinkedServiceTypeProperties](#greenplumlinkedservicetypeproperties) (Required): Greenplum Database linked service properties. +* **type**: 'MariaDBTable' (Required): Type of dataset. -### HBaseLinkedService +### MarketoObjectDataset #### Properties -* **type**: 'HBase' (Required): Type of linked service. -* **typeProperties**: [HBaseLinkedServiceTypeProperties](#hbaselinkedservicetypeproperties) (Required): HBase server linked service properties. +* **type**: 'MarketoObject' (Required): Type of dataset. -### HdfsLinkedService +### MongoDbCollectionDataset #### Properties -* **type**: 'Hdfs' (Required): Type of linked service. -* **typeProperties**: [HdfsLinkedServiceTypeProperties](#hdfslinkedservicetypeproperties) (Required): HDFS linked service properties. +* **type**: 'MongoDbCollection' (Required): Type of dataset. +* **typeProperties**: [MongoDbCollectionDatasetTypeProperties](#mongodbcollectiondatasettypeproperties) (Required): MongoDB database dataset properties. -### HDInsightLinkedService +### NetezzaTableDataset #### Properties -* **type**: 'HDInsight' (Required): Type of linked service. -* **typeProperties**: [HDInsightLinkedServiceTypeProperties](#hdinsightlinkedservicetypeproperties) (Required): HDInsight linked service properties. +* **type**: 'NetezzaTable' (Required): Type of dataset. -### HDInsightOnDemandLinkedService +### ODataResourceDataset #### Properties -* **type**: 'HDInsightOnDemand' (Required): Type of linked service. -* **typeProperties**: [HDInsightOnDemandLinkedServiceTypeProperties](#hdinsightondemandlinkedservicetypeproperties) (Required): HDInsight ondemand linked service properties. +* **type**: 'ODataResource' (Required): Type of dataset. +* **typeProperties**: [ODataResourceDatasetTypeProperties](#odataresourcedatasettypeproperties) (Required): OData dataset properties. -### HiveLinkedService +### OracleTableDataset #### Properties -* **type**: 'Hive' (Required): Type of linked service. -* **typeProperties**: [HiveLinkedServiceTypeProperties](#hivelinkedservicetypeproperties) (Required): Hive Server linked service properties. +* **type**: 'OracleTable' (Required): Type of dataset. +* **typeProperties**: [OracleTableDatasetTypeProperties](#oracletabledatasettypeproperties) (Required): On-premises Oracle dataset properties. -### HttpLinkedService +### PaypalObjectDataset #### Properties -* **type**: 'HttpServer' (Required): Type of linked service. -* **typeProperties**: [HttpLinkedServiceTypeProperties](#httplinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'PaypalObject' (Required): Type of dataset. -### HubspotLinkedService +### PhoenixObjectDataset #### Properties -* **type**: 'Hubspot' (Required): Type of linked service. -* **typeProperties**: [HubspotLinkedServiceTypeProperties](#hubspotlinkedservicetypeproperties) (Required): Hubspot Service linked service properties. +* **type**: 'PhoenixObject' (Required): Type of dataset. -### ImpalaLinkedService +### PrestoObjectDataset #### Properties -* **type**: 'Impala' (Required): Type of linked service. -* **typeProperties**: [ImpalaLinkedServiceTypeProperties](#impalalinkedservicetypeproperties) (Required): Impala server linked service properties. +* **type**: 'PrestoObject' (Required): Type of dataset. -### JiraLinkedService +### QuickBooksObjectDataset #### Properties -* **type**: 'Jira' (Required): Type of linked service. -* **typeProperties**: [JiraLinkedServiceTypeProperties](#jiralinkedservicetypeproperties) (Required): Jira Service linked service properties. +* **type**: 'QuickBooksObject' (Required): Type of dataset. -### MagentoLinkedService +### RelationalTableDataset #### Properties -* **type**: 'Magento' (Required): Type of linked service. -* **typeProperties**: [MagentoLinkedServiceTypeProperties](#magentolinkedservicetypeproperties) (Required): Magento server linked service properties. +* **type**: 'RelationalTable' (Required): Type of dataset. +* **typeProperties**: [RelationalTableDatasetTypeProperties](#relationaltabledatasettypeproperties) (Required): Relational table dataset properties. -### MariaDBLinkedService +### ResponsysObjectDataset #### Properties -* **type**: 'MariaDB' (Required): Type of linked service. -* **typeProperties**: [MariaDBLinkedServiceTypeProperties](#mariadblinkedservicetypeproperties) (Required): MariaDB server linked service properties. +* **type**: 'ResponsysObject' (Required): Type of dataset. -### MarketoLinkedService +### SalesforceMarketingCloudObjectDataset #### Properties -* **type**: 'Marketo' (Required): Type of linked service. -* **typeProperties**: [MarketoLinkedServiceTypeProperties](#marketolinkedservicetypeproperties) (Required): Marketo server linked service properties. +* **type**: 'SalesforceMarketingCloudObject' (Required): Type of dataset. -### MongoDbLinkedService +### SalesforceObjectDataset #### Properties -* **type**: 'MongoDb' (Required): Type of linked service. -* **typeProperties**: [MongoDbLinkedServiceTypeProperties](#mongodblinkedservicetypeproperties) (Required): MongoDB linked service properties. +* **type**: 'SalesforceObject' (Required): Type of dataset. +* **typeProperties**: [SalesforceObjectDatasetTypeProperties](#salesforceobjectdatasettypeproperties) (Required): Salesforce object dataset properties. -### MySqlLinkedService +### SapCloudForCustomerResourceDataset #### Properties -* **type**: 'MySql' (Required): Type of linked service. -* **typeProperties**: [MySqlLinkedServiceTypeProperties](#mysqllinkedservicetypeproperties) (Required): MySQL linked service properties. +* **type**: 'SapCloudForCustomerResource' (Required): Type of dataset. +* **typeProperties**: [SapCloudForCustomerResourceDatasetTypeProperties](#sapcloudforcustomerresourcedatasettypeproperties) (Required): Sap Cloud For Customer OData resource dataset properties. -### NetezzaLinkedService +### SapEccResourceDataset #### Properties -* **type**: 'Netezza' (Required): Type of linked service. -* **typeProperties**: [NetezzaLinkedServiceTypeProperties](#netezzalinkedservicetypeproperties) (Required): Netezza linked service properties. +* **type**: 'SapEccResource' (Required): Type of dataset. +* **typeProperties**: [SapEccResourceDatasetTypeProperties](#sapeccresourcedatasettypeproperties) (Required): Sap ECC OData resource dataset properties. -### ODataLinkedService +### ServiceNowObjectDataset #### Properties -* **type**: 'OData' (Required): Type of linked service. -* **typeProperties**: [ODataLinkedServiceTypeProperties](#odatalinkedservicetypeproperties) (Required): OData linked service properties. +* **type**: 'ServiceNowObject' (Required): Type of dataset. -### OdbcLinkedService +### ShopifyObjectDataset #### Properties -* **type**: 'Odbc' (Required): Type of linked service. -* **typeProperties**: [OdbcLinkedServiceTypeProperties](#odbclinkedservicetypeproperties) (Required): ODBC linked service properties. +* **type**: 'ShopifyObject' (Required): Type of dataset. -### OracleLinkedService +### SparkObjectDataset #### Properties -* **type**: 'Oracle' (Required): Type of linked service. -* **typeProperties**: [OracleLinkedServiceTypeProperties](#oraclelinkedservicetypeproperties) (Required): Oracle database linked service properties. +* **type**: 'SparkObject' (Required): Type of dataset. -### PaypalLinkedService +### SqlServerTableDataset #### Properties -* **type**: 'Paypal' (Required): Type of linked service. -* **typeProperties**: [PaypalLinkedServiceTypeProperties](#paypallinkedservicetypeproperties) (Required): Paypal Service linked service properties. +* **type**: 'SqlServerTable' (Required): Type of dataset. +* **typeProperties**: [SqlServerTableDatasetTypeProperties](#sqlservertabledatasettypeproperties) (Required): On-premises SQL Server dataset properties. -### PhoenixLinkedService +### SquareObjectDataset #### Properties -* **type**: 'Phoenix' (Required): Type of linked service. -* **typeProperties**: [PhoenixLinkedServiceTypeProperties](#phoenixlinkedservicetypeproperties) (Required): Phoenix server linked service properties. +* **type**: 'SquareObject' (Required): Type of dataset. -### PostgreSqlLinkedService +### VerticaTableDataset #### Properties -* **type**: 'PostgreSql' (Required): Type of linked service. -* **typeProperties**: [PostgreSqlLinkedServiceTypeProperties](#postgresqllinkedservicetypeproperties) (Required): PostgreSQL linked service properties. +* **type**: 'VerticaTable' (Required): Type of dataset. -### PrestoLinkedService +### WebTableDataset #### Properties -* **type**: 'Presto' (Required): Type of linked service. -* **typeProperties**: [PrestoLinkedServiceTypeProperties](#prestolinkedservicetypeproperties) (Required): Presto server linked service properties. +* **type**: 'WebTable' (Required): Type of dataset. +* **typeProperties**: [WebTableDatasetTypeProperties](#webtabledatasettypeproperties) (Required): Web table dataset properties. -### QuickBooksLinkedService +### XeroObjectDataset #### Properties -* **type**: 'QuickBooks' (Required): Type of linked service. -* **typeProperties**: [QuickBooksLinkedServiceTypeProperties](#quickbookslinkedservicetypeproperties) (Required): QuickBooks server linked service properties. +* **type**: 'XeroObject' (Required): Type of dataset. -### ResponsysLinkedService +### ZohoObjectDataset #### Properties -* **type**: 'Responsys' (Required): Type of linked service. -* **typeProperties**: [ResponsysLinkedServiceTypeProperties](#responsyslinkedservicetypeproperties) (Required): Responsys linked service properties. +* **type**: 'ZohoObject' (Required): Type of dataset. -### SalesforceLinkedService -#### Properties -* **type**: 'Salesforce' (Required): Type of linked service. -* **typeProperties**: [SalesforceLinkedServiceTypeProperties](#salesforcelinkedservicetypeproperties) (Required): Salesforce linked service properties. -### SalesforceMarketingCloudLinkedService -#### Properties -* **type**: 'SalesforceMarketingCloud' (Required): Type of linked service. -* **typeProperties**: [SalesforceMarketingCloudLinkedServiceTypeProperties](#salesforcemarketingcloudlinkedservicetypeproperties) (Required): Salesforce Marketing Cloud linked service properties. +## DatasetCompression +* **Discriminator**: type -### SapBWLinkedService +### Base Properties +### DatasetBZip2Compression #### Properties -* **type**: 'SapBW' (Required): Type of linked service. -* **typeProperties**: [SapBWLinkedServiceTypeProperties](#sapbwlinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'BZip2' (Required): Type of dataset compression. -### SapCloudForCustomerLinkedService +### DatasetDeflateCompression #### Properties -* **type**: 'SapCloudForCustomer' (Required): Type of linked service. -* **typeProperties**: [SapCloudForCustomerLinkedServiceTypeProperties](#sapcloudforcustomerlinkedservicetypeproperties) (Required): SAP Cloud for Customer linked service properties. +* **level**: 'Fastest' | 'Optimal' | string: All available compression levels. +* **type**: 'Deflate' (Required): Type of dataset compression. -### SapEccLinkedService +### DatasetGZipCompression #### Properties -* **type**: 'SapEcc' (Required): Type of linked service. -* **typeProperties**: [SapEccLinkedServiceTypeProperties](#sapecclinkedservicetypeproperties) (Required): SAP ECC linked service properties. +* **level**: 'Fastest' | 'Optimal' | string: All available compression levels. +* **type**: 'GZip' (Required): Type of dataset compression. -### SapHanaLinkedService +### DatasetZipDeflateCompression #### Properties -* **type**: 'SapHana' (Required): Type of linked service. -* **typeProperties**: [SapHanaLinkedServiceProperties](#saphanalinkedserviceproperties) (Required): Properties specific to this linked service type. +* **level**: 'Fastest' | 'Optimal' | string: All available compression levels. +* **type**: 'ZipDeflate' (Required): Type of dataset compression. -### ServiceNowLinkedService -#### Properties -* **type**: 'ServiceNow' (Required): Type of linked service. -* **typeProperties**: [ServiceNowLinkedServiceTypeProperties](#servicenowlinkedservicetypeproperties) (Required): ServiceNow server linked service properties. -### SftpServerLinkedService -#### Properties -* **type**: 'Sftp' (Required): Type of linked service. -* **typeProperties**: [SftpServerLinkedServiceTypeProperties](#sftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. - -### ShopifyLinkedService -#### Properties -* **type**: 'Shopify' (Required): Type of linked service. -* **typeProperties**: [ShopifyLinkedServiceTypeProperties](#shopifylinkedservicetypeproperties) (Required): Shopify Service linked service properties. - -### SparkLinkedService -#### Properties -* **type**: 'Spark' (Required): Type of linked service. -* **typeProperties**: [SparkLinkedServiceTypeProperties](#sparklinkedservicetypeproperties) (Required): Spark Server linked service properties. - -### SqlServerLinkedService -#### Properties -* **type**: 'SqlServer' (Required): Type of linked service. -* **typeProperties**: [SqlServerLinkedServiceTypeProperties](#sqlserverlinkedservicetypeproperties) (Required): SQL Server linked service properties. - -### SquareLinkedService -#### Properties -* **type**: 'Square' (Required): Type of linked service. -* **typeProperties**: [SquareLinkedServiceTypeProperties](#squarelinkedservicetypeproperties) (Required): Square Service linked service properties. - -### SybaseLinkedService -#### Properties -* **type**: 'Sybase' (Required): Type of linked service. -* **typeProperties**: [SybaseLinkedServiceTypeProperties](#sybaselinkedservicetypeproperties) (Required): Sybase linked service properties. - -### TeradataLinkedService -#### Properties -* **type**: 'Teradata' (Required): Type of linked service. -* **typeProperties**: [TeradataLinkedServiceTypeProperties](#teradatalinkedservicetypeproperties) (Required): Teradata linked service properties. - -### VerticaLinkedService -#### Properties -* **type**: 'Vertica' (Required): Type of linked service. -* **typeProperties**: [VerticaLinkedServiceTypeProperties](#verticalinkedservicetypeproperties) (Required): Vertica linked service properties. - -### WebLinkedService -#### Properties -* **type**: 'Web' (Required): Type of linked service. -* **typeProperties**: [WebLinkedServiceTypeProperties](#weblinkedservicetypeproperties) (Required): Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models. - -### XeroLinkedService -#### Properties -* **type**: 'Xero' (Required): Type of linked service. -* **typeProperties**: [XeroLinkedServiceTypeProperties](#xerolinkedservicetypeproperties) (Required): Xero Service linked service properties. - -### ZohoLinkedService -#### Properties -* **type**: 'Zoho' (Required): Type of linked service. -* **typeProperties**: [ZohoLinkedServiceTypeProperties](#zoholinkedservicetypeproperties) (Required): Zoho server linked service properties. - - -## IntegrationRuntimeReference +## DatasetReference ### Properties * **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference integration runtime name. -* **type**: 'IntegrationRuntimeReference' | string (Required): Type of integration runtime. - -## ParameterValueSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## ParameterDefinitionSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) - -## AmazonMWSLinkedServiceTypeProperties -### Properties -* **accessKeyId**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **marketplaceID**: any (Required): Any object -* **mwsAuthToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **secretKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **sellerID**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **referenceName**: string (Required): Reference dataset name. +* **type**: 'DatasetReference' | string (Required): Dataset reference type. -## SecretBase +## DatasetStorageFormat * **Discriminator**: type ### Base Properties -### AzureKeyVaultSecretReference -#### Properties -* **secretName**: any (Required): Any object -* **secretVersion**: any: Any object -* **store**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **type**: 'AzureKeyVaultSecret' (Required): Type of the secret. - -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - +* **deserializer**: any: Any object +* **serializer**: any: Any object -## AmazonRedshiftLinkedServiceTypeProperties +## Db2LinkedServiceTypeProperties ### Properties +* **authenticationType**: 'Basic' | string: AuthenticationType to be used for connection. * **database**: any (Required): Any object * **encryptedCredential**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object * **server**: any (Required): Any object * **username**: any: Any object -## AmazonS3LinkedServiceTypeProperties +## DocumentDbCollectionDatasetTypeProperties ### Properties -* **accessKeyId**: any: Any object -* **encryptedCredential**: any: Any object -* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **collectionName**: any (Required): Any object -## AzureBatchLinkedServiceTypeProperties +## DrillLinkedServiceTypeProperties ### Properties -* **accessKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **accountName**: any (Required): Any object -* **batchUri**: any (Required): Any object +* **connectionString**: any: Any object * **encryptedCredential**: any: Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **poolName**: any (Required): Any object -## AzureDatabricksLinkedServiceTypeProperties +## DynamicsEntityDatasetTypeProperties ### Properties -* **accessToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **domain**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **existingClusterId**: any: Any object -* **newClusterNodeType**: any: Any object -* **newClusterNumOfWorker**: any: Any object -* **newClusterSparkConf**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf](#azuredatabrickslinkedservicetypepropertiesnewclustersparkconf): a set of optional, user-specified Spark configuration key-value pairs. -* **newClusterVersion**: any: Any object +* **entityName**: any: Any object -## AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf +## DynamicsLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **authenticationType**: 'Ifd' | 'Office365' | string (Required): 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). +* **deploymentType**: 'OnPremisesWithIfd' | 'Online' | string (Required): 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). +* **encryptedCredential**: any: Any object +* **hostName**: any: Any object +* **organizationName**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **serviceUri**: any: Any object +* **username**: any (Required): Any object -## AzureDataLakeAnalyticsLinkedServiceTypeProperties +## EloquaLinkedServiceTypeProperties ### Properties -* **accountName**: any (Required): Any object -* **dataLakeAnalyticsUri**: any: Any object * **encryptedCredential**: any: Any object -* **resourceGroupName**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **subscriptionId**: any: Any object -* **tenant**: any (Required): Any object +* **endpoint**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object -## AzureDataLakeStoreLinkedServiceTypeProperties +## EntityReference ### Properties -* **accountName**: any: Any object -* **dataLakeStoreUri**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **resourceGroupName**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **subscriptionId**: any: Any object -* **tenant**: any: Any object +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## AzureKeyVaultLinkedServiceTypeProperties +## ExecutePipelineActivityTypeProperties ### Properties -* **baseUrl**: any (Required): Any object +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **pipeline**: [PipelineReference](#pipelinereference) (Required): Pipeline reference type. +* **waitOnCompletion**: bool: Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false. -## AzureMLLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypeProperties ### Properties -* **apiKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **mlEndpoint**: any (Required): Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object -* **updateResourceEndpoint**: any: Any object +* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference) (Required): Integration runtime reference type. +* **environmentPath**: any: Any object +* **executionCredential**: [SsisExecutionCredential](#ssisexecutioncredential): SSIS package execution credential. +* **loggingLevel**: any: Any object +* **logLocation**: [SsisLogLocation](#ssisloglocation): SSIS package execution log location +* **packageConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers](#executessispackageactivitytypepropertiespackageconnectionmanagers): The package level connection managers to execute the SSIS package. +* **packageLocation**: [SsisPackageLocation](#ssispackagelocation) (Required): SSIS package location. +* **packageParameters**: [ExecuteSsisPackageActivityTypePropertiesPackageParameters](#executessispackageactivitytypepropertiespackageparameters): The package level parameters to execute the SSIS package. +* **projectConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers](#executessispackageactivitytypepropertiesprojectconnectionmanagers): The project level connection managers to execute the SSIS package. +* **projectParameters**: [ExecuteSsisPackageActivityTypePropertiesProjectParameters](#executessispackageactivitytypepropertiesprojectparameters): The project level parameters to execute the SSIS package. +* **propertyOverrides**: [ExecuteSsisPackageActivityTypePropertiesPropertyOverrides](#executessispackageactivitytypepropertiespropertyoverrides): The property overrides to execute the SSIS package. +* **runtime**: any: Any object -## AzureMySqlLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers ### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) -## AzurePostgreSqlLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesPackageParameters ### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## AzureSearchLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers ### Properties -* **encryptedCredential**: any: Any object -* **key**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object +### Additional Properties +* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) -## AzureSqlDatabaseLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesProjectParameters ### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## AzureSqlDWLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesPropertyOverrides ### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisPropertyOverride](#ssispropertyoverride) -## AzureStorageLinkedServiceTypeProperties +## Expression ### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **sasUri**: [SecretBase](#secretbase): The base definition of a secret type. +* **type**: 'Expression' | string (Required): Expression type. +* **value**: string (Required): Expression value. -## CassandraLinkedServiceTypeProperties +## FactoryIdentity ### Properties -* **authenticationType**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **username**: any: Any object +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'SystemAssigned' (Required): The identity type. Currently the only supported type is 'SystemAssigned'. -## ConcurLinkedServiceTypeProperties +## FactoryProperties ### Properties -* **clientId**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object - -## CosmosDbLinkedServiceTypeProperties -### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object +* **createTime**: string (ReadOnly): Time the factory was created in ISO8601 format. +* **provisioningState**: string (ReadOnly): Factory provisioning state, example Succeeded. +* **version**: string (ReadOnly): Version of the factory. +* **vstsConfiguration**: [FactoryVstsConfiguration](#factoryvstsconfiguration): Factory's VSTS repo information. -## CouchbaseLinkedServiceTypeProperties +## FactoryVstsConfiguration ### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object +* **accountName**: string: VSTS account name. +* **collaborationBranch**: string: VSTS collaboration branch. +* **lastCommitId**: string: VSTS last commit id. +* **projectName**: string: VSTS project name. +* **repositoryName**: string: VSTS repository name. +* **rootFolder**: string: VSTS root folder. +* **tenantId**: string: VSTS tenant id. -## Db2LinkedServiceTypeProperties +## FileServerLinkedServiceTypeProperties ### Properties -* **authenticationType**: 'Basic' | string: AuthenticationType to be used for connection. -* **database**: any (Required): Any object * **encryptedCredential**: any: Any object +* **host**: any (Required): Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any (Required): Any object -* **username**: any: Any object - -## DrillLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object +* **userId**: any: Any object -## DynamicsLinkedServiceTypeProperties +## FileShareDatasetTypeProperties ### Properties -* **authenticationType**: 'Ifd' | 'Office365' | string (Required): 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). -* **deploymentType**: 'OnPremisesWithIfd' | 'Online' | string (Required): 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). -* **encryptedCredential**: any: Any object -* **hostName**: any: Any object -* **organizationName**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **serviceUri**: any: Any object -* **username**: any (Required): Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileFilter**: any: Any object +* **fileName**: any: Any object +* **folderPath**: any: Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -## EloquaLinkedServiceTypeProperties +## FilterActivityTypeProperties ### Properties -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object +* **condition**: [Expression](#expression) (Required): Azure Data Factory expression definition. +* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. -## FileServerLinkedServiceTypeProperties +## ForEachActivityTypeProperties ### Properties -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userId**: any: Any object +* **activities**: [Activity](#activity)[] (Required): List of activities to execute . +* **batchCount**: int: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false). +* **isSequential**: bool: Should the loop be executed in sequence or in parallel (max 50) +* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. ## FtpServerLinkedServiceTypeProperties ### Properties @@ -1198,6 +940,11 @@ * **port**: any: Any object * **userName**: any: Any object +## GetMetadataActivityTypeProperties +### Properties +* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. +* **fieldList**: any[]: Fields of metadata to get from dataset. + ## GoogleBigQueryLinkedServiceTypeProperties ### Properties * **additionalProjects**: any: Any object @@ -1240,6 +987,20 @@ * **url**: any (Required): Any object * **userName**: any: Any object +## HDInsightHiveActivityTypeProperties +### Properties +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **defines**: [HDInsightHiveActivityTypePropertiesDefines](#hdinsighthiveactivitytypepropertiesdefines): Allows user to specify defines for Hive job request. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **scriptPath**: any: Any object +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. + +## HDInsightHiveActivityTypePropertiesDefines +### Properties +### Additional Properties +* **Additional Properties Type**: any + ## HDInsightLinkedServiceTypeProperties ### Properties * **clusterUri**: any (Required): Any object @@ -1249,6 +1010,22 @@ * **password**: [SecretBase](#secretbase): The base definition of a secret type. * **userName**: any: Any object +## HDInsightMapReduceActivityTypeProperties +### Properties +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **className**: any (Required): Any object +* **defines**: [HDInsightMapReduceActivityTypePropertiesDefines](#hdinsightmapreduceactivitytypepropertiesdefines): Allows user to specify defines for the MapReduce job request. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **jarFilePath**: any (Required): Any object +* **jarLibs**: any[]: Jar libs. +* **jarLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. + +## HDInsightMapReduceActivityTypePropertiesDefines +### Properties +### Additional Properties +* **Additional Properties Type**: any + ## HDInsightOnDemandLinkedServiceTypeProperties ### Properties * **additionalLinkedServiceNames**: [LinkedServiceReference](#linkedservicereference)[]: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. @@ -1282,6 +1059,56 @@ * **yarnConfiguration**: any: Any object * **zookeeperNodeSize**: any: Any object +## HDInsightPigActivityTypeProperties +### Properties +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **defines**: [HDInsightPigActivityTypePropertiesDefines](#hdinsightpigactivitytypepropertiesdefines): Allows user to specify defines for Pig job request. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **scriptPath**: any: Any object +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. + +## HDInsightPigActivityTypePropertiesDefines +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## HDInsightSparkActivityTypeProperties +### Properties +* **arguments**: any[]: The user-specified arguments to HDInsightSparkActivity. +* **className**: string: The application's Java/Spark main class. +* **entryFilePath**: any (Required): Any object +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **proxyUser**: any: Any object +* **rootPath**: any (Required): Any object +* **sparkConfig**: [HDInsightSparkActivityTypePropertiesSparkConfig](#hdinsightsparkactivitytypepropertiessparkconfig): Spark configuration property. +* **sparkJobLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. + +## HDInsightSparkActivityTypePropertiesSparkConfig +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## HDInsightStreamingActivityTypeProperties +### Properties +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **combiner**: any: Any object +* **commandEnvironment**: any[]: Command line environment values. +* **defines**: [HDInsightStreamingActivityTypePropertiesDefines](#hdinsightstreamingactivitytypepropertiesdefines): Allows user to specify defines for streaming job request. +* **fileLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **filePaths**: any[] (Required): Paths to streaming job files. Can be directories. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **input**: any (Required): Any object +* **mapper**: any (Required): Any object +* **output**: any (Required): Any object +* **reducer**: any (Required): Any object +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. + +## HDInsightStreamingActivityTypePropertiesDefines +### Properties +### Additional Properties +* **Additional Properties Type**: any + ## HiveLinkedServiceTypeProperties ### Properties * **allowHostNameCNMismatch**: any: Any object @@ -1302,6 +1129,15 @@ * **useSystemTrustStore**: any: Any object * **zooKeeperNameSpace**: any: Any object +## HttpDatasetTypeProperties +### Properties +* **additionalHeaders**: any: Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **relativeUrl**: any: Any object +* **requestBody**: any: Any object +* **requestMethod**: any: Any object + ## HttpLinkedServiceTypeProperties ### Properties * **authenticationType**: 'Anonymous' | 'Basic' | 'ClientCertificate' | 'Digest' | 'Windows' | string: The authentication type to be used to connect to the HTTP server. @@ -1324,6 +1160,12 @@ * **useHostVerification**: any: Any object * **usePeerVerification**: any: Any object +## IfConditionActivityTypeProperties +### Properties +* **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. +* **ifFalseActivities**: [Activity](#activity)[]: 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. +* **ifTrueActivities**: [Activity](#activity)[]: 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. + ## ImpalaLinkedServiceTypeProperties ### Properties * **allowHostNameCNMismatch**: any: Any object @@ -1338,840 +1180,979 @@ * **username**: any: Any object * **useSystemTrustStore**: any: Any object -## JiraLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object +## IntegrationRuntime +* **Discriminator**: type -## MagentoLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### Base Properties +* **description**: string: Integration runtime description. +### ManagedIntegrationRuntime +#### Properties +* **state**: 'Initial' | 'Limited' | 'NeedRegistration' | 'Offline' | 'Online' | 'Started' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The state of integration runtime. +* **type**: 'Managed' (Required): Type of integration runtime. +* **typeProperties**: [ManagedIntegrationRuntimeTypeProperties](#managedintegrationruntimetypeproperties) (Required): Managed integration runtime type properties. -## MariaDBLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object +### SelfHostedIntegrationRuntime +#### Properties +* **type**: 'SelfHosted' (Required): Type of integration runtime. +* **typeProperties**: [LinkedIntegrationRuntimeTypeProperties](#linkedintegrationruntimetypeproperties) (Required): The base definition of a secret type. -## MarketoLinkedServiceTypeProperties + +## IntegrationRuntimeAuthKeys ### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. -## MongoDbLinkedServiceTypeProperties +## IntegrationRuntimeComputeProperties ### Properties -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'Basic' | string: The authentication type to be used to connect to the MongoDB database. -* **authSource**: any: Any object -* **databaseName**: any (Required): Any object -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **server**: any (Required): Any object -* **username**: any: Any object +* **location**: 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 +* **maxParallelExecutionsPerNode**: int: Maximum parallel executions count per node for managed integration runtime. +* **nodeSize**: string: The node size requirement to managed integration runtime. +* **numberOfNodes**: int: The required number of nodes for managed integration runtime. +* **vNetProperties**: [IntegrationRuntimeVNetProperties](#integrationruntimevnetproperties): VNet properties for managed integration runtime. +### Additional Properties +* **Additional Properties Type**: any -## MySqlLinkedServiceTypeProperties +## IntegrationRuntimeCustomSetupScriptProperties ### Properties -* **connectionString**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **encryptedCredential**: any: Any object +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -## NetezzaLinkedServiceTypeProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. -## ODataLinkedServiceTypeProperties +## IntegrationRuntimeReference ### Properties -* **authenticationType**: 'Anonymous' | 'Basic' | string: Type of authentication used to connect to the OData service. -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object -* **userName**: any: Any object +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **referenceName**: string (Required): Reference integration runtime name. +* **type**: 'IntegrationRuntimeReference' | string (Required): Type of integration runtime. -## OdbcLinkedServiceTypeProperties +## IntegrationRuntimeSsisCatalogInfo ### Properties -* **authenticationType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +* **catalogAdminPassword**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. +### Additional Properties +* **Additional Properties Type**: any -## OracleLinkedServiceTypeProperties +## IntegrationRuntimeSsisProperties ### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object +* **catalogInfo**: [IntegrationRuntimeSsisCatalogInfo](#integrationruntimessiscataloginfo): Catalog information for managed dedicated integration runtime. +* **customSetupScriptProperties**: [IntegrationRuntimeCustomSetupScriptProperties](#integrationruntimecustomsetupscriptproperties): Custom setup script properties for a managed dedicated integration runtime. +* **dataProxyProperties**: [IntegrationRuntimeDataProxyProperties](#integrationruntimedataproxyproperties): Data proxy properties for a managed dedicated integration runtime. +* **edition**: 'Enterprise' | 'Standard' | string: The edition for the SSIS Integration Runtime +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: License type for bringing your own license scenario. +### Additional Properties +* **Additional Properties Type**: any -## PaypalLinkedServiceTypeProperties +## IntegrationRuntimeVNetProperties ### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **subnet**: string: The name of the subnet this integration runtime will join. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. +### Additional Properties +* **Additional Properties Type**: any -## PhoenixLinkedServiceTypeProperties +## JiraLinkedServiceTypeProperties ### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication mechanism used to connect to the Phoenix server. -* **enableSsl**: any: Any object * **encryptedCredential**: any: Any object * **host**: any (Required): Any object -* **httpPath**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. * **port**: any: Any object -* **trustedCertPath**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object -## PostgreSqlLinkedServiceTypeProperties -### Properties -* **connectionString**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **encryptedCredential**: any: Any object +## LinkedIntegrationRuntimeProperties +* **Discriminator**: authorizationType -## PrestoLinkedServiceTypeProperties -### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'LDAP' | string (Required): The authentication mechanism used to connect to the Presto server. -* **catalog**: any (Required): Any object -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **serverVersion**: any (Required): Any object -* **timeZoneID**: any: Any object -* **trustedCertPath**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object +### Base Properties +### LinkedIntegrationRuntimeKey +#### Properties +* **authorizationType**: 'Key' (Required): Type of the secret. +* **key**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -## QuickBooksLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **accessTokenSecret**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **companyId**: any (Required): Any object -* **consumerKey**: any (Required): Any object -* **consumerSecret**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object +### LinkedIntegrationRuntimeRbac +#### Properties +* **authorizationType**: 'RBAC' (Required): Type of the secret. +* **resourceId**: string (Required): The resource ID of the integration runtime to be shared. -## ResponsysLinkedServiceTypeProperties -### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -## SalesforceLinkedServiceTypeProperties +## LinkedIntegrationRuntimeTypeProperties ### Properties -* **encryptedCredential**: any: Any object -* **environmentUrl**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **securityToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **username**: any: Any object +* **linkedInfo**: [LinkedIntegrationRuntimeProperties](#linkedintegrationruntimeproperties): The base definition of a secret type. -## SalesforceMarketingCloudLinkedServiceTypeProperties -### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +## LinkedService +* **Discriminator**: type -## SapBWLinkedServiceTypeProperties -### Properties -* **clientId**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any (Required): Any object -* **systemNumber**: any (Required): Any object -* **userName**: any: Any object +### Base Properties +* **annotations**: any[]: List of tags that can be used for describing the Dataset. +* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. +* **description**: string: Linked service description. +* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. +### AmazonMWSLinkedService +#### Properties +* **type**: 'AmazonMWS' (Required): Type of linked service. +* **typeProperties**: [AmazonMWSLinkedServiceTypeProperties](#amazonmwslinkedservicetypeproperties) (Required): Amazon Marketplace Web Service linked service properties. -## SapCloudForCustomerLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object -* **username**: any: Any object +### AmazonRedshiftLinkedService +#### Properties +* **type**: 'AmazonRedshift' (Required): Type of linked service. +* **typeProperties**: [AmazonRedshiftLinkedServiceTypeProperties](#amazonredshiftlinkedservicetypeproperties) (Required): Amazon Redshift linked service properties. -## SapEccLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: string: 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). -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: string (Required): The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). -* **username**: string: The username for Basic authentication. Type: string (or Expression with resultType string). +### AmazonS3LinkedService +#### Properties +* **type**: 'AmazonS3' (Required): Type of linked service. +* **typeProperties**: [AmazonS3LinkedServiceTypeProperties](#amazons3linkedservicetypeproperties) (Required): Amazon S3 linked service properties. -## SapHanaLinkedServiceProperties -### Properties -* **authenticationType**: 'Basic' | 'Windows' | string: The authentication type to be used to connect to the SAP HANA server. -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any (Required): Any object -* **userName**: any: Any object +### AzureBatchLinkedService +#### Properties +* **type**: 'AzureBatch' (Required): Type of linked service. +* **typeProperties**: [AzureBatchLinkedServiceTypeProperties](#azurebatchlinkedservicetypeproperties) (Required): Azure Batch linked service properties. -## ServiceNowLinkedServiceTypeProperties -### Properties -* **authenticationType**: 'Basic' | 'OAuth2' | string (Required): The authentication type to use. -* **clientId**: any: Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any: Any object +### AzureDatabricksLinkedService +#### Properties +* **type**: 'AzureDatabricks' (Required): Type of linked service. +* **typeProperties**: [AzureDatabricksLinkedServiceTypeProperties](#azuredatabrickslinkedservicetypeproperties) (Required): Azure Databricks linked service properties. -## SftpServerLinkedServiceTypeProperties -### Properties -* **authenticationType**: 'Basic' | 'SshPublicKey' | string: The authentication type to be used to connect to the FTP server. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **hostKeyFingerprint**: any: Any object -* **passPhrase**: [SecretBase](#secretbase): The base definition of a secret type. -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **privateKeyContent**: [SecretBase](#secretbase): The base definition of a secret type. -* **privateKeyPath**: any: Any object -* **skipHostKeyValidation**: any: Any object -* **userName**: any: Any object +### AzureDataLakeAnalyticsLinkedService +#### Properties +* **type**: 'AzureDataLakeAnalytics' (Required): Type of linked service. +* **typeProperties**: [AzureDataLakeAnalyticsLinkedServiceTypeProperties](#azuredatalakeanalyticslinkedservicetypeproperties) (Required): Azure Data Lake Analytics linked service properties. + +### AzureDataLakeStoreLinkedService +#### Properties +* **type**: 'AzureDataLakeStore' (Required): Type of linked service. +* **typeProperties**: [AzureDataLakeStoreLinkedServiceTypeProperties](#azuredatalakestorelinkedservicetypeproperties) (Required): Azure Data Lake Store linked service properties. + +### AzureKeyVaultLinkedService +#### Properties +* **type**: 'AzureKeyVault' (Required): Type of linked service. +* **typeProperties**: [AzureKeyVaultLinkedServiceTypeProperties](#azurekeyvaultlinkedservicetypeproperties) (Required): Azure Key Vault linked service properties. + +### AzureMLLinkedService +#### Properties +* **type**: 'AzureML' (Required): Type of linked service. +* **typeProperties**: [AzureMLLinkedServiceTypeProperties](#azuremllinkedservicetypeproperties) (Required): Azure ML Web Service linked service properties. + +### AzureMySqlLinkedService +#### Properties +* **type**: 'AzureMySql' (Required): Type of linked service. +* **typeProperties**: [AzureMySqlLinkedServiceTypeProperties](#azuremysqllinkedservicetypeproperties) (Required): Azure MySQL database linked service properties. + +### AzurePostgreSqlLinkedService +#### Properties +* **type**: 'AzurePostgreSql' (Required): Type of linked service. +* **typeProperties**: [AzurePostgreSqlLinkedServiceTypeProperties](#azurepostgresqllinkedservicetypeproperties) (Required): Azure PostgreSQL linked service properties. + +### AzureSearchLinkedService +#### Properties +* **type**: 'AzureSearch' (Required): Type of linked service. +* **typeProperties**: [AzureSearchLinkedServiceTypeProperties](#azuresearchlinkedservicetypeproperties) (Required): Windows Azure Search Service linked service properties. + +### AzureSqlDatabaseLinkedService +#### Properties +* **type**: 'AzureSqlDatabase' (Required): Type of linked service. +* **typeProperties**: [AzureSqlDatabaseLinkedServiceTypeProperties](#azuresqldatabaselinkedservicetypeproperties) (Required): Azure SQL Database linked service properties. + +### AzureSqlDWLinkedService +#### Properties +* **type**: 'AzureSqlDW' (Required): Type of linked service. +* **typeProperties**: [AzureSqlDWLinkedServiceTypeProperties](#azuresqldwlinkedservicetypeproperties) (Required): Azure SQL Data Warehouse linked service properties. + +### AzureStorageLinkedService +#### Properties +* **type**: 'AzureStorage' (Required): Type of linked service. +* **typeProperties**: [AzureStorageLinkedServiceTypeProperties](#azurestoragelinkedservicetypeproperties) (Required): Azure Storage linked service properties. + +### CassandraLinkedService +#### Properties +* **type**: 'Cassandra' (Required): Type of linked service. +* **typeProperties**: [CassandraLinkedServiceTypeProperties](#cassandralinkedservicetypeproperties) (Required): Cassandra linked service properties. + +### ConcurLinkedService +#### Properties +* **type**: 'Concur' (Required): Type of linked service. +* **typeProperties**: [ConcurLinkedServiceTypeProperties](#concurlinkedservicetypeproperties) (Required): Concur Service linked service properties. + +### CosmosDbLinkedService +#### Properties +* **type**: 'CosmosDb' (Required): Type of linked service. +* **typeProperties**: [CosmosDbLinkedServiceTypeProperties](#cosmosdblinkedservicetypeproperties) (Required): CosmosDB linked service properties. + +### CouchbaseLinkedService +#### Properties +* **type**: 'Couchbase' (Required): Type of linked service. +* **typeProperties**: [CouchbaseLinkedServiceTypeProperties](#couchbaselinkedservicetypeproperties) (Required): Couchbase server linked service properties. + +### CustomDataSourceLinkedService +#### Properties +* **type**: 'CustomDataSource' (Required): Type of linked service. +* **typeProperties**: any (Required): Any object + +### Db2LinkedService +#### Properties +* **type**: 'Db2' (Required): Type of linked service. +* **typeProperties**: [Db2LinkedServiceTypeProperties](#db2linkedservicetypeproperties) (Required): DB2 linked service properties. + +### DrillLinkedService +#### Properties +* **type**: 'Drill' (Required): Type of linked service. +* **typeProperties**: [DrillLinkedServiceTypeProperties](#drilllinkedservicetypeproperties) (Required): Drill server linked service properties. + +### DynamicsLinkedService +#### Properties +* **type**: 'Dynamics' (Required): Type of linked service. +* **typeProperties**: [DynamicsLinkedServiceTypeProperties](#dynamicslinkedservicetypeproperties) (Required): Dynamics linked service properties. + +### EloquaLinkedService +#### Properties +* **type**: 'Eloqua' (Required): Type of linked service. +* **typeProperties**: [EloquaLinkedServiceTypeProperties](#eloqualinkedservicetypeproperties) (Required): Eloqua server linked service properties. + +### FileServerLinkedService +#### Properties +* **type**: 'FileServer' (Required): Type of linked service. +* **typeProperties**: [FileServerLinkedServiceTypeProperties](#fileserverlinkedservicetypeproperties) (Required): File system linked service properties. + +### FtpServerLinkedService +#### Properties +* **type**: 'FtpServer' (Required): Type of linked service. +* **typeProperties**: [FtpServerLinkedServiceTypeProperties](#ftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. + +### GoogleBigQueryLinkedService +#### Properties +* **type**: 'GoogleBigQuery' (Required): Type of linked service. +* **typeProperties**: [GoogleBigQueryLinkedServiceTypeProperties](#googlebigquerylinkedservicetypeproperties) (Required): Google BigQuery service linked service properties. + +### GreenplumLinkedService +#### Properties +* **type**: 'Greenplum' (Required): Type of linked service. +* **typeProperties**: [GreenplumLinkedServiceTypeProperties](#greenplumlinkedservicetypeproperties) (Required): Greenplum Database linked service properties. + +### HBaseLinkedService +#### Properties +* **type**: 'HBase' (Required): Type of linked service. +* **typeProperties**: [HBaseLinkedServiceTypeProperties](#hbaselinkedservicetypeproperties) (Required): HBase server linked service properties. -## ShopifyLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### HdfsLinkedService +#### Properties +* **type**: 'Hdfs' (Required): Type of linked service. +* **typeProperties**: [HdfsLinkedServiceTypeProperties](#hdfslinkedservicetypeproperties) (Required): HDFS linked service properties. -## SparkLinkedServiceTypeProperties -### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'Username' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication method used to access the Spark server. -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **httpPath**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any (Required): Any object -* **serverType**: 'SharkServer' | 'SharkServer2' | 'SparkThriftServer' | string: The type of Spark server. -* **thriftTransportProtocol**: 'Binary' | 'HTTP ' | 'SASL' | string: The transport protocol to use in the Thrift layer. -* **trustedCertPath**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object +### HDInsightLinkedService +#### Properties +* **type**: 'HDInsight' (Required): Type of linked service. +* **typeProperties**: [HDInsightLinkedServiceTypeProperties](#hdinsightlinkedservicetypeproperties) (Required): HDInsight linked service properties. -## SqlServerLinkedServiceTypeProperties -### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +### HDInsightOnDemandLinkedService +#### Properties +* **type**: 'HDInsightOnDemand' (Required): Type of linked service. +* **typeProperties**: [HDInsightOnDemandLinkedServiceTypeProperties](#hdinsightondemandlinkedservicetypeproperties) (Required): HDInsight ondemand linked service properties. -## SquareLinkedServiceTypeProperties -### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **redirectUri**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### HiveLinkedService +#### Properties +* **type**: 'Hive' (Required): Type of linked service. +* **typeProperties**: [HiveLinkedServiceTypeProperties](#hivelinkedservicetypeproperties) (Required): Hive Server linked service properties. -## SybaseLinkedServiceTypeProperties -### Properties -* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. -* **database**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **schema**: any: Any object -* **server**: any (Required): Any object -* **username**: any: Any object +### HttpLinkedService +#### Properties +* **type**: 'HttpServer' (Required): Type of linked service. +* **typeProperties**: [HttpLinkedServiceTypeProperties](#httplinkedservicetypeproperties) (Required): Properties specific to this linked service type. -## TeradataLinkedServiceTypeProperties -### Properties -* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any (Required): Any object -* **username**: any: Any object +### HubspotLinkedService +#### Properties +* **type**: 'Hubspot' (Required): Type of linked service. +* **typeProperties**: [HubspotLinkedServiceTypeProperties](#hubspotlinkedservicetypeproperties) (Required): Hubspot Service linked service properties. -## VerticaLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object +### ImpalaLinkedService +#### Properties +* **type**: 'Impala' (Required): Type of linked service. +* **typeProperties**: [ImpalaLinkedServiceTypeProperties](#impalalinkedservicetypeproperties) (Required): Impala server linked service properties. -## WebLinkedServiceTypeProperties -* **Discriminator**: authenticationType +### JiraLinkedService +#### Properties +* **type**: 'Jira' (Required): Type of linked service. +* **typeProperties**: [JiraLinkedServiceTypeProperties](#jiralinkedservicetypeproperties) (Required): Jira Service linked service properties. -### Base Properties -* **url**: any (Required): Any object -### WebAnonymousAuthentication +### MagentoLinkedService #### Properties -* **authenticationType**: 'Anonymous' (Required): Type of authentication used to connect to the web table source. +* **type**: 'Magento' (Required): Type of linked service. +* **typeProperties**: [MagentoLinkedServiceTypeProperties](#magentolinkedservicetypeproperties) (Required): Magento server linked service properties. -### WebBasicAuthentication +### MariaDBLinkedService #### Properties -* **authenticationType**: 'Basic' (Required): Type of authentication used to connect to the web table source. -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **username**: any (Required): Any object +* **type**: 'MariaDB' (Required): Type of linked service. +* **typeProperties**: [MariaDBLinkedServiceTypeProperties](#mariadblinkedservicetypeproperties) (Required): MariaDB server linked service properties. -### WebClientCertificateAuthentication +### MarketoLinkedService #### Properties -* **authenticationType**: 'ClientCertificate' (Required): Type of authentication used to connect to the web table source. -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **pfx**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **type**: 'Marketo' (Required): Type of linked service. +* **typeProperties**: [MarketoLinkedServiceTypeProperties](#marketolinkedservicetypeproperties) (Required): Marketo server linked service properties. +### MongoDbLinkedService +#### Properties +* **type**: 'MongoDb' (Required): Type of linked service. +* **typeProperties**: [MongoDbLinkedServiceTypeProperties](#mongodblinkedservicetypeproperties) (Required): MongoDB linked service properties. -## XeroLinkedServiceTypeProperties -### Properties -* **consumerKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **privateKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### MySqlLinkedService +#### Properties +* **type**: 'MySql' (Required): Type of linked service. +* **typeProperties**: [MySqlLinkedServiceTypeProperties](#mysqllinkedservicetypeproperties) (Required): MySQL linked service properties. -## ZohoLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### NetezzaLinkedService +#### Properties +* **type**: 'Netezza' (Required): Type of linked service. +* **typeProperties**: [NetezzaLinkedServiceTypeProperties](#netezzalinkedservicetypeproperties) (Required): Netezza linked service properties. -## Pipeline -### Properties -* **activities**: [Activity](#activity)[]: List of activities in pipeline. -* **annotations**: any[]: List of tags that can be used for describing the Pipeline. -* **concurrency**: int: The max number of concurrent runs for the pipeline. -* **description**: string: The description of the pipeline. -* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. +### ODataLinkedService +#### Properties +* **type**: 'OData' (Required): Type of linked service. +* **typeProperties**: [ODataLinkedServiceTypeProperties](#odatalinkedservicetypeproperties) (Required): OData linked service properties. -## Activity -* **Discriminator**: type +### OdbcLinkedService +#### Properties +* **type**: 'Odbc' (Required): Type of linked service. +* **typeProperties**: [OdbcLinkedServiceTypeProperties](#odbclinkedservicetypeproperties) (Required): ODBC linked service properties. -### Base Properties -* **dependsOn**: [ActivityDependency](#activitydependency)[]: Activity depends on condition. -* **description**: string: Activity description. -* **name**: string (Required): Activity name. -### AzureMLBatchExecutionActivity +### OracleLinkedService #### Properties -* **type**: 'AzureMLBatchExecution' (Required): Type of activity. -* **typeProperties**: [AzureMLBatchExecutionActivityTypeProperties](#azuremlbatchexecutionactivitytypeproperties) (Required): Azure ML Batch Execution activity properties. +* **type**: 'Oracle' (Required): Type of linked service. +* **typeProperties**: [OracleLinkedServiceTypeProperties](#oraclelinkedservicetypeproperties) (Required): Oracle database linked service properties. -### AzureMLUpdateResourceActivity +### PaypalLinkedService #### Properties -* **type**: 'AzureMLUpdateResource' (Required): Type of activity. -* **typeProperties**: [AzureMLUpdateResourceActivityTypeProperties](#azuremlupdateresourceactivitytypeproperties) (Required): Azure ML Update Resource activity properties. +* **type**: 'Paypal' (Required): Type of linked service. +* **typeProperties**: [PaypalLinkedServiceTypeProperties](#paypallinkedservicetypeproperties) (Required): Paypal Service linked service properties. -### CopyActivity +### PhoenixLinkedService #### Properties -* **inputs**: [DatasetReference](#datasetreference)[]: List of inputs for the activity. -* **outputs**: [DatasetReference](#datasetreference)[]: List of outputs for the activity. -* **type**: 'Copy' (Required): Type of activity. -* **typeProperties**: [CopyActivityTypeProperties](#copyactivitytypeproperties) (Required): Copy activity properties. +* **type**: 'Phoenix' (Required): Type of linked service. +* **typeProperties**: [PhoenixLinkedServiceTypeProperties](#phoenixlinkedservicetypeproperties) (Required): Phoenix server linked service properties. -### CustomActivity +### PostgreSqlLinkedService #### Properties -* **type**: 'Custom' (Required): Type of activity. -* **typeProperties**: [CustomActivityTypeProperties](#customactivitytypeproperties) (Required): Custom activity properties. +* **type**: 'PostgreSql' (Required): Type of linked service. +* **typeProperties**: [PostgreSqlLinkedServiceTypeProperties](#postgresqllinkedservicetypeproperties) (Required): PostgreSQL linked service properties. -### DatabricksNotebookActivity +### PrestoLinkedService #### Properties -* **type**: 'DatabricksNotebook' (Required): Type of activity. -* **typeProperties**: [DatabricksNotebookActivityTypeProperties](#databricksnotebookactivitytypeproperties) (Required): Databricks Notebook activity properties. +* **type**: 'Presto' (Required): Type of linked service. +* **typeProperties**: [PrestoLinkedServiceTypeProperties](#prestolinkedservicetypeproperties) (Required): Presto server linked service properties. -### DataLakeAnalyticsUsqlActivity +### QuickBooksLinkedService #### Properties -* **type**: 'DataLakeAnalyticsU-SQL' (Required): Type of activity. -* **typeProperties**: [DataLakeAnalyticsUsqlActivityTypeProperties](#datalakeanalyticsusqlactivitytypeproperties) (Required): DataLakeAnalyticsU-SQL activity properties. +* **type**: 'QuickBooks' (Required): Type of linked service. +* **typeProperties**: [QuickBooksLinkedServiceTypeProperties](#quickbookslinkedservicetypeproperties) (Required): QuickBooks server linked service properties. -### ExecutePipelineActivity +### ResponsysLinkedService #### Properties -* **type**: 'ExecutePipeline' (Required): Type of activity. -* **typeProperties**: [ExecutePipelineActivityTypeProperties](#executepipelineactivitytypeproperties) (Required): Execute pipeline activity properties. +* **type**: 'Responsys' (Required): Type of linked service. +* **typeProperties**: [ResponsysLinkedServiceTypeProperties](#responsyslinkedservicetypeproperties) (Required): Responsys linked service properties. -### ExecuteSsisPackageActivity +### SalesforceLinkedService #### Properties -* **type**: 'ExecuteSSISPackage' (Required): Type of activity. -* **typeProperties**: [ExecuteSsisPackageActivityTypeProperties](#executessispackageactivitytypeproperties) (Required): Execute SSIS package activity properties. +* **type**: 'Salesforce' (Required): Type of linked service. +* **typeProperties**: [SalesforceLinkedServiceTypeProperties](#salesforcelinkedservicetypeproperties) (Required): Salesforce linked service properties. -### FilterActivity +### SalesforceMarketingCloudLinkedService #### Properties -* **type**: 'Filter' (Required): Type of activity. -* **typeProperties**: [FilterActivityTypeProperties](#filteractivitytypeproperties) (Required): Filter activity properties. +* **type**: 'SalesforceMarketingCloud' (Required): Type of linked service. +* **typeProperties**: [SalesforceMarketingCloudLinkedServiceTypeProperties](#salesforcemarketingcloudlinkedservicetypeproperties) (Required): Salesforce Marketing Cloud linked service properties. -### ForEachActivity +### SapBWLinkedService #### Properties -* **type**: 'ForEach' (Required): Type of activity. -* **typeProperties**: [ForEachActivityTypeProperties](#foreachactivitytypeproperties) (Required): ForEach activity properties. +* **type**: 'SapBW' (Required): Type of linked service. +* **typeProperties**: [SapBWLinkedServiceTypeProperties](#sapbwlinkedservicetypeproperties) (Required): Properties specific to this linked service type. -### GetMetadataActivity +### SapCloudForCustomerLinkedService #### Properties -* **type**: 'GetMetadata' (Required): Type of activity. -* **typeProperties**: [GetMetadataActivityTypeProperties](#getmetadataactivitytypeproperties) (Required): GetMetadata activity properties. +* **type**: 'SapCloudForCustomer' (Required): Type of linked service. +* **typeProperties**: [SapCloudForCustomerLinkedServiceTypeProperties](#sapcloudforcustomerlinkedservicetypeproperties) (Required): SAP Cloud for Customer linked service properties. -### HDInsightHiveActivity +### SapEccLinkedService #### Properties -* **type**: 'HDInsightHive' (Required): Type of activity. -* **typeProperties**: [HDInsightHiveActivityTypeProperties](#hdinsighthiveactivitytypeproperties) (Required): HDInsight Hive activity properties. +* **type**: 'SapEcc' (Required): Type of linked service. +* **typeProperties**: [SapEccLinkedServiceTypeProperties](#sapecclinkedservicetypeproperties) (Required): SAP ECC linked service properties. -### HDInsightMapReduceActivity +### SapHanaLinkedService +#### Properties +* **type**: 'SapHana' (Required): Type of linked service. +* **typeProperties**: [SapHanaLinkedServiceProperties](#saphanalinkedserviceproperties) (Required): Properties specific to this linked service type. + +### ServiceNowLinkedService +#### Properties +* **type**: 'ServiceNow' (Required): Type of linked service. +* **typeProperties**: [ServiceNowLinkedServiceTypeProperties](#servicenowlinkedservicetypeproperties) (Required): ServiceNow server linked service properties. + +### SftpServerLinkedService +#### Properties +* **type**: 'Sftp' (Required): Type of linked service. +* **typeProperties**: [SftpServerLinkedServiceTypeProperties](#sftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. + +### ShopifyLinkedService #### Properties -* **type**: 'HDInsightMapReduce' (Required): Type of activity. -* **typeProperties**: [HDInsightMapReduceActivityTypeProperties](#hdinsightmapreduceactivitytypeproperties) (Required): HDInsight MapReduce activity properties. +* **type**: 'Shopify' (Required): Type of linked service. +* **typeProperties**: [ShopifyLinkedServiceTypeProperties](#shopifylinkedservicetypeproperties) (Required): Shopify Service linked service properties. -### HDInsightPigActivity +### SparkLinkedService #### Properties -* **type**: 'HDInsightPig' (Required): Type of activity. -* **typeProperties**: [HDInsightPigActivityTypeProperties](#hdinsightpigactivitytypeproperties) (Required): HDInsight Pig activity properties. +* **type**: 'Spark' (Required): Type of linked service. +* **typeProperties**: [SparkLinkedServiceTypeProperties](#sparklinkedservicetypeproperties) (Required): Spark Server linked service properties. -### HDInsightSparkActivity +### SqlServerLinkedService #### Properties -* **type**: 'HDInsightSpark' (Required): Type of activity. -* **typeProperties**: [HDInsightSparkActivityTypeProperties](#hdinsightsparkactivitytypeproperties) (Required): HDInsight spark activity properties. +* **type**: 'SqlServer' (Required): Type of linked service. +* **typeProperties**: [SqlServerLinkedServiceTypeProperties](#sqlserverlinkedservicetypeproperties) (Required): SQL Server linked service properties. -### HDInsightStreamingActivity +### SquareLinkedService #### Properties -* **type**: 'HDInsightStreaming' (Required): Type of activity. -* **typeProperties**: [HDInsightStreamingActivityTypeProperties](#hdinsightstreamingactivitytypeproperties) (Required): HDInsight streaming activity properties. +* **type**: 'Square' (Required): Type of linked service. +* **typeProperties**: [SquareLinkedServiceTypeProperties](#squarelinkedservicetypeproperties) (Required): Square Service linked service properties. -### IfConditionActivity +### SybaseLinkedService #### Properties -* **type**: 'IfCondition' (Required): Type of activity. -* **typeProperties**: [IfConditionActivityTypeProperties](#ifconditionactivitytypeproperties) (Required): IfCondition activity properties. +* **type**: 'Sybase' (Required): Type of linked service. +* **typeProperties**: [SybaseLinkedServiceTypeProperties](#sybaselinkedservicetypeproperties) (Required): Sybase linked service properties. -### LookupActivity +### TeradataLinkedService #### Properties -* **type**: 'Lookup' (Required): Type of activity. -* **typeProperties**: [LookupActivityTypeProperties](#lookupactivitytypeproperties) (Required): Lookup activity properties. +* **type**: 'Teradata' (Required): Type of linked service. +* **typeProperties**: [TeradataLinkedServiceTypeProperties](#teradatalinkedservicetypeproperties) (Required): Teradata linked service properties. -### SqlServerStoredProcedureActivity +### VerticaLinkedService #### Properties -* **type**: 'SqlServerStoredProcedure' (Required): Type of activity. -* **typeProperties**: [SqlServerStoredProcedureActivityTypeProperties](#sqlserverstoredprocedureactivitytypeproperties) (Required): SQL stored procedure activity properties. +* **type**: 'Vertica' (Required): Type of linked service. +* **typeProperties**: [VerticaLinkedServiceTypeProperties](#verticalinkedservicetypeproperties) (Required): Vertica linked service properties. -### UntilActivity +### WebLinkedService #### Properties -* **type**: 'Until' (Required): Type of activity. -* **typeProperties**: [UntilActivityTypeProperties](#untilactivitytypeproperties) (Required): Until activity properties. +* **type**: 'Web' (Required): Type of linked service. +* **typeProperties**: [WebLinkedServiceTypeProperties](#weblinkedservicetypeproperties) (Required): Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models. -### WaitActivity +### XeroLinkedService #### Properties -* **type**: 'Wait' (Required): Type of activity. -* **typeProperties**: [WaitActivityTypeProperties](#waitactivitytypeproperties) (Required): Wait activity properties. +* **type**: 'Xero' (Required): Type of linked service. +* **typeProperties**: [XeroLinkedServiceTypeProperties](#xerolinkedservicetypeproperties) (Required): Xero Service linked service properties. -### WebActivity +### ZohoLinkedService #### Properties -* **type**: 'WebActivity' (Required): Type of activity. -* **typeProperties**: [WebActivityTypeProperties](#webactivitytypeproperties) (Required): Web activity type properties. +* **type**: 'Zoho' (Required): Type of linked service. +* **typeProperties**: [ZohoLinkedServiceTypeProperties](#zoholinkedservicetypeproperties) (Required): Zoho server linked service properties. -## ActivityDependency +## LinkedServiceReference ### Properties -* **activity**: string (Required): Activity name. -* **dependencyConditions**: 'Completed' | 'Failed' | 'Skipped' | 'Succeeded' | string[] (Required): Match-Condition for the dependency. -### Additional Properties -* **Additional Properties Type**: any +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **referenceName**: string (Required): Reference LinkedService name. +* **type**: 'LinkedServiceReference' | string (Required): Linked service reference type. -## AzureMLBatchExecutionActivityTypeProperties +## LookupActivityTypeProperties ### Properties -* **globalParameters**: [AzureMLBatchExecutionActivityTypePropertiesGlobalParameters](#azuremlbatchexecutionactivitytypepropertiesglobalparameters): 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. -* **webServiceInputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs](#azuremlbatchexecutionactivitytypepropertieswebserviceinputs): 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. -* **webServiceOutputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs](#azuremlbatchexecutionactivitytypepropertieswebserviceoutputs): 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. +* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. +* **firstRowOnly**: any: Any object +* **source**: [CopySource](#copysource) (Required): A copy activity source. -## AzureMLBatchExecutionActivityTypePropertiesGlobalParameters +## MagentoLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs +## ManagedIntegrationRuntimeTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. -## AzureMLWebServiceFile +## MariaDBLinkedServiceTypeProperties ### Properties -* **filePath**: any (Required): Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object -## AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs +## MarketoLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object + +## MongoDbCollectionDatasetTypeProperties +### Properties +* **collectionName**: any (Required): Any object + +## MongoDbLinkedServiceTypeProperties +### Properties +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'Basic' | string: The authentication type to be used to connect to the MongoDB database. +* **authSource**: any: Any object +* **databaseName**: any (Required): Any object +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **server**: any (Required): Any object +* **username**: any: Any object + +## MySqlLinkedServiceTypeProperties +### Properties +* **connectionString**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **encryptedCredential**: any: Any object + +## NetezzaLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object + +## ODataLinkedServiceTypeProperties +### Properties +* **authenticationType**: 'Anonymous' | 'Basic' | string: Type of authentication used to connect to the OData service. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object +* **userName**: any: Any object + +## ODataResourceDatasetTypeProperties +### Properties +* **path**: any: Any object + +## OdbcLinkedServiceTypeProperties +### Properties +* **authenticationType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object + +## OracleLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object + +## OracleTableDatasetTypeProperties +### Properties +* **tableName**: any (Required): Any object + +## ParameterDefinitionSpecification ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) +* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) -## AzureMLUpdateResourceActivityTypeProperties +## ParameterDefinitionSpecification ### Properties -* **trainedModelFilePath**: any (Required): Any object -* **trainedModelLinkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **trainedModelName**: any (Required): Any object +### Additional Properties +* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) -## DatasetReference +## ParameterDefinitionSpecification ### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference dataset name. -* **type**: 'DatasetReference' | string (Required): Dataset reference type. +### Additional Properties +* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) + +## ParameterSpecification +### Properties +* **defaultValue**: any: Any object +* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'Object' | 'SecureString' | 'String' | string (Required): Parameter type. ## ParameterValueSpecification ### Properties ### Additional Properties * **Additional Properties Type**: any -## CopyActivityTypeProperties +## ParameterValueSpecification ### Properties -* **cloudDataMovementUnits**: any: Any object -* **enableSkipIncompatibleRow**: any: Any object -* **enableStaging**: any: Any object -* **parallelCopies**: any: Any object -* **redirectIncompatibleRowSettings**: [RedirectIncompatibleRowSettings](#redirectincompatiblerowsettings): Redirect incompatible row settings -* **sink**: [CopySink](#copysink) (Required): A copy activity sink. -* **source**: [CopySource](#copysource) (Required): A copy activity source. -* **stagingSettings**: [StagingSettings](#stagingsettings): Staging settings. -* **translator**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -## RedirectIncompatibleRowSettings +## ParameterValueSpecification ### Properties -* **linkedServiceName**: any (Required): Any object -* **path**: any: Any object ### Additional Properties * **Additional Properties Type**: any -## CopySink -* **Discriminator**: type - -### Base Properties -* **sinkRetryCount**: any: Any object -* **sinkRetryWait**: any: Any object -* **writeBatchSize**: any: Any object -* **writeBatchTimeout**: any: Any object - -## CopySource -* **Discriminator**: type - -### Base Properties -* **sourceRetryCount**: any: Any object -* **sourceRetryWait**: any: Any object +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -## StagingSettings +## ParameterValueSpecification ### Properties -* **enableCompression**: any: Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **path**: any: Any object ### Additional Properties * **Additional Properties Type**: any -## CustomActivityTypeProperties +## PaypalLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object + +## PhoenixLinkedServiceTypeProperties +### Properties +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication mechanism used to connect to the Phoenix server. +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **httpPath**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object + +## Pipeline +### Properties +* **activities**: [Activity](#activity)[]: List of activities in pipeline. +* **annotations**: any[]: List of tags that can be used for describing the Pipeline. +* **concurrency**: int: The max number of concurrent runs for the pipeline. +* **description**: string: The description of the pipeline. +* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. + +## PipelineReference ### Properties -* **command**: any (Required): Any object -* **extendedProperties**: [CustomActivityTypePropertiesExtendedProperties](#customactivitytypepropertiesextendedproperties): 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. -* **folderPath**: any: Any object -* **referenceObjects**: [CustomActivityReferenceObject](#customactivityreferenceobject): Reference objects for custom activity -* **resourceLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **name**: string: Reference name. +* **referenceName**: string (Required): Reference pipeline name. +* **type**: 'PipelineReference' | string (Required): Pipeline reference type. -## CustomActivityTypePropertiesExtendedProperties +## PostgreSqlLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **connectionString**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **encryptedCredential**: any: Any object -## CustomActivityReferenceObject +## PrestoLinkedServiceTypeProperties ### Properties -* **datasets**: [DatasetReference](#datasetreference)[]: Dataset references. -* **linkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Linked service references. +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'LDAP' | string (Required): The authentication mechanism used to connect to the Presto server. +* **catalog**: any (Required): Any object +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **serverVersion**: any (Required): Any object +* **timeZoneID**: any: Any object +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object -## DatabricksNotebookActivityTypeProperties +## QuickBooksLinkedServiceTypeProperties ### Properties -* **baseParameters**: [DatabricksNotebookActivityTypePropertiesBaseParameters](#databricksnotebookactivitytypepropertiesbaseparameters): 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. -* **notebookPath**: any (Required): Any object +* **accessToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **accessTokenSecret**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **companyId**: any (Required): Any object +* **consumerKey**: any (Required): Any object +* **consumerSecret**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object -## DatabricksNotebookActivityTypePropertiesBaseParameters +## RedirectIncompatibleRowSettings ### Properties +* **linkedServiceName**: any (Required): Any object +* **path**: any: Any object ### Additional Properties * **Additional Properties Type**: any -## DataLakeAnalyticsUsqlActivityTypeProperties +## RelationalTableDatasetTypeProperties ### Properties -* **compilationMode**: any: Any object -* **degreeOfParallelism**: any: Any object -* **parameters**: [DataLakeAnalyticsUsqlActivityTypePropertiesParameters](#datalakeanalyticsusqlactivitytypepropertiesparameters): Parameters for U-SQL job request. -* **priority**: any: Any object -* **runtimeVersion**: any: Any object -* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **scriptPath**: any (Required): Any object +* **tableName**: any: Any object -## DataLakeAnalyticsUsqlActivityTypePropertiesParameters +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string -## ExecutePipelineActivityTypeProperties +## ResponsysLinkedServiceTypeProperties ### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **pipeline**: [PipelineReference](#pipelinereference) (Required): Pipeline reference type. -* **waitOnCompletion**: bool: Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false. +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## ParameterValueSpecification +## SalesforceLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **encryptedCredential**: any: Any object +* **environmentUrl**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **securityToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **username**: any: Any object -## PipelineReference +## SalesforceMarketingCloudLinkedServiceTypeProperties ### Properties -* **name**: string: Reference name. -* **referenceName**: string (Required): Reference pipeline name. -* **type**: 'PipelineReference' | string (Required): Pipeline reference type. +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## ExecuteSsisPackageActivityTypeProperties +## SalesforceObjectDatasetTypeProperties ### Properties -* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference) (Required): Integration runtime reference type. -* **environmentPath**: any: Any object -* **executionCredential**: [SsisExecutionCredential](#ssisexecutioncredential): SSIS package execution credential. -* **loggingLevel**: any: Any object -* **logLocation**: [SsisLogLocation](#ssisloglocation): SSIS package execution log location -* **packageConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers](#executessispackageactivitytypepropertiespackageconnectionmanagers): The package level connection managers to execute the SSIS package. -* **packageLocation**: [SsisPackageLocation](#ssispackagelocation) (Required): SSIS package location. -* **packageParameters**: [ExecuteSsisPackageActivityTypePropertiesPackageParameters](#executessispackageactivitytypepropertiespackageparameters): The package level parameters to execute the SSIS package. -* **projectConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers](#executessispackageactivitytypepropertiesprojectconnectionmanagers): The project level connection managers to execute the SSIS package. -* **projectParameters**: [ExecuteSsisPackageActivityTypePropertiesProjectParameters](#executessispackageactivitytypepropertiesprojectparameters): The project level parameters to execute the SSIS package. -* **propertyOverrides**: [ExecuteSsisPackageActivityTypePropertiesPropertyOverrides](#executessispackageactivitytypepropertiespropertyoverrides): The property overrides to execute the SSIS package. -* **runtime**: any: Any object +* **objectApiName**: any: Any object -## SsisExecutionCredential +## SapBWLinkedServiceTypeProperties ### Properties -* **domain**: any (Required): Any object -* **password**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **userName**: any (Required): Any object +* **clientId**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any (Required): Any object +* **systemNumber**: any (Required): Any object +* **userName**: any: Any object -## SsisLogLocation +## SapCloudForCustomerLinkedServiceTypeProperties ### Properties -* **logPath**: any (Required): Any object -* **type**: 'File' | string (Required): The type of SSIS log location. -* **typeProperties**: [SsisLogLocationTypeProperties](#ssisloglocationtypeproperties) (Required): SSIS package execution log location properties. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object +* **username**: any: Any object -## SsisLogLocationTypeProperties +## SapCloudForCustomerResourceDatasetTypeProperties ### Properties -* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. -* **logRefreshInterval**: any: Any object +* **path**: any (Required): Any object -## SsisAccessCredential +## SapEccLinkedServiceTypeProperties ### Properties -* **domain**: any (Required): Any object -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **userName**: any (Required): Any object +* **encryptedCredential**: string: 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). +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: string (Required): The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). +* **username**: string: The username for Basic authentication. Type: string (or Expression with resultType string). -## ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers +## SapEccResourceDatasetTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) +* **path**: any (Required): Any object -## SsisConnectionManager +## SapHanaLinkedServiceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **authenticationType**: 'Basic' | 'Windows' | string: The authentication type to be used to connect to the SAP HANA server. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any (Required): Any object +* **userName**: any: Any object -## SsisExecutionParameter +## SecretBase +* **Discriminator**: type + +### Base Properties +### AzureKeyVaultSecretReference +#### Properties +* **secretName**: any (Required): Any object +* **secretVersion**: any: Any object +* **store**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **type**: 'AzureKeyVaultSecret' (Required): Type of the secret. + +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString ### Properties -* **value**: any (Required): Any object +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. -## SsisPackageLocation +## ServiceNowLinkedServiceTypeProperties ### Properties -* **packagePath**: any (Required): Any object -* **type**: 'File' | 'SSISDB' | string: The type of SSIS package location. -* **typeProperties**: [SsisPackageLocationTypeProperties](#ssispackagelocationtypeproperties): SSIS package location properties. +* **authenticationType**: 'Basic' | 'OAuth2' | string (Required): The authentication type to use. +* **clientId**: any: Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any: Any object -## SsisPackageLocationTypeProperties +## SftpServerLinkedServiceTypeProperties ### Properties -* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. -* **configurationPath**: any: Any object -* **packagePassword**: [SecretBase](#secretbase): The base definition of a secret type. +* **authenticationType**: 'Basic' | 'SshPublicKey' | string: The authentication type to be used to connect to the FTP server. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **hostKeyFingerprint**: any: Any object +* **passPhrase**: [SecretBase](#secretbase): The base definition of a secret type. +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **privateKeyContent**: [SecretBase](#secretbase): The base definition of a secret type. +* **privateKeyPath**: any: Any object +* **skipHostKeyValidation**: any: Any object +* **userName**: any: Any object -## ExecuteSsisPackageActivityTypePropertiesPackageParameters +## ShopifyLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers +## SparkLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'Username' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication method used to access the Spark server. +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **httpPath**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any (Required): Any object +* **serverType**: 'SharkServer' | 'SharkServer2' | 'SparkThriftServer' | string: The type of Spark server. +* **thriftTransportProtocol**: 'Binary' | 'HTTP ' | 'SASL' | string: The transport protocol to use in the Thrift layer. +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object -## SsisConnectionManager +## SqlServerLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object -## ExecuteSsisPackageActivityTypePropertiesProjectParameters +## SqlServerStoredProcedureActivityTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **storedProcedureName**: any (Required): Any object +* **storedProcedureParameters**: [SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters](#sqlserverstoredprocedureactivitytypepropertiesstoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". -## ExecuteSsisPackageActivityTypePropertiesPropertyOverrides +## SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [SsisPropertyOverride](#ssispropertyoverride) +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## SsisPropertyOverride +## SqlServerTableDatasetTypeProperties ### Properties -* **isSensitive**: bool: Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true -* **value**: any (Required): Any object +* **tableName**: any (Required): Any object -## FilterActivityTypeProperties +## SquareLinkedServiceTypeProperties ### Properties -* **condition**: [Expression](#expression) (Required): Azure Data Factory expression definition. -* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **redirectUri**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## Expression +## SsisAccessCredential ### Properties -* **type**: 'Expression' | string (Required): Expression type. -* **value**: string (Required): Expression value. +* **domain**: any (Required): Any object +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **userName**: any (Required): Any object -## ForEachActivityTypeProperties +## SsisConnectionManager ### Properties -* **activities**: [Activity](#activity)[] (Required): List of activities to execute . -* **batchCount**: int: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false). -* **isSequential**: bool: Should the loop be executed in sequence or in parallel (max 50) -* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. +### Additional Properties +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## GetMetadataActivityTypeProperties +## SsisConnectionManager ### Properties -* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. -* **fieldList**: any[]: Fields of metadata to get from dataset. +### Additional Properties +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## HDInsightHiveActivityTypeProperties +## SsisExecutionCredential ### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **defines**: [HDInsightHiveActivityTypePropertiesDefines](#hdinsighthiveactivitytypepropertiesdefines): Allows user to specify defines for Hive job request. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **scriptPath**: any: Any object -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. +* **domain**: any (Required): Any object +* **password**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **userName**: any (Required): Any object -## HDInsightHiveActivityTypePropertiesDefines +## SsisExecutionParameter ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **value**: any (Required): Any object -## HDInsightMapReduceActivityTypeProperties +## SsisLogLocation ### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **className**: any (Required): Any object -* **defines**: [HDInsightMapReduceActivityTypePropertiesDefines](#hdinsightmapreduceactivitytypepropertiesdefines): Allows user to specify defines for the MapReduce job request. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **jarFilePath**: any (Required): Any object -* **jarLibs**: any[]: Jar libs. -* **jarLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. +* **logPath**: any (Required): Any object +* **type**: 'File' | string (Required): The type of SSIS log location. +* **typeProperties**: [SsisLogLocationTypeProperties](#ssisloglocationtypeproperties) (Required): SSIS package execution log location properties. -## HDInsightMapReduceActivityTypePropertiesDefines +## SsisLogLocationTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. +* **logRefreshInterval**: any: Any object -## HDInsightPigActivityTypeProperties +## SsisPackageLocation ### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **defines**: [HDInsightPigActivityTypePropertiesDefines](#hdinsightpigactivitytypepropertiesdefines): Allows user to specify defines for Pig job request. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **scriptPath**: any: Any object -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. +* **packagePath**: any (Required): Any object +* **type**: 'File' | 'SSISDB' | string: The type of SSIS package location. +* **typeProperties**: [SsisPackageLocationTypeProperties](#ssispackagelocationtypeproperties): SSIS package location properties. -## HDInsightPigActivityTypePropertiesDefines +## SsisPackageLocationTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. +* **configurationPath**: any: Any object +* **packagePassword**: [SecretBase](#secretbase): The base definition of a secret type. -## HDInsightSparkActivityTypeProperties +## SsisPropertyOverride ### Properties -* **arguments**: any[]: The user-specified arguments to HDInsightSparkActivity. -* **className**: string: The application's Java/Spark main class. -* **entryFilePath**: any (Required): Any object -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **proxyUser**: any: Any object -* **rootPath**: any (Required): Any object -* **sparkConfig**: [HDInsightSparkActivityTypePropertiesSparkConfig](#hdinsightsparkactivitytypepropertiessparkconfig): Spark configuration property. -* **sparkJobLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **isSensitive**: bool: Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true +* **value**: any (Required): Any object -## HDInsightSparkActivityTypePropertiesSparkConfig +## StagingSettings ### Properties +* **enableCompression**: any: Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **path**: any: Any object ### Additional Properties * **Additional Properties Type**: any -## HDInsightStreamingActivityTypeProperties +## StoredProcedureParameter ### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **combiner**: any: Any object -* **commandEnvironment**: any[]: Command line environment values. -* **defines**: [HDInsightStreamingActivityTypePropertiesDefines](#hdinsightstreamingactivitytypepropertiesdefines): Allows user to specify defines for streaming job request. -* **fileLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **filePaths**: any[] (Required): Paths to streaming job files. Can be directories. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **input**: any (Required): Any object -* **mapper**: any (Required): Any object -* **output**: any (Required): Any object -* **reducer**: any (Required): Any object -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. +* **type**: 'Boolean' | 'Date' | 'Decimal' | 'Guid' | 'Int' | 'Int64' | 'String' | string: Stored procedure parameter type. +* **value**: any (Required): Any object -## HDInsightStreamingActivityTypePropertiesDefines +## SybaseLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. +* **database**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **schema**: any: Any object +* **server**: any (Required): Any object +* **username**: any: Any object -## IfConditionActivityTypeProperties +## TeradataLinkedServiceTypeProperties ### Properties -* **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. -* **ifFalseActivities**: [Activity](#activity)[]: 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. -* **ifTrueActivities**: [Activity](#activity)[]: 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. +* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any (Required): Any object +* **username**: any: Any object -## LookupActivityTypeProperties -### Properties -* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. -* **firstRowOnly**: any: Any object -* **source**: [CopySource](#copysource) (Required): A copy activity source. +## Trigger +* **Discriminator**: type -## SqlServerStoredProcedureActivityTypeProperties -### Properties -* **storedProcedureName**: any (Required): Any object -* **storedProcedureParameters**: [SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters](#sqlserverstoredprocedureactivitytypepropertiesstoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". +### Base Properties +* **description**: string: Trigger description. +* **runtimeState**: 'Disabled' | 'Started' | 'Stopped' | string (ReadOnly): Enumerates possible state of Triggers. +### MultiplePipelineTrigger +#### Properties +* **pipelines**: [TriggerPipelineReference](#triggerpipelinereference)[]: Pipelines that need to be started. +* **type**: 'MultiplePipelineTrigger' (Required): Trigger type. -## SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## StoredProcedureParameter +## TriggerPipelineReference ### Properties -* **type**: 'Boolean' | 'Date' | 'Decimal' | 'Guid' | 'Int' | 'Int64' | 'String' | string: Stored procedure parameter type. -* **value**: any (Required): Any object +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **pipelineReference**: [PipelineReference](#pipelinereference): Pipeline reference type. ## UntilActivityTypeProperties ### Properties @@ -2179,10 +2160,23 @@ * **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. * **timeout**: any: Any object +## VerticaLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object + ## WaitActivityTypeProperties ### Properties * **waitTimeInSeconds**: int (Required): Duration in seconds. +## WebActivityAuthentication +### Properties +* **password**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **pfx**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **resource**: string: Resource for which Azure Auth token will be requested when using MSI Authentication. +* **type**: string (Required): Web activity authentication (Basic/ClientCertificate/MSI) +* **username**: string: Web activity authentication user name for basic authentication. + ## WebActivityTypeProperties ### Properties * **authentication**: [WebActivityAuthentication](#webactivityauthentication): Web activity authentication properties. @@ -2194,43 +2188,49 @@ * **method**: 'DELETE' | 'GET' | 'POST' | 'PUT' | string (Required): The list of HTTP methods supported by a WebActivity. * **url**: any (Required): Any object -## WebActivityAuthentication -### Properties -* **password**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **pfx**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **resource**: string: Resource for which Azure Auth token will be requested when using MSI Authentication. -* **type**: string (Required): Web activity authentication (Basic/ClientCertificate/MSI) -* **username**: string: Web activity authentication user name for basic authentication. +## WebLinkedServiceTypeProperties +* **Discriminator**: authenticationType -## ParameterDefinitionSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) +### Base Properties +* **url**: any (Required): Any object +### WebAnonymousAuthentication +#### Properties +* **authenticationType**: 'Anonymous' (Required): Type of authentication used to connect to the web table source. -## Trigger -* **Discriminator**: type +### WebBasicAuthentication +#### Properties +* **authenticationType**: 'Basic' (Required): Type of authentication used to connect to the web table source. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **username**: any (Required): Any object -### Base Properties -* **description**: string: Trigger description. -* **runtimeState**: 'Disabled' | 'Started' | 'Stopped' | string (ReadOnly): Enumerates possible state of Triggers. -### MultiplePipelineTrigger +### WebClientCertificateAuthentication #### Properties -* **pipelines**: [TriggerPipelineReference](#triggerpipelinereference)[]: Pipelines that need to be started. -* **type**: 'MultiplePipelineTrigger' (Required): Trigger type. +* **authenticationType**: 'ClientCertificate' (Required): Type of authentication used to connect to the web table source. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **pfx**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -## TriggerPipelineReference +## WebTableDatasetTypeProperties ### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **pipelineReference**: [PipelineReference](#pipelinereference): Pipeline reference type. +* **index**: any (Required): Any object +* **path**: any: Any object -## ParameterValueSpecification +## XeroLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **consumerKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **privateKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## IntegrationRuntimeAuthKeys +## ZohoLinkedServiceTypeProperties ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object diff --git a/generated/datafactory/microsoft.datafactory/2018-06-01/types.md b/generated/datafactory/microsoft.datafactory/2018-06-01/types.md index 5d3c9fcd4b..2d3215c232 100644 --- a/generated/datafactory/microsoft.datafactory/2018-06-01/types.md +++ b/generated/datafactory/microsoft.datafactory/2018-06-01/types.md @@ -108,5115 +108,5069 @@ * **ApiVersion**: 2018-06-01 * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## FactoryIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the identity. -* **tenantId**: string (ReadOnly): The client tenant id of the identity. -* **type**: 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [UserAssignedIdentitiesDefinitionSpecification](#userassignedidentitiesdefinitionspecification): Definition of all user assigned identities for a factory. - -## UserAssignedIdentitiesDefinitionSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: any +## Activity +* **Discriminator**: type -## FactoryProperties -### Properties -* **createTime**: string (ReadOnly): Time the factory was created in ISO8601 format. -* **encryption**: [EncryptionConfiguration](#encryptionconfiguration): Definition of CMK for the factory. -* **globalParameters**: [GlobalParameterDefinitionSpecification](#globalparameterdefinitionspecification): Definition of all parameters for an entity. -* **provisioningState**: string (ReadOnly): Factory provisioning state, example Succeeded. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the data factory. -* **repoConfiguration**: [FactoryRepoConfiguration](#factoryrepoconfiguration): Factory's git repo information. -* **version**: string (ReadOnly): Version of the factory. +### Base Properties +* **dependsOn**: [ActivityDependency](#activitydependency)[]: Activity depends on condition. +* **description**: string: Activity description. +* **name**: string (Required): Activity name. +* **userProperties**: [UserProperty](#userproperty)[]: Activity user properties. +### AppendVariableActivity +#### Properties +* **type**: 'AppendVariable' (Required): Type of activity. +* **typeProperties**: [AppendVariableActivityTypeProperties](#appendvariableactivitytypeproperties) (Required): AppendVariable activity properties. -## EncryptionConfiguration -### Properties -* **identity**: [CMKIdentityDefinition](#cmkidentitydefinition): Managed Identity used for CMK. -* **keyName**: string (Required): The name of the key in Azure Key Vault to use as Customer Managed Key. -* **keyVersion**: string: The version of the key used for CMK. If not provided, latest version will be used. -* **vaultBaseUrl**: string (Required): The url of the Azure Key Vault used for CMK. +### AzureDataExplorerCommandActivity +#### Properties +* **type**: 'AzureDataExplorerCommand' (Required): Type of activity. +* **typeProperties**: [AzureDataExplorerCommandActivityTypeProperties](#azuredataexplorercommandactivitytypeproperties) (Required): Azure Data Explorer command activity properties. -## CMKIdentityDefinition -### Properties -* **userAssignedIdentity**: string: The resource id of the user assigned identity to authenticate to customer's key vault. +### AzureFunctionActivity +#### Properties +* **type**: 'AzureFunctionActivity' (Required): Type of activity. +* **typeProperties**: [AzureFunctionActivityTypeProperties](#azurefunctionactivitytypeproperties) (Required): Azure Function activity type properties. -## GlobalParameterDefinitionSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: [GlobalParameterSpecification](#globalparameterspecification) +### AzureMLBatchExecutionActivity +#### Properties +* **type**: 'AzureMLBatchExecution' (Required): Type of activity. +* **typeProperties**: [AzureMLBatchExecutionActivityTypeProperties](#azuremlbatchexecutionactivitytypeproperties) (Required): Azure ML Batch Execution activity properties. -## GlobalParameterSpecification -### Properties -* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'Object' | 'String' | string (Required): Global Parameter type. -* **value**: any (Required): Any object +### AzureMLExecutePipelineActivity +#### Properties +* **type**: 'AzureMLExecutePipeline' (Required): Type of activity. +* **typeProperties**: [AzureMLExecutePipelineActivityTypeProperties](#azuremlexecutepipelineactivitytypeproperties) (Required): Azure ML Execute Pipeline activity properties. -## FactoryRepoConfiguration -* **Discriminator**: type +### AzureMLUpdateResourceActivity +#### Properties +* **type**: 'AzureMLUpdateResource' (Required): Type of activity. +* **typeProperties**: [AzureMLUpdateResourceActivityTypeProperties](#azuremlupdateresourceactivitytypeproperties) (Required): Azure ML Update Resource activity properties. -### Base Properties -* **accountName**: string (Required): Account name. -* **collaborationBranch**: string (Required): Collaboration branch. -* **lastCommitId**: string: Last commit id. -* **repositoryName**: string (Required): Repository name. -* **rootFolder**: string (Required): Root folder. -### FactoryGitHubConfiguration +### CopyActivity #### Properties -* **clientId**: string: GitHub bring your own app client id. -* **clientSecret**: [GitHubClientSecret](#githubclientsecret): Client secret information for factory's bring your own app repository configuration. -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **type**: 'FactoryGitHubConfiguration' (Required): Type of repo configuration. +* **inputs**: [DatasetReference](#datasetreference)[]: List of inputs for the activity. +* **outputs**: [DatasetReference](#datasetreference)[]: List of outputs for the activity. +* **type**: 'Copy' (Required): Type of activity. +* **typeProperties**: [CopyActivityTypeProperties](#copyactivitytypeproperties) (Required): Copy activity properties. -### FactoryVstsConfiguration +### CustomActivity #### Properties -* **projectName**: string (Required): VSTS project name. -* **tenantId**: string: VSTS tenant id. -* **type**: 'FactoryVSTSConfiguration' (Required): Type of repo configuration. +* **type**: 'Custom' (Required): Type of activity. +* **typeProperties**: [CustomActivityTypeProperties](#customactivitytypeproperties) (Required): Custom activity properties. +### DatabricksNotebookActivity +#### Properties +* **type**: 'DatabricksNotebook' (Required): Type of activity. +* **typeProperties**: [DatabricksNotebookActivityTypeProperties](#databricksnotebookactivitytypeproperties) (Required): Databricks Notebook activity properties. -## GitHubClientSecret -### Properties -* **byoaSecretAkvUrl**: string: Bring your own app client secret AKV URL. -* **byoaSecretName**: string: Bring your own app client secret name in AKV. +### DatabricksSparkJarActivity +#### Properties +* **type**: 'DatabricksSparkJar' (Required): Type of activity. +* **typeProperties**: [DatabricksSparkJarActivityTypeProperties](#databrickssparkjaractivitytypeproperties) (Required): Databricks SparkJar activity properties. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### DatabricksSparkPythonActivity +#### Properties +* **type**: 'DatabricksSparkPython' (Required): Type of activity. +* **typeProperties**: [DatabricksSparkPythonActivityTypeProperties](#databrickssparkpythonactivitytypeproperties) (Required): Databricks SparkPython activity properties. -## DataFlow -* **Discriminator**: type +### DataLakeAnalyticsUsqlActivity +#### Properties +* **type**: 'DataLakeAnalyticsU-SQL' (Required): Type of activity. +* **typeProperties**: [DataLakeAnalyticsUsqlActivityTypeProperties](#datalakeanalyticsusqlactivitytypeproperties) (Required): DataLakeAnalyticsU-SQL activity properties. -### Base Properties -* **annotations**: any[]: List of tags that can be used for describing the data flow. -* **description**: string: The description of the data flow. -* **folder**: [DataFlowFolder](#dataflowfolder): The folder that this data flow is in. If not specified, Data flow will appear at the root level. -### Flowlet +### DeleteActivity #### Properties -* **type**: 'Flowlet' (Required): Type of data flow. -* **typeProperties**: [FlowletTypeProperties](#flowlettypeproperties): Flowlet type properties. +* **type**: 'Delete' (Required): Type of activity. +* **typeProperties**: [DeleteActivityTypeProperties](#deleteactivitytypeproperties) (Required): Delete activity properties. -### MappingDataFlow +### ExecuteDataFlowActivity #### Properties -* **type**: 'MappingDataFlow' (Required): Type of data flow. -* **typeProperties**: [MappingDataFlowTypeProperties](#mappingdataflowtypeproperties): Mapping data flow type properties. +* **type**: 'ExecuteDataFlow' (Required): Type of activity. +* **typeProperties**: [ExecuteDataFlowActivityTypeProperties](#executedataflowactivitytypeproperties) (Required): Execute data flow activity properties. -### WranglingDataFlow +### ExecutePipelineActivity #### Properties -* **type**: 'WranglingDataFlow' (Required): Type of data flow. -* **typeProperties**: [PowerQueryTypeProperties](#powerquerytypeproperties): Power Query data flow type properties. +* **policy**: [ExecutePipelineActivityPolicy](#executepipelineactivitypolicy): Execution policy for an execute pipeline activity. +* **type**: 'ExecutePipeline' (Required): Type of activity. +* **typeProperties**: [ExecutePipelineActivityTypeProperties](#executepipelineactivitytypeproperties) (Required): Execute pipeline activity properties. +### ExecuteSsisPackageActivity +#### Properties +* **type**: 'ExecuteSSISPackage' (Required): Type of activity. +* **typeProperties**: [ExecuteSsisPackageActivityTypeProperties](#executessispackageactivitytypeproperties) (Required): Execute SSIS package activity properties. -## DataFlowFolder -### Properties -* **name**: string: The name of the folder that this data flow is in. +### ExecuteWranglingDataflowActivity +#### Properties +* **policy**: [ActivityPolicy](#activitypolicy): Execution policy for an activity. +* **type**: 'ExecuteWranglingDataflow' (Required): Type of activity. +* **typeProperties**: [ExecutePowerQueryActivityTypeProperties](#executepowerqueryactivitytypeproperties) (Required): Execute power query data flow activity properties. -## FlowletTypeProperties -### Properties -* **script**: string: Flowlet script. -* **scriptLines**: string[]: Flowlet script lines. -* **sinks**: [DataFlowSink](#dataflowsink)[]: List of sinks in Flowlet. -* **sources**: [DataFlowSource](#dataflowsource)[]: List of sources in Flowlet. -* **transformations**: [Transformation](#transformation)[]: List of transformations in Flowlet. +### FailActivity +#### Properties +* **type**: 'Fail' (Required): Type of activity. +* **typeProperties**: [FailActivityTypeProperties](#failactivitytypeproperties) (Required): Fail activity properties. -## DataFlowSink -### Properties -* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. -* **description**: string: Transformation description. -* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. -* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **name**: string (Required): Transformation name. -* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +### FilterActivity +#### Properties +* **type**: 'Filter' (Required): Type of activity. +* **typeProperties**: [FilterActivityTypeProperties](#filteractivitytypeproperties) (Required): Filter activity properties. -## DatasetReference -### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference dataset name. -* **type**: 'DatasetReference' | string (Required): Dataset reference type. +### ForEachActivity +#### Properties +* **type**: 'ForEach' (Required): Type of activity. +* **typeProperties**: [ForEachActivityTypeProperties](#foreachactivitytypeproperties) (Required): ForEach activity properties. -## ParameterValueSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: any +### GetMetadataActivity +#### Properties +* **type**: 'GetMetadata' (Required): Type of activity. +* **typeProperties**: [GetMetadataActivityTypeProperties](#getmetadataactivitytypeproperties) (Required): GetMetadata activity properties. -## DataFlowReference -### Properties -* **datasetParameters**: any: Any object -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference data flow name. -* **type**: 'DataFlowReference' | string (Required): Data flow reference type. -### Additional Properties -* **Additional Properties Type**: any +### HDInsightHiveActivity +#### Properties +* **type**: 'HDInsightHive' (Required): Type of activity. +* **typeProperties**: [HDInsightHiveActivityTypeProperties](#hdinsighthiveactivitytypeproperties) (Required): HDInsight Hive activity properties. -## ParameterValueSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: any +### HDInsightMapReduceActivity +#### Properties +* **type**: 'HDInsightMapReduce' (Required): Type of activity. +* **typeProperties**: [HDInsightMapReduceActivityTypeProperties](#hdinsightmapreduceactivitytypeproperties) (Required): HDInsight MapReduce activity properties. -## LinkedServiceReference -### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference LinkedService name. -* **type**: 'LinkedServiceReference' | string (Required): Linked service reference type. +### HDInsightPigActivity +#### Properties +* **type**: 'HDInsightPig' (Required): Type of activity. +* **typeProperties**: [HDInsightPigActivityTypeProperties](#hdinsightpigactivitytypeproperties) (Required): HDInsight Pig activity properties. -## ParameterValueSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: any +### HDInsightSparkActivity +#### Properties +* **type**: 'HDInsightSpark' (Required): Type of activity. +* **typeProperties**: [HDInsightSparkActivityTypeProperties](#hdinsightsparkactivitytypeproperties) (Required): HDInsight spark activity properties. -## DataFlowSource -### Properties -* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. -* **description**: string: Transformation description. -* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. -* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **name**: string (Required): Transformation name. -* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +### HDInsightStreamingActivity +#### Properties +* **type**: 'HDInsightStreaming' (Required): Type of activity. +* **typeProperties**: [HDInsightStreamingActivityTypeProperties](#hdinsightstreamingactivitytypeproperties) (Required): HDInsight streaming activity properties. -## Transformation -### Properties -* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. -* **description**: string: Transformation description. -* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. -* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **name**: string (Required): Transformation name. +### IfConditionActivity +#### Properties +* **type**: 'IfCondition' (Required): Type of activity. +* **typeProperties**: [IfConditionActivityTypeProperties](#ifconditionactivitytypeproperties) (Required): IfCondition activity properties. -## MappingDataFlowTypeProperties -### Properties -* **script**: string: DataFlow script. -* **scriptLines**: string[]: Data flow script lines. -* **sinks**: [DataFlowSink](#dataflowsink)[]: List of sinks in data flow. -* **sources**: [DataFlowSource](#dataflowsource)[]: List of sources in data flow. -* **transformations**: [Transformation](#transformation)[]: List of transformations in data flow. - -## PowerQueryTypeProperties -### Properties -* **documentLocale**: string: Locale of the Power query mashup document. -* **script**: string: Power query mashup script. -* **sources**: [PowerQuerySource](#powerquerysource)[]: List of sources in Power Query. - -## PowerQuerySource -### Properties -* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. -* **description**: string: Transformation description. -* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. -* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **name**: string (Required): Transformation name. -* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **script**: string: source script. - -## Dataset -* **Discriminator**: type - -### Base Properties -* **annotations**: any[]: List of tags that can be used for describing the Dataset. -* **description**: string: Dataset description. -* **folder**: [DatasetFolder](#datasetfolder): The folder that this Dataset is in. If not specified, Dataset will appear at the root level. -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. -* **schema**: any: Any object -* **structure**: any: Any object -### AmazonMWSObjectDataset +### LookupActivity #### Properties -* **type**: 'AmazonMWSObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +* **type**: 'Lookup' (Required): Type of activity. +* **typeProperties**: [LookupActivityTypeProperties](#lookupactivitytypeproperties) (Required): Lookup activity properties. -### AmazonRdsForOracleTableDataset +### ScriptActivity #### Properties -* **type**: 'AmazonRdsForOracleTable' (Required): Type of dataset. -* **typeProperties**: [AmazonRdsForOracleTableDatasetTypeProperties](#amazonrdsfororacletabledatasettypeproperties): AmazonRdsForOracle dataset properties. +* **type**: 'Script' (Required): Type of activity. +* **typeProperties**: [ScriptActivityTypeProperties](#scriptactivitytypeproperties) (Required): Script activity properties. -### AmazonRdsForSqlServerTableDataset +### SetVariableActivity #### Properties -* **type**: 'AmazonRdsForSqlServerTable' (Required): Type of dataset. -* **typeProperties**: [AmazonRdsForSqlServerTableDatasetTypeProperties](#amazonrdsforsqlservertabledatasettypeproperties): The Amazon RDS for SQL Server dataset properties. +* **type**: 'SetVariable' (Required): Type of activity. +* **typeProperties**: [SetVariableActivityTypeProperties](#setvariableactivitytypeproperties) (Required): SetVariable activity properties. -### AmazonRedshiftTableDataset +### SqlServerStoredProcedureActivity #### Properties -* **type**: 'AmazonRedshiftTable' (Required): Type of dataset. -* **typeProperties**: [AmazonRedshiftTableDatasetTypeProperties](#amazonredshifttabledatasettypeproperties): Amazon Redshift table dataset properties. +* **type**: 'SqlServerStoredProcedure' (Required): Type of activity. +* **typeProperties**: [SqlServerStoredProcedureActivityTypeProperties](#sqlserverstoredprocedureactivitytypeproperties) (Required): SQL stored procedure activity properties. -### AmazonS3Dataset +### SwitchActivity #### Properties -* **type**: 'AmazonS3Object' (Required): Type of dataset. -* **typeProperties**: [AmazonS3DatasetTypeProperties](#amazons3datasettypeproperties) (Required): Amazon S3 dataset properties. +* **type**: 'Switch' (Required): Type of activity. +* **typeProperties**: [SwitchActivityTypeProperties](#switchactivitytypeproperties) (Required): Switch activity properties. -### AvroDataset +### UntilActivity #### Properties -* **type**: 'Avro' (Required): Type of dataset. -* **typeProperties**: [AvroDatasetTypeProperties](#avrodatasettypeproperties): Avro dataset properties. +* **type**: 'Until' (Required): Type of activity. +* **typeProperties**: [UntilActivityTypeProperties](#untilactivitytypeproperties) (Required): Until activity properties. -### AzureBlobDataset +### ValidationActivity #### Properties -* **type**: 'AzureBlob' (Required): Type of dataset. -* **typeProperties**: [AzureBlobDatasetTypeProperties](#azureblobdatasettypeproperties): Azure Blob dataset properties. +* **type**: 'Validation' (Required): Type of activity. +* **typeProperties**: [ValidationActivityTypeProperties](#validationactivitytypeproperties) (Required): Validation activity properties. -### AzureBlobFSDataset +### WaitActivity #### Properties -* **type**: 'AzureBlobFSFile' (Required): Type of dataset. -* **typeProperties**: [AzureBlobFSDatasetTypeProperties](#azureblobfsdatasettypeproperties): Azure Data Lake Storage Gen2 dataset properties. +* **type**: 'Wait' (Required): Type of activity. +* **typeProperties**: [WaitActivityTypeProperties](#waitactivitytypeproperties) (Required): Wait activity properties. -### AzureDatabricksDeltaLakeDataset +### WebActivity #### Properties -* **type**: 'AzureDatabricksDeltaLakeDataset' (Required): Type of dataset. -* **typeProperties**: [AzureDatabricksDeltaLakeDatasetTypeProperties](#azuredatabricksdeltalakedatasettypeproperties): Azure Databricks Delta Lake Dataset Properties +* **type**: 'WebActivity' (Required): Type of activity. +* **typeProperties**: [WebActivityTypeProperties](#webactivitytypeproperties) (Required): Web activity type properties. -### AzureDataExplorerTableDataset +### WebHookActivity #### Properties -* **type**: 'AzureDataExplorerTable' (Required): Type of dataset. -* **typeProperties**: [AzureDataExplorerDatasetTypeProperties](#azuredataexplorerdatasettypeproperties) (Required): Azure Data Explorer (Kusto) dataset properties. +* **type**: 'WebHook' (Required): Type of activity. +* **typeProperties**: [WebHookActivityTypeProperties](#webhookactivitytypeproperties) (Required): WebHook activity type properties. -### AzureDataLakeStoreDataset -#### Properties -* **type**: 'AzureDataLakeStoreFile' (Required): Type of dataset. -* **typeProperties**: [AzureDataLakeStoreDatasetTypeProperties](#azuredatalakestoredatasettypeproperties): Azure Data Lake Store dataset properties. -### AzureMariaDBTableDataset -#### Properties -* **type**: 'AzureMariaDBTable' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## ActivityDependency +### Properties +* **activity**: string (Required): Activity name. +* **dependencyConditions**: 'Completed' | 'Failed' | 'Skipped' | 'Succeeded' | string[] (Required): Match-Condition for the dependency. +### Additional Properties +* **Additional Properties Type**: any -### AzureMySqlTableDataset -#### Properties -* **type**: 'AzureMySqlTable' (Required): Type of dataset. -* **typeProperties**: [AzureMySqlTableDatasetTypeProperties](#azuremysqltabledatasettypeproperties) (Required): Azure MySQL database dataset properties. +## ActivityPolicy +### Properties +* **retry**: any: Any object +* **retryIntervalInSeconds**: int: Interval between each retry attempt (in seconds). The default is 30 sec. +* **secureInput**: bool: When set to true, Input from activity is considered as secure and will not be logged to monitoring. +* **secureOutput**: bool: When set to true, Output from activity is considered as secure and will not be logged to monitoring. +* **timeout**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -### AzurePostgreSqlTableDataset -#### Properties -* **type**: 'AzurePostgreSqlTable' (Required): Type of dataset. -* **typeProperties**: [AzurePostgreSqlTableDatasetTypeProperties](#azurepostgresqltabledatasettypeproperties): Azure PostgreSQL dataset properties. +## AmazonMWSLinkedServiceTypeProperties +### Properties +* **accessKeyId**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **marketplaceID**: any (Required): Any object +* **mwsAuthToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **secretKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **sellerID**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### AzureSearchIndexDataset -#### Properties -* **type**: 'AzureSearchIndex' (Required): Type of dataset. -* **typeProperties**: [AzureSearchIndexDatasetTypeProperties](#azuresearchindexdatasettypeproperties) (Required): Properties specific to this dataset type. +## AmazonRdsForLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. -### AzureSqlDWTableDataset -#### Properties -* **type**: 'AzureSqlDWTable' (Required): Type of dataset. -* **typeProperties**: [AzureSqlDWTableDatasetTypeProperties](#azuresqldwtabledatasettypeproperties): Azure SQL Data Warehouse dataset properties. +## AmazonRdsForOraclePartitionSettings +### Properties +* **partitionColumnName**: any: Any object +* **partitionLowerBound**: any: Any object +* **partitionNames**: any: Any object +* **partitionUpperBound**: any: Any object -### AzureSqlMITableDataset -#### Properties -* **type**: 'AzureSqlMITable' (Required): Type of dataset. -* **typeProperties**: [AzureSqlMITableDatasetTypeProperties](#azuresqlmitabledatasettypeproperties): Azure SQL Managed Instance dataset properties. +## AmazonRdsForOracleTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object -### AzureSqlTableDataset -#### Properties -* **type**: 'AzureSqlTable' (Required): Type of dataset. -* **typeProperties**: [AzureSqlTableDatasetTypeProperties](#azuresqltabledatasettypeproperties): Azure SQL dataset properties. +## AmazonRdsForSqlServerLinkedServiceTypeProperties +### Properties +* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object -### AzureTableDataset -#### Properties -* **type**: 'AzureTable' (Required): Type of dataset. -* **typeProperties**: [AzureTableDatasetTypeProperties](#azuretabledatasettypeproperties) (Required): Azure Table dataset properties. +## AmazonRdsForSqlServerSourceStoredProcedureParameters +### Properties +### Additional Properties +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -### BinaryDataset -#### Properties -* **type**: 'Binary' (Required): Type of dataset. -* **typeProperties**: [BinaryDatasetTypeProperties](#binarydatasettypeproperties): Binary dataset properties. +## AmazonRdsForSqlServerTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object -### CassandraTableDataset -#### Properties -* **type**: 'CassandraTable' (Required): Type of dataset. -* **typeProperties**: [CassandraTableDatasetTypeProperties](#cassandratabledatasettypeproperties): Cassandra dataset properties. +## AmazonRedshiftLinkedServiceTypeProperties +### Properties +* **database**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **server**: any (Required): Any object +* **username**: any: Any object -### CommonDataServiceForAppsEntityDataset -#### Properties -* **type**: 'CommonDataServiceForAppsEntity' (Required): Type of dataset. -* **typeProperties**: [CommonDataServiceForAppsEntityDatasetTypeProperties](#commondataserviceforappsentitydatasettypeproperties): Common Data Service for Apps entity dataset properties. +## AmazonRedshiftTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### ConcurObjectDataset -#### Properties -* **type**: 'ConcurObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AmazonS3CompatibleLinkedServiceTypeProperties +### Properties +* **accessKeyId**: any: Any object +* **encryptedCredential**: any: Any object +* **forcePathStyle**: any: Any object +* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **serviceUrl**: any: Any object -### CosmosDbMongoDbApiCollectionDataset -#### Properties -* **type**: 'CosmosDbMongoDbApiCollection' (Required): Type of dataset. -* **typeProperties**: [CosmosDbMongoDbApiCollectionDatasetTypeProperties](#cosmosdbmongodbapicollectiondatasettypeproperties) (Required): CosmosDB (MongoDB API) database dataset properties. +## AmazonS3DatasetTypeProperties +### Properties +* **bucketName**: any (Required): Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **key**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **prefix**: any: Any object +* **version**: any: Any object -### CosmosDbSqlApiCollectionDataset -#### Properties -* **type**: 'CosmosDbSqlApiCollection' (Required): Type of dataset. -* **typeProperties**: [CosmosDbSqlApiCollectionDatasetTypeProperties](#cosmosdbsqlapicollectiondatasettypeproperties) (Required): CosmosDB (SQL API) Collection dataset properties. +## AmazonS3LinkedServiceTypeProperties +### Properties +* **accessKeyId**: any: Any object +* **authenticationType**: any: Any object +* **encryptedCredential**: any: Any object +* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **serviceUrl**: any: Any object +* **sessionToken**: [SecretBase](#secretbase): The base definition of a secret type. -### CouchbaseTableDataset -#### Properties -* **type**: 'CouchbaseTable' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AppendVariableActivityTypeProperties +### Properties +* **value**: any: Any object +* **variableName**: string: Name of the variable whose value needs to be appended to. -### CustomDataset -#### Properties -* **type**: 'CustomDataset' (Required): Type of dataset. -* **typeProperties**: any: Any object - -### Db2TableDataset -#### Properties -* **type**: 'Db2Table' (Required): Type of dataset. -* **typeProperties**: [Db2TableDatasetTypeProperties](#db2tabledatasettypeproperties): Db2 table dataset properties. +## AppFiguresLinkedServiceTypeProperties +### Properties +* **clientKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **userName**: any (Required): Any object -### DelimitedTextDataset -#### Properties -* **type**: 'DelimitedText' (Required): Type of dataset. -* **typeProperties**: [DelimitedTextDatasetTypeProperties](#delimitedtextdatasettypeproperties): DelimitedText dataset properties. +## AsanaLinkedServiceTypeProperties +### Properties +* **apiToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **encryptedCredential**: any: Any object -### DocumentDbCollectionDataset -#### Properties -* **type**: 'DocumentDbCollection' (Required): Type of dataset. -* **typeProperties**: [DocumentDbCollectionDatasetTypeProperties](#documentdbcollectiondatasettypeproperties) (Required): DocumentDB Collection dataset properties. +## AvroDatasetTypeProperties +### Properties +* **avroCompressionCodec**: any: Any object +* **avroCompressionLevel**: int +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -### DrillTableDataset -#### Properties -* **type**: 'DrillTable' (Required): Type of dataset. -* **typeProperties**: [DrillDatasetTypeProperties](#drilldatasettypeproperties): Drill Dataset Properties +## AvroWriteSettings +### Properties +* **fileNamePrefix**: any: Any object +* **maxRowsPerFile**: any: Any object +* **recordName**: string: Top level record name in write result, which is required in AVRO spec. +* **recordNamespace**: string: Record namespace in the write result. +* **type**: string (Required): The write setting type. +### Additional Properties +* **Additional Properties Type**: any -### DynamicsAXResourceDataset -#### Properties -* **type**: 'DynamicsAXResource' (Required): Type of dataset. -* **typeProperties**: [DynamicsAXResourceDatasetTypeProperties](#dynamicsaxresourcedatasettypeproperties) (Required): Dynamics AX OData resource dataset properties. +## AzPowerShellSetupTypeProperties +### Properties +* **version**: string (Required): The required version of Azure PowerShell to install. -### DynamicsCrmEntityDataset -#### Properties -* **type**: 'DynamicsCrmEntity' (Required): Type of dataset. -* **typeProperties**: [DynamicsCrmEntityDatasetTypeProperties](#dynamicscrmentitydatasettypeproperties): Dynamics CRM entity dataset properties. +## AzureBatchLinkedServiceTypeProperties +### Properties +* **accessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **accountName**: any (Required): Any object +* **batchUri**: any (Required): Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: any: Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **poolName**: any (Required): Any object -### DynamicsEntityDataset -#### Properties -* **type**: 'DynamicsEntity' (Required): Type of dataset. -* **typeProperties**: [DynamicsEntityDatasetTypeProperties](#dynamicsentitydatasettypeproperties): Dynamics entity dataset properties. +## AzureBlobDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileName**: any: Any object +* **folderPath**: any: Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **tableRootLocation**: any: Any object -### EloquaObjectDataset -#### Properties -* **type**: 'EloquaObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureBlobFSDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileName**: any: Any object +* **folderPath**: any: Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -### ExcelDataset -#### Properties -* **type**: 'Excel' (Required): Type of dataset. -* **typeProperties**: [ExcelDatasetTypeProperties](#exceldatasettypeproperties): Excel dataset properties. +## AzureBlobFSLinkedServiceTypeProperties +### Properties +* **accountKey**: any: Any object +* **azureCloudType**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: any: Any object +* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalCredentialType**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object +* **url**: any (Required): Any object -### FileShareDataset -#### Properties -* **type**: 'FileShare' (Required): Type of dataset. -* **typeProperties**: [FileShareDatasetTypeProperties](#filesharedatasettypeproperties): On-premises file system dataset properties. +## AzureBlobStorageLinkedServiceTypeProperties +### Properties +* **accountKey**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **accountKind**: 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). +* **azureCloudType**: any: Any object +* **connectionString**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: string: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). +* **sasToken**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **sasUri**: any: Any object +* **serviceEndpoint**: string: Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object -### GoogleAdWordsObjectDataset -#### Properties -* **type**: 'GoogleAdWordsObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureDatabricksDeltaLakeDatasetTypeProperties +### Properties +* **database**: any: Any object +* **table**: any: Any object -### GoogleBigQueryObjectDataset -#### Properties -* **type**: 'GoogleBigQueryObject' (Required): Type of dataset. -* **typeProperties**: [GoogleBigQueryDatasetTypeProperties](#googlebigquerydatasettypeproperties): Google BigQuery Dataset Properties +## AzureDatabricksDeltaLakeExportCommand +### Properties +* **dateFormat**: any: Any object +* **timestampFormat**: any: Any object +* **type**: string (Required): The export setting type. +### Additional Properties +* **Additional Properties Type**: any -### GreenplumTableDataset -#### Properties -* **type**: 'GreenplumTable' (Required): Type of dataset. -* **typeProperties**: [GreenplumDatasetTypeProperties](#greenplumdatasettypeproperties): Greenplum Dataset Properties +## AzureDatabricksDeltaLakeImportCommand +### Properties +* **dateFormat**: any: Any object +* **timestampFormat**: any: Any object +* **type**: string (Required): The import setting type. +### Additional Properties +* **Additional Properties Type**: any -### HBaseObjectDataset -#### Properties -* **type**: 'HBaseObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureDatabricksDetltaLakeLinkedServiceTypeProperties +### Properties +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **clusterId**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **domain**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **workspaceResourceId**: any: Any object -### HiveObjectDataset -#### Properties -* **type**: 'HiveObject' (Required): Type of dataset. -* **typeProperties**: [HiveDatasetTypeProperties](#hivedatasettypeproperties): Hive Properties +## AzureDatabricksLinkedServiceTypeProperties +### Properties +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **authentication**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **domain**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **existingClusterId**: any: Any object +* **instancePoolId**: any: Any object +* **newClusterCustomTags**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags](#azuredatabrickslinkedservicetypepropertiesnewclustercustomtags): Additional tags for cluster resources. This property is ignored in instance pool configurations. +* **newClusterDriverNodeType**: any: Any object +* **newClusterEnableElasticDisk**: any: Any object +* **newClusterInitScripts**: any: Any object +* **newClusterLogDestination**: any: Any object +* **newClusterNodeType**: any: Any object +* **newClusterNumOfWorker**: any: Any object +* **newClusterSparkConf**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf](#azuredatabrickslinkedservicetypepropertiesnewclustersparkconf): A set of optional, user-specified Spark configuration key-value pairs. +* **newClusterSparkEnvVars**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars](#azuredatabrickslinkedservicetypepropertiesnewclustersparkenvvars): A set of optional, user-specified Spark environment variables key-value pairs. +* **newClusterVersion**: any: Any object +* **policyId**: any: Any object +* **workspaceResourceId**: any: Any object -### HttpDataset -#### Properties -* **type**: 'HttpFile' (Required): Type of dataset. -* **typeProperties**: [HttpDatasetTypeProperties](#httpdatasettypeproperties): Properties specific to this dataset type. +## AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags +### Properties +### Additional Properties +* **Additional Properties Type**: any -### HubspotObjectDataset -#### Properties -* **type**: 'HubspotObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf +### Properties +### Additional Properties +* **Additional Properties Type**: any -### ImpalaObjectDataset -#### Properties -* **type**: 'ImpalaObject' (Required): Type of dataset. -* **typeProperties**: [ImpalaDatasetTypeProperties](#impaladatasettypeproperties): Impala Dataset Properties +## AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars +### Properties +### Additional Properties +* **Additional Properties Type**: any -### InformixTableDataset -#### Properties -* **type**: 'InformixTable' (Required): Type of dataset. -* **typeProperties**: [InformixTableDatasetTypeProperties](#informixtabledatasettypeproperties): Informix table dataset properties. +## AzureDataExplorerCommandActivityTypeProperties +### Properties +* **command**: any (Required): Any object +* **commandTimeout**: any: Any object -### JiraObjectDataset -#### Properties -* **type**: 'JiraObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureDataExplorerDatasetTypeProperties +### Properties +* **table**: any: Any object -### JsonDataset -#### Properties -* **type**: 'Json' (Required): Type of dataset. -* **typeProperties**: [JsonDatasetTypeProperties](#jsondatasettypeproperties): Json dataset properties. +## AzureDataExplorerLinkedServiceTypeProperties +### Properties +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **database**: any (Required): Any object +* **endpoint**: any (Required): Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object -### MagentoObjectDataset -#### Properties -* **type**: 'MagentoObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureDataLakeAnalyticsLinkedServiceTypeProperties +### Properties +* **accountName**: any (Required): Any object +* **dataLakeAnalyticsUri**: any: Any object +* **encryptedCredential**: any: Any object +* **resourceGroupName**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **subscriptionId**: any: Any object +* **tenant**: any (Required): Any object -### MariaDBTableDataset -#### Properties -* **type**: 'MariaDBTable' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. - -### MarketoObjectDataset -#### Properties -* **type**: 'MarketoObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. - -### MicrosoftAccessTableDataset -#### Properties -* **type**: 'MicrosoftAccessTable' (Required): Type of dataset. -* **typeProperties**: [MicrosoftAccessTableDatasetTypeProperties](#microsoftaccesstabledatasettypeproperties): Microsoft Access table dataset properties. +## AzureDataLakeStoreDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileName**: any: Any object +* **folderPath**: any: Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -### MongoDbAtlasCollectionDataset -#### Properties -* **type**: 'MongoDbAtlasCollection' (Required): Type of dataset. -* **typeProperties**: [MongoDbAtlasCollectionDatasetTypeProperties](#mongodbatlascollectiondatasettypeproperties) (Required): MongoDB Atlas database dataset properties. +## AzureDataLakeStoreLinkedServiceTypeProperties +### Properties +* **accountName**: any: Any object +* **azureCloudType**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **dataLakeStoreUri**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **resourceGroupName**: any: Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **subscriptionId**: any: Any object +* **tenant**: any: Any object -### MongoDbCollectionDataset -#### Properties -* **type**: 'MongoDbCollection' (Required): Type of dataset. -* **typeProperties**: [MongoDbCollectionDatasetTypeProperties](#mongodbcollectiondatasettypeproperties) (Required): MongoDB database dataset properties. +## AzureFileStorageLinkedServiceTypeProperties +### Properties +* **accountKey**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **fileShare**: any: Any object +* **host**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **sasToken**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **sasUri**: any: Any object +* **snapshot**: any: Any object +* **userId**: any: Any object -### MongoDbV2CollectionDataset -#### Properties -* **type**: 'MongoDbV2Collection' (Required): Type of dataset. -* **typeProperties**: [MongoDbV2CollectionDatasetTypeProperties](#mongodbv2collectiondatasettypeproperties) (Required): MongoDB database dataset properties. +## AzureFunctionActivityTypeProperties +### Properties +* **body**: any: Any object +* **functionName**: any (Required): Any object +* **headers**: any: Any object +* **method**: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'TRACE' | string (Required): The list of HTTP methods supported by a AzureFunctionActivity. -### MySqlTableDataset -#### Properties -* **type**: 'MySqlTable' (Required): Type of dataset. -* **typeProperties**: [MySqlTableDatasetTypeProperties](#mysqltabledatasettypeproperties): MySql table dataset properties. +## AzureFunctionLinkedServiceTypeProperties +### Properties +* **authentication**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: any: Any object +* **functionAppUrl**: any (Required): Any object +* **functionKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **resourceId**: any: Any object -### NetezzaTableDataset -#### Properties -* **type**: 'NetezzaTable' (Required): Type of dataset. -* **typeProperties**: [NetezzaTableDatasetTypeProperties](#netezzatabledatasettypeproperties): Netezza dataset properties. +## AzureKeyVaultLinkedServiceTypeProperties +### Properties +* **baseUrl**: any (Required): Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. -### ODataResourceDataset -#### Properties -* **type**: 'ODataResource' (Required): Type of dataset. -* **typeProperties**: [ODataResourceDatasetTypeProperties](#odataresourcedatasettypeproperties): OData dataset properties. +## AzureKeyVaultSecretReference +### Properties +* **secretName**: any (Required): Any object +* **secretVersion**: any: Any object +* **store**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **type**: string (Required): Type of the secret. -### OdbcTableDataset -#### Properties -* **type**: 'OdbcTable' (Required): Type of dataset. -* **typeProperties**: [OdbcTableDatasetTypeProperties](#odbctabledatasettypeproperties): ODBC table dataset properties. +## AzureMariaDBLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### Office365Dataset -#### Properties -* **type**: 'Office365Table' (Required): Type of dataset. -* **typeProperties**: [Office365DatasetTypeProperties](#office365datasettypeproperties) (Required): Office365 dataset properties. +## AzureMLBatchExecutionActivityTypeProperties +### Properties +* **globalParameters**: [AzureMLBatchExecutionActivityTypePropertiesGlobalParameters](#azuremlbatchexecutionactivitytypepropertiesglobalparameters): 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. +* **webServiceInputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs](#azuremlbatchexecutionactivitytypepropertieswebserviceinputs): 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. +* **webServiceOutputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs](#azuremlbatchexecutionactivitytypepropertieswebserviceoutputs): 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. -### OracleServiceCloudObjectDataset -#### Properties -* **type**: 'OracleServiceCloudObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureMLBatchExecutionActivityTypePropertiesGlobalParameters +### Properties +### Additional Properties +* **Additional Properties Type**: any -### OracleTableDataset -#### Properties -* **type**: 'OracleTable' (Required): Type of dataset. -* **typeProperties**: [OracleTableDatasetTypeProperties](#oracletabledatasettypeproperties): On-premises Oracle dataset properties. +## AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs +### Properties +### Additional Properties +* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) -### OrcDataset -#### Properties -* **type**: 'Orc' (Required): Type of dataset. -* **typeProperties**: [OrcDatasetTypeProperties](#orcdatasettypeproperties): ORC dataset properties. +## AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs +### Properties +### Additional Properties +* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) -### ParquetDataset -#### Properties -* **type**: 'Parquet' (Required): Type of dataset. -* **typeProperties**: [ParquetDatasetTypeProperties](#parquetdatasettypeproperties): Parquet dataset properties. +## AzureMLExecutePipelineActivityTypeProperties +### Properties +* **continueOnStepFailure**: any: Any object +* **dataPathAssignments**: any: Any object +* **experimentName**: any: Any object +* **mlParentRunId**: any: Any object +* **mlPipelineEndpointId**: any: Any object +* **mlPipelineId**: any: Any object +* **mlPipelineParameters**: any: Any object +* **version**: any: Any object -### PaypalObjectDataset -#### Properties -* **type**: 'PaypalObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureMLLinkedServiceTypeProperties +### Properties +* **apiKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **authentication**: any: Any object +* **encryptedCredential**: any: Any object +* **mlEndpoint**: any (Required): Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object +* **updateResourceEndpoint**: any: Any object -### PhoenixObjectDataset -#### Properties -* **type**: 'PhoenixObject' (Required): Type of dataset. -* **typeProperties**: [PhoenixDatasetTypeProperties](#phoenixdatasettypeproperties): Phoenix Dataset Properties +## AzureMLServiceLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **mlWorkspaceName**: any (Required): Any object +* **resourceGroupName**: any (Required): Any object +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **subscriptionId**: any (Required): Any object +* **tenant**: any: Any object -### PostgreSqlTableDataset -#### Properties -* **type**: 'PostgreSqlTable' (Required): Type of dataset. -* **typeProperties**: [PostgreSqlTableDatasetTypeProperties](#postgresqltabledatasettypeproperties): PostgreSQL table dataset properties. +## AzureMLUpdateResourceActivityTypeProperties +### Properties +* **trainedModelFilePath**: any (Required): Any object +* **trainedModelLinkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **trainedModelName**: any (Required): Any object -### PrestoObjectDataset -#### Properties -* **type**: 'PrestoObject' (Required): Type of dataset. -* **typeProperties**: [PrestoDatasetTypeProperties](#prestodatasettypeproperties): Presto Dataset Properties +## AzureMLWebServiceFile +### Properties +* **filePath**: any (Required): Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -### QuickBooksObjectDataset -#### Properties -* **type**: 'QuickBooksObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureMySqlLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### RelationalTableDataset -#### Properties -* **type**: 'RelationalTable' (Required): Type of dataset. -* **typeProperties**: [RelationalTableDatasetTypeProperties](#relationaltabledatasettypeproperties): Relational table dataset properties. +## AzureMySqlTableDatasetTypeProperties +### Properties +* **table**: any: Any object +* **tableName**: any: Any object -### ResponsysObjectDataset -#### Properties -* **type**: 'ResponsysObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzurePostgreSqlLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### RestResourceDataset -#### Properties -* **type**: 'RestResource' (Required): Type of dataset. -* **typeProperties**: [RestResourceDatasetTypeProperties](#restresourcedatasettypeproperties): Properties specific to this dataset type. +## AzurePostgreSqlTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### SalesforceMarketingCloudObjectDataset -#### Properties -* **type**: 'SalesforceMarketingCloudObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureSearchIndexDatasetTypeProperties +### Properties +* **indexName**: any (Required): Any object -### SalesforceObjectDataset -#### Properties -* **type**: 'SalesforceObject' (Required): Type of dataset. -* **typeProperties**: [SalesforceObjectDatasetTypeProperties](#salesforceobjectdatasettypeproperties): Salesforce object dataset properties. +## AzureSearchLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **key**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object -### SalesforceServiceCloudObjectDataset -#### Properties -* **type**: 'SalesforceServiceCloudObject' (Required): Type of dataset. -* **typeProperties**: [SalesforceServiceCloudObjectDatasetTypeProperties](#salesforceservicecloudobjectdatasettypeproperties): Salesforce Service Cloud object dataset properties. +## AzureSqlDatabaseLinkedServiceTypeProperties +### Properties +* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. +* **azureCloudType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object -### SapBwCubeDataset -#### Properties -* **type**: 'SapBwCube' (Required): Type of dataset. - -### SapCloudForCustomerResourceDataset -#### Properties -* **type**: 'SapCloudForCustomerResource' (Required): Type of dataset. -* **typeProperties**: [SapCloudForCustomerResourceDatasetTypeProperties](#sapcloudforcustomerresourcedatasettypeproperties) (Required): Sap Cloud For Customer OData resource dataset properties. - -### SapEccResourceDataset -#### Properties -* **type**: 'SapEccResource' (Required): Type of dataset. -* **typeProperties**: [SapEccResourceDatasetTypeProperties](#sapeccresourcedatasettypeproperties) (Required): Sap ECC OData resource dataset properties. - -### SapHanaTableDataset -#### Properties -* **type**: 'SapHanaTable' (Required): Type of dataset. -* **typeProperties**: [SapHanaTableDatasetTypeProperties](#saphanatabledatasettypeproperties): SAP HANA Table properties. - -### SapOpenHubTableDataset -#### Properties -* **type**: 'SapOpenHubTable' (Required): Type of dataset. -* **typeProperties**: [SapOpenHubTableDatasetTypeProperties](#sapopenhubtabledatasettypeproperties) (Required): Sap Business Warehouse Open Hub Destination Table properties. - -### SapTableResourceDataset -#### Properties -* **type**: 'SapTableResource' (Required): Type of dataset. -* **typeProperties**: [SapTableResourceDatasetTypeProperties](#saptableresourcedatasettypeproperties) (Required): SAP Table Resource properties. - -### ServiceNowObjectDataset -#### Properties -* **type**: 'ServiceNowObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. - -### SharePointOnlineListResourceDataset -#### Properties -* **type**: 'SharePointOnlineListResource' (Required): Type of dataset. -* **typeProperties**: [SharePointOnlineListDatasetTypeProperties](#sharepointonlinelistdatasettypeproperties): Sharepoint online list dataset properties. - -### ShopifyObjectDataset -#### Properties -* **type**: 'ShopifyObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. - -### SnowflakeDataset -#### Properties -* **type**: 'SnowflakeTable' (Required): Type of dataset. -* **typeProperties**: [SnowflakeDatasetTypeProperties](#snowflakedatasettypeproperties) (Required): Snowflake dataset properties. - -### SparkObjectDataset -#### Properties -* **type**: 'SparkObject' (Required): Type of dataset. -* **typeProperties**: [SparkDatasetTypeProperties](#sparkdatasettypeproperties): Spark Properties +## AzureSqlDWLinkedServiceTypeProperties +### Properties +* **azureCloudType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object -### SqlServerTableDataset -#### Properties -* **type**: 'SqlServerTable' (Required): Type of dataset. -* **typeProperties**: [SqlServerTableDatasetTypeProperties](#sqlservertabledatasettypeproperties): On-premises SQL Server dataset properties. +## AzureSqlDWTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### SquareObjectDataset -#### Properties -* **type**: 'SquareObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureSqlMILinkedServiceTypeProperties +### Properties +* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. +* **azureCloudType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object -### SybaseTableDataset -#### Properties -* **type**: 'SybaseTable' (Required): Type of dataset. -* **typeProperties**: [SybaseTableDatasetTypeProperties](#sybasetabledatasettypeproperties): Sybase table dataset properties. +## AzureSqlMITableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### TeradataTableDataset -#### Properties -* **type**: 'TeradataTable' (Required): Type of dataset. -* **typeProperties**: [TeradataTableDatasetTypeProperties](#teradatatabledatasettypeproperties): Teradata dataset properties. +## AzureSqlSinkStoredProcedureParameters +### Properties +### Additional Properties +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -### VerticaTableDataset -#### Properties -* **type**: 'VerticaTable' (Required): Type of dataset. -* **typeProperties**: [VerticaDatasetTypeProperties](#verticadatasettypeproperties): Vertica Properties +## AzureSqlSourceStoredProcedureParameters +### Properties +### Additional Properties +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -### WebTableDataset -#### Properties -* **type**: 'WebTable' (Required): Type of dataset. -* **typeProperties**: [WebTableDatasetTypeProperties](#webtabledatasettypeproperties) (Required): Web table dataset properties. +## AzureSqlTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### XeroObjectDataset -#### Properties -* **type**: 'XeroObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## AzureStorageLinkedServiceTypeProperties +### Properties +* **accountKey**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **connectionString**: any: Any object +* **encryptedCredential**: string: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). +* **sasToken**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **sasUri**: any: Any object -### XmlDataset -#### Properties -* **type**: 'Xml' (Required): Type of dataset. -* **typeProperties**: [XmlDatasetTypeProperties](#xmldatasettypeproperties): Xml dataset properties. +## AzureTableDatasetTypeProperties +### Properties +* **tableName**: any (Required): Any object -### ZohoObjectDataset -#### Properties -* **type**: 'ZohoObject' (Required): Type of dataset. -* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +## BinaryDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +## BinaryReadSettings +### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **type**: string (Required): The read setting type. +### Additional Properties +* **Additional Properties Type**: any -## DatasetFolder +## BlobEventsTriggerTypeProperties ### Properties -* **name**: string: The name of the folder that this Dataset is in. +* **blobPathBeginsWith**: string: 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. +* **blobPathEndsWith**: 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. +* **events**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobDeleted' | string[] (Required): Blob event types. +* **ignoreEmptyBlobs**: bool: If set to true, blobs with zero bytes will be ignored. +* **scope**: string (Required): The ARM resource ID of the Storage Account. -## ParameterDefinitionSpecification +## BlobTriggerTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) +* **folderPath**: string (Required): The path of the container/folder that will trigger the pipeline. +* **linkedService**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **maxConcurrency**: int (Required): The max number of parallel files to handle when it is triggered. -## ParameterSpecification +## CassandraLinkedServiceTypeProperties ### Properties -* **defaultValue**: any: Any object -* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'Object' | 'SecureString' | 'String' | string (Required): Parameter type. +* **authenticationType**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **username**: any: Any object -## GenericDatasetTypeProperties +## CassandraTableDatasetTypeProperties ### Properties +* **keyspace**: any: Any object * **tableName**: any: Any object -## AmazonRdsForOracleTableDatasetTypeProperties +## ChainingTriggerTypeProperties ### Properties -* **schema**: any: Any object -* **table**: any: Any object +* **dependsOn**: [PipelineReference](#pipelinereference)[] (Required): Upstream Pipelines. +* **runDimension**: string (Required): Run Dimension property that needs to be emitted by upstream pipelines. -## AmazonRdsForSqlServerTableDatasetTypeProperties +## CmdkeySetupTypeProperties ### Properties -* **schema**: any: Any object -* **table**: any: Any object +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object -## AmazonRedshiftTableDatasetTypeProperties +## CMKIdentityDefinition ### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +* **userAssignedIdentity**: string: The resource id of the user assigned identity to authenticate to customer's key vault. -## AmazonS3DatasetTypeProperties +## CommonDataServiceForAppsEntityDatasetTypeProperties ### Properties -* **bucketName**: any (Required): Any object -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **key**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **prefix**: any: Any object -* **version**: any: Any object +* **entityName**: any: Any object -## DatasetCompression +## CommonDataServiceForAppsLinkedServiceTypeProperties ### Properties -* **level**: any: Any object -* **type**: any (Required): Any object -### Additional Properties -* **Additional Properties Type**: any +* **authenticationType**: any (Required): Any object +* **deploymentType**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **hostName**: any: Any object +* **organizationName**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalCredentialType**: any: Any object +* **servicePrincipalId**: any: Any object +* **serviceUri**: any: Any object +* **username**: any: Any object -## DatasetStorageFormat +## CompressionReadSettings * **Discriminator**: type ### Base Properties -* **deserializer**: any: Any object -* **serializer**: any: Any object -### AvroFormat +### TarGZipReadSettings #### Properties -* **type**: 'AvroFormat' (Required): Type of dataset storage format. +* **preserveCompressionFileNameAsFolder**: any: Any object +* **type**: 'TarGZipReadSettings' (Required): The Compression setting type. -### JsonFormat +### TarReadSettings #### Properties -* **encodingName**: any: Any object -* **filePattern**: any: Any object -* **jsonNodeReference**: any: Any object -* **jsonPathDefinition**: any: Any object -* **nestingSeparator**: any: Any object -* **type**: 'JsonFormat' (Required): Type of dataset storage format. +* **preserveCompressionFileNameAsFolder**: any: Any object +* **type**: 'TarReadSettings' (Required): The Compression setting type. -### OrcFormat +### ZipDeflateReadSettings #### Properties -* **type**: 'OrcFormat' (Required): Type of dataset storage format. +* **preserveZipFileNameAsFolder**: any: Any object +* **type**: 'ZipDeflateReadSettings' (Required): The Compression setting type. -### ParquetFormat -#### Properties -* **type**: 'ParquetFormat' (Required): Type of dataset storage format. -### TextFormat -#### Properties -* **columnDelimiter**: any: Any object -* **encodingName**: any: Any object -* **escapeChar**: any: Any object -* **firstRowAsHeader**: any: Any object -* **nullValue**: any: Any object -* **quoteChar**: any: Any object -* **rowDelimiter**: any: Any object -* **skipLineCount**: any: Any object -* **treatEmptyAsNull**: any: Any object -* **type**: 'TextFormat' (Required): Type of dataset storage format. +## ConcurLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **connectionProperties**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object +## ConnectionStateProperties +### Properties +* **actionsRequired**: string (ReadOnly): The actions required on the managed private endpoint +* **description**: string (ReadOnly): The managed private endpoint description +* **status**: string (ReadOnly): The approval status -## AvroDatasetTypeProperties +## CopyActivityLogSettings ### Properties -* **avroCompressionCodec**: any: Any object -* **avroCompressionLevel**: int -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +* **enableReliableLogging**: any: Any object +* **logLevel**: any: Any object -## DatasetLocation +## CopyActivityTypeProperties +### Properties +* **dataIntegrationUnits**: any: Any object +* **enableSkipIncompatibleRow**: any: Any object +* **enableStaging**: any: Any object +* **logSettings**: [LogSettings](#logsettings): Log settings. +* **logStorageSettings**: [LogStorageSettings](#logstoragesettings): (Deprecated. Please use LogSettings) Log storage settings. +* **parallelCopies**: any: Any object +* **preserve**: any[]: Preserve rules. +* **preserveRules**: any[]: Preserve Rules. +* **redirectIncompatibleRowSettings**: [RedirectIncompatibleRowSettings](#redirectincompatiblerowsettings): Redirect incompatible row settings +* **sink**: [CopySink](#copysink) (Required): A copy activity sink. +* **skipErrorFile**: [SkipErrorFile](#skiperrorfile): Skip error file. +* **source**: [CopySource](#copysource) (Required): A copy activity source. +* **stagingSettings**: [StagingSettings](#stagingsettings): Staging settings. +* **translator**: any: Any object +* **validateDataConsistency**: any: Any object + +## CopySink * **Discriminator**: type ### Base Properties -* **fileName**: any: Any object -* **folderPath**: any: Any object -### AmazonS3CompatibleLocation +* **disableMetricsCollection**: any: Any object +* **maxConcurrentConnections**: any: Any object +* **sinkRetryCount**: any: Any object +* **sinkRetryWait**: any: Any object +* **writeBatchSize**: any: Any object +* **writeBatchTimeout**: any: Any object +### AvroSink #### Properties -* **bucketName**: any: Any object -* **type**: 'AmazonS3CompatibleLocation' (Required): Type of dataset storage location. -* **version**: any: Any object +* **formatSettings**: [AvroWriteSettings](#avrowritesettings): Avro write settings. +* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. +* **type**: 'AvroSink' (Required): Copy sink type. -### AmazonS3Location +### AzureBlobFSSink #### Properties -* **bucketName**: any: Any object -* **type**: 'AmazonS3Location' (Required): Type of dataset storage location. -* **version**: any: Any object +* **copyBehavior**: any: Any object +* **metadata**: [MetadataItem](#metadataitem)[]: Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). +* **type**: 'AzureBlobFSSink' (Required): Copy sink type. -### AzureBlobFSLocation +### AzureDatabricksDeltaLakeSink #### Properties -* **fileSystem**: any: Any object -* **type**: 'AzureBlobFSLocation' (Required): Type of dataset storage location. +* **importSettings**: [AzureDatabricksDeltaLakeImportCommand](#azuredatabricksdeltalakeimportcommand): Azure Databricks Delta Lake import command settings. +* **preCopyScript**: any: Any object +* **type**: 'AzureDatabricksDeltaLakeSink' (Required): Copy sink type. -### AzureBlobStorageLocation +### AzureDataExplorerSink #### Properties -* **container**: any: Any object -* **type**: 'AzureBlobStorageLocation' (Required): Type of dataset storage location. +* **flushImmediately**: any: Any object +* **ingestionMappingAsJson**: any: Any object +* **ingestionMappingName**: any: Any object +* **type**: 'AzureDataExplorerSink' (Required): Copy sink type. -### AzureDataLakeStoreLocation +### AzureDataLakeStoreSink #### Properties -* **type**: 'AzureDataLakeStoreLocation' (Required): Type of dataset storage location. +* **copyBehavior**: any: Any object +* **enableAdlsSingleFileParallel**: any: Any object +* **type**: 'AzureDataLakeStoreSink' (Required): Copy sink type. -### AzureFileStorageLocation +### AzureMySqlSink #### Properties -* **type**: 'AzureFileStorageLocation' (Required): Type of dataset storage location. +* **preCopyScript**: any: Any object +* **type**: 'AzureMySqlSink' (Required): Copy sink type. -### FileServerLocation +### AzurePostgreSqlSink #### Properties -* **type**: 'FileServerLocation' (Required): Type of dataset storage location. +* **preCopyScript**: any: Any object +* **type**: 'AzurePostgreSqlSink' (Required): Copy sink type. -### FtpServerLocation +### AzureQueueSink #### Properties -* **type**: 'FtpServerLocation' (Required): Type of dataset storage location. +* **type**: 'AzureQueueSink' (Required): Copy sink type. -### GoogleCloudStorageLocation +### AzureSearchIndexSink #### Properties -* **bucketName**: any: Any object -* **type**: 'GoogleCloudStorageLocation' (Required): Type of dataset storage location. -* **version**: any: Any object +* **type**: 'AzureSearchIndexSink' (Required): Copy sink type. +* **writeBehavior**: 'Merge' | 'Upload' | string: Specify the write behavior when upserting documents into Azure Search Index. -### HdfsLocation +### AzureSqlSink #### Properties -* **type**: 'HdfsLocation' (Required): Type of dataset storage location. +* **preCopyScript**: any: Any object +* **sqlWriterStoredProcedureName**: any: Any object +* **sqlWriterTableType**: any: Any object +* **sqlWriterUseTableLock**: any: Any object +* **storedProcedureParameters**: [AzureSqlSinkStoredProcedureParameters](#azuresqlsinkstoredprocedureparameters): SQL stored procedure parameters. +* **storedProcedureTableTypeParameterName**: any: Any object +* **tableOption**: any: Any object +* **type**: 'AzureSqlSink' (Required): Copy sink type. +* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings +* **writeBehavior**: any: Any object -### HttpServerLocation +### AzureTableSink #### Properties -* **relativeUrl**: any: Any object -* **type**: 'HttpServerLocation' (Required): Type of dataset storage location. +* **azureTableDefaultPartitionKeyValue**: any: Any object +* **azureTableInsertType**: any: Any object +* **azureTablePartitionKeyName**: any: Any object +* **azureTableRowKeyName**: any: Any object +* **type**: 'AzureTableSink' (Required): Copy sink type. -### OracleCloudStorageLocation +### BinarySink #### Properties -* **bucketName**: any: Any object -* **type**: 'OracleCloudStorageLocation' (Required): Type of dataset storage location. -* **version**: any: Any object +* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. +* **type**: 'BinarySink' (Required): Copy sink type. -### SftpLocation +### BlobSink #### Properties -* **type**: 'SftpLocation' (Required): Type of dataset storage location. +* **blobWriterAddHeader**: any: Any object +* **blobWriterDateTimeFormat**: any: Any object +* **blobWriterOverwriteFiles**: any: Any object +* **copyBehavior**: any: Any object +* **metadata**: [MetadataItem](#metadataitem)[]: Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). +* **type**: 'BlobSink' (Required): Copy sink type. +### CommonDataServiceForAppsSink +#### Properties +* **alternateKeyName**: any: Any object +* **ignoreNullValues**: any: Any object +* **type**: 'CommonDataServiceForAppsSink' (Required): Copy sink type. +* **writeBehavior**: 'Upsert' | string (Required): Defines values for DynamicsSinkWriteBehavior. -## AzureBlobDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileName**: any: Any object -* **folderPath**: any: Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **tableRootLocation**: any: Any object +### CosmosDbMongoDbApiSink +#### Properties +* **type**: 'CosmosDbMongoDbApiSink' (Required): Copy sink type. +* **writeBehavior**: any: Any object -## AzureBlobFSDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileName**: any: Any object -* **folderPath**: any: Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +### CosmosDbSqlApiSink +#### Properties +* **type**: 'CosmosDbSqlApiSink' (Required): Copy sink type. +* **writeBehavior**: any: Any object -## AzureDatabricksDeltaLakeDatasetTypeProperties -### Properties -* **database**: any: Any object -* **table**: any: Any object +### DelimitedTextSink +#### Properties +* **formatSettings**: [DelimitedTextWriteSettings](#delimitedtextwritesettings): Delimited text write settings. +* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. +* **type**: 'DelimitedTextSink' (Required): Copy sink type. -## AzureDataExplorerDatasetTypeProperties -### Properties -* **table**: any: Any object +### DocumentDbCollectionSink +#### Properties +* **nestingSeparator**: any: Any object +* **type**: 'DocumentDbCollectionSink' (Required): Copy sink type. +* **writeBehavior**: any: Any object -## AzureDataLakeStoreDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileName**: any: Any object -* **folderPath**: any: Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +### DynamicsCrmSink +#### Properties +* **alternateKeyName**: any: Any object +* **ignoreNullValues**: any: Any object +* **type**: 'DynamicsCrmSink' (Required): Copy sink type. +* **writeBehavior**: 'Upsert' | string (Required): Defines values for DynamicsSinkWriteBehavior. -## AzureMySqlTableDatasetTypeProperties -### Properties -* **table**: any: Any object -* **tableName**: any: Any object +### DynamicsSink +#### Properties +* **alternateKeyName**: any: Any object +* **ignoreNullValues**: any: Any object +* **type**: 'DynamicsSink' (Required): Copy sink type. +* **writeBehavior**: 'Upsert' | string (Required): Defines values for DynamicsSinkWriteBehavior. -## AzurePostgreSqlTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### FileSystemSink +#### Properties +* **copyBehavior**: any: Any object +* **type**: 'FileSystemSink' (Required): Copy sink type. -## AzureSearchIndexDatasetTypeProperties -### Properties -* **indexName**: any (Required): Any object +### InformixSink +#### Properties +* **preCopyScript**: any: Any object +* **type**: 'InformixSink' (Required): Copy sink type. -## AzureSqlDWTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### JsonSink +#### Properties +* **formatSettings**: [JsonWriteSettings](#jsonwritesettings): Json write settings. +* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. +* **type**: 'JsonSink' (Required): Copy sink type. -## AzureSqlMITableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### MicrosoftAccessSink +#### Properties +* **preCopyScript**: any: Any object +* **type**: 'MicrosoftAccessSink' (Required): Copy sink type. -## AzureSqlTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### MongoDbAtlasSink +#### Properties +* **type**: 'MongoDbAtlasSink' (Required): Copy sink type. +* **writeBehavior**: any: Any object -## AzureTableDatasetTypeProperties -### Properties -* **tableName**: any (Required): Any object +### MongoDbV2Sink +#### Properties +* **type**: 'MongoDbV2Sink' (Required): Copy sink type. +* **writeBehavior**: any: Any object -## BinaryDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +### OdbcSink +#### Properties +* **preCopyScript**: any: Any object +* **type**: 'OdbcSink' (Required): Copy sink type. -## CassandraTableDatasetTypeProperties -### Properties -* **keyspace**: any: Any object -* **tableName**: any: Any object +### OracleSink +#### Properties +* **preCopyScript**: any: Any object +* **type**: 'OracleSink' (Required): Copy sink type. -## CommonDataServiceForAppsEntityDatasetTypeProperties -### Properties -* **entityName**: any: Any object +### OrcSink +#### Properties +* **formatSettings**: [OrcWriteSettings](#orcwritesettings): Orc write settings. +* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. +* **type**: 'OrcSink' (Required): Copy sink type. -## CosmosDbMongoDbApiCollectionDatasetTypeProperties -### Properties -* **collection**: any (Required): Any object +### ParquetSink +#### Properties +* **formatSettings**: [ParquetWriteSettings](#parquetwritesettings): Parquet write settings. +* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. +* **type**: 'ParquetSink' (Required): Copy sink type. -## CosmosDbSqlApiCollectionDatasetTypeProperties -### Properties -* **collectionName**: any (Required): Any object +### RestSink +#### Properties +* **additionalHeaders**: any: Any object +* **httpCompressionType**: any: Any object +* **httpRequestTimeout**: any: Any object +* **requestInterval**: any: Any object +* **requestMethod**: any: Any object +* **type**: 'RestSink' (Required): Copy sink type. -## Db2TableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### SalesforceServiceCloudSink +#### Properties +* **externalIdFieldName**: any: Any object +* **ignoreNullValues**: any: Any object +* **type**: 'SalesforceServiceCloudSink' (Required): Copy sink type. +* **writeBehavior**: 'Insert' | 'Upsert' | string: The write behavior for the operation. Default is Insert. -## DelimitedTextDatasetTypeProperties -### Properties -* **columnDelimiter**: any: Any object -* **compressionCodec**: any: Any object -* **compressionLevel**: any: Any object -* **encodingName**: any: Any object -* **escapeChar**: any: Any object -* **firstRowAsHeader**: any: Any object -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -* **nullValue**: any: Any object -* **quoteChar**: any: Any object -* **rowDelimiter**: any: Any object +### SalesforceSink +#### Properties +* **externalIdFieldName**: any: Any object +* **ignoreNullValues**: any: Any object +* **type**: 'SalesforceSink' (Required): Copy sink type. +* **writeBehavior**: 'Insert' | 'Upsert' | string: The write behavior for the operation. Default is Insert. -## DocumentDbCollectionDatasetTypeProperties -### Properties -* **collectionName**: any (Required): Any object +### SapCloudForCustomerSink +#### Properties +* **httpRequestTimeout**: any: Any object +* **type**: 'SapCloudForCustomerSink' (Required): Copy sink type. +* **writeBehavior**: 'Insert' | 'Update' | string: The write behavior for the operation. Default is 'Insert'. -## DrillDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### SnowflakeSink +#### Properties +* **importSettings**: [SnowflakeImportCopyCommand](#snowflakeimportcopycommand): Snowflake import command settings. +* **preCopyScript**: any: Any object +* **type**: 'SnowflakeSink' (Required): Copy sink type. -## DynamicsAXResourceDatasetTypeProperties -### Properties -* **path**: any (Required): Any object +### SqlDWSink +#### Properties +* **allowCopyCommand**: any: Any object +* **allowPolyBase**: any: Any object +* **copyCommandSettings**: [DWCopyCommandSettings](#dwcopycommandsettings): DW Copy Command settings. +* **polyBaseSettings**: [PolybaseSettings](#polybasesettings): PolyBase settings. +* **preCopyScript**: any: Any object +* **sqlWriterUseTableLock**: any: Any object +* **tableOption**: any: Any object +* **type**: 'SqlDWSink' (Required): Copy sink type. +* **upsertSettings**: [SqlDWUpsertSettings](#sqldwupsertsettings): Sql DW upsert option settings +* **writeBehavior**: any: Any object -## DynamicsCrmEntityDatasetTypeProperties -### Properties -* **entityName**: any: Any object +### SqlMISink +#### Properties +* **preCopyScript**: any: Any object +* **sqlWriterStoredProcedureName**: any: Any object +* **sqlWriterTableType**: any: Any object +* **sqlWriterUseTableLock**: any: Any object +* **storedProcedureParameters**: [SqlMISinkStoredProcedureParameters](#sqlmisinkstoredprocedureparameters): SQL stored procedure parameters. +* **storedProcedureTableTypeParameterName**: any: Any object +* **tableOption**: any: Any object +* **type**: 'SqlMISink' (Required): Copy sink type. +* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings +* **writeBehavior**: any: Any object -## DynamicsEntityDatasetTypeProperties -### Properties -* **entityName**: any: Any object +### SqlServerSink +#### Properties +* **preCopyScript**: any: Any object +* **sqlWriterStoredProcedureName**: any: Any object +* **sqlWriterTableType**: any: Any object +* **sqlWriterUseTableLock**: any: Any object +* **storedProcedureParameters**: [SqlServerSinkStoredProcedureParameters](#sqlserversinkstoredprocedureparameters): SQL stored procedure parameters. +* **storedProcedureTableTypeParameterName**: any: Any object +* **tableOption**: any: Any object +* **type**: 'SqlServerSink' (Required): Copy sink type. +* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings +* **writeBehavior**: any: Any object -## ExcelDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **firstRowAsHeader**: any: Any object -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -* **nullValue**: any: Any object -* **range**: any: Any object -* **sheetIndex**: any: Any object -* **sheetName**: any: Any object +### SqlSink +#### Properties +* **preCopyScript**: any: Any object +* **sqlWriterStoredProcedureName**: any: Any object +* **sqlWriterTableType**: any: Any object +* **sqlWriterUseTableLock**: any: Any object +* **storedProcedureParameters**: [SqlSinkStoredProcedureParameters](#sqlsinkstoredprocedureparameters): SQL stored procedure parameters. +* **storedProcedureTableTypeParameterName**: any: Any object +* **tableOption**: any: Any object +* **type**: 'SqlSink' (Required): Copy sink type. +* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings +* **writeBehavior**: any: Any object -## FileShareDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **fileFilter**: any: Any object -* **fileName**: any: Any object -* **folderPath**: any: Any object -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -## GoogleBigQueryDatasetTypeProperties -### Properties -* **dataset**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +## CopySource +* **Discriminator**: type -## GreenplumDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### Base Properties +* **disableMetricsCollection**: any: Any object +* **maxConcurrentConnections**: any: Any object +* **sourceRetryCount**: any: Any object +* **sourceRetryWait**: any: Any object +### AmazonMWSSource +#### Properties +* **query**: any: Any object +* **type**: 'AmazonMWSSource' (Required): Copy source type. -## HiveDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### AmazonRdsForOracleSource +#### Properties +* **additionalColumns**: any: Any object +* **oracleReaderQuery**: any: Any object +* **partitionOption**: any: Any object +* **partitionSettings**: [AmazonRdsForOraclePartitionSettings](#amazonrdsfororaclepartitionsettings): The settings that will be leveraged for AmazonRdsForOracle source partitioning. +* **queryTimeout**: any: Any object +* **type**: 'AmazonRdsForOracleSource' (Required): Copy source type. -## HttpDatasetTypeProperties -### Properties -* **additionalHeaders**: any: Any object -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. -* **relativeUrl**: any: Any object -* **requestBody**: any: Any object -* **requestMethod**: any: Any object +### AmazonRdsForSqlServerSource +#### Properties +* **partitionOption**: any: Any object +* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. +* **produceAdditionalTypes**: any: Any object +* **sqlReaderQuery**: any: Any object +* **sqlReaderStoredProcedureName**: any: Any object +* **storedProcedureParameters**: [AmazonRdsForSqlServerSourceStoredProcedureParameters](#amazonrdsforsqlserversourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". +* **type**: 'AmazonRdsForSqlServerSource' (Required): Copy source type. -## ImpalaDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### AmazonRedshiftSource +#### Properties +* **query**: any: Any object +* **redshiftUnloadSettings**: [RedshiftUnloadSettings](#redshiftunloadsettings): 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. +* **type**: 'AmazonRedshiftSource' (Required): Copy source type. -## InformixTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object +### AvroSource +#### Properties +* **additionalColumns**: any: Any object +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'AvroSource' (Required): Copy source type. -## JsonDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **encodingName**: any: Any object -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +### AzureBlobFSSource +#### Properties +* **recursive**: any: Any object +* **skipHeaderLineCount**: any: Any object +* **treatEmptyAsNull**: any: Any object +* **type**: 'AzureBlobFSSource' (Required): Copy source type. -## MicrosoftAccessTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object +### AzureDatabricksDeltaLakeSource +#### Properties +* **exportSettings**: [AzureDatabricksDeltaLakeExportCommand](#azuredatabricksdeltalakeexportcommand): Azure Databricks Delta Lake export command settings. +* **query**: any: Any object +* **type**: 'AzureDatabricksDeltaLakeSource' (Required): Copy source type. -## MongoDbAtlasCollectionDatasetTypeProperties -### Properties -* **collection**: any (Required): Any object +### AzureDataExplorerSource +#### Properties +* **additionalColumns**: any: Any object +* **noTruncation**: any: Any object +* **query**: any (Required): Any object +* **queryTimeout**: any: Any object +* **type**: 'AzureDataExplorerSource' (Required): Copy source type. -## MongoDbCollectionDatasetTypeProperties -### Properties -* **collectionName**: any (Required): Any object +### AzureDataLakeStoreSource +#### Properties +* **recursive**: any: Any object +* **type**: 'AzureDataLakeStoreSource' (Required): Copy source type. -## MongoDbV2CollectionDatasetTypeProperties -### Properties -* **collection**: any (Required): Any object +### AzureMariaDBSource +#### Properties +* **query**: any: Any object +* **type**: 'AzureMariaDBSource' (Required): Copy source type. -## MySqlTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object +### AzureMySqlSource +#### Properties +* **query**: any: Any object +* **type**: 'AzureMySqlSource' (Required): Copy source type. -## NetezzaTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### AzurePostgreSqlSource +#### Properties +* **query**: any: Any object +* **type**: 'AzurePostgreSqlSource' (Required): Copy source type. -## ODataResourceDatasetTypeProperties -### Properties -* **path**: any: Any object +### AzureSqlSource +#### Properties +* **partitionOption**: any: Any object +* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. +* **produceAdditionalTypes**: any: Any object +* **sqlReaderQuery**: any: Any object +* **sqlReaderStoredProcedureName**: any: Any object +* **storedProcedureParameters**: [AzureSqlSourceStoredProcedureParameters](#azuresqlsourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". +* **type**: 'AzureSqlSource' (Required): Copy source type. -## OdbcTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object +### AzureTableSource +#### Properties +* **azureTableSourceIgnoreTableNotFound**: any: Any object +* **azureTableSourceQuery**: any: Any object +* **type**: 'AzureTableSource' (Required): Copy source type. -## Office365DatasetTypeProperties -### Properties -* **predicate**: any: Any object -* **tableName**: any (Required): Any object +### BinarySource +#### Properties +* **formatSettings**: [BinaryReadSettings](#binaryreadsettings): Binary read settings. +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'BinarySource' (Required): Copy source type. -## OracleTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### BlobSource +#### Properties +* **recursive**: any: Any object +* **skipHeaderLineCount**: any: Any object +* **treatEmptyAsNull**: any: Any object +* **type**: 'BlobSource' (Required): Copy source type. -## OrcDatasetTypeProperties -### Properties -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -* **orcCompressionCodec**: any: Any object +### CassandraSource +#### Properties +* **consistencyLevel**: 'ALL' | 'EACH_QUORUM' | 'LOCAL_ONE' | 'LOCAL_QUORUM' | 'LOCAL_SERIAL' | 'ONE' | 'QUORUM' | 'SERIAL' | 'THREE' | 'TWO' | string: 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. +* **query**: any: Any object +* **type**: 'CassandraSource' (Required): Copy source type. -## ParquetDatasetTypeProperties -### Properties -* **compressionCodec**: any: Any object -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +### CommonDataServiceForAppsSource +#### Properties +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **type**: 'CommonDataServiceForAppsSource' (Required): Copy source type. -## PhoenixDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### ConcurSource +#### Properties +* **query**: any: Any object +* **type**: 'ConcurSource' (Required): Copy source type. -## PostgreSqlTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### CosmosDbMongoDbApiSource +#### Properties +* **additionalColumns**: any: Any object +* **batchSize**: any: Any object +* **cursorMethods**: [MongoDbCursorMethodsProperties](#mongodbcursormethodsproperties): Cursor methods for Mongodb query +* **filter**: any: Any object +* **queryTimeout**: any: Any object +* **type**: 'CosmosDbMongoDbApiSource' (Required): Copy source type. -## PrestoDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### CosmosDbSqlApiSource +#### Properties +* **additionalColumns**: any: Any object +* **detectDatetime**: any: Any object +* **pageSize**: any: Any object +* **preferredRegions**: any: Any object +* **query**: any: Any object +* **type**: 'CosmosDbSqlApiSource' (Required): Copy source type. -## RelationalTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object +### CouchbaseSource +#### Properties +* **query**: any: Any object +* **type**: 'CouchbaseSource' (Required): Copy source type. -## RestResourceDatasetTypeProperties -### Properties -* **additionalHeaders**: any: Any object -* **paginationRules**: any: Any object -* **relativeUrl**: any: Any object -* **requestBody**: any: Any object -* **requestMethod**: any: Any object +### Db2Source +#### Properties +* **query**: any: Any object +* **type**: 'Db2Source' (Required): Copy source type. -## SalesforceObjectDatasetTypeProperties -### Properties -* **objectApiName**: any: Any object +### DelimitedTextSource +#### Properties +* **additionalColumns**: any: Any object +* **formatSettings**: [DelimitedTextReadSettings](#delimitedtextreadsettings): Delimited text read settings. +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'DelimitedTextSource' (Required): Copy source type. -## SalesforceServiceCloudObjectDatasetTypeProperties -### Properties -* **objectApiName**: any: Any object +### DocumentDbCollectionSource +#### Properties +* **additionalColumns**: any: Any object +* **nestingSeparator**: any: Any object +* **query**: any: Any object +* **queryTimeout**: any: Any object +* **type**: 'DocumentDbCollectionSource' (Required): Copy source type. -## SapCloudForCustomerResourceDatasetTypeProperties -### Properties -* **path**: any (Required): Any object +### DrillSource +#### Properties +* **query**: any: Any object +* **type**: 'DrillSource' (Required): Copy source type. -## SapEccResourceDatasetTypeProperties -### Properties -* **path**: any (Required): Any object +### DynamicsAXSource +#### Properties +* **httpRequestTimeout**: any: Any object +* **query**: any: Any object +* **type**: 'DynamicsAXSource' (Required): Copy source type. -## SapHanaTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object +### DynamicsCrmSource +#### Properties +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **type**: 'DynamicsCrmSource' (Required): Copy source type. -## SapOpenHubTableDatasetTypeProperties -### Properties -* **baseRequestId**: any: Any object -* **excludeLastRequest**: any: Any object -* **openHubDestinationName**: any (Required): Any object +### DynamicsSource +#### Properties +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **type**: 'DynamicsSource' (Required): Copy source type. -## SapTableResourceDatasetTypeProperties -### Properties -* **tableName**: any (Required): Any object +### EloquaSource +#### Properties +* **query**: any: Any object +* **type**: 'EloquaSource' (Required): Copy source type. -## SharePointOnlineListDatasetTypeProperties -### Properties -* **listName**: any: Any object +### ExcelSource +#### Properties +* **additionalColumns**: any: Any object +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'ExcelSource' (Required): Copy source type. -## SnowflakeDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object +### FileSystemSource +#### Properties +* **additionalColumns**: any: Any object +* **recursive**: any: Any object +* **type**: 'FileSystemSource' (Required): Copy source type. -## SparkDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### GoogleAdWordsSource +#### Properties +* **query**: any: Any object +* **type**: 'GoogleAdWordsSource' (Required): Copy source type. -## SqlServerTableDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object - -## SybaseTableDatasetTypeProperties -### Properties -* **tableName**: any: Any object - -## TeradataTableDatasetTypeProperties -### Properties -* **database**: any: Any object -* **table**: any: Any object +### GoogleBigQuerySource +#### Properties +* **query**: any: Any object +* **type**: 'GoogleBigQuerySource' (Required): Copy source type. -## VerticaDatasetTypeProperties -### Properties -* **schema**: any: Any object -* **table**: any: Any object -* **tableName**: any: Any object +### GreenplumSource +#### Properties +* **query**: any: Any object +* **type**: 'GreenplumSource' (Required): Copy source type. -## WebTableDatasetTypeProperties -### Properties -* **index**: any (Required): Any object -* **path**: any: Any object +### HBaseSource +#### Properties +* **query**: any: Any object +* **type**: 'HBaseSource' (Required): Copy source type. -## XmlDatasetTypeProperties -### Properties -* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. -* **encodingName**: any: Any object -* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -* **nullValue**: any: Any object +### HdfsSource +#### Properties +* **distcpSettings**: [DistcpSettings](#distcpsettings): Distcp settings. +* **recursive**: any: Any object +* **type**: 'HdfsSource' (Required): Copy source type. -## IntegrationRuntime -* **Discriminator**: type +### HiveSource +#### Properties +* **query**: any: Any object +* **type**: 'HiveSource' (Required): Copy source type. -### Base Properties -* **description**: string: Integration runtime description. -### ManagedIntegrationRuntime +### HttpSource #### Properties -* **managedVirtualNetwork**: [ManagedVirtualNetworkReference](#managedvirtualnetworkreference): Managed Virtual Network reference type. -* **state**: 'AccessDenied' | 'Initial' | 'Limited' | 'NeedRegistration' | 'Offline' | 'Online' | 'Started' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The state of integration runtime. -* **type**: 'Managed' (Required): Type of integration runtime. -* **typeProperties**: [ManagedIntegrationRuntimeTypeProperties](#managedintegrationruntimetypeproperties) (Required): Managed integration runtime type properties. +* **httpRequestTimeout**: any: Any object +* **type**: 'HttpSource' (Required): Copy source type. -### SelfHostedIntegrationRuntime +### HubspotSource #### Properties -* **type**: 'SelfHosted' (Required): Type of integration runtime. -* **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. +* **query**: any: Any object +* **type**: 'HubspotSource' (Required): Copy source type. +### ImpalaSource +#### Properties +* **query**: any: Any object +* **type**: 'ImpalaSource' (Required): Copy source type. -## ManagedVirtualNetworkReference -### Properties -* **referenceName**: string (Required): Reference ManagedVirtualNetwork name. -* **type**: 'ManagedVirtualNetworkReference' | string (Required): Managed Virtual Network reference type. +### InformixSource +#### Properties +* **query**: any: Any object +* **type**: 'InformixSource' (Required): Copy source type. -## ManagedIntegrationRuntimeTypeProperties -### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **customerVirtualNetwork**: [IntegrationRuntimeCustomerVirtualNetwork](#integrationruntimecustomervirtualnetwork): The definition and properties of virtual network to which Azure-SSIS integration runtime will join. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +### JiraSource +#### Properties +* **query**: any: Any object +* **type**: 'JiraSource' (Required): Copy source type. -## IntegrationRuntimeComputeProperties -### Properties -* **dataFlowProperties**: [IntegrationRuntimeDataFlowProperties](#integrationruntimedataflowproperties): Data flow properties for managed integration runtime. -* **location**: 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 -* **maxParallelExecutionsPerNode**: int: Maximum parallel executions count per node for managed integration runtime. -* **nodeSize**: string: The node size requirement to managed integration runtime. -* **numberOfNodes**: int: The required number of nodes for managed integration runtime. -* **vNetProperties**: [IntegrationRuntimeVNetProperties](#integrationruntimevnetproperties): VNet properties for managed integration runtime. -### Additional Properties -* **Additional Properties Type**: any +### JsonSource +#### Properties +* **additionalColumns**: any: Any object +* **formatSettings**: [JsonReadSettings](#jsonreadsettings): Json read settings. +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'JsonSource' (Required): Copy source type. -## IntegrationRuntimeDataFlowProperties -### Properties -* **cleanup**: bool: 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. -* **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. -* **coreCount**: int: Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. -* **timeToLive**: int: Time to live (in minutes) setting of the cluster which will execute data flow job. -### Additional Properties -* **Additional Properties Type**: any +### MagentoSource +#### Properties +* **query**: any: Any object +* **type**: 'MagentoSource' (Required): Copy source type. -## IntegrationRuntimeVNetProperties -### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. -### Additional Properties -* **Additional Properties Type**: any +### MariaDBSource +#### Properties +* **query**: any: Any object +* **type**: 'MariaDBSource' (Required): Copy source type. -## IntegrationRuntimeCustomerVirtualNetwork -### Properties -* **subnetId**: string: The ID of subnet to which Azure-SSIS integration runtime will join. +### MarketoSource +#### Properties +* **query**: any: Any object +* **type**: 'MarketoSource' (Required): Copy source type. -## IntegrationRuntimeSsisProperties -### Properties -* **catalogInfo**: [IntegrationRuntimeSsisCatalogInfo](#integrationruntimessiscataloginfo): Catalog information for managed dedicated integration runtime. -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **customSetupScriptProperties**: [IntegrationRuntimeCustomSetupScriptProperties](#integrationruntimecustomsetupscriptproperties): Custom setup script properties for a managed dedicated integration runtime. -* **dataProxyProperties**: [IntegrationRuntimeDataProxyProperties](#integrationruntimedataproxyproperties): Data proxy properties for a managed dedicated integration runtime. -* **edition**: 'Enterprise' | 'Standard' | string: The edition for the SSIS Integration Runtime -* **expressCustomSetupProperties**: [CustomSetupBase](#customsetupbase)[]: Custom setup without script properties for a SSIS integration runtime. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: License type for bringing your own license scenario. -* **packageStores**: [PackageStore](#packagestore)[]: Package stores for the SSIS Integration Runtime. -### Additional Properties -* **Additional Properties Type**: any +### MicrosoftAccessSource +#### Properties +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **type**: 'MicrosoftAccessSource' (Required): Copy source type. -## IntegrationRuntimeSsisCatalogInfo -### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. -* **dualStandbyPairName**: string: The dual standby pair name of Azure-SSIS Integration Runtimes to support SSISDB failover. -### Additional Properties -* **Additional Properties Type**: any +### MongoDbAtlasSource +#### Properties +* **additionalColumns**: any: Any object +* **batchSize**: any: Any object +* **cursorMethods**: [MongoDbCursorMethodsProperties](#mongodbcursormethodsproperties): Cursor methods for Mongodb query +* **filter**: any: Any object +* **queryTimeout**: any: Any object +* **type**: 'MongoDbAtlasSource' (Required): Copy source type. -## SecureString -### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +### MongoDbSource +#### Properties +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **type**: 'MongoDbSource' (Required): Copy source type. -## CredentialReference -### Properties -* **referenceName**: string (Required): Reference credential name. -* **type**: 'CredentialReference' | string (Required): Credential reference type. -### Additional Properties -* **Additional Properties Type**: any +### MongoDbV2Source +#### Properties +* **additionalColumns**: any: Any object +* **batchSize**: any: Any object +* **cursorMethods**: [MongoDbCursorMethodsProperties](#mongodbcursormethodsproperties): Cursor methods for Mongodb query +* **filter**: any: Any object +* **queryTimeout**: any: Any object +* **type**: 'MongoDbV2Source' (Required): Copy source type. -## IntegrationRuntimeCustomSetupScriptProperties -### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +### MySqlSource +#### Properties +* **query**: any: Any object +* **type**: 'MySqlSource' (Required): Copy source type. -## IntegrationRuntimeDataProxyProperties -### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +### NetezzaSource +#### Properties +* **partitionOption**: any: Any object +* **partitionSettings**: [NetezzaPartitionSettings](#netezzapartitionsettings): The settings that will be leveraged for Netezza source partitioning. +* **query**: any: Any object +* **type**: 'NetezzaSource' (Required): Copy source type. -## EntityReference -### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. +### ODataSource +#### Properties +* **additionalColumns**: any: Any object +* **httpRequestTimeout**: any: Any object +* **query**: any: Any object +* **type**: 'ODataSource' (Required): Copy source type. -## CustomSetupBase -* **Discriminator**: type +### OdbcSource +#### Properties +* **query**: any: Any object +* **type**: 'OdbcSource' (Required): Copy source type. -### Base Properties -### AzPowerShellSetup +### Office365Source #### Properties -* **type**: 'AzPowerShellSetup' (Required): The type of custom setup. -* **typeProperties**: [AzPowerShellSetupTypeProperties](#azpowershellsetuptypeproperties) (Required): Installation of Azure PowerShell type properties. +* **allowedGroups**: any: Any object +* **dateFilterColumn**: any: Any object +* **endTime**: any: Any object +* **outputColumns**: any: Any object +* **startTime**: any: Any object +* **type**: 'Office365Source' (Required): Copy source type. +* **userScopeFilterUri**: any: Any object -### CmdkeySetup +### OracleServiceCloudSource #### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. +* **query**: any: Any object +* **type**: 'OracleServiceCloudSource' (Required): Copy source type. -### ComponentSetup +### OracleSource #### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. +* **additionalColumns**: any: Any object +* **oracleReaderQuery**: any: Any object +* **partitionOption**: any: Any object +* **partitionSettings**: [OraclePartitionSettings](#oraclepartitionsettings): The settings that will be leveraged for Oracle source partitioning. +* **queryTimeout**: any: Any object +* **type**: 'OracleSource' (Required): Copy source type. -### EnvironmentVariableSetup +### OrcSource #### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - - -## AzPowerShellSetupTypeProperties -### Properties -* **version**: string (Required): The required version of Azure PowerShell to install. - -## CmdkeySetupTypeProperties -### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type +* **additionalColumns**: any: Any object +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'OrcSource' (Required): Copy source type. -### Base Properties -### AzureKeyVaultSecretReference +### ParquetSource #### Properties -* **secretName**: any (Required): Any object -* **secretVersion**: any: Any object -* **store**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **type**: 'AzureKeyVaultSecret' (Required): Type of the secret. +* **additionalColumns**: any: Any object +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'ParquetSource' (Required): Copy source type. -### SecureString +### PaypalSource #### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - - -## LicensedComponentSetupTypeProperties -### Properties -* **componentName**: string (Required): The name of the 3rd party component. -* **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. - -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## PackageStore -### Properties -* **name**: string (Required): The name of the package store -* **packageStoreLinkedService**: [EntityReference](#entityreference) (Required): The entity reference. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - -## LinkedIntegrationRuntimeType -* **Discriminator**: authorizationType +* **query**: any: Any object +* **type**: 'PaypalSource' (Required): Copy source type. -### Base Properties -### LinkedIntegrationRuntimeKeyAuthorization +### PhoenixSource #### Properties -* **authorizationType**: 'Key' (Required): The authorization type for integration runtime sharing. -* **key**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **query**: any: Any object +* **type**: 'PhoenixSource' (Required): Copy source type. -### LinkedIntegrationRuntimeRbacAuthorization +### PostgreSqlSource #### Properties -* **authorizationType**: 'RBAC' (Required): The authorization type for integration runtime sharing. -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. - - -## LinkedService -* **Discriminator**: type +* **query**: any: Any object +* **type**: 'PostgreSqlSource' (Required): Copy source type. -### Base Properties -* **annotations**: any[]: List of tags that can be used for describing the linked service. -* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. -* **description**: string: Linked service description. -* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. -### AmazonMWSLinkedService +### PrestoSource #### Properties -* **type**: 'AmazonMWS' (Required): Type of linked service. -* **typeProperties**: [AmazonMWSLinkedServiceTypeProperties](#amazonmwslinkedservicetypeproperties) (Required): Amazon Marketplace Web Service linked service properties. +* **query**: any: Any object +* **type**: 'PrestoSource' (Required): Copy source type. -### AmazonRdsForOracleLinkedService +### QuickBooksSource #### Properties -* **type**: 'AmazonRdsForOracle' (Required): Type of linked service. -* **typeProperties**: [AmazonRdsForLinkedServiceTypeProperties](#amazonrdsforlinkedservicetypeproperties) (Required): AmazonRdsForOracle database linked service properties. +* **query**: any: Any object +* **type**: 'QuickBooksSource' (Required): Copy source type. -### AmazonRdsForSqlServerLinkedService +### RelationalSource #### Properties -* **type**: 'AmazonRdsForSqlServer' (Required): Type of linked service. -* **typeProperties**: [AmazonRdsForSqlServerLinkedServiceTypeProperties](#amazonrdsforsqlserverlinkedservicetypeproperties) (Required): Amazon Rds for SQL Server linked service properties. +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **type**: 'RelationalSource' (Required): Copy source type. -### AmazonRedshiftLinkedService +### ResponsysSource #### Properties -* **type**: 'AmazonRedshift' (Required): Type of linked service. -* **typeProperties**: [AmazonRedshiftLinkedServiceTypeProperties](#amazonredshiftlinkedservicetypeproperties) (Required): Amazon Redshift linked service properties. +* **query**: any: Any object +* **type**: 'ResponsysSource' (Required): Copy source type. -### AmazonS3LinkedService +### RestSource #### Properties -* **type**: 'AmazonS3' (Required): Type of linked service. -* **typeProperties**: [AmazonS3LinkedServiceTypeProperties](#amazons3linkedservicetypeproperties) (Required): Amazon S3 linked service properties. +* **additionalColumns**: any: Any object +* **additionalHeaders**: any: Any object +* **httpRequestTimeout**: any: Any object +* **paginationRules**: any: Any object +* **requestBody**: any: Any object +* **requestInterval**: any: Any object +* **requestMethod**: any: Any object +* **type**: 'RestSource' (Required): Copy source type. -### AmazonS3CompatibleLinkedService +### SalesforceMarketingCloudSource #### Properties -* **type**: 'AmazonS3Compatible' (Required): Type of linked service. -* **typeProperties**: [AmazonS3CompatibleLinkedServiceTypeProperties](#amazons3compatiblelinkedservicetypeproperties) (Required): Amazon S3 Compatible linked service properties. +* **query**: any: Any object +* **type**: 'SalesforceMarketingCloudSource' (Required): Copy source type. -### AppFiguresLinkedService +### SalesforceServiceCloudSource #### Properties -* **type**: 'AppFigures' (Required): Type of linked service. -* **typeProperties**: [AppFiguresLinkedServiceTypeProperties](#appfigureslinkedservicetypeproperties) (Required): AppFigures linked service type properties. +* **additionalColumns**: any: Any object +* **query**: any: Any object +* **readBehavior**: 'Query' | 'QueryAll' | string: The read behavior for the operation. Default is Query. +* **type**: 'SalesforceServiceCloudSource' (Required): Copy source type. -### AsanaLinkedService +### SalesforceSource #### Properties -* **type**: 'Asana' (Required): Type of linked service. -* **typeProperties**: [AsanaLinkedServiceTypeProperties](#asanalinkedservicetypeproperties) (Required): Asana linked service type properties. +* **query**: any: Any object +* **readBehavior**: 'Query' | 'QueryAll' | string: The read behavior for the operation. Default is Query. +* **type**: 'SalesforceSource' (Required): Copy source type. -### AzureBatchLinkedService +### SapBwSource #### Properties -* **type**: 'AzureBatch' (Required): Type of linked service. -* **typeProperties**: [AzureBatchLinkedServiceTypeProperties](#azurebatchlinkedservicetypeproperties) (Required): Azure Batch linked service properties. +* **query**: any: Any object +* **type**: 'SapBwSource' (Required): Copy source type. -### AzureBlobFSLinkedService +### SapCloudForCustomerSource #### Properties -* **type**: 'AzureBlobFS' (Required): Type of linked service. -* **typeProperties**: [AzureBlobFSLinkedServiceTypeProperties](#azureblobfslinkedservicetypeproperties) (Required): Azure Data Lake Storage Gen2 linked service properties. +* **httpRequestTimeout**: any: Any object +* **query**: any: Any object +* **type**: 'SapCloudForCustomerSource' (Required): Copy source type. -### AzureBlobStorageLinkedService +### SapEccSource #### Properties -* **type**: 'AzureBlobStorage' (Required): Type of linked service. -* **typeProperties**: [AzureBlobStorageLinkedServiceTypeProperties](#azureblobstoragelinkedservicetypeproperties) (Required): Azure Blob Storage linked service properties. +* **httpRequestTimeout**: any: Any object +* **query**: any: Any object +* **type**: 'SapEccSource' (Required): Copy source type. -### AzureDatabricksLinkedService +### SapHanaSource #### Properties -* **type**: 'AzureDatabricks' (Required): Type of linked service. -* **typeProperties**: [AzureDatabricksLinkedServiceTypeProperties](#azuredatabrickslinkedservicetypeproperties) (Required): Azure Databricks linked service properties. +* **packetSize**: any: Any object +* **partitionOption**: any: Any object +* **partitionSettings**: [SapHanaPartitionSettings](#saphanapartitionsettings): The settings that will be leveraged for SAP HANA source partitioning. +* **query**: any: Any object +* **type**: 'SapHanaSource' (Required): Copy source type. -### AzureDatabricksDeltaLakeLinkedService +### SapOpenHubSource #### Properties -* **type**: 'AzureDatabricksDeltaLake' (Required): Type of linked service. -* **typeProperties**: [AzureDatabricksDetltaLakeLinkedServiceTypeProperties](#azuredatabricksdetltalakelinkedservicetypeproperties) (Required): Azure Databricks Delta Lake linked service properties. +* **baseRequestId**: any: Any object +* **customRfcReadTableFunctionModule**: any: Any object +* **excludeLastRequest**: any: Any object +* **sapDataColumnDelimiter**: any: Any object +* **type**: 'SapOpenHubSource' (Required): Copy source type. -### AzureDataExplorerLinkedService +### SapTableSource #### Properties -* **type**: 'AzureDataExplorer' (Required): Type of linked service. -* **typeProperties**: [AzureDataExplorerLinkedServiceTypeProperties](#azuredataexplorerlinkedservicetypeproperties) (Required): Azure Data Explorer (Kusto) linked service properties. +* **batchSize**: any: Any object +* **customRfcReadTableFunctionModule**: any: Any object +* **partitionOption**: any: Any object +* **partitionSettings**: [SapTablePartitionSettings](#saptablepartitionsettings): The settings that will be leveraged for SAP table source partitioning. +* **rfcTableFields**: any: Any object +* **rfcTableOptions**: any: Any object +* **rowCount**: any: Any object +* **rowSkips**: any: Any object +* **sapDataColumnDelimiter**: any: Any object +* **type**: 'SapTableSource' (Required): Copy source type. -### AzureDataLakeAnalyticsLinkedService +### ServiceNowSource #### Properties -* **type**: 'AzureDataLakeAnalytics' (Required): Type of linked service. -* **typeProperties**: [AzureDataLakeAnalyticsLinkedServiceTypeProperties](#azuredatalakeanalyticslinkedservicetypeproperties) (Required): Azure Data Lake Analytics linked service properties. +* **query**: any: Any object +* **type**: 'ServiceNowSource' (Required): Copy source type. -### AzureDataLakeStoreLinkedService +### SharePointOnlineListSource #### Properties -* **type**: 'AzureDataLakeStore' (Required): Type of linked service. -* **typeProperties**: [AzureDataLakeStoreLinkedServiceTypeProperties](#azuredatalakestorelinkedservicetypeproperties) (Required): Azure Data Lake Store linked service properties. +* **httpRequestTimeout**: any: Any object +* **query**: any: Any object +* **type**: 'SharePointOnlineListSource' (Required): Copy source type. -### AzureFileStorageLinkedService +### ShopifySource #### Properties -* **type**: 'AzureFileStorage' (Required): Type of linked service. -* **typeProperties**: [AzureFileStorageLinkedServiceTypeProperties](#azurefilestoragelinkedservicetypeproperties) (Required): Azure File Storage linked service properties. +* **query**: any: Any object +* **type**: 'ShopifySource' (Required): Copy source type. -### AzureFunctionLinkedService +### SnowflakeSource #### Properties -* **type**: 'AzureFunction' (Required): Type of linked service. -* **typeProperties**: [AzureFunctionLinkedServiceTypeProperties](#azurefunctionlinkedservicetypeproperties) (Required): Azure Function linked service properties. +* **exportSettings**: [SnowflakeExportCopyCommand](#snowflakeexportcopycommand): Snowflake export command settings. +* **query**: any: Any object +* **type**: 'SnowflakeSource' (Required): Copy source type. -### AzureKeyVaultLinkedService +### SparkSource #### Properties -* **type**: 'AzureKeyVault' (Required): Type of linked service. -* **typeProperties**: [AzureKeyVaultLinkedServiceTypeProperties](#azurekeyvaultlinkedservicetypeproperties) (Required): Azure Key Vault linked service properties. +* **query**: any: Any object +* **type**: 'SparkSource' (Required): Copy source type. -### AzureMariaDBLinkedService +### SqlDWSource #### Properties -* **type**: 'AzureMariaDB' (Required): Type of linked service. -* **typeProperties**: [AzureMariaDBLinkedServiceTypeProperties](#azuremariadblinkedservicetypeproperties) (Required): Azure Database for MariaDB linked service properties. +* **partitionOption**: any: Any object +* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. +* **sqlReaderQuery**: any: Any object +* **sqlReaderStoredProcedureName**: any: Any object +* **storedProcedureParameters**: any: Any object +* **type**: 'SqlDWSource' (Required): Copy source type. -### AzureMLLinkedService +### SqlMISource #### Properties -* **type**: 'AzureML' (Required): Type of linked service. -* **typeProperties**: [AzureMLLinkedServiceTypeProperties](#azuremllinkedservicetypeproperties) (Required): Azure ML Studio Web Service linked service properties. +* **partitionOption**: any: Any object +* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. +* **produceAdditionalTypes**: any: Any object +* **sqlReaderQuery**: any: Any object +* **sqlReaderStoredProcedureName**: any: Any object +* **storedProcedureParameters**: [SqlMISourceStoredProcedureParameters](#sqlmisourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". +* **type**: 'SqlMISource' (Required): Copy source type. -### AzureMLServiceLinkedService +### SqlServerSource #### Properties -* **type**: 'AzureMLService' (Required): Type of linked service. -* **typeProperties**: [AzureMLServiceLinkedServiceTypeProperties](#azuremlservicelinkedservicetypeproperties) (Required): Azure ML Service linked service properties. +* **partitionOption**: any: Any object +* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. +* **produceAdditionalTypes**: any: Any object +* **sqlReaderQuery**: any: Any object +* **sqlReaderStoredProcedureName**: any: Any object +* **storedProcedureParameters**: [SqlServerSourceStoredProcedureParameters](#sqlserversourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". +* **type**: 'SqlServerSource' (Required): Copy source type. -### AzureMySqlLinkedService -#### Properties -* **type**: 'AzureMySql' (Required): Type of linked service. -* **typeProperties**: [AzureMySqlLinkedServiceTypeProperties](#azuremysqllinkedservicetypeproperties) (Required): Azure MySQL database linked service properties. - -### AzurePostgreSqlLinkedService +### SqlSource #### Properties -* **type**: 'AzurePostgreSql' (Required): Type of linked service. -* **typeProperties**: [AzurePostgreSqlLinkedServiceTypeProperties](#azurepostgresqllinkedservicetypeproperties) (Required): Azure PostgreSQL linked service properties. +* **isolationLevel**: any: Any object +* **partitionOption**: any: Any object +* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. +* **sqlReaderQuery**: any: Any object +* **sqlReaderStoredProcedureName**: any: Any object +* **storedProcedureParameters**: [SqlSourceStoredProcedureParameters](#sqlsourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". +* **type**: 'SqlSource' (Required): Copy source type. -### AzureSearchLinkedService +### SquareSource #### Properties -* **type**: 'AzureSearch' (Required): Type of linked service. -* **typeProperties**: [AzureSearchLinkedServiceTypeProperties](#azuresearchlinkedservicetypeproperties) (Required): Windows Azure Search Service linked service properties. +* **query**: any: Any object +* **type**: 'SquareSource' (Required): Copy source type. -### AzureSqlDatabaseLinkedService +### SybaseSource #### Properties -* **type**: 'AzureSqlDatabase' (Required): Type of linked service. -* **typeProperties**: [AzureSqlDatabaseLinkedServiceTypeProperties](#azuresqldatabaselinkedservicetypeproperties) (Required): Azure SQL Database linked service properties. +* **query**: any: Any object +* **type**: 'SybaseSource' (Required): Copy source type. -### AzureSqlDWLinkedService +### TeradataSource #### Properties -* **type**: 'AzureSqlDW' (Required): Type of linked service. -* **typeProperties**: [AzureSqlDWLinkedServiceTypeProperties](#azuresqldwlinkedservicetypeproperties) (Required): Azure SQL Data Warehouse linked service properties. +* **partitionOption**: any: Any object +* **partitionSettings**: [TeradataPartitionSettings](#teradatapartitionsettings): The settings that will be leveraged for teradata source partitioning. +* **query**: any: Any object +* **type**: 'TeradataSource' (Required): Copy source type. -### AzureSqlMILinkedService +### VerticaSource #### Properties -* **type**: 'AzureSqlMI' (Required): Type of linked service. -* **typeProperties**: [AzureSqlMILinkedServiceTypeProperties](#azuresqlmilinkedservicetypeproperties) (Required): Azure SQL Managed Instance linked service properties. +* **query**: any: Any object +* **type**: 'VerticaSource' (Required): Copy source type. -### AzureStorageLinkedService +### WebSource #### Properties -* **type**: 'AzureStorage' (Required): Type of linked service. -* **typeProperties**: [AzureStorageLinkedServiceTypeProperties](#azurestoragelinkedservicetypeproperties) (Required): Azure Storage linked service properties. +* **additionalColumns**: any: Any object +* **type**: 'WebSource' (Required): Copy source type. -### AzureTableStorageLinkedService +### XeroSource #### Properties -* **type**: 'AzureTableStorage' (Required): Type of linked service. -* **typeProperties**: [AzureStorageLinkedServiceTypeProperties](#azurestoragelinkedservicetypeproperties) (Required): Azure Storage linked service properties. +* **query**: any: Any object +* **type**: 'XeroSource' (Required): Copy source type. -### CassandraLinkedService +### XmlSource #### Properties -* **type**: 'Cassandra' (Required): Type of linked service. -* **typeProperties**: [CassandraLinkedServiceTypeProperties](#cassandralinkedservicetypeproperties) (Required): Cassandra linked service properties. +* **additionalColumns**: any: Any object +* **formatSettings**: [XmlReadSettings](#xmlreadsettings): Xml read settings. +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **type**: 'XmlSource' (Required): Copy source type. -### CommonDataServiceForAppsLinkedService +### ZohoSource #### Properties -* **type**: 'CommonDataServiceForApps' (Required): Type of linked service. -* **typeProperties**: [CommonDataServiceForAppsLinkedServiceTypeProperties](#commondataserviceforappslinkedservicetypeproperties) (Required): Common Data Service for Apps linked service properties. +* **query**: any: Any object +* **type**: 'ZohoSource' (Required): Copy source type. -### ConcurLinkedService -#### Properties -* **type**: 'Concur' (Required): Type of linked service. -* **typeProperties**: [ConcurLinkedServiceTypeProperties](#concurlinkedservicetypeproperties) (Required): Concur Service linked service properties. -### CosmosDbLinkedService -#### Properties -* **type**: 'CosmosDb' (Required): Type of linked service. -* **typeProperties**: [CosmosDbLinkedServiceTypeProperties](#cosmosdblinkedservicetypeproperties) (Required): CosmosDB linked service properties. +## CosmosDbLinkedServiceTypeProperties +### Properties +* **accountEndpoint**: any: Any object +* **accountKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **azureCloudType**: any: Any object +* **connectionMode**: 'Direct' | 'Gateway' | string: The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string). +* **connectionString**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **database**: any: Any object +* **encryptedCredential**: any: Any object +* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalCredentialType**: 'ServicePrincipalCert' | 'ServicePrincipalKey' | 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). +* **servicePrincipalId**: any: Any object +* **tenant**: any: Any object -### CosmosDbMongoDbApiLinkedService -#### Properties -* **type**: 'CosmosDbMongoDbApi' (Required): Type of linked service. -* **typeProperties**: [CosmosDbMongoDbApiLinkedServiceTypeProperties](#cosmosdbmongodbapilinkedservicetypeproperties) (Required): CosmosDB (MongoDB API) linked service properties. +## CosmosDbMongoDbApiCollectionDatasetTypeProperties +### Properties +* **collection**: any (Required): Any object -### CouchbaseLinkedService -#### Properties -* **type**: 'Couchbase' (Required): Type of linked service. -* **typeProperties**: [CouchbaseLinkedServiceTypeProperties](#couchbaselinkedservicetypeproperties) (Required): Couchbase server linked service properties. +## CosmosDbMongoDbApiLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **database**: any (Required): Any object +* **isServerVersionAbove32**: any: Any object -### CustomDataSourceLinkedService -#### Properties -* **type**: 'CustomDataSource' (Required): Type of linked service. -* **typeProperties**: any (Required): Any object +## CosmosDbSqlApiCollectionDatasetTypeProperties +### Properties +* **collectionName**: any (Required): Any object -### DataworldLinkedService -#### Properties -* **type**: 'Dataworld' (Required): Type of linked service. -* **typeProperties**: [DataworldLinkedServiceTypeProperties](#dataworldlinkedservicetypeproperties) (Required): Dataworld linked service type properties. +## CouchbaseLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **credString**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **encryptedCredential**: any: Any object -### Db2LinkedService -#### Properties -* **type**: 'Db2' (Required): Type of linked service. -* **typeProperties**: [Db2LinkedServiceTypeProperties](#db2linkedservicetypeproperties) (Required): DB2 linked service properties. +## CredentialReference +### Properties +* **referenceName**: string (Required): Reference credential name. +* **type**: 'CredentialReference' | string (Required): Credential reference type. +### Additional Properties +* **Additional Properties Type**: any -### DrillLinkedService -#### Properties -* **type**: 'Drill' (Required): Type of linked service. -* **typeProperties**: [DrillLinkedServiceTypeProperties](#drilllinkedservicetypeproperties) (Required): Drill server linked service properties. +## CustomActivityReferenceObject +### Properties +* **datasets**: [DatasetReference](#datasetreference)[]: Dataset references. +* **linkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Linked service references. -### DynamicsLinkedService -#### Properties -* **type**: 'Dynamics' (Required): Type of linked service. -* **typeProperties**: [DynamicsLinkedServiceTypeProperties](#dynamicslinkedservicetypeproperties) (Required): Dynamics linked service properties. +## CustomActivityTypeProperties +### Properties +* **autoUserSpecification**: any: Any object +* **command**: any (Required): Any object +* **extendedProperties**: [CustomActivityTypePropertiesExtendedProperties](#customactivitytypepropertiesextendedproperties): 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. +* **folderPath**: any: Any object +* **referenceObjects**: [CustomActivityReferenceObject](#customactivityreferenceobject): Reference objects for custom activity +* **resourceLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **retentionTimeInDays**: any: Any object -### DynamicsAXLinkedService -#### Properties -* **type**: 'DynamicsAX' (Required): Type of linked service. -* **typeProperties**: [DynamicsAXLinkedServiceTypeProperties](#dynamicsaxlinkedservicetypeproperties) (Required): Dynamics AX linked service properties. +## CustomActivityTypePropertiesExtendedProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any -### DynamicsCrmLinkedService -#### Properties -* **type**: 'DynamicsCrm' (Required): Type of linked service. -* **typeProperties**: [DynamicsCrmLinkedServiceTypeProperties](#dynamicscrmlinkedservicetypeproperties) (Required): Dynamics CRM linked service properties. +## CustomEventsTriggerTypeProperties +### Properties +* **events**: any[] (Required): The list of event types that cause this trigger to fire. +* **scope**: string (Required): The ARM resource ID of the Azure Event Grid Topic. +* **subjectBeginsWith**: string: The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. +* **subjectEndsWith**: string: The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. -### EloquaLinkedService -#### Properties -* **type**: 'Eloqua' (Required): Type of linked service. -* **typeProperties**: [EloquaLinkedServiceTypeProperties](#eloqualinkedservicetypeproperties) (Required): Eloqua server linked service properties. +## CustomSetupBase +* **Discriminator**: type -### FileServerLinkedService +### Base Properties +### AzPowerShellSetup #### Properties -* **type**: 'FileServer' (Required): Type of linked service. -* **typeProperties**: [FileServerLinkedServiceTypeProperties](#fileserverlinkedservicetypeproperties) (Required): File system linked service properties. +* **type**: 'AzPowerShellSetup' (Required): The type of custom setup. +* **typeProperties**: [AzPowerShellSetupTypeProperties](#azpowershellsetuptypeproperties) (Required): Installation of Azure PowerShell type properties. -### FtpServerLinkedService +### CmdkeySetup #### Properties -* **type**: 'FtpServer' (Required): Type of linked service. -* **typeProperties**: [FtpServerLinkedServiceTypeProperties](#ftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. -### GoogleAdWordsLinkedService +### ComponentSetup #### Properties -* **type**: 'GoogleAdWords' (Required): Type of linked service. -* **typeProperties**: [GoogleAdWordsLinkedServiceTypeProperties](#googleadwordslinkedservicetypeproperties) (Required): Google AdWords service linked service properties. +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. -### GoogleBigQueryLinkedService +### EnvironmentVariableSetup #### Properties -* **type**: 'GoogleBigQuery' (Required): Type of linked service. -* **typeProperties**: [GoogleBigQueryLinkedServiceTypeProperties](#googlebigquerylinkedservicetypeproperties) (Required): Google BigQuery service linked service properties. +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. -### GoogleCloudStorageLinkedService -#### Properties -* **type**: 'GoogleCloudStorage' (Required): Type of linked service. -* **typeProperties**: [GoogleCloudStorageLinkedServiceTypeProperties](#googlecloudstoragelinkedservicetypeproperties) (Required): Google Cloud Storage linked service properties. -### GreenplumLinkedService -#### Properties -* **type**: 'Greenplum' (Required): Type of linked service. -* **typeProperties**: [GreenplumLinkedServiceTypeProperties](#greenplumlinkedservicetypeproperties) (Required): Greenplum Database linked service properties. +## DatabricksNotebookActivityTypeProperties +### Properties +* **baseParameters**: [DatabricksNotebookActivityTypePropertiesBaseParameters](#databricksnotebookactivitytypepropertiesbaseparameters): 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. +* **libraries**: [DatabricksNotebookActivityTypePropertiesLibrariesItem](#databricksnotebookactivitytypepropertieslibrariesitem)[]: A list of libraries to be installed on the cluster that will execute the job. +* **notebookPath**: any (Required): Any object -### HBaseLinkedService -#### Properties -* **type**: 'HBase' (Required): Type of linked service. -* **typeProperties**: [HBaseLinkedServiceTypeProperties](#hbaselinkedservicetypeproperties) (Required): HBase server linked service properties. +## DatabricksNotebookActivityTypePropertiesBaseParameters +### Properties +### Additional Properties +* **Additional Properties Type**: any -### HdfsLinkedService -#### Properties -* **type**: 'Hdfs' (Required): Type of linked service. -* **typeProperties**: [HdfsLinkedServiceTypeProperties](#hdfslinkedservicetypeproperties) (Required): HDFS linked service properties. +## DatabricksNotebookActivityTypePropertiesLibrariesItem +### Properties +### Additional Properties +* **Additional Properties Type**: any -### HDInsightLinkedService -#### Properties -* **type**: 'HDInsight' (Required): Type of linked service. -* **typeProperties**: [HDInsightLinkedServiceTypeProperties](#hdinsightlinkedservicetypeproperties) (Required): HDInsight linked service properties. +## DatabricksSparkJarActivityTypeProperties +### Properties +* **libraries**: [DatabricksSparkJarActivityTypePropertiesLibrariesItem](#databrickssparkjaractivitytypepropertieslibrariesitem)[]: A list of libraries to be installed on the cluster that will execute the job. +* **mainClassName**: any (Required): Any object +* **parameters**: any[]: Parameters that will be passed to the main method. -### HDInsightOnDemandLinkedService -#### Properties -* **type**: 'HDInsightOnDemand' (Required): Type of linked service. -* **typeProperties**: [HDInsightOnDemandLinkedServiceTypeProperties](#hdinsightondemandlinkedservicetypeproperties) (Required): HDInsight ondemand linked service properties. +## DatabricksSparkJarActivityTypePropertiesLibrariesItem +### Properties +### Additional Properties +* **Additional Properties Type**: any -### HiveLinkedService -#### Properties -* **type**: 'Hive' (Required): Type of linked service. -* **typeProperties**: [HiveLinkedServiceTypeProperties](#hivelinkedservicetypeproperties) (Required): Hive Server linked service properties. +## DatabricksSparkPythonActivityTypeProperties +### Properties +* **libraries**: [DatabricksSparkPythonActivityTypePropertiesLibrariesItem](#databrickssparkpythonactivitytypepropertieslibrariesitem)[]: A list of libraries to be installed on the cluster that will execute the job. +* **parameters**: any[]: Command line parameters that will be passed to the Python file. +* **pythonFile**: any (Required): Any object -### HttpLinkedService -#### Properties -* **type**: 'HttpServer' (Required): Type of linked service. -* **typeProperties**: [HttpLinkedServiceTypeProperties](#httplinkedservicetypeproperties) (Required): Properties specific to this linked service type. +## DatabricksSparkPythonActivityTypePropertiesLibrariesItem +### Properties +### Additional Properties +* **Additional Properties Type**: any -### HubspotLinkedService -#### Properties -* **type**: 'Hubspot' (Required): Type of linked service. -* **typeProperties**: [HubspotLinkedServiceTypeProperties](#hubspotlinkedservicetypeproperties) (Required): Hubspot Service linked service properties. +## DataFlow +* **Discriminator**: type -### ImpalaLinkedService +### Base Properties +* **annotations**: any[]: List of tags that can be used for describing the data flow. +* **description**: string: The description of the data flow. +* **folder**: [DataFlowFolder](#dataflowfolder): The folder that this data flow is in. If not specified, Data flow will appear at the root level. +### Flowlet #### Properties -* **type**: 'Impala' (Required): Type of linked service. -* **typeProperties**: [ImpalaLinkedServiceTypeProperties](#impalalinkedservicetypeproperties) (Required): Impala server linked service properties. +* **type**: 'Flowlet' (Required): Type of data flow. +* **typeProperties**: [FlowletTypeProperties](#flowlettypeproperties): Flowlet type properties. -### InformixLinkedService +### MappingDataFlow #### Properties -* **type**: 'Informix' (Required): Type of linked service. -* **typeProperties**: [InformixLinkedServiceTypeProperties](#informixlinkedservicetypeproperties) (Required): Informix linked service properties. +* **type**: 'MappingDataFlow' (Required): Type of data flow. +* **typeProperties**: [MappingDataFlowTypeProperties](#mappingdataflowtypeproperties): Mapping data flow type properties. -### JiraLinkedService +### WranglingDataFlow #### Properties -* **type**: 'Jira' (Required): Type of linked service. -* **typeProperties**: [JiraLinkedServiceTypeProperties](#jiralinkedservicetypeproperties) (Required): Jira Service linked service properties. +* **type**: 'WranglingDataFlow' (Required): Type of data flow. +* **typeProperties**: [PowerQueryTypeProperties](#powerquerytypeproperties): Power Query data flow type properties. -### MagentoLinkedService -#### Properties -* **type**: 'Magento' (Required): Type of linked service. -* **typeProperties**: [MagentoLinkedServiceTypeProperties](#magentolinkedservicetypeproperties) (Required): Magento server linked service properties. -### MariaDBLinkedService -#### Properties -* **type**: 'MariaDB' (Required): Type of linked service. -* **typeProperties**: [MariaDBLinkedServiceTypeProperties](#mariadblinkedservicetypeproperties) (Required): MariaDB server linked service properties. +## DataFlowFolder +### Properties +* **name**: string: The name of the folder that this data flow is in. -### MarketoLinkedService -#### Properties -* **type**: 'Marketo' (Required): Type of linked service. -* **typeProperties**: [MarketoLinkedServiceTypeProperties](#marketolinkedservicetypeproperties) (Required): Marketo server linked service properties. +## DataFlowReference +### Properties +* **datasetParameters**: any: Any object +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **referenceName**: string (Required): Reference data flow name. +* **type**: 'DataFlowReference' | string (Required): Data flow reference type. +### Additional Properties +* **Additional Properties Type**: any -### MicrosoftAccessLinkedService -#### Properties -* **type**: 'MicrosoftAccess' (Required): Type of linked service. -* **typeProperties**: [MicrosoftAccessLinkedServiceTypeProperties](#microsoftaccesslinkedservicetypeproperties) (Required): Microsoft Access linked service properties. +## DataFlowSink +### Properties +* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. +* **description**: string: Transformation description. +* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. +* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **name**: string (Required): Transformation name. +* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -### MongoDbLinkedService -#### Properties -* **type**: 'MongoDb' (Required): Type of linked service. -* **typeProperties**: [MongoDbLinkedServiceTypeProperties](#mongodblinkedservicetypeproperties) (Required): MongoDB linked service properties. +## DataFlowSource +### Properties +* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. +* **description**: string: Transformation description. +* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. +* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **name**: string (Required): Transformation name. +* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -### MongoDbAtlasLinkedService -#### Properties -* **type**: 'MongoDbAtlas' (Required): Type of linked service. -* **typeProperties**: [MongoDbAtlasLinkedServiceTypeProperties](#mongodbatlaslinkedservicetypeproperties) (Required): MongoDB Atlas linked service properties. +## DataFlowStagingInfo +### Properties +* **folderPath**: any: Any object +* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -### MongoDbV2LinkedService -#### Properties -* **type**: 'MongoDbV2' (Required): Type of linked service. -* **typeProperties**: [MongoDbV2LinkedServiceTypeProperties](#mongodbv2linkedservicetypeproperties) (Required): MongoDB linked service properties. +## DataLakeAnalyticsUsqlActivityTypeProperties +### Properties +* **compilationMode**: any: Any object +* **degreeOfParallelism**: any: Any object +* **parameters**: [DataLakeAnalyticsUsqlActivityTypePropertiesParameters](#datalakeanalyticsusqlactivitytypepropertiesparameters): Parameters for U-SQL job request. +* **priority**: any: Any object +* **runtimeVersion**: any: Any object +* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **scriptPath**: any (Required): Any object -### MySqlLinkedService -#### Properties -* **type**: 'MySql' (Required): Type of linked service. -* **typeProperties**: [MySqlLinkedServiceTypeProperties](#mysqllinkedservicetypeproperties) (Required): MySQL linked service properties. +## DataLakeAnalyticsUsqlActivityTypePropertiesParameters +### Properties +### Additional Properties +* **Additional Properties Type**: any -### NetezzaLinkedService -#### Properties -* **type**: 'Netezza' (Required): Type of linked service. -* **typeProperties**: [NetezzaLinkedServiceTypeProperties](#netezzalinkedservicetypeproperties) (Required): Netezza linked service properties. +## Dataset +* **Discriminator**: type -### ODataLinkedService +### Base Properties +* **annotations**: any[]: List of tags that can be used for describing the Dataset. +* **description**: string: Dataset description. +* **folder**: [DatasetFolder](#datasetfolder): The folder that this Dataset is in. If not specified, Dataset will appear at the root level. +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. +* **schema**: any: Any object +* **structure**: any: Any object +### AmazonMWSObjectDataset #### Properties -* **type**: 'OData' (Required): Type of linked service. -* **typeProperties**: [ODataLinkedServiceTypeProperties](#odatalinkedservicetypeproperties) (Required): OData linked service properties. +* **type**: 'AmazonMWSObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -### OdbcLinkedService +### AmazonRdsForOracleTableDataset #### Properties -* **type**: 'Odbc' (Required): Type of linked service. -* **typeProperties**: [OdbcLinkedServiceTypeProperties](#odbclinkedservicetypeproperties) (Required): ODBC linked service properties. +* **type**: 'AmazonRdsForOracleTable' (Required): Type of dataset. +* **typeProperties**: [AmazonRdsForOracleTableDatasetTypeProperties](#amazonrdsfororacletabledatasettypeproperties): AmazonRdsForOracle dataset properties. -### Office365LinkedService +### AmazonRdsForSqlServerTableDataset #### Properties -* **type**: 'Office365' (Required): Type of linked service. -* **typeProperties**: [Office365LinkedServiceTypeProperties](#office365linkedservicetypeproperties) (Required): Office365 linked service properties. +* **type**: 'AmazonRdsForSqlServerTable' (Required): Type of dataset. +* **typeProperties**: [AmazonRdsForSqlServerTableDatasetTypeProperties](#amazonrdsforsqlservertabledatasettypeproperties): The Amazon RDS for SQL Server dataset properties. -### OracleLinkedService +### AmazonRedshiftTableDataset #### Properties -* **type**: 'Oracle' (Required): Type of linked service. -* **typeProperties**: [OracleLinkedServiceTypeProperties](#oraclelinkedservicetypeproperties) (Required): Oracle database linked service properties. +* **type**: 'AmazonRedshiftTable' (Required): Type of dataset. +* **typeProperties**: [AmazonRedshiftTableDatasetTypeProperties](#amazonredshifttabledatasettypeproperties): Amazon Redshift table dataset properties. -### OracleCloudStorageLinkedService +### AmazonS3Dataset #### Properties -* **type**: 'OracleCloudStorage' (Required): Type of linked service. -* **typeProperties**: [OracleCloudStorageLinkedServiceTypeProperties](#oraclecloudstoragelinkedservicetypeproperties) (Required): Oracle Cloud Storage linked service properties. +* **type**: 'AmazonS3Object' (Required): Type of dataset. +* **typeProperties**: [AmazonS3DatasetTypeProperties](#amazons3datasettypeproperties) (Required): Amazon S3 dataset properties. -### OracleServiceCloudLinkedService +### AvroDataset #### Properties -* **type**: 'OracleServiceCloud' (Required): Type of linked service. -* **typeProperties**: [OracleServiceCloudLinkedServiceTypeProperties](#oracleservicecloudlinkedservicetypeproperties) (Required): Oracle Service Cloud linked service properties. +* **type**: 'Avro' (Required): Type of dataset. +* **typeProperties**: [AvroDatasetTypeProperties](#avrodatasettypeproperties): Avro dataset properties. -### PaypalLinkedService +### AzureBlobDataset #### Properties -* **type**: 'Paypal' (Required): Type of linked service. -* **typeProperties**: [PaypalLinkedServiceTypeProperties](#paypallinkedservicetypeproperties) (Required): Paypal Service linked service properties. +* **type**: 'AzureBlob' (Required): Type of dataset. +* **typeProperties**: [AzureBlobDatasetTypeProperties](#azureblobdatasettypeproperties): Azure Blob dataset properties. -### PhoenixLinkedService +### AzureBlobFSDataset #### Properties -* **type**: 'Phoenix' (Required): Type of linked service. -* **typeProperties**: [PhoenixLinkedServiceTypeProperties](#phoenixlinkedservicetypeproperties) (Required): Phoenix server linked service properties. +* **type**: 'AzureBlobFSFile' (Required): Type of dataset. +* **typeProperties**: [AzureBlobFSDatasetTypeProperties](#azureblobfsdatasettypeproperties): Azure Data Lake Storage Gen2 dataset properties. -### PostgreSqlLinkedService +### AzureDatabricksDeltaLakeDataset #### Properties -* **type**: 'PostgreSql' (Required): Type of linked service. -* **typeProperties**: [PostgreSqlLinkedServiceTypeProperties](#postgresqllinkedservicetypeproperties) (Required): PostgreSQL linked service properties. +* **type**: 'AzureDatabricksDeltaLakeDataset' (Required): Type of dataset. +* **typeProperties**: [AzureDatabricksDeltaLakeDatasetTypeProperties](#azuredatabricksdeltalakedatasettypeproperties): Azure Databricks Delta Lake Dataset Properties -### PrestoLinkedService +### AzureDataExplorerTableDataset #### Properties -* **type**: 'Presto' (Required): Type of linked service. -* **typeProperties**: [PrestoLinkedServiceTypeProperties](#prestolinkedservicetypeproperties) (Required): Presto server linked service properties. +* **type**: 'AzureDataExplorerTable' (Required): Type of dataset. +* **typeProperties**: [AzureDataExplorerDatasetTypeProperties](#azuredataexplorerdatasettypeproperties) (Required): Azure Data Explorer (Kusto) dataset properties. -### QuickbaseLinkedService +### AzureDataLakeStoreDataset #### Properties -* **type**: 'Quickbase' (Required): Type of linked service. -* **typeProperties**: [QuickbaseLinkedServiceTypeProperties](#quickbaselinkedservicetypeproperties) (Required): Quickbase linked service type properties. +* **type**: 'AzureDataLakeStoreFile' (Required): Type of dataset. +* **typeProperties**: [AzureDataLakeStoreDatasetTypeProperties](#azuredatalakestoredatasettypeproperties): Azure Data Lake Store dataset properties. -### QuickBooksLinkedService +### AzureMariaDBTableDataset #### Properties -* **type**: 'QuickBooks' (Required): Type of linked service. -* **typeProperties**: [QuickBooksLinkedServiceTypeProperties](#quickbookslinkedservicetypeproperties) (Required): QuickBooks server linked service properties. +* **type**: 'AzureMariaDBTable' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -### ResponsysLinkedService +### AzureMySqlTableDataset #### Properties -* **type**: 'Responsys' (Required): Type of linked service. -* **typeProperties**: [ResponsysLinkedServiceTypeProperties](#responsyslinkedservicetypeproperties) (Required): Responsys linked service properties. +* **type**: 'AzureMySqlTable' (Required): Type of dataset. +* **typeProperties**: [AzureMySqlTableDatasetTypeProperties](#azuremysqltabledatasettypeproperties) (Required): Azure MySQL database dataset properties. -### RestServiceLinkedService +### AzurePostgreSqlTableDataset #### Properties -* **type**: 'RestService' (Required): Type of linked service. -* **typeProperties**: [RestServiceLinkedServiceTypeProperties](#restservicelinkedservicetypeproperties) (Required): Rest Service linked service properties. +* **type**: 'AzurePostgreSqlTable' (Required): Type of dataset. +* **typeProperties**: [AzurePostgreSqlTableDatasetTypeProperties](#azurepostgresqltabledatasettypeproperties): Azure PostgreSQL dataset properties. -### SalesforceLinkedService +### AzureSearchIndexDataset #### Properties -* **type**: 'Salesforce' (Required): Type of linked service. -* **typeProperties**: [SalesforceLinkedServiceTypeProperties](#salesforcelinkedservicetypeproperties) (Required): Salesforce linked service properties. +* **type**: 'AzureSearchIndex' (Required): Type of dataset. +* **typeProperties**: [AzureSearchIndexDatasetTypeProperties](#azuresearchindexdatasettypeproperties) (Required): Properties specific to this dataset type. -### SalesforceMarketingCloudLinkedService +### AzureSqlDWTableDataset #### Properties -* **type**: 'SalesforceMarketingCloud' (Required): Type of linked service. -* **typeProperties**: [SalesforceMarketingCloudLinkedServiceTypeProperties](#salesforcemarketingcloudlinkedservicetypeproperties) (Required): Salesforce Marketing Cloud linked service properties. +* **type**: 'AzureSqlDWTable' (Required): Type of dataset. +* **typeProperties**: [AzureSqlDWTableDatasetTypeProperties](#azuresqldwtabledatasettypeproperties): Azure SQL Data Warehouse dataset properties. -### SalesforceServiceCloudLinkedService +### AzureSqlMITableDataset #### Properties -* **type**: 'SalesforceServiceCloud' (Required): Type of linked service. -* **typeProperties**: [SalesforceServiceCloudLinkedServiceTypeProperties](#salesforceservicecloudlinkedservicetypeproperties) (Required): Salesforce Service Cloud linked service properties. +* **type**: 'AzureSqlMITable' (Required): Type of dataset. +* **typeProperties**: [AzureSqlMITableDatasetTypeProperties](#azuresqlmitabledatasettypeproperties): Azure SQL Managed Instance dataset properties. -### SapBWLinkedService +### AzureSqlTableDataset #### Properties -* **type**: 'SapBW' (Required): Type of linked service. -* **typeProperties**: [SapBWLinkedServiceTypeProperties](#sapbwlinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'AzureSqlTable' (Required): Type of dataset. +* **typeProperties**: [AzureSqlTableDatasetTypeProperties](#azuresqltabledatasettypeproperties): Azure SQL dataset properties. -### SapCloudForCustomerLinkedService +### AzureTableDataset #### Properties -* **type**: 'SapCloudForCustomer' (Required): Type of linked service. -* **typeProperties**: [SapCloudForCustomerLinkedServiceTypeProperties](#sapcloudforcustomerlinkedservicetypeproperties) (Required): SAP Cloud for Customer linked service properties. +* **type**: 'AzureTable' (Required): Type of dataset. +* **typeProperties**: [AzureTableDatasetTypeProperties](#azuretabledatasettypeproperties) (Required): Azure Table dataset properties. -### SapEccLinkedService +### BinaryDataset #### Properties -* **type**: 'SapEcc' (Required): Type of linked service. -* **typeProperties**: [SapEccLinkedServiceTypeProperties](#sapecclinkedservicetypeproperties) (Required): SAP ECC linked service properties. +* **type**: 'Binary' (Required): Type of dataset. +* **typeProperties**: [BinaryDatasetTypeProperties](#binarydatasettypeproperties): Binary dataset properties. -### SapHanaLinkedService +### CassandraTableDataset #### Properties -* **type**: 'SapHana' (Required): Type of linked service. -* **typeProperties**: [SapHanaLinkedServiceProperties](#saphanalinkedserviceproperties) (Required): Properties specific to this linked service type. +* **type**: 'CassandraTable' (Required): Type of dataset. +* **typeProperties**: [CassandraTableDatasetTypeProperties](#cassandratabledatasettypeproperties): Cassandra dataset properties. -### SapOpenHubLinkedService +### CommonDataServiceForAppsEntityDataset #### Properties -* **type**: 'SapOpenHub' (Required): Type of linked service. -* **typeProperties**: [SapOpenHubLinkedServiceTypeProperties](#sapopenhublinkedservicetypeproperties) (Required): Properties specific to SAP Business Warehouse Open Hub Destination linked service type. +* **type**: 'CommonDataServiceForAppsEntity' (Required): Type of dataset. +* **typeProperties**: [CommonDataServiceForAppsEntityDatasetTypeProperties](#commondataserviceforappsentitydatasettypeproperties): Common Data Service for Apps entity dataset properties. -### SapTableLinkedService +### ConcurObjectDataset #### Properties -* **type**: 'SapTable' (Required): Type of linked service. -* **typeProperties**: [SapTableLinkedServiceTypeProperties](#saptablelinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'ConcurObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -### ServiceNowLinkedService +### CosmosDbMongoDbApiCollectionDataset #### Properties -* **type**: 'ServiceNow' (Required): Type of linked service. -* **typeProperties**: [ServiceNowLinkedServiceTypeProperties](#servicenowlinkedservicetypeproperties) (Required): ServiceNow server linked service properties. +* **type**: 'CosmosDbMongoDbApiCollection' (Required): Type of dataset. +* **typeProperties**: [CosmosDbMongoDbApiCollectionDatasetTypeProperties](#cosmosdbmongodbapicollectiondatasettypeproperties) (Required): CosmosDB (MongoDB API) database dataset properties. -### SftpServerLinkedService +### CosmosDbSqlApiCollectionDataset #### Properties -* **type**: 'Sftp' (Required): Type of linked service. -* **typeProperties**: [SftpServerLinkedServiceTypeProperties](#sftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. +* **type**: 'CosmosDbSqlApiCollection' (Required): Type of dataset. +* **typeProperties**: [CosmosDbSqlApiCollectionDatasetTypeProperties](#cosmosdbsqlapicollectiondatasettypeproperties) (Required): CosmosDB (SQL API) Collection dataset properties. -### SharePointOnlineListLinkedService +### CouchbaseTableDataset #### Properties -* **type**: 'SharePointOnlineList' (Required): Type of linked service. -* **typeProperties**: [SharePointOnlineListLinkedServiceTypeProperties](#sharepointonlinelistlinkedservicetypeproperties) (Required): SharePoint Online List linked service properties. +* **type**: 'CouchbaseTable' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -### ShopifyLinkedService +### CustomDataset #### Properties -* **type**: 'Shopify' (Required): Type of linked service. -* **typeProperties**: [ShopifyLinkedServiceTypeProperties](#shopifylinkedservicetypeproperties) (Required): Shopify Service linked service properties. +* **type**: 'CustomDataset' (Required): Type of dataset. +* **typeProperties**: any: Any object -### SmartsheetLinkedService +### Db2TableDataset #### Properties -* **type**: 'Smartsheet' (Required): Type of linked service. -* **typeProperties**: [SmartsheetLinkedServiceTypeProperties](#smartsheetlinkedservicetypeproperties) (Required): Smartsheet linked service type properties. +* **type**: 'Db2Table' (Required): Type of dataset. +* **typeProperties**: [Db2TableDatasetTypeProperties](#db2tabledatasettypeproperties): Db2 table dataset properties. -### SnowflakeLinkedService +### DelimitedTextDataset #### Properties -* **type**: 'Snowflake' (Required): Type of linked service. -* **typeProperties**: [SnowflakeLinkedServiceTypeProperties](#snowflakelinkedservicetypeproperties) (Required): Snowflake linked service properties. +* **type**: 'DelimitedText' (Required): Type of dataset. +* **typeProperties**: [DelimitedTextDatasetTypeProperties](#delimitedtextdatasettypeproperties): DelimitedText dataset properties. -### SparkLinkedService +### DocumentDbCollectionDataset #### Properties -* **type**: 'Spark' (Required): Type of linked service. -* **typeProperties**: [SparkLinkedServiceTypeProperties](#sparklinkedservicetypeproperties) (Required): Spark Server linked service properties. +* **type**: 'DocumentDbCollection' (Required): Type of dataset. +* **typeProperties**: [DocumentDbCollectionDatasetTypeProperties](#documentdbcollectiondatasettypeproperties) (Required): DocumentDB Collection dataset properties. -### SqlServerLinkedService +### DrillTableDataset #### Properties -* **type**: 'SqlServer' (Required): Type of linked service. -* **typeProperties**: [SqlServerLinkedServiceTypeProperties](#sqlserverlinkedservicetypeproperties) (Required): SQL Server linked service properties. +* **type**: 'DrillTable' (Required): Type of dataset. +* **typeProperties**: [DrillDatasetTypeProperties](#drilldatasettypeproperties): Drill Dataset Properties -### SquareLinkedService +### DynamicsAXResourceDataset #### Properties -* **type**: 'Square' (Required): Type of linked service. -* **typeProperties**: [SquareLinkedServiceTypeProperties](#squarelinkedservicetypeproperties) (Required): Square Service linked service properties. +* **type**: 'DynamicsAXResource' (Required): Type of dataset. +* **typeProperties**: [DynamicsAXResourceDatasetTypeProperties](#dynamicsaxresourcedatasettypeproperties) (Required): Dynamics AX OData resource dataset properties. -### SybaseLinkedService +### DynamicsCrmEntityDataset #### Properties -* **type**: 'Sybase' (Required): Type of linked service. -* **typeProperties**: [SybaseLinkedServiceTypeProperties](#sybaselinkedservicetypeproperties) (Required): Sybase linked service properties. +* **type**: 'DynamicsCrmEntity' (Required): Type of dataset. +* **typeProperties**: [DynamicsCrmEntityDatasetTypeProperties](#dynamicscrmentitydatasettypeproperties): Dynamics CRM entity dataset properties. -### TeamDeskLinkedService +### DynamicsEntityDataset #### Properties -* **type**: 'TeamDesk' (Required): Type of linked service. -* **typeProperties**: [TeamDeskLinkedServiceTypeProperties](#teamdesklinkedservicetypeproperties) (Required): TeamDesk linked service type properties. +* **type**: 'DynamicsEntity' (Required): Type of dataset. +* **typeProperties**: [DynamicsEntityDatasetTypeProperties](#dynamicsentitydatasettypeproperties): Dynamics entity dataset properties. -### TeradataLinkedService +### EloquaObjectDataset #### Properties -* **type**: 'Teradata' (Required): Type of linked service. -* **typeProperties**: [TeradataLinkedServiceTypeProperties](#teradatalinkedservicetypeproperties) (Required): Teradata linked service properties. +* **type**: 'EloquaObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -### TwilioLinkedService +### ExcelDataset #### Properties -* **type**: 'Twilio' (Required): Type of linked service. -* **typeProperties**: [TwilioLinkedServiceTypeProperties](#twiliolinkedservicetypeproperties) (Required): Twilio linked service type properties. +* **type**: 'Excel' (Required): Type of dataset. +* **typeProperties**: [ExcelDatasetTypeProperties](#exceldatasettypeproperties): Excel dataset properties. -### VerticaLinkedService +### FileShareDataset #### Properties -* **type**: 'Vertica' (Required): Type of linked service. -* **typeProperties**: [VerticaLinkedServiceTypeProperties](#verticalinkedservicetypeproperties) (Required): Vertica linked service properties. +* **type**: 'FileShare' (Required): Type of dataset. +* **typeProperties**: [FileShareDatasetTypeProperties](#filesharedatasettypeproperties): On-premises file system dataset properties. -### WebLinkedService +### GoogleAdWordsObjectDataset #### Properties -* **type**: 'Web' (Required): Type of linked service. -* **typeProperties**: [WebLinkedServiceTypeProperties](#weblinkedservicetypeproperties) (Required): Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models. +* **type**: 'GoogleAdWordsObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -### XeroLinkedService +### GoogleBigQueryObjectDataset #### Properties -* **type**: 'Xero' (Required): Type of linked service. -* **typeProperties**: [XeroLinkedServiceTypeProperties](#xerolinkedservicetypeproperties) (Required): Xero Service linked service properties. +* **type**: 'GoogleBigQueryObject' (Required): Type of dataset. +* **typeProperties**: [GoogleBigQueryDatasetTypeProperties](#googlebigquerydatasettypeproperties): Google BigQuery Dataset Properties -### ZendeskLinkedService +### GreenplumTableDataset #### Properties -* **type**: 'Zendesk' (Required): Type of linked service. -* **typeProperties**: [ZendeskLinkedServiceTypeProperties](#zendesklinkedservicetypeproperties) (Required): Zendesk linked service type properties. +* **type**: 'GreenplumTable' (Required): Type of dataset. +* **typeProperties**: [GreenplumDatasetTypeProperties](#greenplumdatasettypeproperties): Greenplum Dataset Properties -### ZohoLinkedService +### HBaseObjectDataset #### Properties -* **type**: 'Zoho' (Required): Type of linked service. -* **typeProperties**: [ZohoLinkedServiceTypeProperties](#zoholinkedservicetypeproperties) (Required): Zoho server linked service properties. +* **type**: 'HBaseObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. +### HiveObjectDataset +#### Properties +* **type**: 'HiveObject' (Required): Type of dataset. +* **typeProperties**: [HiveDatasetTypeProperties](#hivedatasettypeproperties): Hive Properties -## IntegrationRuntimeReference -### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **referenceName**: string (Required): Reference integration runtime name. -* **type**: 'IntegrationRuntimeReference' | string (Required): Type of integration runtime. +### HttpDataset +#### Properties +* **type**: 'HttpFile' (Required): Type of dataset. +* **typeProperties**: [HttpDatasetTypeProperties](#httpdatasettypeproperties): Properties specific to this dataset type. -## ParameterValueSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: any +### HubspotObjectDataset +#### Properties +* **type**: 'HubspotObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## ParameterDefinitionSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) +### ImpalaObjectDataset +#### Properties +* **type**: 'ImpalaObject' (Required): Type of dataset. +* **typeProperties**: [ImpalaDatasetTypeProperties](#impaladatasettypeproperties): Impala Dataset Properties -## AmazonMWSLinkedServiceTypeProperties -### Properties -* **accessKeyId**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **marketplaceID**: any (Required): Any object -* **mwsAuthToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **secretKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **sellerID**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### InformixTableDataset +#### Properties +* **type**: 'InformixTable' (Required): Type of dataset. +* **typeProperties**: [InformixTableDatasetTypeProperties](#informixtabledatasettypeproperties): Informix table dataset properties. -## AmazonRdsForLinkedServiceTypeProperties -### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. +### JiraObjectDataset +#### Properties +* **type**: 'JiraObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AmazonRdsForSqlServerLinkedServiceTypeProperties -### Properties -* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +### JsonDataset +#### Properties +* **type**: 'Json' (Required): Type of dataset. +* **typeProperties**: [JsonDatasetTypeProperties](#jsondatasettypeproperties): Json dataset properties. -## SqlAlwaysEncryptedProperties -### Properties -* **alwaysEncryptedAkvAuthType**: 'ManagedIdentity' | 'ServicePrincipal' | 'UserAssignedManagedIdentity' | string (Required): Sql always encrypted AKV authentication type. Type: string (or Expression with resultType string). -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +### MagentoObjectDataset +#### Properties +* **type**: 'MagentoObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AmazonRedshiftLinkedServiceTypeProperties -### Properties -* **database**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **server**: any (Required): Any object -* **username**: any: Any object +### MariaDBTableDataset +#### Properties +* **type**: 'MariaDBTable' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AmazonS3LinkedServiceTypeProperties -### Properties -* **accessKeyId**: any: Any object -* **authenticationType**: any: Any object -* **encryptedCredential**: any: Any object -* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **serviceUrl**: any: Any object -* **sessionToken**: [SecretBase](#secretbase): The base definition of a secret type. +### MarketoObjectDataset +#### Properties +* **type**: 'MarketoObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AmazonS3CompatibleLinkedServiceTypeProperties -### Properties -* **accessKeyId**: any: Any object -* **encryptedCredential**: any: Any object -* **forcePathStyle**: any: Any object -* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **serviceUrl**: any: Any object +### MicrosoftAccessTableDataset +#### Properties +* **type**: 'MicrosoftAccessTable' (Required): Type of dataset. +* **typeProperties**: [MicrosoftAccessTableDatasetTypeProperties](#microsoftaccesstabledatasettypeproperties): Microsoft Access table dataset properties. -## AppFiguresLinkedServiceTypeProperties -### Properties -* **clientKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **userName**: any (Required): Any object +### MongoDbAtlasCollectionDataset +#### Properties +* **type**: 'MongoDbAtlasCollection' (Required): Type of dataset. +* **typeProperties**: [MongoDbAtlasCollectionDatasetTypeProperties](#mongodbatlascollectiondatasettypeproperties) (Required): MongoDB Atlas database dataset properties. -## AsanaLinkedServiceTypeProperties -### Properties -* **apiToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **encryptedCredential**: any: Any object +### MongoDbCollectionDataset +#### Properties +* **type**: 'MongoDbCollection' (Required): Type of dataset. +* **typeProperties**: [MongoDbCollectionDatasetTypeProperties](#mongodbcollectiondatasettypeproperties) (Required): MongoDB database dataset properties. -## AzureBatchLinkedServiceTypeProperties -### Properties -* **accessKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **accountName**: any (Required): Any object -* **batchUri**: any (Required): Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: any: Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **poolName**: any (Required): Any object +### MongoDbV2CollectionDataset +#### Properties +* **type**: 'MongoDbV2Collection' (Required): Type of dataset. +* **typeProperties**: [MongoDbV2CollectionDatasetTypeProperties](#mongodbv2collectiondatasettypeproperties) (Required): MongoDB database dataset properties. -## AzureBlobFSLinkedServiceTypeProperties -### Properties -* **accountKey**: any: Any object -* **azureCloudType**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: any: Any object -* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalCredentialType**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object -* **url**: any (Required): Any object +### MySqlTableDataset +#### Properties +* **type**: 'MySqlTable' (Required): Type of dataset. +* **typeProperties**: [MySqlTableDatasetTypeProperties](#mysqltabledatasettypeproperties): MySql table dataset properties. -## AzureBlobStorageLinkedServiceTypeProperties -### Properties -* **accountKey**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **accountKind**: 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). -* **azureCloudType**: any: Any object -* **connectionString**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: string: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). -* **sasToken**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **sasUri**: any: Any object -* **serviceEndpoint**: string: Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### NetezzaTableDataset +#### Properties +* **type**: 'NetezzaTable' (Required): Type of dataset. +* **typeProperties**: [NetezzaTableDatasetTypeProperties](#netezzatabledatasettypeproperties): Netezza dataset properties. -## AzureKeyVaultSecretReference -### Properties -* **secretName**: any (Required): Any object -* **secretVersion**: any: Any object -* **store**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **type**: string (Required): Type of the secret. +### ODataResourceDataset +#### Properties +* **type**: 'ODataResource' (Required): Type of dataset. +* **typeProperties**: [ODataResourceDatasetTypeProperties](#odataresourcedatasettypeproperties): OData dataset properties. -## AzureDatabricksLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **authentication**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **domain**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **existingClusterId**: any: Any object -* **instancePoolId**: any: Any object -* **newClusterCustomTags**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags](#azuredatabrickslinkedservicetypepropertiesnewclustercustomtags): Additional tags for cluster resources. This property is ignored in instance pool configurations. -* **newClusterDriverNodeType**: any: Any object -* **newClusterEnableElasticDisk**: any: Any object -* **newClusterInitScripts**: any: Any object -* **newClusterLogDestination**: any: Any object -* **newClusterNodeType**: any: Any object -* **newClusterNumOfWorker**: any: Any object -* **newClusterSparkConf**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf](#azuredatabrickslinkedservicetypepropertiesnewclustersparkconf): A set of optional, user-specified Spark configuration key-value pairs. -* **newClusterSparkEnvVars**: [AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars](#azuredatabrickslinkedservicetypepropertiesnewclustersparkenvvars): A set of optional, user-specified Spark environment variables key-value pairs. -* **newClusterVersion**: any: Any object -* **policyId**: any: Any object -* **workspaceResourceId**: any: Any object +### OdbcTableDataset +#### Properties +* **type**: 'OdbcTable' (Required): Type of dataset. +* **typeProperties**: [OdbcTableDatasetTypeProperties](#odbctabledatasettypeproperties): ODBC table dataset properties. -## AzureDatabricksLinkedServiceTypePropertiesNewClusterCustomTags -### Properties -### Additional Properties -* **Additional Properties Type**: any +### Office365Dataset +#### Properties +* **type**: 'Office365Table' (Required): Type of dataset. +* **typeProperties**: [Office365DatasetTypeProperties](#office365datasettypeproperties) (Required): Office365 dataset properties. -## AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkConf -### Properties -### Additional Properties -* **Additional Properties Type**: any +### OracleServiceCloudObjectDataset +#### Properties +* **type**: 'OracleServiceCloudObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AzureDatabricksLinkedServiceTypePropertiesNewClusterSparkEnvVars -### Properties -### Additional Properties -* **Additional Properties Type**: any +### OracleTableDataset +#### Properties +* **type**: 'OracleTable' (Required): Type of dataset. +* **typeProperties**: [OracleTableDatasetTypeProperties](#oracletabledatasettypeproperties): On-premises Oracle dataset properties. -## AzureDatabricksDetltaLakeLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **clusterId**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **domain**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **workspaceResourceId**: any: Any object +### OrcDataset +#### Properties +* **type**: 'Orc' (Required): Type of dataset. +* **typeProperties**: [OrcDatasetTypeProperties](#orcdatasettypeproperties): ORC dataset properties. -## AzureDataExplorerLinkedServiceTypeProperties -### Properties -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **database**: any (Required): Any object -* **endpoint**: any (Required): Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### ParquetDataset +#### Properties +* **type**: 'Parquet' (Required): Type of dataset. +* **typeProperties**: [ParquetDatasetTypeProperties](#parquetdatasettypeproperties): Parquet dataset properties. -## AzureDataLakeAnalyticsLinkedServiceTypeProperties -### Properties -* **accountName**: any (Required): Any object -* **dataLakeAnalyticsUri**: any: Any object -* **encryptedCredential**: any: Any object -* **resourceGroupName**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **subscriptionId**: any: Any object -* **tenant**: any (Required): Any object +### PaypalObjectDataset +#### Properties +* **type**: 'PaypalObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AzureDataLakeStoreLinkedServiceTypeProperties -### Properties -* **accountName**: any: Any object -* **azureCloudType**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **dataLakeStoreUri**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **resourceGroupName**: any: Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **subscriptionId**: any: Any object -* **tenant**: any: Any object +### PhoenixObjectDataset +#### Properties +* **type**: 'PhoenixObject' (Required): Type of dataset. +* **typeProperties**: [PhoenixDatasetTypeProperties](#phoenixdatasettypeproperties): Phoenix Dataset Properties -## AzureFileStorageLinkedServiceTypeProperties -### Properties -* **accountKey**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **fileShare**: any: Any object -* **host**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **sasToken**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **sasUri**: any: Any object -* **snapshot**: any: Any object -* **userId**: any: Any object +### PostgreSqlTableDataset +#### Properties +* **type**: 'PostgreSqlTable' (Required): Type of dataset. +* **typeProperties**: [PostgreSqlTableDatasetTypeProperties](#postgresqltabledatasettypeproperties): PostgreSQL table dataset properties. -## AzureFunctionLinkedServiceTypeProperties -### Properties -* **authentication**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: any: Any object -* **functionAppUrl**: any (Required): Any object -* **functionKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **resourceId**: any: Any object +### PrestoObjectDataset +#### Properties +* **type**: 'PrestoObject' (Required): Type of dataset. +* **typeProperties**: [PrestoDatasetTypeProperties](#prestodatasettypeproperties): Presto Dataset Properties -## AzureKeyVaultLinkedServiceTypeProperties -### Properties -* **baseUrl**: any (Required): Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. +### QuickBooksObjectDataset +#### Properties +* **type**: 'QuickBooksObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AzureMariaDBLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +### RelationalTableDataset +#### Properties +* **type**: 'RelationalTable' (Required): Type of dataset. +* **typeProperties**: [RelationalTableDatasetTypeProperties](#relationaltabledatasettypeproperties): Relational table dataset properties. -## AzureMLLinkedServiceTypeProperties -### Properties -* **apiKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **authentication**: any: Any object -* **encryptedCredential**: any: Any object -* **mlEndpoint**: any (Required): Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object -* **updateResourceEndpoint**: any: Any object +### ResponsysObjectDataset +#### Properties +* **type**: 'ResponsysObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AzureMLServiceLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: any: Any object -* **mlWorkspaceName**: any (Required): Any object -* **resourceGroupName**: any (Required): Any object -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **subscriptionId**: any (Required): Any object -* **tenant**: any: Any object +### RestResourceDataset +#### Properties +* **type**: 'RestResource' (Required): Type of dataset. +* **typeProperties**: [RestResourceDatasetTypeProperties](#restresourcedatasettypeproperties): Properties specific to this dataset type. -## AzureMySqlLinkedServiceTypeProperties -### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +### SalesforceMarketingCloudObjectDataset +#### Properties +* **type**: 'SalesforceMarketingCloudObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## AzurePostgreSqlLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +### SalesforceObjectDataset +#### Properties +* **type**: 'SalesforceObject' (Required): Type of dataset. +* **typeProperties**: [SalesforceObjectDatasetTypeProperties](#salesforceobjectdatasettypeproperties): Salesforce object dataset properties. -## AzureSearchLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: any: Any object -* **key**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object +### SalesforceServiceCloudObjectDataset +#### Properties +* **type**: 'SalesforceServiceCloudObject' (Required): Type of dataset. +* **typeProperties**: [SalesforceServiceCloudObjectDatasetTypeProperties](#salesforceservicecloudobjectdatasettypeproperties): Salesforce Service Cloud object dataset properties. -## AzureSqlDatabaseLinkedServiceTypeProperties -### Properties -* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. -* **azureCloudType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### SapBwCubeDataset +#### Properties +* **type**: 'SapBwCube' (Required): Type of dataset. -## AzureSqlDWLinkedServiceTypeProperties -### Properties -* **azureCloudType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### SapCloudForCustomerResourceDataset +#### Properties +* **type**: 'SapCloudForCustomerResource' (Required): Type of dataset. +* **typeProperties**: [SapCloudForCustomerResourceDatasetTypeProperties](#sapcloudforcustomerresourcedatasettypeproperties) (Required): Sap Cloud For Customer OData resource dataset properties. -## AzureSqlMILinkedServiceTypeProperties -### Properties -* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. -* **azureCloudType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object +### SapEccResourceDataset +#### Properties +* **type**: 'SapEccResource' (Required): Type of dataset. +* **typeProperties**: [SapEccResourceDatasetTypeProperties](#sapeccresourcedatasettypeproperties) (Required): Sap ECC OData resource dataset properties. -## AzureStorageLinkedServiceTypeProperties -### Properties -* **accountKey**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **connectionString**: any: Any object -* **encryptedCredential**: string: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string). -* **sasToken**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **sasUri**: any: Any object +### SapHanaTableDataset +#### Properties +* **type**: 'SapHanaTable' (Required): Type of dataset. +* **typeProperties**: [SapHanaTableDatasetTypeProperties](#saphanatabledatasettypeproperties): SAP HANA Table properties. -## CassandraLinkedServiceTypeProperties -### Properties -* **authenticationType**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **username**: any: Any object +### SapOpenHubTableDataset +#### Properties +* **type**: 'SapOpenHubTable' (Required): Type of dataset. +* **typeProperties**: [SapOpenHubTableDatasetTypeProperties](#sapopenhubtabledatasettypeproperties) (Required): Sap Business Warehouse Open Hub Destination Table properties. -## CommonDataServiceForAppsLinkedServiceTypeProperties -### Properties -* **authenticationType**: any (Required): Any object -* **deploymentType**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **hostName**: any: Any object -* **organizationName**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalCredentialType**: any: Any object -* **servicePrincipalId**: any: Any object -* **serviceUri**: any: Any object -* **username**: any: Any object +### SapTableResourceDataset +#### Properties +* **type**: 'SapTableResource' (Required): Type of dataset. +* **typeProperties**: [SapTableResourceDatasetTypeProperties](#saptableresourcedatasettypeproperties) (Required): SAP Table Resource properties. -## ConcurLinkedServiceTypeProperties -### Properties -* **clientId**: any (Required): Any object -* **connectionProperties**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object +### ServiceNowObjectDataset +#### Properties +* **type**: 'ServiceNowObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## CosmosDbLinkedServiceTypeProperties -### Properties -* **accountEndpoint**: any: Any object -* **accountKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **azureCloudType**: any: Any object -* **connectionMode**: 'Direct' | 'Gateway' | string: The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string). -* **connectionString**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **database**: any: Any object -* **encryptedCredential**: any: Any object -* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalCredentialType**: 'ServicePrincipalCert' | 'ServicePrincipalKey' | 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). -* **servicePrincipalId**: any: Any object -* **tenant**: any: Any object +### SharePointOnlineListResourceDataset +#### Properties +* **type**: 'SharePointOnlineListResource' (Required): Type of dataset. +* **typeProperties**: [SharePointOnlineListDatasetTypeProperties](#sharepointonlinelistdatasettypeproperties): Sharepoint online list dataset properties. -## CosmosDbMongoDbApiLinkedServiceTypeProperties -### Properties -* **connectionString**: any (Required): Any object -* **database**: any (Required): Any object -* **isServerVersionAbove32**: any: Any object +### ShopifyObjectDataset +#### Properties +* **type**: 'ShopifyObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## CouchbaseLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **credString**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -* **encryptedCredential**: any: Any object +### SnowflakeDataset +#### Properties +* **type**: 'SnowflakeTable' (Required): Type of dataset. +* **typeProperties**: [SnowflakeDatasetTypeProperties](#snowflakedatasettypeproperties) (Required): Snowflake dataset properties. -## DataworldLinkedServiceTypeProperties -### Properties -* **apiToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **encryptedCredential**: any: Any object +### SparkObjectDataset +#### Properties +* **type**: 'SparkObject' (Required): Type of dataset. +* **typeProperties**: [SparkDatasetTypeProperties](#sparkdatasettypeproperties): Spark Properties -## Db2LinkedServiceTypeProperties -### Properties -* **authenticationType**: 'Basic' | string: AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. -* **certificateCommonName**: any: Any object -* **connectionString**: any: Any object -* **database**: any: Any object -* **encryptedCredential**: any: Any object -* **packageCollection**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any: Any object -* **username**: any: Any object +### SqlServerTableDataset +#### Properties +* **type**: 'SqlServerTable' (Required): Type of dataset. +* **typeProperties**: [SqlServerTableDatasetTypeProperties](#sqlservertabledatasettypeproperties): On-premises SQL Server dataset properties. -## DrillLinkedServiceTypeProperties -### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +### SquareObjectDataset +#### Properties +* **type**: 'SquareObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## DynamicsLinkedServiceTypeProperties -### Properties -* **authenticationType**: any (Required): Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **deploymentType**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **hostName**: any: Any object -* **organizationName**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalCredentialType**: any: Any object -* **servicePrincipalId**: any: Any object -* **serviceUri**: any: Any object -* **username**: any: Any object +### SybaseTableDataset +#### Properties +* **type**: 'SybaseTable' (Required): Type of dataset. +* **typeProperties**: [SybaseTableDatasetTypeProperties](#sybasetabledatasettypeproperties): Sybase table dataset properties. -## DynamicsAXLinkedServiceTypeProperties -### Properties -* **aadResourceId**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **servicePrincipalId**: any (Required): Any object -* **servicePrincipalKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **tenant**: any (Required): Any object -* **url**: any (Required): Any object +### TeradataTableDataset +#### Properties +* **type**: 'TeradataTable' (Required): Type of dataset. +* **typeProperties**: [TeradataTableDatasetTypeProperties](#teradatatabledatasettypeproperties): Teradata dataset properties. -## DynamicsCrmLinkedServiceTypeProperties -### Properties -* **authenticationType**: any (Required): Any object -* **deploymentType**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **hostName**: any: Any object -* **organizationName**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalCredentialType**: any: Any object -* **servicePrincipalId**: any: Any object -* **serviceUri**: any: Any object -* **username**: any: Any object +### VerticaTableDataset +#### Properties +* **type**: 'VerticaTable' (Required): Type of dataset. +* **typeProperties**: [VerticaDatasetTypeProperties](#verticadatasettypeproperties): Vertica Properties -## EloquaLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object +### WebTableDataset +#### Properties +* **type**: 'WebTable' (Required): Type of dataset. +* **typeProperties**: [WebTableDatasetTypeProperties](#webtabledatasettypeproperties) (Required): Web table dataset properties. -## FileServerLinkedServiceTypeProperties -### Properties -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userId**: any: Any object +### XeroObjectDataset +#### Properties +* **type**: 'XeroObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. -## FtpServerLinkedServiceTypeProperties +### XmlDataset +#### Properties +* **type**: 'Xml' (Required): Type of dataset. +* **typeProperties**: [XmlDatasetTypeProperties](#xmldatasettypeproperties): Xml dataset properties. + +### ZohoObjectDataset +#### Properties +* **type**: 'ZohoObject' (Required): Type of dataset. +* **typeProperties**: [GenericDatasetTypeProperties](#genericdatasettypeproperties): Properties specific to this dataset type. + + +## DatasetCompression ### Properties -* **authenticationType**: 'Anonymous' | 'Basic' | string: The authentication type to be used to connect to the FTP server. -* **enableServerCertificateValidation**: any: Any object -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **userName**: any: Any object +* **level**: any: Any object +* **type**: any (Required): Any object +### Additional Properties +* **Additional Properties Type**: any -## GoogleAdWordsLinkedServiceTypeProperties +## DatasetFolder ### Properties -* **authenticationType**: 'ServiceAuthentication' | 'UserAuthentication' | string: The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. -* **clientCustomerID**: any: Any object -* **clientId**: any: Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **connectionProperties**: any: Any object -* **developerToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **email**: any: Any object -* **encryptedCredential**: any: Any object -* **keyFilePath**: any: Any object -* **refreshToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **trustedCertPath**: any: Any object -* **useSystemTrustStore**: any: Any object +* **name**: string: The name of the folder that this Dataset is in. -## GoogleBigQueryLinkedServiceTypeProperties -### Properties -* **additionalProjects**: any: Any object -* **authenticationType**: 'ServiceAuthentication' | 'UserAuthentication' | string (Required): The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. -* **clientId**: any: Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **email**: any: Any object -* **encryptedCredential**: any: Any object -* **keyFilePath**: any: Any object -* **project**: any (Required): Any object -* **refreshToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **requestGoogleDriveScope**: any: Any object -* **trustedCertPath**: any: Any object -* **useSystemTrustStore**: any: Any object +## DatasetLocation +* **Discriminator**: type -## GoogleCloudStorageLinkedServiceTypeProperties +### Base Properties +* **fileName**: any: Any object +* **folderPath**: any: Any object +### AmazonS3CompatibleLocation +#### Properties +* **bucketName**: any: Any object +* **type**: 'AmazonS3CompatibleLocation' (Required): Type of dataset storage location. +* **version**: any: Any object + +### AmazonS3Location +#### Properties +* **bucketName**: any: Any object +* **type**: 'AmazonS3Location' (Required): Type of dataset storage location. +* **version**: any: Any object + +### AzureBlobFSLocation +#### Properties +* **fileSystem**: any: Any object +* **type**: 'AzureBlobFSLocation' (Required): Type of dataset storage location. + +### AzureBlobStorageLocation +#### Properties +* **container**: any: Any object +* **type**: 'AzureBlobStorageLocation' (Required): Type of dataset storage location. + +### AzureDataLakeStoreLocation +#### Properties +* **type**: 'AzureDataLakeStoreLocation' (Required): Type of dataset storage location. + +### AzureFileStorageLocation +#### Properties +* **type**: 'AzureFileStorageLocation' (Required): Type of dataset storage location. + +### FileServerLocation +#### Properties +* **type**: 'FileServerLocation' (Required): Type of dataset storage location. + +### FtpServerLocation +#### Properties +* **type**: 'FtpServerLocation' (Required): Type of dataset storage location. + +### GoogleCloudStorageLocation +#### Properties +* **bucketName**: any: Any object +* **type**: 'GoogleCloudStorageLocation' (Required): Type of dataset storage location. +* **version**: any: Any object + +### HdfsLocation +#### Properties +* **type**: 'HdfsLocation' (Required): Type of dataset storage location. + +### HttpServerLocation +#### Properties +* **relativeUrl**: any: Any object +* **type**: 'HttpServerLocation' (Required): Type of dataset storage location. + +### OracleCloudStorageLocation +#### Properties +* **bucketName**: any: Any object +* **type**: 'OracleCloudStorageLocation' (Required): Type of dataset storage location. +* **version**: any: Any object + +### SftpLocation +#### Properties +* **type**: 'SftpLocation' (Required): Type of dataset storage location. + + +## DatasetReference ### Properties -* **accessKeyId**: any: Any object -* **encryptedCredential**: any: Any object -* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **serviceUrl**: any: Any object +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **referenceName**: string (Required): Reference dataset name. +* **type**: 'DatasetReference' | string (Required): Dataset reference type. -## GreenplumLinkedServiceTypeProperties +## DatasetStorageFormat +* **Discriminator**: type + +### Base Properties +* **deserializer**: any: Any object +* **serializer**: any: Any object +### AvroFormat +#### Properties +* **type**: 'AvroFormat' (Required): Type of dataset storage format. + +### JsonFormat +#### Properties +* **encodingName**: any: Any object +* **filePattern**: any: Any object +* **jsonNodeReference**: any: Any object +* **jsonPathDefinition**: any: Any object +* **nestingSeparator**: any: Any object +* **type**: 'JsonFormat' (Required): Type of dataset storage format. + +### OrcFormat +#### Properties +* **type**: 'OrcFormat' (Required): Type of dataset storage format. + +### ParquetFormat +#### Properties +* **type**: 'ParquetFormat' (Required): Type of dataset storage format. + +### TextFormat +#### Properties +* **columnDelimiter**: any: Any object +* **encodingName**: any: Any object +* **escapeChar**: any: Any object +* **firstRowAsHeader**: any: Any object +* **nullValue**: any: Any object +* **quoteChar**: any: Any object +* **rowDelimiter**: any: Any object +* **skipLineCount**: any: Any object +* **treatEmptyAsNull**: any: Any object +* **type**: 'TextFormat' (Required): Type of dataset storage format. + + +## DataworldLinkedServiceTypeProperties ### Properties -* **connectionString**: any: Any object +* **apiToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. * **encryptedCredential**: any: Any object -* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -## HBaseLinkedServiceTypeProperties +## Db2LinkedServiceTypeProperties ### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'Basic' | string (Required): The authentication mechanism to use to connect to the HBase server. -* **enableSsl**: any: Any object +* **authenticationType**: 'Basic' | string: AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. +* **certificateCommonName**: any: Any object +* **connectionString**: any: Any object +* **database**: any: Any object * **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **httpPath**: any: Any object +* **packageCollection**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **trustedCertPath**: any: Any object +* **server**: any: Any object * **username**: any: Any object -## HdfsLinkedServiceTypeProperties +## Db2TableDatasetTypeProperties ### Properties -* **authenticationType**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object -* **userName**: any: Any object +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -## HDInsightLinkedServiceTypeProperties +## DeleteActivityTypeProperties ### Properties -* **clusterUri**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **fileSystem**: any: Any object -* **hcatalogLinkedServiceName**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **isEspEnabled**: any: Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. +* **enableLogging**: any: Any object +* **logStorageSettings**: [LogStorageSettings](#logstoragesettings): (Deprecated. Please use LogSettings) Log storage settings. +* **maxConcurrentConnections**: int: The max concurrent connections to connect data source at the same time. +* **recursive**: any: Any object +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -## HDInsightOnDemandLinkedServiceTypeProperties +## DelimitedTextDatasetTypeProperties ### Properties -* **additionalLinkedServiceNames**: [LinkedServiceReference](#linkedservicereference)[]: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. -* **clusterNamePrefix**: any: Any object -* **clusterPassword**: [SecretBase](#secretbase): The base definition of a secret type. -* **clusterResourceGroup**: any (Required): Any object -* **clusterSize**: any (Required): Any object -* **clusterSshPassword**: [SecretBase](#secretbase): The base definition of a secret type. -* **clusterSshUserName**: any: Any object -* **clusterType**: any: Any object -* **clusterUserName**: any: Any object -* **coreConfiguration**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **dataNodeSize**: any: Any object -* **encryptedCredential**: any: Any object -* **hBaseConfiguration**: any: Any object -* **hcatalogLinkedServiceName**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **hdfsConfiguration**: any: Any object -* **headNodeSize**: any: Any object -* **hiveConfiguration**: any: Any object -* **hostSubscriptionId**: any (Required): Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **mapReduceConfiguration**: any: Any object -* **oozieConfiguration**: any: Any object -* **scriptActions**: [ScriptAction](#scriptaction)[]: 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. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **sparkVersion**: any: Any object -* **stormConfiguration**: any: Any object -* **subnetName**: any: Any object -* **tenant**: any (Required): Any object -* **timeToLive**: any (Required): Any object -* **version**: any (Required): Any object -* **virtualNetworkId**: any: Any object -* **yarnConfiguration**: any: Any object -* **zookeeperNodeSize**: any: Any object +* **columnDelimiter**: any: Any object +* **compressionCodec**: any: Any object +* **compressionLevel**: any: Any object +* **encodingName**: any: Any object +* **escapeChar**: any: Any object +* **firstRowAsHeader**: any: Any object +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +* **nullValue**: any: Any object +* **quoteChar**: any: Any object +* **rowDelimiter**: any: Any object -## ScriptAction +## DelimitedTextReadSettings ### Properties -* **name**: string (Required): The user provided name of the script action. -* **parameters**: string: The parameters for the script action. -* **roles**: any (Required): Any object -* **uri**: string (Required): The URI for the script action. +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **skipLineCount**: any: Any object +* **type**: string (Required): The read setting type. +### Additional Properties +* **Additional Properties Type**: any -## HiveLinkedServiceTypeProperties +## DelimitedTextWriteSettings ### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'Username' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication method used to access the Hive server. -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **httpPath**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **serverType**: 'HiveServer1' | 'HiveServer2' | 'HiveThriftServer' | string: The type of Hive server. -* **serviceDiscoveryMode**: any: Any object -* **thriftTransportProtocol**: 'Binary' | 'HTTP ' | 'SASL' | string: The transport protocol to use in the Thrift layer. -* **trustedCertPath**: any: Any object -* **useNativeQuery**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object -* **zooKeeperNameSpace**: any: Any object +* **fileExtension**: any (Required): Any object +* **fileNamePrefix**: any: Any object +* **maxRowsPerFile**: any: Any object +* **quoteAllText**: any: Any object +* **type**: string (Required): The write setting type. +### Additional Properties +* **Additional Properties Type**: any -## HttpLinkedServiceTypeProperties -### Properties -* **authenticationType**: 'Anonymous' | 'Basic' | 'ClientCertificate' | 'Digest' | 'Windows' | string: The authentication type to be used to connect to the HTTP server. -* **authHeaders**: any: Any object -* **certThumbprint**: any: Any object -* **embeddedCertData**: any: Any object -* **enableServerCertificateValidation**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object -* **userName**: any: Any object +## DependencyReference +* **Discriminator**: type -## HubspotLinkedServiceTypeProperties -### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **refreshToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### Base Properties +### SelfDependencyTumblingWindowTriggerReference +#### Properties +* **offset**: string (Required): Timespan applied to the start time of a tumbling window when evaluating dependency. +* **size**: string: The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. +* **type**: 'SelfDependencyTumblingWindowTriggerReference' (Required): The type of dependency reference. -## ImpalaLinkedServiceTypeProperties -### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'SASLUsername' | 'UsernameAndPassword' | string (Required): The authentication type to use. -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **trustedCertPath**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object +### TumblingWindowTriggerDependencyReference +#### Properties +* **offset**: string: Timespan applied to the start time of a tumbling window when evaluating dependency. +* **size**: string: The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. +* **type**: 'TumblingWindowTriggerDependencyReference' (Required): The type of dependency reference. -## InformixLinkedServiceTypeProperties + +## DistcpSettings ### Properties -* **authenticationType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +* **distcpOptions**: any: Any object +* **resourceManagerEndpoint**: any (Required): Any object +* **tempScriptPath**: any (Required): Any object -## JiraLinkedServiceTypeProperties +## DocumentDbCollectionDatasetTypeProperties ### Properties -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object +* **collectionName**: any (Required): Any object -## MagentoLinkedServiceTypeProperties +## DrillDatasetTypeProperties ### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -## MariaDBLinkedServiceTypeProperties +## DrillLinkedServiceTypeProperties ### Properties * **connectionString**: any: Any object * **encryptedCredential**: any: Any object * **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -## MarketoLinkedServiceTypeProperties +## DWCopyCommandDefaultValue ### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **columnName**: any: Any object +* **defaultValue**: any: Any object -## MicrosoftAccessLinkedServiceTypeProperties +## DWCopyCommandSettings ### Properties -* **authenticationType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +* **additionalOptions**: [DWCopyCommandSettingsAdditionalOptions](#dwcopycommandsettingsadditionaloptions): 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'" } +* **defaultValues**: [DWCopyCommandDefaultValue](#dwcopycommanddefaultvalue)[]: 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). -## MongoDbLinkedServiceTypeProperties +## DWCopyCommandSettingsAdditionalOptions ### Properties -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'Basic' | string: The authentication type to be used to connect to the MongoDB database. -* **authSource**: any: Any object -* **databaseName**: any (Required): Any object -* **enableSsl**: any: Any object +### Additional Properties +* **Additional Properties Type**: string + +## DynamicsAXLinkedServiceTypeProperties +### Properties +* **aadResourceId**: any (Required): Any object * **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **server**: any (Required): Any object -* **username**: any: Any object +* **servicePrincipalId**: any (Required): Any object +* **servicePrincipalKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **tenant**: any (Required): Any object +* **url**: any (Required): Any object -## MongoDbAtlasLinkedServiceTypeProperties +## DynamicsAXResourceDatasetTypeProperties ### Properties -* **connectionString**: any (Required): Any object -* **database**: any (Required): Any object +* **path**: any (Required): Any object -## MongoDbV2LinkedServiceTypeProperties +## DynamicsCrmEntityDatasetTypeProperties ### Properties -* **connectionString**: any (Required): Any object -* **database**: any (Required): Any object +* **entityName**: any: Any object -## MySqlLinkedServiceTypeProperties +## DynamicsCrmLinkedServiceTypeProperties ### Properties -* **connectionString**: any (Required): Any object +* **authenticationType**: any (Required): Any object +* **deploymentType**: any (Required): Any object * **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **hostName**: any: Any object +* **organizationName**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalCredentialType**: any: Any object +* **servicePrincipalId**: any: Any object +* **serviceUri**: any: Any object +* **username**: any: Any object -## NetezzaLinkedServiceTypeProperties +## DynamicsEntityDatasetTypeProperties ### Properties -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **entityName**: any: Any object -## ODataLinkedServiceTypeProperties +## DynamicsLinkedServiceTypeProperties ### Properties -* **aadResourceId**: any: Any object -* **aadServicePrincipalCredentialType**: 'ServicePrincipalCert' | 'ServicePrincipalKey' | string: Specify the credential type (key or cert) is used for service principal. -* **authenticationType**: 'AadServicePrincipal' | 'Anonymous' | 'Basic' | 'ManagedServiceIdentity' | 'Windows' | string: Type of authentication used to connect to the OData service. -* **authHeaders**: any: Any object -* **azureCloudType**: any: Any object +* **authenticationType**: any (Required): Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **deploymentType**: any (Required): Any object * **encryptedCredential**: any: Any object +* **hostName**: any: Any object +* **organizationName**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalEmbeddedCert**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalEmbeddedCertPassword**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **servicePrincipalCredential**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalCredentialType**: any: Any object * **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object -* **url**: any (Required): Any object -* **userName**: any: Any object +* **serviceUri**: any: Any object +* **username**: any: Any object -## OdbcLinkedServiceTypeProperties +## EloquaLinkedServiceTypeProperties ### Properties -* **authenticationType**: any: Any object -* **connectionString**: any (Required): Any object -* **credential**: [SecretBase](#secretbase): The base definition of a secret type. * **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **userName**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object -## Office365LinkedServiceTypeProperties +## EncryptionConfiguration ### Properties -* **encryptedCredential**: any: Any object -* **office365TenantId**: any (Required): Any object -* **servicePrincipalId**: any (Required): Any object -* **servicePrincipalKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **servicePrincipalTenantId**: any (Required): Any object +* **identity**: [CMKIdentityDefinition](#cmkidentitydefinition): Managed Identity used for CMK. +* **keyName**: string (Required): The name of the key in Azure Key Vault to use as Customer Managed Key. +* **keyVersion**: string: The version of the key used for CMK. If not provided, latest version will be used. +* **vaultBaseUrl**: string (Required): The url of the Azure Key Vault used for CMK. -## OracleLinkedServiceTypeProperties +## EntityReference ### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## OracleCloudStorageLinkedServiceTypeProperties +## EnvironmentVariableSetupTypeProperties ### Properties -* **accessKeyId**: any: Any object -* **encryptedCredential**: any: Any object -* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **serviceUrl**: any: Any object +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## OracleServiceCloudLinkedServiceTypeProperties +## ExcelDatasetTypeProperties ### Properties -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any (Required): Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **firstRowAsHeader**: any: Any object +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +* **nullValue**: any: Any object +* **range**: any: Any object +* **sheetIndex**: any: Any object +* **sheetName**: any: Any object -## PaypalLinkedServiceTypeProperties +## ExecuteDataFlowActivityTypeProperties ### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **compute**: [ExecuteDataFlowActivityTypePropertiesCompute](#executedataflowactivitytypepropertiescompute): Compute properties for data flow activity. +* **continueOnError**: any: Any object +* **dataFlow**: [DataFlowReference](#dataflowreference) (Required): Data flow reference type. +* **integrationRuntime**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. +* **runConcurrently**: any: Any object +* **staging**: [DataFlowStagingInfo](#dataflowstaginginfo): Staging info for execute data flow activity. +* **traceLevel**: any: Any object -## PhoenixLinkedServiceTypeProperties +## ExecuteDataFlowActivityTypePropertiesCompute ### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication mechanism used to connect to the Phoenix server. -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **httpPath**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **trustedCertPath**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object +* **computeType**: any: Any object +* **coreCount**: any: Any object -## PostgreSqlLinkedServiceTypeProperties +## ExecutePipelineActivityPolicy ### Properties -* **connectionString**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **secureInput**: bool: When set to true, Input from activity is considered as secure and will not be logged to monitoring. +### Additional Properties +* **Additional Properties Type**: any -## PrestoLinkedServiceTypeProperties +## ExecutePipelineActivityTypeProperties ### Properties -* **allowHostNameCNMismatch**: any: Any object -* **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'LDAP' | string (Required): The authentication mechanism used to connect to the Presto server. -* **catalog**: any (Required): Any object -* **enableSsl**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any: Any object -* **serverVersion**: any (Required): Any object -* **timeZoneID**: any: Any object -* **trustedCertPath**: any: Any object -* **username**: any: Any object -* **useSystemTrustStore**: any: Any object +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **pipeline**: [PipelineReference](#pipelinereference) (Required): Pipeline reference type. +* **waitOnCompletion**: bool: Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false. -## QuickbaseLinkedServiceTypeProperties +## ExecutePowerQueryActivityTypeProperties ### Properties -* **encryptedCredential**: any: Any object -* **url**: any (Required): Any object -* **userToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **compute**: [ExecuteDataFlowActivityTypePropertiesCompute](#executedataflowactivitytypepropertiescompute): Compute properties for data flow activity. +* **continueOnError**: any: Any object +* **dataFlow**: [DataFlowReference](#dataflowreference) (Required): Data flow reference type. +* **integrationRuntime**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. +* **queries**: [PowerQuerySinkMapping](#powerquerysinkmapping)[]: List of mapping for Power Query mashup query to sink dataset(s). +* **runConcurrently**: any: Any object +* **sinks**: [ExecutePowerQueryActivityTypePropertiesSinks](#executepowerqueryactivitytypepropertiessinks): (Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName. +* **staging**: [DataFlowStagingInfo](#dataflowstaginginfo): Staging info for execute data flow activity. +* **traceLevel**: any: Any object -## QuickBooksLinkedServiceTypeProperties +## ExecutePowerQueryActivityTypePropertiesSinks ### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **accessTokenSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **companyId**: any: Any object -* **connectionProperties**: any: Any object -* **consumerKey**: any: Any object -* **consumerSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any: Any object -* **useEncryptedEndpoints**: any: Any object +### Additional Properties +* **Additional Properties Type**: [PowerQuerySink](#powerquerysink) -## ResponsysLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypeProperties ### Properties -* **clientId**: any (Required): Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference) (Required): Integration runtime reference type. +* **environmentPath**: any: Any object +* **executionCredential**: [SsisExecutionCredential](#ssisexecutioncredential): SSIS package execution credential. +* **loggingLevel**: any: Any object +* **logLocation**: [SsisLogLocation](#ssisloglocation): SSIS package execution log location +* **packageConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers](#executessispackageactivitytypepropertiespackageconnectionmanagers): The package level connection managers to execute the SSIS package. +* **packageLocation**: [SsisPackageLocation](#ssispackagelocation) (Required): SSIS package location. +* **packageParameters**: [ExecuteSsisPackageActivityTypePropertiesPackageParameters](#executessispackageactivitytypepropertiespackageparameters): The package level parameters to execute the SSIS package. +* **projectConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers](#executessispackageactivitytypepropertiesprojectconnectionmanagers): The project level connection managers to execute the SSIS package. +* **projectParameters**: [ExecuteSsisPackageActivityTypePropertiesProjectParameters](#executessispackageactivitytypepropertiesprojectparameters): The project level parameters to execute the SSIS package. +* **propertyOverrides**: [ExecuteSsisPackageActivityTypePropertiesPropertyOverrides](#executessispackageactivitytypepropertiespropertyoverrides): The property overrides to execute the SSIS package. +* **runtime**: any: Any object -## RestServiceLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers ### Properties -* **aadResourceId**: any: Any object -* **authenticationType**: 'AadServicePrincipal' | 'Anonymous' | 'Basic' | 'ManagedServiceIdentity' | string (Required): Type of authentication used to connect to the REST service. -* **authHeaders**: any: Any object -* **azureCloudType**: any: Any object -* **credential**: [CredentialReference](#credentialreference): Credential reference type. -* **enableServerCertificateValidation**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **servicePrincipalId**: any: Any object -* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **tenant**: any: Any object -* **url**: any (Required): Any object -* **userName**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) -## SalesforceLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesPackageParameters ### Properties -* **apiVersion**: any: Any object -* **encryptedCredential**: any: Any object -* **environmentUrl**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **securityToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **username**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## SalesforceMarketingCloudLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers ### Properties -* **clientId**: any: Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **connectionProperties**: any: Any object -* **encryptedCredential**: any: Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) -## SalesforceServiceCloudLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesProjectParameters ### Properties -* **apiVersion**: any: Any object -* **encryptedCredential**: any: Any object -* **environmentUrl**: any: Any object -* **extendedProperties**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **securityToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **username**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## SapBWLinkedServiceTypeProperties +## ExecuteSsisPackageActivityTypePropertiesPropertyOverrides ### Properties -* **clientId**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any (Required): Any object -* **systemNumber**: any (Required): Any object -* **userName**: any: Any object +### Additional Properties +* **Additional Properties Type**: [SsisPropertyOverride](#ssispropertyoverride) -## SapCloudForCustomerLinkedServiceTypeProperties +## Expression ### Properties -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object -* **username**: any: Any object +* **type**: 'Expression' | string (Required): Expression type. +* **value**: string (Required): Expression value. -## SapEccLinkedServiceTypeProperties +## FactoryIdentity ### Properties -* **encryptedCredential**: string: 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). -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: string (Required): The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). -* **username**: string: The username for Basic authentication. Type: string (or Expression with resultType string). +* **principalId**: string (ReadOnly): The principal id of the identity. +* **tenantId**: string (ReadOnly): The client tenant id of the identity. +* **type**: 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [UserAssignedIdentitiesDefinitionSpecification](#userassignedidentitiesdefinitionspecification): Definition of all user assigned identities for a factory. -## SapHanaLinkedServiceProperties +## FactoryProperties ### Properties -* **authenticationType**: 'Basic' | 'Windows' | string: The authentication type to be used to connect to the SAP HANA server. -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any: Any object -* **userName**: any: Any object +* **createTime**: string (ReadOnly): Time the factory was created in ISO8601 format. +* **encryption**: [EncryptionConfiguration](#encryptionconfiguration): Definition of CMK for the factory. +* **globalParameters**: [GlobalParameterDefinitionSpecification](#globalparameterdefinitionspecification): Definition of all parameters for an entity. +* **provisioningState**: string (ReadOnly): Factory provisioning state, example Succeeded. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the data factory. +* **repoConfiguration**: [FactoryRepoConfiguration](#factoryrepoconfiguration): Factory's git repo information. +* **version**: string (ReadOnly): Version of the factory. -## SapOpenHubLinkedServiceTypeProperties +## FactoryRepoConfiguration +* **Discriminator**: type + +### Base Properties +* **accountName**: string (Required): Account name. +* **collaborationBranch**: string (Required): Collaboration branch. +* **lastCommitId**: string: Last commit id. +* **repositoryName**: string (Required): Repository name. +* **rootFolder**: string (Required): Root folder. +### FactoryGitHubConfiguration +#### Properties +* **clientId**: string: GitHub bring your own app client id. +* **clientSecret**: [GitHubClientSecret](#githubclientsecret): Client secret information for factory's bring your own app repository configuration. +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **type**: 'FactoryGitHubConfiguration' (Required): Type of repo configuration. + +### FactoryVstsConfiguration +#### Properties +* **projectName**: string (Required): VSTS project name. +* **tenantId**: string: VSTS tenant id. +* **type**: 'FactoryVSTSConfiguration' (Required): Type of repo configuration. + + +## FailActivityTypeProperties ### Properties -* **clientId**: any: Any object -* **encryptedCredential**: any: Any object -* **language**: any: Any object -* **logonGroup**: any: Any object -* **messageServer**: any: Any object -* **messageServerService**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any: Any object -* **systemId**: any: Any object -* **systemNumber**: any: Any object -* **userName**: any: Any object +* **errorCode**: any (Required): Any object +* **message**: any (Required): Any object -## SapTableLinkedServiceTypeProperties +## FileServerLinkedServiceTypeProperties ### Properties -* **clientId**: any: Any object * **encryptedCredential**: any: Any object -* **language**: any: Any object -* **logonGroup**: any: Any object -* **messageServer**: any: Any object -* **messageServerService**: any: Any object +* **host**: any (Required): Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any: Any object -* **sncLibraryPath**: any: Any object -* **sncMode**: any: Any object -* **sncMyName**: any: Any object -* **sncPartnerName**: any: Any object -* **sncQop**: any: Any object -* **systemId**: any: Any object -* **systemNumber**: any: Any object -* **userName**: any: Any object +* **userId**: any: Any object -## ServiceNowLinkedServiceTypeProperties +## FileShareDatasetTypeProperties ### Properties -* **authenticationType**: 'Basic' | 'OAuth2' | string (Required): The authentication type to use. -* **clientId**: any: Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **encryptedCredential**: any: Any object -* **endpoint**: any (Required): Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object -* **username**: any: Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **fileFilter**: any: Any object +* **fileName**: any: Any object +* **folderPath**: any: Any object +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object -## SftpServerLinkedServiceTypeProperties +## FilterActivityTypeProperties ### Properties -* **authenticationType**: 'Basic' | 'MultiFactor' | 'SshPublicKey' | string: The authentication type to be used to connect to the FTP server. +* **condition**: [Expression](#expression) (Required): Azure Data Factory expression definition. +* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. + +## FlowletTypeProperties +### Properties +* **script**: string: Flowlet script. +* **scriptLines**: string[]: Flowlet script lines. +* **sinks**: [DataFlowSink](#dataflowsink)[]: List of sinks in Flowlet. +* **sources**: [DataFlowSource](#dataflowsource)[]: List of sources in Flowlet. +* **transformations**: [Transformation](#transformation)[]: List of transformations in Flowlet. + +## ForEachActivityTypeProperties +### Properties +* **activities**: [Activity](#activity)[] (Required): List of activities to execute . +* **batchCount**: int: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false). +* **isSequential**: bool: Should the loop be executed in sequence or in parallel (max 50) +* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. + +## FormatReadSettings +* **Discriminator**: type + +### Base Properties +### BinaryReadSettings +#### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **type**: 'BinaryReadSettings' (Required): The read setting type. + +### DelimitedTextReadSettings +#### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **skipLineCount**: any: Any object +* **type**: 'DelimitedTextReadSettings' (Required): The read setting type. + +### JsonReadSettings +#### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **type**: 'JsonReadSettings' (Required): The read setting type. + +### XmlReadSettings +#### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **detectDataType**: any: Any object +* **namespacePrefixes**: any: Any object +* **namespaces**: any: Any object +* **type**: 'XmlReadSettings' (Required): The read setting type. +* **validationMode**: any: Any object + + +## FtpServerLinkedServiceTypeProperties +### Properties +* **authenticationType**: 'Anonymous' | 'Basic' | string: The authentication type to be used to connect to the FTP server. +* **enableServerCertificateValidation**: any: Any object +* **enableSsl**: any: Any object * **encryptedCredential**: any: Any object * **host**: any (Required): Any object -* **hostKeyFingerprint**: any: Any object -* **passPhrase**: [SecretBase](#secretbase): The base definition of a secret type. * **password**: [SecretBase](#secretbase): The base definition of a secret type. * **port**: any: Any object -* **privateKeyContent**: [SecretBase](#secretbase): The base definition of a secret type. -* **privateKeyPath**: any: Any object -* **skipHostKeyValidation**: any: Any object * **userName**: any: Any object -## SharePointOnlineListLinkedServiceTypeProperties +## GenericDatasetTypeProperties +### Properties +* **tableName**: any: Any object + +## GetMetadataActivityTypeProperties +### Properties +* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. +* **fieldList**: any[]: Fields of metadata to get from dataset. +* **formatSettings**: [FormatReadSettings](#formatreadsettings): Format read settings. +* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. + +## GitHubClientSecret +### Properties +* **byoaSecretAkvUrl**: string: Bring your own app client secret AKV URL. +* **byoaSecretName**: string: Bring your own app client secret name in AKV. + +## GlobalParameterDefinitionSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: [GlobalParameterSpecification](#globalparameterspecification) + +## GlobalParameterSpecification +### Properties +* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'Object' | 'String' | string (Required): Global Parameter type. +* **value**: any (Required): Any object + +## GoogleAdWordsLinkedServiceTypeProperties ### Properties +* **authenticationType**: 'ServiceAuthentication' | 'UserAuthentication' | string: The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. +* **clientCustomerID**: any: Any object +* **clientId**: any: Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **connectionProperties**: any: Any object +* **developerToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **email**: any: Any object * **encryptedCredential**: any: Any object -* **servicePrincipalId**: any (Required): Any object -* **servicePrincipalKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **siteUrl**: any (Required): Any object -* **tenantId**: any (Required): Any object +* **keyFilePath**: any: Any object +* **refreshToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **trustedCertPath**: any: Any object +* **useSystemTrustStore**: any: Any object -## ShopifyLinkedServiceTypeProperties +## GoogleBigQueryDatasetTypeProperties ### Properties -* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **dataset**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object + +## GoogleBigQueryLinkedServiceTypeProperties +### Properties +* **additionalProjects**: any: Any object +* **authenticationType**: 'ServiceAuthentication' | 'UserAuthentication' | string (Required): The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. +* **clientId**: any: Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **email**: any: Any object * **encryptedCredential**: any: Any object -* **host**: any (Required): Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **keyFilePath**: any: Any object +* **project**: any (Required): Any object +* **refreshToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **requestGoogleDriveScope**: any: Any object +* **trustedCertPath**: any: Any object +* **useSystemTrustStore**: any: Any object -## SmartsheetLinkedServiceTypeProperties +## GoogleCloudStorageLinkedServiceTypeProperties ### Properties -* **apiToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **accessKeyId**: any: Any object * **encryptedCredential**: any: Any object +* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **serviceUrl**: any: Any object -## SnowflakeLinkedServiceTypeProperties +## GreenplumDatasetTypeProperties ### Properties -* **connectionString**: any (Required): Any object +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object + +## GreenplumLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object * **encryptedCredential**: any: Any object -* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. +* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -## SparkLinkedServiceTypeProperties +## HBaseLinkedServiceTypeProperties ### Properties * **allowHostNameCNMismatch**: any: Any object * **allowSelfSignedServerCert**: any: Any object -* **authenticationType**: 'Anonymous' | 'Username' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication method used to access the Spark server. +* **authenticationType**: 'Anonymous' | 'Basic' | string (Required): The authentication mechanism to use to connect to the HBase server. * **enableSsl**: any: Any object * **encryptedCredential**: any: Any object * **host**: any (Required): Any object * **httpPath**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **port**: any (Required): Any object -* **serverType**: 'SharkServer' | 'SharkServer2' | 'SparkThriftServer' | string: The type of Spark server. -* **thriftTransportProtocol**: 'Binary' | 'HTTP ' | 'SASL' | string: The transport protocol to use in the Thrift layer. +* **port**: any: Any object * **trustedCertPath**: any: Any object * **username**: any: Any object -* **useSystemTrustStore**: any: Any object -## SqlServerLinkedServiceTypeProperties +## HdfsLinkedServiceTypeProperties ### Properties -* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. -* **connectionString**: any (Required): Any object +* **authenticationType**: any: Any object * **encryptedCredential**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object * **userName**: any: Any object -## SquareLinkedServiceTypeProperties +## HDInsightHiveActivityTypeProperties ### Properties -* **clientId**: any: Any object -* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. -* **connectionProperties**: any: Any object -* **encryptedCredential**: any: Any object -* **host**: any: Any object -* **redirectUri**: any: Any object -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **defines**: [HDInsightHiveActivityTypePropertiesDefines](#hdinsighthiveactivitytypepropertiesdefines): Allows user to specify defines for Hive job request. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **queryTimeout**: int: Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package) +* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **scriptPath**: any: Any object +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. +* **variables**: any[]: User specified arguments under hivevar namespace. -## SybaseLinkedServiceTypeProperties +## HDInsightHiveActivityTypePropertiesDefines ### Properties -* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. -* **database**: any (Required): Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **schema**: any: Any object -* **server**: any (Required): Any object -* **username**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -## TeamDeskLinkedServiceTypeProperties +## HDInsightLinkedServiceTypeProperties ### Properties -* **apiToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **authenticationType**: 'Basic' | 'Token' | string (Required): The authentication type to use. +* **clusterUri**: any (Required): Any object * **encryptedCredential**: any: Any object +* **fileSystem**: any: Any object +* **hcatalogLinkedServiceName**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **isEspEnabled**: any: Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **url**: any (Required): Any object * **userName**: any: Any object -## TeradataLinkedServiceTypeProperties +## HDInsightMapReduceActivityTypeProperties ### Properties -* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. -* **connectionString**: any: Any object -* **encryptedCredential**: any: Any object -* **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **server**: any: Any object -* **username**: any: Any object +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **className**: any (Required): Any object +* **defines**: [HDInsightMapReduceActivityTypePropertiesDefines](#hdinsightmapreduceactivitytypepropertiesdefines): Allows user to specify defines for the MapReduce job request. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **jarFilePath**: any (Required): Any object +* **jarLibs**: any[]: Jar libs. +* **jarLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. -## TwilioLinkedServiceTypeProperties +## HDInsightMapReduceActivityTypePropertiesDefines ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **userName**: any (Required): Any object +### Additional Properties +* **Additional Properties Type**: any -## VerticaLinkedServiceTypeProperties +## HDInsightOnDemandLinkedServiceTypeProperties ### Properties -* **connectionString**: any: Any object +* **additionalLinkedServiceNames**: [LinkedServiceReference](#linkedservicereference)[]: Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. +* **clusterNamePrefix**: any: Any object +* **clusterPassword**: [SecretBase](#secretbase): The base definition of a secret type. +* **clusterResourceGroup**: any (Required): Any object +* **clusterSize**: any (Required): Any object +* **clusterSshPassword**: [SecretBase](#secretbase): The base definition of a secret type. +* **clusterSshUserName**: any: Any object +* **clusterType**: any: Any object +* **clusterUserName**: any: Any object +* **coreConfiguration**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **dataNodeSize**: any: Any object * **encryptedCredential**: any: Any object -* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. - -## WebLinkedServiceTypeProperties -* **Discriminator**: authenticationType - -### Base Properties -* **url**: any (Required): Any object -### WebAnonymousAuthentication -#### Properties -* **authenticationType**: 'Anonymous' (Required): Type of authentication used to connect to the web table source. +* **hBaseConfiguration**: any: Any object +* **hcatalogLinkedServiceName**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **hdfsConfiguration**: any: Any object +* **headNodeSize**: any: Any object +* **hiveConfiguration**: any: Any object +* **hostSubscriptionId**: any (Required): Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **mapReduceConfiguration**: any: Any object +* **oozieConfiguration**: any: Any object +* **scriptActions**: [ScriptAction](#scriptaction)[]: 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. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **sparkVersion**: any: Any object +* **stormConfiguration**: any: Any object +* **subnetName**: any: Any object +* **tenant**: any (Required): Any object +* **timeToLive**: any (Required): Any object +* **version**: any (Required): Any object +* **virtualNetworkId**: any: Any object +* **yarnConfiguration**: any: Any object +* **zookeeperNodeSize**: any: Any object -### WebBasicAuthentication -#### Properties -* **authenticationType**: 'Basic' (Required): Type of authentication used to connect to the web table source. -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **username**: any (Required): Any object +## HDInsightPigActivityTypeProperties +### Properties +* **arguments**: any: Any object +* **defines**: [HDInsightPigActivityTypePropertiesDefines](#hdinsightpigactivitytypepropertiesdefines): Allows user to specify defines for Pig job request. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **scriptPath**: any: Any object +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. -### WebClientCertificateAuthentication -#### Properties -* **authenticationType**: 'ClientCertificate' (Required): Type of authentication used to connect to the web table source. -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **pfx**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +## HDInsightPigActivityTypePropertiesDefines +### Properties +### Additional Properties +* **Additional Properties Type**: any +## HDInsightSparkActivityTypeProperties +### Properties +* **arguments**: any[]: The user-specified arguments to HDInsightSparkActivity. +* **className**: string: The application's Java/Spark main class. +* **entryFilePath**: any (Required): Any object +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **proxyUser**: any: Any object +* **rootPath**: any (Required): Any object +* **sparkConfig**: [HDInsightSparkActivityTypePropertiesSparkConfig](#hdinsightsparkactivitytypepropertiessparkconfig): Spark configuration property. +* **sparkJobLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -## XeroLinkedServiceTypeProperties +## HDInsightSparkActivityTypePropertiesSparkConfig ### Properties -* **connectionProperties**: any: Any object -* **consumerKey**: [SecretBase](#secretbase): The base definition of a secret type. +### Additional Properties +* **Additional Properties Type**: any + +## HDInsightStreamingActivityTypeProperties +### Properties +* **arguments**: any[]: User specified arguments to HDInsightActivity. +* **combiner**: any: Any object +* **commandEnvironment**: any[]: Command line environment values. +* **defines**: [HDInsightStreamingActivityTypePropertiesDefines](#hdinsightstreamingactivitytypepropertiesdefines): Allows user to specify defines for streaming job request. +* **fileLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **filePaths**: any[] (Required): Paths to streaming job files. Can be directories. +* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. +* **input**: any (Required): Any object +* **mapper**: any (Required): Any object +* **output**: any (Required): Any object +* **reducer**: any (Required): Any object +* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. + +## HDInsightStreamingActivityTypePropertiesDefines +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## HiveDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object + +## HiveLinkedServiceTypeProperties +### Properties +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'Username' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication method used to access the Hive server. +* **enableSsl**: any: Any object * **encryptedCredential**: any: Any object -* **host**: any: Any object -* **privateKey**: [SecretBase](#secretbase): The base definition of a secret type. -* **useEncryptedEndpoints**: any: Any object -* **useHostVerification**: any: Any object -* **usePeerVerification**: any: Any object +* **host**: any (Required): Any object +* **httpPath**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **serverType**: 'HiveServer1' | 'HiveServer2' | 'HiveThriftServer' | string: The type of Hive server. +* **serviceDiscoveryMode**: any: Any object +* **thriftTransportProtocol**: 'Binary' | 'HTTP ' | 'SASL' | string: The transport protocol to use in the Thrift layer. +* **trustedCertPath**: any: Any object +* **useNativeQuery**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object +* **zooKeeperNameSpace**: any: Any object -## ZendeskLinkedServiceTypeProperties +## HttpDatasetTypeProperties ### Properties -* **apiToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **authenticationType**: 'Basic' | 'Token' | string (Required): The authentication type to use. +* **additionalHeaders**: any: Any object +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **format**: [DatasetStorageFormat](#datasetstorageformat): The format definition of a storage. +* **relativeUrl**: any: Any object +* **requestBody**: any: Any object +* **requestMethod**: any: Any object + +## HttpLinkedServiceTypeProperties +### Properties +* **authenticationType**: 'Anonymous' | 'Basic' | 'ClientCertificate' | 'Digest' | 'Windows' | string: The authentication type to be used to connect to the HTTP server. +* **authHeaders**: any: Any object +* **certThumbprint**: any: Any object +* **embeddedCertData**: any: Any object +* **enableServerCertificateValidation**: any: Any object * **encryptedCredential**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. * **url**: any (Required): Any object * **userName**: any: Any object -## ZohoLinkedServiceTypeProperties +## HubspotLinkedServiceTypeProperties ### Properties * **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. -* **connectionProperties**: any: Any object +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. * **encryptedCredential**: any: Any object -* **endpoint**: any: Any object +* **refreshToken**: [SecretBase](#secretbase): The base definition of a secret type. * **useEncryptedEndpoints**: any: Any object * **useHostVerification**: any: Any object * **usePeerVerification**: any: Any object -## ManagedVirtualNetwork +## IfConditionActivityTypeProperties ### Properties -* **alias**: string (ReadOnly): Managed Virtual Network alias. -* **vNetId**: string (ReadOnly): Managed Virtual Network ID. -### Additional Properties -* **Additional Properties Type**: any +* **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. +* **ifFalseActivities**: [Activity](#activity)[]: 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. +* **ifTrueActivities**: [Activity](#activity)[]: 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. -## ManagedPrivateEndpoint +## ImpalaDatasetTypeProperties ### Properties -* **connectionState**: [ConnectionStateProperties](#connectionstateproperties): The connection state of a managed private endpoint -* **fqdns**: string[]: Fully qualified domain names -* **groupId**: string: The groupId to which the managed private endpoint is created -* **isReserved**: bool (ReadOnly): Denotes whether the managed private endpoint is reserved -* **privateLinkResourceId**: string: The ARM resource ID of the resource to which the managed private endpoint is created -* **provisioningState**: string (ReadOnly): The managed private endpoint provisioning state -### Additional Properties -* **Additional Properties Type**: any +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -## ConnectionStateProperties +## ImpalaLinkedServiceTypeProperties ### Properties -* **actionsRequired**: string (ReadOnly): The actions required on the managed private endpoint -* **description**: string (ReadOnly): The managed private endpoint description -* **status**: string (ReadOnly): The approval status +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'SASLUsername' | 'UsernameAndPassword' | string (Required): The authentication type to use. +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object -## Pipeline +## InformixLinkedServiceTypeProperties ### Properties -* **activities**: [Activity](#activity)[]: List of activities in pipeline. -* **annotations**: any[]: List of tags that can be used for describing the Pipeline. -* **concurrency**: int: The max number of concurrent runs for the pipeline. -* **description**: string: The description of the pipeline. -* **folder**: [PipelineFolder](#pipelinefolder): The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. -* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. -* **policy**: [PipelinePolicy](#pipelinepolicy): Pipeline Policy. -* **runDimensions**: [PipelineRunDimensions](#pipelinerundimensions): Dimensions emitted by Pipeline. -* **variables**: [VariableDefinitionSpecification](#variabledefinitionspecification): Definition of variable for a Pipeline. +* **authenticationType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object -## Activity +## InformixTableDatasetTypeProperties +### Properties +* **tableName**: any: Any object + +## IntegrationRuntime * **Discriminator**: type ### Base Properties -* **dependsOn**: [ActivityDependency](#activitydependency)[]: Activity depends on condition. -* **description**: string: Activity description. -* **name**: string (Required): Activity name. -* **userProperties**: [UserProperty](#userproperty)[]: Activity user properties. -### AppendVariableActivity +* **description**: string: Integration runtime description. +### ManagedIntegrationRuntime #### Properties -* **type**: 'AppendVariable' (Required): Type of activity. -* **typeProperties**: [AppendVariableActivityTypeProperties](#appendvariableactivitytypeproperties) (Required): AppendVariable activity properties. +* **managedVirtualNetwork**: [ManagedVirtualNetworkReference](#managedvirtualnetworkreference): Managed Virtual Network reference type. +* **state**: 'AccessDenied' | 'Initial' | 'Limited' | 'NeedRegistration' | 'Offline' | 'Online' | 'Started' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The state of integration runtime. +* **type**: 'Managed' (Required): Type of integration runtime. +* **typeProperties**: [ManagedIntegrationRuntimeTypeProperties](#managedintegrationruntimetypeproperties) (Required): Managed integration runtime type properties. -### AzureDataExplorerCommandActivity +### SelfHostedIntegrationRuntime #### Properties -* **type**: 'AzureDataExplorerCommand' (Required): Type of activity. -* **typeProperties**: [AzureDataExplorerCommandActivityTypeProperties](#azuredataexplorercommandactivitytypeproperties) (Required): Azure Data Explorer command activity properties. +* **type**: 'SelfHosted' (Required): Type of integration runtime. +* **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -### AzureFunctionActivity -#### Properties -* **type**: 'AzureFunctionActivity' (Required): Type of activity. -* **typeProperties**: [AzureFunctionActivityTypeProperties](#azurefunctionactivitytypeproperties) (Required): Azure Function activity type properties. -### AzureMLBatchExecutionActivity -#### Properties -* **type**: 'AzureMLBatchExecution' (Required): Type of activity. -* **typeProperties**: [AzureMLBatchExecutionActivityTypeProperties](#azuremlbatchexecutionactivitytypeproperties) (Required): Azure ML Batch Execution activity properties. +## IntegrationRuntimeAuthKeys +### Properties +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. -### AzureMLExecutePipelineActivity -#### Properties -* **type**: 'AzureMLExecutePipeline' (Required): Type of activity. -* **typeProperties**: [AzureMLExecutePipelineActivityTypeProperties](#azuremlexecutepipelineactivitytypeproperties) (Required): Azure ML Execute Pipeline activity properties. +## IntegrationRuntimeComputeProperties +### Properties +* **dataFlowProperties**: [IntegrationRuntimeDataFlowProperties](#integrationruntimedataflowproperties): Data flow properties for managed integration runtime. +* **location**: 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 +* **maxParallelExecutionsPerNode**: int: Maximum parallel executions count per node for managed integration runtime. +* **nodeSize**: string: The node size requirement to managed integration runtime. +* **numberOfNodes**: int: The required number of nodes for managed integration runtime. +* **vNetProperties**: [IntegrationRuntimeVNetProperties](#integrationruntimevnetproperties): VNet properties for managed integration runtime. +### Additional Properties +* **Additional Properties Type**: any -### AzureMLUpdateResourceActivity -#### Properties -* **type**: 'AzureMLUpdateResource' (Required): Type of activity. -* **typeProperties**: [AzureMLUpdateResourceActivityTypeProperties](#azuremlupdateresourceactivitytypeproperties) (Required): Azure ML Update Resource activity properties. +## IntegrationRuntimeCustomerVirtualNetwork +### Properties +* **subnetId**: string: The ID of subnet to which Azure-SSIS integration runtime will join. -### CopyActivity -#### Properties -* **inputs**: [DatasetReference](#datasetreference)[]: List of inputs for the activity. -* **outputs**: [DatasetReference](#datasetreference)[]: List of outputs for the activity. -* **type**: 'Copy' (Required): Type of activity. -* **typeProperties**: [CopyActivityTypeProperties](#copyactivitytypeproperties) (Required): Copy activity properties. +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -### CustomActivity -#### Properties -* **type**: 'Custom' (Required): Type of activity. -* **typeProperties**: [CustomActivityTypeProperties](#customactivitytypeproperties) (Required): Custom activity properties. +## IntegrationRuntimeDataFlowProperties +### Properties +* **cleanup**: bool: 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. +* **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. +* **coreCount**: int: Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. +* **timeToLive**: int: Time to live (in minutes) setting of the cluster which will execute data flow job. +### Additional Properties +* **Additional Properties Type**: any -### DatabricksNotebookActivity -#### Properties -* **type**: 'DatabricksNotebook' (Required): Type of activity. -* **typeProperties**: [DatabricksNotebookActivityTypeProperties](#databricksnotebookactivitytypeproperties) (Required): Databricks Notebook activity properties. +## IntegrationRuntimeDataProxyProperties +### Properties +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. -### DatabricksSparkJarActivity -#### Properties -* **type**: 'DatabricksSparkJar' (Required): Type of activity. -* **typeProperties**: [DatabricksSparkJarActivityTypeProperties](#databrickssparkjaractivitytypeproperties) (Required): Databricks SparkJar activity properties. +## IntegrationRuntimeReference +### Properties +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **referenceName**: string (Required): Reference integration runtime name. +* **type**: 'IntegrationRuntimeReference' | string (Required): Type of integration runtime. -### DatabricksSparkPythonActivity -#### Properties -* **type**: 'DatabricksSparkPython' (Required): Type of activity. -* **typeProperties**: [DatabricksSparkPythonActivityTypeProperties](#databrickssparkpythonactivitytypeproperties) (Required): Databricks SparkPython activity properties. +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. +* **dualStandbyPairName**: string: The dual standby pair name of Azure-SSIS Integration Runtimes to support SSISDB failover. +### Additional Properties +* **Additional Properties Type**: any -### DataLakeAnalyticsUsqlActivity -#### Properties -* **type**: 'DataLakeAnalyticsU-SQL' (Required): Type of activity. -* **typeProperties**: [DataLakeAnalyticsUsqlActivityTypeProperties](#datalakeanalyticsusqlactivitytypeproperties) (Required): DataLakeAnalyticsU-SQL activity properties. +## IntegrationRuntimeSsisProperties +### Properties +* **catalogInfo**: [IntegrationRuntimeSsisCatalogInfo](#integrationruntimessiscataloginfo): Catalog information for managed dedicated integration runtime. +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **customSetupScriptProperties**: [IntegrationRuntimeCustomSetupScriptProperties](#integrationruntimecustomsetupscriptproperties): Custom setup script properties for a managed dedicated integration runtime. +* **dataProxyProperties**: [IntegrationRuntimeDataProxyProperties](#integrationruntimedataproxyproperties): Data proxy properties for a managed dedicated integration runtime. +* **edition**: 'Enterprise' | 'Standard' | string: The edition for the SSIS Integration Runtime +* **expressCustomSetupProperties**: [CustomSetupBase](#customsetupbase)[]: Custom setup without script properties for a SSIS integration runtime. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: License type for bringing your own license scenario. +* **packageStores**: [PackageStore](#packagestore)[]: Package stores for the SSIS Integration Runtime. +### Additional Properties +* **Additional Properties Type**: any -### DeleteActivity -#### Properties -* **type**: 'Delete' (Required): Type of activity. -* **typeProperties**: [DeleteActivityTypeProperties](#deleteactivitytypeproperties) (Required): Delete activity properties. +## IntegrationRuntimeVNetProperties +### Properties +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. +### Additional Properties +* **Additional Properties Type**: any -### ExecuteDataFlowActivity -#### Properties -* **type**: 'ExecuteDataFlow' (Required): Type of activity. -* **typeProperties**: [ExecuteDataFlowActivityTypeProperties](#executedataflowactivitytypeproperties) (Required): Execute data flow activity properties. +## JiraLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object -### ExecutePipelineActivity -#### Properties -* **policy**: [ExecutePipelineActivityPolicy](#executepipelineactivitypolicy): Execution policy for an execute pipeline activity. -* **type**: 'ExecutePipeline' (Required): Type of activity. -* **typeProperties**: [ExecutePipelineActivityTypeProperties](#executepipelineactivitytypeproperties) (Required): Execute pipeline activity properties. +## JsonDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **encodingName**: any: Any object +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -### ExecuteSsisPackageActivity -#### Properties -* **type**: 'ExecuteSSISPackage' (Required): Type of activity. -* **typeProperties**: [ExecuteSsisPackageActivityTypeProperties](#executessispackageactivitytypeproperties) (Required): Execute SSIS package activity properties. +## JsonReadSettings +### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **type**: string (Required): The read setting type. +### Additional Properties +* **Additional Properties Type**: any -### ExecuteWranglingDataflowActivity -#### Properties -* **policy**: [ActivityPolicy](#activitypolicy): Execution policy for an activity. -* **type**: 'ExecuteWranglingDataflow' (Required): Type of activity. -* **typeProperties**: [ExecutePowerQueryActivityTypeProperties](#executepowerqueryactivitytypeproperties) (Required): Execute power query data flow activity properties. +## JsonWriteSettings +### Properties +* **filePattern**: any: Any object +* **type**: string (Required): The write setting type. +### Additional Properties +* **Additional Properties Type**: any -### FailActivity -#### Properties -* **type**: 'Fail' (Required): Type of activity. -* **typeProperties**: [FailActivityTypeProperties](#failactivitytypeproperties) (Required): Fail activity properties. +## LicensedComponentSetupTypeProperties +### Properties +* **componentName**: string (Required): The name of the 3rd party component. +* **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -### FilterActivity -#### Properties -* **type**: 'Filter' (Required): Type of activity. -* **typeProperties**: [FilterActivityTypeProperties](#filteractivitytypeproperties) (Required): Filter activity properties. +## LinkedIntegrationRuntimeType +* **Discriminator**: authorizationType -### ForEachActivity +### Base Properties +### LinkedIntegrationRuntimeKeyAuthorization #### Properties -* **type**: 'ForEach' (Required): Type of activity. -* **typeProperties**: [ForEachActivityTypeProperties](#foreachactivitytypeproperties) (Required): ForEach activity properties. +* **authorizationType**: 'Key' (Required): The authorization type for integration runtime sharing. +* **key**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -### GetMetadataActivity +### LinkedIntegrationRuntimeRbacAuthorization #### Properties -* **type**: 'GetMetadata' (Required): Type of activity. -* **typeProperties**: [GetMetadataActivityTypeProperties](#getmetadataactivitytypeproperties) (Required): GetMetadata activity properties. +* **authorizationType**: 'RBAC' (Required): The authorization type for integration runtime sharing. +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -### HDInsightHiveActivity -#### Properties -* **type**: 'HDInsightHive' (Required): Type of activity. -* **typeProperties**: [HDInsightHiveActivityTypeProperties](#hdinsighthiveactivitytypeproperties) (Required): HDInsight Hive activity properties. -### HDInsightMapReduceActivity +## LinkedService +* **Discriminator**: type + +### Base Properties +* **annotations**: any[]: List of tags that can be used for describing the linked service. +* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. +* **description**: string: Linked service description. +* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. +### AmazonMWSLinkedService #### Properties -* **type**: 'HDInsightMapReduce' (Required): Type of activity. -* **typeProperties**: [HDInsightMapReduceActivityTypeProperties](#hdinsightmapreduceactivitytypeproperties) (Required): HDInsight MapReduce activity properties. +* **type**: 'AmazonMWS' (Required): Type of linked service. +* **typeProperties**: [AmazonMWSLinkedServiceTypeProperties](#amazonmwslinkedservicetypeproperties) (Required): Amazon Marketplace Web Service linked service properties. -### HDInsightPigActivity +### AmazonRdsForOracleLinkedService #### Properties -* **type**: 'HDInsightPig' (Required): Type of activity. -* **typeProperties**: [HDInsightPigActivityTypeProperties](#hdinsightpigactivitytypeproperties) (Required): HDInsight Pig activity properties. +* **type**: 'AmazonRdsForOracle' (Required): Type of linked service. +* **typeProperties**: [AmazonRdsForLinkedServiceTypeProperties](#amazonrdsforlinkedservicetypeproperties) (Required): AmazonRdsForOracle database linked service properties. -### HDInsightSparkActivity +### AmazonRdsForSqlServerLinkedService #### Properties -* **type**: 'HDInsightSpark' (Required): Type of activity. -* **typeProperties**: [HDInsightSparkActivityTypeProperties](#hdinsightsparkactivitytypeproperties) (Required): HDInsight spark activity properties. +* **type**: 'AmazonRdsForSqlServer' (Required): Type of linked service. +* **typeProperties**: [AmazonRdsForSqlServerLinkedServiceTypeProperties](#amazonrdsforsqlserverlinkedservicetypeproperties) (Required): Amazon Rds for SQL Server linked service properties. -### HDInsightStreamingActivity +### AmazonRedshiftLinkedService #### Properties -* **type**: 'HDInsightStreaming' (Required): Type of activity. -* **typeProperties**: [HDInsightStreamingActivityTypeProperties](#hdinsightstreamingactivitytypeproperties) (Required): HDInsight streaming activity properties. +* **type**: 'AmazonRedshift' (Required): Type of linked service. +* **typeProperties**: [AmazonRedshiftLinkedServiceTypeProperties](#amazonredshiftlinkedservicetypeproperties) (Required): Amazon Redshift linked service properties. -### IfConditionActivity +### AmazonS3LinkedService #### Properties -* **type**: 'IfCondition' (Required): Type of activity. -* **typeProperties**: [IfConditionActivityTypeProperties](#ifconditionactivitytypeproperties) (Required): IfCondition activity properties. +* **type**: 'AmazonS3' (Required): Type of linked service. +* **typeProperties**: [AmazonS3LinkedServiceTypeProperties](#amazons3linkedservicetypeproperties) (Required): Amazon S3 linked service properties. -### LookupActivity +### AmazonS3CompatibleLinkedService #### Properties -* **type**: 'Lookup' (Required): Type of activity. -* **typeProperties**: [LookupActivityTypeProperties](#lookupactivitytypeproperties) (Required): Lookup activity properties. +* **type**: 'AmazonS3Compatible' (Required): Type of linked service. +* **typeProperties**: [AmazonS3CompatibleLinkedServiceTypeProperties](#amazons3compatiblelinkedservicetypeproperties) (Required): Amazon S3 Compatible linked service properties. -### ScriptActivity +### AppFiguresLinkedService #### Properties -* **type**: 'Script' (Required): Type of activity. -* **typeProperties**: [ScriptActivityTypeProperties](#scriptactivitytypeproperties) (Required): Script activity properties. +* **type**: 'AppFigures' (Required): Type of linked service. +* **typeProperties**: [AppFiguresLinkedServiceTypeProperties](#appfigureslinkedservicetypeproperties) (Required): AppFigures linked service type properties. -### SetVariableActivity +### AsanaLinkedService #### Properties -* **type**: 'SetVariable' (Required): Type of activity. -* **typeProperties**: [SetVariableActivityTypeProperties](#setvariableactivitytypeproperties) (Required): SetVariable activity properties. +* **type**: 'Asana' (Required): Type of linked service. +* **typeProperties**: [AsanaLinkedServiceTypeProperties](#asanalinkedservicetypeproperties) (Required): Asana linked service type properties. -### SqlServerStoredProcedureActivity +### AzureBatchLinkedService #### Properties -* **type**: 'SqlServerStoredProcedure' (Required): Type of activity. -* **typeProperties**: [SqlServerStoredProcedureActivityTypeProperties](#sqlserverstoredprocedureactivitytypeproperties) (Required): SQL stored procedure activity properties. +* **type**: 'AzureBatch' (Required): Type of linked service. +* **typeProperties**: [AzureBatchLinkedServiceTypeProperties](#azurebatchlinkedservicetypeproperties) (Required): Azure Batch linked service properties. -### SwitchActivity +### AzureBlobFSLinkedService #### Properties -* **type**: 'Switch' (Required): Type of activity. -* **typeProperties**: [SwitchActivityTypeProperties](#switchactivitytypeproperties) (Required): Switch activity properties. +* **type**: 'AzureBlobFS' (Required): Type of linked service. +* **typeProperties**: [AzureBlobFSLinkedServiceTypeProperties](#azureblobfslinkedservicetypeproperties) (Required): Azure Data Lake Storage Gen2 linked service properties. -### UntilActivity +### AzureBlobStorageLinkedService #### Properties -* **type**: 'Until' (Required): Type of activity. -* **typeProperties**: [UntilActivityTypeProperties](#untilactivitytypeproperties) (Required): Until activity properties. +* **type**: 'AzureBlobStorage' (Required): Type of linked service. +* **typeProperties**: [AzureBlobStorageLinkedServiceTypeProperties](#azureblobstoragelinkedservicetypeproperties) (Required): Azure Blob Storage linked service properties. -### ValidationActivity +### AzureDatabricksLinkedService #### Properties -* **type**: 'Validation' (Required): Type of activity. -* **typeProperties**: [ValidationActivityTypeProperties](#validationactivitytypeproperties) (Required): Validation activity properties. +* **type**: 'AzureDatabricks' (Required): Type of linked service. +* **typeProperties**: [AzureDatabricksLinkedServiceTypeProperties](#azuredatabrickslinkedservicetypeproperties) (Required): Azure Databricks linked service properties. -### WaitActivity +### AzureDatabricksDeltaLakeLinkedService #### Properties -* **type**: 'Wait' (Required): Type of activity. -* **typeProperties**: [WaitActivityTypeProperties](#waitactivitytypeproperties) (Required): Wait activity properties. +* **type**: 'AzureDatabricksDeltaLake' (Required): Type of linked service. +* **typeProperties**: [AzureDatabricksDetltaLakeLinkedServiceTypeProperties](#azuredatabricksdetltalakelinkedservicetypeproperties) (Required): Azure Databricks Delta Lake linked service properties. -### WebActivity +### AzureDataExplorerLinkedService #### Properties -* **type**: 'WebActivity' (Required): Type of activity. -* **typeProperties**: [WebActivityTypeProperties](#webactivitytypeproperties) (Required): Web activity type properties. +* **type**: 'AzureDataExplorer' (Required): Type of linked service. +* **typeProperties**: [AzureDataExplorerLinkedServiceTypeProperties](#azuredataexplorerlinkedservicetypeproperties) (Required): Azure Data Explorer (Kusto) linked service properties. -### WebHookActivity +### AzureDataLakeAnalyticsLinkedService #### Properties -* **type**: 'WebHook' (Required): Type of activity. -* **typeProperties**: [WebHookActivityTypeProperties](#webhookactivitytypeproperties) (Required): WebHook activity type properties. +* **type**: 'AzureDataLakeAnalytics' (Required): Type of linked service. +* **typeProperties**: [AzureDataLakeAnalyticsLinkedServiceTypeProperties](#azuredatalakeanalyticslinkedservicetypeproperties) (Required): Azure Data Lake Analytics linked service properties. +### AzureDataLakeStoreLinkedService +#### Properties +* **type**: 'AzureDataLakeStore' (Required): Type of linked service. +* **typeProperties**: [AzureDataLakeStoreLinkedServiceTypeProperties](#azuredatalakestorelinkedservicetypeproperties) (Required): Azure Data Lake Store linked service properties. -## ActivityDependency -### Properties -* **activity**: string (Required): Activity name. -* **dependencyConditions**: 'Completed' | 'Failed' | 'Skipped' | 'Succeeded' | string[] (Required): Match-Condition for the dependency. -### Additional Properties -* **Additional Properties Type**: any +### AzureFileStorageLinkedService +#### Properties +* **type**: 'AzureFileStorage' (Required): Type of linked service. +* **typeProperties**: [AzureFileStorageLinkedServiceTypeProperties](#azurefilestoragelinkedservicetypeproperties) (Required): Azure File Storage linked service properties. -## UserProperty -### Properties -* **name**: string (Required): User property name. -* **value**: any (Required): Any object +### AzureFunctionLinkedService +#### Properties +* **type**: 'AzureFunction' (Required): Type of linked service. +* **typeProperties**: [AzureFunctionLinkedServiceTypeProperties](#azurefunctionlinkedservicetypeproperties) (Required): Azure Function linked service properties. -## AppendVariableActivityTypeProperties -### Properties -* **value**: any: Any object -* **variableName**: string: Name of the variable whose value needs to be appended to. +### AzureKeyVaultLinkedService +#### Properties +* **type**: 'AzureKeyVault' (Required): Type of linked service. +* **typeProperties**: [AzureKeyVaultLinkedServiceTypeProperties](#azurekeyvaultlinkedservicetypeproperties) (Required): Azure Key Vault linked service properties. -## AzureDataExplorerCommandActivityTypeProperties -### Properties -* **command**: any (Required): Any object -* **commandTimeout**: any: Any object +### AzureMariaDBLinkedService +#### Properties +* **type**: 'AzureMariaDB' (Required): Type of linked service. +* **typeProperties**: [AzureMariaDBLinkedServiceTypeProperties](#azuremariadblinkedservicetypeproperties) (Required): Azure Database for MariaDB linked service properties. -## AzureFunctionActivityTypeProperties -### Properties -* **body**: any: Any object -* **functionName**: any (Required): Any object -* **headers**: any: Any object -* **method**: 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'TRACE' | string (Required): The list of HTTP methods supported by a AzureFunctionActivity. +### AzureMLLinkedService +#### Properties +* **type**: 'AzureML' (Required): Type of linked service. +* **typeProperties**: [AzureMLLinkedServiceTypeProperties](#azuremllinkedservicetypeproperties) (Required): Azure ML Studio Web Service linked service properties. -## AzureMLBatchExecutionActivityTypeProperties -### Properties -* **globalParameters**: [AzureMLBatchExecutionActivityTypePropertiesGlobalParameters](#azuremlbatchexecutionactivitytypepropertiesglobalparameters): 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. -* **webServiceInputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs](#azuremlbatchexecutionactivitytypepropertieswebserviceinputs): 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. -* **webServiceOutputs**: [AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs](#azuremlbatchexecutionactivitytypepropertieswebserviceoutputs): 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. +### AzureMLServiceLinkedService +#### Properties +* **type**: 'AzureMLService' (Required): Type of linked service. +* **typeProperties**: [AzureMLServiceLinkedServiceTypeProperties](#azuremlservicelinkedservicetypeproperties) (Required): Azure ML Service linked service properties. -## AzureMLBatchExecutionActivityTypePropertiesGlobalParameters -### Properties -### Additional Properties -* **Additional Properties Type**: any +### AzureMySqlLinkedService +#### Properties +* **type**: 'AzureMySql' (Required): Type of linked service. +* **typeProperties**: [AzureMySqlLinkedServiceTypeProperties](#azuremysqllinkedservicetypeproperties) (Required): Azure MySQL database linked service properties. -## AzureMLBatchExecutionActivityTypePropertiesWebServiceInputs -### Properties -### Additional Properties -* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) +### AzurePostgreSqlLinkedService +#### Properties +* **type**: 'AzurePostgreSql' (Required): Type of linked service. +* **typeProperties**: [AzurePostgreSqlLinkedServiceTypeProperties](#azurepostgresqllinkedservicetypeproperties) (Required): Azure PostgreSQL linked service properties. -## AzureMLWebServiceFile -### Properties -* **filePath**: any (Required): Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +### AzureSearchLinkedService +#### Properties +* **type**: 'AzureSearch' (Required): Type of linked service. +* **typeProperties**: [AzureSearchLinkedServiceTypeProperties](#azuresearchlinkedservicetypeproperties) (Required): Windows Azure Search Service linked service properties. -## AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs -### Properties -### Additional Properties -* **Additional Properties Type**: [AzureMLWebServiceFile](#azuremlwebservicefile) +### AzureSqlDatabaseLinkedService +#### Properties +* **type**: 'AzureSqlDatabase' (Required): Type of linked service. +* **typeProperties**: [AzureSqlDatabaseLinkedServiceTypeProperties](#azuresqldatabaselinkedservicetypeproperties) (Required): Azure SQL Database linked service properties. -## AzureMLExecutePipelineActivityTypeProperties -### Properties -* **continueOnStepFailure**: any: Any object -* **dataPathAssignments**: any: Any object -* **experimentName**: any: Any object -* **mlParentRunId**: any: Any object -* **mlPipelineEndpointId**: any: Any object -* **mlPipelineId**: any: Any object -* **mlPipelineParameters**: any: Any object -* **version**: any: Any object +### AzureSqlDWLinkedService +#### Properties +* **type**: 'AzureSqlDW' (Required): Type of linked service. +* **typeProperties**: [AzureSqlDWLinkedServiceTypeProperties](#azuresqldwlinkedservicetypeproperties) (Required): Azure SQL Data Warehouse linked service properties. -## AzureMLUpdateResourceActivityTypeProperties -### Properties -* **trainedModelFilePath**: any (Required): Any object -* **trainedModelLinkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **trainedModelName**: any (Required): Any object +### AzureSqlMILinkedService +#### Properties +* **type**: 'AzureSqlMI' (Required): Type of linked service. +* **typeProperties**: [AzureSqlMILinkedServiceTypeProperties](#azuresqlmilinkedservicetypeproperties) (Required): Azure SQL Managed Instance linked service properties. -## CopyActivityTypeProperties -### Properties -* **dataIntegrationUnits**: any: Any object -* **enableSkipIncompatibleRow**: any: Any object -* **enableStaging**: any: Any object -* **logSettings**: [LogSettings](#logsettings): Log settings. -* **logStorageSettings**: [LogStorageSettings](#logstoragesettings): (Deprecated. Please use LogSettings) Log storage settings. -* **parallelCopies**: any: Any object -* **preserve**: any[]: Preserve rules. -* **preserveRules**: any[]: Preserve Rules. -* **redirectIncompatibleRowSettings**: [RedirectIncompatibleRowSettings](#redirectincompatiblerowsettings): Redirect incompatible row settings -* **sink**: [CopySink](#copysink) (Required): A copy activity sink. -* **skipErrorFile**: [SkipErrorFile](#skiperrorfile): Skip error file. -* **source**: [CopySource](#copysource) (Required): A copy activity source. -* **stagingSettings**: [StagingSettings](#stagingsettings): Staging settings. -* **translator**: any: Any object -* **validateDataConsistency**: any: Any object +### AzureStorageLinkedService +#### Properties +* **type**: 'AzureStorage' (Required): Type of linked service. +* **typeProperties**: [AzureStorageLinkedServiceTypeProperties](#azurestoragelinkedservicetypeproperties) (Required): Azure Storage linked service properties. -## LogSettings -### Properties -* **copyActivityLogSettings**: [CopyActivityLogSettings](#copyactivitylogsettings): Settings for copy activity log. -* **enableCopyActivityLog**: any: Any object -* **logLocationSettings**: [LogLocationSettings](#loglocationsettings) (Required): Log location settings. +### AzureTableStorageLinkedService +#### Properties +* **type**: 'AzureTableStorage' (Required): Type of linked service. +* **typeProperties**: [AzureStorageLinkedServiceTypeProperties](#azurestoragelinkedservicetypeproperties) (Required): Azure Storage linked service properties. -## CopyActivityLogSettings -### Properties -* **enableReliableLogging**: any: Any object -* **logLevel**: any: Any object +### CassandraLinkedService +#### Properties +* **type**: 'Cassandra' (Required): Type of linked service. +* **typeProperties**: [CassandraLinkedServiceTypeProperties](#cassandralinkedservicetypeproperties) (Required): Cassandra linked service properties. -## LogLocationSettings -### Properties -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **path**: any: Any object +### CommonDataServiceForAppsLinkedService +#### Properties +* **type**: 'CommonDataServiceForApps' (Required): Type of linked service. +* **typeProperties**: [CommonDataServiceForAppsLinkedServiceTypeProperties](#commondataserviceforappslinkedservicetypeproperties) (Required): Common Data Service for Apps linked service properties. -## LogStorageSettings -### Properties -* **enableReliableLogging**: any: Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **logLevel**: any: Any object -* **path**: any: Any object -### Additional Properties -* **Additional Properties Type**: any +### ConcurLinkedService +#### Properties +* **type**: 'Concur' (Required): Type of linked service. +* **typeProperties**: [ConcurLinkedServiceTypeProperties](#concurlinkedservicetypeproperties) (Required): Concur Service linked service properties. -## RedirectIncompatibleRowSettings -### Properties -* **linkedServiceName**: any (Required): Any object -* **path**: any: Any object -### Additional Properties -* **Additional Properties Type**: any +### CosmosDbLinkedService +#### Properties +* **type**: 'CosmosDb' (Required): Type of linked service. +* **typeProperties**: [CosmosDbLinkedServiceTypeProperties](#cosmosdblinkedservicetypeproperties) (Required): CosmosDB linked service properties. -## CopySink -* **Discriminator**: type +### CosmosDbMongoDbApiLinkedService +#### Properties +* **type**: 'CosmosDbMongoDbApi' (Required): Type of linked service. +* **typeProperties**: [CosmosDbMongoDbApiLinkedServiceTypeProperties](#cosmosdbmongodbapilinkedservicetypeproperties) (Required): CosmosDB (MongoDB API) linked service properties. -### Base Properties -* **disableMetricsCollection**: any: Any object -* **maxConcurrentConnections**: any: Any object -* **sinkRetryCount**: any: Any object -* **sinkRetryWait**: any: Any object -* **writeBatchSize**: any: Any object -* **writeBatchTimeout**: any: Any object -### AvroSink +### CouchbaseLinkedService #### Properties -* **formatSettings**: [AvroWriteSettings](#avrowritesettings): Avro write settings. -* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. -* **type**: 'AvroSink' (Required): Copy sink type. +* **type**: 'Couchbase' (Required): Type of linked service. +* **typeProperties**: [CouchbaseLinkedServiceTypeProperties](#couchbaselinkedservicetypeproperties) (Required): Couchbase server linked service properties. -### AzureBlobFSSink +### CustomDataSourceLinkedService #### Properties -* **copyBehavior**: any: Any object -* **metadata**: [MetadataItem](#metadataitem)[]: Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). -* **type**: 'AzureBlobFSSink' (Required): Copy sink type. +* **type**: 'CustomDataSource' (Required): Type of linked service. +* **typeProperties**: any (Required): Any object -### AzureDatabricksDeltaLakeSink +### DataworldLinkedService #### Properties -* **importSettings**: [AzureDatabricksDeltaLakeImportCommand](#azuredatabricksdeltalakeimportcommand): Azure Databricks Delta Lake import command settings. -* **preCopyScript**: any: Any object -* **type**: 'AzureDatabricksDeltaLakeSink' (Required): Copy sink type. +* **type**: 'Dataworld' (Required): Type of linked service. +* **typeProperties**: [DataworldLinkedServiceTypeProperties](#dataworldlinkedservicetypeproperties) (Required): Dataworld linked service type properties. -### AzureDataExplorerSink +### Db2LinkedService #### Properties -* **flushImmediately**: any: Any object -* **ingestionMappingAsJson**: any: Any object -* **ingestionMappingName**: any: Any object -* **type**: 'AzureDataExplorerSink' (Required): Copy sink type. +* **type**: 'Db2' (Required): Type of linked service. +* **typeProperties**: [Db2LinkedServiceTypeProperties](#db2linkedservicetypeproperties) (Required): DB2 linked service properties. -### AzureDataLakeStoreSink +### DrillLinkedService #### Properties -* **copyBehavior**: any: Any object -* **enableAdlsSingleFileParallel**: any: Any object -* **type**: 'AzureDataLakeStoreSink' (Required): Copy sink type. +* **type**: 'Drill' (Required): Type of linked service. +* **typeProperties**: [DrillLinkedServiceTypeProperties](#drilllinkedservicetypeproperties) (Required): Drill server linked service properties. -### AzureMySqlSink +### DynamicsLinkedService #### Properties -* **preCopyScript**: any: Any object -* **type**: 'AzureMySqlSink' (Required): Copy sink type. +* **type**: 'Dynamics' (Required): Type of linked service. +* **typeProperties**: [DynamicsLinkedServiceTypeProperties](#dynamicslinkedservicetypeproperties) (Required): Dynamics linked service properties. -### AzurePostgreSqlSink +### DynamicsAXLinkedService #### Properties -* **preCopyScript**: any: Any object -* **type**: 'AzurePostgreSqlSink' (Required): Copy sink type. +* **type**: 'DynamicsAX' (Required): Type of linked service. +* **typeProperties**: [DynamicsAXLinkedServiceTypeProperties](#dynamicsaxlinkedservicetypeproperties) (Required): Dynamics AX linked service properties. -### AzureQueueSink +### DynamicsCrmLinkedService #### Properties -* **type**: 'AzureQueueSink' (Required): Copy sink type. +* **type**: 'DynamicsCrm' (Required): Type of linked service. +* **typeProperties**: [DynamicsCrmLinkedServiceTypeProperties](#dynamicscrmlinkedservicetypeproperties) (Required): Dynamics CRM linked service properties. -### AzureSearchIndexSink +### EloquaLinkedService #### Properties -* **type**: 'AzureSearchIndexSink' (Required): Copy sink type. -* **writeBehavior**: 'Merge' | 'Upload' | string: Specify the write behavior when upserting documents into Azure Search Index. +* **type**: 'Eloqua' (Required): Type of linked service. +* **typeProperties**: [EloquaLinkedServiceTypeProperties](#eloqualinkedservicetypeproperties) (Required): Eloqua server linked service properties. -### AzureSqlSink +### FileServerLinkedService #### Properties -* **preCopyScript**: any: Any object -* **sqlWriterStoredProcedureName**: any: Any object -* **sqlWriterTableType**: any: Any object -* **sqlWriterUseTableLock**: any: Any object -* **storedProcedureParameters**: [AzureSqlSinkStoredProcedureParameters](#azuresqlsinkstoredprocedureparameters): SQL stored procedure parameters. -* **storedProcedureTableTypeParameterName**: any: Any object -* **tableOption**: any: Any object -* **type**: 'AzureSqlSink' (Required): Copy sink type. -* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings -* **writeBehavior**: any: Any object +* **type**: 'FileServer' (Required): Type of linked service. +* **typeProperties**: [FileServerLinkedServiceTypeProperties](#fileserverlinkedservicetypeproperties) (Required): File system linked service properties. -### AzureTableSink +### FtpServerLinkedService #### Properties -* **azureTableDefaultPartitionKeyValue**: any: Any object -* **azureTableInsertType**: any: Any object -* **azureTablePartitionKeyName**: any: Any object -* **azureTableRowKeyName**: any: Any object -* **type**: 'AzureTableSink' (Required): Copy sink type. +* **type**: 'FtpServer' (Required): Type of linked service. +* **typeProperties**: [FtpServerLinkedServiceTypeProperties](#ftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. -### BinarySink +### GoogleAdWordsLinkedService #### Properties -* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. -* **type**: 'BinarySink' (Required): Copy sink type. +* **type**: 'GoogleAdWords' (Required): Type of linked service. +* **typeProperties**: [GoogleAdWordsLinkedServiceTypeProperties](#googleadwordslinkedservicetypeproperties) (Required): Google AdWords service linked service properties. -### BlobSink +### GoogleBigQueryLinkedService #### Properties -* **blobWriterAddHeader**: any: Any object -* **blobWriterDateTimeFormat**: any: Any object -* **blobWriterOverwriteFiles**: any: Any object -* **copyBehavior**: any: Any object -* **metadata**: [MetadataItem](#metadataitem)[]: Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). -* **type**: 'BlobSink' (Required): Copy sink type. +* **type**: 'GoogleBigQuery' (Required): Type of linked service. +* **typeProperties**: [GoogleBigQueryLinkedServiceTypeProperties](#googlebigquerylinkedservicetypeproperties) (Required): Google BigQuery service linked service properties. -### CommonDataServiceForAppsSink +### GoogleCloudStorageLinkedService #### Properties -* **alternateKeyName**: any: Any object -* **ignoreNullValues**: any: Any object -* **type**: 'CommonDataServiceForAppsSink' (Required): Copy sink type. -* **writeBehavior**: 'Upsert' | string (Required): Defines values for DynamicsSinkWriteBehavior. +* **type**: 'GoogleCloudStorage' (Required): Type of linked service. +* **typeProperties**: [GoogleCloudStorageLinkedServiceTypeProperties](#googlecloudstoragelinkedservicetypeproperties) (Required): Google Cloud Storage linked service properties. -### CosmosDbMongoDbApiSink +### GreenplumLinkedService #### Properties -* **type**: 'CosmosDbMongoDbApiSink' (Required): Copy sink type. -* **writeBehavior**: any: Any object +* **type**: 'Greenplum' (Required): Type of linked service. +* **typeProperties**: [GreenplumLinkedServiceTypeProperties](#greenplumlinkedservicetypeproperties) (Required): Greenplum Database linked service properties. -### CosmosDbSqlApiSink +### HBaseLinkedService #### Properties -* **type**: 'CosmosDbSqlApiSink' (Required): Copy sink type. -* **writeBehavior**: any: Any object +* **type**: 'HBase' (Required): Type of linked service. +* **typeProperties**: [HBaseLinkedServiceTypeProperties](#hbaselinkedservicetypeproperties) (Required): HBase server linked service properties. -### DelimitedTextSink +### HdfsLinkedService #### Properties -* **formatSettings**: [DelimitedTextWriteSettings](#delimitedtextwritesettings): Delimited text write settings. -* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. -* **type**: 'DelimitedTextSink' (Required): Copy sink type. +* **type**: 'Hdfs' (Required): Type of linked service. +* **typeProperties**: [HdfsLinkedServiceTypeProperties](#hdfslinkedservicetypeproperties) (Required): HDFS linked service properties. -### DocumentDbCollectionSink +### HDInsightLinkedService #### Properties -* **nestingSeparator**: any: Any object -* **type**: 'DocumentDbCollectionSink' (Required): Copy sink type. -* **writeBehavior**: any: Any object +* **type**: 'HDInsight' (Required): Type of linked service. +* **typeProperties**: [HDInsightLinkedServiceTypeProperties](#hdinsightlinkedservicetypeproperties) (Required): HDInsight linked service properties. -### DynamicsCrmSink +### HDInsightOnDemandLinkedService #### Properties -* **alternateKeyName**: any: Any object -* **ignoreNullValues**: any: Any object -* **type**: 'DynamicsCrmSink' (Required): Copy sink type. -* **writeBehavior**: 'Upsert' | string (Required): Defines values for DynamicsSinkWriteBehavior. +* **type**: 'HDInsightOnDemand' (Required): Type of linked service. +* **typeProperties**: [HDInsightOnDemandLinkedServiceTypeProperties](#hdinsightondemandlinkedservicetypeproperties) (Required): HDInsight ondemand linked service properties. -### DynamicsSink +### HiveLinkedService #### Properties -* **alternateKeyName**: any: Any object -* **ignoreNullValues**: any: Any object -* **type**: 'DynamicsSink' (Required): Copy sink type. -* **writeBehavior**: 'Upsert' | string (Required): Defines values for DynamicsSinkWriteBehavior. +* **type**: 'Hive' (Required): Type of linked service. +* **typeProperties**: [HiveLinkedServiceTypeProperties](#hivelinkedservicetypeproperties) (Required): Hive Server linked service properties. -### FileSystemSink +### HttpLinkedService #### Properties -* **copyBehavior**: any: Any object -* **type**: 'FileSystemSink' (Required): Copy sink type. +* **type**: 'HttpServer' (Required): Type of linked service. +* **typeProperties**: [HttpLinkedServiceTypeProperties](#httplinkedservicetypeproperties) (Required): Properties specific to this linked service type. -### InformixSink +### HubspotLinkedService #### Properties -* **preCopyScript**: any: Any object -* **type**: 'InformixSink' (Required): Copy sink type. +* **type**: 'Hubspot' (Required): Type of linked service. +* **typeProperties**: [HubspotLinkedServiceTypeProperties](#hubspotlinkedservicetypeproperties) (Required): Hubspot Service linked service properties. -### JsonSink +### ImpalaLinkedService #### Properties -* **formatSettings**: [JsonWriteSettings](#jsonwritesettings): Json write settings. -* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. -* **type**: 'JsonSink' (Required): Copy sink type. +* **type**: 'Impala' (Required): Type of linked service. +* **typeProperties**: [ImpalaLinkedServiceTypeProperties](#impalalinkedservicetypeproperties) (Required): Impala server linked service properties. -### MicrosoftAccessSink +### InformixLinkedService #### Properties -* **preCopyScript**: any: Any object -* **type**: 'MicrosoftAccessSink' (Required): Copy sink type. +* **type**: 'Informix' (Required): Type of linked service. +* **typeProperties**: [InformixLinkedServiceTypeProperties](#informixlinkedservicetypeproperties) (Required): Informix linked service properties. -### MongoDbAtlasSink +### JiraLinkedService #### Properties -* **type**: 'MongoDbAtlasSink' (Required): Copy sink type. -* **writeBehavior**: any: Any object +* **type**: 'Jira' (Required): Type of linked service. +* **typeProperties**: [JiraLinkedServiceTypeProperties](#jiralinkedservicetypeproperties) (Required): Jira Service linked service properties. -### MongoDbV2Sink +### MagentoLinkedService #### Properties -* **type**: 'MongoDbV2Sink' (Required): Copy sink type. -* **writeBehavior**: any: Any object +* **type**: 'Magento' (Required): Type of linked service. +* **typeProperties**: [MagentoLinkedServiceTypeProperties](#magentolinkedservicetypeproperties) (Required): Magento server linked service properties. -### OdbcSink +### MariaDBLinkedService #### Properties -* **preCopyScript**: any: Any object -* **type**: 'OdbcSink' (Required): Copy sink type. +* **type**: 'MariaDB' (Required): Type of linked service. +* **typeProperties**: [MariaDBLinkedServiceTypeProperties](#mariadblinkedservicetypeproperties) (Required): MariaDB server linked service properties. -### OracleSink +### MarketoLinkedService #### Properties -* **preCopyScript**: any: Any object -* **type**: 'OracleSink' (Required): Copy sink type. +* **type**: 'Marketo' (Required): Type of linked service. +* **typeProperties**: [MarketoLinkedServiceTypeProperties](#marketolinkedservicetypeproperties) (Required): Marketo server linked service properties. -### OrcSink +### MicrosoftAccessLinkedService #### Properties -* **formatSettings**: [OrcWriteSettings](#orcwritesettings): Orc write settings. -* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. -* **type**: 'OrcSink' (Required): Copy sink type. +* **type**: 'MicrosoftAccess' (Required): Type of linked service. +* **typeProperties**: [MicrosoftAccessLinkedServiceTypeProperties](#microsoftaccesslinkedservicetypeproperties) (Required): Microsoft Access linked service properties. -### ParquetSink +### MongoDbLinkedService #### Properties -* **formatSettings**: [ParquetWriteSettings](#parquetwritesettings): Parquet write settings. -* **storeSettings**: [StoreWriteSettings](#storewritesettings): Connector write settings. -* **type**: 'ParquetSink' (Required): Copy sink type. +* **type**: 'MongoDb' (Required): Type of linked service. +* **typeProperties**: [MongoDbLinkedServiceTypeProperties](#mongodblinkedservicetypeproperties) (Required): MongoDB linked service properties. -### RestSink +### MongoDbAtlasLinkedService #### Properties -* **additionalHeaders**: any: Any object -* **httpCompressionType**: any: Any object -* **httpRequestTimeout**: any: Any object -* **requestInterval**: any: Any object -* **requestMethod**: any: Any object -* **type**: 'RestSink' (Required): Copy sink type. +* **type**: 'MongoDbAtlas' (Required): Type of linked service. +* **typeProperties**: [MongoDbAtlasLinkedServiceTypeProperties](#mongodbatlaslinkedservicetypeproperties) (Required): MongoDB Atlas linked service properties. -### SalesforceServiceCloudSink +### MongoDbV2LinkedService #### Properties -* **externalIdFieldName**: any: Any object -* **ignoreNullValues**: any: Any object -* **type**: 'SalesforceServiceCloudSink' (Required): Copy sink type. -* **writeBehavior**: 'Insert' | 'Upsert' | string: The write behavior for the operation. Default is Insert. +* **type**: 'MongoDbV2' (Required): Type of linked service. +* **typeProperties**: [MongoDbV2LinkedServiceTypeProperties](#mongodbv2linkedservicetypeproperties) (Required): MongoDB linked service properties. -### SalesforceSink +### MySqlLinkedService #### Properties -* **externalIdFieldName**: any: Any object -* **ignoreNullValues**: any: Any object -* **type**: 'SalesforceSink' (Required): Copy sink type. -* **writeBehavior**: 'Insert' | 'Upsert' | string: The write behavior for the operation. Default is Insert. +* **type**: 'MySql' (Required): Type of linked service. +* **typeProperties**: [MySqlLinkedServiceTypeProperties](#mysqllinkedservicetypeproperties) (Required): MySQL linked service properties. -### SapCloudForCustomerSink +### NetezzaLinkedService #### Properties -* **httpRequestTimeout**: any: Any object -* **type**: 'SapCloudForCustomerSink' (Required): Copy sink type. -* **writeBehavior**: 'Insert' | 'Update' | string: The write behavior for the operation. Default is 'Insert'. +* **type**: 'Netezza' (Required): Type of linked service. +* **typeProperties**: [NetezzaLinkedServiceTypeProperties](#netezzalinkedservicetypeproperties) (Required): Netezza linked service properties. -### SnowflakeSink +### ODataLinkedService #### Properties -* **importSettings**: [SnowflakeImportCopyCommand](#snowflakeimportcopycommand): Snowflake import command settings. -* **preCopyScript**: any: Any object -* **type**: 'SnowflakeSink' (Required): Copy sink type. +* **type**: 'OData' (Required): Type of linked service. +* **typeProperties**: [ODataLinkedServiceTypeProperties](#odatalinkedservicetypeproperties) (Required): OData linked service properties. -### SqlDWSink +### OdbcLinkedService #### Properties -* **allowCopyCommand**: any: Any object -* **allowPolyBase**: any: Any object -* **copyCommandSettings**: [DWCopyCommandSettings](#dwcopycommandsettings): DW Copy Command settings. -* **polyBaseSettings**: [PolybaseSettings](#polybasesettings): PolyBase settings. -* **preCopyScript**: any: Any object -* **sqlWriterUseTableLock**: any: Any object -* **tableOption**: any: Any object -* **type**: 'SqlDWSink' (Required): Copy sink type. -* **upsertSettings**: [SqlDWUpsertSettings](#sqldwupsertsettings): Sql DW upsert option settings -* **writeBehavior**: any: Any object +* **type**: 'Odbc' (Required): Type of linked service. +* **typeProperties**: [OdbcLinkedServiceTypeProperties](#odbclinkedservicetypeproperties) (Required): ODBC linked service properties. -### SqlMISink +### Office365LinkedService #### Properties -* **preCopyScript**: any: Any object -* **sqlWriterStoredProcedureName**: any: Any object -* **sqlWriterTableType**: any: Any object -* **sqlWriterUseTableLock**: any: Any object -* **storedProcedureParameters**: [SqlMISinkStoredProcedureParameters](#sqlmisinkstoredprocedureparameters): SQL stored procedure parameters. -* **storedProcedureTableTypeParameterName**: any: Any object -* **tableOption**: any: Any object -* **type**: 'SqlMISink' (Required): Copy sink type. -* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings -* **writeBehavior**: any: Any object +* **type**: 'Office365' (Required): Type of linked service. +* **typeProperties**: [Office365LinkedServiceTypeProperties](#office365linkedservicetypeproperties) (Required): Office365 linked service properties. -### SqlServerSink +### OracleLinkedService #### Properties -* **preCopyScript**: any: Any object -* **sqlWriterStoredProcedureName**: any: Any object -* **sqlWriterTableType**: any: Any object -* **sqlWriterUseTableLock**: any: Any object -* **storedProcedureParameters**: [SqlServerSinkStoredProcedureParameters](#sqlserversinkstoredprocedureparameters): SQL stored procedure parameters. -* **storedProcedureTableTypeParameterName**: any: Any object -* **tableOption**: any: Any object -* **type**: 'SqlServerSink' (Required): Copy sink type. -* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings -* **writeBehavior**: any: Any object +* **type**: 'Oracle' (Required): Type of linked service. +* **typeProperties**: [OracleLinkedServiceTypeProperties](#oraclelinkedservicetypeproperties) (Required): Oracle database linked service properties. -### SqlSink +### OracleCloudStorageLinkedService #### Properties -* **preCopyScript**: any: Any object -* **sqlWriterStoredProcedureName**: any: Any object -* **sqlWriterTableType**: any: Any object -* **sqlWriterUseTableLock**: any: Any object -* **storedProcedureParameters**: [SqlSinkStoredProcedureParameters](#sqlsinkstoredprocedureparameters): SQL stored procedure parameters. -* **storedProcedureTableTypeParameterName**: any: Any object -* **tableOption**: any: Any object -* **type**: 'SqlSink' (Required): Copy sink type. -* **upsertSettings**: [SqlUpsertSettings](#sqlupsertsettings): Sql upsert option settings -* **writeBehavior**: any: Any object - +* **type**: 'OracleCloudStorage' (Required): Type of linked service. +* **typeProperties**: [OracleCloudStorageLinkedServiceTypeProperties](#oraclecloudstoragelinkedservicetypeproperties) (Required): Oracle Cloud Storage linked service properties. -## AvroWriteSettings -### Properties -* **fileNamePrefix**: any: Any object -* **maxRowsPerFile**: any: Any object -* **recordName**: string: Top level record name in write result, which is required in AVRO spec. -* **recordNamespace**: string: Record namespace in the write result. -* **type**: string (Required): The write setting type. -### Additional Properties -* **Additional Properties Type**: any +### OracleServiceCloudLinkedService +#### Properties +* **type**: 'OracleServiceCloud' (Required): Type of linked service. +* **typeProperties**: [OracleServiceCloudLinkedServiceTypeProperties](#oracleservicecloudlinkedservicetypeproperties) (Required): Oracle Service Cloud linked service properties. -## StoreWriteSettings -* **Discriminator**: type - -### Base Properties -* **copyBehavior**: any: Any object -* **disableMetricsCollection**: any: Any object -* **maxConcurrentConnections**: any: Any object -### AzureBlobFSWriteSettings +### PaypalLinkedService #### Properties -* **blockSizeInMB**: any: Any object -* **type**: 'AzureBlobFSWriteSettings' (Required): The write setting type. +* **type**: 'Paypal' (Required): Type of linked service. +* **typeProperties**: [PaypalLinkedServiceTypeProperties](#paypallinkedservicetypeproperties) (Required): Paypal Service linked service properties. -### AzureBlobStorageWriteSettings +### PhoenixLinkedService #### Properties -* **blockSizeInMB**: any: Any object -* **type**: 'AzureBlobStorageWriteSettings' (Required): The write setting type. +* **type**: 'Phoenix' (Required): Type of linked service. +* **typeProperties**: [PhoenixLinkedServiceTypeProperties](#phoenixlinkedservicetypeproperties) (Required): Phoenix server linked service properties. -### AzureDataLakeStoreWriteSettings +### PostgreSqlLinkedService #### Properties -* **expiryDateTime**: any: Any object -* **type**: 'AzureDataLakeStoreWriteSettings' (Required): The write setting type. +* **type**: 'PostgreSql' (Required): Type of linked service. +* **typeProperties**: [PostgreSqlLinkedServiceTypeProperties](#postgresqllinkedservicetypeproperties) (Required): PostgreSQL linked service properties. -### AzureFileStorageWriteSettings +### PrestoLinkedService #### Properties -* **type**: 'AzureFileStorageWriteSettings' (Required): The write setting type. +* **type**: 'Presto' (Required): Type of linked service. +* **typeProperties**: [PrestoLinkedServiceTypeProperties](#prestolinkedservicetypeproperties) (Required): Presto server linked service properties. -### FileServerWriteSettings +### QuickbaseLinkedService #### Properties -* **type**: 'FileServerWriteSettings' (Required): The write setting type. +* **type**: 'Quickbase' (Required): Type of linked service. +* **typeProperties**: [QuickbaseLinkedServiceTypeProperties](#quickbaselinkedservicetypeproperties) (Required): Quickbase linked service type properties. -### SftpWriteSettings +### QuickBooksLinkedService #### Properties -* **operationTimeout**: any: Any object -* **type**: 'SftpWriteSettings' (Required): The write setting type. -* **useTempFileRename**: any: Any object +* **type**: 'QuickBooks' (Required): Type of linked service. +* **typeProperties**: [QuickBooksLinkedServiceTypeProperties](#quickbookslinkedservicetypeproperties) (Required): QuickBooks server linked service properties. +### ResponsysLinkedService +#### Properties +* **type**: 'Responsys' (Required): Type of linked service. +* **typeProperties**: [ResponsysLinkedServiceTypeProperties](#responsyslinkedservicetypeproperties) (Required): Responsys linked service properties. -## MetadataItem -### Properties -* **name**: any: Any object -* **value**: any: Any object +### RestServiceLinkedService +#### Properties +* **type**: 'RestService' (Required): Type of linked service. +* **typeProperties**: [RestServiceLinkedServiceTypeProperties](#restservicelinkedservicetypeproperties) (Required): Rest Service linked service properties. -## AzureDatabricksDeltaLakeImportCommand -### Properties -* **dateFormat**: any: Any object -* **timestampFormat**: any: Any object -* **type**: string (Required): The import setting type. -### Additional Properties -* **Additional Properties Type**: any +### SalesforceLinkedService +#### Properties +* **type**: 'Salesforce' (Required): Type of linked service. +* **typeProperties**: [SalesforceLinkedServiceTypeProperties](#salesforcelinkedservicetypeproperties) (Required): Salesforce linked service properties. -## AzureSqlSinkStoredProcedureParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +### SalesforceMarketingCloudLinkedService +#### Properties +* **type**: 'SalesforceMarketingCloud' (Required): Type of linked service. +* **typeProperties**: [SalesforceMarketingCloudLinkedServiceTypeProperties](#salesforcemarketingcloudlinkedservicetypeproperties) (Required): Salesforce Marketing Cloud linked service properties. -## StoredProcedureParameter -### Properties -* **type**: 'Boolean' | 'Date' | 'Decimal' | 'Guid' | 'Int' | 'Int64' | 'String' | string: Stored procedure parameter type. -* **value**: any: Any object +### SalesforceServiceCloudLinkedService +#### Properties +* **type**: 'SalesforceServiceCloud' (Required): Type of linked service. +* **typeProperties**: [SalesforceServiceCloudLinkedServiceTypeProperties](#salesforceservicecloudlinkedservicetypeproperties) (Required): Salesforce Service Cloud linked service properties. -## SqlUpsertSettings -### Properties -* **interimSchemaName**: any: Any object -* **keys**: any: Any object -* **useTempDB**: any: Any object +### SapBWLinkedService +#### Properties +* **type**: 'SapBW' (Required): Type of linked service. +* **typeProperties**: [SapBWLinkedServiceTypeProperties](#sapbwlinkedservicetypeproperties) (Required): Properties specific to this linked service type. -## DelimitedTextWriteSettings -### Properties -* **fileExtension**: any (Required): Any object -* **fileNamePrefix**: any: Any object -* **maxRowsPerFile**: any: Any object -* **quoteAllText**: any: Any object -* **type**: string (Required): The write setting type. -### Additional Properties -* **Additional Properties Type**: any +### SapCloudForCustomerLinkedService +#### Properties +* **type**: 'SapCloudForCustomer' (Required): Type of linked service. +* **typeProperties**: [SapCloudForCustomerLinkedServiceTypeProperties](#sapcloudforcustomerlinkedservicetypeproperties) (Required): SAP Cloud for Customer linked service properties. -## JsonWriteSettings -### Properties -* **filePattern**: any: Any object -* **type**: string (Required): The write setting type. -### Additional Properties -* **Additional Properties Type**: any +### SapEccLinkedService +#### Properties +* **type**: 'SapEcc' (Required): Type of linked service. +* **typeProperties**: [SapEccLinkedServiceTypeProperties](#sapecclinkedservicetypeproperties) (Required): SAP ECC linked service properties. -## OrcWriteSettings -### Properties -* **fileNamePrefix**: any: Any object -* **maxRowsPerFile**: any: Any object -* **type**: string (Required): The write setting type. -### Additional Properties -* **Additional Properties Type**: any +### SapHanaLinkedService +#### Properties +* **type**: 'SapHana' (Required): Type of linked service. +* **typeProperties**: [SapHanaLinkedServiceProperties](#saphanalinkedserviceproperties) (Required): Properties specific to this linked service type. -## ParquetWriteSettings -### Properties -* **fileNamePrefix**: any: Any object -* **maxRowsPerFile**: any: Any object -* **type**: string (Required): The write setting type. -### Additional Properties -* **Additional Properties Type**: any +### SapOpenHubLinkedService +#### Properties +* **type**: 'SapOpenHub' (Required): Type of linked service. +* **typeProperties**: [SapOpenHubLinkedServiceTypeProperties](#sapopenhublinkedservicetypeproperties) (Required): Properties specific to SAP Business Warehouse Open Hub Destination linked service type. -## SnowflakeImportCopyCommand -### Properties -* **additionalCopyOptions**: [SnowflakeImportCopyCommandAdditionalCopyOptions](#snowflakeimportcopycommandadditionalcopyoptions): 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'" } -* **additionalFormatOptions**: [SnowflakeImportCopyCommandAdditionalFormatOptions](#snowflakeimportcopycommandadditionalformatoptions): 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'" } -* **type**: string (Required): The import setting type. -### Additional Properties -* **Additional Properties Type**: any +### SapTableLinkedService +#### Properties +* **type**: 'SapTable' (Required): Type of linked service. +* **typeProperties**: [SapTableLinkedServiceTypeProperties](#saptablelinkedservicetypeproperties) (Required): Properties specific to this linked service type. -## SnowflakeImportCopyCommandAdditionalCopyOptions -### Properties -### Additional Properties -* **Additional Properties Type**: any +### ServiceNowLinkedService +#### Properties +* **type**: 'ServiceNow' (Required): Type of linked service. +* **typeProperties**: [ServiceNowLinkedServiceTypeProperties](#servicenowlinkedservicetypeproperties) (Required): ServiceNow server linked service properties. -## SnowflakeImportCopyCommandAdditionalFormatOptions -### Properties -### Additional Properties -* **Additional Properties Type**: any +### SftpServerLinkedService +#### Properties +* **type**: 'Sftp' (Required): Type of linked service. +* **typeProperties**: [SftpServerLinkedServiceTypeProperties](#sftpserverlinkedservicetypeproperties) (Required): Properties specific to this linked service type. -## DWCopyCommandSettings -### Properties -* **additionalOptions**: [DWCopyCommandSettingsAdditionalOptions](#dwcopycommandsettingsadditionaloptions): 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'" } -* **defaultValues**: [DWCopyCommandDefaultValue](#dwcopycommanddefaultvalue)[]: 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). +### SharePointOnlineListLinkedService +#### Properties +* **type**: 'SharePointOnlineList' (Required): Type of linked service. +* **typeProperties**: [SharePointOnlineListLinkedServiceTypeProperties](#sharepointonlinelistlinkedservicetypeproperties) (Required): SharePoint Online List linked service properties. -## DWCopyCommandSettingsAdditionalOptions -### Properties -### Additional Properties -* **Additional Properties Type**: string +### ShopifyLinkedService +#### Properties +* **type**: 'Shopify' (Required): Type of linked service. +* **typeProperties**: [ShopifyLinkedServiceTypeProperties](#shopifylinkedservicetypeproperties) (Required): Shopify Service linked service properties. -## DWCopyCommandDefaultValue -### Properties -* **columnName**: any: Any object -* **defaultValue**: any: Any object +### SmartsheetLinkedService +#### Properties +* **type**: 'Smartsheet' (Required): Type of linked service. +* **typeProperties**: [SmartsheetLinkedServiceTypeProperties](#smartsheetlinkedservicetypeproperties) (Required): Smartsheet linked service type properties. -## PolybaseSettings -### Properties -* **rejectSampleValue**: any: Any object -* **rejectType**: 'percentage' | 'value' | string: Indicates whether the RejectValue property is specified as a literal value or a percentage. -* **rejectValue**: any: Any object -* **useTypeDefault**: any: Any object -### Additional Properties -* **Additional Properties Type**: any +### SnowflakeLinkedService +#### Properties +* **type**: 'Snowflake' (Required): Type of linked service. +* **typeProperties**: [SnowflakeLinkedServiceTypeProperties](#snowflakelinkedservicetypeproperties) (Required): Snowflake linked service properties. -## SqlDWUpsertSettings -### Properties -* **interimSchemaName**: any: Any object -* **keys**: any: Any object +### SparkLinkedService +#### Properties +* **type**: 'Spark' (Required): Type of linked service. +* **typeProperties**: [SparkLinkedServiceTypeProperties](#sparklinkedservicetypeproperties) (Required): Spark Server linked service properties. -## SqlMISinkStoredProcedureParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +### SqlServerLinkedService +#### Properties +* **type**: 'SqlServer' (Required): Type of linked service. +* **typeProperties**: [SqlServerLinkedServiceTypeProperties](#sqlserverlinkedservicetypeproperties) (Required): SQL Server linked service properties. -## SqlServerSinkStoredProcedureParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +### SquareLinkedService +#### Properties +* **type**: 'Square' (Required): Type of linked service. +* **typeProperties**: [SquareLinkedServiceTypeProperties](#squarelinkedservicetypeproperties) (Required): Square Service linked service properties. -## SqlSinkStoredProcedureParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +### SybaseLinkedService +#### Properties +* **type**: 'Sybase' (Required): Type of linked service. +* **typeProperties**: [SybaseLinkedServiceTypeProperties](#sybaselinkedservicetypeproperties) (Required): Sybase linked service properties. -## SkipErrorFile -### Properties -* **dataInconsistency**: any: Any object -* **fileMissing**: any: Any object +### TeamDeskLinkedService +#### Properties +* **type**: 'TeamDesk' (Required): Type of linked service. +* **typeProperties**: [TeamDeskLinkedServiceTypeProperties](#teamdesklinkedservicetypeproperties) (Required): TeamDesk linked service type properties. -## CopySource -* **Discriminator**: type +### TeradataLinkedService +#### Properties +* **type**: 'Teradata' (Required): Type of linked service. +* **typeProperties**: [TeradataLinkedServiceTypeProperties](#teradatalinkedservicetypeproperties) (Required): Teradata linked service properties. -### Base Properties -* **disableMetricsCollection**: any: Any object -* **maxConcurrentConnections**: any: Any object -* **sourceRetryCount**: any: Any object -* **sourceRetryWait**: any: Any object -### AmazonMWSSource +### TwilioLinkedService #### Properties -* **query**: any: Any object -* **type**: 'AmazonMWSSource' (Required): Copy source type. +* **type**: 'Twilio' (Required): Type of linked service. +* **typeProperties**: [TwilioLinkedServiceTypeProperties](#twiliolinkedservicetypeproperties) (Required): Twilio linked service type properties. -### AmazonRdsForOracleSource +### VerticaLinkedService #### Properties -* **additionalColumns**: any: Any object -* **oracleReaderQuery**: any: Any object -* **partitionOption**: any: Any object -* **partitionSettings**: [AmazonRdsForOraclePartitionSettings](#amazonrdsfororaclepartitionsettings): The settings that will be leveraged for AmazonRdsForOracle source partitioning. -* **queryTimeout**: any: Any object -* **type**: 'AmazonRdsForOracleSource' (Required): Copy source type. +* **type**: 'Vertica' (Required): Type of linked service. +* **typeProperties**: [VerticaLinkedServiceTypeProperties](#verticalinkedservicetypeproperties) (Required): Vertica linked service properties. -### AmazonRdsForSqlServerSource +### WebLinkedService #### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. -* **produceAdditionalTypes**: any: Any object -* **sqlReaderQuery**: any: Any object -* **sqlReaderStoredProcedureName**: any: Any object -* **storedProcedureParameters**: [AmazonRdsForSqlServerSourceStoredProcedureParameters](#amazonrdsforsqlserversourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". -* **type**: 'AmazonRdsForSqlServerSource' (Required): Copy source type. +* **type**: 'Web' (Required): Type of linked service. +* **typeProperties**: [WebLinkedServiceTypeProperties](#weblinkedservicetypeproperties) (Required): Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models. -### AmazonRedshiftSource +### XeroLinkedService #### Properties -* **query**: any: Any object -* **redshiftUnloadSettings**: [RedshiftUnloadSettings](#redshiftunloadsettings): 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. -* **type**: 'AmazonRedshiftSource' (Required): Copy source type. +* **type**: 'Xero' (Required): Type of linked service. +* **typeProperties**: [XeroLinkedServiceTypeProperties](#xerolinkedservicetypeproperties) (Required): Xero Service linked service properties. -### AvroSource +### ZendeskLinkedService #### Properties -* **additionalColumns**: any: Any object -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'AvroSource' (Required): Copy source type. +* **type**: 'Zendesk' (Required): Type of linked service. +* **typeProperties**: [ZendeskLinkedServiceTypeProperties](#zendesklinkedservicetypeproperties) (Required): Zendesk linked service type properties. -### AzureBlobFSSource +### ZohoLinkedService #### Properties -* **recursive**: any: Any object -* **skipHeaderLineCount**: any: Any object -* **treatEmptyAsNull**: any: Any object -* **type**: 'AzureBlobFSSource' (Required): Copy source type. +* **type**: 'Zoho' (Required): Type of linked service. +* **typeProperties**: [ZohoLinkedServiceTypeProperties](#zoholinkedservicetypeproperties) (Required): Zoho server linked service properties. -### AzureDatabricksDeltaLakeSource -#### Properties -* **exportSettings**: [AzureDatabricksDeltaLakeExportCommand](#azuredatabricksdeltalakeexportcommand): Azure Databricks Delta Lake export command settings. -* **query**: any: Any object -* **type**: 'AzureDatabricksDeltaLakeSource' (Required): Copy source type. -### AzureDataExplorerSource -#### Properties -* **additionalColumns**: any: Any object -* **noTruncation**: any: Any object -* **query**: any (Required): Any object -* **queryTimeout**: any: Any object -* **type**: 'AzureDataExplorerSource' (Required): Copy source type. +## LinkedServiceReference +### Properties +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **referenceName**: string (Required): Reference LinkedService name. +* **type**: 'LinkedServiceReference' | string (Required): Linked service reference type. -### AzureDataLakeStoreSource -#### Properties -* **recursive**: any: Any object -* **type**: 'AzureDataLakeStoreSource' (Required): Copy source type. +## LogLocationSettings +### Properties +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **path**: any: Any object -### AzureMariaDBSource -#### Properties -* **query**: any: Any object -* **type**: 'AzureMariaDBSource' (Required): Copy source type. +## LogSettings +### Properties +* **copyActivityLogSettings**: [CopyActivityLogSettings](#copyactivitylogsettings): Settings for copy activity log. +* **enableCopyActivityLog**: any: Any object +* **logLocationSettings**: [LogLocationSettings](#loglocationsettings) (Required): Log location settings. -### AzureMySqlSource -#### Properties -* **query**: any: Any object -* **type**: 'AzureMySqlSource' (Required): Copy source type. +## LogStorageSettings +### Properties +* **enableReliableLogging**: any: Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **logLevel**: any: Any object +* **path**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -### AzurePostgreSqlSource -#### Properties -* **query**: any: Any object -* **type**: 'AzurePostgreSqlSource' (Required): Copy source type. +## LookupActivityTypeProperties +### Properties +* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. +* **firstRowOnly**: any: Any object +* **source**: [CopySource](#copysource) (Required): A copy activity source. -### AzureSqlSource -#### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. -* **produceAdditionalTypes**: any: Any object -* **sqlReaderQuery**: any: Any object -* **sqlReaderStoredProcedureName**: any: Any object -* **storedProcedureParameters**: [AzureSqlSourceStoredProcedureParameters](#azuresqlsourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". -* **type**: 'AzureSqlSource' (Required): Copy source type. +## MagentoLinkedServiceTypeProperties +### Properties +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### AzureTableSource -#### Properties -* **azureTableSourceIgnoreTableNotFound**: any: Any object -* **azureTableSourceQuery**: any: Any object -* **type**: 'AzureTableSource' (Required): Copy source type. +## ManagedIntegrationRuntimeTypeProperties +### Properties +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **customerVirtualNetwork**: [IntegrationRuntimeCustomerVirtualNetwork](#integrationruntimecustomervirtualnetwork): The definition and properties of virtual network to which Azure-SSIS integration runtime will join. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. -### BinarySource -#### Properties -* **formatSettings**: [BinaryReadSettings](#binaryreadsettings): Binary read settings. -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'BinarySource' (Required): Copy source type. +## ManagedPrivateEndpoint +### Properties +* **connectionState**: [ConnectionStateProperties](#connectionstateproperties): The connection state of a managed private endpoint +* **fqdns**: string[]: Fully qualified domain names +* **groupId**: string: The groupId to which the managed private endpoint is created +* **isReserved**: bool (ReadOnly): Denotes whether the managed private endpoint is reserved +* **privateLinkResourceId**: string: The ARM resource ID of the resource to which the managed private endpoint is created +* **provisioningState**: string (ReadOnly): The managed private endpoint provisioning state +### Additional Properties +* **Additional Properties Type**: any -### BlobSource -#### Properties -* **recursive**: any: Any object -* **skipHeaderLineCount**: any: Any object -* **treatEmptyAsNull**: any: Any object -* **type**: 'BlobSource' (Required): Copy source type. +## ManagedVirtualNetwork +### Properties +* **alias**: string (ReadOnly): Managed Virtual Network alias. +* **vNetId**: string (ReadOnly): Managed Virtual Network ID. +### Additional Properties +* **Additional Properties Type**: any -### CassandraSource -#### Properties -* **consistencyLevel**: 'ALL' | 'EACH_QUORUM' | 'LOCAL_ONE' | 'LOCAL_QUORUM' | 'LOCAL_SERIAL' | 'ONE' | 'QUORUM' | 'SERIAL' | 'THREE' | 'TWO' | string: 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. -* **query**: any: Any object -* **type**: 'CassandraSource' (Required): Copy source type. +## ManagedVirtualNetworkReference +### Properties +* **referenceName**: string (Required): Reference ManagedVirtualNetwork name. +* **type**: 'ManagedVirtualNetworkReference' | string (Required): Managed Virtual Network reference type. -### CommonDataServiceForAppsSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **type**: 'CommonDataServiceForAppsSource' (Required): Copy source type. +## MappingDataFlowTypeProperties +### Properties +* **script**: string: DataFlow script. +* **scriptLines**: string[]: Data flow script lines. +* **sinks**: [DataFlowSink](#dataflowsink)[]: List of sinks in data flow. +* **sources**: [DataFlowSource](#dataflowsource)[]: List of sources in data flow. +* **transformations**: [Transformation](#transformation)[]: List of transformations in data flow. -### ConcurSource -#### Properties -* **query**: any: Any object -* **type**: 'ConcurSource' (Required): Copy source type. +## MariaDBLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### CosmosDbMongoDbApiSource -#### Properties -* **additionalColumns**: any: Any object -* **batchSize**: any: Any object -* **cursorMethods**: [MongoDbCursorMethodsProperties](#mongodbcursormethodsproperties): Cursor methods for Mongodb query -* **filter**: any: Any object -* **queryTimeout**: any: Any object -* **type**: 'CosmosDbMongoDbApiSource' (Required): Copy source type. +## MarketoLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### CosmosDbSqlApiSource -#### Properties -* **additionalColumns**: any: Any object -* **detectDatetime**: any: Any object -* **pageSize**: any: Any object -* **preferredRegions**: any: Any object -* **query**: any: Any object -* **type**: 'CosmosDbSqlApiSource' (Required): Copy source type. +## MetadataItem +### Properties +* **name**: any: Any object +* **value**: any: Any object -### CouchbaseSource -#### Properties -* **query**: any: Any object -* **type**: 'CouchbaseSource' (Required): Copy source type. +## MicrosoftAccessLinkedServiceTypeProperties +### Properties +* **authenticationType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object -### Db2Source -#### Properties -* **query**: any: Any object -* **type**: 'Db2Source' (Required): Copy source type. +## MicrosoftAccessTableDatasetTypeProperties +### Properties +* **tableName**: any: Any object -### DelimitedTextSource -#### Properties -* **additionalColumns**: any: Any object -* **formatSettings**: [DelimitedTextReadSettings](#delimitedtextreadsettings): Delimited text read settings. -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'DelimitedTextSource' (Required): Copy source type. +## MongoDbAtlasCollectionDatasetTypeProperties +### Properties +* **collection**: any (Required): Any object -### DocumentDbCollectionSource -#### Properties -* **additionalColumns**: any: Any object -* **nestingSeparator**: any: Any object -* **query**: any: Any object -* **queryTimeout**: any: Any object -* **type**: 'DocumentDbCollectionSource' (Required): Copy source type. +## MongoDbAtlasLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **database**: any (Required): Any object -### DrillSource -#### Properties -* **query**: any: Any object -* **type**: 'DrillSource' (Required): Copy source type. +## MongoDbCollectionDatasetTypeProperties +### Properties +* **collectionName**: any (Required): Any object -### DynamicsAXSource -#### Properties -* **httpRequestTimeout**: any: Any object -* **query**: any: Any object -* **type**: 'DynamicsAXSource' (Required): Copy source type. +## MongoDbCursorMethodsProperties +### Properties +* **limit**: any: Any object +* **project**: any: Any object +* **skip**: any: Any object +* **sort**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -### DynamicsCrmSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **type**: 'DynamicsCrmSource' (Required): Copy source type. +## MongoDbLinkedServiceTypeProperties +### Properties +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'Basic' | string: The authentication type to be used to connect to the MongoDB database. +* **authSource**: any: Any object +* **databaseName**: any (Required): Any object +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **server**: any (Required): Any object +* **username**: any: Any object -### DynamicsSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **type**: 'DynamicsSource' (Required): Copy source type. +## MongoDbV2CollectionDatasetTypeProperties +### Properties +* **collection**: any (Required): Any object -### EloquaSource -#### Properties -* **query**: any: Any object -* **type**: 'EloquaSource' (Required): Copy source type. +## MongoDbV2LinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **database**: any (Required): Any object -### ExcelSource -#### Properties -* **additionalColumns**: any: Any object -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'ExcelSource' (Required): Copy source type. +## MySqlLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### FileSystemSource -#### Properties -* **additionalColumns**: any: Any object -* **recursive**: any: Any object -* **type**: 'FileSystemSource' (Required): Copy source type. +## MySqlTableDatasetTypeProperties +### Properties +* **tableName**: any: Any object -### GoogleAdWordsSource -#### Properties -* **query**: any: Any object -* **type**: 'GoogleAdWordsSource' (Required): Copy source type. +## NetezzaLinkedServiceTypeProperties +### Properties +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### GoogleBigQuerySource -#### Properties -* **query**: any: Any object -* **type**: 'GoogleBigQuerySource' (Required): Copy source type. +## NetezzaPartitionSettings +### Properties +* **partitionColumnName**: any: Any object +* **partitionLowerBound**: any: Any object +* **partitionUpperBound**: any: Any object -### GreenplumSource -#### Properties -* **query**: any: Any object -* **type**: 'GreenplumSource' (Required): Copy source type. +## NetezzaTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### HBaseSource -#### Properties -* **query**: any: Any object -* **type**: 'HBaseSource' (Required): Copy source type. +## ODataLinkedServiceTypeProperties +### Properties +* **aadResourceId**: any: Any object +* **aadServicePrincipalCredentialType**: 'ServicePrincipalCert' | 'ServicePrincipalKey' | string: Specify the credential type (key or cert) is used for service principal. +* **authenticationType**: 'AadServicePrincipal' | 'Anonymous' | 'Basic' | 'ManagedServiceIdentity' | 'Windows' | string: Type of authentication used to connect to the OData service. +* **authHeaders**: any: Any object +* **azureCloudType**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalEmbeddedCert**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalEmbeddedCertPassword**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object +* **url**: any (Required): Any object +* **userName**: any: Any object -### HdfsSource -#### Properties -* **distcpSettings**: [DistcpSettings](#distcpsettings): Distcp settings. -* **recursive**: any: Any object -* **type**: 'HdfsSource' (Required): Copy source type. +## ODataResourceDatasetTypeProperties +### Properties +* **path**: any: Any object -### HiveSource -#### Properties -* **query**: any: Any object -* **type**: 'HiveSource' (Required): Copy source type. +## OdbcLinkedServiceTypeProperties +### Properties +* **authenticationType**: any: Any object +* **connectionString**: any (Required): Any object +* **credential**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object -### HttpSource -#### Properties -* **httpRequestTimeout**: any: Any object -* **type**: 'HttpSource' (Required): Copy source type. +## OdbcTableDatasetTypeProperties +### Properties +* **tableName**: any: Any object -### HubspotSource -#### Properties -* **query**: any: Any object -* **type**: 'HubspotSource' (Required): Copy source type. +## Office365DatasetTypeProperties +### Properties +* **predicate**: any: Any object +* **tableName**: any (Required): Any object -### ImpalaSource -#### Properties -* **query**: any: Any object -* **type**: 'ImpalaSource' (Required): Copy source type. +## Office365LinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **office365TenantId**: any (Required): Any object +* **servicePrincipalId**: any (Required): Any object +* **servicePrincipalKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **servicePrincipalTenantId**: any (Required): Any object -### InformixSource -#### Properties -* **query**: any: Any object -* **type**: 'InformixSource' (Required): Copy source type. +## OracleCloudStorageLinkedServiceTypeProperties +### Properties +* **accessKeyId**: any: Any object +* **encryptedCredential**: any: Any object +* **secretAccessKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **serviceUrl**: any: Any object -### JiraSource -#### Properties -* **query**: any: Any object -* **type**: 'JiraSource' (Required): Copy source type. +## OracleLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### JsonSource -#### Properties -* **additionalColumns**: any: Any object -* **formatSettings**: [JsonReadSettings](#jsonreadsettings): Json read settings. -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'JsonSource' (Required): Copy source type. +## OraclePartitionSettings +### Properties +* **partitionColumnName**: any: Any object +* **partitionLowerBound**: any: Any object +* **partitionNames**: any: Any object +* **partitionUpperBound**: any: Any object -### MagentoSource -#### Properties -* **query**: any: Any object -* **type**: 'MagentoSource' (Required): Copy source type. +## OracleServiceCloudLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any (Required): Any object -### MariaDBSource -#### Properties -* **query**: any: Any object -* **type**: 'MariaDBSource' (Required): Copy source type. +## OracleTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### MarketoSource -#### Properties -* **query**: any: Any object -* **type**: 'MarketoSource' (Required): Copy source type. +## OrcDatasetTypeProperties +### Properties +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +* **orcCompressionCodec**: any: Any object -### MicrosoftAccessSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **type**: 'MicrosoftAccessSource' (Required): Copy source type. +## OrcWriteSettings +### Properties +* **fileNamePrefix**: any: Any object +* **maxRowsPerFile**: any: Any object +* **type**: string (Required): The write setting type. +### Additional Properties +* **Additional Properties Type**: any -### MongoDbAtlasSource -#### Properties -* **additionalColumns**: any: Any object -* **batchSize**: any: Any object -* **cursorMethods**: [MongoDbCursorMethodsProperties](#mongodbcursormethodsproperties): Cursor methods for Mongodb query -* **filter**: any: Any object -* **queryTimeout**: any: Any object -* **type**: 'MongoDbAtlasSource' (Required): Copy source type. +## PackageStore +### Properties +* **name**: string (Required): The name of the package store +* **packageStoreLinkedService**: [EntityReference](#entityreference) (Required): The entity reference. -### MongoDbSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **type**: 'MongoDbSource' (Required): Copy source type. +## ParameterDefinitionSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) -### MongoDbV2Source -#### Properties -* **additionalColumns**: any: Any object -* **batchSize**: any: Any object -* **cursorMethods**: [MongoDbCursorMethodsProperties](#mongodbcursormethodsproperties): Cursor methods for Mongodb query -* **filter**: any: Any object -* **queryTimeout**: any: Any object -* **type**: 'MongoDbV2Source' (Required): Copy source type. +## ParameterDefinitionSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) -### MySqlSource -#### Properties -* **query**: any: Any object -* **type**: 'MySqlSource' (Required): Copy source type. +## ParameterDefinitionSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) -### NetezzaSource -#### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [NetezzaPartitionSettings](#netezzapartitionsettings): The settings that will be leveraged for Netezza source partitioning. -* **query**: any: Any object -* **type**: 'NetezzaSource' (Required): Copy source type. +## ParameterSpecification +### Properties +* **defaultValue**: any: Any object +* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'Object' | 'SecureString' | 'String' | string (Required): Parameter type. -### ODataSource -#### Properties -* **additionalColumns**: any: Any object -* **httpRequestTimeout**: any: Any object -* **query**: any: Any object -* **type**: 'ODataSource' (Required): Copy source type. +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -### OdbcSource -#### Properties -* **query**: any: Any object -* **type**: 'OdbcSource' (Required): Copy source type. +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -### Office365Source -#### Properties -* **allowedGroups**: any: Any object -* **dateFilterColumn**: any: Any object -* **endTime**: any: Any object -* **outputColumns**: any: Any object -* **startTime**: any: Any object -* **type**: 'Office365Source' (Required): Copy source type. -* **userScopeFilterUri**: any: Any object +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -### OracleServiceCloudSource -#### Properties -* **query**: any: Any object -* **type**: 'OracleServiceCloudSource' (Required): Copy source type. +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -### OracleSource -#### Properties -* **additionalColumns**: any: Any object -* **oracleReaderQuery**: any: Any object -* **partitionOption**: any: Any object -* **partitionSettings**: [OraclePartitionSettings](#oraclepartitionsettings): The settings that will be leveraged for Oracle source partitioning. -* **queryTimeout**: any: Any object -* **type**: 'OracleSource' (Required): Copy source type. +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -### OrcSource -#### Properties -* **additionalColumns**: any: Any object -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'OrcSource' (Required): Copy source type. +## ParameterValueSpecification +### Properties +### Additional Properties +* **Additional Properties Type**: any -### ParquetSource -#### Properties -* **additionalColumns**: any: Any object -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'ParquetSource' (Required): Copy source type. +## ParquetDatasetTypeProperties +### Properties +* **compressionCodec**: any: Any object +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. -### PaypalSource -#### Properties -* **query**: any: Any object -* **type**: 'PaypalSource' (Required): Copy source type. +## ParquetWriteSettings +### Properties +* **fileNamePrefix**: any: Any object +* **maxRowsPerFile**: any: Any object +* **type**: string (Required): The write setting type. +### Additional Properties +* **Additional Properties Type**: any -### PhoenixSource -#### Properties -* **query**: any: Any object -* **type**: 'PhoenixSource' (Required): Copy source type. +## PaypalLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### PostgreSqlSource -#### Properties -* **query**: any: Any object -* **type**: 'PostgreSqlSource' (Required): Copy source type. +## PhoenixDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### PrestoSource -#### Properties -* **query**: any: Any object -* **type**: 'PrestoSource' (Required): Copy source type. +## PhoenixLinkedServiceTypeProperties +### Properties +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication mechanism used to connect to the Phoenix server. +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **httpPath**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object -### QuickBooksSource -#### Properties -* **query**: any: Any object -* **type**: 'QuickBooksSource' (Required): Copy source type. +## Pipeline +### Properties +* **activities**: [Activity](#activity)[]: List of activities in pipeline. +* **annotations**: any[]: List of tags that can be used for describing the Pipeline. +* **concurrency**: int: The max number of concurrent runs for the pipeline. +* **description**: string: The description of the pipeline. +* **folder**: [PipelineFolder](#pipelinefolder): The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. +* **parameters**: [ParameterDefinitionSpecification](#parameterdefinitionspecification): Definition of all parameters for an entity. +* **policy**: [PipelinePolicy](#pipelinepolicy): Pipeline Policy. +* **runDimensions**: [PipelineRunDimensions](#pipelinerundimensions): Dimensions emitted by Pipeline. +* **variables**: [VariableDefinitionSpecification](#variabledefinitionspecification): Definition of variable for a Pipeline. -### RelationalSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **type**: 'RelationalSource' (Required): Copy source type. +## PipelineElapsedTimeMetricPolicy +### Properties +* **duration**: any: Any object -### ResponsysSource -#### Properties -* **query**: any: Any object -* **type**: 'ResponsysSource' (Required): Copy source type. +## PipelineFolder +### Properties +* **name**: string: The name of the folder that this Pipeline is in. -### RestSource -#### Properties -* **additionalColumns**: any: Any object -* **additionalHeaders**: any: Any object -* **httpRequestTimeout**: any: Any object -* **paginationRules**: any: Any object -* **requestBody**: any: Any object -* **requestInterval**: any: Any object -* **requestMethod**: any: Any object -* **type**: 'RestSource' (Required): Copy source type. +## PipelinePolicy +### Properties +* **elapsedTimeMetric**: [PipelineElapsedTimeMetricPolicy](#pipelineelapsedtimemetricpolicy): Pipeline ElapsedTime Metric Policy. -### SalesforceMarketingCloudSource -#### Properties -* **query**: any: Any object -* **type**: 'SalesforceMarketingCloudSource' (Required): Copy source type. +## PipelineReference +### Properties +* **name**: string: Reference name. +* **referenceName**: string (Required): Reference pipeline name. +* **type**: 'PipelineReference' | string (Required): Pipeline reference type. -### SalesforceServiceCloudSource -#### Properties -* **additionalColumns**: any: Any object -* **query**: any: Any object -* **readBehavior**: 'Query' | 'QueryAll' | string: The read behavior for the operation. Default is Query. -* **type**: 'SalesforceServiceCloudSource' (Required): Copy source type. +## PipelineRunDimensions +### Properties +### Additional Properties +* **Additional Properties Type**: any -### SalesforceSource -#### Properties -* **query**: any: Any object -* **readBehavior**: 'Query' | 'QueryAll' | string: The read behavior for the operation. Default is Query. -* **type**: 'SalesforceSource' (Required): Copy source type. +## PolybaseSettings +### Properties +* **rejectSampleValue**: any: Any object +* **rejectType**: 'percentage' | 'value' | string: Indicates whether the RejectValue property is specified as a literal value or a percentage. +* **rejectValue**: any: Any object +* **useTypeDefault**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -### SapBwSource -#### Properties -* **query**: any: Any object -* **type**: 'SapBwSource' (Required): Copy source type. +## PostgreSqlLinkedServiceTypeProperties +### Properties +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -### SapCloudForCustomerSource -#### Properties -* **httpRequestTimeout**: any: Any object -* **query**: any: Any object -* **type**: 'SapCloudForCustomerSource' (Required): Copy source type. +## PostgreSqlTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### SapEccSource -#### Properties -* **httpRequestTimeout**: any: Any object -* **query**: any: Any object -* **type**: 'SapEccSource' (Required): Copy source type. +## PowerQuerySink +### Properties +* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. +* **description**: string: Transformation description. +* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. +* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **name**: string (Required): Transformation name. +* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **script**: string: sink script. -### SapHanaSource -#### Properties -* **packetSize**: any: Any object -* **partitionOption**: any: Any object -* **partitionSettings**: [SapHanaPartitionSettings](#saphanapartitionsettings): The settings that will be leveraged for SAP HANA source partitioning. -* **query**: any: Any object -* **type**: 'SapHanaSource' (Required): Copy source type. - -### SapOpenHubSource -#### Properties -* **baseRequestId**: any: Any object -* **customRfcReadTableFunctionModule**: any: Any object -* **excludeLastRequest**: any: Any object -* **sapDataColumnDelimiter**: any: Any object -* **type**: 'SapOpenHubSource' (Required): Copy source type. - -### SapTableSource -#### Properties -* **batchSize**: any: Any object -* **customRfcReadTableFunctionModule**: any: Any object -* **partitionOption**: any: Any object -* **partitionSettings**: [SapTablePartitionSettings](#saptablepartitionsettings): The settings that will be leveraged for SAP table source partitioning. -* **rfcTableFields**: any: Any object -* **rfcTableOptions**: any: Any object -* **rowCount**: any: Any object -* **rowSkips**: any: Any object -* **sapDataColumnDelimiter**: any: Any object -* **type**: 'SapTableSource' (Required): Copy source type. - -### ServiceNowSource -#### Properties -* **query**: any: Any object -* **type**: 'ServiceNowSource' (Required): Copy source type. - -### SharePointOnlineListSource -#### Properties -* **httpRequestTimeout**: any: Any object -* **query**: any: Any object -* **type**: 'SharePointOnlineListSource' (Required): Copy source type. - -### ShopifySource -#### Properties -* **query**: any: Any object -* **type**: 'ShopifySource' (Required): Copy source type. - -### SnowflakeSource -#### Properties -* **exportSettings**: [SnowflakeExportCopyCommand](#snowflakeexportcopycommand): Snowflake export command settings. -* **query**: any: Any object -* **type**: 'SnowflakeSource' (Required): Copy source type. - -### SparkSource -#### Properties -* **query**: any: Any object -* **type**: 'SparkSource' (Required): Copy source type. - -### SqlDWSource -#### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. -* **sqlReaderQuery**: any: Any object -* **sqlReaderStoredProcedureName**: any: Any object -* **storedProcedureParameters**: any: Any object -* **type**: 'SqlDWSource' (Required): Copy source type. - -### SqlMISource -#### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. -* **produceAdditionalTypes**: any: Any object -* **sqlReaderQuery**: any: Any object -* **sqlReaderStoredProcedureName**: any: Any object -* **storedProcedureParameters**: [SqlMISourceStoredProcedureParameters](#sqlmisourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". -* **type**: 'SqlMISource' (Required): Copy source type. - -### SqlServerSource -#### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. -* **produceAdditionalTypes**: any: Any object -* **sqlReaderQuery**: any: Any object -* **sqlReaderStoredProcedureName**: any: Any object -* **storedProcedureParameters**: [SqlServerSourceStoredProcedureParameters](#sqlserversourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". -* **type**: 'SqlServerSource' (Required): Copy source type. - -### SqlSource -#### Properties -* **isolationLevel**: any: Any object -* **partitionOption**: any: Any object -* **partitionSettings**: [SqlPartitionSettings](#sqlpartitionsettings): The settings that will be leveraged for Sql source partitioning. -* **sqlReaderQuery**: any: Any object -* **sqlReaderStoredProcedureName**: any: Any object -* **storedProcedureParameters**: [SqlSourceStoredProcedureParameters](#sqlsourcestoredprocedureparameters): Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". -* **type**: 'SqlSource' (Required): Copy source type. +## PowerQuerySinkMapping +### Properties +* **dataflowSinks**: [PowerQuerySink](#powerquerysink)[]: List of sinks mapped to Power Query mashup query. +* **queryName**: string: Name of the query in Power Query mashup document. -### SquareSource -#### Properties -* **query**: any: Any object -* **type**: 'SquareSource' (Required): Copy source type. +## PowerQuerySource +### Properties +* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. +* **description**: string: Transformation description. +* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. +* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **name**: string (Required): Transformation name. +* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **script**: string: source script. -### SybaseSource -#### Properties -* **query**: any: Any object -* **type**: 'SybaseSource' (Required): Copy source type. +## PowerQueryTypeProperties +### Properties +* **documentLocale**: string: Locale of the Power query mashup document. +* **script**: string: Power query mashup script. +* **sources**: [PowerQuerySource](#powerquerysource)[]: List of sources in Power Query. -### TeradataSource -#### Properties -* **partitionOption**: any: Any object -* **partitionSettings**: [TeradataPartitionSettings](#teradatapartitionsettings): The settings that will be leveraged for teradata source partitioning. -* **query**: any: Any object -* **type**: 'TeradataSource' (Required): Copy source type. +## PrestoDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -### VerticaSource -#### Properties -* **query**: any: Any object -* **type**: 'VerticaSource' (Required): Copy source type. +## PrestoLinkedServiceTypeProperties +### Properties +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'LDAP' | string (Required): The authentication mechanism used to connect to the Presto server. +* **catalog**: any (Required): Any object +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **serverVersion**: any (Required): Any object +* **timeZoneID**: any: Any object +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object -### WebSource -#### Properties -* **additionalColumns**: any: Any object -* **type**: 'WebSource' (Required): Copy source type. +## PrivateEndpoint +### Properties +* **id**: string: The resource Id for private endpoint -### XeroSource -#### Properties -* **query**: any: Any object -* **type**: 'XeroSource' (Required): Copy source type. +## PrivateLinkConnectionApprovalRequest +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -### XmlSource -#### Properties -* **additionalColumns**: any: Any object -* **formatSettings**: [XmlReadSettings](#xmlreadsettings): Xml read settings. -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -* **type**: 'XmlSource' (Required): Copy source type. +## PrivateLinkConnectionState +### Properties +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -### ZohoSource -#### Properties -* **query**: any: Any object -* **type**: 'ZohoSource' (Required): Copy source type. +## QuickbaseLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **url**: any (Required): Any object +* **userToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +## QuickBooksLinkedServiceTypeProperties +### Properties +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **accessTokenSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **companyId**: any: Any object +* **connectionProperties**: any: Any object +* **consumerKey**: any: Any object +* **consumerSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any: Any object +* **useEncryptedEndpoints**: any: Any object -## AmazonRdsForOraclePartitionSettings +## RecurrenceSchedule ### Properties -* **partitionColumnName**: any: Any object -* **partitionLowerBound**: any: Any object -* **partitionNames**: any: Any object -* **partitionUpperBound**: any: Any object +* **hours**: int[]: The hours. +* **minutes**: int[]: The minutes. +* **monthDays**: int[]: The month days. +* **monthlyOccurrences**: [RecurrenceScheduleOccurrence](#recurrencescheduleoccurrence)[]: The monthly occurrences. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The days of the week. +### Additional Properties +* **Additional Properties Type**: any -## SqlPartitionSettings +## RecurrenceScheduleOccurrence ### Properties -* **partitionColumnName**: any: Any object -* **partitionLowerBound**: any: Any object -* **partitionUpperBound**: any: Any object +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': The days of the week. +* **occurrence**: int: The occurrence. +### Additional Properties +* **Additional Properties Type**: any -## AmazonRdsForSqlServerSourceStoredProcedureParameters +## RedirectIncompatibleRowSettings ### Properties +* **linkedServiceName**: any (Required): Any object +* **path**: any: Any object ### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +* **Additional Properties Type**: any ## RedshiftUnloadSettings ### Properties * **bucketName**: any (Required): Any object * **s3LinkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -## StoreReadSettings -* **Discriminator**: type - -### Base Properties -* **disableMetricsCollection**: any: Any object -* **maxConcurrentConnections**: any: Any object -### AmazonS3CompatibleReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **prefix**: any: Any object -* **recursive**: any: Any object -* **type**: 'AmazonS3CompatibleReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## RelationalTableDatasetTypeProperties +### Properties +* **tableName**: any: Any object -### AmazonS3ReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **prefix**: any: Any object -* **recursive**: any: Any object -* **type**: 'AmazonS3ReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## RerunTumblingWindowTriggerTypeProperties +### Properties +* **parentTrigger**: any (Required): Any object +* **requestedEndTime**: string (Required): The end time for the time period for which restatement is initiated. Only UTC time is currently supported. +* **requestedStartTime**: string (Required): The start time for the time period for which restatement is initiated. Only UTC time is currently supported. +* **rerunConcurrency**: int (Required): The max number of parallel time windows (ready for execution) for which a rerun is triggered. -### AzureBlobFSReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **recursive**: any: Any object -* **type**: 'AzureBlobFSReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -### AzureBlobStorageReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **prefix**: any: Any object -* **recursive**: any: Any object -* **type**: 'AzureBlobStorageReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## ResponsysLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### AzureDataLakeStoreReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **listAfter**: any: Any object -* **listBefore**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **recursive**: any: Any object -* **type**: 'AzureDataLakeStoreReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## RestResourceDatasetTypeProperties +### Properties +* **additionalHeaders**: any: Any object +* **paginationRules**: any: Any object +* **relativeUrl**: any: Any object +* **requestBody**: any: Any object +* **requestMethod**: any: Any object -### AzureFileStorageReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **prefix**: any: Any object -* **recursive**: any: Any object -* **type**: 'AzureFileStorageReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## RestServiceLinkedServiceTypeProperties +### Properties +* **aadResourceId**: any: Any object +* **authenticationType**: 'AadServicePrincipal' | 'Anonymous' | 'Basic' | 'ManagedServiceIdentity' | string (Required): Type of authentication used to connect to the REST service. +* **authHeaders**: any: Any object +* **azureCloudType**: any: Any object +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **enableServerCertificateValidation**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **tenant**: any: Any object +* **url**: any (Required): Any object +* **userName**: any: Any object -### FileServerReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileFilter**: any: Any object -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **recursive**: any: Any object -* **type**: 'FileServerReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## RetryPolicy +### Properties +* **count**: any: Any object +* **intervalInSeconds**: int: Interval between retries in seconds. Default is 30. -### FtpReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **disableChunking**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **partitionRootPath**: any: Any object -* **recursive**: any: Any object -* **type**: 'FtpReadSettings' (Required): The read setting type. -* **useBinaryTransfer**: bool: Specify whether to use binary transfer mode for FTP stores. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## SalesforceLinkedServiceTypeProperties +### Properties +* **apiVersion**: any: Any object +* **encryptedCredential**: any: Any object +* **environmentUrl**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **securityToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **username**: any: Any object -### GoogleCloudStorageReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **prefix**: any: Any object -* **recursive**: any: Any object -* **type**: 'GoogleCloudStorageReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## SalesforceMarketingCloudLinkedServiceTypeProperties +### Properties +* **clientId**: any: Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **connectionProperties**: any: Any object +* **encryptedCredential**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -### HdfsReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **distcpSettings**: [DistcpSettings](#distcpsettings): Distcp settings. -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **recursive**: any: Any object -* **type**: 'HdfsReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## SalesforceObjectDatasetTypeProperties +### Properties +* **objectApiName**: any: Any object -### HttpReadSettings -#### Properties -* **additionalHeaders**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **partitionRootPath**: any: Any object -* **requestBody**: any: Any object -* **requestMethod**: any: Any object -* **requestTimeout**: any: Any object -* **type**: 'HttpReadSettings' (Required): The read setting type. +## SalesforceServiceCloudLinkedServiceTypeProperties +### Properties +* **apiVersion**: any: Any object +* **encryptedCredential**: any: Any object +* **environmentUrl**: any: Any object +* **extendedProperties**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **securityToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **username**: any: Any object -### OracleCloudStorageReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **prefix**: any: Any object -* **recursive**: any: Any object -* **type**: 'OracleCloudStorageReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## SalesforceServiceCloudObjectDatasetTypeProperties +### Properties +* **objectApiName**: any: Any object -### SftpReadSettings -#### Properties -* **deleteFilesAfterCompletion**: any: Any object -* **disableChunking**: any: Any object -* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. -* **fileListPath**: any: Any object -* **modifiedDatetimeEnd**: any: Any object -* **modifiedDatetimeStart**: any: Any object -* **partitionRootPath**: any: Any object -* **recursive**: any: Any object -* **type**: 'SftpReadSettings' (Required): The read setting type. -* **wildcardFileName**: any: Any object -* **wildcardFolderPath**: any: Any object +## SapBWLinkedServiceTypeProperties +### Properties +* **clientId**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any (Required): Any object +* **systemNumber**: any (Required): Any object +* **userName**: any: Any object +## SapCloudForCustomerLinkedServiceTypeProperties +### Properties +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object +* **username**: any: Any object -## DistcpSettings +## SapCloudForCustomerResourceDatasetTypeProperties ### Properties -* **distcpOptions**: any: Any object -* **resourceManagerEndpoint**: any (Required): Any object -* **tempScriptPath**: any (Required): Any object +* **path**: any (Required): Any object -## AzureDatabricksDeltaLakeExportCommand +## SapEccLinkedServiceTypeProperties ### Properties -* **dateFormat**: any: Any object -* **timestampFormat**: any: Any object -* **type**: string (Required): The export setting type. -### Additional Properties -* **Additional Properties Type**: any +* **encryptedCredential**: string: 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). +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: string (Required): The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). +* **username**: string: The username for Basic authentication. Type: string (or Expression with resultType string). -## AzureSqlSourceStoredProcedureParameters +## SapEccResourceDatasetTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +* **path**: any (Required): Any object -## BinaryReadSettings +## SapHanaLinkedServiceProperties ### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **type**: string (Required): The read setting type. -### Additional Properties -* **Additional Properties Type**: any +* **authenticationType**: 'Basic' | 'Windows' | string: The authentication type to be used to connect to the SAP HANA server. +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any: Any object +* **userName**: any: Any object -## CompressionReadSettings -* **Discriminator**: type +## SapHanaPartitionSettings +### Properties +* **partitionColumnName**: any: Any object -### Base Properties -### TarGZipReadSettings -#### Properties -* **preserveCompressionFileNameAsFolder**: any: Any object -* **type**: 'TarGZipReadSettings' (Required): The Compression setting type. +## SapHanaTableDatasetTypeProperties +### Properties +* **schema**: any: Any object +* **table**: any: Any object -### TarReadSettings -#### Properties -* **preserveCompressionFileNameAsFolder**: any: Any object -* **type**: 'TarReadSettings' (Required): The Compression setting type. +## SapOpenHubLinkedServiceTypeProperties +### Properties +* **clientId**: any: Any object +* **encryptedCredential**: any: Any object +* **language**: any: Any object +* **logonGroup**: any: Any object +* **messageServer**: any: Any object +* **messageServerService**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any: Any object +* **systemId**: any: Any object +* **systemNumber**: any: Any object +* **userName**: any: Any object -### ZipDeflateReadSettings -#### Properties -* **preserveZipFileNameAsFolder**: any: Any object -* **type**: 'ZipDeflateReadSettings' (Required): The Compression setting type. +## SapOpenHubTableDatasetTypeProperties +### Properties +* **baseRequestId**: any: Any object +* **excludeLastRequest**: any: Any object +* **openHubDestinationName**: any (Required): Any object +## SapTableLinkedServiceTypeProperties +### Properties +* **clientId**: any: Any object +* **encryptedCredential**: any: Any object +* **language**: any: Any object +* **logonGroup**: any: Any object +* **messageServer**: any: Any object +* **messageServerService**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any: Any object +* **sncLibraryPath**: any: Any object +* **sncMode**: any: Any object +* **sncMyName**: any: Any object +* **sncPartnerName**: any: Any object +* **sncQop**: any: Any object +* **systemId**: any: Any object +* **systemNumber**: any: Any object +* **userName**: any: Any object -## MongoDbCursorMethodsProperties +## SapTablePartitionSettings ### Properties -* **limit**: any: Any object -* **project**: any: Any object -* **skip**: any: Any object -* **sort**: any: Any object -### Additional Properties -* **Additional Properties Type**: any +* **maxPartitionsNumber**: any: Any object +* **partitionColumnName**: any: Any object +* **partitionLowerBound**: any: Any object +* **partitionUpperBound**: any: Any object -## DelimitedTextReadSettings +## SapTableResourceDatasetTypeProperties ### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **skipLineCount**: any: Any object -* **type**: string (Required): The read setting type. -### Additional Properties -* **Additional Properties Type**: any +* **tableName**: any (Required): Any object -## JsonReadSettings +## ScheduleTriggerRecurrence ### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **type**: string (Required): The read setting type. +* **endTime**: string: The end time. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Week' | 'Year' | string: Enumerates possible frequency option for the schedule trigger. +* **interval**: int: The interval. +* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. +* **startTime**: string: The start time. +* **timeZone**: string: The time zone. ### Additional Properties * **Additional Properties Type**: any -## NetezzaPartitionSettings +## ScheduleTriggerTypeProperties ### Properties -* **partitionColumnName**: any: Any object -* **partitionLowerBound**: any: Any object -* **partitionUpperBound**: any: Any object +* **recurrence**: [ScheduleTriggerRecurrence](#scheduletriggerrecurrence) (Required): The workflow trigger recurrence. -## OraclePartitionSettings +## ScriptAction ### Properties -* **partitionColumnName**: any: Any object -* **partitionLowerBound**: any: Any object -* **partitionNames**: any: Any object -* **partitionUpperBound**: any: Any object +* **name**: string (Required): The user provided name of the script action. +* **parameters**: string: The parameters for the script action. +* **roles**: any (Required): Any object +* **uri**: string (Required): The URI for the script action. -## SapHanaPartitionSettings +## ScriptActivityParameter ### Properties -* **partitionColumnName**: any: Any object +* **direction**: 'Input' | 'InputOutput' | 'Output' | string: The direction of the parameter. +* **name**: any: Any object +* **size**: int: The size of the output direction parameter. +* **type**: 'Boolean' | 'DateTime' | 'DateTimeOffset' | 'Decimal' | 'Double' | 'Guid' | 'Int16' | 'Int32' | 'Int64' | 'Single' | 'String' | 'Timespan' | string: The type of the parameter. +* **value**: any: Any object -## SapTablePartitionSettings +## ScriptActivityScriptBlock ### Properties -* **maxPartitionsNumber**: any: Any object -* **partitionColumnName**: any: Any object -* **partitionLowerBound**: any: Any object -* **partitionUpperBound**: any: Any object +* **parameters**: [ScriptActivityParameter](#scriptactivityparameter)[]: Array of script parameters. Type: array. +* **text**: any (Required): Any object +* **type**: 'NonQuery' | 'Query' | string (Required): The type of the query. Type: string. -## SnowflakeExportCopyCommand +## ScriptActivityTypeProperties ### Properties -* **additionalCopyOptions**: [SnowflakeExportCopyCommandAdditionalCopyOptions](#snowflakeexportcopycommandadditionalcopyoptions): 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'" } -* **additionalFormatOptions**: [SnowflakeExportCopyCommandAdditionalFormatOptions](#snowflakeexportcopycommandadditionalformatoptions): 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'" } -* **type**: string (Required): The export setting type. -### Additional Properties -* **Additional Properties Type**: any +* **logSettings**: [ScriptActivityTypePropertiesLogSettings](#scriptactivitytypepropertieslogsettings): Log settings of script activity. +* **scripts**: [ScriptActivityScriptBlock](#scriptactivityscriptblock)[]: Array of script blocks. Type: array. -## SnowflakeExportCopyCommandAdditionalCopyOptions +## ScriptActivityTypePropertiesLogSettings ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **logDestination**: 'ActivityOutput' | 'ExternalStore' | string (Required): The destination of logs. Type: string. +* **logLocationSettings**: [LogLocationSettings](#loglocationsettings): Log location settings. -## SnowflakeExportCopyCommandAdditionalFormatOptions +## SecretBase +* **Discriminator**: type + +### Base Properties +### AzureKeyVaultSecretReference +#### Properties +* **secretName**: any (Required): Any object +* **secretVersion**: any: Any object +* **store**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **type**: 'AzureKeyVaultSecret' (Required): Type of the secret. + +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. -## SqlMISourceStoredProcedureParameters +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## SqlServerSourceStoredProcedureParameters +## ServiceNowLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +* **authenticationType**: 'Basic' | 'OAuth2' | string (Required): The authentication type to use. +* **clientId**: any: Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **endpoint**: any (Required): Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object +* **username**: any: Any object -## SqlSourceStoredProcedureParameters +## SetVariableActivityTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) +* **value**: any: Any object +* **variableName**: string: Name of the variable whose value needs to be set. -## TeradataPartitionSettings +## SftpServerLinkedServiceTypeProperties ### Properties -* **partitionColumnName**: any: Any object -* **partitionLowerBound**: any: Any object -* **partitionUpperBound**: any: Any object +* **authenticationType**: 'Basic' | 'MultiFactor' | 'SshPublicKey' | string: The authentication type to be used to connect to the FTP server. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **hostKeyFingerprint**: any: Any object +* **passPhrase**: [SecretBase](#secretbase): The base definition of a secret type. +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any: Any object +* **privateKeyContent**: [SecretBase](#secretbase): The base definition of a secret type. +* **privateKeyPath**: any: Any object +* **skipHostKeyValidation**: any: Any object +* **userName**: any: Any object -## XmlReadSettings +## SharePointOnlineListDatasetTypeProperties ### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **detectDataType**: any: Any object -* **namespacePrefixes**: any: Any object -* **namespaces**: any: Any object -* **type**: string (Required): The read setting type. -* **validationMode**: any: Any object -### Additional Properties -* **Additional Properties Type**: any +* **listName**: any: Any object -## StagingSettings +## SharePointOnlineListLinkedServiceTypeProperties ### Properties -* **enableCompression**: any: Any object -* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **path**: any: Any object -### Additional Properties -* **Additional Properties Type**: any +* **encryptedCredential**: any: Any object +* **servicePrincipalId**: any (Required): Any object +* **servicePrincipalKey**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **siteUrl**: any (Required): Any object +* **tenantId**: any (Required): Any object -## CustomActivityTypeProperties +## ShopifyLinkedServiceTypeProperties ### Properties -* **autoUserSpecification**: any: Any object -* **command**: any (Required): Any object -* **extendedProperties**: [CustomActivityTypePropertiesExtendedProperties](#customactivitytypepropertiesextendedproperties): 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. -* **folderPath**: any: Any object -* **referenceObjects**: [CustomActivityReferenceObject](#customactivityreferenceobject): Reference objects for custom activity -* **resourceLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **retentionTimeInDays**: any: Any object +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## CustomActivityTypePropertiesExtendedProperties +## SkipErrorFile ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **dataInconsistency**: any: Any object +* **fileMissing**: any: Any object -## CustomActivityReferenceObject +## SmartsheetLinkedServiceTypeProperties ### Properties -* **datasets**: [DatasetReference](#datasetreference)[]: Dataset references. -* **linkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Linked service references. +* **apiToken**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **encryptedCredential**: any: Any object -## DatabricksNotebookActivityTypeProperties +## SnowflakeDatasetTypeProperties ### Properties -* **baseParameters**: [DatabricksNotebookActivityTypePropertiesBaseParameters](#databricksnotebookactivitytypepropertiesbaseparameters): 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. -* **libraries**: [DatabricksNotebookActivityTypePropertiesLibrariesItem](#databricksnotebookactivitytypepropertieslibrariesitem)[]: A list of libraries to be installed on the cluster that will execute the job. -* **notebookPath**: any (Required): Any object +* **schema**: any: Any object +* **table**: any: Any object -## DatabricksNotebookActivityTypePropertiesBaseParameters +## SnowflakeExportCopyCommand ### Properties +* **additionalCopyOptions**: [SnowflakeExportCopyCommandAdditionalCopyOptions](#snowflakeexportcopycommandadditionalcopyoptions): 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'" } +* **additionalFormatOptions**: [SnowflakeExportCopyCommandAdditionalFormatOptions](#snowflakeexportcopycommandadditionalformatoptions): 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'" } +* **type**: string (Required): The export setting type. ### Additional Properties * **Additional Properties Type**: any -## DatabricksNotebookActivityTypePropertiesLibrariesItem +## SnowflakeExportCopyCommandAdditionalCopyOptions ### Properties ### Additional Properties * **Additional Properties Type**: any -## DatabricksSparkJarActivityTypeProperties -### Properties -* **libraries**: [DatabricksSparkJarActivityTypePropertiesLibrariesItem](#databrickssparkjaractivitytypepropertieslibrariesitem)[]: A list of libraries to be installed on the cluster that will execute the job. -* **mainClassName**: any (Required): Any object -* **parameters**: any[]: Parameters that will be passed to the main method. - -## DatabricksSparkJarActivityTypePropertiesLibrariesItem +## SnowflakeExportCopyCommandAdditionalFormatOptions ### Properties ### Additional Properties * **Additional Properties Type**: any -## DatabricksSparkPythonActivityTypeProperties -### Properties -* **libraries**: [DatabricksSparkPythonActivityTypePropertiesLibrariesItem](#databrickssparkpythonactivitytypepropertieslibrariesitem)[]: A list of libraries to be installed on the cluster that will execute the job. -* **parameters**: any[]: Command line parameters that will be passed to the Python file. -* **pythonFile**: any (Required): Any object - -## DatabricksSparkPythonActivityTypePropertiesLibrariesItem +## SnowflakeImportCopyCommand ### Properties +* **additionalCopyOptions**: [SnowflakeImportCopyCommandAdditionalCopyOptions](#snowflakeimportcopycommandadditionalcopyoptions): 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'" } +* **additionalFormatOptions**: [SnowflakeImportCopyCommandAdditionalFormatOptions](#snowflakeimportcopycommandadditionalformatoptions): 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'" } +* **type**: string (Required): The import setting type. ### Additional Properties * **Additional Properties Type**: any -## DataLakeAnalyticsUsqlActivityTypeProperties +## SnowflakeImportCopyCommandAdditionalCopyOptions ### Properties -* **compilationMode**: any: Any object -* **degreeOfParallelism**: any: Any object -* **parameters**: [DataLakeAnalyticsUsqlActivityTypePropertiesParameters](#datalakeanalyticsusqlactivitytypepropertiesparameters): Parameters for U-SQL job request. -* **priority**: any: Any object -* **runtimeVersion**: any: Any object -* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **scriptPath**: any (Required): Any object +### Additional Properties +* **Additional Properties Type**: any -## DataLakeAnalyticsUsqlActivityTypePropertiesParameters +## SnowflakeImportCopyCommandAdditionalFormatOptions ### Properties ### Additional Properties * **Additional Properties Type**: any -## DeleteActivityTypeProperties +## SnowflakeLinkedServiceTypeProperties ### Properties -* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. -* **enableLogging**: any: Any object -* **logStorageSettings**: [LogStorageSettings](#logstoragesettings): (Deprecated. Please use LogSettings) Log storage settings. -* **maxConcurrentConnections**: int: The max concurrent connections to connect data source at the same time. -* **recursive**: any: Any object -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -## ExecuteDataFlowActivityTypeProperties +## SparkDatasetTypeProperties ### Properties -* **compute**: [ExecuteDataFlowActivityTypePropertiesCompute](#executedataflowactivitytypepropertiescompute): Compute properties for data flow activity. -* **continueOnError**: any: Any object -* **dataFlow**: [DataFlowReference](#dataflowreference) (Required): Data flow reference type. -* **integrationRuntime**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. -* **runConcurrently**: any: Any object -* **staging**: [DataFlowStagingInfo](#dataflowstaginginfo): Staging info for execute data flow activity. -* **traceLevel**: any: Any object +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -## ExecuteDataFlowActivityTypePropertiesCompute +## SparkLinkedServiceTypeProperties ### Properties -* **computeType**: any: Any object -* **coreCount**: any: Any object +* **allowHostNameCNMismatch**: any: Any object +* **allowSelfSignedServerCert**: any: Any object +* **authenticationType**: 'Anonymous' | 'Username' | 'UsernameAndPassword' | 'WindowsAzureHDInsightService' | string (Required): The authentication method used to access the Spark server. +* **enableSsl**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any (Required): Any object +* **httpPath**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **port**: any (Required): Any object +* **serverType**: 'SharkServer' | 'SharkServer2' | 'SparkThriftServer' | string: The type of Spark server. +* **thriftTransportProtocol**: 'Binary' | 'HTTP ' | 'SASL' | string: The transport protocol to use in the Thrift layer. +* **trustedCertPath**: any: Any object +* **username**: any: Any object +* **useSystemTrustStore**: any: Any object -## DataFlowStagingInfo +## SqlAlwaysEncryptedProperties ### Properties -* **folderPath**: any: Any object -* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **alwaysEncryptedAkvAuthType**: 'ManagedIdentity' | 'ServicePrincipal' | 'UserAssignedManagedIdentity' | string (Required): Sql always encrypted AKV authentication type. Type: string (or Expression with resultType string). +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **servicePrincipalId**: any: Any object +* **servicePrincipalKey**: [SecretBase](#secretbase): The base definition of a secret type. -## ExecutePipelineActivityPolicy +## SqlDWUpsertSettings ### Properties -* **secureInput**: bool: When set to true, Input from activity is considered as secure and will not be logged to monitoring. -### Additional Properties -* **Additional Properties Type**: any +* **interimSchemaName**: any: Any object +* **keys**: any: Any object -## ExecutePipelineActivityTypeProperties +## SqlMISinkStoredProcedureParameters ### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **pipeline**: [PipelineReference](#pipelinereference) (Required): Pipeline reference type. -* **waitOnCompletion**: bool: Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false. +### Additional Properties +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## ParameterValueSpecification +## SqlMISourceStoredProcedureParameters ### Properties ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## PipelineReference +## SqlPartitionSettings ### Properties -* **name**: string: Reference name. -* **referenceName**: string (Required): Reference pipeline name. -* **type**: 'PipelineReference' | string (Required): Pipeline reference type. +* **partitionColumnName**: any: Any object +* **partitionLowerBound**: any: Any object +* **partitionUpperBound**: any: Any object -## ExecuteSsisPackageActivityTypeProperties +## SqlServerLinkedServiceTypeProperties ### Properties -* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference) (Required): Integration runtime reference type. -* **environmentPath**: any: Any object -* **executionCredential**: [SsisExecutionCredential](#ssisexecutioncredential): SSIS package execution credential. -* **loggingLevel**: any: Any object -* **logLocation**: [SsisLogLocation](#ssisloglocation): SSIS package execution log location -* **packageConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers](#executessispackageactivitytypepropertiespackageconnectionmanagers): The package level connection managers to execute the SSIS package. -* **packageLocation**: [SsisPackageLocation](#ssispackagelocation) (Required): SSIS package location. -* **packageParameters**: [ExecuteSsisPackageActivityTypePropertiesPackageParameters](#executessispackageactivitytypepropertiespackageparameters): The package level parameters to execute the SSIS package. -* **projectConnectionManagers**: [ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers](#executessispackageactivitytypepropertiesprojectconnectionmanagers): The project level connection managers to execute the SSIS package. -* **projectParameters**: [ExecuteSsisPackageActivityTypePropertiesProjectParameters](#executessispackageactivitytypepropertiesprojectparameters): The project level parameters to execute the SSIS package. -* **propertyOverrides**: [ExecuteSsisPackageActivityTypePropertiesPropertyOverrides](#executessispackageactivitytypepropertiespropertyoverrides): The property overrides to execute the SSIS package. -* **runtime**: any: Any object +* **alwaysEncryptedSettings**: [SqlAlwaysEncryptedProperties](#sqlalwaysencryptedproperties): Sql always encrypted properties. +* **connectionString**: any (Required): Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **userName**: any: Any object -## SsisExecutionCredential +## SqlServerSinkStoredProcedureParameters ### Properties -* **domain**: any (Required): Any object -* **password**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **userName**: any (Required): Any object +### Additional Properties +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## SsisLogLocation +## SqlServerSourceStoredProcedureParameters ### Properties -* **logPath**: any (Required): Any object -* **type**: 'File' | string (Required): The type of SSIS log location. -* **typeProperties**: [SsisLogLocationTypeProperties](#ssisloglocationtypeproperties) (Required): SSIS package execution log location properties. +### Additional Properties +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## SsisLogLocationTypeProperties +## SqlServerStoredProcedureActivityTypeProperties ### Properties -* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. -* **logRefreshInterval**: any: Any object +* **storedProcedureName**: any (Required): Any object +* **storedProcedureParameters**: any: Any object -## SsisAccessCredential +## SqlServerTableDatasetTypeProperties ### Properties -* **domain**: any (Required): Any object -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **userName**: any (Required): Any object +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -## ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers +## SqlSinkStoredProcedureParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## SsisConnectionManager +## SqlSourceStoredProcedureParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **Additional Properties Type**: [StoredProcedureParameter](#storedprocedureparameter) -## SsisExecutionParameter +## SqlUpsertSettings ### Properties -* **value**: any (Required): Any object +* **interimSchemaName**: any: Any object +* **keys**: any: Any object +* **useTempDB**: any: Any object -## SsisPackageLocation +## SquareLinkedServiceTypeProperties ### Properties -* **packagePath**: any: Any object -* **type**: 'File' | 'InlinePackage' | 'PackageStore' | 'SSISDB' | string: The type of SSIS package location. -* **typeProperties**: [SsisPackageLocationTypeProperties](#ssispackagelocationtypeproperties): SSIS package location properties. +* **clientId**: any: Any object +* **clientSecret**: [SecretBase](#secretbase): The base definition of a secret type. +* **connectionProperties**: any: Any object +* **encryptedCredential**: any: Any object +* **host**: any: Any object +* **redirectUri**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object -## SsisPackageLocationTypeProperties +## SsisAccessCredential ### Properties -* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. -* **childPackages**: [SsisChildPackage](#ssischildpackage)[]: The embedded child package list. -* **configurationAccessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. -* **configurationPath**: any: Any object -* **packageContent**: any: Any object -* **packageLastModifiedDate**: string: The embedded package last modified date. -* **packageName**: string: The package name. -* **packagePassword**: [SecretBase](#secretbase): The base definition of a secret type. +* **domain**: any (Required): Any object +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **userName**: any (Required): Any object ## SsisChildPackage ### Properties @@ -5225,264 +5179,292 @@ * **packageName**: string: Name for embedded child package. * **packagePath**: any (Required): Any object -## ExecuteSsisPackageActivityTypePropertiesPackageParameters +## SsisConnectionManager ### Properties ### Additional Properties * **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) -## ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers +## SsisConnectionManager ### Properties ### Additional Properties -* **Additional Properties Type**: [SsisConnectionManager](#ssisconnectionmanager) +* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) + +## SsisExecutionCredential +### Properties +* **domain**: any (Required): Any object +* **password**: [SecureString](#securestring) (Required): Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **userName**: any (Required): Any object + +## SsisExecutionParameter +### Properties +* **value**: any (Required): Any object + +## SsisLogLocation +### Properties +* **logPath**: any (Required): Any object +* **type**: 'File' | string (Required): The type of SSIS log location. +* **typeProperties**: [SsisLogLocationTypeProperties](#ssisloglocationtypeproperties) (Required): SSIS package execution log location properties. -## SsisConnectionManager +## SsisLogLocationTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. +* **logRefreshInterval**: any: Any object -## ExecuteSsisPackageActivityTypePropertiesProjectParameters +## SsisPackageLocation ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisExecutionParameter](#ssisexecutionparameter) +* **packagePath**: any: Any object +* **type**: 'File' | 'InlinePackage' | 'PackageStore' | 'SSISDB' | string: The type of SSIS package location. +* **typeProperties**: [SsisPackageLocationTypeProperties](#ssispackagelocationtypeproperties): SSIS package location properties. -## ExecuteSsisPackageActivityTypePropertiesPropertyOverrides +## SsisPackageLocationTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [SsisPropertyOverride](#ssispropertyoverride) +* **accessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. +* **childPackages**: [SsisChildPackage](#ssischildpackage)[]: The embedded child package list. +* **configurationAccessCredential**: [SsisAccessCredential](#ssisaccesscredential): SSIS access credential. +* **configurationPath**: any: Any object +* **packageContent**: any: Any object +* **packageLastModifiedDate**: string: The embedded package last modified date. +* **packageName**: string: The package name. +* **packagePassword**: [SecretBase](#secretbase): The base definition of a secret type. ## SsisPropertyOverride ### Properties * **isSensitive**: bool: Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true * **value**: any (Required): Any object -## ActivityPolicy +## StagingSettings ### Properties -* **retry**: any: Any object -* **retryIntervalInSeconds**: int: Interval between each retry attempt (in seconds). The default is 30 sec. -* **secureInput**: bool: When set to true, Input from activity is considered as secure and will not be logged to monitoring. -* **secureOutput**: bool: When set to true, Output from activity is considered as secure and will not be logged to monitoring. -* **timeout**: any: Any object +* **enableCompression**: any: Any object +* **linkedServiceName**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. +* **path**: any: Any object ### Additional Properties * **Additional Properties Type**: any -## ExecutePowerQueryActivityTypeProperties +## StoredProcedureParameter ### Properties -* **compute**: [ExecuteDataFlowActivityTypePropertiesCompute](#executedataflowactivitytypepropertiescompute): Compute properties for data flow activity. -* **continueOnError**: any: Any object -* **dataFlow**: [DataFlowReference](#dataflowreference) (Required): Data flow reference type. -* **integrationRuntime**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. -* **queries**: [PowerQuerySinkMapping](#powerquerysinkmapping)[]: List of mapping for Power Query mashup query to sink dataset(s). -* **runConcurrently**: any: Any object -* **sinks**: [ExecutePowerQueryActivityTypePropertiesSinks](#executepowerqueryactivitytypepropertiessinks): (Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName. -* **staging**: [DataFlowStagingInfo](#dataflowstaginginfo): Staging info for execute data flow activity. -* **traceLevel**: any: Any object +* **type**: 'Boolean' | 'Date' | 'Decimal' | 'Guid' | 'Int' | 'Int64' | 'String' | string: Stored procedure parameter type. +* **value**: any: Any object -## PowerQuerySinkMapping -### Properties -* **dataflowSinks**: [PowerQuerySink](#powerquerysink)[]: List of sinks mapped to Power Query mashup query. -* **queryName**: string: Name of the query in Power Query mashup document. +## StoreReadSettings +* **Discriminator**: type -## PowerQuerySink -### Properties -* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. -* **description**: string: Transformation description. -* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. -* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **name**: string (Required): Transformation name. -* **schemaLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **script**: string: sink script. +### Base Properties +* **disableMetricsCollection**: any: Any object +* **maxConcurrentConnections**: any: Any object +### AmazonS3CompatibleReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **prefix**: any: Any object +* **recursive**: any: Any object +* **type**: 'AmazonS3CompatibleReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object -## ExecutePowerQueryActivityTypePropertiesSinks -### Properties -### Additional Properties -* **Additional Properties Type**: [PowerQuerySink](#powerquerysink) +### AmazonS3ReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **prefix**: any: Any object +* **recursive**: any: Any object +* **type**: 'AmazonS3ReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object -## FailActivityTypeProperties -### Properties -* **errorCode**: any (Required): Any object -* **message**: any (Required): Any object +### AzureBlobFSReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **recursive**: any: Any object +* **type**: 'AzureBlobFSReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object -## FilterActivityTypeProperties -### Properties -* **condition**: [Expression](#expression) (Required): Azure Data Factory expression definition. -* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. +### AzureBlobStorageReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **prefix**: any: Any object +* **recursive**: any: Any object +* **type**: 'AzureBlobStorageReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object -## Expression -### Properties -* **type**: 'Expression' | string (Required): Expression type. -* **value**: string (Required): Expression value. +### AzureDataLakeStoreReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **listAfter**: any: Any object +* **listBefore**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **recursive**: any: Any object +* **type**: 'AzureDataLakeStoreReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object -## ForEachActivityTypeProperties -### Properties -* **activities**: [Activity](#activity)[] (Required): List of activities to execute . -* **batchCount**: int: Batch count to be used for controlling the number of parallel execution (when isSequential is set to false). -* **isSequential**: bool: Should the loop be executed in sequence or in parallel (max 50) -* **items**: [Expression](#expression) (Required): Azure Data Factory expression definition. +### AzureFileStorageReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **prefix**: any: Any object +* **recursive**: any: Any object +* **type**: 'AzureFileStorageReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object + +### FileServerReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileFilter**: any: Any object +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **recursive**: any: Any object +* **type**: 'FileServerReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object + +### FtpReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **disableChunking**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **partitionRootPath**: any: Any object +* **recursive**: any: Any object +* **type**: 'FtpReadSettings' (Required): The read setting type. +* **useBinaryTransfer**: bool: Specify whether to use binary transfer mode for FTP stores. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object + +### GoogleCloudStorageReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **prefix**: any: Any object +* **recursive**: any: Any object +* **type**: 'GoogleCloudStorageReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object + +### HdfsReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **distcpSettings**: [DistcpSettings](#distcpsettings): Distcp settings. +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **recursive**: any: Any object +* **type**: 'HdfsReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object + +### HttpReadSettings +#### Properties +* **additionalHeaders**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **partitionRootPath**: any: Any object +* **requestBody**: any: Any object +* **requestMethod**: any: Any object +* **requestTimeout**: any: Any object +* **type**: 'HttpReadSettings' (Required): The read setting type. + +### OracleCloudStorageReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **prefix**: any: Any object +* **recursive**: any: Any object +* **type**: 'OracleCloudStorageReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object + +### SftpReadSettings +#### Properties +* **deleteFilesAfterCompletion**: any: Any object +* **disableChunking**: any: Any object +* **enablePartitionDiscovery**: bool: Indicates whether to enable partition discovery. +* **fileListPath**: any: Any object +* **modifiedDatetimeEnd**: any: Any object +* **modifiedDatetimeStart**: any: Any object +* **partitionRootPath**: any: Any object +* **recursive**: any: Any object +* **type**: 'SftpReadSettings' (Required): The read setting type. +* **wildcardFileName**: any: Any object +* **wildcardFolderPath**: any: Any object -## GetMetadataActivityTypeProperties -### Properties -* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. -* **fieldList**: any[]: Fields of metadata to get from dataset. -* **formatSettings**: [FormatReadSettings](#formatreadsettings): Format read settings. -* **storeSettings**: [StoreReadSettings](#storereadsettings): Connector read setting. -## FormatReadSettings +## StoreWriteSettings * **Discriminator**: type ### Base Properties -### BinaryReadSettings +* **copyBehavior**: any: Any object +* **disableMetricsCollection**: any: Any object +* **maxConcurrentConnections**: any: Any object +### AzureBlobFSWriteSettings #### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **type**: 'BinaryReadSettings' (Required): The read setting type. +* **blockSizeInMB**: any: Any object +* **type**: 'AzureBlobFSWriteSettings' (Required): The write setting type. -### DelimitedTextReadSettings +### AzureBlobStorageWriteSettings #### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **skipLineCount**: any: Any object -* **type**: 'DelimitedTextReadSettings' (Required): The read setting type. +* **blockSizeInMB**: any: Any object +* **type**: 'AzureBlobStorageWriteSettings' (Required): The write setting type. -### JsonReadSettings +### AzureDataLakeStoreWriteSettings #### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **type**: 'JsonReadSettings' (Required): The read setting type. +* **expiryDateTime**: any: Any object +* **type**: 'AzureDataLakeStoreWriteSettings' (Required): The write setting type. -### XmlReadSettings +### AzureFileStorageWriteSettings #### Properties -* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. -* **detectDataType**: any: Any object -* **namespacePrefixes**: any: Any object -* **namespaces**: any: Any object -* **type**: 'XmlReadSettings' (Required): The read setting type. -* **validationMode**: any: Any object - - -## HDInsightHiveActivityTypeProperties -### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **defines**: [HDInsightHiveActivityTypePropertiesDefines](#hdinsighthiveactivitytypepropertiesdefines): Allows user to specify defines for Hive job request. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **queryTimeout**: int: Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package) -* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **scriptPath**: any: Any object -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. -* **variables**: any[]: User specified arguments under hivevar namespace. - -## HDInsightHiveActivityTypePropertiesDefines -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## HDInsightMapReduceActivityTypeProperties -### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **className**: any (Required): Any object -* **defines**: [HDInsightMapReduceActivityTypePropertiesDefines](#hdinsightmapreduceactivitytypepropertiesdefines): Allows user to specify defines for the MapReduce job request. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **jarFilePath**: any (Required): Any object -* **jarLibs**: any[]: Jar libs. -* **jarLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. - -## HDInsightMapReduceActivityTypePropertiesDefines -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## HDInsightPigActivityTypeProperties -### Properties -* **arguments**: any: Any object -* **defines**: [HDInsightPigActivityTypePropertiesDefines](#hdinsightpigactivitytypepropertiesdefines): Allows user to specify defines for Pig job request. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **scriptLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **scriptPath**: any: Any object -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. - -## HDInsightPigActivityTypePropertiesDefines -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## HDInsightSparkActivityTypeProperties -### Properties -* **arguments**: any[]: The user-specified arguments to HDInsightSparkActivity. -* **className**: string: The application's Java/Spark main class. -* **entryFilePath**: any (Required): Any object -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **proxyUser**: any: Any object -* **rootPath**: any (Required): Any object -* **sparkConfig**: [HDInsightSparkActivityTypePropertiesSparkConfig](#hdinsightsparkactivitytypepropertiessparkconfig): Spark configuration property. -* **sparkJobLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. - -## HDInsightSparkActivityTypePropertiesSparkConfig -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## HDInsightStreamingActivityTypeProperties -### Properties -* **arguments**: any[]: User specified arguments to HDInsightActivity. -* **combiner**: any: Any object -* **commandEnvironment**: any[]: Command line environment values. -* **defines**: [HDInsightStreamingActivityTypePropertiesDefines](#hdinsightstreamingactivitytypepropertiesdefines): Allows user to specify defines for streaming job request. -* **fileLinkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. -* **filePaths**: any[] (Required): Paths to streaming job files. Can be directories. -* **getDebugInfo**: 'Always' | 'Failure' | 'None' | string: The HDInsightActivityDebugInfoOption settings to use. -* **input**: any (Required): Any object -* **mapper**: any (Required): Any object -* **output**: any (Required): Any object -* **reducer**: any (Required): Any object -* **storageLinkedServices**: [LinkedServiceReference](#linkedservicereference)[]: Storage linked service references. - -## HDInsightStreamingActivityTypePropertiesDefines -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## IfConditionActivityTypeProperties -### Properties -* **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. -* **ifFalseActivities**: [Activity](#activity)[]: 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. -* **ifTrueActivities**: [Activity](#activity)[]: 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. - -## LookupActivityTypeProperties -### Properties -* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. -* **firstRowOnly**: any: Any object -* **source**: [CopySource](#copysource) (Required): A copy activity source. - -## ScriptActivityTypeProperties -### Properties -* **logSettings**: [ScriptActivityTypePropertiesLogSettings](#scriptactivitytypepropertieslogsettings): Log settings of script activity. -* **scripts**: [ScriptActivityScriptBlock](#scriptactivityscriptblock)[]: Array of script blocks. Type: array. - -## ScriptActivityTypePropertiesLogSettings -### Properties -* **logDestination**: 'ActivityOutput' | 'ExternalStore' | string (Required): The destination of logs. Type: string. -* **logLocationSettings**: [LogLocationSettings](#loglocationsettings): Log location settings. - -## ScriptActivityScriptBlock -### Properties -* **parameters**: [ScriptActivityParameter](#scriptactivityparameter)[]: Array of script parameters. Type: array. -* **text**: any (Required): Any object -* **type**: 'NonQuery' | 'Query' | string (Required): The type of the query. Type: string. +* **type**: 'AzureFileStorageWriteSettings' (Required): The write setting type. -## ScriptActivityParameter -### Properties -* **direction**: 'Input' | 'InputOutput' | 'Output' | string: The direction of the parameter. -* **name**: any: Any object -* **size**: int: The size of the output direction parameter. -* **type**: 'Boolean' | 'DateTime' | 'DateTimeOffset' | 'Decimal' | 'Double' | 'Guid' | 'Int16' | 'Int32' | 'Int64' | 'Single' | 'String' | 'Timespan' | string: The type of the parameter. -* **value**: any: Any object +### FileServerWriteSettings +#### Properties +* **type**: 'FileServerWriteSettings' (Required): The write setting type. -## SetVariableActivityTypeProperties -### Properties -* **value**: any: Any object -* **variableName**: string: Name of the variable whose value needs to be set. +### SftpWriteSettings +#### Properties +* **operationTimeout**: any: Any object +* **type**: 'SftpWriteSettings' (Required): The write setting type. +* **useTempFileRename**: any: Any object -## SqlServerStoredProcedureActivityTypeProperties -### Properties -* **storedProcedureName**: any (Required): Any object -* **storedProcedureParameters**: any: Any object ## SwitchActivityTypeProperties ### Properties @@ -5495,103 +5477,56 @@ * **activities**: [Activity](#activity)[]: List of activities to execute for satisfied case condition. * **value**: string: Expected value that satisfies the expression result of the 'on' property. -## UntilActivityTypeProperties -### Properties -* **activities**: [Activity](#activity)[] (Required): List of activities to execute. -* **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. -* **timeout**: any: Any object - -## ValidationActivityTypeProperties -### Properties -* **childItems**: any: Any object -* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. -* **minimumSize**: any: Any object -* **sleep**: any: Any object -* **timeout**: any: Any object - -## WaitActivityTypeProperties -### Properties -* **waitTimeInSeconds**: any (Required): Any object - -## WebActivityTypeProperties -### Properties -* **authentication**: [WebActivityAuthentication](#webactivityauthentication): Web activity authentication properties. -* **body**: any: Any object -* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. -* **datasets**: [DatasetReference](#datasetreference)[]: List of datasets passed to web endpoint. -* **disableCertValidation**: bool: When set to true, Certificate validation will be disabled. -* **headers**: any: Any object -* **linkedServices**: [LinkedServiceReference](#linkedservicereference)[]: List of linked services passed to web endpoint. -* **method**: 'DELETE' | 'GET' | 'POST' | 'PUT' | string (Required): The list of HTTP methods supported by a WebActivity. -* **url**: any (Required): Any object - -## WebActivityAuthentication +## SybaseLinkedServiceTypeProperties ### Properties -* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. +* **database**: any (Required): Any object +* **encryptedCredential**: any: Any object * **password**: [SecretBase](#secretbase): The base definition of a secret type. -* **pfx**: [SecretBase](#secretbase): The base definition of a secret type. -* **resource**: any: Any object -* **type**: string: Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal) +* **schema**: any: Any object +* **server**: any (Required): Any object * **username**: any: Any object -* **userTenant**: any: Any object - -## WebHookActivityTypeProperties -### Properties -* **authentication**: [WebActivityAuthentication](#webactivityauthentication): Web activity authentication properties. -* **body**: any: Any object -* **headers**: any: Any object -* **method**: 'POST' | string (Required): The list of HTTP methods supported by a WebHook activity. -* **reportStatusOnCallBack**: any: Any object -* **timeout**: string: 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])). -* **url**: any (Required): Any object - -## PipelineFolder -### Properties -* **name**: string: The name of the folder that this Pipeline is in. - -## ParameterDefinitionSpecification -### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterSpecification](#parameterspecification) - -## PipelinePolicy -### Properties -* **elapsedTimeMetric**: [PipelineElapsedTimeMetricPolicy](#pipelineelapsedtimemetricpolicy): Pipeline ElapsedTime Metric Policy. - -## PipelineElapsedTimeMetricPolicy -### Properties -* **duration**: any: Any object -## PipelineRunDimensions +## SybaseTableDatasetTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **tableName**: any: Any object -## VariableDefinitionSpecification +## TeamDeskLinkedServiceTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [VariableSpecification](#variablespecification) +* **apiToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **authenticationType**: 'Basic' | 'Token' | string (Required): The authentication type to use. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object +* **userName**: any: Any object -## VariableSpecification +## TeradataLinkedServiceTypeProperties ### Properties -* **defaultValue**: any: Any object -* **type**: 'Array' | 'Bool' | 'String' | string (Required): Variable type. +* **authenticationType**: 'Basic' | 'Windows' | string: AuthenticationType to be used for connection. +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **server**: any: Any object +* **username**: any: Any object -## PrivateLinkConnectionApprovalRequest +## TeradataPartitionSettings ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint which a connection belongs to. -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) +* **partitionColumnName**: any: Any object +* **partitionLowerBound**: any: Any object +* **partitionUpperBound**: any: Any object -## PrivateEndpoint +## TeradataTableDatasetTypeProperties ### Properties -* **id**: string: The resource Id for private endpoint +* **database**: any: Any object +* **table**: any: Any object -## PrivateLinkConnectionState +## Transformation ### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection +* **dataset**: [DatasetReference](#datasetreference): Dataset reference type. +* **description**: string: Transformation description. +* **flowlet**: [DataFlowReference](#dataflowreference): Data flow reference type. +* **linkedService**: [LinkedServiceReference](#linkedservicereference): Linked service reference type. +* **name**: string (Required): Transformation name. ## Trigger * **Discriminator**: type @@ -5638,116 +5573,181 @@ * **typeProperties**: [TumblingWindowTriggerTypeProperties](#tumblingwindowtriggertypeproperties) (Required): Tumbling Window Trigger properties. -## BlobEventsTriggerTypeProperties +## TriggerPipelineReference ### Properties -* **blobPathBeginsWith**: string: 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. -* **blobPathEndsWith**: 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. -* **events**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobDeleted' | string[] (Required): Blob event types. -* **ignoreEmptyBlobs**: bool: If set to true, blobs with zero bytes will be ignored. -* **scope**: string (Required): The ARM resource ID of the Storage Account. +* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. +* **pipelineReference**: [PipelineReference](#pipelinereference): Pipeline reference type. -## BlobTriggerTypeProperties +## TumblingWindowTriggerTypeProperties ### Properties -* **folderPath**: string (Required): The path of the container/folder that will trigger the pipeline. -* **linkedService**: [LinkedServiceReference](#linkedservicereference) (Required): Linked service reference type. -* **maxConcurrency**: int (Required): The max number of parallel files to handle when it is triggered. +* **delay**: any: Any object +* **dependsOn**: [DependencyReference](#dependencyreference)[]: Triggers that this trigger depends on. Only tumbling window triggers are supported. +* **endTime**: 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. +* **frequency**: 'Hour' | 'Minute' | 'Month' | string (Required): Enumerates possible frequency option for the tumbling window trigger. +* **interval**: int (Required): The interval of the time windows. The minimum interval allowed is 15 Minutes. +* **maxConcurrency**: int (Required): The max number of parallel time windows (ready for execution) for which a new run is triggered. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Execution policy for an activity. +* **startTime**: string (Required): 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. -## TriggerPipelineReference +## TwilioLinkedServiceTypeProperties ### Properties -* **parameters**: [ParameterValueSpecification](#parametervaluespecification): An object mapping parameter names to argument values. -* **pipelineReference**: [PipelineReference](#pipelinereference): Pipeline reference type. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **userName**: any (Required): Any object -## ParameterValueSpecification +## UntilActivityTypeProperties +### Properties +* **activities**: [Activity](#activity)[] (Required): List of activities to execute. +* **expression**: [Expression](#expression) (Required): Azure Data Factory expression definition. +* **timeout**: any: Any object + +## UserAssignedIdentitiesDefinitionSpecification ### Properties ### Additional Properties * **Additional Properties Type**: any -## ChainingTriggerTypeProperties +## UserProperty ### Properties -* **dependsOn**: [PipelineReference](#pipelinereference)[] (Required): Upstream Pipelines. -* **runDimension**: string (Required): Run Dimension property that needs to be emitted by upstream pipelines. +* **name**: string (Required): User property name. +* **value**: any (Required): Any object -## CustomEventsTriggerTypeProperties +## ValidationActivityTypeProperties ### Properties -* **events**: any[] (Required): The list of event types that cause this trigger to fire. -* **scope**: string (Required): The ARM resource ID of the Azure Event Grid Topic. -* **subjectBeginsWith**: string: The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. -* **subjectEndsWith**: string: The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. +* **childItems**: any: Any object +* **dataset**: [DatasetReference](#datasetreference) (Required): Dataset reference type. +* **minimumSize**: any: Any object +* **sleep**: any: Any object +* **timeout**: any: Any object -## RerunTumblingWindowTriggerTypeProperties +## VariableDefinitionSpecification ### Properties -* **parentTrigger**: any (Required): Any object -* **requestedEndTime**: string (Required): The end time for the time period for which restatement is initiated. Only UTC time is currently supported. -* **requestedStartTime**: string (Required): The start time for the time period for which restatement is initiated. Only UTC time is currently supported. -* **rerunConcurrency**: int (Required): The max number of parallel time windows (ready for execution) for which a rerun is triggered. +### Additional Properties +* **Additional Properties Type**: [VariableSpecification](#variablespecification) -## ScheduleTriggerTypeProperties +## VariableSpecification ### Properties -* **recurrence**: [ScheduleTriggerRecurrence](#scheduletriggerrecurrence) (Required): The workflow trigger recurrence. +* **defaultValue**: any: Any object +* **type**: 'Array' | 'Bool' | 'String' | string (Required): Variable type. -## ScheduleTriggerRecurrence +## VerticaDatasetTypeProperties ### Properties -* **endTime**: string: The end time. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Week' | 'Year' | string: Enumerates possible frequency option for the schedule trigger. -* **interval**: int: The interval. -* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. -* **startTime**: string: The start time. -* **timeZone**: string: The time zone. -### Additional Properties -* **Additional Properties Type**: any +* **schema**: any: Any object +* **table**: any: Any object +* **tableName**: any: Any object -## RecurrenceSchedule +## VerticaLinkedServiceTypeProperties ### Properties -* **hours**: int[]: The hours. -* **minutes**: int[]: The minutes. -* **monthDays**: int[]: The month days. -* **monthlyOccurrences**: [RecurrenceScheduleOccurrence](#recurrencescheduleoccurrence)[]: The monthly occurrences. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The days of the week. -### Additional Properties -* **Additional Properties Type**: any +* **connectionString**: any: Any object +* **encryptedCredential**: any: Any object +* **pwd**: [AzureKeyVaultSecretReference](#azurekeyvaultsecretreference): Azure Key Vault secret reference. -## RecurrenceScheduleOccurrence +## WaitActivityTypeProperties ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': The days of the week. -* **occurrence**: int: The occurrence. -### Additional Properties -* **Additional Properties Type**: any +* **waitTimeInSeconds**: any (Required): Any object -## TumblingWindowTriggerTypeProperties +## WebActivityAuthentication ### Properties -* **delay**: any: Any object -* **dependsOn**: [DependencyReference](#dependencyreference)[]: Triggers that this trigger depends on. Only tumbling window triggers are supported. -* **endTime**: 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. -* **frequency**: 'Hour' | 'Minute' | 'Month' | string (Required): Enumerates possible frequency option for the tumbling window trigger. -* **interval**: int (Required): The interval of the time windows. The minimum interval allowed is 15 Minutes. -* **maxConcurrency**: int (Required): The max number of parallel time windows (ready for execution) for which a new run is triggered. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Execution policy for an activity. -* **startTime**: string (Required): 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. +* **credential**: [CredentialReference](#credentialreference): Credential reference type. +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **pfx**: [SecretBase](#secretbase): The base definition of a secret type. +* **resource**: any: Any object +* **type**: string: Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal) +* **username**: any: Any object +* **userTenant**: any: Any object -## DependencyReference -* **Discriminator**: type +## WebActivityTypeProperties +### Properties +* **authentication**: [WebActivityAuthentication](#webactivityauthentication): Web activity authentication properties. +* **body**: any: Any object +* **connectVia**: [IntegrationRuntimeReference](#integrationruntimereference): Integration runtime reference type. +* **datasets**: [DatasetReference](#datasetreference)[]: List of datasets passed to web endpoint. +* **disableCertValidation**: bool: When set to true, Certificate validation will be disabled. +* **headers**: any: Any object +* **linkedServices**: [LinkedServiceReference](#linkedservicereference)[]: List of linked services passed to web endpoint. +* **method**: 'DELETE' | 'GET' | 'POST' | 'PUT' | string (Required): The list of HTTP methods supported by a WebActivity. +* **url**: any (Required): Any object + +## WebHookActivityTypeProperties +### Properties +* **authentication**: [WebActivityAuthentication](#webactivityauthentication): Web activity authentication properties. +* **body**: any: Any object +* **headers**: any: Any object +* **method**: 'POST' | string (Required): The list of HTTP methods supported by a WebHook activity. +* **reportStatusOnCallBack**: any: Any object +* **timeout**: string: 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])). +* **url**: any (Required): Any object + +## WebLinkedServiceTypeProperties +* **Discriminator**: authenticationType ### Base Properties -### SelfDependencyTumblingWindowTriggerReference +* **url**: any (Required): Any object +### WebAnonymousAuthentication #### Properties -* **offset**: string (Required): Timespan applied to the start time of a tumbling window when evaluating dependency. -* **size**: string: The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. -* **type**: 'SelfDependencyTumblingWindowTriggerReference' (Required): The type of dependency reference. +* **authenticationType**: 'Anonymous' (Required): Type of authentication used to connect to the web table source. -### TumblingWindowTriggerDependencyReference +### WebBasicAuthentication #### Properties -* **offset**: string: Timespan applied to the start time of a tumbling window when evaluating dependency. -* **size**: string: The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. -* **type**: 'TumblingWindowTriggerDependencyReference' (Required): The type of dependency reference. +* **authenticationType**: 'Basic' (Required): Type of authentication used to connect to the web table source. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **username**: any (Required): Any object + +### WebClientCertificateAuthentication +#### Properties +* **authenticationType**: 'ClientCertificate' (Required): Type of authentication used to connect to the web table source. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **pfx**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -## RetryPolicy +## WebTableDatasetTypeProperties ### Properties -* **count**: any: Any object -* **intervalInSeconds**: int: Interval between retries in seconds. Default is 30. +* **index**: any (Required): Any object +* **path**: any: Any object -## IntegrationRuntimeAuthKeys +## XeroLinkedServiceTypeProperties ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +* **connectionProperties**: any: Any object +* **consumerKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **encryptedCredential**: any: Any object +* **host**: any: Any object +* **privateKey**: [SecretBase](#secretbase): The base definition of a secret type. +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object + +## XmlDatasetTypeProperties +### Properties +* **compression**: [DatasetCompression](#datasetcompression): The compression method used on a dataset. +* **encodingName**: any: Any object +* **location**: [DatasetLocation](#datasetlocation) (Required): Dataset location. +* **nullValue**: any: Any object + +## XmlReadSettings +### Properties +* **compressionProperties**: [CompressionReadSettings](#compressionreadsettings): Compression read settings. +* **detectDataType**: any: Any object +* **namespacePrefixes**: any: Any object +* **namespaces**: any: Any object +* **type**: string (Required): The read setting type. +* **validationMode**: any: Any object +### Additional Properties +* **Additional Properties Type**: any + +## ZendeskLinkedServiceTypeProperties +### Properties +* **apiToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **authenticationType**: 'Basic' | 'Token' | string (Required): The authentication type to use. +* **encryptedCredential**: any: Any object +* **password**: [SecretBase](#secretbase): The base definition of a secret type. +* **url**: any (Required): Any object +* **userName**: any: Any object + +## ZohoLinkedServiceTypeProperties +### Properties +* **accessToken**: [SecretBase](#secretbase): The base definition of a secret type. +* **connectionProperties**: any: Any object +* **encryptedCredential**: any: Any object +* **endpoint**: any: Any object +* **useEncryptedEndpoints**: any: Any object +* **useHostVerification**: any: Any object +* **usePeerVerification**: any: Any object diff --git a/generated/datalake-analytics/log.out b/generated/datalake-analytics/log.out index 43ca45fd49..03488a9e45 100644 --- a/generated/datalake-analytics/log.out +++ b/generated/datalake-analytics/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datalakeanalytics-2019-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2019-11-01-preview/account.json:1753:5 @@ -149,12 +149,12 @@ warning | PreCheck/SchemaMissingType | The schema 'UpdateFirewallRuleProperties' warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2019-11-01-preview/account.json:3474:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 18ms info | Processing batch task - {"tag":"microsoft.datalakeanalytics-2016-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json:1753:5 @@ -293,12 +293,12 @@ warning | PreCheck/SchemaMissingType | The schema 'UpdateFirewallRuleProperties' warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json:3469:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.datalakeanalytics-2015-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json:1772:5 @@ -437,5 +437,5 @@ warning | PreCheck/SchemaMissingType | The schema 'UpdateFirewallRuleProperties' warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json:3422:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms -info | Autorest completed in 12.15s. 6 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 11.67s. 6 files generated. diff --git a/generated/datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.md b/generated/datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.md index fcf6a6efa1..a33cb6f5c6 100644 --- a/generated/datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.md +++ b/generated/datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.md @@ -52,6 +52,36 @@ * **ApiVersion**: 2015-10-01-preview * **Output**: [SasTokenInformationListResult](#sastokeninformationlistresult) +## AddDataLakeStoreProperties +### Properties +* **suffix**: string: The optional suffix for the Data Lake Store account. + +## AddDataLakeStoreWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the Data Lake Store account to add. +* **properties**: [AddDataLakeStoreProperties](#adddatalakestoreproperties): The Data Lake Store account properties to use when adding a new Data Lake Store account. +* **type**: string (ReadOnly): The resource type. + +## AddStorageAccountWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the Azure Storage account to add. +* **properties**: [StorageAccountProperties](#storageaccountproperties) (Required): The Azure Storage account properties to use when adding a new Azure Storage account. +* **type**: string (ReadOnly): The resource type. + +## CreateComputePolicyWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the compute policy to create. +* **properties**: [CreateOrUpdateComputePolicyProperties](#createorupdatecomputepolicyproperties) (Required): The compute policy properties to use when creating a new compute policy. +* **type**: string (ReadOnly): The resource type. + +## CreateDataLakeAnalyticsAccountParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## CreateDataLakeAnalyticsAccountProperties ### Properties * **accountId**: string (ReadOnly): The unique identifier associated with this Data Lake Analytics account. @@ -82,11 +112,11 @@ * **systemMaxJobCount**: int (ReadOnly): The system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[] (ReadOnly): The list of virtualNetwork rules associated with this account. -## CreateComputePolicyWithAccountParameters +## CreateFirewallRuleWithAccountParameters ### Properties * **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the compute policy to create. -* **properties**: [CreateOrUpdateComputePolicyProperties](#createorupdatecomputepolicyproperties) (Required): The compute policy properties to use when creating a new compute policy. +* **name**: string (Required): The unique name of the firewall rule to create. +* **properties**: [CreateOrUpdateFirewallRuleProperties](#createorupdatefirewallruleproperties) (Required): The firewall rule properties to use when creating a new firewall rule. * **type**: string (ReadOnly): The resource type. ## CreateOrUpdateComputePolicyProperties @@ -96,29 +126,22 @@ * **objectId**: string (Required): The AAD object identifier for the entity to create a policy for. * **objectType**: 'Group' | 'ServicePrincipal' | 'User' | string (Required): The type of AAD object the object identifier refers to. -## AddDataLakeStoreWithAccountParameters +## CreateOrUpdateFirewallRuleProperties ### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the Data Lake Store account to add. -* **properties**: [AddDataLakeStoreProperties](#adddatalakestoreproperties): The Data Lake Store account properties to use when adding a new Data Lake Store account. -* **type**: string (ReadOnly): The resource type. +* **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. +* **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. -## AddDataLakeStoreProperties +## DataLakeStoreAccountInfoProperties ### Properties -* **suffix**: string: The optional suffix for the Data Lake Store account. +* **suffix**: string (ReadOnly): The optional suffix for the Data Lake Store account. -## CreateFirewallRuleWithAccountParameters +## DataLakeStoreAccountInformation ### Properties * **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the firewall rule to create. -* **properties**: [CreateOrUpdateFirewallRuleProperties](#createorupdatefirewallruleproperties) (Required): The firewall rule properties to use when creating a new firewall rule. +* **name**: string (ReadOnly): The resource name. +* **properties**: [DataLakeStoreAccountInfoProperties](#datalakestoreaccountinfoproperties) (ReadOnly): The Data Lake Store account properties. * **type**: string (ReadOnly): The resource type. -## CreateOrUpdateFirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. -* **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. - ## HiveMetastore ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -135,23 +158,14 @@ * **serverUri**: string (ReadOnly): The serverUri for the Hive MetaStore * **userName**: string (ReadOnly): The userName for the Hive MetaStore -## DataLakeStoreAccountInformation -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (ReadOnly): The resource name. -* **properties**: [DataLakeStoreAccountInfoProperties](#datalakestoreaccountinfoproperties) (ReadOnly): The Data Lake Store account properties. -* **type**: string (ReadOnly): The resource type. - -## DataLakeStoreAccountInfoProperties +## SasTokenInformation ### Properties -* **suffix**: string (ReadOnly): The optional suffix for the Data Lake Store account. +* **accessToken**: string (ReadOnly): The access token for the associated Azure Storage Container. -## AddStorageAccountWithAccountParameters +## SasTokenInformationListResult ### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the Azure Storage account to add. -* **properties**: [StorageAccountProperties](#storageaccountproperties) (Required): The Azure Storage account properties to use when adding a new Azure Storage account. -* **type**: string (ReadOnly): The resource type. +* **nextLink**: string (ReadOnly): The link (url) to the next page of results. +* **value**: [SasTokenInformation](#sastokeninformation)[] (ReadOnly): The results of the list operation. ## StorageAccountProperties ### Properties @@ -170,17 +184,3 @@ * **subnetId**: string (ReadOnly): The resource identifier for the subnet * **virtualNetworkRuleState**: 'Active' | 'Failed' | 'NetworkSourceDeleted' (ReadOnly): The current state of the VirtualNetworkRule for this account. -## CreateDataLakeAnalyticsAccountParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SasTokenInformationListResult -### Properties -* **nextLink**: string (ReadOnly): The link (url) to the next page of results. -* **value**: [SasTokenInformation](#sastokeninformation)[] (ReadOnly): The results of the list operation. - -## SasTokenInformation -### Properties -* **accessToken**: string (ReadOnly): The access token for the associated Azure Storage Container. - diff --git a/generated/datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.md b/generated/datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.md index 630280a629..d33eaae3f7 100644 --- a/generated/datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.md +++ b/generated/datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.md @@ -52,6 +52,41 @@ * **ApiVersion**: 2016-11-01 * **Output**: [SasTokenInformationListResult](#sastokeninformationlistresult) +## AddDataLakeStoreProperties +### Properties +* **suffix**: string: The optional suffix for the Data Lake Store account. + +## AddDataLakeStoreWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the Data Lake Store account to add. +* **properties**: [AddDataLakeStoreProperties](#adddatalakestoreproperties): The Data Lake Store account properties to use when adding a new Data Lake Store account. +* **type**: string (ReadOnly): The resource type. + +## AddStorageAccountProperties +### Properties +* **accessKey**: string (Required, WriteOnly): The access key associated with this Azure Storage account that will be used to connect to it. +* **suffix**: string: The optional suffix for the storage account. + +## AddStorageAccountWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the Azure Storage account to add. +* **properties**: [AddStorageAccountProperties](#addstorageaccountproperties) (Required): The Azure Storage account properties to use when adding a new Azure Storage account. +* **type**: string (ReadOnly): The resource type. + +## CreateComputePolicyWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the compute policy to create. +* **properties**: [CreateOrUpdateComputePolicyProperties](#createorupdatecomputepolicyproperties) (Required): The compute policy properties to use when creating a new compute policy. +* **type**: string (ReadOnly): The resource type. + +## CreateDataLakeAnalyticsAccountParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## CreateDataLakeAnalyticsAccountProperties ### Properties * **accountId**: string (ReadOnly): The unique identifier associated with this Data Lake Analytics account. @@ -84,11 +119,11 @@ * **systemMaxJobCount**: int (ReadOnly): The system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[] (ReadOnly): The list of virtualNetwork rules associated with this account. -## CreateComputePolicyWithAccountParameters +## CreateFirewallRuleWithAccountParameters ### Properties * **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the compute policy to create. -* **properties**: [CreateOrUpdateComputePolicyProperties](#createorupdatecomputepolicyproperties) (Required): The compute policy properties to use when creating a new compute policy. +* **name**: string (Required): The unique name of the firewall rule to create. +* **properties**: [CreateOrUpdateFirewallRuleProperties](#createorupdatefirewallruleproperties) (Required): The firewall rule properties to use when creating a new firewall rule. * **type**: string (ReadOnly): The resource type. ## CreateOrUpdateComputePolicyProperties @@ -98,28 +133,21 @@ * **objectId**: string (Required): The AAD object identifier for the entity to create a policy for. * **objectType**: 'Group' | 'ServicePrincipal' | 'User' | string (Required): The type of AAD object the object identifier refers to. -## AddDataLakeStoreWithAccountParameters -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the Data Lake Store account to add. -* **properties**: [AddDataLakeStoreProperties](#adddatalakestoreproperties): The Data Lake Store account properties to use when adding a new Data Lake Store account. -* **type**: string (ReadOnly): The resource type. - -## AddDataLakeStoreProperties +## CreateOrUpdateFirewallRuleProperties ### Properties -* **suffix**: string: The optional suffix for the Data Lake Store account. +* **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. +* **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. -## CreateFirewallRuleWithAccountParameters +## DataLakeStoreAccountInformation ### Properties * **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the firewall rule to create. -* **properties**: [CreateOrUpdateFirewallRuleProperties](#createorupdatefirewallruleproperties) (Required): The firewall rule properties to use when creating a new firewall rule. +* **name**: string (ReadOnly): The resource name. +* **properties**: [DataLakeStoreAccountInformationProperties](#datalakestoreaccountinformationproperties) (ReadOnly): The Data Lake Store account properties. * **type**: string (ReadOnly): The resource type. -## CreateOrUpdateFirewallRuleProperties +## DataLakeStoreAccountInformationProperties ### Properties -* **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. -* **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. +* **suffix**: string (ReadOnly): The optional suffix for the Data Lake Store account. ## HiveMetastore ### Properties @@ -137,28 +165,14 @@ * **serverUri**: string (ReadOnly): The serverUri for the Hive MetaStore * **userName**: string (ReadOnly): The userName for the Hive MetaStore -## DataLakeStoreAccountInformation -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (ReadOnly): The resource name. -* **properties**: [DataLakeStoreAccountInformationProperties](#datalakestoreaccountinformationproperties) (ReadOnly): The Data Lake Store account properties. -* **type**: string (ReadOnly): The resource type. - -## DataLakeStoreAccountInformationProperties -### Properties -* **suffix**: string (ReadOnly): The optional suffix for the Data Lake Store account. - -## AddStorageAccountWithAccountParameters +## SasTokenInformation ### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the Azure Storage account to add. -* **properties**: [AddStorageAccountProperties](#addstorageaccountproperties) (Required): The Azure Storage account properties to use when adding a new Azure Storage account. -* **type**: string (ReadOnly): The resource type. +* **accessToken**: string (ReadOnly): The access token for the associated Azure Storage Container. -## AddStorageAccountProperties +## SasTokenInformationListResult ### Properties -* **accessKey**: string (Required, WriteOnly): The access key associated with this Azure Storage account that will be used to connect to it. -* **suffix**: string: The optional suffix for the storage account. +* **nextLink**: string (ReadOnly): The link (url) to the next page of results. +* **value**: [SasTokenInformation](#sastokeninformation)[] (ReadOnly): The results of the list operation. ## VirtualNetworkRule ### Properties @@ -172,17 +186,3 @@ * **subnetId**: string (ReadOnly): The resource identifier for the subnet * **virtualNetworkRuleState**: 'Active' | 'Failed' | 'NetworkSourceDeleted' (ReadOnly): The current state of the VirtualNetworkRule for this account. -## CreateDataLakeAnalyticsAccountParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SasTokenInformationListResult -### Properties -* **nextLink**: string (ReadOnly): The link (url) to the next page of results. -* **value**: [SasTokenInformation](#sastokeninformation)[] (ReadOnly): The results of the list operation. - -## SasTokenInformation -### Properties -* **accessToken**: string (ReadOnly): The access token for the associated Azure Storage Container. - diff --git a/generated/datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.md b/generated/datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.md index 43ed42a4d1..98f6d10e32 100644 --- a/generated/datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.md +++ b/generated/datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.md @@ -52,6 +52,41 @@ * **ApiVersion**: 2019-11-01-preview * **Output**: [SasTokenInformationListResult](#sastokeninformationlistresult) +## AddDataLakeStoreProperties +### Properties +* **suffix**: string: The optional suffix for the Data Lake Store account. + +## AddDataLakeStoreWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the Data Lake Store account to add. +* **properties**: [AddDataLakeStoreProperties](#adddatalakestoreproperties): The Data Lake Store account properties to use when adding a new Data Lake Store account. +* **type**: string (ReadOnly): The resource type. + +## AddStorageAccountProperties +### Properties +* **accessKey**: string (Required, WriteOnly): The access key associated with this Azure Storage account that will be used to connect to it. +* **suffix**: string: The optional suffix for the storage account. + +## AddStorageAccountWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the Azure Storage account to add. +* **properties**: [AddStorageAccountProperties](#addstorageaccountproperties) (Required): The Azure Storage account properties to use when adding a new Azure Storage account. +* **type**: string (ReadOnly): The resource type. + +## CreateComputePolicyWithAccountParameters +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (Required): The unique name of the compute policy to create. +* **properties**: [CreateOrUpdateComputePolicyProperties](#createorupdatecomputepolicyproperties) (Required): The compute policy properties to use when creating a new compute policy. +* **type**: string (ReadOnly): The resource type. + +## CreateDataLakeAnalyticsAccountParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## CreateDataLakeAnalyticsAccountProperties ### Properties * **accountId**: string (ReadOnly): The unique identifier associated with this Data Lake Analytics account. @@ -85,11 +120,11 @@ * **systemMaxJobCount**: int (ReadOnly): The system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[] (ReadOnly): The list of virtualNetwork rules associated with this account. -## CreateComputePolicyWithAccountParameters +## CreateFirewallRuleWithAccountParameters ### Properties * **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the compute policy to create. -* **properties**: [CreateOrUpdateComputePolicyProperties](#createorupdatecomputepolicyproperties) (Required): The compute policy properties to use when creating a new compute policy. +* **name**: string (Required): The unique name of the firewall rule to create. +* **properties**: [CreateOrUpdateFirewallRuleProperties](#createorupdatefirewallruleproperties) (Required): The firewall rule properties to use when creating a new firewall rule. * **type**: string (ReadOnly): The resource type. ## CreateOrUpdateComputePolicyProperties @@ -99,28 +134,21 @@ * **objectId**: string (Required): The AAD object identifier for the entity to create a policy for. * **objectType**: 'Group' | 'ServicePrincipal' | 'User' | string (Required): The type of AAD object the object identifier refers to. -## AddDataLakeStoreWithAccountParameters -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the Data Lake Store account to add. -* **properties**: [AddDataLakeStoreProperties](#adddatalakestoreproperties): The Data Lake Store account properties to use when adding a new Data Lake Store account. -* **type**: string (ReadOnly): The resource type. - -## AddDataLakeStoreProperties +## CreateOrUpdateFirewallRuleProperties ### Properties -* **suffix**: string: The optional suffix for the Data Lake Store account. +* **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. +* **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. -## CreateFirewallRuleWithAccountParameters +## DataLakeStoreAccountInformation ### Properties * **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the firewall rule to create. -* **properties**: [CreateOrUpdateFirewallRuleProperties](#createorupdatefirewallruleproperties) (Required): The firewall rule properties to use when creating a new firewall rule. +* **name**: string (ReadOnly): The resource name. +* **properties**: [DataLakeStoreAccountInformationProperties](#datalakestoreaccountinformationproperties) (ReadOnly): The Data Lake Store account properties. * **type**: string (ReadOnly): The resource type. -## CreateOrUpdateFirewallRuleProperties +## DataLakeStoreAccountInformationProperties ### Properties -* **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. -* **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. +* **suffix**: string (ReadOnly): The optional suffix for the Data Lake Store account. ## HiveMetastore ### Properties @@ -138,28 +166,14 @@ * **serverUri**: string (ReadOnly): The serverUri for the Hive MetaStore * **userName**: string (ReadOnly): The userName for the Hive MetaStore -## DataLakeStoreAccountInformation -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (ReadOnly): The resource name. -* **properties**: [DataLakeStoreAccountInformationProperties](#datalakestoreaccountinformationproperties) (ReadOnly): The Data Lake Store account properties. -* **type**: string (ReadOnly): The resource type. - -## DataLakeStoreAccountInformationProperties -### Properties -* **suffix**: string (ReadOnly): The optional suffix for the Data Lake Store account. - -## AddStorageAccountWithAccountParameters +## SasTokenInformation ### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (Required): The unique name of the Azure Storage account to add. -* **properties**: [AddStorageAccountProperties](#addstorageaccountproperties) (Required): The Azure Storage account properties to use when adding a new Azure Storage account. -* **type**: string (ReadOnly): The resource type. +* **accessToken**: string (ReadOnly): The access token for the associated Azure Storage Container. -## AddStorageAccountProperties +## SasTokenInformationListResult ### Properties -* **accessKey**: string (Required, WriteOnly): The access key associated with this Azure Storage account that will be used to connect to it. -* **suffix**: string: The optional suffix for the storage account. +* **nextLink**: string (ReadOnly): The link (url) to the next page of results. +* **value**: [SasTokenInformation](#sastokeninformation)[] (ReadOnly): The results of the list operation. ## VirtualNetworkRule ### Properties @@ -173,17 +187,3 @@ * **subnetId**: string (ReadOnly): The resource identifier for the subnet * **virtualNetworkRuleState**: 'Active' | 'Failed' | 'NetworkSourceDeleted' (ReadOnly): The current state of the VirtualNetworkRule for this account. -## CreateDataLakeAnalyticsAccountParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SasTokenInformationListResult -### Properties -* **nextLink**: string (ReadOnly): The link (url) to the next page of results. -* **value**: [SasTokenInformation](#sastokeninformation)[] (ReadOnly): The results of the list operation. - -## SasTokenInformation -### Properties -* **accessToken**: string (ReadOnly): The access token for the associated Azure Storage Container. - diff --git a/generated/datalake-store/log.out b/generated/datalake-store/log.out index f12062cd1d..0a8041c2f9 100644 --- a/generated/datalake-store/log.out +++ b/generated/datalake-store/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datalakestore-2016-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/account.json:1240:5 @@ -117,12 +117,12 @@ warning | PreCheck/SchemaMissingType | The schema 'UpdateTrustedIdProviderProper warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/account.json:2492:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.datalakestore-2015-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FirewallRuleProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json:655:5 @@ -152,4 +152,4 @@ warning | PreCheck/SchemaMissingType | The schema 'AzureAsyncOperationResult' wi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json:998:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 7.07s. 4 files generated. +info | Autorest completed in 6.85s. 4 files generated. diff --git a/generated/datalake-store/microsoft.datalakestore/2015-10-01-preview/types.md b/generated/datalake-store/microsoft.datalakestore/2015-10-01-preview/types.md index 9444f2172e..727be477b0 100644 --- a/generated/datalake-store/microsoft.datalakestore/2015-10-01-preview/types.md +++ b/generated/datalake-store/microsoft.datalakestore/2015-10-01-preview/types.md @@ -22,12 +22,6 @@ * **properties**: [FirewallRuleProperties](#firewallruleproperties): Data Lake Store firewall rule properties information * **type**: 'Microsoft.DataLakeStore/accounts/firewallRules' (ReadOnly, DeployTimeConstant): The resource type -## EncryptionIdentity -### Properties -* **principalId**: string (ReadOnly): The principal identifier associated with the encryption. -* **tenantId**: string (ReadOnly): The tenant identifier associated with the encryption. -* **type**: 'SystemAssigned': The type of encryption being used. Currently the only supported type is 'SystemAssigned'. - ## DataLakeStoreAccountProperties ### Properties * **creationTime**: string (ReadOnly): the account creation time. @@ -40,24 +34,30 @@ * **provisioningState**: 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Patching' | 'Resuming' | 'Running' | 'Succeeded' | 'Suspending' (ReadOnly): the status of the Data Lake Store account while being provisioned. * **state**: 'active' | 'suspended' (ReadOnly): the status of the Data Lake Store account after provisioning has completed. +## DataLakeStoreAccountTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## EncryptionConfig ### Properties * **keyVaultMetaInfo**: [KeyVaultMetaInfo](#keyvaultmetainfo) * **type**: 'ServiceManaged' | 'UserManaged': The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. -## KeyVaultMetaInfo -### Properties -* **encryptionKeyName**: string: The name of the user managed encryption key. -* **encryptionKeyVersion**: string: The version of the user managed encryption key. -* **keyVaultResourceId**: string: The resource identifier for the user managed Key Vault being used to encrypt. - -## DataLakeStoreAccountTags +## EncryptionIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal identifier associated with the encryption. +* **tenantId**: string (ReadOnly): The tenant identifier associated with the encryption. +* **type**: 'SystemAssigned': The type of encryption being used. Currently the only supported type is 'SystemAssigned'. ## FirewallRuleProperties ### Properties * **endIpAddress**: string: the end IP address for the firewall rule. * **startIpAddress**: string: the start IP address for the firewall rule. +## KeyVaultMetaInfo +### Properties +* **encryptionKeyName**: string: The name of the user managed encryption key. +* **encryptionKeyVersion**: string: The version of the user managed encryption key. +* **keyVaultResourceId**: string: The resource identifier for the user managed Key Vault being used to encrypt. + diff --git a/generated/datalake-store/microsoft.datalakestore/2016-11-01/types.md b/generated/datalake-store/microsoft.datalakestore/2016-11-01/types.md index fc0f648c4c..59d6bcde17 100644 --- a/generated/datalake-store/microsoft.datalakestore/2016-11-01/types.md +++ b/generated/datalake-store/microsoft.datalakestore/2016-11-01/types.md @@ -39,11 +39,10 @@ * **properties**: [CreateOrUpdateVirtualNetworkRuleProperties](#createorupdatevirtualnetworkruleproperties) (Required): The virtual network rule properties to use when creating a new virtual network rule. * **type**: 'Microsoft.DataLakeStore/accounts/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type -## EncryptionIdentity +## CreateDataLakeStoreAccountParametersTags ### Properties -* **principalId**: string (ReadOnly): The principal identifier associated with the encryption. -* **tenantId**: string (ReadOnly): The tenant identifier associated with the encryption. -* **type**: 'SystemAssigned' (Required): The type of encryption being used. Currently the only supported type is 'SystemAssigned'. +### Additional Properties +* **Additional Properties Type**: string ## CreateDataLakeStoreAccountProperties ### Properties @@ -66,17 +65,6 @@ * **trustedIdProviderState**: 'Disabled' | 'Enabled': The current state of the trusted identity provider feature for this Data Lake Store account. * **virtualNetworkRules**: [CreateVirtualNetworkRuleWithAccountParameters](#createvirtualnetworkrulewithaccountparameters)[]: The list of virtual network rules associated with this Data Lake Store account. -## EncryptionConfig -### Properties -* **keyVaultMetaInfo**: [KeyVaultMetaInfo](#keyvaultmetainfo): Metadata information used by account encryption. -* **type**: 'ServiceManaged' | 'UserManaged' (Required): The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. - -## KeyVaultMetaInfo -### Properties -* **encryptionKeyName**: string (Required): The name of the user managed encryption key. -* **encryptionKeyVersion**: string (Required): The version of the user managed encryption key. -* **keyVaultResourceId**: string (Required): The resource identifier for the user managed Key Vault being used to encrypt. - ## CreateFirewallRuleWithAccountParameters ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -89,6 +77,14 @@ * **endIpAddress**: string (Required): The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. * **startIpAddress**: string (Required): The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. +## CreateOrUpdateTrustedIdProviderProperties +### Properties +* **idProvider**: string (Required): The URL of this trusted identity provider. + +## CreateOrUpdateVirtualNetworkRuleProperties +### Properties +* **subnetId**: string (Required): The resource identifier for the subnet. + ## CreateTrustedIdProviderWithAccountParameters ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -96,10 +92,6 @@ * **properties**: [CreateOrUpdateTrustedIdProviderProperties](#createorupdatetrustedidproviderproperties) (Required): The trusted identity provider properties to use when creating a new trusted identity provider. * **type**: string (ReadOnly): The resource type. -## CreateOrUpdateTrustedIdProviderProperties -### Properties -* **idProvider**: string (Required): The URL of this trusted identity provider. - ## CreateVirtualNetworkRuleWithAccountParameters ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -107,12 +99,20 @@ * **properties**: [CreateOrUpdateVirtualNetworkRuleProperties](#createorupdatevirtualnetworkruleproperties) (Required): The virtual network rule properties to use when creating a new virtual network rule. * **type**: string (ReadOnly): The resource type. -## CreateOrUpdateVirtualNetworkRuleProperties +## EncryptionConfig ### Properties -* **subnetId**: string (Required): The resource identifier for the subnet. +* **keyVaultMetaInfo**: [KeyVaultMetaInfo](#keyvaultmetainfo): Metadata information used by account encryption. +* **type**: 'ServiceManaged' | 'UserManaged' (Required): The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. -## CreateDataLakeStoreAccountParametersTags +## EncryptionIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal identifier associated with the encryption. +* **tenantId**: string (ReadOnly): The tenant identifier associated with the encryption. +* **type**: 'SystemAssigned' (Required): The type of encryption being used. Currently the only supported type is 'SystemAssigned'. + +## KeyVaultMetaInfo +### Properties +* **encryptionKeyName**: string (Required): The name of the user managed encryption key. +* **encryptionKeyVersion**: string (Required): The version of the user managed encryption key. +* **keyVaultResourceId**: string (Required): The resource identifier for the user managed Key Vault being used to encrypt. diff --git a/generated/datamigration/log.out b/generated/datamigration/log.out index d7cbbb0d50..5da2bef0ab 100644 --- a/generated/datamigration/log.out +++ b/generated/datamigration/log.out @@ -27,7 +27,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datamigration-2022-03-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -54,7 +54,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/definitions/Common.json:181:5 @@ -82,7 +82,7 @@ warning | Modeler/MissingType | The schema 'components·1n054gc·schemas·migrat file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json#/components/schemas/components·1n054gc·schemas·migratepostgresqlazuredbforpostgresqlsyncdatabaseinput·properties·migrationsetting·additionalproperties warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 63ms +info | autorest.bicep took 61ms info | Processing batch task - {"tag":"microsoft.datamigration-2022-01-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -109,7 +109,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-01-30-preview/definitions/Common.json:181:5 @@ -137,7 +137,7 @@ warning | Modeler/MissingType | The schema 'components·1n054gc·schemas·migrat file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-01-30-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json#/components/schemas/components·1n054gc·schemas·migratepostgresqlazuredbforpostgresqlsyncdatabaseinput·properties·migrationsetting·additionalproperties warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 44ms +info | autorest.bicep took 62ms info | Processing batch task - {"tag":"microsoft.datamigration-2021-10-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -164,7 +164,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2021-10-30-preview/definitions/Common.json:181:5 @@ -217,7 +217,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2021-06-30/definitions/Common.json:181:5 @@ -234,7 +234,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMIT warning | PreCheck/PropertyRedeclarationWarning | Schema 'Project' has a property 'systemData' that is already declared the parent schema 'TrackedResource' but isn't significantly different. The property has been removed from Project warning | PreCheck/PropertyRedeclarationWarning | Schema 'DataMigrationService' has a property 'systemData' that is already declared the parent schema 'TrackedResource' but isn't significantly different. The property has been removed from DataMigrationService warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateMySqlAzureDbForMySqlOfflineTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateMySqlAzureDbForMySqlOfflineTaskOutput' but isn't significantly different. The property has been removed from MigrateMySqlAzureDbForMySqlOfflineTaskOutputError -info | autorest.bicep took 29ms +info | autorest.bicep took 65ms info | Processing batch task - {"tag":"microsoft.datamigration-2018-04-19"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -261,7 +261,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json:187:5 @@ -277,7 +277,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlDbTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlDbTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlDbTaskOutputError warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMITaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlMITaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlMITaskOutputError warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMISyncTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlMISyncTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlMISyncTaskOutputError -info | autorest.bicep took 17ms +info | autorest.bicep took 31ms info | Processing batch task - {"tag":"microsoft.datamigration-2018-07-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -304,7 +304,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json:176:5 @@ -320,7 +320,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlDbTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlDbTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlDbTaskOutputError warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMISyncTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlMISyncTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlMISyncTaskOutputError warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMITaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlMITaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlMITaskOutputError -info | autorest.bicep took 37ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.datamigration-2018-03-31-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -347,7 +347,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Common.json:172:5 @@ -362,7 +362,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkusResult' with an u warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlDbTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlDbTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlDbTaskOutputError warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMITaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlMITaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlMITaskOutputError -info | autorest.bicep took 9ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.datamigration-2018-03-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -389,7 +389,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/Common.json:172:5 @@ -404,7 +404,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkusResult' with an u warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlDbTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlDbTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlDbTaskOutputError warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlMITaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlMITaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlMITaskOutputError -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.datamigration-2017-11-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -431,7 +431,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Common.json:172:5 @@ -445,5 +445,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkuRestrictions' with warning | PreCheck/SchemaMissingType | The schema 'ResourceSkusResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'MigrateSqlServerSqlDbTaskOutputError' has a property 'id' that is already declared the parent schema 'MigrateSqlServerSqlDbTaskOutput' but isn't significantly different. The property has been removed from MigrateSqlServerSqlDbTaskOutputError -info | autorest.bicep took 5ms -info | Autorest completed in 66.59s. 18 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 65.55s. 18 files generated. diff --git a/generated/datamigration/microsoft.datamigration/2017-11-15-preview/types.md b/generated/datamigration/microsoft.datamigration/2017-11-15-preview/types.md index da7efdceed..1c6dccb3f4 100644 --- a/generated/datamigration/microsoft.datamigration/2017-11-15-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2017-11-15-preview/types.md @@ -35,39 +35,6 @@ * **properties**: [ProjectTaskProperties](#projecttaskproperties): Base class for all types of DMS task properties. If task is not supported by current client, this object is returned. * **type**: 'Microsoft.DataMigration/services/projects/tasks' (ReadOnly, DeployTimeConstant): The resource type -## DataMigrationServiceProperties -### Properties -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined - -## ServiceSku -### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectProperties -### Properties -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'SQL' | 'Unknown' (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'SQLDB' | 'Unknown' (Required): Target platform of the project - -## DatabaseInfo -### Properties -* **sourceDatabaseName**: string (Required): Name of the database - ## ConnectionInfo * **Discriminator**: type @@ -84,64 +51,11 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectTaskProperties -* **Discriminator**: taskType - -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. - -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. - - -## ODataError -### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error - ## ConnectToSourceSqlServerTaskInput ### Properties * **checkPermissionsGroup**: 'Default' | 'MigrationFromSqlServerToAzureDB': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## SqlConnectionInfo -### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication': An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name - ## ConnectToSourceSqlServerTaskOutput * **Discriminator**: resultType @@ -165,6 +79,17 @@ * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +## ConnectToTargetSqlDbTaskInput +### Properties +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## ConnectToTargetSqlDbTaskOutput +### Properties +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server + ## DatabaseFileInfo ### Properties * **databaseName**: string: Name of the database @@ -175,24 +100,15 @@ * **restoreFullName**: string: Suggested full path of the file for restoring * **sizeMB**: int: Size of the file in megabytes -## ReportableException -### Properties -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace - -## ConnectToTargetSqlDbTaskInput +## DatabaseInfo ### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **sourceDatabaseName**: string (Required): Name of the database -## ConnectToTargetSqlDbTaskOutput +## DataMigrationServiceProperties ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ## GetUserTablesSqlTaskInput ### Properties @@ -205,13 +121,6 @@ * **id**: string (ReadOnly): Result identifier * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrateSqlServerSqlDbTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration - ## MigrateSqlServerSqlDbDatabaseInput ### Properties * **makeSourceDbReadOnly**: bool: Whether to set database read only before migration @@ -224,11 +133,12 @@ ### Additional Properties * **Additional Properties Type**: string -## MigrationValidationOptions +## MigrateSqlServerSqlDbTaskInput ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration ## MigrateSqlServerSqlDbTaskOutput * **Discriminator**: resultType @@ -295,3 +205,93 @@ * **id**: string: Migration validation result identifier * **reportUrl**: string: The url of the report. +## MigrationValidationOptions +### Properties +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. + +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error + +## ProjectProperties +### Properties +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'SQL' | 'Unknown' (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'SQLDB' | 'Unknown' (Required): Target platform of the project + +## ProjectTaskProperties +* **Discriminator**: taskType + +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToSourceSqlServerTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. + +### ConnectToTargetSqlDbTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. + +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. + +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. + + +## ReportableException +### Properties +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace + +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' + +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication': An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/datamigration/microsoft.datamigration/2018-03-15-preview/types.md b/generated/datamigration/microsoft.datamigration/2018-03-15-preview/types.md index e794447a37..4d09e28a0c 100644 --- a/generated/datamigration/microsoft.datamigration/2018-03-15-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2018-03-15-preview/types.md @@ -35,38 +35,9 @@ * **properties**: [ProjectTaskProperties](#projecttaskproperties): Base class for all types of DMS task properties. If task is not supported by current client, this object is returned. * **type**: 'Microsoft.DataMigration/services/projects/tasks' (ReadOnly, DeployTimeConstant): The resource type -## DataMigrationServiceProperties -### Properties -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined - -## ServiceSku -### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectProperties -### Properties -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'SQLDB' | 'Unknown' | string (Required): Target platform of the project - -## DatabaseInfo +## BlobShare ### Properties -* **sourceDatabaseName**: string (Required): Name of the database +* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. ## ConnectionInfo * **Discriminator**: type @@ -84,82 +55,11 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectTaskProperties -* **Discriminator**: taskType - -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. - -### ConnectToTargetSqlMITaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. - -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. - -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. - -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. - - -## ODataError -### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error - ## ConnectToSourceSqlServerTaskInput ### Properties * **checkPermissionsGroup**: 'Default' | 'MigrationFromSqlServerToAzureDB' | string: Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## SqlConnectionInfo -### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name - ## ConnectToSourceSqlServerTaskOutput * **Discriminator**: resultType @@ -183,35 +83,6 @@ * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## DatabaseFileInfo -### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes - -## ReportableException -### Properties -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace - -## ConnectToTargetSqlMITaskInput -### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server - -## ConnectToTargetSqlMITaskOutput -### Properties -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - ## ConnectToTargetSqlDbTaskInput ### Properties * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server @@ -223,28 +94,36 @@ * **targetServerBrandVersion**: string (ReadOnly): Target server brand version * **targetServerVersion**: string (ReadOnly): Version of the target server -## GetUserTablesSqlTaskInput +## ConnectToTargetSqlMITaskInput ### Properties -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## GetUserTablesSqlTaskOutput +## ConnectToTargetSqlMITaskOutput ### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables * **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrateSqlServerSqlMITaskInput +## DatabaseFileInfo ### Properties -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -## BlobShare +## DatabaseInfo ### Properties -* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. +* **sourceDatabaseName**: string (Required): Name of the database + +## DataMigrationServiceProperties +### Properties +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined ## FileShare ### Properties @@ -252,55 +131,16 @@ * **path**: string (Required): The folder path for this share. * **userName**: string: User name credential to connect to the share location -## MigrateSqlServerSqlMIDatabaseInput +## GetUserTablesSqlTaskInput ### Properties -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination - -## MigrateSqlServerSqlMITaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMITaskOutputDatabaseLevel -#### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration - -### MigrateSqlServerSqlMITaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateSqlServerSqlMITaskOutputMigrationLevel -#### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version - +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## MigrateSqlServerSqlDbTaskInput +## GetUserTablesSqlTaskOutput ### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors ## MigrateSqlServerSqlDbDatabaseInput ### Properties @@ -314,11 +154,12 @@ ### Additional Properties * **Additional Properties Type**: string -## MigrationValidationOptions +## MigrateSqlServerSqlDbTaskInput ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration ## MigrateSqlServerSqlDbTaskOutput * **Discriminator**: resultType @@ -380,11 +221,170 @@ * **statusMessage**: string (ReadOnly): Status message +## MigrateSqlServerSqlMIDatabaseInput +### Properties +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination + +## MigrateSqlServerSqlMITaskInput +### Properties +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## MigrateSqlServerSqlMITaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMITaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlMITaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + + ## MigrationReportResult ### Properties * **id**: string: Migration validation result identifier * **reportUrl**: string: The url of the report. +## MigrationValidationOptions +### Properties +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. + +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error + +## ProjectProperties +### Properties +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'SQLDB' | 'Unknown' | string (Required): Target platform of the project + +## ProjectTaskProperties +* **Discriminator**: taskType + +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToSourceSqlServerTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. + +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. + +### ConnectToTargetSqlDbTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. + +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. + +### MigrateSqlServerSqlMITaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. + +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. + +### ValidateMigrationInputSqlServerSqlMITaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. + + +## ReportableException +### Properties +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace + +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' + +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ValidateMigrationInputSqlServerSqlMITaskInput ### Properties * **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. diff --git a/generated/datamigration/microsoft.datamigration/2018-03-31-preview/types.md b/generated/datamigration/microsoft.datamigration/2018-03-31-preview/types.md index dec8b4f7c7..42cc8baa75 100644 --- a/generated/datamigration/microsoft.datamigration/2018-03-31-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2018-03-31-preview/types.md @@ -35,38 +35,9 @@ * **properties**: [ProjectTaskProperties](#projecttaskproperties): Base class for all types of DMS task properties. If task is not supported by current client, this object is returned. * **type**: 'Microsoft.DataMigration/services/projects/tasks' (ReadOnly, DeployTimeConstant): The resource type -## DataMigrationServiceProperties -### Properties -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined - -## ServiceSku -### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectProperties -### Properties -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project - -## DatabaseInfo +## BlobShare ### Properties -* **sourceDatabaseName**: string (Required): Name of the database +* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. ## ConnectionInfo * **Discriminator**: type @@ -84,66 +55,6 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectTaskProperties -* **Discriminator**: taskType - -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. - -### ConnectToTargetSqlMITaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. - -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. - -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. - -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. - - -## ODataError -### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error - ## ConnectToSourceSqlServerTaskInput ### Properties * **checkPermissionsGroup**: 'Default' | 'MigrationFromSqlServerToAzureDB' | string: Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. @@ -151,17 +62,6 @@ * **CollectLogins**: bool: Flag for whether to collect logins from source server. * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## SqlConnectionInfo -### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name - ## ConnectToSourceSqlServerTaskOutput * **Discriminator**: resultType @@ -206,28 +106,16 @@ * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrationEligibilityInfo -### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. - -## DatabaseFileInfo +## ConnectToTargetSqlDbTaskInput ### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ReportableException +## ConnectToTargetSqlDbTaskOutput ### Properties -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server ## ConnectToTargetSqlMITaskInput ### Properties @@ -242,16 +130,31 @@ * **targetServerVersion**: string (ReadOnly): Target server version * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToTargetSqlDbTaskInput +## DatabaseFileInfo ### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -## ConnectToTargetSqlDbTaskOutput +## DatabaseInfo ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +* **sourceDatabaseName**: string (Required): Name of the database + +## DataMigrationServiceProperties +### Properties +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined + +## FileShare +### Properties +* **password**: string: Password credential used to connect to the share location. +* **path**: string (Required): The folder path for this share. +* **userName**: string: User name credential to connect to the share location ## GetUserTablesSqlTaskInput ### Properties @@ -264,25 +167,84 @@ * **id**: string (ReadOnly): Result identifier * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrateSqlServerSqlMITaskInput +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedAgentJobs**: string[]: Agent Jobs to migrate. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **selectedLogins**: string[]: Logins to migrate. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## BlobShare +## MigrateSqlServerSqlDbDatabaseInputTableMap ### Properties -* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. +### Additional Properties +* **Additional Properties Type**: string -## FileShare +## MigrateSqlServerSqlDbTaskInput ### Properties -* **password**: string: Password credential used to connect to the share location. -* **path**: string (Required): The folder path for this share. -* **userName**: string: User name credential to connect to the share location +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration + +## MigrateSqlServerSqlDbTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the item +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + +### MigrateSqlServerSqlDbTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSqlServerSqlDbTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + ## MigrateSqlServerSqlMIDatabaseInput ### Properties @@ -290,6 +252,16 @@ * **name**: string (Required): Name of the database * **restoreDatabaseName**: string (Required): Name of the database at destination +## MigrateSqlServerSqlMITaskInput +### Properties +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedAgentJobs**: string[]: Agent Jobs to migrate. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **selectedLogins**: string[]: Logins to migrate. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + ## MigrateSqlServerSqlMITaskOutput * **Discriminator**: resultType @@ -354,24 +326,15 @@ * **targetServerVersion**: string (ReadOnly): Target server version -## MigrateSqlServerSqlDbTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration - -## MigrateSqlServerSqlDbDatabaseInput +## MigrationEligibilityInfo ### Properties -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. -## MigrateSqlServerSqlDbDatabaseInputTableMap +## MigrationReportResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Migration validation result identifier +* **reportUrl**: string: The url of the report. ## MigrationValidationOptions ### Properties @@ -379,70 +342,107 @@ * **enableQueryAnalysisValidation**: bool: 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. * **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error + +## ProjectProperties +### Properties +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project + +## ProjectTaskProperties +* **Discriminator**: taskType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToSourceSqlServerTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### ConnectToTargetSqlMITaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### ConnectToTargetSqlDbTaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### GetUserTablesSqlTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. + +### MigrateSqlServerSqlMITaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. -## MigrationReportResult +### ValidateMigrationInputSqlServerSqlMITaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. + + +## ReportableException ### Properties -* **id**: string: Migration validation result identifier -* **reportUrl**: string: The url of the report. +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace + +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' + +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ValidateMigrationInputSqlServerSqlMITaskInput ### Properties diff --git a/generated/datamigration/microsoft.datamigration/2018-04-19/types.md b/generated/datamigration/microsoft.datamigration/2018-04-19/types.md index 7071d91bf5..a3f6288fad 100644 --- a/generated/datamigration/microsoft.datamigration/2018-04-19/types.md +++ b/generated/datamigration/microsoft.datamigration/2018-04-19/types.md @@ -35,38 +35,53 @@ * **properties**: [ProjectTaskProperties](#projecttaskproperties): Base class for all types of DMS task properties. If task is not supported by current client, this object is returned. * **type**: 'Microsoft.DataMigration/services/projects/tasks' (ReadOnly, DeployTimeConstant): The resource type -## DataMigrationServiceProperties +## AzureActiveDirectoryApp ### Properties -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined +* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application +* **applicationId**: string (Required): Application ID of the Azure Active Directory Application +* **tenantId**: string (Required): Tenant id of the customer -## ServiceSku +## BackupFileInfo ### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' +* **familySequenceNumber**: int: Sequence number of the backup file in the backup set +* **fileLocation**: string: Location of the backup file in shared folder +* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. -## TrackedResourceTags +## BackupSetInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupFinishedDate**: string: Date and time that the backup operation finished +* **backupSetId**: string: Id for the set of backup files +* **backupStartDate**: string: Date and time that the backup operation began +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. +* **databaseName**: string: Name of the database to which the backup set belongs +* **firstLsn**: string: First log sequence number of the backup file +* **isBackupRestored**: bool: Whether the backup set is restored or not +* **lastLsn**: string: Last log sequence number of the backup file +* **lastModifiedTime**: string: Last modified time of the backup file in share location +* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set -## ProjectProperties +## BlobShare ### Properties -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'SQLDB' | 'Unknown' | string (Required): Target platform of the project +* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. + +## CommandProperties +* **Discriminator**: commandType + +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. +### MigrateMISyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. +* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. +* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. + +### MigrateSyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. +* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. +* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. -## DatabaseInfo -### Properties -* **sourceDatabaseName**: string (Required): Name of the database ## ConnectionInfo * **Discriminator**: type @@ -103,217 +118,12 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProjectTaskProperties -* **Discriminator**: taskType - -### Base Properties -* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToSourceMySqlTaskProperties -#### Properties -* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection -* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.MySql' (Required): Task type. - -### ConnectToSourcePostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements -* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. - -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. - -### ConnectToSourceSqlServerSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. - -### ConnectToTargetAzureDbForMySqlTaskProperties -#### Properties -* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements -* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. - -### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements -* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. - -### ConnectToTargetSqlMITaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. - -### ConnectToTargetSqlMISyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. -* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. - -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. - -### ConnectToTargetSqlDbSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. - -### GetTdeCertificatesSqlTaskProperties -#### Properties -* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. -* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. - -### GetUserTablesSqlSyncTaskProperties -#### Properties -* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### MigrateMySqlAzureDbForMySqlSyncTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations -* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.Sync' (Required): Task type. - -### MigrateSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations -* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. - -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. - -### MigrateSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. - -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. - -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. - -### ValidateMigrationInputSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. - -### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations -* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. - - -## CommandProperties -* **Discriminator**: commandType - -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. -### MigrateMISyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. -* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. -* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. - -### MigrateSyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. -* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. -* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. - - -## ODataError -### Properties -* **code**: string (ReadOnly): The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[] (ReadOnly): Inner errors that caused this error -* **message**: string (ReadOnly): The human-readable description of the error - -## MigrateMISyncCompleteCommandInput -### Properties -* **sourceDatabaseName**: string (Required): Name of managed instance database - -## MigrateMISyncCompleteCommandOutput -### Properties -* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution - -## ReportableException -### Properties -* **actionableMessage**: string: Actionable steps for this exception -* **filePath**: string (ReadOnly): The path to the file where exception occurred -* **hResult**: int (ReadOnly): Coded numerical value that is assigned to a specific exception -* **lineNumber**: string (ReadOnly): The line number where exception occurred -* **message**: string (ReadOnly): Error message -* **stackTrace**: string (ReadOnly): Stack trace - -## MigrateSyncCompleteCommandInput -### Properties -* **commitTimeStamp**: string: Time stamp to complete -* **databaseName**: string (Required): Name of database - -## MigrateSyncCompleteCommandOutput -### Properties -* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution -* **id**: string (ReadOnly): Result identifier - ## ConnectToSourceMySqlTaskInput ### Properties * **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. * **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server * **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL -## MySqlConnectionInfo -### Properties -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name - ## ConnectToSourceNonSqlTaskOutput ### Properties * **databases**: string[] (ReadOnly): List of databases on the server @@ -322,28 +132,10 @@ * **sourceServerBrandVersion**: string (ReadOnly): Server brand version * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## ServerProperties -### Properties -* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server -* **serverEdition**: string (ReadOnly): Edition of the database server -* **serverName**: string (ReadOnly): Name of the server -* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system -* **serverPlatform**: string (ReadOnly): Name of the server platform -* **serverVersion**: string (ReadOnly): Version of the database server - ## ConnectToSourcePostgreSqlSyncTaskInput ### Properties * **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## PostgreSqlConnectionInfo -### Properties -* **databaseName**: string: Name of the database -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name - ## ConnectToSourcePostgreSqlSyncTaskOutput ### Properties * **databases**: string[] (ReadOnly): List of databases on source server @@ -359,18 +151,6 @@ * **collectLogins**: bool: Flag for whether to collect logins from source server. * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## SqlConnectionInfo -### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name - ## ConnectToSourceSqlServerTaskOutput * **Discriminator**: resultType @@ -415,21 +195,6 @@ * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrationEligibilityInfo -### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. - -## DatabaseFileInfo -### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes - ## ConnectToTargetAzureDbForMySqlTaskInput ### Properties * **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server @@ -456,64 +221,100 @@ * **targetServerVersion**: string (ReadOnly): Version of the target server * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## ConnectToTargetSqlMITaskInput +## ConnectToTargetSqlDbSyncTaskInput ### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ConnectToTargetSqlMITaskOutput +## ConnectToTargetSqlDbTaskInput ### Properties -* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## ConnectToTargetSqlDbTaskOutput +### Properties +* **databases**: string (ReadOnly): Source databases as a map from database name to database id * **id**: string (ReadOnly): Result identifier -* **logins**: string[] (ReadOnly): List of logins on the target server. * **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **targetServerVersion**: string (ReadOnly): Version of the target server ## ConnectToTargetSqlMISyncTaskInput ### Properties * **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application * **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## AzureActiveDirectoryApp +## ConnectToTargetSqlMISyncTaskOutput ### Properties -* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application -* **applicationId**: string (Required): Application ID of the Azure Active Directory Application -* **tenantId**: string (Required): Tenant id of the customer +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MiSqlConnectionInfo +## ConnectToTargetSqlMITaskInput ### Properties -* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ConnectToTargetSqlMISyncTaskOutput +## ConnectToTargetSqlMITaskOutput ### Properties +* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **id**: string (ReadOnly): Result identifier +* **logins**: string[] (ReadOnly): List of logins on the target server. * **targetServerBrandVersion**: string (ReadOnly): Target server brand version * **targetServerVersion**: string (ReadOnly): Target server version * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToTargetSqlDbTaskInput +## DatabaseBackupInfo +### Properties +* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. +* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. +* **databaseName**: string (ReadOnly): Database name. +* **familyCount**: int (ReadOnly): Number of files in the backup set. +* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed +* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. +* **position**: int (ReadOnly): Position of current database backup in the file. + +## DatabaseFileInfo +### Properties +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes + +## DatabaseInfo +### Properties +* **sourceDatabaseName**: string (Required): Name of the database + +## DataIntegrityValidationResult +### Properties +* **failedObjects**: [DataIntegrityValidationResultFailedObjects](#dataintegrityvalidationresultfailedobjects) (ReadOnly): List of failed table names of source and target pair +* **validationErrors**: [ValidationError](#validationerror) (ReadOnly): Description about the errors happen while performing migration validation + +## DataIntegrityValidationResultFailedObjects ### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlDbTaskOutput +## DataMigrationServiceProperties ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined -## ConnectToTargetSqlDbSyncTaskInput +## ExecutionStatistics ### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **cpuTimeMs**: int (ReadOnly): CPU Time in millisecond(s) for the query execution +* **elapsedTimeMs**: int (ReadOnly): Time taken in millisecond(s) for executing the query +* **executionCount**: int (ReadOnly): No. of query executions +* **hasErrors**: bool (ReadOnly): Indicates whether the query resulted in an error +* **sqlErrors**: string[] (ReadOnly): List of sql Errors +* **waitStats**: [ExecutionStatisticsWaitStats](#executionstatisticswaitstats): Dictionary of sql query execution wait types and the respective statistics -## GetTdeCertificatesSqlTaskInput +## ExecutionStatisticsWaitStats ### Properties -* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. +### Additional Properties +* **Additional Properties Type**: [WaitStatistics](#waitstatistics) ## FileShare ### Properties @@ -521,10 +322,11 @@ * **path**: string (Required): The folder path for this share. * **userName**: string: User name credential to connect to the share location -## SelectedCertificateInput +## GetTdeCertificatesSqlTaskInput ### Properties -* **certificateName**: string (Required): Name of certificate to be exported. -* **password**: string (Required): Password to use for encrypting the exported certificate. +* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. ## GetTdeCertificatesSqlTaskOutput ### Properties @@ -556,11 +358,13 @@ * **id**: string (ReadOnly): Result identifier * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrateMySqlAzureDbForMySqlSyncTaskInput +## MigrateMISyncCompleteCommandInput ### Properties -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **sourceDatabaseName**: string (Required): Name of managed instance database + +## MigrateMISyncCompleteCommandOutput +### Properties +* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution ## MigrateMySqlAzureDbForMySqlSyncDatabaseInput ### Properties @@ -585,6 +389,12 @@ ### Additional Properties * **Additional Properties Type**: string +## MigrateMySqlAzureDbForMySqlSyncTaskInput +### Properties +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server + ## MigrateMySqlAzureDbForMySqlSyncTaskOutput * **Discriminator**: resultType @@ -648,18 +458,6 @@ * **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## SyncMigrationDatabaseErrorEvent -### Properties -* **eventText**: string (ReadOnly): Event text. -* **eventTypeString**: string (ReadOnly): Event type. -* **timestampString**: string (ReadOnly): String value of timestamp. - -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput -### Properties -* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server - ## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput ### Properties * **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior @@ -683,6 +481,12 @@ ### Additional Properties * **Additional Properties Type**: string +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput +### Properties +* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server + ## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput * **Discriminator**: resultType @@ -746,12 +550,17 @@ * **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## MigrateSqlServerSqlDbSyncTaskInput +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. + +## MigrateSqlServerSqlDbDatabaseInputTableMap +### Properties +### Additional Properties +* **Additional Properties Type**: string ## MigrateSqlServerSqlDbSyncDatabaseInput ### Properties @@ -784,11 +593,12 @@ ### Additional Properties * **Additional Properties Type**: string -## MigrationValidationOptions +## MigrateSqlServerSqlDbSyncTaskInput ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration ## MigrateSqlServerSqlDbSyncTaskOutput * **Discriminator**: resultType @@ -833,26 +643,175 @@ * **sourceServer**: string (ReadOnly): Source server name * **sourceServerVersion**: string (ReadOnly): Source server version * **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes + + +## MigrateSqlServerSqlDbTaskInput +### Properties +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration + +## MigrateSqlServerSqlDbTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the item +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + +### MigrateSqlServerSqlDbTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +#### Properties +* **dataIntegrityValidationResult**: [DataIntegrityValidationResult](#dataintegrityvalidationresult) (ReadOnly): Results for checksum based Data Integrity validation results +* **endedOn**: string (ReadOnly): Validation end time +* **migrationId**: string (ReadOnly): Migration Identifier +* **queryAnalysisValidationResult**: [QueryAnalysisValidationResult](#queryanalysisvalidationresult) (ReadOnly): Results for query analysis comparison between the source and target +* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type +* **schemaValidationResult**: [SchemaComparisonValidationResult](#schemacomparisonvalidationresult) (ReadOnly): Results for schema comparison between the source and target +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database + +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **migrationReport**: [MigrationReportResult](#migrationreportresult) (ReadOnly): Migration validation report result, contains the url for downloading the generated report. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSqlServerSqlDbTaskOutputValidationResult +#### Properties +* **migrationId**: string (ReadOnly): Migration Identifier +* **resultType**: 'MigrationValidationOutput' (Required): Result type +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **summaryResults**: [MigrateSqlServerSqlDbTaskOutputValidationResultSummaryResults](#migratesqlserversqldbtaskoutputvalidationresultsummaryresults): Validation summary results for each database + +### MigrateSqlServerSqlDbTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + + +## MigrateSqlServerSqlDbTaskOutputValidationResultSummaryResults +### Properties +### Additional Properties +* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) + +## MigrateSqlServerSqlMIDatabaseInput +### Properties +* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination + +## MigrateSqlServerSqlMISyncTaskInput +### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance + +## MigrateSqlServerSqlMISyncTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +#### Properties +* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) +* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to +* **endedOn**: string (ReadOnly): Database migration end time +* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not +* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sourceDatabaseName**: string (ReadOnly): Name of the database +* **startedOn**: string (ReadOnly): Database migration start time + +### MigrateSqlServerSqlMISyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **databaseErrorCount**: int (ReadOnly): Number of database level errors +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerName**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerName**: string (ReadOnly): Target server name * **targetServerVersion**: string (ReadOnly): Target server version -### MigrateSqlServerSqlDbSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes - ## MigrateSqlServerSqlMITaskInput ### Properties @@ -865,17 +824,6 @@ * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## BlobShare -### Properties -* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. - -## MigrateSqlServerSqlMIDatabaseInput -### Properties -* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination - ## MigrateSqlServerSqlMITaskOutput * **Discriminator**: resultType @@ -940,193 +888,226 @@ * **targetServerVersion**: string (ReadOnly): Target server version +## MigrateSyncCompleteCommandInput +### Properties +* **commitTimeStamp**: string: Time stamp to complete +* **databaseName**: string (Required): Name of database + +## MigrateSyncCompleteCommandOutput +### Properties +* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +* **id**: string (ReadOnly): Result identifier + +## MigrationEligibilityInfo +### Properties +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. + +## MigrationReportResult +### Properties +* **id**: string (ReadOnly): Migration validation result identifier +* **reportUrl**: string (ReadOnly): The url of the report. + +## MigrationValidationDatabaseSummaryResult +### Properties +* **endedOn**: string (ReadOnly): Validation end time +* **id**: string (ReadOnly): Result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database + +## MigrationValidationOptions +### Properties +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. + +## MiSqlConnectionInfo +### Properties +* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## MySqlConnectionInfo +### Properties +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## ODataError +### Properties +* **code**: string (ReadOnly): The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[] (ReadOnly): Inner errors that caused this error +* **message**: string (ReadOnly): The human-readable description of the error + ## OrphanedUserInfo ### Properties * **databaseName**: string: Parent database of the user * **name**: string: Name of the orphaned user -## MigrateSqlServerSqlMISyncTaskInput +## PostgreSqlConnectionInfo ### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +* **databaseName**: string: Name of the database +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateSqlServerSqlMISyncTaskOutput -* **Discriminator**: resultType +## ProjectProperties +### Properties +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'SQLDB' | 'Unknown' | string (Required): Target platform of the project + +## ProjectTaskProperties +* **Discriminator**: taskType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToSourceMySqlTaskProperties #### Properties -* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) -* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to -* **endedOn**: string (ReadOnly): Database migration end time -* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not -* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sourceDatabaseName**: string (ReadOnly): Name of the database -* **startedOn**: string (ReadOnly): Database migration start time +* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection +* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.MySql' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputError +### ConnectToSourcePostgreSqlSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements +* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +### ConnectToSourceSqlServerTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **databaseErrorCount**: int (ReadOnly): Number of database level errors -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerName**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerName**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. +### ConnectToSourceSqlServerSyncTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. -## BackupSetInfo -### Properties -* **backupFinishedDate**: string: Date and time that the backup operation finished -* **backupSetId**: string: Id for the set of backup files -* **backupStartDate**: string: Date and time that the backup operation began -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. -* **databaseName**: string: Name of the database to which the backup set belongs -* **firstLsn**: string: First log sequence number of the backup file -* **isBackupRestored**: bool: Whether the backup set is restored or not -* **lastLsn**: string: Last log sequence number of the backup file -* **lastModifiedTime**: string: Last modified time of the backup file in share location -* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set +### ConnectToTargetAzureDbForMySqlTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements +* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. -## BackupFileInfo -### Properties -* **familySequenceNumber**: int: Sequence number of the backup file in the backup set -* **fileLocation**: string: Location of the backup file in shared folder -* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. +### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements +* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. -## MigrateSqlServerSqlDbTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInput -### Properties -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +### ConnectToTargetSqlMISyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. +* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### ConnectToTargetSqlDbTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +### ConnectToTargetSqlDbSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +### GetTdeCertificatesSqlTaskProperties +#### Properties +* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. +* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. + +### GetUserTablesSqlSyncTaskProperties +#### Properties +* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. + +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. + +### MigrateMySqlAzureDbForMySqlSyncTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations +* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +### MigrateSqlServerSqlDbSyncTaskProperties #### Properties -* **dataIntegrityValidationResult**: [DataIntegrityValidationResult](#dataintegrityvalidationresult) (ReadOnly): Results for checksum based Data Integrity validation results -* **endedOn**: string (ReadOnly): Validation end time -* **migrationId**: string (ReadOnly): Migration Identifier -* **queryAnalysisValidationResult**: [QueryAnalysisValidationResult](#queryanalysisvalidationresult) (ReadOnly): Results for query analysis comparison between the source and target -* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type -* **schemaValidationResult**: [SchemaComparisonValidationResult](#schemacomparisonvalidationresult) (ReadOnly): Results for schema comparison between the source and target -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations +* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### MigrateSqlServerSqlMITaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReport**: [MigrationReportResult](#migrationreportresult) (ReadOnly): Migration validation report result, contains the url for downloading the generated report. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputValidationResult +### MigrateSqlServerSqlMISyncTaskProperties #### Properties -* **migrationId**: string (ReadOnly): Migration Identifier -* **resultType**: 'MigrationValidationOutput' (Required): Result type -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **summaryResults**: [MigrateSqlServerSqlDbTaskOutputValidationResultSummaryResults](#migratesqlserversqldbtaskoutputvalidationresultsummaryresults): Validation summary results for each database +* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### MigrateSqlServerSqlDbTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. +### ValidateMigrationInputSqlServerSqlMITaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. -## DataIntegrityValidationResult -### Properties -* **failedObjects**: [DataIntegrityValidationResultFailedObjects](#dataintegrityvalidationresultfailedobjects) (ReadOnly): List of failed table names of source and target pair -* **validationErrors**: [ValidationError](#validationerror) (ReadOnly): Description about the errors happen while performing migration validation +### ValidateMigrationInputSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## DataIntegrityValidationResultFailedObjects -### Properties -### Additional Properties -* **Additional Properties Type**: string +### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations +* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. -## ValidationError -### Properties -* **severity**: 'Error' | 'Message' | 'Warning' | string (ReadOnly): Severity of the validation error -* **text**: string (ReadOnly): Error Text ## QueryAnalysisValidationResult ### Properties @@ -1140,25 +1121,14 @@ * **statementsInBatch**: int (ReadOnly): Total no. of statements in the batch * **targetResult**: [ExecutionStatistics](#executionstatistics) (ReadOnly): Description about the errors happen while performing migration validation -## ExecutionStatistics -### Properties -* **cpuTimeMs**: int (ReadOnly): CPU Time in millisecond(s) for the query execution -* **elapsedTimeMs**: int (ReadOnly): Time taken in millisecond(s) for executing the query -* **executionCount**: int (ReadOnly): No. of query executions -* **hasErrors**: bool (ReadOnly): Indicates whether the query resulted in an error -* **sqlErrors**: string[] (ReadOnly): List of sql Errors -* **waitStats**: [ExecutionStatisticsWaitStats](#executionstatisticswaitstats): Dictionary of sql query execution wait types and the respective statistics - -## ExecutionStatisticsWaitStats -### Properties -### Additional Properties -* **Additional Properties Type**: [WaitStatistics](#waitstatistics) - -## WaitStatistics +## ReportableException ### Properties -* **waitCount**: int (ReadOnly): Total no. of waits -* **waitTimeMs**: int (ReadOnly): Total wait time in millisecond(s) -* **waitType**: string (ReadOnly): Type of the Wait +* **actionableMessage**: string: Actionable steps for this exception +* **filePath**: string (ReadOnly): The path to the file where exception occurred +* **hResult**: int (ReadOnly): Coded numerical value that is assigned to a specific exception +* **lineNumber**: string (ReadOnly): The line number where exception occurred +* **message**: string (ReadOnly): Error message +* **stackTrace**: string (ReadOnly): Stack trace ## SchemaComparisonValidationResult ### Properties @@ -1167,12 +1137,6 @@ * **targetDatabaseObjectCount**: [SchemaComparisonValidationResultTargetDatabaseObjectCount](#schemacomparisonvalidationresulttargetdatabaseobjectcount): Count of target database objects * **validationErrors**: [ValidationError](#validationerror) (ReadOnly): Description about the errors happen while performing migration validation -## SchemaComparisonValidationResultType -### Properties -* **objectName**: string (ReadOnly): Name of the object that has the difference -* **objectType**: 'Function' | 'StoredProcedures' | 'Table' | 'User' | 'View' | string (ReadOnly): An enumeration of type of objects -* **updateAction**: 'AddedOnTarget' | 'ChangedOnTarget' | 'DeletedOnTarget' | string (ReadOnly): Type of the actual difference for the compared object, while performing schema comparison - ## SchemaComparisonValidationResultSourceDatabaseObjectCount ### Properties ### Additional Properties @@ -1183,25 +1147,76 @@ ### Additional Properties * **Additional Properties Type**: int -## MigrationReportResult +## SchemaComparisonValidationResultType ### Properties -* **id**: string (ReadOnly): Migration validation result identifier -* **reportUrl**: string (ReadOnly): The url of the report. +* **objectName**: string (ReadOnly): Name of the object that has the difference +* **objectType**: 'Function' | 'StoredProcedures' | 'Table' | 'User' | 'View' | string (ReadOnly): An enumeration of type of objects +* **updateAction**: 'AddedOnTarget' | 'ChangedOnTarget' | 'DeletedOnTarget' | string (ReadOnly): Type of the actual difference for the compared object, while performing schema comparison -## MigrateSqlServerSqlDbTaskOutputValidationResultSummaryResults +## SelectedCertificateInput +### Properties +* **certificateName**: string (Required): Name of certificate to be exported. +* **password**: string (Required): Password to use for encrypting the exported certificate. + +## ServerProperties +### Properties +* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server +* **serverEdition**: string (ReadOnly): Edition of the database server +* **serverName**: string (ReadOnly): Name of the server +* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system +* **serverPlatform**: string (ReadOnly): Name of the server platform +* **serverVersion**: string (ReadOnly): Version of the database server + +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium' + +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## SyncMigrationDatabaseErrorEvent +### Properties +* **eventText**: string (ReadOnly): Event text. +* **eventTypeString**: string (ReadOnly): Event type. +* **timestampString**: string (ReadOnly): String value of timestamp. + +## TrackedResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) +* **Additional Properties Type**: string -## MigrationValidationDatabaseSummaryResult +## TrackedResourceTags ### Properties -* **endedOn**: string (ReadOnly): Validation end time -* **id**: string (ReadOnly): Result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +### Additional Properties +* **Additional Properties Type**: string + +## ValidateMigrationInputSqlServerSqlMISyncTaskInput +### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance + +## ValidateMigrationInputSqlServerSqlMISyncTaskOutput +### Properties +* **id**: string (ReadOnly): Database identifier +* **name**: string (ReadOnly): Name of database +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateMigrationInputSqlServerSqlMITaskInput ### Properties @@ -1224,32 +1239,6 @@ * **name**: string (ReadOnly): Name of database * **restoreDatabaseNameErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with the RestoreDatabaseName -## DatabaseBackupInfo -### Properties -* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. -* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. -* **databaseName**: string (ReadOnly): Database name. -* **familyCount**: int (ReadOnly): Number of files in the backup set. -* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed -* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. -* **position**: int (ReadOnly): Position of current database backup in the file. - -## ValidateMigrationInputSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance - -## ValidateMigrationInputSqlServerSqlMISyncTaskOutput -### Properties -* **id**: string (ReadOnly): Database identifier -* **name**: string (ReadOnly): Name of database -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object - ## ValidateSyncMigrationInputSqlServerTaskInput ### Properties * **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate @@ -1262,3 +1251,14 @@ * **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object +## ValidationError +### Properties +* **severity**: 'Error' | 'Message' | 'Warning' | string (ReadOnly): Severity of the validation error +* **text**: string (ReadOnly): Error Text + +## WaitStatistics +### Properties +* **waitCount**: int (ReadOnly): Total no. of waits +* **waitTimeMs**: int (ReadOnly): Total wait time in millisecond(s) +* **waitType**: string (ReadOnly): Type of the Wait + diff --git a/generated/datamigration/microsoft.datamigration/2018-07-15-preview/types.md b/generated/datamigration/microsoft.datamigration/2018-07-15-preview/types.md index 640784360c..eb4d1bdb35 100644 --- a/generated/datamigration/microsoft.datamigration/2018-07-15-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2018-07-15-preview/types.md @@ -55,39 +55,77 @@ * **properties**: [ProjectTaskProperties](#projecttaskproperties): Base class for all types of DMS task properties. If task is not supported by current client, this object is returned. * **type**: 'Microsoft.DataMigration/services/serviceTasks' (ReadOnly, DeployTimeConstant): The resource type -## DataMigrationServiceProperties +## AzureActiveDirectoryApp ### Properties -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have -* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined +* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application +* **applicationId**: string (Required): Application ID of the Azure Active Directory Application +* **tenantId**: string (Required): Tenant id of the customer -## ServiceSku +## BackupFileInfo ### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' +* **familySequenceNumber**: int: Sequence number of the backup file in the backup set +* **fileLocation**: string: Location of the backup file in shared folder +* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. -## TrackedResourceTags +## BackupSetInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupFinishedDate**: string: Date and time that the backup operation finished +* **backupSetId**: string: Id for the set of backup files +* **backupStartDate**: string: Date and time that the backup operation began +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. +* **databaseName**: string: Name of the database to which the backup set belongs +* **firstLsn**: string: First log sequence number of the backup file +* **isBackupRestored**: bool: Whether the backup set is restored or not +* **lastLsn**: string: Last log sequence number of the backup file +* **lastModifiedTime**: string: Last modified time of the backup file in share location +* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set -## ProjectProperties +## BlobShare ### Properties -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project +* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. -## DatabaseInfo +## CheckOCIDriverTaskInput ### Properties -* **sourceDatabaseName**: string (Required): Name of the database +* **serverVersion**: string: Version of the source server to check against. Optional. + +## CheckOCIDriverTaskOutput +### Properties +* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## CommandProperties +* **Discriminator**: commandType + +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. +### MongoDbCancelCommand +#### Properties +* **commandType**: 'cancel' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands + +### MongoDbFinishCommand +#### Properties +* **commandType**: 'finish' (Required): Command type. +* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command + +### MigrateMISyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. +* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. +* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. + +### MigrateSyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. +* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. +* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. + +### MongoDbRestartCommand +#### Properties +* **commandType**: 'restart' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands + ## ConnectionInfo * **Discriminator**: type @@ -136,297 +174,293 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags +## ConnectToSourceMySqlTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL -## ProjectFileProperties +## ConnectToSourceNonSqlTaskOutput ### Properties -* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. -* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. -* **lastModified**: string (ReadOnly): Modification DateTime. -* **mediaType**: string: File content type. This property can be modified to reflect the file content type. -* **size**: int (ReadOnly): File size. +* **databases**: string[] (ReadOnly): List of databases on the server +* **id**: string (ReadOnly): Result identifier +* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source +* **sourceServerBrandVersion**: string (ReadOnly): Server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## ProjectTaskProperties -* **Discriminator**: taskType +## ConnectToSourceOracleSyncTaskInput +### Properties +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -### Base Properties -* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task -* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToMongoDbTaskProperties -#### Properties -* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source -* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object -* **taskType**: 'Connect.MongoDb' (Required): Task type. +## ConnectToSourceOracleSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of schemas on source server +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceMySqlTaskProperties -#### Properties -* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection -* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.MySql' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ConnectToSourceOracleSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection -* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on source server +* **id**: string (ReadOnly): Result identifier +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourcePostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements -* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. +## ConnectToSourceSqlServerTaskInput +### Properties +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. +* **collectDatabases**: bool: Flag for whether to collect databases from source server. +* **collectLogins**: bool: Flag for whether to collect logins from source server. +* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. +## ConnectToSourceSqlServerTaskOutput +* **Discriminator**: resultType -### ConnectToSourceSqlServerSyncTaskProperties +### Base Properties +* **id**: string (ReadOnly): Result identifier +### ConnectToSourceSqlServerTaskOutputAgentJobLevel #### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **jobCategory**: string (ReadOnly): The type of Agent Job. +* **jobOwner**: string (ReadOnly): The owner of the Agent Job +* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Agent Job name +* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetAzureDbForMySqlTaskProperties +### ConnectToSourceSqlServerTaskOutputDatabaseLevel #### Properties -* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements -* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. +* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels +* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files +* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states +* **name**: string (ReadOnly): Database name +* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level +* **sizeMB**: int (ReadOnly): Size of the file in megabytes -### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +### ConnectToSourceSqlServerTaskOutputLoginLevel #### Properties -* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements -* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. +* **defaultDatabase**: string (ReadOnly): The default database for the login. +* **isEnabled**: bool (ReadOnly): The state of the login. +* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Login name. +* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level -### ConnectToTargetSqlMITaskProperties +### ConnectToSourceSqlServerTaskOutputTaskLevel #### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. +* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable +* **logins**: string (ReadOnly): Source logins as a map from login name to login id. +* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetSqlMISyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. -* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. -* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskInput +### Properties +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **serverVersion**: string (ReadOnly): Version of the target server +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToTargetSqlDbSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### GetTdeCertificatesSqlTaskProperties -#### Properties -* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. -* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. - -### GetUserTablesSqlSyncTaskProperties -#### Properties -* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### GetUserTablesOracleTaskProperties -#### Properties -* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. -* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesOracle' (Required): Task type. - -### GetUserTablesPostgreSqlTaskProperties -#### Properties -* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. -* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. - -### MigrateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress -* **taskType**: 'Migrate.MongoDb' (Required): Task type. - -### MigrateMySqlAzureDbForMySqlSyncTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations -* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +### Properties +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MigrateSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations -* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +### Properties +* **database**: string +* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. +## ConnectToTargetSqlDbSyncTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MigrateSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## ConnectToTargetSqlDbTaskInput +### Properties +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. +## ConnectToTargetSqlDbTaskOutput +### Properties +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server -### MigrateSsisTaskProperties -#### Properties -* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. -* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Ssis' (Required): Task type. +## ConnectToTargetSqlMISyncTaskInput +### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -### MigrateSchemaSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases -* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. +## ConnectToTargetSqlMISyncTaskOutput +### Properties +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### CheckOCIDriverTaskProperties -#### Properties -* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. -* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Check.OCI' (Required): Task type. +## ConnectToTargetSqlMITaskInput +### Properties +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. +* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. -### InstallOCIDriverTaskProperties -#### Properties -* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. -* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Install.OCI' (Required): Task type. +## ConnectToTargetSqlMITaskOutput +### Properties +* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **id**: string (ReadOnly): Result identifier +* **logins**: string[] (ReadOnly): List of logins on the target server. +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### UploadOCIDriverTaskProperties -#### Properties -* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. -* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Upload.OCI' (Required): Task type. +## DatabaseBackupInfo +### Properties +* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. +* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. +* **databaseName**: string (ReadOnly): Database name. +* **familyCount**: int (ReadOnly): Number of files in the backup set. +* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed +* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. +* **position**: int (ReadOnly): Position of current database backup in the file. -### ValidateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object -* **taskType**: 'Validate.MongoDb' (Required): Task type. +## DatabaseFileInfo +### Properties +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object -* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. +## DatabaseInfo +### Properties +* **sourceDatabaseName**: string (Required): Name of the database -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. +## DatabaseTable +### Properties +* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not +* **name**: string (ReadOnly): Schema-qualified name of the table -### ValidateMigrationInputSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## DataMigrationServiceProperties +### Properties +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have +* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined -### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations -* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. +## FileShare +### Properties +* **password**: string: Password credential used to connect to the share location. +* **path**: string (Required): The folder path for this share. +* **userName**: string: User name credential to connect to the share location +## GetTdeCertificatesSqlTaskInput +### Properties +* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. -## ProjectTaskPropertiesClientData +## GetTdeCertificatesSqlTaskOutput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## CommandProperties -* **Discriminator**: commandType +## GetUserTablesOracleTaskInput +### Properties +* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. -### MongoDbCancelCommand -#### Properties -* **commandType**: 'cancel' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## GetUserTablesOracleTaskOutput +### Properties +* **schemaName**: string (ReadOnly): The schema this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MongoDbFinishCommand -#### Properties -* **commandType**: 'finish' (Required): Command type. -* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command +## GetUserTablesPostgreSqlTaskInput +### Properties +* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables -### MigrateMISyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. -* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. -* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. +## GetUserTablesPostgreSqlTaskOutput +### Properties +* **databaseName**: string (ReadOnly): The database this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MigrateSyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. -* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. -* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. +## GetUserTablesSqlSyncTaskInput +### Properties +* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for +* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MongoDbRestartCommand -#### Properties -* **commandType**: 'restart' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## GetUserTablesSqlSyncTaskOutput +### Properties +* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables +* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables +* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +## GetUserTablesSqlTaskInput +### Properties +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## ODataError +## GetUserTablesSqlTaskOutput ### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbCommandInput +## InstallOCIDriverTaskInput ### Properties -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **driverPackageName**: string: Name of the uploaded driver package to install. -## MongoDbFinishCommandInput +## InstallOCIDriverTaskOutput ### Properties -* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors ## MigrateMISyncCompleteCommandInput ### Properties @@ -436,523 +470,791 @@ ### Properties * **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution -## ReportableException +## MigrateMySqlAzureDbForMySqlSyncDatabaseInput ### Properties -* **actionableMessage**: string: Actionable steps for this exception -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace +* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MigrateSyncCompleteCommandInput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting ### Properties -* **commitTimeStamp**: string: Time stamp to complete -* **databaseName**: string (Required): Name of database +### Additional Properties +* **Additional Properties Type**: string -## MigrateSyncCompleteCommandOutput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting ### Properties -* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution -* **id**: string (ReadOnly): Result identifier +### Additional Properties +* **Additional Properties Type**: string -## MongoDbConnectionInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap ### Properties -* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## MongoDbClusterInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting ### Properties -* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster -* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections -* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source -* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. +### Additional Properties +* **Additional Properties Type**: string -## MongoDbDatabaseInfo +## MigrateMySqlAzureDbForMySqlSyncTaskInput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -## MongoDbCollectionInfo +## MigrateMySqlAzureDbForMySqlSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes + + +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **databaseName**: string (Required): The name of the database containing the collection -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) -* **isSystemCollection**: bool (Required): Whether the collection is system collection -* **isView**: bool (Required): Whether the collection is a view of another collection -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -* **viewOf**: string: The name of the collection that this is a view of, if IsView is true +* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower +* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the migration pipeline +* **schemaName**: string: Name of the source schema +* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MongoDbShardKeyInfo +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +### Additional Properties +* **Additional Properties Type**: string -## MongoDbShardKeyField +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **name**: string (Required): The name of the field -* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceMySqlTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL +### Additional Properties +* **Additional Properties Type**: string -## MySqlConnectionInfo +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceNonSqlTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncTaskInput ### Properties -* **databases**: string[] (ReadOnly): List of databases on the server +* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server + +## MigrateOracleAzureDbPostgreSqlSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties * **id**: string (ReadOnly): Result identifier -* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source -* **sourceServerBrandVersion**: string (ReadOnly): Server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## ServerProperties -### Properties -* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server -* **serverEdition**: string (ReadOnly): Edition of the database server -* **serverName**: string (ReadOnly): Name of the server -* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system -* **serverPlatform**: string (ReadOnly): Name of the server platform -* **serverVersion**: string (ReadOnly): Version of the database server +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## ConnectToSourceOracleSyncTaskInput -### Properties -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## OracleConnectionInfo -### Properties -* **dataSource**: string (Required): EZConnect or TNSName connection string. -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## ConnectToSourceOracleSyncTaskOutput +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes + + +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput ### Properties -* **databases**: string[] (ReadOnly): List of schemas on source server -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration +* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToSourcePostgreSqlSyncTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## PostgreSqlConnectionInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **databaseName**: string: Name of the database -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourcePostgreSqlSyncTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on source server -* **id**: string (ReadOnly): Result identifier -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceSqlServerTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. -* **collectDatabases**: bool: Flag for whether to collect databases from source server. -* **collectLogins**: bool: Flag for whether to collect logins from source server. -* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. +* **name**: string: Name of the table to migrate -## SqlConnectionInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## ConnectToSourceSqlServerTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### ConnectToSourceSqlServerTaskOutputAgentJobLevel +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError #### Properties -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **jobCategory**: string (ReadOnly): The type of Agent Job. -* **jobOwner**: string (ReadOnly): The owner of the Agent Job -* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Agent Job name -* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. +* **targetServer**: string (ReadOnly): Target server name +* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes + + +## MigrateSchemaSqlServerSqlDbDatabaseInput +### Properties +* **name**: string: Name of source database +* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target +* **targetDatabaseName**: string: Name of target database + +## MigrateSchemaSqlServerSqlDbTaskInput +### Properties +* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### ConnectToSourceSqlServerTaskOutputDatabaseLevel +## MigrateSchemaSqlServerSqlDbTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel #### Properties -* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels -* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files -* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states -* **name**: string (ReadOnly): Database name -* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level -* **sizeMB**: int (ReadOnly): Size of the file in megabytes +* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database +* **databaseName**: string (ReadOnly): The name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database +* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database +* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database +* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -### ConnectToSourceSqlServerTaskOutputLoginLevel +### MigrateSchemaSqlTaskOutputError #### Properties -* **defaultDatabase**: string (ReadOnly): The default database for the login. -* **isEnabled**: bool (ReadOnly): The state of the login. -* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Login name. -* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### ConnectToSourceSqlServerTaskOutputTaskLevel +### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel #### Properties -* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable -* **logins**: string (ReadOnly): Source logins as a map from login name to login id. -* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +### MigrateSchemaSqlServerSqlDbTaskOutputError +#### Properties +* **commandText**: string (ReadOnly): Schema command which failed +* **errorText**: string (ReadOnly): Reason of failure +* **resultType**: 'SchemaErrorOutput' (Required): Result type -## MigrationEligibilityInfo + +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## DatabaseFileInfo +## MigrateSqlServerSqlDbDatabaseInputTableMap ### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForMySqlTaskInput +## MigrateSqlServerSqlDbSyncDatabaseInput ### Properties -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **id**: string: Unique identifier for database +* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of database +* **schemaName**: string: Schema name to be migrated +* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Target database name +* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToTargetAzureDbForMySqlTaskOutput +## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **serverVersion**: string (ReadOnly): Version of the target server -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +## MigrateSqlServerSqlDbSyncDatabaseInputTableMap ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskInput +## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting ### Properties -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. -* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskOutput +## MigrateSqlServerSqlDbSyncTaskInput ### Properties -* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration + +## MigrateSqlServerSqlDbSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties * **id**: string (ReadOnly): Result identifier -* **logins**: string[] (ReadOnly): List of logins on the target server. -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateSqlServerSqlDbSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name * **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToTargetSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## AzureActiveDirectoryApp -### Properties -* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application -* **applicationId**: string (Required): Application ID of the Azure Active Directory Application -* **tenantId**: string (Required): Tenant id of the customer -## MiSqlConnectionInfo +## MigrateSqlServerSqlDbTaskInput ### Properties -* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## ConnectToTargetSqlMISyncTaskOutput -### Properties -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +## MigrateSqlServerSqlDbTaskOutput +* **Discriminator**: resultType -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput -### Properties -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the item +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput -### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +### MigrateSqlServerSqlDbTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message * **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **targetServerVersion**: string (ReadOnly): Target server version -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem -### Properties -* **database**: string -* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem +### MigrateSqlServerSqlDbTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## ConnectToTargetSqlDbTaskInput -### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ConnectToTargetSqlDbTaskOutput +## MigrateSqlServerSqlMIDatabaseInput ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination -## ConnectToTargetSqlDbSyncTaskInput +## MigrateSqlServerSqlMISyncTaskInput ### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## GetTdeCertificatesSqlTaskInput -### Properties -* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. +## MigrateSqlServerSqlMISyncTaskOutput +* **Discriminator**: resultType -## FileShare -### Properties -* **password**: string: Password credential used to connect to the share location. -* **path**: string (Required): The folder path for this share. -* **userName**: string: User name credential to connect to the share location +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +#### Properties +* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) +* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to +* **endedOn**: string (ReadOnly): Database migration end time +* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not +* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sourceDatabaseName**: string (ReadOnly): Name of the database +* **startedOn**: string (ReadOnly): Database migration start time -## SelectedCertificateInput -### Properties -* **certificateName**: string (Required): Name of certificate to be exported. -* **password**: string (Required): Password to use for encrypting the exported certificate. +### MigrateSqlServerSqlMISyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## GetTdeCertificatesSqlTaskOutput -### Properties -* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **databaseErrorCount**: int (ReadOnly): Number of database level errors +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerName**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerName**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## GetUserTablesSqlSyncTaskInput + +## MigrateSqlServerSqlMITaskInput ### Properties -* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for -* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes +* **selectedAgentJobs**: string[]: Agent Jobs to migrate. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **selectedLogins**: string[]: Logins to migrate. * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## GetUserTablesSqlSyncTaskOutput -### Properties -* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables -* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables -* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - -## GetUserTablesSqlTaskInput -### Properties -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +## MigrateSqlServerSqlMITaskOutput +* **Discriminator**: resultType -## GetUserTablesSqlTaskOutput -### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +### Base Properties * **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSqlServerSqlMITaskOutputAgentJobLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **message**: string (ReadOnly): Migration progress message +* **name**: string (ReadOnly): Agent Job name. +* **resultType**: 'AgentJobLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesOracleTaskInput -### Properties -* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables +### MigrateSqlServerSqlMITaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sizeMB**: int (ReadOnly): Size of the database in megabytes +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesOracleTaskOutput -### Properties -* **schemaName**: string (ReadOnly): The schema this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigrateSqlServerSqlMITaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## DatabaseTable -### Properties -* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not -* **name**: string (ReadOnly): Schema-qualified name of the table +### MigrateSqlServerSqlMITaskOutputLoginLevel +#### Properties +* **endedOn**: string (ReadOnly): Login migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login +* **loginName**: string (ReadOnly): Login name. +* **message**: string (ReadOnly): Login migration progress message +* **resultType**: 'LoginLevelOutput' (Required): Result type +* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. +* **startedOn**: string (ReadOnly): Login migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesPostgreSqlTaskInput -### Properties -* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables +### MigrateSqlServerSqlMITaskOutputMigrationLevel +#### Properties +* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **logins**: string (ReadOnly): Selected logins as a map from name to id +* **message**: string (ReadOnly): Migration progress message +* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **serverRoleResults**: string (ReadOnly): Map of server role migration results. +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## GetUserTablesPostgreSqlTaskOutput -### Properties -* **databaseName**: string (ReadOnly): The database this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## MongoDbMigrationSettings +## MigrateSsisTaskInput ### Properties -* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. -* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. -* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. -* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MongoDbMigrationSettingsDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) +## MigrateSsisTaskOutput +* **Discriminator**: resultType -## MongoDbDatabaseSettings -### Properties -* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSsisTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## MongoDbDatabaseSettingsCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +### MigrateSsisTaskOutputProjectLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **folderName**: string (ReadOnly): Name of the folder +* **message**: string (ReadOnly): Migration progress message +* **projectName**: string (ReadOnly): Name of the project +* **resultType**: 'SsisProjectLevelOutput' (Required): Result type +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## MongoDbCollectionSettings -### Properties -* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. -* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. -## MongoDbShardKeySetting +## MigrateSyncCompleteCommandInput ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +* **commitTimeStamp**: string: Time stamp to complete +* **databaseName**: string (Required): Name of database -## MongoDbThrottlingSettings +## MigrateSyncCompleteCommandOutput ### Properties -* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel -* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 -* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using - -## MongoDbProgress -* **Discriminator**: resultType - -### Base Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -### MongoDbCollectionProgress -#### Properties -* **resultType**: 'Collection' (Required): The type of progress object +* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +* **id**: string (ReadOnly): Result identifier -### MongoDbDatabaseProgress -#### Properties -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **resultType**: 'Database' (Required): The type of progress object +## MigrationEligibilityInfo +### Properties +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. -### MongoDbMigrationProgress -#### Properties -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **resultType**: 'Migration' (Required): The type of progress object +## MigrationReportResult +### Properties +* **id**: string: Migration validation result identifier +* **reportUrl**: string: The url of the report. +## MigrationValidationDatabaseSummaryResult +### Properties +* **endedOn**: string (ReadOnly): Validation end time +* **id**: string (ReadOnly): Result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database -## MongoDbProgressErrors +## MigrationValidationOptions ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. -## MongoDbError +## MigrationValidationResult ### Properties -* **code**: string: The non-localized, machine-readable code that describes the error or warning -* **count**: int: The number of times the error or warning has occurred -* **message**: string: The localized, human-readable message that describes the error or warning -* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning +* **id**: string (ReadOnly): Migration validation result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database -## MongoDbDatabaseProgressCollections +## MigrationValidationResultSummaryResults ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) -## MongoDbCollectionProgress +## MiSqlConnectionInfo ### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MongoDbProgressErrors +## MongoDbClusterInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster +* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections +* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source +* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. -## MongoDbMigrationProgressDatabases +## MongoDbCollectionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **databaseName**: string (Required): The name of the database containing the collection +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) +* **isSystemCollection**: bool (Required): Whether the collection is system collection +* **isView**: bool (Required): Whether the collection is a view of another collection +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **viewOf**: string: The name of the collection that this is a view of, if IsView is true -## MongoDbDatabaseProgress +## MongoDbCollectionProgress ### Properties * **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections * **documentsCopied**: int (Required): The number of documents copied during the Copying stage * **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) * **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. @@ -967,824 +1269,561 @@ * **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown * **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MongoDbDatabaseProgressCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) - -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) - -## MigrateMySqlAzureDbForMySqlSyncTaskInput -### Properties -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server - -## MigrateMySqlAzureDbForMySqlSyncDatabaseInput -### Properties -* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior - -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap +## MongoDbCollectionSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. +* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting +## MongoDbCommandInput ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlSyncTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes - +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## SyncMigrationDatabaseErrorEvent +## MongoDbConnectionInfo ### Properties -* **eventText**: string (ReadOnly): Event text. -* **eventTypeString**: string (ReadOnly): Event type. -* **timestampString**: string (ReadOnly): String value of timestamp. +* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateOracleAzureDbPostgreSqlSyncTaskInput +## MongoDbDatabaseInfo ### Properties -* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput +## MongoDbDatabaseProgress ### Properties -* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower -* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the migration pipeline -* **schemaName**: string: Name of the source schema -* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap +## MongoDbDatabaseSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbDatabaseSettingsCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## MigrateOracleAzureDbPostgreSqlSyncTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +## MongoDbError +### Properties +* **code**: string: The non-localized, machine-readable code that describes the error or warning +* **count**: int: The number of times the error or warning has occurred +* **message**: string: The localized, human-readable message that describes the error or warning +* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput +## MongoDbFinishCommandInput ### Properties -* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput +## MongoDbMigrationProgress ### Properties -* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration -* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput +## MongoDbMigrationProgressDatabases ### Properties -* **name**: string: Name of the table to migrate +### Additional Properties +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbMigrationSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. +* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. +* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. +* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbMigrationSettingsDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +## MongoDbProgress * **Discriminator**: resultType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MongoDbCollectionProgress #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. -* **targetServer**: string (ReadOnly): Target server name -* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type -* **targetServerVersion**: string (ReadOnly): Target server version +* **resultType**: 'Collection' (Required): The type of progress object -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +### MongoDbDatabaseProgress #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes - +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **resultType**: 'Database' (Required): The type of progress object -## MigrateSqlServerSqlDbSyncTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### MongoDbMigrationProgress +#### Properties +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **resultType**: 'Migration' (Required): The type of progress object -## MigrateSqlServerSqlDbSyncDatabaseInput -### Properties -* **id**: string: Unique identifier for database -* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of database -* **schemaName**: string: Schema name to be migrated -* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Target database name -* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputTableMap +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrationValidationOptions +## MongoDbShardKeyField ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **name**: string (Required): The name of the field +* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering -## MigrateSqlServerSqlDbSyncTaskOutput -* **Discriminator**: resultType +## MongoDbShardKeyInfo +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +## MongoDbShardKeySetting +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +## MongoDbThrottlingSettings +### Properties +* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel +* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 +* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using -### MigrateSqlServerSqlDbSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## MySqlConnectionInfo +### Properties +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel -#### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error -### MigrateSqlServerSqlDbSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## OracleConnectionInfo +### Properties +* **dataSource**: string (Required): EZConnect or TNSName connection string. +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## OracleOCIDriverInfo +### Properties +* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. +* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' +* **driverName**: string (ReadOnly): The name of the driver package +* **driverSize**: string (ReadOnly): The size in bytes of the driver package +* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. +* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +## OrphanedUserInfo +### Properties +* **databaseName**: string: Parent database of the user +* **name**: string: Name of the orphaned user -## MigrateSqlServerSqlMITaskInput +## PostgreSqlConnectionInfo ### Properties -* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes -* **selectedAgentJobs**: string[]: Agent Jobs to migrate. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **selectedLogins**: string[]: Logins to migrate. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **databaseName**: string: Name of the database +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## BlobShare +## ProjectFileProperties ### Properties -* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. +* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. +* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. +* **lastModified**: string (ReadOnly): Modification DateTime. +* **mediaType**: string: File content type. This property can be modified to reflect the file content type. +* **size**: int (ReadOnly): File size. -## MigrateSqlServerSqlMIDatabaseInput +## ProjectProperties ### Properties -* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project -## MigrateSqlServerSqlMITaskOutput -* **Discriminator**: resultType +## ProjectTaskProperties +* **Discriminator**: taskType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMITaskOutputAgentJobLevel +* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task +* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToMongoDbTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **message**: string (ReadOnly): Migration progress message -* **name**: string (ReadOnly): Agent Job name. -* **resultType**: 'AgentJobLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source +* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object +* **taskType**: 'Connect.MongoDb' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputDatabaseLevel +### ConnectToSourceMySqlTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sizeMB**: int (ReadOnly): Size of the database in megabytes -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection +* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.MySql' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputError +### ConnectToSourceOracleSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection +* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputLoginLevel +### ConnectToSourcePostgreSqlSyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Login migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login -* **loginName**: string (ReadOnly): Login name. -* **message**: string (ReadOnly): Login migration progress message -* **resultType**: 'LoginLevelOutput' (Required): Result type -* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. -* **startedOn**: string (ReadOnly): Login migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements +* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputMigrationLevel +### ConnectToSourceSqlServerTaskProperties #### Properties -* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **logins**: string (ReadOnly): Selected logins as a map from name to id -* **message**: string (ReadOnly): Migration progress message -* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **serverRoleResults**: string (ReadOnly): Map of server role migration results. -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. + +### ConnectToSourceSqlServerSyncTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. +### ConnectToTargetAzureDbForMySqlTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements +* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. -## OrphanedUserInfo -### Properties -* **databaseName**: string: Parent database of the user -* **name**: string: Name of the orphaned user +### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements +* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskOutput -* **Discriminator**: resultType +### ConnectToTargetSqlMISyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. +* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) -* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to -* **endedOn**: string (ReadOnly): Database migration end time -* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not -* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sourceDatabaseName**: string (ReadOnly): Name of the database -* **startedOn**: string (ReadOnly): Database migration start time +* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. +* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputError +### ConnectToTargetSqlDbTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +### ConnectToTargetSqlDbSyncTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **databaseErrorCount**: int (ReadOnly): Number of database level errors -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerName**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerName**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. +### GetTdeCertificatesSqlTaskProperties +#### Properties +* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. +* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. -## BackupSetInfo -### Properties -* **backupFinishedDate**: string: Date and time that the backup operation finished -* **backupSetId**: string: Id for the set of backup files -* **backupStartDate**: string: Date and time that the backup operation began -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. -* **databaseName**: string: Name of the database to which the backup set belongs -* **firstLsn**: string: First log sequence number of the backup file -* **isBackupRestored**: bool: Whether the backup set is restored or not -* **lastLsn**: string: Last log sequence number of the backup file -* **lastModifiedTime**: string: Last modified time of the backup file in share location -* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set +### GetUserTablesSqlSyncTaskProperties +#### Properties +* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. -## BackupFileInfo -### Properties -* **familySequenceNumber**: int: Sequence number of the backup file in the backup set -* **fileLocation**: string: Location of the backup file in shared folder -* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. -## MigrateSqlServerSqlDbTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### GetUserTablesOracleTaskProperties +#### Properties +* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. +* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesOracle' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInput -### Properties -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +### GetUserTablesPostgreSqlTaskProperties +#### Properties +* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. +* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress +* **taskType**: 'Migrate.MongoDb' (Required): Task type. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +### MigrateMySqlAzureDbForMySqlSyncTaskProperties +#### Properties +* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations +* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### MigrateSqlServerSqlDbSyncTaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations +* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### MigrateSqlServerSqlMITaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. +### MigrateSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## MigrationReportResult -### Properties -* **id**: string: Migration validation result identifier -* **reportUrl**: string: The url of the report. +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. -## MigrationValidationResult -### Properties -* **id**: string (ReadOnly): Migration validation result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database +### MigrateSsisTaskProperties +#### Properties +* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. +* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Ssis' (Required): Task type. -## MigrationValidationResultSummaryResults -### Properties -### Additional Properties -* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) +### MigrateSchemaSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases +* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. + +### CheckOCIDriverTaskProperties +#### Properties +* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. +* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Check.OCI' (Required): Task type. -## MigrationValidationDatabaseSummaryResult -### Properties -* **endedOn**: string (ReadOnly): Validation end time -* **id**: string (ReadOnly): Result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +### InstallOCIDriverTaskProperties +#### Properties +* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. +* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Install.OCI' (Required): Task type. -## MigrateSsisTaskInput -### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### UploadOCIDriverTaskProperties +#### Properties +* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. +* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Upload.OCI' (Required): Task type. -## SsisMigrationInfo -### Properties -* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS +### ValidateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object +* **taskType**: 'Validate.MongoDb' (Required): Task type. -## MigrateSsisTaskOutput -* **Discriminator**: resultType +### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object +* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSsisTaskOutputMigrationLevel +### ValidateMigrationInputSqlServerSqlMITaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. -### MigrateSsisTaskOutputProjectLevel +### ValidateMigrationInputSqlServerSqlMISyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **folderName**: string (ReadOnly): Name of the folder -* **message**: string (ReadOnly): Migration progress message -* **projectName**: string (ReadOnly): Name of the project -* **resultType**: 'SsisProjectLevelOutput' (Required): Result type -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. + +### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations +* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. -## MigrateSchemaSqlServerSqlDbTaskInput +## ProjectTaskPropertiesClientData ### Properties -* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### Additional Properties +* **Additional Properties Type**: string -## MigrateSchemaSqlServerSqlDbDatabaseInput +## ReportableException ### Properties -* **name**: string: Name of source database -* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target -* **targetDatabaseName**: string: Name of target database +* **actionableMessage**: string: Actionable steps for this exception +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace ## SchemaMigrationSetting ### Properties * **fileId**: string: Resource Identifier of a file resource containing the uploaded schema file * **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target -## MigrateSchemaSqlServerSqlDbTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel -#### Properties -* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database -* **databaseName**: string (ReadOnly): The name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database -* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database -* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database -* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration - -### MigrateSchemaSqlTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +## SelectedCertificateInput +### Properties +* **certificateName**: string (Required): Name of certificate to be exported. +* **password**: string (Required): Password to use for encrypting the exported certificate. -### MigrateSchemaSqlServerSqlDbTaskOutputError -#### Properties -* **commandText**: string (ReadOnly): Schema command which failed -* **errorText**: string (ReadOnly): Reason of failure -* **resultType**: 'SchemaErrorOutput' (Required): Result type +## ServerProperties +### Properties +* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server +* **serverEdition**: string (ReadOnly): Edition of the database server +* **serverName**: string (ReadOnly): Name of the server +* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system +* **serverPlatform**: string (ReadOnly): Name of the server platform +* **serverVersion**: string (ReadOnly): Version of the database server +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' -## CheckOCIDriverTaskInput +## SqlConnectionInfo ### Properties -* **serverVersion**: string: Version of the source server to check against. Optional. +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## CheckOCIDriverTaskOutput +## SsisMigrationInfo ### Properties -* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS -## OracleOCIDriverInfo +## SyncMigrationDatabaseErrorEvent ### Properties -* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. -* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' -* **driverName**: string (ReadOnly): The name of the driver package -* **driverSize**: string (ReadOnly): The size in bytes of the driver package -* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. -* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +* **eventText**: string (ReadOnly): Event text. +* **eventTypeString**: string (ReadOnly): Event type. +* **timestampString**: string (ReadOnly): String value of timestamp. -## InstallOCIDriverTaskInput +## TrackedResourceTags ### Properties -* **driverPackageName**: string: Name of the uploaded driver package to install. +### Additional Properties +* **Additional Properties Type**: string -## InstallOCIDriverTaskOutput +## TrackedResourceTags ### Properties -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string ## UploadOCIDriverTaskInput ### Properties @@ -1795,36 +1834,19 @@ * **driverPackageName**: string (ReadOnly): The name of the driver package that was validated and uploaded. * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbMigrationProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown - -## MongoDbMigrationProgressDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) - -## MongoDbProgressErrors +## ValidateMigrationInputSqlServerSqlMISyncTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## ValidateOracleAzureDbPostgreSqlSyncTaskOutput +## ValidateMigrationInputSqlServerSqlMISyncTaskOutput ### Properties +* **id**: string (ReadOnly): Database identifier +* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateMigrationInputSqlServerSqlMITaskInput @@ -1848,30 +1870,8 @@ * **name**: string (ReadOnly): Name of database * **restoreDatabaseNameErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with the RestoreDatabaseName -## DatabaseBackupInfo -### Properties -* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. -* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. -* **databaseName**: string (ReadOnly): Database name. -* **familyCount**: int (ReadOnly): Number of files in the backup set. -* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed -* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. -* **position**: int (ReadOnly): Position of current database backup in the file. - -## ValidateMigrationInputSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance - -## ValidateMigrationInputSqlServerSqlMISyncTaskOutput +## ValidateOracleAzureDbPostgreSqlSyncTaskOutput ### Properties -* **id**: string (ReadOnly): Database identifier -* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateSyncMigrationInputSqlServerTaskInput diff --git a/generated/datamigration/microsoft.datamigration/2021-06-30/types.md b/generated/datamigration/microsoft.datamigration/2021-06-30/types.md index eb3ae5644e..6fbc9bbf13 100644 --- a/generated/datamigration/microsoft.datamigration/2021-06-30/types.md +++ b/generated/datamigration/microsoft.datamigration/2021-06-30/types.md @@ -60,48 +60,77 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DataMigration/services/serviceTasks' (ReadOnly, DeployTimeConstant): The resource type -## DataMigrationServiceProperties +## AzureActiveDirectoryApp ### Properties -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have -* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined +* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application +* **applicationId**: string (Required): Application ID of the Azure Active Directory Application +* **tenantId**: string (Required): Tenant id of the customer -## ServiceSku +## BackupFileInfo ### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' +* **familySequenceNumber**: int: Sequence number of the backup file in the backup set +* **fileLocation**: string: Location of the backup file in shared folder +* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. -## SystemData +## BackupSetInfo ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **backupFinishedDate**: string: Date and time that the backup operation finished +* **backupSetId**: string: Id for the set of backup files +* **backupStartDate**: string: Date and time that the backup operation began +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. +* **databaseName**: string: Name of the database to which the backup set belongs +* **firstLsn**: string: First log sequence number of the backup file +* **isBackupRestored**: bool: Whether the backup set is restored or not +* **lastLsn**: string: Last log sequence number of the backup file +* **lastModifiedTime**: string: Last modified time of the backup file in share location +* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set -## TrackedResourceTags +## BlobShare ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. -## ProjectProperties +## CheckOCIDriverTaskInput ### Properties -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project +* **serverVersion**: string: Version of the source server to check against. Optional. -## DatabaseInfo +## CheckOCIDriverTaskOutput ### Properties -* **sourceDatabaseName**: string (Required): Name of the database +* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## CommandProperties +* **Discriminator**: commandType + +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. +### MongoDbCancelCommand +#### Properties +* **commandType**: 'cancel' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands + +### MongoDbFinishCommand +#### Properties +* **commandType**: 'finish' (Required): Command type. +* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command + +### MigrateMISyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. +* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. +* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. + +### MigrateSyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. +* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. +* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. + +### MongoDbRestartCommand +#### Properties +* **commandType**: 'restart' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands + ## ConnectionInfo * **Discriminator**: type @@ -151,1777 +180,1787 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags +## ConnectToSourceMySqlTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL -## ProjectFileProperties +## ConnectToSourceNonSqlTaskOutput ### Properties -* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. -* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. -* **lastModified**: string (ReadOnly): Modification DateTime. -* **mediaType**: string: File content type. This property can be modified to reflect the file content type. -* **size**: int (ReadOnly): File size. - -## ProjectTaskProperties -* **Discriminator**: taskType +* **databases**: string[] (ReadOnly): List of databases on the server +* **id**: string (ReadOnly): Result identifier +* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source +* **sourceServerBrandVersion**: string (ReadOnly): Server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### Base Properties -* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task -* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToMongoDbTaskProperties -#### Properties -* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source -* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object -* **taskType**: 'Connect.MongoDb' (Required): Task type. +## ConnectToSourceOracleSyncTaskInput +### Properties +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -### ConnectToSourceMySqlTaskProperties -#### Properties -* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection -* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.MySql' (Required): Task type. +## ConnectToSourceOracleSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of schemas on source server +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceOracleSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection -* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ConnectToSourcePostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements -* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on source server +* **id**: string (ReadOnly): Result identifier +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. +## ConnectToSourceSqlServerTaskInput +### Properties +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. +* **collectDatabases**: bool: Flag for whether to collect databases from source server. +* **collectLogins**: bool: Flag for whether to collect logins from source server. +* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. -### ConnectToSourceSqlServerSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. +## ConnectToSourceSqlServerTaskOutput +* **Discriminator**: resultType -### ConnectToTargetAzureDbForMySqlTaskProperties +### Base Properties +* **id**: string (ReadOnly): Result identifier +### ConnectToSourceSqlServerTaskOutputAgentJobLevel #### Properties -* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements -* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **jobCategory**: string (ReadOnly): The type of Agent Job. +* **jobOwner**: string (ReadOnly): The owner of the Agent Job +* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Agent Job name +* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +### ConnectToSourceSqlServerTaskOutputDatabaseLevel #### Properties -* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements -* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. +* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels +* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files +* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states +* **name**: string (ReadOnly): Database name +* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level +* **sizeMB**: int (ReadOnly): Size of the file in megabytes -### ConnectToTargetSqlMITaskProperties +### ConnectToSourceSqlServerTaskOutputLoginLevel #### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. +* **defaultDatabase**: string (ReadOnly): The default database for the login. +* **isEnabled**: bool (ReadOnly): The state of the login. +* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Login name. +* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level -### ConnectToTargetSqlMISyncTaskProperties +### ConnectToSourceSqlServerTaskOutputTaskLevel #### Properties -* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. -* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. +* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable +* **logins**: string (ReadOnly): Source logins as a map from login name to login id. +* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. -* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskInput +### Properties +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -### ConnectToTargetSqlDbSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **serverVersion**: string (ReadOnly): Version of the target server +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### GetTdeCertificatesSqlTaskProperties -#### Properties -* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. -* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. - -### GetUserTablesSqlSyncTaskProperties -#### Properties -* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### GetUserTablesMySqlTaskProperties -#### Properties -* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesMySql' (Required): Task type. - -### GetUserTablesOracleTaskProperties -#### Properties -* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. -* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesOracle' (Required): Task type. - -### GetUserTablesPostgreSqlTaskProperties -#### Properties -* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. -* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. - -### MigrateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress -* **taskType**: 'Migrate.MongoDb' (Required): Task type. - -### MigrateMySqlAzureDbForMySqlOfflineTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations -* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. - -### MigrateMySqlAzureDbForMySqlSyncTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations -* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. - -### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. - -### MigrateSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations -* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. - -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. - -### MigrateSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. - -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. - -### MigrateSsisTaskProperties -#### Properties -* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. -* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Ssis' (Required): Task type. - -### MigrateSchemaSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases -* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. - -### CheckOCIDriverTaskProperties -#### Properties -* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. -* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Check.OCI' (Required): Task type. - -### InstallOCIDriverTaskProperties -#### Properties -* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. -* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Install.OCI' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### UploadOCIDriverTaskProperties -#### Properties -* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. -* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Upload.OCI' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ValidateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object -* **taskType**: 'Validate.MongoDb' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +### Properties +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object -* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +### Properties +* **database**: string +* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem -### ValidateMigrationInputSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## ConnectToTargetSqlDbSyncTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations -* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. +## ConnectToTargetSqlDbTaskInput +### Properties +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +## ConnectToTargetSqlDbTaskOutput +### Properties +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server -## ProjectTaskPropertiesClientData +## ConnectToTargetSqlMISyncTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## CommandProperties -* **Discriminator**: commandType +## ConnectToTargetSqlMISyncTaskOutput +### Properties +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. -### MongoDbCancelCommand -#### Properties -* **commandType**: 'cancel' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## ConnectToTargetSqlMITaskInput +### Properties +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. +* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. -### MongoDbFinishCommand -#### Properties -* **commandType**: 'finish' (Required): Command type. -* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command +## ConnectToTargetSqlMITaskOutput +### Properties +* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **id**: string (ReadOnly): Result identifier +* **logins**: string[] (ReadOnly): List of logins on the target server. +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateMISyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. -* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. -* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. +## DatabaseBackupInfo +### Properties +* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. +* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. +* **databaseName**: string (ReadOnly): Database name. +* **familyCount**: int (ReadOnly): Number of files in the backup set. +* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed +* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. +* **position**: int (ReadOnly): Position of current database backup in the file. -### MigrateSyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. -* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. -* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. +## DatabaseFileInfo +### Properties +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -### MongoDbRestartCommand -#### Properties -* **commandType**: 'restart' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## DatabaseInfo +### Properties +* **sourceDatabaseName**: string (Required): Name of the database +## DatabaseTable +### Properties +* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not +* **name**: string (ReadOnly): Schema-qualified name of the table -## ODataError +## DataMigrationServiceProperties ### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have +* **virtualSubnetId**: string (Required): The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined -## MongoDbCommandInput +## FileShare ### Properties -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **password**: string: Password credential used to connect to the share location. +* **path**: string (Required): The folder path for this share. +* **userName**: string: User name credential to connect to the share location -## MongoDbFinishCommandInput +## GetTdeCertificatesSqlTaskInput ### Properties -* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. -## MigrateMISyncCompleteCommandInput +## GetTdeCertificatesSqlTaskOutput ### Properties -* **sourceDatabaseName**: string (Required): Name of managed instance database +* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrateMISyncCompleteCommandOutput +## GetUserTablesMySqlTaskInput ### Properties -* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution +* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## ReportableException +## GetUserTablesMySqlTaskOutput ### Properties -* **actionableMessage**: string: Actionable steps for this exception -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MigrateSyncCompleteCommandInput +## GetUserTablesOracleTaskInput ### Properties -* **commitTimeStamp**: string: Time stamp to complete -* **databaseName**: string (Required): Name of database +* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables -## MigrateSyncCompleteCommandOutput +## GetUserTablesOracleTaskOutput ### Properties -* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution -* **id**: string (ReadOnly): Result identifier +* **schemaName**: string (ReadOnly): The schema this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## MongoDbConnectionInfo +## GetUserTablesPostgreSqlTaskInput ### Properties -* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables -## MongoDbClusterInfo +## GetUserTablesPostgreSqlTaskOutput ### Properties -* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster -* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections -* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source -* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. +* **databaseName**: string (ReadOnly): The database this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## MongoDbDatabaseInfo +## GetUserTablesSqlSyncTaskInput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for +* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MongoDbCollectionInfo +## GetUserTablesSqlSyncTaskOutput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **databaseName**: string (Required): The name of the database containing the collection -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) -* **isSystemCollection**: bool (Required): Whether the collection is system collection -* **isView**: bool (Required): Whether the collection is a view of another collection -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -* **viewOf**: string: The name of the collection that this is a view of, if IsView is true +* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables +* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables +* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbShardKeyInfo +## GetUserTablesSqlTaskInput ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## MongoDbShardKeyField +## GetUserTablesSqlTaskOutput ### Properties -* **name**: string (Required): The name of the field -* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToSourceMySqlTaskInput +## InstallOCIDriverTaskInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL +* **driverPackageName**: string: Name of the uploaded driver package to install. -## MySqlConnectionInfo +## InstallOCIDriverTaskOutput ### Properties -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToSourceNonSqlTaskOutput +## MigrateMISyncCompleteCommandInput ### Properties -* **databases**: string[] (ReadOnly): List of databases on the server -* **id**: string (ReadOnly): Result identifier -* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source -* **sourceServerBrandVersion**: string (ReadOnly): Server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **sourceDatabaseName**: string (Required): Name of managed instance database -## ServerProperties +## MigrateMISyncCompleteCommandOutput ### Properties -* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server -* **serverEdition**: string (ReadOnly): Edition of the database server -* **serverName**: string (ReadOnly): Name of the server -* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system -* **serverPlatform**: string (ReadOnly): Name of the server platform -* **serverVersion**: string (ReadOnly): Version of the database server +* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution -## ConnectToSourceOracleSyncTaskInput +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput ### Properties -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **name**: string: Name of the database +* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## OracleConnectionInfo +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap ### Properties -* **dataSource**: string (Required): EZConnect or TNSName connection string. -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceOracleSyncTaskOutput +## MigrateMySqlAzureDbForMySqlOfflineTaskInput ### Properties -* **databases**: string[] (ReadOnly): List of schemas on source server +* **makeSourceServerReadOnly**: bool: Setting to set the source server read only +* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **startedOn**: string: Parameter to specify when the migration started +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server + +## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MigrateMySqlAzureDbForMySqlOfflineTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel +#### Properties +* **databases**: string: Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **resultType**: 'MigrationLevelOutput' (Required): Result type * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## ConnectToSourcePostgreSqlSyncTaskInput +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + + +## MigrateMySqlAzureDbForMySqlSyncDatabaseInput ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## PostgreSqlConnectionInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting ### Properties -* **databaseName**: string: Name of the database -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourcePostgreSqlSyncTaskOutput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on source server -* **id**: string (ReadOnly): Result identifier -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceSqlServerTaskInput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. -* **collectDatabases**: bool: Flag for whether to collect databases from source server. -* **collectLogins**: bool: Flag for whether to collect logins from source server. -* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. +### Additional Properties +* **Additional Properties Type**: string -## SqlConnectionInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceSqlServerTaskOutput +## MigrateMySqlAzureDbForMySqlSyncTaskInput +### Properties +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server + +## MigrateMySqlAzureDbForMySqlSyncTaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### ConnectToSourceSqlServerTaskOutputAgentJobLevel +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError #### Properties -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **jobCategory**: string (ReadOnly): The type of Agent Job. -* **jobOwner**: string (ReadOnly): The owner of the Agent Job -* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Agent Job name -* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -### ConnectToSourceSqlServerTaskOutputDatabaseLevel +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel #### Properties -* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels -* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files -* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states -* **name**: string (ReadOnly): Database name -* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level -* **sizeMB**: int (ReadOnly): Size of the file in megabytes +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -### ConnectToSourceSqlServerTaskOutputLoginLevel +### MigrateMySqlAzureDbForMySqlSyncTaskOutputError #### Properties -* **defaultDatabase**: string (ReadOnly): The default database for the login. -* **isEnabled**: bool (ReadOnly): The state of the login. -* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Login name. -* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -### ConnectToSourceSqlServerTaskOutputTaskLevel +### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel #### Properties -* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable -* **logins**: string (ReadOnly): Source logins as a map from login name to login id. -* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## MigrationEligibilityInfo +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput ### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. +* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower +* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the migration pipeline +* **schemaName**: string: Name of the source schema +* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## DatabaseFileInfo +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForMySqlTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForMySqlTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **serverVersion**: string (ReadOnly): Version of the target server -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncTaskInput ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## ConnectToTargetSqlMITaskInput -### Properties -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. -* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. +## MigrateOracleAzureDbPostgreSqlSyncTaskOutput +* **Discriminator**: resultType -## ConnectToTargetSqlMITaskOutput -### Properties -* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +### Base Properties * **id**: string (ReadOnly): Result identifier -* **logins**: string[] (ReadOnly): List of logins on the target server. -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name * **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToTargetSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## AzureActiveDirectoryApp -### Properties -* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application -* **applicationId**: string (Required): Application ID of the Azure Active Directory Application -* **tenantId**: string (Required): Tenant id of the customer -## MiSqlConnectionInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput ### Properties -* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration +* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToTargetSqlMISyncTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput ### Properties -* **database**: string -* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem +* **name**: string: Name of the table to migrate -## ConnectToTargetSqlDbTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput ### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## ConnectToTargetSqlDbTaskOutput -### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties * **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## ConnectToTargetSqlDbSyncTaskInput -### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## GetTdeCertificatesSqlTaskInput -### Properties -* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. +* **targetServer**: string (ReadOnly): Target server name +* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type +* **targetServerVersion**: string (ReadOnly): Target server version -## FileShare -### Properties -* **password**: string: Password credential used to connect to the share location. -* **path**: string (Required): The folder path for this share. -* **userName**: string: User name credential to connect to the share location +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## SelectedCertificateInput -### Properties -* **certificateName**: string (Required): Name of certificate to be exported. -* **password**: string (Required): Password to use for encrypting the exported certificate. -## GetTdeCertificatesSqlTaskOutput +## MigrateSchemaSqlServerSqlDbDatabaseInput ### Properties -* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **name**: string: Name of source database +* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target +* **targetDatabaseName**: string: Name of target database -## GetUserTablesSqlSyncTaskInput +## MigrateSchemaSqlServerSqlDbTaskInput ### Properties -* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for -* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## GetUserTablesSqlSyncTaskOutput -### Properties -* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables -* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables -* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - -## GetUserTablesSqlTaskInput -### Properties -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +## MigrateSchemaSqlServerSqlDbTaskOutput +* **Discriminator**: resultType -## GetUserTablesSqlTaskOutput -### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +### Base Properties * **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - -## GetUserTablesMySqlTaskInput -### Properties -* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel +#### Properties +* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database +* **databaseName**: string (ReadOnly): The name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database +* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database +* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database +* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesMySqlTaskOutput -### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables -* **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSchemaSqlTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## GetUserTablesOracleTaskInput -### Properties -* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables +### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## GetUserTablesOracleTaskOutput -### Properties -* **schemaName**: string (ReadOnly): The schema this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigrateSchemaSqlServerSqlDbTaskOutputError +#### Properties +* **commandText**: string (ReadOnly): Schema command which failed +* **errorText**: string (ReadOnly): Reason of failure +* **resultType**: 'SchemaErrorOutput' (Required): Result type -## DatabaseTable -### Properties -* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not -* **name**: string (ReadOnly): Schema-qualified name of the table -## GetUserTablesPostgreSqlTaskInput +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## GetUserTablesPostgreSqlTaskOutput +## MigrateSqlServerSqlDbDatabaseInputTableMap ### Properties -* **databaseName**: string (ReadOnly): The database this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## MongoDbMigrationSettings +## MigrateSqlServerSqlDbSyncDatabaseInput ### Properties -* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. -* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. -* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. -* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration +* **id**: string: Unique identifier for database +* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of database +* **schemaName**: string: Schema name to be migrated +* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Target database name +* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MongoDbMigrationSettingsDatabases +## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) - -## MongoDbDatabaseSettings -### Properties -* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. +* **Additional Properties Type**: string -## MongoDbDatabaseSettingsCollections +## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +* **Additional Properties Type**: string -## MongoDbCollectionSettings +## MigrateSqlServerSqlDbSyncDatabaseInputTableMap ### Properties -* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. -* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. +### Additional Properties +* **Additional Properties Type**: string -## MongoDbShardKeySetting +## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +### Additional Properties +* **Additional Properties Type**: string -## MongoDbThrottlingSettings +## MigrateSqlServerSqlDbSyncTaskInput ### Properties -* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel -* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 -* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using +* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## MongoDbProgress +## MigrateSqlServerSqlDbSyncTaskOutput * **Discriminator**: resultType ### Base Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -### MongoDbCollectionProgress +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError #### Properties -* **resultType**: 'Collection' (Required): The type of progress object +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateSqlServerSqlDbSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -### MongoDbDatabaseProgress -#### Properties -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **resultType**: 'Database' (Required): The type of progress object -### MongoDbMigrationProgress +## MigrateSqlServerSqlDbTaskInput +### Properties +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration + +## MigrateSqlServerSqlDbTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel #### Properties -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **resultType**: 'Migration' (Required): The type of progress object +* **databaseName**: string (ReadOnly): Name of the item +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message +### MigrateSqlServerSqlDbTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +#### Properties +* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type -## MongoDbError -### Properties -* **code**: string: The non-localized, machine-readable code that describes the error or warning -* **count**: int: The number of times the error or warning has occurred -* **message**: string: The localized, human-readable message that describes the error or warning -* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## MongoDbDatabaseProgressCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +### MigrateSqlServerSqlDbTaskOutputValidationResult +#### Properties +* **resultType**: 'MigrationValidationOutput' (Required): Result type -## MongoDbCollectionProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MigrateSqlServerSqlDbTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MongoDbMigrationProgressDatabases +## MigrateSqlServerSqlMIDatabaseInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) +* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination -## MongoDbDatabaseProgress +## MigrateSqlServerSqlMISyncTaskInput ### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## MongoDbDatabaseProgressCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +## MigrateSqlServerSqlMISyncTaskOutput +* **Discriminator**: resultType -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +#### Properties +* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) +* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to +* **endedOn**: string (ReadOnly): Database migration end time +* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not +* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sourceDatabaseName**: string (ReadOnly): Name of the database +* **startedOn**: string (ReadOnly): Database migration start time -## MigrateMySqlAzureDbForMySqlOfflineTaskInput -### Properties -* **makeSourceServerReadOnly**: bool: Setting to set the source server read only -* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **startedOn**: string: Parameter to specify when the migration started -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +### MigrateSqlServerSqlMISyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **databaseErrorCount**: int (ReadOnly): Number of database level errors +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerName**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerName**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput -### Properties -* **name**: string: Name of the database -* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap +## MigrateSqlServerSqlMITaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes +* **selectedAgentJobs**: string[]: Agent Jobs to migrate. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **selectedLogins**: string[]: Logins to migrate. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MigrateMySqlAzureDbForMySqlOfflineTaskOutput +## MigrateSqlServerSqlMITaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel +### MigrateSqlServerSqlMITaskOutputAgentJobLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **message**: string (ReadOnly): Migration progress message +* **name**: string (ReadOnly): Agent Job name. +* **resultType**: 'AgentJobLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sizeMB**: int (ReadOnly): Size of the database in megabytes +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlMITaskOutputLoginLevel +#### Properties +* **endedOn**: string (ReadOnly): Login migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login +* **loginName**: string (ReadOnly): Login name. +* **message**: string (ReadOnly): Login migration progress message +* **resultType**: 'LoginLevelOutput' (Required): Result type +* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. +* **startedOn**: string (ReadOnly): Login migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputMigrationLevel #### Properties -* **databaseName**: string (ReadOnly): Name of the database +* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id * **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item * **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **logins**: string (ReadOnly): Selected logins as a map from name to id * **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **serverRoleResults**: string (ReadOnly): Map of server role migration results. +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version * **startedOn**: string (ReadOnly): Migration start time * **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel +## MigrateSsisTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## MigrateSsisTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSsisTaskOutputMigrationLevel #### Properties -* **databases**: string: Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. * **endedOn**: string (ReadOnly): Migration end time * **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated * **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. * **resultType**: 'MigrationLevelOutput' (Required): Result type * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration * **startedOn**: string (ReadOnly): Migration start time * **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message * **targetServerBrandVersion**: string (ReadOnly): Target server brand version * **targetServerVersion**: string (ReadOnly): Target server version -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel +### MigrateSsisTaskOutputProjectLevel #### Properties * **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **folderName**: string (ReadOnly): Name of the folder +* **message**: string (ReadOnly): Migration progress message +* **projectName**: string (ReadOnly): Name of the project +* **resultType**: 'SsisProjectLevelOutput' (Required): Result type +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration * **startedOn**: string (ReadOnly): Migration start time * **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +## MigrateSyncCompleteCommandInput +### Properties +* **commitTimeStamp**: string: Time stamp to complete +* **databaseName**: string (Required): Name of database + +## MigrateSyncCompleteCommandOutput +### Properties +* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +* **id**: string (ReadOnly): Result identifier + +## MigrationEligibilityInfo +### Properties +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. + ## MigrationReportResult ### Properties * **id**: string: Migration validation result identifier * **reportUrl**: string: The url of the report. -## MigrateMySqlAzureDbForMySqlSyncTaskInput +## MigrationValidationDatabaseSummaryResult ### Properties -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **endedOn**: string (ReadOnly): Validation end time +* **id**: string (ReadOnly): Result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database -## MigrateMySqlAzureDbForMySqlSyncDatabaseInput +## MigrationValidationOptions ### Properties -* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting +## MigrationValidationResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Migration validation result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting +## MigrationValidationResultSummaryResults ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap +## MiSqlConnectionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting +## MongoDbClusterInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlSyncTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster +* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections +* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source +* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. -### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +## MongoDbCollectionInfo +### Properties +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **databaseName**: string (Required): The name of the database containing the collection +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) +* **isSystemCollection**: bool (Required): Whether the collection is system collection +* **isView**: bool (Required): Whether the collection is a view of another collection +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **viewOf**: string: The name of the collection that this is a view of, if IsView is true -### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## MongoDbCollectionProgress +### Properties +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +## MongoDbCollectionSettings +### Properties +* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. +* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. -## SyncMigrationDatabaseErrorEvent +## MongoDbCommandInput ### Properties -* **eventText**: string (ReadOnly): Event text. -* **eventTypeString**: string (ReadOnly): Event type. -* **timestampString**: string (ReadOnly): String value of timestamp. +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## MigrateOracleAzureDbPostgreSqlSyncTaskInput +## MongoDbConnectionInfo ### Properties -* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput +## MongoDbDatabaseInfo ### Properties -* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower -* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the migration pipeline -* **schemaName**: string: Name of the source schema -* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbDatabaseProgress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbDatabaseSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateOracleAzureDbPostgreSqlSyncTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## MongoDbDatabaseSettingsCollections +### Properties +### Additional Properties +* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +## MongoDbError +### Properties +* **code**: string: The non-localized, machine-readable code that describes the error or warning +* **count**: int: The number of times the error or warning has occurred +* **message**: string: The localized, human-readable message that describes the error or warning +* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput +## MongoDbFinishCommandInput ### Properties -* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput +## MongoDbMigrationProgress ### Properties -* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration -* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput +## MongoDbMigrationProgressDatabases ### Properties -* **name**: string: Name of the table to migrate +### Additional Properties +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbMigrationSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. +* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. +* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. +* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbMigrationSettingsDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +## MongoDbProgress * **Discriminator**: resultType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MongoDbCollectionProgress #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **resultType**: 'Collection' (Required): The type of progress object -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +### MongoDbDatabaseProgress #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. -* **targetServer**: string (ReadOnly): Target server name -* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type -* **targetServerVersion**: string (ReadOnly): Target server version +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **resultType**: 'Database' (Required): The type of progress object -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +### MongoDbMigrationProgress #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes - +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **resultType**: 'Migration' (Required): The type of progress object -## MigrateSqlServerSqlDbSyncTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## MigrateSqlServerSqlDbSyncDatabaseInput +## MongoDbProgressErrors ### Properties -* **id**: string: Unique identifier for database -* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of database -* **schemaName**: string: Schema name to be migrated -* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Target database name -* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputTableMap +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting +## MongoDbShardKeyField ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of the field +* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering -## MigrationValidationOptions +## MongoDbShardKeyInfo ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -## MigrateSqlServerSqlDbSyncTaskOutput -* **Discriminator**: resultType +## MongoDbShardKeySetting +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +## MongoDbThrottlingSettings +### Properties +* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel +* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 +* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +## MySqlConnectionInfo +### Properties +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigrateSqlServerSqlDbSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error -### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel -#### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +## OracleConnectionInfo +### Properties +* **dataSource**: string (Required): EZConnect or TNSName connection string. +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigrateSqlServerSqlDbSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## OracleOCIDriverInfo +### Properties +* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. +* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' +* **driverName**: string (ReadOnly): The name of the driver package +* **driverSize**: string (ReadOnly): The size in bytes of the driver package +* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. +* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +## OrphanedUserInfo +### Properties +* **databaseName**: string: Parent database of the user +* **name**: string: Name of the orphaned user -## MigrateSqlServerSqlMITaskInput +## PostgreSqlConnectionInfo ### Properties -* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes -* **selectedAgentJobs**: string[]: Agent Jobs to migrate. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **selectedLogins**: string[]: Logins to migrate. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **databaseName**: string: Name of the database +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## BlobShare +## ProjectFileProperties ### Properties -* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. +* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. +* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. +* **lastModified**: string (ReadOnly): Modification DateTime. +* **mediaType**: string: File content type. This property can be modified to reflect the file content type. +* **size**: int (ReadOnly): File size. -## MigrateSqlServerSqlMIDatabaseInput +## ProjectProperties ### Properties -* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project -## MigrateSqlServerSqlMITaskOutput -* **Discriminator**: resultType +## ProjectTaskProperties +* **Discriminator**: taskType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMITaskOutputAgentJobLevel +* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task +* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToMongoDbTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **message**: string (ReadOnly): Migration progress message -* **name**: string (ReadOnly): Agent Job name. -* **resultType**: 'AgentJobLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source +* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object +* **taskType**: 'Connect.MongoDb' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputDatabaseLevel +### ConnectToSourceMySqlTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sizeMB**: int (ReadOnly): Size of the database in megabytes -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection +* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.MySql' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputError +### ConnectToSourceOracleSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection +* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputLoginLevel +### ConnectToSourcePostgreSqlSyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Login migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login -* **loginName**: string (ReadOnly): Login name. -* **message**: string (ReadOnly): Login migration progress message -* **resultType**: 'LoginLevelOutput' (Required): Result type -* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. -* **startedOn**: string (ReadOnly): Login migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements +* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputMigrationLevel +### ConnectToSourceSqlServerTaskProperties #### Properties -* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **logins**: string (ReadOnly): Selected logins as a map from name to id -* **message**: string (ReadOnly): Migration progress message -* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **serverRoleResults**: string (ReadOnly): Map of server role migration results. -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. + +### ConnectToSourceSqlServerSyncTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. +### ConnectToTargetAzureDbForMySqlTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements +* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. -## OrphanedUserInfo -### Properties -* **databaseName**: string: Parent database of the user -* **name**: string: Name of the orphaned user +### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements +* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskOutput -* **Discriminator**: resultType +### ConnectToTargetSqlMISyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. +* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) -* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to -* **endedOn**: string (ReadOnly): Database migration end time -* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not -* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sourceDatabaseName**: string (ReadOnly): Name of the database -* **startedOn**: string (ReadOnly): Database migration start time +* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. +* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputError +### ConnectToTargetSqlDbTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +### ConnectToTargetSqlDbSyncTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **databaseErrorCount**: int (ReadOnly): Number of database level errors -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerName**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerName**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. +### GetTdeCertificatesSqlTaskProperties +#### Properties +* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. +* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. -## BackupSetInfo -### Properties -* **backupFinishedDate**: string: Date and time that the backup operation finished -* **backupSetId**: string: Id for the set of backup files -* **backupStartDate**: string: Date and time that the backup operation began -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. -* **databaseName**: string: Name of the database to which the backup set belongs -* **firstLsn**: string: First log sequence number of the backup file -* **isBackupRestored**: bool: Whether the backup set is restored or not -* **lastLsn**: string: Last log sequence number of the backup file -* **lastModifiedTime**: string: Last modified time of the backup file in share location -* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set +### GetUserTablesSqlSyncTaskProperties +#### Properties +* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. -## BackupFileInfo -### Properties -* **familySequenceNumber**: int: Sequence number of the backup file in the backup set -* **fileLocation**: string: Location of the backup file in shared folder -* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. -## MigrateSqlServerSqlDbTaskInput -### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### GetUserTablesMySqlTaskProperties +#### Properties +* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesMySql' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInput -### Properties -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +### GetUserTablesOracleTaskProperties +#### Properties +* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. +* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesOracle' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### GetUserTablesPostgreSqlTaskProperties +#### Properties +* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. +* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +### MigrateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress +* **taskType**: 'Migrate.MongoDb' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +### MigrateMySqlAzureDbForMySqlOfflineTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations +* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### MigrateMySqlAzureDbForMySqlSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations +* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputValidationResult +### MigrateSqlServerSqlDbSyncTaskProperties #### Properties -* **resultType**: 'MigrationValidationOutput' (Required): Result type +* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations +* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### MigrateSqlServerSqlMITaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. +### MigrateSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## MigrationValidationResult -### Properties -* **id**: string (ReadOnly): Migration validation result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. -## MigrationValidationResultSummaryResults -### Properties -### Additional Properties -* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) +### MigrateSsisTaskProperties +#### Properties +* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. +* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Ssis' (Required): Task type. -## MigrationValidationDatabaseSummaryResult -### Properties -* **endedOn**: string (ReadOnly): Validation end time -* **id**: string (ReadOnly): Result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +### MigrateSchemaSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases +* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. + +### CheckOCIDriverTaskProperties +#### Properties +* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. +* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Check.OCI' (Required): Task type. -## MigrateSsisTaskInput -### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### InstallOCIDriverTaskProperties +#### Properties +* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. +* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Install.OCI' (Required): Task type. -## SsisMigrationInfo -### Properties -* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS +### UploadOCIDriverTaskProperties +#### Properties +* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. +* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Upload.OCI' (Required): Task type. -## MigrateSsisTaskOutput -* **Discriminator**: resultType +### ValidateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object +* **taskType**: 'Validate.MongoDb' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSsisTaskOutputMigrationLevel +### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object +* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. -### MigrateSsisTaskOutputProjectLevel +### ValidateMigrationInputSqlServerSqlMITaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **folderName**: string (ReadOnly): Name of the folder -* **message**: string (ReadOnly): Migration progress message -* **projectName**: string (ReadOnly): Name of the project -* **resultType**: 'SsisProjectLevelOutput' (Required): Result type -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. + +### ValidateMigrationInputSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations +* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. -## MigrateSchemaSqlServerSqlDbTaskInput + +## ProjectTaskPropertiesClientData ### Properties -* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### Additional Properties +* **Additional Properties Type**: string -## MigrateSchemaSqlServerSqlDbDatabaseInput +## ReportableException ### Properties -* **name**: string: Name of source database -* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target -* **targetDatabaseName**: string: Name of target database +* **actionableMessage**: string: Actionable steps for this exception +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace ## SchemaMigrationSetting ### Properties * **fileId**: string: Resource Identifier of a file resource containing the uploaded schema file * **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target -## MigrateSchemaSqlServerSqlDbTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel -#### Properties -* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database -* **databaseName**: string (ReadOnly): The name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database -* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database -* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database -* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration - -### MigrateSchemaSqlTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## SelectedCertificateInput +### Properties +* **certificateName**: string (Required): Name of certificate to be exported. +* **password**: string (Required): Password to use for encrypting the exported certificate. -### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +## ServerProperties +### Properties +* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server +* **serverEdition**: string (ReadOnly): Edition of the database server +* **serverName**: string (ReadOnly): Name of the server +* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system +* **serverPlatform**: string (ReadOnly): Name of the server platform +* **serverVersion**: string (ReadOnly): Version of the database server -### MigrateSchemaSqlServerSqlDbTaskOutputError -#### Properties -* **commandText**: string (ReadOnly): Schema command which failed -* **errorText**: string (ReadOnly): Reason of failure -* **resultType**: 'SchemaErrorOutput' (Required): Result type +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## CheckOCIDriverTaskInput +## SsisMigrationInfo ### Properties -* **serverVersion**: string: Version of the source server to check against. Optional. +* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS -## CheckOCIDriverTaskOutput +## SyncMigrationDatabaseErrorEvent ### Properties -* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **eventText**: string (ReadOnly): Event text. +* **eventTypeString**: string (ReadOnly): Event type. +* **timestampString**: string (ReadOnly): String value of timestamp. -## OracleOCIDriverInfo +## SystemData ### Properties -* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. -* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' -* **driverName**: string (ReadOnly): The name of the driver package -* **driverSize**: string (ReadOnly): The size in bytes of the driver package -* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. -* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## InstallOCIDriverTaskInput +## TrackedResourceTags ### Properties -* **driverPackageName**: string: Name of the uploaded driver package to install. +### Additional Properties +* **Additional Properties Type**: string -## InstallOCIDriverTaskOutput +## TrackedResourceTags ### Properties -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string ## UploadOCIDriverTaskInput ### Properties @@ -1932,36 +1971,19 @@ * **driverPackageName**: string (ReadOnly): The name of the driver package that was validated and uploaded. * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbMigrationProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown - -## MongoDbMigrationProgressDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) - -## MongoDbProgressErrors +## ValidateMigrationInputSqlServerSqlMISyncTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## ValidateOracleAzureDbPostgreSqlSyncTaskOutput +## ValidateMigrationInputSqlServerSqlMISyncTaskOutput ### Properties +* **id**: string (ReadOnly): Database identifier +* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateMigrationInputSqlServerSqlMITaskInput @@ -1985,30 +2007,8 @@ * **name**: string (ReadOnly): Name of database * **restoreDatabaseNameErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with the RestoreDatabaseName -## DatabaseBackupInfo -### Properties -* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. -* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. -* **databaseName**: string (ReadOnly): Database name. -* **familyCount**: int (ReadOnly): Number of files in the backup set. -* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed -* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. -* **position**: int (ReadOnly): Position of current database backup in the file. - -## ValidateMigrationInputSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance - -## ValidateMigrationInputSqlServerSqlMISyncTaskOutput +## ValidateOracleAzureDbPostgreSqlSyncTaskOutput ### Properties -* **id**: string (ReadOnly): Database identifier -* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateSyncMigrationInputSqlServerTaskInput diff --git a/generated/datamigration/microsoft.datamigration/2021-10-30-preview/types.md b/generated/datamigration/microsoft.datamigration/2021-10-30-preview/types.md index c0578d8d46..476dca78ae 100644 --- a/generated/datamigration/microsoft.datamigration/2021-10-30-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2021-10-30-preview/types.md @@ -93,34 +93,16 @@ * **ApiVersion**: 2021-10-30-preview * **Output**: [IntegrationRuntimeMonitoringData](#integrationruntimemonitoringdata) -## DatabaseMigrationPropertiesSqlMi -### Properties -* **backupConfiguration**: [BackupConfiguration](#backupconfiguration): Backup Configuration -* **endedOn**: string (ReadOnly): Database migration end time. -* **kind**: 'SqlMi' | 'SqlVm' | string (Required) -* **migrationFailureError**: [ErrorInfo](#errorinfo) (ReadOnly): Error details -* **migrationOperationId**: string: ID tracking current migration operation. -* **migrationService**: string: Resource Id of the Migration Service. -* **migrationStatus**: string (ReadOnly): Migration status. -* **migrationStatusDetails**: [MigrationStatusDetails](#migrationstatusdetails) (ReadOnly): Detailed status of current migration. -* **offlineConfiguration**: [OfflineConfiguration](#offlineconfiguration): Offline configuration -* **provisioningError**: string: Error message for migration provisioning failure, if any. -* **provisioningState**: string (ReadOnly): Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. -* **scope**: string: Scope of the database. -* **sourceDatabaseName**: string: Name of the source database. -* **sourceSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection -* **startedOn**: string (ReadOnly): Database migration start time. -* **targetDatabaseCollation**: string: Database collation to be used for the target database. - -## BackupConfiguration +## AuthenticationKeys ### Properties -* **sourceLocation**: [SourceLocation](#sourcelocation): Source Location details of backups. -* **targetLocation**: [TargetLocation](#targetlocation): Target Location details for optional copy of backups +* **authKey1**: string (ReadOnly): The first authentication key. +* **authKey2**: string (ReadOnly): The second authentication key. -## SourceLocation +## AzureActiveDirectoryApp ### Properties -* **azureBlob**: [AzureBlob](#azureblob): Azure Blob Details -* **fileShare**: [SqlFileShare](#sqlfileshare): File share +* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application +* **applicationId**: string (Required): Application ID of the Azure Active Directory Application +* **tenantId**: string (Required): Tenant id of the customer ## AzureBlob ### Properties @@ -128,122 +110,76 @@ * **blobContainerName**: string: Blob container name where backups are stored. * **storageAccountResourceId**: string: Resource Id of the storage account where backups are stored. -## SqlFileShare -### Properties -* **password**: string (WriteOnly): Password for username to access file share location. -* **path**: string: Location as SMB share or local drive where backups are placed. -* **username**: string: Username to access the file share location for backups. - -## TargetLocation +## BackupConfiguration ### Properties -* **accountKey**: string: Storage Account Key. -* **storageAccountResourceId**: string: Resource Id of the storage account copying backups. +* **sourceLocation**: [SourceLocation](#sourcelocation): Source Location details of backups. +* **targetLocation**: [TargetLocation](#targetlocation): Target Location details for optional copy of backups -## ErrorInfo +## BackupFileInfo ### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message. +* **familySequenceNumber**: int: Sequence number of the backup file in the backup set +* **fileLocation**: string: Location of the backup file in shared folder +* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. -## MigrationStatusDetails +## BackupSetInfo ### Properties -* **activeBackupSets**: [SqlBackupSetInfo](#sqlbackupsetinfo)[] (ReadOnly): Backup sets that are currently active. -* **blobContainerName**: string (ReadOnly): Name of blob container. -* **completeRestoreErrorMessage**: string (ReadOnly): Complete restore error message, if any -* **currentRestoringFilename**: string (ReadOnly): File name that is currently being restored. -* **fileUploadBlockingErrors**: string[] (ReadOnly): File upload blocking errors, if any. -* **fullBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set -* **invalidFiles**: string[] (ReadOnly): Files that are not valid backup files. -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not. -* **lastRestoredBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set -* **lastRestoredFilename**: string (ReadOnly): Last restored file name. -* **migrationState**: string (ReadOnly): Current State of Migration. -* **pendingLogBackupsCount**: int (ReadOnly): Total pending log backups. -* **restoreBlockingReason**: string (ReadOnly): Restore blocking reason, if any +* **backupFinishedDate**: string: Date and time that the backup operation finished +* **backupSetId**: string: Id for the set of backup files +* **backupStartDate**: string: Date and time that the backup operation began +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. +* **databaseName**: string: Name of the database to which the backup set belongs +* **firstLsn**: string: First log sequence number of the backup file +* **isBackupRestored**: bool: Whether the backup set is restored or not +* **lastLsn**: string: Last log sequence number of the backup file +* **lastModifiedTime**: string: Last modified time of the backup file in share location +* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set -## SqlBackupSetInfo +## BlobShare ### Properties -* **backupFinishDate**: string (ReadOnly): Backup end time. -* **backupSetId**: string (ReadOnly): Backup set id. -* **backupStartDate**: string (ReadOnly): Backup start date. -* **backupType**: string (ReadOnly): Backup type. -* **familyCount**: int (ReadOnly): Media family count -* **firstLSN**: string (ReadOnly): First LSN of the backup set. -* **hasBackupChecksums**: bool (ReadOnly): Has Backup Checksums -* **ignoreReasons**: string[] (ReadOnly): The reasons why the backup set is ignored -* **isBackupRestored**: bool (ReadOnly): Whether this backup set has been restored or not. -* **lastLSN**: string (ReadOnly): Last LSN of the backup set. -* **listOfBackupFiles**: [SqlBackupFileInfo](#sqlbackupfileinfo)[] (ReadOnly): List of files in the backup set. +* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. -## SqlBackupFileInfo +## CheckOCIDriverTaskInput ### Properties -* **copyDuration**: int (ReadOnly): Copy Duration in seconds -* **copyThroughput**: int (ReadOnly): Copy throughput in KBps -* **dataRead**: int (ReadOnly): Bytes read -* **dataWritten**: int (ReadOnly): Bytes written -* **familySequenceNumber**: int (ReadOnly): Media family sequence number -* **fileName**: string (ReadOnly): File name. -* **status**: string (ReadOnly): Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) -* **totalSize**: int (ReadOnly): File size in bytes +* **serverVersion**: string: Version of the source server to check against. Optional. -## OfflineConfiguration +## CheckOCIDriverTaskOutput ### Properties -* **lastBackupName**: string: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. -* **offline**: bool: Offline migration +* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## SqlConnectionInformation -### Properties -* **authentication**: string: Authentication type. -* **dataSource**: string: Data source. -* **encryptConnection**: bool: Whether to encrypt connection or not. -* **password**: string: Password to connect to source SQL. -* **trustServerCertificate**: bool: Whether to trust server certificate or not. -* **userName**: string: User name to connect to source SQL. +## CommandProperties +* **Discriminator**: commandType -## SystemData -### Properties -* **createdAt**: string -* **createdBy**: string -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string -* **lastModifiedAt**: string -* **lastModifiedBy**: string -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. +### MongoDbCancelCommand +#### Properties +* **commandType**: 'cancel' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands -## DataMigrationServiceProperties -### Properties -* **autoStopDelay**: string: The time delay before the service is auto-stopped when idle. -* **deleteResourcesOnStop**: bool: Whether service resources should be deleted when stopped. (Turned on by default) -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have -* **virtualSubnetId**: string: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined +### MongoDbFinishCommand +#### Properties +* **commandType**: 'finish' (Required): Command type. +* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command -## ServiceSku -### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' +### MigrateMISyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. +* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. +* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. +* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. +* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. -## ProjectProperties -### Properties -* **azureAuthenticationInfo**: string: Field that defines the Azure active directory application info, used to connect to the target Azure resource -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project +### MongoDbRestartCommand +#### Properties +* **commandType**: 'restart' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands -## DatabaseInfo -### Properties -* **sourceDatabaseName**: string (Required): Name of the database ## ConnectionInfo * **Discriminator**: type @@ -305,868 +241,1255 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags +## ConnectToSourceMySqlTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL -## ProjectFileProperties +## ConnectToSourceNonSqlTaskOutput ### Properties -* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. -* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. -* **lastModified**: string (ReadOnly): Modification DateTime. -* **mediaType**: string: File content type. This property can be modified to reflect the file content type. -* **size**: int (ReadOnly): File size. - -## ProjectTaskProperties -* **Discriminator**: taskType - -### Base Properties -* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task -* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToMongoDbTaskProperties -#### Properties -* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source -* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object -* **taskType**: 'Connect.MongoDb' (Required): Task type. +* **databases**: string[] (ReadOnly): List of databases on the server +* **id**: string (ReadOnly): Result identifier +* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source +* **sourceServerBrandVersion**: string (ReadOnly): Server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceMySqlTaskProperties -#### Properties -* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection -* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.MySql' (Required): Task type. +## ConnectToSourceOracleSyncTaskInput +### Properties +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -### ConnectToSourceOracleSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection -* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. +## ConnectToSourceOracleSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of schemas on source server +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourcePostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements -* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on source server +* **id**: string (ReadOnly): Result identifier +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceSqlServerSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. +## ConnectToSourceSqlServerTaskInput +### Properties +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. +* **collectDatabases**: bool: Flag for whether to collect databases from source server. +* **collectLogins**: bool: Flag for whether to collect logins from source server. +* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. -### ConnectToTargetAzureDbForMySqlTaskProperties -#### Properties -* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements -* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. +## ConnectToSourceSqlServerTaskOutput +* **Discriminator**: resultType -### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +### Base Properties +* **id**: string (ReadOnly): Result identifier +### ConnectToSourceSqlServerTaskOutputAgentJobLevel #### Properties -* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements -* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **jobCategory**: string (ReadOnly): The type of Agent Job. +* **jobOwner**: string (ReadOnly): The owner of the Agent Job +* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Agent Job name +* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetSqlMITaskProperties +### ConnectToSourceSqlServerTaskOutputDatabaseLevel #### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. +* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels +* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files +* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states +* **name**: string (ReadOnly): Database name +* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level +* **sizeMB**: int (ReadOnly): Size of the file in megabytes -### ConnectToTargetSqlMISyncTaskProperties +### ConnectToSourceSqlServerTaskOutputLoginLevel #### Properties -* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. -* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. +* **defaultDatabase**: string (ReadOnly): The default database for the login. +* **isEnabled**: bool (ReadOnly): The state of the login. +* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Login name. +* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level -### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties +### ConnectToSourceSqlServerTaskOutputTaskLevel #### Properties -* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. -* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable +* **logins**: string (ReadOnly): Source logins as a map from login name to login id. +* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -### ConnectToTargetSqlDbSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskInput +### Properties +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -### GetTdeCertificatesSqlTaskProperties -#### Properties -* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. -* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **serverVersion**: string (ReadOnly): Version of the target server +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### GetUserTablesSqlSyncTaskProperties -#### Properties -* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.Sql' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### GetUserTablesMySqlTaskProperties -#### Properties -* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesMySql' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +### Properties +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### GetUserTablesOracleTaskProperties -#### Properties -* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. -* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesOracle' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### GetUserTablesPostgreSqlTaskProperties -#### Properties -* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. -* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +### Properties +* **database**: string +* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem -### MigrateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress -* **taskType**: 'Migrate.MongoDb' (Required): Task type. +## ConnectToTargetSqlDbSyncTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MigrateMySqlAzureDbForMySqlOfflineTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations -* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. +## ConnectToTargetSqlDbTaskInput +### Properties +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MigrateMySqlAzureDbForMySqlSyncTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations -* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. +## ConnectToTargetSqlDbTaskOutput +### Properties +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server -### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +## ConnectToTargetSqlMISyncTaskInput +### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. +## ConnectToTargetSqlMISyncTaskOutput +### Properties +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations -* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. +## ConnectToTargetSqlMITaskInput +### Properties +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. +* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. +## ConnectToTargetSqlMITaskOutput +### Properties +* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **id**: string (ReadOnly): Result identifier +* **logins**: string[] (ReadOnly): List of logins on the target server. +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## DatabaseBackupInfo +### Properties +* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. +* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. +* **databaseName**: string (ReadOnly): Database name. +* **familyCount**: int (ReadOnly): Number of files in the backup set. +* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed +* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. +* **position**: int (ReadOnly): Position of current database backup in the file. -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. +## DatabaseFileInfo +### Properties +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -### MigrateSsisTaskProperties -#### Properties -* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. -* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Ssis' (Required): Task type. +## DatabaseInfo +### Properties +* **sourceDatabaseName**: string (Required): Name of the database -### MigrateSchemaSqlServerSqlDbTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases -* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. +## DatabaseMigrationPropertiesSqlMi +### Properties +* **backupConfiguration**: [BackupConfiguration](#backupconfiguration): Backup Configuration +* **endedOn**: string (ReadOnly): Database migration end time. +* **kind**: 'SqlMi' | 'SqlVm' | string (Required) +* **migrationFailureError**: [ErrorInfo](#errorinfo) (ReadOnly): Error details +* **migrationOperationId**: string: ID tracking current migration operation. +* **migrationService**: string: Resource Id of the Migration Service. +* **migrationStatus**: string (ReadOnly): Migration status. +* **migrationStatusDetails**: [MigrationStatusDetails](#migrationstatusdetails) (ReadOnly): Detailed status of current migration. +* **offlineConfiguration**: [OfflineConfiguration](#offlineconfiguration): Offline configuration +* **provisioningError**: string: Error message for migration provisioning failure, if any. +* **provisioningState**: string (ReadOnly): Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. +* **scope**: string: Scope of the database. +* **sourceDatabaseName**: string: Name of the source database. +* **sourceSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection +* **startedOn**: string (ReadOnly): Database migration start time. +* **targetDatabaseCollation**: string: Database collation to be used for the target database. -### CheckOCIDriverTaskProperties -#### Properties -* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. -* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Check.OCI' (Required): Task type. +## DatabaseTable +### Properties +* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not +* **name**: string (ReadOnly): Schema-qualified name of the table -### InstallOCIDriverTaskProperties +## DataMigrationServiceProperties +### Properties +* **autoStopDelay**: string: The time delay before the service is auto-stopped when idle. +* **deleteResourcesOnStop**: bool: Whether service resources should be deleted when stopped. (Turned on by default) +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have +* **virtualSubnetId**: string: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined + +## ErrorInfo +### Properties +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message. + +## FileShare +### Properties +* **password**: string: Password credential used to connect to the share location. +* **path**: string (Required): The folder path for this share. +* **userName**: string: User name credential to connect to the share location + +## GetTdeCertificatesSqlTaskInput +### Properties +* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. + +## GetTdeCertificatesSqlTaskOutput +### Properties +* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## GetUserTablesMySqlTaskInput +### Properties +* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for + +## GetUserTablesMySqlTaskOutput +### Properties +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## GetUserTablesOracleTaskInput +### Properties +* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables + +## GetUserTablesOracleTaskOutput +### Properties +* **schemaName**: string (ReadOnly): The schema this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task + +## GetUserTablesPostgreSqlTaskInput +### Properties +* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables + +## GetUserTablesPostgreSqlTaskOutput +### Properties +* **databaseName**: string (ReadOnly): The database this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task + +## GetUserTablesSqlSyncTaskInput +### Properties +* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for +* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## GetUserTablesSqlSyncTaskOutput +### Properties +* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables +* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables +* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## GetUserTablesSqlTaskInput +### Properties +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for + +## GetUserTablesSqlTaskOutput +### Properties +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## InstallOCIDriverTaskInput +### Properties +* **driverPackageName**: string: Name of the uploaded driver package to install. + +## InstallOCIDriverTaskOutput +### Properties +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## IntegrationRuntimeMonitoringData +### Properties +* **name**: string (ReadOnly): The name of Integration Runtime. +* **nodes**: [NodeMonitoringData](#nodemonitoringdata)[] (ReadOnly): Integration Runtime node monitoring data. + +## MigrateMISyncCompleteCommandInput +### Properties +* **sourceDatabaseName**: string (Required): Name of managed instance database + +## MigrateMISyncCompleteCommandOutput +### Properties +* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution + +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput +### Properties +* **name**: string: Name of the database +* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. + +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MigrateMySqlAzureDbForMySqlOfflineTaskInput +### Properties +* **makeSourceServerReadOnly**: bool: Setting to set the source server read only +* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **startedOn**: string: Parameter to specify when the migration started +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server + +## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MigrateMySqlAzureDbForMySqlOfflineTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel #### Properties -* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. -* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Install.OCI' (Required): Task type. +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -### UploadOCIDriverTaskProperties +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError #### Properties -* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. -* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Upload.OCI' (Required): Task type. +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### ValidateMongoDbTaskProperties +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel #### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object -* **taskType**: 'Validate.MongoDb' (Required): Task type. +* **databases**: string: Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel #### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object -* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. -### ValidateMigrationInputSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## MigrateMySqlAzureDbForMySqlSyncDatabaseInput +### Properties +* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations -* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting +### Properties +### Additional Properties +* **Additional Properties Type**: string +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ProjectTaskPropertiesClientData +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap ### Properties ### Additional Properties * **Additional Properties Type**: string -## CommandProperties -* **Discriminator**: commandType +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MigrateMySqlAzureDbForMySqlSyncTaskInput +### Properties +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server + +## MigrateMySqlAzureDbForMySqlSyncTaskOutput +* **Discriminator**: resultType ### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. -### MongoDbCancelCommand +* **id**: string (ReadOnly): Result identifier +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError #### Properties -* **commandType**: 'cancel' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -### MongoDbFinishCommand +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel #### Properties -* **commandType**: 'finish' (Required): Command type. -* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -### MigrateMISyncCompleteCommandProperties +### MigrateMySqlAzureDbForMySqlSyncTaskOutputError #### Properties -* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. -* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. -* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### MigrateSyncCompleteCommandProperties +### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel #### Properties -* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. -* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. -* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -### MongoDbRestartCommand +### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel #### Properties -* **commandType**: 'restart' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## ODataError +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput ### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error +* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower +* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the migration pipeline +* **schemaName**: string: Name of the source schema +* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MongoDbCommandInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +### Additional Properties +* **Additional Properties Type**: string -## MongoDbFinishCommandInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +### Additional Properties +* **Additional Properties Type**: string -## MigrateMISyncCompleteCommandInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap ### Properties -* **sourceDatabaseName**: string (Required): Name of managed instance database +### Additional Properties +* **Additional Properties Type**: string -## MigrateMISyncCompleteCommandOutput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution +### Additional Properties +* **Additional Properties Type**: string -## ReportableException +## MigrateOracleAzureDbPostgreSqlSyncTaskInput ### Properties -* **actionableMessage**: string: Actionable steps for this exception -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace +* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## MigrateSyncCompleteCommandInput -### Properties -* **commitTimeStamp**: string: Time stamp to complete -* **databaseName**: string (Required): Name of database +## MigrateOracleAzureDbPostgreSqlSyncTaskOutput +* **Discriminator**: resultType -## MigrateSyncCompleteCommandOutput -### Properties -* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +### Base Properties * **id**: string (ReadOnly): Result identifier +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## MongoDbConnectionInfo -### Properties -* **additionalSettings**: string: Additional connection settings -* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **enforceSSL**: bool -* **password**: string: Password credential. -* **port**: int: port for server -* **serverBrandVersion**: string: server brand version -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## MongoDbClusterInfo -### Properties -* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster -* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections -* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source -* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. -## MongoDbDatabaseInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration +* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MongoDbCollectionInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **databaseName**: string (Required): The name of the database containing the collection -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) -* **isSystemCollection**: bool (Required): Whether the collection is system collection -* **isView**: bool (Required): Whether the collection is a view of another collection -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -* **viewOf**: string: The name of the collection that this is a view of, if IsView is true +### Additional Properties +* **Additional Properties Type**: string -## MongoDbShardKeyInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +### Additional Properties +* **Additional Properties Type**: string -## MongoDbShardKeyField +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **name**: string (Required): The name of the field -* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceMySqlTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL +* **name**: string: Name of the table to migrate -## MySqlConnectionInfo +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput ### Properties -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## ConnectToSourceNonSqlTaskOutput -### Properties -* **databases**: string[] (ReadOnly): List of databases on the server -* **id**: string (ReadOnly): Result identifier -* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source -* **sourceServerBrandVersion**: string (ReadOnly): Server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +* **Discriminator**: resultType -## ServerProperties -### Properties -* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server -* **serverEdition**: string (ReadOnly): Edition of the database server -* **serverName**: string (ReadOnly): Name of the server -* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system -* **serverPlatform**: string (ReadOnly): Name of the server platform -* **serverVersion**: string (ReadOnly): Version of the database server +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## ConnectToSourceOracleSyncTaskInput -### Properties -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## OracleConnectionInfo -### Properties -* **dataSource**: string (Required): EZConnect or TNSName connection string. -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events +* **resultType**: 'ErrorOutput' (Required): Result type -## ConnectToSourceOracleSyncTaskOutput -### Properties -* **databases**: string[] (ReadOnly): List of schemas on source server -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int: Number of databases to include +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. +* **targetServer**: string (ReadOnly): Target server name +* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type +* **targetServerVersion**: string (ReadOnly): Target server version -## ConnectToSourcePostgreSqlSyncTaskInput -### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## PostgreSqlConnectionInfo -### Properties -* **databaseName**: string: Name of the database -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name -## ConnectToSourcePostgreSqlSyncTaskOutput +## MigrateSchemaSqlServerSqlDbDatabaseInput ### Properties -* **databases**: string[] (ReadOnly): List of databases on source server -* **id**: string (ReadOnly): Result identifier -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **id**: string: Id of the source database +* **name**: string: Name of source database +* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target +* **targetDatabaseName**: string: Name of target database -## ConnectToSourceSqlServerTaskInput +## MigrateSchemaSqlServerSqlDbTaskInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. -* **collectDatabases**: bool: Flag for whether to collect databases from source server. -* **collectLogins**: bool: Flag for whether to collect logins from source server. -* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. - -## SqlConnectionInfo -### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types -* **port**: string: port for server -* **resourceId**: string: Represents the ID of an HTTP resource represented by an Azure resource provider. -* **serverName**: string: name of the server -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **startedOn**: string: Migration start time +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ConnectToSourceSqlServerTaskOutput +## MigrateSchemaSqlServerSqlDbTaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### ConnectToSourceSqlServerTaskOutputAgentJobLevel -#### Properties -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **jobCategory**: string (ReadOnly): The type of Agent Job. -* **jobOwner**: string (ReadOnly): The owner of the Agent Job -* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Agent Job name -* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - -### ConnectToSourceSqlServerTaskOutputDatabaseLevel +### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel #### Properties -* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels -* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files -* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states -* **name**: string (ReadOnly): Database name -* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level -* **sizeMB**: int (ReadOnly): Size of the file in megabytes +* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database +* **databaseName**: string (ReadOnly): The name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database +* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database +* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database +* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -### ConnectToSourceSqlServerTaskOutputLoginLevel +### MigrateSchemaSqlTaskOutputError #### Properties -* **defaultDatabase**: string (ReadOnly): The default database for the login. -* **isEnabled**: bool (ReadOnly): The state of the login. -* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Login name. -* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### ConnectToSourceSqlServerTaskOutputTaskLevel +### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel #### Properties -* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable -* **logins**: string (ReadOnly): Source logins as a map from login name to login id. -* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSchemaSqlServerSqlDbTaskOutputError +#### Properties +* **commandText**: string (ReadOnly): Schema command which failed +* **errorText**: string (ReadOnly): Reason of failure +* **resultType**: 'SchemaErrorOutput' (Required): Result type -## MigrationEligibilityInfo +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. +* **id**: string: id of the database +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **schemaSetting**: any: Any object +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## DatabaseFileInfo +## MigrateSqlServerSqlDbDatabaseInputTableMap ### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForMySqlTaskInput +## MigrateSqlServerSqlDbSyncDatabaseInput ### Properties -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **id**: string: Unique identifier for database +* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of database +* **schemaName**: string: Schema name to be migrated +* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Target database name +* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToTargetAzureDbForMySqlTaskOutput +## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **serverVersion**: string (ReadOnly): Version of the target server -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +## MigrateSqlServerSqlDbSyncDatabaseInputTableMap ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskInput +## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting ### Properties -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. -* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskOutput +## MigrateSqlServerSqlDbSyncTaskInput ### Properties -* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration + +## MigrateSqlServerSqlDbSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties * **id**: string (ReadOnly): Result identifier -* **logins**: string[] (ReadOnly): List of logins on the target server. -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateSqlServerSqlDbSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name * **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToTargetSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## AzureActiveDirectoryApp -### Properties -* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application -* **applicationId**: string (Required): Application ID of the Azure Active Directory Application -* **tenantId**: string (Required): Tenant id of the customer -## MiSqlConnectionInfo +## MigrateSqlServerSqlDbTaskInput ### Properties -* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Date and time relative to UTC when the migration was started on +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## ConnectToTargetSqlMISyncTaskOutput -### Properties -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +## MigrateSqlServerSqlDbTaskOutput +* **Discriminator**: resultType -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput -### Properties -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the item +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput -### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +### MigrateSqlServerSqlDbTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +#### Properties +* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message * **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **targetServerVersion**: string (ReadOnly): Target server version -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem -### Properties -* **database**: string -* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem +### MigrateSqlServerSqlDbTaskOutputValidationResult +#### Properties +* **resultType**: 'MigrationValidationOutput' (Required): Result type -## ConnectToTargetSqlDbTaskInput -### Properties -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### MigrateSqlServerSqlDbTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## ConnectToTargetSqlDbTaskOutput + +## MigrateSqlServerSqlMIDatabaseInput ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **id**: string: id of the database +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination -## ConnectToTargetSqlDbSyncTaskInput +## MigrateSqlServerSqlMISyncTaskInput ### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## GetTdeCertificatesSqlTaskInput -### Properties -* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. +## MigrateSqlServerSqlMISyncTaskOutput +* **Discriminator**: resultType -## FileShare -### Properties -* **password**: string: Password credential used to connect to the share location. -* **path**: string (Required): The folder path for this share. -* **userName**: string: User name credential to connect to the share location +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +#### Properties +* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) +* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to +* **endedOn**: string (ReadOnly): Database migration end time +* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not +* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sourceDatabaseName**: string (ReadOnly): Name of the database +* **startedOn**: string (ReadOnly): Database migration start time -## SelectedCertificateInput -### Properties -* **certificateName**: string (Required): Name of certificate to be exported. -* **password**: string (Required): Password to use for encrypting the exported certificate. +### MigrateSqlServerSqlMISyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## GetTdeCertificatesSqlTaskOutput -### Properties -* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **databaseErrorCount**: int (ReadOnly): Number of database level errors +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerName**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerName**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## GetUserTablesSqlSyncTaskInput + +## MigrateSqlServerSqlMITaskInput ### Properties -* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for -* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes +* **selectedAgentJobs**: string[]: Agent Jobs to migrate. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **selectedLogins**: string[]: Logins to migrate. * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Date and time relative to UTC when the migration was started on * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## GetUserTablesSqlSyncTaskOutput -### Properties -* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables -* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables -* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - -## GetUserTablesSqlTaskInput -### Properties -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +## MigrateSqlServerSqlMITaskOutput +* **Discriminator**: resultType -## GetUserTablesSqlTaskOutput -### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +### Base Properties * **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSqlServerSqlMITaskOutputAgentJobLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **message**: string (ReadOnly): Migration progress message +* **name**: string (ReadOnly): Agent Job name. +* **resultType**: 'AgentJobLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesMySqlTaskInput -### Properties -* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +### MigrateSqlServerSqlMITaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sizeMB**: int (ReadOnly): Size of the database in megabytes +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesMySqlTaskOutput -### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables -* **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSqlServerSqlMITaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## GetUserTablesOracleTaskInput -### Properties -* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables +### MigrateSqlServerSqlMITaskOutputLoginLevel +#### Properties +* **endedOn**: string (ReadOnly): Login migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login +* **loginName**: string (ReadOnly): Login name. +* **message**: string (ReadOnly): Login migration progress message +* **resultType**: 'LoginLevelOutput' (Required): Result type +* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. +* **startedOn**: string (ReadOnly): Login migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## GetUserTablesOracleTaskOutput -### Properties -* **schemaName**: string (ReadOnly): The schema this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigrateSqlServerSqlMITaskOutputMigrationLevel +#### Properties +* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **logins**: string (ReadOnly): Selected logins as a map from name to id +* **message**: string (ReadOnly): Migration progress message +* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **serverRoleResults**: string (ReadOnly): Map of server role migration results. +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## DatabaseTable -### Properties -* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not -* **name**: string (ReadOnly): Schema-qualified name of the table -## GetUserTablesPostgreSqlTaskInput +## MigrateSsisTaskInput ### Properties -* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## GetUserTablesPostgreSqlTaskOutput -### Properties -* **databaseName**: string (ReadOnly): The database this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +## MigrateSsisTaskOutput +* **Discriminator**: resultType -## MongoDbMigrationSettings -### Properties -* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. -* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. -* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. -* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSsisTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSsisTaskOutputProjectLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **folderName**: string (ReadOnly): Name of the folder +* **message**: string (ReadOnly): Migration progress message +* **projectName**: string (ReadOnly): Name of the project +* **resultType**: 'SsisProjectLevelOutput' (Required): Result type +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## MongoDbMigrationSettingsDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) -## MongoDbDatabaseSettings +## MigrateSyncCompleteCommandInput ### Properties -* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. +* **commitTimeStamp**: string: Time stamp to complete +* **databaseName**: string (Required): Name of database -## MongoDbDatabaseSettingsCollections +## MigrateSyncCompleteCommandOutput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +* **id**: string (ReadOnly): Result identifier -## MongoDbCollectionSettings +## MigrationEligibilityInfo ### Properties -* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. -* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. -## MongoDbShardKeySetting +## MigrationReportResult ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +* **id**: string: Migration validation result identifier +* **reportUrl**: string: The url of the report. -## MongoDbThrottlingSettings +## MigrationStatusDetails ### Properties -* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel -* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 -* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using - -## MongoDbProgress -* **Discriminator**: resultType - -### Base Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -### MongoDbCollectionProgress -#### Properties -* **resultType**: 'Collection' (Required): The type of progress object - -### MongoDbDatabaseProgress -#### Properties -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **resultType**: 'Database' (Required): The type of progress object - -### MongoDbMigrationProgress -#### Properties -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **resultType**: 'Migration' (Required): The type of progress object +* **activeBackupSets**: [SqlBackupSetInfo](#sqlbackupsetinfo)[] (ReadOnly): Backup sets that are currently active. +* **blobContainerName**: string (ReadOnly): Name of blob container. +* **completeRestoreErrorMessage**: string (ReadOnly): Complete restore error message, if any +* **currentRestoringFilename**: string (ReadOnly): File name that is currently being restored. +* **fileUploadBlockingErrors**: string[] (ReadOnly): File upload blocking errors, if any. +* **fullBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set +* **invalidFiles**: string[] (ReadOnly): Files that are not valid backup files. +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not. +* **lastRestoredBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set +* **lastRestoredFilename**: string (ReadOnly): Last restored file name. +* **migrationState**: string (ReadOnly): Current State of Migration. +* **pendingLogBackupsCount**: int (ReadOnly): Total pending log backups. +* **restoreBlockingReason**: string (ReadOnly): Restore blocking reason, if any +## MigrationValidationDatabaseSummaryResult +### Properties +* **endedOn**: string (ReadOnly): Validation end time +* **id**: string (ReadOnly): Result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database -## MongoDbProgressErrors +## MigrationValidationOptions ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. -## MongoDbError +## MigrationValidationResult ### Properties -* **code**: string: The non-localized, machine-readable code that describes the error or warning -* **count**: int: The number of times the error or warning has occurred -* **message**: string: The localized, human-readable message that describes the error or warning -* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning +* **id**: string (ReadOnly): Migration validation result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database -## MongoDbDatabaseProgressCollections +## MigrationValidationResultSummaryResults ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) -## MongoDbCollectionProgress +## MiSqlConnectionInfo ### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MongoDbProgressErrors +## MongoDbClusterInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster +* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections +* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source +* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. -## MongoDbMigrationProgressDatabases +## MongoDbCollectionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **databaseName**: string (Required): The name of the database containing the collection +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) +* **isSystemCollection**: bool (Required): Whether the collection is system collection +* **isView**: bool (Required): Whether the collection is a view of another collection +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **viewOf**: string: The name of the collection that this is a view of, if IsView is true -## MongoDbDatabaseProgress +## MongoDbCollectionProgress ### Properties * **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections * **documentsCopied**: int (Required): The number of documents copied during the Copying stage * **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) * **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. @@ -1181,933 +1504,686 @@ * **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown * **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MongoDbDatabaseProgressCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) - -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) - -## MigrateMySqlAzureDbForMySqlOfflineTaskInput -### Properties -* **makeSourceServerReadOnly**: bool: Setting to set the source server read only -* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **startedOn**: string: Parameter to specify when the migration started -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server - -## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput -### Properties -* **name**: string: Name of the database -* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. - -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlOfflineTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel -#### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message - -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel -#### Properties -* **databases**: string: Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version - -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +## MongoDbCollectionSettings +### Properties +* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. +* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. +## MongoDbCommandInput +### Properties +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## MigrationReportResult +## MongoDbConnectionInfo ### Properties -* **id**: string: Migration validation result identifier -* **reportUrl**: string: The url of the report. +* **additionalSettings**: string: Additional connection settings +* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **enforceSSL**: bool +* **password**: string: Password credential. +* **port**: int: port for server +* **serverBrandVersion**: string: server brand version +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateMySqlAzureDbForMySqlSyncTaskInput +## MongoDbDatabaseInfo ### Properties -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -## MigrateMySqlAzureDbForMySqlSyncDatabaseInput +## MongoDbDatabaseProgress ### Properties -* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap +## MongoDbDatabaseSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting +## MongoDbDatabaseSettingsCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlSyncTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes - +* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) -## SyncMigrationDatabaseErrorEvent +## MongoDbError ### Properties -* **eventText**: string (ReadOnly): Event text. -* **eventTypeString**: string (ReadOnly): Event type. -* **timestampString**: string (ReadOnly): String value of timestamp. +* **code**: string: The non-localized, machine-readable code that describes the error or warning +* **count**: int: The number of times the error or warning has occurred +* **message**: string: The localized, human-readable message that describes the error or warning +* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning -## MigrateOracleAzureDbPostgreSqlSyncTaskInput +## MongoDbFinishCommandInput ### Properties -* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput +## MongoDbMigrationProgress ### Properties -* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower -* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the migration pipeline -* **schemaName**: string: Name of the source schema -* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap +## MongoDbMigrationSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. +* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. +* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. +* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbMigrationSettingsDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) -## MigrateOracleAzureDbPostgreSqlSyncTaskOutput +## MongoDbProgress * **Discriminator**: resultType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MongoDbCollectionProgress +#### Properties +* **resultType**: 'Collection' (Required): The type of progress object -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +### MongoDbDatabaseProgress #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **resultType**: 'Database' (Required): The type of progress object +### MongoDbMigrationProgress +#### Properties +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **resultType**: 'Migration' (Required): The type of progress object -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput -### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput +## MongoDbProgressErrors ### Properties -* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration -* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput +## MongoDbProgressErrors ### Properties -* **name**: string: Name of the table to migrate +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbShardKeyField ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of the field +* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput -* **Discriminator**: resultType +## MongoDbShardKeyInfo +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +## MongoDbShardKeySetting +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +## MongoDbThrottlingSettings +### Properties +* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel +* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 +* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events -* **resultType**: 'ErrorOutput' (Required): Result type +## MySqlConnectionInfo +### Properties +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel -#### Properties -* **databaseCount**: int: Number of databases to include -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. -* **targetServer**: string (ReadOnly): Target server name -* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type -* **targetServerVersion**: string (ReadOnly): Target server version +## NodeMonitoringData +### Properties +* **additionalProperties**: [NodeMonitoringDataAdditionalProperties](#nodemonitoringdataadditionalproperties) (ReadOnly): Unmatched properties from the message are deserialized in this collection. +* **availableMemoryInMB**: int (ReadOnly): Available memory (MB) on the integration runtime node. +* **concurrentJobsLimit**: int (ReadOnly): Maximum concurrent jobs on the integration runtime node. +* **concurrentJobsRunning**: int (ReadOnly): The number of jobs currently running on the integration runtime node. +* **cpuUtilization**: int (ReadOnly): CPU percentage on the integration runtime node. +* **maxConcurrentJobs**: int (ReadOnly): The maximum concurrent jobs in this integration runtime. +* **nodeName**: string (ReadOnly): Name of the integration runtime node. +* **receivedBytes**: int (ReadOnly): Received bytes on the integration runtime node. +* **sentBytes**: int (ReadOnly): Sent bytes on the integration runtime node. -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## NodeMonitoringDataAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error -## MigrateSqlServerSqlDbSyncTaskInput +## OfflineConfiguration ### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +* **lastBackupName**: string: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. +* **offline**: bool: Offline migration -## MigrateSqlServerSqlDbSyncDatabaseInput +## OracleConnectionInfo ### Properties -* **id**: string: Unique identifier for database -* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of database -* **schemaName**: string: Schema name to be migrated -* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Target database name -* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **dataSource**: string (Required): EZConnect or TNSName connection string. +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting +## OracleOCIDriverInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. +* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' +* **driverName**: string (ReadOnly): The name of the driver package +* **driverSize**: string (ReadOnly): The size in bytes of the driver package +* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. +* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. -## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting +## OrphanedUserInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databaseName**: string: Parent database of the user +* **name**: string: Name of the orphaned user -## MigrateSqlServerSqlDbSyncDatabaseInputTableMap +## PostgreSqlConnectionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databaseName**: string: Name of the database +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting +## ProjectFileProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. +* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. +* **lastModified**: string (ReadOnly): Modification DateTime. +* **mediaType**: string: File content type. This property can be modified to reflect the file content type. +* **size**: int (ReadOnly): File size. -## MigrationValidationOptions +## ProjectProperties ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **azureAuthenticationInfo**: string: Field that defines the Azure active directory application info, used to connect to the target Azure resource +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project + +## ProjectTaskProperties +* **Discriminator**: taskType + +### Base Properties +* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task +* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToMongoDbTaskProperties +#### Properties +* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source +* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object +* **taskType**: 'Connect.MongoDb' (Required): Task type. + +### ConnectToSourceMySqlTaskProperties +#### Properties +* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection +* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.MySql' (Required): Task type. -## MigrateSqlServerSqlDbSyncTaskOutput -* **Discriminator**: resultType +### ConnectToSourceOracleSyncTaskProperties +#### Properties +* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection +* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError +### ConnectToSourcePostgreSqlSyncTaskProperties #### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements +* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +### ConnectToSourceSqlServerTaskProperties #### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputError +### ConnectToSourceSqlServerSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +### ConnectToTargetAzureDbForMySqlTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements +* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements +* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -## MigrateSqlServerSqlMITaskInput -### Properties -* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes -* **selectedAgentJobs**: string[]: Agent Jobs to migrate. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **selectedLogins**: string[]: Logins to migrate. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Date and time relative to UTC when the migration was started on -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### ConnectToTargetSqlMISyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. +* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## BlobShare -### Properties -* **sasUri**: string (Required): SAS URI of Azure Storage Account Container. +### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. +* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -## MigrateSqlServerSqlMIDatabaseInput -### Properties -* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **id**: string: id of the database -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination +### ConnectToTargetSqlDbTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -## MigrateSqlServerSqlMITaskOutput -* **Discriminator**: resultType +### ConnectToTargetSqlDbSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMITaskOutputAgentJobLevel +### GetTdeCertificatesSqlTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **message**: string (ReadOnly): Migration progress message -* **name**: string (ReadOnly): Agent Job name. -* **resultType**: 'AgentJobLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. +* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputDatabaseLevel +### GetUserTablesSqlSyncTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sizeMB**: int (ReadOnly): Size of the database in megabytes -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputError +### GetUserTablesSqlTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.Sql' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputLoginLevel +### GetUserTablesMySqlTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Login migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login -* **loginName**: string (ReadOnly): Login name. -* **message**: string (ReadOnly): Login migration progress message -* **resultType**: 'LoginLevelOutput' (Required): Result type -* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. -* **startedOn**: string (ReadOnly): Login migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesMySql' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputMigrationLevel +### GetUserTablesOracleTaskProperties #### Properties -* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **logins**: string (ReadOnly): Selected logins as a map from name to id -* **message**: string (ReadOnly): Migration progress message -* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **serverRoleResults**: string (ReadOnly): Map of server role migration results. -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. +* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesOracle' (Required): Task type. +### GetUserTablesPostgreSqlTaskProperties +#### Properties +* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. +* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. -## OrphanedUserInfo -### Properties -* **databaseName**: string: Parent database of the user -* **name**: string: Name of the orphaned user +### MigrateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress +* **taskType**: 'Migrate.MongoDb' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### MigrateMySqlAzureDbForMySqlOfflineTaskProperties +#### Properties +* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations +* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskOutput -* **Discriminator**: resultType +### MigrateMySqlAzureDbForMySqlSyncTaskProperties +#### Properties +* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations +* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) -* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to -* **endedOn**: string (ReadOnly): Database migration end time -* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not -* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sourceDatabaseName**: string (ReadOnly): Name of the database -* **startedOn**: string (ReadOnly): Database migration start time +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. + +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputError +### MigrateSqlServerSqlDbSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations +* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +### MigrateSqlServerSqlMITaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **databaseErrorCount**: int (ReadOnly): Number of database level errors -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerName**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerName**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version - - -## BackupSetInfo -### Properties -* **backupFinishedDate**: string: Date and time that the backup operation finished -* **backupSetId**: string: Id for the set of backup files -* **backupStartDate**: string: Date and time that the backup operation began -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. -* **databaseName**: string: Name of the database to which the backup set belongs -* **firstLsn**: string: First log sequence number of the backup file -* **isBackupRestored**: bool: Whether the backup set is restored or not -* **lastLsn**: string: Last log sequence number of the backup file -* **lastModifiedTime**: string: Last modified time of the backup file in share location -* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. -## BackupFileInfo -### Properties -* **familySequenceNumber**: int: Sequence number of the backup file in the backup set -* **fileLocation**: string: Location of the backup file in shared folder -* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. +### MigrateSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## MigrateSqlServerSqlDbTaskInput -### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Date and time relative to UTC when the migration was started on -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInput -### Properties -* **id**: string: id of the database -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **schemaSetting**: any: Any object -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +### MigrateSsisTaskProperties +#### Properties +* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. +* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Ssis' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSchemaSqlServerSqlDbTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases +* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +### CheckOCIDriverTaskProperties +#### Properties +* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. +* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Check.OCI' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +### InstallOCIDriverTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. +* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Install.OCI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### UploadOCIDriverTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. +* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Upload.OCI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +### ValidateMongoDbTaskProperties #### Properties -* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object +* **taskType**: 'Validate.MongoDb' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object +* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputValidationResult +### ValidateMigrationInputSqlServerSqlMITaskProperties #### Properties -* **resultType**: 'MigrationValidationOutput' (Required): Result type +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### ValidateMigrationInputSqlServerSqlMISyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations +* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. -## MigrationValidationResult -### Properties -* **id**: string (ReadOnly): Migration validation result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database -## MigrationValidationResultSummaryResults +## ProjectTaskPropertiesClientData ### Properties ### Additional Properties -* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) +* **Additional Properties Type**: string -## MigrationValidationDatabaseSummaryResult +## ReportableException ### Properties -* **endedOn**: string (ReadOnly): Validation end time -* **id**: string (ReadOnly): Result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +* **actionableMessage**: string: Actionable steps for this exception +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace -## MigrateSsisTaskInput +## SchemaMigrationSetting ### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **fileId**: string: Resource Identifier of a file resource containing the uploaded schema file +* **fileName**: string: Name of the file resource containing the uploaded schema file +* **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target -## SsisMigrationInfo +## SelectedCertificateInput ### Properties -* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS - -## MigrateSsisTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSsisTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **certificateName**: string (Required): Name of certificate to be exported. +* **password**: string (Required): Password to use for encrypting the exported certificate. -### MigrateSsisTaskOutputProjectLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **folderName**: string (ReadOnly): Name of the folder -* **message**: string (ReadOnly): Migration progress message -* **projectName**: string (ReadOnly): Name of the project -* **resultType**: 'SsisProjectLevelOutput' (Required): Result type -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +## ServerProperties +### Properties +* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server +* **serverEdition**: string (ReadOnly): Edition of the database server +* **serverName**: string (ReadOnly): Name of the server +* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system +* **serverPlatform**: string (ReadOnly): Name of the server platform +* **serverVersion**: string (ReadOnly): Version of the database server +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' -## MigrateSchemaSqlServerSqlDbTaskInput +## SourceLocation ### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Migration start time -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **azureBlob**: [AzureBlob](#azureblob): Azure Blob Details +* **fileShare**: [SqlFileShare](#sqlfileshare): File share -## MigrateSchemaSqlServerSqlDbDatabaseInput +## SqlBackupFileInfo ### Properties -* **id**: string: Id of the source database -* **name**: string: Name of source database -* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target -* **targetDatabaseName**: string: Name of target database +* **copyDuration**: int (ReadOnly): Copy Duration in seconds +* **copyThroughput**: int (ReadOnly): Copy throughput in KBps +* **dataRead**: int (ReadOnly): Bytes read +* **dataWritten**: int (ReadOnly): Bytes written +* **familySequenceNumber**: int (ReadOnly): Media family sequence number +* **fileName**: string (ReadOnly): File name. +* **status**: string (ReadOnly): Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) +* **totalSize**: int (ReadOnly): File size in bytes -## SchemaMigrationSetting +## SqlBackupSetInfo ### Properties -* **fileId**: string: Resource Identifier of a file resource containing the uploaded schema file -* **fileName**: string: Name of the file resource containing the uploaded schema file -* **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target +* **backupFinishDate**: string (ReadOnly): Backup end time. +* **backupSetId**: string (ReadOnly): Backup set id. +* **backupStartDate**: string (ReadOnly): Backup start date. +* **backupType**: string (ReadOnly): Backup type. +* **familyCount**: int (ReadOnly): Media family count +* **firstLSN**: string (ReadOnly): First LSN of the backup set. +* **hasBackupChecksums**: bool (ReadOnly): Has Backup Checksums +* **ignoreReasons**: string[] (ReadOnly): The reasons why the backup set is ignored +* **isBackupRestored**: bool (ReadOnly): Whether this backup set has been restored or not. +* **lastLSN**: string (ReadOnly): Last LSN of the backup set. +* **listOfBackupFiles**: [SqlBackupFileInfo](#sqlbackupfileinfo)[] (ReadOnly): List of files in the backup set. -## MigrateSchemaSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types +* **port**: string: port for server +* **resourceId**: string: Represents the ID of an HTTP resource represented by an Azure resource provider. +* **serverName**: string: name of the server +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel -#### Properties -* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database -* **databaseName**: string (ReadOnly): The name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database -* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database -* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database -* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +## SqlConnectionInformation +### Properties +* **authentication**: string: Authentication type. +* **dataSource**: string: Data source. +* **encryptConnection**: bool: Whether to encrypt connection or not. +* **password**: string: Password to connect to source SQL. +* **trustServerCertificate**: bool: Whether to trust server certificate or not. +* **userName**: string: User name to connect to source SQL. -### MigrateSchemaSqlTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## SqlFileShare +### Properties +* **password**: string (WriteOnly): Password for username to access file share location. +* **path**: string: Location as SMB share or local drive where backups are placed. +* **username**: string: Username to access the file share location for backups. -### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +## SqlMigrationServiceProperties +### Properties +* **integrationRuntimeState**: string (ReadOnly): Current state of the Integration runtime. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -### MigrateSchemaSqlServerSqlDbTaskOutputError -#### Properties -* **commandText**: string (ReadOnly): Schema command which failed -* **errorText**: string (ReadOnly): Reason of failure -* **resultType**: 'SchemaErrorOutput' (Required): Result type +## SsisMigrationInfo +### Properties +* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS +## SyncMigrationDatabaseErrorEvent +### Properties +* **eventText**: string (ReadOnly): Event text. +* **eventTypeString**: string (ReadOnly): Event type. +* **timestampString**: string (ReadOnly): String value of timestamp. -## CheckOCIDriverTaskInput +## SystemData ### Properties -* **serverVersion**: string: Version of the source server to check against. Optional. +* **createdAt**: string +* **createdBy**: string +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string +* **lastModifiedAt**: string +* **lastModifiedBy**: string +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string -## CheckOCIDriverTaskOutput +## TargetLocation ### Properties -* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **accountKey**: string: Storage Account Key. +* **storageAccountResourceId**: string: Resource Id of the storage account copying backups. -## OracleOCIDriverInfo +## TrackedResourceTags ### Properties -* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. -* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' -* **driverName**: string (ReadOnly): The name of the driver package -* **driverSize**: string (ReadOnly): The size in bytes of the driver package -* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. -* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +### Additional Properties +* **Additional Properties Type**: string -## InstallOCIDriverTaskInput +## TrackedResourceTags ### Properties -* **driverPackageName**: string: Name of the uploaded driver package to install. +### Additional Properties +* **Additional Properties Type**: string -## InstallOCIDriverTaskOutput +## TrackedResourceTags ### Properties -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string ## UploadOCIDriverTaskInput ### Properties @@ -2118,36 +2194,19 @@ * **driverPackageName**: string (ReadOnly): The name of the driver package that was validated and uploaded. * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbMigrationProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown - -## MongoDbMigrationProgressDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) - -## MongoDbProgressErrors +## ValidateMigrationInputSqlServerSqlMISyncTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## ValidateOracleAzureDbPostgreSqlSyncTaskOutput +## ValidateMigrationInputSqlServerSqlMISyncTaskOutput ### Properties +* **id**: string (ReadOnly): Database identifier +* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateMigrationInputSqlServerSqlMITaskInput @@ -2171,30 +2230,8 @@ * **name**: string (ReadOnly): Name of database * **restoreDatabaseNameErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with the RestoreDatabaseName -## DatabaseBackupInfo -### Properties -* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. -* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. -* **databaseName**: string (ReadOnly): Database name. -* **familyCount**: int (ReadOnly): Number of files in the backup set. -* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed -* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. -* **position**: int (ReadOnly): Position of current database backup in the file. - -## ValidateMigrationInputSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance - -## ValidateMigrationInputSqlServerSqlMISyncTaskOutput +## ValidateOracleAzureDbPostgreSqlSyncTaskOutput ### Properties -* **id**: string (ReadOnly): Database identifier -* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateSyncMigrationInputSqlServerTaskInput @@ -2209,40 +2246,3 @@ * **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object -## SqlMigrationServiceProperties -### Properties -* **integrationRuntimeState**: string (ReadOnly): Current state of the Integration runtime. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthenticationKeys -### Properties -* **authKey1**: string (ReadOnly): The first authentication key. -* **authKey2**: string (ReadOnly): The second authentication key. - -## IntegrationRuntimeMonitoringData -### Properties -* **name**: string (ReadOnly): The name of Integration Runtime. -* **nodes**: [NodeMonitoringData](#nodemonitoringdata)[] (ReadOnly): Integration Runtime node monitoring data. - -## NodeMonitoringData -### Properties -* **additionalProperties**: [NodeMonitoringDataAdditionalProperties](#nodemonitoringdataadditionalproperties) (ReadOnly): Unmatched properties from the message are deserialized in this collection. -* **availableMemoryInMB**: int (ReadOnly): Available memory (MB) on the integration runtime node. -* **concurrentJobsLimit**: int (ReadOnly): Maximum concurrent jobs on the integration runtime node. -* **concurrentJobsRunning**: int (ReadOnly): The number of jobs currently running on the integration runtime node. -* **cpuUtilization**: int (ReadOnly): CPU percentage on the integration runtime node. -* **maxConcurrentJobs**: int (ReadOnly): The maximum concurrent jobs in this integration runtime. -* **nodeName**: string (ReadOnly): Name of the integration runtime node. -* **receivedBytes**: int (ReadOnly): Received bytes on the integration runtime node. -* **sentBytes**: int (ReadOnly): Sent bytes on the integration runtime node. - -## NodeMonitoringDataAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - diff --git a/generated/datamigration/microsoft.datamigration/2022-01-30-preview/types.md b/generated/datamigration/microsoft.datamigration/2022-01-30-preview/types.md index 44af5f3e35..67fa1da25c 100644 --- a/generated/datamigration/microsoft.datamigration/2022-01-30-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2022-01-30-preview/types.md @@ -93,34 +93,17 @@ * **ApiVersion**: 2022-01-30-preview * **Output**: [IntegrationRuntimeMonitoringData](#integrationruntimemonitoringdata) -## DatabaseMigrationPropertiesSqlMi -### Properties -* **backupConfiguration**: [BackupConfiguration](#backupconfiguration): Backup Configuration -* **endedOn**: string (ReadOnly): Database migration end time. -* **kind**: 'SqlMi' | 'SqlVm' | string (Required) -* **migrationFailureError**: [ErrorInfo](#errorinfo) (ReadOnly): Error details -* **migrationOperationId**: string: ID tracking current migration operation. -* **migrationService**: string: Resource Id of the Migration Service. -* **migrationStatus**: string (ReadOnly): Migration status. -* **migrationStatusDetails**: [MigrationStatusDetails](#migrationstatusdetails) (ReadOnly): Detailed status of current migration. -* **offlineConfiguration**: [OfflineConfiguration](#offlineconfiguration): Offline configuration -* **provisioningError**: string: Error message for migration provisioning failure, if any. -* **provisioningState**: string (ReadOnly): Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. -* **scope**: string: Resource Id of the target resource (SQL VM or SQL Managed Instance). -* **sourceDatabaseName**: string: Name of the source database. -* **sourceSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection -* **startedOn**: string (ReadOnly): Database migration start time. -* **targetDatabaseCollation**: string: Database collation to be used for the target database. - -## BackupConfiguration +## AuthenticationKeys ### Properties -* **sourceLocation**: [SourceLocation](#sourcelocation): Source Location details of backups. -* **targetLocation**: [TargetLocation](#targetlocation): Target Location details for optional copy of backups +* **authKey1**: string (ReadOnly): The first authentication key. +* **authKey2**: string (ReadOnly): The second authentication key. -## SourceLocation +## AzureActiveDirectoryApp ### Properties -* **azureBlob**: [AzureBlob](#azureblob): Azure Blob Details -* **fileShare**: [SqlFileShare](#sqlfileshare): File share +* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application +* **applicationId**: string (Required): Application ID of the Azure Active Directory Application +* **ignoreAzurePermissions**: bool: Ignore checking azure permissions on the AAD app +* **tenantId**: string (Required): Tenant id of the customer ## AzureBlob ### Properties @@ -128,129 +111,77 @@ * **blobContainerName**: string: Blob container name where backups are stored. * **storageAccountResourceId**: string: Resource Id of the storage account where backups are stored. -## SqlFileShare -### Properties -* **password**: string (WriteOnly): Password for username to access file share location. -* **path**: string: Location as SMB share or local drive where backups are placed. -* **username**: string: Username to access the file share location for backups. - -## TargetLocation -### Properties -* **accountKey**: string: Storage Account Key. -* **storageAccountResourceId**: string: Resource Id of the storage account copying backups. - -## ErrorInfo +## BackupConfiguration ### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message. +* **sourceLocation**: [SourceLocation](#sourcelocation): Source Location details of backups. +* **targetLocation**: [TargetLocation](#targetlocation): Target Location details for optional copy of backups -## MigrationStatusDetails +## BackupFileInfo ### Properties -* **activeBackupSets**: [SqlBackupSetInfo](#sqlbackupsetinfo)[] (ReadOnly): Backup sets that are currently active. -* **blobContainerName**: string (ReadOnly): Name of blob container. -* **completeRestoreErrorMessage**: string (ReadOnly): Complete restore error message, if any -* **currentRestoringFilename**: string (ReadOnly): File name that is currently being restored. -* **fileUploadBlockingErrors**: string[] (ReadOnly): File upload blocking errors, if any. -* **fullBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set -* **invalidFiles**: string[] (ReadOnly): Files that are not valid backup files. -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not. -* **lastRestoredBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set -* **lastRestoredFilename**: string (ReadOnly): Last restored file name. -* **migrationState**: string (ReadOnly): Current State of Migration. -* **pendingLogBackupsCount**: int (ReadOnly): Total pending log backups. -* **restoreBlockingReason**: string (ReadOnly): Restore blocking reason, if any +* **familySequenceNumber**: int: Sequence number of the backup file in the backup set +* **fileLocation**: string: Location of the backup file in shared folder +* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. -## SqlBackupSetInfo +## BackupSetInfo ### Properties -* **backupFinishDate**: string (ReadOnly): Backup end time. -* **backupSetId**: string (ReadOnly): Backup set id. -* **backupStartDate**: string (ReadOnly): Backup start date. -* **backupType**: string (ReadOnly): Backup type. -* **familyCount**: int (ReadOnly): Media family count -* **firstLSN**: string (ReadOnly): First LSN of the backup set. -* **hasBackupChecksums**: bool (ReadOnly): Has Backup Checksums -* **ignoreReasons**: string[] (ReadOnly): The reasons why the backup set is ignored -* **isBackupRestored**: bool (ReadOnly): Whether this backup set has been restored or not. -* **lastLSN**: string (ReadOnly): Last LSN of the backup set. -* **listOfBackupFiles**: [SqlBackupFileInfo](#sqlbackupfileinfo)[] (ReadOnly): List of files in the backup set. +* **backupFinishedDate**: string: Date and time that the backup operation finished +* **backupSetId**: string: Id for the set of backup files +* **backupStartDate**: string: Date and time that the backup operation began +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. +* **databaseName**: string: Name of the database to which the backup set belongs +* **firstLsn**: string: First log sequence number of the backup file +* **isBackupRestored**: bool: Whether the backup set is restored or not +* **lastLsn**: string: Last log sequence number of the backup file +* **lastModifiedTime**: string: Last modified time of the backup file in share location +* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set -## SqlBackupFileInfo +## BlobShare ### Properties -* **copyDuration**: int (ReadOnly): Copy Duration in seconds -* **copyThroughput**: int (ReadOnly): Copy throughput in KBps -* **dataRead**: int (ReadOnly): Bytes read -* **dataWritten**: int (ReadOnly): Bytes written -* **familySequenceNumber**: int (ReadOnly): Media family sequence number -* **fileName**: string (ReadOnly): File name. -* **status**: string (ReadOnly): Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) -* **totalSize**: int (ReadOnly): File size in bytes +* **sasUri**: string: SAS URI of Azure Storage Account Container. -## OfflineConfiguration +## CheckOCIDriverTaskInput ### Properties -* **lastBackupName**: string: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. -* **offline**: bool: Offline migration +* **serverVersion**: string: Version of the source server to check against. Optional. -## SqlConnectionInformation +## CheckOCIDriverTaskOutput ### Properties -* **authentication**: string: Authentication type. -* **dataSource**: string: Data source. -* **encryptConnection**: bool: Whether to encrypt connection or not. -* **password**: string: Password to connect to source SQL. -* **trustServerCertificate**: bool: Whether to trust server certificate or not. -* **userName**: string: User name to connect to source SQL. +* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## SystemData -### Properties -* **createdAt**: string -* **createdBy**: string -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string -* **lastModifiedAt**: string -* **lastModifiedBy**: string -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string +## CommandProperties +* **Discriminator**: commandType -## DataMigrationServiceProperties -### Properties -* **autoStopDelay**: string: The time delay before the service is auto-stopped when idle. -* **deleteResourcesOnStop**: bool: Whether service resources should be deleted when stopped. (Turned on by default) -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have -* **virtualSubnetId**: string: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. +### MongoDbCancelCommand +#### Properties +* **commandType**: 'cancel' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands -## ServiceSku -### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' +### MongoDbFinishCommand +#### Properties +* **commandType**: 'finish' (Required): Command type. +* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateMISyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. +* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. +* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. -## ProjectProperties -### Properties -* **azureAuthenticationInfo**: [AzureActiveDirectoryApp](#azureactivedirectoryapp): Azure Active Directory Application -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project +### MigrateSyncCompleteCommandProperties +#### Properties +* **commandId**: string: Command id +* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. +* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. +* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. -## AzureActiveDirectoryApp -### Properties -* **appKey**: string (Required): Key used to authenticate to the Azure Active Directory Application -* **applicationId**: string (Required): Application ID of the Azure Active Directory Application -* **ignoreAzurePermissions**: bool: Ignore checking azure permissions on the AAD app -* **tenantId**: string (Required): Tenant id of the customer +### MongoDbRestartCommand +#### Properties +* **commandType**: 'restart' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands -## DatabaseInfo -### Properties -* **sourceDatabaseName**: string (Required): Name of the database ## ConnectionInfo * **Discriminator**: type @@ -320,329 +251,340 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags +## ConnectToSourceMySqlTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL -## ProjectFileProperties +## ConnectToSourceNonSqlTaskOutput ### Properties -* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. -* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. -* **lastModified**: string (ReadOnly): Modification DateTime. -* **mediaType**: string: File content type. This property can be modified to reflect the file content type. -* **size**: int (ReadOnly): File size. +* **databases**: string[] (ReadOnly): List of databases on the server +* **id**: string (ReadOnly): Result identifier +* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source +* **sourceServerBrandVersion**: string (ReadOnly): Server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## ProjectTaskProperties -* **Discriminator**: taskType +## ConnectToSourceOracleSyncTaskInput +### Properties +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -### Base Properties -* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task -* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToMongoDbTaskProperties -#### Properties -* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source -* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object -* **taskType**: 'Connect.MongoDb' (Required): Task type. +## ConnectToSourceOracleSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of schemas on source server +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceMySqlTaskProperties -#### Properties -* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection -* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.MySql' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ConnectToSourceOracleSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection -* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on source server +* **id**: string (ReadOnly): Result identifier +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourcePostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements -* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. - -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. - -### ConnectToSourceSqlServerSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. - -### ConnectToTargetAzureDbForMySqlTaskProperties -#### Properties -* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements -* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. - -### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements -* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. +## ConnectToSourceSqlServerTaskInput +### Properties +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. +* **collectDatabases**: bool: Flag for whether to collect databases from source server. +* **collectLogins**: bool: Flag for whether to collect logins from source server. +* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. -### ConnectToTargetSqlMITaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. +## ConnectToSourceSqlServerTaskOutput +* **Discriminator**: resultType -### ConnectToTargetSqlMISyncTaskProperties +### Base Properties +* **id**: string (ReadOnly): Result identifier +### ConnectToSourceSqlServerTaskOutputAgentJobLevel #### Properties -* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. -* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **jobCategory**: string (ReadOnly): The type of Agent Job. +* **jobOwner**: string (ReadOnly): The owner of the Agent Job +* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Agent Job name +* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties +### ConnectToSourceSqlServerTaskOutputDatabaseLevel #### Properties -* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. -* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels +* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files +* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states +* **name**: string (ReadOnly): Database name +* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level +* **sizeMB**: int (ReadOnly): Size of the file in megabytes -### ConnectToTargetSqlDbTaskProperties +### ConnectToSourceSqlServerTaskOutputLoginLevel #### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. +* **defaultDatabase**: string (ReadOnly): The default database for the login. +* **isEnabled**: bool (ReadOnly): The state of the login. +* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Login name. +* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level -### ConnectToTargetSqlDbSyncTaskProperties +### ConnectToSourceSqlServerTaskOutputTaskLevel #### Properties -* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. +* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable +* **logins**: string (ReadOnly): Source logins as a map from login name to login id. +* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### GetTdeCertificatesSqlTaskProperties -#### Properties -* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. -* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. -### GetUserTablesSqlSyncTaskProperties -#### Properties -* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskInput +### Properties +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'GetUserTables.Sql' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **serverVersion**: string (ReadOnly): Version of the target server +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### GetUserTablesMySqlTaskProperties -#### Properties -* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesMySql' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### GetUserTablesOracleTaskProperties -#### Properties -* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. -* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesOracle' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### GetUserTablesPostgreSqlTaskProperties -#### Properties -* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. -* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +### Properties +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### MigrateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress -* **taskType**: 'Migrate.MongoDb' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MigrateMySqlAzureDbForMySqlOfflineTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +### Properties +* **database**: string +* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem -### MigrateMySqlAzureDbForMySqlSyncTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations -* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. +## ConnectToTargetSqlDbSyncTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +## ConnectToTargetSqlDbTaskInput +### Properties +* **queryObjectCounts**: bool: Boolean flag indicating whether to query object counts for each database on the target server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. +## ConnectToTargetSqlDbTaskOutput +### Properties +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server -### MigrateSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations -* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. +## ConnectToTargetSqlMISyncTaskInput +### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **parentTaskId**: string: parent task id -* **taskId**: string: task id -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. +## ConnectToTargetSqlMISyncTaskOutput +### Properties +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateSqlServerSqlMISyncTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## ConnectToTargetSqlMITaskInput +### Properties +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. +* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. -### MigrateSqlServerSqlDbTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. +## ConnectToTargetSqlMITaskOutput +### Properties +* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **id**: string (ReadOnly): Result identifier +* **logins**: string[] (ReadOnly): List of logins on the target server. +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateSsisTaskProperties -#### Properties -* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. -* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Ssis' (Required): Task type. +## DatabaseBackupInfo +### Properties +* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. +* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. +* **databaseName**: string (ReadOnly): Database name. +* **familyCount**: int (ReadOnly): Number of files in the backup set. +* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed +* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. +* **position**: int (ReadOnly): Position of current database backup in the file. -### MigrateSchemaSqlServerSqlDbTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. +## DatabaseFileInfo +### Properties +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -### CheckOCIDriverTaskProperties -#### Properties -* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. -* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Check.OCI' (Required): Task type. +## DatabaseInfo +### Properties +* **sourceDatabaseName**: string (Required): Name of the database -### InstallOCIDriverTaskProperties -#### Properties -* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. -* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Install.OCI' (Required): Task type. +## DatabaseMigrationPropertiesSqlMi +### Properties +* **backupConfiguration**: [BackupConfiguration](#backupconfiguration): Backup Configuration +* **endedOn**: string (ReadOnly): Database migration end time. +* **kind**: 'SqlMi' | 'SqlVm' | string (Required) +* **migrationFailureError**: [ErrorInfo](#errorinfo) (ReadOnly): Error details +* **migrationOperationId**: string: ID tracking current migration operation. +* **migrationService**: string: Resource Id of the Migration Service. +* **migrationStatus**: string (ReadOnly): Migration status. +* **migrationStatusDetails**: [MigrationStatusDetails](#migrationstatusdetails) (ReadOnly): Detailed status of current migration. +* **offlineConfiguration**: [OfflineConfiguration](#offlineconfiguration): Offline configuration +* **provisioningError**: string: Error message for migration provisioning failure, if any. +* **provisioningState**: string (ReadOnly): Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. +* **scope**: string: Resource Id of the target resource (SQL VM or SQL Managed Instance). +* **sourceDatabaseName**: string: Name of the source database. +* **sourceSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection +* **startedOn**: string (ReadOnly): Database migration start time. +* **targetDatabaseCollation**: string: Database collation to be used for the target database. -### UploadOCIDriverTaskProperties -#### Properties -* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. -* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Upload.OCI' (Required): Task type. +## DatabaseTable +### Properties +* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not +* **name**: string (ReadOnly): Schema-qualified name of the table -### ValidateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object -* **taskType**: 'Validate.MongoDb' (Required): Task type. +## DataMigrationServiceProperties +### Properties +* **autoStopDelay**: string: The time delay before the service is auto-stopped when idle. +* **deleteResourcesOnStop**: bool: Whether service resources should be deleted when stopped. (Turned on by default) +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have +* **virtualSubnetId**: string: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined -### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object -* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. +## ErrorInfo +### Properties +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message. -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. +## FileShare +### Properties +* **password**: string: Password credential used to connect to the share location. +* **path**: string (Required): The folder path for this share. +* **userName**: string: User name credential to connect to the share location -### ValidateMigrationInputSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## GetTdeCertificatesSqlTaskInput +### Properties +* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. -### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations -* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. +## GetTdeCertificatesSqlTaskOutput +### Properties +* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +## GetUserTablesMySqlTaskInput +### Properties +* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## ProjectTaskPropertiesClientData +## GetUserTablesMySqlTaskOutput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## CommandProperties -* **Discriminator**: commandType +## GetUserTablesOracleTaskInput +### Properties +* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. -### MongoDbCancelCommand -#### Properties -* **commandType**: 'cancel' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## GetUserTablesOracleTaskOutput +### Properties +* **schemaName**: string (ReadOnly): The schema this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MongoDbFinishCommand -#### Properties -* **commandType**: 'finish' (Required): Command type. -* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command +## GetUserTablesPostgreSqlTaskInput +### Properties +* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables -### MigrateMISyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. -* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. -* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. +## GetUserTablesPostgreSqlTaskOutput +### Properties +* **databaseName**: string (ReadOnly): The database this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### MigrateSyncCompleteCommandProperties -#### Properties -* **commandId**: string: Command id -* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. -* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. -* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. +## GetUserTablesSqlSyncTaskInput +### Properties +* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for +* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -### MongoDbRestartCommand -#### Properties -* **commandType**: 'restart' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## GetUserTablesSqlSyncTaskOutput +### Properties +* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables +* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables +* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +## GetUserTablesSqlTaskInput +### Properties +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## ODataError +## GetUserTablesSqlTaskOutput ### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors + +## InstallOCIDriverTaskInput +### Properties +* **driverPackageName**: string: Name of the uploaded driver package to install. -## MongoDbCommandInput +## InstallOCIDriverTaskOutput ### Properties -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbFinishCommandInput +## IntegrationRuntimeMonitoringData ### Properties -* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **name**: string (ReadOnly): The name of Integration Runtime. +* **nodes**: [NodeMonitoringData](#nodemonitoringdata)[] (ReadOnly): Integration Runtime node monitoring data. ## MigrateMISyncCompleteCommandInput ### Properties @@ -652,1500 +594,1634 @@ ### Properties * **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution -## ReportableException +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput ### Properties -* **actionableMessage**: string: Actionable steps for this exception -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace +* **name**: string: Name of the database +* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## MigrateSyncCompleteCommandInput +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap ### Properties -* **commitTimeStamp**: string: Time stamp to complete -* **databaseName**: string (Required): Name of database +### Additional Properties +* **Additional Properties Type**: string -## MigrateSyncCompleteCommandOutput +## MigrateMySqlAzureDbForMySqlOfflineTaskInput ### Properties -* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution -* **id**: string (ReadOnly): Result identifier +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **makeSourceServerReadOnly**: bool: Setting to set the source server read only +* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **startedOn**: string: Parameter to specify when the migration started +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -## MongoDbConnectionInfo +## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings ### Properties -* **additionalSettings**: string: Additional connection settings -* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **enforceSSL**: bool -* **password**: string: Password credential. -* **port**: int: port for server -* **serverBrandVersion**: string: server brand version -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## MongoDbClusterInfo +## MigrateMySqlAzureDbForMySqlOfflineTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel +#### Properties +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel +#### Properties +* **databases**: string: Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message + + +## MigrateMySqlAzureDbForMySqlSyncDatabaseInput ### Properties -* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster -* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections -* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source -* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. +* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MongoDbDatabaseInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +### Additional Properties +* **Additional Properties Type**: string -## MongoDbCollectionInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **databaseName**: string (Required): The name of the database containing the collection -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) -* **isSystemCollection**: bool (Required): Whether the collection is system collection -* **isView**: bool (Required): Whether the collection is a view of another collection -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -* **viewOf**: string: The name of the collection that this is a view of, if IsView is true +### Additional Properties +* **Additional Properties Type**: string -## MongoDbShardKeyInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +### Additional Properties +* **Additional Properties Type**: string -## MongoDbShardKeyField +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting ### Properties -* **name**: string (Required): The name of the field -* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceMySqlTaskInput +## MigrateMySqlAzureDbForMySqlSyncTaskInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate * **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -## MySqlConnectionInfo -### Properties -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name +## MigrateMySqlAzureDbForMySqlSyncTaskOutput +* **Discriminator**: resultType -## ConnectToSourceNonSqlTaskOutput -### Properties -* **databases**: string[] (ReadOnly): List of databases on the server +### Base Properties * **id**: string (ReadOnly): Result identifier -* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source -* **sourceServerBrandVersion**: string (ReadOnly): Server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## ServerProperties -### Properties -* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server -* **serverEdition**: string (ReadOnly): Edition of the database server -* **serverName**: string (ReadOnly): Name of the server -* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system -* **serverPlatform**: string (ReadOnly): Name of the server platform -* **serverVersion**: string (ReadOnly): Version of the database server +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## ConnectToSourceOracleSyncTaskInput -### Properties -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +### MigrateMySqlAzureDbForMySqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## OracleConnectionInfo -### Properties -* **dataSource**: string (Required): EZConnect or TNSName connection string. -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name -## ConnectToSourceOracleSyncTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput ### Properties -* **databases**: string[] (ReadOnly): List of schemas on source server -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower +* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the migration pipeline +* **schemaName**: string: Name of the source schema +* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToSourcePostgreSqlSyncTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## PostgreSqlConnectionInfo +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **databaseName**: string: Name of the database -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverBrandVersion**: string: server brand version -* **serverName**: string (Required): Name of the server -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourcePostgreSqlSyncTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap ### Properties -* **databases**: string[] (ReadOnly): List of databases on source server -* **id**: string (ReadOnly): Result identifier -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceSqlServerTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. -* **collectDatabases**: bool: Flag for whether to collect databases from source server. -* **collectLogins**: bool: Flag for whether to collect logins from source server. -* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. +### Additional Properties +* **Additional Properties Type**: string -## SqlConnectionInfo +## MigrateOracleAzureDbPostgreSqlSyncTaskInput ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types -* **port**: int: Port for Server -* **resourceId**: string: Represents the ID of an HTTP resource represented by an Azure resource provider. -* **serverBrandVersion**: string: server brand version -* **serverName**: string: name of the server -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## ConnectToSourceSqlServerTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncTaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### ConnectToSourceSqlServerTaskOutputAgentJobLevel +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError #### Properties -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **jobCategory**: string (ReadOnly): The type of Agent Job. -* **jobOwner**: string (ReadOnly): The owner of the Agent Job -* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Agent Job name -* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -### ConnectToSourceSqlServerTaskOutputDatabaseLevel +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel #### Properties -* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels -* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files -* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states -* **name**: string (ReadOnly): Database name -* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level -* **sizeMB**: int (ReadOnly): Size of the file in megabytes +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -### ConnectToSourceSqlServerTaskOutputLoginLevel +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError #### Properties -* **defaultDatabase**: string (ReadOnly): The default database for the login. -* **isEnabled**: bool (ReadOnly): The state of the login. -* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Login name. -* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### ConnectToSourceSqlServerTaskOutputTaskLevel +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel #### Properties -* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable -* **logins**: string (ReadOnly): Source logins as a map from login name to login id. -* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name * **sourceServerVersion**: string (ReadOnly): Source server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - - -## MigrationEligibilityInfo -### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## DatabaseFileInfo -### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## ConnectToTargetAzureDbForMySqlTaskInput -### Properties -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -## ConnectToTargetAzureDbForMySqlTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server * **id**: string (ReadOnly): Result identifier -* **serverVersion**: string (ReadOnly): Version of the target server -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration +* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: any -## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. -* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput ### Properties -* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. -* **id**: string (ReadOnly): Result identifier -* **logins**: string[] (ReadOnly): List of logins on the target server. -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **name**: string: Name of the table to migrate -## ConnectToTargetSqlMISyncTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput ### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **startedOn**: string (ReadOnly): Migration start time +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## MiSqlConnectionInfo -### Properties -* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## ConnectToTargetSqlMISyncTaskOutput -### Properties -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput -### Properties -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events +* **resultType**: 'ErrorOutput' (Required): Result type -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput -### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int: Number of databases to include +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. +* **targetServer**: string (ReadOnly): Target server name +* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type +* **targetServerVersion**: string (ReadOnly): Target server version -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem -### Properties -* **database**: string -* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## ConnectToTargetSqlDbTaskInput -### Properties -* **queryObjectCounts**: bool: Boolean flag indicating whether to query object counts for each database on the target server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ConnectToTargetSqlDbTaskOutput +## MigrateSchemaSqlServerSqlDbDatabaseInput ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +* **id**: string: Id of the source database +* **name**: string: Name of source database +* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target +* **targetDatabaseName**: string: Name of target database -## ConnectToTargetSqlDbSyncTaskInput +## MigrateSchemaSqlServerSqlDbTaskInput ### Properties +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate * **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Migration start time * **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## GetTdeCertificatesSqlTaskInput -### Properties -* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. +## MigrateSchemaSqlServerSqlDbTaskOutput +* **Discriminator**: resultType -## FileShare -### Properties -* **password**: string: Password credential used to connect to the share location. -* **path**: string (Required): The folder path for this share. -* **userName**: string: User name credential to connect to the share location +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel +#### Properties +* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database +* **databaseName**: string (ReadOnly): The name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database +* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database +* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database +* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -## SelectedCertificateInput -### Properties -* **certificateName**: string (Required): Name of certificate to be exported. -* **password**: string (Required): Password to use for encrypting the exported certificate. +### MigrateSchemaSqlTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## GetTdeCertificatesSqlTaskOutput -### Properties -* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## GetUserTablesSqlSyncTaskInput -### Properties -* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for -* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### MigrateSchemaSqlServerSqlDbTaskOutputError +#### Properties +* **commandText**: string (ReadOnly): Schema command which failed +* **errorText**: string (ReadOnly): Reason of failure +* **resultType**: 'SchemaErrorOutput' (Required): Result type -## GetUserTablesSqlSyncTaskOutput -### Properties -* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables -* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables -* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## GetUserTablesSqlTaskInput +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +* **id**: string: id of the database +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **schemaSetting**: any: Any object +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## GetUserTablesSqlTaskOutput +## MigrateSqlServerSqlDbDatabaseInputTableMap ### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables -* **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string -## GetUserTablesMySqlTaskInput +## MigrateSqlServerSqlDbSyncDatabaseInput ### Properties -* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +* **id**: string: Unique identifier for database +* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of database +* **schemaName**: string: Schema name to be migrated +* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Target database name +* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## GetUserTablesMySqlTaskOutput +## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting ### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables -* **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string -## GetUserTablesOracleTaskInput +## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting ### Properties -* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables +### Additional Properties +* **Additional Properties Type**: string -## GetUserTablesOracleTaskOutput +## MigrateSqlServerSqlDbSyncDatabaseInputTableMap ### Properties -* **schemaName**: string (ReadOnly): The schema this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## DatabaseTable +## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting ### Properties -* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not -* **name**: string (ReadOnly): Schema-qualified name of the table +### Additional Properties +* **Additional Properties Type**: string -## GetUserTablesPostgreSqlTaskInput +## MigrateSqlServerSqlDbSyncTaskInput ### Properties -* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables +* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## GetUserTablesPostgreSqlTaskOutput -### Properties -* **databaseName**: string (ReadOnly): The database this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +## MigrateSqlServerSqlDbSyncTaskOutput +* **Discriminator**: resultType -## MongoDbMigrationSettings -### Properties -* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. -* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. -* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. -* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## MongoDbMigrationSettingsDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## MongoDbDatabaseSettings -### Properties -* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. +### MigrateSqlServerSqlDbSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## MongoDbDatabaseSettingsCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## MongoDbCollectionSettings -### Properties -* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. -* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. +### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## MongoDbShardKeySetting -### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool: Whether the shard key is unique -## MongoDbThrottlingSettings +## MigrateSqlServerSqlDbTaskInput ### Properties -* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel -* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 -* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Date and time relative to UTC when the migration was started on +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## MongoDbProgress +## MigrateSqlServerSqlDbTaskOutput * **Discriminator**: resultType ### Base Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -### MongoDbCollectionProgress +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel #### Properties -* **resultType**: 'Collection' (Required): The type of progress object +* **databaseName**: string (ReadOnly): Name of the item +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -### MongoDbDatabaseProgress +### MigrateSqlServerSqlDbTaskOutputError #### Properties -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **resultType**: 'Database' (Required): The type of progress object +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### MongoDbMigrationProgress +### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult #### Properties -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **resultType**: 'Migration' (Required): The type of progress object - - -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type -## MongoDbError -### Properties -* **code**: string: The non-localized, machine-readable code that describes the error or warning -* **count**: int: The number of times the error or warning has occurred -* **message**: string: The localized, human-readable message that describes the error or warning -* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version -## MongoDbDatabaseProgressCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +### MigrateSqlServerSqlDbTaskOutputValidationResult +#### Properties +* **resultType**: 'MigrationValidationOutput' (Required): Result type -## MongoDbCollectionProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MigrateSqlServerSqlDbTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MongoDbMigrationProgressDatabases +## MigrateSqlServerSqlMIDatabaseInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) +* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **id**: string: id of the database +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination -## MongoDbDatabaseProgress +## MigrateSqlServerSqlMISyncTaskInput ### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **numberOfParallelDatabaseMigrations**: int: Number of database migrations to start in parallel +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## MongoDbDatabaseProgressCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +## MigrateSqlServerSqlMISyncTaskOutput +* **Discriminator**: resultType -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +#### Properties +* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) +* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to +* **endedOn**: string (ReadOnly): Database migration end time +* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not +* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sourceDatabaseName**: string (ReadOnly): Name of the database +* **startedOn**: string (ReadOnly): Database migration start time -## MigrateMySqlAzureDbForMySqlOfflineTaskInput -### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **makeSourceServerReadOnly**: bool: Setting to set the source server read only -* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **startedOn**: string: Parameter to specify when the migration started -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +### MigrateSqlServerSqlMISyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **databaseErrorCount**: int (ReadOnly): Number of database level errors +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerName**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerName**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput -### Properties -* **name**: string: Name of the database -* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap +## MigrateSqlServerSqlMITaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedAgentJobs**: string[]: Agent Jobs to migrate. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **selectedLogins**: string[]: Logins to migrate. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Date and time relative to UTC when the migration was started on +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MigrateMySqlAzureDbForMySqlOfflineTaskOutput +## MigrateSqlServerSqlMITaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel +### MigrateSqlServerSqlMITaskOutputAgentJobLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **message**: string (ReadOnly): Migration progress message +* **name**: string (ReadOnly): Agent Job name. +* **resultType**: 'AgentJobLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputDatabaseLevel #### Properties * **databaseName**: string (ReadOnly): Name of the database * **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings * **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item * **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sizeMB**: int (ReadOnly): Size of the database in megabytes * **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration * **startedOn**: string (ReadOnly): Migration start time * **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError +### MigrateSqlServerSqlMITaskOutputError #### Properties * **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions * **resultType**: 'ErrorOutput' (Required): Result type -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel +### MigrateSqlServerSqlMITaskOutputLoginLevel #### Properties -* **databases**: string: Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Login migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login +* **loginName**: string (ReadOnly): Login name. +* **message**: string (ReadOnly): Login migration progress message +* **resultType**: 'LoginLevelOutput' (Required): Result type +* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. +* **startedOn**: string (ReadOnly): Login migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputMigrationLevel +#### Properties +* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id * **endedOn**: string (ReadOnly): Migration end time * **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **logins**: string (ReadOnly): Selected logins as a map from name to id * **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. * **resultType**: 'MigrationLevelOutput' (Required): Result type +* **serverRoleResults**: string (ReadOnly): Map of server role migration results. * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version * **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration * **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message * **targetServerBrandVersion**: string (ReadOnly): Target server brand version * **targetServerVersion**: string (ReadOnly): Target server version -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel + +## MigrateSsisTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## MigrateSsisTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSsisTaskOutputMigrationLevel #### Properties * **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSsisTaskOutputProjectLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **folderName**: string (ReadOnly): Name of the folder +* **message**: string (ReadOnly): Migration progress message +* **projectName**: string (ReadOnly): Name of the project +* **resultType**: 'SsisProjectLevelOutput' (Required): Result type +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration * **startedOn**: string (ReadOnly): Migration start time * **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +## MigrateSyncCompleteCommandInput +### Properties +* **commitTimeStamp**: string: Time stamp to complete +* **databaseName**: string (Required): Name of database + +## MigrateSyncCompleteCommandOutput +### Properties +* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +* **id**: string (ReadOnly): Result identifier + +## MigrationEligibilityInfo +### Properties +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. + ## MigrationReportResult ### Properties * **id**: string: Migration validation result identifier * **reportUrl**: string: The url of the report. -## MigrateMySqlAzureDbForMySqlSyncTaskInput +## MigrationStatusDetails +### Properties +* **activeBackupSets**: [SqlBackupSetInfo](#sqlbackupsetinfo)[] (ReadOnly): Backup sets that are currently active. +* **blobContainerName**: string (ReadOnly): Name of blob container. +* **completeRestoreErrorMessage**: string (ReadOnly): Complete restore error message, if any +* **currentRestoringFilename**: string (ReadOnly): File name that is currently being restored. +* **fileUploadBlockingErrors**: string[] (ReadOnly): File upload blocking errors, if any. +* **fullBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set +* **invalidFiles**: string[] (ReadOnly): Files that are not valid backup files. +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not. +* **lastRestoredBackupSetInfo**: [SqlBackupSetInfo](#sqlbackupsetinfo) (ReadOnly): Information of backup set +* **lastRestoredFilename**: string (ReadOnly): Last restored file name. +* **migrationState**: string (ReadOnly): Current State of Migration. +* **pendingLogBackupsCount**: int (ReadOnly): Total pending log backups. +* **restoreBlockingReason**: string (ReadOnly): Restore blocking reason, if any + +## MigrationValidationDatabaseSummaryResult +### Properties +* **endedOn**: string (ReadOnly): Validation end time +* **id**: string (ReadOnly): Result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database + +## MigrationValidationOptions +### Properties +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. + +## MigrationValidationResult +### Properties +* **id**: string (ReadOnly): Migration validation result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database + +## MigrationValidationResultSummaryResults +### Properties +### Additional Properties +* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) + +## MiSqlConnectionInfo +### Properties +* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## MongoDbClusterInfo +### Properties +* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster +* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections +* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source +* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. + +## MongoDbCollectionInfo +### Properties +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **databaseName**: string (Required): The name of the database containing the collection +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) +* **isSystemCollection**: bool (Required): Whether the collection is system collection +* **isView**: bool (Required): Whether the collection is a view of another collection +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **viewOf**: string: The name of the collection that this is a view of, if IsView is true + +## MongoDbCollectionProgress +### Properties +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown + +## MongoDbCollectionSettings +### Properties +* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. +* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. + +## MongoDbCommandInput +### Properties +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration + +## MongoDbConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **enforceSSL**: bool +* **password**: string: Password credential. +* **port**: int: port for server +* **serverBrandVersion**: string: server brand version +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name + +## MongoDbDatabaseInfo ### Properties -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -## MigrateMySqlAzureDbForMySqlSyncDatabaseInput +## MongoDbDatabaseProgress ### Properties -* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting +## MongoDbDatabaseProgressCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap +## MongoDbDatabaseSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting +## MongoDbDatabaseSettingsCollections ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## MigrateMySqlAzureDbForMySqlSyncTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version - -### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes - +* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) -## SyncMigrationDatabaseErrorEvent +## MongoDbError ### Properties -* **eventText**: string (ReadOnly): Event text. -* **eventTypeString**: string (ReadOnly): Event type. -* **timestampString**: string (ReadOnly): String value of timestamp. +* **code**: string: The non-localized, machine-readable code that describes the error or warning +* **count**: int: The number of times the error or warning has occurred +* **message**: string: The localized, human-readable message that describes the error or warning +* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning -## MigrateOracleAzureDbPostgreSqlSyncTaskInput +## MongoDbFinishCommandInput ### Properties -* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput +## MongoDbMigrationProgress ### Properties -* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower -* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the migration pipeline -* **schemaName**: string: Name of the source schema -* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap +## MongoDbMigrationSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. +* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. +* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. +* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbMigrationSettingsDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) -## MigrateOracleAzureDbPostgreSqlSyncTaskOutput +## MongoDbProgress * **Discriminator**: resultType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type - -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MongoDbCollectionProgress #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **resultType**: 'Collection' (Required): The type of progress object -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +### MongoDbDatabaseProgress #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **resultType**: 'Database' (Required): The type of progress object +### MongoDbMigrationProgress +#### Properties +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **resultType**: 'Migration' (Required): The type of progress object -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput -### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **startedOn**: string (ReadOnly): Migration start time -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput +## MongoDbProgressErrors ### Properties -* **id**: string (ReadOnly): Result identifier -* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration -* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput +## MongoDbProgressErrors ### Properties -* **name**: string: Name of the table to migrate +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbShardKeyField ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of the field +* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput -* **Discriminator**: resultType +## MongoDbShardKeyInfo +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +## MongoDbShardKeySetting +### Properties +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool: Whether the shard key is unique -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +## MongoDbThrottlingSettings +### Properties +* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel +* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 +* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events -* **resultType**: 'ErrorOutput' (Required): Result type +## MySqlConnectionInfo +### Properties +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel -#### Properties -* **databaseCount**: int: Number of databases to include -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. -* **targetServer**: string (ReadOnly): Target server name -* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type -* **targetServerVersion**: string (ReadOnly): Target server version +## NodeMonitoringData +### Properties +* **additionalProperties**: [NodeMonitoringDataAdditionalProperties](#nodemonitoringdataadditionalproperties) (ReadOnly): Unmatched properties from the message are deserialized in this collection. +* **availableMemoryInMB**: int (ReadOnly): Available memory (MB) on the integration runtime node. +* **concurrentJobsLimit**: int (ReadOnly): Maximum concurrent jobs on the integration runtime node. +* **concurrentJobsRunning**: int (ReadOnly): The number of jobs currently running on the integration runtime node. +* **cpuUtilization**: int (ReadOnly): CPU percentage on the integration runtime node. +* **maxConcurrentJobs**: int (ReadOnly): The maximum concurrent jobs in this integration runtime. +* **nodeName**: string (ReadOnly): Name of the integration runtime node. +* **receivedBytes**: int (ReadOnly): Received bytes on the integration runtime node. +* **sentBytes**: int (ReadOnly): Sent bytes on the integration runtime node. -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## NodeMonitoringDataAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error -## MigrateSqlServerSqlDbSyncTaskInput +## OfflineConfiguration ### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +* **lastBackupName**: string: Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. +* **offline**: bool: Offline migration -## MigrateSqlServerSqlDbSyncDatabaseInput +## OracleConnectionInfo ### Properties -* **id**: string: Unique identifier for database -* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of database -* **schemaName**: string: Schema name to be migrated -* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Target database name -* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **dataSource**: string (Required): EZConnect or TNSName connection string. +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting +## OracleOCIDriverInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. +* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' +* **driverName**: string (ReadOnly): The name of the driver package +* **driverSize**: string (ReadOnly): The size in bytes of the driver package +* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. +* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. -## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting +## OrphanedUserInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databaseName**: string: Parent database of the user +* **name**: string: Name of the orphaned user -## MigrateSqlServerSqlDbSyncDatabaseInputTableMap +## PostgreSqlConnectionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **databaseName**: string: Name of the database +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverBrandVersion**: string: server brand version +* **serverName**: string (Required): Name of the server +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting +## ProjectFileProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. +* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. +* **lastModified**: string (ReadOnly): Modification DateTime. +* **mediaType**: string: File content type. This property can be modified to reflect the file content type. +* **size**: int (ReadOnly): File size. -## MigrationValidationOptions +## ProjectProperties ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **azureAuthenticationInfo**: [AzureActiveDirectoryApp](#azureactivedirectoryapp): Azure Active Directory Application +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project -## MigrateSqlServerSqlDbSyncTaskOutput -* **Discriminator**: resultType +## ProjectTaskProperties +* **Discriminator**: taskType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task +* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToMongoDbTaskProperties #### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source +* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object +* **taskType**: 'Connect.MongoDb' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputError +### ConnectToSourceMySqlTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection +* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.MySql' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +### ConnectToSourceOracleSyncTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection +* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. -### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +### ConnectToSourcePostgreSqlSyncTaskProperties #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements +* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. +### ConnectToSourceSqlServerTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. -## MigrateSqlServerSqlMITaskInput -### Properties -* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedAgentJobs**: string[]: Agent Jobs to migrate. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **selectedLogins**: string[]: Logins to migrate. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Date and time relative to UTC when the migration was started on -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### ConnectToSourceSqlServerSyncTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. -## BlobShare -### Properties -* **sasUri**: string: SAS URI of Azure Storage Account Container. +### ConnectToTargetAzureDbForMySqlTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements +* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. -## MigrateSqlServerSqlMIDatabaseInput -### Properties -* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **id**: string: id of the database -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination +### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements +* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. -## MigrateSqlServerSqlMITaskOutput -* **Discriminator**: resultType +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMITaskOutputAgentJobLevel +### ConnectToTargetSqlMISyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **message**: string (ReadOnly): Migration progress message -* **name**: string (ReadOnly): Agent Job name. -* **resultType**: 'AgentJobLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. +* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputDatabaseLevel +### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sizeMB**: int (ReadOnly): Size of the database in megabytes -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. +* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputError +### ConnectToTargetSqlDbTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputLoginLevel +### ConnectToTargetSqlDbSyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Login migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login -* **loginName**: string (ReadOnly): Login name. -* **message**: string (ReadOnly): Login migration progress message -* **resultType**: 'LoginLevelOutput' (Required): Result type -* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. -* **startedOn**: string (ReadOnly): Login migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputMigrationLevel +### GetTdeCertificatesSqlTaskProperties #### Properties -* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **logins**: string (ReadOnly): Selected logins as a map from name to id -* **message**: string (ReadOnly): Migration progress message -* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **serverRoleResults**: string (ReadOnly): Map of server role migration results. -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. +* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. +### GetUserTablesSqlSyncTaskProperties +#### Properties +* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. -## OrphanedUserInfo -### Properties -* **databaseName**: string: Parent database of the user -* **name**: string: Name of the orphaned user +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'GetUserTables.Sql' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **numberOfParallelDatabaseMigrations**: int: Number of database migrations to start in parallel -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### GetUserTablesMySqlTaskProperties +#### Properties +* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesMySql' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskOutput -* **Discriminator**: resultType +### GetUserTablesOracleTaskProperties +#### Properties +* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. +* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesOracle' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +### GetUserTablesPostgreSqlTaskProperties #### Properties -* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) -* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to -* **endedOn**: string (ReadOnly): Database migration end time -* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not -* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sourceDatabaseName**: string (ReadOnly): Name of the database -* **startedOn**: string (ReadOnly): Database migration start time +* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. +* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputError +### MigrateMongoDbTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress +* **taskType**: 'Migrate.MongoDb' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +### MigrateMySqlAzureDbForMySqlOfflineTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **databaseErrorCount**: int (ReadOnly): Number of database level errors -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerName**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerName**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. + +### MigrateMySqlAzureDbForMySqlSyncTaskProperties +#### Properties +* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations +* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. + +### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. -## BackupSetInfo -### Properties -* **backupFinishedDate**: string: Date and time that the backup operation finished -* **backupSetId**: string: Id for the set of backup files -* **backupStartDate**: string: Date and time that the backup operation began -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. -* **databaseName**: string: Name of the database to which the backup set belongs -* **firstLsn**: string: First log sequence number of the backup file -* **isBackupRestored**: bool: Whether the backup set is restored or not -* **lastLsn**: string: Last log sequence number of the backup file -* **lastModifiedTime**: string: Last modified time of the backup file in share location -* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set +### MigrateSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations +* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. -## BackupFileInfo -### Properties -* **familySequenceNumber**: int: Sequence number of the backup file in the backup set -* **fileLocation**: string: Location of the backup file in shared folder -* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. +### MigrateSqlServerSqlMITaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **parentTaskId**: string: parent task id +* **taskId**: string: task id +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. -## MigrateSqlServerSqlDbTaskInput -### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Date and time relative to UTC when the migration was started on -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### MigrateSqlServerSqlMISyncTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInput -### Properties -* **id**: string: id of the database -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **schemaSetting**: any: Any object -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSsisTaskProperties +#### Properties +* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. +* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Ssis' (Required): Task type. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +### MigrateSchemaSqlServerSqlDbTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +### CheckOCIDriverTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. +* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Check.OCI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### InstallOCIDriverTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. +* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Install.OCI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +### UploadOCIDriverTaskProperties #### Properties -* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type +* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. +* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Upload.OCI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### ValidateMongoDbTaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object +* **taskType**: 'Validate.MongoDb' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputValidationResult +### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **resultType**: 'MigrationValidationOutput' (Required): Result type +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object +* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### ValidateMigrationInputSqlServerSqlMITaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. +### ValidateMigrationInputSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. -## MigrationValidationResult -### Properties -* **id**: string (ReadOnly): Migration validation result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database +### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations +* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. -## MigrationValidationResultSummaryResults + +## ProjectTaskPropertiesClientData ### Properties ### Additional Properties -* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) +* **Additional Properties Type**: string -## MigrationValidationDatabaseSummaryResult +## ReportableException ### Properties -* **endedOn**: string (ReadOnly): Validation end time -* **id**: string (ReadOnly): Result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +* **actionableMessage**: string: Actionable steps for this exception +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace -## MigrateSsisTaskInput +## SchemaMigrationSetting ### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **fileId**: string: Resource Identifier of a file resource containing the uploaded schema file +* **fileName**: string: Name of the file resource containing the uploaded schema file +* **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target -## SsisMigrationInfo +## SelectedCertificateInput ### Properties -* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS - -## MigrateSsisTaskOutput -* **Discriminator**: resultType - -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSsisTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **certificateName**: string (Required): Name of certificate to be exported. +* **password**: string (Required): Password to use for encrypting the exported certificate. -### MigrateSsisTaskOutputProjectLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **folderName**: string (ReadOnly): Name of the folder -* **message**: string (ReadOnly): Migration progress message -* **projectName**: string (ReadOnly): Name of the project -* **resultType**: 'SsisProjectLevelOutput' (Required): Result type -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +## ServerProperties +### Properties +* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server +* **serverEdition**: string (ReadOnly): Edition of the database server +* **serverName**: string (ReadOnly): Name of the server +* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system +* **serverPlatform**: string (ReadOnly): Name of the server platform +* **serverVersion**: string (ReadOnly): Version of the database server +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' -## MigrateSchemaSqlServerSqlDbTaskInput +## SourceLocation ### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Migration start time -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **azureBlob**: [AzureBlob](#azureblob): Azure Blob Details +* **fileShare**: [SqlFileShare](#sqlfileshare): File share -## MigrateSchemaSqlServerSqlDbDatabaseInput +## SqlBackupFileInfo ### Properties -* **id**: string: Id of the source database -* **name**: string: Name of source database -* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target -* **targetDatabaseName**: string: Name of target database +* **copyDuration**: int (ReadOnly): Copy Duration in seconds +* **copyThroughput**: int (ReadOnly): Copy throughput in KBps +* **dataRead**: int (ReadOnly): Bytes read +* **dataWritten**: int (ReadOnly): Bytes written +* **familySequenceNumber**: int (ReadOnly): Media family sequence number +* **fileName**: string (ReadOnly): File name. +* **status**: string (ReadOnly): Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) +* **totalSize**: int (ReadOnly): File size in bytes -## SchemaMigrationSetting +## SqlBackupSetInfo ### Properties -* **fileId**: string: Resource Identifier of a file resource containing the uploaded schema file -* **fileName**: string: Name of the file resource containing the uploaded schema file -* **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target +* **backupFinishDate**: string (ReadOnly): Backup end time. +* **backupSetId**: string (ReadOnly): Backup set id. +* **backupStartDate**: string (ReadOnly): Backup start date. +* **backupType**: string (ReadOnly): Backup type. +* **familyCount**: int (ReadOnly): Media family count +* **firstLSN**: string (ReadOnly): First LSN of the backup set. +* **hasBackupChecksums**: bool (ReadOnly): Has Backup Checksums +* **ignoreReasons**: string[] (ReadOnly): The reasons why the backup set is ignored +* **isBackupRestored**: bool (ReadOnly): Whether this backup set has been restored or not. +* **lastLSN**: string (ReadOnly): Last LSN of the backup set. +* **listOfBackupFiles**: [SqlBackupFileInfo](#sqlbackupfileinfo)[] (ReadOnly): List of files in the backup set. -## MigrateSchemaSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types +* **port**: int: Port for Server +* **resourceId**: string: Represents the ID of an HTTP resource represented by an Azure resource provider. +* **serverBrandVersion**: string: server brand version +* **serverName**: string: name of the server +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel -#### Properties -* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database -* **databaseName**: string (ReadOnly): The name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database -* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database -* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database -* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +## SqlConnectionInformation +### Properties +* **authentication**: string: Authentication type. +* **dataSource**: string: Data source. +* **encryptConnection**: bool: Whether to encrypt connection or not. +* **password**: string: Password to connect to source SQL. +* **trustServerCertificate**: bool: Whether to trust server certificate or not. +* **userName**: string: User name to connect to source SQL. -### MigrateSchemaSqlTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## SqlFileShare +### Properties +* **password**: string (WriteOnly): Password for username to access file share location. +* **path**: string: Location as SMB share or local drive where backups are placed. +* **username**: string: Username to access the file share location for backups. -### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +## SqlMigrationServiceProperties +### Properties +* **integrationRuntimeState**: string (ReadOnly): Current state of the Integration runtime. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -### MigrateSchemaSqlServerSqlDbTaskOutputError -#### Properties -* **commandText**: string (ReadOnly): Schema command which failed -* **errorText**: string (ReadOnly): Reason of failure -* **resultType**: 'SchemaErrorOutput' (Required): Result type +## SsisMigrationInfo +### Properties +* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS +## SyncMigrationDatabaseErrorEvent +### Properties +* **eventText**: string (ReadOnly): Event text. +* **eventTypeString**: string (ReadOnly): Event type. +* **timestampString**: string (ReadOnly): String value of timestamp. -## CheckOCIDriverTaskInput +## SystemData ### Properties -* **serverVersion**: string: Version of the source server to check against. Optional. +* **createdAt**: string +* **createdBy**: string +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string +* **lastModifiedAt**: string +* **lastModifiedBy**: string +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string -## CheckOCIDriverTaskOutput +## TargetLocation ### Properties -* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **accountKey**: string: Storage Account Key. +* **storageAccountResourceId**: string: Resource Id of the storage account copying backups. -## OracleOCIDriverInfo +## TrackedResourceTags ### Properties -* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. -* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' -* **driverName**: string (ReadOnly): The name of the driver package -* **driverSize**: string (ReadOnly): The size in bytes of the driver package -* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. -* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +### Additional Properties +* **Additional Properties Type**: string -## InstallOCIDriverTaskInput +## TrackedResourceTags ### Properties -* **driverPackageName**: string: Name of the uploaded driver package to install. +### Additional Properties +* **Additional Properties Type**: string -## InstallOCIDriverTaskOutput +## TrackedResourceTags ### Properties -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string ## UploadOCIDriverTaskInput ### Properties @@ -2156,36 +2232,19 @@ * **driverPackageName**: string (ReadOnly): The name of the driver package that was validated and uploaded. * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbMigrationProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown - -## MongoDbMigrationProgressDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) - -## MongoDbProgressErrors +## ValidateMigrationInputSqlServerSqlMISyncTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## ValidateOracleAzureDbPostgreSqlSyncTaskOutput +## ValidateMigrationInputSqlServerSqlMISyncTaskOutput ### Properties +* **id**: string (ReadOnly): Database identifier +* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateMigrationInputSqlServerSqlMITaskInput @@ -2209,30 +2268,8 @@ * **name**: string (ReadOnly): Name of database * **restoreDatabaseNameErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with the RestoreDatabaseName -## DatabaseBackupInfo -### Properties -* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. -* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. -* **databaseName**: string (ReadOnly): Database name. -* **familyCount**: int (ReadOnly): Number of files in the backup set. -* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed -* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. -* **position**: int (ReadOnly): Position of current database backup in the file. - -## ValidateMigrationInputSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance - -## ValidateMigrationInputSqlServerSqlMISyncTaskOutput +## ValidateOracleAzureDbPostgreSqlSyncTaskOutput ### Properties -* **id**: string (ReadOnly): Database identifier -* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateSyncMigrationInputSqlServerTaskInput @@ -2247,40 +2284,3 @@ * **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object -## SqlMigrationServiceProperties -### Properties -* **integrationRuntimeState**: string (ReadOnly): Current state of the Integration runtime. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthenticationKeys -### Properties -* **authKey1**: string (ReadOnly): The first authentication key. -* **authKey2**: string (ReadOnly): The second authentication key. - -## IntegrationRuntimeMonitoringData -### Properties -* **name**: string (ReadOnly): The name of Integration Runtime. -* **nodes**: [NodeMonitoringData](#nodemonitoringdata)[] (ReadOnly): Integration Runtime node monitoring data. - -## NodeMonitoringData -### Properties -* **additionalProperties**: [NodeMonitoringDataAdditionalProperties](#nodemonitoringdataadditionalproperties) (ReadOnly): Unmatched properties from the message are deserialized in this collection. -* **availableMemoryInMB**: int (ReadOnly): Available memory (MB) on the integration runtime node. -* **concurrentJobsLimit**: int (ReadOnly): Maximum concurrent jobs on the integration runtime node. -* **concurrentJobsRunning**: int (ReadOnly): The number of jobs currently running on the integration runtime node. -* **cpuUtilization**: int (ReadOnly): CPU percentage on the integration runtime node. -* **maxConcurrentJobs**: int (ReadOnly): The maximum concurrent jobs in this integration runtime. -* **nodeName**: string (ReadOnly): Name of the integration runtime node. -* **receivedBytes**: int (ReadOnly): Received bytes on the integration runtime node. -* **sentBytes**: int (ReadOnly): Sent bytes on the integration runtime node. - -## NodeMonitoringDataAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - diff --git a/generated/datamigration/microsoft.datamigration/2022-03-30-preview/types.md b/generated/datamigration/microsoft.datamigration/2022-03-30-preview/types.md index 97a8e76745..29e595b18f 100644 --- a/generated/datamigration/microsoft.datamigration/2022-03-30-preview/types.md +++ b/generated/datamigration/microsoft.datamigration/2022-03-30-preview/types.md @@ -93,117 +93,84 @@ * **ApiVersion**: 2022-03-30-preview * **Output**: [IntegrationRuntimeMonitoringData](#integrationruntimemonitoringdata) -## DatabaseMigrationPropertiesSqlDb +## AuthenticationKeys ### Properties -* **endedOn**: string (ReadOnly): Database migration end time. -* **kind**: 'SqlDb' | 'SqlMi' | 'SqlVm' | string (Required) -* **migrationFailureError**: [ErrorInfo](#errorinfo) (ReadOnly): Error details -* **migrationOperationId**: string: ID tracking current migration operation. -* **migrationService**: string: Resource Id of the Migration Service. -* **migrationStatus**: string (ReadOnly): Migration status. -* **migrationStatusDetails**: [SqlDbMigrationStatusDetails](#sqldbmigrationstatusdetails) (ReadOnly): Detailed status of current Sql Db migration. -* **offlineConfiguration**: [SqlDbOfflineConfiguration](#sqldbofflineconfiguration) (ReadOnly): Offline configuration -* **provisioningError**: string: Error message for migration provisioning failure, if any. -* **provisioningState**: string (ReadOnly): Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. -* **scope**: string: Resource Id of the target resource (SQL VM or SQL Managed Instance). -* **sourceDatabaseName**: string: Name of the source database. -* **sourceServerName**: string (ReadOnly): Name of the source sql server. -* **sourceSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection -* **startedOn**: string (ReadOnly): Database migration start time. -* **tableList**: string[]: List of tables to copy. -* **targetDatabaseCollation**: string: Database collation to be used for the target database. -* **targetSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection +* **authKey1**: string (ReadOnly): The first authentication key. +* **authKey2**: string (ReadOnly): The second authentication key. -## ErrorInfo +## AzureActiveDirectoryApp ### Properties -* **code**: string (ReadOnly): Error code. -* **message**: string (ReadOnly): Error message. +* **appKey**: string: Key used to authenticate to the Azure Active Directory Application +* **applicationId**: string: Application ID of the Azure Active Directory Application +* **ignoreAzurePermissions**: bool: Ignore checking azure permissions on the AAD app +* **tenantId**: string: Tenant id of the customer -## SqlDbMigrationStatusDetails +## BackupFileInfo ### Properties -* **listOfCopyProgressDetails**: [CopyProgressDetails](#copyprogressdetails)[] (ReadOnly): Details on progress of ADF copy activities. -* **migrationState**: string (ReadOnly): Current State of Migration. -* **sqlDataCopyErrors**: string[] (ReadOnly): Sql Data Copy errors, if any. +* **familySequenceNumber**: int: Sequence number of the backup file in the backup set +* **fileLocation**: string: Location of the backup file in shared folder +* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. -## CopyProgressDetails +## BackupSetInfo ### Properties -* **copyDuration**: int (ReadOnly): Copy Duration in seconds -* **copyStart**: string (ReadOnly): Copy Start -* **copyThroughput**: int (ReadOnly): Copy throughput in KBps -* **dataRead**: int (ReadOnly): Bytes read -* **dataWritten**: int (ReadOnly): Bytes written -* **parallelCopyType**: string (ReadOnly): Type of parallel copy (Dynamic range, Physical partition, none). -* **rowsCopied**: int (ReadOnly): Rows Copied -* **rowsRead**: int (ReadOnly): Rows read -* **status**: string (ReadOnly): Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). -* **tableName**: string (ReadOnly): Table Name -* **usedParallelCopies**: int (ReadOnly): The degree of parallelization. +* **backupFinishedDate**: string: Date and time that the backup operation finished +* **backupSetId**: string: Id for the set of backup files +* **backupStartDate**: string: Date and time that the backup operation began +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. +* **databaseName**: string: Name of the database to which the backup set belongs +* **firstLsn**: string: First log sequence number of the backup file +* **isBackupRestored**: bool: Whether the backup set is restored or not +* **lastLsn**: string: Last log sequence number of the backup file +* **lastModifiedTime**: string: Last modified time of the backup file in share location +* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set -## SqlDbOfflineConfiguration +## BlobShare ### Properties -* **offline**: bool (ReadOnly): Offline migration +* **sasUri**: string: SAS URI of Azure Storage Account Container. -## SqlConnectionInformation +## CheckOCIDriverTaskInput ### Properties -* **authentication**: string: Authentication type. -* **dataSource**: string: Data source. -* **encryptConnection**: bool: Whether to encrypt connection or not. -* **password**: string: Password to connect to source SQL. -* **trustServerCertificate**: bool: Whether to trust server certificate or not. -* **userName**: string: User name to connect to source SQL. +* **serverVersion**: string: Version of the source server to check against. Optional. -## SystemData +## CheckOCIDriverTaskOutput ### Properties -* **createdAt**: string -* **createdBy**: string -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string -* **lastModifiedAt**: string -* **lastModifiedBy**: string -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string +* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## DataMigrationServiceProperties -### Properties -* **autoStopDelay**: string: The time delay before the service is auto-stopped when idle. -* **deleteResourcesOnStop**: bool: Whether service resources should be deleted when stopped. (Turned on by default) -* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state -* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service -* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have -* **virtualSubnetId**: string: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined +## CommandProperties +* **Discriminator**: commandType -## ServiceSku -### Properties -* **capacity**: int: The capacity of the SKU, if it supports scaling -* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines -* **name**: string: The unique name of the SKU, such as 'P3' -* **size**: 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 -* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' +### Base Properties +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. +### MongoDbCancelCommand +#### Properties +* **commandType**: 'cancel' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MongoDbFinishCommand +#### Properties +* **commandType**: 'finish' (Required): Command type. +* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command -## ProjectProperties -### Properties -* **azureAuthenticationInfo**: [AzureActiveDirectoryApp](#azureactivedirectoryapp): Azure Active Directory Application -* **creationTime**: string (ReadOnly): UTC Date and time when project was created -* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo -* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state -* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project -* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server -* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project +### MigrateMISyncCompleteCommandProperties +#### Properties +* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. +* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. +* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. -## AzureActiveDirectoryApp -### Properties -* **appKey**: string: Key used to authenticate to the Azure Active Directory Application -* **applicationId**: string: Application ID of the Azure Active Directory Application -* **ignoreAzurePermissions**: bool: Ignore checking azure permissions on the AAD app -* **tenantId**: string: Tenant id of the customer +### MigrateSyncCompleteCommandProperties +#### Properties +* **commandId**: string: Command id +* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. +* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. +* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. + +### MongoDbRestartCommand +#### Properties +* **commandType**: 'restart' (Required): Command type. +* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands -## DatabaseInfo -### Properties -* **sourceDatabaseName**: string (Required): Name of the database ## ConnectionInfo * **Discriminator**: type @@ -280,956 +247,951 @@ * **type**: 'SqlConnectionInfo' (Required): Type of connection info -## TrackedResourceTags +## ConnectToSourceMySqlTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL -## ProjectFileProperties +## ConnectToSourceNonSqlTaskOutput ### Properties -* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. -* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. -* **lastModified**: string (ReadOnly): Modification DateTime. -* **mediaType**: string: File content type. This property can be modified to reflect the file content type. -* **size**: int (ReadOnly): File size. +* **databases**: string[] (ReadOnly): List of databases on the server +* **id**: string (ReadOnly): Result identifier +* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source +* **sourceServerBrandVersion**: string (ReadOnly): Server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## ProjectTaskProperties -* **Discriminator**: taskType +## ConnectToSourceOracleSyncTaskInput +### Properties +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -### Base Properties -* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task -* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. -### ConnectToMongoDbTaskProperties -#### Properties -* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source -* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object -* **taskType**: 'Connect.MongoDb' (Required): Task type. +## ConnectToSourceOracleSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of schemas on source server +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourceMySqlTaskProperties -#### Properties -* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection -* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.MySql' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ConnectToSourceOracleSyncTaskProperties -#### Properties -* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection -* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. +## ConnectToSourcePostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on source server +* **id**: string (ReadOnly): Result identifier +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Version of the source server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ConnectToSourcePostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements -* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. +## ConnectToSourceSqlServerTaskInput +### Properties +* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. +* **collectDatabases**: bool: Flag for whether to collect databases from source server. +* **collectLogins**: bool: Flag for whether to collect logins from source server. +* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. -### ConnectToSourceSqlServerTaskProperties -#### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. +## ConnectToSourceSqlServerTaskOutput +* **Discriminator**: resultType -### ConnectToSourceSqlServerSyncTaskProperties +### Base Properties +* **id**: string (ReadOnly): Result identifier +### ConnectToSourceSqlServerTaskOutputAgentJobLevel #### Properties -* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements -* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **jobCategory**: string (ReadOnly): The type of Agent Job. +* **jobOwner**: string (ReadOnly): The owner of the Agent Job +* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Agent Job name +* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### ConnectToTargetAzureDbForMySqlTaskProperties +### ConnectToSourceSqlServerTaskOutputDatabaseLevel #### Properties -* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements -* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. - -### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements -* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. - -### ConnectToTargetSqlMITaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. -* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. - -### ConnectToTargetSqlMISyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. -* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. - -### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. -* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. - -### ConnectToTargetSqlDbTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. - -### ConnectToTargetSqlDbSyncTaskProperties -#### Properties -* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements -* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. - -### GetTdeCertificatesSqlTaskProperties -#### Properties -* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. -* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. - -### GetUserTablesSqlSyncTaskProperties -#### Properties -* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. - -### GetUserTablesSqlTaskProperties -#### Properties -* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'GetUserTables.Sql' (Required): Task type. - -### GetUserTablesMySqlTaskProperties -#### Properties -* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases -* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesMySql' (Required): Task type. - -### GetUserTablesOracleTaskProperties -#### Properties -* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. -* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesOracle' (Required): Task type. - -### GetUserTablesPostgreSqlTaskProperties -#### Properties -* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. -* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. - -### MigrateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress -* **taskType**: 'Migrate.MongoDb' (Required): Task type. - -### MigrateMySqlAzureDbForMySqlOfflineTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. - -### MigrateMySqlAzureDbForMySqlSyncTaskProperties -#### Properties -* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations -* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. - -### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. - -### MigrateSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations -* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. - -### MigrateSqlServerSqlMITaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **parentTaskId**: string: parent task id -* **taskId**: string: task id -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. - -### MigrateSqlServerSqlMISyncTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels +* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files +* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states +* **name**: string (ReadOnly): Database name +* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level +* **sizeMB**: int (ReadOnly): Size of the file in megabytes -### MigrateSqlServerSqlDbTaskProperties +### ConnectToSourceSqlServerTaskOutputLoginLevel #### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: task id -* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. +* **defaultDatabase**: string (ReadOnly): The default database for the login. +* **isEnabled**: bool (ReadOnly): The state of the login. +* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. +* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object +* **name**: string (ReadOnly): Login name. +* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level -### MigrateSsisTaskProperties +### ConnectToSourceSqlServerTaskOutputTaskLevel #### Properties -* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. -* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Migrate.Ssis' (Required): Task type. +* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable +* **logins**: string (ReadOnly): Source logins as a map from login name to login id. +* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateSchemaSqlServerSqlDbTaskProperties -#### Properties -* **createdOn**: string: DateTime in UTC when the task was created -* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases -* **isCloneable**: bool: whether the task can be cloned or not -* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskId**: string: Task id -* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. -### CheckOCIDriverTaskProperties -#### Properties -* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. -* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Check.OCI' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskInput +### Properties +* **isOfflineMigration**: bool: Flag for whether or not the migration is offline +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -### InstallOCIDriverTaskProperties -#### Properties -* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. -* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Install.OCI' (Required): Task type. +## ConnectToTargetAzureDbForMySqlTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **serverVersion**: string (ReadOnly): Version of the target server +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### UploadOCIDriverTaskProperties -#### Properties -* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. -* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'Service.Upload.OCI' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +### Properties +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ValidateMongoDbTaskProperties -#### Properties -* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed -* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object -* **taskType**: 'Validate.MongoDb' (Required): Task type. +## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties -#### Properties -* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations -* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object -* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +### Properties +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -### ValidateMigrationInputSqlServerSqlMITaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance -* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +### Properties +* **databases**: string[] (ReadOnly): List of databases on target server +* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -### ValidateMigrationInputSqlServerSqlMISyncTaskProperties -#### Properties -* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. -* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +### Properties +* **database**: string +* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem -### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties -#### Properties -* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations -* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. -* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. +## ConnectToTargetSqlDbSyncTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +## ConnectToTargetSqlDbTaskInput +### Properties +* **queryObjectCounts**: bool: Boolean flag indicating whether to query object counts for each database on the target server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## ProjectTaskPropertiesClientData +## ConnectToTargetSqlDbTaskOutput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databases**: string (ReadOnly): Source databases as a map from database name to database id +* **id**: string (ReadOnly): Result identifier +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Version of the target server -## CommandProperties -* **Discriminator**: commandType +## ConnectToTargetSqlMISyncTaskInput +### Properties +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -### Base Properties -* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. -* **state**: 'Accepted' | 'Failed' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the command. This is ignored if submitted. -### MongoDbCancelCommand -#### Properties -* **commandType**: 'cancel' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## ConnectToTargetSqlMISyncTaskOutput +### Properties +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MongoDbFinishCommand -#### Properties -* **commandType**: 'finish' (Required): Command type. -* **input**: [MongoDbFinishCommandInput](#mongodbfinishcommandinput): Describes the input to the 'finish' MongoDB migration command +## ConnectToTargetSqlMITaskInput +### Properties +* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. +* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. -### MigrateMISyncCompleteCommandProperties -#### Properties -* **commandType**: 'Migrate.SqlServer.AzureDbSqlMi.Complete' (Required): Command type. -* **input**: [MigrateMISyncCompleteCommandInput](#migratemisynccompletecommandinput): Input for command that completes online migration for an Azure SQL Database Managed Instance. -* **output**: [MigrateMISyncCompleteCommandOutput](#migratemisynccompletecommandoutput) (ReadOnly): Output for command that completes online migration for an Azure SQL Database Managed Instance. +## ConnectToTargetSqlMITaskOutput +### Properties +* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +* **id**: string (ReadOnly): Result identifier +* **logins**: string[] (ReadOnly): List of logins on the target server. +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -### MigrateSyncCompleteCommandProperties -#### Properties -* **commandId**: string: Command id -* **commandType**: 'Migrate.Sync.Complete.Database' (Required): Command type. -* **input**: [MigrateSyncCompleteCommandInput](#migratesynccompletecommandinput): Input for command that completes sync migration for a database. -* **output**: [MigrateSyncCompleteCommandOutput](#migratesynccompletecommandoutput) (ReadOnly): Output for command that completes sync migration for a database. +## CopyProgressDetails +### Properties +* **copyDuration**: int (ReadOnly): Copy Duration in seconds +* **copyStart**: string (ReadOnly): Copy Start +* **copyThroughput**: int (ReadOnly): Copy throughput in KBps +* **dataRead**: int (ReadOnly): Bytes read +* **dataWritten**: int (ReadOnly): Bytes written +* **parallelCopyType**: string (ReadOnly): Type of parallel copy (Dynamic range, Physical partition, none). +* **rowsCopied**: int (ReadOnly): Rows Copied +* **rowsRead**: int (ReadOnly): Rows read +* **status**: string (ReadOnly): Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). +* **tableName**: string (ReadOnly): Table Name +* **usedParallelCopies**: int (ReadOnly): The degree of parallelization. -### MongoDbRestartCommand -#### Properties -* **commandType**: 'restart' (Required): Command type. -* **input**: [MongoDbCommandInput](#mongodbcommandinput): Describes the input to the 'cancel' and 'restart' MongoDB migration commands +## DatabaseBackupInfo +### Properties +* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. +* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. +* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. +* **databaseName**: string (ReadOnly): Database name. +* **familyCount**: int (ReadOnly): Number of files in the backup set. +* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed +* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. +* **position**: int (ReadOnly): Position of current database backup in the file. +## DatabaseFileInfo +### Properties +* **databaseName**: string: Name of the database +* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types +* **id**: string: Unique identifier for database file +* **logicalName**: string: Logical name of the file +* **physicalFullName**: string: Operating-system full path of the file +* **restoreFullName**: string: Suggested full path of the file for restoring +* **sizeMB**: int: Size of the file in megabytes -## ODataError +## DatabaseInfo ### Properties -* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' -* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error -* **message**: string: The human-readable description of the error +* **sourceDatabaseName**: string (Required): Name of the database -## MongoDbCommandInput +## DatabaseMigrationPropertiesSqlDb ### Properties -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **endedOn**: string (ReadOnly): Database migration end time. +* **kind**: 'SqlDb' | 'SqlMi' | 'SqlVm' | string (Required) +* **migrationFailureError**: [ErrorInfo](#errorinfo) (ReadOnly): Error details +* **migrationOperationId**: string: ID tracking current migration operation. +* **migrationService**: string: Resource Id of the Migration Service. +* **migrationStatus**: string (ReadOnly): Migration status. +* **migrationStatusDetails**: [SqlDbMigrationStatusDetails](#sqldbmigrationstatusdetails) (ReadOnly): Detailed status of current Sql Db migration. +* **offlineConfiguration**: [SqlDbOfflineConfiguration](#sqldbofflineconfiguration) (ReadOnly): Offline configuration +* **provisioningError**: string: Error message for migration provisioning failure, if any. +* **provisioningState**: string (ReadOnly): Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. +* **scope**: string: Resource Id of the target resource (SQL VM or SQL Managed Instance). +* **sourceDatabaseName**: string: Name of the source database. +* **sourceServerName**: string (ReadOnly): Name of the source sql server. +* **sourceSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection +* **startedOn**: string (ReadOnly): Database migration start time. +* **tableList**: string[]: List of tables to copy. +* **targetDatabaseCollation**: string: Database collation to be used for the target database. +* **targetSqlConnection**: [SqlConnectionInformation](#sqlconnectioninformation): Source SQL Connection -## MongoDbFinishCommandInput +## DatabaseTable ### Properties -* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. -* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration +* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not +* **name**: string (ReadOnly): Schema-qualified name of the table -## MigrateMISyncCompleteCommandInput +## DataMigrationServiceProperties ### Properties -* **sourceDatabaseName**: string (Required): Name of managed instance database +* **autoStopDelay**: string: The time delay before the service is auto-stopped when idle. +* **deleteResourcesOnStop**: bool: Whether service resources should be deleted when stopped. (Turned on by default) +* **provisioningState**: 'Accepted' | 'Deleting' | 'Deploying' | 'Failed' | 'FailedToStart' | 'FailedToStop' | 'Starting' | 'Stopped' | 'Stopping' | 'Succeeded' | string (ReadOnly): The resource's provisioning state +* **publicKey**: string: The public key of the service, used to encrypt secrets sent to the service +* **virtualNicId**: string: The ID of the Microsoft.Network/networkInterfaces resource which the service have +* **virtualSubnetId**: string: The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined -## MigrateMISyncCompleteCommandOutput +## ErrorInfo ### Properties -* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution +* **code**: string (ReadOnly): Error code. +* **message**: string (ReadOnly): Error message. -## ReportableException +## FileShare ### Properties -* **actionableMessage**: string: Actionable steps for this exception -* **filePath**: string: The path to the file where exception occurred -* **hResult**: int: Coded numerical value that is assigned to a specific exception -* **lineNumber**: string: The line number where exception occurred -* **message**: string: Error message -* **stackTrace**: string: Stack trace +* **password**: string: Password credential used to connect to the share location. +* **path**: string (Required): The folder path for this share. +* **userName**: string: User name credential to connect to the share location -## MigrateSyncCompleteCommandInput +## GetTdeCertificatesSqlTaskInput ### Properties -* **commitTimeStamp**: string: Time stamp to complete -* **databaseName**: string (Required): Name of database +* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. -## MigrateSyncCompleteCommandOutput +## GetTdeCertificatesSqlTaskOutput ### Properties -* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution -* **id**: string (ReadOnly): Result identifier +* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbConnectionInfo +## GetUserTablesMySqlTaskInput ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **enforceSSL**: bool -* **password**: string: Password credential. -* **port**: int: port for server -* **serverBrandVersion**: string: server brand version -* **serverName**: string: name of the server -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## MongoDbClusterInfo +## GetUserTablesMySqlTaskOutput ### Properties -* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster -* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections -* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source -* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables +* **id**: string (ReadOnly): Result identifier +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbDatabaseInfo +## GetUserTablesOracleTaskInput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables -## MongoDbCollectionInfo +## GetUserTablesOracleTaskOutput ### Properties -* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown -* **databaseName**: string (Required): The name of the database containing the collection -* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. -* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown -* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) -* **isSystemCollection**: bool (Required): Whether the collection is system collection -* **isView**: bool (Required): Whether the collection is a view of another collection -* **name**: string (Required): The unqualified name of the database or collection -* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. -* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key -* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. -* **viewOf**: string: The name of the collection that this is a view of, if IsView is true +* **schemaName**: string (ReadOnly): The schema this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## MongoDbShardKeyInfo +## GetUserTablesPostgreSqlTaskInput ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool (Required): Whether the shard key is unique +* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables -## MongoDbShardKeyField +## GetUserTablesPostgreSqlTaskOutput ### Properties -* **name**: string (Required): The name of the field -* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering +* **databaseName**: string (ReadOnly): The database this result is for +* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task -## ConnectToSourceMySqlTaskInput +## GetUserTablesSqlSyncTaskInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetPlatform**: 'AzureDbForMySQL' | 'SqlServer' | string: An enumeration of possible target types when migrating from MySQL +* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for +* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MySqlConnectionInfo +## GetUserTablesSqlSyncTaskOutput ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverName**: string (Required): Name of the server -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables +* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables +* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToSourceNonSqlTaskOutput +## GetUserTablesSqlTaskInput ### Properties -* **databases**: string[] (ReadOnly): List of databases on the server +* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: string[] (Required): List of database names to collect tables for + +## GetUserTablesSqlTaskOutput +### Properties +* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables * **id**: string (ReadOnly): Result identifier -* **serverProperties**: [ServerProperties](#serverproperties) (ReadOnly): Server properties for MySQL type source -* **sourceServerBrandVersion**: string (ReadOnly): Server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ServerProperties +## InstallOCIDriverTaskInput ### Properties -* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server -* **serverEdition**: string (ReadOnly): Edition of the database server -* **serverName**: string (ReadOnly): Name of the server -* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system -* **serverPlatform**: string (ReadOnly): Name of the server platform -* **serverVersion**: string (ReadOnly): Version of the database server +* **driverPackageName**: string: Name of the uploaded driver package to install. -## ConnectToSourceOracleSyncTaskInput +## InstallOCIDriverTaskOutput ### Properties -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## OracleConnectionInfo +## IntegrationRuntimeMonitoringData ### Properties -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): EZConnect or TNSName connection string. -* **password**: string: Password credential. -* **port**: int: port for server -* **serverName**: string: name of the server -* **serverVersion**: string: server version -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **name**: string (ReadOnly): The name of Integration Runtime. +* **nodes**: [NodeMonitoringData](#nodemonitoringdata)[] (ReadOnly): Integration Runtime node monitoring data. -## ConnectToSourceOracleSyncTaskOutput +## MigrateMISyncCompleteCommandInput ### Properties -* **databases**: string[] (ReadOnly): List of schemas on source server -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **sourceDatabaseName**: string (Required): Name of managed instance database -## ConnectToSourcePostgreSqlSyncTaskInput +## MigrateMISyncCompleteCommandOutput ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **errors**: [ReportableException](#reportableexception)[]: List of errors that happened during the command execution -## PostgreSqlConnectionInfo +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **databaseName**: string: Name of the database -* **dataSource**: string: Data source -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **port**: int (Required): Port for Server -* **serverBrandVersion**: string: server brand version -* **serverName**: string (Required): Name of the server -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +* **name**: string: Name of the database +* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## ConnectToSourcePostgreSqlSyncTaskOutput +## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap ### Properties -* **databases**: string[] (ReadOnly): List of databases on source server -* **id**: string (ReadOnly): Result identifier -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Version of the source server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceSqlServerTaskInput +## MigrateMySqlAzureDbForMySqlOfflineTaskInput ### Properties -* **checkPermissionsGroup**: 'Default' | 'MigrationFromMySQLToAzureDBForMySQL' | 'MigrationFromSqlServerToAzureDB' | 'MigrationFromSqlServerToAzureMI' | 'MigrationFromSqlServerToAzureVM': Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing. -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from source server. -* **collectDatabases**: bool: Flag for whether to collect databases from source server. -* **collectLogins**: bool: Flag for whether to collect logins from source server. -* **collectTdeCertificateInfo**: bool: Flag for whether to collect TDE Certificate names from source server. * **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the source server. +* **makeSourceServerReadOnly**: bool: Setting to set the source server read only +* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **startedOn**: string: Parameter to specify when the migration started +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -## SqlConnectionInfo +## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings ### Properties -* **additionalSettings**: string: Additional connection settings -* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting -* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber -* **encryptConnection**: bool: Whether to encrypt the connection -* **password**: string: Password credential. -* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types -* **port**: int: Port for Server -* **resourceId**: string: Represents the ID of an HTTP resource represented by an Azure resource provider. -* **serverBrandVersion**: string: server brand version -* **serverName**: string: name of the server -* **serverVersion**: string: server version -* **trustServerCertificate**: bool: Whether to trust the server certificate -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### Additional Properties +* **Additional Properties Type**: string -## ConnectToSourceSqlServerTaskOutput +## MigrateMySqlAzureDbForMySqlOfflineTaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### ConnectToSourceSqlServerTaskOutputAgentJobLevel -#### Properties -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **jobCategory**: string (ReadOnly): The type of Agent Job. -* **jobOwner**: string (ReadOnly): The owner of the Agent Job -* **lastExecutedOn**: string (ReadOnly): UTC Date and time when the Agent Job was last executed. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Agent Job name -* **resultType**: 'AgentJobLevelOutput' (Required): Type of result - database level or task level -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors - -### ConnectToSourceSqlServerTaskOutputDatabaseLevel +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel #### Properties -* **compatibilityLevel**: 'CompatLevel100' | 'CompatLevel110' | 'CompatLevel120' | 'CompatLevel130' | 'CompatLevel140' | 'CompatLevel80' | 'CompatLevel90' | string (ReadOnly): An enumeration of SQL Server database compatibility levels -* **databaseFiles**: [DatabaseFileInfo](#databasefileinfo)[] (ReadOnly): The list of database files -* **databaseState**: 'Copying' | 'Emergency' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Suspect' | string (ReadOnly): An enumeration of SQL Server Database states -* **name**: string (ReadOnly): Database name -* **resultType**: 'DatabaseLevelOutput' (Required): Type of result - database level or task level -* **sizeMB**: int (ReadOnly): Size of the file in megabytes +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **errorCount**: int (ReadOnly): Number of database/object errors. +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **numberOfObjects**: int (ReadOnly): Number of objects +* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects +* **objectSummary**: string (ReadOnly): Summary of object results in the migration +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -### ConnectToSourceSqlServerTaskOutputLoginLevel +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError #### Properties -* **defaultDatabase**: string (ReadOnly): The default database for the login. -* **isEnabled**: bool (ReadOnly): The state of the login. -* **loginType**: 'AsymmetricKey' | 'Certificate' | 'ExternalGroup' | 'ExternalUser' | 'SqlLogin' | 'WindowsGroup' | 'WindowsUser' | string (ReadOnly): Enum mapping of SMO LoginType. -* **migrationEligibility**: [MigrationEligibilityInfo](#migrationeligibilityinfo) (ReadOnly): Information about migration eligibility of a server object -* **name**: string (ReadOnly): Login name. -* **resultType**: 'LoginLevelOutput' (Required): Type of result - database level or task level +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### ConnectToSourceSqlServerTaskOutputTaskLevel +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel #### Properties -* **agentJobs**: string (ReadOnly): Source agent jobs as a map from agent job name to id. -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **databaseTdeCertificateMapping**: string (ReadOnly): Mapping from database name to TDE certificate name, if applicable -* **logins**: string (ReadOnly): Source logins as a map from login name to login id. -* **resultType**: 'TaskLevelOutput' (Required): Type of result - database level or task level +* **databases**: string: Selected databases as a map from database name to database id +* **databaseSummary**: string (ReadOnly): Summary of database results in the migration +* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **message**: string (ReadOnly): Migration progress message +* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **resultType**: 'MigrationLevelOutput' (Required): Result type * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **statusMessage**: string (ReadOnly): Migration status message +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item +* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items +* **itemsCount**: int (ReadOnly): Number of items +* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated +* **objectName**: string (ReadOnly): Name of the item +* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item +* **resultType**: 'TableLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **statusMessage**: string (ReadOnly): Status message -## MigrationEligibilityInfo -### Properties -* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. -* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. -## DatabaseFileInfo +## MigrateMySqlAzureDbForMySqlSyncDatabaseInput ### Properties -* **databaseName**: string: Name of the database -* **fileType**: 'Filestream' | 'Fulltext' | 'Log' | 'NotSupported' | 'Rows' | string: An enumeration of SQL Server database file types -* **id**: string: Unique identifier for database file -* **logicalName**: string: Logical name of the file -* **physicalFullName**: string: Operating-system full path of the file -* **restoreFullName**: string: Suggested full path of the file for restoring -* **sizeMB**: int: Size of the file in megabytes +* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToTargetAzureDbForMySqlTaskInput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting ### Properties -* **isOfflineMigration**: bool: Flag for whether or not the migration is offline -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForMySqlTaskOutput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **serverVersion**: string (ReadOnly): Version of the target server -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskInput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap ### Properties -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput +## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlMITaskInput +## MigrateMySqlAzureDbForMySqlSyncTaskInput ### Properties -* **collectAgentJobs**: bool: Flag for whether to collect agent jobs from target SQL MI server. -* **collectLogins**: bool: Flag for whether to collect logins from target SQL MI server. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validateSsisCatalogOnly**: bool: Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. +* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -## ConnectToTargetSqlMITaskOutput -### Properties -* **agentJobs**: string[] (ReadOnly): List of agent jobs on the target server. +## MigrateMySqlAzureDbForMySqlSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties * **id**: string (ReadOnly): Result identifier -* **logins**: string[] (ReadOnly): List of logins on the target server. -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## ConnectToTargetSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## MiSqlConnectionInfo -### Properties -* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance -* **password**: string: Password credential. -* **type**: string (Required): Type of connection info -* **userName**: string: User name +### MigrateMySqlAzureDbForMySqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## ConnectToTargetSqlMISyncTaskOutput -### Properties -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput ### Properties -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower +* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the migration pipeline +* **schemaName**: string: Name of the source schema +* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **databases**: string[] (ReadOnly): List of databases on target server -* **databaseSchemaMap**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem](#connecttotargetoracleazuredbforpostgresqlsynctaskoutputdatabaseschemamapitem)[]: Mapping of schemas per database -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapItem +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **database**: string -* **schemas**: string[]: Array of ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputDatabaseSchemaMapPropertiesItemsItem +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlDbTaskInput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap ### Properties -* **queryObjectCounts**: bool: Boolean flag indicating whether to query object counts for each database on the target server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlDbTaskOutput +## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **databases**: string (ReadOnly): Source databases as a map from database name to database id -* **id**: string (ReadOnly): Result identifier -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Version of the target server +### Additional Properties +* **Additional Properties Type**: string -## ConnectToTargetSqlDbSyncTaskInput +## MigrateOracleAzureDbPostgreSqlSyncTaskInput ### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## GetTdeCertificatesSqlTaskInput -### Properties -* **backupFileShare**: [FileShare](#fileshare) (Required): File share information with Path, Username, and Password. -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **selectedCertificates**: [SelectedCertificateInput](#selectedcertificateinput)[] (Required): List containing certificate names and corresponding password to use for encrypting the exported certificate. +## MigrateOracleAzureDbPostgreSqlSyncTaskOutput +* **Discriminator**: resultType -## FileShare -### Properties -* **password**: string: Password credential used to connect to the share location. -* **path**: string (Required): The folder path for this share. -* **userName**: string: User name credential to connect to the share location +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## SelectedCertificateInput -### Properties -* **certificateName**: string (Required): Name of certificate to be exported. -* **password**: string (Required): Password to use for encrypting the exported certificate. +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## GetTdeCertificatesSqlTaskOutput -### Properties -* **base64EncodedCertificates**: string (ReadOnly): Mapping from certificate name to base 64 encoded format. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## GetUserTablesSqlSyncTaskInput -### Properties -* **selectedSourceDatabases**: string[] (Required): List of source database names to collect tables for -* **selectedTargetDatabases**: string[] (Required): List of target database names to collect tables for -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## GetUserTablesSqlSyncTaskOutput -### Properties -* **databasesToSourceTables**: string (ReadOnly): Mapping from database name to list of source tables -* **databasesToTargetTables**: string (ReadOnly): Mapping from database name to list of target tables -* **tableValidationErrors**: string (ReadOnly): Mapping from database name to list of validation errors -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## GetUserTablesSqlTaskInput -### Properties -* **connectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: string[] (Required): List of database names to collect tables for -## GetUserTablesSqlTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput ### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables * **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of the database +* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration +* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## GetUserTablesMySqlTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting ### Properties -* **connectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **selectedDatabases**: string[] (Required): List of database names to collect tables for +### Additional Properties +* **Additional Properties Type**: any -## GetUserTablesMySqlTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting ### Properties -* **databasesToTables**: string (ReadOnly): Mapping from database name to list of tables -* **id**: string (ReadOnly): Result identifier -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +### Additional Properties +* **Additional Properties Type**: string -## GetUserTablesOracleTaskInput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting ### Properties -* **connectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **selectedSchemas**: string[] (Required): List of Oracle schemas for which to collect tables +### Additional Properties +* **Additional Properties Type**: string -## GetUserTablesOracleTaskOutput +## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput ### Properties -* **schemaName**: string (ReadOnly): The schema this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this schema -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +* **name**: string: Name of the table to migrate -## DatabaseTable +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput ### Properties -* **hasRows**: bool (ReadOnly): Indicates whether table is empty or not -* **name**: string (ReadOnly): Schema-qualified name of the table +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **startedOn**: string (ReadOnly): Migration start time +* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -## GetUserTablesPostgreSqlTaskInput -### Properties -* **connectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **selectedDatabases**: string[] (Required): List of PostgreSQL databases for which to collect tables +## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +* **Discriminator**: resultType -## GetUserTablesPostgreSqlTaskOutput -### Properties -* **databaseName**: string (ReadOnly): The database this result is for -* **tables**: [DatabaseTable](#databasetable)[] (ReadOnly): List of valid tables found for this database -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors associated with the task +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type -## MongoDbMigrationSettings -### Properties -* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. -* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. -* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. -* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source -* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time -## MongoDbMigrationSettingsDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events +* **resultType**: 'ErrorOutput' (Required): Result type -## MongoDbDatabaseSettings -### Properties -* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int: Number of databases to include +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. +* **targetServer**: string (ReadOnly): Target server name +* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type +* **targetServerVersion**: string (ReadOnly): Target server version -## MongoDbDatabaseSettingsCollections -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## MongoDbCollectionSettings -### Properties -* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. -* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key -* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. -## MongoDbShardKeySetting +## MigrateSchemaSqlServerSqlDbDatabaseInput ### Properties -* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key -* **isUnique**: bool: Whether the shard key is unique +* **id**: string: Id of the source database +* **name**: string: Name of source database +* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target +* **targetDatabaseName**: string: Name of target database -## MongoDbThrottlingSettings +## MigrateSchemaSqlServerSqlDbTaskInput ### Properties -* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel -* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 -* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Migration start time +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MongoDbProgress +## MigrateSchemaSqlServerSqlDbTaskOutput * **Discriminator**: resultType ### Base Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -### MongoDbCollectionProgress +* **id**: string (ReadOnly): Result identifier +### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel #### Properties -* **resultType**: 'Collection' (Required): The type of progress object +* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database +* **databaseName**: string (ReadOnly): The name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database +* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database +* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database +* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -### MongoDbDatabaseProgress +### MigrateSchemaSqlTaskOutputError #### Properties -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **resultType**: 'Database' (Required): The type of progress object +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -### MongoDbMigrationProgress +### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel #### Properties -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **resultType**: 'Migration' (Required): The type of progress object +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version +### MigrateSchemaSqlServerSqlDbTaskOutputError +#### Properties +* **commandText**: string (ReadOnly): Schema command which failed +* **errorText**: string (ReadOnly): Reason of failure +* **resultType**: 'SchemaErrorOutput' (Required): Result type -## MongoDbProgressErrors -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MongoDbError +## MigrateSqlServerSqlDbDatabaseInput ### Properties -* **code**: string: The non-localized, machine-readable code that describes the error or warning -* **count**: int: The number of times the error or warning has occurred -* **message**: string: The localized, human-readable message that describes the error or warning -* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning +* **id**: string: id of the database +* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration +* **name**: string: Name of the database +* **schemaSetting**: any: Any object +* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## MongoDbDatabaseProgressCollections +## MigrateSqlServerSqlDbDatabaseInputTableMap ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +* **Additional Properties Type**: string -## MongoDbCollectionProgress +## MigrateSqlServerSqlDbSyncDatabaseInput ### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +* **id**: string: Unique identifier for database +* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior +* **name**: string: Name of database +* **schemaName**: string: Schema name to be migrated +* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior +* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables +* **targetDatabaseName**: string: Target database name +* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior -## MongoDbProgressErrors +## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **Additional Properties Type**: string -## MongoDbMigrationProgressDatabases +## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) - -## MongoDbDatabaseProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +* **Additional Properties Type**: string -## MongoDbDatabaseProgressCollections +## MigrateSqlServerSqlDbSyncDatabaseInputTableMap ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) +* **Additional Properties Type**: string -## MongoDbProgressErrors +## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting ### Properties ### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **Additional Properties Type**: string -## MigrateMySqlAzureDbForMySqlOfflineTaskInput +## MigrateSqlServerSqlDbSyncTaskInput ### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **makeSourceServerReadOnly**: bool: Setting to set the source server read only -* **optionalAgentSettings**: [MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings](#migratemysqlazuredbformysqlofflinetaskinputoptionalagentsettings): Optional parameters for fine tuning the data transfer rate during migration -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInput](#migratemysqlazuredbformysqlofflinedatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **startedOn**: string: Parameter to specify when the migration started -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## MigrateMySqlAzureDbForMySqlOfflineTaskInputOptionalAgentSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string +## MigrateSqlServerSqlDbSyncTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError +#### Properties +* **errorMessage**: string: Error message +* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. +* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel +#### Properties +* **appliedChanges**: int (ReadOnly): Number of applied changes +* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes +* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates +* **databaseName**: string (ReadOnly): Name of the database +* **endedOn**: string (ReadOnly): Migration end time +* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load +* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load +* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load +* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load +* **incomingChanges**: int (ReadOnly): Number of incoming changes +* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed +* **latency**: int (ReadOnly): CDC apply latency +* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time + +### MigrateSqlServerSqlDbSyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type + +### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServer**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **targetServer**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSqlServerSqlDbSyncTaskOutputTableLevel +#### Properties +* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes +* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts +* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates +* **databaseName**: string (ReadOnly): Name of the database +* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred +* **fullLoadEndedOn**: string (ReadOnly): Full load end time +* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load +* **fullLoadStartedOn**: string (ReadOnly): Full load start time +* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load +* **lastModifiedTime**: string (ReadOnly): Last modified time on target +* **resultType**: 'TableLevelOutput' (Required): Result type +* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. +* **tableName**: string (ReadOnly): Name of the table +* **totalChangesApplied**: int (ReadOnly): Total number of applied changes -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInput -### Properties -* **name**: string: Name of the database -* **tableMap**: [MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap](#migratemysqlazuredbformysqlofflinedatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -## MigrateMySqlAzureDbForMySqlOfflineDatabaseInputTableMap +## MigrateSqlServerSqlDbTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Date and time relative to UTC when the migration was started on +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration -## MigrateMySqlAzureDbForMySqlOfflineTaskOutput +## MigrateSqlServerSqlDbTaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevel +### MigrateSqlServerSqlDbTaskOutputDatabaseLevel #### Properties -* **databaseName**: string (ReadOnly): Name of the database +* **databaseName**: string (ReadOnly): Name of the item * **endedOn**: string (ReadOnly): Migration end time * **errorCount**: int (ReadOnly): Number of database/object errors. * **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item * **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated * **message**: string (ReadOnly): Migration progress message * **numberOfObjects**: int (ReadOnly): Number of objects * **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects @@ -1241,21 +1203,25 @@ * **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration * **statusMessage**: string (ReadOnly): Status message -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputError +### MigrateSqlServerSqlDbTaskOutputError #### Properties * **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions * **resultType**: 'ErrorOutput' (Required): Result type -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevel +### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult #### Properties -* **databases**: string: Selected databases as a map from database name to database id +* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputMigrationLevel +#### Properties +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id * **databaseSummary**: string (ReadOnly): Summary of database results in the migration * **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. * **endedOn**: string (ReadOnly): Migration end time * **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated * **message**: string (ReadOnly): Migration progress message * **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. +* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result * **resultType**: 'MigrationLevelOutput' (Required): Result type * **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version @@ -1265,13 +1231,16 @@ * **targetServerBrandVersion**: string (ReadOnly): Target server brand version * **targetServerVersion**: string (ReadOnly): Target server version -### MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevel +### MigrateSqlServerSqlDbTaskOutputValidationResult +#### Properties +* **resultType**: 'MigrationValidationOutput' (Required): Result type + +### MigrateSqlServerSqlDbTaskOutputTableLevel #### Properties * **endedOn**: string (ReadOnly): Migration end time * **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item * **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items * **itemsCount**: int (ReadOnly): Number of items -* **lastStorageUpdate**: string (ReadOnly): Last time the storage was updated * **objectName**: string (ReadOnly): Name of the item * **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item * **resultType**: 'TableLevelOutput' (Required): Result type @@ -1280,765 +1249,841 @@ * **statusMessage**: string (ReadOnly): Status message -## MigrationReportResult +## MigrateSqlServerSqlMIDatabaseInput ### Properties -* **id**: string: Migration validation result identifier -* **reportUrl**: string: The url of the report. +* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **id**: string: id of the database +* **name**: string (Required): Name of the database +* **restoreDatabaseName**: string (Required): Name of the database at destination -## MigrateMySqlAzureDbForMySqlSyncTaskInput +## MigrateSqlServerSqlMISyncTaskInput ### Properties -* **selectedDatabases**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInput](#migratemysqlazuredbformysqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server -* **targetConnectionInfo**: [MySqlConnectionInfo](#mysqlconnectioninfo) (Required): Information for connecting to MySQL server +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **numberOfParallelDatabaseMigrations**: int: Number of database migrations to start in parallel +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## MigrateMySqlAzureDbForMySqlSyncDatabaseInput -### Properties -* **migrationSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting](#migratemysqlazuredbformysqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **sourceSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting](#migratemysqlazuredbformysqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap](#migratemysqlazuredbformysqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting](#migratemysqlazuredbformysqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +## MigrateSqlServerSqlMISyncTaskOutput +* **Discriminator**: resultType -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputMigrationSetting -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +#### Properties +* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) +* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to +* **endedOn**: string (ReadOnly): Database migration end time +* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not +* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set +* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. +* **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sourceDatabaseName**: string (ReadOnly): Name of the database +* **startedOn**: string (ReadOnly): Database migration start time -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputSourceSetting -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSqlServerSqlMISyncTaskOutputError +#### Properties +* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions +* **resultType**: 'ErrorOutput' (Required): Result type -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +#### Properties +* **databaseCount**: int (ReadOnly): Count of databases +* **databaseErrorCount**: int (ReadOnly): Number of database level errors +* **endedOn**: string (ReadOnly): Migration end time +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerName**: string (ReadOnly): Source server name +* **sourceServerVersion**: string (ReadOnly): Source server version +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerName**: string (ReadOnly): Target server name +* **targetServerVersion**: string (ReadOnly): Target server version -## MigrateMySqlAzureDbForMySqlSyncDatabaseInputTargetSetting + +## MigrateSqlServerSqlMITaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected +* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes +* **encryptedKeyForSecureFields**: string: encrypted key for secure fields +* **selectedAgentJobs**: string[]: Agent Jobs to migrate. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **selectedLogins**: string[]: Logins to migrate. +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **startedOn**: string: Date and time relative to UTC when the migration was started on +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -## MigrateMySqlAzureDbForMySqlSyncTaskOutput +## MigrateSqlServerSqlMITaskOutput * **Discriminator**: resultType ### Base Properties * **id**: string (ReadOnly): Result identifier -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError +### MigrateSqlServerSqlMITaskOutputAgentJobLevel #### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job +* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. +* **message**: string (ReadOnly): Migration progress message +* **name**: string (ReadOnly): Agent Job name. +* **resultType**: 'AgentJobLevelOutput' (Required): Result type +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -### MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel +### MigrateSqlServerSqlMITaskOutputDatabaseLevel #### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates * **databaseName**: string (ReadOnly): Name of the database * **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **message**: string (ReadOnly): Migration progress message * **resultType**: 'DatabaseLevelOutput' (Required): Result type +* **sizeMB**: int (ReadOnly): Size of the database in megabytes +* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration * **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -### MigrateMySqlAzureDbForMySqlSyncTaskOutputError +### MigrateSqlServerSqlMITaskOutputError #### Properties * **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions * **resultType**: 'ErrorOutput' (Required): Result type -### MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel +### MigrateSqlServerSqlMITaskOutputLoginLevel +#### Properties +* **endedOn**: string (ReadOnly): Login migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login +* **loginName**: string (ReadOnly): Login name. +* **message**: string (ReadOnly): Login migration progress message +* **resultType**: 'LoginLevelOutput' (Required): Result type +* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. +* **startedOn**: string (ReadOnly): Login migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + +### MigrateSqlServerSqlMITaskOutputMigrationLevel #### Properties +* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id +* **databases**: string (ReadOnly): Selected databases as a map from database name to database id * **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **logins**: string (ReadOnly): Selected logins as a map from name to id +* **message**: string (ReadOnly): Migration progress message +* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. * **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name +* **serverRoleResults**: string (ReadOnly): Map of server role migration results. +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version * **sourceServerVersion**: string (ReadOnly): Source server version * **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version * **targetServerVersion**: string (ReadOnly): Target server version -### MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel + +## MigrateSsisTaskInput +### Properties +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. +* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server + +## MigrateSsisTaskOutput +* **Discriminator**: resultType + +### Base Properties +* **id**: string (ReadOnly): Result identifier +### MigrateSsisTaskOutputMigrationLevel #### Properties -* **cdcDeleteCounter**: string (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: string (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: string (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. +* **message**: string (ReadOnly): Migration progress message +* **resultType**: 'MigrationLevelOutput' (Required): Result type +* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version +* **sourceServerVersion**: string (ReadOnly): Source server version +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration +* **targetServerBrandVersion**: string (ReadOnly): Target server brand version +* **targetServerVersion**: string (ReadOnly): Target server version + +### MigrateSsisTaskOutputProjectLevel +#### Properties +* **endedOn**: string (ReadOnly): Migration end time +* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings +* **folderName**: string (ReadOnly): Name of the folder +* **message**: string (ReadOnly): Migration progress message +* **projectName**: string (ReadOnly): Name of the project +* **resultType**: 'SsisProjectLevelOutput' (Required): Result type +* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration +* **startedOn**: string (ReadOnly): Migration start time +* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration + + +## MigrateSyncCompleteCommandInput +### Properties +* **commitTimeStamp**: string: Time stamp to complete +* **databaseName**: string (Required): Name of database + +## MigrateSyncCompleteCommandOutput +### Properties +* **errors**: [ReportableException](#reportableexception)[] (ReadOnly): List of errors that happened during the command execution +* **id**: string (ReadOnly): Result identifier +## MigrationEligibilityInfo +### Properties +* **isEligibleForMigration**: bool (ReadOnly): Whether object is eligible for migration or not. +* **validationMessages**: string[] (ReadOnly): Information about eligibility failure for the server object. -## SyncMigrationDatabaseErrorEvent +## MigrationReportResult ### Properties -* **eventText**: string (ReadOnly): Event text. -* **eventTypeString**: string (ReadOnly): Event type. -* **timestampString**: string (ReadOnly): String value of timestamp. +* **id**: string: Migration validation result identifier +* **reportUrl**: string: The url of the report. -## MigrateOracleAzureDbPostgreSqlSyncTaskInput +## MigrationValidationDatabaseSummaryResult ### Properties -* **selectedDatabases**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInput](#migrateoracleazuredbpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [OracleConnectionInfo](#oracleconnectioninfo) (Required): Information for connecting to Oracle server -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +* **endedOn**: string (ReadOnly): Validation end time +* **id**: string (ReadOnly): Result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **sourceDatabaseName**: string (ReadOnly): Name of the source database +* **startedOn**: string (ReadOnly): Validation start time +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **targetDatabaseName**: string (ReadOnly): Name of the target database -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInput +## MigrationValidationOptions ### Properties -* **caseManipulation**: string: How to handle object name casing: either Preserve or ToLower -* **migrationSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the migration pipeline -* **schemaName**: string: Name of the source schema -* **sourceSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap](#migrateoracleazuredbpostgresqlsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting](#migrateoracleazuredbpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . +* **enableQueryAnalysisValidation**: bool: 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. +* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputMigrationSetting +## MigrationValidationResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Migration validation result identifier +* **migrationId**: string (ReadOnly): Migration Identifier +* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation +* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputSourceSetting +## MigrationValidationResultSummaryResults ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTableMap +## MiSqlConnectionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **managedInstanceResourceId**: string (Required): Resource id for Azure SQL database Managed instance +* **password**: string: Password credential. +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateOracleAzureDbPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbClusterInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **databases**: [MongoDbDatabaseInfo](#mongodbdatabaseinfo)[] (Required): A list of non-system databases in the cluster +* **supportsSharding**: bool (Required): Whether the cluster supports sharded collections +* **type**: 'BlobContainer' | 'CosmosDb' | 'MongoDb' | string (Required): The type of data source +* **version**: string (Required): The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. -## MigrateOracleAzureDbPostgreSqlSyncTaskOutput -* **Discriminator**: resultType +## MongoDbCollectionInfo +### Properties +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **databaseName**: string (Required): The name of the database containing the collection +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **isCapped**: bool (Required): Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) +* **isSystemCollection**: bool (Required): Whether the collection is system collection +* **isView**: bool (Required): Whether the collection is a view of another collection +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **shardKey**: [MongoDbShardKeyInfo](#mongodbshardkeyinfo): Describes a MongoDB shard key +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. +* **viewOf**: string: The name of the collection that this is a view of, if IsView is true -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +## MongoDbCollectionProgress +### Properties +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +## MongoDbCollectionSettings +### Properties +* **canDelete**: bool: Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. +* **shardKey**: [MongoDbShardKeySetting](#mongodbshardkeysetting): Describes a MongoDB shard key +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## MongoDbCommandInput +### Properties +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +## MongoDbConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **connectionString**: string (Required): A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **enforceSSL**: bool +* **password**: string: Password credential. +* **port**: int: port for server +* **serverBrandVersion**: string: server brand version +* **serverName**: string: name of the server +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## MongoDbDatabaseInfo +### Properties +* **averageDocumentSize**: int (Required): The average document size, or -1 if the average size is unknown +* **collections**: [MongoDbCollectionInfo](#mongodbcollectioninfo)[] (Required): A list of supported collections in a MongoDB database +* **dataSize**: int (Required): The estimated total data size, in bytes, or -1 if the size is unknown. +* **documentCount**: int (Required): The estimated total number of documents, or -1 if the document count is unknown +* **name**: string (Required): The unqualified name of the database or collection +* **qualifiedName**: string (Required): The qualified name of the database or collection. For a collection, this is the database-qualified name. +* **supportsSharding**: bool (Required): Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. + +## MongoDbDatabaseProgress +### Properties +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +## MongoDbDatabaseProgressCollections +### Properties +### Additional Properties +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput +## MongoDbDatabaseProgressCollections ### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server -* **startedOn**: string (ReadOnly): Migration start time -* **targetConnectionInfo**: [PostgreSqlConnectionInfo](#postgresqlconnectioninfo) (Required): Information for connecting to PostgreSQL server +### Additional Properties +* **Additional Properties Type**: [MongoDbCollectionProgress](#mongodbcollectionprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput +## MongoDbDatabaseSettings ### Properties -* **id**: string (ReadOnly): Result identifier -* **migrationSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of the database -* **selectedTables**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput](#migratepostgresqlazuredbforpostgresqlsyncdatabasetableinput)[]: Tables selected for migration -* **sourceSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. -* **targetSetting**: [MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting](#migratepostgresqlazuredbforpostgresqlsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +* **collections**: [MongoDbDatabaseSettingsCollections](#mongodbdatabasesettingscollections) (Required): The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. +* **targetRUs**: int: The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. + +## MongoDbDatabaseSettingsCollections +### Properties +### Additional Properties +* **Additional Properties Type**: [MongoDbCollectionSettings](#mongodbcollectionsettings) + +## MongoDbError +### Properties +* **code**: string: The non-localized, machine-readable code that describes the error or warning +* **count**: int: The number of times the error or warning has occurred +* **message**: string: The localized, human-readable message that describes the error or warning +* **type**: 'Error' | 'ValidationError' | 'Warning' | string: The type of error or warning + +## MongoDbFinishCommandInput +### Properties +* **immediate**: bool (Required): If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication. +* **objectName**: string: The qualified name of a database or collection to act upon, or null to act upon the entire migration + +## MongoDbMigrationProgress +### Properties +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputMigrationSetting +## MongoDbMigrationProgressDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput +## MongoDbMigrationProgressDatabases ### Properties -* **name**: string: Name of the table to migrate +### Additional Properties +* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputSourceSetting +## MongoDbMigrationSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **boostRUs**: int: The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. +* **databases**: [MongoDbMigrationSettingsDatabases](#mongodbmigrationsettingsdatabases) (Required): The databases on the source cluster to migrate to the target. The keys are the names of the databases. +* **replication**: 'Continuous' | 'Disabled' | 'OneTime' | string: Describes how changes will be replicated from the source to the target. The default is OneTime. +* **source**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **target**: [MongoDbConnectionInfo](#mongodbconnectioninfo) (Required): Describes a connection to a MongoDB data source +* **throttling**: [MongoDbThrottlingSettings](#mongodbthrottlingsettings): Specifies resource limits for the migration -## MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputTargetSetting +## MongoDbMigrationSettingsDatabases ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbDatabaseSettings](#mongodbdatabasesettings) -## MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput +## MongoDbProgress * **Discriminator**: resultType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time - -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError +* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage +* **documentsCopied**: int (Required): The number of documents copied during the Copying stage +* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) +* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. +* **eventsPending**: int (Required): The number of oplog events awaiting replay +* **eventsReplayed**: int (Required): The number of oplog events replayed so far +* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet +* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet +* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. +* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. +* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) +* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown +* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown +### MongoDbCollectionProgress #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events -* **resultType**: 'ErrorOutput' (Required): Result type +* **resultType**: 'Collection' (Required): The type of progress object -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel +### MongoDbDatabaseProgress #### Properties -* **databaseCount**: int: Number of databases to include -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerType**: 'Access' | 'DB2' | 'MongoDB' | 'MySQL' | 'MySQLRDS' | 'Oracle' | 'PostgreSQL' | 'PostgreSQLRDS' | 'SQL' | 'SQLRDS' | 'Sybase' | string (ReadOnly): An enumeration of source type -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'ACTION_REQUIRED' | 'COMPLETE' | 'FAILED' | 'PENDING' | 'UNDEFINED' | 'VALIDATING' | string (ReadOnly): Wrapper for replicate reported migration states. -* **targetServer**: string (ReadOnly): Target server name -* **targetServerType**: 'AzureDBForMySql' | 'AzureDBForPostgresSQL' | 'MongoDB' | 'SQLDB' | 'SQLDW' | 'SQLMI' | 'SQLServer' | string (ReadOnly): An enumeration of target type -* **targetServerVersion**: string (ReadOnly): Target server version +* **collections**: [MongoDbDatabaseProgressCollections](#mongodbdatabaseprogresscollections): The progress of the collections in the database. The keys are the unqualified names of the collections +* **resultType**: 'Database' (Required): The type of progress object -### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel +### MongoDbMigrationProgress #### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases +* **resultType**: 'Migration' (Required): The type of progress object -## MigrateSqlServerSqlDbSyncTaskInput +## MongoDbProgressErrors ### Properties -* **selectedDatabases**: [MigrateSqlServerSqlDbSyncDatabaseInput](#migratesqlserversqldbsyncdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInput +## MongoDbProgressErrors ### Properties -* **id**: string: Unique identifier for database -* **migrationSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting](#migratesqlserversqldbsyncdatabaseinputmigrationsetting): Migration settings which tune the migration behavior -* **name**: string: Name of database -* **schemaName**: string: Schema name to be migrated -* **sourceSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting](#migratesqlserversqldbsyncdatabaseinputsourcesetting): Source settings to tune source endpoint migration behavior -* **tableMap**: [MigrateSqlServerSqlDbSyncDatabaseInputTableMap](#migratesqlserversqldbsyncdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Target database name -* **targetSetting**: [MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting](#migratesqlserversqldbsyncdatabaseinputtargetsetting): Target settings to tune target endpoint migration behavior +### Additional Properties +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputMigrationSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputSourceSetting +## MongoDbProgressErrors ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [MongoDbError](#mongodberror) -## MigrateSqlServerSqlDbSyncDatabaseInputTableMap +## MongoDbShardKeyField ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of the field +* **order**: 'Forward' | 'Hashed' | 'Reverse' | string (Required): The field ordering -## MigrateSqlServerSqlDbSyncDatabaseInputTargetSetting +## MongoDbShardKeyInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool (Required): Whether the shard key is unique -## MigrationValidationOptions +## MongoDbShardKeySetting ### Properties -* **enableDataIntegrityValidation**: bool: Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . -* **enableQueryAnalysisValidation**: bool: 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. -* **enableSchemaValidation**: bool: Allows to compare the schema information between source and target. +* **fields**: [MongoDbShardKeyField](#mongodbshardkeyfield)[] (Required): The fields within the shard key +* **isUnique**: bool: Whether the shard key is unique -## MigrateSqlServerSqlDbSyncTaskOutput -* **Discriminator**: resultType +## MongoDbThrottlingSettings +### Properties +* **maxParallelism**: int: The maximum number of work items (e.g. collection copies) that will be processed in parallel +* **minFreeCpu**: int: The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 +* **minFreeMemoryMb**: int: The number of megabytes of RAM that the migrator will try to avoid using -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseError -#### Properties -* **errorMessage**: string: Error message -* **events**: [SyncMigrationDatabaseErrorEvent](#syncmigrationdatabaseerrorevent)[]: List of error events. -* **resultType**: 'DatabaseLevelErrorOutput' (Required): Result type +## MySqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverName**: string (Required): Name of the server +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel -#### Properties -* **appliedChanges**: int (ReadOnly): Number of applied changes -* **cdcDeleteCounter**: int (ReadOnly): Number of cdc deletes -* **cdcInsertCounter**: int (ReadOnly): Number of cdc inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of cdc updates -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fullLoadCompletedTables**: int (ReadOnly): Number of tables completed in full load -* **fullLoadErroredTables**: int (ReadOnly): Number of tables errored in full load -* **fullLoadLoadingTables**: int (ReadOnly): Number of tables loading in full load -* **fullLoadQueuedTables**: int (ReadOnly): Number of tables queued in full load -* **incomingChanges**: int (ReadOnly): Number of incoming changes -* **initializationCompleted**: bool (ReadOnly): Indicates if initial load (full load) has been completed -* **latency**: int (ReadOnly): CDC apply latency -* **migrationState**: 'BACKUP_COMPLETED' | 'BACKUP_IN_PROGRESS' | 'CANCELLED' | 'CANCELLING' | 'COMPLETE' | 'COMPLETING' | 'CONFIGURING' | 'FAILED' | 'INITIALIAZING' | 'READY_TO_COMPLETE' | 'RESTORE_COMPLETED' | 'RESTORE_IN_PROGRESS' | 'RUNNING' | 'STARTING' | 'UNDEFINED' | 'VALIDATING' | 'VALIDATION_COMPLETE' | 'VALIDATION_FAILED' | string (ReadOnly): Enum of the different state of database level online migration. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time +## NodeMonitoringData +### Properties +* **additionalProperties**: [NodeMonitoringDataAdditionalProperties](#nodemonitoringdataadditionalproperties) (ReadOnly): Unmatched properties from the message are deserialized in this collection. +* **availableMemoryInMB**: int (ReadOnly): Available memory (MB) on the integration runtime node. +* **concurrentJobsLimit**: int (ReadOnly): Maximum concurrent jobs on the integration runtime node. +* **concurrentJobsRunning**: int (ReadOnly): The number of jobs currently running on the integration runtime node. +* **cpuUtilization**: int (ReadOnly): CPU percentage on the integration runtime node. +* **maxConcurrentJobs**: int (ReadOnly): The maximum concurrent jobs in this integration runtime. +* **nodeName**: string (ReadOnly): Name of the integration runtime node. +* **receivedBytes**: int (ReadOnly): Received bytes on the integration runtime node. +* **sentBytes**: int (ReadOnly): Sent bytes on the integration runtime node. -### MigrateSqlServerSqlDbSyncTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## NodeMonitoringDataAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any -### MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel -#### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServer**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **targetServer**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +## ODataError +### Properties +* **code**: string: The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' +* **details**: [ODataError](#odataerror)[]: Inner errors that caused this error +* **message**: string: The human-readable description of the error -### MigrateSqlServerSqlDbSyncTaskOutputTableLevel -#### Properties -* **cdcDeleteCounter**: int (ReadOnly): Number of applied deletes -* **cdcInsertCounter**: int (ReadOnly): Number of applied inserts -* **cdcUpdateCounter**: int (ReadOnly): Number of applied updates -* **databaseName**: string (ReadOnly): Name of the database -* **dataErrorsCounter**: int (ReadOnly): Number of data errors occurred -* **fullLoadEndedOn**: string (ReadOnly): Full load end time -* **fullLoadEstFinishTime**: string (ReadOnly): Estimate to finish full load -* **fullLoadStartedOn**: string (ReadOnly): Full load start time -* **fullLoadTotalRows**: int (ReadOnly): Number of rows applied in full load -* **lastModifiedTime**: string (ReadOnly): Last modified time on target -* **resultType**: 'TableLevelOutput' (Required): Result type -* **state**: 'BEFORE_LOAD' | 'CANCELED' | 'COMPLETED' | 'ERROR' | 'FAILED' | 'FULL_LOAD' | string (ReadOnly): Enum of the different state of table level online migration. -* **tableName**: string (ReadOnly): Name of the table -* **totalChangesApplied**: int (ReadOnly): Total number of applied changes +## OracleConnectionInfo +### Properties +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): EZConnect or TNSName connection string. +* **password**: string: Password credential. +* **port**: int: port for server +* **serverName**: string: name of the server +* **serverVersion**: string: server version +* **type**: string (Required): Type of connection info +* **userName**: string: User name +## OracleOCIDriverInfo +### Properties +* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. +* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' +* **driverName**: string (ReadOnly): The name of the driver package +* **driverSize**: string (ReadOnly): The size in bytes of the driver package +* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. +* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. -## MigrateSqlServerSqlMITaskInput +## OrphanedUserInfo ### Properties -* **aadDomainName**: string: Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected -* **backupBlobShare**: [BlobShare](#blobshare) (Required): Blob container storage information. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **backupMode**: 'CreateBackup' | 'ExistingBackup' | string: An enumeration of backup modes -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedAgentJobs**: string[]: Agent Jobs to migrate. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **selectedLogins**: string[]: Logins to migrate. -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Date and time relative to UTC when the migration was started on -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **databaseName**: string: Parent database of the user +* **name**: string: Name of the orphaned user -## BlobShare +## PostgreSqlConnectionInfo ### Properties -* **sasUri**: string: SAS URI of Azure Storage Account Container. +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **databaseName**: string: Name of the database +* **dataSource**: string: Data source +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **port**: int (Required): Port for Server +* **serverBrandVersion**: string: server brand version +* **serverName**: string (Required): Name of the server +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -## MigrateSqlServerSqlMIDatabaseInput +## ProjectFileProperties ### Properties -* **backupFilePaths**: string[]: The list of backup files to be used in case of existing backups. -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **id**: string: id of the database -* **name**: string (Required): Name of the database -* **restoreDatabaseName**: string (Required): Name of the database at destination +* **extension**: string: Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. +* **filePath**: string: Relative path of this file resource. This property can be set when creating or updating the file resource. +* **lastModified**: string (ReadOnly): Modification DateTime. +* **mediaType**: string: File content type. This property can be modified to reflect the file content type. +* **size**: int (ReadOnly): File size. -## MigrateSqlServerSqlMITaskOutput -* **Discriminator**: resultType +## ProjectProperties +### Properties +* **azureAuthenticationInfo**: [AzureActiveDirectoryApp](#azureactivedirectoryapp): Azure Active Directory Application +* **creationTime**: string (ReadOnly): UTC Date and time when project was created +* **databasesInfo**: [DatabaseInfo](#databaseinfo)[]: List of DatabaseInfo +* **provisioningState**: 'Deleting' | 'Succeeded' | string (ReadOnly): The project's provisioning state +* **sourceConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **sourcePlatform**: 'MongoDb' | 'MySQL' | 'PostgreSql' | 'SQL' | 'Unknown' | string (Required): Source platform of the project +* **targetConnectionInfo**: [ConnectionInfo](#connectioninfo): Defines the connection properties of a server +* **targetPlatform**: 'AzureDbForMySql' | 'AzureDbForPostgreSql' | 'MongoDb' | 'SQLDB' | 'SQLMI' | 'Unknown' | string (Required): Target platform of the project + +## ProjectTaskProperties +* **Discriminator**: taskType ### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMITaskOutputAgentJobLevel +* **clientData**: [ProjectTaskPropertiesClientData](#projecttaskpropertiesclientdata): Key value pairs of client data to attach meta data information to task +* **commands**: [CommandProperties](#commandproperties)[] (ReadOnly): Array of command properties. +* **errors**: [ODataError](#odataerror)[] (ReadOnly): Array of errors. This is ignored if submitted. +* **state**: 'Canceled' | 'Failed' | 'FailedInputValidation' | 'Faulted' | 'Queued' | 'Running' | 'Succeeded' | 'Unknown' | string (ReadOnly): The state of the task. This is ignored if submitted. +### ConnectToMongoDbTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration errors and warnings per job -* **isEnabled**: bool (ReadOnly): The state of the original Agent Job. -* **message**: string (ReadOnly): Migration progress message -* **name**: string (ReadOnly): Agent Job name. -* **resultType**: 'AgentJobLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [MongoDbConnectionInfo](#mongodbconnectioninfo): Describes a connection to a MongoDB data source +* **output**: [MongoDbClusterInfo](#mongodbclusterinfo)[] (ReadOnly): An array containing a single MongoDbClusterInfo object +* **taskType**: 'Connect.MongoDb' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputDatabaseLevel +### ConnectToSourceMySqlTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sizeMB**: int (ReadOnly): Size of the database in megabytes -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToSourceMySqlTaskInput](#connecttosourcemysqltaskinput): Input for the task that validates MySQL database connection +* **output**: [ConnectToSourceNonSqlTaskOutput](#connecttosourcenonsqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.MySql' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputError +### ConnectToSourceOracleSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToSourceOracleSyncTaskInput](#connecttosourceoraclesynctaskinput): Input for the task that validates Oracle database connection +* **output**: [ConnectToSourceOracleSyncTaskOutput](#connecttosourceoraclesynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.Oracle.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputLoginLevel +### ConnectToSourcePostgreSqlSyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Login migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Login migration errors and warnings per login -* **loginName**: string (ReadOnly): Login name. -* **message**: string (ReadOnly): Login migration progress message -* **resultType**: 'LoginLevelOutput' (Required): Result type -* **stage**: 'AssignRoleMembership' | 'AssignRoleOwnership' | 'Completed' | 'EstablishObjectPermissions' | 'EstablishServerPermissions' | 'EstablishUserMapping' | 'Initialize' | 'LoginMigration' | 'None' | string (ReadOnly): Enum of the different stage of login migration. -* **startedOn**: string (ReadOnly): Login migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ConnectToSourcePostgreSqlSyncTaskInput](#connecttosourcepostgresqlsynctaskinput): Input for the task that validates connection to PostgreSQL and source server requirements +* **output**: [ConnectToSourcePostgreSqlSyncTaskOutput](#connecttosourcepostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.PostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMITaskOutputMigrationLevel +### ConnectToSourceSqlServerTaskProperties #### Properties -* **agentJobs**: string (ReadOnly): Selected agent jobs as a map from name to id -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **logins**: string (ReadOnly): Selected logins as a map from name to id -* **message**: string (ReadOnly): Migration progress message -* **orphanedUsersInfo**: [OrphanedUserInfo](#orphaneduserinfo)[] (ReadOnly): List of orphaned users. -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **serverRoleResults**: string (ReadOnly): Map of server role migration results. -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'ConnectToSource.SqlServer' (Required): Task type. +### ConnectToSourceSqlServerSyncTaskProperties +#### Properties +* **input**: [ConnectToSourceSqlServerTaskInput](#connecttosourcesqlservertaskinput): Input for the task that validates connection to SQL Server and also validates source server requirements +* **output**: [ConnectToSourceSqlServerTaskOutput](#connecttosourcesqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToSource.SqlServer.Sync' (Required): Task type. -## OrphanedUserInfo -### Properties -* **databaseName**: string: Parent database of the user -* **name**: string: Name of the orphaned user +### ConnectToTargetAzureDbForMySqlTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForMySqlTaskInput](#connecttotargetazuredbformysqltaskinput): Input for the task that validates connection to Azure Database for MySQL and target server requirements +* **output**: [ConnectToTargetAzureDbForMySqlTaskOutput](#connecttotargetazuredbformysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForMySql' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **numberOfParallelDatabaseMigrations**: int: Number of database migrations to start in parallel -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance +### ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskInput](#connecttotargetazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements +* **output**: [ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureDbForPostgreSql.Sync' (Required): Task type. -## MigrateSqlServerSqlMISyncTaskOutput -* **Discriminator**: resultType +### ConnectToTargetSqlMITaskProperties +#### Properties +* **input**: [ConnectToTargetSqlMITaskInput](#connecttotargetsqlmitaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance. +* **output**: [ConnectToTargetSqlMITaskOutput](#connecttotargetsqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel +### ConnectToTargetSqlMISyncTaskProperties #### Properties -* **activeBackupSets**: [BackupSetInfo](#backupsetinfo)[] (ReadOnly): Backup sets that are currently active (Either being uploaded or getting restored) -* **containerName**: string (ReadOnly): Name of container created in the Azure Storage account where backups are copied to -* **endedOn**: string (ReadOnly): Database migration end time -* **errorPrefix**: string (ReadOnly): prefix string to use for querying errors for this database -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **fullBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **isFullBackupRestored**: bool (ReadOnly): Whether full backup has been applied to the target database or not -* **lastRestoredBackupSetInfo**: [BackupSetInfo](#backupsetinfo) (ReadOnly): Information of backup set -* **migrationState**: 'CANCELLED' | 'COMPLETED' | 'CUTOVER_START' | 'FAILED' | 'FULL_BACKUP_UPLOAD_START' | 'INITIAL' | 'LOG_SHIPPING_START' | 'POST_CUTOVER_COMPLETE' | 'UNDEFINED' | 'UPLOAD_LOG_FILES_START' | string (ReadOnly): Database level migration state. -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **sourceDatabaseName**: string (ReadOnly): Name of the database -* **startedOn**: string (ReadOnly): Database migration start time +* **input**: [ConnectToTargetSqlMISyncTaskInput](#connecttotargetsqlmisynctaskinput): Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. +* **output**: [ConnectToTargetSqlMISyncTaskOutput](#connecttotargetsqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.AzureSqlDbMI.Sync.LRS' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputError +### ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInput](#connecttotargetoracleazuredbforpostgresqlsynctaskinput): Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. +* **output**: [ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutput](#connecttotargetoracleazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlMISyncTaskOutputMigrationLevel +### ConnectToTargetSqlDbTaskProperties #### Properties -* **databaseCount**: int (ReadOnly): Count of databases -* **databaseErrorCount**: int (ReadOnly): Number of database level errors -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerName**: string (ReadOnly): Source server name -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerName**: string (ReadOnly): Target server name -* **targetServerVersion**: string (ReadOnly): Target server version +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [ConnectToTargetSqlDbTaskInput](#connecttotargetsqldbtaskinput): Input for the task that validates connection to SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb' (Required): Task type. +### ConnectToTargetSqlDbSyncTaskProperties +#### Properties +* **input**: [ConnectToTargetSqlDbSyncTaskInput](#connecttotargetsqldbsynctaskinput): Input for the task that validates connection to Azure SQL DB and target server requirements +* **output**: [ConnectToTargetSqlDbTaskOutput](#connecttotargetsqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ConnectToTarget.SqlDb.Sync' (Required): Task type. -## BackupSetInfo -### Properties -* **backupFinishedDate**: string: Date and time that the backup operation finished -* **backupSetId**: string: Id for the set of backup files -* **backupStartDate**: string: Date and time that the backup operation began -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string: Enum of the different backup types. -* **databaseName**: string: Name of the database to which the backup set belongs -* **firstLsn**: string: First log sequence number of the backup file -* **isBackupRestored**: bool: Whether the backup set is restored or not -* **lastLsn**: string: Last log sequence number of the backup file -* **lastModifiedTime**: string: Last modified time of the backup file in share location -* **listOfBackupFiles**: [BackupFileInfo](#backupfileinfo)[]: List of files in the backup set +### GetTdeCertificatesSqlTaskProperties +#### Properties +* **input**: [GetTdeCertificatesSqlTaskInput](#gettdecertificatessqltaskinput): Input for the task that gets TDE certificates in Base64 encoded format. +* **output**: [GetTdeCertificatesSqlTaskOutput](#gettdecertificatessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetTDECertificates.Sql' (Required): Task type. + +### GetUserTablesSqlSyncTaskProperties +#### Properties +* **input**: [GetUserTablesSqlSyncTaskInput](#getusertablessqlsynctaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlSyncTaskOutput](#getusertablessqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTables.AzureSqlDb.Sync' (Required): Task type. + +### GetUserTablesSqlTaskProperties +#### Properties +* **input**: [GetUserTablesSqlTaskInput](#getusertablessqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesSqlTaskOutput](#getusertablessqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'GetUserTables.Sql' (Required): Task type. -## BackupFileInfo -### Properties -* **familySequenceNumber**: int: Sequence number of the backup file in the backup set -* **fileLocation**: string: Location of the backup file in shared folder -* **status**: 'Arrived' | 'Cancelled' | 'Queued' | 'Restored' | 'Restoring' | 'Uploaded' | 'Uploading' | string: An enumeration of Status of the log backup file. +### GetUserTablesMySqlTaskProperties +#### Properties +* **input**: [GetUserTablesMySqlTaskInput](#getusertablesmysqltaskinput): Input for the task that collects user tables for the given list of databases +* **output**: [GetUserTablesMySqlTaskOutput](#getusertablesmysqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesMySql' (Required): Task type. -## MigrateSqlServerSqlDbTaskInput -### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigrateSqlServerSqlDbDatabaseInput](#migratesqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Date and time relative to UTC when the migration was started on -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **validationOptions**: [MigrationValidationOptions](#migrationvalidationoptions): Types of validations to run after the migration +### GetUserTablesOracleTaskProperties +#### Properties +* **input**: [GetUserTablesOracleTaskInput](#getusertablesoracletaskinput): Input for the task that gets the list of tables contained within a provided list of Oracle schemas. +* **output**: [GetUserTablesOracleTaskOutput](#getusertablesoracletaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesOracle' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInput -### Properties -* **id**: string: id of the database -* **makeSourceDbReadOnly**: bool: Whether to set database read only before migration -* **name**: string: Name of the database -* **schemaSetting**: any: Any object -* **tableMap**: [MigrateSqlServerSqlDbDatabaseInputTableMap](#migratesqlserversqldbdatabaseinputtablemap): Mapping of source to target tables -* **targetDatabaseName**: string: Name of target database. Note: Target database will be truncated before starting migration. +### GetUserTablesPostgreSqlTaskProperties +#### Properties +* **input**: [GetUserTablesPostgreSqlTaskInput](#getusertablespostgresqltaskinput): Input for the task that gets the list of tables for a provided list of PostgreSQL databases. +* **output**: [GetUserTablesPostgreSqlTaskOutput](#getusertablespostgresqltaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'GetUserTablesPostgreSql' (Required): Task type. -## MigrateSqlServerSqlDbDatabaseInputTableMap -### Properties -### Additional Properties -* **Additional Properties Type**: string +### MigrateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbProgress](#mongodbprogress)[] (ReadOnly): Array of MongoDbProgress +* **taskType**: 'Migrate.MongoDb' (Required): Task type. -## MigrateSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +### MigrateMySqlAzureDbForMySqlOfflineTaskProperties +#### Properties +* **input**: [MigrateMySqlAzureDbForMySqlOfflineTaskInput](#migratemysqlazuredbformysqlofflinetaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateMySqlAzureDbForMySqlOfflineTaskOutput](#migratemysqlazuredbformysqlofflinetaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'Migrate.MySql.AzureDbForMySql' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSqlServerSqlDbTaskOutputDatabaseLevel +### MigrateMySqlAzureDbForMySqlSyncTaskProperties #### Properties -* **databaseName**: string (ReadOnly): Name of the item -* **endedOn**: string (ReadOnly): Migration end time -* **errorCount**: int (ReadOnly): Number of database/object errors. -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **numberOfObjects**: int (ReadOnly): Number of objects -* **numberOfObjectsCompleted**: int (ReadOnly): Number of successfully completed objects -* **objectSummary**: string (ReadOnly): Summary of object results in the migration -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **stage**: 'Backup' | 'Completed' | 'FileCopy' | 'Initialize' | 'None' | 'Restore' | string (ReadOnly): Current stage of migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **input**: [MigrateMySqlAzureDbForMySqlSyncTaskInput](#migratemysqlazuredbformysqlsynctaskinput): Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations +* **output**: [MigrateMySqlAzureDbForMySqlSyncTaskOutput](#migratemysqlazuredbformysqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.MySql.AzureDbForMySql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputError +### MigrateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [MigrateOracleAzureDbPostgreSqlSyncTaskOutput](#migrateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Oracle.AzureDbForPostgreSql.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult +### MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **resultType**: 'MigrationDatabaseLevelValidationOutput' (Required): Result type +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput](#migratepostgresqlazuredbforpostgresqlsynctaskinput): Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput](#migratepostgresqlazuredbforpostgresqlsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputMigrationLevel +### MigrateSqlServerSqlDbSyncTaskProperties #### Properties -* **databases**: string (ReadOnly): Selected databases as a map from database name to database id -* **databaseSummary**: string (ReadOnly): Summary of database results in the migration -* **durationInSeconds**: int (ReadOnly): Duration of task execution in seconds. -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **migrationReportResult**: [MigrationReportResult](#migrationreportresult): Migration validation report result, contains the url for downloading the generated report. -* **migrationValidationResult**: [MigrationValidationResult](#migrationvalidationresult): Migration Validation Result -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **statusMessage**: string (ReadOnly): Migration status message -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateSqlServerSqlDbSyncTaskInput](#migratesqlserversqldbsynctaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations +* **output**: [MigrateSqlServerSqlDbSyncTaskOutput](#migratesqlserversqldbsynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDb.Sync' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputValidationResult +### MigrateSqlServerSqlMITaskProperties #### Properties -* **resultType**: 'MigrationValidationOutput' (Required): Result type +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSqlServerSqlMITaskInput](#migratesqlserversqlmitaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSqlServerSqlMITaskOutput](#migratesqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **parentTaskId**: string: parent task id +* **taskId**: string: task id +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI' (Required): Task type. -### MigrateSqlServerSqlDbTaskOutputTableLevel +### MigrateSqlServerSqlMISyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **errorPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all errors of the item -* **itemsCompletedCount**: int (ReadOnly): Number of successfully completed items -* **itemsCount**: int (ReadOnly): Number of items -* **objectName**: string (ReadOnly): Name of the item -* **resultPrefix**: string (ReadOnly): Wildcard string prefix to use for querying all sub-tem results of the item -* **resultType**: 'TableLevelOutput' (Required): Result type -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **statusMessage**: string (ReadOnly): Status message +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSqlServerSqlMISyncTaskInput](#migratesqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [MigrateSqlServerSqlMISyncTaskOutput](#migratesqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. +### MigrateSqlServerSqlDbTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSqlServerSqlDbTaskInput](#migratesqlserversqldbtaskinput): Input for the task that migrates on-prem SQL Server databases to Azure SQL Database +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSqlServerSqlDbTaskOutput](#migratesqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: task id +* **taskType**: 'Migrate.SqlServer.SqlDb' (Required): Task type. -## MigrationValidationResult -### Properties -* **id**: string (ReadOnly): Migration validation result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **summaryResults**: [MigrationValidationResultSummaryResults](#migrationvalidationresultsummaryresults): Validation summary results for each database +### MigrateSsisTaskProperties +#### Properties +* **input**: [MigrateSsisTaskInput](#migratessistaskinput): Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. +* **output**: [MigrateSsisTaskOutput](#migratessistaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Migrate.Ssis' (Required): Task type. -## MigrationValidationResultSummaryResults -### Properties -### Additional Properties -* **Additional Properties Type**: [MigrationValidationDatabaseSummaryResult](#migrationvalidationdatabasesummaryresult) +### MigrateSchemaSqlServerSqlDbTaskProperties +#### Properties +* **createdOn**: string: DateTime in UTC when the task was created +* **input**: [MigrateSchemaSqlServerSqlDbTaskInput](#migrateschemasqlserversqldbtaskinput): Input for task that migrates Schema for SQL Server databases to Azure SQL databases +* **isCloneable**: bool: whether the task can be cloned or not +* **output**: [MigrateSchemaSqlServerSqlDbTaskOutput](#migrateschemasqlserversqldbtaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskId**: string: Task id +* **taskType**: 'MigrateSchemaSqlServerSqlDb' (Required): Task type. -## MigrationValidationDatabaseSummaryResult -### Properties -* **endedOn**: string (ReadOnly): Validation end time -* **id**: string (ReadOnly): Result identifier -* **migrationId**: string (ReadOnly): Migration Identifier -* **sourceDatabaseName**: string (ReadOnly): Name of the source database -* **startedOn**: string (ReadOnly): Validation start time -* **status**: 'Completed' | 'CompletedWithIssues' | 'Default' | 'Failed' | 'InProgress' | 'Initialized' | 'NotStarted' | 'Stopped' | string (ReadOnly): Current status of the validation -* **targetDatabaseName**: string (ReadOnly): Name of the target database +### CheckOCIDriverTaskProperties +#### Properties +* **input**: [CheckOCIDriverTaskInput](#checkocidrivertaskinput): Input for the service task to check for OCI drivers. +* **output**: [CheckOCIDriverTaskOutput](#checkocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Check.OCI' (Required): Task type. -## MigrateSsisTaskInput -### Properties -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **ssisMigrationInfo**: [SsisMigrationInfo](#ssismigrationinfo) (Required): SSIS migration info with SSIS store type, overwrite policy. -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### InstallOCIDriverTaskProperties +#### Properties +* **input**: [InstallOCIDriverTaskInput](#installocidrivertaskinput): Input for the service task to install an OCI driver. +* **output**: [InstallOCIDriverTaskOutput](#installocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Install.OCI' (Required): Task type. -## SsisMigrationInfo -### Properties -* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object -* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS +### UploadOCIDriverTaskProperties +#### Properties +* **input**: [UploadOCIDriverTaskInput](#uploadocidrivertaskinput): Input for the service task to upload an OCI driver. +* **output**: [UploadOCIDriverTaskOutput](#uploadocidrivertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'Service.Upload.OCI' (Required): Task type. -## MigrateSsisTaskOutput -* **Discriminator**: resultType +### ValidateMongoDbTaskProperties +#### Properties +* **input**: [MongoDbMigrationSettings](#mongodbmigrationsettings): Describes how a MongoDB data migration should be performed +* **output**: [MongoDbMigrationProgress](#mongodbmigrationprogress)[] (ReadOnly): An array containing a single MongoDbMigrationProgress object +* **taskType**: 'Validate.MongoDb' (Required): Task type. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSsisTaskOutputMigrationLevel +### ValidateOracleAzureDbForPostgreSqlSyncTaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings. -* **message**: string (ReadOnly): Migration progress message -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **status**: 'Completed' | 'CompletedWithWarnings' | 'Configured' | 'Connecting' | 'Default' | 'Error' | 'Running' | 'SelectLogins' | 'SourceAndTargetSelected' | 'Stopped' | string (ReadOnly): Current status of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +* **input**: [MigrateOracleAzureDbPostgreSqlSyncTaskInput](#migrateoracleazuredbpostgresqlsynctaskinput): Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations +* **output**: [ValidateOracleAzureDbPostgreSqlSyncTaskOutput](#validateoracleazuredbpostgresqlsynctaskoutput)[] (ReadOnly): An array containing a single validation error response object +* **taskType**: 'Validate.Oracle.AzureDbPostgreSql.Sync' (Required): Task type. -### MigrateSsisTaskOutputProjectLevel +### ValidateMigrationInputSqlServerSqlMITaskProperties #### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **exceptionsAndWarnings**: [ReportableException](#reportableexception)[] (ReadOnly): Migration exceptions and warnings -* **folderName**: string (ReadOnly): Name of the folder -* **message**: string (ReadOnly): Migration progress message -* **projectName**: string (ReadOnly): Name of the project -* **resultType**: 'SsisProjectLevelOutput' (Required): Result type -* **stage**: 'Completed' | 'InProgress' | 'Initialize' | 'None' | string (ReadOnly): Current stage of SSIS migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +* **input**: [ValidateMigrationInputSqlServerSqlMITaskInput](#validatemigrationinputsqlserversqlmitaskinput): Input for task that validates migration input for SQL to Azure SQL Managed Instance +* **output**: [ValidateMigrationInputSqlServerSqlMITaskOutput](#validatemigrationinputsqlserversqlmitaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI' (Required): Task type. + +### ValidateMigrationInputSqlServerSqlMISyncTaskProperties +#### Properties +* **input**: [ValidateMigrationInputSqlServerSqlMISyncTaskInput](#validatemigrationinputsqlserversqlmisynctaskinput): Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. +* **output**: [ValidateMigrationInputSqlServerSqlMISyncTaskOutput](#validatemigrationinputsqlserversqlmisynctaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS' (Required): Task type. + +### ValidateMigrationInputSqlServerSqlDbSyncTaskProperties +#### Properties +* **input**: [ValidateSyncMigrationInputSqlServerTaskInput](#validatesyncmigrationinputsqlservertaskinput): Input for task that validates migration input for SQL sync migrations +* **output**: [ValidateSyncMigrationInputSqlServerTaskOutput](#validatesyncmigrationinputsqlservertaskoutput)[] (ReadOnly): Task output. This is ignored if submitted. +* **taskType**: 'ValidateMigrationInput.SqlServer.SqlDb.Sync' (Required): Task type. -## MigrateSchemaSqlServerSqlDbTaskInput +## ProjectTaskPropertiesClientData ### Properties -* **encryptedKeyForSecureFields**: string: encrypted key for secure fields -* **selectedDatabases**: [MigrateSchemaSqlServerSqlDbDatabaseInput](#migrateschemasqlserversqldbdatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **startedOn**: string: Migration start time -* **targetConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +### Additional Properties +* **Additional Properties Type**: string -## MigrateSchemaSqlServerSqlDbDatabaseInput +## ReportableException ### Properties -* **id**: string: Id of the source database -* **name**: string: Name of source database -* **schemaSetting**: [SchemaMigrationSetting](#schemamigrationsetting): Settings for migrating schema from source to target -* **targetDatabaseName**: string: Name of target database +* **actionableMessage**: string: Actionable steps for this exception +* **filePath**: string: The path to the file where exception occurred +* **hResult**: int: Coded numerical value that is assigned to a specific exception +* **lineNumber**: string: The line number where exception occurred +* **message**: string: Error message +* **stackTrace**: string: Stack trace ## SchemaMigrationSetting ### Properties @@ -2046,73 +2091,104 @@ * **fileName**: string: Name of the file resource containing the uploaded schema file * **schemaOption**: 'ExtractFromSource' | 'None' | 'UseStorageFile' | string: Option for how schema is extracted and applied to target -## MigrateSchemaSqlServerSqlDbTaskOutput -* **Discriminator**: resultType +## SelectedCertificateInput +### Properties +* **certificateName**: string (Required): Name of certificate to be exported. +* **password**: string (Required): Password to use for encrypting the exported certificate. -### Base Properties -* **id**: string (ReadOnly): Result identifier -### MigrateSchemaSqlServerSqlDbTaskOutputDatabaseLevel -#### Properties -* **databaseErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying errors for this database -* **databaseName**: string (ReadOnly): The name of the database -* **endedOn**: string (ReadOnly): Migration end time -* **fileId**: string (ReadOnly): Identifier for the file resource containing the schema of this database -* **numberOfFailedOperations**: int (ReadOnly): Number of failed operations for this database -* **numberOfSuccessfulOperations**: int (ReadOnly): Number of successful operations for this database -* **resultType**: 'DatabaseLevelOutput' (Required): Result type -* **schemaErrorResultPrefix**: string (ReadOnly): Prefix string to use for querying schema errors for this database -* **stage**: 'CollectingObjects' | 'Completed' | 'CompletedWithWarnings' | 'DeployingSchema' | 'DownloadingScript' | 'Failed' | 'GeneratingScript' | 'NotStarted' | 'UploadingScript' | 'ValidatingInputs' | string (ReadOnly): Current stage of schema migration -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration +## ServerProperties +### Properties +* **serverDatabaseCount**: int (ReadOnly): Number of databases in the server +* **serverEdition**: string (ReadOnly): Edition of the database server +* **serverName**: string (ReadOnly): Name of the server +* **serverOperatingSystemVersion**: string (ReadOnly): Version of the operating system +* **serverPlatform**: string (ReadOnly): Name of the server platform +* **serverVersion**: string (ReadOnly): Version of the database server -### MigrateSchemaSqlTaskOutputError -#### Properties -* **error**: [ReportableException](#reportableexception) (ReadOnly): Exception object for all custom exceptions -* **resultType**: 'ErrorOutput' (Required): Result type +## ServiceSku +### Properties +* **capacity**: int: The capacity of the SKU, if it supports scaling +* **family**: string: The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines +* **name**: string: The unique name of the SKU, such as 'P3' +* **size**: 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 +* **tier**: string: The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' -### MigrateSchemaSqlServerSqlDbTaskOutputMigrationLevel -#### Properties -* **endedOn**: string (ReadOnly): Migration end time -* **resultType**: 'MigrationLevelOutput' (Required): Result type -* **sourceServerBrandVersion**: string (ReadOnly): Source server brand version -* **sourceServerVersion**: string (ReadOnly): Source server version -* **startedOn**: string (ReadOnly): Migration start time -* **state**: 'Completed' | 'Failed' | 'InProgress' | 'None' | 'Skipped' | 'Stopped' | 'Warning' | string (ReadOnly): Current state of migration -* **targetServerBrandVersion**: string (ReadOnly): Target server brand version -* **targetServerVersion**: string (ReadOnly): Target server version +## SqlConnectionInfo +### Properties +* **additionalSettings**: string: Additional connection settings +* **authentication**: 'ActiveDirectoryIntegrated' | 'ActiveDirectoryPassword' | 'None' | 'SqlAuthentication' | 'WindowsAuthentication' | string: An enumeration of possible authentication types when connecting +* **dataSource**: string (Required): Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber +* **encryptConnection**: bool: Whether to encrypt the connection +* **password**: string: Password credential. +* **platform**: 'SqlOnPrem' | string: An enumeration of source platform types +* **port**: int: Port for Server +* **resourceId**: string: Represents the ID of an HTTP resource represented by an Azure resource provider. +* **serverBrandVersion**: string: server brand version +* **serverName**: string: name of the server +* **serverVersion**: string: server version +* **trustServerCertificate**: bool: Whether to trust the server certificate +* **type**: string (Required): Type of connection info +* **userName**: string: User name -### MigrateSchemaSqlServerSqlDbTaskOutputError -#### Properties -* **commandText**: string (ReadOnly): Schema command which failed -* **errorText**: string (ReadOnly): Reason of failure -* **resultType**: 'SchemaErrorOutput' (Required): Result type +## SqlConnectionInformation +### Properties +* **authentication**: string: Authentication type. +* **dataSource**: string: Data source. +* **encryptConnection**: bool: Whether to encrypt connection or not. +* **password**: string: Password to connect to source SQL. +* **trustServerCertificate**: bool: Whether to trust server certificate or not. +* **userName**: string: User name to connect to source SQL. +## SqlDbMigrationStatusDetails +### Properties +* **listOfCopyProgressDetails**: [CopyProgressDetails](#copyprogressdetails)[] (ReadOnly): Details on progress of ADF copy activities. +* **migrationState**: string (ReadOnly): Current State of Migration. +* **sqlDataCopyErrors**: string[] (ReadOnly): Sql Data Copy errors, if any. -## CheckOCIDriverTaskInput +## SqlDbOfflineConfiguration ### Properties -* **serverVersion**: string: Version of the source server to check against. Optional. +* **offline**: bool (ReadOnly): Offline migration -## CheckOCIDriverTaskOutput +## SqlMigrationServiceProperties ### Properties -* **installedDriver**: [OracleOCIDriverInfo](#oracleocidriverinfo): Information about an Oracle OCI driver. -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **integrationRuntimeState**: string (ReadOnly): Current state of the Integration runtime. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -## OracleOCIDriverInfo +## SsisMigrationInfo ### Properties -* **archiveChecksum**: string (ReadOnly): The MD5 Base64 encoded checksum for the driver package. -* **assemblyVersion**: string (ReadOnly): Version listed in the OCI assembly 'oci.dll' -* **driverName**: string (ReadOnly): The name of the driver package -* **driverSize**: string (ReadOnly): The size in bytes of the driver package -* **oracleChecksum**: string (ReadOnly): The checksum for the driver package provided by Oracle. -* **supportedOracleVersions**: string[] (ReadOnly): List of Oracle database versions supported by this driver. Only major minor of the version is listed. +* **environmentOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **projectOverwriteOption**: 'Ignore' | 'Overwrite' | string: The overwrite option for SSIS object migration, only ignore and overwrite are supported in DMS now and future may add Reuse option for container object +* **ssisStoreType**: 'SsisCatalog' | string: An enumeration of supported source SSIS store type in DMS -## InstallOCIDriverTaskInput +## SyncMigrationDatabaseErrorEvent ### Properties -* **driverPackageName**: string: Name of the uploaded driver package to install. +* **eventText**: string (ReadOnly): Event text. +* **eventTypeString**: string (ReadOnly): Event type. +* **timestampString**: string (ReadOnly): String value of timestamp. -## InstallOCIDriverTaskOutput +## SystemData ### Properties -* **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors +* **createdAt**: string +* **createdBy**: string +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string +* **lastModifiedAt**: string +* **lastModifiedBy**: string +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## UploadOCIDriverTaskInput ### Properties @@ -2123,36 +2199,19 @@ * **driverPackageName**: string (ReadOnly): The name of the driver package that was validated and uploaded. * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Validation errors -## MongoDbMigrationProgress -### Properties -* **bytesCopied**: int (Required): The number of document bytes copied during the Copying stage -* **databases**: [MongoDbMigrationProgressDatabases](#mongodbmigrationprogressdatabases): The progress of the databases in the migration. The keys are the names of the databases -* **documentsCopied**: int (Required): The number of documents copied during the Copying stage -* **elapsedTime**: string (Required): The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) -* **errors**: [MongoDbProgressErrors](#mongodbprogresserrors) (Required): The errors and warnings that have occurred for the current object. The keys are the error codes. -* **eventsPending**: int (Required): The number of oplog events awaiting replay -* **eventsReplayed**: int (Required): The number of oplog events replayed so far -* **lastEventTime**: string: The timestamp of the last oplog event received, or null if no oplog event has been received yet -* **lastReplayTime**: string: The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet -* **name**: string: The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. -* **qualifiedName**: string: The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. -* **resultType**: 'Collection' | 'Database' | 'Migration' | string (Required): The type of progress object -* **state**: 'Canceled' | 'Complete' | 'Copying' | 'Failed' | 'Finalizing' | 'InitialReplay' | 'Initializing' | 'NotStarted' | 'Replaying' | 'Restarting' | 'ValidatingInput' | string (Required) -* **totalBytes**: int (Required): The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown -* **totalDocuments**: int (Required): The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown - -## MongoDbMigrationProgressDatabases -### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbDatabaseProgress](#mongodbdatabaseprogress) - -## MongoDbProgressErrors +## ValidateMigrationInputSqlServerSqlMISyncTaskInput ### Properties -### Additional Properties -* **Additional Properties Type**: [MongoDbError](#mongodberror) +* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application +* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. +* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate +* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server +* **storageResourceId**: string (Required): Fully qualified resourceId of storage +* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance -## ValidateOracleAzureDbPostgreSqlSyncTaskOutput +## ValidateMigrationInputSqlServerSqlMISyncTaskOutput ### Properties +* **id**: string (ReadOnly): Database identifier +* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateMigrationInputSqlServerSqlMITaskInput @@ -2176,30 +2235,8 @@ * **name**: string (ReadOnly): Name of database * **restoreDatabaseNameErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with the RestoreDatabaseName -## DatabaseBackupInfo -### Properties -* **backupFiles**: string[] (ReadOnly): The list of backup files for the current database. -* **backupFinishDate**: string (ReadOnly): Date and time when the backup operation finished. -* **backupType**: 'Database' | 'DifferentialDatabase' | 'DifferentialFile' | 'DifferentialPartial' | 'File' | 'Partial' | 'TransactionLog' | string (ReadOnly): Enum of the different backup types. -* **databaseName**: string (ReadOnly): Database name. -* **familyCount**: int (ReadOnly): Number of files in the backup set. -* **isCompressed**: bool (ReadOnly): Whether the backup set is compressed -* **isDamaged**: bool (ReadOnly): Database was damaged when backed up, but the backup operation was requested to continue despite errors. -* **position**: int (ReadOnly): Position of current database backup in the file. - -## ValidateMigrationInputSqlServerSqlMISyncTaskInput -### Properties -* **azureApp**: [AzureActiveDirectoryApp](#azureactivedirectoryapp) (Required): Azure Active Directory Application -* **backupFileShare**: [FileShare](#fileshare): File share information with Path, Username, and Password. -* **selectedDatabases**: [MigrateSqlServerSqlMIDatabaseInput](#migratesqlserversqlmidatabaseinput)[] (Required): Databases to migrate -* **sourceConnectionInfo**: [SqlConnectionInfo](#sqlconnectioninfo) (Required): Information for connecting to SQL database server -* **storageResourceId**: string (Required): Fully qualified resourceId of storage -* **targetConnectionInfo**: [MiSqlConnectionInfo](#misqlconnectioninfo) (Required): Properties required to create a connection to Azure SQL database Managed instance - -## ValidateMigrationInputSqlServerSqlMISyncTaskOutput +## ValidateOracleAzureDbPostgreSqlSyncTaskOutput ### Properties -* **id**: string (ReadOnly): Database identifier -* **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object ## ValidateSyncMigrationInputSqlServerTaskInput @@ -2214,40 +2251,3 @@ * **name**: string (ReadOnly): Name of database * **validationErrors**: [ReportableException](#reportableexception)[] (ReadOnly): Errors associated with a selected database object -## SqlMigrationServiceProperties -### Properties -* **integrationRuntimeState**: string (ReadOnly): Current state of the Integration runtime. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthenticationKeys -### Properties -* **authKey1**: string (ReadOnly): The first authentication key. -* **authKey2**: string (ReadOnly): The second authentication key. - -## IntegrationRuntimeMonitoringData -### Properties -* **name**: string (ReadOnly): The name of Integration Runtime. -* **nodes**: [NodeMonitoringData](#nodemonitoringdata)[] (ReadOnly): Integration Runtime node monitoring data. - -## NodeMonitoringData -### Properties -* **additionalProperties**: [NodeMonitoringDataAdditionalProperties](#nodemonitoringdataadditionalproperties) (ReadOnly): Unmatched properties from the message are deserialized in this collection. -* **availableMemoryInMB**: int (ReadOnly): Available memory (MB) on the integration runtime node. -* **concurrentJobsLimit**: int (ReadOnly): Maximum concurrent jobs on the integration runtime node. -* **concurrentJobsRunning**: int (ReadOnly): The number of jobs currently running on the integration runtime node. -* **cpuUtilization**: int (ReadOnly): CPU percentage on the integration runtime node. -* **maxConcurrentJobs**: int (ReadOnly): The maximum concurrent jobs in this integration runtime. -* **nodeName**: string (ReadOnly): Name of the integration runtime node. -* **receivedBytes**: int (ReadOnly): Received bytes on the integration runtime node. -* **sentBytes**: int (ReadOnly): Sent bytes on the integration runtime node. - -## NodeMonitoringDataAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - diff --git a/generated/dataprotection/log.out b/generated/dataprotection/log.out index a620083897..ae67839e44 100644 --- a/generated/dataprotection/log.out +++ b/generated/dataprotection/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.dataprotection-2022-03-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json:3624:5 @@ -31,10 +31,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobExtendedInfo-additionalDet warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-03-31-preview/dataprotection.json:5425:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 17ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.dataprotection-2022-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-02-01-preview/dataprotection.json:3566:5 @@ -59,10 +59,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobExtendedInfo-additionalDet warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-02-01-preview/dataprotection.json:5367:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.dataprotection-2022-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/dataprotection.json:3549:5 @@ -87,10 +87,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobExtendedInfo-additionalDet warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/dataprotection.json:5346:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.dataprotection-2021-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-10-01-preview/dataprotection.json:3033:5 @@ -118,7 +118,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.dataprotection-2021-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-07-01/dataprotection.json:3033:5 @@ -146,7 +146,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.dataprotection-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json:2060:5 @@ -171,10 +171,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobExtendedInfo-additionalDet warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json:3754:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.dataprotection-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json:2404:5 @@ -199,10 +199,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobExtendedInfo-additionalDet warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json:4098:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.dataprotection-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/dataprotection.json:2419:5 @@ -227,10 +227,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobExtendedInfo-additionalDet warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/dataprotection.json:4121:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.dataprotection-2021-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-12-01-preview/dataprotection.json:3033:5 @@ -258,7 +258,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.dataprotection-2022-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureBackupFindRestorableTimeRangesRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-03-01/dataprotection.json:3549:5 @@ -284,4 +284,4 @@ warning | PreCheck/SchemaMissingType | The schema 'JobSubTask-additionalDetails' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-03-01/dataprotection.json:5346:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 8ms -info | Autorest completed in 49.2s. 20 files generated. +info | Autorest completed in 47.71s. 20 files generated. diff --git a/generated/dataprotection/microsoft.dataprotection/2021-01-01/types.md b/generated/dataprotection/microsoft.dataprotection/2021-01-01/types.md index fd2ceb4ab7..2e2576e2e6 100644 --- a/generated/dataprotection/microsoft.dataprotection/2021-01-01/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2021-01-01/types.md @@ -34,35 +34,25 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DataProtection/backupVaults/backupPolicies' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## BackupCriteria +* **Discriminator**: objectType -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -76,79 +66,24 @@ * **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed -## Datasource -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## DatasourceSet -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters -### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters - -## DataStoreParameters +## BackupParameters * **Discriminator**: objectType ### Base Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -### AzureOperationalStoreParameters +### AzureBackupParams #### Properties -* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing -* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. - - -## UserFacingError -### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. - -## InnerError -### Properties -* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. -* **code**: string: Unique code for this error -* **embeddedInnerError**: [InnerError](#innererror): Inner Error +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## InnerErrorAdditionalInfo -### Properties -### Additional Properties -* **Additional Properties Type**: string -## UserFacingErrorProperties +## BackupSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -## ProtectionStatusDetails +## BackupVault ### Properties -* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user -* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings ## BaseBackupPolicy * **Discriminator**: objectType @@ -180,78 +115,117 @@ * **objectType**: 'AzureRetentionRule' (Required) -## BackupParameters +## CopyOption * **Discriminator**: objectType ### Base Properties -### AzureBackupParams +### CopyOnExpiryOption #### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + + +## Datasource +### Properties +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. +## DatasourceSet +### Properties +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. ## DataStoreInfoBase ### Properties * **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive * **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type -## TriggerContext +## DataStoreParameters * **Discriminator**: objectType ### Base Properties -### AdhocBasedTriggerContext +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +### AzureOperationalStoreParameters #### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria +* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing +* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -### ScheduleBasedTriggerContext + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption #### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing -## AdhocBasedTaggingCriteria +## DppIdentityDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None -## RetentionTag +## DppTrackedResourceTags ### Properties -* **eTag**: string (ReadOnly): Retention Tag version. -* **id**: string (ReadOnly): Retention Tag version. -* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. +### Additional Properties +* **Additional Properties Type**: string -## BackupSchedule +## InnerError ### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. +* **code**: string: Unique code for this error +* **embeddedInnerError**: [InnerError](#innererror): Inner Error -## TaggingCriteria +## InnerErrorAdditionalInfo ### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag +### Additional Properties +* **Additional Properties Type**: string -## BackupCriteria -* **Discriminator**: objectType +## PolicyInfo +### Properties +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +## ProtectionStatusDetails +### Properties +* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user +* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## Day +## RetentionTag ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **eTag**: string (ReadOnly): Retention Tag version. +* **id**: string (ReadOnly): Retention Tag version. +* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. ## SourceLifeCycle ### Properties @@ -259,36 +233,62 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption +### AdhocBasedTriggerContext #### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### CustomCopyOption +### ScheduleBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -### ImmediateCopyOption -#### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +## UserFacingError +### Properties +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. + +## UserFacingErrorProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2021-02-01-preview/types.md b/generated/dataprotection/microsoft.dataprotection/2021-02-01-preview/types.md index 852cf8a5a4..2ceb28908d 100644 --- a/generated/dataprotection/microsoft.dataprotection/2021-02-01-preview/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2021-02-01-preview/types.md @@ -34,35 +34,25 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DataProtection/backupVaults/backupPolicies' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## BackupCriteria +* **Discriminator**: objectType -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -76,79 +66,24 @@ * **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed -## Datasource -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## DatasourceSet -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters -### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters - -## DataStoreParameters +## BackupParameters * **Discriminator**: objectType ### Base Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -### AzureOperationalStoreParameters +### AzureBackupParams #### Properties -* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing -* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. - - -## UserFacingError -### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. - -## InnerError -### Properties -* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. -* **code**: string: Unique code for this error -* **embeddedInnerError**: [InnerError](#innererror): Inner Error +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## InnerErrorAdditionalInfo -### Properties -### Additional Properties -* **Additional Properties Type**: string -## UserFacingErrorProperties +## BackupSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -## ProtectionStatusDetails +## BackupVault ### Properties -* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user -* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings ## BaseBackupPolicy * **Discriminator**: objectType @@ -180,78 +115,117 @@ * **objectType**: 'AzureRetentionRule' (Required) -## BackupParameters +## CopyOption * **Discriminator**: objectType ### Base Properties -### AzureBackupParams +### CopyOnExpiryOption #### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + + +## Datasource +### Properties +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. +## DatasourceSet +### Properties +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. ## DataStoreInfoBase ### Properties * **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive * **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type -## TriggerContext +## DataStoreParameters * **Discriminator**: objectType ### Base Properties -### AdhocBasedTriggerContext +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +### AzureOperationalStoreParameters #### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria +* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing +* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -### ScheduleBasedTriggerContext + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption #### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing -## AdhocBasedTaggingCriteria +## DppIdentityDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None -## RetentionTag +## DppTrackedResourceTags ### Properties -* **eTag**: string (ReadOnly): Retention Tag version. -* **id**: string (ReadOnly): Retention Tag version. -* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. +### Additional Properties +* **Additional Properties Type**: string -## BackupSchedule +## InnerError ### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. +* **code**: string: Unique code for this error +* **embeddedInnerError**: [InnerError](#innererror): Inner Error -## TaggingCriteria +## InnerErrorAdditionalInfo ### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag +### Additional Properties +* **Additional Properties Type**: string -## BackupCriteria -* **Discriminator**: objectType +## PolicyInfo +### Properties +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +## ProtectionStatusDetails +### Properties +* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user +* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## Day +## RetentionTag ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **eTag**: string (ReadOnly): Retention Tag version. +* **id**: string (ReadOnly): Retention Tag version. +* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. ## SourceLifeCycle ### Properties @@ -259,36 +233,62 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption +### AdhocBasedTriggerContext #### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### CustomCopyOption +### ScheduleBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -### ImmediateCopyOption -#### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +## UserFacingError +### Properties +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. + +## UserFacingErrorProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2021-06-01-preview/types.md b/generated/dataprotection/microsoft.dataprotection/2021-06-01-preview/types.md index 3aba89c9ac..20bd9d5c89 100644 --- a/generated/dataprotection/microsoft.dataprotection/2021-06-01-preview/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2021-06-01-preview/types.md @@ -34,35 +34,35 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DataProtection/backupVaults/backupPolicies' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## BackupCriteria +* **Discriminator**: objectType + +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last + ## BackupInstance ### Properties @@ -77,94 +77,24 @@ * **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed -## AuthCredentials -* **Discriminator**: objectType - -### Base Properties -### SecretStoreBasedAuthCredentials -#### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. - - -## SecretStoreResource -### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource - -## Datasource -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## DatasourceSet -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters -### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters - -## DataStoreParameters +## BackupParameters * **Discriminator**: objectType ### Base Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -### AzureOperationalStoreParameters +### AzureBackupParams #### Properties -* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing -* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. - - -## UserFacingError -### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. - -## InnerError -### Properties -* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. -* **code**: string: Unique code for this error -* **embeddedInnerError**: [InnerError](#innererror): Inner Error +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## InnerErrorAdditionalInfo -### Properties -### Additional Properties -* **Additional Properties Type**: string -## UserFacingErrorProperties +## BackupSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -## ProtectionStatusDetails +## BackupVault ### Properties -* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user -* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings ## BaseBackupPolicy * **Discriminator**: objectType @@ -196,78 +126,122 @@ * **objectType**: 'AzureRetentionRule' (Required) -## BackupParameters +## CopyOption * **Discriminator**: objectType ### Base Properties -### AzureBackupParams +### CopyOnExpiryOption #### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + + +## Datasource +### Properties +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. +## DatasourceSet +### Properties +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. ## DataStoreInfoBase ### Properties * **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive * **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type -## TriggerContext +## DataStoreParameters * **Discriminator**: objectType ### Base Properties -### AdhocBasedTriggerContext +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +### AzureOperationalStoreParameters #### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria +* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing +* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -### ScheduleBasedTriggerContext + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption #### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing -## AdhocBasedTaggingCriteria +## DppIdentityDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None -## RetentionTag +## DppTrackedResourceTags ### Properties -* **eTag**: string (ReadOnly): Retention Tag version. -* **id**: string (ReadOnly): Retention Tag version. -* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. +### Additional Properties +* **Additional Properties Type**: string -## BackupSchedule +## InnerError ### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. +* **code**: string: Unique code for this error +* **embeddedInnerError**: [InnerError](#innererror): Inner Error -## TaggingCriteria +## InnerErrorAdditionalInfo ### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag +### Additional Properties +* **Additional Properties Type**: string -## BackupCriteria -* **Discriminator**: objectType +## PolicyInfo +### Properties +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters + +## ProtectionStatusDetails +### Properties +* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user +* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource +## RetentionTag +### Properties +* **eTag**: string (ReadOnly): Retention Tag version. +* **id**: string (ReadOnly): Retention Tag version. +* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource ## SourceLifeCycle ### Properties @@ -275,36 +249,62 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption +### AdhocBasedTriggerContext #### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### CustomCopyOption +### ScheduleBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -### ImmediateCopyOption -#### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +## UserFacingError +### Properties +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. + +## UserFacingErrorProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2021-07-01/types.md b/generated/dataprotection/microsoft.dataprotection/2021-07-01/types.md index ac2711a183..f107299770 100644 --- a/generated/dataprotection/microsoft.dataprotection/2021-07-01/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2021-07-01/types.md @@ -48,45 +48,35 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## BackupCriteria +* **Discriminator**: objectType + +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -101,20 +91,75 @@ * **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed -## AuthCredentials +## BackupParameters * **Discriminator**: objectType ### Base Properties -### SecretStoreBasedAuthCredentials +### AzureBackupParams #### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## SecretStoreResource +## BackupSchedule ### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time + +## BackupVault +### Properties +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings + +## BaseBackupPolicy +* **Discriminator**: objectType + +### Base Properties +* **datasourceTypes**: string[] (Required): Type of datasource for the backup management +### BackupPolicy +#### Properties +* **objectType**: 'BackupPolicy' (Required) +* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + + +## BasePolicyRule +* **Discriminator**: objectType + +### Base Properties +* **name**: string (Required) +### AzureBackupRule +#### Properties +* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **objectType**: 'AzureBackupRule' (Required) +* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context + +### AzureRetentionRule +#### Properties +* **isDefault**: bool +* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle +* **objectType**: 'AzureRetentionRule' (Required) + + +## CopyOption +* **Discriminator**: objectType + +### Base Properties +### CopyOnExpiryOption +#### Properties +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + ## Datasource ### Properties @@ -136,15 +181,10 @@ * **resourceType**: string: Resource Type of Datasource. * **resourceUri**: string: Uri of the resource. -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## DataStoreInfoBase ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type ## DataStoreParameters * **Discriminator**: objectType @@ -157,17 +197,36 @@ * **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -## UserFacingError +## Day ### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption +#### Properties +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing + + +## DppIdentityDetails +### Properties +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## InnerError ### Properties @@ -180,80 +239,41 @@ ### Additional Properties * **Additional Properties Type**: string -## UserFacingErrorProperties +## PolicyInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters ## ProtectionStatusDetails ### Properties * **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user * **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## BaseBackupPolicy -* **Discriminator**: objectType - -### Base Properties -* **datasourceTypes**: string[] (Required): Type of datasource for the backup management -### BackupPolicy -#### Properties -* **objectType**: 'BackupPolicy' (Required) -* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - -## BasePolicyRule -* **Discriminator**: objectType - -### Base Properties -* **name**: string (Required) -### AzureBackupRule -#### Properties -* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **objectType**: 'AzureBackupRule' (Required) -* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context - -### AzureRetentionRule -#### Properties -* **isDefault**: bool -* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle -* **objectType**: 'AzureRetentionRule' (Required) - - -## BackupParameters -* **Discriminator**: objectType - -### Base Properties -### AzureBackupParams -#### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - - -## DataStoreInfoBase +## ResourceGuard ### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type - -## TriggerContext -* **Discriminator**: objectType - -### Base Properties -### AdhocBasedTriggerContext -#### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria - -### ScheduleBasedTriggerContext -#### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. +* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource +* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard +## ResourceGuardOperation +### Properties +* **requestResourceType**: string (ReadOnly): Type of resource request. +* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## AdhocBasedTaggingCriteria +## ResourceMoveDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation ## RetentionTag ### Properties @@ -261,38 +281,10 @@ * **id**: string (ReadOnly): Retention Tag version. * **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## BackupSchedule -### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time - -## TaggingCriteria -### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag - -## BackupCriteria -* **Discriminator**: objectType - -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last - - -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource ## SourceLifeCycle ### Properties @@ -300,53 +292,61 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing - -### CustomCopyOption +### AdhocBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### ImmediateCopyOption +### ScheduleBasedTriggerContext #### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -## ResourceGuard -### Properties -* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. -* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource -* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard - -## ResourceGuardOperation +## UserFacingError ### Properties -* **requestResourceType**: string (ReadOnly): Type of resource request. -* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. -## DppTrackedResourceTags +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2021-10-01-preview/types.md b/generated/dataprotection/microsoft.dataprotection/2021-10-01-preview/types.md index f6365cce0b..93e754a675 100644 --- a/generated/dataprotection/microsoft.dataprotection/2021-10-01-preview/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2021-10-01-preview/types.md @@ -48,58 +48,9 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails -### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None - -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings - -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation - -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupInstance +## AdhocBasedTaggingCriteria ### Properties -* **currentProtectionState**: 'BackupSchedulesSuspended' | 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'Invalid' | 'NotProtected' | 'ProtectionConfigured' | 'ProtectionError' | 'ProtectionStopped' | 'RetentionSchedulesSuspended' | 'SoftDeleted' | 'SoftDeleting' | 'UpdatingProtection' | string (ReadOnly): Specifies the current protection state of the resource -* **datasourceAuthCredentials**: [AuthCredentials](#authcredentials): Base class for different types of authentication credentials. -* **dataSourceInfo**: [Datasource](#datasource) (Required): Datasource to be backed up -* **dataSourceSetInfo**: [DatasourceSet](#datasourceset): DatasourceSet details of datasource to be backed up -* **friendlyName**: string: Gets or sets the Backup Instance friendly name. -* **objectType**: string (Required) -* **policyInfo**: [PolicyInfo](#policyinfo) (Required): Policy Info in backupInstance -* **protectionErrorDetails**: [UserFacingError](#userfacingerror) (ReadOnly): Error object used by layers that have access to localized content, and propagate that to user -* **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details -* **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag ## AuthCredentials * **Discriminator**: objectType @@ -111,96 +62,56 @@ * **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## SecretStoreResource -### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource - -## Datasource -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceProperties**: [BaseResourceProperties](#baseresourceproperties): Properties which are specific to datasource/datasourcesets/backupinstanceref/backupsettings -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## BaseResourceProperties +## BackupCriteria * **Discriminator**: objectType ### Base Properties -### VmwareVMProperties +### ScheduleBasedBackupCriteria #### Properties -* **instanceUuid**: string: Unique Identifier of Vmware VM on VCenter (guid) -* **objectType**: 'VmwareVMProperties' (Required): Type of the specific object - used for deserializing +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DatasourceSet -### Properties -* **datasourceType**: string: DatasourceType of the resource. -* **objectType**: string: Type of Datasource object, used to initialize the right inherited type -* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. -* **resourceLocation**: string: Location of datasource. -* **resourceName**: string: Unique identifier of the resource in the context of parent. -* **resourceProperties**: [BaseResourceProperties](#baseresourceproperties): Properties which are specific to datasource/datasourcesets/backupinstanceref/backupsettings -* **resourceType**: string: Resource Type of Datasource. -* **resourceUri**: string: Uri of the resource. - -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## BackupInstance ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **currentProtectionState**: 'BackupSchedulesSuspended' | 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'Invalid' | 'NotProtected' | 'ProtectionConfigured' | 'ProtectionError' | 'ProtectionStopped' | 'RetentionSchedulesSuspended' | 'SoftDeleted' | 'SoftDeleting' | 'UpdatingProtection' | string (ReadOnly): Specifies the current protection state of the resource +* **datasourceAuthCredentials**: [AuthCredentials](#authcredentials): Base class for different types of authentication credentials. +* **dataSourceInfo**: [Datasource](#datasource) (Required): Datasource to be backed up +* **dataSourceSetInfo**: [DatasourceSet](#datasourceset): DatasourceSet details of datasource to be backed up +* **friendlyName**: string: Gets or sets the Backup Instance friendly name. +* **objectType**: string (Required) +* **policyInfo**: [PolicyInfo](#policyinfo) (Required): Policy Info in backupInstance +* **protectionErrorDetails**: [UserFacingError](#userfacingerror) (ReadOnly): Error object used by layers that have access to localized content, and propagate that to user +* **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details +* **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed -## DataStoreParameters +## BackupParameters * **Discriminator**: objectType ### Base Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -### AzureOperationalStoreParameters +### AzureBackupParams #### Properties -* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing -* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. - - -## UserFacingError -### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. - -## InnerError -### Properties -* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. -* **code**: string: Unique code for this error -* **embeddedInnerError**: [InnerError](#innererror): Inner Error +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## InnerErrorAdditionalInfo -### Properties -### Additional Properties -* **Additional Properties Type**: string -## UserFacingErrorProperties +## BackupSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time -## ProtectionStatusDetails +## BackupVault ### Properties -* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user -* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings ## BaseBackupPolicy * **Discriminator**: objectType @@ -232,73 +143,70 @@ * **objectType**: 'AzureRetentionRule' (Required) -## BackupParameters +## BaseResourceProperties * **Discriminator**: objectType ### Base Properties -### AzureBackupParams +### VmwareVMProperties #### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - +* **instanceUuid**: string: Unique Identifier of Vmware VM on VCenter (guid) +* **objectType**: 'VmwareVMProperties' (Required): Type of the specific object - used for deserializing -## DataStoreInfoBase -### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type -## TriggerContext +## CopyOption * **Discriminator**: objectType ### Base Properties -### AdhocBasedTriggerContext +### CopyOnExpiryOption #### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing -### ScheduleBasedTriggerContext +### CustomCopyOption #### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing -## AdhocBasedTaggingCriteria -### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## RetentionTag +## Datasource ### Properties -* **eTag**: string (ReadOnly): Retention Tag version. -* **id**: string (ReadOnly): Retention Tag version. -* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceProperties**: [BaseResourceProperties](#baseresourceproperties): Properties which are specific to datasource/datasourcesets/backupinstanceref/backupsettings +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. -## BackupSchedule +## DatasourceSet ### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time +* **datasourceType**: string: DatasourceType of the resource. +* **objectType**: string: Type of Datasource object, used to initialize the right inherited type +* **resourceID**: string (Required): Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. +* **resourceLocation**: string: Location of datasource. +* **resourceName**: string: Unique identifier of the resource in the context of parent. +* **resourceProperties**: [BaseResourceProperties](#baseresourceproperties): Properties which are specific to datasource/datasourcesets/backupinstanceref/backupsettings +* **resourceType**: string: Resource Type of Datasource. +* **resourceUri**: string: Uri of the resource. -## TaggingCriteria +## DataStoreInfoBase ### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type -## BackupCriteria +## DataStoreParameters * **Discriminator**: objectType ### Base Properties -### ScheduleBasedBackupCriteria +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +### AzureOperationalStoreParameters #### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last +* **objectType**: 'AzureOperationalStoreParameters' (Required): Type of the specific object - used for deserializing +* **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. ## Day @@ -306,12 +214,6 @@ and should be part of AbsoluteMarker enum * **date**: int: Date of the month * **isLast**: bool: Whether Date is last date of month -## SourceLifeCycle -### Properties -* **deleteAfter**: [DeleteOption](#deleteoption) (Required): Delete Option -* **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting - ## DeleteOption * **Discriminator**: objectType @@ -322,28 +224,47 @@ and should be part of AbsoluteMarker enum * **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing -## TargetCopySetting +## DppIdentityDetails ### Properties -* **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None -## CopyOption -* **Discriminator**: objectType +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -### CustomCopyOption -#### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +## InnerError +### Properties +* **additionalInfo**: [InnerErrorAdditionalInfo](#innererroradditionalinfo): Any Key value pairs that can be provided to the client for additional verbose information. +* **code**: string: Unique code for this error +* **embeddedInnerError**: [InnerError](#innererror): Inner Error -### ImmediateCopyOption -#### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +## InnerErrorAdditionalInfo +### Properties +### Additional Properties +* **Additional Properties Type**: string +## PolicyInfo +### Properties +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters + +## ProtectionStatusDetails +### Properties +* **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user +* **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource ## ResourceGuard ### Properties @@ -358,7 +279,86 @@ and should be part of AbsoluteMarker enum * **requestResourceType**: string (ReadOnly): Type of resource request. * **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## DppTrackedResourceTags +## ResourceMoveDetails +### Properties +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation + +## RetentionTag +### Properties +* **eTag**: string (ReadOnly): Retention Tag version. +* **id**: string (ReadOnly): Retention Tag version. +* **tagName**: string (Required): Retention Tag Name to relate it to retention rule. + +## SecretStoreResource +### Properties +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource + +## SourceLifeCycle +### Properties +* **deleteAfter**: [DeleteOption](#deleteoption) (Required): Delete Option +* **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting + +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag + +## TargetCopySetting +### Properties +* **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base + +## TriggerContext +* **Discriminator**: objectType + +### Base Properties +### AdhocBasedTriggerContext +#### Properties +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria + +### ScheduleBasedTriggerContext +#### Properties +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. + + +## UserFacingError +### Properties +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. + +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2021-12-01-preview/types.md b/generated/dataprotection/microsoft.dataprotection/2021-12-01-preview/types.md index 92922eabf8..dadb6cdf67 100644 --- a/generated/dataprotection/microsoft.dataprotection/2021-12-01-preview/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2021-12-01-preview/types.md @@ -48,45 +48,35 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## BackupCriteria +* **Discriminator**: objectType + +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -101,20 +91,75 @@ * **protectionStatus**: [ProtectionStatusDetails](#protectionstatusdetails) (ReadOnly): Protection status details * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed -## AuthCredentials +## BackupParameters * **Discriminator**: objectType ### Base Properties -### SecretStoreBasedAuthCredentials +### AzureBackupParams #### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## SecretStoreResource +## BackupSchedule ### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time + +## BackupVault +### Properties +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings + +## BaseBackupPolicy +* **Discriminator**: objectType + +### Base Properties +* **datasourceTypes**: string[] (Required): Type of datasource for the backup management +### BackupPolicy +#### Properties +* **objectType**: 'BackupPolicy' (Required) +* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + + +## BasePolicyRule +* **Discriminator**: objectType + +### Base Properties +* **name**: string (Required) +### AzureBackupRule +#### Properties +* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **objectType**: 'AzureBackupRule' (Required) +* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context + +### AzureRetentionRule +#### Properties +* **isDefault**: bool +* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle +* **objectType**: 'AzureRetentionRule' (Required) + + +## CopyOption +* **Discriminator**: objectType + +### Base Properties +### CopyOnExpiryOption +#### Properties +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + ## Datasource ### Properties @@ -136,15 +181,10 @@ * **resourceType**: string: Resource Type of Datasource. * **resourceUri**: string: Uri of the resource. -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## DataStoreInfoBase ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type ## DataStoreParameters * **Discriminator**: objectType @@ -157,17 +197,36 @@ * **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -## UserFacingError +## Day ### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption +#### Properties +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing + + +## DppIdentityDetails +### Properties +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## InnerError ### Properties @@ -180,80 +239,41 @@ ### Additional Properties * **Additional Properties Type**: string -## UserFacingErrorProperties +## PolicyInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters ## ProtectionStatusDetails ### Properties * **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user * **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## BaseBackupPolicy -* **Discriminator**: objectType - -### Base Properties -* **datasourceTypes**: string[] (Required): Type of datasource for the backup management -### BackupPolicy -#### Properties -* **objectType**: 'BackupPolicy' (Required) -* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - -## BasePolicyRule -* **Discriminator**: objectType - -### Base Properties -* **name**: string (Required) -### AzureBackupRule -#### Properties -* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **objectType**: 'AzureBackupRule' (Required) -* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context - -### AzureRetentionRule -#### Properties -* **isDefault**: bool -* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle -* **objectType**: 'AzureRetentionRule' (Required) - - -## BackupParameters -* **Discriminator**: objectType - -### Base Properties -### AzureBackupParams -#### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - - -## DataStoreInfoBase +## ResourceGuard ### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type - -## TriggerContext -* **Discriminator**: objectType - -### Base Properties -### AdhocBasedTriggerContext -#### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria - -### ScheduleBasedTriggerContext -#### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. +* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource +* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard +## ResourceGuardOperation +### Properties +* **requestResourceType**: string (ReadOnly): Type of resource request. +* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## AdhocBasedTaggingCriteria +## ResourceMoveDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation ## RetentionTag ### Properties @@ -261,38 +281,10 @@ * **id**: string (ReadOnly): Retention Tag version. * **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## BackupSchedule -### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time - -## TaggingCriteria -### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag - -## BackupCriteria -* **Discriminator**: objectType - -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last - - -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource ## SourceLifeCycle ### Properties @@ -300,53 +292,61 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing - -### CustomCopyOption +### AdhocBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### ImmediateCopyOption +### ScheduleBasedTriggerContext #### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -## ResourceGuard -### Properties -* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. -* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource -* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard - -## ResourceGuardOperation +## UserFacingError ### Properties -* **requestResourceType**: string (ReadOnly): Type of resource request. -* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. -## DppTrackedResourceTags +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2022-01-01/types.md b/generated/dataprotection/microsoft.dataprotection/2022-01-01/types.md index 77baa76737..3d946b85f7 100644 --- a/generated/dataprotection/microsoft.dataprotection/2022-01-01/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2022-01-01/types.md @@ -48,45 +48,35 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## BackupCriteria +* **Discriminator**: objectType + +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -102,21 +92,75 @@ * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed * **validationType**: 'DeepValidation' | 'ShallowValidation' | string: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. -## AuthCredentials +## BackupParameters * **Discriminator**: objectType ### Base Properties -### SecretStoreBasedAuthCredentials +### AzureBackupParams #### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## SecretStoreResource +## BackupSchedule ### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource -* **value**: string: Gets or sets value stored in secret store resource +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time + +## BackupVault +### Properties +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings + +## BaseBackupPolicy +* **Discriminator**: objectType + +### Base Properties +* **datasourceTypes**: string[] (Required): Type of datasource for the backup management +### BackupPolicy +#### Properties +* **objectType**: 'BackupPolicy' (Required) +* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + + +## BasePolicyRule +* **Discriminator**: objectType + +### Base Properties +* **name**: string (Required) +### AzureBackupRule +#### Properties +* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **objectType**: 'AzureBackupRule' (Required) +* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context + +### AzureRetentionRule +#### Properties +* **isDefault**: bool +* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle +* **objectType**: 'AzureRetentionRule' (Required) + + +## CopyOption +* **Discriminator**: objectType + +### Base Properties +### CopyOnExpiryOption +#### Properties +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + ## Datasource ### Properties @@ -138,15 +182,10 @@ * **resourceType**: string: Resource Type of Datasource. * **resourceUri**: string: Uri of the resource. -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## DataStoreInfoBase ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type ## DataStoreParameters * **Discriminator**: objectType @@ -159,17 +198,36 @@ * **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -## UserFacingError +## Day ### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption +#### Properties +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing + + +## DppIdentityDetails +### Properties +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## InnerError ### Properties @@ -182,80 +240,41 @@ ### Additional Properties * **Additional Properties Type**: string -## UserFacingErrorProperties +## PolicyInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters ## ProtectionStatusDetails ### Properties * **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user * **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## BaseBackupPolicy -* **Discriminator**: objectType - -### Base Properties -* **datasourceTypes**: string[] (Required): Type of datasource for the backup management -### BackupPolicy -#### Properties -* **objectType**: 'BackupPolicy' (Required) -* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - -## BasePolicyRule -* **Discriminator**: objectType - -### Base Properties -* **name**: string (Required) -### AzureBackupRule -#### Properties -* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **objectType**: 'AzureBackupRule' (Required) -* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context - -### AzureRetentionRule -#### Properties -* **isDefault**: bool -* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle -* **objectType**: 'AzureRetentionRule' (Required) - - -## BackupParameters -* **Discriminator**: objectType - -### Base Properties -### AzureBackupParams -#### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - - -## DataStoreInfoBase +## ResourceGuard ### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type - -## TriggerContext -* **Discriminator**: objectType - -### Base Properties -### AdhocBasedTriggerContext -#### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria - -### ScheduleBasedTriggerContext -#### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. +* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource +* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard +## ResourceGuardOperation +### Properties +* **requestResourceType**: string (ReadOnly): Type of resource request. +* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## AdhocBasedTaggingCriteria +## ResourceMoveDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation ## RetentionTag ### Properties @@ -263,38 +282,11 @@ * **id**: string (ReadOnly): Retention Tag version. * **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## BackupSchedule -### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time - -## TaggingCriteria -### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag - -## BackupCriteria -* **Discriminator**: objectType - -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last - - -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource +* **value**: string: Gets or sets value stored in secret store resource ## SourceLifeCycle ### Properties @@ -302,53 +294,61 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing - -### CustomCopyOption +### AdhocBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### ImmediateCopyOption +### ScheduleBasedTriggerContext #### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -## ResourceGuard -### Properties -* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. -* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource -* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard - -## ResourceGuardOperation +## UserFacingError ### Properties -* **requestResourceType**: string (ReadOnly): Type of resource request. -* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. -## DppTrackedResourceTags +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2022-02-01-preview/types.md b/generated/dataprotection/microsoft.dataprotection/2022-02-01-preview/types.md index 324fd53ada..a491c912ab 100644 --- a/generated/dataprotection/microsoft.dataprotection/2022-02-01-preview/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2022-02-01-preview/types.md @@ -48,54 +48,39 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **monitoringSettings**: [MonitoringSettings](#monitoringsettings): Monitoring Settings -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType + +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## MonitoringSettings -### Properties -* **azureMonitorAlertSettings**: [AzureMonitorAlertSettings](#azuremonitoralertsettings): Settings for Azure Monitor based alerts ## AzureMonitorAlertSettings ### Properties * **alertsForAllJobFailures**: 'Disabled' | 'Enabled' | string -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation - -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. +## BackupCriteria +* **Discriminator**: objectType -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -111,21 +96,76 @@ * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed * **validationType**: 'DeepValidation' | 'ShallowValidation' | string: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. -## AuthCredentials +## BackupParameters * **Discriminator**: objectType ### Base Properties -### SecretStoreBasedAuthCredentials +### AzureBackupParams #### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## SecretStoreResource +## BackupSchedule ### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource -* **value**: string: Gets or sets value stored in secret store resource +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time + +## BackupVault +### Properties +* **monitoringSettings**: [MonitoringSettings](#monitoringsettings): Monitoring Settings +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings + +## BaseBackupPolicy +* **Discriminator**: objectType + +### Base Properties +* **datasourceTypes**: string[] (Required): Type of datasource for the backup management +### BackupPolicy +#### Properties +* **objectType**: 'BackupPolicy' (Required) +* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + + +## BasePolicyRule +* **Discriminator**: objectType + +### Base Properties +* **name**: string (Required) +### AzureBackupRule +#### Properties +* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **objectType**: 'AzureBackupRule' (Required) +* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context + +### AzureRetentionRule +#### Properties +* **isDefault**: bool +* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle +* **objectType**: 'AzureRetentionRule' (Required) + + +## CopyOption +* **Discriminator**: objectType + +### Base Properties +### CopyOnExpiryOption +#### Properties +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + ## Datasource ### Properties @@ -147,15 +187,10 @@ * **resourceType**: string: Resource Type of Datasource. * **resourceUri**: string: Uri of the resource. -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## DataStoreInfoBase ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type ## DataStoreParameters * **Discriminator**: objectType @@ -168,17 +203,36 @@ * **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -## UserFacingError +## Day ### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption +#### Properties +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing + + +## DppIdentityDetails +### Properties +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## InnerError ### Properties @@ -191,80 +245,45 @@ ### Additional Properties * **Additional Properties Type**: string -## UserFacingErrorProperties +## MonitoringSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureMonitorAlertSettings**: [AzureMonitorAlertSettings](#azuremonitoralertsettings): Settings for Azure Monitor based alerts + +## PolicyInfo +### Properties +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters ## ProtectionStatusDetails ### Properties * **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user * **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## BaseBackupPolicy -* **Discriminator**: objectType - -### Base Properties -* **datasourceTypes**: string[] (Required): Type of datasource for the backup management -### BackupPolicy -#### Properties -* **objectType**: 'BackupPolicy' (Required) -* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - -## BasePolicyRule -* **Discriminator**: objectType - -### Base Properties -* **name**: string (Required) -### AzureBackupRule -#### Properties -* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **objectType**: 'AzureBackupRule' (Required) -* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context - -### AzureRetentionRule -#### Properties -* **isDefault**: bool -* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle -* **objectType**: 'AzureRetentionRule' (Required) - - -## BackupParameters -* **Discriminator**: objectType - -### Base Properties -### AzureBackupParams -#### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - - -## DataStoreInfoBase +## ResourceGuard ### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type - -## TriggerContext -* **Discriminator**: objectType - -### Base Properties -### AdhocBasedTriggerContext -#### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria - -### ScheduleBasedTriggerContext -#### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. +* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource +* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard +## ResourceGuardOperation +### Properties +* **requestResourceType**: string (ReadOnly): Type of resource request. +* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## AdhocBasedTaggingCriteria +## ResourceMoveDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation ## RetentionTag ### Properties @@ -272,38 +291,11 @@ * **id**: string (ReadOnly): Retention Tag version. * **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## BackupSchedule -### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time - -## TaggingCriteria -### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag - -## BackupCriteria -* **Discriminator**: objectType - -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last - - -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource +* **value**: string: Gets or sets value stored in secret store resource ## SourceLifeCycle ### Properties @@ -311,53 +303,61 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing - -### CustomCopyOption +### AdhocBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### ImmediateCopyOption +### ScheduleBasedTriggerContext #### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing - +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -## ResourceGuard -### Properties -* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. -* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource -* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard -## ResourceGuardOperation +## UserFacingError ### Properties -* **requestResourceType**: string (ReadOnly): Type of resource request. -* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. -## DppTrackedResourceTags +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2022-03-01/types.md b/generated/dataprotection/microsoft.dataprotection/2022-03-01/types.md index 1d1fd82573..29253004b3 100644 --- a/generated/dataprotection/microsoft.dataprotection/2022-03-01/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2022-03-01/types.md @@ -48,45 +48,35 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## BackupCriteria +* **Discriminator**: objectType + +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -102,21 +92,75 @@ * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed * **validationType**: 'DeepValidation' | 'ShallowValidation' | string: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. -## AuthCredentials +## BackupParameters * **Discriminator**: objectType ### Base Properties -### SecretStoreBasedAuthCredentials +### AzureBackupParams #### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## SecretStoreResource +## BackupSchedule ### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource -* **value**: string: Gets or sets value stored in secret store resource +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time + +## BackupVault +### Properties +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings + +## BaseBackupPolicy +* **Discriminator**: objectType + +### Base Properties +* **datasourceTypes**: string[] (Required): Type of datasource for the backup management +### BackupPolicy +#### Properties +* **objectType**: 'BackupPolicy' (Required) +* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + + +## BasePolicyRule +* **Discriminator**: objectType + +### Base Properties +* **name**: string (Required) +### AzureBackupRule +#### Properties +* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **objectType**: 'AzureBackupRule' (Required) +* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context + +### AzureRetentionRule +#### Properties +* **isDefault**: bool +* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle +* **objectType**: 'AzureRetentionRule' (Required) + + +## CopyOption +* **Discriminator**: objectType + +### Base Properties +### CopyOnExpiryOption +#### Properties +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + ## Datasource ### Properties @@ -138,15 +182,10 @@ * **resourceType**: string: Resource Type of Datasource. * **resourceUri**: string: Uri of the resource. -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## DataStoreInfoBase ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type ## DataStoreParameters * **Discriminator**: objectType @@ -159,17 +198,36 @@ * **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -## UserFacingError +## Day ### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption +#### Properties +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing + + +## DppIdentityDetails +### Properties +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## InnerError ### Properties @@ -182,80 +240,41 @@ ### Additional Properties * **Additional Properties Type**: string -## UserFacingErrorProperties +## PolicyInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters ## ProtectionStatusDetails ### Properties * **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user * **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## BaseBackupPolicy -* **Discriminator**: objectType - -### Base Properties -* **datasourceTypes**: string[] (Required): Type of datasource for the backup management -### BackupPolicy -#### Properties -* **objectType**: 'BackupPolicy' (Required) -* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - -## BasePolicyRule -* **Discriminator**: objectType - -### Base Properties -* **name**: string (Required) -### AzureBackupRule -#### Properties -* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **objectType**: 'AzureBackupRule' (Required) -* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context - -### AzureRetentionRule -#### Properties -* **isDefault**: bool -* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle -* **objectType**: 'AzureRetentionRule' (Required) - - -## BackupParameters -* **Discriminator**: objectType - -### Base Properties -### AzureBackupParams -#### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - - -## DataStoreInfoBase +## ResourceGuard ### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type - -## TriggerContext -* **Discriminator**: objectType - -### Base Properties -### AdhocBasedTriggerContext -#### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria - -### ScheduleBasedTriggerContext -#### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. +* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource +* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard +## ResourceGuardOperation +### Properties +* **requestResourceType**: string (ReadOnly): Type of resource request. +* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## AdhocBasedTaggingCriteria +## ResourceMoveDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation ## RetentionTag ### Properties @@ -263,38 +282,11 @@ * **id**: string (ReadOnly): Retention Tag version. * **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## BackupSchedule -### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time - -## TaggingCriteria -### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag - -## BackupCriteria -* **Discriminator**: objectType - -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last - - -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource +* **value**: string: Gets or sets value stored in secret store resource ## SourceLifeCycle ### Properties @@ -302,53 +294,61 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing - -### CustomCopyOption +### AdhocBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### ImmediateCopyOption +### ScheduleBasedTriggerContext #### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -## ResourceGuard -### Properties -* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. -* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource -* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard - -## ResourceGuardOperation +## UserFacingError ### Properties -* **requestResourceType**: string (ReadOnly): Type of resource request. -* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. -## DppTrackedResourceTags +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/dataprotection/microsoft.dataprotection/2022-03-31-preview/types.md b/generated/dataprotection/microsoft.dataprotection/2022-03-31-preview/types.md index 4b366f17ef..a822875d7e 100644 --- a/generated/dataprotection/microsoft.dataprotection/2022-03-31-preview/types.md +++ b/generated/dataprotection/microsoft.dataprotection/2022-03-31-preview/types.md @@ -48,54 +48,39 @@ * **tags**: [DppTrackedResourceTags](#dpptrackedresourcetags): Resource tags. * **type**: 'Microsoft.DataProtection/resourceGuards' (ReadOnly, DeployTimeConstant): The resource type -## DppIdentityDetails +## AdhocBasedTaggingCriteria ### Properties -* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. -* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. -* **type**: string: The identityType which can be either SystemAssigned or None +* **tagInfo**: [RetentionTag](#retentiontag): Retention tag -## BackupVault -### Properties -* **monitoringSettings**: [MonitoringSettings](#monitoringsettings): Monitoring Settings -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM -* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault -* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings +## AuthCredentials +* **Discriminator**: objectType + +### Base Properties +### SecretStoreBasedAuthCredentials +#### Properties +* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing +* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. -## MonitoringSettings -### Properties -* **azureMonitorAlertSettings**: [AzureMonitorAlertSettings](#azuremonitoralertsettings): Settings for Azure Monitor based alerts ## AzureMonitorAlertSettings ### Properties * **alertsForAllJobFailures**: 'Disabled' | 'Enabled' | string -## ResourceMoveDetails -### Properties -* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **operationId**: string: CorrelationId of latest ResourceMove operation attempted -* **sourceResourcePath**: string: ARM resource path of source resource -* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. -* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation - -## StorageSetting -### Properties -* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. -* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. +## BackupCriteria +* **Discriminator**: objectType -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### Base Properties +### ScheduleBasedBackupCriteria +#### Properties +* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" +and should be part of AbsoluteMarker enum +* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December +* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing +* **scheduleTimes**: string[]: List of schedule times for backup +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last -## DppTrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## BackupInstance ### Properties @@ -111,21 +96,76 @@ * **provisioningState**: string (ReadOnly): Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed * **validationType**: 'DeepValidation' | 'ShallowValidation' | string: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. -## AuthCredentials +## BackupParameters * **Discriminator**: objectType ### Base Properties -### SecretStoreBasedAuthCredentials +### AzureBackupParams #### Properties -* **objectType**: 'SecretStoreBasedAuthCredentials' (Required): Type of the specific object - used for deserializing -* **secretStoreResource**: [SecretStoreResource](#secretstoreresource): Class representing a secret store resource. +* **backupType**: string (Required): BackupType ; Full/Incremental etc +* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing -## SecretStoreResource +## BackupSchedule ### Properties -* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store -* **uri**: string: Uri to get to the resource -* **value**: string: Gets or sets value stored in secret store resource +* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format +* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time + +## BackupVault +### Properties +* **monitoringSettings**: [MonitoringSettings](#monitoringsettings): Monitoring Settings +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceMoveDetails**: [ResourceMoveDetails](#resourcemovedetails) (ReadOnly): ResourceMoveDetails will be returned in response to GetResource call from ARM +* **resourceMoveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failed' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): Resource move state for backup vault +* **storageSettings**: [StorageSetting](#storagesetting)[] (Required): Storage Settings + +## BaseBackupPolicy +* **Discriminator**: objectType + +### Base Properties +* **datasourceTypes**: string[] (Required): Type of datasource for the backup management +### BackupPolicy +#### Properties +* **objectType**: 'BackupPolicy' (Required) +* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc + + +## BasePolicyRule +* **Discriminator**: objectType + +### Base Properties +* **name**: string (Required) +### AzureBackupRule +#### Properties +* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base +* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base +* **objectType**: 'AzureBackupRule' (Required) +* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context + +### AzureRetentionRule +#### Properties +* **isDefault**: bool +* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle +* **objectType**: 'AzureRetentionRule' (Required) + + +## CopyOption +* **Discriminator**: objectType + +### Base Properties +### CopyOnExpiryOption +#### Properties +* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing + +### CustomCopyOption +#### Properties +* **duration**: string: Data copied after given timespan +* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing + +### ImmediateCopyOption +#### Properties +* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing + ## Datasource ### Properties @@ -147,15 +187,10 @@ * **resourceType**: string: Resource Type of Datasource. * **resourceUri**: string: Uri of the resource. -## PolicyInfo -### Properties -* **policyId**: string (Required) -* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy -* **policyVersion**: string (ReadOnly) - -## PolicyParameters +## DataStoreInfoBase ### Properties -* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters +* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive +* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type ## DataStoreParameters * **Discriminator**: objectType @@ -168,17 +203,36 @@ * **resourceGroupId**: string: Gets or sets the Snapshot Resource Group Uri. -## UserFacingError +## Day ### Properties -* **code**: string: Unique code for this error -* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors -* **innerError**: [InnerError](#innererror): Inner Error -* **isRetryable**: bool: Whether the operation will be retryable or not -* **isUserError**: bool: Whether the operation is due to a user error or service error -* **message**: string -* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object -* **recommendedAction**: string[]: RecommendedAction � localized. -* **target**: string: Target of the error. +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DeleteOption +* **Discriminator**: objectType + +### Base Properties +* **duration**: string (Required): Duration of deletion after given timespan +### AbsoluteDeleteOption +#### Properties +* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing + + +## DppIdentityDetails +### Properties +* **principalId**: string (ReadOnly): The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. +* **tenantId**: string (ReadOnly): A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. +* **type**: string: The identityType which can be either SystemAssigned or None + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DppTrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## InnerError ### Properties @@ -191,80 +245,45 @@ ### Additional Properties * **Additional Properties Type**: string -## UserFacingErrorProperties +## MonitoringSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureMonitorAlertSettings**: [AzureMonitorAlertSettings](#azuremonitoralertsettings): Settings for Azure Monitor based alerts + +## PolicyInfo +### Properties +* **policyId**: string (Required) +* **policyParameters**: [PolicyParameters](#policyparameters): Parameters in Policy +* **policyVersion**: string (ReadOnly) + +## PolicyParameters +### Properties +* **dataStoreParametersList**: [DataStoreParameters](#datastoreparameters)[]: Gets or sets the DataStore Parameters ## ProtectionStatusDetails ### Properties * **errorDetails**: [UserFacingError](#userfacingerror): Error object used by layers that have access to localized content, and propagate that to user * **status**: 'ConfiguringProtection' | 'ConfiguringProtectionFailed' | 'ProtectionConfigured' | 'ProtectionStopped' | 'SoftDeleted' | 'SoftDeleting' | string: Specifies the protection status of the resource -## BaseBackupPolicy -* **Discriminator**: objectType - -### Base Properties -* **datasourceTypes**: string[] (Required): Type of datasource for the backup management -### BackupPolicy -#### Properties -* **objectType**: 'BackupPolicy' (Required) -* **policyRules**: [BasePolicyRule](#basepolicyrule)[] (Required): Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc - - -## BasePolicyRule -* **Discriminator**: objectType - -### Base Properties -* **name**: string (Required) -### AzureBackupRule -#### Properties -* **backupParameters**: [BackupParameters](#backupparameters): BackupParameters base -* **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -* **objectType**: 'AzureBackupRule' (Required) -* **trigger**: [TriggerContext](#triggercontext) (Required): Trigger context - -### AzureRetentionRule -#### Properties -* **isDefault**: bool -* **lifecycles**: [SourceLifeCycle](#sourcelifecycle)[] (Required): Array of SourceLifeCycle -* **objectType**: 'AzureRetentionRule' (Required) - - -## BackupParameters -* **Discriminator**: objectType - -### Base Properties -### AzureBackupParams -#### Properties -* **backupType**: string (Required): BackupType ; Full/Incremental etc -* **objectType**: 'AzureBackupParams' (Required): Type of the specific object - used for deserializing - - -## DataStoreInfoBase +## ResourceGuard ### Properties -* **dataStoreType**: 'ArchiveStore' | 'OperationalStore' | 'VaultStore' | string (Required): type of datastore; Operational/Vault/Archive -* **objectType**: string (Required): Type of Datasource object, used to initialize the right inherited type - -## TriggerContext -* **Discriminator**: objectType - -### Base Properties -### AdhocBasedTriggerContext -#### Properties -* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria - -### ScheduleBasedTriggerContext -#### Properties -* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing -* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup -* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. +* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. +* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource +* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource +* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard +## ResourceGuardOperation +### Properties +* **requestResourceType**: string (ReadOnly): Type of resource request. +* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. -## AdhocBasedTaggingCriteria +## ResourceMoveDetails ### Properties -* **tagInfo**: [RetentionTag](#retentiontag): Retention tag +* **completionTimeUtc**: string: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **operationId**: string: CorrelationId of latest ResourceMove operation attempted +* **sourceResourcePath**: string: ARM resource path of source resource +* **startTimeUtc**: string: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. +* **targetResourcePath**: string: ARM resource path of target resource used in latest ResourceMove operation ## RetentionTag ### Properties @@ -272,38 +291,11 @@ * **id**: string (ReadOnly): Retention Tag version. * **tagName**: string (Required): Retention Tag Name to relate it to retention rule. -## BackupSchedule -### Properties -* **repeatingTimeIntervals**: string[] (Required): ISO 8601 repeating time interval format -* **timeZone**: string: Time zone for a schedule. Example: Pacific Standard Time - -## TaggingCriteria -### Properties -* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. -* **isDefault**: bool (Required): Specifies if tag is default. -* **taggingPriority**: int (Required): Retention Tag priority. -* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag - -## BackupCriteria -* **Discriminator**: objectType - -### Base Properties -### ScheduleBasedBackupCriteria -#### Properties -* **absoluteCriteria**: 'AllBackup' | 'FirstOfDay' | 'FirstOfMonth' | 'FirstOfWeek' | 'FirstOfYear' | string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" -and should be part of AbsoluteMarker enum -* **daysOfMonth**: [Day](#day)[]: This is day of the month from 1 to 28 other wise last of month -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: It should be Sunday/Monday/T..../Saturday -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September' | string[]: It should be January/February/....../December -* **objectType**: 'ScheduleBasedBackupCriteria' (Required): Type of the specific object - used for deserializing -* **scheduleTimes**: string[]: List of schedule times for backup -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Last' | 'Second' | 'Third' | string[]: It should be First/Second/Third/Fourth/Last - - -## Day +## SecretStoreResource ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +* **secretStoreType**: 'AzureKeyVault' | 'Invalid' | string (Required): Gets or sets the type of secret store +* **uri**: string: Uri to get to the resource +* **value**: string: Gets or sets value stored in secret store resource ## SourceLifeCycle ### Properties @@ -311,53 +303,61 @@ and should be part of AbsoluteMarker enum * **sourceDataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base * **targetDataStoreCopySettings**: [TargetCopySetting](#targetcopysetting)[]: Array of TargetCopySetting -## DeleteOption -* **Discriminator**: objectType +## StorageSetting +### Properties +* **datastoreType**: 'ArchiveStore' | 'SnapshotStore' | 'VaultStore' | string: Gets or sets the type of the datastore. +* **type**: 'GeoRedundant' | 'LocallyRedundant' | string: Gets or sets the type. -### Base Properties -* **duration**: string (Required): Duration of deletion after given timespan -### AbsoluteDeleteOption -#### Properties -* **objectType**: 'AbsoluteDeleteOption' (Required): Type of the specific object - used for deserializing +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## TaggingCriteria +### Properties +* **criteria**: [BackupCriteria](#backupcriteria)[]: Criteria which decides whether the tag can be applied to a triggered backup. +* **isDefault**: bool (Required): Specifies if tag is default. +* **taggingPriority**: int (Required): Retention Tag priority. +* **tagInfo**: [RetentionTag](#retentiontag) (Required): Retention tag ## TargetCopySetting ### Properties * **copyAfter**: [CopyOption](#copyoption) (Required): Options to copy * **dataStore**: [DataStoreInfoBase](#datastoreinfobase) (Required): DataStoreInfo base -## CopyOption +## TriggerContext * **Discriminator**: objectType ### Base Properties -### CopyOnExpiryOption -#### Properties -* **objectType**: 'CopyOnExpiryOption' (Required): Type of the specific object - used for deserializing - -### CustomCopyOption +### AdhocBasedTriggerContext #### Properties -* **duration**: string: Data copied after given timespan -* **objectType**: 'CustomCopyOption' (Required): Type of the specific object - used for deserializing +* **objectType**: 'AdhocBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **taggingCriteria**: [AdhocBasedTaggingCriteria](#adhocbasedtaggingcriteria) (Required): Adhoc backup tagging criteria -### ImmediateCopyOption +### ScheduleBasedTriggerContext #### Properties -* **objectType**: 'ImmediateCopyOption' (Required): Type of the specific object - used for deserializing - +* **objectType**: 'ScheduleBasedTriggerContext' (Required): Type of the specific object - used for deserializing +* **schedule**: [BackupSchedule](#backupschedule) (Required): Schedule for backup +* **taggingCriteria**: [TaggingCriteria](#taggingcriteria)[] (Required): List of tags that can be applicable for given schedule. -## ResourceGuard -### Properties -* **allowAutoApprovals**: bool (ReadOnly): This flag indicates whether auto approval is allowed or not. -* **description**: string (ReadOnly): Description about the pre-req steps to perform all the critical operations. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the BackupVault resource -* **resourceGuardOperations**: [ResourceGuardOperation](#resourceguardoperation)[] (ReadOnly): {readonly} List of operation details those are protected by the ResourceGuard resource -* **vaultCriticalOperationExclusionList**: string[] (ReadOnly): List of critical operations which are not protected by this resourceGuard -## ResourceGuardOperation +## UserFacingError ### Properties -* **requestResourceType**: string (ReadOnly): Type of resource request. -* **vaultCriticalOperation**: string (ReadOnly): Name of the critical operation. +* **code**: string: Unique code for this error +* **details**: [UserFacingError](#userfacingerror)[]: Additional related Errors +* **innerError**: [InnerError](#innererror): Inner Error +* **isRetryable**: bool: Whether the operation will be retryable or not +* **isUserError**: bool: Whether the operation is due to a user error or service error +* **message**: string +* **properties**: [UserFacingErrorProperties](#userfacingerrorproperties): Any key value pairs that can be injected inside error object +* **recommendedAction**: string[]: RecommendedAction � localized. +* **target**: string: Target of the error. -## DppTrackedResourceTags +## UserFacingErrorProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/datashare/log.out b/generated/datashare/log.out index 84c8dd5348..c57ccf1594 100644 --- a/generated/datashare/log.out +++ b/generated/datashare/log.out @@ -3,35 +3,35 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.datashare-2018-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 21ms info | Processing batch task - {"tag":"microsoft.datashare-2019-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.datashare-2020-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.datashare-2020-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.datashare-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 16ms -info | Autorest completed in 24.91s. 10 files generated. +info | autorest.bicep took 12ms +info | Autorest completed in 23.52s. 10 files generated. diff --git a/generated/datashare/microsoft.datashare/2018-11-01-preview/types.md b/generated/datashare/microsoft.datashare/2018-11-01-preview/types.md index cab4da04ec..d1091665ff 100644 --- a/generated/datashare/microsoft.datashare/2018-11-01-preview/types.md +++ b/generated/datashare/microsoft.datashare/2018-11-01-preview/types.md @@ -226,12 +226,6 @@ * **ApiVersion**: 2018-11-01-preview * **Output**: [ShareSubscriptionSynchronizationList](#sharesubscriptionsynchronizationlist) -## Identity -### Properties -* **principalId**: string (ReadOnly): service principal Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'SystemAssigned' | string: Identity Type - ## AccountProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the account was created. @@ -239,21 +233,6 @@ * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## DefaultDtoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ShareProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the share was created. -* **description**: string: Share description. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. -* **terms**: string: Share terms. -* **userEmail**: string (ReadOnly): Email of the user who created the resource -* **userName**: string (ReadOnly): Name of the user who created the resource - ## AdlsGen1FileProperties ### Properties * **accountName**: string (Required): The ADLS account name. @@ -271,6 +250,18 @@ * **resourceGroup**: string (Required): Resource group of ADLS account. * **subscriptionId**: string (Required): Subscription id of ADLS account. +## AdlsGen2FileDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the file system. +* **fileSystem**: string (Required): File system to which the file belongs. +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -280,6 +271,16 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FileSystemDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): The file system name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileSystemProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -288,6 +289,17 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FolderDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): File system to which the folder belongs. +* **folderPath**: string (Required): Folder path within the file system. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FolderProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -297,61 +309,75 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobProperties +## BlobContainerMappingProperties ### Properties -* **containerName**: string (Required): Container that has the file path. +* **containerName**: string (Required): BLOB Container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + +## BlobContainerProperties +### Properties +* **containerName**: string (Required): BLOB Container name. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobFolderProperties +## BlobFolderMappingProperties ### Properties * **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. * **prefix**: string (Required): Prefix for blob folder -* **resourceGroup**: string (Required): Resource group of storage account -* **storageAccountName**: string (Required): Storage account name of the source data set -* **subscriptionId**: string (Required): Subscription id of storage account +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## BlobContainerProperties +## BlobFolderProperties ### Properties -* **containerName**: string (Required): BLOB Container name. +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **prefix**: string (Required): Prefix for blob folder * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## KustoClusterDataSetProperties +## BlobMappingProperties ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. -* **location**: string (ReadOnly): Location of the kusto cluster. +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the source data set +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## KustoDatabaseDataSetProperties +## BlobProperties ### Properties +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. -* **location**: string (ReadOnly): Location of the kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **filePath**: string (Required): File path within the source data set +* **resourceGroup**: string (Required): Resource group of storage account +* **storageAccountName**: string (Required): Storage account name of the source data set +* **subscriptionId**: string (Required): Subscription id of storage account -## SqlDBTableProperties +## DefaultDtoTags ### Properties -* **databaseName**: string (Required): Database name of the source data set -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DB table name. +### Additional Properties +* **Additional Properties Type**: string -## SqlDWTableProperties +## Identity ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DW table name. +* **principalId**: string (ReadOnly): service principal Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'SystemAssigned' | string: Identity Type ## InvitationProperties ### Properties @@ -367,6 +393,41 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource +## KustoClusterDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoClusterDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## ScheduledSourceShareSynchronizationSettingProperties +### Properties +* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval +* **synchronizationTime**: string (ReadOnly): Synchronization time + ## ScheduledSynchronizationSettingProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the synchronization setting was created. @@ -375,6 +436,26 @@ invitations to specific users or applications in an AD tenant. * **synchronizationTime**: string (Required): Synchronization time * **userName**: string (ReadOnly): Name of the user who created the synchronization setting. +## ScheduledTriggerProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the trigger was created. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval +* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode +* **synchronizationTime**: string (Required): Synchronization time +* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state +* **userName**: string (ReadOnly): Name of the user who created the trigger. + +## ShareProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the share was created. +* **description**: string: Share description. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. +* **terms**: string: Share terms. +* **userEmail**: string (ReadOnly): Email of the user who created the resource +* **userName**: string (ReadOnly): Name of the user who created the resource + ## ShareSubscriptionProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the share subscription was created. @@ -391,87 +472,53 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## AdlsGen2FileDataSetMappingProperties +## ShareSubscriptionSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the file system. -* **fileSystem**: string (Required): File system to which the file belongs. -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration +* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization +* **message**: string (ReadOnly, WriteOnly): message of Synchronization +* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization +* **status**: string (ReadOnly, WriteOnly): Raw Status +* **synchronizationId**: string (Required, WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## AdlsGen2FileSystemDataSetMappingProperties +## ShareSubscriptionSynchronizationList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): The file system name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## AdlsGen2FolderDataSetMappingProperties +## ShareSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): File system to which the folder belongs. -* **folderPath**: string (Required): Folder path within the file system. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization +* **consumerName**: string (WriteOnly): Name of the user who created the synchronization +* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization +* **durationMs**: int (WriteOnly): synchronization duration +* **endTime**: string (WriteOnly): End time of synchronization +* **message**: string (WriteOnly): message of synchronization +* **startTime**: string (WriteOnly): start time of synchronization +* **status**: string (WriteOnly): Raw Status +* **synchronizationId**: string (WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## BlobMappingProperties +## ShareSynchronizationList ### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the source data set -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## BlobFolderMappingProperties -### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **prefix**: string (Required): Prefix for blob folder -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +## SourceShareSynchronizationSetting +* **Discriminator**: kind -## BlobContainerMappingProperties -### Properties -* **containerName**: string (Required): BLOB Container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +### Base Properties +### ScheduledSourceSynchronizationSetting +#### Properties +* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. +* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. -## KustoClusterDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -## KustoDatabaseDataSetMappingProperties +## SourceShareSynchronizationSettingList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. ## SqlDBTableDataSetMappingProperties ### Properties @@ -483,6 +530,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DB table name. +## SqlDBTableProperties +### Properties +* **databaseName**: string (Required): Database name of the source data set +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DB table name. + ## SqlDWTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -493,53 +548,13 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DW table name. -## ScheduledTriggerProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the trigger was created. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval -* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode -* **synchronizationTime**: string (Required): Synchronization time -* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state -* **userName**: string (ReadOnly): Name of the user who created the trigger. - -## SourceShareSynchronizationSettingList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## SourceShareSynchronizationSetting -* **Discriminator**: kind - -### Base Properties -### ScheduledSourceSynchronizationSetting -#### Properties -* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. -* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. - - -## ScheduledSourceShareSynchronizationSettingProperties -### Properties -* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval -* **synchronizationTime**: string (ReadOnly): Synchronization time - -## ShareSynchronization -### Properties -* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization -* **consumerName**: string (WriteOnly): Name of the user who created the synchronization -* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization -* **durationMs**: int (WriteOnly): synchronization duration -* **endTime**: string (WriteOnly): End time of synchronization -* **message**: string (WriteOnly): message of synchronization -* **startTime**: string (WriteOnly): start time of synchronization -* **status**: string (WriteOnly): Raw Status -* **synchronizationId**: string (WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - -## SynchronizationDetailsList +## SqlDWTableProperties ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DW table name. ## SynchronizationDetails ### Properties @@ -559,28 +574,13 @@ invitations to specific users or applications in an AD tenant. * **status**: string (ReadOnly): Raw Status * **vCore**: int (ReadOnly): The vCore units consumed for the data set synchronization -## ShareSubscriptionSynchronization -### Properties -* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration -* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization -* **message**: string (ReadOnly, WriteOnly): message of Synchronization -* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization -* **status**: string (ReadOnly, WriteOnly): Raw Status -* **synchronizationId**: string (Required, WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - ## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. * **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSynchronizationList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## ShareSubscriptionSynchronizationList +## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. diff --git a/generated/datashare/microsoft.datashare/2019-11-01/types.md b/generated/datashare/microsoft.datashare/2019-11-01/types.md index 9b0931d726..6c73adedee 100644 --- a/generated/datashare/microsoft.datashare/2019-11-01/types.md +++ b/generated/datashare/microsoft.datashare/2019-11-01/types.md @@ -226,12 +226,6 @@ * **ApiVersion**: 2019-11-01 * **Output**: [ShareSubscriptionSynchronizationList](#sharesubscriptionsynchronizationlist) -## Identity -### Properties -* **principalId**: string (ReadOnly): service principal Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'SystemAssigned' | string: Identity Type - ## AccountProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the account was created. @@ -239,21 +233,6 @@ * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## DefaultDtoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ShareProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the share was created. -* **description**: string: Share description. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. -* **terms**: string: Share terms. -* **userEmail**: string (ReadOnly): Email of the user who created the resource -* **userName**: string (ReadOnly): Name of the user who created the resource - ## AdlsGen1FileProperties ### Properties * **accountName**: string (Required): The ADLS account name. @@ -271,6 +250,18 @@ * **resourceGroup**: string (Required): Resource group of ADLS account. * **subscriptionId**: string (Required): Subscription id of ADLS account. +## AdlsGen2FileDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the file system. +* **fileSystem**: string (Required): File system to which the file belongs. +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -280,6 +271,16 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FileSystemDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): The file system name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileSystemProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -288,6 +289,17 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FolderDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): File system to which the folder belongs. +* **folderPath**: string (Required): Folder path within the file system. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FolderProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -297,61 +309,75 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobProperties +## BlobContainerMappingProperties ### Properties -* **containerName**: string (Required): Container that has the file path. +* **containerName**: string (Required): BLOB Container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + +## BlobContainerProperties +### Properties +* **containerName**: string (Required): BLOB Container name. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobFolderProperties +## BlobFolderMappingProperties ### Properties * **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. * **prefix**: string (Required): Prefix for blob folder -* **resourceGroup**: string (Required): Resource group of storage account -* **storageAccountName**: string (Required): Storage account name of the source data set -* **subscriptionId**: string (Required): Subscription id of storage account +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## BlobContainerProperties +## BlobFolderProperties ### Properties -* **containerName**: string (Required): BLOB Container name. +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **prefix**: string (Required): Prefix for blob folder * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## KustoClusterDataSetProperties +## BlobMappingProperties ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. -* **location**: string (ReadOnly): Location of the kusto cluster. +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the source data set +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## KustoDatabaseDataSetProperties +## BlobProperties ### Properties +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. -* **location**: string (ReadOnly): Location of the kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **filePath**: string (Required): File path within the source data set +* **resourceGroup**: string (Required): Resource group of storage account +* **storageAccountName**: string (Required): Storage account name of the source data set +* **subscriptionId**: string (Required): Subscription id of storage account -## SqlDBTableProperties +## DefaultDtoTags ### Properties -* **databaseName**: string (Required): Database name of the source data set -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DB table name. +### Additional Properties +* **Additional Properties Type**: string -## SqlDWTableProperties +## Identity ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DW table name. +* **principalId**: string (ReadOnly): service principal Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'SystemAssigned' | string: Identity Type ## InvitationProperties ### Properties @@ -367,6 +393,41 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource +## KustoClusterDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoClusterDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## ScheduledSourceShareSynchronizationSettingProperties +### Properties +* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval +* **synchronizationTime**: string (ReadOnly): Synchronization time + ## ScheduledSynchronizationSettingProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the synchronization setting was created. @@ -375,6 +436,26 @@ invitations to specific users or applications in an AD tenant. * **synchronizationTime**: string (Required): Synchronization time * **userName**: string (ReadOnly): Name of the user who created the synchronization setting. +## ScheduledTriggerProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the trigger was created. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval +* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode +* **synchronizationTime**: string (Required): Synchronization time +* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state +* **userName**: string (ReadOnly): Name of the user who created the trigger. + +## ShareProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the share was created. +* **description**: string: Share description. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. +* **terms**: string: Share terms. +* **userEmail**: string (ReadOnly): Email of the user who created the resource +* **userName**: string (ReadOnly): Name of the user who created the resource + ## ShareSubscriptionProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the share subscription was created. @@ -392,87 +473,53 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## AdlsGen2FileDataSetMappingProperties +## ShareSubscriptionSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the file system. -* **fileSystem**: string (Required): File system to which the file belongs. -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration +* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization +* **message**: string (ReadOnly, WriteOnly): message of Synchronization +* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization +* **status**: string (ReadOnly, WriteOnly): Raw Status +* **synchronizationId**: string (Required, WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## AdlsGen2FileSystemDataSetMappingProperties +## ShareSubscriptionSynchronizationList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): The file system name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## AdlsGen2FolderDataSetMappingProperties +## ShareSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): File system to which the folder belongs. -* **folderPath**: string (Required): Folder path within the file system. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization +* **consumerName**: string (WriteOnly): Name of the user who created the synchronization +* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization +* **durationMs**: int (WriteOnly): synchronization duration +* **endTime**: string (WriteOnly): End time of synchronization +* **message**: string (WriteOnly): message of synchronization +* **startTime**: string (WriteOnly): start time of synchronization +* **status**: string (WriteOnly): Raw Status +* **synchronizationId**: string (WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## BlobMappingProperties +## ShareSynchronizationList ### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the source data set -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## BlobFolderMappingProperties -### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **prefix**: string (Required): Prefix for blob folder -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +## SourceShareSynchronizationSetting +* **Discriminator**: kind -## BlobContainerMappingProperties -### Properties -* **containerName**: string (Required): BLOB Container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +### Base Properties +### ScheduledSourceSynchronizationSetting +#### Properties +* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. +* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. -## KustoClusterDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -## KustoDatabaseDataSetMappingProperties +## SourceShareSynchronizationSettingList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. ## SqlDBTableDataSetMappingProperties ### Properties @@ -484,6 +531,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DB table name. +## SqlDBTableProperties +### Properties +* **databaseName**: string (Required): Database name of the source data set +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DB table name. + ## SqlDWTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -494,53 +549,13 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DW table name. -## ScheduledTriggerProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the trigger was created. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval -* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode -* **synchronizationTime**: string (Required): Synchronization time -* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state -* **userName**: string (ReadOnly): Name of the user who created the trigger. - -## SourceShareSynchronizationSettingList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## SourceShareSynchronizationSetting -* **Discriminator**: kind - -### Base Properties -### ScheduledSourceSynchronizationSetting -#### Properties -* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. -* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. - - -## ScheduledSourceShareSynchronizationSettingProperties -### Properties -* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval -* **synchronizationTime**: string (ReadOnly): Synchronization time - -## ShareSynchronization -### Properties -* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization -* **consumerName**: string (WriteOnly): Name of the user who created the synchronization -* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization -* **durationMs**: int (WriteOnly): synchronization duration -* **endTime**: string (WriteOnly): End time of synchronization -* **message**: string (WriteOnly): message of synchronization -* **startTime**: string (WriteOnly): start time of synchronization -* **status**: string (WriteOnly): Raw Status -* **synchronizationId**: string (WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - -## SynchronizationDetailsList +## SqlDWTableProperties ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DW table name. ## SynchronizationDetails ### Properties @@ -560,28 +575,13 @@ invitations to specific users or applications in an AD tenant. * **status**: string (ReadOnly): Raw Status * **vCore**: int (ReadOnly): The vCore units consumed for the data set synchronization -## ShareSubscriptionSynchronization -### Properties -* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration -* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization -* **message**: string (ReadOnly, WriteOnly): message of Synchronization -* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization -* **status**: string (ReadOnly, WriteOnly): Raw Status -* **synchronizationId**: string (Required, WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - ## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. * **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSynchronizationList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## ShareSubscriptionSynchronizationList +## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. diff --git a/generated/datashare/microsoft.datashare/2020-09-01/types.md b/generated/datashare/microsoft.datashare/2020-09-01/types.md index 74a47bf5fb..7b1dedc915 100644 --- a/generated/datashare/microsoft.datashare/2020-09-01/types.md +++ b/generated/datashare/microsoft.datashare/2020-09-01/types.md @@ -244,12 +244,6 @@ * **ApiVersion**: 2020-09-01 * **Output**: [ShareSubscriptionSynchronizationList](#sharesubscriptionsynchronizationlist) -## Identity -### Properties -* **principalId**: string (ReadOnly): service principal Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'SystemAssigned' | string: Identity Type - ## AccountProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the account was created. @@ -257,30 +251,6 @@ * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. - -## DefaultDtoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ShareProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the share was created. -* **description**: string: Share description. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. -* **terms**: string: Share terms. -* **userEmail**: string (ReadOnly): Email of the user who created the resource -* **userName**: string (ReadOnly): Name of the user who created the resource - ## AdlsGen1FileProperties ### Properties * **accountName**: string (Required): The ADLS account name. @@ -298,6 +268,18 @@ * **resourceGroup**: string (Required): Resource group of ADLS account. * **subscriptionId**: string (Required): Subscription id of ADLS account. +## AdlsGen2FileDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the file system. +* **fileSystem**: string (Required): File system to which the file belongs. +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -307,6 +289,16 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FileSystemDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): The file system name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileSystemProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -315,6 +307,17 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FolderDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): File system to which the folder belongs. +* **folderPath**: string (Required): Folder path within the file system. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FolderProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -324,66 +327,75 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobProperties +## BlobContainerMappingProperties ### Properties -* **containerName**: string (Required): Container that has the file path. +* **containerName**: string (Required): BLOB Container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + +## BlobContainerProperties +### Properties +* **containerName**: string (Required): BLOB Container name. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobFolderProperties +## BlobFolderMappingProperties ### Properties * **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. * **prefix**: string (Required): Prefix for blob folder -* **resourceGroup**: string (Required): Resource group of storage account -* **storageAccountName**: string (Required): Storage account name of the source data set -* **subscriptionId**: string (Required): Subscription id of storage account +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## BlobContainerProperties +## BlobFolderProperties ### Properties -* **containerName**: string (Required): BLOB Container name. +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **prefix**: string (Required): Prefix for blob folder * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## KustoClusterDataSetProperties -### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. -* **location**: string (ReadOnly): Location of the kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account - -## KustoDatabaseDataSetProperties +## BlobMappingProperties ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. -* **location**: string (ReadOnly): Location of the kusto cluster. +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the source data set +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## SqlDBTableProperties +## BlobProperties ### Properties -* **databaseName**: string (Required): Database name of the source data set +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DB table name. +* **filePath**: string (Required): File path within the source data set +* **resourceGroup**: string (Required): Resource group of storage account +* **storageAccountName**: string (Required): Storage account name of the source data set +* **subscriptionId**: string (Required): Subscription id of storage account -## SqlDWTableProperties +## DefaultDtoTags ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DW table name. +### Additional Properties +* **Additional Properties Type**: string -## SynapseWorkspaceSqlPoolTableDataSetProperties +## Identity ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table +* **principalId**: string (ReadOnly): service principal Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'SystemAssigned' | string: Identity Type ## InvitationProperties ### Properties @@ -400,6 +412,41 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource +## KustoClusterDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoClusterDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## ScheduledSourceShareSynchronizationSettingProperties +### Properties +* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval +* **synchronizationTime**: string (ReadOnly): Synchronization time + ## ScheduledSynchronizationSettingProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the synchronization setting was created. @@ -408,6 +455,26 @@ invitations to specific users or applications in an AD tenant. * **synchronizationTime**: string (Required): Synchronization time * **userName**: string (ReadOnly): Name of the user who created the synchronization setting. +## ScheduledTriggerProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the trigger was created. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval +* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode +* **synchronizationTime**: string (Required): Synchronization time +* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state +* **userName**: string (ReadOnly): Name of the user who created the trigger. + +## ShareProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the share was created. +* **description**: string: Share description. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. +* **terms**: string: Share terms. +* **userEmail**: string (ReadOnly): Email of the user who created the resource +* **userName**: string (ReadOnly): Name of the user who created the resource + ## ShareSubscriptionProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the share subscription was created. @@ -426,87 +493,53 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## AdlsGen2FileDataSetMappingProperties +## ShareSubscriptionSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the file system. -* **fileSystem**: string (Required): File system to which the file belongs. -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration +* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization +* **message**: string (ReadOnly, WriteOnly): message of Synchronization +* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization +* **status**: string (ReadOnly, WriteOnly): Raw Status +* **synchronizationId**: string (Required, WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## AdlsGen2FileSystemDataSetMappingProperties +## ShareSubscriptionSynchronizationList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): The file system name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## AdlsGen2FolderDataSetMappingProperties +## ShareSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): File system to which the folder belongs. -* **folderPath**: string (Required): Folder path within the file system. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization +* **consumerName**: string (WriteOnly): Name of the user who created the synchronization +* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization +* **durationMs**: int (WriteOnly): synchronization duration +* **endTime**: string (WriteOnly): End time of synchronization +* **message**: string (WriteOnly): message of synchronization +* **startTime**: string (WriteOnly): start time of synchronization +* **status**: string (WriteOnly): Raw Status +* **synchronizationId**: string (WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## BlobMappingProperties +## ShareSynchronizationList ### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the source data set -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## BlobFolderMappingProperties -### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **prefix**: string (Required): Prefix for blob folder -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +## SourceShareSynchronizationSetting +* **Discriminator**: kind -## BlobContainerMappingProperties -### Properties -* **containerName**: string (Required): BLOB Container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +### Base Properties +### ScheduledSourceSynchronizationSetting +#### Properties +* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. +* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. -## KustoClusterDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -## KustoDatabaseDataSetMappingProperties +## SourceShareSynchronizationSettingList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. ## SqlDBTableDataSetMappingProperties ### Properties @@ -518,6 +551,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DB table name. +## SqlDBTableProperties +### Properties +* **databaseName**: string (Required): Database name of the source data set +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DB table name. + ## SqlDWTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -528,6 +569,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DW table name. +## SqlDWTableProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DW table name. + ## SynapseWorkspaceSqlPoolTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -535,53 +584,10 @@ invitations to specific users or applications in an AD tenant. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account * **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table -## ScheduledTriggerProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the trigger was created. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval -* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode -* **synchronizationTime**: string (Required): Synchronization time -* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state -* **userName**: string (ReadOnly): Name of the user who created the trigger. - -## SourceShareSynchronizationSettingList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## SourceShareSynchronizationSetting -* **Discriminator**: kind - -### Base Properties -### ScheduledSourceSynchronizationSetting -#### Properties -* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. -* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. - - -## ScheduledSourceShareSynchronizationSettingProperties -### Properties -* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval -* **synchronizationTime**: string (ReadOnly): Synchronization time - -## ShareSynchronization -### Properties -* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization -* **consumerName**: string (WriteOnly): Name of the user who created the synchronization -* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization -* **durationMs**: int (WriteOnly): synchronization duration -* **endTime**: string (WriteOnly): End time of synchronization -* **message**: string (WriteOnly): message of synchronization -* **startTime**: string (WriteOnly): start time of synchronization -* **status**: string (WriteOnly): Raw Status -* **synchronizationId**: string (WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - -## SynchronizationDetailsList +## SynapseWorkspaceSqlPoolTableDataSetProperties ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table ## SynchronizationDetails ### Properties @@ -601,28 +607,22 @@ invitations to specific users or applications in an AD tenant. * **status**: string (ReadOnly): Raw Status * **vCore**: int (ReadOnly): The vCore units consumed for the data set synchronization -## ShareSubscriptionSynchronization -### Properties -* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration -* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization -* **message**: string (ReadOnly, WriteOnly): message of Synchronization -* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization -* **status**: string (ReadOnly, WriteOnly): Raw Status -* **synchronizationId**: string (Required, WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - ## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. * **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSynchronizationList +## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSubscriptionSynchronizationList +## SystemData ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. diff --git a/generated/datashare/microsoft.datashare/2020-10-01-preview/types.md b/generated/datashare/microsoft.datashare/2020-10-01-preview/types.md index 21548ab5f5..c6b15559f1 100644 --- a/generated/datashare/microsoft.datashare/2020-10-01-preview/types.md +++ b/generated/datashare/microsoft.datashare/2020-10-01-preview/types.md @@ -264,12 +264,6 @@ * **ApiVersion**: 2020-10-01-preview * **Output**: [ShareSubscriptionSynchronizationList](#sharesubscriptionsynchronizationlist) -## Identity -### Properties -* **principalId**: string (ReadOnly): service principal Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'SystemAssigned' | string: Identity Type - ## AccountProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the account was created. @@ -277,30 +271,6 @@ * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. - -## DefaultDtoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ShareProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the share was created. -* **description**: string: Share description. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. -* **terms**: string: Share terms. -* **userEmail**: string (ReadOnly): Email of the user who created the resource -* **userName**: string (ReadOnly): Name of the user who created the resource - ## AdlsGen1FileProperties ### Properties * **accountName**: string (Required): The ADLS account name. @@ -318,6 +288,18 @@ * **resourceGroup**: string (Required): Resource group of ADLS account. * **subscriptionId**: string (Required): Subscription id of ADLS account. +## AdlsGen2FileDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the file system. +* **fileSystem**: string (Required): File system to which the file belongs. +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -327,6 +309,16 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FileSystemDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): The file system name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileSystemProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -335,6 +327,17 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FolderDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): File system to which the folder belongs. +* **folderPath**: string (Required): Folder path within the file system. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FolderProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -344,6 +347,17 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2StorageAccountDataSetMappingProperties +### Properties +* **containerName**: string (Required): Gets or sets the container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **folder**: string (Required): Gets or sets the path to folder within the container. +* **location**: string (ReadOnly): Location of the sink storage account. +* **mountPath**: string: Gets or sets the mount path +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **storageAccountResourceId**: string (Required): Resource id of the sink storage account + ## AdlsGen2StorageAccountDataSetProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -357,15 +371,35 @@ * **containerName**: string (Required): Gets or sets the container name to share. * **providerPath**: string: Gets or sets the path to file/folder within the container. -## BlobProperties +## BlobContainerMappingProperties ### Properties -* **containerName**: string (Required): Container that has the file path. +* **containerName**: string (Required): BLOB Container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + +## BlobContainerProperties +### Properties +* **containerName**: string (Required): BLOB Container name. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## BlobFolderMappingProperties +### Properties +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **prefix**: string (Required): Prefix for blob folder +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## BlobFolderProperties ### Properties * **containerName**: string (Required): Container that has the file path. @@ -375,61 +409,61 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobStorageAccountDataSetProperties -### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **location**: string (ReadOnly): Location of the storage account. -* **paths**: [BlobStorageAccountPath](#blobstorageaccountpath)[] (Required): A list of storage account paths. -* **storageAccountResourceId**: string (Required): Resource id of the storage account. - -## BlobStorageAccountPath +## BlobMappingProperties ### Properties -* **consumerPath**: string: Gets or sets the path on the consumer side where the dataset is to be mapped. -* **containerName**: string (Required): Gets or sets the container name to share. -* **providerPath**: string: Gets or sets the path to file/folder within the container. +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the source data set +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. -## BlobContainerProperties +## BlobProperties ### Properties -* **containerName**: string (Required): BLOB Container name. +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## KustoClusterDataSetProperties +## BlobStorageAccountDataSetMappingProperties ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. -* **location**: string (ReadOnly): Location of the kusto cluster. +* **containerName**: string (Required): Gets or sets the container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **folder**: string (Required): Gets or sets the path to folder within the container. +* **location**: string (ReadOnly): Location of the sink storage account. +* **mountPath**: string: Gets or sets the mount path on the consumer side where the dataset is to be mapped. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **storageAccountResourceId**: string (Required): Resource id of the sink storage account -## KustoDatabaseDataSetProperties +## BlobStorageAccountDataSetProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. -* **location**: string (ReadOnly): Location of the kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **location**: string (ReadOnly): Location of the storage account. +* **paths**: [BlobStorageAccountPath](#blobstorageaccountpath)[] (Required): A list of storage account paths. +* **storageAccountResourceId**: string (Required): Resource id of the storage account. -## SqlDBTableProperties +## BlobStorageAccountPath ### Properties -* **databaseName**: string (Required): Database name of the source data set -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DB table name. +* **consumerPath**: string: Gets or sets the path on the consumer side where the dataset is to be mapped. +* **containerName**: string (Required): Gets or sets the container name to share. +* **providerPath**: string: Gets or sets the path to file/folder within the container. -## SqlDWTableProperties +## DefaultDtoTags ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DW table name. +### Additional Properties +* **Additional Properties Type**: string -## SynapseWorkspaceSqlPoolTableDataSetProperties +## Identity ### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table +* **principalId**: string (ReadOnly): service principal Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'SystemAssigned' | string: Identity Type ## InvitationProperties ### Properties @@ -446,6 +480,41 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource +## KustoClusterDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoClusterDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoClusterResourceId**: string (Required): Resource id of the kusto cluster. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## KustoDatabaseDataSetProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **kustoDatabaseResourceId**: string (Required): Resource id of the kusto database. +* **location**: string (ReadOnly): Location of the kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + +## ScheduledSourceShareSynchronizationSettingProperties +### Properties +* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval +* **synchronizationTime**: string (ReadOnly): Synchronization time + ## ScheduledSynchronizationSettingProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the synchronization setting was created. @@ -454,6 +523,26 @@ invitations to specific users or applications in an AD tenant. * **synchronizationTime**: string (Required): Synchronization time * **userName**: string (ReadOnly): Name of the user who created the synchronization setting. +## ScheduledTriggerProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the trigger was created. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval +* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode +* **synchronizationTime**: string (Required): Synchronization time +* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state +* **userName**: string (ReadOnly): Name of the user who created the trigger. + +## ShareProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the share was created. +* **description**: string: Share description. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. +* **terms**: string: Share terms. +* **userEmail**: string (ReadOnly): Email of the user who created the resource +* **userName**: string (ReadOnly): Name of the user who created the resource + ## ShareSubscriptionProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the share subscription was created. @@ -472,109 +561,53 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## AdlsGen2FileDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the file system. -* **fileSystem**: string (Required): File system to which the file belongs. -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. - -## AdlsGen2FileSystemDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): The file system name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. - -## AdlsGen2FolderDataSetMappingProperties +## ShareSubscriptionSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): File system to which the folder belongs. -* **folderPath**: string (Required): Folder path within the file system. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration +* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization +* **message**: string (ReadOnly, WriteOnly): message of Synchronization +* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization +* **status**: string (ReadOnly, WriteOnly): Raw Status +* **synchronizationId**: string (Required, WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## AdlsGen2StorageAccountDataSetMappingProperties +## ShareSubscriptionSynchronizationList ### Properties -* **containerName**: string (Required): Gets or sets the container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **folder**: string (Required): Gets or sets the path to folder within the container. -* **location**: string (ReadOnly): Location of the sink storage account. -* **mountPath**: string: Gets or sets the mount path -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **storageAccountResourceId**: string (Required): Resource id of the sink storage account +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## BlobMappingProperties +## ShareSynchronization ### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the source data set -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization +* **consumerName**: string (WriteOnly): Name of the user who created the synchronization +* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization +* **durationMs**: int (WriteOnly): synchronization duration +* **endTime**: string (WriteOnly): End time of synchronization +* **message**: string (WriteOnly): message of synchronization +* **startTime**: string (WriteOnly): start time of synchronization +* **status**: string (WriteOnly): Raw Status +* **synchronizationId**: string (WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## BlobFolderMappingProperties +## ShareSynchronizationList ### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **prefix**: string (Required): Prefix for blob folder -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## BlobStorageAccountDataSetMappingProperties -### Properties -* **containerName**: string (Required): Gets or sets the container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **folder**: string (Required): Gets or sets the path to folder within the container. -* **location**: string (ReadOnly): Location of the sink storage account. -* **mountPath**: string: Gets or sets the mount path on the consumer side where the dataset is to be mapped. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **storageAccountResourceId**: string (Required): Resource id of the sink storage account +## SourceShareSynchronizationSetting +* **Discriminator**: kind -## BlobContainerMappingProperties -### Properties -* **containerName**: string (Required): BLOB Container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +### Base Properties +### ScheduledSourceSynchronizationSetting +#### Properties +* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. +* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. -## KustoClusterDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -## KustoDatabaseDataSetMappingProperties +## SourceShareSynchronizationSettingList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. ## SqlDBTableDataSetMappingProperties ### Properties @@ -586,6 +619,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DB table name. +## SqlDBTableProperties +### Properties +* **databaseName**: string (Required): Database name of the source data set +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DB table name. + ## SqlDWTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -596,6 +637,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DW table name. +## SqlDWTableProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DW table name. + ## SynapseWorkspaceSqlPoolTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -603,53 +652,10 @@ invitations to specific users or applications in an AD tenant. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account * **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table -## ScheduledTriggerProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the trigger was created. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval -* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode -* **synchronizationTime**: string (Required): Synchronization time -* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state -* **userName**: string (ReadOnly): Name of the user who created the trigger. - -## SourceShareSynchronizationSettingList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## SourceShareSynchronizationSetting -* **Discriminator**: kind - -### Base Properties -### ScheduledSourceSynchronizationSetting -#### Properties -* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. -* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. - - -## ScheduledSourceShareSynchronizationSettingProperties -### Properties -* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval -* **synchronizationTime**: string (ReadOnly): Synchronization time - -## ShareSynchronization -### Properties -* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization -* **consumerName**: string (WriteOnly): Name of the user who created the synchronization -* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization -* **durationMs**: int (WriteOnly): synchronization duration -* **endTime**: string (WriteOnly): End time of synchronization -* **message**: string (WriteOnly): message of synchronization -* **startTime**: string (WriteOnly): start time of synchronization -* **status**: string (WriteOnly): Raw Status -* **synchronizationId**: string (WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - -## SynchronizationDetailsList +## SynapseWorkspaceSqlPoolTableDataSetProperties ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table ## SynchronizationDetails ### Properties @@ -669,28 +675,22 @@ invitations to specific users or applications in an AD tenant. * **status**: string (ReadOnly): Raw Status * **vCore**: int (ReadOnly): The vCore units consumed for the data set synchronization -## ShareSubscriptionSynchronization -### Properties -* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration -* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization -* **message**: string (ReadOnly, WriteOnly): message of Synchronization -* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization -* **status**: string (ReadOnly, WriteOnly): Raw Status -* **synchronizationId**: string (Required, WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - ## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. * **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSynchronizationList +## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSubscriptionSynchronizationList +## SystemData ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. diff --git a/generated/datashare/microsoft.datashare/2021-08-01/types.md b/generated/datashare/microsoft.datashare/2021-08-01/types.md index 001e4db157..0a4625b632 100644 --- a/generated/datashare/microsoft.datashare/2021-08-01/types.md +++ b/generated/datashare/microsoft.datashare/2021-08-01/types.md @@ -254,12 +254,6 @@ * **ApiVersion**: 2021-08-01 * **Output**: [ShareSubscriptionSynchronizationList](#sharesubscriptionsynchronizationlist) -## Identity -### Properties -* **principalId**: string (ReadOnly): service principal Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'SystemAssigned' | string: Identity Type - ## AccountProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the account was created. @@ -267,30 +261,6 @@ * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. - -## DefaultDtoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ShareProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the share was created. -* **description**: string: Share description. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. -* **terms**: string: Share terms. -* **userEmail**: string (ReadOnly): Email of the user who created the resource -* **userName**: string (ReadOnly): Name of the user who created the resource - ## AdlsGen1FileProperties ### Properties * **accountName**: string (Required): The ADLS account name. @@ -308,6 +278,18 @@ * **resourceGroup**: string (Required): Resource group of ADLS account. * **subscriptionId**: string (Required): Subscription id of ADLS account. +## AdlsGen2FileDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the file system. +* **fileSystem**: string (Required): File system to which the file belongs. +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -317,6 +299,16 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FileSystemDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): The file system name. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FileSystemProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -325,6 +317,17 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## AdlsGen2FolderDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **fileSystem**: string (Required): File system to which the folder belongs. +* **folderPath**: string (Required): Folder path within the file system. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## AdlsGen2FolderProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -334,15 +337,35 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobProperties +## BlobContainerMappingProperties ### Properties -* **containerName**: string (Required): Container that has the file path. +* **containerName**: string (Required): BLOB Container name. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + +## BlobContainerProperties +### Properties +* **containerName**: string (Required): BLOB Container name. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## BlobFolderMappingProperties +### Properties +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **prefix**: string (Required): Prefix for blob folder +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + ## BlobFolderProperties ### Properties * **containerName**: string (Required): Container that has the file path. @@ -352,14 +375,61 @@ * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account -## BlobContainerProperties +## BlobMappingProperties ### Properties -* **containerName**: string (Required): BLOB Container name. +* **containerName**: string (Required): Container that has the file path. +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **filePath**: string (Required): File path within the source data set +* **outputType**: 'Csv' | 'Parquet' | string: Type of output file +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **resourceGroup**: string (Required): Resource group of storage account. +* **storageAccountName**: string (Required): Storage account name of the source data set. +* **subscriptionId**: string (Required): Subscription id of storage account. + +## BlobProperties +### Properties +* **containerName**: string (Required): Container that has the file path. * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **filePath**: string (Required): File path within the source data set * **resourceGroup**: string (Required): Resource group of storage account * **storageAccountName**: string (Required): Storage account name of the source data set * **subscriptionId**: string (Required): Subscription id of storage account +## DefaultDtoTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Identity +### Properties +* **principalId**: string (ReadOnly): service principal Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'SystemAssigned' | string: Identity Type + +## InvitationProperties +### Properties +* **expirationDate**: string: The expiration date for the invitation and share subscription. +* **invitationId**: string (ReadOnly): unique invitation id +* **invitationStatus**: 'Accepted' | 'Pending' | 'Rejected' | 'Withdrawn' | string (ReadOnly): The status of the invitation. +* **respondedAt**: string (ReadOnly): The time the recipient responded to the invitation. +* **sentAt**: string (ReadOnly): Gets the time at which the invitation was sent. +* **targetActiveDirectoryId**: string: The target Azure AD Id. Can't be combined with email. +* **targetEmail**: string: The email the invitation is directed to. +* **targetObjectId**: string: The target user or application Id that invitation is being sent to. +Must be specified along TargetActiveDirectoryId. This enables sending +invitations to specific users or applications in an AD tenant. +* **userEmail**: string (ReadOnly): Email of the user who created the resource +* **userName**: string (ReadOnly): Name of the user who created the resource + +## KustoClusterDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + ## KustoClusterDataSetProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -367,6 +437,14 @@ * **location**: string (ReadOnly): Location of the kusto cluster. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +## KustoDatabaseDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + ## KustoDatabaseDataSetProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -374,6 +452,14 @@ * **location**: string (ReadOnly): Location of the kusto cluster. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +## KustoTableDataSetMappingProperties +### Properties +* **dataSetId**: string (Required): The id of the source data set. +* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. +* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. +* **location**: string (ReadOnly): Location of the sink kusto cluster. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account + ## KustoTableDataSetProperties ### Properties * **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource @@ -382,50 +468,10 @@ * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account * **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties) (Required): Table level sharing properties dto for kusto data set properties -## TableLevelSharingProperties -### Properties -* **externalTablesToExclude**: string[]: External tables to be excluded in the data set -* **externalTablesToInclude**: string[]: External tables to be included in the data set -* **materializedViewsToExclude**: string[]: Materialized views to be excluded in the data set -* **materializedViewsToInclude**: string[]: Materialized views to be included in the data set -* **tablesToExclude**: string[]: Tables to be excluded in the data set -* **tablesToInclude**: string[]: Tables to be included in the data set - -## SqlDBTableProperties -### Properties -* **databaseName**: string (Required): Database name of the source data set -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DB table name. - -## SqlDWTableProperties -### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set -* **schemaName**: string (Required): Schema of the table. Default value is dbo. -* **sqlServerResourceId**: string (Required): Resource id of SQL server -* **tableName**: string (Required): SQL DW table name. - -## SynapseWorkspaceSqlPoolTableDataSetProperties -### Properties -* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource -* **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table - -## InvitationProperties +## ScheduledSourceShareSynchronizationSettingProperties ### Properties -* **expirationDate**: string: The expiration date for the invitation and share subscription. -* **invitationId**: string (ReadOnly): unique invitation id -* **invitationStatus**: 'Accepted' | 'Pending' | 'Rejected' | 'Withdrawn' | string (ReadOnly): The status of the invitation. -* **respondedAt**: string (ReadOnly): The time the recipient responded to the invitation. -* **sentAt**: string (ReadOnly): Gets the time at which the invitation was sent. -* **targetActiveDirectoryId**: string: The target Azure AD Id. Can't be combined with email. -* **targetEmail**: string: The email the invitation is directed to. -* **targetObjectId**: string: The target user or application Id that invitation is being sent to. -Must be specified along TargetActiveDirectoryId. This enables sending -invitations to specific users or applications in an AD tenant. -* **userEmail**: string (ReadOnly): Email of the user who created the resource -* **userName**: string (ReadOnly): Name of the user who created the resource +* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval +* **synchronizationTime**: string (ReadOnly): Synchronization time ## ScheduledSynchronizationSettingProperties ### Properties @@ -435,6 +481,26 @@ invitations to specific users or applications in an AD tenant. * **synchronizationTime**: string (Required): Synchronization time * **userName**: string (ReadOnly): Name of the user who created the synchronization setting. +## ScheduledTriggerProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the trigger was created. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval +* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode +* **synchronizationTime**: string (Required): Synchronization time +* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state +* **userName**: string (ReadOnly): Name of the user who created the trigger. + +## ShareProperties +### Properties +* **createdAt**: string (ReadOnly): Time at which the share was created. +* **description**: string: Share description. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **shareKind**: 'CopyBased' | 'InPlace' | string: Share kind. +* **terms**: string: Share terms. +* **userEmail**: string (ReadOnly): Email of the user who created the resource +* **userName**: string (ReadOnly): Name of the user who created the resource + ## ShareSubscriptionProperties ### Properties * **createdAt**: string (ReadOnly): Time at which the share subscription was created. @@ -453,95 +519,53 @@ invitations to specific users or applications in an AD tenant. * **userEmail**: string (ReadOnly): Email of the user who created the resource * **userName**: string (ReadOnly): Name of the user who created the resource -## AdlsGen2FileDataSetMappingProperties +## ShareSubscriptionSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the file system. -* **fileSystem**: string (Required): File system to which the file belongs. -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration +* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization +* **message**: string (ReadOnly, WriteOnly): message of Synchronization +* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization +* **status**: string (ReadOnly, WriteOnly): Raw Status +* **synchronizationId**: string (Required, WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## AdlsGen2FileSystemDataSetMappingProperties +## ShareSubscriptionSynchronizationList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): The file system name. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## AdlsGen2FolderDataSetMappingProperties +## ShareSynchronization ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **fileSystem**: string (Required): File system to which the folder belongs. -* **folderPath**: string (Required): Folder path within the file system. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization +* **consumerName**: string (WriteOnly): Name of the user who created the synchronization +* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization +* **durationMs**: int (WriteOnly): synchronization duration +* **endTime**: string (WriteOnly): End time of synchronization +* **message**: string (WriteOnly): message of synchronization +* **startTime**: string (WriteOnly): start time of synchronization +* **status**: string (WriteOnly): Raw Status +* **synchronizationId**: string (WriteOnly): Synchronization id +* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode -## BlobMappingProperties +## ShareSynchronizationList ### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **filePath**: string (Required): File path within the source data set -* **outputType**: 'Csv' | 'Parquet' | string: Type of output file -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. -## BlobFolderMappingProperties -### Properties -* **containerName**: string (Required): Container that has the file path. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **prefix**: string (Required): Prefix for blob folder -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +## SourceShareSynchronizationSetting +* **Discriminator**: kind -## BlobContainerMappingProperties -### Properties -* **containerName**: string (Required): BLOB Container name. -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **resourceGroup**: string (Required): Resource group of storage account. -* **storageAccountName**: string (Required): Storage account name of the source data set. -* **subscriptionId**: string (Required): Subscription id of storage account. +### Base Properties +### ScheduledSourceSynchronizationSetting +#### Properties +* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. +* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. -## KustoClusterDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -## KustoDatabaseDataSetMappingProperties -### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account - -## KustoTableDataSetMappingProperties +## SourceShareSynchronizationSettingList ### Properties -* **dataSetId**: string (Required): The id of the source data set. -* **dataSetMappingStatus**: 'Broken' | 'Ok' | string (ReadOnly): Gets the status of the data set mapping. -* **kustoClusterResourceId**: string (Required): Resource id of the sink kusto cluster. -* **location**: string (ReadOnly): Location of the sink kusto cluster. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. ## SqlDBTableDataSetMappingProperties ### Properties @@ -553,6 +577,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DB table name. +## SqlDBTableProperties +### Properties +* **databaseName**: string (Required): Database name of the source data set +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DB table name. + ## SqlDWTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -563,6 +595,14 @@ invitations to specific users or applications in an AD tenant. * **sqlServerResourceId**: string (Required): Resource id of SQL server * **tableName**: string (Required): SQL DW table name. +## SqlDWTableProperties +### Properties +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **dataWarehouseName**: string (Required): DataWarehouse name of the source data set +* **schemaName**: string (Required): Schema of the table. Default value is dbo. +* **sqlServerResourceId**: string (Required): Resource id of SQL server +* **tableName**: string (Required): SQL DW table name. + ## SynapseWorkspaceSqlPoolTableDataSetMappingProperties ### Properties * **dataSetId**: string (Required): The id of the source data set. @@ -570,53 +610,10 @@ invitations to specific users or applications in an AD tenant. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account * **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table -## ScheduledTriggerProperties -### Properties -* **createdAt**: string (ReadOnly): Time at which the trigger was created. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the Account -* **recurrenceInterval**: 'Day' | 'Hour' | string (Required): Recurrence Interval -* **synchronizationMode**: 'FullSync' | 'Incremental' | string: Synchronization mode -* **synchronizationTime**: string (Required): Synchronization time -* **triggerStatus**: 'Active' | 'Inactive' | 'SourceSynchronizationSettingDeleted' | string (ReadOnly): Gets the trigger state -* **userName**: string (ReadOnly): Name of the user who created the trigger. - -## SourceShareSynchronizationSettingList -### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SourceShareSynchronizationSetting](#sourcesharesynchronizationsetting)[] (ReadOnly): Collection of items of type DataTransferObjects. - -## SourceShareSynchronizationSetting -* **Discriminator**: kind - -### Base Properties -### ScheduledSourceSynchronizationSetting -#### Properties -* **kind**: 'ScheduleBased' (Required): Kind of synchronization setting on share. -* **properties**: [ScheduledSourceShareSynchronizationSettingProperties](#scheduledsourcesharesynchronizationsettingproperties) (ReadOnly): A Scheduled source synchronization setting data transfer object. - - -## ScheduledSourceShareSynchronizationSettingProperties -### Properties -* **recurrenceInterval**: 'Day' | 'Hour' | string (ReadOnly): Recurrence Interval -* **synchronizationTime**: string (ReadOnly): Synchronization time - -## ShareSynchronization -### Properties -* **consumerEmail**: string (WriteOnly): Email of the user who created the synchronization -* **consumerName**: string (WriteOnly): Name of the user who created the synchronization -* **consumerTenantName**: string (WriteOnly): Tenant name of the consumer who created the synchronization -* **durationMs**: int (WriteOnly): synchronization duration -* **endTime**: string (WriteOnly): End time of synchronization -* **message**: string (WriteOnly): message of synchronization -* **startTime**: string (WriteOnly): start time of synchronization -* **status**: string (WriteOnly): Raw Status -* **synchronizationId**: string (WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode - -## SynchronizationDetailsList +## SynapseWorkspaceSqlPoolTableDataSetProperties ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **dataSetId**: string (ReadOnly): Unique id for identifying a data set resource +* **synapseWorkspaceSqlPoolTableResourceId**: string (Required): Resource id of the Synapse Workspace SQL Pool Table ## SynchronizationDetails ### Properties @@ -636,28 +633,31 @@ invitations to specific users or applications in an AD tenant. * **status**: string (ReadOnly): Raw Status * **vCore**: int (ReadOnly): The vCore units consumed for the data set synchronization -## ShareSubscriptionSynchronization +## SynchronizationDetailsList ### Properties -* **durationMs**: int (ReadOnly, WriteOnly): Synchronization duration -* **endTime**: string (ReadOnly, WriteOnly): End time of synchronization -* **message**: string (ReadOnly, WriteOnly): message of Synchronization -* **startTime**: string (ReadOnly, WriteOnly): start time of synchronization -* **status**: string (ReadOnly, WriteOnly): Raw Status -* **synchronizationId**: string (Required, WriteOnly): Synchronization id -* **synchronizationMode**: 'FullSync' | 'Incremental' | string (ReadOnly, WriteOnly): Synchronization mode +* **nextLink**: string (ReadOnly): The Url of next result page. +* **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. ## SynchronizationDetailsList ### Properties * **nextLink**: string (ReadOnly): The Url of next result page. * **value**: [SynchronizationDetails](#synchronizationdetails)[] (ReadOnly): Collection of items of type DataTransferObjects. -## ShareSynchronizationList +## SystemData ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSynchronization](#sharesynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. -## ShareSubscriptionSynchronizationList +## TableLevelSharingProperties ### Properties -* **nextLink**: string (ReadOnly): The Url of next result page. -* **value**: [ShareSubscriptionSynchronization](#sharesubscriptionsynchronization)[] (ReadOnly): Collection of items of type DataTransferObjects. +* **externalTablesToExclude**: string[]: External tables to be excluded in the data set +* **externalTablesToInclude**: string[]: External tables to be included in the data set +* **materializedViewsToExclude**: string[]: Materialized views to be excluded in the data set +* **materializedViewsToInclude**: string[]: Materialized views to be included in the data set +* **tablesToExclude**: string[]: Tables to be excluded in the data set +* **tablesToInclude**: string[]: Tables to be included in the data set diff --git a/generated/deploymentmanager/log.out b/generated/deploymentmanager/log.out index 15295af772..bf05006217 100644 --- a/generated/deploymentmanager/log.out +++ b/generated/deploymentmanager/log.out @@ -20,7 +20,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.deploymentmanager-2019-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -40,7 +40,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RolloutRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json:1266:5 @@ -111,7 +111,7 @@ warning | PreCheck/SchemaMissingType | The schema 'StepResource' with an undefin warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'RolloutProperties' -> 'RolloutPropertiesAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ArtifactSourceProperties' -> 'ArtifactSourcePropertiesAutoGenerated' -info | autorest.bicep took 17ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.deploymentmanager-2018-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -131,7 +131,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RolloutRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json:1025:5 @@ -202,5 +202,5 @@ warning | PreCheck/SchemaMissingType | The schema 'StepResource' with an undefin warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'RolloutProperties' -> 'RolloutPropertiesAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ArtifactSourceProperties' -> 'ArtifactSourcePropertiesAutoGenerated' -info | autorest.bicep took 7ms -info | Autorest completed in 8.07s. 4 files generated. +info | autorest.bicep took 5ms +info | Autorest completed in 7.52s. 4 files generated. diff --git a/generated/deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.md b/generated/deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.md index b8d799fb98..e5d45a7571 100644 --- a/generated/deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.md +++ b/generated/deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.md @@ -83,20 +83,44 @@ * **type**: 'Sas' (Required): The authentication type -## SasProperties -### Properties -* **sasUri**: string (Required): The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot. - -## TrackedResourceTags +## CloudErrorBody ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: string (ReadOnly): Error code string. +* **details**: [CloudErrorBody](#clouderrorbody)[] (ReadOnly): More detailed error information. +* **message**: string (ReadOnly): Descriptive error information. +* **target**: string (ReadOnly): Error target ## Identity ### Properties * **identityIds**: string[] (Required): The list of identities. * **type**: string (Required): The identity type. +## Message +### Properties +* **message**: string (ReadOnly): The actual message text. +* **timeStamp**: string (ReadOnly): Time in UTC this message was provided. + +## PrePostStep +### Properties +* **stepId**: string (Required): The resource Id of the step to be run. + +## ResourceOperation +### Properties +* **operationId**: string (ReadOnly): Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service. +* **provisioningState**: string (ReadOnly): State of the resource deployment. For ARM resources, this is the current provisioning state of the resource. +* **resourceName**: string (ReadOnly): Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template. +* **resourceType**: string (ReadOnly): Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template. +* **statusCode**: string (ReadOnly): Http status code of the operation. +* **statusMessage**: string (ReadOnly): Descriptive information of the resource operation. + +## RolloutOperationInfo +### Properties +* **endTime**: string (ReadOnly): The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet. +* **error**: [CloudErrorBody](#clouderrorbody) (ReadOnly): Detailed error information of any failure. +* **retryAttempt**: int (ReadOnly): The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0. +* **skipSucceededOnRetry**: bool (ReadOnly): True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise. +* **startTime**: string (ReadOnly): The start time of the rollout in UTC. + ## RolloutRequestProperties ### Properties * **artifactSourceId**: string: The reference to the artifact source resource Id where the payload is located. @@ -108,20 +132,18 @@ * **targetServiceTopologyId**: string (Required): The resource Id of the service topology from which service units are being referenced in step groups to be deployed. * **totalRetryAttempts**: int (ReadOnly): The cardinal count of total number of retries performed on the rollout at a given time. -## RolloutOperationInfo +## RolloutStep ### Properties -* **endTime**: string (ReadOnly): The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet. -* **error**: [CloudErrorBody](#clouderrorbody) (ReadOnly): Detailed error information of any failure. -* **retryAttempt**: int (ReadOnly): The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0. -* **skipSucceededOnRetry**: bool (ReadOnly): True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise. -* **startTime**: string (ReadOnly): The start time of the rollout in UTC. +* **messages**: [Message](#message)[] (ReadOnly): Supplementary informative messages during rollout. +* **name**: string (ReadOnly): Name of the step. +* **operationInfo**: [StepOperationInfo](#stepoperationinfo) (ReadOnly): Detailed information of a specific step run. +* **resourceOperations**: [ResourceOperation](#resourceoperation)[] (ReadOnly): Set of resource operations that were performed, if any, on an Azure resource. +* **status**: string (ReadOnly): Current state of the step. +* **stepGroup**: string (ReadOnly): The step group the current step is part of. -## CloudErrorBody +## SasProperties ### Properties -* **code**: string (ReadOnly): Error code string. -* **details**: [CloudErrorBody](#clouderrorbody)[] (ReadOnly): More detailed error information. -* **message**: string (ReadOnly): Descriptive error information. -* **target**: string (ReadOnly): Error target +* **sasUri**: string (Required): The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot. ## Service ### Properties @@ -130,6 +152,15 @@ * **targetLocation**: string (ReadOnly): The Azure location to which the resources in the service belong to or should be deployed to. * **targetSubscriptionId**: string (ReadOnly): The subscription to which the resources in the service belong to or should be deployed to. +## ServiceResourceProperties +### Properties +* **targetLocation**: string (Required): The Azure location to which the resources in the service belong to or should be deployed to. +* **targetSubscriptionId**: string (Required): The subscription to which the resources in the service belong to or should be deployed to. + +## ServiceTopologyResourceProperties +### Properties +* **artifactSourceId**: string: The resource Id of the artifact source that contains the artifacts that can be referenced in the service units. + ## ServiceUnit ### Properties * **artifacts**: [ServiceUnitArtifacts](#serviceunitartifacts) (ReadOnly): Defines the artifacts of a service unit. @@ -145,19 +176,19 @@ * **templateArtifactSourceRelativePath**: string: The path to the ARM template file relative to the artifact source. * **templateUri**: string: The full URI of the ARM template file with the SAS token. -## RolloutStep +## ServiceUnitResourceProperties ### Properties -* **messages**: [Message](#message)[] (ReadOnly): Supplementary informative messages during rollout. -* **name**: string (ReadOnly): Name of the step. -* **operationInfo**: [StepOperationInfo](#stepoperationinfo) (ReadOnly): Detailed information of a specific step run. -* **resourceOperations**: [ResourceOperation](#resourceoperation)[] (ReadOnly): Set of resource operations that were performed, if any, on an Azure resource. -* **status**: string (ReadOnly): Current state of the step. -* **stepGroup**: string (ReadOnly): The step group the current step is part of. +* **artifacts**: [ServiceUnitArtifacts](#serviceunitartifacts): Defines the artifacts of a service unit. +* **deploymentMode**: 'Complete' | 'Incremental' (Required): Describes the type of ARM deployment to be performed on the resource. +* **targetResourceGroup**: string (Required): The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. -## Message +## Step ### Properties -* **message**: string (ReadOnly): The actual message text. -* **timeStamp**: string (ReadOnly): Time in UTC this message was provided. +* **dependsOnStepGroups**: string[]: The list of step group names on which this step group depends on. +* **deploymentTargetId**: string (Required): The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId +* **name**: string (Required): The name of the step group. +* **postDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run after deploying the target. +* **preDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run before deploying the target. ## StepOperationInfo ### Properties @@ -168,78 +199,47 @@ * **lastUpdatedTime**: string (ReadOnly): Last time in UTC this operation was updated. * **startTime**: string (ReadOnly): Start time of the action in UTC. -## ResourceOperation -### Properties -* **operationId**: string (ReadOnly): Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service. -* **provisioningState**: string (ReadOnly): State of the resource deployment. For ARM resources, this is the current provisioning state of the resource. -* **resourceName**: string (ReadOnly): Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template. -* **resourceType**: string (ReadOnly): Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template. -* **statusCode**: string (ReadOnly): Http status code of the operation. -* **statusMessage**: string (ReadOnly): Descriptive information of the resource operation. +## StepProperties +* **Discriminator**: stepType -## Step -### Properties -* **dependsOnStepGroups**: string[]: The list of step group names on which this step group depends on. -* **deploymentTargetId**: string (Required): The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId -* **name**: string (Required): The name of the step group. -* **postDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run after deploying the target. -* **preDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run before deploying the target. +### Base Properties +### WaitStepProperties +#### Properties +* **attributes**: [WaitStepAttributes](#waitstepattributes): The parameters for the wait step. +* **stepType**: 'Wait' (Required): The type of step. -## PrePostStep -### Properties -* **stepId**: string (Required): The resource Id of the step to be run. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceTopologyResourceProperties -### Properties -* **artifactSourceId**: string: The resource Id of the artifact source that contains the artifacts that can be referenced in the service units. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceResourceProperties +## TrackedResourceTags ### Properties -* **targetLocation**: string (Required): The Azure location to which the resources in the service belong to or should be deployed to. -* **targetSubscriptionId**: string (Required): The subscription to which the resources in the service belong to or should be deployed to. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceUnitResourceProperties +## TrackedResourceTags ### Properties -* **artifacts**: [ServiceUnitArtifacts](#serviceunitartifacts): Defines the artifacts of a service unit. -* **deploymentMode**: 'Complete' | 'Incremental' (Required): Describes the type of ARM deployment to be performed on the resource. -* **targetResourceGroup**: string (Required): The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## StepProperties -* **Discriminator**: stepType - -### Base Properties -### WaitStepProperties -#### Properties -* **attributes**: [WaitStepAttributes](#waitstepattributes): The parameters for the wait step. -* **stepType**: 'Wait' (Required): The type of step. - - ## WaitStepAttributes ### Properties * **duration**: string (Required): The duration in ISO 8601 format of how long the wait should be. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.md b/generated/deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.md index ce15003e25..d6427b2ea8 100644 --- a/generated/deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.md +++ b/generated/deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.md @@ -83,20 +83,99 @@ * **type**: 'Sas' (Required): The authentication type -## SasProperties +## CloudErrorBody ### Properties -* **sasUri**: string (Required): The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot. +* **code**: string (ReadOnly): Error code string. +* **details**: [CloudErrorBody](#clouderrorbody)[] (ReadOnly): More detailed error information. +* **message**: string (ReadOnly): Descriptive error information. +* **target**: string (ReadOnly): Error target + +## HealthCheckStepAttributes +* **Discriminator**: type + +### Base Properties +* **healthyStateDuration**: string (Required): The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal. +* **maxElasticDuration**: string: The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy. +* **waitDuration**: string: The duration in ISO 8601 format for which health check waits idly without any checks. +### RestHealthCheckStepAttributes +#### Properties +* **properties**: [RestParameters](#restparameters): The parameters for the REST health check. +* **type**: 'REST' (Required): The type of health check. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## Identity ### Properties * **identityIds**: string[] (Required): The list of identities. * **type**: string (Required): The identity type. +## Message +### Properties +* **message**: string (ReadOnly): The actual message text. +* **timeStamp**: string (ReadOnly): Time in UTC this message was provided. + +## PrePostStep +### Properties +* **stepId**: string (Required): The resource Id of the step to be run. + +## ResourceOperation +### Properties +* **operationId**: string (ReadOnly): Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service. +* **provisioningState**: string (ReadOnly): State of the resource deployment. For ARM resources, this is the current provisioning state of the resource. +* **resourceName**: string (ReadOnly): Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template. +* **resourceType**: string (ReadOnly): Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template. +* **statusCode**: string (ReadOnly): Http status code of the operation. +* **statusMessage**: string (ReadOnly): Descriptive information of the resource operation. + +## RestHealthCheck +### Properties +* **name**: string (Required): A unique name for this check. +* **request**: [RestRequest](#restrequest) (Required): The properties that make up a REST request +* **response**: [RestResponse](#restresponse): The properties that make up the expected REST response + +## RestParameters +### Properties +* **healthChecks**: [RestHealthCheck](#resthealthcheck)[] (Required): The list of checks that form the health check step. + +## RestRequest +### Properties +* **authentication**: [RestRequestAuthentication](#restrequestauthentication) (Required): The authentication information required in the REST health check request to the health provider. +* **method**: 'GET' | 'POST' (Required): The HTTP method to use for the request. +* **uri**: string (Required): The HTTP URI to use for the request. + +## RestRequestAuthentication +* **Discriminator**: type + +### Base Properties +### ApiKeyAuthentication +#### Properties +* **in**: 'Header' | 'Query' (Required): The location of the authentication key/value pair in the request. +* **name**: string (Required): The key name of the authentication key/value pair. +* **type**: 'ApiKey' (Required): The authentication type. +* **value**: string (Required): The value of the authentication key/value pair. + +### RolloutIdentityAuthentication +#### Properties +* **type**: 'RolloutIdentity' (Required): The authentication type. + + +## RestResponse +### Properties +* **regex**: [RestResponseRegex](#restresponseregex): The regular expressions to match the response content with. +* **successStatusCodes**: string[]: The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK. + +## RestResponseRegex +### Properties +* **matches**: string[]: The list of regular expressions. +* **matchQuantifier**: 'All' | 'Any': Indicates whether any or all of the expressions should match with the response content. + +## RolloutOperationInfo +### Properties +* **endTime**: string (ReadOnly): The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet. +* **error**: [CloudErrorBody](#clouderrorbody) (ReadOnly): Detailed error information of any failure. +* **retryAttempt**: int (ReadOnly): The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0. +* **skipSucceededOnRetry**: bool (ReadOnly): True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise. +* **startTime**: string (ReadOnly): The start time of the rollout in UTC. + ## RolloutRequestProperties ### Properties * **artifactSourceId**: string: The reference to the artifact source resource Id where the payload is located. @@ -108,20 +187,18 @@ * **targetServiceTopologyId**: string (Required): The resource Id of the service topology from which service units are being referenced in step groups to be deployed. * **totalRetryAttempts**: int (ReadOnly): The cardinal count of total number of retries performed on the rollout at a given time. -## RolloutOperationInfo +## RolloutStep ### Properties -* **endTime**: string (ReadOnly): The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet. -* **error**: [CloudErrorBody](#clouderrorbody) (ReadOnly): Detailed error information of any failure. -* **retryAttempt**: int (ReadOnly): The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0. -* **skipSucceededOnRetry**: bool (ReadOnly): True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise. -* **startTime**: string (ReadOnly): The start time of the rollout in UTC. +* **messages**: [Message](#message)[] (ReadOnly): Supplementary informative messages during rollout. +* **name**: string (ReadOnly): Name of the step. +* **operationInfo**: [StepOperationInfo](#stepoperationinfo) (ReadOnly): Detailed information of a specific step run. +* **resourceOperations**: [ResourceOperation](#resourceoperation)[] (ReadOnly): Set of resource operations that were performed, if any, on an Azure resource. +* **status**: string (ReadOnly): Current state of the step. +* **stepGroup**: string (ReadOnly): The step group the current step is part of. -## CloudErrorBody +## SasProperties ### Properties -* **code**: string (ReadOnly): Error code string. -* **details**: [CloudErrorBody](#clouderrorbody)[] (ReadOnly): More detailed error information. -* **message**: string (ReadOnly): Descriptive error information. -* **target**: string (ReadOnly): Error target +* **sasUri**: string (Required): The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot. ## Service ### Properties @@ -130,6 +207,15 @@ * **targetLocation**: string (ReadOnly): The Azure location to which the resources in the service belong to or should be deployed to. * **targetSubscriptionId**: string (ReadOnly): The subscription to which the resources in the service belong to or should be deployed to. +## ServiceResourceProperties +### Properties +* **targetLocation**: string (Required): The Azure location to which the resources in the service belong to or should be deployed to. +* **targetSubscriptionId**: string (Required): The subscription to which the resources in the service belong to or should be deployed to. + +## ServiceTopologyResourceProperties +### Properties +* **artifactSourceId**: string: The resource Id of the artifact source that contains the artifacts that can be referenced in the service units. + ## ServiceUnit ### Properties * **artifacts**: [ServiceUnitArtifacts](#serviceunitartifacts) (ReadOnly): Defines the artifacts of a service unit. @@ -145,19 +231,19 @@ * **templateArtifactSourceRelativePath**: string: The path to the ARM template file relative to the artifact source. * **templateUri**: string: The full URI of the ARM template file with the SAS token. -## RolloutStep +## ServiceUnitResourceProperties ### Properties -* **messages**: [Message](#message)[] (ReadOnly): Supplementary informative messages during rollout. -* **name**: string (ReadOnly): Name of the step. -* **operationInfo**: [StepOperationInfo](#stepoperationinfo) (ReadOnly): Detailed information of a specific step run. -* **resourceOperations**: [ResourceOperation](#resourceoperation)[] (ReadOnly): Set of resource operations that were performed, if any, on an Azure resource. -* **status**: string (ReadOnly): Current state of the step. -* **stepGroup**: string (ReadOnly): The step group the current step is part of. +* **artifacts**: [ServiceUnitArtifacts](#serviceunitartifacts): Defines the artifacts of a service unit. +* **deploymentMode**: 'Complete' | 'Incremental' (Required): Describes the type of ARM deployment to be performed on the resource. +* **targetResourceGroup**: string (Required): The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. -## Message +## StepGroup ### Properties -* **message**: string (ReadOnly): The actual message text. -* **timeStamp**: string (ReadOnly): Time in UTC this message was provided. +* **dependsOnStepGroups**: string[]: The list of step group names on which this step group depends on. +* **deploymentTargetId**: string (Required): The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId +* **name**: string (Required): The name of the step group. +* **postDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run after deploying the target. +* **preDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run before deploying the target. ## StepOperationInfo ### Properties @@ -168,138 +254,52 @@ * **lastUpdatedTime**: string (ReadOnly): Last time in UTC this operation was updated. * **startTime**: string (ReadOnly): Start time of the action in UTC. -## ResourceOperation -### Properties -* **operationId**: string (ReadOnly): Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service. -* **provisioningState**: string (ReadOnly): State of the resource deployment. For ARM resources, this is the current provisioning state of the resource. -* **resourceName**: string (ReadOnly): Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template. -* **resourceType**: string (ReadOnly): Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template. -* **statusCode**: string (ReadOnly): Http status code of the operation. -* **statusMessage**: string (ReadOnly): Descriptive information of the resource operation. +## StepProperties +* **Discriminator**: stepType -## StepGroup -### Properties -* **dependsOnStepGroups**: string[]: The list of step group names on which this step group depends on. -* **deploymentTargetId**: string (Required): The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId -* **name**: string (Required): The name of the step group. -* **postDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run after deploying the target. -* **preDeploymentSteps**: [PrePostStep](#prepoststep)[]: The list of steps to be run before deploying the target. +### Base Properties +### HealthCheckStepProperties +#### Properties +* **attributes**: [HealthCheckStepAttributes](#healthcheckstepattributes) (Required): The attributes for the health check step. +* **stepType**: 'HealthCheck' (Required): The type of step. + +### WaitStepProperties +#### Properties +* **attributes**: [WaitStepAttributes](#waitstepattributes) (Required): The parameters for the wait step. +* **stepType**: 'Wait' (Required): The type of step. -## PrePostStep -### Properties -* **stepId**: string (Required): The resource Id of the step to be run. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceTopologyResourceProperties -### Properties -* **artifactSourceId**: string: The resource Id of the artifact source that contains the artifacts that can be referenced in the service units. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceResourceProperties -### Properties -* **targetLocation**: string (Required): The Azure location to which the resources in the service belong to or should be deployed to. -* **targetSubscriptionId**: string (Required): The subscription to which the resources in the service belong to or should be deployed to. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceUnitResourceProperties -### Properties -* **artifacts**: [ServiceUnitArtifacts](#serviceunitartifacts): Defines the artifacts of a service unit. -* **deploymentMode**: 'Complete' | 'Incremental' (Required): Describes the type of ARM deployment to be performed on the resource. -* **targetResourceGroup**: string (Required): The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## StepProperties -* **Discriminator**: stepType - -### Base Properties -### HealthCheckStepProperties -#### Properties -* **attributes**: [HealthCheckStepAttributes](#healthcheckstepattributes) (Required): The attributes for the health check step. -* **stepType**: 'HealthCheck' (Required): The type of step. - -### WaitStepProperties -#### Properties -* **attributes**: [WaitStepAttributes](#waitstepattributes) (Required): The parameters for the wait step. -* **stepType**: 'Wait' (Required): The type of step. - - -## HealthCheckStepAttributes -* **Discriminator**: type - -### Base Properties -* **healthyStateDuration**: string (Required): The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal. -* **maxElasticDuration**: string: The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy. -* **waitDuration**: string: The duration in ISO 8601 format for which health check waits idly without any checks. -### RestHealthCheckStepAttributes -#### Properties -* **properties**: [RestParameters](#restparameters): The parameters for the REST health check. -* **type**: 'REST' (Required): The type of health check. - - -## RestParameters -### Properties -* **healthChecks**: [RestHealthCheck](#resthealthcheck)[] (Required): The list of checks that form the health check step. - -## RestHealthCheck -### Properties -* **name**: string (Required): A unique name for this check. -* **request**: [RestRequest](#restrequest) (Required): The properties that make up a REST request -* **response**: [RestResponse](#restresponse): The properties that make up the expected REST response - -## RestRequest -### Properties -* **authentication**: [RestRequestAuthentication](#restrequestauthentication) (Required): The authentication information required in the REST health check request to the health provider. -* **method**: 'GET' | 'POST' (Required): The HTTP method to use for the request. -* **uri**: string (Required): The HTTP URI to use for the request. - -## RestRequestAuthentication -* **Discriminator**: type - -### Base Properties -### ApiKeyAuthentication -#### Properties -* **in**: 'Header' | 'Query' (Required): The location of the authentication key/value pair in the request. -* **name**: string (Required): The key name of the authentication key/value pair. -* **type**: 'ApiKey' (Required): The authentication type. -* **value**: string (Required): The value of the authentication key/value pair. - -### RolloutIdentityAuthentication -#### Properties -* **type**: 'RolloutIdentity' (Required): The authentication type. - - -## RestResponse +## TrackedResourceTags ### Properties -* **regex**: [RestResponseRegex](#restresponseregex): The regular expressions to match the response content with. -* **successStatusCodes**: string[]: The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK. +### Additional Properties +* **Additional Properties Type**: string -## RestResponseRegex +## TrackedResourceTags ### Properties -* **matches**: string[]: The list of regular expressions. -* **matchQuantifier**: 'All' | 'Any': Indicates whether any or all of the expressions should match with the response content. +### Additional Properties +* **Additional Properties Type**: string ## WaitStepAttributes ### Properties * **duration**: string (Required): The duration in ISO 8601 format of how long the wait should be. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/log.out b/generated/desktopvirtualization/log.out index 4f82273012..1d0587a3e4 100644 --- a/generated/desktopvirtualization/log.out +++ b/generated/desktopvirtualization/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2022-02-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceModelWithAllowedPropertySet-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'ResourceModelWithAllowedPropertySet-sku' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' @@ -18,7 +18,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2021-09-03-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceModelWithAllowedPropertySet-identity' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'ResourceModelWithAllowedPropertySet-sku' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' @@ -27,10 +27,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 9ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2021-07-12"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/desktopvirtualization.json:2450:5 @@ -50,7 +50,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2019-01-23-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json:1813:5 @@ -60,10 +60,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperation-dis - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json:1834:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2019-09-24-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json:1813:5 @@ -76,7 +76,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2019-12-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json:1813:5 @@ -86,10 +86,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperation-dis - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json:1834:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2020-09-21-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-09-21-preview/desktopvirtualization.json:2096:5 @@ -103,10 +103,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2020-10-19-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-10-19-preview/desktopvirtualization.json:2096:5 @@ -120,10 +120,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2020-11-02-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-11-02-preview/desktopvirtualization.json:2096:5 @@ -140,7 +140,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2020-11-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2020-11-10-preview/desktopvirtualization.json:2408:5 @@ -154,10 +154,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2021-01-14-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-01-14-preview/desktopvirtualization.json:2450:5 @@ -177,7 +177,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-02-01-preview/desktopvirtualization.json:2450:5 @@ -194,10 +194,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2021-03-09-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-03-09-preview/desktopvirtualization.json:2450:5 @@ -214,10 +214,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.desktopvirtualization-2021-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-04-01-preview/desktopvirtualization.json:2908:5 @@ -238,5 +238,5 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 7ms -info | Autorest completed in 55.31s. 28 files generated. +info | autorest.bicep took 5ms +info | Autorest completed in 52.92s. 28 files generated. diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.md index e75b91ab70..37cc4b51d1 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.md @@ -50,11 +50,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **commandLineArguments**: string: Command Line Arguments for Application. @@ -96,14 +91,19 @@ ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.md index cf19d4ef6f..2fb3447550 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.md @@ -50,11 +50,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **commandLineArguments**: string: Command Line Arguments for Application. @@ -96,14 +91,19 @@ ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.md index 8ccb17b7ee..eeccda5388 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.md @@ -50,11 +50,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **commandLineArguments**: string: Command Line Arguments for Application. @@ -96,14 +91,19 @@ ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.md index 19b78b8506..1d6ce948de 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.md @@ -59,11 +59,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -97,16 +92,21 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MsixPackageApplications ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. -## TrackedResourceTags +## MsixPackageDependencies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -122,30 +122,30 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## TrackedResourceTags ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +### Additional Properties +* **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.md index f755172790..3cc81fc0d8 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.md @@ -59,11 +59,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -101,16 +96,21 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MsixPackageApplications ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. -## TrackedResourceTags +## MsixPackageDependencies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -126,30 +126,30 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## TrackedResourceTags ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +### Additional Properties +* **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.md index 92d376d4e6..2978578ab9 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.md @@ -59,11 +59,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -102,16 +97,21 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MsixPackageApplications ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. -## TrackedResourceTags +## MsixPackageDependencies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -127,30 +127,30 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## TrackedResourceTags ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +### Additional Properties +* **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.md index 8ecfec5f78..621f48f75d 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.md @@ -70,11 +70,6 @@ * **hostPoolArmPath**: string (Required): HostPool arm path of ApplicationGroup. * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -112,16 +107,21 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MsixPackageApplications ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. -## TrackedResourceTags +## MsixPackageDependencies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -137,21 +137,16 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## ScalingHostPoolReference ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -163,11 +158,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -194,14 +184,24 @@ ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties +## TrackedResourceTags ### Properties -* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. -* **description**: string: Description of Workspace. -* **friendlyName**: string: Friendly name of Workspace. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceProperties +### Properties +* **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. +* **description**: string: Description of Workspace. +* **friendlyName**: string: Friendly name of Workspace. + diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.md index d15f6dc759..bd400f46f1 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.md @@ -86,20 +86,6 @@ * **tags**: [ResourceModelWithAllowedPropertySetTags](#resourcemodelwithallowedpropertysettags): Resource tags. * **type**: 'Microsoft.DesktopVirtualization/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan -### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. - ## ApplicationGroupProperties ### Properties * **applicationGroupType**: 'Desktop' | 'RemoteApp' | string (Required): Resource Type of ApplicationGroup. @@ -111,24 +97,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -170,16 +138,26 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MigrationRequestProperties ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. -## ResourceModelWithAllowedPropertySetTags +## MsixPackageApplications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -195,21 +173,58 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## ResourceModelWithAllowedPropertySetIdentity ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -223,11 +238,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -249,11 +259,6 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: string: Starting time for ramp up period. -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceProperties ### Properties * **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. @@ -262,8 +267,3 @@ * **friendlyName**: string: Friendly name of Workspace. * **objectId**: string (ReadOnly): ObjectId of Workspace. (internal use) -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.md index 4945f8fff6..45082a626e 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.md @@ -86,20 +86,6 @@ * **tags**: [ResourceModelWithAllowedPropertySetTags](#resourcemodelwithallowedpropertysettags): Resource tags. * **type**: 'Microsoft.DesktopVirtualization/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan -### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. - ## ApplicationGroupProperties ### Properties * **applicationGroupType**: 'Desktop' | 'RemoteApp' | string (Required): Resource Type of ApplicationGroup. @@ -111,24 +97,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -170,16 +138,26 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MigrationRequestProperties ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. -## ResourceModelWithAllowedPropertySetTags +## MsixPackageApplications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -195,21 +173,58 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## ResourceModelWithAllowedPropertySetIdentity ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -223,11 +238,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -249,11 +259,6 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: string: Starting time for ramp up period. -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceProperties ### Properties * **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. @@ -262,8 +267,3 @@ * **friendlyName**: string: Friendly name of Workspace. * **objectId**: string (ReadOnly): ObjectId of Workspace. (internal use) -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.md index 685e0362e7..7876720472 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.md @@ -86,20 +86,6 @@ * **tags**: [ResourceModelWithAllowedPropertySetTags](#resourcemodelwithallowedpropertysettags): Resource tags. * **type**: 'Microsoft.DesktopVirtualization/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan -### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. - ## ApplicationGroupProperties ### Properties * **applicationGroupType**: 'Desktop' | 'RemoteApp' | string (Required): Resource Type of ApplicationGroup. @@ -111,24 +97,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -170,16 +138,26 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MigrationRequestProperties ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. -## ResourceModelWithAllowedPropertySetTags +## MsixPackageApplications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -195,21 +173,58 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## ResourceModelWithAllowedPropertySetIdentity ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -222,11 +237,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -248,11 +258,6 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: string: Starting time for ramp up period. -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceProperties ### Properties * **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. @@ -261,8 +266,3 @@ * **friendlyName**: string: Friendly name of Workspace. * **objectId**: string (ReadOnly): ObjectId of Workspace. (internal use) -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.md index 0aff772571..bdf12026ad 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.md @@ -106,20 +106,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan -### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. - ## ApplicationGroupProperties ### Properties * **applicationGroupType**: 'Desktop' | 'RemoteApp' | string (Required): Resource Type of ApplicationGroup. @@ -131,24 +117,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -191,16 +159,26 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MigrationRequestProperties ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. -## ResourceModelWithAllowedPropertySetTags +## MsixPackageApplications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -216,21 +194,9 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications -### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. - -## MsixPackageDependencies +## PrivateEndpoint ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -238,24 +204,64 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData +## RegistrationInfo ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. + +## ResourceModelWithAllowedPropertySetIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -268,11 +274,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -294,10 +295,14 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: string: Starting time for ramp up period. -## ResourceModelWithAllowedPropertySetTags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. ## WorkspaceProperties ### Properties @@ -308,8 +313,3 @@ * **objectId**: string (ReadOnly): ObjectId of Workspace. (internal use) * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.md index 1d750a718e..888242597a 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.md @@ -86,20 +86,6 @@ * **tags**: [ResourceModelWithAllowedPropertySetTags](#resourcemodelwithallowedpropertysettags): Resource tags. * **type**: 'Microsoft.DesktopVirtualization/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan -### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. - ## ApplicationGroupProperties ### Properties * **applicationGroupType**: 'Desktop' | 'RemoteApp' | string (Required): Resource Type of ApplicationGroup. @@ -111,24 +97,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -170,16 +138,26 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MigrationRequestProperties ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. -## ResourceModelWithAllowedPropertySetTags +## MsixPackageApplications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -195,21 +173,58 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications +## RegistrationInfo ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. -## MsixPackageDependencies +## ResourceModelWithAllowedPropertySetIdentity ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -222,11 +237,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -248,11 +258,6 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: string: Starting time for ramp up period. -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceProperties ### Properties * **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. @@ -261,8 +266,3 @@ * **friendlyName**: string: Friendly name of Workspace. * **objectId**: string (ReadOnly): ObjectId of Workspace. (internal use) -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.md index 724486c06c..a0cc190080 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.md @@ -112,20 +112,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan -### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. - ## ApplicationGroupProperties ### Properties * **applicationGroupType**: 'Desktop' | 'RemoteApp' | string (Required): Resource Type of ApplicationGroup. @@ -137,33 +123,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -206,16 +165,26 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## RegistrationInfo +## MigrationRequestProperties ### Properties -* **expirationTime**: string: Expiration time of registration token. -* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. -* **token**: string: The registration token base64 encoded string. +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. -## ResourceModelWithAllowedPropertySetTags +## MsixPackageApplications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. ## MsixPackageProperties ### Properties @@ -231,21 +200,9 @@ * **packageRelativePath**: string: Relative Path to the package inside the image. * **version**: string: Package Version found in the appxmanifest.xml. -## MsixPackageApplications -### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. - -## MsixPackageDependencies +## PrivateEndpoint ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -253,16 +210,65 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## RegistrationInfo +### Properties +* **expirationTime**: string: Expiration time of registration token. +* **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. +* **token**: string: The registration token base64 encoded string. + +## ResourceModelWithAllowedPropertySetIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceModelWithAllowedPropertySetTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. + ## ScalingPlanProperties ### Properties * **description**: string: Description of scaling plan. @@ -274,11 +280,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -300,16 +301,20 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: [Time](#time): The time for a scaling action to occur. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## Time ### Properties * **hour**: int (Required): The hour. * **minute**: int (Required): The minute. -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceProperties ### Properties * **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. @@ -319,8 +324,3 @@ * **objectId**: string (ReadOnly): ObjectId of Workspace. (internal use) * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.md b/generated/desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.md index 7edd8eefd3..a344543369 100644 --- a/generated/desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.md +++ b/generated/desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.md @@ -112,19 +112,12 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ResourceModelWithAllowedPropertySetIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## ResourceModelWithAllowedPropertySetPlan +## AgentUpdateProperties ### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. +* **maintenanceWindows**: [MaintenanceWindowProperties](#maintenancewindowproperties)[]: List of maintenance windows. Maintenance windows are 2 hours long. +* **maintenanceWindowTimeZone**: string: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. +* **type**: 'Default' | 'Scheduled' | string: The type of maintenance for session host components. +* **useSessionHostLocalTime**: bool: Whether to use localTime of the virtual machine. ## ApplicationGroupProperties ### Properties @@ -137,33 +130,6 @@ * **objectId**: string (ReadOnly): ObjectId of ApplicationGroup. (internal use) * **workspaceArmPath**: string (ReadOnly): Workspace arm path of ApplicationGroup. -## MigrationRequestProperties -### Properties -* **migrationPath**: string: The path to the legacy object to migrate. -* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. - -## ResourceModelWithAllowedPropertySetSku -### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationProperties ### Properties * **applicationType**: 'InBuilt' | 'MsixApplication' | string: Resource Type of Application. @@ -208,18 +174,50 @@ * **validationEnvironment**: bool: Is validation environment. * **vmTemplate**: string: VM template for sessionhosts configuration within hostpool. -## AgentUpdateProperties -### Properties -* **maintenanceWindows**: [MaintenanceWindowProperties](#maintenancewindowproperties)[]: List of maintenance windows. Maintenance windows are 2 hours long. -* **maintenanceWindowTimeZone**: string: Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. -* **type**: 'Default' | 'Scheduled' | string: The type of maintenance for session host components. -* **useSessionHostLocalTime**: bool: Whether to use localTime of the virtual machine. - ## MaintenanceWindowProperties ### Properties * **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Day of the week. * **hour**: int: The update start hour of the day. (0 - 23) +## MigrationRequestProperties +### Properties +* **migrationPath**: string: The path to the legacy object to migrate. +* **operation**: 'Complete' | 'Hide' | 'Revoke' | 'Start' | 'Unhide' | string: The type of operation for migration. + +## MsixPackageApplications +### Properties +* **appId**: string: Package Application Id, found in appxmanifest.xml. +* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. +* **description**: string: Description of Package Application. +* **friendlyName**: string: User friendly name. +* **iconImageName**: string: User friendly name. +* **rawIcon**: any: the icon a 64 bit string as a byte array. +* **rawPng**: any: the icon a 64 bit string as a byte array. + +## MsixPackageDependencies +### Properties +* **dependencyName**: string: Name of package dependency. +* **minVersion**: string: Dependency version required. +* **publisher**: string: Name of dependency publisher. + +## MsixPackageProperties +### Properties +* **displayName**: string: User friendly Name to be displayed in the portal. +* **imagePath**: string: VHD/CIM image path on Network Share. +* **isActive**: bool: Make this version of the package the active one across the hostpool. +* **isRegularRegistration**: bool: Specifies how to register Package in feed. +* **lastUpdated**: string: Date Package was last updated, found in the appxmanifest.xml. +* **packageApplications**: [MsixPackageApplications](#msixpackageapplications)[]: List of package applications. +* **packageDependencies**: [MsixPackageDependencies](#msixpackagedependencies)[]: List of package dependencies. +* **packageFamilyName**: string: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. +* **packageName**: string: Package Name from appxmanifest.xml. +* **packageRelativePath**: string: Relative Path to the package inside the image. +* **version**: string: Package Version found in the appxmanifest.xml. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -233,10 +231,6 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. @@ -249,40 +243,52 @@ * **registrationTokenOperation**: 'Delete' | 'None' | 'Update' | string: The type of resetting the token. * **token**: string: The registration token base64 encoded string. +## ResourceModelWithAllowedPropertySetIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## ResourceModelWithAllowedPropertySetPlan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## ResourceModelWithAllowedPropertySetSku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + ## ResourceModelWithAllowedPropertySetTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MsixPackageProperties +## ResourceModelWithAllowedPropertySetTags ### Properties -* **displayName**: string: User friendly Name to be displayed in the portal. -* **imagePath**: string: VHD/CIM image path on Network Share. -* **isActive**: bool: Make this version of the package the active one across the hostpool. -* **isRegularRegistration**: bool: Specifies how to register Package in feed. -* **lastUpdated**: string: Date Package was last updated, found in the appxmanifest.xml. -* **packageApplications**: [MsixPackageApplications](#msixpackageapplications)[]: List of package applications. -* **packageDependencies**: [MsixPackageDependencies](#msixpackagedependencies)[]: List of package dependencies. -* **packageFamilyName**: string: Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. -* **packageName**: string: Package Name from appxmanifest.xml. -* **packageRelativePath**: string: Relative Path to the package inside the image. -* **version**: string: Package Version found in the appxmanifest.xml. +### Additional Properties +* **Additional Properties Type**: string -## MsixPackageApplications +## ResourceModelWithAllowedPropertySetTags ### Properties -* **appId**: string: Package Application Id, found in appxmanifest.xml. -* **appUserModelID**: string: Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. -* **description**: string: Description of Package Application. -* **friendlyName**: string: User friendly name. -* **iconImageName**: string: User friendly name. -* **rawIcon**: any: the icon a 64 bit string as a byte array. -* **rawPng**: any: the icon a 64 bit string as a byte array. +### Additional Properties +* **Additional Properties Type**: string -## MsixPackageDependencies +## ResourceModelWithAllowedPropertySetTags ### Properties -* **dependencyName**: string: Name of package dependency. -* **minVersion**: string: Dependency version required. -* **publisher**: string: Name of dependency publisher. +### Additional Properties +* **Additional Properties Type**: string + +## ScalingHostPoolReference +### Properties +* **hostPoolArmPath**: string: Arm path of referenced hostpool. +* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. ## ScalingPlanProperties ### Properties @@ -295,11 +301,6 @@ * **schedules**: [ScalingSchedule](#scalingschedule)[]: List of ScalingSchedule definitions. * **timeZone**: string: Timezone of the scaling plan. -## ScalingHostPoolReference -### Properties -* **hostPoolArmPath**: string: Arm path of referenced hostpool. -* **scalingPlanEnabled**: bool: Is the scaling plan enabled for this hostpool. - ## ScalingSchedule ### Properties * **daysOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Set of days of the week on which this schedule is active. @@ -321,16 +322,20 @@ * **rampUpMinimumHostsPct**: int: Minimum host percentage for ramp up period. * **rampUpStartTime**: [Time](#time): The time for a scaling action to occur. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## Time ### Properties * **hour**: int (Required): The hour. * **minute**: int (Required): The minute. -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceProperties ### Properties * **applicationGroupReferences**: string[]: List of applicationGroup resource Ids. @@ -341,8 +346,3 @@ * **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified resource * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints -## ResourceModelWithAllowedPropertySetTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/deviceprovisioningservices/log.out b/generated/deviceprovisioningservices/log.out index ce68144d2c..8b311988aa 100644 --- a/generated/deviceprovisioningservices/log.out +++ b/generated/deviceprovisioningservices/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.devices-2022-02-05"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-02-05/iotdps.json:2202:5 @@ -20,10 +20,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-02-05/iotdps.json:2407:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 17ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.devices-2020-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/iotdps.json:2256:5 @@ -36,10 +36,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource' with an undefin warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/iotdps.json:2461:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json:2174:5 @@ -56,7 +56,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2017-08-21-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json:1555:5 @@ -65,10 +65,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json:1618:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2017-11-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2017-11-15/iotdps.json:1633:5 @@ -84,7 +84,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2018-01-22"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2018-01-22/iotdps.json:1633:5 @@ -100,7 +100,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2020-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-01-01/iotdps.json:1690:5 @@ -114,10 +114,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-01-01/iotdps.json:1895:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.devices-2021-10-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2021-10-15/iotdps.json:2190:5 @@ -132,4 +132,4 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 3ms -info | Autorest completed in 20.46s. 16 files generated. +info | Autorest completed in 19.71s. 16 files generated. diff --git a/generated/deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.md b/generated/deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.md index 2cf25c0668..90527e150e 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.md @@ -34,6 +34,15 @@ * **ApiVersion**: 2017-08-21-preview * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -45,12 +54,11 @@ * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of services of the selected tier allowed in the subscription. +* **name**: 'S1' | string +* **tier**: string (ReadOnly): Pricing tier of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -60,30 +68,17 @@ * **location**: string (Required): ARM region of the IoT hub. * **name**: string (ReadOnly): Host name of the IoT hub. -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of services of the selected tier allowed in the subscription. -* **name**: 'S1' | string -* **tier**: string (ReadOnly): Pricing tier of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly) -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): Array of SharedAccessSignatureAuthorizationRule_AccessRightsDescription_ +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -92,3 +87,8 @@ * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly) +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): Array of SharedAccessSignatureAuthorizationRule_AccessRightsDescription_ + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2017-11-15/types.md b/generated/deviceprovisioningservices/microsoft.devices/2017-11-15/types.md index 0b6e882289..6cf25af5c2 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2017-11-15/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2017-11-15/types.md @@ -34,6 +34,15 @@ * **ApiVersion**: 2017-11-15 * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -45,12 +54,11 @@ * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -60,30 +68,17 @@ * **location**: string (Required): ARM region of the IoT hub. * **name**: string (ReadOnly): Host name of the IoT hub. -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -92,3 +87,8 @@ * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2018-01-22/types.md b/generated/deviceprovisioningservices/microsoft.devices/2018-01-22/types.md index 64a8d0a72b..72d254464a 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2018-01-22/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2018-01-22/types.md @@ -34,6 +34,15 @@ * **ApiVersion**: 2018-01-22 * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -45,12 +54,11 @@ * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -60,30 +68,17 @@ * **location**: string (Required): ARM region of the IoT hub. * **name**: string (ReadOnly): Host name of the IoT hub. -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -92,3 +87,8 @@ * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2020-01-01/types.md b/generated/deviceprovisioningservices/microsoft.devices/2020-01-01/types.md index b73d881d8e..c104643957 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2020-01-01/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2020-01-01/types.md @@ -34,6 +34,16 @@ * **ApiVersion**: 2020-01-01 * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **certificate**: any (ReadOnly): base-64 representation of X509 certificate .cer file or just .pem file content. +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -46,12 +56,11 @@ * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -68,31 +77,17 @@ * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. * **target**: 'all' | 'deviceApi' | 'serviceApi': Target for requests captured by this rule. -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **certificate**: any (ReadOnly): base-64 representation of X509 certificate .cer file or just .pem file content. -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -101,3 +96,8 @@ * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2020-03-01/types.md b/generated/deviceprovisioningservices/microsoft.devices/2020-03-01/types.md index a2a3c2eb88..347bbdd213 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2020-03-01/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2020-03-01/types.md @@ -44,6 +44,16 @@ * **ApiVersion**: 2020-03-01 * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **certificate**: any (ReadOnly): base-64 representation of X509 certificate .cer file or just .pem file content. +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -58,12 +68,11 @@ * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -80,6 +89,10 @@ * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. * **target**: 'all' | 'deviceApi' | 'serviceApi': Target for requests captured by this rule. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -92,41 +105,23 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **certificate**: any (ReadOnly): base-64 representation of X509 certificate .cer file or just .pem file content. -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -135,3 +130,8 @@ * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.md b/generated/deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.md index aa430454aa..e59ef8cd05 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.md @@ -61,6 +61,25 @@ * **clientId**: string (ReadOnly): Client Id * **principalId**: string (ReadOnly): Principal Id +## CertificateProperties +### Properties +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## EncryptionKeyIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity. + +## EncryptionPropertiesDescription +### Properties +* **identity**: [EncryptionKeyIdentity](#encryptionkeyidentity): The properties of the identity used to access the key encryption key in KeyVault. +* **keySource**: string: The source of the encryption key. Typically, Microsoft.KeyVault +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the encryption key configured in KeyVault. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -76,26 +95,11 @@ * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription -### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. - -## EncryptionPropertiesDescription -### Properties -* **identity**: [EncryptionKeyIdentity](#encryptionkeyidentity): The properties of the identity used to access the key encryption key in KeyVault. -* **keySource**: string: The source of the encryption key. Typically, Microsoft.KeyVault -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the encryption key configured in KeyVault. - -## EncryptionKeyIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity. - -## KeyVaultKeyProperties +## IotDpsSkuInfo ### Properties -* **keyIdentifier**: string: The identifier of the key. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -112,6 +116,14 @@ * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. * **target**: 'all' | 'deviceApi' | 'serviceApi': Target for requests captured by this rule. +## KeyVaultKeyProperties +### Properties +* **keyIdentifier**: string: The identifier of the key. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -124,40 +136,23 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -166,3 +161,8 @@ * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2021-10-15/types.md b/generated/deviceprovisioningservices/microsoft.devices/2021-10-15/types.md index 65fcee6a14..6b060aac5b 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2021-10-15/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2021-10-15/types.md @@ -47,6 +47,16 @@ * **ApiVersion**: 2021-10-15 * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **certificate**: any (ReadOnly): base-64 representation of X509 certificate .cer file or just .pem file content. +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -63,12 +73,11 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -85,6 +94,10 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. * **target**: 'all' | 'deviceApi' | 'serviceApi': Target for requests captured by this rule. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -98,50 +111,23 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **certificate**: any (ReadOnly): base-64 representation of X509 certificate .cer file or just .pem file content. -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -150,3 +136,17 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. + diff --git a/generated/deviceprovisioningservices/microsoft.devices/2022-02-05/types.md b/generated/deviceprovisioningservices/microsoft.devices/2022-02-05/types.md index 3a4de8b438..227f358987 100644 --- a/generated/deviceprovisioningservices/microsoft.devices/2022-02-05/types.md +++ b/generated/deviceprovisioningservices/microsoft.devices/2022-02-05/types.md @@ -45,6 +45,16 @@ * **ApiVersion**: 2022-02-05 * **Output**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription) +## CertificateProperties +### Properties +* **certificate**: any: base-64 representation of X509 certificate .cer file or just .pem file content. +* **created**: string (ReadOnly): The certificate's creation date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool: Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + ## IotDpsPropertiesDescription ### Properties * **allocationPolicy**: 'GeoLatency' | 'Hashed' | 'Static' | string: Allocation policy to be used by this provisioning service. @@ -61,12 +71,11 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **serviceOperationsHostName**: string (ReadOnly): Service endpoint for provisioning service. * **state**: 'Activating' | 'ActivationFailed' | 'Active' | 'Deleted' | 'Deleting' | 'DeletionFailed' | 'FailingOver' | 'FailoverFailed' | 'Resuming' | 'Suspended' | 'Suspending' | 'Transitioning' | string: Current state of the provisioning service. -## SharedAccessSignatureAuthorizationRuleAccessRightsDescription +## IotDpsSkuInfo ### Properties -* **keyName**: string (Required): Name of the key. -* **primaryKey**: string: Primary SAS key value. -* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. -* **secondaryKey**: string: Secondary SAS key value. +* **capacity**: int: The number of units to provision +* **name**: 'S1' | string: Sku name. +* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. ## IotHubDefinitionDescription ### Properties @@ -83,6 +92,10 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. * **target**: 'all' | 'deviceApi' | 'serviceApi': Target for requests captured by this rule. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -96,50 +109,23 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## IotDpsSkuInfo -### Properties -* **capacity**: int: The number of units to provision -* **name**: 'S1' | string: Sku name. -* **tier**: string (ReadOnly): Pricing tier name of the provisioning service. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateProperties -### Properties -* **certificate**: any: base-64 representation of X509 certificate .cer file or just .pem file content. -* **created**: string (ReadOnly): The certificate's creation date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool: Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): Name of the key. +* **primaryKey**: string: Primary SAS key value. +* **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. +* **secondaryKey**: string: Secondary SAS key value. ## SharedAccessSignatureAuthorizationRuleAccessRightsDescription ### Properties @@ -148,3 +134,17 @@ Indicates if the DPS instance has Data Residency enabled, removing the cross geo * **rights**: 'DeviceConnect' | 'EnrollmentRead' | 'EnrollmentWrite' | 'RegistrationStatusRead' | 'RegistrationStatusWrite' | 'ServiceConfig' | string (Required): Rights that this key has. * **secondaryKey**: string: Secondary SAS key value. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRuleAccessRightsDescription](#sharedaccesssignatureauthorizationruleaccessrightsdescription)[] (ReadOnly): The list of shared access policies. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/deviceupdate/log.out b/generated/deviceupdate/log.out index a048e295ef..bb5a6b687a 100644 --- a/generated/deviceupdate/log.out +++ b/generated/deviceupdate/log.out @@ -5,27 +5,27 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.deviceupdate-2022-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkServiceProxy-remotePrivateEndpointConnection' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-04-01-preview/deviceupdate.json:1783:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'PrivateEndpointConnectionProxyProperties' -> 'PrivateEndpointConnectionProxyPropertiesAutoGenerated' -info | autorest.bicep took 13ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.deviceupdate-2020-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkServiceProxy-remotePrivateEndpointConnection' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json:1748:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'PrivateEndpointConnectionProxyProperties' -> 'PrivateEndpointConnectionProxyPropertiesAutoGenerated' -info | autorest.bicep took 5ms -info | Autorest completed in 7.85s. 4 files generated. +info | autorest.bicep took 6ms +info | Autorest completed in 7.44s. 4 files generated. diff --git a/generated/deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.md b/generated/deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.md index 8342088286..ae5e2b0be8 100644 --- a/generated/deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.md +++ b/generated/deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.md @@ -48,29 +48,60 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DeviceUpdate/accounts/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity +## AccountProperties ### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. +* **hostName**: string (ReadOnly): API host name. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections associated with the account. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the account. -## UserAssignedIdentities +## ConnectionDetails ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **groupId**: string (ReadOnly): Group ID. +* **id**: string (ReadOnly): Connection details ID. +* **linkIdentifier**: string (ReadOnly): Link ID. +* **memberName**: string (ReadOnly): Member name. +* **privateIpAddress**: string (ReadOnly): Private IP address. -## UserAssignedIdentity +## DiagnosticStorageProperties ### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. +* **authenticationType**: 'KeyBased' | string (Required): Authentication Type +* **connectionString**: string: ConnectionString of the diagnostic storage account +* **resourceId**: string (Required): ResourceId of the diagnostic storage account -## AccountProperties +## GroupConnectivityInformation ### Properties -* **hostName**: string (ReadOnly): API host name. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections associated with the account. +* **customerVisibleFqdns**: string[]: List of customer visible FQDNs. +* **groupId**: string (ReadOnly): Group ID. +* **internalFqdn**: string (ReadOnly): Internal FQDN. +* **memberName**: string (ReadOnly): Member name. +* **privateLinkServiceArmRegion**: string: PrivateLinkService ARM region. +* **redirectMapId**: string: Redirect map ID. + +## InstanceProperties +### Properties +* **accountName**: string (ReadOnly): Parent Device Update Account name which Instance belongs to. +* **diagnosticStorageProperties**: [DiagnosticStorageProperties](#diagnosticstorageproperties): Customer-initiated diagnostic log collection storage properties +* **enableDiagnostics**: bool: Enables or Disables the diagnostic logs collection +* **iotHubs**: [IotHubSettings](#iothubsettings)[]: List of IoT Hubs associated with the account. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the account. + +## IotHubSettings +### Properties +* **eventHubConnectionString**: string: EventHub connection string. +* **ioTHubConnectionString**: string: IoTHub connection string. +* **resourceId**: string (Required): IoTHub resource ID + +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -87,9 +118,15 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateEndpointConnectionProxyProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnection +### Properties +* **groupIds**: string[]: List of group IDs. +* **name**: string: Private link service connection name. +* **requestMessage**: string: Request message. ## PrivateLinkServiceConnectionState ### Properties @@ -97,48 +134,16 @@ * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstanceProperties -### Properties -* **accountName**: string (ReadOnly): Parent Device Update Account name which Instance belongs to. -* **diagnosticStorageProperties**: [DiagnosticStorageProperties](#diagnosticstorageproperties): Customer-initiated diagnostic log collection storage properties -* **enableDiagnostics**: bool: Enables or Disables the diagnostic logs collection -* **iotHubs**: [IotHubSettings](#iothubsettings)[]: List of IoT Hubs associated with the account. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state. - -## DiagnosticStorageProperties -### Properties -* **authenticationType**: 'KeyBased' | string (Required): Authentication Type -* **connectionString**: string: ConnectionString of the diagnostic storage account -* **resourceId**: string (Required): ResourceId of the diagnostic storage account - -## IotHubSettings -### Properties -* **eventHubConnectionString**: string: EventHub connection string. -* **ioTHubConnectionString**: string: IoTHub connection string. -* **resourceId**: string (Required): IoTHub resource ID - -## TrackedResourceTags +## PrivateLinkServiceProxy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **groupConnectivityInformation**: [GroupConnectivityInformation](#groupconnectivityinformation)[]: Group connectivity information. +* **id**: string: NRP resource ID. +* **remotePrivateEndpointConnection**: [PrivateLinkServiceProxyRemotePrivateEndpointConnection](#privatelinkserviceproxyremoteprivateendpointconnection): Remote private endpoint connection details. +* **remotePrivateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -## PrivateEndpointConnectionProxyProperties +## PrivateLinkServiceProxyRemotePrivateEndpointConnection ### Properties -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **id**: string (ReadOnly): Remote private endpoint connection ID. ## RemotePrivateEndpoint ### Properties @@ -152,37 +157,32 @@ * **privateLinkServiceProxies**: [PrivateLinkServiceProxy](#privatelinkserviceproxy)[]: List of private link service proxies. * **vnetTrafficTag**: string: Virtual network traffic tag. -## ConnectionDetails +## SystemData ### Properties -* **groupId**: string (ReadOnly): Group ID. -* **id**: string (ReadOnly): Connection details ID. -* **linkIdentifier**: string (ReadOnly): Link ID. -* **memberName**: string (ReadOnly): Member name. -* **privateIpAddress**: string (ReadOnly): Private IP address. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PrivateLinkServiceConnection +## TrackedResourceTags ### Properties -* **groupIds**: string[]: List of group IDs. -* **name**: string: Private link service connection name. -* **requestMessage**: string: Request message. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceProxy +## TrackedResourceTags ### Properties -* **groupConnectivityInformation**: [GroupConnectivityInformation](#groupconnectivityinformation)[]: Group connectivity information. -* **id**: string: NRP resource ID. -* **remotePrivateEndpointConnection**: [PrivateLinkServiceProxyRemotePrivateEndpointConnection](#privatelinkserviceproxyremoteprivateendpointconnection): Remote private endpoint connection details. -* **remotePrivateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +### Additional Properties +* **Additional Properties Type**: string -## GroupConnectivityInformation +## UserAssignedIdentities ### Properties -* **customerVisibleFqdns**: string[]: List of customer visible FQDNs. -* **groupId**: string (ReadOnly): Group ID. -* **internalFqdn**: string (ReadOnly): Internal FQDN. -* **memberName**: string (ReadOnly): Member name. -* **privateLinkServiceArmRegion**: string: PrivateLinkService ARM region. -* **redirectMapId**: string: Redirect map ID. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## PrivateLinkServiceProxyRemotePrivateEndpointConnection +## UserAssignedIdentity ### Properties -* **id**: string (ReadOnly): Remote private endpoint connection ID. +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. diff --git a/generated/deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.md b/generated/deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.md index 0afae40f9c..e042ab7602 100644 --- a/generated/deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.md +++ b/generated/deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.md @@ -48,23 +48,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DeviceUpdate/accounts/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - ## AccountProperties ### Properties * **hostName**: string (ReadOnly): API host name. @@ -74,11 +57,57 @@ * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for the account. * **sku**: 'Free' | 'Standard' | string: Device Update Sku +## ConnectionDetails +### Properties +* **groupId**: string (ReadOnly): Group ID. +* **id**: string (ReadOnly): Connection details ID. +* **linkIdentifier**: string (ReadOnly): Link ID. +* **memberName**: string (ReadOnly): Member name. +* **privateIpAddress**: string (ReadOnly): Private IP address. + +## DiagnosticStorageProperties +### Properties +* **authenticationType**: 'KeyBased' | string (Required): Authentication Type +* **connectionString**: string: ConnectionString of the diagnostic storage account +* **resourceId**: string (Required): ResourceId of the diagnostic storage account + +## GroupConnectivityInformation +### Properties +* **customerVisibleFqdns**: string[]: List of customer visible FQDNs. +* **groupId**: string (ReadOnly): Group ID. +* **internalFqdn**: string (ReadOnly): Internal FQDN. +* **memberName**: string (ReadOnly): Member name. +* **privateLinkServiceArmRegion**: string: PrivateLinkService ARM region. +* **redirectMapId**: string: Redirect map ID. + +## InstanceProperties +### Properties +* **accountName**: string (ReadOnly): Parent Device Update Account name which Instance belongs to. +* **diagnosticStorageProperties**: [DiagnosticStorageProperties](#diagnosticstorageproperties): Customer-initiated diagnostic log collection storage properties +* **enableDiagnostics**: bool: Enables or Disables the diagnostic logs collection +* **iotHubs**: [IotHubSettings](#iothubsettings)[]: List of IoT Hubs associated with the account. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state. + +## IotHubSettings +### Properties +* **resourceId**: string (Required): IoTHub resource ID + ## Location ### Properties * **name**: string * **role**: 'Failover' | 'Primary' | string: Whether the location is primary or failover +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -94,9 +123,15 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## PrivateEndpointConnectionProxyProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnection +### Properties +* **groupIds**: string[]: List of group IDs. +* **name**: string: Private link service connection name. +* **requestMessage**: string: Request message. ## PrivateLinkServiceConnectionState ### Properties @@ -104,46 +139,16 @@ * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstanceProperties -### Properties -* **accountName**: string (ReadOnly): Parent Device Update Account name which Instance belongs to. -* **diagnosticStorageProperties**: [DiagnosticStorageProperties](#diagnosticstorageproperties): Customer-initiated diagnostic log collection storage properties -* **enableDiagnostics**: bool: Enables or Disables the diagnostic logs collection -* **iotHubs**: [IotHubSettings](#iothubsettings)[]: List of IoT Hubs associated with the account. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state. - -## DiagnosticStorageProperties -### Properties -* **authenticationType**: 'KeyBased' | string (Required): Authentication Type -* **connectionString**: string: ConnectionString of the diagnostic storage account -* **resourceId**: string (Required): ResourceId of the diagnostic storage account - -## IotHubSettings -### Properties -* **resourceId**: string (Required): IoTHub resource ID - -## TrackedResourceTags +## PrivateLinkServiceProxy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **groupConnectivityInformation**: [GroupConnectivityInformation](#groupconnectivityinformation)[]: Group connectivity information. +* **id**: string: NRP resource ID. +* **remotePrivateEndpointConnection**: [PrivateLinkServiceProxyRemotePrivateEndpointConnection](#privatelinkserviceproxyremoteprivateendpointconnection): Remote private endpoint connection details. +* **remotePrivateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -## PrivateEndpointConnectionProxyProperties +## PrivateLinkServiceProxyRemotePrivateEndpointConnection ### Properties -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **id**: string (ReadOnly): Remote private endpoint connection ID. ## RemotePrivateEndpoint ### Properties @@ -157,37 +162,32 @@ * **privateLinkServiceProxies**: [PrivateLinkServiceProxy](#privatelinkserviceproxy)[]: List of private link service proxies. * **vnetTrafficTag**: string: Virtual network traffic tag. -## ConnectionDetails +## SystemData ### Properties -* **groupId**: string (ReadOnly): Group ID. -* **id**: string (ReadOnly): Connection details ID. -* **linkIdentifier**: string (ReadOnly): Link ID. -* **memberName**: string (ReadOnly): Member name. -* **privateIpAddress**: string (ReadOnly): Private IP address. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## PrivateLinkServiceConnection +## TrackedResourceTags ### Properties -* **groupIds**: string[]: List of group IDs. -* **name**: string: Private link service connection name. -* **requestMessage**: string: Request message. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceProxy +## TrackedResourceTags ### Properties -* **groupConnectivityInformation**: [GroupConnectivityInformation](#groupconnectivityinformation)[]: Group connectivity information. -* **id**: string: NRP resource ID. -* **remotePrivateEndpointConnection**: [PrivateLinkServiceProxyRemotePrivateEndpointConnection](#privatelinkserviceproxyremoteprivateendpointconnection): Remote private endpoint connection details. -* **remotePrivateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +### Additional Properties +* **Additional Properties Type**: string -## GroupConnectivityInformation +## UserAssignedIdentities ### Properties -* **customerVisibleFqdns**: string[]: List of customer visible FQDNs. -* **groupId**: string (ReadOnly): Group ID. -* **internalFqdn**: string (ReadOnly): Internal FQDN. -* **memberName**: string (ReadOnly): Member name. -* **privateLinkServiceArmRegion**: string: PrivateLinkService ARM region. -* **redirectMapId**: string: Redirect map ID. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## PrivateLinkServiceProxyRemotePrivateEndpointConnection +## UserAssignedIdentity ### Properties -* **id**: string (ReadOnly): Remote private endpoint connection ID. +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. diff --git a/generated/devops/log.out b/generated/devops/log.out index 20b9d2e2ca..58d70872b7 100644 --- a/generated/devops/log.out +++ b/generated/devops/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.devops-2020-07-13-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/devops/resource-manager/Microsoft.DevOps/preview/2020-07-13-preview/devops.json:405:5 @@ -21,10 +21,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationDisplayValue' with a warning | PreCheck/SchemaMissingType | The schema 'PipelineListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/devops/resource-manager/Microsoft.DevOps/preview/2020-07-13-preview/devops.json:884:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.devops-2019-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/devops.json:402:5 @@ -39,5 +39,5 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationDisplayValue' with a warning | PreCheck/SchemaMissingType | The schema 'PipelineListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/devops.json:829:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 6.17s. 4 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 5.99s. 4 files generated. diff --git a/generated/devops/microsoft.devops/2019-07-01-preview/types.md b/generated/devops/microsoft.devops/2019-07-01-preview/types.md index 38ea29671e..a05ee5f435 100644 --- a/generated/devops/microsoft.devops/2019-07-01-preview/types.md +++ b/generated/devops/microsoft.devops/2019-07-01-preview/types.md @@ -11,12 +11,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource Tags * **type**: 'Microsoft.DevOps/pipelines' (ReadOnly, DeployTimeConstant): The resource type -## PipelineProperties +## Authorization ### Properties -* **bootstrapConfiguration**: [BootstrapConfiguration](#bootstrapconfiguration) (Required): Configuration used to bootstrap a Pipeline. -* **organization**: [OrganizationReference](#organizationreference) (Required): Reference to an Azure DevOps Organization. -* **pipelineId**: int (ReadOnly): Unique identifier of the Azure Pipeline within the Azure DevOps Project. -* **project**: [ProjectReference](#projectreference) (Required): Reference to an Azure DevOps Project. +* **authorizationType**: 'personalAccessToken' | string (Required): Type of authorization. +* **parameters**: [AuthorizationParameters](#authorizationparameters): Authorization parameters corresponding to the authorization type. + +## AuthorizationParameters +### Properties +### Additional Properties +* **Additional Properties Type**: string ## BootstrapConfiguration ### Properties @@ -31,20 +34,22 @@ * **properties**: [CodeRepositoryProperties](#coderepositoryproperties): Repository-specific properties. * **repositoryType**: 'gitHub' | 'vstsGit' | string (Required): Type of code repository. -## Authorization -### Properties -* **authorizationType**: 'personalAccessToken' | string (Required): Type of authorization. -* **parameters**: [AuthorizationParameters](#authorizationparameters): Authorization parameters corresponding to the authorization type. - -## AuthorizationParameters +## CodeRepositoryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## CodeRepositoryProperties +## OrganizationReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Unique immutable identifier for the Azure DevOps Organization. +* **name**: string (Required): Name of the Azure DevOps Organization. + +## PipelineProperties +### Properties +* **bootstrapConfiguration**: [BootstrapConfiguration](#bootstrapconfiguration) (Required): Configuration used to bootstrap a Pipeline. +* **organization**: [OrganizationReference](#organizationreference) (Required): Reference to an Azure DevOps Organization. +* **pipelineId**: int (ReadOnly): Unique identifier of the Azure Pipeline within the Azure DevOps Project. +* **project**: [ProjectReference](#projectreference) (Required): Reference to an Azure DevOps Project. ## PipelineTemplate ### Properties @@ -56,11 +61,6 @@ ### Additional Properties * **Additional Properties Type**: string -## OrganizationReference -### Properties -* **id**: string (ReadOnly): Unique immutable identifier for the Azure DevOps Organization. -* **name**: string (Required): Name of the Azure DevOps Organization. - ## ProjectReference ### Properties * **id**: string (ReadOnly): Unique immutable identifier of the Azure DevOps Project. diff --git a/generated/devops/microsoft.devops/2020-07-13-preview/types.md b/generated/devops/microsoft.devops/2020-07-13-preview/types.md index 9769474446..17415f97ef 100644 --- a/generated/devops/microsoft.devops/2020-07-13-preview/types.md +++ b/generated/devops/microsoft.devops/2020-07-13-preview/types.md @@ -12,23 +12,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource Tags * **type**: 'Microsoft.DevOps/pipelines' (ReadOnly, DeployTimeConstant): The resource type -## PipelineProperties -* **Discriminator**: pipelineType - -### Base Properties -* **bootstrapConfiguration**: [BootstrapConfiguration](#bootstrapconfiguration) (Required): Configuration used to bootstrap a Pipeline. -* **pipelineId**: int (ReadOnly): Unique identifier of the Pipeline -### AzurePipelineProperties -#### Properties -* **organization**: [OrganizationReference](#organizationreference) (Required): Reference to an Azure DevOps Organization. -* **pipelineType**: 'azurePipeline' (Required): Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. -* **project**: [ProjectReference](#projectreference) (Required): Reference to an Azure DevOps Project. - -### GithubWorkflowProperties -#### Properties -* **pipelineType**: 'githubWorkflow' (Required): Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. -* **repository**: [CodeRepository](#coderepository) (Required): Repository containing the source code for a pipeline. +## Authorization +### Properties +* **authorizationType**: 'personalAccessToken' | string (Required): Type of authorization. +* **parameters**: [AuthorizationParameters](#authorizationparameters): Authorization parameters corresponding to the authorization type. +## AuthorizationParameters +### Properties +### Additional Properties +* **Additional Properties Type**: string ## BootstrapConfiguration ### Properties @@ -43,20 +35,33 @@ * **properties**: [CodeRepositoryProperties](#coderepositoryproperties): Repository-specific properties. * **repositoryType**: 'gitHub' | 'vstsGit' | string (Required): Type of code repository. -## Authorization -### Properties -* **authorizationType**: 'personalAccessToken' | string (Required): Type of authorization. -* **parameters**: [AuthorizationParameters](#authorizationparameters): Authorization parameters corresponding to the authorization type. - -## AuthorizationParameters +## CodeRepositoryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## CodeRepositoryProperties +## OrganizationReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Unique immutable identifier for the Azure DevOps Organization. +* **name**: string (Required): Name of the Azure DevOps Organization. + +## PipelineProperties +* **Discriminator**: pipelineType + +### Base Properties +* **bootstrapConfiguration**: [BootstrapConfiguration](#bootstrapconfiguration) (Required): Configuration used to bootstrap a Pipeline. +* **pipelineId**: int (ReadOnly): Unique identifier of the Pipeline +### AzurePipelineProperties +#### Properties +* **organization**: [OrganizationReference](#organizationreference) (Required): Reference to an Azure DevOps Organization. +* **pipelineType**: 'azurePipeline' (Required): Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. +* **project**: [ProjectReference](#projectreference) (Required): Reference to an Azure DevOps Project. + +### GithubWorkflowProperties +#### Properties +* **pipelineType**: 'githubWorkflow' (Required): Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. +* **repository**: [CodeRepository](#coderepository) (Required): Repository containing the source code for a pipeline. + ## PipelineTemplate ### Properties @@ -68,16 +73,16 @@ ### Additional Properties * **Additional Properties Type**: string -## OrganizationReference -### Properties -* **id**: string (ReadOnly): Unique immutable identifier for the Azure DevOps Organization. -* **name**: string (Required): Name of the Azure DevOps Organization. - ## ProjectReference ### Properties * **id**: string (ReadOnly): Unique immutable identifier of the Azure DevOps Project. * **name**: string (Required): Name of the Azure DevOps Project. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -87,8 +92,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/devspaces/log.out b/generated/devspaces/log.out index 19b12341b6..e8443625c8 100644 --- a/generated/devspaces/log.out +++ b/generated/devspaces/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.devspaces-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ContainerHostMapping' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/devspaces.json:440:5 @@ -52,4 +52,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefin - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/devspaces.json:763:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 12ms -info | Autorest completed in 4.63s. 2 files generated. +info | Autorest completed in 4.51s. 2 files generated. diff --git a/generated/devspaces/microsoft.devspaces/2019-04-01/types.md b/generated/devspaces/microsoft.devspaces/2019-04-01/types.md index 908df5eca0..cd211231f2 100644 --- a/generated/devspaces/microsoft.devspaces/2019-04-01/types.md +++ b/generated/devspaces/microsoft.devspaces/2019-04-01/types.md @@ -18,6 +18,14 @@ * **Input**: [ListConnectionDetailsParameters](#listconnectiondetailsparameters) * **Output**: [ControllerConnectionDetailsList](#controllerconnectiondetailslist) +## ControllerConnectionDetails +### Properties +* **orchestratorSpecificConnectionDetails**: [OrchestratorSpecificConnectionDetails](#orchestratorspecificconnectiondetails) (ReadOnly): Base class for types that supply values used to connect to container orchestrators + +## ControllerConnectionDetailsList +### Properties +* **connectionDetailsList**: [ControllerConnectionDetails](#controllerconnectiondetails)[] (ReadOnly): List of Azure Dev Spaces Controller connection details. + ## ControllerProperties ### Properties * **dataPlaneFqdn**: string (ReadOnly): DNS name for accessing DataPlane services @@ -27,28 +35,10 @@ * **targetContainerHostCredentialsBase64**: string (Required, WriteOnly): Credentials of the target container host (base64). * **targetContainerHostResourceId**: string (Required): Resource ID of the target container host -## Sku -### Properties -* **name**: 'S1' | string (Required): The name of the SKU for Azure Dev Spaces Controller. -* **tier**: 'Standard' | string: The tier of the SKU for Azure Dev Spaces Controller. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ListConnectionDetailsParameters ### Properties * **targetContainerHostResourceId**: string (Required, WriteOnly): Resource ID of the target container host mapped to the Azure Dev Spaces Controller. -## ControllerConnectionDetailsList -### Properties -* **connectionDetailsList**: [ControllerConnectionDetails](#controllerconnectiondetails)[] (ReadOnly): List of Azure Dev Spaces Controller connection details. - -## ControllerConnectionDetails -### Properties -* **orchestratorSpecificConnectionDetails**: [OrchestratorSpecificConnectionDetails](#orchestratorspecificconnectiondetails) (ReadOnly): Base class for types that supply values used to connect to container orchestrators - ## OrchestratorSpecificConnectionDetails * **Discriminator**: instanceType @@ -59,3 +49,13 @@ * **kubeConfig**: string (ReadOnly): Gets the kubeconfig for the cluster. +## Sku +### Properties +* **name**: 'S1' | string (Required): The name of the SKU for Azure Dev Spaces Controller. +* **tier**: 'Standard' | string: The tier of the SKU for Azure Dev Spaces Controller. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/devtestlabs/log.out b/generated/devtestlabs/log.out index 43724cc0e0..6bd6056980 100644 --- a/generated/devtestlabs/log.out +++ b/generated/devtestlabs/log.out @@ -3,23 +3,23 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.devtestlab-2018-09-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 30ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.devtestlab-2016-05-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.devtestlab-2015-05-21-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 5ms -info | Autorest completed in 20.94s. 6 files generated. +info | Autorest completed in 20.19s. 6 files generated. diff --git a/generated/devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.md b/generated/devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.md index 910af2237b..2d36be0032 100644 --- a/generated/devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.md +++ b/generated/devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.md @@ -93,21 +93,21 @@ * **ApiVersion**: 2015-05-21-preview * **Output**: [ResponseWithContinuationLabVhd](#responsewithcontinuationlabvhd) -## LabProperties +## ArtifactDeploymentStatusProperties ### Properties -* **artifactsStorageAccount**: string: The artifact storage account of the lab. -* **createdDate**: string: The creation date of the lab. -* **defaultStorageAccount**: string: The lab's default storage account. -* **defaultVirtualNetworkId**: string: The default virtual network identifier of the lab. -* **labStorageType**: 'Premium' | 'Standard' | string: The type of the lab storage. -* **provisioningState**: string: The provisioning status of the resource. -* **storageAccounts**: string[]: The storage accounts of the lab. -* **vaultName**: string: The name of the key vault of the lab. +* **artifactsApplied**: int: The total count of the artifacts that were successfully applied. +* **deploymentStatus**: string: The deployment status of the artifact. +* **totalArtifacts**: int: The total count of the artifacts that were tentatively applied. -## LabTags +## ArtifactInstallProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **artifactId**: string: The artifact's identifier. +* **parameters**: [ArtifactParameterProperties](#artifactparameterproperties)[]: The parameters of the artifact. + +## ArtifactParameterProperties +### Properties +* **name**: string: The name of the artifact parameter. +* **value**: string: The value of the artifact parameter. ## ArtifactSourceProperties ### Properties @@ -147,19 +147,15 @@ * **sysPrep**: bool: Indicates whether sysprep has been run on the VHD. * **windowsOsInfo**: [WindowsOsInfo](#windowsosinfo): Information about a Windows OS. -## LinuxOsInfo -### Properties -* **linuxOsState**: 'DeprovisionApplied' | 'DeprovisionRequested' | 'NonDeprovisioned' | string: The state of the Linux OS. - -## WindowsOsInfo -### Properties -* **windowsOsState**: 'NonSysprepped' | 'SysprepApplied' | 'SysprepRequested' | string: The state of the Windows OS. - ## CustomImageTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## DayDetails +### Properties +* **time**: string + ## FormulaProperties ### Properties * **author**: string: The author of the formula. @@ -170,6 +166,47 @@ * **provisioningState**: string: The provisioning status of the resource. * **vm**: [FormulaPropertiesFromVm](#formulapropertiesfromvm): Information about a VM from which a formula is to be created. +## FormulaPropertiesFromVm +### Properties +* **labVmId**: string: The identifier of the VM from which a formula is to be created. + +## FormulaTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## GalleryImageReference +### Properties +* **offer**: string: The offer of the gallery image. +* **osType**: string: The OS type of the gallery image. +* **publisher**: string: The publisher of the gallery image. +* **sku**: string: The SKU of the gallery image. +* **version**: string: The version of the gallery image. + +## HourDetails +### Properties +* **minute**: int: Minutes of the hour the schedule will run. + +## LabProperties +### Properties +* **artifactsStorageAccount**: string: The artifact storage account of the lab. +* **createdDate**: string: The creation date of the lab. +* **defaultStorageAccount**: string: The lab's default storage account. +* **defaultVirtualNetworkId**: string: The default virtual network identifier of the lab. +* **labStorageType**: 'Premium' | 'Standard' | string: The type of the lab storage. +* **provisioningState**: string: The provisioning status of the resource. +* **storageAccounts**: string[]: The storage accounts of the lab. +* **vaultName**: string: The name of the key vault of the lab. + +## LabTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## LabVhd +### Properties +* **id**: string (ReadOnly): The absolute URI of the VHD. + ## LabVirtualMachine ### Properties * **id**: string: The identifier of the resource. @@ -202,44 +239,20 @@ * **sshKey**: string: The SSH key of the virtual machine administrator. * **userName**: string: The user name of the virtual machine. -## ArtifactDeploymentStatusProperties -### Properties -* **artifactsApplied**: int: The total count of the artifacts that were successfully applied. -* **deploymentStatus**: string: The deployment status of the artifact. -* **totalArtifacts**: int: The total count of the artifacts that were tentatively applied. - -## ArtifactInstallProperties -### Properties -* **artifactId**: string: The artifact's identifier. -* **parameters**: [ArtifactParameterProperties](#artifactparameterproperties)[]: The parameters of the artifact. - -## ArtifactParameterProperties -### Properties -* **name**: string: The name of the artifact parameter. -* **value**: string: The value of the artifact parameter. - -## GalleryImageReference -### Properties -* **offer**: string: The offer of the gallery image. -* **osType**: string: The OS type of the gallery image. -* **publisher**: string: The publisher of the gallery image. -* **sku**: string: The SKU of the gallery image. -* **version**: string: The version of the gallery image. - ## LabVirtualMachineTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FormulaPropertiesFromVm -### Properties -* **labVmId**: string: The identifier of the VM from which a formula is to be created. - -## FormulaTags +## LabVirtualMachineTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## LinuxOsInfo +### Properties +* **linuxOsState**: 'DeprovisionApplied' | 'DeprovisionRequested' | 'NonDeprovisioned' | string: The state of the Linux OS. + ## PolicyProperties ### Properties * **description**: string: The description of the policy. @@ -255,6 +268,11 @@ ### Additional Properties * **Additional Properties Type**: string +## ResponseWithContinuationLabVhd +### Properties +* **nextLink**: string (ReadOnly): Link for next set of results. +* **value**: [LabVhd](#labvhd)[] (ReadOnly): Results of the list operation. + ## ScheduleProperties ### Properties * **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. @@ -265,37 +283,11 @@ * **timeZoneId**: string: The time zone id. * **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. -## DayDetails -### Properties -* **time**: string - -## HourDetails -### Properties -* **minute**: int: Minutes of the hour the schedule will run. - -## WeekDetails -### Properties -* **time**: string: The time of the day. -* **weekdays**: string[]: The days of the week. - ## ScheduleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LabVirtualMachineTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkProperties -### Properties -* **allowedSubnets**: [Subnet](#subnet)[]: The allowed subnets of the virtual network. -* **description**: string: The description of the virtual network. -* **externalProviderResourceId**: string: The Microsoft.Network resource identifier of the virtual network. -* **provisioningState**: string: The provisioning status of the resource. -* **subnetOverrides**: [SubnetOverride](#subnetoverride)[]: The subnet overrides of the virtual network. - ## Subnet ### Properties * **allowPublicIp**: 'Allow' | 'Default' | 'Deny' | string @@ -309,17 +301,25 @@ * **useInVmCreationPermission**: 'Allow' | 'Default' | 'Deny' | string * **usePublicIpAddressPermission**: 'Allow' | 'Default' | 'Deny' | string +## VirtualNetworkProperties +### Properties +* **allowedSubnets**: [Subnet](#subnet)[]: The allowed subnets of the virtual network. +* **description**: string: The description of the virtual network. +* **externalProviderResourceId**: string: The Microsoft.Network resource identifier of the virtual network. +* **provisioningState**: string: The provisioning status of the resource. +* **subnetOverrides**: [SubnetOverride](#subnetoverride)[]: The subnet overrides of the virtual network. + ## VirtualNetworkTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResponseWithContinuationLabVhd +## WeekDetails ### Properties -* **nextLink**: string (ReadOnly): Link for next set of results. -* **value**: [LabVhd](#labvhd)[] (ReadOnly): Results of the list operation. +* **time**: string: The time of the day. +* **weekdays**: string[]: The days of the week. -## LabVhd +## WindowsOsInfo ### Properties -* **id**: string (ReadOnly): The absolute URI of the VHD. +* **windowsOsState**: 'NonSysprepped' | 'SysprepApplied' | 'SysprepRequested' | string: The state of the Windows OS. diff --git a/generated/devtestlabs/microsoft.devtestlab/2016-05-15/types.md b/generated/devtestlabs/microsoft.devtestlab/2016-05-15/types.md index e150b02f33..b98530bb36 100644 --- a/generated/devtestlabs/microsoft.devtestlab/2016-05-15/types.md +++ b/generated/devtestlabs/microsoft.devtestlab/2016-05-15/types.md @@ -202,25 +202,53 @@ * **ApiVersion**: 2016-05-15 * **Output**: [ResponseWithContinuationLabVhd](#responsewithcontinuationlabvhd) -## LabProperties +## ApplicableSchedule ### Properties -* **artifactsStorageAccount**: string (ReadOnly): The lab's artifact storage account. -* **createdDate**: string (ReadOnly): The creation date of the lab. -* **defaultPremiumStorageAccount**: string (ReadOnly): The lab's default premium storage account. -* **defaultStorageAccount**: string (ReadOnly): The lab's default storage account. -* **labStorageType**: 'Premium' | 'Standard' | string: The storage type for the disk (i.e. Standard, Premium). -* **premiumDataDisks**: 'Disabled' | 'Enabled' | 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. -* **premiumDataDiskStorageAccount**: string (ReadOnly): The lab's premium data disk storage account. -* **provisioningState**: string: The provisioning status of the resource. -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -* **vaultName**: string (ReadOnly): The lab's Key vault. +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. -## ResourceTags +## ApplicableSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## ApplicableScheduleProperties +### Properties +* **labVmsShutdown**: [Schedule](#schedule): A schedule. +* **labVmsStartup**: [Schedule](#schedule): A schedule. + +## ArmTemplateParameterProperties +### Properties +* **name**: string: The name of the template parameter. +* **value**: string: The value of the template parameter. + +## ArtifactDeploymentStatusProperties +### Properties +* **artifactsApplied**: int: The total count of the artifacts that were successfully applied. +* **deploymentStatus**: string: The deployment status of the artifact. +* **totalArtifacts**: int: The total count of the artifacts that were tentatively applied. + +## ArtifactInstallProperties +### Properties +* **artifactId**: string: The artifact's identifier. +* **deploymentStatusMessage**: string: The status message from the deployment. +* **installTime**: string: The time that the artifact starts to install on the virtual machine. +* **parameters**: [ArtifactParameterProperties](#artifactparameterproperties)[]: The parameters of the artifact. +* **status**: string: The status of the artifact. +* **vmExtensionStatusMessage**: string: The status message from the virtual machine extension. + +## ArtifactParameterProperties +### Properties +* **name**: string: The name of the artifact parameter. +* **value**: string: The value of the artifact parameter. ## ArtifactSourceProperties ### Properties @@ -236,54 +264,32 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). * **uri**: string: The artifact source's URI. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LabCostProperties -### Properties -* **createdDate**: string: The creation date of the cost. -* **currencyCode**: string: The currency code of the cost. -* **endDateTime**: string: The end time of the cost data. -* **labCostDetails**: [LabCostDetailsProperties](#labcostdetailsproperties)[] (ReadOnly): The lab cost details component of the cost data. -* **labCostSummary**: [LabCostSummaryProperties](#labcostsummaryproperties) (ReadOnly): The properties of the cost summary. -* **provisioningState**: string: The provisioning status of the resource. -* **resourceCosts**: [LabResourceCostProperties](#labresourcecostproperties)[] (ReadOnly): The resource cost component of the cost data. -* **startDateTime**: string: The start time of the cost data. -* **targetCost**: [TargetCostProperties](#targetcostproperties): Properties of a cost target. -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). - -## LabCostDetailsProperties +## BulkCreationParameters ### Properties -* **cost**: int: The cost component of the cost item. -* **costType**: 'Projected' | 'Reported' | 'Unavailable' | string: The type of the cost. -* **date**: string: The date of the cost item. +* **instanceCount**: int: The number of virtual machine instances to create. -## LabCostSummaryProperties +## ComputeDataDisk ### Properties -* **estimatedLabCost**: int: The cost component of the cost item. +* **diskSizeGiB**: int: Gets data disk size in GiB. +* **diskUri**: string: When backed by a blob, the URI of underlying blob. +* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. +* **name**: string: Gets data disk name. -## LabResourceCostProperties +## ComputeVmInstanceViewStatus ### Properties -* **externalResourceId**: string: The ID of the external resource -* **resourceCost**: int: The cost component of the resource cost item. -* **resourceId**: string: The ID of the resource -* **resourcename**: string: The name of the resource. -* **resourceOwner**: string: The owner of the resource (ex. janedoe@microsoft.com) -* **resourcePricingTier**: string: The category of the resource (ex. Premium_LRS, Standard_DS1) -* **resourceStatus**: string: The status of the resource (ex. Active) -* **resourceType**: string: The logical resource type (ex. virtualmachine, storageaccount) -* **resourceUId**: string: The unique identifier of the resource. +* **code**: string: Gets the status Code. +* **displayStatus**: string: Gets the short localizable label for the status. +* **message**: string: Gets the message associated with the status. -## TargetCostProperties +## ComputeVmProperties ### Properties -* **costThresholds**: [CostThresholdProperties](#costthresholdproperties)[]: Cost thresholds. -* **cycleEndDateTime**: string: Reporting cycle end date. -* **cycleStartDateTime**: string: Reporting cycle start date. -* **cycleType**: 'CalendarMonth' | 'Custom' | string: Reporting cycle type. -* **status**: 'Disabled' | 'Enabled' | string: Target cost status -* **target**: int: Lab target cost +* **dataDiskIds**: string[]: Gets data disks blob uri for the virtual machine. +* **dataDisks**: [ComputeDataDisk](#computedatadisk)[]: Gets all data disks attached to the virtual machine. +* **networkInterfaceId**: string: Gets the network interface ID of the virtual machine. +* **osDiskId**: string: Gets OS disk blob uri for the virtual machine. +* **osType**: string: Gets the OS type of the virtual machine. +* **statuses**: [ComputeVmInstanceViewStatus](#computevminstanceviewstatus)[]: Gets the statuses of the virtual machine. +* **vmSize**: string: Gets the size of the virtual machine. ## CostThresholdProperties ### Properties @@ -293,15 +299,6 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **sendNotificationWhenExceeded**: 'Disabled' | 'Enabled' | string: Indicates whether this threshold will be displayed on cost charts. * **thresholdId**: string: The ID of the cost threshold item. -## PercentageCostThresholdProperties -### Properties -* **thresholdValue**: int: The cost threshold value. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CustomImageProperties ### Properties * **author**: string: The author of the custom image. @@ -325,18 +322,45 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **sourceVmId**: string: The source vm identifier. * **windowsOsInfo**: [WindowsOsInfo](#windowsosinfo): Information about a Windows OS. -## LinuxOsInfo +## DayDetails ### Properties -* **linuxOsState**: 'DeprovisionApplied' | 'DeprovisionRequested' | 'NonDeprovisioned' | string: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). +* **time**: string: The time of day the schedule will occur. -## WindowsOsInfo +## DiskProperties ### Properties -* **windowsOsState**: 'NonSysprepped' | 'SysprepApplied' | 'SysprepRequested' | string: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). +* **createdDate**: string (ReadOnly): The creation date of the disk. +* **diskBlobName**: string: When backed by a blob, the name of the VHD blob without extension. +* **diskSizeGiB**: int: The size of the disk in Gibibytes. +* **diskType**: 'Premium' | 'Standard' | string: The storage type for the disk (i.e. Standard, Premium). +* **diskUri**: string: When backed by a blob, the URI of underlying blob. +* **hostCaching**: string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). +* **leasedByLabVmId**: string: The resource ID of the VM to which this disk is leased. +* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. +* **provisioningState**: string: The provisioning status of the resource. +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -## ResourceTags +## EnvironmentDeploymentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **armTemplateId**: string: The Azure Resource Manager template's identifier. +* **parameters**: [ArmTemplateParameterProperties](#armtemplateparameterproperties)[]: The parameters of the Azure Resource Manager template. + +## EnvironmentProperties +### Properties +* **armTemplateDisplayName**: string: The display name of the Azure Resource Manager template that produced the environment. +* **createdByUser**: string (ReadOnly): The creator of the environment. +* **deploymentProperties**: [EnvironmentDeploymentProperties](#environmentdeploymentproperties): Properties of an environment deployment. +* **provisioningState**: string: The provisioning status of the resource. +* **resourceGroupId**: string (ReadOnly): The identifier of the resource group containing the environment's resources. +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). + +## Event +### Properties +* **eventName**: 'AutoShutdown' | 'Cost' | string: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) + +## ExternalSubnet +### Properties +* **id**: string: Gets or sets the identifier. +* **name**: string: Gets or sets the name. ## FormulaProperties ### Properties @@ -349,6 +373,89 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). * **vm**: [FormulaPropertiesFromVm](#formulapropertiesfromvm): Information about a VM from which a formula is to be created. +## FormulaPropertiesFromVm +### Properties +* **labVmId**: string: The identifier of the VM from which a formula is to be created. + +## GalleryImageReference +### Properties +* **offer**: string: The offer of the gallery image. +* **osType**: string: The OS type of the gallery image. +* **publisher**: string: The publisher of the gallery image. +* **sku**: string: The SKU of the gallery image. +* **version**: string: The version of the gallery image. + +## HourDetails +### Properties +* **minute**: int: Minutes of the hour the schedule will run. + +## IdentityProperties +### Properties +* **clientSecretUrl**: string: The client secret URL of the identity. +* **principalId**: string: The principal id of resource identity. +* **tenantId**: string: The tenant identifier of resource. +* **type**: string: Managed identity. + +## InboundNatRule +### Properties +* **backendPort**: int: The port to which the external traffic will be redirected. +* **frontendPort**: int: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. +* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. + +## LabCostDetailsProperties +### Properties +* **cost**: int: The cost component of the cost item. +* **costType**: 'Projected' | 'Reported' | 'Unavailable' | string: The type of the cost. +* **date**: string: The date of the cost item. + +## LabCostProperties +### Properties +* **createdDate**: string: The creation date of the cost. +* **currencyCode**: string: The currency code of the cost. +* **endDateTime**: string: The end time of the cost data. +* **labCostDetails**: [LabCostDetailsProperties](#labcostdetailsproperties)[] (ReadOnly): The lab cost details component of the cost data. +* **labCostSummary**: [LabCostSummaryProperties](#labcostsummaryproperties) (ReadOnly): The properties of the cost summary. +* **provisioningState**: string: The provisioning status of the resource. +* **resourceCosts**: [LabResourceCostProperties](#labresourcecostproperties)[] (ReadOnly): The resource cost component of the cost data. +* **startDateTime**: string: The start time of the cost data. +* **targetCost**: [TargetCostProperties](#targetcostproperties): Properties of a cost target. +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). + +## LabCostSummaryProperties +### Properties +* **estimatedLabCost**: int: The cost component of the cost item. + +## LabProperties +### Properties +* **artifactsStorageAccount**: string (ReadOnly): The lab's artifact storage account. +* **createdDate**: string (ReadOnly): The creation date of the lab. +* **defaultPremiumStorageAccount**: string (ReadOnly): The lab's default premium storage account. +* **defaultStorageAccount**: string (ReadOnly): The lab's default storage account. +* **labStorageType**: 'Premium' | 'Standard' | string: The storage type for the disk (i.e. Standard, Premium). +* **premiumDataDisks**: 'Disabled' | 'Enabled' | 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. +* **premiumDataDiskStorageAccount**: string (ReadOnly): The lab's premium data disk storage account. +* **provisioningState**: string: The provisioning status of the resource. +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +* **vaultName**: string (ReadOnly): The lab's Key vault. + +## LabResourceCostProperties +### Properties +* **externalResourceId**: string: The ID of the external resource +* **resourceCost**: int: The cost component of the resource cost item. +* **resourceId**: string: The ID of the resource +* **resourcename**: string: The name of the resource. +* **resourceOwner**: string: The owner of the resource (ex. janedoe@microsoft.com) +* **resourcePricingTier**: string: The category of the resource (ex. Premium_LRS, Standard_DS1) +* **resourceStatus**: string: The status of the resource (ex. Active) +* **resourceType**: string: The logical resource type (ex. virtualmachine, storageaccount) +* **resourceUId**: string: The unique identifier of the resource. + +## LabVhd +### Properties +* **id**: string (ReadOnly): The URI to the VHD. + ## LabVirtualMachineCreationParameter ### Properties * **location**: string: The location of the new virtual machine or environment @@ -390,162 +497,60 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **userName**: string: The user name of the virtual machine. * **virtualMachineCreationSource**: 'FromCustomImage' | 'FromGalleryImage' | string: Tells source of creation of lab virtual machine. Output property only. -## ApplicableSchedule -### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## ApplicableScheduleProperties -### Properties -* **labVmsShutdown**: [Schedule](#schedule): A schedule. -* **labVmsStartup**: [Schedule](#schedule): A schedule. - -## Schedule -### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ScheduleProperties](#scheduleproperties) (Required): Properties of a schedule. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. - -## ScheduleProperties -### Properties -* **createdDate**: string (ReadOnly): The creation date of the schedule. -* **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. -* **hourlyRecurrence**: [HourDetails](#hourdetails): Properties of an hourly schedule. -* **notificationSettings**: [NotificationSettings](#notificationsettings): Notification settings for a schedule. -* **provisioningState**: string: The provisioning status of the resource. -* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). -* **targetResourceId**: string: The resource ID to which the schedule belongs -* **taskType**: string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). -* **timeZoneId**: string: The time zone ID (e.g. Pacific Standard time). -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -* **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. - -## DayDetails -### Properties -* **time**: string: The time of day the schedule will occur. - -## HourDetails -### Properties -* **minute**: int: Minutes of the hour the schedule will run. - -## NotificationSettings -### Properties -* **status**: 'Disabled' | 'Enabled' | string: If notifications are enabled for this schedule (i.e. Enabled, Disabled). -* **timeInMinutes**: int: Time in minutes before event at which notification will be sent. -* **webhookUrl**: string: The webhook URL to which the notification will be sent. - -## WeekDetails -### Properties -* **time**: string: The time of the day the schedule will occur. -* **weekdays**: string[]: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## LabVirtualMachineCreationParameterTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ArtifactDeploymentStatusProperties -### Properties -* **artifactsApplied**: int: The total count of the artifacts that were successfully applied. -* **deploymentStatus**: string: The deployment status of the artifact. -* **totalArtifacts**: int: The total count of the artifacts that were tentatively applied. - -## ArtifactInstallProperties -### Properties -* **artifactId**: string: The artifact's identifier. -* **deploymentStatusMessage**: string: The status message from the deployment. -* **installTime**: string: The time that the artifact starts to install on the virtual machine. -* **parameters**: [ArtifactParameterProperties](#artifactparameterproperties)[]: The parameters of the artifact. -* **status**: string: The status of the artifact. -* **vmExtensionStatusMessage**: string: The status message from the virtual machine extension. - -## ArtifactParameterProperties -### Properties -* **name**: string: The name of the artifact parameter. -* **value**: string: The value of the artifact parameter. - -## BulkCreationParameters -### Properties -* **instanceCount**: int: The number of virtual machine instances to create. - -## ComputeVmProperties -### Properties -* **dataDiskIds**: string[]: Gets data disks blob uri for the virtual machine. -* **dataDisks**: [ComputeDataDisk](#computedatadisk)[]: Gets all data disks attached to the virtual machine. -* **networkInterfaceId**: string: Gets the network interface ID of the virtual machine. -* **osDiskId**: string: Gets OS disk blob uri for the virtual machine. -* **osType**: string: Gets the OS type of the virtual machine. -* **statuses**: [ComputeVmInstanceViewStatus](#computevminstanceviewstatus)[]: Gets the statuses of the virtual machine. -* **vmSize**: string: Gets the size of the virtual machine. - -## ComputeDataDisk -### Properties -* **diskSizeGiB**: int: Gets data disk size in GiB. -* **diskUri**: string: When backed by a blob, the URI of underlying blob. -* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. -* **name**: string: Gets data disk name. - -## ComputeVmInstanceViewStatus -### Properties -* **code**: string: Gets the status Code. -* **displayStatus**: string: Gets the short localizable label for the status. -* **message**: string: Gets the message associated with the status. - -## GalleryImageReference -### Properties -* **offer**: string: The offer of the gallery image. -* **osType**: string: The OS type of the gallery image. -* **publisher**: string: The publisher of the gallery image. -* **sku**: string: The SKU of the gallery image. -* **version**: string: The version of the gallery image. - -## NetworkInterfaceProperties -### Properties -* **dnsName**: string: The DNS name. -* **privateIpAddress**: string: The private IP address. -* **publicIpAddress**: string: The public IP address. -* **publicIpAddressId**: string: The resource ID of the public IP address. -* **rdpAuthority**: string: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). -* **sharedPublicIpAddressConfiguration**: [SharedPublicIpAddressConfiguration](#sharedpublicipaddressconfiguration): Properties of a virtual machine that determine how it is connected to a load balancer. -* **sshAuthority**: string: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. -* **subnetId**: string: The resource ID of the sub net. -* **virtualNetworkId**: string: The resource ID of the virtual network. - -## SharedPublicIpAddressConfiguration -### Properties -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: The incoming NAT rules - -## InboundNatRule -### Properties -* **backendPort**: int: The port to which the external traffic will be redirected. -* **frontendPort**: int: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. -* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. - -## LabVirtualMachineCreationParameterTags +## LabVirtualMachineProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowClaim**: bool: Indicates whether another user can take ownership of the virtual machine +* **applicableSchedule**: [ApplicableSchedule](#applicableschedule): Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. +* **artifactDeploymentStatus**: [ArtifactDeploymentStatusProperties](#artifactdeploymentstatusproperties): Properties of an artifact deployment. +* **artifacts**: [ArtifactInstallProperties](#artifactinstallproperties)[]: The artifacts to be installed on the virtual machine. +* **computeId**: string (ReadOnly): The resource identifier (Microsoft.Compute) of the virtual machine. +* **computeVm**: [ComputeVmProperties](#computevmproperties): Properties of a virtual machine returned by the Microsoft.Compute API. +* **createdByUser**: string: The email address of creator of the virtual machine. +* **createdByUserId**: string: The object identifier of the creator of the virtual machine. +* **createdDate**: string: The creation date of the virtual machine. +* **customImageId**: string: The custom image identifier of the virtual machine. +* **disallowPublicIpAddress**: bool: Indicates whether the virtual machine is to be created without a public IP address. +* **environmentId**: string: The resource ID of the environment that contains this virtual machine, if any. +* **expirationDate**: string: The expiration date for VM. +* **fqdn**: string: The fully-qualified domain name of the virtual machine. +* **galleryImageReference**: [GalleryImageReference](#galleryimagereference): The reference information for an Azure Marketplace image. +* **isAuthenticationWithSshKey**: bool: Indicates whether this virtual machine uses an SSH key for authentication. +* **labSubnetName**: string: The lab subnet name of the virtual machine. +* **labVirtualNetworkId**: string: The lab virtual network identifier of the virtual machine. +* **networkInterface**: [NetworkInterfaceProperties](#networkinterfaceproperties): Properties of a network interface. +* **notes**: string: The notes of the virtual machine. +* **osType**: string: The OS type of the virtual machine. +* **ownerObjectId**: string: The object identifier of the owner of the virtual machine. +* **ownerUserPrincipalName**: string: The user principal name of the virtual machine owner. +* **password**: string: The password of the virtual machine administrator. +* **provisioningState**: string: The provisioning status of the resource. +* **size**: string: The size of the virtual machine. +* **sshKey**: string: The SSH key of the virtual machine administrator. +* **storageType**: string: Storage type to use for virtual machine (i.e. Standard, Premium). +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +* **userName**: string: The user name of the virtual machine. +* **virtualMachineCreationSource**: 'FromCustomImage' | 'FromGalleryImage' | string: Tells source of creation of lab virtual machine. Output property only. -## FormulaPropertiesFromVm +## LinuxOsInfo ### Properties -* **labVmId**: string: The identifier of the VM from which a formula is to be created. +* **linuxOsState**: 'DeprovisionApplied' | 'DeprovisionRequested' | 'NonDeprovisioned' | string: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). -## ResourceTags +## NetworkInterfaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsName**: string: The DNS name. +* **privateIpAddress**: string: The private IP address. +* **publicIpAddress**: string: The public IP address. +* **publicIpAddressId**: string: The resource ID of the public IP address. +* **rdpAuthority**: string: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). +* **sharedPublicIpAddressConfiguration**: [SharedPublicIpAddressConfiguration](#sharedpublicipaddressconfiguration): Properties of a virtual machine that determine how it is connected to a load balancer. +* **sshAuthority**: string: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. +* **subnetId**: string: The resource ID of the sub net. +* **virtualNetworkId**: string: The resource ID of the virtual network. ## NotificationChannelProperties ### Properties @@ -556,14 +561,15 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). * **webHookUrl**: string: The webhook URL to send notifications to. -## Event +## NotificationSettings ### Properties -* **eventName**: 'AutoShutdown' | 'Cost' | string: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) +* **status**: 'Disabled' | 'Enabled' | string: If notifications are enabled for this schedule (i.e. Enabled, Disabled). +* **timeInMinutes**: int: Time in minutes before event at which notification will be sent. +* **webhookUrl**: string: The webhook URL to which the notification will be sent. -## ResourceTags +## PercentageCostThresholdProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **thresholdValue**: int: The cost threshold value. ## PolicyProperties ### Properties @@ -577,6 +583,11 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **threshold**: string: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). * **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +## Port +### Properties +* **backendPort**: int: Backend port of the target virtual machine. +* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. + ## ResourceTags ### Properties ### Additional Properties @@ -587,130 +598,80 @@ When its value is 'Disabled', only creation of standard data disks is allowed. ### Additional Properties * **Additional Properties Type**: string -## IdentityProperties +## ResourceTags ### Properties -* **clientSecretUrl**: string: The client secret URL of the identity. -* **principalId**: string: The principal id of resource identity. -* **tenantId**: string: The tenant identifier of resource. -* **type**: string: Managed identity. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## UserProperties +## ResourceTags ### Properties -* **createdDate**: string (ReadOnly): The creation date of the user profile. -* **identity**: [UserIdentity](#useridentity): Identity attributes of a lab user. -* **provisioningState**: string: The provisioning status of the resource. -* **secretStore**: [UserSecretStore](#usersecretstore): Properties of a user's secret store. -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +### Additional Properties +* **Additional Properties Type**: string -## UserIdentity +## ResourceTags ### Properties -* **appId**: string: Set to the app Id of the client JWT making the request. -* **objectId**: 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. -* **principalId**: string: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. -* **principalName**: string: Set to the principal name / UPN of the client JWT making the request. -* **tenantId**: string: Set to the tenant ID of the client JWT making the request. +### Additional Properties +* **Additional Properties Type**: string -## UserSecretStore +## ResourceTags ### Properties -* **keyVaultId**: string: The ID of the user's Key vault. -* **keyVaultUri**: string: The URI of the user's Key vault. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DiskProperties +## ResourceTags ### Properties -* **createdDate**: string (ReadOnly): The creation date of the disk. -* **diskBlobName**: string: When backed by a blob, the name of the VHD blob without extension. -* **diskSizeGiB**: int: The size of the disk in Gibibytes. -* **diskType**: 'Premium' | 'Standard' | string: The storage type for the disk (i.e. Standard, Premium). -* **diskUri**: string: When backed by a blob, the URI of underlying blob. -* **hostCaching**: string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). -* **leasedByLabVmId**: string: The resource ID of the VM to which this disk is leased. -* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. -* **provisioningState**: string: The provisioning status of the resource. -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EnvironmentProperties +## ResourceTags ### Properties -* **armTemplateDisplayName**: string: The display name of the Azure Resource Manager template that produced the environment. -* **createdByUser**: string (ReadOnly): The creator of the environment. -* **deploymentProperties**: [EnvironmentDeploymentProperties](#environmentdeploymentproperties): Properties of an environment deployment. -* **provisioningState**: string: The provisioning status of the resource. -* **resourceGroupId**: string (ReadOnly): The identifier of the resource group containing the environment's resources. -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +### Additional Properties +* **Additional Properties Type**: string -## EnvironmentDeploymentProperties +## ResourceTags ### Properties -* **armTemplateId**: string: The Azure Resource Manager template's identifier. -* **parameters**: [ArmTemplateParameterProperties](#armtemplateparameterproperties)[]: The parameters of the Azure Resource Manager template. +### Additional Properties +* **Additional Properties Type**: string -## ArmTemplateParameterProperties +## ResourceTags ### Properties -* **name**: string: The name of the template parameter. -* **value**: string: The value of the template parameter. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SecretProperties +## ResourceTags ### Properties -* **provisioningState**: string: The provisioning status of the resource. -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -* **value**: string: The value of the secret for secret creation. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LabVirtualMachineProperties +## ResourceTags ### Properties -* **allowClaim**: bool: Indicates whether another user can take ownership of the virtual machine -* **applicableSchedule**: [ApplicableSchedule](#applicableschedule): Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. -* **artifactDeploymentStatus**: [ArtifactDeploymentStatusProperties](#artifactdeploymentstatusproperties): Properties of an artifact deployment. -* **artifacts**: [ArtifactInstallProperties](#artifactinstallproperties)[]: The artifacts to be installed on the virtual machine. -* **computeId**: string (ReadOnly): The resource identifier (Microsoft.Compute) of the virtual machine. -* **computeVm**: [ComputeVmProperties](#computevmproperties): Properties of a virtual machine returned by the Microsoft.Compute API. -* **createdByUser**: string: The email address of creator of the virtual machine. -* **createdByUserId**: string: The object identifier of the creator of the virtual machine. -* **createdDate**: string: The creation date of the virtual machine. -* **customImageId**: string: The custom image identifier of the virtual machine. -* **disallowPublicIpAddress**: bool: Indicates whether the virtual machine is to be created without a public IP address. -* **environmentId**: string: The resource ID of the environment that contains this virtual machine, if any. -* **expirationDate**: string: The expiration date for VM. -* **fqdn**: string: The fully-qualified domain name of the virtual machine. -* **galleryImageReference**: [GalleryImageReference](#galleryimagereference): The reference information for an Azure Marketplace image. -* **isAuthenticationWithSshKey**: bool: Indicates whether this virtual machine uses an SSH key for authentication. -* **labSubnetName**: string: The lab subnet name of the virtual machine. -* **labVirtualNetworkId**: string: The lab virtual network identifier of the virtual machine. -* **networkInterface**: [NetworkInterfaceProperties](#networkinterfaceproperties): Properties of a network interface. -* **notes**: string: The notes of the virtual machine. -* **osType**: string: The OS type of the virtual machine. -* **ownerObjectId**: string: The object identifier of the owner of the virtual machine. -* **ownerUserPrincipalName**: string: The user principal name of the virtual machine owner. -* **password**: string: The password of the virtual machine administrator. -* **provisioningState**: string: The provisioning status of the resource. -* **size**: string: The size of the virtual machine. -* **sshKey**: string: The SSH key of the virtual machine administrator. -* **storageType**: string: Storage type to use for virtual machine (i.e. Standard, Premium). -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -* **userName**: string: The user name of the virtual machine. -* **virtualMachineCreationSource**: 'FromCustomImage' | 'FromGalleryImage' | string: Tells source of creation of lab virtual machine. Output property only. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -722,16 +683,48 @@ When its value is 'Disabled', only creation of standard data disks is allowed. ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkProperties +## ResponseWithContinuationLabVhd +### Properties +* **nextLink**: string (ReadOnly): Link for next set of results. +* **value**: [LabVhd](#labvhd)[] (ReadOnly): Results of the list operation. + +## ResponseWithContinuationSchedule +### Properties +* **nextLink**: string (ReadOnly): Link for next set of results. +* **value**: [Schedule](#schedule)[] (ReadOnly): Results of the list operation. + +## Schedule +### Properties +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ScheduleProperties](#scheduleproperties) (Required): Properties of a schedule. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. + +## ScheduleProperties +### Properties +* **createdDate**: string (ReadOnly): The creation date of the schedule. +* **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. +* **hourlyRecurrence**: [HourDetails](#hourdetails): Properties of an hourly schedule. +* **notificationSettings**: [NotificationSettings](#notificationsettings): Notification settings for a schedule. +* **provisioningState**: string: The provisioning status of the resource. +* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). +* **targetResourceId**: string: The resource ID to which the schedule belongs +* **taskType**: string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). +* **timeZoneId**: string: The time zone ID (e.g. Pacific Standard time). +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +* **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. + +## SecretProperties ### Properties -* **allowedSubnets**: [Subnet](#subnet)[]: The allowed subnets of the virtual network. -* **createdDate**: string (ReadOnly): The creation date of the virtual network. -* **description**: string: The description of the virtual network. -* **externalProviderResourceId**: string: The Microsoft.Network resource identifier of the virtual network. -* **externalSubnets**: [ExternalSubnet](#externalsubnet)[]: The external subnet properties. * **provisioningState**: string: The provisioning status of the resource. -* **subnetOverrides**: [SubnetOverride](#subnetoverride)[]: The subnet overrides of the virtual network. * **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +* **value**: string: The value of the secret for secret creation. + +## SharedPublicIpAddressConfiguration +### Properties +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: The incoming NAT rules ## Subnet ### Properties @@ -739,11 +732,6 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **labSubnetName**: string: The name of the subnet as seen in the lab. * **resourceId**: string: The resource ID of the subnet. -## ExternalSubnet -### Properties -* **id**: string: Gets or sets the identifier. -* **name**: string: Gets or sets the name. - ## SubnetOverride ### Properties * **labSubnetName**: string: The name given to the subnet within the lab. @@ -757,41 +745,53 @@ When its value is 'Disabled', only creation of standard data disks is allowed. ### Properties * **allowedPorts**: [Port](#port)[]: Backend ports that virtual machines on this subnet are allowed to expose -## Port +## TargetCostProperties ### Properties -* **backendPort**: int: Backend port of the target virtual machine. -* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **costThresholds**: [CostThresholdProperties](#costthresholdproperties)[]: Cost thresholds. +* **cycleEndDateTime**: string: Reporting cycle end date. +* **cycleStartDateTime**: string: Reporting cycle start date. +* **cycleType**: 'CalendarMonth' | 'Custom' | string: Reporting cycle type. +* **status**: 'Disabled' | 'Enabled' | string: Target cost status +* **target**: int: Lab target cost -## ResourceTags +## UserIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Set to the app Id of the client JWT making the request. +* **objectId**: 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. +* **principalId**: string: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. +* **principalName**: string: Set to the principal name / UPN of the client JWT making the request. +* **tenantId**: string: Set to the tenant ID of the client JWT making the request. -## ResourceTags +## UserProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdDate**: string (ReadOnly): The creation date of the user profile. +* **identity**: [UserIdentity](#useridentity): Identity attributes of a lab user. +* **provisioningState**: string: The provisioning status of the resource. +* **secretStore**: [UserSecretStore](#usersecretstore): Properties of a user's secret store. +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -## ResponseWithContinuationSchedule +## UserSecretStore ### Properties -* **nextLink**: string (ReadOnly): Link for next set of results. -* **value**: [Schedule](#schedule)[] (ReadOnly): Results of the list operation. +* **keyVaultId**: string: The ID of the user's Key vault. +* **keyVaultUri**: string: The URI of the user's Key vault. -## ApplicableSchedule +## VirtualNetworkProperties ### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. +* **allowedSubnets**: [Subnet](#subnet)[]: The allowed subnets of the virtual network. +* **createdDate**: string (ReadOnly): The creation date of the virtual network. +* **description**: string: The description of the virtual network. +* **externalProviderResourceId**: string: The Microsoft.Network resource identifier of the virtual network. +* **externalSubnets**: [ExternalSubnet](#externalsubnet)[]: The external subnet properties. +* **provisioningState**: string: The provisioning status of the resource. +* **subnetOverrides**: [SubnetOverride](#subnetoverride)[]: The subnet overrides of the virtual network. +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -## ResponseWithContinuationLabVhd +## WeekDetails ### Properties -* **nextLink**: string (ReadOnly): Link for next set of results. -* **value**: [LabVhd](#labvhd)[] (ReadOnly): Results of the list operation. +* **time**: string: The time of the day the schedule will occur. +* **weekdays**: string[]: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). -## LabVhd +## WindowsOsInfo ### Properties -* **id**: string (ReadOnly): The URI to the VHD. +* **windowsOsState**: 'NonSysprepped' | 'SysprepApplied' | 'SysprepRequested' | string: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). diff --git a/generated/devtestlabs/microsoft.devtestlab/2018-09-15/types.md b/generated/devtestlabs/microsoft.devtestlab/2018-09-15/types.md index 1c86f1a651..9c673dcea2 100644 --- a/generated/devtestlabs/microsoft.devtestlab/2018-09-15/types.md +++ b/generated/devtestlabs/microsoft.devtestlab/2018-09-15/types.md @@ -229,55 +229,63 @@ * **ApiVersion**: 2018-09-15 * **Output**: [LabVhdList](#labvhdlist) -## LabProperties +## ApplicableSchedule ### Properties -* **announcement**: [LabAnnouncementProperties](#labannouncementproperties): Properties of a lab's announcement banner -* **artifactsStorageAccount**: string (ReadOnly): The lab's artifact storage account. -* **createdDate**: string (ReadOnly): The creation date of the lab. -* **defaultPremiumStorageAccount**: string (ReadOnly): The lab's default premium storage account. -* **defaultStorageAccount**: string (ReadOnly): The lab's default storage account. -* **environmentPermission**: 'Contributor' | 'Reader' | string: The access rights to be granted to the user when provisioning an environment -* **extendedProperties**: [LabPropertiesExtendedProperties](#labpropertiesextendedproperties): Extended properties of the lab used for experimental features -* **labStorageType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). -* **loadBalancerId**: string (ReadOnly): The load balancer used to for lab VMs that use shared IP address. -* **mandatoryArtifactsResourceIdsLinux**: string[]: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. -* **mandatoryArtifactsResourceIdsWindows**: string[]: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. -* **networkSecurityGroupId**: string (ReadOnly): The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. -* **premiumDataDisks**: 'Disabled' | 'Enabled' | 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. -* **premiumDataDiskStorageAccount**: string (ReadOnly): The lab's premium data disk storage account. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **publicIpId**: string (ReadOnly): The public IP address for the lab's load balancer. -* **support**: [LabSupportProperties](#labsupportproperties): Properties of a lab's support banner -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -* **vaultName**: string (ReadOnly): The lab's Key vault. -* **vmCreationResourceGroup**: string (ReadOnly): The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. -## LabAnnouncementProperties +## ApplicableSchedule ### Properties -* **enabled**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). -* **expirationDate**: string: The time at which the announcement expires (null for never) -* **expired**: bool: Has this announcement expired? -* **markdown**: string: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **title**: string: The plain text title for the lab announcement -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. -## LabPropertiesExtendedProperties +## ApplicableSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. -## LabSupportProperties +## ApplicableScheduleProperties ### Properties -* **enabled**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). -* **markdown**: string: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. +* **labVmsShutdown**: [Schedule](#schedule): A schedule. +* **labVmsStartup**: [Schedule](#schedule): A schedule. -## ResourceTags +## ArmTemplateParameterProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name of the template parameter. +* **value**: string: The value of the template parameter. + +## ArtifactDeploymentStatusProperties +### Properties +* **artifactsApplied**: int: The total count of the artifacts that were successfully applied. +* **deploymentStatus**: string: The deployment status of the artifact. +* **totalArtifacts**: int: The total count of the artifacts that were tentatively applied. + +## ArtifactInstallProperties +### Properties +* **artifactId**: string: The artifact's identifier. +* **artifactTitle**: string: The artifact's title. +* **deploymentStatusMessage**: string: The status message from the deployment. +* **installTime**: string: The time that the artifact starts to install on the virtual machine. +* **parameters**: [ArtifactParameterProperties](#artifactparameterproperties)[]: The parameters of the artifact. +* **status**: string: The status of the artifact. +* **vmExtensionStatusMessage**: string: The status message from the virtual machine extension. + +## ArtifactParameterProperties +### Properties +* **name**: string: The name of the artifact parameter. +* **value**: string: The value of the artifact parameter. ## ArtifactSourceProperties ### Properties @@ -293,54 +301,38 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). * **uri**: string: The artifact source's URI. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LabCostProperties +## AttachNewDataDiskOptions ### Properties -* **createdDate**: string: The creation date of the cost. -* **currencyCode**: string: The currency code of the cost. -* **endDateTime**: string: The end time of the cost data. -* **labCostDetails**: [LabCostDetailsProperties](#labcostdetailsproperties)[] (ReadOnly): The lab cost details component of the cost data. -* **labCostSummary**: [LabCostSummaryProperties](#labcostsummaryproperties) (ReadOnly): The properties of the cost summary. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **resourceCosts**: [LabResourceCostProperties](#labresourcecostproperties)[] (ReadOnly): The resource cost component of the cost data. -* **startDateTime**: string: The start time of the cost data. -* **targetCost**: [TargetCostProperties](#targetcostproperties): Properties of a cost target. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **diskName**: string: The name of the disk to be attached. +* **diskSizeGiB**: int: Size of the disk to be attached in Gibibytes. +* **diskType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). -## LabCostDetailsProperties +## BulkCreationParameters ### Properties -* **cost**: int: The cost component of the cost item. -* **costType**: 'Projected' | 'Reported' | 'Unavailable' | string: The type of the cost. -* **date**: string: The date of the cost item. +* **instanceCount**: int: The number of virtual machine instances to create. -## LabCostSummaryProperties +## ComputeDataDisk ### Properties -* **estimatedLabCost**: int: The cost component of the cost item. +* **diskSizeGiB**: int: Gets data disk size in GiB. +* **diskUri**: string: When backed by a blob, the URI of underlying blob. +* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. +* **name**: string: Gets data disk name. -## LabResourceCostProperties +## ComputeVmInstanceViewStatus ### Properties -* **externalResourceId**: string: The ID of the external resource -* **resourceCost**: int: The cost component of the resource cost item. -* **resourceId**: string: The ID of the resource -* **resourcename**: string: The name of the resource. -* **resourceOwner**: string: The owner of the resource (ex. janedoe@microsoft.com) -* **resourcePricingTier**: string: The category of the resource (ex. Premium_LRS, Standard_DS1) -* **resourceStatus**: string: The status of the resource (ex. Active) -* **resourceType**: string: The logical resource type (ex. virtualmachine, storageaccount) -* **resourceUId**: string: The unique identifier of the resource. +* **code**: string: Gets the status Code. +* **displayStatus**: string: Gets the short localizable label for the status. +* **message**: string: Gets the message associated with the status. -## TargetCostProperties +## ComputeVmProperties ### Properties -* **costThresholds**: [CostThresholdProperties](#costthresholdproperties)[]: Cost thresholds. -* **cycleEndDateTime**: string: Reporting cycle end date. -* **cycleStartDateTime**: string: Reporting cycle start date. -* **cycleType**: 'CalendarMonth' | 'Custom' | string: Reporting cycle type. -* **status**: 'Disabled' | 'Enabled' | string: Target cost status -* **target**: int: Lab target cost +* **dataDiskIds**: string[]: Gets data disks blob uri for the virtual machine. +* **dataDisks**: [ComputeDataDisk](#computedatadisk)[]: Gets all data disks attached to the virtual machine. +* **networkInterfaceId**: string: Gets the network interface ID of the virtual machine. +* **osDiskId**: string: Gets OS disk blob uri for the virtual machine. +* **osType**: string: Gets the OS type of the virtual machine. +* **statuses**: [ComputeVmInstanceViewStatus](#computevminstanceviewstatus)[]: Gets the statuses of the virtual machine. +* **vmSize**: string: Gets the size of the virtual machine. ## CostThresholdProperties ### Properties @@ -350,15 +342,6 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **sendNotificationWhenExceeded**: 'Disabled' | 'Enabled' | string: Indicates whether this threshold will be displayed on cost charts. * **thresholdId**: string: The ID of the cost threshold item. -## PercentageCostThresholdProperties -### Properties -* **thresholdValue**: int: The cost threshold value. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## CustomImageProperties ### Properties * **author**: string: The author of the custom image. @@ -374,52 +357,204 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **vhd**: [CustomImagePropertiesCustom](#customimagepropertiescustom): Properties for creating a custom image from a VHD. * **vm**: [CustomImagePropertiesFromVm](#customimagepropertiesfromvm): Properties for creating a custom image from a virtual machine. +## CustomImagePropertiesCustom +### Properties +* **imageName**: string: The image name. +* **osType**: 'Linux' | 'None' | 'Windows' | string (Required): The OS type of the custom image (i.e. Windows, Linux) +* **sysPrep**: bool: Indicates whether sysprep has been run on the VHD. + ## CustomImagePropertiesFromPlan ### Properties * **id**: string: The id of the plan, equivalent to name of the plan * **offer**: string: The offer for the plan from the marketplace image the custom image is derived from * **publisher**: string: The publisher for the plan from the marketplace image the custom image is derived from +## CustomImagePropertiesFromVm +### Properties +* **linuxOsInfo**: [LinuxOsInfo](#linuxosinfo): Information about a Linux OS. +* **sourceVmId**: string: The source vm identifier. +* **windowsOsInfo**: [WindowsOsInfo](#windowsosinfo): Information about a Windows OS. + +## DataDiskProperties +### Properties +* **attachNewDataDiskOptions**: [AttachNewDataDiskOptions](#attachnewdatadiskoptions): Properties to attach new disk to the Virtual Machine. +* **existingLabDiskId**: string: Specifies the existing lab disk id to attach to virtual machine. +* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' | string: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). + ## DataDiskStorageTypeInfo ### Properties * **lun**: string: Disk Lun * **storageType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). -## CustomImagePropertiesCustom +## DayDetails ### Properties -* **imageName**: string: The image name. -* **osType**: 'Linux' | 'None' | 'Windows' | string (Required): The OS type of the custom image (i.e. Windows, Linux) -* **sysPrep**: bool: Indicates whether sysprep has been run on the VHD. +* **time**: string: The time of day the schedule will occur. -## CustomImagePropertiesFromVm +## DiskProperties ### Properties -* **linuxOsInfo**: [LinuxOsInfo](#linuxosinfo): Information about a Linux OS. -* **sourceVmId**: string: The source vm identifier. -* **windowsOsInfo**: [WindowsOsInfo](#windowsosinfo): Information about a Windows OS. +* **createdDate**: string (ReadOnly): The creation date of the disk. +* **diskBlobName**: string: When backed by a blob, the name of the VHD blob without extension. +* **diskSizeGiB**: int: The size of the disk in Gibibytes. +* **diskType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). +* **diskUri**: string: When backed by a blob, the URI of underlying blob. +* **hostCaching**: string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). +* **leasedByLabVmId**: string: The resource ID of the VM to which this disk is leased. +* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **storageAccountId**: string: When backed by a blob, the storage account where the blob is. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -## LinuxOsInfo +## EnvironmentDeploymentProperties ### Properties -* **linuxOsState**: 'DeprovisionApplied' | 'DeprovisionRequested' | 'NonDeprovisioned' | string: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). +* **armTemplateId**: string: The Azure Resource Manager template's identifier. +* **parameters**: [ArmTemplateParameterProperties](#armtemplateparameterproperties)[]: The parameters of the Azure Resource Manager template. + +## EnvironmentProperties +### Properties +* **armTemplateDisplayName**: string: The display name of the Azure Resource Manager template that produced the environment. +* **createdByUser**: string (ReadOnly): The creator of the environment. +* **deploymentProperties**: [EnvironmentDeploymentProperties](#environmentdeploymentproperties): Properties of an environment deployment. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **resourceGroupId**: string (ReadOnly): The identifier of the resource group containing the environment's resources. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). + +## Event +### Properties +* **eventName**: 'AutoShutdown' | 'Cost' | string: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) + +## ExternalSubnet +### Properties +* **id**: string: Gets or sets the identifier. +* **name**: string: Gets or sets the name. + +## FormulaProperties +### Properties +* **author**: string (ReadOnly): The author of the formula. +* **creationDate**: string (ReadOnly): The creation date of the formula. +* **description**: string: The description of the formula. +* **formulaContent**: [LabVirtualMachineCreationParameter](#labvirtualmachinecreationparameter): Properties for creating a virtual machine. +* **osType**: string: The OS type of the formula. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **vm**: [FormulaPropertiesFromVm](#formulapropertiesfromvm): Information about a VM from which a formula is to be created. + +## FormulaPropertiesFromVm +### Properties +* **labVmId**: string: The identifier of the VM from which a formula is to be created. + +## GalleryImageReference +### Properties +* **offer**: string: The offer of the gallery image. +* **osType**: string: The OS type of the gallery image. +* **publisher**: string: The publisher of the gallery image. +* **sku**: string: The SKU of the gallery image. +* **version**: string: The version of the gallery image. + +## HourDetails +### Properties +* **minute**: int: Minutes of the hour the schedule will run. + +## IdentityProperties +### Properties +* **clientSecretUrl**: string: The client secret URL of the identity. +* **principalId**: string: The principal id of resource identity. +* **tenantId**: string: The tenant identifier of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Managed identity. + +## InboundNatRule +### Properties +* **backendPort**: int: The port to which the external traffic will be redirected. +* **frontendPort**: int: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. +* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. + +## LabAnnouncementProperties +### Properties +* **enabled**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). +* **expirationDate**: string: The time at which the announcement expires (null for never) +* **expired**: bool: Has this announcement expired? +* **markdown**: string: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **title**: string: The plain text title for the lab announcement +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). + +## LabCostDetailsProperties +### Properties +* **cost**: int: The cost component of the cost item. +* **costType**: 'Projected' | 'Reported' | 'Unavailable' | string: The type of the cost. +* **date**: string: The date of the cost item. + +## LabCostProperties +### Properties +* **createdDate**: string: The creation date of the cost. +* **currencyCode**: string: The currency code of the cost. +* **endDateTime**: string: The end time of the cost data. +* **labCostDetails**: [LabCostDetailsProperties](#labcostdetailsproperties)[] (ReadOnly): The lab cost details component of the cost data. +* **labCostSummary**: [LabCostSummaryProperties](#labcostsummaryproperties) (ReadOnly): The properties of the cost summary. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **resourceCosts**: [LabResourceCostProperties](#labresourcecostproperties)[] (ReadOnly): The resource cost component of the cost data. +* **startDateTime**: string: The start time of the cost data. +* **targetCost**: [TargetCostProperties](#targetcostproperties): Properties of a cost target. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). + +## LabCostSummaryProperties +### Properties +* **estimatedLabCost**: int: The cost component of the cost item. + +## LabProperties +### Properties +* **announcement**: [LabAnnouncementProperties](#labannouncementproperties): Properties of a lab's announcement banner +* **artifactsStorageAccount**: string (ReadOnly): The lab's artifact storage account. +* **createdDate**: string (ReadOnly): The creation date of the lab. +* **defaultPremiumStorageAccount**: string (ReadOnly): The lab's default premium storage account. +* **defaultStorageAccount**: string (ReadOnly): The lab's default storage account. +* **environmentPermission**: 'Contributor' | 'Reader' | string: The access rights to be granted to the user when provisioning an environment +* **extendedProperties**: [LabPropertiesExtendedProperties](#labpropertiesextendedproperties): Extended properties of the lab used for experimental features +* **labStorageType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). +* **loadBalancerId**: string (ReadOnly): The load balancer used to for lab VMs that use shared IP address. +* **mandatoryArtifactsResourceIdsLinux**: string[]: The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user. +* **mandatoryArtifactsResourceIdsWindows**: string[]: The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user. +* **networkSecurityGroupId**: string (ReadOnly): The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. +* **premiumDataDisks**: 'Disabled' | 'Enabled' | 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. +* **premiumDataDiskStorageAccount**: string (ReadOnly): The lab's premium data disk storage account. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **publicIpId**: string (ReadOnly): The public IP address for the lab's load balancer. +* **support**: [LabSupportProperties](#labsupportproperties): Properties of a lab's support banner +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **vaultName**: string (ReadOnly): The lab's Key vault. +* **vmCreationResourceGroup**: string (ReadOnly): The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. + +## LabPropertiesExtendedProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## LabResourceCostProperties +### Properties +* **externalResourceId**: string: The ID of the external resource +* **resourceCost**: int: The cost component of the resource cost item. +* **resourceId**: string: The ID of the resource +* **resourcename**: string: The name of the resource. +* **resourceOwner**: string: The owner of the resource (ex. janedoe@microsoft.com) +* **resourcePricingTier**: string: The category of the resource (ex. Premium_LRS, Standard_DS1) +* **resourceStatus**: string: The status of the resource (ex. Active) +* **resourceType**: string: The logical resource type (ex. virtualmachine, storageaccount) +* **resourceUId**: string: The unique identifier of the resource. -## WindowsOsInfo +## LabSupportProperties ### Properties -* **windowsOsState**: 'NonSysprepped' | 'SysprepApplied' | 'SysprepRequested' | string: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). +* **enabled**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). +* **markdown**: string: The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. -## ResourceTags +## LabVhd ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The URI to the VHD. -## FormulaProperties +## LabVhdList ### Properties -* **author**: string (ReadOnly): The author of the formula. -* **creationDate**: string (ReadOnly): The creation date of the formula. -* **description**: string: The description of the formula. -* **formulaContent**: [LabVirtualMachineCreationParameter](#labvirtualmachinecreationparameter): Properties for creating a virtual machine. -* **osType**: string: The OS type of the formula. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -* **vm**: [FormulaPropertiesFromVm](#formulapropertiesfromvm): Information about a VM from which a formula is to be created. +* **nextLink**: string (ReadOnly): Link for next set of results. +* **value**: [LabVhd](#labvhd)[] (ReadOnly): Results of the list operation. ## LabVirtualMachineCreationParameter ### Properties @@ -455,44 +590,52 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **storageType**: string: Storage type to use for virtual machine (i.e. Standard, Premium). * **userName**: string: The user name of the virtual machine. -## ArtifactInstallProperties -### Properties -* **artifactId**: string: The artifact's identifier. -* **artifactTitle**: string: The artifact's title. -* **deploymentStatusMessage**: string: The status message from the deployment. -* **installTime**: string: The time that the artifact starts to install on the virtual machine. -* **parameters**: [ArtifactParameterProperties](#artifactparameterproperties)[]: The parameters of the artifact. -* **status**: string: The status of the artifact. -* **vmExtensionStatusMessage**: string: The status message from the virtual machine extension. - -## ArtifactParameterProperties -### Properties -* **name**: string: The name of the artifact parameter. -* **value**: string: The value of the artifact parameter. - -## BulkCreationParameters -### Properties -* **instanceCount**: int: The number of virtual machine instances to create. - -## DataDiskProperties +## LabVirtualMachineCreationParameterTags ### Properties -* **attachNewDataDiskOptions**: [AttachNewDataDiskOptions](#attachnewdatadiskoptions): Properties to attach new disk to the Virtual Machine. -* **existingLabDiskId**: string: Specifies the existing lab disk id to attach to virtual machine. -* **hostCaching**: 'None' | 'ReadOnly' | 'ReadWrite' | string: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). +### Additional Properties +* **Additional Properties Type**: string -## AttachNewDataDiskOptions +## LabVirtualMachineProperties ### Properties -* **diskName**: string: The name of the disk to be attached. -* **diskSizeGiB**: int: Size of the disk to be attached in Gibibytes. -* **diskType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). +* **allowClaim**: bool: Indicates whether another user can take ownership of the virtual machine +* **applicableSchedule**: [ApplicableSchedule](#applicableschedule) (ReadOnly): Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. +* **artifactDeploymentStatus**: [ArtifactDeploymentStatusProperties](#artifactdeploymentstatusproperties) (ReadOnly): Properties of an artifact deployment. +* **artifacts**: [ArtifactInstallProperties](#artifactinstallproperties)[]: The artifacts to be installed on the virtual machine. +* **computeId**: string (ReadOnly): The resource identifier (Microsoft.Compute) of the virtual machine. +* **computeVm**: [ComputeVmProperties](#computevmproperties) (ReadOnly): Properties of a virtual machine returned by the Microsoft.Compute API. +* **createdByUser**: string (ReadOnly): The email address of creator of the virtual machine. +* **createdByUserId**: string (ReadOnly): The object identifier of the creator of the virtual machine. +* **createdDate**: string: The creation date of the virtual machine. +* **customImageId**: string: The custom image identifier of the virtual machine. +* **dataDiskParameters**: [DataDiskProperties](#datadiskproperties)[]: New or existing data disks to attach to the virtual machine after creation +* **disallowPublicIpAddress**: bool: Indicates whether the virtual machine is to be created without a public IP address. +* **environmentId**: string: The resource ID of the environment that contains this virtual machine, if any. +* **expirationDate**: string: The expiration date for VM. +* **fqdn**: string (ReadOnly): The fully-qualified domain name of the virtual machine. +* **galleryImageReference**: [GalleryImageReference](#galleryimagereference): The reference information for an Azure Marketplace image. +* **isAuthenticationWithSshKey**: bool: Indicates whether this virtual machine uses an SSH key for authentication. +* **labSubnetName**: string: The lab subnet name of the virtual machine. +* **labVirtualNetworkId**: string: The lab virtual network identifier of the virtual machine. +* **lastKnownPowerState**: string (ReadOnly): Last known compute power state captured in DTL +* **networkInterface**: [NetworkInterfaceProperties](#networkinterfaceproperties): Properties of a network interface. +* **notes**: string: The notes of the virtual machine. +* **osType**: string (ReadOnly): The OS type of the virtual machine. +* **ownerObjectId**: string: The object identifier of the owner of the virtual machine. +* **ownerUserPrincipalName**: string: The user principal name of the virtual machine owner. +* **password**: string: The password of the virtual machine administrator. +* **planId**: string: The id of the plan associated with the virtual machine image +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **scheduleParameters**: [ScheduleCreationParameter](#schedulecreationparameter)[]: Virtual Machine schedules to be created +* **size**: string: The size of the virtual machine. +* **sshKey**: string: The SSH key of the virtual machine administrator. +* **storageType**: string: Storage type to use for virtual machine (i.e. Standard, Premium). +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **userName**: string: The user name of the virtual machine. +* **virtualMachineCreationSource**: 'FromCustomImage' | 'FromGalleryImage' | 'FromSharedGalleryImage' | string (ReadOnly): Tells source of creation of lab virtual machine. Output property only. -## GalleryImageReference +## LinuxOsInfo ### Properties -* **offer**: string: The offer of the gallery image. -* **osType**: string: The OS type of the gallery image. -* **publisher**: string: The publisher of the gallery image. -* **sku**: string: The SKU of the gallery image. -* **version**: string: The version of the gallery image. +* **linuxOsState**: 'DeprovisionApplied' | 'DeprovisionRequested' | 'NonDeprovisioned' | string: The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). ## NetworkInterfaceProperties ### Properties @@ -506,74 +649,6 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **subnetId**: string: The resource ID of the sub net. * **virtualNetworkId**: string: The resource ID of the virtual network. -## SharedPublicIpAddressConfiguration -### Properties -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: The incoming NAT rules - -## InboundNatRule -### Properties -* **backendPort**: int: The port to which the external traffic will be redirected. -* **frontendPort**: int: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. -* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. - -## ScheduleCreationParameter -### Properties -* **location**: string (ReadOnly): The location of the new virtual machine or environment -* **name**: string: The name of the virtual machine or environment -* **properties**: [ScheduleCreationParameterProperties](#schedulecreationparameterproperties): Properties for schedule creation. -* **tags**: [ScheduleCreationParameterTags](#schedulecreationparametertags): The tags of the resource. - -## ScheduleCreationParameterProperties -### Properties -* **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. -* **hourlyRecurrence**: [HourDetails](#hourdetails): Properties of an hourly schedule. -* **notificationSettings**: [NotificationSettings](#notificationsettings): Notification settings for a schedule. -* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). -* **targetResourceId**: string: The resource ID to which the schedule belongs -* **taskType**: string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). -* **timeZoneId**: string: The time zone ID (e.g. Pacific Standard time). -* **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. - -## DayDetails -### Properties -* **time**: string: The time of day the schedule will occur. - -## HourDetails -### Properties -* **minute**: int: Minutes of the hour the schedule will run. - -## NotificationSettings -### Properties -* **emailRecipient**: string: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). -* **notificationLocale**: string: The locale to use when sending a notification (fallback for unsupported languages is EN). -* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). -* **timeInMinutes**: int: Time in minutes before event at which notification will be sent. -* **webhookUrl**: string: The webhook URL to which the notification will be sent. - -## WeekDetails -### Properties -* **time**: string: The time of the day the schedule will occur. -* **weekdays**: string[]: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). - -## ScheduleCreationParameterTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LabVirtualMachineCreationParameterTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## FormulaPropertiesFromVm -### Properties -* **labVmId**: string: The identifier of the VM from which a formula is to be created. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## NotificationChannelProperties ### Properties * **createdDate**: string (ReadOnly): The creation date of the notification channel. @@ -585,14 +660,17 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). * **webHookUrl**: string: The webhook URL to send notifications to. -## Event +## NotificationSettings ### Properties -* **eventName**: 'AutoShutdown' | 'Cost' | string: The event type for which this notification is enabled (i.e. AutoShutdown, Cost) +* **emailRecipient**: string: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). +* **notificationLocale**: string: The locale to use when sending a notification (fallback for unsupported languages is EN). +* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). +* **timeInMinutes**: int: Time in minutes before event at which notification will be sent. +* **webhookUrl**: string: The webhook URL to which the notification will be sent. -## ResourceTags +## PercentageCostThresholdProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **thresholdValue**: int: The cost threshold value. ## PolicyProperties ### Properties @@ -606,152 +684,85 @@ When its value is 'Disabled', only creation of standard data disks is allowed. * **threshold**: string: The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy). * **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +## Port +### Properties +* **backendPort**: int: Backend port of the target virtual machine. +* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ScheduleProperties -### Properties -* **createdDate**: string (ReadOnly): The creation date of the schedule. -* **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. -* **hourlyRecurrence**: [HourDetails](#hourdetails): Properties of an hourly schedule. -* **notificationSettings**: [NotificationSettings](#notificationsettings): Notification settings for a schedule. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). -* **targetResourceId**: string: The resource ID to which the schedule belongs -* **taskType**: string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). -* **timeZoneId**: string: The time zone ID (e.g. Pacific Standard time). -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -* **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IdentityProperties -### Properties -* **clientSecretUrl**: string: The client secret URL of the identity. -* **principalId**: string: The principal id of resource identity. -* **tenantId**: string: The tenant identifier of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Managed identity. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## UserProperties -### Properties -* **createdDate**: string (ReadOnly): The creation date of the user profile. -* **identity**: [UserIdentity](#useridentity): Identity attributes of a lab user. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **secretStore**: [UserSecretStore](#usersecretstore): Properties of a user's secret store. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). - -## UserIdentity -### Properties -* **appId**: string: Set to the app Id of the client JWT making the request. -* **objectId**: 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. -* **principalId**: string: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. -* **principalName**: string: Set to the principal name / UPN of the client JWT making the request. -* **tenantId**: string: Set to the tenant ID of the client JWT making the request. - -## UserSecretStore -### Properties -* **keyVaultId**: string: The ID of the user's Key vault. -* **keyVaultUri**: string: The URI of the user's Key vault. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DiskProperties -### Properties -* **createdDate**: string (ReadOnly): The creation date of the disk. -* **diskBlobName**: string: When backed by a blob, the name of the VHD blob without extension. -* **diskSizeGiB**: int: The size of the disk in Gibibytes. -* **diskType**: 'Premium' | 'Standard' | 'StandardSSD' | string: The storage type for the disk (i.e. Standard, Premium). -* **diskUri**: string: When backed by a blob, the URI of underlying blob. -* **hostCaching**: string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite). -* **leasedByLabVmId**: string: The resource ID of the VM to which this disk is leased. -* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **storageAccountId**: string: When backed by a blob, the storage account where the blob is. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EnvironmentProperties +## ResourceTags ### Properties -* **armTemplateDisplayName**: string: The display name of the Azure Resource Manager template that produced the environment. -* **createdByUser**: string (ReadOnly): The creator of the environment. -* **deploymentProperties**: [EnvironmentDeploymentProperties](#environmentdeploymentproperties): Properties of an environment deployment. -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **resourceGroupId**: string (ReadOnly): The identifier of the resource group containing the environment's resources. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +### Additional Properties +* **Additional Properties Type**: string -## EnvironmentDeploymentProperties +## ResourceTags ### Properties -* **armTemplateId**: string: The Azure Resource Manager template's identifier. -* **parameters**: [ArmTemplateParameterProperties](#armtemplateparameterproperties)[]: The parameters of the Azure Resource Manager template. +### Additional Properties +* **Additional Properties Type**: string -## ArmTemplateParameterProperties +## ResourceTags ### Properties -* **name**: string: The name of the template parameter. -* **value**: string: The value of the template parameter. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SecretProperties +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -* **value**: string: The value of the secret for secret creation. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceFabricProperties +## ResourceTags ### Properties -* **applicableSchedule**: [ApplicableSchedule](#applicableschedule) (ReadOnly): Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. -* **environmentId**: string: The resource id of the environment under which the service fabric resource is present -* **externalServiceFabricId**: string: The backing service fabric resource's id -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +### Additional Properties +* **Additional Properties Type**: string -## ApplicableSchedule +## ResourceTags ### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicableScheduleProperties +## ResourceTags ### Properties -* **labVmsShutdown**: [Schedule](#schedule): A schedule. -* **labVmsStartup**: [Schedule](#schedule): A schedule. +### Additional Properties +* **Additional Properties Type**: string -## Schedule +## ResourceTags ### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ScheduleProperties](#scheduleproperties) (Required): Properties of a schedule. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -773,105 +784,91 @@ When its value is 'Disabled', only creation of standard data disks is allowed. ### Additional Properties * **Additional Properties Type**: string -## LabVirtualMachineProperties +## ResourceTags ### Properties -* **allowClaim**: bool: Indicates whether another user can take ownership of the virtual machine -* **applicableSchedule**: [ApplicableSchedule](#applicableschedule) (ReadOnly): Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. -* **artifactDeploymentStatus**: [ArtifactDeploymentStatusProperties](#artifactdeploymentstatusproperties) (ReadOnly): Properties of an artifact deployment. -* **artifacts**: [ArtifactInstallProperties](#artifactinstallproperties)[]: The artifacts to be installed on the virtual machine. -* **computeId**: string (ReadOnly): The resource identifier (Microsoft.Compute) of the virtual machine. -* **computeVm**: [ComputeVmProperties](#computevmproperties) (ReadOnly): Properties of a virtual machine returned by the Microsoft.Compute API. -* **createdByUser**: string (ReadOnly): The email address of creator of the virtual machine. -* **createdByUserId**: string (ReadOnly): The object identifier of the creator of the virtual machine. -* **createdDate**: string: The creation date of the virtual machine. -* **customImageId**: string: The custom image identifier of the virtual machine. -* **dataDiskParameters**: [DataDiskProperties](#datadiskproperties)[]: New or existing data disks to attach to the virtual machine after creation -* **disallowPublicIpAddress**: bool: Indicates whether the virtual machine is to be created without a public IP address. -* **environmentId**: string: The resource ID of the environment that contains this virtual machine, if any. -* **expirationDate**: string: The expiration date for VM. -* **fqdn**: string (ReadOnly): The fully-qualified domain name of the virtual machine. -* **galleryImageReference**: [GalleryImageReference](#galleryimagereference): The reference information for an Azure Marketplace image. -* **isAuthenticationWithSshKey**: bool: Indicates whether this virtual machine uses an SSH key for authentication. -* **labSubnetName**: string: The lab subnet name of the virtual machine. -* **labVirtualNetworkId**: string: The lab virtual network identifier of the virtual machine. -* **lastKnownPowerState**: string (ReadOnly): Last known compute power state captured in DTL -* **networkInterface**: [NetworkInterfaceProperties](#networkinterfaceproperties): Properties of a network interface. -* **notes**: string: The notes of the virtual machine. -* **osType**: string (ReadOnly): The OS type of the virtual machine. -* **ownerObjectId**: string: The object identifier of the owner of the virtual machine. -* **ownerUserPrincipalName**: string: The user principal name of the virtual machine owner. -* **password**: string: The password of the virtual machine administrator. -* **planId**: string: The id of the plan associated with the virtual machine image -* **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **scheduleParameters**: [ScheduleCreationParameter](#schedulecreationparameter)[]: Virtual Machine schedules to be created -* **size**: string: The size of the virtual machine. -* **sshKey**: string: The SSH key of the virtual machine administrator. -* **storageType**: string: Storage type to use for virtual machine (i.e. Standard, Premium). -* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -* **userName**: string: The user name of the virtual machine. -* **virtualMachineCreationSource**: 'FromCustomImage' | 'FromGalleryImage' | 'FromSharedGalleryImage' | string (ReadOnly): Tells source of creation of lab virtual machine. Output property only. +### Additional Properties +* **Additional Properties Type**: string -## ArtifactDeploymentStatusProperties +## ResourceTags ### Properties -* **artifactsApplied**: int: The total count of the artifacts that were successfully applied. -* **deploymentStatus**: string: The deployment status of the artifact. -* **totalArtifacts**: int: The total count of the artifacts that were tentatively applied. +### Additional Properties +* **Additional Properties Type**: string -## ComputeVmProperties +## Schedule ### Properties -* **dataDiskIds**: string[]: Gets data disks blob uri for the virtual machine. -* **dataDisks**: [ComputeDataDisk](#computedatadisk)[]: Gets all data disks attached to the virtual machine. -* **networkInterfaceId**: string: Gets the network interface ID of the virtual machine. -* **osDiskId**: string: Gets OS disk blob uri for the virtual machine. -* **osType**: string: Gets the OS type of the virtual machine. -* **statuses**: [ComputeVmInstanceViewStatus](#computevminstanceviewstatus)[]: Gets the statuses of the virtual machine. -* **vmSize**: string: Gets the size of the virtual machine. +* **id**: string (ReadOnly): The identifier of the resource. +* **location**: string: The location of the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [ScheduleProperties](#scheduleproperties) (Required): Properties of a schedule. +* **tags**: [ResourceTags](#resourcetags): The tags of the resource. +* **type**: string (ReadOnly): The type of the resource. -## ComputeDataDisk +## ScheduleCreationParameter ### Properties -* **diskSizeGiB**: int: Gets data disk size in GiB. -* **diskUri**: string: When backed by a blob, the URI of underlying blob. -* **managedDiskId**: string: When backed by managed disk, this is the ID of the compute disk resource. -* **name**: string: Gets data disk name. +* **location**: string (ReadOnly): The location of the new virtual machine or environment +* **name**: string: The name of the virtual machine or environment +* **properties**: [ScheduleCreationParameterProperties](#schedulecreationparameterproperties): Properties for schedule creation. +* **tags**: [ScheduleCreationParameterTags](#schedulecreationparametertags): The tags of the resource. -## ComputeVmInstanceViewStatus +## ScheduleCreationParameterProperties ### Properties -* **code**: string: Gets the status Code. -* **displayStatus**: string: Gets the short localizable label for the status. -* **message**: string: Gets the message associated with the status. +* **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. +* **hourlyRecurrence**: [HourDetails](#hourdetails): Properties of an hourly schedule. +* **notificationSettings**: [NotificationSettings](#notificationsettings): Notification settings for a schedule. +* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). +* **targetResourceId**: string: The resource ID to which the schedule belongs +* **taskType**: string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). +* **timeZoneId**: string: The time zone ID (e.g. Pacific Standard time). +* **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. -## ResourceTags +## ScheduleCreationParameterTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## ScheduleList ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link for next set of results. +* **value**: [Schedule](#schedule)[] (ReadOnly): Results of the list operation. -## VirtualNetworkProperties +## ScheduleProperties ### Properties -* **allowedSubnets**: [Subnet](#subnet)[]: The allowed subnets of the virtual network. -* **createdDate**: string (ReadOnly): The creation date of the virtual network. -* **description**: string: The description of the virtual network. -* **externalProviderResourceId**: string: The Microsoft.Network resource identifier of the virtual network. -* **externalSubnets**: [ExternalSubnet](#externalsubnet)[] (ReadOnly): The external subnet properties. +* **createdDate**: string (ReadOnly): The creation date of the schedule. +* **dailyRecurrence**: [DayDetails](#daydetails): Properties of a daily schedule. +* **hourlyRecurrence**: [HourDetails](#hourdetails): Properties of an hourly schedule. +* **notificationSettings**: [NotificationSettings](#notificationsettings): Notification settings for a schedule. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **status**: 'Disabled' | 'Enabled' | string: Indicates if the artifact source is enabled (values: Enabled, Disabled). +* **targetResourceId**: string: The resource ID to which the schedule belongs +* **taskType**: string: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). +* **timeZoneId**: string: The time zone ID (e.g. Pacific Standard time). +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **weeklyRecurrence**: [WeekDetails](#weekdetails): Properties of a weekly schedule. + +## SecretProperties +### Properties +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +* **value**: string: The value of the secret for secret creation. + +## ServiceFabricProperties +### Properties +* **applicableSchedule**: [ApplicableSchedule](#applicableschedule) (ReadOnly): Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. +* **environmentId**: string: The resource id of the environment under which the service fabric resource is present +* **externalServiceFabricId**: string: The backing service fabric resource's id * **provisioningState**: string (ReadOnly): The provisioning status of the resource. -* **subnetOverrides**: [SubnetOverride](#subnetoverride)[]: The subnet overrides of the virtual network. * **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). +## SharedPublicIpAddressConfiguration +### Properties +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: The incoming NAT rules + ## Subnet ### Properties * **allowPublicIp**: 'Allow' | 'Default' | 'Deny' | string: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). * **labSubnetName**: string: The name of the subnet as seen in the lab. * **resourceId**: string: The resource ID of the subnet. -## ExternalSubnet -### Properties -* **id**: string: Gets or sets the identifier. -* **name**: string: Gets or sets the name. - ## SubnetOverride ### Properties * **labSubnetName**: string: The name given to the subnet within the lab. @@ -885,50 +882,53 @@ When its value is 'Disabled', only creation of standard data disks is allowed. ### Properties * **allowedPorts**: [Port](#port)[]: Backend ports that virtual machines on this subnet are allowed to expose -## Port -### Properties -* **backendPort**: int: Backend port of the target virtual machine. -* **transportProtocol**: 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. - -## ResourceTags +## TargetCostProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **costThresholds**: [CostThresholdProperties](#costthresholdproperties)[]: Cost thresholds. +* **cycleEndDateTime**: string: Reporting cycle end date. +* **cycleStartDateTime**: string: Reporting cycle start date. +* **cycleType**: 'CalendarMonth' | 'Custom' | string: Reporting cycle type. +* **status**: 'Disabled' | 'Enabled' | string: Target cost status +* **target**: int: Lab target cost -## ResourceTags +## UserIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: Set to the app Id of the client JWT making the request. +* **objectId**: 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. +* **principalId**: string: Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. +* **principalName**: string: Set to the principal name / UPN of the client JWT making the request. +* **tenantId**: string: Set to the tenant ID of the client JWT making the request. -## ScheduleList +## UserProperties ### Properties -* **nextLink**: string (ReadOnly): Link for next set of results. -* **value**: [Schedule](#schedule)[] (ReadOnly): Results of the list operation. +* **createdDate**: string (ReadOnly): The creation date of the user profile. +* **identity**: [UserIdentity](#useridentity): Identity attributes of a lab user. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **secretStore**: [UserSecretStore](#usersecretstore): Properties of a user's secret store. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -## ApplicableSchedule +## UserSecretStore ### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. +* **keyVaultId**: string: The ID of the user's Key vault. +* **keyVaultUri**: string: The URI of the user's Key vault. -## ApplicableSchedule +## VirtualNetworkProperties ### Properties -* **id**: string (ReadOnly): The identifier of the resource. -* **location**: string: The location of the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [ApplicableScheduleProperties](#applicablescheduleproperties) (Required): Properties of a schedules applicable to a virtual machine. -* **tags**: [ResourceTags](#resourcetags): The tags of the resource. -* **type**: string (ReadOnly): The type of the resource. +* **allowedSubnets**: [Subnet](#subnet)[]: The allowed subnets of the virtual network. +* **createdDate**: string (ReadOnly): The creation date of the virtual network. +* **description**: string: The description of the virtual network. +* **externalProviderResourceId**: string: The Microsoft.Network resource identifier of the virtual network. +* **externalSubnets**: [ExternalSubnet](#externalsubnet)[] (ReadOnly): The external subnet properties. +* **provisioningState**: string (ReadOnly): The provisioning status of the resource. +* **subnetOverrides**: [SubnetOverride](#subnetoverride)[]: The subnet overrides of the virtual network. +* **uniqueIdentifier**: string (ReadOnly): The unique immutable identifier of a resource (Guid). -## LabVhdList +## WeekDetails ### Properties -* **nextLink**: string (ReadOnly): Link for next set of results. -* **value**: [LabVhd](#labvhd)[] (ReadOnly): Results of the list operation. +* **time**: string: The time of the day the schedule will occur. +* **weekdays**: string[]: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). -## LabVhd +## WindowsOsInfo ### Properties -* **id**: string (ReadOnly): The URI to the VHD. +* **windowsOsState**: 'NonSysprepped' | 'SysprepApplied' | 'SysprepRequested' | string: The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). diff --git a/generated/dfp/log.out b/generated/dfp/log.out index 183b121116..3d254edfb9 100644 --- a/generated/dfp/log.out +++ b/generated/dfp/log.out @@ -3,13 +3,13 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.dynamics365fraudprotection-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationDisplayValue' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dfp/resource-manager/Microsoft.Dynamics365Fraudprotection/preview/2021-02-01-preview/dfp.json:443:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms -info | Autorest completed in 4.53s. 2 files generated. +info | autorest.bicep took 11ms +info | Autorest completed in 4.34s. 2 files generated. diff --git a/generated/dfp/microsoft.dynamics365fraudprotection/2021-02-01-preview/types.md b/generated/dfp/microsoft.dynamics365fraudprotection/2021-02-01-preview/types.md index f532258cfd..0db099f9c2 100644 --- a/generated/dfp/microsoft.dynamics365fraudprotection/2021-02-01-preview/types.md +++ b/generated/dfp/microsoft.dynamics365fraudprotection/2021-02-01-preview/types.md @@ -12,14 +12,19 @@ * **tags**: [DFPInstanceTags](#dfpinstancetags): Key-value pairs of additional resource provisioning properties. * **type**: 'Microsoft.Dynamics365FraudProtection/instances' (ReadOnly, DeployTimeConstant): The resource type +## DFPInstanceAdministrators +### Properties +* **members**: string[]: An array of administrator user identities. + ## DFPInstanceProperties ### Properties * **administration**: [DFPInstanceAdministrators](#dfpinstanceadministrators): An array of administrator user identities * **provisioningState**: 'Deleting' | 'Failed' | 'Paused' | 'Pausing' | 'Preparing' | 'Provisioning' | 'Resuming' | 'Scaling' | 'Succeeded' | 'Suspended' | 'Suspending' | 'Updating' | string (ReadOnly): The current deployment state of DFP resource. The provisioningState is to indicate states for resource provisioning. -## DFPInstanceAdministrators +## DFPInstanceTags ### Properties -* **members**: string[]: An array of administrator user identities. +### Additional Properties +* **Additional Properties Type**: string ## SystemData ### Properties @@ -30,8 +35,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DFPInstanceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/digitaltwins/log.out b/generated/digitaltwins/log.out index a3fa9b32f4..18e4f2153d 100644 --- a/generated/digitaltwins/log.out +++ b/generated/digitaltwins/log.out @@ -12,7 +12,7 @@ warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.digitaltwins-2021-06-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -24,7 +24,7 @@ warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json:1251:5 @@ -41,7 +41,7 @@ warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsEndpointResourceP warning | PreCheck/SchemaMissingType | The schema 'ConnectionProperties-privateLinkServiceConnectionState' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2021-06-30-preview/digitaltwins.json:1970:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.digitaltwins-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -53,7 +53,7 @@ warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-12-01/digitaltwins.json:1047:5 @@ -77,7 +77,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnection-pro - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-12-01/digitaltwins.json:1729:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'GroupIdInformationProperties' -> 'GroupIdInformationPropertiesAutoGenerated' -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.digitaltwins-2020-10-31"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -89,7 +89,7 @@ warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json:678:5 @@ -114,7 +114,7 @@ warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json:689:5 @@ -127,5 +127,5 @@ warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsEndpointResource' warning | PreCheck/SchemaMissingType | The schema 'DigitalTwinsEndpointResourceProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json:933:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms -info | Autorest completed in 10.6s. 8 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 10.57s. 8 files generated. diff --git a/generated/digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.md b/generated/digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.md index 9cbe1a6a7e..1e43f6b5af 100644 --- a/generated/digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.md +++ b/generated/digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.md @@ -21,22 +21,6 @@ * **properties**: [DigitalTwinsEndpointResourceProperties](#digitaltwinsendpointresourceproperties): Properties related to Digital Twins Endpoint * **type**: 'Microsoft.DigitalTwins/digitalTwinsInstances/endpoints' (ReadOnly, DeployTimeConstant): The resource type -## DigitalTwinsProperties -### Properties -* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. -* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. -* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. -* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): The provisioning state. - -## DigitalTwinsSkuInfo -### Properties -* **name**: 'F1' | string (Required): The name of the SKU. - -## DigitalTwinsResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DigitalTwinsEndpointResourceProperties * **Discriminator**: endpointType @@ -69,3 +53,19 @@ ### Additional Properties * **Additional Properties Type**: string +## DigitalTwinsProperties +### Properties +* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. +* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. +* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. +* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): The provisioning state. + +## DigitalTwinsResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DigitalTwinsSkuInfo +### Properties +* **name**: 'F1' | string (Required): The name of the SKU. + diff --git a/generated/digitaltwins/microsoft.digitaltwins/2020-10-31/types.md b/generated/digitaltwins/microsoft.digitaltwins/2020-10-31/types.md index 158a7cd20b..cc0210ff91 100644 --- a/generated/digitaltwins/microsoft.digitaltwins/2020-10-31/types.md +++ b/generated/digitaltwins/microsoft.digitaltwins/2020-10-31/types.md @@ -20,18 +20,6 @@ * **properties**: [DigitalTwinsEndpointResourceProperties](#digitaltwinsendpointresourceproperties) (Required): Properties related to Digital Twins Endpoint * **type**: 'Microsoft.DigitalTwins/digitalTwinsInstances/endpoints' (ReadOnly, DeployTimeConstant): The resource type -## DigitalTwinsProperties -### Properties -* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. -* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. -* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was updated. -* **provisioningState**: 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'Provisioning' | 'Restoring' | 'Succeeded' | 'Suspending' | 'Warning' | string (ReadOnly): The provisioning state. - -## DigitalTwinsResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DigitalTwinsEndpointResourceProperties * **Discriminator**: endpointType @@ -59,3 +47,15 @@ * **secondaryConnectionString**: string: SecondaryConnectionString of the endpoint. Will be obfuscated during read. +## DigitalTwinsProperties +### Properties +* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. +* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. +* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was updated. +* **provisioningState**: 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'Provisioning' | 'Restoring' | 'Succeeded' | 'Suspending' | 'Warning' | string (ReadOnly): The provisioning state. + +## DigitalTwinsResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/digitaltwins/microsoft.digitaltwins/2020-12-01/types.md b/generated/digitaltwins/microsoft.digitaltwins/2020-12-01/types.md index 0c3b34d92e..071a4c8a1d 100644 --- a/generated/digitaltwins/microsoft.digitaltwins/2020-12-01/types.md +++ b/generated/digitaltwins/microsoft.digitaltwins/2020-12-01/types.md @@ -30,35 +30,6 @@ * **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (Required) * **type**: 'Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## DigitalTwinsIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. - -## DigitalTwinsProperties -### Properties -* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. -* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. -* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was updated. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Array of PrivateEndpointConnection -* **provisioningState**: 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'Provisioning' | 'Restoring' | 'Succeeded' | 'Suspending' | 'Updating' | 'Warning' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Public network access for the DigitalTwinsInstance. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (ReadOnly): The resource name. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (Required) -* **type**: string (ReadOnly): The resource type. - -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: The list of group ids for the private endpoint connection. -* **privateEndpoint**: [ConnectionPropertiesPrivateEndpoint](#connectionpropertiesprivateendpoint) -* **privateLinkServiceConnectionState**: [ConnectionPropertiesPrivateLinkServiceConnectionState](#connectionpropertiesprivatelinkserviceconnectionstate) -* **provisioningState**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The provisioning state. - ## ConnectionPropertiesPrivateEndpoint ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -69,11 +40,6 @@ * **description**: string (Required): The description for the current state of a private endpoint connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection. -## DigitalTwinsResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DigitalTwinsEndpointResourceProperties * **Discriminator**: endpointType @@ -107,3 +73,37 @@ * **secondaryConnectionString**: string: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. +## DigitalTwinsIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. + +## DigitalTwinsProperties +### Properties +* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. +* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. +* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was updated. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Array of PrivateEndpointConnection +* **provisioningState**: 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'Provisioning' | 'Restoring' | 'Succeeded' | 'Suspending' | 'Updating' | 'Warning' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Public network access for the DigitalTwinsInstance. + +## DigitalTwinsResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (ReadOnly): The resource name. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (Required) +* **type**: string (ReadOnly): The resource type. + +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: The list of group ids for the private endpoint connection. +* **privateEndpoint**: [ConnectionPropertiesPrivateEndpoint](#connectionpropertiesprivateendpoint) +* **privateLinkServiceConnectionState**: [ConnectionPropertiesPrivateLinkServiceConnectionState](#connectionpropertiesprivatelinkserviceconnectionstate) +* **provisioningState**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The provisioning state. + diff --git a/generated/digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.md b/generated/digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.md index 8db5baf697..008a0bfa66 100644 --- a/generated/digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.md +++ b/generated/digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.md @@ -43,29 +43,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections' (ReadOnly, DeployTimeConstant): The resource type -## DigitalTwinsIdentity -### Properties -* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity -* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. - -## DigitalTwinsProperties -### Properties -* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. -* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. -* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was updated. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The private endpoint connections. -* **provisioningState**: 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'Provisioning' | 'Restoring' | 'Succeeded' | 'Suspending' | 'Updating' | 'Warning' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Public network access for the DigitalTwinsInstance. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): The resource identifier. -* **name**: string (ReadOnly): The resource name. -* **properties**: [ConnectionProperties](#connectionproperties) (Required): The properties of a private endpoint connection. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The resource type. - ## ConnectionProperties ### Properties * **groupIds**: string[]: The list of group ids for the private endpoint connection. @@ -73,30 +50,12 @@ * **privateLinkServiceConnectionState**: [ConnectionPropertiesPrivateLinkServiceConnectionState](#connectionpropertiesprivatelinkserviceconnectionstate): The connection state. * **provisioningState**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## ConnectionPropertiesPrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection. * **description**: string (Required): The description for the current state of a private endpoint connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DigitalTwinsResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DigitalTwinsEndpointResourceProperties * **Discriminator**: endpointType @@ -130,6 +89,47 @@ * **secondaryConnectionString**: string: SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. +## DigitalTwinsIdentity +### Properties +* **principalId**: string (ReadOnly): The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **tenantId**: string (ReadOnly): The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity +* **type**: 'None' | 'SystemAssigned' | string: The type of Managed Identity used by the DigitalTwinsInstance. Only SystemAssigned is supported. + +## DigitalTwinsProperties +### Properties +* **createdTime**: string (ReadOnly): Time when DigitalTwinsInstance was created. +* **hostName**: string (ReadOnly): Api endpoint to work with DigitalTwinsInstance. +* **lastUpdatedTime**: string (ReadOnly): Time when DigitalTwinsInstance was updated. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The private endpoint connections. +* **provisioningState**: 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'Provisioning' | 'Restoring' | 'Succeeded' | 'Suspending' | 'Updating' | 'Warning' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Public network access for the DigitalTwinsInstance. + +## DigitalTwinsResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): The resource identifier. +* **name**: string (ReadOnly): The resource name. +* **properties**: [ConnectionProperties](#connectionproperties) (Required): The properties of a private endpoint connection. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The resource type. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TimeSeriesDatabaseConnectionProperties * **Discriminator**: connectionType diff --git a/generated/dnc/log.out b/generated/dnc/log.out index 947ce0877c..2e69cda20c 100644 --- a/generated/dnc/log.out +++ b/generated/dnc/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.delegatednetwork-2021-03-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrchestratorResourceUpdateParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json:365:5 @@ -15,10 +15,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OrchestratorIdentity' with an warning | PreCheck/SchemaMissingType | The schema 'ResourceUpdateParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json:348:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.delegatednetwork-2020-08-08-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OrchestratorResourceUpdateParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json:362:5 @@ -28,4 +28,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceUpdateParameters' wit - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json:348:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 7.11s. 4 files generated. +info | Autorest completed in 6.81s. 4 files generated. diff --git a/generated/dnc/microsoft.delegatednetwork/2020-08-08-preview/types.md b/generated/dnc/microsoft.delegatednetwork/2020-08-08-preview/types.md index 558d3be58f..50a97f7217 100644 --- a/generated/dnc/microsoft.delegatednetwork/2020-08-08-preview/types.md +++ b/generated/dnc/microsoft.delegatednetwork/2020-08-08-preview/types.md @@ -35,6 +35,15 @@ * **tags**: [OrchestratorResourceTags](#orchestratorresourcetags): The resource tags. * **type**: 'Microsoft.DelegatedNetwork/orchestrators' (ReadOnly, DeployTimeConstant): The resource type +## ControllerDetails +### Properties +* **id**: string: controller arm resource id + +## ControllerResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DelegatedControllerProperties ### Properties * **dncAppId**: string (ReadOnly): dnc application id should be used by customer to authenticate with dnc gateway. @@ -43,11 +52,6 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): The current state of dnc controller resource. * **resourceGuid**: string (ReadOnly): Resource guid. -## ControllerResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DelegatedSubnetProperties ### Properties * **controllerDetails**: [ControllerDetails](#controllerdetails): controller details @@ -55,14 +59,6 @@ * **resourceGuid**: string (ReadOnly): Resource guid. * **subnetDetails**: [SubnetDetails](#subnetdetails): Properties of orchestrator -## ControllerDetails -### Properties -* **id**: string: controller arm resource id - -## SubnetDetails -### Properties -* **id**: string: subnet arm resource id - ## DelegatedSubnetResourceTags ### Properties ### Additional Properties @@ -89,3 +85,7 @@ ### Additional Properties * **Additional Properties Type**: string +## SubnetDetails +### Properties +* **id**: string: subnet arm resource id + diff --git a/generated/dnc/microsoft.delegatednetwork/2021-03-15/types.md b/generated/dnc/microsoft.delegatednetwork/2021-03-15/types.md index 459680d752..24bd329f9a 100644 --- a/generated/dnc/microsoft.delegatednetwork/2021-03-15/types.md +++ b/generated/dnc/microsoft.delegatednetwork/2021-03-15/types.md @@ -35,6 +35,15 @@ * **tags**: [OrchestratorResourceTags](#orchestratorresourcetags): The resource tags. * **type**: 'Microsoft.DelegatedNetwork/orchestrators' (ReadOnly, DeployTimeConstant): The resource type +## ControllerDetails +### Properties +* **id**: string: controller arm resource id + +## ControllerResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DelegatedControllerProperties ### Properties * **dncAppId**: string (ReadOnly): dnc application id should be used by customer to authenticate with dnc gateway. @@ -43,11 +52,6 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): The current state of dnc controller resource. * **resourceGuid**: string (ReadOnly): Resource guid. -## ControllerResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DelegatedSubnetProperties ### Properties * **controllerDetails**: [ControllerDetails](#controllerdetails): controller details @@ -55,14 +59,6 @@ * **resourceGuid**: string (ReadOnly): Resource guid. * **subnetDetails**: [SubnetDetails](#subnetdetails): Properties of orchestrator -## ControllerDetails -### Properties -* **id**: string: controller arm resource id - -## SubnetDetails -### Properties -* **id**: string: subnet arm resource id - ## DelegatedSubnetResourceTags ### Properties ### Additional Properties @@ -90,3 +86,7 @@ ### Additional Properties * **Additional Properties Type**: string +## SubnetDetails +### Properties +* **id**: string: subnet arm resource id + diff --git a/generated/dns/log.out b/generated/dns/log.out index 82254131d9..5fd507ecef 100644 --- a/generated/dns/log.out +++ b/generated/dns/log.out @@ -9,7 +9,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.network-2018-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18,7 +18,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ARecord' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json:1166:5 @@ -71,7 +71,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json:1683:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.network-2018-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -80,7 +80,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ARecord' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json:1076:5 @@ -121,7 +121,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ZoneListResult' with an undef warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json:1485:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.network-2017-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -130,7 +130,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ARecord' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json:1073:5 @@ -171,7 +171,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ZoneListResult' with an undef warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json:1468:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.network-2017-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -180,7 +180,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ARecord' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json:815:5 @@ -228,7 +228,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ARecord' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json:747:5 @@ -276,7 +276,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ARecord' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json:615:5 @@ -311,5 +311,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ZoneListResult' with an undef warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json:921:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 14.58s. 12 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 13.61s. 12 files generated. diff --git a/generated/dns/microsoft.network/2015-05-04-preview/types.md b/generated/dns/microsoft.network/2015-05-04-preview/types.md index 77b5f90e1f..07fcc55c24 100644 --- a/generated/dns/microsoft.network/2015-05-04-preview/types.md +++ b/generated/dns/microsoft.network/2015-05-04-preview/types.md @@ -102,31 +102,6 @@ * **properties**: [RecordSetProperties](#recordsetproperties): Represents the properties of the records in the RecordSet. * **type**: 'Microsoft.Network/dnszones/TXT' (ReadOnly, DeployTimeConstant): The resource type -## ZoneProperties -### Properties -* **maxNumberOfRecordSets**: int: Gets or sets the maximum number of record sets that can be created in this zone. -* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **numberOfRecordSets**: int: Gets or sets the current number of record sets in this zone. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RecordSetProperties -### Properties -* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: Gets or sets the list of AAAA records in the RecordSet. -* **ARecords**: [ARecord](#arecord)[]: Gets or sets the list of A records in the RecordSet. -* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. -* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. -* **MXRecords**: [MxRecord](#mxrecord)[]: Gets or sets the list of MX records in the RecordSet. -* **NSRecords**: [NsRecord](#nsrecord)[]: Gets or sets the list of NS records in the RecordSet. -* **PTRRecords**: [PtrRecord](#ptrrecord)[]: Gets or sets the list of PTR records in the RecordSet. -* **SOARecord**: [SoaRecord](#soarecord): An SOA record. -* **SRVRecords**: [SrvRecord](#srvrecord)[]: Gets or sets the list of SRV records in the RecordSet. -* **TTL**: int: Gets or sets the TTL of the records in the RecordSet. -* **TXTRecords**: [TxtRecord](#txtrecord)[]: Gets or sets the list of TXT records in the RecordSet. - ## AaaaRecord ### Properties * **ipv6Address**: string: Gets or sets the IPv6 address of this AAAA record in string notation. @@ -152,6 +127,20 @@ ### Properties * **ptrdname**: string: Gets or sets the PTR target domain name for this record without a terminating dot. +## RecordSetProperties +### Properties +* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: Gets or sets the list of AAAA records in the RecordSet. +* **ARecords**: [ARecord](#arecord)[]: Gets or sets the list of A records in the RecordSet. +* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. +* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. +* **MXRecords**: [MxRecord](#mxrecord)[]: Gets or sets the list of MX records in the RecordSet. +* **NSRecords**: [NsRecord](#nsrecord)[]: Gets or sets the list of NS records in the RecordSet. +* **PTRRecords**: [PtrRecord](#ptrrecord)[]: Gets or sets the list of PTR records in the RecordSet. +* **SOARecord**: [SoaRecord](#soarecord): An SOA record. +* **SRVRecords**: [SrvRecord](#srvrecord)[]: Gets or sets the list of SRV records in the RecordSet. +* **TTL**: int: Gets or sets the TTL of the records in the RecordSet. +* **TXTRecords**: [TxtRecord](#txtrecord)[]: Gets or sets the list of TXT records in the RecordSet. + ## SoaRecord ### Properties * **email**: string: Gets or sets the email for this record. @@ -169,7 +158,18 @@ * **target**: string: Gets or sets the domain name of the target for this record, without a terminating dot. * **weight**: int: Gets or sets the weight metric for this record. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: Gets or sets the text value of this record. +## ZoneProperties +### Properties +* **maxNumberOfRecordSets**: int: Gets or sets the maximum number of record sets that can be created in this zone. +* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **numberOfRecordSets**: int: Gets or sets the current number of record sets in this zone. + diff --git a/generated/dns/microsoft.network/2016-04-01/types.md b/generated/dns/microsoft.network/2016-04-01/types.md index a9e55e0b4e..e491c514b2 100644 --- a/generated/dns/microsoft.network/2016-04-01/types.md +++ b/generated/dns/microsoft.network/2016-04-01/types.md @@ -102,34 +102,6 @@ * **properties**: [RecordSetProperties](#recordsetproperties): Represents the properties of the records in the record set. * **type**: 'Microsoft.Network/dnsZones/TXT' (ReadOnly, DeployTimeConstant): The resource type -## ZoneProperties -### Properties -* **maxNumberOfRecordSets**: int: The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **numberOfRecordSets**: int: The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RecordSetProperties -### Properties -* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. -* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. -* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. -* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. -* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. -* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. -* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. -* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. -* **SOARecord**: [SoaRecord](#soarecord): An SOA record. -* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. -* **TTL**: int: The TTL (time-to-live) of the records in the record set. -* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. - ## AaaaRecord ### Properties * **ipv6Address**: string: The IPv6 address of this AAAA record. @@ -142,11 +114,6 @@ ### Properties * **cname**: string: The canonical name for this CNAME record. -## RecordSetPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MxRecord ### Properties * **exchange**: string: The domain name of the mail host for this MX record. @@ -160,6 +127,26 @@ ### Properties * **ptrdname**: string: The PTR target domain name for this PTR record. +## RecordSetProperties +### Properties +* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. +* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. +* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. +* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. +* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. +* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. +* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. +* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. +* **SOARecord**: [SoaRecord](#soarecord): An SOA record. +* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. +* **TTL**: int: The TTL (time-to-live) of the records in the record set. +* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. + +## RecordSetPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -177,7 +164,20 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. +## ZoneProperties +### Properties +* **maxNumberOfRecordSets**: int: The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **numberOfRecordSets**: int: The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). + diff --git a/generated/dns/microsoft.network/2017-09-01/types.md b/generated/dns/microsoft.network/2017-09-01/types.md index 90cce3af71..d63e11157e 100644 --- a/generated/dns/microsoft.network/2017-09-01/types.md +++ b/generated/dns/microsoft.network/2017-09-01/types.md @@ -112,35 +112,6 @@ * **properties**: [RecordSetProperties](#recordsetproperties): Represents the properties of the records in the record set. * **type**: 'Microsoft.Network/dnsZones/TXT' (ReadOnly, DeployTimeConstant): The resource type -## ZoneProperties -### Properties -* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RecordSetProperties -### Properties -* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. -* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. -* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. -* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. -* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. -* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. -* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. -* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. -* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. -* **SOARecord**: [SoaRecord](#soarecord): An SOA record. -* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. -* **TTL**: int: The TTL (time-to-live) of the records in the record set. -* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. - ## AaaaRecord ### Properties * **ipv6Address**: string: The IPv6 address of this AAAA record. @@ -159,11 +130,6 @@ ### Properties * **cname**: string: The canonical name for this CNAME record. -## RecordSetPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MxRecord ### Properties * **exchange**: string: The domain name of the mail host for this MX record. @@ -177,6 +143,27 @@ ### Properties * **ptrdname**: string: The PTR target domain name for this PTR record. +## RecordSetProperties +### Properties +* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. +* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. +* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. +* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. +* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. +* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. +* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. +* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. +* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. +* **SOARecord**: [SoaRecord](#soarecord): An SOA record. +* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. +* **TTL**: int: The TTL (time-to-live) of the records in the record set. +* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. + +## RecordSetPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -194,7 +181,20 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. +## ZoneProperties +### Properties +* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). + diff --git a/generated/dns/microsoft.network/2017-10-01/types.md b/generated/dns/microsoft.network/2017-10-01/types.md index 2088437deb..a65f9bcf74 100644 --- a/generated/dns/microsoft.network/2017-10-01/types.md +++ b/generated/dns/microsoft.network/2017-10-01/types.md @@ -112,35 +112,6 @@ * **properties**: [RecordSetProperties](#recordsetproperties): Represents the properties of the records in the record set. * **type**: 'Microsoft.Network/dnsZones/TXT' (ReadOnly, DeployTimeConstant): The resource type -## ZoneProperties -### Properties -* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RecordSetProperties -### Properties -* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. -* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. -* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. -* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. -* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. -* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. -* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. -* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. -* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. -* **SOARecord**: [SoaRecord](#soarecord): An SOA record. -* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. -* **TTL**: int: The TTL (time-to-live) of the records in the record set. -* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. - ## AaaaRecord ### Properties * **ipv6Address**: string: The IPv6 address of this AAAA record. @@ -159,11 +130,6 @@ ### Properties * **cname**: string: The canonical name for this CNAME record. -## RecordSetPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MxRecord ### Properties * **exchange**: string: The domain name of the mail host for this MX record. @@ -177,6 +143,27 @@ ### Properties * **ptrdname**: string: The PTR target domain name for this PTR record. +## RecordSetProperties +### Properties +* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. +* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. +* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. +* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. +* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. +* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. +* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. +* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. +* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. +* **SOARecord**: [SoaRecord](#soarecord): An SOA record. +* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. +* **TTL**: int: The TTL (time-to-live) of the records in the record set. +* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. + +## RecordSetPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -194,7 +181,20 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. +## ZoneProperties +### Properties +* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). + diff --git a/generated/dns/microsoft.network/2018-03-01-preview/types.md b/generated/dns/microsoft.network/2018-03-01-preview/types.md index 47ad78337c..c8cf62187d 100644 --- a/generated/dns/microsoft.network/2018-03-01-preview/types.md +++ b/generated/dns/microsoft.network/2018-03-01-preview/types.md @@ -112,41 +112,6 @@ * **properties**: [RecordSetProperties](#recordsetproperties): Represents the properties of the records in the record set. * **type**: 'Microsoft.Network/dnsZones/TXT' (ReadOnly, DeployTimeConstant): The resource type -## ZoneProperties -### Properties -* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **registrationVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. -* **resolutionVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. -* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). - -## SubResource -### Properties -* **id**: string: Resource Id. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RecordSetProperties -### Properties -* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. -* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. -* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. -* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. -* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. -* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. -* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. -* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. -* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. -* **SOARecord**: [SoaRecord](#soarecord): An SOA record. -* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. -* **TTL**: int: The TTL (time-to-live) of the records in the record set. -* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. - ## AaaaRecord ### Properties * **ipv6Address**: string: The IPv6 address of this AAAA record. @@ -165,11 +130,6 @@ ### Properties * **cname**: string: The canonical name for this CNAME record. -## RecordSetPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MxRecord ### Properties * **exchange**: string: The domain name of the mail host for this MX record. @@ -183,6 +143,27 @@ ### Properties * **ptrdname**: string: The PTR target domain name for this PTR record. +## RecordSetProperties +### Properties +* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. +* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. +* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. +* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. +* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. +* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. +* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. +* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. +* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. +* **SOARecord**: [SoaRecord](#soarecord): An SOA record. +* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. +* **TTL**: int: The TTL (time-to-live) of the records in the record set. +* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. + +## RecordSetPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -200,7 +181,26 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## SubResource +### Properties +* **id**: string: Resource Id. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. +## ZoneProperties +### Properties +* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **registrationVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. +* **resolutionVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. +* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). + diff --git a/generated/dns/microsoft.network/2018-05-01/types.md b/generated/dns/microsoft.network/2018-05-01/types.md index 08f2ba70ca..f12673e5c8 100644 --- a/generated/dns/microsoft.network/2018-05-01/types.md +++ b/generated/dns/microsoft.network/2018-05-01/types.md @@ -112,43 +112,6 @@ * **properties**: [RecordSetProperties](#recordsetproperties): Represents the properties of the records in the record set. * **type**: 'Microsoft.Network/dnsZones/TXT' (ReadOnly, DeployTimeConstant): The resource type -## ZoneProperties -### Properties -* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. -* **registrationVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. -* **resolutionVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. -* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). - -## SubResource -### Properties -* **id**: string: Resource Id. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RecordSetProperties -### Properties -* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. -* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. -* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. -* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. -* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. -* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. -* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. -* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. -* **provisioningState**: string (ReadOnly): provisioning State of the record set. -* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. -* **SOARecord**: [SoaRecord](#soarecord): An SOA record. -* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. -* **targetResource**: [SubResource](#subresource): A reference to a another resource -* **TTL**: int: The TTL (time-to-live) of the records in the record set. -* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. - ## AaaaRecord ### Properties * **ipv6Address**: string: The IPv6 address of this AAAA record. @@ -167,11 +130,6 @@ ### Properties * **cname**: string: The canonical name for this CNAME record. -## RecordSetPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MxRecord ### Properties * **exchange**: string: The domain name of the mail host for this MX record. @@ -185,6 +143,34 @@ ### Properties * **ptrdname**: string: The PTR target domain name for this PTR record. +## RecordSetProperties +### Properties +* **AAAARecords**: [AaaaRecord](#aaaarecord)[]: The list of AAAA records in the record set. +* **ARecords**: [ARecord](#arecord)[]: The list of A records in the record set. +* **caaRecords**: [CaaRecord](#caarecord)[]: The list of CAA records in the record set. +* **CNAMERecord**: [CnameRecord](#cnamerecord): A CNAME record. +* **fqdn**: string (ReadOnly): Fully qualified domain name of the record set. +* **metadata**: [RecordSetPropertiesMetadata](#recordsetpropertiesmetadata): The metadata attached to the record set. +* **MXRecords**: [MxRecord](#mxrecord)[]: The list of MX records in the record set. +* **NSRecords**: [NsRecord](#nsrecord)[]: The list of NS records in the record set. +* **provisioningState**: string (ReadOnly): provisioning State of the record set. +* **PTRRecords**: [PtrRecord](#ptrrecord)[]: The list of PTR records in the record set. +* **SOARecord**: [SoaRecord](#soarecord): An SOA record. +* **SRVRecords**: [SrvRecord](#srvrecord)[]: The list of SRV records in the record set. +* **targetResource**: [SubResource](#subresource): A reference to a another resource +* **TTL**: int: The TTL (time-to-live) of the records in the record set. +* **TXTRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. + +## RecordSetPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -202,7 +188,21 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## SubResource +### Properties +* **id**: string: Resource Id. + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. +## ZoneProperties +### Properties +* **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **maxNumberOfRecordsPerRecordSet**: int (ReadOnly): The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **nameServers**: string[] (ReadOnly): The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **numberOfRecordSets**: int (ReadOnly): The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. +* **registrationVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. +* **resolutionVirtualNetworks**: [SubResource](#subresource)[]: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. +* **zoneType**: 'Private' | 'Public': The type of this DNS zone (Public or Private). + diff --git a/generated/dnsresolver/log.out b/generated/dnsresolver/log.out index 44b2c0f4e6..47fd8ecacf 100644 --- a/generated/dnsresolver/log.out +++ b/generated/dnsresolver/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.network-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16,8 +16,8 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 15ms -info | Autorest completed in 5.77s. 2 files generated. +info | Autorest completed in 5.37s. 2 files generated. diff --git a/generated/dnsresolver/microsoft.network/2020-04-01-preview/types.md b/generated/dnsresolver/microsoft.network/2020-04-01-preview/types.md index e31da2286a..95b1f1b368 100644 --- a/generated/dnsresolver/microsoft.network/2020-04-01-preview/types.md +++ b/generated/dnsresolver/microsoft.network/2020-04-01-preview/types.md @@ -90,23 +90,12 @@ * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. * **resourceGuid**: string (ReadOnly): The resourceGuid for the DNS forwarding ruleset. -## SubResource -### Properties -* **id**: string: Resource ID. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## DnsResolverProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsResolverState**: 'Connected' | 'Disconnected' | string (ReadOnly): The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The Guid property of the resource. +* **virtualNetwork**: [SubResource](#subresource) (Required): Reference to another ARM resource. ## ForwardingRuleProperties ### Properties @@ -121,78 +110,89 @@ ### Additional Properties * **Additional Properties Type**: string -## TargetDnsServer -### Properties -* **ipAddress**: string: DNS server IP address. -* **port**: int: DNS server port. - -## VirtualNetworkLinkProperties +## InboundEndpointProperties ### Properties -* **metadata**: [VirtualNetworkLinkPropertiesMetadata](#virtualnetworklinkpropertiesmetadata): Metadata attached to the virtual network link. +* **ipConfigurations**: [IpConfiguration](#ipconfiguration)[]: IP configurations for the inbound endpoint. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another ARM resource. +* **resourceGuid**: string (ReadOnly): The Guid property of the resource. -## VirtualNetworkLinkPropertiesMetadata +## IpConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIpAddress**: string: Private IP address of the IP configuration. +* **privateIpAllocationMethod**: 'Dynamic' | 'Static' | string: Private IP address allocation method. +* **subnet**: [SubResource](#subresource): Reference to another ARM resource. -## DnsResolverProperties +## OutboundEndpointProperties ### Properties -* **dnsResolverState**: 'Connected' | 'Disconnected' | string (ReadOnly): The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. * **resourceGuid**: string (ReadOnly): The Guid property of the resource. -* **virtualNetwork**: [SubResource](#subresource) (Required): Reference to another ARM resource. +* **subnet**: [SubResource](#subresource): Reference to another ARM resource. -## TrackedResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## InboundEndpointProperties +## SubResourceListResult ### Properties -* **ipConfigurations**: [IpConfiguration](#ipconfiguration)[]: IP configurations for the inbound endpoint. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The Guid property of the resource. +* **nextLink**: string (ReadOnly): The continuation token for the next page of results. +* **value**: [SubResource](#subresource)[] (ReadOnly): Enumeration of the sub-resources. -## IpConfiguration +## SystemData ### Properties -* **privateIpAddress**: string: Private IP address of the IP configuration. -* **privateIpAllocationMethod**: 'Dynamic' | 'Static' | string: Private IP address allocation method. -* **subnet**: [SubResource](#subresource): Reference to another ARM resource. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TargetDnsServer +### Properties +* **ipAddress**: string: DNS server IP address. +* **port**: int: DNS server port. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## OutboundEndpointProperties +## TrackedResourceTags ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The Guid property of the resource. -* **subnet**: [SubResource](#subresource): Reference to another ARM resource. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkDnsForwardingRulesetListResult +## TrackedResourceTags ### Properties -* **nextLink**: string (ReadOnly): The continuation token for the next page of results. -* **value**: [VirtualNetworkDnsForwardingRuleset](#virtualnetworkdnsforwardingruleset)[] (ReadOnly): Enumeration of the Virtual Network DNS Forwarding Ruleset. +### Additional Properties +* **Additional Properties Type**: string ## VirtualNetworkDnsForwardingRuleset ### Properties * **id**: string (ReadOnly): DNS Forwarding Ruleset Resource ID. * **properties**: [VirtualNetworkLinkSubResourceProperties](#virtualnetworklinksubresourceproperties) (ReadOnly): The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network. -## VirtualNetworkLinkSubResourceProperties +## VirtualNetworkDnsForwardingRulesetListResult ### Properties -* **virtualNetworkLink**: [SubResource](#subresource) (ReadOnly): Reference to another ARM resource. +* **nextLink**: string (ReadOnly): The continuation token for the next page of results. +* **value**: [VirtualNetworkDnsForwardingRuleset](#virtualnetworkdnsforwardingruleset)[] (ReadOnly): Enumeration of the Virtual Network DNS Forwarding Ruleset. -## SubResourceListResult +## VirtualNetworkLinkProperties ### Properties -* **nextLink**: string (ReadOnly): The continuation token for the next page of results. -* **value**: [SubResource](#subresource)[] (ReadOnly): Enumeration of the sub-resources. +* **metadata**: [VirtualNetworkLinkPropertiesMetadata](#virtualnetworklinkpropertiesmetadata): Metadata attached to the virtual network link. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the resource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another ARM resource. + +## VirtualNetworkLinkPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VirtualNetworkLinkSubResourceProperties +### Properties +* **virtualNetworkLink**: [SubResource](#subresource) (ReadOnly): Reference to another ARM resource. diff --git a/generated/domainservices/log.out b/generated/domainservices/log.out index d8eafac49d..cf4c913c16 100644 --- a/generated/domainservices/log.out +++ b/generated/domainservices/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.aad-2021-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-05-01/domainservices.json:356:5 @@ -57,10 +57,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OuContainerProperties' with a warning | PreCheck/SchemaMissingType | The schema 'ContainerAccount' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-05-01/oucontainer.json:459:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.aad-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2021-03-01/domainservices.json:356:5 @@ -115,10 +115,10 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'CloudErrorBody' (1 - properties.details.$ref: "#/components/schemas/schemas:88" => "#/components/schemas/schemas:145" warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CloudError' -> 'CloudErrorAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CloudErrorBody' -> 'CloudErrorBodyAutoGenerated' -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.aad-2020-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2020-01-01/domainservices.json:356:5 @@ -176,7 +176,7 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CloudErrorBody' info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.aad-2017-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/domainservices.json:356:5 @@ -224,7 +224,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.aad-2017-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/domainservices.json:314:5 @@ -246,4 +246,4 @@ warning | PreCheck/SchemaMissingType | The schema 'DomainSecuritySettings' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/domainservices.json:638:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 13.55s. 10 files generated. +info | Autorest completed in 12.85s. 10 files generated. diff --git a/generated/domainservices/microsoft.aad/2017-01-01/types.md b/generated/domainservices/microsoft.aad/2017-01-01/types.md index f3ff423eb0..be4e6a08d7 100644 --- a/generated/domainservices/microsoft.aad/2017-01-01/types.md +++ b/generated/domainservices/microsoft.aad/2017-01-01/types.md @@ -12,6 +12,12 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.AAD/domainServices' (ReadOnly, DeployTimeConstant): The resource type +## DomainSecuritySettings +### Properties +* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. +* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. +* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. + ## DomainServiceProperties ### Properties * **deploymentId**: string (ReadOnly): Deployment Id @@ -30,12 +36,6 @@ * **tenantId**: string (ReadOnly): Azure Active Directory tenant id * **vnetSiteId**: string (ReadOnly): Virtual network site id -## DomainSecuritySettings -### Properties -* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. -* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. -* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. - ## HealthAlert ### Properties * **id**: string (ReadOnly): Health Alert Id diff --git a/generated/domainservices/microsoft.aad/2017-06-01/types.md b/generated/domainservices/microsoft.aad/2017-06-01/types.md index 8a99175cab..33b3341d6b 100644 --- a/generated/domainservices/microsoft.aad/2017-06-01/types.md +++ b/generated/domainservices/microsoft.aad/2017-06-01/types.md @@ -27,6 +27,20 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags * **type**: 'Microsoft.Aad/domainServices/ouContainer' (ReadOnly, DeployTimeConstant): The resource type +## ContainerAccount +### Properties +* **accountName**: string (ReadOnly): The account name +* **password**: string (ReadOnly): The account password +* **spn**: string (ReadOnly): The account spn + +## DomainSecuritySettings +### Properties +* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. +* **syncKerberosPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. +* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. +* **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. +* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. + ## DomainServiceProperties ### Properties * **deploymentId**: string (ReadOnly): Deployment Id @@ -50,13 +64,13 @@ * **version**: int (ReadOnly): Data Model Version * **vnetSiteId**: string (ReadOnly): Virtual network site id -## DomainSecuritySettings +## ForestTrust ### Properties -* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. -* **syncKerberosPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. -* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. -* **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. -* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. +* **friendlyName**: string: Friendly Name +* **remoteDnsIps**: string: Remote Dns ips +* **trustDirection**: string: Trust Direction +* **trustedDomainFqdn**: string: Trusted Domain FQDN +* **trustPassword**: string: Trust Password ## HealthAlert ### Properties @@ -85,41 +99,23 @@ * **pfxCertificatePassword**: string: The password to decrypt the provided Secure LDAP certificate pfx file. * **publicCertificate**: string (ReadOnly): Public certificate used to configure secure ldap. +## MigrationProgress +### Properties +* **completionPercentage**: int: Completion Percentage +* **progressMessage**: string: Progress Message + ## MigrationProperties ### Properties * **migrationProgress**: [MigrationProgress](#migrationprogress) (ReadOnly): Migration Progress * **oldSubnetId**: string (ReadOnly): Old Subnet Id * **oldVnetSiteId**: string (ReadOnly): Old Vnet Site Id -## MigrationProgress -### Properties -* **completionPercentage**: int: Completion Percentage -* **progressMessage**: string: Progress Message - ## NotificationSettings ### Properties * **additionalRecipients**: string[]: The list of additional recipients * **notifyDcAdmins**: 'Disabled' | 'Enabled' | string: Should domain controller admins be notified * **notifyGlobalAdmins**: 'Disabled' | 'Enabled' | string: Should global admins be notified -## ResourceForestSettings -### Properties -* **resourceForest**: string: Resource Forest -* **settings**: [ForestTrust](#foresttrust)[]: List of settings for Resource Forest - -## ForestTrust -### Properties -* **friendlyName**: string: Friendly Name -* **remoteDnsIps**: string: Remote Dns ips -* **trustDirection**: string: Trust Direction -* **trustedDomainFqdn**: string: Trusted Domain FQDN -* **trustPassword**: string: Trust Password - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## OuContainerProperties ### Properties * **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts @@ -131,11 +127,15 @@ * **serviceStatus**: string (ReadOnly): Status of OuContainer instance * **tenantId**: string (ReadOnly): Azure Active Directory tenant id -## ContainerAccount +## ResourceForestSettings ### Properties -* **accountName**: string (ReadOnly): The account name -* **password**: string (ReadOnly): The account password -* **spn**: string (ReadOnly): The account spn +* **resourceForest**: string: Resource Forest +* **settings**: [ForestTrust](#foresttrust)[]: List of settings for Resource Forest + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/domainservices/microsoft.aad/2020-01-01/types.md b/generated/domainservices/microsoft.aad/2020-01-01/types.md index 21c9be8367..d130927793 100644 --- a/generated/domainservices/microsoft.aad/2020-01-01/types.md +++ b/generated/domainservices/microsoft.aad/2020-01-01/types.md @@ -27,6 +27,20 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags * **type**: 'Microsoft.Aad/domainServices/ouContainer' (ReadOnly, DeployTimeConstant): The resource type +## ContainerAccount +### Properties +* **accountName**: string (ReadOnly): The account name +* **password**: string (ReadOnly): The account password +* **spn**: string (ReadOnly): The account spn + +## DomainSecuritySettings +### Properties +* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. +* **syncKerberosPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. +* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. +* **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. +* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. + ## DomainServiceProperties ### Properties * **deploymentId**: string (ReadOnly): Deployment Id @@ -45,13 +59,29 @@ * **tenantId**: string (ReadOnly): Azure Active Directory Tenant Id * **version**: int (ReadOnly): Data Model Version -## DomainSecuritySettings +## ForestTrust ### Properties -* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. -* **syncKerberosPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. -* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. -* **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. -* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. +* **friendlyName**: string: Friendly Name +* **remoteDnsIps**: string: Remote Dns ips +* **trustDirection**: string: Trust Direction +* **trustedDomainFqdn**: string: Trusted Domain FQDN +* **trustPassword**: string: Trust Password + +## HealthAlert +### Properties +* **id**: string (ReadOnly): Health Alert Id +* **issue**: string (ReadOnly): Health Alert Issue +* **lastDetected**: string (ReadOnly): Health Alert Last Detected DateTime +* **name**: string (ReadOnly): Health Alert Name +* **raised**: string (ReadOnly): Health Alert Raised DateTime +* **resolutionUri**: string (ReadOnly): Health Alert TSG Link +* **severity**: string (ReadOnly): Health Alert Severity + +## HealthMonitor +### Properties +* **details**: string (ReadOnly): Health Monitor Details +* **id**: string (ReadOnly): Health Monitor Id +* **name**: string (ReadOnly): Health Monitor Name ## LdapsSettings ### Properties @@ -63,23 +93,34 @@ * **pfxCertificatePassword**: string: The password to decrypt the provided Secure LDAP certificate pfx file. * **publicCertificate**: string (ReadOnly): Public certificate used to configure secure ldap. +## MigrationProgress +### Properties +* **completionPercentage**: int: Completion Percentage +* **progressMessage**: string: Progress Message + ## MigrationProperties ### Properties * **migrationProgress**: [MigrationProgress](#migrationprogress) (ReadOnly): Migration Progress * **oldSubnetId**: string (ReadOnly): Old Subnet Id * **oldVnetSiteId**: string (ReadOnly): Old Vnet Site Id -## MigrationProgress -### Properties -* **completionPercentage**: int: Completion Percentage -* **progressMessage**: string: Progress Message - ## NotificationSettings ### Properties * **additionalRecipients**: string[]: The list of additional recipients * **notifyDcAdmins**: 'Disabled' | 'Enabled' | string: Should domain controller admins be notified * **notifyGlobalAdmins**: 'Disabled' | 'Enabled' | string: Should global admins be notified +## OuContainerProperties +### Properties +* **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts +* **containerId**: string (ReadOnly): The OuContainer name +* **deploymentId**: string (ReadOnly): The Deployment id +* **distinguishedName**: string (ReadOnly): Distinguished Name of OuContainer instance +* **domainName**: string (ReadOnly): The domain name of Domain Services. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **serviceStatus**: string (ReadOnly): Status of OuContainer instance +* **tenantId**: string (ReadOnly): Azure Active Directory tenant id + ## ReplicaSet ### Properties * **domainControllerIpAddress**: string[] (ReadOnly): List of Domain Controller IP Address @@ -93,57 +134,16 @@ * **subnetId**: 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. * **vnetSiteId**: string (ReadOnly): Virtual network site id -## HealthAlert -### Properties -* **id**: string (ReadOnly): Health Alert Id -* **issue**: string (ReadOnly): Health Alert Issue -* **lastDetected**: string (ReadOnly): Health Alert Last Detected DateTime -* **name**: string (ReadOnly): Health Alert Name -* **raised**: string (ReadOnly): Health Alert Raised DateTime -* **resolutionUri**: string (ReadOnly): Health Alert TSG Link -* **severity**: string (ReadOnly): Health Alert Severity - -## HealthMonitor -### Properties -* **details**: string (ReadOnly): Health Monitor Details -* **id**: string (ReadOnly): Health Monitor Id -* **name**: string (ReadOnly): Health Monitor Name - ## ResourceForestSettings ### Properties * **resourceForest**: string: Resource Forest * **settings**: [ForestTrust](#foresttrust)[]: List of settings for Resource Forest -## ForestTrust -### Properties -* **friendlyName**: string: Friendly Name -* **remoteDnsIps**: string: Remote Dns ips -* **trustDirection**: string: Trust Direction -* **trustedDomainFqdn**: string: Trusted Domain FQDN -* **trustPassword**: string: Trust Password - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## OuContainerProperties -### Properties -* **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts -* **containerId**: string (ReadOnly): The OuContainer name -* **deploymentId**: string (ReadOnly): The Deployment id -* **distinguishedName**: string (ReadOnly): Distinguished Name of OuContainer instance -* **domainName**: string (ReadOnly): The domain name of Domain Services. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **serviceStatus**: string (ReadOnly): Status of OuContainer instance -* **tenantId**: string (ReadOnly): Azure Active Directory tenant id - -## ContainerAccount -### Properties -* **accountName**: string (ReadOnly): The account name -* **password**: string (ReadOnly): The account password -* **spn**: string (ReadOnly): The account spn - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/domainservices/microsoft.aad/2021-03-01/types.md b/generated/domainservices/microsoft.aad/2021-03-01/types.md index e6b302a035..82a8e8ab13 100644 --- a/generated/domainservices/microsoft.aad/2021-03-01/types.md +++ b/generated/domainservices/microsoft.aad/2021-03-01/types.md @@ -29,6 +29,22 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags * **type**: 'Microsoft.Aad/domainServices/ouContainer' (ReadOnly, DeployTimeConstant): The resource type +## ContainerAccount +### Properties +* **accountName**: string (ReadOnly): The account name +* **password**: string (ReadOnly): The account password +* **spn**: string (ReadOnly): The account spn + +## DomainSecuritySettings +### Properties +* **kerberosArmoring**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not KerberosArmoring is enabled or disabled. +* **kerberosRc4Encryption**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not KerberosRc4Encryption is enabled or disabled. +* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. +* **syncKerberosPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. +* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. +* **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. +* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. + ## DomainServiceProperties ### Properties * **deploymentId**: string (ReadOnly): Deployment Id @@ -47,15 +63,29 @@ * **tenantId**: string (ReadOnly): Azure Active Directory Tenant Id * **version**: int (ReadOnly): Data Model Version -## DomainSecuritySettings +## ForestTrust ### Properties -* **kerberosArmoring**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not KerberosArmoring is enabled or disabled. -* **kerberosRc4Encryption**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not KerberosRc4Encryption is enabled or disabled. -* **ntlmV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not NtlmV1 is enabled or disabled. -* **syncKerberosPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. -* **syncNtlmPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. -* **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. -* **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. +* **friendlyName**: string: Friendly Name +* **remoteDnsIps**: string: Remote Dns ips +* **trustDirection**: string: Trust Direction +* **trustedDomainFqdn**: string: Trusted Domain FQDN +* **trustPassword**: string: Trust Password + +## HealthAlert +### Properties +* **id**: string (ReadOnly): Health Alert Id +* **issue**: string (ReadOnly): Health Alert Issue +* **lastDetected**: string (ReadOnly): Health Alert Last Detected DateTime +* **name**: string (ReadOnly): Health Alert Name +* **raised**: string (ReadOnly): Health Alert Raised DateTime +* **resolutionUri**: string (ReadOnly): Health Alert TSG Link +* **severity**: string (ReadOnly): Health Alert Severity + +## HealthMonitor +### Properties +* **details**: string (ReadOnly): Health Monitor Details +* **id**: string (ReadOnly): Health Monitor Id +* **name**: string (ReadOnly): Health Monitor Name ## LdapsSettings ### Properties @@ -67,23 +97,34 @@ * **pfxCertificatePassword**: string: The password to decrypt the provided Secure LDAP certificate pfx file. * **publicCertificate**: string (ReadOnly): Public certificate used to configure secure ldap. +## MigrationProgress +### Properties +* **completionPercentage**: int: Completion Percentage +* **progressMessage**: string: Progress Message + ## MigrationProperties ### Properties * **migrationProgress**: [MigrationProgress](#migrationprogress) (ReadOnly): Migration Progress * **oldSubnetId**: string (ReadOnly): Old Subnet Id * **oldVnetSiteId**: string (ReadOnly): Old Vnet Site Id -## MigrationProgress -### Properties -* **completionPercentage**: int: Completion Percentage -* **progressMessage**: string: Progress Message - ## NotificationSettings ### Properties * **additionalRecipients**: string[]: The list of additional recipients * **notifyDcAdmins**: 'Disabled' | 'Enabled' | string: Should domain controller admins be notified * **notifyGlobalAdmins**: 'Disabled' | 'Enabled' | string: Should global admins be notified +## OuContainerProperties +### Properties +* **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts +* **containerId**: string (ReadOnly): The OuContainer name +* **deploymentId**: string (ReadOnly): The Deployment id +* **distinguishedName**: string (ReadOnly): Distinguished Name of OuContainer instance +* **domainName**: string (ReadOnly): The domain name of Domain Services. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **serviceStatus**: string (ReadOnly): Status of OuContainer instance +* **tenantId**: string (ReadOnly): Azure Active Directory tenant id + ## ReplicaSet ### Properties * **domainControllerIpAddress**: string[] (ReadOnly): List of Domain Controller IP Address @@ -97,34 +138,20 @@ * **subnetId**: 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. * **vnetSiteId**: string (ReadOnly): Virtual network site id -## HealthAlert -### Properties -* **id**: string (ReadOnly): Health Alert Id -* **issue**: string (ReadOnly): Health Alert Issue -* **lastDetected**: string (ReadOnly): Health Alert Last Detected DateTime -* **name**: string (ReadOnly): Health Alert Name -* **raised**: string (ReadOnly): Health Alert Raised DateTime -* **resolutionUri**: string (ReadOnly): Health Alert TSG Link -* **severity**: string (ReadOnly): Health Alert Severity - -## HealthMonitor -### Properties -* **details**: string (ReadOnly): Health Monitor Details -* **id**: string (ReadOnly): Health Monitor Id -* **name**: string (ReadOnly): Health Monitor Name - ## ResourceForestSettings ### Properties * **resourceForest**: string: Resource Forest * **settings**: [ForestTrust](#foresttrust)[]: List of settings for Resource Forest -## ForestTrust +## ResourceTags ### Properties -* **friendlyName**: string: Friendly Name -* **remoteDnsIps**: string: Remote Dns ips -* **trustDirection**: string: Trust Direction -* **trustedDomainFqdn**: string: Trusted Domain FQDN -* **trustPassword**: string: Trust Password +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SystemData ### Properties @@ -135,30 +162,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## OuContainerProperties -### Properties -* **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts -* **containerId**: string (ReadOnly): The OuContainer name -* **deploymentId**: string (ReadOnly): The Deployment id -* **distinguishedName**: string (ReadOnly): Distinguished Name of OuContainer instance -* **domainName**: string (ReadOnly): The domain name of Domain Services. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **serviceStatus**: string (ReadOnly): Status of OuContainer instance -* **tenantId**: string (ReadOnly): Azure Active Directory tenant id - -## ContainerAccount -### Properties -* **accountName**: string (ReadOnly): The account name -* **password**: string (ReadOnly): The account password -* **spn**: string (ReadOnly): The account spn - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/domainservices/microsoft.aad/2021-05-01/types.md b/generated/domainservices/microsoft.aad/2021-05-01/types.md index 0536a6cff7..1b06be4ba0 100644 --- a/generated/domainservices/microsoft.aad/2021-05-01/types.md +++ b/generated/domainservices/microsoft.aad/2021-05-01/types.md @@ -29,25 +29,6 @@ * **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags * **type**: 'Microsoft.Aad/domainServices/ouContainer' (ReadOnly, DeployTimeConstant): The resource type -## DomainServiceProperties -### Properties -* **configDiagnostics**: [ConfigDiagnostics](#configdiagnostics): Configuration Diagnostics -* **deploymentId**: string (ReadOnly): Deployment Id -* **domainConfigurationType**: string: Domain Configuration Type -* **domainName**: string: The name of the Azure domain that the user would like to deploy Domain Services to. -* **domainSecuritySettings**: [DomainSecuritySettings](#domainsecuritysettings): Domain Security Settings -* **filteredSync**: 'Disabled' | 'Enabled' | string: Enabled or Disabled flag to turn on Group-based filtered sync -* **ldapsSettings**: [LdapsSettings](#ldapssettings): Secure LDAP Settings -* **migrationProperties**: [MigrationProperties](#migrationproperties) (ReadOnly): Migration Properties -* **notificationSettings**: [NotificationSettings](#notificationsettings): Settings for notification -* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. -* **replicaSets**: [ReplicaSet](#replicaset)[]: List of ReplicaSets -* **resourceForestSettings**: [ResourceForestSettings](#resourceforestsettings): Settings for Resource Forest -* **sku**: string: Sku Type -* **syncOwner**: string (ReadOnly): SyncOwner ReplicaSet Id -* **tenantId**: string (ReadOnly): Azure Active Directory Tenant Id -* **version**: int (ReadOnly): Data Model Version - ## ConfigDiagnostics ### Properties * **lastExecuted**: string: Last domain configuration diagnostics DateTime @@ -65,6 +46,12 @@ * **descriptionParams**: string[]: List of domain resource property name or values used to compose a rich description. * **id**: string: Validation issue identifier. +## ContainerAccount +### Properties +* **accountName**: string (ReadOnly): The account name +* **password**: string (ReadOnly): The account password +* **spn**: string (ReadOnly): The account spn + ## DomainSecuritySettings ### Properties * **kerberosArmoring**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not KerberosArmoring is enabled or disabled. @@ -75,6 +62,49 @@ * **syncOnPremPasswords**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. * **tlsV1**: 'Disabled' | 'Enabled' | string: A flag to determine whether or not TlsV1 is enabled or disabled. +## DomainServiceProperties +### Properties +* **configDiagnostics**: [ConfigDiagnostics](#configdiagnostics): Configuration Diagnostics +* **deploymentId**: string (ReadOnly): Deployment Id +* **domainConfigurationType**: string: Domain Configuration Type +* **domainName**: string: The name of the Azure domain that the user would like to deploy Domain Services to. +* **domainSecuritySettings**: [DomainSecuritySettings](#domainsecuritysettings): Domain Security Settings +* **filteredSync**: 'Disabled' | 'Enabled' | string: Enabled or Disabled flag to turn on Group-based filtered sync +* **ldapsSettings**: [LdapsSettings](#ldapssettings): Secure LDAP Settings +* **migrationProperties**: [MigrationProperties](#migrationproperties) (ReadOnly): Migration Properties +* **notificationSettings**: [NotificationSettings](#notificationsettings): Settings for notification +* **provisioningState**: string (ReadOnly): the current deployment or provisioning state, which only appears in the response. +* **replicaSets**: [ReplicaSet](#replicaset)[]: List of ReplicaSets +* **resourceForestSettings**: [ResourceForestSettings](#resourceforestsettings): Settings for Resource Forest +* **sku**: string: Sku Type +* **syncOwner**: string (ReadOnly): SyncOwner ReplicaSet Id +* **tenantId**: string (ReadOnly): Azure Active Directory Tenant Id +* **version**: int (ReadOnly): Data Model Version + +## ForestTrust +### Properties +* **friendlyName**: string: Friendly Name +* **remoteDnsIps**: string: Remote Dns ips +* **trustDirection**: string: Trust Direction +* **trustedDomainFqdn**: string: Trusted Domain FQDN +* **trustPassword**: string: Trust Password + +## HealthAlert +### Properties +* **id**: string (ReadOnly): Health Alert Id +* **issue**: string (ReadOnly): Health Alert Issue +* **lastDetected**: string (ReadOnly): Health Alert Last Detected DateTime +* **name**: string (ReadOnly): Health Alert Name +* **raised**: string (ReadOnly): Health Alert Raised DateTime +* **resolutionUri**: string (ReadOnly): Health Alert TSG Link +* **severity**: string (ReadOnly): Health Alert Severity + +## HealthMonitor +### Properties +* **details**: string (ReadOnly): Health Monitor Details +* **id**: string (ReadOnly): Health Monitor Id +* **name**: string (ReadOnly): Health Monitor Name + ## LdapsSettings ### Properties * **certificateNotAfter**: string (ReadOnly): NotAfter DateTime of configure ldaps certificate. @@ -85,23 +115,34 @@ * **pfxCertificatePassword**: string: The password to decrypt the provided Secure LDAP certificate pfx file. * **publicCertificate**: string (ReadOnly): Public certificate used to configure secure ldap. +## MigrationProgress +### Properties +* **completionPercentage**: int: Completion Percentage +* **progressMessage**: string: Progress Message + ## MigrationProperties ### Properties * **migrationProgress**: [MigrationProgress](#migrationprogress) (ReadOnly): Migration Progress * **oldSubnetId**: string (ReadOnly): Old Subnet Id * **oldVnetSiteId**: string (ReadOnly): Old Vnet Site Id -## MigrationProgress -### Properties -* **completionPercentage**: int: Completion Percentage -* **progressMessage**: string: Progress Message - ## NotificationSettings ### Properties * **additionalRecipients**: string[]: The list of additional recipients * **notifyDcAdmins**: 'Disabled' | 'Enabled' | string: Should domain controller admins be notified * **notifyGlobalAdmins**: 'Disabled' | 'Enabled' | string: Should global admins be notified +## OuContainerProperties +### Properties +* **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts +* **containerId**: string (ReadOnly): The OuContainer name +* **deploymentId**: string (ReadOnly): The Deployment id +* **distinguishedName**: string (ReadOnly): Distinguished Name of OuContainer instance +* **domainName**: string (ReadOnly): The domain name of Domain Services. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **serviceStatus**: string (ReadOnly): Status of OuContainer instance +* **tenantId**: string (ReadOnly): Azure Active Directory tenant id + ## ReplicaSet ### Properties * **domainControllerIpAddress**: string[] (ReadOnly): List of Domain Controller IP Address @@ -115,34 +156,20 @@ * **subnetId**: 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. * **vnetSiteId**: string (ReadOnly): Virtual network site id -## HealthAlert -### Properties -* **id**: string (ReadOnly): Health Alert Id -* **issue**: string (ReadOnly): Health Alert Issue -* **lastDetected**: string (ReadOnly): Health Alert Last Detected DateTime -* **name**: string (ReadOnly): Health Alert Name -* **raised**: string (ReadOnly): Health Alert Raised DateTime -* **resolutionUri**: string (ReadOnly): Health Alert TSG Link -* **severity**: string (ReadOnly): Health Alert Severity - -## HealthMonitor -### Properties -* **details**: string (ReadOnly): Health Monitor Details -* **id**: string (ReadOnly): Health Monitor Id -* **name**: string (ReadOnly): Health Monitor Name - ## ResourceForestSettings ### Properties * **resourceForest**: string: Resource Forest * **settings**: [ForestTrust](#foresttrust)[]: List of settings for Resource Forest -## ForestTrust +## ResourceTags ### Properties -* **friendlyName**: string: Friendly Name -* **remoteDnsIps**: string: Remote Dns ips -* **trustDirection**: string: Trust Direction -* **trustedDomainFqdn**: string: Trusted Domain FQDN -* **trustPassword**: string: Trust Password +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SystemData ### Properties @@ -153,30 +180,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## OuContainerProperties -### Properties -* **accounts**: [ContainerAccount](#containeraccount)[] (ReadOnly): The list of container accounts -* **containerId**: string (ReadOnly): The OuContainer name -* **deploymentId**: string (ReadOnly): The Deployment id -* **distinguishedName**: string (ReadOnly): Distinguished Name of OuContainer instance -* **domainName**: string (ReadOnly): The domain name of Domain Services. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -* **serviceStatus**: string (ReadOnly): Status of OuContainer instance -* **tenantId**: string (ReadOnly): Azure Active Directory tenant id - -## ContainerAccount -### Properties -* **accountName**: string (ReadOnly): The account name -* **password**: string (ReadOnly): The account password -* **spn**: string (ReadOnly): The account spn - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/edgeorder/log.out b/generated/edgeorder/log.out index b0abae06f4..de179cc71a 100644 --- a/generated/edgeorder/log.out +++ b/generated/edgeorder/log.out @@ -3,23 +3,23 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.edgeorder-2021-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies': Unable to find type segments warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations': Unable to find type segments warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 24ms +info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.edgeorder-2020-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listProductFamilies': Unable to find type segments warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations': Unable to find type segments warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms -info | Autorest completed in 9.03s. 4 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 8.53s. 4 files generated. diff --git a/generated/edgeorder/microsoft.edgeorder/2020-12-01-preview/types.md b/generated/edgeorder/microsoft.edgeorder/2020-12-01-preview/types.md index d8d9d88ab5..9e1e3763b9 100644 --- a/generated/edgeorder/microsoft.edgeorder/2020-12-01-preview/types.md +++ b/generated/edgeorder/microsoft.edgeorder/2020-12-01-preview/types.md @@ -24,6 +24,11 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.EdgeOrder/orderItems' (ReadOnly, DeployTimeConstant): The resource type +## AddressDetails +### Properties +* **forwardAddress**: [AddressProperties](#addressproperties) (Required): Address Properties +* **returnAddress**: [AddressProperties](#addressproperties) (ReadOnly): Address Properties + ## AddressProperties ### Properties * **contactDetails**: [ContactDetails](#contactdetails) (Required): Contact Details. @@ -37,44 +42,56 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## ShippingAddress +## DeviceDetails ### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential' | string: Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string: Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. +* **managementResourceId**: string (ReadOnly): Management Resource Id +* **managementResourceTenantId**: string (ReadOnly): Management Resource Tenant ID +* **serialNumber**: string (ReadOnly): device serial number -## SystemData +## DisplayInfo ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **configurationDisplayName**: string (ReadOnly): Configuration display name +* **productFamilyDisplayName**: string (ReadOnly): Product family display name -## TrackedResourceTags +## EncryptionPreferences ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **doubleEncryptionStatus**: 'Disabled' | 'Enabled' | string: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. -## OrderItemProperties +## ErrorAdditionalInfo ### Properties -* **addressDetails**: [AddressDetails](#addressdetails) (Required): Address details for an order item. -* **orderId**: string (Required): Id of the order to which order item belongs to -* **orderItemDetails**: [OrderItemDetails](#orderitemdetails) (Required): Order item details -* **startTime**: string (ReadOnly): Start time of order item +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. -## AddressDetails +## ErrorDetail ### Properties -* **forwardAddress**: [AddressProperties](#addressproperties) (Required): Address Properties -* **returnAddress**: [AddressProperties](#addressproperties) (ReadOnly): Address Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. + +## ForwardShippingDetails +### Properties +* **carrierDisplayName**: string (ReadOnly): Carrier Name for display purpose. Not to be used for any processing. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): TrackingId of the package +* **trackingUrl**: string (ReadOnly): TrackingUrl of the package. + +## HierarchyInformation +### Properties +* **configurationName**: string: Represents configuration name that uniquely identifies configuration +* **productFamilyName**: string: Represents product family name that uniquely identifies product family +* **productLineName**: string: Represents product line name that uniquely identifies product line +* **productName**: string: Represents product name that uniquely identifies product + +## ManagementResourcePreferences +### Properties +* **preferredManagementResourceId**: string: Customer preferred Management resource ARM ID + +## NotificationPreference +### Properties +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'Delivered' | 'Shipped' | string (Required): Name of the stage. ## OrderItemDetails ### Properties @@ -95,36 +112,12 @@ * **returnStatus**: 'NotReturnable' | 'Returnable' | 'ReturnableWithFee' | string (ReadOnly): Describes whether the order item is returnable or not. * **reverseShippingDetails**: [ReverseShippingDetails](#reverseshippingdetails) (ReadOnly): Reverse shipment details. -## StageDetails -### Properties -* **displayName**: string (ReadOnly): Display name of the resource stage. -* **stageName**: 'Cancelled' | 'Confirmed' | 'Delivered' | 'InReview' | 'InUse' | 'Placed' | 'ReadyToShip' | 'ReturnCompleted' | 'ReturnInitiated' | 'ReturnPickedUp' | 'ReturnedToMicrosoft' | 'Shipped' | string (ReadOnly): Stage name -* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | string (ReadOnly): Stage status. -* **startTime**: string (ReadOnly): Stage start time - -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## ForwardShippingDetails -### Properties -* **carrierDisplayName**: string (ReadOnly): Carrier Name for display purpose. Not to be used for any processing. -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): TrackingId of the package -* **trackingUrl**: string (ReadOnly): TrackingUrl of the package. - -## ResourceProviderDetails +## OrderItemProperties ### Properties -* **resourceProviderNamespace**: string (ReadOnly): Resource provider namespace +* **addressDetails**: [AddressDetails](#addressdetails) (Required): Address details for an order item. +* **orderId**: string (Required): Id of the order to which order item belongs to +* **orderItemDetails**: [OrderItemDetails](#orderitemdetails) (Required): Order item details +* **startTime**: string (ReadOnly): Start time of order item ## Preferences ### Properties @@ -133,23 +126,6 @@ * **notificationPreferences**: [NotificationPreference](#notificationpreference)[]: Notification preferences. * **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## EncryptionPreferences -### Properties -* **doubleEncryptionStatus**: 'Disabled' | 'Enabled' | string: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. - -## ManagementResourcePreferences -### Properties -* **preferredManagementResourceId**: string: Customer preferred Management resource ARM ID - -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'Delivered' | 'Shipped' | string (Required): Name of the stage. - -## TransportPreferences -### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' | string (Required): Indicates Shipment Logistics type that the customer preferred. - ## ProductDetails ### Properties * **count**: int (ReadOnly): Quantity of the product @@ -158,23 +134,9 @@ * **hierarchyInformation**: [HierarchyInformation](#hierarchyinformation) (Required): Holds details about product hierarchy information * **productDoubleEncryptionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. -## DeviceDetails -### Properties -* **managementResourceId**: string (ReadOnly): Management Resource Id -* **managementResourceTenantId**: string (ReadOnly): Management Resource Tenant ID -* **serialNumber**: string (ReadOnly): device serial number - -## DisplayInfo -### Properties -* **configurationDisplayName**: string (ReadOnly): Configuration display name -* **productFamilyDisplayName**: string (ReadOnly): Product family display name - -## HierarchyInformation +## ResourceProviderDetails ### Properties -* **configurationName**: string: Represents configuration name that uniquely identifies configuration -* **productFamilyName**: string: Represents product family name that uniquely identifies product family -* **productLineName**: string: Represents product line name that uniquely identifies product line -* **productName**: string: Represents product name that uniquely identifies product +* **resourceProviderNamespace**: string (ReadOnly): Resource provider namespace ## ReverseShippingDetails ### Properties @@ -184,8 +146,46 @@ * **trackingId**: string (ReadOnly): TrackingId of the package * **trackingUrl**: string (ReadOnly): TrackingUrl of the package. +## ShippingAddress +### Properties +* **addressType**: 'Commercial' | 'None' | 'Residential' | string: Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string: Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. + +## StageDetails +### Properties +* **displayName**: string (ReadOnly): Display name of the resource stage. +* **stageName**: 'Cancelled' | 'Confirmed' | 'Delivered' | 'InReview' | 'InUse' | 'Placed' | 'ReadyToShip' | 'ReturnCompleted' | 'ReturnInitiated' | 'ReturnPickedUp' | 'ReturnedToMicrosoft' | 'Shipped' | string (ReadOnly): Stage name +* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | string (ReadOnly): Stage status. +* **startTime**: string (ReadOnly): Stage start time + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TransportPreferences +### Properties +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' | string (Required): Indicates Shipment Logistics type that the customer preferred. + diff --git a/generated/edgeorder/microsoft.edgeorder/2021-12-01/types.md b/generated/edgeorder/microsoft.edgeorder/2021-12-01/types.md index d7883a2730..68f9a665da 100644 --- a/generated/edgeorder/microsoft.edgeorder/2021-12-01/types.md +++ b/generated/edgeorder/microsoft.edgeorder/2021-12-01/types.md @@ -24,6 +24,11 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.EdgeOrder/orderItems' (ReadOnly, DeployTimeConstant): The resource type +## AddressDetails +### Properties +* **forwardAddress**: [AddressProperties](#addressproperties) (Required): Address Properties +* **returnAddress**: [AddressProperties](#addressproperties) (ReadOnly): Address Properties + ## AddressProperties ### Properties * **addressValidationStatus**: 'Ambiguous' | 'Invalid' | 'Valid' | string (ReadOnly): Status of address validation @@ -38,44 +43,56 @@ * **phone**: string (Required): Phone number of the contact person. * **phoneExtension**: string: Phone extension number of the contact person. -## ShippingAddress +## DeviceDetails ### Properties -* **addressType**: 'Commercial' | 'None' | 'Residential' | string: Type of address. -* **city**: string: Name of the City. -* **companyName**: string: Name of the company. -* **country**: string (Required): Name of the Country. -* **postalCode**: string: Postal code. -* **stateOrProvince**: string: Name of the State or Province. -* **streetAddress1**: string (Required): Street Address line 1. -* **streetAddress2**: string: Street Address line 2. -* **streetAddress3**: string: Street Address line 3. -* **zipExtendedCode**: string: Extended Zip Code. +* **managementResourceId**: string (ReadOnly): Management Resource Id +* **managementResourceTenantId**: string (ReadOnly): Management Resource Tenant ID +* **serialNumber**: string (ReadOnly): device serial number -## SystemData +## DisplayInfo ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **configurationDisplayName**: string (ReadOnly): Configuration display name +* **productFamilyDisplayName**: string (ReadOnly): Product family display name -## TrackedResourceTags +## EncryptionPreferences ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **doubleEncryptionStatus**: 'Disabled' | 'Enabled' | string: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. -## OrderItemProperties +## ErrorAdditionalInfo ### Properties -* **addressDetails**: [AddressDetails](#addressdetails) (Required): Address details for an order item. -* **orderId**: string (Required): Id of the order to which order item belongs to -* **orderItemDetails**: [OrderItemDetails](#orderitemdetails) (Required): Order item details -* **startTime**: string (ReadOnly): Start time of order item +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. -## AddressDetails +## ErrorDetail ### Properties -* **forwardAddress**: [AddressProperties](#addressproperties) (Required): Address Properties -* **returnAddress**: [AddressProperties](#addressproperties) (ReadOnly): Address Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. + +## ForwardShippingDetails +### Properties +* **carrierDisplayName**: string (ReadOnly): Carrier Name for display purpose. Not to be used for any processing. +* **carrierName**: string (ReadOnly): Name of the carrier. +* **trackingId**: string (ReadOnly): TrackingId of the package +* **trackingUrl**: string (ReadOnly): TrackingUrl of the package. + +## HierarchyInformation +### Properties +* **configurationName**: string: Represents configuration name that uniquely identifies configuration +* **productFamilyName**: string: Represents product family name that uniquely identifies product family +* **productLineName**: string: Represents product line name that uniquely identifies product line +* **productName**: string: Represents product name that uniquely identifies product + +## ManagementResourcePreferences +### Properties +* **preferredManagementResourceId**: string: Customer preferred Management resource ARM ID + +## NotificationPreference +### Properties +* **sendNotification**: bool (Required): Notification is required or not. +* **stageName**: 'Delivered' | 'Shipped' | string (Required): Name of the stage. ## OrderItemDetails ### Properties @@ -96,36 +113,12 @@ * **returnStatus**: 'NotReturnable' | 'Returnable' | 'ReturnableWithFee' | string (ReadOnly): Describes whether the order item is returnable or not. * **reverseShippingDetails**: [ReverseShippingDetails](#reverseshippingdetails) (ReadOnly): Reverse shipment details. -## StageDetails -### Properties -* **displayName**: string (ReadOnly): Display name of the resource stage. -* **stageName**: 'Cancelled' | 'Confirmed' | 'Delivered' | 'InReview' | 'InUse' | 'Placed' | 'ReadyToShip' | 'ReturnCompleted' | 'ReturnInitiated' | 'ReturnPickedUp' | 'ReturnedToMicrosoft' | 'Shipped' | string (ReadOnly): Stage name -* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | string (ReadOnly): Stage status. -* **startTime**: string (ReadOnly): Stage start time - -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## ForwardShippingDetails -### Properties -* **carrierDisplayName**: string (ReadOnly): Carrier Name for display purpose. Not to be used for any processing. -* **carrierName**: string (ReadOnly): Name of the carrier. -* **trackingId**: string (ReadOnly): TrackingId of the package -* **trackingUrl**: string (ReadOnly): TrackingUrl of the package. - -## ResourceProviderDetails +## OrderItemProperties ### Properties -* **resourceProviderNamespace**: string (ReadOnly): Resource provider namespace +* **addressDetails**: [AddressDetails](#addressdetails) (Required): Address details for an order item. +* **orderId**: string (Required): Id of the order to which order item belongs to +* **orderItemDetails**: [OrderItemDetails](#orderitemdetails) (Required): Order item details +* **startTime**: string (ReadOnly): Start time of order item ## Preferences ### Properties @@ -134,23 +127,6 @@ * **notificationPreferences**: [NotificationPreference](#notificationpreference)[]: Notification preferences. * **transportPreferences**: [TransportPreferences](#transportpreferences): Preferences related to the shipment logistics of the sku -## EncryptionPreferences -### Properties -* **doubleEncryptionStatus**: 'Disabled' | 'Enabled' | string: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. - -## ManagementResourcePreferences -### Properties -* **preferredManagementResourceId**: string: Customer preferred Management resource ARM ID - -## NotificationPreference -### Properties -* **sendNotification**: bool (Required): Notification is required or not. -* **stageName**: 'Delivered' | 'Shipped' | string (Required): Name of the stage. - -## TransportPreferences -### Properties -* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' | string (Required): Indicates Shipment Logistics type that the customer preferred. - ## ProductDetails ### Properties * **count**: int (ReadOnly): Quantity of the product @@ -159,23 +135,9 @@ * **hierarchyInformation**: [HierarchyInformation](#hierarchyinformation) (Required): Holds details about product hierarchy information * **productDoubleEncryptionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. -## DeviceDetails -### Properties -* **managementResourceId**: string (ReadOnly): Management Resource Id -* **managementResourceTenantId**: string (ReadOnly): Management Resource Tenant ID -* **serialNumber**: string (ReadOnly): device serial number - -## DisplayInfo -### Properties -* **configurationDisplayName**: string (ReadOnly): Configuration display name -* **productFamilyDisplayName**: string (ReadOnly): Product family display name - -## HierarchyInformation +## ResourceProviderDetails ### Properties -* **configurationName**: string: Represents configuration name that uniquely identifies configuration -* **productFamilyName**: string: Represents product family name that uniquely identifies product family -* **productLineName**: string: Represents product line name that uniquely identifies product line -* **productName**: string: Represents product name that uniquely identifies product +* **resourceProviderNamespace**: string (ReadOnly): Resource provider namespace ## ReverseShippingDetails ### Properties @@ -185,8 +147,46 @@ * **trackingId**: string (ReadOnly): TrackingId of the package * **trackingUrl**: string (ReadOnly): TrackingUrl of the package. +## ShippingAddress +### Properties +* **addressType**: 'Commercial' | 'None' | 'Residential' | string: Type of address. +* **city**: string: Name of the City. +* **companyName**: string: Name of the company. +* **country**: string (Required): Name of the Country. +* **postalCode**: string: Postal code. +* **stateOrProvince**: string: Name of the State or Province. +* **streetAddress1**: string (Required): Street Address line 1. +* **streetAddress2**: string: Street Address line 2. +* **streetAddress3**: string: Street Address line 3. +* **zipExtendedCode**: string: Extended Zip Code. + +## StageDetails +### Properties +* **displayName**: string (ReadOnly): Display name of the resource stage. +* **stageName**: 'Cancelled' | 'Confirmed' | 'Delivered' | 'InReview' | 'InUse' | 'Placed' | 'ReadyToShip' | 'ReturnCompleted' | 'ReturnInitiated' | 'ReturnPickedUp' | 'ReturnedToMicrosoft' | 'Shipped' | string (ReadOnly): Stage name +* **stageStatus**: 'Cancelled' | 'Cancelling' | 'Failed' | 'InProgress' | 'None' | 'Succeeded' | string (ReadOnly): Stage status. +* **startTime**: string (ReadOnly): Stage start time + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TransportPreferences +### Properties +* **preferredShipmentType**: 'CustomerManaged' | 'MicrosoftManaged' | string (Required): Indicates Shipment Logistics type that the customer preferred. + diff --git a/generated/edgeorderpartner/log.out b/generated/edgeorderpartner/log.out index 2ee60c5193..9830d6e7ab 100644 --- a/generated/edgeorderpartner/log.out +++ b/generated/edgeorderpartner/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.edgeorderpartner-2020-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 4.61s. 0 files generated. +info | Autorest completed in 4.35s. 0 files generated. diff --git a/generated/education/log.out b/generated/education/log.out index cba48efd23..19bfc606b9 100644 --- a/generated/education/log.out +++ b/generated/education/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.education-2021-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms -info | Autorest completed in 5.21s. 2 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 4.82s. 2 files generated. diff --git a/generated/education/microsoft.education/2021-12-01-preview/types.md b/generated/education/microsoft.education/2021-12-01-preview/types.md index 29e6245341..b98dff5989 100644 --- a/generated/education/microsoft.education/2021-12-01-preview/types.md +++ b/generated/education/microsoft.education/2021-12-01-preview/types.md @@ -20,6 +20,11 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Education/labs/students' (ReadOnly, DeployTimeConstant): The resource type +## Amount +### Properties +* **currency**: string: The type of currency being used for the value. +* **value**: int: Amount value. + ## LabProperties ### Properties * **budgetPerStudent**: [Amount](#amount) (Required): The amount. @@ -33,20 +38,6 @@ * **totalAllocatedBudget**: [Amount](#amount) (ReadOnly): The amount. * **totalBudget**: [Amount](#amount) (ReadOnly): The amount. -## Amount -### Properties -* **currency**: string: The type of currency being used for the value. -* **value**: int: Amount value. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## StudentProperties ### Properties * **budget**: [Amount](#amount) (Required): The amount. @@ -61,3 +52,12 @@ * **subscriptionId**: string (ReadOnly): Subscription Id * **subscriptionInviteLastSentDate**: string: subscription invite last sent date +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/elastic/log.out b/generated/elastic/log.out index 3932d8ff1a..52aa590b75 100644 --- a/generated/elastic/log.out +++ b/generated/elastic/log.out @@ -3,29 +3,29 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.elastic-2021-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.elastic-2021-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.elastic-2020-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.elastic-2020-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 10.78s. 8 files generated. +info | Autorest completed in 10.32s. 8 files generated. diff --git a/generated/elastic/microsoft.elastic/2020-07-01-preview/types.md b/generated/elastic/microsoft.elastic/2020-07-01-preview/types.md index 1f04c09083..173f3adf40 100644 --- a/generated/elastic/microsoft.elastic/2020-07-01-preview/types.md +++ b/generated/elastic/microsoft.elastic/2020-07-01-preview/types.md @@ -39,25 +39,20 @@ * **ApiVersion**: 2020-07-01-preview * **Output**: [VMHostListResponse](#vmhostlistresponse) -## IdentityProperties -### Properties -* **principalId**: string (ReadOnly): The identity ID. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' | string: Managed Identity types. - -## MonitorProperties +## CompanyInfo ### Properties -* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. -* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. +* **business**: string: Business of the company +* **country**: string: Country of the company location. +* **domain**: string: Domain of the company +* **employeesNumber**: string: Number of employees in the company +* **state**: string: State of the company location. -## ElasticProperties +## DeploymentInfoResponse ### Properties -* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. -* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. +* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. +* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. +* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. +* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. ## ElasticCloudDeployment ### Properties @@ -75,44 +70,27 @@ * **emailAddress**: string (ReadOnly): Email of the Elastic User Account. * **id**: string (ReadOnly): User Id of the elastic account of the User. -## UserInfo -### Properties -* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. -* **companyName**: string: Company name of the user -* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed -* **firstName**: string: First name of the user -* **lastName**: string: Last name of the user - -## CompanyInfo -### Properties -* **business**: string: Business of the company -* **country**: string: Country of the company location. -* **domain**: string: Domain of the company -* **employeesNumber**: string: Number of employees in the company -* **state**: string: State of the company location. - -## ResourceSku +## ElasticMonitorResourceTags ### Properties -* **name**: string (Required): Name of the SKU. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## ElasticProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. +* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. -## ElasticMonitorResourceTags +## FilteringTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. -## MonitoringTagRulesProperties +## IdentityProperties ### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **principalId**: string (ReadOnly): The identity ID. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' | string: Managed Identity types. ## LogRules ### Properties @@ -121,29 +99,51 @@ * **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. * **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. -## FilteringTag -### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. - -## DeploymentInfoResponse +## MonitoredResource ### Properties -* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. -* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. -* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. -* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. +* **id**: string (ReadOnly): The ARM id of the resource. +* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). +* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. ## MonitoredResourceListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## MonitoredResource +## MonitoringTagRulesProperties ### Properties -* **id**: string (ReadOnly): The ARM id of the resource. -* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). -* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. + +## MonitorProperties +### Properties +* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. + +## ResourceSku +### Properties +* **name**: string (Required): Name of the SKU. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserInfo +### Properties +* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. +* **companyName**: string: Company name of the user +* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed +* **firstName**: string: First name of the user +* **lastName**: string: Last name of the user ## VMHostListResponse ### Properties diff --git a/generated/elastic/microsoft.elastic/2020-07-01/types.md b/generated/elastic/microsoft.elastic/2020-07-01/types.md index d0e2f5f700..5adbe185bb 100644 --- a/generated/elastic/microsoft.elastic/2020-07-01/types.md +++ b/generated/elastic/microsoft.elastic/2020-07-01/types.md @@ -39,25 +39,20 @@ * **ApiVersion**: 2020-07-01 * **Output**: [VMHostListResponse](#vmhostlistresponse) -## IdentityProperties -### Properties -* **principalId**: string (ReadOnly): The identity ID. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' | string: Managed Identity types. - -## MonitorProperties +## CompanyInfo ### Properties -* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. -* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. +* **business**: string: Business of the company +* **country**: string: Country of the company location. +* **domain**: string: Domain of the company +* **employeesNumber**: string: Number of employees in the company +* **state**: string: State of the company location. -## ElasticProperties +## DeploymentInfoResponse ### Properties -* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. -* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. +* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. +* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. +* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. +* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. ## ElasticCloudDeployment ### Properties @@ -75,44 +70,27 @@ * **emailAddress**: string (ReadOnly): Email of the Elastic User Account. * **id**: string (ReadOnly): User Id of the elastic account of the User. -## UserInfo -### Properties -* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. -* **companyName**: string: Company name of the user -* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed -* **firstName**: string: First name of the user -* **lastName**: string: Last name of the user - -## CompanyInfo -### Properties -* **business**: string: Business of the company -* **country**: string: Country of the company location. -* **domain**: string: Domain of the company -* **employeesNumber**: string: Number of employees in the company -* **state**: string: State of the company location. - -## ResourceSku +## ElasticMonitorResourceTags ### Properties -* **name**: string (Required): Name of the SKU. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## ElasticProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. +* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. -## ElasticMonitorResourceTags +## FilteringTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. -## MonitoringTagRulesProperties +## IdentityProperties ### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **principalId**: string (ReadOnly): The identity ID. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' | string: Managed Identity types. ## LogRules ### Properties @@ -121,29 +99,51 @@ * **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. * **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. -## FilteringTag -### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. - -## DeploymentInfoResponse +## MonitoredResource ### Properties -* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. -* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. -* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. -* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. +* **id**: string (ReadOnly): The ARM id of the resource. +* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). +* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. ## MonitoredResourceListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## MonitoredResource +## MonitoringTagRulesProperties ### Properties -* **id**: string (ReadOnly): The ARM id of the resource. -* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). -* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. + +## MonitorProperties +### Properties +* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. + +## ResourceSku +### Properties +* **name**: string (Required): Name of the SKU. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserInfo +### Properties +* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. +* **companyName**: string: Company name of the user +* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed +* **firstName**: string: First name of the user +* **lastName**: string: Last name of the user ## VMHostListResponse ### Properties diff --git a/generated/elastic/microsoft.elastic/2021-09-01-preview/types.md b/generated/elastic/microsoft.elastic/2021-09-01-preview/types.md index 3cf77cb22d..bcdc01034b 100644 --- a/generated/elastic/microsoft.elastic/2021-09-01-preview/types.md +++ b/generated/elastic/microsoft.elastic/2021-09-01-preview/types.md @@ -39,25 +39,20 @@ * **ApiVersion**: 2021-09-01-preview * **Output**: [VMHostListResponse](#vmhostlistresponse) -## IdentityProperties -### Properties -* **principalId**: string (ReadOnly): The identity ID. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' | string: Managed Identity types. - -## MonitorProperties +## CompanyInfo ### Properties -* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. -* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. +* **business**: string: Business of the company +* **country**: string: Country of the company location. +* **domain**: string: Domain of the company +* **employeesNumber**: string: Number of employees in the company +* **state**: string: State of the company location. -## ElasticProperties +## DeploymentInfoResponse ### Properties -* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. -* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. +* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. +* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. +* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. +* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. ## ElasticCloudDeployment ### Properties @@ -75,44 +70,27 @@ * **emailAddress**: string (ReadOnly): Email of the Elastic User Account. * **id**: string (ReadOnly): User Id of the elastic account of the User. -## UserInfo -### Properties -* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. -* **companyName**: string: Company name of the user -* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed -* **firstName**: string: First name of the user -* **lastName**: string: Last name of the user - -## CompanyInfo -### Properties -* **business**: string: Business of the company -* **country**: string: Country of the company location. -* **domain**: string: Domain of the company -* **employeesNumber**: string: Number of employees in the company -* **state**: string: State of the company location. - -## ResourceSku +## ElasticMonitorResourceTags ### Properties -* **name**: string (Required): Name of the SKU. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## ElasticProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. +* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. -## ElasticMonitorResourceTags +## FilteringTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. -## MonitoringTagRulesProperties +## IdentityProperties ### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **principalId**: string (ReadOnly): The identity ID. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' | string: Managed Identity types. ## LogRules ### Properties @@ -121,29 +99,51 @@ * **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. * **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. -## FilteringTag -### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. - -## DeploymentInfoResponse +## MonitoredResource ### Properties -* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. -* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. -* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. -* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. +* **id**: string (ReadOnly): The ARM id of the resource. +* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). +* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. ## MonitoredResourceListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## MonitoredResource +## MonitoringTagRulesProperties ### Properties -* **id**: string (ReadOnly): The ARM id of the resource. -* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). -* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. + +## MonitorProperties +### Properties +* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. + +## ResourceSku +### Properties +* **name**: string (Required): Name of the SKU. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserInfo +### Properties +* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. +* **companyName**: string: Company name of the user +* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed +* **firstName**: string: First name of the user +* **lastName**: string: Last name of the user ## VMHostListResponse ### Properties diff --git a/generated/elastic/microsoft.elastic/2021-10-01-preview/types.md b/generated/elastic/microsoft.elastic/2021-10-01-preview/types.md index f54a1d7999..0ab0779895 100644 --- a/generated/elastic/microsoft.elastic/2021-10-01-preview/types.md +++ b/generated/elastic/microsoft.elastic/2021-10-01-preview/types.md @@ -44,26 +44,20 @@ * **ApiVersion**: 2021-10-01-preview * **Output**: [VMHostListResponse](#vmhostlistresponse) -## IdentityProperties -### Properties -* **principalId**: string (ReadOnly): The identity ID. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' | string: Managed Identity types. - -## MonitorProperties +## CompanyInfo ### Properties -* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. -* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. -* **version**: string: Version of elastic of the monitor resource +* **business**: string: Business of the company +* **country**: string: Country of the company location. +* **domain**: string: Domain of the company +* **employeesNumber**: string: Number of employees in the company +* **state**: string: State of the company location. -## ElasticProperties +## DeploymentInfoResponse ### Properties -* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. -* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. +* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. +* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. +* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. +* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. ## ElasticCloudDeployment ### Properties @@ -81,44 +75,27 @@ * **emailAddress**: string (ReadOnly): Email of the Elastic User Account. * **id**: string (ReadOnly): User Id of the elastic account of the User. -## UserInfo -### Properties -* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. -* **companyName**: string: Company name of the user -* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed -* **firstName**: string: First name of the user -* **lastName**: string: Last name of the user - -## CompanyInfo -### Properties -* **business**: string: Business of the company -* **country**: string: Country of the company location. -* **domain**: string: Domain of the company -* **employeesNumber**: string: Number of employees in the company -* **state**: string: State of the company location. - -## ResourceSku +## ElasticMonitorResourceTags ### Properties -* **name**: string (Required): Name of the SKU. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## ElasticProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **elasticCloudDeployment**: [ElasticCloudDeployment](#elasticclouddeployment): Details of the user's elastic deployment associated with the monitor resource. +* **elasticCloudUser**: [ElasticCloudUser](#elasticclouduser): Details of the user's elastic account. -## ElasticMonitorResourceTags +## FilteringTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. -## MonitoringTagRulesProperties +## IdentityProperties ### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **principalId**: string (ReadOnly): The identity ID. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' | string: Managed Identity types. ## LogRules ### Properties @@ -127,35 +104,58 @@ * **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. * **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. -## FilteringTag -### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. - -## DeploymentInfoResponse +## MonitoredResource ### Properties -* **diskCapacity**: string (ReadOnly): Disk capacity of the elasticsearch in Elastic cloud deployment. -* **memoryCapacity**: string (ReadOnly): RAM capacity of the elasticsearch in Elastic cloud deployment. -* **status**: 'Healthy' | 'Unhealthy' | string (ReadOnly): Flag specifying if the Elastic deployment status is healthy or not. -* **version**: string (ReadOnly): Version of the elasticsearch in Elastic cloud deployment. +* **id**: string (ReadOnly): The ARM id of the resource. +* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). +* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. ## MonitoredResourceListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## MonitoredResource +## MonitoringTagRulesProperties ### Properties -* **id**: string (ReadOnly): The ARM id of the resource. -* **reasonForLogsStatus**: string (ReadOnly): Reason for why the resource is sending logs (or why it is not sending). -* **sendingLogs**: 'False' | 'True' | string (ReadOnly): Flag indicating the status of the resource for sending logs operation to Elastic. +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. + +## MonitorProperties +### Properties +* **elasticProperties**: [ElasticProperties](#elasticproperties): Elastic Resource Properties. +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string: Provisioning state of Elastic resource. +* **userInfo**: [UserInfo](#userinfo) (WriteOnly): User Information to be passed to partners. +* **version**: string: Version of elastic of the monitor resource + +## ResourceSku +### Properties +* **name**: string (Required): Name of the SKU. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## UpgradableVersionsList ### Properties * **currentVersion**: string (ReadOnly): Current version of the elastic monitor * **upgradableVersions**: string[] (ReadOnly): Stack Versions that this version can upgrade to +## UserInfo +### Properties +* **companyInfo**: [CompanyInfo](#companyinfo): Company information of the user to be passed to partners. +* **companyName**: string: Company name of the user +* **emailAddress**: string: Email of the user used by Elastic for contacting them if needed +* **firstName**: string: First name of the user +* **lastName**: string: Last name of the user + ## VMHostListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next Vm resource Id, if any. diff --git a/generated/elasticsan/log.out b/generated/elasticsan/log.out index 9e2b60f3d8..f7eab69ae4 100644 --- a/generated/elasticsan/log.out +++ b/generated/elasticsan/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.elasticsan-2021-11-20-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 12ms -info | Autorest completed in 5.34s. 2 files generated. +info | Autorest completed in 5.08s. 2 files generated. diff --git a/generated/elasticsan/microsoft.elasticsan/2021-11-20-preview/types.md b/generated/elasticsan/microsoft.elasticsan/2021-11-20-preview/types.md index ae66ff3507..1ec7ff8644 100644 --- a/generated/elasticsan/microsoft.elasticsan/2021-11-20-preview/types.md +++ b/generated/elasticsan/microsoft.elasticsan/2021-11-20-preview/types.md @@ -49,11 +49,43 @@ * **totalVolumeSizeGiB**: int (ReadOnly): Total size of the provisioned Volumes in GiB. * **volumeGroupCount**: int (ReadOnly): Total number of volume groups in this Elastic San appliance. +## IscsiTargetInfo +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the iSCSI Target. +* **status**: 'Healthy' | 'Invalid' | 'Running' | 'Stopped (deallocated)' | 'Stopped' | 'Unhealthy' | 'Unknown' | 'Updating' | string: Operational status of the resource. +* **targetIqn**: string (ReadOnly): iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". +* **targetPortalHostname**: string (ReadOnly): iSCSI Target Portal Host Name +* **targetPortalPort**: int (ReadOnly): iSCSI Target Portal Port + +## NetworkRuleSet +### Properties +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Sku ### Properties * **name**: 'Premium_LRS' | 'Standard_LRS' | 'Standard_ZRS' | string: The sku name. * **tier**: 'Hero' | 'Hub' | 'Satellite' | string: The sku tier. +## SourceCreationData +### Properties +* **createSource**: 'Export' | 'FromDiskSnapshot' | 'FromVolume' | 'None' (Required): This enumerates the possible sources of a volume creation. +* **sourceUri**: 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. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -63,10 +95,11 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags +## VirtualNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded' (ReadOnly): Gets the state of virtual network rule. ## VolumeGroupProperties ### Properties @@ -75,21 +108,6 @@ * **protocolType**: 'Iscsi' | 'None' | string (Required): Storage Target type. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the iSCSI Target. -## NetworkRuleSet -### Properties -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded' (ReadOnly): Gets the state of virtual network rule. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## VolumeProperties ### Properties * **creationData**: [SourceCreationData](#sourcecreationdata): Data used when creating a disk. @@ -97,21 +115,3 @@ * **storageTarget**: [IscsiTargetInfo](#iscsitargetinfo) (ReadOnly): Iscsi target information * **volumeId**: string (ReadOnly): Unique Id of the volume in GUID format -## SourceCreationData -### Properties -* **createSource**: 'Export' | 'FromDiskSnapshot' | 'FromVolume' | 'None' (Required): This enumerates the possible sources of a volume creation. -* **sourceUri**: 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. - -## IscsiTargetInfo -### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the iSCSI Target. -* **status**: 'Healthy' | 'Invalid' | 'Running' | 'Stopped (deallocated)' | 'Stopped' | 'Unhealthy' | 'Unknown' | 'Updating' | string: Operational status of the resource. -* **targetIqn**: string (ReadOnly): iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". -* **targetPortalHostname**: string (ReadOnly): iSCSI Target Portal Host Name -* **targetPortalPort**: int (ReadOnly): iSCSI Target Portal Port - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/engagementfabric/log.out b/generated/engagementfabric/log.out index 31ce858eb2..e4d90b63a7 100644 --- a/generated/engagementfabric/log.out +++ b/generated/engagementfabric/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.engagementfabric-2018-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms -info | Autorest completed in 4.95s. 2 files generated. +info | autorest.bicep took 11ms +info | Autorest completed in 4.67s. 2 files generated. diff --git a/generated/engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.md b/generated/engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.md index fb361b939b..18a25e39af 100644 --- a/generated/engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.md +++ b/generated/engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.md @@ -30,16 +30,6 @@ * **ApiVersion**: 2018-09-01-preview * **Output**: [KeyDescriptionList](#keydescriptionlist) -## SKU -### Properties -* **name**: string (Required): The name of the SKU -* **tier**: string: The price tier of the SKU - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ChannelProperties ### Properties * **channelFunctions**: string[]: The functions to be enabled for the channel @@ -51,19 +41,15 @@ ### Additional Properties * **Additional Properties Type**: string -## ChannelTypeDescriptionList -### Properties -* **value**: [ChannelTypeDescription](#channeltypedescription)[] (ReadOnly): Channel descriptions - ## ChannelTypeDescription ### Properties * **channelDescription**: string (ReadOnly): Text description for the channel * **channelFunctions**: string[] (ReadOnly): All the available functions for the channel * **channelType**: string (ReadOnly): Channel type -## KeyDescriptionList +## ChannelTypeDescriptionList ### Properties -* **value**: [KeyDescription](#keydescription)[] (ReadOnly): Account keys +* **value**: [ChannelTypeDescription](#channeltypedescription)[] (ReadOnly): Channel descriptions ## KeyDescription ### Properties @@ -71,3 +57,17 @@ * **rank**: 'PrimaryKey' | 'SecondaryKey' | string (ReadOnly): The rank of the EngagementFabric account key * **value**: string (ReadOnly): The value of the key +## KeyDescriptionList +### Properties +* **value**: [KeyDescription](#keydescription)[] (ReadOnly): Account keys + +## SKU +### Properties +* **name**: string (Required): The name of the SKU +* **tier**: string: The price tier of the SKU + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/enterpriseknowledgegraph/log.out b/generated/enterpriseknowledgegraph/log.out index d96b042ab8..383711e926 100644 --- a/generated/enterpriseknowledgegraph/log.out +++ b/generated/enterpriseknowledgegraph/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.enterpriseknowledgegraph-2018-12-03"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json:337:5 @@ -24,5 +24,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorBody' with an undefined - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json:460:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 9ms -info | Autorest completed in 4.44s. 2 files generated. +info | autorest.bicep took 8ms +info | Autorest completed in 4.29s. 2 files generated. diff --git a/generated/enterpriseknowledgegraph/microsoft.enterpriseknowledgegraph/2018-12-03/types.md b/generated/enterpriseknowledgegraph/microsoft.enterpriseknowledgegraph/2018-12-03/types.md index 6a27057a1d..1eb7914b0b 100644 --- a/generated/enterpriseknowledgegraph/microsoft.enterpriseknowledgegraph/2018-12-03/types.md +++ b/generated/enterpriseknowledgegraph/microsoft.enterpriseknowledgegraph/2018-12-03/types.md @@ -18,12 +18,12 @@ * **metadata**: any: Any object * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string: The state of EnterpriseKnowledgeGraph provisioning -## Sku -### Properties -* **name**: 'F0' | 'S1' | string (Required): The name of SKU. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **name**: 'F0' | 'S1' | string (Required): The name of SKU. + diff --git a/generated/eventgrid/log.out b/generated/eventgrid/log.out index 861d66d557..2f553c988a 100644 --- a/generated/eventgrid/log.out +++ b/generated/eventgrid/log.out @@ -7,37 +7,37 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.eventgrid-2021-10-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'WebhookPartnerDestinationInfo' has a property 'resourceMoveChangeHistory' that is already declared the parent schema 'PartnerDestinationInfo' but isn't significantly different. The property has been removed from WebhookPartnerDestinationInfo info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 27ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.eventgrid-2021-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 7ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.eventgrid-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. @@ -48,62 +48,62 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 18ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.eventgrid-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 7ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.eventgrid-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 10ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.eventgrid-2020-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 9ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.eventgrid-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.eventgrid-2019-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.eventgrid/domains/topics under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}' has no body defined. @@ -114,17 +114,17 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.eventgrid-2018-09-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms @@ -134,7 +134,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms @@ -144,7 +144,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms @@ -154,18 +154,18 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.eventgrid-2017-06-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 57.01s. 30 files generated. +info | Autorest completed in 55.11s. 30 files generated. diff --git a/generated/eventgrid/microsoft.eventgrid/2017-06-15-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2017-06-15-preview/types.md index 285ffc5dbc..8e90420c6a 100644 --- a/generated/eventgrid/microsoft.eventgrid/2017-06-15-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2017-06-15-preview/types.md @@ -25,14 +25,6 @@ * **ApiVersion**: 2017-06-15-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## EventSubscriptionProperties -### Properties -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. - ## EventSubscriptionDestination ### Properties * **endpointType**: 'WebHook' | string: Type of the endpoint for the event subscription destination @@ -55,18 +47,26 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. +## EventSubscriptionProperties +### Properties +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TopicSharedAccessKeys ### Properties * **key1**: string (ReadOnly): Shared access key1 for the topic. * **key2**: string (ReadOnly): Shared access key2 for the topic. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/eventgrid/microsoft.eventgrid/2017-09-15-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2017-09-15-preview/types.md index 198b39b4c2..466628ce8e 100644 --- a/generated/eventgrid/microsoft.eventgrid/2017-09-15-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2017-09-15-preview/types.md @@ -25,13 +25,9 @@ * **ApiVersion**: 2017-09-15-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## EventSubscriptionProperties +## EventHubEventSubscriptionDestinationProperties ### Properties -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -48,15 +44,6 @@ * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - ## EventSubscriptionFilter ### Properties * **includedEventTypes**: string[]: A list of applicable event types that need to be part of the event subscription. @@ -69,18 +56,31 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. +## EventSubscriptionProperties +### Properties +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. diff --git a/generated/eventgrid/microsoft.eventgrid/2018-01-01/types.md b/generated/eventgrid/microsoft.eventgrid/2018-01-01/types.md index 81d746526c..5614ff6737 100644 --- a/generated/eventgrid/microsoft.eventgrid/2018-01-01/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2018-01-01/types.md @@ -25,13 +25,9 @@ * **ApiVersion**: 2018-01-01 * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## EventSubscriptionProperties +## EventHubEventSubscriptionDestinationProperties ### Properties -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -48,15 +44,6 @@ * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - ## EventSubscriptionFilter ### Properties * **includedEventTypes**: string[]: A list of applicable event types that need to be part of the event subscription. @@ -69,18 +56,31 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. +## EventSubscriptionProperties +### Properties +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. diff --git a/generated/eventgrid/microsoft.eventgrid/2018-05-01-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2018-05-01-preview/types.md index ca26b3ab5c..82bcdae898 100644 --- a/generated/eventgrid/microsoft.eventgrid/2018-05-01-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2018-05-01-preview/types.md @@ -25,17 +25,6 @@ * **ApiVersion**: 2018-05-01-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **eventDeliverySchema**: 'CloudEventV01Schema' | 'EventGridSchema' | 'InputEventSchema' | string: The event delivery schema for the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription -* **topic**: string (ReadOnly): Name of the topic of the event subscription. - ## DeadLetterDestination * **Discriminator**: endpointType @@ -46,10 +35,9 @@ * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties +## EventHubEventSubscriptionDestinationProperties ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -76,24 +64,6 @@ * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - ## EventSubscriptionFilter ### Properties * **includedEventTypes**: string[]: A list of applicable event types that need to be part of the event subscription. @@ -106,17 +76,20 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## RetryPolicy +## EventSubscriptionProperties ### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **eventDeliverySchema**: 'CloudEventV01Schema' | 'EventGridSchema' | 'InputEventSchema' | string: The event delivery schema for the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -## TopicProperties +## HybridConnectionEventSubscriptionDestinationProperties ### Properties -* **endpoint**: string (ReadOnly): Endpoint for the topic. -* **inputSchema**: 'CloudEventV01Schema' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the topic. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. ## InputSchemaMapping * **Discriminator**: inputSchemaMappingType @@ -128,6 +101,15 @@ Wildcard characters are not supported in this path. * **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. + +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. + ## JsonInputSchemaMappingProperties ### Properties * **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. @@ -137,22 +119,40 @@ Wildcard characters are not supported in this path. * **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. * **topic**: [JsonField](#jsonfield): 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. -## JsonFieldWithDefault +## RetryPolicy ### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. -## JsonField +## StorageBlobDeadLetterDestinationProperties ### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events -## TrackedResourceTags +## StorageQueueEventSubscriptionDestinationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + +## TopicProperties +### Properties +* **endpoint**: string (ReadOnly): Endpoint for the topic. +* **inputSchema**: 'CloudEventV01Schema' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the topic. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. ## TopicSharedAccessKeys ### Properties * **key1**: string (ReadOnly): Shared access key1 for the topic. * **key2**: string (ReadOnly): Shared access key2 for the topic. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## WebHookEventSubscriptionDestinationProperties +### Properties +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. + diff --git a/generated/eventgrid/microsoft.eventgrid/2018-09-15-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2018-09-15-preview/types.md index c55b934447..a7db8c83a0 100644 --- a/generated/eventgrid/microsoft.eventgrid/2018-09-15-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2018-09-15-preview/types.md @@ -41,57 +41,71 @@ * **ApiVersion**: 2018-09-15-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inputSchema**: 'CloudEventV01Schema' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. - -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +## AdvancedFilter +* **Discriminator**: operatorType ### Base Properties -### JsonInputSchemaMapping +* **key**: string: The filter key. Represents an event property with up to two levels of nesting. +### BoolEqualsAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'BoolEquals' (Required): Represents the filter operator +* **value**: bool: The filter value +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): Represents the filter operator +* **value**: int: The filter value -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): Represents the filter operator +* **value**: int: The filter value -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): Represents the filter operator +* **values**: int[]: The set of filter values -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): Represents the filter operator +* **value**: int: The filter value -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): Represents the filter operator +* **value**: int: The filter value + +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): Represents the filter operator +* **values**: int[]: The set of filter values + +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): Represents the filter operator +* **values**: string[]: The set of filter values + +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): Represents the filter operator +* **values**: string[]: The set of filter values + +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): Represents the filter operator +* **values**: string[]: The set of filter values + +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): Represents the filter operator +* **values**: string[]: The set of filter values + +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): Represents the filter operator +* **values**: string[]: The set of filter values -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **eventDeliverySchema**: 'CloudEventV01Schema' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription -* **topic**: string (ReadOnly): Name of the topic of the event subscription. ## DeadLetterDestination * **Discriminator**: endpointType @@ -103,10 +117,21 @@ * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties +## DomainProperties ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inputSchema**: 'CloudEventV01Schema' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -133,24 +158,6 @@ * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - ## EventSubscriptionFilter ### Properties * **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: A list of advanced filters. @@ -164,77 +171,65 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The filter key. Represents an event property with up to two levels of nesting. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): Represents the filter operator -* **value**: bool: The filter value - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): Represents the filter operator -* **value**: int: The filter value - -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): Represents the filter operator -* **value**: int: The filter value - -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): Represents the filter operator -* **values**: int[]: The set of filter values - -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): Represents the filter operator -* **value**: int: The filter value - -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): Represents the filter operator -* **value**: int: The filter value +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **eventDeliverySchema**: 'CloudEventV01Schema' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): Represents the filter operator -* **values**: int[]: The set of filter values +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): Represents the filter operator -* **values**: string[]: The set of filter values +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### StringContainsAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'StringContains' (Required): Represents the filter operator -* **values**: string[]: The set of filter values +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): Represents the filter operator -* **values**: string[]: The set of filter values -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): Represents the filter operator -* **values**: string[]: The set of filter values +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): Represents the filter operator -* **values**: string[]: The set of filter values +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +## JsonInputSchemaMappingProperties +### Properties +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. ## RetryPolicy ### Properties * **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. * **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. @@ -242,18 +237,23 @@ Wildcard characters are not supported in this path. * **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. diff --git a/generated/eventgrid/microsoft.eventgrid/2019-01-01/types.md b/generated/eventgrid/microsoft.eventgrid/2019-01-01/types.md index 1d1ea1f2bb..4c8430495e 100644 --- a/generated/eventgrid/microsoft.eventgrid/2019-01-01/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2019-01-01/types.md @@ -25,16 +25,6 @@ * **ApiVersion**: 2019-01-01 * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription -* **topic**: string (ReadOnly): Name of the topic of the event subscription. - ## DeadLetterDestination * **Discriminator**: endpointType @@ -45,10 +35,9 @@ * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties +## EventHubEventSubscriptionDestinationProperties ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: 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: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -75,24 +64,6 @@ * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - ## EventSubscriptionFilter ### Properties * **includedEventTypes**: string[]: A list of applicable event types that need to be part of the event subscription. @@ -105,23 +76,52 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription +* **topic**: string (ReadOnly): Name of the topic of the event subscription. + +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. + ## RetryPolicy ### Properties * **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. * **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: 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} + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. diff --git a/generated/eventgrid/microsoft.eventgrid/2019-02-01-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2019-02-01-preview/types.md index c18804ecde..c55ffced18 100644 --- a/generated/eventgrid/microsoft.eventgrid/2019-02-01-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2019-02-01-preview/types.md @@ -50,70 +50,71 @@ * **ApiVersion**: 2019-02-01-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inputSchema**: 'CloudEventV01Schema' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. - -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +## AdvancedFilter +* **Discriminator**: operatorType ### Base Properties -### JsonInputSchemaMapping +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## DomainTopicProperties -### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. + +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **eventDeliverySchema**: 'CloudEventV01Schema' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription -* **topic**: string (ReadOnly): Name of the topic of the event subscription. ## DeadLetterDestination * **Discriminator**: endpointType @@ -125,10 +126,25 @@ along with a default value to be used, and at least one of these two properties * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties +## DomainProperties ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inputSchema**: 'CloudEventV01Schema' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -160,28 +176,6 @@ along with a default value to be used, and at least one of these two properties * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - ## EventSubscriptionFilter ### Properties * **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. @@ -194,77 +188,78 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. - -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **eventDeliverySchema**: 'CloudEventV01Schema' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### StringContainsAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +## JsonInputSchemaMappingProperties +### Properties +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. ## RetryPolicy ### Properties * **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. * **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. @@ -272,18 +267,23 @@ Wildcard characters are not supported in this path. * **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. diff --git a/generated/eventgrid/microsoft.eventgrid/2019-06-01/types.md b/generated/eventgrid/microsoft.eventgrid/2019-06-01/types.md index a65bbf625a..f34211c79f 100644 --- a/generated/eventgrid/microsoft.eventgrid/2019-06-01/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2019-06-01/types.md @@ -50,110 +50,6 @@ * **ApiVersion**: 2019-06-01 * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DomainTopicProperties -### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. - -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. - -## DeadLetterDestination -* **Discriminator**: endpointType - -### Base Properties -### StorageBlobDeadLetterDestination -#### Properties -* **endpointType**: 'StorageBlob' (Required): Type of the endpoint for the dead letter destination -* **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. - - -## StorageBlobDeadLetterDestinationProperties -### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events - -## EventSubscriptionDestination -* **Discriminator**: endpointType - -### Base Properties -### EventHubEventSubscriptionDestination -#### Properties -* **endpointType**: 'EventHub' (Required): Type of the endpoint for the event subscription destination -* **properties**: [EventHubEventSubscriptionDestinationProperties](#eventhubeventsubscriptiondestinationproperties): The properties for a event hub destination. - -### HybridConnectionEventSubscriptionDestination -#### Properties -* **endpointType**: 'HybridConnection' (Required): Type of the endpoint for the event subscription destination -* **properties**: [HybridConnectionEventSubscriptionDestinationProperties](#hybridconnectioneventsubscriptiondestinationproperties): The properties for a hybrid connection destination. - -### ServiceBusQueueEventSubscriptionDestination -#### Properties -* **endpointType**: 'ServiceBusQueue' (Required): Type of the endpoint for the event subscription destination -* **properties**: [ServiceBusQueueEventSubscriptionDestinationProperties](#servicebusqueueeventsubscriptiondestinationproperties): The properties that represent the Service Bus destination of an event subscription. - -### StorageQueueEventSubscriptionDestination -#### Properties -* **endpointType**: 'StorageQueue' (Required): Type of the endpoint for the event subscription destination -* **properties**: [StorageQueueEventSubscriptionDestinationProperties](#storagequeueeventsubscriptiondestinationproperties): The properties for a storage queue destination. - -### WebHookEventSubscriptionDestination -#### Properties -* **endpointType**: 'WebHook' (Required): Type of the endpoint for the event subscription destination -* **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. - - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. - -## EventSubscriptionFilter -### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. -* **includedEventTypes**: 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. -* **isSubjectCaseSensitive**: bool: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter -should be compared in a case sensitive manner. -* **subjectBeginsWith**: 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. -* **subjectEndsWith**: 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. - ## AdvancedFilter * **Discriminator**: operatorType @@ -220,28 +116,132 @@ Wildcard characters are not supported in this path. * **values**: string[]: The set of filter values. +## DeadLetterDestination +* **Discriminator**: endpointType + +### Base Properties +### StorageBlobDeadLetterDestination +#### Properties +* **endpointType**: 'StorageBlob' (Required): Type of the endpoint for the dead letter destination +* **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. + + +## DomainProperties +### Properties +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. + +## EventSubscriptionDestination +* **Discriminator**: endpointType + +### Base Properties +### EventHubEventSubscriptionDestination +#### Properties +* **endpointType**: 'EventHub' (Required): Type of the endpoint for the event subscription destination +* **properties**: [EventHubEventSubscriptionDestinationProperties](#eventhubeventsubscriptiondestinationproperties): The properties for a event hub destination. + +### HybridConnectionEventSubscriptionDestination +#### Properties +* **endpointType**: 'HybridConnection' (Required): Type of the endpoint for the event subscription destination +* **properties**: [HybridConnectionEventSubscriptionDestinationProperties](#hybridconnectioneventsubscriptiondestinationproperties): The properties for a hybrid connection destination. + +### ServiceBusQueueEventSubscriptionDestination +#### Properties +* **endpointType**: 'ServiceBusQueue' (Required): Type of the endpoint for the event subscription destination +* **properties**: [ServiceBusQueueEventSubscriptionDestinationProperties](#servicebusqueueeventsubscriptiondestinationproperties): The properties that represent the Service Bus destination of an event subscription. + +### StorageQueueEventSubscriptionDestination +#### Properties +* **endpointType**: 'StorageQueue' (Required): Type of the endpoint for the event subscription destination +* **properties**: [StorageQueueEventSubscriptionDestinationProperties](#storagequeueeventsubscriptiondestinationproperties): The properties for a storage queue destination. + +### WebHookEventSubscriptionDestination +#### Properties +* **endpointType**: 'WebHook' (Required): Type of the endpoint for the event subscription destination +* **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. + + +## EventSubscriptionFilter +### Properties +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. +* **includedEventTypes**: 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. +* **isSubjectCaseSensitive**: bool: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter +should be compared in a case sensitive manner. +* **subjectBeginsWith**: 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. +* **subjectEndsWith**: 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. + +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. + +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. + ## RetryPolicy ### Properties * **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. * **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. diff --git a/generated/eventgrid/microsoft.eventgrid/2020-01-01-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2020-01-01-preview/types.md index 491ce9434e..02bdbc5ae1 100644 --- a/generated/eventgrid/microsoft.eventgrid/2020-01-01-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2020-01-01-preview/types.md @@ -50,71 +50,77 @@ * **ApiVersion**: 2020-01-01-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. - -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +## AdvancedFilter +* **Discriminator**: operatorType ### Base Properties -### JsonInputSchemaMapping +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## DomainTopicProperties -### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## EventSubscriptionProperties +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + + +## AzureFunctionEventSubscriptionDestinationProperties ### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. ## DeadLetterDestination * **Discriminator**: endpointType @@ -126,10 +132,26 @@ along with a default value to be used, and at least one of these two properties * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties +## DomainProperties ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -171,42 +193,6 @@ along with a default value to be used, and at least one of these two properties * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## AzureFunctionEventSubscriptionDestinationProperties -### Properties -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## ServiceBusTopicEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. - ## EventSubscriptionFilter ### Properties * **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. @@ -219,76 +205,81 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### NumberLessThanAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### StringContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonInputSchemaMappingProperties +### Properties +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## RetryPolicy +### Properties +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events -## RetryPolicy +## StorageQueueEventSubscriptionDestinationProperties ### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. ## TopicProperties ### Properties @@ -298,18 +289,27 @@ Wildcard characters are not supported in this path. * **metricResourceId**: string (ReadOnly): Metric resource id for the topic. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the topic. +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. diff --git a/generated/eventgrid/microsoft.eventgrid/2020-04-01-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2020-04-01-preview/types.md index af340f5dd5..4256a8c8cf 100644 --- a/generated/eventgrid/microsoft.eventgrid/2020-04-01-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2020-04-01-preview/types.md @@ -144,96 +144,77 @@ * **ApiVersion**: 2020-04-01-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## IdentityInfo -### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. -This property is currently not used and reserved for future usage. +## AdvancedFilter +* **Discriminator**: operatorType -## IdentityInfoUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +### Base Properties +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter +#### Properties +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. -* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. -You can further restrict to specific IPs by configuring +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## InboundIpRule -### Properties -* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. -* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -### Base Properties -### JsonInputSchemaMapping +### NumberLessThanOrEqualsAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified identifier of the resource. -* **name**: string (ReadOnly): Name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **type**: string (ReadOnly): Type of the resource. +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: GroupIds from the private link service resource. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpoint + +## AzureFunctionEventSubscriptionDestinationProperties ### Properties -* **id**: string: The ARM identifier for Private Endpoint. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. ## ConnectionState ### Properties @@ -241,33 +222,6 @@ along with a default value to be used, and at least one of these two properties * **description**: string: Description of the connection state. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## ResourceSku -### Properties -* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DomainTopicProperties -### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. - -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. -* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. - ## DeadLetterDestination * **Discriminator**: endpointType @@ -278,26 +232,70 @@ along with a default value to be used, and at least one of these two properties * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties -### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events - ## DeadLetterWithResourceIdentity ### Properties * **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. * **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. -## EventSubscriptionIdentity -### Properties -* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentity**: string: The user identity associated with the resource. - ## DeliveryWithResourceIdentity ### Properties * **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. * **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +## DomainProperties +### Properties +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. +* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. +You can further restrict to specific IPs by configuring + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## EventChannelDestination +### Properties +* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic +associated with the event channel will be created under this Azure subscription. +* **partnerTopicName**: string: Name of the partner topic associated with the event channel. +* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic +associated with the event channel will be created under this resource group. + +## EventChannelFilter +### Properties +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. + +## EventChannelProperties +### Properties +* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. +* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, +the event channel and corresponding partner topic are deleted. +* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. +* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. +This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. +* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. +* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. + +## EventChannelSource +### Properties +* **source**: string: The identifier of the resource that's the source of the events. +This represents a unique resource in the partner's resource model. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. + ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -338,133 +336,96 @@ along with a default value to be used, and at least one of these two properties * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## AzureFunctionEventSubscriptionDestinationProperties +## EventSubscriptionFilter ### Properties -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. +* **includedEventTypes**: 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. +* **isSubjectCaseSensitive**: bool: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter +should be compared in a case sensitive manner. +* **subjectBeginsWith**: 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. +* **subjectEndsWith**: 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. -## EventHubEventSubscriptionDestinationProperties +## EventSubscriptionIdentity ### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. +* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentity**: string: The user identity associated with the resource. + +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. +* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. ## HybridConnectionEventSubscriptionDestinationProperties ### Properties * **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## ServiceBusTopicEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties +## IdentityInfo ### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. +This property is currently not used and reserved for future usage. -## WebHookEventSubscriptionDestinationProperties +## IdentityInfoUserAssignedIdentities ### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## EventSubscriptionFilter +## InboundIpRule ### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. -* **includedEventTypes**: 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. -* **isSubjectCaseSensitive**: bool: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter -should be compared in a case sensitive manner. -* **subjectBeginsWith**: 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. -* **subjectEndsWith**: 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. +* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. +* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. -## AdvancedFilter -* **Discriminator**: operatorType +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType ### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. - -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. - -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. - -### StringContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. - -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. - -### StringInAdvancedFilter +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -## RetryPolicy +## JsonFieldWithDefault ### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -## SystemData +## JsonInputSchemaMappingProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. ## PartnerNamespaceProperties ### Properties @@ -473,39 +434,10 @@ Wildcard characters are not supported in this path. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the partner namespace. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventChannelProperties -### Properties -* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. -* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, -the event channel and corresponding partner topic are deleted. -* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. -* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. -This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. -* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. -* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. - -## EventChannelDestination -### Properties -* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic -associated with the event channel will be created under this Azure subscription. -* **partnerTopicName**: string: Name of the partner topic associated with the event channel. -* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic -associated with the event channel will be created under this resource group. - -## EventChannelFilter -### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. - -## EventChannelSource +## PartnerNamespaceSharedAccessKeys ### Properties -* **source**: string: The identifier of the resource that's the source of the events. -This represents a unique resource in the partner's resource model. +* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. +* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. ## PartnerRegistrationProperties ### Properties @@ -531,10 +463,59 @@ length cannot exceed 16 digits including country code. Examples of valid phone n integration on an event source. * **visibilityState**: 'GenerallyAvailable' | 'Hidden' | 'PublicPreview' | string: Visibility state of the partner registration. -## TrackedResourceTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified identifier of the resource. +* **name**: string (ReadOnly): Name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **type**: string (ReadOnly): Type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: GroupIds from the private link service resource. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## ResourceSku +### Properties +* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. + +## RetryPolicy +### Properties +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. + +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## SystemTopicProperties ### Properties @@ -543,11 +524,6 @@ integration on an event source. * **source**: string: Source for the system topic. * **topicType**: string: TopicType for the system topic. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. @@ -560,23 +536,47 @@ integration on an event source. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## PartnerNamespaceSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. -* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## WebHookEventSubscriptionDestinationProperties +### Properties +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. diff --git a/generated/eventgrid/microsoft.eventgrid/2020-06-01/types.md b/generated/eventgrid/microsoft.eventgrid/2020-06-01/types.md index c33bfc8f07..f7b9ee13cc 100644 --- a/generated/eventgrid/microsoft.eventgrid/2020-06-01/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2020-06-01/types.md @@ -72,113 +72,83 @@ * **ApiVersion**: 2020-06-01 * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. -* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. -You can further restrict to specific IPs by configuring +## AdvancedFilter +* **Discriminator**: operatorType -## InboundIpRule -### Properties -* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. -* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. +### Base Properties +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter +#### Properties +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -### Base Properties -### JsonInputSchemaMapping +### NumberGreaterThanOrEqualsAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified identifier of the resource. -* **name**: string (ReadOnly): Name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **type**: string (ReadOnly): Type of the resource. +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: GroupIds from the private link service resource. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## ConnectionState -### Properties -* **actionsRequired**: string: Actions required (if any). -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## DomainTopicProperties +## AzureFunctionEventSubscriptionDestinationProperties ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. -## EventSubscriptionProperties +## ConnectionState ### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +* **actionsRequired**: string: Actions required (if any). +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. ## DeadLetterDestination * **Discriminator**: endpointType @@ -190,10 +160,30 @@ along with a default value to be used, and at least one of these two properties * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties +## DomainProperties ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. +* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. +You can further restrict to specific IPs by configuring + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -235,42 +225,6 @@ along with a default value to be used, and at least one of these two properties * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## AzureFunctionEventSubscriptionDestinationProperties -### Properties -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## ServiceBusTopicEventSubscriptionDestinationProperties -### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. - ## EventSubscriptionFilter ### Properties * **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. @@ -283,77 +237,114 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## InboundIpRule +### Properties +* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. +* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### NumberLessThanOrEqualsAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### StringContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonInputSchemaMappingProperties +### Properties +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## PrivateEndpoint +### Properties +* **id**: string: The ARM identifier for Private Endpoint. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified identifier of the resource. +* **name**: string (ReadOnly): Name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **type**: string (ReadOnly): Type of the resource. +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: GroupIds from the private link service resource. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. ## RetryPolicy ### Properties * **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. * **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. @@ -366,18 +357,27 @@ Wildcard characters are not supported in this path. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## WebHookEventSubscriptionDestinationProperties ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. diff --git a/generated/eventgrid/microsoft.eventgrid/2020-10-15-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2020-10-15-preview/types.md index 4fec9da394..4054471cc7 100644 --- a/generated/eventgrid/microsoft.eventgrid/2020-10-15-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2020-10-15-preview/types.md @@ -150,138 +150,117 @@ * **ApiVersion**: 2020-10-15-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## IdentityInfo -### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. -This property is currently not used and reserved for future usage. +## AdvancedFilter +* **Discriminator**: operatorType -## IdentityInfoUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +### Base Properties +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter +#### Properties +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +### IsNotNullAdvancedFilter +#### Properties +* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -## DomainProperties -### Properties -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. -* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. -You can further restrict to specific IPs by configuring +### IsNullOrUndefinedAdvancedFilter +#### Properties +* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -## InboundIpRule -### Properties -* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. -* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -### Base Properties -### JsonInputSchemaMapping +### NumberInAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. +### NumberInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified identifier of the resource. -* **name**: string (ReadOnly): Name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **type**: string (ReadOnly): Type of the resource. +### NumberNotInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: GroupIds from the private link service resource. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## ConnectionState -### Properties -* **actionsRequired**: string: Actions required (if any). -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## ResourceSku -### Properties -* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### StringNotBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### StringNotContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## DomainTopicProperties +### StringNotEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + + +## AzureFunctionEventSubscriptionDestinationProperties ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. -## EventSubscriptionProperties +## ConnectionState ### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. -* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +* **actionsRequired**: string: Actions required (if any). +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. ## DeadLetterDestination * **Discriminator**: endpointType @@ -293,26 +272,92 @@ along with a default value to be used, and at least one of these two properties * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties -### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events - ## DeadLetterWithResourceIdentity ### Properties * **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. * **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. -## EventSubscriptionIdentity -### Properties -* **type**: 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentity**: string: The user identity associated with the resource. +## DeliveryAttributeMapping +* **Discriminator**: type + +### Base Properties +* **name**: string: Name of the delivery attribute or header. +### DynamicDeliveryAttributeMapping +#### Properties +* **properties**: [DynamicDeliveryAttributeMappingProperties](#dynamicdeliveryattributemappingproperties): Properties of dynamic delivery attribute mapping. +* **type**: 'Dynamic' (Required): Type of the delivery attribute or header name. + +### StaticDeliveryAttributeMapping +#### Properties +* **properties**: [StaticDeliveryAttributeMappingProperties](#staticdeliveryattributemappingproperties): Properties of static delivery attribute mapping. +* **type**: 'Static' (Required): Type of the delivery attribute or header name. + ## DeliveryWithResourceIdentity ### Properties * **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. * **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +## DomainProperties +### Properties +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. +* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. +You can further restrict to specific IPs by configuring + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## DynamicDeliveryAttributeMappingProperties +### Properties +* **sourceField**: string: JSON path in the event which contains attribute value. + +## EventChannelDestination +### Properties +* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic +associated with the event channel will be created under this Azure subscription. +* **partnerTopicName**: string: Name of the partner topic associated with the event channel. +* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic +associated with the event channel will be created under this resource group. + +## EventChannelFilter +### Properties +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. +* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. + +## EventChannelProperties +### Properties +* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. +* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, +the event channel and corresponding partner topic are deleted. +* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. +* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. +This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. +* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. +* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. + +## EventChannelSource +### Properties +* **source**: string: The identifier of the resource that's the source of the events. +This represents a unique resource in the partner's resource model. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. + ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -353,74 +398,6 @@ along with a default value to be used, and at least one of these two properties * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## AzureFunctionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. - -## DeliveryAttributeMapping -* **Discriminator**: type - -### Base Properties -* **name**: string: Name of the delivery attribute or header. -### DynamicDeliveryAttributeMapping -#### Properties -* **properties**: [DynamicDeliveryAttributeMappingProperties](#dynamicdeliveryattributemappingproperties): Properties of dynamic delivery attribute mapping. -* **type**: 'Dynamic' (Required): Type of the delivery attribute or header name. - -### StaticDeliveryAttributeMapping -#### Properties -* **properties**: [StaticDeliveryAttributeMappingProperties](#staticdeliveryattributemappingproperties): Properties of static delivery attribute mapping. -* **type**: 'Static' (Required): Type of the delivery attribute or header name. - - -## DynamicDeliveryAttributeMappingProperties -### Properties -* **sourceField**: string: JSON path in the event which contains attribute value. - -## StaticDeliveryAttributeMappingProperties -### Properties -* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . -* **value**: string: Value of the delivery attribute. - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## ServiceBusTopicEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. - ## EventSubscriptionFilter ### Properties * **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. @@ -434,109 +411,90 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### IsNotNullAdvancedFilter -#### Properties -* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. - -### IsNullOrUndefinedAdvancedFilter -#### Properties -* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. - -### NumberInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. - -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventSubscriptionIdentity +### Properties +* **type**: 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentity**: string: The user identity associated with the resource. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. +* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### NumberNotInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. +## ExtendedLocation +### Properties +* **name**: string: Fully qualified name of the extended location. +* **type**: string: Type of the extended location. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### StringContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## IdentityInfo +### Properties +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. +This property is currently not used and reserved for future usage. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## IdentityInfoUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## InboundIpRule +### Properties +* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. +* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. -### StringNotBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### StringNotContainsAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### StringNotEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -## RetryPolicy +## JsonInputSchemaMappingProperties ### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. ## PartnerNamespaceProperties ### Properties @@ -545,40 +503,10 @@ Wildcard characters are not supported in this path. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the partner namespace. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventChannelProperties -### Properties -* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. -* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, -the event channel and corresponding partner topic are deleted. -* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. -* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. -This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. -* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. -* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. - -## EventChannelDestination -### Properties -* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic -associated with the event channel will be created under this Azure subscription. -* **partnerTopicName**: string: Name of the partner topic associated with the event channel. -* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic -associated with the event channel will be created under this resource group. - -## EventChannelFilter -### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. -* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. - -## EventChannelSource +## PartnerNamespaceSharedAccessKeys ### Properties -* **source**: string: The identifier of the resource that's the source of the events. -This represents a unique resource in the partner's resource model. +* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. +* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. ## PartnerRegistrationProperties ### Properties @@ -604,10 +532,67 @@ length cannot exceed 16 digits including country code. Examples of valid phone n integration on an event source. * **visibilityState**: 'GenerallyAvailable' | 'Hidden' | 'PublicPreview' | string: Visibility state of the partner registration. -## TrackedResourceTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified identifier of the resource. +* **name**: string (ReadOnly): Name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **type**: string (ReadOnly): Type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: GroupIds from the private link service resource. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## ResourceSku +### Properties +* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. + +## RetryPolicy +### Properties +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. + +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. + +## StaticDeliveryAttributeMappingProperties +### Properties +* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . +* **value**: string: Value of the delivery attribute. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## SystemTopicProperties ### Properties @@ -616,16 +601,6 @@ integration on an event source. * **source**: string: Source for the system topic. * **topicType**: string: TopicType for the system topic. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExtendedLocation -### Properties -* **name**: string: Fully qualified name of the extended location. -* **type**: string: Type of the extended location. - ## TopicProperties ### Properties * **endpoint**: string (ReadOnly): Endpoint for the topic. @@ -638,23 +613,48 @@ integration on an event source. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## PartnerNamespaceSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. -* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## WebHookEventSubscriptionDestinationProperties +### Properties +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. diff --git a/generated/eventgrid/microsoft.eventgrid/2021-06-01-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2021-06-01-preview/types.md index c2b4d4abbe..021a11b231 100644 --- a/generated/eventgrid/microsoft.eventgrid/2021-06-01-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2021-06-01-preview/types.md @@ -159,24 +159,153 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## IdentityInfo +## AdvancedFilter +* **Discriminator**: operatorType + +### Base Properties +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter +#### Properties +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. + +### IsNotNullAdvancedFilter +#### Properties +* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. + +### IsNullOrUndefinedAdvancedFilter +#### Properties +* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. + +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. + +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. + +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. + +### NumberInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. + +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. + +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. + +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. + +### NumberNotInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. + +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + + +## AzureFunctionEventSubscriptionDestinationProperties ### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. -This property is currently not used and reserved for future usage. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. -## IdentityInfoUserAssignedIdentities +## ConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +* **actionsRequired**: string: Actions required (if any). +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## UserIdentityProperties +## DeadLetterDestination +* **Discriminator**: endpointType + +### Base Properties +### StorageBlobDeadLetterDestination +#### Properties +* **endpointType**: 'StorageBlob' (Required): Type of the endpoint for the dead letter destination +* **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. + + +## DeadLetterWithResourceIdentity ### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. + +## DeliveryAttributeMapping +* **Discriminator**: type + +### Base Properties +* **name**: string: Name of the delivery attribute or header. +### DynamicDeliveryAttributeMapping +#### Properties +* **properties**: [DynamicDeliveryAttributeMappingProperties](#dynamicdeliveryattributemappingproperties): Properties of dynamic delivery attribute mapping. +* **type**: 'Dynamic' (Required): Type of the delivery attribute or header name. + +### StaticDeliveryAttributeMapping +#### Properties +* **properties**: [StaticDeliveryAttributeMappingProperties](#staticdeliveryattributemappingproperties): Properties of static delivery attribute mapping. +* **type**: 'Static' (Required): Type of the delivery attribute or header name. + + +## DeliveryWithResourceIdentity +### Properties +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. ## DomainProperties ### Properties @@ -205,137 +334,53 @@ resources by the user. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring -## InboundIpRule -### Properties -* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. -* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. - -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType - -### Base Properties -### JsonInputSchemaMapping -#### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. - - -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. - -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. - -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified identifier of the resource. -* **name**: string (ReadOnly): Name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **type**: string (ReadOnly): Type of the resource. - -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: GroupIds from the private link service resource. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. - -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. - -## ConnectionState -### Properties -* **actionsRequired**: string: Actions required (if any). -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. - -## ResourceSku -### Properties -* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## DomainSharedAccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. ## DomainTopicProperties ### Properties * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. -## EventSubscriptionProperties +## DynamicDeliveryAttributeMappingProperties ### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. -* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. - -## DeadLetterDestination -* **Discriminator**: endpointType - -### Base Properties -### StorageBlobDeadLetterDestination -#### Properties -* **endpointType**: 'StorageBlob' (Required): Type of the endpoint for the dead letter destination -* **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. +* **sourceField**: string: JSON path in the event which contains attribute value. +## EventChannelDestination +### Properties +* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic +associated with the event channel will be created under this Azure subscription. +* **partnerTopicName**: string: Name of the partner topic associated with the event channel. +* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic +associated with the event channel will be created under this resource group. -## StorageBlobDeadLetterDestinationProperties +## EventChannelFilter ### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. +* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null. -## DeadLetterWithResourceIdentity +## EventChannelProperties ### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. +* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, +the event channel and corresponding partner topic are deleted. +* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. +* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. +This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. +* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. +* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. -## EventSubscriptionIdentity +## EventChannelSource ### Properties -* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentity**: string: The user identity associated with the resource. +* **source**: string: The identifier of the resource that's the source of the events. +This represents a unique resource in the partner's resource model. -## DeliveryWithResourceIdentity +## EventHubEventSubscriptionDestinationProperties ### Properties -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -377,74 +422,6 @@ along with a default value to be used, and at least one of these two properties * **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## AzureFunctionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. - -## DeliveryAttributeMapping -* **Discriminator**: type - -### Base Properties -* **name**: string: Name of the delivery attribute or header. -### DynamicDeliveryAttributeMapping -#### Properties -* **properties**: [DynamicDeliveryAttributeMappingProperties](#dynamicdeliveryattributemappingproperties): Properties of dynamic delivery attribute mapping. -* **type**: 'Dynamic' (Required): Type of the delivery attribute or header name. - -### StaticDeliveryAttributeMapping -#### Properties -* **properties**: [StaticDeliveryAttributeMappingProperties](#staticdeliveryattributemappingproperties): Properties of static delivery attribute mapping. -* **type**: 'Static' (Required): Type of the delivery attribute or header name. - - -## DynamicDeliveryAttributeMappingProperties -### Properties -* **sourceField**: string: JSON path in the event which contains attribute value. - -## StaticDeliveryAttributeMappingProperties -### Properties -* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . -* **value**: string: Value of the delivery attribute. - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## ServiceBusTopicEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. - -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. - -## WebHookEventSubscriptionDestinationProperties -### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. - ## EventSubscriptionFilter ### Properties * **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. @@ -458,109 +435,90 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### IsNotNullAdvancedFilter -#### Properties -* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. - -### IsNullOrUndefinedAdvancedFilter -#### Properties -* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. - -### NumberInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. - -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventSubscriptionIdentity +### Properties +* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentity**: string: The user identity associated with the resource. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. +* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### NumberNotInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. +## ExtendedLocation +### Properties +* **name**: string: Fully qualified name of the extended location. +* **type**: string: Type of the extended location. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### StringContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## IdentityInfo +### Properties +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. +This property is currently not used and reserved for future usage. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## IdentityInfoUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## InboundIpRule +### Properties +* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. +* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. -### StringNotBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### StringNotContainsAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### StringNotEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -## RetryPolicy +## JsonInputSchemaMappingProperties ### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. ## PartnerNamespaceProperties ### Properties @@ -574,40 +532,10 @@ Wildcard characters are not supported in this path. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventChannelProperties -### Properties -* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. -* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, -the event channel and corresponding partner topic are deleted. -* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. -* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. -This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. -* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. -* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. - -## EventChannelDestination -### Properties -* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic -associated with the event channel will be created under this Azure subscription. -* **partnerTopicName**: string: Name of the partner topic associated with the event channel. -* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic -associated with the event channel will be created under this resource group. - -## EventChannelFilter -### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. -* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null. - -## EventChannelSource +## PartnerNamespaceSharedAccessKeys ### Properties -* **source**: string: The identifier of the resource that's the source of the events. -This represents a unique resource in the partner's resource model. +* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. +* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. ## PartnerRegistrationProperties ### Properties @@ -633,10 +561,67 @@ length cannot exceed 16 digits including country code. Examples of valid phone n integration on an event source. * **visibilityState**: 'GenerallyAvailable' | 'Hidden' | 'PublicPreview' | string: Visibility state of the partner registration. -## TrackedResourceTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified identifier of the resource. +* **name**: string (ReadOnly): Name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **type**: string (ReadOnly): Type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: GroupIds from the private link service resource. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## ResourceSku +### Properties +* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. + +## RetryPolicy +### Properties +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. + +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. + +## StaticDeliveryAttributeMappingProperties +### Properties +* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . +* **value**: string: Value of the delivery attribute. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## SystemTopicProperties ### Properties @@ -645,16 +630,6 @@ integration on an event source. * **source**: string: Source for the system topic. * **topicType**: string: TopicType for the system topic. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExtendedLocation -### Properties -* **name**: string: Fully qualified name of the extended location. -* **type**: string: Type of the extended location. - ## TopicProperties ### Properties * **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. @@ -668,23 +643,48 @@ integration on an event source. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## PartnerNamespaceSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. -* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## WebHookEventSubscriptionDestinationProperties +### Properties +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. diff --git a/generated/eventgrid/microsoft.eventgrid/2021-10-15-preview/types.md b/generated/eventgrid/microsoft.eventgrid/2021-10-15-preview/types.md index 40ac515453..3b4aad317e 100644 --- a/generated/eventgrid/microsoft.eventgrid/2021-10-15-preview/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2021-10-15-preview/types.md @@ -236,226 +236,110 @@ * **ApiVersion**: 2021-10-15-preview * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## IdentityInfo -### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. -This property is currently not used and reserved for future usage. - -## IdentityInfoUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) - -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. - -## DomainProperties -### Properties -* **autoCreateTopicWithFirstSubscription**: bool: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. -In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. -When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is -created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic -by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the -flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the -domain topic on demand if needed. -* **autoDeleteTopicWithLastSubscription**: bool: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. -In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. -When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope -of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed -(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full -control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer -resources by the user. -* **dataResidencyBoundary**: 'WithinGeopair' | 'WithinRegion' | string: Data Residency Boundary of the resource. -* **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. -* **endpoint**: string (ReadOnly): Endpoint for the Event Grid Domain Resource which is used for publishing the events. -* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. -* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **metricResourceId**: string (ReadOnly): Metric resource id for the Event Grid Domain Resource. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Event Grid Domain Resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. -You can further restrict to specific IPs by configuring - -## InboundIpRule -### Properties -* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. -* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. - -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +## AdvancedFilter +* **Discriminator**: operatorType ### Base Properties -### JsonInputSchemaMapping +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. - - -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. - -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. - -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified identifier of the resource. -* **name**: string (ReadOnly): Name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **type**: string (ReadOnly): Type of the resource. - -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: GroupIds from the private link service resource. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. - -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. - -## ConnectionState -### Properties -* **actionsRequired**: string: Actions required (if any). -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. - -## ResourceSku -### Properties -* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### IsNotNullAdvancedFilter +#### Properties +* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -## EventSubscriptionProperties -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. -* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +### IsNullOrUndefinedAdvancedFilter +#### Properties +* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -## DeadLetterDestination -* **Discriminator**: endpointType +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -### Base Properties -### StorageBlobDeadLetterDestination +### NumberGreaterThanOrEqualsAdvancedFilter #### Properties -* **endpointType**: 'StorageBlob' (Required): Type of the endpoint for the dead letter destination -* **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. +### NumberInAdvancedFilter +#### Properties +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## StorageBlobDeadLetterDestinationProperties -### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +### NumberInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. -## DeadLetterWithResourceIdentity -### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## EventSubscriptionIdentity -### Properties -* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentity**: string: The user identity associated with the resource. +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## DeliveryWithResourceIdentity -### Properties -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## EventSubscriptionDestination -* **Discriminator**: endpointType +### NumberNotInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. -### Base Properties -### AzureFunctionEventSubscriptionDestination +### StringBeginsWithAdvancedFilter #### Properties -* **endpointType**: 'AzureFunction' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [AzureFunctionEventSubscriptionDestinationProperties](#azurefunctioneventsubscriptiondestinationproperties): The properties that represent the Azure Function destination of an event subscription. +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### EventHubEventSubscriptionDestination +### StringContainsAdvancedFilter #### Properties -* **endpointType**: 'EventHub' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [EventHubEventSubscriptionDestinationProperties](#eventhubeventsubscriptiondestinationproperties): The properties for a event hub destination. +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### HybridConnectionEventSubscriptionDestination +### StringEndsWithAdvancedFilter #### Properties -* **endpointType**: 'HybridConnection' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [HybridConnectionEventSubscriptionDestinationProperties](#hybridconnectioneventsubscriptiondestinationproperties): The properties for a hybrid connection destination. +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### PartnerEventSubscriptionDestination +### StringInAdvancedFilter #### Properties -* **endpointType**: 'PartnerDestination' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [PartnerEventSubscriptionDestinationProperties](#partnereventsubscriptiondestinationproperties) +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### ServiceBusQueueEventSubscriptionDestination +### StringNotBeginsWithAdvancedFilter #### Properties -* **endpointType**: 'ServiceBusQueue' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [ServiceBusQueueEventSubscriptionDestinationProperties](#servicebusqueueeventsubscriptiondestinationproperties): The properties that represent the Service Bus destination of an event subscription. +* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### ServiceBusTopicEventSubscriptionDestination +### StringNotContainsAdvancedFilter #### Properties -* **endpointType**: 'ServiceBusTopic' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [ServiceBusTopicEventSubscriptionDestinationProperties](#servicebustopiceventsubscriptiondestinationproperties): The properties that represent the Service Bus Topic destination of an event subscription. +* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### StorageQueueEventSubscriptionDestination +### StringNotEndsWithAdvancedFilter #### Properties -* **endpointType**: 'StorageQueue' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [StorageQueueEventSubscriptionDestinationProperties](#storagequeueeventsubscriptiondestinationproperties): The properties for a storage queue destination. +* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -### WebHookEventSubscriptionDestination +### StringNotInAdvancedFilter #### Properties -* **endpointType**: 'WebHook' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. +## AzureADPartnerClientAuthenticationProperties +### Properties +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. + ## AzureFunctionEventSubscriptionDestinationProperties ### Properties * **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. @@ -463,6 +347,38 @@ along with a default value to be used, and at least one of these two properties * **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. * **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. +## ChannelProperties +### Properties +* **channelType**: 'PartnerDestination' | 'PartnerTopic' | string: The type of the event channel which represents the direction flow of events. +* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, +the channel and corresponding partner topic are deleted. +* **messageForActivation**: string: Context or helpful message that can be used during the approval process by the subscriber. +* **partnerDestinationInfo**: [PartnerDestinationInfo](#partnerdestinationinfo): Properties of the corresponding partner destination of a Channel. +* **partnerTopicInfo**: [PartnerTopicInfo](#partnertopicinfo): Properties of the corresponding partner topic of a Channel. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the channel. +* **readinessState**: 'Activated' | 'NeverActivated' | string: The readiness state of the corresponding partner topic. + +## ConnectionState +### Properties +* **actionsRequired**: string: Actions required (if any). +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. + +## DeadLetterDestination +* **Discriminator**: endpointType + +### Base Properties +### StorageBlobDeadLetterDestination +#### Properties +* **endpointType**: 'StorageBlob' (Required): Type of the endpoint for the dead letter destination +* **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. + + +## DeadLetterWithResourceIdentity +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. + ## DeliveryAttributeMapping * **Discriminator**: type @@ -479,274 +395,261 @@ along with a default value to be used, and at least one of these two properties * **type**: 'Static' (Required): Type of the delivery attribute or header name. -## DynamicDeliveryAttributeMappingProperties -### Properties -* **sourceField**: string: JSON path in the event which contains attribute value. - -## StaticDeliveryAttributeMappingProperties -### Properties -* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . -* **value**: string: Value of the delivery attribute. - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## PartnerEventSubscriptionDestinationProperties +## DeliveryWithResourceIdentity ### Properties -* **resourceId**: string: The Azure Resource Id that represents the endpoint of a Partner Destination of an event subscription. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. -## ServiceBusQueueEventSubscriptionDestinationProperties +## DomainProperties ### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. +* **autoCreateTopicWithFirstSubscription**: bool: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. +In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. +When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is +created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic +by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the +flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the +domain topic on demand if needed. +* **autoDeleteTopicWithLastSubscription**: bool: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. +In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. +When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope +of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed +(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full +control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer +resources by the user. +* **dataResidencyBoundary**: 'WithinGeopair' | 'WithinRegion' | string: Data Residency Boundary of the resource. +* **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. +* **endpoint**: string (ReadOnly): Endpoint for the Event Grid Domain Resource which is used for publishing the events. +* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. +* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **metricResourceId**: string (ReadOnly): Metric resource id for the Event Grid Domain Resource. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Event Grid Domain Resource. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. +You can further restrict to specific IPs by configuring -## ServiceBusTopicEventSubscriptionDestinationProperties +## DomainSharedAccessKeys ### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. -## StorageQueueEventSubscriptionDestinationProperties +## DomainTopicProperties ### Properties -* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. -## WebHookEventSubscriptionDestinationProperties +## DynamicDeliveryAttributeMappingProperties ### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **sourceField**: string: JSON path in the event which contains attribute value. -## EventSubscriptionFilter +## EventChannelDestination ### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. -* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. -* **includedEventTypes**: 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. -* **isSubjectCaseSensitive**: bool: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter -should be compared in a case sensitive manner. -* **subjectBeginsWith**: 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. -* **subjectEndsWith**: 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. - -## AdvancedFilter -* **Discriminator**: operatorType - -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. - -### IsNotNullAdvancedFilter -#### Properties -* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. - -### IsNullOrUndefinedAdvancedFilter -#### Properties -* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. - -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. - -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic +associated with the event channel will be created under this Azure subscription. +* **partnerTopicName**: string: Name of the partner topic associated with the event channel. +* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic +associated with the event channel will be created under this resource group. -### NumberInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. +## EventChannelFilter +### Properties +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. +* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null. -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventChannelProperties +### Properties +* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. +* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, +the event channel and corresponding partner topic are deleted. +* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. +* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. +This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. +* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. +* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## EventChannelSource +### Properties +* **source**: string: The identifier of the resource that's the source of the events. +This represents a unique resource in the partner's resource model. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## EventHubEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. -### NumberNotInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. +## EventSubscriptionDestination +* **Discriminator**: endpointType -### StringBeginsWithAdvancedFilter +### Base Properties +### AzureFunctionEventSubscriptionDestination #### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'AzureFunction' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [AzureFunctionEventSubscriptionDestinationProperties](#azurefunctioneventsubscriptiondestinationproperties): The properties that represent the Azure Function destination of an event subscription. -### StringContainsAdvancedFilter +### EventHubEventSubscriptionDestination #### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'EventHub' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [EventHubEventSubscriptionDestinationProperties](#eventhubeventsubscriptiondestinationproperties): The properties for a event hub destination. -### StringEndsWithAdvancedFilter +### HybridConnectionEventSubscriptionDestination #### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'HybridConnection' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [HybridConnectionEventSubscriptionDestinationProperties](#hybridconnectioneventsubscriptiondestinationproperties): The properties for a hybrid connection destination. -### StringInAdvancedFilter +### PartnerEventSubscriptionDestination #### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'PartnerDestination' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [PartnerEventSubscriptionDestinationProperties](#partnereventsubscriptiondestinationproperties) -### StringNotBeginsWithAdvancedFilter +### ServiceBusQueueEventSubscriptionDestination #### Properties -* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'ServiceBusQueue' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [ServiceBusQueueEventSubscriptionDestinationProperties](#servicebusqueueeventsubscriptiondestinationproperties): The properties that represent the Service Bus destination of an event subscription. -### StringNotContainsAdvancedFilter +### ServiceBusTopicEventSubscriptionDestination #### Properties -* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'ServiceBusTopic' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [ServiceBusTopicEventSubscriptionDestinationProperties](#servicebustopiceventsubscriptiondestinationproperties): The properties that represent the Service Bus Topic destination of an event subscription. -### StringNotEndsWithAdvancedFilter +### StorageQueueEventSubscriptionDestination #### Properties -* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +* **endpointType**: 'StorageQueue' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [StorageQueueEventSubscriptionDestinationProperties](#storagequeueeventsubscriptiondestinationproperties): The properties for a storage queue destination. -### StringNotInAdvancedFilter +### WebHookEventSubscriptionDestination #### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. - +* **endpointType**: 'WebHook' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## RetryPolicy -### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. -## DomainTopicProperties +## EventSubscriptionFilter ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. +* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event subscriptions. +* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. +* **includedEventTypes**: 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. +* **isSubjectCaseSensitive**: bool: Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter +should be compared in a case sensitive manner. +* **subjectBeginsWith**: 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. +* **subjectEndsWith**: 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. -## PartnerConfigurationProperties +## EventSubscriptionIdentity ### Properties -* **partnerAuthorization**: [PartnerAuthorization](#partnerauthorization): The partner authorization details. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the partner configuration. +* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentity**: string: The user identity associated with the resource. -## PartnerAuthorization +## EventSubscriptionProperties ### Properties -* **authorizedPartnersList**: [Partner](#partner)[]: The list of authorized partners. -* **defaultMaximumExpirationTimeInDays**: int: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is -not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. +* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -## Partner +## EventTypeInfo ### Properties -* **authorizationExpirationTimeInUtc**: string: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's -context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. -If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. -* **partnerName**: string: The partner name. -* **partnerRegistrationImmutableId**: string: The immutableId of the corresponding partner registration. +* **inlineEventTypes**: [EventTypeInfoInlineEventTypes](#eventtypeinfoinlineeventtypes): A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. +An example of a valid inline event name is "Contoso.OrderCreated". +The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type. +* **kind**: 'Inline' | string: The kind of event type used. -## PartnerConfigurationTags +## EventTypeInfoInlineEventTypes ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [InlineEventProperties](#inlineeventproperties) -## PartnerDestinationProperties +## ExtendedLocation ### Properties -* **activationState**: 'Activated' | 'NeverActivated' | string: Activation state of the partner destination. -* **endpointBaseUrl**: string: Endpoint Base URL of the partner destination -* **endpointServiceContext**: string: Endpoint context associated with this partner destination. -* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, -the partner destination and corresponding channel are deleted. -* **messageForActivation**: string: Context or helpful message that can be used during the approval process. -* **partnerRegistrationImmutableId**: string: The immutable Id of the corresponding partner registration. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the partner destination. +* **name**: string: Fully qualified name of the extended location. +* **type**: string: Type of the extended location. -## TrackedResourceTags +## HybridConnectionEventSubscriptionDestinationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -## PartnerNamespaceProperties +## IdentityInfo ### Properties -* **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. -* **endpoint**: string (ReadOnly): Endpoint for the partner namespace. -* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. -* **partnerRegistrationFullyQualifiedId**: string: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: -/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. -* **partnerTopicRoutingMode**: 'ChannelNameHeader' | 'SourceEventAttribute' | string: This determines if events published to this partner namespace should use the source attribute in the event payload -or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Array of PrivateEndpointConnection -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the partner namespace. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. -You can further restrict to specific IPs by configuring +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. +This property is currently not used and reserved for future usage. -## TrackedResourceTags +## IdentityInfoUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -## ChannelProperties +## InboundIpRule ### Properties -* **channelType**: 'PartnerDestination' | 'PartnerTopic' | string: The type of the event channel which represents the direction flow of events. -* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, -the channel and corresponding partner topic are deleted. -* **messageForActivation**: string: Context or helpful message that can be used during the approval process by the subscriber. -* **partnerDestinationInfo**: [PartnerDestinationInfo](#partnerdestinationinfo): Properties of the corresponding partner destination of a Channel. -* **partnerTopicInfo**: [PartnerTopicInfo](#partnertopicinfo): Properties of the corresponding partner topic of a Channel. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the channel. -* **readinessState**: 'Activated' | 'NeverActivated' | string: The readiness state of the corresponding partner topic. +* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. +* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. -## PartnerDestinationInfo -* **Discriminator**: endpointType +## InlineEventProperties +### Properties +* **dataSchemaUrl**: string: The dataSchemaUrl for the inline event. +* **description**: string: The description for the inline event. +* **documentationUrl**: string: The documentationUrl for the inline event. + +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType ### Base Properties -* **azureSubscriptionId**: string: Azure subscription ID of the subscriber. The partner destination associated with the channel will be -created under this Azure subscription. -* **endpointServiceContext**: string: Additional context of the partner destination endpoint. -* **name**: string: Name of the partner destination associated with the channel. -* **resourceGroupName**: string: Azure Resource Group of the subscriber. The partner destination associated with the channel will be -created under this resource group. -* **resourceMoveChangeHistory**: [ResourceMoveChangeHistory](#resourcemovechangehistory)[]: Change history of the resource move. -### WebhookPartnerDestinationInfo +### JsonInputSchemaMapping #### Properties -* **endpointType**: 'WebHook' (Required): Type of the endpoint for the partner destination -* **properties**: [WebhookPartnerDestinationProperties](#webhookpartnerdestinationproperties): Properties of a partner destination webhook. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -## ResourceMoveChangeHistory +## JsonField ### Properties -* **azureSubscriptionId**: string: Azure subscription ID of the resource. -* **changedTimeUtc**: string: UTC timestamp of when the resource was changed. -* **resourceGroupName**: string: Azure Resource Group of the resource. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. + +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. + +## JsonInputSchemaMappingProperties +### Properties +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. + +## Partner +### Properties +* **authorizationExpirationTimeInUtc**: string: Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's +context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. +If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. +* **partnerName**: string: The partner name. +* **partnerRegistrationImmutableId**: string: The immutableId of the corresponding partner registration. -## WebhookPartnerDestinationProperties +## PartnerAuthorization ### Properties -* **clientAuthentication**: [PartnerClientAuthentication](#partnerclientauthentication): Partner client authentication -* **endpointBaseUrl**: string: The base URL that represents the endpoint of the partner destination. -* **endpointUrl**: string: The URL that represents the endpoint of the partner destination. +* **authorizedPartnersList**: [Partner](#partner)[]: The list of authorized partners. +* **defaultMaximumExpirationTimeInDays**: int: Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is +not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. ## PartnerClientAuthentication * **Discriminator**: clientAuthenticationType @@ -758,70 +661,66 @@ created under this resource group. * **properties**: [AzureADPartnerClientAuthenticationProperties](#azureadpartnerclientauthenticationproperties): Properties of an Azure Active Directory Partner Client Authentication. -## AzureADPartnerClientAuthenticationProperties +## PartnerConfigurationProperties ### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **partnerAuthorization**: [PartnerAuthorization](#partnerauthorization): The partner authorization details. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the partner configuration. -## PartnerTopicInfo +## PartnerConfigurationTags ### Properties -* **azureSubscriptionId**: string: Azure subscription ID of the subscriber. The partner topic associated with the channel will be -created under this Azure subscription. -* **eventTypeInfo**: [EventTypeInfo](#eventtypeinfo): The event type information for Channels. -* **name**: string: Name of the partner topic associated with the channel. -* **resourceGroupName**: string: Azure Resource Group of the subscriber. The partner topic associated with the channel will be -created under this resource group. -* **source**: string: The source information is provided by the publisher to determine the scope or context from which the events -are originating. This information can be used by the subscriber during the approval process of the -created partner topic. +### Additional Properties +* **Additional Properties Type**: string -## EventTypeInfo -### Properties -* **inlineEventTypes**: [EventTypeInfoInlineEventTypes](#eventtypeinfoinlineeventtypes): A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. -An example of a valid inline event name is "Contoso.OrderCreated". -The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type. -* **kind**: 'Inline' | string: The kind of event type used. +## PartnerDestinationInfo +* **Discriminator**: endpointType -## EventTypeInfoInlineEventTypes -### Properties -### Additional Properties -* **Additional Properties Type**: [InlineEventProperties](#inlineeventproperties) +### Base Properties +* **azureSubscriptionId**: string: Azure subscription ID of the subscriber. The partner destination associated with the channel will be +created under this Azure subscription. +* **endpointServiceContext**: string: Additional context of the partner destination endpoint. +* **name**: string: Name of the partner destination associated with the channel. +* **resourceGroupName**: string: Azure Resource Group of the subscriber. The partner destination associated with the channel will be +created under this resource group. +* **resourceMoveChangeHistory**: [ResourceMoveChangeHistory](#resourcemovechangehistory)[]: Change history of the resource move. +### WebhookPartnerDestinationInfo +#### Properties +* **endpointType**: 'WebHook' (Required): Type of the endpoint for the partner destination +* **properties**: [WebhookPartnerDestinationProperties](#webhookpartnerdestinationproperties): Properties of a partner destination webhook. -## InlineEventProperties -### Properties -* **dataSchemaUrl**: string: The dataSchemaUrl for the inline event. -* **description**: string: The description for the inline event. -* **documentationUrl**: string: The documentationUrl for the inline event. -## EventChannelProperties +## PartnerDestinationProperties ### Properties -* **destination**: [EventChannelDestination](#eventchanneldestination): Properties of the destination of an event channel. -* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated, -the event channel and corresponding partner topic are deleted. -* **filter**: [EventChannelFilter](#eventchannelfilter): Filter for the Event Channel. -* **partnerTopicFriendlyDescription**: string: Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. -This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer. -* **partnerTopicReadinessState**: 'ActivatedByUser' | 'DeactivatedByUser' | 'DeletedByUser' | 'NotActivatedByUserYet' | string (ReadOnly): The readiness state of the corresponding partner topic. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event channel. -* **source**: [EventChannelSource](#eventchannelsource): Properties of the source of an event channel. +* **activationState**: 'Activated' | 'NeverActivated' | string: Activation state of the partner destination. +* **endpointBaseUrl**: string: Endpoint Base URL of the partner destination +* **endpointServiceContext**: string: Endpoint context associated with this partner destination. +* **expirationTimeIfNotActivatedUtc**: string: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, +the partner destination and corresponding channel are deleted. +* **messageForActivation**: string: Context or helpful message that can be used during the approval process. +* **partnerRegistrationImmutableId**: string: The immutable Id of the corresponding partner registration. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the partner destination. -## EventChannelDestination +## PartnerEventSubscriptionDestinationProperties ### Properties -* **azureSubscriptionId**: string: Azure subscription ID of the customer creating the event channel. The partner topic -associated with the event channel will be created under this Azure subscription. -* **partnerTopicName**: string: Name of the partner topic associated with the event channel. -* **resourceGroup**: string: Azure Resource Group of the customer creating the event channel. The partner topic -associated with the event channel will be created under this resource group. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of a Partner Destination of an event subscription. -## EventChannelFilter +## PartnerNamespaceProperties ### Properties -* **advancedFilters**: [AdvancedFilter](#advancedfilter)[]: An array of advanced filters that are used for filtering event channels. -* **enableAdvancedFilteringOnArrays**: bool: Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null. +* **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace. +* **endpoint**: string (ReadOnly): Endpoint for the partner namespace. +* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. +* **partnerRegistrationFullyQualifiedId**: string: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. +* **partnerTopicRoutingMode**: 'ChannelNameHeader' | 'SourceEventAttribute' | string: This determines if events published to this partner namespace should use the source attribute in the event payload +or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Array of PrivateEndpointConnection +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the partner namespace. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. +You can further restrict to specific IPs by configuring -## EventChannelSource +## PartnerNamespaceSharedAccessKeys ### Properties -* **source**: string: The identifier of the resource that's the source of the events. -This represents a unique resource in the partner's resource model. +* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. +* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. ## PartnerRegistrationProperties ### Properties @@ -848,10 +747,17 @@ length cannot exceed 16 digits including country code. Examples of valid phone n integration on an event source. * **visibilityState**: 'GenerallyAvailable' | 'Hidden' | 'PublicPreview' | string: Visibility state of the partner registration. -## TrackedResourceTags +## PartnerTopicInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureSubscriptionId**: string: Azure subscription ID of the subscriber. The partner topic associated with the channel will be +created under this Azure subscription. +* **eventTypeInfo**: [EventTypeInfo](#eventtypeinfo): The event type information for Channels. +* **name**: string: Name of the partner topic associated with the channel. +* **resourceGroupName**: string: Azure Resource Group of the subscriber. The partner topic associated with the channel will be +created under this resource group. +* **source**: string: The source information is provided by the publisher to determine the scope or context from which the events +are originating. This information can be used by the subscriber during the approval process of the +created partner topic. ## PartnerTopicProperties ### Properties @@ -866,10 +772,73 @@ This will be helpful to remove any ambiguity of the origin of creation of the pa * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the partner topic. * **source**: string: Source associated with this partner topic. This represents a unique partner resource. -## TrackedResourceTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified identifier of the resource. +* **name**: string (ReadOnly): Name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **type**: string (ReadOnly): Type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: GroupIds from the private link service resource. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## ResourceMoveChangeHistory +### Properties +* **azureSubscriptionId**: string: Azure subscription ID of the resource. +* **changedTimeUtc**: string: UTC timestamp of when the resource was changed. +* **resourceGroupName**: string: Azure Resource Group of the resource. + +## ResourceSku +### Properties +* **name**: 'Basic' | 'Premium' | string: The Sku name of the resource. The possible values are: Basic or Premium. + +## RetryPolicy +### Properties +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. + +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. + +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. + +## StaticDeliveryAttributeMappingProperties +### Properties +* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . +* **value**: string: Value of the delivery attribute. + +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events + +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## SystemTopicProperties ### Properties @@ -878,16 +847,6 @@ This will be helpful to remove any ambiguity of the origin of creation of the pa * **source**: string: Source for the system topic. * **topicType**: string: TopicType for the system topic. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExtendedLocation -### Properties -* **name**: string: Fully qualified name of the extended location. -* **type**: string: Type of the extended location. - ## TopicProperties ### Properties * **dataResidencyBoundary**: 'WithinGeopair' | 'WithinRegion' | string: Data Residency Boundary of the resource. @@ -902,23 +861,64 @@ This will be helpful to remove any ambiguity of the origin of creation of the pa * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## PartnerNamespaceSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the partner namespace. -* **key2**: string (ReadOnly): Shared access key2 for the partner namespace. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## WebHookEventSubscriptionDestinationProperties +### Properties +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. + +## WebhookPartnerDestinationProperties +### Properties +* **clientAuthentication**: [PartnerClientAuthentication](#partnerclientauthentication): Partner client authentication +* **endpointBaseUrl**: string: The base URL that represents the endpoint of the partner destination. +* **endpointUrl**: string: The URL that represents the endpoint of the partner destination. diff --git a/generated/eventgrid/microsoft.eventgrid/2021-12-01/types.md b/generated/eventgrid/microsoft.eventgrid/2021-12-01/types.md index 33cd02713e..7b45eb4cf8 100644 --- a/generated/eventgrid/microsoft.eventgrid/2021-12-01/types.md +++ b/generated/eventgrid/microsoft.eventgrid/2021-12-01/types.md @@ -97,149 +97,117 @@ * **ApiVersion**: 2021-12-01 * **Output**: [TopicSharedAccessKeys](#topicsharedaccesskeys) -## IdentityInfo -### Properties -* **principalId**: string: The principal ID of resource identity. -* **tenantId**: string: The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. -This property is currently not used and reserved for future usage. +## AdvancedFilter +* **Discriminator**: operatorType -## IdentityInfoUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +### Base Properties +* **key**: string: The field/property in the event based on which you want to filter. +### BoolEqualsAdvancedFilter +#### Properties +* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: bool: The boolean filter value. -## UserIdentityProperties -### Properties -* **clientId**: string: The client id of user assigned identity. -* **principalId**: string: The principal id of user assigned identity. +### IsNotNullAdvancedFilter +#### Properties +* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -## DomainProperties -### Properties -* **autoCreateTopicWithFirstSubscription**: bool: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. -In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. -When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is -created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic -by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the -flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the -domain topic on demand if needed. -* **autoDeleteTopicWithLastSubscription**: bool: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. -In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. -When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope -of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed -(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full -control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer -resources by the user. -* **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. -* **endpoint**: string (ReadOnly): Endpoint for the domain. -* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. -* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. -* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. -* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Event Grid Domain Resource. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. -You can further restrict to specific IPs by configuring +### IsNullOrUndefinedAdvancedFilter +#### Properties +* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -## InboundIpRule -### Properties -* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. -* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. +### NumberGreaterThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## InputSchemaMapping -* **Discriminator**: inputSchemaMappingType +### NumberGreaterThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -### Base Properties -### JsonInputSchemaMapping +### NumberInAdvancedFilter #### Properties -* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping -* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. +* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. +### NumberInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. -## JsonInputSchemaMappingProperties -### Properties -* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **eventTime**: [JsonField](#jsonfield): 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. -* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **id**: [JsonField](#jsonfield): 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. -* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. -* **topic**: [JsonField](#jsonfield): 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. +### NumberLessThanAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonFieldWithDefault -### Properties -* **defaultValue**: string: 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. -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberLessThanOrEqualsAdvancedFilter +#### Properties +* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **value**: int: The filter value. -## JsonField -### Properties -* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. +### NumberNotInAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[]: The set of filter values. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified identifier of the resource. -* **name**: string (ReadOnly): Name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **type**: string (ReadOnly): Type of the resource. +### NumberNotInRangeAdvancedFilter +#### Properties +* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: int[][]: The set of filter values. -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[]: GroupIds from the private link service resource. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +### StringBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. +### StringContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## ConnectionState -### Properties -* **actionsRequired**: string: Actions required (if any). -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +### StringEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### StringInAdvancedFilter +#### Properties +* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### StringNotBeginsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. -## DomainTopicProperties +### StringNotContainsAdvancedFilter +#### Properties +* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotEndsWithAdvancedFilter +#### Properties +* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + +### StringNotInAdvancedFilter +#### Properties +* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +* **values**: string[]: The set of filter values. + + +## AzureFunctionEventSubscriptionDestinationProperties ### Properties -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. -## EventSubscriptionProperties +## ConnectionState ### Properties -* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. -* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. -* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. -* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. -* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. -* **expirationTimeUtc**: string: Expiration time of the event subscription. -* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. -* **labels**: string[]: List of user defined labels. -* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. -* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. -* **topic**: string (ReadOnly): Name of the topic of the event subscription. +* **actionsRequired**: string: Actions required (if any). +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. ## DeadLetterDestination * **Discriminator**: endpointType @@ -251,26 +219,77 @@ along with a default value to be used, and at least one of these two properties * **properties**: [StorageBlobDeadLetterDestinationProperties](#storageblobdeadletterdestinationproperties): Properties of the storage blob based dead letter destination. -## StorageBlobDeadLetterDestinationProperties -### Properties -* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events -* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events - ## DeadLetterWithResourceIdentity ### Properties * **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. * **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. -## EventSubscriptionIdentity -### Properties -* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. -* **userAssignedIdentity**: string: The user identity associated with the resource. +## DeliveryAttributeMapping +* **Discriminator**: type + +### Base Properties +* **name**: string: Name of the delivery attribute or header. +### DynamicDeliveryAttributeMapping +#### Properties +* **properties**: [DynamicDeliveryAttributeMappingProperties](#dynamicdeliveryattributemappingproperties): Properties of dynamic delivery attribute mapping. +* **type**: 'Dynamic' (Required): Type of the delivery attribute or header name. + +### StaticDeliveryAttributeMapping +#### Properties +* **properties**: [StaticDeliveryAttributeMappingProperties](#staticdeliveryattributemappingproperties): Properties of static delivery attribute mapping. +* **type**: 'Static' (Required): Type of the delivery attribute or header name. + ## DeliveryWithResourceIdentity ### Properties * **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. * **identity**: [EventSubscriptionIdentity](#eventsubscriptionidentity): The identity information with the event subscription. +## DomainProperties +### Properties +* **autoCreateTopicWithFirstSubscription**: bool: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. +In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. +When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is +created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic +by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the +flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the +domain topic on demand if needed. +* **autoDeleteTopicWithLastSubscription**: bool: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. +In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. +When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope +of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed +(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full +control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer +resources by the user. +* **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. +* **endpoint**: string (ReadOnly): Endpoint for the domain. +* **inboundIpRules**: [InboundIpRule](#inboundiprule)[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. +* **inputSchema**: 'CloudEventSchemaV1_0' | 'CustomEventSchema' | 'EventGridSchema' | string: This determines the format that Event Grid should expect for incoming events published to the domain. +* **inputSchemaMapping**: [InputSchemaMapping](#inputschemamapping): 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'. +* **metricResourceId**: string (ReadOnly): Metric resource id for the domain. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the Event Grid Domain Resource. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. +You can further restrict to specific IPs by configuring + +## DomainSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the domain. +* **key2**: string (ReadOnly): Shared access key2 for the domain. + +## DomainTopicProperties +### Properties +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the domain topic. + +## DynamicDeliveryAttributeMappingProperties +### Properties +* **sourceField**: string: JSON path in the event which contains attribute value. + +## EventHubEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. + ## EventSubscriptionDestination * **Discriminator**: endpointType @@ -297,87 +316,19 @@ along with a default value to be used, and at least one of these two properties ### ServiceBusTopicEventSubscriptionDestination #### Properties -* **endpointType**: 'ServiceBusTopic' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [ServiceBusTopicEventSubscriptionDestinationProperties](#servicebustopiceventsubscriptiondestinationproperties): The properties that represent the Service Bus Topic destination of an event subscription. - -### StorageQueueEventSubscriptionDestination -#### Properties -* **endpointType**: 'StorageQueue' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [StorageQueueEventSubscriptionDestinationProperties](#storagequeueeventsubscriptiondestinationproperties): The properties for a storage queue destination. - -### WebHookEventSubscriptionDestination -#### Properties -* **endpointType**: 'WebHook' (Required): Type of the endpoint for the event subscription destination. -* **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. - - -## AzureFunctionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. - -## DeliveryAttributeMapping -* **Discriminator**: type - -### Base Properties -* **name**: string: Name of the delivery attribute or header. -### DynamicDeliveryAttributeMapping -#### Properties -* **properties**: [DynamicDeliveryAttributeMappingProperties](#dynamicdeliveryattributemappingproperties): Properties of dynamic delivery attribute mapping. -* **type**: 'Dynamic' (Required): Type of the delivery attribute or header name. - -### StaticDeliveryAttributeMapping -#### Properties -* **properties**: [StaticDeliveryAttributeMappingProperties](#staticdeliveryattributemappingproperties): Properties of static delivery attribute mapping. -* **type**: 'Static' (Required): Type of the delivery attribute or header name. - - -## DynamicDeliveryAttributeMappingProperties -### Properties -* **sourceField**: string: JSON path in the event which contains attribute value. - -## StaticDeliveryAttributeMappingProperties -### Properties -* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . -* **value**: string: Value of the delivery attribute. - -## EventHubEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. - -## HybridConnectionEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. - -## ServiceBusQueueEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. - -## ServiceBusTopicEventSubscriptionDestinationProperties -### Properties -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. +* **endpointType**: 'ServiceBusTopic' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [ServiceBusTopicEventSubscriptionDestinationProperties](#servicebustopiceventsubscriptiondestinationproperties): The properties that represent the Service Bus Topic destination of an event subscription. -## StorageQueueEventSubscriptionDestinationProperties -### Properties -* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. -* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. -* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. +### StorageQueueEventSubscriptionDestination +#### Properties +* **endpointType**: 'StorageQueue' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [StorageQueueEventSubscriptionDestinationProperties](#storagequeueeventsubscriptiondestinationproperties): The properties for a storage queue destination. + +### WebHookEventSubscriptionDestination +#### Properties +* **endpointType**: 'WebHook' (Required): Type of the endpoint for the event subscription destination. +* **properties**: [WebHookEventSubscriptionDestinationProperties](#webhookeventsubscriptiondestinationproperties): Information about the webhook destination properties for an event subscription. -## WebHookEventSubscriptionDestinationProperties -### Properties -* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. -* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. -* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. -* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. -* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. -* **maxEventsPerBatch**: int: Maximum number of events per batch. -* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. ## EventSubscriptionFilter ### Properties @@ -392,109 +343,143 @@ Wildcard characters are not supported in this path. * **subjectEndsWith**: 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. -## AdvancedFilter -* **Discriminator**: operatorType +## EventSubscriptionIdentity +### Properties +* **type**: 'SystemAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentity**: string: The user identity associated with the resource. -### Base Properties -* **key**: string: The field/property in the event based on which you want to filter. -### BoolEqualsAdvancedFilter -#### Properties -* **operatorType**: 'BoolEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: bool: The boolean filter value. +## EventSubscriptionProperties +### Properties +* **deadLetterDestination**: [DeadLetterDestination](#deadletterdestination): 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. +* **deadLetterWithResourceIdentity**: [DeadLetterWithResourceIdentity](#deadletterwithresourceidentity): Information about the deadletter destination with resource identity. +* **deliveryWithResourceIdentity**: [DeliveryWithResourceIdentity](#deliverywithresourceidentity): Information about the delivery for an event subscription with resource identity. +* **destination**: [EventSubscriptionDestination](#eventsubscriptiondestination): Information about the destination for an event subscription. +* **eventDeliverySchema**: 'CloudEventSchemaV1_0' | 'CustomInputSchema' | 'EventGridSchema' | string: The event delivery schema for the event subscription. +* **expirationTimeUtc**: string: Expiration time of the event subscription. +* **filter**: [EventSubscriptionFilter](#eventsubscriptionfilter): Filter for the Event Subscription. +* **labels**: string[]: List of user defined labels. +* **provisioningState**: 'AwaitingManualAction' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the event subscription. +* **retryPolicy**: [RetryPolicy](#retrypolicy): Information about the retry policy for an event subscription. +* **topic**: string (ReadOnly): Name of the topic of the event subscription. -### IsNotNullAdvancedFilter -#### Properties -* **operatorType**: 'IsNotNull' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +## HybridConnectionEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource ID of an hybrid connection that is the destination of an event subscription. -### IsNullOrUndefinedAdvancedFilter -#### Properties -* **operatorType**: 'IsNullOrUndefined' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. +## IdentityInfo +### Properties +* **principalId**: string: The principal ID of resource identity. +* **tenantId**: string: The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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 any identity. +* **userAssignedIdentities**: [IdentityInfoUserAssignedIdentities](#identityinfouserassignedidentities): The list of user 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}'. +This property is currently not used and reserved for future usage. -### NumberGreaterThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## IdentityInfoUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) -### NumberGreaterThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberGreaterThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## InboundIpRule +### Properties +* **action**: 'Allow' | string: Action to perform based on the match or no match of the IpMask. +* **ipMask**: string: IP Address in CIDR notation e.g., 10.0.0.0/8. -### NumberInAdvancedFilter -#### Properties -* **operatorType**: 'NumberIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## InputSchemaMapping +* **Discriminator**: inputSchemaMappingType -### NumberInRangeAdvancedFilter +### Base Properties +### JsonInputSchemaMapping #### Properties -* **operatorType**: 'NumberInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. +* **inputSchemaMappingType**: 'Json' (Required): Type of the custom mapping +* **properties**: [JsonInputSchemaMappingProperties](#jsoninputschemamappingproperties): This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema. -### NumberLessThanAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThan' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. -### NumberLessThanOrEqualsAdvancedFilter -#### Properties -* **operatorType**: 'NumberLessThanOrEquals' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **value**: int: The filter value. +## JsonField +### Properties +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### NumberNotInAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[]: The set of filter values. +## JsonFieldWithDefault +### Properties +* **defaultValue**: string: 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. +* **sourceField**: string: Name of a field in the input event schema that's to be used as the source of a mapping. -### NumberNotInRangeAdvancedFilter -#### Properties -* **operatorType**: 'NumberNotInRange' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: int[][]: The set of filter values. +## JsonInputSchemaMappingProperties +### Properties +* **dataVersion**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **eventTime**: [JsonField](#jsonfield): 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. +* **eventType**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **id**: [JsonField](#jsonfield): 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. +* **subject**: [JsonFieldWithDefault](#jsonfieldwithdefault): 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. +* **topic**: [JsonField](#jsonfield): 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. -### StringBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## PrivateEndpoint +### Properties +* **id**: string: The ARM identifier for Private Endpoint. -### StringContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified identifier of the resource. +* **name**: string (ReadOnly): Name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **type**: string (ReadOnly): Type of the resource. -### StringEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## PrivateEndpointConnectionProperties +### Properties +* **groupIds**: string[]: GroupIds from the private link service resource. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. -### StringInAdvancedFilter -#### Properties -* **operatorType**: 'StringIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## RetryPolicy +### Properties +* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. +* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. -### StringNotBeginsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringNotBeginsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## ServiceBusQueueEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. -### StringNotContainsAdvancedFilter -#### Properties -* **operatorType**: 'StringNotContains' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## ServiceBusTopicEventSubscriptionDestinationProperties +### Properties +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **resourceId**: string: The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. -### StringNotEndsWithAdvancedFilter -#### Properties -* **operatorType**: 'StringNotEndsWith' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## StaticDeliveryAttributeMappingProperties +### Properties +* **isSecret**: bool: Boolean flag to tell if the attribute contains sensitive information . +* **value**: string: Value of the delivery attribute. -### StringNotInAdvancedFilter -#### Properties -* **operatorType**: 'StringNotIn' (Required): The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. -* **values**: string[]: The set of filter values. +## StorageBlobDeadLetterDestinationProperties +### Properties +* **blobContainerName**: string: The name of the Storage blob container that is the destination of the deadletter events +* **resourceId**: string: The Azure Resource ID of the storage account that is the destination of the deadletter events +## StorageQueueEventSubscriptionDestinationProperties +### Properties +* **queueMessageTimeToLiveInSeconds**: int: Storage queue message time to live in seconds. +* **queueName**: string: The name of the Storage queue under a storage account that is the destination of an event subscription. +* **resourceId**: string: The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. -## RetryPolicy +## SystemData ### Properties -* **eventTimeToLiveInMinutes**: int: Time To Live (in minutes) for events. -* **maxDeliveryAttempts**: int: Maximum number of delivery retry attempts for events. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## SystemTopicProperties ### Properties @@ -503,11 +488,6 @@ Wildcard characters are not supported in this path. * **source**: string: Source for the system topic. * **topicType**: string: TopicType for the system topic. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TopicProperties ### Properties * **disableLocalAuth**: bool: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic. @@ -521,18 +501,38 @@ Wildcard characters are not supported in this path. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring +## TopicSharedAccessKeys +### Properties +* **key1**: string (ReadOnly): Shared access key1 for the topic. +* **key2**: string (ReadOnly): Shared access key2 for the topic. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the domain. -* **key2**: string (ReadOnly): Shared access key2 for the domain. +### Additional Properties +* **Additional Properties Type**: string -## TopicSharedAccessKeys +## TrackedResourceTags ### Properties -* **key1**: string (ReadOnly): Shared access key1 for the topic. -* **key2**: string (ReadOnly): Shared access key2 for the topic. +### Additional Properties +* **Additional Properties Type**: string + +## UserIdentityProperties +### Properties +* **clientId**: string: The client id of user assigned identity. +* **principalId**: string: The principal id of user assigned identity. + +## WebHookEventSubscriptionDestinationProperties +### Properties +* **azureActiveDirectoryApplicationIdOrUri**: string: The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. +* **azureActiveDirectoryTenantId**: string: The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. +* **deliveryAttributeMappings**: [DeliveryAttributeMapping](#deliveryattributemapping)[]: Delivery attribute details. +* **endpointBaseUrl**: string (ReadOnly): The base URL that represents the endpoint of the destination of an event subscription. +* **endpointUrl**: string: The URL that represents the endpoint of the destination of an event subscription. +* **maxEventsPerBatch**: int: Maximum number of events per batch. +* **preferredBatchSizeInKilobytes**: int: Preferred batch size in Kilobytes. diff --git a/generated/eventhub/log.out b/generated/eventhub/log.out index 408325dc21..bf8291add1 100644 --- a/generated/eventhub/log.out +++ b/generated/eventhub/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.eventhub-2017-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AuthorizationRuleListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json:769:5 @@ -87,11 +87,11 @@ warning | PreCheck/SchemaMissingType | The schema 'MessagingRegionsListResult' w warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.eventhub-2015-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json:1292:5 @@ -145,11 +145,11 @@ warning | PreCheck/SchemaMissingType | The schema 'NamespaceUpdateParameter' wit - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json:1898:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrackedResource' has a property 'location' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from TrackedResource -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.eventhub-2014-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2014-09-01/EventHub.json:1079:5 @@ -203,11 +203,11 @@ warning | PreCheck/SchemaMissingType | The schema 'NamespaceUpdateParameter' wit - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2014-09-01/EventHub.json:1708:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrackedResource' has a property 'location' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from TrackedResource -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.eventhub-2021-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'EHNamespaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json:578:5 @@ -298,11 +298,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.eventhub-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'EHNamespaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json:578:5 @@ -391,11 +391,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.eventhub-2018-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableClustersList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json:75:5 @@ -520,7 +520,7 @@ info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.eventhub-2021-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'EHNamespaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2021-11-01/namespaces-preview.json:578:5 @@ -607,5 +607,5 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms -info | Autorest completed in 24.27s. 14 files generated. +info | autorest.bicep took 9ms +info | Autorest completed in 24.21s. 14 files generated. diff --git a/generated/eventhub/microsoft.eventhub/2014-09-01/types.md b/generated/eventhub/microsoft.eventhub/2014-09-01/types.md index 90b01d9e5c..37517fdcf9 100644 --- a/generated/eventhub/microsoft.eventhub/2014-09-01/types.md +++ b/generated/eventhub/microsoft.eventhub/2014-09-01/types.md @@ -52,6 +52,27 @@ * **properties**: [ConsumerGroupProperties](#consumergroupproperties): Properties supplied to the Create Or Update Consumer Group operation. * **type**: 'Microsoft.EventHub/namespaces/eventhubs/consumergroups' (ReadOnly, DeployTimeConstant): The resource type +## ConsumerGroupProperties +### Properties +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **eventHubPath**: string (ReadOnly): The path of the Event Hub. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: The user metadata. + +## EventHubProperties +### Properties +* **createdAt**: string (ReadOnly): Exact time the Event Hub was created. +* **messageRetentionInDays**: int: Number of days to retain the events for this Event Hub. +* **partitionCount**: int: Number of partitions created for the Event Hub. +* **partitionIds**: string[] (ReadOnly): Current number of shards on the Event Hub. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. + +## NamespaceCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## NamespaceProperties ### Properties * **createdAt**: string: The time the Namespace was created. @@ -62,34 +83,13 @@ * **status**: 'Activating' | 'Active' | 'Created' | 'Creating' | 'Disabled' | 'Disabling' | 'Enabling' | 'Failed' | 'Removed' | 'Removing' | 'SoftDeleted' | 'SoftDeleting' | 'Unknown': State of the Namespace. * **updatedAt**: string: The time the Namespace was updated. -## Sku -### Properties -* **capacity**: int: The Event Hubs throughput units. -* **name**: 'Basic' | 'Standard' | string: Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): The billing tier of this particular SKU. - -## NamespaceCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SharedAccessAuthorizationRuleProperties ### Properties * **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. -## EventHubProperties -### Properties -* **createdAt**: string (ReadOnly): Exact time the Event Hub was created. -* **messageRetentionInDays**: int: Number of days to retain the events for this Event Hub. -* **partitionCount**: int: Number of partitions created for the Event Hub. -* **partitionIds**: string[] (ReadOnly): Current number of shards on the Event Hub. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. - -## ConsumerGroupProperties +## Sku ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **eventHubPath**: string (ReadOnly): The path of the Event Hub. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: The user metadata. +* **capacity**: int: The Event Hubs throughput units. +* **name**: 'Basic' | 'Standard' | string: Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): The billing tier of this particular SKU. diff --git a/generated/eventhub/microsoft.eventhub/2015-08-01/types.md b/generated/eventhub/microsoft.eventhub/2015-08-01/types.md index 9c51aa45cd..cf09104876 100644 --- a/generated/eventhub/microsoft.eventhub/2015-08-01/types.md +++ b/generated/eventhub/microsoft.eventhub/2015-08-01/types.md @@ -62,30 +62,12 @@ * **ApiVersion**: 2015-08-01 * **Output**: [ResourceListKeys](#resourcelistkeys) -## NamespaceProperties -### Properties -* **createdAt**: string: The time the Namespace was created. -* **enabled**: bool: Specifies whether this instance is enabled. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **provisioningState**: string: Provisioning state of the Namespace. -* **serviceBusEndpoint**: string: Endpoint you can use to perform Service Bus operations. -* **status**: 'Activating' | 'Active' | 'Created' | 'Creating' | 'Disabled' | 'Disabling' | 'Enabling' | 'Failed' | 'Removed' | 'Removing' | 'SoftDeleted' | 'SoftDeleting' | 'Unknown': State of the Namespace. -* **updatedAt**: string: The time the Namespace was updated. - -## Sku -### Properties -* **capacity**: int: The Event Hubs throughput units. -* **name**: 'Basic' | 'Standard' | string: Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): The billing tier of this particular SKU. - -## NamespaceCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessAuthorizationRuleProperties +## ConsumerGroupProperties ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **eventHubPath**: string (ReadOnly): The path of the Event Hub. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: The user metadata. ## EventHubProperties ### Properties @@ -96,12 +78,20 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## ConsumerGroupProperties +## NamespaceCreateOrUpdateParametersTags ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **eventHubPath**: string (ReadOnly): The path of the Event Hub. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: The user metadata. +### Additional Properties +* **Additional Properties Type**: string + +## NamespaceProperties +### Properties +* **createdAt**: string: The time the Namespace was created. +* **enabled**: bool: Specifies whether this instance is enabled. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **provisioningState**: string: Provisioning state of the Namespace. +* **serviceBusEndpoint**: string: Endpoint you can use to perform Service Bus operations. +* **status**: 'Activating' | 'Active' | 'Created' | 'Creating' | 'Disabled' | 'Disabling' | 'Enabling' | 'Failed' | 'Removed' | 'Removing' | 'SoftDeleted' | 'SoftDeleting' | 'Unknown': State of the Namespace. +* **updatedAt**: string: The time the Namespace was updated. ## ResourceListKeys ### Properties @@ -119,3 +109,13 @@ * **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created Namespace AuthorizationRule. * **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +## SharedAccessAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## Sku +### Properties +* **capacity**: int: The Event Hubs throughput units. +* **name**: 'Basic' | 'Standard' | string: Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): The billing tier of this particular SKU. + diff --git a/generated/eventhub/microsoft.eventhub/2017-04-01/types.md b/generated/eventhub/microsoft.eventhub/2017-04-01/types.md index f0a750c649..a1175f8023 100644 --- a/generated/eventhub/microsoft.eventhub/2017-04-01/types.md +++ b/generated/eventhub/microsoft.eventhub/2017-04-01/types.md @@ -81,31 +81,35 @@ * **ApiVersion**: 2017-04-01 * **Output**: [AccessKeys](#accesskeys) -## EHNamespaceProperties -### Properties -* **createdAt**: string (ReadOnly): The time the Namespace was created. -* **isAutoInflateEnabled**: bool: Value that indicates whether AutoInflate is enabled for eventhub namespace. -* **kafkaEnabled**: bool: Value that indicates whether Kafka is enabled for eventhub namespace. -* **maximumThroughputUnits**: int: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. -* **provisioningState**: string (ReadOnly): Provisioning state of the Namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **updatedAt**: string (ReadOnly): The time the Namespace was updated. - -## Sku +## AccessKeys ### Properties -* **capacity**: int: The Event Hubs throughput units, value should be 0 to 20 throughput units. -* **name**: 'Basic' | 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Basic' | 'Standard' | string: The billing tier of this particular SKU. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## TrackedResourceTags +## AccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## AuthorizationRuleProperties +## AccessKeys ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. ## ArmDisasterRecoveryProperties ### Properties @@ -115,15 +119,9 @@ * **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' * **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' -## EventhubProperties +## AuthorizationRuleProperties ### Properties -* **captureDescription**: [CaptureDescription](#capturedescription): Properties to configure capture description for eventhub -* **createdAt**: string (ReadOnly): Exact time the Event Hub was created. -* **messageRetentionInDays**: int: Number of days to retain the events for this Event Hub, value should be 1 to 7 days -* **partitionCount**: int: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. -* **partitionIds**: string[] (ReadOnly): Current number of shards on the Event Hub. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. ## CaptureDescription ### Properties @@ -134,6 +132,12 @@ * **sizeLimitInBytes**: int: 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 * **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives +## ConsumerGroupProperties +### Properties +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: 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. + ## Destination ### Properties * **name**: string: Name for capture destination @@ -145,11 +149,26 @@ * **blobContainer**: string: Blob container Name * **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs -## ConsumerGroupProperties +## EHNamespaceProperties ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. +* **createdAt**: string (ReadOnly): The time the Namespace was created. +* **isAutoInflateEnabled**: bool: Value that indicates whether AutoInflate is enabled for eventhub namespace. +* **kafkaEnabled**: bool: Value that indicates whether Kafka is enabled for eventhub namespace. +* **maximumThroughputUnits**: int: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true) +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. +* **provisioningState**: string (ReadOnly): Provisioning state of the Namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **updatedAt**: string (ReadOnly): The time the Namespace was updated. + +## EventhubProperties +### Properties +* **captureDescription**: [CaptureDescription](#capturedescription): Properties to configure capture description for eventhub +* **createdAt**: string (ReadOnly): Exact time the Event Hub was created. +* **messageRetentionInDays**: int: Number of days to retain the events for this Event Hub, value should be 1 to 7 days +* **partitionCount**: int: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. +* **partitionIds**: string[] (ReadOnly): Current number of shards on the Event Hub. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: 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. ## NetworkRuleSetProperties ### Properties @@ -167,37 +186,18 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing VNet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet -### Properties -* **id**: string (Required): Resource ID of Virtual Network Subnet - -## AccessKeys +## Sku ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **capacity**: int: The Event Hubs throughput units, value should be 0 to 20 throughput units. +* **name**: 'Basic' | 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Basic' | 'Standard' | string: The billing tier of this particular SKU. -## AccessKeys +## Subnet ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **id**: string (Required): Resource ID of Virtual Network Subnet -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/eventhub/microsoft.eventhub/2018-01-01-preview/types.md b/generated/eventhub/microsoft.eventhub/2018-01-01-preview/types.md index ca21f624ef..c2a0a72c73 100644 --- a/generated/eventhub/microsoft.eventhub/2018-01-01-preview/types.md +++ b/generated/eventhub/microsoft.eventhub/2018-01-01-preview/types.md @@ -121,6 +121,57 @@ * **ApiVersion**: 2018-01-01-preview * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## ArmDisasterRecoveryProperties +### Properties +* **alternateName**: string: Alternate name specified when alias and namespace names are same. +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' + +## AuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. + +## CaptureDescription +### Properties +* **destination**: [Destination](#destination): Capture storage details for capture description +* **enabled**: bool: A value that indicates whether capture description is enabled. +* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version +* **intervalInSeconds**: int: 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 +* **sizeLimitInBytes**: int: 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 +* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives + ## ClusterProperties ### Properties * **createdAt**: string (ReadOnly): The UTC time when the Event Hubs Cluster was created. @@ -133,16 +184,27 @@ * **capacity**: int: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. * **name**: 'Dedicated' | string (Required): Name of this SKU. -## TrackedResourceTags +## ConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## Identity +## ConsumerGroupProperties ### Properties -* **principalId**: string: ObjectId from the KeyVault -* **tenantId**: string: TenantId from the KeyVault -* **type**: 'SystemAssigned': Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: 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. + +## Destination +### Properties +* **name**: string: Name for capture destination +* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination + +## DestinationProperties +### Properties +* **archiveNameFormat**: string: 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 +* **blobContainer**: string: Blob container Name +* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs ## EHNamespaceProperties ### Properties @@ -164,35 +226,6 @@ * **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault -## KeyVaultProperties -### Properties -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Key Version - -## Sku -### Properties -* **capacity**: int: The Event Hubs throughput units, value should be 0 to 20 throughput units. -* **name**: 'Basic' | 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Basic' | 'Standard' | string: The billing tier of this particular SKU. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. - -## ArmDisasterRecoveryProperties -### Properties -* **alternateName**: string: Alternate name specified when alias and namespace names are same. -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' - ## EventhubProperties ### Properties * **captureDescription**: [CaptureDescription](#capturedescription): Properties to configure capture description for eventhub @@ -203,31 +236,11 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## CaptureDescription -### Properties -* **destination**: [Destination](#destination): Capture storage details for capture description -* **enabled**: bool: A value that indicates whether capture description is enabled. -* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version -* **intervalInSeconds**: int: 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 -* **sizeLimitInBytes**: int: 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 -* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives - -## Destination -### Properties -* **name**: string: Name for capture destination -* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination - -## DestinationProperties -### Properties -* **archiveNameFormat**: string: 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 -* **blobContainer**: string: Blob container Name -* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs - -## ConsumerGroupProperties +## Identity ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: 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. +* **principalId**: string: ObjectId from the KeyVault +* **tenantId**: string: TenantId from the KeyVault +* **type**: 'SystemAssigned': Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' ## IpFilterRuleProperties ### Properties @@ -235,6 +248,12 @@ * **filterName**: string: IP Filter name * **ipMask**: string: IP Mask +## KeyVaultProperties +### Properties +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Key Version + ## NetworkRuleSetProperties ### Properties * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set @@ -252,9 +271,9 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing Vnet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## PrivateEndpoint ### Properties -* **id**: string: Resource ID of Virtual Network Subnet +* **id**: string: The ARM identifier for Private Endpoint. ## PrivateEndpointConnectionProperties ### Properties @@ -262,46 +281,27 @@ * **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. - -## ConnectionState +## Sku ### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +* **capacity**: int: The Event Hubs throughput units, value should be 0 to 20 throughput units. +* **name**: 'Basic' | 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Basic' | 'Standard' | string: The billing tier of this particular SKU. -## VirtualNetworkRuleProperties +## Subnet ### Properties -* **virtualNetworkSubnetId**: string: ARM ID of Virtual Network Subnet +* **id**: string: Resource ID of Virtual Network Subnet -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## VirtualNetworkRuleProperties ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **virtualNetworkSubnetId**: string: ARM ID of Virtual Network Subnet diff --git a/generated/eventhub/microsoft.eventhub/2021-01-01-preview/types.md b/generated/eventhub/microsoft.eventhub/2021-01-01-preview/types.md index cc40f5b9a4..4952d1d5d8 100644 --- a/generated/eventhub/microsoft.eventhub/2021-01-01-preview/types.md +++ b/generated/eventhub/microsoft.eventhub/2021-01-01-preview/types.md @@ -99,23 +99,84 @@ * **ApiVersion**: 2021-01-01-preview * **Output**: [AccessKeys](#accesskeys) -## Identity +## AccessKeys ### Properties -* **principalId**: string (ReadOnly): ObjectId from the KeyVault -* **tenantId**: string (ReadOnly): TenantId from the KeyVault -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## IdentityUserAssignedIdentities +## AccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## ArmDisasterRecoveryProperties +### Properties +* **alternateName**: string: Alternate name specified when alias and namespace names are same. +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' + +## AuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. + +## CaptureDescription +### Properties +* **destination**: [Destination](#destination): Capture storage details for capture description +* **enabled**: bool: A value that indicates whether capture description is enabled. +* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version +* **intervalInSeconds**: int: 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 +* **sizeLimitInBytes**: int: 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 +* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives ## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): Client Id of user assigned identity * **principalId**: string (ReadOnly): Principal Id of user assigned identity +## ConnectionState +### Properties +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. + +## ConsumerGroupProperties +### Properties +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: 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. + +## Destination +### Properties +* **name**: string: Name for capture destination +* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination + +## DestinationProperties +### Properties +* **archiveNameFormat**: string: 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 +* **blobContainer**: string: Blob container Name +* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs + ## EHNamespaceProperties ### Properties * **clusterArmId**: string: Cluster ARM ID of the Namespace. @@ -138,72 +199,6 @@ * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault * **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) -## KeyVaultProperties -### Properties -* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Key Version - -## UserAssignedIdentityProperties -### Properties -* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. - -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. - -## ConnectionState -### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## Sku -### Properties -* **capacity**: int: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The billing tier of this particular SKU. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. - -## ArmDisasterRecoveryProperties -### Properties -* **alternateName**: string: Alternate name specified when alias and namespace names are same. -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' - ## EventhubProperties ### Properties * **captureDescription**: [CaptureDescription](#capturedescription): Properties to configure capture description for eventhub @@ -214,31 +209,24 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## CaptureDescription -### Properties -* **destination**: [Destination](#destination): Capture storage details for capture description -* **enabled**: bool: A value that indicates whether capture description is enabled. -* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version -* **intervalInSeconds**: int: 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 -* **sizeLimitInBytes**: int: 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 -* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives - -## Destination +## Identity ### Properties -* **name**: string: Name for capture destination -* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination +* **principalId**: string (ReadOnly): ObjectId from the KeyVault +* **tenantId**: string (ReadOnly): TenantId from the KeyVault +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities -## DestinationProperties +## IdentityUserAssignedIdentities ### Properties -* **archiveNameFormat**: string: 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 -* **blobContainer**: string: Blob container Name -* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) -## ConsumerGroupProperties +## KeyVaultProperties ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: 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. +* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Key Version ## NetworkRuleSetProperties ### Properties @@ -257,37 +245,49 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing Vnet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet +## PrivateEndpoint +### Properties +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## Sku +### Properties +* **capacity**: int: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The billing tier of this particular SKU. + ## Subnet ### Properties * **id**: string: Resource ID of Virtual Network Subnet -## AccessKeys +## SystemData ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## UserAssignedIdentityProperties ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption diff --git a/generated/eventhub/microsoft.eventhub/2021-06-01-preview/types.md b/generated/eventhub/microsoft.eventhub/2021-06-01-preview/types.md index e57f55a3c2..c6272aeefa 100644 --- a/generated/eventhub/microsoft.eventhub/2021-06-01-preview/types.md +++ b/generated/eventhub/microsoft.eventhub/2021-06-01-preview/types.md @@ -112,6 +112,57 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## ArmDisasterRecoveryProperties +### Properties +* **alternateName**: string: Alternate name specified when alias and namespace names are same. +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' + +## AuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. + +## CaptureDescription +### Properties +* **destination**: [Destination](#destination): Capture storage details for capture description +* **enabled**: bool: A value that indicates whether capture description is enabled. +* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version +* **intervalInSeconds**: int: 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 +* **sizeLimitInBytes**: int: 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 +* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives + ## ClusterProperties ### Properties * **createdAt**: string (ReadOnly): The UTC time when the Event Hubs Cluster was created. @@ -124,36 +175,27 @@ * **capacity**: int: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. * **name**: 'Dedicated' | string (Required): Name of this SKU. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## ConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## Identity +## ConsumerGroupProperties ### Properties -* **principalId**: string (ReadOnly): ObjectId from the KeyVault -* **tenantId**: string (ReadOnly): TenantId from the KeyVault -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: 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. -## IdentityUserAssignedIdentities +## Destination ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **name**: string: Name for capture destination +* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination -## UserAssignedIdentity +## DestinationProperties ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **archiveNameFormat**: string: 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 +* **blobContainer**: string: Blob container Name +* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs ## EHNamespaceProperties ### Properties @@ -178,63 +220,6 @@ * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault * **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) -## KeyVaultProperties -### Properties -* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Key Version - -## UserAssignedIdentityProperties -### Properties -* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. - -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. - -## ConnectionState -### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. - -## Sku -### Properties -* **capacity**: int: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The billing tier of this particular SKU. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. - -## ArmDisasterRecoveryProperties -### Properties -* **alternateName**: string: Alternate name specified when alias and namespace names are same. -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' - ## EventhubProperties ### Properties * **captureDescription**: [CaptureDescription](#capturedescription): Properties to configure capture description for eventhub @@ -245,31 +230,24 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## CaptureDescription -### Properties -* **destination**: [Destination](#destination): Capture storage details for capture description -* **enabled**: bool: A value that indicates whether capture description is enabled. -* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version -* **intervalInSeconds**: int: 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 -* **sizeLimitInBytes**: int: 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 -* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives - -## Destination +## Identity ### Properties -* **name**: string: Name for capture destination -* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination +* **principalId**: string (ReadOnly): ObjectId from the KeyVault +* **tenantId**: string (ReadOnly): TenantId from the KeyVault +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities -## DestinationProperties +## IdentityUserAssignedIdentities ### Properties -* **archiveNameFormat**: string: 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 -* **blobContainer**: string: Blob container Name -* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## ConsumerGroupProperties +## KeyVaultProperties ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: 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. +* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Key Version ## NetworkRuleSetProperties ### Properties @@ -289,37 +267,59 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing Vnet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet +## PrivateEndpoint +### Properties +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## Sku +### Properties +* **capacity**: int: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The billing tier of this particular SKU. + ## Subnet ### Properties * **id**: string: Resource ID of Virtual Network Subnet -## AccessKeys +## SystemData ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## UserAssignedIdentityProperties +### Properties +* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption diff --git a/generated/eventhub/microsoft.eventhub/2021-11-01/types.md b/generated/eventhub/microsoft.eventhub/2021-11-01/types.md index 2f520df0ed..77b451b5aa 100644 --- a/generated/eventhub/microsoft.eventhub/2021-11-01/types.md +++ b/generated/eventhub/microsoft.eventhub/2021-11-01/types.md @@ -130,6 +130,57 @@ * **ApiVersion**: 2021-11-01 * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## ArmDisasterRecoveryProperties +### Properties +* **alternateName**: string: Alternate name specified when alias and namespace names are same. +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' + +## AuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. + +## CaptureDescription +### Properties +* **destination**: [Destination](#destination): Capture storage details for capture description +* **enabled**: bool: A value that indicates whether capture description is enabled. +* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version +* **intervalInSeconds**: int: 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 +* **sizeLimitInBytes**: int: 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 +* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives + ## ClusterProperties ### Properties * **createdAt**: string (ReadOnly): The UTC time when the Event Hubs Cluster was created. @@ -142,36 +193,30 @@ * **capacity**: int: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. * **name**: 'Dedicated' | string (Required): Name of this SKU. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## ConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## Identity +## ConsumerGroupProperties ### Properties -* **principalId**: string (ReadOnly): ObjectId from the KeyVault -* **tenantId**: string (ReadOnly): TenantId from the KeyVault -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **userMetadata**: string: 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. -## IdentityUserAssignedIdentities +## Destination ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **name**: string: Name for capture destination +* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination -## UserAssignedIdentity +## DestinationProperties ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **archiveNameFormat**: string: 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 +* **blobContainer**: string: Blob container Name +* **dataLakeAccountName**: string: The Azure Data Lake Store name for the captured events +* **dataLakeFolderPath**: string: The destination folder path for the captured events +* **dataLakeSubscriptionId**: string: Subscription Id of Azure Data Lake Store +* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs ## EHNamespaceProperties ### Properties @@ -197,64 +242,6 @@ * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault * **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) -## KeyVaultProperties -### Properties -* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Key Version - -## UserAssignedIdentityProperties -### Properties -* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **location**: string (ReadOnly): The geo-location where the resource lives -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. - -## PrivateEndpoint -### Properties -* **id**: string: The ARM identifier for Private Endpoint. - -## ConnectionState -### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. - -## Sku -### Properties -* **capacity**: int: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The billing tier of this particular SKU. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. - -## ArmDisasterRecoveryProperties -### Properties -* **alternateName**: string: Alternate name specified when alias and namespace names are same. -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' - ## EventhubProperties ### Properties * **captureDescription**: [CaptureDescription](#capturedescription): Properties to configure capture description for eventhub @@ -265,34 +252,24 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Enumerates the possible values for the status of the Event Hub. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## CaptureDescription -### Properties -* **destination**: [Destination](#destination): Capture storage details for capture description -* **enabled**: bool: A value that indicates whether capture description is enabled. -* **encoding**: 'Avro' | 'AvroDeflate': Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version -* **intervalInSeconds**: int: 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 -* **sizeLimitInBytes**: int: 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 -* **skipEmptyArchives**: bool: A value that indicates whether to Skip Empty Archives - -## Destination +## Identity ### Properties -* **name**: string: Name for capture destination -* **properties**: [DestinationProperties](#destinationproperties): Properties describing the storage account, blob container and archive name format for capture destination +* **principalId**: string (ReadOnly): ObjectId from the KeyVault +* **tenantId**: string (ReadOnly): TenantId from the KeyVault +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities -## DestinationProperties +## IdentityUserAssignedIdentities ### Properties -* **archiveNameFormat**: string: 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 -* **blobContainer**: string: Blob container Name -* **dataLakeAccountName**: string: The Azure Data Lake Store name for the captured events -* **dataLakeFolderPath**: string: The destination folder path for the captured events -* **dataLakeSubscriptionId**: string: Subscription Id of Azure Data Lake Store -* **storageAccountResourceId**: string: Resource id of the storage account to be used to create the blobs +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## ConsumerGroupProperties +## KeyVaultProperties ### Properties -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. -* **userMetadata**: string: 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. +* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Key Version ## NetworkRuleSetProperties ### Properties @@ -312,9 +289,24 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing Vnet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## PrivateEndpoint ### Properties -* **id**: string: Resource ID of Virtual Network Subnet +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **location**: string (ReadOnly): The geo-location where the resource lives +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. ## SchemaGroupProperties ### Properties @@ -330,33 +322,41 @@ ### Additional Properties * **Additional Properties Type**: string -## AccessKeys +## Sku ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **capacity**: int: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The billing tier of this particular SKU. -## AccessKeys +## Subnet ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **id**: string: Resource ID of Virtual Network Subnet -## AccessKeys +## SystemData ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the AuthorizationRule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace AuthorizationRule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## UserAssignedIdentityProperties +### Properties +* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption diff --git a/generated/extendedlocation/log.out b/generated/extendedlocation/log.out index d28c545496..e0e61e7d99 100644 --- a/generated/extendedlocation/log.out +++ b/generated/extendedlocation/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.extendedlocation-2021-03-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'customLocationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json:525:5 @@ -17,10 +17,10 @@ warning | PreCheck/SchemaMissingType | The schema 'customLocationOperationValueD warning | PreCheck/SchemaMissingType | The schema 'customLocationOperationsList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/preview/2021-03-15-preview/customlocations.json:593:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.extendedlocation-2021-08-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'customLocationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/customlocations.json:557:5 @@ -34,8 +34,8 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.extendedlocation-2021-08-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 7.93s. 6 files generated. +info | Autorest completed in 7.62s. 6 files generated. diff --git a/generated/extendedlocation/microsoft.extendedlocation/2021-08-15/types.md b/generated/extendedlocation/microsoft.extendedlocation/2021-08-15/types.md index 15499ac412..c9cb03170c 100644 --- a/generated/extendedlocation/microsoft.extendedlocation/2021-08-15/types.md +++ b/generated/extendedlocation/microsoft.extendedlocation/2021-08-15/types.md @@ -13,12 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.ExtendedLocation/customLocations' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. - ## CustomLocationProperties ### Properties * **authentication**: [CustomLocationPropertiesAuthentication](#customlocationpropertiesauthentication): This is optional input that contains the authentication that should be used to generate the namespace. @@ -34,6 +28,12 @@ * **type**: string: The type of the Custom Locations authentication * **value**: string (WriteOnly): The kubeconfig value. +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.md b/generated/extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.md index 04c1df8e2f..23e36107ca 100644 --- a/generated/extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.md +++ b/generated/extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.md @@ -25,12 +25,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.ExtendedLocation/customLocations/resourceSyncRules' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. - ## CustomLocationProperties ### Properties * **authentication**: [CustomLocationPropertiesAuthentication](#customlocationpropertiesauthentication): This is optional input that contains the authentication that should be used to generate the namespace. @@ -46,19 +40,17 @@ * **type**: string: The type of the Custom Locations authentication * **value**: string (WriteOnly): The kubeconfig value. -## SystemData +## Identity ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. -## TrackedResourceTags +## MatchExpressionsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: string: Key is the label key that the selector applies to. +* **operator**: string: The Operator field represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. +* **values**: string[]: The label value ## ResourceSyncRuleProperties ### Properties @@ -72,13 +64,21 @@ * **matchExpressions**: [MatchExpressionsProperties](#matchexpressionsproperties)[]: Resource Sync Rules matchExpression property definition. * **matchLabels**: [ResourceSyncRulePropertiesSelectorMatchLabels](#resourcesyncrulepropertiesselectormatchlabels): MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is 'key', the operator is 'In', and the values array contains only 'value'. -## MatchExpressionsProperties +## ResourceSyncRulePropertiesSelectorMatchLabels ### Properties -* **key**: string: Key is the label key that the selector applies to. -* **operator**: string: The Operator field represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. -* **values**: string[]: The label value +### Additional Properties +* **Additional Properties Type**: string -## ResourceSyncRulePropertiesSelectorMatchLabels +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/fluidrelay/log.out b/generated/fluidrelay/log.out index 4d96b54cc2..3833494272 100644 --- a/generated/fluidrelay/log.out +++ b/generated/fluidrelay/log.out @@ -3,35 +3,35 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.fluidrelay-2021-03-12-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.fluidrelay-2021-06-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.fluidrelay-2021-08-30-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.fluidrelay-2021-09-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.fluidrelay-2022-02-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms -info | Autorest completed in 10.93s. 10 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 10.87s. 10 files generated. diff --git a/generated/fluidrelay/microsoft.fluidrelay/2021-03-12-preview/types.md b/generated/fluidrelay/microsoft.fluidrelay/2021-03-12-preview/types.md index 7ad7caffce..3d9c8548bd 100644 --- a/generated/fluidrelay/microsoft.fluidrelay/2021-03-12-preview/types.md +++ b/generated/fluidrelay/microsoft.fluidrelay/2021-03-12-preview/types.md @@ -12,17 +12,17 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.FluidRelay/fluidRelayServers' (ReadOnly, DeployTimeConstant): The resource type +## FluidRelayEndpoints +### Properties +* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. +* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. + ## FluidRelayServerProperties ### Properties * **fluidRelayEndpoints**: [FluidRelayEndpoints](#fluidrelayendpoints) (ReadOnly): The Fluid Relay endpoints for this server * **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server * **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP -## FluidRelayEndpoints -### Properties -* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. -* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/fluidrelay/microsoft.fluidrelay/2021-06-15-preview/types.md b/generated/fluidrelay/microsoft.fluidrelay/2021-06-15-preview/types.md index e098c82a0c..c10d1ac1c4 100644 --- a/generated/fluidrelay/microsoft.fluidrelay/2021-06-15-preview/types.md +++ b/generated/fluidrelay/microsoft.fluidrelay/2021-06-15-preview/types.md @@ -13,11 +13,10 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.FluidRelay/fluidRelayServers' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## FluidRelayEndpoints ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. +* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. +* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. ## FluidRelayServerProperties ### Properties @@ -25,10 +24,11 @@ * **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server * **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP -## FluidRelayEndpoints +## Identity ### Properties -* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. -* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. ## SystemData ### Properties diff --git a/generated/fluidrelay/microsoft.fluidrelay/2021-08-30-preview/types.md b/generated/fluidrelay/microsoft.fluidrelay/2021-08-30-preview/types.md index 5379e7429b..b87695f71e 100644 --- a/generated/fluidrelay/microsoft.fluidrelay/2021-08-30-preview/types.md +++ b/generated/fluidrelay/microsoft.fluidrelay/2021-08-30-preview/types.md @@ -13,11 +13,10 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.FluidRelay/fluidRelayServers' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## FluidRelayEndpoints ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. +* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. +* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. ## FluidRelayServerProperties ### Properties @@ -25,10 +24,11 @@ * **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server * **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP -## FluidRelayEndpoints +## Identity ### Properties -* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. -* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. ## SystemData ### Properties diff --git a/generated/fluidrelay/microsoft.fluidrelay/2021-09-10-preview/types.md b/generated/fluidrelay/microsoft.fluidrelay/2021-09-10-preview/types.md index ec112ea788..6bc001f870 100644 --- a/generated/fluidrelay/microsoft.fluidrelay/2021-09-10-preview/types.md +++ b/generated/fluidrelay/microsoft.fluidrelay/2021-09-10-preview/types.md @@ -13,6 +13,17 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.FluidRelay/fluidRelayServers' (ReadOnly, DeployTimeConstant): The resource type +## FluidRelayEndpoints +### Properties +* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. +* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. + +## FluidRelayServerProperties +### Properties +* **fluidRelayEndpoints**: [FluidRelayEndpoints](#fluidrelayendpoints) (ReadOnly): The Fluid Relay endpoints for this server +* **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server +* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -25,22 +36,6 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## FluidRelayServerProperties -### Properties -* **fluidRelayEndpoints**: [FluidRelayEndpoints](#fluidrelayendpoints) (ReadOnly): The Fluid Relay endpoints for this server -* **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server -* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP - -## FluidRelayEndpoints -### Properties -* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. -* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -55,3 +50,8 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentitiesValue +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + diff --git a/generated/fluidrelay/microsoft.fluidrelay/2022-02-15/types.md b/generated/fluidrelay/microsoft.fluidrelay/2022-02-15/types.md index c715dfbec5..0cf532bcd0 100644 --- a/generated/fluidrelay/microsoft.fluidrelay/2022-02-15/types.md +++ b/generated/fluidrelay/microsoft.fluidrelay/2022-02-15/types.md @@ -13,6 +13,17 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.FluidRelay/fluidRelayServers' (ReadOnly, DeployTimeConstant): The resource type +## FluidRelayEndpoints +### Properties +* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. +* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. + +## FluidRelayServerProperties +### Properties +* **fluidRelayEndpoints**: [FluidRelayEndpoints](#fluidrelayendpoints) (ReadOnly): The Fluid Relay endpoints for this server +* **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server +* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -25,22 +36,6 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## FluidRelayServerProperties -### Properties -* **fluidRelayEndpoints**: [FluidRelayEndpoints](#fluidrelayendpoints) (ReadOnly): The Fluid Relay endpoints for this server -* **frsTenantId**: string (ReadOnly): The Fluid tenantId for this server -* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | string: Provision states for FluidRelay RP - -## FluidRelayEndpoints -### Properties -* **ordererEndpoints**: string[] (ReadOnly): The Fluid Relay Orderer endpoints. -* **storageEndpoints**: string[] (ReadOnly): The Fluid Relay storage endpoints. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -55,3 +50,8 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentitiesValue +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + diff --git a/generated/frontdoor/log.out b/generated/frontdoor/log.out index e27806a9ad..d106a8045a 100644 --- a/generated/frontdoor/log.out +++ b/generated/frontdoor/log.out @@ -15,7 +15,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.network-2020-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -30,7 +30,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-11-01/network.json:40:5 @@ -92,7 +92,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProfileList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/networkexperiment.json:889:5 @@ -126,7 +126,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'Profile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from Profile warning | PreCheck/PropertyRedeclarationWarning | Schema 'Experiment' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Experiment warning | PreCheck/PropertyRedeclarationWarning | Schema 'PreconfiguredEndpoint' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PreconfiguredEndpoint -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.network-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -141,7 +141,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FrontDoor' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/frontdoor.json:866:5 @@ -229,7 +229,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WebApplicationFirewallPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json:262:5 @@ -349,7 +349,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-01-01/network.json:40:5 @@ -437,7 +437,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WebApplicationFirewallPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json:262:5 @@ -473,7 +473,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedRuleExclusion' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json:764:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.network-2019-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -488,7 +488,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FrontDoor' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-05-01/frontdoor.json:646:5 @@ -562,7 +562,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WebApplicationFirewallPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-03-01/webapplicationfirewall.json:262:5 @@ -596,7 +596,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedRuleDefinition' with a - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-03-01/webapplicationfirewall.json:718:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.network-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -611,7 +611,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FrontDoor' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-04-01/frontdoor.json:646:5 @@ -685,7 +685,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FrontDoor' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json:646:5 @@ -772,7 +772,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'MatchCondition' (5 - x-ms-enum: => {"name":"MatchCondition","modelAsString":true} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'MatchCondition' -> 'MatchConditionAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'WebApplicationFirewallPolicy' -> 'WebApplicationFirewallPolicyAutoGenerated' -info | autorest.bicep took 9ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.network-2019-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -787,7 +787,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WebApplicationFirewallPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/frontdoor/resource-manager/Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json:262:5 @@ -822,4 +822,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagedRuleDefinition' with a warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 25.95s. 22 files generated. +info | Autorest completed in 25.45s. 22 files generated. diff --git a/generated/frontdoor/microsoft.network/2018-08-01/types.md b/generated/frontdoor/microsoft.network/2018-08-01/types.md index 0cb765d469..bfb8f86944 100644 --- a/generated/frontdoor/microsoft.network/2018-08-01/types.md +++ b/generated/frontdoor/microsoft.network/2018-08-01/types.md @@ -23,18 +23,20 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/FrontDoorWebApplicationFirewallPolicies' (ReadOnly, DeployTimeConstant): The resource type -## FrontDoorProperties +## AzureManagedOverrideRuleGroup ### Properties -* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. -* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions +* **ruleGroupOverride**: 'SqlInjection' | 'XSS' | string (Required): Describes override rule group + +## Backend +### Properties +* **address**: string: Location of the backend (IP address or FQDN) +* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. * **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **friendlyName**: string: A friendly name for the frontDoor -* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. -* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. -* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. -* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. +* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. +* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. +* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. +* **weight**: int: Weight of this endpoint for load balancing purposes. ## BackendPool ### Properties @@ -50,19 +52,50 @@ * **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -## Backend +## CacheConfiguration ### Properties -* **address**: string: Location of the backend (IP address or FQDN) -* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. -* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. -* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. -* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. -* **weight**: int: Weight of this endpoint for load balancing purposes. +* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content +* **queryParameterStripDirective**: 'StripAll' | 'StripNone' | string: Treatment of URL query terms when forming the cache key. -## SubResource +## CustomHttpsConfiguration ### Properties -* **id**: string: Resource ID. +* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string: Defines the source of the SSL certificate +* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates +* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault +* **protocolType**: 'ServerNameIndication' | string: Defines the TLS extension protocol that is used for secure delivery + +## CustomRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchConditionAutoGenerated](#matchconditionautogenerated)[] (Required): List of match conditions +* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value +* **rateLimitDurationInMinutes**: int: Defines rate limit duration. Default - 1 minute +* **rateLimitThreshold**: int: Defines rate limit threshold +* **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms + +## CustomRules +### Properties +* **rules**: [CustomRule](#customrule)[]: List of rules + +## FrontDoorCertificateSourceParameters +### Properties +* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint + +## FrontDoorProperties +### Properties +* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. +* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' +* **friendlyName**: string: A friendly name for the frontDoor +* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. +* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. +* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. +* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. ## FrontendEndpoint ### Properties @@ -82,27 +115,6 @@ * **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. * **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) -## CustomHttpsConfiguration -### Properties -* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string: Defines the source of the SSL certificate -* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates -* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault -* **protocolType**: 'ServerNameIndication' | string: Defines the TLS extension protocol that is used for secure delivery - -## FrontDoorCertificateSourceParameters -### Properties -* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint - -## KeyVaultCertificateSourceParameters -### Properties -* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX -* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX -* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate - -## KeyVaultCertificateSourceParametersVault -### Properties -* **id**: string: Resource ID. - ## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink ### Properties * **id**: string: Resource ID. @@ -121,6 +133,16 @@ * **protocol**: 'Http' | 'Https' | string: Accepted protocol schemes. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +## KeyVaultCertificateSourceParameters +### Properties +* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX +* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX +* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate + +## KeyVaultCertificateSourceParametersVault +### Properties +* **id**: string: Resource ID. + ## LoadBalancingSettingsModel ### Properties * **id**: string: Resource ID. @@ -135,6 +157,45 @@ * **sampleSize**: int: The number of samples to consider for load balancing decisions * **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed +## ManagedRuleSet +* **Discriminator**: ruleSetType + +### Base Properties +* **priority**: int: Describes priority of the rule +* **version**: int: defines version of the rule set +### AzureManagedRuleSet +#### Properties +* **ruleGroupOverrides**: [AzureManagedOverrideRuleGroup](#azuremanagedoverriderulegroup)[]: List of azure managed provider override configuration (optional) +* **ruleSetType**: 'AzureManagedRuleSet' (Required): RuleSetType - AzureManagedRuleSet or OWASP RuleSets. + + +## ManagedRuleSets +### Properties +* **ruleSets**: [ManagedRuleSet](#managedruleset)[]: List of rules + +## MatchConditionAutoGenerated +### Properties +* **matchValue**: string[] (Required): Match value +* **matchVariable**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable +* **negateCondition**: bool: Describes if this is negate condition or not +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched +* **selector**: string: Name of selector in RequestHeader or RequestBody to be matched + +## PolicySettings +### Properties +* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## RoutingRule ### Properties * **id**: string: Resource ID. @@ -154,15 +215,9 @@ * **patternsToMatch**: string[]: The route patterns of the rule. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -## CacheConfiguration -### Properties -* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content -* **queryParameterStripDirective**: 'StripAll' | 'StripNone' | string: Treatment of URL query terms when forming the cache key. - -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. ## WebApplicationFirewallPolicyPropertiesFormat ### Properties @@ -172,58 +227,3 @@ * **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -## CustomRules -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - -## CustomRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchConditionAutoGenerated](#matchconditionautogenerated)[] (Required): List of match conditions -* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value -* **rateLimitDurationInMinutes**: int: Defines rate limit duration. Default - 1 minute -* **rateLimitThreshold**: int: Defines rate limit threshold -* **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms - -## MatchConditionAutoGenerated -### Properties -* **matchValue**: string[] (Required): Match value -* **matchVariable**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable -* **negateCondition**: bool: Describes if this is negate condition or not -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | string (Required): Describes operator to be matched -* **selector**: string: Name of selector in RequestHeader or RequestBody to be matched - -## ManagedRuleSets -### Properties -* **ruleSets**: [ManagedRuleSet](#managedruleset)[]: List of rules - -## ManagedRuleSet -* **Discriminator**: ruleSetType - -### Base Properties -* **priority**: int: Describes priority of the rule -* **version**: int: defines version of the rule set -### AzureManagedRuleSet -#### Properties -* **ruleGroupOverrides**: [AzureManagedOverrideRuleGroup](#azuremanagedoverriderulegroup)[]: List of azure managed provider override configuration (optional) -* **ruleSetType**: 'AzureManagedRuleSet' (Required): RuleSetType - AzureManagedRuleSet or OWASP RuleSets. - - -## AzureManagedOverrideRuleGroup -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions -* **ruleGroupOverride**: 'SqlInjection' | 'XSS' | string (Required): Describes override rule group - -## PolicySettings -### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/frontdoor/microsoft.network/2019-03-01/types.md b/generated/frontdoor/microsoft.network/2019-03-01/types.md index 6869456813..6f4a951a37 100644 --- a/generated/frontdoor/microsoft.network/2019-03-01/types.md +++ b/generated/frontdoor/microsoft.network/2019-03-01/types.md @@ -12,19 +12,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/FrontDoorWebApplicationFirewallPolicies' (ReadOnly, DeployTimeConstant): The resource type -## WebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **frontendEndpointLinks**: [FrontendEndpointLink](#frontendendpointlink)[] (ReadOnly): Describes Frontend Endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines top-level WebApplicationFirewallPolicy configuration settings. -* **provisioningState**: string (ReadOnly): Provisioning state of the policy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - ## CustomRule ### Properties * **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. @@ -36,22 +23,24 @@ * **rateLimitThreshold**: int: Defines rate limit threshold. * **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule. -## MatchCondition +## CustomRuleList ### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | string (Required): Match variable to compare against. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched -* **selector**: string: Selector can used to match against a specific key from QueryString, PostArgs, RequestHeader or Cookies. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **rules**: [CustomRule](#customrule)[]: List of rules ## FrontendEndpointLink ### Properties * **id**: string: Resource ID. -## ManagedRuleSetList +## ManagedRuleGroupOverride ### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. +* **ruleGroupName**: string (Required): Describes the managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. + +## ManagedRuleOverride +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. +* **ruleId**: string (Required): Identifier for the managed rule. ## ManagedRuleSet ### Properties @@ -59,16 +48,18 @@ * **ruleSetType**: string (Required): Defines the rule set type to use. * **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ManagedRuleGroupOverride +## ManagedRuleSetList ### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. -## ManagedRuleOverride +## MatchCondition ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. -* **ruleId**: string (Required): Identifier for the managed rule. +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | string (Required): Match variable to compare against. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Describes operator to be matched +* **selector**: string: Selector can used to match against a specific key from QueryString, PostArgs, RequestHeader or Cookies. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. ## PolicySettings ### Properties @@ -83,3 +74,12 @@ ### Additional Properties * **Additional Properties Type**: string +## WebApplicationFirewallPolicyProperties +### Properties +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **frontendEndpointLinks**: [FrontendEndpointLink](#frontendendpointlink)[] (ReadOnly): Describes Frontend Endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines top-level WebApplicationFirewallPolicy configuration settings. +* **provisioningState**: string (ReadOnly): Provisioning state of the policy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. + diff --git a/generated/frontdoor/microsoft.network/2019-04-01/types.md b/generated/frontdoor/microsoft.network/2019-04-01/types.md index 491e740631..4a32f0d1c5 100644 --- a/generated/frontdoor/microsoft.network/2019-04-01/types.md +++ b/generated/frontdoor/microsoft.network/2019-04-01/types.md @@ -11,19 +11,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/frontDoors' (ReadOnly, DeployTimeConstant): The resource type -## FrontDoorProperties +## Backend ### Properties -* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. -* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. -* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. -* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **friendlyName**: string: A friendly name for the frontDoor -* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. -* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. -* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. -* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. +* **address**: string: Location of the backend (IP address or FQDN) +* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' +* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. +* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. +* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. +* **weight**: int: Weight of this endpoint for load balancing purposes. ## BackendPool ### Properties @@ -39,23 +35,39 @@ * **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -## Backend +## BackendPoolsSettings ### Properties -* **address**: string: Location of the backend (IP address or FQDN) -* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' -* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. -* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. -* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. -* **weight**: int: Weight of this endpoint for load balancing purposes. +* **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. -## SubResource +## CacheConfiguration ### Properties -* **id**: string: Resource ID. +* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content +* **queryParameterStripDirective**: 'StripAll' | 'StripNone' | string: Treatment of URL query terms when forming the cache key. -## BackendPoolsSettings +## CustomHttpsConfiguration ### Properties -* **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. +* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string: Defines the source of the SSL certificate +* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates +* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault +* **protocolType**: 'ServerNameIndication' | string: Defines the TLS extension protocol that is used for secure delivery + +## FrontDoorCertificateSourceParameters +### Properties +* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint + +## FrontDoorProperties +### Properties +* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. +* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. +* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' +* **friendlyName**: string: A friendly name for the frontDoor +* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. +* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. +* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. +* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. ## FrontendEndpoint ### Properties @@ -75,27 +87,6 @@ * **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. * **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) -## CustomHttpsConfiguration -### Properties -* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string: Defines the source of the SSL certificate -* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates -* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault -* **protocolType**: 'ServerNameIndication' | string: Defines the TLS extension protocol that is used for secure delivery - -## FrontDoorCertificateSourceParameters -### Properties -* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint - -## KeyVaultCertificateSourceParameters -### Properties -* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX -* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX -* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate - -## KeyVaultCertificateSourceParametersVault -### Properties -* **id**: string: Resource ID. - ## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink ### Properties * **id**: string: Resource ID. @@ -114,6 +105,16 @@ * **protocol**: 'Http' | 'Https' | string: Accepted protocol schemes. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +## KeyVaultCertificateSourceParameters +### Properties +* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX +* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX +* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate + +## KeyVaultCertificateSourceParametersVault +### Properties +* **id**: string: Resource ID. + ## LoadBalancingSettingsModel ### Properties * **id**: string: Resource ID. @@ -128,21 +129,10 @@ * **sampleSize**: int: The number of samples to consider for load balancing decisions * **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## RoutingRule -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. -* **type**: string (ReadOnly): Resource type. - -## RoutingRuleProperties +## ResourceTags ### Properties -* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule -* **patternsToMatch**: string[]: The route patterns of the rule. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. +### Additional Properties +* **Additional Properties Type**: string ## RouteConfiguration * **Discriminator**: @odata.type @@ -167,13 +157,23 @@ * **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string: The redirect type the rule will use when redirecting traffic. -## CacheConfiguration +## RoutingRule ### Properties -* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content -* **queryParameterStripDirective**: 'StripAll' | 'StripNone' | string: Treatment of URL query terms when forming the cache key. +* **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## RoutingRuleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule +* **patternsToMatch**: string[]: The route patterns of the rule. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. + +## SubResource +### Properties +* **id**: string: Resource ID. diff --git a/generated/frontdoor/microsoft.network/2019-05-01/types.md b/generated/frontdoor/microsoft.network/2019-05-01/types.md index b3c2ba0efb..af243a1fdd 100644 --- a/generated/frontdoor/microsoft.network/2019-05-01/types.md +++ b/generated/frontdoor/microsoft.network/2019-05-01/types.md @@ -11,19 +11,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/frontDoors' (ReadOnly, DeployTimeConstant): The resource type -## FrontDoorProperties +## Backend ### Properties -* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. -* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. -* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. -* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **friendlyName**: string: A friendly name for the frontDoor -* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. -* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. -* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. -* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. +* **address**: string: Location of the backend (IP address or FQDN) +* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' +* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. +* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. +* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. +* **weight**: int: Weight of this endpoint for load balancing purposes. ## BackendPool ### Properties @@ -39,42 +35,15 @@ * **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -## Backend -### Properties -* **address**: string: Location of the backend (IP address or FQDN) -* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' -* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. -* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. -* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. -* **weight**: int: Weight of this endpoint for load balancing purposes. - -## SubResource -### Properties -* **id**: string: Resource ID. - ## BackendPoolsSettings ### Properties * **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. * **sendRecvTimeoutSeconds**: int: Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. -## FrontendEndpoint -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [FrontendEndpointProperties](#frontendendpointproperties): The JSON object that contains the properties required to create a frontend endpoint. -* **type**: string (ReadOnly): Resource type. - -## FrontendEndpointProperties +## CacheConfiguration ### Properties -* **customHttpsConfiguration**: [CustomHttpsConfiguration](#customhttpsconfiguration) (ReadOnly): Https settings for a domain -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the frontendEndpoint. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string: The host name of the frontendEndpoint. Must be a domain name. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **sessionAffinityEnabledState**: 'Disabled' | 'Enabled' | string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' -* **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. -* **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) +* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content +* **queryParameterStripDirective**: 'StripAll' | 'StripNone' | string: Treatment of URL query terms when forming the cache key. ## CustomHttpsConfiguration ### Properties @@ -88,15 +57,37 @@ ### Properties * **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint -## KeyVaultCertificateSourceParameters +## FrontDoorProperties ### Properties -* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX -* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX -* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate +* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. +* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. +* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' +* **friendlyName**: string: A friendly name for the frontDoor +* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. +* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. +* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. +* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. -## KeyVaultCertificateSourceParametersVault +## FrontendEndpoint ### Properties * **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [FrontendEndpointProperties](#frontendendpointproperties): The JSON object that contains the properties required to create a frontend endpoint. +* **type**: string (ReadOnly): Resource type. + +## FrontendEndpointProperties +### Properties +* **customHttpsConfiguration**: [CustomHttpsConfiguration](#customhttpsconfiguration) (ReadOnly): Https settings for a domain +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the frontendEndpoint. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string: The host name of the frontendEndpoint. Must be a domain name. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **sessionAffinityEnabledState**: 'Disabled' | 'Enabled' | string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' +* **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. +* **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) ## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink ### Properties @@ -118,6 +109,16 @@ * **protocol**: 'Http' | 'Https' | string: Accepted protocol schemes. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +## KeyVaultCertificateSourceParameters +### Properties +* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX +* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX +* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate + +## KeyVaultCertificateSourceParametersVault +### Properties +* **id**: string: Resource ID. + ## LoadBalancingSettingsModel ### Properties * **id**: string: Resource ID. @@ -132,21 +133,10 @@ * **sampleSize**: int: The number of samples to consider for load balancing decisions * **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## RoutingRule -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. -* **type**: string (ReadOnly): Resource type. - -## RoutingRuleProperties +## ResourceTags ### Properties -* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule -* **patternsToMatch**: string[]: The route patterns of the rule. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. +### Additional Properties +* **Additional Properties Type**: string ## RouteConfiguration * **Discriminator**: @odata.type @@ -171,13 +161,23 @@ * **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string: The redirect type the rule will use when redirecting traffic. -## CacheConfiguration +## RoutingRule ### Properties -* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content -* **queryParameterStripDirective**: 'StripAll' | 'StripNone' | string: Treatment of URL query terms when forming the cache key. +* **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## RoutingRuleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule +* **patternsToMatch**: string[]: The route patterns of the rule. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. + +## SubResource +### Properties +* **id**: string: Resource ID. diff --git a/generated/frontdoor/microsoft.network/2019-10-01/types.md b/generated/frontdoor/microsoft.network/2019-10-01/types.md index cb1ad5b6a0..0c9f72a308 100644 --- a/generated/frontdoor/microsoft.network/2019-10-01/types.md +++ b/generated/frontdoor/microsoft.network/2019-10-01/types.md @@ -12,19 +12,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/FrontDoorWebApplicationFirewallPolicies' (ReadOnly, DeployTimeConstant): The resource type -## WebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **frontendEndpointLinks**: [FrontendEndpointLink](#frontendendpointlink)[] (ReadOnly): Describes Frontend Endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines top-level WebApplicationFirewallPolicy configuration settings. -* **provisioningState**: string (ReadOnly): Provisioning state of the policy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## CustomRuleList -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - ## CustomRule ### Properties * **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. @@ -36,30 +23,14 @@ * **rateLimitThreshold**: int: Number of allowed requests per client within the time window. * **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule. -## MatchCondition +## CustomRuleList ### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Request variable to compare with. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Comparison type to use for matching with the variable value. -* **selector**: string: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **rules**: [CustomRule](#customrule)[]: List of rules ## FrontendEndpointLink ### Properties * **id**: string: Resource ID. -## ManagedRuleSetList -### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. - -## ManagedRuleSet -### Properties -* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the set. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. - ## ManagedRuleExclusion ### Properties * **matchVariable**: 'QueryStringArgNames' | 'RequestBodyPostArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable type to be excluded. @@ -79,6 +50,26 @@ * **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to this specific rule. * **ruleId**: string (Required): Identifier for the managed rule. +## ManagedRuleSet +### Properties +* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the set. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. + +## MatchCondition +### Properties +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Request variable to compare with. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Comparison type to use for matching with the variable value. +* **selector**: string: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. + ## PolicySettings ### Properties * **customBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. @@ -92,3 +83,12 @@ ### Additional Properties * **Additional Properties Type**: string +## WebApplicationFirewallPolicyProperties +### Properties +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **frontendEndpointLinks**: [FrontendEndpointLink](#frontendendpointlink)[] (ReadOnly): Describes Frontend Endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines top-level WebApplicationFirewallPolicy configuration settings. +* **provisioningState**: string (ReadOnly): Provisioning state of the policy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. + diff --git a/generated/frontdoor/microsoft.network/2019-11-01/types.md b/generated/frontdoor/microsoft.network/2019-11-01/types.md index b47a5eefd2..f538dfff72 100644 --- a/generated/frontdoor/microsoft.network/2019-11-01/types.md +++ b/generated/frontdoor/microsoft.network/2019-11-01/types.md @@ -23,15 +23,10 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/NetworkExperimentProfiles/Experiments' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: The state of the Experiment -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Defines the server side resource status - -## ResourceTags +## Endpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endpoint**: string: The endpoint URL +* **name**: string: The name of the endpoint ## ExperimentProperties ### Properties @@ -43,10 +38,15 @@ * **scriptFileUri**: string (ReadOnly): The uri to the Script used in the Experiment * **status**: string (ReadOnly): The description of Experiment status from the server side -## Endpoint +## ProfileProperties ### Properties -* **endpoint**: string: The endpoint URL -* **name**: string: The name of the endpoint +* **enabledState**: 'Disabled' | 'Enabled' | string: The state of the Experiment +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Defines the server side resource status + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties diff --git a/generated/frontdoor/microsoft.network/2020-01-01/types.md b/generated/frontdoor/microsoft.network/2020-01-01/types.md index bd3d8dd99f..ee60c78674 100644 --- a/generated/frontdoor/microsoft.network/2020-01-01/types.md +++ b/generated/frontdoor/microsoft.network/2020-01-01/types.md @@ -20,21 +20,18 @@ * **properties**: [RulesEngineProperties](#rulesengineproperties): The JSON object that contains the properties required to create a Rules Engine Configuration. * **type**: 'Microsoft.Network/frontDoors/rulesEngines' (ReadOnly, DeployTimeConstant): The resource type -## FrontDoorProperties +## Backend ### Properties -* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. -* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. -* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. -* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **friendlyName**: string: A friendly name for the frontDoor -* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. -* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. -* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. -* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. -* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. -* **rulesEngines**: [RulesEngine](#rulesengine)[] (ReadOnly): Rules Engine Configurations available to routing rules. +* **address**: string: Location of the backend (IP address or FQDN) +* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' +* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. +* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. +* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. +* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The Approval status for the connection to the Private Link +* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link +* **weight**: int: Weight of this endpoint for load balancing purposes. ## BackendPool ### Properties @@ -50,27 +47,45 @@ * **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -## Backend +## BackendPoolsSettings ### Properties -* **address**: string: Location of the backend (IP address or FQDN) -* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' -* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. -* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. -* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. -* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The Approval status for the connection to the Private Link -* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private' -* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link -* **weight**: int: Weight of this endpoint for load balancing purposes. +* **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. +* **sendRecvTimeoutSeconds**: int: Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. -## SubResource +## CacheConfiguration ### Properties -* **id**: string: Resource ID. +* **cacheDuration**: string: 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 +* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryParameterStripDirective**: 'StripAll' | 'StripAllExcept' | 'StripNone' | 'StripOnly' | string: Treatment of URL query terms when forming the cache key. -## BackendPoolsSettings +## CustomHttpsConfiguration ### Properties -* **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. -* **sendRecvTimeoutSeconds**: int: Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. +* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string (Required): Defines the source of the SSL certificate +* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates +* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault +* **minimumTlsVersion**: '1.0' | '1.2' | string (Required): The minimum TLS version required from the clients to establish an SSL handshake with Front Door. +* **protocolType**: 'ServerNameIndication' | string (Required): Defines the TLS extension protocol that is used for secure delivery + +## FrontDoorCertificateSourceParameters +### Properties +* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint + +## FrontDoorProperties +### Properties +* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. +* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. +* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' +* **friendlyName**: string: A friendly name for the frontDoor +* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. +* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. +* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. +* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. +* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. +* **rulesEngines**: [RulesEngine](#rulesengine)[] (ReadOnly): Rules Engine Configurations available to routing rules. ## FrontendEndpoint ### Properties @@ -90,31 +105,15 @@ * **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. * **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) -## CustomHttpsConfiguration -### Properties -* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string (Required): Defines the source of the SSL certificate -* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates -* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault -* **minimumTlsVersion**: '1.0' | '1.2' | string (Required): The minimum TLS version required from the clients to establish an SSL handshake with Front Door. -* **protocolType**: 'ServerNameIndication' | string (Required): Defines the TLS extension protocol that is used for secure delivery - -## FrontDoorCertificateSourceParameters -### Properties -* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint - -## KeyVaultCertificateSourceParameters -### Properties -* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX -* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX -* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate - -## KeyVaultCertificateSourceParametersVault +## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink ### Properties * **id**: string: Resource ID. -## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink +## HeaderAction ### Properties -* **id**: string: Resource ID. +* **headerActionType**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Which type of manipulation to apply to the header. +* **headerName**: string (Required): The name of the header this action will apply to. +* **value**: string: The value to update the given header name with. This value is not used if the actionType is Delete. ## HealthProbeSettingsModel ### Properties @@ -132,6 +131,16 @@ * **protocol**: 'Http' | 'Https' | string: Accepted protocol schemes. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +## KeyVaultCertificateSourceParameters +### Properties +* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX +* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX +* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate + +## KeyVaultCertificateSourceParametersVault +### Properties +* **id**: string: Resource ID. + ## LoadBalancingSettingsModel ### Properties * **id**: string: Resource ID. @@ -146,22 +155,10 @@ * **sampleSize**: int: The number of samples to consider for load balancing decisions * **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## RoutingRule -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. -* **type**: string (ReadOnly): Resource type. - -## RoutingRuleProperties +## ResourceTags ### Properties -* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule -* **patternsToMatch**: string[]: The route patterns of the rule. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. -* **rulesEngine**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string ## RouteConfiguration * **Discriminator**: @odata.type @@ -186,12 +183,22 @@ * **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string: The redirect type the rule will use when redirecting traffic. -## CacheConfiguration +## RoutingRule ### Properties -* **cacheDuration**: string: 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 -* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryParameterStripDirective**: 'StripAll' | 'StripAllExcept' | 'StripNone' | 'StripOnly' | string: Treatment of URL query terms when forming the cache key. +* **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. +* **type**: string (ReadOnly): Resource type. + +## RoutingRuleProperties +### Properties +* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule +* **patternsToMatch**: string[]: The route patterns of the rule. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. +* **rulesEngine**: [SubResource](#subresource): Reference to another subresource. ## RulesEngine ### Properties @@ -200,31 +207,12 @@ * **properties**: [RulesEngineProperties](#rulesengineproperties): The JSON object that contains the properties required to create a Rules Engine Configuration. * **type**: string (ReadOnly): Resource type. -## RulesEngineProperties -### Properties -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **rules**: [RulesEngineRule](#rulesenginerule)[]: A list of rules that define a particular Rules Engine Configuration. - -## RulesEngineRule -### Properties -* **action**: [RulesEngineAction](#rulesengineaction) (Required): One or more actions that will execute, modifying the request and/or response. -* **matchConditions**: [RulesEngineMatchCondition](#rulesenginematchcondition)[]: 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. -* **matchProcessingBehavior**: 'Continue' | 'Stop' | string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. -* **name**: string (Required): A name to refer to this specific rule. -* **priority**: int (Required): A priority assigned to this rule. - ## RulesEngineAction ### Properties * **requestHeaderActions**: [HeaderAction](#headeraction)[]: A list of header actions to apply from the request from AFD to the origin. * **responseHeaderActions**: [HeaderAction](#headeraction)[]: A list of header actions to apply from the response from AFD to the client. * **routeConfigurationOverride**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. -## HeaderAction -### Properties -* **headerActionType**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Which type of manipulation to apply to the header. -* **headerName**: string (Required): The name of the header this action will apply to. -* **value**: string: The value to update the given header name with. This value is not used if the actionType is Delete. - ## RulesEngineMatchCondition ### Properties * **negateCondition**: bool: Describes if this is negate condition or not @@ -234,8 +222,20 @@ * **selector**: string: Name of selector in RequestHeader or RequestBody to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## ResourceTags +## RulesEngineProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **rules**: [RulesEngineRule](#rulesenginerule)[]: A list of rules that define a particular Rules Engine Configuration. + +## RulesEngineRule +### Properties +* **action**: [RulesEngineAction](#rulesengineaction) (Required): One or more actions that will execute, modifying the request and/or response. +* **matchConditions**: [RulesEngineMatchCondition](#rulesenginematchcondition)[]: 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. +* **matchProcessingBehavior**: 'Continue' | 'Stop' | string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. +* **name**: string (Required): A name to refer to this specific rule. +* **priority**: int (Required): A priority assigned to this rule. + +## SubResource +### Properties +* **id**: string: Resource ID. diff --git a/generated/frontdoor/microsoft.network/2020-04-01/types.md b/generated/frontdoor/microsoft.network/2020-04-01/types.md index a305c0a4e2..3019e6f436 100644 --- a/generated/frontdoor/microsoft.network/2020-04-01/types.md +++ b/generated/frontdoor/microsoft.network/2020-04-01/types.md @@ -32,21 +32,18 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/FrontDoorWebApplicationFirewallPolicies' (ReadOnly, DeployTimeConstant): The resource type -## FrontDoorProperties +## Backend ### Properties -* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. -* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. -* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. -* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **friendlyName**: string: A friendly name for the frontDoor -* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. -* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. -* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. -* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. -* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. -* **rulesEngines**: [RulesEngine](#rulesengine)[] (ReadOnly): Rules Engine Configurations available to routing rules. +* **address**: string: Location of the backend (IP address or FQDN) +* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' +* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. +* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. +* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. +* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The Approval status for the connection to the Private Link +* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private' +* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link +* **weight**: int: Weight of this endpoint for load balancing purposes. ## BackendPool ### Properties @@ -62,27 +59,60 @@ * **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -## Backend +## BackendPoolsSettings ### Properties -* **address**: string: Location of the backend (IP address or FQDN) -* **backendHostHeader**: string: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' -* **httpPort**: int: The HTTP TCP port number. Must be between 1 and 65535. -* **httpsPort**: int: The HTTPS TCP port number. Must be between 1 and 65535. -* **priority**: int: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. -* **privateEndpointStatus**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): The Approval status for the connection to the Private Link -* **privateLinkAlias**: string: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private' -* **privateLinkApprovalMessage**: string: A custom message to be included in the approval request to connect to the Private Link -* **weight**: int: Weight of this endpoint for load balancing purposes. +* **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. +* **sendRecvTimeoutSeconds**: int: Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. -## SubResource +## CacheConfiguration ### Properties -* **id**: string: Resource ID. +* **cacheDuration**: string: 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 +* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryParameterStripDirective**: 'StripAll' | 'StripAllExcept' | 'StripNone' | 'StripOnly' | string: Treatment of URL query terms when forming the cache key. -## BackendPoolsSettings +## CustomHttpsConfiguration ### Properties -* **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. -* **sendRecvTimeoutSeconds**: int: Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. +* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string (Required): Defines the source of the SSL certificate +* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates +* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault +* **minimumTlsVersion**: '1.0' | '1.2' | string (Required): The minimum TLS version required from the clients to establish an SSL handshake with Front Door. +* **protocolType**: 'ServerNameIndication' | string (Required): Defines the TLS extension protocol that is used for secure delivery + +## CustomRule +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: Describes the name of the rule. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **rateLimitDurationInMinutes**: int: Time window for resetting the rate limit count. Default is 1 minute. +* **rateLimitThreshold**: int: Number of allowed requests per client within the time window. +* **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule. + +## CustomRuleList +### Properties +* **rules**: [CustomRule](#customrule)[]: List of rules + +## FrontDoorCertificateSourceParameters +### Properties +* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint + +## FrontDoorProperties +### Properties +* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. +* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. +* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' +* **friendlyName**: string: A friendly name for the frontDoor +* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. +* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. +* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. +* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. +* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. +* **rulesEngines**: [RulesEngine](#rulesengine)[] (ReadOnly): Rules Engine Configurations available to routing rules. ## FrontendEndpoint ### Properties @@ -91,6 +121,10 @@ * **properties**: [FrontendEndpointProperties](#frontendendpointproperties): The JSON object that contains the properties required to create a frontend endpoint. * **type**: string (ReadOnly): Resource type. +## FrontendEndpointLink +### Properties +* **id**: string: Resource ID. + ## FrontendEndpointProperties ### Properties * **customHttpsConfiguration**: [CustomHttpsConfiguration](#customhttpsconfiguration) (ReadOnly): Https settings for a domain @@ -102,31 +136,15 @@ * **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. * **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) -## CustomHttpsConfiguration -### Properties -* **certificateSource**: 'AzureKeyVault' | 'FrontDoor' | string (Required): Defines the source of the SSL certificate -* **frontDoorCertificateSourceParameters**: [FrontDoorCertificateSourceParameters](#frontdoorcertificatesourceparameters): Parameters required for enabling SSL with Front Door-managed certificates -* **keyVaultCertificateSourceParameters**: [KeyVaultCertificateSourceParameters](#keyvaultcertificatesourceparameters): Parameters required for bring-your-own-certification via Key Vault -* **minimumTlsVersion**: '1.0' | '1.2' | string (Required): The minimum TLS version required from the clients to establish an SSL handshake with Front Door. -* **protocolType**: 'ServerNameIndication' | string (Required): Defines the TLS extension protocol that is used for secure delivery - -## FrontDoorCertificateSourceParameters -### Properties -* **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint - -## KeyVaultCertificateSourceParameters -### Properties -* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX -* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX -* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate - -## KeyVaultCertificateSourceParametersVault +## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink ### Properties * **id**: string: Resource ID. -## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink +## HeaderAction ### Properties -* **id**: string: Resource ID. +* **headerActionType**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Which type of manipulation to apply to the header. +* **headerName**: string (Required): The name of the header this action will apply to. +* **value**: string: The value to update the given header name with. This value is not used if the actionType is Delete. ## HealthProbeSettingsModel ### Properties @@ -144,6 +162,16 @@ * **protocol**: 'Http' | 'Https' | string: Accepted protocol schemes. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +## KeyVaultCertificateSourceParameters +### Properties +* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX +* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX +* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate + +## KeyVaultCertificateSourceParametersVault +### Properties +* **id**: string: Resource ID. + ## LoadBalancingSettingsModel ### Properties * **id**: string: Resource ID. @@ -158,23 +186,62 @@ * **sampleSize**: int: The number of samples to consider for load balancing decisions * **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## RoutingRule +## ManagedRuleExclusion ### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. -* **type**: string (ReadOnly): Resource type. +* **matchVariable**: 'QueryStringArgNames' | 'RequestBodyPostArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable type to be excluded. +* **selector**: string (Required): Selector value for which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. -## RoutingRuleProperties +## ManagedRuleGroupOverride ### Properties -* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule -* **patternsToMatch**: string[]: The route patterns of the rule. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. -* **rulesEngine**: [SubResource](#subresource): Reference to another subresource. -* **webApplicationFirewallPolicyLink**: [RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink](#routingruleupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each routing rule (if applicable) +* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the group. +* **ruleGroupName**: string (Required): Describes the managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. + +## ManagedRuleOverride +### Properties +* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. +* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to this specific rule. +* **ruleId**: string (Required): Identifier for the managed rule. + +## ManagedRuleSet +### Properties +* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the set. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. + +## MatchCondition +### Properties +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Request variable to compare with. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Comparison type to use for matching with the variable value. +* **selector**: string: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. + +## PolicySettings +### Properties +* **customBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. +* **customBlockResponseStatusCode**: int: If the action type is block, customer can override the response status code. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +* **redirectUrl**: string: If action type is redirect, this field represents redirect URL for the client. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## RouteConfiguration * **Discriminator**: @odata.type @@ -199,12 +266,27 @@ * **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string: The redirect type the rule will use when redirecting traffic. -## CacheConfiguration +## RoutingRule ### Properties -* **cacheDuration**: string: 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 -* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryParameterStripDirective**: 'StripAll' | 'StripAllExcept' | 'StripNone' | 'StripOnly' | string: Treatment of URL query terms when forming the cache key. +* **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. +* **type**: string (ReadOnly): Resource type. + +## RoutingRuleLink +### Properties +* **id**: string: Resource ID. + +## RoutingRuleProperties +### Properties +* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule +* **patternsToMatch**: string[]: The route patterns of the rule. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. +* **rulesEngine**: [SubResource](#subresource): Reference to another subresource. +* **webApplicationFirewallPolicyLink**: [RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink](#routingruleupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each routing rule (if applicable) ## RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink ### Properties @@ -217,31 +299,12 @@ * **properties**: [RulesEngineProperties](#rulesengineproperties): The JSON object that contains the properties required to create a Rules Engine Configuration. * **type**: string (ReadOnly): Resource type. -## RulesEngineProperties -### Properties -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **rules**: [RulesEngineRule](#rulesenginerule)[]: A list of rules that define a particular Rules Engine Configuration. - -## RulesEngineRule -### Properties -* **action**: [RulesEngineAction](#rulesengineaction) (Required): One or more actions that will execute, modifying the request and/or response. -* **matchConditions**: [RulesEngineMatchCondition](#rulesenginematchcondition)[]: 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. -* **matchProcessingBehavior**: 'Continue' | 'Stop' | string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. -* **name**: string (Required): A name to refer to this specific rule. -* **priority**: int (Required): A priority assigned to this rule. - ## RulesEngineAction ### Properties * **requestHeaderActions**: [HeaderAction](#headeraction)[]: A list of header actions to apply from the request from AFD to the origin. * **responseHeaderActions**: [HeaderAction](#headeraction)[]: A list of header actions to apply from the response from AFD to the client. * **routeConfigurationOverride**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. -## HeaderAction -### Properties -* **headerActionType**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Which type of manipulation to apply to the header. -* **headerName**: string (Required): The name of the header this action will apply to. -* **value**: string: The value to update the given header name with. This value is not used if the actionType is Delete. - ## RulesEngineMatchCondition ### Properties * **negateCondition**: bool: Describes if this is negate condition or not @@ -251,10 +314,22 @@ * **selector**: string: Name of selector in RequestHeader or RequestBody to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## ResourceTags +## RulesEngineProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **rules**: [RulesEngineRule](#rulesenginerule)[]: A list of rules that define a particular Rules Engine Configuration. + +## RulesEngineRule +### Properties +* **action**: [RulesEngineAction](#rulesengineaction) (Required): One or more actions that will execute, modifying the request and/or response. +* **matchConditions**: [RulesEngineMatchCondition](#rulesenginematchcondition)[]: 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. +* **matchProcessingBehavior**: 'Continue' | 'Stop' | string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. +* **name**: string (Required): A name to refer to this specific rule. +* **priority**: int (Required): A priority assigned to this rule. + +## SubResource +### Properties +* **id**: string: Resource ID. ## WebApplicationFirewallPolicyProperties ### Properties @@ -266,78 +341,3 @@ * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. * **routingRuleLinks**: [RoutingRuleLink](#routingrulelink)[] (ReadOnly): Describes Routing Rules associated with this Web Application Firewall policy. -## CustomRuleList -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - -## CustomRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: Describes the name of the rule. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **rateLimitDurationInMinutes**: int: Time window for resetting the rate limit count. Default is 1 minute. -* **rateLimitThreshold**: int: Number of allowed requests per client within the time window. -* **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule. - -## MatchCondition -### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Request variable to compare with. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Comparison type to use for matching with the variable value. -* **selector**: string: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. - -## FrontendEndpointLink -### Properties -* **id**: string: Resource ID. - -## ManagedRuleSetList -### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. - -## ManagedRuleSet -### Properties -* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the set. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. - -## ManagedRuleExclusion -### Properties -* **matchVariable**: 'QueryStringArgNames' | 'RequestBodyPostArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable type to be excluded. -* **selector**: string (Required): Selector value for which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. - -## ManagedRuleGroupOverride -### Properties -* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the group. -* **ruleGroupName**: string (Required): Describes the managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. - -## ManagedRuleOverride -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string: Defines the action to take on rule match. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the managed rule is in enabled or disabled state. -* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to this specific rule. -* **ruleId**: string (Required): Identifier for the managed rule. - -## PolicySettings -### Properties -* **customBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. -* **customBlockResponseStatusCode**: int: If the action type is block, customer can override the response status code. -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -* **redirectUrl**: string: If action type is redirect, this field represents redirect URL for the client. - -## RoutingRuleLink -### Properties -* **id**: string: Resource ID. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/frontdoor/microsoft.network/2020-05-01/types.md b/generated/frontdoor/microsoft.network/2020-05-01/types.md index aced20340b..103de65534 100644 --- a/generated/frontdoor/microsoft.network/2020-05-01/types.md +++ b/generated/frontdoor/microsoft.network/2020-05-01/types.md @@ -20,36 +20,6 @@ * **properties**: [RulesEngineProperties](#rulesengineproperties): The JSON object that contains the properties required to create a Rules Engine Configuration. * **type**: 'Microsoft.Network/frontDoors/rulesEngines' (ReadOnly, DeployTimeConstant): The resource type -## FrontDoorProperties -### Properties -* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. -* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. -* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. -* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' -* **friendlyName**: string: A friendly name for the frontDoor -* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. -* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. -* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. -* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. -* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. -* **rulesEngines**: [RulesEngine](#rulesengine)[] (ReadOnly): Rules Engine Configurations available to routing rules. - -## BackendPool -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [BackendPoolProperties](#backendpoolproperties): The JSON object that contains the properties required to create a Backend Pool. -* **type**: string (ReadOnly): Resource type. - -## BackendPoolProperties -### Properties -* **backends**: [Backend](#backend)[]: The set of backends for this pool -* **healthProbeSettings**: [SubResource](#subresource): Reference to another subresource. -* **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. - ## Backend ### Properties * **address**: string: Location of the backend (IP address or FQDN) @@ -65,32 +35,31 @@ * **privateLinkResourceId**: string: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' * **weight**: int: Weight of this endpoint for load balancing purposes. -## SubResource +## BackendPool ### Properties * **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [BackendPoolProperties](#backendpoolproperties): The JSON object that contains the properties required to create a Backend Pool. +* **type**: string (ReadOnly): Resource type. + +## BackendPoolProperties +### Properties +* **backends**: [Backend](#backend)[]: The set of backends for this pool +* **healthProbeSettings**: [SubResource](#subresource): Reference to another subresource. +* **loadBalancingSettings**: [SubResource](#subresource): Reference to another subresource. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. ## BackendPoolsSettings ### Properties * **enforceCertificateNameCheck**: 'Disabled' | 'Enabled' | string: Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. * **sendRecvTimeoutSeconds**: int: Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. -## FrontendEndpoint -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [FrontendEndpointProperties](#frontendendpointproperties): The JSON object that contains the properties required to create a frontend endpoint. -* **type**: string (ReadOnly): Resource type. - -## FrontendEndpointProperties +## CacheConfiguration ### Properties -* **customHttpsConfiguration**: [CustomHttpsConfiguration](#customhttpsconfiguration) (ReadOnly): Https settings for a domain -* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the frontendEndpoint. -* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. -* **hostName**: string: The host name of the frontendEndpoint. Must be a domain name. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **sessionAffinityEnabledState**: 'Disabled' | 'Enabled' | string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' -* **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. -* **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) +* **cacheDuration**: string: 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 +* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content +* **queryParameters**: string: query parameters to include or exclude (comma separated). +* **queryParameterStripDirective**: 'StripAll' | 'StripAllExcept' | 'StripNone' | 'StripOnly' | string: Treatment of URL query terms when forming the cache key. ## CustomHttpsConfiguration ### Properties @@ -104,20 +73,50 @@ ### Properties * **certificateType**: 'Dedicated' | string: Defines the type of the certificate used for secure connections to a frontendEndpoint -## KeyVaultCertificateSourceParameters +## FrontDoorProperties ### Properties -* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX -* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX -* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate +* **backendPools**: [BackendPool](#backendpool)[]: Backend pools available to routing rules. +* **backendPoolsSettings**: [BackendPoolsSettings](#backendpoolssettings): Settings that apply to all backend pools. +* **cname**: string (ReadOnly): The host that each frontendEndpoint must CNAME to. +* **enabledState**: 'Disabled' | 'Enabled' | string: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled' +* **friendlyName**: string: A friendly name for the frontDoor +* **frontdoorId**: string (ReadOnly): The Id of the frontdoor. +* **frontendEndpoints**: [FrontendEndpoint](#frontendendpoint)[]: Frontend endpoints available to routing rules. +* **healthProbeSettings**: [HealthProbeSettingsModel](#healthprobesettingsmodel)[]: Health probe settings associated with this Front Door instance. +* **loadBalancingSettings**: [LoadBalancingSettingsModel](#loadbalancingsettingsmodel)[]: Load balancing settings associated with this Front Door instance. +* **provisioningState**: string (ReadOnly): Provisioning state of the Front Door. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routingRules**: [RoutingRule](#routingrule)[]: Routing rules associated with this Front Door. +* **rulesEngines**: [RulesEngine](#rulesengine)[] (ReadOnly): Rules Engine Configurations available to routing rules. -## KeyVaultCertificateSourceParametersVault +## FrontendEndpoint ### Properties * **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [FrontendEndpointProperties](#frontendendpointproperties): The JSON object that contains the properties required to create a frontend endpoint. +* **type**: string (ReadOnly): Resource type. + +## FrontendEndpointProperties +### Properties +* **customHttpsConfiguration**: [CustomHttpsConfiguration](#customhttpsconfiguration) (ReadOnly): Https settings for a domain +* **customHttpsProvisioningState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Failed' | string (ReadOnly): Provisioning status of Custom Https of the frontendEndpoint. +* **customHttpsProvisioningSubstate**: 'CertificateDeleted' | 'CertificateDeployed' | 'DeletingCertificate' | 'DeployingCertificate' | 'DomainControlValidationRequestApproved' | 'DomainControlValidationRequestRejected' | 'DomainControlValidationRequestTimedOut' | 'IssuingCertificate' | 'PendingDomainControlValidationREquestApproval' | 'SubmittingDomainControlValidationRequest' | string (ReadOnly): Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. +* **hostName**: string: The host name of the frontendEndpoint. Must be a domain name. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **sessionAffinityEnabledState**: 'Disabled' | 'Enabled' | string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' +* **sessionAffinityTtlSeconds**: int: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. +* **webApplicationFirewallPolicyLink**: [FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink](#frontendendpointupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each host (if applicable) ## FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink ### Properties * **id**: string: Resource ID. +## HeaderAction +### Properties +* **headerActionType**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Which type of manipulation to apply to the header. +* **headerName**: string (Required): The name of the header this action will apply to. +* **value**: string: The value to update the given header name with. This value is not used if the actionType is Delete. + ## HealthProbeSettingsModel ### Properties * **id**: string: Resource ID. @@ -134,6 +133,16 @@ * **protocol**: 'Http' | 'Https' | string: Accepted protocol schemes. * **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +## KeyVaultCertificateSourceParameters +### Properties +* **secretName**: string: The name of the Key Vault secret representing the full certificate PFX +* **secretVersion**: string: The version of the Key Vault secret representing the full certificate PFX +* **vault**: [KeyVaultCertificateSourceParametersVault](#keyvaultcertificatesourceparametersvault): The Key Vault containing the SSL certificate + +## KeyVaultCertificateSourceParametersVault +### Properties +* **id**: string: Resource ID. + ## LoadBalancingSettingsModel ### Properties * **id**: string: Resource ID. @@ -148,23 +157,10 @@ * **sampleSize**: int: The number of samples to consider for load balancing decisions * **successfulSamplesRequired**: int: The number of samples within the sample period that must succeed -## RoutingRule -### Properties -* **id**: string: Resource ID. -* **name**: string: Resource name. -* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. -* **type**: string (ReadOnly): Resource type. - -## RoutingRuleProperties +## ResourceTags ### Properties -* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule -* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' -* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule -* **patternsToMatch**: string[]: The route patterns of the rule. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. -* **rulesEngine**: [SubResource](#subresource): Reference to another subresource. -* **webApplicationFirewallPolicyLink**: [RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink](#routingruleupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each routing rule (if applicable) +### Additional Properties +* **Additional Properties Type**: string ## RouteConfiguration * **Discriminator**: @odata.type @@ -189,12 +185,23 @@ * **redirectType**: 'Found' | 'Moved' | 'PermanentRedirect' | 'TemporaryRedirect' | string: The redirect type the rule will use when redirecting traffic. -## CacheConfiguration +## RoutingRule ### Properties -* **cacheDuration**: string: 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 -* **dynamicCompression**: 'Disabled' | 'Enabled' | string: Whether to use dynamic compression for cached content -* **queryParameters**: string: query parameters to include or exclude (comma separated). -* **queryParameterStripDirective**: 'StripAll' | 'StripAllExcept' | 'StripNone' | 'StripOnly' | string: Treatment of URL query terms when forming the cache key. +* **id**: string: Resource ID. +* **name**: string: Resource name. +* **properties**: [RoutingRuleProperties](#routingruleproperties): The JSON object that contains the properties required to create a routing rule. +* **type**: string (ReadOnly): Resource type. + +## RoutingRuleProperties +### Properties +* **acceptedProtocols**: 'Http' | 'Https' | string[]: Protocol schemes to match for this rule +* **enabledState**: 'Disabled' | 'Enabled' | string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' +* **frontendEndpoints**: [SubResource](#subresource)[]: Frontend endpoints associated with this rule +* **patternsToMatch**: string[]: The route patterns of the rule. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **routeConfiguration**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. +* **rulesEngine**: [SubResource](#subresource): Reference to another subresource. +* **webApplicationFirewallPolicyLink**: [RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink](#routingruleupdateparameterswebapplicationfirewallpolicylink): Defines the Web Application Firewall policy for each routing rule (if applicable) ## RoutingRuleUpdateParametersWebApplicationFirewallPolicyLink ### Properties @@ -207,31 +214,12 @@ * **properties**: [RulesEngineProperties](#rulesengineproperties): The JSON object that contains the properties required to create a Rules Engine Configuration. * **type**: string (ReadOnly): Resource type. -## RulesEngineProperties -### Properties -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. -* **rules**: [RulesEngineRule](#rulesenginerule)[]: A list of rules that define a particular Rules Engine Configuration. - -## RulesEngineRule -### Properties -* **action**: [RulesEngineAction](#rulesengineaction) (Required): One or more actions that will execute, modifying the request and/or response. -* **matchConditions**: [RulesEngineMatchCondition](#rulesenginematchcondition)[]: 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. -* **matchProcessingBehavior**: 'Continue' | 'Stop' | string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. -* **name**: string (Required): A name to refer to this specific rule. -* **priority**: int (Required): A priority assigned to this rule. - ## RulesEngineAction ### Properties * **requestHeaderActions**: [HeaderAction](#headeraction)[]: A list of header actions to apply from the request from AFD to the origin. * **responseHeaderActions**: [HeaderAction](#headeraction)[]: A list of header actions to apply from the response from AFD to the client. * **routeConfigurationOverride**: [RouteConfiguration](#routeconfiguration): Base class for all types of Route. -## HeaderAction -### Properties -* **headerActionType**: 'Append' | 'Delete' | 'Overwrite' | string (Required): Which type of manipulation to apply to the header. -* **headerName**: string (Required): The name of the header this action will apply to. -* **value**: string: The value to update the given header name with. This value is not used if the actionType is Delete. - ## RulesEngineMatchCondition ### Properties * **negateCondition**: bool: Describes if this is negate condition or not @@ -241,8 +229,20 @@ * **selector**: string: Name of selector in RequestHeader or RequestBody to be matched * **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## ResourceTags +## RulesEngineProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the Front Door or Front Door SubResource. +* **rules**: [RulesEngineRule](#rulesenginerule)[]: A list of rules that define a particular Rules Engine Configuration. + +## RulesEngineRule +### Properties +* **action**: [RulesEngineAction](#rulesengineaction) (Required): One or more actions that will execute, modifying the request and/or response. +* **matchConditions**: [RulesEngineMatchCondition](#rulesenginematchcondition)[]: 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. +* **matchProcessingBehavior**: 'Continue' | 'Stop' | string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. +* **name**: string (Required): A name to refer to this specific rule. +* **priority**: int (Required): A priority assigned to this rule. + +## SubResource +### Properties +* **id**: string: Resource ID. diff --git a/generated/frontdoor/microsoft.network/2020-11-01/types.md b/generated/frontdoor/microsoft.network/2020-11-01/types.md index 77091bfdde..2b3fc116b7 100644 --- a/generated/frontdoor/microsoft.network/2020-11-01/types.md +++ b/generated/frontdoor/microsoft.network/2020-11-01/types.md @@ -13,21 +13,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/FrontDoorWebApplicationFirewallPolicies' (ReadOnly, DeployTimeConstant): The resource type -## WebApplicationFirewallPolicyProperties -### Properties -* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules -* **frontendEndpointLinks**: [FrontendEndpointLink](#frontendendpointlink)[] (ReadOnly): Describes Frontend Endpoints associated with this Web Application Firewall policy. -* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines top-level WebApplicationFirewallPolicy configuration settings. -* **provisioningState**: string (ReadOnly): Provisioning state of the policy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. -* **routingRuleLinks**: [RoutingRuleLink](#routingrulelink)[] (ReadOnly): Describes Routing Rules associated with this Web Application Firewall policy. -* **securityPolicyLinks**: [SecurityPolicyLink](#securitypolicylink)[] (ReadOnly): Describes Security Policy associated with this Web Application Firewall policy. - -## CustomRuleList -### Properties -* **rules**: [CustomRule](#customrule)[]: List of rules - ## CustomRule ### Properties * **action**: 'Allow' | 'Block' | 'Log' | 'Redirect' | string (Required): Defines the action to take on rule match. @@ -39,31 +24,14 @@ * **rateLimitThreshold**: int: Number of allowed requests per client within the time window. * **ruleType**: 'MatchRule' | 'RateLimitRule' | string (Required): Describes type of rule. -## MatchCondition +## CustomRuleList ### Properties -* **matchValue**: string[] (Required): List of possible match values. -* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Request variable to compare with. -* **negateCondition**: bool: Describes if the result of this condition should be negated. -* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Comparison type to use for matching with the variable value. -* **selector**: string: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. -* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **rules**: [CustomRule](#customrule)[]: List of rules ## FrontendEndpointLink ### Properties * **id**: string: Resource ID. -## ManagedRuleSetList -### Properties -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. - -## ManagedRuleSet -### Properties -* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the set. -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetAction**: 'Block' | 'Log' | 'Redirect' | string: Defines the action to take when a managed rule set score threshold is met. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. - ## ManagedRuleExclusion ### Properties * **matchVariable**: 'QueryStringArgNames' | 'RequestBodyJsonArgNames' | 'RequestBodyPostArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable type to be excluded. @@ -83,6 +51,27 @@ * **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to this specific rule. * **ruleId**: string (Required): Identifier for the managed rule. +## ManagedRuleSet +### Properties +* **exclusions**: [ManagedRuleExclusion](#managedruleexclusion)[]: Describes the exclusions that are applied to all rules in the set. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetAction**: 'Block' | 'Log' | 'Redirect' | string: Defines the action to take when a managed rule set score threshold is met. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedRuleSetList +### Properties +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[]: List of rule sets. + +## MatchCondition +### Properties +* **matchValue**: string[] (Required): List of possible match values. +* **matchVariable**: 'Cookies' | 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestHeader' | 'RequestMethod' | 'RequestUri' | 'SocketAddr' | string (Required): Request variable to compare with. +* **negateCondition**: bool: Describes if the result of this condition should be negated. +* **operator**: 'Any' | 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'RegEx' | string (Required): Comparison type to use for matching with the variable value. +* **selector**: string: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. +* **transforms**: 'Lowercase' | 'RemoveNulls' | 'Trim' | 'Uppercase' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. + ## PolicySettings ### Properties * **customBlockResponseBody**: string: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. @@ -92,6 +81,11 @@ * **redirectUrl**: string: If action type is redirect, this field represents redirect URL for the client. * **requestBodyCheck**: 'Disabled' | 'Enabled' | string: Describes if policy managed rules will inspect the request body content. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## RoutingRuleLink ### Properties * **id**: string: Resource ID. @@ -104,8 +98,14 @@ ### Properties * **name**: 'Classic_AzureFrontDoor' | 'Premium_AzureFrontDoor' | 'Standard_AzureFrontDoor' | string: Name of the pricing tier. -## ResourceTags +## WebApplicationFirewallPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customRules**: [CustomRuleList](#customrulelist): Defines contents of custom rules +* **frontendEndpointLinks**: [FrontendEndpointLink](#frontendendpointlink)[] (ReadOnly): Describes Frontend Endpoints associated with this Web Application Firewall policy. +* **managedRules**: [ManagedRuleSetList](#managedrulesetlist): Defines the list of managed rule sets for the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines top-level WebApplicationFirewallPolicy configuration settings. +* **provisioningState**: string (ReadOnly): Provisioning state of the policy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **routingRuleLinks**: [RoutingRuleLink](#routingrulelink)[] (ReadOnly): Describes Routing Rules associated with this Web Application Firewall policy. +* **securityPolicyLinks**: [SecurityPolicyLink](#securitypolicylink)[] (ReadOnly): Describes Security Policy associated with this Web Application Firewall policy. diff --git a/generated/guestconfiguration/log.out b/generated/guestconfiguration/log.out index cba0f53af6..6c412c3e71 100644 --- a/generated/guestconfiguration/log.out +++ b/generated/guestconfiguration/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.guestconfiguration-2021-01-25"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GuestConfigurationAssignmentList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json:1134:5 @@ -58,7 +58,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-properties' with an warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.guestconfiguration-2020-06-25"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -66,7 +66,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GuestConfigurationAssignmentList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json:855:5 @@ -108,7 +108,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-properties' with an warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.guestconfiguration-2018-11-20"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -116,7 +116,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GuestConfigurationAssignmentList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json:855:5 @@ -163,7 +163,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GuestConfigurationAssignmentList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json:415:5 @@ -200,7 +200,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'Operation-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.guestconfiguration-2018-01-20-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -208,7 +208,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GuestConfigurationAssignmentList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json:314:5 @@ -231,5 +231,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'Operation-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms -info | Autorest completed in 12s. 10 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 11.93s. 10 files generated. diff --git a/generated/guestconfiguration/microsoft.guestconfiguration/2018-01-20-preview/types.md b/generated/guestconfiguration/microsoft.guestconfiguration/2018-01-20-preview/types.md index 8c041cae77..3d10881892 100644 --- a/generated/guestconfiguration/microsoft.guestconfiguration/2018-01-20-preview/types.md +++ b/generated/guestconfiguration/microsoft.guestconfiguration/2018-01-20-preview/types.md @@ -10,6 +10,15 @@ * **properties**: [GuestConfigurationAssignmentProperties](#guestconfigurationassignmentproperties): Properties of guest configuration assignment object. * **type**: 'Microsoft.GuestConfiguration/guestConfigurationAssignments' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationParameter +### Properties +* **name**: string (ReadOnly): Name of the configuration parameter. +* **value**: string (ReadOnly): Value of the configuration parameter. + +## ConfigurationParameterList +### Properties +* **value**: [ConfigurationParameter](#configurationparameter)[]: Represents the list for configuration parameters. + ## GuestConfigurationAssignmentProperties ### Properties * **assignmentHash**: string (ReadOnly): Combined hash of the configuration package and parameters. @@ -27,12 +36,3 @@ * **name**: string: Name of the guest configuration. * **type**: string: Type of the guest configuration. -## ConfigurationParameterList -### Properties -* **value**: [ConfigurationParameter](#configurationparameter)[]: Represents the list for configuration parameters. - -## ConfigurationParameter -### Properties -* **name**: string (ReadOnly): Name of the configuration parameter. -* **value**: string (ReadOnly): Value of the configuration parameter. - diff --git a/generated/guestconfiguration/microsoft.guestconfiguration/2018-06-30-preview/types.md b/generated/guestconfiguration/microsoft.guestconfiguration/2018-06-30-preview/types.md index 0775e23ea4..68281b6202 100644 --- a/generated/guestconfiguration/microsoft.guestconfiguration/2018-06-30-preview/types.md +++ b/generated/guestconfiguration/microsoft.guestconfiguration/2018-06-30-preview/types.md @@ -10,6 +10,20 @@ * **properties**: [GuestConfigurationAssignmentProperties](#guestconfigurationassignmentproperties): Guest configuration assignment properties. * **type**: 'Microsoft.GuestConfiguration/guestConfigurationAssignments' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationParameter +### Properties +* **name**: string (ReadOnly): Name of the configuration parameter. +* **value**: string (ReadOnly): Value of the configuration parameter. + +## ConfigurationSetting +### Properties +* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration +* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false +* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. +* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. +* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. +* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. + ## GuestConfigurationAssignmentProperties ### Properties * **assignmentHash**: string (ReadOnly): Combined hash of the configuration package and parameters. @@ -30,17 +44,3 @@ * **name**: string: Name of the guest configuration. * **version**: string: Version of the guest configuration. -## ConfigurationParameter -### Properties -* **name**: string (ReadOnly): Name of the configuration parameter. -* **value**: string (ReadOnly): Value of the configuration parameter. - -## ConfigurationSetting -### Properties -* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration -* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false -* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. -* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. -* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. -* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. - diff --git a/generated/guestconfiguration/microsoft.guestconfiguration/2018-11-20/types.md b/generated/guestconfiguration/microsoft.guestconfiguration/2018-11-20/types.md index e5e8c0a85d..1167cbc562 100644 --- a/generated/guestconfiguration/microsoft.guestconfiguration/2018-11-20/types.md +++ b/generated/guestconfiguration/microsoft.guestconfiguration/2018-11-20/types.md @@ -10,6 +10,20 @@ * **properties**: [GuestConfigurationAssignmentProperties](#guestconfigurationassignmentproperties): Guest configuration assignment properties. * **type**: 'Microsoft.GuestConfiguration/guestConfigurationAssignments' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationParameter +### Properties +* **name**: string: Name of the configuration parameter. +* **value**: string: Value of the configuration parameter. + +## ConfigurationSetting +### Properties +* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration +* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false +* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. +* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. +* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. +* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. + ## GuestConfigurationAssignmentProperties ### Properties * **assignmentHash**: string (ReadOnly): Combined hash of the configuration package and parameters. @@ -36,20 +50,6 @@ * **name**: string: Name of the guest configuration. * **version**: string: Version of the guest configuration. -## ConfigurationParameter -### Properties -* **name**: string: Name of the configuration parameter. -* **value**: string: Value of the configuration parameter. - -## ConfigurationSetting -### Properties -* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration -* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false -* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. -* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. -* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. -* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. - ## VmssvmInfo ### Properties * **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. diff --git a/generated/guestconfiguration/microsoft.guestconfiguration/2020-06-25/types.md b/generated/guestconfiguration/microsoft.guestconfiguration/2020-06-25/types.md index cb940e3110..6b6a421d7d 100644 --- a/generated/guestconfiguration/microsoft.guestconfiguration/2020-06-25/types.md +++ b/generated/guestconfiguration/microsoft.guestconfiguration/2020-06-25/types.md @@ -10,6 +10,54 @@ * **properties**: [GuestConfigurationAssignmentProperties](#guestconfigurationassignmentproperties): Guest configuration assignment properties. * **type**: 'Microsoft.GuestConfiguration/guestConfigurationAssignments' (ReadOnly, DeployTimeConstant): The resource type +## AssignmentInfo +### Properties +* **configuration**: [ConfigurationInfo](#configurationinfo): Information about the configuration. +* **name**: string (ReadOnly): Name of the guest configuration assignment. + +## AssignmentReport +### Properties +* **assignment**: [AssignmentInfo](#assignmentinfo): Information about the guest configuration assignment. +* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. +* **endTime**: string (ReadOnly): End date and time of the guest configuration assignment compliance status check. +* **id**: string (ReadOnly): ARM resource id of the report for the guest configuration assignment. +* **operationType**: 'Consistency' | 'Initial' | string (ReadOnly): Type of report, Consistency or Initial +* **reportId**: string (ReadOnly): GUID that identifies the guest configuration assignment report under a subscription, resource group. +* **resources**: [AssignmentReportResource](#assignmentreportresource)[]: The list of resources for which guest configuration assignment compliance is checked. +* **startTime**: string (ReadOnly): Start date and time of the guest configuration assignment compliance status check. +* **vm**: [VMInfo](#vminfo): Information about the VM. + +## AssignmentReportResource +### Properties +* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. +* **properties**: any (ReadOnly): Any object +* **reasons**: [AssignmentReportResourceComplianceReason](#assignmentreportresourcecompliancereason)[]: Compliance reason and reason code for a resource. +* **resourceId**: string (ReadOnly): Name of the guest configuration assignment resource setting. + +## AssignmentReportResourceComplianceReason +### Properties +* **code**: string (ReadOnly): Code for the compliance of the guest configuration assignment resource. +* **phrase**: string (ReadOnly): Reason for the compliance of the guest configuration assignment resource. + +## ConfigurationInfo +### Properties +* **name**: string (ReadOnly): Name of the configuration. +* **version**: string (ReadOnly): Version of the configuration. + +## ConfigurationParameter +### Properties +* **name**: string: Name of the configuration parameter. +* **value**: string: Value of the configuration parameter. + +## ConfigurationSetting +### Properties +* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration +* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false +* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. +* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. +* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. +* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. + ## GuestConfigurationAssignmentProperties ### Properties * **assignmentHash**: string (ReadOnly): Combined hash of the configuration package and parameters. @@ -38,54 +86,6 @@ * **name**: string: Name of the guest configuration. * **version**: string: Version of the guest configuration. -## ConfigurationParameter -### Properties -* **name**: string: Name of the configuration parameter. -* **value**: string: Value of the configuration parameter. - -## ConfigurationSetting -### Properties -* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration -* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false -* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. -* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. -* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. -* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. - -## AssignmentReport -### Properties -* **assignment**: [AssignmentInfo](#assignmentinfo): Information about the guest configuration assignment. -* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. -* **endTime**: string (ReadOnly): End date and time of the guest configuration assignment compliance status check. -* **id**: string (ReadOnly): ARM resource id of the report for the guest configuration assignment. -* **operationType**: 'Consistency' | 'Initial' | string (ReadOnly): Type of report, Consistency or Initial -* **reportId**: string (ReadOnly): GUID that identifies the guest configuration assignment report under a subscription, resource group. -* **resources**: [AssignmentReportResource](#assignmentreportresource)[]: The list of resources for which guest configuration assignment compliance is checked. -* **startTime**: string (ReadOnly): Start date and time of the guest configuration assignment compliance status check. -* **vm**: [VMInfo](#vminfo): Information about the VM. - -## AssignmentInfo -### Properties -* **configuration**: [ConfigurationInfo](#configurationinfo): Information about the configuration. -* **name**: string (ReadOnly): Name of the guest configuration assignment. - -## ConfigurationInfo -### Properties -* **name**: string (ReadOnly): Name of the configuration. -* **version**: string (ReadOnly): Version of the configuration. - -## AssignmentReportResource -### Properties -* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. -* **properties**: any (ReadOnly): Any object -* **reasons**: [AssignmentReportResourceComplianceReason](#assignmentreportresourcecompliancereason)[]: Compliance reason and reason code for a resource. -* **resourceId**: string (ReadOnly): Name of the guest configuration assignment resource setting. - -## AssignmentReportResourceComplianceReason -### Properties -* **code**: string (ReadOnly): Code for the compliance of the guest configuration assignment resource. -* **phrase**: string (ReadOnly): Reason for the compliance of the guest configuration assignment resource. - ## VMInfo ### Properties * **id**: string (ReadOnly): Azure resource Id of the VM. diff --git a/generated/guestconfiguration/microsoft.guestconfiguration/2021-01-25/types.md b/generated/guestconfiguration/microsoft.guestconfiguration/2021-01-25/types.md index db11f29b7e..9bcae3854c 100644 --- a/generated/guestconfiguration/microsoft.guestconfiguration/2021-01-25/types.md +++ b/generated/guestconfiguration/microsoft.guestconfiguration/2021-01-25/types.md @@ -11,6 +11,54 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.GuestConfiguration/guestConfigurationAssignments' (ReadOnly, DeployTimeConstant): The resource type +## AssignmentInfo +### Properties +* **configuration**: [ConfigurationInfo](#configurationinfo): Information about the configuration. +* **name**: string (ReadOnly): Name of the guest configuration assignment. + +## AssignmentReport +### Properties +* **assignment**: [AssignmentInfo](#assignmentinfo): Information about the guest configuration assignment. +* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. +* **endTime**: string (ReadOnly): End date and time of the guest configuration assignment compliance status check. +* **id**: string (ReadOnly): ARM resource id of the report for the guest configuration assignment. +* **operationType**: 'Consistency' | 'Initial' | string (ReadOnly): Type of report, Consistency or Initial +* **reportId**: string (ReadOnly): GUID that identifies the guest configuration assignment report under a subscription, resource group. +* **resources**: [AssignmentReportResource](#assignmentreportresource)[]: The list of resources for which guest configuration assignment compliance is checked. +* **startTime**: string (ReadOnly): Start date and time of the guest configuration assignment compliance status check. +* **vm**: [VMInfo](#vminfo): Information about the VM. + +## AssignmentReportResource +### Properties +* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. +* **properties**: any (ReadOnly): Any object +* **reasons**: [AssignmentReportResourceComplianceReason](#assignmentreportresourcecompliancereason)[]: Compliance reason and reason code for a resource. +* **resourceId**: string (ReadOnly): Name of the guest configuration assignment resource setting. + +## AssignmentReportResourceComplianceReason +### Properties +* **code**: string (ReadOnly): Code for the compliance of the guest configuration assignment resource. +* **phrase**: string (ReadOnly): Reason for the compliance of the guest configuration assignment resource. + +## ConfigurationInfo +### Properties +* **name**: string (ReadOnly): Name of the configuration. +* **version**: string (ReadOnly): Version of the configuration. + +## ConfigurationParameter +### Properties +* **name**: string: Name of the configuration parameter. +* **value**: string: Value of the configuration parameter. + +## ConfigurationSetting +### Properties +* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration +* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false +* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. +* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. +* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. +* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. + ## GuestConfigurationAssignmentProperties ### Properties * **assignmentHash**: string (ReadOnly): Combined hash of the configuration package and parameters. @@ -39,53 +87,14 @@ * **name**: string: Name of the guest configuration. * **version**: string: Version of the guest configuration. -## ConfigurationParameter -### Properties -* **name**: string: Name of the configuration parameter. -* **value**: string: Value of the configuration parameter. - -## ConfigurationSetting -### Properties -* **actionAfterReboot**: 'ContinueConfiguration' | 'StopConfiguration' | string: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration -* **allowModuleOverwrite**: bool: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false -* **configurationMode**: 'ApplyAndAutoCorrect' | 'ApplyAndMonitor' | 'ApplyOnly' | string: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. -* **configurationModeFrequencyMins**: int: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. -* **rebootIfNeeded**: bool: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. -* **refreshFrequencyMins**: int: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. - -## AssignmentReport -### Properties -* **assignment**: [AssignmentInfo](#assignmentinfo): Information about the guest configuration assignment. -* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. -* **endTime**: string (ReadOnly): End date and time of the guest configuration assignment compliance status check. -* **id**: string (ReadOnly): ARM resource id of the report for the guest configuration assignment. -* **operationType**: 'Consistency' | 'Initial' | string (ReadOnly): Type of report, Consistency or Initial -* **reportId**: string (ReadOnly): GUID that identifies the guest configuration assignment report under a subscription, resource group. -* **resources**: [AssignmentReportResource](#assignmentreportresource)[]: The list of resources for which guest configuration assignment compliance is checked. -* **startTime**: string (ReadOnly): Start date and time of the guest configuration assignment compliance status check. -* **vm**: [VMInfo](#vminfo): Information about the VM. - -## AssignmentInfo -### Properties -* **configuration**: [ConfigurationInfo](#configurationinfo): Information about the configuration. -* **name**: string (ReadOnly): Name of the guest configuration assignment. - -## ConfigurationInfo -### Properties -* **name**: string (ReadOnly): Name of the configuration. -* **version**: string (ReadOnly): Version of the configuration. - -## AssignmentReportResource -### Properties -* **complianceStatus**: 'Compliant' | 'NonCompliant' | 'Pending' | string (ReadOnly): A value indicating compliance status of the machine for the assigned guest configuration. -* **properties**: any (ReadOnly): Any object -* **reasons**: [AssignmentReportResourceComplianceReason](#assignmentreportresourcecompliancereason)[]: Compliance reason and reason code for a resource. -* **resourceId**: string (ReadOnly): Name of the guest configuration assignment resource setting. - -## AssignmentReportResourceComplianceReason +## SystemData ### Properties -* **code**: string (ReadOnly): Code for the compliance of the guest configuration assignment resource. -* **phrase**: string (ReadOnly): Reason for the compliance of the guest configuration assignment resource. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## VMInfo ### Properties @@ -100,12 +109,3 @@ * **vmId**: string (ReadOnly): UUID of the VM. * **vmResourceId**: string (ReadOnly): Azure resource Id of the VM. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - diff --git a/generated/hanaonazure/log.out b/generated/hanaonazure/log.out index 7a82a08012..ba39b55a63 100644 --- a/generated/hanaonazure/log.out +++ b/generated/hanaonazure/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hanaonazure-2017-11-03-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json:490:5 @@ -32,7 +32,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.hanaonazure-2020-02-07-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SapMonitorListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json:594:5 @@ -47,5 +47,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ProviderInstance' with an und warning | PreCheck/SchemaMissingType | The schema 'ProviderInstanceProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json:709:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 6.39s. 4 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 6.2s. 4 files generated. diff --git a/generated/hanaonazure/microsoft.hanaonazure/2017-11-03-preview/types.md b/generated/hanaonazure/microsoft.hanaonazure/2017-11-03-preview/types.md index 4359ad6bdf..acb95f5231 100644 --- a/generated/hanaonazure/microsoft.hanaonazure/2017-11-03-preview/types.md +++ b/generated/hanaonazure/microsoft.hanaonazure/2017-11-03-preview/types.md @@ -11,6 +11,12 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.HanaOnAzure/hanaInstances' (ReadOnly, DeployTimeConstant): The resource type +## Disk +### Properties +* **diskSizeGB**: int: Specifies the size of an empty data disk in gigabytes. +* **lun**: int (ReadOnly): 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. +* **name**: string: The disk name. + ## HanaInstanceProperties ### Properties * **hanaInstanceId**: string (ReadOnly): Specifies the HANA instance unique ID. @@ -29,15 +35,15 @@ * **hanaInstanceSize**: 'S112' | 'S144' | 'S144m' | 'S192' | 'S192m' | 'S192xm' | 'S224' | 'S224m' | 'S224om' | 'S224oo' | 'S224oom' | 'S224ooo' | 'S384' | 'S384m' | 'S384xm' | 'S384xxm' | 'S448' | 'S448m' | 'S448om' | 'S448oo' | 'S448oom' | 'S448ooo' | 'S576m' | 'S576xm' | 'S672' | 'S672m' | 'S672om' | 'S672oo' | 'S672oom' | 'S672ooo' | 'S72' | 'S72m' | 'S768' | 'S768m' | 'S768xm' | 'S896' | 'S896m' | 'S896om' | 'S896oo' | 'S896oom' | 'S896ooo' | 'S96' | 'S960m' | string (ReadOnly): Specifies the HANA instance SKU. * **hardwareType**: 'Cisco_UCS' | 'HPE' | string (ReadOnly): Name of the hardware type (vendor and/or their product name) +## IpAddress +### Properties +* **ipAddress**: string: Specifies the IP address of the network interface. + ## NetworkProfile ### Properties * **circuitId**: string (ReadOnly): Specifies the circuit id for connecting to express route. * **networkInterfaces**: [IpAddress](#ipaddress)[]: Specifies the network interfaces for the HANA instance. -## IpAddress -### Properties -* **ipAddress**: string: Specifies the IP address of the network interface. - ## OSProfile ### Properties * **computerName**: string: Specifies the host OS name of the HANA instance. @@ -45,11 +51,10 @@ * **sshPublicKey**: string: Specifies the SSH public key used to access the operating system. * **version**: string (ReadOnly): Specifies version of operating system. -## StorageProfile +## ResourceTags ### Properties -* **hanaSids**: [SAPSystemID](#sapsystemid)[]: Specifies information related to SAP system IDs for the hana instance. -* **nfsIpAddress**: string (ReadOnly): IP Address to connect to storage. -* **osDisks**: [Disk](#disk)[]: Specifies information about the operating system disk used by the hana instance. +### Additional Properties +* **Additional Properties Type**: string ## SAPSystemID ### Properties @@ -59,14 +64,9 @@ * **uid**: string: User ID of the HANA database user. * **username**: string: Name of the HANA database user. -## Disk -### Properties -* **diskSizeGB**: int: Specifies the size of an empty data disk in gigabytes. -* **lun**: int (ReadOnly): 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. -* **name**: string: The disk name. - -## ResourceTags +## StorageProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hanaSids**: [SAPSystemID](#sapsystemid)[]: Specifies information related to SAP system IDs for the hana instance. +* **nfsIpAddress**: string (ReadOnly): IP Address to connect to storage. +* **osDisks**: [Disk](#disk)[]: Specifies information about the operating system disk used by the hana instance. diff --git a/generated/hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.md b/generated/hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.md index dbdb50b6ad..4b75958698 100644 --- a/generated/hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.md +++ b/generated/hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.md @@ -20,6 +20,13 @@ * **properties**: [ProviderInstanceProperties](#providerinstanceproperties): Describes the properties of a provider instance. * **type**: 'Microsoft.HanaOnAzure/sapMonitors/providerInstances' (ReadOnly, DeployTimeConstant): The resource type +## ProviderInstanceProperties +### Properties +* **metadata**: string: A JSON string containing metadata of the provider instance. +* **properties**: string: A JSON string containing the properties of the provider instance. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): State of provisioning of the HanaInstance +* **type**: string: The type of provider instance. + ## SapMonitorProperties ### Properties * **enableCustomerAnalytics**: bool: The value indicating whether to send analytics to Microsoft @@ -36,10 +43,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ProviderInstanceProperties -### Properties -* **metadata**: string: A JSON string containing metadata of the provider instance. -* **properties**: string: A JSON string containing the properties of the provider instance. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Migrating' | 'Succeeded' | 'Updating' | string (ReadOnly): State of provisioning of the HanaInstance -* **type**: string: The type of provider instance. - diff --git a/generated/hardwaresecuritymodules/log.out b/generated/hardwaresecuritymodules/log.out index 166d60b9a5..13b38ea584 100644 --- a/generated/hardwaresecuritymodules/log.out +++ b/generated/hardwaresecuritymodules/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hardwaresecuritymodules-2018-10-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DedicatedHsmOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json:423:9 @@ -37,10 +37,10 @@ warning | PreCheck/SchemaMissingType | The schema 'Error' with an undefined type warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json:706:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.hardwaresecuritymodules-2021-11-30"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DedicatedHsmOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json:492:9 @@ -72,4 +72,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json:787:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 6.01s. 4 files generated. +info | Autorest completed in 5.94s. 4 files generated. diff --git a/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2018-10-31-preview/types.md b/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2018-10-31-preview/types.md index a1e4164457..583b1fa87a 100644 --- a/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2018-10-31-preview/types.md +++ b/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2018-10-31-preview/types.md @@ -13,6 +13,10 @@ * **type**: 'Microsoft.HardwareSecurityModules/dedicatedHSMs' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[]: The Dedicated Hsm zones. +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + ## DedicatedHsmProperties ### Properties * **networkProfile**: [NetworkProfile](#networkprofile) @@ -20,26 +24,22 @@ * **stampId**: string: This field will be used when RP does not support Availability zones. * **statusMessage**: string (ReadOnly): Resource Status Message. -## NetworkProfile -### Properties -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. -* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. - ## NetworkInterface ### Properties * **id**: string (ReadOnly): The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * **privateIpAddress**: string: Private Ip address of the interface -## ApiEntityReference -### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... - -## Sku +## NetworkProfile ### Properties -* **name**: 'SafeNet Luna Network HSM A790' | 'payShield10K_LMK1_CPS250' | 'payShield10K_LMK1_CPS2500' | 'payShield10K_LMK1_CPS60' | 'payShield10K_LMK2_CPS250' | 'payShield10K_LMK2_CPS2500' | 'payShield10K_LMK2_CPS60' | string: SKU of the dedicated HSM +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. +* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **name**: 'SafeNet Luna Network HSM A790' | 'payShield10K_LMK1_CPS250' | 'payShield10K_LMK1_CPS2500' | 'payShield10K_LMK1_CPS60' | 'payShield10K_LMK2_CPS250' | 'payShield10K_LMK2_CPS2500' | 'payShield10K_LMK2_CPS60' | string: SKU of the dedicated HSM + diff --git a/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2021-11-30/types.md b/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2021-11-30/types.md index 39da6a7161..ed4b8056e7 100644 --- a/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2021-11-30/types.md +++ b/generated/hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2021-11-30/types.md @@ -14,6 +14,10 @@ * **type**: 'Microsoft.HardwareSecurityModules/dedicatedHSMs' (ReadOnly, DeployTimeConstant): The resource type * **zones**: string[]: The Dedicated Hsm zones. +## ApiEntityReference +### Properties +* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... + ## DedicatedHsmProperties ### Properties * **managementNetworkProfile**: [NetworkProfile](#networkprofile): The network profile definition. @@ -22,19 +26,20 @@ * **stampId**: string: This field will be used when RP does not support Availability zones. * **statusMessage**: string (ReadOnly): Resource Status Message. -## NetworkProfile -### Properties -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. -* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. - ## NetworkInterface ### Properties * **id**: string (ReadOnly): The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... * **privateIpAddress**: string: Private Ip address of the interface -## ApiEntityReference +## NetworkProfile ### Properties -* **id**: string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. +* **subnet**: [ApiEntityReference](#apientityreference): The API entity reference. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## Sku ### Properties @@ -49,8 +54,3 @@ * **lastModifiedBy**: string: The identity that last modified dedicated hsm resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/hdinsight/log.out b/generated/hdinsight/log.out index 1332cab30c..3259e52bd4 100644 --- a/generated/hdinsight/log.out +++ b/generated/hdinsight/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hdinsight-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/cluster.json:2186:5 @@ -35,7 +35,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json:743:5 @@ -202,7 +202,7 @@ warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ClusterListRuntimeScriptActionDetailResult' -> 'ClusterListRuntimeScriptActionDetailResultAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. warning | Skipping resource type microsoft.hdinsight/clusters/extensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring': Found multiple definitions for the same type -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.hdinsight-2015-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -210,7 +210,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json:743:5 @@ -378,4 +378,4 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ClusterListRunt warning | Unrecognized property type: any-object. Returning 'any'. warning | Skipping resource type microsoft.hdinsight/clusters/extensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring': Found multiple definitions for the same type info | autorest.bicep took 6ms -info | Autorest completed in 18.15s. 6 files generated. +info | Autorest completed in 17.45s. 6 files generated. diff --git a/generated/hdinsight/microsoft.hdinsight/2015-03-01-preview/types.md b/generated/hdinsight/microsoft.hdinsight/2015-03-01-preview/types.md index 92ab3a1242..74f4acafde 100644 --- a/generated/hdinsight/microsoft.hdinsight/2015-03-01-preview/types.md +++ b/generated/hdinsight/microsoft.hdinsight/2015-03-01-preview/types.md @@ -29,23 +29,77 @@ * **ApiVersion**: 2015-03-01-preview * **Output**: [HostInfo](#hostinfo)[] -## ClusterIdentity +## ApplicationGetEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal id of cluster identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the cluster. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ClusterIdentityUserAssignedIdentities](#clusteridentityuserassignedidentities): 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}'. +* **destinationPort**: int: The destination port to connect to. +* **location**: string: The location of the endpoint. +* **privateIPAddress**: string: The private ip address of the endpoint. +* **publicPort**: int: The public port to connect to. -## ClusterIdentityUserAssignedIdentities +## ApplicationGetHttpsEndpoint +### Properties +* **accessModes**: string[]: The list of access modes for the application. +* **destinationPort**: int: The destination port to connect to. +* **disableGatewayAuth**: bool (WriteOnly): The value indicates whether to disable GatewayAuth. +* **location**: string (ReadOnly): The location of the endpoint. +* **privateIPAddress**: string: The private ip address of the endpoint. +* **publicPort**: int (ReadOnly): The public port to connect to. +* **subDomainSuffix**: string (WriteOnly): The subdomain suffix of the application. + +## ApplicationProperties +### Properties +* **applicationState**: string (ReadOnly): The application state. +* **applicationType**: string: The application type. +* **computeProfile**: [ComputeProfile](#computeprofile): Describes the compute profile. +* **createdDate**: string (ReadOnly): The application create date time. +* **errors**: [Errors](#errors)[]: The list of errors. +* **httpsEndpoints**: [ApplicationGetHttpsEndpoint](#applicationgethttpsendpoint)[]: The list of application HTTPS endpoints. +* **installScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of install script actions. +* **marketplaceIdentifier**: string (ReadOnly): The marketplace identifier. +* **provisioningState**: string (ReadOnly): The provisioning state of the application. +* **sshEndpoints**: [ApplicationGetEndpoint](#applicationgetendpoint)[]: The list of application SSH endpoints. +* **uninstallScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of uninstall script actions. + +## ApplicationTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsc51ht8schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **Additional Properties Type**: string -## ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties +## Autoscale ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. -* **tenantId**: string: The tenant id of user assigned identity. +* **capacity**: [AutoscaleCapacity](#autoscalecapacity): The load-based autoscale request parameters +* **recurrence**: [AutoscaleRecurrence](#autoscalerecurrence): Schedule-based autoscale request parameters + +## AutoscaleCapacity +### Properties +* **maxInstanceCount**: int: The maximum instance count of the cluster +* **minInstanceCount**: int: The minimum instance count of the cluster + +## AutoscaleRecurrence +### Properties +* **schedule**: [AutoscaleSchedule](#autoscaleschedule)[]: Array of schedule-based autoscale rules +* **timeZone**: string: The time zone for the autoscale schedule times + +## AutoscaleSchedule +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Days of the week for a schedule-based autoscale rule +* **timeAndCapacity**: [AutoscaleTimeAndCapacity](#autoscaletimeandcapacity): Time and capacity request parameters + +## AutoscaleTimeAndCapacity +### Properties +* **maxInstanceCount**: int: The maximum instance count of the cluster +* **minInstanceCount**: int: The minimum instance count of the cluster +* **time**: string: 24-hour time in the form xx:xx + +## ClientGroupInfo +### Properties +* **groupId**: string: The AAD security group id. +* **groupName**: string: The AAD security group name. + +## ClusterCreateParametersExtendedTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ClusterCreateProperties ### Properties @@ -84,93 +138,32 @@ ### Additional Properties * **Additional Properties Type**: string -## ComputeIsolationProperties -### Properties -* **enableComputeIsolation**: bool: The flag indicates whether enable compute isolation or not. -* **hostSku**: string: The host sku. - -## ComputeProfile -### Properties -* **roles**: [Role](#role)[]: The list of roles in the cluster. - -## Role -### Properties -* **autoscale**: [Autoscale](#autoscale): The autoscale request parameters -* **dataDisksGroups**: [DataDisksGroups](#datadisksgroups)[]: The data disks groups for the role. -* **encryptDataDisks**: bool: Indicates whether encrypt the data disks. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): The hardware profile. -* **minInstanceCount**: int: The minimum instance count of the cluster. -* **name**: string: The name of the role. -* **osProfile**: [OsProfile](#osprofile): The Linux operation systems profile. -* **scriptActions**: [ScriptAction](#scriptaction)[]: The list of script actions on the role. -* **targetInstanceCount**: int: The instance count of the cluster. -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): The virtual network properties. -* **VMGroupName**: string: The name of the virtual machine group. - -## Autoscale -### Properties -* **capacity**: [AutoscaleCapacity](#autoscalecapacity): The load-based autoscale request parameters -* **recurrence**: [AutoscaleRecurrence](#autoscalerecurrence): Schedule-based autoscale request parameters - -## AutoscaleCapacity -### Properties -* **maxInstanceCount**: int: The maximum instance count of the cluster -* **minInstanceCount**: int: The minimum instance count of the cluster - -## AutoscaleRecurrence -### Properties -* **schedule**: [AutoscaleSchedule](#autoscaleschedule)[]: Array of schedule-based autoscale rules -* **timeZone**: string: The time zone for the autoscale schedule times - -## AutoscaleSchedule -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Days of the week for a schedule-based autoscale rule -* **timeAndCapacity**: [AutoscaleTimeAndCapacity](#autoscaletimeandcapacity): Time and capacity request parameters - -## AutoscaleTimeAndCapacity -### Properties -* **maxInstanceCount**: int: The maximum instance count of the cluster -* **minInstanceCount**: int: The minimum instance count of the cluster -* **time**: string: 24-hour time in the form xx:xx - -## DataDisksGroups -### Properties -* **diskSizeGB**: int (ReadOnly): ReadOnly. The DiskSize in GB. Do not set this value. -* **disksPerNode**: int: The number of disks per node. -* **storageAccountType**: string (ReadOnly): ReadOnly. The storage account type. Do not set this value. - -## HardwareProfile -### Properties -* **vmSize**: string: The size of the VM - -## OsProfile -### Properties -* **linuxOperatingSystemProfile**: [LinuxOperatingSystemProfile](#linuxoperatingsystemprofile): The ssh username, password, and ssh public key. - -## LinuxOperatingSystemProfile +## ClusterIdentity ### Properties -* **password**: string: The password. -* **sshProfile**: [SshProfile](#sshprofile): The list of SSH public keys. -* **username**: string: The username. +* **principalId**: string (ReadOnly): The principal id of cluster identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the cluster. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ClusterIdentityUserAssignedIdentities](#clusteridentityuserassignedidentities): 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}'. -## SshProfile +## ClusterIdentityUserAssignedIdentities ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys. +### Additional Properties +* **Additional Properties Type**: [ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsc51ht8schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties) -## SshPublicKey +## ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **certificateData**: string: The certificate for SSH. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **tenantId**: string: The tenant id of user assigned identity. -## ScriptAction +## ComputeIsolationProperties ### Properties -* **name**: string (Required): The name of the script action. -* **parameters**: string (Required): The parameters for the script provided. -* **uri**: string (Required): The URI to the script. +* **enableComputeIsolation**: bool: The flag indicates whether enable compute isolation or not. +* **hostSku**: string: The host sku. -## VirtualNetworkProfile +## ComputeProfile ### Properties -* **id**: string: The ID of the virtual network. -* **subnet**: string: The name of the subnet. +* **roles**: [Role](#role)[]: The list of roles in the cluster. ## ConnectivityEndpoint ### Properties @@ -180,6 +173,12 @@ * **privateIPAddress**: string (ReadOnly): The private ip address of the endpoint. * **protocol**: string (ReadOnly): The protocol of the endpoint. +## DataDisksGroups +### Properties +* **diskSizeGB**: int (ReadOnly): ReadOnly. The DiskSize in GB. Do not set this value. +* **disksPerNode**: int: The number of disks per node. +* **storageAccountType**: string (ReadOnly): ReadOnly. The storage account type. Do not set this value. + ## DiskEncryptionProperties ### Properties * **encryptionAlgorithm**: 'RSA-OAEP' | 'RSA-OAEP-256' | 'RSA1_5' | string: Algorithm identifier for encryption, default RSA-OAEP. @@ -203,30 +202,73 @@ * **excludedServicesConfigId**: string (ReadOnly): The config id of excluded services. * **excludedServicesList**: string (ReadOnly): The list of excluded services. +## HardwareProfile +### Properties +* **vmSize**: string: The size of the VM + +## HostInfo +### Properties +* **effectiveDiskEncryptionKeyUrl**: string (ReadOnly): The effective disk encryption key URL used by the host +* **fqdn**: string (ReadOnly): The Fully Qualified Domain Name of host +* **name**: string (ReadOnly): The host name + ## KafkaRestProperties ### Properties * **clientGroupInfo**: [ClientGroupInfo](#clientgroupinfo): The information of AAD security group. * **configurationOverride**: [KafkaRestPropertiesConfigurationOverride](#kafkarestpropertiesconfigurationoverride): The configurations that need to be overriden. -## ClientGroupInfo -### Properties -* **groupId**: string: The AAD security group id. -* **groupName**: string: The AAD security group name. - ## KafkaRestPropertiesConfigurationOverride ### Properties ### Additional Properties * **Additional Properties Type**: string +## LinuxOperatingSystemProfile +### Properties +* **password**: string: The password. +* **sshProfile**: [SshProfile](#sshprofile): The list of SSH public keys. +* **username**: string: The username. + ## NetworkProperties ### Properties * **privateLink**: 'Disabled' | 'Enabled' | string: Indicates whether or not private link is enabled. * **resourceProviderConnection**: 'Inbound' | 'Outbound' | string: The direction for the resource provider connection. +## OsProfile +### Properties +* **linuxOperatingSystemProfile**: [LinuxOperatingSystemProfile](#linuxoperatingsystemprofile): The ssh username, password, and ssh public key. + ## QuotaInfo ### Properties * **coresUsed**: int (ReadOnly): The cores used by the cluster. +## Role +### Properties +* **autoscale**: [Autoscale](#autoscale): The autoscale request parameters +* **dataDisksGroups**: [DataDisksGroups](#datadisksgroups)[]: The data disks groups for the role. +* **encryptDataDisks**: bool: Indicates whether encrypt the data disks. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): The hardware profile. +* **minInstanceCount**: int: The minimum instance count of the cluster. +* **name**: string: The name of the role. +* **osProfile**: [OsProfile](#osprofile): The Linux operation systems profile. +* **scriptActions**: [ScriptAction](#scriptaction)[]: The list of script actions on the role. +* **targetInstanceCount**: int: The instance count of the cluster. +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): The virtual network properties. +* **VMGroupName**: string: The name of the virtual machine group. + +## RuntimeScriptAction +### Properties +* **applicationName**: string (ReadOnly): The application name of the script action, if any. +* **name**: string (Required): The name of the script action. +* **parameters**: string (WriteOnly): The parameters for the script +* **roles**: string[] (Required): The list of roles where script will be executed. +* **uri**: string (Required): The URI to the script. + +## ScriptAction +### Properties +* **name**: string (Required): The name of the script action. +* **parameters**: string (Required): The parameters for the script provided. +* **uri**: string (Required): The URI to the script. + ## SecurityProfile ### Properties * **aaddsResourceId**: string: The resource ID of the user's Azure Active Directory Domain Service. @@ -239,9 +281,13 @@ * **msiResourceId**: string: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. * **organizationalUnitDN**: string: The organizational unit within the Active Directory to place the cluster and service accounts. -## StorageProfile +## SshProfile ### Properties -* **storageaccounts**: [StorageAccount](#storageaccount)[]: The list of storage accounts in the cluster. +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys. + +## SshPublicKey +### Properties +* **certificateData**: string: The certificate for SSH. ## StorageAccount ### Properties @@ -255,58 +301,12 @@ * **resourceId**: string: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. * **saskey**: string: The shared access signature key. -## ClusterCreateParametersExtendedTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationProperties -### Properties -* **applicationState**: string (ReadOnly): The application state. -* **applicationType**: string: The application type. -* **computeProfile**: [ComputeProfile](#computeprofile): Describes the compute profile. -* **createdDate**: string (ReadOnly): The application create date time. -* **errors**: [Errors](#errors)[]: The list of errors. -* **httpsEndpoints**: [ApplicationGetHttpsEndpoint](#applicationgethttpsendpoint)[]: The list of application HTTPS endpoints. -* **installScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of install script actions. -* **marketplaceIdentifier**: string (ReadOnly): The marketplace identifier. -* **provisioningState**: string (ReadOnly): The provisioning state of the application. -* **sshEndpoints**: [ApplicationGetEndpoint](#applicationgetendpoint)[]: The list of application SSH endpoints. -* **uninstallScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of uninstall script actions. - -## ApplicationGetHttpsEndpoint -### Properties -* **accessModes**: string[]: The list of access modes for the application. -* **destinationPort**: int: The destination port to connect to. -* **disableGatewayAuth**: bool (WriteOnly): The value indicates whether to disable GatewayAuth. -* **location**: string (ReadOnly): The location of the endpoint. -* **privateIPAddress**: string: The private ip address of the endpoint. -* **publicPort**: int (ReadOnly): The public port to connect to. -* **subDomainSuffix**: string (WriteOnly): The subdomain suffix of the application. - -## RuntimeScriptAction -### Properties -* **applicationName**: string (ReadOnly): The application name of the script action, if any. -* **name**: string (Required): The name of the script action. -* **parameters**: string (WriteOnly): The parameters for the script -* **roles**: string[] (Required): The list of roles where script will be executed. -* **uri**: string (Required): The URI to the script. - -## ApplicationGetEndpoint -### Properties -* **destinationPort**: int: The destination port to connect to. -* **location**: string: The location of the endpoint. -* **privateIPAddress**: string: The private ip address of the endpoint. -* **publicPort**: int: The public port to connect to. - -## ApplicationTags +## StorageProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **storageaccounts**: [StorageAccount](#storageaccount)[]: The list of storage accounts in the cluster. -## HostInfo +## VirtualNetworkProfile ### Properties -* **effectiveDiskEncryptionKeyUrl**: string (ReadOnly): The effective disk encryption key URL used by the host -* **fqdn**: string (ReadOnly): The Fully Qualified Domain Name of host -* **name**: string (ReadOnly): The host name +* **id**: string: The ID of the virtual network. +* **subnet**: string: The name of the subnet. diff --git a/generated/hdinsight/microsoft.hdinsight/2018-06-01-preview/types.md b/generated/hdinsight/microsoft.hdinsight/2018-06-01-preview/types.md index d14b040b3c..19ed4dfd71 100644 --- a/generated/hdinsight/microsoft.hdinsight/2018-06-01-preview/types.md +++ b/generated/hdinsight/microsoft.hdinsight/2018-06-01-preview/types.md @@ -29,23 +29,77 @@ * **ApiVersion**: 2018-06-01-preview * **Output**: [HostInfo](#hostinfo)[] -## ClusterIdentity +## ApplicationGetEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal id of cluster identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the cluster. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ClusterIdentityUserAssignedIdentities](#clusteridentityuserassignedidentities): 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}'. +* **destinationPort**: int: The destination port to connect to. +* **location**: string: The location of the endpoint. +* **privateIPAddress**: string: The private ip address of the endpoint. +* **publicPort**: int: The public port to connect to. -## ClusterIdentityUserAssignedIdentities +## ApplicationGetHttpsEndpoint +### Properties +* **accessModes**: string[]: The list of access modes for the application. +* **destinationPort**: int: The destination port to connect to. +* **disableGatewayAuth**: bool: The value indicates whether to disable GatewayAuth. +* **location**: string (ReadOnly): The location of the endpoint. +* **privateIPAddress**: string: The private ip address of the endpoint. +* **publicPort**: int (ReadOnly): The public port to connect to. +* **subDomainSuffix**: string: The subdomain suffix of the application. + +## ApplicationProperties +### Properties +* **applicationState**: string (ReadOnly): The application state. +* **applicationType**: string: The application type. +* **computeProfile**: [ComputeProfile](#computeprofile): Describes the compute profile. +* **createdDate**: string (ReadOnly): The application create date time. +* **errors**: [Errors](#errors)[]: The list of errors. +* **httpsEndpoints**: [ApplicationGetHttpsEndpoint](#applicationgethttpsendpoint)[]: The list of application HTTPS endpoints. +* **installScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of install script actions. +* **marketplaceIdentifier**: string (ReadOnly): The marketplace identifier. +* **provisioningState**: string (ReadOnly): The provisioning state of the application. +* **sshEndpoints**: [ApplicationGetEndpoint](#applicationgetendpoint)[]: The list of application SSH endpoints. +* **uninstallScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of uninstall script actions. + +## ApplicationTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsc51ht8schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties) +* **Additional Properties Type**: string -## ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties +## Autoscale ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. -* **tenantId**: string: The tenant id of user assigned identity. +* **capacity**: [AutoscaleCapacity](#autoscalecapacity): The load-based autoscale request parameters +* **recurrence**: [AutoscaleRecurrence](#autoscalerecurrence): Schedule-based autoscale request parameters + +## AutoscaleCapacity +### Properties +* **maxInstanceCount**: int: The maximum instance count of the cluster +* **minInstanceCount**: int: The minimum instance count of the cluster + +## AutoscaleRecurrence +### Properties +* **schedule**: [AutoscaleSchedule](#autoscaleschedule)[]: Array of schedule-based autoscale rules +* **timeZone**: string: The time zone for the autoscale schedule times + +## AutoscaleSchedule +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Days of the week for a schedule-based autoscale rule +* **timeAndCapacity**: [AutoscaleTimeAndCapacity](#autoscaletimeandcapacity): Time and capacity request parameters + +## AutoscaleTimeAndCapacity +### Properties +* **maxInstanceCount**: int: The maximum instance count of the cluster +* **minInstanceCount**: int: The minimum instance count of the cluster +* **time**: string: 24-hour time in the form xx:xx + +## ClientGroupInfo +### Properties +* **groupId**: string: The AAD security group id. +* **groupName**: string: The AAD security group name. + +## ClusterCreateParametersExtendedTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ClusterCreateProperties ### Properties @@ -84,93 +138,32 @@ ### Additional Properties * **Additional Properties Type**: string -## ComputeIsolationProperties -### Properties -* **enableComputeIsolation**: bool: The flag indicates whether enable compute isolation or not. -* **hostSku**: string: The host sku. - -## ComputeProfile -### Properties -* **roles**: [Role](#role)[]: The list of roles in the cluster. - -## Role -### Properties -* **autoscale**: [Autoscale](#autoscale): The autoscale request parameters -* **dataDisksGroups**: [DataDisksGroups](#datadisksgroups)[]: The data disks groups for the role. -* **encryptDataDisks**: bool: Indicates whether encrypt the data disks. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): The hardware profile. -* **minInstanceCount**: int: The minimum instance count of the cluster. -* **name**: string: The name of the role. -* **osProfile**: [OsProfile](#osprofile): The Linux operation systems profile. -* **scriptActions**: [ScriptAction](#scriptaction)[]: The list of script actions on the role. -* **targetInstanceCount**: int: The instance count of the cluster. -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): The virtual network properties. -* **VMGroupName**: string: The name of the virtual machine group. - -## Autoscale -### Properties -* **capacity**: [AutoscaleCapacity](#autoscalecapacity): The load-based autoscale request parameters -* **recurrence**: [AutoscaleRecurrence](#autoscalerecurrence): Schedule-based autoscale request parameters - -## AutoscaleCapacity -### Properties -* **maxInstanceCount**: int: The maximum instance count of the cluster -* **minInstanceCount**: int: The minimum instance count of the cluster - -## AutoscaleRecurrence -### Properties -* **schedule**: [AutoscaleSchedule](#autoscaleschedule)[]: Array of schedule-based autoscale rules -* **timeZone**: string: The time zone for the autoscale schedule times - -## AutoscaleSchedule -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Days of the week for a schedule-based autoscale rule -* **timeAndCapacity**: [AutoscaleTimeAndCapacity](#autoscaletimeandcapacity): Time and capacity request parameters - -## AutoscaleTimeAndCapacity -### Properties -* **maxInstanceCount**: int: The maximum instance count of the cluster -* **minInstanceCount**: int: The minimum instance count of the cluster -* **time**: string: 24-hour time in the form xx:xx - -## DataDisksGroups -### Properties -* **diskSizeGB**: int (ReadOnly): ReadOnly. The DiskSize in GB. Do not set this value. -* **disksPerNode**: int: The number of disks per node. -* **storageAccountType**: string (ReadOnly): ReadOnly. The storage account type. Do not set this value. - -## HardwareProfile -### Properties -* **vmSize**: string: The size of the VM - -## OsProfile -### Properties -* **linuxOperatingSystemProfile**: [LinuxOperatingSystemProfile](#linuxoperatingsystemprofile): The ssh username, password, and ssh public key. - -## LinuxOperatingSystemProfile +## ClusterIdentity ### Properties -* **password**: string: The password. -* **sshProfile**: [SshProfile](#sshprofile): The list of SSH public keys. -* **username**: string: The username. +* **principalId**: string (ReadOnly): The principal id of cluster identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the cluster. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ClusterIdentityUserAssignedIdentities](#clusteridentityuserassignedidentities): 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}'. -## SshProfile +## ClusterIdentityUserAssignedIdentities ### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys. +### Additional Properties +* **Additional Properties Type**: [ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsc51ht8schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties) -## SshPublicKey +## ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **certificateData**: string: The certificate for SSH. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **tenantId**: string: The tenant id of user assigned identity. -## ScriptAction +## ComputeIsolationProperties ### Properties -* **name**: string (Required): The name of the script action. -* **parameters**: string (Required): The parameters for the script provided. -* **uri**: string (Required): The URI to the script. +* **enableComputeIsolation**: bool: The flag indicates whether enable compute isolation or not. +* **hostSku**: string: The host sku. -## VirtualNetworkProfile +## ComputeProfile ### Properties -* **id**: string: The ID of the virtual network. -* **subnet**: string: The name of the subnet. +* **roles**: [Role](#role)[]: The list of roles in the cluster. ## ConnectivityEndpoint ### Properties @@ -180,6 +173,12 @@ * **privateIPAddress**: string (ReadOnly): The private ip address of the endpoint. * **protocol**: string (ReadOnly): The protocol of the endpoint. +## DataDisksGroups +### Properties +* **diskSizeGB**: int (ReadOnly): ReadOnly. The DiskSize in GB. Do not set this value. +* **disksPerNode**: int: The number of disks per node. +* **storageAccountType**: string (ReadOnly): ReadOnly. The storage account type. Do not set this value. + ## DiskEncryptionProperties ### Properties * **encryptionAlgorithm**: 'RSA-OAEP' | 'RSA-OAEP-256' | 'RSA1_5' | string: Algorithm identifier for encryption, default RSA-OAEP. @@ -203,30 +202,73 @@ * **excludedServicesConfigId**: string (ReadOnly): The config id of excluded services. * **excludedServicesList**: string (ReadOnly): The list of excluded services. +## HardwareProfile +### Properties +* **vmSize**: string: The size of the VM + +## HostInfo +### Properties +* **effectiveDiskEncryptionKeyUrl**: string (ReadOnly): The effective disk encryption key URL used by the host +* **fqdn**: string (ReadOnly): The Fully Qualified Domain Name of host +* **name**: string (ReadOnly): The host name + ## KafkaRestProperties ### Properties * **clientGroupInfo**: [ClientGroupInfo](#clientgroupinfo): The information of AAD security group. * **configurationOverride**: [KafkaRestPropertiesConfigurationOverride](#kafkarestpropertiesconfigurationoverride): The configurations that need to be overriden. -## ClientGroupInfo -### Properties -* **groupId**: string: The AAD security group id. -* **groupName**: string: The AAD security group name. - ## KafkaRestPropertiesConfigurationOverride ### Properties ### Additional Properties * **Additional Properties Type**: string +## LinuxOperatingSystemProfile +### Properties +* **password**: string: The password. +* **sshProfile**: [SshProfile](#sshprofile): The list of SSH public keys. +* **username**: string: The username. + ## NetworkProperties ### Properties * **privateLink**: 'Disabled' | 'Enabled' | string: Indicates whether or not private link is enabled. * **resourceProviderConnection**: 'Inbound' | 'Outbound' | string: The direction for the resource provider connection. +## OsProfile +### Properties +* **linuxOperatingSystemProfile**: [LinuxOperatingSystemProfile](#linuxoperatingsystemprofile): The ssh username, password, and ssh public key. + ## QuotaInfo ### Properties * **coresUsed**: int (ReadOnly): The cores used by the cluster. +## Role +### Properties +* **autoscale**: [Autoscale](#autoscale): The autoscale request parameters +* **dataDisksGroups**: [DataDisksGroups](#datadisksgroups)[]: The data disks groups for the role. +* **encryptDataDisks**: bool: Indicates whether encrypt the data disks. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): The hardware profile. +* **minInstanceCount**: int: The minimum instance count of the cluster. +* **name**: string: The name of the role. +* **osProfile**: [OsProfile](#osprofile): The Linux operation systems profile. +* **scriptActions**: [ScriptAction](#scriptaction)[]: The list of script actions on the role. +* **targetInstanceCount**: int: The instance count of the cluster. +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): The virtual network properties. +* **VMGroupName**: string: The name of the virtual machine group. + +## RuntimeScriptAction +### Properties +* **applicationName**: string (ReadOnly): The application name of the script action, if any. +* **name**: string (Required): The name of the script action. +* **parameters**: string: The parameters for the script +* **roles**: string[] (Required): The list of roles where script will be executed. +* **uri**: string (Required): The URI to the script. + +## ScriptAction +### Properties +* **name**: string (Required): The name of the script action. +* **parameters**: string (Required): The parameters for the script provided. +* **uri**: string (Required): The URI to the script. + ## SecurityProfile ### Properties * **aaddsResourceId**: string: The resource ID of the user's Azure Active Directory Domain Service. @@ -239,9 +281,13 @@ * **msiResourceId**: string: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. * **organizationalUnitDN**: string: The organizational unit within the Active Directory to place the cluster and service accounts. -## StorageProfile +## SshProfile ### Properties -* **storageaccounts**: [StorageAccount](#storageaccount)[]: The list of storage accounts in the cluster. +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys. + +## SshPublicKey +### Properties +* **certificateData**: string: The certificate for SSH. ## StorageAccount ### Properties @@ -255,58 +301,12 @@ * **resourceId**: string: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. * **saskey**: string: The shared access signature key. -## ClusterCreateParametersExtendedTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationProperties -### Properties -* **applicationState**: string (ReadOnly): The application state. -* **applicationType**: string: The application type. -* **computeProfile**: [ComputeProfile](#computeprofile): Describes the compute profile. -* **createdDate**: string (ReadOnly): The application create date time. -* **errors**: [Errors](#errors)[]: The list of errors. -* **httpsEndpoints**: [ApplicationGetHttpsEndpoint](#applicationgethttpsendpoint)[]: The list of application HTTPS endpoints. -* **installScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of install script actions. -* **marketplaceIdentifier**: string (ReadOnly): The marketplace identifier. -* **provisioningState**: string (ReadOnly): The provisioning state of the application. -* **sshEndpoints**: [ApplicationGetEndpoint](#applicationgetendpoint)[]: The list of application SSH endpoints. -* **uninstallScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of uninstall script actions. - -## ApplicationGetHttpsEndpoint -### Properties -* **accessModes**: string[]: The list of access modes for the application. -* **destinationPort**: int: The destination port to connect to. -* **disableGatewayAuth**: bool: The value indicates whether to disable GatewayAuth. -* **location**: string (ReadOnly): The location of the endpoint. -* **privateIPAddress**: string: The private ip address of the endpoint. -* **publicPort**: int (ReadOnly): The public port to connect to. -* **subDomainSuffix**: string: The subdomain suffix of the application. - -## RuntimeScriptAction -### Properties -* **applicationName**: string (ReadOnly): The application name of the script action, if any. -* **name**: string (Required): The name of the script action. -* **parameters**: string: The parameters for the script -* **roles**: string[] (Required): The list of roles where script will be executed. -* **uri**: string (Required): The URI to the script. - -## ApplicationGetEndpoint -### Properties -* **destinationPort**: int: The destination port to connect to. -* **location**: string: The location of the endpoint. -* **privateIPAddress**: string: The private ip address of the endpoint. -* **publicPort**: int: The public port to connect to. - -## ApplicationTags +## StorageProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **storageaccounts**: [StorageAccount](#storageaccount)[]: The list of storage accounts in the cluster. -## HostInfo +## VirtualNetworkProfile ### Properties -* **effectiveDiskEncryptionKeyUrl**: string (ReadOnly): The effective disk encryption key URL used by the host -* **fqdn**: string (ReadOnly): The Fully Qualified Domain Name of host -* **name**: string (ReadOnly): The host name +* **id**: string: The ID of the virtual network. +* **subnet**: string: The name of the subnet. diff --git a/generated/hdinsight/microsoft.hdinsight/2021-06-01/types.md b/generated/hdinsight/microsoft.hdinsight/2021-06-01/types.md index f34e37c59c..20777aaecd 100644 --- a/generated/hdinsight/microsoft.hdinsight/2021-06-01/types.md +++ b/generated/hdinsight/microsoft.hdinsight/2021-06-01/types.md @@ -42,23 +42,78 @@ * **ApiVersion**: 2021-06-01 * **Output**: [HostInfo](#hostinfo)[] -## ClusterIdentity +## ApplicationGetEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal id of cluster identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id associated with the cluster. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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. -* **userAssignedIdentities**: [ClusterIdentityUserAssignedIdentities](#clusteridentityuserassignedidentities): 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}'. +* **destinationPort**: int: The destination port to connect to. +* **location**: string: The location of the endpoint. +* **privateIPAddress**: string: The private ip address of the endpoint. +* **publicPort**: int: The public port to connect to. -## ClusterIdentityUserAssignedIdentities +## ApplicationGetHttpsEndpoint +### Properties +* **accessModes**: string[]: The list of access modes for the application. +* **destinationPort**: int: The destination port to connect to. +* **disableGatewayAuth**: bool: The value indicates whether to disable GatewayAuth. +* **location**: string (ReadOnly): The location of the endpoint. +* **privateIPAddress**: string: The private ip address of the endpoint. +* **publicPort**: int (ReadOnly): The public port to connect to. +* **subDomainSuffix**: string (WriteOnly): The subdomain suffix of the application. + +## ApplicationProperties +### Properties +* **applicationState**: string (ReadOnly): The application state. +* **applicationType**: string: The application type. +* **computeProfile**: [ComputeProfile](#computeprofile): Describes the compute profile. +* **createdDate**: string (ReadOnly): The application create date time. +* **errors**: [Errors](#errors)[]: The list of errors. +* **httpsEndpoints**: [ApplicationGetHttpsEndpoint](#applicationgethttpsendpoint)[]: The list of application HTTPS endpoints. +* **installScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of install script actions. +* **marketplaceIdentifier**: string (ReadOnly): The marketplace identifier. +* **privateLinkConfigurations**: [PrivateLinkConfiguration](#privatelinkconfiguration)[]: The private link configurations. +* **provisioningState**: string (ReadOnly): The provisioning state of the application. +* **sshEndpoints**: [ApplicationGetEndpoint](#applicationgetendpoint)[]: The list of application SSH endpoints. +* **uninstallScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of uninstall script actions. + +## ApplicationTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **Additional Properties Type**: string -## UserAssignedIdentity +## Autoscale ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. -* **tenantId**: string: The tenant id of user assigned identity. +* **capacity**: [AutoscaleCapacity](#autoscalecapacity): The load-based autoscale request parameters +* **recurrence**: [AutoscaleRecurrence](#autoscalerecurrence): Schedule-based autoscale request parameters + +## AutoscaleCapacity +### Properties +* **maxInstanceCount**: int: The maximum instance count of the cluster +* **minInstanceCount**: int: The minimum instance count of the cluster + +## AutoscaleRecurrence +### Properties +* **schedule**: [AutoscaleSchedule](#autoscaleschedule)[]: Array of schedule-based autoscale rules +* **timeZone**: string: The time zone for the autoscale schedule times + +## AutoscaleSchedule +### Properties +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Days of the week for a schedule-based autoscale rule +* **timeAndCapacity**: [AutoscaleTimeAndCapacity](#autoscaletimeandcapacity): Time and capacity request parameters + +## AutoscaleTimeAndCapacity +### Properties +* **maxInstanceCount**: int: The maximum instance count of the cluster +* **minInstanceCount**: int: The minimum instance count of the cluster +* **time**: string: 24-hour time in the form xx:xx + +## ClientGroupInfo +### Properties +* **groupId**: string: The AAD security group id. +* **groupName**: string: The AAD security group name. + +## ClusterCreateParametersExtendedTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ClusterCreateProperties ### Properties @@ -99,6 +154,18 @@ ### Additional Properties * **Additional Properties Type**: string +## ClusterIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of cluster identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id associated with the cluster. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: 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. +* **userAssignedIdentities**: [ClusterIdentityUserAssignedIdentities](#clusteridentityuserassignedidentities): 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}'. + +## ClusterIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + ## ComputeIsolationProperties ### Properties * **enableComputeIsolation**: bool: The flag indicates whether enable compute isolation or not. @@ -108,85 +175,6 @@ ### Properties * **roles**: [Role](#role)[]: The list of roles in the cluster. -## Role -### Properties -* **autoscale**: [Autoscale](#autoscale): The autoscale request parameters -* **dataDisksGroups**: [DataDisksGroups](#datadisksgroups)[]: The data disks groups for the role. -* **encryptDataDisks**: bool: Indicates whether encrypt the data disks. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): The hardware profile. -* **minInstanceCount**: int: The minimum instance count of the cluster. -* **name**: string: The name of the role. -* **osProfile**: [OsProfile](#osprofile): The Linux operation systems profile. -* **scriptActions**: [ScriptAction](#scriptaction)[]: The list of script actions on the role. -* **targetInstanceCount**: int: The instance count of the cluster. -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): The virtual network properties. -* **VMGroupName**: string: The name of the virtual machine group. - -## Autoscale -### Properties -* **capacity**: [AutoscaleCapacity](#autoscalecapacity): The load-based autoscale request parameters -* **recurrence**: [AutoscaleRecurrence](#autoscalerecurrence): Schedule-based autoscale request parameters - -## AutoscaleCapacity -### Properties -* **maxInstanceCount**: int: The maximum instance count of the cluster -* **minInstanceCount**: int: The minimum instance count of the cluster - -## AutoscaleRecurrence -### Properties -* **schedule**: [AutoscaleSchedule](#autoscaleschedule)[]: Array of schedule-based autoscale rules -* **timeZone**: string: The time zone for the autoscale schedule times - -## AutoscaleSchedule -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string[]: Days of the week for a schedule-based autoscale rule -* **timeAndCapacity**: [AutoscaleTimeAndCapacity](#autoscaletimeandcapacity): Time and capacity request parameters - -## AutoscaleTimeAndCapacity -### Properties -* **maxInstanceCount**: int: The maximum instance count of the cluster -* **minInstanceCount**: int: The minimum instance count of the cluster -* **time**: string: 24-hour time in the form xx:xx - -## DataDisksGroups -### Properties -* **diskSizeGB**: int (ReadOnly): ReadOnly. The DiskSize in GB. Do not set this value. -* **disksPerNode**: int: The number of disks per node. -* **storageAccountType**: string (ReadOnly): ReadOnly. The storage account type. Do not set this value. - -## HardwareProfile -### Properties -* **vmSize**: string: The size of the VM - -## OsProfile -### Properties -* **linuxOperatingSystemProfile**: [LinuxOperatingSystemProfile](#linuxoperatingsystemprofile): The ssh username, password, and ssh public key. - -## LinuxOperatingSystemProfile -### Properties -* **password**: string: The password. -* **sshProfile**: [SshProfile](#sshprofile): The list of SSH public keys. -* **username**: string: The username. - -## SshProfile -### Properties -* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys. - -## SshPublicKey -### Properties -* **certificateData**: string: The certificate for SSH. - -## ScriptAction -### Properties -* **name**: string (Required): The name of the script action. -* **parameters**: string (Required): The parameters for the script provided. -* **uri**: string (Required): The URI to the script. - -## VirtualNetworkProfile -### Properties -* **id**: string: The ID of the virtual network. -* **subnet**: string: The name of the subnet. - ## ConnectivityEndpoint ### Properties * **location**: string (ReadOnly): The location of the endpoint. @@ -195,6 +183,12 @@ * **privateIPAddress**: string (ReadOnly): The private ip address of the endpoint. * **protocol**: string (ReadOnly): The protocol of the endpoint. +## DataDisksGroups +### Properties +* **diskSizeGB**: int (ReadOnly): ReadOnly. The DiskSize in GB. Do not set this value. +* **disksPerNode**: int: The number of disks per node. +* **storageAccountType**: string (ReadOnly): ReadOnly. The storage account type. Do not set this value. + ## DiskEncryptionProperties ### Properties * **encryptionAlgorithm**: 'RSA-OAEP' | 'RSA-OAEP-256' | 'RSA1_5' | string: Algorithm identifier for encryption, default RSA-OAEP. @@ -218,26 +212,60 @@ * **excludedServicesConfigId**: string (ReadOnly): The config id of excluded services. * **excludedServicesList**: string (ReadOnly): The list of excluded services. +## HardwareProfile +### Properties +* **vmSize**: string: The size of the VM + +## HostInfo +### Properties +* **effectiveDiskEncryptionKeyUrl**: string (ReadOnly): The effective disk encryption key URL used by the host +* **fqdn**: string (ReadOnly): The Fully Qualified Domain Name of host +* **name**: string (ReadOnly): The host name + +## IPConfiguration +### Properties +* **id**: string (ReadOnly): The private link IP configuration id. +* **name**: string (Required): The name of private link IP configuration. +* **properties**: [IPConfigurationProperties](#ipconfigurationproperties): The private link ip configuration properties. +* **type**: string (ReadOnly): The type of the private link IP configuration. + +## IPConfigurationProperties +### Properties +* **primary**: bool: Indicates whether this IP configuration is primary for the corresponding NIC. +* **privateIPAddress**: string: The IP address. +* **privateIPAllocationMethod**: 'dynamic' | 'static' | string: The method that private IP address is allocated. +* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The private link configuration provisioning state, which only appears in the response. +* **subnet**: [ResourceId](#resourceid): The azure resource id. + ## KafkaRestProperties ### Properties * **clientGroupInfo**: [ClientGroupInfo](#clientgroupinfo): The information of AAD security group. * **configurationOverride**: [KafkaRestPropertiesConfigurationOverride](#kafkarestpropertiesconfigurationoverride): The configurations that need to be overriden. -## ClientGroupInfo -### Properties -* **groupId**: string: The AAD security group id. -* **groupName**: string: The AAD security group name. - ## KafkaRestPropertiesConfigurationOverride ### Properties ### Additional Properties * **Additional Properties Type**: string +## LinuxOperatingSystemProfile +### Properties +* **password**: string: The password. +* **sshProfile**: [SshProfile](#sshprofile): The list of SSH public keys. +* **username**: string: The username. + ## NetworkProperties ### Properties * **privateLink**: 'Disabled' | 'Enabled' | string: Indicates whether or not private link is enabled. * **resourceProviderConnection**: 'Inbound' | 'Outbound' | string: The direction for the resource provider connection. +## OsProfile +### Properties +* **linuxOperatingSystemProfile**: [LinuxOperatingSystemProfile](#linuxoperatingsystemprofile): The ssh username, password, and ssh public key. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The private endpoint id. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -253,25 +281,6 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): The private link service connection state. * **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state, which only appears in the response. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The private endpoint id. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string (ReadOnly): Whether there is further actions. -* **description**: string (ReadOnly): The optional description of the status. -* **status**: 'Approved' | 'Pending' | 'Rejected' | 'Removed' | string (ReadOnly): The concrete private link service connection. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - ## PrivateLinkConfiguration ### Properties * **id**: string (ReadOnly): The private link configuration id. @@ -285,28 +294,47 @@ * **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (Required): The IP configurations for the private link service. * **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The private link configuration provisioning state, which only appears in the response. -## IPConfiguration +## PrivateLinkServiceConnectionState ### Properties -* **id**: string (ReadOnly): The private link IP configuration id. -* **name**: string (Required): The name of private link IP configuration. -* **properties**: [IPConfigurationProperties](#ipconfigurationproperties): The private link ip configuration properties. -* **type**: string (ReadOnly): The type of the private link IP configuration. +* **actionsRequired**: string (ReadOnly): Whether there is further actions. +* **description**: string (ReadOnly): The optional description of the status. +* **status**: 'Approved' | 'Pending' | 'Rejected' | 'Removed' | string (ReadOnly): The concrete private link service connection. -## IPConfigurationProperties +## QuotaInfo ### Properties -* **primary**: bool: Indicates whether this IP configuration is primary for the corresponding NIC. -* **privateIPAddress**: string: The IP address. -* **privateIPAllocationMethod**: 'dynamic' | 'static' | string: The method that private IP address is allocated. -* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The private link configuration provisioning state, which only appears in the response. -* **subnet**: [ResourceId](#resourceid): The azure resource id. +* **coresUsed**: int (ReadOnly): The cores used by the cluster. ## ResourceId ### Properties * **id**: string: The azure resource id. -## QuotaInfo +## Role ### Properties -* **coresUsed**: int (ReadOnly): The cores used by the cluster. +* **autoscale**: [Autoscale](#autoscale): The autoscale request parameters +* **dataDisksGroups**: [DataDisksGroups](#datadisksgroups)[]: The data disks groups for the role. +* **encryptDataDisks**: bool: Indicates whether encrypt the data disks. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): The hardware profile. +* **minInstanceCount**: int: The minimum instance count of the cluster. +* **name**: string: The name of the role. +* **osProfile**: [OsProfile](#osprofile): The Linux operation systems profile. +* **scriptActions**: [ScriptAction](#scriptaction)[]: The list of script actions on the role. +* **targetInstanceCount**: int: The instance count of the cluster. +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): The virtual network properties. +* **VMGroupName**: string: The name of the virtual machine group. + +## RuntimeScriptAction +### Properties +* **applicationName**: string (ReadOnly): The application name of the script action, if any. +* **name**: string (Required): The name of the script action. +* **parameters**: string (WriteOnly): The parameters for the script +* **roles**: string[] (Required): The list of roles where script will be executed. +* **uri**: string (Required): The URI to the script. + +## ScriptAction +### Properties +* **name**: string (Required): The name of the script action. +* **parameters**: string (Required): The parameters for the script provided. +* **uri**: string (Required): The URI to the script. ## SecurityProfile ### Properties @@ -320,9 +348,13 @@ * **msiResourceId**: string: User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. * **organizationalUnitDN**: string: The organizational unit within the Active Directory to place the cluster and service accounts. -## StorageProfile +## SshProfile ### Properties -* **storageaccounts**: [StorageAccount](#storageaccount)[]: The list of storage accounts in the cluster. +* **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys. + +## SshPublicKey +### Properties +* **certificateData**: string: The certificate for SSH. ## StorageAccount ### Properties @@ -336,59 +368,27 @@ * **resourceId**: string: The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. * **saskey**: string: The shared access signature key. -## ClusterCreateParametersExtendedTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationProperties -### Properties -* **applicationState**: string (ReadOnly): The application state. -* **applicationType**: string: The application type. -* **computeProfile**: [ComputeProfile](#computeprofile): Describes the compute profile. -* **createdDate**: string (ReadOnly): The application create date time. -* **errors**: [Errors](#errors)[]: The list of errors. -* **httpsEndpoints**: [ApplicationGetHttpsEndpoint](#applicationgethttpsendpoint)[]: The list of application HTTPS endpoints. -* **installScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of install script actions. -* **marketplaceIdentifier**: string (ReadOnly): The marketplace identifier. -* **privateLinkConfigurations**: [PrivateLinkConfiguration](#privatelinkconfiguration)[]: The private link configurations. -* **provisioningState**: string (ReadOnly): The provisioning state of the application. -* **sshEndpoints**: [ApplicationGetEndpoint](#applicationgetendpoint)[]: The list of application SSH endpoints. -* **uninstallScriptActions**: [RuntimeScriptAction](#runtimescriptaction)[]: The list of uninstall script actions. - -## ApplicationGetHttpsEndpoint -### Properties -* **accessModes**: string[]: The list of access modes for the application. -* **destinationPort**: int: The destination port to connect to. -* **disableGatewayAuth**: bool: The value indicates whether to disable GatewayAuth. -* **location**: string (ReadOnly): The location of the endpoint. -* **privateIPAddress**: string: The private ip address of the endpoint. -* **publicPort**: int (ReadOnly): The public port to connect to. -* **subDomainSuffix**: string (WriteOnly): The subdomain suffix of the application. - -## RuntimeScriptAction +## StorageProfile ### Properties -* **applicationName**: string (ReadOnly): The application name of the script action, if any. -* **name**: string (Required): The name of the script action. -* **parameters**: string (WriteOnly): The parameters for the script -* **roles**: string[] (Required): The list of roles where script will be executed. -* **uri**: string (Required): The URI to the script. +* **storageaccounts**: [StorageAccount](#storageaccount)[]: The list of storage accounts in the cluster. -## ApplicationGetEndpoint +## SystemData ### Properties -* **destinationPort**: int: The destination port to connect to. -* **location**: string: The location of the endpoint. -* **privateIPAddress**: string: The private ip address of the endpoint. -* **publicPort**: int: The public port to connect to. +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## ApplicationTags +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **tenantId**: string: The tenant id of user assigned identity. -## HostInfo +## VirtualNetworkProfile ### Properties -* **effectiveDiskEncryptionKeyUrl**: string (ReadOnly): The effective disk encryption key URL used by the host -* **fqdn**: string (ReadOnly): The Fully Qualified Domain Name of host -* **name**: string (ReadOnly): The host name +* **id**: string: The ID of the virtual network. +* **subnet**: string: The name of the subnet. diff --git a/generated/healthbot/log.out b/generated/healthbot/log.out index 0c60199163..829bf64529 100644 --- a/generated/healthbot/log.out +++ b/generated/healthbot/log.out @@ -3,22 +3,22 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.healthbot-2021-08-24"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.healthbot-2021-06-10"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.healthbot-2020-10-20-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthbot/resource-manager/Microsoft.HealthBot/preview/2020-10-20-preview/healthbot.json:373:5 @@ -37,10 +37,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an warning | PreCheck/SchemaMissingType | The schema 'BotResponseList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthbot/resource-manager/Microsoft.HealthBot/preview/2020-10-20-preview/healthbot.json:750:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.healthbot-2020-10-20"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2020-10-20/healthbot.json:373:5 @@ -62,7 +62,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.healthbot-2020-12-08-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthbot/resource-manager/Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json:383:5 @@ -84,7 +84,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.healthbot-2020-12-08"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2020-12-08/healthbot.json:341:5 @@ -103,5 +103,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an warning | PreCheck/SchemaMissingType | The schema 'BotResponseList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2020-12-08/healthbot.json:661:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms -info | Autorest completed in 11.6s. 12 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 11.07s. 12 files generated. diff --git a/generated/healthbot/microsoft.healthbot/2021-06-10/types.md b/generated/healthbot/microsoft.healthbot/2021-06-10/types.md index 968c372790..c898296c41 100644 --- a/generated/healthbot/microsoft.healthbot/2021-06-10/types.md +++ b/generated/healthbot/microsoft.healthbot/2021-06-10/types.md @@ -14,6 +14,11 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.HealthBot/healthBots' (ReadOnly, DeployTimeConstant): The resource type +## HealthBotProperties +### Properties +* **botManagementPortalLink**: string (ReadOnly): The link. +* **provisioningState**: string (ReadOnly): The provisioning state of the Azure Health Bot resource. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. This property will only be provided for a system assigned identity. @@ -22,21 +27,6 @@ * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of user assigned identity. - -## HealthBotProperties -### Properties -* **botManagementPortalLink**: string (ReadOnly): The link. -* **provisioningState**: string (ReadOnly): The provisioning state of the Azure Health Bot resource. - ## Sku ### Properties * **name**: 'C0' | 'F0' | 'S1' (Required): The name of the Azure Health Bot SKU @@ -55,3 +45,13 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of user assigned identity. + +## UserAssignedIdentityMap +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + diff --git a/generated/healthbot/microsoft.healthbot/2021-08-24/types.md b/generated/healthbot/microsoft.healthbot/2021-08-24/types.md index 91be767f06..d0aafcdeb4 100644 --- a/generated/healthbot/microsoft.healthbot/2021-08-24/types.md +++ b/generated/healthbot/microsoft.healthbot/2021-08-24/types.md @@ -14,6 +14,12 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.HealthBot/healthBots' (ReadOnly, DeployTimeConstant): The resource type +## HealthBotProperties +### Properties +* **botManagementPortalLink**: string (ReadOnly): The link. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties of the key vault. +* **provisioningState**: string (ReadOnly): The provisioning state of the Azure Health Bot resource. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. This property will only be provided for a system assigned identity. @@ -22,22 +28,6 @@ * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of user assigned identity. - -## HealthBotProperties -### Properties -* **botManagementPortalLink**: string (ReadOnly): The link. -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties of the key vault. -* **provisioningState**: string (ReadOnly): The provisioning state of the Azure Health Bot resource. - ## KeyVaultProperties ### Properties * **keyName**: string (Required): The name of the key vault key. @@ -63,3 +53,13 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of user assigned identity. + +## UserAssignedIdentityMap +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + diff --git a/generated/healthcareapis/log.out b/generated/healthcareapis/log.out index 70049f57e1..12ce0331b6 100644 --- a/generated/healthcareapis/log.out +++ b/generated/healthcareapis/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.healthcareapis-2022-01-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2022-01-31-preview/healthcare-apis.json:2346:5 @@ -15,10 +15,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ServicesResource' with an und warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2021-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2021-11-01/healthcare-apis.json:2342:5 @@ -30,7 +30,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/healthcare-apis.json:2074:5 @@ -47,10 +47,10 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2021-01-11"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2021-01-11/healthcare-apis.json:806:5 @@ -68,10 +68,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. warning | Modeler/MissingType | The schema 'OperationResultsDescription-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2021-01-11/healthcare-apis.json#/components/schemas/OperationResultsDescription-properties -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2020-03-30"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-30/healthcare-apis.json:805:5 @@ -84,7 +84,7 @@ warning | Modeler/MissingType | The schema 'OperationResultsDescription-properti info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2020-03-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json:505:5 @@ -97,7 +97,7 @@ warning | Modeler/MissingType | The schema 'OperationResultsDescription-properti info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2019-09-16"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2019-09-16/healthcare-apis.json:505:5 @@ -110,7 +110,7 @@ warning | Modeler/MissingType | The schema 'OperationResultsDescription-properti info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.healthcareapis-2018-08-20-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json:495:5 @@ -121,4 +121,4 @@ warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition warning | Modeler/MissingType | The schema 'OperationResultsDescription-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json#/components/schemas/OperationResultsDescription-properties info | autorest.bicep took 1ms -info | Autorest completed in 21.4s. 16 files generated. +info | Autorest completed in 20.4s. 16 files generated. diff --git a/generated/healthcareapis/microsoft.healthcareapis/2018-08-20-preview/types.md b/generated/healthcareapis/microsoft.healthcareapis/2018-08-20-preview/types.md index a7859a0a4e..92696602b5 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2018-08-20-preview/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2018-08-20-preview/types.md @@ -20,13 +20,10 @@ * **tenantId**: string (ReadOnly): The tenant ID of the resource. * **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## ServicesProperties +## ResourceTags ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ServiceAccessPolicyEntry ### Properties @@ -50,8 +47,11 @@ ### Properties * **offerThroughput**: int: The provisioned throughput for the backing database. -## ResourceTags +## ServicesProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. diff --git a/generated/healthcareapis/microsoft.healthcareapis/2019-09-16/types.md b/generated/healthcareapis/microsoft.healthcareapis/2019-09-16/types.md index 678ef6131f..f8d0f638dc 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2019-09-16/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2019-09-16/types.md @@ -20,14 +20,10 @@ * **tenantId**: string (ReadOnly): The tenant ID of the resource. * **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## ServicesProperties +## ResourceTags ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ServiceAccessPolicyEntry ### Properties @@ -55,8 +51,12 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## ResourceTags +## ServicesProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. diff --git a/generated/healthcareapis/microsoft.healthcareapis/2020-03-15/types.md b/generated/healthcareapis/microsoft.healthcareapis/2020-03-15/types.md index baa1b15631..6f75d8d1fe 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2020-03-15/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2020-03-15/types.md @@ -20,14 +20,10 @@ * **tenantId**: string (ReadOnly): The tenant ID of the resource. * **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## ServicesProperties +## ResourceTags ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ServiceAccessPolicyEntry ### Properties @@ -56,8 +52,12 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## ResourceTags +## ServicesProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. diff --git a/generated/healthcareapis/microsoft.healthcareapis/2020-03-30/types.md b/generated/healthcareapis/microsoft.healthcareapis/2020-03-30/types.md index 24b2e75f2e..310a8dd7bb 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2020-03-30/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2020-03-30/types.md @@ -23,22 +23,28 @@ * **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. * **type**: 'Microsoft.HealthcareApis/services/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## PrivateEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ServicesProperties +## PrivateEndpointConnection ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ServiceAccessPolicyEntry ### Properties @@ -67,28 +73,22 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint +## ServicesProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## PrivateLinkServiceConnectionState +## ServicesResourceIdentity ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. ## ServicesResourceTags ### Properties diff --git a/generated/healthcareapis/microsoft.healthcareapis/2021-01-11/types.md b/generated/healthcareapis/microsoft.healthcareapis/2021-01-11/types.md index 5f66af4010..361b70e127 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2021-01-11/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2021-01-11/types.md @@ -25,23 +25,28 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HealthcareApis/services/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## PrivateEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ServicesProperties +## PrivateEndpointConnection ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ServiceAccessPolicyEntry ### Properties @@ -74,28 +79,28 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties +## ServicesProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## PrivateEndpoint +## ServicesResourceIdentity ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## PrivateLinkServiceConnectionState +## ServicesResourceTags ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +### Additional Properties +* **Additional Properties Type**: string ## SystemData ### Properties @@ -106,8 +111,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ServicesResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.md b/generated/healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.md index 57f72e1469..ad5a203575 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.md @@ -92,39 +92,32 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## DicomServiceAuthenticationConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **audiences**: string[] (ReadOnly): The audiences for the service +* **authority**: string (ReadOnly): The authority url for the service -## ServicesProperties +## DicomServiceProperties ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **authenticationConfiguration**: [DicomServiceAuthenticationConfiguration](#dicomserviceauthenticationconfiguration): Authentication configuration information +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. +* **serviceUrl**: string (ReadOnly): The url of the Dicom Services. -## ServiceAccessPolicyEntry +## FhirServiceAccessPolicyEntry ### Properties * **objectId**: string (Required): An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. -## ServiceAcrConfigurationInfo +## FhirServiceAcrConfiguration ### Properties -* **loginServers**: string[]: The list of the ACR login servers. +* **loginServers**: string[]: The list of the Azure container registry login servers. -## ServiceAuthenticationConfigurationInfo +## FhirServiceAuthenticationConfiguration ### Properties * **audience**: string: The audience url for the service * **authority**: string: The authority url for the service * **smartProxyEnabled**: bool: If the SMART on FHIR proxy is enabled -## ServiceCorsConfigurationInfo +## FhirServiceCorsConfiguration ### Properties * **allowCredentials**: bool: If credentials are allowed via CORS. * **headers**: string[]: The headers to be allowed via CORS. @@ -132,14 +125,45 @@ * **methods**: string[]: The methods to be allowed via CORS. * **origins**: string[]: The origins to be allowed via CORS. -## ServiceCosmosDbConfigurationInfo +## FhirServiceExportConfiguration ### Properties -* **keyVaultKeyUri**: string: The URI of the customer-managed key for the backing database. -* **offerThroughput**: int: The provisioned throughput for the backing database. +* **storageAccountName**: string: The name of the default export storage account. -## ServiceExportConfigurationInfo +## FhirServiceProperties ### Properties -* **storageAccountName**: string: The name of the default export storage account. +* **accessPolicies**: [FhirServiceAccessPolicyEntry](#fhirserviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [FhirServiceAcrConfiguration](#fhirserviceacrconfiguration): Azure container registry configuration information +* **authenticationConfiguration**: [FhirServiceAuthenticationConfiguration](#fhirserviceauthenticationconfiguration): Authentication configuration information +* **corsConfiguration**: [FhirServiceCorsConfiguration](#fhirservicecorsconfiguration): The settings for the CORS configuration of the service instance. +* **exportConfiguration**: [FhirServiceExportConfiguration](#fhirserviceexportconfiguration): Export operation configuration information +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. + +## IotConnectorProperties +### Properties +* **deviceMapping**: [IotMappingProperties](#iotmappingproperties): The mapping content. +* **ingestionEndpointConfiguration**: [IotEventHubIngestionEndpointConfiguration](#ioteventhubingestionendpointconfiguration): Event Hub ingestion endpoint configuration +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. + +## IotEventHubIngestionEndpointConfiguration +### Properties +* **consumerGroup**: string: Consumer group of the event hub to connected to. +* **eventHubName**: string: Event Hub name to connect to. +* **fullyQualifiedEventHubNamespace**: string: Fully qualified namespace of the Event Hub to connect to. + +## IotFhirDestinationProperties +### Properties +* **fhirMapping**: [IotMappingProperties](#iotmappingproperties) (Required): The mapping content. +* **fhirServiceResourceId**: string (Required): Fully qualified resource id of the FHIR service to connect to. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. +* **resourceIdentityResolutionType**: 'Create' | 'Lookup' | string (Required): The type of IoT identity resolution to use with the destination. + +## IotMappingProperties +### Properties +* **content**: any: Any object + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -154,83 +178,47 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ServicesResourceTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DicomServiceProperties -### Properties -* **authenticationConfiguration**: [DicomServiceAuthenticationConfiguration](#dicomserviceauthenticationconfiguration): Authentication configuration information -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. -* **serviceUrl**: string (ReadOnly): The url of the Dicom Services. - -## DicomServiceAuthenticationConfiguration -### Properties -* **audiences**: string[] (ReadOnly): The audiences for the service -* **authority**: string (ReadOnly): The authority url for the service - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceManagedIdentityIdentity -### Properties -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. - -## FhirServiceProperties +## ResourceTags ### Properties -* **accessPolicies**: [FhirServiceAccessPolicyEntry](#fhirserviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [FhirServiceAcrConfiguration](#fhirserviceacrconfiguration): Azure container registry configuration information -* **authenticationConfiguration**: [FhirServiceAuthenticationConfiguration](#fhirserviceauthenticationconfiguration): Authentication configuration information -* **corsConfiguration**: [FhirServiceCorsConfiguration](#fhirservicecorsconfiguration): The settings for the CORS configuration of the service instance. -* **exportConfiguration**: [FhirServiceExportConfiguration](#fhirserviceexportconfiguration): Export operation configuration information -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## FhirServiceAccessPolicyEntry +## ServiceAccessPolicyEntry ### Properties * **objectId**: string (Required): An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. -## FhirServiceAcrConfiguration +## ServiceAcrConfigurationInfo ### Properties -* **loginServers**: string[]: The list of the Azure container registry login servers. +* **loginServers**: string[]: The list of the ACR login servers. -## FhirServiceAuthenticationConfiguration +## ServiceAuthenticationConfigurationInfo ### Properties * **audience**: string: The audience url for the service * **authority**: string: The authority url for the service * **smartProxyEnabled**: bool: If the SMART on FHIR proxy is enabled -## FhirServiceCorsConfiguration +## ServiceCorsConfigurationInfo ### Properties * **allowCredentials**: bool: If credentials are allowed via CORS. * **headers**: string[]: The headers to be allowed via CORS. @@ -238,40 +226,52 @@ * **methods**: string[]: The methods to be allowed via CORS. * **origins**: string[]: The origins to be allowed via CORS. -## FhirServiceExportConfiguration +## ServiceCosmosDbConfigurationInfo ### Properties -* **storageAccountName**: string: The name of the default export storage account. +* **keyVaultKeyUri**: string: The URI of the customer-managed key for the backing database. +* **offerThroughput**: int: The provisioned throughput for the backing database. -## ResourceTags +## ServiceExportConfigurationInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **storageAccountName**: string: The name of the default export storage account. -## IotConnectorProperties +## ServiceManagedIdentityIdentity ### Properties -* **deviceMapping**: [IotMappingProperties](#iotmappingproperties): The mapping content. -* **ingestionEndpointConfiguration**: [IotEventHubIngestionEndpointConfiguration](#ioteventhubingestionendpointconfiguration): Event Hub ingestion endpoint configuration -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## IotMappingProperties +## ServicesProperties ### Properties -* **content**: any: Any object +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## IotEventHubIngestionEndpointConfiguration +## ServicesResourceIdentity ### Properties -* **consumerGroup**: string: Consumer group of the event hub to connected to. -* **eventHubName**: string: Event Hub name to connect to. -* **fullyQualifiedEventHubNamespace**: string: Fully qualified namespace of the Event Hub to connect to. +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## ResourceTags +## ServicesResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IotFhirDestinationProperties +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## WorkspaceProperties ### Properties -* **fhirMapping**: [IotMappingProperties](#iotmappingproperties) (Required): The mapping content. -* **fhirServiceResourceId**: string (Required): Fully qualified resource id of the FHIR service to connect to. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string: The provisioning state. -* **resourceIdentityResolutionType**: 'Create' | 'Lookup' | string (Required): The type of IoT identity resolution to use with the destination. diff --git a/generated/healthcareapis/microsoft.healthcareapis/2021-11-01/types.md b/generated/healthcareapis/microsoft.healthcareapis/2021-11-01/types.md index 08c4c3affa..e9b77f4ad4 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2021-11-01/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2021-11-01/types.md @@ -103,46 +103,35 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HealthcareApis/workspaces/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## DicomServiceAuthenticationConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **audiences**: string[] (ReadOnly): The audiences for the service +* **authority**: string (ReadOnly): The authority url for the service -## ServicesProperties +## DicomServiceProperties ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **authenticationConfiguration**: [DicomServiceAuthenticationConfiguration](#dicomserviceauthenticationconfiguration): Authentication configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **serviceUrl**: string (ReadOnly): The url of the Dicom Services. -## ServiceAccessPolicyEntry +## FhirServiceAccessPolicyEntry ### Properties * **objectId**: string (Required): An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. -## ServiceAcrConfigurationInfo +## FhirServiceAcrConfiguration ### Properties -* **loginServers**: string[]: The list of the ACR login servers. +* **loginServers**: string[]: The list of the Azure container registry login servers. * **ociArtifacts**: [ServiceOciArtifactEntry](#serviceociartifactentry)[]: The list of Open Container Initiative (OCI) artifacts. -## ServiceOciArtifactEntry -### Properties -* **digest**: string: The artifact digest. -* **imageName**: string: The artifact name. -* **loginServer**: string: The Azure Container Registry login server. - -## ServiceAuthenticationConfigurationInfo +## FhirServiceAuthenticationConfiguration ### Properties * **audience**: string: The audience url for the service * **authority**: string: The authority url for the service * **smartProxyEnabled**: bool: If the SMART on FHIR proxy is enabled -## ServiceCorsConfigurationInfo +## FhirServiceCorsConfiguration ### Properties * **allowCredentials**: bool: If credentials are allowed via CORS. * **headers**: string[]: The headers to be allowed via CORS. @@ -150,14 +139,49 @@ * **methods**: string[]: The methods to be allowed via CORS. * **origins**: string[]: The origins to be allowed via CORS. -## ServiceCosmosDbConfigurationInfo +## FhirServiceExportConfiguration ### Properties -* **keyVaultKeyUri**: string: The URI of the customer-managed key for the backing database. -* **offerThroughput**: int: The provisioned throughput for the backing database. +* **storageAccountName**: string: The name of the default export storage account. -## ServiceExportConfigurationInfo +## FhirServiceProperties ### Properties -* **storageAccountName**: string: The name of the default export storage account. +* **accessPolicies**: [FhirServiceAccessPolicyEntry](#fhirserviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [FhirServiceAcrConfiguration](#fhirserviceacrconfiguration): Azure container registry configuration information +* **authenticationConfiguration**: [FhirServiceAuthenticationConfiguration](#fhirserviceauthenticationconfiguration): Authentication configuration information +* **corsConfiguration**: [FhirServiceCorsConfiguration](#fhirservicecorsconfiguration): The settings for the CORS configuration of the service instance. +* **eventState**: 'Disabled' | 'Enabled' | 'Updating' | string (ReadOnly): Indicates the current status of event support for the resource. +* **exportConfiguration**: [FhirServiceExportConfiguration](#fhirserviceexportconfiguration): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **resourceVersionPolicyConfiguration**: [ResourceVersionPolicyConfiguration](#resourceversionpolicyconfiguration): The settings for history tracking for FHIR resources. + +## IotConnectorProperties +### Properties +* **deviceMapping**: [IotMappingProperties](#iotmappingproperties): The mapping content. +* **ingestionEndpointConfiguration**: [IotEventHubIngestionEndpointConfiguration](#ioteventhubingestionendpointconfiguration): Event Hub ingestion endpoint configuration +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. + +## IotEventHubIngestionEndpointConfiguration +### Properties +* **consumerGroup**: string: Consumer group of the event hub to connected to. +* **eventHubName**: string: Event Hub name to connect to. +* **fullyQualifiedEventHubNamespace**: string: Fully qualified namespace of the Event Hub to connect to. + +## IotFhirDestinationProperties +### Properties +* **fhirMapping**: [IotMappingProperties](#iotmappingproperties) (Required): The mapping content. +* **fhirServiceResourceId**: string (Required): Fully qualified resource id of the FHIR service to connect to. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **resourceIdentityResolutionType**: 'Create' | 'Lookup' | string (Required): The type of IoT identity resolution to use with the destination. + +## IotMappingProperties +### Properties +* **content**: any: Any object + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -172,105 +196,58 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ServicesResourceTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceManagedIdentityIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of identity being specified, currently SystemAssigned and None are allowed. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - -## DicomServiceProperties -### Properties -* **authenticationConfiguration**: [DicomServiceAuthenticationConfiguration](#dicomserviceauthenticationconfiguration): Authentication configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -* **serviceUrl**: string (ReadOnly): The url of the Dicom Services. - -## DicomServiceAuthenticationConfiguration -### Properties -* **audiences**: string[] (ReadOnly): The audiences for the service -* **authority**: string (ReadOnly): The authority url for the service +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FhirServiceProperties +## ResourceVersionPolicyConfiguration ### Properties -* **accessPolicies**: [FhirServiceAccessPolicyEntry](#fhirserviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [FhirServiceAcrConfiguration](#fhirserviceacrconfiguration): Azure container registry configuration information -* **authenticationConfiguration**: [FhirServiceAuthenticationConfiguration](#fhirserviceauthenticationconfiguration): Authentication configuration information -* **corsConfiguration**: [FhirServiceCorsConfiguration](#fhirservicecorsconfiguration): The settings for the CORS configuration of the service instance. -* **eventState**: 'Disabled' | 'Enabled' | 'Updating' | string (ReadOnly): Indicates the current status of event support for the resource. -* **exportConfiguration**: [FhirServiceExportConfiguration](#fhirserviceexportconfiguration): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -* **resourceVersionPolicyConfiguration**: [ResourceVersionPolicyConfiguration](#resourceversionpolicyconfiguration): The settings for history tracking for FHIR resources. +* **default**: 'no-version' | 'versioned' | 'versioned-update' | string: Controls how resources are versioned on the FHIR service +* **resourceTypeOverrides**: [ResourceVersionPolicyConfigurationResourceTypeOverrides](#resourceversionpolicyconfigurationresourcetypeoverrides): A list of FHIR Resources and their version policy overrides. -## FhirServiceAccessPolicyEntry +## ResourceVersionPolicyConfigurationResourceTypeOverrides +### Properties +### Additional Properties +* **Additional Properties Type**: 'no-version' | 'versioned' | 'versioned-update' | string + +## ServiceAccessPolicyEntry ### Properties * **objectId**: string (Required): An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. -## FhirServiceAcrConfiguration +## ServiceAcrConfigurationInfo ### Properties -* **loginServers**: string[]: The list of the Azure container registry login servers. +* **loginServers**: string[]: The list of the ACR login servers. * **ociArtifacts**: [ServiceOciArtifactEntry](#serviceociartifactentry)[]: The list of Open Container Initiative (OCI) artifacts. -## FhirServiceAuthenticationConfiguration +## ServiceAuthenticationConfigurationInfo ### Properties * **audience**: string: The audience url for the service * **authority**: string: The authority url for the service * **smartProxyEnabled**: bool: If the SMART on FHIR proxy is enabled -## FhirServiceCorsConfiguration +## ServiceCorsConfigurationInfo ### Properties * **allowCredentials**: bool: If credentials are allowed via CORS. * **headers**: string[]: The headers to be allowed via CORS. @@ -278,50 +255,73 @@ * **methods**: string[]: The methods to be allowed via CORS. * **origins**: string[]: The origins to be allowed via CORS. -## FhirServiceExportConfiguration +## ServiceCosmosDbConfigurationInfo ### Properties -* **storageAccountName**: string: The name of the default export storage account. +* **keyVaultKeyUri**: string: The URI of the customer-managed key for the backing database. +* **offerThroughput**: int: The provisioned throughput for the backing database. -## ResourceVersionPolicyConfiguration +## ServiceExportConfigurationInfo ### Properties -* **default**: 'no-version' | 'versioned' | 'versioned-update' | string: Controls how resources are versioned on the FHIR service -* **resourceTypeOverrides**: [ResourceVersionPolicyConfigurationResourceTypeOverrides](#resourceversionpolicyconfigurationresourcetypeoverrides): A list of FHIR Resources and their version policy overrides. +* **storageAccountName**: string: The name of the default export storage account. -## ResourceVersionPolicyConfigurationResourceTypeOverrides +## ServiceManagedIdentityIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: 'no-version' | 'versioned' | 'versioned-update' | string +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of identity being specified, currently SystemAssigned and None are allowed. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. -## ResourceTags +## ServiceOciArtifactEntry ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **digest**: string: The artifact digest. +* **imageName**: string: The artifact name. +* **loginServer**: string: The Azure Container Registry login server. -## IotConnectorProperties +## ServicesProperties ### Properties -* **deviceMapping**: [IotMappingProperties](#iotmappingproperties): The mapping content. -* **ingestionEndpointConfiguration**: [IotEventHubIngestionEndpointConfiguration](#ioteventhubingestionendpointconfiguration): Event Hub ingestion endpoint configuration +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## IotMappingProperties +## ServicesResourceIdentity ### Properties -* **content**: any: Any object +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## IotEventHubIngestionEndpointConfiguration +## ServicesResourceTags ### Properties -* **consumerGroup**: string: Consumer group of the event hub to connected to. -* **eventHubName**: string: Event Hub name to connect to. -* **fullyQualifiedEventHubNamespace**: string: Fully qualified namespace of the Event Hub to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ResourceTags +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## IotFhirDestinationProperties +## UserAssignedIdentity ### Properties -* **fhirMapping**: [IotMappingProperties](#iotmappingproperties) (Required): The mapping content. -* **fhirServiceResourceId**: string (Required): Fully qualified resource id of the FHIR service to connect to. +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. + +## WorkspaceProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **resourceIdentityResolutionType**: 'Create' | 'Lookup' | string (Required): The type of IoT identity resolution to use with the destination. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. diff --git a/generated/healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.md b/generated/healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.md index d79bfafd0a..1b858dab62 100644 --- a/generated/healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.md +++ b/generated/healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.md @@ -103,47 +103,35 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HealthcareApis/workspaces/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## DicomServiceAuthenticationConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **audiences**: string[] (ReadOnly): The audiences for the service +* **authority**: string (ReadOnly): The authority url for the service -## ServicesProperties +## DicomServiceProperties ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **importConfiguration**: [ServiceImportConfigurationInfo](#serviceimportconfigurationinfo): Import operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **authenticationConfiguration**: [DicomServiceAuthenticationConfiguration](#dicomserviceauthenticationconfiguration): Authentication configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **serviceUrl**: string (ReadOnly): The url of the Dicom Services. -## ServiceAccessPolicyEntry +## FhirServiceAccessPolicyEntry ### Properties * **objectId**: string (Required): An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. -## ServiceAcrConfigurationInfo +## FhirServiceAcrConfiguration ### Properties -* **loginServers**: string[]: The list of the ACR login servers. +* **loginServers**: string[]: The list of the Azure container registry login servers. * **ociArtifacts**: [ServiceOciArtifactEntry](#serviceociartifactentry)[]: The list of Open Container Initiative (OCI) artifacts. -## ServiceOciArtifactEntry -### Properties -* **digest**: string: The artifact digest. -* **imageName**: string: The artifact name. -* **loginServer**: string: The Azure Container Registry login server. - -## ServiceAuthenticationConfigurationInfo +## FhirServiceAuthenticationConfiguration ### Properties * **audience**: string: The audience url for the service * **authority**: string: The authority url for the service * **smartProxyEnabled**: bool: If the SMART on FHIR proxy is enabled -## ServiceCorsConfigurationInfo +## FhirServiceCorsConfiguration ### Properties * **allowCredentials**: bool: If credentials are allowed via CORS. * **headers**: string[]: The headers to be allowed via CORS. @@ -151,21 +139,57 @@ * **methods**: string[]: The methods to be allowed via CORS. * **origins**: string[]: The origins to be allowed via CORS. -## ServiceCosmosDbConfigurationInfo -### Properties -* **keyVaultKeyUri**: string: The URI of the customer-managed key for the backing database. -* **offerThroughput**: int: The provisioned throughput for the backing database. - -## ServiceExportConfigurationInfo +## FhirServiceExportConfiguration ### Properties * **storageAccountName**: string: The name of the default export storage account. -## ServiceImportConfigurationInfo +## FhirServiceImportConfiguration ### Properties * **enabled**: bool: If the import operation is enabled. * **initialImportMode**: bool: If the FHIR service is in InitialImportMode. * **integrationDataStore**: string: The name of the default integration storage account. +## FhirServiceProperties +### Properties +* **accessPolicies**: [FhirServiceAccessPolicyEntry](#fhirserviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [FhirServiceAcrConfiguration](#fhirserviceacrconfiguration): Azure container registry configuration information +* **authenticationConfiguration**: [FhirServiceAuthenticationConfiguration](#fhirserviceauthenticationconfiguration): Authentication configuration information +* **corsConfiguration**: [FhirServiceCorsConfiguration](#fhirservicecorsconfiguration): The settings for the CORS configuration of the service instance. +* **eventState**: 'Disabled' | 'Enabled' | 'Updating' | string (ReadOnly): Indicates the current status of event support for the resource. +* **exportConfiguration**: [FhirServiceExportConfiguration](#fhirserviceexportconfiguration): Export operation configuration information +* **importConfiguration**: [FhirServiceImportConfiguration](#fhirserviceimportconfiguration): Import operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **resourceVersionPolicyConfiguration**: [ResourceVersionPolicyConfiguration](#resourceversionpolicyconfiguration): The settings for history tracking for FHIR resources. + +## IotConnectorProperties +### Properties +* **deviceMapping**: [IotMappingProperties](#iotmappingproperties): The mapping content. +* **ingestionEndpointConfiguration**: [IotEventHubIngestionEndpointConfiguration](#ioteventhubingestionendpointconfiguration): Event Hub ingestion endpoint configuration +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. + +## IotEventHubIngestionEndpointConfiguration +### Properties +* **consumerGroup**: string: Consumer group of the event hub to connected to. +* **eventHubName**: string: Event Hub name to connect to. +* **fullyQualifiedEventHubNamespace**: string: Fully qualified namespace of the Event Hub to connect to. + +## IotFhirDestinationProperties +### Properties +* **fhirMapping**: [IotMappingProperties](#iotmappingproperties) (Required): The mapping content. +* **fhirServiceResourceId**: string (Required): Fully qualified resource id of the FHIR service to connect to. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **resourceIdentityResolutionType**: 'Create' | 'Lookup' | string (Required): The type of IoT identity resolution to use with the destination. + +## IotMappingProperties +### Properties +* **content**: any: Any object + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -179,106 +203,58 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ServicesResourceTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceManagedIdentityIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of identity being specified, currently SystemAssigned and None are allowed. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - -## DicomServiceProperties -### Properties -* **authenticationConfiguration**: [DicomServiceAuthenticationConfiguration](#dicomserviceauthenticationconfiguration): Authentication configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -* **serviceUrl**: string (ReadOnly): The url of the Dicom Services. - -## DicomServiceAuthenticationConfiguration -### Properties -* **audiences**: string[] (ReadOnly): The audiences for the service -* **authority**: string (ReadOnly): The authority url for the service +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FhirServiceProperties +## ResourceVersionPolicyConfiguration ### Properties -* **accessPolicies**: [FhirServiceAccessPolicyEntry](#fhirserviceaccesspolicyentry)[]: The access policies of the service instance. -* **acrConfiguration**: [FhirServiceAcrConfiguration](#fhirserviceacrconfiguration): Azure container registry configuration information -* **authenticationConfiguration**: [FhirServiceAuthenticationConfiguration](#fhirserviceauthenticationconfiguration): Authentication configuration information -* **corsConfiguration**: [FhirServiceCorsConfiguration](#fhirservicecorsconfiguration): The settings for the CORS configuration of the service instance. -* **eventState**: 'Disabled' | 'Enabled' | 'Updating' | string (ReadOnly): Indicates the current status of event support for the resource. -* **exportConfiguration**: [FhirServiceExportConfiguration](#fhirserviceexportconfiguration): Export operation configuration information -* **importConfiguration**: [FhirServiceImportConfiguration](#fhirserviceimportconfiguration): Import operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -* **resourceVersionPolicyConfiguration**: [ResourceVersionPolicyConfiguration](#resourceversionpolicyconfiguration): The settings for history tracking for FHIR resources. +* **default**: 'no-version' | 'versioned' | 'versioned-update' | string: Controls how resources are versioned on the FHIR service +* **resourceTypeOverrides**: [ResourceVersionPolicyConfigurationResourceTypeOverrides](#resourceversionpolicyconfigurationresourcetypeoverrides): A list of FHIR Resources and their version policy overrides. -## FhirServiceAccessPolicyEntry +## ResourceVersionPolicyConfigurationResourceTypeOverrides +### Properties +### Additional Properties +* **Additional Properties Type**: 'no-version' | 'versioned' | 'versioned-update' | string + +## ServiceAccessPolicyEntry ### Properties * **objectId**: string (Required): An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. -## FhirServiceAcrConfiguration +## ServiceAcrConfigurationInfo ### Properties -* **loginServers**: string[]: The list of the Azure container registry login servers. +* **loginServers**: string[]: The list of the ACR login servers. * **ociArtifacts**: [ServiceOciArtifactEntry](#serviceociartifactentry)[]: The list of Open Container Initiative (OCI) artifacts. -## FhirServiceAuthenticationConfiguration +## ServiceAuthenticationConfigurationInfo ### Properties * **audience**: string: The audience url for the service * **authority**: string: The authority url for the service * **smartProxyEnabled**: bool: If the SMART on FHIR proxy is enabled -## FhirServiceCorsConfiguration +## ServiceCorsConfigurationInfo ### Properties * **allowCredentials**: bool: If credentials are allowed via CORS. * **headers**: string[]: The headers to be allowed via CORS. @@ -286,56 +262,80 @@ * **methods**: string[]: The methods to be allowed via CORS. * **origins**: string[]: The origins to be allowed via CORS. -## FhirServiceExportConfiguration +## ServiceCosmosDbConfigurationInfo +### Properties +* **keyVaultKeyUri**: string: The URI of the customer-managed key for the backing database. +* **offerThroughput**: int: The provisioned throughput for the backing database. + +## ServiceExportConfigurationInfo ### Properties * **storageAccountName**: string: The name of the default export storage account. -## FhirServiceImportConfiguration +## ServiceImportConfigurationInfo ### Properties * **enabled**: bool: If the import operation is enabled. * **initialImportMode**: bool: If the FHIR service is in InitialImportMode. * **integrationDataStore**: string: The name of the default integration storage account. -## ResourceVersionPolicyConfiguration +## ServiceManagedIdentityIdentity ### Properties -* **default**: 'no-version' | 'versioned' | 'versioned-update' | string: Controls how resources are versioned on the FHIR service -* **resourceTypeOverrides**: [ResourceVersionPolicyConfigurationResourceTypeOverrides](#resourceversionpolicyconfigurationresourcetypeoverrides): A list of FHIR Resources and their version policy overrides. +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of identity being specified, currently SystemAssigned and None are allowed. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. -## ResourceVersionPolicyConfigurationResourceTypeOverrides +## ServiceOciArtifactEntry ### Properties -### Additional Properties -* **Additional Properties Type**: 'no-version' | 'versioned' | 'versioned-update' | string +* **digest**: string: The artifact digest. +* **imageName**: string: The artifact name. +* **loginServer**: string: The Azure Container Registry login server. -## ResourceTags +## ServicesProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **acrConfiguration**: [ServiceAcrConfigurationInfo](#serviceacrconfigurationinfo): Azure container registry configuration information +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **importConfiguration**: [ServiceImportConfigurationInfo](#serviceimportconfigurationinfo): Import operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## IotConnectorProperties +## ServicesResourceIdentity ### Properties -* **deviceMapping**: [IotMappingProperties](#iotmappingproperties): The mapping content. -* **ingestionEndpointConfiguration**: [IotEventHubIngestionEndpointConfiguration](#ioteventhubingestionendpointconfiguration): Event Hub ingestion endpoint configuration -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. -## IotMappingProperties +## ServicesResourceTags ### Properties -* **content**: any: Any object +### Additional Properties +* **Additional Properties Type**: string -## IotEventHubIngestionEndpointConfiguration +## SystemData ### Properties -* **consumerGroup**: string: Consumer group of the event hub to connected to. -* **eventHubName**: string: Event Hub name to connect to. -* **fullyQualifiedEventHubNamespace**: string: Fully qualified namespace of the Event Hub to connect to. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags +## UserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## IotFhirDestinationProperties +## UserAssignedIdentity ### Properties -* **fhirMapping**: [IotMappingProperties](#iotmappingproperties) (Required): The mapping content. -* **fhirServiceResourceId**: string (Required): Fully qualified resource id of the FHIR service to connect to. +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. + +## WorkspaceProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections that are set up for this resource. * **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Moving' | 'Succeeded' | 'Suspended' | 'SystemMaintenance' | 'Updating' | 'Verifying' | 'Warned' | string (ReadOnly): The provisioning state. -* **resourceIdentityResolutionType**: 'Create' | 'Lookup' | string (Required): The type of IoT identity resolution to use with the destination. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. diff --git a/generated/hybridcompute/log.out b/generated/hybridcompute/log.out index b2da8bd483..75c99be86a 100644 --- a/generated/hybridcompute/log.out +++ b/generated/hybridcompute/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hybridcompute-2022-03-10"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -15,7 +15,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-12-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MachineExtensionInstanceView-status' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-12-10-preview/HybridCompute.json:1229:9 @@ -27,10 +27,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-06-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json:706:5 @@ -94,10 +94,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-05-17-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json:706:5 @@ -164,7 +164,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-05-20"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2021-05-20/HybridCompute.json:706:5 @@ -228,10 +228,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-04-22-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-04-22-preview/HybridCompute.json:706:5 @@ -295,10 +295,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-03-25-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-03-25-preview/HybridCompute.json:653:5 @@ -356,10 +356,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2021-01-28-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-01-28-preview/HybridCompute.json:653:5 @@ -417,10 +417,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2020-08-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json:786:5 @@ -502,10 +502,10 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'MachineExtensio warning | PreNamer/DeduplicateName | Deduplicating schema name: 'OperationValueDisplay' -> 'OperationValueDisplayAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2019-03-18"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2019-03-18/HybridCompute.json:418:5 @@ -537,7 +537,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2019-08-02"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2019-08-02/HybridCompute.json:718:5 @@ -582,10 +582,10 @@ warning | PreCheck/SchemaMissingType | The schema 'MachineExtensionsListResult' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2019-12-12"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2019-12-12/HybridCompute.json:722:5 @@ -654,10 +654,10 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'MachineExtensio warning | PreNamer/DeduplicateName | Deduplicating schema name: 'OperationValueDisplay' -> 'OperationValueDisplayAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2020-07-30-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2020-07-30-preview/HybridCompute.json:663:5 @@ -722,7 +722,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.hybridcompute-2020-08-02"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json:663:5 @@ -785,4 +785,4 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'OperationValueD warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms -info | Autorest completed in 34.12s. 28 files generated. +info | Autorest completed in 32.6s. 28 files generated. diff --git a/generated/hybridcompute/microsoft.hybridcompute/2019-03-18-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2019-03-18-preview/types.md index 489dc8a68d..a477183d76 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2019-03-18-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2019-03-18-preview/types.md @@ -12,6 +12,13 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.HybridCompute/machines' (ReadOnly, DeployTimeConstant): The resource type +## ErrorDetail +### Properties +* **code**: string (Required): The error's code. +* **details**: [ErrorDetail](#errordetail)[]: Additional error details. +* **message**: string (Required): A human readable error message. +* **target**: string: Indicates which property in the request is responsible for the error. + ## Identity ### Properties * **principalId**: string (ReadOnly): The identity's principal id. @@ -34,13 +41,6 @@ * **status**: 'Connected' | 'Disconnected' | 'Error' (ReadOnly): The status of the hybrid machine agent. * **vmId**: string (ReadOnly): Specifies the hybrid machine unique ID. -## ErrorDetail -### Properties -* **code**: string (Required): The error's code. -* **details**: [ErrorDetail](#errordetail)[]: Additional error details. -* **message**: string (Required): A human readable error message. -* **target**: string: Indicates which property in the request is responsible for the error. - ## OSProfile ### Properties * **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. diff --git a/generated/hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.md index 01f1470093..6212186d55 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.md @@ -24,29 +24,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.HybridCompute/machines/extensions' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The identity's principal id. -* **tenantId**: string (ReadOnly): The identity's tenant id. -* **type**: string: The identity type. - -## MachineProperties -### Properties -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string: The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. -* **osVersion**: string: The version of Operating System running on the hybrid machine. -* **physicalLocation**: string: Resource's Physical Location -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string (ReadOnly): Specifies the hybrid machine unique ID. - ## ErrorDetail ### Properties * **code**: string (Required): The error's code. @@ -54,6 +31,12 @@ * **message**: string (Required): A human readable error message. * **target**: string: Indicates which property in the request is responsible for the error. +## Identity +### Properties +* **principalId**: string (ReadOnly): The identity's principal id. +* **tenantId**: string (ReadOnly): The identity's tenant id. +* **type**: string: The identity type. + ## MachineExtensionInstanceView ### Properties * **name**: string: The machine extension name. @@ -69,15 +52,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## OSProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -90,6 +64,32 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## MachineProperties +### Properties +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string: The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. +* **osVersion**: string: The version of Operating System running on the hybrid machine. +* **physicalLocation**: string: Resource's Physical Location +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string (ReadOnly): Specifies the hybrid machine unique ID. + +## OSProfile +### Properties +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/hybridcompute/microsoft.hybridcompute/2019-12-12/types.md b/generated/hybridcompute/microsoft.hybridcompute/2019-12-12/types.md index acc9ff0e5d..f5c67d24e7 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2019-12-12/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2019-12-12/types.md @@ -23,29 +23,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.HybridCompute/machines/extensions' (ReadOnly, DeployTimeConstant): The resource type -## MachineIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. - ## ErrorDetail ### Properties * **code**: string (Required): The error's code. @@ -53,6 +30,13 @@ * **message**: string (Required): A human readable error message. * **target**: string: Indicates which property in the request is responsible for the error. +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + ## MachineExtensionInstanceView ### Properties * **name**: string: The machine extension name. @@ -68,22 +52,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## MachinePropertiesOsProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -103,6 +71,38 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## MachineIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## MachineProperties +### Properties +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. + +## MachinePropertiesOsProfile +### Properties +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.md index 69031621f7..65e0dbd9f6 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.md @@ -23,34 +23,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.HybridCompute/machines/extensions' (ReadOnly, DeployTimeConstant): The resource type -## MachineIdentity -### Properties -* **principalId**: string (ReadOnly): The identity's principal id. -* **tenantId**: string (ReadOnly): The identity's tenant id. -* **type**: string: The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## ErrorDetail ### Properties * **code**: string (Required): The error's code. @@ -58,6 +30,13 @@ * **message**: string (Required): A human readable error message. * **target**: string: Indicates which property in the request is responsible for the error. +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + ## MachineExtensionInstanceView ### Properties * **name**: string: The machine extension name. @@ -73,22 +52,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## MachinePropertiesOsProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -108,6 +71,43 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. +## MachineIdentity +### Properties +* **principalId**: string (ReadOnly): The identity's principal id. +* **tenantId**: string (ReadOnly): The identity's tenant id. +* **type**: string: The identity type. + +## MachineProperties +### Properties +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID + +## MachinePropertiesOsProfile +### Properties +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/hybridcompute/microsoft.hybridcompute/2020-08-02/types.md b/generated/hybridcompute/microsoft.hybridcompute/2020-08-02/types.md index 369b5ab343..29742d0b38 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2020-08-02/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2020-08-02/types.md @@ -23,34 +23,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.HybridCompute/machines/extensions' (ReadOnly, DeployTimeConstant): The resource type -## MachineIdentity -### Properties -* **principalId**: string (ReadOnly): The identity's principal id. -* **tenantId**: string (ReadOnly): The identity's tenant id. -* **type**: string: The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[] (ReadOnly): Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## ErrorDetail ### Properties * **code**: string (Required): The error's code. @@ -58,6 +30,13 @@ * **message**: string (Required): A human readable error message. * **target**: string: Indicates which property in the request is responsible for the error. +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + ## MachineExtensionInstanceView ### Properties * **name**: string (ReadOnly): The machine extension name. @@ -73,22 +52,6 @@ * **message**: string (ReadOnly): The detailed status message, including for alerts and error messages. * **time**: string (ReadOnly): The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## MachinePropertiesOsProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -108,6 +71,43 @@ * **type**: string (ReadOnly): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (ReadOnly): Specifies the version of the script handler. +## MachineIdentity +### Properties +* **principalId**: string (ReadOnly): The identity's principal id. +* **tenantId**: string (ReadOnly): The identity's tenant id. +* **type**: string: The identity type. + +## MachineProperties +### Properties +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[] (ReadOnly): Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID + +## MachinePropertiesOsProfile +### Properties +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.md index 6112555842..7e3640d0b3 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.md @@ -52,35 +52,6 @@ * **properties**: [ScopedResourceProperties](#scopedresourceproperties): Properties of a private link scoped resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/scopedResources' (ReadOnly, DeployTimeConstant): The resource type -## MachineIdentity -### Properties -* **principalId**: string (ReadOnly): The identity's principal id. -* **tenantId**: string (ReadOnly): The identity's tenant id. -* **type**: string: The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **privateLinkScopedResources**: string[] (ReadOnly): List of private link scoped resources associated with this machine. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## ErrorDetail ### Properties * **code**: string (Required): The error's code. @@ -88,6 +59,19 @@ * **message**: string (Required): A human readable error message. * **target**: string: Indicates which property in the request is responsible for the error. +## HybridComputePrivateLinkScopeProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + ## MachineExtensionInstanceView ### Properties * **name**: string: The machine extension name. @@ -103,22 +87,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## MachinePropertiesOsProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -138,16 +106,38 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## TrackedResourceTags +## MachineIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The identity's principal id. +* **tenantId**: string (ReadOnly): The identity's tenant id. +* **type**: string: The identity type. -## HybridComputePrivateLinkScopeProperties +## MachineProperties ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [MachinePropertiesOsProfile](#machinepropertiesosprofile): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **privateLinkScopedResources**: string[] (ReadOnly): List of private link scoped resources associated with this machine. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID + +## MachinePropertiesOsProfile +### Properties +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. ## PrivateEndpointConnection ### Properties @@ -166,19 +156,29 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. -## PrivateLinkScopesResourceTags +## ScopedResourceProperties +### Properties +* **linkedResourceId**: string: The resource id of the scoped Azure monitor resource. +* **provisioningState**: string (ReadOnly): State of the private endpoint connection. + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ScopedResourceProperties +## TrackedResourceTags ### Properties -* **linkedResourceId**: string: The resource id of the scoped Azure monitor resource. -* **provisioningState**: string (ReadOnly): State of the private endpoint connection. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.md index 947d31c276..59412542c0 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.md @@ -47,34 +47,10 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties +## ErrorAdditionalInfo ### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorDetail ### Properties @@ -84,10 +60,24 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -104,31 +94,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## OSProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -141,21 +106,32 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## MachineProperties ### Properties -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID -## PrivateLinkScopesResourceTags +## OSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. ## PrivateEndpointConnectionProperties ### Properties @@ -167,9 +143,33 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.md index 1ff01d431d..461ce6f3e6 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.md @@ -47,42 +47,16 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## DetectedProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + ## ErrorDetail ### Properties * **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. @@ -91,10 +65,24 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -111,31 +99,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## OSProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -148,21 +111,34 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## MachineProperties ### Properties -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID -## PrivateLinkScopesResourceTags +## OSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. ## PrivateEndpointConnectionProperties ### Properties @@ -174,9 +150,33 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.md index c0e067492e..eb4231c538 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.md @@ -47,42 +47,16 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## DetectedProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + ## ErrorDetail ### Properties * **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. @@ -91,10 +65,24 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -111,31 +99,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## OSProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -148,21 +111,34 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## MachineProperties ### Properties -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID -## PrivateLinkScopesResourceTags +## OSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. ## PrivateEndpointConnectionProperties ### Properties @@ -174,9 +150,33 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.md index cb6209aefd..6edf8ab8d1 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.md @@ -47,42 +47,16 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## DetectedProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + ## ErrorDetail ### Properties * **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. @@ -91,10 +65,25 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -111,31 +100,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## OSProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -148,17 +112,34 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## TrackedResourceTags +## MachineProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID -## HybridComputePrivateLinkScopeProperties +## OSProfile ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. ## PrivateEndpointConnectionDataModel ### Properties @@ -177,13 +158,32 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. -## PrivateLinkScopesResourceTags +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-05-20/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-05-20/types.md index 0c1c92f786..04185dfed6 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-05-20/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-05-20/types.md @@ -47,42 +47,16 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## DetectedProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + ## ErrorDetail ### Properties * **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. @@ -91,10 +65,24 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -111,31 +99,6 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - -## OSProfile -### Properties -* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MachineExtensionProperties ### Properties * **autoUpgradeMinorVersion**: bool: 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. @@ -148,21 +111,34 @@ * **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string: Specifies the version of the script handler. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## MachineProperties ### Properties -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile) (ReadOnly): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID -## PrivateLinkScopesResourceTags +## OSProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. ## PrivateEndpointConnectionProperties ### Properties @@ -174,9 +150,33 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.md index c82f99b611..7ce84a73a4 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.md @@ -47,12 +47,71 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type +## DetectedProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. + +## HybridComputePrivateLinkScopeProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. + +## MachineExtensionInstanceView +### Properties +* **name**: string: The machine extension name. +* **status**: [MachineExtensionInstanceViewStatus](#machineextensioninstanceviewstatus): Instance view status. +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## MachineExtensionInstanceViewStatus +### Properties +* **code**: string: The status code. +* **displayStatus**: string: The short localizable label for the status. +* **level**: 'Error' | 'Info' | 'Warning' | string: The level code. +* **message**: string: The detailed status message, including for alerts and error messages. +* **time**: string: The time of the status. + +## MachineExtensionProperties +### Properties +* **autoUpgradeMinorVersion**: bool: 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. +* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. +* **instanceView**: [MachineExtensionInstanceView](#machineextensioninstanceview): Describes the Machine Extension Instance View. +* **protectedSettings**: any: Any object +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string: The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + ## MachineProperties ### Properties * **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. @@ -80,46 +139,6 @@ * **vmId**: string: Specifies the hybrid machine unique ID. * **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID -## DetectedProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## MachineExtensionInstanceView -### Properties -* **name**: string: The machine extension name. -* **status**: [MachineExtensionInstanceViewStatus](#machineextensioninstanceviewstatus): Instance view status. -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## MachineExtensionInstanceViewStatus -### Properties -* **code**: string: The status code. -* **displayStatus**: string: The short localizable label for the status. -* **level**: 'Error' | 'Info' | 'Warning' | string: The level code. -* **message**: string: The detailed status message, including for alerts and error messages. -* **time**: string: The time of the status. - -## LocationData -### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. - ## OSProfile ### Properties * **computerName**: string (ReadOnly): Specifies the host OS name of the hybrid machine. @@ -130,51 +149,13 @@ ### Properties * **patchSettings**: [PatchSettings](#patchsettings): Specifies the patch settings. -## PatchSettings -### Properties -* **assessmentMode**: string: Specifies the assessment mode. - ## OSProfileWindowsConfiguration ### Properties * **patchSettings**: [PatchSettings](#patchsettings): Specifies the patch settings. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MachineExtensionProperties -### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. -* **instanceView**: [MachineExtensionInstanceView](#machineextensioninstanceview): Describes the Machine Extension Instance View. -* **protectedSettings**: any: Any object -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## PatchSettings ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **assessmentMode**: string: Specifies the assessment mode. ## PrivateEndpointConnectionDataModel ### Properties @@ -193,13 +174,32 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. -## PrivateLinkScopesResourceTags +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.md b/generated/hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.md index ef57bf46b7..74e9e01199 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.md @@ -47,41 +47,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentConfiguration**: [AgentConfiguration](#agentconfiguration): Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **cloudMetadata**: [CloudMetadata](#cloudmetadata): The metadata of the cloud environment (Azure/GCP/AWS/OCI...). -* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **mssqlDiscovered**: string: Specifies whether any MS SQL instance is discovered on the machine. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osType**: string: The type of Operating System (windows/linux). -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## AgentConfiguration ### Properties * **incomingConnectionsPorts**: string[] (ReadOnly): Specifies the list of ports that the agent will be able to listen on. @@ -96,6 +61,11 @@ ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + ## ErrorDetail ### Properties * **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. @@ -104,10 +74,25 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -124,12 +109,47 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData +## MachineExtensionProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **autoUpgradeMinorVersion**: bool: 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. +* **enableAutomaticUpgrade**: bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. +* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. +* **instanceView**: [MachineExtensionInstanceView](#machineextensioninstanceview): Describes the Machine Extension Instance View. +* **protectedSettings**: any: Any object +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string: The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## MachineProperties +### Properties +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentConfiguration**: [AgentConfiguration](#agentconfiguration): Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **cloudMetadata**: [CloudMetadata](#cloudmetadata): The metadata of the cloud environment (Azure/GCP/AWS/OCI...). +* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **mssqlDiscovered**: string: Specifies whether any MS SQL instance is discovered on the machine. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osType**: string: The type of Operating System (windows/linux). +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID ## OSProfile ### Properties @@ -141,53 +161,14 @@ ### Properties * **patchSettings**: [PatchSettings](#patchsettings): Specifies the patch settings. -## PatchSettings -### Properties -* **assessmentMode**: string: Specifies the assessment mode. -* **patchMode**: string: Specifies the patch mode. - ## OSProfileWindowsConfiguration ### Properties * **patchSettings**: [PatchSettings](#patchsettings): Specifies the patch settings. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MachineExtensionProperties -### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **enableAutomaticUpgrade**: bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. -* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. -* **instanceView**: [MachineExtensionInstanceView](#machineextensioninstanceview): Describes the Machine Extension Instance View. -* **protectedSettings**: any: Any object -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## PatchSettings ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **assessmentMode**: string: Specifies the assessment mode. +* **patchMode**: string: Specifies the patch mode. ## PrivateEndpointConnectionDataModel ### Properties @@ -206,13 +187,32 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. -## PrivateLinkScopesResourceTags +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/hybridcompute/microsoft.hybridcompute/2022-03-10/types.md b/generated/hybridcompute/microsoft.hybridcompute/2022-03-10/types.md index 13e3755093..435c841121 100644 --- a/generated/hybridcompute/microsoft.hybridcompute/2022-03-10/types.md +++ b/generated/hybridcompute/microsoft.hybridcompute/2022-03-10/types.md @@ -47,42 +47,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## MachineProperties -### Properties -* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. -* **agentConfiguration**: [AgentConfiguration](#agentconfiguration) (ReadOnly): Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. -* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. -* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding -* **cloudMetadata**: [CloudMetadata](#cloudmetadata): The metadata of the cloud environment (Azure/GCP/AWS/OCI...). -* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. -* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. -* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. -* **domainName**: string (ReadOnly): Specifies the Windows domain name. -* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. -* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information -* **lastStatusChange**: string (ReadOnly): The time of the last status change. -* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. -* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. -* **mssqlDiscovered**: string: Specifies whether any MS SQL instance is discovered on the machine. -* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. -* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the hybrid machine. -* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. -* **osType**: string: The type of Operating System (windows/linux). -* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. -* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. -* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **serviceStatuses**: [ServiceStatuses](#servicestatuses): Reports the state and behavior of dependent services. -* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. -* **vmId**: string: Specifies the hybrid machine unique ID. -* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID - ## AgentConfiguration ### Properties * **extensionsAllowList**: [ConfigurationExtension](#configurationextension)[] (ReadOnly): Array of extensions that are allowed to be installed or updated. @@ -93,20 +57,25 @@ * **proxyBypass**: string[] (ReadOnly): List of service names which should not use the specified proxy server. * **proxyUrl**: string (ReadOnly): Specifies the URL of the proxy to be used. +## CloudMetadata +### Properties +* **provider**: string (ReadOnly): Specifies the cloud provider (Azure/AWS/GCP...). + ## ConfigurationExtension ### Properties * **publisher**: string (ReadOnly): Publisher of the extension. * **type**: string (ReadOnly): Type of the extension. -## CloudMetadata -### Properties -* **provider**: string (ReadOnly): Specifies the cloud provider (Azure/AWS/GCP...). - ## DetectedProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + ## ErrorDetail ### Properties * **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. @@ -115,10 +84,25 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## HybridComputePrivateLinkScopeProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. +* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## LocationData +### Properties +* **city**: string: The city or locality where the resource is located. +* **countryOrRegion**: string: The country or region where the resource is located +* **district**: string: The district, state, or province where the resource is located. +* **name**: string (Required): A canonical name for the geographic or physical location. ## MachineExtensionInstanceView ### Properties @@ -135,12 +119,48 @@ * **message**: string: The detailed status message, including for alerts and error messages. * **time**: string: The time of the status. -## LocationData +## MachineExtensionProperties ### Properties -* **city**: string: The city or locality where the resource is located. -* **countryOrRegion**: string: The country or region where the resource is located -* **district**: string: The district, state, or province where the resource is located. -* **name**: string (Required): A canonical name for the geographic or physical location. +* **autoUpgradeMinorVersion**: bool: 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. +* **enableAutomaticUpgrade**: bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. +* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. +* **instanceView**: [MachineExtensionInstanceView](#machineextensioninstanceview): Describes the Machine Extension Instance View. +* **protectedSettings**: any: Any object +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string: The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string: Specifies the version of the script handler. + +## MachineProperties +### Properties +* **adFqdn**: string (ReadOnly): Specifies the AD fully qualified display name. +* **agentConfiguration**: [AgentConfiguration](#agentconfiguration) (ReadOnly): Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. +* **agentVersion**: string (ReadOnly): The hybrid machine agent full version. +* **clientPublicKey**: string: Public Key that the client provides to be used during initial resource onboarding +* **cloudMetadata**: [CloudMetadata](#cloudmetadata): The metadata of the cloud environment (Azure/GCP/AWS/OCI...). +* **detectedProperties**: [DetectedProperties](#detectedproperties) (ReadOnly): Detected properties from the machine. +* **displayName**: string (ReadOnly): Specifies the hybrid machine display name. +* **dnsFqdn**: string (ReadOnly): Specifies the DNS fully qualified display name. +* **domainName**: string (ReadOnly): Specifies the Windows domain name. +* **errorDetails**: [ErrorDetail](#errordetail)[] (ReadOnly): Details about the error state. +* **extensions**: [MachineExtensionInstanceView](#machineextensioninstanceview)[]: Machine Extensions information +* **lastStatusChange**: string (ReadOnly): The time of the last status change. +* **locationData**: [LocationData](#locationdata): Metadata pertaining to the geographic location of the resource. +* **machineFqdn**: string (ReadOnly): Specifies the hybrid machine FQDN. +* **mssqlDiscovered**: string: Specifies whether any MS SQL instance is discovered on the machine. +* **osName**: string (ReadOnly): The Operating System running on the hybrid machine. +* **osProfile**: [OSProfile](#osprofile): Specifies the operating system settings for the hybrid machine. +* **osSku**: string (ReadOnly): Specifies the Operating System product SKU. +* **osType**: string: The type of Operating System (windows/linux). +* **osVersion**: string (ReadOnly): The version of Operating System running on the hybrid machine. +* **parentClusterResourceId**: string: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. +* **privateLinkScopeResourceId**: string: The resource id of the private link scope this machine is assigned to, if any. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **serviceStatuses**: [ServiceStatuses](#servicestatuses): Reports the state and behavior of dependent services. +* **status**: 'Connected' | 'Disconnected' | 'Error' | string (ReadOnly): The status of the hybrid machine agent. +* **vmId**: string: Specifies the hybrid machine unique ID. +* **vmUuid**: string (ReadOnly): Specifies the Arc Machine's unique SMBIOS ID ## OSProfile ### Properties @@ -152,63 +172,14 @@ ### Properties * **patchSettings**: [PatchSettings](#patchsettings): Specifies the patch settings. -## PatchSettings -### Properties -* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the assessment mode. -* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'ImageDefault' | 'Manual' | string: Specifies the patch mode. - ## OSProfileWindowsConfiguration ### Properties * **patchSettings**: [PatchSettings](#patchsettings): Specifies the patch settings. -## ServiceStatuses -### Properties -* **extensionService**: [ServiceStatus](#servicestatus): Describes the status and behavior of a service. -* **guestConfigurationService**: [ServiceStatus](#servicestatus): Describes the status and behavior of a service. - -## ServiceStatus -### Properties -* **startupType**: string: The behavior of the service when the Arc-enabled machine starts up. -* **status**: string: The current status of the service. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MachineExtensionProperties -### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **enableAutomaticUpgrade**: bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. -* **forceUpdateTag**: string: How the extension handler should be forced to update even if the extension configuration has not changed. -* **instanceView**: [MachineExtensionInstanceView](#machineextensioninstanceview): Describes the Machine Extension Instance View. -* **protectedSettings**: any: Any object -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string: The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string: Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string: Specifies the version of the script handler. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HybridComputePrivateLinkScopeProperties +## PatchSettings ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionDataModel](#privateendpointconnectiondatamodel)[] (ReadOnly): The collection of associated Private Endpoint Connections. -* **privateLinkScopeId**: string (ReadOnly): The Guid id of the private link scope. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +* **assessmentMode**: 'AutomaticByPlatform' | 'ImageDefault' | string: Specifies the assessment mode. +* **patchMode**: 'AutomaticByOS' | 'AutomaticByPlatform' | 'ImageDefault' | 'Manual' | string: Specifies the patch mode. ## PrivateEndpointConnectionDataModel ### Properties @@ -228,13 +199,42 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. -## PrivateLinkScopesResourceTags +## ServiceStatus +### Properties +* **startupType**: string: The behavior of the service when the Arc-enabled machine starts up. +* **status**: string: The current status of the service. + +## ServiceStatuses +### Properties +* **extensionService**: [ServiceStatus](#servicestatus): Describes the status and behavior of a service. +* **guestConfigurationService**: [ServiceStatus](#servicestatus): Describes the status and behavior of a service. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/hybridconnectivity/log.out b/generated/hybridconnectivity/log.out index 845b29c9bb..0bf6ce528a 100644 --- a/generated/hybridconnectivity/log.out +++ b/generated/hybridconnectivity/log.out @@ -3,17 +3,17 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hybridconnectivity-2021-10-06-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.hybridconnectivity-2022-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms -info | Autorest completed in 5.83s. 4 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 5.66s. 4 files generated. diff --git a/generated/hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.md b/generated/hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.md index 4d45cf8f18..e5a6f8c864 100644 --- a/generated/hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.md +++ b/generated/hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.md @@ -15,12 +15,24 @@ * **ApiVersion**: 2021-10-06-preview * **Output**: [EndpointAccessResource](#endpointaccessresource) +## EndpointAccessResource +### Properties +* **relay**: [RelayNamespaceAccessProperties](#relaynamespaceaccessproperties) (ReadOnly): Azure relay hybrid connection access properties + ## EndpointProperties ### Properties * **provisioningState**: string (ReadOnly) * **resourceId**: string: The resource Id of the connectivity endpoint (optional). * **type**: 'custom' | 'default' | string (Required): The type of endpoint. +## RelayNamespaceAccessProperties +### Properties +* **accessKey**: string (ReadOnly): Access key for hybrid connection. +* **expiresOn**: int (ReadOnly): The expiration of access key in unix time. +* **hybridConnectionName**: string (ReadOnly): Azure Relay hybrid connection name for the resource. +* **namespaceName**: string (ReadOnly): The namespace name. +* **namespaceNameSuffix**: string (ReadOnly): The suffix domain name of relay namespace. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -30,15 +42,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## EndpointAccessResource -### Properties -* **relay**: [RelayNamespaceAccessProperties](#relaynamespaceaccessproperties) (ReadOnly): Azure relay hybrid connection access properties - -## RelayNamespaceAccessProperties -### Properties -* **accessKey**: string (ReadOnly): Access key for hybrid connection. -* **expiresOn**: int (ReadOnly): The expiration of access key in unix time. -* **hybridConnectionName**: string (ReadOnly): Azure Relay hybrid connection name for the resource. -* **namespaceName**: string (ReadOnly): The namespace name. -* **namespaceNameSuffix**: string (ReadOnly): The suffix domain name of relay namespace. - diff --git a/generated/hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.md b/generated/hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.md index f186d9220e..cdcf7ba9ba 100644 --- a/generated/hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.md +++ b/generated/hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.md @@ -21,24 +21,25 @@ * **Input**: [ManagedProxyRequest](#managedproxyrequest) * **Output**: [ManagedProxyResource](#managedproxyresource) +## EndpointAccessResource +### Properties +* **relay**: [RelayNamespaceAccessProperties](#relaynamespaceaccessproperties) (ReadOnly): Azure relay hybrid connection access properties + ## EndpointProperties ### Properties * **provisioningState**: string (ReadOnly): The resource provisioning state. * **resourceId**: string: The resource Id of the connectivity endpoint (optional). * **type**: 'custom' | 'default' | string (Required): The type of endpoint. -## SystemData +## ManagedProxyRequest ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **hostname**: string (WriteOnly): The target host name. +* **service**: string (Required, WriteOnly): The name of the service. -## EndpointAccessResource +## ManagedProxyResource ### Properties -* **relay**: [RelayNamespaceAccessProperties](#relaynamespaceaccessproperties) (ReadOnly): Azure relay hybrid connection access properties +* **expiresOn**: int (ReadOnly): The expiration time of short lived proxy name in unix epoch. +* **proxy**: string (ReadOnly): The short lived proxy name. ## RelayNamespaceAccessProperties ### Properties @@ -48,13 +49,12 @@ * **namespaceName**: string (ReadOnly): The namespace name. * **namespaceNameSuffix**: string (ReadOnly): The suffix domain name of relay namespace. -## ManagedProxyRequest -### Properties -* **hostname**: string (WriteOnly): The target host name. -* **service**: string (Required, WriteOnly): The name of the service. - -## ManagedProxyResource +## SystemData ### Properties -* **expiresOn**: int (ReadOnly): The expiration time of short lived proxy name in unix epoch. -* **proxy**: string (ReadOnly): The short lived proxy name. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/hybriddatamanager/log.out b/generated/hybriddatamanager/log.out index ff52146004..213e96334f 100644 --- a/generated/hybriddatamanager/log.out +++ b/generated/hybriddatamanager/log.out @@ -5,25 +5,25 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hybriddata-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 22ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.hybriddata-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms -info | Autorest completed in 8.76s. 4 files generated. +info | autorest.bicep took 5ms +info | Autorest completed in 8.39s. 4 files generated. diff --git a/generated/hybriddatamanager/microsoft.hybriddata/2016-06-01/types.md b/generated/hybriddatamanager/microsoft.hybriddata/2016-06-01/types.md index 4c9f38d71c..3611642859 100644 --- a/generated/hybriddatamanager/microsoft.hybriddata/2016-06-01/types.md +++ b/generated/hybriddatamanager/microsoft.hybriddata/2016-06-01/types.md @@ -33,15 +33,19 @@ region is specified on update the request will succeed. * **properties**: [DataStoreProperties](#datastoreproperties) (Required): Data Store for sources and sinks * **type**: 'Microsoft.HybridData/dataManagers/dataStores' (ReadOnly, DeployTimeConstant): The resource type -## Sku +## CustomerSecret ### Properties -* **name**: string: The sku name. Required for data manager creation, optional for update. -* **tier**: string: The sku tier. This is based on the SKU name. +* **algorithm**: 'None' | 'PlainText' | 'RSA1_5' | 'RSA_OAEP' (Required): The encryption algorithm used to encrypt data. +* **keyIdentifier**: string (Required): The identifier to the data service input object which this secret corresponds to. +* **keyValue**: string (Required): It contains the encrypted customer secret. -## ResourceTags +## DataStoreProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customerSecrets**: [CustomerSecret](#customersecret)[]: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. +* **dataStoreTypeId**: string (Required): The arm id of the data store type. +* **extendedProperties**: any: Any object +* **repositoryId**: string: Arm Id for the manager resource to which the data source is associated. This is optional. +* **state**: 'Disabled' | 'Enabled' | 'Supported' (Required): State of the data service. ## JobDefinitionProperties ### Properties @@ -55,22 +59,18 @@ region is specified on update the request will succeed. * **state**: 'Disabled' | 'Enabled' | 'Supported' (Required): State of the data service. * **userConfirmation**: 'NotRequired' | 'Required': Enum to detect if user confirmation is required. If not passed will default to NotRequired. -## CustomerSecret +## ResourceTags ### Properties -* **algorithm**: 'None' | 'PlainText' | 'RSA1_5' | 'RSA_OAEP' (Required): The encryption algorithm used to encrypt data. -* **keyIdentifier**: string (Required): The identifier to the data service input object which this secret corresponds to. -* **keyValue**: string (Required): It contains the encrypted customer secret. +### Additional Properties +* **Additional Properties Type**: string ## Schedule ### Properties * **name**: string: Name of the schedule. * **policyList**: string[]: A list of repetition intervals in ISO 8601 format. -## DataStoreProperties +## Sku ### Properties -* **customerSecrets**: [CustomerSecret](#customersecret)[]: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. -* **dataStoreTypeId**: string (Required): The arm id of the data store type. -* **extendedProperties**: any: Any object -* **repositoryId**: string: Arm Id for the manager resource to which the data source is associated. This is optional. -* **state**: 'Disabled' | 'Enabled' | 'Supported' (Required): State of the data service. +* **name**: string: The sku name. Required for data manager creation, optional for update. +* **tier**: string: The sku tier. This is based on the SKU name. diff --git a/generated/hybriddatamanager/microsoft.hybriddata/2019-06-01/types.md b/generated/hybriddatamanager/microsoft.hybriddata/2019-06-01/types.md index 71c5d37425..844398dd00 100644 --- a/generated/hybriddatamanager/microsoft.hybriddata/2019-06-01/types.md +++ b/generated/hybriddatamanager/microsoft.hybriddata/2019-06-01/types.md @@ -33,15 +33,19 @@ region is specified on update the request will succeed. * **properties**: [DataStoreProperties](#datastoreproperties) (Required): Data Store for sources and sinks * **type**: 'Microsoft.HybridData/dataManagers/dataStores' (ReadOnly, DeployTimeConstant): The resource type -## Sku +## CustomerSecret ### Properties -* **name**: string: The sku name. Required for data manager creation, optional for update. -* **tier**: string: The sku tier. This is based on the SKU name. +* **algorithm**: 'None' | 'PlainText' | 'RSA1_5' | 'RSA_OAEP' (Required): The encryption algorithm used to encrypt data. +* **keyIdentifier**: string (Required): The identifier to the data service input object which this secret corresponds to. +* **keyValue**: string (Required): It contains the encrypted customer secret. -## ResourceTags +## DataStoreProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customerSecrets**: [CustomerSecret](#customersecret)[]: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. +* **dataStoreTypeId**: string (Required): The arm id of the data store type. +* **extendedProperties**: any: Any object +* **repositoryId**: string: Arm Id for the manager resource to which the data source is associated. This is optional. +* **state**: 'Disabled' | 'Enabled' | 'Supported' (Required): State of the data service. ## JobDefinitionProperties ### Properties @@ -55,22 +59,18 @@ region is specified on update the request will succeed. * **state**: 'Disabled' | 'Enabled' | 'Supported' (Required): State of the data service. * **userConfirmation**: 'NotRequired' | 'Required': Enum to detect if user confirmation is required. If not passed will default to NotRequired. -## CustomerSecret +## ResourceTags ### Properties -* **algorithm**: 'None' | 'PlainText' | 'RSA1_5' | 'RSA_OAEP' (Required): The encryption algorithm used to encrypt data. -* **keyIdentifier**: string (Required): The identifier to the data service input object which this secret corresponds to. -* **keyValue**: string (Required): It contains the encrypted customer secret. +### Additional Properties +* **Additional Properties Type**: string ## Schedule ### Properties * **name**: string: Name of the schedule. * **policyList**: string[]: A list of repetition intervals in ISO 8601 format. -## DataStoreProperties +## Sku ### Properties -* **customerSecrets**: [CustomerSecret](#customersecret)[]: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. -* **dataStoreTypeId**: string (Required): The arm id of the data store type. -* **extendedProperties**: any: Any object -* **repositoryId**: string: Arm Id for the manager resource to which the data source is associated. This is optional. -* **state**: 'Disabled' | 'Enabled' | 'Supported' (Required): State of the data service. +* **name**: string: The sku name. Required for data manager creation, optional for update. +* **tier**: string: The sku tier. This is based on the SKU name. diff --git a/generated/hybridkubernetes/log.out b/generated/hybridkubernetes/log.out index ed1c705f00..81132ed0ca 100644 --- a/generated/hybridkubernetes/log.out +++ b/generated/hybridkubernetes/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.kubernetes-2020-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json:417:5 @@ -18,10 +18,10 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionConfig' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json:755:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 10ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.kubernetes-2021-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json:433:5 @@ -33,20 +33,20 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionConfig' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json:748:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.kubernetes-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/stable/2021-03-01/connectedClusters.json:359:5 warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/stable/2021-03-01/connectedClusters.json:385:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.kubernetes-2021-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json:420:5 @@ -58,5 +58,5 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionConfig' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json:701:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms -info | Autorest completed in 9.51s. 8 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 9.02s. 8 files generated. diff --git a/generated/hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.md b/generated/hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.md index dc38ee29f1..db43020f2e 100644 --- a/generated/hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.md +++ b/generated/hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.md @@ -18,6 +18,21 @@ * **Input**: [AuthenticationDetails](#authenticationdetails) * **Output**: [CredentialResults](#credentialresults) +## AuthenticationDetails +### Properties +* **authenticationMethod**: 'Token' | string (Required, WriteOnly): The mode of client authentication. +* **value**: [AuthenticationDetailsValue](#authenticationdetailsvalue) (Required, WriteOnly): Authentication token value. + +## AuthenticationDetailsValue +### Properties +* **token**: string (WriteOnly): Authentication token. + +## ConnectedClusterAADProfile +### Properties +* **clientAppId**: string (Required): The client app id configured on target K8 cluster +* **serverAppId**: string (Required): The server app id to access AD server +* **tenantId**: string (Required): The aad tenant id which is configured on target K8s cluster + ## ConnectedClusterIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of connected cluster identity. This property will only be provided for a system assigned identity. @@ -40,25 +55,10 @@ * **totalCoreCount**: int (ReadOnly): Number of CPU cores present in the connected cluster resource * **totalNodeCount**: int (ReadOnly): Number of nodes present in the connected cluster resource -## ConnectedClusterAADProfile -### Properties -* **clientAppId**: string (Required): The client app id configured on target K8 cluster -* **serverAppId**: string (Required): The server app id to access AD server -* **tenantId**: string (Required): The aad tenant id which is configured on target K8s cluster - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AuthenticationDetails -### Properties -* **authenticationMethod**: 'Token' | string (Required, WriteOnly): The mode of client authentication. -* **value**: [AuthenticationDetailsValue](#authenticationdetailsvalue) (Required, WriteOnly): Authentication token value. - -## AuthenticationDetailsValue +## CredentialResult ### Properties -* **token**: string (WriteOnly): Authentication token. +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. ## CredentialResults ### Properties @@ -72,8 +72,8 @@ * **relay**: string (ReadOnly): Name of the relay. * **token**: string (ReadOnly): Sender access token -## CredentialResult +## TrackedResourceTags ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.md b/generated/hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.md index 8409d4e156..3bf0c2fabd 100644 --- a/generated/hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.md +++ b/generated/hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.md @@ -42,24 +42,10 @@ * **totalCoreCount**: int (ReadOnly): Number of CPU cores present in the connected cluster resource * **totalNodeCount**: int (ReadOnly): Number of nodes present in the connected cluster resource -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListClusterUserCredentialsProperties +## CredentialResult ### Properties -* **authenticationMethod**: 'AAD' | 'Token' | string (Required, WriteOnly): The mode of client authentication. -* **clientProxy**: bool (Required, WriteOnly): Boolean value to indicate whether the request is for client side proxy or not +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. ## CredentialResults ### Properties @@ -73,8 +59,22 @@ * **relay**: string (ReadOnly): Name of the relay. * **token**: string (ReadOnly): Sender access token -## CredentialResult +## ListClusterUserCredentialsProperties ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **authenticationMethod**: 'AAD' | 'Token' | string (Required, WriteOnly): The mode of client authentication. +* **clientProxy**: bool (Required, WriteOnly): Boolean value to indicate whether the request is for client side proxy or not + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/hybridkubernetes/microsoft.kubernetes/2021-10-01/types.md b/generated/hybridkubernetes/microsoft.kubernetes/2021-10-01/types.md index d956befb6f..ed78d0a268 100644 --- a/generated/hybridkubernetes/microsoft.kubernetes/2021-10-01/types.md +++ b/generated/hybridkubernetes/microsoft.kubernetes/2021-10-01/types.md @@ -40,24 +40,10 @@ * **totalCoreCount**: int (ReadOnly): Number of CPU cores present in the connected cluster resource * **totalNodeCount**: int (ReadOnly): Number of nodes present in the connected cluster resource -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListClusterUserCredentialProperties +## CredentialResult ### Properties -* **authenticationMethod**: 'AAD' | 'Token' | string (Required, WriteOnly): The mode of client authentication. -* **clientProxy**: bool (Required, WriteOnly): Boolean value to indicate whether the request is for client side proxy or not +* **name**: string (ReadOnly): The name of the credential. +* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. ## CredentialResults ### Properties @@ -71,8 +57,22 @@ * **relay**: string (ReadOnly): Name of the relay. * **token**: string (ReadOnly): Sender access token -## CredentialResult +## ListClusterUserCredentialProperties ### Properties -* **name**: string (ReadOnly): The name of the credential. -* **value**: any (ReadOnly): Base64-encoded Kubernetes configuration file. +* **authenticationMethod**: 'AAD' | 'Token' | string (Required, WriteOnly): The mode of client authentication. +* **clientProxy**: bool (Required, WriteOnly): Boolean value to indicate whether the request is for client side proxy or not + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that last modified the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/hybridnetwork/log.out b/generated/hybridnetwork/log.out index 2afd7d7453..d2d99d9f66 100644 --- a/generated/hybridnetwork/log.out +++ b/generated/hybridnetwork/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.hybridnetwork-2022-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -20,7 +20,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.hybridnetwork-2021-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/common.json:38:5 @@ -130,7 +130,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.hybridnetwork-2020-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/preview/2020-01-01-preview/common.json:38:5 @@ -236,5 +236,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms -info | Autorest completed in 12.67s. 6 files generated. +info | autorest.bicep took 5ms +info | Autorest completed in 12.14s. 6 files generated. diff --git a/generated/hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.md b/generated/hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.md index a93f85d620..c0d5cad0fb 100644 --- a/generated/hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.md +++ b/generated/hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.md @@ -63,6 +63,16 @@ * **ApiVersion**: 2020-01-01-preview * **Output**: [DeviceRegistrationKey](#deviceregistrationkey) +## CustomProfile +### Properties +* **metadataConfigurationPath**: string: Path for metadata configuration. + +## DataDisk +### Properties +* **createOption**: 'Empty' | 'Unknown' | string: Specifies how the virtual machine should be created. +* **diskSizeGB**: int: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. +* **name**: string: The name of data disk. + ## DevicePropertiesFormat * **Discriminator**: deviceType @@ -76,22 +86,61 @@ * **deviceType**: 'AzureStackEdge' (Required): The type of the device. -## SubResource +## DeviceRegistrationKey ### Properties -* **id**: string: Resource ID. +* **registrationKey**: string (ReadOnly): The registration key for the device. -## TrackedResourceTags +## ImageReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exactVersion**: string: Specifies in decimal numbers, the exact version of image used to create the virtual machine. +* **offer**: string: Specifies the offer of the image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: string: Specifies the version of the 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. -## VendorNetworkFunctionPropertiesFormat +## LinuxConfiguration ### Properties -* **networkFunctionVendorConfigurations**: [NetworkFunctionVendorConfiguration](#networkfunctionvendorconfiguration)[]: An array of network function vendor configurations. +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure + +## NetworkFunctionPropertiesFormat +### Properties +* **device**: [SubResource](#subresource): Reference to another sub resource. +* **managedApplication**: [SubResource](#subresource) (ReadOnly): Reference to another sub resource. +* **managedApplicationParameters**: any: Any object +* **networkFunctionUserConfigurations**: [NetworkFunctionUserConfiguration](#networkfunctionuserconfiguration)[]: The network function configurations from the user. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **skuName**: string (ReadOnly): The name of the sku. +* **serviceKey**: string (ReadOnly): The service key for the network function resource. +* **skuName**: string: The sku name for the network function. * **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. -* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string: The current vendor provisioning state. +* **vendorName**: string: The vendor name for the network function. +* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string (ReadOnly): The current vendor provisioning state. + +## NetworkFunctionRoleConfiguration +### Properties +* **customProfile**: [CustomProfile](#customprofile): Specifies the custom settings for the virtual machine. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configurations. +* **osProfile**: [OsProfile](#osprofile): Specifies the operating system settings for the role instance. +* **roleName**: string: The name of the network function role. +* **roleType**: 'Unknown' | 'VirtualMachine' | string: Role type. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userDataParameters**: any: Any object +* **userDataTemplate**: any: Any object +* **virtualMachineSize**: 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D1_v2' | 'Standard_D2_v2' | 'Standard_D3_v2' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS11_v2' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS1_v2' | 'Standard_DS2_v2' | 'Standard_DS3_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Unknown' | string: The size of the virtual machine. + +## NetworkFunctionTemplate +### Properties +* **networkFunctionRoleConfigurations**: [NetworkFunctionRoleConfiguration](#networkfunctionroleconfiguration)[]: An array of network function role definitions. + +## NetworkFunctionUserConfiguration +### Properties +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configuration. +* **osProfile**: [NetworkFunctionUserConfigurationOsProfile](#networkfunctionuserconfigurationosprofile): Specifies the operating system settings for the role instance. +* **roleName**: string: The name of the network function role. +* **userDataParameters**: any: Any object + +## NetworkFunctionUserConfigurationOsProfile +### Properties +* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) ## NetworkFunctionVendorConfiguration ### Properties @@ -116,6 +165,13 @@ * **ipVersion**: 'IPv4' | 'Unknown' | string: IP address version. * **subnet**: string: The value of the subnet. +## OsDisk +### Properties +* **diskSizeGB**: int: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. +* **name**: string: The VHD name. +* **osType**: 'Linux' | 'Unknown' | 'Windows' | string: The OS type. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. + ## OsProfile ### Properties * **adminUsername**: 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). @@ -123,10 +179,6 @@ * **customDataRequired**: bool: Indicates if custom data is required to deploy this role. * **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): Specifies the Linux operating system settings on the virtual machine. -## LinuxConfiguration -### Properties -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure - ## SshConfiguration ### Properties * **publicKeys**: [SshPublicKey](#sshpublickey)[]: The list of SSH public keys used to authenticate with linux based VMs. @@ -136,35 +188,34 @@ * **keyData**: string: 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). * **path**: 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 -## NetworkFunctionPropertiesFormat +## StorageProfile ### Properties -* **device**: [SubResource](#subresource): Reference to another sub resource. -* **managedApplication**: [SubResource](#subresource) (ReadOnly): Reference to another sub resource. -* **managedApplicationParameters**: any: Any object -* **networkFunctionUserConfigurations**: [NetworkFunctionUserConfiguration](#networkfunctionuserconfiguration)[]: The network function configurations from the user. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string (ReadOnly): The service key for the network function resource. -* **skuName**: string: The sku name for the network function. -* **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. -* **vendorName**: string: The vendor name for the network function. -* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string (ReadOnly): The current vendor provisioning state. +* **dataDisks**: [DataDisk](#datadisk)[]: Specifies the parameters that are used to add a data disk to a virtual machine. +* **imageReference**: [ImageReference](#imagereference): The image reference properties. +* **osDisk**: [OsDisk](#osdisk): 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). -## NetworkFunctionUserConfiguration +## SubResource ### Properties -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configuration. -* **osProfile**: [NetworkFunctionUserConfigurationOsProfile](#networkfunctionuserconfigurationosprofile): Specifies the operating system settings for the role instance. -* **roleName**: string: The name of the network function role. -* **userDataParameters**: any: Any object +* **id**: string: Resource ID. -## NetworkFunctionUserConfigurationOsProfile +## TrackedResourceTags ### Properties -* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VendorNetworkFunctionPropertiesFormat +### Properties +* **networkFunctionVendorConfigurations**: [NetworkFunctionVendorConfiguration](#networkfunctionvendorconfiguration)[]: An array of network function vendor configurations. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **skuName**: string (ReadOnly): The name of the sku. +* **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. +* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string: The current vendor provisioning state. + ## VendorPropertiesFormat ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. @@ -180,58 +231,7 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. * **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string: Sku type. -## NetworkFunctionTemplate -### Properties -* **networkFunctionRoleConfigurations**: [NetworkFunctionRoleConfiguration](#networkfunctionroleconfiguration)[]: An array of network function role definitions. - -## NetworkFunctionRoleConfiguration -### Properties -* **customProfile**: [CustomProfile](#customprofile): Specifies the custom settings for the virtual machine. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configurations. -* **osProfile**: [OsProfile](#osprofile): Specifies the operating system settings for the role instance. -* **roleName**: string: The name of the network function role. -* **roleType**: 'Unknown' | 'VirtualMachine' | string: Role type. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userDataParameters**: any: Any object -* **userDataTemplate**: any: Any object -* **virtualMachineSize**: 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D1_v2' | 'Standard_D2_v2' | 'Standard_D3_v2' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS11_v2' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS1_v2' | 'Standard_DS2_v2' | 'Standard_DS3_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Unknown' | string: The size of the virtual machine. - -## CustomProfile -### Properties -* **metadataConfigurationPath**: string: Path for metadata configuration. - -## StorageProfile -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: Specifies the parameters that are used to add a data disk to a virtual machine. -* **imageReference**: [ImageReference](#imagereference): The image reference properties. -* **osDisk**: [OsDisk](#osdisk): 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). - -## DataDisk -### Properties -* **createOption**: 'Empty' | 'Unknown' | string: Specifies how the virtual machine should be created. -* **diskSizeGB**: int: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. -* **name**: string: The name of data disk. - -## ImageReference -### Properties -* **exactVersion**: string: Specifies in decimal numbers, the exact version of image used to create the virtual machine. -* **offer**: string: Specifies the offer of the image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: string: Specifies the version of the 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. - -## OsDisk -### Properties -* **diskSizeGB**: int: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. -* **name**: string: The VHD name. -* **osType**: 'Linux' | 'Unknown' | 'Windows' | string: The OS type. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. - ## VirtualHardDisk ### Properties * **uri**: string (WriteOnly): Specifies the virtual hard disk's uri. -## DeviceRegistrationKey -### Properties -* **registrationKey**: string (ReadOnly): The registration key for the device. - diff --git a/generated/hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.md b/generated/hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.md index 6a5ad0a1e4..e522e95684 100644 --- a/generated/hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.md +++ b/generated/hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.md @@ -70,6 +70,16 @@ * **ApiVersion**: 2021-05-01 * **Output**: [DeviceRegistrationKey](#deviceregistrationkey) +## CustomProfile +### Properties +* **metadataConfigurationPath**: string: Path for metadata configuration. + +## DataDisk +### Properties +* **createOption**: 'Empty' | 'Unknown' | string: Specifies how the virtual machine should be created. +* **diskSizeGB**: int: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. +* **name**: string: The name of data disk. + ## DevicePropertiesFormat * **Discriminator**: deviceType @@ -83,31 +93,62 @@ * **deviceType**: 'AzureStackEdge' (Required): The type of the device. -## SubResource +## DeviceRegistrationKey ### Properties -* **id**: string: Resource ID. +* **registrationKey**: string (ReadOnly): The registration key for the device. -## SystemData +## ImageReference ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **exactVersion**: string: Specifies in decimal numbers, the exact version of image used to create the virtual machine. +* **offer**: string: Specifies the offer of the image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: string: Specifies the version of the 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. -## TrackedResourceTags +## LinuxConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## VendorNetworkFunctionPropertiesFormat +## NetworkFunctionPropertiesFormat ### Properties -* **networkFunctionVendorConfigurations**: [NetworkFunctionVendorConfiguration](#networkfunctionvendorconfiguration)[]: An array of network function vendor configurations. +* **device**: [SubResource](#subresource): Reference to another sub resource. +* **managedApplication**: [SubResource](#subresource) (ReadOnly): Reference to another sub resource. +* **managedApplicationParameters**: any: Any object +* **networkFunctionContainerConfigurations**: any: Any object +* **networkFunctionUserConfigurations**: [NetworkFunctionUserConfiguration](#networkfunctionuserconfiguration)[]: The network function configurations from the user. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **skuName**: string (ReadOnly): The name of the sku. Once set, it cannot be updated. +* **serviceKey**: string (ReadOnly): The service key for the network function resource. +* **skuName**: string: The sku name for the network function. Once set, it cannot be updated. * **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. -* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string: The current vendor provisioning state. +* **vendorName**: string: The vendor name for the network function. Once set, it cannot be updated. +* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string (ReadOnly): The current vendor provisioning state. + +## NetworkFunctionRoleConfiguration +### Properties +* **customProfile**: [CustomProfile](#customprofile): Specifies the custom settings for the virtual machine. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configurations. +* **osProfile**: [OsProfile](#osprofile): Specifies the operating system settings for the role instance. +* **roleName**: string: The name of the network function role. +* **roleType**: 'Unknown' | 'VirtualMachine' | string: Role type. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userDataParameters**: any: Any object +* **userDataTemplate**: any: Any object +* **virtualMachineSize**: 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D1_v2' | 'Standard_D2_v2' | 'Standard_D3_v2' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS11_v2' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS1_v2' | 'Standard_DS2_v2' | 'Standard_DS3_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Unknown' | string: The size of the virtual machine. + +## NetworkFunctionTemplate +### Properties +* **networkFunctionRoleConfigurations**: [NetworkFunctionRoleConfiguration](#networkfunctionroleconfiguration)[]: An array of network function role definitions. + +## NetworkFunctionUserConfiguration +### Properties +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configuration. +* **osProfile**: [NetworkFunctionUserConfigurationOsProfile](#networkfunctionuserconfigurationosprofile): Specifies the operating system settings for the role instance. +* **roleName**: string: The name of the network function role. +* **userDataParameters**: any: Any object + +## NetworkFunctionUserConfigurationOsProfile +### Properties +* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) ## NetworkFunctionVendorConfiguration ### Properties @@ -132,6 +173,13 @@ * **ipVersion**: 'IPv4' | 'Unknown' | string: IP address version. * **subnet**: string: The value of the subnet. +## OsDisk +### Properties +* **diskSizeGB**: int: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. +* **name**: string: The VHD name. +* **osType**: 'Linux' | 'Unknown' | 'Windows' | string: The OS type. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. + ## OsProfile ### Properties * **adminUsername**: 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). @@ -139,9 +187,9 @@ * **customDataRequired**: bool: Indicates if custom data is required to deploy this role. * **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): Specifies the Linux operating system settings on the virtual machine. -## LinuxConfiguration +## PreviewSubscriptionProperties ### Properties -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. ## SshConfiguration ### Properties @@ -152,36 +200,43 @@ * **keyData**: string: 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). * **path**: 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 -## NetworkFunctionPropertiesFormat +## StorageProfile ### Properties -* **device**: [SubResource](#subresource): Reference to another sub resource. -* **managedApplication**: [SubResource](#subresource) (ReadOnly): Reference to another sub resource. -* **managedApplicationParameters**: any: Any object -* **networkFunctionContainerConfigurations**: any: Any object -* **networkFunctionUserConfigurations**: [NetworkFunctionUserConfiguration](#networkfunctionuserconfiguration)[]: The network function configurations from the user. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string (ReadOnly): The service key for the network function resource. -* **skuName**: string: The sku name for the network function. Once set, it cannot be updated. -* **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. -* **vendorName**: string: The vendor name for the network function. Once set, it cannot be updated. -* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string (ReadOnly): The current vendor provisioning state. +* **dataDisks**: [DataDisk](#datadisk)[]: Specifies the parameters that are used to add a data disk to a virtual machine. +* **imageReference**: [ImageReference](#imagereference): The image reference properties. +* **osDisk**: [OsDisk](#osdisk): 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). -## NetworkFunctionUserConfiguration +## SubResource ### Properties -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configuration. -* **osProfile**: [NetworkFunctionUserConfigurationOsProfile](#networkfunctionuserconfigurationosprofile): Specifies the operating system settings for the role instance. -* **roleName**: string: The name of the network function role. -* **userDataParameters**: any: Any object +* **id**: string: Resource ID. -## NetworkFunctionUserConfigurationOsProfile +## SystemData ### Properties -* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VendorNetworkFunctionPropertiesFormat +### Properties +* **networkFunctionVendorConfigurations**: [NetworkFunctionVendorConfiguration](#networkfunctionvendorconfiguration)[]: An array of network function vendor configurations. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **skuName**: string (ReadOnly): The name of the sku. Once set, it cannot be updated. +* **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. +* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string: The current vendor provisioning state. + ## VendorPropertiesFormat ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. @@ -198,62 +253,7 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. * **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string: Sku type. -## NetworkFunctionTemplate -### Properties -* **networkFunctionRoleConfigurations**: [NetworkFunctionRoleConfiguration](#networkfunctionroleconfiguration)[]: An array of network function role definitions. - -## NetworkFunctionRoleConfiguration -### Properties -* **customProfile**: [CustomProfile](#customprofile): Specifies the custom settings for the virtual machine. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configurations. -* **osProfile**: [OsProfile](#osprofile): Specifies the operating system settings for the role instance. -* **roleName**: string: The name of the network function role. -* **roleType**: 'Unknown' | 'VirtualMachine' | string: Role type. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userDataParameters**: any: Any object -* **userDataTemplate**: any: Any object -* **virtualMachineSize**: 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D1_v2' | 'Standard_D2_v2' | 'Standard_D3_v2' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS11_v2' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS1_v2' | 'Standard_DS2_v2' | 'Standard_DS3_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Unknown' | string: The size of the virtual machine. - -## CustomProfile -### Properties -* **metadataConfigurationPath**: string: Path for metadata configuration. - -## StorageProfile -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: Specifies the parameters that are used to add a data disk to a virtual machine. -* **imageReference**: [ImageReference](#imagereference): The image reference properties. -* **osDisk**: [OsDisk](#osdisk): 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). - -## DataDisk -### Properties -* **createOption**: 'Empty' | 'Unknown' | string: Specifies how the virtual machine should be created. -* **diskSizeGB**: int: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. -* **name**: string: The name of data disk. - -## ImageReference -### Properties -* **exactVersion**: string: Specifies in decimal numbers, the exact version of image used to create the virtual machine. -* **offer**: string: Specifies the offer of the image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: string: Specifies the version of the 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. - -## OsDisk -### Properties -* **diskSizeGB**: int: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. -* **name**: string: The VHD name. -* **osType**: 'Linux' | 'Unknown' | 'Windows' | string: The OS type. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. - ## VirtualHardDisk ### Properties * **uri**: string (WriteOnly): Specifies the virtual hard disk's uri. -## PreviewSubscriptionProperties -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. - -## DeviceRegistrationKey -### Properties -* **registrationKey**: string (ReadOnly): The registration key for the device. - diff --git a/generated/hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.md b/generated/hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.md index 865aec8991..ab35254dc2 100644 --- a/generated/hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.md +++ b/generated/hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.md @@ -75,6 +75,16 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [DeviceRegistrationKey](#deviceregistrationkey) +## CustomProfile +### Properties +* **metadataConfigurationPath**: string: Path for metadata configuration. + +## DataDisk +### Properties +* **createOption**: 'Empty' | 'Unknown' | string: Specifies how the virtual machine should be created. +* **diskSizeGB**: int: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. +* **name**: string: The name of data disk. + ## DevicePropertiesFormat * **Discriminator**: deviceType @@ -88,31 +98,62 @@ * **deviceType**: 'AzureStackEdge' (Required): The type of the device. -## SubResource +## DeviceRegistrationKey ### Properties -* **id**: string: Resource ID. +* **registrationKey**: string (ReadOnly): The registration key for the device. -## SystemData +## ImageReference ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **exactVersion**: string: Specifies in decimal numbers, the exact version of image used to create the virtual machine. +* **offer**: string: Specifies the offer of the image used to create the virtual machine. +* **publisher**: string: The image publisher. +* **sku**: string: The image SKU. +* **version**: string: Specifies the version of the 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. -## TrackedResourceTags +## LinuxConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure -## VendorNetworkFunctionPropertiesFormat +## NetworkFunctionPropertiesFormat ### Properties -* **networkFunctionVendorConfigurations**: [NetworkFunctionVendorConfiguration](#networkfunctionvendorconfiguration)[]: An array of network function vendor configurations. +* **device**: [SubResource](#subresource): Reference to another sub resource. +* **managedApplication**: [SubResource](#subresource) (ReadOnly): Reference to another sub resource. +* **managedApplicationParameters**: any: Any object +* **networkFunctionContainerConfigurations**: any: Any object +* **networkFunctionUserConfigurations**: [NetworkFunctionUserConfiguration](#networkfunctionuserconfiguration)[]: The network function configurations from the user. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **skuName**: string (ReadOnly): The name of the sku. Once set, it cannot be updated. +* **serviceKey**: string (ReadOnly): The service key for the network function resource. +* **skuName**: string: The sku name for the network function. Once set, it cannot be updated. * **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. -* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string: The current vendor provisioning state. +* **vendorName**: string: The vendor name for the network function. Once set, it cannot be updated. +* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string (ReadOnly): The current vendor provisioning state. + +## NetworkFunctionRoleConfiguration +### Properties +* **customProfile**: [CustomProfile](#customprofile): Specifies the custom settings for the virtual machine. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configurations. +* **osProfile**: [OsProfile](#osprofile): Specifies the operating system settings for the role instance. +* **roleName**: string: The name of the network function role. +* **roleType**: 'Unknown' | 'VirtualMachine' | string: Role type. +* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. +* **userDataParameters**: any: Any object +* **userDataTemplate**: any: Any object +* **virtualMachineSize**: 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D1_v2' | 'Standard_D2_v2' | 'Standard_D3_v2' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS11_v2' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS1_v2' | 'Standard_DS2_v2' | 'Standard_DS3_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Unknown' | string: The size of the virtual machine. + +## NetworkFunctionTemplate +### Properties +* **networkFunctionRoleConfigurations**: [NetworkFunctionRoleConfiguration](#networkfunctionroleconfiguration)[]: An array of network function role definitions. + +## NetworkFunctionUserConfiguration +### Properties +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configuration. +* **osProfile**: [NetworkFunctionUserConfigurationOsProfile](#networkfunctionuserconfigurationosprofile): Specifies the operating system settings for the role instance. +* **roleName**: string: The name of the network function role. +* **userDataParameters**: any: Any object + +## NetworkFunctionUserConfigurationOsProfile +### Properties +* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) ## NetworkFunctionVendorConfiguration ### Properties @@ -137,6 +178,13 @@ * **ipVersion**: 'IPv4' | 'Unknown' | string: IP address version. * **subnet**: string: The value of the subnet. +## OsDisk +### Properties +* **diskSizeGB**: int: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. +* **name**: string: The VHD name. +* **osType**: 'Linux' | 'Unknown' | 'Windows' | string: The OS type. +* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. + ## OsProfile ### Properties * **adminUsername**: 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). @@ -144,9 +192,17 @@ * **customDataRequired**: bool: Indicates if custom data is required to deploy this role. * **linuxConfiguration**: [LinuxConfiguration](#linuxconfiguration): Specifies the Linux operating system settings on the virtual machine. -## LinuxConfiguration +## PreviewSubscriptionProperties ### Properties -* **ssh**: [SshConfiguration](#sshconfiguration): SSH configuration for Linux based VMs running on Azure +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. + +## SkuCredential +### Properties +* **acrServerUrl**: string (ReadOnly): The Acr server url +* **acrToken**: string (ReadOnly): The credential value. +* **expiry**: string (ReadOnly): The UTC time when credential will expire. +* **repositories**: string[] (ReadOnly): The repositories that could be accessed using the current credential. +* **username**: string (ReadOnly): The username of the sku credential. ## SshConfiguration ### Properties @@ -157,36 +213,43 @@ * **keyData**: string: 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). * **path**: 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 -## NetworkFunctionPropertiesFormat +## StorageProfile ### Properties -* **device**: [SubResource](#subresource): Reference to another sub resource. -* **managedApplication**: [SubResource](#subresource) (ReadOnly): Reference to another sub resource. -* **managedApplicationParameters**: any: Any object -* **networkFunctionContainerConfigurations**: any: Any object -* **networkFunctionUserConfigurations**: [NetworkFunctionUserConfiguration](#networkfunctionuserconfiguration)[]: The network function configurations from the user. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string (ReadOnly): The service key for the network function resource. -* **skuName**: string: The sku name for the network function. Once set, it cannot be updated. -* **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. -* **vendorName**: string: The vendor name for the network function. Once set, it cannot be updated. -* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string (ReadOnly): The current vendor provisioning state. +* **dataDisks**: [DataDisk](#datadisk)[]: Specifies the parameters that are used to add a data disk to a virtual machine. +* **imageReference**: [ImageReference](#imagereference): The image reference properties. +* **osDisk**: [OsDisk](#osdisk): 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). -## NetworkFunctionUserConfiguration +## SubResource ### Properties -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configuration. -* **osProfile**: [NetworkFunctionUserConfigurationOsProfile](#networkfunctionuserconfigurationosprofile): Specifies the operating system settings for the role instance. -* **roleName**: string: The name of the network function role. -* **userDataParameters**: any: Any object +* **id**: string: Resource ID. -## NetworkFunctionUserConfigurationOsProfile +## SystemData ### Properties -* **customData**: 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://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    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) +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VendorNetworkFunctionPropertiesFormat +### Properties +* **networkFunctionVendorConfigurations**: [NetworkFunctionVendorConfiguration](#networkfunctionvendorconfiguration)[]: An array of network function vendor configurations. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **skuName**: string (ReadOnly): The name of the sku. Once set, it cannot be updated. +* **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string (ReadOnly): Sku type. +* **vendorProvisioningState**: 'Deprovisioned' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | 'Unknown' | 'UserDataValidationFailed' | string: The current vendor provisioning state. + ## VendorPropertiesFormat ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. @@ -203,70 +266,7 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. * **skuType**: 'EvolvedPacketCore' | 'Firewall' | 'SDWAN' | 'Unknown' | string: Sku type. -## NetworkFunctionTemplate -### Properties -* **networkFunctionRoleConfigurations**: [NetworkFunctionRoleConfiguration](#networkfunctionroleconfiguration)[]: An array of network function role definitions. - -## NetworkFunctionRoleConfiguration -### Properties -* **customProfile**: [CustomProfile](#customprofile): Specifies the custom settings for the virtual machine. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interface configurations. -* **osProfile**: [OsProfile](#osprofile): Specifies the operating system settings for the role instance. -* **roleName**: string: The name of the network function role. -* **roleType**: 'Unknown' | 'VirtualMachine' | string: Role type. -* **storageProfile**: [StorageProfile](#storageprofile): Specifies the storage settings for the virtual machine disks. -* **userDataParameters**: any: Any object -* **userDataTemplate**: any: Any object -* **virtualMachineSize**: 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D1_v2' | 'Standard_D2_v2' | 'Standard_D3_v2' | 'Standard_D4_v2' | 'Standard_D5_v2' | 'Standard_DS11_v2' | 'Standard_DS12_v2' | 'Standard_DS13_v2' | 'Standard_DS1_v2' | 'Standard_DS2_v2' | 'Standard_DS3_v2' | 'Standard_DS4_v2' | 'Standard_DS5_v2' | 'Standard_F1' | 'Standard_F16' | 'Standard_F16s' | 'Standard_F1s' | 'Standard_F2' | 'Standard_F2s' | 'Standard_F4' | 'Standard_F4s' | 'Standard_F8' | 'Standard_F8s' | 'Unknown' | string: The size of the virtual machine. - -## CustomProfile -### Properties -* **metadataConfigurationPath**: string: Path for metadata configuration. - -## StorageProfile -### Properties -* **dataDisks**: [DataDisk](#datadisk)[]: Specifies the parameters that are used to add a data disk to a virtual machine. -* **imageReference**: [ImageReference](#imagereference): The image reference properties. -* **osDisk**: [OsDisk](#osdisk): 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). - -## DataDisk -### Properties -* **createOption**: 'Empty' | 'Unknown' | string: Specifies how the virtual machine should be created. -* **diskSizeGB**: int: Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. -* **name**: string: The name of data disk. - -## ImageReference -### Properties -* **exactVersion**: string: Specifies in decimal numbers, the exact version of image used to create the virtual machine. -* **offer**: string: Specifies the offer of the image used to create the virtual machine. -* **publisher**: string: The image publisher. -* **sku**: string: The image SKU. -* **version**: string: Specifies the version of the 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. - -## OsDisk -### Properties -* **diskSizeGB**: int: Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. -* **name**: string: The VHD name. -* **osType**: 'Linux' | 'Unknown' | 'Windows' | string: The OS type. -* **vhd**: [VirtualHardDisk](#virtualharddisk): Describes the uri of a disk. - ## VirtualHardDisk ### Properties * **uri**: string (WriteOnly): Specifies the virtual hard disk's uri. -## PreviewSubscriptionProperties -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. - -## SkuCredential -### Properties -* **acrServerUrl**: string (ReadOnly): The Acr server url -* **acrToken**: string (ReadOnly): The credential value. -* **expiry**: string (ReadOnly): The UTC time when credential will expire. -* **repositories**: string[] (ReadOnly): The repositories that could be accessed using the current credential. -* **username**: string (ReadOnly): The username of the sku credential. - -## DeviceRegistrationKey -### Properties -* **registrationKey**: string (ReadOnly): The registration key for the device. - diff --git a/generated/imagebuilder/log.out b/generated/imagebuilder/log.out index 7518ece24c..6efb6c06a1 100644 --- a/generated/imagebuilder/log.out +++ b/generated/imagebuilder/log.out @@ -3,17 +3,17 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.virtualmachineimages-2021-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. -info | autorest.bicep took 14ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.virtualmachineimages-2020-02-14"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ImageTemplateListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json:549:5 @@ -80,7 +80,7 @@ warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.virtualmachineimages-2019-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ImageTemplateListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/preview/2019-05-01-preview/imagebuilder.json:497:5 @@ -140,10 +140,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ApiError' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/preview/2019-05-01-preview/imagebuilder.json:1248:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.virtualmachineimages-2018-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ImageTemplateListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/preview/2018-02-01-preview/imagebuilder.json:484:5 @@ -192,7 +192,7 @@ warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.virtualmachineimages-2019-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ImageTemplateListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/preview/2019-02-01-preview/imagebuilder.json:484:5 @@ -245,4 +245,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ApiError' with an undefined t warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. info | autorest.bicep took 2ms -info | Autorest completed in 12.25s. 10 files generated. +info | Autorest completed in 11.93s. 10 files generated. diff --git a/generated/imagebuilder/microsoft.virtualmachineimages/2018-02-01-preview/types.md b/generated/imagebuilder/microsoft.virtualmachineimages/2018-02-01-preview/types.md index 3087897798..4aeb9cac60 100644 --- a/generated/imagebuilder/microsoft.virtualmachineimages/2018-02-01-preview/types.md +++ b/generated/imagebuilder/microsoft.virtualmachineimages/2018-02-01-preview/types.md @@ -11,15 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.VirtualMachineImages/imageTemplates' (ReadOnly, DeployTimeConstant): The resource type -## ImageTemplateProperties -### Properties -* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc -* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. -* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly) -* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly) -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the resource -* **source**: [ImageTemplateSource](#imagetemplatesource) (Required) - ## ImageTemplateCustomizer * **Discriminator**: type @@ -63,10 +54,14 @@ * **runSubState**: 'building' | 'customizing' | 'distributing' | 'queued' | string: Sub state of the last run * **startTime**: string: Start time of the last run (UTC) -## ProvisioningError +## ImageTemplateProperties ### Properties -* **message**: string: Verbose error message about the provisioning failure -* **provisioningErrorCode**: 'BadCustomizerType' | 'BadISOSource' | 'BadPIRSource' | 'BadSourceType' | 'NoCustomizerShellScript' | 'Other' | 'ServerError' | string: Error code of the provisioning failure +* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc +* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. +* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly) +* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly) +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the resource +* **source**: [ImageTemplateSource](#imagetemplatesource) (Required) ## ImageTemplateSource * **Discriminator**: type @@ -87,6 +82,11 @@ * **version**: string: Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). +## ProvisioningError +### Properties +* **message**: string: Verbose error message about the provisioning failure +* **provisioningErrorCode**: 'BadCustomizerType' | 'BadISOSource' | 'BadPIRSource' | 'BadSourceType' | 'NoCustomizerShellScript' | 'Other' | 'ServerError' | string: Error code of the provisioning failure + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/imagebuilder/microsoft.virtualmachineimages/2019-02-01-preview/types.md b/generated/imagebuilder/microsoft.virtualmachineimages/2019-02-01-preview/types.md index 6f0c7f67e8..03c99ec2ab 100644 --- a/generated/imagebuilder/microsoft.virtualmachineimages/2019-02-01-preview/types.md +++ b/generated/imagebuilder/microsoft.virtualmachineimages/2019-02-01-preview/types.md @@ -11,15 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.VirtualMachineImages/imageTemplates' (ReadOnly, DeployTimeConstant): The resource type -## ImageTemplateProperties -### Properties -* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc -* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. -* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly) -* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly) -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the resource -* **source**: [ImageTemplateSource](#imagetemplatesource) (Required) - ## ImageTemplateCustomizer * **Discriminator**: type @@ -82,10 +73,14 @@ * **runSubState**: 'Building' | 'Customizing' | 'Distributing' | 'Queued' | string: Sub-state of the last run * **startTime**: string: Start time of the last run (UTC) -## ProvisioningError +## ImageTemplateProperties ### Properties -* **message**: string: Verbose error message about the provisioning failure -* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadISOSource' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure +* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc +* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. +* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly) +* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly) +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the resource +* **source**: [ImageTemplateSource](#imagetemplatesource) (Required) ## ImageTemplateSource * **Discriminator**: type @@ -111,6 +106,11 @@ * **version**: string: Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). +## ProvisioningError +### Properties +* **message**: string: Verbose error message about the provisioning failure +* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadISOSource' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/imagebuilder/microsoft.virtualmachineimages/2019-05-01-preview/types.md b/generated/imagebuilder/microsoft.virtualmachineimages/2019-05-01-preview/types.md index 94031bc882..dbb0e560be 100644 --- a/generated/imagebuilder/microsoft.virtualmachineimages/2019-05-01-preview/types.md +++ b/generated/imagebuilder/microsoft.virtualmachineimages/2019-05-01-preview/types.md @@ -12,32 +12,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.VirtualMachineImages/imageTemplates' (ReadOnly, DeployTimeConstant): The resource type -## ImageTemplateIdentity -### Properties -* **type**: 'None' | 'UserAssigned': The type of identity used for the image template. The type 'None' will remove any identities from the image template. -* **userAssignedIdentities**: [ImageTemplateIdentityUserAssignedIdentities](#imagetemplateidentityuserassignedidentities): The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ImageTemplateIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsvrq145schemasimagetemplateidentitypropertiesuserassignedidentitiesadditionalproperties) - ## ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ImageTemplateProperties -### Properties -* **buildTimeoutInMinutes**: int: Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). -* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc -* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. -* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly): Describes the latest status of running an image template -* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly): Describes the error happened when create or update an image template -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): Provisioning state of the resource -* **source**: [ImageTemplateSource](#imagetemplatesource) (Required): Describes a virtual machine image source for building, customizing and distributing -* **vmProfile**: [ImageTemplateVmProfile](#imagetemplatevmprofile): Describes the virtual machine used to build, customize and capture images - ## ImageTemplateCustomizer * **Discriminator**: type @@ -102,6 +81,16 @@ ### Additional Properties * **Additional Properties Type**: string +## ImageTemplateIdentity +### Properties +* **type**: 'None' | 'UserAssigned': The type of identity used for the image template. The type 'None' will remove any identities from the image template. +* **userAssignedIdentities**: [ImageTemplateIdentityUserAssignedIdentities](#imagetemplateidentityuserassignedidentities): The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ImageTemplateIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsvrq145schemasimagetemplateidentitypropertiesuserassignedidentitiesadditionalproperties) + ## ImageTemplateLastRunStatus ### Properties * **endTime**: string: End time of the last run (UTC) @@ -110,10 +99,16 @@ * **runSubState**: 'Building' | 'Customizing' | 'Distributing' | 'Queued': Sub-state of the last run * **startTime**: string: Start time of the last run (UTC) -## ProvisioningError +## ImageTemplateProperties ### Properties -* **message**: string: Verbose error message about the provisioning failure -* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadISOSource' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSharedImageVersionSource' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure +* **buildTimeoutInMinutes**: int: Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). +* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc +* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. +* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly): Describes the latest status of running an image template +* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly): Describes the error happened when create or update an image template +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): Provisioning state of the resource +* **source**: [ImageTemplateSource](#imagetemplatesource) (Required): Describes a virtual machine image source for building, customizing and distributing +* **vmProfile**: [ImageTemplateVmProfile](#imagetemplatevmprofile): Describes the virtual machine used to build, customize and capture images ## ImageTemplateSource * **Discriminator**: type @@ -148,6 +143,11 @@ ### Properties * **vmSize**: string: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2). +## ProvisioningError +### Properties +* **message**: string: Verbose error message about the provisioning failure +* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadISOSource' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSharedImageVersionSource' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/imagebuilder/microsoft.virtualmachineimages/2020-02-14/types.md b/generated/imagebuilder/microsoft.virtualmachineimages/2020-02-14/types.md index 31d71f382d..af9ce5156a 100644 --- a/generated/imagebuilder/microsoft.virtualmachineimages/2020-02-14/types.md +++ b/generated/imagebuilder/microsoft.virtualmachineimages/2020-02-14/types.md @@ -12,32 +12,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.VirtualMachineImages/imageTemplates' (ReadOnly, DeployTimeConstant): The resource type -## ImageTemplateIdentity -### Properties -* **type**: 'None' | 'UserAssigned': The type of identity used for the image template. The type 'None' will remove any identities from the image template. -* **userAssignedIdentities**: [ImageTemplateIdentityUserAssignedIdentities](#imagetemplateidentityuserassignedidentities): The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ImageTemplateIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsvrq145schemasimagetemplateidentitypropertiesuserassignedidentitiesadditionalproperties) - ## ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ImageTemplateProperties -### Properties -* **buildTimeoutInMinutes**: int: Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). -* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc -* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. -* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly): Describes the latest status of running an image template -* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly): Describes the error happened when create or update an image template -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): Provisioning state of the resource -* **source**: [ImageTemplateSource](#imagetemplatesource) (Required): Describes a virtual machine image source for building, customizing and distributing -* **vmProfile**: [ImageTemplateVmProfile](#imagetemplatevmprofile): Describes the virtual machine used to build, customize and capture images - ## ImageTemplateCustomizer * **Discriminator**: type @@ -112,6 +91,16 @@ ### Additional Properties * **Additional Properties Type**: string +## ImageTemplateIdentity +### Properties +* **type**: 'None' | 'UserAssigned': The type of identity used for the image template. The type 'None' will remove any identities from the image template. +* **userAssignedIdentities**: [ImageTemplateIdentityUserAssignedIdentities](#imagetemplateidentityuserassignedidentities): The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ImageTemplateIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsvrq145schemasimagetemplateidentitypropertiesuserassignedidentitiesadditionalproperties) + ## ImageTemplateLastRunStatus ### Properties * **endTime**: string: End time of the last run (UTC) @@ -120,10 +109,16 @@ * **runSubState**: 'Building' | 'Customizing' | 'Distributing' | 'Queued': Sub-state of the last run * **startTime**: string: Start time of the last run (UTC) -## ProvisioningError +## ImageTemplateProperties ### Properties -* **message**: string: Verbose error message about the provisioning failure -* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSharedImageVersionSource' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure +* **buildTimeoutInMinutes**: int: Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). +* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc +* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. +* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly): Describes the latest status of running an image template +* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly): Describes the error happened when create or update an image template +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): Provisioning state of the resource +* **source**: [ImageTemplateSource](#imagetemplatesource) (Required): Describes a virtual machine image source for building, customizing and distributing +* **vmProfile**: [ImageTemplateVmProfile](#imagetemplatevmprofile): Describes the virtual machine used to build, customize and capture images ## ImageTemplateSource * **Discriminator**: type @@ -149,24 +144,29 @@ * **type**: 'SharedImageVersion' (Required): Specifies the type of source image you want to start with. -## PlatformImagePurchasePlan -### Properties -* **planName**: string (Required): Name of the purchase plan. -* **planProduct**: string (Required): Product of the purchase plan. -* **planPublisher**: string (Required): Publisher of the purchase plan. - ## ImageTemplateVmProfile ### Properties * **osDiskSizeGB**: int: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. * **vmSize**: string: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). * **vnetConfig**: [VirtualNetworkConfig](#virtualnetworkconfig): Virtual Network configuration. -## VirtualNetworkConfig +## PlatformImagePurchasePlan ### Properties -* **subnetId**: string: Resource id of a pre-existing subnet. +* **planName**: string (Required): Name of the purchase plan. +* **planProduct**: string (Required): Product of the purchase plan. +* **planPublisher**: string (Required): Publisher of the purchase plan. + +## ProvisioningError +### Properties +* **message**: string: Verbose error message about the provisioning failure +* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSharedImageVersionSource' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VirtualNetworkConfig +### Properties +* **subnetId**: string: Resource id of a pre-existing subnet. + diff --git a/generated/imagebuilder/microsoft.virtualmachineimages/2021-10-01/types.md b/generated/imagebuilder/microsoft.virtualmachineimages/2021-10-01/types.md index 40455c9d0f..3cd112b33d 100644 --- a/generated/imagebuilder/microsoft.virtualmachineimages/2021-10-01/types.md +++ b/generated/imagebuilder/microsoft.virtualmachineimages/2021-10-01/types.md @@ -13,32 +13,11 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.VirtualMachineImages/imageTemplates' (ReadOnly, DeployTimeConstant): The resource type -## ImageTemplateIdentity -### Properties -* **type**: 'None' | 'UserAssigned': The type of identity used for the image template. The type 'None' will remove any identities from the image template. -* **userAssignedIdentities**: [ImageTemplateIdentityUserAssignedIdentities](#imagetemplateidentityuserassignedidentities): The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## ImageTemplateIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsvrq145schemasimagetemplateidentitypropertiesuserassignedidentitiesadditionalproperties) - ## ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties * **clientId**: string (ReadOnly): The client id of user assigned identity. * **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ImageTemplateProperties -### Properties -* **buildTimeoutInMinutes**: int: Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). -* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc -* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. -* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly): Describes the latest status of running an image template -* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly): Describes the error happened when create or update an image template -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): Provisioning state of the resource -* **source**: [ImageTemplateSource](#imagetemplatesource) (Required): Describes a virtual machine image source for building, customizing and distributing -* **vmProfile**: [ImageTemplateVmProfile](#imagetemplatevmprofile): Describes the virtual machine used to build, customize and capture images - ## ImageTemplateCustomizer * **Discriminator**: type @@ -113,6 +92,16 @@ ### Additional Properties * **Additional Properties Type**: string +## ImageTemplateIdentity +### Properties +* **type**: 'None' | 'UserAssigned': The type of identity used for the image template. The type 'None' will remove any identities from the image template. +* **userAssignedIdentities**: [ImageTemplateIdentityUserAssignedIdentities](#imagetemplateidentityuserassignedidentities): The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## ImageTemplateIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties](#componentsvrq145schemasimagetemplateidentitypropertiesuserassignedidentitiesadditionalproperties) + ## ImageTemplateLastRunStatus ### Properties * **endTime**: string: End time of the last run (UTC) @@ -121,10 +110,16 @@ * **runSubState**: 'Building' | 'Customizing' | 'Distributing' | 'Queued': Sub-state of the last run * **startTime**: string: Start time of the last run (UTC) -## ProvisioningError +## ImageTemplateProperties ### Properties -* **message**: string: Verbose error message about the provisioning failure -* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSharedImageVersionSource' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure +* **buildTimeoutInMinutes**: int: Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours). +* **customize**: [ImageTemplateCustomizer](#imagetemplatecustomizer)[]: Specifies the properties used to describe the customization steps of the image, like Image source etc +* **distribute**: [ImageTemplateDistributor](#imagetemplatedistributor)[] (Required): The distribution targets where the image output needs to go to. +* **lastRunStatus**: [ImageTemplateLastRunStatus](#imagetemplatelastrunstatus) (ReadOnly): Describes the latest status of running an image template +* **provisioningError**: [ProvisioningError](#provisioningerror) (ReadOnly): Describes the error happened when create or update an image template +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): Provisioning state of the resource +* **source**: [ImageTemplateSource](#imagetemplatesource) (Required): Describes a virtual machine image source for building, customizing and distributing +* **vmProfile**: [ImageTemplateVmProfile](#imagetemplatevmprofile): Describes the virtual machine used to build, customize and capture images ## ImageTemplateSource * **Discriminator**: type @@ -151,12 +146,6 @@ * **type**: 'SharedImageVersion' (Required): Specifies the type of source image you want to start with. -## PlatformImagePurchasePlan -### Properties -* **planName**: string (Required): Name of the purchase plan. -* **planProduct**: string (Required): Product of the purchase plan. -* **planPublisher**: string (Required): Publisher of the purchase plan. - ## ImageTemplateVmProfile ### Properties * **osDiskSizeGB**: int: Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. @@ -164,10 +153,16 @@ * **vmSize**: string: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D2ds_v4). * **vnetConfig**: [VirtualNetworkConfig](#virtualnetworkconfig): Virtual Network configuration. -## VirtualNetworkConfig +## PlatformImagePurchasePlan ### Properties -* **proxyVmSize**: string: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). -* **subnetId**: string: Resource id of a pre-existing subnet. +* **planName**: string (Required): Name of the purchase plan. +* **planProduct**: string (Required): Product of the purchase plan. +* **planPublisher**: string (Required): Publisher of the purchase plan. + +## ProvisioningError +### Properties +* **message**: string: Verbose error message about the provisioning failure +* **provisioningErrorCode**: 'BadCustomizerType' | 'BadDistributeType' | 'BadManagedImageSource' | 'BadPIRSource' | 'BadSharedImageDistribute' | 'BadSharedImageVersionSource' | 'BadSourceType' | 'NoCustomizerScript' | 'Other' | 'ServerError' | 'UnsupportedCustomizerType' | string: Error code of the provisioning failure ## SystemData ### Properties @@ -183,3 +178,8 @@ ### Additional Properties * **Additional Properties Type**: string +## VirtualNetworkConfig +### Properties +* **proxyVmSize**: string: Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). +* **subnetId**: string: Resource id of a pre-existing subnet. + diff --git a/generated/index.json b/generated/index.json index df10817987..492039c558 100644 --- a/generated/index.json +++ b/generated/index.json @@ -1 +1 @@ -{"Resources":{"Microsoft.Addons/supportProviders/supportPlanTypes@2017-05-15":{"RelativePath":"addons/microsoft.addons/2017-05-15/types.json","Index":24},"Microsoft.Addons/supportProviders/supportPlanTypes@2018-03-01":{"RelativePath":"addons/microsoft.addons/2018-03-01/types.json","Index":24},"Microsoft.AutonomousDevelopmentPlatform/accounts@2020-07-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.json","Index":31},"Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools@2020-07-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.json","Index":45},"Microsoft.AutonomousDevelopmentPlatform/accounts@2021-02-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.json","Index":31},"Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools@2021-02-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.json","Index":46},"Microsoft.AutonomousDevelopmentPlatform/accounts@2021-11-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.json","Index":31},"Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools@2021-11-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.json","Index":57},"Microsoft.Advisor/recommendations/suppressions@2016-07-12-preview":{"RelativePath":"advisor/microsoft.advisor/2016-07-12-preview/types.json","Index":12},"Microsoft.Advisor/recommendations/suppressions@2017-03-31":{"RelativePath":"advisor/microsoft.advisor/2017-03-31/types.json","Index":12},"Microsoft.Advisor/recommendations/suppressions@2017-04-19":{"RelativePath":"advisor/microsoft.advisor/2017-04-19/types.json","Index":12},"Microsoft.Advisor/configurations@2020-01-01":{"RelativePath":"advisor/microsoft.advisor/2020-01-01/types.json","Index":31},"Microsoft.Advisor/recommendations/suppressions@2020-01-01":{"RelativePath":"advisor/microsoft.advisor/2020-01-01/types.json","Index":36},"Microsoft.AgFoodPlatform/farmBeats/extensions@2020-05-12-preview":{"RelativePath":"agfood/microsoft.agfoodplatform/2020-05-12-preview/types.json","Index":23},"Microsoft.AgFoodPlatform/farmBeats@2020-05-12-preview":{"RelativePath":"agfood/microsoft.agfoodplatform/2020-05-12-preview/types.json","Index":32},"microsoft.alertsManagement/smartDetectorAlertRules@2019-03-01":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2019-03-01/types.json","Index":29},"Microsoft.AlertsManagement/actionRules@2019-05-05-preview":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2019-05-05-preview/types.json","Index":45},"microsoft.alertsManagement/smartDetectorAlertRules@2019-06-01":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2019-06-01/types.json","Index":30},"microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2021-04-01/types.json","Index":39},"Microsoft.AlertsManagement/actionRules@2021-08-08-preview":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2021-08-08-preview/types.json","Index":71},"Microsoft.AlertsManagement/actionRules@2021-08-08":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2021-08-08/types.json","Index":71},"Microsoft.AnalysisServices/servers@2016-05-16":{"RelativePath":"analysisservices/microsoft.analysisservices/2016-05-16/types.json","Index":46},"Microsoft.AnalysisServices/servers@2017-07-14":{"RelativePath":"analysisservices/microsoft.analysisservices/2017-07-14/types.json","Index":47},"Microsoft.AnalysisServices/servers@2017-08-01":{"RelativePath":"analysisservices/microsoft.analysisservices/2017-08-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":25},"Microsoft.ApiManagement/service/apis/operations@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":40},"Microsoft.ApiManagement/service/subscriptions@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":51},"Microsoft.ApiManagement/service/products@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":58},"Microsoft.ApiManagement/service/products/apis@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":62},"Microsoft.ApiManagement/service/products/groups@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":66},"Microsoft.ApiManagement/service/groups@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":70},"Microsoft.ApiManagement/service/groups/users@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":74},"Microsoft.ApiManagement/service/certificates@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":78},"Microsoft.ApiManagement/service/users@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":87},"Microsoft.ApiManagement/service/authorizationServers@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":117},"Microsoft.ApiManagement/service/loggers@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":122},"Microsoft.ApiManagement/service/properties@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":127},"Microsoft.ApiManagement/service/openidConnectProviders@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":131},"Microsoft.ApiManagement/service/backends@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":135},"Microsoft.ApiManagement/service/identityProviders@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":146},"Microsoft.ApiManagement/service@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":179},"Microsoft.ApiManagement/service/apis@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":25},"Microsoft.ApiManagement/service/apis/operations@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":40},"Microsoft.ApiManagement/service/authorizationServers@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":70},"Microsoft.ApiManagement/service/backends@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":83},"Microsoft.ApiManagement/service/certificates@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":87},"Microsoft.ApiManagement/service@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":120},"Microsoft.ApiManagement/service/groups@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":124},"Microsoft.ApiManagement/service/groups/users@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":128},"Microsoft.ApiManagement/service/identityProviders@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":140},"Microsoft.ApiManagement/service/loggers@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":145},"Microsoft.ApiManagement/service/openidConnectProviders@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":149},"Microsoft.ApiManagement/service/products@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":156},"Microsoft.ApiManagement/service/products/apis@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":160},"Microsoft.ApiManagement/service/products/groups@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":164},"Microsoft.ApiManagement/service/properties@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":169},"Microsoft.ApiManagement/service/subscriptions@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":180},"Microsoft.ApiManagement/service/tenant@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":185},"Microsoft.ApiManagement/service/users@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":194},"Microsoft.ApiManagement/service/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":14},"Microsoft.ApiManagement/service/apis@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":43},"Microsoft.ApiManagement/service/apis/releases@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":48},"Microsoft.ApiManagement/service/apis/operations@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":66},"Microsoft.ApiManagement/service/apis/operations/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":72},"Microsoft.ApiManagement/service/apis/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":78},"Microsoft.ApiManagement/service/apis/schemas@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":84},"Microsoft.ApiManagement/service/apis/diagnostics@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":89},"Microsoft.ApiManagement/service/apis/diagnostics/loggers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/issues@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":104},"Microsoft.ApiManagement/service/apis/issues/comments@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":109},"Microsoft.ApiManagement/service/apis/issues/attachments@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":114},"Microsoft.ApiManagement/service/authorizationServers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":145},"Microsoft.ApiManagement/service/backends@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":168},"Microsoft.ApiManagement/service/certificates@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":173},"Microsoft.ApiManagement/service@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":211},"Microsoft.ApiManagement/service/diagnostics@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":215},"Microsoft.ApiManagement/service/diagnostics/loggers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":219},"Microsoft.ApiManagement/service/templates@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":241},"Microsoft.ApiManagement/service/groups@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":250},"Microsoft.ApiManagement/service/groups/users@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":254},"Microsoft.ApiManagement/service/identityProviders@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":274},"Microsoft.ApiManagement/service/loggers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":288},"Microsoft.ApiManagement/service/notifications@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":304},"Microsoft.ApiManagement/service/notifications/recipientUsers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":308},"Microsoft.ApiManagement/service/notifications/recipientEmails@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":312},"Microsoft.ApiManagement/service/openidConnectProviders@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":317},"Microsoft.ApiManagement/service/portalsettings@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":337},"Microsoft.ApiManagement/service/products@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":345},"Microsoft.ApiManagement/service/products/apis@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":349},"Microsoft.ApiManagement/service/products/groups@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":353},"Microsoft.ApiManagement/service/products/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":359},"Microsoft.ApiManagement/service/properties@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":365},"Microsoft.ApiManagement/service/subscriptions@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":377},"Microsoft.ApiManagement/service/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":382},"Microsoft.ApiManagement/service/apis/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":386},"Microsoft.ApiManagement/service/apis/operations/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":390},"Microsoft.ApiManagement/service/products/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":394},"Microsoft.ApiManagement/service/apis/tagDescriptions@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":399},"Microsoft.ApiManagement/service/users@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":421},"Microsoft.ApiManagement/service/api-version-sets@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":425},"Microsoft.ApiManagement/service/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":19},"Microsoft.ApiManagement/service/apis@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":55},"Microsoft.ApiManagement/service/apis/releases@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":60},"Microsoft.ApiManagement/service/apis/operations@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":78},"Microsoft.ApiManagement/service/apis/operations/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":84},"Microsoft.ApiManagement/service/apis/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":90},"Microsoft.ApiManagement/service/apis/schemas@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":96},"Microsoft.ApiManagement/service/apis/diagnostics@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":101},"Microsoft.ApiManagement/service/apis/diagnostics/loggers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/issues@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":116},"Microsoft.ApiManagement/service/apis/issues/comments@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":121},"Microsoft.ApiManagement/service/apis/issues/attachments@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":126},"Microsoft.ApiManagement/service/authorizationServers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":157},"Microsoft.ApiManagement/service/backends@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":180},"Microsoft.ApiManagement/service/certificates@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":185},"Microsoft.ApiManagement/service@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":225},"Microsoft.ApiManagement/service/diagnostics@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":229},"Microsoft.ApiManagement/service/diagnostics/loggers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":233},"Microsoft.ApiManagement/service/templates@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":255},"Microsoft.ApiManagement/service/groups@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":264},"Microsoft.ApiManagement/service/groups/users@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":268},"Microsoft.ApiManagement/service/identityProviders@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":288},"Microsoft.ApiManagement/service/loggers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":297},"Microsoft.ApiManagement/service/notifications@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":313},"Microsoft.ApiManagement/service/notifications/recipientUsers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":317},"Microsoft.ApiManagement/service/notifications/recipientEmails@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":321},"Microsoft.ApiManagement/service/openidConnectProviders@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":326},"Microsoft.ApiManagement/service/portalsettings@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":346},"Microsoft.ApiManagement/service/products@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":354},"Microsoft.ApiManagement/service/products/apis@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":358},"Microsoft.ApiManagement/service/products/groups@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":362},"Microsoft.ApiManagement/service/products/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":368},"Microsoft.ApiManagement/service/properties@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":374},"Microsoft.ApiManagement/service/subscriptions@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":386},"Microsoft.ApiManagement/service/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":391},"Microsoft.ApiManagement/service/apis/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":395},"Microsoft.ApiManagement/service/apis/operations/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":399},"Microsoft.ApiManagement/service/products/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":403},"Microsoft.ApiManagement/service/apis/tagDescriptions@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":408},"Microsoft.ApiManagement/service/users@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":429},"Microsoft.ApiManagement/service/api-version-sets@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":438},"Microsoft.ApiManagement/service/apis@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":46},"Microsoft.ApiManagement/service/apis/releases@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":51},"Microsoft.ApiManagement/service/apis/operations@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":69},"Microsoft.ApiManagement/service/apis/operations/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":81},"Microsoft.ApiManagement/service/apis/operations/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":86},"Microsoft.ApiManagement/service/apis/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":90},"Microsoft.ApiManagement/service/products/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":94},"Microsoft.ApiManagement/service/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":98},"Microsoft.ApiManagement/service/apis/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":104},"Microsoft.ApiManagement/service/apis/schemas@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":110},"Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":124},"Microsoft.ApiManagement/service/apis/issues@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":135},"Microsoft.ApiManagement/service/apis/issues/comments@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":140},"Microsoft.ApiManagement/service/apis/issues/attachments@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":145},"Microsoft.ApiManagement/service/apis/tagDescriptions@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":150},"Microsoft.ApiManagement/service/authorizationServers@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":181},"Microsoft.ApiManagement/service/backends@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":204},"Microsoft.ApiManagement/service/caches@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":209},"Microsoft.ApiManagement/service/certificates@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":214},"Microsoft.ApiManagement/service@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":255},"Microsoft.ApiManagement/service/diagnostics@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":259},"Microsoft.ApiManagement/service/templates@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":281},"Microsoft.ApiManagement/service/groups@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":290},"Microsoft.ApiManagement/service/groups/users@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":294},"Microsoft.ApiManagement/service/identityProviders@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":314},"Microsoft.ApiManagement/service/loggers@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":323},"Microsoft.ApiManagement/service/notifications@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":339},"Microsoft.ApiManagement/service/notifications/recipientUsers@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":343},"Microsoft.ApiManagement/service/notifications/recipientEmails@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":347},"Microsoft.ApiManagement/service/openidConnectProviders@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":352},"Microsoft.ApiManagement/service/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":358},"Microsoft.ApiManagement/service/portalsettings@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":378},"Microsoft.ApiManagement/service/products@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":386},"Microsoft.ApiManagement/service/products/apis@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":390},"Microsoft.ApiManagement/service/products/groups@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":394},"Microsoft.ApiManagement/service/products/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":400},"Microsoft.ApiManagement/service/properties@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":406},"Microsoft.ApiManagement/service/subscriptions@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":418},"Microsoft.ApiManagement/service/users@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":439},"Microsoft.ApiManagement/service/api-version-sets@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/apis@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":139},"Microsoft.ApiManagement/service/apis/issues@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":150},"Microsoft.ApiManagement/service/apis/issues/comments@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":155},"Microsoft.ApiManagement/service/apis/issues/attachments@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":160},"Microsoft.ApiManagement/service/apis/tagDescriptions@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":165},"Microsoft.ApiManagement/service/apiVersionSets@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":174},"Microsoft.ApiManagement/service/authorizationServers@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":205},"Microsoft.ApiManagement/service/backends@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":228},"Microsoft.ApiManagement/service/caches@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":233},"Microsoft.ApiManagement/service/certificates@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":238},"Microsoft.ApiManagement/service@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":280},"Microsoft.ApiManagement/service/diagnostics@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":284},"Microsoft.ApiManagement/service/templates@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":306},"Microsoft.ApiManagement/service/groups@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":315},"Microsoft.ApiManagement/service/groups/users@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":319},"Microsoft.ApiManagement/service/identityProviders@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":339},"Microsoft.ApiManagement/service/loggers@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":348},"Microsoft.ApiManagement/service/notifications@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":364},"Microsoft.ApiManagement/service/notifications/recipientUsers@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":368},"Microsoft.ApiManagement/service/notifications/recipientEmails@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":372},"Microsoft.ApiManagement/service/openidConnectProviders@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":377},"Microsoft.ApiManagement/service/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":383},"Microsoft.ApiManagement/service/portalsettings@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":403},"Microsoft.ApiManagement/service/products@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":411},"Microsoft.ApiManagement/service/products/apis@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":415},"Microsoft.ApiManagement/service/products/groups@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":419},"Microsoft.ApiManagement/service/products/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":425},"Microsoft.ApiManagement/service/properties@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":431},"Microsoft.ApiManagement/service/subscriptions@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":443},"Microsoft.ApiManagement/service/users@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":467},"Microsoft.ApiManagement/service/apis@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":139},"Microsoft.ApiManagement/service/apis/issues@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":150},"Microsoft.ApiManagement/service/apis/issues/comments@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":155},"Microsoft.ApiManagement/service/apis/issues/attachments@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":160},"Microsoft.ApiManagement/service/apis/tagDescriptions@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":165},"Microsoft.ApiManagement/service/apiVersionSets@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":174},"Microsoft.ApiManagement/service/authorizationServers@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":205},"Microsoft.ApiManagement/service/backends@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":228},"Microsoft.ApiManagement/service/caches@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":233},"Microsoft.ApiManagement/service/certificates@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":238},"Microsoft.ApiManagement/service@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":286},"Microsoft.ApiManagement/service/diagnostics@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":290},"Microsoft.ApiManagement/service/templates@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":312},"Microsoft.ApiManagement/service/gateways@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":318},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":323},"Microsoft.ApiManagement/service/gateways/apis@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":329},"Microsoft.ApiManagement/service/groups@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":338},"Microsoft.ApiManagement/service/groups/users@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":342},"Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":362},"Microsoft.ApiManagement/service/loggers@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/notifications@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":387},"Microsoft.ApiManagement/service/notifications/recipientUsers@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":391},"Microsoft.ApiManagement/service/notifications/recipientEmails@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":395},"Microsoft.ApiManagement/service/openidConnectProviders@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":400},"Microsoft.ApiManagement/service/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":406},"Microsoft.ApiManagement/service/portalsettings@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":426},"Microsoft.ApiManagement/service/products@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":434},"Microsoft.ApiManagement/service/products/apis@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":438},"Microsoft.ApiManagement/service/products/groups@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":442},"Microsoft.ApiManagement/service/products/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/namedValues@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":454},"Microsoft.ApiManagement/service/subscriptions@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":466},"Microsoft.ApiManagement/service/users@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":489},"Microsoft.ApiManagement/service/apis@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":139},"Microsoft.ApiManagement/service/apis/issues@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":150},"Microsoft.ApiManagement/service/apis/issues/comments@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":155},"Microsoft.ApiManagement/service/apis/issues/attachments@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":160},"Microsoft.ApiManagement/service/apis/tagDescriptions@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":165},"Microsoft.ApiManagement/service/apiVersionSets@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":174},"Microsoft.ApiManagement/service/authorizationServers@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":205},"Microsoft.ApiManagement/service/backends@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":228},"Microsoft.ApiManagement/service/caches@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":233},"Microsoft.ApiManagement/service/certificates@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":238},"Microsoft.ApiManagement/service/contentTypes@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":243},"Microsoft.ApiManagement/service/contentTypes/contentItems@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":248},"Microsoft.ApiManagement/service@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":296},"Microsoft.ApiManagement/service/diagnostics@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":300},"Microsoft.ApiManagement/service/templates@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":322},"Microsoft.ApiManagement/service/gateways@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":328},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":333},"Microsoft.ApiManagement/service/gateways/apis@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":339},"Microsoft.ApiManagement/service/groups@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":348},"Microsoft.ApiManagement/service/groups/users@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":352},"Microsoft.ApiManagement/service/identityProviders@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":372},"Microsoft.ApiManagement/service/loggers@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":381},"Microsoft.ApiManagement/service/namedValues@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":387},"Microsoft.ApiManagement/service/notifications@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":403},"Microsoft.ApiManagement/service/notifications/recipientUsers@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":407},"Microsoft.ApiManagement/service/notifications/recipientEmails@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":411},"Microsoft.ApiManagement/service/openidConnectProviders@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":416},"Microsoft.ApiManagement/service/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":422},"Microsoft.ApiManagement/service/portalsettings@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":442},"Microsoft.ApiManagement/service/products@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":450},"Microsoft.ApiManagement/service/products/apis@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":454},"Microsoft.ApiManagement/service/products/groups@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":458},"Microsoft.ApiManagement/service/products/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":464},"Microsoft.ApiManagement/service/subscriptions@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":476},"Microsoft.ApiManagement/service/users@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":500},"Microsoft.ApiManagement/service/apis@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":149},"Microsoft.ApiManagement/service/apis/issues@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":160},"Microsoft.ApiManagement/service/apis/issues/comments@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":165},"Microsoft.ApiManagement/service/apis/issues/attachments@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":170},"Microsoft.ApiManagement/service/apis/tagDescriptions@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":175},"Microsoft.ApiManagement/service/apiVersionSets@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":184},"Microsoft.ApiManagement/service/authorizationServers@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":215},"Microsoft.ApiManagement/service/backends@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":239},"Microsoft.ApiManagement/service/caches@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":244},"Microsoft.ApiManagement/service/certificates@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/contentTypes@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":256},"Microsoft.ApiManagement/service/contentTypes/contentItems@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":261},"Microsoft.ApiManagement/service@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":312},"Microsoft.ApiManagement/service/diagnostics@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":316},"Microsoft.ApiManagement/service/templates@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":338},"Microsoft.ApiManagement/service/gateways@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":344},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":349},"Microsoft.ApiManagement/service/gateways/apis@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":355},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":360},"Microsoft.ApiManagement/service/groups@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":369},"Microsoft.ApiManagement/service/groups/users@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":373},"Microsoft.ApiManagement/service/identityProviders@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":393},"Microsoft.ApiManagement/service/loggers@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":403},"Microsoft.ApiManagement/service/namedValues@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":409},"Microsoft.ApiManagement/service/notifications@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":425},"Microsoft.ApiManagement/service/notifications/recipientUsers@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":429},"Microsoft.ApiManagement/service/notifications/recipientEmails@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":433},"Microsoft.ApiManagement/service/openidConnectProviders@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":438},"Microsoft.ApiManagement/service/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":444},"Microsoft.ApiManagement/service/portalRevisions@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":454},"Microsoft.ApiManagement/service/portalsettings@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":474},"Microsoft.ApiManagement/service/products@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":482},"Microsoft.ApiManagement/service/products/apis@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":486},"Microsoft.ApiManagement/service/products/groups@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":490},"Microsoft.ApiManagement/service/products/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":496},"Microsoft.ApiManagement/service/subscriptions@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":508},"Microsoft.ApiManagement/service/tenant@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":516},"Microsoft.ApiManagement/service/users@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":540},"Microsoft.ApiManagement/service/apis@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":149},"Microsoft.ApiManagement/service/apis/issues@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":160},"Microsoft.ApiManagement/service/apis/issues/comments@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":165},"Microsoft.ApiManagement/service/apis/issues/attachments@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":170},"Microsoft.ApiManagement/service/apis/tagDescriptions@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":175},"Microsoft.ApiManagement/service/apiVersionSets@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":184},"Microsoft.ApiManagement/service/authorizationServers@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":215},"Microsoft.ApiManagement/service/backends@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":239},"Microsoft.ApiManagement/service/caches@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":244},"Microsoft.ApiManagement/service/certificates@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":251},"Microsoft.ApiManagement/service/contentTypes@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":256},"Microsoft.ApiManagement/service/contentTypes/contentItems@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":261},"Microsoft.ApiManagement/service@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":312},"Microsoft.ApiManagement/service/diagnostics@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":316},"Microsoft.ApiManagement/service/templates@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":338},"Microsoft.ApiManagement/service/gateways@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":344},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":349},"Microsoft.ApiManagement/service/gateways/apis@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":355},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":360},"Microsoft.ApiManagement/service/groups@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":369},"Microsoft.ApiManagement/service/groups/users@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":373},"Microsoft.ApiManagement/service/identityProviders@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":393},"Microsoft.ApiManagement/service/loggers@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":403},"Microsoft.ApiManagement/service/namedValues@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":409},"Microsoft.ApiManagement/service/notifications@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":425},"Microsoft.ApiManagement/service/notifications/recipientUsers@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":429},"Microsoft.ApiManagement/service/notifications/recipientEmails@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":433},"Microsoft.ApiManagement/service/openidConnectProviders@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":438},"Microsoft.ApiManagement/service/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":444},"Microsoft.ApiManagement/service/portalRevisions@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":454},"Microsoft.ApiManagement/service/portalsettings@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":474},"Microsoft.ApiManagement/service/products@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":482},"Microsoft.ApiManagement/service/products/apis@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":486},"Microsoft.ApiManagement/service/products/groups@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":490},"Microsoft.ApiManagement/service/products/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":496},"Microsoft.ApiManagement/service/subscriptions@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":508},"Microsoft.ApiManagement/service/tenant@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":516},"Microsoft.ApiManagement/service/users@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":540},"Microsoft.ApiManagement/service/apis@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":59},"Microsoft.ApiManagement/service/apis/releases@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":64},"Microsoft.ApiManagement/service/apis/operations@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":84},"Microsoft.ApiManagement/service/apis/operations/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":96},"Microsoft.ApiManagement/service/apis/operations/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":101},"Microsoft.ApiManagement/service/apis/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/products/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":109},"Microsoft.ApiManagement/service/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":113},"Microsoft.ApiManagement/service/apis/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":119},"Microsoft.ApiManagement/service/apis/schemas@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":124},"Microsoft.ApiManagement/service/apis/diagnostics@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":156},"Microsoft.ApiManagement/service/apis/issues@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":167},"Microsoft.ApiManagement/service/apis/issues/comments@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":177},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":182},"Microsoft.ApiManagement/service/apiVersionSets@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":191},"Microsoft.ApiManagement/service/authorizationServers@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":222},"Microsoft.ApiManagement/service/backends@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":246},"Microsoft.ApiManagement/service/caches@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/certificates@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":258},"Microsoft.ApiManagement/service/contentTypes@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":268},"Microsoft.ApiManagement/service@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":328},"Microsoft.ApiManagement/service/diagnostics@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":332},"Microsoft.ApiManagement/service/templates@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":354},"Microsoft.ApiManagement/service/gateways@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":360},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":365},"Microsoft.ApiManagement/service/gateways/apis@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":376},"Microsoft.ApiManagement/service/groups@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":385},"Microsoft.ApiManagement/service/groups/users@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":389},"Microsoft.ApiManagement/service/identityProviders@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":409},"Microsoft.ApiManagement/service/loggers@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":419},"Microsoft.ApiManagement/service/namedValues@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":425},"Microsoft.ApiManagement/service/notifications@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":441},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":445},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":449},"Microsoft.ApiManagement/service/openidConnectProviders@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":454},"Microsoft.ApiManagement/service/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":460},"Microsoft.ApiManagement/service/portalRevisions@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":470},"Microsoft.ApiManagement/service/portalsettings@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":490},"Microsoft.ApiManagement/service/products@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":498},"Microsoft.ApiManagement/service/products/apis@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":502},"Microsoft.ApiManagement/service/products/groups@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":506},"Microsoft.ApiManagement/service/products/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":512},"Microsoft.ApiManagement/service/subscriptions@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":524},"Microsoft.ApiManagement/service/tenant@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":532},"Microsoft.ApiManagement/service/users@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":556},"Microsoft.ApiManagement/service/apis@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":62},"Microsoft.ApiManagement/service/apis/releases@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":67},"Microsoft.ApiManagement/service/apis/operations@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":100},"Microsoft.ApiManagement/service/apis/operations/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":109},"Microsoft.ApiManagement/service/products/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":113},"Microsoft.ApiManagement/service/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":123},"Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":129},"Microsoft.ApiManagement/service/apis/diagnostics@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":161},"Microsoft.ApiManagement/service/apis/issues@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/comments@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":177},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":182},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":187},"Microsoft.ApiManagement/service/apiVersionSets@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":196},"Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":227},"Microsoft.ApiManagement/service/backends@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/caches@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":256},"Microsoft.ApiManagement/service/certificates@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":268},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":273},"Microsoft.ApiManagement/service@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":367},"Microsoft.ApiManagement/service/diagnostics@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/templates@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":393},"Microsoft.ApiManagement/service/gateways@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":399},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":404},"Microsoft.ApiManagement/service/gateways/apis@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":410},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":415},"Microsoft.ApiManagement/service/groups@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":424},"Microsoft.ApiManagement/service/groups/users@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":428},"Microsoft.ApiManagement/service/identityProviders@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/loggers@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":458},"Microsoft.ApiManagement/service/namedValues@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":464},"Microsoft.ApiManagement/service/notifications@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":480},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":484},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":488},"Microsoft.ApiManagement/service/openidConnectProviders@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":493},"Microsoft.ApiManagement/service/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":499},"Microsoft.ApiManagement/service/portalRevisions@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":509},"Microsoft.ApiManagement/service/portalsettings@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":529},"Microsoft.ApiManagement/service/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":540},"Microsoft.ApiManagement/service/products@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":548},"Microsoft.ApiManagement/service/products/apis@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":552},"Microsoft.ApiManagement/service/products/groups@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":556},"Microsoft.ApiManagement/service/products/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":562},"Microsoft.ApiManagement/service/schemas@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":570},"Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":582},"Microsoft.ApiManagement/service/tenant@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":590},"Microsoft.ApiManagement/service/users@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":614},"Microsoft.ApiManagement/service/apis@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":62},"Microsoft.ApiManagement/service/apis/releases@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":67},"Microsoft.ApiManagement/service/apis/operations@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":100},"Microsoft.ApiManagement/service/apis/operations/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":109},"Microsoft.ApiManagement/service/products/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":113},"Microsoft.ApiManagement/service/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":123},"Microsoft.ApiManagement/service/apis/schemas@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":129},"Microsoft.ApiManagement/service/apis/diagnostics@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":161},"Microsoft.ApiManagement/service/apis/issues@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/comments@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":177},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":182},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":187},"Microsoft.ApiManagement/service/apiVersionSets@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":196},"Microsoft.ApiManagement/service/authorizationServers@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":227},"Microsoft.ApiManagement/service/backends@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":251},"Microsoft.ApiManagement/service/caches@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":256},"Microsoft.ApiManagement/service/certificates@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":268},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":273},"Microsoft.ApiManagement/service@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":367},"Microsoft.ApiManagement/service/diagnostics@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":371},"Microsoft.ApiManagement/service/templates@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":393},"Microsoft.ApiManagement/service/gateways@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":399},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":404},"Microsoft.ApiManagement/service/gateways/apis@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":410},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":415},"Microsoft.ApiManagement/service/groups@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":424},"Microsoft.ApiManagement/service/groups/users@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":428},"Microsoft.ApiManagement/service/identityProviders@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":448},"Microsoft.ApiManagement/service/loggers@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":458},"Microsoft.ApiManagement/service/namedValues@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":464},"Microsoft.ApiManagement/service/notifications@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":480},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":484},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":488},"Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":493},"Microsoft.ApiManagement/service/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":499},"Microsoft.ApiManagement/service/portalRevisions@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":509},"Microsoft.ApiManagement/service/portalsettings@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":529},"Microsoft.ApiManagement/service/privateEndpointConnections@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":540},"Microsoft.ApiManagement/service/products@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":548},"Microsoft.ApiManagement/service/products/apis@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":552},"Microsoft.ApiManagement/service/products/groups@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":556},"Microsoft.ApiManagement/service/products/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":562},"Microsoft.ApiManagement/service/schemas@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":570},"Microsoft.ApiManagement/service/subscriptions@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":582},"Microsoft.ApiManagement/service/tenant@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":590},"Microsoft.ApiManagement/service/users@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":614},"Microsoft.ApiManagement/service/apis@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":62},"Microsoft.ApiManagement/service/apis/releases@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":67},"Microsoft.ApiManagement/service/apis/operations@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":100},"Microsoft.ApiManagement/service/apis/operations/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":109},"Microsoft.ApiManagement/service/products/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":113},"Microsoft.ApiManagement/service/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":123},"Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":129},"Microsoft.ApiManagement/service/apis/diagnostics@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":161},"Microsoft.ApiManagement/service/apis/issues@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/comments@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":177},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":182},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":187},"Microsoft.ApiManagement/service/apiVersionSets@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":196},"Microsoft.ApiManagement/service/authorizationServers@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":227},"Microsoft.ApiManagement/service/backends@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/caches@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":256},"Microsoft.ApiManagement/service/certificates@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":268},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":273},"Microsoft.ApiManagement/service@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":367},"Microsoft.ApiManagement/service/diagnostics@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/templates@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":393},"Microsoft.ApiManagement/service/gateways@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":399},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":404},"Microsoft.ApiManagement/service/gateways/apis@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":410},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":415},"Microsoft.ApiManagement/service/groups@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":424},"Microsoft.ApiManagement/service/groups/users@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":428},"Microsoft.ApiManagement/service/identityProviders@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/loggers@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":458},"Microsoft.ApiManagement/service/namedValues@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":464},"Microsoft.ApiManagement/service/notifications@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":480},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":484},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":488},"Microsoft.ApiManagement/service/openidConnectProviders@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":493},"Microsoft.ApiManagement/service/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":499},"Microsoft.ApiManagement/service/policyFragments@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":507},"Microsoft.ApiManagement/service/portalRevisions@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":517},"Microsoft.ApiManagement/service/portalsettings@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":537},"Microsoft.ApiManagement/service/portalconfigs@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":555},"Microsoft.ApiManagement/service/privateEndpointConnections@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":566},"Microsoft.ApiManagement/service/products@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":574},"Microsoft.ApiManagement/service/products/apis@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":578},"Microsoft.ApiManagement/service/products/groups@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":582},"Microsoft.ApiManagement/service/products/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":588},"Microsoft.ApiManagement/service/schemas@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":596},"Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":608},"Microsoft.ApiManagement/service/tenant@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":616},"Microsoft.ApiManagement/service/users@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":640},"Microsoft.App/containerApps@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":99},"Microsoft.App/managedEnvironments@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":119},"Microsoft.App/managedEnvironments/certificates@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":131},"Microsoft.App/containerApps/sourcecontrols@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":144},"Microsoft.App/managedEnvironments/daprComponents@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":153},"Microsoft.App/containerApps/authConfigs@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":219},"Microsoft.App/managedEnvironments/storages@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":228},"Microsoft.App/containerApps/authConfigs@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":84},"Microsoft.App/containerApps@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":165},"Microsoft.App/managedEnvironments/daprComponents@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":174},"Microsoft.App/managedEnvironments@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":194},"Microsoft.App/managedEnvironments/certificates@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":206},"Microsoft.App/managedEnvironments/storages@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":215},"Microsoft.App/containerApps/sourcecontrols@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":228},"Microsoft.AppConfiguration/configurationStores@2019-02-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.json","Index":20},"Microsoft.AppConfiguration/configurationStores@2019-10-01":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-10-01/types.json","Index":29},"Microsoft.AppConfiguration/configurationStores@2019-11-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":54},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2019-11-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":58},"Microsoft.AppConfiguration/configurationStores@2020-06-01":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":54},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2020-06-01":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":58},"Microsoft.AppConfiguration/configurationStores@2020-07-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":54},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2020-07-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":58},"Microsoft.AppConfiguration/configurationStores/keyValues@2020-07-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":64},"Microsoft.AppConfiguration/configurationStores@2021-03-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":65},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2021-03-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":69},"Microsoft.AppConfiguration/configurationStores/keyValues@2021-03-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":75},"Microsoft.AppConfiguration/configurationStores@2021-10-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":68},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2021-10-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":72},"Microsoft.AppConfiguration/configurationStores/keyValues@2021-10-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":78},"Microsoft.Insights/components/exportconfiguration@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":11},"Microsoft.Insights/components/ProactiveDetectionConfigs@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":17},"Microsoft.Insights/components/favorites@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":25},"Microsoft.Insights/webtests@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":40},"microsoft.insights/components/analyticsItems@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":54},"microsoft.insights/components/myanalyticsItems@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":67},"microsoft.insights/workbooks@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":80},"Microsoft.Insights/myWorkbooks@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":90},"Microsoft.Insights/components@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":109},"microsoft.insights/components/pricingPlans@2017-10-01":{"RelativePath":"applicationinsights/microsoft.insights/2017-10-01/types.json","Index":13},"Microsoft.Insights/components@2018-05-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-05-01-preview/types.json","Index":32},"Microsoft.Insights/components/ProactiveDetectionConfigs@2018-05-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-05-01-preview/types.json","Index":39},"Microsoft.Insights/webtests@2018-05-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-05-01-preview/types.json","Index":61},"microsoft.insights/workbooks@2018-06-17-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-06-17-preview/types.json","Index":17},"microsoft.insights/workbooktemplates@2019-10-17-preview":{"RelativePath":"applicationinsights/microsoft.insights/2019-10-17-preview/types.json","Index":19},"Microsoft.Insights/components@2020-02-02-preview":{"RelativePath":"applicationinsights/microsoft.insights/2020-02-02-preview/types.json","Index":32},"Microsoft.Insights/components@2020-02-02":{"RelativePath":"applicationinsights/microsoft.insights/2020-02-02/types.json","Index":32},"microsoft.insights/components/linkedStorageAccounts@2020-03-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2020-03-01-preview/types.json","Index":14},"Microsoft.Insights/webtests@2020-10-05-preview":{"RelativePath":"applicationinsights/microsoft.insights/2020-10-05-preview/types.json","Index":29},"Microsoft.Insights/myWorkbooks@2020-10-20":{"RelativePath":"applicationinsights/microsoft.insights/2020-10-20/types.json","Index":23},"Microsoft.Insights/workbooks@2020-10-20":{"RelativePath":"applicationinsights/microsoft.insights/2020-10-20/types.json","Index":39},"Microsoft.Insights/workbooktemplates@2020-11-20":{"RelativePath":"applicationinsights/microsoft.insights/2020-11-20/types.json","Index":19},"Microsoft.Insights/myWorkbooks@2021-03-08":{"RelativePath":"applicationinsights/microsoft.insights/2021-03-08/types.json","Index":34},"Microsoft.Insights/workbooks@2021-03-08":{"RelativePath":"applicationinsights/microsoft.insights/2021-03-08/types.json","Index":50},"Microsoft.Insights/workbooks@2021-08-01":{"RelativePath":"applicationinsights/microsoft.insights/2021-08-01/types.json","Index":36},"Microsoft.AppPlatform/Spring@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":34},"Microsoft.AppPlatform/Spring/configServers@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":54},"Microsoft.AppPlatform/Spring/monitoringSettings@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":65},"Microsoft.AppPlatform/Spring/apps@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":83},"Microsoft.AppPlatform/Spring/apps/bindings@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":89},"Microsoft.AppPlatform/Spring/certificates@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":95},"Microsoft.AppPlatform/Spring/apps/domains@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":100},"Microsoft.AppPlatform/Spring/apps/deployments@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":131},"Microsoft.AppPlatform/Spring@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":34},"Microsoft.AppPlatform/Spring/configServers@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":54},"Microsoft.AppPlatform/Spring/monitoringSettings@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":66},"Microsoft.AppPlatform/Spring/apps@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":84},"Microsoft.AppPlatform/Spring/apps/bindings@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/certificates@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":96},"Microsoft.AppPlatform/Spring/apps/domains@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":101},"Microsoft.AppPlatform/Spring/apps/deployments@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":132},"Microsoft.AppPlatform/Spring@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":34},"Microsoft.AppPlatform/Spring/configServers@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":54},"Microsoft.AppPlatform/Spring/monitoringSettings@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":66},"Microsoft.AppPlatform/Spring/apps@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":84},"Microsoft.AppPlatform/Spring/apps/bindings@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/certificates@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":96},"Microsoft.AppPlatform/Spring/apps/domains@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":101},"Microsoft.AppPlatform/Spring/apps/deployments@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":138},"Microsoft.AppPlatform/Spring@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":39},"Microsoft.AppPlatform/Spring/configServers@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":59},"Microsoft.AppPlatform/Spring/monitoringSettings@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":71},"Microsoft.AppPlatform/Spring/apps@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":97},"Microsoft.AppPlatform/Spring/apps/bindings@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":103},"Microsoft.AppPlatform/Spring/storages@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":121},"Microsoft.AppPlatform/Spring/certificates@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":131},"Microsoft.AppPlatform/Spring/apps/domains@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":136},"Microsoft.AppPlatform/Spring/apps/deployments@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":174},"Microsoft.AppPlatform/Spring@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":50},"Microsoft.AppPlatform/Spring/configServers@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":70},"Microsoft.AppPlatform/Spring/configurationServices@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/serviceRegistries@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":104},"Microsoft.AppPlatform/Spring/buildServices/builds@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":117},"Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":138},"Microsoft.AppPlatform/Spring/buildServices/builders@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":154},"Microsoft.AppPlatform/Spring/buildServices/agentPools@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":160},"Microsoft.AppPlatform/Spring/monitoringSettings@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":172},"Microsoft.AppPlatform/Spring/apps@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":201},"Microsoft.AppPlatform/Spring/apps/bindings@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":207},"Microsoft.AppPlatform/Spring/storages@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":214},"Microsoft.AppPlatform/Spring/certificates@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":224},"Microsoft.AppPlatform/Spring/apps/domains@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":229},"Microsoft.AppPlatform/Spring/apps/deployments@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":265},"Microsoft.AppPlatform/Spring/gateways@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":290},"Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":306},"Microsoft.AppPlatform/Spring/gateways/domains@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":311},"Microsoft.AppPlatform/Spring/apiPortals@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":327},"Microsoft.AppPlatform/Spring/apiPortals/domains@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":332},"Microsoft.AppPlatform/Spring@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":50},"Microsoft.AppPlatform/Spring/configServers@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":70},"Microsoft.AppPlatform/Spring/configurationServices@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/serviceRegistries@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":104},"Microsoft.AppPlatform/Spring/buildServices/builds@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":117},"Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":138},"Microsoft.AppPlatform/Spring/buildServices/builders@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":154},"Microsoft.AppPlatform/Spring/buildServices/agentPools@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":160},"Microsoft.AppPlatform/Spring/monitoringSettings@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":172},"Microsoft.AppPlatform/Spring/apps@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":203},"Microsoft.AppPlatform/Spring/apps/bindings@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":209},"Microsoft.AppPlatform/Spring/storages@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":216},"Microsoft.AppPlatform/Spring/certificates@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":226},"Microsoft.AppPlatform/Spring/apps/domains@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":231},"Microsoft.AppPlatform/Spring/apps/deployments@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":267},"Microsoft.AppPlatform/Spring/gateways@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":292},"Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":308},"Microsoft.AppPlatform/Spring/gateways/domains@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":313},"Microsoft.AppPlatform/Spring/apiPortals@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":329},"Microsoft.AppPlatform/Spring/apiPortals/domains@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":334},"Microsoft.Attestation/attestationProviders@2018-09-01-preview":{"RelativePath":"attestation/microsoft.attestation/2018-09-01-preview/types.json","Index":21},"Microsoft.Attestation/attestationProviders@2020-10-01":{"RelativePath":"attestation/microsoft.attestation/2020-10-01/types.json","Index":46},"Microsoft.Attestation/attestationProviders/privateEndpointConnections@2020-10-01":{"RelativePath":"attestation/microsoft.attestation/2020-10-01/types.json","Index":50},"Microsoft.Attestation/attestationProviders@2021-06-01-preview":{"RelativePath":"attestation/microsoft.attestation/2021-06-01-preview/types.json","Index":49},"Microsoft.Attestation/attestationProviders/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"attestation/microsoft.attestation/2021-06-01-preview/types.json","Index":53},"Microsoft.Authorization/roleDefinitions@2015-07-01":{"RelativePath":"authorization/microsoft.authorization/2015-07-01/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2015-07-01":{"RelativePath":"authorization/microsoft.authorization/2015-07-01/types.json","Index":22},"Microsoft.Authorization/roleAssignments@2017-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2017-10-01-preview/types.json","Index":12},"Microsoft.Authorization/roleDefinitions@2018-01-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-01-01-preview/types.json","Index":19},"Microsoft.Authorization/roleAssignments@2018-01-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-01-01-preview/types.json","Index":24},"Microsoft.Authorization/accessReviewScheduleDefinitions@2018-05-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-05-01-preview/types.json","Index":89},"Microsoft.Authorization/accessReviewScheduleSettings@2018-05-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-05-01-preview/types.json","Index":98},"Microsoft.Authorization/roleAssignments@2018-09-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-09-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-03-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-03-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-04-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-04-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-08-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-08-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":18},"Microsoft.Authorization/roleAssignmentScheduleRequests@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":73},"Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":124},"Microsoft.Authorization/roleManagementPolicyAssignments@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":134},"Microsoft.Authorization/roleAssignmentScheduleRequests@2020-10-01":{"RelativePath":"authorization/microsoft.authorization/2020-10-01/types.json","Index":62},"Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01":{"RelativePath":"authorization/microsoft.authorization/2020-10-01/types.json","Index":113},"Microsoft.Authorization/roleManagementPolicyAssignments@2020-10-01":{"RelativePath":"authorization/microsoft.authorization/2020-10-01/types.json","Index":170},"Microsoft.Authorization/roleAssignmentApprovals/stages@2021-01-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-01-01-preview/types.json","Index":42},"Microsoft.Authorization/accessReviewScheduleDefinitions@2021-03-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-03-01-preview/types.json","Index":95},"Microsoft.Authorization/accessReviewScheduleSettings@2021-03-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-03-01-preview/types.json","Index":104},"Microsoft.Authorization/accessReviewScheduleDefinitions@2021-07-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-07-01-preview/types.json","Index":103},"Microsoft.Authorization/accessReviewScheduleDefinitions/instances@2021-07-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-07-01-preview/types.json","Index":125},"Microsoft.Authorization/accessReviewScheduleSettings@2021-07-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-07-01-preview/types.json","Index":134},"Microsoft.Authorization/accessReviewHistoryDefinitions@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":71},"Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":144},"Microsoft.Authorization/accessReviewScheduleDefinitions/instances@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":166},"Microsoft.Authorization/accessReviewScheduleSettings@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":175},"Microsoft.Authorization/roleAssignmentScheduleRequests@2022-04-01-preview":{"RelativePath":"authorization/microsoft.authorization/2022-04-01-preview/types.json","Index":62},"Microsoft.Authorization/roleEligibilityScheduleRequests@2022-04-01-preview":{"RelativePath":"authorization/microsoft.authorization/2022-04-01-preview/types.json","Index":113},"Microsoft.Automanage/accounts@2020-06-30-preview":{"RelativePath":"automanage/microsoft.automanage/2020-06-30-preview/types.json","Index":16},"Microsoft.Automanage/configurationProfileAssignments@2020-06-30-preview":{"RelativePath":"automanage/microsoft.automanage/2020-06-30-preview/types.json","Index":33},"Microsoft.Automanage/configurationProfilePreferences@2020-06-30-preview":{"RelativePath":"automanage/microsoft.automanage/2020-06-30-preview/types.json","Index":50},"Microsoft.Automanage/configurationProfiles@2021-04-30-preview":{"RelativePath":"automanage/microsoft.automanage/2021-04-30-preview/types.json","Index":25},"Microsoft.Automanage/configurationProfiles/versions@2021-04-30-preview":{"RelativePath":"automanage/microsoft.automanage/2021-04-30-preview/types.json","Index":30},"Microsoft.Automanage/configurationProfileAssignments@2021-04-30-preview":{"RelativePath":"automanage/microsoft.automanage/2021-04-30-preview/types.json","Index":36},"Microsoft.Automation/automationAccounts@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":21},"Microsoft.Automation/automationAccounts/certificates@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":26},"Microsoft.Automation/automationAccounts/connections@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":33},"Microsoft.Automation/automationAccounts/connectionTypes@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":40},"Microsoft.Automation/automationAccounts/credentials@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":45},"Microsoft.Automation/automationAccounts/compilationjobs@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":72},"Microsoft.Automation/automationAccounts/configurations@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":90},"Microsoft.Automation/automationAccounts/nodeConfigurations@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":94},"Microsoft.Automation/automationAccounts/jobs@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":121},"Microsoft.Automation/automationAccounts/jobSchedules@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":127},"Microsoft.Automation/automationAccounts/modules@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":152},"Microsoft.Automation/automationAccounts/runbooks/draft@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":163},"Microsoft.Automation/automationAccounts/runbooks@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":187},"Microsoft.Automation/automationAccounts/schedules@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":212},"Microsoft.Automation/automationAccounts/variables@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":217},"Microsoft.Automation/automationAccounts/watchers@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":224},"Microsoft.Automation/automationAccounts/webhooks@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":230},"Microsoft.Automation/automationAccounts/softwareUpdateConfigurations@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":77},"Microsoft.Automation/automationAccounts/sourceControls@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":90},"Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":102},"Microsoft.Automation/automationAccounts/jobs@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":128},"Microsoft.Automation/automationAccounts/compilationjobs@2018-01-15":{"RelativePath":"automation/microsoft.automation/2018-01-15/types.json","Index":34},"Microsoft.Automation/automationAccounts/nodeConfigurations@2018-01-15":{"RelativePath":"automation/microsoft.automation/2018-01-15/types.json","Index":45},"Microsoft.Automation/automationAccounts/runbooks/draft@2018-06-30":{"RelativePath":"automation/microsoft.automation/2018-06-30/types.json","Index":18},"Microsoft.Automation/automationAccounts/runbooks@2018-06-30":{"RelativePath":"automation/microsoft.automation/2018-06-30/types.json","Index":44},"Microsoft.Automation/automationAccounts/python2Packages@2018-06-30":{"RelativePath":"automation/microsoft.automation/2018-06-30/types.json","Index":68},"Microsoft.Automation/automationAccounts/runbooks/draft@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":18},"Microsoft.Automation/automationAccounts/runbooks@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":44},"Microsoft.Automation/automationAccounts/python2Packages@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":68},"Microsoft.Automation/automationAccounts/compilationjobs@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":95},"Microsoft.Automation/automationAccounts/nodeConfigurations@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":105},"Microsoft.Automation/automationAccounts/sourceControls@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":118},"Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":130},"Microsoft.Automation/automationAccounts/jobs@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":156},"Microsoft.Automation/automationAccounts@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":170},"Microsoft.Automation/automationAccounts/certificates@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":175},"Microsoft.Automation/automationAccounts/connections@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":182},"Microsoft.Automation/automationAccounts/connectionTypes@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":189},"Microsoft.Automation/automationAccounts/credentials@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":194},"Microsoft.Automation/automationAccounts/configurations@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":207},"Microsoft.Automation/automationAccounts/softwareUpdateConfigurations@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":277},"Microsoft.Automation/automationAccounts/jobSchedules@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":284},"Microsoft.Automation/automationAccounts/modules@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":307},"Microsoft.Automation/automationAccounts/schedules@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":319},"Microsoft.Automation/automationAccounts/variables@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":324},"Microsoft.Automation/automationAccounts/watchers@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":331},"Microsoft.Automation/automationAccounts/privateEndpointConnections@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":15},"Microsoft.Automation/automationAccounts/python2Packages@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":41},"Microsoft.Automation/automationAccounts/nodeConfigurations@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":52},"Microsoft.Automation/automationAccounts/compilationjobs@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":78},"Microsoft.Automation/automationAccounts/sourceControls@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":91},"Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":103},"Microsoft.Automation/automationAccounts@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":133},"Microsoft.Automation/automationAccounts/certificates@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":138},"Microsoft.Automation/automationAccounts/connections@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":145},"Microsoft.Automation/automationAccounts/connectionTypes@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":152},"Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":157},"Microsoft.Automation/automationAccounts/jobSchedules@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":165},"Microsoft.Automation/automationAccounts/modules@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":188},"Microsoft.Automation/automationAccounts/schedules@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":213},"Microsoft.Automation/automationAccounts/variables@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":218},"Microsoft.Automation/automationAccounts/watchers@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":225},"Microsoft.Automation/automationAccounts@2021-06-22":{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":52},"Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22":{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":62},"Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2021-06-22":{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":70},"Microsoft.Kusto/clusters@2018-09-07-preview":{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":42},"Microsoft.Kusto/clusters/databases@2018-09-07-preview":{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":55},"Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview":{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":64},"Microsoft.Kusto/clusters@2019-01-21":{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":48},"Microsoft.Kusto/clusters/databases@2019-01-21":{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":60},"Microsoft.Kusto/clusters/databases/dataConnections@2019-01-21":{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":94},"Microsoft.Kusto/clusters@2019-05-15":{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":52},"Microsoft.Kusto/clusters/databases@2019-05-15":{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":65},"Microsoft.Kusto/clusters/databases/dataConnections@2019-05-15":{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":119},"Microsoft.Kusto/clusters@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":59},"Microsoft.Kusto/clusters/databases@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":88},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":105},"Microsoft.Kusto/clusters/databases/dataConnections@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":159},"Microsoft.Kusto/clusters@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":59},"Microsoft.Kusto/clusters/principalAssignments@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":78},"Microsoft.Kusto/clusters/databases@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":107},"Microsoft.Kusto/clusters/databases/principalAssignments@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":130},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":147},"Microsoft.Kusto/clusters/databases/dataConnections@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":210},"Microsoft.Kusto/clusters@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":74},"Microsoft.Kusto/clusters/principalAssignments@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":93},"Microsoft.Kusto/clusters/databases@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":122},"Microsoft.Kusto/clusters/databases/principalAssignments@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":145},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":162},"Microsoft.Kusto/clusters/databases/dataConnections@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":225},"Microsoft.Kusto/clusters@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":74},"Microsoft.Kusto/clusters/principalAssignments@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":93},"Microsoft.Kusto/clusters/databases@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":122},"Microsoft.Kusto/clusters/databases/principalAssignments@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":145},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":162},"Microsoft.Kusto/clusters/databases/dataConnections@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":234},"Microsoft.Kusto/clusters@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":80},"Microsoft.Kusto/clusters/principalAssignments@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":99},"Microsoft.Kusto/clusters/databases@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":128},"Microsoft.Kusto/clusters/databases/principalAssignments@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":151},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":168},"Microsoft.Kusto/clusters/databases/dataConnections@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":261},"Microsoft.Kusto/clusters@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":83},"Microsoft.Kusto/clusters/principalAssignments@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":102},"Microsoft.Kusto/clusters/databases@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":131},"Microsoft.Kusto/clusters/databases/principalAssignments@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":154},"Microsoft.Kusto/clusters/databases/scripts@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":177},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":201},"Microsoft.Kusto/clusters/databases/dataConnections@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":294},"Microsoft.Kusto/clusters@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":104},"Microsoft.Kusto/clusters/principalAssignments@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":123},"Microsoft.Kusto/clusters/databases@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":152},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":176},"Microsoft.Kusto/clusters/managedPrivateEndpoints@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":188},"Microsoft.Kusto/clusters/databases/principalAssignments@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":211},"Microsoft.Kusto/clusters/databases/scripts@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":223},"Microsoft.Kusto/clusters/privateEndpointConnections@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":230},"Microsoft.Kusto/clusters/databases/dataConnections@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":323},"Microsoft.Kusto/clusters@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":131},"Microsoft.Kusto/clusters/principalAssignments@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":150},"Microsoft.Kusto/clusters/databases@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":179},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":203},"Microsoft.Kusto/clusters/managedPrivateEndpoints@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":215},"Microsoft.Kusto/clusters/databases/principalAssignments@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":238},"Microsoft.Kusto/clusters/databases/scripts@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":250},"Microsoft.Kusto/clusters/privateEndpointConnections@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":254},"Microsoft.Kusto/clusters/databases/dataConnections@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":356},"microsoft.aadiam/diagnosticSettings@2017-04-01-preview":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2017-04-01-preview/types.json","Index":18},"microsoft.aadiam/diagnosticSettings@2017-04-01":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2017-04-01/types.json","Index":18},"microsoft.aadiam/privateLinkForAzureAd@2020-03-01-preview":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-03-01-preview/types.json","Index":13},"microsoft.aadiam/privateLinkForAzureAd@2020-03-01":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-03-01/types.json","Index":13},"microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections@2020-03-01":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-03-01/types.json","Index":31},"microsoft.aadiam/azureADMetrics@2020-07-01-preview":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-07-01-preview/types.json","Index":17},"Microsoft.AzureArcData/sqlManagedInstances@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":32},"Microsoft.AzureArcData/sqlServerInstances@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":38},"Microsoft.AzureArcData/postgresInstances@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":46},"Microsoft.AzureArcData/dataControllers@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":56},"Microsoft.AzureArcData/sqlManagedInstances@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":37},"Microsoft.AzureArcData/sqlServerInstances@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":43},"Microsoft.AzureArcData/postgresInstances@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":51},"Microsoft.AzureArcData/dataControllers@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":68},"Microsoft.AzureArcData/sqlManagedInstances@2021-08-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-08-01/types.json","Index":44},"Microsoft.AzureArcData/sqlServerInstances@2021-08-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-08-01/types.json","Index":74},"Microsoft.AzureArcData/dataControllers@2021-08-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-08-01/types.json","Index":91},"Microsoft.AzureArcData/sqlManagedInstances@2021-11-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-11-01/types.json","Index":45},"Microsoft.AzureArcData/sqlServerInstances@2021-11-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-11-01/types.json","Index":75},"Microsoft.AzureArcData/dataControllers@2021-11-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-11-01/types.json","Index":92},"Microsoft.AzureArcData/sqlManagedInstances@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":46},"Microsoft.AzureArcData/sqlServerInstances@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":87},"Microsoft.AzureArcData/dataControllers@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":104},"Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":120},"Microsoft.AzureArcData/postgresInstances@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":128},"Microsoft.AzureData/sqlServerRegistrations@2019-07-24-preview":{"RelativePath":"azuredata/microsoft.azuredata/2019-07-24-preview/types.json","Index":24},"Microsoft.AzureData/sqlServerRegistrations/sqlServers@2019-07-24-preview":{"RelativePath":"azuredata/microsoft.azuredata/2019-07-24-preview/types.json","Index":29},"Microsoft.AzureStack/registrations@2016-01-01":{"RelativePath":"azurestack/microsoft.azurestack/2016-01-01/types.json","Index":15},"Microsoft.AzureStack/registrations@2017-06-01":{"RelativePath":"azurestack/microsoft.azurestack/2017-06-01/types.json","Index":15},"Microsoft.AzureStack/registrations/customerSubscriptions@2017-06-01":{"RelativePath":"azurestack/microsoft.azurestack/2017-06-01/types.json","Index":20},"Microsoft.AzureStack/registrations/customerSubscriptions@2020-06-01-preview":{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":23},"Microsoft.AzureStack/registrations@2020-06-01-preview":{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":31},"Microsoft.AzureStack/linkedSubscriptions@2020-06-01-preview":{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":39},"Microsoft.AzureStackHCI/clusters@2020-03-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2020-03-01-preview/types.json","Index":28},"Microsoft.AzureStackHCI/clusters@2020-10-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2020-10-01/types.json","Index":39},"Microsoft.AzureStackHCI/clusters/arcSettings@2021-01-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2021-01-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.json","Index":81},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2021-01-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.json","Index":124},"Microsoft.AzureStackHCI/clusters/arcSettings@2021-09-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-09-01/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2021-09-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-09-01/types.json","Index":99},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2021-09-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-09-01/types.json","Index":142},"Microsoft.AzureStackHCI/clusters/arcSettings@2022-01-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-01-01/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2022-01-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-01-01/types.json","Index":99},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2022-01-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-01-01/types.json","Index":142},"Microsoft.AzureStackHCI/clusters/arcSettings@2022-03-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-03-01/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2022-03-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-03-01/types.json","Index":99},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2022-03-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-03-01/types.json","Index":142},"Microsoft.Batch/batchAccounts@2015-12-01":{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":21},"Microsoft.Batch/batchAccounts/applications/versions@2015-12-01":{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":29},"Microsoft.Batch/batchAccounts/applications@2015-12-01":{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":39},"Microsoft.Batch/batchAccounts@2017-01-01":{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2017-01-01":{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2017-01-01":{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":43},"Microsoft.Batch/batchAccounts@2017-05-01":{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2017-05-01":{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2017-05-01":{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":43},"Microsoft.Batch/batchAccounts@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":43},"Microsoft.Batch/batchAccounts/certificates@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":61},"Microsoft.Batch/batchAccounts/pools@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":165},"Microsoft.Batch/batchAccounts@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":38},"Microsoft.Batch/batchAccounts/certificates@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":56},"Microsoft.Batch/batchAccounts/pools@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":165},"Microsoft.Batch/batchAccounts@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":27},"Microsoft.Batch/batchAccounts/applications/versions@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":35},"Microsoft.Batch/batchAccounts/applications@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":40},"Microsoft.Batch/batchAccounts/certificates@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":58},"Microsoft.Batch/batchAccounts/pools@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":167},"Microsoft.Batch/batchAccounts@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":27},"Microsoft.Batch/batchAccounts/applications/versions@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":35},"Microsoft.Batch/batchAccounts/applications@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":40},"Microsoft.Batch/batchAccounts/certificates@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":58},"Microsoft.Batch/batchAccounts/pools@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":178},"Microsoft.Batch/batchAccounts@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":49},"Microsoft.Batch/batchAccounts/applications/versions@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":57},"Microsoft.Batch/batchAccounts/applications@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":62},"Microsoft.Batch/batchAccounts/certificates@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":80},"Microsoft.Batch/batchAccounts/pools@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":210},"Microsoft.Batch/batchAccounts@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":53},"Microsoft.Batch/batchAccounts/applications/versions@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":61},"Microsoft.Batch/batchAccounts/applications@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":66},"Microsoft.Batch/batchAccounts/certificates@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":84},"Microsoft.Batch/batchAccounts/pools@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":214},"Microsoft.Batch/batchAccounts@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":53},"Microsoft.Batch/batchAccounts/applications/versions@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":61},"Microsoft.Batch/batchAccounts/applications@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":66},"Microsoft.Batch/batchAccounts/certificates@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":84},"Microsoft.Batch/batchAccounts/pools@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":214},"Microsoft.Batch/batchAccounts@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":56},"Microsoft.Batch/batchAccounts/applications/versions@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":64},"Microsoft.Batch/batchAccounts/applications@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":69},"Microsoft.Batch/batchAccounts/certificates@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":87},"Microsoft.Batch/batchAccounts/pools@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":230},"Microsoft.Batch/batchAccounts@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":65},"Microsoft.Batch/batchAccounts/applications/versions@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":73},"Microsoft.Batch/batchAccounts/applications@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":78},"Microsoft.Batch/batchAccounts/certificates@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":96},"Microsoft.Batch/batchAccounts/pools@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":241},"Microsoft.Batch/batchAccounts@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":65},"Microsoft.Batch/batchAccounts/applications/versions@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":73},"Microsoft.Batch/batchAccounts/applications@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":78},"Microsoft.Batch/batchAccounts/certificates@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":96},"Microsoft.Batch/batchAccounts/pools@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":244},"Microsoft.BatchAI/clusters@2017-09-01-preview":{"RelativePath":"batchai/microsoft.batchai/2017-09-01-preview/types.json","Index":56},"Microsoft.BatchAI/jobs@2017-09-01-preview":{"RelativePath":"batchai/microsoft.batchai/2017-09-01-preview/types.json","Index":103},"Microsoft.BatchAI/fileServers@2017-09-01-preview":{"RelativePath":"batchai/microsoft.batchai/2017-09-01-preview/types.json","Index":129},"Microsoft.BatchAI/clusters@2018-03-01":{"RelativePath":"batchai/microsoft.batchai/2018-03-01/types.json","Index":60},"Microsoft.BatchAI/jobs@2018-03-01":{"RelativePath":"batchai/microsoft.batchai/2018-03-01/types.json","Index":109},"Microsoft.BatchAI/fileServers@2018-03-01":{"RelativePath":"batchai/microsoft.batchai/2018-03-01/types.json","Index":135},"Microsoft.BatchAI/workspaces@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":18},"Microsoft.BatchAI/workspaces/experiments@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":28},"Microsoft.BatchAI/workspaces/experiments/jobs@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":96},"Microsoft.BatchAI/workspaces/fileServers@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":112},"Microsoft.BatchAI/workspaces/clusters@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":145},"Microsoft.Billing/billingAccounts/billingProfiles@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":20},"Microsoft.Billing/billingAccounts/invoiceSections@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":24},"Microsoft.Billing/billingAccounts/billingProfiles/policies@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":30},"Microsoft.Billing/billingAccounts/lineOfCredit@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":40},"Microsoft.Billing/billingAccounts/billingProfiles/instructions@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":12},"Microsoft.Billing/billingAccounts/billingProfiles@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":53},"Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":57},"Microsoft.Billing/billingAccounts/billingProfiles/policies@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":73},"Microsoft.Billing/billingAccounts/customers/policies@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":82},"Microsoft.Billing/billingAccounts/billingRoleAssignments@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":87},"Microsoft.Billing/billingAccounts/departments/billingRoleAssignments@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":91},"Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":95},"Microsoft.Billing/billingAccounts/billingProfiles/instructions@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":12},"Microsoft.Billing/billingAccounts/billingProfiles@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":56},"Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":60},"Microsoft.Billing/billingAccounts/billingProfiles/policies@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":76},"Microsoft.Billing/billingAccounts/customers/policies@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":85},"Microsoft.Billing/promotions@2020-09-01-preview":{"RelativePath":"billing/microsoft.billing/2020-09-01-preview/types.json","Index":14},"Microsoft.Billing/promotions@2020-11-01-preview":{"RelativePath":"billing/microsoft.billing/2020-11-01-preview/types.json","Index":14},"Microsoft.Billing/billingAccounts/billingSubscriptionAliases@2021-10-01":{"RelativePath":"billing/microsoft.billing/2021-10-01/types.json","Index":40},"Microsoft.Blockchain/blockchainMembers@2018-06-01-preview":{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":29},"Microsoft.Blockchain/blockchainMembers/transactionNodes@2018-06-01-preview":{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":41},"Microsoft.Blueprint/blueprints@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":31},"Microsoft.Blueprint/blueprints/artifacts@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":50},"Microsoft.Blueprint/blueprints/versions@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":60},"Microsoft.Blueprint/blueprintAssignments@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":89},"Microsoft.Blueprint/blueprints@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":32},"Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":53},"Microsoft.Blueprint/blueprints/versions@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":63},"Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":98},"Microsoft.BotService/botServices@2017-12-01":{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":28},"Microsoft.BotService/botServices/channels@2017-12-01":{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":86},"Microsoft.BotService/botServices/Connections@2017-12-01":{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":99},"Microsoft.BotService/botServices@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":28},"Microsoft.BotService/botServices/channels@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":87},"Microsoft.BotService/botServices/Connections@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":100},"Microsoft.BotService/enterpriseChannels@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":135},"Microsoft.BotService/botServices@2020-06-02":{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":28},"Microsoft.BotService/botServices/channels@2020-06-02":{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":101},"Microsoft.BotService/botServices/connections@2020-06-02":{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":114},"Microsoft.BotService/botServices@2021-03-01":{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":39},"Microsoft.BotService/botServices/channels@2021-03-01":{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":114},"Microsoft.BotService/botServices/connections@2021-03-01":{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":129},"Microsoft.BotService/botServices@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":53},"Microsoft.BotService/botServices/channels@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":129},"Microsoft.BotService/botServices/connections@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":144},"Microsoft.BotService/botServices/privateEndpointConnections@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":148},"Microsoft.Cdn/profiles@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":26},"Microsoft.Cdn/profiles/endpoints@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":52},"Microsoft.Cdn/profiles/endpoints/origins@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":65},"Microsoft.Cdn/profiles/endpoints/customDomains@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":78},"Microsoft.Cdn/profiles@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":28},"Microsoft.Cdn/profiles/endpoints@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":54},"Microsoft.Cdn/profiles/endpoints/origins@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":67},"Microsoft.Cdn/profiles/endpoints/customDomains@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":80},"Microsoft.Cdn/profiles@2016-10-02":{"RelativePath":"cdn/microsoft.cdn/2016-10-02/types.json","Index":25},"Microsoft.Cdn/profiles/endpoints@2016-10-02":{"RelativePath":"cdn/microsoft.cdn/2016-10-02/types.json","Index":59},"Microsoft.Cdn/profiles/endpoints/customDomains@2016-10-02":{"RelativePath":"cdn/microsoft.cdn/2016-10-02/types.json","Index":75},"Microsoft.Cdn/profiles@2017-04-02":{"RelativePath":"cdn/microsoft.cdn/2017-04-02/types.json","Index":25},"Microsoft.Cdn/profiles/endpoints@2017-04-02":{"RelativePath":"cdn/microsoft.cdn/2017-04-02/types.json","Index":59},"Microsoft.Cdn/profiles/endpoints/customDomains@2017-04-02":{"RelativePath":"cdn/microsoft.cdn/2017-04-02/types.json","Index":85},"Microsoft.Cdn/profiles@2017-10-12":{"RelativePath":"cdn/microsoft.cdn/2017-10-12/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2017-10-12":{"RelativePath":"cdn/microsoft.cdn/2017-10-12/types.json","Index":93},"Microsoft.Cdn/profiles/endpoints/customDomains@2017-10-12":{"RelativePath":"cdn/microsoft.cdn/2017-10-12/types.json","Index":119},"Microsoft.Cdn/profiles@2019-04-15":{"RelativePath":"cdn/microsoft.cdn/2019-04-15/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-04-15":{"RelativePath":"cdn/microsoft.cdn/2019-04-15/types.json","Index":408},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-04-15":{"RelativePath":"cdn/microsoft.cdn/2019-04-15/types.json","Index":459},"Microsoft.Cdn/profiles@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":365},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":416},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":521},"Microsoft.Cdn/profiles@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":409},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":460},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":565},"Microsoft.Cdn/profiles@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":434},"Microsoft.Cdn/profiles/endpoints/origins@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":443},"Microsoft.Cdn/profiles/endpoints/originGroups@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":453},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":504},"Microsoft.Cdn/profiles@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":449},"Microsoft.Cdn/profiles/endpoints/origins@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":464},"Microsoft.Cdn/profiles/endpoints/originGroups@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":474},"Microsoft.Cdn/profiles/endpoints/customDomains@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":525},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":630},"Microsoft.Cdn/profiles@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":45},"Microsoft.Cdn/profiles/endpoints@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":480},"Microsoft.Cdn/profiles/endpoints/origins@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":495},"Microsoft.Cdn/profiles/endpoints/originGroups@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":505},"Microsoft.Cdn/profiles/endpoints/customDomains@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":556},"Microsoft.Cdn/profiles/customDomains@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":587},"Microsoft.Cdn/profiles/afdEndpoints@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":607},"Microsoft.Cdn/profiles/originGroups@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":627},"Microsoft.Cdn/profiles/originGroups/origins@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":653},"Microsoft.Cdn/profiles/afdEndpoints/routes@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":695},"Microsoft.Cdn/profiles/ruleSets@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":711},"Microsoft.Cdn/profiles/ruleSets/rules@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":732},"Microsoft.Cdn/profiles/securityPolicies@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":755},"Microsoft.Cdn/profiles/secrets@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":779},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":884},"Microsoft.Cdn/profiles/customDomains@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":54},"Microsoft.Cdn/profiles/afdEndpoints@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":79},"Microsoft.Cdn/profiles/originGroups@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":108},"Microsoft.Cdn/profiles/originGroups/origins@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":134},"Microsoft.Cdn/profiles/afdEndpoints/routes@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":179},"Microsoft.Cdn/profiles/ruleSets@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":195},"Microsoft.Cdn/profiles/ruleSets/rules@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":744},"Microsoft.Cdn/profiles/securityPolicies@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":767},"Microsoft.Cdn/profiles/secrets@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":793},"Microsoft.Cdn/profiles@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":819},"Microsoft.Cdn/profiles/endpoints@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":930},"Microsoft.Cdn/profiles/endpoints/origins@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":945},"Microsoft.Cdn/profiles/endpoints/originGroups@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":955},"Microsoft.Cdn/profiles/endpoints/customDomains@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":981},"Microsoft.Cdn/cdnWebApplicationFirewallPolicies@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":1079},"Microsoft.ChangeAnalysis/profile@2020-04-01-preview":{"RelativePath":"changeanalysis/microsoft.changeanalysis/2020-04-01-preview/types.json","Index":27},"Microsoft.Chaos/targets/capabilities@2021-09-15-preview":{"RelativePath":"chaos/microsoft.chaos/2021-09-15-preview/types.json","Index":23},"Microsoft.Chaos/experiments@2021-09-15-preview":{"RelativePath":"chaos/microsoft.chaos/2021-09-15-preview/types.json","Index":58},"Microsoft.Chaos/targets@2021-09-15-preview":{"RelativePath":"chaos/microsoft.chaos/2021-09-15-preview/types.json","Index":63},"Microsoft.Portal/locations/userSettings@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":30},"Microsoft.Portal/locations/consoles@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":48},"Microsoft.Portal/userSettings@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":52},"Microsoft.Portal/consoles@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":70},"Microsoft.CognitiveServices/accounts@2016-02-01-preview":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.json","Index":47},"Microsoft.CognitiveServices/accounts@2017-04-18":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.json","Index":66},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2017-04-18":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.json","Index":70},"Microsoft.CognitiveServices/accounts@2021-04-30":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.json","Index":93},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2021-04-30":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.json","Index":97},"Microsoft.CognitiveServices/accounts@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":93},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":97},"Microsoft.CognitiveServices/accounts/deployments@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":113},"Microsoft.CognitiveServices/accounts/commitmentPlans@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":124},"Microsoft.CognitiveServices/accounts@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":93},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":97},"Microsoft.CognitiveServices/accounts/deployments@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":113},"Microsoft.CognitiveServices/accounts/commitmentPlans@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":124},"Microsoft.Communication/communicationServices@2020-08-20-preview":{"RelativePath":"communication/microsoft.communication/2020-08-20-preview/types.json","Index":23},"Microsoft.Communication/communicationServices@2020-08-20":{"RelativePath":"communication/microsoft.communication/2020-08-20/types.json","Index":34},"Microsoft.Compute/availabilitySets@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":21},"Microsoft.Compute/virtualMachines/extensions@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":30},"Microsoft.Compute/virtualMachines@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":162},"Microsoft.Compute/virtualMachineScaleSets@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":204},"Microsoft.Compute/availabilitySets@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":21},"Microsoft.Compute/virtualMachines/extensions@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":30},"Microsoft.Compute/virtualMachines@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":175},"Microsoft.Compute/virtualMachineScaleSets@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":220},"Microsoft.Compute/availabilitySets@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":22},"Microsoft.Compute/virtualMachines/extensions@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":31},"Microsoft.Compute/virtualMachines@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":180},"Microsoft.Compute/images@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":204},"Microsoft.Compute/virtualMachineScaleSets@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":262},"Microsoft.Compute/disks@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":287},"Microsoft.Compute/snapshots@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":292},"Microsoft.Compute/disks@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":33},"Microsoft.Compute/snapshots@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":38},"Microsoft.Compute/availabilitySets@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":53},"Microsoft.Compute/virtualMachines/extensions@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":62},"Microsoft.Compute/virtualMachines@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":253},"Microsoft.Compute/images@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":283},"Microsoft.Compute/virtualMachineScaleSets@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":352},"Microsoft.Compute/virtualMachineScaleSets/extensions@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":356},"Microsoft.Compute/availabilitySets@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":22},"Microsoft.Compute/virtualMachines/extensions@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":31},"Microsoft.Compute/virtualMachines@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":296},"Microsoft.Compute/images@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":326},"Microsoft.Compute/virtualMachineScaleSets@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":407},"Microsoft.Compute/virtualMachineScaleSets/extensions@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":411},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":423},"Microsoft.Compute/availabilitySets@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":34},"Microsoft.Compute/virtualMachines/extensions@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":43},"Microsoft.Compute/virtualMachines@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":309},"Microsoft.Compute/images@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":341},"Microsoft.Compute/virtualMachineScaleSets@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":425},"Microsoft.Compute/virtualMachineScaleSets/extensions@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":429},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":442},"Microsoft.Compute/disks@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":470},"Microsoft.Compute/snapshots@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":480},"Microsoft.Compute/galleries@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":21},"Microsoft.Compute/galleries/images@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":46},"Microsoft.Compute/galleries/images/versions@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":89},"Microsoft.Compute/disks@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":118},"Microsoft.Compute/snapshots@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":132},"Microsoft.Compute/availabilitySets@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":147},"Microsoft.Compute/proximityPlacementGroups@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":159},"Microsoft.Compute/virtualMachines/extensions@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":168},"Microsoft.Compute/virtualMachines@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":440},"Microsoft.Compute/images@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":474},"Microsoft.Compute/virtualMachineScaleSets@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":562},"Microsoft.Compute/virtualMachineScaleSets/extensions@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":566},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":579},"Microsoft.Compute/disks@2018-09-30":{"RelativePath":"compute/microsoft.compute/2018-09-30/types.json","Index":49},"Microsoft.Compute/snapshots@2018-09-30":{"RelativePath":"compute/microsoft.compute/2018-09-30/types.json","Index":66},"Microsoft.Compute/availabilitySets@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":34},"Microsoft.Compute/virtualMachines/extensions@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":43},"Microsoft.Compute/virtualMachines@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":315},"Microsoft.Compute/images@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":349},"Microsoft.Compute/virtualMachineScaleSets@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":438},"Microsoft.Compute/virtualMachineScaleSets/extensions@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":442},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":455},"Microsoft.Compute/availabilitySets@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":34},"Microsoft.Compute/hostGroups@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":43},"Microsoft.Compute/hostGroups/hosts@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":59},"Microsoft.Compute/virtualMachines/extensions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":68},"Microsoft.Compute/virtualMachines@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":351},"Microsoft.Compute/images@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":388},"Microsoft.Compute/virtualMachineScaleSets@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":486},"Microsoft.Compute/virtualMachineScaleSets/extensions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":490},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":506},"Microsoft.Compute/disks@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":548},"Microsoft.Compute/snapshots@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":565},"Microsoft.Compute/galleries@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":579},"Microsoft.Compute/galleries/images@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":604},"Microsoft.Compute/galleries/images/versions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":653},"Microsoft.Compute/galleries/applications@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":662},"Microsoft.Compute/galleries/applications/versions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":682},"Microsoft.Compute/availabilitySets@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":44},"Microsoft.Compute/hostGroups/hosts@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":60},"Microsoft.Compute/virtualMachines/extensions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":69},"Microsoft.Compute/virtualMachines@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":353},"Microsoft.Compute/images@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":390},"Microsoft.Compute/virtualMachineScaleSets@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":491},"Microsoft.Compute/virtualMachineScaleSets/extensions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":495},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":500},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":516},"Microsoft.Compute/galleries@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":530},"Microsoft.Compute/galleries/images@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":558},"Microsoft.Compute/galleries/images/versions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":606},"Microsoft.Compute/galleries/applications@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":615},"Microsoft.Compute/galleries/applications/versions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":635},"Microsoft.Compute/disks@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":681},"Microsoft.Compute/snapshots@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":698},"Microsoft.Compute/diskEncryptionSets@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":708},"Microsoft.Compute/disks@2019-11-01":{"RelativePath":"compute/microsoft.compute/2019-11-01/types.json","Index":56},"Microsoft.Compute/snapshots@2019-11-01":{"RelativePath":"compute/microsoft.compute/2019-11-01/types.json","Index":73},"Microsoft.Compute/diskEncryptionSets@2019-11-01":{"RelativePath":"compute/microsoft.compute/2019-11-01/types.json","Index":83},"Microsoft.Compute/galleries@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":21},"Microsoft.Compute/galleries/images@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":49},"Microsoft.Compute/galleries/images/versions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":103},"Microsoft.Compute/galleries/applications@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":112},"Microsoft.Compute/galleries/applications/versions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":133},"Microsoft.Compute/availabilitySets@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":148},"Microsoft.Compute/proximityPlacementGroups@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":161},"Microsoft.Compute/hostGroups@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":170},"Microsoft.Compute/hostGroups/hosts@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":186},"Microsoft.Compute/sshPublicKeys@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":192},"Microsoft.Compute/virtualMachines/extensions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":201},"Microsoft.Compute/virtualMachines@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":488},"Microsoft.Compute/images@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":525},"Microsoft.Compute/virtualMachineScaleSets@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":626},"Microsoft.Compute/virtualMachineScaleSets/extensions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":630},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":635},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":651},"Microsoft.Compute/disks@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":61},"Microsoft.Compute/snapshots@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":82},"Microsoft.Compute/diskEncryptionSets@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":96},"Microsoft.Compute/diskAccesses@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":116},"Microsoft.Compute/availabilitySets@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":51},"Microsoft.Compute/hostGroups/hosts@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":64},"Microsoft.Compute/sshPublicKeys@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":70},"Microsoft.Compute/virtualMachines/extensions@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":79},"Microsoft.Compute/virtualMachines@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":396},"Microsoft.Compute/images@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":433},"Microsoft.Compute/virtualMachineScaleSets@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":534},"Microsoft.Compute/virtualMachineScaleSets/extensions@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":538},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":542},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":557},"Microsoft.Compute/virtualMachines/runCommands@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":577},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":582},"Microsoft.Compute/disks@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":61},"Microsoft.Compute/snapshots@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":89},"Microsoft.Compute/diskEncryptionSets@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":102},"Microsoft.Compute/diskAccesses@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":122},"Microsoft.Compute/galleries@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":31},"Microsoft.Compute/galleries/images@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":61},"Microsoft.Compute/galleries/images/versions@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":115},"Microsoft.Compute/galleries/applications@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":124},"Microsoft.Compute/galleries/applications/versions@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":145},"Microsoft.Compute/disks@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":203},"Microsoft.Compute/snapshots@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":231},"Microsoft.Compute/diskEncryptionSets@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":246},"Microsoft.Compute/diskAccesses@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":266},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":270},"Microsoft.Compute/cloudServices@2020-10-01-preview":{"RelativePath":"compute/microsoft.compute/2020-10-01-preview/types.json","Index":40},"Microsoft.Compute/cloudServices/updateDomains@2020-10-01-preview":{"RelativePath":"compute/microsoft.compute/2020-10-01-preview/types.json","Index":44},"Microsoft.Compute/disks@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":71},"Microsoft.Compute/snapshots@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":99},"Microsoft.Compute/diskEncryptionSets@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":114},"Microsoft.Compute/diskAccesses@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":134},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":138},"Microsoft.Compute/availabilitySets@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":153},"Microsoft.Compute/proximityPlacementGroups@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":166},"Microsoft.Compute/hostGroups@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":182},"Microsoft.Compute/hostGroups/hosts@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":195},"Microsoft.Compute/sshPublicKeys@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":201},"Microsoft.Compute/virtualMachines/extensions@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":210},"Microsoft.Compute/virtualMachines@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":535},"Microsoft.Compute/virtualMachineScaleSets@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":641},"Microsoft.Compute/images@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":682},"Microsoft.Compute/virtualMachineScaleSets/extensions@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":686},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":690},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":705},"Microsoft.Compute/virtualMachines/runCommands@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":725},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":730},"Microsoft.Compute/cloudServices@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":40},"Microsoft.Compute/cloudServices/updateDomains@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":44},"Microsoft.Compute/availabilitySets@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":58},"Microsoft.Compute/proximityPlacementGroups@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":71},"Microsoft.Compute/hostGroups@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":87},"Microsoft.Compute/hostGroups/hosts@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":100},"Microsoft.Compute/sshPublicKeys@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":106},"Microsoft.Compute/virtualMachines/extensions@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":115},"Microsoft.Compute/virtualMachines@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":500},"Microsoft.Compute/virtualMachineScaleSets@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":612},"Microsoft.Compute/images@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":653},"Microsoft.Compute/restorePointCollections@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":684},"Microsoft.Compute/restorePointCollections/restorePoints@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":688},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":692},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":696},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":711},"Microsoft.Compute/virtualMachines/runCommands@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":731},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":736},"Microsoft.Compute/disks@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":78},"Microsoft.Compute/snapshots@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":111},"Microsoft.Compute/diskEncryptionSets@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":130},"Microsoft.Compute/diskAccesses@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":150},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":154},"Microsoft.Compute/availabilitySets@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":169},"Microsoft.Compute/proximityPlacementGroups@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":182},"Microsoft.Compute/hostGroups@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":198},"Microsoft.Compute/hostGroups/hosts@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":211},"Microsoft.Compute/sshPublicKeys@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":217},"Microsoft.Compute/virtualMachines/extensions@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":226},"Microsoft.Compute/virtualMachines@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":605},"Microsoft.Compute/virtualMachineScaleSets@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":718},"Microsoft.Compute/images@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":759},"Microsoft.Compute/restorePointCollections@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":790},"Microsoft.Compute/restorePointCollections/restorePoints@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":794},"Microsoft.Compute/capacityReservationGroups@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":809},"Microsoft.Compute/capacityReservationGroups/capacityReservations@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":819},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":823},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":827},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":842},"Microsoft.Compute/virtualMachines/runCommands@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":862},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":867},"Microsoft.Compute/availabilitySets@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":51},"Microsoft.Compute/hostGroups/hosts@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":64},"Microsoft.Compute/sshPublicKeys@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":70},"Microsoft.Compute/virtualMachines/extensions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":79},"Microsoft.Compute/virtualMachines@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":469},"Microsoft.Compute/virtualMachineScaleSets@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":582},"Microsoft.Compute/images@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":623},"Microsoft.Compute/restorePointCollections@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":654},"Microsoft.Compute/restorePointCollections/restorePoints@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":658},"Microsoft.Compute/capacityReservationGroups@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":673},"Microsoft.Compute/capacityReservationGroups/capacityReservations@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":683},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":687},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":691},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":706},"Microsoft.Compute/virtualMachines/runCommands@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":726},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":731},"Microsoft.Compute/galleries@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":756},"Microsoft.Compute/galleries/images@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":786},"Microsoft.Compute/galleries/images/versions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":843},"Microsoft.Compute/galleries/applications@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":852},"Microsoft.Compute/galleries/applications/versions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":876},"Microsoft.Compute/disks@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":83},"Microsoft.Compute/snapshots@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":116},"Microsoft.Compute/diskEncryptionSets@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":136},"Microsoft.Compute/diskAccesses@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":156},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":160},"Microsoft.Compute/galleries@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":46},"Microsoft.Compute/galleries/images@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":79},"Microsoft.Compute/galleries/images/versions@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":151},"Microsoft.Compute/galleries/applications@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":160},"Microsoft.Compute/galleries/applications/versions@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":185},"Microsoft.Compute/availabilitySets@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":51},"Microsoft.Compute/hostGroups/hosts@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":64},"Microsoft.Compute/sshPublicKeys@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":70},"Microsoft.Compute/virtualMachines/extensions@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":79},"Microsoft.Compute/virtualMachines@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":474},"Microsoft.Compute/virtualMachineScaleSets@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":592},"Microsoft.Compute/images@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":633},"Microsoft.Compute/restorePointCollections@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":668},"Microsoft.Compute/restorePointCollections/restorePoints@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":672},"Microsoft.Compute/capacityReservationGroups@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":687},"Microsoft.Compute/capacityReservationGroups/capacityReservations@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":697},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":701},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":705},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":720},"Microsoft.Compute/virtualMachines/runCommands@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":740},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":745},"Microsoft.Compute/disks@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":89},"Microsoft.Compute/snapshots@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":125},"Microsoft.Compute/diskEncryptionSets@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":145},"Microsoft.Compute/diskAccesses@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":165},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":169},"Microsoft.ContainerService/containerServices@2015-11-01-preview":{"RelativePath":"compute/microsoft.containerservice/2015-11-01-preview/types.json","Index":76},"Microsoft.ContainerService/containerServices@2016-03-30":{"RelativePath":"compute/microsoft.containerservice/2016-03-30/types.json","Index":75},"Microsoft.ContainerService/containerServices@2016-09-30":{"RelativePath":"compute/microsoft.containerservice/2016-09-30/types.json","Index":79},"Microsoft.ContainerService/containerServices@2017-01-31":{"RelativePath":"compute/microsoft.containerservice/2017-01-31/types.json","Index":79},"Microsoft.ConfidentialLedger/ledgers@2020-12-01-preview":{"RelativePath":"confidentialledger/microsoft.confidentialledger/2020-12-01-preview/types.json","Index":48},"Microsoft.ConfidentialLedger/ledgers@2021-05-13-preview":{"RelativePath":"confidentialledger/microsoft.confidentialledger/2021-05-13-preview/types.json","Index":48},"Microsoft.Confluent/agreements@2020-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2020-03-01-preview/types.json","Index":13},"Microsoft.Confluent/organizations@2020-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2020-03-01-preview/types.json","Index":42},"Microsoft.Confluent/agreements@2020-03-01":{"RelativePath":"confluent/microsoft.confluent/2020-03-01/types.json","Index":13},"Microsoft.Confluent/organizations@2020-03-01":{"RelativePath":"confluent/microsoft.confluent/2020-03-01/types.json","Index":42},"Microsoft.Confluent/agreements@2021-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-03-01-preview/types.json","Index":24},"Microsoft.Confluent/organizations@2021-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-03-01-preview/types.json","Index":53},"Microsoft.Confluent/agreements@2021-09-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-09-01-preview/types.json","Index":24},"Microsoft.Confluent/organizations@2021-09-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-09-01-preview/types.json","Index":53},"Microsoft.Confluent/agreements@2021-12-01":{"RelativePath":"confluent/microsoft.confluent/2021-12-01/types.json","Index":24},"Microsoft.Confluent/organizations@2021-12-01":{"RelativePath":"confluent/microsoft.confluent/2021-12-01/types.json","Index":53},"Microsoft.ConnectedVMwarevSphere/resourcePools@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":27},"Microsoft.ConnectedVMwarevSphere/clusters@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":36},"Microsoft.ConnectedVMwarevSphere/hosts@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":43},"Microsoft.ConnectedVMwarevSphere/datastores@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":59},"Microsoft.ConnectedVMwarevSphere/vcenters@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":67},"Microsoft.ConnectedVMwarevSphere/virtualMachines@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":148},"Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":164},"Microsoft.ConnectedVMwarevSphere/virtualNetworks@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":171},"Microsoft.ConnectedVMwarevSphere/vcenters/inventoryItems@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":200},"Microsoft.ConnectedVMwarevSphere/virtualMachines/hybridIdentityMetadata@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":205},"Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":217},"Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":229},"Microsoft.Consumption/budgets@2017-12-30-preview":{"RelativePath":"consumption/microsoft.consumption/2017-12-30-preview/types.json","Index":28},"Microsoft.Consumption/budgets@2018-01-31":{"RelativePath":"consumption/microsoft.consumption/2018-01-31/types.json","Index":34},"Microsoft.Consumption/budgets@2018-03-31":{"RelativePath":"consumption/microsoft.consumption/2018-03-31/types.json","Index":36},"Microsoft.Consumption/budgets@2018-06-30":{"RelativePath":"consumption/microsoft.consumption/2018-06-30/types.json","Index":36},"Microsoft.Consumption/budgets@2018-08-31":{"RelativePath":"consumption/microsoft.consumption/2018-08-31/types.json","Index":36},"Microsoft.Consumption/budgets@2018-10-01":{"RelativePath":"consumption/microsoft.consumption/2018-10-01/types.json","Index":36},"Microsoft.Consumption/budgets@2019-01-01":{"RelativePath":"consumption/microsoft.consumption/2019-01-01/types.json","Index":39},"Microsoft.Consumption/budgets@2019-04-01-preview":{"RelativePath":"consumption/microsoft.consumption/2019-04-01-preview/types.json","Index":36},"Microsoft.Consumption/budgets@2019-05-01-preview":{"RelativePath":"consumption/microsoft.consumption/2019-05-01-preview/types.json","Index":36},"Microsoft.Consumption/budgets@2019-05-01":{"RelativePath":"consumption/microsoft.consumption/2019-05-01/types.json","Index":41},"Microsoft.Consumption/budgets@2019-06-01":{"RelativePath":"consumption/microsoft.consumption/2019-06-01/types.json","Index":39},"Microsoft.Consumption/budgets@2019-10-01":{"RelativePath":"consumption/microsoft.consumption/2019-10-01/types.json","Index":64},"Microsoft.Consumption/budgets@2019-11-01":{"RelativePath":"consumption/microsoft.consumption/2019-11-01/types.json","Index":43},"Microsoft.Consumption/budgets@2021-05-01":{"RelativePath":"consumption/microsoft.consumption/2021-05-01/types.json","Index":42},"Microsoft.Consumption/budgets@2021-10-01":{"RelativePath":"consumption/microsoft.consumption/2021-10-01/types.json","Index":65},"Microsoft.ContainerInstance/containerGroups@2017-08-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2017-08-01-preview/types.json","Index":48},"Microsoft.ContainerInstance/containerGroups@2017-10-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2017-10-01-preview/types.json","Index":55},"Microsoft.ContainerInstance/containerGroups@2017-12-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2017-12-01-preview/types.json","Index":57},"Microsoft.ContainerInstance/containerGroups@2018-02-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-02-01-preview/types.json","Index":57},"Microsoft.ContainerInstance/containerGroups@2018-04-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-04-01/types.json","Index":57},"Microsoft.ContainerInstance/containerGroups@2018-06-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-06-01/types.json","Index":66},"Microsoft.ContainerInstance/containerGroups@2018-09-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-09-01/types.json","Index":72},"Microsoft.ContainerInstance/containerGroups@2018-10-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-10-01/types.json","Index":87},"Microsoft.ContainerInstance/containerGroups@2019-12-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2019-12-01/types.json","Index":99},"Microsoft.ContainerInstance/containerGroups@2020-11-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2020-11-01/types.json","Index":101},"Microsoft.ContainerInstance/containerGroups@2021-03-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-03-01/types.json","Index":101},"Microsoft.ContainerInstance/containerGroups@2021-07-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-07-01/types.json","Index":102},"Microsoft.ContainerInstance/containerGroups@2021-09-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-09-01/types.json","Index":103},"Microsoft.ContainerInstance/containerGroups@2021-10-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-10-01/types.json","Index":109},"Microsoft.ContainerRegistry/registries@2016-06-27-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2016-06-27-preview/types.json","Index":14},"Microsoft.ContainerRegistry/registries@2017-03-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-03-01/types.json","Index":20},"Microsoft.ContainerRegistry/registries@2017-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":31},"Microsoft.ContainerRegistry/registries/replications@2017-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":44},"Microsoft.ContainerRegistry/registries/webhooks@2017-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":65},"Microsoft.ContainerRegistry/registries@2017-10-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":45},"Microsoft.ContainerRegistry/registries/replications@2017-10-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":58},"Microsoft.ContainerRegistry/registries/webhooks@2017-10-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":82},"Microsoft.ContainerRegistry/registries/buildTasks/steps@2018-02-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":35},"Microsoft.ContainerRegistry/registries/buildTasks@2018-02-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":63},"Microsoft.ContainerRegistry/registries/tasks@2018-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":89},"Microsoft.ContainerRegistry/registries/tasks@2019-04-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":103},"Microsoft.ContainerRegistry/registries/scopeMaps@2019-05-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01-preview/types.json","Index":31},"Microsoft.ContainerRegistry/registries/tokens@2019-05-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01-preview/types.json","Index":58},"Microsoft.ContainerRegistry/registries@2019-05-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":60},"Microsoft.ContainerRegistry/registries/replications@2019-05-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":73},"Microsoft.ContainerRegistry/registries/webhooks@2019-05-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":97},"Microsoft.ContainerRegistry/registries/agentPools@2019-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":34},"Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":128},"Microsoft.ContainerRegistry/registries/tasks@2019-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":193},"Microsoft.ContainerRegistry/registries/exportPipelines@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":45},"Microsoft.ContainerRegistry/registries@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":129},"Microsoft.ContainerRegistry/registries/importPipelines@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":155},"Microsoft.ContainerRegistry/registries/pipelineRuns@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":180},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":184},"Microsoft.ContainerRegistry/registries/replications@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":197},"Microsoft.ContainerRegistry/registries/webhooks@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":221},"Microsoft.ContainerRegistry/registries/connectedRegistries@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":65},"Microsoft.ContainerRegistry/registries/exportPipelines@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":92},"Microsoft.ContainerRegistry/registries@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":179},"Microsoft.ContainerRegistry/registries/importPipelines@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":205},"Microsoft.ContainerRegistry/registries/pipelineRuns@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":230},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":234},"Microsoft.ContainerRegistry/registries/replications@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":250},"Microsoft.ContainerRegistry/registries/scopeMaps@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":263},"Microsoft.ContainerRegistry/registries/tokens@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":289},"Microsoft.ContainerRegistry/registries/webhooks@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":313},"Microsoft.ContainerRegistry/registries/connectedRegistries@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":65},"Microsoft.ContainerRegistry/registries/exportPipelines@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":92},"Microsoft.ContainerRegistry/registries@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":183},"Microsoft.ContainerRegistry/registries/importPipelines@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":209},"Microsoft.ContainerRegistry/registries/pipelineRuns@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":234},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":238},"Microsoft.ContainerRegistry/registries/replications@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":254},"Microsoft.ContainerRegistry/registries/scopeMaps@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":267},"Microsoft.ContainerRegistry/registries/tokens@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":293},"Microsoft.ContainerRegistry/registries/webhooks@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":317},"Microsoft.ContainerRegistry/registries/connectedRegistries@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":68},"Microsoft.ContainerRegistry/registries/exportPipelines@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":95},"Microsoft.ContainerRegistry/registries@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":186},"Microsoft.ContainerRegistry/registries/importPipelines@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":212},"Microsoft.ContainerRegistry/registries/pipelineRuns@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":237},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":241},"Microsoft.ContainerRegistry/registries/replications@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":257},"Microsoft.ContainerRegistry/registries/scopeMaps@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":270},"Microsoft.ContainerRegistry/registries/tokens@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":296},"Microsoft.ContainerRegistry/registries/webhooks@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":320},"Microsoft.ContainerRegistry/registries@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":113},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":117},"Microsoft.ContainerRegistry/registries/replications@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":133},"Microsoft.ContainerRegistry/registries/webhooks@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":157},"Microsoft.ContainerRegistry/registries/connectedRegistries@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":68},"Microsoft.ContainerRegistry/registries/exportPipelines@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":95},"Microsoft.ContainerRegistry/registries@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":186},"Microsoft.ContainerRegistry/registries/importPipelines@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":212},"Microsoft.ContainerRegistry/registries/pipelineRuns@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":237},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":241},"Microsoft.ContainerRegistry/registries/replications@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":257},"Microsoft.ContainerRegistry/registries/scopeMaps@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":270},"Microsoft.ContainerRegistry/registries/tokens@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":296},"Microsoft.ContainerRegistry/registries/webhooks@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":320},"Microsoft.ContainerService/containerServices@2017-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2017-07-01/types.json","Index":393},"Microsoft.ContainerService/managedClusters@2017-08-31":{"RelativePath":"containerservice/microsoft.containerservice/2017-08-31/types.json","Index":203},"Microsoft.ContainerService/managedClusters@2018-03-31":{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":211},"Microsoft.ContainerService/managedClusters@2018-08-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":211},"Microsoft.ContainerService/openShiftManagedClusters@2018-09-30-preview":{"RelativePath":"containerservice/microsoft.containerservice/2018-09-30-preview/types.json","Index":103},"Microsoft.ContainerService/managedClusters@2019-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":214},"Microsoft.ContainerService/managedClusters/agentPools@2019-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":401},"Microsoft.ContainerService/managedClusters@2019-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":222},"Microsoft.ContainerService/managedClusters/agentPools@2019-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":409},"Microsoft.ContainerService/openShiftManagedClusters@2019-04-30":{"RelativePath":"containerservice/microsoft.containerservice/2019-04-30/types.json","Index":103},"Microsoft.ContainerService/managedClusters@2019-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":229},"Microsoft.ContainerService/managedClusters/agentPools@2019-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":423},"Microsoft.ContainerService/managedClusters@2019-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":238},"Microsoft.ContainerService/managedClusters/agentPools@2019-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":432},"Microsoft.ContainerService/openShiftManagedClusters@2019-09-30-preview":{"RelativePath":"containerservice/microsoft.containerservice/2019-09-30-preview/types.json","Index":104},"Microsoft.ContainerService/managedClusters@2019-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":238},"Microsoft.ContainerService/managedClusters/agentPools@2019-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":432},"Microsoft.ContainerService/openShiftManagedClusters@2019-10-27-preview":{"RelativePath":"containerservice/microsoft.containerservice/2019-10-27-preview/types.json","Index":102},"Microsoft.ContainerService/managedClusters@2019-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":246},"Microsoft.ContainerService/managedClusters/agentPools@2019-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":442},"Microsoft.ContainerService/managedClusters@2020-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":246},"Microsoft.ContainerService/managedClusters/agentPools@2020-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":442},"Microsoft.ContainerService/managedClusters@2020-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":251},"Microsoft.ContainerService/managedClusters/agentPools@2020-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":448},"Microsoft.ContainerService/managedClusters@2020-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":261},"Microsoft.ContainerService/managedClusters/agentPools@2020-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":461},"Microsoft.ContainerService/managedClusters@2020-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":261},"Microsoft.ContainerService/managedClusters/agentPools@2020-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":460},"Microsoft.ContainerService/managedClusters@2020-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":264},"Microsoft.ContainerService/managedClusters/agentPools@2020-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":463},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":480},"Microsoft.ContainerService/managedClusters@2020-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":267},"Microsoft.ContainerService/managedClusters/agentPools@2020-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":466},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":483},"Microsoft.ContainerService/managedClusters@2020-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":278},"Microsoft.ContainerService/managedClusters/agentPools@2020-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":480},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":497},"Microsoft.ContainerService/managedClusters@2020-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":304},"Microsoft.ContainerService/managedClusters/agentPools@2020-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":506},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":523},"Microsoft.ContainerService/managedClusters@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":307},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":336},"Microsoft.ContainerService/managedClusters/agentPools@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":540},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":557},"Microsoft.ContainerService/managedClusters@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":308},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":337},"Microsoft.ContainerService/managedClusters/agentPools@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":542},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":559},"Microsoft.ContainerService/managedClusters@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":151},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":180},"Microsoft.ContainerService/managedClusters/agentPools@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":219},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":236},"Microsoft.ContainerService/managedClusters@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":151},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":180},"Microsoft.ContainerService/managedClusters/agentPools@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":219},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":236},"Microsoft.ContainerService/managedClusters@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":160},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":189},"Microsoft.ContainerService/managedClusters/agentPools@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":231},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":167},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":196},"Microsoft.ContainerService/managedClusters/agentPools@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":241},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":258},"Microsoft.ContainerService/snapshots@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":266},"Microsoft.ContainerService/managedClusters@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":168},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":197},"Microsoft.ContainerService/managedClusters/agentPools@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":242},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":259},"Microsoft.ContainerService/snapshots@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":273},"Microsoft.ContainerService/managedClusters@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":174},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":175},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":204},"Microsoft.ContainerService/managedClusters/agentPools@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":249},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":266},"Microsoft.ContainerService/snapshots@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":280},"Microsoft.ContainerService/managedClusters@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":174},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":176},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":205},"Microsoft.ContainerService/managedClusters/agentPools@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":250},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":267},"Microsoft.ContainerService/snapshots@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":281},"Microsoft.ContainerService/managedClusters@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":185},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":188},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":206},"Microsoft.ContainerService/managedClusters/agentPools@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":251},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":268},"Microsoft.ContainerService/snapshots@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":283},"Microsoft.ContainerService/managedclustersnapshots@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":307},"Microsoft.ContainerService/managedClusters@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":185},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":192},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":210},"Microsoft.ContainerService/managedClusters/agentPools@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":255},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":272},"Microsoft.ContainerService/snapshots@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":287},"Microsoft.ContainerService/managedclustersnapshots@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":311},"Microsoft.DocumentDB/databaseAccounts@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2019-08-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01-preview/types.json","Index":14},"Microsoft.DocumentDB/databaseAccounts@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":110},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":116},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":157},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":163},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":177},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":183},"Microsoft.DocumentDB/databaseAccounts/tables@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":191},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":197},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":205},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":226},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":232},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":240},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":56},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":112},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":125},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":148},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":161},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":180},"Microsoft.DocumentDB/databaseAccounts/tables@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":193},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":200},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":206},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":220},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":226},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":233},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":239},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":252},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":64},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":120},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":126},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":133},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":140},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":156},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":163},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":182},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/tables@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":195},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":201},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":208},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":214},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":228},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":234},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":241},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":247},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":62},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":73},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":129},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":135},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":142},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":165},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":172},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":178},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":191},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":197},"Microsoft.DocumentDB/databaseAccounts/tables@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":204},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":250},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":256},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":263},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":269},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":276},"Microsoft.DocumentDB/databaseAccounts@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":101},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":112},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":168},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":204},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":222},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":229},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":248},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/tables@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":261},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":274},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":280},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":307},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":313},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":320},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":326},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":333},"Microsoft.DocumentDB/databaseAccounts@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":59},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":68},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":79},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":135},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":141},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":148},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":171},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":178},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":184},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":197},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":203},"Microsoft.DocumentDB/databaseAccounts/tables@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":216},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":229},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":249},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":256},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":262},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":269},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":275},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":282},"Microsoft.DocumentDB/databaseAccounts@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":72},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":81},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":162},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":185},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":192},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/tables@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":230},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":257},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":263},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":270},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":276},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":283},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":289},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":296},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":97},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":106},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":117},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":180},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":194},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":228},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":241},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/tables@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":273},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":280},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":286},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":306},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":313},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":319},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":326},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":332},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":339},"Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":362},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":375},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":379},"Microsoft.DocumentDB/databaseAccounts@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":72},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":81},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":162},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":185},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":192},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/tables@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":230},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":257},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":263},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":270},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":276},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":283},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":289},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":296},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":97},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":106},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":117},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":180},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":194},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":228},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":241},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/tables@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":273},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":280},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":286},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":306},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":313},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":319},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":326},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":332},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":339},"Microsoft.DocumentDB/cassandraClusters@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":362},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":375},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":379},"Microsoft.DocumentDB/databaseAccounts/services@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":395},"Microsoft.DocumentDB/databaseAccounts@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":72},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":81},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":162},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":185},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":203},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":216},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":229},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/tables@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":242},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":248},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":255},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":261},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":275},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":281},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":288},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":301},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":307},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":314},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":318},"Microsoft.DocumentDB/databaseAccounts@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":76},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":85},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":153},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":159},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":166},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":189},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":202},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":207},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":214},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":220},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":233},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":239},"Microsoft.DocumentDB/databaseAccounts/tables@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":252},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":265},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":279},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":285},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":292},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":298},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":305},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":311},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":318},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":322},"Microsoft.DocumentDB/databaseAccounts@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":105},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":114},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":125},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":182},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":195},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":202},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":218},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":231},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":236},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":249},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":262},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":268},"Microsoft.DocumentDB/databaseAccounts/tables@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":275},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":281},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":288},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":308},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":314},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":321},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":327},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":334},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":340},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":347},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":351},"Microsoft.DocumentDB/databaseAccounts@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":114},"Microsoft.DocumentDB/databaseAccounts/graphs@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":123},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":130},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":141},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":204},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":218},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":234},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":247},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":252},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":265},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":278},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":284},"Microsoft.DocumentDB/databaseAccounts/tables@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":291},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":297},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":304},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":310},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":324},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":330},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":337},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":343},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":350},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":356},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":363},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":369},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":376},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":380},"Microsoft.DocumentDB/cassandraClusters@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":403},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":416},"Microsoft.DocumentDB/databaseAccounts/services@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":432},"Microsoft.DocumentDB/databaseAccounts@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":115},"Microsoft.DocumentDB/databaseAccounts/graphs@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":131},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":142},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":206},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":212},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":219},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":226},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":242},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":255},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":273},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":286},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":292},"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":306},"Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":312},"Microsoft.DocumentDB/databaseAccounts/tables@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":319},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":325},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":332},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":338},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":352},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":358},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":365},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":371},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":378},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":384},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":391},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":397},"Microsoft.DocumentDB/cassandraClusters@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":425},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":440},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":447},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":451},"Microsoft.DocumentDB/databaseAccounts/services@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":467},"Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":478},"Microsoft.DocumentDB/databaseAccounts@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":111},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":120},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":131},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":194},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":201},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":208},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":242},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":249},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":255},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":268},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":274},"Microsoft.DocumentDB/databaseAccounts/tables@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":281},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":287},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":314},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":320},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":327},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":333},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":340},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":346},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":353},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":357},"Microsoft.DocumentDB/cassandraClusters@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":384},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":397},"Microsoft.DocumentDB/databaseAccounts@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":119},"Microsoft.DocumentDB/databaseAccounts/graphs@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":128},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":135},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":153},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":216},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":230},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":264},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":271},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":277},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":290},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":296},"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":310},"Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":316},"Microsoft.DocumentDB/databaseAccounts/tables@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":323},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":329},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":336},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":342},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":356},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":362},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":369},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":375},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":382},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":388},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":395},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":401},"Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":414},"Microsoft.DocumentDB/cassandraClusters@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":442},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":457},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":464},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":468},"Microsoft.DocumentDB/databaseAccounts/services@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":484},"Microsoft.DocumentDB/databaseAccounts@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/graphs@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":133},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":140},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":151},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":158},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":218},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":231},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":238},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":272},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":279},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":285},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":298},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":304},"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":318},"Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":324},"Microsoft.DocumentDB/databaseAccounts/tables@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":331},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":337},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":344},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":350},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":364},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":370},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":377},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":383},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":390},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":396},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":403},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":409},"Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":422},"Microsoft.DocumentDB/cassandraClusters@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":450},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":465},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":472},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":476},"Microsoft.DocumentDB/databaseAccounts/services@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":492},"Microsoft.CostManagement/reportconfigs@2018-05-31":{"RelativePath":"cost-management/microsoft.costmanagement/2018-05-31/types.json","Index":57},"Microsoft.CostManagement/reports@2018-08-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2018-08-01-preview/types.json","Index":57},"Microsoft.CostManagement/connectors@2018-08-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2018-08-01-preview/types.json","Index":69},"Microsoft.CostManagement/exports@2019-01-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-01-01/types.json","Index":68},"Microsoft.CostManagement/cloudConnectors@2019-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-03-01-preview/types.json","Index":24},"Microsoft.CostManagement/externalSubscriptions@2019-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-03-01-preview/types.json","Index":28},"Microsoft.CostManagement/showbackRules@2019-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-03-01-preview/types.json","Index":57},"Microsoft.CostManagement/views@2019-04-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-04-01-preview/types.json","Index":72},"Microsoft.CostManagement/budgets@2019-04-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-04-01-preview/types.json","Index":95},"Microsoft.CostManagement/exports@2019-09-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-09-01/types.json","Index":66},"Microsoft.CostManagement/exports@2019-10-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-10-01/types.json","Index":66},"Microsoft.CostManagement/settings@2019-11-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-11-01/types.json","Index":18},"Microsoft.CostManagement/views@2019-11-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-11-01/types.json","Index":86},"Microsoft.CostManagement/exports@2019-11-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-11-01/types.json","Index":143},"Microsoft.CostManagement/costAllocationRules@2020-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2020-03-01-preview/types.json","Index":32},"Microsoft.CostManagement/views@2020-06-01":{"RelativePath":"cost-management/microsoft.costmanagement/2020-06-01/types.json","Index":72},"Microsoft.CostManagement/exports@2020-06-01":{"RelativePath":"cost-management/microsoft.costmanagement/2020-06-01/types.json","Index":128},"Microsoft.CostManagement/exports@2020-12-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2020-12-01-preview/types.json","Index":63},"Microsoft.CostManagement/exports@2021-01-01":{"RelativePath":"cost-management/microsoft.costmanagement/2021-01-01/types.json","Index":63},"Microsoft.CostManagement/views@2021-10-01":{"RelativePath":"cost-management/microsoft.costmanagement/2021-10-01/types.json","Index":72},"Microsoft.CostManagement/exports@2021-10-01":{"RelativePath":"cost-management/microsoft.costmanagement/2021-10-01/types.json","Index":128},"Microsoft.CostManagement/scheduledActions@2022-04-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2022-04-01-preview/types.json","Index":55},"Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview":{"RelativePath":"cpim/microsoft.azureactivedirectory/2019-01-01-preview/types.json","Index":24},"Microsoft.AzureActiveDirectory/guestUsages@2020-05-01-preview":{"RelativePath":"cpim/microsoft.azureactivedirectory/2020-05-01-preview/types.json","Index":13},"Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01":{"RelativePath":"cpim/microsoft.azureactivedirectory/2021-04-01/types.json","Index":36},"Microsoft.AzureActiveDirectory/guestUsages@2021-04-01":{"RelativePath":"cpim/microsoft.azureactivedirectory/2021-04-01/types.json","Index":42},"Microsoft.CustomerInsights/hubs@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":14},"Microsoft.CustomerInsights/hubs/profiles@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":58},"Microsoft.CustomerInsights/hubs/interactions@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":90},"Microsoft.CustomerInsights/hubs/relationships@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":113},"Microsoft.CustomerInsights/hubs/relationshipLinks@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":134},"Microsoft.CustomerInsights/hubs/authorizationPolicies@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":144},"Microsoft.CustomerInsights/hubs/connectors@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":164},"Microsoft.CustomerInsights/hubs/connectors/mappings@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":211},"Microsoft.CustomerInsights/hubs/kpi@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":256},"Microsoft.CustomerInsights/hubs/views@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":262},"Microsoft.CustomerInsights/hubs/links@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":285},"Microsoft.CustomerInsights/hubs/roleAssignments@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":312},"Microsoft.CustomerInsights/hubs@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":14},"Microsoft.CustomerInsights/hubs/profiles@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":58},"Microsoft.CustomerInsights/hubs/interactions@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":90},"Microsoft.CustomerInsights/hubs/relationships@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":113},"Microsoft.CustomerInsights/hubs/relationshipLinks@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":135},"Microsoft.CustomerInsights/hubs/authorizationPolicies@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":145},"Microsoft.CustomerInsights/hubs/connectors@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":165},"Microsoft.CustomerInsights/hubs/connectors/mappings@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":212},"Microsoft.CustomerInsights/hubs/kpi@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":257},"Microsoft.CustomerInsights/hubs/views@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":263},"Microsoft.CustomerInsights/hubs/links@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":296},"Microsoft.CustomerInsights/hubs/roleAssignments@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":323},"Microsoft.CustomerInsights/hubs/predictions@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":347},"Microsoft.CustomProviders/resourceProviders@2018-09-01-preview":{"RelativePath":"customproviders/microsoft.customproviders/2018-09-01-preview/types.json","Index":32},"Microsoft.CustomProviders/associations@2018-09-01-preview":{"RelativePath":"customproviders/microsoft.customproviders/2018-09-01-preview/types.json","Index":43},"Microsoft.Dashboard/grafana@2021-09-01-preview":{"RelativePath":"dashboard/microsoft.dashboard/2021-09-01-preview/types.json","Index":46},"Microsoft.DataBox/jobs@2018-01-01":{"RelativePath":"databox/microsoft.databox/2018-01-01/types.json","Index":115},"Microsoft.DataBox/jobs@2019-09-01":{"RelativePath":"databox/microsoft.databox/2019-09-01/types.json","Index":137},"Microsoft.DataBox/jobs@2020-04-01":{"RelativePath":"databox/microsoft.databox/2020-04-01/types.json","Index":184},"Microsoft.DataBox/jobs@2020-11-01":{"RelativePath":"databox/microsoft.databox/2020-11-01/types.json","Index":193},"Microsoft.DataBox/jobs@2021-03-01":{"RelativePath":"databox/microsoft.databox/2021-03-01/types.json","Index":203},"Microsoft.DataBox/jobs@2021-05-01":{"RelativePath":"databox/microsoft.databox/2021-05-01/types.json","Index":206},"Microsoft.DataBox/jobs@2021-08-01-preview":{"RelativePath":"databox/microsoft.databox/2021-08-01-preview/types.json","Index":326},"Microsoft.DataBox/jobs@2021-12-01":{"RelativePath":"databox/microsoft.databox/2021-12-01/types.json","Index":366},"Microsoft.DataBox/jobs@2022-02-01":{"RelativePath":"databox/microsoft.databox/2022-02-01/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":34},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":48},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":77},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":105},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":141},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":152},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":165},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":176},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":35},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":49},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":78},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":106},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":156},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":169},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":42},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":56},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":86},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":114},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":153},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":164},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":178},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":193},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":206},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":221},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":46},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":60},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":90},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":126},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":165},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":176},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":190},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":205},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":218},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":233},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":94},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":108},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":243},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":281},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":296},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":346},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":360},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":375},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":388},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":403},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":94},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":108},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":243},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":281},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":296},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":346},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":360},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":375},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":388},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":403},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":94},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":108},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":243},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":281},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":296},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":346},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":360},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":375},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":388},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":403},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":98},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":112},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":149},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":247},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":285},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":300},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":339},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":350},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":364},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":379},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":392},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":407},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":102},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":116},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":125},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":143},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":278},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":316},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":331},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":370},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":395},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":410},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":423},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":438},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":102},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":116},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":125},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":143},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":278},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":316},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":331},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":370},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":395},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":410},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":423},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":438},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":102},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":116},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":125},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":143},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":278},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":316},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":331},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":370},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":395},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":410},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":423},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":438},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":106},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":120},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":129},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":147},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":184},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":282},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":320},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":374},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":385},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":399},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":414},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":427},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":442},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":107},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":121},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":130},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":148},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":185},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":321},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":342},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":357},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":396},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":407},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":421},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":436},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":449},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":464},"Microsoft.Databricks/workspaces@2018-04-01":{"RelativePath":"databricks/microsoft.databricks/2018-04-01/types.json","Index":55},"Microsoft.Databricks/workspaces/virtualNetworkPeerings@2018-04-01":{"RelativePath":"databricks/microsoft.databricks/2018-04-01/types.json","Index":73},"Microsoft.Databricks/workspaces@2021-04-01-preview":{"RelativePath":"databricks/microsoft.databricks/2021-04-01-preview/types.json","Index":95},"Microsoft.Databricks/workspaces/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"databricks/microsoft.databricks/2021-04-01-preview/types.json","Index":99},"Microsoft.Databricks/workspaces/virtualNetworkPeerings@2021-04-01-preview":{"RelativePath":"databricks/microsoft.databricks/2021-04-01-preview/types.json","Index":117},"Microsoft.DataCatalog/catalogs@2016-03-30":{"RelativePath":"datacatalog/microsoft.datacatalog/2016-03-30/types.json","Index":19},"Microsoft.Datadog/agreements@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":13},"Microsoft.Datadog/monitors@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":47},"Microsoft.Datadog/monitors/tagRules@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":70},"Microsoft.Datadog/monitors/singleSignOnConfigurations@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":90},"Microsoft.Datadog/agreements@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":24},"Microsoft.Datadog/monitors@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":58},"Microsoft.Datadog/monitors/tagRules@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":81},"Microsoft.Datadog/monitors/singleSignOnConfigurations@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":101},"Microsoft.DataFactory/factories@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":16},"Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":59},"Microsoft.DataFactory/factories/linkedservices@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":386},"Microsoft.DataFactory/factories/datasets@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":538},"Microsoft.DataFactory/factories/pipelines@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":728},"Microsoft.DataFactory/factories/triggers@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":742},"Microsoft.DataFactory/factories@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":39},"Microsoft.DataFactory/factories/integrationRuntimes@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":126},"Microsoft.DataFactory/factories/linkedservices@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":594},"Microsoft.DataFactory/factories/datasets@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":903},"Microsoft.DataFactory/factories/pipelines@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1629},"Microsoft.DataFactory/factories/triggers@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1711},"Microsoft.DataFactory/factories/dataflows@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1740},"Microsoft.DataFactory/factories/managedVirtualNetworks@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1745},"Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1752},"Microsoft.DataFactory/factories/privateEndpointConnections@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1759},"Microsoft.DataLakeAnalytics/accounts@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":89},"Microsoft.DataLakeAnalytics/accounts/DataLakeStoreAccounts@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":93},"Microsoft.DataLakeAnalytics/accounts/StorageAccounts@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":97},"Microsoft.DataLakeAnalytics/accounts/computePolicies@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":101},"Microsoft.DataLakeAnalytics/accounts/firewallRules@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":105},"Microsoft.DataLakeAnalytics/accounts@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":91},"Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":95},"Microsoft.DataLakeAnalytics/accounts/storageAccounts@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":99},"Microsoft.DataLakeAnalytics/accounts/computePolicies@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":103},"Microsoft.DataLakeAnalytics/accounts/firewallRules@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":107},"Microsoft.DataLakeAnalytics/accounts@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":91},"Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":95},"Microsoft.DataLakeAnalytics/accounts/storageAccounts@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":99},"Microsoft.DataLakeAnalytics/accounts/computePolicies@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":103},"Microsoft.DataLakeAnalytics/accounts/firewallRules@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":107},"Microsoft.DataLakeStore/accounts/firewallRules@2015-10-01-preview":{"RelativePath":"datalake-store/microsoft.datalakestore/2015-10-01-preview/types.json","Index":12},"Microsoft.DataLakeStore/accounts@2015-10-01-preview":{"RelativePath":"datalake-store/microsoft.datalakestore/2015-10-01-preview/types.json","Index":44},"Microsoft.DataLakeStore/accounts@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":75},"Microsoft.DataLakeStore/accounts/firewallRules@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":79},"Microsoft.DataLakeStore/accounts/virtualNetworkRules@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":83},"Microsoft.DataLakeStore/accounts/trustedIdProviders@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":87},"Microsoft.DataMigration/services@2017-11-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2017-11-15-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2017-11-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2017-11-15-preview/types.json","Index":155},"Microsoft.DataMigration/services/projects@2017-11-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2017-11-15-preview/types.json","Index":181},"Microsoft.DataMigration/services@2018-03-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-15-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-03-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-15-preview/types.json","Index":222},"Microsoft.DataMigration/services/projects@2018-03-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-15-preview/types.json","Index":248},"Microsoft.DataMigration/services@2018-03-31-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-31-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-03-31-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-31-preview/types.json","Index":272},"Microsoft.DataMigration/services/projects@2018-03-31-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-31-preview/types.json","Index":299},"Microsoft.DataMigration/services@2018-04-19":{"RelativePath":"datamigration/microsoft.datamigration/2018-04-19/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-04-19":{"RelativePath":"datamigration/microsoft.datamigration/2018-04-19/types.json","Index":634},"Microsoft.DataMigration/services/projects@2018-04-19":{"RelativePath":"datamigration/microsoft.datamigration/2018-04-19/types.json","Index":668},"Microsoft.DataMigration/services@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":981},"Microsoft.DataMigration/services/serviceTasks@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":985},"Microsoft.DataMigration/services/projects@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":1030},"Microsoft.DataMigration/services/projects/files@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":1035},"Microsoft.DataMigration/services@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":36},"Microsoft.DataMigration/services/projects/tasks@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1056},"Microsoft.DataMigration/services/serviceTasks@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1060},"Microsoft.DataMigration/services/projects@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1105},"Microsoft.DataMigration/services/projects/files@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1110},"Microsoft.DataMigration/databaseMigrations@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":42},"Microsoft.DataMigration/sqlMigrationServices@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":48},"Microsoft.DataMigration/services@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":66},"Microsoft.DataMigration/services/projects/tasks@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1087},"Microsoft.DataMigration/services/serviceTasks@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1091},"Microsoft.DataMigration/services/projects@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1136},"Microsoft.DataMigration/services/projects/files@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1141},"Microsoft.DataMigration/databaseMigrations@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":42},"Microsoft.DataMigration/sqlMigrationServices@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":48},"Microsoft.DataMigration/services@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":66},"Microsoft.DataMigration/services/projects/tasks@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1101},"Microsoft.DataMigration/services/serviceTasks@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1105},"Microsoft.DataMigration/services/projects@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1162},"Microsoft.DataMigration/services/projects/files@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1167},"Microsoft.DataMigration/databaseMigrations@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":35},"Microsoft.DataMigration/sqlMigrationServices@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":41},"Microsoft.DataMigration/services@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":59},"Microsoft.DataMigration/services/projects/tasks@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1106},"Microsoft.DataMigration/services/serviceTasks@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1110},"Microsoft.DataMigration/services/projects@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1179},"Microsoft.DataMigration/services/projects/files@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1184},"Microsoft.DataProtection/backupVaults@2021-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-01-01/types.json","Index":40},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-01-01/types.json","Index":131},"Microsoft.DataProtection/backupVaults/backupInstances@2021-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-01-01/types.json","Index":175},"Microsoft.DataProtection/backupVaults@2021-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-02-01-preview/types.json","Index":40},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-02-01-preview/types.json","Index":131},"Microsoft.DataProtection/backupVaults/backupInstances@2021-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-02-01-preview/types.json","Index":175},"Microsoft.DataProtection/backupVaults@2021-06-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-06-01-preview/types.json","Index":40},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-06-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-06-01-preview/types.json","Index":131},"Microsoft.DataProtection/backupVaults/backupInstances@2021-06-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-06-01-preview/types.json","Index":182},"Microsoft.DataProtection/backupVaults@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":194},"Microsoft.DataProtection/resourceGuards@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":209},"Microsoft.DataProtection/backupVaults@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":197},"Microsoft.DataProtection/resourceGuards@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":212},"Microsoft.DataProtection/backupVaults@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":194},"Microsoft.DataProtection/resourceGuards@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":209},"Microsoft.DataProtection/backupVaults@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":197},"Microsoft.DataProtection/resourceGuards@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":212},"Microsoft.DataProtection/backupVaults@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":57},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":148},"Microsoft.DataProtection/backupVaults/backupInstances@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":202},"Microsoft.DataProtection/resourceGuards@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":217},"Microsoft.DataProtection/backupVaults@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":197},"Microsoft.DataProtection/resourceGuards@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":212},"Microsoft.DataProtection/backupVaults@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":57},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":148},"Microsoft.DataProtection/backupVaults/backupInstances@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":202},"Microsoft.DataProtection/resourceGuards@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":217},"Microsoft.DataShare/accounts@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":22},"Microsoft.DataShare/accounts/shares/dataSets@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":74},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":204},"Microsoft.DataShare/accounts/shares/invitations@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":214},"Microsoft.DataShare/accounts/shares@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":228},"Microsoft.DataShare/accounts/shareSubscriptions@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":247},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":263},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":286},"Microsoft.DataShare/accounts@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":22},"Microsoft.DataShare/accounts/shares/dataSets@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":74},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":204},"Microsoft.DataShare/accounts/shares/invitations@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":214},"Microsoft.DataShare/accounts/shares@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":228},"Microsoft.DataShare/accounts/shareSubscriptions@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":247},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":263},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":286},"Microsoft.DataShare/accounts@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":33},"Microsoft.DataShare/accounts/shares/dataSets@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":88},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":230},"Microsoft.DataShare/accounts/shares/invitations@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":240},"Microsoft.DataShare/accounts/shares@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":254},"Microsoft.DataShare/accounts/shareSubscriptions@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":273},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":289},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":312},"Microsoft.DataShare/accounts@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":33},"Microsoft.DataShare/accounts/shares/dataSets@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":98},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":264},"Microsoft.DataShare/accounts/shares/invitations@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":274},"Microsoft.DataShare/accounts/shares@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":288},"Microsoft.DataShare/accounts/shareSubscriptions@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":307},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":323},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":346},"Microsoft.DataShare/accounts@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":33},"Microsoft.DataShare/accounts/shares/dataSets@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":104},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":258},"Microsoft.DataShare/accounts/shares/invitations@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":268},"Microsoft.DataShare/accounts/shares@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":282},"Microsoft.DataShare/accounts/shareSubscriptions@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":301},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":317},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":340},"Microsoft.DeploymentManager/serviceTopologies@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":13},"Microsoft.DeploymentManager/serviceTopologies/services@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":19},"Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":29},"Microsoft.DeploymentManager/steps@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":38},"Microsoft.DeploymentManager/rollouts@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":69},"Microsoft.DeploymentManager/artifactSources@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":79},"Microsoft.DeploymentManager/serviceTopologies@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":13},"Microsoft.DeploymentManager/serviceTopologies/services@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":19},"Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":29},"Microsoft.DeploymentManager/steps@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":65},"Microsoft.DeploymentManager/rollouts@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":96},"Microsoft.DeploymentManager/artifactSources@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":106},"Microsoft.DesktopVirtualization/workspaces@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":32},"Microsoft.DesktopVirtualization/hostPools@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":54},"Microsoft.DesktopVirtualization/workspaces@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":32},"Microsoft.DesktopVirtualization/hostPools@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":58},"Microsoft.DesktopVirtualization/workspaces@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":32},"Microsoft.DesktopVirtualization/hostPools@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":58},"Microsoft.DesktopVirtualization/workspaces@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":35},"Microsoft.DesktopVirtualization/hostPools@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":70},"Microsoft.DesktopVirtualization/workspaces@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":35},"Microsoft.DesktopVirtualization/hostPools@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":66},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":75},"Microsoft.DesktopVirtualization/workspaces@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":35},"Microsoft.DesktopVirtualization/hostPools@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":66},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":75},"Microsoft.DesktopVirtualization/workspaces@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/scalingPlans@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":51},"Microsoft.DesktopVirtualization/applicationGroups@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":60},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":72},"Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":103},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":112},"Microsoft.DesktopVirtualization/workspaces@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":26},"Microsoft.DesktopVirtualization/scalingPlans@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":64},"Microsoft.DesktopVirtualization/applicationGroups@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":80},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":92},"Microsoft.DesktopVirtualization/hostPools@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":127},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":136},"Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":163},"Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":167},"Microsoft.DesktopVirtualization/workspaces@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":37},"Microsoft.DesktopVirtualization/scalingPlans@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":74},"Microsoft.DesktopVirtualization/applicationGroups@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":90},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":102},"Microsoft.DesktopVirtualization/hostPools@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":137},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":146},"Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":162},"Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":166},"Microsoft.DesktopVirtualization/workspaces@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":51},"Microsoft.DesktopVirtualization/scalingPlans@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":88},"Microsoft.DesktopVirtualization/applicationGroups@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":104},"Microsoft.DesktopVirtualization/applicationGroups/applications@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":116},"Microsoft.DesktopVirtualization/hostPools@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":168},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":177},"Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":181},"Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":185},"Microsoft.Devices/provisioningServices/certificates@2017-08-21-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":12},"Microsoft.Devices/provisioningServices@2017-08-21-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":49},"Microsoft.Devices/provisioningServices/certificates@2017-11-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":12},"Microsoft.Devices/provisioningServices@2017-11-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":49},"Microsoft.Devices/provisioningServices/certificates@2018-01-22":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":12},"Microsoft.Devices/provisioningServices@2018-01-22":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":49},"Microsoft.Devices/provisioningServices/certificates@2020-01-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":12},"Microsoft.Devices/provisioningServices@2020-01-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":58},"Microsoft.Devices/provisioningServices/certificates@2020-03-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":12},"Microsoft.Devices/provisioningServices@2020-03-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":71},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2020-03-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":75},"Microsoft.Devices/provisioningServices/certificates@2020-09-01-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":12},"Microsoft.Devices/provisioningServices@2020-09-01-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":78},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2020-09-01-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":82},"Microsoft.Devices/provisioningServices/certificates@2021-10-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":23},"Microsoft.Devices/provisioningServices@2021-10-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":82},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2021-10-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":86},"Microsoft.Devices/provisioningServices/certificates@2022-02-05":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":23},"Microsoft.Devices/provisioningServices@2022-02-05":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":82},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2022-02-05":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":86},"Microsoft.DeviceUpdate/accounts@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":57},"Microsoft.DeviceUpdate/accounts/instances@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":75},"Microsoft.DeviceUpdate/accounts/privateEndpointConnections@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":79},"Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":102},"Microsoft.DeviceUpdate/accounts@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":65},"Microsoft.DeviceUpdate/accounts/instances@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":83},"Microsoft.DeviceUpdate/accounts/privateEndpointConnections@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":87},"Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":110},"Microsoft.DevOps/pipelines@2019-07-01-preview":{"RelativePath":"devops/microsoft.devops/2019-07-01-preview/types.json","Index":27},"Microsoft.DevOps/pipelines@2020-07-13-preview":{"RelativePath":"devops/microsoft.devops/2020-07-13-preview/types.json","Index":42},"Microsoft.DevSpaces/controllers@2019-04-01":{"RelativePath":"devspaces/microsoft.devspaces/2019-04-01/types.json","Index":26},"Microsoft.DevTestLab/labs@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":17},"Microsoft.DevTestLab/labs/artifactsources@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":29},"Microsoft.DevTestLab/labs/customimages@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":51},"Microsoft.DevTestLab/labs/formulas@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":67},"Microsoft.DevTestLab/labs/policysets/policies@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":85},"Microsoft.DevTestLab/labs/schedules@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":102},"Microsoft.DevTestLab/labs/virtualmachines@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":107},"Microsoft.DevTestLab/labs/virtualnetworks@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":129},"Microsoft.DevTestLab/labs@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":19},"Microsoft.DevTestLab/schedules@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":36},"Microsoft.DevTestLab/labs/artifactsources@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":48},"Microsoft.DevTestLab/labs/costs@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":79},"Microsoft.DevTestLab/labs/customimages@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":101},"Microsoft.DevTestLab/labs/formulas@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":139},"Microsoft.DevTestLab/labs/notificationchannels@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":150},"Microsoft.DevTestLab/labs/policysets/policies@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":171},"Microsoft.DevTestLab/labs/schedules@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":176},"Microsoft.DevTestLab/labs/servicerunners@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":182},"Microsoft.DevTestLab/labs/users@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":190},"Microsoft.DevTestLab/labs/users/disks@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":199},"Microsoft.DevTestLab/labs/users/environments@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":208},"Microsoft.DevTestLab/labs/users/secrets@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":214},"Microsoft.DevTestLab/labs/virtualmachines@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":224},"Microsoft.DevTestLab/labs/virtualmachines/schedules@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":229},"Microsoft.DevTestLab/labs/virtualnetworks@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":259},"Microsoft.DevTestLab/labs@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":34},"Microsoft.DevTestLab/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":51},"Microsoft.DevTestLab/labs/artifactsources@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":64},"Microsoft.DevTestLab/labs/costs@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":95},"Microsoft.DevTestLab/labs/customimages@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":124},"Microsoft.DevTestLab/labs/formulas@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":165},"Microsoft.DevTestLab/labs/notificationchannels@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":176},"Microsoft.DevTestLab/labs/policysets/policies@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":199},"Microsoft.DevTestLab/labs/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":204},"Microsoft.DevTestLab/labs/servicerunners@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":215},"Microsoft.DevTestLab/labs/users@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":223},"Microsoft.DevTestLab/labs/users/disks@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":233},"Microsoft.DevTestLab/labs/users/environments@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":242},"Microsoft.DevTestLab/labs/users/secrets@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":248},"Microsoft.DevTestLab/labs/users/servicefabrics@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":259},"Microsoft.DevTestLab/labs/users/servicefabrics/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":264},"Microsoft.DevTestLab/labs/virtualmachines@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":284},"Microsoft.DevTestLab/labs/virtualmachines/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":289},"Microsoft.DevTestLab/labs/virtualnetworks@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":319},"Microsoft.Dynamics365FraudProtection/instances@2021-02-01-preview":{"RelativePath":"dfp/microsoft.dynamics365fraudprotection/2021-02-01-preview/types.json","Index":39},"Microsoft.DigitalTwins/digitalTwinsInstances@2020-03-01-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.json","Index":22},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-03-01-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.json","Index":40},"Microsoft.DigitalTwins/digitalTwinsInstances@2020-10-31":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-10-31/types.json","Index":24},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-10-31":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-10-31/types.json","Index":47},"Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-12-01/types.json","Index":48},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-12-01":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-12-01/types.json","Index":74},"Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2020-12-01":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-12-01/types.json","Index":78},"Microsoft.DigitalTwins/digitalTwinsInstances@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":59},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":85},"Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":89},"Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":108},"Microsoft.DelegatedNetwork/controller@2020-08-08-preview":{"RelativePath":"dnc/microsoft.delegatednetwork/2020-08-08-preview/types.json","Index":18},"Microsoft.DelegatedNetwork/orchestrators@2020-08-08-preview":{"RelativePath":"dnc/microsoft.delegatednetwork/2020-08-08-preview/types.json","Index":36},"Microsoft.DelegatedNetwork/delegatedSubnets@2020-08-08-preview":{"RelativePath":"dnc/microsoft.delegatednetwork/2020-08-08-preview/types.json","Index":48},"Microsoft.DelegatedNetwork/controller@2021-03-15":{"RelativePath":"dnc/microsoft.delegatednetwork/2021-03-15/types.json","Index":18},"Microsoft.DelegatedNetwork/orchestrators@2021-03-15":{"RelativePath":"dnc/microsoft.delegatednetwork/2021-03-15/types.json","Index":36},"Microsoft.DelegatedNetwork/delegatedSubnets@2021-03-15":{"RelativePath":"dnc/microsoft.delegatednetwork/2021-03-15/types.json","Index":48},"Microsoft.Network/dnszones/A@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":29},"Microsoft.Network/dnszones/AAAA@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":33},"Microsoft.Network/dnszones/CNAME@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":37},"Microsoft.Network/dnszones/MX@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":41},"Microsoft.Network/dnszones/NS@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":45},"Microsoft.Network/dnszones/PTR@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":49},"Microsoft.Network/dnszones/SOA@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":53},"Microsoft.Network/dnszones/SRV@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":57},"Microsoft.Network/dnszones/TXT@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":61},"Microsoft.Network/dnszones@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":67},"Microsoft.Network/dnsZones/A@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":30},"Microsoft.Network/dnsZones/AAAA@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":34},"Microsoft.Network/dnsZones/CNAME@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":38},"Microsoft.Network/dnsZones/MX@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":42},"Microsoft.Network/dnsZones/NS@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":46},"Microsoft.Network/dnsZones/PTR@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":50},"Microsoft.Network/dnsZones/SOA@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":54},"Microsoft.Network/dnsZones/SRV@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":58},"Microsoft.Network/dnsZones/TXT@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":62},"Microsoft.Network/dnsZones@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":72},"Microsoft.Network/dnsZones/A@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":32},"Microsoft.Network/dnsZones/AAAA@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":36},"Microsoft.Network/dnsZones/CAA@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":40},"Microsoft.Network/dnsZones/CNAME@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":44},"Microsoft.Network/dnsZones/MX@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":48},"Microsoft.Network/dnsZones/NS@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":52},"Microsoft.Network/dnsZones/PTR@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":56},"Microsoft.Network/dnsZones/SOA@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":60},"Microsoft.Network/dnsZones/SRV@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":64},"Microsoft.Network/dnsZones/TXT@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":68},"Microsoft.Network/dnsZones@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":78},"Microsoft.Network/dnsZones/A@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":32},"Microsoft.Network/dnsZones/AAAA@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":36},"Microsoft.Network/dnsZones/CAA@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":40},"Microsoft.Network/dnsZones/CNAME@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":44},"Microsoft.Network/dnsZones/MX@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":48},"Microsoft.Network/dnsZones/NS@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":52},"Microsoft.Network/dnsZones/PTR@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":56},"Microsoft.Network/dnsZones/SOA@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":60},"Microsoft.Network/dnsZones/SRV@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":64},"Microsoft.Network/dnsZones/TXT@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":68},"Microsoft.Network/dnsZones@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":78},"Microsoft.Network/dnsZones/A@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":32},"Microsoft.Network/dnsZones/AAAA@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":36},"Microsoft.Network/dnsZones/CAA@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":40},"Microsoft.Network/dnsZones/CNAME@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":44},"Microsoft.Network/dnsZones/MX@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":48},"Microsoft.Network/dnsZones/NS@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":52},"Microsoft.Network/dnsZones/PTR@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":56},"Microsoft.Network/dnsZones/SOA@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":60},"Microsoft.Network/dnsZones/SRV@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":64},"Microsoft.Network/dnsZones/TXT@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":68},"Microsoft.Network/dnsZones@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":81},"Microsoft.Network/dnsZones/A@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":33},"Microsoft.Network/dnsZones/AAAA@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":37},"Microsoft.Network/dnsZones/CAA@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":41},"Microsoft.Network/dnsZones/CNAME@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":45},"Microsoft.Network/dnsZones/MX@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":49},"Microsoft.Network/dnsZones/NS@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":53},"Microsoft.Network/dnsZones/PTR@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":57},"Microsoft.Network/dnsZones/SOA@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":61},"Microsoft.Network/dnsZones/SRV@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":65},"Microsoft.Network/dnsZones/TXT@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":69},"Microsoft.Network/dnsZones@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":81},"Microsoft.Network/dnsResolvers@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":35},"Microsoft.Network/dnsResolvers/inboundEndpoints@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":53},"Microsoft.Network/dnsResolvers/outboundEndpoints@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":66},"Microsoft.Network/dnsForwardingRulesets@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":80},"Microsoft.Network/dnsForwardingRulesets/forwardingRules@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":98},"Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":111},"Microsoft.AAD/domainServices@2017-01-01":{"RelativePath":"domainservices/microsoft.aad/2017-01-01/types.json","Index":46},"Microsoft.AAD/domainServices@2017-06-01":{"RelativePath":"domainservices/microsoft.aad/2017-06-01/types.json","Index":57},"Microsoft.Aad/domainServices/ouContainer@2017-06-01":{"RelativePath":"domainservices/microsoft.aad/2017-06-01/types.json","Index":65},"Microsoft.AAD/domainServices@2020-01-01":{"RelativePath":"domainservices/microsoft.aad/2020-01-01/types.json","Index":59},"Microsoft.Aad/domainServices/ouContainer@2020-01-01":{"RelativePath":"domainservices/microsoft.aad/2020-01-01/types.json","Index":67},"Microsoft.AAD/domainServices@2021-03-01":{"RelativePath":"domainservices/microsoft.aad/2021-03-01/types.json","Index":76},"Microsoft.Aad/domainServices/ouContainer@2021-03-01":{"RelativePath":"domainservices/microsoft.aad/2021-03-01/types.json","Index":84},"Microsoft.AAD/domainServices@2021-05-01":{"RelativePath":"domainservices/microsoft.aad/2021-05-01/types.json","Index":89},"Microsoft.Aad/domainServices/ouContainer@2021-05-01":{"RelativePath":"domainservices/microsoft.aad/2021-05-01/types.json","Index":97},"Microsoft.EdgeOrder/addresses@2020-12-01-preview":{"RelativePath":"edgeorder/microsoft.edgeorder/2020-12-01-preview/types.json","Index":31},"Microsoft.EdgeOrder/orderItems@2020-12-01-preview":{"RelativePath":"edgeorder/microsoft.edgeorder/2020-12-01-preview/types.json","Index":107},"Microsoft.EdgeOrder/addresses@2021-12-01":{"RelativePath":"edgeorder/microsoft.edgeorder/2021-12-01/types.json","Index":35},"Microsoft.EdgeOrder/orderItems@2021-12-01":{"RelativePath":"edgeorder/microsoft.edgeorder/2021-12-01/types.json","Index":111},"Microsoft.Education/labs@2021-12-01-preview":{"RelativePath":"education/microsoft.education/2021-12-01-preview/types.json","Index":28},"Microsoft.Education/labs/students@2021-12-01-preview":{"RelativePath":"education/microsoft.education/2021-12-01-preview/types.json","Index":42},"Microsoft.Elastic/monitors@2020-07-01-preview":{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2020-07-01-preview":{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":70},"Microsoft.Elastic/monitors@2020-07-01":{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2020-07-01":{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":70},"Microsoft.Elastic/monitors@2021-09-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2021-09-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":70},"Microsoft.Elastic/monitors@2021-10-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2021-10-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":70},"Microsoft.ElasticSan/elasticSans@2021-11-20-preview":{"RelativePath":"elasticsan/microsoft.elasticsan/2021-11-20-preview/types.json","Index":43},"Microsoft.ElasticSan/elasticSans/volumegroups@2021-11-20-preview":{"RelativePath":"elasticsan/microsoft.elasticsan/2021-11-20-preview/types.json","Index":75},"Microsoft.ElasticSan/elasticSans/volumegroups/volumes@2021-11-20-preview":{"RelativePath":"elasticsan/microsoft.elasticsan/2021-11-20-preview/types.json","Index":106},"Microsoft.EngagementFabric/Accounts@2018-09-01-preview":{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":13},"Microsoft.EngagementFabric/Accounts/Channels@2018-09-01-preview":{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":20},"Microsoft.EnterpriseKnowledgeGraph/services@2018-12-03":{"RelativePath":"enterpriseknowledgegraph/microsoft.enterpriseknowledgegraph/2018-12-03/types.json","Index":22},"Microsoft.EventGrid/eventSubscriptions@2017-06-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-06-15-preview/types.json","Index":26},"Microsoft.EventGrid/topics@2017-06-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-06-15-preview/types.json","Index":39},"Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-09-15-preview/types.json","Index":29},"Microsoft.EventGrid/topics@2017-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-09-15-preview/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2018-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-01-01/types.json","Index":29},"Microsoft.EventGrid/topics@2018-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-01-01/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-05-01-preview/types.json","Index":45},"Microsoft.EventGrid/topics@2018-05-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-05-01-preview/types.json","Index":68},"Microsoft.EventGrid/domains@2018-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":30},"Microsoft.EventGrid/eventSubscriptions@2018-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":101},"Microsoft.EventGrid/topics@2018-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":118},"Microsoft.EventGrid/eventSubscriptions@2019-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-01-01/types.json","Index":41},"Microsoft.EventGrid/topics@2019-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-01-01/types.json","Index":54},"Microsoft.EventGrid/domains@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":30},"Microsoft.EventGrid/domains/topics@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":116},"Microsoft.EventGrid/topics@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":133},"Microsoft.EventGrid/domains@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":20},"Microsoft.EventGrid/domains/topics@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":32},"Microsoft.EventGrid/eventSubscriptions@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":102},"Microsoft.EventGrid/topics@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":115},"Microsoft.EventGrid/domains@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":30},"Microsoft.EventGrid/domains/topics@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":122},"Microsoft.EventGrid/topics@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":139},"Microsoft.EventGrid/domains@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":67},"Microsoft.EventGrid/domains/topics@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":79},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":143},"Microsoft.EventGrid/eventSubscriptions@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":197},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":201},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":205},"Microsoft.EventGrid/partnerNamespaces@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":218},"Microsoft.EventGrid/partnerRegistrations@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":236},"Microsoft.EventGrid/topics/privateEndpointConnections@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":240},"Microsoft.EventGrid/domains/privateEndpointConnections@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":244},"Microsoft.EventGrid/systemTopics@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":257},"Microsoft.EventGrid/topics@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":279},"Microsoft.EventGrid/domains@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":66},"Microsoft.EventGrid/domains/topics@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":78},"Microsoft.EventGrid/eventSubscriptions@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":158},"Microsoft.EventGrid/topics@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":180},"Microsoft.EventGrid/topics/privateEndpointConnections@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":184},"Microsoft.EventGrid/domains/privateEndpointConnections@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":188},"Microsoft.EventGrid/domains@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":78},"Microsoft.EventGrid/domains/topics@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":90},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":164},"Microsoft.EventGrid/eventSubscriptions@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":232},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":236},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":240},"Microsoft.EventGrid/partnerNamespaces@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":253},"Microsoft.EventGrid/partnerRegistrations@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":271},"Microsoft.EventGrid/topics/privateEndpointConnections@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":275},"Microsoft.EventGrid/domains/privateEndpointConnections@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":279},"Microsoft.EventGrid/systemTopics@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":292},"Microsoft.EventGrid/topics@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":318},"Microsoft.EventGrid/domains@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":78},"Microsoft.EventGrid/domains/topics@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":90},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":164},"Microsoft.EventGrid/eventSubscriptions@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":231},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":235},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":239},"Microsoft.EventGrid/partnerNamespaces@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":257},"Microsoft.EventGrid/partnerRegistrations@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":275},"Microsoft.EventGrid/topics/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":279},"Microsoft.EventGrid/domains/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":283},"Microsoft.EventGrid/partnerNamespaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":287},"Microsoft.EventGrid/systemTopics@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":300},"Microsoft.EventGrid/topics@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":326},"Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":52},"Microsoft.EventGrid/domains@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":115},"Microsoft.EventGrid/domains/topics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":127},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":201},"Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":271},"Microsoft.EventGrid/domains/topics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":275},"Microsoft.EventGrid/topics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":279},"Microsoft.EventGrid/domains/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":283},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":287},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":291},"Microsoft.EventGrid/partnerConfigurations@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":308},"Microsoft.EventGrid/partnerDestinations@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":324},"Microsoft.EventGrid/partnerNamespaces@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":345},"Microsoft.EventGrid/partnerRegistrations@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":363},"Microsoft.EventGrid/partnerTopics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":380},"Microsoft.EventGrid/topics/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":384},"Microsoft.EventGrid/domains/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":388},"Microsoft.EventGrid/partnerNamespaces/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":392},"Microsoft.EventGrid/systemTopics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":405},"Microsoft.EventGrid/topics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":434},"Microsoft.EventGrid/domains@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":74},"Microsoft.EventGrid/domains/topics@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":86},"Microsoft.EventGrid/eventSubscriptions@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":206},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":210},"Microsoft.EventGrid/topics@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":232},"Microsoft.EventGrid/topics/privateEndpointConnections@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":236},"Microsoft.EventGrid/domains/privateEndpointConnections@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":240},"Microsoft.EventGrid/systemTopics@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":253},"Microsoft.EventHub/namespaces@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":35},"Microsoft.EventHub/namespaces/AuthorizationRules@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":45},"Microsoft.EventHub/namespaces/eventhubs@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":61},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":65},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":70},"Microsoft.EventHub/namespaces@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":35},"Microsoft.EventHub/namespaces/AuthorizationRules@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":45},"Microsoft.EventHub/namespaces/eventhubs@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":61},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":65},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":70},"Microsoft.EventHub/namespaces/authorizationRules@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":17},"Microsoft.EventHub/namespaces@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":30},"Microsoft.EventHub/namespaces/networkRuleSets@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":46},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":59},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":63},"Microsoft.EventHub/namespaces/eventhubs@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":85},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":90},"Microsoft.EventHub/clusters@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":16},"Microsoft.EventHub/namespaces/ipfilterrules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":24},"Microsoft.EventHub/namespaces@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":43},"Microsoft.EventHub/namespaces/virtualnetworkrules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":48},"Microsoft.EventHub/namespaces/networkRuleSets@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":64},"Microsoft.EventHub/namespaces/authorizationRules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":74},"Microsoft.EventHub/namespaces/privateEndpointConnections@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":93},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":106},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":110},"Microsoft.EventHub/namespaces/eventhubs@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":132},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":137},"Microsoft.EventHub/namespaces@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":63},"Microsoft.EventHub/namespaces/networkRuleSets@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":79},"Microsoft.EventHub/namespaces/authorizationRules@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":89},"Microsoft.EventHub/namespaces/privateEndpointConnections@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":93},"Microsoft.EventHub/namespaces/eventhubs@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":115},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":119},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":132},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":137},"Microsoft.EventHub/clusters@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":27},"Microsoft.EventHub/namespaces@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":72},"Microsoft.EventHub/namespaces/networkRuleSets@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":91},"Microsoft.EventHub/namespaces/authorizationRules@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":101},"Microsoft.EventHub/namespaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":105},"Microsoft.EventHub/namespaces/eventhubs@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":127},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":131},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":144},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":149},"Microsoft.EventHub/clusters@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":27},"Microsoft.EventHub/namespaces@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":72},"Microsoft.EventHub/namespaces/networkRuleSets@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":91},"Microsoft.EventHub/namespaces/authorizationRules@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":101},"Microsoft.EventHub/namespaces/privateEndpointConnections@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":105},"Microsoft.EventHub/namespaces/eventhubs@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":127},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":131},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":144},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":149},"Microsoft.EventHub/namespaces/schemagroups@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":162},"Microsoft.ExtendedLocation/customLocations@2021-03-15-preview":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-03-15-preview/types.json","Index":28},"Microsoft.ExtendedLocation/customLocations@2021-08-15":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-08-15/types.json","Index":32},"Microsoft.ExtendedLocation/customLocations@2021-08-31-preview":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.json","Index":32},"Microsoft.ExtendedLocation/customLocations/resourceSyncRules@2021-08-31-preview":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.json","Index":43},"Microsoft.FluidRelay/fluidRelayServers@2021-03-12-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-03-12-preview/types.json","Index":31},"Microsoft.FluidRelay/fluidRelayServers@2021-06-15-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-06-15-preview/types.json","Index":35},"Microsoft.FluidRelay/fluidRelayServers@2021-08-30-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-08-30-preview/types.json","Index":35},"Microsoft.FluidRelay/fluidRelayServers@2021-09-10-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-09-10-preview/types.json","Index":39},"Microsoft.FluidRelay/fluidRelayServers@2022-02-15":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2022-02-15/types.json","Index":39},"Microsoft.Network/frontDoors@2018-08-01":{"RelativePath":"frontdoor/microsoft.network/2018-08-01/types.json","Index":134},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2018-08-01":{"RelativePath":"frontdoor/microsoft.network/2018-08-01/types.json","Index":210},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2019-03-01":{"RelativePath":"frontdoor/microsoft.network/2019-03-01/types.json","Index":91},"Microsoft.Network/frontDoors@2019-04-01":{"RelativePath":"frontdoor/microsoft.network/2019-04-01/types.json","Index":152},"Microsoft.Network/frontDoors@2019-05-01":{"RelativePath":"frontdoor/microsoft.network/2019-05-01/types.json","Index":161},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2019-10-01":{"RelativePath":"frontdoor/microsoft.network/2019-10-01/types.json","Index":107},"Microsoft.Network/NetworkExperimentProfiles@2019-11-01":{"RelativePath":"frontdoor/microsoft.network/2019-11-01/types.json","Index":23},"Microsoft.Network/NetworkExperimentProfiles/Experiments@2019-11-01":{"RelativePath":"frontdoor/microsoft.network/2019-11-01/types.json","Index":40},"Microsoft.Network/frontDoors@2020-01-01":{"RelativePath":"frontdoor/microsoft.network/2020-01-01/types.json","Index":228},"Microsoft.Network/frontDoors/rulesEngines@2020-01-01":{"RelativePath":"frontdoor/microsoft.network/2020-01-01/types.json","Index":232},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2020-04-01":{"RelativePath":"frontdoor/microsoft.network/2020-04-01/types.json","Index":109},"Microsoft.Network/frontDoors@2020-04-01":{"RelativePath":"frontdoor/microsoft.network/2020-04-01/types.json","Index":331},"Microsoft.Network/frontDoors/rulesEngines@2020-04-01":{"RelativePath":"frontdoor/microsoft.network/2020-04-01/types.json","Index":335},"Microsoft.Network/frontDoors@2020-05-01":{"RelativePath":"frontdoor/microsoft.network/2020-05-01/types.json","Index":229},"Microsoft.Network/frontDoors/rulesEngines@2020-05-01":{"RelativePath":"frontdoor/microsoft.network/2020-05-01/types.json","Index":233},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2020-11-01":{"RelativePath":"frontdoor/microsoft.network/2020-11-01/types.json","Index":124},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-01-20-preview":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2018-01-20-preview/types.json","Index":24},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-06-30-preview":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2018-06-30-preview/types.json","Index":34},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2018-11-20/types.json","Index":46},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2020-06-25/types.json","Index":65},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2021-01-25/types.json","Index":76},"Microsoft.HanaOnAzure/hanaInstances@2017-11-03-preview":{"RelativePath":"hanaonazure/microsoft.hanaonazure/2017-11-03-preview/types.json","Index":85},"Microsoft.HanaOnAzure/sapMonitors@2020-02-07-preview":{"RelativePath":"hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.json","Index":21},"Microsoft.HanaOnAzure/sapMonitors/providerInstances@2020-02-07-preview":{"RelativePath":"hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.json","Index":34},"Microsoft.HardwareSecurityModules/dedicatedHSMs@2018-10-31-preview":{"RelativePath":"hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2018-10-31-preview/types.json","Index":35},"Microsoft.HardwareSecurityModules/dedicatedHSMs@2021-11-30":{"RelativePath":"hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2021-11-30/types.json","Index":46},"Microsoft.HDInsight/clusters@2015-03-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2015-03-01-preview/types.json","Index":94},"Microsoft.HDInsight/clusters/applications@2015-03-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2015-03-01-preview/types.json","Index":110},"Microsoft.HDInsight/clusters@2018-06-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2018-06-01-preview/types.json","Index":94},"Microsoft.HDInsight/clusters/applications@2018-06-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2018-06-01-preview/types.json","Index":110},"Microsoft.HDInsight/clusters@2021-06-01":{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":146},"Microsoft.HDInsight/clusters/applications@2021-06-01":{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":163},"Microsoft.HDInsight/clusters/privateEndpointConnections@2021-06-01":{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":167},"Microsoft.HealthBot/healthBots@2020-10-20-preview":{"RelativePath":"healthbot/microsoft.healthbot/2020-10-20-preview/types.json","Index":31},"Microsoft.HealthBot/healthBots@2020-10-20":{"RelativePath":"healthbot/microsoft.healthbot/2020-10-20/types.json","Index":31},"Microsoft.HealthBot/healthBots@2020-12-08-preview":{"RelativePath":"healthbot/microsoft.healthbot/2020-12-08-preview/types.json","Index":32},"Microsoft.HealthBot/healthBots@2020-12-08":{"RelativePath":"healthbot/microsoft.healthbot/2020-12-08/types.json","Index":29},"Microsoft.HealthBot/healthBots@2021-06-10":{"RelativePath":"healthbot/microsoft.healthbot/2021-06-10/types.json","Index":37},"Microsoft.HealthBot/healthBots@2021-08-24":{"RelativePath":"healthbot/microsoft.healthbot/2021-08-24/types.json","Index":38},"Microsoft.HealthcareApis/services@2018-08-20-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2018-08-20-preview/types.json","Index":39},"Microsoft.HealthcareApis/services@2019-09-16":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2019-09-16/types.json","Index":40},"Microsoft.HealthcareApis/services@2020-03-15":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2020-03-15/types.json","Index":40},"Microsoft.HealthcareApis/services@2020-03-30":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2020-03-30/types.json","Index":57},"Microsoft.HealthcareApis/services/privateEndpointConnections@2020-03-30":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2020-03-30/types.json","Index":61},"Microsoft.HealthcareApis/services@2021-01-11":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-01-11/types.json","Index":70},"Microsoft.HealthcareApis/services/privateEndpointConnections@2021-01-11":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-01-11/types.json","Index":74},"Microsoft.HealthcareApis/services@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":74},"Microsoft.HealthcareApis/services/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":78},"Microsoft.HealthcareApis/workspaces@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":98},"Microsoft.HealthcareApis/workspaces/dicomservices@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":120},"Microsoft.HealthcareApis/workspaces/iotconnectors@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":146},"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":168},"Microsoft.HealthcareApis/workspaces/fhirservices@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":201},"Microsoft.HealthcareApis/services@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":76},"Microsoft.HealthcareApis/services/privateEndpointConnections@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":80},"Microsoft.HealthcareApis/workspaces@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":104},"Microsoft.HealthcareApis/workspaces/dicomservices@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":138},"Microsoft.HealthcareApis/workspaces/iotconnectors@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":160},"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":182},"Microsoft.HealthcareApis/workspaces/fhirservices@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":234},"Microsoft.HealthcareApis/workspaces/privateEndpointConnections@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":238},"Microsoft.HealthcareApis/services@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":77},"Microsoft.HealthcareApis/services/privateEndpointConnections@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":81},"Microsoft.HealthcareApis/workspaces@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":105},"Microsoft.HealthcareApis/workspaces/dicomservices@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":139},"Microsoft.HealthcareApis/workspaces/iotconnectors@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":161},"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":183},"Microsoft.HealthcareApis/workspaces/fhirservices@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":236},"Microsoft.HealthcareApis/workspaces/privateEndpointConnections@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":240},"Microsoft.HybridCompute/machines@2019-03-18-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-03-18-preview/types.json","Index":22},"Microsoft.HybridCompute/machines@2019-08-02-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.json","Index":29},"Microsoft.HybridCompute/machines/extensions@2019-08-02-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.json","Index":35},"Microsoft.HybridCompute/machines@2019-12-12":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-12-12/types.json","Index":31},"Microsoft.HybridCompute/machines/extensions@2019-12-12":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-12-12/types.json","Index":38},"Microsoft.HybridCompute/machines@2020-07-30-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.json","Index":30},"Microsoft.HybridCompute/machines/extensions@2020-07-30-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.json","Index":37},"Microsoft.HybridCompute/machines@2020-08-02":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-02/types.json","Index":30},"Microsoft.HybridCompute/machines/extensions@2020-08-02":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-02/types.json","Index":37},"Microsoft.HybridCompute/machines@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":31},"Microsoft.HybridCompute/machines/extensions@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":38},"Microsoft.HybridCompute/privateLinkScopes@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":52},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":56},"Microsoft.HybridCompute/privateLinkScopes/scopedResources@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":61},"Microsoft.HybridCompute/machines@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":44},"Microsoft.HybridCompute/machines/extensions@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":50},"Microsoft.HybridCompute/privateLinkScopes@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":59},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":66},"Microsoft.HybridCompute/machines@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":60},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":67},"Microsoft.HybridCompute/machines@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":60},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":67},"Microsoft.HybridCompute/machines@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":65},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":69},"Microsoft.HybridCompute/machines@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":60},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":67},"Microsoft.HybridCompute/machines@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":48},"Microsoft.HybridCompute/machines/extensions@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":54},"Microsoft.HybridCompute/privateLinkScopes@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":68},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":72},"Microsoft.HybridCompute/machines@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":51},"Microsoft.HybridCompute/machines/extensions@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":57},"Microsoft.HybridCompute/privateLinkScopes@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":71},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":75},"Microsoft.HybridCompute/machines@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":65},"Microsoft.HybridCompute/machines/extensions@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":71},"Microsoft.HybridCompute/privateLinkScopes@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":86},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":90},"Microsoft.HybridConnectivity/endpoints@2021-10-06-preview":{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.json","Index":26},"Microsoft.HybridConnectivity/endpoints@2022-05-01-preview":{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.json","Index":26},"Microsoft.HybridData/dataManagers@2016-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2016-06-01/types.json","Index":13},"Microsoft.HybridData/dataManagers/dataServices/jobDefinitions@2016-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2016-06-01/types.json","Index":63},"Microsoft.HybridData/dataManagers/dataStores@2016-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2016-06-01/types.json","Index":73},"Microsoft.HybridData/dataManagers@2019-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2019-06-01/types.json","Index":13},"Microsoft.HybridData/dataManagers/dataServices/jobDefinitions@2019-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2019-06-01/types.json","Index":63},"Microsoft.HybridData/dataManagers/dataStores@2019-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2019-06-01/types.json","Index":73},"Microsoft.Kubernetes/connectedClusters@2020-01-01-preview":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.json","Index":31},"Microsoft.Kubernetes/connectedClusters@2021-03-01":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-03-01/types.json","Index":41},"Microsoft.Kubernetes/connectedClusters@2021-04-01-preview":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.json","Index":44},"Microsoft.Kubernetes/connectedClusters@2021-10-01":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-10-01/types.json","Index":41},"Microsoft.HybridNetwork/networkFunctions@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":54},"Microsoft.HybridNetwork/devices@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":76},"Microsoft.HybridNetwork/vendors@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":90},"Microsoft.HybridNetwork/vendors/vendorSkus@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":166},"Microsoft.HybridNetwork/vendors/vendorSkus/previewSubscriptions@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":170},"Microsoft.HybridNetwork/locations/vendors/networkFunctions@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":198},"Microsoft.HybridNetwork/networkFunctions@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":65},"Microsoft.HybridNetwork/devices@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":87},"Microsoft.HybridNetwork/vendors@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":101},"Microsoft.HybridNetwork/vendors/vendorSkus@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":181},"Microsoft.HybridNetwork/vendors/vendorSkus/previewSubscriptions@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":194},"Microsoft.HybridNetwork/locations/vendors/networkFunctions@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":222},"Microsoft.HybridNetwork/devices@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":41},"Microsoft.HybridNetwork/networkFunctions@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":87},"Microsoft.HybridNetwork/vendors@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":101},"Microsoft.HybridNetwork/vendors/vendorSkus@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":181},"Microsoft.HybridNetwork/vendors/vendorSkus/previewSubscriptions@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":194},"Microsoft.HybridNetwork/locations/vendors/networkFunctions@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":222},"Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2018-02-01-preview/types.json","Index":56},"Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2019-02-01-preview/types.json","Index":70},"Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2019-05-01-preview/types.json","Index":83},"Microsoft.VirtualMachineImages/imageTemplates@2020-02-14":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2020-02-14/types.json","Index":90},"Microsoft.VirtualMachineImages/imageTemplates@2021-10-01":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2021-10-01/types.json","Index":102},"Microsoft.Intune/locations/iosPolicies@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":55},"Microsoft.Intune/locations/iosPolicies/apps@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":60},"Microsoft.Intune/locations/iosPolicies/groups@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":64},"Microsoft.Intune/locations/androidPolicies@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":110},"Microsoft.Intune/locations/androidPolicies/apps@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":114},"Microsoft.Intune/locations/androidPolicies/groups@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":118},"Microsoft.IoTCentral/iotApps@2018-09-01":{"RelativePath":"iotcentral/microsoft.iotcentral/2018-09-01/types.json","Index":20},"Microsoft.IoTCentral/iotApps@2021-06-01":{"RelativePath":"iotcentral/microsoft.iotcentral/2021-06-01/types.json","Index":25},"Microsoft.IoTCentral/iotApps@2021-11-01-preview":{"RelativePath":"iotcentral/microsoft.iotcentral/2021-11-01-preview/types.json","Index":67},"Microsoft.IoTCentral/iotApps/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"iotcentral/microsoft.iotcentral/2021-11-01-preview/types.json","Index":71},"Microsoft.Devices/IotHubs@2016-02-03":{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":64},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2016-02-03":{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":69},"Microsoft.Devices/IotHubs@2017-01-19":{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":87},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2017-01-19":{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":92},"Microsoft.Devices/IotHubs@2017-07-01":{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":89},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2017-07-01":{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":94},"Microsoft.Devices/IotHubs/certificates@2017-07-01":{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":99},"Microsoft.Devices/IotHubs@2018-01-22":{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":89},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2018-01-22":{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":94},"Microsoft.Devices/IotHubs/certificates@2018-01-22":{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":99},"Microsoft.Devices/IotHubs@2018-04-01":{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":95},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2018-04-01":{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":100},"Microsoft.Devices/IotHubs/certificates@2018-04-01":{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":105},"Microsoft.Devices/IotHubs@2018-12-01-preview":{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":99},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2018-12-01-preview":{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":104},"Microsoft.Devices/IotHubs/certificates@2018-12-01-preview":{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":109},"Microsoft.Devices/IotHubs@2019-03-22-preview":{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":102},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-03-22-preview":{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":107},"Microsoft.Devices/IotHubs/certificates@2019-03-22-preview":{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":112},"Microsoft.Devices/IotHubs@2019-03-22":{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":97},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-03-22":{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":102},"Microsoft.Devices/IotHubs/certificates@2019-03-22":{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":107},"Microsoft.Devices/IotHubs@2019-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":104},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":109},"Microsoft.Devices/IotHubs/certificates@2019-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":114},"Microsoft.Devices/IotHubs@2019-11-04":{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":100},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-11-04":{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":105},"Microsoft.Devices/IotHubs/certificates@2019-11-04":{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":110},"Microsoft.Devices/IotHubs@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":139},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":144},"Microsoft.Devices/IotHubs/certificates@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":149},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":153},"Microsoft.Devices/IotHubs@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":147},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":152},"Microsoft.Devices/IotHubs/certificates@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":157},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":161},"Microsoft.Devices/IotHubs@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":136},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":141},"Microsoft.Devices/IotHubs/certificates@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":146},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":150},"Microsoft.Devices/IotHubs@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":154},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":159},"Microsoft.Devices/IotHubs/certificates@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":164},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":168},"Microsoft.Devices/IotHubs@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":154},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":159},"Microsoft.Devices/IotHubs/certificates@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":164},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":168},"Microsoft.Devices/IotHubs@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":147},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":152},"Microsoft.Devices/IotHubs/certificates@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":157},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":161},"Microsoft.Devices/IotHubs@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":157},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":162},"Microsoft.Devices/IotHubs/certificates@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":167},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":171},"Microsoft.Devices/IotHubs@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":148},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":153},"Microsoft.Devices/IotHubs/certificates@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":158},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":162},"Microsoft.Devices/IotHubs@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":168},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":173},"Microsoft.Devices/IotHubs/certificates@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":178},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":182},"Microsoft.Devices/IotHubs@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":159},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":164},"Microsoft.Devices/IotHubs/certificates@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":169},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":173},"Microsoft.IoTSecurity/defenderSettings@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":23},"Microsoft.IoTSecurity/sites@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":41},"Microsoft.IoTSecurity/sensors@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":58},"Microsoft.IoTSecurity/onPremiseSensors@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":62},"Microsoft.IoTSecurity/locations/deviceGroups@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":66},"Microsoft.KeyVault/vaults@2015-06-01":{"RelativePath":"keyvault/microsoft.keyvault/2015-06-01/types.json","Index":69},"Microsoft.KeyVault/vaults/secrets@2016-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2016-10-01/types.json","Index":14},"Microsoft.KeyVault/vaults@2016-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2016-10-01/types.json","Index":92},"Microsoft.KeyVault/vaults/accessPolicies@2016-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2016-10-01/types.json","Index":102},"Microsoft.KeyVault/vaults/secrets@2018-02-14-preview":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14-preview/types.json","Index":14},"Microsoft.KeyVault/vaults@2018-02-14-preview":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14-preview/types.json","Index":105},"Microsoft.KeyVault/vaults/accessPolicies@2018-02-14-preview":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14-preview/types.json","Index":115},"Microsoft.KeyVault/vaults/secrets@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":14},"Microsoft.KeyVault/vaults@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":122},"Microsoft.KeyVault/vaults/accessPolicies@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":132},"Microsoft.KeyVault/vaults/privateEndpointConnections@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":137},"Microsoft.KeyVault/vaults/secrets@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":14},"Microsoft.KeyVault/vaults@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":129},"Microsoft.KeyVault/vaults/accessPolicies@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":139},"Microsoft.KeyVault/vaults/privateEndpointConnections@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":144},"Microsoft.KeyVault/vaults/keys@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":175},"Microsoft.KeyVault/managedHSMs@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":32},"Microsoft.KeyVault/vaults/keys@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":63},"Microsoft.KeyVault/vaults@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":187},"Microsoft.KeyVault/vaults/accessPolicies@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":197},"Microsoft.KeyVault/vaults/privateEndpointConnections@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":202},"Microsoft.KeyVault/vaults/secrets@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":209},"Microsoft.KeyVault/vaults@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":132},"Microsoft.KeyVault/vaults/accessPolicies@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":142},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":147},"Microsoft.KeyVault/managedHSMs@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":205},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":210},"Microsoft.KeyVault/vaults/keys@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":250},"Microsoft.KeyVault/vaults/secrets@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":257},"Microsoft.KeyVault/vaults/keys@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":49},"Microsoft.KeyVault/vaults@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":181},"Microsoft.KeyVault/vaults/accessPolicies@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":191},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":196},"Microsoft.KeyVault/managedHSMs@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":254},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":259},"Microsoft.KeyVault/vaults/secrets@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":266},"Microsoft.KeyVault/vaults/keys@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":38},"Microsoft.KeyVault/vaults@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":166},"Microsoft.KeyVault/vaults/accessPolicies@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":176},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":181},"Microsoft.KeyVault/managedHSMs@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":239},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":244},"Microsoft.KeyVault/vaults/secrets@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":251},"Microsoft.KeyVault/vaults/keys@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":49},"Microsoft.KeyVault/vaults@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":181},"Microsoft.KeyVault/vaults/accessPolicies@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":191},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":196},"Microsoft.KeyVault/managedHSMs@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":254},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":259},"Microsoft.KeyVault/vaults/secrets@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":266},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2019-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2019-11-01-preview/types.json","Index":38},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2020-07-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.json","Index":37},"Microsoft.KubernetesConfiguration/extensions@2020-07-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.json","Index":62},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2020-10-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-10-01-preview/types.json","Index":37},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2021-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-03-01/types.json","Index":47},"Microsoft.KubernetesConfiguration/extensions@2021-05-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.json","Index":48},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2021-05-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.json","Index":77},"Microsoft.KubernetesConfiguration/extensions@2021-09-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-09-01/types.json","Index":50},"Microsoft.KubernetesConfiguration/extensions@2021-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.json","Index":50},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2021-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.json","Index":79},"Microsoft.KubernetesConfiguration/fluxConfigurations@2021-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.json","Index":125},"Microsoft.KubernetesConfiguration/extensions@2022-01-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.json","Index":50},"Microsoft.KubernetesConfiguration/fluxConfigurations@2022-01-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.json","Index":94},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2022-01-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.json","Index":123},"Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.json","Index":61},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2022-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.json","Index":90},"Microsoft.KubernetesConfiguration/extensions@2022-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.json","Index":124},"Microsoft.KubernetesConfiguration/extensions@2022-04-02-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.json","Index":53},"Microsoft.KubernetesConfiguration/privateLinkScopes@2022-04-02-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.json","Index":83},"Microsoft.KubernetesConfiguration/privateLinkScopes/privateEndpointConnections@2022-04-02-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.json","Index":87},"Microsoft.LabServices/labaccounts@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":23},"Microsoft.LabServices/labaccounts/galleryimages@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":30},"Microsoft.LabServices/labaccounts/labs@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":39},"Microsoft.LabServices/labaccounts/labs/environmentsettings@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":61},"Microsoft.LabServices/labaccounts/labs/environmentsettings/environments@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":69},"Microsoft.LabServices/labaccounts/labs/users@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":75},"Microsoft.LabServices/labPlans@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":62},"Microsoft.LabServices/labPlans/images@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":87},"Microsoft.LabServices/labs@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":134},"Microsoft.LabServices/labs/users@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":154},"Microsoft.LabServices/labs/schedules@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":179},"Microsoft.LabServices/labPlans/images@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":43},"Microsoft.LabServices/labPlans@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":87},"Microsoft.LabServices/labs@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":134},"Microsoft.LabServices/labs/schedules@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":159},"Microsoft.LabServices/labs/users@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":179},"Microsoft.LoadTestService/loadTests@2021-12-01-preview":{"RelativePath":"loadtestservice/microsoft.loadtestservice/2021-12-01-preview/types.json","Index":33},"Microsoft.LoadTestService/loadTests@2022-04-15-preview":{"RelativePath":"loadtestservice/microsoft.loadtestservice/2022-04-15-preview/types.json","Index":42},"Microsoft.Logic/workflows@2015-02-01-preview":{"RelativePath":"logic/microsoft.logic/2015-02-01-preview/types.json","Index":46},"Microsoft.Logic/workflows/accessKeys@2015-02-01-preview":{"RelativePath":"logic/microsoft.logic/2015-02-01-preview/types.json","Index":51},"Microsoft.Logic/integrationAccounts@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":20},"Microsoft.Logic/integrationAccounts/schemas@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":31},"Microsoft.Logic/integrationAccounts/maps@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":40},"Microsoft.Logic/integrationAccounts/partners@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":53},"Microsoft.Logic/integrationAccounts/agreements@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":234},"Microsoft.Logic/integrationAccounts/certificates@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":242},"Microsoft.Logic/workflows@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":60},"Microsoft.Logic/integrationAccounts@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":70},"Microsoft.Logic/integrationAccounts/assemblies@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":78},"Microsoft.Logic/integrationAccounts/batchConfigurations@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":118},"Microsoft.Logic/integrationAccounts/schemas@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":127},"Microsoft.Logic/integrationAccounts/maps@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":137},"Microsoft.Logic/integrationAccounts/partners@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":150},"Microsoft.Logic/integrationAccounts/agreements@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":340},"Microsoft.Logic/integrationAccounts/certificates@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":348},"Microsoft.Logic/integrationAccounts/sessions@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":354},"Microsoft.Logic/integrationAccounts/rosettanetprocessconfigurations@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":392},"Microsoft.Logic/workflows@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":60},"Microsoft.Logic/integrationAccounts@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":71},"Microsoft.Logic/integrationAccounts/assemblies@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":79},"Microsoft.Logic/integrationAccounts/batchConfigurations@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":119},"Microsoft.Logic/integrationAccounts/schemas@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":128},"Microsoft.Logic/integrationAccounts/maps@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":141},"Microsoft.Logic/integrationAccounts/partners@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":154},"Microsoft.Logic/integrationAccounts/agreements@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":344},"Microsoft.Logic/integrationAccounts/certificates@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":352},"Microsoft.Logic/integrationAccounts/sessions@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":358},"Microsoft.Logic/workflows@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":87},"Microsoft.Logic/integrationAccounts@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":106},"Microsoft.Logic/integrationAccounts/assemblies@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":114},"Microsoft.Logic/integrationAccounts/batchConfigurations@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":154},"Microsoft.Logic/integrationAccounts/schemas@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":163},"Microsoft.Logic/integrationAccounts/maps@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":176},"Microsoft.Logic/integrationAccounts/partners@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":189},"Microsoft.Logic/integrationAccounts/agreements@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":379},"Microsoft.Logic/integrationAccounts/certificates@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":387},"Microsoft.Logic/integrationAccounts/sessions@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":393},"Microsoft.Logic/integrationServiceEnvironments@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":443},"Microsoft.Logic/integrationServiceEnvironments/managedApis@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":531},"Microsoft.Logz/monitors@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":50},"Microsoft.Logz/monitors/tagRules@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":71},"Microsoft.Logz/monitors/singleSignOnConfigurations@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":91},"Microsoft.Logz/monitors/accounts@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":96},"Microsoft.Logz/monitors/accounts/tagRules@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":100},"Microsoft.Logz/monitors@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":50},"Microsoft.Logz/monitors/tagRules@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":71},"Microsoft.Logz/monitors/singleSignOnConfigurations@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":91},"Microsoft.Logz/monitors/accounts@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":96},"Microsoft.Logz/monitors/accounts/tagRules@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":100},"Microsoft.Logz/monitors@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":50},"Microsoft.Logz/monitors/tagRules@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":71},"Microsoft.Logz/monitors/singleSignOnConfigurations@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":91},"Microsoft.Logz/monitors/accounts@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":96},"Microsoft.Logz/monitors/accounts/tagRules@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":100},"Microsoft.Logz/monitors/metricsSource@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":105},"Microsoft.Logz/monitors/metricsSource/tagRules@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":123},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForEDMUpload@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":68},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForEDMUpload/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":72},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":81},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":85},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365SecurityCenter@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":94},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365SecurityCenter/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":98},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":107},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":111},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":120},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":124},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForMIPPolicySync@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":133},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForMIPPolicySync/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":137},"Microsoft.MachineLearning/workspaces@2016-04-01":{"RelativePath":"machinelearning/microsoft.machinelearning/2016-04-01/types.json","Index":27},"Microsoft.MachineLearning/commitmentPlans@2016-05-01-preview":{"RelativePath":"machinelearning/microsoft.machinelearning/2016-05-01-preview/types.json","Index":16},"Microsoft.MachineLearning/webServices@2016-05-01-preview":{"RelativePath":"machinelearning/microsoft.machinelearning/2016-05-01-preview/types.json","Index":117},"Microsoft.MachineLearning/webServices@2017-01-01":{"RelativePath":"machinelearning/microsoft.machinelearning/2017-01-01/types.json","Index":109},"Microsoft.MachineLearning/workspaces@2019-10-01":{"RelativePath":"machinelearning/microsoft.machinelearning/2019-10-01/types.json","Index":28},"Microsoft.MachineLearningCompute/operationalizationClusters@2017-06-01-preview":{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.json","Index":91},"Microsoft.MachineLearningCompute/operationalizationClusters@2017-08-01-preview":{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.json","Index":102},"Microsoft.MachineLearningExperimentation/accounts@2017-05-01-preview":{"RelativePath":"machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.json","Index":20},"Microsoft.MachineLearningExperimentation/accounts/workspaces@2017-05-01-preview":{"RelativePath":"machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.json","Index":32},"Microsoft.MachineLearningExperimentation/accounts/workspaces/projects@2017-05-01-preview":{"RelativePath":"machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.json","Index":44},"Microsoft.MachineLearningServices/workspaces@2018-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2018-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":64},"Microsoft.MachineLearningServices/workspaces@2018-11-19":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2018-11-19":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":81},"Microsoft.MachineLearningServices/workspaces@2019-05-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2019-05-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":81},"Microsoft.MachineLearningServices/workspaces@2019-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2019-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":85},"Microsoft.MachineLearningServices/workspaces@2019-11-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":24},"Microsoft.MachineLearningServices/workspaces/computes@2019-11-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":86},"Microsoft.MachineLearningServices/workspaces@2020-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":29},"Microsoft.MachineLearningServices/workspaces/computes@2020-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":91},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":108},"Microsoft.MachineLearningServices/workspaces@2020-02-18-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":29},"Microsoft.MachineLearningServices/workspaces/computes@2020-02-18-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":130},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-02-18-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":147},"Microsoft.MachineLearningServices/workspaces@2020-03-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":61},"Microsoft.MachineLearningServices/workspaces/computes@2020-03-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":123},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-03-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":128},"Microsoft.MachineLearningServices/workspaces@2020-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":63},"Microsoft.MachineLearningServices/workspaces/computes@2020-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":130},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":135},"Microsoft.MachineLearningServices/workspaces@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":61},"Microsoft.MachineLearningServices/workspaces/computes@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":123},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":128},"Microsoft.MachineLearningServices/workspaces/linkedWorkspaces@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":133},"Microsoft.MachineLearningServices/workspaces/services@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":180},"Microsoft.MachineLearningServices/workspaces/datasets@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":217},"Microsoft.MachineLearningServices/workspaces/datastores@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":290},"Microsoft.MachineLearningServices/workspaces@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":61},"Microsoft.MachineLearningServices/workspaces/computes@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":127},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":132},"Microsoft.MachineLearningServices/workspaces/linkedWorkspaces@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":137},"Microsoft.MachineLearningServices/workspaces/services@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":184},"Microsoft.MachineLearningServices/workspaces@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":62},"Microsoft.MachineLearningServices/workspaces/connections@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":67},"Microsoft.MachineLearningServices/workspaces/computes@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":161},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":165},"Microsoft.MachineLearningServices/workspaces@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":62},"Microsoft.MachineLearningServices/workspaces/connections@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":67},"Microsoft.MachineLearningServices/workspaces/computes@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":185},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":189},"Microsoft.MachineLearningServices/workspaces/labelingJobs@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":63},"Microsoft.MachineLearningServices/workspaces@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":117},"Microsoft.MachineLearningServices/workspaces/computes@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":239},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":244},"Microsoft.MachineLearningServices/workspaces/linkedServices@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":250},"Microsoft.MachineLearningServices/workspaces/services@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":297},"Microsoft.MachineLearningServices/workspaces/connections@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":302},"Microsoft.MachineLearningServices/workspaces@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":77},"Microsoft.MachineLearningServices/workspaces/computes@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":203},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":208},"Microsoft.MachineLearningServices/workspaces/services@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":255},"Microsoft.MachineLearningServices/workspaces/connections@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":262},"Microsoft.MachineLearningServices/workspaces@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":77},"Microsoft.MachineLearningServices/workspaces/computes@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":248},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":253},"Microsoft.MachineLearningServices/workspaces/connections@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":260},"Microsoft.MachineLearningServices/workspaces/batchEndpoints@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":281},"Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":309},"Microsoft.MachineLearningServices/workspaces/codes@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":316},"Microsoft.MachineLearningServices/workspaces/codes/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":323},"Microsoft.MachineLearningServices/workspaces/data@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":330},"Microsoft.MachineLearningServices/workspaces/data/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":340},"Microsoft.MachineLearningServices/workspaces/datastores@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":426},"Microsoft.MachineLearningServices/workspaces/environments@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":433},"Microsoft.MachineLearningServices/workspaces/environments/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":454},"Microsoft.MachineLearningServices/workspaces/jobs@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":560},"Microsoft.MachineLearningServices/workspaces/labelingJobs@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":618},"Microsoft.MachineLearningServices/workspaces/models@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":625},"Microsoft.MachineLearningServices/workspaces/models/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":635},"Microsoft.MachineLearningServices/workspaces/onlineEndpoints@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":654},"Microsoft.MachineLearningServices/workspaces/onlineEndpoints/deployments@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":682},"Microsoft.MachineLearningServices/workspaces@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":77},"Microsoft.MachineLearningServices/workspaces/computes@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":208},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":213},"Microsoft.MachineLearningServices/workspaces/services@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":260},"Microsoft.MachineLearningServices/workspaces/connections@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":267},"Microsoft.MachineLearningServices/workspaces@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":80},"Microsoft.MachineLearningServices/workspaces/computes@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":217},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":222},"Microsoft.MachineLearningServices/workspaces/connections@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":229},"Microsoft.MachineLearningServices/workspaces@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":86},"Microsoft.MachineLearningServices/workspaces/computes@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":223},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":228},"Microsoft.MachineLearningServices/workspaces/connections@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":235},"Microsoft.Maintenance/applyUpdates@2018-06-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2018-06-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2018-06-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2018-06-01-preview/types.json","Index":17},"Microsoft.Maintenance/maintenanceConfigurations@2018-06-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2018-06-01-preview/types.json","Index":29},"Microsoft.Maintenance/applyUpdates@2020-04-01":{"RelativePath":"maintenance/microsoft.maintenance/2020-04-01/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2020-04-01":{"RelativePath":"maintenance/microsoft.maintenance/2020-04-01/types.json","Index":17},"Microsoft.Maintenance/maintenanceConfigurations@2020-04-01":{"RelativePath":"maintenance/microsoft.maintenance/2020-04-01/types.json","Index":29},"Microsoft.Maintenance/applyUpdates@2020-07-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2020-07-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2020-07-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2020-07-01-preview/types.json","Index":17},"Microsoft.Maintenance/maintenanceConfigurations@2020-07-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2020-07-01-preview/types.json","Index":38},"Microsoft.Maintenance/applyUpdates@2021-04-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-04-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2021-04-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-04-01-preview/types.json","Index":28},"Microsoft.Maintenance/maintenanceConfigurations@2021-04-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-04-01-preview/types.json","Index":67},"Microsoft.Maintenance/applyUpdates@2021-05-01":{"RelativePath":"maintenance/microsoft.maintenance/2021-05-01/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2021-05-01":{"RelativePath":"maintenance/microsoft.maintenance/2021-05-01/types.json","Index":28},"Microsoft.Maintenance/maintenanceConfigurations@2021-05-01":{"RelativePath":"maintenance/microsoft.maintenance/2021-05-01/types.json","Index":46},"Microsoft.Maintenance/applyUpdates@2021-09-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-09-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2021-09-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-09-01-preview/types.json","Index":28},"Microsoft.Maintenance/maintenanceConfigurations@2021-09-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-09-01-preview/types.json","Index":67},"Microsoft.ManagedNetwork/managedNetworks@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":52},"Microsoft.ManagedNetwork/scopeAssignments@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":62},"Microsoft.ManagedNetwork/managedNetworks/managedNetworkGroups@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":68},"Microsoft.ManagedNetwork/managedNetworks/managedNetworkPeeringPolicies@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":72},"Microsoft.ManagedServices/registrationDefinitions@2018-06-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2018-06-01-preview/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2018-06-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2018-06-01-preview/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2019-04-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2019-04-01-preview/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2019-04-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2019-04-01-preview/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2019-06-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-06-01/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2019-06-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-06-01/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2019-09-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-09-01/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2019-09-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-09-01/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2020-02-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2020-02-01-preview/types.json","Index":37},"Microsoft.ManagedServices/registrationAssignments@2020-02-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2020-02-01-preview/types.json","Index":72},"Microsoft.ManagedServices/registrationDefinitions@2022-01-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2022-01-01-preview/types.json","Index":48},"Microsoft.ManagedServices/registrationAssignments@2022-01-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2022-01-01-preview/types.json","Index":83},"Microsoft.Management/managementGroups@2017-11-01-preview":{"RelativePath":"managementgroups/microsoft.management/2017-11-01-preview/types.json","Index":20},"Microsoft.Management/managementGroups/subscriptions@2017-11-01-preview":{"RelativePath":"managementgroups/microsoft.management/2017-11-01-preview/types.json","Index":24},"Microsoft.Management/managementGroups@2018-01-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-01-01-preview/types.json","Index":22},"Microsoft.Management/managementGroups/subscriptions@2018-01-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-01-01-preview/types.json","Index":26},"Microsoft.Management/managementGroups@2018-03-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-03-01-preview/types.json","Index":22},"Microsoft.Management/managementGroups/subscriptions@2018-03-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-03-01-preview/types.json","Index":26},"Microsoft.Management/managementGroups@2019-11-01":{"RelativePath":"managementgroups/microsoft.management/2019-11-01/types.json","Index":24},"Microsoft.Management/managementGroups/subscriptions@2019-11-01":{"RelativePath":"managementgroups/microsoft.management/2019-11-01/types.json","Index":28},"Microsoft.Management/managementGroups@2020-02-01":{"RelativePath":"managementgroups/microsoft.management/2020-02-01/types.json","Index":24},"Microsoft.Management/managementGroups/subscriptions@2020-02-01":{"RelativePath":"managementgroups/microsoft.management/2020-02-01/types.json","Index":28},"Microsoft.Management/managementGroups/settings@2020-02-01":{"RelativePath":"managementgroups/microsoft.management/2020-02-01/types.json","Index":34},"Microsoft.Management/managementGroups@2020-05-01":{"RelativePath":"managementgroups/microsoft.management/2020-05-01/types.json","Index":22},"Microsoft.Management/managementGroups/subscriptions@2020-05-01":{"RelativePath":"managementgroups/microsoft.management/2020-05-01/types.json","Index":28},"Microsoft.Management/managementGroups/settings@2020-05-01":{"RelativePath":"managementgroups/microsoft.management/2020-05-01/types.json","Index":34},"Microsoft.Management/managementGroups@2020-10-01":{"RelativePath":"managementgroups/microsoft.management/2020-10-01/types.json","Index":23},"Microsoft.Management/managementGroups/subscriptions@2020-10-01":{"RelativePath":"managementgroups/microsoft.management/2020-10-01/types.json","Index":29},"Microsoft.Management/managementGroups/settings@2020-10-01":{"RelativePath":"managementgroups/microsoft.management/2020-10-01/types.json","Index":35},"Microsoft.Management/managementGroups@2021-04-01":{"RelativePath":"managementgroups/microsoft.management/2021-04-01/types.json","Index":24},"Microsoft.Management/managementGroups/subscriptions@2021-04-01":{"RelativePath":"managementgroups/microsoft.management/2021-04-01/types.json","Index":30},"Microsoft.Management/managementGroups/settings@2021-04-01":{"RelativePath":"managementgroups/microsoft.management/2021-04-01/types.json","Index":36},"Microsoft.ManagementPartner/partners@2018-02-01":{"RelativePath":"managementpartner/microsoft.managementpartner/2018-02-01/types.json","Index":15},"Microsoft.Maps/accounts@2017-01-01-preview":{"RelativePath":"maps/microsoft.maps/2017-01-01-preview/types.json","Index":14},"Microsoft.Maps/accounts@2018-05-01":{"RelativePath":"maps/microsoft.maps/2018-05-01/types.json","Index":14},"Microsoft.Maps/accounts@2020-02-01-preview":{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":25},"Microsoft.Maps/accounts/privateAtlases@2020-02-01-preview":{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":31},"Microsoft.Maps/accounts/creators@2020-02-01-preview":{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":37},"Microsoft.Maps/accounts@2021-02-01":{"RelativePath":"maps/microsoft.maps/2021-02-01/types.json","Index":32},"Microsoft.Maps/accounts/creators@2021-02-01":{"RelativePath":"maps/microsoft.maps/2021-02-01/types.json","Index":38},"Microsoft.Maps/accounts@2021-07-01-preview":{"RelativePath":"maps/microsoft.maps/2021-07-01-preview/types.json","Index":42},"Microsoft.Maps/accounts/creators@2021-07-01-preview":{"RelativePath":"maps/microsoft.maps/2021-07-01-preview/types.json","Index":48},"Microsoft.Maps/accounts@2021-12-01-preview":{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":46},"Microsoft.Maps/accounts/creators@2021-12-01-preview":{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":52},"Microsoft.DBforMariaDB/servers@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":51},"Microsoft.DBforMariaDB/servers/firewallRules@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":56},"Microsoft.DBforMariaDB/servers/virtualNetworkRules@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":67},"Microsoft.DBforMariaDB/servers/databases@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":72},"Microsoft.DBforMariaDB/servers/configurations@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":77},"Microsoft.DBforMariaDB/servers/securityAlertPolicies@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":89},"Microsoft.DBforMariaDB/servers@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":69},"Microsoft.DBforMariaDB/servers/firewallRules@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":74},"Microsoft.DBforMariaDB/servers/virtualNetworkRules@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":85},"Microsoft.DBforMariaDB/servers/databases@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":90},"Microsoft.DBforMariaDB/servers/configurations@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":95},"Microsoft.DBforMariaDB/servers/privateEndpointConnections@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":101},"Microsoft.DBforMariaDB/servers/securityAlertPolicies@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":113},"Microsoft.Marketplace/privateStores/offers@2020-01-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-01-01/types.json","Index":21},"Microsoft.Marketplace/privateStores@2020-01-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-01-01/types.json","Index":30},"Microsoft.Marketplace/privateStores/requestApprovals@2020-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-12-01/types.json","Index":30},"Microsoft.Marketplace/privateStores/adminRequestApprovals@2020-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-12-01/types.json","Index":43},"Microsoft.Marketplace/privateStores@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":31},"Microsoft.Marketplace/privateStores/requestApprovals@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":43},"Microsoft.Marketplace/privateStores/adminRequestApprovals@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":57},"Microsoft.Marketplace/privateStores/collections@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":63},"Microsoft.Marketplace/privateStores/collections/offers@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":77},"Microsoft.Marketplace/privateStores@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":31},"Microsoft.Marketplace/privateStores/requestApprovals@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":43},"Microsoft.Marketplace/privateStores/adminRequestApprovals@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":57},"Microsoft.Marketplace/privateStores/collections@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":63},"Microsoft.Marketplace/privateStores/collections/offers@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":77},"Microsoft.MarketplaceOrdering/offerTypes/publishers/offers/plans/agreements@2015-06-01":{"RelativePath":"marketplaceordering/microsoft.marketplaceordering/2015-06-01/types.json","Index":13},"Microsoft.MarketplaceOrdering/offerTypes/publishers/offers/plans/agreements@2021-01-01":{"RelativePath":"marketplaceordering/microsoft.marketplaceordering/2021-01-01/types.json","Index":24},"Microsoft.Media/mediaservices@2015-10-01":{"RelativePath":"mediaservices/microsoft.media/2015-10-01/types.json","Index":17},"Microsoft.Media/mediaservices@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":18},"Microsoft.Media/mediaServices/assets@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":26},"Microsoft.Media/mediaServices/contentKeyPolicies@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":93},"Microsoft.Media/mediaServices/transforms@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":191},"Microsoft.Media/mediaServices/transforms/jobs@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":250},"Microsoft.Media/mediaServices/streamingPolicies@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":282},"Microsoft.Media/mediaServices/streamingLocators@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":289},"Microsoft.Media/mediaservices/liveEvents@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":322},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":332},"Microsoft.Media/mediaservices/streamingEndpoints@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":350},"Microsoft.Media/mediaservices@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":18},"Microsoft.Media/mediaServices/assets@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":26},"Microsoft.Media/mediaServices/contentKeyPolicies@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":93},"Microsoft.Media/mediaServices/transforms@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":191},"Microsoft.Media/mediaServices/transforms/jobs@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":251},"Microsoft.Media/mediaServices/streamingPolicies@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":283},"Microsoft.Media/mediaServices/streamingLocators@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":295},"Microsoft.Media/mediaservices/liveEvents@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":328},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":338},"Microsoft.Media/mediaservices/streamingEndpoints@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":356},"Microsoft.Media/mediaServices/accountFilters@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":28},"Microsoft.Media/mediaservices@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":51},"Microsoft.Media/mediaServices/contentKeyPolicies@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":118},"Microsoft.Media/mediaServices/transforms@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":229},"Microsoft.Media/mediaServices/transforms/jobs@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":289},"Microsoft.Media/mediaServices/streamingPolicies@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":321},"Microsoft.Media/mediaServices/streamingLocators@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":334},"Microsoft.Media/mediaservices/liveEvents@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":375},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":385},"Microsoft.Media/mediaservices/streamingEndpoints@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":403},"Microsoft.Media/mediaServices/accountFilters@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":28},"Microsoft.Media/mediaservices@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":51},"Microsoft.Media/mediaServices/contentKeyPolicies@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":118},"Microsoft.Media/mediaServices/transforms@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":229},"Microsoft.Media/mediaServices/transforms/jobs@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":289},"Microsoft.Media/mediaServices/streamingPolicies@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":321},"Microsoft.Media/mediaServices/streamingLocators@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":334},"Microsoft.Media/mediaservices/liveEvents@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":375},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":385},"Microsoft.Media/mediaservices/streamingEndpoints@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":403},"Microsoft.Media/mediaServices/mediaGraphs@2019-09-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-09-01-preview/types.json","Index":27},"Microsoft.Media/mediaServices/mediaGraphs@2020-02-01-preview":{"RelativePath":"mediaservices/microsoft.media/2020-02-01-preview/types.json","Index":42},"Microsoft.Media/mediaServices/accountFilters@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":51},"Microsoft.Media/mediaServices/contentKeyPolicies@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":120},"Microsoft.Media/mediaServices/transforms@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":260},"Microsoft.Media/mediaServices/transforms/jobs@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":368},"Microsoft.Media/mediaServices/streamingPolicies@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":400},"Microsoft.Media/mediaServices/streamingLocators@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":413},"Microsoft.Media/mediaservices/liveEvents@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":459},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":469},"Microsoft.Media/mediaservices/streamingEndpoints@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":487},"Microsoft.Media/mediaservices@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":510},"Microsoft.Media/mediaservices/privateEndpointConnections@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":526},"Microsoft.Media/mediaservices@2021-05-01":{"RelativePath":"mediaservices/microsoft.media/2021-05-01/types.json","Index":47},"Microsoft.Media/mediaservices/privateEndpointConnections@2021-05-01":{"RelativePath":"mediaservices/microsoft.media/2021-05-01/types.json","Index":63},"Microsoft.Media/mediaservices@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":50},"Microsoft.Media/mediaservices/privateEndpointConnections@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":66},"Microsoft.Media/mediaServices/accountFilters@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":87},"Microsoft.Media/mediaServices/assets@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":95},"Microsoft.Media/mediaServices/assets/assetFilters@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":99},"Microsoft.Media/mediaServices/contentKeyPolicies@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":168},"Microsoft.Media/mediaServices/transforms@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":316},"Microsoft.Media/mediaServices/transforms/jobs@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":424},"Microsoft.Media/mediaServices/streamingPolicies@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":456},"Microsoft.Media/mediaServices/streamingLocators@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":469},"Microsoft.Media/mediaservices/liveEvents@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":517},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":527},"Microsoft.Media/mediaservices/streamingEndpoints@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":545},"Microsoft.Media/mediaServices/accountFilters@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":51},"Microsoft.Media/mediaServices/assets/tracks@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":71},"Microsoft.Media/mediaServices/contentKeyPolicies@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":140},"Microsoft.Media/mediaServices/transforms@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":293},"Microsoft.Media/mediaServices/transforms/jobs@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":401},"Microsoft.Media/mediaServices/streamingPolicies@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":433},"Microsoft.Media/mediaServices/streamingLocators@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":446},"Microsoft.Media/mediaservices/liveEvents@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":495},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":505},"Microsoft.Media/mediaservices/streamingEndpoints@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":524},"Microsoft.Migrate/projects@2018-02-02":{"RelativePath":"migrate/microsoft.migrate/2018-02-02/types.json","Index":24},"Microsoft.Migrate/projects/groups@2018-02-02":{"RelativePath":"migrate/microsoft.migrate/2018-02-02/types.json","Index":31},"Microsoft.Migrate/projects/groups/assessments@2018-02-02":{"RelativePath":"migrate/microsoft.migrate/2018-02-02/types.json","Index":169},"Microsoft.Migrate/assessmentProjects@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":37},"Microsoft.Migrate/assessmentProjects/groups@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":49},"Microsoft.Migrate/assessmentProjects/groups/assessments@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":233},"Microsoft.Migrate/assessmentProjects/hypervcollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":240},"Microsoft.Migrate/assessmentProjects/servercollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":244},"Microsoft.Migrate/assessmentProjects/vmwarecollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":248},"Microsoft.Migrate/assessmentProjects/importcollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":253},"Microsoft.Migrate/assessmentprojects/privateEndpointConnections@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":257},"Microsoft.Migrate/migrateProjects@2020-05-01":{"RelativePath":"migrate/microsoft.migrate/2020-05-01/types.json","Index":80},"Microsoft.Migrate/migrateProjects/privateEndpointConnections@2020-05-01":{"RelativePath":"migrate/microsoft.migrate/2020-05-01/types.json","Index":90},"Microsoft.OffAzure/HyperVSites/clusters@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":16},"Microsoft.OffAzure/HyperVSites/hosts@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":22},"Microsoft.OffAzure/HyperVSites@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":30},"Microsoft.OffAzure/VMwareSites@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":35},"Microsoft.OffAzure/VMwareSites/vCenters@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":41},"Microsoft.OffAzure/HyperVSites/clusters@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":16},"Microsoft.OffAzure/HyperVSites/hosts@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":22},"Microsoft.OffAzure/HyperVSites@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":41},"Microsoft.OffAzure/VMwareSites@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":46},"Microsoft.OffAzure/VMwareSites/vCenters@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":52},"Microsoft.OffAzure/MasterSites@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":77},"Microsoft.OffAzure/masterSites/privateEndpointConnections@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":81},"Microsoft.Migrate/migrateProjects@2018-09-01-preview":{"RelativePath":"migrateprojects/microsoft.migrate/2018-09-01-preview/types.json","Index":51},"Microsoft.Migrate/migrateProjects/solutions@2018-09-01-preview":{"RelativePath":"migrateprojects/microsoft.migrate/2018-09-01-preview/types.json","Index":92},"Microsoft.MixedReality/spatialAnchorsAccounts@2019-02-28-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2019-02-28-preview/types.json","Index":15},"Microsoft.MixedReality/remoteRenderingAccounts@2019-12-02-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2019-12-02-preview/types.json","Index":15},"Microsoft.MixedReality/spatialAnchorsAccounts@2019-12-02-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2019-12-02-preview/types.json","Index":20},"Microsoft.MixedReality/remoteRenderingAccounts@2020-04-06-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2020-04-06-preview/types.json","Index":32},"Microsoft.MixedReality/spatialAnchorsAccounts@2020-05-01":{"RelativePath":"mixedreality/microsoft.mixedreality/2020-05-01/types.json","Index":32},"Microsoft.MixedReality/spatialAnchorsAccounts@2021-01-01":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":32},"Microsoft.MixedReality/remoteRenderingAccounts@2021-01-01":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":37},"Microsoft.MixedReality/spatialAnchorsAccounts@2021-03-01-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":32},"Microsoft.MixedReality/remoteRenderingAccounts@2021-03-01-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":37},"Microsoft.MixedReality/objectAnchorsAccounts@2021-03-01-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":44},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes/attachedDataNetworks@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":42},"Microsoft.MobileNetwork/mobileNetworks/dataNetworks@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":56},"Microsoft.MobileNetwork/mobileNetworks@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":71},"Microsoft.MobileNetwork/mobileNetworks/sites@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":87},"Microsoft.MobileNetwork/sims@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":111},"Microsoft.MobileNetwork/packetCoreControlPlanes@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":129},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":143},"Microsoft.MobileNetwork/mobileNetworks/services@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":186},"Microsoft.MobileNetwork/mobileNetworks/simPolicies@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":220},"Microsoft.MobileNetwork/mobileNetworks/slices@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":235},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes/attachedDataNetworks@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":42},"Microsoft.MobileNetwork/mobileNetworks/dataNetworks@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":56},"Microsoft.MobileNetwork/mobileNetworks@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":71},"Microsoft.MobileNetwork/mobileNetworks/sites@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":87},"Microsoft.MobileNetwork/sims@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":112},"Microsoft.MobileNetwork/packetCoreControlPlanes@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":130},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":144},"Microsoft.MobileNetwork/mobileNetworks/services@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":187},"Microsoft.MobileNetwork/mobileNetworks/simPolicies@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":221},"Microsoft.MobileNetwork/mobileNetworks/slices@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":236},"Microsoft.Insights/alertrules@2014-04-01":{"RelativePath":"monitor/microsoft.insights/2014-04-01/types.json","Index":51},"Microsoft.Insights/autoscalesettings@2014-04-01":{"RelativePath":"monitor/microsoft.insights/2014-04-01/types.json","Index":122},"Microsoft.Insights/autoscalesettings@2015-04-01":{"RelativePath":"monitor/microsoft.insights/2015-04-01/types.json","Index":78},"microsoft.insights/diagnosticSettings@2015-07-01":{"RelativePath":"monitor/microsoft.insights/2015-07-01/types.json","Index":19},"Microsoft.Insights/alertrules@2016-03-01":{"RelativePath":"monitor/microsoft.insights/2016-03-01/types.json","Index":51},"Microsoft.Insights/logprofiles@2016-03-01":{"RelativePath":"monitor/microsoft.insights/2016-03-01/types.json","Index":60},"microsoft.insights/diagnosticSettings@2016-09-01":{"RelativePath":"monitor/microsoft.insights/2016-09-01/types.json","Index":19},"microsoft.insights/activityLogAlerts@2017-03-01-preview":{"RelativePath":"monitor/microsoft.insights/2017-03-01-preview/types.json","Index":21},"microsoft.insights/activityLogAlerts@2017-04-01":{"RelativePath":"monitor/microsoft.insights/2017-04-01/types.json","Index":21},"microsoft.insights/actionGroups@2017-04-01":{"RelativePath":"monitor/microsoft.insights/2017-04-01/types.json","Index":47},"Microsoft.Insights/diagnosticSettings@2017-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2017-05-01-preview/types.json","Index":17},"Microsoft.Insights/metricAlerts@2018-03-01":{"RelativePath":"monitor/microsoft.insights/2018-03-01/types.json","Index":72},"microsoft.insights/actionGroups@2018-03-01":{"RelativePath":"monitor/microsoft.insights/2018-03-01/types.json","Index":104},"Microsoft.Insights/scheduledQueryRules@2018-04-16":{"RelativePath":"monitor/microsoft.insights/2018-04-16/types.json","Index":63},"microsoft.insights/guestDiagnosticSettingsAssociation@2018-06-01-preview":{"RelativePath":"monitor/microsoft.insights/2018-06-01-preview/types.json","Index":13},"microsoft.insights/guestDiagnosticSettings@2018-06-01-preview":{"RelativePath":"monitor/microsoft.insights/2018-06-01-preview/types.json","Index":43},"microsoft.insights/actionGroups@2018-09-01":{"RelativePath":"monitor/microsoft.insights/2018-09-01/types.json","Index":41},"microsoft.insights/actionGroups@2019-03-01":{"RelativePath":"monitor/microsoft.insights/2019-03-01/types.json","Index":41},"microsoft.insights/actionGroups@2019-06-01":{"RelativePath":"monitor/microsoft.insights/2019-06-01/types.json","Index":41},"microsoft.insights/privateLinkScopes@2019-10-17-preview":{"RelativePath":"monitor/microsoft.insights/2019-10-17-preview/types.json","Index":18},"Microsoft.Insights/privateLinkScopes/privateEndpointConnections@2019-10-17-preview":{"RelativePath":"monitor/microsoft.insights/2019-10-17-preview/types.json","Index":22},"Microsoft.Insights/privateLinkScopes/scopedResources@2019-10-17-preview":{"RelativePath":"monitor/microsoft.insights/2019-10-17-preview/types.json","Index":27},"Microsoft.Insights/dataCollectionRuleAssociations@2019-11-01-preview":{"RelativePath":"monitor/microsoft.insights/2019-11-01-preview/types.json","Index":18},"Microsoft.Insights/dataCollectionRules@2019-11-01-preview":{"RelativePath":"monitor/microsoft.insights/2019-11-01-preview/types.json","Index":111},"microsoft.insights/diagnosticSettings@2020-01-01-preview":{"RelativePath":"monitor/microsoft.insights/2020-01-01-preview/types.json","Index":14},"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2020-05-01-preview/types.json","Index":40},"Microsoft.Insights/activityLogAlerts@2020-10-01":{"RelativePath":"monitor/microsoft.insights/2020-10-01/types.json","Index":25},"Microsoft.Insights/scheduledQueryRules@2021-02-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-02-01-preview/types.json","Index":54},"Microsoft.Insights/dataCollectionEndpoints@2021-04-01":{"RelativePath":"monitor/microsoft.insights/2021-04-01/types.json","Index":39},"Microsoft.Insights/dataCollectionRuleAssociations@2021-04-01":{"RelativePath":"monitor/microsoft.insights/2021-04-01/types.json","Index":61},"Microsoft.Insights/dataCollectionRules@2021-04-01":{"RelativePath":"monitor/microsoft.insights/2021-04-01/types.json","Index":165},"Microsoft.Insights/autoscalesettings@2021-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-05-01-preview/types.json","Index":94},"Microsoft.Insights/diagnosticSettings@2021-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-05-01-preview/types.json","Index":104},"microsoft.insights/privateLinkScopes@2021-07-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-07-01-preview/types.json","Index":53},"Microsoft.Insights/privateLinkScopes/privateEndpointConnections@2021-07-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-07-01-preview/types.json","Index":57},"Microsoft.Insights/privateLinkScopes/scopedResources@2021-07-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-07-01-preview/types.json","Index":62},"Microsoft.Insights/scheduledQueryRules@2021-08-01":{"RelativePath":"monitor/microsoft.insights/2021-08-01/types.json","Index":54},"Microsoft.Insights/dataCollectionEndpoints@2021-09-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-09-01-preview/types.json","Index":39},"Microsoft.Insights/dataCollectionRuleAssociations@2021-09-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-09-01-preview/types.json","Index":62},"Microsoft.Insights/dataCollectionRules@2021-09-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-09-01-preview/types.json","Index":201},"Microsoft.Insights/actionGroups@2021-09-01":{"RelativePath":"monitor/microsoft.insights/2021-09-01/types.json","Index":43},"Microsoft.Insights/actionGroups@2022-04-01":{"RelativePath":"monitor/microsoft.insights/2022-04-01/types.json","Index":43},"Microsoft.ManagedIdentity/userAssignedIdentities@2015-08-31-preview":{"RelativePath":"msi/microsoft.managedidentity/2015-08-31-preview/types.json","Index":13},"Microsoft.ManagedIdentity/userAssignedIdentities@2018-11-30":{"RelativePath":"msi/microsoft.managedidentity/2018-11-30/types.json","Index":13},"Microsoft.ManagedIdentity/userAssignedIdentities@2021-09-30-preview":{"RelativePath":"msi/microsoft.managedidentity/2021-09-30-preview/types.json","Index":13},"Microsoft.DBforMySQL/servers@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":77},"Microsoft.DBforMySQL/servers/firewallRules@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":82},"Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":93},"Microsoft.DBforMySQL/servers/databases@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":98},"Microsoft.DBforMySQL/servers/configurations@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":103},"Microsoft.DBforMySQL/servers/administrators@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":110},"Microsoft.DBforMySQL/servers/securityAlertPolicies@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":122},"Microsoft.DBforMySQL/servers@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":77},"Microsoft.DBforMySQL/servers/firewallRules@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":82},"Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":93},"Microsoft.DBforMySQL/servers/databases@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":98},"Microsoft.DBforMySQL/servers/configurations@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":103},"Microsoft.DBforMySQL/servers/administrators@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":110},"Microsoft.DBforMySQL/servers/securityAlertPolicies@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":122},"Microsoft.DBforMySQL/servers/privateEndpointConnections@2018-06-01":{"RelativePath":"mysql/microsoft.dbformysql/2018-06-01/types.json","Index":14},"Microsoft.DBforMySQL/servers/keys@2020-01-01":{"RelativePath":"mysql/microsoft.dbformysql/2020-01-01/types.json","Index":14},"Microsoft.DBForMySql/flexibleServers@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":61},"Microsoft.DBForMySql/flexibleServers/keys@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":68},"Microsoft.DBForMySql/flexibleServers/firewallRules@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":73},"Microsoft.DBForMySql/flexibleServers/databases@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":78},"Microsoft.DBforMySQL/flexibleServers@2021-05-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01-preview/types.json","Index":76},"Microsoft.DBforMySQL/flexibleServers/firewallRules@2021-05-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01-preview/types.json","Index":81},"Microsoft.DBforMySQL/flexibleServers/databases@2021-05-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01-preview/types.json","Index":86},"Microsoft.DBforMySQL/flexibleServers@2021-05-01":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01/types.json","Index":80},"Microsoft.DBforMySQL/flexibleServers/firewallRules@2021-05-01":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01/types.json","Index":85},"Microsoft.DBforMySQL/flexibleServers/databases@2021-05-01":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01/types.json","Index":90},"Microsoft.NetApp/netAppAccounts@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":40},"Microsoft.NetApp/netAppAccounts@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":38},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":38},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":38},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":15},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":25},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":49},"Microsoft.NetApp/netAppAccounts@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":15},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":25},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":50},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":56},"Microsoft.NetApp/netAppAccounts@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":15},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":25},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":50},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":55},"Microsoft.NetApp/netAppAccounts@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":16},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":26},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":52},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":57},"Microsoft.NetApp/netAppAccounts@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":16},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":26},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":54},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":59},"Microsoft.NetApp/netAppAccounts@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":16},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":26},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":53},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":58},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":68},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":76},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":84},"Microsoft.NetApp/netAppAccounts@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":22},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":65},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":70},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":88},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":96},"Microsoft.NetApp/netAppAccounts@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":22},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":65},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":70},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":88},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":96},"Microsoft.NetApp/netAppAccounts@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":22},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":65},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":70},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":88},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":96},"Microsoft.NetApp/netAppAccounts@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":66},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":71},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":81},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":89},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":97},"Microsoft.NetApp/netAppAccounts@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":37},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":50},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":85},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":95},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":103},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":111},"Microsoft.NetApp/netAppAccounts@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":48},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":78},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":83},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":93},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":101},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":109},"Microsoft.NetApp/netAppAccounts@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":48},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":78},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":83},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":93},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":101},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":109},"Microsoft.NetApp/netAppAccounts@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":48},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":85},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":90},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":100},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":108},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":116},"Microsoft.NetApp/netAppAccounts@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":52},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":85},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":90},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":100},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":108},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":116},"Microsoft.NetApp/netAppAccounts@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":53},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":97},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":102},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":112},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":120},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":128},"Microsoft.NetApp/netAppAccounts@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":53},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":99},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":104},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":114},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":122},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":130},"Microsoft.NetApp/netAppAccounts/volumeGroups@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":143},"Microsoft.NetApp/netAppAccounts@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":37},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":54},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":103},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":108},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":118},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":126},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":134},"Microsoft.NetApp/netAppAccounts/volumeGroups@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":147},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":152},"Microsoft.Network/applicationGateways@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":67},"Microsoft.Network/expressRouteCircuits@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":110},"Microsoft.Network/expressRouteCircuits/peerings@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":114},"Microsoft.Network/loadBalancers@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":168},"Microsoft.Network/localNetworkGateways@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":176},"Microsoft.Network/networkInterfaces@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":193},"Microsoft.Network/routeTables@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":209},"Microsoft.Network/networkSecurityGroups@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":231},"Microsoft.Network/publicIPAddresses@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":241},"Microsoft.Network/routeTables/routes@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":245},"Microsoft.Network/networkSecurityGroups/securityRules@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":249},"Microsoft.Network/expressRouteCircuits/authorizations@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":253},"Microsoft.Network/virtualnetworks/subnets@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":259},"Microsoft.Network/connections@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":292},"Microsoft.Network/virtualnetworkgateways@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":297},"Microsoft.Network/virtualnetworks@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":307},"Microsoft.Network/applicationGateways@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":151},"Microsoft.Network/expressRouteCircuits/authorizations@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":159},"Microsoft.Network/expressRouteCircuits/peerings@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":179},"Microsoft.Network/expressRouteCircuits@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":202},"Microsoft.Network/loadBalancers@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":247},"Microsoft.Network/networkInterfaces@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":252},"Microsoft.Network/networkSecurityGroups@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":257},"Microsoft.Network/networkSecurityGroups/securityRules@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":261},"Microsoft.Network/publicIPAddresses@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":266},"Microsoft.Network/routeTables@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":271},"Microsoft.Network/routeTables/routes@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":275},"Microsoft.Network/virtualNetworks@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":286},"Microsoft.Network/virtualnetworks/subnets@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":290},"Microsoft.Network/virtualNetworkGateways@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":325},"Microsoft.Network/connections@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":346},"Microsoft.Network/localNetworkGateways@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":351},"Microsoft.Network/applicationGateways@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":158},"Microsoft.Network/expressRouteCircuits/authorizations@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":166},"Microsoft.Network/expressRouteCircuits/peerings@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":186},"Microsoft.Network/expressRouteCircuits@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":209},"Microsoft.Network/loadBalancers@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":254},"Microsoft.Network/localNetworkGateways@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":263},"Microsoft.Network/networkInterfaces@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":268},"Microsoft.Network/networkSecurityGroups@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":273},"Microsoft.Network/publicIPAddresses@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":278},"Microsoft.Network/routeTables@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":283},"Microsoft.Network/routeTables/routes@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":287},"Microsoft.Network/networkSecurityGroups/securityRules@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":291},"Microsoft.Network/virtualNetworks/subnets@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":295},"Microsoft.Network/connections@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":344},"Microsoft.Network/virtualNetworkGateways@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":349},"Microsoft.Network/virtualNetworks@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":358},"Microsoft.Network/applicationGateways@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":171},"Microsoft.Network/expressRouteCircuits/authorizations@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":179},"Microsoft.Network/expressRouteCircuits/peerings@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":199},"Microsoft.Network/expressRouteCircuits@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":222},"Microsoft.Network/loadBalancers@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":267},"Microsoft.Network/localNetworkGateways@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":276},"Microsoft.Network/networkInterfaces@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":281},"Microsoft.Network/networkSecurityGroups@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":286},"Microsoft.Network/publicIPAddresses@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":291},"Microsoft.Network/routeTables@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":296},"Microsoft.Network/routeTables/routes@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":300},"Microsoft.Network/networkSecurityGroups/securityRules@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":304},"Microsoft.Network/virtualNetworks/subnets@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":308},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":317},"Microsoft.Network/connections@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":368},"Microsoft.Network/virtualNetworkGateways@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":373},"Microsoft.Network/virtualNetworks@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":384},"Microsoft.Network/networkInterfaces@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":98},"Microsoft.Network/applicationGateways@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":183},"Microsoft.Network/expressRouteCircuits/authorizations@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":191},"Microsoft.Network/expressRouteCircuits/peerings@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":211},"Microsoft.Network/expressRouteCircuits@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":234},"Microsoft.Network/loadBalancers@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":279},"Microsoft.Network/networkSecurityGroups@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":284},"Microsoft.Network/networkSecurityGroups/securityRules@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":288},"Microsoft.Network/networkWatchers@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":299},"Microsoft.Network/networkWatchers/packetCaptures@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":316},"Microsoft.Network/publicIPAddresses@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":321},"Microsoft.Network/routeTables@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":326},"Microsoft.Network/routeTables/routes@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":330},"Microsoft.Network/virtualNetworks@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":348},"Microsoft.Network/virtualNetworks/subnets@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":352},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":356},"Microsoft.Network/virtualNetworkGateways@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":393},"Microsoft.Network/connections@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":421},"Microsoft.Network/localNetworkGateways@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":426},"Microsoft.Network/networkInterfaces@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":98},"Microsoft.Network/applicationGateways@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":184},"Microsoft.Network/expressRouteCircuits/authorizations@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":192},"Microsoft.Network/expressRouteCircuits/peerings@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":227},"Microsoft.Network/expressRouteCircuits@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":249},"Microsoft.Network/loadBalancers@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":294},"Microsoft.Network/networkSecurityGroups@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":299},"Microsoft.Network/networkSecurityGroups/securityRules@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":303},"Microsoft.Network/networkWatchers@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":314},"Microsoft.Network/networkWatchers/packetCaptures@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":331},"Microsoft.Network/publicIPAddresses@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":336},"Microsoft.Network/routeFilters@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":341},"Microsoft.Network/routeFilters/routeFilterRules@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":346},"Microsoft.Network/routeTables@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":351},"Microsoft.Network/routeTables/routes@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":355},"Microsoft.Network/virtualNetworks@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":373},"Microsoft.Network/virtualNetworks/subnets@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":377},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":381},"Microsoft.Network/virtualNetworkGateways@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":418},"Microsoft.Network/connections@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":446},"Microsoft.Network/localNetworkGateways@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":451},"Microsoft.Network/applicationGateways@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":182},"Microsoft.Network/expressRouteCircuits/authorizations@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":190},"Microsoft.Network/expressRouteCircuits/peerings@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":229},"Microsoft.Network/expressRouteCircuits@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":251},"Microsoft.Network/loadBalancers@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":296},"Microsoft.Network/networkInterfaces@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":301},"Microsoft.Network/networkSecurityGroups@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":306},"Microsoft.Network/networkSecurityGroups/securityRules@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":310},"Microsoft.Network/networkWatchers@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":321},"Microsoft.Network/networkWatchers/packetCaptures@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":338},"Microsoft.Network/publicIPAddresses@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":343},"Microsoft.Network/routeFilters@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":348},"Microsoft.Network/routeFilters/routeFilterRules@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":353},"Microsoft.Network/routeTables@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":358},"Microsoft.Network/routeTables/routes@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":362},"Microsoft.Network/virtualNetworks@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":380},"Microsoft.Network/virtualNetworks/subnets@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":384},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":388},"Microsoft.Network/virtualNetworkGateways@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":431},"Microsoft.Network/connections@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":506},"Microsoft.Network/localNetworkGateways@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":511},"Microsoft.Network/applicationGateways@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":182},"Microsoft.Network/expressRouteCircuits/authorizations@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":190},"Microsoft.Network/expressRouteCircuits/peerings@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":229},"Microsoft.Network/expressRouteCircuits@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":251},"Microsoft.Network/loadBalancers@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":296},"Microsoft.Network/networkInterfaces@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":301},"Microsoft.Network/networkSecurityGroups@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":306},"Microsoft.Network/networkSecurityGroups/securityRules@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":310},"Microsoft.Network/networkWatchers@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":321},"Microsoft.Network/networkWatchers/packetCaptures@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":338},"Microsoft.Network/publicIPAddresses@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":343},"Microsoft.Network/routeFilters@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":348},"Microsoft.Network/routeFilters/routeFilterRules@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":353},"Microsoft.Network/routeTables@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":358},"Microsoft.Network/routeTables/routes@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":362},"Microsoft.Network/virtualNetworks@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":380},"Microsoft.Network/virtualNetworks/subnets@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":384},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":388},"Microsoft.Network/virtualNetworkGateways@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":431},"Microsoft.Network/connections@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":506},"Microsoft.Network/localNetworkGateways@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":511},"Microsoft.Network/applicationGateways@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":244},"Microsoft.Network/expressRouteCircuits/authorizations@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":252},"Microsoft.Network/expressRouteCircuits/peerings@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":292},"Microsoft.Network/expressRouteCircuits@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":315},"Microsoft.Network/loadBalancers@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":361},"Microsoft.Network/loadBalancers/inboundNatRules@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":365},"Microsoft.Network/networkInterfaces@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":370},"Microsoft.Network/networkSecurityGroups@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":375},"Microsoft.Network/networkSecurityGroups/securityRules@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":379},"Microsoft.Network/networkWatchers@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":390},"Microsoft.Network/networkWatchers/packetCaptures@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":407},"Microsoft.Network/publicIPAddresses@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":413},"Microsoft.Network/routeFilters@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":418},"Microsoft.Network/routeFilters/routeFilterRules@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":423},"Microsoft.Network/routeTables@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":428},"Microsoft.Network/routeTables/routes@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":432},"Microsoft.Network/virtualNetworks@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":450},"Microsoft.Network/virtualNetworks/subnets@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":454},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":458},"Microsoft.Network/virtualNetworkGateways@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":505},"Microsoft.Network/connections@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":580},"Microsoft.Network/localNetworkGateways@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":585},"Microsoft.Network/applicationGateways@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":248},"Microsoft.Network/expressRouteCircuits/authorizations@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":256},"Microsoft.Network/expressRouteCircuits/peerings@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":296},"Microsoft.Network/expressRouteCircuits@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":318},"Microsoft.Network/loadBalancers@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":368},"Microsoft.Network/loadBalancers/inboundNatRules@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":372},"Microsoft.Network/networkInterfaces@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":377},"Microsoft.Network/networkSecurityGroups@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":382},"Microsoft.Network/networkSecurityGroups/securityRules@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":386},"Microsoft.Network/networkWatchers@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":397},"Microsoft.Network/networkWatchers/packetCaptures@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":414},"Microsoft.Network/publicIPAddresses@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":420},"Microsoft.Network/routeFilters@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":425},"Microsoft.Network/routeFilters/routeFilterRules@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":430},"Microsoft.Network/routeTables@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":435},"Microsoft.Network/routeTables/routes@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":439},"Microsoft.Network/virtualNetworks@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":457},"Microsoft.Network/virtualNetworks/subnets@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":461},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":465},"Microsoft.Network/virtualNetworkGateways@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":512},"Microsoft.Network/connections@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":587},"Microsoft.Network/localNetworkGateways@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":592},"Microsoft.Network/applicationGateways@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":255},"Microsoft.Network/applicationSecurityGroups@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":260},"Microsoft.Network/expressRouteCircuits/authorizations@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":268},"Microsoft.Network/expressRouteCircuits/peerings@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":308},"Microsoft.Network/expressRouteCircuits@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":330},"Microsoft.Network/loadBalancers@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":382},"Microsoft.Network/loadBalancers/inboundNatRules@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":386},"Microsoft.Network/networkInterfaces@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":391},"Microsoft.Network/networkSecurityGroups@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":396},"Microsoft.Network/networkSecurityGroups/securityRules@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":400},"Microsoft.Network/networkWatchers@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":411},"Microsoft.Network/networkWatchers/packetCaptures@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":428},"Microsoft.Network/publicIPAddresses@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":434},"Microsoft.Network/routeFilters@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":439},"Microsoft.Network/routeFilters/routeFilterRules@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":444},"Microsoft.Network/routeTables@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":449},"Microsoft.Network/routeTables/routes@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":453},"Microsoft.Network/virtualNetworks@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":471},"Microsoft.Network/virtualNetworks/subnets@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":475},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":479},"Microsoft.Network/virtualNetworkGateways@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":526},"Microsoft.Network/connections@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":601},"Microsoft.Network/localNetworkGateways@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":606},"Microsoft.Network/applicationGateways@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":255},"Microsoft.Network/applicationSecurityGroups@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":260},"Microsoft.Network/expressRouteCircuits/authorizations@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":268},"Microsoft.Network/expressRouteCircuits/peerings@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":308},"Microsoft.Network/expressRouteCircuits@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":330},"Microsoft.Network/loadBalancers@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":382},"Microsoft.Network/loadBalancers/inboundNatRules@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":386},"Microsoft.Network/networkInterfaces@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":391},"Microsoft.Network/networkSecurityGroups@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":396},"Microsoft.Network/networkSecurityGroups/securityRules@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":400},"Microsoft.Network/networkWatchers@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":411},"Microsoft.Network/networkWatchers/packetCaptures@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":428},"Microsoft.Network/networkWatchers/connectionMonitors@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":441},"Microsoft.Network/publicIPAddresses@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":447},"Microsoft.Network/routeFilters@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":452},"Microsoft.Network/routeFilters/routeFilterRules@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":457},"Microsoft.Network/routeTables@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":462},"Microsoft.Network/routeTables/routes@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":466},"Microsoft.Network/virtualNetworks@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":484},"Microsoft.Network/virtualNetworks/subnets@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":492},"Microsoft.Network/virtualNetworkGateways@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":539},"Microsoft.Network/connections@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":614},"Microsoft.Network/localNetworkGateways@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":619},"Microsoft.Network/applicationGateways@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":257},"Microsoft.Network/applicationSecurityGroups@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":262},"Microsoft.Network/expressRouteCircuits/authorizations@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":270},"Microsoft.Network/expressRouteCircuits/peerings@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":309},"Microsoft.Network/expressRouteCircuits@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":331},"Microsoft.Network/loadBalancers@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":383},"Microsoft.Network/loadBalancers/inboundNatRules@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":387},"Microsoft.Network/networkInterfaces@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":392},"Microsoft.Network/networkSecurityGroups@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":397},"Microsoft.Network/networkSecurityGroups/securityRules@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":401},"Microsoft.Network/networkWatchers@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":412},"Microsoft.Network/networkWatchers/packetCaptures@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":429},"Microsoft.Network/networkWatchers/connectionMonitors@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":442},"Microsoft.Network/publicIPAddresses@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":448},"Microsoft.Network/routeFilters@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":453},"Microsoft.Network/routeFilters/routeFilterRules@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":457},"Microsoft.Network/routeTables@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":462},"Microsoft.Network/routeTables/routes@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":466},"Microsoft.Network/virtualNetworks@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":484},"Microsoft.Network/virtualNetworks/subnets@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":492},"Microsoft.Network/virtualNetworkGateways@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":539},"Microsoft.Network/connections@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":614},"Microsoft.Network/localNetworkGateways@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":619},"Microsoft.Network/applicationGateways@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":257},"Microsoft.Network/applicationSecurityGroups@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":262},"Microsoft.Network/expressRouteCircuits/authorizations@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":270},"Microsoft.Network/expressRouteCircuits/peerings@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":309},"Microsoft.Network/expressRouteCircuits@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":331},"Microsoft.Network/loadBalancers@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":383},"Microsoft.Network/loadBalancers/inboundNatRules@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":387},"Microsoft.Network/networkInterfaces@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":392},"Microsoft.Network/networkSecurityGroups@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":397},"Microsoft.Network/networkSecurityGroups/securityRules@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":401},"Microsoft.Network/networkWatchers@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":412},"Microsoft.Network/networkWatchers/packetCaptures@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":429},"Microsoft.Network/networkWatchers/connectionMonitors@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":442},"Microsoft.Network/publicIPAddresses@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":448},"Microsoft.Network/routeFilters@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":453},"Microsoft.Network/routeFilters/routeFilterRules@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":457},"Microsoft.Network/routeTables@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":462},"Microsoft.Network/routeTables/routes@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":466},"Microsoft.Network/virtualNetworks@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":484},"Microsoft.Network/virtualNetworks/subnets@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":492},"Microsoft.Network/virtualNetworkGateways@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":539},"Microsoft.Network/connections@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":614},"Microsoft.Network/localNetworkGateways@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":619},"Microsoft.Network/applicationGateways@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":257},"Microsoft.Network/applicationSecurityGroups@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":262},"Microsoft.Network/ddosProtectionPlans@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":269},"Microsoft.Network/expressRouteCircuits/authorizations@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":277},"Microsoft.Network/expressRouteCircuits/peerings@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":323},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":327},"Microsoft.Network/expressRouteCircuits@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":349},"Microsoft.Network/expressRouteCrossConnections@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":371},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":375},"Microsoft.Network/loadBalancers@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":428},"Microsoft.Network/loadBalancers/inboundNatRules@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":432},"Microsoft.Network/networkInterfaces@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":437},"Microsoft.Network/networkSecurityGroups@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":442},"Microsoft.Network/networkSecurityGroups/securityRules@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":446},"Microsoft.Network/networkWatchers@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":457},"Microsoft.Network/networkWatchers/packetCaptures@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":474},"Microsoft.Network/networkWatchers/connectionMonitors@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":487},"Microsoft.Network/publicIPAddresses@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":493},"Microsoft.Network/routeFilters@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":498},"Microsoft.Network/routeFilters/routeFilterRules@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":502},"Microsoft.Network/routeTables@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":507},"Microsoft.Network/routeTables/routes@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":511},"Microsoft.Network/virtualNetworks@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":529},"Microsoft.Network/virtualNetworks/subnets@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":533},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":537},"Microsoft.Network/virtualNetworkGateways@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":637},"Microsoft.Network/connections@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":666},"Microsoft.Network/localNetworkGateways@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":671},"Microsoft.Network/azureFirewalls@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":67},"Microsoft.Network/applicationGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":323},"Microsoft.Network/applicationSecurityGroups@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":328},"Microsoft.Network/ddosProtectionPlans@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":335},"Microsoft.Network/expressRouteCircuits/authorizations@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":343},"Microsoft.Network/expressRouteCircuits/peerings@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":389},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":393},"Microsoft.Network/expressRouteCircuits@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":415},"Microsoft.Network/expressRouteCrossConnections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":437},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":441},"Microsoft.Network/loadBalancers@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":494},"Microsoft.Network/loadBalancers/inboundNatRules@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":498},"Microsoft.Network/networkInterfaces@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":503},"Microsoft.Network/networkSecurityGroups@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":508},"Microsoft.Network/networkSecurityGroups/securityRules@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":512},"Microsoft.Network/networkWatchers@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":523},"Microsoft.Network/networkWatchers/packetCaptures@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":540},"Microsoft.Network/networkWatchers/connectionMonitors@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":553},"Microsoft.Network/publicIPAddresses@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":559},"Microsoft.Network/routeFilters@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":564},"Microsoft.Network/routeFilters/routeFilterRules@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":568},"Microsoft.Network/routeTables@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":573},"Microsoft.Network/routeTables/routes@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":577},"Microsoft.Network/virtualNetworks@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":595},"Microsoft.Network/virtualNetworks/subnets@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":599},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":603},"Microsoft.Network/virtualNetworkGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":716},"Microsoft.Network/connections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":745},"Microsoft.Network/localNetworkGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":750},"Microsoft.Network/virtualWans@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":763},"Microsoft.Network/vpnSites@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":775},"Microsoft.Network/virtualHubs@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":795},"Microsoft.Network/vpnGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":821},"Microsoft.Network/vpnGateways/vpnConnections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":825},"Microsoft.Network/azureFirewalls@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":67},"Microsoft.Network/applicationGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":323},"Microsoft.Network/applicationSecurityGroups@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":328},"Microsoft.Network/ddosProtectionPlans@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":335},"Microsoft.Network/expressRouteCircuits/authorizations@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":343},"Microsoft.Network/expressRouteCircuits/peerings@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":389},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":393},"Microsoft.Network/expressRouteCircuits@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":415},"Microsoft.Network/expressRouteCrossConnections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":437},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":441},"Microsoft.Network/loadBalancers@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":494},"Microsoft.Network/loadBalancers/inboundNatRules@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":498},"Microsoft.Network/networkInterfaces@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":503},"Microsoft.Network/networkSecurityGroups@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":508},"Microsoft.Network/networkSecurityGroups/securityRules@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":512},"Microsoft.Network/networkWatchers@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":523},"Microsoft.Network/networkWatchers/packetCaptures@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":540},"Microsoft.Network/networkWatchers/connectionMonitors@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":553},"Microsoft.Network/publicIPAddresses@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":559},"Microsoft.Network/routeFilters@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":564},"Microsoft.Network/routeFilters/routeFilterRules@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":568},"Microsoft.Network/routeTables@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":573},"Microsoft.Network/routeTables/routes@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":577},"Microsoft.Network/virtualNetworks@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":595},"Microsoft.Network/virtualNetworks/subnets@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":599},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":603},"Microsoft.Network/virtualNetworkGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":716},"Microsoft.Network/connections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":745},"Microsoft.Network/localNetworkGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":750},"Microsoft.Network/virtualWans@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":763},"Microsoft.Network/vpnSites@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":775},"Microsoft.Network/virtualHubs@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":795},"Microsoft.Network/vpnGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":821},"Microsoft.Network/vpnGateways/vpnConnections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":825},"Microsoft.Network/azureFirewalls@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":67},"Microsoft.Network/applicationGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":332},"Microsoft.Network/applicationSecurityGroups@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":337},"Microsoft.Network/ddosProtectionPlans@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":344},"Microsoft.Network/expressRouteCircuits/authorizations@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":352},"Microsoft.Network/expressRouteCircuits/peerings@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":398},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":402},"Microsoft.Network/expressRouteCircuits@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":424},"Microsoft.Network/expressRouteCrossConnections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":446},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":450},"Microsoft.Network/loadBalancers@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":507},"Microsoft.Network/loadBalancers/inboundNatRules@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":511},"Microsoft.Network/networkInterfaces@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":516},"Microsoft.Network/networkSecurityGroups@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":521},"Microsoft.Network/networkSecurityGroups/securityRules@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":525},"Microsoft.Network/networkWatchers@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":536},"Microsoft.Network/networkWatchers/packetCaptures@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":553},"Microsoft.Network/networkWatchers/connectionMonitors@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":566},"Microsoft.Network/publicIPAddresses@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":572},"Microsoft.Network/publicIPPrefixes@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":588},"Microsoft.Network/routeFilters@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":593},"Microsoft.Network/routeFilters/routeFilterRules@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":597},"Microsoft.Network/routeTables@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":602},"Microsoft.Network/routeTables/routes@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":606},"Microsoft.Network/virtualNetworks@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":624},"Microsoft.Network/virtualNetworks/subnets@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":628},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":632},"Microsoft.Network/virtualNetworkGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":745},"Microsoft.Network/connections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":774},"Microsoft.Network/localNetworkGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":779},"Microsoft.Network/virtualWans@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":792},"Microsoft.Network/vpnSites@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":804},"Microsoft.Network/virtualHubs@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":824},"Microsoft.Network/vpnGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":850},"Microsoft.Network/vpnGateways/vpnConnections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":854},"Microsoft.Network/serviceEndpointPolicies@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":859},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":863},"Microsoft.Network/applicationGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":321},"Microsoft.Network/applicationSecurityGroups@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":326},"Microsoft.Network/azureFirewalls@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":409},"Microsoft.Network/ddosProtectionPlans@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":416},"Microsoft.Network/expressRouteCircuits/authorizations@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":424},"Microsoft.Network/expressRouteCircuits/peerings@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":471},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":475},"Microsoft.Network/expressRouteCircuits@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":498},"Microsoft.Network/expressRouteCrossConnections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":520},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":524},"Microsoft.Network/expressRouteGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":547},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":551},"Microsoft.Network/ExpressRoutePorts@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":570},"Microsoft.Network/interfaceEndpoints@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":575},"Microsoft.Network/loadBalancers@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":622},"Microsoft.Network/loadBalancers/inboundNatRules@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":626},"Microsoft.Network/networkInterfaces@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":631},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":635},"Microsoft.Network/networkProfiles@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":653},"Microsoft.Network/networkSecurityGroups@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":658},"Microsoft.Network/networkSecurityGroups/securityRules@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":662},"Microsoft.Network/networkWatchers@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":673},"Microsoft.Network/networkWatchers/packetCaptures@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":690},"Microsoft.Network/networkWatchers/connectionMonitors@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":703},"Microsoft.Network/publicIPAddresses@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":709},"Microsoft.Network/publicIPPrefixes@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":725},"Microsoft.Network/routeFilters@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":730},"Microsoft.Network/routeFilters/routeFilterRules@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":734},"Microsoft.Network/routeTables@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":739},"Microsoft.Network/routeTables/routes@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":743},"Microsoft.Network/serviceEndpointPolicies@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":748},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":752},"Microsoft.Network/virtualNetworks@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":770},"Microsoft.Network/virtualNetworks/subnets@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":774},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":778},"Microsoft.Network/virtualNetworkTaps@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":783},"Microsoft.Network/virtualNetworkGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":896},"Microsoft.Network/connections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":928},"Microsoft.Network/localNetworkGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":933},"Microsoft.Network/virtualWans@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":972},"Microsoft.Network/vpnSites@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":984},"Microsoft.Network/virtualHubs@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1007},"Microsoft.Network/vpnGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1035},"Microsoft.Network/vpnGateways/vpnConnections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1039},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1043},"Microsoft.Network/p2svpnGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1056},"Microsoft.Network/applicationGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":338},"Microsoft.Network/applicationSecurityGroups@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":343},"Microsoft.Network/azureFirewalls@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":426},"Microsoft.Network/ddosProtectionPlans@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":433},"Microsoft.Network/expressRouteCircuits/authorizations@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":441},"Microsoft.Network/expressRouteCircuits/peerings@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":488},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":492},"Microsoft.Network/expressRouteCircuits@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":515},"Microsoft.Network/expressRouteCrossConnections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":537},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":541},"Microsoft.Network/expressRouteGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":564},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":568},"Microsoft.Network/ExpressRoutePorts@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":587},"Microsoft.Network/interfaceEndpoints@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":592},"Microsoft.Network/loadBalancers@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":639},"Microsoft.Network/loadBalancers/inboundNatRules@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":643},"Microsoft.Network/networkInterfaces@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":648},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":652},"Microsoft.Network/networkProfiles@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":670},"Microsoft.Network/networkSecurityGroups@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":675},"Microsoft.Network/networkSecurityGroups/securityRules@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":679},"Microsoft.Network/networkWatchers@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":690},"Microsoft.Network/networkWatchers/packetCaptures@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":707},"Microsoft.Network/networkWatchers/connectionMonitors@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":720},"Microsoft.Network/publicIPAddresses@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":726},"Microsoft.Network/publicIPPrefixes@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":742},"Microsoft.Network/routeFilters@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":747},"Microsoft.Network/routeFilters/routeFilterRules@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":751},"Microsoft.Network/routeTables@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":756},"Microsoft.Network/routeTables/routes@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":760},"Microsoft.Network/serviceEndpointPolicies@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":765},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":769},"Microsoft.Network/virtualNetworks@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":787},"Microsoft.Network/virtualNetworks/subnets@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":791},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":795},"Microsoft.Network/virtualNetworkGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":908},"Microsoft.Network/connections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":940},"Microsoft.Network/localNetworkGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":945},"Microsoft.Network/virtualNetworkTaps@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":950},"Microsoft.Network/virtualWans@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":989},"Microsoft.Network/vpnSites@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1001},"Microsoft.Network/virtualHubs@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1024},"Microsoft.Network/vpnGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1052},"Microsoft.Network/vpnGateways/vpnConnections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1056},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1060},"Microsoft.Network/p2svpnGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1073},"Microsoft.Network/applicationGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":342},"Microsoft.Network/applicationSecurityGroups@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":347},"Microsoft.Network/azureFirewalls@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":430},"Microsoft.Network/ddosCustomPolicies@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":448},"Microsoft.Network/ddosProtectionPlans@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":455},"Microsoft.Network/expressRouteCircuits/authorizations@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":463},"Microsoft.Network/expressRouteCircuits/peerings@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":510},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":514},"Microsoft.Network/expressRouteCircuits@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":537},"Microsoft.Network/expressRouteCrossConnections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":559},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":563},"Microsoft.Network/expressRouteGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":586},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":590},"Microsoft.Network/ExpressRoutePorts@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":609},"Microsoft.Network/interfaceEndpoints@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":614},"Microsoft.Network/loadBalancers@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":661},"Microsoft.Network/loadBalancers/inboundNatRules@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":665},"Microsoft.Network/networkInterfaces@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":670},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":674},"Microsoft.Network/networkProfiles@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":692},"Microsoft.Network/networkSecurityGroups@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":697},"Microsoft.Network/networkSecurityGroups/securityRules@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":701},"Microsoft.Network/networkWatchers@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":712},"Microsoft.Network/networkWatchers/packetCaptures@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":729},"Microsoft.Network/networkWatchers/connectionMonitors@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":742},"Microsoft.Network/publicIPAddresses@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":748},"Microsoft.Network/publicIPPrefixes@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":764},"Microsoft.Network/routeFilters@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":769},"Microsoft.Network/routeFilters/routeFilterRules@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":773},"Microsoft.Network/routeTables@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":778},"Microsoft.Network/routeTables/routes@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":782},"Microsoft.Network/serviceEndpointPolicies@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":787},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":791},"Microsoft.Network/virtualNetworks@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":809},"Microsoft.Network/virtualNetworks/subnets@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":813},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":817},"Microsoft.Network/virtualNetworkGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":930},"Microsoft.Network/connections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":962},"Microsoft.Network/localNetworkGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":967},"Microsoft.Network/virtualNetworkTaps@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":972},"Microsoft.Network/virtualWans@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1011},"Microsoft.Network/vpnSites@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1023},"Microsoft.Network/virtualHubs@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1046},"Microsoft.Network/vpnGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1074},"Microsoft.Network/vpnGateways/vpnConnections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1078},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1082},"Microsoft.Network/p2svpnGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1095},"Microsoft.Network/applicationGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":344},"Microsoft.Network/applicationSecurityGroups@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":349},"Microsoft.Network/azureFirewalls@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":437},"Microsoft.Network/ddosCustomPolicies@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":455},"Microsoft.Network/ddosProtectionPlans@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":462},"Microsoft.Network/expressRouteCircuits/authorizations@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":470},"Microsoft.Network/expressRouteCircuits/peerings@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":524},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":528},"Microsoft.Network/expressRouteCircuits@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":552},"Microsoft.Network/expressRouteCrossConnections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":574},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":578},"Microsoft.Network/expressRouteGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":601},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":605},"Microsoft.Network/ExpressRoutePorts@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":624},"Microsoft.Network/interfaceEndpoints@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":629},"Microsoft.Network/loadBalancers@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":676},"Microsoft.Network/loadBalancers/inboundNatRules@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":680},"Microsoft.Network/networkInterfaces@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":685},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":689},"Microsoft.Network/networkProfiles@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":707},"Microsoft.Network/networkSecurityGroups@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":712},"Microsoft.Network/networkSecurityGroups/securityRules@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":716},"Microsoft.Network/networkWatchers@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":727},"Microsoft.Network/networkWatchers/packetCaptures@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":744},"Microsoft.Network/networkWatchers/connectionMonitors@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":757},"Microsoft.Network/publicIPAddresses@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":763},"Microsoft.Network/publicIPPrefixes@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":779},"Microsoft.Network/routeFilters@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":784},"Microsoft.Network/routeFilters/routeFilterRules@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":788},"Microsoft.Network/routeTables@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":793},"Microsoft.Network/routeTables/routes@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":797},"Microsoft.Network/serviceEndpointPolicies@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":802},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":806},"Microsoft.Network/virtualNetworks@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":824},"Microsoft.Network/virtualNetworks/subnets@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":828},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":832},"Microsoft.Network/virtualNetworkGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":945},"Microsoft.Network/connections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":977},"Microsoft.Network/localNetworkGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":982},"Microsoft.Network/virtualNetworkTaps@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":987},"Microsoft.Network/virtualWans@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1026},"Microsoft.Network/vpnSites@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1038},"Microsoft.Network/virtualHubs@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1061},"Microsoft.Network/vpnGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1089},"Microsoft.Network/vpnGateways/vpnConnections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1093},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1097},"Microsoft.Network/p2svpnGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1110},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1176},"Microsoft.Network/applicationGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":346},"Microsoft.Network/applicationSecurityGroups@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":351},"Microsoft.Network/azureFirewalls@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":438},"Microsoft.Network/ddosCustomPolicies@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":456},"Microsoft.Network/ddosProtectionPlans@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":463},"Microsoft.Network/expressRouteCircuits/authorizations@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":471},"Microsoft.Network/expressRouteCircuits/peerings@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":525},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":529},"Microsoft.Network/expressRouteCircuits@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":553},"Microsoft.Network/expressRouteCrossConnections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":575},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":579},"Microsoft.Network/expressRouteGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":602},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":606},"Microsoft.Network/ExpressRoutePorts@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":625},"Microsoft.Network/interfaceEndpoints@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":630},"Microsoft.Network/loadBalancers@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":677},"Microsoft.Network/loadBalancers/inboundNatRules@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":681},"Microsoft.Network/natGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":693},"Microsoft.Network/networkInterfaces@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":698},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":702},"Microsoft.Network/networkProfiles@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":720},"Microsoft.Network/networkSecurityGroups@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":725},"Microsoft.Network/networkSecurityGroups/securityRules@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":729},"Microsoft.Network/networkWatchers@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":740},"Microsoft.Network/networkWatchers/packetCaptures@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":757},"Microsoft.Network/networkWatchers/connectionMonitors@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":770},"Microsoft.Network/publicIPAddresses@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":776},"Microsoft.Network/publicIPPrefixes@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":792},"Microsoft.Network/routeFilters@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":797},"Microsoft.Network/routeFilters/routeFilterRules@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":801},"Microsoft.Network/routeTables@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":806},"Microsoft.Network/routeTables/routes@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":810},"Microsoft.Network/serviceEndpointPolicies@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":815},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":819},"Microsoft.Network/virtualNetworks@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":837},"Microsoft.Network/virtualNetworks/subnets@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":841},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":845},"Microsoft.Network/virtualNetworkGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":958},"Microsoft.Network/connections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":990},"Microsoft.Network/localNetworkGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":995},"Microsoft.Network/virtualNetworkTaps@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1000},"Microsoft.Network/virtualWans@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1039},"Microsoft.Network/vpnSites@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1051},"Microsoft.Network/virtualHubs@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1074},"Microsoft.Network/vpnGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1102},"Microsoft.Network/vpnGateways/vpnConnections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1106},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1110},"Microsoft.Network/p2svpnGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1123},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1189},"Microsoft.Network/applicationGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":365},"Microsoft.Network/applicationSecurityGroups@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":370},"Microsoft.Network/azureFirewalls@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":458},"Microsoft.Network/bastionHosts@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":480},"Microsoft.Network/ddosCustomPolicies@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":498},"Microsoft.Network/ddosProtectionPlans@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":505},"Microsoft.Network/expressRouteCircuits/authorizations@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":513},"Microsoft.Network/expressRouteCircuits/peerings@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":553},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":557},"Microsoft.Network/expressRouteCircuits@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":582},"Microsoft.Network/expressRouteCrossConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":604},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":608},"Microsoft.Network/expressRouteGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":631},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":635},"Microsoft.Network/ExpressRoutePorts@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":654},"Microsoft.Network/privateEndpoints@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":659},"Microsoft.Network/privateLinkServices@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":699},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":703},"Microsoft.Network/loadBalancers@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":750},"Microsoft.Network/loadBalancers/inboundNatRules@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":754},"Microsoft.Network/natGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":767},"Microsoft.Network/networkInterfaces@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":772},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":776},"Microsoft.Network/networkProfiles@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":794},"Microsoft.Network/networkSecurityGroups@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":799},"Microsoft.Network/networkSecurityGroups/securityRules@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":803},"Microsoft.Network/networkWatchers@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":814},"Microsoft.Network/networkWatchers/packetCaptures@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":831},"Microsoft.Network/networkWatchers/connectionMonitors@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":844},"Microsoft.Network/publicIPAddresses@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":850},"Microsoft.Network/publicIPPrefixes@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":866},"Microsoft.Network/routeFilters@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":883},"Microsoft.Network/routeFilters/routeFilterRules@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":887},"Microsoft.Network/routeTables@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":892},"Microsoft.Network/routeTables/routes@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":896},"Microsoft.Network/serviceEndpointPolicies@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":901},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":905},"Microsoft.Network/virtualNetworks@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":923},"Microsoft.Network/virtualNetworks/subnets@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":927},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":931},"Microsoft.Network/virtualNetworkGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1044},"Microsoft.Network/connections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1076},"Microsoft.Network/localNetworkGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1081},"Microsoft.Network/virtualNetworkTaps@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1086},"Microsoft.Network/virtualWans@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1125},"Microsoft.Network/vpnSites@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1137},"Microsoft.Network/virtualHubs@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1160},"Microsoft.Network/vpnGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1188},"Microsoft.Network/vpnGateways/vpnConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1192},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1196},"Microsoft.Network/p2svpnGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1209},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1275},"Microsoft.Network/applicationGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":365},"Microsoft.Network/applicationSecurityGroups@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":370},"Microsoft.Network/azureFirewalls@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":461},"Microsoft.Network/bastionHosts@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":483},"Microsoft.Network/ddosCustomPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":501},"Microsoft.Network/ddosProtectionPlans@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":508},"Microsoft.Network/expressRouteCircuits/authorizations@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":516},"Microsoft.Network/expressRouteCircuits/peerings@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":556},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":560},"Microsoft.Network/expressRouteCircuits@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":585},"Microsoft.Network/expressRouteCrossConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":607},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":611},"Microsoft.Network/expressRouteGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":634},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":638},"Microsoft.Network/ExpressRoutePorts@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":657},"Microsoft.Network/firewallPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":675},"Microsoft.Network/firewallPolicies/ruleGroups@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":724},"Microsoft.Network/loadBalancers@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":771},"Microsoft.Network/loadBalancers/inboundNatRules@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":775},"Microsoft.Network/natGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":788},"Microsoft.Network/networkInterfaces@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":793},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":797},"Microsoft.Network/networkProfiles@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":815},"Microsoft.Network/networkSecurityGroups@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":820},"Microsoft.Network/networkSecurityGroups/securityRules@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":824},"Microsoft.Network/networkWatchers@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":835},"Microsoft.Network/networkWatchers/packetCaptures@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":852},"Microsoft.Network/networkWatchers/connectionMonitors@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":865},"Microsoft.Network/privateEndpoints@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":870},"Microsoft.Network/privateLinkServices@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":910},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":914},"Microsoft.Network/publicIPAddresses@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":920},"Microsoft.Network/publicIPPrefixes@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":936},"Microsoft.Network/routeFilters@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":953},"Microsoft.Network/routeFilters/routeFilterRules@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":957},"Microsoft.Network/routeTables@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":962},"Microsoft.Network/routeTables/routes@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":966},"Microsoft.Network/serviceEndpointPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":971},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":975},"Microsoft.Network/virtualNetworks@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":993},"Microsoft.Network/virtualNetworks/subnets@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":997},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1001},"Microsoft.Network/virtualNetworkGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1114},"Microsoft.Network/connections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1146},"Microsoft.Network/localNetworkGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1151},"Microsoft.Network/virtualNetworkTaps@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1156},"Microsoft.Network/virtualWans@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1195},"Microsoft.Network/vpnSites@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1217},"Microsoft.Network/virtualHubs@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1240},"Microsoft.Network/vpnGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1285},"Microsoft.Network/vpnGateways/vpnConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1289},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1293},"Microsoft.Network/p2svpnGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1306},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1372},"Microsoft.Network/applicationGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":552},"Microsoft.Network/applicationSecurityGroups@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":557},"Microsoft.Network/azureFirewalls@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":649},"Microsoft.Network/bastionHosts@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":671},"Microsoft.Network/ddosCustomPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":694},"Microsoft.Network/ddosProtectionPlans@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":706},"Microsoft.Network/expressRouteCircuits/authorizations@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":719},"Microsoft.Network/expressRouteCircuits/peerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":774},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":778},"Microsoft.Network/expressRouteCircuits@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":808},"Microsoft.Network/expressRouteCrossConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":840},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":844},"Microsoft.Network/expressRouteGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":867},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":871},"Microsoft.Network/ExpressRoutePorts@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":904},"Microsoft.Network/firewallPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":922},"Microsoft.Network/firewallPolicies/ruleGroups@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":971},"Microsoft.Network/loadBalancers@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1043},"Microsoft.Network/loadBalancers/inboundNatRules@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1047},"Microsoft.Network/natGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1065},"Microsoft.Network/networkInterfaces@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1070},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1074},"Microsoft.Network/networkProfiles@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1112},"Microsoft.Network/networkSecurityGroups@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1117},"Microsoft.Network/networkSecurityGroups/securityRules@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1121},"Microsoft.Network/networkWatchers@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1132},"Microsoft.Network/networkWatchers/packetCaptures@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1149},"Microsoft.Network/networkWatchers/connectionMonitors@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1162},"Microsoft.Network/privateEndpoints@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1167},"Microsoft.Network/privateLinkServices@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1207},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1211},"Microsoft.Network/publicIPAddresses@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1217},"Microsoft.Network/publicIPPrefixes@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1238},"Microsoft.Network/routeFilters@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1265},"Microsoft.Network/routeFilters/routeFilterRules@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1269},"Microsoft.Network/routeTables@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1274},"Microsoft.Network/routeTables/routes@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1278},"Microsoft.Network/serviceEndpointPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1283},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1287},"Microsoft.Network/virtualNetworks@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1315},"Microsoft.Network/virtualNetworks/subnets@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1319},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1323},"Microsoft.Network/virtualNetworkGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1468},"Microsoft.Network/connections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1514},"Microsoft.Network/localNetworkGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1519},"Microsoft.Network/virtualNetworkTaps@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1524},"Microsoft.Network/virtualRouters@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1537},"Microsoft.Network/virtualRouters/peerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1547},"Microsoft.Network/virtualWans@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1611},"Microsoft.Network/vpnSites@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1633},"Microsoft.Network/virtualHubs@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1656},"Microsoft.Network/vpnGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1701},"Microsoft.Network/vpnGateways/vpnConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1705},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1709},"Microsoft.Network/p2svpnGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1722},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1793},"Microsoft.Network/applicationGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":553},"Microsoft.Network/applicationSecurityGroups@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":558},"Microsoft.Network/azureFirewalls@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":656},"Microsoft.Network/bastionHosts@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":678},"Microsoft.Network/ddosCustomPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":701},"Microsoft.Network/ddosProtectionPlans@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":713},"Microsoft.Network/expressRouteCircuits/authorizations@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":726},"Microsoft.Network/expressRouteCircuits/peerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":781},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":785},"Microsoft.Network/expressRouteCircuits@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":815},"Microsoft.Network/expressRouteCrossConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":847},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":851},"Microsoft.Network/expressRouteGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":874},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":878},"Microsoft.Network/ExpressRoutePorts@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":911},"Microsoft.Network/firewallPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":929},"Microsoft.Network/firewallPolicies/ruleGroups@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":976},"Microsoft.Network/loadBalancers@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1048},"Microsoft.Network/loadBalancers/inboundNatRules@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1052},"Microsoft.Network/natGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1070},"Microsoft.Network/networkInterfaces@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1075},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1079},"Microsoft.Network/networkProfiles@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1117},"Microsoft.Network/networkSecurityGroups@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1122},"Microsoft.Network/networkSecurityGroups/securityRules@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1126},"Microsoft.Network/networkWatchers@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1137},"Microsoft.Network/networkWatchers/packetCaptures@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1154},"Microsoft.Network/networkWatchers/connectionMonitors@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1167},"Microsoft.Network/privateEndpoints@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1172},"Microsoft.Network/privateLinkServices@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1212},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1216},"Microsoft.Network/publicIPAddresses@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1222},"Microsoft.Network/publicIPPrefixes@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1243},"Microsoft.Network/routeFilters@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1270},"Microsoft.Network/routeFilters/routeFilterRules@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1274},"Microsoft.Network/routeTables@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1279},"Microsoft.Network/routeTables/routes@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1283},"Microsoft.Network/serviceEndpointPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1288},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1292},"Microsoft.Network/virtualNetworks@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1321},"Microsoft.Network/virtualNetworks/subnets@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1325},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1329},"Microsoft.Network/virtualNetworkGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1474},"Microsoft.Network/connections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1520},"Microsoft.Network/localNetworkGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1525},"Microsoft.Network/virtualNetworkTaps@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1530},"Microsoft.Network/virtualRouters@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1543},"Microsoft.Network/virtualRouters/peerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1553},"Microsoft.Network/virtualWans@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1571},"Microsoft.Network/vpnSites@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1593},"Microsoft.Network/vpnServerConfigurations@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1637},"Microsoft.Network/virtualHubs@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1660},"Microsoft.Network/vpnGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1705},"Microsoft.Network/vpnGateways/vpnConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1709},"Microsoft.Network/p2svpnGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1714},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1806},"Microsoft.Network/applicationGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":554},"Microsoft.Network/applicationSecurityGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":559},"Microsoft.Network/azureFirewalls@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":663},"Microsoft.Network/bastionHosts@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":685},"Microsoft.Network/ddosCustomPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":708},"Microsoft.Network/ddosProtectionPlans@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":720},"Microsoft.Network/expressRouteCircuits/authorizations@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":733},"Microsoft.Network/expressRouteCircuits/peerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":788},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":792},"Microsoft.Network/expressRouteCircuits@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":822},"Microsoft.Network/expressRouteCrossConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":854},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":858},"Microsoft.Network/expressRouteGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":881},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":885},"Microsoft.Network/ExpressRoutePorts@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":918},"Microsoft.Network/firewallPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":936},"Microsoft.Network/firewallPolicies/ruleGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":983},"Microsoft.Network/ipGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":996},"Microsoft.Network/loadBalancers@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1068},"Microsoft.Network/loadBalancers/inboundNatRules@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1072},"Microsoft.Network/natGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1090},"Microsoft.Network/networkInterfaces@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1095},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1099},"Microsoft.Network/networkProfiles@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1137},"Microsoft.Network/networkSecurityGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1142},"Microsoft.Network/networkSecurityGroups/securityRules@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1146},"Microsoft.Network/networkWatchers@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1157},"Microsoft.Network/networkWatchers/packetCaptures@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1174},"Microsoft.Network/networkWatchers/connectionMonitors@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1187},"Microsoft.Network/privateEndpoints@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1192},"Microsoft.Network/privateLinkServices@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1232},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1236},"Microsoft.Network/publicIPAddresses@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1242},"Microsoft.Network/publicIPPrefixes@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1263},"Microsoft.Network/routeFilters@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1290},"Microsoft.Network/routeFilters/routeFilterRules@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1294},"Microsoft.Network/routeTables@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1299},"Microsoft.Network/routeTables/routes@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1303},"Microsoft.Network/serviceEndpointPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1308},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1312},"Microsoft.Network/virtualNetworks@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1341},"Microsoft.Network/virtualNetworks/subnets@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1345},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1349},"Microsoft.Network/virtualNetworkGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1494},"Microsoft.Network/connections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1540},"Microsoft.Network/localNetworkGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1545},"Microsoft.Network/virtualNetworkTaps@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1550},"Microsoft.Network/virtualRouters@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1563},"Microsoft.Network/virtualRouters/peerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1573},"Microsoft.Network/virtualWans@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1591},"Microsoft.Network/vpnSites@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1613},"Microsoft.Network/vpnServerConfigurations@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1657},"Microsoft.Network/virtualHubs@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1693},"Microsoft.Network/vpnGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1738},"Microsoft.Network/vpnGateways/vpnConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1742},"Microsoft.Network/p2svpnGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1747},"Microsoft.Network/virtualHubs/routeTables@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1751},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1846},"Microsoft.Network/applicationGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":555},"Microsoft.Network/applicationSecurityGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":560},"Microsoft.Network/azureFirewalls@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":666},"Microsoft.Network/bastionHosts@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":688},"Microsoft.Network/ddosCustomPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":711},"Microsoft.Network/ddosProtectionPlans@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":723},"Microsoft.Network/expressRouteCircuits/authorizations@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":736},"Microsoft.Network/expressRouteCircuits/peerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":791},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":795},"Microsoft.Network/expressRouteCircuits@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":825},"Microsoft.Network/expressRouteCrossConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":857},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":861},"Microsoft.Network/expressRouteGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":884},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":888},"Microsoft.Network/ExpressRoutePorts@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":921},"Microsoft.Network/firewallPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":939},"Microsoft.Network/firewallPolicies/ruleGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":986},"Microsoft.Network/ipGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":999},"Microsoft.Network/loadBalancers@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1071},"Microsoft.Network/loadBalancers/inboundNatRules@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1075},"Microsoft.Network/natGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1093},"Microsoft.Network/networkInterfaces@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1098},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1102},"Microsoft.Network/networkProfiles@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1140},"Microsoft.Network/networkSecurityGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1145},"Microsoft.Network/networkSecurityGroups/securityRules@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1149},"Microsoft.Network/networkWatchers@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1160},"Microsoft.Network/networkWatchers/packetCaptures@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1177},"Microsoft.Network/networkWatchers/connectionMonitors@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1231},"Microsoft.Network/networkWatchers/flowLogs@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1248},"Microsoft.Network/privateEndpoints@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1253},"Microsoft.Network/privateLinkServices@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1293},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1297},"Microsoft.Network/publicIPAddresses@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1303},"Microsoft.Network/publicIPPrefixes@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1324},"Microsoft.Network/routeFilters@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1351},"Microsoft.Network/routeFilters/routeFilterRules@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1355},"Microsoft.Network/routeTables@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1360},"Microsoft.Network/routeTables/routes@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1364},"Microsoft.Network/serviceEndpointPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1369},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1373},"Microsoft.Network/virtualNetworks@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1402},"Microsoft.Network/virtualNetworks/subnets@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1406},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1410},"Microsoft.Network/virtualNetworkGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1555},"Microsoft.Network/connections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1601},"Microsoft.Network/localNetworkGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1606},"Microsoft.Network/virtualNetworkTaps@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1611},"Microsoft.Network/virtualRouters@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1624},"Microsoft.Network/virtualRouters/peerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1634},"Microsoft.Network/virtualWans@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1652},"Microsoft.Network/vpnSites@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1674},"Microsoft.Network/vpnServerConfigurations@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1718},"Microsoft.Network/virtualHubs@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1754},"Microsoft.Network/vpnGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1799},"Microsoft.Network/vpnGateways/vpnConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1803},"Microsoft.Network/p2svpnGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1808},"Microsoft.Network/virtualHubs/routeTables@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1812},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1907},"Microsoft.Network/applicationGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":570},"Microsoft.Network/applicationSecurityGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":575},"Microsoft.Network/azureFirewalls@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":681},"Microsoft.Network/bastionHosts@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":703},"Microsoft.Network/ddosCustomPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":726},"Microsoft.Network/ddosProtectionPlans@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":738},"Microsoft.Network/expressRouteCircuits/authorizations@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":751},"Microsoft.Network/expressRouteCircuits/peerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":811},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":815},"Microsoft.Network/expressRouteCircuits@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":845},"Microsoft.Network/expressRouteCrossConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":877},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":881},"Microsoft.Network/expressRouteGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":904},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":908},"Microsoft.Network/ExpressRoutePorts@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":941},"Microsoft.Network/firewallPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":959},"Microsoft.Network/firewallPolicies/ruleGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1021},"Microsoft.Network/ipGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1034},"Microsoft.Network/loadBalancers@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1106},"Microsoft.Network/loadBalancers/inboundNatRules@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1110},"Microsoft.Network/natGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1128},"Microsoft.Network/networkInterfaces@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1133},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1137},"Microsoft.Network/networkProfiles@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1175},"Microsoft.Network/networkSecurityGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1180},"Microsoft.Network/networkSecurityGroups/securityRules@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1184},"Microsoft.Network/networkVirtualAppliances@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1200},"Microsoft.Network/networkWatchers@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1211},"Microsoft.Network/networkWatchers/packetCaptures@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1228},"Microsoft.Network/networkWatchers/connectionMonitors@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1282},"Microsoft.Network/networkWatchers/flowLogs@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1287},"Microsoft.Network/privateEndpoints@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1292},"Microsoft.Network/privateLinkServices@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1332},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1336},"Microsoft.Network/publicIPAddresses@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1342},"Microsoft.Network/publicIPPrefixes@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1363},"Microsoft.Network/routeFilters@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1390},"Microsoft.Network/routeFilters/routeFilterRules@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1394},"Microsoft.Network/routeTables@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1399},"Microsoft.Network/routeTables/routes@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1403},"Microsoft.Network/serviceEndpointPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1408},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1412},"Microsoft.Network/virtualNetworks@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1441},"Microsoft.Network/virtualNetworks/subnets@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1445},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1449},"Microsoft.Network/virtualNetworkGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1599},"Microsoft.Network/connections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1645},"Microsoft.Network/localNetworkGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1650},"Microsoft.Network/virtualNetworkTaps@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1655},"Microsoft.Network/virtualRouters@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1668},"Microsoft.Network/virtualRouters/peerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1678},"Microsoft.Network/virtualWans@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1696},"Microsoft.Network/vpnSites@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1718},"Microsoft.Network/vpnServerConfigurations@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1762},"Microsoft.Network/virtualHubs@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1798},"Microsoft.Network/vpnGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1843},"Microsoft.Network/vpnGateways/vpnConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1847},"Microsoft.Network/p2svpnGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1852},"Microsoft.Network/virtualHubs/routeTables@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1856},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1951},"Microsoft.Network/applicationGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":574},"Microsoft.Network/applicationSecurityGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":579},"Microsoft.Network/azureFirewalls@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":685},"Microsoft.Network/bastionHosts@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":707},"Microsoft.Network/ddosCustomPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":730},"Microsoft.Network/ddosProtectionPlans@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":742},"Microsoft.Network/expressRouteCircuits/authorizations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":755},"Microsoft.Network/expressRouteCircuits/peerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":815},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":819},"Microsoft.Network/expressRouteCircuits@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":849},"Microsoft.Network/expressRouteCrossConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":881},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":885},"Microsoft.Network/ExpressRoutePorts@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":918},"Microsoft.Network/firewallPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":936},"Microsoft.Network/firewallPolicies/ruleGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":998},"Microsoft.Network/IpAllocations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1011},"Microsoft.Network/ipGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1024},"Microsoft.Network/loadBalancers@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1096},"Microsoft.Network/loadBalancers/inboundNatRules@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1100},"Microsoft.Network/natGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1118},"Microsoft.Network/networkInterfaces@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1123},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1127},"Microsoft.Network/networkProfiles@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1165},"Microsoft.Network/networkSecurityGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1170},"Microsoft.Network/networkSecurityGroups/securityRules@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1174},"Microsoft.Network/networkVirtualAppliances@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1190},"Microsoft.Network/networkWatchers@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1201},"Microsoft.Network/networkWatchers/packetCaptures@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1218},"Microsoft.Network/networkWatchers/connectionMonitors@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1272},"Microsoft.Network/networkWatchers/flowLogs@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1277},"Microsoft.Network/privateEndpoints@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1282},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1303},"Microsoft.Network/privateLinkServices@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1343},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1347},"Microsoft.Network/publicIPAddresses@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1353},"Microsoft.Network/publicIPPrefixes@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1374},"Microsoft.Network/routeFilters@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1401},"Microsoft.Network/routeFilters/routeFilterRules@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1405},"Microsoft.Network/routeTables@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1410},"Microsoft.Network/routeTables/routes@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1414},"Microsoft.Network/securityPartnerProviders@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1434},"Microsoft.Network/serviceEndpointPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1439},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1443},"Microsoft.Network/virtualNetworks@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1473},"Microsoft.Network/virtualNetworks/subnets@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1477},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1481},"Microsoft.Network/virtualNetworkGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1633},"Microsoft.Network/connections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1679},"Microsoft.Network/localNetworkGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1684},"Microsoft.Network/virtualNetworkTaps@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1689},"Microsoft.Network/virtualRouters@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1702},"Microsoft.Network/virtualRouters/peerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1712},"Microsoft.Network/virtualWans@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1730},"Microsoft.Network/vpnSites@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1752},"Microsoft.Network/vpnServerConfigurations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1797},"Microsoft.Network/virtualHubs@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1833},"Microsoft.Network/vpnGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1878},"Microsoft.Network/vpnGateways/vpnConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1882},"Microsoft.Network/p2svpnGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1887},"Microsoft.Network/virtualHubs/routeTables@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1891},"Microsoft.Network/expressRouteGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1914},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1918},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":2013},"Microsoft.Network/applicationGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":577},"Microsoft.Network/applicationSecurityGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":582},"Microsoft.Network/azureFirewalls@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":689},"Microsoft.Network/bastionHosts@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":711},"Microsoft.Network/ddosCustomPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":734},"Microsoft.Network/ddosProtectionPlans@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":746},"Microsoft.Network/expressRouteCircuits/authorizations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":759},"Microsoft.Network/expressRouteCircuits/peerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":819},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":823},"Microsoft.Network/expressRouteCircuits@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":853},"Microsoft.Network/expressRouteCrossConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":885},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":889},"Microsoft.Network/ExpressRoutePorts@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":922},"Microsoft.Network/firewallPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":943},"Microsoft.Network/firewallPolicies/ruleGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1005},"Microsoft.Network/IpAllocations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1018},"Microsoft.Network/ipGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1031},"Microsoft.Network/loadBalancers@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1103},"Microsoft.Network/loadBalancers/backendAddressPools@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1107},"Microsoft.Network/loadBalancers/inboundNatRules@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1111},"Microsoft.Network/natGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1129},"Microsoft.Network/networkInterfaces@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1134},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1138},"Microsoft.Network/networkProfiles@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1176},"Microsoft.Network/networkSecurityGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1181},"Microsoft.Network/networkSecurityGroups/securityRules@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1185},"Microsoft.Network/networkVirtualAppliances@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1201},"Microsoft.Network/networkWatchers@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1212},"Microsoft.Network/networkWatchers/packetCaptures@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1229},"Microsoft.Network/networkWatchers/connectionMonitors@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1283},"Microsoft.Network/networkWatchers/flowLogs@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1288},"Microsoft.Network/privateEndpoints@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1293},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1314},"Microsoft.Network/privateLinkServices@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1354},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1358},"Microsoft.Network/publicIPAddresses@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1364},"Microsoft.Network/publicIPPrefixes@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1385},"Microsoft.Network/routeFilters@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1412},"Microsoft.Network/routeFilters/routeFilterRules@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1416},"Microsoft.Network/routeTables@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1421},"Microsoft.Network/routeTables/routes@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1425},"Microsoft.Network/securityPartnerProviders@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1445},"Microsoft.Network/serviceEndpointPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1450},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1454},"Microsoft.Network/virtualNetworks@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1484},"Microsoft.Network/virtualNetworks/subnets@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1492},"Microsoft.Network/virtualNetworkGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1644},"Microsoft.Network/connections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1690},"Microsoft.Network/localNetworkGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1695},"Microsoft.Network/virtualNetworkTaps@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1700},"Microsoft.Network/virtualRouters@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1713},"Microsoft.Network/virtualRouters/peerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1723},"Microsoft.Network/virtualWans@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1741},"Microsoft.Network/vpnSites@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1763},"Microsoft.Network/vpnServerConfigurations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1816},"Microsoft.Network/virtualHubs@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1852},"Microsoft.Network/vpnGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1897},"Microsoft.Network/vpnGateways/vpnConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1901},"Microsoft.Network/p2svpnGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1906},"Microsoft.Network/virtualHubs/routeTables@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1910},"Microsoft.Network/expressRouteGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1933},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1937},"Microsoft.Network/virtualHubs/hubRouteTables@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1953},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":2048},"Microsoft.Network/applicationGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":604},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":608},"Microsoft.Network/applicationSecurityGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":613},"Microsoft.Network/azureFirewalls@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":721},"Microsoft.Network/bastionHosts@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":743},"Microsoft.Network/ddosCustomPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":766},"Microsoft.Network/ddosProtectionPlans@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":778},"Microsoft.Network/expressRouteCircuits/authorizations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":791},"Microsoft.Network/expressRouteCircuits/peerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":851},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":855},"Microsoft.Network/expressRouteCircuits@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":885},"Microsoft.Network/expressRouteCrossConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":917},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":921},"Microsoft.Network/ExpressRoutePorts@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":954},"Microsoft.Network/firewallPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":977},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1041},"Microsoft.Network/IpAllocations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1054},"Microsoft.Network/ipGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1067},"Microsoft.Network/loadBalancers@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1139},"Microsoft.Network/loadBalancers/backendAddressPools@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1143},"Microsoft.Network/loadBalancers/inboundNatRules@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1147},"Microsoft.Network/natGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1165},"Microsoft.Network/networkInterfaces@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1170},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1174},"Microsoft.Network/networkProfiles@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1212},"Microsoft.Network/networkSecurityGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1217},"Microsoft.Network/networkSecurityGroups/securityRules@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1221},"Microsoft.Network/networkVirtualAppliances@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1238},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1250},"Microsoft.Network/networkWatchers@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1261},"Microsoft.Network/networkWatchers/packetCaptures@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1278},"Microsoft.Network/networkWatchers/connectionMonitors@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1332},"Microsoft.Network/networkWatchers/flowLogs@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1337},"Microsoft.Network/privateEndpoints@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1342},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1363},"Microsoft.Network/privateLinkServices@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1403},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1407},"Microsoft.Network/publicIPAddresses@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1413},"Microsoft.Network/publicIPPrefixes@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1434},"Microsoft.Network/routeFilters@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1461},"Microsoft.Network/routeFilters/routeFilterRules@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1465},"Microsoft.Network/routeTables@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1470},"Microsoft.Network/routeTables/routes@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1474},"Microsoft.Network/securityPartnerProviders@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1494},"Microsoft.Network/serviceEndpointPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1499},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1503},"Microsoft.Network/virtualNetworks@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1533},"Microsoft.Network/virtualNetworks/subnets@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1537},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1541},"Microsoft.Network/virtualNetworkGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1693},"Microsoft.Network/connections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1739},"Microsoft.Network/localNetworkGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1744},"Microsoft.Network/virtualNetworkTaps@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1749},"Microsoft.Network/virtualRouters@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1762},"Microsoft.Network/virtualRouters/peerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1772},"Microsoft.Network/virtualWans@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1790},"Microsoft.Network/vpnSites@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1812},"Microsoft.Network/vpnServerConfigurations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1866},"Microsoft.Network/virtualHubs@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1902},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1912},"Microsoft.Network/vpnGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1957},"Microsoft.Network/vpnGateways/vpnConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1961},"Microsoft.Network/p2svpnGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1966},"Microsoft.Network/virtualHubs/routeTables@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1970},"Microsoft.Network/expressRouteGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1993},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1997},"Microsoft.Network/virtualHubs/bgpConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2012},"Microsoft.Network/virtualHubs/ipConfigurations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2025},"Microsoft.Network/virtualHubs/hubRouteTables@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2041},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2136},"Microsoft.Network/applicationGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":622},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":626},"Microsoft.Network/applicationSecurityGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":631},"Microsoft.Network/azureFirewalls@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":739},"Microsoft.Network/bastionHosts@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":761},"Microsoft.Network/customIpPrefixes@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":781},"Microsoft.Network/ddosCustomPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":804},"Microsoft.Network/ddosProtectionPlans@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":816},"Microsoft.Network/dscpConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":845},"Microsoft.Network/expressRouteCircuits/authorizations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":858},"Microsoft.Network/expressRouteCircuits/peerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":918},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":922},"Microsoft.Network/expressRouteCircuits@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":952},"Microsoft.Network/expressRouteCrossConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":984},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":988},"Microsoft.Network/ExpressRoutePorts@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1026},"Microsoft.Network/firewallPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1049},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1113},"Microsoft.Network/IpAllocations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1126},"Microsoft.Network/ipGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1139},"Microsoft.Network/loadBalancers@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1211},"Microsoft.Network/loadBalancers/backendAddressPools@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1215},"Microsoft.Network/loadBalancers/inboundNatRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1219},"Microsoft.Network/natGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1237},"Microsoft.Network/networkInterfaces@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1242},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1246},"Microsoft.Network/networkProfiles@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1284},"Microsoft.Network/networkSecurityGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1289},"Microsoft.Network/networkSecurityGroups/securityRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1293},"Microsoft.Network/networkVirtualAppliances@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1311},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1323},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1338},"Microsoft.Network/networkWatchers@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1349},"Microsoft.Network/networkWatchers/packetCaptures@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1366},"Microsoft.Network/networkWatchers/connectionMonitors@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1441},"Microsoft.Network/networkWatchers/flowLogs@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1446},"Microsoft.Network/privateEndpoints@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1451},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1472},"Microsoft.Network/privateLinkServices@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1512},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1516},"Microsoft.Network/publicIPAddresses@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1522},"Microsoft.Network/publicIPPrefixes@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1543},"Microsoft.Network/routeFilters@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1570},"Microsoft.Network/routeFilters/routeFilterRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1574},"Microsoft.Network/routeTables@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1579},"Microsoft.Network/routeTables/routes@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1583},"Microsoft.Network/securityPartnerProviders@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1603},"Microsoft.Network/serviceEndpointPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1608},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1612},"Microsoft.Network/virtualNetworks@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1642},"Microsoft.Network/virtualNetworks/subnets@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1646},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1650},"Microsoft.Network/virtualNetworkGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1802},"Microsoft.Network/connections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1848},"Microsoft.Network/localNetworkGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1853},"Microsoft.Network/virtualNetworkTaps@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1858},"Microsoft.Network/virtualRouters@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1871},"Microsoft.Network/virtualRouters/peerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1881},"Microsoft.Network/virtualWans@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1899},"Microsoft.Network/vpnSites@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1923},"Microsoft.Network/vpnServerConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1977},"Microsoft.Network/virtualHubs@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2013},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2023},"Microsoft.Network/vpnGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2070},"Microsoft.Network/vpnGateways/vpnConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2074},"Microsoft.Network/p2svpnGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2079},"Microsoft.Network/virtualHubs/routeTables@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2083},"Microsoft.Network/expressRouteGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2106},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2110},"Microsoft.Network/virtualHubs/bgpConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2125},"Microsoft.Network/virtualHubs/ipConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2138},"Microsoft.Network/virtualHubs/hubRouteTables@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2154},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2249},"Microsoft.Network/applicationGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":695},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":699},"Microsoft.Network/applicationSecurityGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":704},"Microsoft.Network/azureFirewalls@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":812},"Microsoft.Network/bastionHosts@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":834},"Microsoft.Network/customIpPrefixes@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":854},"Microsoft.Network/ddosCustomPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":877},"Microsoft.Network/ddosProtectionPlans@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":889},"Microsoft.Network/dscpConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":918},"Microsoft.Network/expressRouteCircuits/authorizations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":931},"Microsoft.Network/expressRouteCircuits/peerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":991},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":995},"Microsoft.Network/expressRouteCircuits@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1025},"Microsoft.Network/expressRouteCrossConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1057},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1061},"Microsoft.Network/ExpressRoutePorts@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1099},"Microsoft.Network/firewallPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1152},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1218},"Microsoft.Network/IpAllocations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1231},"Microsoft.Network/ipGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1245},"Microsoft.Network/loadBalancers@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1320},"Microsoft.Network/loadBalancers/backendAddressPools@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1324},"Microsoft.Network/loadBalancers/inboundNatRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1328},"Microsoft.Network/natGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1334},"Microsoft.Network/networkInterfaces@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1339},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1343},"Microsoft.Network/networkProfiles@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1381},"Microsoft.Network/networkSecurityGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1386},"Microsoft.Network/networkSecurityGroups/securityRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1390},"Microsoft.Network/networkVirtualAppliances@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1408},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1420},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1435},"Microsoft.Network/networkWatchers@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1446},"Microsoft.Network/networkWatchers/packetCaptures@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1463},"Microsoft.Network/networkWatchers/connectionMonitors@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1538},"Microsoft.Network/networkWatchers/flowLogs@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1543},"Microsoft.Network/privateEndpoints@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1548},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1569},"Microsoft.Network/privateLinkServices@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1574},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1578},"Microsoft.Network/publicIPAddresses@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1584},"Microsoft.Network/publicIPPrefixes@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1608},"Microsoft.Network/routeFilters@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1635},"Microsoft.Network/routeFilters/routeFilterRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1639},"Microsoft.Network/routeTables@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1644},"Microsoft.Network/routeTables/routes@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1648},"Microsoft.Network/securityPartnerProviders@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1668},"Microsoft.Network/serviceEndpointPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1673},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1677},"Microsoft.Network/virtualNetworks@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1707},"Microsoft.Network/virtualNetworks/subnets@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1711},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1715},"Microsoft.Network/virtualNetworkGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1868},"Microsoft.Network/connections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1918},"Microsoft.Network/localNetworkGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1923},"Microsoft.Network/virtualNetworkTaps@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1928},"Microsoft.Network/virtualRouters@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1941},"Microsoft.Network/virtualRouters/peerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1951},"Microsoft.Network/virtualWans@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1969},"Microsoft.Network/vpnSites@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1993},"Microsoft.Network/vpnServerConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2047},"Microsoft.Network/virtualHubs@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2083},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2093},"Microsoft.Network/vpnGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2140},"Microsoft.Network/vpnGateways/vpnConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2144},"Microsoft.Network/p2svpnGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2149},"Microsoft.Network/virtualHubs/routeTables@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2153},"Microsoft.Network/expressRouteGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2176},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2180},"Microsoft.Network/virtualHubs/bgpConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2195},"Microsoft.Network/virtualHubs/ipConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2208},"Microsoft.Network/virtualHubs/hubRouteTables@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2224},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2319},"Microsoft.Network/applicationGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":702},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":706},"Microsoft.Network/applicationSecurityGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":711},"Microsoft.Network/azureFirewalls@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":819},"Microsoft.Network/bastionHosts@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":841},"Microsoft.Network/customIpPrefixes@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":861},"Microsoft.Network/ddosCustomPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":884},"Microsoft.Network/ddosProtectionPlans@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":896},"Microsoft.Network/dscpConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":925},"Microsoft.Network/expressRouteCircuits/authorizations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":938},"Microsoft.Network/expressRouteCircuits/peerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":998},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1002},"Microsoft.Network/expressRouteCircuits@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1032},"Microsoft.Network/expressRouteCrossConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1064},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1068},"Microsoft.Network/ExpressRoutePorts@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1106},"Microsoft.Network/firewallPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1159},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1225},"Microsoft.Network/IpAllocations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1238},"Microsoft.Network/ipGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1252},"Microsoft.Network/loadBalancers@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1327},"Microsoft.Network/loadBalancers/backendAddressPools@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1331},"Microsoft.Network/loadBalancers/inboundNatRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1335},"Microsoft.Network/natGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1341},"Microsoft.Network/networkInterfaces@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1346},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1350},"Microsoft.Network/networkProfiles@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1388},"Microsoft.Network/networkSecurityGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1393},"Microsoft.Network/networkSecurityGroups/securityRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1397},"Microsoft.Network/networkVirtualAppliances@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1415},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1427},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1442},"Microsoft.Network/networkWatchers@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1453},"Microsoft.Network/networkWatchers/packetCaptures@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1470},"Microsoft.Network/networkWatchers/connectionMonitors@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1545},"Microsoft.Network/networkWatchers/flowLogs@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1550},"Microsoft.Network/privateEndpoints@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1555},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1576},"Microsoft.Network/privateLinkServices@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1581},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1585},"Microsoft.Network/publicIPAddresses@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1591},"Microsoft.Network/publicIPPrefixes@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1615},"Microsoft.Network/routeFilters@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1642},"Microsoft.Network/routeFilters/routeFilterRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1646},"Microsoft.Network/routeTables@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1651},"Microsoft.Network/routeTables/routes@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1655},"Microsoft.Network/securityPartnerProviders@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1675},"Microsoft.Network/serviceEndpointPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1680},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1684},"Microsoft.Network/virtualNetworks@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1714},"Microsoft.Network/virtualNetworks/subnets@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1718},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1722},"Microsoft.Network/virtualNetworkGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1875},"Microsoft.Network/connections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1925},"Microsoft.Network/localNetworkGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1930},"Microsoft.Network/virtualNetworkTaps@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1935},"Microsoft.Network/virtualRouters@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1948},"Microsoft.Network/virtualRouters/peerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1958},"Microsoft.Network/virtualWans@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1976},"Microsoft.Network/vpnSites@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2000},"Microsoft.Network/vpnServerConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2054},"Microsoft.Network/virtualHubs@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2090},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2100},"Microsoft.Network/vpnGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2172},"Microsoft.Network/vpnGateways/vpnConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2176},"Microsoft.Network/vpnGateways/natRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2180},"Microsoft.Network/p2svpnGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2185},"Microsoft.Network/virtualHubs/routeTables@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2189},"Microsoft.Network/expressRouteGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2212},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2216},"Microsoft.Network/virtualHubs/bgpConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2231},"Microsoft.Network/virtualHubs/ipConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2244},"Microsoft.Network/virtualHubs/hubRouteTables@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2260},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2355},"Microsoft.Network/applicationGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":702},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":706},"Microsoft.Network/applicationSecurityGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":711},"Microsoft.Network/azureFirewalls@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":819},"Microsoft.Network/bastionHosts@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":841},"Microsoft.Network/networkInterfaces@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":846},"Microsoft.Network/publicIPAddresses@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":852},"Microsoft.Network/customIpPrefixes@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":872},"Microsoft.Network/ddosCustomPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":895},"Microsoft.Network/ddosProtectionPlans@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":907},"Microsoft.Network/dscpConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":936},"Microsoft.Network/expressRouteCircuits/authorizations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":949},"Microsoft.Network/expressRouteCircuits/peerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1009},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1013},"Microsoft.Network/expressRouteCircuits@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1043},"Microsoft.Network/expressRouteCrossConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1075},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1079},"Microsoft.Network/ExpressRoutePorts@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1117},"Microsoft.Network/firewallPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1176},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1242},"Microsoft.Network/IpAllocations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1255},"Microsoft.Network/ipGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1269},"Microsoft.Network/loadBalancers@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1344},"Microsoft.Network/loadBalancers/backendAddressPools@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1348},"Microsoft.Network/loadBalancers/inboundNatRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1352},"Microsoft.Network/natGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1358},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1362},"Microsoft.Network/networkProfiles@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1400},"Microsoft.Network/networkSecurityGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1405},"Microsoft.Network/networkSecurityGroups/securityRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1409},"Microsoft.Network/networkVirtualAppliances@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1427},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1439},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1454},"Microsoft.Network/networkWatchers@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1465},"Microsoft.Network/networkWatchers/packetCaptures@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1482},"Microsoft.Network/networkWatchers/connectionMonitors@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1557},"Microsoft.Network/networkWatchers/flowLogs@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1562},"Microsoft.Network/privateEndpoints@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1567},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1588},"Microsoft.Network/privateLinkServices@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1593},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1597},"Microsoft.Network/publicIPPrefixes@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1621},"Microsoft.Network/routeFilters@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1648},"Microsoft.Network/routeFilters/routeFilterRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1652},"Microsoft.Network/routeTables@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1657},"Microsoft.Network/routeTables/routes@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1661},"Microsoft.Network/securityPartnerProviders@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1681},"Microsoft.Network/serviceEndpointPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1686},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1690},"Microsoft.Network/virtualNetworks@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1720},"Microsoft.Network/virtualNetworks/subnets@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1724},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1728},"Microsoft.Network/virtualNetworkGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1886},"Microsoft.Network/connections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1936},"Microsoft.Network/localNetworkGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1941},"Microsoft.Network/virtualNetworkTaps@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1946},"Microsoft.Network/virtualRouters@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1959},"Microsoft.Network/virtualRouters/peerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1969},"Microsoft.Network/virtualWans@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1987},"Microsoft.Network/vpnSites@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2011},"Microsoft.Network/vpnServerConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2065},"Microsoft.Network/virtualHubs@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2101},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2111},"Microsoft.Network/vpnGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2184},"Microsoft.Network/vpnGateways/vpnConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2188},"Microsoft.Network/vpnGateways/natRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2192},"Microsoft.Network/p2svpnGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2197},"Microsoft.Network/virtualHubs/routeTables@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2201},"Microsoft.Network/expressRouteGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2224},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2228},"Microsoft.Network/virtualHubs/bgpConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2243},"Microsoft.Network/virtualHubs/ipConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2256},"Microsoft.Network/virtualHubs/hubRouteTables@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2272},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2367},"Microsoft.Network/networkManagers@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":37},"Microsoft.Network/networkManagers/connectivityConfigurations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":69},"Microsoft.Network/networkManagers/networkGroups@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":81},"Microsoft.Network/networkManagers/securityUserConfigurations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":97},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":109},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":161},"Microsoft.Network/networkManagers/securityAdminConfigurations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":165},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":169},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":225},"Microsoft.Network/networkSecurityPerimeters@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":238},"Microsoft.Network/networkSecurityPerimeters/profiles@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":246},"Microsoft.Network/networkSecurityPerimeters/profiles/accessRules@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":267},"Microsoft.Network/networkSecurityPerimeters/resourceAssociations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":285},"Microsoft.Network/applicationGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":715},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":719},"Microsoft.Network/applicationSecurityGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":724},"Microsoft.Network/azureFirewalls@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":832},"Microsoft.Network/bastionHosts@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":858},"Microsoft.Network/networkInterfaces@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":863},"Microsoft.Network/publicIPAddresses@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":869},"Microsoft.Network/customIpPrefixes@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":893},"Microsoft.Network/ddosCustomPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":916},"Microsoft.Network/ddosProtectionPlans@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":928},"Microsoft.Network/dscpConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":957},"Microsoft.Network/expressRouteCircuits/authorizations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":970},"Microsoft.Network/expressRouteCircuits/peerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1030},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1034},"Microsoft.Network/expressRouteCircuits@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1064},"Microsoft.Network/expressRouteCrossConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1096},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1100},"Microsoft.Network/ExpressRoutePorts@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1138},"Microsoft.Network/firewallPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1197},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1263},"Microsoft.Network/IpAllocations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1276},"Microsoft.Network/ipGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1290},"Microsoft.Network/loadBalancers@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1367},"Microsoft.Network/loadBalancers/backendAddressPools@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1371},"Microsoft.Network/loadBalancers/inboundNatRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1375},"Microsoft.Network/natGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1381},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1385},"Microsoft.Network/networkProfiles@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1423},"Microsoft.Network/networkSecurityGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1428},"Microsoft.Network/networkSecurityGroups/securityRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1432},"Microsoft.Network/networkVirtualAppliances@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1450},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1462},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1477},"Microsoft.Network/networkWatchers@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1488},"Microsoft.Network/networkWatchers/packetCaptures@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1505},"Microsoft.Network/networkWatchers/connectionMonitors@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1580},"Microsoft.Network/networkWatchers/flowLogs@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1585},"Microsoft.Network/privateEndpoints@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1590},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1616},"Microsoft.Network/privateLinkServices@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1621},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1625},"Microsoft.Network/publicIPPrefixes@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1649},"Microsoft.Network/routeFilters@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1676},"Microsoft.Network/routeFilters/routeFilterRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1680},"Microsoft.Network/routeTables@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1685},"Microsoft.Network/routeTables/routes@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1689},"Microsoft.Network/securityPartnerProviders@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1709},"Microsoft.Network/serviceEndpointPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1714},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1718},"Microsoft.Network/virtualNetworks@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1753},"Microsoft.Network/virtualNetworks/subnets@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1757},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1761},"Microsoft.Network/virtualNetworkGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1936},"Microsoft.Network/connections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1988},"Microsoft.Network/localNetworkGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1993},"Microsoft.Network/virtualNetworkGateways/natRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1997},"Microsoft.Network/virtualNetworkTaps@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2002},"Microsoft.Network/virtualRouters@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2015},"Microsoft.Network/virtualRouters/peerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2025},"Microsoft.Network/virtualWans@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2043},"Microsoft.Network/vpnSites@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2067},"Microsoft.Network/vpnServerConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2121},"Microsoft.Network/virtualHubs@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2161},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2171},"Microsoft.Network/vpnGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2243},"Microsoft.Network/vpnGateways/vpnConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2247},"Microsoft.Network/vpnGateways/natRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2251},"Microsoft.Network/p2svpnGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2256},"Microsoft.Network/virtualHubs/routeTables@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2260},"Microsoft.Network/expressRouteGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2283},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2287},"Microsoft.Network/virtualHubs/bgpConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2302},"Microsoft.Network/virtualHubs/ipConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2315},"Microsoft.Network/virtualHubs/hubRouteTables@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2331},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2426},"Microsoft.Network/networkSecurityPerimeters@2021-03-01-preview":{"RelativePath":"network/microsoft.network/2021-03-01-preview/types.json","Index":18},"Microsoft.Network/applicationGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":736},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":740},"Microsoft.Network/applicationSecurityGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":745},"Microsoft.Network/azureFirewalls@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":853},"Microsoft.Network/bastionHosts@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":879},"Microsoft.Network/networkInterfaces@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":884},"Microsoft.Network/publicIPAddresses@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":890},"Microsoft.Network/customIpPrefixes@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":914},"Microsoft.Network/ddosCustomPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":937},"Microsoft.Network/ddosProtectionPlans@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":949},"Microsoft.Network/dscpConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":995},"Microsoft.Network/expressRouteCircuits/authorizations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1008},"Microsoft.Network/expressRouteCircuits/peerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1068},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1072},"Microsoft.Network/expressRouteCircuits@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1102},"Microsoft.Network/expressRouteCrossConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1134},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1138},"Microsoft.Network/ExpressRoutePorts@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1176},"Microsoft.Network/firewallPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1237},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1303},"Microsoft.Network/IpAllocations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1316},"Microsoft.Network/ipGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1330},"Microsoft.Network/loadBalancers@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1407},"Microsoft.Network/loadBalancers/backendAddressPools@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1411},"Microsoft.Network/loadBalancers/inboundNatRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1415},"Microsoft.Network/natGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1421},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1425},"Microsoft.Network/networkProfiles@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1463},"Microsoft.Network/networkSecurityGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1468},"Microsoft.Network/networkSecurityGroups/securityRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1472},"Microsoft.Network/networkVirtualAppliances@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1490},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1502},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1517},"Microsoft.Network/networkWatchers@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1528},"Microsoft.Network/networkWatchers/packetCaptures@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1545},"Microsoft.Network/networkWatchers/connectionMonitors@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1620},"Microsoft.Network/networkWatchers/flowLogs@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1625},"Microsoft.Network/privateEndpoints@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1630},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1651},"Microsoft.Network/privateLinkServices@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1656},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1660},"Microsoft.Network/publicIPPrefixes@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1684},"Microsoft.Network/routeFilters@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1711},"Microsoft.Network/routeFilters/routeFilterRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1715},"Microsoft.Network/routeTables@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1720},"Microsoft.Network/routeTables/routes@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1724},"Microsoft.Network/securityPartnerProviders@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1744},"Microsoft.Network/serviceEndpointPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1749},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1753},"Microsoft.Network/virtualNetworks@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1788},"Microsoft.Network/virtualNetworks/subnets@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1792},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1796},"Microsoft.Network/virtualNetworkGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1971},"Microsoft.Network/connections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2023},"Microsoft.Network/localNetworkGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2028},"Microsoft.Network/virtualNetworkGateways/natRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2032},"Microsoft.Network/virtualNetworkTaps@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2037},"Microsoft.Network/virtualRouters@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2050},"Microsoft.Network/virtualRouters/peerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2060},"Microsoft.Network/virtualWans@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2078},"Microsoft.Network/vpnSites@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2102},"Microsoft.Network/vpnServerConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2157},"Microsoft.Network/virtualHubs@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2197},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2207},"Microsoft.Network/vpnGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2279},"Microsoft.Network/vpnGateways/vpnConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2283},"Microsoft.Network/vpnGateways/natRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2287},"Microsoft.Network/p2svpnGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2292},"Microsoft.Network/virtualHubs/routeTables@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2296},"Microsoft.Network/expressRouteGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2319},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2323},"Microsoft.Network/virtualHubs/bgpConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2338},"Microsoft.Network/virtualHubs/ipConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2351},"Microsoft.Network/virtualHubs/hubRouteTables@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2367},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2462},"Microsoft.Network/networkManagers@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":41},"Microsoft.Network/networkManagers/connectivityConfigurations@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":73},"Microsoft.Network/networkManagers/networkGroups@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":83},"Microsoft.Network/networkManagers/networkGroups/staticMembers@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":88},"Microsoft.Network/networkManagers/securityUserConfigurations@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":108},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":120},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":172},"Microsoft.Network/networkManagers/securityAdminConfigurations@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":176},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":180},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":236},"Microsoft.Network/networkManagerConnections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":247},"Microsoft.Network/managementGroups/networkManagerConnections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":251},"Microsoft.Network/networkManagers/scopeConnections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":262},"Microsoft.Network/applicationGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":739},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":743},"Microsoft.Network/applicationSecurityGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":748},"Microsoft.Network/azureFirewalls@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":857},"Microsoft.Network/bastionHosts@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":883},"Microsoft.Network/networkInterfaces@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":888},"Microsoft.Network/publicIPAddresses@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":894},"Microsoft.Network/customIpPrefixes@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":915},"Microsoft.Network/ddosCustomPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":938},"Microsoft.Network/ddosProtectionPlans@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":950},"Microsoft.Network/dscpConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":996},"Microsoft.Network/expressRouteCircuits/authorizations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1009},"Microsoft.Network/expressRouteCircuits/peerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1069},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1073},"Microsoft.Network/expressRouteCircuits@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1103},"Microsoft.Network/expressRouteCrossConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1135},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1139},"Microsoft.Network/ExpressRoutePorts@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1177},"Microsoft.Network/firewallPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1239},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1305},"Microsoft.Network/firewallPolicies/signatureOverrides@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1312},"Microsoft.Network/IpAllocations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1325},"Microsoft.Network/ipGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1339},"Microsoft.Network/loadBalancers@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1416},"Microsoft.Network/loadBalancers/backendAddressPools@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1420},"Microsoft.Network/loadBalancers/inboundNatRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1424},"Microsoft.Network/natGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1430},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1434},"Microsoft.Network/networkProfiles@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1472},"Microsoft.Network/networkSecurityGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1477},"Microsoft.Network/networkSecurityGroups/securityRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1481},"Microsoft.Network/networkVirtualAppliances@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1499},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1511},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1526},"Microsoft.Network/networkWatchers@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1537},"Microsoft.Network/networkWatchers/packetCaptures@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1554},"Microsoft.Network/networkWatchers/connectionMonitors@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1629},"Microsoft.Network/networkWatchers/flowLogs@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1634},"Microsoft.Network/privateEndpoints@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1639},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1660},"Microsoft.Network/privateLinkServices@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1665},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1669},"Microsoft.Network/publicIPPrefixes@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1693},"Microsoft.Network/routeFilters@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1720},"Microsoft.Network/routeFilters/routeFilterRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1724},"Microsoft.Network/routeTables@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1729},"Microsoft.Network/routeTables/routes@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1733},"Microsoft.Network/securityPartnerProviders@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1753},"Microsoft.Network/serviceEndpointPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1758},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1762},"Microsoft.Network/virtualNetworks@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1801},"Microsoft.Network/virtualNetworks/subnets@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1805},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1809},"Microsoft.Network/virtualNetworkGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1984},"Microsoft.Network/connections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2036},"Microsoft.Network/localNetworkGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2041},"Microsoft.Network/virtualNetworkGateways/natRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2045},"Microsoft.Network/virtualNetworkTaps@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2050},"Microsoft.Network/virtualRouters@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2063},"Microsoft.Network/virtualRouters/peerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2073},"Microsoft.Network/virtualWans@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2091},"Microsoft.Network/vpnSites@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2115},"Microsoft.Network/vpnServerConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2170},"Microsoft.Network/virtualHubs@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2210},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2220},"Microsoft.Network/vpnGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2292},"Microsoft.Network/vpnGateways/vpnConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2296},"Microsoft.Network/vpnGateways/natRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2300},"Microsoft.Network/p2svpnGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2305},"Microsoft.Network/virtualHubs/routeTables@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2309},"Microsoft.Network/expressRouteGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2332},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2336},"Microsoft.Network/virtualHubs/bgpConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2351},"Microsoft.Network/virtualHubs/ipConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2364},"Microsoft.Network/virtualHubs/hubRouteTables@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2380},"Microsoft.Network/virtualHubs/routingIntent@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2393},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2500},"Microsoft.Network/applicationGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":792},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":796},"Microsoft.Network/applicationSecurityGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":801},"Microsoft.Network/azureFirewalls@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":910},"Microsoft.Network/bastionHosts@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":936},"Microsoft.Network/networkInterfaces@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":941},"Microsoft.Network/publicIPAddresses@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":947},"Microsoft.Network/customIpPrefixes@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":968},"Microsoft.Network/ddosCustomPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":991},"Microsoft.Network/ddosProtectionPlans@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1003},"Microsoft.Network/dscpConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1049},"Microsoft.Network/expressRouteCircuits/authorizations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1062},"Microsoft.Network/expressRouteCircuits/peerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1122},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1126},"Microsoft.Network/expressRouteCircuits@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1156},"Microsoft.Network/expressRouteCrossConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1188},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1192},"Microsoft.Network/ExpressRoutePorts@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1230},"Microsoft.Network/expressRoutePorts/authorizations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1243},"Microsoft.Network/firewallPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1306},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1372},"Microsoft.Network/firewallPolicies/signatureOverrides@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1379},"Microsoft.Network/IpAllocations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1392},"Microsoft.Network/ipGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1406},"Microsoft.Network/loadBalancers@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1483},"Microsoft.Network/loadBalancers/backendAddressPools@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1487},"Microsoft.Network/loadBalancers/inboundNatRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1491},"Microsoft.Network/natGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1497},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1501},"Microsoft.Network/networkProfiles@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1539},"Microsoft.Network/networkSecurityGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1544},"Microsoft.Network/networkSecurityGroups/securityRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1548},"Microsoft.Network/networkVirtualAppliances@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1566},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1578},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1593},"Microsoft.Network/networkWatchers@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1604},"Microsoft.Network/networkWatchers/packetCaptures@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1621},"Microsoft.Network/networkWatchers/connectionMonitors@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1696},"Microsoft.Network/networkWatchers/flowLogs@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1701},"Microsoft.Network/privateEndpoints@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1706},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1727},"Microsoft.Network/privateLinkServices@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1732},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1736},"Microsoft.Network/publicIPPrefixes@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1760},"Microsoft.Network/routeFilters@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1787},"Microsoft.Network/routeFilters/routeFilterRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1791},"Microsoft.Network/routeTables@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1796},"Microsoft.Network/routeTables/routes@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1800},"Microsoft.Network/securityPartnerProviders@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1820},"Microsoft.Network/serviceEndpointPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1825},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1829},"Microsoft.Network/virtualNetworks@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1868},"Microsoft.Network/virtualNetworks/subnets@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1872},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1876},"Microsoft.Network/virtualNetworkGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2051},"Microsoft.Network/connections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2105},"Microsoft.Network/localNetworkGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2110},"Microsoft.Network/virtualNetworkGateways/natRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2114},"Microsoft.Network/virtualNetworkTaps@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2119},"Microsoft.Network/virtualRouters@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2132},"Microsoft.Network/virtualRouters/peerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2142},"Microsoft.Network/virtualWans@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2160},"Microsoft.Network/vpnSites@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2184},"Microsoft.Network/vpnServerConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2256},"Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2260},"Microsoft.Network/virtualHubs@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2304},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2314},"Microsoft.Network/vpnGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2387},"Microsoft.Network/vpnGateways/vpnConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2391},"Microsoft.Network/vpnGateways/natRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2395},"Microsoft.Network/p2svpnGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2400},"Microsoft.Network/virtualHubs/routeTables@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2404},"Microsoft.Network/expressRouteGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2427},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2431},"Microsoft.Network/virtualHubs/bgpConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2446},"Microsoft.Network/virtualHubs/ipConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2459},"Microsoft.Network/virtualHubs/hubRouteTables@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2475},"Microsoft.Network/virtualHubs/routingIntent@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2488},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2595},"Microsoft.Network/networkManagers@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":41},"Microsoft.Network/networkManagers/connectivityConfigurations@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":73},"Microsoft.Network/networkManagers/networkGroups@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":83},"Microsoft.Network/networkManagers/networkGroups/staticMembers@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":88},"Microsoft.Network/networkManagers/securityUserConfigurations@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":101},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":113},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":165},"Microsoft.Network/networkManagers/securityAdminConfigurations@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":179},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":190},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":246},"Microsoft.Network/networkManagerConnections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":257},"Microsoft.Network/networkManagers/scopeConnections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":268},"Microsoft.NotificationHubs/namespaces@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":16},"Microsoft.NotificationHubs/namespaces/AuthorizationRules@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":26},"Microsoft.NotificationHubs/namespaces/notificationHubs@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":45},"Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":49},"Microsoft.NotificationHubs/namespaces@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":21},"Microsoft.NotificationHubs/namespaces/AuthorizationRules@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":32},"Microsoft.NotificationHubs/namespaces/notificationHubs@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":51},"Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":56},"Microsoft.NotificationHubs/namespaces@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":21},"Microsoft.NotificationHubs/namespaces/AuthorizationRules@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":32},"Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":51},"Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":56},"Microsoft.OpenEnergyPlatform/energyServices@2021-06-01-preview":{"RelativePath":"oep/microsoft.openenergyplatform/2021-06-01-preview/types.json","Index":34},"Microsoft.OperationalInsights/workspaces/storageInsightConfigs@2015-03-20":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-03-20/types.json","Index":20},"Microsoft.OperationalInsights/workspaces/savedSearches@2015-03-20":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-03-20/types.json","Index":27},"Microsoft.OperationalInsights/workspaces/linkedServices@2015-11-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.json","Index":12},"Microsoft.OperationalInsights/workspaces/dataSources@2015-11-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.json","Index":33},"Microsoft.OperationalInsights/workspaces@2015-11-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.json","Index":55},"Microsoft.OperationalInsights/clusters@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":28},"Microsoft.OperationalInsights/workspaces/linkedServices@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":33},"Microsoft.OperationalInsights/workspaces/dataExports@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":44},"Microsoft.OperationalInsights/workspaces/linkedStorageAccounts@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":56},"Microsoft.OperationalInsights/queryPacks@2019-09-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.json","Index":13},"Microsoft.OperationalInsights/queryPacks/queries@2019-09-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.json","Index":35},"Microsoft.OperationalInsights/queryPacks@2019-09-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01/types.json","Index":13},"Microsoft.OperationalInsights/queryPacks/queries@2019-09-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01/types.json","Index":35},"Microsoft.OperationalInsights/workspaces/dataExports@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":18},"Microsoft.OperationalInsights/workspaces/dataSources@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":57},"Microsoft.OperationalInsights/workspaces/linkedServices@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":68},"Microsoft.OperationalInsights/workspaces/linkedStorageAccounts@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":86},"Microsoft.OperationalInsights/workspaces@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":125},"Microsoft.OperationalInsights/clusters@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":147},"Microsoft.OperationalInsights/workspaces/storageInsightConfigs@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":160},"Microsoft.OperationalInsights/workspaces/savedSearches@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":167},"Microsoft.OperationalInsights/workspaces/dataExports@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":18},"Microsoft.OperationalInsights/workspaces/dataSources@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":57},"Microsoft.OperationalInsights/workspaces/linkedServices@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":68},"Microsoft.OperationalInsights/workspaces/linkedStorageAccounts@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":84},"Microsoft.OperationalInsights/workspaces/storageInsightConfigs@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":97},"Microsoft.OperationalInsights/workspaces/savedSearches@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":104},"Microsoft.OperationalInsights/workspaces@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":145},"Microsoft.OperationalInsights/clusters@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":167},"Microsoft.OperationalInsights/clusters@2020-10-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-10-01/types.json","Index":38},"Microsoft.OperationalInsights/workspaces@2020-10-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-10-01/types.json","Index":79},"Microsoft.OperationalInsights/clusters@2021-06-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-06-01/types.json","Index":38},"Microsoft.OperationalInsights/workspaces@2021-06-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-06-01/types.json","Index":79},"Microsoft.OperationalInsights/workspaces@2021-12-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.json","Index":59},"Microsoft.OperationalInsights/workspaces/tables@2021-12-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.json","Index":107},"Microsoft.OperationsManagement/solutions@2015-11-01-preview":{"RelativePath":"operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.json","Index":16},"Microsoft.OperationsManagement/ManagementAssociations@2015-11-01-preview":{"RelativePath":"operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.json","Index":21},"Microsoft.OperationsManagement/ManagementConfigurations@2015-11-01-preview":{"RelativePath":"operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.json","Index":28},"Microsoft.Orbital/spacecrafts@2021-04-04-preview":{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":39},"Microsoft.Orbital/spacecrafts/contacts@2021-04-04-preview":{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":51},"Microsoft.Orbital/contactProfiles@2021-04-04-preview":{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":78},"Microsoft.Orbital/spacecrafts@2022-03-01":{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":43},"Microsoft.Orbital/spacecrafts/contacts@2022-03-01":{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":68},"Microsoft.Orbital/contactProfiles@2022-03-01":{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":102},"Microsoft.Peering/peerAsns@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":20},"Microsoft.Peering/peerings@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":110},"Microsoft.Peering/peeringServices/prefixes@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":131},"Microsoft.Peering/peeringServices@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":142},"Microsoft.Peering/peerAsns@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":20},"Microsoft.Peering/peerings@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":110},"Microsoft.Peering/peeringServices/prefixes@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":134},"Microsoft.Peering/peeringServices@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":145},"Microsoft.Peering/peerAsns@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":25},"Microsoft.Peering/peerings/registeredAsns@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":35},"Microsoft.Peering/peerings/registeredPrefixes@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":53},"Microsoft.Peering/peerings@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":138},"Microsoft.Peering/peeringServices/prefixes@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":162},"Microsoft.Peering/peeringServices@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":174},"Microsoft.Peering/peerAsns@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":54},"Microsoft.Peering/peerings@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":139},"Microsoft.Peering/peeringServices/prefixes@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":163},"Microsoft.Peering/peeringServices@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":175},"Microsoft.Peering/peerAsns@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":54},"Microsoft.Peering/peerings@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":139},"Microsoft.Peering/peeringServices/prefixes@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":163},"Microsoft.Peering/peeringServices@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":175},"Microsoft.Peering/peerAsns@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":54},"Microsoft.Peering/peerings@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":140},"Microsoft.Peering/peeringServices/prefixes@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":164},"Microsoft.Peering/peeringServices@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":176},"Microsoft.Peering/peerAsns@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":54},"Microsoft.Peering/peerings@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":140},"Microsoft.Peering/peeringServices/connectionMonitorTests@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":151},"Microsoft.Peering/peeringServices/prefixes@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":175},"Microsoft.Peering/peeringServices@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":189},"Microsoft.Peering/peerAsns@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":54},"Microsoft.Peering/peerings@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":141},"Microsoft.Peering/peeringServices/connectionMonitorTests@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":152},"Microsoft.Peering/peeringServices/prefixes@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":176},"Microsoft.Peering/peeringServices@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":190},"Microsoft.PolicyInsights/remediations@2018-07-01-preview":{"RelativePath":"policyinsights/microsoft.policyinsights/2018-07-01-preview/types.json","Index":15},"Microsoft.PolicyInsights/remediations@2019-07-01":{"RelativePath":"policyinsights/microsoft.policyinsights/2019-07-01/types.json","Index":18},"Microsoft.PolicyInsights/attestations@2021-01-01":{"RelativePath":"policyinsights/microsoft.policyinsights/2021-01-01/types.json","Index":29},"Microsoft.PolicyInsights/remediations@2021-10-01":{"RelativePath":"policyinsights/microsoft.policyinsights/2021-10-01/types.json","Index":30},"Microsoft.Portal/dashboards@2015-08-01-preview":{"RelativePath":"portal/microsoft.portal/2015-08-01-preview/types.json","Index":22},"Microsoft.Portal/dashboards@2018-10-01-preview":{"RelativePath":"portal/microsoft.portal/2018-10-01-preview/types.json","Index":22},"Microsoft.Portal/dashboards@2019-01-01-preview":{"RelativePath":"portal/microsoft.portal/2019-01-01-preview/types.json","Index":22},"Microsoft.Portal/tenantConfigurations@2019-01-01-preview":{"RelativePath":"portal/microsoft.portal/2019-01-01-preview/types.json","Index":29},"Microsoft.Portal/dashboards@2020-09-01-preview":{"RelativePath":"portal/microsoft.portal/2020-09-01-preview/types.json","Index":28},"Microsoft.Portal/tenantConfigurations@2020-09-01-preview":{"RelativePath":"portal/microsoft.portal/2020-09-01-preview/types.json","Index":35},"Microsoft.DBforPostgreSQL/servers@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":80},"Microsoft.DBforPostgreSQL/servers/firewallRules@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":85},"Microsoft.DBforPostgreSQL/servers/virtualNetworkRules@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":96},"Microsoft.DBforPostgreSQL/servers/databases@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":101},"Microsoft.DBforPostgreSQL/servers/configurations@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":106},"Microsoft.DBforPostgreSQL/servers/administrators@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":113},"Microsoft.DBforPostgreSQL/servers/securityAlertPolicies@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":125},"Microsoft.DBforPostgreSQL/servers@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":80},"Microsoft.DBforPostgreSQL/servers/firewallRules@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":85},"Microsoft.DBforPostgreSQL/servers/virtualNetworkRules@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":96},"Microsoft.DBforPostgreSQL/servers/databases@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":101},"Microsoft.DBforPostgreSQL/servers/configurations@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":106},"Microsoft.DBforPostgreSQL/servers/administrators@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":113},"Microsoft.DBforPostgreSQL/servers/securityAlertPolicies@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":125},"Microsoft.DBforPostgreSQL/servers/privateEndpointConnections@2018-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2018-06-01/types.json","Index":14},"Microsoft.DBforPostgreSQL/servers/keys@2020-01-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-01-01/types.json","Index":14},"Microsoft.DBForPostgreSql/flexibleServers@2020-02-14-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.json","Index":55},"Microsoft.DBForPostgreSql/flexibleServers/firewallRules@2020-02-14-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.json","Index":60},"Microsoft.DBForPostgreSql/flexibleServers/databases@2020-11-05-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-11-05-preview/types.json","Index":12},"Microsoft.DBforPostgreSQL/flexibleServers@2021-06-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.json","Index":67},"Microsoft.DBforPostgreSQL/flexibleServers/firewallRules@2021-06-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.json","Index":72},"Microsoft.DBforPostgreSQL/flexibleServers/configurations@2021-06-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.json","Index":82},"Microsoft.DBforPostgreSQL/flexibleServers@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":67},"Microsoft.DBforPostgreSQL/flexibleServers/firewallRules@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":72},"Microsoft.DBforPostgreSQL/flexibleServers/configurations@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":82},"Microsoft.DBforPostgreSQL/flexibleServers/databases@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":87},"Microsoft.PowerBIDedicated/capacities@2017-10-01":{"RelativePath":"powerbidedicated/microsoft.powerbidedicated/2017-10-01/types.json","Index":44},"Microsoft.PowerBIDedicated/capacities@2021-01-01":{"RelativePath":"powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.json","Index":60},"Microsoft.PowerBIDedicated/autoScaleVCores@2021-01-01":{"RelativePath":"powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.json","Index":71},"Microsoft.PowerBI/workspaceCollections@2016-01-29":{"RelativePath":"powerbiembedded/microsoft.powerbi/2016-01-29/types.json","Index":17},"Microsoft.PowerBI/privateLinkServicesForPowerBI@2020-06-01":{"RelativePath":"powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.json","Index":41},"Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections@2020-06-01":{"RelativePath":"powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.json","Index":45},"Microsoft.PowerPlatform/accounts@2020-10-30-preview":{"RelativePath":"powerplatform/microsoft.powerplatform/2020-10-30-preview/types.json","Index":24},"Microsoft.PowerPlatform/enterprisePolicies@2020-10-30-preview":{"RelativePath":"powerplatform/microsoft.powerplatform/2020-10-30-preview/types.json","Index":56},"Microsoft.PowerPlatform/enterprisePolicies/privateEndpointConnections@2020-10-30-preview":{"RelativePath":"powerplatform/microsoft.powerplatform/2020-10-30-preview/types.json","Index":72},"Microsoft.Network/privateDnsZones@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":20},"Microsoft.Network/privateDnsZones/virtualNetworkLinks@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":37},"Microsoft.Network/privateDnsZones/A@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":58},"Microsoft.Network/privateDnsZones/AAAA@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":62},"Microsoft.Network/privateDnsZones/CNAME@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":66},"Microsoft.Network/privateDnsZones/MX@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":70},"Microsoft.Network/privateDnsZones/PTR@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":74},"Microsoft.Network/privateDnsZones/SOA@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":78},"Microsoft.Network/privateDnsZones/SRV@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":82},"Microsoft.Network/privateDnsZones/TXT@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":86},"Microsoft.Network/privateDnsZones@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":20},"Microsoft.Network/privateDnsZones/virtualNetworkLinks@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":37},"Microsoft.Network/privateDnsZones/A@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":58},"Microsoft.Network/privateDnsZones/AAAA@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":62},"Microsoft.Network/privateDnsZones/CNAME@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":66},"Microsoft.Network/privateDnsZones/MX@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":70},"Microsoft.Network/privateDnsZones/PTR@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":74},"Microsoft.Network/privateDnsZones/SOA@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":78},"Microsoft.Network/privateDnsZones/SRV@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":82},"Microsoft.Network/privateDnsZones/TXT@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":86},"Microsoft.Network/privateDnsZones@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":20},"Microsoft.Network/privateDnsZones/virtualNetworkLinks@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":37},"Microsoft.Network/privateDnsZones/A@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":58},"Microsoft.Network/privateDnsZones/AAAA@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":62},"Microsoft.Network/privateDnsZones/CNAME@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":66},"Microsoft.Network/privateDnsZones/MX@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":70},"Microsoft.Network/privateDnsZones/PTR@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":74},"Microsoft.Network/privateDnsZones/SOA@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":78},"Microsoft.Network/privateDnsZones/SRV@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":82},"Microsoft.Network/privateDnsZones/TXT@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":86},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":285},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":337},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":367},"Microsoft.ProviderHub/providerRegistrations/operations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":382},"Microsoft.ProviderHub/providerRegistrations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":386},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":390},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":435},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":439},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":443},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":447},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":292},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":345},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":375},"Microsoft.ProviderHub/providerRegistrations/operations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":390},"Microsoft.ProviderHub/providerRegistrations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":394},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":398},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":443},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":447},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":451},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":455},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":318},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":371},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":401},"Microsoft.ProviderHub/providerRegistrations/operations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":435},"Microsoft.ProviderHub/providerRegistrations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":439},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":443},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":488},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":492},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":496},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":500},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":328},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":381},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":411},"Microsoft.ProviderHub/providerRegistrations/operations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":445},"Microsoft.ProviderHub/providerRegistrations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":449},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":453},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":498},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":502},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":506},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":510},"Microsoft.Purview/accounts@2020-12-01-preview":{"RelativePath":"purview/microsoft.purview/2020-12-01-preview/types.json","Index":58},"Microsoft.Purview/accounts/privateEndpointConnections@2020-12-01-preview":{"RelativePath":"purview/microsoft.purview/2020-12-01-preview/types.json","Index":62},"Microsoft.Purview/accounts@2021-07-01":{"RelativePath":"purview/microsoft.purview/2021-07-01/types.json","Index":62},"Microsoft.Purview/accounts/privateEndpointConnections@2021-07-01":{"RelativePath":"purview/microsoft.purview/2021-07-01/types.json","Index":66},"Microsoft.Quantum/workspaces@2019-11-04-preview":{"RelativePath":"quantum/microsoft.quantum/2019-11-04-preview/types.json","Index":48},"Microsoft.Quantum/workspaces@2022-01-10-preview":{"RelativePath":"quantum/microsoft.quantum/2022-01-10-preview/types.json","Index":48},"Microsoft.Quota/quotas@2021-03-15-preview":{"RelativePath":"quota/microsoft.quota/2021-03-15-preview/types.json","Index":19},"Microsoft.Quota/quotaLimits@2021-03-15":{"RelativePath":"quota/microsoft.quota/2021-03-15/types.json","Index":19},"Microsoft.RecommendationsService/accounts@2022-02-01":{"RelativePath":"recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.json","Index":38},"Microsoft.RecommendationsService/accounts/modeling@2022-02-01":{"RelativePath":"recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.json","Index":57},"Microsoft.RecommendationsService/accounts/serviceEndpoints@2022-02-01":{"RelativePath":"recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.json","Index":63},"Microsoft.RecoveryServices/vaults/certificates@2016-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2016-06-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2016-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2016-06-01/types.json","Index":62},"Microsoft.RecoveryServices/vaults/extendedInformation@2016-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2016-06-01/types.json","Index":68},"Microsoft.RecoveryServices/vaults/certificates@2020-02-02":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-02-02/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2020-02-02":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-02-02/types.json","Index":72},"Microsoft.RecoveryServices/vaults/extendedInformation@2020-02-02":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-02-02/types.json","Index":78},"Microsoft.RecoveryServices/vaults/certificates@2020-10-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-10-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2020-10-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-10-01/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2020-10-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-10-01/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-01-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-01-01/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-01-01/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-02-10":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-02-10/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-02-10":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-02-10/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-02-10":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-02-10/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-03-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-03-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-03-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-03-01/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-03-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-03-01/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-04-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-04-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-04-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-04-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-04-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-04-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-06-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-06-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-06-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-07-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-07-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-07-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-07-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-07-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-07-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-08-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-08-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-08-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-08-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-08-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-08-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-11-01-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-11-01-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-11-01-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.json","Index":105},"Microsoft.RecoveryServices/vaults/certificates@2021-12-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-12-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-12-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-12-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-12-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-12-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2022-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2022-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-01/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2022-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-01/types.json","Index":105},"Microsoft.RecoveryServices/vaults/certificates@2022-01-31-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2022-01-31-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2022-01-31-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.json","Index":105},"Microsoft.RecoveryServices/vaults/certificates@2022-02-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-02-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2022-02-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-02-01/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2022-02-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-02-01/types.json","Index":105},"Microsoft.RecoveryServices/vaults/backupPolicies@2016-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.json","Index":110},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2016-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.json","Index":149},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2016-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.json","Index":65},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2016-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.json","Index":84},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2017-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2017-07-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2018-12-20":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2018-12-20/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2019-05-13":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.json","Index":102},"Microsoft.RecoveryServices/vaults/backupPolicies@2019-05-13":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.json","Index":256},"Microsoft.RecoveryServices/vaults/backupconfig@2019-06-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.json","Index":34},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2019-06-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.json","Index":136},"Microsoft.RecoveryServices/vaults/backupPolicies@2019-06-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.json","Index":291},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2020-02-02":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-02-02/types.json","Index":25},"Microsoft.RecoveryServices/vaults/backupconfig@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":60},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":78},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":180},"Microsoft.RecoveryServices/vaults/backupPolicies@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":336},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":394},"Microsoft.RecoveryServices/vaults/backupconfig@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":60},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":78},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":180},"Microsoft.RecoveryServices/vaults/backupPolicies@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":336},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":394},"Microsoft.RecoveryServices/vaults/backupconfig@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":60},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":78},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":180},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":336},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":394},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":73},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":95},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":113},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":215},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":371},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":429},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":437},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":94},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":112},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":214},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":370},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":428},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":94},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":112},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":214},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":370},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":428},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":94},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":112},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":214},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":370},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":428},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":64},"Microsoft.RecoveryServices/vaults/backupconfig@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":119},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":137},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":239},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":395},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":453},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":96},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":114},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":216},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":372},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":430},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":64},"Microsoft.RecoveryServices/vaults/backupconfig@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":96},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":120},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":138},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":241},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":398},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":456},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":464},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":64},"Microsoft.RecoveryServices/vaults/backupconfig@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":96},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":120},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":138},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":241},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":398},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":456},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":464},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":410},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":471},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":479},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-11-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-11-15/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":448},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":509},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":517},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":434},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":495},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":503},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":434},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":495},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":503},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":85},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":104},"Microsoft.RecoveryServices/vaults/replicationFabrics@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":136},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":141},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":146},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":200},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":210},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":218},"Microsoft.RecoveryServices/vaults/replicationPolicies@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":272},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":278},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":57},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":76},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":88},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":156},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":237},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":259},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":268},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":273},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationPolicies@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":333},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":387},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":125},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":144},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":156},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":214},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":384},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":406},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":453},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":461},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":466},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":472},"Microsoft.RecoveryServices/vaults/replicationPolicies@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":530},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":592},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":597},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":166},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":185},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":199},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":276},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":551},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":575},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":583},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":588},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":594},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":651},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":695},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":758},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":763},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":125},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":144},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":156},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":214},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":384},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":406},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":453},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":461},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":466},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":472},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":530},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":592},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":597},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":166},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":185},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":199},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":276},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":551},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":575},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":583},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":588},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":594},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":651},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":695},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":758},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":763},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":589},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":596},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":601},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":664},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":708},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":771},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":776},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":589},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":596},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":601},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":664},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":708},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":771},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":776},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":595},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":602},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":613},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":670},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":720},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":783},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":788},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":595},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":602},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":613},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":670},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":720},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":783},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":788},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":283},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":577},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":614},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":619},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":625},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":682},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":732},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":795},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":800},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":283},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":577},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":614},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":619},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":625},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":682},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":732},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":795},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":800},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":286},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":580},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":610},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":617},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":622},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":628},"Microsoft.RecoveryServices/vaults/replicationPolicies@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":685},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":735},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":798},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":803},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":286},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":580},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":610},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":617},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":622},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":628},"Microsoft.RecoveryServices/vaults/replicationPolicies@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":685},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":735},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":798},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":803},"Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30":{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.json","Index":44},"Microsoft.RedHatOpenShift/openShiftClusters@2021-09-01-preview":{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.json","Index":104},"Microsoft.RedHatOpenShift/openShiftClusters@2022-04-01":{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.json","Index":56},"Microsoft.Cache/Redis@2015-08-01":{"RelativePath":"redis/microsoft.cache/2015-08-01/types.json","Index":23},"Microsoft.Cache/Redis@2016-04-01":{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":24},"Microsoft.Cache/Redis/firewallRules@2016-04-01":{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":29},"Microsoft.Cache/Redis/patchSchedules@2016-04-01":{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":47},"Microsoft.Cache/Redis@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":27},"Microsoft.Cache/Redis/firewallRules@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":32},"Microsoft.Cache/Redis/patchSchedules@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":50},"Microsoft.Cache/Redis/linkedServers@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":58},"Microsoft.Cache/Redis@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":27},"Microsoft.Cache/Redis/firewallRules@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":32},"Microsoft.Cache/Redis/patchSchedules@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":51},"Microsoft.Cache/Redis/linkedServers@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":59},"Microsoft.Cache/Redis@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":44},"Microsoft.Cache/Redis/firewallRules@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":49},"Microsoft.Cache/Redis/patchSchedules@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":68},"Microsoft.Cache/Redis/linkedServers@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":76},"Microsoft.Cache/Redis@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":46},"Microsoft.Cache/Redis/firewallRules@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":51},"Microsoft.Cache/Redis/patchSchedules@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":70},"Microsoft.Cache/Redis/linkedServers@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":78},"Microsoft.Cache/redis@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":63},"Microsoft.Cache/redis/firewallRules@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":68},"Microsoft.Cache/redis/patchSchedules@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":87},"Microsoft.Cache/redis/linkedServers@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":95},"Microsoft.Cache/redis/privateEndpointConnections@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":99},"Microsoft.Cache/redis@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":63},"Microsoft.Cache/redis/firewallRules@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":68},"Microsoft.Cache/redis/patchSchedules@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":87},"Microsoft.Cache/redis/linkedServers@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":95},"Microsoft.Cache/redis/privateEndpointConnections@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":99},"Microsoft.Cache/redis@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":71},"Microsoft.Cache/redis/firewallRules@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":76},"Microsoft.Cache/redis/patchSchedules@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":95},"Microsoft.Cache/redis/linkedServers@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":103},"Microsoft.Cache/redis/privateEndpointConnections@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":107},"Microsoft.Cache/redisEnterprise@2020-10-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":57},"Microsoft.Cache/redisEnterprise/databases@2020-10-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":99},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2020-10-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":103},"Microsoft.Cache/redisEnterprise@2021-02-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2021-02-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":120},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":124},"Microsoft.Cache/redisEnterprise@2021-03-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2021-03-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":111},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2021-03-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":115},"Microsoft.Cache/redisEnterprise@2021-08-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2021-08-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":111},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2021-08-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":115},"Microsoft.Cache/redisEnterprise@2022-01-01":{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2022-01-01":{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":120},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2022-01-01":{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":124},"Microsoft.Relay/namespaces@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":18},"Microsoft.Relay/namespaces/AuthorizationRules@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":28},"Microsoft.Relay/namespaces/HybridConnections@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":33},"Microsoft.Relay/namespaces/HybridConnections/authorizationRules@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":37},"Microsoft.Relay/namespaces/WcfRelays@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":45},"Microsoft.Relay/namespaces/WcfRelays/authorizationRules@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":49},"Microsoft.Relay/namespaces@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":23},"Microsoft.Relay/namespaces/authorizationRules@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":33},"Microsoft.Relay/namespaces/hybridConnections@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":38},"Microsoft.Relay/namespaces/hybridConnections/authorizationRules@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":42},"Microsoft.Relay/namespaces/wcfRelays@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":50},"Microsoft.Relay/namespaces/wcfRelays/authorizationRules@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":54},"Microsoft.Relay/namespaces@2018-01-01-preview":{"RelativePath":"relay/microsoft.relay/2018-01-01-preview/types.json","Index":25},"Microsoft.Relay/namespaces/networkRuleSets@2018-01-01-preview":{"RelativePath":"relay/microsoft.relay/2018-01-01-preview/types.json","Index":38},"Microsoft.Relay/namespaces/privateEndpointConnections@2018-01-01-preview":{"RelativePath":"relay/microsoft.relay/2018-01-01-preview/types.json","Index":59},"Microsoft.Relay/namespaces/authorizationRules@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":28},"Microsoft.Relay/namespaces@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":60},"Microsoft.Relay/namespaces/networkRuleSets@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":73},"Microsoft.Relay/namespaces/hybridConnections/authorizationRules@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":77},"Microsoft.Relay/namespaces/hybridConnections@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":82},"Microsoft.Relay/namespaces/wcfRelays/authorizationRules@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":86},"Microsoft.Relay/namespaces/wcfRelays@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":94},"Microsoft.Relay/namespaces/privateEndpointConnections@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":98},"Microsoft.Capacity/reservationOrders@2019-04-01":{"RelativePath":"reservations/microsoft.capacity/2019-04-01/types.json","Index":118},"Microsoft.Capacity/resourceProviders/locations/serviceLimits@2019-07-19-preview":{"RelativePath":"reservations/microsoft.capacity/2019-07-19-preview/types.json","Index":19},"Microsoft.Capacity/reservationOrders@2020-10-01-preview":{"RelativePath":"reservations/microsoft.capacity/2020-10-01-preview/types.json","Index":113},"Microsoft.Capacity/resourceProviders/locations/serviceLimits@2020-10-25":{"RelativePath":"reservations/microsoft.capacity/2020-10-25/types.json","Index":19},"Microsoft.Capacity/reservationOrders@2021-07-01":{"RelativePath":"reservations/microsoft.capacity/2021-07-01/types.json","Index":169},"Microsoft.Capacity/reservationOrders@2022-03-01":{"RelativePath":"reservations/microsoft.capacity/2022-03-01/types.json","Index":171},"Microsoft.ResourceConnector/appliances@2021-10-31-preview":{"RelativePath":"resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.json","Index":40},"Microsoft.ResourceGraph/queries@2018-09-01-preview":{"RelativePath":"resourcegraph/microsoft.resourcegraph/2018-09-01-preview/types.json","Index":15},"Microsoft.Migrate/moveCollections@2019-10-01-preview":{"RelativePath":"resourcemover/microsoft.migrate/2019-10-01-preview/types.json","Index":26},"Microsoft.Migrate/moveCollections/moveResources@2019-10-01-preview":{"RelativePath":"resourcemover/microsoft.migrate/2019-10-01-preview/types.json","Index":127},"Microsoft.Migrate/moveCollections@2021-01-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-01-01/types.json","Index":26},"Microsoft.Migrate/moveCollections/moveResources@2021-01-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-01-01/types.json","Index":127},"Microsoft.Migrate/moveCollections@2021-08-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-08-01/types.json","Index":37},"Microsoft.Migrate/moveCollections/moveResources@2021-08-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-08-01/types.json","Index":148},"Microsoft.Authorization/locks@2015-01-01":{"RelativePath":"resources/microsoft.authorization/2015-01-01/types.json","Index":16},"Microsoft.Authorization/policyassignments@2015-10-01-preview":{"RelativePath":"resources/microsoft.authorization/2015-10-01-preview/types.json","Index":12},"Microsoft.Authorization/policydefinitions@2015-10-01-preview":{"RelativePath":"resources/microsoft.authorization/2015-10-01-preview/types.json","Index":21},"Microsoft.Authorization/policydefinitions@2015-11-01":{"RelativePath":"resources/microsoft.authorization/2015-11-01/types.json","Index":12},"Microsoft.Authorization/policyAssignments@2015-11-01":{"RelativePath":"resources/microsoft.authorization/2015-11-01/types.json","Index":17},"Microsoft.Authorization/policyassignments@2016-04-01":{"RelativePath":"resources/microsoft.authorization/2016-04-01/types.json","Index":12},"Microsoft.Authorization/policydefinitions@2016-04-01":{"RelativePath":"resources/microsoft.authorization/2016-04-01/types.json","Index":21},"Microsoft.Authorization/locks@2016-09-01":{"RelativePath":"resources/microsoft.authorization/2016-09-01/types.json","Index":18},"Microsoft.Authorization/policyDefinitions@2016-12-01":{"RelativePath":"resources/microsoft.authorization/2016-12-01/types.json","Index":20},"Microsoft.Authorization/policyAssignments@2016-12-01":{"RelativePath":"resources/microsoft.authorization/2016-12-01/types.json","Index":25},"Microsoft.Authorization/locks@2017-04-01":{"RelativePath":"resources/microsoft.authorization/2017-04-01/types.json","Index":18},"Microsoft.Authorization/policyAssignments@2017-06-01-preview":{"RelativePath":"resources/microsoft.authorization/2017-06-01-preview/types.json","Index":14},"Microsoft.Authorization/policySetDefinitions@2017-06-01-preview":{"RelativePath":"resources/microsoft.authorization/2017-06-01-preview/types.json","Index":25},"Microsoft.Authorization/policyAssignments@2018-03-01":{"RelativePath":"resources/microsoft.authorization/2018-03-01/types.json","Index":14},"Microsoft.Authorization/policyDefinitions@2018-03-01":{"RelativePath":"resources/microsoft.authorization/2018-03-01/types.json","Index":27},"Microsoft.Authorization/policySetDefinitions@2018-03-01":{"RelativePath":"resources/microsoft.authorization/2018-03-01/types.json","Index":38},"Microsoft.Authorization/policyAssignments@2018-05-01":{"RelativePath":"resources/microsoft.authorization/2018-05-01/types.json","Index":18},"Microsoft.Authorization/policyDefinitions@2018-05-01":{"RelativePath":"resources/microsoft.authorization/2018-05-01/types.json","Index":31},"Microsoft.Authorization/policySetDefinitions@2018-05-01":{"RelativePath":"resources/microsoft.authorization/2018-05-01/types.json","Index":42},"Microsoft.Authorization/policyAssignments@2019-01-01":{"RelativePath":"resources/microsoft.authorization/2019-01-01/types.json","Index":18},"Microsoft.Authorization/policyDefinitions@2019-01-01":{"RelativePath":"resources/microsoft.authorization/2019-01-01/types.json","Index":27},"Microsoft.Authorization/policySetDefinitions@2019-01-01":{"RelativePath":"resources/microsoft.authorization/2019-01-01/types.json","Index":38},"Microsoft.Authorization/policyAssignments@2019-06-01":{"RelativePath":"resources/microsoft.authorization/2019-06-01/types.json","Index":21},"Microsoft.Authorization/policyDefinitions@2019-06-01":{"RelativePath":"resources/microsoft.authorization/2019-06-01/types.json","Index":30},"Microsoft.Authorization/policySetDefinitions@2019-06-01":{"RelativePath":"resources/microsoft.authorization/2019-06-01/types.json","Index":41},"Microsoft.Authorization/policyAssignments@2019-09-01":{"RelativePath":"resources/microsoft.authorization/2019-09-01/types.json","Index":23},"Microsoft.Authorization/policyDefinitions@2019-09-01":{"RelativePath":"resources/microsoft.authorization/2019-09-01/types.json","Index":45},"Microsoft.Authorization/policySetDefinitions@2019-09-01":{"RelativePath":"resources/microsoft.authorization/2019-09-01/types.json","Index":62},"Microsoft.Authorization/policyAssignments@2020-03-01":{"RelativePath":"resources/microsoft.authorization/2020-03-01/types.json","Index":23},"Microsoft.Authorization/policyDefinitions@2020-03-01":{"RelativePath":"resources/microsoft.authorization/2020-03-01/types.json","Index":45},"Microsoft.Authorization/policySetDefinitions@2020-03-01":{"RelativePath":"resources/microsoft.authorization/2020-03-01/types.json","Index":62},"Microsoft.Authorization/privateLinkAssociations@2020-05-01":{"RelativePath":"resources/microsoft.authorization/2020-05-01/types.json","Index":15},"Microsoft.Authorization/resourceManagementPrivateLinks@2020-05-01":{"RelativePath":"resources/microsoft.authorization/2020-05-01/types.json","Index":21},"Microsoft.Authorization/locks@2020-05-01":{"RelativePath":"resources/microsoft.authorization/2020-05-01/types.json","Index":43},"Microsoft.Authorization/policyExemptions@2020-07-01-preview":{"RelativePath":"resources/microsoft.authorization/2020-07-01-preview/types.json","Index":27},"Microsoft.Authorization/policyAssignments@2020-09-01":{"RelativePath":"resources/microsoft.authorization/2020-09-01/types.json","Index":24},"Microsoft.Authorization/policyDefinitions@2020-09-01":{"RelativePath":"resources/microsoft.authorization/2020-09-01/types.json","Index":46},"Microsoft.Authorization/policySetDefinitions@2020-09-01":{"RelativePath":"resources/microsoft.authorization/2020-09-01/types.json","Index":63},"Microsoft.Authorization/policyAssignments@2021-06-01":{"RelativePath":"resources/microsoft.authorization/2021-06-01/types.json","Index":38},"Microsoft.Authorization/policyDefinitions@2021-06-01":{"RelativePath":"resources/microsoft.authorization/2021-06-01/types.json","Index":60},"Microsoft.Authorization/policySetDefinitions@2021-06-01":{"RelativePath":"resources/microsoft.authorization/2021-06-01/types.json","Index":77},"Microsoft.Features/featureProviders/subscriptionFeatureRegistrations@2021-07-01":{"RelativePath":"resources/microsoft.features/2021-07-01/types.json","Index":26},"Microsoft.Resources/deployments@2015-11-01":{"RelativePath":"resources/microsoft.resources/2015-11-01/types.json","Index":32},"Microsoft.Resources/resourceGroups@2015-11-01":{"RelativePath":"resources/microsoft.resources/2015-11-01/types.json","Index":38},"Microsoft.Resources/deployments@2016-02-01":{"RelativePath":"resources/microsoft.resources/2016-02-01/types.json","Index":38},"Microsoft.Resources/resourceGroups@2016-02-01":{"RelativePath":"resources/microsoft.resources/2016-02-01/types.json","Index":44},"Microsoft.Resources/deployments@2016-07-01":{"RelativePath":"resources/microsoft.resources/2016-07-01/types.json","Index":41},"Microsoft.Resources/resourceGroups@2016-07-01":{"RelativePath":"resources/microsoft.resources/2016-07-01/types.json","Index":47},"Microsoft.Resources/deployments@2016-09-01":{"RelativePath":"resources/microsoft.resources/2016-09-01/types.json","Index":41},"Microsoft.Resources/resourceGroups@2016-09-01":{"RelativePath":"resources/microsoft.resources/2016-09-01/types.json","Index":47},"Microsoft.Resources/deployments@2017-05-10":{"RelativePath":"resources/microsoft.resources/2017-05-10/types.json","Index":41},"Microsoft.Resources/resourceGroups@2017-05-10":{"RelativePath":"resources/microsoft.resources/2017-05-10/types.json","Index":47},"Microsoft.Resources/deployments@2018-02-01":{"RelativePath":"resources/microsoft.resources/2018-02-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2018-02-01":{"RelativePath":"resources/microsoft.resources/2018-02-01/types.json","Index":51},"Microsoft.Resources/deployments@2018-05-01":{"RelativePath":"resources/microsoft.resources/2018-05-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2018-05-01":{"RelativePath":"resources/microsoft.resources/2018-05-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-03-01":{"RelativePath":"resources/microsoft.resources/2019-03-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-03-01":{"RelativePath":"resources/microsoft.resources/2019-03-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-05-01":{"RelativePath":"resources/microsoft.resources/2019-05-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-05-01":{"RelativePath":"resources/microsoft.resources/2019-05-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-05-10":{"RelativePath":"resources/microsoft.resources/2019-05-10/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-05-10":{"RelativePath":"resources/microsoft.resources/2019-05-10/types.json","Index":51},"Microsoft.Resources/templateSpecs@2019-06-01-preview":{"RelativePath":"resources/microsoft.resources/2019-06-01-preview/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2019-06-01-preview":{"RelativePath":"resources/microsoft.resources/2019-06-01-preview/types.json","Index":36},"Microsoft.Resources/deployments@2019-07-01":{"RelativePath":"resources/microsoft.resources/2019-07-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-07-01":{"RelativePath":"resources/microsoft.resources/2019-07-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-08-01":{"RelativePath":"resources/microsoft.resources/2019-08-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-08-01":{"RelativePath":"resources/microsoft.resources/2019-08-01/types.json","Index":51},"Microsoft.Resources/deploymentScripts@2019-10-01-preview":{"RelativePath":"resources/microsoft.resources/2019-10-01-preview/types.json","Index":70},"Microsoft.Resources/deployments@2019-10-01":{"RelativePath":"resources/microsoft.resources/2019-10-01/types.json","Index":57},"Microsoft.Resources/resourceGroups@2019-10-01":{"RelativePath":"resources/microsoft.resources/2019-10-01/types.json","Index":63},"Microsoft.Resources/tags@2019-10-01":{"RelativePath":"resources/microsoft.resources/2019-10-01/types.json","Index":70},"Microsoft.Resources/deployments@2020-06-01":{"RelativePath":"resources/microsoft.resources/2020-06-01/types.json","Index":90},"Microsoft.Resources/resourceGroups@2020-06-01":{"RelativePath":"resources/microsoft.resources/2020-06-01/types.json","Index":96},"Microsoft.Resources/tags@2020-06-01":{"RelativePath":"resources/microsoft.resources/2020-06-01/types.json","Index":103},"Microsoft.Resources/deployments@2020-08-01":{"RelativePath":"resources/microsoft.resources/2020-08-01/types.json","Index":88},"Microsoft.Resources/resourceGroups@2020-08-01":{"RelativePath":"resources/microsoft.resources/2020-08-01/types.json","Index":94},"Microsoft.Resources/tags@2020-08-01":{"RelativePath":"resources/microsoft.resources/2020-08-01/types.json","Index":101},"Microsoft.Resources/deploymentScripts@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":70},"Microsoft.Resources/deployments@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":152},"Microsoft.Resources/resourceGroups@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":158},"Microsoft.Resources/tags@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":165},"Microsoft.Resources/deployments@2021-01-01":{"RelativePath":"resources/microsoft.resources/2021-01-01/types.json","Index":93},"Microsoft.Resources/resourceGroups@2021-01-01":{"RelativePath":"resources/microsoft.resources/2021-01-01/types.json","Index":99},"Microsoft.Resources/tags@2021-01-01":{"RelativePath":"resources/microsoft.resources/2021-01-01/types.json","Index":106},"Microsoft.Resources/templateSpecs@2021-03-01-preview":{"RelativePath":"resources/microsoft.resources/2021-03-01-preview/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2021-03-01-preview":{"RelativePath":"resources/microsoft.resources/2021-03-01-preview/types.json","Index":34},"Microsoft.Resources/deployments@2021-04-01":{"RelativePath":"resources/microsoft.resources/2021-04-01/types.json","Index":98},"Microsoft.Resources/resourceGroups@2021-04-01":{"RelativePath":"resources/microsoft.resources/2021-04-01/types.json","Index":104},"Microsoft.Resources/tags@2021-04-01":{"RelativePath":"resources/microsoft.resources/2021-04-01/types.json","Index":111},"Microsoft.Resources/templateSpecs@2021-05-01":{"RelativePath":"resources/microsoft.resources/2021-05-01/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2021-05-01":{"RelativePath":"resources/microsoft.resources/2021-05-01/types.json","Index":34},"Microsoft.Resources/templateSpecs@2022-02-01":{"RelativePath":"resources/microsoft.resources/2022-02-01/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2022-02-01":{"RelativePath":"resources/microsoft.resources/2022-02-01/types.json","Index":34},"Microsoft.Solutions/appliances@2016-09-01-preview":{"RelativePath":"resources/microsoft.solutions/2016-09-01-preview/types.json","Index":29},"Microsoft.Solutions/applianceDefinitions@2016-09-01-preview":{"RelativePath":"resources/microsoft.solutions/2016-09-01-preview/types.json","Index":46},"Microsoft.Solutions/applications@2017-09-01":{"RelativePath":"resources/microsoft.solutions/2017-09-01/types.json","Index":29},"Microsoft.Solutions/applicationDefinitions@2017-09-01":{"RelativePath":"resources/microsoft.solutions/2017-09-01/types.json","Index":46},"Microsoft.Solutions/applications@2018-06-01":{"RelativePath":"resources/microsoft.solutions/2018-06-01/types.json","Index":29},"Microsoft.Solutions/applicationDefinitions@2018-06-01":{"RelativePath":"resources/microsoft.solutions/2018-06-01/types.json","Index":46},"Microsoft.Solutions/applications@2019-07-01":{"RelativePath":"resources/microsoft.solutions/2019-07-01/types.json","Index":67},"Microsoft.Solutions/applicationDefinitions@2019-07-01":{"RelativePath":"resources/microsoft.solutions/2019-07-01/types.json","Index":107},"Microsoft.Solutions/jitRequests@2019-07-01":{"RelativePath":"resources/microsoft.solutions/2019-07-01/types.json","Index":142},"Microsoft.Solutions/applications@2020-08-21-preview":{"RelativePath":"resources/microsoft.solutions/2020-08-21-preview/types.json","Index":67},"Microsoft.Solutions/applicationDefinitions@2020-08-21-preview":{"RelativePath":"resources/microsoft.solutions/2020-08-21-preview/types.json","Index":107},"Microsoft.Solutions/jitRequests@2020-08-21-preview":{"RelativePath":"resources/microsoft.solutions/2020-08-21-preview/types.json","Index":142},"Microsoft.Scheduler/jobCollections@2014-08-01-preview":{"RelativePath":"scheduler/microsoft.scheduler/2014-08-01-preview/types.json","Index":31},"Microsoft.Scheduler/jobCollections/jobs@2014-08-01-preview":{"RelativePath":"scheduler/microsoft.scheduler/2014-08-01-preview/types.json","Index":116},"Microsoft.Scheduler/jobCollections@2016-01-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-01-01/types.json","Index":31},"Microsoft.Scheduler/jobCollections/jobs@2016-01-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-01-01/types.json","Index":116},"Microsoft.Scheduler/jobCollections@2016-03-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-03-01/types.json","Index":32},"Microsoft.Scheduler/jobCollections/jobs@2016-03-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-03-01/types.json","Index":118},"Microsoft.ScVmm/vmmServers@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":26},"Microsoft.ScVmm/clouds@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":35},"Microsoft.ScVmm/virtualNetworks@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":41},"Microsoft.ScVmm/virtualMachines@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":84},"Microsoft.ScVmm/virtualMachineTemplates@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":105},"Microsoft.ScVmm/availabilitySets@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":111},"Microsoft.ScVmm/vmmServers/inventoryItems@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":134},"Microsoft.Search/searchServices@2015-02-28":{"RelativePath":"search/microsoft.search/2015-02-28/types.json","Index":18},"Microsoft.Search/searchServices@2015-08-19":{"RelativePath":"search/microsoft.search/2015-08-19/types.json","Index":40},"Microsoft.Search/searchServices@2019-10-01-preview":{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":56},"Microsoft.Search/searchServices/privateEndpointConnections@2019-10-01-preview":{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":60},"Microsoft.Search/searchServices@2020-03-13":{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":56},"Microsoft.Search/searchServices/privateEndpointConnections@2020-03-13":{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":60},"Microsoft.Search/searchServices@2020-08-01-preview":{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":70},"Microsoft.Search/searchServices/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":74},"Microsoft.Search/searchServices/sharedPrivateLinkResources@2020-08-01-preview":{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":78},"Microsoft.Search/searchServices@2020-08-01":{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":70},"Microsoft.Search/searchServices/privateEndpointConnections@2020-08-01":{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":74},"Microsoft.Search/searchServices/sharedPrivateLinkResources@2020-08-01":{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":78},"Microsoft.Search/searchServices@2021-04-01-preview":{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":98},"Microsoft.Search/searchServices/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":102},"Microsoft.Search/searchServices/sharedPrivateLinkResources@2021-04-01-preview":{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":106},"Microsoft.Security/locations/jitNetworkAccessPolicies@2015-06-01-preview":{"RelativePath":"security/microsoft.security/2015-06-01-preview/types.json","Index":35},"Microsoft.Security/locations/applicationWhitelistings@2015-06-01-preview":{"RelativePath":"security/microsoft.security/2015-06-01-preview/types.json","Index":143},"Microsoft.Security/pricings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":15},"Microsoft.Security/securityContacts@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":26},"Microsoft.Security/workspaceSettings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":31},"Microsoft.Security/autoProvisioningSettings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":39},"Microsoft.Security/advancedThreatProtectionSettings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":46},"Microsoft.Security/deviceSecurityGroups@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":137},"Microsoft.Security/settings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":147},"Microsoft.Security/informationProtectionPolicies@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":167},"Microsoft.Security/iotSecuritySolutions@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":208},"Microsoft.Security/pricings@2018-06-01":{"RelativePath":"security/microsoft.security/2018-06-01/types.json","Index":15},"Microsoft.Security/automations@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":56},"Microsoft.Security/alertsSuppressionRules@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":68},"Microsoft.Security/assessmentMetadata@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":106},"Microsoft.Security/assessments@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":123},"Microsoft.Security/advancedThreatProtectionSettings@2019-01-01":{"RelativePath":"security/microsoft.security/2019-01-01/types.json","Index":13},"Microsoft.Security/settings@2019-01-01":{"RelativePath":"security/microsoft.security/2019-01-01/types.json","Index":23},"Microsoft.Security/deviceSecurityGroups@2019-08-01":{"RelativePath":"security/microsoft.security/2019-08-01/types.json","Index":100},"Microsoft.Security/iotSecuritySolutions@2019-08-01":{"RelativePath":"security/microsoft.security/2019-08-01/types.json","Index":163},"Microsoft.Security/connectors@2020-01-01-preview":{"RelativePath":"security/microsoft.security/2020-01-01-preview/types.json","Index":40},"Microsoft.Security/serverVulnerabilityAssessments@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":19},"Microsoft.Security/locations/applicationWhitelistings@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":121},"Microsoft.Security/locations/jitNetworkAccessPolicies@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":149},"Microsoft.Security/assessmentMetadata@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":189},"Microsoft.Security/assessments@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":207},"Microsoft.Security/sqlVulnerabilityAssessments/baselineRules@2020-07-01-preview":{"RelativePath":"security/microsoft.security/2020-07-01-preview/types.json","Index":16},"Microsoft.Security/ingestionSettings@2021-01-15-preview":{"RelativePath":"security/microsoft.security/2021-01-15-preview/types.json","Index":11},"Microsoft.Security/assessmentMetadata@2021-06-01":{"RelativePath":"security/microsoft.security/2021-06-01/types.json","Index":170},"Microsoft.Security/assessments@2021-06-01":{"RelativePath":"security/microsoft.security/2021-06-01/types.json","Index":223},"Microsoft.Security/customAssessmentAutomations@2021-07-01-preview":{"RelativePath":"security/microsoft.security/2021-07-01-preview/types.json","Index":30},"Microsoft.Security/customEntityStoreAssignments@2021-07-01-preview":{"RelativePath":"security/microsoft.security/2021-07-01-preview/types.json","Index":35},"Microsoft.Security/securityConnectors@2021-07-01-preview":{"RelativePath":"security/microsoft.security/2021-07-01-preview/types.json","Index":69},"Microsoft.Security/settings@2021-07-01":{"RelativePath":"security/microsoft.security/2021-07-01/types.json","Index":22},"Microsoft.Security/standards@2021-08-01-preview":{"RelativePath":"security/microsoft.security/2021-08-01-preview/types.json","Index":30},"Microsoft.Security/assignments@2021-08-01-preview":{"RelativePath":"security/microsoft.security/2021-08-01-preview/types.json","Index":39},"Microsoft.Security/securityConnectors@2021-12-01-preview":{"RelativePath":"security/microsoft.security/2021-12-01-preview/types.json","Index":102},"Microsoft.Security/pricings@2022-03-01":{"RelativePath":"security/microsoft.security/2022-03-01/types.json","Index":15},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":68},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":72},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":81},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":85},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":94},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":98},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":107},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":111},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":120},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":124},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":68},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":72},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":81},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":85},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":94},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":98},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":107},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":111},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":120},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":124},"Microsoft.SecurityAndCompliance/privateLinkServicesForMIPPolicySync@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":133},"Microsoft.SecurityAndCompliance/privateLinkServicesForMIPPolicySync/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":137},"Microsoft.SecurityInsights/automationRules@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":117},"Microsoft.SecurityInsights/bookmarks@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":130},"Microsoft.SecurityInsights/bookmarks/relations@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":135},"Microsoft.SecurityInsights/cases@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":176},"Microsoft.SecurityInsights/cases/comments@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":181},"Microsoft.SecurityInsights/cases/relations@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":192},"Microsoft.SecurityInsights/alertRules@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":202},"Microsoft.SecurityInsights/alertRules/actions@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":218},"Microsoft.SecurityInsights/dataConnectors@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":236},"Microsoft.SecurityInsights/settings@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":245},"Microsoft.SecurityInsights/incidents@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":288},"Microsoft.SecurityInsights/incidents/comments@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":293},"Microsoft.SecurityInsights/incidents/relations@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":297},"Microsoft.SecurityInsights/watchlists@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":306},"Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":311},"Microsoft.SecurityInsights/threatIntelligence/indicators@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":336},"Microsoft.SecurityInsights/alertRules@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":77},"Microsoft.SecurityInsights/alertRules/actions@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":82},"Microsoft.SecurityInsights/bookmarks@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":95},"Microsoft.SecurityInsights/dataConnectors@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":152},"Microsoft.SecurityInsights/incidents@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":199},"Microsoft.SecurityInsights/incidents/comments@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":205},"Microsoft.SecurityInsights/incidents@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":71},"Microsoft.SecurityInsights/incidents/comments@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":77},"Microsoft.SecurityInsights/incidents/relations@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":82},"Microsoft.SecurityInsights/settings@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":104},"Microsoft.SecurityInsights/onboardingStates@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":109},"Microsoft.SecurityInsights/sourcecontrols@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":127},"Microsoft.SecurityInsights/dataConnectors@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":268},"Microsoft.SecurityInsights/watchlists@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":278},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":283},"Microsoft.SecurityInsights/alertRules@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":463},"Microsoft.SecurityInsights/alertRules/actions@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":468},"Microsoft.SecurityInsights/entityQueries@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":552},"Microsoft.SecurityInsights/metadata@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":608},"Microsoft.SecurityInsights/incidents@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":65},"Microsoft.SecurityInsights/incidents/comments@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":71},"Microsoft.SecurityInsights/incidents/relations@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":76},"Microsoft.SecurityInsights/watchlists@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":86},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":91},"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":116},"Microsoft.SecurityInsights/alertRules@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":223},"Microsoft.SecurityInsights/alertRules/actions@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":228},"Microsoft.SecurityInsights/automationRules@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":342},"Microsoft.SecurityInsights/bookmarks@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":355},"Microsoft.SecurityInsights/bookmarks/relations@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":360},"Microsoft.SecurityInsights/entityQueries@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":444},"Microsoft.SecurityInsights/incidents@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":488},"Microsoft.SecurityInsights/incidents/comments@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":493},"Microsoft.SecurityInsights/incidents/relations@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":497},"Microsoft.SecurityInsights/metadata@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":553},"Microsoft.SecurityInsights/onboardingStates@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":558},"Microsoft.SecurityInsights/settings@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":580},"Microsoft.SecurityInsights/sourcecontrols@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":598},"Microsoft.SecurityInsights/watchlists@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":607},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":612},"Microsoft.SecurityInsights/dataConnectors@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":774},"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":799},"Microsoft.SerialConsole/serialPorts@2018-05-01":{"RelativePath":"serialconsole/microsoft.serialconsole/2018-05-01/types.json","Index":15},"Microsoft.ServiceBus/namespaces@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":36},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":46},"Microsoft.ServiceBus/namespaces/queues@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":68},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":72},"Microsoft.ServiceBus/namespaces/topics@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":93},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":97},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":118},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":17},"Microsoft.ServiceBus/namespaces@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":32},"Microsoft.ServiceBus/namespaces/networkRuleSets@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":48},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":52},"Microsoft.ServiceBus/namespaces/queues@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":68},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":72},"Microsoft.ServiceBus/namespaces/topics@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":87},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":100},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":107},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":119},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":134},"Microsoft.ServiceBus/namespaces/ipfilterrules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":15},"Microsoft.ServiceBus/namespaces@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":35},"Microsoft.ServiceBus/namespaces/virtualnetworkrules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":40},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":50},"Microsoft.ServiceBus/namespaces/networkRuleSets@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":66},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":85},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":98},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":102},"Microsoft.ServiceBus/namespaces/queues@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":118},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":122},"Microsoft.ServiceBus/namespaces/topics@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":137},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":144},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":159},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":171},"Microsoft.ServiceBus/namespaces@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":63},"Microsoft.ServiceBus/namespaces/networkRuleSets@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":79},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":89},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":93},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":106},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":113},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":117},"Microsoft.ServiceBus/namespaces/queues@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":133},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":137},"Microsoft.ServiceBus/namespaces/topics@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":152},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":164},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":179},"Microsoft.ServiceBus/namespaces@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":63},"Microsoft.ServiceBus/namespaces/networkRuleSets@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":82},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":92},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":96},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":109},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":116},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":120},"Microsoft.ServiceBus/namespaces/queues@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":136},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":140},"Microsoft.ServiceBus/namespaces/topics@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":155},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":167},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":183},"Microsoft.ServiceBus/namespaces@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":63},"Microsoft.ServiceBus/namespaces/networkRuleSets@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":82},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":92},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":96},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":109},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":116},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":120},"Microsoft.ServiceBus/namespaces/queues@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":136},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":140},"Microsoft.ServiceBus/namespaces/topics@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":155},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":167},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":183},"Microsoft.ServiceFabric/clusters@2016-09-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2016-09-01/types.json","Index":74},"Microsoft.ServiceFabric/clusters/applicationTypes@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":12},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":18},"Microsoft.ServiceFabric/clusters/applications@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":34},"Microsoft.ServiceFabric/clusters/applications/services@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":72},"Microsoft.ServiceFabric/clusters@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":145},"Microsoft.ServiceFabric/clusters@2018-02-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2018-02-01/types.json","Index":101},"Microsoft.ServiceFabric/clusters@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":101},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":107},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":114},"Microsoft.ServiceFabric/clusters/applications@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":131},"Microsoft.ServiceFabric/clusters/applications/services@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":173},"Microsoft.ServiceFabric/clusters@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":101},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":107},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":114},"Microsoft.ServiceFabric/clusters/applications@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":131},"Microsoft.ServiceFabric/clusters/applications/services@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":173},"Microsoft.ServiceFabric/clusters@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":101},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":107},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":114},"Microsoft.ServiceFabric/clusters/applications@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":141},"Microsoft.ServiceFabric/clusters/applications/services@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":183},"Microsoft.ServiceFabric/clusters@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":102},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":108},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":115},"Microsoft.ServiceFabric/clusters/applications@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":147},"Microsoft.ServiceFabric/clusters/applications/services@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":189},"Microsoft.ServiceFabric/managedClusters@2020-01-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-01-01-preview/types.json","Index":60},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2020-01-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-01-01-preview/types.json","Index":89},"Microsoft.ServiceFabric/clusters@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":102},"Microsoft.ServiceFabric/clusters/applicationTypes@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":108},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":115},"Microsoft.ServiceFabric/clusters/applications@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":147},"Microsoft.ServiceFabric/clusters/applications/services@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":189},"Microsoft.ServiceFabric/clusters@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":113},"Microsoft.ServiceFabric/clusters/applicationTypes@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":119},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":126},"Microsoft.ServiceFabric/clusters/applications@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":158},"Microsoft.ServiceFabric/clusters/applications/services@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":200},"Microsoft.ServiceFabric/clusters@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":126},"Microsoft.ServiceFabric/clusters/applicationTypes@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":132},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":139},"Microsoft.ServiceFabric/clusters/applications@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":171},"Microsoft.ServiceFabric/clusters/applications/services@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":213},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":185},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":216},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":188},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":223},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":190},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":232},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":201},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":249},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":201},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":249},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":201},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":250},"Microsoft.ServiceFabricMesh/applications@2018-07-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.json","Index":77},"Microsoft.ServiceFabricMesh/networks@2018-07-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.json","Index":88},"Microsoft.ServiceFabricMesh/volumes@2018-07-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.json","Index":97},"Microsoft.ServiceFabricMesh/secrets@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":22},"Microsoft.ServiceFabricMesh/secrets/values@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":28},"Microsoft.ServiceFabricMesh/volumes@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":44},"Microsoft.ServiceFabricMesh/networks@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":59},"Microsoft.ServiceFabricMesh/gateways@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":92},"Microsoft.ServiceFabricMesh/applications@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":186},"Microsoft.ServiceLinker/linkers@2021-11-01-preview":{"RelativePath":"servicelinker/microsoft.servicelinker/2021-11-01-preview/types.json","Index":50},"Microsoft.ServiceLinker/linkers@2022-01-01-preview":{"RelativePath":"servicelinker/microsoft.servicelinker/2022-01-01-preview/types.json","Index":67},"Microsoft.ServiceLinker/linkers@2022-05-01":{"RelativePath":"servicelinker/microsoft.servicelinker/2022-05-01/types.json","Index":67},"Microsoft.SignalRService/SignalR@2018-03-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2018-03-01-preview/types.json","Index":29},"Microsoft.SignalRService/signalR@2018-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2018-10-01/types.json","Index":37},"Microsoft.SignalRService/signalR@2020-05-01":{"RelativePath":"signalr/microsoft.signalrservice/2020-05-01/types.json","Index":95},"Microsoft.SignalRService/signalR/privateEndpointConnections@2020-05-01":{"RelativePath":"signalr/microsoft.signalrservice/2020-05-01/types.json","Index":99},"Microsoft.SignalRService/signalR@2020-07-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2020-07-01-preview/types.json","Index":104},"Microsoft.SignalRService/signalR/privateEndpointConnections@2020-07-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2020-07-01-preview/types.json","Index":108},"Microsoft.SignalRService/signalR@2021-04-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":139},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":143},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-04-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":147},"Microsoft.SignalRService/signalR@2021-06-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":139},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":143},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-06-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":147},"Microsoft.SignalRService/signalR@2021-09-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":139},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-09-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":143},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-09-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":147},"Microsoft.SignalRService/signalR@2021-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":143},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":147},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":151},"Microsoft.SignalRService/signalR@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":146},"Microsoft.SignalRService/signalR/customCertificates@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":161},"Microsoft.SignalRService/signalR/customDomains@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":177},"Microsoft.SignalRService/signalR/privateEndpointConnections@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":181},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":185},"Microsoft.SoftwarePlan/hybridUseBenefits@2019-06-01-preview":{"RelativePath":"softwareplan/microsoft.softwareplan/2019-06-01-preview/types.json","Index":17},"Microsoft.SoftwarePlan/hybridUseBenefits@2019-12-01":{"RelativePath":"softwareplan/microsoft.softwareplan/2019-12-01/types.json","Index":17},"Microsoft.Solutions/applications@2021-07-01":{"RelativePath":"solutions/microsoft.solutions/2021-07-01/types.json","Index":75},"Microsoft.Solutions/applicationDefinitions@2021-07-01":{"RelativePath":"solutions/microsoft.solutions/2021-07-01/types.json","Index":125},"Microsoft.Solutions/jitRequests@2021-07-01":{"RelativePath":"solutions/microsoft.solutions/2021-07-01/types.json","Index":157},"Microsoft.Sql/servers/databases/dataMaskingPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":16},"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":31},"Microsoft.Sql/servers/databases/geoBackupPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":41},"Microsoft.Sql/servers/databases@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":314},"Microsoft.Sql/servers/databases/extensions@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":328},"Microsoft.Sql/servers/elasticPools@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":344},"Microsoft.Sql/servers/communicationLinks@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":349},"Microsoft.Sql/servers/connectionPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":360},"Microsoft.Sql/servers/databases/securityAlertPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":377},"Microsoft.Sql/servers/firewallRules@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":382},"Microsoft.Sql/servers/databases/transparentDataEncryption@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":388},"Microsoft.Sql/servers@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":400},"Microsoft.Sql/servers/administrators@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":407},"Microsoft.Sql/servers/advisors@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":421},"Microsoft.Sql/servers/databases/advisors@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":425},"Microsoft.Sql/servers/disasterRecoveryConfiguration@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":445},"Microsoft.Sql/servers/auditingPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":452},"Microsoft.Sql/servers/databases/auditingPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":459},"Microsoft.Sql/servers/databases/connectionPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":466},"Microsoft.Sql/servers/encryptionProtector@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":17},"Microsoft.Sql/servers/failoverGroups@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":40},"Microsoft.Sql/servers/keys@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":48},"Microsoft.Sql/servers/syncAgents@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":57},"Microsoft.Sql/servers/virtualNetworkRules@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":68},"Microsoft.Sql/managedInstances@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":91},"Microsoft.Sql/servers@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":97},"Microsoft.Sql/servers/databases/syncGroups@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":116},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":147},"Microsoft.Sql/servers/databases/auditingSettings@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":158},"Microsoft.Sql/servers/firewallRules@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":163},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":18},"Microsoft.Sql/servers/extendedAuditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":29},"Microsoft.Sql/servers/auditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":40},"Microsoft.Sql/servers/databases/auditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":51},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":62},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":71},"Microsoft.Sql/servers/jobAgents@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":84},"Microsoft.Sql/servers/jobAgents/credentials@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":89},"Microsoft.Sql/servers/jobAgents/jobs/executions@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":118},"Microsoft.Sql/servers/jobAgents/jobs@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":127},"Microsoft.Sql/servers/jobAgents/jobs/steps@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":141},"Microsoft.Sql/servers/jobAgents/targetGroups@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":157},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":164},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":170},"Microsoft.Sql/servers/dnsAliases@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":175},"Microsoft.Sql/servers/securityAlertPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":188},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":194},"Microsoft.Sql/managedInstances/securityAlertPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":200},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":212},"Microsoft.Sql/managedInstances/administrators@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":220},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":227},"Microsoft.Sql/servers/databases@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":270},"Microsoft.Sql/managedInstances/databases@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":293},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":18},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":27},"Microsoft.Sql/locations/instanceFailoverGroups@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":50},"Microsoft.Sql/managedInstances/keys@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":58},"Microsoft.Sql/managedInstances/encryptionProtector@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":68},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":75},"Microsoft.Sql/servers/elasticPools@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":90},"Microsoft.Sql/servers/databases@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":142},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":16},"Microsoft.Sql/servers/vulnerabilityAssessments@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":23},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":35},"Microsoft.Sql/instancePools@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":45},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":52},"Microsoft.Sql/servers/databases/securityAlertPolicies@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":65},"Microsoft.Sql/managedInstances@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":87},"Microsoft.Sql/managedInstances/databases@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":110},"Microsoft.Sql/servers/privateEndpointConnections@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":117},"Microsoft.Sql/servers/administrators@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":126},"Microsoft.Sql/servers@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":40},"Microsoft.Sql/servers/databases/workloadGroups@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":45},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":50},"Microsoft.Sql/servers/administrators@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":59},"Microsoft.Sql/servers/databases/syncGroups@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":78},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":109},"Microsoft.Sql/servers/databases@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":166},"Microsoft.Sql/managedInstances/databases@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":189},"Microsoft.Sql/servers/databases@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":64},"Microsoft.Sql/servers@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":97},"Microsoft.Sql/managedInstances/databases@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":120},"Microsoft.Sql/servers/azureADOnlyAuthentications@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":127},"Microsoft.Sql/managedInstances@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":159},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":166},"Microsoft.Sql/locations/serverTrustGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":176},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":183},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":194},"Microsoft.Sql/servers/extendedAuditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":205},"Microsoft.Sql/servers/auditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":216},"Microsoft.Sql/servers/databases/auditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":227},"Microsoft.Sql/servers/databases/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":250},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":261},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":270},"Microsoft.Sql/servers/elasticPools@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":284},"Microsoft.Sql/servers/encryptionProtector@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":294},"Microsoft.Sql/servers/failoverGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":317},"Microsoft.Sql/servers/firewallRules@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":322},"Microsoft.Sql/locations/instanceFailoverGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":345},"Microsoft.Sql/instancePools@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":354},"Microsoft.Sql/servers/jobAgents@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":366},"Microsoft.Sql/servers/jobAgents/credentials@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":371},"Microsoft.Sql/servers/jobAgents/jobs/executions@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":400},"Microsoft.Sql/servers/jobAgents/jobs@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":409},"Microsoft.Sql/servers/jobAgents/jobs/steps@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":423},"Microsoft.Sql/servers/jobAgents/targetGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":439},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":446},"Microsoft.Sql/servers/databases/maintenanceWindows@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":462},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":469},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":482},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":494},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":504},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":511},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":517},"Microsoft.Sql/managedInstances/administrators@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":526},"Microsoft.Sql/managedInstances/encryptionProtector@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":536},"Microsoft.Sql/managedInstances/keys@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":544},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":550},"Microsoft.Sql/managedInstances/privateEndpointConnections@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":554},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":561},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":567},"Microsoft.Sql/managedInstances/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":573},"Microsoft.Sql/servers/privateEndpointConnections@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":577},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":582},"Microsoft.Sql/servers/administrators@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":591},"Microsoft.Sql/servers/devOpsAuditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":599},"Microsoft.Sql/servers/dnsAliases@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":604},"Microsoft.Sql/servers/keys@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":612},"Microsoft.Sql/servers/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":618},"Microsoft.Sql/servers/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":625},"Microsoft.Sql/managedInstances/sqlAgent@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":634},"Microsoft.Sql/servers/syncAgents@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":643},"Microsoft.Sql/servers/databases/syncGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":662},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":693},"Microsoft.Sql/servers/databases/transparentDataEncryption@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":703},"Microsoft.Sql/servers/virtualNetworkRules@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":715},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":720},"Microsoft.Sql/servers/databases/workloadGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":725},"Microsoft.Sql/servers/elasticPools@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":22},"Microsoft.Sql/servers/devOpsAuditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":41},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":48},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":59},"Microsoft.Sql/servers/extendedAuditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":70},"Microsoft.Sql/servers/auditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":81},"Microsoft.Sql/servers/databases/auditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":92},"Microsoft.Sql/servers/databases/extensions@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":102},"Microsoft.Sql/servers/databases@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":161},"Microsoft.Sql/servers/databases/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":173},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":184},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":193},"Microsoft.Sql/servers/encryptionProtector@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":203},"Microsoft.Sql/servers/failoverGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":226},"Microsoft.Sql/servers/firewallRules@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":231},"Microsoft.Sql/locations/instanceFailoverGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":254},"Microsoft.Sql/instancePools@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":263},"Microsoft.Sql/servers/jobAgents@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":275},"Microsoft.Sql/servers/jobAgents/credentials@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":280},"Microsoft.Sql/servers/jobAgents/jobs/executions@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":309},"Microsoft.Sql/servers/jobAgents/jobs@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":318},"Microsoft.Sql/servers/jobAgents/jobs/steps@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":332},"Microsoft.Sql/servers/jobAgents/targetGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":348},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":355},"Microsoft.Sql/servers/databases/maintenanceWindows@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":371},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":378},"Microsoft.Sql/managedInstances/databases@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":401},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":414},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":426},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":436},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":443},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":449},"Microsoft.Sql/managedInstances/administrators@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":458},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":465},"Microsoft.Sql/managedInstances/encryptionProtector@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":475},"Microsoft.Sql/managedInstances/keys@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":489},"Microsoft.Sql/managedInstances/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":496},"Microsoft.Sql/managedInstances@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":531},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":538},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":544},"Microsoft.Sql/managedInstances/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":550},"Microsoft.Sql/servers/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":570},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":575},"Microsoft.Sql/servers/administrators@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":584},"Microsoft.Sql/servers/azureADOnlyAuthentications@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":591},"Microsoft.Sql/servers/dnsAliases@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":596},"Microsoft.Sql/servers/keys@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":604},"Microsoft.Sql/servers@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":618},"Microsoft.Sql/servers/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":624},"Microsoft.Sql/locations/serverTrustGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":634},"Microsoft.Sql/servers/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":641},"Microsoft.Sql/managedInstances/sqlAgent@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":650},"Microsoft.Sql/servers/syncAgents@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":659},"Microsoft.Sql/servers/databases/syncGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":678},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":709},"Microsoft.Sql/servers/databases/transparentDataEncryption@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":719},"Microsoft.Sql/servers/virtualNetworkRules@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":731},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":736},"Microsoft.Sql/servers/databases/workloadGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":741},"Microsoft.Sql/servers/databases/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":30},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":41},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":50},"Microsoft.Sql/servers/encryptionProtector@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":60},"Microsoft.Sql/servers/failoverGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":83},"Microsoft.Sql/servers/firewallRules@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":88},"Microsoft.Sql/locations/instanceFailoverGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":111},"Microsoft.Sql/instancePools@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":121},"Microsoft.Sql/servers/jobAgents@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":133},"Microsoft.Sql/servers/jobAgents/credentials@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":138},"Microsoft.Sql/servers/jobAgents/jobs/executions@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":167},"Microsoft.Sql/servers/jobAgents/jobs@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":176},"Microsoft.Sql/servers/jobAgents/jobs/steps@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":190},"Microsoft.Sql/servers/jobAgents/targetGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":206},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":213},"Microsoft.Sql/servers/databases/maintenanceWindows@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":229},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":236},"Microsoft.Sql/managedInstances/databases@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":259},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":272},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":282},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":289},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":295},"Microsoft.Sql/managedInstances/administrators@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":304},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":311},"Microsoft.Sql/managedInstances/encryptionProtector@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":321},"Microsoft.Sql/managedInstances/keys@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":329},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":335},"Microsoft.Sql/managedInstances/privateEndpointConnections@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":342},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":349},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":355},"Microsoft.Sql/managedInstances/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":361},"Microsoft.Sql/servers/privateEndpointConnections@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":381},"Microsoft.Sql/servers/administrators@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":390},"Microsoft.Sql/servers/azureADOnlyAuthentications@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":397},"Microsoft.Sql/servers/devOpsAuditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":405},"Microsoft.Sql/servers/dnsAliases@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":410},"Microsoft.Sql/servers/keys@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":418},"Microsoft.Sql/servers/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":424},"Microsoft.Sql/locations/serverTrustGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":435},"Microsoft.Sql/servers/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":442},"Microsoft.Sql/managedInstances/sqlAgent@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":451},"Microsoft.Sql/servers/syncAgents@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":460},"Microsoft.Sql/servers/databases/syncGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":479},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":510},"Microsoft.Sql/servers/virtualNetworkRules@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":522},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":527},"Microsoft.Sql/servers/databases/workloadGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":532},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":544},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":549},"Microsoft.Sql/servers/databases@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":612},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":619},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":629},"Microsoft.Sql/servers/extendedAuditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":639},"Microsoft.Sql/servers/auditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":649},"Microsoft.Sql/servers/databases/auditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":659},"Microsoft.Sql/servers/databases/extensions@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":669},"Microsoft.Sql/servers/elasticPools@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":683},"Microsoft.Sql/managedInstances@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":727},"Microsoft.Sql/servers@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":748},"Microsoft.Sql/servers/databases/transparentDataEncryption@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":758},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":17},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":24},"Microsoft.Sql/servers/databases/extensions@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":34},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":44},"Microsoft.Sql/servers/outboundFirewallRules@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":49},"Microsoft.Sql/servers@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":97},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":108},"Microsoft.Sql/servers/extendedAuditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":119},"Microsoft.Sql/servers/auditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":130},"Microsoft.Sql/servers/databases/auditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":141},"Microsoft.Sql/servers/databases@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":205},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":228},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":239},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":248},"Microsoft.Sql/servers/elasticPools@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":262},"Microsoft.Sql/servers/encryptionProtector@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":272},"Microsoft.Sql/servers/failoverGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":295},"Microsoft.Sql/servers/firewallRules@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":300},"Microsoft.Sql/locations/instanceFailoverGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":323},"Microsoft.Sql/instancePools@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":332},"Microsoft.Sql/servers/jobAgents@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":344},"Microsoft.Sql/servers/jobAgents/credentials@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":349},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":378},"Microsoft.Sql/servers/jobAgents/jobs@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":387},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":401},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":417},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":424},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":440},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":447},"Microsoft.Sql/managedInstances/databases@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":470},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":495},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":505},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":512},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":518},"Microsoft.Sql/managedInstances/administrators@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":527},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":534},"Microsoft.Sql/managedInstances/encryptionProtector@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":544},"Microsoft.Sql/managedInstances/keys@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":552},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":558},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":565},"Microsoft.Sql/managedInstances@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":610},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":617},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":623},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":629},"Microsoft.Sql/servers/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":633},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":638},"Microsoft.Sql/servers/administrators@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":647},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":654},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":662},"Microsoft.Sql/servers/dnsAliases@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":667},"Microsoft.Sql/servers/keys@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":675},"Microsoft.Sql/servers/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":681},"Microsoft.Sql/locations/serverTrustGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":692},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":699},"Microsoft.Sql/managedInstances/sqlAgent@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":708},"Microsoft.Sql/servers/syncAgents@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":717},"Microsoft.Sql/servers/databases/syncGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":736},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":767},"Microsoft.Sql/servers/virtualNetworkRules@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":779},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":784},"Microsoft.Sql/servers/databases/workloadGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":789},"Microsoft.Sql/servers/databases@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":82},"Microsoft.Sql/managedInstances@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":148},"Microsoft.Sql/servers/connectionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":159},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":166},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":177},"Microsoft.Sql/servers/extendedAuditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":188},"Microsoft.Sql/servers/auditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":199},"Microsoft.Sql/servers/databases/auditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":210},"Microsoft.Sql/servers/databases/extensions@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":223},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":246},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":257},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":266},"Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":274},"Microsoft.Sql/servers/elasticPools@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":288},"Microsoft.Sql/servers/encryptionProtector@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":298},"Microsoft.Sql/servers/failoverGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":321},"Microsoft.Sql/servers/firewallRules@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":326},"Microsoft.Sql/locations/instanceFailoverGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":349},"Microsoft.Sql/instancePools@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":358},"Microsoft.Sql/servers/jobAgents@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":370},"Microsoft.Sql/servers/jobAgents/credentials@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":375},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":404},"Microsoft.Sql/servers/jobAgents/jobs@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":413},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":427},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":443},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":453},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":460},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":476},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":506},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":519},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":531},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":541},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":548},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":554},"Microsoft.Sql/managedInstances/administrators@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":563},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":570},"Microsoft.Sql/managedInstances/encryptionProtector@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":580},"Microsoft.Sql/managedInstances/keys@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":588},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":594},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":598},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":605},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":611},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":617},"Microsoft.Sql/servers/outboundFirewallRules@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":622},"Microsoft.Sql/servers/privateEndpointConnections@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":643},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":648},"Microsoft.Sql/servers/administrators@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":657},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":664},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":672},"Microsoft.Sql/servers/dnsAliases@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":677},"Microsoft.Sql/servers/keys@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":685},"Microsoft.Sql/servers@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":709},"Microsoft.Sql/servers/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":715},"Microsoft.Sql/managedInstances/serverTrustCertificates@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":720},"Microsoft.Sql/locations/serverTrustGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":731},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":738},"Microsoft.Sql/managedInstances/sqlAgent@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":747},"Microsoft.Sql/servers/syncAgents@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":756},"Microsoft.Sql/servers/databases/syncGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":775},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":806},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":816},"Microsoft.Sql/servers/virtualNetworkRules@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":828},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":833},"Microsoft.Sql/servers/databases/workloadGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":838},"Microsoft.Sql/servers/elasticPools@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":22},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":29},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":39},"Microsoft.Sql/servers/extendedAuditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":49},"Microsoft.Sql/servers/auditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":59},"Microsoft.Sql/servers/databases/auditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":69},"Microsoft.Sql/servers/databases/extensions@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":82},"Microsoft.Sql/servers/databases@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":156},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":179},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":190},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":199},"Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":207},"Microsoft.Sql/servers/encryptionProtector@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":217},"Microsoft.Sql/servers/failoverGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":240},"Microsoft.Sql/servers/firewallRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":245},"Microsoft.Sql/locations/instanceFailoverGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":268},"Microsoft.Sql/instancePools@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":277},"Microsoft.Sql/servers/ipv6FirewallRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":282},"Microsoft.Sql/servers/jobAgents@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":294},"Microsoft.Sql/servers/jobAgents/credentials@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":299},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":328},"Microsoft.Sql/servers/jobAgents/jobs@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":337},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":351},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":367},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":377},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":384},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":400},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":407},"Microsoft.Sql/managedInstances/databases@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":430},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":443},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":455},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":465},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":472},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":478},"Microsoft.Sql/managedInstances/administrators@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":487},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":494},"Microsoft.Sql/managedInstances/encryptionProtector@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":504},"Microsoft.Sql/managedInstances/keys@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":512},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":518},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":525},"Microsoft.Sql/managedInstances@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":588},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":595},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":601},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":607},"Microsoft.Sql/servers/outboundFirewallRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":612},"Microsoft.Sql/servers/privateEndpointConnections@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":633},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":638},"Microsoft.Sql/servers/administrators@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":647},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":654},"Microsoft.Sql/servers/connectionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":665},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":673},"Microsoft.Sql/servers/dnsAliases@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":678},"Microsoft.Sql/servers/keys@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":686},"Microsoft.Sql/servers@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":710},"Microsoft.Sql/servers/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":716},"Microsoft.Sql/managedInstances/serverTrustCertificates@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":721},"Microsoft.Sql/locations/serverTrustGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":732},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":739},"Microsoft.Sql/managedInstances/sqlAgent@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":748},"Microsoft.Sql/servers/syncAgents@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":757},"Microsoft.Sql/servers/databases/syncGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":776},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":807},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":817},"Microsoft.Sql/servers/virtualNetworkRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":829},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":834},"Microsoft.Sql/servers/databases/workloadGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":839},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":14},"Microsoft.Sql/servers/auditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":24},"Microsoft.Sql/servers/databases/auditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":34},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":44},"Microsoft.Sql/servers/extendedAuditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":54},"Microsoft.Sql/servers/databases/advancedThreatProtectionSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":76},"Microsoft.Sql/servers/databases/extensions@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":89},"Microsoft.Sql/servers/databases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":164},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":176},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":187},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":196},"Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":204},"Microsoft.Sql/servers/elasticPools@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":218},"Microsoft.Sql/servers/encryptionProtector@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":228},"Microsoft.Sql/servers/failoverGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":251},"Microsoft.Sql/servers/firewallRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":256},"Microsoft.Sql/locations/instanceFailoverGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":279},"Microsoft.Sql/instancePools@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":288},"Microsoft.Sql/servers/ipv6FirewallRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":293},"Microsoft.Sql/servers/jobAgents@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":305},"Microsoft.Sql/servers/jobAgents/credentials@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":310},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":339},"Microsoft.Sql/servers/jobAgents/jobs@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":348},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":362},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":378},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":388},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":395},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":411},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":418},"Microsoft.Sql/managedInstances/databases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":441},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":454},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":466},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":476},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":489},"Microsoft.Sql/managedInstances/administrators@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":498},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":505},"Microsoft.Sql/managedInstances/encryptionProtector@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":515},"Microsoft.Sql/managedInstances/keys@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":523},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":529},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":536},"Microsoft.Sql/managedInstances@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":599},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":606},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":612},"Microsoft.Sql/managedInstances/dnsAliases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":617},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":623},"Microsoft.Sql/servers/outboundFirewallRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":628},"Microsoft.Sql/servers/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":649},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":654},"Microsoft.Sql/servers/advancedThreatProtectionSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":660},"Microsoft.Sql/servers/administrators@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":669},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":676},"Microsoft.Sql/servers/connectionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":687},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":695},"Microsoft.Sql/servers/dnsAliases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":700},"Microsoft.Sql/servers/keys@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":708},"Microsoft.Sql/servers@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":732},"Microsoft.Sql/servers/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":738},"Microsoft.Sql/managedInstances/serverTrustCertificates@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":743},"Microsoft.Sql/locations/serverTrustGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":754},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":761},"Microsoft.Sql/managedInstances/sqlAgent@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":770},"Microsoft.Sql/servers/syncAgents@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":779},"Microsoft.Sql/servers/databases/syncGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":798},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":829},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":839},"Microsoft.Sql/servers/virtualNetworkRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":851},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":856},"Microsoft.Sql/servers/databases/workloadGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":861},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2017-03-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.json","Index":16},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2017-03-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.json","Index":32},"Microsoft.SqlVirtualMachine/sqlVirtualMachines@2017-03-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.json","Index":101},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2021-11-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.json","Index":43},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2021-11-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.json","Index":59},"Microsoft.SqlVirtualMachine/sqlVirtualMachines@2021-11-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.json","Index":151},"Microsoft.Storage/storageAccounts@2015-05-01-preview":{"RelativePath":"storage/microsoft.storage/2015-05-01-preview/types.json","Index":31},"Microsoft.Storage/storageAccounts@2015-06-15":{"RelativePath":"storage/microsoft.storage/2015-06-15/types.json","Index":31},"Microsoft.Storage/storageAccounts@2016-01-01":{"RelativePath":"storage/microsoft.storage/2016-01-01/types.json","Index":46},"Microsoft.Storage/storageAccounts@2016-05-01":{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":46},"Microsoft.Storage/storageAccounts@2016-12-01":{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":46},"Microsoft.Storage/storageAccounts@2017-06-01":{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":83},"Microsoft.Storage/storageAccounts@2017-10-01":{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":85},"Microsoft.Storage/storageAccounts@2018-02-01":{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":85},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-02-01":{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":121},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-02-01":{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":127},"Microsoft.Storage/storageAccounts/managementPolicies@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":14},"Microsoft.Storage/storageAccounts@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":92},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":128},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":134},"Microsoft.Storage/storageAccounts@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":95},"Microsoft.Storage/storageAccounts/blobServices@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":118},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":154},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":160},"Microsoft.Storage/storageAccounts@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":95},"Microsoft.Storage/storageAccounts/managementPolicies@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":116},"Microsoft.Storage/storageAccounts/blobServices@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":139},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":175},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":181},"Microsoft.Storage/storageAccounts@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":110},"Microsoft.Storage/storageAccounts/managementPolicies@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":131},"Microsoft.Storage/storageAccounts/blobServices@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":155},"Microsoft.Storage/storageAccounts/blobServices/containers@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":191},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":197},"Microsoft.Storage/storageAccounts/fileServices@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":204},"Microsoft.Storage/storageAccounts/fileServices/shares@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":210},"Microsoft.Storage/storageAccounts@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":126},"Microsoft.Storage/storageAccounts/managementPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":150},"Microsoft.Storage/storageAccounts/inventoryPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":177},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":181},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":190},"Microsoft.Storage/storageAccounts/encryptionScopes@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":202},"Microsoft.Storage/storageAccounts/blobServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":231},"Microsoft.Storage/storageAccounts/blobServices/containers@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":267},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":273},"Microsoft.Storage/storageAccounts/fileServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":280},"Microsoft.Storage/storageAccounts/fileServices/shares@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":298},"Microsoft.Storage/storageAccounts/queueServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":305},"Microsoft.Storage/storageAccounts/queueServices/queues@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":311},"Microsoft.Storage/storageAccounts/tableServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":318},"Microsoft.Storage/storageAccounts/tableServices/tables@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":323},"Microsoft.Storage/storageAccounts@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":131},"Microsoft.Storage/storageAccounts/managementPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":155},"Microsoft.Storage/storageAccounts/inventoryPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":182},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":186},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":195},"Microsoft.Storage/storageAccounts/encryptionScopes@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":207},"Microsoft.Storage/storageAccounts/blobServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":236},"Microsoft.Storage/storageAccounts/blobServices/containers@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":272},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":278},"Microsoft.Storage/storageAccounts/fileServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":288},"Microsoft.Storage/storageAccounts/fileServices/shares@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":306},"Microsoft.Storage/storageAccounts/queueServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":313},"Microsoft.Storage/storageAccounts/queueServices/queues@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":319},"Microsoft.Storage/storageAccounts/tableServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":326},"Microsoft.Storage/storageAccounts/tableServices/tables@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":331},"Microsoft.Storage/storageAccounts@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":138},"Microsoft.Storage/storageAccounts/managementPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":162},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":189},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":193},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":202},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":214},"Microsoft.Storage/storageAccounts/blobServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":243},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":279},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":285},"Microsoft.Storage/storageAccounts/fileServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":295},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":313},"Microsoft.Storage/storageAccounts/queueServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":320},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":326},"Microsoft.Storage/storageAccounts/tableServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":333},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":338},"Microsoft.Storage/storageAccounts@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":143},"Microsoft.Storage/storageAccounts/managementPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":167},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":194},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":198},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":207},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":219},"Microsoft.Storage/storageAccounts/blobServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":248},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":284},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":290},"Microsoft.Storage/storageAccounts/fileServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":300},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":318},"Microsoft.Storage/storageAccounts/queueServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":325},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":331},"Microsoft.Storage/storageAccounts/tableServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":338},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":343},"Microsoft.Storage/storageAccounts@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":149},"Microsoft.Storage/storageAccounts/managementPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":173},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":210},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":214},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":223},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":235},"Microsoft.Storage/storageAccounts/blobServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":264},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":304},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":310},"Microsoft.Storage/storageAccounts/fileServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":320},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":353},"Microsoft.Storage/storageAccounts/queueServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":360},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":366},"Microsoft.Storage/storageAccounts/tableServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":373},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":378},"Microsoft.Storage/storageAccounts@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":157},"Microsoft.Storage/storageAccounts/managementPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":181},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":218},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":222},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":231},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":243},"Microsoft.Storage/storageAccounts/blobServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":271},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":312},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":317},"Microsoft.Storage/storageAccounts/fileServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":326},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":359},"Microsoft.Storage/storageAccounts/queueServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":365},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":371},"Microsoft.Storage/storageAccounts/tableServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":377},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":382},"Microsoft.Storage/storageAccounts@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":163},"Microsoft.Storage/storageAccounts/managementPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":187},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":224},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":228},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":237},"Microsoft.Storage/storageAccounts/localUsers@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":246},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":258},"Microsoft.Storage/storageAccounts/blobServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":286},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":327},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":332},"Microsoft.Storage/storageAccounts/fileServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":341},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":374},"Microsoft.Storage/storageAccounts/queueServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":380},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":386},"Microsoft.Storage/storageAccounts/tableServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":392},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":397},"Microsoft.Storage/storageAccounts@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":181},"Microsoft.Storage/storageAccounts/managementPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":205},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":243},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":247},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":256},"Microsoft.Storage/storageAccounts/localUsers@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":265},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":277},"Microsoft.Storage/storageAccounts/blobServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":306},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":347},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":352},"Microsoft.Storage/storageAccounts/fileServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":361},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":394},"Microsoft.Storage/storageAccounts/queueServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":400},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":406},"Microsoft.Storage/storageAccounts/tableServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":412},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":420},"Microsoft.StorageCache/caches@2019-08-01-preview":{"RelativePath":"storagecache/microsoft.storagecache/2019-08-01-preview/types.json","Index":36},"Microsoft.StorageCache/caches/storageTargets@2019-08-01-preview":{"RelativePath":"storagecache/microsoft.storagecache/2019-08-01-preview/types.json","Index":58},"Microsoft.StorageCache/caches@2019-11-01":{"RelativePath":"storagecache/microsoft.storagecache/2019-11-01/types.json","Index":36},"Microsoft.StorageCache/caches/storageTargets@2019-11-01":{"RelativePath":"storagecache/microsoft.storagecache/2019-11-01/types.json","Index":58},"Microsoft.StorageCache/caches@2020-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-03-01/types.json","Index":57},"Microsoft.StorageCache/caches/storageTargets@2020-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-03-01/types.json","Index":81},"Microsoft.StorageCache/caches@2020-10-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-10-01/types.json","Index":87},"Microsoft.StorageCache/caches/storageTargets@2020-10-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-10-01/types.json","Index":111},"Microsoft.StorageCache/caches@2021-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-03-01/types.json","Index":91},"Microsoft.StorageCache/caches/storageTargets@2021-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-03-01/types.json","Index":115},"Microsoft.StorageCache/caches@2021-05-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-05-01/types.json","Index":95},"Microsoft.StorageCache/caches/storageTargets@2021-05-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-05-01/types.json","Index":119},"Microsoft.StorageCache/caches@2021-09-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-09-01/types.json","Index":95},"Microsoft.StorageCache/caches/storageTargets@2021-09-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-09-01/types.json","Index":124},"Microsoft.StorageCache/caches@2022-01-01":{"RelativePath":"storagecache/microsoft.storagecache/2022-01-01/types.json","Index":96},"Microsoft.StorageCache/caches/storageTargets@2022-01-01":{"RelativePath":"storagecache/microsoft.storagecache/2022-01-01/types.json","Index":125},"Microsoft.ImportExport/jobs@2016-11-01":{"RelativePath":"storageimportexport/microsoft.importexport/2016-11-01/types.json","Index":51},"Microsoft.ImportExport/jobs@2020-08-01":{"RelativePath":"storageimportexport/microsoft.importexport/2020-08-01/types.json","Index":51},"Microsoft.ImportExport/jobs@2021-01-01":{"RelativePath":"storageimportexport/microsoft.importexport/2021-01-01/types.json","Index":51},"Microsoft.StoragePool/diskPools@2020-03-15-preview":{"RelativePath":"storagepool/microsoft.storagepool/2020-03-15-preview/types.json","Index":40},"Microsoft.StoragePool/diskPools/iscsiTargets@2020-03-15-preview":{"RelativePath":"storagepool/microsoft.storagepool/2020-03-15-preview/types.json","Index":73},"Microsoft.StoragePool/diskPools@2021-04-01-preview":{"RelativePath":"storagepool/microsoft.storagepool/2021-04-01-preview/types.json","Index":47},"Microsoft.StoragePool/diskPools/iscsiTargets@2021-04-01-preview":{"RelativePath":"storagepool/microsoft.storagepool/2021-04-01-preview/types.json","Index":79},"Microsoft.StoragePool/diskPools@2021-08-01":{"RelativePath":"storagepool/microsoft.storagepool/2021-08-01/types.json","Index":48},"Microsoft.StoragePool/diskPools/iscsiTargets@2021-08-01":{"RelativePath":"storagepool/microsoft.storagepool/2021-08-01/types.json","Index":82},"Microsoft.StorageSync/storageSyncServices@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":17},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":22},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":42},"Microsoft.StorageSync/storageSyncServices/registeredServers@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":47},"Microsoft.StorageSync/storageSyncServices@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":13},"Microsoft.StorageSync/storageSyncServices/syncGroups@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":18},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":24},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":33},"Microsoft.StorageSync/storageSyncServices/registeredServers@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":39},"Microsoft.StorageSync/storageSyncServices@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":29},"Microsoft.StorageSync/storageSyncServices/registeredServers@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":34},"Microsoft.StorageSync/storageSyncServices@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":64},"Microsoft.StorageSync/storageSyncServices/registeredServers@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":69},"Microsoft.StorageSync/storageSyncServices@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":64},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":69},"Microsoft.StorageSync/storageSyncServices@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":64},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":69},"Microsoft.StorageSync/storageSyncServices@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":71},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":76},"Microsoft.StorageSync/storageSyncServices@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":78},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":83},"Microsoft.StorageSync/storageSyncServices@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":30},"Microsoft.StorageSync/storageSyncServices/privateEndpointConnections@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":34},"Microsoft.StorageSync/storageSyncServices/syncGroups@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":38},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":43},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":119},"Microsoft.StorageSync/storageSyncServices/registeredServers@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":129},"Microsoft.StorageSync/storageSyncServices@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":41},"Microsoft.StorageSync/storageSyncServices/privateEndpointConnections@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":45},"Microsoft.StorageSync/storageSyncServices/syncGroups@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":49},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":63},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":138},"Microsoft.StorageSync/storageSyncServices/registeredServers@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":148},"Microsoft.StorSimple/managers@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":19},"Microsoft.StorSimple/managers/certificates@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":58},"Microsoft.StorSimple/managers/extendedInformation@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":64},"Microsoft.StorSimple/managers/accessControlRecords@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":69},"Microsoft.StorSimple/managers/devices/alertSettings@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":82},"Microsoft.StorSimple/managers/devices/backupScheduleGroups@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":88},"Microsoft.StorSimple/managers/devices/chapSettings@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":98},"Microsoft.StorSimple/managers/devices/iscsiservers/disks@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":115},"Microsoft.StorSimple/managers/devices/fileservers@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":120},"Microsoft.StorSimple/managers/devices/fileservers/shares@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":136},"Microsoft.StorSimple/managers/devices/iscsiservers@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":141},"Microsoft.StorSimple/managers/storageAccountCredentials@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":155},"Microsoft.StorSimple/managers/storageDomains@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":164},"Microsoft.StorSimple/managers@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":19},"Microsoft.StorSimple/managers/extendedInformation@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":26},"Microsoft.StorSimple/managers/accessControlRecords@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":32},"Microsoft.StorSimple/managers/bandwidthSettings@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":50},"Microsoft.StorSimple/managers/devices/alertSettings@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":64},"Microsoft.StorSimple/managers/devices/timeSettings@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":72},"Microsoft.StorSimple/managers/devices/backupPolicies@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":85},"Microsoft.StorSimple/managers/devices/backupPolicies/schedules@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":112},"Microsoft.StorSimple/managers/devices/volumeContainers@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":129},"Microsoft.StorSimple/managers/devices/volumeContainers/volumes@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":155},"Microsoft.StorSimple/managers/storageAccountCredentials@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":164},"Microsoft.StreamAnalytics/streamingjobs@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":129},"Microsoft.StreamAnalytics/streamingjobs/inputs@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":133},"Microsoft.StreamAnalytics/streamingjobs/outputs@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":137},"Microsoft.StreamAnalytics/streamingjobs/transformations@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":141},"Microsoft.StreamAnalytics/streamingjobs/functions@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":145},"Microsoft.StreamAnalytics/streamingjobs/functions@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":42},"Microsoft.StreamAnalytics/streamingjobs/inputs@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":115},"Microsoft.StreamAnalytics/streamingjobs/outputs@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":194},"Microsoft.StreamAnalytics/streamingjobs@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":237},"Microsoft.StreamAnalytics/streamingjobs/transformations@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":241},"Microsoft.StreamAnalytics/clusters@2020-03-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.json","Index":21},"Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.json","Index":31},"Microsoft.StreamAnalytics/streamingjobs@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":212},"Microsoft.StreamAnalytics/streamingjobs/inputs@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":216},"Microsoft.StreamAnalytics/streamingjobs/outputs@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":220},"Microsoft.StreamAnalytics/streamingjobs/transformations@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":224},"Microsoft.StreamAnalytics/streamingjobs/functions@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":228},"Microsoft.StreamAnalytics/clusters@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":242},"Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":252},"Microsoft.StreamAnalytics/streamingjobs/functions@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":45},"Microsoft.StreamAnalytics/streamingjobs/inputs@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":152},"Microsoft.StreamAnalytics/streamingjobs/outputs@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":258},"Microsoft.StreamAnalytics/streamingjobs@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":310},"Microsoft.StreamAnalytics/streamingjobs/transformations@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":314},"Microsoft.Subscription/subscriptionDefinitions@2017-11-01-preview":{"RelativePath":"subscription/microsoft.subscription/2017-11-01-preview/types.json","Index":12},"Microsoft.Subscription/aliases@2019-10-01-preview":{"RelativePath":"subscription/microsoft.subscription/2019-10-01-preview/types.json","Index":19},"Microsoft.Subscription/aliases@2020-09-01":{"RelativePath":"subscription/microsoft.subscription/2020-09-01/types.json","Index":19},"Microsoft.Subscription/aliases@2021-10-01":{"RelativePath":"subscription/microsoft.subscription/2021-10-01/types.json","Index":37},"Microsoft.Subscription/policies@2021-10-01":{"RelativePath":"subscription/microsoft.subscription/2021-10-01/types.json","Index":45},"Microsoft.Support/supportTickets@2019-05-01-preview":{"RelativePath":"support/microsoft.support/2019-05-01-preview/types.json","Index":27},"Microsoft.Support/supportTickets/communications@2019-05-01-preview":{"RelativePath":"support/microsoft.support/2019-05-01-preview/types.json","Index":38},"Microsoft.Support/supportTickets@2020-04-01":{"RelativePath":"support/microsoft.support/2020-04-01/types.json","Index":28},"Microsoft.Support/supportTickets/communications@2020-04-01":{"RelativePath":"support/microsoft.support/2020-04-01/types.json","Index":39},"Microsoft.Synapse/workspaces/bigDataPools@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":30},"Microsoft.Synapse/workspaces/firewallRules@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":41},"Microsoft.Synapse/workspaces/sqlPools@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":53},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":59},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":69},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":85},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":95},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":106},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":118},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":127},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":140},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":151},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":162},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":171},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":186},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":191},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":196},"Microsoft.Synapse/workspaces@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":223},"Microsoft.Synapse/workspaces/administrators@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":229},"Microsoft.Synapse/workspaces/sqlAdministrators@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":234},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":250},"Microsoft.Synapse/workspaces/integrationRuntimes@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":322},"Microsoft.Synapse/workspaces/privateEndpointConnections@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":326},"Microsoft.Synapse/privateLinkHubs@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":334},"Microsoft.Synapse/workspaces/auditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":345},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":356},"Microsoft.Synapse/workspaces/securityAlertPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":369},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":376},"Microsoft.Synapse/workspaces/keys@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":381},"Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2020-04-01-preview/types.json","Index":38},"Microsoft.Synapse/workspaces/sqlDatabases@2020-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2020-04-01-preview/types.json","Index":72},"Microsoft.Synapse/workspaces/bigDataPools@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":43},"Microsoft.Synapse/workspaces/sqlPools@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":59},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":65},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":75},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":91},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":101},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":112},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":124},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":133},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":146},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":157},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":168},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":177},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":192},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":197},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":202},"Microsoft.Synapse/workspaces@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":228},"Microsoft.Synapse/workspaces/administrators@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":234},"Microsoft.Synapse/workspaces/sqlAdministrators@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":239},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":255},"Microsoft.Synapse/workspaces/integrationRuntimes@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":324},"Microsoft.Synapse/workspaces/privateEndpointConnections@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":328},"Microsoft.Synapse/privateLinkHubs@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":336},"Microsoft.Synapse/workspaces/auditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":347},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":358},"Microsoft.Synapse/workspaces/securityAlertPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":371},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":378},"Microsoft.Synapse/workspaces/encryptionProtector@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":388},"Microsoft.Synapse/workspaces/keys@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":393},"Microsoft.Synapse/workspaces/bigDataPools@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":43},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":112},"Microsoft.Synapse/workspaces/keys@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":117},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":124},"Microsoft.Synapse/privateLinkHubs@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":132},"Microsoft.Synapse/workspaces/sqlPools@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":148},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":154},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":164},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":190},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":201},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":213},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":222},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":235},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":246},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":257},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":266},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":281},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":286},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":291},"Microsoft.Synapse/workspaces/auditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":302},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":313},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":326},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":333},"Microsoft.Synapse/workspaces/encryptionProtector@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":343},"Microsoft.Synapse/workspaces@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":369},"Microsoft.Synapse/workspaces/administrators@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":375},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":380},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":396},"Microsoft.Synapse/workspaces/bigDataPools@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":43},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":112},"Microsoft.Synapse/workspaces/keys@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":117},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":124},"Microsoft.Synapse/privateLinkHubs@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":132},"Microsoft.Synapse/workspaces/sqlPools@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":148},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":154},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":164},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":190},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":201},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":213},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":222},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":235},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":246},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":257},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":266},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":281},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":286},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":291},"Microsoft.Synapse/workspaces/auditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":302},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":313},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":326},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":333},"Microsoft.Synapse/workspaces/encryptionProtector@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":343},"Microsoft.Synapse/workspaces@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":369},"Microsoft.Synapse/workspaces/administrators@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":375},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":380},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":396},"Microsoft.Synapse/workspaces/kustoPools@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":464},"Microsoft.Synapse/workspaces/kustoPools/databases@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":480},"Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":576},"Microsoft.Synapse/workspaces/kustoPools/principalAssignments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":596},"Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":620},"Microsoft.Synapse/workspaces/bigDataPools@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":43},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":112},"Microsoft.Synapse/workspaces/keys@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":117},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":124},"Microsoft.Synapse/privateLinkHubs@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":132},"Microsoft.Synapse/workspaces/sqlPools@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":148},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":154},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":164},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":190},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":201},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":213},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":222},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":235},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":246},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":257},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":266},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":281},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":286},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":291},"Microsoft.Synapse/workspaces/auditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":302},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":313},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":326},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":333},"Microsoft.Synapse/workspaces/encryptionProtector@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":343},"Microsoft.Synapse/workspaces@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":374},"Microsoft.Synapse/workspaces/administrators@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":380},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":385},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":401},"Microsoft.Synapse/workspaces/bigDataPools@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":36},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":106},"Microsoft.Synapse/workspaces/kustoPools@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":157},"Microsoft.Synapse/workspaces/kustoPools/attachedDatabaseConfigurations@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":182},"Microsoft.Synapse/workspaces/kustoPools/databases@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":213},"Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":309},"Microsoft.Synapse/workspaces/kustoPools/principalAssignments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":329},"Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":353},"Microsoft.Synapse/workspaces/firewallRules@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":364},"Microsoft.Synapse/workspaces/keys@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":369},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":376},"Microsoft.Synapse/privateLinkHubs@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":384},"Microsoft.Synapse/workspaces/sqlPools@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":399},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":405},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":415},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":431},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":441},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":452},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":464},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":473},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":486},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":497},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":508},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":517},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":532},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":537},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":542},"Microsoft.Synapse/workspaces/auditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":553},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":564},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":577},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":584},"Microsoft.Synapse/workspaces/encryptionProtector@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":594},"Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":601},"Microsoft.Synapse/workspaces@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":633},"Microsoft.Synapse/workspaces/administrators@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":639},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":644},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":660},"Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":671},"Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":18},"Microsoft.Synapse/workspaces/firewallRules@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":29},"Microsoft.Synapse/workspaces/keys@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":34},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":41},"Microsoft.Synapse/privateLinkHubs@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":49},"Microsoft.Synapse/workspaces/sqlPools@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":64},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":70},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":80},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":96},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":106},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":116},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":128},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":137},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":150},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":161},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":171},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":195},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":200},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":205},"Microsoft.Synapse/workspaces/auditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":216},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":227},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":240},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":247},"Microsoft.Synapse/workspaces/encryptionProtector@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":257},"Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":264},"Microsoft.Synapse/workspaces@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":296},"Microsoft.Synapse/workspaces/administrators@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":302},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":307},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":323},"Microsoft.Synapse/workspaces/bigDataPools@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":352},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":423},"Microsoft.TestBase/testBaseAccounts@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":37},"Microsoft.TestBase/testBaseAccounts/packages@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":92},"Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":97},"Microsoft.TestBase/testBaseAccounts/customerEvents@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":110},"Microsoft.TimeSeriesInsights/environments@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":28},"Microsoft.TimeSeriesInsights/environments/eventSources@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":62},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":81},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":89},"Microsoft.TimeSeriesInsights/environments@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":40},"Microsoft.TimeSeriesInsights/environments/eventSources@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":74},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":96},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":104},"Microsoft.TimeSeriesInsights/environments@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":64},"Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":91},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":113},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":121},"Microsoft.TimeSeriesInsights/environments@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":57},"Microsoft.TimeSeriesInsights/environments/eventSources@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":84},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":106},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":114},"Microsoft.Network/trafficmanagerprofiles@2015-11-01":{"RelativePath":"trafficmanager/microsoft.network/2015-11-01/types.json","Index":18},"Microsoft.Network/trafficmanagerprofiles@2017-03-01":{"RelativePath":"trafficmanager/microsoft.network/2017-03-01/types.json","Index":19},"Microsoft.Network/trafficmanagerprofiles@2017-05-01":{"RelativePath":"trafficmanager/microsoft.network/2017-05-01/types.json","Index":47},"Microsoft.Network/trafficmanagerprofiles@2018-02-01":{"RelativePath":"trafficmanager/microsoft.network/2018-02-01/types.json","Index":50},"Microsoft.Network/trafficmanagerprofiles@2018-03-01":{"RelativePath":"trafficmanager/microsoft.network/2018-03-01/types.json","Index":56},"Microsoft.Network/trafficmanagerprofiles@2018-04-01":{"RelativePath":"trafficmanager/microsoft.network/2018-04-01/types.json","Index":60},"Microsoft.Network/trafficManagerUserMetricsKeys@2018-04-01":{"RelativePath":"trafficmanager/microsoft.network/2018-04-01/types.json","Index":66},"Microsoft.Network/trafficmanagerprofiles/AzureEndpoints@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":27},"Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":31},"Microsoft.Network/trafficmanagerprofiles/NestedEndpoints@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":35},"Microsoft.Network/trafficmanagerprofiles@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":78},"Microsoft.Network/trafficManagerUserMetricsKeys@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":84},"Microsoft.VideoIndexer/accounts@2021-10-18-preview":{"RelativePath":"vi/microsoft.videoindexer/2021-10-18-preview/types.json","Index":40},"Microsoft.VideoIndexer/accounts@2021-10-27-preview":{"RelativePath":"vi/microsoft.videoindexer/2021-10-27-preview/types.json","Index":40},"Microsoft.VideoIndexer/accounts@2021-11-10-preview":{"RelativePath":"vi/microsoft.videoindexer/2021-11-10-preview/types.json","Index":40},"Microsoft.Media/videoAnalyzers@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":39},"Microsoft.Media/videoAnalyzers/edgeModules@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":44},"Microsoft.Media/videoAnalyzers/videos@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":54},"Microsoft.Media/videoAnalyzers/accessPolicies@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":82},"Microsoft.Media/videoAnalyzers/edgeModules@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":23},"Microsoft.Media/videoAnalyzers/pipelineTopologies@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":107},"Microsoft.Media/videoAnalyzers/livePipelines@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":119},"Microsoft.Media/videoAnalyzers/pipelineJobs@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":131},"Microsoft.Media/videoAnalyzers@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":180},"Microsoft.Media/videoAnalyzers/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":184},"Microsoft.Media/videoAnalyzers/videos@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":197},"Microsoft.Media/videoAnalyzers/accessPolicies@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":225},"microsoft.visualstudio/account@2014-04-01-preview":{"RelativePath":"visualstudio/microsoft.visualstudio/2014-04-01-preview/types.json","Index":18},"microsoft.visualstudio/account/extension@2014-04-01-preview":{"RelativePath":"visualstudio/microsoft.visualstudio/2014-04-01-preview/types.json","Index":25},"microsoft.visualstudio/account/project@2014-04-01-preview":{"RelativePath":"visualstudio/microsoft.visualstudio/2014-04-01-preview/types.json","Index":31},"Microsoft.AVS/privateClouds@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":40},"Microsoft.AVS/privateClouds/clusters@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":52},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":62},"Microsoft.AVS/privateClouds/authorizations@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":71},"Microsoft.AVS/privateClouds@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":40},"Microsoft.AVS/privateClouds/clusters@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":52},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":62},"Microsoft.AVS/privateClouds/authorizations@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":71},"Microsoft.AVS/privateClouds/globalReachConnections@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":84},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":101},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":118},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":133},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":147},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":168},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":181},"Microsoft.AVS/privateClouds/addons@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":195},"Microsoft.AVS/privateClouds@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":40},"Microsoft.AVS/privateClouds/clusters@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":52},"Microsoft.AVS/privateClouds/clusters/datastores@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":66},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":76},"Microsoft.AVS/privateClouds/authorizations@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":85},"Microsoft.AVS/privateClouds/globalReachConnections@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":98},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":115},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":132},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":147},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":161},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":182},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":195},"Microsoft.AVS/privateClouds/addons@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":210},"Microsoft.AVS/privateClouds@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":41},"Microsoft.AVS/privateClouds/clusters@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":53},"Microsoft.AVS/privateClouds/clusters/datastores@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":71},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":81},"Microsoft.AVS/privateClouds/authorizations@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":90},"Microsoft.AVS/privateClouds/globalReachConnections@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":103},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":120},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":137},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":152},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":166},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":187},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":200},"Microsoft.AVS/privateClouds/workloadNetworks/publicIPs@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":211},"Microsoft.AVS/privateClouds/cloudLinks@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":222},"Microsoft.AVS/privateClouds/addons@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":240},"Microsoft.AVS/privateClouds/scriptExecutions@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":267},"Microsoft.AVS/privateClouds@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":60},"Microsoft.AVS/privateClouds/clusters@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":72},"Microsoft.AVS/privateClouds/clusters/datastores@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":98},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":108},"Microsoft.AVS/privateClouds/authorizations@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":117},"Microsoft.AVS/privateClouds/globalReachConnections@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":130},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":148},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":165},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":183},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":198},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":219},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":232},"Microsoft.AVS/privateClouds/workloadNetworks/publicIPs@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":243},"Microsoft.AVS/privateClouds/cloudLinks@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":254},"Microsoft.AVS/privateClouds/addons@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":272},"Microsoft.AVS/privateClouds/clusters/placementPolicies@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":299},"Microsoft.AVS/privateClouds/scriptExecutions@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":326},"Microsoft.VMwareCloudSimple/dedicatedCloudNodes@2019-04-01":{"RelativePath":"vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.json","Index":18},"Microsoft.VMwareCloudSimple/dedicatedCloudServices@2019-04-01":{"RelativePath":"vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.json","Index":29},"Microsoft.VMwareCloudSimple/virtualMachines@2019-04-01":{"RelativePath":"vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.json","Index":77},"Microsoft.CertificateRegistration/certificateOrders/certificates@2015-08-01":{"RelativePath":"web/microsoft.certificateregistration/2015-08-01/types.json","Index":24},"Microsoft.CertificateRegistration/certificateOrders@2015-08-01":{"RelativePath":"web/microsoft.certificateregistration/2015-08-01/types.json","Index":56},"Microsoft.CertificateRegistration/certificateOrders@2018-02-01":{"RelativePath":"web/microsoft.certificateregistration/2018-02-01/types.json","Index":53},"Microsoft.CertificateRegistration/certificateOrders/certificates@2018-02-01":{"RelativePath":"web/microsoft.certificateregistration/2018-02-01/types.json","Index":58},"Microsoft.CertificateRegistration/certificateOrders@2019-08-01":{"RelativePath":"web/microsoft.certificateregistration/2019-08-01/types.json","Index":53},"Microsoft.CertificateRegistration/certificateOrders/certificates@2019-08-01":{"RelativePath":"web/microsoft.certificateregistration/2019-08-01/types.json","Index":58},"Microsoft.CertificateRegistration/certificateOrders@2020-06-01":{"RelativePath":"web/microsoft.certificateregistration/2020-06-01/types.json","Index":53},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-06-01":{"RelativePath":"web/microsoft.certificateregistration/2020-06-01/types.json","Index":58},"Microsoft.CertificateRegistration/certificateOrders@2020-09-01":{"RelativePath":"web/microsoft.certificateregistration/2020-09-01/types.json","Index":64},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-09-01":{"RelativePath":"web/microsoft.certificateregistration/2020-09-01/types.json","Index":69},"Microsoft.CertificateRegistration/certificateOrders@2020-10-01":{"RelativePath":"web/microsoft.certificateregistration/2020-10-01/types.json","Index":64},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-10-01":{"RelativePath":"web/microsoft.certificateregistration/2020-10-01/types.json","Index":69},"Microsoft.CertificateRegistration/certificateOrders@2020-12-01":{"RelativePath":"web/microsoft.certificateregistration/2020-12-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-12-01":{"RelativePath":"web/microsoft.certificateregistration/2020-12-01/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-01-01":{"RelativePath":"web/microsoft.certificateregistration/2021-01-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-01":{"RelativePath":"web/microsoft.certificateregistration/2021-01-01/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-01-15":{"RelativePath":"web/microsoft.certificateregistration/2021-01-15/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-15":{"RelativePath":"web/microsoft.certificateregistration/2021-01-15/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-02-01":{"RelativePath":"web/microsoft.certificateregistration/2021-02-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-02-01":{"RelativePath":"web/microsoft.certificateregistration/2021-02-01/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-03-01":{"RelativePath":"web/microsoft.certificateregistration/2021-03-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-03-01":{"RelativePath":"web/microsoft.certificateregistration/2021-03-01/types.json","Index":59},"Microsoft.DomainRegistration/domains@2015-04-01":{"RelativePath":"web/microsoft.domainregistration/2015-04-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2015-04-01":{"RelativePath":"web/microsoft.domainregistration/2015-04-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2015-08-01":{"RelativePath":"web/microsoft.domainregistration/2015-08-01/types.json","Index":63},"Microsoft.DomainRegistration/domains@2018-02-01":{"RelativePath":"web/microsoft.domainregistration/2018-02-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2018-02-01":{"RelativePath":"web/microsoft.domainregistration/2018-02-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2019-08-01":{"RelativePath":"web/microsoft.domainregistration/2019-08-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2019-08-01":{"RelativePath":"web/microsoft.domainregistration/2019-08-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2020-06-01":{"RelativePath":"web/microsoft.domainregistration/2020-06-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-06-01":{"RelativePath":"web/microsoft.domainregistration/2020-06-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2020-09-01":{"RelativePath":"web/microsoft.domainregistration/2020-09-01/types.json","Index":80},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-09-01":{"RelativePath":"web/microsoft.domainregistration/2020-09-01/types.json","Index":85},"Microsoft.DomainRegistration/domains@2020-10-01":{"RelativePath":"web/microsoft.domainregistration/2020-10-01/types.json","Index":80},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-10-01":{"RelativePath":"web/microsoft.domainregistration/2020-10-01/types.json","Index":85},"Microsoft.DomainRegistration/domains@2020-12-01":{"RelativePath":"web/microsoft.domainregistration/2020-12-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-12-01":{"RelativePath":"web/microsoft.domainregistration/2020-12-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-01-01":{"RelativePath":"web/microsoft.domainregistration/2021-01-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-01":{"RelativePath":"web/microsoft.domainregistration/2021-01-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-01-15":{"RelativePath":"web/microsoft.domainregistration/2021-01-15/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-15":{"RelativePath":"web/microsoft.domainregistration/2021-01-15/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-02-01":{"RelativePath":"web/microsoft.domainregistration/2021-02-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-02-01":{"RelativePath":"web/microsoft.domainregistration/2021-02-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-03-01":{"RelativePath":"web/microsoft.domainregistration/2021-03-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-03-01":{"RelativePath":"web/microsoft.domainregistration/2021-03-01/types.json","Index":74},"Microsoft.Web/connections@2015-08-01-preview":{"RelativePath":"web/microsoft.web/2015-08-01-preview/types.json","Index":71},"Microsoft.Web/certificates@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":15},"Microsoft.Web/csrs@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":21},"Microsoft.Web/hostingEnvironments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":73},"Microsoft.Web/hostingEnvironments/multiRolePools@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":79},"Microsoft.Web/hostingEnvironments/workerPools@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":84},"Microsoft.Web/managedHostingEnvironments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":89},"Microsoft.Web/sourcecontrols@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":95},"Microsoft.Web/publishingUsers@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":102},"Microsoft.Web/serverfarms@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":111},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":117},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":123},"Microsoft.Web/sites/slots/virtualNetworkConnections@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":132},"Microsoft.Web/sites/virtualNetworkConnections@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":137},"Microsoft.Web/sites/config@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":290},"Microsoft.Web/sites@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":316},"Microsoft.Web/sites/slots@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":321},"Microsoft.Web/sites/instances/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":327},"Microsoft.Web/sites/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":332},"Microsoft.Web/sites/slots/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":337},"Microsoft.Web/sites/slots/instances/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":342},"Microsoft.Web/sites/hostNameBindings@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":357},"Microsoft.Web/sites/slots/hostNameBindings@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":362},"Microsoft.Web/sites/slots/config@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":416},"Microsoft.Web/sites/sourcecontrols@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":423},"Microsoft.Web/sites/slots/sourcecontrols@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":429},"Microsoft.Web/sites/premieraddons@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":435},"Microsoft.Web/sites/slots/premieraddons@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":440},"Microsoft.Web/sites/backups@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":452},"Microsoft.Web/sites/slots/backups@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":458},"Microsoft.Web/sites/hybridconnection@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":464},"Microsoft.Web/sites/slots/hybridconnection@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":469},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":474},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":479},"Microsoft.Web/certificates@2016-03-01":{"RelativePath":"web/microsoft.web/2016-03-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2016-03-01":{"RelativePath":"web/microsoft.web/2016-03-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2016-03-01":{"RelativePath":"web/microsoft.web/2016-03-01/types.json","Index":38},"Microsoft.Web/connectionGateways@2016-06-01":{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":15},"Microsoft.Web/customApis@2016-06-01":{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":52},"Microsoft.Web/connections@2016-06-01":{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":69},"Microsoft.Web/sites@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":116},"Microsoft.Web/sites/backups@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":134},"Microsoft.Web/sites/config@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":245},"Microsoft.Web/sites/deployments@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":250},"Microsoft.Web/sites/domainOwnershipIdentifiers@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":255},"Microsoft.Web/sites/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":268},"Microsoft.Web/sites/functions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":274},"Microsoft.Web/sites/hostNameBindings@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":292},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":297},"Microsoft.Web/sites/hybridconnection@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":302},"Microsoft.Web/sites/instances/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":307},"Microsoft.Web/sites/premieraddons@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":314},"Microsoft.Web/sites/publicCertificates@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":323},"Microsoft.Web/sites/siteextensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":332},"Microsoft.Web/sites/slots@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":337},"Microsoft.Web/sites/slots/backups@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":342},"Microsoft.Web/sites/slots/config@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":379},"Microsoft.Web/sites/slots/deployments@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":383},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":387},"Microsoft.Web/sites/slots/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":392},"Microsoft.Web/sites/slots/functions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":396},"Microsoft.Web/sites/slots/hostNameBindings@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":400},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":404},"Microsoft.Web/sites/slots/hybridconnection@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":408},"Microsoft.Web/sites/slots/instances/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":413},"Microsoft.Web/sites/slots/premieraddons@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":418},"Microsoft.Web/sites/slots/publicCertificates@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":422},"Microsoft.Web/sites/slots/siteextensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":426},"Microsoft.Web/sites/slots/sourcecontrols@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":432},"Microsoft.Web/sites/slots/virtualNetworkConnections@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":444},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":449},"Microsoft.Web/sites/sourcecontrols@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":454},"Microsoft.Web/sites/virtualNetworkConnections@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":458},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":462},"Microsoft.Web/hostingEnvironments@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":60},"Microsoft.Web/hostingEnvironments/multiRolePools@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":70},"Microsoft.Web/hostingEnvironments/workerPools@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":74},"Microsoft.Web/serverfarms@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":91},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":96},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":105},"Microsoft.Web/publishingUsers@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":13},"Microsoft.Web/sourcecontrols@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":18},"Microsoft.Web/hostingEnvironments@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":71},"Microsoft.Web/hostingEnvironments/multiRolePools@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":81},"Microsoft.Web/hostingEnvironments/workerPools@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":85},"Microsoft.Web/serverfarms@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":102},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":107},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":116},"Microsoft.Web/sites@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":251},"Microsoft.Web/sites/config@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":369},"Microsoft.Web/sites/deployments@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":374},"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":379},"Microsoft.Web/sites/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":392},"Microsoft.Web/sites/functions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":398},"Microsoft.Web/sites/functions/keys@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":402},"Microsoft.Web/sites/hostNameBindings@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":420},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":425},"Microsoft.Web/sites/hybridconnection@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":430},"Microsoft.Web/sites/instances/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":435},"Microsoft.Web/sites/networkConfig@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":441},"Microsoft.Web/sites/premieraddons@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":447},"Microsoft.Web/sites/privateAccess@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":457},"Microsoft.Web/sites/publicCertificates@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":466},"Microsoft.Web/sites/siteextensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":475},"Microsoft.Web/sites/slots@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":480},"Microsoft.Web/sites/slots/config@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":522},"Microsoft.Web/sites/slots/deployments@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":526},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":530},"Microsoft.Web/sites/slots/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":535},"Microsoft.Web/sites/slots/functions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":539},"Microsoft.Web/sites/slots/functions/keys@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":543},"Microsoft.Web/sites/slots/hostNameBindings@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":547},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":551},"Microsoft.Web/sites/slots/hybridconnection@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":555},"Microsoft.Web/sites/slots/instances/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":560},"Microsoft.Web/sites/slots/networkConfig@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":565},"Microsoft.Web/sites/slots/premieraddons@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":570},"Microsoft.Web/sites/slots/privateAccess@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":575},"Microsoft.Web/sites/slots/publicCertificates@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":579},"Microsoft.Web/sites/slots/siteextensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":583},"Microsoft.Web/sites/slots/sourcecontrols@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":589},"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":596},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":600},"Microsoft.Web/sites/sourcecontrols@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":605},"Microsoft.Web/sites/virtualNetworkConnections@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":609},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":613},"Microsoft.Web/certificates@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":632},"Microsoft.Web/certificates@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":27},"Microsoft.Web/sites@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":163},"Microsoft.Web/sites/config@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":281},"Microsoft.Web/sites/deployments@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":286},"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":291},"Microsoft.Web/sites/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":304},"Microsoft.Web/sites/functions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":310},"Microsoft.Web/sites/hostNameBindings@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":328},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":333},"Microsoft.Web/sites/hybridconnection@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":338},"Microsoft.Web/sites/instances/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":343},"Microsoft.Web/sites/networkConfig@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":349},"Microsoft.Web/sites/premieraddons@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":355},"Microsoft.Web/sites/privateAccess@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":365},"Microsoft.Web/sites/publicCertificates@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":374},"Microsoft.Web/sites/siteextensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":383},"Microsoft.Web/sites/slots@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":388},"Microsoft.Web/sites/slots/config@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":430},"Microsoft.Web/sites/slots/deployments@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":434},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":438},"Microsoft.Web/sites/slots/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":443},"Microsoft.Web/sites/slots/functions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":447},"Microsoft.Web/sites/slots/hostNameBindings@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":451},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":455},"Microsoft.Web/sites/slots/hybridconnection@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":459},"Microsoft.Web/sites/slots/instances/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":464},"Microsoft.Web/sites/slots/networkConfig@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":469},"Microsoft.Web/sites/slots/premieraddons@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":474},"Microsoft.Web/sites/slots/privateAccess@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":479},"Microsoft.Web/sites/slots/publicCertificates@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":483},"Microsoft.Web/sites/slots/siteextensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":487},"Microsoft.Web/sites/slots/sourcecontrols@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":493},"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":505},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":510},"Microsoft.Web/sites/sourcecontrols@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":515},"Microsoft.Web/sites/virtualNetworkConnections@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":519},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":523},"Microsoft.Web/certificates@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":38},"Microsoft.Web/sites@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":165},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":176},"Microsoft.Web/sites/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":302},"Microsoft.Web/sites/deployments@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":307},"Microsoft.Web/sites/domainOwnershipIdentifiers@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":312},"Microsoft.Web/sites/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":325},"Microsoft.Web/sites/functions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":331},"Microsoft.Web/sites/functions/keys@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":335},"Microsoft.Web/sites/hostNameBindings@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":353},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":358},"Microsoft.Web/sites/hybridconnection@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":363},"Microsoft.Web/sites/instances/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":368},"Microsoft.Web/sites/networkConfig@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":374},"Microsoft.Web/sites/premieraddons@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":380},"Microsoft.Web/sites/privateAccess@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":390},"Microsoft.Web/sites/publicCertificates@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":399},"Microsoft.Web/sites/siteextensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":408},"Microsoft.Web/sites/slots@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":413},"Microsoft.Web/sites/slots/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":455},"Microsoft.Web/sites/slots/deployments@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":459},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":463},"Microsoft.Web/sites/slots/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":468},"Microsoft.Web/sites/slots/functions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":472},"Microsoft.Web/sites/slots/functions/keys@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":476},"Microsoft.Web/sites/slots/hostNameBindings@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":480},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":484},"Microsoft.Web/sites/slots/hybridconnection@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":488},"Microsoft.Web/sites/slots/instances/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":493},"Microsoft.Web/sites/slots/networkConfig@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":498},"Microsoft.Web/sites/slots/premieraddons@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":503},"Microsoft.Web/sites/slots/privateAccess@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":508},"Microsoft.Web/sites/privateEndpointConnections@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":515},"Microsoft.Web/sites/slots/publicCertificates@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":519},"Microsoft.Web/sites/slots/siteextensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":523},"Microsoft.Web/sites/slots/sourcecontrols@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":529},"Microsoft.Web/sites/slots/virtualNetworkConnections@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":541},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":546},"Microsoft.Web/sites/sourcecontrols@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":551},"Microsoft.Web/sites/virtualNetworkConnections@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":555},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":559},"Microsoft.Web/staticSites@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":572},"Microsoft.Web/staticSites/builds/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":578},"Microsoft.Web/staticSites/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":584},"Microsoft.Web/staticSites/customDomains@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":588},"Microsoft.Web/hostingEnvironments@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":641},"Microsoft.Web/hostingEnvironments/multiRolePools@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":646},"Microsoft.Web/hostingEnvironments/workerPools@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":650},"Microsoft.Web/serverfarms@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":666},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":670},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":674},"Microsoft.Web/certificates@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":38},"Microsoft.Web/sites@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":175},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":186},"Microsoft.Web/sites/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":406},"Microsoft.Web/sites/deployments@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":411},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":416},"Microsoft.Web/sites/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":429},"Microsoft.Web/sites/functions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":435},"Microsoft.Web/sites/functions/keys@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":439},"Microsoft.Web/sites/hostNameBindings@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":457},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":462},"Microsoft.Web/sites/hybridconnection@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":467},"Microsoft.Web/sites/instances/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":472},"Microsoft.Web/sites/networkConfig@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":478},"Microsoft.Web/sites/premieraddons@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":484},"Microsoft.Web/sites/privateAccess@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":494},"Microsoft.Web/sites/publicCertificates@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":503},"Microsoft.Web/sites/siteextensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":512},"Microsoft.Web/sites/slots@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":517},"Microsoft.Web/sites/slots/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":563},"Microsoft.Web/sites/slots/deployments@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":567},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":571},"Microsoft.Web/sites/slots/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":576},"Microsoft.Web/sites/slots/functions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":580},"Microsoft.Web/sites/slots/functions/keys@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":584},"Microsoft.Web/sites/slots/hostNameBindings@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":588},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":592},"Microsoft.Web/sites/slots/hybridconnection@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":596},"Microsoft.Web/sites/slots/instances/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":601},"Microsoft.Web/sites/slots/networkConfig@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":606},"Microsoft.Web/sites/slots/premieraddons@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":611},"Microsoft.Web/sites/slots/privateAccess@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":616},"Microsoft.Web/sites/privateEndpointConnections@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":623},"Microsoft.Web/sites/slots/publicCertificates@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":627},"Microsoft.Web/sites/slots/siteextensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":631},"Microsoft.Web/sites/slots/sourcecontrols@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":637},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":649},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":654},"Microsoft.Web/sites/sourcecontrols@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":659},"Microsoft.Web/sites/virtualNetworkConnections@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":663},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":667},"Microsoft.Web/staticSites@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":680},"Microsoft.Web/staticSites/builds/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":686},"Microsoft.Web/staticSites/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":692},"Microsoft.Web/staticSites/customDomains@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":696},"Microsoft.Web/hostingEnvironments@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":750},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":755},"Microsoft.Web/hostingEnvironments/workerPools@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":759},"Microsoft.Web/serverfarms@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":775},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":779},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":783},"Microsoft.Web/certificates@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":38},"Microsoft.Web/publishingUsers@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":44},"Microsoft.Web/sourcecontrols@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":49},"Microsoft.Web/sites@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":186},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":197},"Microsoft.Web/sites/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":417},"Microsoft.Web/sites/deployments@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":422},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":427},"Microsoft.Web/sites/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":440},"Microsoft.Web/sites/functions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":446},"Microsoft.Web/sites/functions/keys@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":450},"Microsoft.Web/sites/hostNameBindings@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":468},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":473},"Microsoft.Web/sites/hybridconnection@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":478},"Microsoft.Web/sites/instances/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":483},"Microsoft.Web/sites/networkConfig@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":489},"Microsoft.Web/sites/premieraddons@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":495},"Microsoft.Web/sites/privateAccess@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":505},"Microsoft.Web/sites/publicCertificates@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":514},"Microsoft.Web/sites/siteextensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":523},"Microsoft.Web/sites/slots@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":528},"Microsoft.Web/sites/slots/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":574},"Microsoft.Web/sites/slots/deployments@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":578},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":582},"Microsoft.Web/sites/slots/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":587},"Microsoft.Web/sites/slots/functions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":591},"Microsoft.Web/sites/slots/functions/keys@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":595},"Microsoft.Web/sites/slots/hostNameBindings@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":599},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":603},"Microsoft.Web/sites/slots/hybridconnection@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":607},"Microsoft.Web/sites/slots/instances/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":612},"Microsoft.Web/sites/slots/networkConfig@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":617},"Microsoft.Web/sites/slots/premieraddons@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":622},"Microsoft.Web/sites/slots/privateAccess@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":627},"Microsoft.Web/sites/privateEndpointConnections@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":634},"Microsoft.Web/sites/slots/publicCertificates@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":638},"Microsoft.Web/sites/slots/siteextensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":642},"Microsoft.Web/sites/slots/sourcecontrols@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":648},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":660},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":665},"Microsoft.Web/sites/sourcecontrols@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":670},"Microsoft.Web/sites/virtualNetworkConnections@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":674},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":678},"Microsoft.Web/staticSites@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":691},"Microsoft.Web/staticSites/builds/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":697},"Microsoft.Web/staticSites/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":703},"Microsoft.Web/staticSites/customDomains@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":707},"Microsoft.Web/hostingEnvironments@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":761},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":766},"Microsoft.Web/hostingEnvironments/workerPools@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":770},"Microsoft.Web/serverfarms@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":786},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":790},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":794},"Microsoft.Web/certificates@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":38},"Microsoft.Web/publishingUsers@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":44},"Microsoft.Web/sourcecontrols@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":49},"Microsoft.Web/sites@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":186},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":197},"Microsoft.Web/sites/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":417},"Microsoft.Web/sites/deployments@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":422},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":427},"Microsoft.Web/sites/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":440},"Microsoft.Web/sites/functions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":446},"Microsoft.Web/sites/functions/keys@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":450},"Microsoft.Web/sites/hostNameBindings@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":468},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":473},"Microsoft.Web/sites/hybridconnection@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":478},"Microsoft.Web/sites/instances/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":483},"Microsoft.Web/sites/networkConfig@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":489},"Microsoft.Web/sites/premieraddons@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":495},"Microsoft.Web/sites/privateAccess@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":505},"Microsoft.Web/sites/publicCertificates@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":514},"Microsoft.Web/sites/siteextensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":523},"Microsoft.Web/sites/slots@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":528},"Microsoft.Web/sites/slots/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":574},"Microsoft.Web/sites/slots/deployments@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":578},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":582},"Microsoft.Web/sites/slots/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":587},"Microsoft.Web/sites/slots/functions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":591},"Microsoft.Web/sites/slots/functions/keys@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":595},"Microsoft.Web/sites/slots/hostNameBindings@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":599},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":603},"Microsoft.Web/sites/slots/hybridconnection@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":607},"Microsoft.Web/sites/slots/instances/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":612},"Microsoft.Web/sites/slots/networkConfig@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":617},"Microsoft.Web/sites/slots/premieraddons@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":622},"Microsoft.Web/sites/slots/privateAccess@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":627},"Microsoft.Web/sites/privateEndpointConnections@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":634},"Microsoft.Web/sites/slots/publicCertificates@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":638},"Microsoft.Web/sites/slots/siteextensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":642},"Microsoft.Web/sites/slots/sourcecontrols@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":648},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":660},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":665},"Microsoft.Web/sites/sourcecontrols@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":670},"Microsoft.Web/sites/virtualNetworkConnections@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":674},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":678},"Microsoft.Web/staticSites@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":691},"Microsoft.Web/staticSites/builds/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":697},"Microsoft.Web/staticSites/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":703},"Microsoft.Web/staticSites/customDomains@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":707},"Microsoft.Web/hostingEnvironments@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":761},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":766},"Microsoft.Web/hostingEnvironments/workerPools@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":770},"Microsoft.Web/serverfarms@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":786},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":790},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":794},"Microsoft.Web/certificates@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":38},"Microsoft.Web/sites@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":190},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":201},"Microsoft.Web/sites/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":386},"Microsoft.Web/sites/deployments@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":391},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":396},"Microsoft.Web/sites/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":409},"Microsoft.Web/sites/functions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":415},"Microsoft.Web/sites/functions/keys@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":419},"Microsoft.Web/sites/hostNameBindings@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":437},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":442},"Microsoft.Web/sites/hybridconnection@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":447},"Microsoft.Web/sites/instances/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":452},"Microsoft.Web/sites/networkConfig@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":458},"Microsoft.Web/sites/premieraddons@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":464},"Microsoft.Web/sites/privateAccess@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":474},"Microsoft.Web/sites/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":482},"Microsoft.Web/sites/publicCertificates@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":491},"Microsoft.Web/sites/siteextensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":500},"Microsoft.Web/sites/slots@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":505},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":515},"Microsoft.Web/sites/slots/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":561},"Microsoft.Web/sites/slots/deployments@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":565},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":569},"Microsoft.Web/sites/slots/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":574},"Microsoft.Web/sites/slots/functions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":578},"Microsoft.Web/sites/slots/functions/keys@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":582},"Microsoft.Web/sites/slots/hostNameBindings@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":586},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":590},"Microsoft.Web/sites/slots/hybridconnection@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":594},"Microsoft.Web/sites/slots/instances/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":599},"Microsoft.Web/sites/slots/premieraddons@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":604},"Microsoft.Web/sites/slots/privateAccess@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":609},"Microsoft.Web/sites/slots/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":613},"Microsoft.Web/sites/slots/publicCertificates@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":617},"Microsoft.Web/sites/slots/siteextensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":621},"Microsoft.Web/sites/slots/sourcecontrols@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":630},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":642},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":647},"Microsoft.Web/sites/sourcecontrols@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":652},"Microsoft.Web/sites/virtualNetworkConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":656},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":660},"Microsoft.Web/staticSites@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":691},"Microsoft.Web/staticSites/builds/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":703},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":708},"Microsoft.Web/staticSites/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":720},"Microsoft.Web/staticSites/customDomains@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":732},"Microsoft.Web/staticSites/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":736},"Microsoft.Web/staticSites/userProvidedFunctionApps@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":740},"Microsoft.Web/hostingEnvironments@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":765},"Microsoft.Web/hostingEnvironments/configurations@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":773},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":784},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":788},"Microsoft.Web/hostingEnvironments/workerPools@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":792},"Microsoft.Web/serverfarms@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":809},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":813},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":817},"Microsoft.Web/hostingEnvironments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":41},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":57},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":65},"Microsoft.Web/hostingEnvironments/workerPools@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":69},"Microsoft.Web/serverfarms@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":88},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":93},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":102},"Microsoft.Web/certificates@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":121},"Microsoft.Web/publishingUsers@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":127},"Microsoft.Web/sourcecontrols@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":132},"Microsoft.Web/staticSites@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":166},"Microsoft.Web/staticSites/builds/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":178},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":183},"Microsoft.Web/staticSites/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":195},"Microsoft.Web/staticSites/customDomains@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":207},"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":211},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":215},"Microsoft.Web/sites@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":358},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":369},"Microsoft.Web/sites/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":554},"Microsoft.Web/sites/deployments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":559},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":564},"Microsoft.Web/sites/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":577},"Microsoft.Web/sites/functions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":583},"Microsoft.Web/sites/functions/keys@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":587},"Microsoft.Web/sites/hostNameBindings@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":605},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":610},"Microsoft.Web/sites/hybridconnection@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":615},"Microsoft.Web/sites/instances/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":620},"Microsoft.Web/sites/networkConfig@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":626},"Microsoft.Web/sites/premieraddons@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":632},"Microsoft.Web/sites/privateAccess@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":642},"Microsoft.Web/sites/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":646},"Microsoft.Web/sites/publicCertificates@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":655},"Microsoft.Web/sites/siteextensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":664},"Microsoft.Web/sites/slots@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":669},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":679},"Microsoft.Web/sites/slots/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":725},"Microsoft.Web/sites/slots/deployments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":729},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":733},"Microsoft.Web/sites/slots/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":738},"Microsoft.Web/sites/slots/functions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":742},"Microsoft.Web/sites/slots/functions/keys@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":746},"Microsoft.Web/sites/slots/hostNameBindings@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":750},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":754},"Microsoft.Web/sites/slots/hybridconnection@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":758},"Microsoft.Web/sites/slots/instances/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":763},"Microsoft.Web/sites/slots/premieraddons@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":768},"Microsoft.Web/sites/slots/privateAccess@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":773},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":777},"Microsoft.Web/sites/slots/publicCertificates@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":781},"Microsoft.Web/sites/slots/siteextensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":785},"Microsoft.Web/sites/slots/sourcecontrols@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":794},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":801},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":805},"Microsoft.Web/sites/sourcecontrols@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":810},"Microsoft.Web/sites/virtualNetworkConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":814},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":818},"Microsoft.Web/kubeEnvironments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":845},"Microsoft.Web/hostingEnvironments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":41},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":57},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":65},"Microsoft.Web/hostingEnvironments/workerPools@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":69},"Microsoft.Web/serverfarms@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":88},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":93},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":102},"Microsoft.Web/certificates@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":121},"Microsoft.Web/kubeEnvironments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":148},"Microsoft.Web/publishingUsers@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":154},"Microsoft.Web/sourcecontrols@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":159},"Microsoft.Web/staticSites@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":193},"Microsoft.Web/staticSites/builds/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":205},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":210},"Microsoft.Web/staticSites/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":222},"Microsoft.Web/staticSites/customDomains@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":234},"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":238},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":242},"Microsoft.Web/sites@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":385},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":396},"Microsoft.Web/sites/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":581},"Microsoft.Web/sites/deployments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":586},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":591},"Microsoft.Web/sites/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":604},"Microsoft.Web/sites/functions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":610},"Microsoft.Web/sites/functions/keys@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":614},"Microsoft.Web/sites/hostNameBindings@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":632},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":637},"Microsoft.Web/sites/hybridconnection@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":642},"Microsoft.Web/sites/instances/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":647},"Microsoft.Web/sites/networkConfig@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":653},"Microsoft.Web/sites/premieraddons@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":659},"Microsoft.Web/sites/privateAccess@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":669},"Microsoft.Web/sites/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":673},"Microsoft.Web/sites/publicCertificates@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":682},"Microsoft.Web/sites/siteextensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":691},"Microsoft.Web/sites/slots@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":696},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":706},"Microsoft.Web/sites/slots/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":752},"Microsoft.Web/sites/slots/deployments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":756},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":760},"Microsoft.Web/sites/slots/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":765},"Microsoft.Web/sites/slots/functions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":769},"Microsoft.Web/sites/slots/functions/keys@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":773},"Microsoft.Web/sites/slots/hostNameBindings@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":777},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":781},"Microsoft.Web/sites/slots/hybridconnection@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":785},"Microsoft.Web/sites/slots/instances/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":790},"Microsoft.Web/sites/slots/networkConfig@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":795},"Microsoft.Web/sites/slots/premieraddons@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":800},"Microsoft.Web/sites/slots/privateAccess@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":805},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":809},"Microsoft.Web/sites/slots/publicCertificates@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":813},"Microsoft.Web/sites/slots/siteextensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":817},"Microsoft.Web/sites/slots/sourcecontrols@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":826},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":833},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":837},"Microsoft.Web/sites/sourcecontrols@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":842},"Microsoft.Web/sites/virtualNetworkConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":846},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":850},"Microsoft.Web/hostingEnvironments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":43},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":59},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":67},"Microsoft.Web/hostingEnvironments/workerPools@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":71},"Microsoft.Web/serverfarms@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":90},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":95},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":104},"Microsoft.Web/certificates@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":123},"Microsoft.Web/kubeEnvironments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":150},"Microsoft.Web/publishingUsers@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":156},"Microsoft.Web/sourcecontrols@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":161},"Microsoft.Web/staticSites@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":196},"Microsoft.Web/staticSites/builds/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":208},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":213},"Microsoft.Web/staticSites/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":225},"Microsoft.Web/staticSites/customDomains@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":237},"Microsoft.Web/staticSites/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":241},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":245},"Microsoft.Web/sites@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":388},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":399},"Microsoft.Web/sites/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":589},"Microsoft.Web/sites/deployments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":594},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":599},"Microsoft.Web/sites/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":612},"Microsoft.Web/sites/functions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":618},"Microsoft.Web/sites/functions/keys@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":622},"Microsoft.Web/sites/hostNameBindings@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":640},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":645},"Microsoft.Web/sites/hybridconnection@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":650},"Microsoft.Web/sites/instances/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":655},"Microsoft.Web/sites/networkConfig@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":661},"Microsoft.Web/sites/premieraddons@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":667},"Microsoft.Web/sites/privateAccess@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":677},"Microsoft.Web/sites/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":681},"Microsoft.Web/sites/publicCertificates@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":690},"Microsoft.Web/sites/siteextensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":699},"Microsoft.Web/sites/slots@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":704},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":714},"Microsoft.Web/sites/slots/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":760},"Microsoft.Web/sites/slots/deployments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":764},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":768},"Microsoft.Web/sites/slots/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":773},"Microsoft.Web/sites/slots/functions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":777},"Microsoft.Web/sites/slots/functions/keys@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":781},"Microsoft.Web/sites/slots/hostNameBindings@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":785},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":789},"Microsoft.Web/sites/slots/hybridconnection@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":793},"Microsoft.Web/sites/slots/instances/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":798},"Microsoft.Web/sites/slots/networkConfig@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":803},"Microsoft.Web/sites/slots/premieraddons@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":808},"Microsoft.Web/sites/slots/privateAccess@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":813},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":817},"Microsoft.Web/sites/slots/publicCertificates@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":821},"Microsoft.Web/sites/slots/siteextensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":825},"Microsoft.Web/sites/slots/sourcecontrols@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":834},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":841},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":845},"Microsoft.Web/sites/sourcecontrols@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":850},"Microsoft.Web/sites/virtualNetworkConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":854},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":858},"Microsoft.Web/hostingEnvironments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":43},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":59},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":67},"Microsoft.Web/hostingEnvironments/workerPools@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":71},"Microsoft.Web/serverfarms@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":90},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":95},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":104},"Microsoft.Web/certificates@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":123},"Microsoft.Web/containerApps@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":174},"Microsoft.Web/kubeEnvironments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":202},"Microsoft.Web/publishingUsers@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":208},"Microsoft.Web/sourcecontrols@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":213},"Microsoft.Web/staticSites@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":253},"Microsoft.Web/staticSites/builds/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":265},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":270},"Microsoft.Web/staticSites/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":282},"Microsoft.Web/staticSites/customDomains@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":294},"Microsoft.Web/staticSites/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":298},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":302},"Microsoft.Web/sites@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":445},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":456},"Microsoft.Web/sites/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":646},"Microsoft.Web/sites/deployments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":651},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":656},"Microsoft.Web/sites/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":674},"Microsoft.Web/sites/functions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":680},"Microsoft.Web/sites/functions/keys@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":684},"Microsoft.Web/sites/hostNameBindings@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":702},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":707},"Microsoft.Web/sites/hybridconnection@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":712},"Microsoft.Web/sites/instances/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":717},"Microsoft.Web/sites/networkConfig@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":723},"Microsoft.Web/sites/premieraddons@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":729},"Microsoft.Web/sites/privateAccess@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":739},"Microsoft.Web/sites/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":743},"Microsoft.Web/sites/publicCertificates@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":752},"Microsoft.Web/sites/siteextensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":761},"Microsoft.Web/sites/slots@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":766},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":776},"Microsoft.Web/sites/slots/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":822},"Microsoft.Web/sites/slots/deployments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":826},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":830},"Microsoft.Web/sites/slots/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":835},"Microsoft.Web/sites/slots/functions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":839},"Microsoft.Web/sites/slots/functions/keys@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":843},"Microsoft.Web/sites/slots/hostNameBindings@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":847},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":851},"Microsoft.Web/sites/slots/hybridconnection@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":855},"Microsoft.Web/sites/slots/instances/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":860},"Microsoft.Web/sites/slots/networkConfig@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":865},"Microsoft.Web/sites/slots/premieraddons@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":870},"Microsoft.Web/sites/slots/privateAccess@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":875},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":879},"Microsoft.Web/sites/slots/publicCertificates@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":883},"Microsoft.Web/sites/slots/siteextensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":887},"Microsoft.Web/sites/slots/sourcecontrols@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":896},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":903},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":907},"Microsoft.Web/sites/sourcecontrols@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":912},"Microsoft.Web/sites/virtualNetworkConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":916},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":920},"Microsoft.SignalRService/webPubSub@2021-04-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":134},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":138},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-04-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":142},"Microsoft.SignalRService/webPubSub@2021-06-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":128},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":132},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-06-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":136},"Microsoft.SignalRService/webPubSub@2021-09-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":130},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-09-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":134},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-09-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":138},"Microsoft.SignalRService/webPubSub@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":125},"Microsoft.SignalRService/webPubSub/hubs@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":138},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":142},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":146},"Microsoft.WindowsESU/multipleActivationKeys@2019-09-16-preview":{"RelativePath":"windowsesu/microsoft.windowsesu/2019-09-16-preview/types.json","Index":26},"Microsoft.WindowsIoT/deviceServices@2018-02-16-preview":{"RelativePath":"windowsiot/microsoft.windowsiot/2018-02-16-preview/types.json","Index":13},"Microsoft.WindowsIoT/deviceServices@2019-06-01":{"RelativePath":"windowsiot/microsoft.windowsiot/2019-06-01/types.json","Index":13},"Microsoft.WorkloadMonitor/notificationSettings@2018-08-31-preview":{"RelativePath":"workloadmonitor/microsoft.workloadmonitor/2018-08-31-preview/types.json","Index":15}},"Functions":{"microsoft.addons/supportproviders":{"2018-03-01":[{"RelativePath":"addons/microsoft.addons/2018-03-01/types.json","Index":35}]},"microsoft.analysisservices/servers":{"2017-07-14":[{"RelativePath":"analysisservices/microsoft.analysisservices/2017-07-14/types.json","Index":50}],"2017-08-01":[{"RelativePath":"analysisservices/microsoft.analysisservices/2017-08-01/types.json","Index":56}]},"microsoft.apimanagement/service/authorizationservers":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":491}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":502}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":542}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":542}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":558}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":616}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":616}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":642}]},"microsoft.apimanagement/service/gateways":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":493}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":504}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":544}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":544}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":560}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":618}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":618}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":644}]},"microsoft.apimanagement/service/identityproviders":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":494}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":505}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":546}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":546}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":562}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":620}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":620}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":646}]},"microsoft.apimanagement/service/openidconnectproviders":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":495}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":508}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":549}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":549}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":565}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":623}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":623}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":649}]},"microsoft.apimanagement/service/portalsettings":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":497}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":510}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":551}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":551}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":567}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":625}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":625}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":655}]},"microsoft.apimanagement/service/namedvalues":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":499}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":507}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":548}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":548}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":564}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":622}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":622}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":648}]},"microsoft.apimanagement/service/subscriptions":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":501}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":512}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":553}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":553}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":569}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":627}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":627}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":657}]},"microsoft.apimanagement/service/tenant":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":503}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":514}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":555}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":555}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":571}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":629}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":629}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":659}]},"microsoft.apimanagement/service/policyfragments":{"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":653}]},"microsoft.app/containerapps":{"2022-01-01-preview":[{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":244},{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":248}],"2022-03-01":[{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":244},{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":248}]},"microsoft.app/managedenvironments/daprcomponents":{"2022-03-01":[{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":251}]},"microsoft.appconfiguration/configurationstores":{"2019-02-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.json","Index":24},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.json","Index":28}],"2019-10-01":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-10-01/types.json","Index":33},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-10-01/types.json","Index":37}],"2019-11-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":62},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":66}],"2020-06-01":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":62},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":66}],"2020-07-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":68}],"2021-03-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":79}],"2021-10-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":82}]},"microsoft.appplatform/spring":{"2020-07-01":[{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":133}],"2020-11-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":134}],"2021-06-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":140}],"2021-09-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":176}],"2022-01-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":334}],"2022-03-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":336}]},"microsoft.automation/automationaccounts":{"2015-10-31":[{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":240}],"2019-06-01":[{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":341}],"2020-01-13-preview":[{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":235}],"2021-06-22":[{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":80}]},"microsoft.kusto/clusters/databases":{"2018-09-07-preview":[{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":79}],"2019-01-21":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":109}],"2019-05-15":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":134}],"2019-09-07":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":178}],"2019-11-09":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":229}],"2020-02-15":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":245}],"2020-06-14":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":254}],"2020-09-18":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":281}],"2021-01-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":314}],"2021-08-27":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":343}],"2022-02-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":376}]},"microsoft.kusto/clusters":{"2019-09-07":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":163}],"2019-11-09":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":214}],"2020-02-15":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":229},{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":230}],"2020-06-14":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":238},{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":239}],"2020-09-18":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":265},{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":266}],"2021-01-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":298},{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":299}],"2021-08-27":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":327},{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":328}],"2022-02-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":360},{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":361}]},"microsoft.azurestack/registrations/products":{"2016-01-01":[{"RelativePath":"azurestack/microsoft.azurestack/2016-01-01/types.json","Index":34}],"2017-06-01":[{"RelativePath":"azurestack/microsoft.azurestack/2017-06-01/types.json","Index":39}],"2020-06-01-preview":[{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":58}]},"microsoft.batch/batchaccounts":{"2015-12-01":[{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":41}],"2017-01-01":[{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":45}],"2017-05-01":[{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":45}],"2017-09-01":[{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":167}],"2018-12-01":[{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":167}],"2019-04-01":[{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":169}],"2019-08-01":[{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":180}],"2020-03-01":[{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":212}],"2020-05-01":[{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":216}],"2020-09-01":[{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":216}],"2021-01-01":[{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":232}],"2021-06-01":[{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":243}],"2022-01-01":[{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":246}]},"microsoft.billing/billingaccounts":{"2019-10-01-preview":[{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":111}],"2020-05-01":[{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":101}]},"microsoft.blockchain/blockchainmembers":{"2018-06-01-preview":[{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":45}]},"microsoft.blockchain/locations":{"2018-06-01-preview":[{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":54}]},"microsoft.blockchain/blockchainmembers/transactionnodes":{"2018-06-01-preview":[{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":55}]},"microsoft.botservice/botservices/channels":{"2017-12-01":[{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":107}],"2018-07-12":[{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":143}],"2020-06-02":[{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":122}],"2021-03-01":[{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":143}],"2021-05-01-preview":[{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":162}]},"microsoft.botservice/botservices/connections":{"2017-12-01":[{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":115}],"2018-07-12":[{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":151}],"2020-06-02":[{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":130}],"2021-03-01":[{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":153}],"2021-05-01-preview":[{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":172}]},"microsoft.cognitiveservices/accounts":{"2016-02-01-preview":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.json","Index":49}],"2017-04-18":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.json","Index":72}],"2021-04-30":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.json","Index":99}],"2021-10-01":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":126}],"2022-03-01":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":126}]},"microsoft.communication/communicationservices":{"2020-08-20-preview":[{"RelativePath":"communication/microsoft.communication/2020-08-20-preview/types.json","Index":25}],"2020-08-20":[{"RelativePath":"communication/microsoft.communication/2020-08-20/types.json","Index":36}]},"microsoft.containerregistry/registries":{"2017-03-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-03-01/types.json","Index":27}],"2017-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":72}],"2017-10-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":89}],"2018-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":91}],"2019-04-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":105}],"2019-05-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":104}],"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":197}],"2019-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":228}],"2020-11-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":320}],"2021-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":324}],"2021-08-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":327}],"2021-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":164}],"2021-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":327}]},"microsoft.containerregistry/registries/webhooks":{"2017-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":85}],"2017-10-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":102}],"2019-05-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":117}],"2019-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":241}],"2020-11-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":333}],"2021-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":337}],"2021-08-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":340}],"2021-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":177}],"2021-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":340}]},"microsoft.containerregistry/registries/buildtasks/steps":{"2018-02-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":66}]},"microsoft.containerregistry/registries/buildtasks":{"2018-02-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":67}]},"microsoft.containerregistry/registries/runs":{"2018-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":93}],"2019-04-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":107}],"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":199}]},"microsoft.containerregistry/registries/tasks":{"2018-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":96}],"2019-04-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":110}],"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":204}]},"microsoft.containerregistry/registries/agentpools":{"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":195}]},"microsoft.containerregistry/registries/taskruns":{"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":201}]},"microsoft.containerservice/managedclusters/accessprofiles":{"2017-08-31":[{"RelativePath":"containerservice/microsoft.containerservice/2017-08-31/types.json","Index":207}],"2018-03-31":[{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":215}],"2018-08-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":215}],"2019-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":405}],"2019-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":413}],"2019-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":427}],"2019-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":436}],"2019-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":436}],"2019-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":446}],"2020-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":446}],"2020-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":452}],"2020-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":465}],"2020-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":464}],"2020-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":484}],"2020-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":487}],"2020-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":501}],"2020-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":527}],"2020-12-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":561}],"2021-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":563}],"2021-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":240}],"2021-05-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":240}],"2021-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":252}],"2021-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":270}],"2021-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":277}],"2021-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":283}],"2021-11-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":284}],"2022-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":283}],"2022-01-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":285}],"2022-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":283}],"2022-02-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":311}],"2022-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":283}],"2022-03-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":315}]},"microsoft.containerservice/managedclusters":{"2018-03-31":[{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":219},{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":220}],"2018-08-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":219},{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":220}],"2019-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":409},{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":410}],"2019-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":417},{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":418}],"2019-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":431},{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":432}],"2019-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":440},{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":441}],"2019-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":440},{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":441},{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":442}],"2019-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":450},{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":451},{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":452}],"2020-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":450},{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":451},{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":452}],"2020-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":456},{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":457},{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":458}],"2020-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":469},{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":470},{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":471}],"2020-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":468},{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":469},{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":470}],"2020-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":488},{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":489},{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":490}],"2020-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":491},{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":492},{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":493}],"2020-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":505},{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":506},{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":507}],"2020-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":531},{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":532},{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":533}],"2020-12-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":565},{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":566},{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":567}],"2021-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":567},{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":568},{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":569}],"2021-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":244},{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":245},{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":246}],"2021-05-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":244},{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":245},{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":246}],"2021-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":256},{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":257},{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":258}],"2021-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":274},{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":275},{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":276}],"2021-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":281},{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":282},{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":283}],"2021-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":289}],"2021-11-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":289},{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":290}],"2022-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":289}],"2022-01-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":289},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":290},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":291}],"2022-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":289}],"2022-02-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":315},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":316},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":317}],"2022-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":289}],"2022-03-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":319},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":320},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":321}]},"microsoft.documentdb/databaseaccounts":{"2015-04-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":193}],"2015-04-08":[{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":193}],"2015-11-06":[{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":193}],"2016-03-19":[{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":193}],"2016-03-31":[{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":193}],"2019-08-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":269},{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":273}],"2019-12-12":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":261},{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":265}],"2020-03-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":269},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":273}],"2020-04-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":278},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":282}],"2020-06-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":335},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":339}],"2020-09-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":284},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":288}],"2021-01-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":302},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":306}],"2021-03-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":381},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":385}],"2021-03-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":302},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":306}],"2021-04-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":397},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":401}],"2021-04-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":320},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":324}],"2021-05-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":324},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":328}],"2021-06-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":353},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":357}],"2021-07-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":434},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":438}],"2021-10-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":480},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":484}],"2021-10-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":399},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":403}],"2021-11-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":486},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":490}],"2022-02-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":494},{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":498}]},"microsoft.documentdb/databaseaccounts/notebookworkspaces":{"2019-08-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":275}],"2019-12-12":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":267}],"2020-03-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":275}],"2020-04-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":284}],"2020-06-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":341}],"2020-09-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":290}],"2021-01-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":308}],"2021-03-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":387}],"2021-03-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":308}],"2021-04-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":403}],"2021-04-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":326}],"2021-05-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":330}],"2021-06-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":359}],"2021-07-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":440}],"2021-10-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":486}],"2021-10-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":405}],"2021-11-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":492}],"2022-02-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":500}]},"microsoft.databox/jobs":{"2018-01-01":[{"RelativePath":"databox/microsoft.databox/2018-01-01/types.json","Index":151}],"2019-09-01":[{"RelativePath":"databox/microsoft.databox/2019-09-01/types.json","Index":177}],"2020-04-01":[{"RelativePath":"databox/microsoft.databox/2020-04-01/types.json","Index":224}],"2020-11-01":[{"RelativePath":"databox/microsoft.databox/2020-11-01/types.json","Index":233}],"2021-03-01":[{"RelativePath":"databox/microsoft.databox/2021-03-01/types.json","Index":243}],"2021-05-01":[{"RelativePath":"databox/microsoft.databox/2021-05-01/types.json","Index":246}],"2021-08-01-preview":[{"RelativePath":"databox/microsoft.databox/2021-08-01-preview/types.json","Index":369}],"2021-12-01":[{"RelativePath":"databox/microsoft.databox/2021-12-01/types.json","Index":409}],"2022-02-01":[{"RelativePath":"databox/microsoft.databox/2022-02-01/types.json","Index":424}]},"microsoft.databoxedge/databoxedgedevices/orders":{"2020-09-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":406}],"2020-09-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":406}],"2020-12-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":406}],"2021-02-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":410}],"2021-02-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":441}],"2021-06-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":441}],"2021-06-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":441}],"2022-03-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":445}],"2022-04-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":467}]},"microsoft.datadog/monitors":{"2020-02-01-preview":[{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":94},{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":103},{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":107},{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":111}],"2021-03-01":[{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":105},{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":114},{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":118},{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":122}]},"microsoft.datafactory/factories/integrationruntimes":{"2017-09-01-preview":[{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":744}],"2018-06-01":[{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1761}]},"microsoft.datalakeanalytics/accounts/storageaccounts/containers":{"2015-10-01-preview":[{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":109}],"2016-11-01":[{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":111}],"2019-11-01-preview":[{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":111}]},"microsoft.datamigration/sqlmigrationservices":{"2021-10-30-preview":[{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1143},{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1148}],"2022-01-30-preview":[{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1169},{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1174}],"2022-03-30-preview":[{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1186},{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1191}]},"microsoft.datashare/accounts/shares":{"2018-11-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":307},{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":310}],"2019-11-01":[{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":307},{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":310}],"2020-09-01":[{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":334},{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":337}],"2020-10-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":370},{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":373}],"2021-08-01":[{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":363},{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":366}]},"microsoft.datashare/accounts/sharesubscriptions":{"2018-11-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":320},{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":325},{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":328}],"2019-11-01":[{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":320},{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":325},{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":328}],"2020-09-01":[{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":347},{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":352},{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":355}],"2020-10-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":383},{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":388},{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":391}],"2021-08-01":[{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":376},{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":381},{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":384}]},"microsoft.devices/provisioningservices":{"2017-08-21-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":52}],"2017-11-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":52}],"2018-01-22":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":52}],"2020-01-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":61}],"2020-03-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":78}],"2020-09-01-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":85}],"2021-10-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":89}],"2022-02-05":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":89}]},"microsoft.devices/provisioningservices/keys":{"2017-08-21-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":53}],"2017-11-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":53}],"2018-01-22":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":53}],"2020-01-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":62}],"2020-03-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":79}],"2020-09-01-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":86}],"2021-10-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":90}],"2022-02-05":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":90}]},"microsoft.devspaces/controllers":{"2019-04-01":[{"RelativePath":"devspaces/microsoft.devspaces/2019-04-01/types.json","Index":34}]},"microsoft.devtestlab/labs":{"2015-05-21-preview":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":133}],"2016-05-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":263}],"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":323}]},"microsoft.devtestlab/labs/schedules":{"2016-05-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":266}],"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":326}]},"microsoft.devtestlab/labs/virtualmachines":{"2016-05-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":267}],"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":328}]},"microsoft.devtestlab/labs/users/servicefabrics":{"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":327}]},"microsoft.network/virtualnetworks":{"2020-04-01-preview":[{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":114},{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":119}],"2021-02-01-preview":[{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":349},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":359}],"2021-05-01-preview":[{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":325},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":335}],"2022-02-01-preview":[{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":331},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":341}]},"microsoft.elastic/monitors":{"2020-07-01-preview":[{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":86}],"2020-07-01":[{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":86}],"2021-09-01-preview":[{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":86}],"2021-10-01-preview":[{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":86},{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":89}]},"microsoft.engagementfabric/accounts":{"2018-09-01-preview":[{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":27},{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":32}]},"microsoft.eventgrid/topics":{"2017-06-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2017-06-15-preview/types.json","Index":41}],"2017-09-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2017-09-15-preview/types.json","Index":44}],"2018-01-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-01-01/types.json","Index":44}],"2018-05-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-05-01-preview/types.json","Index":70}],"2018-09-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":122}],"2019-01-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-01-01/types.json","Index":56}],"2019-02-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":137}],"2019-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":119}],"2020-01-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":143}],"2020-04-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":285}],"2020-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":192}],"2020-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":324}],"2021-06-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":332}],"2021-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":440}],"2021-12-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":257}]},"microsoft.eventgrid/domains":{"2018-09-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":120}],"2019-02-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":135}],"2019-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":117}],"2020-01-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":141}],"2020-04-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":281}],"2020-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":190}],"2020-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":320}],"2021-06-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":328}],"2021-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":436}],"2021-12-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":255}]},"microsoft.eventgrid/partnernamespaces":{"2020-04-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":283}],"2020-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":322}],"2021-06-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":330}],"2021-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":438}]},"microsoft.eventhub/namespaces/authorizationrules":{"2015-08-01":[{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":72}],"2017-04-01":[{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":92}],"2018-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":139}],"2021-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":139}],"2021-06-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":151}],"2021-11-01":[{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":164}]},"microsoft.eventhub/namespaces/eventhubs/authorizationrules":{"2015-08-01":[{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":73}],"2017-04-01":[{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":94}],"2018-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":141}],"2021-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":140}],"2021-06-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":152}],"2021-11-01":[{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":165}]},"microsoft.eventhub/namespaces/disasterrecoveryconfigs/authorizationrules":{"2017-04-01":[{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":93}],"2018-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":140}],"2021-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":141}],"2021-06-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":153}],"2021-11-01":[{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":166}]},"microsoft.hdinsight/clusters":{"2015-03-01-preview":[{"RelativePath":"hdinsight/microsoft.hdinsight/2015-03-01-preview/types.json","Index":113}],"2018-06-01-preview":[{"RelativePath":"hdinsight/microsoft.hdinsight/2018-06-01-preview/types.json","Index":113}],"2021-06-01":[{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":170}]},"microsoft.hybridconnectivity/endpoints":{"2021-10-06-preview":[{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.json","Index":29}],"2022-05-01-preview":[{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.json","Index":29},{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.json","Index":32}]},"microsoft.kubernetes/connectedclusters":{"2020-01-01-preview":[{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.json","Index":40}],"2021-04-01-preview":[{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.json","Index":53}],"2021-10-01":[{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-10-01/types.json","Index":50}]},"microsoft.hybridnetwork/devices":{"2020-01-01-preview":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":200}],"2021-05-01":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":224}],"2022-01-01-preview":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":224}]},"microsoft.hybridnetwork/vendors/vendorskus":{"2022-01-01-preview":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":227}]},"microsoft.devices/iothubs":{"2016-02-03":[{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":72}],"2017-01-19":[{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":95}],"2017-07-01":[{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":102}],"2018-01-22":[{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":102}],"2018-04-01":[{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":108}],"2018-12-01-preview":[{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":112}],"2019-03-22-preview":[{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":115}],"2019-03-22":[{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":110}],"2019-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":117}],"2019-11-04":[{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":113}],"2020-03-01":[{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":145}],"2020-04-01":[{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":145}],"2020-06-15":[{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":145}],"2020-07-10-preview":[{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":156}],"2020-08-01":[{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":145}],"2020-08-31-preview":[{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":164}],"2020-08-31":[{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":153}],"2021-02-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":171}],"2021-03-03-preview":[{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":171}],"2021-03-31":[{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":164}],"2021-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":174}],"2021-07-01":[{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":165}],"2021-07-02-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":185}],"2021-07-02":[{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":176}]},"microsoft.devices/iothubs/iothubkeys":{"2016-02-03":[{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":73}],"2017-01-19":[{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":96}],"2017-07-01":[{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":103}],"2018-01-22":[{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":103}],"2018-04-01":[{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":109}],"2018-12-01-preview":[{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":113}],"2019-03-22-preview":[{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":116}],"2019-03-22":[{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":111}],"2019-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":118}],"2019-11-04":[{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":114}],"2020-03-01":[{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":146}],"2020-04-01":[{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":146}],"2020-06-15":[{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":146}],"2020-07-10-preview":[{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":157}],"2020-08-01":[{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":146}],"2020-08-31-preview":[{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":165}],"2020-08-31":[{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":154}],"2021-02-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":172}],"2021-03-03-preview":[{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":172}],"2021-03-31":[{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":165}],"2021-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":175}],"2021-07-01":[{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":166}],"2021-07-02-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":186}],"2021-07-02":[{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":177}]},"microsoft.labservices/users":{"2018-10-15":[{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":81},{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":85}]},"microsoft.logic/workflows/accesskeys":{"2015-02-01-preview":[{"RelativePath":"logic/microsoft.logic/2015-02-01-preview/types.json","Index":53}]},"microsoft.logic/integrationaccounts":{"2015-08-01-preview":[{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":245}],"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":416},{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":423}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":382},{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":389}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":555},{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":562}]},"microsoft.logic/workflows":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":401},{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":402}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":367},{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":368}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":540},{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":541}]},"microsoft.logic/workflows/versions/triggers":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":403}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":370}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":543}]},"microsoft.logic/workflows/triggers":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":404}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":369}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":542}]},"microsoft.logic/workflows/runs/actions":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":413}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":379}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":552}]},"microsoft.logic/workflows/runs/actions/repetitions":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":414}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":380}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":553}]},"microsoft.logic/integrationaccounts/assemblies":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":424}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":390}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":563}]},"microsoft.logic/integrationaccounts/schemas":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":425}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":391}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":564}]},"microsoft.logic/integrationaccounts/maps":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":426}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":392}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":565}]},"microsoft.logic/integrationaccounts/partners":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":427}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":393}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":566}]},"microsoft.logic/integrationaccounts/agreements":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":428}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":394}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":567}]},"microsoft.logz/monitors":{"2020-10-01-preview":[{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":104},{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":113},{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":117}],"2020-10-01":[{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":104},{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":113},{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":117}],"2022-01-01-preview":[{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":127},{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":136},{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":140}]},"microsoft.logz/monitors/accounts":{"2020-10-01-preview":[{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":118},{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":119}],"2020-10-01":[{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":118},{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":119}],"2022-01-01-preview":[{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":141},{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":142}]},"microsoft.machinelearning/workspaces":{"2016-04-01":[{"RelativePath":"machinelearning/microsoft.machinelearning/2016-04-01/types.json","Index":29}],"2019-10-01":[{"RelativePath":"machinelearning/microsoft.machinelearning/2019-10-01/types.json","Index":30}]},"microsoft.machinelearningcompute/operationalizationclusters":{"2017-06-01-preview":[{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.json","Index":96}],"2017-08-01-preview":[{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.json","Index":108}]},"microsoft.machinelearningservices/workspaces":{"2018-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":69}],"2018-11-19":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":86}],"2019-05-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":86}],"2019-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":90}],"2019-11-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":91}],"2020-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":113}],"2020-02-18-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":152}],"2020-03-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":133}],"2020-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":141}],"2020-05-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":295}],"2020-05-15-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":189}],"2020-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":171}],"2020-08-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":195}],"2020-09-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":307},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":309}],"2021-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":268},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":270},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":271},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":273}],"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":688},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":690},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":692},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":693}],"2021-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":273},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":275},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":276},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":278}],"2021-07-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":235},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":237},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":239},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":240}],"2022-01-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":241},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":243},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":245},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":246}]},"microsoft.machinelearningservices/workspaces/computes":{"2018-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":75}],"2018-11-19":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":98},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":106}],"2019-05-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":98},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":106}],"2019-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":109},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":117}],"2019-11-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":110},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":118}],"2020-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":132},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":140}],"2020-02-18-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":172},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":180}],"2020-03-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":152},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":160}],"2020-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":160},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":168}],"2020-05-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":314},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":322}],"2020-05-15-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":208},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":216}],"2020-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":191},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":199}],"2020-08-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":215},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":223}],"2020-09-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":329},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":337}],"2021-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":293},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":301}],"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":714},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":722}],"2021-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":299},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":307}],"2021-07-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":251},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":259}],"2022-01-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":257},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":265}]},"microsoft.machinelearningservices/workspaces/batchendpoints":{"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":723}]},"microsoft.machinelearningservices/workspaces/datastores":{"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":737}]},"microsoft.machinelearningservices/workspaces/onlineendpoints":{"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":738}]},"microsoft.maps/accounts":{"2017-01-01-preview":[{"RelativePath":"maps/microsoft.maps/2017-01-01-preview/types.json","Index":16}],"2018-05-01":[{"RelativePath":"maps/microsoft.maps/2018-05-01/types.json","Index":16}],"2020-02-01-preview":[{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":39}],"2021-02-01":[{"RelativePath":"maps/microsoft.maps/2021-02-01/types.json","Index":40}],"2021-07-01-preview":[{"RelativePath":"maps/microsoft.maps/2021-07-01-preview/types.json","Index":50}],"2021-12-01-preview":[{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":59},{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":61}]},"microsoft.marketplace/privatestores":{"2021-12-01":[{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":83},{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":91},{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":94}]},"microsoft.media/mediaservices":{"2015-10-01":[{"RelativePath":"mediaservices/microsoft.media/2015-10-01/types.json","Index":19}],"2020-05-01":[{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":562}],"2021-05-01":[{"RelativePath":"mediaservices/microsoft.media/2021-05-01/types.json","Index":68}],"2021-06-01":[{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":550}]},"microsoft.media/mediaservices/assets":{"2018-03-30-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":358}],"2018-06-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":364}],"2018-07-01":[{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":411},{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":415}],"2019-05-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":411},{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":415}],"2020-05-01":[{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":534},{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":538}],"2021-06-01":[{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":558},{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":562}],"2021-11-01":[{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":532},{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":536}]},"microsoft.media/mediaservices/streaminglocators":{"2018-03-30-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":367},{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":383}],"2018-06-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":367},{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":383}],"2018-07-01":[{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":418},{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":434}],"2019-05-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":418},{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":434}],"2020-05-01":[{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":541},{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":557}],"2021-06-01":[{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":565},{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":581}],"2021-11-01":[{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":539},{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":555}]},"microsoft.mixedreality/remoterenderingaccounts":{"2020-04-06-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2020-04-06-preview/types.json","Index":34}],"2021-01-01":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":40}],"2021-03-01-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":47}]},"microsoft.mixedreality/spatialanchorsaccounts":{"2020-05-01":[{"RelativePath":"mixedreality/microsoft.mixedreality/2020-05-01/types.json","Index":34}],"2021-01-01":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":39}],"2021-03-01-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":46}]},"microsoft.mixedreality/objectanchorsaccounts":{"2021-03-01-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":48}]},"microsoft.mobilenetwork/mobilenetworks":{"2022-01-01-preview":[{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":238}],"2022-03-01-preview":[{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":239}]},"microsoft.managedidentity/userassignedidentities":{"2021-09-30-preview":[{"RelativePath":"msi/microsoft.managedidentity/2021-09-30-preview/types.json","Index":17}]},"microsoft.network/networkmanagers":{"2021-02-01-preview":[{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":306},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":314},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":322},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":332},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":342}],"2021-05-01-preview":[{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":283},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":291},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":299},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":309},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":319}],"2022-02-01-preview":[{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":289},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":297},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":305},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":315},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":325}]},"microsoft.network/networkmanagers/networkgroups":{"2021-02-01-preview":[{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":344}],"2021-05-01-preview":[{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":336}],"2022-02-01-preview":[{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":342}]},"microsoft.network/firewallpolicies":{"2021-05-01":[{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2514},{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2518}],"2021-08-01":[{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2609},{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2613}]},"microsoft.notificationhubs/namespaces/authorizationrules":{"2014-09-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":51}],"2016-03-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":58}],"2017-04-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":58}]},"microsoft.notificationhubs/namespaces/notificationhubs/authorizationrules":{"2014-09-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":52}],"2016-03-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":59}],"2017-04-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":59}]},"microsoft.operationalinsights/workspaces":{"2015-03-20":[{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-03-20/types.json","Index":29}]},"microsoft.orbital/spacecrafts":{"2021-04-04-preview":[{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":84}],"2022-03-01":[{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":110}]},"microsoft.policyinsights/remediations":{"2018-07-01-preview":[{"RelativePath":"policyinsights/microsoft.policyinsights/2018-07-01-preview/types.json","Index":23}],"2019-07-01":[{"RelativePath":"policyinsights/microsoft.policyinsights/2019-07-01/types.json","Index":26}],"2021-10-01":[{"RelativePath":"policyinsights/microsoft.policyinsights/2021-10-01/types.json","Index":38}]},"microsoft.powerbi/workspacecollections":{"2016-01-29":[{"RelativePath":"powerbiembedded/microsoft.powerbi/2016-01-29/types.json","Index":19}]},"microsoft.purview/accounts":{"2020-12-01-preview":[{"RelativePath":"purview/microsoft.purview/2020-12-01-preview/types.json","Index":64}],"2021-07-01":[{"RelativePath":"purview/microsoft.purview/2021-07-01/types.json","Index":68}]},"microsoft.redhatopenshift/openshiftclusters":{"2020-04-30":[{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.json","Index":46}],"2021-09-01-preview":[{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.json","Index":106},{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.json","Index":108}],"2022-04-01":[{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.json","Index":58},{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.json","Index":60}]},"microsoft.cache/redis":{"2015-08-01":[{"RelativePath":"redis/microsoft.cache/2015-08-01/types.json","Index":25}],"2016-04-01":[{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":48}],"2017-02-01":[{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":59}],"2017-10-01":[{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":60}],"2018-03-01":[{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":77}],"2019-07-01":[{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":79}],"2020-06-01":[{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":100}],"2020-12-01":[{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":100}],"2021-06-01":[{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":108}]},"microsoft.cache/redisenterprise/databases":{"2020-10-01-preview":[{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":105}],"2021-02-01-preview":[{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":126}],"2021-03-01":[{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":117}],"2021-08-01":[{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":117}],"2022-01-01":[{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":126}]},"microsoft.relay/namespaces/authorizationrules":{"2016-07-01":[{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":51}],"2017-04-01":[{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":56}],"2021-11-01":[{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":100}]},"microsoft.relay/namespaces/hybridconnections/authorizationrules":{"2016-07-01":[{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":52}],"2017-04-01":[{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":57}],"2021-11-01":[{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":101}]},"microsoft.relay/namespaces/wcfrelays/authorizationrules":{"2016-07-01":[{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":53}],"2017-04-01":[{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":58}],"2021-11-01":[{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":102}]},"microsoft.resourceconnector/appliances":{"2021-10-31-preview":[{"RelativePath":"resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.json","Index":47}]},"microsoft.search/searchservices":{"2015-02-28":[{"RelativePath":"search/microsoft.search/2015-02-28/types.json","Index":20}],"2015-08-19":[{"RelativePath":"search/microsoft.search/2015-08-19/types.json","Index":42},{"RelativePath":"search/microsoft.search/2015-08-19/types.json","Index":46}],"2019-10-01-preview":[{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":62},{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":66}],"2020-03-13":[{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":62},{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":66}],"2020-08-01-preview":[{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":80},{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":84}],"2020-08-01":[{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":80},{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":84}],"2021-04-01-preview":[{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":108},{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":112}]},"microsoft.security/ingestionsettings":{"2021-01-15-preview":[{"RelativePath":"security/microsoft.security/2021-01-15-preview/types.json","Index":13},{"RelativePath":"security/microsoft.security/2021-01-15-preview/types.json","Index":17}]},"microsoft.servicebus/namespaces/authorizationrules":{"2015-08-01":[{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":120}],"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":136}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":173}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":181}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":185}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":185}]},"microsoft.servicebus/namespaces/queues/authorizationrules":{"2015-08-01":[{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":121}],"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":137}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":175}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":183}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":187}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":187}]},"microsoft.servicebus/namespaces/topics/authorizationrules":{"2015-08-01":[{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":122}],"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":138}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":176}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":184}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":188}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":188}]},"microsoft.servicebus/namespaces/disasterrecoveryconfigs/authorizationrules":{"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":139}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":174}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":182}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":186}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":186}]},"microsoft.servicefabric/clusters":{"2020-12-01-preview":[{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":204}],"2021-06-01":[{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":217}]},"microsoft.servicefabricmesh/secrets/values":{"2018-09-01-preview":[{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":188}]},"microsoft.servicelinker/linkers":{"2021-11-01-preview":[{"RelativePath":"servicelinker/microsoft.servicelinker/2021-11-01-preview/types.json","Index":54}],"2022-01-01-preview":[{"RelativePath":"servicelinker/microsoft.servicelinker/2022-01-01-preview/types.json","Index":71}],"2022-05-01":[{"RelativePath":"servicelinker/microsoft.servicelinker/2022-05-01/types.json","Index":71}]},"microsoft.signalrservice/signalr":{"2018-03-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2018-03-01-preview/types.json","Index":31}],"2018-10-01":[{"RelativePath":"signalr/microsoft.signalrservice/2018-10-01/types.json","Index":39}],"2020-05-01":[{"RelativePath":"signalr/microsoft.signalrservice/2020-05-01/types.json","Index":101}],"2020-07-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2020-07-01-preview/types.json","Index":110}],"2021-04-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":149}],"2021-06-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":149}],"2021-09-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":149}],"2021-10-01":[{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":153}],"2022-02-01":[{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":187}]},"microsoft.storage/storageaccounts":{"2015-05-01-preview":[{"RelativePath":"storage/microsoft.storage/2015-05-01-preview/types.json","Index":33}],"2015-06-15":[{"RelativePath":"storage/microsoft.storage/2015-06-15/types.json","Index":33}],"2016-01-01":[{"RelativePath":"storage/microsoft.storage/2016-01-01/types.json","Index":53}],"2016-05-01":[{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":53},{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":77},{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":97}],"2016-12-01":[{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":53},{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":77},{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":97}],"2017-06-01":[{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":90},{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":114},{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":134}],"2017-10-01":[{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":92},{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":116},{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":136}],"2018-02-01":[{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":134},{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":158},{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":178}],"2018-03-01-preview":[{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":141},{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":165},{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":185}],"2018-07-01":[{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":167},{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":191},{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":211}],"2018-11-01":[{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":188},{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":212},{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":232}],"2019-04-01":[{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":217},{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":241},{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":261}],"2019-06-01":[{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":330},{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":354},{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":374}],"2020-08-01-preview":[{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":338},{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":362},{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":382}],"2021-01-01":[{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":345},{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":369},{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":389}],"2021-02-01":[{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":350},{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":374},{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":394}],"2021-04-01":[{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":385},{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":409},{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":429}],"2021-06-01":[{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":389},{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":413},{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":433}],"2021-08-01":[{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":404},{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":428},{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":448}],"2021-09-01":[{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":427},{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":451},{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":471}]},"microsoft.storage/storageaccounts/localusers":{"2021-08-01":[{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":451}],"2021-09-01":[{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":474}]},"microsoft.importexport/jobs":{"2016-11-01":[{"RelativePath":"storageimportexport/microsoft.importexport/2016-11-01/types.json","Index":55}],"2020-08-01":[{"RelativePath":"storageimportexport/microsoft.importexport/2020-08-01/types.json","Index":55}],"2021-01-01":[{"RelativePath":"storageimportexport/microsoft.importexport/2021-01-01/types.json","Index":55}]},"microsoft.storsimple/managers":{"2017-06-01":[{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":166},{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":172}]},"microsoft.storsimple/managers/devices":{"2017-06-01":[{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":185},{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":217}]},"microsoft.streamanalytics/clusters":{"2020-03-01-preview":[{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.json","Index":46}],"2020-03-01":[{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":267}]},"microsoft.synapse/workspaces/integrationruntimes":{"2019-06-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":383}],"2020-12-01":[{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":395}],"2021-03-01":[{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":398}],"2021-04-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":622}],"2021-05-01":[{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":403}],"2021-06-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":673}],"2021-06-01":[{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":425}]},"microsoft.synapse/workspaces/kustopools":{"2021-06-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":674},{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":678}]},"microsoft.media/videoanalyzers/edgemodules":{"2021-05-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":85}],"2021-11-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":228}]},"microsoft.media/videoanalyzers/videos":{"2021-05-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":87}],"2021-11-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":230}]},"microsoft.avs/privateclouds":{"2020-03-20":[{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":73}],"2020-07-17-preview":[{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":197}],"2021-01-01-preview":[{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":212}],"2021-06-01":[{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":269}],"2021-12-01":[{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":328}]},"microsoft.domainregistration/topleveldomains":{"2015-04-01":[{"RelativePath":"web/microsoft.domainregistration/2015-04-01/types.json","Index":79}],"2015-08-01":[{"RelativePath":"web/microsoft.domainregistration/2015-08-01/types.json","Index":68}],"2018-02-01":[{"RelativePath":"web/microsoft.domainregistration/2018-02-01/types.json","Index":79}],"2019-08-01":[{"RelativePath":"web/microsoft.domainregistration/2019-08-01/types.json","Index":79}],"2020-06-01":[{"RelativePath":"web/microsoft.domainregistration/2020-06-01/types.json","Index":79}],"2020-09-01":[{"RelativePath":"web/microsoft.domainregistration/2020-09-01/types.json","Index":90}],"2020-10-01":[{"RelativePath":"web/microsoft.domainregistration/2020-10-01/types.json","Index":90}],"2020-12-01":[{"RelativePath":"web/microsoft.domainregistration/2020-12-01/types.json","Index":79}],"2021-01-01":[{"RelativePath":"web/microsoft.domainregistration/2021-01-01/types.json","Index":79}],"2021-01-15":[{"RelativePath":"web/microsoft.domainregistration/2021-01-15/types.json","Index":79}],"2021-02-01":[{"RelativePath":"web/microsoft.domainregistration/2021-02-01/types.json","Index":79}],"2021-03-01":[{"RelativePath":"web/microsoft.domainregistration/2021-03-01/types.json","Index":79}]},"microsoft.web/connections":{"2015-08-01-preview":[{"RelativePath":"web/microsoft.web/2015-08-01-preview/types.json","Index":88},{"RelativePath":"web/microsoft.web/2015-08-01-preview/types.json","Index":94}],"2016-06-01":[{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":83}]},"microsoft.web/sites/slots/config":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":483}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":490}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":666}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":551}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":707}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":815}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":826}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":826}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":849}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":893}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":898}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":906}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":972}]},"microsoft.web/sites/config":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":484}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":481}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":654}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":542}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":693}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":802}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":813}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":813}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":836}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":880}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":885}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":893}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":959}]},"microsoft.web/sites/slots/backups":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":502}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":489}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":665}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":550}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":706}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":814}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":825}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":825}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":848}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":892}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":897}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":905}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":971}]},"microsoft.web/sites/backups":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":503}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":478}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":651}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":539}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":690}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":799}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":810}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":810}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":833}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":879}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":884}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":892}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":958}]},"microsoft.web/locations":{"2016-06-01":[{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":72}]},"microsoft.web/sites/functions":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":484}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":655},{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":658}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":545}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":694},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":697}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":803},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":805}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":814},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":816}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":814},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":816}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":837},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":839}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":881},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":883}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":886},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":888}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":894},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":896}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":960},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":962}]},"microsoft.web/sites/hybridconnectionnamespaces/relays":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":487}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":663}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":548}]},"microsoft.web/sites":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":488}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":664}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":549}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":704},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":705}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":812},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":813}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":823},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":824}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":823},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":824}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":846},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":847}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":890},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":891}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":895},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":896}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":903},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":904}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":969},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":970}]},"microsoft.web/sites/slots/functions":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":491}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":667},{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":668}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":552}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":708},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":709}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":816},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":817}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":827},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":828}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":827},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":828}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":850},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":851}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":894},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":895}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":899},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":900}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":907},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":908}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":973},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":974}]},"microsoft.web/sites/slots/hybridconnectionnamespaces/relays":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":492}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":670}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":553}]},"microsoft.web/sites/slots":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":493}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":671}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":554}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":711},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":712}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":819},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":820}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":830},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":831}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":830},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":831}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":853},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":854}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":897},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":898}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":902},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":903}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":910},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":911}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":976},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":977}]},"microsoft.web/serverfarms/hybridconnectionnamespaces/relays":{"2016-09-01":[{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":108}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":635}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":723}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":831}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":842}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":842}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":870}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":848}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":853}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":861}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":923}]},"microsoft.web/sites/host":{"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":662}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":701}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":809}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":820}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":820}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":843}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":887}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":892}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":900}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":966}]},"microsoft.web/sites/slots/host":{"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":669}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":710}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":818}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":829}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":829}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":852}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":896}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":901}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":909}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":975}]},"microsoft.web/staticsites/authproviders":{"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":717}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":825}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":836}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":836}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":859}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":853}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":858}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":866}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":932}]},"microsoft.web/staticsites/builds":{"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":718}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":826}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":837}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":837}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":860},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":861}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":856},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":857}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":861},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":862}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":869},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":870}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":935},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":936}]},"microsoft.web/staticsites":{"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":719},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":720}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":827},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":828}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":838},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":839}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":838},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":839}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":862},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":865},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":866},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":867}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":858},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":861},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":862},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":863}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":863},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":866},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":867},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":868}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":871},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":874},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":875},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":876}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":937},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":940},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":941},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":942}]},"microsoft.web/containerapps":{"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":927}]},"microsoft.signalrservice/webpubsub":{"2021-04-01-preview":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":144}],"2021-06-01-preview":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":138}],"2021-09-01-preview":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":140}],"2021-10-01":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":148}]}}} \ No newline at end of file +{"Resources":{"Microsoft.Addons/supportProviders/supportPlanTypes@2017-05-15":{"RelativePath":"addons/microsoft.addons/2017-05-15/types.json","Index":24},"Microsoft.Addons/supportProviders/supportPlanTypes@2018-03-01":{"RelativePath":"addons/microsoft.addons/2018-03-01/types.json","Index":24},"Microsoft.AutonomousDevelopmentPlatform/accounts@2020-07-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.json","Index":31},"Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools@2020-07-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2020-07-01-preview/types.json","Index":45},"Microsoft.AutonomousDevelopmentPlatform/accounts@2021-02-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.json","Index":31},"Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools@2021-02-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-02-01-preview/types.json","Index":46},"Microsoft.AutonomousDevelopmentPlatform/accounts@2021-11-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.json","Index":31},"Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools@2021-11-01-preview":{"RelativePath":"adp/microsoft.autonomousdevelopmentplatform/2021-11-01-preview/types.json","Index":57},"Microsoft.Advisor/recommendations/suppressions@2016-07-12-preview":{"RelativePath":"advisor/microsoft.advisor/2016-07-12-preview/types.json","Index":12},"Microsoft.Advisor/recommendations/suppressions@2017-03-31":{"RelativePath":"advisor/microsoft.advisor/2017-03-31/types.json","Index":12},"Microsoft.Advisor/recommendations/suppressions@2017-04-19":{"RelativePath":"advisor/microsoft.advisor/2017-04-19/types.json","Index":12},"Microsoft.Advisor/configurations@2020-01-01":{"RelativePath":"advisor/microsoft.advisor/2020-01-01/types.json","Index":31},"Microsoft.Advisor/recommendations/suppressions@2020-01-01":{"RelativePath":"advisor/microsoft.advisor/2020-01-01/types.json","Index":36},"Microsoft.AgFoodPlatform/farmBeats/extensions@2020-05-12-preview":{"RelativePath":"agfood/microsoft.agfoodplatform/2020-05-12-preview/types.json","Index":23},"Microsoft.AgFoodPlatform/farmBeats@2020-05-12-preview":{"RelativePath":"agfood/microsoft.agfoodplatform/2020-05-12-preview/types.json","Index":32},"microsoft.alertsManagement/smartDetectorAlertRules@2019-03-01":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2019-03-01/types.json","Index":29},"Microsoft.AlertsManagement/actionRules@2019-05-05-preview":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2019-05-05-preview/types.json","Index":45},"microsoft.alertsManagement/smartDetectorAlertRules@2019-06-01":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2019-06-01/types.json","Index":30},"microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2021-04-01/types.json","Index":39},"Microsoft.AlertsManagement/actionRules@2021-08-08-preview":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2021-08-08-preview/types.json","Index":71},"Microsoft.AlertsManagement/actionRules@2021-08-08":{"RelativePath":"alertsmanagement/microsoft.alertsmanagement/2021-08-08/types.json","Index":71},"Microsoft.AnalysisServices/servers@2016-05-16":{"RelativePath":"analysisservices/microsoft.analysisservices/2016-05-16/types.json","Index":46},"Microsoft.AnalysisServices/servers@2017-07-14":{"RelativePath":"analysisservices/microsoft.analysisservices/2017-07-14/types.json","Index":47},"Microsoft.AnalysisServices/servers@2017-08-01":{"RelativePath":"analysisservices/microsoft.analysisservices/2017-08-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":25},"Microsoft.ApiManagement/service/apis/operations@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":40},"Microsoft.ApiManagement/service/subscriptions@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":51},"Microsoft.ApiManagement/service/products@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":58},"Microsoft.ApiManagement/service/products/apis@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":62},"Microsoft.ApiManagement/service/products/groups@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":66},"Microsoft.ApiManagement/service/groups@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":70},"Microsoft.ApiManagement/service/groups/users@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":74},"Microsoft.ApiManagement/service/certificates@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":78},"Microsoft.ApiManagement/service/users@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":87},"Microsoft.ApiManagement/service/authorizationServers@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":117},"Microsoft.ApiManagement/service/loggers@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":122},"Microsoft.ApiManagement/service/properties@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":127},"Microsoft.ApiManagement/service/openidConnectProviders@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":131},"Microsoft.ApiManagement/service/backends@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":135},"Microsoft.ApiManagement/service/identityProviders@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":146},"Microsoft.ApiManagement/service@2016-07-07":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-07-07/types.json","Index":179},"Microsoft.ApiManagement/service/apis@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":25},"Microsoft.ApiManagement/service/apis/operations@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":40},"Microsoft.ApiManagement/service/authorizationServers@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":70},"Microsoft.ApiManagement/service/backends@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":83},"Microsoft.ApiManagement/service/certificates@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":87},"Microsoft.ApiManagement/service@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":120},"Microsoft.ApiManagement/service/groups@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":124},"Microsoft.ApiManagement/service/groups/users@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":128},"Microsoft.ApiManagement/service/identityProviders@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":140},"Microsoft.ApiManagement/service/loggers@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":145},"Microsoft.ApiManagement/service/openidConnectProviders@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":149},"Microsoft.ApiManagement/service/products@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":156},"Microsoft.ApiManagement/service/products/apis@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":160},"Microsoft.ApiManagement/service/products/groups@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":164},"Microsoft.ApiManagement/service/properties@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":169},"Microsoft.ApiManagement/service/subscriptions@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":180},"Microsoft.ApiManagement/service/tenant@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":185},"Microsoft.ApiManagement/service/users@2016-10-10":{"RelativePath":"apimanagement/microsoft.apimanagement/2016-10-10/types.json","Index":194},"Microsoft.ApiManagement/service/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":14},"Microsoft.ApiManagement/service/apis@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":43},"Microsoft.ApiManagement/service/apis/releases@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":48},"Microsoft.ApiManagement/service/apis/operations@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":66},"Microsoft.ApiManagement/service/apis/operations/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":72},"Microsoft.ApiManagement/service/apis/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":78},"Microsoft.ApiManagement/service/apis/schemas@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":84},"Microsoft.ApiManagement/service/apis/diagnostics@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":89},"Microsoft.ApiManagement/service/apis/diagnostics/loggers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/issues@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":104},"Microsoft.ApiManagement/service/apis/issues/comments@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":109},"Microsoft.ApiManagement/service/apis/issues/attachments@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":114},"Microsoft.ApiManagement/service/authorizationServers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":145},"Microsoft.ApiManagement/service/backends@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":168},"Microsoft.ApiManagement/service/certificates@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":173},"Microsoft.ApiManagement/service@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":211},"Microsoft.ApiManagement/service/diagnostics@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":215},"Microsoft.ApiManagement/service/diagnostics/loggers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":219},"Microsoft.ApiManagement/service/templates@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":241},"Microsoft.ApiManagement/service/groups@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":250},"Microsoft.ApiManagement/service/groups/users@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":254},"Microsoft.ApiManagement/service/identityProviders@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":274},"Microsoft.ApiManagement/service/loggers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":288},"Microsoft.ApiManagement/service/notifications@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":304},"Microsoft.ApiManagement/service/notifications/recipientUsers@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":308},"Microsoft.ApiManagement/service/notifications/recipientEmails@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":312},"Microsoft.ApiManagement/service/openidConnectProviders@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":317},"Microsoft.ApiManagement/service/portalsettings@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":337},"Microsoft.ApiManagement/service/products@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":345},"Microsoft.ApiManagement/service/products/apis@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":349},"Microsoft.ApiManagement/service/products/groups@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":353},"Microsoft.ApiManagement/service/products/policies@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":359},"Microsoft.ApiManagement/service/properties@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":365},"Microsoft.ApiManagement/service/subscriptions@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":377},"Microsoft.ApiManagement/service/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":382},"Microsoft.ApiManagement/service/apis/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":386},"Microsoft.ApiManagement/service/apis/operations/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":390},"Microsoft.ApiManagement/service/products/tags@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":394},"Microsoft.ApiManagement/service/apis/tagDescriptions@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":399},"Microsoft.ApiManagement/service/users@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":421},"Microsoft.ApiManagement/service/api-version-sets@2017-03-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2017-03-01/types.json","Index":425},"Microsoft.ApiManagement/service/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":19},"Microsoft.ApiManagement/service/apis@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":55},"Microsoft.ApiManagement/service/apis/releases@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":60},"Microsoft.ApiManagement/service/apis/operations@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":78},"Microsoft.ApiManagement/service/apis/operations/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":84},"Microsoft.ApiManagement/service/apis/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":90},"Microsoft.ApiManagement/service/apis/schemas@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":96},"Microsoft.ApiManagement/service/apis/diagnostics@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":101},"Microsoft.ApiManagement/service/apis/diagnostics/loggers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/issues@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":116},"Microsoft.ApiManagement/service/apis/issues/comments@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":121},"Microsoft.ApiManagement/service/apis/issues/attachments@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":126},"Microsoft.ApiManagement/service/authorizationServers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":157},"Microsoft.ApiManagement/service/backends@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":180},"Microsoft.ApiManagement/service/certificates@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":185},"Microsoft.ApiManagement/service@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":225},"Microsoft.ApiManagement/service/diagnostics@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":229},"Microsoft.ApiManagement/service/diagnostics/loggers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":233},"Microsoft.ApiManagement/service/templates@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":255},"Microsoft.ApiManagement/service/groups@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":264},"Microsoft.ApiManagement/service/groups/users@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":268},"Microsoft.ApiManagement/service/identityProviders@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":288},"Microsoft.ApiManagement/service/loggers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":297},"Microsoft.ApiManagement/service/notifications@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":313},"Microsoft.ApiManagement/service/notifications/recipientUsers@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":317},"Microsoft.ApiManagement/service/notifications/recipientEmails@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":321},"Microsoft.ApiManagement/service/openidConnectProviders@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":326},"Microsoft.ApiManagement/service/portalsettings@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":346},"Microsoft.ApiManagement/service/products@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":354},"Microsoft.ApiManagement/service/products/apis@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":358},"Microsoft.ApiManagement/service/products/groups@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":362},"Microsoft.ApiManagement/service/products/policies@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":368},"Microsoft.ApiManagement/service/properties@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":374},"Microsoft.ApiManagement/service/subscriptions@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":386},"Microsoft.ApiManagement/service/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":391},"Microsoft.ApiManagement/service/apis/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":395},"Microsoft.ApiManagement/service/apis/operations/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":399},"Microsoft.ApiManagement/service/products/tags@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":403},"Microsoft.ApiManagement/service/apis/tagDescriptions@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":408},"Microsoft.ApiManagement/service/users@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":429},"Microsoft.ApiManagement/service/api-version-sets@2018-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-01-01/types.json","Index":438},"Microsoft.ApiManagement/service/apis@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":46},"Microsoft.ApiManagement/service/apis/releases@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":51},"Microsoft.ApiManagement/service/apis/operations@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":69},"Microsoft.ApiManagement/service/apis/operations/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":81},"Microsoft.ApiManagement/service/apis/operations/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":86},"Microsoft.ApiManagement/service/apis/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":90},"Microsoft.ApiManagement/service/products/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":94},"Microsoft.ApiManagement/service/tags@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":98},"Microsoft.ApiManagement/service/apis/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":104},"Microsoft.ApiManagement/service/apis/schemas@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":110},"Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":124},"Microsoft.ApiManagement/service/apis/issues@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":135},"Microsoft.ApiManagement/service/apis/issues/comments@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":140},"Microsoft.ApiManagement/service/apis/issues/attachments@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":145},"Microsoft.ApiManagement/service/apis/tagDescriptions@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":150},"Microsoft.ApiManagement/service/authorizationServers@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":181},"Microsoft.ApiManagement/service/backends@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":204},"Microsoft.ApiManagement/service/caches@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":209},"Microsoft.ApiManagement/service/certificates@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":214},"Microsoft.ApiManagement/service@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":255},"Microsoft.ApiManagement/service/diagnostics@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":259},"Microsoft.ApiManagement/service/templates@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":281},"Microsoft.ApiManagement/service/groups@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":290},"Microsoft.ApiManagement/service/groups/users@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":294},"Microsoft.ApiManagement/service/identityProviders@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":314},"Microsoft.ApiManagement/service/loggers@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":323},"Microsoft.ApiManagement/service/notifications@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":339},"Microsoft.ApiManagement/service/notifications/recipientUsers@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":343},"Microsoft.ApiManagement/service/notifications/recipientEmails@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":347},"Microsoft.ApiManagement/service/openidConnectProviders@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":352},"Microsoft.ApiManagement/service/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":358},"Microsoft.ApiManagement/service/portalsettings@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":378},"Microsoft.ApiManagement/service/products@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":386},"Microsoft.ApiManagement/service/products/apis@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":390},"Microsoft.ApiManagement/service/products/groups@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":394},"Microsoft.ApiManagement/service/products/policies@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":400},"Microsoft.ApiManagement/service/properties@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":406},"Microsoft.ApiManagement/service/subscriptions@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":418},"Microsoft.ApiManagement/service/users@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":439},"Microsoft.ApiManagement/service/api-version-sets@2018-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2018-06-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/apis@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":139},"Microsoft.ApiManagement/service/apis/issues@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":150},"Microsoft.ApiManagement/service/apis/issues/comments@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":155},"Microsoft.ApiManagement/service/apis/issues/attachments@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":160},"Microsoft.ApiManagement/service/apis/tagDescriptions@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":165},"Microsoft.ApiManagement/service/apiVersionSets@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":174},"Microsoft.ApiManagement/service/authorizationServers@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":205},"Microsoft.ApiManagement/service/backends@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":228},"Microsoft.ApiManagement/service/caches@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":233},"Microsoft.ApiManagement/service/certificates@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":238},"Microsoft.ApiManagement/service@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":280},"Microsoft.ApiManagement/service/diagnostics@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":284},"Microsoft.ApiManagement/service/templates@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":306},"Microsoft.ApiManagement/service/groups@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":315},"Microsoft.ApiManagement/service/groups/users@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":319},"Microsoft.ApiManagement/service/identityProviders@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":339},"Microsoft.ApiManagement/service/loggers@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":348},"Microsoft.ApiManagement/service/notifications@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":364},"Microsoft.ApiManagement/service/notifications/recipientUsers@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":368},"Microsoft.ApiManagement/service/notifications/recipientEmails@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":372},"Microsoft.ApiManagement/service/openidConnectProviders@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":377},"Microsoft.ApiManagement/service/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":383},"Microsoft.ApiManagement/service/portalsettings@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":403},"Microsoft.ApiManagement/service/products@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":411},"Microsoft.ApiManagement/service/products/apis@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":415},"Microsoft.ApiManagement/service/products/groups@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":419},"Microsoft.ApiManagement/service/products/policies@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":425},"Microsoft.ApiManagement/service/properties@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":431},"Microsoft.ApiManagement/service/subscriptions@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":443},"Microsoft.ApiManagement/service/users@2019-01-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-01-01/types.json","Index":467},"Microsoft.ApiManagement/service/apis@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":139},"Microsoft.ApiManagement/service/apis/issues@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":150},"Microsoft.ApiManagement/service/apis/issues/comments@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":155},"Microsoft.ApiManagement/service/apis/issues/attachments@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":160},"Microsoft.ApiManagement/service/apis/tagDescriptions@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":165},"Microsoft.ApiManagement/service/apiVersionSets@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":174},"Microsoft.ApiManagement/service/authorizationServers@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":205},"Microsoft.ApiManagement/service/backends@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":228},"Microsoft.ApiManagement/service/caches@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":233},"Microsoft.ApiManagement/service/certificates@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":238},"Microsoft.ApiManagement/service@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":286},"Microsoft.ApiManagement/service/diagnostics@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":290},"Microsoft.ApiManagement/service/templates@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":312},"Microsoft.ApiManagement/service/gateways@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":318},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":323},"Microsoft.ApiManagement/service/gateways/apis@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":329},"Microsoft.ApiManagement/service/groups@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":338},"Microsoft.ApiManagement/service/groups/users@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":342},"Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":362},"Microsoft.ApiManagement/service/loggers@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/notifications@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":387},"Microsoft.ApiManagement/service/notifications/recipientUsers@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":391},"Microsoft.ApiManagement/service/notifications/recipientEmails@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":395},"Microsoft.ApiManagement/service/openidConnectProviders@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":400},"Microsoft.ApiManagement/service/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":406},"Microsoft.ApiManagement/service/portalsettings@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":426},"Microsoft.ApiManagement/service/products@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":434},"Microsoft.ApiManagement/service/products/apis@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":438},"Microsoft.ApiManagement/service/products/groups@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":442},"Microsoft.ApiManagement/service/products/policies@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/namedValues@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":454},"Microsoft.ApiManagement/service/subscriptions@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":466},"Microsoft.ApiManagement/service/users@2019-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":489},"Microsoft.ApiManagement/service/apis@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":139},"Microsoft.ApiManagement/service/apis/issues@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":150},"Microsoft.ApiManagement/service/apis/issues/comments@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":155},"Microsoft.ApiManagement/service/apis/issues/attachments@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":160},"Microsoft.ApiManagement/service/apis/tagDescriptions@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":165},"Microsoft.ApiManagement/service/apiVersionSets@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":174},"Microsoft.ApiManagement/service/authorizationServers@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":205},"Microsoft.ApiManagement/service/backends@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":228},"Microsoft.ApiManagement/service/caches@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":233},"Microsoft.ApiManagement/service/certificates@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":238},"Microsoft.ApiManagement/service/contentTypes@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":243},"Microsoft.ApiManagement/service/contentTypes/contentItems@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":248},"Microsoft.ApiManagement/service@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":296},"Microsoft.ApiManagement/service/diagnostics@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":300},"Microsoft.ApiManagement/service/templates@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":322},"Microsoft.ApiManagement/service/gateways@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":328},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":333},"Microsoft.ApiManagement/service/gateways/apis@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":339},"Microsoft.ApiManagement/service/groups@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":348},"Microsoft.ApiManagement/service/groups/users@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":352},"Microsoft.ApiManagement/service/identityProviders@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":372},"Microsoft.ApiManagement/service/loggers@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":381},"Microsoft.ApiManagement/service/namedValues@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":387},"Microsoft.ApiManagement/service/notifications@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":403},"Microsoft.ApiManagement/service/notifications/recipientUsers@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":407},"Microsoft.ApiManagement/service/notifications/recipientEmails@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":411},"Microsoft.ApiManagement/service/openidConnectProviders@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":416},"Microsoft.ApiManagement/service/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":422},"Microsoft.ApiManagement/service/portalsettings@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":442},"Microsoft.ApiManagement/service/products@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":450},"Microsoft.ApiManagement/service/products/apis@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":454},"Microsoft.ApiManagement/service/products/groups@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":458},"Microsoft.ApiManagement/service/products/policies@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":464},"Microsoft.ApiManagement/service/subscriptions@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":476},"Microsoft.ApiManagement/service/users@2019-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":500},"Microsoft.ApiManagement/service/apis@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":149},"Microsoft.ApiManagement/service/apis/issues@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":160},"Microsoft.ApiManagement/service/apis/issues/comments@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":165},"Microsoft.ApiManagement/service/apis/issues/attachments@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":170},"Microsoft.ApiManagement/service/apis/tagDescriptions@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":175},"Microsoft.ApiManagement/service/apiVersionSets@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":184},"Microsoft.ApiManagement/service/authorizationServers@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":215},"Microsoft.ApiManagement/service/backends@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":239},"Microsoft.ApiManagement/service/caches@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":244},"Microsoft.ApiManagement/service/certificates@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/contentTypes@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":256},"Microsoft.ApiManagement/service/contentTypes/contentItems@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":261},"Microsoft.ApiManagement/service@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":312},"Microsoft.ApiManagement/service/diagnostics@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":316},"Microsoft.ApiManagement/service/templates@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":338},"Microsoft.ApiManagement/service/gateways@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":344},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":349},"Microsoft.ApiManagement/service/gateways/apis@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":355},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":360},"Microsoft.ApiManagement/service/groups@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":369},"Microsoft.ApiManagement/service/groups/users@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":373},"Microsoft.ApiManagement/service/identityProviders@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":393},"Microsoft.ApiManagement/service/loggers@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":403},"Microsoft.ApiManagement/service/namedValues@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":409},"Microsoft.ApiManagement/service/notifications@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":425},"Microsoft.ApiManagement/service/notifications/recipientUsers@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":429},"Microsoft.ApiManagement/service/notifications/recipientEmails@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":433},"Microsoft.ApiManagement/service/openidConnectProviders@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":438},"Microsoft.ApiManagement/service/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":444},"Microsoft.ApiManagement/service/portalRevisions@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":454},"Microsoft.ApiManagement/service/portalsettings@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":474},"Microsoft.ApiManagement/service/products@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":482},"Microsoft.ApiManagement/service/products/apis@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":486},"Microsoft.ApiManagement/service/products/groups@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":490},"Microsoft.ApiManagement/service/products/policies@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":496},"Microsoft.ApiManagement/service/subscriptions@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":508},"Microsoft.ApiManagement/service/tenant@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":516},"Microsoft.ApiManagement/service/users@2020-06-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":540},"Microsoft.ApiManagement/service/apis@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":53},"Microsoft.ApiManagement/service/apis/releases@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":58},"Microsoft.ApiManagement/service/apis/operations@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":76},"Microsoft.ApiManagement/service/apis/operations/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":93},"Microsoft.ApiManagement/service/apis/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":97},"Microsoft.ApiManagement/service/products/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":101},"Microsoft.ApiManagement/service/tags@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":111},"Microsoft.ApiManagement/service/apis/schemas@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/diagnostics@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":149},"Microsoft.ApiManagement/service/apis/issues@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":160},"Microsoft.ApiManagement/service/apis/issues/comments@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":165},"Microsoft.ApiManagement/service/apis/issues/attachments@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":170},"Microsoft.ApiManagement/service/apis/tagDescriptions@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":175},"Microsoft.ApiManagement/service/apiVersionSets@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":184},"Microsoft.ApiManagement/service/authorizationServers@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":215},"Microsoft.ApiManagement/service/backends@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":239},"Microsoft.ApiManagement/service/caches@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":244},"Microsoft.ApiManagement/service/certificates@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":251},"Microsoft.ApiManagement/service/contentTypes@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":256},"Microsoft.ApiManagement/service/contentTypes/contentItems@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":261},"Microsoft.ApiManagement/service@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":312},"Microsoft.ApiManagement/service/diagnostics@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":316},"Microsoft.ApiManagement/service/templates@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":338},"Microsoft.ApiManagement/service/gateways@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":344},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":349},"Microsoft.ApiManagement/service/gateways/apis@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":355},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":360},"Microsoft.ApiManagement/service/groups@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":369},"Microsoft.ApiManagement/service/groups/users@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":373},"Microsoft.ApiManagement/service/identityProviders@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":393},"Microsoft.ApiManagement/service/loggers@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":403},"Microsoft.ApiManagement/service/namedValues@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":409},"Microsoft.ApiManagement/service/notifications@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":425},"Microsoft.ApiManagement/service/notifications/recipientUsers@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":429},"Microsoft.ApiManagement/service/notifications/recipientEmails@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":433},"Microsoft.ApiManagement/service/openidConnectProviders@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":438},"Microsoft.ApiManagement/service/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":444},"Microsoft.ApiManagement/service/portalRevisions@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":454},"Microsoft.ApiManagement/service/portalsettings@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":474},"Microsoft.ApiManagement/service/products@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":482},"Microsoft.ApiManagement/service/products/apis@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":486},"Microsoft.ApiManagement/service/products/groups@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":490},"Microsoft.ApiManagement/service/products/policies@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":496},"Microsoft.ApiManagement/service/subscriptions@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":508},"Microsoft.ApiManagement/service/tenant@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":516},"Microsoft.ApiManagement/service/users@2020-12-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":540},"Microsoft.ApiManagement/service/apis@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":59},"Microsoft.ApiManagement/service/apis/releases@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":64},"Microsoft.ApiManagement/service/apis/operations@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":84},"Microsoft.ApiManagement/service/apis/operations/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":96},"Microsoft.ApiManagement/service/apis/operations/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":101},"Microsoft.ApiManagement/service/apis/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/products/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":109},"Microsoft.ApiManagement/service/tags@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":113},"Microsoft.ApiManagement/service/apis/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":119},"Microsoft.ApiManagement/service/apis/schemas@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":124},"Microsoft.ApiManagement/service/apis/diagnostics@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":156},"Microsoft.ApiManagement/service/apis/issues@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":167},"Microsoft.ApiManagement/service/apis/issues/comments@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":177},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":182},"Microsoft.ApiManagement/service/apiVersionSets@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":191},"Microsoft.ApiManagement/service/authorizationServers@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":222},"Microsoft.ApiManagement/service/backends@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":246},"Microsoft.ApiManagement/service/caches@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/certificates@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":258},"Microsoft.ApiManagement/service/contentTypes@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":268},"Microsoft.ApiManagement/service@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":328},"Microsoft.ApiManagement/service/diagnostics@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":332},"Microsoft.ApiManagement/service/templates@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":354},"Microsoft.ApiManagement/service/gateways@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":360},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":365},"Microsoft.ApiManagement/service/gateways/apis@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":376},"Microsoft.ApiManagement/service/groups@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":385},"Microsoft.ApiManagement/service/groups/users@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":389},"Microsoft.ApiManagement/service/identityProviders@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":409},"Microsoft.ApiManagement/service/loggers@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":419},"Microsoft.ApiManagement/service/namedValues@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":425},"Microsoft.ApiManagement/service/notifications@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":441},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":445},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":449},"Microsoft.ApiManagement/service/openidConnectProviders@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":454},"Microsoft.ApiManagement/service/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":460},"Microsoft.ApiManagement/service/portalRevisions@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":470},"Microsoft.ApiManagement/service/portalsettings@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":490},"Microsoft.ApiManagement/service/products@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":498},"Microsoft.ApiManagement/service/products/apis@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":502},"Microsoft.ApiManagement/service/products/groups@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":506},"Microsoft.ApiManagement/service/products/policies@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":512},"Microsoft.ApiManagement/service/subscriptions@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":524},"Microsoft.ApiManagement/service/tenant@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":532},"Microsoft.ApiManagement/service/users@2021-01-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":556},"Microsoft.ApiManagement/service/apis@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":62},"Microsoft.ApiManagement/service/apis/releases@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":67},"Microsoft.ApiManagement/service/apis/operations@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":100},"Microsoft.ApiManagement/service/apis/operations/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":109},"Microsoft.ApiManagement/service/products/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":113},"Microsoft.ApiManagement/service/tags@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":123},"Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":129},"Microsoft.ApiManagement/service/apis/diagnostics@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":161},"Microsoft.ApiManagement/service/apis/issues@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/comments@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":177},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":182},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":187},"Microsoft.ApiManagement/service/apiVersionSets@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":196},"Microsoft.ApiManagement/service/authorizationServers@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":227},"Microsoft.ApiManagement/service/backends@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/caches@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":256},"Microsoft.ApiManagement/service/certificates@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":268},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":273},"Microsoft.ApiManagement/service@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":367},"Microsoft.ApiManagement/service/diagnostics@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/templates@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":393},"Microsoft.ApiManagement/service/gateways@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":399},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":404},"Microsoft.ApiManagement/service/gateways/apis@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":410},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":415},"Microsoft.ApiManagement/service/groups@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":424},"Microsoft.ApiManagement/service/groups/users@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":428},"Microsoft.ApiManagement/service/identityProviders@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/loggers@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":458},"Microsoft.ApiManagement/service/namedValues@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":464},"Microsoft.ApiManagement/service/notifications@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":480},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":484},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":488},"Microsoft.ApiManagement/service/openidConnectProviders@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":493},"Microsoft.ApiManagement/service/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":499},"Microsoft.ApiManagement/service/portalRevisions@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":509},"Microsoft.ApiManagement/service/portalsettings@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":529},"Microsoft.ApiManagement/service/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":540},"Microsoft.ApiManagement/service/products@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":548},"Microsoft.ApiManagement/service/products/apis@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":552},"Microsoft.ApiManagement/service/products/groups@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":556},"Microsoft.ApiManagement/service/products/policies@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":562},"Microsoft.ApiManagement/service/schemas@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":570},"Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":582},"Microsoft.ApiManagement/service/tenant@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":590},"Microsoft.ApiManagement/service/users@2021-04-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":614},"Microsoft.ApiManagement/service/apis@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":62},"Microsoft.ApiManagement/service/apis/releases@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":67},"Microsoft.ApiManagement/service/apis/operations@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":100},"Microsoft.ApiManagement/service/apis/operations/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":105},"Microsoft.ApiManagement/service/apis/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":109},"Microsoft.ApiManagement/service/products/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":113},"Microsoft.ApiManagement/service/tags@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":117},"Microsoft.ApiManagement/service/apis/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":123},"Microsoft.ApiManagement/service/apis/schemas@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":129},"Microsoft.ApiManagement/service/apis/diagnostics@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":161},"Microsoft.ApiManagement/service/apis/issues@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/comments@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":177},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":182},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":187},"Microsoft.ApiManagement/service/apiVersionSets@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":196},"Microsoft.ApiManagement/service/authorizationServers@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":227},"Microsoft.ApiManagement/service/backends@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":251},"Microsoft.ApiManagement/service/caches@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":256},"Microsoft.ApiManagement/service/certificates@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":268},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":273},"Microsoft.ApiManagement/service@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":367},"Microsoft.ApiManagement/service/diagnostics@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":371},"Microsoft.ApiManagement/service/templates@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":393},"Microsoft.ApiManagement/service/gateways@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":399},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":404},"Microsoft.ApiManagement/service/gateways/apis@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":410},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":415},"Microsoft.ApiManagement/service/groups@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":424},"Microsoft.ApiManagement/service/groups/users@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":428},"Microsoft.ApiManagement/service/identityProviders@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":448},"Microsoft.ApiManagement/service/loggers@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":458},"Microsoft.ApiManagement/service/namedValues@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":464},"Microsoft.ApiManagement/service/notifications@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":480},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":484},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":488},"Microsoft.ApiManagement/service/openidConnectProviders@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":493},"Microsoft.ApiManagement/service/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":499},"Microsoft.ApiManagement/service/portalRevisions@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":509},"Microsoft.ApiManagement/service/portalsettings@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":529},"Microsoft.ApiManagement/service/privateEndpointConnections@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":540},"Microsoft.ApiManagement/service/products@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":548},"Microsoft.ApiManagement/service/products/apis@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":552},"Microsoft.ApiManagement/service/products/groups@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":556},"Microsoft.ApiManagement/service/products/policies@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":562},"Microsoft.ApiManagement/service/schemas@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":570},"Microsoft.ApiManagement/service/subscriptions@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":582},"Microsoft.ApiManagement/service/tenant@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":590},"Microsoft.ApiManagement/service/users@2021-08-01":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":614},"Microsoft.ApiManagement/service/apis@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":62},"Microsoft.ApiManagement/service/apis/releases@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":67},"Microsoft.ApiManagement/service/apis/operations@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":88},"Microsoft.ApiManagement/service/apis/operations/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":100},"Microsoft.ApiManagement/service/apis/operations/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":105},"Microsoft.ApiManagement/service/apis/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":109},"Microsoft.ApiManagement/service/products/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":113},"Microsoft.ApiManagement/service/tags@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":117},"Microsoft.ApiManagement/service/apis/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":123},"Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":129},"Microsoft.ApiManagement/service/apis/diagnostics@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":161},"Microsoft.ApiManagement/service/apis/issues@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":172},"Microsoft.ApiManagement/service/apis/issues/comments@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":177},"Microsoft.ApiManagement/service/apis/issues/attachments@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":182},"Microsoft.ApiManagement/service/apis/tagDescriptions@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":187},"Microsoft.ApiManagement/service/apiVersionSets@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":196},"Microsoft.ApiManagement/service/authorizationServers@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":227},"Microsoft.ApiManagement/service/backends@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":251},"Microsoft.ApiManagement/service/caches@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":256},"Microsoft.ApiManagement/service/certificates@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":263},"Microsoft.ApiManagement/service/contentTypes@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":268},"Microsoft.ApiManagement/service/contentTypes/contentItems@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":273},"Microsoft.ApiManagement/service@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":367},"Microsoft.ApiManagement/service/diagnostics@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":371},"Microsoft.ApiManagement/service/templates@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":393},"Microsoft.ApiManagement/service/gateways@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":399},"Microsoft.ApiManagement/service/gateways/hostnameConfigurations@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":404},"Microsoft.ApiManagement/service/gateways/apis@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":410},"Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":415},"Microsoft.ApiManagement/service/groups@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":424},"Microsoft.ApiManagement/service/groups/users@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":428},"Microsoft.ApiManagement/service/identityProviders@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":448},"Microsoft.ApiManagement/service/loggers@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":458},"Microsoft.ApiManagement/service/namedValues@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":464},"Microsoft.ApiManagement/service/notifications@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":480},"Microsoft.ApiManagement/service/notifications/recipientUsers@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":484},"Microsoft.ApiManagement/service/notifications/recipientEmails@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":488},"Microsoft.ApiManagement/service/openidConnectProviders@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":493},"Microsoft.ApiManagement/service/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":499},"Microsoft.ApiManagement/service/policyFragments@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":507},"Microsoft.ApiManagement/service/portalRevisions@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":517},"Microsoft.ApiManagement/service/portalsettings@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":537},"Microsoft.ApiManagement/service/portalconfigs@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":555},"Microsoft.ApiManagement/service/privateEndpointConnections@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":566},"Microsoft.ApiManagement/service/products@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":574},"Microsoft.ApiManagement/service/products/apis@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":578},"Microsoft.ApiManagement/service/products/groups@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":582},"Microsoft.ApiManagement/service/products/policies@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":588},"Microsoft.ApiManagement/service/schemas@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":596},"Microsoft.ApiManagement/service/subscriptions@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":608},"Microsoft.ApiManagement/service/tenant@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":616},"Microsoft.ApiManagement/service/users@2021-12-01-preview":{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":640},"Microsoft.App/containerApps@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":99},"Microsoft.App/managedEnvironments@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":119},"Microsoft.App/managedEnvironments/certificates@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":131},"Microsoft.App/containerApps/sourcecontrols@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":144},"Microsoft.App/managedEnvironments/daprComponents@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":153},"Microsoft.App/containerApps/authConfigs@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":219},"Microsoft.App/managedEnvironments/storages@2022-01-01-preview":{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":228},"Microsoft.App/containerApps/authConfigs@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":84},"Microsoft.App/containerApps@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":165},"Microsoft.App/managedEnvironments/daprComponents@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":174},"Microsoft.App/managedEnvironments@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":194},"Microsoft.App/managedEnvironments/certificates@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":206},"Microsoft.App/managedEnvironments/storages@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":215},"Microsoft.App/containerApps/sourcecontrols@2022-03-01":{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":228},"Microsoft.AppConfiguration/configurationStores@2019-02-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.json","Index":20},"Microsoft.AppConfiguration/configurationStores@2019-10-01":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-10-01/types.json","Index":29},"Microsoft.AppConfiguration/configurationStores@2019-11-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":54},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2019-11-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":58},"Microsoft.AppConfiguration/configurationStores@2020-06-01":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":54},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2020-06-01":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":58},"Microsoft.AppConfiguration/configurationStores@2020-07-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":54},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2020-07-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":58},"Microsoft.AppConfiguration/configurationStores/keyValues@2020-07-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":64},"Microsoft.AppConfiguration/configurationStores@2021-03-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":65},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2021-03-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":69},"Microsoft.AppConfiguration/configurationStores/keyValues@2021-03-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":75},"Microsoft.AppConfiguration/configurationStores@2021-10-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":68},"Microsoft.AppConfiguration/configurationStores/privateEndpointConnections@2021-10-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":72},"Microsoft.AppConfiguration/configurationStores/keyValues@2021-10-01-preview":{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":78},"Microsoft.Insights/components/exportconfiguration@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":11},"Microsoft.Insights/components/ProactiveDetectionConfigs@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":17},"Microsoft.Insights/components/favorites@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":25},"Microsoft.Insights/webtests@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":40},"microsoft.insights/components/analyticsItems@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":54},"microsoft.insights/components/myanalyticsItems@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":67},"microsoft.insights/workbooks@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":80},"Microsoft.Insights/myWorkbooks@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":90},"Microsoft.Insights/components@2015-05-01":{"RelativePath":"applicationinsights/microsoft.insights/2015-05-01/types.json","Index":109},"microsoft.insights/components/pricingPlans@2017-10-01":{"RelativePath":"applicationinsights/microsoft.insights/2017-10-01/types.json","Index":13},"Microsoft.Insights/components@2018-05-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-05-01-preview/types.json","Index":32},"Microsoft.Insights/components/ProactiveDetectionConfigs@2018-05-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-05-01-preview/types.json","Index":39},"Microsoft.Insights/webtests@2018-05-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-05-01-preview/types.json","Index":61},"microsoft.insights/workbooks@2018-06-17-preview":{"RelativePath":"applicationinsights/microsoft.insights/2018-06-17-preview/types.json","Index":17},"microsoft.insights/workbooktemplates@2019-10-17-preview":{"RelativePath":"applicationinsights/microsoft.insights/2019-10-17-preview/types.json","Index":19},"Microsoft.Insights/components@2020-02-02-preview":{"RelativePath":"applicationinsights/microsoft.insights/2020-02-02-preview/types.json","Index":32},"Microsoft.Insights/components@2020-02-02":{"RelativePath":"applicationinsights/microsoft.insights/2020-02-02/types.json","Index":32},"microsoft.insights/components/linkedStorageAccounts@2020-03-01-preview":{"RelativePath":"applicationinsights/microsoft.insights/2020-03-01-preview/types.json","Index":14},"Microsoft.Insights/webtests@2020-10-05-preview":{"RelativePath":"applicationinsights/microsoft.insights/2020-10-05-preview/types.json","Index":29},"Microsoft.Insights/myWorkbooks@2020-10-20":{"RelativePath":"applicationinsights/microsoft.insights/2020-10-20/types.json","Index":23},"Microsoft.Insights/workbooks@2020-10-20":{"RelativePath":"applicationinsights/microsoft.insights/2020-10-20/types.json","Index":39},"Microsoft.Insights/workbooktemplates@2020-11-20":{"RelativePath":"applicationinsights/microsoft.insights/2020-11-20/types.json","Index":19},"Microsoft.Insights/myWorkbooks@2021-03-08":{"RelativePath":"applicationinsights/microsoft.insights/2021-03-08/types.json","Index":34},"Microsoft.Insights/workbooks@2021-03-08":{"RelativePath":"applicationinsights/microsoft.insights/2021-03-08/types.json","Index":50},"Microsoft.Insights/workbooks@2021-08-01":{"RelativePath":"applicationinsights/microsoft.insights/2021-08-01/types.json","Index":36},"Microsoft.AppPlatform/Spring@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":34},"Microsoft.AppPlatform/Spring/configServers@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":54},"Microsoft.AppPlatform/Spring/monitoringSettings@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":65},"Microsoft.AppPlatform/Spring/apps@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":83},"Microsoft.AppPlatform/Spring/apps/bindings@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":89},"Microsoft.AppPlatform/Spring/certificates@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":95},"Microsoft.AppPlatform/Spring/apps/domains@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":100},"Microsoft.AppPlatform/Spring/apps/deployments@2020-07-01":{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":131},"Microsoft.AppPlatform/Spring@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":34},"Microsoft.AppPlatform/Spring/configServers@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":54},"Microsoft.AppPlatform/Spring/monitoringSettings@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":66},"Microsoft.AppPlatform/Spring/apps@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":84},"Microsoft.AppPlatform/Spring/apps/bindings@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/certificates@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":96},"Microsoft.AppPlatform/Spring/apps/domains@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":101},"Microsoft.AppPlatform/Spring/apps/deployments@2020-11-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":132},"Microsoft.AppPlatform/Spring@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":34},"Microsoft.AppPlatform/Spring/configServers@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":54},"Microsoft.AppPlatform/Spring/monitoringSettings@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":66},"Microsoft.AppPlatform/Spring/apps@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":84},"Microsoft.AppPlatform/Spring/apps/bindings@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/certificates@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":96},"Microsoft.AppPlatform/Spring/apps/domains@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":101},"Microsoft.AppPlatform/Spring/apps/deployments@2021-06-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":138},"Microsoft.AppPlatform/Spring@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":39},"Microsoft.AppPlatform/Spring/configServers@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":59},"Microsoft.AppPlatform/Spring/monitoringSettings@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":71},"Microsoft.AppPlatform/Spring/apps@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":97},"Microsoft.AppPlatform/Spring/apps/bindings@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":103},"Microsoft.AppPlatform/Spring/storages@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":121},"Microsoft.AppPlatform/Spring/certificates@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":131},"Microsoft.AppPlatform/Spring/apps/domains@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":136},"Microsoft.AppPlatform/Spring/apps/deployments@2021-09-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":174},"Microsoft.AppPlatform/Spring@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":50},"Microsoft.AppPlatform/Spring/configServers@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":70},"Microsoft.AppPlatform/Spring/configurationServices@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/serviceRegistries@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":104},"Microsoft.AppPlatform/Spring/buildServices/builds@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":117},"Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":138},"Microsoft.AppPlatform/Spring/buildServices/builders@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":154},"Microsoft.AppPlatform/Spring/buildServices/agentPools@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":160},"Microsoft.AppPlatform/Spring/monitoringSettings@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":172},"Microsoft.AppPlatform/Spring/apps@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":201},"Microsoft.AppPlatform/Spring/apps/bindings@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":207},"Microsoft.AppPlatform/Spring/storages@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":214},"Microsoft.AppPlatform/Spring/certificates@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":224},"Microsoft.AppPlatform/Spring/apps/domains@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":229},"Microsoft.AppPlatform/Spring/apps/deployments@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":265},"Microsoft.AppPlatform/Spring/gateways@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":290},"Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":306},"Microsoft.AppPlatform/Spring/gateways/domains@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":311},"Microsoft.AppPlatform/Spring/apiPortals@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":327},"Microsoft.AppPlatform/Spring/apiPortals/domains@2022-01-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":332},"Microsoft.AppPlatform/Spring@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":50},"Microsoft.AppPlatform/Spring/configServers@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":70},"Microsoft.AppPlatform/Spring/configurationServices@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":90},"Microsoft.AppPlatform/Spring/serviceRegistries@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":104},"Microsoft.AppPlatform/Spring/buildServices/builds@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":117},"Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":138},"Microsoft.AppPlatform/Spring/buildServices/builders@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":154},"Microsoft.AppPlatform/Spring/buildServices/agentPools@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":160},"Microsoft.AppPlatform/Spring/monitoringSettings@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":172},"Microsoft.AppPlatform/Spring/apps@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":203},"Microsoft.AppPlatform/Spring/apps/bindings@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":209},"Microsoft.AppPlatform/Spring/storages@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":216},"Microsoft.AppPlatform/Spring/certificates@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":226},"Microsoft.AppPlatform/Spring/apps/domains@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":231},"Microsoft.AppPlatform/Spring/apps/deployments@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":267},"Microsoft.AppPlatform/Spring/gateways@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":292},"Microsoft.AppPlatform/Spring/gateways/routeConfigs@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":308},"Microsoft.AppPlatform/Spring/gateways/domains@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":313},"Microsoft.AppPlatform/Spring/apiPortals@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":329},"Microsoft.AppPlatform/Spring/apiPortals/domains@2022-03-01-preview":{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":334},"Microsoft.Attestation/attestationProviders@2018-09-01-preview":{"RelativePath":"attestation/microsoft.attestation/2018-09-01-preview/types.json","Index":21},"Microsoft.Attestation/attestationProviders@2020-10-01":{"RelativePath":"attestation/microsoft.attestation/2020-10-01/types.json","Index":46},"Microsoft.Attestation/attestationProviders/privateEndpointConnections@2020-10-01":{"RelativePath":"attestation/microsoft.attestation/2020-10-01/types.json","Index":50},"Microsoft.Attestation/attestationProviders@2021-06-01-preview":{"RelativePath":"attestation/microsoft.attestation/2021-06-01-preview/types.json","Index":49},"Microsoft.Attestation/attestationProviders/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"attestation/microsoft.attestation/2021-06-01-preview/types.json","Index":53},"Microsoft.Authorization/roleDefinitions@2015-07-01":{"RelativePath":"authorization/microsoft.authorization/2015-07-01/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2015-07-01":{"RelativePath":"authorization/microsoft.authorization/2015-07-01/types.json","Index":22},"Microsoft.Authorization/roleAssignments@2017-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2017-10-01-preview/types.json","Index":12},"Microsoft.Authorization/roleDefinitions@2018-01-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-01-01-preview/types.json","Index":19},"Microsoft.Authorization/roleAssignments@2018-01-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-01-01-preview/types.json","Index":24},"Microsoft.Authorization/accessReviewScheduleDefinitions@2018-05-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-05-01-preview/types.json","Index":89},"Microsoft.Authorization/accessReviewScheduleSettings@2018-05-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-05-01-preview/types.json","Index":98},"Microsoft.Authorization/roleAssignments@2018-09-01-preview":{"RelativePath":"authorization/microsoft.authorization/2018-09-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-03-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-03-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-04-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-04-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-08-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-08-01-preview/types.json","Index":17},"Microsoft.Authorization/roleAssignments@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":18},"Microsoft.Authorization/roleAssignmentScheduleRequests@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":73},"Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":124},"Microsoft.Authorization/roleManagementPolicyAssignments@2020-10-01-preview":{"RelativePath":"authorization/microsoft.authorization/2020-10-01-preview/types.json","Index":134},"Microsoft.Authorization/roleAssignmentScheduleRequests@2020-10-01":{"RelativePath":"authorization/microsoft.authorization/2020-10-01/types.json","Index":62},"Microsoft.Authorization/roleEligibilityScheduleRequests@2020-10-01":{"RelativePath":"authorization/microsoft.authorization/2020-10-01/types.json","Index":113},"Microsoft.Authorization/roleManagementPolicyAssignments@2020-10-01":{"RelativePath":"authorization/microsoft.authorization/2020-10-01/types.json","Index":170},"Microsoft.Authorization/roleAssignmentApprovals/stages@2021-01-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-01-01-preview/types.json","Index":42},"Microsoft.Authorization/accessReviewScheduleDefinitions@2021-03-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-03-01-preview/types.json","Index":95},"Microsoft.Authorization/accessReviewScheduleSettings@2021-03-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-03-01-preview/types.json","Index":104},"Microsoft.Authorization/accessReviewScheduleDefinitions@2021-07-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-07-01-preview/types.json","Index":103},"Microsoft.Authorization/accessReviewScheduleDefinitions/instances@2021-07-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-07-01-preview/types.json","Index":125},"Microsoft.Authorization/accessReviewScheduleSettings@2021-07-01-preview":{"RelativePath":"authorization/microsoft.authorization/2021-07-01-preview/types.json","Index":134},"Microsoft.Authorization/accessReviewHistoryDefinitions@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":71},"Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":144},"Microsoft.Authorization/accessReviewScheduleDefinitions/instances@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":166},"Microsoft.Authorization/accessReviewScheduleSettings@2021-11-16-preview":{"RelativePath":"authorization/microsoft.authorization/2021-11-16-preview/types.json","Index":175},"Microsoft.Authorization/roleAssignmentScheduleRequests@2022-04-01-preview":{"RelativePath":"authorization/microsoft.authorization/2022-04-01-preview/types.json","Index":62},"Microsoft.Authorization/roleEligibilityScheduleRequests@2022-04-01-preview":{"RelativePath":"authorization/microsoft.authorization/2022-04-01-preview/types.json","Index":113},"Microsoft.Automanage/accounts@2020-06-30-preview":{"RelativePath":"automanage/microsoft.automanage/2020-06-30-preview/types.json","Index":16},"Microsoft.Automanage/configurationProfileAssignments@2020-06-30-preview":{"RelativePath":"automanage/microsoft.automanage/2020-06-30-preview/types.json","Index":33},"Microsoft.Automanage/configurationProfilePreferences@2020-06-30-preview":{"RelativePath":"automanage/microsoft.automanage/2020-06-30-preview/types.json","Index":50},"Microsoft.Automanage/configurationProfiles@2021-04-30-preview":{"RelativePath":"automanage/microsoft.automanage/2021-04-30-preview/types.json","Index":25},"Microsoft.Automanage/configurationProfiles/versions@2021-04-30-preview":{"RelativePath":"automanage/microsoft.automanage/2021-04-30-preview/types.json","Index":30},"Microsoft.Automanage/configurationProfileAssignments@2021-04-30-preview":{"RelativePath":"automanage/microsoft.automanage/2021-04-30-preview/types.json","Index":36},"Microsoft.Automation/automationAccounts@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":21},"Microsoft.Automation/automationAccounts/certificates@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":26},"Microsoft.Automation/automationAccounts/connections@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":33},"Microsoft.Automation/automationAccounts/connectionTypes@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":40},"Microsoft.Automation/automationAccounts/credentials@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":45},"Microsoft.Automation/automationAccounts/compilationjobs@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":72},"Microsoft.Automation/automationAccounts/configurations@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":90},"Microsoft.Automation/automationAccounts/nodeConfigurations@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":94},"Microsoft.Automation/automationAccounts/jobs@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":121},"Microsoft.Automation/automationAccounts/jobSchedules@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":127},"Microsoft.Automation/automationAccounts/modules@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":152},"Microsoft.Automation/automationAccounts/runbooks/draft@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":163},"Microsoft.Automation/automationAccounts/runbooks@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":187},"Microsoft.Automation/automationAccounts/schedules@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":212},"Microsoft.Automation/automationAccounts/variables@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":217},"Microsoft.Automation/automationAccounts/watchers@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":224},"Microsoft.Automation/automationAccounts/webhooks@2015-10-31":{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":230},"Microsoft.Automation/automationAccounts/softwareUpdateConfigurations@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":77},"Microsoft.Automation/automationAccounts/sourceControls@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":90},"Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":102},"Microsoft.Automation/automationAccounts/jobs@2017-05-15-preview":{"RelativePath":"automation/microsoft.automation/2017-05-15-preview/types.json","Index":128},"Microsoft.Automation/automationAccounts/compilationjobs@2018-01-15":{"RelativePath":"automation/microsoft.automation/2018-01-15/types.json","Index":34},"Microsoft.Automation/automationAccounts/nodeConfigurations@2018-01-15":{"RelativePath":"automation/microsoft.automation/2018-01-15/types.json","Index":45},"Microsoft.Automation/automationAccounts/runbooks/draft@2018-06-30":{"RelativePath":"automation/microsoft.automation/2018-06-30/types.json","Index":18},"Microsoft.Automation/automationAccounts/runbooks@2018-06-30":{"RelativePath":"automation/microsoft.automation/2018-06-30/types.json","Index":44},"Microsoft.Automation/automationAccounts/python2Packages@2018-06-30":{"RelativePath":"automation/microsoft.automation/2018-06-30/types.json","Index":68},"Microsoft.Automation/automationAccounts/runbooks/draft@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":18},"Microsoft.Automation/automationAccounts/runbooks@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":44},"Microsoft.Automation/automationAccounts/python2Packages@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":68},"Microsoft.Automation/automationAccounts/compilationjobs@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":95},"Microsoft.Automation/automationAccounts/nodeConfigurations@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":105},"Microsoft.Automation/automationAccounts/sourceControls@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":118},"Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":130},"Microsoft.Automation/automationAccounts/jobs@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":156},"Microsoft.Automation/automationAccounts@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":170},"Microsoft.Automation/automationAccounts/certificates@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":175},"Microsoft.Automation/automationAccounts/connections@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":182},"Microsoft.Automation/automationAccounts/connectionTypes@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":189},"Microsoft.Automation/automationAccounts/credentials@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":194},"Microsoft.Automation/automationAccounts/configurations@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":207},"Microsoft.Automation/automationAccounts/softwareUpdateConfigurations@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":277},"Microsoft.Automation/automationAccounts/jobSchedules@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":284},"Microsoft.Automation/automationAccounts/modules@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":307},"Microsoft.Automation/automationAccounts/schedules@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":319},"Microsoft.Automation/automationAccounts/variables@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":324},"Microsoft.Automation/automationAccounts/watchers@2019-06-01":{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":331},"Microsoft.Automation/automationAccounts/privateEndpointConnections@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":15},"Microsoft.Automation/automationAccounts/python2Packages@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":41},"Microsoft.Automation/automationAccounts/nodeConfigurations@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":52},"Microsoft.Automation/automationAccounts/compilationjobs@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":78},"Microsoft.Automation/automationAccounts/sourceControls@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":91},"Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":103},"Microsoft.Automation/automationAccounts@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":133},"Microsoft.Automation/automationAccounts/certificates@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":138},"Microsoft.Automation/automationAccounts/connections@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":145},"Microsoft.Automation/automationAccounts/connectionTypes@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":152},"Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":157},"Microsoft.Automation/automationAccounts/jobSchedules@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":165},"Microsoft.Automation/automationAccounts/modules@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":188},"Microsoft.Automation/automationAccounts/schedules@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":213},"Microsoft.Automation/automationAccounts/variables@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":218},"Microsoft.Automation/automationAccounts/watchers@2020-01-13-preview":{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":225},"Microsoft.Automation/automationAccounts@2021-06-22":{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":52},"Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups@2021-06-22":{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":62},"Microsoft.Automation/automationAccounts/hybridRunbookWorkerGroups/hybridRunbookWorkers@2021-06-22":{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":70},"Microsoft.Kusto/clusters@2018-09-07-preview":{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":42},"Microsoft.Kusto/clusters/databases@2018-09-07-preview":{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":55},"Microsoft.Kusto/clusters/databases/eventhubconnections@2018-09-07-preview":{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":64},"Microsoft.Kusto/clusters@2019-01-21":{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":48},"Microsoft.Kusto/clusters/databases@2019-01-21":{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":60},"Microsoft.Kusto/clusters/databases/dataConnections@2019-01-21":{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":94},"Microsoft.Kusto/clusters@2019-05-15":{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":52},"Microsoft.Kusto/clusters/databases@2019-05-15":{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":65},"Microsoft.Kusto/clusters/databases/dataConnections@2019-05-15":{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":119},"Microsoft.Kusto/clusters@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":59},"Microsoft.Kusto/clusters/databases@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":88},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":105},"Microsoft.Kusto/clusters/databases/dataConnections@2019-09-07":{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":159},"Microsoft.Kusto/clusters@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":59},"Microsoft.Kusto/clusters/principalAssignments@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":78},"Microsoft.Kusto/clusters/databases@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":107},"Microsoft.Kusto/clusters/databases/principalAssignments@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":130},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":147},"Microsoft.Kusto/clusters/databases/dataConnections@2019-11-09":{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":210},"Microsoft.Kusto/clusters@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":74},"Microsoft.Kusto/clusters/principalAssignments@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":93},"Microsoft.Kusto/clusters/databases@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":122},"Microsoft.Kusto/clusters/databases/principalAssignments@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":145},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":162},"Microsoft.Kusto/clusters/databases/dataConnections@2020-02-15":{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":225},"Microsoft.Kusto/clusters@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":74},"Microsoft.Kusto/clusters/principalAssignments@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":93},"Microsoft.Kusto/clusters/databases@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":122},"Microsoft.Kusto/clusters/databases/principalAssignments@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":145},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":162},"Microsoft.Kusto/clusters/databases/dataConnections@2020-06-14":{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":234},"Microsoft.Kusto/clusters@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":80},"Microsoft.Kusto/clusters/principalAssignments@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":99},"Microsoft.Kusto/clusters/databases@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":128},"Microsoft.Kusto/clusters/databases/principalAssignments@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":151},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":168},"Microsoft.Kusto/clusters/databases/dataConnections@2020-09-18":{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":261},"Microsoft.Kusto/clusters@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":83},"Microsoft.Kusto/clusters/principalAssignments@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":102},"Microsoft.Kusto/clusters/databases@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":131},"Microsoft.Kusto/clusters/databases/principalAssignments@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":154},"Microsoft.Kusto/clusters/databases/scripts@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":177},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":201},"Microsoft.Kusto/clusters/databases/dataConnections@2021-01-01":{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":294},"Microsoft.Kusto/clusters@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":104},"Microsoft.Kusto/clusters/principalAssignments@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":123},"Microsoft.Kusto/clusters/databases@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":152},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":176},"Microsoft.Kusto/clusters/managedPrivateEndpoints@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":188},"Microsoft.Kusto/clusters/databases/principalAssignments@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":211},"Microsoft.Kusto/clusters/databases/scripts@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":223},"Microsoft.Kusto/clusters/privateEndpointConnections@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":230},"Microsoft.Kusto/clusters/databases/dataConnections@2021-08-27":{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":323},"Microsoft.Kusto/clusters@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":131},"Microsoft.Kusto/clusters/principalAssignments@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":150},"Microsoft.Kusto/clusters/databases@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":179},"Microsoft.Kusto/clusters/attachedDatabaseConfigurations@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":203},"Microsoft.Kusto/clusters/managedPrivateEndpoints@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":215},"Microsoft.Kusto/clusters/databases/principalAssignments@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":238},"Microsoft.Kusto/clusters/databases/scripts@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":250},"Microsoft.Kusto/clusters/privateEndpointConnections@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":254},"Microsoft.Kusto/clusters/databases/dataConnections@2022-02-01":{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":356},"microsoft.aadiam/diagnosticSettings@2017-04-01-preview":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2017-04-01-preview/types.json","Index":18},"microsoft.aadiam/diagnosticSettings@2017-04-01":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2017-04-01/types.json","Index":18},"microsoft.aadiam/privateLinkForAzureAd@2020-03-01-preview":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-03-01-preview/types.json","Index":13},"microsoft.aadiam/privateLinkForAzureAd@2020-03-01":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-03-01/types.json","Index":13},"microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections@2020-03-01":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-03-01/types.json","Index":31},"microsoft.aadiam/azureADMetrics@2020-07-01-preview":{"RelativePath":"azureactivedirectory/microsoft.aadiam/2020-07-01-preview/types.json","Index":17},"Microsoft.AzureArcData/sqlManagedInstances@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":32},"Microsoft.AzureArcData/sqlServerInstances@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":38},"Microsoft.AzureArcData/postgresInstances@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":46},"Microsoft.AzureArcData/dataControllers@2021-06-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-06-01-preview/types.json","Index":56},"Microsoft.AzureArcData/sqlManagedInstances@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":37},"Microsoft.AzureArcData/sqlServerInstances@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":43},"Microsoft.AzureArcData/postgresInstances@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":51},"Microsoft.AzureArcData/dataControllers@2021-07-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-07-01-preview/types.json","Index":68},"Microsoft.AzureArcData/sqlManagedInstances@2021-08-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-08-01/types.json","Index":44},"Microsoft.AzureArcData/sqlServerInstances@2021-08-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-08-01/types.json","Index":74},"Microsoft.AzureArcData/dataControllers@2021-08-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-08-01/types.json","Index":91},"Microsoft.AzureArcData/sqlManagedInstances@2021-11-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-11-01/types.json","Index":45},"Microsoft.AzureArcData/sqlServerInstances@2021-11-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-11-01/types.json","Index":75},"Microsoft.AzureArcData/dataControllers@2021-11-01":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2021-11-01/types.json","Index":92},"Microsoft.AzureArcData/sqlManagedInstances@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":46},"Microsoft.AzureArcData/sqlServerInstances@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":87},"Microsoft.AzureArcData/dataControllers@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":104},"Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":120},"Microsoft.AzureArcData/postgresInstances@2022-03-01-preview":{"RelativePath":"azurearcdata/microsoft.azurearcdata/2022-03-01-preview/types.json","Index":128},"Microsoft.AzureData/sqlServerRegistrations@2019-07-24-preview":{"RelativePath":"azuredata/microsoft.azuredata/2019-07-24-preview/types.json","Index":24},"Microsoft.AzureData/sqlServerRegistrations/sqlServers@2019-07-24-preview":{"RelativePath":"azuredata/microsoft.azuredata/2019-07-24-preview/types.json","Index":29},"Microsoft.AzureStack/registrations@2016-01-01":{"RelativePath":"azurestack/microsoft.azurestack/2016-01-01/types.json","Index":15},"Microsoft.AzureStack/registrations@2017-06-01":{"RelativePath":"azurestack/microsoft.azurestack/2017-06-01/types.json","Index":15},"Microsoft.AzureStack/registrations/customerSubscriptions@2017-06-01":{"RelativePath":"azurestack/microsoft.azurestack/2017-06-01/types.json","Index":20},"Microsoft.AzureStack/registrations/customerSubscriptions@2020-06-01-preview":{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":23},"Microsoft.AzureStack/registrations@2020-06-01-preview":{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":31},"Microsoft.AzureStack/linkedSubscriptions@2020-06-01-preview":{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":39},"Microsoft.AzureStackHCI/clusters@2020-03-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2020-03-01-preview/types.json","Index":28},"Microsoft.AzureStackHCI/clusters@2020-10-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2020-10-01/types.json","Index":39},"Microsoft.AzureStackHCI/clusters/arcSettings@2021-01-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2021-01-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.json","Index":81},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2021-01-01-preview":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-01-01-preview/types.json","Index":124},"Microsoft.AzureStackHCI/clusters/arcSettings@2021-09-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-09-01/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2021-09-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-09-01/types.json","Index":99},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2021-09-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2021-09-01/types.json","Index":142},"Microsoft.AzureStackHCI/clusters/arcSettings@2022-01-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-01-01/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2022-01-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-01-01/types.json","Index":99},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2022-01-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-01-01/types.json","Index":142},"Microsoft.AzureStackHCI/clusters/arcSettings@2022-03-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-03-01/types.json","Index":60},"Microsoft.AzureStackHCI/clusters@2022-03-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-03-01/types.json","Index":99},"Microsoft.AzureStackHCI/clusters/arcSettings/extensions@2022-03-01":{"RelativePath":"azurestackhci/microsoft.azurestackhci/2022-03-01/types.json","Index":142},"Microsoft.Batch/batchAccounts@2015-12-01":{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":21},"Microsoft.Batch/batchAccounts/applications/versions@2015-12-01":{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":29},"Microsoft.Batch/batchAccounts/applications@2015-12-01":{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":39},"Microsoft.Batch/batchAccounts@2017-01-01":{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2017-01-01":{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2017-01-01":{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":43},"Microsoft.Batch/batchAccounts@2017-05-01":{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2017-05-01":{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2017-05-01":{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":43},"Microsoft.Batch/batchAccounts@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":43},"Microsoft.Batch/batchAccounts/certificates@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":61},"Microsoft.Batch/batchAccounts/pools@2017-09-01":{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":165},"Microsoft.Batch/batchAccounts@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":25},"Microsoft.Batch/batchAccounts/applications/versions@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":33},"Microsoft.Batch/batchAccounts/applications@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":38},"Microsoft.Batch/batchAccounts/certificates@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":56},"Microsoft.Batch/batchAccounts/pools@2018-12-01":{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":165},"Microsoft.Batch/batchAccounts@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":27},"Microsoft.Batch/batchAccounts/applications/versions@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":35},"Microsoft.Batch/batchAccounts/applications@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":40},"Microsoft.Batch/batchAccounts/certificates@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":58},"Microsoft.Batch/batchAccounts/pools@2019-04-01":{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":167},"Microsoft.Batch/batchAccounts@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":27},"Microsoft.Batch/batchAccounts/applications/versions@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":35},"Microsoft.Batch/batchAccounts/applications@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":40},"Microsoft.Batch/batchAccounts/certificates@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":58},"Microsoft.Batch/batchAccounts/pools@2019-08-01":{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":178},"Microsoft.Batch/batchAccounts@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":49},"Microsoft.Batch/batchAccounts/applications/versions@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":57},"Microsoft.Batch/batchAccounts/applications@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":62},"Microsoft.Batch/batchAccounts/certificates@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":80},"Microsoft.Batch/batchAccounts/pools@2020-03-01":{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":210},"Microsoft.Batch/batchAccounts@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":53},"Microsoft.Batch/batchAccounts/applications/versions@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":61},"Microsoft.Batch/batchAccounts/applications@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":66},"Microsoft.Batch/batchAccounts/certificates@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":84},"Microsoft.Batch/batchAccounts/pools@2020-05-01":{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":214},"Microsoft.Batch/batchAccounts@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":53},"Microsoft.Batch/batchAccounts/applications/versions@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":61},"Microsoft.Batch/batchAccounts/applications@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":66},"Microsoft.Batch/batchAccounts/certificates@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":84},"Microsoft.Batch/batchAccounts/pools@2020-09-01":{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":214},"Microsoft.Batch/batchAccounts@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":56},"Microsoft.Batch/batchAccounts/applications/versions@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":64},"Microsoft.Batch/batchAccounts/applications@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":69},"Microsoft.Batch/batchAccounts/certificates@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":87},"Microsoft.Batch/batchAccounts/pools@2021-01-01":{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":230},"Microsoft.Batch/batchAccounts@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":65},"Microsoft.Batch/batchAccounts/applications/versions@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":73},"Microsoft.Batch/batchAccounts/applications@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":78},"Microsoft.Batch/batchAccounts/certificates@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":96},"Microsoft.Batch/batchAccounts/pools@2021-06-01":{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":241},"Microsoft.Batch/batchAccounts@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":65},"Microsoft.Batch/batchAccounts/applications/versions@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":73},"Microsoft.Batch/batchAccounts/applications@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":78},"Microsoft.Batch/batchAccounts/certificates@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":96},"Microsoft.Batch/batchAccounts/pools@2022-01-01":{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":244},"Microsoft.BatchAI/clusters@2017-09-01-preview":{"RelativePath":"batchai/microsoft.batchai/2017-09-01-preview/types.json","Index":56},"Microsoft.BatchAI/jobs@2017-09-01-preview":{"RelativePath":"batchai/microsoft.batchai/2017-09-01-preview/types.json","Index":103},"Microsoft.BatchAI/fileServers@2017-09-01-preview":{"RelativePath":"batchai/microsoft.batchai/2017-09-01-preview/types.json","Index":129},"Microsoft.BatchAI/clusters@2018-03-01":{"RelativePath":"batchai/microsoft.batchai/2018-03-01/types.json","Index":60},"Microsoft.BatchAI/jobs@2018-03-01":{"RelativePath":"batchai/microsoft.batchai/2018-03-01/types.json","Index":109},"Microsoft.BatchAI/fileServers@2018-03-01":{"RelativePath":"batchai/microsoft.batchai/2018-03-01/types.json","Index":135},"Microsoft.BatchAI/workspaces@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":18},"Microsoft.BatchAI/workspaces/experiments@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":28},"Microsoft.BatchAI/workspaces/experiments/jobs@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":96},"Microsoft.BatchAI/workspaces/fileServers@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":112},"Microsoft.BatchAI/workspaces/clusters@2018-05-01":{"RelativePath":"batchai/microsoft.batchai/2018-05-01/types.json","Index":145},"Microsoft.Billing/billingAccounts/billingProfiles@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":20},"Microsoft.Billing/billingAccounts/invoiceSections@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":24},"Microsoft.Billing/billingAccounts/billingProfiles/policies@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":30},"Microsoft.Billing/billingAccounts/lineOfCredit@2018-11-01-preview":{"RelativePath":"billing/microsoft.billing/2018-11-01-preview/types.json","Index":40},"Microsoft.Billing/billingAccounts/billingProfiles/instructions@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":12},"Microsoft.Billing/billingAccounts/billingProfiles@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":53},"Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":57},"Microsoft.Billing/billingAccounts/billingProfiles/policies@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":73},"Microsoft.Billing/billingAccounts/customers/policies@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":82},"Microsoft.Billing/billingAccounts/billingRoleAssignments@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":87},"Microsoft.Billing/billingAccounts/departments/billingRoleAssignments@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":91},"Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments@2019-10-01-preview":{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":95},"Microsoft.Billing/billingAccounts/billingProfiles/instructions@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":12},"Microsoft.Billing/billingAccounts/billingProfiles@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":56},"Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":60},"Microsoft.Billing/billingAccounts/billingProfiles/policies@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":76},"Microsoft.Billing/billingAccounts/customers/policies@2020-05-01":{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":85},"Microsoft.Billing/promotions@2020-09-01-preview":{"RelativePath":"billing/microsoft.billing/2020-09-01-preview/types.json","Index":14},"Microsoft.Billing/promotions@2020-11-01-preview":{"RelativePath":"billing/microsoft.billing/2020-11-01-preview/types.json","Index":14},"Microsoft.Billing/billingAccounts/billingSubscriptionAliases@2021-10-01":{"RelativePath":"billing/microsoft.billing/2021-10-01/types.json","Index":40},"Microsoft.Blockchain/blockchainMembers@2018-06-01-preview":{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":29},"Microsoft.Blockchain/blockchainMembers/transactionNodes@2018-06-01-preview":{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":41},"Microsoft.Blueprint/blueprints@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":31},"Microsoft.Blueprint/blueprints/artifacts@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":50},"Microsoft.Blueprint/blueprints/versions@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":60},"Microsoft.Blueprint/blueprintAssignments@2017-11-11-preview":{"RelativePath":"blueprint/microsoft.blueprint/2017-11-11-preview/types.json","Index":89},"Microsoft.Blueprint/blueprints@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":32},"Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":53},"Microsoft.Blueprint/blueprints/versions@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":63},"Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview":{"RelativePath":"blueprint/microsoft.blueprint/2018-11-01-preview/types.json","Index":98},"Microsoft.BotService/botServices@2017-12-01":{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":28},"Microsoft.BotService/botServices/channels@2017-12-01":{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":86},"Microsoft.BotService/botServices/Connections@2017-12-01":{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":99},"Microsoft.BotService/botServices@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":28},"Microsoft.BotService/botServices/channels@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":87},"Microsoft.BotService/botServices/Connections@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":100},"Microsoft.BotService/enterpriseChannels@2018-07-12":{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":135},"Microsoft.BotService/botServices@2020-06-02":{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":28},"Microsoft.BotService/botServices/channels@2020-06-02":{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":101},"Microsoft.BotService/botServices/connections@2020-06-02":{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":114},"Microsoft.BotService/botServices@2021-03-01":{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":39},"Microsoft.BotService/botServices/channels@2021-03-01":{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":114},"Microsoft.BotService/botServices/connections@2021-03-01":{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":129},"Microsoft.BotService/botServices@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":53},"Microsoft.BotService/botServices/channels@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":129},"Microsoft.BotService/botServices/connections@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":144},"Microsoft.BotService/botServices/privateEndpointConnections@2021-05-01-preview":{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":148},"Microsoft.Cdn/profiles@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":26},"Microsoft.Cdn/profiles/endpoints@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":52},"Microsoft.Cdn/profiles/endpoints/origins@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":65},"Microsoft.Cdn/profiles/endpoints/customDomains@2015-06-01":{"RelativePath":"cdn/microsoft.cdn/2015-06-01/types.json","Index":78},"Microsoft.Cdn/profiles@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":28},"Microsoft.Cdn/profiles/endpoints@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":54},"Microsoft.Cdn/profiles/endpoints/origins@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":67},"Microsoft.Cdn/profiles/endpoints/customDomains@2016-04-02":{"RelativePath":"cdn/microsoft.cdn/2016-04-02/types.json","Index":80},"Microsoft.Cdn/profiles@2016-10-02":{"RelativePath":"cdn/microsoft.cdn/2016-10-02/types.json","Index":25},"Microsoft.Cdn/profiles/endpoints@2016-10-02":{"RelativePath":"cdn/microsoft.cdn/2016-10-02/types.json","Index":59},"Microsoft.Cdn/profiles/endpoints/customDomains@2016-10-02":{"RelativePath":"cdn/microsoft.cdn/2016-10-02/types.json","Index":75},"Microsoft.Cdn/profiles@2017-04-02":{"RelativePath":"cdn/microsoft.cdn/2017-04-02/types.json","Index":25},"Microsoft.Cdn/profiles/endpoints@2017-04-02":{"RelativePath":"cdn/microsoft.cdn/2017-04-02/types.json","Index":59},"Microsoft.Cdn/profiles/endpoints/customDomains@2017-04-02":{"RelativePath":"cdn/microsoft.cdn/2017-04-02/types.json","Index":85},"Microsoft.Cdn/profiles@2017-10-12":{"RelativePath":"cdn/microsoft.cdn/2017-10-12/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2017-10-12":{"RelativePath":"cdn/microsoft.cdn/2017-10-12/types.json","Index":93},"Microsoft.Cdn/profiles/endpoints/customDomains@2017-10-12":{"RelativePath":"cdn/microsoft.cdn/2017-10-12/types.json","Index":119},"Microsoft.Cdn/profiles@2019-04-15":{"RelativePath":"cdn/microsoft.cdn/2019-04-15/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-04-15":{"RelativePath":"cdn/microsoft.cdn/2019-04-15/types.json","Index":408},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-04-15":{"RelativePath":"cdn/microsoft.cdn/2019-04-15/types.json","Index":459},"Microsoft.Cdn/profiles@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":365},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":416},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2019-06-15-preview":{"RelativePath":"cdn/microsoft.cdn/2019-06-15-preview/types.json","Index":521},"Microsoft.Cdn/profiles@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":409},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":460},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2019-06-15":{"RelativePath":"cdn/microsoft.cdn/2019-06-15/types.json","Index":565},"Microsoft.Cdn/profiles@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":434},"Microsoft.Cdn/profiles/endpoints/origins@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":443},"Microsoft.Cdn/profiles/endpoints/originGroups@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":453},"Microsoft.Cdn/profiles/endpoints/customDomains@2019-12-31":{"RelativePath":"cdn/microsoft.cdn/2019-12-31/types.json","Index":504},"Microsoft.Cdn/profiles@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":27},"Microsoft.Cdn/profiles/endpoints@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":449},"Microsoft.Cdn/profiles/endpoints/origins@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":464},"Microsoft.Cdn/profiles/endpoints/originGroups@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":474},"Microsoft.Cdn/profiles/endpoints/customDomains@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":525},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2020-04-15":{"RelativePath":"cdn/microsoft.cdn/2020-04-15/types.json","Index":630},"Microsoft.Cdn/profiles@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":45},"Microsoft.Cdn/profiles/endpoints@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":480},"Microsoft.Cdn/profiles/endpoints/origins@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":495},"Microsoft.Cdn/profiles/endpoints/originGroups@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":505},"Microsoft.Cdn/profiles/endpoints/customDomains@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":556},"Microsoft.Cdn/profiles/customDomains@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":587},"Microsoft.Cdn/profiles/afdEndpoints@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":607},"Microsoft.Cdn/profiles/originGroups@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":627},"Microsoft.Cdn/profiles/originGroups/origins@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":653},"Microsoft.Cdn/profiles/afdEndpoints/routes@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":695},"Microsoft.Cdn/profiles/ruleSets@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":711},"Microsoft.Cdn/profiles/ruleSets/rules@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":732},"Microsoft.Cdn/profiles/securityPolicies@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":755},"Microsoft.Cdn/profiles/secrets@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":779},"Microsoft.Cdn/CdnWebApplicationFirewallPolicies@2020-09-01":{"RelativePath":"cdn/microsoft.cdn/2020-09-01/types.json","Index":884},"Microsoft.Cdn/profiles/customDomains@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":54},"Microsoft.Cdn/profiles/afdEndpoints@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":79},"Microsoft.Cdn/profiles/originGroups@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":108},"Microsoft.Cdn/profiles/originGroups/origins@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":134},"Microsoft.Cdn/profiles/afdEndpoints/routes@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":179},"Microsoft.Cdn/profiles/ruleSets@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":195},"Microsoft.Cdn/profiles/ruleSets/rules@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":744},"Microsoft.Cdn/profiles/securityPolicies@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":767},"Microsoft.Cdn/profiles/secrets@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":793},"Microsoft.Cdn/profiles@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":819},"Microsoft.Cdn/profiles/endpoints@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":930},"Microsoft.Cdn/profiles/endpoints/origins@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":945},"Microsoft.Cdn/profiles/endpoints/originGroups@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":955},"Microsoft.Cdn/profiles/endpoints/customDomains@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":981},"Microsoft.Cdn/cdnWebApplicationFirewallPolicies@2021-06-01":{"RelativePath":"cdn/microsoft.cdn/2021-06-01/types.json","Index":1079},"Microsoft.ChangeAnalysis/profile@2020-04-01-preview":{"RelativePath":"changeanalysis/microsoft.changeanalysis/2020-04-01-preview/types.json","Index":27},"Microsoft.Chaos/targets/capabilities@2021-09-15-preview":{"RelativePath":"chaos/microsoft.chaos/2021-09-15-preview/types.json","Index":23},"Microsoft.Chaos/experiments@2021-09-15-preview":{"RelativePath":"chaos/microsoft.chaos/2021-09-15-preview/types.json","Index":58},"Microsoft.Chaos/targets@2021-09-15-preview":{"RelativePath":"chaos/microsoft.chaos/2021-09-15-preview/types.json","Index":63},"Microsoft.Portal/locations/userSettings@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":30},"Microsoft.Portal/locations/consoles@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":48},"Microsoft.Portal/userSettings@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":52},"Microsoft.Portal/consoles@2018-10-01":{"RelativePath":"cloudshell/microsoft.portal/2018-10-01/types.json","Index":70},"Microsoft.CognitiveServices/accounts@2016-02-01-preview":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.json","Index":47},"Microsoft.CognitiveServices/accounts@2017-04-18":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.json","Index":66},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2017-04-18":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.json","Index":70},"Microsoft.CognitiveServices/accounts@2021-04-30":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.json","Index":93},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2021-04-30":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.json","Index":97},"Microsoft.CognitiveServices/accounts@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":93},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":97},"Microsoft.CognitiveServices/accounts/deployments@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":113},"Microsoft.CognitiveServices/accounts/commitmentPlans@2021-10-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":124},"Microsoft.CognitiveServices/accounts@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":93},"Microsoft.CognitiveServices/accounts/privateEndpointConnections@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":97},"Microsoft.CognitiveServices/accounts/deployments@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":113},"Microsoft.CognitiveServices/accounts/commitmentPlans@2022-03-01":{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":124},"Microsoft.Communication/communicationServices@2020-08-20-preview":{"RelativePath":"communication/microsoft.communication/2020-08-20-preview/types.json","Index":23},"Microsoft.Communication/communicationServices@2020-08-20":{"RelativePath":"communication/microsoft.communication/2020-08-20/types.json","Index":34},"Microsoft.Compute/availabilitySets@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":21},"Microsoft.Compute/virtualMachines/extensions@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":30},"Microsoft.Compute/virtualMachines@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":162},"Microsoft.Compute/virtualMachineScaleSets@2015-06-15":{"RelativePath":"compute/microsoft.compute/2015-06-15/types.json","Index":204},"Microsoft.Compute/availabilitySets@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":21},"Microsoft.Compute/virtualMachines/extensions@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":30},"Microsoft.Compute/virtualMachines@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":175},"Microsoft.Compute/virtualMachineScaleSets@2016-03-30":{"RelativePath":"compute/microsoft.compute/2016-03-30/types.json","Index":220},"Microsoft.Compute/availabilitySets@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":22},"Microsoft.Compute/virtualMachines/extensions@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":31},"Microsoft.Compute/virtualMachines@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":180},"Microsoft.Compute/images@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":204},"Microsoft.Compute/virtualMachineScaleSets@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":262},"Microsoft.Compute/disks@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":287},"Microsoft.Compute/snapshots@2016-04-30-preview":{"RelativePath":"compute/microsoft.compute/2016-04-30-preview/types.json","Index":292},"Microsoft.Compute/disks@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":33},"Microsoft.Compute/snapshots@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":38},"Microsoft.Compute/availabilitySets@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":53},"Microsoft.Compute/virtualMachines/extensions@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":62},"Microsoft.Compute/virtualMachines@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":253},"Microsoft.Compute/images@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":283},"Microsoft.Compute/virtualMachineScaleSets@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":352},"Microsoft.Compute/virtualMachineScaleSets/extensions@2017-03-30":{"RelativePath":"compute/microsoft.compute/2017-03-30/types.json","Index":356},"Microsoft.Compute/availabilitySets@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":22},"Microsoft.Compute/virtualMachines/extensions@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":31},"Microsoft.Compute/virtualMachines@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":296},"Microsoft.Compute/images@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":326},"Microsoft.Compute/virtualMachineScaleSets@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":407},"Microsoft.Compute/virtualMachineScaleSets/extensions@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":411},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2017-12-01":{"RelativePath":"compute/microsoft.compute/2017-12-01/types.json","Index":423},"Microsoft.Compute/availabilitySets@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":34},"Microsoft.Compute/virtualMachines/extensions@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":43},"Microsoft.Compute/virtualMachines@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":309},"Microsoft.Compute/images@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":341},"Microsoft.Compute/virtualMachineScaleSets@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":425},"Microsoft.Compute/virtualMachineScaleSets/extensions@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":429},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":442},"Microsoft.Compute/disks@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":470},"Microsoft.Compute/snapshots@2018-04-01":{"RelativePath":"compute/microsoft.compute/2018-04-01/types.json","Index":480},"Microsoft.Compute/galleries@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":21},"Microsoft.Compute/galleries/images@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":46},"Microsoft.Compute/galleries/images/versions@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":89},"Microsoft.Compute/disks@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":118},"Microsoft.Compute/snapshots@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":132},"Microsoft.Compute/availabilitySets@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":147},"Microsoft.Compute/proximityPlacementGroups@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":159},"Microsoft.Compute/virtualMachines/extensions@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":168},"Microsoft.Compute/virtualMachines@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":440},"Microsoft.Compute/images@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":474},"Microsoft.Compute/virtualMachineScaleSets@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":562},"Microsoft.Compute/virtualMachineScaleSets/extensions@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":566},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2018-06-01":{"RelativePath":"compute/microsoft.compute/2018-06-01/types.json","Index":579},"Microsoft.Compute/disks@2018-09-30":{"RelativePath":"compute/microsoft.compute/2018-09-30/types.json","Index":49},"Microsoft.Compute/snapshots@2018-09-30":{"RelativePath":"compute/microsoft.compute/2018-09-30/types.json","Index":66},"Microsoft.Compute/availabilitySets@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":34},"Microsoft.Compute/virtualMachines/extensions@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":43},"Microsoft.Compute/virtualMachines@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":315},"Microsoft.Compute/images@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":349},"Microsoft.Compute/virtualMachineScaleSets@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":438},"Microsoft.Compute/virtualMachineScaleSets/extensions@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":442},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2018-10-01":{"RelativePath":"compute/microsoft.compute/2018-10-01/types.json","Index":455},"Microsoft.Compute/availabilitySets@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":34},"Microsoft.Compute/hostGroups@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":43},"Microsoft.Compute/hostGroups/hosts@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":59},"Microsoft.Compute/virtualMachines/extensions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":68},"Microsoft.Compute/virtualMachines@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":351},"Microsoft.Compute/images@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":388},"Microsoft.Compute/virtualMachineScaleSets@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":486},"Microsoft.Compute/virtualMachineScaleSets/extensions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":490},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":506},"Microsoft.Compute/disks@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":548},"Microsoft.Compute/snapshots@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":565},"Microsoft.Compute/galleries@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":579},"Microsoft.Compute/galleries/images@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":604},"Microsoft.Compute/galleries/images/versions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":653},"Microsoft.Compute/galleries/applications@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":662},"Microsoft.Compute/galleries/applications/versions@2019-03-01":{"RelativePath":"compute/microsoft.compute/2019-03-01/types.json","Index":682},"Microsoft.Compute/availabilitySets@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":44},"Microsoft.Compute/hostGroups/hosts@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":60},"Microsoft.Compute/virtualMachines/extensions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":69},"Microsoft.Compute/virtualMachines@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":353},"Microsoft.Compute/images@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":390},"Microsoft.Compute/virtualMachineScaleSets@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":491},"Microsoft.Compute/virtualMachineScaleSets/extensions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":495},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":500},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":516},"Microsoft.Compute/galleries@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":530},"Microsoft.Compute/galleries/images@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":558},"Microsoft.Compute/galleries/images/versions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":606},"Microsoft.Compute/galleries/applications@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":615},"Microsoft.Compute/galleries/applications/versions@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":635},"Microsoft.Compute/disks@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":681},"Microsoft.Compute/snapshots@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":698},"Microsoft.Compute/diskEncryptionSets@2019-07-01":{"RelativePath":"compute/microsoft.compute/2019-07-01/types.json","Index":708},"Microsoft.Compute/disks@2019-11-01":{"RelativePath":"compute/microsoft.compute/2019-11-01/types.json","Index":56},"Microsoft.Compute/snapshots@2019-11-01":{"RelativePath":"compute/microsoft.compute/2019-11-01/types.json","Index":73},"Microsoft.Compute/diskEncryptionSets@2019-11-01":{"RelativePath":"compute/microsoft.compute/2019-11-01/types.json","Index":83},"Microsoft.Compute/galleries@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":21},"Microsoft.Compute/galleries/images@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":49},"Microsoft.Compute/galleries/images/versions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":103},"Microsoft.Compute/galleries/applications@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":112},"Microsoft.Compute/galleries/applications/versions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":133},"Microsoft.Compute/availabilitySets@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":148},"Microsoft.Compute/proximityPlacementGroups@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":161},"Microsoft.Compute/hostGroups@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":170},"Microsoft.Compute/hostGroups/hosts@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":186},"Microsoft.Compute/sshPublicKeys@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":192},"Microsoft.Compute/virtualMachines/extensions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":201},"Microsoft.Compute/virtualMachines@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":488},"Microsoft.Compute/images@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":525},"Microsoft.Compute/virtualMachineScaleSets@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":626},"Microsoft.Compute/virtualMachineScaleSets/extensions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":630},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":635},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2019-12-01":{"RelativePath":"compute/microsoft.compute/2019-12-01/types.json","Index":651},"Microsoft.Compute/disks@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":61},"Microsoft.Compute/snapshots@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":82},"Microsoft.Compute/diskEncryptionSets@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":96},"Microsoft.Compute/diskAccesses@2020-05-01":{"RelativePath":"compute/microsoft.compute/2020-05-01/types.json","Index":116},"Microsoft.Compute/availabilitySets@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":51},"Microsoft.Compute/hostGroups/hosts@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":64},"Microsoft.Compute/sshPublicKeys@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":70},"Microsoft.Compute/virtualMachines/extensions@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":79},"Microsoft.Compute/virtualMachines@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":396},"Microsoft.Compute/images@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":433},"Microsoft.Compute/virtualMachineScaleSets@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":534},"Microsoft.Compute/virtualMachineScaleSets/extensions@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":538},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":542},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":557},"Microsoft.Compute/virtualMachines/runCommands@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":577},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2020-06-01":{"RelativePath":"compute/microsoft.compute/2020-06-01/types.json","Index":582},"Microsoft.Compute/disks@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":61},"Microsoft.Compute/snapshots@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":89},"Microsoft.Compute/diskEncryptionSets@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":102},"Microsoft.Compute/diskAccesses@2020-06-30":{"RelativePath":"compute/microsoft.compute/2020-06-30/types.json","Index":122},"Microsoft.Compute/galleries@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":31},"Microsoft.Compute/galleries/images@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":61},"Microsoft.Compute/galleries/images/versions@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":115},"Microsoft.Compute/galleries/applications@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":124},"Microsoft.Compute/galleries/applications/versions@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":145},"Microsoft.Compute/disks@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":203},"Microsoft.Compute/snapshots@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":231},"Microsoft.Compute/diskEncryptionSets@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":246},"Microsoft.Compute/diskAccesses@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":266},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2020-09-30":{"RelativePath":"compute/microsoft.compute/2020-09-30/types.json","Index":270},"Microsoft.Compute/cloudServices@2020-10-01-preview":{"RelativePath":"compute/microsoft.compute/2020-10-01-preview/types.json","Index":40},"Microsoft.Compute/cloudServices/updateDomains@2020-10-01-preview":{"RelativePath":"compute/microsoft.compute/2020-10-01-preview/types.json","Index":44},"Microsoft.Compute/disks@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":71},"Microsoft.Compute/snapshots@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":99},"Microsoft.Compute/diskEncryptionSets@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":114},"Microsoft.Compute/diskAccesses@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":134},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":138},"Microsoft.Compute/availabilitySets@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":153},"Microsoft.Compute/proximityPlacementGroups@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":166},"Microsoft.Compute/hostGroups@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":182},"Microsoft.Compute/hostGroups/hosts@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":195},"Microsoft.Compute/sshPublicKeys@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":201},"Microsoft.Compute/virtualMachines/extensions@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":210},"Microsoft.Compute/virtualMachines@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":535},"Microsoft.Compute/virtualMachineScaleSets@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":641},"Microsoft.Compute/images@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":682},"Microsoft.Compute/virtualMachineScaleSets/extensions@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":686},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":690},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":705},"Microsoft.Compute/virtualMachines/runCommands@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":725},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2020-12-01":{"RelativePath":"compute/microsoft.compute/2020-12-01/types.json","Index":730},"Microsoft.Compute/cloudServices@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":40},"Microsoft.Compute/cloudServices/updateDomains@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":44},"Microsoft.Compute/availabilitySets@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":58},"Microsoft.Compute/proximityPlacementGroups@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":71},"Microsoft.Compute/hostGroups@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":87},"Microsoft.Compute/hostGroups/hosts@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":100},"Microsoft.Compute/sshPublicKeys@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":106},"Microsoft.Compute/virtualMachines/extensions@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":115},"Microsoft.Compute/virtualMachines@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":500},"Microsoft.Compute/virtualMachineScaleSets@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":612},"Microsoft.Compute/images@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":653},"Microsoft.Compute/restorePointCollections@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":684},"Microsoft.Compute/restorePointCollections/restorePoints@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":688},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":692},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":696},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":711},"Microsoft.Compute/virtualMachines/runCommands@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":731},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-03-01":{"RelativePath":"compute/microsoft.compute/2021-03-01/types.json","Index":736},"Microsoft.Compute/disks@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":78},"Microsoft.Compute/snapshots@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":111},"Microsoft.Compute/diskEncryptionSets@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":130},"Microsoft.Compute/diskAccesses@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":150},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":154},"Microsoft.Compute/availabilitySets@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":169},"Microsoft.Compute/proximityPlacementGroups@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":182},"Microsoft.Compute/hostGroups@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":198},"Microsoft.Compute/hostGroups/hosts@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":211},"Microsoft.Compute/sshPublicKeys@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":217},"Microsoft.Compute/virtualMachines/extensions@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":226},"Microsoft.Compute/virtualMachines@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":605},"Microsoft.Compute/virtualMachineScaleSets@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":718},"Microsoft.Compute/images@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":759},"Microsoft.Compute/restorePointCollections@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":790},"Microsoft.Compute/restorePointCollections/restorePoints@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":794},"Microsoft.Compute/capacityReservationGroups@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":809},"Microsoft.Compute/capacityReservationGroups/capacityReservations@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":819},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":823},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":827},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":842},"Microsoft.Compute/virtualMachines/runCommands@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":862},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-04-01":{"RelativePath":"compute/microsoft.compute/2021-04-01/types.json","Index":867},"Microsoft.Compute/availabilitySets@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":51},"Microsoft.Compute/hostGroups/hosts@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":64},"Microsoft.Compute/sshPublicKeys@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":70},"Microsoft.Compute/virtualMachines/extensions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":79},"Microsoft.Compute/virtualMachines@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":469},"Microsoft.Compute/virtualMachineScaleSets@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":582},"Microsoft.Compute/images@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":623},"Microsoft.Compute/restorePointCollections@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":654},"Microsoft.Compute/restorePointCollections/restorePoints@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":658},"Microsoft.Compute/capacityReservationGroups@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":673},"Microsoft.Compute/capacityReservationGroups/capacityReservations@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":683},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":687},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":691},"Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":706},"Microsoft.Compute/virtualMachines/runCommands@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":726},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":731},"Microsoft.Compute/galleries@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":756},"Microsoft.Compute/galleries/images@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":786},"Microsoft.Compute/galleries/images/versions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":843},"Microsoft.Compute/galleries/applications@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":852},"Microsoft.Compute/galleries/applications/versions@2021-07-01":{"RelativePath":"compute/microsoft.compute/2021-07-01/types.json","Index":876},"Microsoft.Compute/disks@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":83},"Microsoft.Compute/snapshots@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":116},"Microsoft.Compute/diskEncryptionSets@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":136},"Microsoft.Compute/diskAccesses@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":156},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2021-08-01":{"RelativePath":"compute/microsoft.compute/2021-08-01/types.json","Index":160},"Microsoft.Compute/galleries@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":46},"Microsoft.Compute/galleries/images@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":79},"Microsoft.Compute/galleries/images/versions@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":151},"Microsoft.Compute/galleries/applications@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":160},"Microsoft.Compute/galleries/applications/versions@2021-10-01":{"RelativePath":"compute/microsoft.compute/2021-10-01/types.json","Index":185},"Microsoft.Compute/availabilitySets@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":22},"Microsoft.Compute/proximityPlacementGroups@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":35},"Microsoft.Compute/hostGroups@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":51},"Microsoft.Compute/hostGroups/hosts@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":64},"Microsoft.Compute/sshPublicKeys@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":70},"Microsoft.Compute/virtualMachines/extensions@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":79},"Microsoft.Compute/virtualMachines@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":474},"Microsoft.Compute/virtualMachineScaleSets@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":592},"Microsoft.Compute/images@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":633},"Microsoft.Compute/restorePointCollections@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":668},"Microsoft.Compute/restorePointCollections/restorePoints@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":672},"Microsoft.Compute/capacityReservationGroups@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":687},"Microsoft.Compute/capacityReservationGroups/capacityReservations@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":697},"Microsoft.Compute/virtualMachineScaleSets/extensions@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":701},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":705},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":720},"Microsoft.Compute/virtualMachines/runCommands@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":740},"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01":{"RelativePath":"compute/microsoft.compute/2021-11-01/types.json","Index":745},"Microsoft.Compute/disks@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":89},"Microsoft.Compute/snapshots@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":125},"Microsoft.Compute/diskEncryptionSets@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":145},"Microsoft.Compute/diskAccesses@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":165},"Microsoft.Compute/diskAccesses/privateEndpointConnections@2021-12-01":{"RelativePath":"compute/microsoft.compute/2021-12-01/types.json","Index":169},"Microsoft.ContainerService/containerServices@2015-11-01-preview":{"RelativePath":"compute/microsoft.containerservice/2015-11-01-preview/types.json","Index":76},"Microsoft.ContainerService/containerServices@2016-03-30":{"RelativePath":"compute/microsoft.containerservice/2016-03-30/types.json","Index":75},"Microsoft.ContainerService/containerServices@2016-09-30":{"RelativePath":"compute/microsoft.containerservice/2016-09-30/types.json","Index":79},"Microsoft.ContainerService/containerServices@2017-01-31":{"RelativePath":"compute/microsoft.containerservice/2017-01-31/types.json","Index":79},"Microsoft.ConfidentialLedger/ledgers@2020-12-01-preview":{"RelativePath":"confidentialledger/microsoft.confidentialledger/2020-12-01-preview/types.json","Index":48},"Microsoft.ConfidentialLedger/ledgers@2021-05-13-preview":{"RelativePath":"confidentialledger/microsoft.confidentialledger/2021-05-13-preview/types.json","Index":48},"Microsoft.Confluent/agreements@2020-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2020-03-01-preview/types.json","Index":13},"Microsoft.Confluent/organizations@2020-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2020-03-01-preview/types.json","Index":42},"Microsoft.Confluent/agreements@2020-03-01":{"RelativePath":"confluent/microsoft.confluent/2020-03-01/types.json","Index":13},"Microsoft.Confluent/organizations@2020-03-01":{"RelativePath":"confluent/microsoft.confluent/2020-03-01/types.json","Index":42},"Microsoft.Confluent/agreements@2021-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-03-01-preview/types.json","Index":24},"Microsoft.Confluent/organizations@2021-03-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-03-01-preview/types.json","Index":53},"Microsoft.Confluent/agreements@2021-09-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-09-01-preview/types.json","Index":24},"Microsoft.Confluent/organizations@2021-09-01-preview":{"RelativePath":"confluent/microsoft.confluent/2021-09-01-preview/types.json","Index":53},"Microsoft.Confluent/agreements@2021-12-01":{"RelativePath":"confluent/microsoft.confluent/2021-12-01/types.json","Index":24},"Microsoft.Confluent/organizations@2021-12-01":{"RelativePath":"confluent/microsoft.confluent/2021-12-01/types.json","Index":53},"Microsoft.ConnectedVMwarevSphere/resourcePools@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":27},"Microsoft.ConnectedVMwarevSphere/clusters@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":36},"Microsoft.ConnectedVMwarevSphere/hosts@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":43},"Microsoft.ConnectedVMwarevSphere/datastores@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":59},"Microsoft.ConnectedVMwarevSphere/vcenters@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":67},"Microsoft.ConnectedVMwarevSphere/virtualMachines@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":148},"Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":164},"Microsoft.ConnectedVMwarevSphere/virtualNetworks@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":171},"Microsoft.ConnectedVMwarevSphere/vcenters/inventoryItems@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":200},"Microsoft.ConnectedVMwarevSphere/virtualMachines/hybridIdentityMetadata@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":205},"Microsoft.ConnectedVMwarevSphere/virtualMachines/extensions@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":217},"Microsoft.ConnectedVMwarevSphere/virtualMachines/guestAgents@2020-10-01-preview":{"RelativePath":"connectedvmware/microsoft.connectedvmwarevsphere/2020-10-01-preview/types.json","Index":229},"Microsoft.Consumption/budgets@2017-12-30-preview":{"RelativePath":"consumption/microsoft.consumption/2017-12-30-preview/types.json","Index":28},"Microsoft.Consumption/budgets@2018-01-31":{"RelativePath":"consumption/microsoft.consumption/2018-01-31/types.json","Index":34},"Microsoft.Consumption/budgets@2018-03-31":{"RelativePath":"consumption/microsoft.consumption/2018-03-31/types.json","Index":36},"Microsoft.Consumption/budgets@2018-06-30":{"RelativePath":"consumption/microsoft.consumption/2018-06-30/types.json","Index":36},"Microsoft.Consumption/budgets@2018-08-31":{"RelativePath":"consumption/microsoft.consumption/2018-08-31/types.json","Index":36},"Microsoft.Consumption/budgets@2018-10-01":{"RelativePath":"consumption/microsoft.consumption/2018-10-01/types.json","Index":36},"Microsoft.Consumption/budgets@2019-01-01":{"RelativePath":"consumption/microsoft.consumption/2019-01-01/types.json","Index":39},"Microsoft.Consumption/budgets@2019-04-01-preview":{"RelativePath":"consumption/microsoft.consumption/2019-04-01-preview/types.json","Index":36},"Microsoft.Consumption/budgets@2019-05-01-preview":{"RelativePath":"consumption/microsoft.consumption/2019-05-01-preview/types.json","Index":36},"Microsoft.Consumption/budgets@2019-05-01":{"RelativePath":"consumption/microsoft.consumption/2019-05-01/types.json","Index":41},"Microsoft.Consumption/budgets@2019-06-01":{"RelativePath":"consumption/microsoft.consumption/2019-06-01/types.json","Index":39},"Microsoft.Consumption/budgets@2019-10-01":{"RelativePath":"consumption/microsoft.consumption/2019-10-01/types.json","Index":64},"Microsoft.Consumption/budgets@2019-11-01":{"RelativePath":"consumption/microsoft.consumption/2019-11-01/types.json","Index":43},"Microsoft.Consumption/budgets@2021-05-01":{"RelativePath":"consumption/microsoft.consumption/2021-05-01/types.json","Index":42},"Microsoft.Consumption/budgets@2021-10-01":{"RelativePath":"consumption/microsoft.consumption/2021-10-01/types.json","Index":65},"Microsoft.ContainerInstance/containerGroups@2017-08-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2017-08-01-preview/types.json","Index":48},"Microsoft.ContainerInstance/containerGroups@2017-10-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2017-10-01-preview/types.json","Index":55},"Microsoft.ContainerInstance/containerGroups@2017-12-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2017-12-01-preview/types.json","Index":57},"Microsoft.ContainerInstance/containerGroups@2018-02-01-preview":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-02-01-preview/types.json","Index":57},"Microsoft.ContainerInstance/containerGroups@2018-04-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-04-01/types.json","Index":57},"Microsoft.ContainerInstance/containerGroups@2018-06-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-06-01/types.json","Index":66},"Microsoft.ContainerInstance/containerGroups@2018-09-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-09-01/types.json","Index":72},"Microsoft.ContainerInstance/containerGroups@2018-10-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2018-10-01/types.json","Index":87},"Microsoft.ContainerInstance/containerGroups@2019-12-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2019-12-01/types.json","Index":99},"Microsoft.ContainerInstance/containerGroups@2020-11-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2020-11-01/types.json","Index":101},"Microsoft.ContainerInstance/containerGroups@2021-03-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-03-01/types.json","Index":101},"Microsoft.ContainerInstance/containerGroups@2021-07-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-07-01/types.json","Index":102},"Microsoft.ContainerInstance/containerGroups@2021-09-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-09-01/types.json","Index":103},"Microsoft.ContainerInstance/containerGroups@2021-10-01":{"RelativePath":"containerinstance/microsoft.containerinstance/2021-10-01/types.json","Index":109},"Microsoft.ContainerRegistry/registries@2016-06-27-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2016-06-27-preview/types.json","Index":14},"Microsoft.ContainerRegistry/registries@2017-03-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-03-01/types.json","Index":20},"Microsoft.ContainerRegistry/registries@2017-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":31},"Microsoft.ContainerRegistry/registries/replications@2017-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":44},"Microsoft.ContainerRegistry/registries/webhooks@2017-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":65},"Microsoft.ContainerRegistry/registries@2017-10-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":45},"Microsoft.ContainerRegistry/registries/replications@2017-10-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":58},"Microsoft.ContainerRegistry/registries/webhooks@2017-10-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":82},"Microsoft.ContainerRegistry/registries/buildTasks/steps@2018-02-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":35},"Microsoft.ContainerRegistry/registries/buildTasks@2018-02-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":63},"Microsoft.ContainerRegistry/registries/tasks@2018-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":89},"Microsoft.ContainerRegistry/registries/tasks@2019-04-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":103},"Microsoft.ContainerRegistry/registries/scopeMaps@2019-05-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01-preview/types.json","Index":31},"Microsoft.ContainerRegistry/registries/tokens@2019-05-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01-preview/types.json","Index":58},"Microsoft.ContainerRegistry/registries@2019-05-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":60},"Microsoft.ContainerRegistry/registries/replications@2019-05-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":73},"Microsoft.ContainerRegistry/registries/webhooks@2019-05-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":97},"Microsoft.ContainerRegistry/registries/agentPools@2019-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":34},"Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":128},"Microsoft.ContainerRegistry/registries/tasks@2019-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":193},"Microsoft.ContainerRegistry/registries/exportPipelines@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":45},"Microsoft.ContainerRegistry/registries@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":129},"Microsoft.ContainerRegistry/registries/importPipelines@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":155},"Microsoft.ContainerRegistry/registries/pipelineRuns@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":180},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":184},"Microsoft.ContainerRegistry/registries/replications@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":197},"Microsoft.ContainerRegistry/registries/webhooks@2019-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":221},"Microsoft.ContainerRegistry/registries/connectedRegistries@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":65},"Microsoft.ContainerRegistry/registries/exportPipelines@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":92},"Microsoft.ContainerRegistry/registries@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":179},"Microsoft.ContainerRegistry/registries/importPipelines@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":205},"Microsoft.ContainerRegistry/registries/pipelineRuns@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":230},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":234},"Microsoft.ContainerRegistry/registries/replications@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":250},"Microsoft.ContainerRegistry/registries/scopeMaps@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":263},"Microsoft.ContainerRegistry/registries/tokens@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":289},"Microsoft.ContainerRegistry/registries/webhooks@2020-11-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":313},"Microsoft.ContainerRegistry/registries/connectedRegistries@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":65},"Microsoft.ContainerRegistry/registries/exportPipelines@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":92},"Microsoft.ContainerRegistry/registries@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":183},"Microsoft.ContainerRegistry/registries/importPipelines@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":209},"Microsoft.ContainerRegistry/registries/pipelineRuns@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":234},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":238},"Microsoft.ContainerRegistry/registries/replications@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":254},"Microsoft.ContainerRegistry/registries/scopeMaps@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":267},"Microsoft.ContainerRegistry/registries/tokens@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":293},"Microsoft.ContainerRegistry/registries/webhooks@2021-06-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":317},"Microsoft.ContainerRegistry/registries/connectedRegistries@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":68},"Microsoft.ContainerRegistry/registries/exportPipelines@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":95},"Microsoft.ContainerRegistry/registries@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":186},"Microsoft.ContainerRegistry/registries/importPipelines@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":212},"Microsoft.ContainerRegistry/registries/pipelineRuns@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":237},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":241},"Microsoft.ContainerRegistry/registries/replications@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":257},"Microsoft.ContainerRegistry/registries/scopeMaps@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":270},"Microsoft.ContainerRegistry/registries/tokens@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":296},"Microsoft.ContainerRegistry/registries/webhooks@2021-08-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":320},"Microsoft.ContainerRegistry/registries@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":113},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":117},"Microsoft.ContainerRegistry/registries/replications@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":133},"Microsoft.ContainerRegistry/registries/webhooks@2021-09-01":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":157},"Microsoft.ContainerRegistry/registries/connectedRegistries@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":68},"Microsoft.ContainerRegistry/registries/exportPipelines@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":95},"Microsoft.ContainerRegistry/registries@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":186},"Microsoft.ContainerRegistry/registries/importPipelines@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":212},"Microsoft.ContainerRegistry/registries/pipelineRuns@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":237},"Microsoft.ContainerRegistry/registries/privateEndpointConnections@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":241},"Microsoft.ContainerRegistry/registries/replications@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":257},"Microsoft.ContainerRegistry/registries/scopeMaps@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":270},"Microsoft.ContainerRegistry/registries/tokens@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":296},"Microsoft.ContainerRegistry/registries/webhooks@2021-12-01-preview":{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":320},"Microsoft.ContainerService/containerServices@2017-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2017-07-01/types.json","Index":393},"Microsoft.ContainerService/managedClusters@2017-08-31":{"RelativePath":"containerservice/microsoft.containerservice/2017-08-31/types.json","Index":203},"Microsoft.ContainerService/managedClusters@2018-03-31":{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":211},"Microsoft.ContainerService/managedClusters@2018-08-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":211},"Microsoft.ContainerService/openShiftManagedClusters@2018-09-30-preview":{"RelativePath":"containerservice/microsoft.containerservice/2018-09-30-preview/types.json","Index":103},"Microsoft.ContainerService/managedClusters@2019-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":214},"Microsoft.ContainerService/managedClusters/agentPools@2019-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":401},"Microsoft.ContainerService/managedClusters@2019-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":222},"Microsoft.ContainerService/managedClusters/agentPools@2019-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":409},"Microsoft.ContainerService/openShiftManagedClusters@2019-04-30":{"RelativePath":"containerservice/microsoft.containerservice/2019-04-30/types.json","Index":103},"Microsoft.ContainerService/managedClusters@2019-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":229},"Microsoft.ContainerService/managedClusters/agentPools@2019-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":423},"Microsoft.ContainerService/managedClusters@2019-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":238},"Microsoft.ContainerService/managedClusters/agentPools@2019-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":432},"Microsoft.ContainerService/openShiftManagedClusters@2019-09-30-preview":{"RelativePath":"containerservice/microsoft.containerservice/2019-09-30-preview/types.json","Index":104},"Microsoft.ContainerService/managedClusters@2019-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":238},"Microsoft.ContainerService/managedClusters/agentPools@2019-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":432},"Microsoft.ContainerService/openShiftManagedClusters@2019-10-27-preview":{"RelativePath":"containerservice/microsoft.containerservice/2019-10-27-preview/types.json","Index":102},"Microsoft.ContainerService/managedClusters@2019-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":246},"Microsoft.ContainerService/managedClusters/agentPools@2019-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":442},"Microsoft.ContainerService/managedClusters@2020-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":246},"Microsoft.ContainerService/managedClusters/agentPools@2020-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":442},"Microsoft.ContainerService/managedClusters@2020-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":251},"Microsoft.ContainerService/managedClusters/agentPools@2020-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":448},"Microsoft.ContainerService/managedClusters@2020-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":261},"Microsoft.ContainerService/managedClusters/agentPools@2020-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":461},"Microsoft.ContainerService/managedClusters@2020-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":261},"Microsoft.ContainerService/managedClusters/agentPools@2020-04-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":460},"Microsoft.ContainerService/managedClusters@2020-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":264},"Microsoft.ContainerService/managedClusters/agentPools@2020-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":463},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-06-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":480},"Microsoft.ContainerService/managedClusters@2020-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":267},"Microsoft.ContainerService/managedClusters/agentPools@2020-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":466},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":483},"Microsoft.ContainerService/managedClusters@2020-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":278},"Microsoft.ContainerService/managedClusters/agentPools@2020-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":480},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":497},"Microsoft.ContainerService/managedClusters@2020-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":304},"Microsoft.ContainerService/managedClusters/agentPools@2020-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":506},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-11-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":523},"Microsoft.ContainerService/managedClusters@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":307},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":336},"Microsoft.ContainerService/managedClusters/agentPools@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":540},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2020-12-01":{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":557},"Microsoft.ContainerService/managedClusters@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":308},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":337},"Microsoft.ContainerService/managedClusters/agentPools@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":542},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":559},"Microsoft.ContainerService/managedClusters@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":151},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":180},"Microsoft.ContainerService/managedClusters/agentPools@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":219},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":236},"Microsoft.ContainerService/managedClusters@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":151},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":180},"Microsoft.ContainerService/managedClusters/agentPools@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":219},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-05-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":236},"Microsoft.ContainerService/managedClusters@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":160},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":189},"Microsoft.ContainerService/managedClusters/agentPools@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":231},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-07-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":167},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":196},"Microsoft.ContainerService/managedClusters/agentPools@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":241},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":258},"Microsoft.ContainerService/snapshots@2021-08-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":266},"Microsoft.ContainerService/managedClusters@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":168},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":197},"Microsoft.ContainerService/managedClusters/agentPools@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":242},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":259},"Microsoft.ContainerService/snapshots@2021-09-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":273},"Microsoft.ContainerService/managedClusters@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":174},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2021-10-01":{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":175},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":204},"Microsoft.ContainerService/managedClusters/agentPools@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":249},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":266},"Microsoft.ContainerService/snapshots@2021-11-01-preview":{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":280},"Microsoft.ContainerService/managedClusters@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":174},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2022-01-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":176},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":205},"Microsoft.ContainerService/managedClusters/agentPools@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":250},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":267},"Microsoft.ContainerService/snapshots@2022-01-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":281},"Microsoft.ContainerService/managedClusters@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":185},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2022-02-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":188},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":206},"Microsoft.ContainerService/managedClusters/agentPools@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":251},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":268},"Microsoft.ContainerService/snapshots@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":283},"Microsoft.ContainerService/managedclustersnapshots@2022-02-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":307},"Microsoft.ContainerService/managedClusters@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":185},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":203},"Microsoft.ContainerService/managedClusters/agentPools@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":248},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":265},"Microsoft.ContainerService/snapshots@2022-03-01":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":279},"Microsoft.ContainerService/managedClusters@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":192},"Microsoft.ContainerService/managedClusters/maintenanceConfigurations@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":210},"Microsoft.ContainerService/managedClusters/agentPools@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":255},"Microsoft.ContainerService/managedClusters/privateEndpointConnections@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":272},"Microsoft.ContainerService/snapshots@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":287},"Microsoft.ContainerService/managedclustersnapshots@2022-03-02-preview":{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":311},"Microsoft.DocumentDB/databaseAccounts@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2015-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2015-04-08":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2015-11-06":{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2016-03-19":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/apis/databases@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/apis/databases/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":102},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/apis/tables@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/apis/tables/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":138},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":152},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":167},"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings@2016-03-31":{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2019-08-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01-preview/types.json","Index":14},"Microsoft.DocumentDB/databaseAccounts@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":110},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":116},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":157},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":163},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":177},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":183},"Microsoft.DocumentDB/databaseAccounts/tables@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":191},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":197},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":205},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":226},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":232},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":240},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2019-08-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":37},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":56},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":112},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":118},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":125},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":132},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":148},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":161},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":180},"Microsoft.DocumentDB/databaseAccounts/tables@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":193},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":200},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":206},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":220},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":226},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":233},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":239},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":252},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2019-12-12":{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":45},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":64},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":120},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":126},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":133},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":140},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":156},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":163},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":182},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/tables@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":195},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":201},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":208},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":214},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":228},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":234},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":241},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":247},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-03-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":53},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":62},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":73},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":129},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":135},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":142},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":165},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":172},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":178},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":191},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":197},"Microsoft.DocumentDB/databaseAccounts/tables@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":204},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":250},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":256},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":263},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":269},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-04-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":276},"Microsoft.DocumentDB/databaseAccounts@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":101},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":112},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":168},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":181},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":204},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":222},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":229},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":248},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/tables@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":261},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":274},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":280},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":307},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":313},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":320},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":326},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-06-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":333},"Microsoft.DocumentDB/databaseAccounts@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":59},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":68},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":79},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":135},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":141},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":148},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":171},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":178},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":184},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":197},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":203},"Microsoft.DocumentDB/databaseAccounts/tables@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":216},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":229},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":249},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":256},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":262},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":269},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":275},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2020-09-01":{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":282},"Microsoft.DocumentDB/databaseAccounts@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":72},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":81},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":162},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":185},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":192},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/tables@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":230},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":257},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":263},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":270},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":276},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":283},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":289},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":296},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-01-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":97},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":106},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":117},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":180},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":194},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":228},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":241},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/tables@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":273},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":280},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":286},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":306},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":313},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":319},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":326},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":332},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":339},"Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":362},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":375},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-03-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":379},"Microsoft.DocumentDB/databaseAccounts@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":72},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":81},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":162},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":185},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":192},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":217},"Microsoft.DocumentDB/databaseAccounts/tables@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":230},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":257},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":263},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":270},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":276},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":283},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":289},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":296},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-03-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":97},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":106},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":117},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":174},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":180},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":187},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":194},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":228},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":241},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/tables@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":273},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":280},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":286},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":306},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":313},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":319},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":326},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":332},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":339},"Microsoft.DocumentDB/cassandraClusters@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":362},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":375},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":379},"Microsoft.DocumentDB/databaseAccounts/services@2021-04-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":395},"Microsoft.DocumentDB/databaseAccounts@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":72},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":81},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":92},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":155},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":162},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":169},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":185},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":203},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":216},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":229},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":235},"Microsoft.DocumentDB/databaseAccounts/tables@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":242},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":248},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":255},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":261},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":275},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":281},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":288},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":301},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":307},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":314},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-04-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":318},"Microsoft.DocumentDB/databaseAccounts@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":76},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":85},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":96},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":153},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":159},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":166},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":173},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":189},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":202},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":207},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":214},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":220},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":233},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":239},"Microsoft.DocumentDB/databaseAccounts/tables@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":252},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":265},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":279},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":285},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":292},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":298},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":305},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":311},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":318},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-05-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":322},"Microsoft.DocumentDB/databaseAccounts@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":105},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":114},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":125},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":182},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":195},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":202},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":218},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":231},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":236},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":243},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":249},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":262},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":268},"Microsoft.DocumentDB/databaseAccounts/tables@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":275},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":281},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":288},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":308},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":314},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":321},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":327},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":334},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":340},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":347},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-06-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":351},"Microsoft.DocumentDB/databaseAccounts@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":114},"Microsoft.DocumentDB/databaseAccounts/graphs@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":123},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":130},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":141},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":198},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":204},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":211},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":218},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":234},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":247},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":252},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":265},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":278},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":284},"Microsoft.DocumentDB/databaseAccounts/tables@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":291},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":297},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":304},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":310},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":324},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":330},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":337},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":343},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":350},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":356},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":363},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":369},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":376},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":380},"Microsoft.DocumentDB/cassandraClusters@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":403},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":416},"Microsoft.DocumentDB/databaseAccounts/services@2021-07-01-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":432},"Microsoft.DocumentDB/databaseAccounts@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":115},"Microsoft.DocumentDB/databaseAccounts/graphs@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":131},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":142},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":149},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":206},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":212},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":219},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":226},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":242},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":255},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":260},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":273},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":286},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":292},"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":306},"Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":312},"Microsoft.DocumentDB/databaseAccounts/tables@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":319},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":325},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":332},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":338},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":352},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":358},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":365},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":371},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":378},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":384},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":391},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":397},"Microsoft.DocumentDB/cassandraClusters@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":425},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":440},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":447},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":451},"Microsoft.DocumentDB/databaseAccounts/services@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":467},"Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-10-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":478},"Microsoft.DocumentDB/databaseAccounts@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":111},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":120},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":131},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":188},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":194},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":201},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":208},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":237},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":242},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":249},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":255},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":268},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":274},"Microsoft.DocumentDB/databaseAccounts/tables@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":281},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":287},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":294},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":300},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":314},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":320},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":327},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":333},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":340},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":346},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":353},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":357},"Microsoft.DocumentDB/cassandraClusters@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":384},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-10-15":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":397},"Microsoft.DocumentDB/databaseAccounts@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":119},"Microsoft.DocumentDB/databaseAccounts/graphs@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":128},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":135},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":146},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":153},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":210},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":216},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":223},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":230},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":246},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":259},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":264},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":271},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":277},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":290},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":296},"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":310},"Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":316},"Microsoft.DocumentDB/databaseAccounts/tables@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":323},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":329},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":336},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":342},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":356},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":362},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":369},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":375},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":382},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":388},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":395},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":401},"Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":414},"Microsoft.DocumentDB/cassandraClusters@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":442},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":457},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":464},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":468},"Microsoft.DocumentDB/databaseAccounts/services@2021-11-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":484},"Microsoft.DocumentDB/databaseAccounts@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":124},"Microsoft.DocumentDB/databaseAccounts/graphs@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":133},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":140},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":151},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":158},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":218},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":224},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/storedProcedures@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":231},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":238},"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/triggers@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":254},"Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":267},"Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":272},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":279},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":285},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":298},"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":304},"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":318},"Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":324},"Microsoft.DocumentDB/databaseAccounts/tables@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":331},"Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":337},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":344},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":350},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":364},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":370},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":377},"Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":383},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":390},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":396},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":403},"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs/throughputSettings@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":409},"Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":422},"Microsoft.DocumentDB/cassandraClusters@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":450},"Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":465},"Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":472},"Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":476},"Microsoft.DocumentDB/databaseAccounts/services@2022-02-15-preview":{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":492},"Microsoft.CostManagement/reportconfigs@2018-05-31":{"RelativePath":"cost-management/microsoft.costmanagement/2018-05-31/types.json","Index":57},"Microsoft.CostManagement/reports@2018-08-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2018-08-01-preview/types.json","Index":57},"Microsoft.CostManagement/connectors@2018-08-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2018-08-01-preview/types.json","Index":69},"Microsoft.CostManagement/exports@2019-01-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-01-01/types.json","Index":68},"Microsoft.CostManagement/cloudConnectors@2019-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-03-01-preview/types.json","Index":24},"Microsoft.CostManagement/externalSubscriptions@2019-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-03-01-preview/types.json","Index":28},"Microsoft.CostManagement/showbackRules@2019-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-03-01-preview/types.json","Index":57},"Microsoft.CostManagement/views@2019-04-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-04-01-preview/types.json","Index":72},"Microsoft.CostManagement/budgets@2019-04-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2019-04-01-preview/types.json","Index":95},"Microsoft.CostManagement/exports@2019-09-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-09-01/types.json","Index":66},"Microsoft.CostManagement/exports@2019-10-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-10-01/types.json","Index":66},"Microsoft.CostManagement/settings@2019-11-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-11-01/types.json","Index":18},"Microsoft.CostManagement/views@2019-11-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-11-01/types.json","Index":86},"Microsoft.CostManagement/exports@2019-11-01":{"RelativePath":"cost-management/microsoft.costmanagement/2019-11-01/types.json","Index":143},"Microsoft.CostManagement/costAllocationRules@2020-03-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2020-03-01-preview/types.json","Index":32},"Microsoft.CostManagement/views@2020-06-01":{"RelativePath":"cost-management/microsoft.costmanagement/2020-06-01/types.json","Index":72},"Microsoft.CostManagement/exports@2020-06-01":{"RelativePath":"cost-management/microsoft.costmanagement/2020-06-01/types.json","Index":128},"Microsoft.CostManagement/exports@2020-12-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2020-12-01-preview/types.json","Index":63},"Microsoft.CostManagement/exports@2021-01-01":{"RelativePath":"cost-management/microsoft.costmanagement/2021-01-01/types.json","Index":63},"Microsoft.CostManagement/views@2021-10-01":{"RelativePath":"cost-management/microsoft.costmanagement/2021-10-01/types.json","Index":72},"Microsoft.CostManagement/exports@2021-10-01":{"RelativePath":"cost-management/microsoft.costmanagement/2021-10-01/types.json","Index":128},"Microsoft.CostManagement/scheduledActions@2022-04-01-preview":{"RelativePath":"cost-management/microsoft.costmanagement/2022-04-01-preview/types.json","Index":55},"Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview":{"RelativePath":"cpim/microsoft.azureactivedirectory/2019-01-01-preview/types.json","Index":24},"Microsoft.AzureActiveDirectory/guestUsages@2020-05-01-preview":{"RelativePath":"cpim/microsoft.azureactivedirectory/2020-05-01-preview/types.json","Index":13},"Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01":{"RelativePath":"cpim/microsoft.azureactivedirectory/2021-04-01/types.json","Index":36},"Microsoft.AzureActiveDirectory/guestUsages@2021-04-01":{"RelativePath":"cpim/microsoft.azureactivedirectory/2021-04-01/types.json","Index":42},"Microsoft.CustomerInsights/hubs@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":14},"Microsoft.CustomerInsights/hubs/profiles@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":58},"Microsoft.CustomerInsights/hubs/interactions@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":90},"Microsoft.CustomerInsights/hubs/relationships@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":113},"Microsoft.CustomerInsights/hubs/relationshipLinks@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":134},"Microsoft.CustomerInsights/hubs/authorizationPolicies@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":144},"Microsoft.CustomerInsights/hubs/connectors@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":164},"Microsoft.CustomerInsights/hubs/connectors/mappings@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":211},"Microsoft.CustomerInsights/hubs/kpi@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":256},"Microsoft.CustomerInsights/hubs/views@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":262},"Microsoft.CustomerInsights/hubs/links@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":285},"Microsoft.CustomerInsights/hubs/roleAssignments@2017-01-01":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-01-01/types.json","Index":312},"Microsoft.CustomerInsights/hubs@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":14},"Microsoft.CustomerInsights/hubs/profiles@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":58},"Microsoft.CustomerInsights/hubs/interactions@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":90},"Microsoft.CustomerInsights/hubs/relationships@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":113},"Microsoft.CustomerInsights/hubs/relationshipLinks@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":135},"Microsoft.CustomerInsights/hubs/authorizationPolicies@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":145},"Microsoft.CustomerInsights/hubs/connectors@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":165},"Microsoft.CustomerInsights/hubs/connectors/mappings@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":212},"Microsoft.CustomerInsights/hubs/kpi@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":257},"Microsoft.CustomerInsights/hubs/views@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":263},"Microsoft.CustomerInsights/hubs/links@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":296},"Microsoft.CustomerInsights/hubs/roleAssignments@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":323},"Microsoft.CustomerInsights/hubs/predictions@2017-04-26":{"RelativePath":"customer-insights/microsoft.customerinsights/2017-04-26/types.json","Index":347},"Microsoft.CustomProviders/resourceProviders@2018-09-01-preview":{"RelativePath":"customproviders/microsoft.customproviders/2018-09-01-preview/types.json","Index":32},"Microsoft.CustomProviders/associations@2018-09-01-preview":{"RelativePath":"customproviders/microsoft.customproviders/2018-09-01-preview/types.json","Index":43},"Microsoft.Dashboard/grafana@2021-09-01-preview":{"RelativePath":"dashboard/microsoft.dashboard/2021-09-01-preview/types.json","Index":46},"Microsoft.DataBox/jobs@2018-01-01":{"RelativePath":"databox/microsoft.databox/2018-01-01/types.json","Index":115},"Microsoft.DataBox/jobs@2019-09-01":{"RelativePath":"databox/microsoft.databox/2019-09-01/types.json","Index":137},"Microsoft.DataBox/jobs@2020-04-01":{"RelativePath":"databox/microsoft.databox/2020-04-01/types.json","Index":184},"Microsoft.DataBox/jobs@2020-11-01":{"RelativePath":"databox/microsoft.databox/2020-11-01/types.json","Index":193},"Microsoft.DataBox/jobs@2021-03-01":{"RelativePath":"databox/microsoft.databox/2021-03-01/types.json","Index":203},"Microsoft.DataBox/jobs@2021-05-01":{"RelativePath":"databox/microsoft.databox/2021-05-01/types.json","Index":206},"Microsoft.DataBox/jobs@2021-08-01-preview":{"RelativePath":"databox/microsoft.databox/2021-08-01-preview/types.json","Index":326},"Microsoft.DataBox/jobs@2021-12-01":{"RelativePath":"databox/microsoft.databox/2021-12-01/types.json","Index":366},"Microsoft.DataBox/jobs@2022-02-01":{"RelativePath":"databox/microsoft.databox/2022-02-01/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":34},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":48},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":77},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":105},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":141},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":152},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":165},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2019-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-03-01/types.json","Index":176},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":35},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":49},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":78},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":106},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":156},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":169},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2019-07-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-07-01/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":42},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":56},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":86},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":114},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":153},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":164},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":178},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":193},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":206},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2019-08-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2019-08-01/types.json","Index":221},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":46},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":60},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":90},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":126},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":165},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":176},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":190},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":205},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":218},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-05-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-05-01-preview/types.json","Index":233},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":94},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":108},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":243},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":281},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":296},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":346},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":360},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":375},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":388},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-09-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":403},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":94},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":108},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":243},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":281},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":296},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":346},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":360},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":375},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":388},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-09-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":403},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":94},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":108},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":145},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":243},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":281},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":296},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":346},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":360},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":375},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":388},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2020-12-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":403},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":98},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":112},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":149},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":247},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":285},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":300},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":339},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":350},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":364},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":379},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":392},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-02-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":407},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":102},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":116},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":125},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":143},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":278},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":316},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":331},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":370},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":395},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":410},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":423},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-02-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":438},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":102},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":116},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":125},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":143},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":278},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":316},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":331},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":370},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":395},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":410},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":423},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-06-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":438},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":102},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":116},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":125},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":143},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":180},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":278},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":316},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":331},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":370},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":381},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":395},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":410},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":423},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2021-06-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":438},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":106},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":120},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":129},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":147},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":184},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":282},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":320},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":335},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":374},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":385},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":399},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":414},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":427},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2022-03-01":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":442},"Microsoft.DataBoxEdge/dataBoxEdgeDevices@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":107},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":121},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticProactiveLogCollectionSettings@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":130},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticRemoteSupportSettings@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":148},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/orders@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":185},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":321},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":342},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/monitoringConfig@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":357},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":396},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":407},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":421},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":436},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/triggers@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":449},"Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2022-04-01-preview":{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":464},"Microsoft.Databricks/workspaces@2018-04-01":{"RelativePath":"databricks/microsoft.databricks/2018-04-01/types.json","Index":55},"Microsoft.Databricks/workspaces/virtualNetworkPeerings@2018-04-01":{"RelativePath":"databricks/microsoft.databricks/2018-04-01/types.json","Index":73},"Microsoft.Databricks/workspaces@2021-04-01-preview":{"RelativePath":"databricks/microsoft.databricks/2021-04-01-preview/types.json","Index":95},"Microsoft.Databricks/workspaces/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"databricks/microsoft.databricks/2021-04-01-preview/types.json","Index":99},"Microsoft.Databricks/workspaces/virtualNetworkPeerings@2021-04-01-preview":{"RelativePath":"databricks/microsoft.databricks/2021-04-01-preview/types.json","Index":117},"Microsoft.DataCatalog/catalogs@2016-03-30":{"RelativePath":"datacatalog/microsoft.datacatalog/2016-03-30/types.json","Index":19},"Microsoft.Datadog/agreements@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":13},"Microsoft.Datadog/monitors@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":47},"Microsoft.Datadog/monitors/tagRules@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":70},"Microsoft.Datadog/monitors/singleSignOnConfigurations@2020-02-01-preview":{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":90},"Microsoft.Datadog/agreements@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":24},"Microsoft.Datadog/monitors@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":58},"Microsoft.Datadog/monitors/tagRules@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":81},"Microsoft.Datadog/monitors/singleSignOnConfigurations@2021-03-01":{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":101},"Microsoft.DataFactory/factories@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":16},"Microsoft.DataFactory/factories/integrationRuntimes@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":59},"Microsoft.DataFactory/factories/linkedservices@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":386},"Microsoft.DataFactory/factories/datasets@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":538},"Microsoft.DataFactory/factories/pipelines@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":728},"Microsoft.DataFactory/factories/triggers@2017-09-01-preview":{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":742},"Microsoft.DataFactory/factories@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":39},"Microsoft.DataFactory/factories/integrationRuntimes@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":126},"Microsoft.DataFactory/factories/linkedservices@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":594},"Microsoft.DataFactory/factories/datasets@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":903},"Microsoft.DataFactory/factories/pipelines@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1629},"Microsoft.DataFactory/factories/triggers@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1711},"Microsoft.DataFactory/factories/dataflows@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1740},"Microsoft.DataFactory/factories/managedVirtualNetworks@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1745},"Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1752},"Microsoft.DataFactory/factories/privateEndpointConnections@2018-06-01":{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1759},"Microsoft.DataLakeAnalytics/accounts@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":89},"Microsoft.DataLakeAnalytics/accounts/DataLakeStoreAccounts@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":93},"Microsoft.DataLakeAnalytics/accounts/StorageAccounts@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":97},"Microsoft.DataLakeAnalytics/accounts/computePolicies@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":101},"Microsoft.DataLakeAnalytics/accounts/firewallRules@2015-10-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":105},"Microsoft.DataLakeAnalytics/accounts@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":91},"Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":95},"Microsoft.DataLakeAnalytics/accounts/storageAccounts@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":99},"Microsoft.DataLakeAnalytics/accounts/computePolicies@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":103},"Microsoft.DataLakeAnalytics/accounts/firewallRules@2016-11-01":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":107},"Microsoft.DataLakeAnalytics/accounts@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":91},"Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":95},"Microsoft.DataLakeAnalytics/accounts/storageAccounts@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":99},"Microsoft.DataLakeAnalytics/accounts/computePolicies@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":103},"Microsoft.DataLakeAnalytics/accounts/firewallRules@2019-11-01-preview":{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":107},"Microsoft.DataLakeStore/accounts/firewallRules@2015-10-01-preview":{"RelativePath":"datalake-store/microsoft.datalakestore/2015-10-01-preview/types.json","Index":12},"Microsoft.DataLakeStore/accounts@2015-10-01-preview":{"RelativePath":"datalake-store/microsoft.datalakestore/2015-10-01-preview/types.json","Index":44},"Microsoft.DataLakeStore/accounts@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":75},"Microsoft.DataLakeStore/accounts/firewallRules@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":79},"Microsoft.DataLakeStore/accounts/virtualNetworkRules@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":83},"Microsoft.DataLakeStore/accounts/trustedIdProviders@2016-11-01":{"RelativePath":"datalake-store/microsoft.datalakestore/2016-11-01/types.json","Index":87},"Microsoft.DataMigration/services@2017-11-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2017-11-15-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2017-11-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2017-11-15-preview/types.json","Index":155},"Microsoft.DataMigration/services/projects@2017-11-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2017-11-15-preview/types.json","Index":181},"Microsoft.DataMigration/services@2018-03-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-15-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-03-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-15-preview/types.json","Index":222},"Microsoft.DataMigration/services/projects@2018-03-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-15-preview/types.json","Index":248},"Microsoft.DataMigration/services@2018-03-31-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-31-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-03-31-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-31-preview/types.json","Index":272},"Microsoft.DataMigration/services/projects@2018-03-31-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-03-31-preview/types.json","Index":299},"Microsoft.DataMigration/services@2018-04-19":{"RelativePath":"datamigration/microsoft.datamigration/2018-04-19/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-04-19":{"RelativePath":"datamigration/microsoft.datamigration/2018-04-19/types.json","Index":634},"Microsoft.DataMigration/services/projects@2018-04-19":{"RelativePath":"datamigration/microsoft.datamigration/2018-04-19/types.json","Index":668},"Microsoft.DataMigration/services@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":25},"Microsoft.DataMigration/services/projects/tasks@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":981},"Microsoft.DataMigration/services/serviceTasks@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":985},"Microsoft.DataMigration/services/projects@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":1030},"Microsoft.DataMigration/services/projects/files@2018-07-15-preview":{"RelativePath":"datamigration/microsoft.datamigration/2018-07-15-preview/types.json","Index":1035},"Microsoft.DataMigration/services@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":36},"Microsoft.DataMigration/services/projects/tasks@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1056},"Microsoft.DataMigration/services/serviceTasks@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1060},"Microsoft.DataMigration/services/projects@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1105},"Microsoft.DataMigration/services/projects/files@2021-06-30":{"RelativePath":"datamigration/microsoft.datamigration/2021-06-30/types.json","Index":1110},"Microsoft.DataMigration/databaseMigrations@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":42},"Microsoft.DataMigration/sqlMigrationServices@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":48},"Microsoft.DataMigration/services@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":66},"Microsoft.DataMigration/services/projects/tasks@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1087},"Microsoft.DataMigration/services/serviceTasks@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1091},"Microsoft.DataMigration/services/projects@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1136},"Microsoft.DataMigration/services/projects/files@2021-10-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1141},"Microsoft.DataMigration/databaseMigrations@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":42},"Microsoft.DataMigration/sqlMigrationServices@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":48},"Microsoft.DataMigration/services@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":66},"Microsoft.DataMigration/services/projects/tasks@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1101},"Microsoft.DataMigration/services/serviceTasks@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1105},"Microsoft.DataMigration/services/projects@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1162},"Microsoft.DataMigration/services/projects/files@2022-01-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1167},"Microsoft.DataMigration/databaseMigrations@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":35},"Microsoft.DataMigration/sqlMigrationServices@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":41},"Microsoft.DataMigration/services@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":59},"Microsoft.DataMigration/services/projects/tasks@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1106},"Microsoft.DataMigration/services/serviceTasks@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1110},"Microsoft.DataMigration/services/projects@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1179},"Microsoft.DataMigration/services/projects/files@2022-03-30-preview":{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1184},"Microsoft.DataProtection/backupVaults@2021-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-01-01/types.json","Index":40},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-01-01/types.json","Index":131},"Microsoft.DataProtection/backupVaults/backupInstances@2021-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-01-01/types.json","Index":175},"Microsoft.DataProtection/backupVaults@2021-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-02-01-preview/types.json","Index":40},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-02-01-preview/types.json","Index":131},"Microsoft.DataProtection/backupVaults/backupInstances@2021-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-02-01-preview/types.json","Index":175},"Microsoft.DataProtection/backupVaults@2021-06-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-06-01-preview/types.json","Index":40},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-06-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-06-01-preview/types.json","Index":131},"Microsoft.DataProtection/backupVaults/backupInstances@2021-06-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-06-01-preview/types.json","Index":182},"Microsoft.DataProtection/backupVaults@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":194},"Microsoft.DataProtection/resourceGuards@2021-07-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-07-01/types.json","Index":209},"Microsoft.DataProtection/backupVaults@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":197},"Microsoft.DataProtection/resourceGuards@2021-10-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-10-01-preview/types.json","Index":212},"Microsoft.DataProtection/backupVaults@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":194},"Microsoft.DataProtection/resourceGuards@2021-12-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2021-12-01-preview/types.json","Index":209},"Microsoft.DataProtection/backupVaults@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":197},"Microsoft.DataProtection/resourceGuards@2022-01-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-01-01/types.json","Index":212},"Microsoft.DataProtection/backupVaults@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":57},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":148},"Microsoft.DataProtection/backupVaults/backupInstances@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":202},"Microsoft.DataProtection/resourceGuards@2022-02-01-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-02-01-preview/types.json","Index":217},"Microsoft.DataProtection/backupVaults@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":52},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":143},"Microsoft.DataProtection/backupVaults/backupInstances@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":197},"Microsoft.DataProtection/resourceGuards@2022-03-01":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-01/types.json","Index":212},"Microsoft.DataProtection/backupVaults@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":57},"Microsoft.DataProtection/backupVaults/backupPolicies@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":148},"Microsoft.DataProtection/backupVaults/backupInstances@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":202},"Microsoft.DataProtection/resourceGuards@2022-03-31-preview":{"RelativePath":"dataprotection/microsoft.dataprotection/2022-03-31-preview/types.json","Index":217},"Microsoft.DataShare/accounts@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":22},"Microsoft.DataShare/accounts/shares/dataSets@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":74},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":204},"Microsoft.DataShare/accounts/shares/invitations@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":214},"Microsoft.DataShare/accounts/shares@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":228},"Microsoft.DataShare/accounts/shareSubscriptions@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":247},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":263},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2018-11-01-preview":{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":286},"Microsoft.DataShare/accounts@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":22},"Microsoft.DataShare/accounts/shares/dataSets@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":74},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":204},"Microsoft.DataShare/accounts/shares/invitations@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":214},"Microsoft.DataShare/accounts/shares@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":228},"Microsoft.DataShare/accounts/shareSubscriptions@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":247},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":263},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2019-11-01":{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":286},"Microsoft.DataShare/accounts@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":33},"Microsoft.DataShare/accounts/shares/dataSets@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":88},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":230},"Microsoft.DataShare/accounts/shares/invitations@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":240},"Microsoft.DataShare/accounts/shares@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":254},"Microsoft.DataShare/accounts/shareSubscriptions@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":273},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":289},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2020-09-01":{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":312},"Microsoft.DataShare/accounts@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":33},"Microsoft.DataShare/accounts/shares/dataSets@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":98},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":264},"Microsoft.DataShare/accounts/shares/invitations@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":274},"Microsoft.DataShare/accounts/shares@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":288},"Microsoft.DataShare/accounts/shareSubscriptions@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":307},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":323},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2020-10-01-preview":{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":346},"Microsoft.DataShare/accounts@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":33},"Microsoft.DataShare/accounts/shares/dataSets@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":104},"Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":258},"Microsoft.DataShare/accounts/shares/invitations@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":268},"Microsoft.DataShare/accounts/shares@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":282},"Microsoft.DataShare/accounts/shareSubscriptions@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":301},"Microsoft.DataShare/accounts/shares/synchronizationSettings@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":317},"Microsoft.DataShare/accounts/shareSubscriptions/triggers@2021-08-01":{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":340},"Microsoft.DeploymentManager/serviceTopologies@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":13},"Microsoft.DeploymentManager/serviceTopologies/services@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":19},"Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":29},"Microsoft.DeploymentManager/steps@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":38},"Microsoft.DeploymentManager/rollouts@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":69},"Microsoft.DeploymentManager/artifactSources@2018-09-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2018-09-01-preview/types.json","Index":79},"Microsoft.DeploymentManager/serviceTopologies@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":13},"Microsoft.DeploymentManager/serviceTopologies/services@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":19},"Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":29},"Microsoft.DeploymentManager/steps@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":65},"Microsoft.DeploymentManager/rollouts@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":96},"Microsoft.DeploymentManager/artifactSources@2019-11-01-preview":{"RelativePath":"deploymentmanager/microsoft.deploymentmanager/2019-11-01-preview/types.json","Index":106},"Microsoft.DesktopVirtualization/workspaces@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":32},"Microsoft.DesktopVirtualization/hostPools@2019-01-23-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-01-23-preview/types.json","Index":54},"Microsoft.DesktopVirtualization/workspaces@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":32},"Microsoft.DesktopVirtualization/hostPools@2019-09-24-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-09-24-preview/types.json","Index":58},"Microsoft.DesktopVirtualization/workspaces@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":32},"Microsoft.DesktopVirtualization/hostPools@2019-12-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2019-12-10-preview/types.json","Index":58},"Microsoft.DesktopVirtualization/workspaces@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":35},"Microsoft.DesktopVirtualization/hostPools@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-09-21-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-09-21-preview/types.json","Index":70},"Microsoft.DesktopVirtualization/workspaces@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":35},"Microsoft.DesktopVirtualization/hostPools@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":66},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-10-19-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-10-19-preview/types.json","Index":75},"Microsoft.DesktopVirtualization/workspaces@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/applicationGroups@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":35},"Microsoft.DesktopVirtualization/hostPools@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":66},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-11-02-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-02-preview/types.json","Index":75},"Microsoft.DesktopVirtualization/workspaces@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":14},"Microsoft.DesktopVirtualization/scalingPlans@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":51},"Microsoft.DesktopVirtualization/applicationGroups@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":60},"Microsoft.DesktopVirtualization/applicationGroups/applications@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":72},"Microsoft.DesktopVirtualization/hostPools@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":103},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2020-11-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2020-11-10-preview/types.json","Index":112},"Microsoft.DesktopVirtualization/workspaces@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-01-14-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-01-14-preview/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-02-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-02-01-preview/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-03-09-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-03-09-preview/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":26},"Microsoft.DesktopVirtualization/scalingPlans@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":64},"Microsoft.DesktopVirtualization/applicationGroups@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":80},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":92},"Microsoft.DesktopVirtualization/hostPools@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":127},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":136},"Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":163},"Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-04-01-preview/types.json","Index":167},"Microsoft.DesktopVirtualization/workspaces@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":23},"Microsoft.DesktopVirtualization/scalingPlans@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":61},"Microsoft.DesktopVirtualization/applicationGroups@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":77},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":89},"Microsoft.DesktopVirtualization/hostPools@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":121},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-07-12":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-07-12/types.json","Index":130},"Microsoft.DesktopVirtualization/workspaces@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":37},"Microsoft.DesktopVirtualization/scalingPlans@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":74},"Microsoft.DesktopVirtualization/applicationGroups@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":90},"Microsoft.DesktopVirtualization/applicationGroups/applications@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":102},"Microsoft.DesktopVirtualization/hostPools@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":137},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":146},"Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":162},"Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2021-09-03-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2021-09-03-preview/types.json","Index":166},"Microsoft.DesktopVirtualization/workspaces@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":51},"Microsoft.DesktopVirtualization/scalingPlans@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":88},"Microsoft.DesktopVirtualization/applicationGroups@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":104},"Microsoft.DesktopVirtualization/applicationGroups/applications@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":116},"Microsoft.DesktopVirtualization/hostPools@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":168},"Microsoft.DesktopVirtualization/hostPools/msixPackages@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":177},"Microsoft.DesktopVirtualization/hostPools/privateEndpointConnections@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":181},"Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections@2022-02-10-preview":{"RelativePath":"desktopvirtualization/microsoft.desktopvirtualization/2022-02-10-preview/types.json","Index":185},"Microsoft.Devices/provisioningServices/certificates@2017-08-21-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":12},"Microsoft.Devices/provisioningServices@2017-08-21-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":49},"Microsoft.Devices/provisioningServices/certificates@2017-11-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":12},"Microsoft.Devices/provisioningServices@2017-11-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":49},"Microsoft.Devices/provisioningServices/certificates@2018-01-22":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":12},"Microsoft.Devices/provisioningServices@2018-01-22":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":49},"Microsoft.Devices/provisioningServices/certificates@2020-01-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":12},"Microsoft.Devices/provisioningServices@2020-01-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":58},"Microsoft.Devices/provisioningServices/certificates@2020-03-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":12},"Microsoft.Devices/provisioningServices@2020-03-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":71},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2020-03-01":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":75},"Microsoft.Devices/provisioningServices/certificates@2020-09-01-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":12},"Microsoft.Devices/provisioningServices@2020-09-01-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":78},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2020-09-01-preview":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":82},"Microsoft.Devices/provisioningServices/certificates@2021-10-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":23},"Microsoft.Devices/provisioningServices@2021-10-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":82},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2021-10-15":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":86},"Microsoft.Devices/provisioningServices/certificates@2022-02-05":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":23},"Microsoft.Devices/provisioningServices@2022-02-05":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":82},"Microsoft.Devices/provisioningServices/privateEndpointConnections@2022-02-05":{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":86},"Microsoft.DeviceUpdate/accounts@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":57},"Microsoft.DeviceUpdate/accounts/instances@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":75},"Microsoft.DeviceUpdate/accounts/privateEndpointConnections@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":79},"Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2020-03-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2020-03-01-preview/types.json","Index":102},"Microsoft.DeviceUpdate/accounts@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":65},"Microsoft.DeviceUpdate/accounts/instances@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":83},"Microsoft.DeviceUpdate/accounts/privateEndpointConnections@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":87},"Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies@2022-04-01-preview":{"RelativePath":"deviceupdate/microsoft.deviceupdate/2022-04-01-preview/types.json","Index":110},"Microsoft.DevOps/pipelines@2019-07-01-preview":{"RelativePath":"devops/microsoft.devops/2019-07-01-preview/types.json","Index":27},"Microsoft.DevOps/pipelines@2020-07-13-preview":{"RelativePath":"devops/microsoft.devops/2020-07-13-preview/types.json","Index":42},"Microsoft.DevSpaces/controllers@2019-04-01":{"RelativePath":"devspaces/microsoft.devspaces/2019-04-01/types.json","Index":26},"Microsoft.DevTestLab/labs@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":17},"Microsoft.DevTestLab/labs/artifactsources@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":29},"Microsoft.DevTestLab/labs/customimages@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":51},"Microsoft.DevTestLab/labs/formulas@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":67},"Microsoft.DevTestLab/labs/policysets/policies@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":85},"Microsoft.DevTestLab/labs/schedules@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":102},"Microsoft.DevTestLab/labs/virtualmachines@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":107},"Microsoft.DevTestLab/labs/virtualnetworks@2015-05-21-preview":{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":129},"Microsoft.DevTestLab/labs@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":19},"Microsoft.DevTestLab/schedules@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":36},"Microsoft.DevTestLab/labs/artifactsources@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":48},"Microsoft.DevTestLab/labs/costs@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":79},"Microsoft.DevTestLab/labs/customimages@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":101},"Microsoft.DevTestLab/labs/formulas@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":139},"Microsoft.DevTestLab/labs/notificationchannels@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":150},"Microsoft.DevTestLab/labs/policysets/policies@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":171},"Microsoft.DevTestLab/labs/schedules@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":176},"Microsoft.DevTestLab/labs/servicerunners@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":182},"Microsoft.DevTestLab/labs/users@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":190},"Microsoft.DevTestLab/labs/users/disks@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":199},"Microsoft.DevTestLab/labs/users/environments@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":208},"Microsoft.DevTestLab/labs/users/secrets@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":214},"Microsoft.DevTestLab/labs/virtualmachines@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":224},"Microsoft.DevTestLab/labs/virtualmachines/schedules@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":229},"Microsoft.DevTestLab/labs/virtualnetworks@2016-05-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":259},"Microsoft.DevTestLab/labs@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":34},"Microsoft.DevTestLab/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":51},"Microsoft.DevTestLab/labs/artifactsources@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":64},"Microsoft.DevTestLab/labs/costs@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":95},"Microsoft.DevTestLab/labs/customimages@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":124},"Microsoft.DevTestLab/labs/formulas@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":165},"Microsoft.DevTestLab/labs/notificationchannels@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":176},"Microsoft.DevTestLab/labs/policysets/policies@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":199},"Microsoft.DevTestLab/labs/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":204},"Microsoft.DevTestLab/labs/servicerunners@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":215},"Microsoft.DevTestLab/labs/users@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":223},"Microsoft.DevTestLab/labs/users/disks@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":233},"Microsoft.DevTestLab/labs/users/environments@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":242},"Microsoft.DevTestLab/labs/users/secrets@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":248},"Microsoft.DevTestLab/labs/users/servicefabrics@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":259},"Microsoft.DevTestLab/labs/users/servicefabrics/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":264},"Microsoft.DevTestLab/labs/virtualmachines@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":284},"Microsoft.DevTestLab/labs/virtualmachines/schedules@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":289},"Microsoft.DevTestLab/labs/virtualnetworks@2018-09-15":{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":319},"Microsoft.Dynamics365FraudProtection/instances@2021-02-01-preview":{"RelativePath":"dfp/microsoft.dynamics365fraudprotection/2021-02-01-preview/types.json","Index":39},"Microsoft.DigitalTwins/digitalTwinsInstances@2020-03-01-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.json","Index":22},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-03-01-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-03-01-preview/types.json","Index":40},"Microsoft.DigitalTwins/digitalTwinsInstances@2020-10-31":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-10-31/types.json","Index":24},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-10-31":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-10-31/types.json","Index":47},"Microsoft.DigitalTwins/digitalTwinsInstances@2020-12-01":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-12-01/types.json","Index":48},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2020-12-01":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-12-01/types.json","Index":74},"Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2020-12-01":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2020-12-01/types.json","Index":78},"Microsoft.DigitalTwins/digitalTwinsInstances@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":59},"Microsoft.DigitalTwins/digitalTwinsInstances/endpoints@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":85},"Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":89},"Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections@2021-06-30-preview":{"RelativePath":"digitaltwins/microsoft.digitaltwins/2021-06-30-preview/types.json","Index":108},"Microsoft.DelegatedNetwork/controller@2020-08-08-preview":{"RelativePath":"dnc/microsoft.delegatednetwork/2020-08-08-preview/types.json","Index":18},"Microsoft.DelegatedNetwork/orchestrators@2020-08-08-preview":{"RelativePath":"dnc/microsoft.delegatednetwork/2020-08-08-preview/types.json","Index":36},"Microsoft.DelegatedNetwork/delegatedSubnets@2020-08-08-preview":{"RelativePath":"dnc/microsoft.delegatednetwork/2020-08-08-preview/types.json","Index":48},"Microsoft.DelegatedNetwork/controller@2021-03-15":{"RelativePath":"dnc/microsoft.delegatednetwork/2021-03-15/types.json","Index":18},"Microsoft.DelegatedNetwork/orchestrators@2021-03-15":{"RelativePath":"dnc/microsoft.delegatednetwork/2021-03-15/types.json","Index":36},"Microsoft.DelegatedNetwork/delegatedSubnets@2021-03-15":{"RelativePath":"dnc/microsoft.delegatednetwork/2021-03-15/types.json","Index":48},"Microsoft.Network/dnszones/A@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":29},"Microsoft.Network/dnszones/AAAA@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":33},"Microsoft.Network/dnszones/CNAME@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":37},"Microsoft.Network/dnszones/MX@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":41},"Microsoft.Network/dnszones/NS@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":45},"Microsoft.Network/dnszones/PTR@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":49},"Microsoft.Network/dnszones/SOA@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":53},"Microsoft.Network/dnszones/SRV@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":57},"Microsoft.Network/dnszones/TXT@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":61},"Microsoft.Network/dnszones@2015-05-04-preview":{"RelativePath":"dns/microsoft.network/2015-05-04-preview/types.json","Index":67},"Microsoft.Network/dnsZones/A@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":30},"Microsoft.Network/dnsZones/AAAA@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":34},"Microsoft.Network/dnsZones/CNAME@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":38},"Microsoft.Network/dnsZones/MX@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":42},"Microsoft.Network/dnsZones/NS@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":46},"Microsoft.Network/dnsZones/PTR@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":50},"Microsoft.Network/dnsZones/SOA@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":54},"Microsoft.Network/dnsZones/SRV@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":58},"Microsoft.Network/dnsZones/TXT@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":62},"Microsoft.Network/dnsZones@2016-04-01":{"RelativePath":"dns/microsoft.network/2016-04-01/types.json","Index":72},"Microsoft.Network/dnsZones/A@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":32},"Microsoft.Network/dnsZones/AAAA@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":36},"Microsoft.Network/dnsZones/CAA@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":40},"Microsoft.Network/dnsZones/CNAME@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":44},"Microsoft.Network/dnsZones/MX@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":48},"Microsoft.Network/dnsZones/NS@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":52},"Microsoft.Network/dnsZones/PTR@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":56},"Microsoft.Network/dnsZones/SOA@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":60},"Microsoft.Network/dnsZones/SRV@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":64},"Microsoft.Network/dnsZones/TXT@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":68},"Microsoft.Network/dnsZones@2017-09-01":{"RelativePath":"dns/microsoft.network/2017-09-01/types.json","Index":78},"Microsoft.Network/dnsZones/A@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":32},"Microsoft.Network/dnsZones/AAAA@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":36},"Microsoft.Network/dnsZones/CAA@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":40},"Microsoft.Network/dnsZones/CNAME@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":44},"Microsoft.Network/dnsZones/MX@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":48},"Microsoft.Network/dnsZones/NS@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":52},"Microsoft.Network/dnsZones/PTR@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":56},"Microsoft.Network/dnsZones/SOA@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":60},"Microsoft.Network/dnsZones/SRV@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":64},"Microsoft.Network/dnsZones/TXT@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":68},"Microsoft.Network/dnsZones@2017-10-01":{"RelativePath":"dns/microsoft.network/2017-10-01/types.json","Index":78},"Microsoft.Network/dnsZones/A@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":32},"Microsoft.Network/dnsZones/AAAA@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":36},"Microsoft.Network/dnsZones/CAA@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":40},"Microsoft.Network/dnsZones/CNAME@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":44},"Microsoft.Network/dnsZones/MX@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":48},"Microsoft.Network/dnsZones/NS@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":52},"Microsoft.Network/dnsZones/PTR@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":56},"Microsoft.Network/dnsZones/SOA@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":60},"Microsoft.Network/dnsZones/SRV@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":64},"Microsoft.Network/dnsZones/TXT@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":68},"Microsoft.Network/dnsZones@2018-03-01-preview":{"RelativePath":"dns/microsoft.network/2018-03-01-preview/types.json","Index":81},"Microsoft.Network/dnsZones/A@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":33},"Microsoft.Network/dnsZones/AAAA@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":37},"Microsoft.Network/dnsZones/CAA@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":41},"Microsoft.Network/dnsZones/CNAME@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":45},"Microsoft.Network/dnsZones/MX@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":49},"Microsoft.Network/dnsZones/NS@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":53},"Microsoft.Network/dnsZones/PTR@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":57},"Microsoft.Network/dnsZones/SOA@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":61},"Microsoft.Network/dnsZones/SRV@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":65},"Microsoft.Network/dnsZones/TXT@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":69},"Microsoft.Network/dnsZones@2018-05-01":{"RelativePath":"dns/microsoft.network/2018-05-01/types.json","Index":81},"Microsoft.Network/dnsResolvers@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":35},"Microsoft.Network/dnsResolvers/inboundEndpoints@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":53},"Microsoft.Network/dnsResolvers/outboundEndpoints@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":66},"Microsoft.Network/dnsForwardingRulesets@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":80},"Microsoft.Network/dnsForwardingRulesets/forwardingRules@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":98},"Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks@2020-04-01-preview":{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":111},"Microsoft.AAD/domainServices@2017-01-01":{"RelativePath":"domainservices/microsoft.aad/2017-01-01/types.json","Index":46},"Microsoft.AAD/domainServices@2017-06-01":{"RelativePath":"domainservices/microsoft.aad/2017-06-01/types.json","Index":57},"Microsoft.Aad/domainServices/ouContainer@2017-06-01":{"RelativePath":"domainservices/microsoft.aad/2017-06-01/types.json","Index":65},"Microsoft.AAD/domainServices@2020-01-01":{"RelativePath":"domainservices/microsoft.aad/2020-01-01/types.json","Index":59},"Microsoft.Aad/domainServices/ouContainer@2020-01-01":{"RelativePath":"domainservices/microsoft.aad/2020-01-01/types.json","Index":67},"Microsoft.AAD/domainServices@2021-03-01":{"RelativePath":"domainservices/microsoft.aad/2021-03-01/types.json","Index":76},"Microsoft.Aad/domainServices/ouContainer@2021-03-01":{"RelativePath":"domainservices/microsoft.aad/2021-03-01/types.json","Index":84},"Microsoft.AAD/domainServices@2021-05-01":{"RelativePath":"domainservices/microsoft.aad/2021-05-01/types.json","Index":89},"Microsoft.Aad/domainServices/ouContainer@2021-05-01":{"RelativePath":"domainservices/microsoft.aad/2021-05-01/types.json","Index":97},"Microsoft.EdgeOrder/addresses@2020-12-01-preview":{"RelativePath":"edgeorder/microsoft.edgeorder/2020-12-01-preview/types.json","Index":31},"Microsoft.EdgeOrder/orderItems@2020-12-01-preview":{"RelativePath":"edgeorder/microsoft.edgeorder/2020-12-01-preview/types.json","Index":107},"Microsoft.EdgeOrder/addresses@2021-12-01":{"RelativePath":"edgeorder/microsoft.edgeorder/2021-12-01/types.json","Index":35},"Microsoft.EdgeOrder/orderItems@2021-12-01":{"RelativePath":"edgeorder/microsoft.edgeorder/2021-12-01/types.json","Index":111},"Microsoft.Education/labs@2021-12-01-preview":{"RelativePath":"education/microsoft.education/2021-12-01-preview/types.json","Index":28},"Microsoft.Education/labs/students@2021-12-01-preview":{"RelativePath":"education/microsoft.education/2021-12-01-preview/types.json","Index":42},"Microsoft.Elastic/monitors@2020-07-01-preview":{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2020-07-01-preview":{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":70},"Microsoft.Elastic/monitors@2020-07-01":{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2020-07-01":{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":70},"Microsoft.Elastic/monitors@2021-09-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2021-09-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":70},"Microsoft.Elastic/monitors@2021-10-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":49},"Microsoft.Elastic/monitors/tagRules@2021-10-01-preview":{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":70},"Microsoft.ElasticSan/elasticSans@2021-11-20-preview":{"RelativePath":"elasticsan/microsoft.elasticsan/2021-11-20-preview/types.json","Index":43},"Microsoft.ElasticSan/elasticSans/volumegroups@2021-11-20-preview":{"RelativePath":"elasticsan/microsoft.elasticsan/2021-11-20-preview/types.json","Index":75},"Microsoft.ElasticSan/elasticSans/volumegroups/volumes@2021-11-20-preview":{"RelativePath":"elasticsan/microsoft.elasticsan/2021-11-20-preview/types.json","Index":106},"Microsoft.EngagementFabric/Accounts@2018-09-01-preview":{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":13},"Microsoft.EngagementFabric/Accounts/Channels@2018-09-01-preview":{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":20},"Microsoft.EnterpriseKnowledgeGraph/services@2018-12-03":{"RelativePath":"enterpriseknowledgegraph/microsoft.enterpriseknowledgegraph/2018-12-03/types.json","Index":22},"Microsoft.EventGrid/eventSubscriptions@2017-06-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-06-15-preview/types.json","Index":26},"Microsoft.EventGrid/topics@2017-06-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-06-15-preview/types.json","Index":39},"Microsoft.EventGrid/eventSubscriptions@2017-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-09-15-preview/types.json","Index":29},"Microsoft.EventGrid/topics@2017-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2017-09-15-preview/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2018-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-01-01/types.json","Index":29},"Microsoft.EventGrid/topics@2018-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-01-01/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2018-05-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-05-01-preview/types.json","Index":45},"Microsoft.EventGrid/topics@2018-05-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-05-01-preview/types.json","Index":68},"Microsoft.EventGrid/domains@2018-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":30},"Microsoft.EventGrid/eventSubscriptions@2018-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":101},"Microsoft.EventGrid/topics@2018-09-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":118},"Microsoft.EventGrid/eventSubscriptions@2019-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-01-01/types.json","Index":41},"Microsoft.EventGrid/topics@2019-01-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-01-01/types.json","Index":54},"Microsoft.EventGrid/domains@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":30},"Microsoft.EventGrid/domains/topics@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":116},"Microsoft.EventGrid/topics@2019-02-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":133},"Microsoft.EventGrid/domains@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":20},"Microsoft.EventGrid/domains/topics@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":32},"Microsoft.EventGrid/eventSubscriptions@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":102},"Microsoft.EventGrid/topics@2019-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":115},"Microsoft.EventGrid/domains@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":30},"Microsoft.EventGrid/domains/topics@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":42},"Microsoft.EventGrid/eventSubscriptions@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":122},"Microsoft.EventGrid/topics@2020-01-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":139},"Microsoft.EventGrid/domains@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":67},"Microsoft.EventGrid/domains/topics@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":79},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":143},"Microsoft.EventGrid/eventSubscriptions@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":197},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":201},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":205},"Microsoft.EventGrid/partnerNamespaces@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":218},"Microsoft.EventGrid/partnerRegistrations@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":236},"Microsoft.EventGrid/topics/privateEndpointConnections@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":240},"Microsoft.EventGrid/domains/privateEndpointConnections@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":244},"Microsoft.EventGrid/systemTopics@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":257},"Microsoft.EventGrid/topics@2020-04-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":279},"Microsoft.EventGrid/domains@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":66},"Microsoft.EventGrid/domains/topics@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":78},"Microsoft.EventGrid/eventSubscriptions@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":158},"Microsoft.EventGrid/topics@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":180},"Microsoft.EventGrid/topics/privateEndpointConnections@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":184},"Microsoft.EventGrid/domains/privateEndpointConnections@2020-06-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":188},"Microsoft.EventGrid/domains@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":78},"Microsoft.EventGrid/domains/topics@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":90},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":164},"Microsoft.EventGrid/eventSubscriptions@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":232},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":236},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":240},"Microsoft.EventGrid/partnerNamespaces@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":253},"Microsoft.EventGrid/partnerRegistrations@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":271},"Microsoft.EventGrid/topics/privateEndpointConnections@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":275},"Microsoft.EventGrid/domains/privateEndpointConnections@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":279},"Microsoft.EventGrid/systemTopics@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":292},"Microsoft.EventGrid/topics@2020-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":318},"Microsoft.EventGrid/domains@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":78},"Microsoft.EventGrid/domains/topics@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":90},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":164},"Microsoft.EventGrid/eventSubscriptions@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":231},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":235},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":239},"Microsoft.EventGrid/partnerNamespaces@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":257},"Microsoft.EventGrid/partnerRegistrations@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":275},"Microsoft.EventGrid/topics/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":279},"Microsoft.EventGrid/domains/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":283},"Microsoft.EventGrid/partnerNamespaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":287},"Microsoft.EventGrid/systemTopics@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":300},"Microsoft.EventGrid/topics@2021-06-01-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":326},"Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":52},"Microsoft.EventGrid/domains@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":115},"Microsoft.EventGrid/domains/topics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":127},"Microsoft.EventGrid/partnerNamespaces/eventChannels@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":201},"Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":271},"Microsoft.EventGrid/domains/topics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":275},"Microsoft.EventGrid/topics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":279},"Microsoft.EventGrid/domains/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":283},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":287},"Microsoft.EventGrid/partnerTopics/eventSubscriptions@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":291},"Microsoft.EventGrid/partnerConfigurations@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":308},"Microsoft.EventGrid/partnerDestinations@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":324},"Microsoft.EventGrid/partnerNamespaces@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":345},"Microsoft.EventGrid/partnerRegistrations@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":363},"Microsoft.EventGrid/partnerTopics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":380},"Microsoft.EventGrid/topics/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":384},"Microsoft.EventGrid/domains/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":388},"Microsoft.EventGrid/partnerNamespaces/privateEndpointConnections@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":392},"Microsoft.EventGrid/systemTopics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":405},"Microsoft.EventGrid/topics@2021-10-15-preview":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":434},"Microsoft.EventGrid/domains@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":74},"Microsoft.EventGrid/domains/topics@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":86},"Microsoft.EventGrid/eventSubscriptions@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":206},"Microsoft.EventGrid/systemTopics/eventSubscriptions@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":210},"Microsoft.EventGrid/topics@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":232},"Microsoft.EventGrid/topics/privateEndpointConnections@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":236},"Microsoft.EventGrid/domains/privateEndpointConnections@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":240},"Microsoft.EventGrid/systemTopics@2021-12-01":{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":253},"Microsoft.EventHub/namespaces@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":35},"Microsoft.EventHub/namespaces/AuthorizationRules@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":45},"Microsoft.EventHub/namespaces/eventhubs@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":61},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":65},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2014-09-01":{"RelativePath":"eventhub/microsoft.eventhub/2014-09-01/types.json","Index":70},"Microsoft.EventHub/namespaces@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":35},"Microsoft.EventHub/namespaces/AuthorizationRules@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":45},"Microsoft.EventHub/namespaces/eventhubs@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":61},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":65},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2015-08-01":{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":70},"Microsoft.EventHub/namespaces/authorizationRules@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":17},"Microsoft.EventHub/namespaces@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":30},"Microsoft.EventHub/namespaces/networkRuleSets@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":46},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":59},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":63},"Microsoft.EventHub/namespaces/eventhubs@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":85},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2017-04-01":{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":90},"Microsoft.EventHub/clusters@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":16},"Microsoft.EventHub/namespaces/ipfilterrules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":24},"Microsoft.EventHub/namespaces@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":43},"Microsoft.EventHub/namespaces/virtualnetworkrules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":48},"Microsoft.EventHub/namespaces/networkRuleSets@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":64},"Microsoft.EventHub/namespaces/authorizationRules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":74},"Microsoft.EventHub/namespaces/privateEndpointConnections@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":93},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":106},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":110},"Microsoft.EventHub/namespaces/eventhubs@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":132},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2018-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":137},"Microsoft.EventHub/namespaces@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":63},"Microsoft.EventHub/namespaces/networkRuleSets@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":79},"Microsoft.EventHub/namespaces/authorizationRules@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":89},"Microsoft.EventHub/namespaces/privateEndpointConnections@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":93},"Microsoft.EventHub/namespaces/eventhubs@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":115},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":119},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":132},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2021-01-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":137},"Microsoft.EventHub/clusters@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":27},"Microsoft.EventHub/namespaces@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":72},"Microsoft.EventHub/namespaces/networkRuleSets@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":91},"Microsoft.EventHub/namespaces/authorizationRules@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":101},"Microsoft.EventHub/namespaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":105},"Microsoft.EventHub/namespaces/eventhubs@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":127},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":131},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":144},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2021-06-01-preview":{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":149},"Microsoft.EventHub/clusters@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":27},"Microsoft.EventHub/namespaces@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":72},"Microsoft.EventHub/namespaces/networkRuleSets@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":91},"Microsoft.EventHub/namespaces/authorizationRules@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":101},"Microsoft.EventHub/namespaces/privateEndpointConnections@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":105},"Microsoft.EventHub/namespaces/eventhubs@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":127},"Microsoft.EventHub/namespaces/eventhubs/authorizationRules@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":131},"Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":144},"Microsoft.EventHub/namespaces/eventhubs/consumergroups@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":149},"Microsoft.EventHub/namespaces/schemagroups@2021-11-01":{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":162},"Microsoft.ExtendedLocation/customLocations@2021-03-15-preview":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-03-15-preview/types.json","Index":28},"Microsoft.ExtendedLocation/customLocations@2021-08-15":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-08-15/types.json","Index":32},"Microsoft.ExtendedLocation/customLocations@2021-08-31-preview":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.json","Index":32},"Microsoft.ExtendedLocation/customLocations/resourceSyncRules@2021-08-31-preview":{"RelativePath":"extendedlocation/microsoft.extendedlocation/2021-08-31-preview/types.json","Index":43},"Microsoft.FluidRelay/fluidRelayServers@2021-03-12-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-03-12-preview/types.json","Index":31},"Microsoft.FluidRelay/fluidRelayServers@2021-06-15-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-06-15-preview/types.json","Index":35},"Microsoft.FluidRelay/fluidRelayServers@2021-08-30-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-08-30-preview/types.json","Index":35},"Microsoft.FluidRelay/fluidRelayServers@2021-09-10-preview":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2021-09-10-preview/types.json","Index":39},"Microsoft.FluidRelay/fluidRelayServers@2022-02-15":{"RelativePath":"fluidrelay/microsoft.fluidrelay/2022-02-15/types.json","Index":39},"Microsoft.Network/frontDoors@2018-08-01":{"RelativePath":"frontdoor/microsoft.network/2018-08-01/types.json","Index":134},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2018-08-01":{"RelativePath":"frontdoor/microsoft.network/2018-08-01/types.json","Index":210},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2019-03-01":{"RelativePath":"frontdoor/microsoft.network/2019-03-01/types.json","Index":91},"Microsoft.Network/frontDoors@2019-04-01":{"RelativePath":"frontdoor/microsoft.network/2019-04-01/types.json","Index":152},"Microsoft.Network/frontDoors@2019-05-01":{"RelativePath":"frontdoor/microsoft.network/2019-05-01/types.json","Index":161},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2019-10-01":{"RelativePath":"frontdoor/microsoft.network/2019-10-01/types.json","Index":107},"Microsoft.Network/NetworkExperimentProfiles@2019-11-01":{"RelativePath":"frontdoor/microsoft.network/2019-11-01/types.json","Index":23},"Microsoft.Network/NetworkExperimentProfiles/Experiments@2019-11-01":{"RelativePath":"frontdoor/microsoft.network/2019-11-01/types.json","Index":40},"Microsoft.Network/frontDoors@2020-01-01":{"RelativePath":"frontdoor/microsoft.network/2020-01-01/types.json","Index":228},"Microsoft.Network/frontDoors/rulesEngines@2020-01-01":{"RelativePath":"frontdoor/microsoft.network/2020-01-01/types.json","Index":232},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2020-04-01":{"RelativePath":"frontdoor/microsoft.network/2020-04-01/types.json","Index":109},"Microsoft.Network/frontDoors@2020-04-01":{"RelativePath":"frontdoor/microsoft.network/2020-04-01/types.json","Index":331},"Microsoft.Network/frontDoors/rulesEngines@2020-04-01":{"RelativePath":"frontdoor/microsoft.network/2020-04-01/types.json","Index":335},"Microsoft.Network/frontDoors@2020-05-01":{"RelativePath":"frontdoor/microsoft.network/2020-05-01/types.json","Index":229},"Microsoft.Network/frontDoors/rulesEngines@2020-05-01":{"RelativePath":"frontdoor/microsoft.network/2020-05-01/types.json","Index":233},"Microsoft.Network/FrontDoorWebApplicationFirewallPolicies@2020-11-01":{"RelativePath":"frontdoor/microsoft.network/2020-11-01/types.json","Index":124},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-01-20-preview":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2018-01-20-preview/types.json","Index":24},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-06-30-preview":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2018-06-30-preview/types.json","Index":34},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2018-11-20":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2018-11-20/types.json","Index":46},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2020-06-25":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2020-06-25/types.json","Index":65},"Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25":{"RelativePath":"guestconfiguration/microsoft.guestconfiguration/2021-01-25/types.json","Index":76},"Microsoft.HanaOnAzure/hanaInstances@2017-11-03-preview":{"RelativePath":"hanaonazure/microsoft.hanaonazure/2017-11-03-preview/types.json","Index":85},"Microsoft.HanaOnAzure/sapMonitors@2020-02-07-preview":{"RelativePath":"hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.json","Index":21},"Microsoft.HanaOnAzure/sapMonitors/providerInstances@2020-02-07-preview":{"RelativePath":"hanaonazure/microsoft.hanaonazure/2020-02-07-preview/types.json","Index":34},"Microsoft.HardwareSecurityModules/dedicatedHSMs@2018-10-31-preview":{"RelativePath":"hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2018-10-31-preview/types.json","Index":35},"Microsoft.HardwareSecurityModules/dedicatedHSMs@2021-11-30":{"RelativePath":"hardwaresecuritymodules/microsoft.hardwaresecuritymodules/2021-11-30/types.json","Index":46},"Microsoft.HDInsight/clusters@2015-03-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2015-03-01-preview/types.json","Index":94},"Microsoft.HDInsight/clusters/applications@2015-03-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2015-03-01-preview/types.json","Index":110},"Microsoft.HDInsight/clusters@2018-06-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2018-06-01-preview/types.json","Index":94},"Microsoft.HDInsight/clusters/applications@2018-06-01-preview":{"RelativePath":"hdinsight/microsoft.hdinsight/2018-06-01-preview/types.json","Index":110},"Microsoft.HDInsight/clusters@2021-06-01":{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":146},"Microsoft.HDInsight/clusters/applications@2021-06-01":{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":163},"Microsoft.HDInsight/clusters/privateEndpointConnections@2021-06-01":{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":167},"Microsoft.HealthBot/healthBots@2020-10-20-preview":{"RelativePath":"healthbot/microsoft.healthbot/2020-10-20-preview/types.json","Index":31},"Microsoft.HealthBot/healthBots@2020-10-20":{"RelativePath":"healthbot/microsoft.healthbot/2020-10-20/types.json","Index":31},"Microsoft.HealthBot/healthBots@2020-12-08-preview":{"RelativePath":"healthbot/microsoft.healthbot/2020-12-08-preview/types.json","Index":32},"Microsoft.HealthBot/healthBots@2020-12-08":{"RelativePath":"healthbot/microsoft.healthbot/2020-12-08/types.json","Index":29},"Microsoft.HealthBot/healthBots@2021-06-10":{"RelativePath":"healthbot/microsoft.healthbot/2021-06-10/types.json","Index":37},"Microsoft.HealthBot/healthBots@2021-08-24":{"RelativePath":"healthbot/microsoft.healthbot/2021-08-24/types.json","Index":38},"Microsoft.HealthcareApis/services@2018-08-20-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2018-08-20-preview/types.json","Index":39},"Microsoft.HealthcareApis/services@2019-09-16":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2019-09-16/types.json","Index":40},"Microsoft.HealthcareApis/services@2020-03-15":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2020-03-15/types.json","Index":40},"Microsoft.HealthcareApis/services@2020-03-30":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2020-03-30/types.json","Index":57},"Microsoft.HealthcareApis/services/privateEndpointConnections@2020-03-30":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2020-03-30/types.json","Index":61},"Microsoft.HealthcareApis/services@2021-01-11":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-01-11/types.json","Index":70},"Microsoft.HealthcareApis/services/privateEndpointConnections@2021-01-11":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-01-11/types.json","Index":74},"Microsoft.HealthcareApis/services@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":74},"Microsoft.HealthcareApis/services/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":78},"Microsoft.HealthcareApis/workspaces@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":98},"Microsoft.HealthcareApis/workspaces/dicomservices@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":120},"Microsoft.HealthcareApis/workspaces/iotconnectors@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":146},"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":168},"Microsoft.HealthcareApis/workspaces/fhirservices@2021-06-01-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-06-01-preview/types.json","Index":201},"Microsoft.HealthcareApis/services@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":76},"Microsoft.HealthcareApis/services/privateEndpointConnections@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":80},"Microsoft.HealthcareApis/workspaces@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":104},"Microsoft.HealthcareApis/workspaces/dicomservices@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":138},"Microsoft.HealthcareApis/workspaces/iotconnectors@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":160},"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":182},"Microsoft.HealthcareApis/workspaces/fhirservices@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":234},"Microsoft.HealthcareApis/workspaces/privateEndpointConnections@2021-11-01":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2021-11-01/types.json","Index":238},"Microsoft.HealthcareApis/services@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":77},"Microsoft.HealthcareApis/services/privateEndpointConnections@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":81},"Microsoft.HealthcareApis/workspaces@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":105},"Microsoft.HealthcareApis/workspaces/dicomservices@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":139},"Microsoft.HealthcareApis/workspaces/iotconnectors@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":161},"Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":183},"Microsoft.HealthcareApis/workspaces/fhirservices@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":236},"Microsoft.HealthcareApis/workspaces/privateEndpointConnections@2022-01-31-preview":{"RelativePath":"healthcareapis/microsoft.healthcareapis/2022-01-31-preview/types.json","Index":240},"Microsoft.HybridCompute/machines@2019-03-18-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-03-18-preview/types.json","Index":22},"Microsoft.HybridCompute/machines@2019-08-02-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.json","Index":29},"Microsoft.HybridCompute/machines/extensions@2019-08-02-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-08-02-preview/types.json","Index":35},"Microsoft.HybridCompute/machines@2019-12-12":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-12-12/types.json","Index":31},"Microsoft.HybridCompute/machines/extensions@2019-12-12":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2019-12-12/types.json","Index":38},"Microsoft.HybridCompute/machines@2020-07-30-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.json","Index":30},"Microsoft.HybridCompute/machines/extensions@2020-07-30-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-07-30-preview/types.json","Index":37},"Microsoft.HybridCompute/machines@2020-08-02":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-02/types.json","Index":30},"Microsoft.HybridCompute/machines/extensions@2020-08-02":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-02/types.json","Index":37},"Microsoft.HybridCompute/machines@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":31},"Microsoft.HybridCompute/machines/extensions@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":38},"Microsoft.HybridCompute/privateLinkScopes@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":52},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":56},"Microsoft.HybridCompute/privateLinkScopes/scopedResources@2020-08-15-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2020-08-15-preview/types.json","Index":61},"Microsoft.HybridCompute/machines@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":44},"Microsoft.HybridCompute/machines/extensions@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":50},"Microsoft.HybridCompute/privateLinkScopes@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":59},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-01-28-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-01-28-preview/types.json","Index":66},"Microsoft.HybridCompute/machines@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":60},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-03-25-preview/types.json","Index":67},"Microsoft.HybridCompute/machines@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":60},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-04-22-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-04-22-preview/types.json","Index":67},"Microsoft.HybridCompute/machines@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":65},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-05-17-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-17-preview/types.json","Index":69},"Microsoft.HybridCompute/machines@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":45},"Microsoft.HybridCompute/machines/extensions@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":51},"Microsoft.HybridCompute/privateLinkScopes@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":60},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-05-20":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-05-20/types.json","Index":67},"Microsoft.HybridCompute/machines@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":48},"Microsoft.HybridCompute/machines/extensions@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":54},"Microsoft.HybridCompute/privateLinkScopes@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":68},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-06-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-06-10-preview/types.json","Index":72},"Microsoft.HybridCompute/machines@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":51},"Microsoft.HybridCompute/machines/extensions@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":57},"Microsoft.HybridCompute/privateLinkScopes@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":71},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2021-12-10-preview":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2021-12-10-preview/types.json","Index":75},"Microsoft.HybridCompute/machines@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":65},"Microsoft.HybridCompute/machines/extensions@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":71},"Microsoft.HybridCompute/privateLinkScopes@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":86},"Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections@2022-03-10":{"RelativePath":"hybridcompute/microsoft.hybridcompute/2022-03-10/types.json","Index":90},"Microsoft.HybridConnectivity/endpoints@2021-10-06-preview":{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.json","Index":26},"Microsoft.HybridConnectivity/endpoints@2022-05-01-preview":{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.json","Index":26},"Microsoft.HybridData/dataManagers@2016-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2016-06-01/types.json","Index":13},"Microsoft.HybridData/dataManagers/dataServices/jobDefinitions@2016-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2016-06-01/types.json","Index":63},"Microsoft.HybridData/dataManagers/dataStores@2016-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2016-06-01/types.json","Index":73},"Microsoft.HybridData/dataManagers@2019-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2019-06-01/types.json","Index":13},"Microsoft.HybridData/dataManagers/dataServices/jobDefinitions@2019-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2019-06-01/types.json","Index":63},"Microsoft.HybridData/dataManagers/dataStores@2019-06-01":{"RelativePath":"hybriddatamanager/microsoft.hybriddata/2019-06-01/types.json","Index":73},"Microsoft.Kubernetes/connectedClusters@2020-01-01-preview":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.json","Index":31},"Microsoft.Kubernetes/connectedClusters@2021-03-01":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-03-01/types.json","Index":41},"Microsoft.Kubernetes/connectedClusters@2021-04-01-preview":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.json","Index":44},"Microsoft.Kubernetes/connectedClusters@2021-10-01":{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-10-01/types.json","Index":41},"Microsoft.HybridNetwork/networkFunctions@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":54},"Microsoft.HybridNetwork/devices@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":76},"Microsoft.HybridNetwork/vendors@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":90},"Microsoft.HybridNetwork/vendors/vendorSkus@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":166},"Microsoft.HybridNetwork/vendors/vendorSkus/previewSubscriptions@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":170},"Microsoft.HybridNetwork/locations/vendors/networkFunctions@2020-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":198},"Microsoft.HybridNetwork/networkFunctions@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":65},"Microsoft.HybridNetwork/devices@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":87},"Microsoft.HybridNetwork/vendors@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":101},"Microsoft.HybridNetwork/vendors/vendorSkus@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":181},"Microsoft.HybridNetwork/vendors/vendorSkus/previewSubscriptions@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":194},"Microsoft.HybridNetwork/locations/vendors/networkFunctions@2021-05-01":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":222},"Microsoft.HybridNetwork/devices@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":41},"Microsoft.HybridNetwork/networkFunctions@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":87},"Microsoft.HybridNetwork/vendors@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":101},"Microsoft.HybridNetwork/vendors/vendorSkus@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":181},"Microsoft.HybridNetwork/vendors/vendorSkus/previewSubscriptions@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":194},"Microsoft.HybridNetwork/locations/vendors/networkFunctions@2022-01-01-preview":{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":222},"Microsoft.VirtualMachineImages/imageTemplates@2018-02-01-preview":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2018-02-01-preview/types.json","Index":56},"Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2019-02-01-preview/types.json","Index":70},"Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2019-05-01-preview/types.json","Index":83},"Microsoft.VirtualMachineImages/imageTemplates@2020-02-14":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2020-02-14/types.json","Index":90},"Microsoft.VirtualMachineImages/imageTemplates@2021-10-01":{"RelativePath":"imagebuilder/microsoft.virtualmachineimages/2021-10-01/types.json","Index":102},"Microsoft.Intune/locations/iosPolicies@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":55},"Microsoft.Intune/locations/iosPolicies/apps@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":60},"Microsoft.Intune/locations/iosPolicies/groups@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":64},"Microsoft.Intune/locations/androidPolicies@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":110},"Microsoft.Intune/locations/androidPolicies/apps@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":114},"Microsoft.Intune/locations/androidPolicies/groups@2015-01-14-preview":{"RelativePath":"intune/microsoft.intune/2015-01-14-preview/types.json","Index":118},"Microsoft.IoTCentral/iotApps@2018-09-01":{"RelativePath":"iotcentral/microsoft.iotcentral/2018-09-01/types.json","Index":20},"Microsoft.IoTCentral/iotApps@2021-06-01":{"RelativePath":"iotcentral/microsoft.iotcentral/2021-06-01/types.json","Index":25},"Microsoft.IoTCentral/iotApps@2021-11-01-preview":{"RelativePath":"iotcentral/microsoft.iotcentral/2021-11-01-preview/types.json","Index":67},"Microsoft.IoTCentral/iotApps/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"iotcentral/microsoft.iotcentral/2021-11-01-preview/types.json","Index":71},"Microsoft.Devices/IotHubs@2016-02-03":{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":64},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2016-02-03":{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":69},"Microsoft.Devices/IotHubs@2017-01-19":{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":87},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2017-01-19":{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":92},"Microsoft.Devices/IotHubs@2017-07-01":{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":89},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2017-07-01":{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":94},"Microsoft.Devices/IotHubs/certificates@2017-07-01":{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":99},"Microsoft.Devices/IotHubs@2018-01-22":{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":89},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2018-01-22":{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":94},"Microsoft.Devices/IotHubs/certificates@2018-01-22":{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":99},"Microsoft.Devices/IotHubs@2018-04-01":{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":95},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2018-04-01":{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":100},"Microsoft.Devices/IotHubs/certificates@2018-04-01":{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":105},"Microsoft.Devices/IotHubs@2018-12-01-preview":{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":99},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2018-12-01-preview":{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":104},"Microsoft.Devices/IotHubs/certificates@2018-12-01-preview":{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":109},"Microsoft.Devices/IotHubs@2019-03-22-preview":{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":102},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-03-22-preview":{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":107},"Microsoft.Devices/IotHubs/certificates@2019-03-22-preview":{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":112},"Microsoft.Devices/IotHubs@2019-03-22":{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":97},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-03-22":{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":102},"Microsoft.Devices/IotHubs/certificates@2019-03-22":{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":107},"Microsoft.Devices/IotHubs@2019-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":104},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":109},"Microsoft.Devices/IotHubs/certificates@2019-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":114},"Microsoft.Devices/IotHubs@2019-11-04":{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":100},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2019-11-04":{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":105},"Microsoft.Devices/IotHubs/certificates@2019-11-04":{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":110},"Microsoft.Devices/IotHubs@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-03-01":{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-04-01":{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-06-15":{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":139},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":144},"Microsoft.Devices/IotHubs/certificates@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":149},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-07-10-preview":{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":153},"Microsoft.Devices/IotHubs@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":128},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":133},"Microsoft.Devices/IotHubs/certificates@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":138},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-08-01":{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":142},"Microsoft.Devices/IotHubs@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":147},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":152},"Microsoft.Devices/IotHubs/certificates@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":157},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-08-31-preview":{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":161},"Microsoft.Devices/IotHubs@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":136},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":141},"Microsoft.Devices/IotHubs/certificates@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":146},"Microsoft.Devices/iotHubs/privateEndpointConnections@2020-08-31":{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":150},"Microsoft.Devices/IotHubs@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":154},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":159},"Microsoft.Devices/IotHubs/certificates@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":164},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":168},"Microsoft.Devices/IotHubs@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":154},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":159},"Microsoft.Devices/IotHubs/certificates@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":164},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-03-03-preview":{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":168},"Microsoft.Devices/IotHubs@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":147},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":152},"Microsoft.Devices/IotHubs/certificates@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":157},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-03-31":{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":161},"Microsoft.Devices/IotHubs@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":157},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":162},"Microsoft.Devices/IotHubs/certificates@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":167},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-01-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":171},"Microsoft.Devices/IotHubs@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":148},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":153},"Microsoft.Devices/IotHubs/certificates@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":158},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-01":{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":162},"Microsoft.Devices/IotHubs@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":168},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":173},"Microsoft.Devices/IotHubs/certificates@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":178},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02-preview":{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":182},"Microsoft.Devices/IotHubs@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":159},"Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":164},"Microsoft.Devices/IotHubs/certificates@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":169},"Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02":{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":173},"Microsoft.IoTSecurity/defenderSettings@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":23},"Microsoft.IoTSecurity/sites@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":41},"Microsoft.IoTSecurity/sensors@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":58},"Microsoft.IoTSecurity/onPremiseSensors@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":62},"Microsoft.IoTSecurity/locations/deviceGroups@2021-02-01-preview":{"RelativePath":"iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.json","Index":66},"Microsoft.KeyVault/vaults@2015-06-01":{"RelativePath":"keyvault/microsoft.keyvault/2015-06-01/types.json","Index":69},"Microsoft.KeyVault/vaults/secrets@2016-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2016-10-01/types.json","Index":14},"Microsoft.KeyVault/vaults@2016-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2016-10-01/types.json","Index":92},"Microsoft.KeyVault/vaults/accessPolicies@2016-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2016-10-01/types.json","Index":102},"Microsoft.KeyVault/vaults/secrets@2018-02-14-preview":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14-preview/types.json","Index":14},"Microsoft.KeyVault/vaults@2018-02-14-preview":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14-preview/types.json","Index":105},"Microsoft.KeyVault/vaults/accessPolicies@2018-02-14-preview":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14-preview/types.json","Index":115},"Microsoft.KeyVault/vaults/secrets@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":14},"Microsoft.KeyVault/vaults@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":122},"Microsoft.KeyVault/vaults/accessPolicies@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":132},"Microsoft.KeyVault/vaults/privateEndpointConnections@2018-02-14":{"RelativePath":"keyvault/microsoft.keyvault/2018-02-14/types.json","Index":137},"Microsoft.KeyVault/vaults/secrets@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":14},"Microsoft.KeyVault/vaults@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":129},"Microsoft.KeyVault/vaults/accessPolicies@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":139},"Microsoft.KeyVault/vaults/privateEndpointConnections@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":144},"Microsoft.KeyVault/vaults/keys@2019-09-01":{"RelativePath":"keyvault/microsoft.keyvault/2019-09-01/types.json","Index":175},"Microsoft.KeyVault/managedHSMs@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":32},"Microsoft.KeyVault/vaults/keys@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":63},"Microsoft.KeyVault/vaults@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":187},"Microsoft.KeyVault/vaults/accessPolicies@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":197},"Microsoft.KeyVault/vaults/privateEndpointConnections@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":202},"Microsoft.KeyVault/vaults/secrets@2020-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2020-04-01-preview/types.json","Index":209},"Microsoft.KeyVault/vaults@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":132},"Microsoft.KeyVault/vaults/accessPolicies@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":142},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":147},"Microsoft.KeyVault/managedHSMs@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":205},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":210},"Microsoft.KeyVault/vaults/keys@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":250},"Microsoft.KeyVault/vaults/secrets@2021-04-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-04-01-preview/types.json","Index":257},"Microsoft.KeyVault/vaults/keys@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":49},"Microsoft.KeyVault/vaults@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":181},"Microsoft.KeyVault/vaults/accessPolicies@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":191},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":196},"Microsoft.KeyVault/managedHSMs@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":254},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":259},"Microsoft.KeyVault/vaults/secrets@2021-06-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-06-01-preview/types.json","Index":266},"Microsoft.KeyVault/vaults/keys@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":38},"Microsoft.KeyVault/vaults@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":166},"Microsoft.KeyVault/vaults/accessPolicies@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":176},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":181},"Microsoft.KeyVault/managedHSMs@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":239},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":244},"Microsoft.KeyVault/vaults/secrets@2021-10-01":{"RelativePath":"keyvault/microsoft.keyvault/2021-10-01/types.json","Index":251},"Microsoft.KeyVault/vaults/keys@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":49},"Microsoft.KeyVault/vaults@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":181},"Microsoft.KeyVault/vaults/accessPolicies@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":191},"Microsoft.KeyVault/vaults/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":196},"Microsoft.KeyVault/managedHSMs@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":254},"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":259},"Microsoft.KeyVault/vaults/secrets@2021-11-01-preview":{"RelativePath":"keyvault/microsoft.keyvault/2021-11-01-preview/types.json","Index":266},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2019-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2019-11-01-preview/types.json","Index":38},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2020-07-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.json","Index":37},"Microsoft.KubernetesConfiguration/extensions@2020-07-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.json","Index":62},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2020-10-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-10-01-preview/types.json","Index":37},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2021-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-03-01/types.json","Index":47},"Microsoft.KubernetesConfiguration/extensions@2021-05-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.json","Index":48},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2021-05-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.json","Index":77},"Microsoft.KubernetesConfiguration/extensions@2021-09-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-09-01/types.json","Index":50},"Microsoft.KubernetesConfiguration/extensions@2021-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.json","Index":50},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2021-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.json","Index":79},"Microsoft.KubernetesConfiguration/fluxConfigurations@2021-11-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.json","Index":125},"Microsoft.KubernetesConfiguration/extensions@2022-01-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.json","Index":50},"Microsoft.KubernetesConfiguration/fluxConfigurations@2022-01-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.json","Index":94},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2022-01-01-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.json","Index":123},"Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.json","Index":61},"Microsoft.KubernetesConfiguration/sourceControlConfigurations@2022-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.json","Index":90},"Microsoft.KubernetesConfiguration/extensions@2022-03-01":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.json","Index":124},"Microsoft.KubernetesConfiguration/extensions@2022-04-02-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.json","Index":53},"Microsoft.KubernetesConfiguration/privateLinkScopes@2022-04-02-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.json","Index":83},"Microsoft.KubernetesConfiguration/privateLinkScopes/privateEndpointConnections@2022-04-02-preview":{"RelativePath":"kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.json","Index":87},"Microsoft.LabServices/labaccounts@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":23},"Microsoft.LabServices/labaccounts/galleryimages@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":30},"Microsoft.LabServices/labaccounts/labs@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":39},"Microsoft.LabServices/labaccounts/labs/environmentsettings@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":61},"Microsoft.LabServices/labaccounts/labs/environmentsettings/environments@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":69},"Microsoft.LabServices/labaccounts/labs/users@2018-10-15":{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":75},"Microsoft.LabServices/labPlans@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":62},"Microsoft.LabServices/labPlans/images@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":87},"Microsoft.LabServices/labs@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":134},"Microsoft.LabServices/labs/users@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":154},"Microsoft.LabServices/labs/schedules@2021-10-01-preview":{"RelativePath":"labservices/microsoft.labservices/2021-10-01-preview/types.json","Index":179},"Microsoft.LabServices/labPlans/images@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":43},"Microsoft.LabServices/labPlans@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":87},"Microsoft.LabServices/labs@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":134},"Microsoft.LabServices/labs/schedules@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":159},"Microsoft.LabServices/labs/users@2021-11-15-preview":{"RelativePath":"labservices/microsoft.labservices/2021-11-15-preview/types.json","Index":179},"Microsoft.LoadTestService/loadTests@2021-12-01-preview":{"RelativePath":"loadtestservice/microsoft.loadtestservice/2021-12-01-preview/types.json","Index":33},"Microsoft.LoadTestService/loadTests@2022-04-15-preview":{"RelativePath":"loadtestservice/microsoft.loadtestservice/2022-04-15-preview/types.json","Index":42},"Microsoft.Logic/workflows@2015-02-01-preview":{"RelativePath":"logic/microsoft.logic/2015-02-01-preview/types.json","Index":46},"Microsoft.Logic/workflows/accessKeys@2015-02-01-preview":{"RelativePath":"logic/microsoft.logic/2015-02-01-preview/types.json","Index":51},"Microsoft.Logic/integrationAccounts@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":20},"Microsoft.Logic/integrationAccounts/schemas@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":31},"Microsoft.Logic/integrationAccounts/maps@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":40},"Microsoft.Logic/integrationAccounts/partners@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":53},"Microsoft.Logic/integrationAccounts/agreements@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":234},"Microsoft.Logic/integrationAccounts/certificates@2015-08-01-preview":{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":242},"Microsoft.Logic/workflows@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":60},"Microsoft.Logic/integrationAccounts@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":70},"Microsoft.Logic/integrationAccounts/assemblies@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":78},"Microsoft.Logic/integrationAccounts/batchConfigurations@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":118},"Microsoft.Logic/integrationAccounts/schemas@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":127},"Microsoft.Logic/integrationAccounts/maps@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":137},"Microsoft.Logic/integrationAccounts/partners@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":150},"Microsoft.Logic/integrationAccounts/agreements@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":340},"Microsoft.Logic/integrationAccounts/certificates@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":348},"Microsoft.Logic/integrationAccounts/sessions@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":354},"Microsoft.Logic/integrationAccounts/rosettanetprocessconfigurations@2016-06-01":{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":392},"Microsoft.Logic/workflows@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":60},"Microsoft.Logic/integrationAccounts@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":71},"Microsoft.Logic/integrationAccounts/assemblies@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":79},"Microsoft.Logic/integrationAccounts/batchConfigurations@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":119},"Microsoft.Logic/integrationAccounts/schemas@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":128},"Microsoft.Logic/integrationAccounts/maps@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":141},"Microsoft.Logic/integrationAccounts/partners@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":154},"Microsoft.Logic/integrationAccounts/agreements@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":344},"Microsoft.Logic/integrationAccounts/certificates@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":352},"Microsoft.Logic/integrationAccounts/sessions@2018-07-01-preview":{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":358},"Microsoft.Logic/workflows@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":87},"Microsoft.Logic/integrationAccounts@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":106},"Microsoft.Logic/integrationAccounts/assemblies@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":114},"Microsoft.Logic/integrationAccounts/batchConfigurations@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":154},"Microsoft.Logic/integrationAccounts/schemas@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":163},"Microsoft.Logic/integrationAccounts/maps@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":176},"Microsoft.Logic/integrationAccounts/partners@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":189},"Microsoft.Logic/integrationAccounts/agreements@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":379},"Microsoft.Logic/integrationAccounts/certificates@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":387},"Microsoft.Logic/integrationAccounts/sessions@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":393},"Microsoft.Logic/integrationServiceEnvironments@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":443},"Microsoft.Logic/integrationServiceEnvironments/managedApis@2019-05-01":{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":531},"Microsoft.Logz/monitors@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":50},"Microsoft.Logz/monitors/tagRules@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":71},"Microsoft.Logz/monitors/singleSignOnConfigurations@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":91},"Microsoft.Logz/monitors/accounts@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":96},"Microsoft.Logz/monitors/accounts/tagRules@2020-10-01-preview":{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":100},"Microsoft.Logz/monitors@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":50},"Microsoft.Logz/monitors/tagRules@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":71},"Microsoft.Logz/monitors/singleSignOnConfigurations@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":91},"Microsoft.Logz/monitors/accounts@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":96},"Microsoft.Logz/monitors/accounts/tagRules@2020-10-01":{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":100},"Microsoft.Logz/monitors@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":50},"Microsoft.Logz/monitors/tagRules@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":71},"Microsoft.Logz/monitors/singleSignOnConfigurations@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":91},"Microsoft.Logz/monitors/accounts@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":96},"Microsoft.Logz/monitors/accounts/tagRules@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":100},"Microsoft.Logz/monitors/metricsSource@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":105},"Microsoft.Logz/monitors/metricsSource/tagRules@2022-01-01-preview":{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":123},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForEDMUpload@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":68},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForEDMUpload/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":72},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":81},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":85},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365SecurityCenter@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":94},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForM365SecurityCenter/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":98},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":107},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":111},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":120},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":124},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForMIPPolicySync@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":133},"Microsoft.M365SecurityAndCompliance/privateLinkServicesForMIPPolicySync/privateEndpointConnections@2021-03-25-preview":{"RelativePath":"m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.json","Index":137},"Microsoft.MachineLearning/workspaces@2016-04-01":{"RelativePath":"machinelearning/microsoft.machinelearning/2016-04-01/types.json","Index":27},"Microsoft.MachineLearning/commitmentPlans@2016-05-01-preview":{"RelativePath":"machinelearning/microsoft.machinelearning/2016-05-01-preview/types.json","Index":16},"Microsoft.MachineLearning/webServices@2016-05-01-preview":{"RelativePath":"machinelearning/microsoft.machinelearning/2016-05-01-preview/types.json","Index":117},"Microsoft.MachineLearning/webServices@2017-01-01":{"RelativePath":"machinelearning/microsoft.machinelearning/2017-01-01/types.json","Index":109},"Microsoft.MachineLearning/workspaces@2019-10-01":{"RelativePath":"machinelearning/microsoft.machinelearning/2019-10-01/types.json","Index":28},"Microsoft.MachineLearningCompute/operationalizationClusters@2017-06-01-preview":{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.json","Index":91},"Microsoft.MachineLearningCompute/operationalizationClusters@2017-08-01-preview":{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.json","Index":102},"Microsoft.MachineLearningExperimentation/accounts@2017-05-01-preview":{"RelativePath":"machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.json","Index":20},"Microsoft.MachineLearningExperimentation/accounts/workspaces@2017-05-01-preview":{"RelativePath":"machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.json","Index":32},"Microsoft.MachineLearningExperimentation/accounts/workspaces/projects@2017-05-01-preview":{"RelativePath":"machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.json","Index":44},"Microsoft.MachineLearningServices/workspaces@2018-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2018-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":64},"Microsoft.MachineLearningServices/workspaces@2018-11-19":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2018-11-19":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":81},"Microsoft.MachineLearningServices/workspaces@2019-05-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2019-05-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":81},"Microsoft.MachineLearningServices/workspaces@2019-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":23},"Microsoft.MachineLearningServices/workspaces/computes@2019-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":85},"Microsoft.MachineLearningServices/workspaces@2019-11-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":24},"Microsoft.MachineLearningServices/workspaces/computes@2019-11-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":86},"Microsoft.MachineLearningServices/workspaces@2020-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":29},"Microsoft.MachineLearningServices/workspaces/computes@2020-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":91},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":108},"Microsoft.MachineLearningServices/workspaces@2020-02-18-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":29},"Microsoft.MachineLearningServices/workspaces/computes@2020-02-18-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":130},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-02-18-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":147},"Microsoft.MachineLearningServices/workspaces@2020-03-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":61},"Microsoft.MachineLearningServices/workspaces/computes@2020-03-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":123},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-03-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":128},"Microsoft.MachineLearningServices/workspaces@2020-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":63},"Microsoft.MachineLearningServices/workspaces/computes@2020-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":130},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":135},"Microsoft.MachineLearningServices/workspaces@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":61},"Microsoft.MachineLearningServices/workspaces/computes@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":123},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":128},"Microsoft.MachineLearningServices/workspaces/linkedWorkspaces@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":133},"Microsoft.MachineLearningServices/workspaces/services@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":180},"Microsoft.MachineLearningServices/workspaces/datasets@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":217},"Microsoft.MachineLearningServices/workspaces/datastores@2020-05-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":290},"Microsoft.MachineLearningServices/workspaces@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":61},"Microsoft.MachineLearningServices/workspaces/computes@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":127},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":132},"Microsoft.MachineLearningServices/workspaces/linkedWorkspaces@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":137},"Microsoft.MachineLearningServices/workspaces/services@2020-05-15-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":184},"Microsoft.MachineLearningServices/workspaces@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":62},"Microsoft.MachineLearningServices/workspaces/connections@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":67},"Microsoft.MachineLearningServices/workspaces/computes@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":161},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-06-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":165},"Microsoft.MachineLearningServices/workspaces@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":62},"Microsoft.MachineLearningServices/workspaces/connections@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":67},"Microsoft.MachineLearningServices/workspaces/computes@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":185},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-08-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":189},"Microsoft.MachineLearningServices/workspaces/labelingJobs@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":63},"Microsoft.MachineLearningServices/workspaces@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":117},"Microsoft.MachineLearningServices/workspaces/computes@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":239},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":244},"Microsoft.MachineLearningServices/workspaces/linkedServices@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":250},"Microsoft.MachineLearningServices/workspaces/services@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":297},"Microsoft.MachineLearningServices/workspaces/connections@2020-09-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":302},"Microsoft.MachineLearningServices/workspaces@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":77},"Microsoft.MachineLearningServices/workspaces/computes@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":203},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":208},"Microsoft.MachineLearningServices/workspaces/services@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":255},"Microsoft.MachineLearningServices/workspaces/connections@2021-01-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":262},"Microsoft.MachineLearningServices/workspaces@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":77},"Microsoft.MachineLearningServices/workspaces/computes@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":248},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":253},"Microsoft.MachineLearningServices/workspaces/connections@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":260},"Microsoft.MachineLearningServices/workspaces/batchEndpoints@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":281},"Microsoft.MachineLearningServices/workspaces/batchEndpoints/deployments@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":309},"Microsoft.MachineLearningServices/workspaces/codes@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":316},"Microsoft.MachineLearningServices/workspaces/codes/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":323},"Microsoft.MachineLearningServices/workspaces/data@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":330},"Microsoft.MachineLearningServices/workspaces/data/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":340},"Microsoft.MachineLearningServices/workspaces/datastores@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":426},"Microsoft.MachineLearningServices/workspaces/environments@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":433},"Microsoft.MachineLearningServices/workspaces/environments/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":454},"Microsoft.MachineLearningServices/workspaces/jobs@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":560},"Microsoft.MachineLearningServices/workspaces/labelingJobs@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":618},"Microsoft.MachineLearningServices/workspaces/models@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":625},"Microsoft.MachineLearningServices/workspaces/models/versions@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":635},"Microsoft.MachineLearningServices/workspaces/onlineEndpoints@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":654},"Microsoft.MachineLearningServices/workspaces/onlineEndpoints/deployments@2021-03-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":682},"Microsoft.MachineLearningServices/workspaces@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":77},"Microsoft.MachineLearningServices/workspaces/computes@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":208},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":213},"Microsoft.MachineLearningServices/workspaces/services@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":260},"Microsoft.MachineLearningServices/workspaces/connections@2021-04-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":267},"Microsoft.MachineLearningServices/workspaces@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":80},"Microsoft.MachineLearningServices/workspaces/computes@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":217},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":222},"Microsoft.MachineLearningServices/workspaces/connections@2021-07-01":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":229},"Microsoft.MachineLearningServices/workspaces@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":86},"Microsoft.MachineLearningServices/workspaces/computes@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":223},"Microsoft.MachineLearningServices/workspaces/privateEndpointConnections@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":228},"Microsoft.MachineLearningServices/workspaces/connections@2022-01-01-preview":{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":235},"Microsoft.Maintenance/applyUpdates@2018-06-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2018-06-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2018-06-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2018-06-01-preview/types.json","Index":17},"Microsoft.Maintenance/maintenanceConfigurations@2018-06-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2018-06-01-preview/types.json","Index":29},"Microsoft.Maintenance/applyUpdates@2020-04-01":{"RelativePath":"maintenance/microsoft.maintenance/2020-04-01/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2020-04-01":{"RelativePath":"maintenance/microsoft.maintenance/2020-04-01/types.json","Index":17},"Microsoft.Maintenance/maintenanceConfigurations@2020-04-01":{"RelativePath":"maintenance/microsoft.maintenance/2020-04-01/types.json","Index":29},"Microsoft.Maintenance/applyUpdates@2020-07-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2020-07-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2020-07-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2020-07-01-preview/types.json","Index":17},"Microsoft.Maintenance/maintenanceConfigurations@2020-07-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2020-07-01-preview/types.json","Index":38},"Microsoft.Maintenance/applyUpdates@2021-04-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-04-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2021-04-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-04-01-preview/types.json","Index":28},"Microsoft.Maintenance/maintenanceConfigurations@2021-04-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-04-01-preview/types.json","Index":67},"Microsoft.Maintenance/applyUpdates@2021-05-01":{"RelativePath":"maintenance/microsoft.maintenance/2021-05-01/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2021-05-01":{"RelativePath":"maintenance/microsoft.maintenance/2021-05-01/types.json","Index":28},"Microsoft.Maintenance/maintenanceConfigurations@2021-05-01":{"RelativePath":"maintenance/microsoft.maintenance/2021-05-01/types.json","Index":46},"Microsoft.Maintenance/applyUpdates@2021-09-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-09-01-preview/types.json","Index":12},"Microsoft.Maintenance/configurationAssignments@2021-09-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-09-01-preview/types.json","Index":28},"Microsoft.Maintenance/maintenanceConfigurations@2021-09-01-preview":{"RelativePath":"maintenance/microsoft.maintenance/2021-09-01-preview/types.json","Index":67},"Microsoft.ManagedNetwork/managedNetworks@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":52},"Microsoft.ManagedNetwork/scopeAssignments@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":62},"Microsoft.ManagedNetwork/managedNetworks/managedNetworkGroups@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":68},"Microsoft.ManagedNetwork/managedNetworks/managedNetworkPeeringPolicies@2019-06-01-preview":{"RelativePath":"managednetwork/microsoft.managednetwork/2019-06-01-preview/types.json","Index":72},"Microsoft.ManagedServices/registrationDefinitions@2018-06-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2018-06-01-preview/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2018-06-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2018-06-01-preview/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2019-04-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2019-04-01-preview/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2019-04-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2019-04-01-preview/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2019-06-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-06-01/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2019-06-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-06-01/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2019-09-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-09-01/types.json","Index":29},"Microsoft.ManagedServices/registrationAssignments@2019-09-01":{"RelativePath":"managedservices/microsoft.managedservices/2019-09-01/types.json","Index":63},"Microsoft.ManagedServices/registrationDefinitions@2020-02-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2020-02-01-preview/types.json","Index":37},"Microsoft.ManagedServices/registrationAssignments@2020-02-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2020-02-01-preview/types.json","Index":72},"Microsoft.ManagedServices/registrationDefinitions@2022-01-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2022-01-01-preview/types.json","Index":48},"Microsoft.ManagedServices/registrationAssignments@2022-01-01-preview":{"RelativePath":"managedservices/microsoft.managedservices/2022-01-01-preview/types.json","Index":83},"Microsoft.Management/managementGroups@2017-11-01-preview":{"RelativePath":"managementgroups/microsoft.management/2017-11-01-preview/types.json","Index":20},"Microsoft.Management/managementGroups/subscriptions@2017-11-01-preview":{"RelativePath":"managementgroups/microsoft.management/2017-11-01-preview/types.json","Index":24},"Microsoft.Management/managementGroups@2018-01-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-01-01-preview/types.json","Index":22},"Microsoft.Management/managementGroups/subscriptions@2018-01-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-01-01-preview/types.json","Index":26},"Microsoft.Management/managementGroups@2018-03-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-03-01-preview/types.json","Index":22},"Microsoft.Management/managementGroups/subscriptions@2018-03-01-preview":{"RelativePath":"managementgroups/microsoft.management/2018-03-01-preview/types.json","Index":26},"Microsoft.Management/managementGroups@2019-11-01":{"RelativePath":"managementgroups/microsoft.management/2019-11-01/types.json","Index":24},"Microsoft.Management/managementGroups/subscriptions@2019-11-01":{"RelativePath":"managementgroups/microsoft.management/2019-11-01/types.json","Index":28},"Microsoft.Management/managementGroups@2020-02-01":{"RelativePath":"managementgroups/microsoft.management/2020-02-01/types.json","Index":24},"Microsoft.Management/managementGroups/subscriptions@2020-02-01":{"RelativePath":"managementgroups/microsoft.management/2020-02-01/types.json","Index":28},"Microsoft.Management/managementGroups/settings@2020-02-01":{"RelativePath":"managementgroups/microsoft.management/2020-02-01/types.json","Index":34},"Microsoft.Management/managementGroups@2020-05-01":{"RelativePath":"managementgroups/microsoft.management/2020-05-01/types.json","Index":22},"Microsoft.Management/managementGroups/subscriptions@2020-05-01":{"RelativePath":"managementgroups/microsoft.management/2020-05-01/types.json","Index":28},"Microsoft.Management/managementGroups/settings@2020-05-01":{"RelativePath":"managementgroups/microsoft.management/2020-05-01/types.json","Index":34},"Microsoft.Management/managementGroups@2020-10-01":{"RelativePath":"managementgroups/microsoft.management/2020-10-01/types.json","Index":23},"Microsoft.Management/managementGroups/subscriptions@2020-10-01":{"RelativePath":"managementgroups/microsoft.management/2020-10-01/types.json","Index":29},"Microsoft.Management/managementGroups/settings@2020-10-01":{"RelativePath":"managementgroups/microsoft.management/2020-10-01/types.json","Index":35},"Microsoft.Management/managementGroups@2021-04-01":{"RelativePath":"managementgroups/microsoft.management/2021-04-01/types.json","Index":24},"Microsoft.Management/managementGroups/subscriptions@2021-04-01":{"RelativePath":"managementgroups/microsoft.management/2021-04-01/types.json","Index":30},"Microsoft.Management/managementGroups/settings@2021-04-01":{"RelativePath":"managementgroups/microsoft.management/2021-04-01/types.json","Index":36},"Microsoft.ManagementPartner/partners@2018-02-01":{"RelativePath":"managementpartner/microsoft.managementpartner/2018-02-01/types.json","Index":15},"Microsoft.Maps/accounts@2017-01-01-preview":{"RelativePath":"maps/microsoft.maps/2017-01-01-preview/types.json","Index":14},"Microsoft.Maps/accounts@2018-05-01":{"RelativePath":"maps/microsoft.maps/2018-05-01/types.json","Index":14},"Microsoft.Maps/accounts@2020-02-01-preview":{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":25},"Microsoft.Maps/accounts/privateAtlases@2020-02-01-preview":{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":31},"Microsoft.Maps/accounts/creators@2020-02-01-preview":{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":37},"Microsoft.Maps/accounts@2021-02-01":{"RelativePath":"maps/microsoft.maps/2021-02-01/types.json","Index":32},"Microsoft.Maps/accounts/creators@2021-02-01":{"RelativePath":"maps/microsoft.maps/2021-02-01/types.json","Index":38},"Microsoft.Maps/accounts@2021-07-01-preview":{"RelativePath":"maps/microsoft.maps/2021-07-01-preview/types.json","Index":42},"Microsoft.Maps/accounts/creators@2021-07-01-preview":{"RelativePath":"maps/microsoft.maps/2021-07-01-preview/types.json","Index":48},"Microsoft.Maps/accounts@2021-12-01-preview":{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":46},"Microsoft.Maps/accounts/creators@2021-12-01-preview":{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":52},"Microsoft.DBforMariaDB/servers@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":51},"Microsoft.DBforMariaDB/servers/firewallRules@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":56},"Microsoft.DBforMariaDB/servers/virtualNetworkRules@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":67},"Microsoft.DBforMariaDB/servers/databases@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":72},"Microsoft.DBforMariaDB/servers/configurations@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":77},"Microsoft.DBforMariaDB/servers/securityAlertPolicies@2018-06-01-preview":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01-preview/types.json","Index":89},"Microsoft.DBforMariaDB/servers@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":69},"Microsoft.DBforMariaDB/servers/firewallRules@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":74},"Microsoft.DBforMariaDB/servers/virtualNetworkRules@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":85},"Microsoft.DBforMariaDB/servers/databases@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":90},"Microsoft.DBforMariaDB/servers/configurations@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":95},"Microsoft.DBforMariaDB/servers/privateEndpointConnections@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":101},"Microsoft.DBforMariaDB/servers/securityAlertPolicies@2018-06-01":{"RelativePath":"mariadb/microsoft.dbformariadb/2018-06-01/types.json","Index":113},"Microsoft.Marketplace/privateStores/offers@2020-01-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-01-01/types.json","Index":21},"Microsoft.Marketplace/privateStores@2020-01-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-01-01/types.json","Index":30},"Microsoft.Marketplace/privateStores/requestApprovals@2020-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-12-01/types.json","Index":30},"Microsoft.Marketplace/privateStores/adminRequestApprovals@2020-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2020-12-01/types.json","Index":43},"Microsoft.Marketplace/privateStores@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":31},"Microsoft.Marketplace/privateStores/requestApprovals@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":43},"Microsoft.Marketplace/privateStores/adminRequestApprovals@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":57},"Microsoft.Marketplace/privateStores/collections@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":63},"Microsoft.Marketplace/privateStores/collections/offers@2021-06-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-06-01/types.json","Index":77},"Microsoft.Marketplace/privateStores@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":31},"Microsoft.Marketplace/privateStores/requestApprovals@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":43},"Microsoft.Marketplace/privateStores/adminRequestApprovals@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":57},"Microsoft.Marketplace/privateStores/collections@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":63},"Microsoft.Marketplace/privateStores/collections/offers@2021-12-01":{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":77},"Microsoft.MarketplaceOrdering/offerTypes/publishers/offers/plans/agreements@2015-06-01":{"RelativePath":"marketplaceordering/microsoft.marketplaceordering/2015-06-01/types.json","Index":13},"Microsoft.MarketplaceOrdering/offerTypes/publishers/offers/plans/agreements@2021-01-01":{"RelativePath":"marketplaceordering/microsoft.marketplaceordering/2021-01-01/types.json","Index":24},"Microsoft.Media/mediaservices@2015-10-01":{"RelativePath":"mediaservices/microsoft.media/2015-10-01/types.json","Index":17},"Microsoft.Media/mediaservices@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":18},"Microsoft.Media/mediaServices/assets@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":26},"Microsoft.Media/mediaServices/contentKeyPolicies@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":93},"Microsoft.Media/mediaServices/transforms@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":191},"Microsoft.Media/mediaServices/transforms/jobs@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":250},"Microsoft.Media/mediaServices/streamingPolicies@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":282},"Microsoft.Media/mediaServices/streamingLocators@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":289},"Microsoft.Media/mediaservices/liveEvents@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":322},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":332},"Microsoft.Media/mediaservices/streamingEndpoints@2018-03-30-preview":{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":350},"Microsoft.Media/mediaservices@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":18},"Microsoft.Media/mediaServices/assets@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":26},"Microsoft.Media/mediaServices/contentKeyPolicies@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":93},"Microsoft.Media/mediaServices/transforms@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":191},"Microsoft.Media/mediaServices/transforms/jobs@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":251},"Microsoft.Media/mediaServices/streamingPolicies@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":283},"Microsoft.Media/mediaServices/streamingLocators@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":295},"Microsoft.Media/mediaservices/liveEvents@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":328},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":338},"Microsoft.Media/mediaservices/streamingEndpoints@2018-06-01-preview":{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":356},"Microsoft.Media/mediaServices/accountFilters@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":28},"Microsoft.Media/mediaservices@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":51},"Microsoft.Media/mediaServices/contentKeyPolicies@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":118},"Microsoft.Media/mediaServices/transforms@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":229},"Microsoft.Media/mediaServices/transforms/jobs@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":289},"Microsoft.Media/mediaServices/streamingPolicies@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":321},"Microsoft.Media/mediaServices/streamingLocators@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":334},"Microsoft.Media/mediaservices/liveEvents@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":375},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":385},"Microsoft.Media/mediaservices/streamingEndpoints@2018-07-01":{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":403},"Microsoft.Media/mediaServices/accountFilters@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":28},"Microsoft.Media/mediaservices@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":51},"Microsoft.Media/mediaServices/contentKeyPolicies@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":118},"Microsoft.Media/mediaServices/transforms@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":229},"Microsoft.Media/mediaServices/transforms/jobs@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":289},"Microsoft.Media/mediaServices/streamingPolicies@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":321},"Microsoft.Media/mediaServices/streamingLocators@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":334},"Microsoft.Media/mediaservices/liveEvents@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":375},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":385},"Microsoft.Media/mediaservices/streamingEndpoints@2019-05-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":403},"Microsoft.Media/mediaServices/mediaGraphs@2019-09-01-preview":{"RelativePath":"mediaservices/microsoft.media/2019-09-01-preview/types.json","Index":27},"Microsoft.Media/mediaServices/mediaGraphs@2020-02-01-preview":{"RelativePath":"mediaservices/microsoft.media/2020-02-01-preview/types.json","Index":42},"Microsoft.Media/mediaServices/accountFilters@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":51},"Microsoft.Media/mediaServices/contentKeyPolicies@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":120},"Microsoft.Media/mediaServices/transforms@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":260},"Microsoft.Media/mediaServices/transforms/jobs@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":368},"Microsoft.Media/mediaServices/streamingPolicies@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":400},"Microsoft.Media/mediaServices/streamingLocators@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":413},"Microsoft.Media/mediaservices/liveEvents@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":459},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":469},"Microsoft.Media/mediaservices/streamingEndpoints@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":487},"Microsoft.Media/mediaservices@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":510},"Microsoft.Media/mediaservices/privateEndpointConnections@2020-05-01":{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":526},"Microsoft.Media/mediaservices@2021-05-01":{"RelativePath":"mediaservices/microsoft.media/2021-05-01/types.json","Index":47},"Microsoft.Media/mediaservices/privateEndpointConnections@2021-05-01":{"RelativePath":"mediaservices/microsoft.media/2021-05-01/types.json","Index":63},"Microsoft.Media/mediaservices@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":50},"Microsoft.Media/mediaservices/privateEndpointConnections@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":66},"Microsoft.Media/mediaServices/accountFilters@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":87},"Microsoft.Media/mediaServices/assets@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":95},"Microsoft.Media/mediaServices/assets/assetFilters@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":99},"Microsoft.Media/mediaServices/contentKeyPolicies@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":168},"Microsoft.Media/mediaServices/transforms@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":316},"Microsoft.Media/mediaServices/transforms/jobs@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":424},"Microsoft.Media/mediaServices/streamingPolicies@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":456},"Microsoft.Media/mediaServices/streamingLocators@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":469},"Microsoft.Media/mediaservices/liveEvents@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":517},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":527},"Microsoft.Media/mediaservices/streamingEndpoints@2021-06-01":{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":545},"Microsoft.Media/mediaServices/accountFilters@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":39},"Microsoft.Media/mediaServices/assets@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":47},"Microsoft.Media/mediaServices/assets/assetFilters@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":51},"Microsoft.Media/mediaServices/assets/tracks@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":71},"Microsoft.Media/mediaServices/contentKeyPolicies@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":140},"Microsoft.Media/mediaServices/transforms@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":293},"Microsoft.Media/mediaServices/transforms/jobs@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":401},"Microsoft.Media/mediaServices/streamingPolicies@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":433},"Microsoft.Media/mediaServices/streamingLocators@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":446},"Microsoft.Media/mediaservices/liveEvents@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":495},"Microsoft.Media/mediaservices/liveEvents/liveOutputs@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":505},"Microsoft.Media/mediaservices/streamingEndpoints@2021-11-01":{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":524},"Microsoft.Migrate/projects@2018-02-02":{"RelativePath":"migrate/microsoft.migrate/2018-02-02/types.json","Index":24},"Microsoft.Migrate/projects/groups@2018-02-02":{"RelativePath":"migrate/microsoft.migrate/2018-02-02/types.json","Index":31},"Microsoft.Migrate/projects/groups/assessments@2018-02-02":{"RelativePath":"migrate/microsoft.migrate/2018-02-02/types.json","Index":169},"Microsoft.Migrate/assessmentProjects@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":37},"Microsoft.Migrate/assessmentProjects/groups@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":49},"Microsoft.Migrate/assessmentProjects/groups/assessments@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":233},"Microsoft.Migrate/assessmentProjects/hypervcollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":240},"Microsoft.Migrate/assessmentProjects/servercollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":244},"Microsoft.Migrate/assessmentProjects/vmwarecollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":248},"Microsoft.Migrate/assessmentProjects/importcollectors@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":253},"Microsoft.Migrate/assessmentprojects/privateEndpointConnections@2019-10-01":{"RelativePath":"migrate/microsoft.migrate/2019-10-01/types.json","Index":257},"Microsoft.Migrate/migrateProjects@2020-05-01":{"RelativePath":"migrate/microsoft.migrate/2020-05-01/types.json","Index":80},"Microsoft.Migrate/migrateProjects/privateEndpointConnections@2020-05-01":{"RelativePath":"migrate/microsoft.migrate/2020-05-01/types.json","Index":90},"Microsoft.OffAzure/HyperVSites/clusters@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":16},"Microsoft.OffAzure/HyperVSites/hosts@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":22},"Microsoft.OffAzure/HyperVSites@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":30},"Microsoft.OffAzure/VMwareSites@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":35},"Microsoft.OffAzure/VMwareSites/vCenters@2020-01-01":{"RelativePath":"migrate/microsoft.offazure/2020-01-01/types.json","Index":41},"Microsoft.OffAzure/HyperVSites/clusters@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":16},"Microsoft.OffAzure/HyperVSites/hosts@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":22},"Microsoft.OffAzure/HyperVSites@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":41},"Microsoft.OffAzure/VMwareSites@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":46},"Microsoft.OffAzure/VMwareSites/vCenters@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":52},"Microsoft.OffAzure/MasterSites@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":77},"Microsoft.OffAzure/masterSites/privateEndpointConnections@2020-07-07":{"RelativePath":"migrate/microsoft.offazure/2020-07-07/types.json","Index":81},"Microsoft.Migrate/migrateProjects@2018-09-01-preview":{"RelativePath":"migrateprojects/microsoft.migrate/2018-09-01-preview/types.json","Index":51},"Microsoft.Migrate/migrateProjects/solutions@2018-09-01-preview":{"RelativePath":"migrateprojects/microsoft.migrate/2018-09-01-preview/types.json","Index":92},"Microsoft.MixedReality/spatialAnchorsAccounts@2019-02-28-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2019-02-28-preview/types.json","Index":15},"Microsoft.MixedReality/remoteRenderingAccounts@2019-12-02-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2019-12-02-preview/types.json","Index":15},"Microsoft.MixedReality/spatialAnchorsAccounts@2019-12-02-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2019-12-02-preview/types.json","Index":20},"Microsoft.MixedReality/remoteRenderingAccounts@2020-04-06-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2020-04-06-preview/types.json","Index":32},"Microsoft.MixedReality/spatialAnchorsAccounts@2020-05-01":{"RelativePath":"mixedreality/microsoft.mixedreality/2020-05-01/types.json","Index":32},"Microsoft.MixedReality/spatialAnchorsAccounts@2021-01-01":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":32},"Microsoft.MixedReality/remoteRenderingAccounts@2021-01-01":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":37},"Microsoft.MixedReality/spatialAnchorsAccounts@2021-03-01-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":32},"Microsoft.MixedReality/remoteRenderingAccounts@2021-03-01-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":37},"Microsoft.MixedReality/objectAnchorsAccounts@2021-03-01-preview":{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":44},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes/attachedDataNetworks@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":42},"Microsoft.MobileNetwork/mobileNetworks/dataNetworks@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":56},"Microsoft.MobileNetwork/mobileNetworks@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":71},"Microsoft.MobileNetwork/mobileNetworks/sites@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":87},"Microsoft.MobileNetwork/sims@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":111},"Microsoft.MobileNetwork/packetCoreControlPlanes@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":129},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":143},"Microsoft.MobileNetwork/mobileNetworks/services@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":186},"Microsoft.MobileNetwork/mobileNetworks/simPolicies@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":220},"Microsoft.MobileNetwork/mobileNetworks/slices@2022-01-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":235},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes/attachedDataNetworks@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":42},"Microsoft.MobileNetwork/mobileNetworks/dataNetworks@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":56},"Microsoft.MobileNetwork/mobileNetworks@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":71},"Microsoft.MobileNetwork/mobileNetworks/sites@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":87},"Microsoft.MobileNetwork/sims@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":112},"Microsoft.MobileNetwork/packetCoreControlPlanes@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":130},"Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":144},"Microsoft.MobileNetwork/mobileNetworks/services@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":187},"Microsoft.MobileNetwork/mobileNetworks/simPolicies@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":221},"Microsoft.MobileNetwork/mobileNetworks/slices@2022-03-01-preview":{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":236},"Microsoft.Insights/alertrules@2014-04-01":{"RelativePath":"monitor/microsoft.insights/2014-04-01/types.json","Index":51},"Microsoft.Insights/autoscalesettings@2014-04-01":{"RelativePath":"monitor/microsoft.insights/2014-04-01/types.json","Index":122},"Microsoft.Insights/autoscalesettings@2015-04-01":{"RelativePath":"monitor/microsoft.insights/2015-04-01/types.json","Index":78},"microsoft.insights/diagnosticSettings@2015-07-01":{"RelativePath":"monitor/microsoft.insights/2015-07-01/types.json","Index":19},"Microsoft.Insights/alertrules@2016-03-01":{"RelativePath":"monitor/microsoft.insights/2016-03-01/types.json","Index":51},"Microsoft.Insights/logprofiles@2016-03-01":{"RelativePath":"monitor/microsoft.insights/2016-03-01/types.json","Index":60},"microsoft.insights/diagnosticSettings@2016-09-01":{"RelativePath":"monitor/microsoft.insights/2016-09-01/types.json","Index":19},"microsoft.insights/activityLogAlerts@2017-03-01-preview":{"RelativePath":"monitor/microsoft.insights/2017-03-01-preview/types.json","Index":21},"microsoft.insights/activityLogAlerts@2017-04-01":{"RelativePath":"monitor/microsoft.insights/2017-04-01/types.json","Index":21},"microsoft.insights/actionGroups@2017-04-01":{"RelativePath":"monitor/microsoft.insights/2017-04-01/types.json","Index":47},"Microsoft.Insights/diagnosticSettings@2017-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2017-05-01-preview/types.json","Index":17},"Microsoft.Insights/metricAlerts@2018-03-01":{"RelativePath":"monitor/microsoft.insights/2018-03-01/types.json","Index":72},"microsoft.insights/actionGroups@2018-03-01":{"RelativePath":"monitor/microsoft.insights/2018-03-01/types.json","Index":104},"Microsoft.Insights/scheduledQueryRules@2018-04-16":{"RelativePath":"monitor/microsoft.insights/2018-04-16/types.json","Index":63},"microsoft.insights/guestDiagnosticSettingsAssociation@2018-06-01-preview":{"RelativePath":"monitor/microsoft.insights/2018-06-01-preview/types.json","Index":13},"microsoft.insights/guestDiagnosticSettings@2018-06-01-preview":{"RelativePath":"monitor/microsoft.insights/2018-06-01-preview/types.json","Index":43},"microsoft.insights/actionGroups@2018-09-01":{"RelativePath":"monitor/microsoft.insights/2018-09-01/types.json","Index":41},"microsoft.insights/actionGroups@2019-03-01":{"RelativePath":"monitor/microsoft.insights/2019-03-01/types.json","Index":41},"microsoft.insights/actionGroups@2019-06-01":{"RelativePath":"monitor/microsoft.insights/2019-06-01/types.json","Index":41},"microsoft.insights/privateLinkScopes@2019-10-17-preview":{"RelativePath":"monitor/microsoft.insights/2019-10-17-preview/types.json","Index":18},"Microsoft.Insights/privateLinkScopes/privateEndpointConnections@2019-10-17-preview":{"RelativePath":"monitor/microsoft.insights/2019-10-17-preview/types.json","Index":22},"Microsoft.Insights/privateLinkScopes/scopedResources@2019-10-17-preview":{"RelativePath":"monitor/microsoft.insights/2019-10-17-preview/types.json","Index":27},"Microsoft.Insights/dataCollectionRuleAssociations@2019-11-01-preview":{"RelativePath":"monitor/microsoft.insights/2019-11-01-preview/types.json","Index":18},"Microsoft.Insights/dataCollectionRules@2019-11-01-preview":{"RelativePath":"monitor/microsoft.insights/2019-11-01-preview/types.json","Index":111},"microsoft.insights/diagnosticSettings@2020-01-01-preview":{"RelativePath":"monitor/microsoft.insights/2020-01-01-preview/types.json","Index":14},"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2020-05-01-preview/types.json","Index":40},"Microsoft.Insights/activityLogAlerts@2020-10-01":{"RelativePath":"monitor/microsoft.insights/2020-10-01/types.json","Index":25},"Microsoft.Insights/scheduledQueryRules@2021-02-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-02-01-preview/types.json","Index":54},"Microsoft.Insights/dataCollectionEndpoints@2021-04-01":{"RelativePath":"monitor/microsoft.insights/2021-04-01/types.json","Index":39},"Microsoft.Insights/dataCollectionRuleAssociations@2021-04-01":{"RelativePath":"monitor/microsoft.insights/2021-04-01/types.json","Index":61},"Microsoft.Insights/dataCollectionRules@2021-04-01":{"RelativePath":"monitor/microsoft.insights/2021-04-01/types.json","Index":165},"Microsoft.Insights/autoscalesettings@2021-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-05-01-preview/types.json","Index":94},"Microsoft.Insights/diagnosticSettings@2021-05-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-05-01-preview/types.json","Index":104},"microsoft.insights/privateLinkScopes@2021-07-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-07-01-preview/types.json","Index":53},"Microsoft.Insights/privateLinkScopes/privateEndpointConnections@2021-07-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-07-01-preview/types.json","Index":57},"Microsoft.Insights/privateLinkScopes/scopedResources@2021-07-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-07-01-preview/types.json","Index":62},"Microsoft.Insights/scheduledQueryRules@2021-08-01":{"RelativePath":"monitor/microsoft.insights/2021-08-01/types.json","Index":54},"Microsoft.Insights/dataCollectionEndpoints@2021-09-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-09-01-preview/types.json","Index":39},"Microsoft.Insights/dataCollectionRuleAssociations@2021-09-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-09-01-preview/types.json","Index":62},"Microsoft.Insights/dataCollectionRules@2021-09-01-preview":{"RelativePath":"monitor/microsoft.insights/2021-09-01-preview/types.json","Index":201},"Microsoft.Insights/actionGroups@2021-09-01":{"RelativePath":"monitor/microsoft.insights/2021-09-01/types.json","Index":43},"Microsoft.Insights/actionGroups@2022-04-01":{"RelativePath":"monitor/microsoft.insights/2022-04-01/types.json","Index":43},"Microsoft.ManagedIdentity/userAssignedIdentities@2015-08-31-preview":{"RelativePath":"msi/microsoft.managedidentity/2015-08-31-preview/types.json","Index":13},"Microsoft.ManagedIdentity/userAssignedIdentities@2018-11-30":{"RelativePath":"msi/microsoft.managedidentity/2018-11-30/types.json","Index":13},"Microsoft.ManagedIdentity/userAssignedIdentities@2021-09-30-preview":{"RelativePath":"msi/microsoft.managedidentity/2021-09-30-preview/types.json","Index":13},"Microsoft.DBforMySQL/servers@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":77},"Microsoft.DBforMySQL/servers/firewallRules@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":82},"Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":93},"Microsoft.DBforMySQL/servers/databases@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":98},"Microsoft.DBforMySQL/servers/configurations@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":103},"Microsoft.DBforMySQL/servers/administrators@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":110},"Microsoft.DBforMySQL/servers/securityAlertPolicies@2017-12-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01-preview/types.json","Index":122},"Microsoft.DBforMySQL/servers@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":77},"Microsoft.DBforMySQL/servers/firewallRules@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":82},"Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":93},"Microsoft.DBforMySQL/servers/databases@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":98},"Microsoft.DBforMySQL/servers/configurations@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":103},"Microsoft.DBforMySQL/servers/administrators@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":110},"Microsoft.DBforMySQL/servers/securityAlertPolicies@2017-12-01":{"RelativePath":"mysql/microsoft.dbformysql/2017-12-01/types.json","Index":122},"Microsoft.DBforMySQL/servers/privateEndpointConnections@2018-06-01":{"RelativePath":"mysql/microsoft.dbformysql/2018-06-01/types.json","Index":14},"Microsoft.DBforMySQL/servers/keys@2020-01-01":{"RelativePath":"mysql/microsoft.dbformysql/2020-01-01/types.json","Index":14},"Microsoft.DBForMySql/flexibleServers@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":61},"Microsoft.DBForMySql/flexibleServers/keys@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":68},"Microsoft.DBForMySql/flexibleServers/firewallRules@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":73},"Microsoft.DBForMySql/flexibleServers/databases@2020-07-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2020-07-01-preview/types.json","Index":78},"Microsoft.DBforMySQL/flexibleServers@2021-05-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01-preview/types.json","Index":76},"Microsoft.DBforMySQL/flexibleServers/firewallRules@2021-05-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01-preview/types.json","Index":81},"Microsoft.DBforMySQL/flexibleServers/databases@2021-05-01-preview":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01-preview/types.json","Index":86},"Microsoft.DBforMySQL/flexibleServers@2021-05-01":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01/types.json","Index":80},"Microsoft.DBforMySQL/flexibleServers/firewallRules@2021-05-01":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01/types.json","Index":85},"Microsoft.DBforMySQL/flexibleServers/databases@2021-05-01":{"RelativePath":"mysql/microsoft.dbformysql/2021-05-01/types.json","Index":90},"Microsoft.NetApp/netAppAccounts@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2017-08-15":{"RelativePath":"netapp/microsoft.netapp/2017-08-15/types.json","Index":40},"Microsoft.NetApp/netAppAccounts@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":38},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-05-01":{"RelativePath":"netapp/microsoft.netapp/2019-05-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":38},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-06-01":{"RelativePath":"netapp/microsoft.netapp/2019-06-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":14},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":38},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-07-01":{"RelativePath":"netapp/microsoft.netapp/2019-07-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":15},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":25},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":43},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-08-01":{"RelativePath":"netapp/microsoft.netapp/2019-08-01/types.json","Index":49},"Microsoft.NetApp/netAppAccounts@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":15},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":25},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":50},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-10-01":{"RelativePath":"netapp/microsoft.netapp/2019-10-01/types.json","Index":56},"Microsoft.NetApp/netAppAccounts@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":15},"Microsoft.NetApp/netAppAccounts/capacityPools@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":25},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":50},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2019-11-01":{"RelativePath":"netapp/microsoft.netapp/2019-11-01/types.json","Index":55},"Microsoft.NetApp/netAppAccounts@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":16},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":26},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":52},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-02-01":{"RelativePath":"netapp/microsoft.netapp/2020-02-01/types.json","Index":57},"Microsoft.NetApp/netAppAccounts@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":16},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":26},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":54},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-03-01":{"RelativePath":"netapp/microsoft.netapp/2020-03-01/types.json","Index":59},"Microsoft.NetApp/netAppAccounts@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":16},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":26},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":53},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":58},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":68},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":76},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-05-01":{"RelativePath":"netapp/microsoft.netapp/2020-05-01/types.json","Index":84},"Microsoft.NetApp/netAppAccounts@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":22},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":65},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":70},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":88},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-06-01":{"RelativePath":"netapp/microsoft.netapp/2020-06-01/types.json","Index":96},"Microsoft.NetApp/netAppAccounts@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":22},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":65},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":70},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":88},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-07-01":{"RelativePath":"netapp/microsoft.netapp/2020-07-01/types.json","Index":96},"Microsoft.NetApp/netAppAccounts@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":22},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":65},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":70},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":88},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-08-01":{"RelativePath":"netapp/microsoft.netapp/2020-08-01/types.json","Index":96},"Microsoft.NetApp/netAppAccounts@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":23},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":66},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":71},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":81},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":89},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-09-01":{"RelativePath":"netapp/microsoft.netapp/2020-09-01/types.json","Index":97},"Microsoft.NetApp/netAppAccounts@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":37},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":50},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":80},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":85},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":95},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":103},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-11-01":{"RelativePath":"netapp/microsoft.netapp/2020-11-01/types.json","Index":111},"Microsoft.NetApp/netAppAccounts@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":48},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":78},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":83},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":93},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":101},"Microsoft.NetApp/netAppAccounts/backupPolicies@2020-12-01":{"RelativePath":"netapp/microsoft.netapp/2020-12-01/types.json","Index":109},"Microsoft.NetApp/netAppAccounts@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":48},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":78},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":83},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":93},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":101},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-02-01":{"RelativePath":"netapp/microsoft.netapp/2021-02-01/types.json","Index":109},"Microsoft.NetApp/netAppAccounts@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":35},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":48},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":85},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":90},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":100},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":108},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01-preview":{"RelativePath":"netapp/microsoft.netapp/2021-04-01-preview/types.json","Index":116},"Microsoft.NetApp/netAppAccounts@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":52},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":85},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":90},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":100},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":108},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01":{"RelativePath":"netapp/microsoft.netapp/2021-04-01/types.json","Index":116},"Microsoft.NetApp/netAppAccounts@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":53},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":97},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":102},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":112},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":120},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-06-01":{"RelativePath":"netapp/microsoft.netapp/2021-06-01/types.json","Index":128},"Microsoft.NetApp/netAppAccounts@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":36},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":53},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":99},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":104},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":114},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":122},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":130},"Microsoft.NetApp/netAppAccounts/volumeGroups@2021-08-01":{"RelativePath":"netapp/microsoft.netapp/2021-08-01/types.json","Index":143},"Microsoft.NetApp/netAppAccounts@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":37},"Microsoft.NetApp/netAppAccounts/capacityPools@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":54},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":103},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":108},"Microsoft.NetApp/netAppAccounts/snapshotPolicies@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":118},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":126},"Microsoft.NetApp/netAppAccounts/backupPolicies@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":134},"Microsoft.NetApp/netAppAccounts/volumeGroups@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":147},"Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes@2021-10-01":{"RelativePath":"netapp/microsoft.netapp/2021-10-01/types.json","Index":152},"Microsoft.Network/applicationGateways@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":67},"Microsoft.Network/expressRouteCircuits@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":110},"Microsoft.Network/expressRouteCircuits/peerings@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":114},"Microsoft.Network/loadBalancers@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":168},"Microsoft.Network/localNetworkGateways@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":176},"Microsoft.Network/networkInterfaces@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":193},"Microsoft.Network/routeTables@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":209},"Microsoft.Network/networkSecurityGroups@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":231},"Microsoft.Network/publicIPAddresses@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":241},"Microsoft.Network/routeTables/routes@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":245},"Microsoft.Network/networkSecurityGroups/securityRules@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":249},"Microsoft.Network/expressRouteCircuits/authorizations@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":253},"Microsoft.Network/virtualnetworks/subnets@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":259},"Microsoft.Network/connections@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":292},"Microsoft.Network/virtualnetworkgateways@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":297},"Microsoft.Network/virtualnetworks@2015-05-01-preview":{"RelativePath":"network/microsoft.network/2015-05-01-preview/types.json","Index":307},"Microsoft.Network/applicationGateways@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":151},"Microsoft.Network/expressRouteCircuits/authorizations@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":159},"Microsoft.Network/expressRouteCircuits/peerings@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":179},"Microsoft.Network/expressRouteCircuits@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":202},"Microsoft.Network/loadBalancers@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":247},"Microsoft.Network/networkInterfaces@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":252},"Microsoft.Network/networkSecurityGroups@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":257},"Microsoft.Network/networkSecurityGroups/securityRules@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":261},"Microsoft.Network/publicIPAddresses@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":266},"Microsoft.Network/routeTables@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":271},"Microsoft.Network/routeTables/routes@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":275},"Microsoft.Network/virtualNetworks@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":286},"Microsoft.Network/virtualnetworks/subnets@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":290},"Microsoft.Network/virtualNetworkGateways@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":325},"Microsoft.Network/connections@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":346},"Microsoft.Network/localNetworkGateways@2015-06-15":{"RelativePath":"network/microsoft.network/2015-06-15/types.json","Index":351},"Microsoft.Network/applicationGateways@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":158},"Microsoft.Network/expressRouteCircuits/authorizations@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":166},"Microsoft.Network/expressRouteCircuits/peerings@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":186},"Microsoft.Network/expressRouteCircuits@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":209},"Microsoft.Network/loadBalancers@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":254},"Microsoft.Network/localNetworkGateways@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":263},"Microsoft.Network/networkInterfaces@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":268},"Microsoft.Network/networkSecurityGroups@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":273},"Microsoft.Network/publicIPAddresses@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":278},"Microsoft.Network/routeTables@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":283},"Microsoft.Network/routeTables/routes@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":287},"Microsoft.Network/networkSecurityGroups/securityRules@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":291},"Microsoft.Network/virtualNetworks/subnets@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":295},"Microsoft.Network/connections@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":344},"Microsoft.Network/virtualNetworkGateways@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":349},"Microsoft.Network/virtualNetworks@2016-03-30":{"RelativePath":"network/microsoft.network/2016-03-30/types.json","Index":358},"Microsoft.Network/applicationGateways@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":171},"Microsoft.Network/expressRouteCircuits/authorizations@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":179},"Microsoft.Network/expressRouteCircuits/peerings@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":199},"Microsoft.Network/expressRouteCircuits@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":222},"Microsoft.Network/loadBalancers@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":267},"Microsoft.Network/localNetworkGateways@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":276},"Microsoft.Network/networkInterfaces@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":281},"Microsoft.Network/networkSecurityGroups@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":286},"Microsoft.Network/publicIPAddresses@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":291},"Microsoft.Network/routeTables@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":296},"Microsoft.Network/routeTables/routes@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":300},"Microsoft.Network/networkSecurityGroups/securityRules@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":304},"Microsoft.Network/virtualNetworks/subnets@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":308},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":317},"Microsoft.Network/connections@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":368},"Microsoft.Network/virtualNetworkGateways@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":373},"Microsoft.Network/virtualNetworks@2016-06-01":{"RelativePath":"network/microsoft.network/2016-06-01/types.json","Index":384},"Microsoft.Network/networkInterfaces@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":98},"Microsoft.Network/applicationGateways@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":183},"Microsoft.Network/expressRouteCircuits/authorizations@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":191},"Microsoft.Network/expressRouteCircuits/peerings@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":211},"Microsoft.Network/expressRouteCircuits@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":234},"Microsoft.Network/loadBalancers@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":279},"Microsoft.Network/networkSecurityGroups@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":284},"Microsoft.Network/networkSecurityGroups/securityRules@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":288},"Microsoft.Network/networkWatchers@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":299},"Microsoft.Network/networkWatchers/packetCaptures@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":316},"Microsoft.Network/publicIPAddresses@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":321},"Microsoft.Network/routeTables@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":326},"Microsoft.Network/routeTables/routes@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":330},"Microsoft.Network/virtualNetworks@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":348},"Microsoft.Network/virtualNetworks/subnets@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":352},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":356},"Microsoft.Network/virtualNetworkGateways@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":393},"Microsoft.Network/connections@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":421},"Microsoft.Network/localNetworkGateways@2016-09-01":{"RelativePath":"network/microsoft.network/2016-09-01/types.json","Index":426},"Microsoft.Network/networkInterfaces@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":98},"Microsoft.Network/applicationGateways@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":184},"Microsoft.Network/expressRouteCircuits/authorizations@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":192},"Microsoft.Network/expressRouteCircuits/peerings@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":227},"Microsoft.Network/expressRouteCircuits@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":249},"Microsoft.Network/loadBalancers@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":294},"Microsoft.Network/networkSecurityGroups@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":299},"Microsoft.Network/networkSecurityGroups/securityRules@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":303},"Microsoft.Network/networkWatchers@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":314},"Microsoft.Network/networkWatchers/packetCaptures@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":331},"Microsoft.Network/publicIPAddresses@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":336},"Microsoft.Network/routeFilters@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":341},"Microsoft.Network/routeFilters/routeFilterRules@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":346},"Microsoft.Network/routeTables@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":351},"Microsoft.Network/routeTables/routes@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":355},"Microsoft.Network/virtualNetworks@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":373},"Microsoft.Network/virtualNetworks/subnets@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":377},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":381},"Microsoft.Network/virtualNetworkGateways@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":418},"Microsoft.Network/connections@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":446},"Microsoft.Network/localNetworkGateways@2016-12-01":{"RelativePath":"network/microsoft.network/2016-12-01/types.json","Index":451},"Microsoft.Network/applicationGateways@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":182},"Microsoft.Network/expressRouteCircuits/authorizations@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":190},"Microsoft.Network/expressRouteCircuits/peerings@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":229},"Microsoft.Network/expressRouteCircuits@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":251},"Microsoft.Network/loadBalancers@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":296},"Microsoft.Network/networkInterfaces@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":301},"Microsoft.Network/networkSecurityGroups@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":306},"Microsoft.Network/networkSecurityGroups/securityRules@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":310},"Microsoft.Network/networkWatchers@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":321},"Microsoft.Network/networkWatchers/packetCaptures@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":338},"Microsoft.Network/publicIPAddresses@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":343},"Microsoft.Network/routeFilters@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":348},"Microsoft.Network/routeFilters/routeFilterRules@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":353},"Microsoft.Network/routeTables@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":358},"Microsoft.Network/routeTables/routes@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":362},"Microsoft.Network/virtualNetworks@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":380},"Microsoft.Network/virtualNetworks/subnets@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":384},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":388},"Microsoft.Network/virtualNetworkGateways@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":431},"Microsoft.Network/connections@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":506},"Microsoft.Network/localNetworkGateways@2017-03-01":{"RelativePath":"network/microsoft.network/2017-03-01/types.json","Index":511},"Microsoft.Network/applicationGateways@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":182},"Microsoft.Network/expressRouteCircuits/authorizations@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":190},"Microsoft.Network/expressRouteCircuits/peerings@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":229},"Microsoft.Network/expressRouteCircuits@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":251},"Microsoft.Network/loadBalancers@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":296},"Microsoft.Network/networkInterfaces@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":301},"Microsoft.Network/networkSecurityGroups@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":306},"Microsoft.Network/networkSecurityGroups/securityRules@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":310},"Microsoft.Network/networkWatchers@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":321},"Microsoft.Network/networkWatchers/packetCaptures@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":338},"Microsoft.Network/publicIPAddresses@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":343},"Microsoft.Network/routeFilters@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":348},"Microsoft.Network/routeFilters/routeFilterRules@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":353},"Microsoft.Network/routeTables@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":358},"Microsoft.Network/routeTables/routes@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":362},"Microsoft.Network/virtualNetworks@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":380},"Microsoft.Network/virtualNetworks/subnets@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":384},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":388},"Microsoft.Network/virtualNetworkGateways@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":431},"Microsoft.Network/connections@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":506},"Microsoft.Network/localNetworkGateways@2017-03-30":{"RelativePath":"network/microsoft.network/2017-03-30/types.json","Index":511},"Microsoft.Network/applicationGateways@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":244},"Microsoft.Network/expressRouteCircuits/authorizations@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":252},"Microsoft.Network/expressRouteCircuits/peerings@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":292},"Microsoft.Network/expressRouteCircuits@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":315},"Microsoft.Network/loadBalancers@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":361},"Microsoft.Network/loadBalancers/inboundNatRules@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":365},"Microsoft.Network/networkInterfaces@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":370},"Microsoft.Network/networkSecurityGroups@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":375},"Microsoft.Network/networkSecurityGroups/securityRules@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":379},"Microsoft.Network/networkWatchers@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":390},"Microsoft.Network/networkWatchers/packetCaptures@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":407},"Microsoft.Network/publicIPAddresses@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":413},"Microsoft.Network/routeFilters@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":418},"Microsoft.Network/routeFilters/routeFilterRules@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":423},"Microsoft.Network/routeTables@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":428},"Microsoft.Network/routeTables/routes@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":432},"Microsoft.Network/virtualNetworks@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":450},"Microsoft.Network/virtualNetworks/subnets@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":454},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":458},"Microsoft.Network/virtualNetworkGateways@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":505},"Microsoft.Network/connections@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":580},"Microsoft.Network/localNetworkGateways@2017-06-01":{"RelativePath":"network/microsoft.network/2017-06-01/types.json","Index":585},"Microsoft.Network/applicationGateways@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":248},"Microsoft.Network/expressRouteCircuits/authorizations@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":256},"Microsoft.Network/expressRouteCircuits/peerings@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":296},"Microsoft.Network/expressRouteCircuits@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":318},"Microsoft.Network/loadBalancers@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":368},"Microsoft.Network/loadBalancers/inboundNatRules@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":372},"Microsoft.Network/networkInterfaces@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":377},"Microsoft.Network/networkSecurityGroups@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":382},"Microsoft.Network/networkSecurityGroups/securityRules@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":386},"Microsoft.Network/networkWatchers@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":397},"Microsoft.Network/networkWatchers/packetCaptures@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":414},"Microsoft.Network/publicIPAddresses@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":420},"Microsoft.Network/routeFilters@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":425},"Microsoft.Network/routeFilters/routeFilterRules@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":430},"Microsoft.Network/routeTables@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":435},"Microsoft.Network/routeTables/routes@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":439},"Microsoft.Network/virtualNetworks@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":457},"Microsoft.Network/virtualNetworks/subnets@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":461},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":465},"Microsoft.Network/virtualNetworkGateways@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":512},"Microsoft.Network/connections@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":587},"Microsoft.Network/localNetworkGateways@2017-08-01":{"RelativePath":"network/microsoft.network/2017-08-01/types.json","Index":592},"Microsoft.Network/applicationGateways@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":255},"Microsoft.Network/applicationSecurityGroups@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":260},"Microsoft.Network/expressRouteCircuits/authorizations@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":268},"Microsoft.Network/expressRouteCircuits/peerings@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":308},"Microsoft.Network/expressRouteCircuits@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":330},"Microsoft.Network/loadBalancers@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":382},"Microsoft.Network/loadBalancers/inboundNatRules@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":386},"Microsoft.Network/networkInterfaces@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":391},"Microsoft.Network/networkSecurityGroups@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":396},"Microsoft.Network/networkSecurityGroups/securityRules@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":400},"Microsoft.Network/networkWatchers@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":411},"Microsoft.Network/networkWatchers/packetCaptures@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":428},"Microsoft.Network/publicIPAddresses@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":434},"Microsoft.Network/routeFilters@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":439},"Microsoft.Network/routeFilters/routeFilterRules@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":444},"Microsoft.Network/routeTables@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":449},"Microsoft.Network/routeTables/routes@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":453},"Microsoft.Network/virtualNetworks@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":471},"Microsoft.Network/virtualNetworks/subnets@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":475},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":479},"Microsoft.Network/virtualNetworkGateways@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":526},"Microsoft.Network/connections@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":601},"Microsoft.Network/localNetworkGateways@2017-09-01":{"RelativePath":"network/microsoft.network/2017-09-01/types.json","Index":606},"Microsoft.Network/applicationGateways@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":255},"Microsoft.Network/applicationSecurityGroups@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":260},"Microsoft.Network/expressRouteCircuits/authorizations@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":268},"Microsoft.Network/expressRouteCircuits/peerings@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":308},"Microsoft.Network/expressRouteCircuits@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":330},"Microsoft.Network/loadBalancers@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":382},"Microsoft.Network/loadBalancers/inboundNatRules@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":386},"Microsoft.Network/networkInterfaces@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":391},"Microsoft.Network/networkSecurityGroups@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":396},"Microsoft.Network/networkSecurityGroups/securityRules@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":400},"Microsoft.Network/networkWatchers@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":411},"Microsoft.Network/networkWatchers/packetCaptures@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":428},"Microsoft.Network/networkWatchers/connectionMonitors@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":441},"Microsoft.Network/publicIPAddresses@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":447},"Microsoft.Network/routeFilters@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":452},"Microsoft.Network/routeFilters/routeFilterRules@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":457},"Microsoft.Network/routeTables@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":462},"Microsoft.Network/routeTables/routes@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":466},"Microsoft.Network/virtualNetworks@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":484},"Microsoft.Network/virtualNetworks/subnets@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":492},"Microsoft.Network/virtualNetworkGateways@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":539},"Microsoft.Network/connections@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":614},"Microsoft.Network/localNetworkGateways@2017-10-01":{"RelativePath":"network/microsoft.network/2017-10-01/types.json","Index":619},"Microsoft.Network/applicationGateways@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":257},"Microsoft.Network/applicationSecurityGroups@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":262},"Microsoft.Network/expressRouteCircuits/authorizations@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":270},"Microsoft.Network/expressRouteCircuits/peerings@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":309},"Microsoft.Network/expressRouteCircuits@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":331},"Microsoft.Network/loadBalancers@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":383},"Microsoft.Network/loadBalancers/inboundNatRules@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":387},"Microsoft.Network/networkInterfaces@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":392},"Microsoft.Network/networkSecurityGroups@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":397},"Microsoft.Network/networkSecurityGroups/securityRules@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":401},"Microsoft.Network/networkWatchers@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":412},"Microsoft.Network/networkWatchers/packetCaptures@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":429},"Microsoft.Network/networkWatchers/connectionMonitors@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":442},"Microsoft.Network/publicIPAddresses@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":448},"Microsoft.Network/routeFilters@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":453},"Microsoft.Network/routeFilters/routeFilterRules@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":457},"Microsoft.Network/routeTables@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":462},"Microsoft.Network/routeTables/routes@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":466},"Microsoft.Network/virtualNetworks@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":484},"Microsoft.Network/virtualNetworks/subnets@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":492},"Microsoft.Network/virtualNetworkGateways@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":539},"Microsoft.Network/connections@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":614},"Microsoft.Network/localNetworkGateways@2017-11-01":{"RelativePath":"network/microsoft.network/2017-11-01/types.json","Index":619},"Microsoft.Network/applicationGateways@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":257},"Microsoft.Network/applicationSecurityGroups@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":262},"Microsoft.Network/expressRouteCircuits/authorizations@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":270},"Microsoft.Network/expressRouteCircuits/peerings@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":309},"Microsoft.Network/expressRouteCircuits@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":331},"Microsoft.Network/loadBalancers@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":383},"Microsoft.Network/loadBalancers/inboundNatRules@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":387},"Microsoft.Network/networkInterfaces@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":392},"Microsoft.Network/networkSecurityGroups@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":397},"Microsoft.Network/networkSecurityGroups/securityRules@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":401},"Microsoft.Network/networkWatchers@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":412},"Microsoft.Network/networkWatchers/packetCaptures@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":429},"Microsoft.Network/networkWatchers/connectionMonitors@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":442},"Microsoft.Network/publicIPAddresses@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":448},"Microsoft.Network/routeFilters@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":453},"Microsoft.Network/routeFilters/routeFilterRules@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":457},"Microsoft.Network/routeTables@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":462},"Microsoft.Network/routeTables/routes@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":466},"Microsoft.Network/virtualNetworks@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":484},"Microsoft.Network/virtualNetworks/subnets@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":492},"Microsoft.Network/virtualNetworkGateways@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":539},"Microsoft.Network/connections@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":614},"Microsoft.Network/localNetworkGateways@2018-01-01":{"RelativePath":"network/microsoft.network/2018-01-01/types.json","Index":619},"Microsoft.Network/applicationGateways@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":257},"Microsoft.Network/applicationSecurityGroups@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":262},"Microsoft.Network/ddosProtectionPlans@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":269},"Microsoft.Network/expressRouteCircuits/authorizations@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":277},"Microsoft.Network/expressRouteCircuits/peerings@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":323},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":327},"Microsoft.Network/expressRouteCircuits@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":349},"Microsoft.Network/expressRouteCrossConnections@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":371},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":375},"Microsoft.Network/loadBalancers@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":428},"Microsoft.Network/loadBalancers/inboundNatRules@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":432},"Microsoft.Network/networkInterfaces@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":437},"Microsoft.Network/networkSecurityGroups@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":442},"Microsoft.Network/networkSecurityGroups/securityRules@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":446},"Microsoft.Network/networkWatchers@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":457},"Microsoft.Network/networkWatchers/packetCaptures@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":474},"Microsoft.Network/networkWatchers/connectionMonitors@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":487},"Microsoft.Network/publicIPAddresses@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":493},"Microsoft.Network/routeFilters@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":498},"Microsoft.Network/routeFilters/routeFilterRules@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":502},"Microsoft.Network/routeTables@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":507},"Microsoft.Network/routeTables/routes@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":511},"Microsoft.Network/virtualNetworks@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":529},"Microsoft.Network/virtualNetworks/subnets@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":533},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":537},"Microsoft.Network/virtualNetworkGateways@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":637},"Microsoft.Network/connections@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":666},"Microsoft.Network/localNetworkGateways@2018-02-01":{"RelativePath":"network/microsoft.network/2018-02-01/types.json","Index":671},"Microsoft.Network/azureFirewalls@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":67},"Microsoft.Network/applicationGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":323},"Microsoft.Network/applicationSecurityGroups@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":328},"Microsoft.Network/ddosProtectionPlans@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":335},"Microsoft.Network/expressRouteCircuits/authorizations@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":343},"Microsoft.Network/expressRouteCircuits/peerings@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":389},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":393},"Microsoft.Network/expressRouteCircuits@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":415},"Microsoft.Network/expressRouteCrossConnections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":437},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":441},"Microsoft.Network/loadBalancers@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":494},"Microsoft.Network/loadBalancers/inboundNatRules@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":498},"Microsoft.Network/networkInterfaces@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":503},"Microsoft.Network/networkSecurityGroups@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":508},"Microsoft.Network/networkSecurityGroups/securityRules@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":512},"Microsoft.Network/networkWatchers@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":523},"Microsoft.Network/networkWatchers/packetCaptures@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":540},"Microsoft.Network/networkWatchers/connectionMonitors@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":553},"Microsoft.Network/publicIPAddresses@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":559},"Microsoft.Network/routeFilters@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":564},"Microsoft.Network/routeFilters/routeFilterRules@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":568},"Microsoft.Network/routeTables@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":573},"Microsoft.Network/routeTables/routes@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":577},"Microsoft.Network/virtualNetworks@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":595},"Microsoft.Network/virtualNetworks/subnets@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":599},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":603},"Microsoft.Network/virtualNetworkGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":716},"Microsoft.Network/connections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":745},"Microsoft.Network/localNetworkGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":750},"Microsoft.Network/virtualWans@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":763},"Microsoft.Network/vpnSites@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":775},"Microsoft.Network/virtualHubs@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":795},"Microsoft.Network/vpnGateways@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":821},"Microsoft.Network/vpnGateways/vpnConnections@2018-04-01":{"RelativePath":"network/microsoft.network/2018-04-01/types.json","Index":825},"Microsoft.Network/azureFirewalls@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":67},"Microsoft.Network/applicationGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":323},"Microsoft.Network/applicationSecurityGroups@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":328},"Microsoft.Network/ddosProtectionPlans@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":335},"Microsoft.Network/expressRouteCircuits/authorizations@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":343},"Microsoft.Network/expressRouteCircuits/peerings@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":389},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":393},"Microsoft.Network/expressRouteCircuits@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":415},"Microsoft.Network/expressRouteCrossConnections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":437},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":441},"Microsoft.Network/loadBalancers@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":494},"Microsoft.Network/loadBalancers/inboundNatRules@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":498},"Microsoft.Network/networkInterfaces@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":503},"Microsoft.Network/networkSecurityGroups@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":508},"Microsoft.Network/networkSecurityGroups/securityRules@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":512},"Microsoft.Network/networkWatchers@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":523},"Microsoft.Network/networkWatchers/packetCaptures@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":540},"Microsoft.Network/networkWatchers/connectionMonitors@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":553},"Microsoft.Network/publicIPAddresses@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":559},"Microsoft.Network/routeFilters@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":564},"Microsoft.Network/routeFilters/routeFilterRules@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":568},"Microsoft.Network/routeTables@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":573},"Microsoft.Network/routeTables/routes@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":577},"Microsoft.Network/virtualNetworks@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":595},"Microsoft.Network/virtualNetworks/subnets@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":599},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":603},"Microsoft.Network/virtualNetworkGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":716},"Microsoft.Network/connections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":745},"Microsoft.Network/localNetworkGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":750},"Microsoft.Network/virtualWans@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":763},"Microsoft.Network/vpnSites@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":775},"Microsoft.Network/virtualHubs@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":795},"Microsoft.Network/vpnGateways@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":821},"Microsoft.Network/vpnGateways/vpnConnections@2018-06-01":{"RelativePath":"network/microsoft.network/2018-06-01/types.json","Index":825},"Microsoft.Network/azureFirewalls@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":67},"Microsoft.Network/applicationGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":332},"Microsoft.Network/applicationSecurityGroups@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":337},"Microsoft.Network/ddosProtectionPlans@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":344},"Microsoft.Network/expressRouteCircuits/authorizations@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":352},"Microsoft.Network/expressRouteCircuits/peerings@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":398},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":402},"Microsoft.Network/expressRouteCircuits@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":424},"Microsoft.Network/expressRouteCrossConnections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":446},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":450},"Microsoft.Network/loadBalancers@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":507},"Microsoft.Network/loadBalancers/inboundNatRules@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":511},"Microsoft.Network/networkInterfaces@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":516},"Microsoft.Network/networkSecurityGroups@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":521},"Microsoft.Network/networkSecurityGroups/securityRules@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":525},"Microsoft.Network/networkWatchers@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":536},"Microsoft.Network/networkWatchers/packetCaptures@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":553},"Microsoft.Network/networkWatchers/connectionMonitors@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":566},"Microsoft.Network/publicIPAddresses@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":572},"Microsoft.Network/publicIPPrefixes@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":588},"Microsoft.Network/routeFilters@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":593},"Microsoft.Network/routeFilters/routeFilterRules@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":597},"Microsoft.Network/routeTables@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":602},"Microsoft.Network/routeTables/routes@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":606},"Microsoft.Network/virtualNetworks@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":624},"Microsoft.Network/virtualNetworks/subnets@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":628},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":632},"Microsoft.Network/virtualNetworkGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":745},"Microsoft.Network/connections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":774},"Microsoft.Network/localNetworkGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":779},"Microsoft.Network/virtualWans@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":792},"Microsoft.Network/vpnSites@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":804},"Microsoft.Network/virtualHubs@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":824},"Microsoft.Network/vpnGateways@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":850},"Microsoft.Network/vpnGateways/vpnConnections@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":854},"Microsoft.Network/serviceEndpointPolicies@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":859},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-07-01":{"RelativePath":"network/microsoft.network/2018-07-01/types.json","Index":863},"Microsoft.Network/applicationGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":321},"Microsoft.Network/applicationSecurityGroups@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":326},"Microsoft.Network/azureFirewalls@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":409},"Microsoft.Network/ddosProtectionPlans@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":416},"Microsoft.Network/expressRouteCircuits/authorizations@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":424},"Microsoft.Network/expressRouteCircuits/peerings@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":471},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":475},"Microsoft.Network/expressRouteCircuits@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":498},"Microsoft.Network/expressRouteCrossConnections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":520},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":524},"Microsoft.Network/expressRouteGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":547},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":551},"Microsoft.Network/ExpressRoutePorts@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":570},"Microsoft.Network/interfaceEndpoints@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":575},"Microsoft.Network/loadBalancers@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":622},"Microsoft.Network/loadBalancers/inboundNatRules@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":626},"Microsoft.Network/networkInterfaces@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":631},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":635},"Microsoft.Network/networkProfiles@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":653},"Microsoft.Network/networkSecurityGroups@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":658},"Microsoft.Network/networkSecurityGroups/securityRules@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":662},"Microsoft.Network/networkWatchers@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":673},"Microsoft.Network/networkWatchers/packetCaptures@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":690},"Microsoft.Network/networkWatchers/connectionMonitors@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":703},"Microsoft.Network/publicIPAddresses@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":709},"Microsoft.Network/publicIPPrefixes@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":725},"Microsoft.Network/routeFilters@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":730},"Microsoft.Network/routeFilters/routeFilterRules@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":734},"Microsoft.Network/routeTables@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":739},"Microsoft.Network/routeTables/routes@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":743},"Microsoft.Network/serviceEndpointPolicies@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":748},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":752},"Microsoft.Network/virtualNetworks@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":770},"Microsoft.Network/virtualNetworks/subnets@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":774},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":778},"Microsoft.Network/virtualNetworkTaps@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":783},"Microsoft.Network/virtualNetworkGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":896},"Microsoft.Network/connections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":928},"Microsoft.Network/localNetworkGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":933},"Microsoft.Network/virtualWans@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":972},"Microsoft.Network/vpnSites@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":984},"Microsoft.Network/virtualHubs@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1007},"Microsoft.Network/vpnGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1035},"Microsoft.Network/vpnGateways/vpnConnections@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1039},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1043},"Microsoft.Network/p2svpnGateways@2018-08-01":{"RelativePath":"network/microsoft.network/2018-08-01/types.json","Index":1056},"Microsoft.Network/applicationGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":338},"Microsoft.Network/applicationSecurityGroups@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":343},"Microsoft.Network/azureFirewalls@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":426},"Microsoft.Network/ddosProtectionPlans@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":433},"Microsoft.Network/expressRouteCircuits/authorizations@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":441},"Microsoft.Network/expressRouteCircuits/peerings@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":488},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":492},"Microsoft.Network/expressRouteCircuits@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":515},"Microsoft.Network/expressRouteCrossConnections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":537},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":541},"Microsoft.Network/expressRouteGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":564},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":568},"Microsoft.Network/ExpressRoutePorts@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":587},"Microsoft.Network/interfaceEndpoints@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":592},"Microsoft.Network/loadBalancers@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":639},"Microsoft.Network/loadBalancers/inboundNatRules@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":643},"Microsoft.Network/networkInterfaces@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":648},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":652},"Microsoft.Network/networkProfiles@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":670},"Microsoft.Network/networkSecurityGroups@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":675},"Microsoft.Network/networkSecurityGroups/securityRules@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":679},"Microsoft.Network/networkWatchers@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":690},"Microsoft.Network/networkWatchers/packetCaptures@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":707},"Microsoft.Network/networkWatchers/connectionMonitors@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":720},"Microsoft.Network/publicIPAddresses@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":726},"Microsoft.Network/publicIPPrefixes@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":742},"Microsoft.Network/routeFilters@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":747},"Microsoft.Network/routeFilters/routeFilterRules@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":751},"Microsoft.Network/routeTables@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":756},"Microsoft.Network/routeTables/routes@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":760},"Microsoft.Network/serviceEndpointPolicies@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":765},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":769},"Microsoft.Network/virtualNetworks@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":787},"Microsoft.Network/virtualNetworks/subnets@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":791},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":795},"Microsoft.Network/virtualNetworkGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":908},"Microsoft.Network/connections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":940},"Microsoft.Network/localNetworkGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":945},"Microsoft.Network/virtualNetworkTaps@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":950},"Microsoft.Network/virtualWans@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":989},"Microsoft.Network/vpnSites@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1001},"Microsoft.Network/virtualHubs@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1024},"Microsoft.Network/vpnGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1052},"Microsoft.Network/vpnGateways/vpnConnections@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1056},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1060},"Microsoft.Network/p2svpnGateways@2018-10-01":{"RelativePath":"network/microsoft.network/2018-10-01/types.json","Index":1073},"Microsoft.Network/applicationGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":342},"Microsoft.Network/applicationSecurityGroups@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":347},"Microsoft.Network/azureFirewalls@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":430},"Microsoft.Network/ddosCustomPolicies@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":448},"Microsoft.Network/ddosProtectionPlans@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":455},"Microsoft.Network/expressRouteCircuits/authorizations@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":463},"Microsoft.Network/expressRouteCircuits/peerings@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":510},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":514},"Microsoft.Network/expressRouteCircuits@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":537},"Microsoft.Network/expressRouteCrossConnections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":559},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":563},"Microsoft.Network/expressRouteGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":586},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":590},"Microsoft.Network/ExpressRoutePorts@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":609},"Microsoft.Network/interfaceEndpoints@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":614},"Microsoft.Network/loadBalancers@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":661},"Microsoft.Network/loadBalancers/inboundNatRules@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":665},"Microsoft.Network/networkInterfaces@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":670},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":674},"Microsoft.Network/networkProfiles@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":692},"Microsoft.Network/networkSecurityGroups@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":697},"Microsoft.Network/networkSecurityGroups/securityRules@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":701},"Microsoft.Network/networkWatchers@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":712},"Microsoft.Network/networkWatchers/packetCaptures@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":729},"Microsoft.Network/networkWatchers/connectionMonitors@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":742},"Microsoft.Network/publicIPAddresses@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":748},"Microsoft.Network/publicIPPrefixes@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":764},"Microsoft.Network/routeFilters@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":769},"Microsoft.Network/routeFilters/routeFilterRules@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":773},"Microsoft.Network/routeTables@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":778},"Microsoft.Network/routeTables/routes@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":782},"Microsoft.Network/serviceEndpointPolicies@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":787},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":791},"Microsoft.Network/virtualNetworks@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":809},"Microsoft.Network/virtualNetworks/subnets@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":813},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":817},"Microsoft.Network/virtualNetworkGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":930},"Microsoft.Network/connections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":962},"Microsoft.Network/localNetworkGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":967},"Microsoft.Network/virtualNetworkTaps@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":972},"Microsoft.Network/virtualWans@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1011},"Microsoft.Network/vpnSites@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1023},"Microsoft.Network/virtualHubs@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1046},"Microsoft.Network/vpnGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1074},"Microsoft.Network/vpnGateways/vpnConnections@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1078},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1082},"Microsoft.Network/p2svpnGateways@2018-11-01":{"RelativePath":"network/microsoft.network/2018-11-01/types.json","Index":1095},"Microsoft.Network/applicationGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":344},"Microsoft.Network/applicationSecurityGroups@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":349},"Microsoft.Network/azureFirewalls@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":437},"Microsoft.Network/ddosCustomPolicies@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":455},"Microsoft.Network/ddosProtectionPlans@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":462},"Microsoft.Network/expressRouteCircuits/authorizations@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":470},"Microsoft.Network/expressRouteCircuits/peerings@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":524},"Microsoft.Network/expressRouteCircuits/peerings/connections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":528},"Microsoft.Network/expressRouteCircuits@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":552},"Microsoft.Network/expressRouteCrossConnections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":574},"Microsoft.Network/expressRouteCrossConnections/peerings@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":578},"Microsoft.Network/expressRouteGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":601},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":605},"Microsoft.Network/ExpressRoutePorts@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":624},"Microsoft.Network/interfaceEndpoints@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":629},"Microsoft.Network/loadBalancers@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":676},"Microsoft.Network/loadBalancers/inboundNatRules@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":680},"Microsoft.Network/networkInterfaces@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":685},"Microsoft.Network/networkInterfaces/tapConfigurations@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":689},"Microsoft.Network/networkProfiles@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":707},"Microsoft.Network/networkSecurityGroups@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":712},"Microsoft.Network/networkSecurityGroups/securityRules@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":716},"Microsoft.Network/networkWatchers@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":727},"Microsoft.Network/networkWatchers/packetCaptures@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":744},"Microsoft.Network/networkWatchers/connectionMonitors@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":757},"Microsoft.Network/publicIPAddresses@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":763},"Microsoft.Network/publicIPPrefixes@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":779},"Microsoft.Network/routeFilters@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":784},"Microsoft.Network/routeFilters/routeFilterRules@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":788},"Microsoft.Network/routeTables@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":793},"Microsoft.Network/routeTables/routes@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":797},"Microsoft.Network/serviceEndpointPolicies@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":802},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":806},"Microsoft.Network/virtualNetworks@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":824},"Microsoft.Network/virtualNetworks/subnets@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":828},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":832},"Microsoft.Network/virtualNetworkGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":945},"Microsoft.Network/connections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":977},"Microsoft.Network/localNetworkGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":982},"Microsoft.Network/virtualNetworkTaps@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":987},"Microsoft.Network/virtualWans@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1026},"Microsoft.Network/vpnSites@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1038},"Microsoft.Network/virtualHubs@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1061},"Microsoft.Network/vpnGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1089},"Microsoft.Network/vpnGateways/vpnConnections@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1093},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1097},"Microsoft.Network/p2svpnGateways@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1110},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2018-12-01":{"RelativePath":"network/microsoft.network/2018-12-01/types.json","Index":1176},"Microsoft.Network/applicationGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":346},"Microsoft.Network/applicationSecurityGroups@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":351},"Microsoft.Network/azureFirewalls@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":438},"Microsoft.Network/ddosCustomPolicies@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":456},"Microsoft.Network/ddosProtectionPlans@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":463},"Microsoft.Network/expressRouteCircuits/authorizations@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":471},"Microsoft.Network/expressRouteCircuits/peerings@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":525},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":529},"Microsoft.Network/expressRouteCircuits@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":553},"Microsoft.Network/expressRouteCrossConnections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":575},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":579},"Microsoft.Network/expressRouteGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":602},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":606},"Microsoft.Network/ExpressRoutePorts@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":625},"Microsoft.Network/interfaceEndpoints@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":630},"Microsoft.Network/loadBalancers@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":677},"Microsoft.Network/loadBalancers/inboundNatRules@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":681},"Microsoft.Network/natGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":693},"Microsoft.Network/networkInterfaces@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":698},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":702},"Microsoft.Network/networkProfiles@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":720},"Microsoft.Network/networkSecurityGroups@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":725},"Microsoft.Network/networkSecurityGroups/securityRules@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":729},"Microsoft.Network/networkWatchers@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":740},"Microsoft.Network/networkWatchers/packetCaptures@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":757},"Microsoft.Network/networkWatchers/connectionMonitors@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":770},"Microsoft.Network/publicIPAddresses@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":776},"Microsoft.Network/publicIPPrefixes@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":792},"Microsoft.Network/routeFilters@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":797},"Microsoft.Network/routeFilters/routeFilterRules@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":801},"Microsoft.Network/routeTables@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":806},"Microsoft.Network/routeTables/routes@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":810},"Microsoft.Network/serviceEndpointPolicies@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":815},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":819},"Microsoft.Network/virtualNetworks@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":837},"Microsoft.Network/virtualNetworks/subnets@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":841},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":845},"Microsoft.Network/virtualNetworkGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":958},"Microsoft.Network/connections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":990},"Microsoft.Network/localNetworkGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":995},"Microsoft.Network/virtualNetworkTaps@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1000},"Microsoft.Network/virtualWans@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1039},"Microsoft.Network/vpnSites@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1051},"Microsoft.Network/virtualHubs@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1074},"Microsoft.Network/vpnGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1102},"Microsoft.Network/vpnGateways/vpnConnections@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1106},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1110},"Microsoft.Network/p2svpnGateways@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1123},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-02-01":{"RelativePath":"network/microsoft.network/2019-02-01/types.json","Index":1189},"Microsoft.Network/applicationGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":365},"Microsoft.Network/applicationSecurityGroups@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":370},"Microsoft.Network/azureFirewalls@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":458},"Microsoft.Network/bastionHosts@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":480},"Microsoft.Network/ddosCustomPolicies@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":498},"Microsoft.Network/ddosProtectionPlans@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":505},"Microsoft.Network/expressRouteCircuits/authorizations@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":513},"Microsoft.Network/expressRouteCircuits/peerings@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":553},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":557},"Microsoft.Network/expressRouteCircuits@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":582},"Microsoft.Network/expressRouteCrossConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":604},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":608},"Microsoft.Network/expressRouteGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":631},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":635},"Microsoft.Network/ExpressRoutePorts@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":654},"Microsoft.Network/privateEndpoints@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":659},"Microsoft.Network/privateLinkServices@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":699},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":703},"Microsoft.Network/loadBalancers@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":750},"Microsoft.Network/loadBalancers/inboundNatRules@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":754},"Microsoft.Network/natGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":767},"Microsoft.Network/networkInterfaces@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":772},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":776},"Microsoft.Network/networkProfiles@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":794},"Microsoft.Network/networkSecurityGroups@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":799},"Microsoft.Network/networkSecurityGroups/securityRules@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":803},"Microsoft.Network/networkWatchers@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":814},"Microsoft.Network/networkWatchers/packetCaptures@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":831},"Microsoft.Network/networkWatchers/connectionMonitors@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":844},"Microsoft.Network/publicIPAddresses@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":850},"Microsoft.Network/publicIPPrefixes@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":866},"Microsoft.Network/routeFilters@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":883},"Microsoft.Network/routeFilters/routeFilterRules@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":887},"Microsoft.Network/routeTables@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":892},"Microsoft.Network/routeTables/routes@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":896},"Microsoft.Network/serviceEndpointPolicies@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":901},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":905},"Microsoft.Network/virtualNetworks@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":923},"Microsoft.Network/virtualNetworks/subnets@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":927},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":931},"Microsoft.Network/virtualNetworkGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1044},"Microsoft.Network/connections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1076},"Microsoft.Network/localNetworkGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1081},"Microsoft.Network/virtualNetworkTaps@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1086},"Microsoft.Network/virtualWans@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1125},"Microsoft.Network/vpnSites@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1137},"Microsoft.Network/virtualHubs@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1160},"Microsoft.Network/vpnGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1188},"Microsoft.Network/vpnGateways/vpnConnections@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1192},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1196},"Microsoft.Network/p2svpnGateways@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1209},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-04-01":{"RelativePath":"network/microsoft.network/2019-04-01/types.json","Index":1275},"Microsoft.Network/applicationGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":365},"Microsoft.Network/applicationSecurityGroups@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":370},"Microsoft.Network/azureFirewalls@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":461},"Microsoft.Network/bastionHosts@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":483},"Microsoft.Network/ddosCustomPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":501},"Microsoft.Network/ddosProtectionPlans@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":508},"Microsoft.Network/expressRouteCircuits/authorizations@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":516},"Microsoft.Network/expressRouteCircuits/peerings@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":556},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":560},"Microsoft.Network/expressRouteCircuits@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":585},"Microsoft.Network/expressRouteCrossConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":607},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":611},"Microsoft.Network/expressRouteGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":634},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":638},"Microsoft.Network/ExpressRoutePorts@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":657},"Microsoft.Network/firewallPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":675},"Microsoft.Network/firewallPolicies/ruleGroups@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":724},"Microsoft.Network/loadBalancers@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":771},"Microsoft.Network/loadBalancers/inboundNatRules@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":775},"Microsoft.Network/natGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":788},"Microsoft.Network/networkInterfaces@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":793},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":797},"Microsoft.Network/networkProfiles@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":815},"Microsoft.Network/networkSecurityGroups@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":820},"Microsoft.Network/networkSecurityGroups/securityRules@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":824},"Microsoft.Network/networkWatchers@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":835},"Microsoft.Network/networkWatchers/packetCaptures@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":852},"Microsoft.Network/networkWatchers/connectionMonitors@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":865},"Microsoft.Network/privateEndpoints@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":870},"Microsoft.Network/privateLinkServices@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":910},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":914},"Microsoft.Network/publicIPAddresses@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":920},"Microsoft.Network/publicIPPrefixes@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":936},"Microsoft.Network/routeFilters@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":953},"Microsoft.Network/routeFilters/routeFilterRules@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":957},"Microsoft.Network/routeTables@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":962},"Microsoft.Network/routeTables/routes@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":966},"Microsoft.Network/serviceEndpointPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":971},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":975},"Microsoft.Network/virtualNetworks@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":993},"Microsoft.Network/virtualNetworks/subnets@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":997},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1001},"Microsoft.Network/virtualNetworkGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1114},"Microsoft.Network/connections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1146},"Microsoft.Network/localNetworkGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1151},"Microsoft.Network/virtualNetworkTaps@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1156},"Microsoft.Network/virtualWans@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1195},"Microsoft.Network/vpnSites@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1217},"Microsoft.Network/virtualHubs@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1240},"Microsoft.Network/vpnGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1285},"Microsoft.Network/vpnGateways/vpnConnections@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1289},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1293},"Microsoft.Network/p2svpnGateways@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1306},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-06-01":{"RelativePath":"network/microsoft.network/2019-06-01/types.json","Index":1372},"Microsoft.Network/applicationGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":552},"Microsoft.Network/applicationSecurityGroups@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":557},"Microsoft.Network/azureFirewalls@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":649},"Microsoft.Network/bastionHosts@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":671},"Microsoft.Network/ddosCustomPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":694},"Microsoft.Network/ddosProtectionPlans@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":706},"Microsoft.Network/expressRouteCircuits/authorizations@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":719},"Microsoft.Network/expressRouteCircuits/peerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":774},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":778},"Microsoft.Network/expressRouteCircuits@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":808},"Microsoft.Network/expressRouteCrossConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":840},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":844},"Microsoft.Network/expressRouteGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":867},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":871},"Microsoft.Network/ExpressRoutePorts@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":904},"Microsoft.Network/firewallPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":922},"Microsoft.Network/firewallPolicies/ruleGroups@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":971},"Microsoft.Network/loadBalancers@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1043},"Microsoft.Network/loadBalancers/inboundNatRules@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1047},"Microsoft.Network/natGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1065},"Microsoft.Network/networkInterfaces@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1070},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1074},"Microsoft.Network/networkProfiles@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1112},"Microsoft.Network/networkSecurityGroups@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1117},"Microsoft.Network/networkSecurityGroups/securityRules@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1121},"Microsoft.Network/networkWatchers@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1132},"Microsoft.Network/networkWatchers/packetCaptures@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1149},"Microsoft.Network/networkWatchers/connectionMonitors@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1162},"Microsoft.Network/privateEndpoints@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1167},"Microsoft.Network/privateLinkServices@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1207},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1211},"Microsoft.Network/publicIPAddresses@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1217},"Microsoft.Network/publicIPPrefixes@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1238},"Microsoft.Network/routeFilters@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1265},"Microsoft.Network/routeFilters/routeFilterRules@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1269},"Microsoft.Network/routeTables@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1274},"Microsoft.Network/routeTables/routes@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1278},"Microsoft.Network/serviceEndpointPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1283},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1287},"Microsoft.Network/virtualNetworks@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1315},"Microsoft.Network/virtualNetworks/subnets@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1319},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1323},"Microsoft.Network/virtualNetworkGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1468},"Microsoft.Network/connections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1514},"Microsoft.Network/localNetworkGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1519},"Microsoft.Network/virtualNetworkTaps@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1524},"Microsoft.Network/virtualRouters@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1537},"Microsoft.Network/virtualRouters/peerings@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1547},"Microsoft.Network/virtualWans@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1611},"Microsoft.Network/vpnSites@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1633},"Microsoft.Network/virtualHubs@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1656},"Microsoft.Network/vpnGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1701},"Microsoft.Network/vpnGateways/vpnConnections@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1705},"Microsoft.Network/virtualWans/p2sVpnServerConfigurations@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1709},"Microsoft.Network/p2svpnGateways@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1722},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-07-01":{"RelativePath":"network/microsoft.network/2019-07-01/types.json","Index":1793},"Microsoft.Network/applicationGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":553},"Microsoft.Network/applicationSecurityGroups@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":558},"Microsoft.Network/azureFirewalls@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":656},"Microsoft.Network/bastionHosts@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":678},"Microsoft.Network/ddosCustomPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":701},"Microsoft.Network/ddosProtectionPlans@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":713},"Microsoft.Network/expressRouteCircuits/authorizations@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":726},"Microsoft.Network/expressRouteCircuits/peerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":781},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":785},"Microsoft.Network/expressRouteCircuits@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":815},"Microsoft.Network/expressRouteCrossConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":847},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":851},"Microsoft.Network/expressRouteGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":874},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":878},"Microsoft.Network/ExpressRoutePorts@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":911},"Microsoft.Network/firewallPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":929},"Microsoft.Network/firewallPolicies/ruleGroups@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":976},"Microsoft.Network/loadBalancers@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1048},"Microsoft.Network/loadBalancers/inboundNatRules@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1052},"Microsoft.Network/natGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1070},"Microsoft.Network/networkInterfaces@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1075},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1079},"Microsoft.Network/networkProfiles@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1117},"Microsoft.Network/networkSecurityGroups@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1122},"Microsoft.Network/networkSecurityGroups/securityRules@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1126},"Microsoft.Network/networkWatchers@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1137},"Microsoft.Network/networkWatchers/packetCaptures@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1154},"Microsoft.Network/networkWatchers/connectionMonitors@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1167},"Microsoft.Network/privateEndpoints@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1172},"Microsoft.Network/privateLinkServices@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1212},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1216},"Microsoft.Network/publicIPAddresses@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1222},"Microsoft.Network/publicIPPrefixes@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1243},"Microsoft.Network/routeFilters@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1270},"Microsoft.Network/routeFilters/routeFilterRules@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1274},"Microsoft.Network/routeTables@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1279},"Microsoft.Network/routeTables/routes@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1283},"Microsoft.Network/serviceEndpointPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1288},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1292},"Microsoft.Network/virtualNetworks@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1321},"Microsoft.Network/virtualNetworks/subnets@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1325},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1329},"Microsoft.Network/virtualNetworkGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1474},"Microsoft.Network/connections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1520},"Microsoft.Network/localNetworkGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1525},"Microsoft.Network/virtualNetworkTaps@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1530},"Microsoft.Network/virtualRouters@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1543},"Microsoft.Network/virtualRouters/peerings@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1553},"Microsoft.Network/virtualWans@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1571},"Microsoft.Network/vpnSites@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1593},"Microsoft.Network/vpnServerConfigurations@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1637},"Microsoft.Network/virtualHubs@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1660},"Microsoft.Network/vpnGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1705},"Microsoft.Network/vpnGateways/vpnConnections@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1709},"Microsoft.Network/p2svpnGateways@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1714},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-08-01":{"RelativePath":"network/microsoft.network/2019-08-01/types.json","Index":1806},"Microsoft.Network/applicationGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":554},"Microsoft.Network/applicationSecurityGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":559},"Microsoft.Network/azureFirewalls@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":663},"Microsoft.Network/bastionHosts@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":685},"Microsoft.Network/ddosCustomPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":708},"Microsoft.Network/ddosProtectionPlans@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":720},"Microsoft.Network/expressRouteCircuits/authorizations@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":733},"Microsoft.Network/expressRouteCircuits/peerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":788},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":792},"Microsoft.Network/expressRouteCircuits@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":822},"Microsoft.Network/expressRouteCrossConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":854},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":858},"Microsoft.Network/expressRouteGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":881},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":885},"Microsoft.Network/ExpressRoutePorts@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":918},"Microsoft.Network/firewallPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":936},"Microsoft.Network/firewallPolicies/ruleGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":983},"Microsoft.Network/ipGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":996},"Microsoft.Network/loadBalancers@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1068},"Microsoft.Network/loadBalancers/inboundNatRules@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1072},"Microsoft.Network/natGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1090},"Microsoft.Network/networkInterfaces@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1095},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1099},"Microsoft.Network/networkProfiles@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1137},"Microsoft.Network/networkSecurityGroups@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1142},"Microsoft.Network/networkSecurityGroups/securityRules@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1146},"Microsoft.Network/networkWatchers@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1157},"Microsoft.Network/networkWatchers/packetCaptures@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1174},"Microsoft.Network/networkWatchers/connectionMonitors@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1187},"Microsoft.Network/privateEndpoints@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1192},"Microsoft.Network/privateLinkServices@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1232},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1236},"Microsoft.Network/publicIPAddresses@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1242},"Microsoft.Network/publicIPPrefixes@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1263},"Microsoft.Network/routeFilters@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1290},"Microsoft.Network/routeFilters/routeFilterRules@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1294},"Microsoft.Network/routeTables@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1299},"Microsoft.Network/routeTables/routes@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1303},"Microsoft.Network/serviceEndpointPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1308},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1312},"Microsoft.Network/virtualNetworks@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1341},"Microsoft.Network/virtualNetworks/subnets@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1345},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1349},"Microsoft.Network/virtualNetworkGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1494},"Microsoft.Network/connections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1540},"Microsoft.Network/localNetworkGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1545},"Microsoft.Network/virtualNetworkTaps@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1550},"Microsoft.Network/virtualRouters@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1563},"Microsoft.Network/virtualRouters/peerings@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1573},"Microsoft.Network/virtualWans@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1591},"Microsoft.Network/vpnSites@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1613},"Microsoft.Network/vpnServerConfigurations@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1657},"Microsoft.Network/virtualHubs@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1693},"Microsoft.Network/vpnGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1738},"Microsoft.Network/vpnGateways/vpnConnections@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1742},"Microsoft.Network/p2svpnGateways@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1747},"Microsoft.Network/virtualHubs/routeTables@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1751},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-09-01":{"RelativePath":"network/microsoft.network/2019-09-01/types.json","Index":1846},"Microsoft.Network/applicationGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":555},"Microsoft.Network/applicationSecurityGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":560},"Microsoft.Network/azureFirewalls@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":666},"Microsoft.Network/bastionHosts@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":688},"Microsoft.Network/ddosCustomPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":711},"Microsoft.Network/ddosProtectionPlans@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":723},"Microsoft.Network/expressRouteCircuits/authorizations@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":736},"Microsoft.Network/expressRouteCircuits/peerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":791},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":795},"Microsoft.Network/expressRouteCircuits@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":825},"Microsoft.Network/expressRouteCrossConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":857},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":861},"Microsoft.Network/expressRouteGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":884},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":888},"Microsoft.Network/ExpressRoutePorts@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":921},"Microsoft.Network/firewallPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":939},"Microsoft.Network/firewallPolicies/ruleGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":986},"Microsoft.Network/ipGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":999},"Microsoft.Network/loadBalancers@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1071},"Microsoft.Network/loadBalancers/inboundNatRules@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1075},"Microsoft.Network/natGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1093},"Microsoft.Network/networkInterfaces@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1098},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1102},"Microsoft.Network/networkProfiles@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1140},"Microsoft.Network/networkSecurityGroups@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1145},"Microsoft.Network/networkSecurityGroups/securityRules@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1149},"Microsoft.Network/networkWatchers@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1160},"Microsoft.Network/networkWatchers/packetCaptures@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1177},"Microsoft.Network/networkWatchers/connectionMonitors@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1231},"Microsoft.Network/networkWatchers/flowLogs@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1248},"Microsoft.Network/privateEndpoints@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1253},"Microsoft.Network/privateLinkServices@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1293},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1297},"Microsoft.Network/publicIPAddresses@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1303},"Microsoft.Network/publicIPPrefixes@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1324},"Microsoft.Network/routeFilters@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1351},"Microsoft.Network/routeFilters/routeFilterRules@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1355},"Microsoft.Network/routeTables@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1360},"Microsoft.Network/routeTables/routes@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1364},"Microsoft.Network/serviceEndpointPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1369},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1373},"Microsoft.Network/virtualNetworks@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1402},"Microsoft.Network/virtualNetworks/subnets@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1406},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1410},"Microsoft.Network/virtualNetworkGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1555},"Microsoft.Network/connections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1601},"Microsoft.Network/localNetworkGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1606},"Microsoft.Network/virtualNetworkTaps@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1611},"Microsoft.Network/virtualRouters@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1624},"Microsoft.Network/virtualRouters/peerings@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1634},"Microsoft.Network/virtualWans@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1652},"Microsoft.Network/vpnSites@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1674},"Microsoft.Network/vpnServerConfigurations@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1718},"Microsoft.Network/virtualHubs@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1754},"Microsoft.Network/vpnGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1799},"Microsoft.Network/vpnGateways/vpnConnections@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1803},"Microsoft.Network/p2svpnGateways@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1808},"Microsoft.Network/virtualHubs/routeTables@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1812},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-11-01":{"RelativePath":"network/microsoft.network/2019-11-01/types.json","Index":1907},"Microsoft.Network/applicationGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":570},"Microsoft.Network/applicationSecurityGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":575},"Microsoft.Network/azureFirewalls@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":681},"Microsoft.Network/bastionHosts@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":703},"Microsoft.Network/ddosCustomPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":726},"Microsoft.Network/ddosProtectionPlans@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":738},"Microsoft.Network/expressRouteCircuits/authorizations@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":751},"Microsoft.Network/expressRouteCircuits/peerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":811},"Microsoft.Network/expressRouteCircuits/peerings/connections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":815},"Microsoft.Network/expressRouteCircuits@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":845},"Microsoft.Network/expressRouteCrossConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":877},"Microsoft.Network/expressRouteCrossConnections/peerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":881},"Microsoft.Network/expressRouteGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":904},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":908},"Microsoft.Network/ExpressRoutePorts@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":941},"Microsoft.Network/firewallPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":959},"Microsoft.Network/firewallPolicies/ruleGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1021},"Microsoft.Network/ipGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1034},"Microsoft.Network/loadBalancers@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1106},"Microsoft.Network/loadBalancers/inboundNatRules@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1110},"Microsoft.Network/natGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1128},"Microsoft.Network/networkInterfaces@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1133},"Microsoft.Network/networkInterfaces/tapConfigurations@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1137},"Microsoft.Network/networkProfiles@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1175},"Microsoft.Network/networkSecurityGroups@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1180},"Microsoft.Network/networkSecurityGroups/securityRules@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1184},"Microsoft.Network/networkVirtualAppliances@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1200},"Microsoft.Network/networkWatchers@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1211},"Microsoft.Network/networkWatchers/packetCaptures@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1228},"Microsoft.Network/networkWatchers/connectionMonitors@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1282},"Microsoft.Network/networkWatchers/flowLogs@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1287},"Microsoft.Network/privateEndpoints@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1292},"Microsoft.Network/privateLinkServices@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1332},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1336},"Microsoft.Network/publicIPAddresses@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1342},"Microsoft.Network/publicIPPrefixes@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1363},"Microsoft.Network/routeFilters@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1390},"Microsoft.Network/routeFilters/routeFilterRules@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1394},"Microsoft.Network/routeTables@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1399},"Microsoft.Network/routeTables/routes@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1403},"Microsoft.Network/serviceEndpointPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1408},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1412},"Microsoft.Network/virtualNetworks@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1441},"Microsoft.Network/virtualNetworks/subnets@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1445},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1449},"Microsoft.Network/virtualNetworkGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1599},"Microsoft.Network/connections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1645},"Microsoft.Network/localNetworkGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1650},"Microsoft.Network/virtualNetworkTaps@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1655},"Microsoft.Network/virtualRouters@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1668},"Microsoft.Network/virtualRouters/peerings@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1678},"Microsoft.Network/virtualWans@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1696},"Microsoft.Network/vpnSites@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1718},"Microsoft.Network/vpnServerConfigurations@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1762},"Microsoft.Network/virtualHubs@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1798},"Microsoft.Network/vpnGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1843},"Microsoft.Network/vpnGateways/vpnConnections@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1847},"Microsoft.Network/p2svpnGateways@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1852},"Microsoft.Network/virtualHubs/routeTables@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1856},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2019-12-01":{"RelativePath":"network/microsoft.network/2019-12-01/types.json","Index":1951},"Microsoft.Network/applicationGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":574},"Microsoft.Network/applicationSecurityGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":579},"Microsoft.Network/azureFirewalls@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":685},"Microsoft.Network/bastionHosts@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":707},"Microsoft.Network/ddosCustomPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":730},"Microsoft.Network/ddosProtectionPlans@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":742},"Microsoft.Network/expressRouteCircuits/authorizations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":755},"Microsoft.Network/expressRouteCircuits/peerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":815},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":819},"Microsoft.Network/expressRouteCircuits@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":849},"Microsoft.Network/expressRouteCrossConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":881},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":885},"Microsoft.Network/ExpressRoutePorts@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":918},"Microsoft.Network/firewallPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":936},"Microsoft.Network/firewallPolicies/ruleGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":998},"Microsoft.Network/IpAllocations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1011},"Microsoft.Network/ipGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1024},"Microsoft.Network/loadBalancers@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1096},"Microsoft.Network/loadBalancers/inboundNatRules@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1100},"Microsoft.Network/natGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1118},"Microsoft.Network/networkInterfaces@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1123},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1127},"Microsoft.Network/networkProfiles@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1165},"Microsoft.Network/networkSecurityGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1170},"Microsoft.Network/networkSecurityGroups/securityRules@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1174},"Microsoft.Network/networkVirtualAppliances@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1190},"Microsoft.Network/networkWatchers@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1201},"Microsoft.Network/networkWatchers/packetCaptures@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1218},"Microsoft.Network/networkWatchers/connectionMonitors@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1272},"Microsoft.Network/networkWatchers/flowLogs@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1277},"Microsoft.Network/privateEndpoints@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1282},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1303},"Microsoft.Network/privateLinkServices@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1343},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1347},"Microsoft.Network/publicIPAddresses@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1353},"Microsoft.Network/publicIPPrefixes@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1374},"Microsoft.Network/routeFilters@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1401},"Microsoft.Network/routeFilters/routeFilterRules@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1405},"Microsoft.Network/routeTables@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1410},"Microsoft.Network/routeTables/routes@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1414},"Microsoft.Network/securityPartnerProviders@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1434},"Microsoft.Network/serviceEndpointPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1439},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1443},"Microsoft.Network/virtualNetworks@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1473},"Microsoft.Network/virtualNetworks/subnets@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1477},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1481},"Microsoft.Network/virtualNetworkGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1633},"Microsoft.Network/connections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1679},"Microsoft.Network/localNetworkGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1684},"Microsoft.Network/virtualNetworkTaps@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1689},"Microsoft.Network/virtualRouters@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1702},"Microsoft.Network/virtualRouters/peerings@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1712},"Microsoft.Network/virtualWans@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1730},"Microsoft.Network/vpnSites@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1752},"Microsoft.Network/vpnServerConfigurations@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1797},"Microsoft.Network/virtualHubs@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1833},"Microsoft.Network/vpnGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1878},"Microsoft.Network/vpnGateways/vpnConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1882},"Microsoft.Network/p2svpnGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1887},"Microsoft.Network/virtualHubs/routeTables@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1891},"Microsoft.Network/expressRouteGateways@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1914},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":1918},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-03-01":{"RelativePath":"network/microsoft.network/2020-03-01/types.json","Index":2013},"Microsoft.Network/applicationGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":577},"Microsoft.Network/applicationSecurityGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":582},"Microsoft.Network/azureFirewalls@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":689},"Microsoft.Network/bastionHosts@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":711},"Microsoft.Network/ddosCustomPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":734},"Microsoft.Network/ddosProtectionPlans@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":746},"Microsoft.Network/expressRouteCircuits/authorizations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":759},"Microsoft.Network/expressRouteCircuits/peerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":819},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":823},"Microsoft.Network/expressRouteCircuits@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":853},"Microsoft.Network/expressRouteCrossConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":885},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":889},"Microsoft.Network/ExpressRoutePorts@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":922},"Microsoft.Network/firewallPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":943},"Microsoft.Network/firewallPolicies/ruleGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1005},"Microsoft.Network/IpAllocations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1018},"Microsoft.Network/ipGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1031},"Microsoft.Network/loadBalancers@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1103},"Microsoft.Network/loadBalancers/backendAddressPools@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1107},"Microsoft.Network/loadBalancers/inboundNatRules@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1111},"Microsoft.Network/natGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1129},"Microsoft.Network/networkInterfaces@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1134},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1138},"Microsoft.Network/networkProfiles@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1176},"Microsoft.Network/networkSecurityGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1181},"Microsoft.Network/networkSecurityGroups/securityRules@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1185},"Microsoft.Network/networkVirtualAppliances@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1201},"Microsoft.Network/networkWatchers@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1212},"Microsoft.Network/networkWatchers/packetCaptures@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1229},"Microsoft.Network/networkWatchers/connectionMonitors@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1283},"Microsoft.Network/networkWatchers/flowLogs@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1288},"Microsoft.Network/privateEndpoints@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1293},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1314},"Microsoft.Network/privateLinkServices@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1354},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1358},"Microsoft.Network/publicIPAddresses@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1364},"Microsoft.Network/publicIPPrefixes@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1385},"Microsoft.Network/routeFilters@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1412},"Microsoft.Network/routeFilters/routeFilterRules@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1416},"Microsoft.Network/routeTables@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1421},"Microsoft.Network/routeTables/routes@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1425},"Microsoft.Network/securityPartnerProviders@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1445},"Microsoft.Network/serviceEndpointPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1450},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1454},"Microsoft.Network/virtualNetworks@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1484},"Microsoft.Network/virtualNetworks/subnets@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1488},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1492},"Microsoft.Network/virtualNetworkGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1644},"Microsoft.Network/connections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1690},"Microsoft.Network/localNetworkGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1695},"Microsoft.Network/virtualNetworkTaps@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1700},"Microsoft.Network/virtualRouters@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1713},"Microsoft.Network/virtualRouters/peerings@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1723},"Microsoft.Network/virtualWans@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1741},"Microsoft.Network/vpnSites@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1763},"Microsoft.Network/vpnServerConfigurations@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1816},"Microsoft.Network/virtualHubs@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1852},"Microsoft.Network/vpnGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1897},"Microsoft.Network/vpnGateways/vpnConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1901},"Microsoft.Network/p2svpnGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1906},"Microsoft.Network/virtualHubs/routeTables@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1910},"Microsoft.Network/expressRouteGateways@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1933},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1937},"Microsoft.Network/virtualHubs/hubRouteTables@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":1953},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-04-01":{"RelativePath":"network/microsoft.network/2020-04-01/types.json","Index":2048},"Microsoft.Network/applicationGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":604},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":608},"Microsoft.Network/applicationSecurityGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":613},"Microsoft.Network/azureFirewalls@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":721},"Microsoft.Network/bastionHosts@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":743},"Microsoft.Network/ddosCustomPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":766},"Microsoft.Network/ddosProtectionPlans@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":778},"Microsoft.Network/expressRouteCircuits/authorizations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":791},"Microsoft.Network/expressRouteCircuits/peerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":851},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":855},"Microsoft.Network/expressRouteCircuits@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":885},"Microsoft.Network/expressRouteCrossConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":917},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":921},"Microsoft.Network/ExpressRoutePorts@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":954},"Microsoft.Network/firewallPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":977},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1041},"Microsoft.Network/IpAllocations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1054},"Microsoft.Network/ipGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1067},"Microsoft.Network/loadBalancers@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1139},"Microsoft.Network/loadBalancers/backendAddressPools@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1143},"Microsoft.Network/loadBalancers/inboundNatRules@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1147},"Microsoft.Network/natGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1165},"Microsoft.Network/networkInterfaces@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1170},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1174},"Microsoft.Network/networkProfiles@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1212},"Microsoft.Network/networkSecurityGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1217},"Microsoft.Network/networkSecurityGroups/securityRules@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1221},"Microsoft.Network/networkVirtualAppliances@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1238},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1250},"Microsoft.Network/networkWatchers@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1261},"Microsoft.Network/networkWatchers/packetCaptures@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1278},"Microsoft.Network/networkWatchers/connectionMonitors@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1332},"Microsoft.Network/networkWatchers/flowLogs@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1337},"Microsoft.Network/privateEndpoints@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1342},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1363},"Microsoft.Network/privateLinkServices@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1403},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1407},"Microsoft.Network/publicIPAddresses@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1413},"Microsoft.Network/publicIPPrefixes@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1434},"Microsoft.Network/routeFilters@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1461},"Microsoft.Network/routeFilters/routeFilterRules@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1465},"Microsoft.Network/routeTables@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1470},"Microsoft.Network/routeTables/routes@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1474},"Microsoft.Network/securityPartnerProviders@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1494},"Microsoft.Network/serviceEndpointPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1499},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1503},"Microsoft.Network/virtualNetworks@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1533},"Microsoft.Network/virtualNetworks/subnets@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1537},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1541},"Microsoft.Network/virtualNetworkGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1693},"Microsoft.Network/connections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1739},"Microsoft.Network/localNetworkGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1744},"Microsoft.Network/virtualNetworkTaps@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1749},"Microsoft.Network/virtualRouters@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1762},"Microsoft.Network/virtualRouters/peerings@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1772},"Microsoft.Network/virtualWans@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1790},"Microsoft.Network/vpnSites@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1812},"Microsoft.Network/vpnServerConfigurations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1866},"Microsoft.Network/virtualHubs@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1902},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1912},"Microsoft.Network/vpnGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1957},"Microsoft.Network/vpnGateways/vpnConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1961},"Microsoft.Network/p2svpnGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1966},"Microsoft.Network/virtualHubs/routeTables@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1970},"Microsoft.Network/expressRouteGateways@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1993},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":1997},"Microsoft.Network/virtualHubs/bgpConnections@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2012},"Microsoft.Network/virtualHubs/ipConfigurations@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2025},"Microsoft.Network/virtualHubs/hubRouteTables@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2041},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-05-01":{"RelativePath":"network/microsoft.network/2020-05-01/types.json","Index":2136},"Microsoft.Network/applicationGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":622},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":626},"Microsoft.Network/applicationSecurityGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":631},"Microsoft.Network/azureFirewalls@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":739},"Microsoft.Network/bastionHosts@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":761},"Microsoft.Network/customIpPrefixes@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":781},"Microsoft.Network/ddosCustomPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":804},"Microsoft.Network/ddosProtectionPlans@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":816},"Microsoft.Network/dscpConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":845},"Microsoft.Network/expressRouteCircuits/authorizations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":858},"Microsoft.Network/expressRouteCircuits/peerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":918},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":922},"Microsoft.Network/expressRouteCircuits@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":952},"Microsoft.Network/expressRouteCrossConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":984},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":988},"Microsoft.Network/ExpressRoutePorts@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1026},"Microsoft.Network/firewallPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1049},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1113},"Microsoft.Network/IpAllocations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1126},"Microsoft.Network/ipGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1139},"Microsoft.Network/loadBalancers@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1211},"Microsoft.Network/loadBalancers/backendAddressPools@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1215},"Microsoft.Network/loadBalancers/inboundNatRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1219},"Microsoft.Network/natGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1237},"Microsoft.Network/networkInterfaces@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1242},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1246},"Microsoft.Network/networkProfiles@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1284},"Microsoft.Network/networkSecurityGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1289},"Microsoft.Network/networkSecurityGroups/securityRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1293},"Microsoft.Network/networkVirtualAppliances@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1311},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1323},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1338},"Microsoft.Network/networkWatchers@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1349},"Microsoft.Network/networkWatchers/packetCaptures@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1366},"Microsoft.Network/networkWatchers/connectionMonitors@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1441},"Microsoft.Network/networkWatchers/flowLogs@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1446},"Microsoft.Network/privateEndpoints@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1451},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1472},"Microsoft.Network/privateLinkServices@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1512},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1516},"Microsoft.Network/publicIPAddresses@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1522},"Microsoft.Network/publicIPPrefixes@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1543},"Microsoft.Network/routeFilters@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1570},"Microsoft.Network/routeFilters/routeFilterRules@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1574},"Microsoft.Network/routeTables@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1579},"Microsoft.Network/routeTables/routes@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1583},"Microsoft.Network/securityPartnerProviders@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1603},"Microsoft.Network/serviceEndpointPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1608},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1612},"Microsoft.Network/virtualNetworks@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1642},"Microsoft.Network/virtualNetworks/subnets@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1646},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1650},"Microsoft.Network/virtualNetworkGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1802},"Microsoft.Network/connections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1848},"Microsoft.Network/localNetworkGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1853},"Microsoft.Network/virtualNetworkTaps@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1858},"Microsoft.Network/virtualRouters@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1871},"Microsoft.Network/virtualRouters/peerings@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1881},"Microsoft.Network/virtualWans@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1899},"Microsoft.Network/vpnSites@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1923},"Microsoft.Network/vpnServerConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":1977},"Microsoft.Network/virtualHubs@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2013},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2023},"Microsoft.Network/vpnGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2070},"Microsoft.Network/vpnGateways/vpnConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2074},"Microsoft.Network/p2svpnGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2079},"Microsoft.Network/virtualHubs/routeTables@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2083},"Microsoft.Network/expressRouteGateways@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2106},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2110},"Microsoft.Network/virtualHubs/bgpConnections@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2125},"Microsoft.Network/virtualHubs/ipConfigurations@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2138},"Microsoft.Network/virtualHubs/hubRouteTables@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2154},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-06-01":{"RelativePath":"network/microsoft.network/2020-06-01/types.json","Index":2249},"Microsoft.Network/applicationGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":695},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":699},"Microsoft.Network/applicationSecurityGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":704},"Microsoft.Network/azureFirewalls@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":812},"Microsoft.Network/bastionHosts@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":834},"Microsoft.Network/customIpPrefixes@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":854},"Microsoft.Network/ddosCustomPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":877},"Microsoft.Network/ddosProtectionPlans@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":889},"Microsoft.Network/dscpConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":918},"Microsoft.Network/expressRouteCircuits/authorizations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":931},"Microsoft.Network/expressRouteCircuits/peerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":991},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":995},"Microsoft.Network/expressRouteCircuits@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1025},"Microsoft.Network/expressRouteCrossConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1057},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1061},"Microsoft.Network/ExpressRoutePorts@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1099},"Microsoft.Network/firewallPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1152},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1218},"Microsoft.Network/IpAllocations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1231},"Microsoft.Network/ipGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1245},"Microsoft.Network/loadBalancers@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1320},"Microsoft.Network/loadBalancers/backendAddressPools@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1324},"Microsoft.Network/loadBalancers/inboundNatRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1328},"Microsoft.Network/natGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1334},"Microsoft.Network/networkInterfaces@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1339},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1343},"Microsoft.Network/networkProfiles@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1381},"Microsoft.Network/networkSecurityGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1386},"Microsoft.Network/networkSecurityGroups/securityRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1390},"Microsoft.Network/networkVirtualAppliances@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1408},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1420},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1435},"Microsoft.Network/networkWatchers@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1446},"Microsoft.Network/networkWatchers/packetCaptures@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1463},"Microsoft.Network/networkWatchers/connectionMonitors@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1538},"Microsoft.Network/networkWatchers/flowLogs@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1543},"Microsoft.Network/privateEndpoints@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1548},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1569},"Microsoft.Network/privateLinkServices@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1574},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1578},"Microsoft.Network/publicIPAddresses@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1584},"Microsoft.Network/publicIPPrefixes@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1608},"Microsoft.Network/routeFilters@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1635},"Microsoft.Network/routeFilters/routeFilterRules@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1639},"Microsoft.Network/routeTables@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1644},"Microsoft.Network/routeTables/routes@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1648},"Microsoft.Network/securityPartnerProviders@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1668},"Microsoft.Network/serviceEndpointPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1673},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1677},"Microsoft.Network/virtualNetworks@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1707},"Microsoft.Network/virtualNetworks/subnets@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1711},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1715},"Microsoft.Network/virtualNetworkGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1868},"Microsoft.Network/connections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1918},"Microsoft.Network/localNetworkGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1923},"Microsoft.Network/virtualNetworkTaps@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1928},"Microsoft.Network/virtualRouters@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1941},"Microsoft.Network/virtualRouters/peerings@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1951},"Microsoft.Network/virtualWans@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1969},"Microsoft.Network/vpnSites@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":1993},"Microsoft.Network/vpnServerConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2047},"Microsoft.Network/virtualHubs@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2083},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2093},"Microsoft.Network/vpnGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2140},"Microsoft.Network/vpnGateways/vpnConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2144},"Microsoft.Network/p2svpnGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2149},"Microsoft.Network/virtualHubs/routeTables@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2153},"Microsoft.Network/expressRouteGateways@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2176},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2180},"Microsoft.Network/virtualHubs/bgpConnections@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2195},"Microsoft.Network/virtualHubs/ipConfigurations@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2208},"Microsoft.Network/virtualHubs/hubRouteTables@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2224},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-07-01":{"RelativePath":"network/microsoft.network/2020-07-01/types.json","Index":2319},"Microsoft.Network/applicationGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":702},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":706},"Microsoft.Network/applicationSecurityGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":711},"Microsoft.Network/azureFirewalls@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":819},"Microsoft.Network/bastionHosts@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":841},"Microsoft.Network/customIpPrefixes@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":861},"Microsoft.Network/ddosCustomPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":884},"Microsoft.Network/ddosProtectionPlans@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":896},"Microsoft.Network/dscpConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":925},"Microsoft.Network/expressRouteCircuits/authorizations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":938},"Microsoft.Network/expressRouteCircuits/peerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":998},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1002},"Microsoft.Network/expressRouteCircuits@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1032},"Microsoft.Network/expressRouteCrossConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1064},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1068},"Microsoft.Network/ExpressRoutePorts@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1106},"Microsoft.Network/firewallPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1159},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1225},"Microsoft.Network/IpAllocations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1238},"Microsoft.Network/ipGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1252},"Microsoft.Network/loadBalancers@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1327},"Microsoft.Network/loadBalancers/backendAddressPools@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1331},"Microsoft.Network/loadBalancers/inboundNatRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1335},"Microsoft.Network/natGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1341},"Microsoft.Network/networkInterfaces@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1346},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1350},"Microsoft.Network/networkProfiles@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1388},"Microsoft.Network/networkSecurityGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1393},"Microsoft.Network/networkSecurityGroups/securityRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1397},"Microsoft.Network/networkVirtualAppliances@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1415},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1427},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1442},"Microsoft.Network/networkWatchers@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1453},"Microsoft.Network/networkWatchers/packetCaptures@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1470},"Microsoft.Network/networkWatchers/connectionMonitors@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1545},"Microsoft.Network/networkWatchers/flowLogs@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1550},"Microsoft.Network/privateEndpoints@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1555},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1576},"Microsoft.Network/privateLinkServices@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1581},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1585},"Microsoft.Network/publicIPAddresses@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1591},"Microsoft.Network/publicIPPrefixes@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1615},"Microsoft.Network/routeFilters@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1642},"Microsoft.Network/routeFilters/routeFilterRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1646},"Microsoft.Network/routeTables@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1651},"Microsoft.Network/routeTables/routes@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1655},"Microsoft.Network/securityPartnerProviders@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1675},"Microsoft.Network/serviceEndpointPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1680},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1684},"Microsoft.Network/virtualNetworks@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1714},"Microsoft.Network/virtualNetworks/subnets@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1718},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1722},"Microsoft.Network/virtualNetworkGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1875},"Microsoft.Network/connections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1925},"Microsoft.Network/localNetworkGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1930},"Microsoft.Network/virtualNetworkTaps@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1935},"Microsoft.Network/virtualRouters@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1948},"Microsoft.Network/virtualRouters/peerings@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1958},"Microsoft.Network/virtualWans@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":1976},"Microsoft.Network/vpnSites@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2000},"Microsoft.Network/vpnServerConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2054},"Microsoft.Network/virtualHubs@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2090},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2100},"Microsoft.Network/vpnGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2172},"Microsoft.Network/vpnGateways/vpnConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2176},"Microsoft.Network/vpnGateways/natRules@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2180},"Microsoft.Network/p2svpnGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2185},"Microsoft.Network/virtualHubs/routeTables@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2189},"Microsoft.Network/expressRouteGateways@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2212},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2216},"Microsoft.Network/virtualHubs/bgpConnections@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2231},"Microsoft.Network/virtualHubs/ipConfigurations@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2244},"Microsoft.Network/virtualHubs/hubRouteTables@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2260},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-08-01":{"RelativePath":"network/microsoft.network/2020-08-01/types.json","Index":2355},"Microsoft.Network/applicationGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":702},"Microsoft.Network/applicationGateways/privateEndpointConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":706},"Microsoft.Network/applicationSecurityGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":711},"Microsoft.Network/azureFirewalls@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":819},"Microsoft.Network/bastionHosts@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":841},"Microsoft.Network/networkInterfaces@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":846},"Microsoft.Network/publicIPAddresses@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":852},"Microsoft.Network/customIpPrefixes@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":872},"Microsoft.Network/ddosCustomPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":895},"Microsoft.Network/ddosProtectionPlans@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":907},"Microsoft.Network/dscpConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":936},"Microsoft.Network/expressRouteCircuits/authorizations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":949},"Microsoft.Network/expressRouteCircuits/peerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1009},"Microsoft.Network/expressRouteCircuits/peerings/connections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1013},"Microsoft.Network/expressRouteCircuits@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1043},"Microsoft.Network/expressRouteCrossConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1075},"Microsoft.Network/expressRouteCrossConnections/peerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1079},"Microsoft.Network/ExpressRoutePorts@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1117},"Microsoft.Network/firewallPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1176},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1242},"Microsoft.Network/IpAllocations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1255},"Microsoft.Network/ipGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1269},"Microsoft.Network/loadBalancers@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1344},"Microsoft.Network/loadBalancers/backendAddressPools@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1348},"Microsoft.Network/loadBalancers/inboundNatRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1352},"Microsoft.Network/natGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1358},"Microsoft.Network/networkInterfaces/tapConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1362},"Microsoft.Network/networkProfiles@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1400},"Microsoft.Network/networkSecurityGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1405},"Microsoft.Network/networkSecurityGroups/securityRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1409},"Microsoft.Network/networkVirtualAppliances@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1427},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1439},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1454},"Microsoft.Network/networkWatchers@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1465},"Microsoft.Network/networkWatchers/packetCaptures@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1482},"Microsoft.Network/networkWatchers/connectionMonitors@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1557},"Microsoft.Network/networkWatchers/flowLogs@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1562},"Microsoft.Network/privateEndpoints@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1567},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1588},"Microsoft.Network/privateLinkServices@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1593},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1597},"Microsoft.Network/publicIPPrefixes@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1621},"Microsoft.Network/routeFilters@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1648},"Microsoft.Network/routeFilters/routeFilterRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1652},"Microsoft.Network/routeTables@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1657},"Microsoft.Network/routeTables/routes@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1661},"Microsoft.Network/securityPartnerProviders@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1681},"Microsoft.Network/serviceEndpointPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1686},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1690},"Microsoft.Network/virtualNetworks@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1720},"Microsoft.Network/virtualNetworks/subnets@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1724},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1728},"Microsoft.Network/virtualNetworkGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1886},"Microsoft.Network/connections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1936},"Microsoft.Network/localNetworkGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1941},"Microsoft.Network/virtualNetworkTaps@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1946},"Microsoft.Network/virtualRouters@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1959},"Microsoft.Network/virtualRouters/peerings@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1969},"Microsoft.Network/virtualWans@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":1987},"Microsoft.Network/vpnSites@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2011},"Microsoft.Network/vpnServerConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2065},"Microsoft.Network/virtualHubs@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2101},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2111},"Microsoft.Network/vpnGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2184},"Microsoft.Network/vpnGateways/vpnConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2188},"Microsoft.Network/vpnGateways/natRules@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2192},"Microsoft.Network/p2svpnGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2197},"Microsoft.Network/virtualHubs/routeTables@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2201},"Microsoft.Network/expressRouteGateways@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2224},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2228},"Microsoft.Network/virtualHubs/bgpConnections@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2243},"Microsoft.Network/virtualHubs/ipConfigurations@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2256},"Microsoft.Network/virtualHubs/hubRouteTables@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2272},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2020-11-01":{"RelativePath":"network/microsoft.network/2020-11-01/types.json","Index":2367},"Microsoft.Network/networkManagers@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":37},"Microsoft.Network/networkManagers/connectivityConfigurations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":69},"Microsoft.Network/networkManagers/networkGroups@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":81},"Microsoft.Network/networkManagers/securityUserConfigurations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":97},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":109},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":161},"Microsoft.Network/networkManagers/securityAdminConfigurations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":165},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":169},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":225},"Microsoft.Network/networkSecurityPerimeters@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":238},"Microsoft.Network/networkSecurityPerimeters/profiles@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":246},"Microsoft.Network/networkSecurityPerimeters/profiles/accessRules@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":267},"Microsoft.Network/networkSecurityPerimeters/resourceAssociations@2021-02-01-preview":{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":285},"Microsoft.Network/applicationGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":715},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":719},"Microsoft.Network/applicationSecurityGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":724},"Microsoft.Network/azureFirewalls@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":832},"Microsoft.Network/bastionHosts@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":858},"Microsoft.Network/networkInterfaces@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":863},"Microsoft.Network/publicIPAddresses@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":869},"Microsoft.Network/customIpPrefixes@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":893},"Microsoft.Network/ddosCustomPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":916},"Microsoft.Network/ddosProtectionPlans@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":928},"Microsoft.Network/dscpConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":957},"Microsoft.Network/expressRouteCircuits/authorizations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":970},"Microsoft.Network/expressRouteCircuits/peerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1030},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1034},"Microsoft.Network/expressRouteCircuits@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1064},"Microsoft.Network/expressRouteCrossConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1096},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1100},"Microsoft.Network/ExpressRoutePorts@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1138},"Microsoft.Network/firewallPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1197},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1263},"Microsoft.Network/IpAllocations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1276},"Microsoft.Network/ipGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1290},"Microsoft.Network/loadBalancers@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1367},"Microsoft.Network/loadBalancers/backendAddressPools@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1371},"Microsoft.Network/loadBalancers/inboundNatRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1375},"Microsoft.Network/natGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1381},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1385},"Microsoft.Network/networkProfiles@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1423},"Microsoft.Network/networkSecurityGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1428},"Microsoft.Network/networkSecurityGroups/securityRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1432},"Microsoft.Network/networkVirtualAppliances@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1450},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1462},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1477},"Microsoft.Network/networkWatchers@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1488},"Microsoft.Network/networkWatchers/packetCaptures@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1505},"Microsoft.Network/networkWatchers/connectionMonitors@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1580},"Microsoft.Network/networkWatchers/flowLogs@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1585},"Microsoft.Network/privateEndpoints@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1590},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1616},"Microsoft.Network/privateLinkServices@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1621},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1625},"Microsoft.Network/publicIPPrefixes@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1649},"Microsoft.Network/routeFilters@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1676},"Microsoft.Network/routeFilters/routeFilterRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1680},"Microsoft.Network/routeTables@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1685},"Microsoft.Network/routeTables/routes@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1689},"Microsoft.Network/securityPartnerProviders@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1709},"Microsoft.Network/serviceEndpointPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1714},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1718},"Microsoft.Network/virtualNetworks@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1753},"Microsoft.Network/virtualNetworks/subnets@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1757},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1761},"Microsoft.Network/virtualNetworkGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1936},"Microsoft.Network/connections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1988},"Microsoft.Network/localNetworkGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1993},"Microsoft.Network/virtualNetworkGateways/natRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":1997},"Microsoft.Network/virtualNetworkTaps@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2002},"Microsoft.Network/virtualRouters@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2015},"Microsoft.Network/virtualRouters/peerings@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2025},"Microsoft.Network/virtualWans@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2043},"Microsoft.Network/vpnSites@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2067},"Microsoft.Network/vpnServerConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2121},"Microsoft.Network/virtualHubs@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2161},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2171},"Microsoft.Network/vpnGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2243},"Microsoft.Network/vpnGateways/vpnConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2247},"Microsoft.Network/vpnGateways/natRules@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2251},"Microsoft.Network/p2svpnGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2256},"Microsoft.Network/virtualHubs/routeTables@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2260},"Microsoft.Network/expressRouteGateways@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2283},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2287},"Microsoft.Network/virtualHubs/bgpConnections@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2302},"Microsoft.Network/virtualHubs/ipConfigurations@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2315},"Microsoft.Network/virtualHubs/hubRouteTables@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2331},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-02-01":{"RelativePath":"network/microsoft.network/2021-02-01/types.json","Index":2426},"Microsoft.Network/networkSecurityPerimeters@2021-03-01-preview":{"RelativePath":"network/microsoft.network/2021-03-01-preview/types.json","Index":18},"Microsoft.Network/applicationGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":736},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":740},"Microsoft.Network/applicationSecurityGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":745},"Microsoft.Network/azureFirewalls@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":853},"Microsoft.Network/bastionHosts@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":879},"Microsoft.Network/networkInterfaces@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":884},"Microsoft.Network/publicIPAddresses@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":890},"Microsoft.Network/customIpPrefixes@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":914},"Microsoft.Network/ddosCustomPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":937},"Microsoft.Network/ddosProtectionPlans@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":949},"Microsoft.Network/dscpConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":995},"Microsoft.Network/expressRouteCircuits/authorizations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1008},"Microsoft.Network/expressRouteCircuits/peerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1068},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1072},"Microsoft.Network/expressRouteCircuits@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1102},"Microsoft.Network/expressRouteCrossConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1134},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1138},"Microsoft.Network/ExpressRoutePorts@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1176},"Microsoft.Network/firewallPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1237},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1303},"Microsoft.Network/IpAllocations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1316},"Microsoft.Network/ipGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1330},"Microsoft.Network/loadBalancers@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1407},"Microsoft.Network/loadBalancers/backendAddressPools@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1411},"Microsoft.Network/loadBalancers/inboundNatRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1415},"Microsoft.Network/natGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1421},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1425},"Microsoft.Network/networkProfiles@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1463},"Microsoft.Network/networkSecurityGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1468},"Microsoft.Network/networkSecurityGroups/securityRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1472},"Microsoft.Network/networkVirtualAppliances@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1490},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1502},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1517},"Microsoft.Network/networkWatchers@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1528},"Microsoft.Network/networkWatchers/packetCaptures@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1545},"Microsoft.Network/networkWatchers/connectionMonitors@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1620},"Microsoft.Network/networkWatchers/flowLogs@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1625},"Microsoft.Network/privateEndpoints@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1630},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1651},"Microsoft.Network/privateLinkServices@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1656},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1660},"Microsoft.Network/publicIPPrefixes@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1684},"Microsoft.Network/routeFilters@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1711},"Microsoft.Network/routeFilters/routeFilterRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1715},"Microsoft.Network/routeTables@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1720},"Microsoft.Network/routeTables/routes@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1724},"Microsoft.Network/securityPartnerProviders@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1744},"Microsoft.Network/serviceEndpointPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1749},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1753},"Microsoft.Network/virtualNetworks@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1788},"Microsoft.Network/virtualNetworks/subnets@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1792},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1796},"Microsoft.Network/virtualNetworkGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":1971},"Microsoft.Network/connections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2023},"Microsoft.Network/localNetworkGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2028},"Microsoft.Network/virtualNetworkGateways/natRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2032},"Microsoft.Network/virtualNetworkTaps@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2037},"Microsoft.Network/virtualRouters@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2050},"Microsoft.Network/virtualRouters/peerings@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2060},"Microsoft.Network/virtualWans@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2078},"Microsoft.Network/vpnSites@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2102},"Microsoft.Network/vpnServerConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2157},"Microsoft.Network/virtualHubs@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2197},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2207},"Microsoft.Network/vpnGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2279},"Microsoft.Network/vpnGateways/vpnConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2283},"Microsoft.Network/vpnGateways/natRules@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2287},"Microsoft.Network/p2svpnGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2292},"Microsoft.Network/virtualHubs/routeTables@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2296},"Microsoft.Network/expressRouteGateways@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2319},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2323},"Microsoft.Network/virtualHubs/bgpConnections@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2338},"Microsoft.Network/virtualHubs/ipConfigurations@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2351},"Microsoft.Network/virtualHubs/hubRouteTables@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2367},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-03-01":{"RelativePath":"network/microsoft.network/2021-03-01/types.json","Index":2462},"Microsoft.Network/networkManagers@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":41},"Microsoft.Network/networkManagers/connectivityConfigurations@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":73},"Microsoft.Network/networkManagers/networkGroups@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":83},"Microsoft.Network/networkManagers/networkGroups/staticMembers@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":88},"Microsoft.Network/networkManagers/securityUserConfigurations@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":108},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":120},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":172},"Microsoft.Network/networkManagers/securityAdminConfigurations@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":176},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":180},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":236},"Microsoft.Network/networkManagerConnections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":247},"Microsoft.Network/managementGroups/networkManagerConnections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":251},"Microsoft.Network/networkManagers/scopeConnections@2021-05-01-preview":{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":262},"Microsoft.Network/applicationGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":739},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":743},"Microsoft.Network/applicationSecurityGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":748},"Microsoft.Network/azureFirewalls@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":857},"Microsoft.Network/bastionHosts@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":883},"Microsoft.Network/networkInterfaces@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":888},"Microsoft.Network/publicIPAddresses@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":894},"Microsoft.Network/customIpPrefixes@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":915},"Microsoft.Network/ddosCustomPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":938},"Microsoft.Network/ddosProtectionPlans@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":950},"Microsoft.Network/dscpConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":996},"Microsoft.Network/expressRouteCircuits/authorizations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1009},"Microsoft.Network/expressRouteCircuits/peerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1069},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1073},"Microsoft.Network/expressRouteCircuits@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1103},"Microsoft.Network/expressRouteCrossConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1135},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1139},"Microsoft.Network/ExpressRoutePorts@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1177},"Microsoft.Network/firewallPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1239},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1305},"Microsoft.Network/firewallPolicies/signatureOverrides@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1312},"Microsoft.Network/IpAllocations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1325},"Microsoft.Network/ipGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1339},"Microsoft.Network/loadBalancers@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1416},"Microsoft.Network/loadBalancers/backendAddressPools@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1420},"Microsoft.Network/loadBalancers/inboundNatRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1424},"Microsoft.Network/natGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1430},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1434},"Microsoft.Network/networkProfiles@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1472},"Microsoft.Network/networkSecurityGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1477},"Microsoft.Network/networkSecurityGroups/securityRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1481},"Microsoft.Network/networkVirtualAppliances@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1499},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1511},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1526},"Microsoft.Network/networkWatchers@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1537},"Microsoft.Network/networkWatchers/packetCaptures@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1554},"Microsoft.Network/networkWatchers/connectionMonitors@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1629},"Microsoft.Network/networkWatchers/flowLogs@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1634},"Microsoft.Network/privateEndpoints@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1639},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1660},"Microsoft.Network/privateLinkServices@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1665},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1669},"Microsoft.Network/publicIPPrefixes@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1693},"Microsoft.Network/routeFilters@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1720},"Microsoft.Network/routeFilters/routeFilterRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1724},"Microsoft.Network/routeTables@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1729},"Microsoft.Network/routeTables/routes@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1733},"Microsoft.Network/securityPartnerProviders@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1753},"Microsoft.Network/serviceEndpointPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1758},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1762},"Microsoft.Network/virtualNetworks@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1801},"Microsoft.Network/virtualNetworks/subnets@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1805},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1809},"Microsoft.Network/virtualNetworkGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":1984},"Microsoft.Network/connections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2036},"Microsoft.Network/localNetworkGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2041},"Microsoft.Network/virtualNetworkGateways/natRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2045},"Microsoft.Network/virtualNetworkTaps@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2050},"Microsoft.Network/virtualRouters@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2063},"Microsoft.Network/virtualRouters/peerings@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2073},"Microsoft.Network/virtualWans@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2091},"Microsoft.Network/vpnSites@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2115},"Microsoft.Network/vpnServerConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2170},"Microsoft.Network/virtualHubs@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2210},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2220},"Microsoft.Network/vpnGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2292},"Microsoft.Network/vpnGateways/vpnConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2296},"Microsoft.Network/vpnGateways/natRules@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2300},"Microsoft.Network/p2svpnGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2305},"Microsoft.Network/virtualHubs/routeTables@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2309},"Microsoft.Network/expressRouteGateways@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2332},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2336},"Microsoft.Network/virtualHubs/bgpConnections@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2351},"Microsoft.Network/virtualHubs/ipConfigurations@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2364},"Microsoft.Network/virtualHubs/hubRouteTables@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2380},"Microsoft.Network/virtualHubs/routingIntent@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2393},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-05-01":{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2500},"Microsoft.Network/applicationGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":792},"Microsoft.Network/applicationGateways/privateEndpointConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":796},"Microsoft.Network/applicationSecurityGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":801},"Microsoft.Network/azureFirewalls@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":910},"Microsoft.Network/bastionHosts@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":936},"Microsoft.Network/networkInterfaces@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":941},"Microsoft.Network/publicIPAddresses@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":947},"Microsoft.Network/customIpPrefixes@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":968},"Microsoft.Network/ddosCustomPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":991},"Microsoft.Network/ddosProtectionPlans@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1003},"Microsoft.Network/dscpConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1049},"Microsoft.Network/expressRouteCircuits/authorizations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1062},"Microsoft.Network/expressRouteCircuits/peerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1122},"Microsoft.Network/expressRouteCircuits/peerings/connections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1126},"Microsoft.Network/expressRouteCircuits@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1156},"Microsoft.Network/expressRouteCrossConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1188},"Microsoft.Network/expressRouteCrossConnections/peerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1192},"Microsoft.Network/ExpressRoutePorts@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1230},"Microsoft.Network/expressRoutePorts/authorizations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1243},"Microsoft.Network/firewallPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1306},"Microsoft.Network/firewallPolicies/ruleCollectionGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1372},"Microsoft.Network/firewallPolicies/signatureOverrides@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1379},"Microsoft.Network/IpAllocations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1392},"Microsoft.Network/ipGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1406},"Microsoft.Network/loadBalancers@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1483},"Microsoft.Network/loadBalancers/backendAddressPools@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1487},"Microsoft.Network/loadBalancers/inboundNatRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1491},"Microsoft.Network/natGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1497},"Microsoft.Network/networkInterfaces/tapConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1501},"Microsoft.Network/networkProfiles@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1539},"Microsoft.Network/networkSecurityGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1544},"Microsoft.Network/networkSecurityGroups/securityRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1548},"Microsoft.Network/networkVirtualAppliances@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1566},"Microsoft.Network/networkVirtualAppliances/virtualApplianceSites@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1578},"Microsoft.Network/networkVirtualAppliances/inboundSecurityRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1593},"Microsoft.Network/networkWatchers@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1604},"Microsoft.Network/networkWatchers/packetCaptures@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1621},"Microsoft.Network/networkWatchers/connectionMonitors@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1696},"Microsoft.Network/networkWatchers/flowLogs@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1701},"Microsoft.Network/privateEndpoints@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1706},"Microsoft.Network/privateEndpoints/privateDnsZoneGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1727},"Microsoft.Network/privateLinkServices@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1732},"Microsoft.Network/privateLinkServices/privateEndpointConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1736},"Microsoft.Network/publicIPPrefixes@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1760},"Microsoft.Network/routeFilters@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1787},"Microsoft.Network/routeFilters/routeFilterRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1791},"Microsoft.Network/routeTables@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1796},"Microsoft.Network/routeTables/routes@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1800},"Microsoft.Network/securityPartnerProviders@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1820},"Microsoft.Network/serviceEndpointPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1825},"Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1829},"Microsoft.Network/virtualNetworks@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1868},"Microsoft.Network/virtualNetworks/subnets@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1872},"Microsoft.Network/virtualNetworks/virtualNetworkPeerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":1876},"Microsoft.Network/virtualNetworkGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2051},"Microsoft.Network/connections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2105},"Microsoft.Network/localNetworkGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2110},"Microsoft.Network/virtualNetworkGateways/natRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2114},"Microsoft.Network/virtualNetworkTaps@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2119},"Microsoft.Network/virtualRouters@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2132},"Microsoft.Network/virtualRouters/peerings@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2142},"Microsoft.Network/virtualWans@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2160},"Microsoft.Network/vpnSites@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2184},"Microsoft.Network/vpnServerConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2256},"Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2260},"Microsoft.Network/virtualHubs@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2304},"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2314},"Microsoft.Network/vpnGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2387},"Microsoft.Network/vpnGateways/vpnConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2391},"Microsoft.Network/vpnGateways/natRules@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2395},"Microsoft.Network/p2svpnGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2400},"Microsoft.Network/virtualHubs/routeTables@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2404},"Microsoft.Network/expressRouteGateways@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2427},"Microsoft.Network/expressRouteGateways/expressRouteConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2431},"Microsoft.Network/virtualHubs/bgpConnections@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2446},"Microsoft.Network/virtualHubs/ipConfigurations@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2459},"Microsoft.Network/virtualHubs/hubRouteTables@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2475},"Microsoft.Network/virtualHubs/routingIntent@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2488},"Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies@2021-08-01":{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2595},"Microsoft.Network/networkManagers@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":41},"Microsoft.Network/networkManagers/connectivityConfigurations@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":73},"Microsoft.Network/networkManagers/networkGroups@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":83},"Microsoft.Network/networkManagers/networkGroups/staticMembers@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":88},"Microsoft.Network/networkManagers/securityUserConfigurations@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":101},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":113},"Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":165},"Microsoft.Network/networkManagers/securityAdminConfigurations@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":179},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":190},"Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":246},"Microsoft.Network/networkManagerConnections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":257},"Microsoft.Network/networkManagers/scopeConnections@2022-02-01-preview":{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":268},"Microsoft.NotificationHubs/namespaces@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":16},"Microsoft.NotificationHubs/namespaces/AuthorizationRules@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":26},"Microsoft.NotificationHubs/namespaces/notificationHubs@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":45},"Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules@2014-09-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":49},"Microsoft.NotificationHubs/namespaces@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":21},"Microsoft.NotificationHubs/namespaces/AuthorizationRules@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":32},"Microsoft.NotificationHubs/namespaces/notificationHubs@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":51},"Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules@2016-03-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":56},"Microsoft.NotificationHubs/namespaces@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":21},"Microsoft.NotificationHubs/namespaces/AuthorizationRules@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":32},"Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":51},"Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules@2017-04-01":{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":56},"Microsoft.OpenEnergyPlatform/energyServices@2021-06-01-preview":{"RelativePath":"oep/microsoft.openenergyplatform/2021-06-01-preview/types.json","Index":34},"Microsoft.OperationalInsights/workspaces/storageInsightConfigs@2015-03-20":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-03-20/types.json","Index":20},"Microsoft.OperationalInsights/workspaces/savedSearches@2015-03-20":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-03-20/types.json","Index":27},"Microsoft.OperationalInsights/workspaces/linkedServices@2015-11-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.json","Index":12},"Microsoft.OperationalInsights/workspaces/dataSources@2015-11-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.json","Index":33},"Microsoft.OperationalInsights/workspaces@2015-11-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.json","Index":55},"Microsoft.OperationalInsights/clusters@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":28},"Microsoft.OperationalInsights/workspaces/linkedServices@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":33},"Microsoft.OperationalInsights/workspaces/dataExports@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":44},"Microsoft.OperationalInsights/workspaces/linkedStorageAccounts@2019-08-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.json","Index":56},"Microsoft.OperationalInsights/queryPacks@2019-09-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.json","Index":13},"Microsoft.OperationalInsights/queryPacks/queries@2019-09-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.json","Index":35},"Microsoft.OperationalInsights/queryPacks@2019-09-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01/types.json","Index":13},"Microsoft.OperationalInsights/queryPacks/queries@2019-09-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2019-09-01/types.json","Index":35},"Microsoft.OperationalInsights/workspaces/dataExports@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":18},"Microsoft.OperationalInsights/workspaces/dataSources@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":57},"Microsoft.OperationalInsights/workspaces/linkedServices@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":68},"Microsoft.OperationalInsights/workspaces/linkedStorageAccounts@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":86},"Microsoft.OperationalInsights/workspaces@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":125},"Microsoft.OperationalInsights/clusters@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":147},"Microsoft.OperationalInsights/workspaces/storageInsightConfigs@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":160},"Microsoft.OperationalInsights/workspaces/savedSearches@2020-03-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.json","Index":167},"Microsoft.OperationalInsights/workspaces/dataExports@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":18},"Microsoft.OperationalInsights/workspaces/dataSources@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":57},"Microsoft.OperationalInsights/workspaces/linkedServices@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":68},"Microsoft.OperationalInsights/workspaces/linkedStorageAccounts@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":84},"Microsoft.OperationalInsights/workspaces/storageInsightConfigs@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":97},"Microsoft.OperationalInsights/workspaces/savedSearches@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":104},"Microsoft.OperationalInsights/workspaces@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":145},"Microsoft.OperationalInsights/clusters@2020-08-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-08-01/types.json","Index":167},"Microsoft.OperationalInsights/clusters@2020-10-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-10-01/types.json","Index":38},"Microsoft.OperationalInsights/workspaces@2020-10-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2020-10-01/types.json","Index":79},"Microsoft.OperationalInsights/clusters@2021-06-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-06-01/types.json","Index":38},"Microsoft.OperationalInsights/workspaces@2021-06-01":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-06-01/types.json","Index":79},"Microsoft.OperationalInsights/workspaces@2021-12-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.json","Index":59},"Microsoft.OperationalInsights/workspaces/tables@2021-12-01-preview":{"RelativePath":"operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.json","Index":107},"Microsoft.OperationsManagement/solutions@2015-11-01-preview":{"RelativePath":"operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.json","Index":16},"Microsoft.OperationsManagement/ManagementAssociations@2015-11-01-preview":{"RelativePath":"operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.json","Index":21},"Microsoft.OperationsManagement/ManagementConfigurations@2015-11-01-preview":{"RelativePath":"operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.json","Index":28},"Microsoft.Orbital/spacecrafts@2021-04-04-preview":{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":39},"Microsoft.Orbital/spacecrafts/contacts@2021-04-04-preview":{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":51},"Microsoft.Orbital/contactProfiles@2021-04-04-preview":{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":78},"Microsoft.Orbital/spacecrafts@2022-03-01":{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":43},"Microsoft.Orbital/spacecrafts/contacts@2022-03-01":{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":68},"Microsoft.Orbital/contactProfiles@2022-03-01":{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":102},"Microsoft.Peering/peerAsns@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":20},"Microsoft.Peering/peerings@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":110},"Microsoft.Peering/peeringServices/prefixes@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":131},"Microsoft.Peering/peeringServices@2019-08-01-preview":{"RelativePath":"peering/microsoft.peering/2019-08-01-preview/types.json","Index":142},"Microsoft.Peering/peerAsns@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":20},"Microsoft.Peering/peerings@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":110},"Microsoft.Peering/peeringServices/prefixes@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":134},"Microsoft.Peering/peeringServices@2019-09-01-preview":{"RelativePath":"peering/microsoft.peering/2019-09-01-preview/types.json","Index":145},"Microsoft.Peering/peerAsns@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":25},"Microsoft.Peering/peerings/registeredAsns@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":35},"Microsoft.Peering/peerings/registeredPrefixes@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":53},"Microsoft.Peering/peerings@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":138},"Microsoft.Peering/peeringServices/prefixes@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":162},"Microsoft.Peering/peeringServices@2020-01-01-preview":{"RelativePath":"peering/microsoft.peering/2020-01-01-preview/types.json","Index":174},"Microsoft.Peering/peerAsns@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":54},"Microsoft.Peering/peerings@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":139},"Microsoft.Peering/peeringServices/prefixes@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":163},"Microsoft.Peering/peeringServices@2020-04-01":{"RelativePath":"peering/microsoft.peering/2020-04-01/types.json","Index":175},"Microsoft.Peering/peerAsns@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":54},"Microsoft.Peering/peerings@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":139},"Microsoft.Peering/peeringServices/prefixes@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":163},"Microsoft.Peering/peeringServices@2020-10-01":{"RelativePath":"peering/microsoft.peering/2020-10-01/types.json","Index":175},"Microsoft.Peering/peerAsns@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":54},"Microsoft.Peering/peerings@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":140},"Microsoft.Peering/peeringServices/prefixes@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":164},"Microsoft.Peering/peeringServices@2021-01-01":{"RelativePath":"peering/microsoft.peering/2021-01-01/types.json","Index":176},"Microsoft.Peering/peerAsns@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":54},"Microsoft.Peering/peerings@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":140},"Microsoft.Peering/peeringServices/connectionMonitorTests@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":151},"Microsoft.Peering/peeringServices/prefixes@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":175},"Microsoft.Peering/peeringServices@2021-06-01":{"RelativePath":"peering/microsoft.peering/2021-06-01/types.json","Index":189},"Microsoft.Peering/peerAsns@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":26},"Microsoft.Peering/peerings/registeredAsns@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":36},"Microsoft.Peering/peerings/registeredPrefixes@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":54},"Microsoft.Peering/peerings@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":141},"Microsoft.Peering/peeringServices/connectionMonitorTests@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":152},"Microsoft.Peering/peeringServices/prefixes@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":176},"Microsoft.Peering/peeringServices@2022-01-01":{"RelativePath":"peering/microsoft.peering/2022-01-01/types.json","Index":190},"Microsoft.PolicyInsights/remediations@2018-07-01-preview":{"RelativePath":"policyinsights/microsoft.policyinsights/2018-07-01-preview/types.json","Index":15},"Microsoft.PolicyInsights/remediations@2019-07-01":{"RelativePath":"policyinsights/microsoft.policyinsights/2019-07-01/types.json","Index":18},"Microsoft.PolicyInsights/attestations@2021-01-01":{"RelativePath":"policyinsights/microsoft.policyinsights/2021-01-01/types.json","Index":29},"Microsoft.PolicyInsights/remediations@2021-10-01":{"RelativePath":"policyinsights/microsoft.policyinsights/2021-10-01/types.json","Index":30},"Microsoft.Portal/dashboards@2015-08-01-preview":{"RelativePath":"portal/microsoft.portal/2015-08-01-preview/types.json","Index":22},"Microsoft.Portal/dashboards@2018-10-01-preview":{"RelativePath":"portal/microsoft.portal/2018-10-01-preview/types.json","Index":22},"Microsoft.Portal/dashboards@2019-01-01-preview":{"RelativePath":"portal/microsoft.portal/2019-01-01-preview/types.json","Index":22},"Microsoft.Portal/tenantConfigurations@2019-01-01-preview":{"RelativePath":"portal/microsoft.portal/2019-01-01-preview/types.json","Index":29},"Microsoft.Portal/dashboards@2020-09-01-preview":{"RelativePath":"portal/microsoft.portal/2020-09-01-preview/types.json","Index":28},"Microsoft.Portal/tenantConfigurations@2020-09-01-preview":{"RelativePath":"portal/microsoft.portal/2020-09-01-preview/types.json","Index":35},"Microsoft.DBforPostgreSQL/servers@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":80},"Microsoft.DBforPostgreSQL/servers/firewallRules@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":85},"Microsoft.DBforPostgreSQL/servers/virtualNetworkRules@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":96},"Microsoft.DBforPostgreSQL/servers/databases@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":101},"Microsoft.DBforPostgreSQL/servers/configurations@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":106},"Microsoft.DBforPostgreSQL/servers/administrators@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":113},"Microsoft.DBforPostgreSQL/servers/securityAlertPolicies@2017-12-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.json","Index":125},"Microsoft.DBforPostgreSQL/servers@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":80},"Microsoft.DBforPostgreSQL/servers/firewallRules@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":85},"Microsoft.DBforPostgreSQL/servers/virtualNetworkRules@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":96},"Microsoft.DBforPostgreSQL/servers/databases@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":101},"Microsoft.DBforPostgreSQL/servers/configurations@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":106},"Microsoft.DBforPostgreSQL/servers/administrators@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":113},"Microsoft.DBforPostgreSQL/servers/securityAlertPolicies@2017-12-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2017-12-01/types.json","Index":125},"Microsoft.DBforPostgreSQL/servers/privateEndpointConnections@2018-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2018-06-01/types.json","Index":14},"Microsoft.DBforPostgreSQL/servers/keys@2020-01-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-01-01/types.json","Index":14},"Microsoft.DBForPostgreSql/flexibleServers@2020-02-14-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.json","Index":55},"Microsoft.DBForPostgreSql/flexibleServers/firewallRules@2020-02-14-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.json","Index":60},"Microsoft.DBForPostgreSql/flexibleServers/databases@2020-11-05-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2020-11-05-preview/types.json","Index":12},"Microsoft.DBforPostgreSQL/flexibleServers@2021-06-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.json","Index":67},"Microsoft.DBforPostgreSQL/flexibleServers/firewallRules@2021-06-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.json","Index":72},"Microsoft.DBforPostgreSQL/flexibleServers/configurations@2021-06-01-preview":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.json","Index":82},"Microsoft.DBforPostgreSQL/flexibleServers@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":67},"Microsoft.DBforPostgreSQL/flexibleServers/firewallRules@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":72},"Microsoft.DBforPostgreSQL/flexibleServers/configurations@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":82},"Microsoft.DBforPostgreSQL/flexibleServers/databases@2021-06-01":{"RelativePath":"postgresql/microsoft.dbforpostgresql/2021-06-01/types.json","Index":87},"Microsoft.PowerBIDedicated/capacities@2017-10-01":{"RelativePath":"powerbidedicated/microsoft.powerbidedicated/2017-10-01/types.json","Index":44},"Microsoft.PowerBIDedicated/capacities@2021-01-01":{"RelativePath":"powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.json","Index":60},"Microsoft.PowerBIDedicated/autoScaleVCores@2021-01-01":{"RelativePath":"powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.json","Index":71},"Microsoft.PowerBI/workspaceCollections@2016-01-29":{"RelativePath":"powerbiembedded/microsoft.powerbi/2016-01-29/types.json","Index":17},"Microsoft.PowerBI/privateLinkServicesForPowerBI@2020-06-01":{"RelativePath":"powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.json","Index":41},"Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections@2020-06-01":{"RelativePath":"powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.json","Index":45},"Microsoft.PowerPlatform/accounts@2020-10-30-preview":{"RelativePath":"powerplatform/microsoft.powerplatform/2020-10-30-preview/types.json","Index":24},"Microsoft.PowerPlatform/enterprisePolicies@2020-10-30-preview":{"RelativePath":"powerplatform/microsoft.powerplatform/2020-10-30-preview/types.json","Index":56},"Microsoft.PowerPlatform/enterprisePolicies/privateEndpointConnections@2020-10-30-preview":{"RelativePath":"powerplatform/microsoft.powerplatform/2020-10-30-preview/types.json","Index":72},"Microsoft.Network/privateDnsZones@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":20},"Microsoft.Network/privateDnsZones/virtualNetworkLinks@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":37},"Microsoft.Network/privateDnsZones/A@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":58},"Microsoft.Network/privateDnsZones/AAAA@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":62},"Microsoft.Network/privateDnsZones/CNAME@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":66},"Microsoft.Network/privateDnsZones/MX@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":70},"Microsoft.Network/privateDnsZones/PTR@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":74},"Microsoft.Network/privateDnsZones/SOA@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":78},"Microsoft.Network/privateDnsZones/SRV@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":82},"Microsoft.Network/privateDnsZones/TXT@2018-09-01":{"RelativePath":"privatedns/microsoft.network/2018-09-01/types.json","Index":86},"Microsoft.Network/privateDnsZones@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":20},"Microsoft.Network/privateDnsZones/virtualNetworkLinks@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":37},"Microsoft.Network/privateDnsZones/A@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":58},"Microsoft.Network/privateDnsZones/AAAA@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":62},"Microsoft.Network/privateDnsZones/CNAME@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":66},"Microsoft.Network/privateDnsZones/MX@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":70},"Microsoft.Network/privateDnsZones/PTR@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":74},"Microsoft.Network/privateDnsZones/SOA@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":78},"Microsoft.Network/privateDnsZones/SRV@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":82},"Microsoft.Network/privateDnsZones/TXT@2020-01-01":{"RelativePath":"privatedns/microsoft.network/2020-01-01/types.json","Index":86},"Microsoft.Network/privateDnsZones@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":20},"Microsoft.Network/privateDnsZones/virtualNetworkLinks@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":37},"Microsoft.Network/privateDnsZones/A@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":58},"Microsoft.Network/privateDnsZones/AAAA@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":62},"Microsoft.Network/privateDnsZones/CNAME@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":66},"Microsoft.Network/privateDnsZones/MX@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":70},"Microsoft.Network/privateDnsZones/PTR@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":74},"Microsoft.Network/privateDnsZones/SOA@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":78},"Microsoft.Network/privateDnsZones/SRV@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":82},"Microsoft.Network/privateDnsZones/TXT@2020-06-01":{"RelativePath":"privatedns/microsoft.network/2020-06-01/types.json","Index":86},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":285},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":337},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":367},"Microsoft.ProviderHub/providerRegistrations/operations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":382},"Microsoft.ProviderHub/providerRegistrations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":386},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":390},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":435},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":439},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":443},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2020-11-20":{"RelativePath":"providerhub/microsoft.providerhub/2020-11-20/types.json","Index":447},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":292},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":345},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":375},"Microsoft.ProviderHub/providerRegistrations/operations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":390},"Microsoft.ProviderHub/providerRegistrations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":394},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":398},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":443},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":447},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":451},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-05-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-05-01-preview/types.json","Index":455},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":318},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":371},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":401},"Microsoft.ProviderHub/providerRegistrations/operations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":435},"Microsoft.ProviderHub/providerRegistrations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":439},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":443},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":488},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":492},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":496},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-06-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-06-01-preview/types.json","Index":500},"Microsoft.ProviderHub/providerRegistrations/customRollouts@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":328},"Microsoft.ProviderHub/providerRegistrations/defaultRollouts@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":381},"Microsoft.ProviderHub/providerRegistrations/notificationRegistrations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":411},"Microsoft.ProviderHub/providerRegistrations/operations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":445},"Microsoft.ProviderHub/providerRegistrations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":449},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":453},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":498},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":502},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":506},"Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/resourcetypeRegistrations/skus@2021-09-01-preview":{"RelativePath":"providerhub/microsoft.providerhub/2021-09-01-preview/types.json","Index":510},"Microsoft.Purview/accounts@2020-12-01-preview":{"RelativePath":"purview/microsoft.purview/2020-12-01-preview/types.json","Index":58},"Microsoft.Purview/accounts/privateEndpointConnections@2020-12-01-preview":{"RelativePath":"purview/microsoft.purview/2020-12-01-preview/types.json","Index":62},"Microsoft.Purview/accounts@2021-07-01":{"RelativePath":"purview/microsoft.purview/2021-07-01/types.json","Index":62},"Microsoft.Purview/accounts/privateEndpointConnections@2021-07-01":{"RelativePath":"purview/microsoft.purview/2021-07-01/types.json","Index":66},"Microsoft.Quantum/workspaces@2019-11-04-preview":{"RelativePath":"quantum/microsoft.quantum/2019-11-04-preview/types.json","Index":48},"Microsoft.Quantum/workspaces@2022-01-10-preview":{"RelativePath":"quantum/microsoft.quantum/2022-01-10-preview/types.json","Index":48},"Microsoft.Quota/quotas@2021-03-15-preview":{"RelativePath":"quota/microsoft.quota/2021-03-15-preview/types.json","Index":19},"Microsoft.Quota/quotaLimits@2021-03-15":{"RelativePath":"quota/microsoft.quota/2021-03-15/types.json","Index":19},"Microsoft.RecommendationsService/accounts@2022-02-01":{"RelativePath":"recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.json","Index":38},"Microsoft.RecommendationsService/accounts/modeling@2022-02-01":{"RelativePath":"recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.json","Index":57},"Microsoft.RecommendationsService/accounts/serviceEndpoints@2022-02-01":{"RelativePath":"recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.json","Index":63},"Microsoft.RecoveryServices/vaults/certificates@2016-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2016-06-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2016-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2016-06-01/types.json","Index":62},"Microsoft.RecoveryServices/vaults/extendedInformation@2016-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2016-06-01/types.json","Index":68},"Microsoft.RecoveryServices/vaults/certificates@2020-02-02":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-02-02/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2020-02-02":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-02-02/types.json","Index":72},"Microsoft.RecoveryServices/vaults/extendedInformation@2020-02-02":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-02-02/types.json","Index":78},"Microsoft.RecoveryServices/vaults/certificates@2020-10-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-10-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2020-10-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-10-01/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2020-10-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2020-10-01/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-01-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-01-01/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-01-01/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-02-10":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-02-10/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-02-10":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-02-10/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-02-10":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-02-10/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-03-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-03-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-03-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-03-01/types.json","Index":83},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-03-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-03-01/types.json","Index":89},"Microsoft.RecoveryServices/vaults/certificates@2021-04-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-04-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-04-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-04-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-04-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-04-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-06-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-06-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-06-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-06-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-07-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-07-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-07-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-07-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-07-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-07-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-08-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-08-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-08-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-08-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-08-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-08-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2021-11-01-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-11-01-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-11-01-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.json","Index":105},"Microsoft.RecoveryServices/vaults/certificates@2021-12-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-12-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2021-12-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-12-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/extendedInformation@2021-12-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2021-12-01/types.json","Index":101},"Microsoft.RecoveryServices/vaults/certificates@2022-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2022-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-01/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2022-01-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-01/types.json","Index":105},"Microsoft.RecoveryServices/vaults/certificates@2022-01-31-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2022-01-31-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2022-01-31-preview":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.json","Index":105},"Microsoft.RecoveryServices/vaults/certificates@2022-02-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-02-01/types.json","Index":18},"Microsoft.RecoveryServices/vaults@2022-02-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-02-01/types.json","Index":99},"Microsoft.RecoveryServices/vaults/extendedInformation@2022-02-01":{"RelativePath":"recoveryservices/microsoft.recoveryservices/2022-02-01/types.json","Index":105},"Microsoft.RecoveryServices/vaults/backupPolicies@2016-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.json","Index":110},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2016-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.json","Index":149},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2016-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.json","Index":65},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2016-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.json","Index":84},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2017-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2017-07-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2018-12-20":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2018-12-20/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2019-05-13":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.json","Index":102},"Microsoft.RecoveryServices/vaults/backupPolicies@2019-05-13":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.json","Index":256},"Microsoft.RecoveryServices/vaults/backupconfig@2019-06-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.json","Index":34},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2019-06-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.json","Index":136},"Microsoft.RecoveryServices/vaults/backupPolicies@2019-06-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.json","Index":291},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2020-02-02":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-02-02/types.json","Index":25},"Microsoft.RecoveryServices/vaults/backupconfig@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":60},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":78},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":180},"Microsoft.RecoveryServices/vaults/backupPolicies@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":336},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2020-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.json","Index":394},"Microsoft.RecoveryServices/vaults/backupconfig@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":60},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":78},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":180},"Microsoft.RecoveryServices/vaults/backupPolicies@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":336},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2020-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.json","Index":394},"Microsoft.RecoveryServices/vaults/backupconfig@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":60},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":78},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":180},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":336},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.json","Index":394},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":73},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":95},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":113},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":215},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":371},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":429},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-02-01-preview":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.json","Index":437},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":94},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":112},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":214},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":370},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.json","Index":428},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":94},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":112},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":214},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":370},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-02-10":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.json","Index":428},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":94},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":112},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":214},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":370},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-03-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.json","Index":428},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":64},"Microsoft.RecoveryServices/vaults/backupconfig@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":95},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":119},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":137},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":239},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":395},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-04-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.json","Index":453},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":41},"Microsoft.RecoveryServices/vaults/backupconfig@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":72},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":96},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":114},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":216},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":372},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-06-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.json","Index":430},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":64},"Microsoft.RecoveryServices/vaults/backupconfig@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":96},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":120},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":138},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":241},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":398},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":456},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-07-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.json","Index":464},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":64},"Microsoft.RecoveryServices/vaults/backupconfig@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":96},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":120},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":138},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":241},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":398},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":456},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-08-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.json","Index":464},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":410},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":471},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-10-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.json","Index":479},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-11-15":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-11-15/types.json","Index":30},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":448},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":509},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2021-12-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.json","Index":517},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":434},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":495},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2022-01-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.json","Index":503},"Microsoft.RecoveryServices/vaults/backupstorageconfig@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":38},"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":74},"Microsoft.RecoveryServices/vaults/backupconfig@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":106},"Microsoft.RecoveryServices/vaults/backupEncryptionConfigs@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":130},"Microsoft.RecoveryServices/vaults/privateEndpointConnections@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":148},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":251},"Microsoft.RecoveryServices/vaults/backupPolicies@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":434},"Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":495},"Microsoft.RecoveryServices/vaults/backupResourceGuardProxies@2022-02-01":{"RelativePath":"recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.json","Index":503},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":85},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":104},"Microsoft.RecoveryServices/vaults/replicationFabrics@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":136},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":141},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":146},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":200},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":210},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":218},"Microsoft.RecoveryServices/vaults/replicationPolicies@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":272},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2016-08-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.json","Index":278},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":57},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":76},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":88},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":156},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":237},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":259},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":268},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":273},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationPolicies@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":333},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2018-01-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.json","Index":387},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":125},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":144},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":156},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":214},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":384},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":406},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":453},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":461},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":466},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":472},"Microsoft.RecoveryServices/vaults/replicationPolicies@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":530},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":592},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2018-07-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.json","Index":597},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":166},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":185},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":199},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":276},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":551},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":575},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":583},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":588},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":594},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":651},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":695},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":758},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-02-10":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.json","Index":763},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":125},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":144},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":156},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":214},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":384},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":406},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":453},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":461},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":466},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":472},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":530},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":592},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-03-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.json","Index":597},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":166},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":185},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":199},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":276},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":551},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":575},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":583},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":588},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":594},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":651},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":695},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":758},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-04-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.json","Index":763},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":589},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":596},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":601},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":664},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":708},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":771},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-06-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.json","Index":776},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":589},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":596},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":601},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":664},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":708},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":771},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-07-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.json","Index":776},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":595},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":602},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":613},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":670},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":720},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":783},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-08-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.json","Index":788},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":169},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":188},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":202},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":279},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":565},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":595},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":602},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":613},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":670},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":720},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":783},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-10-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.json","Index":788},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":283},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":577},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":614},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":619},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":625},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":682},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":732},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":795},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-11-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.json","Index":800},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":283},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":577},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":607},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":614},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":619},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":625},"Microsoft.RecoveryServices/vaults/replicationPolicies@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":682},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":732},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":795},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2021-12-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.json","Index":800},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":286},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":580},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":610},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":617},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":622},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":628},"Microsoft.RecoveryServices/vaults/replicationPolicies@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":685},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":735},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":798},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2022-01-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.json","Index":803},"Microsoft.RecoveryServices/vaults/replicationAlertSettings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":13},"Microsoft.RecoveryServices/vaults/replicationFabrics@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":173},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":192},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":206},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":286},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":580},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":610},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":617},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":622},"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":628},"Microsoft.RecoveryServices/vaults/replicationPolicies@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":685},"Microsoft.RecoveryServices/vaults/replicationProtectionIntents@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":735},"Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":798},"Microsoft.RecoveryServices/vaults/replicationVaultSettings@2022-02-01":{"RelativePath":"recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.json","Index":803},"Microsoft.RedHatOpenShift/openShiftClusters@2020-04-30":{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.json","Index":44},"Microsoft.RedHatOpenShift/openShiftClusters@2021-09-01-preview":{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.json","Index":104},"Microsoft.RedHatOpenShift/openShiftClusters@2022-04-01":{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.json","Index":56},"Microsoft.Cache/Redis@2015-08-01":{"RelativePath":"redis/microsoft.cache/2015-08-01/types.json","Index":23},"Microsoft.Cache/Redis@2016-04-01":{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":24},"Microsoft.Cache/Redis/firewallRules@2016-04-01":{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":29},"Microsoft.Cache/Redis/patchSchedules@2016-04-01":{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":47},"Microsoft.Cache/Redis@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":27},"Microsoft.Cache/Redis/firewallRules@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":32},"Microsoft.Cache/Redis/patchSchedules@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":50},"Microsoft.Cache/Redis/linkedServers@2017-02-01":{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":58},"Microsoft.Cache/Redis@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":27},"Microsoft.Cache/Redis/firewallRules@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":32},"Microsoft.Cache/Redis/patchSchedules@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":51},"Microsoft.Cache/Redis/linkedServers@2017-10-01":{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":59},"Microsoft.Cache/Redis@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":44},"Microsoft.Cache/Redis/firewallRules@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":49},"Microsoft.Cache/Redis/patchSchedules@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":68},"Microsoft.Cache/Redis/linkedServers@2018-03-01":{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":76},"Microsoft.Cache/Redis@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":46},"Microsoft.Cache/Redis/firewallRules@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":51},"Microsoft.Cache/Redis/patchSchedules@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":70},"Microsoft.Cache/Redis/linkedServers@2019-07-01":{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":78},"Microsoft.Cache/redis@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":63},"Microsoft.Cache/redis/firewallRules@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":68},"Microsoft.Cache/redis/patchSchedules@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":87},"Microsoft.Cache/redis/linkedServers@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":95},"Microsoft.Cache/redis/privateEndpointConnections@2020-06-01":{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":99},"Microsoft.Cache/redis@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":63},"Microsoft.Cache/redis/firewallRules@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":68},"Microsoft.Cache/redis/patchSchedules@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":87},"Microsoft.Cache/redis/linkedServers@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":95},"Microsoft.Cache/redis/privateEndpointConnections@2020-12-01":{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":99},"Microsoft.Cache/redis@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":71},"Microsoft.Cache/redis/firewallRules@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":76},"Microsoft.Cache/redis/patchSchedules@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":95},"Microsoft.Cache/redis/linkedServers@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":103},"Microsoft.Cache/redis/privateEndpointConnections@2021-06-01":{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":107},"Microsoft.Cache/redisEnterprise@2020-10-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":57},"Microsoft.Cache/redisEnterprise/databases@2020-10-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":99},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2020-10-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":103},"Microsoft.Cache/redisEnterprise@2021-02-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2021-02-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":120},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":124},"Microsoft.Cache/redisEnterprise@2021-03-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2021-03-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":111},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2021-03-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":115},"Microsoft.Cache/redisEnterprise@2021-08-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2021-08-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":111},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2021-08-01":{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":115},"Microsoft.Cache/redisEnterprise@2022-01-01":{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":61},"Microsoft.Cache/redisEnterprise/databases@2022-01-01":{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":120},"Microsoft.Cache/redisEnterprise/privateEndpointConnections@2022-01-01":{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":124},"Microsoft.Relay/namespaces@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":18},"Microsoft.Relay/namespaces/AuthorizationRules@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":28},"Microsoft.Relay/namespaces/HybridConnections@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":33},"Microsoft.Relay/namespaces/HybridConnections/authorizationRules@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":37},"Microsoft.Relay/namespaces/WcfRelays@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":45},"Microsoft.Relay/namespaces/WcfRelays/authorizationRules@2016-07-01":{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":49},"Microsoft.Relay/namespaces@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":23},"Microsoft.Relay/namespaces/authorizationRules@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":33},"Microsoft.Relay/namespaces/hybridConnections@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":38},"Microsoft.Relay/namespaces/hybridConnections/authorizationRules@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":42},"Microsoft.Relay/namespaces/wcfRelays@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":50},"Microsoft.Relay/namespaces/wcfRelays/authorizationRules@2017-04-01":{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":54},"Microsoft.Relay/namespaces@2018-01-01-preview":{"RelativePath":"relay/microsoft.relay/2018-01-01-preview/types.json","Index":25},"Microsoft.Relay/namespaces/networkRuleSets@2018-01-01-preview":{"RelativePath":"relay/microsoft.relay/2018-01-01-preview/types.json","Index":38},"Microsoft.Relay/namespaces/privateEndpointConnections@2018-01-01-preview":{"RelativePath":"relay/microsoft.relay/2018-01-01-preview/types.json","Index":59},"Microsoft.Relay/namespaces/authorizationRules@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":28},"Microsoft.Relay/namespaces@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":60},"Microsoft.Relay/namespaces/networkRuleSets@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":73},"Microsoft.Relay/namespaces/hybridConnections/authorizationRules@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":77},"Microsoft.Relay/namespaces/hybridConnections@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":82},"Microsoft.Relay/namespaces/wcfRelays/authorizationRules@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":86},"Microsoft.Relay/namespaces/wcfRelays@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":94},"Microsoft.Relay/namespaces/privateEndpointConnections@2021-11-01":{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":98},"Microsoft.Capacity/reservationOrders@2019-04-01":{"RelativePath":"reservations/microsoft.capacity/2019-04-01/types.json","Index":118},"Microsoft.Capacity/resourceProviders/locations/serviceLimits@2019-07-19-preview":{"RelativePath":"reservations/microsoft.capacity/2019-07-19-preview/types.json","Index":19},"Microsoft.Capacity/reservationOrders@2020-10-01-preview":{"RelativePath":"reservations/microsoft.capacity/2020-10-01-preview/types.json","Index":113},"Microsoft.Capacity/resourceProviders/locations/serviceLimits@2020-10-25":{"RelativePath":"reservations/microsoft.capacity/2020-10-25/types.json","Index":19},"Microsoft.Capacity/reservationOrders@2021-07-01":{"RelativePath":"reservations/microsoft.capacity/2021-07-01/types.json","Index":169},"Microsoft.Capacity/reservationOrders@2022-03-01":{"RelativePath":"reservations/microsoft.capacity/2022-03-01/types.json","Index":171},"Microsoft.ResourceConnector/appliances@2021-10-31-preview":{"RelativePath":"resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.json","Index":40},"Microsoft.ResourceGraph/queries@2018-09-01-preview":{"RelativePath":"resourcegraph/microsoft.resourcegraph/2018-09-01-preview/types.json","Index":15},"Microsoft.Migrate/moveCollections@2019-10-01-preview":{"RelativePath":"resourcemover/microsoft.migrate/2019-10-01-preview/types.json","Index":26},"Microsoft.Migrate/moveCollections/moveResources@2019-10-01-preview":{"RelativePath":"resourcemover/microsoft.migrate/2019-10-01-preview/types.json","Index":127},"Microsoft.Migrate/moveCollections@2021-01-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-01-01/types.json","Index":26},"Microsoft.Migrate/moveCollections/moveResources@2021-01-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-01-01/types.json","Index":127},"Microsoft.Migrate/moveCollections@2021-08-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-08-01/types.json","Index":37},"Microsoft.Migrate/moveCollections/moveResources@2021-08-01":{"RelativePath":"resourcemover/microsoft.migrate/2021-08-01/types.json","Index":148},"Microsoft.Authorization/locks@2015-01-01":{"RelativePath":"resources/microsoft.authorization/2015-01-01/types.json","Index":16},"Microsoft.Authorization/policyassignments@2015-10-01-preview":{"RelativePath":"resources/microsoft.authorization/2015-10-01-preview/types.json","Index":12},"Microsoft.Authorization/policydefinitions@2015-10-01-preview":{"RelativePath":"resources/microsoft.authorization/2015-10-01-preview/types.json","Index":21},"Microsoft.Authorization/policydefinitions@2015-11-01":{"RelativePath":"resources/microsoft.authorization/2015-11-01/types.json","Index":12},"Microsoft.Authorization/policyAssignments@2015-11-01":{"RelativePath":"resources/microsoft.authorization/2015-11-01/types.json","Index":17},"Microsoft.Authorization/policyassignments@2016-04-01":{"RelativePath":"resources/microsoft.authorization/2016-04-01/types.json","Index":12},"Microsoft.Authorization/policydefinitions@2016-04-01":{"RelativePath":"resources/microsoft.authorization/2016-04-01/types.json","Index":21},"Microsoft.Authorization/locks@2016-09-01":{"RelativePath":"resources/microsoft.authorization/2016-09-01/types.json","Index":18},"Microsoft.Authorization/policyDefinitions@2016-12-01":{"RelativePath":"resources/microsoft.authorization/2016-12-01/types.json","Index":20},"Microsoft.Authorization/policyAssignments@2016-12-01":{"RelativePath":"resources/microsoft.authorization/2016-12-01/types.json","Index":25},"Microsoft.Authorization/locks@2017-04-01":{"RelativePath":"resources/microsoft.authorization/2017-04-01/types.json","Index":18},"Microsoft.Authorization/policyAssignments@2017-06-01-preview":{"RelativePath":"resources/microsoft.authorization/2017-06-01-preview/types.json","Index":14},"Microsoft.Authorization/policySetDefinitions@2017-06-01-preview":{"RelativePath":"resources/microsoft.authorization/2017-06-01-preview/types.json","Index":25},"Microsoft.Authorization/policyAssignments@2018-03-01":{"RelativePath":"resources/microsoft.authorization/2018-03-01/types.json","Index":14},"Microsoft.Authorization/policyDefinitions@2018-03-01":{"RelativePath":"resources/microsoft.authorization/2018-03-01/types.json","Index":27},"Microsoft.Authorization/policySetDefinitions@2018-03-01":{"RelativePath":"resources/microsoft.authorization/2018-03-01/types.json","Index":38},"Microsoft.Authorization/policyAssignments@2018-05-01":{"RelativePath":"resources/microsoft.authorization/2018-05-01/types.json","Index":18},"Microsoft.Authorization/policyDefinitions@2018-05-01":{"RelativePath":"resources/microsoft.authorization/2018-05-01/types.json","Index":31},"Microsoft.Authorization/policySetDefinitions@2018-05-01":{"RelativePath":"resources/microsoft.authorization/2018-05-01/types.json","Index":42},"Microsoft.Authorization/policyAssignments@2019-01-01":{"RelativePath":"resources/microsoft.authorization/2019-01-01/types.json","Index":18},"Microsoft.Authorization/policyDefinitions@2019-01-01":{"RelativePath":"resources/microsoft.authorization/2019-01-01/types.json","Index":27},"Microsoft.Authorization/policySetDefinitions@2019-01-01":{"RelativePath":"resources/microsoft.authorization/2019-01-01/types.json","Index":38},"Microsoft.Authorization/policyAssignments@2019-06-01":{"RelativePath":"resources/microsoft.authorization/2019-06-01/types.json","Index":21},"Microsoft.Authorization/policyDefinitions@2019-06-01":{"RelativePath":"resources/microsoft.authorization/2019-06-01/types.json","Index":30},"Microsoft.Authorization/policySetDefinitions@2019-06-01":{"RelativePath":"resources/microsoft.authorization/2019-06-01/types.json","Index":41},"Microsoft.Authorization/policyAssignments@2019-09-01":{"RelativePath":"resources/microsoft.authorization/2019-09-01/types.json","Index":23},"Microsoft.Authorization/policyDefinitions@2019-09-01":{"RelativePath":"resources/microsoft.authorization/2019-09-01/types.json","Index":45},"Microsoft.Authorization/policySetDefinitions@2019-09-01":{"RelativePath":"resources/microsoft.authorization/2019-09-01/types.json","Index":62},"Microsoft.Authorization/policyAssignments@2020-03-01":{"RelativePath":"resources/microsoft.authorization/2020-03-01/types.json","Index":23},"Microsoft.Authorization/policyDefinitions@2020-03-01":{"RelativePath":"resources/microsoft.authorization/2020-03-01/types.json","Index":45},"Microsoft.Authorization/policySetDefinitions@2020-03-01":{"RelativePath":"resources/microsoft.authorization/2020-03-01/types.json","Index":62},"Microsoft.Authorization/privateLinkAssociations@2020-05-01":{"RelativePath":"resources/microsoft.authorization/2020-05-01/types.json","Index":15},"Microsoft.Authorization/resourceManagementPrivateLinks@2020-05-01":{"RelativePath":"resources/microsoft.authorization/2020-05-01/types.json","Index":21},"Microsoft.Authorization/locks@2020-05-01":{"RelativePath":"resources/microsoft.authorization/2020-05-01/types.json","Index":43},"Microsoft.Authorization/policyExemptions@2020-07-01-preview":{"RelativePath":"resources/microsoft.authorization/2020-07-01-preview/types.json","Index":27},"Microsoft.Authorization/policyAssignments@2020-09-01":{"RelativePath":"resources/microsoft.authorization/2020-09-01/types.json","Index":24},"Microsoft.Authorization/policyDefinitions@2020-09-01":{"RelativePath":"resources/microsoft.authorization/2020-09-01/types.json","Index":46},"Microsoft.Authorization/policySetDefinitions@2020-09-01":{"RelativePath":"resources/microsoft.authorization/2020-09-01/types.json","Index":63},"Microsoft.Authorization/policyAssignments@2021-06-01":{"RelativePath":"resources/microsoft.authorization/2021-06-01/types.json","Index":38},"Microsoft.Authorization/policyDefinitions@2021-06-01":{"RelativePath":"resources/microsoft.authorization/2021-06-01/types.json","Index":60},"Microsoft.Authorization/policySetDefinitions@2021-06-01":{"RelativePath":"resources/microsoft.authorization/2021-06-01/types.json","Index":77},"Microsoft.Features/featureProviders/subscriptionFeatureRegistrations@2021-07-01":{"RelativePath":"resources/microsoft.features/2021-07-01/types.json","Index":26},"Microsoft.Resources/deployments@2015-11-01":{"RelativePath":"resources/microsoft.resources/2015-11-01/types.json","Index":32},"Microsoft.Resources/resourceGroups@2015-11-01":{"RelativePath":"resources/microsoft.resources/2015-11-01/types.json","Index":38},"Microsoft.Resources/deployments@2016-02-01":{"RelativePath":"resources/microsoft.resources/2016-02-01/types.json","Index":38},"Microsoft.Resources/resourceGroups@2016-02-01":{"RelativePath":"resources/microsoft.resources/2016-02-01/types.json","Index":44},"Microsoft.Resources/deployments@2016-07-01":{"RelativePath":"resources/microsoft.resources/2016-07-01/types.json","Index":41},"Microsoft.Resources/resourceGroups@2016-07-01":{"RelativePath":"resources/microsoft.resources/2016-07-01/types.json","Index":47},"Microsoft.Resources/deployments@2016-09-01":{"RelativePath":"resources/microsoft.resources/2016-09-01/types.json","Index":41},"Microsoft.Resources/resourceGroups@2016-09-01":{"RelativePath":"resources/microsoft.resources/2016-09-01/types.json","Index":47},"Microsoft.Resources/deployments@2017-05-10":{"RelativePath":"resources/microsoft.resources/2017-05-10/types.json","Index":41},"Microsoft.Resources/resourceGroups@2017-05-10":{"RelativePath":"resources/microsoft.resources/2017-05-10/types.json","Index":47},"Microsoft.Resources/deployments@2018-02-01":{"RelativePath":"resources/microsoft.resources/2018-02-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2018-02-01":{"RelativePath":"resources/microsoft.resources/2018-02-01/types.json","Index":51},"Microsoft.Resources/deployments@2018-05-01":{"RelativePath":"resources/microsoft.resources/2018-05-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2018-05-01":{"RelativePath":"resources/microsoft.resources/2018-05-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-03-01":{"RelativePath":"resources/microsoft.resources/2019-03-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-03-01":{"RelativePath":"resources/microsoft.resources/2019-03-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-05-01":{"RelativePath":"resources/microsoft.resources/2019-05-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-05-01":{"RelativePath":"resources/microsoft.resources/2019-05-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-05-10":{"RelativePath":"resources/microsoft.resources/2019-05-10/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-05-10":{"RelativePath":"resources/microsoft.resources/2019-05-10/types.json","Index":51},"Microsoft.Resources/templateSpecs@2019-06-01-preview":{"RelativePath":"resources/microsoft.resources/2019-06-01-preview/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2019-06-01-preview":{"RelativePath":"resources/microsoft.resources/2019-06-01-preview/types.json","Index":36},"Microsoft.Resources/deployments@2019-07-01":{"RelativePath":"resources/microsoft.resources/2019-07-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-07-01":{"RelativePath":"resources/microsoft.resources/2019-07-01/types.json","Index":51},"Microsoft.Resources/deployments@2019-08-01":{"RelativePath":"resources/microsoft.resources/2019-08-01/types.json","Index":45},"Microsoft.Resources/resourceGroups@2019-08-01":{"RelativePath":"resources/microsoft.resources/2019-08-01/types.json","Index":51},"Microsoft.Resources/deploymentScripts@2019-10-01-preview":{"RelativePath":"resources/microsoft.resources/2019-10-01-preview/types.json","Index":70},"Microsoft.Resources/deployments@2019-10-01":{"RelativePath":"resources/microsoft.resources/2019-10-01/types.json","Index":57},"Microsoft.Resources/resourceGroups@2019-10-01":{"RelativePath":"resources/microsoft.resources/2019-10-01/types.json","Index":63},"Microsoft.Resources/tags@2019-10-01":{"RelativePath":"resources/microsoft.resources/2019-10-01/types.json","Index":70},"Microsoft.Resources/deployments@2020-06-01":{"RelativePath":"resources/microsoft.resources/2020-06-01/types.json","Index":90},"Microsoft.Resources/resourceGroups@2020-06-01":{"RelativePath":"resources/microsoft.resources/2020-06-01/types.json","Index":96},"Microsoft.Resources/tags@2020-06-01":{"RelativePath":"resources/microsoft.resources/2020-06-01/types.json","Index":103},"Microsoft.Resources/deployments@2020-08-01":{"RelativePath":"resources/microsoft.resources/2020-08-01/types.json","Index":88},"Microsoft.Resources/resourceGroups@2020-08-01":{"RelativePath":"resources/microsoft.resources/2020-08-01/types.json","Index":94},"Microsoft.Resources/tags@2020-08-01":{"RelativePath":"resources/microsoft.resources/2020-08-01/types.json","Index":101},"Microsoft.Resources/deploymentScripts@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":70},"Microsoft.Resources/deployments@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":152},"Microsoft.Resources/resourceGroups@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":158},"Microsoft.Resources/tags@2020-10-01":{"RelativePath":"resources/microsoft.resources/2020-10-01/types.json","Index":165},"Microsoft.Resources/deployments@2021-01-01":{"RelativePath":"resources/microsoft.resources/2021-01-01/types.json","Index":93},"Microsoft.Resources/resourceGroups@2021-01-01":{"RelativePath":"resources/microsoft.resources/2021-01-01/types.json","Index":99},"Microsoft.Resources/tags@2021-01-01":{"RelativePath":"resources/microsoft.resources/2021-01-01/types.json","Index":106},"Microsoft.Resources/templateSpecs@2021-03-01-preview":{"RelativePath":"resources/microsoft.resources/2021-03-01-preview/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2021-03-01-preview":{"RelativePath":"resources/microsoft.resources/2021-03-01-preview/types.json","Index":34},"Microsoft.Resources/deployments@2021-04-01":{"RelativePath":"resources/microsoft.resources/2021-04-01/types.json","Index":98},"Microsoft.Resources/resourceGroups@2021-04-01":{"RelativePath":"resources/microsoft.resources/2021-04-01/types.json","Index":104},"Microsoft.Resources/tags@2021-04-01":{"RelativePath":"resources/microsoft.resources/2021-04-01/types.json","Index":111},"Microsoft.Resources/templateSpecs@2021-05-01":{"RelativePath":"resources/microsoft.resources/2021-05-01/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2021-05-01":{"RelativePath":"resources/microsoft.resources/2021-05-01/types.json","Index":34},"Microsoft.Resources/templateSpecs@2022-02-01":{"RelativePath":"resources/microsoft.resources/2022-02-01/types.json","Index":26},"Microsoft.Resources/templateSpecs/versions@2022-02-01":{"RelativePath":"resources/microsoft.resources/2022-02-01/types.json","Index":34},"Microsoft.Solutions/appliances@2016-09-01-preview":{"RelativePath":"resources/microsoft.solutions/2016-09-01-preview/types.json","Index":29},"Microsoft.Solutions/applianceDefinitions@2016-09-01-preview":{"RelativePath":"resources/microsoft.solutions/2016-09-01-preview/types.json","Index":46},"Microsoft.Solutions/applications@2017-09-01":{"RelativePath":"resources/microsoft.solutions/2017-09-01/types.json","Index":29},"Microsoft.Solutions/applicationDefinitions@2017-09-01":{"RelativePath":"resources/microsoft.solutions/2017-09-01/types.json","Index":46},"Microsoft.Solutions/applications@2018-06-01":{"RelativePath":"resources/microsoft.solutions/2018-06-01/types.json","Index":29},"Microsoft.Solutions/applicationDefinitions@2018-06-01":{"RelativePath":"resources/microsoft.solutions/2018-06-01/types.json","Index":46},"Microsoft.Solutions/applications@2019-07-01":{"RelativePath":"resources/microsoft.solutions/2019-07-01/types.json","Index":67},"Microsoft.Solutions/applicationDefinitions@2019-07-01":{"RelativePath":"resources/microsoft.solutions/2019-07-01/types.json","Index":107},"Microsoft.Solutions/jitRequests@2019-07-01":{"RelativePath":"resources/microsoft.solutions/2019-07-01/types.json","Index":142},"Microsoft.Solutions/applications@2020-08-21-preview":{"RelativePath":"resources/microsoft.solutions/2020-08-21-preview/types.json","Index":67},"Microsoft.Solutions/applicationDefinitions@2020-08-21-preview":{"RelativePath":"resources/microsoft.solutions/2020-08-21-preview/types.json","Index":107},"Microsoft.Solutions/jitRequests@2020-08-21-preview":{"RelativePath":"resources/microsoft.solutions/2020-08-21-preview/types.json","Index":142},"Microsoft.Scheduler/jobCollections@2014-08-01-preview":{"RelativePath":"scheduler/microsoft.scheduler/2014-08-01-preview/types.json","Index":31},"Microsoft.Scheduler/jobCollections/jobs@2014-08-01-preview":{"RelativePath":"scheduler/microsoft.scheduler/2014-08-01-preview/types.json","Index":116},"Microsoft.Scheduler/jobCollections@2016-01-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-01-01/types.json","Index":31},"Microsoft.Scheduler/jobCollections/jobs@2016-01-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-01-01/types.json","Index":116},"Microsoft.Scheduler/jobCollections@2016-03-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-03-01/types.json","Index":32},"Microsoft.Scheduler/jobCollections/jobs@2016-03-01":{"RelativePath":"scheduler/microsoft.scheduler/2016-03-01/types.json","Index":118},"Microsoft.ScVmm/vmmServers@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":26},"Microsoft.ScVmm/clouds@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":35},"Microsoft.ScVmm/virtualNetworks@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":41},"Microsoft.ScVmm/virtualMachines@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":84},"Microsoft.ScVmm/virtualMachineTemplates@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":105},"Microsoft.ScVmm/availabilitySets@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":111},"Microsoft.ScVmm/vmmServers/inventoryItems@2020-06-05-preview":{"RelativePath":"scvmm/microsoft.scvmm/2020-06-05-preview/types.json","Index":134},"Microsoft.Search/searchServices@2015-02-28":{"RelativePath":"search/microsoft.search/2015-02-28/types.json","Index":18},"Microsoft.Search/searchServices@2015-08-19":{"RelativePath":"search/microsoft.search/2015-08-19/types.json","Index":40},"Microsoft.Search/searchServices@2019-10-01-preview":{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":56},"Microsoft.Search/searchServices/privateEndpointConnections@2019-10-01-preview":{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":60},"Microsoft.Search/searchServices@2020-03-13":{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":56},"Microsoft.Search/searchServices/privateEndpointConnections@2020-03-13":{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":60},"Microsoft.Search/searchServices@2020-08-01-preview":{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":70},"Microsoft.Search/searchServices/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":74},"Microsoft.Search/searchServices/sharedPrivateLinkResources@2020-08-01-preview":{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":78},"Microsoft.Search/searchServices@2020-08-01":{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":70},"Microsoft.Search/searchServices/privateEndpointConnections@2020-08-01":{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":74},"Microsoft.Search/searchServices/sharedPrivateLinkResources@2020-08-01":{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":78},"Microsoft.Search/searchServices@2021-04-01-preview":{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":98},"Microsoft.Search/searchServices/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":102},"Microsoft.Search/searchServices/sharedPrivateLinkResources@2021-04-01-preview":{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":106},"Microsoft.Security/locations/jitNetworkAccessPolicies@2015-06-01-preview":{"RelativePath":"security/microsoft.security/2015-06-01-preview/types.json","Index":35},"Microsoft.Security/locations/applicationWhitelistings@2015-06-01-preview":{"RelativePath":"security/microsoft.security/2015-06-01-preview/types.json","Index":143},"Microsoft.Security/pricings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":15},"Microsoft.Security/securityContacts@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":26},"Microsoft.Security/workspaceSettings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":31},"Microsoft.Security/autoProvisioningSettings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":39},"Microsoft.Security/advancedThreatProtectionSettings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":46},"Microsoft.Security/deviceSecurityGroups@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":137},"Microsoft.Security/settings@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":147},"Microsoft.Security/informationProtectionPolicies@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":167},"Microsoft.Security/iotSecuritySolutions@2017-08-01-preview":{"RelativePath":"security/microsoft.security/2017-08-01-preview/types.json","Index":208},"Microsoft.Security/pricings@2018-06-01":{"RelativePath":"security/microsoft.security/2018-06-01/types.json","Index":15},"Microsoft.Security/automations@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":56},"Microsoft.Security/alertsSuppressionRules@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":68},"Microsoft.Security/assessmentMetadata@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":106},"Microsoft.Security/assessments@2019-01-01-preview":{"RelativePath":"security/microsoft.security/2019-01-01-preview/types.json","Index":123},"Microsoft.Security/advancedThreatProtectionSettings@2019-01-01":{"RelativePath":"security/microsoft.security/2019-01-01/types.json","Index":13},"Microsoft.Security/settings@2019-01-01":{"RelativePath":"security/microsoft.security/2019-01-01/types.json","Index":23},"Microsoft.Security/deviceSecurityGroups@2019-08-01":{"RelativePath":"security/microsoft.security/2019-08-01/types.json","Index":100},"Microsoft.Security/iotSecuritySolutions@2019-08-01":{"RelativePath":"security/microsoft.security/2019-08-01/types.json","Index":163},"Microsoft.Security/connectors@2020-01-01-preview":{"RelativePath":"security/microsoft.security/2020-01-01-preview/types.json","Index":40},"Microsoft.Security/serverVulnerabilityAssessments@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":19},"Microsoft.Security/locations/applicationWhitelistings@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":121},"Microsoft.Security/locations/jitNetworkAccessPolicies@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":149},"Microsoft.Security/assessmentMetadata@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":189},"Microsoft.Security/assessments@2020-01-01":{"RelativePath":"security/microsoft.security/2020-01-01/types.json","Index":207},"Microsoft.Security/sqlVulnerabilityAssessments/baselineRules@2020-07-01-preview":{"RelativePath":"security/microsoft.security/2020-07-01-preview/types.json","Index":16},"Microsoft.Security/ingestionSettings@2021-01-15-preview":{"RelativePath":"security/microsoft.security/2021-01-15-preview/types.json","Index":11},"Microsoft.Security/assessmentMetadata@2021-06-01":{"RelativePath":"security/microsoft.security/2021-06-01/types.json","Index":170},"Microsoft.Security/assessments@2021-06-01":{"RelativePath":"security/microsoft.security/2021-06-01/types.json","Index":223},"Microsoft.Security/customAssessmentAutomations@2021-07-01-preview":{"RelativePath":"security/microsoft.security/2021-07-01-preview/types.json","Index":30},"Microsoft.Security/customEntityStoreAssignments@2021-07-01-preview":{"RelativePath":"security/microsoft.security/2021-07-01-preview/types.json","Index":35},"Microsoft.Security/securityConnectors@2021-07-01-preview":{"RelativePath":"security/microsoft.security/2021-07-01-preview/types.json","Index":69},"Microsoft.Security/settings@2021-07-01":{"RelativePath":"security/microsoft.security/2021-07-01/types.json","Index":22},"Microsoft.Security/standards@2021-08-01-preview":{"RelativePath":"security/microsoft.security/2021-08-01-preview/types.json","Index":30},"Microsoft.Security/assignments@2021-08-01-preview":{"RelativePath":"security/microsoft.security/2021-08-01-preview/types.json","Index":39},"Microsoft.Security/securityConnectors@2021-12-01-preview":{"RelativePath":"security/microsoft.security/2021-12-01-preview/types.json","Index":102},"Microsoft.Security/pricings@2022-03-01":{"RelativePath":"security/microsoft.security/2022-03-01/types.json","Index":15},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":68},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":72},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":81},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":85},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":94},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":98},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":107},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":111},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":120},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections@2021-01-11":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.json","Index":124},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":68},"Microsoft.SecurityAndCompliance/privateLinkServicesForEDMUpload/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":72},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":81},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365ComplianceCenter/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":85},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":94},"Microsoft.SecurityAndCompliance/privateLinkServicesForM365SecurityCenter/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":98},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":107},"Microsoft.SecurityAndCompliance/privateLinkServicesForO365ManagementActivityAPI/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":111},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":120},"Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":124},"Microsoft.SecurityAndCompliance/privateLinkServicesForMIPPolicySync@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":133},"Microsoft.SecurityAndCompliance/privateLinkServicesForMIPPolicySync/privateEndpointConnections@2021-03-08":{"RelativePath":"securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.json","Index":137},"Microsoft.SecurityInsights/automationRules@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":119},"Microsoft.SecurityInsights/bookmarks@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":132},"Microsoft.SecurityInsights/bookmarks/relations@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":137},"Microsoft.SecurityInsights/cases@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":178},"Microsoft.SecurityInsights/cases/comments@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":183},"Microsoft.SecurityInsights/cases/relations@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":195},"Microsoft.SecurityInsights/alertRules@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":205},"Microsoft.SecurityInsights/alertRules/actions@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":221},"Microsoft.SecurityInsights/dataConnectors@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":239},"Microsoft.SecurityInsights/settings@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":248},"Microsoft.SecurityInsights/incidents@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":291},"Microsoft.SecurityInsights/incidents/comments@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":296},"Microsoft.SecurityInsights/incidents/relations@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":300},"Microsoft.SecurityInsights/watchlists@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":309},"Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":314},"Microsoft.SecurityInsights/threatIntelligence/indicators@2019-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json","Index":340},"Microsoft.SecurityInsights/alertRules@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":77},"Microsoft.SecurityInsights/alertRules/actions@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":82},"Microsoft.SecurityInsights/bookmarks@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":95},"Microsoft.SecurityInsights/dataConnectors@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":152},"Microsoft.SecurityInsights/incidents@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":199},"Microsoft.SecurityInsights/incidents/comments@2020-01-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2020-01-01/types.json","Index":205},"Microsoft.SecurityInsights/incidents@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":71},"Microsoft.SecurityInsights/incidents/comments@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":77},"Microsoft.SecurityInsights/incidents/relations@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":82},"Microsoft.SecurityInsights/settings@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":104},"Microsoft.SecurityInsights/onboardingStates@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":109},"Microsoft.SecurityInsights/sourcecontrols@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":127},"Microsoft.SecurityInsights/dataConnectors@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":269},"Microsoft.SecurityInsights/watchlists@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":279},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":284},"Microsoft.SecurityInsights/alertRules@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":464},"Microsoft.SecurityInsights/alertRules/actions@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":469},"Microsoft.SecurityInsights/entityQueries@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":553},"Microsoft.SecurityInsights/metadata@2021-03-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json","Index":609},"Microsoft.SecurityInsights/incidents@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":65},"Microsoft.SecurityInsights/incidents/comments@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":71},"Microsoft.SecurityInsights/incidents/relations@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":76},"Microsoft.SecurityInsights/watchlists@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":86},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":91},"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-04-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-04-01/types.json","Index":117},"Microsoft.SecurityInsights/alertRules@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":223},"Microsoft.SecurityInsights/alertRules/actions@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":228},"Microsoft.SecurityInsights/automationRules@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":344},"Microsoft.SecurityInsights/bookmarks@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":357},"Microsoft.SecurityInsights/bookmarks/relations@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":362},"Microsoft.SecurityInsights/entityQueries@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":446},"Microsoft.SecurityInsights/incidents@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":490},"Microsoft.SecurityInsights/incidents/comments@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":495},"Microsoft.SecurityInsights/incidents/relations@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":499},"Microsoft.SecurityInsights/metadata@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":555},"Microsoft.SecurityInsights/onboardingStates@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":560},"Microsoft.SecurityInsights/settings@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":582},"Microsoft.SecurityInsights/sourcecontrols@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":600},"Microsoft.SecurityInsights/watchlists@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":609},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":614},"Microsoft.SecurityInsights/dataConnectors@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":777},"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-09-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json","Index":803},"Microsoft.SecurityInsights/alertRules@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":262},"Microsoft.SecurityInsights/alertRules/actions@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":267},"Microsoft.SecurityInsights/automationRules@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":385},"Microsoft.SecurityInsights/incidents@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":434},"Microsoft.SecurityInsights/bookmarks@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":471},"Microsoft.SecurityInsights/bookmarks/relations@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":476},"Microsoft.SecurityInsights/entityQueries@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":560},"Microsoft.SecurityInsights/incidents/comments@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":565},"Microsoft.SecurityInsights/incidents/relations@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":569},"Microsoft.SecurityInsights/metadata@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":625},"Microsoft.SecurityInsights/onboardingStates@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":630},"Microsoft.SecurityInsights/settings@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":652},"Microsoft.SecurityInsights/sourcecontrols@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":670},"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":694},"Microsoft.SecurityInsights/watchlists@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":703},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":708},"Microsoft.SecurityInsights/dataConnectors@2021-10-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json","Index":887},"Microsoft.SecurityInsights/incidents@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":66},"Microsoft.SecurityInsights/incidents/comments@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":72},"Microsoft.SecurityInsights/incidents/relations@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":77},"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":101},"Microsoft.SecurityInsights/watchlists@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":111},"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":116},"Microsoft.SecurityInsights/onboardingStates@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":121},"Microsoft.SecurityInsights/alertRules@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":253},"Microsoft.SecurityInsights/alertRules/actions@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":258},"Microsoft.SecurityInsights/bookmarks@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":270},"Microsoft.SecurityInsights/dataConnectors@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":327},"Microsoft.SecurityInsights/automationRules@2021-10-01":{"RelativePath":"securityinsights/microsoft.securityinsights/2021-10-01/types.json","Index":440},"Microsoft.SecurityInsights/alertRules@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":262},"Microsoft.SecurityInsights/alertRules/actions@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":267},"Microsoft.SecurityInsights/automationRules@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":385},"Microsoft.SecurityInsights/incidents@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":434},"Microsoft.SecurityInsights/bookmarks@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":471},"Microsoft.SecurityInsights/bookmarks/relations@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":476},"Microsoft.SecurityInsights/entityQueries@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":560},"Microsoft.SecurityInsights/incidents/comments@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":565},"Microsoft.SecurityInsights/incidents/relations@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":569},"Microsoft.SecurityInsights/metadata@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":635},"Microsoft.SecurityInsights/onboardingStates@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":640},"Microsoft.SecurityInsights/settings@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":662},"Microsoft.SecurityInsights/sourcecontrols@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":702},"Microsoft.SecurityInsights/threatIntelligence/indicators@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":726},"Microsoft.SecurityInsights/watchlists@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":740},"Microsoft.SecurityInsights/watchlists/watchlistItems@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":747},"Microsoft.SecurityInsights/dataConnectors@2022-01-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json","Index":929},"Microsoft.SecurityInsights/alertRules@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":262},"Microsoft.SecurityInsights/alertRules/actions@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":267},"Microsoft.SecurityInsights/automationRules@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":385},"Microsoft.SecurityInsights/incidents@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":434},"Microsoft.SecurityInsights/bookmarks@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":471},"Microsoft.SecurityInsights/bookmarks/relations@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":476},"Microsoft.SecurityInsights/entityQueries@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":560},"Microsoft.SecurityInsights/incidents/comments@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":565},"Microsoft.SecurityInsights/incidents/relations@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":569},"Microsoft.SecurityInsights/metadata@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":635},"Microsoft.SecurityInsights/onboardingStates@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":640},"Microsoft.SecurityInsights/settings@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":666},"Microsoft.SecurityInsights/sourcecontrols@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":706},"Microsoft.SecurityInsights/threatIntelligence/indicators@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":730},"Microsoft.SecurityInsights/watchlists@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":739},"Microsoft.SecurityInsights/watchlists/watchlistItems@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":746},"Microsoft.SecurityInsights/dataConnectors@2022-04-01-preview":{"RelativePath":"securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json","Index":928},"Microsoft.SerialConsole/serialPorts@2018-05-01":{"RelativePath":"serialconsole/microsoft.serialconsole/2018-05-01/types.json","Index":15},"Microsoft.ServiceBus/namespaces@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":36},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":46},"Microsoft.ServiceBus/namespaces/queues@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":68},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":72},"Microsoft.ServiceBus/namespaces/topics@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":93},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":97},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2015-08-01":{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":118},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":17},"Microsoft.ServiceBus/namespaces@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":32},"Microsoft.ServiceBus/namespaces/networkRuleSets@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":48},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":52},"Microsoft.ServiceBus/namespaces/queues@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":68},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":72},"Microsoft.ServiceBus/namespaces/topics@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":87},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":100},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":107},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":119},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2017-04-01":{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":134},"Microsoft.ServiceBus/namespaces/ipfilterrules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":15},"Microsoft.ServiceBus/namespaces@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":35},"Microsoft.ServiceBus/namespaces/virtualnetworkrules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":40},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":50},"Microsoft.ServiceBus/namespaces/networkRuleSets@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":66},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":85},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":98},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":102},"Microsoft.ServiceBus/namespaces/queues@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":118},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":122},"Microsoft.ServiceBus/namespaces/topics@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":137},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":144},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":159},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2018-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":171},"Microsoft.ServiceBus/namespaces@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":63},"Microsoft.ServiceBus/namespaces/networkRuleSets@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":79},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":89},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":93},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":106},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":113},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":117},"Microsoft.ServiceBus/namespaces/queues@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":133},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":137},"Microsoft.ServiceBus/namespaces/topics@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":152},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":164},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-01-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":179},"Microsoft.ServiceBus/namespaces@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":63},"Microsoft.ServiceBus/namespaces/networkRuleSets@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":82},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":92},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":96},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":109},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":116},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":120},"Microsoft.ServiceBus/namespaces/queues@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":136},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":140},"Microsoft.ServiceBus/namespaces/topics@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":155},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":167},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-06-01-preview":{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":183},"Microsoft.ServiceBus/namespaces@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":63},"Microsoft.ServiceBus/namespaces/networkRuleSets@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":82},"Microsoft.ServiceBus/namespaces/AuthorizationRules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":92},"Microsoft.ServiceBus/namespaces/privateEndpointConnections@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":96},"Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":109},"Microsoft.ServiceBus/namespaces/migrationConfigurations@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":116},"Microsoft.ServiceBus/namespaces/queues/authorizationRules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":120},"Microsoft.ServiceBus/namespaces/queues@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":136},"Microsoft.ServiceBus/namespaces/topics/authorizationRules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":140},"Microsoft.ServiceBus/namespaces/topics@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":155},"Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":167},"Microsoft.ServiceBus/namespaces/topics/subscriptions@2021-11-01":{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":183},"Microsoft.ServiceFabric/clusters@2016-09-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2016-09-01/types.json","Index":74},"Microsoft.ServiceFabric/clusters/applicationTypes@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":12},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":18},"Microsoft.ServiceFabric/clusters/applications@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":34},"Microsoft.ServiceFabric/clusters/applications/services@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":72},"Microsoft.ServiceFabric/clusters@2017-07-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2017-07-01-preview/types.json","Index":145},"Microsoft.ServiceFabric/clusters@2018-02-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2018-02-01/types.json","Index":101},"Microsoft.ServiceFabric/clusters@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":101},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":107},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":114},"Microsoft.ServiceFabric/clusters/applications@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":131},"Microsoft.ServiceFabric/clusters/applications/services@2019-03-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01-preview/types.json","Index":173},"Microsoft.ServiceFabric/clusters@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":101},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":107},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":114},"Microsoft.ServiceFabric/clusters/applications@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":131},"Microsoft.ServiceFabric/clusters/applications/services@2019-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-03-01/types.json","Index":173},"Microsoft.ServiceFabric/clusters@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":101},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":107},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":114},"Microsoft.ServiceFabric/clusters/applications@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":141},"Microsoft.ServiceFabric/clusters/applications/services@2019-06-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-06-01-preview/types.json","Index":183},"Microsoft.ServiceFabric/clusters@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":102},"Microsoft.ServiceFabric/clusters/applicationTypes@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":108},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":115},"Microsoft.ServiceFabric/clusters/applications@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":147},"Microsoft.ServiceFabric/clusters/applications/services@2019-11-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2019-11-01-preview/types.json","Index":189},"Microsoft.ServiceFabric/managedClusters@2020-01-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-01-01-preview/types.json","Index":60},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2020-01-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-01-01-preview/types.json","Index":89},"Microsoft.ServiceFabric/clusters@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":102},"Microsoft.ServiceFabric/clusters/applicationTypes@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":108},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":115},"Microsoft.ServiceFabric/clusters/applications@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":147},"Microsoft.ServiceFabric/clusters/applications/services@2020-03-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-03-01/types.json","Index":189},"Microsoft.ServiceFabric/clusters@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":113},"Microsoft.ServiceFabric/clusters/applicationTypes@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":119},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":126},"Microsoft.ServiceFabric/clusters/applications@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":158},"Microsoft.ServiceFabric/clusters/applications/services@2020-12-01-preview":{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":200},"Microsoft.ServiceFabric/clusters@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":126},"Microsoft.ServiceFabric/clusters/applicationTypes@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":132},"Microsoft.ServiceFabric/clusters/applicationTypes/versions@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":139},"Microsoft.ServiceFabric/clusters/applications@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":171},"Microsoft.ServiceFabric/clusters/applications/services@2021-06-01":{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":213},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":185},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-01-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.json","Index":216},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":188},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-05-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.json","Index":223},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":190},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-07-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.json","Index":232},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":201},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2021-11-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.json","Index":249},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":201},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2022-01-01":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.json","Index":249},"Microsoft.ServiceFabric/managedclusters/applicationTypes@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":14},"Microsoft.ServiceFabric/managedclusters/applicationTypes/versions@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":20},"Microsoft.ServiceFabric/managedclusters/applications@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":48},"Microsoft.ServiceFabric/managedclusters/applications/services@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":110},"Microsoft.ServiceFabric/managedClusters@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":201},"Microsoft.ServiceFabric/managedClusters/nodeTypes@2022-02-01-preview":{"RelativePath":"servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.json","Index":250},"Microsoft.ServiceFabricMesh/applications@2018-07-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.json","Index":77},"Microsoft.ServiceFabricMesh/networks@2018-07-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.json","Index":88},"Microsoft.ServiceFabricMesh/volumes@2018-07-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.json","Index":97},"Microsoft.ServiceFabricMesh/secrets@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":22},"Microsoft.ServiceFabricMesh/secrets/values@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":28},"Microsoft.ServiceFabricMesh/volumes@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":44},"Microsoft.ServiceFabricMesh/networks@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":59},"Microsoft.ServiceFabricMesh/gateways@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":92},"Microsoft.ServiceFabricMesh/applications@2018-09-01-preview":{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":186},"Microsoft.ServiceLinker/linkers@2021-11-01-preview":{"RelativePath":"servicelinker/microsoft.servicelinker/2021-11-01-preview/types.json","Index":50},"Microsoft.ServiceLinker/linkers@2022-01-01-preview":{"RelativePath":"servicelinker/microsoft.servicelinker/2022-01-01-preview/types.json","Index":67},"Microsoft.ServiceLinker/linkers@2022-05-01":{"RelativePath":"servicelinker/microsoft.servicelinker/2022-05-01/types.json","Index":67},"Microsoft.SignalRService/SignalR@2018-03-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2018-03-01-preview/types.json","Index":29},"Microsoft.SignalRService/signalR@2018-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2018-10-01/types.json","Index":37},"Microsoft.SignalRService/signalR@2020-05-01":{"RelativePath":"signalr/microsoft.signalrservice/2020-05-01/types.json","Index":95},"Microsoft.SignalRService/signalR/privateEndpointConnections@2020-05-01":{"RelativePath":"signalr/microsoft.signalrservice/2020-05-01/types.json","Index":99},"Microsoft.SignalRService/signalR@2020-07-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2020-07-01-preview/types.json","Index":104},"Microsoft.SignalRService/signalR/privateEndpointConnections@2020-07-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2020-07-01-preview/types.json","Index":108},"Microsoft.SignalRService/signalR@2021-04-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":139},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":143},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-04-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":147},"Microsoft.SignalRService/signalR@2021-06-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":139},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":143},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-06-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":147},"Microsoft.SignalRService/signalR@2021-09-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":139},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-09-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":143},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-09-01-preview":{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":147},"Microsoft.SignalRService/signalR@2021-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":143},"Microsoft.SignalRService/signalR/privateEndpointConnections@2021-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":147},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2021-10-01":{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":151},"Microsoft.SignalRService/signalR@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":146},"Microsoft.SignalRService/signalR/customCertificates@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":161},"Microsoft.SignalRService/signalR/customDomains@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":177},"Microsoft.SignalRService/signalR/privateEndpointConnections@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":181},"Microsoft.SignalRService/signalR/sharedPrivateLinkResources@2022-02-01":{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":185},"Microsoft.SoftwarePlan/hybridUseBenefits@2019-06-01-preview":{"RelativePath":"softwareplan/microsoft.softwareplan/2019-06-01-preview/types.json","Index":17},"Microsoft.SoftwarePlan/hybridUseBenefits@2019-12-01":{"RelativePath":"softwareplan/microsoft.softwareplan/2019-12-01/types.json","Index":17},"Microsoft.Solutions/applications@2021-07-01":{"RelativePath":"solutions/microsoft.solutions/2021-07-01/types.json","Index":75},"Microsoft.Solutions/applicationDefinitions@2021-07-01":{"RelativePath":"solutions/microsoft.solutions/2021-07-01/types.json","Index":125},"Microsoft.Solutions/jitRequests@2021-07-01":{"RelativePath":"solutions/microsoft.solutions/2021-07-01/types.json","Index":157},"Microsoft.Sql/servers/databases/dataMaskingPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":16},"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":31},"Microsoft.Sql/servers/databases/geoBackupPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":41},"Microsoft.Sql/servers/databases@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":314},"Microsoft.Sql/servers/databases/extensions@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":328},"Microsoft.Sql/servers/elasticPools@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":344},"Microsoft.Sql/servers/communicationLinks@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":349},"Microsoft.Sql/servers/connectionPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":360},"Microsoft.Sql/servers/databases/securityAlertPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":377},"Microsoft.Sql/servers/firewallRules@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":382},"Microsoft.Sql/servers/databases/transparentDataEncryption@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":388},"Microsoft.Sql/servers@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":400},"Microsoft.Sql/servers/administrators@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":407},"Microsoft.Sql/servers/advisors@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":421},"Microsoft.Sql/servers/databases/advisors@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":425},"Microsoft.Sql/servers/disasterRecoveryConfiguration@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":445},"Microsoft.Sql/servers/auditingPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":452},"Microsoft.Sql/servers/databases/auditingPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":459},"Microsoft.Sql/servers/databases/connectionPolicies@2014-04-01":{"RelativePath":"sql/microsoft.sql/2014-04-01/types.json","Index":466},"Microsoft.Sql/servers/encryptionProtector@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":17},"Microsoft.Sql/servers/failoverGroups@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":40},"Microsoft.Sql/servers/keys@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":48},"Microsoft.Sql/servers/syncAgents@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":57},"Microsoft.Sql/servers/virtualNetworkRules@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":68},"Microsoft.Sql/managedInstances@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":91},"Microsoft.Sql/servers@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":97},"Microsoft.Sql/servers/databases/syncGroups@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":116},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":147},"Microsoft.Sql/servers/databases/auditingSettings@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":158},"Microsoft.Sql/servers/firewallRules@2015-05-01-preview":{"RelativePath":"sql/microsoft.sql/2015-05-01-preview/types.json","Index":163},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":18},"Microsoft.Sql/servers/extendedAuditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":29},"Microsoft.Sql/servers/auditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":40},"Microsoft.Sql/servers/databases/auditingSettings@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":51},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":62},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":71},"Microsoft.Sql/servers/jobAgents@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":84},"Microsoft.Sql/servers/jobAgents/credentials@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":89},"Microsoft.Sql/servers/jobAgents/jobs/executions@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":118},"Microsoft.Sql/servers/jobAgents/jobs@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":127},"Microsoft.Sql/servers/jobAgents/jobs/steps@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":141},"Microsoft.Sql/servers/jobAgents/targetGroups@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":157},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":164},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":170},"Microsoft.Sql/servers/dnsAliases@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":175},"Microsoft.Sql/servers/securityAlertPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":188},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":194},"Microsoft.Sql/managedInstances/securityAlertPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":200},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":212},"Microsoft.Sql/managedInstances/administrators@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":220},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":227},"Microsoft.Sql/servers/databases@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":270},"Microsoft.Sql/managedInstances/databases@2017-03-01-preview":{"RelativePath":"sql/microsoft.sql/2017-03-01-preview/types.json","Index":293},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":18},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":27},"Microsoft.Sql/locations/instanceFailoverGroups@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":50},"Microsoft.Sql/managedInstances/keys@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":58},"Microsoft.Sql/managedInstances/encryptionProtector@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":68},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":75},"Microsoft.Sql/servers/elasticPools@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":90},"Microsoft.Sql/servers/databases@2017-10-01-preview":{"RelativePath":"sql/microsoft.sql/2017-10-01-preview/types.json","Index":142},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":16},"Microsoft.Sql/servers/vulnerabilityAssessments@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":23},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":35},"Microsoft.Sql/instancePools@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":45},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":52},"Microsoft.Sql/servers/databases/securityAlertPolicies@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":65},"Microsoft.Sql/managedInstances@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":87},"Microsoft.Sql/managedInstances/databases@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":110},"Microsoft.Sql/servers/privateEndpointConnections@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":117},"Microsoft.Sql/servers/administrators@2018-06-01-preview":{"RelativePath":"sql/microsoft.sql/2018-06-01-preview/types.json","Index":126},"Microsoft.Sql/servers@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":40},"Microsoft.Sql/servers/databases/workloadGroups@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":45},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":50},"Microsoft.Sql/servers/administrators@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":59},"Microsoft.Sql/servers/databases/syncGroups@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":78},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":109},"Microsoft.Sql/servers/databases@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":166},"Microsoft.Sql/managedInstances/databases@2019-06-01-preview":{"RelativePath":"sql/microsoft.sql/2019-06-01-preview/types.json","Index":189},"Microsoft.Sql/servers/databases@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":64},"Microsoft.Sql/servers@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":97},"Microsoft.Sql/managedInstances/databases@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":120},"Microsoft.Sql/servers/azureADOnlyAuthentications@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":127},"Microsoft.Sql/managedInstances@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":159},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":166},"Microsoft.Sql/locations/serverTrustGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":176},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":183},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":194},"Microsoft.Sql/servers/extendedAuditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":205},"Microsoft.Sql/servers/auditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":216},"Microsoft.Sql/servers/databases/auditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":227},"Microsoft.Sql/servers/databases/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":250},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":261},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":270},"Microsoft.Sql/servers/elasticPools@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":284},"Microsoft.Sql/servers/encryptionProtector@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":294},"Microsoft.Sql/servers/failoverGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":317},"Microsoft.Sql/servers/firewallRules@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":322},"Microsoft.Sql/locations/instanceFailoverGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":345},"Microsoft.Sql/instancePools@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":354},"Microsoft.Sql/servers/jobAgents@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":366},"Microsoft.Sql/servers/jobAgents/credentials@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":371},"Microsoft.Sql/servers/jobAgents/jobs/executions@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":400},"Microsoft.Sql/servers/jobAgents/jobs@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":409},"Microsoft.Sql/servers/jobAgents/jobs/steps@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":423},"Microsoft.Sql/servers/jobAgents/targetGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":439},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":446},"Microsoft.Sql/servers/databases/maintenanceWindows@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":462},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":469},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":482},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":494},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":504},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":511},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":517},"Microsoft.Sql/managedInstances/administrators@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":526},"Microsoft.Sql/managedInstances/encryptionProtector@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":536},"Microsoft.Sql/managedInstances/keys@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":544},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":550},"Microsoft.Sql/managedInstances/privateEndpointConnections@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":554},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":561},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":567},"Microsoft.Sql/managedInstances/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":573},"Microsoft.Sql/servers/privateEndpointConnections@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":577},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":582},"Microsoft.Sql/servers/administrators@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":591},"Microsoft.Sql/servers/devOpsAuditingSettings@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":599},"Microsoft.Sql/servers/dnsAliases@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":604},"Microsoft.Sql/servers/keys@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":612},"Microsoft.Sql/servers/securityAlertPolicies@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":618},"Microsoft.Sql/servers/vulnerabilityAssessments@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":625},"Microsoft.Sql/managedInstances/sqlAgent@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":634},"Microsoft.Sql/servers/syncAgents@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":643},"Microsoft.Sql/servers/databases/syncGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":662},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":693},"Microsoft.Sql/servers/databases/transparentDataEncryption@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":703},"Microsoft.Sql/servers/virtualNetworkRules@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":715},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":720},"Microsoft.Sql/servers/databases/workloadGroups@2020-02-02-preview":{"RelativePath":"sql/microsoft.sql/2020-02-02-preview/types.json","Index":725},"Microsoft.Sql/servers/elasticPools@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":22},"Microsoft.Sql/servers/devOpsAuditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":41},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":48},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":59},"Microsoft.Sql/servers/extendedAuditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":70},"Microsoft.Sql/servers/auditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":81},"Microsoft.Sql/servers/databases/auditingSettings@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":92},"Microsoft.Sql/servers/databases/extensions@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":102},"Microsoft.Sql/servers/databases@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":161},"Microsoft.Sql/servers/databases/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":173},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":184},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":193},"Microsoft.Sql/servers/encryptionProtector@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":203},"Microsoft.Sql/servers/failoverGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":226},"Microsoft.Sql/servers/firewallRules@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":231},"Microsoft.Sql/locations/instanceFailoverGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":254},"Microsoft.Sql/instancePools@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":263},"Microsoft.Sql/servers/jobAgents@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":275},"Microsoft.Sql/servers/jobAgents/credentials@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":280},"Microsoft.Sql/servers/jobAgents/jobs/executions@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":309},"Microsoft.Sql/servers/jobAgents/jobs@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":318},"Microsoft.Sql/servers/jobAgents/jobs/steps@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":332},"Microsoft.Sql/servers/jobAgents/targetGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":348},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":355},"Microsoft.Sql/servers/databases/maintenanceWindows@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":371},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":378},"Microsoft.Sql/managedInstances/databases@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":401},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":414},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":426},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":436},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":443},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":449},"Microsoft.Sql/managedInstances/administrators@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":458},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":465},"Microsoft.Sql/managedInstances/encryptionProtector@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":475},"Microsoft.Sql/managedInstances/keys@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":489},"Microsoft.Sql/managedInstances/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":496},"Microsoft.Sql/managedInstances@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":531},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":538},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":544},"Microsoft.Sql/managedInstances/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":550},"Microsoft.Sql/servers/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":570},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":575},"Microsoft.Sql/servers/administrators@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":584},"Microsoft.Sql/servers/azureADOnlyAuthentications@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":591},"Microsoft.Sql/servers/dnsAliases@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":596},"Microsoft.Sql/servers/keys@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":604},"Microsoft.Sql/servers@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":618},"Microsoft.Sql/servers/securityAlertPolicies@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":624},"Microsoft.Sql/locations/serverTrustGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":634},"Microsoft.Sql/servers/vulnerabilityAssessments@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":641},"Microsoft.Sql/managedInstances/sqlAgent@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":650},"Microsoft.Sql/servers/syncAgents@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":659},"Microsoft.Sql/servers/databases/syncGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":678},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":709},"Microsoft.Sql/servers/databases/transparentDataEncryption@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":719},"Microsoft.Sql/servers/virtualNetworkRules@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":731},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":736},"Microsoft.Sql/servers/databases/workloadGroups@2020-08-01-preview":{"RelativePath":"sql/microsoft.sql/2020-08-01-preview/types.json","Index":741},"Microsoft.Sql/servers/databases/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":30},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":41},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":50},"Microsoft.Sql/servers/encryptionProtector@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":60},"Microsoft.Sql/servers/failoverGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":83},"Microsoft.Sql/servers/firewallRules@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":88},"Microsoft.Sql/locations/instanceFailoverGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":111},"Microsoft.Sql/instancePools@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":121},"Microsoft.Sql/servers/jobAgents@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":133},"Microsoft.Sql/servers/jobAgents/credentials@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":138},"Microsoft.Sql/servers/jobAgents/jobs/executions@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":167},"Microsoft.Sql/servers/jobAgents/jobs@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":176},"Microsoft.Sql/servers/jobAgents/jobs/steps@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":190},"Microsoft.Sql/servers/jobAgents/targetGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":206},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":213},"Microsoft.Sql/servers/databases/maintenanceWindows@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":229},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":236},"Microsoft.Sql/managedInstances/databases@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":259},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":272},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":282},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":289},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":295},"Microsoft.Sql/managedInstances/administrators@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":304},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":311},"Microsoft.Sql/managedInstances/encryptionProtector@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":321},"Microsoft.Sql/managedInstances/keys@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":329},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":335},"Microsoft.Sql/managedInstances/privateEndpointConnections@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":342},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":349},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":355},"Microsoft.Sql/managedInstances/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":361},"Microsoft.Sql/servers/privateEndpointConnections@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":381},"Microsoft.Sql/servers/administrators@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":390},"Microsoft.Sql/servers/azureADOnlyAuthentications@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":397},"Microsoft.Sql/servers/devOpsAuditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":405},"Microsoft.Sql/servers/dnsAliases@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":410},"Microsoft.Sql/servers/keys@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":418},"Microsoft.Sql/servers/securityAlertPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":424},"Microsoft.Sql/locations/serverTrustGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":435},"Microsoft.Sql/servers/vulnerabilityAssessments@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":442},"Microsoft.Sql/managedInstances/sqlAgent@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":451},"Microsoft.Sql/servers/syncAgents@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":460},"Microsoft.Sql/servers/databases/syncGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":479},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":510},"Microsoft.Sql/servers/virtualNetworkRules@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":522},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":527},"Microsoft.Sql/servers/databases/workloadGroups@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":532},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":544},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":549},"Microsoft.Sql/servers/databases@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":612},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":619},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":629},"Microsoft.Sql/servers/extendedAuditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":639},"Microsoft.Sql/servers/auditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":649},"Microsoft.Sql/servers/databases/auditingSettings@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":659},"Microsoft.Sql/servers/databases/extensions@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":669},"Microsoft.Sql/servers/elasticPools@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":683},"Microsoft.Sql/managedInstances@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":727},"Microsoft.Sql/servers@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":748},"Microsoft.Sql/servers/databases/transparentDataEncryption@2020-11-01-preview":{"RelativePath":"sql/microsoft.sql/2020-11-01-preview/types.json","Index":758},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":17},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":24},"Microsoft.Sql/servers/databases/extensions@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":34},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":44},"Microsoft.Sql/servers/outboundFirewallRules@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":49},"Microsoft.Sql/servers@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":97},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":108},"Microsoft.Sql/servers/extendedAuditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":119},"Microsoft.Sql/servers/auditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":130},"Microsoft.Sql/servers/databases/auditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":141},"Microsoft.Sql/servers/databases@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":205},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":228},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":239},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":248},"Microsoft.Sql/servers/elasticPools@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":262},"Microsoft.Sql/servers/encryptionProtector@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":272},"Microsoft.Sql/servers/failoverGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":295},"Microsoft.Sql/servers/firewallRules@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":300},"Microsoft.Sql/locations/instanceFailoverGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":323},"Microsoft.Sql/instancePools@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":332},"Microsoft.Sql/servers/jobAgents@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":344},"Microsoft.Sql/servers/jobAgents/credentials@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":349},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":378},"Microsoft.Sql/servers/jobAgents/jobs@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":387},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":401},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":417},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":424},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":440},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":447},"Microsoft.Sql/managedInstances/databases@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":470},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":495},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":505},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":512},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":518},"Microsoft.Sql/managedInstances/administrators@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":527},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":534},"Microsoft.Sql/managedInstances/encryptionProtector@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":544},"Microsoft.Sql/managedInstances/keys@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":552},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":558},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":565},"Microsoft.Sql/managedInstances@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":610},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":617},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":623},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":629},"Microsoft.Sql/servers/privateEndpointConnections@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":633},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":638},"Microsoft.Sql/servers/administrators@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":647},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":654},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":662},"Microsoft.Sql/servers/dnsAliases@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":667},"Microsoft.Sql/servers/keys@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":675},"Microsoft.Sql/servers/securityAlertPolicies@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":681},"Microsoft.Sql/locations/serverTrustGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":692},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":699},"Microsoft.Sql/managedInstances/sqlAgent@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":708},"Microsoft.Sql/servers/syncAgents@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":717},"Microsoft.Sql/servers/databases/syncGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":736},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":767},"Microsoft.Sql/servers/virtualNetworkRules@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":779},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":784},"Microsoft.Sql/servers/databases/workloadGroups@2021-02-01-preview":{"RelativePath":"sql/microsoft.sql/2021-02-01-preview/types.json","Index":789},"Microsoft.Sql/servers/databases@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":82},"Microsoft.Sql/managedInstances@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":148},"Microsoft.Sql/servers/connectionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":159},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":166},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":177},"Microsoft.Sql/servers/extendedAuditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":188},"Microsoft.Sql/servers/auditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":199},"Microsoft.Sql/servers/databases/auditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":210},"Microsoft.Sql/servers/databases/extensions@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":223},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":246},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":257},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":266},"Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":274},"Microsoft.Sql/servers/elasticPools@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":288},"Microsoft.Sql/servers/encryptionProtector@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":298},"Microsoft.Sql/servers/failoverGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":321},"Microsoft.Sql/servers/firewallRules@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":326},"Microsoft.Sql/locations/instanceFailoverGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":349},"Microsoft.Sql/instancePools@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":358},"Microsoft.Sql/servers/jobAgents@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":370},"Microsoft.Sql/servers/jobAgents/credentials@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":375},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":404},"Microsoft.Sql/servers/jobAgents/jobs@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":413},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":427},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":443},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":453},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":460},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":476},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":506},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":519},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":531},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":541},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":548},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":554},"Microsoft.Sql/managedInstances/administrators@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":563},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":570},"Microsoft.Sql/managedInstances/encryptionProtector@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":580},"Microsoft.Sql/managedInstances/keys@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":588},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":594},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":598},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":605},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":611},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":617},"Microsoft.Sql/servers/outboundFirewallRules@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":622},"Microsoft.Sql/servers/privateEndpointConnections@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":643},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":648},"Microsoft.Sql/servers/administrators@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":657},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":664},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":672},"Microsoft.Sql/servers/dnsAliases@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":677},"Microsoft.Sql/servers/keys@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":685},"Microsoft.Sql/servers@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":709},"Microsoft.Sql/servers/securityAlertPolicies@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":715},"Microsoft.Sql/managedInstances/serverTrustCertificates@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":720},"Microsoft.Sql/locations/serverTrustGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":731},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":738},"Microsoft.Sql/managedInstances/sqlAgent@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":747},"Microsoft.Sql/servers/syncAgents@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":756},"Microsoft.Sql/servers/databases/syncGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":775},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":806},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":816},"Microsoft.Sql/servers/virtualNetworkRules@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":828},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":833},"Microsoft.Sql/servers/databases/workloadGroups@2021-05-01-preview":{"RelativePath":"sql/microsoft.sql/2021-05-01-preview/types.json","Index":838},"Microsoft.Sql/servers/elasticPools@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":22},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":29},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":39},"Microsoft.Sql/servers/extendedAuditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":49},"Microsoft.Sql/servers/auditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":59},"Microsoft.Sql/servers/databases/auditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":69},"Microsoft.Sql/servers/databases/extensions@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":82},"Microsoft.Sql/servers/databases@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":156},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":179},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":190},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":199},"Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":207},"Microsoft.Sql/servers/encryptionProtector@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":217},"Microsoft.Sql/servers/failoverGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":240},"Microsoft.Sql/servers/firewallRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":245},"Microsoft.Sql/locations/instanceFailoverGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":268},"Microsoft.Sql/instancePools@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":277},"Microsoft.Sql/servers/ipv6FirewallRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":282},"Microsoft.Sql/servers/jobAgents@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":294},"Microsoft.Sql/servers/jobAgents/credentials@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":299},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":328},"Microsoft.Sql/servers/jobAgents/jobs@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":337},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":351},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":367},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":377},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":384},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":400},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":407},"Microsoft.Sql/managedInstances/databases@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":430},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":443},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":455},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":465},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":472},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":478},"Microsoft.Sql/managedInstances/administrators@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":487},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":494},"Microsoft.Sql/managedInstances/encryptionProtector@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":504},"Microsoft.Sql/managedInstances/keys@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":512},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":518},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":525},"Microsoft.Sql/managedInstances@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":588},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":595},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":601},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":607},"Microsoft.Sql/servers/outboundFirewallRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":612},"Microsoft.Sql/servers/privateEndpointConnections@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":633},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":638},"Microsoft.Sql/servers/administrators@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":647},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":654},"Microsoft.Sql/servers/connectionPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":665},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":673},"Microsoft.Sql/servers/dnsAliases@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":678},"Microsoft.Sql/servers/keys@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":686},"Microsoft.Sql/servers@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":710},"Microsoft.Sql/servers/securityAlertPolicies@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":716},"Microsoft.Sql/managedInstances/serverTrustCertificates@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":721},"Microsoft.Sql/locations/serverTrustGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":732},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":739},"Microsoft.Sql/managedInstances/sqlAgent@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":748},"Microsoft.Sql/servers/syncAgents@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":757},"Microsoft.Sql/servers/databases/syncGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":776},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":807},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":817},"Microsoft.Sql/servers/virtualNetworkRules@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":829},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":834},"Microsoft.Sql/servers/databases/workloadGroups@2021-08-01-preview":{"RelativePath":"sql/microsoft.sql/2021-08-01-preview/types.json","Index":839},"Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":14},"Microsoft.Sql/servers/auditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":24},"Microsoft.Sql/servers/databases/auditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":34},"Microsoft.Sql/servers/databases/extendedAuditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":44},"Microsoft.Sql/servers/extendedAuditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":54},"Microsoft.Sql/servers/databases/advancedThreatProtectionSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":76},"Microsoft.Sql/servers/databases/extensions@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":89},"Microsoft.Sql/servers/databases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":164},"Microsoft.Sql/servers/databases/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":176},"Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":187},"Microsoft.Sql/servers/databases/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":196},"Microsoft.Sql/managedInstances/distributedAvailabilityGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":204},"Microsoft.Sql/servers/elasticPools@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":218},"Microsoft.Sql/servers/encryptionProtector@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":228},"Microsoft.Sql/servers/failoverGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":251},"Microsoft.Sql/servers/firewallRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":256},"Microsoft.Sql/locations/instanceFailoverGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":279},"Microsoft.Sql/instancePools@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":288},"Microsoft.Sql/servers/ipv6FirewallRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":293},"Microsoft.Sql/servers/jobAgents@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":305},"Microsoft.Sql/servers/jobAgents/credentials@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":310},"Microsoft.Sql/servers/jobAgents/jobs/executions@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":339},"Microsoft.Sql/servers/jobAgents/jobs@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":348},"Microsoft.Sql/servers/jobAgents/jobs/steps@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":362},"Microsoft.Sql/servers/jobAgents/targetGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":378},"Microsoft.Sql/servers/databases/ledgerDigestUploads@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":388},"Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":395},"Microsoft.Sql/servers/databases/maintenanceWindows@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":411},"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":418},"Microsoft.Sql/managedInstances/databases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":441},"Microsoft.Sql/managedInstances/databases/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":454},"Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":466},"Microsoft.Sql/managedInstances/databases/transparentDataEncryption@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":476},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":483},"Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":489},"Microsoft.Sql/managedInstances/administrators@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":498},"Microsoft.Sql/managedInstances/azureADOnlyAuthentications@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":505},"Microsoft.Sql/managedInstances/encryptionProtector@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":515},"Microsoft.Sql/managedInstances/keys@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":523},"Microsoft.Sql/managedInstances/databases/backupLongTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":529},"Microsoft.Sql/managedInstances/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":536},"Microsoft.Sql/managedInstances@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":599},"Microsoft.Sql/managedInstances/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":606},"Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":612},"Microsoft.Sql/managedInstances/dnsAliases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":617},"Microsoft.Sql/managedInstances/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":623},"Microsoft.Sql/servers/outboundFirewallRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":628},"Microsoft.Sql/servers/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":649},"Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":654},"Microsoft.Sql/servers/advancedThreatProtectionSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":660},"Microsoft.Sql/servers/administrators@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":669},"Microsoft.Sql/servers/azureADOnlyAuthentications@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":676},"Microsoft.Sql/servers/connectionPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":687},"Microsoft.Sql/servers/devOpsAuditingSettings@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":695},"Microsoft.Sql/servers/dnsAliases@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":700},"Microsoft.Sql/servers/keys@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":708},"Microsoft.Sql/servers@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":732},"Microsoft.Sql/servers/securityAlertPolicies@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":738},"Microsoft.Sql/managedInstances/serverTrustCertificates@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":743},"Microsoft.Sql/locations/serverTrustGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":754},"Microsoft.Sql/servers/vulnerabilityAssessments@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":761},"Microsoft.Sql/managedInstances/sqlAgent@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":770},"Microsoft.Sql/servers/syncAgents@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":779},"Microsoft.Sql/servers/databases/syncGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":798},"Microsoft.Sql/servers/databases/syncGroups/syncMembers@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":829},"Microsoft.Sql/servers/databases/transparentDataEncryption@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":839},"Microsoft.Sql/servers/virtualNetworkRules@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":851},"Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":856},"Microsoft.Sql/servers/databases/workloadGroups@2021-11-01-preview":{"RelativePath":"sql/microsoft.sql/2021-11-01-preview/types.json","Index":861},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2017-03-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.json","Index":16},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2017-03-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.json","Index":32},"Microsoft.SqlVirtualMachine/sqlVirtualMachines@2017-03-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.json","Index":101},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners@2021-11-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.json","Index":43},"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups@2021-11-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.json","Index":59},"Microsoft.SqlVirtualMachine/sqlVirtualMachines@2021-11-01-preview":{"RelativePath":"sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.json","Index":151},"Microsoft.Storage/storageAccounts@2015-05-01-preview":{"RelativePath":"storage/microsoft.storage/2015-05-01-preview/types.json","Index":31},"Microsoft.Storage/storageAccounts@2015-06-15":{"RelativePath":"storage/microsoft.storage/2015-06-15/types.json","Index":31},"Microsoft.Storage/storageAccounts@2016-01-01":{"RelativePath":"storage/microsoft.storage/2016-01-01/types.json","Index":46},"Microsoft.Storage/storageAccounts@2016-05-01":{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":46},"Microsoft.Storage/storageAccounts@2016-12-01":{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":46},"Microsoft.Storage/storageAccounts@2017-06-01":{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":83},"Microsoft.Storage/storageAccounts@2017-10-01":{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":85},"Microsoft.Storage/storageAccounts@2018-02-01":{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":85},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-02-01":{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":121},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-02-01":{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":127},"Microsoft.Storage/storageAccounts/managementPolicies@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":14},"Microsoft.Storage/storageAccounts@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":92},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":128},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-03-01-preview":{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":134},"Microsoft.Storage/storageAccounts@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":95},"Microsoft.Storage/storageAccounts/blobServices@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":118},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":154},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-07-01":{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":160},"Microsoft.Storage/storageAccounts@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":95},"Microsoft.Storage/storageAccounts/managementPolicies@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":116},"Microsoft.Storage/storageAccounts/blobServices@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":139},"Microsoft.Storage/storageAccounts/blobServices/containers@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":175},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2018-11-01":{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":181},"Microsoft.Storage/storageAccounts@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":110},"Microsoft.Storage/storageAccounts/managementPolicies@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":131},"Microsoft.Storage/storageAccounts/blobServices@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":155},"Microsoft.Storage/storageAccounts/blobServices/containers@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":191},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":197},"Microsoft.Storage/storageAccounts/fileServices@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":204},"Microsoft.Storage/storageAccounts/fileServices/shares@2019-04-01":{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":210},"Microsoft.Storage/storageAccounts@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":126},"Microsoft.Storage/storageAccounts/managementPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":150},"Microsoft.Storage/storageAccounts/inventoryPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":177},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":181},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":190},"Microsoft.Storage/storageAccounts/encryptionScopes@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":202},"Microsoft.Storage/storageAccounts/blobServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":231},"Microsoft.Storage/storageAccounts/blobServices/containers@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":267},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":273},"Microsoft.Storage/storageAccounts/fileServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":280},"Microsoft.Storage/storageAccounts/fileServices/shares@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":298},"Microsoft.Storage/storageAccounts/queueServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":305},"Microsoft.Storage/storageAccounts/queueServices/queues@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":311},"Microsoft.Storage/storageAccounts/tableServices@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":318},"Microsoft.Storage/storageAccounts/tableServices/tables@2019-06-01":{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":323},"Microsoft.Storage/storageAccounts@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":131},"Microsoft.Storage/storageAccounts/managementPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":155},"Microsoft.Storage/storageAccounts/inventoryPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":182},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":186},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":195},"Microsoft.Storage/storageAccounts/encryptionScopes@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":207},"Microsoft.Storage/storageAccounts/blobServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":236},"Microsoft.Storage/storageAccounts/blobServices/containers@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":272},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":278},"Microsoft.Storage/storageAccounts/fileServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":288},"Microsoft.Storage/storageAccounts/fileServices/shares@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":306},"Microsoft.Storage/storageAccounts/queueServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":313},"Microsoft.Storage/storageAccounts/queueServices/queues@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":319},"Microsoft.Storage/storageAccounts/tableServices@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":326},"Microsoft.Storage/storageAccounts/tableServices/tables@2020-08-01-preview":{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":331},"Microsoft.Storage/storageAccounts@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":138},"Microsoft.Storage/storageAccounts/managementPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":162},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":189},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":193},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":202},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":214},"Microsoft.Storage/storageAccounts/blobServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":243},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":279},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":285},"Microsoft.Storage/storageAccounts/fileServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":295},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":313},"Microsoft.Storage/storageAccounts/queueServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":320},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":326},"Microsoft.Storage/storageAccounts/tableServices@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":333},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-01-01":{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":338},"Microsoft.Storage/storageAccounts@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":143},"Microsoft.Storage/storageAccounts/managementPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":167},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":194},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":198},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":207},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":219},"Microsoft.Storage/storageAccounts/blobServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":248},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":284},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":290},"Microsoft.Storage/storageAccounts/fileServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":300},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":318},"Microsoft.Storage/storageAccounts/queueServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":325},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":331},"Microsoft.Storage/storageAccounts/tableServices@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":338},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-02-01":{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":343},"Microsoft.Storage/storageAccounts@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":149},"Microsoft.Storage/storageAccounts/managementPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":173},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":210},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":214},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":223},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":235},"Microsoft.Storage/storageAccounts/blobServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":264},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":304},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":310},"Microsoft.Storage/storageAccounts/fileServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":320},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":353},"Microsoft.Storage/storageAccounts/queueServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":360},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":366},"Microsoft.Storage/storageAccounts/tableServices@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":373},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-04-01":{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":378},"Microsoft.Storage/storageAccounts@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":157},"Microsoft.Storage/storageAccounts/managementPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":181},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":218},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":222},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":231},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":243},"Microsoft.Storage/storageAccounts/blobServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":271},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":312},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":317},"Microsoft.Storage/storageAccounts/fileServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":326},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":359},"Microsoft.Storage/storageAccounts/queueServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":365},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":371},"Microsoft.Storage/storageAccounts/tableServices@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":377},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-06-01":{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":382},"Microsoft.Storage/storageAccounts@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":163},"Microsoft.Storage/storageAccounts/managementPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":187},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":224},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":228},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":237},"Microsoft.Storage/storageAccounts/localUsers@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":246},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":258},"Microsoft.Storage/storageAccounts/blobServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":286},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":327},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":332},"Microsoft.Storage/storageAccounts/fileServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":341},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":374},"Microsoft.Storage/storageAccounts/queueServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":380},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":386},"Microsoft.Storage/storageAccounts/tableServices@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":392},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-08-01":{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":397},"Microsoft.Storage/storageAccounts@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":181},"Microsoft.Storage/storageAccounts/managementPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":205},"Microsoft.Storage/storageAccounts/inventoryPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":243},"Microsoft.Storage/storageAccounts/privateEndpointConnections@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":247},"Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":256},"Microsoft.Storage/storageAccounts/localUsers@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":265},"Microsoft.Storage/storageAccounts/encryptionScopes@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":277},"Microsoft.Storage/storageAccounts/blobServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":306},"Microsoft.Storage/storageAccounts/blobServices/containers@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":347},"Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":352},"Microsoft.Storage/storageAccounts/fileServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":361},"Microsoft.Storage/storageAccounts/fileServices/shares@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":394},"Microsoft.Storage/storageAccounts/queueServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":400},"Microsoft.Storage/storageAccounts/queueServices/queues@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":406},"Microsoft.Storage/storageAccounts/tableServices@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":412},"Microsoft.Storage/storageAccounts/tableServices/tables@2021-09-01":{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":420},"Microsoft.StorageCache/caches@2019-08-01-preview":{"RelativePath":"storagecache/microsoft.storagecache/2019-08-01-preview/types.json","Index":36},"Microsoft.StorageCache/caches/storageTargets@2019-08-01-preview":{"RelativePath":"storagecache/microsoft.storagecache/2019-08-01-preview/types.json","Index":58},"Microsoft.StorageCache/caches@2019-11-01":{"RelativePath":"storagecache/microsoft.storagecache/2019-11-01/types.json","Index":36},"Microsoft.StorageCache/caches/storageTargets@2019-11-01":{"RelativePath":"storagecache/microsoft.storagecache/2019-11-01/types.json","Index":58},"Microsoft.StorageCache/caches@2020-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-03-01/types.json","Index":57},"Microsoft.StorageCache/caches/storageTargets@2020-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-03-01/types.json","Index":81},"Microsoft.StorageCache/caches@2020-10-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-10-01/types.json","Index":87},"Microsoft.StorageCache/caches/storageTargets@2020-10-01":{"RelativePath":"storagecache/microsoft.storagecache/2020-10-01/types.json","Index":111},"Microsoft.StorageCache/caches@2021-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-03-01/types.json","Index":91},"Microsoft.StorageCache/caches/storageTargets@2021-03-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-03-01/types.json","Index":115},"Microsoft.StorageCache/caches@2021-05-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-05-01/types.json","Index":95},"Microsoft.StorageCache/caches/storageTargets@2021-05-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-05-01/types.json","Index":119},"Microsoft.StorageCache/caches@2021-09-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-09-01/types.json","Index":95},"Microsoft.StorageCache/caches/storageTargets@2021-09-01":{"RelativePath":"storagecache/microsoft.storagecache/2021-09-01/types.json","Index":124},"Microsoft.StorageCache/caches@2022-01-01":{"RelativePath":"storagecache/microsoft.storagecache/2022-01-01/types.json","Index":96},"Microsoft.StorageCache/caches/storageTargets@2022-01-01":{"RelativePath":"storagecache/microsoft.storagecache/2022-01-01/types.json","Index":125},"Microsoft.ImportExport/jobs@2016-11-01":{"RelativePath":"storageimportexport/microsoft.importexport/2016-11-01/types.json","Index":51},"Microsoft.ImportExport/jobs@2020-08-01":{"RelativePath":"storageimportexport/microsoft.importexport/2020-08-01/types.json","Index":51},"Microsoft.ImportExport/jobs@2021-01-01":{"RelativePath":"storageimportexport/microsoft.importexport/2021-01-01/types.json","Index":51},"Microsoft.StoragePool/diskPools@2020-03-15-preview":{"RelativePath":"storagepool/microsoft.storagepool/2020-03-15-preview/types.json","Index":40},"Microsoft.StoragePool/diskPools/iscsiTargets@2020-03-15-preview":{"RelativePath":"storagepool/microsoft.storagepool/2020-03-15-preview/types.json","Index":73},"Microsoft.StoragePool/diskPools@2021-04-01-preview":{"RelativePath":"storagepool/microsoft.storagepool/2021-04-01-preview/types.json","Index":47},"Microsoft.StoragePool/diskPools/iscsiTargets@2021-04-01-preview":{"RelativePath":"storagepool/microsoft.storagepool/2021-04-01-preview/types.json","Index":79},"Microsoft.StoragePool/diskPools@2021-08-01":{"RelativePath":"storagepool/microsoft.storagepool/2021-08-01/types.json","Index":48},"Microsoft.StoragePool/diskPools/iscsiTargets@2021-08-01":{"RelativePath":"storagepool/microsoft.storagepool/2021-08-01/types.json","Index":82},"Microsoft.StorageSync/storageSyncServices@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":17},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":22},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":42},"Microsoft.StorageSync/storageSyncServices/registeredServers@2017-06-05-preview":{"RelativePath":"storagesync/microsoft.storagesync/2017-06-05-preview/types.json","Index":47},"Microsoft.StorageSync/storageSyncServices@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":13},"Microsoft.StorageSync/storageSyncServices/syncGroups@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":18},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":24},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":33},"Microsoft.StorageSync/storageSyncServices/registeredServers@2018-04-02":{"RelativePath":"storagesync/microsoft.storagesync/2018-04-02/types.json","Index":39},"Microsoft.StorageSync/storageSyncServices@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":29},"Microsoft.StorageSync/storageSyncServices/registeredServers@2018-07-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-07-01/types.json","Index":34},"Microsoft.StorageSync/storageSyncServices@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":64},"Microsoft.StorageSync/storageSyncServices/registeredServers@2018-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2018-10-01/types.json","Index":69},"Microsoft.StorageSync/storageSyncServices@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":64},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-02-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-02-01/types.json","Index":69},"Microsoft.StorageSync/storageSyncServices@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":64},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-03-01/types.json","Index":69},"Microsoft.StorageSync/storageSyncServices@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":71},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-06-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-06-01/types.json","Index":76},"Microsoft.StorageSync/storageSyncServices@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":12},"Microsoft.StorageSync/storageSyncServices/syncGroups@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":16},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":21},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":78},"Microsoft.StorageSync/storageSyncServices/registeredServers@2019-10-01":{"RelativePath":"storagesync/microsoft.storagesync/2019-10-01/types.json","Index":83},"Microsoft.StorageSync/storageSyncServices@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":30},"Microsoft.StorageSync/storageSyncServices/privateEndpointConnections@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":34},"Microsoft.StorageSync/storageSyncServices/syncGroups@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":38},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":43},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":119},"Microsoft.StorageSync/storageSyncServices/registeredServers@2020-03-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-03-01/types.json","Index":129},"Microsoft.StorageSync/storageSyncServices@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":41},"Microsoft.StorageSync/storageSyncServices/privateEndpointConnections@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":45},"Microsoft.StorageSync/storageSyncServices/syncGroups@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":49},"Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":63},"Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":138},"Microsoft.StorageSync/storageSyncServices/registeredServers@2020-09-01":{"RelativePath":"storagesync/microsoft.storagesync/2020-09-01/types.json","Index":148},"Microsoft.StorSimple/managers@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":19},"Microsoft.StorSimple/managers/certificates@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":58},"Microsoft.StorSimple/managers/extendedInformation@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":64},"Microsoft.StorSimple/managers/accessControlRecords@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":69},"Microsoft.StorSimple/managers/devices/alertSettings@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":82},"Microsoft.StorSimple/managers/devices/backupScheduleGroups@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":88},"Microsoft.StorSimple/managers/devices/chapSettings@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":98},"Microsoft.StorSimple/managers/devices/iscsiservers/disks@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":115},"Microsoft.StorSimple/managers/devices/fileservers@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":120},"Microsoft.StorSimple/managers/devices/fileservers/shares@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":136},"Microsoft.StorSimple/managers/devices/iscsiservers@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":141},"Microsoft.StorSimple/managers/storageAccountCredentials@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":155},"Microsoft.StorSimple/managers/storageDomains@2016-10-01":{"RelativePath":"storsimple1200series/microsoft.storsimple/2016-10-01/types.json","Index":164},"Microsoft.StorSimple/managers@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":19},"Microsoft.StorSimple/managers/extendedInformation@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":26},"Microsoft.StorSimple/managers/accessControlRecords@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":32},"Microsoft.StorSimple/managers/bandwidthSettings@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":50},"Microsoft.StorSimple/managers/devices/alertSettings@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":64},"Microsoft.StorSimple/managers/devices/timeSettings@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":72},"Microsoft.StorSimple/managers/devices/backupPolicies@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":85},"Microsoft.StorSimple/managers/devices/backupPolicies/schedules@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":112},"Microsoft.StorSimple/managers/devices/volumeContainers@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":129},"Microsoft.StorSimple/managers/devices/volumeContainers/volumes@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":155},"Microsoft.StorSimple/managers/storageAccountCredentials@2017-06-01":{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":164},"Microsoft.StreamAnalytics/streamingjobs@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":129},"Microsoft.StreamAnalytics/streamingjobs/inputs@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":133},"Microsoft.StreamAnalytics/streamingjobs/outputs@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":137},"Microsoft.StreamAnalytics/streamingjobs/transformations@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":141},"Microsoft.StreamAnalytics/streamingjobs/functions@2016-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2016-03-01/types.json","Index":145},"Microsoft.StreamAnalytics/streamingjobs/functions@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":42},"Microsoft.StreamAnalytics/streamingjobs/inputs@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":115},"Microsoft.StreamAnalytics/streamingjobs/outputs@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":194},"Microsoft.StreamAnalytics/streamingjobs@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":237},"Microsoft.StreamAnalytics/streamingjobs/transformations@2017-04-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.json","Index":241},"Microsoft.StreamAnalytics/clusters@2020-03-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.json","Index":21},"Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.json","Index":31},"Microsoft.StreamAnalytics/streamingjobs@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":212},"Microsoft.StreamAnalytics/streamingjobs/inputs@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":216},"Microsoft.StreamAnalytics/streamingjobs/outputs@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":220},"Microsoft.StreamAnalytics/streamingjobs/transformations@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":224},"Microsoft.StreamAnalytics/streamingjobs/functions@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":228},"Microsoft.StreamAnalytics/clusters@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":242},"Microsoft.StreamAnalytics/clusters/privateEndpoints@2020-03-01":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":252},"Microsoft.StreamAnalytics/streamingjobs/functions@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":45},"Microsoft.StreamAnalytics/streamingjobs/inputs@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":152},"Microsoft.StreamAnalytics/streamingjobs/outputs@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":258},"Microsoft.StreamAnalytics/streamingjobs@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":310},"Microsoft.StreamAnalytics/streamingjobs/transformations@2021-10-01-preview":{"RelativePath":"streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.json","Index":314},"Microsoft.Subscription/subscriptionDefinitions@2017-11-01-preview":{"RelativePath":"subscription/microsoft.subscription/2017-11-01-preview/types.json","Index":12},"Microsoft.Subscription/aliases@2019-10-01-preview":{"RelativePath":"subscription/microsoft.subscription/2019-10-01-preview/types.json","Index":19},"Microsoft.Subscription/aliases@2020-09-01":{"RelativePath":"subscription/microsoft.subscription/2020-09-01/types.json","Index":19},"Microsoft.Subscription/aliases@2021-10-01":{"RelativePath":"subscription/microsoft.subscription/2021-10-01/types.json","Index":37},"Microsoft.Subscription/policies@2021-10-01":{"RelativePath":"subscription/microsoft.subscription/2021-10-01/types.json","Index":45},"Microsoft.Support/supportTickets@2019-05-01-preview":{"RelativePath":"support/microsoft.support/2019-05-01-preview/types.json","Index":27},"Microsoft.Support/supportTickets/communications@2019-05-01-preview":{"RelativePath":"support/microsoft.support/2019-05-01-preview/types.json","Index":38},"Microsoft.Support/supportTickets@2020-04-01":{"RelativePath":"support/microsoft.support/2020-04-01/types.json","Index":28},"Microsoft.Support/supportTickets/communications@2020-04-01":{"RelativePath":"support/microsoft.support/2020-04-01/types.json","Index":39},"Microsoft.Synapse/workspaces/bigDataPools@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":30},"Microsoft.Synapse/workspaces/firewallRules@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":41},"Microsoft.Synapse/workspaces/sqlPools@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":53},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":59},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":69},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":85},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":95},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":106},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":118},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":127},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":140},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":151},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":162},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":171},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":186},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":191},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":196},"Microsoft.Synapse/workspaces@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":223},"Microsoft.Synapse/workspaces/administrators@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":229},"Microsoft.Synapse/workspaces/sqlAdministrators@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":234},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":250},"Microsoft.Synapse/workspaces/integrationRuntimes@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":322},"Microsoft.Synapse/workspaces/privateEndpointConnections@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":326},"Microsoft.Synapse/privateLinkHubs@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":334},"Microsoft.Synapse/workspaces/auditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":345},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":356},"Microsoft.Synapse/workspaces/securityAlertPolicies@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":369},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":376},"Microsoft.Synapse/workspaces/keys@2019-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":381},"Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2020-04-01-preview/types.json","Index":38},"Microsoft.Synapse/workspaces/sqlDatabases@2020-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2020-04-01-preview/types.json","Index":72},"Microsoft.Synapse/workspaces/bigDataPools@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":43},"Microsoft.Synapse/workspaces/sqlPools@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":59},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":65},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":75},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":91},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":101},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":112},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":124},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":133},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":146},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":157},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":168},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":177},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":192},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":197},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":202},"Microsoft.Synapse/workspaces@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":228},"Microsoft.Synapse/workspaces/administrators@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":234},"Microsoft.Synapse/workspaces/sqlAdministrators@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":239},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":255},"Microsoft.Synapse/workspaces/integrationRuntimes@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":324},"Microsoft.Synapse/workspaces/privateEndpointConnections@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":328},"Microsoft.Synapse/privateLinkHubs@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":336},"Microsoft.Synapse/workspaces/auditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":347},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":358},"Microsoft.Synapse/workspaces/securityAlertPolicies@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":371},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":378},"Microsoft.Synapse/workspaces/encryptionProtector@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":388},"Microsoft.Synapse/workspaces/keys@2020-12-01":{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":393},"Microsoft.Synapse/workspaces/bigDataPools@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":43},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":112},"Microsoft.Synapse/workspaces/keys@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":117},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":124},"Microsoft.Synapse/privateLinkHubs@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":132},"Microsoft.Synapse/workspaces/sqlPools@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":148},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":154},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":164},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":190},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":201},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":213},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":222},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":235},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":246},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":257},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":266},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":281},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":286},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":291},"Microsoft.Synapse/workspaces/auditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":302},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":313},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":326},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":333},"Microsoft.Synapse/workspaces/encryptionProtector@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":343},"Microsoft.Synapse/workspaces@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":369},"Microsoft.Synapse/workspaces/administrators@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":375},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":380},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-03-01":{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":396},"Microsoft.Synapse/workspaces/bigDataPools@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":43},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":112},"Microsoft.Synapse/workspaces/keys@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":117},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":124},"Microsoft.Synapse/privateLinkHubs@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":132},"Microsoft.Synapse/workspaces/sqlPools@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":148},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":154},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":164},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":190},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":201},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":213},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":222},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":235},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":246},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":257},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":266},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":281},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":286},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":291},"Microsoft.Synapse/workspaces/auditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":302},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":313},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":326},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":333},"Microsoft.Synapse/workspaces/encryptionProtector@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":343},"Microsoft.Synapse/workspaces@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":369},"Microsoft.Synapse/workspaces/administrators@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":375},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":380},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":396},"Microsoft.Synapse/workspaces/kustoPools@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":464},"Microsoft.Synapse/workspaces/kustoPools/databases@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":480},"Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":576},"Microsoft.Synapse/workspaces/kustoPools/principalAssignments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":596},"Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments@2021-04-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":620},"Microsoft.Synapse/workspaces/bigDataPools@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":32},"Microsoft.Synapse/workspaces/firewallRules@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":43},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":112},"Microsoft.Synapse/workspaces/keys@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":117},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":124},"Microsoft.Synapse/privateLinkHubs@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":132},"Microsoft.Synapse/workspaces/sqlPools@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":148},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":154},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":164},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":190},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":201},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":213},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":222},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":235},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":246},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":257},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":266},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":281},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":286},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":291},"Microsoft.Synapse/workspaces/auditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":302},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":313},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":326},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":333},"Microsoft.Synapse/workspaces/encryptionProtector@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":343},"Microsoft.Synapse/workspaces@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":374},"Microsoft.Synapse/workspaces/administrators@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":380},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":385},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-05-01":{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":401},"Microsoft.Synapse/workspaces/bigDataPools@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":36},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":106},"Microsoft.Synapse/workspaces/kustoPools@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":157},"Microsoft.Synapse/workspaces/kustoPools/attachedDatabaseConfigurations@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":182},"Microsoft.Synapse/workspaces/kustoPools/databases@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":213},"Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":309},"Microsoft.Synapse/workspaces/kustoPools/principalAssignments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":329},"Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":353},"Microsoft.Synapse/workspaces/firewallRules@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":364},"Microsoft.Synapse/workspaces/keys@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":369},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":376},"Microsoft.Synapse/privateLinkHubs@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":384},"Microsoft.Synapse/workspaces/sqlPools@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":399},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":405},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":415},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":431},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":441},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":452},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":464},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":473},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":486},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":497},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":508},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":517},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":532},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":537},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":542},"Microsoft.Synapse/workspaces/auditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":553},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":564},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":577},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":584},"Microsoft.Synapse/workspaces/encryptionProtector@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":594},"Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":601},"Microsoft.Synapse/workspaces@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":633},"Microsoft.Synapse/workspaces/administrators@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":639},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":644},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":660},"Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01-preview":{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":671},"Microsoft.Synapse/workspaces/azureADOnlyAuthentications@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":18},"Microsoft.Synapse/workspaces/firewallRules@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":29},"Microsoft.Synapse/workspaces/keys@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":34},"Microsoft.Synapse/workspaces/privateEndpointConnections@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":41},"Microsoft.Synapse/privateLinkHubs@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":49},"Microsoft.Synapse/workspaces/sqlPools@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":64},"Microsoft.Synapse/workspaces/sqlPools/metadataSync@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":70},"Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":80},"Microsoft.Synapse/workspaces/sqlPools/maintenancewindows@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":96},"Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":106},"Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":116},"Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":128},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":137},"Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":150},"Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":161},"Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":171},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":180},"Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":195},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":200},"Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":205},"Microsoft.Synapse/workspaces/auditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":216},"Microsoft.Synapse/workspaces/extendedAuditingSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":227},"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":240},"Microsoft.Synapse/workspaces/vulnerabilityAssessments@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":247},"Microsoft.Synapse/workspaces/encryptionProtector@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":257},"Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":264},"Microsoft.Synapse/workspaces@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":296},"Microsoft.Synapse/workspaces/administrators@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":302},"Microsoft.Synapse/workspaces/sqlAdministrators@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":307},"Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":323},"Microsoft.Synapse/workspaces/bigDataPools@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":352},"Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01":{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":423},"Microsoft.TestBase/testBaseAccounts@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":37},"Microsoft.TestBase/testBaseAccounts/packages@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":92},"Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":97},"Microsoft.TestBase/testBaseAccounts/customerEvents@2020-12-16-preview":{"RelativePath":"testbase/microsoft.testbase/2020-12-16-preview/types.json","Index":110},"Microsoft.TimeSeriesInsights/environments@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":28},"Microsoft.TimeSeriesInsights/environments/eventSources@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":62},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":81},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-02-28-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-02-28-preview/types.json","Index":89},"Microsoft.TimeSeriesInsights/environments@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":40},"Microsoft.TimeSeriesInsights/environments/eventSources@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":74},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":96},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2017-11-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2017-11-15/types.json","Index":104},"Microsoft.TimeSeriesInsights/environments@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":64},"Microsoft.TimeSeriesInsights/environments/eventSources@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":91},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":113},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2018-08-15-preview":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2018-08-15-preview/types.json","Index":121},"Microsoft.TimeSeriesInsights/environments@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":57},"Microsoft.TimeSeriesInsights/environments/eventSources@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":84},"Microsoft.TimeSeriesInsights/environments/referenceDataSets@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":106},"Microsoft.TimeSeriesInsights/environments/accessPolicies@2020-05-15":{"RelativePath":"timeseriesinsights/microsoft.timeseriesinsights/2020-05-15/types.json","Index":114},"Microsoft.Network/trafficmanagerprofiles@2015-11-01":{"RelativePath":"trafficmanager/microsoft.network/2015-11-01/types.json","Index":18},"Microsoft.Network/trafficmanagerprofiles@2017-03-01":{"RelativePath":"trafficmanager/microsoft.network/2017-03-01/types.json","Index":19},"Microsoft.Network/trafficmanagerprofiles@2017-05-01":{"RelativePath":"trafficmanager/microsoft.network/2017-05-01/types.json","Index":47},"Microsoft.Network/trafficmanagerprofiles@2018-02-01":{"RelativePath":"trafficmanager/microsoft.network/2018-02-01/types.json","Index":50},"Microsoft.Network/trafficmanagerprofiles@2018-03-01":{"RelativePath":"trafficmanager/microsoft.network/2018-03-01/types.json","Index":56},"Microsoft.Network/trafficmanagerprofiles@2018-04-01":{"RelativePath":"trafficmanager/microsoft.network/2018-04-01/types.json","Index":60},"Microsoft.Network/trafficManagerUserMetricsKeys@2018-04-01":{"RelativePath":"trafficmanager/microsoft.network/2018-04-01/types.json","Index":66},"Microsoft.Network/trafficmanagerprofiles/AzureEndpoints@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":27},"Microsoft.Network/trafficmanagerprofiles/ExternalEndpoints@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":31},"Microsoft.Network/trafficmanagerprofiles/NestedEndpoints@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":35},"Microsoft.Network/trafficmanagerprofiles@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":78},"Microsoft.Network/trafficManagerUserMetricsKeys@2018-08-01":{"RelativePath":"trafficmanager/microsoft.network/2018-08-01/types.json","Index":84},"Microsoft.VideoIndexer/accounts@2021-10-18-preview":{"RelativePath":"vi/microsoft.videoindexer/2021-10-18-preview/types.json","Index":40},"Microsoft.VideoIndexer/accounts@2021-10-27-preview":{"RelativePath":"vi/microsoft.videoindexer/2021-10-27-preview/types.json","Index":40},"Microsoft.VideoIndexer/accounts@2021-11-10-preview":{"RelativePath":"vi/microsoft.videoindexer/2021-11-10-preview/types.json","Index":40},"Microsoft.Media/videoAnalyzers@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":39},"Microsoft.Media/videoAnalyzers/edgeModules@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":44},"Microsoft.Media/videoAnalyzers/videos@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":54},"Microsoft.Media/videoAnalyzers/accessPolicies@2021-05-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":82},"Microsoft.Media/videoAnalyzers/edgeModules@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":23},"Microsoft.Media/videoAnalyzers/pipelineTopologies@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":107},"Microsoft.Media/videoAnalyzers/livePipelines@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":119},"Microsoft.Media/videoAnalyzers/pipelineJobs@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":131},"Microsoft.Media/videoAnalyzers@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":180},"Microsoft.Media/videoAnalyzers/privateEndpointConnections@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":184},"Microsoft.Media/videoAnalyzers/videos@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":197},"Microsoft.Media/videoAnalyzers/accessPolicies@2021-11-01-preview":{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":225},"microsoft.visualstudio/account@2014-04-01-preview":{"RelativePath":"visualstudio/microsoft.visualstudio/2014-04-01-preview/types.json","Index":18},"microsoft.visualstudio/account/extension@2014-04-01-preview":{"RelativePath":"visualstudio/microsoft.visualstudio/2014-04-01-preview/types.json","Index":25},"microsoft.visualstudio/account/project@2014-04-01-preview":{"RelativePath":"visualstudio/microsoft.visualstudio/2014-04-01-preview/types.json","Index":31},"Microsoft.AVS/privateClouds@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":40},"Microsoft.AVS/privateClouds/clusters@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":52},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":62},"Microsoft.AVS/privateClouds/authorizations@2020-03-20":{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":71},"Microsoft.AVS/privateClouds@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":40},"Microsoft.AVS/privateClouds/clusters@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":52},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":62},"Microsoft.AVS/privateClouds/authorizations@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":71},"Microsoft.AVS/privateClouds/globalReachConnections@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":84},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":101},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":118},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":133},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":147},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":168},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":181},"Microsoft.AVS/privateClouds/addons@2020-07-17-preview":{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":195},"Microsoft.AVS/privateClouds@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":40},"Microsoft.AVS/privateClouds/clusters@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":52},"Microsoft.AVS/privateClouds/clusters/datastores@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":66},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":76},"Microsoft.AVS/privateClouds/authorizations@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":85},"Microsoft.AVS/privateClouds/globalReachConnections@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":98},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":115},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":132},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":147},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":161},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":182},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":195},"Microsoft.AVS/privateClouds/addons@2021-01-01-preview":{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":210},"Microsoft.AVS/privateClouds@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":41},"Microsoft.AVS/privateClouds/clusters@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":53},"Microsoft.AVS/privateClouds/clusters/datastores@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":71},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":81},"Microsoft.AVS/privateClouds/authorizations@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":90},"Microsoft.AVS/privateClouds/globalReachConnections@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":103},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":120},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":137},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":152},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":166},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":187},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":200},"Microsoft.AVS/privateClouds/workloadNetworks/publicIPs@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":211},"Microsoft.AVS/privateClouds/cloudLinks@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":222},"Microsoft.AVS/privateClouds/addons@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":240},"Microsoft.AVS/privateClouds/scriptExecutions@2021-06-01":{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":267},"Microsoft.AVS/privateClouds@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":60},"Microsoft.AVS/privateClouds/clusters@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":72},"Microsoft.AVS/privateClouds/clusters/datastores@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":98},"Microsoft.AVS/privateClouds/hcxEnterpriseSites@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":108},"Microsoft.AVS/privateClouds/authorizations@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":117},"Microsoft.AVS/privateClouds/globalReachConnections@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":130},"Microsoft.AVS/privateClouds/workloadNetworks/segments@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":148},"Microsoft.AVS/privateClouds/workloadNetworks/dhcpConfigurations@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":165},"Microsoft.AVS/privateClouds/workloadNetworks/portMirroringProfiles@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":183},"Microsoft.AVS/privateClouds/workloadNetworks/vmGroups@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":198},"Microsoft.AVS/privateClouds/workloadNetworks/dnsServices@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":219},"Microsoft.AVS/privateClouds/workloadNetworks/dnsZones@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":232},"Microsoft.AVS/privateClouds/workloadNetworks/publicIPs@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":243},"Microsoft.AVS/privateClouds/cloudLinks@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":254},"Microsoft.AVS/privateClouds/addons@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":272},"Microsoft.AVS/privateClouds/clusters/placementPolicies@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":299},"Microsoft.AVS/privateClouds/scriptExecutions@2021-12-01":{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":326},"Microsoft.VMwareCloudSimple/dedicatedCloudNodes@2019-04-01":{"RelativePath":"vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.json","Index":18},"Microsoft.VMwareCloudSimple/dedicatedCloudServices@2019-04-01":{"RelativePath":"vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.json","Index":29},"Microsoft.VMwareCloudSimple/virtualMachines@2019-04-01":{"RelativePath":"vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.json","Index":77},"Microsoft.CertificateRegistration/certificateOrders/certificates@2015-08-01":{"RelativePath":"web/microsoft.certificateregistration/2015-08-01/types.json","Index":24},"Microsoft.CertificateRegistration/certificateOrders@2015-08-01":{"RelativePath":"web/microsoft.certificateregistration/2015-08-01/types.json","Index":56},"Microsoft.CertificateRegistration/certificateOrders@2018-02-01":{"RelativePath":"web/microsoft.certificateregistration/2018-02-01/types.json","Index":53},"Microsoft.CertificateRegistration/certificateOrders/certificates@2018-02-01":{"RelativePath":"web/microsoft.certificateregistration/2018-02-01/types.json","Index":58},"Microsoft.CertificateRegistration/certificateOrders@2019-08-01":{"RelativePath":"web/microsoft.certificateregistration/2019-08-01/types.json","Index":53},"Microsoft.CertificateRegistration/certificateOrders/certificates@2019-08-01":{"RelativePath":"web/microsoft.certificateregistration/2019-08-01/types.json","Index":58},"Microsoft.CertificateRegistration/certificateOrders@2020-06-01":{"RelativePath":"web/microsoft.certificateregistration/2020-06-01/types.json","Index":53},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-06-01":{"RelativePath":"web/microsoft.certificateregistration/2020-06-01/types.json","Index":58},"Microsoft.CertificateRegistration/certificateOrders@2020-09-01":{"RelativePath":"web/microsoft.certificateregistration/2020-09-01/types.json","Index":64},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-09-01":{"RelativePath":"web/microsoft.certificateregistration/2020-09-01/types.json","Index":69},"Microsoft.CertificateRegistration/certificateOrders@2020-10-01":{"RelativePath":"web/microsoft.certificateregistration/2020-10-01/types.json","Index":64},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-10-01":{"RelativePath":"web/microsoft.certificateregistration/2020-10-01/types.json","Index":69},"Microsoft.CertificateRegistration/certificateOrders@2020-12-01":{"RelativePath":"web/microsoft.certificateregistration/2020-12-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-12-01":{"RelativePath":"web/microsoft.certificateregistration/2020-12-01/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-01-01":{"RelativePath":"web/microsoft.certificateregistration/2021-01-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-01":{"RelativePath":"web/microsoft.certificateregistration/2021-01-01/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-01-15":{"RelativePath":"web/microsoft.certificateregistration/2021-01-15/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-15":{"RelativePath":"web/microsoft.certificateregistration/2021-01-15/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-02-01":{"RelativePath":"web/microsoft.certificateregistration/2021-02-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-02-01":{"RelativePath":"web/microsoft.certificateregistration/2021-02-01/types.json","Index":59},"Microsoft.CertificateRegistration/certificateOrders@2021-03-01":{"RelativePath":"web/microsoft.certificateregistration/2021-03-01/types.json","Index":54},"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-03-01":{"RelativePath":"web/microsoft.certificateregistration/2021-03-01/types.json","Index":59},"Microsoft.DomainRegistration/domains@2015-04-01":{"RelativePath":"web/microsoft.domainregistration/2015-04-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2015-04-01":{"RelativePath":"web/microsoft.domainregistration/2015-04-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2015-08-01":{"RelativePath":"web/microsoft.domainregistration/2015-08-01/types.json","Index":63},"Microsoft.DomainRegistration/domains@2018-02-01":{"RelativePath":"web/microsoft.domainregistration/2018-02-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2018-02-01":{"RelativePath":"web/microsoft.domainregistration/2018-02-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2019-08-01":{"RelativePath":"web/microsoft.domainregistration/2019-08-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2019-08-01":{"RelativePath":"web/microsoft.domainregistration/2019-08-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2020-06-01":{"RelativePath":"web/microsoft.domainregistration/2020-06-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-06-01":{"RelativePath":"web/microsoft.domainregistration/2020-06-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2020-09-01":{"RelativePath":"web/microsoft.domainregistration/2020-09-01/types.json","Index":80},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-09-01":{"RelativePath":"web/microsoft.domainregistration/2020-09-01/types.json","Index":85},"Microsoft.DomainRegistration/domains@2020-10-01":{"RelativePath":"web/microsoft.domainregistration/2020-10-01/types.json","Index":80},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-10-01":{"RelativePath":"web/microsoft.domainregistration/2020-10-01/types.json","Index":85},"Microsoft.DomainRegistration/domains@2020-12-01":{"RelativePath":"web/microsoft.domainregistration/2020-12-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-12-01":{"RelativePath":"web/microsoft.domainregistration/2020-12-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-01-01":{"RelativePath":"web/microsoft.domainregistration/2021-01-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-01":{"RelativePath":"web/microsoft.domainregistration/2021-01-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-01-15":{"RelativePath":"web/microsoft.domainregistration/2021-01-15/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-15":{"RelativePath":"web/microsoft.domainregistration/2021-01-15/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-02-01":{"RelativePath":"web/microsoft.domainregistration/2021-02-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-02-01":{"RelativePath":"web/microsoft.domainregistration/2021-02-01/types.json","Index":74},"Microsoft.DomainRegistration/domains@2021-03-01":{"RelativePath":"web/microsoft.domainregistration/2021-03-01/types.json","Index":69},"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-03-01":{"RelativePath":"web/microsoft.domainregistration/2021-03-01/types.json","Index":74},"Microsoft.Web/connections@2015-08-01-preview":{"RelativePath":"web/microsoft.web/2015-08-01-preview/types.json","Index":71},"Microsoft.Web/certificates@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":15},"Microsoft.Web/csrs@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":21},"Microsoft.Web/hostingEnvironments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":73},"Microsoft.Web/hostingEnvironments/multiRolePools@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":79},"Microsoft.Web/hostingEnvironments/workerPools@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":84},"Microsoft.Web/managedHostingEnvironments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":89},"Microsoft.Web/sourcecontrols@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":95},"Microsoft.Web/publishingUsers@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":102},"Microsoft.Web/serverfarms@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":111},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":117},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":123},"Microsoft.Web/sites/slots/virtualNetworkConnections@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":132},"Microsoft.Web/sites/virtualNetworkConnections@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":137},"Microsoft.Web/sites/config@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":290},"Microsoft.Web/sites@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":316},"Microsoft.Web/sites/slots@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":321},"Microsoft.Web/sites/instances/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":327},"Microsoft.Web/sites/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":332},"Microsoft.Web/sites/slots/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":337},"Microsoft.Web/sites/slots/instances/deployments@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":342},"Microsoft.Web/sites/hostNameBindings@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":357},"Microsoft.Web/sites/slots/hostNameBindings@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":362},"Microsoft.Web/sites/slots/config@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":416},"Microsoft.Web/sites/sourcecontrols@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":423},"Microsoft.Web/sites/slots/sourcecontrols@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":429},"Microsoft.Web/sites/premieraddons@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":435},"Microsoft.Web/sites/slots/premieraddons@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":440},"Microsoft.Web/sites/backups@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":452},"Microsoft.Web/sites/slots/backups@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":458},"Microsoft.Web/sites/hybridconnection@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":464},"Microsoft.Web/sites/slots/hybridconnection@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":469},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":474},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2015-08-01":{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":479},"Microsoft.Web/certificates@2016-03-01":{"RelativePath":"web/microsoft.web/2016-03-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2016-03-01":{"RelativePath":"web/microsoft.web/2016-03-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2016-03-01":{"RelativePath":"web/microsoft.web/2016-03-01/types.json","Index":38},"Microsoft.Web/connectionGateways@2016-06-01":{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":15},"Microsoft.Web/customApis@2016-06-01":{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":52},"Microsoft.Web/connections@2016-06-01":{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":69},"Microsoft.Web/sites@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":117},"Microsoft.Web/sites/backups@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":135},"Microsoft.Web/sites/config@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":246},"Microsoft.Web/sites/deployments@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":251},"Microsoft.Web/sites/domainOwnershipIdentifiers@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":256},"Microsoft.Web/sites/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":269},"Microsoft.Web/sites/functions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":275},"Microsoft.Web/sites/hostNameBindings@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":293},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":298},"Microsoft.Web/sites/hybridconnection@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":303},"Microsoft.Web/sites/instances/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":308},"Microsoft.Web/sites/premieraddons@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":315},"Microsoft.Web/sites/publicCertificates@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":324},"Microsoft.Web/sites/siteextensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":333},"Microsoft.Web/sites/slots@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":338},"Microsoft.Web/sites/slots/backups@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":343},"Microsoft.Web/sites/slots/config@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":380},"Microsoft.Web/sites/slots/deployments@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":384},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":388},"Microsoft.Web/sites/slots/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":393},"Microsoft.Web/sites/slots/functions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":397},"Microsoft.Web/sites/slots/hostNameBindings@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":401},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":405},"Microsoft.Web/sites/slots/hybridconnection@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":409},"Microsoft.Web/sites/slots/instances/extensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":414},"Microsoft.Web/sites/slots/premieraddons@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":419},"Microsoft.Web/sites/slots/publicCertificates@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":423},"Microsoft.Web/sites/slots/siteextensions@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":427},"Microsoft.Web/sites/slots/sourcecontrols@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":433},"Microsoft.Web/sites/slots/virtualNetworkConnections@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":445},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":450},"Microsoft.Web/sites/sourcecontrols@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":455},"Microsoft.Web/sites/virtualNetworkConnections@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":459},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2016-08-01":{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":463},"Microsoft.Web/hostingEnvironments@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":60},"Microsoft.Web/hostingEnvironments/multiRolePools@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":70},"Microsoft.Web/hostingEnvironments/workerPools@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":74},"Microsoft.Web/serverfarms@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":91},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":96},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2016-09-01":{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":105},"Microsoft.Web/publishingUsers@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":13},"Microsoft.Web/sourcecontrols@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":18},"Microsoft.Web/hostingEnvironments@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":71},"Microsoft.Web/hostingEnvironments/multiRolePools@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":81},"Microsoft.Web/hostingEnvironments/workerPools@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":85},"Microsoft.Web/serverfarms@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":102},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":107},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":116},"Microsoft.Web/sites@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":251},"Microsoft.Web/sites/config@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":369},"Microsoft.Web/sites/deployments@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":374},"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":379},"Microsoft.Web/sites/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":392},"Microsoft.Web/sites/functions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":398},"Microsoft.Web/sites/functions/keys@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":402},"Microsoft.Web/sites/hostNameBindings@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":420},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":425},"Microsoft.Web/sites/hybridconnection@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":430},"Microsoft.Web/sites/instances/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":435},"Microsoft.Web/sites/networkConfig@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":441},"Microsoft.Web/sites/premieraddons@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":447},"Microsoft.Web/sites/privateAccess@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":457},"Microsoft.Web/sites/publicCertificates@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":466},"Microsoft.Web/sites/siteextensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":475},"Microsoft.Web/sites/slots@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":480},"Microsoft.Web/sites/slots/config@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":522},"Microsoft.Web/sites/slots/deployments@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":526},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":530},"Microsoft.Web/sites/slots/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":535},"Microsoft.Web/sites/slots/functions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":539},"Microsoft.Web/sites/slots/functions/keys@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":543},"Microsoft.Web/sites/slots/hostNameBindings@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":547},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":551},"Microsoft.Web/sites/slots/hybridconnection@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":555},"Microsoft.Web/sites/slots/instances/extensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":560},"Microsoft.Web/sites/slots/networkConfig@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":565},"Microsoft.Web/sites/slots/premieraddons@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":570},"Microsoft.Web/sites/slots/privateAccess@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":575},"Microsoft.Web/sites/slots/publicCertificates@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":579},"Microsoft.Web/sites/slots/siteextensions@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":583},"Microsoft.Web/sites/slots/sourcecontrols@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":589},"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":596},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":600},"Microsoft.Web/sites/sourcecontrols@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":605},"Microsoft.Web/sites/virtualNetworkConnections@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":609},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":613},"Microsoft.Web/certificates@2018-02-01":{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":632},"Microsoft.Web/certificates@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":27},"Microsoft.Web/sites@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":163},"Microsoft.Web/sites/config@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":281},"Microsoft.Web/sites/deployments@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":286},"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":291},"Microsoft.Web/sites/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":304},"Microsoft.Web/sites/functions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":310},"Microsoft.Web/sites/hostNameBindings@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":328},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":333},"Microsoft.Web/sites/hybridconnection@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":338},"Microsoft.Web/sites/instances/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":343},"Microsoft.Web/sites/networkConfig@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":349},"Microsoft.Web/sites/premieraddons@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":355},"Microsoft.Web/sites/privateAccess@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":365},"Microsoft.Web/sites/publicCertificates@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":374},"Microsoft.Web/sites/siteextensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":383},"Microsoft.Web/sites/slots@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":388},"Microsoft.Web/sites/slots/config@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":430},"Microsoft.Web/sites/slots/deployments@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":434},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":438},"Microsoft.Web/sites/slots/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":443},"Microsoft.Web/sites/slots/functions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":447},"Microsoft.Web/sites/slots/hostNameBindings@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":451},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":455},"Microsoft.Web/sites/slots/hybridconnection@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":459},"Microsoft.Web/sites/slots/instances/extensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":464},"Microsoft.Web/sites/slots/networkConfig@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":469},"Microsoft.Web/sites/slots/premieraddons@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":474},"Microsoft.Web/sites/slots/privateAccess@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":479},"Microsoft.Web/sites/slots/publicCertificates@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":483},"Microsoft.Web/sites/slots/siteextensions@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":487},"Microsoft.Web/sites/slots/sourcecontrols@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":493},"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":505},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":510},"Microsoft.Web/sites/sourcecontrols@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":515},"Microsoft.Web/sites/virtualNetworkConnections@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":519},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-11-01":{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":523},"Microsoft.Web/certificates@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":38},"Microsoft.Web/sites@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":165},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":176},"Microsoft.Web/sites/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":302},"Microsoft.Web/sites/deployments@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":307},"Microsoft.Web/sites/domainOwnershipIdentifiers@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":312},"Microsoft.Web/sites/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":325},"Microsoft.Web/sites/functions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":331},"Microsoft.Web/sites/functions/keys@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":335},"Microsoft.Web/sites/hostNameBindings@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":353},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":358},"Microsoft.Web/sites/hybridconnection@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":363},"Microsoft.Web/sites/instances/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":368},"Microsoft.Web/sites/networkConfig@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":374},"Microsoft.Web/sites/premieraddons@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":380},"Microsoft.Web/sites/privateAccess@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":390},"Microsoft.Web/sites/publicCertificates@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":399},"Microsoft.Web/sites/siteextensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":408},"Microsoft.Web/sites/slots@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":413},"Microsoft.Web/sites/slots/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":455},"Microsoft.Web/sites/slots/deployments@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":459},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":463},"Microsoft.Web/sites/slots/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":468},"Microsoft.Web/sites/slots/functions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":472},"Microsoft.Web/sites/slots/functions/keys@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":476},"Microsoft.Web/sites/slots/hostNameBindings@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":480},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":484},"Microsoft.Web/sites/slots/hybridconnection@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":488},"Microsoft.Web/sites/slots/instances/extensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":493},"Microsoft.Web/sites/slots/networkConfig@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":498},"Microsoft.Web/sites/slots/premieraddons@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":503},"Microsoft.Web/sites/slots/privateAccess@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":508},"Microsoft.Web/sites/privateEndpointConnections@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":515},"Microsoft.Web/sites/slots/publicCertificates@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":519},"Microsoft.Web/sites/slots/siteextensions@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":523},"Microsoft.Web/sites/slots/sourcecontrols@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":529},"Microsoft.Web/sites/slots/virtualNetworkConnections@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":541},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":546},"Microsoft.Web/sites/sourcecontrols@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":551},"Microsoft.Web/sites/virtualNetworkConnections@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":555},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":559},"Microsoft.Web/staticSites@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":572},"Microsoft.Web/staticSites/builds/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":578},"Microsoft.Web/staticSites/config@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":584},"Microsoft.Web/staticSites/customDomains@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":588},"Microsoft.Web/hostingEnvironments@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":641},"Microsoft.Web/hostingEnvironments/multiRolePools@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":646},"Microsoft.Web/hostingEnvironments/workerPools@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":650},"Microsoft.Web/serverfarms@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":666},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":670},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2019-08-01":{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":674},"Microsoft.Web/certificates@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":38},"Microsoft.Web/sites@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":175},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":186},"Microsoft.Web/sites/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":406},"Microsoft.Web/sites/deployments@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":411},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":416},"Microsoft.Web/sites/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":429},"Microsoft.Web/sites/functions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":435},"Microsoft.Web/sites/functions/keys@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":439},"Microsoft.Web/sites/hostNameBindings@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":457},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":462},"Microsoft.Web/sites/hybridconnection@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":467},"Microsoft.Web/sites/instances/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":472},"Microsoft.Web/sites/networkConfig@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":478},"Microsoft.Web/sites/premieraddons@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":484},"Microsoft.Web/sites/privateAccess@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":494},"Microsoft.Web/sites/publicCertificates@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":503},"Microsoft.Web/sites/siteextensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":512},"Microsoft.Web/sites/slots@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":517},"Microsoft.Web/sites/slots/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":563},"Microsoft.Web/sites/slots/deployments@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":567},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":571},"Microsoft.Web/sites/slots/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":576},"Microsoft.Web/sites/slots/functions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":580},"Microsoft.Web/sites/slots/functions/keys@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":584},"Microsoft.Web/sites/slots/hostNameBindings@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":588},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":592},"Microsoft.Web/sites/slots/hybridconnection@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":596},"Microsoft.Web/sites/slots/instances/extensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":601},"Microsoft.Web/sites/slots/networkConfig@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":606},"Microsoft.Web/sites/slots/premieraddons@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":611},"Microsoft.Web/sites/slots/privateAccess@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":616},"Microsoft.Web/sites/privateEndpointConnections@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":623},"Microsoft.Web/sites/slots/publicCertificates@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":627},"Microsoft.Web/sites/slots/siteextensions@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":631},"Microsoft.Web/sites/slots/sourcecontrols@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":637},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":649},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":654},"Microsoft.Web/sites/sourcecontrols@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":659},"Microsoft.Web/sites/virtualNetworkConnections@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":663},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":667},"Microsoft.Web/staticSites@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":680},"Microsoft.Web/staticSites/builds/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":686},"Microsoft.Web/staticSites/config@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":692},"Microsoft.Web/staticSites/customDomains@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":696},"Microsoft.Web/hostingEnvironments@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":750},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":755},"Microsoft.Web/hostingEnvironments/workerPools@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":759},"Microsoft.Web/serverfarms@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":775},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":779},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-06-01":{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":783},"Microsoft.Web/certificates@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":38},"Microsoft.Web/publishingUsers@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":44},"Microsoft.Web/sourcecontrols@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":49},"Microsoft.Web/sites@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":186},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":197},"Microsoft.Web/sites/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":417},"Microsoft.Web/sites/deployments@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":422},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":427},"Microsoft.Web/sites/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":440},"Microsoft.Web/sites/functions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":446},"Microsoft.Web/sites/functions/keys@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":450},"Microsoft.Web/sites/hostNameBindings@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":468},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":473},"Microsoft.Web/sites/hybridconnection@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":478},"Microsoft.Web/sites/instances/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":483},"Microsoft.Web/sites/networkConfig@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":489},"Microsoft.Web/sites/premieraddons@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":495},"Microsoft.Web/sites/privateAccess@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":505},"Microsoft.Web/sites/publicCertificates@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":514},"Microsoft.Web/sites/siteextensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":523},"Microsoft.Web/sites/slots@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":528},"Microsoft.Web/sites/slots/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":574},"Microsoft.Web/sites/slots/deployments@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":578},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":582},"Microsoft.Web/sites/slots/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":587},"Microsoft.Web/sites/slots/functions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":591},"Microsoft.Web/sites/slots/functions/keys@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":595},"Microsoft.Web/sites/slots/hostNameBindings@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":599},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":603},"Microsoft.Web/sites/slots/hybridconnection@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":607},"Microsoft.Web/sites/slots/instances/extensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":612},"Microsoft.Web/sites/slots/networkConfig@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":617},"Microsoft.Web/sites/slots/premieraddons@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":622},"Microsoft.Web/sites/slots/privateAccess@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":627},"Microsoft.Web/sites/privateEndpointConnections@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":634},"Microsoft.Web/sites/slots/publicCertificates@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":638},"Microsoft.Web/sites/slots/siteextensions@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":642},"Microsoft.Web/sites/slots/sourcecontrols@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":648},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":660},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":665},"Microsoft.Web/sites/sourcecontrols@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":670},"Microsoft.Web/sites/virtualNetworkConnections@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":674},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":678},"Microsoft.Web/staticSites@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":691},"Microsoft.Web/staticSites/builds/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":697},"Microsoft.Web/staticSites/config@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":703},"Microsoft.Web/staticSites/customDomains@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":707},"Microsoft.Web/hostingEnvironments@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":761},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":766},"Microsoft.Web/hostingEnvironments/workerPools@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":770},"Microsoft.Web/serverfarms@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":786},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":790},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-09-01":{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":794},"Microsoft.Web/certificates@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":38},"Microsoft.Web/publishingUsers@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":44},"Microsoft.Web/sourcecontrols@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":49},"Microsoft.Web/sites@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":186},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":197},"Microsoft.Web/sites/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":417},"Microsoft.Web/sites/deployments@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":422},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":427},"Microsoft.Web/sites/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":440},"Microsoft.Web/sites/functions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":446},"Microsoft.Web/sites/functions/keys@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":450},"Microsoft.Web/sites/hostNameBindings@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":468},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":473},"Microsoft.Web/sites/hybridconnection@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":478},"Microsoft.Web/sites/instances/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":483},"Microsoft.Web/sites/networkConfig@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":489},"Microsoft.Web/sites/premieraddons@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":495},"Microsoft.Web/sites/privateAccess@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":505},"Microsoft.Web/sites/publicCertificates@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":514},"Microsoft.Web/sites/siteextensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":523},"Microsoft.Web/sites/slots@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":528},"Microsoft.Web/sites/slots/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":574},"Microsoft.Web/sites/slots/deployments@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":578},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":582},"Microsoft.Web/sites/slots/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":587},"Microsoft.Web/sites/slots/functions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":591},"Microsoft.Web/sites/slots/functions/keys@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":595},"Microsoft.Web/sites/slots/hostNameBindings@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":599},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":603},"Microsoft.Web/sites/slots/hybridconnection@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":607},"Microsoft.Web/sites/slots/instances/extensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":612},"Microsoft.Web/sites/slots/networkConfig@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":617},"Microsoft.Web/sites/slots/premieraddons@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":622},"Microsoft.Web/sites/slots/privateAccess@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":627},"Microsoft.Web/sites/privateEndpointConnections@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":634},"Microsoft.Web/sites/slots/publicCertificates@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":638},"Microsoft.Web/sites/slots/siteextensions@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":642},"Microsoft.Web/sites/slots/sourcecontrols@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":648},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":660},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":665},"Microsoft.Web/sites/sourcecontrols@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":670},"Microsoft.Web/sites/virtualNetworkConnections@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":674},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":678},"Microsoft.Web/staticSites@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":691},"Microsoft.Web/staticSites/builds/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":697},"Microsoft.Web/staticSites/config@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":703},"Microsoft.Web/staticSites/customDomains@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":707},"Microsoft.Web/hostingEnvironments@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":761},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":766},"Microsoft.Web/hostingEnvironments/workerPools@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":770},"Microsoft.Web/serverfarms@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":786},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":790},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-10-01":{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":794},"Microsoft.Web/certificates@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":27},"Microsoft.Web/publishingUsers@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":33},"Microsoft.Web/sourcecontrols@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":38},"Microsoft.Web/sites@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":190},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":201},"Microsoft.Web/sites/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":386},"Microsoft.Web/sites/deployments@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":391},"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":396},"Microsoft.Web/sites/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":409},"Microsoft.Web/sites/functions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":415},"Microsoft.Web/sites/functions/keys@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":419},"Microsoft.Web/sites/hostNameBindings@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":437},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":442},"Microsoft.Web/sites/hybridconnection@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":447},"Microsoft.Web/sites/instances/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":452},"Microsoft.Web/sites/networkConfig@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":458},"Microsoft.Web/sites/premieraddons@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":464},"Microsoft.Web/sites/privateAccess@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":474},"Microsoft.Web/sites/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":482},"Microsoft.Web/sites/publicCertificates@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":491},"Microsoft.Web/sites/siteextensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":500},"Microsoft.Web/sites/slots@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":505},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":515},"Microsoft.Web/sites/slots/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":561},"Microsoft.Web/sites/slots/deployments@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":565},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":569},"Microsoft.Web/sites/slots/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":574},"Microsoft.Web/sites/slots/functions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":578},"Microsoft.Web/sites/slots/functions/keys@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":582},"Microsoft.Web/sites/slots/hostNameBindings@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":586},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":590},"Microsoft.Web/sites/slots/hybridconnection@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":594},"Microsoft.Web/sites/slots/instances/extensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":599},"Microsoft.Web/sites/slots/premieraddons@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":604},"Microsoft.Web/sites/slots/privateAccess@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":609},"Microsoft.Web/sites/slots/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":613},"Microsoft.Web/sites/slots/publicCertificates@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":617},"Microsoft.Web/sites/slots/siteextensions@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":621},"Microsoft.Web/sites/slots/sourcecontrols@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":630},"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":642},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":647},"Microsoft.Web/sites/sourcecontrols@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":652},"Microsoft.Web/sites/virtualNetworkConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":656},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":660},"Microsoft.Web/staticSites@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":691},"Microsoft.Web/staticSites/builds/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":703},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":708},"Microsoft.Web/staticSites/config@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":720},"Microsoft.Web/staticSites/customDomains@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":732},"Microsoft.Web/staticSites/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":736},"Microsoft.Web/staticSites/userProvidedFunctionApps@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":740},"Microsoft.Web/hostingEnvironments@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":765},"Microsoft.Web/hostingEnvironments/configurations@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":773},"Microsoft.Web/hostingEnvironments/multiRolePools@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":784},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":788},"Microsoft.Web/hostingEnvironments/workerPools@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":792},"Microsoft.Web/serverfarms@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":809},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":813},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-12-01":{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":817},"Microsoft.Web/hostingEnvironments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":41},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":57},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":65},"Microsoft.Web/hostingEnvironments/workerPools@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":69},"Microsoft.Web/serverfarms@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":88},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":93},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":102},"Microsoft.Web/certificates@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":121},"Microsoft.Web/publishingUsers@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":127},"Microsoft.Web/sourcecontrols@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":132},"Microsoft.Web/staticSites@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":166},"Microsoft.Web/staticSites/builds/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":178},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":183},"Microsoft.Web/staticSites/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":195},"Microsoft.Web/staticSites/customDomains@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":207},"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":211},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":215},"Microsoft.Web/sites@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":358},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":369},"Microsoft.Web/sites/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":554},"Microsoft.Web/sites/deployments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":559},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":564},"Microsoft.Web/sites/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":577},"Microsoft.Web/sites/functions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":583},"Microsoft.Web/sites/functions/keys@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":587},"Microsoft.Web/sites/hostNameBindings@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":605},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":610},"Microsoft.Web/sites/hybridconnection@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":615},"Microsoft.Web/sites/instances/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":620},"Microsoft.Web/sites/networkConfig@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":626},"Microsoft.Web/sites/premieraddons@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":632},"Microsoft.Web/sites/privateAccess@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":642},"Microsoft.Web/sites/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":646},"Microsoft.Web/sites/publicCertificates@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":655},"Microsoft.Web/sites/siteextensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":664},"Microsoft.Web/sites/slots@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":669},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":679},"Microsoft.Web/sites/slots/config@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":725},"Microsoft.Web/sites/slots/deployments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":729},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":733},"Microsoft.Web/sites/slots/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":738},"Microsoft.Web/sites/slots/functions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":742},"Microsoft.Web/sites/slots/functions/keys@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":746},"Microsoft.Web/sites/slots/hostNameBindings@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":750},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":754},"Microsoft.Web/sites/slots/hybridconnection@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":758},"Microsoft.Web/sites/slots/instances/extensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":763},"Microsoft.Web/sites/slots/premieraddons@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":768},"Microsoft.Web/sites/slots/privateAccess@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":773},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":777},"Microsoft.Web/sites/slots/publicCertificates@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":781},"Microsoft.Web/sites/slots/siteextensions@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":785},"Microsoft.Web/sites/slots/sourcecontrols@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":794},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":801},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":805},"Microsoft.Web/sites/sourcecontrols@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":810},"Microsoft.Web/sites/virtualNetworkConnections@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":814},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":818},"Microsoft.Web/kubeEnvironments@2021-01-01":{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":845},"Microsoft.Web/hostingEnvironments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":41},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":57},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":65},"Microsoft.Web/hostingEnvironments/workerPools@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":69},"Microsoft.Web/serverfarms@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":88},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":93},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":102},"Microsoft.Web/certificates@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":121},"Microsoft.Web/kubeEnvironments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":148},"Microsoft.Web/publishingUsers@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":154},"Microsoft.Web/sourcecontrols@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":159},"Microsoft.Web/staticSites@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":193},"Microsoft.Web/staticSites/builds/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":205},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":210},"Microsoft.Web/staticSites/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":222},"Microsoft.Web/staticSites/customDomains@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":234},"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":238},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":242},"Microsoft.Web/sites@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":385},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":396},"Microsoft.Web/sites/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":581},"Microsoft.Web/sites/deployments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":586},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":591},"Microsoft.Web/sites/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":604},"Microsoft.Web/sites/functions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":610},"Microsoft.Web/sites/functions/keys@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":614},"Microsoft.Web/sites/hostNameBindings@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":632},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":637},"Microsoft.Web/sites/hybridconnection@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":642},"Microsoft.Web/sites/instances/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":647},"Microsoft.Web/sites/networkConfig@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":653},"Microsoft.Web/sites/premieraddons@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":659},"Microsoft.Web/sites/privateAccess@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":669},"Microsoft.Web/sites/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":673},"Microsoft.Web/sites/publicCertificates@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":682},"Microsoft.Web/sites/siteextensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":691},"Microsoft.Web/sites/slots@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":696},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":706},"Microsoft.Web/sites/slots/config@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":752},"Microsoft.Web/sites/slots/deployments@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":756},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":760},"Microsoft.Web/sites/slots/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":765},"Microsoft.Web/sites/slots/functions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":769},"Microsoft.Web/sites/slots/functions/keys@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":773},"Microsoft.Web/sites/slots/hostNameBindings@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":777},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":781},"Microsoft.Web/sites/slots/hybridconnection@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":785},"Microsoft.Web/sites/slots/instances/extensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":790},"Microsoft.Web/sites/slots/networkConfig@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":795},"Microsoft.Web/sites/slots/premieraddons@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":800},"Microsoft.Web/sites/slots/privateAccess@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":805},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":809},"Microsoft.Web/sites/slots/publicCertificates@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":813},"Microsoft.Web/sites/slots/siteextensions@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":817},"Microsoft.Web/sites/slots/sourcecontrols@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":826},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":833},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":837},"Microsoft.Web/sites/sourcecontrols@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":842},"Microsoft.Web/sites/virtualNetworkConnections@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":846},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-15":{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":850},"Microsoft.Web/hostingEnvironments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":43},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":59},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":67},"Microsoft.Web/hostingEnvironments/workerPools@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":71},"Microsoft.Web/serverfarms@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":90},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":95},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":104},"Microsoft.Web/certificates@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":123},"Microsoft.Web/kubeEnvironments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":150},"Microsoft.Web/publishingUsers@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":156},"Microsoft.Web/sourcecontrols@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":161},"Microsoft.Web/staticSites@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":196},"Microsoft.Web/staticSites/builds/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":208},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":213},"Microsoft.Web/staticSites/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":225},"Microsoft.Web/staticSites/customDomains@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":237},"Microsoft.Web/staticSites/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":241},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":245},"Microsoft.Web/sites@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":388},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":399},"Microsoft.Web/sites/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":589},"Microsoft.Web/sites/deployments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":594},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":599},"Microsoft.Web/sites/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":612},"Microsoft.Web/sites/functions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":618},"Microsoft.Web/sites/functions/keys@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":622},"Microsoft.Web/sites/hostNameBindings@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":640},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":645},"Microsoft.Web/sites/hybridconnection@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":650},"Microsoft.Web/sites/instances/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":655},"Microsoft.Web/sites/networkConfig@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":661},"Microsoft.Web/sites/premieraddons@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":667},"Microsoft.Web/sites/privateAccess@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":677},"Microsoft.Web/sites/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":681},"Microsoft.Web/sites/publicCertificates@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":690},"Microsoft.Web/sites/siteextensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":699},"Microsoft.Web/sites/slots@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":704},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":714},"Microsoft.Web/sites/slots/config@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":760},"Microsoft.Web/sites/slots/deployments@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":764},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":768},"Microsoft.Web/sites/slots/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":773},"Microsoft.Web/sites/slots/functions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":777},"Microsoft.Web/sites/slots/functions/keys@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":781},"Microsoft.Web/sites/slots/hostNameBindings@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":785},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":789},"Microsoft.Web/sites/slots/hybridconnection@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":793},"Microsoft.Web/sites/slots/instances/extensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":798},"Microsoft.Web/sites/slots/networkConfig@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":803},"Microsoft.Web/sites/slots/premieraddons@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":808},"Microsoft.Web/sites/slots/privateAccess@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":813},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":817},"Microsoft.Web/sites/slots/publicCertificates@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":821},"Microsoft.Web/sites/slots/siteextensions@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":825},"Microsoft.Web/sites/slots/sourcecontrols@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":834},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":841},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":845},"Microsoft.Web/sites/sourcecontrols@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":850},"Microsoft.Web/sites/virtualNetworkConnections@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":854},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-02-01":{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":858},"Microsoft.Web/hostingEnvironments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":33},"Microsoft.Web/hostingEnvironments/configurations@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":43},"Microsoft.Web/hostingEnvironments/multiRolePools@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":59},"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":67},"Microsoft.Web/hostingEnvironments/workerPools@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":71},"Microsoft.Web/serverfarms@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":90},"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":95},"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":104},"Microsoft.Web/certificates@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":123},"Microsoft.Web/containerApps@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":174},"Microsoft.Web/kubeEnvironments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":202},"Microsoft.Web/publishingUsers@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":208},"Microsoft.Web/sourcecontrols@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":213},"Microsoft.Web/staticSites@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":253},"Microsoft.Web/staticSites/builds/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":265},"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":270},"Microsoft.Web/staticSites/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":282},"Microsoft.Web/staticSites/customDomains@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":294},"Microsoft.Web/staticSites/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":298},"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":302},"Microsoft.Web/sites@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":445},"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":456},"Microsoft.Web/sites/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":646},"Microsoft.Web/sites/deployments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":651},"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":656},"Microsoft.Web/sites/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":674},"Microsoft.Web/sites/functions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":680},"Microsoft.Web/sites/functions/keys@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":684},"Microsoft.Web/sites/hostNameBindings@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":702},"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":707},"Microsoft.Web/sites/hybridconnection@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":712},"Microsoft.Web/sites/instances/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":717},"Microsoft.Web/sites/networkConfig@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":723},"Microsoft.Web/sites/premieraddons@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":729},"Microsoft.Web/sites/privateAccess@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":739},"Microsoft.Web/sites/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":743},"Microsoft.Web/sites/publicCertificates@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":752},"Microsoft.Web/sites/siteextensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":761},"Microsoft.Web/sites/slots@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":766},"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":776},"Microsoft.Web/sites/slots/config@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":822},"Microsoft.Web/sites/slots/deployments@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":826},"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":830},"Microsoft.Web/sites/slots/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":835},"Microsoft.Web/sites/slots/functions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":839},"Microsoft.Web/sites/slots/functions/keys@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":843},"Microsoft.Web/sites/slots/hostNameBindings@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":847},"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":851},"Microsoft.Web/sites/slots/hybridconnection@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":855},"Microsoft.Web/sites/slots/instances/extensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":860},"Microsoft.Web/sites/slots/networkConfig@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":865},"Microsoft.Web/sites/slots/premieraddons@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":870},"Microsoft.Web/sites/slots/privateAccess@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":875},"Microsoft.Web/sites/slots/privateEndpointConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":879},"Microsoft.Web/sites/slots/publicCertificates@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":883},"Microsoft.Web/sites/slots/siteextensions@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":887},"Microsoft.Web/sites/slots/sourcecontrols@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":896},"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":903},"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":907},"Microsoft.Web/sites/sourcecontrols@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":912},"Microsoft.Web/sites/virtualNetworkConnections@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":916},"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-03-01":{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":920},"Microsoft.SignalRService/webPubSub@2021-04-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":134},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-04-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":138},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-04-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":142},"Microsoft.SignalRService/webPubSub@2021-06-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":128},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-06-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":132},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-06-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":136},"Microsoft.SignalRService/webPubSub@2021-09-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":130},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-09-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":134},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-09-01-preview":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":138},"Microsoft.SignalRService/webPubSub@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":125},"Microsoft.SignalRService/webPubSub/hubs@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":138},"Microsoft.SignalRService/webPubSub/privateEndpointConnections@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":142},"Microsoft.SignalRService/webPubSub/sharedPrivateLinkResources@2021-10-01":{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":146},"Microsoft.WindowsESU/multipleActivationKeys@2019-09-16-preview":{"RelativePath":"windowsesu/microsoft.windowsesu/2019-09-16-preview/types.json","Index":26},"Microsoft.WindowsIoT/deviceServices@2018-02-16-preview":{"RelativePath":"windowsiot/microsoft.windowsiot/2018-02-16-preview/types.json","Index":13},"Microsoft.WindowsIoT/deviceServices@2019-06-01":{"RelativePath":"windowsiot/microsoft.windowsiot/2019-06-01/types.json","Index":13},"Microsoft.WorkloadMonitor/notificationSettings@2018-08-31-preview":{"RelativePath":"workloadmonitor/microsoft.workloadmonitor/2018-08-31-preview/types.json","Index":15}},"Functions":{"microsoft.addons/supportproviders":{"2018-03-01":[{"RelativePath":"addons/microsoft.addons/2018-03-01/types.json","Index":35}]},"microsoft.analysisservices/servers":{"2017-07-14":[{"RelativePath":"analysisservices/microsoft.analysisservices/2017-07-14/types.json","Index":50}],"2017-08-01":[{"RelativePath":"analysisservices/microsoft.analysisservices/2017-08-01/types.json","Index":56}]},"microsoft.apimanagement/service/authorizationservers":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":491}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":502}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":542}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":542}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":558}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":616}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":616}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":642}]},"microsoft.apimanagement/service/gateways":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":493}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":504}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":544}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":544}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":560}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":618}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":618}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":644}]},"microsoft.apimanagement/service/identityproviders":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":494}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":505}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":546}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":546}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":562}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":620}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":620}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":646}]},"microsoft.apimanagement/service/openidconnectproviders":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":495}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":508}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":549}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":549}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":565}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":623}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":623}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":649}]},"microsoft.apimanagement/service/portalsettings":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":497}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":510}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":551}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":551}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":567}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":625}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":625}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":655}]},"microsoft.apimanagement/service/namedvalues":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":499}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":507}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":548}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":548}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":564}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":622}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":622}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":648}]},"microsoft.apimanagement/service/subscriptions":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":501}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":512}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":553}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":553}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":569}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":627}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":627}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":657}]},"microsoft.apimanagement/service/tenant":{"2019-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01-preview/types.json","Index":503}],"2019-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2019-12-01/types.json","Index":514}],"2020-06-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-06-01-preview/types.json","Index":555}],"2020-12-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2020-12-01/types.json","Index":555}],"2021-01-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-01-01-preview/types.json","Index":571}],"2021-04-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-04-01-preview/types.json","Index":629}],"2021-08-01":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-08-01/types.json","Index":629}],"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":659}]},"microsoft.apimanagement/service/policyfragments":{"2021-12-01-preview":[{"RelativePath":"apimanagement/microsoft.apimanagement/2021-12-01-preview/types.json","Index":653}]},"microsoft.app/containerapps":{"2022-01-01-preview":[{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":244},{"RelativePath":"app/microsoft.app/2022-01-01-preview/types.json","Index":248}],"2022-03-01":[{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":244},{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":248}]},"microsoft.app/managedenvironments/daprcomponents":{"2022-03-01":[{"RelativePath":"app/microsoft.app/2022-03-01/types.json","Index":251}]},"microsoft.appconfiguration/configurationstores":{"2019-02-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.json","Index":24},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-02-01-preview/types.json","Index":28}],"2019-10-01":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-10-01/types.json","Index":33},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-10-01/types.json","Index":37}],"2019-11-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":62},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2019-11-01-preview/types.json","Index":66}],"2020-06-01":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":62},{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-06-01/types.json","Index":66}],"2020-07-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2020-07-01-preview/types.json","Index":68}],"2021-03-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-03-01-preview/types.json","Index":79}],"2021-10-01-preview":[{"RelativePath":"appconfiguration/microsoft.appconfiguration/2021-10-01-preview/types.json","Index":82}]},"microsoft.appplatform/spring":{"2020-07-01":[{"RelativePath":"appplatform/microsoft.appplatform/2020-07-01/types.json","Index":133}],"2020-11-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2020-11-01-preview/types.json","Index":134}],"2021-06-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2021-06-01-preview/types.json","Index":140}],"2021-09-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2021-09-01-preview/types.json","Index":176}],"2022-01-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2022-01-01-preview/types.json","Index":334}],"2022-03-01-preview":[{"RelativePath":"appplatform/microsoft.appplatform/2022-03-01-preview/types.json","Index":336}]},"microsoft.automation/automationaccounts":{"2015-10-31":[{"RelativePath":"automation/microsoft.automation/2015-10-31/types.json","Index":240}],"2019-06-01":[{"RelativePath":"automation/microsoft.automation/2019-06-01/types.json","Index":341}],"2020-01-13-preview":[{"RelativePath":"automation/microsoft.automation/2020-01-13-preview/types.json","Index":235}],"2021-06-22":[{"RelativePath":"automation/microsoft.automation/2021-06-22/types.json","Index":80}]},"microsoft.kusto/clusters/databases":{"2018-09-07-preview":[{"RelativePath":"azure-kusto/microsoft.kusto/2018-09-07-preview/types.json","Index":79}],"2019-01-21":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-01-21/types.json","Index":109}],"2019-05-15":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-05-15/types.json","Index":134}],"2019-09-07":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":178}],"2019-11-09":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":229}],"2020-02-15":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":245}],"2020-06-14":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":254}],"2020-09-18":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":281}],"2021-01-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":314}],"2021-08-27":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":343}],"2022-02-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":376}]},"microsoft.kusto/clusters":{"2019-09-07":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-09-07/types.json","Index":163}],"2019-11-09":[{"RelativePath":"azure-kusto/microsoft.kusto/2019-11-09/types.json","Index":214}],"2020-02-15":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":229},{"RelativePath":"azure-kusto/microsoft.kusto/2020-02-15/types.json","Index":230}],"2020-06-14":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":238},{"RelativePath":"azure-kusto/microsoft.kusto/2020-06-14/types.json","Index":239}],"2020-09-18":[{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":265},{"RelativePath":"azure-kusto/microsoft.kusto/2020-09-18/types.json","Index":266}],"2021-01-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":298},{"RelativePath":"azure-kusto/microsoft.kusto/2021-01-01/types.json","Index":299}],"2021-08-27":[{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":327},{"RelativePath":"azure-kusto/microsoft.kusto/2021-08-27/types.json","Index":328}],"2022-02-01":[{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":360},{"RelativePath":"azure-kusto/microsoft.kusto/2022-02-01/types.json","Index":361}]},"microsoft.azurestack/registrations/products":{"2016-01-01":[{"RelativePath":"azurestack/microsoft.azurestack/2016-01-01/types.json","Index":34}],"2017-06-01":[{"RelativePath":"azurestack/microsoft.azurestack/2017-06-01/types.json","Index":39}],"2020-06-01-preview":[{"RelativePath":"azurestack/microsoft.azurestack/2020-06-01-preview/types.json","Index":58}]},"microsoft.batch/batchaccounts":{"2015-12-01":[{"RelativePath":"batch/microsoft.batch/2015-12-01/types.json","Index":41}],"2017-01-01":[{"RelativePath":"batch/microsoft.batch/2017-01-01/types.json","Index":45}],"2017-05-01":[{"RelativePath":"batch/microsoft.batch/2017-05-01/types.json","Index":45}],"2017-09-01":[{"RelativePath":"batch/microsoft.batch/2017-09-01/types.json","Index":167}],"2018-12-01":[{"RelativePath":"batch/microsoft.batch/2018-12-01/types.json","Index":167}],"2019-04-01":[{"RelativePath":"batch/microsoft.batch/2019-04-01/types.json","Index":169}],"2019-08-01":[{"RelativePath":"batch/microsoft.batch/2019-08-01/types.json","Index":180}],"2020-03-01":[{"RelativePath":"batch/microsoft.batch/2020-03-01/types.json","Index":212}],"2020-05-01":[{"RelativePath":"batch/microsoft.batch/2020-05-01/types.json","Index":216}],"2020-09-01":[{"RelativePath":"batch/microsoft.batch/2020-09-01/types.json","Index":216}],"2021-01-01":[{"RelativePath":"batch/microsoft.batch/2021-01-01/types.json","Index":232}],"2021-06-01":[{"RelativePath":"batch/microsoft.batch/2021-06-01/types.json","Index":243}],"2022-01-01":[{"RelativePath":"batch/microsoft.batch/2022-01-01/types.json","Index":246}]},"microsoft.billing/billingaccounts":{"2019-10-01-preview":[{"RelativePath":"billing/microsoft.billing/2019-10-01-preview/types.json","Index":111}],"2020-05-01":[{"RelativePath":"billing/microsoft.billing/2020-05-01/types.json","Index":101}]},"microsoft.blockchain/blockchainmembers":{"2018-06-01-preview":[{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":45}]},"microsoft.blockchain/locations":{"2018-06-01-preview":[{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":54}]},"microsoft.blockchain/blockchainmembers/transactionnodes":{"2018-06-01-preview":[{"RelativePath":"blockchain/microsoft.blockchain/2018-06-01-preview/types.json","Index":55}]},"microsoft.botservice/botservices/channels":{"2017-12-01":[{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":107}],"2018-07-12":[{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":143}],"2020-06-02":[{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":122}],"2021-03-01":[{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":143}],"2021-05-01-preview":[{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":162}]},"microsoft.botservice/botservices/connections":{"2017-12-01":[{"RelativePath":"botservice/microsoft.botservice/2017-12-01/types.json","Index":115}],"2018-07-12":[{"RelativePath":"botservice/microsoft.botservice/2018-07-12/types.json","Index":151}],"2020-06-02":[{"RelativePath":"botservice/microsoft.botservice/2020-06-02/types.json","Index":130}],"2021-03-01":[{"RelativePath":"botservice/microsoft.botservice/2021-03-01/types.json","Index":153}],"2021-05-01-preview":[{"RelativePath":"botservice/microsoft.botservice/2021-05-01-preview/types.json","Index":172}]},"microsoft.cognitiveservices/accounts":{"2016-02-01-preview":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2016-02-01-preview/types.json","Index":49}],"2017-04-18":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2017-04-18/types.json","Index":72}],"2021-04-30":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-04-30/types.json","Index":99}],"2021-10-01":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2021-10-01/types.json","Index":126}],"2022-03-01":[{"RelativePath":"cognitiveservices/microsoft.cognitiveservices/2022-03-01/types.json","Index":126}]},"microsoft.communication/communicationservices":{"2020-08-20-preview":[{"RelativePath":"communication/microsoft.communication/2020-08-20-preview/types.json","Index":25}],"2020-08-20":[{"RelativePath":"communication/microsoft.communication/2020-08-20/types.json","Index":36}]},"microsoft.containerregistry/registries":{"2017-03-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-03-01/types.json","Index":27}],"2017-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":72}],"2017-10-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":89}],"2018-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":91}],"2019-04-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":105}],"2019-05-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":104}],"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":197}],"2019-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":228}],"2020-11-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":320}],"2021-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":324}],"2021-08-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":327}],"2021-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":164}],"2021-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":327}]},"microsoft.containerregistry/registries/webhooks":{"2017-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-06-01-preview/types.json","Index":85}],"2017-10-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2017-10-01/types.json","Index":102}],"2019-05-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-05-01/types.json","Index":117}],"2019-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-12-01-preview/types.json","Index":241}],"2020-11-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2020-11-01-preview/types.json","Index":333}],"2021-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-06-01-preview/types.json","Index":337}],"2021-08-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-08-01-preview/types.json","Index":340}],"2021-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-09-01/types.json","Index":177}],"2021-12-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2021-12-01-preview/types.json","Index":340}]},"microsoft.containerregistry/registries/buildtasks/steps":{"2018-02-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":66}]},"microsoft.containerregistry/registries/buildtasks":{"2018-02-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-02-01-preview/types.json","Index":67}]},"microsoft.containerregistry/registries/runs":{"2018-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":93}],"2019-04-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":107}],"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":199}]},"microsoft.containerregistry/registries/tasks":{"2018-09-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2018-09-01/types.json","Index":96}],"2019-04-01":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-04-01/types.json","Index":110}],"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":204}]},"microsoft.containerregistry/registries/agentpools":{"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":195}]},"microsoft.containerregistry/registries/taskruns":{"2019-06-01-preview":[{"RelativePath":"containerregistry/microsoft.containerregistry/2019-06-01-preview/types.json","Index":201}]},"microsoft.containerservice/managedclusters/accessprofiles":{"2017-08-31":[{"RelativePath":"containerservice/microsoft.containerservice/2017-08-31/types.json","Index":207}],"2018-03-31":[{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":215}],"2018-08-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":215}],"2019-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":405}],"2019-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":413}],"2019-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":427}],"2019-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":436}],"2019-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":436}],"2019-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":446}],"2020-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":446}],"2020-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":452}],"2020-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":465}],"2020-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":464}],"2020-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":484}],"2020-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":487}],"2020-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":501}],"2020-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":527}],"2020-12-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":561}],"2021-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":563}],"2021-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":240}],"2021-05-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":240}],"2021-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":252}],"2021-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":270}],"2021-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":277}],"2021-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":283}],"2021-11-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":284}],"2022-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":283}],"2022-01-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":285}],"2022-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":283}],"2022-02-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":311}],"2022-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":283}],"2022-03-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":315}]},"microsoft.containerservice/managedclusters":{"2018-03-31":[{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":219},{"RelativePath":"containerservice/microsoft.containerservice/2018-03-31/types.json","Index":220}],"2018-08-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":219},{"RelativePath":"containerservice/microsoft.containerservice/2018-08-01-preview/types.json","Index":220}],"2019-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":409},{"RelativePath":"containerservice/microsoft.containerservice/2019-02-01/types.json","Index":410}],"2019-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":417},{"RelativePath":"containerservice/microsoft.containerservice/2019-04-01/types.json","Index":418}],"2019-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":431},{"RelativePath":"containerservice/microsoft.containerservice/2019-06-01/types.json","Index":432}],"2019-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":440},{"RelativePath":"containerservice/microsoft.containerservice/2019-08-01/types.json","Index":441}],"2019-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":440},{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":441},{"RelativePath":"containerservice/microsoft.containerservice/2019-10-01/types.json","Index":442}],"2019-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":450},{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":451},{"RelativePath":"containerservice/microsoft.containerservice/2019-11-01/types.json","Index":452}],"2020-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":450},{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":451},{"RelativePath":"containerservice/microsoft.containerservice/2020-01-01/types.json","Index":452}],"2020-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":456},{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":457},{"RelativePath":"containerservice/microsoft.containerservice/2020-02-01/types.json","Index":458}],"2020-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":469},{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":470},{"RelativePath":"containerservice/microsoft.containerservice/2020-03-01/types.json","Index":471}],"2020-04-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":468},{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":469},{"RelativePath":"containerservice/microsoft.containerservice/2020-04-01/types.json","Index":470}],"2020-06-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":488},{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":489},{"RelativePath":"containerservice/microsoft.containerservice/2020-06-01/types.json","Index":490}],"2020-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":491},{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":492},{"RelativePath":"containerservice/microsoft.containerservice/2020-07-01/types.json","Index":493}],"2020-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":505},{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":506},{"RelativePath":"containerservice/microsoft.containerservice/2020-09-01/types.json","Index":507}],"2020-11-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":531},{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":532},{"RelativePath":"containerservice/microsoft.containerservice/2020-11-01/types.json","Index":533}],"2020-12-01":[{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":565},{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":566},{"RelativePath":"containerservice/microsoft.containerservice/2020-12-01/types.json","Index":567}],"2021-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":567},{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":568},{"RelativePath":"containerservice/microsoft.containerservice/2021-02-01/types.json","Index":569}],"2021-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":244},{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":245},{"RelativePath":"containerservice/microsoft.containerservice/2021-03-01/types.json","Index":246}],"2021-05-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":244},{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":245},{"RelativePath":"containerservice/microsoft.containerservice/2021-05-01/types.json","Index":246}],"2021-07-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":256},{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":257},{"RelativePath":"containerservice/microsoft.containerservice/2021-07-01/types.json","Index":258}],"2021-08-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":274},{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":275},{"RelativePath":"containerservice/microsoft.containerservice/2021-08-01/types.json","Index":276}],"2021-09-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":281},{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":282},{"RelativePath":"containerservice/microsoft.containerservice/2021-09-01/types.json","Index":283}],"2021-10-01":[{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2021-10-01/types.json","Index":289}],"2021-11-01-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":289},{"RelativePath":"containerservice/microsoft.containerservice/2021-11-01-preview/types.json","Index":290}],"2022-01-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-01/types.json","Index":289}],"2022-01-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":289},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":290},{"RelativePath":"containerservice/microsoft.containerservice/2022-01-02-preview/types.json","Index":291}],"2022-02-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-01/types.json","Index":289}],"2022-02-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":315},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":316},{"RelativePath":"containerservice/microsoft.containerservice/2022-02-02-preview/types.json","Index":317}],"2022-03-01":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":287},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":288},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-01/types.json","Index":289}],"2022-03-02-preview":[{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":319},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":320},{"RelativePath":"containerservice/microsoft.containerservice/2022-03-02-preview/types.json","Index":321}]},"microsoft.documentdb/databaseaccounts":{"2015-04-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-01/types.json","Index":193}],"2015-04-08":[{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2015-04-08/types.json","Index":193}],"2015-11-06":[{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2015-11-06/types.json","Index":193}],"2016-03-19":[{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-19/types.json","Index":193}],"2016-03-31":[{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":189},{"RelativePath":"cosmos-db/microsoft.documentdb/2016-03-31/types.json","Index":193}],"2019-08-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":269},{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":273}],"2019-12-12":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":261},{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":265}],"2020-03-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":269},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":273}],"2020-04-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":278},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":282}],"2020-06-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":335},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":339}],"2020-09-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":284},{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":288}],"2021-01-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":302},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":306}],"2021-03-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":381},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":385}],"2021-03-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":302},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":306}],"2021-04-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":397},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":401}],"2021-04-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":320},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":324}],"2021-05-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":324},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":328}],"2021-06-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":353},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":357}],"2021-07-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":434},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":438}],"2021-10-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":480},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":484}],"2021-10-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":399},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":403}],"2021-11-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":486},{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":490}],"2022-02-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":494},{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":498}]},"microsoft.documentdb/databaseaccounts/notebookworkspaces":{"2019-08-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-08-01/types.json","Index":275}],"2019-12-12":[{"RelativePath":"cosmos-db/microsoft.documentdb/2019-12-12/types.json","Index":267}],"2020-03-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-03-01/types.json","Index":275}],"2020-04-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-04-01/types.json","Index":284}],"2020-06-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-06-01-preview/types.json","Index":341}],"2020-09-01":[{"RelativePath":"cosmos-db/microsoft.documentdb/2020-09-01/types.json","Index":290}],"2021-01-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-01-15/types.json","Index":308}],"2021-03-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-01-preview/types.json","Index":387}],"2021-03-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-03-15/types.json","Index":308}],"2021-04-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-01-preview/types.json","Index":403}],"2021-04-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-04-15/types.json","Index":326}],"2021-05-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-05-15/types.json","Index":330}],"2021-06-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-06-15/types.json","Index":359}],"2021-07-01-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-07-01-preview/types.json","Index":440}],"2021-10-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15-preview/types.json","Index":486}],"2021-10-15":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-10-15/types.json","Index":405}],"2021-11-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2021-11-15-preview/types.json","Index":492}],"2022-02-15-preview":[{"RelativePath":"cosmos-db/microsoft.documentdb/2022-02-15-preview/types.json","Index":500}]},"microsoft.databox/jobs":{"2018-01-01":[{"RelativePath":"databox/microsoft.databox/2018-01-01/types.json","Index":151}],"2019-09-01":[{"RelativePath":"databox/microsoft.databox/2019-09-01/types.json","Index":177}],"2020-04-01":[{"RelativePath":"databox/microsoft.databox/2020-04-01/types.json","Index":224}],"2020-11-01":[{"RelativePath":"databox/microsoft.databox/2020-11-01/types.json","Index":233}],"2021-03-01":[{"RelativePath":"databox/microsoft.databox/2021-03-01/types.json","Index":243}],"2021-05-01":[{"RelativePath":"databox/microsoft.databox/2021-05-01/types.json","Index":246}],"2021-08-01-preview":[{"RelativePath":"databox/microsoft.databox/2021-08-01-preview/types.json","Index":369}],"2021-12-01":[{"RelativePath":"databox/microsoft.databox/2021-12-01/types.json","Index":409}],"2022-02-01":[{"RelativePath":"databox/microsoft.databox/2022-02-01/types.json","Index":424}]},"microsoft.databoxedge/databoxedgedevices/orders":{"2020-09-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01-preview/types.json","Index":406}],"2020-09-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2020-09-01/types.json","Index":406}],"2020-12-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2020-12-01/types.json","Index":406}],"2021-02-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01-preview/types.json","Index":410}],"2021-02-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-02-01/types.json","Index":441}],"2021-06-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01-preview/types.json","Index":441}],"2021-06-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2021-06-01/types.json","Index":441}],"2022-03-01":[{"RelativePath":"databoxedge/microsoft.databoxedge/2022-03-01/types.json","Index":445}],"2022-04-01-preview":[{"RelativePath":"databoxedge/microsoft.databoxedge/2022-04-01-preview/types.json","Index":467}]},"microsoft.datadog/monitors":{"2020-02-01-preview":[{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":94},{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":103},{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":107},{"RelativePath":"datadog/microsoft.datadog/2020-02-01-preview/types.json","Index":111}],"2021-03-01":[{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":105},{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":114},{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":118},{"RelativePath":"datadog/microsoft.datadog/2021-03-01/types.json","Index":122}]},"microsoft.datafactory/factories/integrationruntimes":{"2017-09-01-preview":[{"RelativePath":"datafactory/microsoft.datafactory/2017-09-01-preview/types.json","Index":744}],"2018-06-01":[{"RelativePath":"datafactory/microsoft.datafactory/2018-06-01/types.json","Index":1761}]},"microsoft.datalakeanalytics/accounts/storageaccounts/containers":{"2015-10-01-preview":[{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2015-10-01-preview/types.json","Index":109}],"2016-11-01":[{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2016-11-01/types.json","Index":111}],"2019-11-01-preview":[{"RelativePath":"datalake-analytics/microsoft.datalakeanalytics/2019-11-01-preview/types.json","Index":111}]},"microsoft.datamigration/sqlmigrationservices":{"2021-10-30-preview":[{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1143},{"RelativePath":"datamigration/microsoft.datamigration/2021-10-30-preview/types.json","Index":1148}],"2022-01-30-preview":[{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1169},{"RelativePath":"datamigration/microsoft.datamigration/2022-01-30-preview/types.json","Index":1174}],"2022-03-30-preview":[{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1186},{"RelativePath":"datamigration/microsoft.datamigration/2022-03-30-preview/types.json","Index":1191}]},"microsoft.datashare/accounts/shares":{"2018-11-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":307},{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":310}],"2019-11-01":[{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":307},{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":310}],"2020-09-01":[{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":334},{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":337}],"2020-10-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":370},{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":373}],"2021-08-01":[{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":363},{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":366}]},"microsoft.datashare/accounts/sharesubscriptions":{"2018-11-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":320},{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":325},{"RelativePath":"datashare/microsoft.datashare/2018-11-01-preview/types.json","Index":328}],"2019-11-01":[{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":320},{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":325},{"RelativePath":"datashare/microsoft.datashare/2019-11-01/types.json","Index":328}],"2020-09-01":[{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":347},{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":352},{"RelativePath":"datashare/microsoft.datashare/2020-09-01/types.json","Index":355}],"2020-10-01-preview":[{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":383},{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":388},{"RelativePath":"datashare/microsoft.datashare/2020-10-01-preview/types.json","Index":391}],"2021-08-01":[{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":376},{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":381},{"RelativePath":"datashare/microsoft.datashare/2021-08-01/types.json","Index":384}]},"microsoft.devices/provisioningservices":{"2017-08-21-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":52}],"2017-11-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":52}],"2018-01-22":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":52}],"2020-01-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":61}],"2020-03-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":78}],"2020-09-01-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":85}],"2021-10-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":89}],"2022-02-05":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":89}]},"microsoft.devices/provisioningservices/keys":{"2017-08-21-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-08-21-preview/types.json","Index":53}],"2017-11-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2017-11-15/types.json","Index":53}],"2018-01-22":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2018-01-22/types.json","Index":53}],"2020-01-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-01-01/types.json","Index":62}],"2020-03-01":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-03-01/types.json","Index":79}],"2020-09-01-preview":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2020-09-01-preview/types.json","Index":86}],"2021-10-15":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2021-10-15/types.json","Index":90}],"2022-02-05":[{"RelativePath":"deviceprovisioningservices/microsoft.devices/2022-02-05/types.json","Index":90}]},"microsoft.devspaces/controllers":{"2019-04-01":[{"RelativePath":"devspaces/microsoft.devspaces/2019-04-01/types.json","Index":34}]},"microsoft.devtestlab/labs":{"2015-05-21-preview":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2015-05-21-preview/types.json","Index":133}],"2016-05-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":263}],"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":323}]},"microsoft.devtestlab/labs/schedules":{"2016-05-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":266}],"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":326}]},"microsoft.devtestlab/labs/virtualmachines":{"2016-05-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2016-05-15/types.json","Index":267}],"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":328}]},"microsoft.devtestlab/labs/users/servicefabrics":{"2018-09-15":[{"RelativePath":"devtestlabs/microsoft.devtestlab/2018-09-15/types.json","Index":327}]},"microsoft.network/virtualnetworks":{"2020-04-01-preview":[{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":114},{"RelativePath":"dnsresolver/microsoft.network/2020-04-01-preview/types.json","Index":119}],"2021-02-01-preview":[{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":349},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":359}],"2021-05-01-preview":[{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":325},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":335}],"2022-02-01-preview":[{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":331},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":341}]},"microsoft.elastic/monitors":{"2020-07-01-preview":[{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2020-07-01-preview/types.json","Index":86}],"2020-07-01":[{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2020-07-01/types.json","Index":86}],"2021-09-01-preview":[{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2021-09-01-preview/types.json","Index":86}],"2021-10-01-preview":[{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":77},{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":82},{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":86},{"RelativePath":"elastic/microsoft.elastic/2021-10-01-preview/types.json","Index":89}]},"microsoft.engagementfabric/accounts":{"2018-09-01-preview":[{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":27},{"RelativePath":"engagementfabric/microsoft.engagementfabric/2018-09-01-preview/types.json","Index":32}]},"microsoft.eventgrid/topics":{"2017-06-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2017-06-15-preview/types.json","Index":41}],"2017-09-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2017-09-15-preview/types.json","Index":44}],"2018-01-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-01-01/types.json","Index":44}],"2018-05-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-05-01-preview/types.json","Index":70}],"2018-09-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":122}],"2019-01-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-01-01/types.json","Index":56}],"2019-02-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":137}],"2019-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":119}],"2020-01-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":143}],"2020-04-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":285}],"2020-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":192}],"2020-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":324}],"2021-06-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":332}],"2021-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":440}],"2021-12-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":257}]},"microsoft.eventgrid/domains":{"2018-09-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2018-09-15-preview/types.json","Index":120}],"2019-02-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-02-01-preview/types.json","Index":135}],"2019-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2019-06-01/types.json","Index":117}],"2020-01-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-01-01-preview/types.json","Index":141}],"2020-04-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":281}],"2020-06-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-06-01/types.json","Index":190}],"2020-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":320}],"2021-06-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":328}],"2021-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":436}],"2021-12-01":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-12-01/types.json","Index":255}]},"microsoft.eventgrid/partnernamespaces":{"2020-04-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-04-01-preview/types.json","Index":283}],"2020-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2020-10-15-preview/types.json","Index":322}],"2021-06-01-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-06-01-preview/types.json","Index":330}],"2021-10-15-preview":[{"RelativePath":"eventgrid/microsoft.eventgrid/2021-10-15-preview/types.json","Index":438}]},"microsoft.eventhub/namespaces/authorizationrules":{"2015-08-01":[{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":72}],"2017-04-01":[{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":92}],"2018-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":139}],"2021-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":139}],"2021-06-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":151}],"2021-11-01":[{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":164}]},"microsoft.eventhub/namespaces/eventhubs/authorizationrules":{"2015-08-01":[{"RelativePath":"eventhub/microsoft.eventhub/2015-08-01/types.json","Index":73}],"2017-04-01":[{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":94}],"2018-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":141}],"2021-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":140}],"2021-06-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":152}],"2021-11-01":[{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":165}]},"microsoft.eventhub/namespaces/disasterrecoveryconfigs/authorizationrules":{"2017-04-01":[{"RelativePath":"eventhub/microsoft.eventhub/2017-04-01/types.json","Index":93}],"2018-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2018-01-01-preview/types.json","Index":140}],"2021-01-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-01-01-preview/types.json","Index":141}],"2021-06-01-preview":[{"RelativePath":"eventhub/microsoft.eventhub/2021-06-01-preview/types.json","Index":153}],"2021-11-01":[{"RelativePath":"eventhub/microsoft.eventhub/2021-11-01/types.json","Index":166}]},"microsoft.hdinsight/clusters":{"2015-03-01-preview":[{"RelativePath":"hdinsight/microsoft.hdinsight/2015-03-01-preview/types.json","Index":113}],"2018-06-01-preview":[{"RelativePath":"hdinsight/microsoft.hdinsight/2018-06-01-preview/types.json","Index":113}],"2021-06-01":[{"RelativePath":"hdinsight/microsoft.hdinsight/2021-06-01/types.json","Index":170}]},"microsoft.hybridconnectivity/endpoints":{"2021-10-06-preview":[{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2021-10-06-preview/types.json","Index":29}],"2022-05-01-preview":[{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.json","Index":29},{"RelativePath":"hybridconnectivity/microsoft.hybridconnectivity/2022-05-01-preview/types.json","Index":32}]},"microsoft.kubernetes/connectedclusters":{"2020-01-01-preview":[{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2020-01-01-preview/types.json","Index":40}],"2021-04-01-preview":[{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-04-01-preview/types.json","Index":53}],"2021-10-01":[{"RelativePath":"hybridkubernetes/microsoft.kubernetes/2021-10-01/types.json","Index":50}]},"microsoft.hybridnetwork/devices":{"2020-01-01-preview":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2020-01-01-preview/types.json","Index":200}],"2021-05-01":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2021-05-01/types.json","Index":224}],"2022-01-01-preview":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":224}]},"microsoft.hybridnetwork/vendors/vendorskus":{"2022-01-01-preview":[{"RelativePath":"hybridnetwork/microsoft.hybridnetwork/2022-01-01-preview/types.json","Index":227}]},"microsoft.devices/iothubs":{"2016-02-03":[{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":72}],"2017-01-19":[{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":95}],"2017-07-01":[{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":102}],"2018-01-22":[{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":102}],"2018-04-01":[{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":108}],"2018-12-01-preview":[{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":112}],"2019-03-22-preview":[{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":115}],"2019-03-22":[{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":110}],"2019-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":117}],"2019-11-04":[{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":113}],"2020-03-01":[{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":145}],"2020-04-01":[{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":145}],"2020-06-15":[{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":145}],"2020-07-10-preview":[{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":156}],"2020-08-01":[{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":145}],"2020-08-31-preview":[{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":164}],"2020-08-31":[{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":153}],"2021-02-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":171}],"2021-03-03-preview":[{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":171}],"2021-03-31":[{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":164}],"2021-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":174}],"2021-07-01":[{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":165}],"2021-07-02-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":185}],"2021-07-02":[{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":176}]},"microsoft.devices/iothubs/iothubkeys":{"2016-02-03":[{"RelativePath":"iothub/microsoft.devices/2016-02-03/types.json","Index":73}],"2017-01-19":[{"RelativePath":"iothub/microsoft.devices/2017-01-19/types.json","Index":96}],"2017-07-01":[{"RelativePath":"iothub/microsoft.devices/2017-07-01/types.json","Index":103}],"2018-01-22":[{"RelativePath":"iothub/microsoft.devices/2018-01-22/types.json","Index":103}],"2018-04-01":[{"RelativePath":"iothub/microsoft.devices/2018-04-01/types.json","Index":109}],"2018-12-01-preview":[{"RelativePath":"iothub/microsoft.devices/2018-12-01-preview/types.json","Index":113}],"2019-03-22-preview":[{"RelativePath":"iothub/microsoft.devices/2019-03-22-preview/types.json","Index":116}],"2019-03-22":[{"RelativePath":"iothub/microsoft.devices/2019-03-22/types.json","Index":111}],"2019-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2019-07-01-preview/types.json","Index":118}],"2019-11-04":[{"RelativePath":"iothub/microsoft.devices/2019-11-04/types.json","Index":114}],"2020-03-01":[{"RelativePath":"iothub/microsoft.devices/2020-03-01/types.json","Index":146}],"2020-04-01":[{"RelativePath":"iothub/microsoft.devices/2020-04-01/types.json","Index":146}],"2020-06-15":[{"RelativePath":"iothub/microsoft.devices/2020-06-15/types.json","Index":146}],"2020-07-10-preview":[{"RelativePath":"iothub/microsoft.devices/2020-07-10-preview/types.json","Index":157}],"2020-08-01":[{"RelativePath":"iothub/microsoft.devices/2020-08-01/types.json","Index":146}],"2020-08-31-preview":[{"RelativePath":"iothub/microsoft.devices/2020-08-31-preview/types.json","Index":165}],"2020-08-31":[{"RelativePath":"iothub/microsoft.devices/2020-08-31/types.json","Index":154}],"2021-02-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-02-01-preview/types.json","Index":172}],"2021-03-03-preview":[{"RelativePath":"iothub/microsoft.devices/2021-03-03-preview/types.json","Index":172}],"2021-03-31":[{"RelativePath":"iothub/microsoft.devices/2021-03-31/types.json","Index":165}],"2021-07-01-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-01-preview/types.json","Index":175}],"2021-07-01":[{"RelativePath":"iothub/microsoft.devices/2021-07-01/types.json","Index":166}],"2021-07-02-preview":[{"RelativePath":"iothub/microsoft.devices/2021-07-02-preview/types.json","Index":186}],"2021-07-02":[{"RelativePath":"iothub/microsoft.devices/2021-07-02/types.json","Index":177}]},"microsoft.labservices/users":{"2018-10-15":[{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":81},{"RelativePath":"labservices/microsoft.labservices/2018-10-15/types.json","Index":85}]},"microsoft.logic/workflows/accesskeys":{"2015-02-01-preview":[{"RelativePath":"logic/microsoft.logic/2015-02-01-preview/types.json","Index":53}]},"microsoft.logic/integrationaccounts":{"2015-08-01-preview":[{"RelativePath":"logic/microsoft.logic/2015-08-01-preview/types.json","Index":245}],"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":416},{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":423}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":382},{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":389}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":555},{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":562}]},"microsoft.logic/workflows":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":401},{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":402}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":367},{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":368}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":540},{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":541}]},"microsoft.logic/workflows/versions/triggers":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":403}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":370}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":543}]},"microsoft.logic/workflows/triggers":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":404}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":369}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":542}]},"microsoft.logic/workflows/runs/actions":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":413}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":379}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":552}]},"microsoft.logic/workflows/runs/actions/repetitions":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":414}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":380}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":553}]},"microsoft.logic/integrationaccounts/assemblies":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":424}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":390}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":563}]},"microsoft.logic/integrationaccounts/schemas":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":425}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":391}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":564}]},"microsoft.logic/integrationaccounts/maps":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":426}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":392}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":565}]},"microsoft.logic/integrationaccounts/partners":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":427}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":393}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":566}]},"microsoft.logic/integrationaccounts/agreements":{"2016-06-01":[{"RelativePath":"logic/microsoft.logic/2016-06-01/types.json","Index":428}],"2018-07-01-preview":[{"RelativePath":"logic/microsoft.logic/2018-07-01-preview/types.json","Index":394}],"2019-05-01":[{"RelativePath":"logic/microsoft.logic/2019-05-01/types.json","Index":567}]},"microsoft.logz/monitors":{"2020-10-01-preview":[{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":104},{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":113},{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":117}],"2020-10-01":[{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":104},{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":113},{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":117}],"2022-01-01-preview":[{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":127},{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":136},{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":140}]},"microsoft.logz/monitors/accounts":{"2020-10-01-preview":[{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":118},{"RelativePath":"logz/microsoft.logz/2020-10-01-preview/types.json","Index":119}],"2020-10-01":[{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":118},{"RelativePath":"logz/microsoft.logz/2020-10-01/types.json","Index":119}],"2022-01-01-preview":[{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":141},{"RelativePath":"logz/microsoft.logz/2022-01-01-preview/types.json","Index":142}]},"microsoft.machinelearning/workspaces":{"2016-04-01":[{"RelativePath":"machinelearning/microsoft.machinelearning/2016-04-01/types.json","Index":29}],"2019-10-01":[{"RelativePath":"machinelearning/microsoft.machinelearning/2019-10-01/types.json","Index":30}]},"microsoft.machinelearningcompute/operationalizationclusters":{"2017-06-01-preview":[{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.json","Index":96}],"2017-08-01-preview":[{"RelativePath":"machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.json","Index":108}]},"microsoft.machinelearningservices/workspaces":{"2018-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":69}],"2018-11-19":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":86}],"2019-05-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":86}],"2019-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":90}],"2019-11-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":91}],"2020-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":113}],"2020-02-18-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":152}],"2020-03-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":133}],"2020-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":141}],"2020-05-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":295}],"2020-05-15-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":189}],"2020-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":171}],"2020-08-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":195}],"2020-09-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":307},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":309}],"2021-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":268},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":270},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":271},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":273}],"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":688},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":690},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":692},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":693}],"2021-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":273},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":275},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":276},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":278}],"2021-07-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":235},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":237},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":239},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":240}],"2022-01-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":241},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":243},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":245},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":246}]},"microsoft.machinelearningservices/workspaces/computes":{"2018-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.json","Index":75}],"2018-11-19":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":98},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.json","Index":106}],"2019-05-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":98},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.json","Index":106}],"2019-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":109},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.json","Index":117}],"2019-11-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":110},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.json","Index":118}],"2020-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":132},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.json","Index":140}],"2020-02-18-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":172},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.json","Index":180}],"2020-03-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":152},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.json","Index":160}],"2020-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":160},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.json","Index":168}],"2020-05-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":314},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.json","Index":322}],"2020-05-15-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":208},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.json","Index":216}],"2020-06-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":191},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.json","Index":199}],"2020-08-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":215},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.json","Index":223}],"2020-09-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":329},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.json","Index":337}],"2021-01-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":293},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.json","Index":301}],"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":714},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":722}],"2021-04-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":299},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.json","Index":307}],"2021-07-01":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":251},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.json","Index":259}],"2022-01-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":257},{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.json","Index":265}]},"microsoft.machinelearningservices/workspaces/batchendpoints":{"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":723}]},"microsoft.machinelearningservices/workspaces/datastores":{"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":737}]},"microsoft.machinelearningservices/workspaces/onlineendpoints":{"2021-03-01-preview":[{"RelativePath":"machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.json","Index":738}]},"microsoft.maps/accounts":{"2017-01-01-preview":[{"RelativePath":"maps/microsoft.maps/2017-01-01-preview/types.json","Index":16}],"2018-05-01":[{"RelativePath":"maps/microsoft.maps/2018-05-01/types.json","Index":16}],"2020-02-01-preview":[{"RelativePath":"maps/microsoft.maps/2020-02-01-preview/types.json","Index":39}],"2021-02-01":[{"RelativePath":"maps/microsoft.maps/2021-02-01/types.json","Index":40}],"2021-07-01-preview":[{"RelativePath":"maps/microsoft.maps/2021-07-01-preview/types.json","Index":50}],"2021-12-01-preview":[{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":59},{"RelativePath":"maps/microsoft.maps/2021-12-01-preview/types.json","Index":61}]},"microsoft.marketplace/privatestores":{"2021-12-01":[{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":83},{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":91},{"RelativePath":"marketplace/microsoft.marketplace/2021-12-01/types.json","Index":94}]},"microsoft.media/mediaservices":{"2015-10-01":[{"RelativePath":"mediaservices/microsoft.media/2015-10-01/types.json","Index":19}],"2020-05-01":[{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":562}],"2021-05-01":[{"RelativePath":"mediaservices/microsoft.media/2021-05-01/types.json","Index":68}],"2021-06-01":[{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":550}]},"microsoft.media/mediaservices/assets":{"2018-03-30-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":358}],"2018-06-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":364}],"2018-07-01":[{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":411},{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":415}],"2019-05-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":411},{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":415}],"2020-05-01":[{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":534},{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":538}],"2021-06-01":[{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":558},{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":562}],"2021-11-01":[{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":532},{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":536}]},"microsoft.media/mediaservices/streaminglocators":{"2018-03-30-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":367},{"RelativePath":"mediaservices/microsoft.media/2018-03-30-preview/types.json","Index":383}],"2018-06-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":367},{"RelativePath":"mediaservices/microsoft.media/2018-06-01-preview/types.json","Index":383}],"2018-07-01":[{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":418},{"RelativePath":"mediaservices/microsoft.media/2018-07-01/types.json","Index":434}],"2019-05-01-preview":[{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":418},{"RelativePath":"mediaservices/microsoft.media/2019-05-01-preview/types.json","Index":434}],"2020-05-01":[{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":541},{"RelativePath":"mediaservices/microsoft.media/2020-05-01/types.json","Index":557}],"2021-06-01":[{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":565},{"RelativePath":"mediaservices/microsoft.media/2021-06-01/types.json","Index":581}],"2021-11-01":[{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":539},{"RelativePath":"mediaservices/microsoft.media/2021-11-01/types.json","Index":555}]},"microsoft.mixedreality/remoterenderingaccounts":{"2020-04-06-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2020-04-06-preview/types.json","Index":34}],"2021-01-01":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":40}],"2021-03-01-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":47}]},"microsoft.mixedreality/spatialanchorsaccounts":{"2020-05-01":[{"RelativePath":"mixedreality/microsoft.mixedreality/2020-05-01/types.json","Index":34}],"2021-01-01":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-01-01/types.json","Index":39}],"2021-03-01-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":46}]},"microsoft.mixedreality/objectanchorsaccounts":{"2021-03-01-preview":[{"RelativePath":"mixedreality/microsoft.mixedreality/2021-03-01-preview/types.json","Index":48}]},"microsoft.mobilenetwork/mobilenetworks":{"2022-01-01-preview":[{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.json","Index":238}],"2022-03-01-preview":[{"RelativePath":"mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.json","Index":239}]},"microsoft.managedidentity/userassignedidentities":{"2021-09-30-preview":[{"RelativePath":"msi/microsoft.managedidentity/2021-09-30-preview/types.json","Index":17}]},"microsoft.network/networkmanagers":{"2021-02-01-preview":[{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":306},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":314},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":322},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":332},{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":342}],"2021-05-01-preview":[{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":283},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":291},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":299},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":309},{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":319}],"2022-02-01-preview":[{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":289},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":297},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":305},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":315},{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":325}]},"microsoft.network/networkmanagers/networkgroups":{"2021-02-01-preview":[{"RelativePath":"network/microsoft.network/2021-02-01-preview/types.json","Index":344}],"2021-05-01-preview":[{"RelativePath":"network/microsoft.network/2021-05-01-preview/types.json","Index":336}],"2022-02-01-preview":[{"RelativePath":"network/microsoft.network/2022-02-01-preview/types.json","Index":342}]},"microsoft.network/firewallpolicies":{"2021-05-01":[{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2514},{"RelativePath":"network/microsoft.network/2021-05-01/types.json","Index":2518}],"2021-08-01":[{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2609},{"RelativePath":"network/microsoft.network/2021-08-01/types.json","Index":2613}]},"microsoft.notificationhubs/namespaces/authorizationrules":{"2014-09-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":51}],"2016-03-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":58}],"2017-04-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":58}]},"microsoft.notificationhubs/namespaces/notificationhubs/authorizationrules":{"2014-09-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2014-09-01/types.json","Index":52}],"2016-03-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2016-03-01/types.json","Index":59}],"2017-04-01":[{"RelativePath":"notificationhubs/microsoft.notificationhubs/2017-04-01/types.json","Index":59}]},"microsoft.operationalinsights/workspaces":{"2015-03-20":[{"RelativePath":"operationalinsights/microsoft.operationalinsights/2015-03-20/types.json","Index":29}]},"microsoft.orbital/spacecrafts":{"2021-04-04-preview":[{"RelativePath":"orbital/microsoft.orbital/2021-04-04-preview/types.json","Index":84}],"2022-03-01":[{"RelativePath":"orbital/microsoft.orbital/2022-03-01/types.json","Index":110}]},"microsoft.policyinsights/remediations":{"2018-07-01-preview":[{"RelativePath":"policyinsights/microsoft.policyinsights/2018-07-01-preview/types.json","Index":23}],"2019-07-01":[{"RelativePath":"policyinsights/microsoft.policyinsights/2019-07-01/types.json","Index":26}],"2021-10-01":[{"RelativePath":"policyinsights/microsoft.policyinsights/2021-10-01/types.json","Index":38}]},"microsoft.powerbi/workspacecollections":{"2016-01-29":[{"RelativePath":"powerbiembedded/microsoft.powerbi/2016-01-29/types.json","Index":19}]},"microsoft.purview/accounts":{"2020-12-01-preview":[{"RelativePath":"purview/microsoft.purview/2020-12-01-preview/types.json","Index":64}],"2021-07-01":[{"RelativePath":"purview/microsoft.purview/2021-07-01/types.json","Index":68}]},"microsoft.redhatopenshift/openshiftclusters":{"2020-04-30":[{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.json","Index":46}],"2021-09-01-preview":[{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.json","Index":106},{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.json","Index":108}],"2022-04-01":[{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.json","Index":58},{"RelativePath":"redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.json","Index":60}]},"microsoft.cache/redis":{"2015-08-01":[{"RelativePath":"redis/microsoft.cache/2015-08-01/types.json","Index":25}],"2016-04-01":[{"RelativePath":"redis/microsoft.cache/2016-04-01/types.json","Index":48}],"2017-02-01":[{"RelativePath":"redis/microsoft.cache/2017-02-01/types.json","Index":59}],"2017-10-01":[{"RelativePath":"redis/microsoft.cache/2017-10-01/types.json","Index":60}],"2018-03-01":[{"RelativePath":"redis/microsoft.cache/2018-03-01/types.json","Index":77}],"2019-07-01":[{"RelativePath":"redis/microsoft.cache/2019-07-01/types.json","Index":79}],"2020-06-01":[{"RelativePath":"redis/microsoft.cache/2020-06-01/types.json","Index":100}],"2020-12-01":[{"RelativePath":"redis/microsoft.cache/2020-12-01/types.json","Index":100}],"2021-06-01":[{"RelativePath":"redis/microsoft.cache/2021-06-01/types.json","Index":108}]},"microsoft.cache/redisenterprise/databases":{"2020-10-01-preview":[{"RelativePath":"redisenterprise/microsoft.cache/2020-10-01-preview/types.json","Index":105}],"2021-02-01-preview":[{"RelativePath":"redisenterprise/microsoft.cache/2021-02-01-preview/types.json","Index":126}],"2021-03-01":[{"RelativePath":"redisenterprise/microsoft.cache/2021-03-01/types.json","Index":117}],"2021-08-01":[{"RelativePath":"redisenterprise/microsoft.cache/2021-08-01/types.json","Index":117}],"2022-01-01":[{"RelativePath":"redisenterprise/microsoft.cache/2022-01-01/types.json","Index":126}]},"microsoft.relay/namespaces/authorizationrules":{"2016-07-01":[{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":51}],"2017-04-01":[{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":56}],"2021-11-01":[{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":100}]},"microsoft.relay/namespaces/hybridconnections/authorizationrules":{"2016-07-01":[{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":52}],"2017-04-01":[{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":57}],"2021-11-01":[{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":101}]},"microsoft.relay/namespaces/wcfrelays/authorizationrules":{"2016-07-01":[{"RelativePath":"relay/microsoft.relay/2016-07-01/types.json","Index":53}],"2017-04-01":[{"RelativePath":"relay/microsoft.relay/2017-04-01/types.json","Index":58}],"2021-11-01":[{"RelativePath":"relay/microsoft.relay/2021-11-01/types.json","Index":102}]},"microsoft.resourceconnector/appliances":{"2021-10-31-preview":[{"RelativePath":"resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.json","Index":47}]},"microsoft.search/searchservices":{"2015-02-28":[{"RelativePath":"search/microsoft.search/2015-02-28/types.json","Index":20}],"2015-08-19":[{"RelativePath":"search/microsoft.search/2015-08-19/types.json","Index":42},{"RelativePath":"search/microsoft.search/2015-08-19/types.json","Index":46}],"2019-10-01-preview":[{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":62},{"RelativePath":"search/microsoft.search/2019-10-01-preview/types.json","Index":66}],"2020-03-13":[{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":62},{"RelativePath":"search/microsoft.search/2020-03-13/types.json","Index":66}],"2020-08-01-preview":[{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":80},{"RelativePath":"search/microsoft.search/2020-08-01-preview/types.json","Index":84}],"2020-08-01":[{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":80},{"RelativePath":"search/microsoft.search/2020-08-01/types.json","Index":84}],"2021-04-01-preview":[{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":108},{"RelativePath":"search/microsoft.search/2021-04-01-preview/types.json","Index":112}]},"microsoft.security/ingestionsettings":{"2021-01-15-preview":[{"RelativePath":"security/microsoft.security/2021-01-15-preview/types.json","Index":13},{"RelativePath":"security/microsoft.security/2021-01-15-preview/types.json","Index":17}]},"microsoft.servicebus/namespaces/authorizationrules":{"2015-08-01":[{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":120}],"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":136}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":173}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":181}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":185}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":185}]},"microsoft.servicebus/namespaces/queues/authorizationrules":{"2015-08-01":[{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":121}],"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":137}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":175}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":183}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":187}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":187}]},"microsoft.servicebus/namespaces/topics/authorizationrules":{"2015-08-01":[{"RelativePath":"servicebus/microsoft.servicebus/2015-08-01/types.json","Index":122}],"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":138}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":176}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":184}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":188}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":188}]},"microsoft.servicebus/namespaces/disasterrecoveryconfigs/authorizationrules":{"2017-04-01":[{"RelativePath":"servicebus/microsoft.servicebus/2017-04-01/types.json","Index":139}],"2018-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2018-01-01-preview/types.json","Index":174}],"2021-01-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-01-01-preview/types.json","Index":182}],"2021-06-01-preview":[{"RelativePath":"servicebus/microsoft.servicebus/2021-06-01-preview/types.json","Index":186}],"2021-11-01":[{"RelativePath":"servicebus/microsoft.servicebus/2021-11-01/types.json","Index":186}]},"microsoft.servicefabric/clusters":{"2020-12-01-preview":[{"RelativePath":"servicefabric/microsoft.servicefabric/2020-12-01-preview/types.json","Index":204}],"2021-06-01":[{"RelativePath":"servicefabric/microsoft.servicefabric/2021-06-01/types.json","Index":217}]},"microsoft.servicefabricmesh/secrets/values":{"2018-09-01-preview":[{"RelativePath":"servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.json","Index":188}]},"microsoft.servicelinker/linkers":{"2021-11-01-preview":[{"RelativePath":"servicelinker/microsoft.servicelinker/2021-11-01-preview/types.json","Index":54}],"2022-01-01-preview":[{"RelativePath":"servicelinker/microsoft.servicelinker/2022-01-01-preview/types.json","Index":71}],"2022-05-01":[{"RelativePath":"servicelinker/microsoft.servicelinker/2022-05-01/types.json","Index":71}]},"microsoft.signalrservice/signalr":{"2018-03-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2018-03-01-preview/types.json","Index":31}],"2018-10-01":[{"RelativePath":"signalr/microsoft.signalrservice/2018-10-01/types.json","Index":39}],"2020-05-01":[{"RelativePath":"signalr/microsoft.signalrservice/2020-05-01/types.json","Index":101}],"2020-07-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2020-07-01-preview/types.json","Index":110}],"2021-04-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2021-04-01-preview/types.json","Index":149}],"2021-06-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2021-06-01-preview/types.json","Index":149}],"2021-09-01-preview":[{"RelativePath":"signalr/microsoft.signalrservice/2021-09-01-preview/types.json","Index":149}],"2021-10-01":[{"RelativePath":"signalr/microsoft.signalrservice/2021-10-01/types.json","Index":153}],"2022-02-01":[{"RelativePath":"signalr/microsoft.signalrservice/2022-02-01/types.json","Index":187}]},"microsoft.storage/storageaccounts":{"2015-05-01-preview":[{"RelativePath":"storage/microsoft.storage/2015-05-01-preview/types.json","Index":33}],"2015-06-15":[{"RelativePath":"storage/microsoft.storage/2015-06-15/types.json","Index":33}],"2016-01-01":[{"RelativePath":"storage/microsoft.storage/2016-01-01/types.json","Index":53}],"2016-05-01":[{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":53},{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":77},{"RelativePath":"storage/microsoft.storage/2016-05-01/types.json","Index":97}],"2016-12-01":[{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":53},{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":77},{"RelativePath":"storage/microsoft.storage/2016-12-01/types.json","Index":97}],"2017-06-01":[{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":90},{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":114},{"RelativePath":"storage/microsoft.storage/2017-06-01/types.json","Index":134}],"2017-10-01":[{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":92},{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":116},{"RelativePath":"storage/microsoft.storage/2017-10-01/types.json","Index":136}],"2018-02-01":[{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":134},{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":158},{"RelativePath":"storage/microsoft.storage/2018-02-01/types.json","Index":178}],"2018-03-01-preview":[{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":141},{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":165},{"RelativePath":"storage/microsoft.storage/2018-03-01-preview/types.json","Index":185}],"2018-07-01":[{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":167},{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":191},{"RelativePath":"storage/microsoft.storage/2018-07-01/types.json","Index":211}],"2018-11-01":[{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":188},{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":212},{"RelativePath":"storage/microsoft.storage/2018-11-01/types.json","Index":232}],"2019-04-01":[{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":217},{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":241},{"RelativePath":"storage/microsoft.storage/2019-04-01/types.json","Index":261}],"2019-06-01":[{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":330},{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":354},{"RelativePath":"storage/microsoft.storage/2019-06-01/types.json","Index":374}],"2020-08-01-preview":[{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":338},{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":362},{"RelativePath":"storage/microsoft.storage/2020-08-01-preview/types.json","Index":382}],"2021-01-01":[{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":345},{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":369},{"RelativePath":"storage/microsoft.storage/2021-01-01/types.json","Index":389}],"2021-02-01":[{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":350},{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":374},{"RelativePath":"storage/microsoft.storage/2021-02-01/types.json","Index":394}],"2021-04-01":[{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":385},{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":409},{"RelativePath":"storage/microsoft.storage/2021-04-01/types.json","Index":429}],"2021-06-01":[{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":389},{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":413},{"RelativePath":"storage/microsoft.storage/2021-06-01/types.json","Index":433}],"2021-08-01":[{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":404},{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":428},{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":448}],"2021-09-01":[{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":427},{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":451},{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":471}]},"microsoft.storage/storageaccounts/localusers":{"2021-08-01":[{"RelativePath":"storage/microsoft.storage/2021-08-01/types.json","Index":451}],"2021-09-01":[{"RelativePath":"storage/microsoft.storage/2021-09-01/types.json","Index":474}]},"microsoft.importexport/jobs":{"2016-11-01":[{"RelativePath":"storageimportexport/microsoft.importexport/2016-11-01/types.json","Index":55}],"2020-08-01":[{"RelativePath":"storageimportexport/microsoft.importexport/2020-08-01/types.json","Index":55}],"2021-01-01":[{"RelativePath":"storageimportexport/microsoft.importexport/2021-01-01/types.json","Index":55}]},"microsoft.storsimple/managers":{"2017-06-01":[{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":166},{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":172}]},"microsoft.storsimple/managers/devices":{"2017-06-01":[{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":185},{"RelativePath":"storsimple8000series/microsoft.storsimple/2017-06-01/types.json","Index":217}]},"microsoft.streamanalytics/clusters":{"2020-03-01-preview":[{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.json","Index":46}],"2020-03-01":[{"RelativePath":"streamanalytics/microsoft.streamanalytics/2020-03-01/types.json","Index":267}]},"microsoft.synapse/workspaces/integrationruntimes":{"2019-06-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2019-06-01-preview/types.json","Index":383}],"2020-12-01":[{"RelativePath":"synapse/microsoft.synapse/2020-12-01/types.json","Index":395}],"2021-03-01":[{"RelativePath":"synapse/microsoft.synapse/2021-03-01/types.json","Index":398}],"2021-04-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2021-04-01-preview/types.json","Index":622}],"2021-05-01":[{"RelativePath":"synapse/microsoft.synapse/2021-05-01/types.json","Index":403}],"2021-06-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":673}],"2021-06-01":[{"RelativePath":"synapse/microsoft.synapse/2021-06-01/types.json","Index":425}]},"microsoft.synapse/workspaces/kustopools":{"2021-06-01-preview":[{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":674},{"RelativePath":"synapse/microsoft.synapse/2021-06-01-preview/types.json","Index":678}]},"microsoft.media/videoanalyzers/edgemodules":{"2021-05-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":85}],"2021-11-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":228}]},"microsoft.media/videoanalyzers/videos":{"2021-05-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-05-01-preview/types.json","Index":87}],"2021-11-01-preview":[{"RelativePath":"videoanalyzer/microsoft.media/2021-11-01-preview/types.json","Index":230}]},"microsoft.avs/privateclouds":{"2020-03-20":[{"RelativePath":"vmware/microsoft.avs/2020-03-20/types.json","Index":73}],"2020-07-17-preview":[{"RelativePath":"vmware/microsoft.avs/2020-07-17-preview/types.json","Index":197}],"2021-01-01-preview":[{"RelativePath":"vmware/microsoft.avs/2021-01-01-preview/types.json","Index":212}],"2021-06-01":[{"RelativePath":"vmware/microsoft.avs/2021-06-01/types.json","Index":269}],"2021-12-01":[{"RelativePath":"vmware/microsoft.avs/2021-12-01/types.json","Index":328}]},"microsoft.domainregistration/topleveldomains":{"2015-04-01":[{"RelativePath":"web/microsoft.domainregistration/2015-04-01/types.json","Index":79}],"2015-08-01":[{"RelativePath":"web/microsoft.domainregistration/2015-08-01/types.json","Index":68}],"2018-02-01":[{"RelativePath":"web/microsoft.domainregistration/2018-02-01/types.json","Index":79}],"2019-08-01":[{"RelativePath":"web/microsoft.domainregistration/2019-08-01/types.json","Index":79}],"2020-06-01":[{"RelativePath":"web/microsoft.domainregistration/2020-06-01/types.json","Index":79}],"2020-09-01":[{"RelativePath":"web/microsoft.domainregistration/2020-09-01/types.json","Index":90}],"2020-10-01":[{"RelativePath":"web/microsoft.domainregistration/2020-10-01/types.json","Index":90}],"2020-12-01":[{"RelativePath":"web/microsoft.domainregistration/2020-12-01/types.json","Index":79}],"2021-01-01":[{"RelativePath":"web/microsoft.domainregistration/2021-01-01/types.json","Index":79}],"2021-01-15":[{"RelativePath":"web/microsoft.domainregistration/2021-01-15/types.json","Index":79}],"2021-02-01":[{"RelativePath":"web/microsoft.domainregistration/2021-02-01/types.json","Index":79}],"2021-03-01":[{"RelativePath":"web/microsoft.domainregistration/2021-03-01/types.json","Index":79}]},"microsoft.web/connections":{"2015-08-01-preview":[{"RelativePath":"web/microsoft.web/2015-08-01-preview/types.json","Index":88},{"RelativePath":"web/microsoft.web/2015-08-01-preview/types.json","Index":94}],"2016-06-01":[{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":83}]},"microsoft.web/sites/slots/config":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":483}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":491}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":666}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":551}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":707}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":815}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":826}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":826}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":849}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":893}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":898}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":906}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":972}]},"microsoft.web/sites/config":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":484}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":482}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":654}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":542}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":693}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":802}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":813}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":813}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":836}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":880}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":885}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":893}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":959}]},"microsoft.web/sites/slots/backups":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":502}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":490}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":665}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":550}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":706}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":814}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":825}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":825}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":848}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":892}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":897}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":905}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":971}]},"microsoft.web/sites/backups":{"2015-08-01":[{"RelativePath":"web/microsoft.web/2015-08-01/types.json","Index":503}],"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":479}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":651}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":539}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":690}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":799}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":810}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":810}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":833}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":879}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":884}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":892}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":958}]},"microsoft.web/locations":{"2016-06-01":[{"RelativePath":"web/microsoft.web/2016-06-01/types.json","Index":72}]},"microsoft.web/sites/functions":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":485}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":655},{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":658}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":545}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":694},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":697}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":803},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":805}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":814},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":816}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":814},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":816}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":837},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":839}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":881},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":883}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":886},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":888}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":894},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":896}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":960},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":962}]},"microsoft.web/sites/hybridconnectionnamespaces/relays":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":488}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":663}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":548}]},"microsoft.web/sites":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":489}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":664}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":549}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":704},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":705}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":812},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":813}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":823},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":824}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":823},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":824}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":846},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":847}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":890},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":891}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":895},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":896}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":903},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":904}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":969},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":970}]},"microsoft.web/sites/slots/functions":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":492}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":667},{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":668}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":552}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":708},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":709}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":816},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":817}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":827},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":828}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":827},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":828}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":850},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":851}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":894},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":895}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":899},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":900}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":907},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":908}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":973},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":974}]},"microsoft.web/sites/slots/hybridconnectionnamespaces/relays":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":493}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":670}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":553}]},"microsoft.web/sites/slots":{"2016-08-01":[{"RelativePath":"web/microsoft.web/2016-08-01/types.json","Index":494}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":671}],"2018-11-01":[{"RelativePath":"web/microsoft.web/2018-11-01/types.json","Index":554}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":711},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":712}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":819},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":820}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":830},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":831}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":830},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":831}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":853},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":854}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":897},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":898}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":902},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":903}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":910},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":911}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":976},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":977}]},"microsoft.web/serverfarms/hybridconnectionnamespaces/relays":{"2016-09-01":[{"RelativePath":"web/microsoft.web/2016-09-01/types.json","Index":108}],"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":635}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":723}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":831}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":842}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":842}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":870}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":848}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":853}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":861}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":923}]},"microsoft.web/sites/host":{"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":662}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":701}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":809}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":820}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":820}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":843}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":887}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":892}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":900}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":966}]},"microsoft.web/sites/slots/host":{"2018-02-01":[{"RelativePath":"web/microsoft.web/2018-02-01/types.json","Index":669}],"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":710}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":818}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":829}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":829}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":852}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":896}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":901}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":909}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":975}]},"microsoft.web/staticsites/authproviders":{"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":717}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":825}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":836}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":836}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":859}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":853}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":858}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":866}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":932}]},"microsoft.web/staticsites/builds":{"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":718}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":826}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":837}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":837}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":860},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":861}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":856},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":857}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":861},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":862}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":869},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":870}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":935},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":936}]},"microsoft.web/staticsites":{"2019-08-01":[{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":719},{"RelativePath":"web/microsoft.web/2019-08-01/types.json","Index":720}],"2020-06-01":[{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":827},{"RelativePath":"web/microsoft.web/2020-06-01/types.json","Index":828}],"2020-09-01":[{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":838},{"RelativePath":"web/microsoft.web/2020-09-01/types.json","Index":839}],"2020-10-01":[{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":838},{"RelativePath":"web/microsoft.web/2020-10-01/types.json","Index":839}],"2020-12-01":[{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":862},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":865},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":866},{"RelativePath":"web/microsoft.web/2020-12-01/types.json","Index":867}],"2021-01-01":[{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":858},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":861},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":862},{"RelativePath":"web/microsoft.web/2021-01-01/types.json","Index":863}],"2021-01-15":[{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":863},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":866},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":867},{"RelativePath":"web/microsoft.web/2021-01-15/types.json","Index":868}],"2021-02-01":[{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":871},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":874},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":875},{"RelativePath":"web/microsoft.web/2021-02-01/types.json","Index":876}],"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":937},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":940},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":941},{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":942}]},"microsoft.web/containerapps":{"2021-03-01":[{"RelativePath":"web/microsoft.web/2021-03-01/types.json","Index":927}]},"microsoft.signalrservice/webpubsub":{"2021-04-01-preview":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-04-01-preview/types.json","Index":144}],"2021-06-01-preview":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-06-01-preview/types.json","Index":138}],"2021-09-01-preview":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-09-01-preview/types.json","Index":140}],"2021-10-01":[{"RelativePath":"webpubsub/microsoft.signalrservice/2021-10-01/types.json","Index":148}]}}} \ No newline at end of file diff --git a/generated/index.md b/generated/index.md index 8a9e52850f..407a6fa3fd 100644 --- a/generated/index.md +++ b/generated/index.md @@ -9358,25 +9358,44 @@ * [2020-01-01](securityinsights/microsoft.securityinsights/2020-01-01/types.md#resource-microsoftsecurityinsightsalertrules2020-01-01) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsalertrules2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsalertrules2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsalertrules2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsalertrules2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsalertrules2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsalertrules2022-04-01-preview) ### microsoft.securityinsights/alertrules/actions * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsalertrulesactions2019-01-01-preview) * [2020-01-01](securityinsights/microsoft.securityinsights/2020-01-01/types.md#resource-microsoftsecurityinsightsalertrulesactions2020-01-01) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsalertrulesactions2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsalertrulesactions2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsalertrulesactions2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsalertrulesactions2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsalertrulesactions2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsalertrulesactions2022-04-01-preview) ### microsoft.securityinsights/automationrules * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsautomationrules2019-01-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsautomationrules2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsautomationrules2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsautomationrules2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsautomationrules2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsautomationrules2022-04-01-preview) ### microsoft.securityinsights/bookmarks * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsbookmarks2019-01-01-preview) * [2020-01-01](securityinsights/microsoft.securityinsights/2020-01-01/types.md#resource-microsoftsecurityinsightsbookmarks2020-01-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsbookmarks2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsbookmarks2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsbookmarks2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsbookmarks2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsbookmarks2022-04-01-preview) ### microsoft.securityinsights/bookmarks/relations * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsbookmarksrelations2019-01-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsbookmarksrelations2021-09-01-preview) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsbookmarksrelations2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsbookmarksrelations2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsbookmarksrelations2022-04-01-preview) ### microsoft.securityinsights/cases * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightscases2019-01-01-preview) @@ -9392,10 +9411,17 @@ * [2020-01-01](securityinsights/microsoft.securityinsights/2020-01-01/types.md#resource-microsoftsecurityinsightsdataconnectors2020-01-01) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsdataconnectors2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsdataconnectors2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsdataconnectors2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsdataconnectors2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsdataconnectors2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsdataconnectors2022-04-01-preview) ### microsoft.securityinsights/entityqueries * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsentityqueries2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsentityqueries2021-09-01-preview) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsentityqueries2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsentityqueries2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsentityqueries2022-04-01-preview) ### microsoft.securityinsights/incidents * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsincidents2019-01-01-preview) @@ -9403,6 +9429,10 @@ * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsincidents2021-03-01-preview) * [2021-04-01](securityinsights/microsoft.securityinsights/2021-04-01/types.md#resource-microsoftsecurityinsightsincidents2021-04-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsincidents2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsincidents2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsincidents2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsincidents2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsincidents2022-04-01-preview) ### microsoft.securityinsights/incidents/comments * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsincidentscomments2019-01-01-preview) @@ -9410,46 +9440,79 @@ * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsincidentscomments2021-03-01-preview) * [2021-04-01](securityinsights/microsoft.securityinsights/2021-04-01/types.md#resource-microsoftsecurityinsightsincidentscomments2021-04-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsincidentscomments2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsincidentscomments2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsincidentscomments2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsincidentscomments2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsincidentscomments2022-04-01-preview) ### microsoft.securityinsights/incidents/relations * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsincidentsrelations2019-01-01-preview) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsincidentsrelations2021-03-01-preview) * [2021-04-01](securityinsights/microsoft.securityinsights/2021-04-01/types.md#resource-microsoftsecurityinsightsincidentsrelations2021-04-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsincidentsrelations2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsincidentsrelations2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsincidentsrelations2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsincidentsrelations2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsincidentsrelations2022-04-01-preview) ### microsoft.securityinsights/metadata * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsmetadata2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsmetadata2021-09-01-preview) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsmetadata2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsmetadata2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsmetadata2022-04-01-preview) ### microsoft.securityinsights/onboardingstates * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightsonboardingstates2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsonboardingstates2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsonboardingstates2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsonboardingstates2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsonboardingstates2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsonboardingstates2022-04-01-preview) ### microsoft.securityinsights/settings * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightssettings2019-01-01-preview) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightssettings2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightssettings2021-09-01-preview) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightssettings2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightssettings2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightssettings2022-04-01-preview) ### microsoft.securityinsights/sourcecontrols * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightssourcecontrols2021-03-01-preview) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightssourcecontrols2021-09-01-preview) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightssourcecontrols2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightssourcecontrols2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightssourcecontrols2022-04-01-preview) ### microsoft.securityinsights/threatintelligence/indicators * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2019-01-01-preview) * [2021-04-01](securityinsights/microsoft.securityinsights/2021-04-01/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2021-04-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightsthreatintelligenceindicators2022-04-01-preview) ### microsoft.securityinsights/watchlists * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightswatchlists2019-01-01-preview) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightswatchlists2021-03-01-preview) * [2021-04-01](securityinsights/microsoft.securityinsights/2021-04-01/types.md#resource-microsoftsecurityinsightswatchlists2021-04-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightswatchlists2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightswatchlists2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightswatchlists2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightswatchlists2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightswatchlists2022-04-01-preview) ### microsoft.securityinsights/watchlists/watchlistitems * [2019-01-01-preview](securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2019-01-01-preview) * [2021-03-01-preview](securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2021-03-01-preview) * [2021-04-01](securityinsights/microsoft.securityinsights/2021-04-01/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2021-04-01) * [2021-09-01-preview](securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2021-09-01-preview) +* [2021-10-01](securityinsights/microsoft.securityinsights/2021-10-01/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2021-10-01) +* [2021-10-01-preview](securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2021-10-01-preview) +* [2022-01-01-preview](securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2022-01-01-preview) +* [2022-04-01-preview](securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md#resource-microsoftsecurityinsightswatchlistswatchlistitems2022-04-01-preview) ## microsoft.serialconsole ### microsoft.serialconsole/serialports diff --git a/generated/intune/log.out b/generated/intune/log.out index df205e985e..fb024d07f2 100644 --- a/generated/intune/log.out +++ b/generated/intune/log.out @@ -4,10 +4,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.intune-2015-01-14-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/intune/resource-manager/Microsoft.Intune/preview/2015-01-14-preview/intune.json:1712:5 @@ -86,5 +86,5 @@ warning | PreCheck/SchemaMissingType | The schema 'FlaggedEnrolledAppProperties' warning | PreCheck/SchemaMissingType | The schema 'FlaggedEnrolledAppError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/intune/resource-manager/Microsoft.Intune/preview/2015-01-14-preview/intune.json:2476:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 19ms -info | Autorest completed in 5.38s. 2 files generated. +info | autorest.bicep took 17ms +info | Autorest completed in 5.26s. 2 files generated. diff --git a/generated/intune/microsoft.intune/2015-01-14-preview/types.md b/generated/intune/microsoft.intune/2015-01-14-preview/types.md index af408c73b8..c5c537a47d 100644 --- a/generated/intune/microsoft.intune/2015-01-14-preview/types.md +++ b/generated/intune/microsoft.intune/2015-01-14-preview/types.md @@ -81,15 +81,6 @@ * **pinNumRetry**: int * **screenCapture**: 'allow' | 'block' | string -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MAMPolicyAppOrGroupIdProperties -### Properties -* **url**: string (Required) - ## IOsmamPolicyProperties ### Properties * **accessRecheckOfflineTimeout**: string @@ -113,6 +104,15 @@ * **pinNumRetry**: int * **touchId**: 'disable' | 'enable' | string +## MAMPolicyAppOrGroupIdProperties +### Properties +* **url**: string (Required) + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/iotcentral/log.out b/generated/iotcentral/log.out index 8e8331ee40..91e409b692 100644 --- a/generated/iotcentral/log.out +++ b/generated/iotcentral/log.out @@ -11,7 +11,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.iotcentral-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -22,10 +22,10 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.iotcentral-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -36,14 +36,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/iotcentral.json:611:5 warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/iotcentral.json:652:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.iotcentral-2018-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -54,7 +54,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json:588:5 @@ -62,4 +62,4 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json:629:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 8.7s. 6 files generated. +info | Autorest completed in 8.67s. 6 files generated. diff --git a/generated/iotcentral/microsoft.iotcentral/2021-06-01/types.md b/generated/iotcentral/microsoft.iotcentral/2021-06-01/types.md index b9750d162e..55083e44b8 100644 --- a/generated/iotcentral/microsoft.iotcentral/2021-06-01/types.md +++ b/generated/iotcentral/microsoft.iotcentral/2021-06-01/types.md @@ -13,12 +13,6 @@ * **tags**: [ResourceTags](#resourcetags): The resource tags. * **type**: 'Microsoft.IoTCentral/iotApps' (ReadOnly, DeployTimeConstant): The resource type -## SystemAssignedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | string (Required): Type of managed service identity (either system assigned, or none). - ## AppProperties ### Properties * **applicationId**: string (ReadOnly): The ID of the application. @@ -36,3 +30,9 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemAssignedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | string (Required): Type of managed service identity (either system assigned, or none). + diff --git a/generated/iotcentral/microsoft.iotcentral/2021-11-01-preview/types.md b/generated/iotcentral/microsoft.iotcentral/2021-11-01-preview/types.md index bdde110484..6aee44bf8e 100644 --- a/generated/iotcentral/microsoft.iotcentral/2021-11-01-preview/types.md +++ b/generated/iotcentral/microsoft.iotcentral/2021-11-01-preview/types.md @@ -24,12 +24,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.IoTCentral/iotApps/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## SystemAssignedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | string (Required): Type of managed service identity (either system assigned, or none). - ## AppProperties ### Properties * **applicationId**: string (ReadOnly): The ID of the application. @@ -42,6 +36,15 @@ * **subdomain**: string: The subdomain of the application. * **template**: 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. +## AppSkuInfo +### Properties +* **name**: 'ST0' | 'ST1' | 'ST2' | string (Required): The name of the SKU. + +## NetworkRuleSetIpRule +### Properties +* **filterName**: string: The readable name of the IP rule. +* **ipMask**: string: The CIDR block defining the IP range. + ## NetworkRuleSets ### Properties * **applyToDevices**: bool: Whether these rules apply for device connectivity to IoT Hub and Device Provisioning service associated with this application. @@ -49,10 +52,9 @@ * **defaultAction**: 'Allow' | 'Deny' | string: Whether to allow or deny network traffic. * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[]: List of IP rules. -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **filterName**: string: The readable name of the IP rule. -* **ipMask**: string: The CIDR block defining the IP range. +* **id**: string (ReadOnly): The ARM identifier for private endpoint. ## PrivateEndpointConnection ### Properties @@ -69,16 +71,18 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for private endpoint. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## SystemAssignedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | string (Required): Type of managed service identity (either system assigned, or none). + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -88,10 +92,6 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AppSkuInfo -### Properties -* **name**: 'ST0' | 'ST1' | 'ST2' | string (Required): The name of the SKU. - ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/iothub/log.out b/generated/iothub/log.out index 4ea71d4fb2..5e5299b0bc 100644 --- a/generated/iothub/log.out +++ b/generated/iothub/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.devices-2021-07-02"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-02/iothub.json:3307:5 @@ -23,10 +23,10 @@ warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-02/iothub.json#/components/schemas/components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties -info | autorest.bicep took 18ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.devices-2021-07-02-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-02-preview/iothub.json:3326:5 @@ -46,7 +46,7 @@ warning | Modeler/MissingType | The schema 'components·11psznm·schemas·eventh info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.devices-2021-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/iothub.json:3298:5 @@ -66,7 +66,7 @@ warning | Modeler/MissingType | The schema 'components·11psznm·schemas·eventh info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.devices-2021-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/iothub.json:3317:5 @@ -86,7 +86,7 @@ warning | Modeler/MissingType | The schema 'components·11psznm·schemas·eventh info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.devices-2021-03-31"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-03-31/iothub.json:3271:5 @@ -103,10 +103,10 @@ warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-03-31/iothub.json#/components/schemas/components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2021-03-03-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-03-03-preview/iothub.json:3291:5 @@ -121,10 +121,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-03-03-preview/iothub.json:3969:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.devices-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-02-01-preview/iothub.json:3271:5 @@ -139,10 +139,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-02-01-preview/iothub.json:3949:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.devices-2020-08-31"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-08-31/iothub.json:3248:5 @@ -157,10 +157,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-08-31/iothub.json:3924:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2020-08-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2020-08-31-preview/iothub.json:3270:5 @@ -175,10 +175,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2020-08-31-preview/iothub.json:3947:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.devices-2020-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-08-01/iothub.json:3181:5 @@ -196,7 +196,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2020-07-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2020-07-10-preview/iothub.json:3203:5 @@ -211,10 +211,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2020-07-10-preview/iothub.json:3880:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2020-06-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/iothub.json:3181:5 @@ -229,10 +229,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/iothub.json:3857:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2020-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/iothub.json:3172:5 @@ -251,7 +251,7 @@ info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergrou info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-03-01/iothub.json:3170:5 @@ -270,7 +270,7 @@ info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergrou info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.devices-2019-11-04"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2019-11-04/iothub.json:2592:5 @@ -286,10 +286,10 @@ warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2019-11-04/iothub.json:3229:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergroups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' has no body defined. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.devices-2019-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json:2606:5 @@ -308,7 +308,7 @@ info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergrou info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2019-03-22"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2019-03-22/iothub.json:2558:5 @@ -324,10 +324,10 @@ warning | PreCheck/SchemaMissingType | The schema 'RoutingTwin-properties' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2019-03-22/iothub.json:3195:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergroups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' has no body defined. -info | autorest.bicep took 6ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2019-03-22-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-03-22-preview/iothub.json:2605:5 @@ -346,7 +346,7 @@ info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergrou info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2018-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json:2525:5 @@ -365,7 +365,7 @@ info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergrou info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2018-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json:2504:5 @@ -384,7 +384,7 @@ info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergrou info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.devices-2018-01-22"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-01-22/iothub.json:2255:5 @@ -398,10 +398,10 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource-tags' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-01-22/iothub.json:2468:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergroups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2017-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-07-01/iothub.json:2068:5 @@ -411,23 +411,23 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-07-01/iothub.json:2149:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergroups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2017-01-19"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-01-19/iothub.json:1610:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergroups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' has no body defined. -info | autorest.bicep took 2ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.devices-2016-02-03"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2016-02-03/iothub.json:1490:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.devices/iothubs/eventhubendpoints/consumergroups under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' has no body defined. -info | autorest.bicep took 3ms -info | Autorest completed in 75.08s. 48 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 73.31s. 48 files generated. diff --git a/generated/iothub/microsoft.devices/2016-02-03/types.md b/generated/iothub/microsoft.devices/2016-02-03/types.md index 3c94f3d5bf..66dda0c392 100644 --- a/generated/iothub/microsoft.devices/2016-02-03/types.md +++ b/generated/iothub/microsoft.devices/2016-02-03/types.md @@ -34,6 +34,31 @@ * **ApiVersion**: 2016-02-03 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -49,37 +74,26 @@ * **provisioningState**: string (ReadOnly): The provisioning state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int (Required): The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -87,11 +101,6 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload. @@ -107,37 +116,17 @@ ### Additional Properties * **Additional Properties Type**: 'Error' | 'Error, Information' | 'Information' | 'None' | string -## IotHubPropertiesStorageEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) - -## StorageEndpointProperties -### Properties -* **connectionString**: string (Required): The connection string for the Azure Storage account to which files are uploaded. -* **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. -* **sasTtlAsIso8601**: 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. - -## IotHubSkuInfo -### Properties -* **capacity**: int (Required): The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EventHubConsumerGroupInfoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult +## SharedAccessSignatureAuthorizationRule ### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. ## SharedAccessSignatureAuthorizationRule ### Properties @@ -146,3 +135,14 @@ * **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. * **secondaryKey**: string: The secondary key. +## SharedAccessSignatureAuthorizationRuleListResult +### Properties +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. + +## StorageEndpointProperties +### Properties +* **connectionString**: string (Required): The connection string for the Azure Storage account to which files are uploaded. +* **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. +* **sasTtlAsIso8601**: 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. + diff --git a/generated/iothub/microsoft.devices/2017-01-19/types.md b/generated/iothub/microsoft.devices/2017-01-19/types.md index 67117f355d..65aa005dd0 100644 --- a/generated/iothub/microsoft.devices/2017-01-19/types.md +++ b/generated/iothub/microsoft.devices/2017-01-19/types.md @@ -34,6 +34,38 @@ * **ApiVersion**: 2017-01-19 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled or not. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -50,37 +82,26 @@ * **routing**: [RoutingProperties](#routingproperties): The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int (Required): The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -88,11 +109,6 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. @@ -108,11 +124,18 @@ ### Additional Properties * **Additional Properties Type**: 'Error' | 'Error, Information' | 'Information' | 'None' | string -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties related to the fallback route based on which the IoT hub routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -127,6 +150,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties related to the fallback route based on which the IoT hub routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -141,25 +170,24 @@ * **resourceGroup**: string: The name of the resource group of the service bus topic endpoint. * **subscriptionId**: string: The subscription identifier of the service bus topic endpoint. -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled or not. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -167,31 +195,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int (Required): The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventHubConsumerGroupInfoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2017-07-01/types.md b/generated/iothub/microsoft.devices/2017-07-01/types.md index ff50fdc117..cb73335864 100644 --- a/generated/iothub/microsoft.devices/2017-07-01/types.md +++ b/generated/iothub/microsoft.devices/2017-07-01/types.md @@ -45,6 +45,47 @@ * **ApiVersion**: 2017-07-01 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -61,37 +102,26 @@ * **routing**: [RoutingProperties](#routingproperties): The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int (Required): The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -99,11 +129,6 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. @@ -119,11 +144,18 @@ ### Additional Properties * **Additional Properties Type**: 'Error' | 'Error, Information' | 'Information' | 'None' | string -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -139,6 +171,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -165,25 +203,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -191,40 +228,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int (Required): The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2018-01-22/types.md b/generated/iothub/microsoft.devices/2018-01-22/types.md index 118600edb1..c5e36f0315 100644 --- a/generated/iothub/microsoft.devices/2018-01-22/types.md +++ b/generated/iothub/microsoft.devices/2018-01-22/types.md @@ -44,6 +44,48 @@ * **ApiVersion**: 2018-01-22 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -61,37 +103,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -99,11 +130,6 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. @@ -119,11 +145,18 @@ ### Additional Properties * **Additional Properties Type**: 'Error' | 'Error, Information' | 'Information' | 'None' | string -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -139,6 +172,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -165,26 +204,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -192,40 +229,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2018-04-01/types.md b/generated/iothub/microsoft.devices/2018-04-01/types.md index ed80c934ef..727c361620 100644 --- a/generated/iothub/microsoft.devices/2018-04-01/types.md +++ b/generated/iothub/microsoft.devices/2018-04-01/types.md @@ -44,6 +44,49 @@ * **ApiVersion**: 2018-04-01 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -61,37 +104,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -99,11 +131,6 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. @@ -119,11 +146,18 @@ ### Additional Properties * **Additional Properties Type**: 'Error' | 'Error, Information' | 'Information' | 'None' | string -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -139,6 +173,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -165,26 +205,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -192,41 +230,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2018-12-01-preview/types.md b/generated/iothub/microsoft.devices/2018-12-01-preview/types.md index fa935a2790..2cbdf76366 100644 --- a/generated/iothub/microsoft.devices/2018-12-01-preview/types.md +++ b/generated/iothub/microsoft.devices/2018-12-01-preview/types.md @@ -44,6 +44,54 @@ * **ApiVersion**: 2018-12-01-preview * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: Azure Geo Regions +* **role**: 'primary' | 'secondary' | string: Specific Role assigned to this location + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -62,25 +110,6 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. @@ -90,29 +119,27 @@ ### Additional Properties * **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## EventHubProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IpFilterRule +## IotHubPropertiesStorageEndpoints ### Properties -* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. -* **filterName**: string (Required): The name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +### Additional Properties +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## IotHubLocationDescription +## IotHubSkuInfo ### Properties -* **location**: string: Azure Geo Regions -* **role**: 'primary' | 'secondary' | string: Specific Role assigned to this location +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. -## IotHubPropertiesMessagingEndpoints +## IpFilterRule ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. +* **filterName**: string (Required): The name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. ## MessagingEndpointProperties ### Properties @@ -120,11 +147,18 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -140,6 +174,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -166,26 +206,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -193,41 +231,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2019-03-22-preview/types.md b/generated/iothub/microsoft.devices/2019-03-22-preview/types.md index 4cfd9f24b2..fabe09559e 100644 --- a/generated/iothub/microsoft.devices/2019-03-22-preview/types.md +++ b/generated/iothub/microsoft.devices/2019-03-22-preview/types.md @@ -44,6 +44,60 @@ * **ApiVersion**: 2019-03-22-preview * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: Azure Geo Regions +* **role**: 'primary' | 'secondary' | string: Specific Role assigned to this location + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -62,25 +116,6 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. @@ -90,29 +125,27 @@ ### Additional Properties * **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## EventHubProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IpFilterRule +## IotHubPropertiesStorageEndpoints ### Properties -* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. -* **filterName**: string (Required): The name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +### Additional Properties +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## IotHubLocationDescription +## IotHubSkuInfo ### Properties -* **location**: string: Azure Geo Regions -* **role**: 'primary' | 'secondary' | string: Specific Role assigned to this location +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. -## IotHubPropertiesMessagingEndpoints +## IpFilterRule ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. +* **filterName**: string (Required): The name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. ## MessagingEndpointProperties ### Properties @@ -120,12 +153,18 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/iotmsgenrich -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -141,6 +180,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/iotmsgenrich +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -167,32 +213,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -200,41 +238,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2019-03-22/types.md b/generated/iothub/microsoft.devices/2019-03-22/types.md index 7c21555ed4..9e69f4b017 100644 --- a/generated/iothub/microsoft.devices/2019-03-22/types.md +++ b/generated/iothub/microsoft.devices/2019-03-22/types.md @@ -44,6 +44,54 @@ * **ApiVersion**: 2019-03-22 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -61,37 +109,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -99,27 +136,24 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -135,6 +169,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -161,26 +201,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -188,41 +226,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2019-07-01-preview/types.md b/generated/iothub/microsoft.devices/2019-07-01-preview/types.md index 6fa88612b9..86ea01d25b 100644 --- a/generated/iothub/microsoft.devices/2019-07-01-preview/types.md +++ b/generated/iothub/microsoft.devices/2019-07-01-preview/types.md @@ -44,6 +44,60 @@ * **ApiVersion**: 2019-07-01-preview * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: Azure Geo Regions +* **role**: 'primary' | 'secondary' | string: Specific Role assigned to this location + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -62,25 +116,6 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. @@ -90,29 +125,27 @@ ### Additional Properties * **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## EventHubProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IpFilterRule +## IotHubPropertiesStorageEndpoints ### Properties -* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. -* **filterName**: string (Required): The name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +### Additional Properties +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## IotHubLocationDescription +## IotHubSkuInfo ### Properties -* **location**: string: Azure Geo Regions -* **role**: 'primary' | 'secondary' | string: Specific Role assigned to this location +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. -## IotHubPropertiesMessagingEndpoints +## IpFilterRule ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. +* **filterName**: string (Required): The name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. ## MessagingEndpointProperties ### Properties @@ -120,12 +153,18 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/iotmsgenrich -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -141,6 +180,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/iotmsgenrich +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -167,32 +213,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -200,41 +238,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2019-11-04/types.md b/generated/iothub/microsoft.devices/2019-11-04/types.md index c1676a8de2..2a3a106178 100644 --- a/generated/iothub/microsoft.devices/2019-11-04/types.md +++ b/generated/iothub/microsoft.devices/2019-11-04/types.md @@ -44,29 +44,15 @@ * **ApiVersion**: 2019-11-04 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) -## IotHubProperties -### Properties -* **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. -* **cloudToDevice**: [CloudToDeviceProperties](#cloudtodeviceproperties): The IoT hub cloud-to-device messaging properties. -* **comments**: string: IoT hub comments. -* **enableFileUploadNotifications**: bool: If True, file upload notifications are enabled. -* **eventHubEndpoints**: [IotHubPropertiesEventHubEndpoints](#iothubpropertieseventhubendpoints): The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. -* **features**: 'DeviceManagement' | 'None' | string: The capabilities and features enabled for the IoT hub. -* **hostName**: string (ReadOnly): The name of the host. -* **ipFilterRules**: [IpFilterRule](#ipfilterrule)[]: The IP filter rules. -* **locations**: [IotHubLocationDescription](#iothublocationdescription)[] (ReadOnly): Primary and secondary location for iot hub -* **messagingEndpoints**: [IotHubPropertiesMessagingEndpoints](#iothubpropertiesmessagingendpoints): The messaging endpoint properties for the file upload notification queue. -* **provisioningState**: string (ReadOnly): The provisioning state. -* **routing**: [RoutingProperties](#routingproperties): The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging -* **state**: string (ReadOnly): The hub state. -* **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. - -## SharedAccessSignatureAuthorizationRule +## CertificateProperties ### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. ## CloudToDeviceProperties ### Properties @@ -74,16 +60,16 @@ * **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. * **maxDeliveryCount**: int: 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. -## FeedbackProperties +## EnrichmentProperties ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. -## IotHubPropertiesEventHubEndpoints +## EventHubConsumerGroupInfoProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: string ## EventHubProperties ### Properties @@ -93,34 +79,87 @@ * **path**: string (ReadOnly): The Event Hub-compatible name. * **retentionTimeInDays**: int: 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 -## IpFilterRule +## FallbackRouteProperties ### Properties -* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. -* **filterName**: string (Required): The name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. ## IotHubLocationDescription ### Properties * **location**: string: The name of the Azure region * **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +## IotHubProperties +### Properties +* **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. +* **cloudToDevice**: [CloudToDeviceProperties](#cloudtodeviceproperties): The IoT hub cloud-to-device messaging properties. +* **comments**: string: IoT hub comments. +* **enableFileUploadNotifications**: bool: If True, file upload notifications are enabled. +* **eventHubEndpoints**: [IotHubPropertiesEventHubEndpoints](#iothubpropertieseventhubendpoints): The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. +* **features**: 'DeviceManagement' | 'None' | string: The capabilities and features enabled for the IoT hub. +* **hostName**: string (ReadOnly): The name of the host. +* **ipFilterRules**: [IpFilterRule](#ipfilterrule)[]: The IP filter rules. +* **locations**: [IotHubLocationDescription](#iothublocationdescription)[] (ReadOnly): Primary and secondary location for iot hub +* **messagingEndpoints**: [IotHubPropertiesMessagingEndpoints](#iothubpropertiesmessagingendpoints): The messaging endpoint properties for the file upload notification queue. +* **provisioningState**: string (ReadOnly): The provisioning state. +* **routing**: [RoutingProperties](#routingproperties): The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging +* **state**: string (ReadOnly): The hub state. +* **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. + +## IotHubPropertiesEventHubEndpoints +### Properties +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) + ## IotHubPropertiesMessagingEndpoints ### Properties ### Additional Properties * **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +## IotHubPropertiesStorageEndpoints +### Properties +### Additional Properties +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) + +## IotHubSkuInfo +### Properties +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. + +## IpFilterRule +### Properties +* **action**: 'Accept' | 'Reject' (Required): The desired action for requests captured by this rule. +* **filterName**: string (Required): The name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -136,6 +175,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **connectionString**: string (Required): The connection string of the service bus queue endpoint. @@ -162,32 +208,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -195,41 +233,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-03-01/types.md b/generated/iothub/microsoft.devices/2020-03-01/types.md index fdee0de275..0615d7a1d4 100644 --- a/generated/iothub/microsoft.devices/2020-03-01/types.md +++ b/generated/iothub/microsoft.devices/2020-03-01/types.md @@ -53,6 +53,60 @@ * **ApiVersion**: 2020-03-01 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -73,37 +127,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -111,22 +154,16 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -139,22 +176,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -174,6 +213,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -211,32 +257,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -245,41 +283,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-04-01/types.md b/generated/iothub/microsoft.devices/2020-04-01/types.md index f5cec23ece..eab649ca3b 100644 --- a/generated/iothub/microsoft.devices/2020-04-01/types.md +++ b/generated/iothub/microsoft.devices/2020-04-01/types.md @@ -53,6 +53,60 @@ * **ApiVersion**: 2020-04-01 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string (ReadOnly): The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupInfoProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -73,37 +127,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -111,22 +154,16 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -139,22 +176,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -174,6 +213,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -211,32 +257,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -245,41 +283,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string (ReadOnly): The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupInfoProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-06-15/types.md b/generated/iothub/microsoft.devices/2020-06-15/types.md index afc0638831..c12c79b2cd 100644 --- a/generated/iothub/microsoft.devices/2020-06-15/types.md +++ b/generated/iothub/microsoft.devices/2020-06-15/types.md @@ -52,6 +52,59 @@ * **ApiVersion**: 2020-06-15 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -72,37 +125,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -110,22 +152,16 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -138,22 +174,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -173,6 +211,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -210,32 +255,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -244,40 +281,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-07-10-preview/types.md b/generated/iothub/microsoft.devices/2020-07-10-preview/types.md index 99903d09c1..e1728e1da6 100644 --- a/generated/iothub/microsoft.devices/2020-07-10-preview/types.md +++ b/generated/iothub/microsoft.devices/2020-07-10-preview/types.md @@ -70,6 +70,64 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EncryptionPropertiesDescription +### Properties +* **keySource**: string: The source of the key. +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -92,55 +150,30 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. -## EncryptionPropertiesDescription -### Properties -* **keySource**: string: The source of the key. -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. - -## KeyVaultKeyProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **identity**: [KEKIdentity](#kekidentity): The properties of the KeyVault identity. -* **keyIdentifier**: string: The identifier of the key. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## KEKIdentity +## IotHubPropertiesMessagingEndpoints ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -148,15 +181,14 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription +## KEKIdentity ### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +* **userAssignedIdentity**: string: The user assigned identity. -## IotHubPropertiesMessagingEndpoints +## KeyVaultKeyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **identity**: [KEKIdentity](#kekidentity): The properties of the KeyVault identity. +* **keyIdentifier**: string: The identifier of the key. ## MessagingEndpointProperties ### Properties @@ -164,6 +196,10 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -176,22 +212,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -211,6 +249,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -248,32 +293,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -282,40 +319,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-08-01/types.md b/generated/iothub/microsoft.devices/2020-08-01/types.md index cf7fb571b5..912d240d15 100644 --- a/generated/iothub/microsoft.devices/2020-08-01/types.md +++ b/generated/iothub/microsoft.devices/2020-08-01/types.md @@ -52,6 +52,59 @@ * **ApiVersion**: 2020-08-01 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -72,37 +125,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -110,22 +152,16 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The resource identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): The resource identifier. @@ -138,22 +174,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -173,6 +211,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -210,32 +255,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -244,40 +281,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-08-31-preview/types.md b/generated/iothub/microsoft.devices/2020-08-31-preview/types.md index b19c9c74a5..c558c8f8cb 100644 --- a/generated/iothub/microsoft.devices/2020-08-31-preview/types.md +++ b/generated/iothub/microsoft.devices/2020-08-31-preview/types.md @@ -70,6 +70,64 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EncryptionPropertiesDescription +### Properties +* **keySource**: string: The source of the key. +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -93,55 +151,30 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. -## EncryptionPropertiesDescription -### Properties -* **keySource**: string: The source of the key. -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. - -## KeyVaultKeyProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **identity**: [KEKIdentity](#kekidentity): The properties of the KeyVault identity. -* **keyIdentifier**: string: The identifier of the key. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## KEKIdentity +## IotHubPropertiesMessagingEndpoints ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -149,15 +182,14 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription +## KEKIdentity ### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +* **userAssignedIdentity**: string: The user assigned identity. -## IotHubPropertiesMessagingEndpoints +## KeyVaultKeyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **identity**: [KEKIdentity](#kekidentity): The properties of the KeyVault identity. +* **keyIdentifier**: string: The identifier of the key. ## MessagingEndpointProperties ### Properties @@ -165,17 +197,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -189,22 +225,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -224,6 +262,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -261,32 +306,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -295,40 +332,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2020-08-31/types.md b/generated/iothub/microsoft.devices/2020-08-31/types.md index 424a48bac8..ad83fc1a15 100644 --- a/generated/iothub/microsoft.devices/2020-08-31/types.md +++ b/generated/iothub/microsoft.devices/2020-08-31/types.md @@ -52,6 +52,59 @@ * **ApiVersion**: 2020-08-31 * **Output**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -73,37 +126,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -111,33 +153,27 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) - ## MessagingEndpointProperties ### Properties * **lockDurationAsIso8601**: string: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -151,22 +187,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -186,6 +224,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -223,32 +268,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -257,40 +294,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-02-01-preview/types.md b/generated/iothub/microsoft.devices/2021-02-01-preview/types.md index 8ae8c59a2d..2f1e1e1582 100644 --- a/generated/iothub/microsoft.devices/2021-02-01-preview/types.md +++ b/generated/iothub/microsoft.devices/2021-02-01-preview/types.md @@ -70,6 +70,64 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EncryptionPropertiesDescription +### Properties +* **keySource**: string: The source of the key. +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -93,55 +151,30 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. -## EncryptionPropertiesDescription -### Properties -* **keySource**: string: The source of the key. -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. - -## KeyVaultKeyProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **identity**: [KEKIdentity](#kekidentity): The properties of the KeyVault identity. -* **keyIdentifier**: string: The identifier of the key. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## KEKIdentity +## IotHubPropertiesMessagingEndpoints ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -149,15 +182,14 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription +## KEKIdentity ### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +* **userAssignedIdentity**: string: The user assigned identity. -## IotHubPropertiesMessagingEndpoints +## KeyVaultKeyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **identity**: [KEKIdentity](#kekidentity): The properties of the KeyVault identity. +* **keyIdentifier**: string: The identifier of the key. ## MessagingEndpointProperties ### Properties @@ -165,17 +197,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -189,22 +225,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -224,6 +262,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -261,32 +306,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -295,40 +332,3 @@ * **containerName**: string (Required): The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-03-03-preview/types.md b/generated/iothub/microsoft.devices/2021-03-03-preview/types.md index 19da212891..e2c8fb3cf5 100644 --- a/generated/iothub/microsoft.devices/2021-03-03-preview/types.md +++ b/generated/iothub/microsoft.devices/2021-03-03-preview/types.md @@ -70,6 +70,64 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EncryptionPropertiesDescription +### Properties +* **keySource**: string: The source of the key. +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -93,55 +151,30 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. -## EncryptionPropertiesDescription -### Properties -* **keySource**: string: The source of the key. -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. - -## KeyVaultKeyProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. -* **keyIdentifier**: string: The identifier of the key. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## ManagedIdentity +## IotHubPropertiesMessagingEndpoints ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -149,15 +182,14 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription +## KeyVaultKeyProperties ### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +* **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. +* **keyIdentifier**: string: The identifier of the key. -## IotHubPropertiesMessagingEndpoints +## ManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **userAssignedIdentity**: string: The user assigned identity. ## MessagingEndpointProperties ### Properties @@ -165,17 +197,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -189,22 +225,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -225,6 +263,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -265,32 +310,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -300,40 +337,3 @@ * **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-03-31/types.md b/generated/iothub/microsoft.devices/2021-03-31/types.md index d05033194c..e5a648b711 100644 --- a/generated/iothub/microsoft.devices/2021-03-31/types.md +++ b/generated/iothub/microsoft.devices/2021-03-31/types.md @@ -70,6 +70,59 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (Required, WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **authorizationPolicies**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[]: The shared access policies you can use to secure a connection to the IoT hub. @@ -91,37 +144,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -129,15 +171,9 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints +## ManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **userAssignedIdentity**: string: The user assigned identity. ## MessagingEndpointProperties ### Properties @@ -145,17 +181,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -169,22 +209,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -205,9 +247,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. -## ManagedIdentity +## RoutingProperties ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. ## RoutingServiceBusQueueEndpointProperties ### Properties @@ -249,32 +294,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -284,40 +321,3 @@ * **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool (ReadOnly): Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (Required, WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-07-01-preview/types.md b/generated/iothub/microsoft.devices/2021-07-01-preview/types.md index db2c674a93..e388ba625a 100644 --- a/generated/iothub/microsoft.devices/2021-07-01-preview/types.md +++ b/generated/iothub/microsoft.devices/2021-07-01-preview/types.md @@ -70,6 +70,64 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool: Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EncryptionPropertiesDescription +### Properties +* **keySource**: string: The source of the key. +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (Required, WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **allowedFqdnList**: string[]: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. @@ -98,55 +156,30 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. -## EncryptionPropertiesDescription -### Properties -* **keySource**: string: The source of the key. -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. - -## KeyVaultKeyProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. -* **keyIdentifier**: string: The identifier of the key. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## ManagedIdentity +## IotHubPropertiesMessagingEndpoints ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -154,15 +187,14 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription +## KeyVaultKeyProperties ### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +* **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. +* **keyIdentifier**: string: The identifier of the key. -## IotHubPropertiesMessagingEndpoints +## ManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **userAssignedIdentity**: string: The user assigned identity. ## MessagingEndpointProperties ### Properties @@ -170,17 +202,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -194,22 +230,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -230,6 +268,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -270,32 +315,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -305,40 +342,3 @@ * **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool: Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (Required, WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-07-01/types.md b/generated/iothub/microsoft.devices/2021-07-01/types.md index a3dda53bd2..8dfa02df66 100644 --- a/generated/iothub/microsoft.devices/2021-07-01/types.md +++ b/generated/iothub/microsoft.devices/2021-07-01/types.md @@ -70,6 +70,59 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool: Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (Required, WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **allowedFqdnList**: string[]: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. @@ -96,37 +149,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -134,15 +176,9 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints +## ManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **userAssignedIdentity**: string: The user assigned identity. ## MessagingEndpointProperties ### Properties @@ -150,17 +186,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -174,22 +214,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -210,9 +252,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. -## ManagedIdentity +## RoutingProperties ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. ## RoutingServiceBusQueueEndpointProperties ### Properties @@ -254,32 +299,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -289,40 +326,3 @@ * **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool: Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (Required, WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-07-02-preview/types.md b/generated/iothub/microsoft.devices/2021-07-02-preview/types.md index 60bcdef564..3c2f941972 100644 --- a/generated/iothub/microsoft.devices/2021-07-02-preview/types.md +++ b/generated/iothub/microsoft.devices/2021-07-02-preview/types.md @@ -71,6 +71,64 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool: Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EncryptionPropertiesDescription +### Properties +* **keySource**: string: The source of the key. +* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (Required, WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **allowedFqdnList**: string[]: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. @@ -100,55 +158,30 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties -### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. - -## FeedbackProperties -### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. - ## IotHubPropertiesDeviceStreams ### Properties * **streamingEndpoints**: string[]: List of Device Streams Endpoints. -## EncryptionPropertiesDescription -### Properties -* **keySource**: string: The source of the key. -* **keyVaultProperties**: [KeyVaultKeyProperties](#keyvaultkeyproperties)[]: The properties of the KeyVault key. - -## KeyVaultKeyProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. -* **keyIdentifier**: string: The identifier of the key. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## ManagedIdentity +## IotHubPropertiesMessagingEndpoints ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -156,15 +189,14 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription +## KeyVaultKeyProperties ### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. +* **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. +* **keyIdentifier**: string: The identifier of the key. -## IotHubPropertiesMessagingEndpoints +## ManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **userAssignedIdentity**: string: The user assigned identity. ## MessagingEndpointProperties ### Properties @@ -172,17 +204,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -196,22 +232,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -232,6 +270,13 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. +## RoutingProperties +### Properties +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. + ## RoutingServiceBusQueueEndpointProperties ### Properties * **authenticationType**: 'identityBased' | 'keyBased' | string: Specifies authentication type being used for connecting to the storage account. @@ -272,32 +317,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'DigitalTwinChangeEvents' | 'Invalid' | 'MqttBrokerMessages' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -307,12 +344,6 @@ * **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -322,34 +353,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool: Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (Required, WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iothub/microsoft.devices/2021-07-02/types.md b/generated/iothub/microsoft.devices/2021-07-02/types.md index 4b891c9d2a..2dae9d7394 100644 --- a/generated/iothub/microsoft.devices/2021-07-02/types.md +++ b/generated/iothub/microsoft.devices/2021-07-02/types.md @@ -71,6 +71,59 @@ * **clientId**: string (ReadOnly) * **principalId**: string (ReadOnly) +## CertificateProperties +### Properties +* **certificate**: string: The certificate content +* **created**: string (ReadOnly): The certificate's create date and time. +* **expiry**: string (ReadOnly): The certificate's expiration date and time. +* **isVerified**: bool: Determines whether certificate has been verified. +* **subject**: string (ReadOnly): The certificate's subject name. +* **thumbprint**: string (ReadOnly): The certificate's thumbprint. +* **updated**: string (ReadOnly): The certificate's last update date and time. + +## CloudToDeviceProperties +### Properties +* **defaultTtlAsIso8601**: string: 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. +* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. +* **maxDeliveryCount**: int: 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. + +## EnrichmentProperties +### Properties +* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. +* **key**: string (Required): The key or name for the enrichment property. +* **value**: string (Required): The value for the enrichment property. + +## EventHubConsumerGroupName +### Properties +* **name**: string (Required, WriteOnly): EventHub consumer group name + +## EventHubProperties +### Properties +* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. +* **partitionCount**: int: 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. +* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. +* **path**: string (ReadOnly): The Event Hub-compatible name. +* **retentionTimeInDays**: int: 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 + +## FallbackRouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. +* **name**: 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. + +## FeedbackProperties +### Properties +* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. +* **maxDeliveryCount**: int: 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. +* **ttlAsIso8601**: 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. + +## IotHubLocationDescription +### Properties +* **location**: string: The name of the Azure region +* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. + ## IotHubProperties ### Properties * **allowedFqdnList**: string[]: List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. @@ -98,37 +151,26 @@ * **state**: string (ReadOnly): The hub state. * **storageEndpoints**: [IotHubPropertiesStorageEndpoints](#iothubpropertiesstorageendpoints): 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. -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - -## CloudToDeviceProperties +## IotHubPropertiesEventHubEndpoints ### Properties -* **defaultTtlAsIso8601**: string: 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. -* **feedback**: [FeedbackProperties](#feedbackproperties): The properties of the feedback queue for cloud-to-device messages. -* **maxDeliveryCount**: int: 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. +### Additional Properties +* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) -## FeedbackProperties +## IotHubPropertiesMessagingEndpoints ### Properties -* **lockDurationAsIso8601**: string: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. -* **maxDeliveryCount**: int: 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. -* **ttlAsIso8601**: 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. +### Additional Properties +* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) -## IotHubPropertiesEventHubEndpoints +## IotHubPropertiesStorageEndpoints ### Properties ### Additional Properties -* **Additional Properties Type**: [EventHubProperties](#eventhubproperties) +* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) -## EventHubProperties +## IotHubSkuInfo ### Properties -* **endpoint**: string (ReadOnly): The Event Hub-compatible endpoint. -* **partitionCount**: int: 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. -* **partitionIds**: string[] (ReadOnly): The partition ids in the Event Hub-compatible endpoint. -* **path**: string (ReadOnly): The Event Hub-compatible name. -* **retentionTimeInDays**: int: 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 +* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. +* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. +* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. ## IpFilterRule ### Properties @@ -136,15 +178,9 @@ * **filterName**: string (Required): The name of the IP filter rule. * **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. -## IotHubLocationDescription -### Properties -* **location**: string: The name of the Azure region -* **role**: 'primary' | 'secondary' | string: The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. - -## IotHubPropertiesMessagingEndpoints +## ManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [MessagingEndpointProperties](#messagingendpointproperties) +* **userAssignedIdentity**: string: The user assigned identity. ## MessagingEndpointProperties ### Properties @@ -152,17 +188,21 @@ * **maxDeliveryCount**: int: 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. * **ttlAsIso8601**: 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. +## NetworkRuleSetIpRule +### Properties +* **action**: 'Allow' | string: IP Filter Action +* **filterName**: string (Required): Name of the IP filter rule. +* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. + ## NetworkRuleSetProperties ### Properties * **applyToBuiltInEventHubEndpoint**: bool (Required): If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set * **ipRules**: [NetworkRuleSetIpRule](#networkrulesetiprule)[] (Required): List of IP Rules -## NetworkRuleSetIpRule +## PrivateEndpoint ### Properties -* **action**: 'Allow' | string: IP Filter Action -* **filterName**: string (Required): Name of the IP filter rule. -* **ipMask**: string (Required): A string that contains the IP address range in CIDR notation for the rule. +* **id**: string (ReadOnly): The resource identifier. ## PrivateEndpointConnection ### Properties @@ -176,22 +216,24 @@ * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The private endpoint property of a private endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): The current state of a private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The resource identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Actions required for a private endpoint connection * **description**: string (Required): The description for the current state of a private endpoint connection * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The status of a private endpoint connection -## RoutingProperties +## ResourceTags ### Properties -* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. -* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid -* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. -* **routes**: [RouteProperties](#routeproperties)[]: 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. +### Additional Properties +* **Additional Properties Type**: string + +## RouteProperties +### Properties +* **condition**: string: 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 +* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. +* **isEnabled**: bool (Required): Used to specify whether a route is enabled. +* **name**: string (Required): 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. +* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. ## RoutingEndpoints ### Properties @@ -212,9 +254,12 @@ * **resourceGroup**: string: The name of the resource group of the event hub endpoint. * **subscriptionId**: string: The subscription identifier of the event hub endpoint. -## ManagedIdentity +## RoutingProperties ### Properties -* **userAssignedIdentity**: string: The user assigned identity. +* **endpoints**: [RoutingEndpoints](#routingendpoints): 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. +* **enrichments**: [EnrichmentProperties](#enrichmentproperties)[]: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid +* **fallbackRoute**: [FallbackRouteProperties](#fallbackrouteproperties): The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. +* **routes**: [RouteProperties](#routeproperties)[]: 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. ## RoutingServiceBusQueueEndpointProperties ### Properties @@ -256,32 +301,24 @@ * **resourceGroup**: string: The name of the resource group of the storage account. * **subscriptionId**: string: The subscription identifier of the storage account. -## EnrichmentProperties -### Properties -* **endpointNames**: string[] (Required): The list of endpoints for which the enrichment is applied to the message. -* **key**: string (Required): The key or name for the enrichment property. -* **value**: string (Required): The value for the enrichment property. - -## FallbackRouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether the fallback route is enabled. -* **name**: 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## RouteProperties +## SharedAccessSignatureAuthorizationRule ### Properties -* **condition**: string: 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 -* **endpointNames**: string[] (Required): The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. -* **isEnabled**: bool (Required): Used to specify whether a route is enabled. -* **name**: string (Required): 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. -* **source**: 'DeviceConnectionStateEvents' | 'DeviceJobLifecycleEvents' | 'DeviceLifecycleEvents' | 'DeviceMessages' | 'Invalid' | 'TwinChangeEvents' | string (Required): The source that the routing rule is to be applied to, such as DeviceMessages. +* **keyName**: string (Required): The name of the shared access policy. +* **primaryKey**: string: The primary key. +* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. +* **secondaryKey**: string: The secondary key. -## IotHubPropertiesStorageEndpoints +## SharedAccessSignatureAuthorizationRuleListResult ### Properties -### Additional Properties -* **Additional Properties Type**: [StorageEndpointProperties](#storageendpointproperties) +* **nextLink**: string (ReadOnly): The next link. +* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. ## StorageEndpointProperties ### Properties @@ -291,12 +328,6 @@ * **identity**: [ManagedIdentity](#managedidentity): The properties of the Managed identity. * **sasTtlAsIso8601**: 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. -## IotHubSkuInfo -### Properties -* **capacity**: int: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. -* **name**: 'B1' | 'B2' | 'B3' | 'F1' | 'S1' | 'S2' | 'S3' | string (Required): The name of the SKU. -* **tier**: 'Basic' | 'Free' | 'Standard' (ReadOnly): The billing tier for the IoT hub. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -306,34 +337,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CertificateProperties -### Properties -* **certificate**: string: The certificate content -* **created**: string (ReadOnly): The certificate's create date and time. -* **expiry**: string (ReadOnly): The certificate's expiration date and time. -* **isVerified**: bool: Determines whether certificate has been verified. -* **subject**: string (ReadOnly): The certificate's subject name. -* **thumbprint**: string (ReadOnly): The certificate's thumbprint. -* **updated**: string (ReadOnly): The certificate's last update date and time. - -## EventHubConsumerGroupName -### Properties -* **name**: string (Required, WriteOnly): EventHub consumer group name - -## SharedAccessSignatureAuthorizationRuleListResult -### Properties -* **nextLink**: string (ReadOnly): The next link. -* **value**: [SharedAccessSignatureAuthorizationRule](#sharedaccesssignatureauthorizationrule)[] (ReadOnly): The list of shared access policies. - -## SharedAccessSignatureAuthorizationRule -### Properties -* **keyName**: string (Required): The name of the shared access policy. -* **primaryKey**: string: The primary key. -* **rights**: 'DeviceConnect' | 'RegistryRead' | 'RegistryRead, DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, ServiceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite' | 'RegistryWrite, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'ServiceConnect' | 'ServiceConnect, DeviceConnect' (Required): The permissions assigned to the shared access policy. -* **secondaryKey**: string: The secondary key. - diff --git a/generated/iotsecurity/log.out b/generated/iotsecurity/log.out index 0d796da8bd..735bb5eab3 100644 --- a/generated/iotsecurity/log.out +++ b/generated/iotsecurity/log.out @@ -7,14 +7,14 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.iotsecurity-2021-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/BinarySchema | 'The schema paths·7g9qi2·subscriptions-subscriptionid-providers-microsoft-iotsecurity-defendersettings-default-downloadmanageractivation·post·responses·200·content·application-zip·schema with 'type: object', format: file' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json:246:11 @@ -32,5 +32,5 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | Resource type microsoft.iotsecurity/onpremisesensors under path '/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/onPremiseSensors/{onPremiseSensorName}' has no body defined. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 20ms -info | Autorest completed in 6.17s. 2 files generated. +info | autorest.bicep took 17ms +info | Autorest completed in 5.86s. 2 files generated. diff --git a/generated/iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.md b/generated/iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.md index 54c1d9cdb7..d540bb5344 100644 --- a/generated/iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.md +++ b/generated/iotsecurity/microsoft.iotsecurity/2021-02-01-preview/types.md @@ -61,15 +61,6 @@ ### Properties * **status**: 'Disabled' | 'Enabled' | string (Required): Integration status -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## SensorProperties ### Properties * **connectivityTime**: string (ReadOnly): Last connectivity time of the IoT sensor @@ -93,3 +84,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/iotspaces/log.out b/generated/iotspaces/log.out index 595591feb2..01b010a5c5 100644 --- a/generated/iotspaces/log.out +++ b/generated/iotspaces/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.iotspaces-2017-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms -info | Autorest completed in 3.92s. 0 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 3.68s. 0 files generated. diff --git a/generated/keyvault/log.out b/generated/keyvault/log.out index f7abdac078..c905d1bd95 100644 --- a/generated/keyvault/log.out +++ b/generated/keyvault/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.keyvault-2016-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Attributes' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/secrets.json:276:5 @@ -73,11 +73,11 @@ warning | PreCheck/SchemaMissingType | The schema 'ServiceSpecification' with an warning | PreCheck/SchemaMissingType | The schema 'LogSpecification' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/providers.json:135:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.keyvault-2018-02-14"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Attributes' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/secrets.json:276:5 @@ -172,7 +172,7 @@ info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.keyvault-2018-02-14-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Attributes' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/secrets.json:276:5 @@ -247,7 +247,7 @@ info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.keyvault-2019-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/secrets.json:294:5 @@ -378,7 +378,7 @@ info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.keyvault-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/common.json:10:5 @@ -510,18 +510,18 @@ info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.keyvault-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MHSMIPRule' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/managedHsm.json:1217:5 warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/providers.json:88:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.keyvault-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/common.json:10:5 @@ -649,11 +649,11 @@ warning | PreCheck/SchemaMissingType | The schema 'DimensionProperties' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/providers.json:227:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 12ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.keyvault-2021-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/common.json:10:5 @@ -816,11 +816,11 @@ warning | PreCheck/SchemaMissingType | The schema 'Secret' with an undefined typ warning | PreCheck/SchemaMissingType | The schema 'SecretListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json:439:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.keyvault-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedHsmSku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json:354:5 @@ -941,7 +941,7 @@ info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.keyvault-2015-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2015-06-01/keyvault.json:245:5 @@ -963,4 +963,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2015-06-01/keyvault.json:512:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 31.42s. 20 files generated. +info | Autorest completed in 29.73s. 20 files generated. diff --git a/generated/keyvault/microsoft.keyvault/2015-06-01/types.md b/generated/keyvault/microsoft.keyvault/2015-06-01/types.md index ce54a748f4..253ad0afca 100644 --- a/generated/keyvault/microsoft.keyvault/2015-06-01/types.md +++ b/generated/keyvault/microsoft.keyvault/2015-06-01/types.md @@ -11,17 +11,6 @@ * **tags**: [VaultCreateOrUpdateParametersTags](#vaultcreateorupdateparameterstags): The tags that will be assigned to the key vault. * **type**: 'Microsoft.KeyVault/vaults' (ReadOnly, DeployTimeConstant): The resource type -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enableSoftDelete**: bool: Property to specify whether the 'soft delete' functionality is enabled for this key vault. -* **sku**: [Sku](#sku) (Required): SKU details -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - ## AccessPolicyEntry ### Properties * **applicationId**: string: Application ID of the client making request on behalf of a principal @@ -45,3 +34,14 @@ ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enableSoftDelete**: bool: Property to specify whether the 'soft delete' functionality is enabled for this key vault. +* **sku**: [Sku](#sku) (Required): SKU details +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. + diff --git a/generated/keyvault/microsoft.keyvault/2016-10-01/types.md b/generated/keyvault/microsoft.keyvault/2016-10-01/types.md index 6ecd898f1d..9444d9ab97 100644 --- a/generated/keyvault/microsoft.keyvault/2016-10-01/types.md +++ b/generated/keyvault/microsoft.keyvault/2016-10-01/types.md @@ -32,19 +32,6 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableSoftDelete**: bool: 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. -* **sku**: [Sku](#sku) (Required): SKU details -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - ## AccessPolicyEntry ### Properties * **applicationId**: string: Application ID of the client making request on behalf of a principal @@ -59,20 +46,19 @@ * **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets * **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## Sku +## SecretAttributes ### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## VaultCreateOrUpdateParametersTags +## SecretCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - ## SecretProperties ### Properties * **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. @@ -81,16 +67,30 @@ * **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. * **value**: 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. -## SecretAttributes +## Sku ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## SecretCreateOrUpdateParametersTags +## VaultAccessPolicyProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. + +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableSoftDelete**: bool: 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. +* **sku**: [Sku](#sku) (Required): SKU details +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. + diff --git a/generated/keyvault/microsoft.keyvault/2018-02-14-preview/types.md b/generated/keyvault/microsoft.keyvault/2018-02-14-preview/types.md index ad5e887989..ccffb27803 100644 --- a/generated/keyvault/microsoft.keyvault/2018-02-14-preview/types.md +++ b/generated/keyvault/microsoft.keyvault/2018-02-14-preview/types.md @@ -32,20 +32,6 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableSoftDelete**: bool: Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **sku**: [Sku](#sku) (Required): SKU details -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - ## AccessPolicyEntry ### Properties * **applicationId**: string: Application ID of the client making request on behalf of a principal @@ -53,12 +39,9 @@ * **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. * **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -## Permissions +## IPRule ### Properties -* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **value**: string (Required): 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). ## NetworkRuleSet ### Properties @@ -67,28 +50,26 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule -### Properties -* **value**: string (Required): 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). - -## VirtualNetworkRule +## Permissions ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## Sku +## SecretAttributes ### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## VaultCreateOrUpdateParametersTags +## SecretCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - ## SecretProperties ### Properties * **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. @@ -97,16 +78,35 @@ * **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. * **value**: 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. -## SecretAttributes +## Sku ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## SecretCreateOrUpdateParametersTags +## VaultAccessPolicyProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. + +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableSoftDelete**: bool: Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **sku**: [Sku](#sku) (Required): SKU details +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. + +## VirtualNetworkRule +### Properties +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. + diff --git a/generated/keyvault/microsoft.keyvault/2018-02-14/types.md b/generated/keyvault/microsoft.keyvault/2018-02-14/types.md index ba101466ec..f44237c2fc 100644 --- a/generated/keyvault/microsoft.keyvault/2018-02-14/types.md +++ b/generated/keyvault/microsoft.keyvault/2018-02-14/types.md @@ -43,21 +43,6 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableSoftDelete**: bool: Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **sku**: [Sku](#sku) (Required): SKU details -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - ## AccessPolicyEntry ### Properties * **applicationId**: string: Application ID of the client making request on behalf of a principal @@ -65,12 +50,9 @@ * **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. * **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -## Permissions +## IPRule ### Properties -* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **value**: string (Required): 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). ## NetworkRuleSet ### Properties @@ -79,13 +61,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -97,31 +82,26 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties +## SecretAttributes ### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## ResourceTags +## SecretCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -134,16 +114,36 @@ * **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. * **value**: 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. -## SecretAttributes +## Sku ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## SecretCreateOrUpdateParametersTags +## VaultAccessPolicyProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. + +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableSoftDelete**: bool: Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **sku**: [Sku](#sku) (Required): SKU details +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. + +## VirtualNetworkRule +### Properties +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. + diff --git a/generated/keyvault/microsoft.keyvault/2019-09-01/types.md b/generated/keyvault/microsoft.keyvault/2019-09-01/types.md index 6c54960a30..dccd1eb5a8 100644 --- a/generated/keyvault/microsoft.keyvault/2019-09-01/types.md +++ b/generated/keyvault/microsoft.keyvault/2019-09-01/types.md @@ -55,25 +55,6 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableRbacAuthorization**: bool: 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. -* **enableSoftDelete**: bool: 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. -* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. -* **sku**: [Sku](#sku) (Required): SKU details -* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. This property is readonly - ## AccessPolicyEntry ### Properties * **applicationId**: string: Application ID of the client making request on behalf of a principal @@ -81,12 +62,33 @@ * **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. * **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -## Permissions +## IPRule ### Properties -* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **value**: string (Required): 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). + +## KeyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether or not the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## KeyCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## KeyProperties +### Properties +* **attributes**: [KeyAttributes](#keyattributes): The attributes of the key. +* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. +* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation +* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. +* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. +* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. +* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. ## NetworkRuleSet ### Properties @@ -95,14 +97,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -116,55 +120,26 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - -## KeyProperties -### Properties -* **attributes**: [KeyAttributes](#keyattributes): The attributes of the key. -* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. -* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation -* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. -* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. -* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. -* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. - -## KeyAttributes +## SecretAttributes ### Properties * **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether or not the object is enabled. +* **enabled**: bool: Determines whether the object is enabled. * **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. * **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. * **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## KeyCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## SecretCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -177,16 +152,41 @@ * **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. * **value**: 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. -## SecretAttributes +## Sku ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## SecretCreateOrUpdateParametersTags +## VaultAccessPolicyProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. + +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableRbacAuthorization**: bool: 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. +* **enableSoftDelete**: bool: 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. +* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. +* **sku**: [Sku](#sku) (Required): SKU details +* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. This property is readonly + +## VirtualNetworkRule +### Properties +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. + diff --git a/generated/keyvault/microsoft.keyvault/2020-04-01-preview/types.md b/generated/keyvault/microsoft.keyvault/2020-04-01-preview/types.md index 9fda051c72..bbe8252c6e 100644 --- a/generated/keyvault/microsoft.keyvault/2020-04-01-preview/types.md +++ b/generated/keyvault/microsoft.keyvault/2020-04-01-preview/types.md @@ -68,6 +68,41 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type +## AccessPolicyEntry +### Properties +* **applicationId**: string: Application ID of the client making request on behalf of a principal +* **objectId**: string (Required): 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. +* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + +## IPRule +### Properties +* **value**: string (Required): 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). + +## KeyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether or not the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## KeyCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## KeyProperties +### Properties +* **attributes**: [KeyAttributes](#keyattributes): The attributes of the key. +* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. +* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation +* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. +* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. +* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. +* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. + ## ManagedHsmProperties ### Properties * **createMode**: 'default' | 'recover': The create mode to indicate whether the resource is being created or is being recovered from a deleted resource. @@ -80,47 +115,15 @@ * **statusMessage**: string (ReadOnly): Resource Status Message. * **tenantId**: string: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. -## ManagedHsmSku -### Properties -* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool -* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool - ## ManagedHsmResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover': The create mode to indicate whether the resource is being created or is being recovered from a deleted resource. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableRbacAuthorization**: bool: 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. -* **enableSoftDelete**: bool: 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. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. -* **sku**: [Sku](#sku) (Required): SKU details -* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - -## AccessPolicyEntry -### Properties -* **applicationId**: string: Application ID of the client making request on behalf of a principal -* **objectId**: string (Required): 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. -* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. - -## Permissions +## ManagedHsmSku ### Properties -* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool +* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool ## NetworkRuleSet ### Properties @@ -129,14 +132,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -150,64 +155,26 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of key vault resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created key vault resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. -* **lastModifiedAt**: string (ReadOnly): The timestamp of key vault resource last modification (UTC). -* **lastModifiedBy**: string (ReadOnly): The identity that last modified key vault resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - -## KeyProperties -### Properties -* **attributes**: [KeyAttributes](#keyattributes): The attributes of the key. -* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. -* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation -* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. -* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. -* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. -* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. - -## KeyAttributes +## SecretAttributes ### Properties * **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether or not the object is enabled. +* **enabled**: bool: Determines whether the object is enabled. * **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. * **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. * **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## KeyCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## SecretCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -220,16 +187,49 @@ * **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. * **value**: 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. -## SecretAttributes +## Sku ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## SecretCreateOrUpdateParametersTags +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of key vault resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created key vault resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. +* **lastModifiedAt**: string (ReadOnly): The timestamp of key vault resource last modification (UTC). +* **lastModifiedBy**: string (ReadOnly): The identity that last modified key vault resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. + +## VaultAccessPolicyProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. + +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover': The create mode to indicate whether the resource is being created or is being recovered from a deleted resource. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableRbacAuthorization**: bool: 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. +* **enableSoftDelete**: bool: 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. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. +* **sku**: [Sku](#sku) (Required): SKU details +* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. + +## VirtualNetworkRule +### Properties +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. + diff --git a/generated/keyvault/microsoft.keyvault/2021-04-01-preview/types.md b/generated/keyvault/microsoft.keyvault/2021-04-01-preview/types.md index 965ace4738..85b05e3150 100644 --- a/generated/keyvault/microsoft.keyvault/2021-04-01-preview/types.md +++ b/generated/keyvault/microsoft.keyvault/2021-04-01-preview/types.md @@ -83,6 +83,57 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type +## AccessPolicyEntry +### Properties +* **applicationId**: string: Application ID of the client making request on behalf of a principal +* **objectId**: string (Required): 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. +* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + +## Action +### Properties +* **type**: 'notify' | 'rotate': The type of action. + +## IPRule +### Properties +* **value**: string (Required): 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). + +## KeyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether or not the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## KeyCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## KeyProperties +### Properties +* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. +* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. +* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation +* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. +* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. +* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. +* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. +* **rotationPolicy**: [RotationPolicy](#rotationpolicy) + +## KeyRotationPolicyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **expiryTime**: string: The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## LifetimeAction +### Properties +* **action**: [Action](#action) +* **trigger**: [Trigger](#trigger) + ## ManagedHsmProperties ### Properties * **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. @@ -99,6 +150,25 @@ * **statusMessage**: string (ReadOnly): Resource Status Message. * **tenantId**: string: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmSku +### Properties +* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool +* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool + +## MhsmipRule +### Properties +* **value**: string (Required): 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). + ## MhsmNetworkRuleSet ### Properties * **bypass**: 'AzureServices' | 'None' | string: Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. @@ -106,13 +176,9 @@ * **ipRules**: [MhsmipRule](#mhsmiprule)[]: The list of IP address rules. * **virtualNetworkRules**: [MhsmVirtualNetworkRule](#mhsmvirtualnetworkrule)[]: The list of virtual network rules. -## MhsmipRule -### Properties -* **value**: string (Required): 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). - -## MhsmVirtualNetworkRule +## MhsmPrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## MhsmPrivateEndpointConnectionItem ### Properties @@ -124,72 +190,15 @@ * **privateLinkServiceConnectionState**: [MhsmPrivateLinkServiceConnectionState](#mhsmprivatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## MhsmPrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## MhsmPrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## ManagedHsmSku -### Properties -* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool -* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the key vault resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. -* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableRbacAuthorization**: bool: 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. -* **enableSoftDelete**: bool: 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. -* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. -* **sku**: [Sku](#sku) (Required): SKU details -* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - -## AccessPolicyEntry -### Properties -* **applicationId**: string: Application ID of the client making request on behalf of a principal -* **objectId**: string (Required): 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. -* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. - -## Permissions +## MhsmVirtualNetworkRule ### Properties -* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'release' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ## NetworkRuleSet ### Properties @@ -198,14 +207,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'release' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -219,103 +230,92 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - -## KeyProperties +## RotationPolicy ### Properties -* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. -* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. -* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation -* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. -* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. -* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. -* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. -* **rotationPolicy**: [RotationPolicy](#rotationpolicy) +* **attributes**: [KeyRotationPolicyAttributes](#keyrotationpolicyattributes) +* **lifetimeActions**: [LifetimeAction](#lifetimeaction)[]: The lifetimeActions for key rotation action. -## KeyAttributes +## SecretAttributes ### Properties * **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether or not the object is enabled. +* **enabled**: bool: Determines whether the object is enabled. * **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. * **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. * **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## RotationPolicy +## SecretCreateOrUpdateParametersTags ### Properties -* **attributes**: [KeyRotationPolicyAttributes](#keyrotationpolicyattributes) -* **lifetimeActions**: [LifetimeAction](#lifetimeaction)[]: The lifetimeActions for key rotation action. +### Additional Properties +* **Additional Properties Type**: string -## KeyRotationPolicyAttributes +## SecretProperties ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **expiryTime**: string: The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. +* **contentType**: string: The content type of the secret. +* **secretUri**: string (ReadOnly): The URI to retrieve the current version of the secret. +* **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. +* **value**: 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. -## LifetimeAction +## Sku ### Properties -* **action**: [Action](#action) -* **trigger**: [Trigger](#trigger) +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## Action +## SystemData ### Properties -* **type**: 'notify' | 'rotate': The type of action. +* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the key vault resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. +* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. ## Trigger ### Properties * **timeAfterCreate**: string: The time duration after key creation to rotate the key. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. * **timeBeforeExpiry**: string: The time duration before key expiring to rotate the key. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. -## KeyCreateParametersTags +## VaultAccessPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. -## ResourceTags +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SecretProperties -### Properties -* **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. -* **contentType**: string: The content type of the secret. -* **secretUri**: string (ReadOnly): The URI to retrieve the current version of the secret. -* **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. -* **value**: 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. - -## SecretAttributes +## VaultProperties ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableRbacAuthorization**: bool: 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. +* **enableSoftDelete**: bool: 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. +* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. +* **sku**: [Sku](#sku) (Required): SKU details +* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. -## SecretCreateOrUpdateParametersTags +## VirtualNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. diff --git a/generated/keyvault/microsoft.keyvault/2021-06-01-preview/types.md b/generated/keyvault/microsoft.keyvault/2021-06-01-preview/types.md index d9757a9614..9c7d33e4af 100644 --- a/generated/keyvault/microsoft.keyvault/2021-06-01-preview/types.md +++ b/generated/keyvault/microsoft.keyvault/2021-06-01-preview/types.md @@ -83,6 +83,64 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type +## AccessPolicyEntry +### Properties +* **applicationId**: string: Application ID of the client making request on behalf of a principal +* **objectId**: string (Required): 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. +* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + +## Action +### Properties +* **type**: 'notify' | 'rotate': The type of action. + +## IPRule +### Properties +* **value**: string (Required): 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). + +## KeyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether or not the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **exportable**: bool: Indicates if the private key can be exported. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## KeyCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## KeyProperties +### Properties +* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. +* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. +* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'release' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation +* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. +* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. +* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. +* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. +* **release_policy**: [KeyReleasePolicy](#keyreleasepolicy) +* **rotationPolicy**: [RotationPolicy](#rotationpolicy) + +## KeyReleasePolicy +### Properties +* **contentType**: string: Content type and version of key release policy +* **data**: any: Blob encoding the policy rules under which the key can be released. + +## KeyRotationPolicyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **expiryTime**: string: The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## LifetimeAction +### Properties +* **action**: [Action](#action) +* **trigger**: [Trigger](#trigger) + ## ManagedHsmProperties ### Properties * **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. @@ -99,6 +157,25 @@ * **statusMessage**: string (ReadOnly): Resource Status Message. * **tenantId**: string: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmSku +### Properties +* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool +* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool + +## MhsmipRule +### Properties +* **value**: string (Required): 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). + ## MhsmNetworkRuleSet ### Properties * **bypass**: 'AzureServices' | 'None' | string: Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. @@ -106,13 +183,9 @@ * **ipRules**: [MhsmipRule](#mhsmiprule)[]: The list of IP address rules. * **virtualNetworkRules**: [MhsmVirtualNetworkRule](#mhsmvirtualnetworkrule)[]: The list of virtual network rules. -## MhsmipRule -### Properties -* **value**: string (Required): 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). - -## MhsmVirtualNetworkRule +## MhsmPrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## MhsmPrivateEndpointConnectionItem ### Properties @@ -124,73 +197,15 @@ * **privateLinkServiceConnectionState**: [MhsmPrivateLinkServiceConnectionState](#mhsmprivatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## MhsmPrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## MhsmPrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## ManagedHsmSku -### Properties -* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool -* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the key vault resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. -* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableRbacAuthorization**: bool: 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 (warning: this is a preview feature). 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. -* **enableSoftDelete**: bool: 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. -* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. -* **publicNetworkAccess**: string: Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. -* **sku**: [Sku](#sku) (Required): SKU details -* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - -## AccessPolicyEntry -### Properties -* **applicationId**: string: Application ID of the client making request on behalf of a principal -* **objectId**: string (Required): 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. -* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. - -## Permissions +## MhsmVirtualNetworkRule ### Properties -* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'getrotationpolicy' | 'import' | 'list' | 'purge' | 'recover' | 'release' | 'restore' | 'rotate' | 'setrotationpolicy' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ## NetworkRuleSet ### Properties @@ -199,14 +214,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'getrotationpolicy' | 'import' | 'list' | 'purge' | 'recover' | 'release' | 'restore' | 'rotate' | 'setrotationpolicy' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -220,110 +237,93 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - -## KeyProperties +## RotationPolicy ### Properties -* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. -* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. -* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'release' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation -* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. -* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. -* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. -* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. -* **release_policy**: [KeyReleasePolicy](#keyreleasepolicy) -* **rotationPolicy**: [RotationPolicy](#rotationpolicy) +* **attributes**: [KeyRotationPolicyAttributes](#keyrotationpolicyattributes) +* **lifetimeActions**: [LifetimeAction](#lifetimeaction)[]: The lifetimeActions for key rotation action. -## KeyAttributes +## SecretAttributes ### Properties * **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether or not the object is enabled. +* **enabled**: bool: Determines whether the object is enabled. * **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **exportable**: bool: Indicates if the private key can be exported. * **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. * **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## KeyReleasePolicy -### Properties -* **contentType**: string: Content type and version of key release policy -* **data**: any: Blob encoding the policy rules under which the key can be released. - -## RotationPolicy +## SecretCreateOrUpdateParametersTags ### Properties -* **attributes**: [KeyRotationPolicyAttributes](#keyrotationpolicyattributes) -* **lifetimeActions**: [LifetimeAction](#lifetimeaction)[]: The lifetimeActions for key rotation action. +### Additional Properties +* **Additional Properties Type**: string -## KeyRotationPolicyAttributes +## SecretProperties ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **expiryTime**: string: The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. +* **contentType**: string: The content type of the secret. +* **secretUri**: string (ReadOnly): The URI to retrieve the current version of the secret. +* **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. +* **value**: 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. -## LifetimeAction +## Sku ### Properties -* **action**: [Action](#action) -* **trigger**: [Trigger](#trigger) +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## Action +## SystemData ### Properties -* **type**: 'notify' | 'rotate': The type of action. +* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the key vault resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. +* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. ## Trigger ### Properties * **timeAfterCreate**: string: The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. * **timeBeforeExpiry**: string: The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. -## KeyCreateParametersTags +## VaultAccessPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. -## ResourceTags +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SecretProperties -### Properties -* **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. -* **contentType**: string: The content type of the secret. -* **secretUri**: string (ReadOnly): The URI to retrieve the current version of the secret. -* **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. -* **value**: 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. - -## SecretAttributes +## VaultProperties ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableRbacAuthorization**: bool: 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 (warning: this is a preview feature). 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. +* **enableSoftDelete**: bool: 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. +* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. +* **publicNetworkAccess**: string: Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. +* **sku**: [Sku](#sku) (Required): SKU details +* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. -## SecretCreateOrUpdateParametersTags +## VirtualNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. diff --git a/generated/keyvault/microsoft.keyvault/2021-10-01/types.md b/generated/keyvault/microsoft.keyvault/2021-10-01/types.md index 630a2f4ac0..813b864618 100644 --- a/generated/keyvault/microsoft.keyvault/2021-10-01/types.md +++ b/generated/keyvault/microsoft.keyvault/2021-10-01/types.md @@ -83,6 +83,42 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type +## AccessPolicyEntry +### Properties +* **applicationId**: string: Application ID of the client making request on behalf of a principal +* **objectId**: string (Required): 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. +* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + +## IPRule +### Properties +* **value**: string (Required): 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). + +## KeyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether or not the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **exportable**: bool: Indicates if the private key can be exported. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## KeyCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## KeyProperties +### Properties +* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. +* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. +* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation +* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. +* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. +* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. +* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. + ## ManagedHsmProperties ### Properties * **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. @@ -99,6 +135,25 @@ * **statusMessage**: string (ReadOnly): Resource Status Message. * **tenantId**: string: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmSku +### Properties +* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool +* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool + +## MhsmipRule +### Properties +* **value**: string (Required): 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). + ## MhsmNetworkRuleSet ### Properties * **bypass**: 'AzureServices' | 'None' | string: Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. @@ -106,13 +161,9 @@ * **ipRules**: [MhsmipRule](#mhsmiprule)[]: The list of IP address rules. * **virtualNetworkRules**: [MhsmVirtualNetworkRule](#mhsmvirtualnetworkrule)[]: The list of virtual network rules. -## MhsmipRule -### Properties -* **value**: string (Required): 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). - -## MhsmVirtualNetworkRule +## MhsmPrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## MhsmPrivateEndpointConnectionItem ### Properties @@ -124,73 +175,15 @@ * **privateLinkServiceConnectionState**: [MhsmPrivateLinkServiceConnectionState](#mhsmprivatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## MhsmPrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## MhsmPrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## ManagedHsmSku -### Properties -* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool -* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the key vault resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. -* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableRbacAuthorization**: bool: 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. -* **enableSoftDelete**: bool: 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. -* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. -* **publicNetworkAccess**: string: Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. -* **sku**: [Sku](#sku) (Required): SKU details -* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - -## AccessPolicyEntry -### Properties -* **applicationId**: string: Application ID of the client making request on behalf of a principal -* **objectId**: string (Required): 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. -* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. - -## Permissions +## MhsmVirtualNetworkRule ### Properties -* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ## NetworkRuleSet ### Properties @@ -199,14 +192,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'import' | 'list' | 'purge' | 'recover' | 'restore' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -220,56 +215,26 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - -## KeyProperties -### Properties -* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. -* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. -* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation -* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. -* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. -* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. -* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. - -## KeyAttributes +## SecretAttributes ### Properties * **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether or not the object is enabled. +* **enabled**: bool: Determines whether the object is enabled. * **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **exportable**: bool: Indicates if the private key can be exported. * **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. * **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## KeyCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## SecretCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -282,16 +247,51 @@ * **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. * **value**: 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. -## SecretAttributes +## Sku ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## SecretCreateOrUpdateParametersTags +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the key vault resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. +* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. + +## VaultAccessPolicyProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. + +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VaultProperties +### Properties +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableRbacAuthorization**: bool: 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. +* **enableSoftDelete**: bool: 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. +* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. +* **publicNetworkAccess**: string: Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. +* **sku**: [Sku](#sku) (Required): SKU details +* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. + +## VirtualNetworkRule +### Properties +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. + diff --git a/generated/keyvault/microsoft.keyvault/2021-11-01-preview/types.md b/generated/keyvault/microsoft.keyvault/2021-11-01-preview/types.md index e4f89c141a..ddd0ec767c 100644 --- a/generated/keyvault/microsoft.keyvault/2021-11-01-preview/types.md +++ b/generated/keyvault/microsoft.keyvault/2021-11-01-preview/types.md @@ -83,6 +83,64 @@ * **tags**: [SecretCreateOrUpdateParametersTags](#secretcreateorupdateparameterstags): The tags that will be assigned to the secret. * **type**: 'Microsoft.KeyVault/vaults/secrets' (ReadOnly, DeployTimeConstant): The resource type +## AccessPolicyEntry +### Properties +* **applicationId**: string: Application ID of the client making request on behalf of a principal +* **objectId**: string (Required): 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. +* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. + +## Action +### Properties +* **type**: 'notify' | 'rotate': The type of action. + +## IPRule +### Properties +* **value**: string (Required): 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). + +## KeyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **enabled**: bool: Determines whether or not the object is enabled. +* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. +* **exportable**: bool: Indicates if the private key can be exported. +* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. +* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## KeyCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## KeyProperties +### Properties +* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. +* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. +* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'release' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation +* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. +* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. +* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. +* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. +* **release_policy**: [KeyReleasePolicy](#keyreleasepolicy) +* **rotationPolicy**: [RotationPolicy](#rotationpolicy) + +## KeyReleasePolicy +### Properties +* **contentType**: string: Content type and version of key release policy +* **data**: any: Blob encoding the policy rules under which the key can be released. + +## KeyRotationPolicyAttributes +### Properties +* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. +* **expiryTime**: string: The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. +* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. + +## LifetimeAction +### Properties +* **action**: [Action](#action) +* **trigger**: [Trigger](#trigger) + ## ManagedHsmProperties ### Properties * **createMode**: 'default' | 'recover': The vault's create mode to indicate whether the vault need to be recovered or not. @@ -99,6 +157,25 @@ * **statusMessage**: string (ReadOnly): Resource Status Message. * **tenantId**: string: The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManagedHsmSku +### Properties +* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool +* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool + +## MhsmipRule +### Properties +* **value**: string (Required): 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). + ## MhsmNetworkRuleSet ### Properties * **bypass**: 'AzureServices' | 'None' | string: Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. @@ -106,13 +183,9 @@ * **ipRules**: [MhsmipRule](#mhsmiprule)[]: The list of IP address rules. * **virtualNetworkRules**: [MhsmVirtualNetworkRule](#mhsmvirtualnetworkrule)[]: The list of virtual network rules. -## MhsmipRule -### Properties -* **value**: string (Required): 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). - -## MhsmVirtualNetworkRule +## MhsmPrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## MhsmPrivateEndpointConnectionItem ### Properties @@ -124,73 +197,15 @@ * **privateLinkServiceConnectionState**: [MhsmPrivateLinkServiceConnectionState](#mhsmprivatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## MhsmPrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## MhsmPrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## ManagedHsmSku -### Properties -* **family**: 'B' | string (Required): SKU Family of the managed HSM Pool -* **name**: 'Custom_B32' | 'Standard_B1' (Required): SKU of the managed HSM Pool - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the key vault resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. -* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedHsmResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VaultProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. -* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. -* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. -* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. -* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. -* **enablePurgeProtection**: bool: 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. -* **enableRbacAuthorization**: bool: 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 (warning: this is a preview feature). 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. -* **enableSoftDelete**: bool: 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. -* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. -* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. -* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. -* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. -* **publicNetworkAccess**: string: Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. -* **sku**: [Sku](#sku) (Required): SKU details -* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. -* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. - -## AccessPolicyEntry -### Properties -* **applicationId**: string: Application ID of the client making request on behalf of a principal -* **objectId**: string (Required): 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. -* **permissions**: [Permissions](#permissions) (Required): Permissions the identity has for keys, secrets, certificates and storage. -* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. - -## Permissions +## MhsmVirtualNetworkRule ### Properties -* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates -* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'getrotationpolicy' | 'import' | 'list' | 'purge' | 'recover' | 'release' | 'restore' | 'rotate' | 'setrotationpolicy' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys -* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets -* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. ## NetworkRuleSet ### Properties @@ -199,14 +214,16 @@ * **ipRules**: [IPRule](#iprule)[]: The list of IP address rules. * **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: The list of virtual network rules. -## IPRule +## Permissions ### Properties -* **value**: string (Required): 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). +* **certificates**: 'all' | 'backup' | 'create' | 'delete' | 'deleteissuers' | 'get' | 'getissuers' | 'import' | 'list' | 'listissuers' | 'managecontacts' | 'manageissuers' | 'purge' | 'recover' | 'restore' | 'setissuers' | 'update' | string[]: Permissions to certificates +* **keys**: 'all' | 'backup' | 'create' | 'decrypt' | 'delete' | 'encrypt' | 'get' | 'getrotationpolicy' | 'import' | 'list' | 'purge' | 'recover' | 'release' | 'restore' | 'rotate' | 'setrotationpolicy' | 'sign' | 'unwrapKey' | 'update' | 'verify' | 'wrapKey' | string[]: Permissions to keys +* **secrets**: 'all' | 'backup' | 'delete' | 'get' | 'list' | 'purge' | 'recover' | 'restore' | 'set' | string[]: Permissions to secrets +* **storage**: 'all' | 'backup' | 'delete' | 'deletesas' | 'get' | 'getsas' | 'list' | 'listsas' | 'purge' | 'recover' | 'regeneratekey' | 'restore' | 'set' | 'setsas' | 'update' | string[]: Permissions to storage accounts -## VirtualNetworkRule +## PrivateEndpoint ### Properties -* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. -* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. +* **id**: string (ReadOnly): Full identifier of the private endpoint resource. ## PrivateEndpointConnectionItem ### Properties @@ -220,110 +237,93 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'Disconnected' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: 'None' | string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## Sku -### Properties -* **family**: 'A' | string (Required): SKU family name -* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. - -## VaultCreateOrUpdateParametersTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VaultAccessPolicyProperties -### Properties -* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. - -## KeyProperties +## RotationPolicy ### Properties -* **attributes**: [KeyAttributes](#keyattributes): The object attributes managed by the Azure Key Vault service. -* **curveName**: 'P-256' | 'P-256K' | 'P-384' | 'P-521' | string: The elliptic curve name. For valid values, see JsonWebKeyCurveName. -* **keyOps**: 'decrypt' | 'encrypt' | 'import' | 'release' | 'sign' | 'unwrapKey' | 'verify' | 'wrapKey' | string[]: Array of JsonWebKeyOperation -* **keySize**: int: The key size in bits. For example: 2048, 3072, or 4096 for RSA. -* **keyUri**: string (ReadOnly): The URI to retrieve the current version of the key. -* **keyUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the key. -* **kty**: 'EC' | 'EC-HSM' | 'RSA' | 'RSA-HSM' | string: The type of the key. For valid values, see JsonWebKeyType. -* **release_policy**: [KeyReleasePolicy](#keyreleasepolicy) -* **rotationPolicy**: [RotationPolicy](#rotationpolicy) +* **attributes**: [KeyRotationPolicyAttributes](#keyrotationpolicyattributes) +* **lifetimeActions**: [LifetimeAction](#lifetimeaction)[]: The lifetimeActions for key rotation action. -## KeyAttributes +## SecretAttributes ### Properties * **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether or not the object is enabled. +* **enabled**: bool: Determines whether the object is enabled. * **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **exportable**: bool: Indicates if the private key can be exported. * **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **recoveryLevel**: 'Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'Recoverable+Purgeable' | string (ReadOnly): The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. * **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. -## KeyReleasePolicy -### Properties -* **contentType**: string: Content type and version of key release policy -* **data**: any: Blob encoding the policy rules under which the key can be released. - -## RotationPolicy +## SecretCreateOrUpdateParametersTags ### Properties -* **attributes**: [KeyRotationPolicyAttributes](#keyrotationpolicyattributes) -* **lifetimeActions**: [LifetimeAction](#lifetimeaction)[]: The lifetimeActions for key rotation action. +### Additional Properties +* **Additional Properties Type**: string -## KeyRotationPolicyAttributes +## SecretProperties ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **expiryTime**: string: The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. +* **contentType**: string: The content type of the secret. +* **secretUri**: string (ReadOnly): The URI to retrieve the current version of the secret. +* **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. +* **value**: 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. -## LifetimeAction +## Sku ### Properties -* **action**: [Action](#action) -* **trigger**: [Trigger](#trigger) +* **family**: 'A' | string (Required): SKU family name +* **name**: 'premium' | 'standard' (Required): SKU name to specify whether the key vault is a standard vault or a premium vault. -## Action +## SystemData ### Properties -* **type**: 'notify' | 'rotate': The type of action. +* **createdAt**: string (ReadOnly): The timestamp of the key vault resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the key vault resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. +* **lastModifiedAt**: string (ReadOnly): The timestamp of the key vault resource last modification (UTC). +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the key vault resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity. ## Trigger ### Properties * **timeAfterCreate**: string: The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. * **timeBeforeExpiry**: string: The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. -## KeyCreateParametersTags +## VaultAccessPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[] (Required): 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. -## ResourceTags +## VaultCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SecretProperties -### Properties -* **attributes**: [SecretAttributes](#secretattributes): The secret management attributes. -* **contentType**: string: The content type of the secret. -* **secretUri**: string (ReadOnly): The URI to retrieve the current version of the secret. -* **secretUriWithVersion**: string (ReadOnly): The URI to retrieve the specific version of the secret. -* **value**: 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. - -## SecretAttributes +## VaultProperties ### Properties -* **created**: int (ReadOnly): Creation time in seconds since 1970-01-01T00:00:00Z. -* **enabled**: bool: Determines whether the object is enabled. -* **exp**: int: Expiry date in seconds since 1970-01-01T00:00:00Z. -* **nbf**: int: Not before date in seconds since 1970-01-01T00:00:00Z. -* **updated**: int (ReadOnly): Last updated time in seconds since 1970-01-01T00:00:00Z. +* **accessPolicies**: [AccessPolicyEntry](#accesspolicyentry)[]: 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. +* **createMode**: 'default' | 'recover' (WriteOnly): The vault's create mode to indicate whether the vault need to be recovered or not. +* **enabledForDeployment**: bool: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. +* **enabledForDiskEncryption**: bool: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. +* **enabledForTemplateDeployment**: bool: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. +* **enablePurgeProtection**: bool: 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. +* **enableRbacAuthorization**: bool: 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 (warning: this is a preview feature). 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. +* **enableSoftDelete**: bool: 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. +* **hsmPoolResourceId**: string (ReadOnly): The resource id of HSM Pool. +* **networkAcls**: [NetworkRuleSet](#networkruleset): A set of rules governing the network accessibility of a vault. +* **privateEndpointConnections**: [PrivateEndpointConnectionItem](#privateendpointconnectionitem)[] (ReadOnly): List of private endpoint connections associated with the key vault. +* **provisioningState**: 'RegisteringDns' | 'Succeeded' | string: Provisioning state of the vault. +* **publicNetworkAccess**: string: Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. +* **sku**: [Sku](#sku) (Required): SKU details +* **softDeleteRetentionInDays**: int: softDelete data retention days. It accepts >=7 and <=90. +* **tenantId**: string (Required): The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. +* **vaultUri**: string: The URI of the vault for performing operations on keys and secrets. -## SecretCreateOrUpdateParametersTags +## VirtualNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. +* **ignoreMissingVnetServiceEndpoint**: bool: Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. diff --git a/generated/kubernetesconfiguration/log.out b/generated/kubernetesconfiguration/log.out index 3680d7c2f0..f93debd611 100644 --- a/generated/kubernetesconfiguration/log.out +++ b/generated/kubernetesconfiguration/log.out @@ -13,7 +13,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.kubernetesconfiguration-2022-04-02-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -26,14 +26,14 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/DuplicateSchema | Duplicate Schema named 'Resource' (1 differences): - properties.systemData: => {"readOnly":true,"type":"object","description":"Azure Resource Manager metadata containing createdBy and modifiedBy information.","$ref":"#/components/schemas/schemas:132"} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'Resource' -> 'ResourceAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 15ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.kubernetesconfiguration-2022-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -46,11 +46,11 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.kubernetesconfiguration-2022-01-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -63,7 +63,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -79,11 +79,11 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.kubernetesconfiguration-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -96,11 +96,11 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.kubernetesconfiguration-2021-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -113,7 +113,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -130,7 +130,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Extension' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensions.json:475:5 @@ -152,7 +152,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/kubernetesconfiguration.json:537:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.kubernetesconfiguration-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -165,7 +165,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Result' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/stable/2021-03-01/kubernetesconfiguration.json:291:5 @@ -199,7 +199,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Result' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2020-10-01-preview/kubernetesconfiguration.json:365:5 @@ -233,7 +233,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Result' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2020-07-01-preview/kubernetesconfiguration.json:365:5 @@ -283,7 +283,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Result' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2019-11-01-preview/kubernetesconfiguration.json:317:5 @@ -303,4 +303,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperationList - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2019-11-01-preview/kubernetesconfiguration.json:581:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 24.87s. 20 files generated. +info | Autorest completed in 24.31s. 20 files generated. diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2019-11-01-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2019-11-01-preview/types.md index 2d2aa1e2b2..1ca2c44f74 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2019-11-01-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2019-11-01-preview/types.md @@ -9,6 +9,18 @@ * **properties**: [SourceControlConfigurationProperties](#sourcecontrolconfigurationproperties): Properties to create a Source Control Configuration resource * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type +## ComplianceStatus +### Properties +* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. +* **lastConfigApplied**: string: Datetime the configuration was last applied. +* **message**: string: Message from when the configuration was applied. +* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. + +## HelmOperatorProperties +### Properties +* **chartValues**: string: Values override for the operator Helm chart. +* **chartVersion**: string: Version of the operator Helm chart. + ## SourceControlConfigurationProperties ### Properties * **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details @@ -23,15 +35,3 @@ * **repositoryPublicKey**: string (ReadOnly): Public Key associated with this SourceControl configuration (either generated within the cluster or provided by the user). * **repositoryUrl**: string: Url of the SourceControl Repository. -## ComplianceStatus -### Properties -* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. -* **lastConfigApplied**: string: Datetime the configuration was last applied. -* **message**: string: Message from when the configuration was applied. -* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. - -## HelmOperatorProperties -### Properties -* **chartValues**: string: Values override for the operator Helm chart. -* **chartVersion**: string: Version of the operator Helm chart. - diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.md index 10aae00adf..bc1ab27d6d 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-07-01-preview/types.md @@ -20,6 +20,34 @@ * **systemData**: [SystemData](#systemdata): Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type +## ComplianceStatus +### Properties +* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. +* **lastConfigApplied**: string: Datetime the configuration was last applied. +* **message**: string: Message from when the configuration was applied. +* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. + +## ConfigurationIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by the configuration. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by the configuration. +* **type**: 'None' | 'SystemAssigned': The type of identity used for the configuration. Type 'SystemAssigned' will use an implicitly created identity. Type 'None' will not use Managed Identity for the configuration. + +## ConfigurationProtectedSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ConfigurationSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ErrorDefinition +### Properties +* **code**: string (Required): Service specific error code which serves as the substatus for the HTTP error code. +* **message**: string (Required): Description of the error. + ## ExtensionInstanceProperties ### Properties * **autoUpgradeMinorVersion**: bool: Flag to note if this instance participates in auto upgrade of minor version, or not. @@ -42,21 +70,18 @@ ### Additional Properties * **Additional Properties Type**: string -## ConfigurationSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ErrorDefinition +## ExtensionStatus ### Properties -* **code**: string (Required): Service specific error code which serves as the substatus for the HTTP error code. -* **message**: string (Required): Description of the error. +* **code**: string: Status code provided by the Extension +* **displayStatus**: string: Short description of status of this instance of the extension. +* **level**: 'Error' | 'Information' | 'Warning' | string: Level of the status. +* **message**: string: Detailed message of the status from the Extension instance. +* **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## ConfigurationIdentity +## HelmOperatorProperties ### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity which is used by the configuration. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity which is used by the configuration. -* **type**: 'None' | 'SystemAssigned': The type of identity used for the configuration. Type 'SystemAssigned' will use an implicitly created identity. Type 'None' will not use Managed Identity for the configuration. +* **chartValues**: string: Values override for the operator Helm chart. +* **chartVersion**: string: Version of the operator Helm chart. ## Scope ### Properties @@ -71,23 +96,6 @@ ### Properties * **targetNamespace**: string: Namespace where the extensionInstance will be created for an Namespace scoped extensionInstance. If this namespace does not exist, it will be created -## ExtensionStatus -### Properties -* **code**: string: Status code provided by the Extension -* **displayStatus**: string: Short description of status of this instance of the extension. -* **level**: 'Error' | 'Information' | 'Warning' | string: Level of the status. -* **message**: string: Detailed message of the status from the Extension instance. -* **time**: string: DateLiteral (per ISO8601) noting the time of installation status. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC) -* **createdBy**: string (ReadOnly): A string identifier for the identity that created the resource -* **createdByType**: string (ReadOnly): The type of identity that created the resource: user, application, managedIdentity, key -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource -* **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity, key - ## SourceControlConfigurationProperties ### Properties * **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details @@ -104,20 +112,12 @@ * **repositoryUrl**: string: Url of the SourceControl Repository. * **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances -## ComplianceStatus -### Properties -* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. -* **lastConfigApplied**: string: Datetime the configuration was last applied. -* **message**: string: Message from when the configuration was applied. -* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. - -## ConfigurationProtectedSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HelmOperatorProperties +## SystemData ### Properties -* **chartValues**: string: Values override for the operator Helm chart. -* **chartVersion**: string: Version of the operator Helm chart. +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC) +* **createdBy**: string (ReadOnly): A string identifier for the identity that created the resource +* **createdByType**: string (ReadOnly): The type of identity that created the resource: user, application, managedIdentity, key +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource +* **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity, key diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-10-01-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-10-01-preview/types.md index 04d4dffae8..0bfbf1d734 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-10-01-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2020-10-01-preview/types.md @@ -10,22 +10,6 @@ * **systemData**: [SystemData](#systemdata): Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## SourceControlConfigurationProperties -### Properties -* **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details -* **configurationProtectedSettings**: [ConfigurationProtectedSettings](#configurationprotectedsettings): Name-value pairs of protected configuration settings for the configuration -* **enableHelmOperator**: bool: Option to enable Helm Operator for this git configuration. -* **helmOperatorProperties**: [HelmOperatorProperties](#helmoperatorproperties): Properties for Helm operator. -* **operatorInstanceName**: string: Instance name of the operator - identifying the specific configuration. -* **operatorNamespace**: string: The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. -* **operatorParams**: string: Any Parameters for the Operator instance in string format. -* **operatorScope**: 'cluster' | 'namespace' | string: Scope at which the operator will be installed. -* **operatorType**: 'Flux' | string: Type of the operator -* **provisioningState**: 'Accepted' | 'Deleting' | 'Failed' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioning state of the resource provider. -* **repositoryPublicKey**: string (ReadOnly): Public Key associated with this SourceControl configuration (either generated within the cluster or provided by the user). -* **repositoryUrl**: string: Url of the SourceControl Repository. -* **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances - ## ComplianceStatus ### Properties * **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. @@ -43,6 +27,22 @@ * **chartValues**: string: Values override for the operator Helm chart. * **chartVersion**: string: Version of the operator Helm chart. +## SourceControlConfigurationProperties +### Properties +* **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details +* **configurationProtectedSettings**: [ConfigurationProtectedSettings](#configurationprotectedsettings): Name-value pairs of protected configuration settings for the configuration +* **enableHelmOperator**: bool: Option to enable Helm Operator for this git configuration. +* **helmOperatorProperties**: [HelmOperatorProperties](#helmoperatorproperties): Properties for Helm operator. +* **operatorInstanceName**: string: Instance name of the operator - identifying the specific configuration. +* **operatorNamespace**: string: The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. +* **operatorParams**: string: Any Parameters for the Operator instance in string format. +* **operatorScope**: 'cluster' | 'namespace' | string: Scope at which the operator will be installed. +* **operatorType**: 'Flux' | string: Type of the operator +* **provisioningState**: 'Accepted' | 'Deleting' | 'Failed' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioning state of the resource provider. +* **repositoryPublicKey**: string (ReadOnly): Public Key associated with this SourceControl configuration (either generated within the cluster or provided by the user). +* **repositoryUrl**: string: Url of the SourceControl Repository. +* **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances + ## SystemData ### Properties * **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC) diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-03-01/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-03-01/types.md index 3c87f58020..ef3406f9cd 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-03-01/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-03-01/types.md @@ -10,22 +10,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## SourceControlConfigurationProperties -### Properties -* **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details -* **configurationProtectedSettings**: [ConfigurationProtectedSettings](#configurationprotectedsettings): Name-value pairs of protected configuration settings for the configuration -* **enableHelmOperator**: bool: Option to enable Helm Operator for this git configuration. -* **helmOperatorProperties**: [HelmOperatorProperties](#helmoperatorproperties): Properties for Helm operator. -* **operatorInstanceName**: string: Instance name of the operator - identifying the specific configuration. -* **operatorNamespace**: string: The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. -* **operatorParams**: string: Any Parameters for the Operator instance in string format. -* **operatorScope**: 'cluster' | 'namespace' | string: Scope at which the operator will be installed. -* **operatorType**: 'Flux' | string: Type of the operator -* **provisioningState**: 'Accepted' | 'Deleting' | 'Failed' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioning state of the resource provider. -* **repositoryPublicKey**: string (ReadOnly): Public Key associated with this SourceControl configuration (either generated within the cluster or provided by the user). -* **repositoryUrl**: string: Url of the SourceControl Repository. -* **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances - ## ComplianceStatus ### Properties * **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. @@ -43,6 +27,22 @@ * **chartValues**: string: Values override for the operator Helm chart. * **chartVersion**: string: Version of the operator Helm chart. +## SourceControlConfigurationProperties +### Properties +* **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details +* **configurationProtectedSettings**: [ConfigurationProtectedSettings](#configurationprotectedsettings): Name-value pairs of protected configuration settings for the configuration +* **enableHelmOperator**: bool: Option to enable Helm Operator for this git configuration. +* **helmOperatorProperties**: [HelmOperatorProperties](#helmoperatorproperties): Properties for Helm operator. +* **operatorInstanceName**: string: Instance name of the operator - identifying the specific configuration. +* **operatorNamespace**: string: The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. +* **operatorParams**: string: Any Parameters for the Operator instance in string format. +* **operatorScope**: 'cluster' | 'namespace' | string: Scope at which the operator will be installed. +* **operatorType**: 'Flux' | string: Type of the operator +* **provisioningState**: 'Accepted' | 'Deleting' | 'Failed' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioning state of the resource provider. +* **repositoryPublicKey**: string (ReadOnly): Public Key associated with this SourceControl configuration (either generated within the cluster or provided by the user). +* **repositoryUrl**: string: Url of the SourceControl Repository. +* **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.md index 7e36db68e7..ba76f7a982 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-05-01-preview/types.md @@ -21,11 +21,30 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ComplianceStatus ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. +* **lastConfigApplied**: string: Datetime the configuration was last applied. +* **message**: string: Message from when the configuration was applied. +* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. + +## ConfigurationProtectedSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. ## ExtensionProperties ### Properties @@ -57,18 +76,24 @@ ### Additional Properties * **Additional Properties Type**: string -## ErrorDetail +## ExtensionStatus ### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. +* **code**: string: Status code provided by the Extension +* **displayStatus**: string: Short description of status of the extension. +* **level**: 'Error' | 'Information' | 'Warning' | string: Level of the status. +* **message**: string: Detailed message of the status from the Extension. +* **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## ErrorAdditionalInfo +## HelmOperatorProperties ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **chartValues**: string: Values override for the operator Helm chart. +* **chartVersion**: string: Version of the operator Helm chart. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## Scope ### Properties @@ -83,23 +108,6 @@ ### Properties * **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created -## ExtensionStatus -### Properties -* **code**: string: Status code provided by the Extension -* **displayStatus**: string: Short description of status of the extension. -* **level**: 'Error' | 'Information' | 'Warning' | string: Level of the status. -* **message**: string: Detailed message of the status from the Extension. -* **time**: string: DateLiteral (per ISO8601) noting the time of installation status. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## SourceControlConfigurationProperties ### Properties * **complianceStatus**: [ComplianceStatus](#compliancestatus) (ReadOnly): Compliance Status details @@ -116,20 +124,12 @@ * **repositoryUrl**: string: Url of the SourceControl Repository. * **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances -## ComplianceStatus -### Properties -* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. -* **lastConfigApplied**: string: Datetime the configuration was last applied. -* **message**: string: Message from when the configuration was applied. -* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. - -## ConfigurationProtectedSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HelmOperatorProperties +## SystemData ### Properties -* **chartValues**: string: Values override for the operator Helm chart. -* **chartVersion**: string: Version of the operator Helm chart. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-09-01/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-09-01/types.md index 469c6eebca..08b4067b68 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-09-01/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-09-01/types.md @@ -11,11 +11,18 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/extensions' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ErrorAdditionalInfo ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. ## ExtensionProperties ### Properties @@ -54,18 +61,19 @@ ### Additional Properties * **Additional Properties Type**: string -## ErrorDetail +## ExtensionStatus ### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. +* **code**: string: Status code provided by the Extension +* **displayStatus**: string: Short description of status of the extension. +* **level**: 'Error' | 'Information' | 'Warning' | string: Level of the status. +* **message**: string: Detailed message of the status from the Extension. +* **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## ErrorAdditionalInfo +## Identity ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## Scope ### Properties @@ -80,14 +88,6 @@ ### Properties * **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created -## ExtensionStatus -### Properties -* **code**: string: Status code provided by the Extension -* **displayStatus**: string: Short description of status of the extension. -* **level**: 'Error' | 'Information' | 'Warning' | string: Level of the status. -* **message**: string: Detailed message of the status from the Extension. -* **time**: string: DateLiteral (per ISO8601) noting the time of installation status. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.md index ce1e3b1613..b868925f49 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2021-11-01-preview/types.md @@ -31,11 +31,34 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ComplianceStatus ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. +* **lastConfigApplied**: string: Datetime the configuration was last applied. +* **message**: string: Message from when the configuration was applied. +* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. + +## ConfigurationProtectedSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DependsOnDefinition +### Properties +* **kustomizationName**: string: Name of the kustomization to claim dependency on + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. ## ExtensionProperties ### Properties @@ -74,32 +97,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## Scope -### Properties -* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster -* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace - -## ScopeCluster -### Properties -* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created - -## ScopeNamespace -### Properties -* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created - ## ExtensionStatus ### Properties * **code**: string: Status code provided by the Extension @@ -108,15 +105,6 @@ * **message**: string: Detailed message of the status from the Extension. * **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## FluxConfigurationProperties ### Properties * **complianceState**: 'Compliant' | 'Non-Compliant' | 'Pending' | 'Suspended' | 'Unknown' | string (ReadOnly): Compliance state of the cluster object. @@ -139,6 +127,11 @@ ### Additional Properties * **Additional Properties Type**: string +## FluxConfigurationPropertiesKustomizations +### Properties +### Additional Properties +* **Additional Properties Type**: [KustomizationDefinition](#kustomizationdefinition) + ## GitRepositoryDefinition ### Properties * **httpsCAFile**: string: Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS @@ -150,17 +143,24 @@ * **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. * **url**: string: The URL to sync for the flux configuration git repository. -## RepositoryRefDefinition +## HelmOperatorProperties ### Properties -* **branch**: string: The git repository branch name to checkout. -* **commit**: string: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. -* **semver**: string: The semver range used to match against git repository tags. This takes precedence over tag. -* **tag**: string: The git repository tag name to checkout. This takes precedence over branch. +* **chartValues**: string: Values override for the operator Helm chart. +* **chartVersion**: string: Version of the operator Helm chart. -## FluxConfigurationPropertiesKustomizations +## HelmReleasePropertiesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: [KustomizationDefinition](#kustomizationdefinition) +* **failureCount**: int: Total number of times that the HelmRelease failed to install or upgrade +* **helmChartRef**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster +* **installFailureCount**: int: Number of times that the HelmRelease failed to install +* **lastRevisionApplied**: int: The revision number of the last released object change +* **upgradeFailureCount**: int: Number of times that the HelmRelease failed to upgrade + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## KustomizationDefinition ### Properties @@ -173,9 +173,18 @@ * **timeoutInSeconds**: int: The maximum time to attempt to reconcile the Kustomization on the cluster. * **validation**: 'client' | 'none' | 'server' | string: Specify whether to validate the Kubernetes objects referenced in the Kustomization before applying them to the cluster. -## DependsOnDefinition +## ObjectReferenceDefinition ### Properties -* **kustomizationName**: string: Name of the kustomization to claim dependency on +* **name**: string: Name of the object +* **namespace**: string: Namespace of the object + +## ObjectStatusConditionDefinition +### Properties +* **lastTransitionTime**: string: Last time this status condition has changed +* **message**: string: A more verbose description of the object status condition +* **reason**: string: Reason for the specified status condition type status +* **status**: string: Status of the Kubernetes object condition type +* **type**: string: Object status condition type for this object ## ObjectStatusDefinition ### Properties @@ -187,26 +196,25 @@ * **namespace**: string: Namespace of the applied object * **statusConditions**: [ObjectStatusConditionDefinition](#objectstatusconditiondefinition)[]: List of Kubernetes object status conditions present on the cluster -## ObjectReferenceDefinition +## RepositoryRefDefinition ### Properties -* **name**: string: Name of the object -* **namespace**: string: Namespace of the object +* **branch**: string: The git repository branch name to checkout. +* **commit**: string: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. +* **semver**: string: The semver range used to match against git repository tags. This takes precedence over tag. +* **tag**: string: The git repository tag name to checkout. This takes precedence over branch. -## HelmReleasePropertiesDefinition +## Scope ### Properties -* **failureCount**: int: Total number of times that the HelmRelease failed to install or upgrade -* **helmChartRef**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster -* **installFailureCount**: int: Number of times that the HelmRelease failed to install -* **lastRevisionApplied**: int: The revision number of the last released object change -* **upgradeFailureCount**: int: Number of times that the HelmRelease failed to upgrade +* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster +* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace -## ObjectStatusConditionDefinition +## ScopeCluster ### Properties -* **lastTransitionTime**: string: Last time this status condition has changed -* **message**: string: A more verbose description of the object status condition -* **reason**: string: Reason for the specified status condition type status -* **status**: string: Status of the Kubernetes object condition type -* **type**: string: Object status condition type for this object +* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created + +## ScopeNamespace +### Properties +* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created ## SourceControlConfigurationProperties ### Properties @@ -224,20 +232,12 @@ * **repositoryUrl**: string: Url of the SourceControl Repository. * **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances -## ComplianceStatus -### Properties -* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. -* **lastConfigApplied**: string: Datetime the configuration was last applied. -* **message**: string: Message from when the configuration was applied. -* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. - -## ConfigurationProtectedSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HelmOperatorProperties +## SystemData ### Properties -* **chartValues**: string: Values override for the operator Helm chart. -* **chartVersion**: string: Version of the operator Helm chart. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.md index 6b5ed29bf8..085e8d4a99 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-01-01-preview/types.md @@ -31,11 +31,44 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## BucketDefinition ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **accessKey**: string: Plaintext access key used to securely access the S3 bucket +* **bucketName**: string: The bucket name to sync from the url endpoint for the flux configuration. +* **insecure**: bool: Specify whether to use insecure communication when puling data from the S3 bucket. +* **localAuthRef**: string: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. +* **syncIntervalInSeconds**: int: The interval at which to re-reconcile the cluster git repository source with the remote. +* **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. +* **url**: string: The URL to sync for the flux configuration S3 bucket. + +## ComplianceStatus +### Properties +* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. +* **lastConfigApplied**: string: Datetime the configuration was last applied. +* **message**: string: Message from when the configuration was applied. +* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. + +## ConfigurationProtectedSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DependsOnDefinition +### Properties +* **kustomizationName**: string: Name of the kustomization to claim dependency on + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. ## ExtensionProperties ### Properties @@ -74,32 +107,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## Scope -### Properties -* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster -* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace - -## ScopeCluster -### Properties -* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created - -## ScopeNamespace -### Properties -* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created - ## ExtensionStatus ### Properties * **code**: string: Status code provided by the Extension @@ -108,15 +115,6 @@ * **message**: string: Detailed message of the status from the Extension. * **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## FluxConfigurationProperties ### Properties * **bucket**: [BucketDefinition](#bucketdefinition): Parameters to reconcile to the GitRepository source kind type. @@ -135,21 +133,16 @@ * **statuses**: [ObjectStatusDefinition](#objectstatusdefinition)[] (ReadOnly): Statuses of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects provisioned by the fluxConfiguration. * **suspend**: bool: Whether this configuration should suspend its reconciliation of its kustomizations and sources. -## BucketDefinition -### Properties -* **accessKey**: string: Plaintext access key used to securely access the S3 bucket -* **bucketName**: string: The bucket name to sync from the url endpoint for the flux configuration. -* **insecure**: bool: Specify whether to use insecure communication when puling data from the S3 bucket. -* **localAuthRef**: string: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. -* **syncIntervalInSeconds**: int: The interval at which to re-reconcile the cluster git repository source with the remote. -* **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. -* **url**: string: The URL to sync for the flux configuration S3 bucket. - ## FluxConfigurationPropertiesConfigurationProtectedSettings ### Properties ### Additional Properties * **Additional Properties Type**: string +## FluxConfigurationPropertiesKustomizations +### Properties +### Additional Properties +* **Additional Properties Type**: [KustomizationDefinition](#kustomizationdefinition) + ## GitRepositoryDefinition ### Properties * **httpsCACert**: string: Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS @@ -161,17 +154,24 @@ * **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. * **url**: string: The URL to sync for the flux configuration git repository. -## RepositoryRefDefinition +## HelmOperatorProperties ### Properties -* **branch**: string: The git repository branch name to checkout. -* **commit**: string: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. -* **semver**: string: The semver range used to match against git repository tags. This takes precedence over tag. -* **tag**: string: The git repository tag name to checkout. This takes precedence over branch. +* **chartValues**: string: Values override for the operator Helm chart. +* **chartVersion**: string: Version of the operator Helm chart. -## FluxConfigurationPropertiesKustomizations +## HelmReleasePropertiesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: [KustomizationDefinition](#kustomizationdefinition) +* **failureCount**: int: Total number of times that the HelmRelease failed to install or upgrade +* **helmChartRef**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster +* **installFailureCount**: int: Number of times that the HelmRelease failed to install +* **lastRevisionApplied**: int: The revision number of the last released object change +* **upgradeFailureCount**: int: Number of times that the HelmRelease failed to upgrade + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## KustomizationDefinition ### Properties @@ -183,9 +183,18 @@ * **syncIntervalInSeconds**: int: The interval at which to re-reconcile the Kustomization on the cluster. * **timeoutInSeconds**: int: The maximum time to attempt to reconcile the Kustomization on the cluster. -## DependsOnDefinition +## ObjectReferenceDefinition ### Properties -* **kustomizationName**: string: Name of the kustomization to claim dependency on +* **name**: string: Name of the object +* **namespace**: string: Namespace of the object + +## ObjectStatusConditionDefinition +### Properties +* **lastTransitionTime**: string: Last time this status condition has changed +* **message**: string: A more verbose description of the object status condition +* **reason**: string: Reason for the specified status condition type status +* **status**: string: Status of the Kubernetes object condition type +* **type**: string: Object status condition type for this object ## ObjectStatusDefinition ### Properties @@ -197,26 +206,25 @@ * **namespace**: string: Namespace of the applied object * **statusConditions**: [ObjectStatusConditionDefinition](#objectstatusconditiondefinition)[]: List of Kubernetes object status conditions present on the cluster -## ObjectReferenceDefinition +## RepositoryRefDefinition ### Properties -* **name**: string: Name of the object -* **namespace**: string: Namespace of the object +* **branch**: string: The git repository branch name to checkout. +* **commit**: string: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. +* **semver**: string: The semver range used to match against git repository tags. This takes precedence over tag. +* **tag**: string: The git repository tag name to checkout. This takes precedence over branch. -## HelmReleasePropertiesDefinition +## Scope ### Properties -* **failureCount**: int: Total number of times that the HelmRelease failed to install or upgrade -* **helmChartRef**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster -* **installFailureCount**: int: Number of times that the HelmRelease failed to install -* **lastRevisionApplied**: int: The revision number of the last released object change -* **upgradeFailureCount**: int: Number of times that the HelmRelease failed to upgrade +* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster +* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace -## ObjectStatusConditionDefinition +## ScopeCluster ### Properties -* **lastTransitionTime**: string: Last time this status condition has changed -* **message**: string: A more verbose description of the object status condition -* **reason**: string: Reason for the specified status condition type status -* **status**: string: Status of the Kubernetes object condition type -* **type**: string: Object status condition type for this object +* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created + +## ScopeNamespace +### Properties +* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created ## SourceControlConfigurationProperties ### Properties @@ -234,20 +242,12 @@ * **repositoryUrl**: string: Url of the SourceControl Repository. * **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances -## ComplianceStatus -### Properties -* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. -* **lastConfigApplied**: string: Datetime the configuration was last applied. -* **message**: string: Message from when the configuration was applied. -* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. - -## ConfigurationProtectedSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HelmOperatorProperties +## SystemData ### Properties -* **chartValues**: string: Values override for the operator Helm chart. -* **chartVersion**: string: Version of the operator Helm chart. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.md index b503b59e27..f5b4ec8d4e 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-03-01/types.md @@ -31,11 +31,40 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/sourceControlConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## BucketDefinition ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **accessKey**: string: Plaintext access key used to securely access the S3 bucket +* **bucketName**: string: The bucket name to sync from the url endpoint for the flux configuration. +* **insecure**: bool: Specify whether to use insecure communication when puling data from the S3 bucket. +* **localAuthRef**: string: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. +* **syncIntervalInSeconds**: int: The interval at which to re-reconcile the cluster git repository source with the remote. +* **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. +* **url**: string: The URL to sync for the flux configuration S3 bucket. + +## ComplianceStatus +### Properties +* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. +* **lastConfigApplied**: string: Datetime the configuration was last applied. +* **message**: string: Message from when the configuration was applied. +* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. + +## ConfigurationProtectedSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. ## ExtensionProperties ### Properties @@ -75,32 +104,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## Scope -### Properties -* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster -* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace - -## ScopeCluster -### Properties -* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created - -## ScopeNamespace -### Properties -* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created - ## ExtensionStatus ### Properties * **code**: string: Status code provided by the Extension @@ -109,15 +112,6 @@ * **message**: string: Detailed message of the status from the Extension. * **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## FluxConfigurationProperties ### Properties * **bucket**: [BucketDefinition](#bucketdefinition): Parameters to reconcile to the GitRepository source kind type. @@ -137,21 +131,16 @@ * **statusUpdatedAt**: string (ReadOnly): Datetime the fluxConfiguration synced its status on the cluster with Azure. * **suspend**: bool: Whether this configuration should suspend its reconciliation of its kustomizations and sources. -## BucketDefinition -### Properties -* **accessKey**: string: Plaintext access key used to securely access the S3 bucket -* **bucketName**: string: The bucket name to sync from the url endpoint for the flux configuration. -* **insecure**: bool: Specify whether to use insecure communication when puling data from the S3 bucket. -* **localAuthRef**: string: Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. -* **syncIntervalInSeconds**: int: The interval at which to re-reconcile the cluster git repository source with the remote. -* **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. -* **url**: string: The URL to sync for the flux configuration S3 bucket. - ## FluxConfigurationPropertiesConfigurationProtectedSettings ### Properties ### Additional Properties * **Additional Properties Type**: string +## FluxConfigurationPropertiesKustomizations +### Properties +### Additional Properties +* **Additional Properties Type**: [KustomizationDefinition](#kustomizationdefinition) + ## GitRepositoryDefinition ### Properties * **httpsCACert**: string: Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS @@ -163,17 +152,24 @@ * **timeoutInSeconds**: int: The maximum time to attempt to reconcile the cluster git repository source with the remote. * **url**: string: The URL to sync for the flux configuration git repository. -## RepositoryRefDefinition +## HelmOperatorProperties ### Properties -* **branch**: string: The git repository branch name to checkout. -* **commit**: string: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. -* **semver**: string: The semver range used to match against git repository tags. This takes precedence over tag. -* **tag**: string: The git repository tag name to checkout. This takes precedence over branch. +* **chartValues**: string: Values override for the operator Helm chart. +* **chartVersion**: string: Version of the operator Helm chart. -## FluxConfigurationPropertiesKustomizations +## HelmReleasePropertiesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: [KustomizationDefinition](#kustomizationdefinition) +* **failureCount**: int: Total number of times that the HelmRelease failed to install or upgrade +* **helmChartRef**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster +* **installFailureCount**: int: Number of times that the HelmRelease failed to install +* **lastRevisionApplied**: int: The revision number of the last released object change +* **upgradeFailureCount**: int: Number of times that the HelmRelease failed to upgrade + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## KustomizationDefinition ### Properties @@ -186,6 +182,19 @@ * **syncIntervalInSeconds**: int: The interval at which to re-reconcile the Kustomization on the cluster. * **timeoutInSeconds**: int: The maximum time to attempt to reconcile the Kustomization on the cluster. +## ObjectReferenceDefinition +### Properties +* **name**: string: Name of the object +* **namespace**: string: Namespace of the object + +## ObjectStatusConditionDefinition +### Properties +* **lastTransitionTime**: string: Last time this status condition has changed +* **message**: string: A more verbose description of the object status condition +* **reason**: string: Reason for the specified status condition type status +* **status**: string: Status of the Kubernetes object condition type +* **type**: string: Object status condition type for this object + ## ObjectStatusDefinition ### Properties * **appliedBy**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster @@ -196,26 +205,25 @@ * **namespace**: string: Namespace of the applied object * **statusConditions**: [ObjectStatusConditionDefinition](#objectstatusconditiondefinition)[]: List of Kubernetes object status conditions present on the cluster -## ObjectReferenceDefinition +## RepositoryRefDefinition ### Properties -* **name**: string: Name of the object -* **namespace**: string: Namespace of the object +* **branch**: string: The git repository branch name to checkout. +* **commit**: string: The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. +* **semver**: string: The semver range used to match against git repository tags. This takes precedence over tag. +* **tag**: string: The git repository tag name to checkout. This takes precedence over branch. -## HelmReleasePropertiesDefinition +## Scope ### Properties -* **failureCount**: int: Total number of times that the HelmRelease failed to install or upgrade -* **helmChartRef**: [ObjectReferenceDefinition](#objectreferencedefinition): Object reference to a Kubernetes object on a cluster -* **installFailureCount**: int: Number of times that the HelmRelease failed to install -* **lastRevisionApplied**: int: The revision number of the last released object change -* **upgradeFailureCount**: int: Number of times that the HelmRelease failed to upgrade +* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster +* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace -## ObjectStatusConditionDefinition +## ScopeCluster ### Properties -* **lastTransitionTime**: string: Last time this status condition has changed -* **message**: string: A more verbose description of the object status condition -* **reason**: string: Reason for the specified status condition type status -* **status**: string: Status of the Kubernetes object condition type -* **type**: string: Object status condition type for this object +* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created + +## ScopeNamespace +### Properties +* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created ## SourceControlConfigurationProperties ### Properties @@ -233,20 +241,12 @@ * **repositoryUrl**: string: Url of the SourceControl Repository. * **sshKnownHostsContents**: string: Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances -## ComplianceStatus -### Properties -* **complianceState**: 'Compliant' | 'Failed' | 'Installed' | 'Noncompliant' | 'Pending' | string (ReadOnly): The compliance state of the configuration. -* **lastConfigApplied**: string: Datetime the configuration was last applied. -* **message**: string: Message from when the configuration was applied. -* **messageLevel**: 'Error' | 'Information' | 'Warning' | string: Level of the message. - -## ConfigurationProtectedSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HelmOperatorProperties +## SystemData ### Properties -* **chartValues**: string: Values override for the operator Helm chart. -* **chartVersion**: string: Version of the operator Helm chart. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.md b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.md index e5001bc5d0..c9d2614bbf 100644 --- a/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.md +++ b/generated/kubernetesconfiguration/microsoft.kubernetesconfiguration/2022-04-02-preview/types.md @@ -34,19 +34,18 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.KubernetesConfiguration/privateLinkScopes/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ErrorAdditionalInfo ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. -## Plan +## ErrorDetail ### Properties -* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. -* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. -* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. -* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic -* **version**: string: The version of the desired product/artifact. +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. ## ExtensionProperties ### Properties @@ -86,32 +85,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## Scope -### Properties -* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster -* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace - -## ScopeCluster -### Properties -* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created - -## ScopeNamespace -### Properties -* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created - ## ExtensionStatus ### Properties * **code**: string: Status code provided by the Extension @@ -120,14 +93,11 @@ * **message**: string: Detailed message of the status from the Extension. * **time**: string: DateLiteral (per ISO8601) noting the time of installation status. -## SystemData +## Identity ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## KubernetesConfigurationPrivateLinkScopeProperties ### Properties @@ -137,6 +107,18 @@ * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link). +## Plan +### Properties +* **name**: string (Required): A user defined name of the 3rd Party Artifact that is being procured. +* **product**: string (Required): The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. +* **promotionCode**: string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. +* **publisher**: string (Required): The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic +* **version**: string: The version of the desired product/artifact. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -151,16 +133,34 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## Scope +### Properties +* **cluster**: [ScopeCluster](#scopecluster): Specifies that the scope of the extension is Cluster +* **namespace**: [ScopeNamespace](#scopenamespace): Specifies that the scope of the extension is Namespace + +## ScopeCluster +### Properties +* **releaseNamespace**: string: Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created + +## ScopeNamespace +### Properties +* **targetNamespace**: string: Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/labservices/log.out b/generated/labservices/log.out index 509d815fbf..2092d921f0 100644 --- a/generated/labservices/log.out +++ b/generated/labservices/log.out @@ -3,23 +3,23 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.labservices-2021-11-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.labservices-2021-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.labservices-2018-10-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms -info | Autorest completed in 13.56s. 6 files generated. +info | autorest.bicep took 6ms +info | Autorest completed in 12.91s. 6 files generated. diff --git a/generated/labservices/microsoft.labservices/2018-10-15/types.md b/generated/labservices/microsoft.labservices/2018-10-15/types.md index 287beca4a7..e804a24197 100644 --- a/generated/labservices/microsoft.labservices/2018-10-15/types.md +++ b/generated/labservices/microsoft.labservices/2018-10-15/types.md @@ -77,26 +77,45 @@ * **ApiVersion**: 2018-10-15 * **Output**: [ListLabsResponse](#listlabsresponse) -## LabAccountProperties +## EnvironmentDetails ### Properties -* **enabledRegionSelection**: bool: Represents if region selection is enabled +* **description**: string (ReadOnly): Description of the Environment +* **environmentState**: string (ReadOnly): Publishing state of the environment setting Possible values are Creating, Created, Failed +* **id**: string (ReadOnly): Resource Id of the environment * **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. -* **provisioningState**: string: The provisioning status of the resource. -* **sizeConfiguration**: [SizeConfigurationProperties](#sizeconfigurationproperties) (ReadOnly): Represents the size configuration under the lab account -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +* **name**: string (ReadOnly): Name of the Environment +* **passwordLastReset**: string (ReadOnly): When the password was last reset on the environment. +* **provisioningState**: string (ReadOnly): The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. +* **totalUsage**: string (ReadOnly): How long the environment has been used by a lab user +* **virtualMachineDetails**: [VirtualMachineDetails](#virtualmachinedetails) (ReadOnly): Details of the backing virtual machine. -## LatestOperationResult +## EnvironmentProperties ### Properties -* **errorCode**: string (ReadOnly): Error code on failure. -* **errorMessage**: string (ReadOnly): The error message. -* **httpMethod**: string (ReadOnly): The HttpMethod - PUT/POST/DELETE for the operation. -* **operationUrl**: string (ReadOnly): The URL to use to check long-running operation status -* **requestUri**: string (ReadOnly): Request URI of the operation. -* **status**: string (ReadOnly): The current status of the operation. +* **claimedByUserName**: string (ReadOnly): The name or email address of the user who has claimed the environment +* **claimedByUserObjectId**: string (ReadOnly): The AAD object Id of the user who has claimed the environment +* **claimedByUserPrincipalId**: string (ReadOnly): The user principal Id of the user who has claimed the environment +* **isClaimed**: bool (ReadOnly): Is the environment claimed or not +* **lastKnownPowerState**: string (ReadOnly): Last known power state of the environment +* **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. +* **networkInterface**: [NetworkInterface](#networkinterface) (ReadOnly): Network details of the environment +* **passwordLastReset**: string (ReadOnly): When the password was last reset on the environment. +* **provisioningState**: string: The provisioning status of the resource. +* **resourceSets**: [ResourceSet](#resourceset): Represents a VM and the setting Id it was created for. +* **totalUsage**: string (ReadOnly): How long the environment has been used by a lab user +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). -## SizeConfigurationProperties +## EnvironmentSettingProperties ### Properties -* **environmentSizes**: [EnvironmentSize](#environmentsize)[]: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) +* **configurationState**: 'Completed' | 'NotApplicable' | string: Describes the user's progress in configuring their environment setting +* **description**: string: Describes the environment and its resource settings +* **lastChanged**: string (ReadOnly): Time when the template VM was last changed. +* **lastPublished**: string (ReadOnly): Time when the template VM was last sent for publishing. +* **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. +* **provisioningState**: string: The provisioning status of the resource. +* **publishingState**: 'Draft' | 'PublishFailed' | 'Published' | 'Publishing' | 'Scaling' | string (ReadOnly): Describes the readiness of this environment setting +* **resourceSettings**: [ResourceSettings](#resourcesettings) (Required): Represents resource specific settings +* **title**: string: Brief title describing the environment and its resource settings +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). ## EnvironmentSize ### Properties @@ -106,18 +125,6 @@ * **name**: 'Basic' | 'Performance' | 'Standard' | string: The size category * **vmSizes**: [SizeInfo](#sizeinfo)[]: Represents a set of compute sizes that can serve this given size type -## SizeInfo -### Properties -* **computeSize**: string: Represents the actual compute size, e.g. Standard_A2_v2. -* **memory**: int: The amount of memory available (in GB). -* **numberOfCores**: int: The number of cores a VM of this size has. -* **price**: int: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## GalleryImageProperties ### Properties * **author**: string (ReadOnly): The author of the gallery image. @@ -141,10 +148,20 @@ * **sku**: string: The SKU of the gallery image. * **version**: string: The version of the gallery image. -## ResourceTags +## LabAccountProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabledRegionSelection**: bool: Represents if region selection is enabled +* **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. +* **provisioningState**: string: The provisioning status of the resource. +* **sizeConfiguration**: [SizeConfigurationProperties](#sizeconfigurationproperties) (ReadOnly): Represents the size configuration under the lab account +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). + +## LabDetails +### Properties +* **id**: string (ReadOnly): The Id of the lab. +* **name**: string (ReadOnly): Name of the lab +* **provisioningState**: string (ReadOnly): The provisioning state of the lab. +* **usageQuota**: string (ReadOnly): The maximum duration a user can use a VM in this lab. ## LabProperties ### Properties @@ -160,32 +177,33 @@ * **userAccessMode**: 'Open' | 'Restricted' | string: Lab user access mode (open to all vs. restricted to those listed on the lab). * **userQuota**: int (ReadOnly): Maximum value MaxUsersInLab can be set to, as specified by the service -## ResourceTags +## LatestOperationResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errorCode**: string (ReadOnly): Error code on failure. +* **errorMessage**: string (ReadOnly): The error message. +* **httpMethod**: string (ReadOnly): The HttpMethod - PUT/POST/DELETE for the operation. +* **operationUrl**: string (ReadOnly): The URL to use to check long-running operation status +* **requestUri**: string (ReadOnly): Request URI of the operation. +* **status**: string (ReadOnly): The current status of the operation. -## EnvironmentSettingProperties +## ListEnvironmentsPayload ### Properties -* **configurationState**: 'Completed' | 'NotApplicable' | string: Describes the user's progress in configuring their environment setting -* **description**: string: Describes the environment and its resource settings -* **lastChanged**: string (ReadOnly): Time when the template VM was last changed. -* **lastPublished**: string (ReadOnly): Time when the template VM was last sent for publishing. -* **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. -* **provisioningState**: string: The provisioning status of the resource. -* **publishingState**: 'Draft' | 'PublishFailed' | 'Published' | 'Publishing' | 'Scaling' | string (ReadOnly): Describes the readiness of this environment setting -* **resourceSettings**: [ResourceSettings](#resourcesettings) (Required): Represents resource specific settings -* **title**: string: Brief title describing the environment and its resource settings -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +* **labId**: string (WriteOnly): The resource Id of the lab -## ResourceSettings +## ListEnvironmentsResponse ### Properties -* **cores**: int (ReadOnly): The translated compute cores of the virtual machine -* **galleryImageResourceId**: string: The resource id of the gallery image used for creating the virtual machine -* **id**: string (ReadOnly): The unique id of the resource setting -* **imageName**: string (ReadOnly): The name of the image used to created the environment setting -* **referenceVm**: [ReferenceVm](#referencevm) (Required): Details of a Reference Vm -* **size**: 'Basic' | 'Performance' | 'Standard' | string: The size category +* **environments**: [EnvironmentDetails](#environmentdetails)[] (ReadOnly): List of all the environments + +## ListLabsResponse +### Properties +* **labs**: [LabDetails](#labdetails)[] (ReadOnly): List of all the labs + +## NetworkInterface +### Properties +* **privateIpAddress**: string (ReadOnly): PrivateIp address of the Compute VM +* **rdpAuthority**: string (ReadOnly): Connection information for Windows +* **sshAuthority**: string (ReadOnly): Connection information for Linux +* **username**: string (ReadOnly): Username of the VM ## ReferenceVm ### Properties @@ -194,85 +212,71 @@ * **vmResourceId**: string (ReadOnly): VM resource Id for the environment * **vmStateDetails**: [VmStateDetails](#vmstatedetails) (ReadOnly): Details about the state of the reference virtual machine. -## VmStateDetails +## ResourceSet ### Properties -* **lastKnownPowerState**: string (ReadOnly): Last known compute power state captured in DTL -* **powerState**: string (ReadOnly): The power state of the reference virtual machine. -* **rdpAuthority**: string (ReadOnly): The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). -* **sshAuthority**: string (ReadOnly): The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. +* **resourceSettingId**: string: resourceSettingId for the environment +* **vmResourceId**: string: VM resource Id for the environment + +## ResourceSettings +### Properties +* **cores**: int (ReadOnly): The translated compute cores of the virtual machine +* **galleryImageResourceId**: string: The resource id of the gallery image used for creating the virtual machine +* **id**: string (ReadOnly): The unique id of the resource setting +* **imageName**: string (ReadOnly): The name of the image used to created the environment setting +* **referenceVm**: [ReferenceVm](#referencevm) (Required): Details of a Reference Vm +* **size**: 'Basic' | 'Performance' | 'Standard' | string: The size category ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EnvironmentProperties -### Properties -* **claimedByUserName**: string (ReadOnly): The name or email address of the user who has claimed the environment -* **claimedByUserObjectId**: string (ReadOnly): The AAD object Id of the user who has claimed the environment -* **claimedByUserPrincipalId**: string (ReadOnly): The user principal Id of the user who has claimed the environment -* **isClaimed**: bool (ReadOnly): Is the environment claimed or not -* **lastKnownPowerState**: string (ReadOnly): Last known power state of the environment -* **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. -* **networkInterface**: [NetworkInterface](#networkinterface) (ReadOnly): Network details of the environment -* **passwordLastReset**: string (ReadOnly): When the password was last reset on the environment. -* **provisioningState**: string: The provisioning status of the resource. -* **resourceSets**: [ResourceSet](#resourceset): Represents a VM and the setting Id it was created for. -* **totalUsage**: string (ReadOnly): How long the environment has been used by a lab user -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). - -## NetworkInterface +## ResourceTags ### Properties -* **privateIpAddress**: string (ReadOnly): PrivateIp address of the Compute VM -* **rdpAuthority**: string (ReadOnly): Connection information for Windows -* **sshAuthority**: string (ReadOnly): Connection information for Linux -* **username**: string (ReadOnly): Username of the VM +### Additional Properties +* **Additional Properties Type**: string -## ResourceSet +## ResourceTags ### Properties -* **resourceSettingId**: string: resourceSettingId for the environment -* **vmResourceId**: string: VM resource Id for the environment +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## UserProperties +## ResourceTags ### Properties -* **email**: string (ReadOnly): The user email address, as it was specified during registration. -* **familyName**: string (ReadOnly): The user family name, as it was specified during registration. -* **givenName**: string (ReadOnly): The user given name, as it was specified during registration. -* **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. -* **provisioningState**: string: The provisioning status of the resource. -* **tenantId**: string (ReadOnly): The user tenant ID, as it was specified during registration. -* **totalUsage**: string (ReadOnly): How long the user has used his VMs in this lab -* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ListEnvironmentsPayload +## SizeConfigurationProperties ### Properties -* **labId**: string (WriteOnly): The resource Id of the lab +* **environmentSizes**: [EnvironmentSize](#environmentsize)[]: Represents a list of size categories supported by this Lab Account (Small, Medium, Large) -## ListEnvironmentsResponse +## SizeInfo ### Properties -* **environments**: [EnvironmentDetails](#environmentdetails)[] (ReadOnly): List of all the environments +* **computeSize**: string: Represents the actual compute size, e.g. Standard_A2_v2. +* **memory**: int: The amount of memory available (in GB). +* **numberOfCores**: int: The number of cores a VM of this size has. +* **price**: int: The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. -## EnvironmentDetails +## UserProperties ### Properties -* **description**: string (ReadOnly): Description of the Environment -* **environmentState**: string (ReadOnly): Publishing state of the environment setting Possible values are Creating, Created, Failed -* **id**: string (ReadOnly): Resource Id of the environment +* **email**: string (ReadOnly): The user email address, as it was specified during registration. +* **familyName**: string (ReadOnly): The user family name, as it was specified during registration. +* **givenName**: string (ReadOnly): The user given name, as it was specified during registration. * **latestOperationResult**: [LatestOperationResult](#latestoperationresult) (ReadOnly): Details of the status of an operation. -* **name**: string (ReadOnly): Name of the Environment -* **passwordLastReset**: string (ReadOnly): When the password was last reset on the environment. -* **provisioningState**: string (ReadOnly): The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status. -* **totalUsage**: string (ReadOnly): How long the environment has been used by a lab user -* **virtualMachineDetails**: [VirtualMachineDetails](#virtualmachinedetails) (ReadOnly): Details of the backing virtual machine. +* **provisioningState**: string: The provisioning status of the resource. +* **tenantId**: string (ReadOnly): The user tenant ID, as it was specified during registration. +* **totalUsage**: string (ReadOnly): How long the user has used his VMs in this lab +* **uniqueIdentifier**: string: The unique immutable identifier of a resource (Guid). ## VirtualMachineDetails ### Properties @@ -283,14 +287,10 @@ * **sshAuthority**: string (ReadOnly): Connection information for Linux * **userName**: string (ReadOnly): Compute VM login user name -## ListLabsResponse -### Properties -* **labs**: [LabDetails](#labdetails)[] (ReadOnly): List of all the labs - -## LabDetails +## VmStateDetails ### Properties -* **id**: string (ReadOnly): The Id of the lab. -* **name**: string (ReadOnly): Name of the lab -* **provisioningState**: string (ReadOnly): The provisioning state of the lab. -* **usageQuota**: string (ReadOnly): The maximum duration a user can use a VM in this lab. +* **lastKnownPowerState**: string (ReadOnly): Last known compute power state captured in DTL +* **powerState**: string (ReadOnly): The power state of the reference virtual machine. +* **rdpAuthority**: string (ReadOnly): The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). +* **sshAuthority**: string (ReadOnly): The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. diff --git a/generated/labservices/microsoft.labservices/2021-10-01-preview/types.md b/generated/labservices/microsoft.labservices/2021-10-01-preview/types.md index 89736a6bd1..2b7c28cb6e 100644 --- a/generated/labservices/microsoft.labservices/2021-10-01-preview/types.md +++ b/generated/labservices/microsoft.labservices/2021-10-01-preview/types.md @@ -54,17 +54,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.LabServices/labs/users' (ReadOnly, DeployTimeConstant): The resource type -## LabPlanProperties -### Properties -* **allowedRegions**: string[]: The allowed regions for the lab creator to use when creating labs using this lab plan. -* **defaultAutoShutdownProfile**: [AutoShutdownProfile](#autoshutdownprofile): Profile for how to handle shutting down virtual machines. -* **defaultConnectionProfile**: [ConnectionProfile](#connectionprofile): Connection profile for how users connect to lab virtual machines. -* **defaultNetworkProfile**: [LabPlanNetworkProfile](#labplannetworkprofile): Profile for how to handle networking for Lab Plans. -* **linkedLmsInstance**: string: A URL. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. -* **sharedGalleryId**: string: A URL. -* **supportInfo**: [SupportInfo](#supportinfo): Support contact information and instructions. - ## AutoShutdownProfile ### Properties * **disconnectDelay**: string: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. @@ -81,30 +70,10 @@ * **webRdpAccess**: 'None' | 'Private' | 'Public': A connection type for access labs and VMs (Public, Private or None). * **webSshAccess**: 'None' | 'Private' | 'Public': A connection type for access labs and VMs (Public, Private or None). -## LabPlanNetworkProfile -### Properties -* **subnetId**: string: A URL. - -## SupportInfo -### Properties -* **email**: string: An email address. -* **instructions**: string: Support instructions. -* **phone**: string: A phone number. -* **url**: string: A URL. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## Credentials ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: string (WriteOnly): The password for the user. This is required for the TemplateVM createOption. +* **username**: string (Required): The username to use when signing in to lab VMs. ## ImageProperties ### Properties @@ -125,6 +94,36 @@ * **termsStatus**: 'Disabled' | 'Enabled' (ReadOnly): Property enabled state. * **version**: string (ReadOnly): The image version. +## ImageReference +### Properties +* **exactVersion**: string (ReadOnly): The actual version of the image after use. +* **id**: string: A URL. +* **offer**: string: The image offer if applicable. +* **publisher**: string: The image publisher +* **sku**: string: The image SKU +* **version**: string: The image version specified on creation. + +## LabNetworkProfile +### Properties +* **loadBalancerId**: string: A URL. +* **publicIpId**: string: A URL. +* **subnetId**: string: A URL. + +## LabPlanNetworkProfile +### Properties +* **subnetId**: string: A URL. + +## LabPlanProperties +### Properties +* **allowedRegions**: string[]: The allowed regions for the lab creator to use when creating labs using this lab plan. +* **defaultAutoShutdownProfile**: [AutoShutdownProfile](#autoshutdownprofile): Profile for how to handle shutting down virtual machines. +* **defaultConnectionProfile**: [ConnectionProfile](#connectionprofile): Connection profile for how users connect to lab virtual machines. +* **defaultNetworkProfile**: [LabPlanNetworkProfile](#labplannetworkprofile): Profile for how to handle networking for Lab Plans. +* **linkedLmsInstance**: string: A URL. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. +* **sharedGalleryId**: string: A URL. +* **supportInfo**: [SupportInfo](#supportinfo): Support contact information and instructions. + ## LabProperties ### Properties * **autoShutdownProfile**: [AutoShutdownProfile](#autoshutdownprofile): Profile for how to handle shutting down virtual machines. @@ -139,11 +138,12 @@ * **title**: string: The title of the lab. * **virtualMachineProfile**: [VirtualMachineProfile](#virtualmachineprofile): The base virtual machine configuration for a lab. -## LabNetworkProfile +## RecurrencePattern ### Properties -* **loadBalancerId**: string: A URL. -* **publicIpId**: string: A URL. -* **subnetId**: string: A URL. +* **expirationDate**: string (Required): When the recurrence will expire. This date is inclusive. +* **frequency**: 'Daily' | 'Weekly' (Required): Schedule recurrence frequencies. +* **interval**: int: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The week days the schedule runs. Used for when the Frequency is set to Weekly. ## RosterProfile ### Properties @@ -153,41 +153,20 @@ * **ltiContextId**: string: The unique context identifier for the lab in the lms. * **ltiRosterEndpoint**: string: The uri of the names and roles service endpoint on the lms for the class attached to this lab. +## ScheduleProperties +### Properties +* **notes**: string: Notes for this schedule. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. +* **recurrencePattern**: [RecurrencePattern](#recurrencepattern): Recurrence pattern of a lab schedule. +* **startAt**: string: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. +* **stopAt**: string: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. +* **timeZoneId**: string: The IANA timezone id for the schedule. + ## SecurityProfile ### Properties * **openAccess**: 'Disabled' | 'Enabled': Property enabled state. * **registrationCode**: string (ReadOnly): The registration code for the lab. -## VirtualMachineProfile -### Properties -* **additionalCapabilities**: [VirtualMachineAdditionalCapabilities](#virtualmachineadditionalcapabilities): The additional capabilities for a lab VM. -* **adminUser**: [Credentials](#credentials) (Required): Credentials for a user on a lab VM. -* **createOption**: 'Image' | 'TemplateVM' (Required): Indicates what lab virtual machines are created from. -* **imageReference**: [ImageReference](#imagereference) (Required): Image reference information. Used in the virtual machine profile. -* **nonAdminUser**: [Credentials](#credentials): Credentials for a user on a lab VM. -* **osType**: 'Linux' | 'Windows' (ReadOnly): The operating system type. -* **sku**: [Sku](#sku) (Required): The resource model definition representing SKU -* **usageQuota**: string (Required): The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. -* **useSharedPassword**: 'Disabled' | 'Enabled': Property enabled state. - -## VirtualMachineAdditionalCapabilities -### Properties -* **installGpuDrivers**: 'Disabled' | 'Enabled': Property enabled state. - -## Credentials -### Properties -* **password**: string (WriteOnly): The password for the user. This is required for the TemplateVM createOption. -* **username**: string (Required): The username to use when signing in to lab VMs. - -## ImageReference -### Properties -* **exactVersion**: string (ReadOnly): The actual version of the image after use. -* **id**: string: A URL. -* **offer**: string: The image offer if applicable. -* **publisher**: string: The image publisher -* **sku**: string: The image SKU -* **version**: string: The image version specified on creation. - ## Sku ### Properties * **capacity**: int: 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. @@ -196,26 +175,31 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. +## SupportInfo +### Properties +* **email**: string: An email address. +* **instructions**: string: Support instructions. +* **phone**: string: A phone number. +* **url**: string: A URL. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ScheduleProperties -### Properties -* **notes**: string: Notes for this schedule. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. -* **recurrencePattern**: [RecurrencePattern](#recurrencepattern): Recurrence pattern of a lab schedule. -* **startAt**: string: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. -* **stopAt**: string: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. -* **timeZoneId**: string: The IANA timezone id for the schedule. - -## RecurrencePattern +## TrackedResourceTags ### Properties -* **expirationDate**: string (Required): When the recurrence will expire. This date is inclusive. -* **frequency**: 'Daily' | 'Weekly' (Required): Schedule recurrence frequencies. -* **interval**: int: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The week days the schedule runs. Used for when the Frequency is set to Weekly. +### Additional Properties +* **Additional Properties Type**: string ## UserProperties ### Properties @@ -228,3 +212,19 @@ * **registrationState**: 'NotRegistered' | 'Registered' (ReadOnly): The user lab registration state. * **totalUsage**: string (ReadOnly): How long the user has used their virtual machines in this lab. +## VirtualMachineAdditionalCapabilities +### Properties +* **installGpuDrivers**: 'Disabled' | 'Enabled': Property enabled state. + +## VirtualMachineProfile +### Properties +* **additionalCapabilities**: [VirtualMachineAdditionalCapabilities](#virtualmachineadditionalcapabilities): The additional capabilities for a lab VM. +* **adminUser**: [Credentials](#credentials) (Required): Credentials for a user on a lab VM. +* **createOption**: 'Image' | 'TemplateVM' (Required): Indicates what lab virtual machines are created from. +* **imageReference**: [ImageReference](#imagereference) (Required): Image reference information. Used in the virtual machine profile. +* **nonAdminUser**: [Credentials](#credentials): Credentials for a user on a lab VM. +* **osType**: 'Linux' | 'Windows' (ReadOnly): The operating system type. +* **sku**: [Sku](#sku) (Required): The resource model definition representing SKU +* **usageQuota**: string (Required): The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. +* **useSharedPassword**: 'Disabled' | 'Enabled': Property enabled state. + diff --git a/generated/labservices/microsoft.labservices/2021-11-15-preview/types.md b/generated/labservices/microsoft.labservices/2021-11-15-preview/types.md index b446c627c6..be3beff863 100644 --- a/generated/labservices/microsoft.labservices/2021-11-15-preview/types.md +++ b/generated/labservices/microsoft.labservices/2021-11-15-preview/types.md @@ -54,17 +54,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.LabServices/labs/users' (ReadOnly, DeployTimeConstant): The resource type -## LabPlanProperties -### Properties -* **allowedRegions**: string[]: The allowed regions for the lab creator to use when creating labs using this lab plan. -* **defaultAutoShutdownProfile**: [AutoShutdownProfile](#autoshutdownprofile): Profile for how to handle shutting down virtual machines. -* **defaultConnectionProfile**: [ConnectionProfile](#connectionprofile): Connection profile for how users connect to lab virtual machines. -* **defaultNetworkProfile**: [LabPlanNetworkProfile](#labplannetworkprofile): Profile for how to handle networking for Lab Plans. -* **linkedLmsInstance**: string: A URL. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. -* **sharedGalleryId**: string: A URL. -* **supportInfo**: [SupportInfo](#supportinfo): Support contact information and instructions. - ## AutoShutdownProfile ### Properties * **disconnectDelay**: string: The amount of time a VM will stay running after a user disconnects if this behavior is enabled. @@ -81,30 +70,10 @@ * **webRdpAccess**: 'None' | 'Private' | 'Public': A connection type for access labs and VMs (Public, Private or None). * **webSshAccess**: 'None' | 'Private' | 'Public': A connection type for access labs and VMs (Public, Private or None). -## LabPlanNetworkProfile -### Properties -* **subnetId**: string: A URL. - -## SupportInfo -### Properties -* **email**: string: An email address. -* **instructions**: string: Support instructions. -* **phone**: string: A phone number. -* **url**: string: A URL. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## Credentials ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: string (WriteOnly): The password for the user. This is required for the TemplateVM createOption. +* **username**: string (Required): The username to use when signing in to lab VMs. ## ImageProperties ### Properties @@ -125,6 +94,36 @@ * **termsStatus**: 'Disabled' | 'Enabled' (ReadOnly): Property enabled state. * **version**: string (ReadOnly): The image version. +## ImageReference +### Properties +* **exactVersion**: string (ReadOnly): The actual version of the image after use. +* **id**: string: A URL. +* **offer**: string: The image offer if applicable. +* **publisher**: string: The image publisher +* **sku**: string: The image SKU +* **version**: string: The image version specified on creation. + +## LabNetworkProfile +### Properties +* **loadBalancerId**: string: A URL. +* **publicIpId**: string: A URL. +* **subnetId**: string: A URL. + +## LabPlanNetworkProfile +### Properties +* **subnetId**: string: A URL. + +## LabPlanProperties +### Properties +* **allowedRegions**: string[]: The allowed regions for the lab creator to use when creating labs using this lab plan. +* **defaultAutoShutdownProfile**: [AutoShutdownProfile](#autoshutdownprofile): Profile for how to handle shutting down virtual machines. +* **defaultConnectionProfile**: [ConnectionProfile](#connectionprofile): Connection profile for how users connect to lab virtual machines. +* **defaultNetworkProfile**: [LabPlanNetworkProfile](#labplannetworkprofile): Profile for how to handle networking for Lab Plans. +* **linkedLmsInstance**: string: A URL. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. +* **sharedGalleryId**: string: A URL. +* **supportInfo**: [SupportInfo](#supportinfo): Support contact information and instructions. + ## LabProperties ### Properties * **autoShutdownProfile**: [AutoShutdownProfile](#autoshutdownprofile): Profile for how to handle shutting down virtual machines. @@ -139,11 +138,12 @@ * **title**: string: The title of the lab. * **virtualMachineProfile**: [VirtualMachineProfile](#virtualmachineprofile): The base virtual machine configuration for a lab. -## LabNetworkProfile +## RecurrencePattern ### Properties -* **loadBalancerId**: string: A URL. -* **publicIpId**: string: A URL. -* **subnetId**: string: A URL. +* **expirationDate**: string (Required): When the recurrence will expire. This date is inclusive. +* **frequency**: 'Daily' | 'Weekly' (Required): Schedule recurrence frequencies. +* **interval**: int: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The week days the schedule runs. Used for when the Frequency is set to Weekly. ## RosterProfile ### Properties @@ -153,41 +153,20 @@ * **ltiContextId**: string: The unique context identifier for the lab in the lms. * **ltiRosterEndpoint**: string: The uri of the names and roles service endpoint on the lms for the class attached to this lab. +## ScheduleProperties +### Properties +* **notes**: string: Notes for this schedule. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. +* **recurrencePattern**: [RecurrencePattern](#recurrencepattern): Recurrence pattern of a lab schedule. +* **startAt**: string: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. +* **stopAt**: string: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. +* **timeZoneId**: string: The IANA timezone id for the schedule. + ## SecurityProfile ### Properties * **openAccess**: 'Disabled' | 'Enabled': Property enabled state. * **registrationCode**: string (ReadOnly): The registration code for the lab. -## VirtualMachineProfile -### Properties -* **additionalCapabilities**: [VirtualMachineAdditionalCapabilities](#virtualmachineadditionalcapabilities): The additional capabilities for a lab VM. -* **adminUser**: [Credentials](#credentials) (Required): Credentials for a user on a lab VM. -* **createOption**: 'Image' | 'TemplateVM' (Required): Indicates what lab virtual machines are created from. -* **imageReference**: [ImageReference](#imagereference) (Required): Image reference information. Used in the virtual machine profile. -* **nonAdminUser**: [Credentials](#credentials): Credentials for a user on a lab VM. -* **osType**: 'Linux' | 'Windows' (ReadOnly): The operating system type. -* **sku**: [Sku](#sku) (Required): The resource model definition representing SKU -* **usageQuota**: string (Required): The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. -* **useSharedPassword**: 'Disabled' | 'Enabled': Property enabled state. - -## VirtualMachineAdditionalCapabilities -### Properties -* **installGpuDrivers**: 'Disabled' | 'Enabled': Property enabled state. - -## Credentials -### Properties -* **password**: string (WriteOnly): The password for the user. This is required for the TemplateVM createOption. -* **username**: string (Required): The username to use when signing in to lab VMs. - -## ImageReference -### Properties -* **exactVersion**: string (ReadOnly): The actual version of the image after use. -* **id**: string: A URL. -* **offer**: string: The image offer if applicable. -* **publisher**: string: The image publisher -* **sku**: string: The image SKU -* **version**: string: The image version specified on creation. - ## Sku ### Properties * **capacity**: int: 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. @@ -196,26 +175,31 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. +## SupportInfo +### Properties +* **email**: string: An email address. +* **instructions**: string: Support instructions. +* **phone**: string: A phone number. +* **url**: string: A URL. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ScheduleProperties -### Properties -* **notes**: string: Notes for this schedule. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Locked' | 'Succeeded' | 'Updating' (ReadOnly): Resource provisioning state. -* **recurrencePattern**: [RecurrencePattern](#recurrencepattern): Recurrence pattern of a lab schedule. -* **startAt**: string: When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead. -* **stopAt**: string: When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead. -* **timeZoneId**: string: The IANA timezone id for the schedule. - -## RecurrencePattern +## TrackedResourceTags ### Properties -* **expirationDate**: string (Required): When the recurrence will expire. This date is inclusive. -* **frequency**: 'Daily' | 'Weekly' (Required): Schedule recurrence frequencies. -* **interval**: int: The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The week days the schedule runs. Used for when the Frequency is set to Weekly. +### Additional Properties +* **Additional Properties Type**: string ## UserProperties ### Properties @@ -228,3 +212,19 @@ * **registrationState**: 'NotRegistered' | 'Registered' (ReadOnly): The user lab registration state. * **totalUsage**: string (ReadOnly): How long the user has used their virtual machines in this lab. +## VirtualMachineAdditionalCapabilities +### Properties +* **installGpuDrivers**: 'Disabled' | 'Enabled': Property enabled state. + +## VirtualMachineProfile +### Properties +* **additionalCapabilities**: [VirtualMachineAdditionalCapabilities](#virtualmachineadditionalcapabilities): The additional capabilities for a lab VM. +* **adminUser**: [Credentials](#credentials) (Required): Credentials for a user on a lab VM. +* **createOption**: 'Image' | 'TemplateVM' (Required): Indicates what lab virtual machines are created from. +* **imageReference**: [ImageReference](#imagereference) (Required): Image reference information. Used in the virtual machine profile. +* **nonAdminUser**: [Credentials](#credentials): Credentials for a user on a lab VM. +* **osType**: 'Linux' | 'Windows' (ReadOnly): The operating system type. +* **sku**: [Sku](#sku) (Required): The resource model definition representing SKU +* **usageQuota**: string (Required): The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. +* **useSharedPassword**: 'Disabled' | 'Enabled': Property enabled state. + diff --git a/generated/loadtestservice/log.out b/generated/loadtestservice/log.out index 9bfb0c8951..47e6a75182 100644 --- a/generated/loadtestservice/log.out +++ b/generated/loadtestservice/log.out @@ -3,17 +3,17 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.loadtestservice-2022-04-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.loadtestservice-2021-12-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 5.99s. 4 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 5.68s. 4 files generated. diff --git a/generated/loadtestservice/microsoft.loadtestservice/2021-12-01-preview/types.md b/generated/loadtestservice/microsoft.loadtestservice/2021-12-01-preview/types.md index a26ed3ac77..42fe3b57c8 100644 --- a/generated/loadtestservice/microsoft.loadtestservice/2021-12-01-preview/types.md +++ b/generated/loadtestservice/microsoft.loadtestservice/2021-12-01-preview/types.md @@ -13,18 +13,18 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.LoadTestService/loadTests' (ReadOnly, DeployTimeConstant): The resource type -## SystemAssignedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | string (Required): Type of managed service identity (either system assigned, or none). - ## LoadTestProperties ### Properties * **dataPlaneURI**: string (ReadOnly): Resource data plane URI. * **description**: string: Description of the resource. * **provisioningState**: 'Canceled' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Load Test resources provisioning states. +## SystemAssignedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | string (Required): Type of managed service identity (either system assigned, or none). + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/loadtestservice/microsoft.loadtestservice/2022-04-15-preview/types.md b/generated/loadtestservice/microsoft.loadtestservice/2022-04-15-preview/types.md index 808837e511..851e725030 100644 --- a/generated/loadtestservice/microsoft.loadtestservice/2022-04-15-preview/types.md +++ b/generated/loadtestservice/microsoft.loadtestservice/2022-04-15-preview/types.md @@ -13,22 +13,15 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.LoadTestService/loadTests' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities +## EncryptionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **identity**: [EncryptionPropertiesIdentity](#encryptionpropertiesidentity): All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. +* **keyUrl**: string: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. -## UserAssignedIdentity +## EncryptionPropertiesIdentity ### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. +* **resourceId**: string: user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId +* **type**: 'SystemAssigned' | 'UserAssigned' | string: Managed identity type to use for accessing encryption key Url ## LoadTestProperties ### Properties @@ -37,15 +30,12 @@ * **encryption**: [EncryptionProperties](#encryptionproperties): Key and identity details for Customer Managed Key encryption of load test resource * **provisioningState**: 'Canceled' | 'Deleted' | 'Failed' | 'Succeeded' | string (ReadOnly): Load Test resources provisioning states. -## EncryptionProperties -### Properties -* **identity**: [EncryptionPropertiesIdentity](#encryptionpropertiesidentity): All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. -* **keyUrl**: string: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. - -## EncryptionPropertiesIdentity +## ManagedServiceIdentity ### Properties -* **resourceId**: string: user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId -* **type**: 'SystemAssigned' | 'UserAssigned' | string: Managed identity type to use for accessing encryption key Url +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ## SystemData ### Properties @@ -61,3 +51,13 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. + diff --git a/generated/logic/log.out b/generated/logic/log.out index 5128b08594..c71632fe0b 100644 --- a/generated/logic/log.out +++ b/generated/logic/log.out @@ -6,13 +6,13 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.logic-2019-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/logic/resource-manager/Microsoft.Logic/stable/2019-05-01/logic.json:6408:5 @@ -46,13 +46,13 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 38ms +info | autorest.bicep took 39ms info | Processing batch task - {"tag":"microsoft.logic-2018-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json:5169:5 @@ -86,13 +86,13 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 26ms +info | autorest.bicep took 36ms info | Processing batch task - {"tag":"microsoft.logic-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json:5419:5 @@ -126,13 +126,13 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 21ms +info | autorest.bicep took 28ms info | Processing batch task - {"tag":"microsoft.logic-2015-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'IntegrationAccountResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json:1351:5 @@ -146,13 +146,13 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 17ms +info | autorest.bicep took 18ms info | Processing batch task - {"tag":"microsoft.logic-2015-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/logic/resource-manager/Microsoft.Logic/preview/2015-02-01-preview/logic.json:1352:5 @@ -163,5 +163,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms -info | Autorest completed in 32.53s. 10 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 31.6s. 10 files generated. diff --git a/generated/logic/microsoft.logic/2015-02-01-preview/types.md b/generated/logic/microsoft.logic/2015-02-01-preview/types.md index 086592b8b6..1baeee8d7d 100644 --- a/generated/logic/microsoft.logic/2015-02-01-preview/types.md +++ b/generated/logic/microsoft.logic/2015-02-01-preview/types.md @@ -25,19 +25,10 @@ * **ApiVersion**: 2015-02-01-preview * **Output**: [WorkflowSecretKeys](#workflowsecretkeys) -## WorkflowProperties +## ContentHash ### Properties -* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. -* **changedTime**: string (ReadOnly): Gets the changed time. -* **createdTime**: string (ReadOnly): Gets the created time. -* **definition**: any: Any object -* **definitionLink**: [ContentLink](#contentlink) -* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): Gets or sets the parameters. -* **parametersLink**: [ContentLink](#contentlink) -* **provisioningState**: 'Moving' | 'NotSpecified' | 'Succeeded' (ReadOnly) -* **sku**: [Sku](#sku) -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' -* **version**: string (ReadOnly): Gets the version. +* **algorithm**: string: Gets or sets the algorithm. +* **value**: string: Gets or sets the value. ## ContentLink ### Properties @@ -47,27 +38,6 @@ * **metadata**: any: Any object * **uri**: string: Gets or sets the content link URI. -## ContentHash -### Properties -* **algorithm**: string: Gets or sets the algorithm. -* **value**: string: Gets or sets the value. - -## WorkflowPropertiesParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) - -## WorkflowParameter -### Properties -* **metadata**: any: Any object -* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'NotSpecified' | 'Object' | 'SecureObject' | 'SecureString' | 'String' -* **value**: any: Any object - -## Sku -### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' -* **plan**: [ResourceReference](#resourcereference) - ## ResourceReference ### Properties * **id**: string: Gets or sets the resource id. @@ -79,11 +49,41 @@ ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' +* **plan**: [ResourceReference](#resourcereference) + ## WorkflowAccessKeyProperties ### Properties * **notAfter**: string: Gets or sets the not-after time. * **notBefore**: string: Gets or sets the not-before time. +## WorkflowParameter +### Properties +* **metadata**: any: Any object +* **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'NotSpecified' | 'Object' | 'SecureObject' | 'SecureString' | 'String' +* **value**: any: Any object + +## WorkflowProperties +### Properties +* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. +* **changedTime**: string (ReadOnly): Gets the changed time. +* **createdTime**: string (ReadOnly): Gets the created time. +* **definition**: any: Any object +* **definitionLink**: [ContentLink](#contentlink) +* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): Gets or sets the parameters. +* **parametersLink**: [ContentLink](#contentlink) +* **provisioningState**: 'Moving' | 'NotSpecified' | 'Succeeded' (ReadOnly) +* **sku**: [Sku](#sku) +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' +* **version**: string (ReadOnly): Gets the version. + +## WorkflowPropertiesParameters +### Properties +### Additional Properties +* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) + ## WorkflowSecretKeys ### Properties * **primarySecretKey**: string (ReadOnly): Gets the primary secret key. diff --git a/generated/logic/microsoft.logic/2015-08-01-preview/types.md b/generated/logic/microsoft.logic/2015-08-01-preview/types.md index 4a6d0d6b25..b42030a452 100644 --- a/generated/logic/microsoft.logic/2015-08-01-preview/types.md +++ b/generated/logic/microsoft.logic/2015-08-01-preview/types.md @@ -73,54 +73,12 @@ * **Input**: [ListCallbackUrlParameters](#listcallbackurlparameters) * **Output**: [CallbackUrl](#callbackurl) -## IntegrationAccountSku -### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' - -## IntegrationAccountResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountAgreementProperties -### Properties -* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [AgreementContent](#agreementcontent) -* **createdTime**: string (ReadOnly): The created time. -* **guestIdentity**: [BusinessIdentity](#businessidentity) -* **guestPartner**: string: The guest partner. -* **hostIdentity**: [BusinessIdentity](#businessidentity) -* **hostPartner**: string: The host partner. -* **metadata**: any: Any object - ## AgreementContent ### Properties * **AS2**: [AS2AgreementContent](#as2agreementcontent) * **Edifact**: [EdifactAgreementContent](#edifactagreementcontent) * **X12**: [X12AgreementContent](#x12agreementcontent) -## AS2AgreementContent -### Properties -* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) -* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) - -## AS2OneWayAgreement -### Properties -* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) - -## AS2ProtocolSettings -### Properties -* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) -* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) -* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) -* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) -* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) -* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) -* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) - ## AS2AcknowledgementConnectionSettings ### Properties * **ignoreCertificateNameMismatch**: bool: The value indicating whether to ignore mismatch in certificate name. @@ -128,6 +86,11 @@ * **supportHttpStatusCodeContinue**: bool: The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool: The value indicating whether to unfold the HTTP headers. +## AS2AgreementContent +### Properties +* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) +* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) + ## AS2EnvelopeSettings ### Properties * **AutogenerateFileName**: bool: The value indicating whether to auto generate file name. @@ -160,6 +123,22 @@ * **supportHttpStatusCodeContinue**: bool: The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool: The value indicating whether to unfold the HTTP headers. +## AS2OneWayAgreement +### Properties +* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) + +## AS2ProtocolSettings +### Properties +* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) +* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) +* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) +* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) +* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) +* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) +* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) + ## AS2SecuritySettings ### Properties * **enableNrrForInboundDecodedMessages**: bool: The value indicating whether to enable NRR for inbound decoded messages. @@ -184,35 +163,18 @@ * **overrideMessageProperties**: bool: The value indicating whether to override incoming message properties with those in agreement. * **signMessage**: bool: The value indicating whether the message has to be signed. +## B2BPartnerContent +### Properties +* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. + ## BusinessIdentity ### Properties * **Qualifier**: string: The business identity qualifier. * **Value**: string: The business identity value. -## EdifactAgreementContent -### Properties -* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) -* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) - -## EdifactOneWayAgreement -### Properties -* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) - -## EdifactProtocolSettings +## CallbackUrl ### Properties -* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) -* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. -* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. -* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) -* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) -* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) -* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. -* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) -* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[]: The EDIFACT schema references. -* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. -* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) +* **value**: string (ReadOnly): The URL value. ## EdifactAcknowledgementSettings ### Properties @@ -228,6 +190,11 @@ * **rolloverAcknowledgementControlNumber**: bool: The value indicating whether to rollover acknowledgement control number. * **sendSynchronousAcknowledgement**: bool: The value indicating whether to send synchronous acknowledgement. +## EdifactAgreementContent +### Properties +* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) +* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) + ## EdifactDelimiterOverride ### Properties * **componentSeparator**: int: The component separator. @@ -327,6 +294,12 @@ ### Properties * **messageId**: string: The message id on which this envelope settings has to be applied. +## EdifactOneWayAgreement +### Properties +* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) + ## EdifactProcessingSettings ### Properties * **createEmptyXmlTagsForTrailingSeparators**: bool: The value indicating whether to create empty xml tags for trailing separators. @@ -335,6 +308,20 @@ * **suspendInterchangeOnError**: bool: The value indicating whether to suspend interchange on error. * **useDotAsDecimalSeparator**: bool: The value indicating whether to use dot as decimal separator. +## EdifactProtocolSettings +### Properties +* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) +* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. +* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. +* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) +* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) +* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) +* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. +* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) +* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[]: The EDIFACT schema references. +* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. +* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) + ## EdifactSchemaReference ### Properties * **associationAssignedCode**: string: The association assigned code. @@ -368,31 +355,121 @@ * **validateEDITypes**: bool: The value indicating whether to Whether to validate EDI types. * **validateXSDTypes**: bool: The value indicating whether to Whether to validate XSD types. -## X12AgreementContent +## IntegrationAccountAgreementProperties ### Properties -* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) -* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) +* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [AgreementContent](#agreementcontent) +* **createdTime**: string (ReadOnly): The created time. +* **guestIdentity**: [BusinessIdentity](#businessidentity) +* **guestPartner**: string: The guest partner. +* **hostIdentity**: [BusinessIdentity](#businessidentity) +* **hostPartner**: string: The host partner. +* **metadata**: any: Any object -## X12OneWayAgreement +## IntegrationAccountCertificateProperties ### Properties -* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) +* **changedTime**: string (ReadOnly): The changed time. +* **createdTime**: string (ReadOnly): The created time. +* **key**: [KeyVaultKeyReference](#keyvaultkeyreference) +* **metadata**: any: Any object +* **publicCertificate**: string: The public certificate. -## X12ProtocolSettings +## IntegrationAccountContentHash ### Properties -* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) -* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. -* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) -* **framingSettings**: [X12FramingSettings](#x12framingsettings) -* **messageFilter**: [X12MessageFilter](#x12messagefilter) -* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. -* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) -* **schemaReferences**: [X12SchemaReference](#x12schemareference)[]: The X12 schema references. -* **securitySettings**: [X12SecuritySettings](#x12securitysettings) -* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. -* **validationSettings**: [X12ValidationSettings](#x12validationsettings) -* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. +* **algorithm**: string: The content hash algorithm. +* **value**: string: The content hash value. + +## IntegrationAccountContentLink +### Properties +* **contentHash**: [IntegrationAccountContentHash](#integrationaccountcontenthash) +* **contentSize**: int: The content size. +* **contentVersion**: string: The content version. +* **metadata**: any: Any object +* **uri**: string: The content link URI. + +## IntegrationAccountMapProperties +### Properties +* **changedTime**: string (ReadOnly): The changed time. +* **content**: any: Any object +* **contentLink**: [IntegrationAccountContentLink](#integrationaccountcontentlink) (ReadOnly) +* **contentType**: string: The content type. +* **createdTime**: string (ReadOnly): The created time. +* **mapType**: 'NotSpecified' | 'Xslt' +* **metadata**: any: Any object + +## IntegrationAccountPartnerProperties +### Properties +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [PartnerContent](#partnercontent) +* **createdTime**: string (ReadOnly): The created time. +* **metadata**: any: Any object +* **partnerType**: 'B2B' | 'NotSpecified' + +## IntegrationAccountResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IntegrationAccountResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IntegrationAccountResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IntegrationAccountResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IntegrationAccountResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IntegrationAccountResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IntegrationAccountSchemaProperties +### Properties +* **changedTime**: string (ReadOnly): The changed time. +* **content**: any: Any object +* **contentLink**: [IntegrationAccountContentLink](#integrationaccountcontentlink) (ReadOnly) +* **contentType**: string: The content type. +* **createdTime**: string (ReadOnly): The created time. +* **metadata**: any: Any object +* **schemaType**: 'NotSpecified' | 'Xml' +* **targetNamespace**: string: The target namespace. + +## IntegrationAccountSku +### Properties +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' + +## KeyVaultKeyReference +### Properties +* **keyName**: string: The private key name in key vault. +* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault): The key vault reference. +* **keyVersion**: string: The private key version in key vault. + +## KeyVaultKeyReferenceKeyVault +### Properties +* **id**: string: The resource id. +* **name**: string (ReadOnly): The resource name. +* **type**: string (ReadOnly): The resource type. + +## ListCallbackUrlParameters +### Properties +* **NotAfter**: string (WriteOnly): The expiry time. + +## PartnerContent +### Properties +* **b2b**: [B2BPartnerContent](#b2bpartnercontent) ## X12AcknowledgementSettings ### Properties @@ -412,6 +489,23 @@ * **rolloverAcknowledgementControlNumber**: bool: The value indicating whether to rollover acknowledgement control number. * **sendSynchronousAcknowledgement**: bool: The value indicating whether to send synchronous acknowledgement. +## X12AgreementContent +### Properties +* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) +* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) + +## X12DelimiterOverrides +### Properties +* **componentSeparator**: int: The component separator. +* **dataElementSeparator**: int: The data element separator. +* **messageId**: string: The message id. +* **protocolVersion**: string: The protocol version. +* **replaceCharacter**: int: The replacement character. +* **replaceSeparatorsInPayload**: bool: The value indicating whether to replace separators in payload. +* **segmentTerminator**: int: The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' +* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. + ## X12EnvelopeOverride ### Properties * **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' @@ -470,6 +564,12 @@ ### Properties * **messageId**: string: The message id. +## X12OneWayAgreement +### Properties +* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) + ## X12ProcessingSettings ### Properties * **convertImpliedDecimal**: bool: The value indicating whether to convert numerical type to implied decimal. @@ -479,6 +579,21 @@ * **suspendInterchangeOnError**: bool: The value indicating whether to suspend interchange on error. * **useDotAsDecimalSeparator**: bool: The value indicating whether to use dot as decimal separator. +## X12ProtocolSettings +### Properties +* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) +* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. +* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) +* **framingSettings**: [X12FramingSettings](#x12framingsettings) +* **messageFilter**: [X12MessageFilter](#x12messagefilter) +* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. +* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) +* **schemaReferences**: [X12SchemaReference](#x12schemareference)[]: The X12 schema references. +* **securitySettings**: [X12SecuritySettings](#x12securitysettings) +* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. +* **validationSettings**: [X12ValidationSettings](#x12validationsettings) +* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. + ## X12SchemaReference ### Properties * **messageId**: string: The message id. @@ -516,118 +631,3 @@ * **validateEDITypes**: bool: The value indicating whether to Whether to validate EDI types. * **validateXSDTypes**: bool: The value indicating whether to Whether to validate XSD types. -## X12DelimiterOverrides -### Properties -* **componentSeparator**: int: The component separator. -* **dataElementSeparator**: int: The data element separator. -* **messageId**: string: The message id. -* **protocolVersion**: string: The protocol version. -* **replaceCharacter**: int: The replacement character. -* **replaceSeparatorsInPayload**: bool: The value indicating whether to replace separators in payload. -* **segmentTerminator**: int: The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' -* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. - -## IntegrationAccountResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountCertificateProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **createdTime**: string (ReadOnly): The created time. -* **key**: [KeyVaultKeyReference](#keyvaultkeyreference) -* **metadata**: any: Any object -* **publicCertificate**: string: The public certificate. - -## KeyVaultKeyReference -### Properties -* **keyName**: string: The private key name in key vault. -* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault): The key vault reference. -* **keyVersion**: string: The private key version in key vault. - -## KeyVaultKeyReferenceKeyVault -### Properties -* **id**: string: The resource id. -* **name**: string (ReadOnly): The resource name. -* **type**: string (ReadOnly): The resource type. - -## IntegrationAccountResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountMapProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: any: Any object -* **contentLink**: [IntegrationAccountContentLink](#integrationaccountcontentlink) (ReadOnly) -* **contentType**: string: The content type. -* **createdTime**: string (ReadOnly): The created time. -* **mapType**: 'NotSpecified' | 'Xslt' -* **metadata**: any: Any object - -## IntegrationAccountContentLink -### Properties -* **contentHash**: [IntegrationAccountContentHash](#integrationaccountcontenthash) -* **contentSize**: int: The content size. -* **contentVersion**: string: The content version. -* **metadata**: any: Any object -* **uri**: string: The content link URI. - -## IntegrationAccountContentHash -### Properties -* **algorithm**: string: The content hash algorithm. -* **value**: string: The content hash value. - -## IntegrationAccountResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountPartnerProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [PartnerContent](#partnercontent) -* **createdTime**: string (ReadOnly): The created time. -* **metadata**: any: Any object -* **partnerType**: 'B2B' | 'NotSpecified' - -## PartnerContent -### Properties -* **b2b**: [B2BPartnerContent](#b2bpartnercontent) - -## B2BPartnerContent -### Properties -* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. - -## IntegrationAccountResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountSchemaProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: any: Any object -* **contentLink**: [IntegrationAccountContentLink](#integrationaccountcontentlink) (ReadOnly) -* **contentType**: string: The content type. -* **createdTime**: string (ReadOnly): The created time. -* **metadata**: any: Any object -* **schemaType**: 'NotSpecified' | 'Xml' -* **targetNamespace**: string: The target namespace. - -## IntegrationAccountResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListCallbackUrlParameters -### Properties -* **NotAfter**: string (WriteOnly): The expiry time. - -## CallbackUrl -### Properties -* **value**: string (ReadOnly): The URL value. - diff --git a/generated/logic/microsoft.logic/2016-06-01/types.md b/generated/logic/microsoft.logic/2016-06-01/types.md index 8ff3503b8b..919d24668c 100644 --- a/generated/logic/microsoft.logic/2016-06-01/types.md +++ b/generated/logic/microsoft.logic/2016-06-01/types.md @@ -195,54 +195,12 @@ * **ApiVersion**: 2016-06-01 * **Output**: any -## IntegrationAccountSku -### Properties -* **name**: 'Free' | 'NotSpecified' | 'Standard' (Required) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountAgreementProperties -### Properties -* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' (Required) -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [AgreementContent](#agreementcontent) (Required): The integration account agreement content. -* **createdTime**: string (ReadOnly): The created time. -* **guestIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **guestPartner**: string (Required): The integration account partner that is set as guest partner for this agreement. -* **hostIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **hostPartner**: string (Required): The integration account partner that is set as host partner for this agreement. -* **metadata**: any: Any object - ## AgreementContent ### Properties * **aS2**: [AS2AgreementContent](#as2agreementcontent): The integration account AS2 agreement content. * **edifact**: [EdifactAgreementContent](#edifactagreementcontent): The Edifact agreement content. * **x12**: [X12AgreementContent](#x12agreementcontent): The X12 agreement content. -## AS2AgreementContent -### Properties -* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. -* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. - -## AS2OneWayAgreement -### Properties -* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) (Required): The AS2 agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. - -## AS2ProtocolSettings -### Properties -* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) (Required): The AS2 agreement acknowledgement connection settings. -* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) (Required): The AS2 agreement envelope settings. -* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) (Required): The AS2 agreement error settings. -* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) (Required): The AS2 agreement mdn settings. -* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) (Required): The AS2 agreement message connection settings. -* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) (Required): The AS2 agreement security settings. -* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) (Required): The AS2 agreement validation settings. - ## AS2AcknowledgementConnectionSettings ### Properties * **ignoreCertificateNameMismatch**: bool (Required): The value indicating whether to ignore mismatch in certificate name. @@ -250,6 +208,11 @@ * **supportHttpStatusCodeContinue**: bool (Required): The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool (Required): The value indicating whether to unfold the HTTP headers. +## AS2AgreementContent +### Properties +* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. +* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. + ## AS2EnvelopeSettings ### Properties * **autogenerateFileName**: bool (Required): The value indicating whether to auto generate file name. @@ -282,6 +245,22 @@ * **supportHttpStatusCodeContinue**: bool (Required): The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool (Required): The value indicating whether to unfold the HTTP headers. +## AS2OneWayAgreement +### Properties +* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) (Required): The AS2 agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + +## AS2ProtocolSettings +### Properties +* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) (Required): The AS2 agreement acknowledgement connection settings. +* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) (Required): The AS2 agreement envelope settings. +* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) (Required): The AS2 agreement error settings. +* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) (Required): The AS2 agreement mdn settings. +* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) (Required): The AS2 agreement message connection settings. +* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) (Required): The AS2 agreement security settings. +* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) (Required): The AS2 agreement validation settings. + ## AS2SecuritySettings ### Properties * **enableNrrForInboundDecodedMessages**: bool (Required): The value indicating whether to enable NRR for inbound decoded messages. @@ -308,35 +287,64 @@ * **signingAlgorithm**: 'Default' | 'NotSpecified' | 'SHA1' | 'SHA2256' | 'SHA2384' | 'SHA2512' | string * **signMessage**: bool (Required): The value indicating whether the message has to be signed. +## AssemblyProperties +### Properties +* **assemblyCulture**: string: The assembly culture. +* **assemblyName**: string (Required): The assembly name. +* **assemblyPublicKeyToken**: string: The assembly public key token. +* **assemblyVersion**: string: The assembly version. +* **changedTime**: string: The artifact changed time. +* **content**: any: Anything +* **contentLink**: [ContentLink](#contentlink): The content link. +* **contentType**: string: The content type. +* **createdTime**: string: The artifact creation time. +* **metadata**: any: Anything + +## AzureResourceErrorInfo +### Properties +* **code**: string (ReadOnly): The error code. +* **details**: [AzureResourceErrorInfo](#azureresourceerrorinfo)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. + +## B2BPartnerContent +### Properties +* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. + +## BatchConfigurationProperties +### Properties +* **batchGroupName**: string (Required): The name of the batch group. +* **changedTime**: string: The artifact changed time. +* **createdTime**: string: The artifact creation time. +* **metadata**: any: Anything +* **releaseCriteria**: [BatchReleaseCriteria](#batchreleasecriteria) (Required): The batch release criteria. + +## BatchReleaseCriteria +### Properties +* **batchSize**: int: The batch size in bytes. +* **messageCount**: int: The message count. +* **recurrence**: [WorkflowTriggerRecurrence](#workflowtriggerrecurrence): The workflow trigger recurrence. + ## BusinessIdentity ### Properties * **qualifier**: string (Required): The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * **value**: string (Required): The user defined business identity value. -## EdifactAgreementContent +## CallbackUrl ### Properties -* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. -* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. +* **value**: string (ReadOnly): The URL value. -## EdifactOneWayAgreement +## ContentHash ### Properties -* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) (Required): The Edifact agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **algorithm**: string: The algorithm of the content hash. +* **value**: string: The value of the content hash. -## EdifactProtocolSettings +## ContentLink ### Properties -* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) (Required): The Edifact agreement acknowledgement settings. -* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. -* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. -* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) (Required): The Edifact agreement envelope settings. -* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) (Required): The Edifact agreement framing settings. -* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) (Required): The Edifact message filter for odata query. -* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. -* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) (Required): The Edifact agreement protocol settings. -* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[] (Required): The EDIFACT schema references. -* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. -* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) (Required): The Edifact agreement validation settings. +* **contentHash**: [ContentHash](#contenthash): The content hash. +* **contentSize**: int: The content size. +* **contentVersion**: string: The content version. +* **metadata**: any: Any object +* **uri**: string: The content link URI. ## EdifactAcknowledgementSettings ### Properties @@ -352,6 +360,11 @@ * **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. * **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. +## EdifactAgreementContent +### Properties +* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. +* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. + ## EdifactDelimiterOverride ### Properties * **componentSeparator**: int (Required): The component separator. @@ -451,6 +464,12 @@ ### Properties * **messageId**: string (Required): The message id on which this envelope settings has to be applied. +## EdifactOneWayAgreement +### Properties +* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) (Required): The Edifact agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + ## EdifactProcessingSettings ### Properties * **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. @@ -459,6 +478,20 @@ * **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. * **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. +## EdifactProtocolSettings +### Properties +* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) (Required): The Edifact agreement acknowledgement settings. +* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. +* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. +* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) (Required): The Edifact agreement envelope settings. +* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) (Required): The Edifact agreement framing settings. +* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) (Required): The Edifact message filter for odata query. +* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. +* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) (Required): The Edifact agreement protocol settings. +* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[] (Required): The EDIFACT schema references. +* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. +* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) (Required): The Edifact agreement validation settings. + ## EdifactSchemaReference ### Properties * **associationAssignedCode**: string: The association assigned code. @@ -492,224 +525,190 @@ * **validateEdiTypes**: bool (Required): The value indicating whether to Whether to validate EDI types. * **validateXsdTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. -## X12AgreementContent +## Expression ### Properties -* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. -* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. +* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. +* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression +* **text**: string (ReadOnly) +* **value**: any (ReadOnly): Anything -## X12OneWayAgreement +## ExpressionRoot ### Properties -* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) (Required): The X12 agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. +* **path**: string (ReadOnly): The path. +* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression +* **text**: string (ReadOnly) +* **value**: any (ReadOnly): Anything -## X12ProtocolSettings +## ExpressionTraces ### Properties -* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) (Required): The X12 agreement acknowledgement settings. -* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. -* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) (Required): The X12 agreement envelope settings. -* **framingSettings**: [X12FramingSettings](#x12framingsettings) (Required): The X12 agreement framing settings. -* **messageFilter**: [X12MessageFilter](#x12messagefilter) (Required): The X12 message filter for odata query. -* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. -* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) (Required): The X12 processing settings. -* **schemaReferences**: [X12SchemaReference](#x12schemareference)[] (Required): The X12 schema references. -* **securitySettings**: [X12SecuritySettings](#x12securitysettings) (Required): The X12 agreement security settings. -* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. -* **validationSettings**: [X12ValidationSettings](#x12validationsettings) (Required): The X12 agreement validation settings. -* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. +* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot -## X12AcknowledgementSettings +## ExpressionTraces ### Properties -* **acknowledgementControlNumberLowerBound**: int (Required): The acknowledgement control number lower bound. -* **acknowledgementControlNumberPrefix**: string: The acknowledgement control number prefix. -* **acknowledgementControlNumberSuffix**: string: The acknowledgement control number suffix. -* **acknowledgementControlNumberUpperBound**: int (Required): The acknowledgement control number upper bound. -* **batchFunctionalAcknowledgements**: bool (Required): The value indicating whether to batch functional acknowledgements. -* **batchImplementationAcknowledgements**: bool (Required): The value indicating whether to batch implementation acknowledgements. -* **batchTechnicalAcknowledgements**: bool (Required): The value indicating whether to batch the technical acknowledgements. -* **functionalAcknowledgementVersion**: string: The functional acknowledgement version. -* **implementationAcknowledgementVersion**: string: The implementation acknowledgement version. -* **needFunctionalAcknowledgement**: bool (Required): The value indicating whether functional acknowledgement is needed. -* **needImplementationAcknowledgement**: bool (Required): The value indicating whether implementation acknowledgement is needed. -* **needLoopForValidMessages**: bool (Required): The value indicating whether a loop is needed for valid messages. -* **needTechnicalAcknowledgement**: bool (Required): The value indicating whether technical acknowledgement is needed. -* **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. -* **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. +* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot -## X12EnvelopeOverride +## GetCallbackUrlParameters ### Properties -* **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' (Required) -* **functionalIdentifierCode**: string: The functional identifier code. -* **headerVersion**: string (Required): The header version. -* **messageId**: string (Required): The message id on which this envelope settings has to be applied. -* **protocolVersion**: string (Required): The protocol version on which this envelope settings has to be applied. -* **receiverApplicationId**: string (Required): The receiver application id. -* **responsibleAgencyCode**: string (Required): The responsible agency code. -* **senderApplicationId**: string (Required): The sender application id. -* **targetNamespace**: string (Required): The target namespace on which this envelope settings has to be applied. -* **timeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' (Required) +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12EnvelopeSettings +## GetCallbackUrlParameters ### Properties -* **controlStandardsId**: int (Required): The controls standards id. -* **controlVersionNumber**: string (Required): The control version number. -* **enableDefaultGroupHeaders**: bool (Required): The value indicating whether to enable default group headers. -* **functionalGroupId**: string: The functional group id. -* **groupControlNumberLowerBound**: int (Required): The group control number lower bound. -* **groupControlNumberUpperBound**: int (Required): The group control number upper bound. -* **groupHeaderAgencyCode**: string (Required): The group header agency code. -* **groupHeaderDateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' (Required) -* **groupHeaderTimeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' (Required) -* **groupHeaderVersion**: string (Required): The group header version. -* **interchangeControlNumberLowerBound**: int (Required): The interchange control number lower bound. -* **interchangeControlNumberUpperBound**: int (Required): The interchange control number upper bound. -* **overwriteExistingTransactionSetControlNumber**: bool (Required): The value indicating whether to overwrite existing transaction set control number. -* **receiverApplicationId**: string (Required): The receiver application id. -* **rolloverGroupControlNumber**: bool (Required): The value indicating whether to rollover group control number. -* **rolloverInterchangeControlNumber**: bool (Required): The value indicating whether to rollover interchange control number. -* **rolloverTransactionSetControlNumber**: bool (Required): The value indicating whether to rollover transaction set control number. -* **senderApplicationId**: string (Required): The sender application id. -* **transactionSetControlNumberLowerBound**: int (Required): The transaction set control number lower bound. -* **transactionSetControlNumberPrefix**: string: The transaction set control number prefix. -* **transactionSetControlNumberSuffix**: string: The transaction set control number suffix. -* **transactionSetControlNumberUpperBound**: int (Required): The transaction set control number upper bound. -* **usageIndicator**: 'Information' | 'NotSpecified' | 'Production' | 'Test' (Required) -* **useControlStandardsIdAsRepetitionCharacter**: bool (Required): The value indicating whether to use control standards id as repetition character. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12FramingSettings +## GetCallbackUrlParameters ### Properties -* **characterSet**: 'Basic' | 'Extended' | 'NotSpecified' | 'UTF8' (Required) -* **componentSeparator**: int (Required): The component separator. -* **dataElementSeparator**: int (Required): The data element separator. -* **replaceCharacter**: int (Required): The replacement character. -* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. -* **segmentTerminator**: int (Required): The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12MessageFilter +## GetCallbackUrlParameters ### Properties -* **messageFilterType**: 'Exclude' | 'Include' | 'NotSpecified' (Required) +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12MessageIdentifier +## GetCallbackUrlParameters ### Properties -* **messageId**: string (Required): The message id. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12ProcessingSettings +## GetCallbackUrlParameters ### Properties -* **convertImpliedDecimal**: bool (Required): The value indicating whether to convert numerical type to implied decimal. -* **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. -* **maskSecurityInfo**: bool (Required): The value indicating whether to mask security information. -* **preserveInterchange**: bool (Required): The value indicating whether to preserve interchange. -* **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. -* **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12SchemaReference +## GetCallbackUrlParameters ### Properties -* **messageId**: string (Required): The message id. -* **schemaName**: string (Required): The schema name. -* **schemaVersion**: string (Required): The schema version. -* **senderApplicationId**: string: The sender application id. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12SecuritySettings +## IntegrationAccountAgreementProperties ### Properties -* **authorizationQualifier**: string (Required): The authorization qualifier. -* **authorizationValue**: string: The authorization value. -* **passwordValue**: string: The password value. -* **securityQualifier**: string (Required): The security qualifier. +* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' (Required) +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [AgreementContent](#agreementcontent) (Required): The integration account agreement content. +* **createdTime**: string (ReadOnly): The created time. +* **guestIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **guestPartner**: string (Required): The integration account partner that is set as guest partner for this agreement. +* **hostIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **hostPartner**: string (Required): The integration account partner that is set as host partner for this agreement. +* **metadata**: any: Any object -## X12ValidationOverride +## IntegrationAccountCertificateProperties ### Properties -* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. -* **messageId**: string (Required): The message id on which the validation settings has to be applied. -* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' (Required) -* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. -* **validateCharacterSet**: bool (Required): The value indicating whether to validate character Set. -* **validateEdiTypes**: bool (Required): The value indicating whether to validate EDI types. -* **validateXsdTypes**: bool (Required): The value indicating whether to validate XSD types. +* **changedTime**: string (ReadOnly): The changed time. +* **createdTime**: string (ReadOnly): The created time. +* **key**: [KeyVaultKeyReference](#keyvaultkeyreference): The reference to the key vault key. +* **metadata**: any: Any object +* **publicCertificate**: string: The public certificate. -## X12ValidationSettings +## IntegrationAccountMapProperties ### Properties -* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. -* **checkDuplicateGroupControlNumber**: bool (Required): The value indicating whether to check for duplicate group control number. -* **checkDuplicateInterchangeControlNumber**: bool (Required): The value indicating whether to check for duplicate interchange control number. -* **checkDuplicateTransactionSetControlNumber**: bool (Required): The value indicating whether to check for duplicate transaction set control number. -* **interchangeControlNumberValidityDays**: int (Required): The validity period of interchange control number. -* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' (Required) -* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. -* **validateCharacterSet**: bool (Required): The value indicating whether to validate character set in the message. -* **validateEdiTypes**: bool (Required): The value indicating whether to Whether to validate EDI types. -* **validateXsdTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: string: The content. +* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. +* **contentType**: string: The content type. +* **createdTime**: string (ReadOnly): The created time. +* **mapType**: 'NotSpecified' | 'Xslt' (Required) +* **metadata**: any: Any object +* **parametersSchema**: [IntegrationAccountMapPropertiesParametersSchema](#integrationaccountmappropertiesparametersschema): The parameters schema of integration account map. -## X12DelimiterOverrides +## IntegrationAccountMapPropertiesParametersSchema ### Properties -* **componentSeparator**: int (Required): The component separator. -* **dataElementSeparator**: int (Required): The data element separator. -* **messageId**: string: The message id. -* **protocolVersion**: string: The protocol version. -* **replaceCharacter**: int (Required): The replacement character. -* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. -* **segmentTerminator**: int (Required): The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) -* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. +* **ref**: string: The reference name. -## ResourceTags +## IntegrationAccountPartnerProperties +### Properties +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [PartnerContent](#partnercontent) (Required): The integration account partner content. +* **createdTime**: string (ReadOnly): The created time. +* **metadata**: any: Any object +* **partnerType**: 'B2B' | 'NotSpecified' (Required) + +## IntegrationAccountRosettaNetProcessConfigurationProperties +### Properties +* **activitySettings**: [RosettaNetPipActivitySettings](#rosettanetpipactivitysettings) (Required): The integration account RosettaNet ProcessConfiguration activity settings. +* **changedTime**: string (ReadOnly): The changed time. +* **createdTime**: string (ReadOnly): The created time. +* **description**: string: The integration account RosettaNet ProcessConfiguration properties. +* **initiatorRoleSettings**: [RosettaNetPipRoleSettings](#rosettanetpiprolesettings) (Required): The integration account RosettaNet ProcessConfiguration role settings. +* **metadata**: [IntegrationAccountRosettaNetProcessConfigurationPropertiesMetadata](#integrationaccountrosettanetprocessconfigurationpropertiesmetadata): The metadata. +* **processCode**: string (Required): The integration account RosettaNet process code. +* **processName**: string (Required): The integration account RosettaNet process name. +* **processVersion**: string (Required): The integration account RosettaNet process version. +* **responderRoleSettings**: [RosettaNetPipRoleSettings](#rosettanetpiprolesettings) (Required): The integration account RosettaNet ProcessConfiguration role settings. + +## IntegrationAccountRosettaNetProcessConfigurationPropertiesMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string -## AssemblyProperties +## IntegrationAccountSchemaProperties ### Properties -* **assemblyCulture**: string: The assembly culture. -* **assemblyName**: string (Required): The assembly name. -* **assemblyPublicKeyToken**: string: The assembly public key token. -* **assemblyVersion**: string: The assembly version. -* **changedTime**: string: The artifact changed time. -* **content**: any: Anything -* **contentLink**: [ContentLink](#contentlink): The content link. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: string: The content. +* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. * **contentType**: string: The content type. -* **createdTime**: string: The artifact creation time. -* **metadata**: any: Anything +* **createdTime**: string (ReadOnly): The created time. +* **documentName**: string: The document name. +* **fileName**: string: The file name. +* **metadata**: any: Any object +* **schemaType**: 'NotSpecified' | 'Xml' (Required) +* **targetNamespace**: string: The target namespace of the schema. -## ContentLink +## IntegrationAccountSessionProperties ### Properties -* **contentHash**: [ContentHash](#contenthash): The content hash. -* **contentSize**: int: The content size. -* **contentVersion**: string: The content version. -* **metadata**: any: Any object -* **uri**: string: The content link URI. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: any: Any object +* **createdTime**: string (ReadOnly): The created time. -## ContentHash +## IntegrationAccountSku ### Properties -* **algorithm**: string: The algorithm of the content hash. -* **value**: string: The value of the content hash. +* **name**: 'Free' | 'NotSpecified' | 'Standard' (Required) -## ResourceTags +## KeyVaultKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **attributes**: [KeyVaultKeyAttributes](#keyvaultkeyattributes) (ReadOnly): The key attributes. +* **kid**: string (ReadOnly): The key id. -## BatchConfigurationProperties +## KeyVaultKeyAttributes ### Properties -* **batchGroupName**: string (Required): The name of the batch group. -* **changedTime**: string: The artifact changed time. -* **createdTime**: string: The artifact creation time. -* **metadata**: any: Anything -* **releaseCriteria**: [BatchReleaseCriteria](#batchreleasecriteria) (Required): The batch release criteria. +* **created**: int (ReadOnly): When the key was created. +* **enabled**: bool (ReadOnly): Whether the key is enabled or not. +* **updated**: int (ReadOnly): When the key was updated. -## BatchReleaseCriteria +## KeyVaultKeyCollection ### Properties -* **batchSize**: int: The batch size in bytes. -* **messageCount**: int: The message count. -* **recurrence**: [WorkflowTriggerRecurrence](#workflowtriggerrecurrence): The workflow trigger recurrence. +* **skipToken**: string (ReadOnly): The skip token. +* **value**: [KeyVaultKey](#keyvaultkey)[] (ReadOnly): The key vault keys. -## WorkflowTriggerRecurrence +## KeyVaultKeyReference ### Properties -* **endTime**: string: The end time. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' -* **interval**: int: The interval. -* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. -* **startTime**: string: The start time. -* **timeZone**: string: The time zone. +* **keyName**: string (Required): The private key name in key vault. +* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault) (Required): The key vault reference. +* **keyVersion**: string: The private key version in key vault. + +## KeyVaultKeyReferenceKeyVault +### Properties +* **id**: string: The resource id. +* **name**: string (ReadOnly): The resource name. +* **type**: string (ReadOnly): The resource type. + +## KeyVaultReference +### Properties +* **id**: string (ReadOnly, WriteOnly): The resource id. +* **name**: string (ReadOnly, WriteOnly): Gets the resource name. +* **type**: string (ReadOnly, WriteOnly): Gets the resource type. + +## ListKeyVaultKeysDefinition +### Properties +* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required, WriteOnly): The key vault reference. +* **skipToken**: string (WriteOnly): The skip token. + +## PartnerContent +### Properties +* **b2b**: [B2BPartnerContent](#b2bpartnercontent): The B2B partner content. ## RecurrenceSchedule ### Properties @@ -724,95 +723,66 @@ * **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' * **occurrence**: int: The occurrence. +## ResourceReference +### Properties +* **id**: string (ReadOnly): The resource id. +* **name**: string (ReadOnly): Gets the resource name. +* **type**: string (ReadOnly): Gets the resource type. + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountCertificateProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **createdTime**: string (ReadOnly): The created time. -* **key**: [KeyVaultKeyReference](#keyvaultkeyreference): The reference to the key vault key. -* **metadata**: any: Any object -* **publicCertificate**: string: The public certificate. - -## KeyVaultKeyReference -### Properties -* **keyName**: string (Required): The private key name in key vault. -* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault) (Required): The key vault reference. -* **keyVersion**: string: The private key version in key vault. - -## KeyVaultKeyReferenceKeyVault -### Properties -* **id**: string: The resource id. -* **name**: string (ReadOnly): The resource name. -* **type**: string (ReadOnly): The resource type. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountMapProperties +## ResourceTags ### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: string: The content. -* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. -* **contentType**: string: The content type. -* **createdTime**: string (ReadOnly): The created time. -* **mapType**: 'NotSpecified' | 'Xslt' (Required) -* **metadata**: any: Any object -* **parametersSchema**: [IntegrationAccountMapPropertiesParametersSchema](#integrationaccountmappropertiesparametersschema): The parameters schema of integration account map. +### Additional Properties +* **Additional Properties Type**: string -## IntegrationAccountMapPropertiesParametersSchema +## ResourceTags ### Properties -* **ref**: string: The reference name. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountPartnerProperties +## ResourceTags ### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [PartnerContent](#partnercontent) (Required): The integration account partner content. -* **createdTime**: string (ReadOnly): The created time. -* **metadata**: any: Any object -* **partnerType**: 'B2B' | 'NotSpecified' (Required) +### Additional Properties +* **Additional Properties Type**: string -## PartnerContent +## ResourceTags ### Properties -* **b2b**: [B2BPartnerContent](#b2bpartnercontent): The B2B partner content. +### Additional Properties +* **Additional Properties Type**: string -## B2BPartnerContent +## ResourceTags ### Properties -* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountRosettaNetProcessConfigurationProperties +## ResourceTags ### Properties -* **activitySettings**: [RosettaNetPipActivitySettings](#rosettanetpipactivitysettings) (Required): The integration account RosettaNet ProcessConfiguration activity settings. -* **changedTime**: string (ReadOnly): The changed time. -* **createdTime**: string (ReadOnly): The created time. -* **description**: string: The integration account RosettaNet ProcessConfiguration properties. -* **initiatorRoleSettings**: [RosettaNetPipRoleSettings](#rosettanetpiprolesettings) (Required): The integration account RosettaNet ProcessConfiguration role settings. -* **metadata**: [IntegrationAccountRosettaNetProcessConfigurationPropertiesMetadata](#integrationaccountrosettanetprocessconfigurationpropertiesmetadata): The metadata. -* **processCode**: string (Required): The integration account RosettaNet process code. -* **processName**: string (Required): The integration account RosettaNet process name. -* **processVersion**: string (Required): The integration account RosettaNet process version. -* **responderRoleSettings**: [RosettaNetPipRoleSettings](#rosettanetpiprolesettings) (Required): The integration account RosettaNet ProcessConfiguration role settings. +### Additional Properties +* **Additional Properties Type**: string -## RosettaNetPipActivitySettings +## ResourceTags ### Properties -* **acknowledgmentOfReceiptSettings**: [RosettaNetPipAcknowledgmentOfReceiptSettings](#rosettanetpipacknowledgmentofreceiptsettings) (Required): The integration account RosettaNet ProcessConfiguration Acknowledgement settings. -* **activityBehavior**: [RosettaNetPipActivityBehavior](#rosettanetpipactivitybehavior) (Required): The integration account RosettaNet ProcessConfiguration activity behavior. -* **activityType**: 'BusinessTransaction' | 'InformationDistribution' | 'NotSpecified' | 'Notification' | 'QueryResponse' | 'RequestConfirm' | 'RequestResponse' (Required) +### Additional Properties +* **Additional Properties Type**: string ## RosettaNetPipAcknowledgmentOfReceiptSettings ### Properties @@ -830,15 +800,11 @@ * **retryCount**: int (Required): The value indicating retry count. * **timeToPerformInSeconds**: int (Required): The time to perform in seconds. -## RosettaNetPipRoleSettings +## RosettaNetPipActivitySettings ### Properties -* **action**: string (Required): The action name. -* **businessDocument**: [RosettaNetPipBusinessDocument](#rosettanetpipbusinessdocument) (Required): The RosettaNet ProcessConfiguration business document settings. -* **description**: string: The description. -* **role**: string (Required): The role name. -* **roleType**: 'Employee' | 'Functional' | 'NotSpecified' | 'Organizational' (Required) -* **service**: string (Required): The service name. -* **serviceClassification**: string (Required): The service classification name. +* **acknowledgmentOfReceiptSettings**: [RosettaNetPipAcknowledgmentOfReceiptSettings](#rosettanetpipacknowledgmentofreceiptsettings) (Required): The integration account RosettaNet ProcessConfiguration Acknowledgement settings. +* **activityBehavior**: [RosettaNetPipActivityBehavior](#rosettanetpipactivitybehavior) (Required): The integration account RosettaNet ProcessConfiguration activity behavior. +* **activityType**: 'BusinessTransaction' | 'InformationDistribution' | 'NotSpecified' | 'Notification' | 'QueryResponse' | 'RequestConfirm' | 'RequestResponse' (Required) ## RosettaNetPipBusinessDocument ### Properties @@ -846,90 +812,45 @@ * **name**: string (Required): The business document name. * **version**: string (Required): The business document version. -## IntegrationAccountRosettaNetProcessConfigurationPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountSchemaProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: string: The content. -* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. -* **contentType**: string: The content type. -* **createdTime**: string (ReadOnly): The created time. -* **documentName**: string: The document name. -* **fileName**: string: The file name. -* **metadata**: any: Any object -* **schemaType**: 'NotSpecified' | 'Xml' (Required) -* **targetNamespace**: string: The target namespace of the schema. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountSessionProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: any: Any object -* **createdTime**: string (ReadOnly): The created time. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WorkflowProperties -### Properties -* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. -* **changedTime**: string (ReadOnly): Gets the changed time. -* **createdTime**: string (ReadOnly): Gets the created time. -* **definition**: any: Any object -* **integrationAccount**: [ResourceReference](#resourcereference): The resource reference. -* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): The parameters. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'NotSpecified' | 'Ready' | 'Registered' | 'Registering' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' (ReadOnly) -* **sku**: [Sku](#sku): The sku type. -* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' -* **version**: string (ReadOnly): Gets the version. - -## ResourceReference +## RosettaNetPipRoleSettings ### Properties -* **id**: string (ReadOnly): The resource id. -* **name**: string (ReadOnly): Gets the resource name. -* **type**: string (ReadOnly): Gets the resource type. +* **action**: string (Required): The action name. +* **businessDocument**: [RosettaNetPipBusinessDocument](#rosettanetpipbusinessdocument) (Required): The RosettaNet ProcessConfiguration business document settings. +* **description**: string: The description. +* **role**: string (Required): The role name. +* **roleType**: 'Employee' | 'Functional' | 'NotSpecified' | 'Organizational' (Required) +* **service**: string (Required): The service name. +* **serviceClassification**: string (Required): The service classification name. -## WorkflowPropertiesParameters +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' (Required): The sku name. +* **plan**: [ResourceReference](#resourcereference): The resource reference. ## WorkflowParameter ### Properties * **description**: string: The description. * **metadata**: any: Any object * **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'NotSpecified' | 'Object' | 'SecureObject' | 'SecureString' | 'String' -* **value**: any: Any object - -## Sku -### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' (Required): The sku name. -* **plan**: [ResourceReference](#resourcereference): The resource reference. +* **value**: any: Any object -## ResourceTags +## WorkflowProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. +* **changedTime**: string (ReadOnly): Gets the changed time. +* **createdTime**: string (ReadOnly): Gets the created time. +* **definition**: any: Any object +* **integrationAccount**: [ResourceReference](#resourcereference): The resource reference. +* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): The parameters. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'NotSpecified' | 'Ready' | 'Registered' | 'Registering' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' (ReadOnly) +* **sku**: [Sku](#sku): The sku type. +* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' +* **version**: string (ReadOnly): Gets the version. -## GetCallbackUrlParameters +## WorkflowPropertiesParameters ### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. +### Additional Properties +* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) ## WorkflowTriggerCallbackUrl ### Properties @@ -940,19 +861,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## WorkflowTriggerListCallbackUrlQueries -### Properties -* **api-version**: string (ReadOnly): The api version. -* **se**: string (ReadOnly): The SAS timestamp. -* **sig**: string (ReadOnly): The SAS signature. -* **sp**: string (ReadOnly): The SAS permissions. -* **sv**: string (ReadOnly): The SAS version. - -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -971,15 +879,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - -## CallbackUrl -### Properties -* **value**: string (ReadOnly): The URL value. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -989,11 +888,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1003,11 +897,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1017,11 +906,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1031,11 +915,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1045,59 +924,180 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## ExpressionTraces +## WorkflowTriggerListCallbackUrlQueries ### Properties -* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot +* **api-version**: string (ReadOnly): The api version. +* **se**: string (ReadOnly): The SAS timestamp. +* **sig**: string (ReadOnly): The SAS signature. +* **sp**: string (ReadOnly): The SAS permissions. +* **sv**: string (ReadOnly): The SAS version. -## ExpressionRoot +## WorkflowTriggerRecurrence ### Properties -* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. -* **path**: string (ReadOnly): The path. -* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression -* **text**: string (ReadOnly) -* **value**: any (ReadOnly): Anything +* **endTime**: string: The end time. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' +* **interval**: int: The interval. +* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. +* **startTime**: string: The start time. +* **timeZone**: string: The time zone. -## AzureResourceErrorInfo +## X12AcknowledgementSettings ### Properties -* **code**: string (ReadOnly): The error code. -* **details**: [AzureResourceErrorInfo](#azureresourceerrorinfo)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. +* **acknowledgementControlNumberLowerBound**: int (Required): The acknowledgement control number lower bound. +* **acknowledgementControlNumberPrefix**: string: The acknowledgement control number prefix. +* **acknowledgementControlNumberSuffix**: string: The acknowledgement control number suffix. +* **acknowledgementControlNumberUpperBound**: int (Required): The acknowledgement control number upper bound. +* **batchFunctionalAcknowledgements**: bool (Required): The value indicating whether to batch functional acknowledgements. +* **batchImplementationAcknowledgements**: bool (Required): The value indicating whether to batch implementation acknowledgements. +* **batchTechnicalAcknowledgements**: bool (Required): The value indicating whether to batch the technical acknowledgements. +* **functionalAcknowledgementVersion**: string: The functional acknowledgement version. +* **implementationAcknowledgementVersion**: string: The implementation acknowledgement version. +* **needFunctionalAcknowledgement**: bool (Required): The value indicating whether functional acknowledgement is needed. +* **needImplementationAcknowledgement**: bool (Required): The value indicating whether implementation acknowledgement is needed. +* **needLoopForValidMessages**: bool (Required): The value indicating whether a loop is needed for valid messages. +* **needTechnicalAcknowledgement**: bool (Required): The value indicating whether technical acknowledgement is needed. +* **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. +* **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. -## Expression +## X12AgreementContent ### Properties -* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. -* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression -* **text**: string (ReadOnly) -* **value**: any (ReadOnly): Anything +* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. +* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. -## ExpressionTraces +## X12DelimiterOverrides ### Properties -* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot +* **componentSeparator**: int (Required): The component separator. +* **dataElementSeparator**: int (Required): The data element separator. +* **messageId**: string: The message id. +* **protocolVersion**: string: The protocol version. +* **replaceCharacter**: int (Required): The replacement character. +* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. +* **segmentTerminator**: int (Required): The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) +* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. -## ListKeyVaultKeysDefinition +## X12EnvelopeOverride ### Properties -* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required, WriteOnly): The key vault reference. -* **skipToken**: string (WriteOnly): The skip token. +* **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' (Required) +* **functionalIdentifierCode**: string: The functional identifier code. +* **headerVersion**: string (Required): The header version. +* **messageId**: string (Required): The message id on which this envelope settings has to be applied. +* **protocolVersion**: string (Required): The protocol version on which this envelope settings has to be applied. +* **receiverApplicationId**: string (Required): The receiver application id. +* **responsibleAgencyCode**: string (Required): The responsible agency code. +* **senderApplicationId**: string (Required): The sender application id. +* **targetNamespace**: string (Required): The target namespace on which this envelope settings has to be applied. +* **timeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' (Required) -## KeyVaultReference +## X12EnvelopeSettings ### Properties -* **id**: string (ReadOnly, WriteOnly): The resource id. -* **name**: string (ReadOnly, WriteOnly): Gets the resource name. -* **type**: string (ReadOnly, WriteOnly): Gets the resource type. +* **controlStandardsId**: int (Required): The controls standards id. +* **controlVersionNumber**: string (Required): The control version number. +* **enableDefaultGroupHeaders**: bool (Required): The value indicating whether to enable default group headers. +* **functionalGroupId**: string: The functional group id. +* **groupControlNumberLowerBound**: int (Required): The group control number lower bound. +* **groupControlNumberUpperBound**: int (Required): The group control number upper bound. +* **groupHeaderAgencyCode**: string (Required): The group header agency code. +* **groupHeaderDateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' (Required) +* **groupHeaderTimeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' (Required) +* **groupHeaderVersion**: string (Required): The group header version. +* **interchangeControlNumberLowerBound**: int (Required): The interchange control number lower bound. +* **interchangeControlNumberUpperBound**: int (Required): The interchange control number upper bound. +* **overwriteExistingTransactionSetControlNumber**: bool (Required): The value indicating whether to overwrite existing transaction set control number. +* **receiverApplicationId**: string (Required): The receiver application id. +* **rolloverGroupControlNumber**: bool (Required): The value indicating whether to rollover group control number. +* **rolloverInterchangeControlNumber**: bool (Required): The value indicating whether to rollover interchange control number. +* **rolloverTransactionSetControlNumber**: bool (Required): The value indicating whether to rollover transaction set control number. +* **senderApplicationId**: string (Required): The sender application id. +* **transactionSetControlNumberLowerBound**: int (Required): The transaction set control number lower bound. +* **transactionSetControlNumberPrefix**: string: The transaction set control number prefix. +* **transactionSetControlNumberSuffix**: string: The transaction set control number suffix. +* **transactionSetControlNumberUpperBound**: int (Required): The transaction set control number upper bound. +* **usageIndicator**: 'Information' | 'NotSpecified' | 'Production' | 'Test' (Required) +* **useControlStandardsIdAsRepetitionCharacter**: bool (Required): The value indicating whether to use control standards id as repetition character. -## KeyVaultKeyCollection +## X12FramingSettings ### Properties -* **skipToken**: string (ReadOnly): The skip token. -* **value**: [KeyVaultKey](#keyvaultkey)[] (ReadOnly): The key vault keys. +* **characterSet**: 'Basic' | 'Extended' | 'NotSpecified' | 'UTF8' (Required) +* **componentSeparator**: int (Required): The component separator. +* **dataElementSeparator**: int (Required): The data element separator. +* **replaceCharacter**: int (Required): The replacement character. +* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. +* **segmentTerminator**: int (Required): The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) -## KeyVaultKey +## X12MessageFilter ### Properties -* **attributes**: [KeyVaultKeyAttributes](#keyvaultkeyattributes) (ReadOnly): The key attributes. -* **kid**: string (ReadOnly): The key id. +* **messageFilterType**: 'Exclude' | 'Include' | 'NotSpecified' (Required) -## KeyVaultKeyAttributes +## X12MessageIdentifier ### Properties -* **created**: int (ReadOnly): When the key was created. -* **enabled**: bool (ReadOnly): Whether the key is enabled or not. -* **updated**: int (ReadOnly): When the key was updated. +* **messageId**: string (Required): The message id. + +## X12OneWayAgreement +### Properties +* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) (Required): The X12 agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + +## X12ProcessingSettings +### Properties +* **convertImpliedDecimal**: bool (Required): The value indicating whether to convert numerical type to implied decimal. +* **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. +* **maskSecurityInfo**: bool (Required): The value indicating whether to mask security information. +* **preserveInterchange**: bool (Required): The value indicating whether to preserve interchange. +* **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. +* **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. + +## X12ProtocolSettings +### Properties +* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) (Required): The X12 agreement acknowledgement settings. +* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. +* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) (Required): The X12 agreement envelope settings. +* **framingSettings**: [X12FramingSettings](#x12framingsettings) (Required): The X12 agreement framing settings. +* **messageFilter**: [X12MessageFilter](#x12messagefilter) (Required): The X12 message filter for odata query. +* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. +* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) (Required): The X12 processing settings. +* **schemaReferences**: [X12SchemaReference](#x12schemareference)[] (Required): The X12 schema references. +* **securitySettings**: [X12SecuritySettings](#x12securitysettings) (Required): The X12 agreement security settings. +* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. +* **validationSettings**: [X12ValidationSettings](#x12validationsettings) (Required): The X12 agreement validation settings. +* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. + +## X12SchemaReference +### Properties +* **messageId**: string (Required): The message id. +* **schemaName**: string (Required): The schema name. +* **schemaVersion**: string (Required): The schema version. +* **senderApplicationId**: string: The sender application id. + +## X12SecuritySettings +### Properties +* **authorizationQualifier**: string (Required): The authorization qualifier. +* **authorizationValue**: string: The authorization value. +* **passwordValue**: string: The password value. +* **securityQualifier**: string (Required): The security qualifier. + +## X12ValidationOverride +### Properties +* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. +* **messageId**: string (Required): The message id on which the validation settings has to be applied. +* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' (Required) +* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. +* **validateCharacterSet**: bool (Required): The value indicating whether to validate character Set. +* **validateEdiTypes**: bool (Required): The value indicating whether to validate EDI types. +* **validateXsdTypes**: bool (Required): The value indicating whether to validate XSD types. + +## X12ValidationSettings +### Properties +* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. +* **checkDuplicateGroupControlNumber**: bool (Required): The value indicating whether to check for duplicate group control number. +* **checkDuplicateInterchangeControlNumber**: bool (Required): The value indicating whether to check for duplicate interchange control number. +* **checkDuplicateTransactionSetControlNumber**: bool (Required): The value indicating whether to check for duplicate transaction set control number. +* **interchangeControlNumberValidityDays**: int (Required): The validity period of interchange control number. +* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' (Required) +* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. +* **validateCharacterSet**: bool (Required): The value indicating whether to validate character set in the message. +* **validateEdiTypes**: bool (Required): The value indicating whether to Whether to validate EDI types. +* **validateXsdTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. diff --git a/generated/logic/microsoft.logic/2018-07-01-preview/types.md b/generated/logic/microsoft.logic/2018-07-01-preview/types.md index cd6666880f..a04a2816b0 100644 --- a/generated/logic/microsoft.logic/2018-07-01-preview/types.md +++ b/generated/logic/microsoft.logic/2018-07-01-preview/types.md @@ -184,54 +184,12 @@ * **ApiVersion**: 2018-07-01-preview * **Output**: any -## IntegrationAccountSku -### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Standard' | string (Required) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountAgreementProperties -### Properties -* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' (Required) -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [AgreementContent](#agreementcontent) (Required): The integration account agreement content. -* **createdTime**: string (ReadOnly): The created time. -* **guestIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **guestPartner**: string (Required): The integration account partner that is set as guest partner for this agreement. -* **hostIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **hostPartner**: string (Required): The integration account partner that is set as host partner for this agreement. -* **metadata**: any: Any object - ## AgreementContent ### Properties * **aS2**: [AS2AgreementContent](#as2agreementcontent): The integration account AS2 agreement content. * **edifact**: [EdifactAgreementContent](#edifactagreementcontent): The Edifact agreement content. * **x12**: [X12AgreementContent](#x12agreementcontent): The X12 agreement content. -## AS2AgreementContent -### Properties -* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. -* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. - -## AS2OneWayAgreement -### Properties -* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) (Required): The AS2 agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. - -## AS2ProtocolSettings -### Properties -* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) (Required): The AS2 agreement acknowledgement connection settings. -* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) (Required): The AS2 agreement envelope settings. -* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) (Required): The AS2 agreement error settings. -* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) (Required): The AS2 agreement mdn settings. -* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) (Required): The AS2 agreement message connection settings. -* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) (Required): The AS2 agreement security settings. -* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) (Required): The AS2 agreement validation settings. - ## AS2AcknowledgementConnectionSettings ### Properties * **ignoreCertificateNameMismatch**: bool (Required): The value indicating whether to ignore mismatch in certificate name. @@ -239,6 +197,11 @@ * **supportHttpStatusCodeContinue**: bool (Required): The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool (Required): The value indicating whether to unfold the HTTP headers. +## AS2AgreementContent +### Properties +* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. +* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. + ## AS2EnvelopeSettings ### Properties * **autogenerateFileName**: bool (Required): The value indicating whether to auto generate file name. @@ -271,6 +234,22 @@ * **supportHttpStatusCodeContinue**: bool (Required): The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool (Required): The value indicating whether to unfold the HTTP headers. +## AS2OneWayAgreement +### Properties +* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) (Required): The AS2 agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + +## AS2ProtocolSettings +### Properties +* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) (Required): The AS2 agreement acknowledgement connection settings. +* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) (Required): The AS2 agreement envelope settings. +* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) (Required): The AS2 agreement error settings. +* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) (Required): The AS2 agreement mdn settings. +* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) (Required): The AS2 agreement message connection settings. +* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) (Required): The AS2 agreement security settings. +* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) (Required): The AS2 agreement validation settings. + ## AS2SecuritySettings ### Properties * **enableNRRForInboundDecodedMessages**: bool (Required): The value indicating whether to enable NRR for inbound decoded messages. @@ -297,35 +276,64 @@ * **signingAlgorithm**: 'Default' | 'NotSpecified' | 'SHA1' | 'SHA2256' | 'SHA2384' | 'SHA2512' | string * **signMessage**: bool (Required): The value indicating whether the message has to be signed. +## AssemblyProperties +### Properties +* **assemblyCulture**: string: The assembly culture. +* **assemblyName**: string (Required): The assembly name. +* **assemblyPublicKeyToken**: string: The assembly public key token. +* **assemblyVersion**: string: The assembly version. +* **changedTime**: string: The artifact changed time. +* **content**: any: Anything +* **contentLink**: [ContentLink](#contentlink): The content link. +* **contentType**: string: The content type. +* **createdTime**: string: The artifact creation time. +* **metadata**: any: Anything + +## AzureResourceErrorInfo +### Properties +* **code**: string (ReadOnly): The error code. +* **details**: [AzureResourceErrorInfo](#azureresourceerrorinfo)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. + +## B2BPartnerContent +### Properties +* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. + +## BatchConfigurationProperties +### Properties +* **batchGroupName**: string (Required): The name of the batch group. +* **changedTime**: string: The artifact changed time. +* **createdTime**: string: The artifact creation time. +* **metadata**: any: Anything +* **releaseCriteria**: [BatchReleaseCriteria](#batchreleasecriteria) (Required): The batch release criteria. + +## BatchReleaseCriteria +### Properties +* **batchSize**: int: The batch size in bytes. +* **messageCount**: int: The message count. +* **recurrence**: [WorkflowTriggerRecurrence](#workflowtriggerrecurrence): The workflow trigger recurrence. + ## BusinessIdentity ### Properties * **qualifier**: string (Required): The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * **value**: string (Required): The user defined business identity value. -## EdifactAgreementContent +## CallbackUrl ### Properties -* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. -* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. +* **value**: string (ReadOnly): The URL value. -## EdifactOneWayAgreement +## ContentHash ### Properties -* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) (Required): The Edifact agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **algorithm**: string: The algorithm of the content hash. +* **value**: string: The value of the content hash. -## EdifactProtocolSettings +## ContentLink ### Properties -* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) (Required): The Edifact agreement acknowledgement settings. -* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. -* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. -* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) (Required): The Edifact agreement envelope settings. -* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) (Required): The Edifact agreement framing settings. -* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) (Required): The Edifact message filter for odata query. -* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. -* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) (Required): The Edifact agreement protocol settings. -* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[] (Required): The EDIFACT schema references. -* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. -* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) (Required): The Edifact agreement validation settings. +* **contentHash**: [ContentHash](#contenthash): The content hash. +* **contentSize**: int: The content size. +* **contentVersion**: string: The content version. +* **metadata**: any: Any object +* **uri**: string: The content link URI. ## EdifactAcknowledgementSettings ### Properties @@ -341,6 +349,11 @@ * **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. * **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. +## EdifactAgreementContent +### Properties +* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. +* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. + ## EdifactDelimiterOverride ### Properties * **componentSeparator**: int (Required): The component separator. @@ -440,6 +453,12 @@ ### Properties * **messageId**: string (Required): The message id on which this envelope settings has to be applied. +## EdifactOneWayAgreement +### Properties +* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) (Required): The Edifact agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + ## EdifactProcessingSettings ### Properties * **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. @@ -448,6 +467,20 @@ * **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. * **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. +## EdifactProtocolSettings +### Properties +* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) (Required): The Edifact agreement acknowledgement settings. +* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. +* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. +* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) (Required): The Edifact agreement envelope settings. +* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) (Required): The Edifact agreement framing settings. +* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) (Required): The Edifact message filter for odata query. +* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. +* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) (Required): The Edifact agreement protocol settings. +* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[] (Required): The EDIFACT schema references. +* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. +* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) (Required): The Edifact agreement validation settings. + ## EdifactSchemaReference ### Properties * **associationAssignedCode**: string: The association assigned code. @@ -481,224 +514,172 @@ * **validateEDITypes**: bool (Required): The value indicating whether to Whether to validate EDI types. * **validateXSDTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. -## X12AgreementContent +## Expression ### Properties -* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. -* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. +* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. +* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression +* **text**: string (ReadOnly) +* **value**: any (ReadOnly): Anything -## X12OneWayAgreement +## ExpressionRoot ### Properties -* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) (Required): The X12 agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. +* **path**: string (ReadOnly): The path. +* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression +* **text**: string (ReadOnly) +* **value**: any (ReadOnly): Anything -## X12ProtocolSettings +## ExpressionTraces ### Properties -* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) (Required): The X12 agreement acknowledgement settings. -* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. -* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) (Required): The X12 agreement envelope settings. -* **framingSettings**: [X12FramingSettings](#x12framingsettings) (Required): The X12 agreement framing settings. -* **messageFilter**: [X12MessageFilter](#x12messagefilter) (Required): The X12 message filter for odata query. -* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. -* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) (Required): The X12 processing settings. -* **schemaReferences**: [X12SchemaReference](#x12schemareference)[] (Required): The X12 schema references. -* **securitySettings**: [X12SecuritySettings](#x12securitysettings) (Required): The X12 agreement security settings. -* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. -* **validationSettings**: [X12ValidationSettings](#x12validationsettings) (Required): The X12 agreement validation settings. -* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. +* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot -## X12AcknowledgementSettings +## ExpressionTraces ### Properties -* **acknowledgementControlNumberLowerBound**: int (Required): The acknowledgement control number lower bound. -* **acknowledgementControlNumberPrefix**: string: The acknowledgement control number prefix. -* **acknowledgementControlNumberSuffix**: string: The acknowledgement control number suffix. -* **acknowledgementControlNumberUpperBound**: int (Required): The acknowledgement control number upper bound. -* **batchFunctionalAcknowledgements**: bool (Required): The value indicating whether to batch functional acknowledgements. -* **batchImplementationAcknowledgements**: bool (Required): The value indicating whether to batch implementation acknowledgements. -* **batchTechnicalAcknowledgements**: bool (Required): The value indicating whether to batch the technical acknowledgements. -* **functionalAcknowledgementVersion**: string: The functional acknowledgement version. -* **implementationAcknowledgementVersion**: string: The implementation acknowledgement version. -* **needFunctionalAcknowledgement**: bool (Required): The value indicating whether functional acknowledgement is needed. -* **needImplementationAcknowledgement**: bool (Required): The value indicating whether implementation acknowledgement is needed. -* **needLoopForValidMessages**: bool (Required): The value indicating whether a loop is needed for valid messages. -* **needTechnicalAcknowledgement**: bool (Required): The value indicating whether technical acknowledgement is needed. -* **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. -* **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. +* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot -## X12EnvelopeOverride +## GetCallbackUrlParameters ### Properties -* **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required) -* **functionalIdentifierCode**: string: The functional identifier code. -* **headerVersion**: string (Required): The header version. -* **messageId**: string (Required): The message id on which this envelope settings has to be applied. -* **protocolVersion**: string (Required): The protocol version on which this envelope settings has to be applied. -* **receiverApplicationId**: string (Required): The receiver application id. -* **responsibleAgencyCode**: string (Required): The responsible agency code. -* **senderApplicationId**: string (Required): The sender application id. -* **targetNamespace**: string (Required): The target namespace on which this envelope settings has to be applied. -* **timeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required) +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12EnvelopeSettings +## GetCallbackUrlParameters ### Properties -* **controlStandardsId**: int (Required): The controls standards id. -* **controlVersionNumber**: string (Required): The control version number. -* **enableDefaultGroupHeaders**: bool (Required): The value indicating whether to enable default group headers. -* **functionalGroupId**: string: The functional group id. -* **groupControlNumberLowerBound**: int (Required): The group control number lower bound. -* **groupControlNumberUpperBound**: int (Required): The group control number upper bound. -* **groupHeaderAgencyCode**: string (Required): The group header agency code. -* **groupHeaderDateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required) -* **groupHeaderTimeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required) -* **groupHeaderVersion**: string (Required): The group header version. -* **interchangeControlNumberLowerBound**: int (Required): The interchange control number lower bound. -* **interchangeControlNumberUpperBound**: int (Required): The interchange control number upper bound. -* **overwriteExistingTransactionSetControlNumber**: bool (Required): The value indicating whether to overwrite existing transaction set control number. -* **receiverApplicationId**: string (Required): The receiver application id. -* **rolloverGroupControlNumber**: bool (Required): The value indicating whether to rollover group control number. -* **rolloverInterchangeControlNumber**: bool (Required): The value indicating whether to rollover interchange control number. -* **rolloverTransactionSetControlNumber**: bool (Required): The value indicating whether to rollover transaction set control number. -* **senderApplicationId**: string (Required): The sender application id. -* **transactionSetControlNumberLowerBound**: int (Required): The transaction set control number lower bound. -* **transactionSetControlNumberPrefix**: string: The transaction set control number prefix. -* **transactionSetControlNumberSuffix**: string: The transaction set control number suffix. -* **transactionSetControlNumberUpperBound**: int (Required): The transaction set control number upper bound. -* **usageIndicator**: 'Information' | 'NotSpecified' | 'Production' | 'Test' | string (Required) -* **useControlStandardsIdAsRepetitionCharacter**: bool (Required): The value indicating whether to use control standards id as repetition character. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12FramingSettings +## GetCallbackUrlParameters ### Properties -* **characterSet**: 'Basic' | 'Extended' | 'NotSpecified' | 'UTF8' | string (Required) -* **componentSeparator**: int (Required): The component separator. -* **dataElementSeparator**: int (Required): The data element separator. -* **replaceCharacter**: int (Required): The replacement character. -* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. -* **segmentTerminator**: int (Required): The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12MessageFilter +## GetCallbackUrlParameters ### Properties -* **messageFilterType**: 'Exclude' | 'Include' | 'NotSpecified' | string (Required) +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12MessageIdentifier +## GetCallbackUrlParameters ### Properties -* **messageId**: string (Required): The message id. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12ProcessingSettings +## GetCallbackUrlParameters ### Properties -* **convertImpliedDecimal**: bool (Required): The value indicating whether to convert numerical type to implied decimal. -* **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. -* **maskSecurityInfo**: bool (Required): The value indicating whether to mask security information. -* **preserveInterchange**: bool (Required): The value indicating whether to preserve interchange. -* **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. -* **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12SchemaReference +## GetCallbackUrlParameters ### Properties -* **messageId**: string (Required): The message id. -* **schemaName**: string (Required): The schema name. -* **schemaVersion**: string (Required): The schema version. -* **senderApplicationId**: string: The sender application id. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) +* **notAfter**: string (WriteOnly): The expiry time. -## X12SecuritySettings +## IntegrationAccountAgreementProperties ### Properties -* **authorizationQualifier**: string (Required): The authorization qualifier. -* **authorizationValue**: string: The authorization value. -* **passwordValue**: string: The password value. -* **securityQualifier**: string (Required): The security qualifier. +* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' (Required) +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [AgreementContent](#agreementcontent) (Required): The integration account agreement content. +* **createdTime**: string (ReadOnly): The created time. +* **guestIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **guestPartner**: string (Required): The integration account partner that is set as guest partner for this agreement. +* **hostIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **hostPartner**: string (Required): The integration account partner that is set as host partner for this agreement. +* **metadata**: any: Any object -## X12ValidationOverride +## IntegrationAccountCertificateProperties ### Properties -* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. -* **messageId**: string (Required): The message id on which the validation settings has to be applied. -* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required) -* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. -* **validateCharacterSet**: bool (Required): The value indicating whether to validate character Set. -* **validateEDITypes**: bool (Required): The value indicating whether to validate EDI types. -* **validateXSDTypes**: bool (Required): The value indicating whether to validate XSD types. +* **changedTime**: string (ReadOnly): The changed time. +* **createdTime**: string (ReadOnly): The created time. +* **key**: [KeyVaultKeyReference](#keyvaultkeyreference): The reference to the key vault key. +* **metadata**: any: Any object +* **publicCertificate**: string: The public certificate. -## X12ValidationSettings +## IntegrationAccountMapProperties ### Properties -* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. -* **checkDuplicateGroupControlNumber**: bool (Required): The value indicating whether to check for duplicate group control number. -* **checkDuplicateInterchangeControlNumber**: bool (Required): The value indicating whether to check for duplicate interchange control number. -* **checkDuplicateTransactionSetControlNumber**: bool (Required): The value indicating whether to check for duplicate transaction set control number. -* **interchangeControlNumberValidityDays**: int (Required): The validity period of interchange control number. -* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required) -* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. -* **validateCharacterSet**: bool (Required): The value indicating whether to validate character set in the message. -* **validateEDITypes**: bool (Required): The value indicating whether to Whether to validate EDI types. -* **validateXSDTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: string: The content. +* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. +* **contentType**: string: The content type. +* **createdTime**: string (ReadOnly): The created time. +* **mapType**: 'Liquid' | 'NotSpecified' | 'Xslt' | 'Xslt20' | 'Xslt30' | string (Required) +* **metadata**: any: Any object +* **parametersSchema**: [IntegrationAccountMapPropertiesParametersSchema](#integrationaccountmappropertiesparametersschema): The parameters schema of integration account map. -## X12DelimiterOverrides +## IntegrationAccountMapPropertiesParametersSchema ### Properties -* **componentSeparator**: int (Required): The component separator. -* **dataElementSeparator**: int (Required): The data element separator. -* **messageId**: string: The message id. -* **protocolVersion**: string: The protocol version. -* **replaceCharacter**: int (Required): The replacement character. -* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. -* **segmentTerminator**: int (Required): The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) -* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. +* **ref**: string: The reference name. -## ResourceTags +## IntegrationAccountPartnerProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [PartnerContent](#partnercontent) (Required): The integration account partner content. +* **createdTime**: string (ReadOnly): The created time. +* **metadata**: any: Any object +* **partnerType**: 'B2B' | 'NotSpecified' | string (Required) -## AssemblyProperties +## IntegrationAccountSchemaProperties ### Properties -* **assemblyCulture**: string: The assembly culture. -* **assemblyName**: string (Required): The assembly name. -* **assemblyPublicKeyToken**: string: The assembly public key token. -* **assemblyVersion**: string: The assembly version. -* **changedTime**: string: The artifact changed time. -* **content**: any: Anything -* **contentLink**: [ContentLink](#contentlink): The content link. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: string: The content. +* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. * **contentType**: string: The content type. -* **createdTime**: string: The artifact creation time. -* **metadata**: any: Anything +* **createdTime**: string (ReadOnly): The created time. +* **documentName**: string: The document name. +* **fileName**: string: The file name. +* **metadata**: any: Any object +* **schemaType**: 'NotSpecified' | 'Xml' | string (Required) +* **targetNamespace**: string: The target namespace of the schema. -## ContentLink +## IntegrationAccountSessionProperties ### Properties -* **contentHash**: [ContentHash](#contenthash): The content hash. -* **contentSize**: int: The content size. -* **contentVersion**: string: The content version. -* **metadata**: any: Any object -* **uri**: string: The content link URI. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: any: Any object +* **createdTime**: string (ReadOnly): The created time. -## ContentHash +## IntegrationAccountSku ### Properties -* **algorithm**: string: The algorithm of the content hash. -* **value**: string: The value of the content hash. +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Standard' | string (Required) -## ResourceTags +## KeyVaultKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **attributes**: [KeyVaultKeyAttributes](#keyvaultkeyattributes) (ReadOnly): The key attributes. +* **kid**: string (ReadOnly): The key id. -## BatchConfigurationProperties +## KeyVaultKeyAttributes ### Properties -* **batchGroupName**: string (Required): The name of the batch group. -* **changedTime**: string: The artifact changed time. -* **createdTime**: string: The artifact creation time. -* **metadata**: any: Anything -* **releaseCriteria**: [BatchReleaseCriteria](#batchreleasecriteria) (Required): The batch release criteria. +* **created**: int (ReadOnly): When the key was created. +* **enabled**: bool (ReadOnly): Whether the key is enabled or not. +* **updated**: int (ReadOnly): When the key was updated. -## BatchReleaseCriteria +## KeyVaultKeyCollection ### Properties -* **batchSize**: int: The batch size in bytes. -* **messageCount**: int: The message count. -* **recurrence**: [WorkflowTriggerRecurrence](#workflowtriggerrecurrence): The workflow trigger recurrence. +* **skipToken**: string (ReadOnly): The skip token. +* **value**: [KeyVaultKey](#keyvaultkey)[] (ReadOnly): The key vault keys. -## WorkflowTriggerRecurrence +## KeyVaultKeyReference ### Properties -* **endTime**: string: The end time. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' | string -* **interval**: int: The interval. -* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. -* **startTime**: string: The start time. -* **timeZone**: string: The time zone. +* **keyName**: string (Required): The private key name in key vault. +* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault) (Required): The key vault reference. +* **keyVersion**: string: The private key version in key vault. + +## KeyVaultKeyReferenceKeyVault +### Properties +* **id**: string: The resource id. +* **name**: string (ReadOnly): The resource name. +* **type**: string (ReadOnly): The resource type. + +## KeyVaultReference +### Properties +* **id**: string (WriteOnly): The resource id. +* **name**: string (ReadOnly, WriteOnly): Gets the resource name. +* **type**: string (ReadOnly, WriteOnly): Gets the resource type. + +## ListKeyVaultKeysDefinition +### Properties +* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required, WriteOnly): The key vault reference. +* **skipToken**: string (WriteOnly): The skip token. + +## PartnerContent +### Properties +* **b2b**: [B2BPartnerContent](#b2bpartnercontent): The B2B partner content. ## RecurrenceSchedule ### Properties @@ -713,151 +694,91 @@ * **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' * **occurrence**: int: The occurrence. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## IntegrationAccountCertificateProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **createdTime**: string (ReadOnly): The created time. -* **key**: [KeyVaultKeyReference](#keyvaultkeyreference): The reference to the key vault key. -* **metadata**: any: Any object -* **publicCertificate**: string: The public certificate. - -## KeyVaultKeyReference -### Properties -* **keyName**: string (Required): The private key name in key vault. -* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault) (Required): The key vault reference. -* **keyVersion**: string: The private key version in key vault. - -## KeyVaultKeyReferenceKeyVault +## ResourceReference ### Properties * **id**: string: The resource id. -* **name**: string (ReadOnly): The resource name. -* **type**: string (ReadOnly): The resource type. +* **name**: string (ReadOnly): Gets the resource name. +* **type**: string (ReadOnly): Gets the resource type. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountMapProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: string: The content. -* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. -* **contentType**: string: The content type. -* **createdTime**: string (ReadOnly): The created time. -* **mapType**: 'Liquid' | 'NotSpecified' | 'Xslt' | 'Xslt20' | 'Xslt30' | string (Required) -* **metadata**: any: Any object -* **parametersSchema**: [IntegrationAccountMapPropertiesParametersSchema](#integrationaccountmappropertiesparametersschema): The parameters schema of integration account map. - -## IntegrationAccountMapPropertiesParametersSchema -### Properties -* **ref**: string: The reference name. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountPartnerProperties -### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [PartnerContent](#partnercontent) (Required): The integration account partner content. -* **createdTime**: string (ReadOnly): The created time. -* **metadata**: any: Any object -* **partnerType**: 'B2B' | 'NotSpecified' | string (Required) - -## PartnerContent -### Properties -* **b2b**: [B2BPartnerContent](#b2bpartnercontent): The B2B partner content. - -## B2BPartnerContent +## ResourceTags ### Properties -* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountSchemaProperties +## ResourceTags ### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: string: The content. -* **contentLink**: [ContentLink](#contentlink) (ReadOnly): The content link. -* **contentType**: string: The content type. -* **createdTime**: string (ReadOnly): The created time. -* **documentName**: string: The document name. -* **fileName**: string: The file name. -* **metadata**: any: Any object -* **schemaType**: 'NotSpecified' | 'Xml' | string (Required) -* **targetNamespace**: string: The target namespace of the schema. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IntegrationAccountSessionProperties +## ResourceTags ### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: any: Any object -* **createdTime**: string (ReadOnly): The created time. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkflowProperties +## ResourceTags ### Properties -* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. -* **changedTime**: string (ReadOnly): Gets the changed time. -* **createdTime**: string (ReadOnly): Gets the created time. -* **definition**: any: Any object -* **integrationAccount**: [ResourceReference](#resourcereference): The resource reference. -* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): The parameters. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'NotSpecified' | 'Ready' | 'Registered' | 'Registering' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | string (ReadOnly) -* **sku**: [Sku](#sku): The sku type. -* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string -* **version**: string (ReadOnly): Gets the version. +### Additional Properties +* **Additional Properties Type**: string -## ResourceReference +## ResourceTags ### Properties -* **id**: string: The resource id. -* **name**: string (ReadOnly): Gets the resource name. -* **type**: string (ReadOnly): Gets the resource type. +### Additional Properties +* **Additional Properties Type**: string -## WorkflowPropertiesParameters +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' | string (Required): The sku name. +* **plan**: [ResourceReference](#resourcereference): The resource reference. ## WorkflowParameter ### Properties * **description**: string: The description. * **metadata**: any: Any object * **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'NotSpecified' | 'Object' | 'SecureObject' | 'SecureString' | 'String' | string -* **value**: any: Any object - -## Sku -### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' | string (Required): The sku name. -* **plan**: [ResourceReference](#resourcereference): The resource reference. +* **value**: any: Any object -## ResourceTags +## WorkflowProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. +* **changedTime**: string (ReadOnly): Gets the changed time. +* **createdTime**: string (ReadOnly): Gets the created time. +* **definition**: any: Any object +* **integrationAccount**: [ResourceReference](#resourcereference): The resource reference. +* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): The parameters. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Moving' | 'NotSpecified' | 'Ready' | 'Registered' | 'Registering' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | string (ReadOnly) +* **sku**: [Sku](#sku): The sku type. +* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string +* **version**: string (ReadOnly): Gets the version. -## GetCallbackUrlParameters +## WorkflowPropertiesParameters ### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. +### Additional Properties +* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) ## WorkflowTriggerCallbackUrl ### Properties @@ -868,14 +789,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## WorkflowTriggerListCallbackUrlQueries -### Properties -* **api-version**: string (ReadOnly): The api version. -* **se**: string (ReadOnly): The SAS timestamp. -* **sig**: string (ReadOnly): The SAS signature. -* **sp**: string (ReadOnly): The SAS permissions. -* **sv**: string (ReadOnly): The SAS version. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -885,11 +798,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -899,15 +807,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - -## CallbackUrl -### Properties -* **value**: string (ReadOnly): The URL value. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -917,11 +816,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -931,11 +825,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -945,11 +834,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -959,11 +843,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly) -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -973,59 +852,180 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## ExpressionTraces +## WorkflowTriggerListCallbackUrlQueries ### Properties -* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot +* **api-version**: string (ReadOnly): The api version. +* **se**: string (ReadOnly): The SAS timestamp. +* **sig**: string (ReadOnly): The SAS signature. +* **sp**: string (ReadOnly): The SAS permissions. +* **sv**: string (ReadOnly): The SAS version. -## ExpressionRoot +## WorkflowTriggerRecurrence ### Properties -* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. -* **path**: string (ReadOnly): The path. -* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression -* **text**: string (ReadOnly) -* **value**: any (ReadOnly): Anything +* **endTime**: string: The end time. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' | string +* **interval**: int: The interval. +* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. +* **startTime**: string: The start time. +* **timeZone**: string: The time zone. -## AzureResourceErrorInfo +## X12AcknowledgementSettings ### Properties -* **code**: string (ReadOnly): The error code. -* **details**: [AzureResourceErrorInfo](#azureresourceerrorinfo)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. +* **acknowledgementControlNumberLowerBound**: int (Required): The acknowledgement control number lower bound. +* **acknowledgementControlNumberPrefix**: string: The acknowledgement control number prefix. +* **acknowledgementControlNumberSuffix**: string: The acknowledgement control number suffix. +* **acknowledgementControlNumberUpperBound**: int (Required): The acknowledgement control number upper bound. +* **batchFunctionalAcknowledgements**: bool (Required): The value indicating whether to batch functional acknowledgements. +* **batchImplementationAcknowledgements**: bool (Required): The value indicating whether to batch implementation acknowledgements. +* **batchTechnicalAcknowledgements**: bool (Required): The value indicating whether to batch the technical acknowledgements. +* **functionalAcknowledgementVersion**: string: The functional acknowledgement version. +* **implementationAcknowledgementVersion**: string: The implementation acknowledgement version. +* **needFunctionalAcknowledgement**: bool (Required): The value indicating whether functional acknowledgement is needed. +* **needImplementationAcknowledgement**: bool (Required): The value indicating whether implementation acknowledgement is needed. +* **needLoopForValidMessages**: bool (Required): The value indicating whether a loop is needed for valid messages. +* **needTechnicalAcknowledgement**: bool (Required): The value indicating whether technical acknowledgement is needed. +* **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. +* **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. -## Expression +## X12AgreementContent ### Properties -* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. -* **subexpressions**: [Expression](#expression)[] (ReadOnly): Array of Expression -* **text**: string (ReadOnly) -* **value**: any (ReadOnly): Anything +* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. +* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. -## ExpressionTraces +## X12DelimiterOverrides ### Properties -* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot +* **componentSeparator**: int (Required): The component separator. +* **dataElementSeparator**: int (Required): The data element separator. +* **messageId**: string: The message id. +* **protocolVersion**: string: The protocol version. +* **replaceCharacter**: int (Required): The replacement character. +* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. +* **segmentTerminator**: int (Required): The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) +* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. -## ListKeyVaultKeysDefinition +## X12EnvelopeOverride ### Properties -* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required, WriteOnly): The key vault reference. -* **skipToken**: string (WriteOnly): The skip token. +* **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required) +* **functionalIdentifierCode**: string: The functional identifier code. +* **headerVersion**: string (Required): The header version. +* **messageId**: string (Required): The message id on which this envelope settings has to be applied. +* **protocolVersion**: string (Required): The protocol version on which this envelope settings has to be applied. +* **receiverApplicationId**: string (Required): The receiver application id. +* **responsibleAgencyCode**: string (Required): The responsible agency code. +* **senderApplicationId**: string (Required): The sender application id. +* **targetNamespace**: string (Required): The target namespace on which this envelope settings has to be applied. +* **timeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required) -## KeyVaultReference +## X12EnvelopeSettings ### Properties -* **id**: string (WriteOnly): The resource id. -* **name**: string (ReadOnly, WriteOnly): Gets the resource name. -* **type**: string (ReadOnly, WriteOnly): Gets the resource type. +* **controlStandardsId**: int (Required): The controls standards id. +* **controlVersionNumber**: string (Required): The control version number. +* **enableDefaultGroupHeaders**: bool (Required): The value indicating whether to enable default group headers. +* **functionalGroupId**: string: The functional group id. +* **groupControlNumberLowerBound**: int (Required): The group control number lower bound. +* **groupControlNumberUpperBound**: int (Required): The group control number upper bound. +* **groupHeaderAgencyCode**: string (Required): The group header agency code. +* **groupHeaderDateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required) +* **groupHeaderTimeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required) +* **groupHeaderVersion**: string (Required): The group header version. +* **interchangeControlNumberLowerBound**: int (Required): The interchange control number lower bound. +* **interchangeControlNumberUpperBound**: int (Required): The interchange control number upper bound. +* **overwriteExistingTransactionSetControlNumber**: bool (Required): The value indicating whether to overwrite existing transaction set control number. +* **receiverApplicationId**: string (Required): The receiver application id. +* **rolloverGroupControlNumber**: bool (Required): The value indicating whether to rollover group control number. +* **rolloverInterchangeControlNumber**: bool (Required): The value indicating whether to rollover interchange control number. +* **rolloverTransactionSetControlNumber**: bool (Required): The value indicating whether to rollover transaction set control number. +* **senderApplicationId**: string (Required): The sender application id. +* **transactionSetControlNumberLowerBound**: int (Required): The transaction set control number lower bound. +* **transactionSetControlNumberPrefix**: string: The transaction set control number prefix. +* **transactionSetControlNumberSuffix**: string: The transaction set control number suffix. +* **transactionSetControlNumberUpperBound**: int (Required): The transaction set control number upper bound. +* **usageIndicator**: 'Information' | 'NotSpecified' | 'Production' | 'Test' | string (Required) +* **useControlStandardsIdAsRepetitionCharacter**: bool (Required): The value indicating whether to use control standards id as repetition character. -## KeyVaultKeyCollection +## X12FramingSettings ### Properties -* **skipToken**: string (ReadOnly): The skip token. -* **value**: [KeyVaultKey](#keyvaultkey)[] (ReadOnly): The key vault keys. +* **characterSet**: 'Basic' | 'Extended' | 'NotSpecified' | 'UTF8' | string (Required) +* **componentSeparator**: int (Required): The component separator. +* **dataElementSeparator**: int (Required): The data element separator. +* **replaceCharacter**: int (Required): The replacement character. +* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. +* **segmentTerminator**: int (Required): The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required) -## KeyVaultKey +## X12MessageFilter ### Properties -* **attributes**: [KeyVaultKeyAttributes](#keyvaultkeyattributes) (ReadOnly): The key attributes. -* **kid**: string (ReadOnly): The key id. +* **messageFilterType**: 'Exclude' | 'Include' | 'NotSpecified' | string (Required) -## KeyVaultKeyAttributes +## X12MessageIdentifier ### Properties -* **created**: int (ReadOnly): When the key was created. -* **enabled**: bool (ReadOnly): Whether the key is enabled or not. -* **updated**: int (ReadOnly): When the key was updated. +* **messageId**: string (Required): The message id. + +## X12OneWayAgreement +### Properties +* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) (Required): The X12 agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + +## X12ProcessingSettings +### Properties +* **convertImpliedDecimal**: bool (Required): The value indicating whether to convert numerical type to implied decimal. +* **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. +* **maskSecurityInfo**: bool (Required): The value indicating whether to mask security information. +* **preserveInterchange**: bool (Required): The value indicating whether to preserve interchange. +* **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. +* **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. + +## X12ProtocolSettings +### Properties +* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) (Required): The X12 agreement acknowledgement settings. +* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. +* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) (Required): The X12 agreement envelope settings. +* **framingSettings**: [X12FramingSettings](#x12framingsettings) (Required): The X12 agreement framing settings. +* **messageFilter**: [X12MessageFilter](#x12messagefilter) (Required): The X12 message filter for odata query. +* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. +* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) (Required): The X12 processing settings. +* **schemaReferences**: [X12SchemaReference](#x12schemareference)[] (Required): The X12 schema references. +* **securitySettings**: [X12SecuritySettings](#x12securitysettings) (Required): The X12 agreement security settings. +* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. +* **validationSettings**: [X12ValidationSettings](#x12validationsettings) (Required): The X12 agreement validation settings. +* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. + +## X12SchemaReference +### Properties +* **messageId**: string (Required): The message id. +* **schemaName**: string (Required): The schema name. +* **schemaVersion**: string (Required): The schema version. +* **senderApplicationId**: string: The sender application id. + +## X12SecuritySettings +### Properties +* **authorizationQualifier**: string (Required): The authorization qualifier. +* **authorizationValue**: string: The authorization value. +* **passwordValue**: string: The password value. +* **securityQualifier**: string (Required): The security qualifier. + +## X12ValidationOverride +### Properties +* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. +* **messageId**: string (Required): The message id on which the validation settings has to be applied. +* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required) +* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. +* **validateCharacterSet**: bool (Required): The value indicating whether to validate character Set. +* **validateEDITypes**: bool (Required): The value indicating whether to validate EDI types. +* **validateXSDTypes**: bool (Required): The value indicating whether to validate XSD types. + +## X12ValidationSettings +### Properties +* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. +* **checkDuplicateGroupControlNumber**: bool (Required): The value indicating whether to check for duplicate group control number. +* **checkDuplicateInterchangeControlNumber**: bool (Required): The value indicating whether to check for duplicate interchange control number. +* **checkDuplicateTransactionSetControlNumber**: bool (Required): The value indicating whether to check for duplicate transaction set control number. +* **interchangeControlNumberValidityDays**: int (Required): The validity period of interchange control number. +* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required) +* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. +* **validateCharacterSet**: bool (Required): The value indicating whether to validate character set in the message. +* **validateEDITypes**: bool (Required): The value indicating whether to Whether to validate EDI types. +* **validateXSDTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. diff --git a/generated/logic/microsoft.logic/2019-05-01/types.md b/generated/logic/microsoft.logic/2019-05-01/types.md index 6c8c82b44c..7e0087e567 100644 --- a/generated/logic/microsoft.logic/2019-05-01/types.md +++ b/generated/logic/microsoft.logic/2019-05-01/types.md @@ -209,64 +209,70 @@ * **ApiVersion**: 2019-05-01 * **Output**: any -## IntegrationAccountProperties +## AgreementContent ### Properties -* **integrationServiceEnvironment**: [ResourceReference](#resourcereference): The resource reference. -* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string: The workflow state. +* **aS2**: [AS2AgreementContent](#as2agreementcontent): The integration account AS2 agreement content. +* **edifact**: [EdifactAgreementContent](#edifactagreementcontent): The Edifact agreement content. +* **x12**: [X12AgreementContent](#x12agreementcontent): The X12 agreement content. -## ResourceReference +## ApiDeploymentParameterMetadata ### Properties -* **id**: string: The resource id. -* **name**: string (ReadOnly): Gets the resource name. -* **type**: string (ReadOnly): Gets the resource type. +* **description**: string: The description. +* **displayName**: string: The display name. +* **isRequired**: bool: Indicates whether its required. +* **type**: string: The type. +* **visibility**: 'Default' | 'Internal' | 'NotSpecified' | string: The Api deployment parameter visibility. -## IntegrationAccountSku +## ApiDeploymentParameterMetadataSet ### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Standard' | string (Required): The integration account sku name. +* **packageContentLink**: [ApiDeploymentParameterMetadata](#apideploymentparametermetadata): The API deployment parameter metadata. +* **redisCacheConnectionString**: [ApiDeploymentParameterMetadata](#apideploymentparametermetadata): The API deployment parameter metadata. -## ResourceTags +## ApiResourceBackendService ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **serviceUrl**: string: The service URL. -## IntegrationAccountAgreementProperties +## ApiResourceDefinitions ### Properties -* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' (Required): The agreement type. -* **changedTime**: string (ReadOnly): The changed time. -* **content**: [AgreementContent](#agreementcontent) (Required): The integration account agreement content. -* **createdTime**: string (ReadOnly): The created time. -* **guestIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **guestPartner**: string (Required): The integration account partner that is set as guest partner for this agreement. -* **hostIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **hostPartner**: string (Required): The integration account partner that is set as host partner for this agreement. -* **metadata**: any: Any object +* **modifiedSwaggerUrl**: string: The modified swagger url. +* **originalSwaggerUrl**: string: The original swagger url. -## AgreementContent +## ApiResourceGeneralInformation ### Properties -* **aS2**: [AS2AgreementContent](#as2agreementcontent): The integration account AS2 agreement content. -* **edifact**: [EdifactAgreementContent](#edifactagreementcontent): The Edifact agreement content. -* **x12**: [X12AgreementContent](#x12agreementcontent): The X12 agreement content. +* **description**: string: The description. +* **displayName**: string: The display name. +* **iconUrl**: string: The icon url. +* **releaseTag**: string: The release tag. +* **termsOfUseUrl**: string: The terms of use url. +* **tier**: 'Enterprise' | 'NotSpecified' | 'Premium' | 'Standard' | string: The Api tier. -## AS2AgreementContent +## ApiResourceMetadata ### Properties -* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. -* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. +* **ApiType**: 'NotSpecified' | 'Rest' | 'Soap' | string +* **brandColor**: string: The brand color. +* **connectionType**: string: The connection type. +* **deploymentParameters**: [ApiDeploymentParameterMetadataSet](#apideploymentparametermetadataset): The API deployment parameters metadata. +* **hideKey**: string: The hide key. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string: The workflow provisioning state. +* **source**: string: The source. +* **tags**: [ApiResourceMetadataTags](#apiresourcemetadatatags): The tags. +* **wsdlImportMethod**: 'NotSpecified' | 'SoapPassThrough' | 'SoapToRest' | string: The WSDL import method. +* **wsdlService**: [WsdlService](#wsdlservice): The WSDL service. -## AS2OneWayAgreement +## ApiResourceMetadataTags ### Properties -* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) (Required): The AS2 agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +### Additional Properties +* **Additional Properties Type**: string -## AS2ProtocolSettings +## ApiResourcePolicies ### Properties -* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) (Required): The AS2 agreement acknowledgement connection settings. -* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) (Required): The AS2 agreement envelope settings. -* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) (Required): The AS2 agreement error settings. -* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) (Required): The AS2 agreement mdn settings. -* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) (Required): The AS2 agreement message connection settings. -* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) (Required): The AS2 agreement security settings. -* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) (Required): The AS2 agreement validation settings. +* **content**: string: The API level only policies XML as embedded content. +* **contentLink**: string: The content link to the policies. + +## ApiResourcePropertiesConnectionParameters +### Properties +### Additional Properties +* **Additional Properties Type**: any ## AS2AcknowledgementConnectionSettings ### Properties @@ -275,6 +281,11 @@ * **supportHttpStatusCodeContinue**: bool (Required): Indicates whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool (Required): Indicates whether to unfold the HTTP headers. +## AS2AgreementContent +### Properties +* **receiveAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. +* **sendAgreement**: [AS2OneWayAgreement](#as2onewayagreement) (Required): The integration account AS2 one-way agreement. + ## AS2EnvelopeSettings ### Properties * **autogenerateFileName**: bool (Required): The value indicating whether to auto generate file name. @@ -307,6 +318,22 @@ * **supportHttpStatusCodeContinue**: bool (Required): The value indicating whether to support HTTP status code 'CONTINUE'. * **unfoldHttpHeaders**: bool (Required): The value indicating whether to unfold the HTTP headers. +## AS2OneWayAgreement +### Properties +* **protocolSettings**: [AS2ProtocolSettings](#as2protocolsettings) (Required): The AS2 agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + +## AS2ProtocolSettings +### Properties +* **acknowledgementConnectionSettings**: [AS2AcknowledgementConnectionSettings](#as2acknowledgementconnectionsettings) (Required): The AS2 agreement acknowledgement connection settings. +* **envelopeSettings**: [AS2EnvelopeSettings](#as2envelopesettings) (Required): The AS2 agreement envelope settings. +* **errorSettings**: [AS2ErrorSettings](#as2errorsettings) (Required): The AS2 agreement error settings. +* **mdnSettings**: [AS2MdnSettings](#as2mdnsettings) (Required): The AS2 agreement mdn settings. +* **messageConnectionSettings**: [AS2MessageConnectionSettings](#as2messageconnectionsettings) (Required): The AS2 agreement message connection settings. +* **securitySettings**: [AS2SecuritySettings](#as2securitysettings) (Required): The AS2 agreement security settings. +* **validationSettings**: [AS2ValidationSettings](#as2validationsettings) (Required): The AS2 agreement validation settings. + ## AS2SecuritySettings ### Properties * **enableNRRForInboundDecodedMessages**: bool (Required): The value indicating whether to enable NRR for inbound decoded messages. @@ -333,35 +360,64 @@ * **signingAlgorithm**: 'Default' | 'NotSpecified' | 'SHA1' | 'SHA2256' | 'SHA2384' | 'SHA2512' | string: The signing or hashing algorithm. * **signMessage**: bool (Required): The value indicating whether the message has to be signed. +## AssemblyProperties +### Properties +* **assemblyCulture**: string: The assembly culture. +* **assemblyName**: string (Required): The assembly name. +* **assemblyPublicKeyToken**: string: The assembly public key token. +* **assemblyVersion**: string: The assembly version. +* **changedTime**: string: The artifact changed time. +* **content**: any: Anything +* **contentLink**: [ContentLink](#contentlink): The content link. +* **contentType**: string: The content type. +* **createdTime**: string: The artifact creation time. +* **metadata**: any: Anything + +## AzureResourceErrorInfo +### Properties +* **code**: string (ReadOnly): The error code. +* **details**: [AzureResourceErrorInfo](#azureresourceerrorinfo)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. + +## B2BPartnerContent +### Properties +* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. + +## BatchConfigurationProperties +### Properties +* **batchGroupName**: string (Required): The name of the batch group. +* **changedTime**: string: The artifact changed time. +* **createdTime**: string: The artifact creation time. +* **metadata**: any: Anything +* **releaseCriteria**: [BatchReleaseCriteria](#batchreleasecriteria) (Required): The batch release criteria. + +## BatchReleaseCriteria +### Properties +* **batchSize**: int: The batch size in bytes. +* **messageCount**: int: The message count. +* **recurrence**: [WorkflowTriggerRecurrence](#workflowtriggerrecurrence): The workflow trigger recurrence. + ## BusinessIdentity ### Properties * **qualifier**: string (Required): The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * **value**: string (Required): The user defined business identity value. -## EdifactAgreementContent +## CallbackUrl ### Properties -* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. -* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. +* **value**: string (ReadOnly): The URL value. -## EdifactOneWayAgreement +## ContentHash ### Properties -* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) (Required): The Edifact agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **algorithm**: string: The algorithm of the content hash. +* **value**: string: The value of the content hash. -## EdifactProtocolSettings +## ContentLink ### Properties -* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) (Required): The Edifact agreement acknowledgement settings. -* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. -* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. -* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) (Required): The Edifact agreement envelope settings. -* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) (Required): The Edifact agreement framing settings. -* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) (Required): The Edifact message filter for odata query. -* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. -* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) (Required): The Edifact agreement protocol settings. -* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[] (Required): The EDIFACT schema references. -* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. -* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) (Required): The Edifact agreement validation settings. +* **contentHash**: [ContentHash](#contenthash) (ReadOnly): The content hash. +* **contentSize**: int (ReadOnly): The content size. +* **contentVersion**: string (ReadOnly): The content version. +* **metadata**: any (ReadOnly): Any object +* **uri**: string: The content link URI. ## EdifactAcknowledgementSettings ### Properties @@ -377,6 +433,11 @@ * **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. * **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. +## EdifactAgreementContent +### Properties +* **receiveAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. +* **sendAgreement**: [EdifactOneWayAgreement](#edifactonewayagreement) (Required): The Edifact one way agreement. + ## EdifactDelimiterOverride ### Properties * **componentSeparator**: int (Required): The component separator. @@ -476,6 +537,12 @@ ### Properties * **messageId**: string (Required): The message id on which this envelope settings has to be applied. +## EdifactOneWayAgreement +### Properties +* **protocolSettings**: [EdifactProtocolSettings](#edifactprotocolsettings) (Required): The Edifact agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + ## EdifactProcessingSettings ### Properties * **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. @@ -484,6 +551,20 @@ * **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. * **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. +## EdifactProtocolSettings +### Properties +* **acknowledgementSettings**: [EdifactAcknowledgementSettings](#edifactacknowledgementsettings) (Required): The Edifact agreement acknowledgement settings. +* **edifactDelimiterOverrides**: [EdifactDelimiterOverride](#edifactdelimiteroverride)[]: The EDIFACT delimiter override settings. +* **envelopeOverrides**: [EdifactEnvelopeOverride](#edifactenvelopeoverride)[]: The EDIFACT envelope override settings. +* **envelopeSettings**: [EdifactEnvelopeSettings](#edifactenvelopesettings) (Required): The Edifact agreement envelope settings. +* **framingSettings**: [EdifactFramingSettings](#edifactframingsettings) (Required): The Edifact agreement framing settings. +* **messageFilter**: [EdifactMessageFilter](#edifactmessagefilter) (Required): The Edifact message filter for odata query. +* **messageFilterList**: [EdifactMessageIdentifier](#edifactmessageidentifier)[]: The EDIFACT message filter list. +* **processingSettings**: [EdifactProcessingSettings](#edifactprocessingsettings) (Required): The Edifact agreement protocol settings. +* **schemaReferences**: [EdifactSchemaReference](#edifactschemareference)[] (Required): The EDIFACT schema references. +* **validationOverrides**: [EdifactValidationOverride](#edifactvalidationoverride)[]: The EDIFACT validation override settings. +* **validationSettings**: [EdifactValidationSettings](#edifactvalidationsettings) (Required): The Edifact agreement validation settings. + ## EdifactSchemaReference ### Properties * **associationAssignedCode**: string: The association assigned code. @@ -517,242 +598,97 @@ * **validateEDITypes**: bool (Required): The value indicating whether to Whether to validate EDI types. * **validateXSDTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. -## X12AgreementContent +## Expression ### Properties -* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. -* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. +* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. +* **subexpressions**: [Expression](#expression)[] (ReadOnly): The sub expressions. +* **text**: string (ReadOnly): The text. +* **value**: any (ReadOnly): Anything -## X12OneWayAgreement +## ExpressionRoot ### Properties -* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) (Required): The X12 agreement protocol settings. -* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. -* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. +* **path**: string (ReadOnly): The path. +* **subexpressions**: [Expression](#expression)[] (ReadOnly): The sub expressions. +* **text**: string (ReadOnly): The text. +* **value**: any (ReadOnly): Anything -## X12ProtocolSettings +## ExpressionTraces ### Properties -* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) (Required): The X12 agreement acknowledgement settings. -* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. -* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) (Required): The X12 agreement envelope settings. -* **framingSettings**: [X12FramingSettings](#x12framingsettings) (Required): The X12 agreement framing settings. -* **messageFilter**: [X12MessageFilter](#x12messagefilter) (Required): The X12 message filter for odata query. -* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. -* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) (Required): The X12 processing settings. -* **schemaReferences**: [X12SchemaReference](#x12schemareference)[] (Required): The X12 schema references. -* **securitySettings**: [X12SecuritySettings](#x12securitysettings) (Required): The X12 agreement security settings. -* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. -* **validationSettings**: [X12ValidationSettings](#x12validationsettings) (Required): The X12 agreement validation settings. -* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. +* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot -## X12AcknowledgementSettings +## ExpressionTraces ### Properties -* **acknowledgementControlNumberLowerBound**: int (Required): The acknowledgement control number lower bound. -* **acknowledgementControlNumberPrefix**: string: The acknowledgement control number prefix. -* **acknowledgementControlNumberSuffix**: string: The acknowledgement control number suffix. -* **acknowledgementControlNumberUpperBound**: int (Required): The acknowledgement control number upper bound. -* **batchFunctionalAcknowledgements**: bool (Required): The value indicating whether to batch functional acknowledgements. -* **batchImplementationAcknowledgements**: bool (Required): The value indicating whether to batch implementation acknowledgements. -* **batchTechnicalAcknowledgements**: bool (Required): The value indicating whether to batch the technical acknowledgements. -* **functionalAcknowledgementVersion**: string: The functional acknowledgement version. -* **implementationAcknowledgementVersion**: string: The implementation acknowledgement version. -* **needFunctionalAcknowledgement**: bool (Required): The value indicating whether functional acknowledgement is needed. -* **needImplementationAcknowledgement**: bool (Required): The value indicating whether implementation acknowledgement is needed. -* **needLoopForValidMessages**: bool (Required): The value indicating whether a loop is needed for valid messages. -* **needTechnicalAcknowledgement**: bool (Required): The value indicating whether technical acknowledgement is needed. -* **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. -* **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. +* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot -## X12EnvelopeOverride +## FlowAccessControlConfiguration ### Properties -* **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required): The x12 date format. -* **functionalIdentifierCode**: string: The functional identifier code. -* **headerVersion**: string (Required): The header version. -* **messageId**: string (Required): The message id on which this envelope settings has to be applied. -* **protocolVersion**: string (Required): The protocol version on which this envelope settings has to be applied. -* **receiverApplicationId**: string (Required): The receiver application id. -* **responsibleAgencyCode**: string (Required): The responsible agency code. -* **senderApplicationId**: string (Required): The sender application id. -* **targetNamespace**: string (Required): The target namespace on which this envelope settings has to be applied. -* **timeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required): The x12 time format. - -## X12EnvelopeSettings -### Properties -* **controlStandardsId**: int (Required): The controls standards id. -* **controlVersionNumber**: string (Required): The control version number. -* **enableDefaultGroupHeaders**: bool (Required): The value indicating whether to enable default group headers. -* **functionalGroupId**: string: The functional group id. -* **groupControlNumberLowerBound**: int (Required): The group control number lower bound. -* **groupControlNumberUpperBound**: int (Required): The group control number upper bound. -* **groupHeaderAgencyCode**: string (Required): The group header agency code. -* **groupHeaderDateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required): The x12 date format. -* **groupHeaderTimeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required): The x12 time format. -* **groupHeaderVersion**: string (Required): The group header version. -* **interchangeControlNumberLowerBound**: int (Required): The interchange control number lower bound. -* **interchangeControlNumberUpperBound**: int (Required): The interchange control number upper bound. -* **overwriteExistingTransactionSetControlNumber**: bool (Required): The value indicating whether to overwrite existing transaction set control number. -* **receiverApplicationId**: string (Required): The receiver application id. -* **rolloverGroupControlNumber**: bool (Required): The value indicating whether to rollover group control number. -* **rolloverInterchangeControlNumber**: bool (Required): The value indicating whether to rollover interchange control number. -* **rolloverTransactionSetControlNumber**: bool (Required): The value indicating whether to rollover transaction set control number. -* **senderApplicationId**: string (Required): The sender application id. -* **transactionSetControlNumberLowerBound**: int (Required): The transaction set control number lower bound. -* **transactionSetControlNumberPrefix**: string: The transaction set control number prefix. -* **transactionSetControlNumberSuffix**: string: The transaction set control number suffix. -* **transactionSetControlNumberUpperBound**: int (Required): The transaction set control number upper bound. -* **usageIndicator**: 'Information' | 'NotSpecified' | 'Production' | 'Test' | string (Required): The usage indicator. -* **useControlStandardsIdAsRepetitionCharacter**: bool (Required): The value indicating whether to use control standards id as repetition character. - -## X12FramingSettings -### Properties -* **characterSet**: 'Basic' | 'Extended' | 'NotSpecified' | 'UTF8' | string (Required): The X12 character set. -* **componentSeparator**: int (Required): The component separator. -* **dataElementSeparator**: int (Required): The data element separator. -* **replaceCharacter**: int (Required): The replacement character. -* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. -* **segmentTerminator**: int (Required): The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required): The segment terminator suffix. - -## X12MessageFilter -### Properties -* **messageFilterType**: 'Exclude' | 'Include' | 'NotSpecified' | string (Required): The message filter type. - -## X12MessageIdentifier -### Properties -* **messageId**: string (Required): The message id. - -## X12ProcessingSettings -### Properties -* **convertImpliedDecimal**: bool (Required): The value indicating whether to convert numerical type to implied decimal. -* **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. -* **maskSecurityInfo**: bool (Required): The value indicating whether to mask security information. -* **preserveInterchange**: bool (Required): The value indicating whether to preserve interchange. -* **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. -* **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. - -## X12SchemaReference -### Properties -* **messageId**: string (Required): The message id. -* **schemaName**: string (Required): The schema name. -* **schemaVersion**: string (Required): The schema version. -* **senderApplicationId**: string: The sender application id. - -## X12SecuritySettings -### Properties -* **authorizationQualifier**: string (Required): The authorization qualifier. -* **authorizationValue**: string: The authorization value. -* **passwordValue**: string: The password value. -* **securityQualifier**: string (Required): The security qualifier. - -## X12ValidationOverride -### Properties -* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. -* **messageId**: string (Required): The message id on which the validation settings has to be applied. -* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required): The trailing separator policy. -* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. -* **validateCharacterSet**: bool (Required): The value indicating whether to validate character Set. -* **validateEDITypes**: bool (Required): The value indicating whether to validate EDI types. -* **validateXSDTypes**: bool (Required): The value indicating whether to validate XSD types. - -## X12ValidationSettings -### Properties -* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. -* **checkDuplicateGroupControlNumber**: bool (Required): The value indicating whether to check for duplicate group control number. -* **checkDuplicateInterchangeControlNumber**: bool (Required): The value indicating whether to check for duplicate interchange control number. -* **checkDuplicateTransactionSetControlNumber**: bool (Required): The value indicating whether to check for duplicate transaction set control number. -* **interchangeControlNumberValidityDays**: int (Required): The validity period of interchange control number. -* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required): The trailing separator policy. -* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. -* **validateCharacterSet**: bool (Required): The value indicating whether to validate character set in the message. -* **validateEDITypes**: bool (Required): The value indicating whether to Whether to validate EDI types. -* **validateXSDTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. - -## X12DelimiterOverrides -### Properties -* **componentSeparator**: int (Required): The component separator. -* **dataElementSeparator**: int (Required): The data element separator. -* **messageId**: string: The message id. -* **protocolVersion**: string: The protocol version. -* **replaceCharacter**: int (Required): The replacement character. -* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. -* **segmentTerminator**: int (Required): The segment terminator. -* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required): The segment terminator suffix. -* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. +* **actions**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. +* **contents**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. +* **triggers**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. +* **workflowManagement**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. -## ResourceTags +## FlowAccessControlConfigurationPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedCallerIpAddresses**: [IpAddressRange](#ipaddressrange)[]: The allowed caller IP address ranges. +* **openAuthenticationPolicies**: [OpenAuthenticationAccessPolicies](#openauthenticationaccesspolicies): AuthenticationPolicy of type Open. -## AssemblyProperties +## FlowEndpoints ### Properties -* **assemblyCulture**: string: The assembly culture. -* **assemblyName**: string (Required): The assembly name. -* **assemblyPublicKeyToken**: string: The assembly public key token. -* **assemblyVersion**: string: The assembly version. -* **changedTime**: string: The artifact changed time. -* **content**: any: Anything -* **contentLink**: [ContentLink](#contentlink): The content link. -* **contentType**: string: The content type. -* **createdTime**: string: The artifact creation time. -* **metadata**: any: Anything +* **accessEndpointIpAddresses**: [IpAddress](#ipaddress)[]: The access endpoint ip address. +* **outgoingIpAddresses**: [IpAddress](#ipaddress)[]: The outgoing ip address. -## ContentLink +## FlowEndpointsConfiguration ### Properties -* **contentHash**: [ContentHash](#contenthash) (ReadOnly): The content hash. -* **contentSize**: int (ReadOnly): The content size. -* **contentVersion**: string (ReadOnly): The content version. -* **metadata**: any (ReadOnly): Any object -* **uri**: string: The content link URI. +* **connector**: [FlowEndpoints](#flowendpoints): The flow endpoints configuration. +* **workflow**: [FlowEndpoints](#flowendpoints): The flow endpoints configuration. -## ContentHash +## GetCallbackUrlParameters ### Properties -* **algorithm**: string: The algorithm of the content hash. -* **value**: string: The value of the content hash. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## ResourceTags +## GetCallbackUrlParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## BatchConfigurationProperties +## GetCallbackUrlParameters ### Properties -* **batchGroupName**: string (Required): The name of the batch group. -* **changedTime**: string: The artifact changed time. -* **createdTime**: string: The artifact creation time. -* **metadata**: any: Anything -* **releaseCriteria**: [BatchReleaseCriteria](#batchreleasecriteria) (Required): The batch release criteria. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## BatchReleaseCriteria +## GetCallbackUrlParameters ### Properties -* **batchSize**: int: The batch size in bytes. -* **messageCount**: int: The message count. -* **recurrence**: [WorkflowTriggerRecurrence](#workflowtriggerrecurrence): The workflow trigger recurrence. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## WorkflowTriggerRecurrence +## GetCallbackUrlParameters ### Properties -* **endTime**: string: The end time. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' | string: The recurrence frequency. -* **interval**: int: The interval. -* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. -* **startTime**: string: The start time. -* **timeZone**: string: The time zone. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## RecurrenceSchedule +## GetCallbackUrlParameters ### Properties -* **hours**: int[]: The hours. -* **minutes**: int[]: The minutes. -* **monthDays**: int[]: The month days. -* **monthlyOccurrences**: [RecurrenceScheduleOccurrence](#recurrencescheduleoccurrence)[]: The monthly occurrences. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The days of the week. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## RecurrenceScheduleOccurrence +## GetCallbackUrlParameters ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': The day of the week. -* **occurrence**: int: The occurrence. +* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. +* **notAfter**: string (WriteOnly): The expiry time. -## ResourceTags +## IntegrationAccountAgreementProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **agreementType**: 'AS2' | 'Edifact' | 'NotSpecified' | 'X12' (Required): The agreement type. +* **changedTime**: string (ReadOnly): The changed time. +* **content**: [AgreementContent](#agreementcontent) (Required): The integration account agreement content. +* **createdTime**: string (ReadOnly): The created time. +* **guestIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **guestPartner**: string (Required): The integration account partner that is set as guest partner for this agreement. +* **hostIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **hostPartner**: string (Required): The integration account partner that is set as host partner for this agreement. +* **metadata**: any: Any object ## IntegrationAccountCertificateProperties ### Properties @@ -762,23 +698,6 @@ * **metadata**: any: Any object * **publicCertificate**: string: The public certificate. -## KeyVaultKeyReference -### Properties -* **keyName**: string (Required): The private key name in key vault. -* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault) (Required): The key vault reference. -* **keyVersion**: string: The private key version in key vault. - -## KeyVaultKeyReferenceKeyVault -### Properties -* **id**: string: The resource id. -* **name**: string (ReadOnly): The resource name. -* **type**: string (ReadOnly): The resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## IntegrationAccountMapProperties ### Properties * **changedTime**: string (ReadOnly): The changed time. @@ -794,11 +713,6 @@ ### Properties * **ref**: string: The reference name. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## IntegrationAccountPartnerProperties ### Properties * **changedTime**: string (ReadOnly): The changed time. @@ -807,18 +721,10 @@ * **metadata**: any: Any object * **partnerType**: 'B2B' | 'NotSpecified' | string (Required): The partner type. -## PartnerContent -### Properties -* **b2b**: [B2BPartnerContent](#b2bpartnercontent): The B2B partner content. - -## B2BPartnerContent -### Properties -* **businessIdentities**: [BusinessIdentity](#businessidentity)[]: The list of partner business identities. - -## ResourceTags +## IntegrationAccountProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **integrationServiceEnvironment**: [ResourceReference](#resourcereference): The resource reference. +* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string: The workflow state. ## IntegrationAccountSchemaProperties ### Properties @@ -833,71 +739,123 @@ * **schemaType**: 'NotSpecified' | 'Xml' | string (Required): The schema type. * **targetNamespace**: string: The target namespace of the schema. -## ResourceTags +## IntegrationAccountSessionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changedTime**: string (ReadOnly): The changed time. +* **content**: any: Any object +* **createdTime**: string (ReadOnly): The created time. + +## IntegrationAccountSku +### Properties +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Standard' | string (Required): The integration account sku name. + +## IntegrationServiceEnvironmenEncryptionConfiguration +### Properties +* **encryptionKeyReference**: [IntegrationServiceEnvironmenEncryptionKeyReference](#integrationserviceenvironmenencryptionkeyreference): The encryption key details for the integration service environment. + +## IntegrationServiceEnvironmenEncryptionKeyReference +### Properties +* **keyName**: string: Gets the key name in the Key Vault. +* **keyVault**: [ResourceReference](#resourcereference): The resource reference. +* **keyVersion**: string: Gets the version of the key specified in the keyName property. + +## IntegrationServiceEnvironmentAccessEndpoint +### Properties +* **type**: 'External' | 'Internal' | 'NotSpecified' | string: The integration service environment access endpoint type. + +## IntegrationServiceEnvironmentManagedApiDeploymentParameters +### Properties +* **contentLinkDefinition**: [ContentLink](#contentlink): The content link. + +## IntegrationServiceEnvironmentManagedApiProperties +### Properties +* **apiDefinitions**: [ApiResourceDefinitions](#apiresourcedefinitions) (ReadOnly): The Api resource definition. +* **apiDefinitionUrl**: string (ReadOnly): The API definition. +* **backendService**: [ApiResourceBackendService](#apiresourcebackendservice) (ReadOnly): The API backend service. +* **capabilities**: string[] (ReadOnly): The capabilities. +* **category**: 'Enterprise' | 'NotSpecified' | 'Premium' | 'Standard' | string (ReadOnly): The Api tier. +* **connectionParameters**: [ApiResourcePropertiesConnectionParameters](#apiresourcepropertiesconnectionparameters) (ReadOnly): The connection parameters. +* **deploymentParameters**: [IntegrationServiceEnvironmentManagedApiDeploymentParameters](#integrationserviceenvironmentmanagedapideploymentparameters): The integration service environment managed api deployment parameters. +* **generalInformation**: [ApiResourceGeneralInformation](#apiresourcegeneralinformation) (ReadOnly): The API general information. +* **integrationServiceEnvironment**: [ResourceReference](#resourcereference): The resource reference. +* **metadata**: [ApiResourceMetadata](#apiresourcemetadata) (ReadOnly): The api resource metadata. +* **name**: string (ReadOnly): The name +* **policies**: [ApiResourcePolicies](#apiresourcepolicies) (ReadOnly): The API resource policies. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string (ReadOnly): The workflow provisioning state. +* **runtimeUrls**: string[] (ReadOnly): The runtime urls. + +## IntegrationServiceEnvironmentProperties +### Properties +* **encryptionConfiguration**: [IntegrationServiceEnvironmenEncryptionConfiguration](#integrationserviceenvironmenencryptionconfiguration): The encryption configuration for the integration service environment. +* **endpointsConfiguration**: [FlowEndpointsConfiguration](#flowendpointsconfiguration): The endpoints configuration. +* **integrationServiceEnvironmentId**: string: Gets the tracking id. +* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string: The workflow provisioning state. +* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string: The workflow state. + +## IntegrationServiceEnvironmentSku +### Properties +* **capacity**: int: The sku capacity. +* **name**: 'Developer' | 'NotSpecified' | 'Premium' | string: The integration service environment sku name. -## IntegrationAccountSessionProperties +## IpAddress ### Properties -* **changedTime**: string (ReadOnly): The changed time. -* **content**: any: Any object -* **createdTime**: string (ReadOnly): The created time. +* **address**: string: The address. -## ResourceTags +## IpAddressRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressRange**: string: The IP address range. -## ManagedServiceIdentity +## KeyVaultKey ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (Required): Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **attributes**: [KeyVaultKeyAttributes](#keyvaultkeyattributes) (ReadOnly): The key attributes. +* **kid**: string (ReadOnly): The key id. -## ManagedServiceIdentityUserAssignedIdentities +## KeyVaultKeyAttributes ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **created**: int (ReadOnly): When the key was created. +* **enabled**: bool (ReadOnly): Whether the key is enabled or not. +* **updated**: int (ReadOnly): When the key was updated. -## UserAssignedIdentity +## KeyVaultKeyCollection ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **skipToken**: string (ReadOnly): The skip token. +* **value**: [KeyVaultKey](#keyvaultkey)[] (ReadOnly): The key vault keys. -## IntegrationServiceEnvironmentProperties +## KeyVaultKeyReference ### Properties -* **encryptionConfiguration**: [IntegrationServiceEnvironmenEncryptionConfiguration](#integrationserviceenvironmenencryptionconfiguration): The encryption configuration for the integration service environment. -* **endpointsConfiguration**: [FlowEndpointsConfiguration](#flowendpointsconfiguration): The endpoints configuration. -* **integrationServiceEnvironmentId**: string: Gets the tracking id. -* **networkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string: The workflow provisioning state. -* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string: The workflow state. +* **keyName**: string (Required): The private key name in key vault. +* **keyVault**: [KeyVaultKeyReferenceKeyVault](#keyvaultkeyreferencekeyvault) (Required): The key vault reference. +* **keyVersion**: string: The private key version in key vault. -## IntegrationServiceEnvironmenEncryptionConfiguration +## KeyVaultKeyReferenceKeyVault ### Properties -* **encryptionKeyReference**: [IntegrationServiceEnvironmenEncryptionKeyReference](#integrationserviceenvironmenencryptionkeyreference): The encryption key details for the integration service environment. +* **id**: string: The resource id. +* **name**: string (ReadOnly): The resource name. +* **type**: string (ReadOnly): The resource type. -## IntegrationServiceEnvironmenEncryptionKeyReference +## KeyVaultReference ### Properties -* **keyName**: string: Gets the key name in the Key Vault. -* **keyVault**: [ResourceReference](#resourcereference): The resource reference. -* **keyVersion**: string: Gets the version of the key specified in the keyName property. +* **id**: string (WriteOnly): The resource id. +* **name**: string (ReadOnly, WriteOnly): Gets the resource name. +* **type**: string (ReadOnly, WriteOnly): Gets the resource type. -## FlowEndpointsConfiguration +## ListKeyVaultKeysDefinition ### Properties -* **connector**: [FlowEndpoints](#flowendpoints): The flow endpoints configuration. -* **workflow**: [FlowEndpoints](#flowendpoints): The flow endpoints configuration. +* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required, WriteOnly): The key vault reference. +* **skipToken**: string (WriteOnly): The skip token. -## FlowEndpoints +## ManagedServiceIdentity ### Properties -* **accessEndpointIpAddresses**: [IpAddress](#ipaddress)[]: The access endpoint ip address. -* **outgoingIpAddresses**: [IpAddress](#ipaddress)[]: The outgoing ip address. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (Required): Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## IpAddress +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **address**: string: The address. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) ## NetworkConfiguration ### Properties @@ -905,165 +863,117 @@ * **subnets**: [ResourceReference](#resourcereference)[]: The subnets. * **virtualNetworkAddressSpace**: string: Gets the virtual network address space. -## IntegrationServiceEnvironmentAccessEndpoint -### Properties -* **type**: 'External' | 'Internal' | 'NotSpecified' | string: The integration service environment access endpoint type. - -## IntegrationServiceEnvironmentSku +## OpenAuthenticationAccessPolicies ### Properties -* **capacity**: int: The sku capacity. -* **name**: 'Developer' | 'NotSpecified' | 'Premium' | string: The integration service environment sku name. +* **policies**: [OpenAuthenticationAccessPolicies](#openauthenticationaccesspolicies): Open authentication policies. -## ResourceTags +## OpenAuthenticationAccessPolicies ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## IntegrationServiceEnvironmentManagedApiProperties -### Properties -* **apiDefinitions**: [ApiResourceDefinitions](#apiresourcedefinitions) (ReadOnly): The Api resource definition. -* **apiDefinitionUrl**: string (ReadOnly): The API definition. -* **backendService**: [ApiResourceBackendService](#apiresourcebackendservice) (ReadOnly): The API backend service. -* **capabilities**: string[] (ReadOnly): The capabilities. -* **category**: 'Enterprise' | 'NotSpecified' | 'Premium' | 'Standard' | string (ReadOnly): The Api tier. -* **connectionParameters**: [ApiResourcePropertiesConnectionParameters](#apiresourcepropertiesconnectionparameters) (ReadOnly): The connection parameters. -* **deploymentParameters**: [IntegrationServiceEnvironmentManagedApiDeploymentParameters](#integrationserviceenvironmentmanagedapideploymentparameters): The integration service environment managed api deployment parameters. -* **generalInformation**: [ApiResourceGeneralInformation](#apiresourcegeneralinformation) (ReadOnly): The API general information. -* **integrationServiceEnvironment**: [ResourceReference](#resourcereference): The resource reference. -* **metadata**: [ApiResourceMetadata](#apiresourcemetadata) (ReadOnly): The api resource metadata. -* **name**: string (ReadOnly): The name -* **policies**: [ApiResourcePolicies](#apiresourcepolicies) (ReadOnly): The API resource policies. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string (ReadOnly): The workflow provisioning state. -* **runtimeUrls**: string[] (ReadOnly): The runtime urls. - -## ApiResourceDefinitions -### Properties -* **modifiedSwaggerUrl**: string: The modified swagger url. -* **originalSwaggerUrl**: string: The original swagger url. +* **Additional Properties Type**: [OpenAuthenticationAccessPolicy](#openauthenticationaccesspolicy) -## ApiResourceBackendService +## OpenAuthenticationAccessPolicy ### Properties -* **serviceUrl**: string: The service URL. +* **claims**: [OpenAuthenticationPolicyClaim](#openauthenticationpolicyclaim)[]: The access policy claims. +* **type**: 'AAD' | string: Open authentication policy provider type. -## ApiResourcePropertiesConnectionParameters +## OpenAuthenticationPolicyClaim ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **name**: string: The name of the claim. +* **value**: string: The value of the claim. -## IntegrationServiceEnvironmentManagedApiDeploymentParameters +## PartnerContent ### Properties -* **contentLinkDefinition**: [ContentLink](#contentlink): The content link. +* **b2b**: [B2BPartnerContent](#b2bpartnercontent): The B2B partner content. -## ApiResourceGeneralInformation +## RecurrenceSchedule ### Properties -* **description**: string: The description. -* **displayName**: string: The display name. -* **iconUrl**: string: The icon url. -* **releaseTag**: string: The release tag. -* **termsOfUseUrl**: string: The terms of use url. -* **tier**: 'Enterprise' | 'NotSpecified' | 'Premium' | 'Standard' | string: The Api tier. +* **hours**: int[]: The hours. +* **minutes**: int[]: The minutes. +* **monthDays**: int[]: The month days. +* **monthlyOccurrences**: [RecurrenceScheduleOccurrence](#recurrencescheduleoccurrence)[]: The monthly occurrences. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The days of the week. -## ApiResourceMetadata +## RecurrenceScheduleOccurrence ### Properties -* **ApiType**: 'NotSpecified' | 'Rest' | 'Soap' | string -* **brandColor**: string: The brand color. -* **connectionType**: string: The connection type. -* **deploymentParameters**: [ApiDeploymentParameterMetadataSet](#apideploymentparametermetadataset): The API deployment parameters metadata. -* **hideKey**: string: The hide key. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string: The workflow provisioning state. -* **source**: string: The source. -* **tags**: [ApiResourceMetadataTags](#apiresourcemetadatatags): The tags. -* **wsdlImportMethod**: 'NotSpecified' | 'SoapPassThrough' | 'SoapToRest' | string: The WSDL import method. -* **wsdlService**: [WsdlService](#wsdlservice): The WSDL service. +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': The day of the week. +* **occurrence**: int: The occurrence. -## ApiDeploymentParameterMetadataSet +## ResourceReference ### Properties -* **packageContentLink**: [ApiDeploymentParameterMetadata](#apideploymentparametermetadata): The API deployment parameter metadata. -* **redisCacheConnectionString**: [ApiDeploymentParameterMetadata](#apideploymentparametermetadata): The API deployment parameter metadata. +* **id**: string: The resource id. +* **name**: string (ReadOnly): Gets the resource name. +* **type**: string (ReadOnly): Gets the resource type. -## ApiDeploymentParameterMetadata +## ResourceTags ### Properties -* **description**: string: The description. -* **displayName**: string: The display name. -* **isRequired**: bool: Indicates whether its required. -* **type**: string: The type. -* **visibility**: 'Default' | 'Internal' | 'NotSpecified' | string: The Api deployment parameter visibility. +### Additional Properties +* **Additional Properties Type**: string -## ApiResourceMetadataTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WsdlService +## ResourceTags ### Properties -* **EndpointQualifiedNames**: string[]: The list of endpoints' qualified names. -* **qualifiedName**: string: The qualified name. +### Additional Properties +* **Additional Properties Type**: string -## ApiResourcePolicies +## ResourceTags ### Properties -* **content**: string: The API level only policies XML as embedded content. -* **contentLink**: string: The content link to the policies. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkflowProperties +## ResourceTags ### Properties -* **accessControl**: [FlowAccessControlConfiguration](#flowaccesscontrolconfiguration): The access control configuration. -* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. -* **changedTime**: string (ReadOnly): Gets the changed time. -* **createdTime**: string (ReadOnly): Gets the created time. -* **definition**: any: Any object -* **endpointsConfiguration**: [FlowEndpointsConfiguration](#flowendpointsconfiguration): The endpoints configuration. -* **integrationAccount**: [ResourceReference](#resourcereference): The resource reference. -* **integrationServiceEnvironment**: [ResourceReference](#resourcereference): The resource reference. -* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): The parameters. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string (ReadOnly): The workflow provisioning state. -* **sku**: [Sku](#sku) (ReadOnly): The sku type. -* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string: The workflow state. -* **version**: string (ReadOnly): Gets the version. +### Additional Properties +* **Additional Properties Type**: string -## FlowAccessControlConfiguration +## ResourceTags ### Properties -* **actions**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. -* **contents**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. -* **triggers**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. -* **workflowManagement**: [FlowAccessControlConfigurationPolicy](#flowaccesscontrolconfigurationpolicy): The access control configuration policy. +### Additional Properties +* **Additional Properties Type**: string -## FlowAccessControlConfigurationPolicy +## ResourceTags ### Properties -* **allowedCallerIpAddresses**: [IpAddressRange](#ipaddressrange)[]: The allowed caller IP address ranges. -* **openAuthenticationPolicies**: [OpenAuthenticationAccessPolicies](#openauthenticationaccesspolicies): AuthenticationPolicy of type Open. +### Additional Properties +* **Additional Properties Type**: string -## IpAddressRange +## ResourceTags ### Properties -* **addressRange**: string: The IP address range. +### Additional Properties +* **Additional Properties Type**: string -## OpenAuthenticationAccessPolicies +## ResourceTags ### Properties -* **policies**: [OpenAuthenticationAccessPolicies](#openauthenticationaccesspolicies): Open authentication policies. +### Additional Properties +* **Additional Properties Type**: string -## OpenAuthenticationAccessPolicies +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [OpenAuthenticationAccessPolicy](#openauthenticationaccesspolicy) +* **Additional Properties Type**: string -## OpenAuthenticationAccessPolicy +## ResourceTags ### Properties -* **claims**: [OpenAuthenticationPolicyClaim](#openauthenticationpolicyclaim)[]: The access policy claims. -* **type**: 'AAD' | string: Open authentication policy provider type. +### Additional Properties +* **Additional Properties Type**: string -## OpenAuthenticationPolicyClaim +## Sku ### Properties -* **name**: string: The name of the claim. -* **value**: string: The value of the claim. +* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' | string (Required): The sku name. +* **plan**: [ResourceReference](#resourcereference): The resource reference. -## WorkflowPropertiesParameters +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity ## WorkflowParameter ### Properties @@ -1072,20 +982,26 @@ * **type**: 'Array' | 'Bool' | 'Float' | 'Int' | 'NotSpecified' | 'Object' | 'SecureObject' | 'SecureString' | 'String' | string: The parameter type. * **value**: any: Any object -## Sku +## WorkflowProperties ### Properties -* **name**: 'Basic' | 'Free' | 'NotSpecified' | 'Premium' | 'Shared' | 'Standard' | string (Required): The sku name. -* **plan**: [ResourceReference](#resourcereference): The resource reference. +* **accessControl**: [FlowAccessControlConfiguration](#flowaccesscontrolconfiguration): The access control configuration. +* **accessEndpoint**: string (ReadOnly): Gets the access endpoint. +* **changedTime**: string (ReadOnly): Gets the changed time. +* **createdTime**: string (ReadOnly): Gets the created time. +* **definition**: any: Any object +* **endpointsConfiguration**: [FlowEndpointsConfiguration](#flowendpointsconfiguration): The endpoints configuration. +* **integrationAccount**: [ResourceReference](#resourcereference): The resource reference. +* **integrationServiceEnvironment**: [ResourceReference](#resourcereference): The resource reference. +* **parameters**: [WorkflowPropertiesParameters](#workflowpropertiesparameters): The parameters. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Completed' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'InProgress' | 'Moving' | 'NotSpecified' | 'Pending' | 'Ready' | 'Registered' | 'Registering' | 'Renewing' | 'Running' | 'Succeeded' | 'Unregistered' | 'Unregistering' | 'Updating' | 'Waiting' | string (ReadOnly): The workflow provisioning state. +* **sku**: [Sku](#sku) (ReadOnly): The sku type. +* **state**: 'Completed' | 'Deleted' | 'Disabled' | 'Enabled' | 'NotSpecified' | 'Suspended' | string: The workflow state. +* **version**: string (ReadOnly): Gets the version. -## ResourceTags +## WorkflowPropertiesParameters ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. +* **Additional Properties Type**: [WorkflowParameter](#workflowparameter) ## WorkflowTriggerCallbackUrl ### Properties @@ -1096,14 +1012,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## WorkflowTriggerListCallbackUrlQueries -### Properties -* **api-version**: string (ReadOnly): The api version. -* **se**: string (ReadOnly): The SAS timestamp. -* **sig**: string (ReadOnly): The SAS signature. -* **sp**: string (ReadOnly): The SAS permissions. -* **sv**: string (ReadOnly): The SAS version. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1113,11 +1021,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1127,15 +1030,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. - -## CallbackUrl -### Properties -* **value**: string (ReadOnly): The URL value. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1145,11 +1039,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1159,11 +1048,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1173,11 +1057,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1187,11 +1066,6 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## GetCallbackUrlParameters -### Properties -* **keyType**: 'NotSpecified' | 'Primary' | 'Secondary' | string (WriteOnly): The key type. -* **notAfter**: string (WriteOnly): The expiry time. - ## WorkflowTriggerCallbackUrl ### Properties * **basePath**: string (ReadOnly): Gets the workflow trigger callback URL base path. @@ -1201,59 +1075,185 @@ * **relativePathParameters**: string[] (ReadOnly): Gets the workflow trigger callback URL relative path parameters. * **value**: string (ReadOnly): Gets the workflow trigger callback URL. -## ExpressionTraces +## WorkflowTriggerListCallbackUrlQueries ### Properties -* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot +* **api-version**: string (ReadOnly): The api version. +* **se**: string (ReadOnly): The SAS timestamp. +* **sig**: string (ReadOnly): The SAS signature. +* **sp**: string (ReadOnly): The SAS permissions. +* **sv**: string (ReadOnly): The SAS version. -## ExpressionRoot +## WorkflowTriggerRecurrence ### Properties -* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. -* **path**: string (ReadOnly): The path. -* **subexpressions**: [Expression](#expression)[] (ReadOnly): The sub expressions. -* **text**: string (ReadOnly): The text. -* **value**: any (ReadOnly): Anything +* **endTime**: string: The end time. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' | string: The recurrence frequency. +* **interval**: int: The interval. +* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule. +* **startTime**: string: The start time. +* **timeZone**: string: The time zone. -## AzureResourceErrorInfo +## WsdlService ### Properties -* **code**: string (ReadOnly): The error code. -* **details**: [AzureResourceErrorInfo](#azureresourceerrorinfo)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. +* **EndpointQualifiedNames**: string[]: The list of endpoints' qualified names. +* **qualifiedName**: string: The qualified name. -## Expression +## X12AcknowledgementSettings ### Properties -* **error**: [AzureResourceErrorInfo](#azureresourceerrorinfo) (ReadOnly): The azure resource error info. -* **subexpressions**: [Expression](#expression)[] (ReadOnly): The sub expressions. -* **text**: string (ReadOnly): The text. -* **value**: any (ReadOnly): Anything +* **acknowledgementControlNumberLowerBound**: int (Required): The acknowledgement control number lower bound. +* **acknowledgementControlNumberPrefix**: string: The acknowledgement control number prefix. +* **acknowledgementControlNumberSuffix**: string: The acknowledgement control number suffix. +* **acknowledgementControlNumberUpperBound**: int (Required): The acknowledgement control number upper bound. +* **batchFunctionalAcknowledgements**: bool (Required): The value indicating whether to batch functional acknowledgements. +* **batchImplementationAcknowledgements**: bool (Required): The value indicating whether to batch implementation acknowledgements. +* **batchTechnicalAcknowledgements**: bool (Required): The value indicating whether to batch the technical acknowledgements. +* **functionalAcknowledgementVersion**: string: The functional acknowledgement version. +* **implementationAcknowledgementVersion**: string: The implementation acknowledgement version. +* **needFunctionalAcknowledgement**: bool (Required): The value indicating whether functional acknowledgement is needed. +* **needImplementationAcknowledgement**: bool (Required): The value indicating whether implementation acknowledgement is needed. +* **needLoopForValidMessages**: bool (Required): The value indicating whether a loop is needed for valid messages. +* **needTechnicalAcknowledgement**: bool (Required): The value indicating whether technical acknowledgement is needed. +* **rolloverAcknowledgementControlNumber**: bool (Required): The value indicating whether to rollover acknowledgement control number. +* **sendSynchronousAcknowledgement**: bool (Required): The value indicating whether to send synchronous acknowledgement. -## ExpressionTraces +## X12AgreementContent ### Properties -* **inputs**: [ExpressionRoot](#expressionroot)[] (ReadOnly): Array of ExpressionRoot +* **receiveAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. +* **sendAgreement**: [X12OneWayAgreement](#x12onewayagreement) (Required): The X12 one-way agreement. -## ListKeyVaultKeysDefinition +## X12DelimiterOverrides ### Properties -* **keyVault**: [KeyVaultReference](#keyvaultreference) (Required, WriteOnly): The key vault reference. -* **skipToken**: string (WriteOnly): The skip token. +* **componentSeparator**: int (Required): The component separator. +* **dataElementSeparator**: int (Required): The data element separator. +* **messageId**: string: The message id. +* **protocolVersion**: string: The protocol version. +* **replaceCharacter**: int (Required): The replacement character. +* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. +* **segmentTerminator**: int (Required): The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required): The segment terminator suffix. +* **targetNamespace**: string: The target namespace on which this delimiter settings has to be applied. -## KeyVaultReference +## X12EnvelopeOverride ### Properties -* **id**: string (WriteOnly): The resource id. -* **name**: string (ReadOnly, WriteOnly): Gets the resource name. -* **type**: string (ReadOnly, WriteOnly): Gets the resource type. +* **dateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required): The x12 date format. +* **functionalIdentifierCode**: string: The functional identifier code. +* **headerVersion**: string (Required): The header version. +* **messageId**: string (Required): The message id on which this envelope settings has to be applied. +* **protocolVersion**: string (Required): The protocol version on which this envelope settings has to be applied. +* **receiverApplicationId**: string (Required): The receiver application id. +* **responsibleAgencyCode**: string (Required): The responsible agency code. +* **senderApplicationId**: string (Required): The sender application id. +* **targetNamespace**: string (Required): The target namespace on which this envelope settings has to be applied. +* **timeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required): The x12 time format. -## KeyVaultKeyCollection +## X12EnvelopeSettings ### Properties -* **skipToken**: string (ReadOnly): The skip token. -* **value**: [KeyVaultKey](#keyvaultkey)[] (ReadOnly): The key vault keys. +* **controlStandardsId**: int (Required): The controls standards id. +* **controlVersionNumber**: string (Required): The control version number. +* **enableDefaultGroupHeaders**: bool (Required): The value indicating whether to enable default group headers. +* **functionalGroupId**: string: The functional group id. +* **groupControlNumberLowerBound**: int (Required): The group control number lower bound. +* **groupControlNumberUpperBound**: int (Required): The group control number upper bound. +* **groupHeaderAgencyCode**: string (Required): The group header agency code. +* **groupHeaderDateFormat**: 'CCYYMMDD' | 'NotSpecified' | 'YYMMDD' | string (Required): The x12 date format. +* **groupHeaderTimeFormat**: 'HHMM' | 'HHMMSS' | 'HHMMSSd' | 'HHMMSSdd' | 'NotSpecified' | string (Required): The x12 time format. +* **groupHeaderVersion**: string (Required): The group header version. +* **interchangeControlNumberLowerBound**: int (Required): The interchange control number lower bound. +* **interchangeControlNumberUpperBound**: int (Required): The interchange control number upper bound. +* **overwriteExistingTransactionSetControlNumber**: bool (Required): The value indicating whether to overwrite existing transaction set control number. +* **receiverApplicationId**: string (Required): The receiver application id. +* **rolloverGroupControlNumber**: bool (Required): The value indicating whether to rollover group control number. +* **rolloverInterchangeControlNumber**: bool (Required): The value indicating whether to rollover interchange control number. +* **rolloverTransactionSetControlNumber**: bool (Required): The value indicating whether to rollover transaction set control number. +* **senderApplicationId**: string (Required): The sender application id. +* **transactionSetControlNumberLowerBound**: int (Required): The transaction set control number lower bound. +* **transactionSetControlNumberPrefix**: string: The transaction set control number prefix. +* **transactionSetControlNumberSuffix**: string: The transaction set control number suffix. +* **transactionSetControlNumberUpperBound**: int (Required): The transaction set control number upper bound. +* **usageIndicator**: 'Information' | 'NotSpecified' | 'Production' | 'Test' | string (Required): The usage indicator. +* **useControlStandardsIdAsRepetitionCharacter**: bool (Required): The value indicating whether to use control standards id as repetition character. -## KeyVaultKey +## X12FramingSettings ### Properties -* **attributes**: [KeyVaultKeyAttributes](#keyvaultkeyattributes) (ReadOnly): The key attributes. -* **kid**: string (ReadOnly): The key id. +* **characterSet**: 'Basic' | 'Extended' | 'NotSpecified' | 'UTF8' | string (Required): The X12 character set. +* **componentSeparator**: int (Required): The component separator. +* **dataElementSeparator**: int (Required): The data element separator. +* **replaceCharacter**: int (Required): The replacement character. +* **replaceSeparatorsInPayload**: bool (Required): The value indicating whether to replace separators in payload. +* **segmentTerminator**: int (Required): The segment terminator. +* **segmentTerminatorSuffix**: 'CR' | 'CRLF' | 'LF' | 'None' | 'NotSpecified' (Required): The segment terminator suffix. -## KeyVaultKeyAttributes +## X12MessageFilter ### Properties -* **created**: int (ReadOnly): When the key was created. -* **enabled**: bool (ReadOnly): Whether the key is enabled or not. -* **updated**: int (ReadOnly): When the key was updated. +* **messageFilterType**: 'Exclude' | 'Include' | 'NotSpecified' | string (Required): The message filter type. + +## X12MessageIdentifier +### Properties +* **messageId**: string (Required): The message id. + +## X12OneWayAgreement +### Properties +* **protocolSettings**: [X12ProtocolSettings](#x12protocolsettings) (Required): The X12 agreement protocol settings. +* **receiverBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. +* **senderBusinessIdentity**: [BusinessIdentity](#businessidentity) (Required): The integration account partner's business identity. + +## X12ProcessingSettings +### Properties +* **convertImpliedDecimal**: bool (Required): The value indicating whether to convert numerical type to implied decimal. +* **createEmptyXmlTagsForTrailingSeparators**: bool (Required): The value indicating whether to create empty xml tags for trailing separators. +* **maskSecurityInfo**: bool (Required): The value indicating whether to mask security information. +* **preserveInterchange**: bool (Required): The value indicating whether to preserve interchange. +* **suspendInterchangeOnError**: bool (Required): The value indicating whether to suspend interchange on error. +* **useDotAsDecimalSeparator**: bool (Required): The value indicating whether to use dot as decimal separator. + +## X12ProtocolSettings +### Properties +* **acknowledgementSettings**: [X12AcknowledgementSettings](#x12acknowledgementsettings) (Required): The X12 agreement acknowledgement settings. +* **envelopeOverrides**: [X12EnvelopeOverride](#x12envelopeoverride)[]: The X12 envelope override settings. +* **envelopeSettings**: [X12EnvelopeSettings](#x12envelopesettings) (Required): The X12 agreement envelope settings. +* **framingSettings**: [X12FramingSettings](#x12framingsettings) (Required): The X12 agreement framing settings. +* **messageFilter**: [X12MessageFilter](#x12messagefilter) (Required): The X12 message filter for odata query. +* **messageFilterList**: [X12MessageIdentifier](#x12messageidentifier)[]: The X12 message filter list. +* **processingSettings**: [X12ProcessingSettings](#x12processingsettings) (Required): The X12 processing settings. +* **schemaReferences**: [X12SchemaReference](#x12schemareference)[] (Required): The X12 schema references. +* **securitySettings**: [X12SecuritySettings](#x12securitysettings) (Required): The X12 agreement security settings. +* **validationOverrides**: [X12ValidationOverride](#x12validationoverride)[]: The X12 validation override settings. +* **validationSettings**: [X12ValidationSettings](#x12validationsettings) (Required): The X12 agreement validation settings. +* **x12DelimiterOverrides**: [X12DelimiterOverrides](#x12delimiteroverrides)[]: The X12 delimiter override settings. + +## X12SchemaReference +### Properties +* **messageId**: string (Required): The message id. +* **schemaName**: string (Required): The schema name. +* **schemaVersion**: string (Required): The schema version. +* **senderApplicationId**: string: The sender application id. + +## X12SecuritySettings +### Properties +* **authorizationQualifier**: string (Required): The authorization qualifier. +* **authorizationValue**: string: The authorization value. +* **passwordValue**: string: The password value. +* **securityQualifier**: string (Required): The security qualifier. + +## X12ValidationOverride +### Properties +* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. +* **messageId**: string (Required): The message id on which the validation settings has to be applied. +* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required): The trailing separator policy. +* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. +* **validateCharacterSet**: bool (Required): The value indicating whether to validate character Set. +* **validateEDITypes**: bool (Required): The value indicating whether to validate EDI types. +* **validateXSDTypes**: bool (Required): The value indicating whether to validate XSD types. + +## X12ValidationSettings +### Properties +* **allowLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to allow leading and trailing spaces and zeroes. +* **checkDuplicateGroupControlNumber**: bool (Required): The value indicating whether to check for duplicate group control number. +* **checkDuplicateInterchangeControlNumber**: bool (Required): The value indicating whether to check for duplicate interchange control number. +* **checkDuplicateTransactionSetControlNumber**: bool (Required): The value indicating whether to check for duplicate transaction set control number. +* **interchangeControlNumberValidityDays**: int (Required): The validity period of interchange control number. +* **trailingSeparatorPolicy**: 'Mandatory' | 'NotAllowed' | 'NotSpecified' | 'Optional' | string (Required): The trailing separator policy. +* **trimLeadingAndTrailingSpacesAndZeroes**: bool (Required): The value indicating whether to trim leading and trailing spaces and zeroes. +* **validateCharacterSet**: bool (Required): The value indicating whether to validate character set in the message. +* **validateEDITypes**: bool (Required): The value indicating whether to Whether to validate EDI types. +* **validateXSDTypes**: bool (Required): The value indicating whether to Whether to validate XSD types. diff --git a/generated/logz/log.out b/generated/logz/log.out index 14cd5ccb32..2ded03485e 100644 --- a/generated/logz/log.out +++ b/generated/logz/log.out @@ -3,23 +3,23 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.logz-2022-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 18ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.logz-2020-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.logz-2020-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms -info | Autorest completed in 10.29s. 6 files generated. +info | Autorest completed in 10.15s. 6 files generated. diff --git a/generated/logz/microsoft.logz/2020-10-01-preview/types.md b/generated/logz/microsoft.logz/2020-10-01-preview/types.md index bb503b7e44..b17aace3c6 100644 --- a/generated/logz/microsoft.logz/2020-10-01-preview/types.md +++ b/generated/logz/microsoft.logz/2020-10-01-preview/types.md @@ -82,52 +82,24 @@ * **ApiVersion**: 2020-10-01-preview * **Output**: [VMResourcesListResponse](#vmresourceslistresponse) +## FilteringTag +### Properties +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. + ## IdentityProperties ### Properties * **principalId**: string (ReadOnly): The identity ID. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned' | 'UserAssigned' | string -## MonitorProperties -### Properties -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **logzOrganizationProperties**: [LogzOrganizationProperties](#logzorganizationproperties) -* **marketplaceSubscriptionStatus**: 'Active' | 'Suspended' | string: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **planData**: [PlanData](#plandata) -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **userInfo**: [UserInfo](#userinfo) - -## LogzOrganizationProperties -### Properties -* **companyName**: string: Name of the Logz organization. -* **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign on. -* **id**: string (ReadOnly): Id of the Logz organization. -* **singleSignOnUrl**: string: The login URL specific to this Logz Organization. - -## PlanData -### Properties -* **billingCycle**: string: different billing cycles like MONTHLY/WEEKLY. this could be enum -* **effectiveDate**: string: date when plan was applied -* **planDetails**: string: plan id as published by Logz -* **usageType**: string: different usage type like PAYG/COMMITTED. this could be enum - -## UserInfo -### Properties -* **emailAddress**: string: Email of the user used by Logz for contacting them if needed -* **firstName**: string: First Name of the user -* **lastName**: string: Last Name of the user -* **phoneNumber**: string: Phone number of the user used by Logz for contacting them if needed - -## SystemData +## LogRules ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. +* **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. +* **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. ## LogzMonitorResourceTags ### Properties @@ -139,24 +111,12 @@ ### Additional Properties * **Additional Properties Type**: string -## MonitoringTagRulesProperties -### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. - -## LogRules -### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. -* **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. -* **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. - -## FilteringTag +## LogzOrganizationProperties ### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. +* **companyName**: string: Name of the Logz organization. +* **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign on. +* **id**: string (ReadOnly): Id of the Logz organization. +* **singleSignOnUrl**: string: The login URL specific to this Logz Organization. ## LogzSingleSignOnProperties ### Properties @@ -165,11 +125,6 @@ * **singleSignOnState**: 'Disable' | 'Enable' | 'Existing' | 'Initial' | string: Various states of the SSO resource * **singleSignOnUrl**: string: The login URL specific to this Logz Organization. -## MonitoredResourceListResponse -### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. - ## MonitoredResource ### Properties * **id**: string (ReadOnly): The ARM id of the resource. @@ -184,23 +139,63 @@ * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## UserRoleRequest +## MonitoredResourceListResponse ### Properties -* **emailAddress**: string (WriteOnly): Email of the user used by Logz for contacting them if needed +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. + +## MonitoringTagRulesProperties +### Properties +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. + +## MonitorProperties +### Properties +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **logzOrganizationProperties**: [LogzOrganizationProperties](#logzorganizationproperties) +* **marketplaceSubscriptionStatus**: 'Active' | 'Suspended' | string: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **planData**: [PlanData](#plandata) +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **userInfo**: [UserInfo](#userinfo) + +## PlanData +### Properties +* **billingCycle**: string: different billing cycles like MONTHLY/WEEKLY. this could be enum +* **effectiveDate**: string: date when plan was applied +* **planDetails**: string: plan id as published by Logz +* **usageType**: string: different usage type like PAYG/COMMITTED. this could be enum + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserInfo +### Properties +* **emailAddress**: string: Email of the user used by Logz for contacting them if needed +* **firstName**: string: First Name of the user +* **lastName**: string: Last Name of the user +* **phoneNumber**: string: Phone number of the user used by Logz for contacting them if needed ## UserRoleListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [UserRoleResponse](#userroleresponse)[] (ReadOnly): List of user roles for Logz.io account. -## UserRoleResponse +## UserRoleRequest ### Properties -* **role**: 'Admin' | 'None' | 'User' | string (ReadOnly): User roles on configured in Logz.io account. +* **emailAddress**: string (WriteOnly): Email of the user used by Logz for contacting them if needed -## VMResourcesListResponse +## UserRoleResponse ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. +* **role**: 'Admin' | 'None' | 'User' | string (ReadOnly): User roles on configured in Logz.io account. ## VMResources ### Properties @@ -212,3 +207,8 @@ * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. +## VMResourcesListResponse +### Properties +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. + diff --git a/generated/logz/microsoft.logz/2020-10-01/types.md b/generated/logz/microsoft.logz/2020-10-01/types.md index 1070ac3f0f..49db1f7695 100644 --- a/generated/logz/microsoft.logz/2020-10-01/types.md +++ b/generated/logz/microsoft.logz/2020-10-01/types.md @@ -82,52 +82,24 @@ * **ApiVersion**: 2020-10-01 * **Output**: [VMResourcesListResponse](#vmresourceslistresponse) +## FilteringTag +### Properties +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. + ## IdentityProperties ### Properties * **principalId**: string (ReadOnly): The identity ID. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned' | 'UserAssigned' | string -## MonitorProperties -### Properties -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **logzOrganizationProperties**: [LogzOrganizationProperties](#logzorganizationproperties) -* **marketplaceSubscriptionStatus**: 'Active' | 'Suspended' | string: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **planData**: [PlanData](#plandata) -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **userInfo**: [UserInfo](#userinfo) - -## LogzOrganizationProperties -### Properties -* **companyName**: string: Name of the Logz organization. -* **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign on. -* **id**: string (ReadOnly): Id of the Logz organization. -* **singleSignOnUrl**: string: The login URL specific to this Logz Organization. - -## PlanData -### Properties -* **billingCycle**: string: different billing cycles like MONTHLY/WEEKLY. this could be enum -* **effectiveDate**: string: date when plan was applied -* **planDetails**: string: plan id as published by Logz -* **usageType**: string: different usage type like PAYG/COMMITTED. this could be enum - -## UserInfo -### Properties -* **emailAddress**: string: Email of the user used by Logz for contacting them if needed -* **firstName**: string: First Name of the user -* **lastName**: string: Last Name of the user -* **phoneNumber**: string: Phone number of the user used by Logz for contacting them if needed - -## SystemData +## LogRules ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. +* **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. +* **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. ## LogzMonitorResourceTags ### Properties @@ -139,24 +111,12 @@ ### Additional Properties * **Additional Properties Type**: string -## MonitoringTagRulesProperties -### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. - -## LogRules -### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. -* **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. -* **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. - -## FilteringTag +## LogzOrganizationProperties ### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. +* **companyName**: string: Name of the Logz organization. +* **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign on. +* **id**: string (ReadOnly): Id of the Logz organization. +* **singleSignOnUrl**: string: The login URL specific to this Logz Organization. ## LogzSingleSignOnProperties ### Properties @@ -165,11 +125,6 @@ * **singleSignOnState**: 'Disable' | 'Enable' | 'Existing' | 'Initial' | string: Various states of the SSO resource * **singleSignOnUrl**: string: The login URL specific to this Logz Organization. -## MonitoredResourceListResponse -### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. - ## MonitoredResource ### Properties * **id**: string (ReadOnly): The ARM id of the resource. @@ -184,23 +139,63 @@ * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## UserRoleRequest +## MonitoredResourceListResponse ### Properties -* **emailAddress**: string (WriteOnly): Email of the user used by Logz for contacting them if needed +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. + +## MonitoringTagRulesProperties +### Properties +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. + +## MonitorProperties +### Properties +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **logzOrganizationProperties**: [LogzOrganizationProperties](#logzorganizationproperties) +* **marketplaceSubscriptionStatus**: 'Active' | 'Suspended' | string: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **planData**: [PlanData](#plandata) +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **userInfo**: [UserInfo](#userinfo) + +## PlanData +### Properties +* **billingCycle**: string: different billing cycles like MONTHLY/WEEKLY. this could be enum +* **effectiveDate**: string: date when plan was applied +* **planDetails**: string: plan id as published by Logz +* **usageType**: string: different usage type like PAYG/COMMITTED. this could be enum + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserInfo +### Properties +* **emailAddress**: string: Email of the user used by Logz for contacting them if needed +* **firstName**: string: First Name of the user +* **lastName**: string: Last Name of the user +* **phoneNumber**: string: Phone number of the user used by Logz for contacting them if needed ## UserRoleListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [UserRoleResponse](#userroleresponse)[] (ReadOnly): List of user roles for Logz.io account. -## UserRoleResponse +## UserRoleRequest ### Properties -* **role**: 'Admin' | 'None' | 'User' | string (ReadOnly): User roles on configured in Logz.io account. +* **emailAddress**: string (WriteOnly): Email of the user used by Logz for contacting them if needed -## VMResourcesListResponse +## UserRoleResponse ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. +* **role**: 'Admin' | 'None' | 'User' | string (ReadOnly): User roles on configured in Logz.io account. ## VMResources ### Properties @@ -212,3 +207,8 @@ * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. +## VMResourcesListResponse +### Properties +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. + diff --git a/generated/logz/microsoft.logz/2022-01-01-preview/types.md b/generated/logz/microsoft.logz/2022-01-01-preview/types.md index fa8cbdcb68..8acd260232 100644 --- a/generated/logz/microsoft.logz/2022-01-01-preview/types.md +++ b/generated/logz/microsoft.logz/2022-01-01-preview/types.md @@ -105,52 +105,24 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [VMResourcesListResponse](#vmresourceslistresponse) +## FilteringTag +### Properties +* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +* **name**: string: The name (also known as the key) of the tag. +* **value**: string: The value of the tag. + ## IdentityProperties ### Properties * **principalId**: string (ReadOnly): The identity ID. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned' | 'UserAssigned' | string -## MonitorProperties -### Properties -* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) -* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. -* **logzOrganizationProperties**: [LogzOrganizationProperties](#logzorganizationproperties) -* **marketplaceSubscriptionStatus**: 'Active' | 'Suspended' | string: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. -* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. -* **planData**: [PlanData](#plandata) -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **userInfo**: [UserInfo](#userinfo) - -## LogzOrganizationProperties -### Properties -* **companyName**: string: Name of the Logz organization. -* **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign on. -* **id**: string (ReadOnly): Id of the Logz organization. -* **singleSignOnUrl**: string: The login URL specific to this Logz Organization. - -## PlanData -### Properties -* **billingCycle**: string: different billing cycles like MONTHLY/WEEKLY. this could be enum -* **effectiveDate**: string: date when plan was applied -* **planDetails**: string: plan id as published by Logz -* **usageType**: string: different usage type like PAYG/COMMITTED. this could be enum - -## UserInfo -### Properties -* **emailAddress**: string: Email of the user used by Logz for contacting them if needed -* **firstName**: string: First Name of the user -* **lastName**: string: Last Name of the user -* **phoneNumber**: string: Phone number of the user used by Logz for contacting them if needed - -## SystemData +## LogRules ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. +* **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. +* **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. ## LogzMonitorResourceTags ### Properties @@ -162,41 +134,17 @@ ### Additional Properties * **Additional Properties Type**: string -## MonitoringTagRulesProperties -### Properties -* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. - -## LogRules -### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -* **sendAadLogs**: bool: Flag specifying if AAD logs should be sent for the Monitor resource. -* **sendActivityLogs**: bool: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. -* **sendSubscriptionLogs**: bool: Flag specifying if subscription logs should be sent for the Monitor resource. - -## FilteringTag -### Properties -* **action**: 'Exclude' | 'Include' | string: Valid actions for a filtering tag. Exclusion takes priority over inclusion. -* **name**: string: The name (also known as the key) of the tag. -* **value**: string: The value of the tag. - ## LogzMonitorResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MetricsTagRulesProperties -### Properties -* **metricRules**: [MetricRules](#metricrules)[]: Array of MetricRules -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. -* **sendMetrics**: bool: Flag specifying if metrics from Azure resources should be sent for the Monitor resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. - -## MetricRules +## LogzOrganizationProperties ### Properties -* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. -* **subscriptionId**: string: Subscription Id for which filtering tags are applicable +* **companyName**: string: Name of the Logz organization. +* **enterpriseAppId**: string: The Id of the Enterprise App used for Single sign on. +* **id**: string (ReadOnly): Id of the Logz organization. +* **singleSignOnUrl**: string: The login URL specific to this Logz Organization. ## LogzSingleSignOnProperties ### Properties @@ -205,10 +153,17 @@ * **singleSignOnState**: 'Disable' | 'Enable' | 'Existing' | 'Initial' | string: Various states of the SSO resource * **singleSignOnUrl**: string: The login URL specific to this Logz Organization. -## MonitoredResourceListResponse +## MetricRules ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. +* **filteringTags**: [FilteringTag](#filteringtag)[]: List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. +* **subscriptionId**: string: Subscription Id for which filtering tags are applicable + +## MetricsTagRulesProperties +### Properties +* **metricRules**: [MetricRules](#metricrules)[]: Array of MetricRules +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **sendMetrics**: bool: Flag specifying if metrics from Azure resources should be sent for the Monitor resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. ## MonitoredResource ### Properties @@ -224,23 +179,63 @@ * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. -## UserRoleRequest +## MonitoredResourceListResponse ### Properties -* **emailAddress**: string (WriteOnly): Email of the user used by Logz for contacting them if needed +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [MonitoredResource](#monitoredresource)[] (ReadOnly): Results of a list operation. + +## MonitoringTagRulesProperties +### Properties +* **logRules**: [LogRules](#logrules): Set of rules for sending logs for the Monitor resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. + +## MonitorProperties +### Properties +* **liftrResourceCategory**: 'MonitorLogs' | 'Unknown' | string (ReadOnly) +* **liftrResourcePreference**: int (ReadOnly): The priority of the resource. +* **logzOrganizationProperties**: [LogzOrganizationProperties](#logzorganizationproperties) +* **marketplaceSubscriptionStatus**: 'Active' | 'Suspended' | string: Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. +* **monitoringStatus**: 'Disabled' | 'Enabled' | string: Flag specifying if the resource monitoring is enabled or disabled. +* **planData**: [PlanData](#plandata) +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Succeeded' | 'Updating' | string (ReadOnly): Flag specifying if the resource provisioning state as tracked by ARM. +* **userInfo**: [UserInfo](#userinfo) + +## PlanData +### Properties +* **billingCycle**: string: different billing cycles like MONTHLY/WEEKLY. this could be enum +* **effectiveDate**: string: date when plan was applied +* **planDetails**: string: plan id as published by Logz +* **usageType**: string: different usage type like PAYG/COMMITTED. this could be enum + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserInfo +### Properties +* **emailAddress**: string: Email of the user used by Logz for contacting them if needed +* **firstName**: string: First Name of the user +* **lastName**: string: Last Name of the user +* **phoneNumber**: string: Phone number of the user used by Logz for contacting them if needed ## UserRoleListResponse ### Properties * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [UserRoleResponse](#userroleresponse)[] (ReadOnly): List of user roles for Logz.io account. -## UserRoleResponse +## UserRoleRequest ### Properties -* **role**: 'Admin' | 'None' | 'User' | string (ReadOnly): User roles on configured in Logz.io account. +* **emailAddress**: string (WriteOnly): Email of the user used by Logz for contacting them if needed -## VMResourcesListResponse +## UserRoleResponse ### Properties -* **nextLink**: string (ReadOnly): Link to the next set of results, if any. -* **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. +* **role**: 'Admin' | 'None' | 'User' | string (ReadOnly): User roles on configured in Logz.io account. ## VMResources ### Properties @@ -252,3 +247,8 @@ * **nextLink**: string (ReadOnly): Link to the next set of results, if any. * **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. +## VMResourcesListResponse +### Properties +* **nextLink**: string (ReadOnly): Link to the next set of results, if any. +* **value**: [VMResources](#vmresources)[] (ReadOnly): Response of a list vm host update operation. + diff --git a/generated/m365securityandcompliance/log.out b/generated/m365securityandcompliance/log.out index e79c5ac354..2a0824a23b 100644 --- a/generated/m365securityandcompliance/log.out +++ b/generated/m365securityandcompliance/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.m365securityandcompliance-2021-03-25-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/m365securityandcompliance/resource-manager/Microsoft.M365SecurityAndCompliance/preview/2021-03-25-preview/common-types.json:208:5 @@ -31,5 +31,5 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'OperationResultsDescription-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/m365securityandcompliance/resource-manager/Microsoft.M365SecurityAndCompliance/preview/2021-03-25-preview/common-types.json#/components/schemas/OperationResultsDescription-properties -info | autorest.bicep took 16ms -info | Autorest completed in 7.42s. 2 files generated. +info | autorest.bicep took 15ms +info | Autorest completed in 6.84s. 2 files generated. diff --git a/generated/m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.md b/generated/m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.md index 975070dab6..8b6a8be0c3 100644 --- a/generated/m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.md +++ b/generated/m365securityandcompliance/microsoft.m365securityandcompliance/2021-03-25-preview/types.md @@ -150,22 +150,29 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## PrivateEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ServicesProperties +## PrivateEndpointConnection ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ServiceAccessPolicyEntry ### Properties @@ -194,38 +201,22 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState +## ServicesProperties ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## SystemData +## ServicesResourceIdentity ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. ## ServicesResourceTags ### Properties @@ -257,3 +248,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/machinelearning/log.out b/generated/machinelearning/log.out index e364e2070b..20420ed9df 100644 --- a/generated/machinelearning/log.out +++ b/generated/machinelearning/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.machinelearning-2017-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json:413:5 @@ -21,11 +21,11 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.machinelearning-2016-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SkuRestrictions' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json:596:5 @@ -57,11 +57,11 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CommitmentPlan' warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.machinelearning-2016-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json:412:5 @@ -78,11 +78,11 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json:635:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.machinelearning-2019-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2019-10-01/workspaces.json:412:5 @@ -99,5 +99,5 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2019-10-01/workspaces.json:636:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms -info | Autorest completed in 10.6s. 8 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 10.37s. 8 files generated. diff --git a/generated/machinelearning/microsoft.machinelearning/2016-04-01/types.md b/generated/machinelearning/microsoft.machinelearning/2016-04-01/types.md index 00e32ce580..8f652bf256 100644 --- a/generated/machinelearning/microsoft.machinelearning/2016-04-01/types.md +++ b/generated/machinelearning/microsoft.machinelearning/2016-04-01/types.md @@ -16,6 +16,16 @@ * **ApiVersion**: 2016-04-01 * **Output**: [WorkspaceKeysResponse](#workspacekeysresponse) +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## WorkspaceKeysResponse +### Properties +* **primaryToken**: string (ReadOnly): Primary authorization key for this workspace. +* **secondaryToken**: string (ReadOnly): Secondary authorization key for this workspace. + ## WorkspaceProperties ### Properties * **creationTime**: string (ReadOnly): The creation time for this workspace resource. @@ -27,13 +37,3 @@ * **workspaceState**: 'Deleted' | 'Disabled' | 'Enabled' | 'Migrated' | 'Registered' | 'Unregistered' | 'Updated' (ReadOnly): The current state of workspace resource. * **workspaceType**: 'Anonymous' | 'Free' | 'PaidPremium' | 'PaidStandard' | 'Production' (ReadOnly): The type of this workspace. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WorkspaceKeysResponse -### Properties -* **primaryToken**: string (ReadOnly): Primary authorization key for this workspace. -* **secondaryToken**: string (ReadOnly): Secondary authorization key for this workspace. - diff --git a/generated/machinelearning/microsoft.machinelearning/2016-05-01-preview/types.md b/generated/machinelearning/microsoft.machinelearning/2016-05-01-preview/types.md index 2c6b68f090..d9e5934ea4 100644 --- a/generated/machinelearning/microsoft.machinelearning/2016-05-01-preview/types.md +++ b/generated/machinelearning/microsoft.machinelearning/2016-05-01-preview/types.md @@ -24,6 +24,49 @@ * **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. * **type**: 'Microsoft.MachineLearning/webServices' (ReadOnly, DeployTimeConstant): The resource type +## AssetItem +### Properties +* **id**: string: Asset's Id. +* **inputPorts**: [AssetItemInputPorts](#assetiteminputports): Information about the asset's input ports. +* **locationInfo**: [AssetLocation](#assetlocation) (Required): Describes the access location for a web service asset. +* **metadata**: [AssetItemMetadata](#assetitemmetadata): If the asset is a custom module, this holds the module's metadata. +* **name**: string (Required): Asset's friendly name. +* **outputPorts**: [AssetItemOutputPorts](#assetitemoutputports): Information about the asset's output ports. +* **parameters**: [ModuleAssetParameter](#moduleassetparameter)[]: If the asset is a custom module, this holds the module's parameters. +* **type**: 'Module' | 'Resource' | string (Required): Asset's type. + +## AssetItemInputPorts +### Properties +### Additional Properties +* **Additional Properties Type**: [InputPort](#inputport) + +## AssetItemMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AssetItemOutputPorts +### Properties +### Additional Properties +* **Additional Properties Type**: [OutputPort](#outputport) + +## AssetLocation +### Properties +* **credentials**: string: Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI) +* **uri**: string (Required): The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets + +## ColumnSpecification +### Properties +* **enum**: any[]: If the data type is categorical, this provides the list of accepted categories. +* **format**: 'Byte' | 'Char' | 'Complex128' | 'Complex64' | 'Date-time' | 'Date-timeOffset' | 'Double' | 'Duration' | 'Float' | 'Int16' | 'Int32' | 'Int64' | 'Int8' | 'Uint16' | 'Uint32' | 'Uint64' | 'Uint8' | string: Additional format information for the data type. +* **type**: 'Boolean' | 'Integer' | 'Number' | 'String' | string (Required): Data type of the column. +* **x-ms-isnullable**: bool: Flag indicating if the type supports null values or not. +* **x-ms-isordered**: bool: Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. + +## CommitmentPlanAutoGenerated +### Properties +* **id**: string (Required): Specifies the Azure Resource Manager ID of the commitment plan associated with the web service. + ## CommitmentPlanProperties ### Properties * **chargeForOverage**: bool (ReadOnly): Indicates whether usage beyond the commitment plan's included quantities will be charged. @@ -42,96 +85,84 @@ ### Additional Properties * **Additional Properties Type**: [PlanQuantity](#planquantity) -## PlanQuantity +## DiagnosticsConfiguration ### Properties -* **allowance**: int (ReadOnly): The quantity added to the commitment plan at an interval specified by its allowance frequency. -* **amount**: int (ReadOnly): The quantity available to the plan the last time usage was calculated. -* **includedQuantityMeter**: string (ReadOnly): The Azure meter for usage against included quantities. -* **overageMeter**: string (ReadOnly): The Azure meter for usage which exceeds included quantities. +* **expiry**: string: Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited. +* **level**: 'All' | 'Error' | 'None' | string (Required): 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). -## ResourceSku +## ExampleRequest ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name. Along with tier, uniquely identifies the SKU. -* **tier**: string: The SKU tier. Along with name, uniquely identifies the SKU. +* **globalParameters**: [ExampleRequestGlobalParameters](#examplerequestglobalparameters): Sample input data for the web service's global parameters +* **inputs**: [ExampleRequestInputs](#examplerequestinputs): Sample input data for the web service's input(s) given as an input name to sample input values matrix map. -## Tags +## ExampleRequestGlobalParameters ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any -## WebServiceProperties -* **Discriminator**: packageType +## ExampleRequestInputs +### Properties +### Additional Properties +* **Additional Properties Type**: any[][] -### Base Properties -* **assets**: [WebServicePropertiesAssets](#webservicepropertiesassets): Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. -* **commitmentPlan**: [CommitmentPlanAutoGenerated](#commitmentplanautogenerated): Information about the machine learning commitment plan associated with the web service. -* **createdOn**: string (ReadOnly): Read Only: The date and time when the web service was created. -* **description**: string: The description of the web service. -* **diagnostics**: [DiagnosticsConfiguration](#diagnosticsconfiguration): Diagnostics settings for an Azure ML web service. -* **exampleRequest**: [ExampleRequest](#examplerequest): Sample input data for the service's input(s). -* **exposeSampleData**: bool: When set to true, sample data is included in the web service's swagger definition. The default value is true. -* **input**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ -* **keys**: [WebServiceKeys](#webservicekeys): Access keys for the web service calls. -* **machineLearningWorkspace**: [MachineLearningWorkspace](#machinelearningworkspace): Information about the machine learning workspace containing the experiment that is source for the web service. -* **modifiedOn**: string (ReadOnly): Read Only: The date and time when the web service was last modified. -* **output**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ -* **parameters**: [WebServicePropertiesParameters](#webservicepropertiesparameters): 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. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | string (ReadOnly): Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. -* **readOnly**: bool: 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. -* **realtimeConfiguration**: [RealtimeConfiguration](#realtimeconfiguration): Holds the available configuration options for an Azure ML web service endpoint. -* **storageAccount**: [StorageAccount](#storageaccount): Access information for a storage account. -* **swaggerLocation**: string (ReadOnly): Read Only: Contains the URI of the swagger spec associated with this web service. -* **title**: string: The title of the web service. -### WebServicePropertiesForGraph -#### Properties -* **package**: [GraphPackage](#graphpackage): Defines the graph of modules making up the machine learning solution. -* **packageType**: 'Graph' (Required): Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. +## GraphEdge +### Properties +* **sourceNodeId**: string: The source graph node's identifier. +* **sourcePortId**: string: The identifier of the source node's port that the edge connects from. +* **targetNodeId**: string: The destination graph node's identifier. +* **targetPortId**: string: The identifier of the destination node's port that the edge connects into. +## GraphNode +### Properties +* **assetId**: string: The id of the asset represented by this node. +* **inputId**: string: The id of the input element represented by this node. +* **outputId**: string: The id of the output element represented by this node. +* **parameters**: [GraphNodeParameters](#graphnodeparameters): If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. -## WebServicePropertiesAssets +## GraphNodeParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [AssetItem](#assetitem) +* **Additional Properties Type**: string -## AssetItem +## GraphPackage ### Properties -* **id**: string: Asset's Id. -* **inputPorts**: [AssetItemInputPorts](#assetiteminputports): Information about the asset's input ports. -* **locationInfo**: [AssetLocation](#assetlocation) (Required): Describes the access location for a web service asset. -* **metadata**: [AssetItemMetadata](#assetitemmetadata): If the asset is a custom module, this holds the module's metadata. -* **name**: string (Required): Asset's friendly name. -* **outputPorts**: [AssetItemOutputPorts](#assetitemoutputports): Information about the asset's output ports. -* **parameters**: [ModuleAssetParameter](#moduleassetparameter)[]: If the asset is a custom module, this holds the module's parameters. -* **type**: 'Module' | 'Resource' | string (Required): Asset's type. +* **edges**: [GraphEdge](#graphedge)[]: The list of edges making up the graph. +* **graphParameters**: [GraphPackageGraphParameters](#graphpackagegraphparameters): 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. +* **nodes**: [GraphPackageNodes](#graphpackagenodes): The set of nodes making up the graph, provided as a nodeId to GraphNode map -## AssetItemInputPorts +## GraphPackageGraphParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [InputPort](#inputport) +* **Additional Properties Type**: [GraphParameter](#graphparameter) -## InputPort +## GraphPackageNodes ### Properties -* **type**: 'Dataset' | string: Port data type. +### Additional Properties +* **Additional Properties Type**: [GraphNode](#graphnode) -## AssetLocation +## GraphParameter ### Properties -* **credentials**: string: Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI) -* **uri**: string (Required): The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets +* **description**: string: Description of this graph parameter. +* **links**: [GraphParameterLink](#graphparameterlink)[] (Required): Association links for this parameter to nodes in the graph. +* **type**: 'Boolean' | 'ColumnPicker' | 'Credential' | 'DataGatewayName' | 'Double' | 'Enumerated' | 'Float' | 'Int' | 'Mode' | 'ParameterRange' | 'Script' | 'String' | string (Required): Graph parameter's type. -## AssetItemMetadata +## GraphParameterLink ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nodeId**: string (Required): The graph node's identifier +* **parameterKey**: string (Required): The identifier of the node parameter that the global parameter maps to. -## AssetItemOutputPorts +## InputPort ### Properties -### Additional Properties -* **Additional Properties Type**: [OutputPort](#outputport) +* **type**: 'Dataset' | string: Port data type. -## OutputPort +## MachineLearningWorkspace ### Properties -* **type**: 'Dataset' | string: Port data type. +* **id**: string (Required): Specifies the workspace ID of the machine learning workspace associated with the web service + +## ModeValueInfo +### Properties +* **interfaceString**: string: The interface string name for the nested parameter. +* **parameters**: [ModuleAssetParameter](#moduleassetparameter)[]: The definition of the parameter. ## ModuleAssetParameter ### Properties @@ -144,34 +175,31 @@ ### Additional Properties * **Additional Properties Type**: [ModeValueInfo](#modevalueinfo) -## ModeValueInfo -### Properties -* **interfaceString**: string: The interface string name for the nested parameter. -* **parameters**: [ModuleAssetParameter](#moduleassetparameter)[]: The definition of the parameter. - -## CommitmentPlanAutoGenerated +## OutputPort ### Properties -* **id**: string (Required): Specifies the Azure Resource Manager ID of the commitment plan associated with the web service. +* **type**: 'Dataset' | string: Port data type. -## DiagnosticsConfiguration +## PlanQuantity ### Properties -* **expiry**: string: Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited. -* **level**: 'All' | 'Error' | 'None' | string (Required): 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). +* **allowance**: int (ReadOnly): The quantity added to the commitment plan at an interval specified by its allowance frequency. +* **amount**: int (ReadOnly): The quantity available to the plan the last time usage was calculated. +* **includedQuantityMeter**: string (ReadOnly): The Azure meter for usage against included quantities. +* **overageMeter**: string (ReadOnly): The Azure meter for usage which exceeds included quantities. -## ExampleRequest +## RealtimeConfiguration ### Properties -* **globalParameters**: [ExampleRequestGlobalParameters](#examplerequestglobalparameters): Sample input data for the web service's global parameters -* **inputs**: [ExampleRequestInputs](#examplerequestinputs): Sample input data for the web service's input(s) given as an input name to sample input values matrix map. +* **maxConcurrentCalls**: int: Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. -## ExampleRequestGlobalParameters +## ResourceSku ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **capacity**: int: 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. +* **name**: string: The SKU name. Along with tier, uniquely identifies the SKU. +* **tier**: string: The SKU tier. Along with name, uniquely identifies the SKU. -## ExampleRequestInputs +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: any[][] +* **Additional Properties Type**: string ## ServiceInputOutputSpecification ### Properties @@ -185,6 +213,11 @@ ### Additional Properties * **Additional Properties Type**: [TableSpecification](#tablespecification) +## StorageAccount +### Properties +* **key**: string: Specifies the key used to access the storage account. +* **name**: string: Specifies the name of the storage account. + ## TableSpecification ### Properties * **description**: string: Swagger schema description. @@ -198,84 +231,51 @@ ### Additional Properties * **Additional Properties Type**: [ColumnSpecification](#columnspecification) -## ColumnSpecification +## Tags ### Properties -* **enum**: any[]: If the data type is categorical, this provides the list of accepted categories. -* **format**: 'Byte' | 'Char' | 'Complex128' | 'Complex64' | 'Date-time' | 'Date-timeOffset' | 'Double' | 'Duration' | 'Float' | 'Int16' | 'Int32' | 'Int64' | 'Int8' | 'Uint16' | 'Uint32' | 'Uint64' | 'Uint8' | string: Additional format information for the data type. -* **type**: 'Boolean' | 'Integer' | 'Number' | 'String' | string (Required): Data type of the column. -* **x-ms-isnullable**: bool: Flag indicating if the type supports null values or not. -* **x-ms-isordered**: bool: Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. +### Additional Properties +* **Additional Properties Type**: string ## WebServiceKeys ### Properties * **primary**: string: The primary access key. * **secondary**: string: The secondary access key. -## MachineLearningWorkspace -### Properties -* **id**: string (Required): Specifies the workspace ID of the machine learning workspace associated with the web service - -## WebServicePropertiesParameters -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RealtimeConfiguration -### Properties -* **maxConcurrentCalls**: int: Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. - -## StorageAccount -### Properties -* **key**: string: Specifies the key used to access the storage account. -* **name**: string: Specifies the name of the storage account. - -## GraphPackage -### Properties -* **edges**: [GraphEdge](#graphedge)[]: The list of edges making up the graph. -* **graphParameters**: [GraphPackageGraphParameters](#graphpackagegraphparameters): 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. -* **nodes**: [GraphPackageNodes](#graphpackagenodes): The set of nodes making up the graph, provided as a nodeId to GraphNode map - -## GraphEdge -### Properties -* **sourceNodeId**: string: The source graph node's identifier. -* **sourcePortId**: string: The identifier of the source node's port that the edge connects from. -* **targetNodeId**: string: The destination graph node's identifier. -* **targetPortId**: string: The identifier of the destination node's port that the edge connects into. - -## GraphPackageGraphParameters -### Properties -### Additional Properties -* **Additional Properties Type**: [GraphParameter](#graphparameter) - -## GraphParameter -### Properties -* **description**: string: Description of this graph parameter. -* **links**: [GraphParameterLink](#graphparameterlink)[] (Required): Association links for this parameter to nodes in the graph. -* **type**: 'Boolean' | 'ColumnPicker' | 'Credential' | 'DataGatewayName' | 'Double' | 'Enumerated' | 'Float' | 'Int' | 'Mode' | 'ParameterRange' | 'Script' | 'String' | string (Required): Graph parameter's type. - -## GraphParameterLink -### Properties -* **nodeId**: string (Required): The graph node's identifier -* **parameterKey**: string (Required): The identifier of the node parameter that the global parameter maps to. +## WebServiceProperties +* **Discriminator**: packageType -## GraphPackageNodes -### Properties -### Additional Properties -* **Additional Properties Type**: [GraphNode](#graphnode) +### Base Properties +* **assets**: [WebServicePropertiesAssets](#webservicepropertiesassets): Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. +* **commitmentPlan**: [CommitmentPlanAutoGenerated](#commitmentplanautogenerated): Information about the machine learning commitment plan associated with the web service. +* **createdOn**: string (ReadOnly): Read Only: The date and time when the web service was created. +* **description**: string: The description of the web service. +* **diagnostics**: [DiagnosticsConfiguration](#diagnosticsconfiguration): Diagnostics settings for an Azure ML web service. +* **exampleRequest**: [ExampleRequest](#examplerequest): Sample input data for the service's input(s). +* **exposeSampleData**: bool: When set to true, sample data is included in the web service's swagger definition. The default value is true. +* **input**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ +* **keys**: [WebServiceKeys](#webservicekeys): Access keys for the web service calls. +* **machineLearningWorkspace**: [MachineLearningWorkspace](#machinelearningworkspace): Information about the machine learning workspace containing the experiment that is source for the web service. +* **modifiedOn**: string (ReadOnly): Read Only: The date and time when the web service was last modified. +* **output**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ +* **parameters**: [WebServicePropertiesParameters](#webservicepropertiesparameters): 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. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | string (ReadOnly): Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. +* **readOnly**: bool: 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. +* **realtimeConfiguration**: [RealtimeConfiguration](#realtimeconfiguration): Holds the available configuration options for an Azure ML web service endpoint. +* **storageAccount**: [StorageAccount](#storageaccount): Access information for a storage account. +* **swaggerLocation**: string (ReadOnly): Read Only: Contains the URI of the swagger spec associated with this web service. +* **title**: string: The title of the web service. +### WebServicePropertiesForGraph +#### Properties +* **package**: [GraphPackage](#graphpackage): Defines the graph of modules making up the machine learning solution. +* **packageType**: 'Graph' (Required): Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. -## GraphNode -### Properties -* **assetId**: string: The id of the asset represented by this node. -* **inputId**: string: The id of the input element represented by this node. -* **outputId**: string: The id of the output element represented by this node. -* **parameters**: [GraphNodeParameters](#graphnodeparameters): If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. -## GraphNodeParameters +## WebServicePropertiesAssets ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AssetItem](#assetitem) -## ResourceTags +## WebServicePropertiesParameters ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/machinelearning/microsoft.machinelearning/2017-01-01/types.md b/generated/machinelearning/microsoft.machinelearning/2017-01-01/types.md index 0e8ad562f0..ac4859ed9d 100644 --- a/generated/machinelearning/microsoft.machinelearning/2017-01-01/types.md +++ b/generated/machinelearning/microsoft.machinelearning/2017-01-01/types.md @@ -11,42 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. * **type**: 'Microsoft.MachineLearning/webServices' (ReadOnly, DeployTimeConstant): The resource type -## WebServiceProperties -* **Discriminator**: packageType - -### Base Properties -* **assets**: [WebServicePropertiesAssets](#webservicepropertiesassets): Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. -* **commitmentPlan**: [CommitmentPlan](#commitmentplan): Information about the machine learning commitment plan associated with the web service. -* **createdOn**: string (ReadOnly): Read Only: The date and time when the web service was created. -* **description**: string: The description of the web service. -* **diagnostics**: [DiagnosticsConfiguration](#diagnosticsconfiguration): Diagnostics settings for an Azure ML web service. -* **exampleRequest**: [ExampleRequest](#examplerequest): Sample input data for the service's input(s). -* **exposeSampleData**: bool: When set to true, sample data is included in the web service's swagger definition. The default value is true. -* **input**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ -* **keys**: [WebServiceKeys](#webservicekeys): Access keys for the web service calls. -* **machineLearningWorkspace**: [MachineLearningWorkspace](#machinelearningworkspace): Information about the machine learning workspace containing the experiment that is source for the web service. -* **modifiedOn**: string (ReadOnly): Read Only: The date and time when the web service was last modified. -* **output**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ -* **parameters**: [WebServicePropertiesParameters](#webservicepropertiesparameters): 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. -* **payloadsInBlobStorage**: bool: 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. -* **payloadsLocation**: [BlobLocation](#bloblocation): Describes the access location for a blob. -* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | string (ReadOnly): Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. -* **readOnly**: bool: 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. -* **realtimeConfiguration**: [RealtimeConfiguration](#realtimeconfiguration): Holds the available configuration options for an Azure ML web service endpoint. -* **storageAccount**: [StorageAccount](#storageaccount): Access information for a storage account. -* **swaggerLocation**: string (ReadOnly): Read Only: Contains the URI of the swagger spec associated with this web service. -* **title**: string: The title of the web service. -### WebServicePropertiesForGraph -#### Properties -* **package**: [GraphPackage](#graphpackage): Defines the graph of modules making up the machine learning solution. -* **packageType**: 'Graph' (Required): Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. - - -## WebServicePropertiesAssets -### Properties -### Additional Properties -* **Additional Properties Type**: [AssetItem](#assetitem) - ## AssetItem ### Properties * **id**: string: Asset's Id. @@ -63,15 +27,6 @@ ### Additional Properties * **Additional Properties Type**: [InputPort](#inputport) -## InputPort -### Properties -* **type**: 'Dataset' | string: Port data type. - -## BlobLocation -### Properties -* **credentials**: string: Access credentials for the blob, if applicable (e.g. blob specified by storage account connection string + blob URI) -* **uri**: string (Required): The URI from which the blob is accessible from. For example, aml://abc for system assets or https://xyz for user assets or payload. - ## AssetItemMetadata ### Properties ### Additional Properties @@ -82,25 +37,18 @@ ### Additional Properties * **Additional Properties Type**: [OutputPort](#outputport) -## OutputPort -### Properties -* **type**: 'Dataset' | string: Port data type. - -## ModuleAssetParameter -### Properties -* **modeValuesInfo**: [ModuleAssetParameterModeValuesInfo](#moduleassetparametermodevaluesinfo): Definitions for nested interface parameters if this is a complex module parameter. -* **name**: string: Parameter name. -* **parameterType**: string: Parameter type. - -## ModuleAssetParameterModeValuesInfo +## BlobLocation ### Properties -### Additional Properties -* **Additional Properties Type**: [ModeValueInfo](#modevalueinfo) +* **credentials**: string: Access credentials for the blob, if applicable (e.g. blob specified by storage account connection string + blob URI) +* **uri**: string (Required): The URI from which the blob is accessible from. For example, aml://abc for system assets or https://xyz for user assets or payload. -## ModeValueInfo +## ColumnSpecification ### Properties -* **interfaceString**: string: The interface string name for the nested parameter. -* **parameters**: [ModuleAssetParameter](#moduleassetparameter)[]: The definition of the parameter. +* **enum**: any[]: If the data type is categorical, this provides the list of accepted categories. +* **format**: 'Byte' | 'Char' | 'Complex128' | 'Complex64' | 'Date-time' | 'Date-timeOffset' | 'Double' | 'Duration' | 'Float' | 'Int16' | 'Int32' | 'Int64' | 'Int8' | 'Uint16' | 'Uint32' | 'Uint64' | 'Uint8' | string: Additional format information for the data type. +* **type**: 'Boolean' | 'Integer' | 'Number' | 'String' | string (Required): Data type of the column. +* **x-ms-isnullable**: bool: Flag indicating if the type supports null values or not. +* **x-ms-isordered**: bool: Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. ## CommitmentPlan ### Properties @@ -126,115 +74,167 @@ ### Additional Properties * **Additional Properties Type**: any[][] -## ServiceInputOutputSpecification +## GraphEdge ### Properties -* **description**: string: The description of the Swagger schema. -* **properties**: [ServiceInputOutputSpecificationProperties](#serviceinputoutputspecificationproperties) (Required): Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification. -* **title**: string: The title of your Swagger schema. -* **type**: string (Required): The type of the entity described in swagger. Always 'object'. +* **sourceNodeId**: string: The source graph node's identifier. +* **sourcePortId**: string: The identifier of the source node's port that the edge connects from. +* **targetNodeId**: string: The destination graph node's identifier. +* **targetPortId**: string: The identifier of the destination node's port that the edge connects into. -## ServiceInputOutputSpecificationProperties +## GraphNode +### Properties +* **assetId**: string: The id of the asset represented by this node. +* **inputId**: string: The id of the input element represented by this node. +* **outputId**: string: The id of the output element represented by this node. +* **parameters**: [GraphNodeParameters](#graphnodeparameters): If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. + +## GraphNodeParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [TableSpecification](#tablespecification) +* **Additional Properties Type**: [WebServiceParameter](#webserviceparameter) -## TableSpecification +## GraphPackage ### Properties -* **description**: string: Swagger schema description. -* **format**: string: The format, if 'type' is not 'object' -* **properties**: [TableSpecificationProperties](#tablespecificationproperties): The set of columns within the data table. -* **title**: string: Swagger schema title. -* **type**: string (Required): The type of the entity described in swagger. +* **edges**: [GraphEdge](#graphedge)[]: The list of edges making up the graph. +* **graphParameters**: [GraphPackageGraphParameters](#graphpackagegraphparameters): 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. +* **nodes**: [GraphPackageNodes](#graphpackagenodes): The set of nodes making up the graph, provided as a nodeId to GraphNode map -## TableSpecificationProperties +## GraphPackageGraphParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [ColumnSpecification](#columnspecification) +* **Additional Properties Type**: [GraphParameter](#graphparameter) -## ColumnSpecification +## GraphPackageNodes ### Properties -* **enum**: any[]: If the data type is categorical, this provides the list of accepted categories. -* **format**: 'Byte' | 'Char' | 'Complex128' | 'Complex64' | 'Date-time' | 'Date-timeOffset' | 'Double' | 'Duration' | 'Float' | 'Int16' | 'Int32' | 'Int64' | 'Int8' | 'Uint16' | 'Uint32' | 'Uint64' | 'Uint8' | string: Additional format information for the data type. -* **type**: 'Boolean' | 'Integer' | 'Number' | 'String' | string (Required): Data type of the column. -* **x-ms-isnullable**: bool: Flag indicating if the type supports null values or not. -* **x-ms-isordered**: bool: Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column. +### Additional Properties +* **Additional Properties Type**: [GraphNode](#graphnode) -## WebServiceKeys +## GraphParameter ### Properties -* **primary**: string: The primary access key. -* **secondary**: string: The secondary access key. +* **description**: string: Description of this graph parameter. +* **links**: [GraphParameterLink](#graphparameterlink)[] (Required): Association links for this parameter to nodes in the graph. +* **type**: 'Boolean' | 'ColumnPicker' | 'Credential' | 'DataGatewayName' | 'Double' | 'Enumerated' | 'Float' | 'Int' | 'Mode' | 'ParameterRange' | 'Script' | 'String' | string (Required): Graph parameter's type. + +## GraphParameterLink +### Properties +* **nodeId**: string (Required): The graph node's identifier +* **parameterKey**: string (Required): The identifier of the node parameter that the global parameter maps to. + +## InputPort +### Properties +* **type**: 'Dataset' | string: Port data type. ## MachineLearningWorkspace ### Properties * **id**: string (Required): Specifies the workspace ID of the machine learning workspace associated with the web service -## WebServicePropertiesParameters +## ModeValueInfo +### Properties +* **interfaceString**: string: The interface string name for the nested parameter. +* **parameters**: [ModuleAssetParameter](#moduleassetparameter)[]: The definition of the parameter. + +## ModuleAssetParameter +### Properties +* **modeValuesInfo**: [ModuleAssetParameterModeValuesInfo](#moduleassetparametermodevaluesinfo): Definitions for nested interface parameters if this is a complex module parameter. +* **name**: string: Parameter name. +* **parameterType**: string: Parameter type. + +## ModuleAssetParameterModeValuesInfo ### Properties ### Additional Properties -* **Additional Properties Type**: [WebServiceParameter](#webserviceparameter) +* **Additional Properties Type**: [ModeValueInfo](#modevalueinfo) -## WebServiceParameter +## OutputPort ### Properties -* **certificateThumbprint**: string: If the parameter value in 'value' field is encrypted, the thumbprint of the certificate should be put here. -* **value**: any: Any object +* **type**: 'Dataset' | string: Port data type. ## RealtimeConfiguration ### Properties * **maxConcurrentCalls**: int: Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200. -## StorageAccount -### Properties -* **key**: string: Specifies the key used to access the storage account. -* **name**: string: Specifies the name of the storage account. - -## GraphPackage +## ResourceTags ### Properties -* **edges**: [GraphEdge](#graphedge)[]: The list of edges making up the graph. -* **graphParameters**: [GraphPackageGraphParameters](#graphpackagegraphparameters): 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. -* **nodes**: [GraphPackageNodes](#graphpackagenodes): The set of nodes making up the graph, provided as a nodeId to GraphNode map +### Additional Properties +* **Additional Properties Type**: string -## GraphEdge +## ServiceInputOutputSpecification ### Properties -* **sourceNodeId**: string: The source graph node's identifier. -* **sourcePortId**: string: The identifier of the source node's port that the edge connects from. -* **targetNodeId**: string: The destination graph node's identifier. -* **targetPortId**: string: The identifier of the destination node's port that the edge connects into. +* **description**: string: The description of the Swagger schema. +* **properties**: [ServiceInputOutputSpecificationProperties](#serviceinputoutputspecificationproperties) (Required): Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification. +* **title**: string: The title of your Swagger schema. +* **type**: string (Required): The type of the entity described in swagger. Always 'object'. -## GraphPackageGraphParameters +## ServiceInputOutputSpecificationProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [GraphParameter](#graphparameter) +* **Additional Properties Type**: [TableSpecification](#tablespecification) -## GraphParameter +## StorageAccount ### Properties -* **description**: string: Description of this graph parameter. -* **links**: [GraphParameterLink](#graphparameterlink)[] (Required): Association links for this parameter to nodes in the graph. -* **type**: 'Boolean' | 'ColumnPicker' | 'Credential' | 'DataGatewayName' | 'Double' | 'Enumerated' | 'Float' | 'Int' | 'Mode' | 'ParameterRange' | 'Script' | 'String' | string (Required): Graph parameter's type. +* **key**: string: Specifies the key used to access the storage account. +* **name**: string: Specifies the name of the storage account. -## GraphParameterLink +## TableSpecification ### Properties -* **nodeId**: string (Required): The graph node's identifier -* **parameterKey**: string (Required): The identifier of the node parameter that the global parameter maps to. +* **description**: string: Swagger schema description. +* **format**: string: The format, if 'type' is not 'object' +* **properties**: [TableSpecificationProperties](#tablespecificationproperties): The set of columns within the data table. +* **title**: string: Swagger schema title. +* **type**: string (Required): The type of the entity described in swagger. -## GraphPackageNodes +## TableSpecificationProperties ### Properties ### Additional Properties -* **Additional Properties Type**: [GraphNode](#graphnode) +* **Additional Properties Type**: [ColumnSpecification](#columnspecification) -## GraphNode +## WebServiceKeys ### Properties -* **assetId**: string: The id of the asset represented by this node. -* **inputId**: string: The id of the input element represented by this node. -* **outputId**: string: The id of the output element represented by this node. -* **parameters**: [GraphNodeParameters](#graphnodeparameters): If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime. +* **primary**: string: The primary access key. +* **secondary**: string: The secondary access key. -## GraphNodeParameters +## WebServiceParameter +### Properties +* **certificateThumbprint**: string: If the parameter value in 'value' field is encrypted, the thumbprint of the certificate should be put here. +* **value**: any: Any object + +## WebServiceProperties +* **Discriminator**: packageType + +### Base Properties +* **assets**: [WebServicePropertiesAssets](#webservicepropertiesassets): Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs. +* **commitmentPlan**: [CommitmentPlan](#commitmentplan): Information about the machine learning commitment plan associated with the web service. +* **createdOn**: string (ReadOnly): Read Only: The date and time when the web service was created. +* **description**: string: The description of the web service. +* **diagnostics**: [DiagnosticsConfiguration](#diagnosticsconfiguration): Diagnostics settings for an Azure ML web service. +* **exampleRequest**: [ExampleRequest](#examplerequest): Sample input data for the service's input(s). +* **exposeSampleData**: bool: When set to true, sample data is included in the web service's swagger definition. The default value is true. +* **input**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ +* **keys**: [WebServiceKeys](#webservicekeys): Access keys for the web service calls. +* **machineLearningWorkspace**: [MachineLearningWorkspace](#machinelearningworkspace): Information about the machine learning workspace containing the experiment that is source for the web service. +* **modifiedOn**: string (ReadOnly): Read Only: The date and time when the web service was last modified. +* **output**: [ServiceInputOutputSpecification](#serviceinputoutputspecification): The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/ +* **parameters**: [WebServicePropertiesParameters](#webservicepropertiesparameters): 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. +* **payloadsInBlobStorage**: bool: 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. +* **payloadsLocation**: [BlobLocation](#bloblocation): Describes the access location for a blob. +* **provisioningState**: 'Failed' | 'Provisioning' | 'Succeeded' | 'Unknown' | string (ReadOnly): Read Only: The provision state of the web service. Valid values are Unknown, Provisioning, Succeeded, and Failed. +* **readOnly**: bool: 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. +* **realtimeConfiguration**: [RealtimeConfiguration](#realtimeconfiguration): Holds the available configuration options for an Azure ML web service endpoint. +* **storageAccount**: [StorageAccount](#storageaccount): Access information for a storage account. +* **swaggerLocation**: string (ReadOnly): Read Only: Contains the URI of the swagger spec associated with this web service. +* **title**: string: The title of the web service. +### WebServicePropertiesForGraph +#### Properties +* **package**: [GraphPackage](#graphpackage): Defines the graph of modules making up the machine learning solution. +* **packageType**: 'Graph' (Required): Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time. + + +## WebServicePropertiesAssets ### Properties ### Additional Properties -* **Additional Properties Type**: [WebServiceParameter](#webserviceparameter) +* **Additional Properties Type**: [AssetItem](#assetitem) -## ResourceTags +## WebServicePropertiesParameters ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [WebServiceParameter](#webserviceparameter) diff --git a/generated/machinelearning/microsoft.machinelearning/2019-10-01/types.md b/generated/machinelearning/microsoft.machinelearning/2019-10-01/types.md index c72f5becc3..9243a6845b 100644 --- a/generated/machinelearning/microsoft.machinelearning/2019-10-01/types.md +++ b/generated/machinelearning/microsoft.machinelearning/2019-10-01/types.md @@ -17,29 +17,29 @@ * **ApiVersion**: 2019-10-01 * **Output**: [WorkspaceKeysResponse](#workspacekeysresponse) -## WorkspaceProperties +## ResourceTags ### Properties -* **creationTime**: string (ReadOnly): The creation time for this workspace resource. -* **keyVaultIdentifierId**: string: The key vault identifier used for encrypted workspaces. -* **ownerEmail**: string (Required): The email id of the owner for this workspace. -* **studioEndpoint**: string (ReadOnly): The regional endpoint for the machine learning studio service which hosts this workspace. -* **userStorageAccountId**: string (Required): The fully qualified arm id of the storage account associated with this workspace. -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. -* **workspaceState**: 'Deleted' | 'Disabled' | 'Enabled' | 'Migrated' | 'Registered' | 'Unregistered' | 'Updated' (ReadOnly): The current state of workspace resource. -* **workspaceType**: 'Anonymous' | 'Free' | 'PaidPremium' | 'PaidStandard' | 'Production' (ReadOnly): The type of this workspace. +### Additional Properties +* **Additional Properties Type**: string ## Sku ### Properties * **name**: string: Name of the sku * **tier**: string: Tier of the sku like Basic or Enterprise -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## WorkspaceKeysResponse ### Properties * **primaryToken**: string (ReadOnly): Primary authorization key for this workspace. * **secondaryToken**: string (ReadOnly): Secondary authorization key for this workspace. +## WorkspaceProperties +### Properties +* **creationTime**: string (ReadOnly): The creation time for this workspace resource. +* **keyVaultIdentifierId**: string: The key vault identifier used for encrypted workspaces. +* **ownerEmail**: string (Required): The email id of the owner for this workspace. +* **studioEndpoint**: string (ReadOnly): The regional endpoint for the machine learning studio service which hosts this workspace. +* **userStorageAccountId**: string (Required): The fully qualified arm id of the storage account associated with this workspace. +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **workspaceState**: 'Deleted' | 'Disabled' | 'Enabled' | 'Migrated' | 'Registered' | 'Unregistered' | 'Updated' (ReadOnly): The current state of workspace resource. +* **workspaceType**: 'Anonymous' | 'Free' | 'PaidPremium' | 'PaidStandard' | 'Production' (ReadOnly): The type of this workspace. + diff --git a/generated/machinelearningcompute/log.out b/generated/machinelearningcompute/log.out index 92f66ed222..c05d3cd402 100644 --- a/generated/machinelearningcompute/log.out +++ b/generated/machinelearningcompute/log.out @@ -3,22 +3,22 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.machinelearningcompute-2017-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json:503:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 19ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.machinelearningcompute-2017-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json:520:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 6.52s. 4 files generated. +info | Autorest completed in 6.54s. 4 files generated. diff --git a/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.md b/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.md index 7e17a3960c..15622ad80f 100644 --- a/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.md +++ b/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-06-01-preview/types.md @@ -16,28 +16,6 @@ * **ApiVersion**: 2017-06-01-preview * **Output**: [OperationalizationClusterCredentials](#operationalizationclustercredentials) -## OperationalizationClusterProperties -### Properties -* **appInsights**: [AppInsightsCredentials](#appinsightscredentials): AppInsights credentials. -* **clusterType**: 'ACS' | string (Required): The cluster type. -* **containerRegistry**: [ContainerRegistryProperties](#containerregistryproperties): Properties of Azure Container Registry. -* **containerService**: [AcsClusterProperties](#acsclusterproperties) (Required): Information about the container service backing the cluster -* **createdOn**: string (ReadOnly): The date and time when the cluster was created. -* **description**: string: The description of the cluster. -* **globalServiceConfiguration**: [GlobalServiceConfiguration](#globalserviceconfiguration): Global configuration for services in the cluster. -* **modifiedOn**: string (ReadOnly): The date and time when the cluster was last modified. -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. -* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): Properties of Storage Account. - -## AppInsightsCredentials -### Properties -* **apiKey**: string: The AppInsights API key. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. -* **appId**: string: The AppInsights application ID. - -## ContainerRegistryProperties -### Properties -* **resourceId**: string: ARM resource ID of the Azure Container Registry used to store Docker images for web services in the cluster. If not provided one will be created. This cannot be changed once the cluster is created. - ## AcsClusterProperties ### Properties * **agentCount**: int: The number of agent nodes in the Container Service. This can be changed to scale the cluster. @@ -47,23 +25,10 @@ * **orchestratorType**: 'Kubernetes' | string (Required): Type of orchestrator. It cannot be changed once the cluster is created. * **systemServices**: 'Batch' | 'Scoring' | string[]: The system services deployed to the cluster -## KubernetesClusterProperties -### Properties -* **servicePrincipal**: [ServicePrincipalProperties](#serviceprincipalproperties) (Required): The Azure service principal used by Kubernetes for configuring load balancers - -## ServicePrincipalProperties -### Properties -* **clientId**: string (Required): The service principal client ID -* **secret**: string (Required): The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys. - -## GlobalServiceConfiguration +## AppInsightsCredentials ### Properties -* **autoScale**: [AutoScaleConfiguration](#autoscaleconfiguration): AutoScale configuration properties. -* **etag**: string: The configuration ETag for updates. -* **serviceAuth**: [ServiceAuthConfiguration](#serviceauthconfiguration): Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own. -* **ssl**: [SslConfiguration](#sslconfiguration): SSL configuration. If configured data-plane calls to user services will be exposed over SSL only. -### Additional Properties -* **Additional Properties Type**: string +* **apiKey**: string: The AppInsights API key. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. +* **appId**: string: The AppInsights application ID. ## AutoScaleConfiguration ### Properties @@ -73,26 +38,35 @@ * **status**: 'Disabled' | 'Enabled' | string: SSL status. Allowed values are Enabled and Disabled. * **targetUtilization**: int: The target utilization. -## ServiceAuthConfiguration +## ContainerRegistryCredentials ### Properties -* **primaryAuthKeyHash**: string (Required): The primary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. -* **secondaryAuthKeyHash**: string (Required): The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. +* **loginServer**: string (ReadOnly): The ACR login server name. User name is the first part of the FQDN. +* **password**: string (ReadOnly): The ACR primary password. +* **password2**: string (ReadOnly): The ACR secondary password. -## SslConfiguration +## ContainerRegistryProperties ### Properties -* **cert**: string: The SSL cert data in PEM format encoded as base64 string -* **key**: string: The SSL key data in PEM format encoded as base64 string. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. -* **status**: 'Disabled' | 'Enabled' | string: SSL status. Allowed values are Enabled and Disabled. +* **resourceId**: string: ARM resource ID of the Azure Container Registry used to store Docker images for web services in the cluster. If not provided one will be created. This cannot be changed once the cluster is created. -## StorageAccountProperties +## ContainerServiceCredentials ### Properties -* **resourceId**: string: ARM resource ID of the Azure Storage Account to store CLI specific files. If not provided one will be created. This cannot be changed once the cluster is created. +* **acsKubeConfig**: string (ReadOnly): The ACS kube config file. +* **imagePullSecretName**: string (ReadOnly): The ACR image pull secret name which was created in Kubernetes. +* **servicePrincipalConfiguration**: [ServicePrincipalProperties](#serviceprincipalproperties) (ReadOnly): The Azure service principal used by Kubernetes for configuring load balancers -## ResourceTags +## GlobalServiceConfiguration ### Properties +* **autoScale**: [AutoScaleConfiguration](#autoscaleconfiguration): AutoScale configuration properties. +* **etag**: string: The configuration ETag for updates. +* **serviceAuth**: [ServiceAuthConfiguration](#serviceauthconfiguration): Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own. +* **ssl**: [SslConfiguration](#sslconfiguration): SSL configuration. If configured data-plane calls to user services will be exposed over SSL only. ### Additional Properties * **Additional Properties Type**: string +## KubernetesClusterProperties +### Properties +* **servicePrincipal**: [ServicePrincipalProperties](#serviceprincipalproperties) (Required): The Azure service principal used by Kubernetes for configuring load balancers + ## OperationalizationClusterCredentials ### Properties * **appInsights**: [AppInsightsCredentials](#appinsightscredentials) (ReadOnly): AppInsights credentials. @@ -102,17 +76,39 @@ * **sslConfiguration**: [SslConfiguration](#sslconfiguration) (ReadOnly): SSL configuration. If configured data-plane calls to user services will be exposed over SSL only. * **storageAccount**: [StorageAccountCredentials](#storageaccountcredentials) (ReadOnly): Access information for the storage account. -## ContainerRegistryCredentials +## OperationalizationClusterProperties ### Properties -* **loginServer**: string (ReadOnly): The ACR login server name. User name is the first part of the FQDN. -* **password**: string (ReadOnly): The ACR primary password. -* **password2**: string (ReadOnly): The ACR secondary password. +* **appInsights**: [AppInsightsCredentials](#appinsightscredentials): AppInsights credentials. +* **clusterType**: 'ACS' | string (Required): The cluster type. +* **containerRegistry**: [ContainerRegistryProperties](#containerregistryproperties): Properties of Azure Container Registry. +* **containerService**: [AcsClusterProperties](#acsclusterproperties) (Required): Information about the container service backing the cluster +* **createdOn**: string (ReadOnly): The date and time when the cluster was created. +* **description**: string: The description of the cluster. +* **globalServiceConfiguration**: [GlobalServiceConfiguration](#globalserviceconfiguration): Global configuration for services in the cluster. +* **modifiedOn**: string (ReadOnly): The date and time when the cluster was last modified. +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. +* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): Properties of Storage Account. -## ContainerServiceCredentials +## ResourceTags ### Properties -* **acsKubeConfig**: string (ReadOnly): The ACS kube config file. -* **imagePullSecretName**: string (ReadOnly): The ACR image pull secret name which was created in Kubernetes. -* **servicePrincipalConfiguration**: [ServicePrincipalProperties](#serviceprincipalproperties) (ReadOnly): The Azure service principal used by Kubernetes for configuring load balancers +### Additional Properties +* **Additional Properties Type**: string + +## ServiceAuthConfiguration +### Properties +* **primaryAuthKeyHash**: string (Required): The primary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. +* **secondaryAuthKeyHash**: string (Required): The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. + +## ServicePrincipalProperties +### Properties +* **clientId**: string (Required): The service principal client ID +* **secret**: string (Required): The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys. + +## SslConfiguration +### Properties +* **cert**: string: The SSL cert data in PEM format encoded as base64 string +* **key**: string: The SSL key data in PEM format encoded as base64 string. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. +* **status**: 'Disabled' | 'Enabled' | string: SSL status. Allowed values are Enabled and Disabled. ## StorageAccountCredentials ### Properties @@ -120,3 +116,7 @@ * **resourceId**: string (ReadOnly): The ARM resource ID of the storage account. * **secondaryKey**: string (ReadOnly): The secondary key of the storage account. +## StorageAccountProperties +### Properties +* **resourceId**: string: ARM resource ID of the Azure Storage Account to store CLI specific files. If not provided one will be created. This cannot be changed once the cluster is created. + diff --git a/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.md b/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.md index 800cd45883..e05ad7dc0b 100644 --- a/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.md +++ b/generated/machinelearningcompute/microsoft.machinelearningcompute/2017-08-01-preview/types.md @@ -16,28 +16,6 @@ * **ApiVersion**: 2017-08-01-preview * **Output**: [OperationalizationClusterCredentials](#operationalizationclustercredentials) -## OperationalizationClusterProperties -### Properties -* **appInsights**: [AppInsightsProperties](#appinsightsproperties): Properties of App Insights. -* **clusterType**: 'ACS' | 'Local' | string (Required): The cluster type. -* **containerRegistry**: [ContainerRegistryProperties](#containerregistryproperties): Properties of Azure Container Registry. -* **containerService**: [AcsClusterProperties](#acsclusterproperties): Information about the container service backing the cluster -* **createdOn**: string (ReadOnly): The date and time when the cluster was created. -* **description**: string: The description of the cluster. -* **globalServiceConfiguration**: [GlobalServiceConfiguration](#globalserviceconfiguration): Global configuration for services in the cluster. -* **modifiedOn**: string (ReadOnly): The date and time when the cluster was last modified. -* **provisioningErrors**: [ErrorResponseWrapper](#errorresponsewrapper)[] (ReadOnly): List of provisioning errors reported by the resource provider. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. -* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): Properties of Storage Account. - -## AppInsightsProperties -### Properties -* **resourceId**: string: ARM resource ID of the App Insights. - -## ContainerRegistryProperties -### Properties -* **resourceId**: string: ARM resource ID of the Azure Container Registry used to store Docker images for web services in the cluster. If not provided one will be created. This cannot be changed once the cluster is created. - ## AcsClusterProperties ### Properties * **agentCount**: int: The number of agent nodes in the Container Service. This can be changed to scale the cluster. @@ -48,29 +26,14 @@ * **orchestratorType**: 'Kubernetes' | 'None' | string (Required): Type of orchestrator. It cannot be changed once the cluster is created. * **systemServices**: [SystemService](#systemservice)[]: The system services deployed to the cluster -## KubernetesClusterProperties -### Properties -* **servicePrincipal**: [ServicePrincipalProperties](#serviceprincipalproperties): The Azure service principal used by Kubernetes for configuring load balancers - -## ServicePrincipalProperties -### Properties -* **clientId**: string (Required): The service principal client ID -* **secret**: string (Required): The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys. - -## SystemService +## AppInsightsCredentials ### Properties -* **publicIpAddress**: string (ReadOnly): The public IP address of the system service -* **systemServiceType**: 'BatchFrontEnd' | 'None' | 'ScoringFrontEnd' | string (Required): The system service type -* **version**: string (ReadOnly): The state of the system service +* **appId**: string (ReadOnly): The AppInsights application ID. +* **instrumentationKey**: string (ReadOnly): The AppInsights instrumentation key. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API. -## GlobalServiceConfiguration +## AppInsightsProperties ### Properties -* **autoScale**: [AutoScaleConfiguration](#autoscaleconfiguration): AutoScale configuration properties. -* **etag**: string: The configuration ETag for updates. -* **serviceAuth**: [ServiceAuthConfiguration](#serviceauthconfiguration): Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own. -* **ssl**: [SslConfiguration](#sslconfiguration): SSL configuration. If configured data-plane calls to user services will be exposed over SSL only. -### Additional Properties -* **Additional Properties Type**: any +* **resourceId**: string: ARM resource ID of the App Insights. ## AutoScaleConfiguration ### Properties @@ -80,41 +43,50 @@ * **status**: 'Disabled' | 'Enabled' | string: SSL status. Allowed values are Enabled and Disabled. * **targetUtilization**: int: The target utilization. -## ServiceAuthConfiguration +## ContainerRegistryCredentials ### Properties -* **primaryAuthKeyHash**: string (Required): The primary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. -* **secondaryAuthKeyHash**: string (Required): The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. +* **loginServer**: string (ReadOnly): The ACR login server name. User name is the first part of the FQDN. +* **password**: string (ReadOnly): The ACR primary password. +* **password2**: string (ReadOnly): The ACR secondary password. +* **username**: string (ReadOnly): The ACR login username. -## SslConfiguration +## ContainerRegistryProperties ### Properties -* **cert**: string: The SSL cert data in PEM format. -* **cname**: string: The CName of the certificate. -* **key**: string: The SSL key data in PEM format. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API. -* **status**: 'Disabled' | 'Enabled' | string: SSL status. Allowed values are Enabled and Disabled. +* **resourceId**: string: ARM resource ID of the Azure Container Registry used to store Docker images for web services in the cluster. If not provided one will be created. This cannot be changed once the cluster is created. -## ErrorResponseWrapper +## ContainerServiceCredentials ### Properties -* **error**: [ErrorResponse](#errorresponse): Error response information. +* **acsKubeConfig**: string (ReadOnly): The ACS kube config file. +* **imagePullSecretName**: string (ReadOnly): The ACR image pull secret name which was created in Kubernetes. +* **servicePrincipalConfiguration**: [ServicePrincipalProperties](#serviceprincipalproperties) (ReadOnly): The Azure service principal used by Kubernetes for configuring load balancers -## ErrorResponse +## ErrorDetail ### Properties * **code**: string (Required): Error code. -* **details**: [ErrorDetail](#errordetail)[]: An array of error detail objects. * **message**: string (Required): Error message. -## ErrorDetail +## ErrorResponse ### Properties * **code**: string (Required): Error code. +* **details**: [ErrorDetail](#errordetail)[]: An array of error detail objects. * **message**: string (Required): Error message. -## StorageAccountProperties +## ErrorResponseWrapper ### Properties -* **resourceId**: string: ARM resource ID of the Azure Storage Account to store CLI specific files. If not provided one will be created. This cannot be changed once the cluster is created. +* **error**: [ErrorResponse](#errorresponse): Error response information. -## ResourceTags +## GlobalServiceConfiguration ### Properties +* **autoScale**: [AutoScaleConfiguration](#autoscaleconfiguration): AutoScale configuration properties. +* **etag**: string: The configuration ETag for updates. +* **serviceAuth**: [ServiceAuthConfiguration](#serviceauthconfiguration): Global service auth configuration properties. These are the data-plane authorization keys and are used if a service doesn't define it's own. +* **ssl**: [SslConfiguration](#sslconfiguration): SSL configuration. If configured data-plane calls to user services will be exposed over SSL only. ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any + +## KubernetesClusterProperties +### Properties +* **servicePrincipal**: [ServicePrincipalProperties](#serviceprincipalproperties): The Azure service principal used by Kubernetes for configuring load balancers ## OperationalizationClusterCredentials ### Properties @@ -125,23 +97,41 @@ * **sslConfiguration**: [SslConfiguration](#sslconfiguration) (ReadOnly): SSL configuration. If configured data-plane calls to user services will be exposed over SSL only. * **storageAccount**: [StorageAccountCredentials](#storageaccountcredentials) (ReadOnly): Access information for the storage account. -## AppInsightsCredentials +## OperationalizationClusterProperties ### Properties -* **appId**: string (ReadOnly): The AppInsights application ID. -* **instrumentationKey**: string (ReadOnly): The AppInsights instrumentation key. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API. +* **appInsights**: [AppInsightsProperties](#appinsightsproperties): Properties of App Insights. +* **clusterType**: 'ACS' | 'Local' | string (Required): The cluster type. +* **containerRegistry**: [ContainerRegistryProperties](#containerregistryproperties): Properties of Azure Container Registry. +* **containerService**: [AcsClusterProperties](#acsclusterproperties): Information about the container service backing the cluster +* **createdOn**: string (ReadOnly): The date and time when the cluster was created. +* **description**: string: The description of the cluster. +* **globalServiceConfiguration**: [GlobalServiceConfiguration](#globalserviceconfiguration): Global configuration for services in the cluster. +* **modifiedOn**: string (ReadOnly): The date and time when the cluster was last modified. +* **provisioningErrors**: [ErrorResponseWrapper](#errorresponsewrapper)[] (ReadOnly): List of provisioning errors reported by the resource provider. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. +* **storageAccount**: [StorageAccountProperties](#storageaccountproperties): Properties of Storage Account. -## ContainerRegistryCredentials +## ResourceTags ### Properties -* **loginServer**: string (ReadOnly): The ACR login server name. User name is the first part of the FQDN. -* **password**: string (ReadOnly): The ACR primary password. -* **password2**: string (ReadOnly): The ACR secondary password. -* **username**: string (ReadOnly): The ACR login username. +### Additional Properties +* **Additional Properties Type**: string -## ContainerServiceCredentials +## ServiceAuthConfiguration ### Properties -* **acsKubeConfig**: string (ReadOnly): The ACS kube config file. -* **imagePullSecretName**: string (ReadOnly): The ACR image pull secret name which was created in Kubernetes. -* **servicePrincipalConfiguration**: [ServicePrincipalProperties](#serviceprincipalproperties) (ReadOnly): The Azure service principal used by Kubernetes for configuring load balancers +* **primaryAuthKeyHash**: string (Required): The primary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. +* **secondaryAuthKeyHash**: string (Required): The secondary auth key hash. This is not returned in response of GET/PUT on the resource.. To see this please call listKeys API. + +## ServicePrincipalProperties +### Properties +* **clientId**: string (Required): The service principal client ID +* **secret**: string (Required): The service principal secret. This is not returned in response of GET/PUT on the resource. To see this please call listKeys. + +## SslConfiguration +### Properties +* **cert**: string: The SSL cert data in PEM format. +* **cname**: string: The CName of the certificate. +* **key**: string: The SSL key data in PEM format. This is not returned in response of GET/PUT on the resource. To see this please call listKeys API. +* **status**: 'Disabled' | 'Enabled' | string: SSL status. Allowed values are Enabled and Disabled. ## StorageAccountCredentials ### Properties @@ -149,3 +139,13 @@ * **resourceId**: string (ReadOnly): The ARM resource ID of the storage account. * **secondaryKey**: string (ReadOnly): The secondary key of the storage account. +## StorageAccountProperties +### Properties +* **resourceId**: string: ARM resource ID of the Azure Storage Account to store CLI specific files. If not provided one will be created. This cannot be changed once the cluster is created. + +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): The public IP address of the system service +* **systemServiceType**: 'BatchFrontEnd' | 'None' | 'ScoringFrontEnd' | string (Required): The system service type +* **version**: string (ReadOnly): The state of the system service + diff --git a/generated/machinelearningexperimentation/log.out b/generated/machinelearningexperimentation/log.out index 8a1c4072d7..e720c0a0e7 100644 --- a/generated/machinelearningexperimentation/log.out +++ b/generated/machinelearningexperimentation/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.machinelearningexperimentation-2017-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WorkspaceUpdateParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningexperimentation/resource-manager/Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json:903:5 @@ -38,4 +38,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningexperimentation/resource-manager/Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json:1290:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 11ms -info | Autorest completed in 4.89s. 2 files generated. +info | Autorest completed in 4.92s. 2 files generated. diff --git a/generated/machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.md b/generated/machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.md index cff575c1fc..dc4338df38 100644 --- a/generated/machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.md +++ b/generated/machinelearningexperimentation/microsoft.machinelearningexperimentation/2017-05-01-preview/types.md @@ -46,43 +46,43 @@ * **storageAccount**: [StorageAccountProperties](#storageaccountproperties) (Required): The properties of a storage account for a machine learning team account. * **vsoAccountId**: string (Required): The fully qualified arm id of the vso account to be used for this team account. -## StorageAccountProperties +## ProjectProperties ### Properties -* **accessKey**: string (Required): The access key to the storage account. -* **storageAccountId**: string (Required): The fully qualified arm Id of the storage account. +* **accountId**: string (ReadOnly): The immutable id of the team account which contains this project. +* **creationDate**: string (ReadOnly): The creation date of the project in ISO8601 format. +* **description**: string: The description of this project. +* **friendlyName**: string (Required): The friendly name for this project. +* **gitrepo**: string: The reference to git repo for this project. +* **projectId**: string (ReadOnly): The immutable id of this project. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning. +* **workspaceId**: string (ReadOnly): The immutable id of the workspace which contains this project. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkspaceProperties +## ResourceTags ### Properties -* **accountId**: string (ReadOnly): The immutable id of the team account which contains this workspace. -* **creationDate**: string (ReadOnly): The creation date of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **friendlyName**: string (Required): The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning. -* **workspaceId**: string (ReadOnly): The immutable id of this workspace. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProjectProperties +## StorageAccountProperties ### Properties -* **accountId**: string (ReadOnly): The immutable id of the team account which contains this project. -* **creationDate**: string (ReadOnly): The creation date of the project in ISO8601 format. -* **description**: string: The description of this project. -* **friendlyName**: string (Required): The friendly name for this project. -* **gitrepo**: string: The reference to git repo for this project. -* **projectId**: string (ReadOnly): The immutable id of this project. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning. -* **workspaceId**: string (ReadOnly): The immutable id of the workspace which contains this project. +* **accessKey**: string (Required): The access key to the storage account. +* **storageAccountId**: string (Required): The fully qualified arm Id of the storage account. -## ResourceTags +## WorkspaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accountId**: string (ReadOnly): The immutable id of the team account which contains this workspace. +* **creationDate**: string (ReadOnly): The creation date of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **friendlyName**: string (Required): The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' (ReadOnly): The current deployment state of team account workspace resource. The provisioningState is to indicate states for resource provisioning. +* **workspaceId**: string (ReadOnly): The immutable id of this workspace. diff --git a/generated/machinelearningservices/log.out b/generated/machinelearningservices/log.out index 3558a0e266..1f39e6a667 100644 --- a/generated/machinelearningservices/log.out +++ b/generated/machinelearningservices/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.machinelearningservices-2022-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-01-01-preview/machineLearningServices.json:1957:9 @@ -97,7 +97,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 21ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2021-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json:1957:9 @@ -188,7 +188,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2021-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/machineLearningServices.json:2214:9 @@ -328,10 +328,10 @@ warning | PreCheck/SchemaMissingType | The schema 'AKSServiceCreateRequest-liven warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AmlComputeNodesInformation' has a property 'nextLink' that is already declared the parent schema 'ComputeNodesInformation' but isn't significantly different. The property has been removed from AmlComputeNodesInformation warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/machineLearningServices.json:2211:9 @@ -469,10 +469,10 @@ warning | PreCheck/SchemaMissingType | The schema 'AKSServiceCreateRequest-liven warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AmlComputeNodesInformation' has a property 'nextLink' that is already declared the parent schema 'ComputeNodesInformation' but isn't significantly different. The property has been removed from AmlComputeNodesInformation warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2021-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/machineLearningServices.json:1885:9 @@ -564,10 +564,10 @@ warning | Modeler/MissingType | The schema 'components·1dsxf3l·schemas·comman file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json#/components/schemas/components·1dsxf3l·schemas·commandjob·properties·parameters·additionalproperties warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 30ms +info | autorest.bicep took 71ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/machineLearningServices.json:1775:9 @@ -649,10 +649,10 @@ warning | PreCheck/SchemaMissingType | The schema 'SharedPrivateLinkResourceProp - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-08-01/machineLearningServices.json:3998:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AmlComputeNodesInformation' has a property 'nextLink' that is already declared the parent schema 'ComputeNodesInformation' but isn't significantly different. The property has been removed from AmlComputeNodesInformation -info | autorest.bicep took 7ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json:1757:9 @@ -729,10 +729,10 @@ warning | PreCheck/SchemaMissingType | The schema 'SharedPrivateLinkResource' wi warning | PreCheck/SchemaMissingType | The schema 'SharedPrivateLinkResourceProperty' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json:3839:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-05-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-15-preview/machineLearningServices.json:1867:9 @@ -872,7 +872,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json:1400:9 @@ -951,10 +951,10 @@ warning | PreCheck/SchemaMissingType | The schema 'SharedPrivateLinkResource' wi warning | PreCheck/SchemaMissingType | The schema 'SharedPrivateLinkResourceProperty' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json:3390:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 27ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json:1400:9 @@ -1036,7 +1036,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json:1355:9 @@ -1111,10 +1111,10 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResource' with an warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json:3185:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2019-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json:1171:9 @@ -1175,10 +1175,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkuZoneDetails' with warning | PreCheck/SchemaMissingType | The schema 'Restriction' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json:2808:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2019-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json:1098:9 @@ -1231,10 +1231,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ClusterUpdateParameters' with warning | PreCheck/SchemaMissingType | The schema 'AmlComputeNodeInformation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json:2356:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2019-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json:1004:9 @@ -1273,10 +1273,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ClusterUpdateParameters' with warning | PreCheck/SchemaMissingType | The schema 'AmlComputeNodeInformation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json:2057:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2018-11-19"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json:997:9 @@ -1315,10 +1315,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ClusterUpdateParameters' with warning | PreCheck/SchemaMissingType | The schema 'AmlComputeNodeInformation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json:2040:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json:2309:9 @@ -1456,10 +1456,10 @@ warning | PreCheck/SchemaMissingType | The schema 'AKSServiceCreateRequest-liven warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AmlComputeNodesInformation' has a property 'nextLink' that is already declared the parent schema 'ComputeNodesInformation' but isn't significantly different. The property has been removed from AmlComputeNodesInformation warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 18ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json:2296:9 @@ -1594,10 +1594,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json:1546:9 @@ -1682,7 +1682,7 @@ warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourc info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2020-02-18-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json:1493:9 @@ -1757,10 +1757,10 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResource' with an warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json:3439:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.machinelearningservices-2018-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json:847:9 @@ -1780,4 +1780,4 @@ warning | PreCheck/SchemaMissingType | The schema 'DataFactory' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json:1367:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 85.94s. 40 files generated. +info | Autorest completed in 85.32s. 40 files generated. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.md index 8cdf548889..9683dee747 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2018-03-01-preview/types.md @@ -34,30 +34,19 @@ * **ApiVersion**: 2018-03-01-preview * **Output**: [ComputeSecrets](#computesecrets) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## WorkspaceProperties +## AKSProperties ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **batchaiWorkspace**: string: ARM id of the Batch AI workspace associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The SSL configuration for scoring +* **systemServices**: [SystemService](#systemservice)[]: System services -## ResourceTags +## BatchAIProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for BatchAI Compute +* **vmPriority**: string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -95,9 +84,27 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## ErrorDetail ### Properties -* **error**: [ErrorResponse](#errorresponse): Error response information. +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. ## ErrorResponse ### Properties @@ -105,37 +112,49 @@ * **details**: [ErrorDetail](#errordetail)[]: An array of error detail objects. * **message**: string (Required): Error message. -## ErrorDetail +## HDInsightProperties ### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## AKSProperties +## Identity ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The SSL configuration for scoring -* **systemServices**: [SystemService](#systemservice)[]: System services +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## SslConfiguration +## ListWorkspaceKeysResult ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable SSL for scoring +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## SystemService +## MachineLearningServiceError ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **error**: [ErrorResponse](#errorresponse): Error response information. -## BatchAIProperties +## Password ### Properties -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for BatchAI Compute -* **vmPriority**: string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ScaleSettings ### Properties @@ -143,18 +162,18 @@ * **maxNodeCount**: int: Max number of nodes to use * **minNodeCount**: int: Min number of nodes to use -## HDInsightProperties +## SslConfiguration ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable SSL for scoring -## VirtualMachineSshCredentials +## SystemService ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. ## VirtualMachineProperties ### Properties @@ -163,43 +182,24 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult +## VirtualMachineSshCredentials ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## Password +## WorkspaceProperties ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **batchaiWorkspace**: string: ARM id of the Batch AI workspace associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.md index aff9ecae29..f6d4c8b768 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2018-11-19/types.md @@ -39,29 +39,47 @@ * **ApiVersion**: 2018-11-19 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity +## AksNetworkingConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## WorkspaceProperties +## AKSProperties ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## ResourceTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddress**: string (ReadOnly): Public IP address of the compute node. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **port**: int (ReadOnly): SSH port number of the node. + +## AmlComputeNodesInformation +### Properties +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. + +## AmlComputeProperties +### Properties +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -110,63 +128,69 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token -## ErrorResponse +## DataLakeAnalyticsProperties ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name ## ErrorDetail ### Properties * **code**: string (Required): Error code. * **message**: string (Required): Error message. -## AKSProperties +## ErrorResponse ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## AksNetworkingConfiguration +## HDInsightProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## SslConfiguration +## Identity ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## SystemService +## ListWorkspaceKeysResult ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## AmlComputeProperties +## MachineLearningServiceError ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -177,42 +201,55 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## Password ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) ## ResourceId ### Properties * **id**: string (Required): The ID of the resource -## UserAccountCredentials +## ResourceTags ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +### Additional Properties +* **Additional Properties Type**: string -## DatabricksProperties +## ResourceTags ### Properties -* **databricksAccessToken**: string: Databricks access token +### Additional Properties +* **Additional Properties Type**: string -## DataLakeAnalyticsProperties +## ScaleSettings ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## HDInsightProperties +## SslConfiguration ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -## VirtualMachineSshCredentials +## SystemService ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. ## VirtualMachineProperties ### Properties @@ -221,60 +258,23 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult -### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) - -## Password -### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. - -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - - -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **ipAddress**: string (ReadOnly): Public IP address of the compute node. -* **nodeId**: string (ReadOnly): ID of the compute node. -* **port**: int (ReadOnly): SSH port number of the node. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.md index 70a4a3c423..98712bf73a 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2019-05-01/types.md @@ -39,29 +39,47 @@ * **ApiVersion**: 2019-05-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity +## AksNetworkingConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## WorkspaceProperties +## AKSProperties ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## ResourceTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipAddress**: string (ReadOnly): Public IP address of the compute node. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **port**: int (ReadOnly): SSH port number of the node. + +## AmlComputeNodesInformation +### Properties +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. + +## AmlComputeProperties +### Properties +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -110,63 +128,69 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token -## ErrorResponse +## DataLakeAnalyticsProperties ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name ## ErrorDetail ### Properties * **code**: string (Required): Error code. * **message**: string (Required): Error message. -## AKSProperties +## ErrorResponse ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## AksNetworkingConfiguration +## HDInsightProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## SslConfiguration +## Identity ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## SystemService +## ListWorkspaceKeysResult ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## AmlComputeProperties +## MachineLearningServiceError ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -177,42 +201,55 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## Password ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) ## ResourceId ### Properties * **id**: string (Required): The ID of the resource -## UserAccountCredentials +## ResourceTags ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +### Additional Properties +* **Additional Properties Type**: string -## DatabricksProperties +## ResourceTags ### Properties -* **databricksAccessToken**: string: Databricks access token +### Additional Properties +* **Additional Properties Type**: string -## DataLakeAnalyticsProperties +## ScaleSettings ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## HDInsightProperties +## SslConfiguration ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -## VirtualMachineSshCredentials +## SystemService ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. ## VirtualMachineProperties ### Properties @@ -221,60 +258,23 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult -### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) - -## Password -### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. - -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - - -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **ipAddress**: string (ReadOnly): Public IP address of the compute node. -* **nodeId**: string (ReadOnly): ID of the compute node. -* **port**: int (ReadOnly): SSH port number of the node. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.md index 0b82b70ed9..c9f0cb522c 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2019-06-01/types.md @@ -39,29 +39,51 @@ * **ApiVersion**: 2019-06-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity +## AksNetworkingConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## WorkspaceProperties +## AKSProperties ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## ResourceTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. + +## AmlComputeNodesInformation +### Properties +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. + +## AmlComputeProperties +### Properties +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -110,64 +132,69 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token -## ErrorResponse +## DataLakeAnalyticsProperties ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name ## ErrorDetail ### Properties * **code**: string (Required): Error code. * **message**: string (Required): Error message. -## AKSProperties +## ErrorResponse ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## AksNetworkingConfiguration +## HDInsightProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## SslConfiguration +## Identity ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## SystemService +## ListWorkspaceKeysResult ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## AmlComputeProperties +## MachineLearningServiceError ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -178,42 +205,55 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## Password ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) ## ResourceId ### Properties * **id**: string (Required): The ID of the resource -## UserAccountCredentials +## ResourceTags ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +### Additional Properties +* **Additional Properties Type**: string -## DatabricksProperties +## ResourceTags ### Properties -* **databricksAccessToken**: string: Databricks access token +### Additional Properties +* **Additional Properties Type**: string -## DataLakeAnalyticsProperties +## ScaleSettings ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## HDInsightProperties +## SslConfiguration ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -## VirtualMachineSshCredentials +## SystemService ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. ## VirtualMachineProperties ### Properties @@ -222,63 +262,23 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult -### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) - -## Password -### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. - -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - - -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.md index 850d241485..9ef7f2f62d 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2019-11-01/types.md @@ -41,34 +41,51 @@ * **ApiVersion**: 2019-11-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity +## AksNetworkingConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## WorkspaceProperties +## AKSProperties ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## Sku +## AmlComputeNodeInformation ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## ResourceTags +## AmlComputeNodesInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. + +## AmlComputeProperties +### Properties +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -117,64 +134,69 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token -## ErrorResponse +## DataLakeAnalyticsProperties ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name ## ErrorDetail ### Properties * **code**: string (Required): Error code. * **message**: string (Required): Error message. -## AKSProperties +## ErrorResponse ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## AksNetworkingConfiguration +## HDInsightProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## SslConfiguration +## Identity ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## SystemService +## ListWorkspaceKeysResult ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## AmlComputeProperties +## MachineLearningServiceError ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -185,42 +207,60 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## Password ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) ## ResourceId ### Properties * **id**: string (Required): The ID of the resource -## UserAccountCredentials +## ResourceTags ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +### Additional Properties +* **Additional Properties Type**: string -## DatabricksProperties +## ResourceTags ### Properties -* **databricksAccessToken**: string: Databricks access token +### Additional Properties +* **Additional Properties Type**: string -## DataLakeAnalyticsProperties +## ScaleSettings ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## HDInsightProperties +## Sku ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## VirtualMachineSshCredentials +## SslConfiguration ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring + +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. ## VirtualMachineProperties ### Properties @@ -229,63 +269,23 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult -### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) - -## Password -### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. - -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - - -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.md index fc39651efb..a015189bd2 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-01-01/types.md @@ -54,48 +54,51 @@ * **ApiVersion**: 2020-01-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. - -## WorkspaceProperties +## AksNetworkingConfiguration ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## EncryptionProperty +## AKSProperties ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## KeyVaultProperties +## AmlComputeNodeInformation ### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## Sku +## AmlComputeNodesInformation ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## ResourceTags +## AmlComputeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -144,64 +147,80 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token -## ErrorResponse +## DataLakeAnalyticsProperties ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. ## ErrorDetail ### Properties * **code**: string (Required): Error code. * **message**: string (Required): Error message. -## AKSProperties +## ErrorResponse ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## AksNetworkingConfiguration +## HDInsightProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## SslConfiguration +## Identity ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## SystemService +## KeyVaultProperties ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## AmlComputeProperties +## ListWorkspaceKeysResult ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) + +## MachineLearningServiceError +### Properties +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -212,128 +231,109 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings -### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute - -## ResourceId -### Properties -* **id**: string (Required): The ID of the resource - -## UserAccountCredentials +## Password ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## DatabricksProperties +## PrivateEndpoint ### Properties -* **databricksAccessToken**: string: Databricks access token +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## DataLakeAnalyticsProperties +## PrivateEndpointConnectionProperties ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## HDInsightProperties +## PrivateLinkServiceConnectionState ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **actionRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## VirtualMachineSshCredentials +## RegistryListCredentialsResult ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## VirtualMachineProperties +## ResourceId ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **id**: string (Required): The ID of the resource ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState +## ResourceTags ### Properties -* **actionRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ListWorkspaceKeysResult +## ScaleSettings ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## RegistryListCredentialsResult +## Sku ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## Password +## SslConfiguration ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.md index 9ad8ce1af7..1d388ff002 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-02-18-preview/types.md @@ -54,48 +54,58 @@ * **ApiVersion**: 2020-02-18-preview * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity +## AksNetworkingConfiguration ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## WorkspaceProperties +## AKSProperties ### Properties -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## EncryptionProperty +## AmlComputeNodeInformation ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## KeyVaultProperties +## AmlComputeNodesInformation ### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## Sku +## AmlComputeProperties ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: OS Type. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## AssignedUser ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. ## Compute * **Discriminator**: computeType @@ -149,91 +159,21 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError -### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. - -## ErrorResponse -### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. - -## ErrorDetail -### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. - -## AKSProperties -### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services - -## AksNetworkingConfiguration -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to - -## SslConfiguration -### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring - -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. - -## AmlComputeProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: OS Type. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size - -## NodeStateCounts -### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. - -## ScaleSettings +## ComputeInstanceApplication ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ResourceId +## ComputeInstanceConnectivityEndpoints ### Properties -* **id**: string (Required): The ID of the resource +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## UserAccountCredentials +## ComputeInstanceCreatedBy ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. This property is only supported on Linux based clusters. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. ## ComputeInstanceProperties ### Properties @@ -249,31 +189,6 @@ * **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. * **vmSize**: string: Virtual Machine Size -## ComputeInstanceApplication -### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. - -## ComputeInstanceConnectivityEndpoints -### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. - -## ComputeInstanceCreatedBy -### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. - -## PersonalComputeInstanceSettings -### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. - -## AssignedUser -### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. - ## ComputeInstanceSshSettings ### Properties * **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. @@ -281,6 +196,28 @@ * **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. * **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + ## DatabricksProperties ### Properties * **databricksAccessToken**: string: Databricks access token @@ -289,104 +226,167 @@ ### Properties * **dataLakeStoreAccountName**: string: DataLake Store Account Name +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. + +## ErrorDetail +### Properties +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. + +## ErrorResponse +### Properties +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. + ## HDInsightProperties ### Properties * **address**: string: Public IP address of the master node of the cluster. * **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine * **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## VirtualMachineSshCredentials +## Identity ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. -## VirtualMachineProperties +## KeyVaultProperties ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## ResourceTags +## ListWorkspaceKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## PrivateEndpointConnectionProperties +## MachineLearningServiceError ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. + +## NodeStateCounts +### Properties +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. + +## Password +### Properties +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## PersonalComputeInstanceSettings +### Properties +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. ## PrivateEndpoint ### Properties * **id**: string (ReadOnly): The ARM identifier for Private Endpoint +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + ## PrivateLinkServiceConnectionState ### Properties * **actionRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) + +## ResourceId +### Properties +* **id**: string (Required): The ID of the resource + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ListWorkspaceKeysResult +## ResourceTags ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## RegistryListCredentialsResult +## ResourceTags ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## Password +## ScaleSettings ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## ComputeSecrets -* **Discriminator**: computeType +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. This property is only supported on Linux based clusters. +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.md index ad8e416ba9..9d71f4ae37 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-03-01/types.md @@ -54,109 +54,51 @@ * **ApiVersion**: 2020-03-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. - -## Sku +## AksNetworkingConfiguration ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## ResourceTags +## AKSProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## SharedPrivateLinkResource +## AmlComputeNodeInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResourceProperty +## AmlComputeNodesInformation ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## ResourceTags +## AmlComputeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -205,64 +147,81 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token -## ErrorResponse +## DataLakeAnalyticsProperties ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. ## ErrorDetail ### Properties * **code**: string (Required): Error code. * **message**: string (Required): Error message. -## AKSProperties +## ErrorResponse ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## AksNetworkingConfiguration +## HDInsightProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## SslConfiguration +## Identity ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. -## SystemService +## KeyVaultProperties ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## AmlComputeProperties +## ListWorkspaceKeysResult ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) + +## MachineLearningServiceError +### Properties +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -273,49 +232,52 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## Password ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ResourceId +## PrivateEndpoint ### Properties -* **id**: string (Required): The ID of the resource +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## UserAccountCredentials +## PrivateEndpointConnection ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. -## DatabricksProperties +## PrivateEndpointConnectionProperties ### Properties -* **databricksAccessToken**: string: Databricks access token +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## DataLakeAnalyticsProperties +## PrivateLinkServiceConnectionState ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## HDInsightProperties +## RegistryListCredentialsResult ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## VirtualMachineSshCredentials +## ResourceId ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **id**: string (Required): The ID of the resource -## VirtualMachineProperties +## ResourceTags ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -327,58 +289,96 @@ ### Additional Properties * **Additional Properties Type**: string -## ListWorkspaceKeysResult +## ResourceTags ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## RegistryListCredentialsResult +## ScaleSettings ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## Password +## SharedPrivateLinkResource ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## ComputeSecrets -* **Discriminator**: computeType +## SharedPrivateLinkResourceProperty +### Properties +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -## AmlComputeNodesInformation +## UserAssignedIdentities ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## AmlComputeNodeInformation +## UserAssignedIdentity ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. + +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size + +## VirtualMachineSshCredentials +### Properties +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.md index ea04a388aa..64b898b7a7 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-04-01/types.md @@ -54,120 +54,57 @@ * **ApiVersion**: 2020-04-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) - -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState +## AksNetworkingConfiguration ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## Sku +## AKSProperties ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## ResourceTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResource +## AmlComputeNodesInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## SharedPrivateLinkResourceProperty +## AmlComputeProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## Compute * **Discriminator**: computeType @@ -216,9 +153,45 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **databricksAccessToken**: string: Databricks access token + +## DataLakeAnalyticsProperties +### Properties +* **dataLakeStoreAccountName**: string: DataLake Store Account Name + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. + +## ErrorDetail +### Properties +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. ## ErrorResponse ### Properties @@ -226,57 +199,41 @@ * **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. * **message**: string (ReadOnly): Error message. -## ErrorDetail +## HDInsightProperties ### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## AKSProperties +## Identity ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. -## AksNetworkingConfiguration +## IdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) -## SslConfiguration +## KeyVaultProperties ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **leafDomainLabel**: string: The leaf domain label name -* **overwriteExistingDomain**: bool: Boolean value for overwriting the domain -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## SystemService +## ListWorkspaceKeysResult ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [NotebookListCredentialsResult](#notebooklistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## AmlComputeProperties +## MachineLearningServiceError ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -287,49 +244,63 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## NotebookListCredentialsResult ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## ResourceId +## NotebookPreparationError ### Properties -* **id**: string (Required): The ID of the resource +* **errorMessage**: string +* **statusCode**: int -## UserAccountCredentials +## NotebookResourceInfo ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component -## DatabricksProperties +## Password ### Properties -* **databricksAccessToken**: string: Databricks access token +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## DataLakeAnalyticsProperties +## PrivateEndpoint ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## HDInsightProperties +## PrivateEndpointConnection ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. -## VirtualMachineSshCredentials +## PrivateEndpointConnectionProperties ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## VirtualMachineProperties +## PrivateLinkServiceConnectionState ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) + +## ResourceId +### Properties +* **id**: string (Required): The ID of the resource ## ResourceTags ### Properties @@ -341,64 +312,93 @@ ### Additional Properties * **Additional Properties Type**: string -## ListWorkspaceKeysResult +## ResourceTags ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [NotebookListCredentialsResult](#notebooklistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## RegistryListCredentialsResult +## ResourceTags ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## Password +## ScaleSettings ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## NotebookListCredentialsResult +## SharedPrivateLinkResource ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## ComputeSecrets -* **Discriminator**: computeType +## SharedPrivateLinkResourceProperty +### Properties +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **leafDomainLabel**: string: The leaf domain label name +* **overwriteExistingDomain**: bool: Boolean value for overwriting the domain +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -## AmlComputeNodesInformation +## VirtualMachineProperties ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## AmlComputeNodeInformation +## VirtualMachineSshCredentials ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.md index 025d845af3..58af0fb6ff 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-01-preview/types.md @@ -175,109 +175,200 @@ * **ApiVersion**: 2020-05-01-preview * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity +## ACIServiceCreateRequestDataCollection ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## UserAssignedIdentities +## ACIServiceCreateRequestEncryptionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **keyName**: string (Required, WriteOnly): Encryption Key name +* **keyVersion**: string (Required, WriteOnly): Encryption Key Version +* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url -## UserAssignedIdentity +## ACIServiceCreateRequestVnetConfiguration ### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. +* **subnetName**: string (WriteOnly): The name of the virtual network subnet. +* **vnetName**: string (WriteOnly): The name of the virtual network. -## WorkspaceProperties +## AksNetworkingConfiguration ### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## EncryptionProperty +## AKSProperties ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## KeyVaultProperties +## AKSServiceCreateRequestAutoScaler ### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. +* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. +* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. +* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. +* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. -## PrivateEndpointConnection +## AKSServiceCreateRequestDataCollection ### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## PrivateEndpointConnectionProperties +## AKSServiceCreateRequestLivenessProbeRequirements ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. +* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. +* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. +* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. +* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. -## PrivateEndpoint +## AmlComputeNodeInformation ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## PrivateLinkServiceConnectionState +## AmlComputeNodesInformation ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## Sku +## AmlComputeProperties ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## AzureDataLakeSection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. +* **certificate**: string (ReadOnly): The content of the certificate used for authentication. +* **clientId**: string (ReadOnly): The Client ID/Application ID +* **clientSecret**: string (ReadOnly): The client secret. +* **credentialType**: 'None' | 'ServicePrincipal' | string (ReadOnly): The Azure Data Lake credential type. +* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. +* **resourceGroup**: string (ReadOnly): Resource Group. +* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. +* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. +* **storeName**: string (ReadOnly): The Azure Data Lake store name. +* **subscriptionId**: string (ReadOnly): Subscription ID. +* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. +* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. -## SharedPrivateLinkResource +## AzureMySqlSection ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. +* **certificate**: string (ReadOnly): The content of the certificate used for authentication. +* **clientId**: string (ReadOnly): The Client ID/Application ID +* **clientSecret**: string (ReadOnly): The client secret. +* **credentialType**: 'None' | 'ServicePrincipal' | 'SqlAuthentication' | string (ReadOnly): Sql Authentication type. +* **databaseName**: string (ReadOnly): The Azure SQL database name. +* **endpoint**: string (ReadOnly): The server host endpoint. +* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. +* **portNumber**: string (ReadOnly): / The Azure SQL port number. +* **resourceGroup**: string (ReadOnly): Resource Group. +* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. +* **serverName**: string (ReadOnly): The Azure SQL server name. +* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. +* **subscriptionId**: string (ReadOnly): Subscription ID. +* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. +* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. +* **userId**: string (ReadOnly): The Azure SQL user id. +* **userPassword**: string (ReadOnly): The Azure SQL user password. -## SharedPrivateLinkResourceProperty +## AzurePostgreSqlSection ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. +* **certificate**: string (ReadOnly): The content of the certificate used for authentication. +* **clientId**: string (ReadOnly): The Client ID/Application ID +* **clientSecret**: string (ReadOnly): The client secret. +* **credentialType**: 'None' | 'ServicePrincipal' | 'SqlAuthentication' | string (ReadOnly): Sql Authentication type. +* **databaseName**: string (ReadOnly): The Azure SQL database name. +* **enableSsl**: bool (ReadOnly): Indicates SSL requirement of Azure Postgresql server. +* **endpoint**: string (ReadOnly): The server host endpoint. +* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. +* **portNumber**: string (ReadOnly): / The Azure SQL port number. +* **resourceGroup**: string (ReadOnly): Resource Group. +* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. +* **serverName**: string (ReadOnly): The Azure SQL server name. +* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. +* **subscriptionId**: string (ReadOnly): Subscription ID. +* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. +* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. +* **userId**: string (ReadOnly): The Azure SQL user id. +* **userPassword**: string (ReadOnly): The Azure SQL user password. -## ResourceTags +## AzureSqlDatabaseSection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. +* **certificate**: string (ReadOnly): The content of the certificate used for authentication. +* **clientId**: string (ReadOnly): The Client ID/Application ID +* **clientSecret**: string (ReadOnly): The client secret. +* **credentialType**: 'None' | 'ServicePrincipal' | 'SqlAuthentication' | string (ReadOnly): Sql Authentication type. +* **databaseName**: string (ReadOnly): The Azure SQL database name. +* **endpoint**: string (ReadOnly): The server host endpoint. +* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. +* **portNumber**: string (ReadOnly): / The Azure SQL port number. +* **resourceGroup**: string (ReadOnly): Resource Group. +* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. +* **serverName**: string (ReadOnly): The Azure SQL server name. +* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. +* **subscriptionId**: string (ReadOnly): Subscription ID. +* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. +* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. +* **userId**: string (ReadOnly): The Azure SQL user id. +* **userPassword**: string (ReadOnly): The Azure SQL user password. + +## AzureStorageSection +### Properties +* **accountKey**: string (ReadOnly): Storage Account Key (Deprecated). +* **accountName**: string (ReadOnly): Storage Account Name. +* **areWorkspaceManagedIdentitiesAllowed**: bool (ReadOnly): Indicate if we are using Workspace ManagedIdentities/MSI token (Deprecated). +* **blobCacheTimeout**: int (ReadOnly): If this is an "DataStoreType.AzureBlob", the length of time (in seconds) to cache files locally after they are accessed (downloaded). +* **clientCredentials**: [ClientCredentials](#clientcredentials) (ReadOnly): Service principal credential when credential type is "AzureStorageCredentialTypes.ClientCredentials". +* **containerName**: string (ReadOnly): The storage container name. +* **credential**: string (ReadOnly): The credential. +* **credentialType**: 'AccountKey' | 'ClientCredentials' | 'None' | 'Sas' | string (ReadOnly): The credential type. +* **endpoint**: string (ReadOnly): The host of the container. +* **isSas**: bool (ReadOnly): Indicate if we are using SAS token or Account Key (Deprecated). +* **protocol**: string (ReadOnly): The protocol to use. Defaults to https. +* **resourceGroup**: string (ReadOnly): Resource Group. +* **sasToken**: string (ReadOnly): SAS Token for the container (Deprecated). +* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. +* **subscriptionId**: string (ReadOnly): Subscription ID. + +## ClientCredentials +### Properties +* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. +* **certificate**: string (ReadOnly): The content of the certificate used for authentication. +* **clientId**: string (ReadOnly): The Client ID/Application ID +* **clientSecret**: string (ReadOnly): The client secret. +* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. +* **resourceGroup**: string (ReadOnly): Resource Group. +* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. +* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. +* **subscriptionId**: string (ReadOnly): Subscription ID. +* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. +* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. ## Compute * **Discriminator**: computeType @@ -326,89 +417,58 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError -### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +## ComputeSecrets +* **Discriminator**: computeType -## ErrorResponse -### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -## ErrorDetail -### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. - -## AKSProperties -### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services - -## AksNetworkingConfiguration -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. -## SslConfiguration -### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. -## AmlComputeProperties +## ContainerResourceRequirements ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **cpu**: int (WriteOnly): The number of CPU cores on the container. +* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. +* **gpu**: int (WriteOnly): The number of GPU cores in the container. +* **memoryInGB**: int (WriteOnly): The amount of memory on the container in GB. -## NodeStateCounts +## CreateServiceRequestEnvironmentImageRequest ### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. +* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. +* **driverProgram**: string (WriteOnly): The name of the driver file. +* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. +* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. +* **modelIds**: string[] (WriteOnly): The list of model Ids. +* **models**: [Model](#model)[] (WriteOnly): The list of models. -## ScaleSettings +## CreateServiceRequestKeys ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute +* **primaryKey**: string (WriteOnly): The primary key. +* **secondaryKey**: string (WriteOnly): The secondary key. -## ResourceId +## CreateServiceRequestKvTags ### Properties -* **id**: string (Required): The ID of the resource +### Additional Properties +* **Additional Properties Type**: string -## UserAccountCredentials +## CreateServiceRequestProperties ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +### Additional Properties +* **Additional Properties Type**: string ## DatabricksProperties ### Properties @@ -418,30 +478,20 @@ ### Properties * **dataLakeStoreAccountName**: string: DataLake Store Account Name -## HDInsightProperties -### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. - -## VirtualMachineSshCredentials -### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account - -## VirtualMachineProperties -### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size - -## ResourceTags +## Dataset ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdTime**: string (ReadOnly): The dataset creation time (UTC). +* **datasetId**: string (ReadOnly): Unique Dataset identifier. +* **datasetState**: [DatasetState](#datasetstate) (ReadOnly): Dataset state +* **datasetType**: string (ReadOnly): Dataset Type. +* **defaultCompute**: string (ReadOnly): Name of the default compute to be used for any Dataset actions (such as Profile, Write). +* **description**: string (ReadOnly): Description about this dataset version. +* **etag**: string (ReadOnly): eTag description +* **isVisible**: bool (ReadOnly): Flag to hide Dataset in UI +* **latest**: [DatasetLatest](#datasetlatest) (ReadOnly): Last created Dataset definition. +* **modifiedTime**: string (ReadOnly): The dataset last modified time (UTC). +* **name**: string (ReadOnly): Unique dataset name +* **tags**: [DatasetTags](#datasettags) (ReadOnly): Tags for this dataset version. ## DatasetCreateRequestParameters ### Properties @@ -468,31 +518,21 @@ * **datastoreName**: string (WriteOnly): The SQL/PostgreSQL/MySQL datastore name. * **query**: string (WriteOnly): SQL Quey. -## Dataset +## DatasetCreateRequestRegistration ### Properties -* **createdTime**: string (ReadOnly): The dataset creation time (UTC). -* **datasetId**: string (ReadOnly): Unique Dataset identifier. -* **datasetState**: [DatasetState](#datasetstate) (ReadOnly): Dataset state -* **datasetType**: string (ReadOnly): Dataset Type. -* **defaultCompute**: string (ReadOnly): Name of the default compute to be used for any Dataset actions (such as Profile, Write). -* **description**: string (ReadOnly): Description about this dataset version. -* **etag**: string (ReadOnly): eTag description -* **isVisible**: bool (ReadOnly): Flag to hide Dataset in UI -* **latest**: [DatasetLatest](#datasetlatest) (ReadOnly): Last created Dataset definition. -* **modifiedTime**: string (ReadOnly): The dataset last modified time (UTC). -* **name**: string (ReadOnly): Unique dataset name -* **tags**: [DatasetTags](#datasettags) (ReadOnly): Tags for this dataset version. +* **description**: string (WriteOnly): The description for the dataset. +* **name**: string (WriteOnly): The name of the dataset. +* **tags**: [DatasetCreateRequestRegistrationTags](#datasetcreaterequestregistrationtags) (WriteOnly): Tags associated with the dataset. -## DatasetState +## DatasetCreateRequestRegistrationTags ### Properties -* **deprecatedBy**: [DatasetStateDeprecatedBy](#datasetstatedeprecatedby) (ReadOnly): Reference to better Dataset or a Definition -* **etag**: string (ReadOnly): eTag description -* **state**: string (ReadOnly): Dataset state +### Additional Properties +* **Additional Properties Type**: string -## DatasetStateDeprecatedBy +## DatasetCreateRequestTimeSeries ### Properties -* **datasetId**: string (ReadOnly): Unique Dataset identifier. -* **definitionVersion**: string (ReadOnly): Definition Version +* **coarseGrainTimestamp**: string (WriteOnly): Column name to be used as CoarseGrainTimestamp. Can only be used if 'fineGrainTimestamp' is specified and cannot be same as 'fineGrainTimestamp'. +* **fineGrainTimestamp**: string (WriteOnly): Column name to be used as FineGrainTimestamp ## DatasetLatest ### Properties @@ -515,16 +555,6 @@ * **useDescriptionTagsFromDefinition**: bool (ReadOnly): Whether to use description and tags from the definition level as opposed to dataset level (old behavior). * **versionId**: string (ReadOnly): An identifier uniquely identifies a definition change. -## UserInfo -### Properties -* **userAltSecId**: string (ReadOnly): A user alternate sec id. This represents the user in a different identity provider system Eg.1:live.com:puid -* **userIdp**: string (ReadOnly): A user identity provider. Eg live.com -* **userIss**: string (ReadOnly): The issuer which issued the token for this user. -* **userName**: string (ReadOnly): A user's full name or a service principal's app ID. -* **userObjectId**: string (ReadOnly): A user or service principal's object ID.. -* **userPuId**: string (ReadOnly): A user or service principal's PuID. -* **userTenantId**: string (ReadOnly): A user or service principal's tenant ID. - ## DatasetLatestDataPath ### Properties * **additionalProperties**: [DatasetLatestDataPathAdditionalProperties](#datasetlatestdatapathadditionalproperties) (ReadOnly): Additional Properties. @@ -564,32 +594,27 @@ ### Additional Properties * **Additional Properties Type**: string -## DatasetTags +## DatasetReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (WriteOnly): The id of the dataset reference. +* **name**: string (WriteOnly): The name of the dataset reference. -## DatasetCreateRequestRegistration +## DatasetState ### Properties -* **description**: string (WriteOnly): The description for the dataset. -* **name**: string (WriteOnly): The name of the dataset. -* **tags**: [DatasetCreateRequestRegistrationTags](#datasetcreaterequestregistrationtags) (WriteOnly): Tags associated with the dataset. +* **deprecatedBy**: [DatasetStateDeprecatedBy](#datasetstatedeprecatedby) (ReadOnly): Reference to better Dataset or a Definition +* **etag**: string (ReadOnly): eTag description +* **state**: string (ReadOnly): Dataset state -## DatasetCreateRequestRegistrationTags +## DatasetStateDeprecatedBy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **datasetId**: string (ReadOnly): Unique Dataset identifier. +* **definitionVersion**: string (ReadOnly): Definition Version -## ResourceTags +## DatasetTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DatasetCreateRequestTimeSeries -### Properties -* **coarseGrainTimestamp**: string (WriteOnly): Column name to be used as CoarseGrainTimestamp. Can only be used if 'fineGrainTimestamp' is specified and cannot be same as 'fineGrainTimestamp'. -* **fineGrainTimestamp**: string (WriteOnly): Column name to be used as FineGrainTimestamp - ## Datastore ### Properties * **azureDataLakeSection**: [AzureDataLakeSection](#azuredatalakesection) (ReadOnly): Data Specific to azure data lake. @@ -609,175 +634,125 @@ * **name**: string (ReadOnly): Name of the datastore. * **tags**: [DatastoreTags](#datastoretags) (ReadOnly): Tags for this datastore. -## AzureDataLakeSection -### Properties -* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. -* **certificate**: string (ReadOnly): The content of the certificate used for authentication. -* **clientId**: string (ReadOnly): The Client ID/Application ID -* **clientSecret**: string (ReadOnly): The client secret. -* **credentialType**: 'None' | 'ServicePrincipal' | string (ReadOnly): The Azure Data Lake credential type. -* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. -* **resourceGroup**: string (ReadOnly): Resource Group. -* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. -* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. -* **storeName**: string (ReadOnly): The Azure Data Lake store name. -* **subscriptionId**: string (ReadOnly): Subscription ID. -* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. -* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. - -## AzureMySqlSection +## DatastoreTags ### Properties -* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. -* **certificate**: string (ReadOnly): The content of the certificate used for authentication. -* **clientId**: string (ReadOnly): The Client ID/Application ID -* **clientSecret**: string (ReadOnly): The client secret. -* **credentialType**: 'None' | 'ServicePrincipal' | 'SqlAuthentication' | string (ReadOnly): Sql Authentication type. -* **databaseName**: string (ReadOnly): The Azure SQL database name. -* **endpoint**: string (ReadOnly): The server host endpoint. -* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. -* **portNumber**: string (ReadOnly): / The Azure SQL port number. -* **resourceGroup**: string (ReadOnly): Resource Group. -* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. -* **serverName**: string (ReadOnly): The Azure SQL server name. -* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. -* **subscriptionId**: string (ReadOnly): Subscription ID. -* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. -* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. -* **userId**: string (ReadOnly): The Azure SQL user id. -* **userPassword**: string (ReadOnly): The Azure SQL user password. +### Additional Properties +* **Additional Properties Type**: string -## AzurePostgreSqlSection +## EncryptionProperty ### Properties -* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. -* **certificate**: string (ReadOnly): The content of the certificate used for authentication. -* **clientId**: string (ReadOnly): The Client ID/Application ID -* **clientSecret**: string (ReadOnly): The client secret. -* **credentialType**: 'None' | 'ServicePrincipal' | 'SqlAuthentication' | string (ReadOnly): Sql Authentication type. -* **databaseName**: string (ReadOnly): The Azure SQL database name. -* **enableSsl**: bool (ReadOnly): Indicates SSL requirement of Azure Postgresql server. -* **endpoint**: string (ReadOnly): The server host endpoint. -* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. -* **portNumber**: string (ReadOnly): / The Azure SQL port number. -* **resourceGroup**: string (ReadOnly): Resource Group. -* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. -* **serverName**: string (ReadOnly): The Azure SQL server name. -* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. -* **subscriptionId**: string (ReadOnly): Subscription ID. -* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. -* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. -* **userId**: string (ReadOnly): The Azure SQL user id. -* **userPassword**: string (ReadOnly): The Azure SQL user password. +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -## AzureSqlDatabaseSection +## EnvironmentImageRequestEnvironment ### Properties -* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. -* **certificate**: string (ReadOnly): The content of the certificate used for authentication. -* **clientId**: string (ReadOnly): The Client ID/Application ID -* **clientSecret**: string (ReadOnly): The client secret. -* **credentialType**: 'None' | 'ServicePrincipal' | 'SqlAuthentication' | string (ReadOnly): Sql Authentication type. -* **databaseName**: string (ReadOnly): The Azure SQL database name. -* **endpoint**: string (ReadOnly): The server host endpoint. -* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. -* **portNumber**: string (ReadOnly): / The Azure SQL port number. -* **resourceGroup**: string (ReadOnly): Resource Group. -* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. -* **serverName**: string (ReadOnly): The Azure SQL server name. -* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. -* **subscriptionId**: string (ReadOnly): Subscription ID. -* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. -* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. -* **userId**: string (ReadOnly): The Azure SQL user id. -* **userPassword**: string (ReadOnly): The Azure SQL user password. +* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. +* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. +* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". +* **name**: string (WriteOnly): The name of the environment. +* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. +* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. +* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. +* **version**: string (WriteOnly): The environment version. -## AzureStorageSection +## EnvironmentImageRequestEnvironmentReference ### Properties -* **accountKey**: string (ReadOnly): Storage Account Key (Deprecated). -* **accountName**: string (ReadOnly): Storage Account Name. -* **areWorkspaceManagedIdentitiesAllowed**: bool (ReadOnly): Indicate if we are using Workspace ManagedIdentities/MSI token (Deprecated). -* **blobCacheTimeout**: int (ReadOnly): If this is an "DataStoreType.AzureBlob", the length of time (in seconds) to cache files locally after they are accessed (downloaded). -* **clientCredentials**: [ClientCredentials](#clientcredentials) (ReadOnly): Service principal credential when credential type is "AzureStorageCredentialTypes.ClientCredentials". -* **containerName**: string (ReadOnly): The storage container name. -* **credential**: string (ReadOnly): The credential. -* **credentialType**: 'AccountKey' | 'ClientCredentials' | 'None' | 'Sas' | string (ReadOnly): The credential type. -* **endpoint**: string (ReadOnly): The host of the container. -* **isSas**: bool (ReadOnly): Indicate if we are using SAS token or Account Key (Deprecated). -* **protocol**: string (ReadOnly): The protocol to use. Defaults to https. -* **resourceGroup**: string (ReadOnly): Resource Group. -* **sasToken**: string (ReadOnly): SAS Token for the container (Deprecated). -* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. -* **subscriptionId**: string (ReadOnly): Subscription ID. +* **name**: string (WriteOnly): Name of the environment. +* **version**: string (WriteOnly): Version of the environment. -## ClientCredentials +## ErrorDetail ### Properties -* **authorityUrl**: string (ReadOnly): The authority URL used for authentication. -* **certificate**: string (ReadOnly): The content of the certificate used for authentication. -* **clientId**: string (ReadOnly): The Client ID/Application ID -* **clientSecret**: string (ReadOnly): The client secret. -* **isCertAuth**: bool (ReadOnly): Is it using certificate to authenticate. If false then use client secret. -* **resourceGroup**: string (ReadOnly): Resource Group. -* **resourceUri**: string (ReadOnly): The resource the service principal/app has access to. -* **serviceDataAccessAuthIdentity**: 'None' | 'WorkspaceSystemAssignedIdentity' | string (ReadOnly): Indicates which identity to use to authenticate service data access to customer's storage. -* **subscriptionId**: string (ReadOnly): Subscription ID. -* **tenantId**: string (ReadOnly): The ID of the tenant the service principal/app belongs to. -* **thumbprint**: string (ReadOnly): The thumbprint of the certificate above. +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. + +## ErrorResponse +### Properties +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. ## GlusterFsSection ### Properties * **serverAddress**: string (ReadOnly): The server address of one of the servers that hosts the GlusterFS. Can be either the IP address or server name. * **volumeName**: string (ReadOnly): The name of the created GlusterFS volume. -## LinkedInfo +## HDInsightProperties ### Properties -* **linkedId**: string (ReadOnly): LinkedId id. -* **linkedResourceName**: string (ReadOnly): Linked resource name. -* **origin**: 'Synapse' | string (ReadOnly): Datastore origin +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## DatastoreTags +## Identity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. -## ResourceTags +## ImageAsset ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (WriteOnly): The Asset Id. +* **mimeType**: string (WriteOnly): The mime type. +* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. +* **url**: string (WriteOnly): The Url of the Asset. + +## KeyVaultProperties +### Properties +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. + +## LinkedInfo +### Properties +* **linkedId**: string (ReadOnly): LinkedId id. +* **linkedResourceName**: string (ReadOnly): Linked resource name. +* **origin**: 'Synapse' | string (ReadOnly): Datastore origin ## LinkedWorkspaceProps ### Properties * **linkedWorkspaceResourceId**: string: ResourceId of the link target of the linked workspace. * **userAssignedIdentityResourceId**: string: ResourceId of the user assigned identity for the linked workspace. -## ResourceTags +## ListWorkspaceKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## CreateServiceRequestEnvironmentImageRequest +## MachineLearningServiceError ### Properties -* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. -* **driverProgram**: string (WriteOnly): The name of the driver file. -* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. -* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. -* **modelIds**: string[] (WriteOnly): The list of model Ids. -* **models**: [Model](#model)[] (WriteOnly): The list of models. +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. -## ImageAsset +## Model ### Properties -* **id**: string (WriteOnly): The Asset Id. -* **mimeType**: string (WriteOnly): The mime type. -* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. -* **url**: string (WriteOnly): The Url of the Asset. +* **createdTime**: string (WriteOnly): The Model creation time (UTC). +* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. +* **derivedModelIds**: string[] (WriteOnly): Models derived from this model +* **description**: string (WriteOnly): The Model description text. +* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. +* **framework**: string (WriteOnly): The Model framework. +* **frameworkVersion**: string (WriteOnly): The Model framework version. +* **id**: string (WriteOnly): The Model Id. +* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. +* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml +* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). +* **name**: string (Required, WriteOnly): The Model name. +* **parentModelId**: string (WriteOnly): The Parent Model Id. +* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. +* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). +* **runId**: string (WriteOnly): The RunId that created this model. +* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. +* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. +* **version**: int (WriteOnly): The Model version assigned by Model Management Service. -## EnvironmentImageRequestEnvironment +## ModelDockerSectionBaseImageRegistry ### Properties -* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. -* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. -* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". -* **name**: string (WriteOnly): The name of the environment. -* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. -* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. -* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. -* **version**: string (WriteOnly): The environment version. +* **address**: string (WriteOnly) +* **password**: string (WriteOnly) +* **username**: string (WriteOnly) ## ModelEnvironmentDefinitionDocker ### Properties @@ -785,12 +760,6 @@ * **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. * **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. -## ModelDockerSectionBaseImageRegistry -### Properties -* **address**: string (WriteOnly) -* **password**: string (WriteOnly) -* **username**: string (WriteOnly) - ## ModelEnvironmentDefinitionEnvironmentVariables ### Properties ### Additional Properties @@ -815,90 +784,104 @@ The path specified gets used to call the user script. * **snapshotDate**: string (WriteOnly): Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. "2019-04-17" * **userManaged**: bool (WriteOnly): Indicates whether the environment is managed by user or by AzureML. -## RCranPackage -### Properties -* **name**: string (WriteOnly): The package name. -* **repository**: string (WriteOnly): The repository name. - -## RGitHubPackage -### Properties -* **authToken**: string (WriteOnly): Personal access token to install from a private repo -* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. - ## ModelEnvironmentDefinitionSpark ### Properties * **packages**: [SparkMavenPackage](#sparkmavenpackage)[] (WriteOnly): The Spark packages to use. * **precachePackages**: bool (WriteOnly): Whether to precache the packages. * **repositories**: string[] (WriteOnly): The list of spark repositories. -## SparkMavenPackage +## ModelKvTags ### Properties -* **artifact**: string (WriteOnly) -* **group**: string (WriteOnly) -* **version**: string (WriteOnly) +### Additional Properties +* **Additional Properties Type**: string -## EnvironmentImageRequestEnvironmentReference +## ModelProperties ### Properties -* **name**: string (WriteOnly): Name of the environment. -* **version**: string (WriteOnly): Version of the environment. +### Additional Properties +* **Additional Properties Type**: string -## Model +## NodeStateCounts ### Properties -* **createdTime**: string (WriteOnly): The Model creation time (UTC). -* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. -* **derivedModelIds**: string[] (WriteOnly): Models derived from this model -* **description**: string (WriteOnly): The Model description text. -* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. -* **framework**: string (WriteOnly): The Model framework. -* **frameworkVersion**: string (WriteOnly): The Model framework version. -* **id**: string (WriteOnly): The Model Id. -* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. -* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml -* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). -* **name**: string (Required, WriteOnly): The Model name. -* **parentModelId**: string (WriteOnly): The Parent Model Id. -* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. -* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). -* **runId**: string (WriteOnly): The RunId that created this model. -* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. -* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. -* **version**: int (WriteOnly): The Model version assigned by Model Management Service. +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## DatasetReference +## Password ### Properties -* **id**: string (WriteOnly): The id of the dataset reference. -* **name**: string (WriteOnly): The name of the dataset reference. +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ModelKvTags +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## RCranPackage +### Properties +* **name**: string (WriteOnly): The package name. +* **repository**: string (WriteOnly): The repository name. + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) + +## ResourceId +### Properties +* **id**: string (Required): The ID of the resource + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ModelProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ContainerResourceRequirements +## ResourceTags ### Properties -* **cpu**: int (WriteOnly): The number of CPU cores on the container. -* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. -* **gpu**: int (WriteOnly): The number of GPU cores in the container. -* **memoryInGB**: int (WriteOnly): The amount of memory on the container in GB. +### Additional Properties +* **Additional Properties Type**: string -## CreateServiceRequestKeys +## ResourceTags ### Properties -* **primaryKey**: string (WriteOnly): The primary key. -* **secondaryKey**: string (WriteOnly): The secondary key. +### Additional Properties +* **Additional Properties Type**: string -## CreateServiceRequestKvTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CreateServiceRequestProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -908,95 +891,112 @@ The path specified gets used to call the user script. ### Additional Properties * **Additional Properties Type**: string -## ACIServiceCreateRequestDataCollection +## RGitHubPackage ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **authToken**: string (WriteOnly): Personal access token to install from a private repo +* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. -## ACIServiceCreateRequestEncryptionProperties +## ScaleSettings ### Properties -* **keyName**: string (Required, WriteOnly): Encryption Key name -* **keyVersion**: string (Required, WriteOnly): Encryption Key Version -* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## ACIServiceCreateRequestVnetConfiguration +## SharedPrivateLinkResource ### Properties -* **subnetName**: string (WriteOnly): The name of the virtual network subnet. -* **vnetName**: string (WriteOnly): The name of the virtual network. +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## AKSServiceCreateRequestAutoScaler +## SharedPrivateLinkResourceProperty ### Properties -* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. -* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. -* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. -* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. -* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## AKSServiceCreateRequestDataCollection +## Sku ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## AKSServiceCreateRequestLivenessProbeRequirements +## SparkMavenPackage ### Properties -* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. -* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. -* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. -* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. -* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. +* **artifact**: string (WriteOnly) +* **group**: string (WriteOnly) +* **version**: string (WriteOnly) -## ListWorkspaceKeysResult +## SslConfiguration ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -## RegistryListCredentialsResult +## SystemService ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -## Password +## UserAccountCredentials ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## UserInfo +### Properties +* **userAltSecId**: string (ReadOnly): A user alternate sec id. This represents the user in a different identity provider system Eg.1:live.com:puid +* **userIdp**: string (ReadOnly): A user identity provider. Eg live.com +* **userIss**: string (ReadOnly): The issuer which issued the token for this user. +* **userName**: string (ReadOnly): A user's full name or a service principal's app ID. +* **userObjectId**: string (ReadOnly): A user or service principal's object ID.. +* **userPuId**: string (ReadOnly): A user or service principal's PuID. +* **userTenantId**: string (ReadOnly): A user or service principal's tenant ID. +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## AmlComputeNodesInformation +## VirtualMachineSshCredentials ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.md index 26be8de0e0..ccd1d7c850 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-05-15-preview/types.md @@ -114,109 +114,92 @@ * **ApiVersion**: 2020-05-15-preview * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty +## ACIServiceCreateRequestDataCollection ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## KeyVaultProperties +## ACIServiceCreateRequestEncryptionProperties ### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +* **keyName**: string (Required, WriteOnly): Encryption Key name +* **keyVersion**: string (Required, WriteOnly): Encryption Key Version +* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url -## PrivateEndpointConnection +## ACIServiceCreateRequestVnetConfiguration ### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. +* **subnetName**: string (WriteOnly): The name of the virtual network subnet. +* **vnetName**: string (WriteOnly): The name of the virtual network. -## PrivateEndpointConnectionProperties +## AksNetworkingConfiguration ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## PrivateEndpoint +## AKSProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## PrivateLinkServiceConnectionState +## AKSServiceCreateRequestAutoScaler ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. +* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. +* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. +* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. +* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. -## Sku +## AKSServiceCreateRequestDataCollection ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## ResourceTags +## AKSServiceCreateRequestLivenessProbeRequirements ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. +* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. +* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. +* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. +* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. -## SharedPrivateLinkResource +## AmlComputeNodeInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResourceProperty +## AmlComputeNodesInformation ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## ResourceTags +## AmlComputeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size ## Compute * **Discriminator**: computeType @@ -265,105 +248,103 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError -### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +## ComputeSecrets +* **Discriminator**: computeType -## ErrorResponse -### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -## ErrorDetail -### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. -## AKSProperties -### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute -## AksNetworkingConfiguration + +## ContainerResourceRequirements ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **cpu**: int (WriteOnly): The number of CPU cores on the container. +* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. +* **gpu**: int (WriteOnly): The number of GPU cores in the container. +* **memoryInGB**: int (WriteOnly): The amount of memory on the container in GB. -## SslConfiguration +## CreateServiceRequestEnvironmentImageRequest ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. +* **driverProgram**: string (WriteOnly): The name of the driver file. +* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. +* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. +* **modelIds**: string[] (WriteOnly): The list of model Ids. +* **models**: [Model](#model)[] (WriteOnly): The list of models. -## SystemService +## CreateServiceRequestKeys ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **primaryKey**: string (WriteOnly): The primary key. +* **secondaryKey**: string (WriteOnly): The secondary key. -## AmlComputeProperties +## CreateServiceRequestKvTags ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +### Additional Properties +* **Additional Properties Type**: string -## NodeStateCounts +## CreateServiceRequestProperties ### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. +### Additional Properties +* **Additional Properties Type**: string -## ScaleSettings +## DatabricksProperties ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +* **databricksAccessToken**: string: Databricks access token -## ResourceId +## DataLakeAnalyticsProperties ### Properties -* **id**: string (Required): The ID of the resource +* **dataLakeStoreAccountName**: string: DataLake Store Account Name -## UserAccountCredentials +## DatasetReference ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **id**: string (WriteOnly): The id of the dataset reference. +* **name**: string (WriteOnly): The name of the dataset reference. -## VirtualMachineImage +## EncryptionProperty ### Properties -* **id**: string (Required): Virtual Machine image path +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -## DatabricksProperties +## EnvironmentImageRequestEnvironment ### Properties -* **databricksAccessToken**: string: Databricks access token +* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. +* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. +* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". +* **name**: string (WriteOnly): The name of the environment. +* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. +* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. +* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. +* **version**: string (WriteOnly): The environment version. -## DataLakeAnalyticsProperties +## EnvironmentImageRequestEnvironmentReference ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **name**: string (WriteOnly): Name of the environment. +* **version**: string (WriteOnly): Version of the environment. + +## ErrorDetail +### Properties +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. + +## ErrorResponse +### Properties +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. ## HDInsightProperties ### Properties @@ -371,61 +352,71 @@ * **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine * **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## VirtualMachineSshCredentials +## Identity ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. -## VirtualMachineProperties +## ImageAsset ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **id**: string (WriteOnly): The Asset Id. +* **mimeType**: string (WriteOnly): The mime type. +* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. +* **url**: string (WriteOnly): The Url of the Asset. -## ResourceTags +## KeyVaultProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. ## LinkedWorkspaceProps ### Properties * **linkedWorkspaceResourceId**: string: ResourceId of the link target of the linked workspace. * **userAssignedIdentityResourceId**: string: ResourceId of the user assigned identity for the linked workspace. -## ResourceTags +## ListWorkspaceKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## CreateServiceRequestEnvironmentImageRequest +## MachineLearningServiceError ### Properties -* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. -* **driverProgram**: string (WriteOnly): The name of the driver file. -* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. -* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. -* **modelIds**: string[] (WriteOnly): The list of model Ids. -* **models**: [Model](#model)[] (WriteOnly): The list of models. +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. -## ImageAsset +## Model ### Properties -* **id**: string (WriteOnly): The Asset Id. -* **mimeType**: string (WriteOnly): The mime type. -* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. -* **url**: string (WriteOnly): The Url of the Asset. +* **createdTime**: string (WriteOnly): The Model creation time (UTC). +* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. +* **derivedModelIds**: string[] (WriteOnly): Models derived from this model +* **description**: string (WriteOnly): The Model description text. +* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. +* **framework**: string (WriteOnly): The Model framework. +* **frameworkVersion**: string (WriteOnly): The Model framework version. +* **id**: string (WriteOnly): The Model Id. +* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. +* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml +* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). +* **name**: string (Required, WriteOnly): The Model name. +* **parentModelId**: string (WriteOnly): The Parent Model Id. +* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. +* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). +* **runId**: string (WriteOnly): The RunId that created this model. +* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. +* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. +* **version**: int (WriteOnly): The Model version assigned by Model Management Service. -## EnvironmentImageRequestEnvironment +## ModelDockerSectionBaseImageRegistry ### Properties -* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. -* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. -* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". -* **name**: string (WriteOnly): The name of the environment. -* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. -* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. -* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. -* **version**: string (WriteOnly): The environment version. +* **address**: string (WriteOnly) +* **password**: string (WriteOnly) +* **username**: string (WriteOnly) ## ModelEnvironmentDefinitionDocker ### Properties @@ -433,12 +424,6 @@ * **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. * **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. -## ModelDockerSectionBaseImageRegistry -### Properties -* **address**: string (WriteOnly) -* **password**: string (WriteOnly) -* **username**: string (WriteOnly) - ## ModelEnvironmentDefinitionEnvironmentVariables ### Properties ### Additional Properties @@ -463,90 +448,84 @@ The path specified gets used to call the user script. * **snapshotDate**: string (WriteOnly): Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. "2019-04-17" * **userManaged**: bool (WriteOnly): Indicates whether the environment is managed by user or by AzureML. -## RCranPackage -### Properties -* **name**: string (WriteOnly): The package name. -* **repository**: string (WriteOnly): The repository name. - -## RGitHubPackage -### Properties -* **authToken**: string (WriteOnly): Personal access token to install from a private repo -* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. - ## ModelEnvironmentDefinitionSpark ### Properties * **packages**: [SparkMavenPackage](#sparkmavenpackage)[] (WriteOnly): The Spark packages to use. * **precachePackages**: bool (WriteOnly): Whether to precache the packages. * **repositories**: string[] (WriteOnly): The list of spark repositories. -## SparkMavenPackage +## ModelKvTags ### Properties -* **artifact**: string (WriteOnly) -* **group**: string (WriteOnly) -* **version**: string (WriteOnly) +### Additional Properties +* **Additional Properties Type**: string -## EnvironmentImageRequestEnvironmentReference +## ModelProperties ### Properties -* **name**: string (WriteOnly): Name of the environment. -* **version**: string (WriteOnly): Version of the environment. +### Additional Properties +* **Additional Properties Type**: string -## Model +## NodeStateCounts ### Properties -* **createdTime**: string (WriteOnly): The Model creation time (UTC). -* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. -* **derivedModelIds**: string[] (WriteOnly): Models derived from this model -* **description**: string (WriteOnly): The Model description text. -* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. -* **framework**: string (WriteOnly): The Model framework. -* **frameworkVersion**: string (WriteOnly): The Model framework version. -* **id**: string (WriteOnly): The Model Id. -* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. -* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml -* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). -* **name**: string (Required, WriteOnly): The Model name. -* **parentModelId**: string (WriteOnly): The Parent Model Id. -* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. -* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). -* **runId**: string (WriteOnly): The RunId that created this model. -* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. -* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. -* **version**: int (WriteOnly): The Model version assigned by Model Management Service. +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## DatasetReference +## Password ### Properties -* **id**: string (WriteOnly): The id of the dataset reference. -* **name**: string (WriteOnly): The name of the dataset reference. +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ModelKvTags +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ModelProperties +## PrivateEndpointConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. -## ContainerResourceRequirements +## PrivateEndpointConnectionProperties ### Properties -* **cpu**: int (WriteOnly): The number of CPU cores on the container. -* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. -* **gpu**: int (WriteOnly): The number of GPU cores in the container. -* **memoryInGB**: int (WriteOnly): The amount of memory on the container in GB. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## CreateServiceRequestKeys +## PrivateLinkServiceConnectionState ### Properties -* **primaryKey**: string (WriteOnly): The primary key. -* **secondaryKey**: string (WriteOnly): The secondary key. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## CreateServiceRequestKvTags +## RCranPackage +### Properties +* **name**: string (WriteOnly): The package name. +* **repository**: string (WriteOnly): The repository name. + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) + +## ResourceId +### Properties +* **id**: string (Required): The ID of the resource + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CreateServiceRequestProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -556,95 +535,116 @@ The path specified gets used to call the user script. ### Additional Properties * **Additional Properties Type**: string -## ACIServiceCreateRequestDataCollection +## ResourceTags ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +### Additional Properties +* **Additional Properties Type**: string -## ACIServiceCreateRequestEncryptionProperties +## ResourceTags ### Properties -* **keyName**: string (Required, WriteOnly): Encryption Key name -* **keyVersion**: string (Required, WriteOnly): Encryption Key Version -* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url +### Additional Properties +* **Additional Properties Type**: string -## ACIServiceCreateRequestVnetConfiguration +## RGitHubPackage ### Properties -* **subnetName**: string (WriteOnly): The name of the virtual network subnet. -* **vnetName**: string (WriteOnly): The name of the virtual network. +* **authToken**: string (WriteOnly): Personal access token to install from a private repo +* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. -## AKSServiceCreateRequestAutoScaler +## ScaleSettings ### Properties -* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. -* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. -* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. -* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. -* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. -## AKSServiceCreateRequestDataCollection +## SharedPrivateLinkResource ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## AKSServiceCreateRequestLivenessProbeRequirements +## SharedPrivateLinkResourceProperty ### Properties -* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. -* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. -* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. -* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. -* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## ListWorkspaceKeysResult +## Sku ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## RegistryListCredentialsResult +## SparkMavenPackage ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **artifact**: string (WriteOnly) +* **group**: string (WriteOnly) +* **version**: string (WriteOnly) -## Password +## SslConfiguration ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -## ComputeSecrets -* **Discriminator**: computeType +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. +## VirtualMachineImage +### Properties +* **id**: string (Required): Virtual Machine image path -## AmlComputeNodesInformation +## VirtualMachineProperties ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## AmlComputeNodeInformation +## VirtualMachineSshCredentials ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.md index 4ec86bac2c..57c59904e4 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-06-01/types.md @@ -59,111 +59,56 @@ * **ApiVersion**: 2020-06-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) - -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): ResourceId of the private endpoint connection. -* **name**: string (ReadOnly): Friendly name of the private endpoint connection. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): Resource type of private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint +## AksNetworkingConfiguration ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## PrivateLinkServiceConnectionState +## AKSProperties ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **agentCount**: int: Number of agents +* **agentVMSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## SharedPrivateLinkResource +## AmlComputeNodeInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResourceProperty +## AmlComputeNodesInformation ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## Sku +## AmlComputeProperties ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## Compute * **Discriminator**: computeType @@ -217,9 +162,80 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeInstanceApplication ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. + +## ComputeInstanceConnectivityEndpoints +### Properties +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. + +## ComputeInstanceCreatedBy +### Properties +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. + +## ComputeInstanceProperties +### Properties +* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. +* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. +* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for a ComputeInstance. +* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. +* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. +* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'RestartFailed' | 'Restarting' | 'Running' | 'SettingUp' | 'StartFailed' | 'Starting' | 'StopFailed' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | string (ReadOnly): Current state of a ComputeInstance. +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmSize**: string: Virtual Machine Size + +## ComputeInstanceSshSettings +### Properties +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. + +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## DatabricksProperties +### Properties +* **databricksAccessToken**: string: Databricks access token + +## DataLakeAnalyticsProperties +### Properties +* **dataLakeStoreAccountName**: string: DataLake Store Account Name + +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. + +## ErrorDetail +### Properties +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. ## ErrorResponse ### Properties @@ -227,54 +243,41 @@ * **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. * **message**: string (ReadOnly): Error message. -## ErrorDetail +## HDInsightProperties ### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## AKSProperties +## Identity ### Properties -* **agentCount**: int: Number of agents -* **agentVMSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. -## AksNetworkingConfiguration +## IdentityUserAssignedIdentities ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +### Additional Properties +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) -## SslConfiguration +## KeyVaultProperties ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## SystemService +## ListWorkspaceKeysResult ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [NotebookListCredentialsResult](#notebooklistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## AmlComputeProperties +## MachineLearningServiceError ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. ## NodeStateCounts ### Properties @@ -285,155 +288,152 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings -### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute - -## ResourceId -### Properties -* **id**: string (Required): The ID of the resource - -## UserAccountCredentials +## NotebookListCredentialsResult ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## ComputeInstanceProperties +## NotebookPreparationError ### Properties -* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. -* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. -* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for a ComputeInstance. -* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. -* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. -* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'RestartFailed' | 'Restarting' | 'Running' | 'SettingUp' | 'StartFailed' | 'Starting' | 'StopFailed' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | string (ReadOnly): Current state of a ComputeInstance. -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmSize**: string: Virtual Machine Size +* **errorMessage**: string +* **statusCode**: int -## ComputeInstanceApplication +## NotebookResourceInfo ### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component -## ComputeInstanceConnectivityEndpoints +## Password ### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ComputeInstanceCreatedBy +## PrivateEndpoint ### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ComputeInstanceSshSettings +## PrivateEndpointConnection ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +* **id**: string (ReadOnly): ResourceId of the private endpoint connection. +* **name**: string (ReadOnly): Friendly name of the private endpoint connection. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): Resource type of private endpoint connection. -## DatabricksProperties +## PrivateEndpointConnectionProperties ### Properties -* **databricksAccessToken**: string: Databricks access token +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## DataLakeAnalyticsProperties +## PrivateLinkServiceConnectionState ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## HDInsightProperties +## RegistryListCredentialsResult ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## VirtualMachineSshCredentials +## ResourceId ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **id**: string (Required): The ID of the resource -## VirtualMachineProperties +## ResourceTags ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## WorkspaceConnectionProps +## ScaleSettings ### Properties -* **authType**: string: Authorization type of the workspace connection. -* **category**: string: Category of the workspace connection. -* **target**: string: Target of the workspace connection. -* **value**: string: Value details of the workspace connection. +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute -## ListWorkspaceKeysResult +## SharedPrivateLinkResource ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [NotebookListCredentialsResult](#notebooklistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## RegistryListCredentialsResult +## SharedPrivateLinkResourceProperty ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## Password +## Sku ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## NotebookListCredentialsResult +## SslConfiguration ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size +## VirtualMachineSshCredentials +### Properties +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## AmlComputeNodesInformation +## WorkspaceConnectionProps ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **authType**: string: Authorization type of the workspace connection. +* **category**: string: Category of the workspace connection. +* **target**: string: Target of the workspace connection. +* **value**: string: Value details of the workspace connection. -## AmlComputeNodeInformation +## WorkspaceProperties ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.md index a3d274eba9..2161b66eff 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-08-01/types.md @@ -59,111 +59,62 @@ * **ApiVersion**: 2020-08-01 * **Output**: [AmlComputeNodesInformation](#amlcomputenodesinformation) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) - -## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): ResourceId of the private endpoint connection. -* **name**: string (ReadOnly): Friendly name of the private endpoint connection. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): Resource type of private endpoint connection. - -## PrivateEndpointConnectionProperties +## AksNetworkingConfiguration ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## PrivateEndpoint +## AKSProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## PrivateLinkServiceConnectionState +## AmlComputeNodeInformation ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResource +## AmlComputeNodesInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## SharedPrivateLinkResourceProperty +## AmlComputeProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## Sku +## AssignedUser ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. -## ResourceTags +## ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. ## Compute * **Discriminator**: computeType @@ -217,106 +168,6 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError -### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. - -## ErrorResponse -### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. - -## ErrorDetail -### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. - -## AKSProperties -### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services - -## AksNetworkingConfiguration -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to - -## SslConfiguration -### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring - -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. - -## AmlComputeProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size - -## NodeStateCounts -### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. - -## ScaleSettings -### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. - -## ResourceId -### Properties -* **id**: string (Required): The ID of the resource - -## UserAccountCredentials -### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. - -## ComputeInstanceProperties -### Properties -* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. -* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. -* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). -* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for a ComputeInstance. -* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. -* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. -* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. -* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. -* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of a ComputeInstance. -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmSize**: string: Virtual Machine Size - ## ComputeInstanceApplication ### Properties * **displayName**: string: Name of the ComputeInstance application. @@ -339,14 +190,20 @@ * **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. * **operationTime**: string: Time of the last operation. -## PersonalComputeInstanceSettings -### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. - -## AssignedUser +## ComputeInstanceProperties ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. +* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. +* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). +* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for a ComputeInstance. +* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. +* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. +* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. +* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. +* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of a ComputeInstance. +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmSize**: string: Virtual Machine Size ## ComputeInstanceSshSettings ### Properties @@ -355,6 +212,28 @@ * **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. * **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + ## DatabricksProperties ### Properties * **databricksAccessToken**: string: Databricks access token @@ -363,37 +242,45 @@ ### Properties * **dataLakeStoreAccountName**: string: DataLake Store Account Name +## EncryptionProperty +### Properties +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. + +## ErrorDetail +### Properties +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. + +## ErrorResponse +### Properties +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. + ## HDInsightProperties ### Properties * **address**: string: Public IP address of the master node of the cluster. * **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine * **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## VirtualMachineSshCredentials -### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account - -## VirtualMachineProperties +## Identity ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): 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}'. -## ResourceTags +## IdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties](#componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties) -## WorkspaceConnectionProps +## KeyVaultProperties ### Properties -* **authType**: string: Authorization type of the workspace connection. -* **category**: string: Category of the workspace connection. -* **target**: string: Target of the workspace connection. -* **value**: string: Value details of the workspace connection. +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. ## ListWorkspaceKeysResult ### Properties @@ -403,56 +290,169 @@ * **userStorageKey**: string (ReadOnly) * **userStorageResourceId**: string (ReadOnly) +## MachineLearningServiceError +### Properties +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. + +## NodeStateCounts +### Properties +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. + +## NotebookListCredentialsResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## NotebookPreparationError +### Properties +* **errorMessage**: string +* **statusCode**: int + +## NotebookResourceInfo +### Properties +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component + +## Password +### Properties +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## PersonalComputeInstanceSettings +### Properties +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): ResourceId of the private endpoint connection. +* **name**: string (ReadOnly): Friendly name of the private endpoint connection. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): Resource type of private endpoint connection. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + ## RegistryListCredentialsResult ### Properties * **location**: string (ReadOnly) * **passwords**: [Password](#password)[] (ReadOnly): Array of Password * **username**: string (ReadOnly) -## Password +## ResourceId ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **id**: string (Required): The ID of the resource -## NotebookListCredentialsResult +## ResourceTags ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## ComputeSecrets -* **Discriminator**: computeType +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## ScaleSettings +### Properties +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SharedPrivateLinkResource +### Properties +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## SharedPrivateLinkResourceProperty +### Properties +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## AmlComputeNodesInformation +## SslConfiguration ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -## AmlComputeNodeInformation +## SystemService ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. + +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size + +## VirtualMachineSshCredentials +### Properties +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account + +## WorkspaceConnectionProps +### Properties +* **authType**: string: Authorization type of the workspace connection. +* **category**: string: Category of the workspace connection. +* **target**: string: Target of the workspace connection. +* **value**: string: Value details of the workspace connection. + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.md index 6529e68460..4ccbdec46c 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2020-09-01-preview/types.md @@ -140,109 +140,97 @@ * **ApiVersion**: 2020-09-01-preview * **Output**: [ListNotebookKeysResult](#listnotebookkeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties +## ACIServiceCreateRequestDataCollection ### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## EncryptionProperty +## ACIServiceCreateRequestEncryptionProperties ### Properties -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **keyName**: string (Required, WriteOnly): Encryption Key name +* **keyVersion**: string (Required, WriteOnly): Encryption Key Version +* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url -## KeyVaultProperties +## ACIServiceCreateRequestVnetConfiguration ### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +* **subnetName**: string (WriteOnly): The name of the virtual network subnet. +* **vnetName**: string (WriteOnly): The name of the virtual network. -## PrivateEndpointConnection +## AksNetworkingConfiguration ### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## PrivateEndpointConnectionProperties +## AKSProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## PrivateEndpoint +## AKSServiceCreateRequestAutoScaler ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. +* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. +* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. +* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. +* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. -## PrivateLinkServiceConnectionState +## AKSServiceCreateRequestDataCollection ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## Sku +## AKSServiceCreateRequestLivenessProbeRequirements ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. +* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. +* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. +* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. +* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. -## ResourceTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResource +## AmlComputeNodesInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## SharedPrivateLinkResourceProperty +## AmlComputeProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## AssignedUser ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. ## Compute * **Discriminator**: computeType @@ -296,97 +284,32 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError -### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. - -## ErrorResponse -### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. - -## ErrorDetail -### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. - -## AKSProperties -### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services - -## AksNetworkingConfiguration -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to - -## SslConfiguration -### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring - -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. - -## AmlComputeProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size - -## NodeStateCounts +## ComputeBinding ### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. +* **computeId**: string: ID of the compute resource. +* **nodeCount**: int: Number of nodes. -## ScaleSettings +## ComputeInstanceApplication ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ResourceId +## ComputeInstanceConnectivityEndpoints ### Properties -* **id**: string (Required): The ID of the resource +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## UserAccountCredentials +## ComputeInstanceCreatedBy ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. -## VirtualMachineImage +## ComputeInstanceLastOperation ### Properties -* **id**: string (Required): Virtual Machine image path +* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. +* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. +* **operationTime**: string: Time of the last operation. ## ComputeInstanceProperties ### Properties @@ -404,59 +327,65 @@ * **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. * **vmSize**: string: Virtual Machine Size -## ComputeInstanceApplication +## ComputeInstanceSshSettings ### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. -## ComputeInstanceConnectivityEndpoints -### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. +## ComputeSecrets +* **Discriminator**: computeType -## ComputeInstanceCreatedBy -### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -## ComputeInstanceLastOperation -### Properties -* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. -* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. -* **operationTime**: string: Time of the last operation. +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. -## PersonalComputeInstanceSettings -### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute -## AssignedUser + +## ContainerResourceRequirements ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +* **cpu**: int (WriteOnly): The number of CPU cores on the container. +* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. +* **gpu**: int (WriteOnly): The number of GPU cores in the container. +* **memoryInGB**: int (WriteOnly): The amount of memory on the container in GB. -## SetupScripts +## CreateServiceRequestEnvironmentImageRequest ### Properties -* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts +* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. +* **driverProgram**: string (WriteOnly): The name of the driver file. +* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. +* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. +* **modelIds**: string[] (WriteOnly): The list of model Ids. +* **models**: [Model](#model)[] (WriteOnly): The list of models. -## ScriptsToExecute +## CreateServiceRequestKeys ### Properties -* **creationScript**: [ScriptReference](#scriptreference): Script reference -* **startupScript**: [ScriptReference](#scriptreference): Script reference +* **primaryKey**: string (WriteOnly): The primary key. +* **secondaryKey**: string (WriteOnly): The secondary key. -## ScriptReference +## CreateServiceRequestKvTags ### Properties -* **scriptArguments**: string: Optional command line arguments passed to the script to run. -* **scriptData**: string: The location of scripts in the mounted volume. -* **scriptSource**: string: The storage source of the script: inline, workspace. -* **timeout**: string: Optional time period passed to timeout command. +### Additional Properties +* **Additional Properties Type**: string -## ComputeInstanceSshSettings +## CreateServiceRequestProperties ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +### Additional Properties +* **Additional Properties Type**: string ## DatabricksProperties ### Properties @@ -466,67 +395,68 @@ ### Properties * **dataLakeStoreAccountName**: string: DataLake Store Account Name -## HDInsightProperties +## DatasetReference ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **id**: string (WriteOnly): The id of the dataset reference. +* **name**: string (WriteOnly): The name of the dataset reference. -## VirtualMachineSshCredentials +## EncryptionProperty ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -## VirtualMachineProperties +## EnvironmentImageRequestEnvironment ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. +* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. +* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". +* **name**: string (WriteOnly): The name of the environment. +* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. +* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. +* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. +* **version**: string (WriteOnly): The environment version. -## ResourceTags +## EnvironmentImageRequestEnvironmentReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (WriteOnly): Name of the environment. +* **version**: string (WriteOnly): Version of the environment. -## WorkspaceConnectionProps +## ErrorDetail ### Properties -* **authType**: string: Authorization type of the workspace connection. -* **category**: string: Category of the workspace connection. -* **target**: string: Target of the workspace connection. -* **value**: string: Value details of the workspace connection. +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. -## LabelingJobProperties +## ErrorResponse ### Properties -* **createdTimeUtc**: string (ReadOnly): Created time of the job in UTC timezone. -* **datasetConfiguration**: [LabelingDatasetConfiguration](#labelingdatasetconfiguration) (Required): Represents configuration of dataset used in a labeling job. -* **jobInstructions**: [LabelingJobInstructions](#labelingjobinstructions) (Required): Instructions for a labeling job. -* **labelCategories**: [LabelingJobPropertiesLabelCategories](#labelingjobpropertieslabelcategories) (Required): Label categories of the job. -* **labelingJobMediaProperties**: [LabelingJobImageProperties](#labelingjobimageproperties) (Required): Properties in an labeling job of image media. -* **mlAssistConfiguration**: [MLAssistConfiguration](#mlassistconfiguration): Represents configuration for machine learning assisted features in a labeling job. -* **progressMetrics**: [ProgressMetrics](#progressmetrics) (ReadOnly): Progress metrics for a labeling job. -* **projectId**: string (ReadOnly): Internal id of the job(Previously called project). -* **properties**: [LabelingJobProperties](#labelingjobproperties): The job property dictionary. Properties can be added, but not removed or altered. -* **status**: 'CancelRequested' | 'Canceled' | 'Completed' | 'Failed' | 'Finalizing' | 'NotResponding' | 'NotStarted' | 'Paused' | 'Preparing' | 'Provisioning' | 'Queued' | 'Running' | 'Starting' | string (ReadOnly): The status of a job. -* **statusMessages**: [StatusMessage](#statusmessage)[] (ReadOnly): Status messages of the job. -* **tags**: [LabelingJobPropertiesTags](#labelingjobpropertiestags): The job tag dictionary. Tags can be added, removed, and updated. +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. -## LabelingDatasetConfiguration +## HDInsightProperties ### Properties -* **assetName**: string (Required): Name of the data asset to perform labeling. -* **datasetVersion**: string (Required): AML dataset version. -* **enableIncrementalDatasetRefresh**: bool: Indicates whether to enable incremental dataset refresh. +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## LabelingJobInstructions +## Identity ### Properties -* **uri**: string: The link to a page with detailed labeling instructions for labelers. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. -## LabelingJobPropertiesLabelCategories +## ImageAsset ### Properties -### Additional Properties -* **Additional Properties Type**: [LabelCategory](#labelcategory) +* **id**: string (WriteOnly): The Asset Id. +* **mimeType**: string (WriteOnly): The mime type. +* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. +* **url**: string (WriteOnly): The Url of the Asset. + +## KeyVaultProperties +### Properties +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. ## LabelCategory ### Properties @@ -549,6 +479,12 @@ ### Additional Properties * **Additional Properties Type**: [LabelClass](#labelclass) +## LabelingDatasetConfiguration +### Properties +* **assetName**: string (Required): Name of the data asset to perform labeling. +* **datasetVersion**: string (Required): AML dataset version. +* **enableIncrementalDatasetRefresh**: bool: Indicates whether to enable incremental dataset refresh. + ## LabelingJobImageProperties ### Properties * **annotationType**: 'BoundingBox' | 'Classification' | 'InstanceSegmentation' | string: Annotation type of image labeling tasks. @@ -556,52 +492,40 @@ ### Additional Properties * **Additional Properties Type**: any -## MLAssistConfiguration -### Properties -* **inferencingComputeBinding**: [ComputeBinding](#computebinding) (Required): Compute binding definition. -* **mlAssistEnabled**: bool: Indicates whether MLAssist feature is enabled. -* **modelNamePrefix**: string (Required): Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}. -* **prelabelAccuracyThreshold**: int: Prelabel accuracy threshold used in MLAssist feature. -* **trainingComputeBinding**: [ComputeBinding](#computebinding) (Required): Compute binding definition. - -## ComputeBinding +## LabelingJobInstructions ### Properties -* **computeId**: string: ID of the compute resource. -* **nodeCount**: int: Number of nodes. +* **uri**: string: The link to a page with detailed labeling instructions for labelers. -## ProgressMetrics +## LabelingJobProperties ### Properties -* **completedDatapointCount**: int (ReadOnly): The completed datapoint count. -* **incrementalDatasetLastRefreshTime**: string (ReadOnly): The time of last successful incremental dataset refresh in UTC. -* **skippedDatapointCount**: int (ReadOnly): The skipped datapoint count. -* **totalDatapointCount**: int (ReadOnly): The total datapoint count. +* **createdTimeUtc**: string (ReadOnly): Created time of the job in UTC timezone. +* **datasetConfiguration**: [LabelingDatasetConfiguration](#labelingdatasetconfiguration) (Required): Represents configuration of dataset used in a labeling job. +* **jobInstructions**: [LabelingJobInstructions](#labelingjobinstructions) (Required): Instructions for a labeling job. +* **labelCategories**: [LabelingJobPropertiesLabelCategories](#labelingjobpropertieslabelcategories) (Required): Label categories of the job. +* **labelingJobMediaProperties**: [LabelingJobImageProperties](#labelingjobimageproperties) (Required): Properties in an labeling job of image media. +* **mlAssistConfiguration**: [MLAssistConfiguration](#mlassistconfiguration): Represents configuration for machine learning assisted features in a labeling job. +* **progressMetrics**: [ProgressMetrics](#progressmetrics) (ReadOnly): Progress metrics for a labeling job. +* **projectId**: string (ReadOnly): Internal id of the job(Previously called project). +* **properties**: [LabelingJobProperties](#labelingjobproperties): The job property dictionary. Properties can be added, but not removed or altered. +* **status**: 'CancelRequested' | 'Canceled' | 'Completed' | 'Failed' | 'Finalizing' | 'NotResponding' | 'NotStarted' | 'Paused' | 'Preparing' | 'Provisioning' | 'Queued' | 'Running' | 'Starting' | string (ReadOnly): The status of a job. +* **statusMessages**: [StatusMessage](#statusmessage)[] (ReadOnly): Status messages of the job. +* **tags**: [LabelingJobPropertiesTags](#labelingjobpropertiestags): The job tag dictionary. Tags can be added, removed, and updated. ## LabelingJobProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StatusMessage +## LabelingJobPropertiesLabelCategories ### Properties -* **code**: string (ReadOnly): Service-defined message code. -* **createdTimeUtc**: string (ReadOnly): Time in UTC at which the message was created. -* **level**: 'Error' | 'Information' | 'Warning' | string (ReadOnly): Severity level of the status message. -* **message**: string (ReadOnly): A human-readable representation of the message code. +### Additional Properties +* **Additional Properties Type**: [LabelCategory](#labelcategory) ## LabelingJobPropertiesTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - ## LinkedServiceProps ### Properties * **createdTime**: string: The creation time of the linked service. @@ -609,43 +533,53 @@ * **linkType**: 'Synapse': Type of the link target. * **modifiedTime**: string: The last modified time of the linked service. -## ResourceTags +## ListNotebookKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## CreateServiceRequestEnvironmentImageRequest +## ListWorkspaceKeysResult ### Properties -* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. -* **driverProgram**: string (WriteOnly): The name of the driver file. -* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. -* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. -* **modelIds**: string[] (WriteOnly): The list of model Ids. -* **models**: [Model](#model)[] (WriteOnly): The list of models. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## ImageAsset +## MachineLearningServiceError ### Properties -* **id**: string (WriteOnly): The Asset Id. -* **mimeType**: string (WriteOnly): The mime type. -* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. -* **url**: string (WriteOnly): The Url of the Asset. +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. -## EnvironmentImageRequestEnvironment +## MLAssistConfiguration ### Properties -* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. -* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. -* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". -* **name**: string (WriteOnly): The name of the environment. -* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. -* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. -* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. -* **version**: string (WriteOnly): The environment version. +* **inferencingComputeBinding**: [ComputeBinding](#computebinding) (Required): Compute binding definition. +* **mlAssistEnabled**: bool: Indicates whether MLAssist feature is enabled. +* **modelNamePrefix**: string (Required): Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}. +* **prelabelAccuracyThreshold**: int: Prelabel accuracy threshold used in MLAssist feature. +* **trainingComputeBinding**: [ComputeBinding](#computebinding) (Required): Compute binding definition. -## ModelEnvironmentDefinitionDocker +## Model ### Properties -* **baseDockerfile**: string (WriteOnly): Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage. -* **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. -* **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. +* **createdTime**: string (WriteOnly): The Model creation time (UTC). +* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. +* **derivedModelIds**: string[] (WriteOnly): Models derived from this model +* **description**: string (WriteOnly): The Model description text. +* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. +* **framework**: string (WriteOnly): The Model framework. +* **frameworkVersion**: string (WriteOnly): The Model framework version. +* **id**: string (WriteOnly): The Model Id. +* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. +* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml +* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). +* **name**: string (Required, WriteOnly): The Model name. +* **parentModelId**: string (WriteOnly): The Parent Model Id. +* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. +* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). +* **runId**: string (WriteOnly): The RunId that created this model. +* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. +* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. +* **version**: int (WriteOnly): The Model version assigned by Model Management Service. ## ModelDockerSectionBaseImageRegistry ### Properties @@ -653,6 +587,12 @@ * **password**: string (WriteOnly) * **username**: string (WriteOnly) +## ModelEnvironmentDefinitionDocker +### Properties +* **baseDockerfile**: string (WriteOnly): Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage. +* **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. +* **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. + ## ModelEnvironmentDefinitionEnvironmentVariables ### Properties ### Additional Properties @@ -677,90 +617,95 @@ The path specified gets used to call the user script. * **snapshotDate**: string (WriteOnly): Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. "2019-04-17" * **userManaged**: bool (WriteOnly): Indicates whether the environment is managed by user or by AzureML. -## RCranPackage -### Properties -* **name**: string (WriteOnly): The package name. -* **repository**: string (WriteOnly): The repository name. - -## RGitHubPackage -### Properties -* **authToken**: string (WriteOnly): Personal access token to install from a private repo -* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. - ## ModelEnvironmentDefinitionSpark ### Properties * **packages**: [SparkMavenPackage](#sparkmavenpackage)[] (WriteOnly): The Spark packages to use. * **precachePackages**: bool (WriteOnly): Whether to precache the packages. * **repositories**: string[] (WriteOnly): The list of spark repositories. -## SparkMavenPackage +## ModelKvTags ### Properties -* **artifact**: string (WriteOnly) -* **group**: string (WriteOnly) -* **version**: string (WriteOnly) +### Additional Properties +* **Additional Properties Type**: string -## EnvironmentImageRequestEnvironmentReference +## ModelProperties ### Properties -* **name**: string (WriteOnly): Name of the environment. -* **version**: string (WriteOnly): Version of the environment. +### Additional Properties +* **Additional Properties Type**: string -## Model +## NodeStateCounts ### Properties -* **createdTime**: string (WriteOnly): The Model creation time (UTC). -* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. -* **derivedModelIds**: string[] (WriteOnly): Models derived from this model -* **description**: string (WriteOnly): The Model description text. -* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. -* **framework**: string (WriteOnly): The Model framework. -* **frameworkVersion**: string (WriteOnly): The Model framework version. -* **id**: string (WriteOnly): The Model Id. -* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. -* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml -* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). -* **name**: string (Required, WriteOnly): The Model name. -* **parentModelId**: string (WriteOnly): The Parent Model Id. -* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. -* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). -* **runId**: string (WriteOnly): The RunId that created this model. -* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. -* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. -* **version**: int (WriteOnly): The Model version assigned by Model Management Service. +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## DatasetReference +## Password ### Properties -* **id**: string (WriteOnly): The id of the dataset reference. -* **name**: string (WriteOnly): The name of the dataset reference. +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ModelKvTags +## PersonalComputeInstanceSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. -## ModelProperties +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ContainerResourceRequirements +## PrivateEndpointConnection ### Properties -* **cpu**: int (WriteOnly): The number of CPU cores on the container. -* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. -* **gpu**: int (WriteOnly): The number of GPU cores in the container. -* **memoryInGB**: int (WriteOnly): The amount of memory on the container in GB. +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. -## CreateServiceRequestKeys +## PrivateEndpointConnectionProperties ### Properties -* **primaryKey**: string (WriteOnly): The primary key. -* **secondaryKey**: string (WriteOnly): The secondary key. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## CreateServiceRequestKvTags +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## ProgressMetrics +### Properties +* **completedDatapointCount**: int (ReadOnly): The completed datapoint count. +* **incrementalDatasetLastRefreshTime**: string (ReadOnly): The time of last successful incremental dataset refresh in UTC. +* **skippedDatapointCount**: int (ReadOnly): The skipped datapoint count. +* **totalDatapointCount**: int (ReadOnly): The total datapoint count. + +## RCranPackage +### Properties +* **name**: string (WriteOnly): The package name. +* **repository**: string (WriteOnly): The repository name. + +## RegistryListCredentialsResult +### Properties +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) + +## ResourceId +### Properties +* **id**: string (Required): The ID of the resource + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CreateServiceRequestProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -770,100 +715,155 @@ The path specified gets used to call the user script. ### Additional Properties * **Additional Properties Type**: string -## ACIServiceCreateRequestDataCollection +## ResourceTags ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +### Additional Properties +* **Additional Properties Type**: string -## ACIServiceCreateRequestEncryptionProperties +## ResourceTags ### Properties -* **keyName**: string (Required, WriteOnly): Encryption Key name -* **keyVersion**: string (Required, WriteOnly): Encryption Key Version -* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url +### Additional Properties +* **Additional Properties Type**: string -## ACIServiceCreateRequestVnetConfiguration +## RGitHubPackage ### Properties -* **subnetName**: string (WriteOnly): The name of the virtual network subnet. -* **vnetName**: string (WriteOnly): The name of the virtual network. +* **authToken**: string (WriteOnly): Personal access token to install from a private repo +* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. -## AKSServiceCreateRequestAutoScaler +## ScaleSettings ### Properties -* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. -* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. -* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. -* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. -* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. -## AKSServiceCreateRequestDataCollection +## ScriptReference ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **scriptArguments**: string: Optional command line arguments passed to the script to run. +* **scriptData**: string: The location of scripts in the mounted volume. +* **scriptSource**: string: The storage source of the script: inline, workspace. +* **timeout**: string: Optional time period passed to timeout command. -## AKSServiceCreateRequestLivenessProbeRequirements +## ScriptsToExecute ### Properties -* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. -* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. -* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. -* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. -* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. +* **creationScript**: [ScriptReference](#scriptreference): Script reference +* **startupScript**: [ScriptReference](#scriptreference): Script reference -## ListWorkspaceKeysResult +## SetupScripts ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts -## RegistryListCredentialsResult +## SharedPrivateLinkResource ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## Password +## SharedPrivateLinkResourceProperty ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## ComputeSecrets -* **Discriminator**: computeType +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## SparkMavenPackage +### Properties +* **artifact**: string (WriteOnly) +* **group**: string (WriteOnly) +* **version**: string (WriteOnly) -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## StatusMessage +### Properties +* **code**: string (ReadOnly): Service-defined message code. +* **createdTimeUtc**: string (ReadOnly): Time in UTC at which the message was created. +* **level**: 'Error' | 'Information' | 'Warning' | string (ReadOnly): Severity level of the status message. +* **message**: string (ReadOnly): A human-readable representation of the message code. +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## AmlComputeNodesInformation +## SystemService ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -## AmlComputeNodeInformation +## UserAccountCredentials ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -## ListNotebookKeysResult +## UserAssignedIdentities ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. + +## VirtualMachineImage +### Properties +* **id**: string (Required): Virtual Machine image path + +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size + +## VirtualMachineSshCredentials +### Properties +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account + +## WorkspaceConnectionProps +### Properties +* **authType**: string: Authorization type of the workspace connection. +* **category**: string: Category of the workspace connection. +* **target**: string: Target of the workspace connection. +* **value**: string: Value details of the workspace connection. + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **creationTime**: string (ReadOnly): The creation time of the machine learning workspace in ISO8601 format. +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.md index e18452e9d1..3998fb89a6 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2021-01-01/types.md @@ -133,146 +133,98 @@ * **ApiVersion**: 2021-01-01 * **Output**: [ListStorageAccountKeysResult](#liststorageaccountkeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## IdentityForCmk -### Properties -* **userAssignedIdentity**: string (Required): The ArmId of the user assigned identity that will be used to access the customer managed key vault - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection +## ACIServiceCreateRequestDataCollection ### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## PrivateEndpointConnectionProperties +## ACIServiceCreateRequestEncryptionProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **keyName**: string (Required, WriteOnly): Encryption Key name +* **keyVersion**: string (Required, WriteOnly): Encryption Key Version +* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url -## PrivateEndpoint +## ACIServiceCreateRequestVnetConfiguration ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to +* **subnetName**: string (WriteOnly): The name of the virtual network subnet. +* **vnetName**: string (WriteOnly): The name of the virtual network. -## PrivateLinkServiceConnectionState +## AksNetworkingConfiguration ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## Sku +## AKSProperties ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## SystemData +## AKSServiceCreateRequestAutoScaler ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources +* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. +* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. +* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. +* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. +* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. -## ResourceTags +## AKSServiceCreateRequestDataCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## ServiceManagedResourcesSettings +## AKSServiceCreateRequestLivenessProbeRequirements ### Properties -* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) +* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. +* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. +* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. +* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. +* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. -## CosmosDbSettings +## AmlComputeNodeInformation ### Properties -* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResource +## AmlComputeNodesInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## SharedPrivateLinkResourceProperty +## AmlComputeProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## AssignedUser ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. ## Compute * **Discriminator**: computeType @@ -324,177 +276,160 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeInstanceApplication ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ErrorResponse +## ComputeInstanceConnectivityEndpoints ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## ErrorDetail +## ComputeInstanceCreatedBy ### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. -## AKSProperties +## ComputeInstanceLastOperation ### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. +* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. +* **operationTime**: string: Time of the last operation. -## AksNetworkingConfiguration +## ComputeInstanceProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. +* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. +* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). +* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. +* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. +* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. +* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. +* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. +* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. +* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmSize**: string: Virtual Machine Size -## SslConfiguration +## ComputeInstanceSshSettings ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +## ComputeSecrets +* **Discriminator**: computeType -## AmlComputeProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size - -## NodeStateCounts -### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -## ScaleSettings -### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. -## ResourceId -### Properties -* **id**: string (Required): The ID of the resource +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute -## UserAccountCredentials -### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -## VirtualMachineImage +## ContainerResourceRequirements ### Properties -* **id**: string (Required): Virtual Machine image path +* **cpu**: int (WriteOnly): The minimum amount of CPU cores to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **cpuLimit**: int (WriteOnly): The maximum amount of CPU cores allowed to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. +* **gpu**: int (WriteOnly): The number of GPU cores in the container. +* **memoryInGB**: int (WriteOnly): The minimum amount of memory (in GB) to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **memoryInGBLimit**: int (WriteOnly): The maximum amount of memory (in GB) allowed to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -## ComputeInstanceProperties +## CosmosDbSettings ### Properties -* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. -* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. -* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). -* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. -* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. -* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. -* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. -* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. -* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. -* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmSize**: string: Virtual Machine Size +* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database -## ComputeInstanceApplication +## CreateServiceRequestEnvironmentImageRequest ### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. +* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. +* **driverProgram**: string (WriteOnly): The name of the driver file. +* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. +* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. +* **modelIds**: string[] (WriteOnly): The list of model Ids. +* **models**: [Model](#model)[] (WriteOnly): The list of models. -## ComputeInstanceConnectivityEndpoints +## CreateServiceRequestKeys ### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. +* **primaryKey**: string (WriteOnly): The primary key. +* **secondaryKey**: string (WriteOnly): The secondary key. -## ComputeInstanceCreatedBy +## CreateServiceRequestKvTags ### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. +### Additional Properties +* **Additional Properties Type**: string -## ComputeInstanceLastOperation +## CreateServiceRequestProperties ### Properties -* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. -* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. -* **operationTime**: string: Time of the last operation. +### Additional Properties +* **Additional Properties Type**: string -## PersonalComputeInstanceSettings +## DatabricksProperties ### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. +* **databricksAccessToken**: string: Databricks access token +* **workspaceUrl**: string: Workspace Url -## AssignedUser +## DataLakeAnalyticsProperties ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name -## SetupScripts +## DatasetReference ### Properties -* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts +* **id**: string (WriteOnly): The id of the dataset reference. +* **name**: string (WriteOnly): The name of the dataset reference. -## ScriptsToExecute +## EncryptionProperty ### Properties -* **creationScript**: [ScriptReference](#scriptreference): Script reference -* **startupScript**: [ScriptReference](#scriptreference): Script reference +* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -## ScriptReference +## EnvironmentImageRequestEnvironment ### Properties -* **scriptArguments**: string: Optional command line arguments passed to the script to run. -* **scriptData**: string: The location of scripts in the mounted volume. -* **scriptSource**: string: The storage source of the script: inline, workspace. -* **timeout**: string: Optional time period passed to timeout command. +* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. +* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. +* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". +* **name**: string (WriteOnly): The name of the environment. +* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. +* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. +* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. +* **version**: string (WriteOnly): The environment version. -## ComputeInstanceSshSettings +## EnvironmentImageRequestEnvironmentReference ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +* **name**: string (WriteOnly): Name of the environment. +* **version**: string (WriteOnly): Version of the environment. -## DatabricksProperties +## ErrorDetail ### Properties -* **databricksAccessToken**: string: Databricks access token -* **workspaceUrl**: string: Workspace Url +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. -## DataLakeAnalyticsProperties +## ErrorResponse ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. ## HDInsightProperties ### Properties @@ -502,70 +437,79 @@ * **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine * **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## VirtualMachineSshCredentials +## Identity ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. -## VirtualMachineProperties +## IdentityForCmk ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **userAssignedIdentity**: string (Required): The ArmId of the user assigned identity that will be used to access the customer managed key vault -## ResourceTags +## ImageAsset ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (WriteOnly): The Asset Id. +* **mimeType**: string (WriteOnly): The mime type. +* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. +* **url**: string (WriteOnly): The Url of the Asset. -## WorkspaceConnectionProps +## KeyVaultProperties ### Properties -* **authType**: string: Authorization type of the workspace connection. -* **category**: string: Category of the workspace connection. -* **target**: string: Target of the workspace connection. -* **value**: string: Value details of the workspace connection. -* **valueFormat**: 'JSON' | string: format for the workspace connection value +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## ResourceTags +## ListNotebookKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## CreateServiceRequestEnvironmentImageRequest +## ListNotebookKeysResult ### Properties -* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. -* **driverProgram**: string (WriteOnly): The name of the driver file. -* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. -* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. -* **modelIds**: string[] (WriteOnly): The list of model Ids. -* **models**: [Model](#model)[] (WriteOnly): The list of models. +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## ImageAsset +## ListStorageAccountKeysResult ### Properties -* **id**: string (WriteOnly): The Asset Id. -* **mimeType**: string (WriteOnly): The mime type. -* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. -* **url**: string (WriteOnly): The Url of the Asset. +* **userStorageKey**: string (ReadOnly) -## EnvironmentImageRequestEnvironment +## ListWorkspaceKeysResult ### Properties -* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. -* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. -* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". -* **name**: string (WriteOnly): The name of the environment. -* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. -* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. -* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. -* **version**: string (WriteOnly): The environment version. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## ModelEnvironmentDefinitionDocker +## MachineLearningServiceError ### Properties -* **baseDockerfile**: string (WriteOnly): Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage. -* **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. -* **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. + +## Model +### Properties +* **createdTime**: string (WriteOnly): The Model creation time (UTC). +* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. +* **derivedModelIds**: string[] (WriteOnly): Models derived from this model +* **description**: string (WriteOnly): The Model description text. +* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. +* **framework**: string (WriteOnly): The Model framework. +* **frameworkVersion**: string (WriteOnly): The Model framework version. +* **id**: string (WriteOnly): The Model Id. +* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. +* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml +* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). +* **name**: string (Required, WriteOnly): The Model name. +* **parentModelId**: string (WriteOnly): The Parent Model Id. +* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. +* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). +* **runId**: string (WriteOnly): The RunId that created this model. +* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. +* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. +* **version**: int (WriteOnly): The Model version assigned by Model Management Service. ## ModelDockerSectionBaseImageRegistry ### Properties @@ -573,6 +517,12 @@ * **password**: string (WriteOnly) * **username**: string (WriteOnly) +## ModelEnvironmentDefinitionDocker +### Properties +* **baseDockerfile**: string (WriteOnly): Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage. +* **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. +* **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. + ## ModelEnvironmentDefinitionEnvironmentVariables ### Properties ### Additional Properties @@ -597,96 +547,122 @@ The path specified gets used to call the user script. * **snapshotDate**: string (WriteOnly): Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. "2019-04-17" * **userManaged**: bool (WriteOnly): Indicates whether the environment is managed by user or by AzureML. -## RCranPackage -### Properties -* **name**: string (WriteOnly): The package name. -* **repository**: string (WriteOnly): The repository name. - -## RGitHubPackage -### Properties -* **authToken**: string (WriteOnly): Personal access token to install from a private repo -* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. - ## ModelEnvironmentDefinitionSpark ### Properties * **packages**: [SparkMavenPackage](#sparkmavenpackage)[] (WriteOnly): The Spark packages to use. * **precachePackages**: bool (WriteOnly): Whether to precache the packages. * **repositories**: string[] (WriteOnly): The list of spark repositories. -## SparkMavenPackage +## ModelKvTags ### Properties -* **artifact**: string (WriteOnly) -* **group**: string (WriteOnly) -* **version**: string (WriteOnly) +### Additional Properties +* **Additional Properties Type**: string + +## ModelProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## NodeStateCounts +### Properties +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. + +## NotebookAccessTokenResult +### Properties +* **accessToken**: string (ReadOnly) +* **expiresIn**: int (ReadOnly) +* **hostName**: string (ReadOnly) +* **notebookResourceId**: string (ReadOnly) +* **publicDns**: string (ReadOnly) +* **refreshToken**: string (ReadOnly) +* **scope**: string (ReadOnly) +* **tokenType**: string (ReadOnly) + +## NotebookPreparationError +### Properties +* **errorMessage**: string +* **statusCode**: int + +## NotebookResourceInfo +### Properties +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component + +## Password +### Properties +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## PersonalComputeInstanceSettings +### Properties +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## EnvironmentImageRequestEnvironmentReference +## RCranPackage ### Properties -* **name**: string (WriteOnly): Name of the environment. -* **version**: string (WriteOnly): Version of the environment. +* **name**: string (WriteOnly): The package name. +* **repository**: string (WriteOnly): The repository name. -## Model +## RegistryListCredentialsResult ### Properties -* **createdTime**: string (WriteOnly): The Model creation time (UTC). -* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. -* **derivedModelIds**: string[] (WriteOnly): Models derived from this model -* **description**: string (WriteOnly): The Model description text. -* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. -* **framework**: string (WriteOnly): The Model framework. -* **frameworkVersion**: string (WriteOnly): The Model framework version. -* **id**: string (WriteOnly): The Model Id. -* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. -* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml -* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). -* **name**: string (Required, WriteOnly): The Model name. -* **parentModelId**: string (WriteOnly): The Parent Model Id. -* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. -* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). -* **runId**: string (WriteOnly): The RunId that created this model. -* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. -* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. -* **version**: int (WriteOnly): The Model version assigned by Model Management Service. +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## DatasetReference +## ResourceId ### Properties -* **id**: string (WriteOnly): The id of the dataset reference. -* **name**: string (WriteOnly): The name of the dataset reference. +* **id**: string (Required): The ID of the resource -## ModelKvTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ModelProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ContainerResourceRequirements -### Properties -* **cpu**: int (WriteOnly): The minimum amount of CPU cores to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **cpuLimit**: int (WriteOnly): The maximum amount of CPU cores allowed to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. -* **gpu**: int (WriteOnly): The number of GPU cores in the container. -* **memoryInGB**: int (WriteOnly): The minimum amount of memory (in GB) to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **memoryInGBLimit**: int (WriteOnly): The maximum amount of memory (in GB) allowed to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - -## CreateServiceRequestKeys -### Properties -* **primaryKey**: string (WriteOnly): The primary key. -* **secondaryKey**: string (WriteOnly): The secondary key. - -## CreateServiceRequestKvTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CreateServiceRequestProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -696,121 +672,145 @@ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-conta ### Additional Properties * **Additional Properties Type**: string -## ACIServiceCreateRequestDataCollection +## RGitHubPackage ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **authToken**: string (WriteOnly): Personal access token to install from a private repo +* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. -## ACIServiceCreateRequestEncryptionProperties +## ScaleSettings ### Properties -* **keyName**: string (Required, WriteOnly): Encryption Key name -* **keyVersion**: string (Required, WriteOnly): Encryption Key Version -* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. -## ACIServiceCreateRequestVnetConfiguration +## ScriptReference ### Properties -* **subnetName**: string (WriteOnly): The name of the virtual network subnet. -* **vnetName**: string (WriteOnly): The name of the virtual network. +* **scriptArguments**: string: Optional command line arguments passed to the script to run. +* **scriptData**: string: The location of scripts in the mounted volume. +* **scriptSource**: string: The storage source of the script: inline, workspace. +* **timeout**: string: Optional time period passed to timeout command. -## AKSServiceCreateRequestAutoScaler +## ScriptsToExecute ### Properties -* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. -* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. -* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. -* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. -* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. +* **creationScript**: [ScriptReference](#scriptreference): Script reference +* **startupScript**: [ScriptReference](#scriptreference): Script reference -## AKSServiceCreateRequestDataCollection +## ServiceManagedResourcesSettings ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) -## AKSServiceCreateRequestLivenessProbeRequirements +## SetupScripts ### Properties -* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. -* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. -* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. -* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. -* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. +* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts -## ListWorkspaceKeysResult +## SharedPrivateLinkResource ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## RegistryListCredentialsResult +## SharedPrivateLinkResourceProperty ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## Password +## Sku ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## ListNotebookKeysResult +## SparkMavenPackage ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **artifact**: string (WriteOnly) +* **group**: string (WriteOnly) +* **version**: string (WriteOnly) -## ComputeSecrets -* **Discriminator**: computeType +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'application' | 'key' | 'managedIdentity' | 'user' | string: The type of identity that creates/modifies resources -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## AmlComputeNodesInformation +## UserAssignedIdentity ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. -## AmlComputeNodeInformation +## VirtualMachineImage ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **id**: string (Required): Virtual Machine image path -## NotebookAccessTokenResult +## VirtualMachineProperties ### Properties -* **accessToken**: string (ReadOnly) -* **expiresIn**: int (ReadOnly) -* **hostName**: string (ReadOnly) -* **notebookResourceId**: string (ReadOnly) -* **publicDns**: string (ReadOnly) -* **refreshToken**: string (ReadOnly) -* **scope**: string (ReadOnly) -* **tokenType**: string (ReadOnly) +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## ListNotebookKeysResult +## VirtualMachineSshCredentials ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## ListStorageAccountKeysResult +## WorkspaceConnectionProps ### Properties -* **userStorageKey**: string (ReadOnly) +* **authType**: string: Authorization type of the workspace connection. +* **category**: string: Category of the workspace connection. +* **target**: string: Target of the workspace connection. +* **value**: string: Value details of the workspace connection. +* **valueFormat**: 'JSON' | string: format for the workspace connection value + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.md index 2924754685..5dad0fb8da 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2021-03-01-preview/types.md @@ -263,165 +263,125 @@ * **ApiVersion**: 2021-03-01-preview * **Output**: [ListStorageAccountKeysResult](#liststorageaccountkeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccountKeyDatastoreSecrets ### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. +* **key**: string: Storage account key. +* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. -## WorkspaceProperties +## AksNetworkingConfiguration ### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## EncryptionProperty +## AKSProperties ### Properties -* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster +* **loadBalancerSubnet**: string: Load Balancer Subnet +* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## IdentityForCmk +## AmlComputeNodeInformation ### Properties -* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## KeyVaultProperties +## AmlComputeNodesInformation ### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'SynapseSpark' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## NotebookResourceInfo +## AmlComputeProperties ### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int +## AssetReferenceBase +* **Discriminator**: referenceType -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [PrivateEndpointConnectionTags](#privateendpointconnectiontags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +### Base Properties +### DataPathAssetReference +#### Properties +* **datastoreId**: string: ARM resource ID of the datastore where the asset is located. +* **path**: string: The path of the file/directory in the datastore. +* **referenceType**: 'DataPath' (Required): [Required] Specifies the type of asset reference. -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### IdAssetReference +#### Properties +* **assetId**: string (Required): [Required] ARM resource ID of the asset. +* **referenceType**: 'Id' (Required): [Required] Specifies the type of asset reference. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to +### OutputPathAssetReference +#### Properties +* **jobId**: string: ARM resource ID of the job. +* **path**: string: The path of the file/directory in the job output. +* **referenceType**: 'OutputPath' (Required): [Required] Specifies the type of asset reference. -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## Sku +## AssignedUser ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. -## SystemData +## BatchDeployment ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **codeConfiguration**: [CodeConfiguration](#codeconfiguration): Configuration for a scoring code asset. +* **compute**: [ComputeConfiguration](#computeconfiguration): Configuration for compute binding. +* **description**: string: Description of the endpoint deployment. +* **environmentId**: string: ARM resource ID of the environment specification for the endpoint deployment. +* **environmentVariables**: [BatchDeploymentEnvironmentVariables](#batchdeploymentenvironmentvariables): Environment variables configuration for the deployment. +* **errorThreshold**: int: Error threshold, if the error count for the entire input goes above this value, +the batch inference will be aborted. Range is [-1, int.MaxValue]. +For FileDataset, this value is the count of file failures. +For TabularDataset, this value is the count of record failures. +If set to -1 (the lower bound), all failures during batch inference will be ignored. +* **loggingLevel**: 'Debug' | 'Info' | 'Warning' | string: Log verbosity for batch inferencing. +Increasing verbosity order for logging is : Warning, Info and Debug. +The default value is Info. +* **miniBatchSize**: int: Size of the mini-batch passed to each batch invocation. +For FileDataset, this is the number of files per mini-batch. +For TabularDataset, this is the size of the records in bytes, per mini-batch. +* **model**: [AssetReferenceBase](#assetreferencebase): Base definition for asset references. +* **outputConfiguration**: [BatchOutputConfiguration](#batchoutputconfiguration): Batch inference output configuration. +* **partitionKeys**: string[]: Partition keys list used for Named partitioning. +* **properties**: [BatchDeploymentProperties](#batchdeploymentproperties): Property dictionary. Properties can be added, but not removed or altered. +* **retrySettings**: [BatchRetrySettings](#batchretrysettings): Retry settings for a batch inference operation. -## PrivateEndpointConnectionTags +## BatchDeploymentEnvironmentVariables ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceManagedResourcesSettings -### Properties -* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) - -## CosmosDbSettings -### Properties -* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database - -## SharedPrivateLinkResource -### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. - -## SharedPrivateLinkResourceProperty -### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. - -## WorkspaceTags +## BatchDeploymentProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): Client ID that is used when authenticating. -* **tenantId**: string (ReadOnly): AAD Tenant where this identity lives. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Defines values for a ResourceIdentity's type. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): Dictionary of the user assigned identities, key is ARM resource ID of the UAI. - -## ResourceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentityMeta](#userassignedidentitymeta) - -## UserAssignedIdentityMeta -### Properties -* **clientId**: string: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. -* **principalId**: string: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. - ## BatchEndpoint ### Properties * **authMode**: 'AADToken' | 'AMLToken' | 'Key' | string: Enum to determine endpoint authentication mode. @@ -432,11 +392,6 @@ * **swaggerUri**: string (ReadOnly): Endpoint Swagger URI. * **traffic**: [BatchEndpointTraffic](#batchendpointtraffic): Traffic rules on how the traffic will be routed across deployments. -## EndpointAuthKeys -### Properties -* **primaryKey**: string: The primary key. -* **secondaryKey**: string: The secondary key. - ## BatchEndpointProperties ### Properties ### Additional Properties @@ -447,135 +402,80 @@ ### Additional Properties * **Additional Properties Type**: int -## TrackedResourceTags +## BatchOutputConfiguration +### Properties +* **appendRowFileName**: string: Customized output file name for append_row output action. +* **outputAction**: 'AppendRow' | 'SummaryOnly' | string: Enum to determine how batch inferencing will handle output + +## BatchRetrySettings +### Properties +* **maxRetries**: int: Maximum retry count for a mini-batch +* **timeout**: string: Invocation timeout for a mini-batch, in ISO 8601 format. + +## CertificateDatastoreSecrets +### Properties +* **certificate**: string: Service principal certificate. +* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. + +## CodeConfiguration +### Properties +* **codeId**: string: ARM resource ID of the code asset. +* **scoringScript**: string (Required): [Required] The script to execute on startup. eg. "score.py" + +## CodeContainer +### Properties +* **description**: string: The asset description text. +* **properties**: [CodeContainerProperties](#codecontainerproperties): The asset property dictionary. +* **tags**: [CodeContainerTags](#codecontainertags): Tag dictionary. Tags can be added, removed, and updated. + +## CodeContainerProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## BatchDeployment -### Properties -* **codeConfiguration**: [CodeConfiguration](#codeconfiguration): Configuration for a scoring code asset. -* **compute**: [ComputeConfiguration](#computeconfiguration): Configuration for compute binding. -* **description**: string: Description of the endpoint deployment. -* **environmentId**: string: ARM resource ID of the environment specification for the endpoint deployment. -* **environmentVariables**: [BatchDeploymentEnvironmentVariables](#batchdeploymentenvironmentvariables): Environment variables configuration for the deployment. -* **errorThreshold**: int: Error threshold, if the error count for the entire input goes above this value, -the batch inference will be aborted. Range is [-1, int.MaxValue]. -For FileDataset, this value is the count of file failures. -For TabularDataset, this value is the count of record failures. -If set to -1 (the lower bound), all failures during batch inference will be ignored. -* **loggingLevel**: 'Debug' | 'Info' | 'Warning' | string: Log verbosity for batch inferencing. -Increasing verbosity order for logging is : Warning, Info and Debug. -The default value is Info. -* **miniBatchSize**: int: Size of the mini-batch passed to each batch invocation. -For FileDataset, this is the number of files per mini-batch. -For TabularDataset, this is the size of the records in bytes, per mini-batch. -* **model**: [AssetReferenceBase](#assetreferencebase): Base definition for asset references. -* **outputConfiguration**: [BatchOutputConfiguration](#batchoutputconfiguration): Batch inference output configuration. -* **partitionKeys**: string[]: Partition keys list used for Named partitioning. -* **properties**: [BatchDeploymentProperties](#batchdeploymentproperties): Property dictionary. Properties can be added, but not removed or altered. -* **retrySettings**: [BatchRetrySettings](#batchretrysettings): Retry settings for a batch inference operation. - -## CodeConfiguration -### Properties -* **codeId**: string: ARM resource ID of the code asset. -* **scoringScript**: string (Required): [Required] The script to execute on startup. eg. "score.py" - -## ComputeConfiguration -### Properties -* **instanceCount**: int: Number of instances or nodes. -* **instanceType**: string: SKU type to run on. -* **isLocal**: bool: Set to true for jobs running on local compute. -* **location**: string: Location for virtual cluster run. -* **properties**: [ComputeConfigurationProperties](#computeconfigurationproperties): Additional properties. -* **target**: string: ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed. - -## ComputeConfigurationProperties +## CodeContainerTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BatchDeploymentEnvironmentVariables +## CodeVersion ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AssetReferenceBase -* **Discriminator**: referenceType - -### Base Properties -### DataPathAssetReference -#### Properties * **datastoreId**: string: ARM resource ID of the datastore where the asset is located. -* **path**: string: The path of the file/directory in the datastore. -* **referenceType**: 'DataPath' (Required): [Required] Specifies the type of asset reference. - -### IdAssetReference -#### Properties -* **assetId**: string (Required): [Required] ARM resource ID of the asset. -* **referenceType**: 'Id' (Required): [Required] Specifies the type of asset reference. - -### OutputPathAssetReference -#### Properties -* **jobId**: string: ARM resource ID of the job. -* **path**: string: The path of the file/directory in the job output. -* **referenceType**: 'OutputPath' (Required): [Required] Specifies the type of asset reference. - - -## BatchOutputConfiguration -### Properties -* **appendRowFileName**: string: Customized output file name for append_row output action. -* **outputAction**: 'AppendRow' | 'SummaryOnly' | string: Enum to determine how batch inferencing will handle output +* **description**: string: The asset description text. +* **isAnonymous**: bool: If the name version are system generated (anonymous registration). +* **path**: string (Required): [Required] The path of the file/directory in the datastore. +* **properties**: [CodeVersionProperties](#codeversionproperties): The asset property dictionary. +* **tags**: [CodeVersionTags](#codeversiontags): Tag dictionary. Tags can be added, removed, and updated. -## BatchDeploymentProperties +## CodeVersionProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## BatchRetrySettings -### Properties -* **maxRetries**: int: Maximum retry count for a mini-batch -* **timeout**: string: Invocation timeout for a mini-batch, in ISO 8601 format. - -## TrackedResourceTags +## CodeVersionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CodeContainer -### Properties -* **description**: string: The asset description text. -* **properties**: [CodeContainerProperties](#codecontainerproperties): The asset property dictionary. -* **tags**: [CodeContainerTags](#codecontainertags): Tag dictionary. Tags can be added, removed, and updated. - -## CodeContainerProperties +## CommandJobEnvironmentVariables ### Properties ### Additional Properties * **Additional Properties Type**: string -## CodeContainerTags +## CommandJobInputDataBindings ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## CodeVersion -### Properties -* **datastoreId**: string: ARM resource ID of the datastore where the asset is located. -* **description**: string: The asset description text. -* **isAnonymous**: bool: If the name version are system generated (anonymous registration). -* **path**: string (Required): [Required] The path of the file/directory in the datastore. -* **properties**: [CodeVersionProperties](#codeversionproperties): The asset property dictionary. -* **tags**: [CodeVersionTags](#codeversiontags): Tag dictionary. Tags can be added, removed, and updated. +* **Additional Properties Type**: [InputDataBinding](#inputdatabinding) -## CodeVersionProperties +## CommandJobOutputDataBindings ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [OutputDataBinding](#outputdatabinding) -## CodeVersionTags +## CommandJobParameters ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any ## Compute * **Discriminator**: computeType @@ -634,104 +534,41 @@ For TabularDataset, this is the size of the records in bytes, per mini-batch. * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## ErrorResponse -### Properties -* **error**: [ErrorDetail](#errordetail): The error detail. - -## ErrorDetail -### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. - -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - -## AKSProperties -### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster -* **loadBalancerSubnet**: string: Load Balancer Subnet -* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services - -## AksNetworkingConfiguration -### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to - -## SslConfiguration -### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **leafDomainLabel**: string: Leaf domain label of public endpoint -* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring - -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. - -## AmlComputeProperties +## ComputeConfiguration ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **instanceCount**: int: Number of instances or nodes. +* **instanceType**: string: SKU type to run on. +* **isLocal**: bool: Set to true for jobs running on local compute. +* **location**: string: Location for virtual cluster run. +* **properties**: [ComputeConfigurationProperties](#computeconfigurationproperties): Additional properties. +* **target**: string: ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed. -## NodeStateCounts +## ComputeConfigurationProperties ### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. +### Additional Properties +* **Additional Properties Type**: string -## ScaleSettings +## ComputeInstanceApplication ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ResourceId +## ComputeInstanceConnectivityEndpoints ### Properties -* **id**: string (Required): The ID of the resource +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## UserAccountCredentials +## ComputeInstanceCreatedBy ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. -## VirtualMachineImage +## ComputeInstanceLastOperation ### Properties -* **id**: string (Required): Virtual Machine image path +* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. +* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. +* **operationTime**: string: Time of the last operation. ## ComputeInstanceProperties ### Properties @@ -751,41 +588,44 @@ For TabularDataset, this is the size of the records in bytes, per mini-batch. * **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. * **vmSize**: string: Virtual Machine Size -## ComputeInstanceApplication -### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. - -## ComputeInstanceConnectivityEndpoints -### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. - -## ComputeInstanceCreatedBy -### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. - -## ComputeInstanceLastOperation -### Properties -* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. -* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. -* **operationTime**: string: Time of the last operation. - -## PersonalComputeInstanceSettings +## ComputeInstanceSshSettings ### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. -## AssignedUser +## ComputeResourceTags ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +### Additional Properties +* **Additional Properties Type**: string ## ComputeSchedules ### Properties * **computeStartStop**: [ComputeStartStopSchedule](#computestartstopschedule)[]: The list of compute start stop schedules to be applied. +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + ## ComputeStartStopSchedule ### Properties * **action**: 'Start' | 'Stop' | string: The compute power action. @@ -796,92 +636,34 @@ For TabularDataset, this is the size of the records in bytes, per mini-batch. * **status**: 'Disabled' | 'Enabled' | string: The schedule status. * **triggerType**: 'Cron' | 'Recurrence' | string: The schedule trigger type. -## Cron -### Properties -* **expression**: string: The cron expression. -* **startTime**: string: The start time. -* **timeZone**: string: The time zone. - -## Recurrence -### Properties -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' | string: The recurrence frequency. -* **interval**: int: The interval. -* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule -* **startTime**: string: The start time. -* **timeZone**: string: The time zone. - -## RecurrenceSchedule -### Properties -* **hours**: int[]: The hours. -* **minutes**: int[]: The minutes. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The days of the week. - -## SetupScripts -### Properties -* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts - -## ScriptsToExecute +## ContainerResourceRequirements ### Properties -* **creationScript**: [ScriptReference](#scriptreference): Script reference -* **startupScript**: [ScriptReference](#scriptreference): Script reference +* **cpu**: int: The minimum amount of CPU cores to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **cpuLimit**: int: The maximum amount of CPU cores allowed to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **fpga**: int: The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. +* **gpu**: int: The number of GPU cores in the container. +* **memoryInGB**: int: The minimum amount of memory (in GB) to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **memoryInGBLimit**: int: The maximum amount of memory (in GB) allowed to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -## ScriptReference +## CosmosDbSettings ### Properties -* **scriptArguments**: string: Optional command line arguments passed to the script to run. -* **scriptData**: string: The location of scripts in the mounted volume. -* **scriptSource**: string: The storage source of the script: inline, workspace. -* **timeout**: string: Optional time period passed to timeout command. +* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database -## ComputeInstanceSshSettings +## Cron ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +* **expression**: string: The cron expression. +* **startTime**: string: The start time. +* **timeZone**: string: The time zone. ## DatabricksProperties ### Properties * **databricksAccessToken**: string: Databricks access token * **workspaceUrl**: string: Workspace Url -## DataLakeAnalyticsProperties -### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name - -## HDInsightProperties -### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. - -## VirtualMachineSshCredentials -### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account - -## VirtualMachineProperties -### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **isNotebookInstanceCompute**: bool: Indicates whether this compute will be used for running notebooks. -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size - -## ComputeResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WorkspaceConnectionProps -### Properties -* **authType**: string: Authorization type of the workspace connection. -* **category**: string: Category of the workspace connection. -* **target**: string: Target of the workspace connection. -* **value**: string: Value details of the workspace connection. -* **valueFormat**: 'JSON' | string: format for the workspace connection value - ## DataContainer ### Properties * **description**: string: The asset description text. @@ -898,35 +680,9 @@ For TabularDataset, this is the size of the records in bytes, per mini-batch. ### Additional Properties * **Additional Properties Type**: string -## DataVersion -### Properties -* **datasetType**: 'Dataflow' | 'Simple' | string -* **datastoreId**: string: ARM resource ID of the datastore where the asset is located. -* **description**: string: The asset description text. -* **isAnonymous**: bool: If the name version are system generated (anonymous registration). -* **path**: string (Required): [Required] The path of the file/directory in the datastore. -* **properties**: [DataVersionProperties](#dataversionproperties): The asset property dictionary. -* **tags**: [DataVersionTags](#dataversiontags): Tag dictionary. Tags can be added, removed, and updated. - -## DataVersionProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DataVersionTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DatastoreProperties +## DataLakeAnalyticsProperties ### Properties -* **contents**: [DatastoreContents](#datastorecontents) (Required): Base definition for datastore contents configuration. -* **description**: string: The asset description text. -* **hasBeenValidated**: bool (ReadOnly): Whether the service has validated access to the datastore with the provided credentials. -* **isDefault**: bool: Whether this datastore is the default for the workspace. -* **linkedInfo**: [LinkedInfo](#linkedinfo): Information about a datastore origin, if linked. -* **properties**: [DatastoreProperties](#datastoreproperties): The asset property dictionary. -* **tags**: [DatastorePropertiesTags](#datastorepropertiestags): Tag dictionary. Tags can be added, removed, and updated. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name ## DatastoreContents * **Discriminator**: contentsType @@ -1036,40 +792,15 @@ For TabularDataset, this is the size of the records in bytes, per mini-batch. * **userId**: string (Required): [Required] SQL database user name. -## AccountKeyDatastoreSecrets -### Properties -* **key**: string: Storage account key. -* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. - -## CertificateDatastoreSecrets -### Properties -* **certificate**: string: Service principal certificate. -* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. - -## NoneDatastoreSecrets -### Properties -* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. - -## SasDatastoreSecrets -### Properties -* **sasToken**: string: Storage container SAS token. -* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. - -## ServicePrincipalDatastoreSecrets -### Properties -* **clientSecret**: string: Service principal secret. -* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. - -## SqlAdminDatastoreSecrets -### Properties -* **password**: string: SQL database password. -* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. - -## LinkedInfo +## DatastoreProperties ### Properties -* **linkedId**: string: Linked service ID. -* **linkedResourceName**: string: Linked service resource name. -* **origin**: 'Synapse' | string: Enum to determine the type of linked service. +* **contents**: [DatastoreContents](#datastorecontents) (Required): Base definition for datastore contents configuration. +* **description**: string: The asset description text. +* **hasBeenValidated**: bool (ReadOnly): Whether the service has validated access to the datastore with the provided credentials. +* **isDefault**: bool: Whether this datastore is the default for the workspace. +* **linkedInfo**: [LinkedInfo](#linkedinfo): Information about a datastore origin, if linked. +* **properties**: [DatastoreProperties](#datastoreproperties): The asset property dictionary. +* **tags**: [DatastorePropertiesTags](#datastorepropertiestags): Tag dictionary. Tags can be added, removed, and updated. ## DatastoreProperties ### Properties @@ -1081,45 +812,96 @@ For TabularDataset, this is the size of the records in bytes, per mini-batch. ### Additional Properties * **Additional Properties Type**: string -## EnvironmentContainer +## DatastoreSecrets +* **Discriminator**: secretsType + +### Base Properties +### AccountKeyDatastoreSecrets +#### Properties +* **key**: string (ReadOnly): Storage account key. +* **secretsType**: 'AccountKey' (Required): [Required] Credential type used to authentication with storage. + +### CertificateDatastoreSecrets +#### Properties +* **certificate**: string (ReadOnly): Service principal certificate. +* **secretsType**: 'Certificate' (Required): [Required] Credential type used to authentication with storage. + +### NoneDatastoreSecrets +#### Properties +* **secretsType**: 'None' (Required): [Required] Credential type used to authentication with storage. + +### SasDatastoreSecrets +#### Properties +* **sasToken**: string (ReadOnly): Storage container SAS token. +* **secretsType**: 'Sas' (Required): [Required] Credential type used to authentication with storage. + +### ServicePrincipalDatastoreSecrets +#### Properties +* **clientSecret**: string (ReadOnly): Service principal secret. +* **secretsType**: 'ServicePrincipal' (Required): [Required] Credential type used to authentication with storage. + +### SqlAdminDatastoreSecrets +#### Properties +* **password**: string (ReadOnly): SQL database password. +* **secretsType**: 'SqlAdmin' (Required): [Required] Credential type used to authentication with storage. + + +## DataVersion ### Properties +* **datasetType**: 'Dataflow' | 'Simple' | string +* **datastoreId**: string: ARM resource ID of the datastore where the asset is located. * **description**: string: The asset description text. -* **properties**: [EnvironmentContainerProperties](#environmentcontainerproperties): The asset property dictionary. -* **tags**: [EnvironmentContainerTags](#environmentcontainertags): Tag dictionary. Tags can be added, removed, and updated. +* **isAnonymous**: bool: If the name version are system generated (anonymous registration). +* **path**: string (Required): [Required] The path of the file/directory in the datastore. +* **properties**: [DataVersionProperties](#dataversionproperties): The asset property dictionary. +* **tags**: [DataVersionTags](#dataversiontags): Tag dictionary. Tags can be added, removed, and updated. -## EnvironmentContainerProperties +## DataVersionProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## EnvironmentContainerTags +## DataVersionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## EnvironmentSpecificationVersion -### Properties -* **condaFile**: string: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. - -* **description**: string: The asset description text. -* **docker**: [DockerSpecification](#dockerspecification): Configuration settings for Docker -* **environmentSpecificationType**: 'Curated' | 'UserCreated' | string (ReadOnly): Environment specification is either user created or curated by Azure ML service -* **inferenceContainerProperties**: [InferenceContainerProperties](#inferencecontainerproperties) -* **isAnonymous**: bool: If the name version are system generated (anonymous registration). -* **properties**: [EnvironmentSpecificationVersionProperties](#environmentspecificationversionproperties): The asset property dictionary. -* **tags**: [EnvironmentSpecificationVersionTags](#environmentspecificationversiontags): Tag dictionary. Tags can be added, removed, and updated. - -## DockerSpecification -* **Discriminator**: dockerSpecificationType +## DistributionConfiguration +* **Discriminator**: distributionType ### Base Properties -* **platform**: [DockerImagePlatform](#dockerimageplatform) -### DockerBuild +### Mpi #### Properties -* **context**: string: Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified. -The path is relative to the asset path which must contain a single Blob URI value. - -* **dockerfile**: string (Required): [Required] Docker command line instructions to assemble an image. +* **distributionType**: 'Mpi' (Required): [Required] Specifies the type of distribution framework. +* **processCountPerInstance**: int: Number of processes per MPI node. + +### PyTorch +#### Properties +* **distributionType**: 'PyTorch' (Required): [Required] Specifies the type of distribution framework. +* **processCount**: int: Total process count for the distributed job. + +### TensorFlow +#### Properties +* **distributionType**: 'TensorFlow' (Required): [Required] Specifies the type of distribution framework. +* **parameterServerCount**: int: Number of parameter server tasks. +* **workerCount**: int: Number of workers. Overwrites the node count in compute binding. + + +## DockerImagePlatform +### Properties +* **operatingSystemType**: 'Linux' | 'Windows' | string: The type of operating system. + +## DockerSpecification +* **Discriminator**: dockerSpecificationType + +### Base Properties +* **platform**: [DockerImagePlatform](#dockerimageplatform) +### DockerBuild +#### Properties +* **context**: string: Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified. +The path is relative to the asset path which must contain a single Blob URI value. + +* **dockerfile**: string (Required): [Required] Docker command line instructions to assemble an image. * **dockerSpecificationType**: 'Build' (Required): [Required] Docker specification must be either Build or Image @@ -1130,20 +912,76 @@ The path is relative to the asset path which must contain a single Blob URI valu * **dockerSpecificationType**: 'Image' (Required): [Required] Docker specification must be either Build or Image -## DockerImagePlatform +## EarlyTerminationPolicy +* **Discriminator**: policyType + +### Base Properties +* **delayEvaluation**: int: Number of intervals by which to delay the first evaluation. +* **evaluationInterval**: int: Interval (number of runs) between policy evaluations. +### BanditPolicy +#### Properties +* **policyType**: 'Bandit' (Required): [Required] Name of policy configuration +* **slackAmount**: int: Absolute distance allowed from the best performing run. +* **slackFactor**: int: Ratio of the allowed distance from the best performing run. + +### MedianStoppingPolicy +#### Properties +* **policyType**: 'MedianStopping' (Required): [Required] Name of policy configuration + +### TruncationSelectionPolicy +#### Properties +* **policyType**: 'TruncationSelection' (Required): [Required] Name of policy configuration +* **truncationPercentage**: int: The percentage of runs to cancel at each evaluation interval. + + +## EncryptionProperty ### Properties -* **operatingSystemType**: 'Linux' | 'Windows' | string: The type of operating system. +* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -## InferenceContainerProperties +## EndpointAuthKeys ### Properties -* **livenessRoute**: [Route](#route) -* **readinessRoute**: [Route](#route) -* **scoringRoute**: [Route](#route) +* **primaryKey**: string: The primary key. +* **secondaryKey**: string: The secondary key. -## Route +## EndpointAuthKeys ### Properties -* **path**: string (Required): [Required] The path for the route. -* **port**: int (Required): [Required] The port for the route. +* **primaryKey**: string: The primary key. +* **secondaryKey**: string: The secondary key. + +## EndpointAuthKeys +### Properties +* **primaryKey**: string: The primary key. +* **secondaryKey**: string: The secondary key. + +## EnvironmentContainer +### Properties +* **description**: string: The asset description text. +* **properties**: [EnvironmentContainerProperties](#environmentcontainerproperties): The asset property dictionary. +* **tags**: [EnvironmentContainerTags](#environmentcontainertags): Tag dictionary. Tags can be added, removed, and updated. + +## EnvironmentContainerProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EnvironmentContainerTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EnvironmentSpecificationVersion +### Properties +* **condaFile**: string: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. + +* **description**: string: The asset description text. +* **docker**: [DockerSpecification](#dockerspecification): Configuration settings for Docker +* **environmentSpecificationType**: 'Curated' | 'UserCreated' | string (ReadOnly): Environment specification is either user created or curated by Azure ML service +* **inferenceContainerProperties**: [InferenceContainerProperties](#inferencecontainerproperties) +* **isAnonymous**: bool: If the name version are system generated (anonymous registration). +* **properties**: [EnvironmentSpecificationVersionProperties](#environmentspecificationversionproperties): The asset property dictionary. +* **tags**: [EnvironmentSpecificationVersionTags](#environmentspecificationversiontags): Tag dictionary. Tags can be added, removed, and updated. ## EnvironmentSpecificationVersionProperties ### Properties @@ -1155,6 +993,77 @@ The path is relative to the asset path which must contain a single Blob URI valu ### Additional Properties * **Additional Properties Type**: string +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. + +## ErrorResponse +### Properties +* **error**: [ErrorDetail](#errordetail): The error detail. + +## FlavorData +### Properties +* **data**: [FlavorData](#flavordata): Model flavor-specific data. + +## FlavorData +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## HDInsightProperties +### Properties +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. + +## IdentityConfiguration +* **Discriminator**: identityType + +### Base Properties +### AmlToken +#### Properties +* **identityType**: 'AMLToken' (Required): [Required] Specifies the type of identity framework. + +### ManagedIdentity +#### Properties +* **clientId**: string: Specifies a user-assigned identity by client ID. For system-assigned, do not set this field. +* **identityType**: 'Managed' (Required): [Required] Specifies the type of identity framework. +* **objectId**: string: Specifies a user-assigned identity by object ID. For system-assigned, do not set this field. +* **resourceId**: string: Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field. + + +## IdentityForCmk +### Properties +* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault + +## InferenceContainerProperties +### Properties +* **livenessRoute**: [Route](#route) +* **readinessRoute**: [Route](#route) +* **scoringRoute**: [Route](#route) + +## InputDataBinding +### Properties +* **dataId**: string: ARM resource ID of the registered dataVersion. +* **mode**: 'Direct' | 'Download' | 'EvalDownload' | 'EvalMount' | 'Mount' | 'ReadOnlyMount' | 'ReadWriteMount' | 'Upload' | string: Describes how the data should be attached to the container. +* **pathOnCompute**: string: Location of data inside the container process. + ## JobBase * **Discriminator**: jobType @@ -1210,6 +1119,16 @@ Private preview feature and only available to users on the allow list. ### Additional Properties * **Additional Properties Type**: [JobEndpoint](#jobendpoint) +## JobBaseProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## JobBaseTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## JobEndpoint ### Properties * **endpoint**: string: Url for endpoint. @@ -1222,149 +1141,43 @@ Private preview feature and only available to users on the allow list. ### Additional Properties * **Additional Properties Type**: string -## JobBaseProperties +## JobOutput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **datastoreId**: string (ReadOnly): ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account. +* **path**: string (ReadOnly): Path within the datastore to the job logs and artifacts. -## JobBaseTags +## KeyVaultProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DistributionConfiguration -* **Discriminator**: distributionType - -### Base Properties -### Mpi -#### Properties -* **distributionType**: 'Mpi' (Required): [Required] Specifies the type of distribution framework. -* **processCountPerInstance**: int: Number of processes per MPI node. - -### PyTorch -#### Properties -* **distributionType**: 'PyTorch' (Required): [Required] Specifies the type of distribution framework. -* **processCount**: int: Total process count for the distributed job. - -### TensorFlow -#### Properties -* **distributionType**: 'TensorFlow' (Required): [Required] Specifies the type of distribution framework. -* **parameterServerCount**: int: Number of parameter server tasks. -* **workerCount**: int: Number of workers. Overwrites the node count in compute binding. +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. +## LabelCategory +### Properties +* **allowMultiSelect**: bool: Indicates whether it is allowed to select multiple classes in this category. +* **classes**: [LabelCategoryClasses](#labelcategoryclasses): Dictionary of label classes in this category. +* **displayName**: string: Display name of the label category. -## CommandJobEnvironmentVariables +## LabelCategoryClasses ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## IdentityConfiguration -* **Discriminator**: identityType - -### Base Properties -### AmlToken -#### Properties -* **identityType**: 'AMLToken' (Required): [Required] Specifies the type of identity framework. - -### ManagedIdentity -#### Properties -* **clientId**: string: Specifies a user-assigned identity by client ID. For system-assigned, do not set this field. -* **identityType**: 'Managed' (Required): [Required] Specifies the type of identity framework. -* **objectId**: string: Specifies a user-assigned identity by object ID. For system-assigned, do not set this field. -* **resourceId**: string: Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field. +* **Additional Properties Type**: [LabelClass](#labelclass) +## LabelClass +### Properties +* **displayName**: string: Display name of the label class. +* **subclasses**: [LabelClassSubclasses](#labelclasssubclasses): Dictionary of subclasses of the label class. -## CommandJobInputDataBindings +## LabelClassSubclasses ### Properties ### Additional Properties -* **Additional Properties Type**: [InputDataBinding](#inputdatabinding) +* **Additional Properties Type**: [LabelClass](#labelclass) -## InputDataBinding +## LabelingDatasetConfiguration ### Properties -* **dataId**: string: ARM resource ID of the registered dataVersion. -* **mode**: 'Direct' | 'Download' | 'EvalDownload' | 'EvalMount' | 'Mount' | 'ReadOnlyMount' | 'ReadWriteMount' | 'Upload' | string: Describes how the data should be attached to the container. -* **pathOnCompute**: string: Location of data inside the container process. - -## JobOutput -### Properties -* **datastoreId**: string (ReadOnly): ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container ("azureml") in the workspace's storage account. -* **path**: string (ReadOnly): Path within the datastore to the job logs and artifacts. - -## CommandJobOutputDataBindings -### Properties -### Additional Properties -* **Additional Properties Type**: [OutputDataBinding](#outputdatabinding) - -## OutputDataBinding -### Properties -* **datastoreId**: string: ARM resource ID of the datastore where the data output will be stored. -* **mode**: 'Direct' | 'Download' | 'EvalDownload' | 'EvalMount' | 'Mount' | 'ReadOnlyMount' | 'ReadWriteMount' | 'Upload' | string: Describes how the data should be attached to the container. -* **pathOnCompute**: string: Location of data inside the container process. -* **pathOnDatastore**: string: Path within the datastore to the data. - -## CommandJobParameters -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## EarlyTerminationPolicy -* **Discriminator**: policyType - -### Base Properties -* **delayEvaluation**: int: Number of intervals by which to delay the first evaluation. -* **evaluationInterval**: int: Interval (number of runs) between policy evaluations. -### BanditPolicy -#### Properties -* **policyType**: 'Bandit' (Required): [Required] Name of policy configuration -* **slackAmount**: int: Absolute distance allowed from the best performing run. -* **slackFactor**: int: Ratio of the allowed distance from the best performing run. - -### MedianStoppingPolicy -#### Properties -* **policyType**: 'MedianStopping' (Required): [Required] Name of policy configuration - -### TruncationSelectionPolicy -#### Properties -* **policyType**: 'TruncationSelection' (Required): [Required] Name of policy configuration -* **truncationPercentage**: int: The percentage of runs to cancel at each evaluation interval. - - -## Objective -### Properties -* **goal**: 'Maximize' | 'Minimize' | string (Required): Defines supported metric goals for hyperparameter tuning -* **primaryMetric**: string (Required): [Required] Name of the metric to optimize. - -## SweepJobSearchSpace -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## TrialComponent -### Properties -* **codeId**: string: ARM resource ID of the code asset. -* **command**: string (Required): [Required] The command to execute on startup of the job. eg. "python train.py" -* **distribution**: [DistributionConfiguration](#distributionconfiguration): Base definition for job distribution configuration. -* **environmentId**: string: The ARM resource ID of the Environment specification for the job. -* **environmentVariables**: [TrialComponentEnvironmentVariables](#trialcomponentenvironmentvariables): Environment variables included in the job. -* **inputDataBindings**: [TrialComponentInputDataBindings](#trialcomponentinputdatabindings): Mapping of input data bindings used in the job. -* **outputDataBindings**: [TrialComponentOutputDataBindings](#trialcomponentoutputdatabindings): Mapping of output data bindings used in the job. -* **timeout**: string: The max run duration in ISO 8601 format, after which the trial component will be cancelled. -Only supports duration with precision as low as Seconds. - -## TrialComponentEnvironmentVariables -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TrialComponentInputDataBindings -### Properties -### Additional Properties -* **Additional Properties Type**: [InputDataBinding](#inputdatabinding) - -## TrialComponentOutputDataBindings -### Properties -### Additional Properties -* **Additional Properties Type**: [OutputDataBinding](#outputdatabinding) +* **assetName**: string: Name of the data asset to perform labeling. +* **datasetVersion**: string: AML dataset version. +* **incrementalDatasetRefreshEnabled**: bool: Indicates whether to enable incremental dataset refresh. ## LabelingJob ### Properties @@ -1386,47 +1199,20 @@ For local jobs, a job endpoint will have an endpoint value of FileStreamObject. * **statusMessages**: [StatusMessage](#statusmessage)[] (ReadOnly): Status messages of the job. * **tags**: [LabelingJobTags](#labelingjobtags): Tag dictionary. Tags can be added, removed, and updated. -## LabelingDatasetConfiguration +## LabelingJobInstructions ### Properties -* **assetName**: string: Name of the data asset to perform labeling. -* **datasetVersion**: string: AML dataset version. -* **incrementalDatasetRefreshEnabled**: bool: Indicates whether to enable incremental dataset refresh. +* **uri**: string: The link to a page with detailed labeling instructions for labelers. ## LabelingJobInteractionEndpoints ### Properties ### Additional Properties * **Additional Properties Type**: [JobEndpoint](#jobendpoint) -## LabelingJobInstructions -### Properties -* **uri**: string: The link to a page with detailed labeling instructions for labelers. - ## LabelingJobLabelCategories ### Properties ### Additional Properties * **Additional Properties Type**: [LabelCategory](#labelcategory) -## LabelCategory -### Properties -* **allowMultiSelect**: bool: Indicates whether it is allowed to select multiple classes in this category. -* **classes**: [LabelCategoryClasses](#labelcategoryclasses): Dictionary of label classes in this category. -* **displayName**: string: Display name of the label category. - -## LabelCategoryClasses -### Properties -### Additional Properties -* **Additional Properties Type**: [LabelClass](#labelclass) - -## LabelClass -### Properties -* **displayName**: string: Display name of the label class. -* **subclasses**: [LabelClassSubclasses](#labelclasssubclasses): Dictionary of subclasses of the label class. - -## LabelClassSubclasses -### Properties -### Additional Properties -* **Additional Properties Type**: [LabelClass](#labelclass) - ## LabelingJobMediaProperties * **Discriminator**: mediaType @@ -1442,36 +1228,50 @@ For local jobs, a job endpoint will have an endpoint value of FileStreamObject. * **mediaType**: 'Text' (Required): [Required] Media type of the job. -## MLAssistConfiguration -### Properties -* **inferencingComputeBinding**: [ComputeConfiguration](#computeconfiguration): Configuration for compute binding. -* **mlAssistEnabled**: bool: Indicates whether MLAssist feature is enabled. -* **trainingComputeBinding**: [ComputeConfiguration](#computeconfiguration): Configuration for compute binding. - -## ProgressMetrics -### Properties -* **completedDatapointCount**: int (ReadOnly): The completed datapoint count. -* **incrementalDatasetLastRefreshTime**: string (ReadOnly): The time of last successful incremental dataset refresh in UTC. -* **skippedDatapointCount**: int (ReadOnly): The skipped datapoint count. -* **totalDatapointCount**: int (ReadOnly): The total datapoint count. - ## LabelingJobProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StatusMessage -### Properties -* **code**: string (ReadOnly): Service-defined message code. -* **createdTimeUtc**: string (ReadOnly): Time in UTC at which the message was created. -* **level**: 'Error' | 'Information' | 'Warning' | string (ReadOnly) -* **message**: string (ReadOnly): A human-readable representation of the message code. - ## LabelingJobTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## LinkedInfo +### Properties +* **linkedId**: string: Linked service ID. +* **linkedResourceName**: string: Linked service resource name. +* **origin**: 'Synapse' | string: Enum to determine the type of linked service. + +## ListNotebookKeysResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## ListNotebookKeysResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## ListStorageAccountKeysResult +### Properties +* **userStorageKey**: string (ReadOnly) + +## ListWorkspaceKeysResult +### Properties +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) + +## MLAssistConfiguration +### Properties +* **inferencingComputeBinding**: [ComputeConfiguration](#computeconfiguration): Configuration for compute binding. +* **mlAssistEnabled**: bool: Indicates whether MLAssist feature is enabled. +* **trainingComputeBinding**: [ComputeConfiguration](#computeconfiguration): Configuration for compute binding. + ## ModelContainer ### Properties * **description**: string: The asset description text. @@ -1503,15 +1303,6 @@ For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ### Additional Properties * **Additional Properties Type**: [FlavorData](#flavordata) -## FlavorData -### Properties -* **data**: [FlavorData](#flavordata): Model flavor-specific data. - -## FlavorData -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ModelVersionProperties ### Properties ### Additional Properties @@ -1522,33 +1313,45 @@ For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ### Additional Properties * **Additional Properties Type**: string -## OnlineEndpoint +## NodeStateCounts ### Properties -* **authMode**: 'AADToken' | 'AMLToken' | 'Key' | string (Required): Enum to determine endpoint authentication mode. -* **description**: string: Description of the inference endpoint. -* **keys**: [EndpointAuthKeys](#endpointauthkeys) (WriteOnly): Keys for endpoint authentication. -* **properties**: [OnlineEndpointProperties](#onlineendpointproperties): Property dictionary. Properties can be added, but not removed or altered. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of endpoint provisioning. -* **scoringUri**: string (ReadOnly): Endpoint URI. -* **swaggerUri**: string (ReadOnly): Endpoint Swagger URI. -* **target**: string: ARM resource ID of the compute if it exists. -optional -* **traffic**: [OnlineEndpointTraffic](#onlineendpointtraffic): Traffic rules on how the traffic will be routed across deployments. +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## OnlineEndpointProperties +## NoneDatastoreSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. -## OnlineEndpointTraffic +## NotebookAccessTokenResult ### Properties -### Additional Properties -* **Additional Properties Type**: int +* **accessToken**: string (ReadOnly) +* **expiresIn**: int (ReadOnly) +* **hostName**: string (ReadOnly) +* **notebookResourceId**: string (ReadOnly) +* **publicDns**: string (ReadOnly) +* **refreshToken**: string (ReadOnly) +* **scope**: string (ReadOnly) +* **tokenType**: string (ReadOnly) -## TrackedResourceTags +## NotebookPreparationError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errorMessage**: string +* **statusCode**: int + +## NotebookResourceInfo +### Properties +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component + +## Objective +### Properties +* **goal**: 'Maximize' | 'Minimize' | string (Required): Defines supported metric goals for hyperparameter tuning +* **primaryMetric**: string (Required): [Required] Name of the metric to optimize. ## OnlineDeployment * **Discriminator**: endpointComputeType @@ -1582,29 +1385,44 @@ optional ### Additional Properties * **Additional Properties Type**: string -## ProbeSettings -### Properties -* **failureThreshold**: int: The number of failures to allow before returning an unhealthy status. -* **initialDelay**: string: The delay before the first probe in ISO 8601 format. -* **period**: string: The length of time between probes in ISO 8601 format. -* **successThreshold**: int: The number of successful probes before returning a healthy status. -* **timeout**: string: The probe timeout in ISO 8601 format. - ## OnlineDeploymentProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## OnlineRequestSettings +## OnlineEndpoint ### Properties -* **maxConcurrentRequestsPerInstance**: int: The number of requests allowed to queue at once for this deployment. -* **maxQueueWait**: string: The maximum queue wait time in ISO 8601 format. Supports millisecond precision. -* **requestTimeout**: string: The request timeout in ISO 8601 format. Supports millisecond precision. - -## OnlineScaleSettings -* **Discriminator**: scaleType +* **authMode**: 'AADToken' | 'AMLToken' | 'Key' | string (Required): Enum to determine endpoint authentication mode. +* **description**: string: Description of the inference endpoint. +* **keys**: [EndpointAuthKeys](#endpointauthkeys) (WriteOnly): Keys for endpoint authentication. +* **properties**: [OnlineEndpointProperties](#onlineendpointproperties): Property dictionary. Properties can be added, but not removed or altered. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): State of endpoint provisioning. +* **scoringUri**: string (ReadOnly): Endpoint URI. +* **swaggerUri**: string (ReadOnly): Endpoint Swagger URI. +* **target**: string: ARM resource ID of the compute if it exists. +optional +* **traffic**: [OnlineEndpointTraffic](#onlineendpointtraffic): Traffic rules on how the traffic will be routed across deployments. -### Base Properties +## OnlineEndpointProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## OnlineEndpointTraffic +### Properties +### Additional Properties +* **Additional Properties Type**: int + +## OnlineRequestSettings +### Properties +* **maxConcurrentRequestsPerInstance**: int: The number of requests allowed to queue at once for this deployment. +* **maxQueueWait**: string: The maximum queue wait time in ISO 8601 format. Supports millisecond precision. +* **requestTimeout**: string: The request timeout in ISO 8601 format. Supports millisecond precision. + +## OnlineScaleSettings +* **Discriminator**: scaleType + +### Base Properties * **maxInstances**: int: Maximum number of instances for this deployment. * **minInstances**: int: Minimum number of instances for this deployment. ### AutoScaleSettings @@ -1619,20 +1437,46 @@ optional * **scaleType**: 'Manual' (Required): [Required] Type of deployment scaling algorithm -## ContainerResourceRequirements +## OutputDataBinding ### Properties -* **cpu**: int: The minimum amount of CPU cores to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **cpuLimit**: int: The maximum amount of CPU cores allowed to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **fpga**: int: The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. -* **gpu**: int: The number of GPU cores in the container. -* **memoryInGB**: int: The minimum amount of memory (in GB) to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **memoryInGBLimit**: int: The maximum amount of memory (in GB) allowed to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **datastoreId**: string: ARM resource ID of the datastore where the data output will be stored. +* **mode**: 'Direct' | 'Download' | 'EvalDownload' | 'EvalMount' | 'Mount' | 'ReadOnlyMount' | 'ReadWriteMount' | 'Upload' | string: Describes how the data should be attached to the container. +* **pathOnCompute**: string: Location of data inside the container process. +* **pathOnDatastore**: string: Path within the datastore to the data. -## TrackedResourceTags +## Password +### Properties +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## PersonalComputeInstanceSettings +### Properties +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [PrivateEndpointConnectionTags](#privateendpointconnectiontags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateEndpointConnectionTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1642,13 +1486,40 @@ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-conta ### Additional Properties * **Additional Properties Type**: string -## ListWorkspaceKeysResult +## PrivateLinkServiceConnectionState ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## ProbeSettings +### Properties +* **failureThreshold**: int: The number of failures to allow before returning an unhealthy status. +* **initialDelay**: string: The delay before the first probe in ISO 8601 format. +* **period**: string: The length of time between probes in ISO 8601 format. +* **successThreshold**: int: The number of successful probes before returning a healthy status. +* **timeout**: string: The probe timeout in ISO 8601 format. + +## ProgressMetrics +### Properties +* **completedDatapointCount**: int (ReadOnly): The completed datapoint count. +* **incrementalDatasetLastRefreshTime**: string (ReadOnly): The time of last successful incremental dataset refresh in UTC. +* **skippedDatapointCount**: int (ReadOnly): The skipped datapoint count. +* **totalDatapointCount**: int (ReadOnly): The total datapoint count. + +## Recurrence +### Properties +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'NotSpecified' | 'Second' | 'Week' | 'Year' | string: The recurrence frequency. +* **interval**: int: The interval. +* **schedule**: [RecurrenceSchedule](#recurrenceschedule): The recurrence schedule +* **startTime**: string: The start time. +* **timeZone**: string: The time zone. + +## RecurrenceSchedule +### Properties +* **hours**: int[]: The hours. +* **minutes**: int[]: The minutes. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The days of the week. ## RegistryListCredentialsResult ### Properties @@ -1656,114 +1527,243 @@ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-conta * **passwords**: [Password](#password)[] (ReadOnly): Array of Password * **username**: string (ReadOnly) -## Password +## ResourceId ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **id**: string (Required): The ID of the resource -## ListNotebookKeysResult +## ResourceIdentity ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **principalId**: string (ReadOnly): Client ID that is used when authenticating. +* **tenantId**: string (ReadOnly): AAD Tenant where this identity lives. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: Defines values for a ResourceIdentity's type. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): Dictionary of the user assigned identities, key is ARM resource ID of the UAI. -## ComputeSecrets -* **Discriminator**: computeType +## ResourceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentityMeta](#userassignedidentitymeta) -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## Route +### Properties +* **path**: string (Required): [Required] The path for the route. +* **port**: int (Required): [Required] The port for the route. -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SasDatastoreSecrets +### Properties +* **sasToken**: string: Storage container SAS token. +* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## ScaleSettings +### Properties +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +## ScriptReference +### Properties +* **scriptArguments**: string: Optional command line arguments passed to the script to run. +* **scriptData**: string: The location of scripts in the mounted volume. +* **scriptSource**: string: The storage source of the script: inline, workspace. +* **timeout**: string: Optional time period passed to timeout command. -## EndpointAuthKeys +## ScriptsToExecute ### Properties -* **primaryKey**: string: The primary key. -* **secondaryKey**: string: The secondary key. +* **creationScript**: [ScriptReference](#scriptreference): Script reference +* **startupScript**: [ScriptReference](#scriptreference): Script reference -## EndpointAuthKeys +## ServiceManagedResourcesSettings ### Properties -* **primaryKey**: string: The primary key. -* **secondaryKey**: string: The secondary key. +* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) -## AmlComputeNodesInformation +## ServicePrincipalDatastoreSecrets ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'SynapseSpark' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **clientSecret**: string: Service principal secret. +* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. -## AmlComputeNodeInformation +## SetupScripts ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts -## NotebookAccessTokenResult +## SharedPrivateLinkResource ### Properties -* **accessToken**: string (ReadOnly) -* **expiresIn**: int (ReadOnly) -* **hostName**: string (ReadOnly) -* **notebookResourceId**: string (ReadOnly) -* **publicDns**: string (ReadOnly) -* **refreshToken**: string (ReadOnly) -* **scope**: string (ReadOnly) -* **tokenType**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## ListNotebookKeysResult +## SharedPrivateLinkResourceProperty ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## DatastoreSecrets -* **Discriminator**: secretsType +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -### Base Properties -### AccountKeyDatastoreSecrets -#### Properties -* **key**: string (ReadOnly): Storage account key. -* **secretsType**: 'AccountKey' (Required): [Required] Credential type used to authentication with storage. +## SqlAdminDatastoreSecrets +### Properties +* **password**: string: SQL database password. +* **secretsType**: 'AccountKey' | 'Certificate' | 'None' | 'Sas' | 'ServicePrincipal' | 'SqlAdmin' | string (Required): Enum to determine the datastore secrets type. -### CertificateDatastoreSecrets -#### Properties -* **certificate**: string (ReadOnly): Service principal certificate. -* **secretsType**: 'Certificate' (Required): [Required] Credential type used to authentication with storage. +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **leafDomainLabel**: string: Leaf domain label of public endpoint +* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### NoneDatastoreSecrets -#### Properties -* **secretsType**: 'None' (Required): [Required] Credential type used to authentication with storage. +## StatusMessage +### Properties +* **code**: string (ReadOnly): Service-defined message code. +* **createdTimeUtc**: string (ReadOnly): Time in UTC at which the message was created. +* **level**: 'Error' | 'Information' | 'Warning' | string (ReadOnly) +* **message**: string (ReadOnly): A human-readable representation of the message code. -### SasDatastoreSecrets -#### Properties -* **sasToken**: string (ReadOnly): Storage container SAS token. -* **secretsType**: 'Sas' (Required): [Required] Credential type used to authentication with storage. +## SweepJobSearchSpace +### Properties +### Additional Properties +* **Additional Properties Type**: any -### ServicePrincipalDatastoreSecrets -#### Properties -* **clientSecret**: string (ReadOnly): Service principal secret. -* **secretsType**: 'ServicePrincipal' (Required): [Required] Credential type used to authentication with storage. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -### SqlAdminDatastoreSecrets -#### Properties -* **password**: string (ReadOnly): SQL database password. -* **secretsType**: 'SqlAdmin' (Required): [Required] Credential type used to authentication with storage. +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ListStorageAccountKeysResult +## TrackedResourceTags ### Properties -* **userStorageKey**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrialComponent +### Properties +* **codeId**: string: ARM resource ID of the code asset. +* **command**: string (Required): [Required] The command to execute on startup of the job. eg. "python train.py" +* **distribution**: [DistributionConfiguration](#distributionconfiguration): Base definition for job distribution configuration. +* **environmentId**: string: The ARM resource ID of the Environment specification for the job. +* **environmentVariables**: [TrialComponentEnvironmentVariables](#trialcomponentenvironmentvariables): Environment variables included in the job. +* **inputDataBindings**: [TrialComponentInputDataBindings](#trialcomponentinputdatabindings): Mapping of input data bindings used in the job. +* **outputDataBindings**: [TrialComponentOutputDataBindings](#trialcomponentoutputdatabindings): Mapping of output data bindings used in the job. +* **timeout**: string: The max run duration in ISO 8601 format, after which the trial component will be cancelled. +Only supports duration with precision as low as Seconds. + +## TrialComponentEnvironmentVariables +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrialComponentInputDataBindings +### Properties +### Additional Properties +* **Additional Properties Type**: [InputDataBinding](#inputdatabinding) + +## TrialComponentOutputDataBindings +### Properties +### Additional Properties +* **Additional Properties Type**: [OutputDataBinding](#outputdatabinding) + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. + +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. + +## UserAssignedIdentityMeta +### Properties +* **clientId**: string: Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. +* **principalId**: string: The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. + +## VirtualMachineImage +### Properties +* **id**: string (Required): Virtual Machine image path + +## VirtualMachineProperties +### Properties +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **isNotebookInstanceCompute**: bool: Indicates whether this compute will be used for running notebooks. +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size + +## VirtualMachineSshCredentials +### Properties +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account + +## WorkspaceConnectionProps +### Properties +* **authType**: string: Authorization type of the workspace connection. +* **category**: string: Category of the workspace connection. +* **target**: string: Target of the workspace connection. +* **value**: string: Value details of the workspace connection. +* **valueFormat**: 'JSON' | string: format for the workspace connection value + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. + +## WorkspaceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.md index bae2d03684..820ffc3520 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2021-04-01/types.md @@ -133,147 +133,100 @@ * **ApiVersion**: 2021-04-01 * **Output**: [ListStorageAccountKeysResult](#liststorageaccountkeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## IdentityForCmk -### Properties -* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection +## ACIServiceCreateRequestDataCollection ### Properties -* **id**: string (ReadOnly): Specifies the resource ID. -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): Specifies the name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data -* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): Specifies the type of the resource. +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## PrivateEndpointConnectionProperties +## ACIServiceCreateRequestEncryptionProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **keyName**: string (Required, WriteOnly): Encryption Key name +* **keyVersion**: string (Required, WriteOnly): Encryption Key Version +* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url -## PrivateEndpoint +## ACIServiceCreateRequestVnetConfiguration ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to +* **subnetName**: string (WriteOnly): The name of the virtual network subnet. +* **vnetName**: string (WriteOnly): The name of the virtual network. -## PrivateLinkServiceConnectionState +## AksNetworkingConfiguration ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## Sku +## AKSProperties ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster +* **loadBalancerSubnet**: string: Load Balancer Subnet +* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## SystemData +## AKSServiceCreateRequestAutoScaler ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. +* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. +* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. +* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. +* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. -## ResourceTags +## AKSServiceCreateRequestDataCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. +* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. -## ServiceManagedResourcesSettings +## AKSServiceCreateRequestLivenessProbeRequirements ### Properties -* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) +* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. +* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. +* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. +* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. +* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. -## CosmosDbSettings +## AmlComputeNodeInformation ### Properties -* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## SharedPrivateLinkResource +## AmlComputeNodesInformation ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'SynapseSpark' | 'VirtualMachine' | string (ReadOnly): The type of compute +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## SharedPrivateLinkResourceProperty +## AmlComputeProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## ResourceTags +## AssignedUser ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. ## Compute * **Discriminator**: computeType @@ -332,182 +285,161 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## MachineLearningServiceError +## ComputeInstanceApplication ### Properties -* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ErrorResponse +## ComputeInstanceConnectivityEndpoints ### Properties -* **code**: string (ReadOnly): Error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. -* **message**: string (ReadOnly): Error message. -* **target**: string (ReadOnly): The target of the particular error +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## ErrorDetail +## ComputeInstanceCreatedBy ### Properties -* **code**: string (Required): Error code. -* **message**: string (Required): Error message. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. -## AKSProperties +## ComputeInstanceLastOperation ### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster -* **loadBalancerSubnet**: string: Load Balancer Subnet -* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. +* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. +* **operationTime**: string: Time of the last operation. -## AksNetworkingConfiguration +## ComputeInstanceProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. +* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. +* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). +* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. +* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. +* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. +* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. +* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. +* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. +* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. +* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmSize**: string: Virtual Machine Size -## SslConfiguration +## ComputeInstanceSshSettings ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **leafDomainLabel**: string: Leaf domain label of public endpoint -* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. -## SystemService -### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. - -## AmlComputeProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +## ComputeSecrets +* **Discriminator**: computeType -## NodeStateCounts -### Properties -* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. -* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. -* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. -* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. -* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. -* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. +### Base Properties +### AksComputeSecrets +#### Properties +* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +* **computeType**: 'AKS' (Required): The type of compute +* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. +* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -## ScaleSettings -### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute +* **databricksAccessToken**: string (ReadOnly): access token for databricks account. -## ResourceId -### Properties -* **id**: string (Required): The ID of the resource +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute -## UserAccountCredentials -### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. -## VirtualMachineImage +## ContainerResourceRequirements ### Properties -* **id**: string (Required): Virtual Machine image path +* **cpu**: int (WriteOnly): The minimum amount of CPU cores to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **cpuLimit**: int (WriteOnly): The maximum amount of CPU cores allowed to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. +* **gpu**: int (WriteOnly): The number of GPU cores in the container. +* **memoryInGB**: int (WriteOnly): The minimum amount of memory (in GB) to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +* **memoryInGBLimit**: int (WriteOnly): The maximum amount of memory (in GB) allowed to be used by the container. More info: +https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -## ComputeInstanceProperties +## CosmosDbSettings ### Properties -* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. -* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. -* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). -* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. -* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. -* **errors**: [MachineLearningServiceError](#machinelearningserviceerror)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. -* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. -* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. -* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. -* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. -* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmSize**: string: Virtual Machine Size +* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database -## ComputeInstanceApplication +## CreateServiceRequestEnvironmentImageRequest ### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. +* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. +* **driverProgram**: string (WriteOnly): The name of the driver file. +* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. +* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. +* **modelIds**: string[] (WriteOnly): The list of model Ids. +* **models**: [Model](#model)[] (WriteOnly): The list of models. -## ComputeInstanceConnectivityEndpoints +## CreateServiceRequestKeys ### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. +* **primaryKey**: string (WriteOnly): The primary key. +* **secondaryKey**: string (WriteOnly): The secondary key. -## ComputeInstanceCreatedBy +## CreateServiceRequestKvTags ### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. +### Additional Properties +* **Additional Properties Type**: string -## ComputeInstanceLastOperation +## CreateServiceRequestProperties ### Properties -* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. -* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. -* **operationTime**: string: Time of the last operation. +### Additional Properties +* **Additional Properties Type**: string -## PersonalComputeInstanceSettings +## DatabricksProperties ### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. +* **databricksAccessToken**: string: Databricks access token +* **workspaceUrl**: string: Workspace Url -## AssignedUser +## DataLakeAnalyticsProperties ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +* **dataLakeStoreAccountName**: string: DataLake Store Account Name -## SetupScripts +## DatasetReference ### Properties -* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts +* **id**: string (WriteOnly): The id of the dataset reference. +* **name**: string (WriteOnly): The name of the dataset reference. -## ScriptsToExecute +## EncryptionProperty ### Properties -* **creationScript**: [ScriptReference](#scriptreference): Script reference -* **startupScript**: [ScriptReference](#scriptreference): Script reference +* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -## ScriptReference +## EnvironmentImageRequestEnvironment ### Properties -* **scriptArguments**: string: Optional command line arguments passed to the script to run. -* **scriptData**: string: The location of scripts in the mounted volume. -* **scriptSource**: string: The storage source of the script: inline, workspace. -* **timeout**: string: Optional time period passed to timeout command. +* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. +* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. +* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". +* **name**: string (WriteOnly): The name of the environment. +* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. +* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. +* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. +* **version**: string (WriteOnly): The environment version. -## ComputeInstanceSshSettings +## EnvironmentImageRequestEnvironmentReference ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +* **name**: string (WriteOnly): Name of the environment. +* **version**: string (WriteOnly): Version of the environment. -## DatabricksProperties +## ErrorDetail ### Properties -* **databricksAccessToken**: string: Databricks access token -* **workspaceUrl**: string: Workspace Url +* **code**: string (Required): Error code. +* **message**: string (Required): Error message. -## DataLakeAnalyticsProperties +## ErrorResponse ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **code**: string (ReadOnly): Error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): An array of error detail objects. +* **message**: string (ReadOnly): Error message. +* **target**: string (ReadOnly): The target of the particular error ## HDInsightProperties ### Properties @@ -515,71 +447,79 @@ * **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine * **sshPort**: int: Port open for ssh connections on the master node of the cluster. -## VirtualMachineSshCredentials +## Identity ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. -## VirtualMachineProperties +## IdentityForCmk ### Properties -* **address**: string: Public IP address of the virtual machine. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **isNotebookInstanceCompute**: bool: Indicates whether this compute will be used for running notebooks. -* **sshPort**: int: Port open for ssh connections. -* **virtualMachineSize**: string: Virtual Machine size +* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault -## ResourceTags +## ImageAsset ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (WriteOnly): The Asset Id. +* **mimeType**: string (WriteOnly): The mime type. +* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. +* **url**: string (WriteOnly): The Url of the Asset. -## WorkspaceConnectionProps +## KeyVaultProperties ### Properties -* **authType**: string: Authorization type of the workspace connection. -* **category**: string: Category of the workspace connection. -* **target**: string: Target of the workspace connection. -* **value**: string: Value details of the workspace connection. -* **valueFormat**: 'JSON' | string: format for the workspace connection value +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. -## ResourceTags +## ListNotebookKeysResult ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## CreateServiceRequestEnvironmentImageRequest +## ListNotebookKeysResult ### Properties -* **assets**: [ImageAsset](#imageasset)[] (WriteOnly): The list of assets. -* **driverProgram**: string (WriteOnly): The name of the driver file. -* **environment**: [EnvironmentImageRequestEnvironment](#environmentimagerequestenvironment) (WriteOnly): The details of the AZURE ML environment. -* **environmentReference**: [EnvironmentImageRequestEnvironmentReference](#environmentimagerequestenvironmentreference) (WriteOnly): The unique identifying details of the AZURE ML environment. -* **modelIds**: string[] (WriteOnly): The list of model Ids. -* **models**: [Model](#model)[] (WriteOnly): The list of models. +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) -## ImageAsset +## ListStorageAccountKeysResult ### Properties -* **id**: string (WriteOnly): The Asset Id. -* **mimeType**: string (WriteOnly): The mime type. -* **unpack**: bool (WriteOnly): Whether the Asset is unpacked. -* **url**: string (WriteOnly): The Url of the Asset. +* **userStorageKey**: string (ReadOnly) -## EnvironmentImageRequestEnvironment +## ListWorkspaceKeysResult ### Properties -* **docker**: [ModelEnvironmentDefinitionDocker](#modelenvironmentdefinitiondocker) (WriteOnly): The definition of a Docker container. -* **environmentVariables**: [ModelEnvironmentDefinitionEnvironmentVariables](#modelenvironmentdefinitionenvironmentvariables) (WriteOnly): Definition of environment variables to be defined in the environment. -* **inferencingStackVersion**: string (WriteOnly): The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: "latest". -* **name**: string (WriteOnly): The name of the environment. -* **python**: [ModelEnvironmentDefinitionPython](#modelenvironmentdefinitionpython) (WriteOnly): Settings for a Python environment. -* **r**: [ModelEnvironmentDefinitionR](#modelenvironmentdefinitionr) (WriteOnly): Settings for a R environment. -* **spark**: [ModelEnvironmentDefinitionSpark](#modelenvironmentdefinitionspark) (WriteOnly): The configuration for a Spark environment. -* **version**: string (WriteOnly): The environment version. +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) -## ModelEnvironmentDefinitionDocker +## MachineLearningServiceError ### Properties -* **baseDockerfile**: string (WriteOnly): Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage. -* **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. -* **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. +* **error**: [ErrorResponse](#errorresponse) (ReadOnly): Error response information. + +## Model +### Properties +* **createdTime**: string (WriteOnly): The Model creation time (UTC). +* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. +* **derivedModelIds**: string[] (WriteOnly): Models derived from this model +* **description**: string (WriteOnly): The Model description text. +* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. +* **framework**: string (WriteOnly): The Model framework. +* **frameworkVersion**: string (WriteOnly): The Model framework version. +* **id**: string (WriteOnly): The Model Id. +* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. +* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml +* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). +* **name**: string (Required, WriteOnly): The Model name. +* **parentModelId**: string (WriteOnly): The Parent Model Id. +* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. +* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). +* **runId**: string (WriteOnly): The RunId that created this model. +* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} +* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. +* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. +* **version**: int (WriteOnly): The Model version assigned by Model Management Service. ## ModelDockerSectionBaseImageRegistry ### Properties @@ -587,6 +527,12 @@ * **password**: string (WriteOnly) * **username**: string (WriteOnly) +## ModelEnvironmentDefinitionDocker +### Properties +* **baseDockerfile**: string (WriteOnly): Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage. +* **baseImage**: string (WriteOnly): Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile. +* **baseImageRegistry**: [ModelDockerSectionBaseImageRegistry](#modeldockersectionbaseimageregistry) (WriteOnly): Image registry that contains the base image. + ## ModelEnvironmentDefinitionEnvironmentVariables ### Properties ### Additional Properties @@ -611,96 +557,122 @@ The path specified gets used to call the user script. * **snapshotDate**: string (WriteOnly): Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. "2019-04-17" * **userManaged**: bool (WriteOnly): Indicates whether the environment is managed by user or by AzureML. -## RCranPackage -### Properties -* **name**: string (WriteOnly): The package name. -* **repository**: string (WriteOnly): The repository name. - -## RGitHubPackage -### Properties -* **authToken**: string (WriteOnly): Personal access token to install from a private repo -* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. - ## ModelEnvironmentDefinitionSpark ### Properties * **packages**: [SparkMavenPackage](#sparkmavenpackage)[] (WriteOnly): The Spark packages to use. * **precachePackages**: bool (WriteOnly): Whether to precache the packages. * **repositories**: string[] (WriteOnly): The list of spark repositories. -## SparkMavenPackage +## ModelKvTags ### Properties -* **artifact**: string (WriteOnly) -* **group**: string (WriteOnly) -* **version**: string (WriteOnly) +### Additional Properties +* **Additional Properties Type**: string -## EnvironmentImageRequestEnvironmentReference +## ModelProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## NodeStateCounts +### Properties +* **idleNodeCount**: int (ReadOnly): Number of compute nodes in idle state. +* **leavingNodeCount**: int (ReadOnly): Number of compute nodes which are leaving the amlCompute. +* **preemptedNodeCount**: int (ReadOnly): Number of compute nodes which are in preempted state. +* **preparingNodeCount**: int (ReadOnly): Number of compute nodes which are being prepared. +* **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. +* **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. + +## NotebookAccessTokenResult +### Properties +* **accessToken**: string (ReadOnly) +* **expiresIn**: int (ReadOnly) +* **hostName**: string (ReadOnly) +* **notebookResourceId**: string (ReadOnly) +* **publicDns**: string (ReadOnly) +* **refreshToken**: string (ReadOnly) +* **scope**: string (ReadOnly) +* **tokenType**: string (ReadOnly) + +## NotebookPreparationError +### Properties +* **errorMessage**: string +* **statusCode**: int + +## NotebookResourceInfo +### Properties +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component + +## Password +### Properties +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) + +## PersonalComputeInstanceSettings +### Properties +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Specifies the resource ID. +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): Specifies the name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data +* **tags**: [ResourceTags](#resourcetags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): Specifies the type of the resource. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## RCranPackage ### Properties -* **name**: string (WriteOnly): Name of the environment. -* **version**: string (WriteOnly): Version of the environment. +* **name**: string (WriteOnly): The package name. +* **repository**: string (WriteOnly): The repository name. -## Model +## RegistryListCredentialsResult ### Properties -* **createdTime**: string (WriteOnly): The Model creation time (UTC). -* **datasets**: [DatasetReference](#datasetreference)[] (WriteOnly): The list of datasets associated with the model. -* **derivedModelIds**: string[] (WriteOnly): Models derived from this model -* **description**: string (WriteOnly): The Model description text. -* **experimentName**: string (WriteOnly): The name of the experiment where this model was created. -* **framework**: string (WriteOnly): The Model framework. -* **frameworkVersion**: string (WriteOnly): The Model framework version. -* **id**: string (WriteOnly): The Model Id. -* **kvTags**: [ModelKvTags](#modelkvtags) (WriteOnly): The Model tag dictionary. Items are mutable. -* **mimeType**: string (Required, WriteOnly): The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml -* **modifiedTime**: string (WriteOnly): The Model last modified time (UTC). -* **name**: string (Required, WriteOnly): The Model name. -* **parentModelId**: string (WriteOnly): The Parent Model Id. -* **properties**: [ModelProperties](#modelproperties) (WriteOnly): The Model property dictionary. Properties are immutable. -* **resourceRequirements**: [ContainerResourceRequirements](#containerresourcerequirements) (WriteOnly): The resource requirements for the container (cpu and memory). -* **runId**: string (WriteOnly): The RunId that created this model. -* **sampleInputData**: string (WriteOnly): Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **sampleOutputData**: string (WriteOnly): Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId} -* **unpack**: bool (WriteOnly): Indicates whether we need to unpack the Model during docker Image creation. -* **url**: string (Required, WriteOnly): The URL of the Model. Usually a SAS URL. -* **version**: int (WriteOnly): The Model version assigned by Model Management Service. +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## DatasetReference +## ResourceId ### Properties -* **id**: string (WriteOnly): The id of the dataset reference. -* **name**: string (WriteOnly): The name of the dataset reference. +* **id**: string (Required): The ID of the resource -## ModelKvTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ModelProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ContainerResourceRequirements -### Properties -* **cpu**: int (WriteOnly): The minimum amount of CPU cores to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **cpuLimit**: int (WriteOnly): The maximum amount of CPU cores allowed to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **fpga**: int (WriteOnly): The number of FPGA PCIE devices exposed to the container. Must be multiple of 2. -* **gpu**: int (WriteOnly): The number of GPU cores in the container. -* **memoryInGB**: int (WriteOnly): The minimum amount of memory (in GB) to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ -* **memoryInGBLimit**: int (WriteOnly): The maximum amount of memory (in GB) allowed to be used by the container. More info: -https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - -## CreateServiceRequestKeys -### Properties -* **primaryKey**: string (WriteOnly): The primary key. -* **secondaryKey**: string (WriteOnly): The secondary key. - -## CreateServiceRequestKvTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CreateServiceRequestProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -710,121 +682,149 @@ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-conta ### Additional Properties * **Additional Properties Type**: string -## ACIServiceCreateRequestDataCollection +## RGitHubPackage ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **authToken**: string (WriteOnly): Personal access token to install from a private repo +* **repository**: string (WriteOnly): Repository address in the format username/repo[/subdir][@ref|#pull]. -## ACIServiceCreateRequestEncryptionProperties +## ScaleSettings ### Properties -* **keyName**: string (Required, WriteOnly): Encryption Key name -* **keyVersion**: string (Required, WriteOnly): Encryption Key Version -* **vaultBaseUrl**: string (Required, WriteOnly): vault base Url +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. -## ACIServiceCreateRequestVnetConfiguration +## ScriptReference ### Properties -* **subnetName**: string (WriteOnly): The name of the virtual network subnet. -* **vnetName**: string (WriteOnly): The name of the virtual network. +* **scriptArguments**: string: Optional command line arguments passed to the script to run. +* **scriptData**: string: The location of scripts in the mounted volume. +* **scriptSource**: string: The storage source of the script: inline, workspace. +* **timeout**: string: Optional time period passed to timeout command. -## AKSServiceCreateRequestAutoScaler +## ScriptsToExecute ### Properties -* **autoscaleEnabled**: bool (WriteOnly): Option to enable/disable auto scaling. -* **maxReplicas**: int (WriteOnly): The maximum number of replicas in the cluster. -* **minReplicas**: int (WriteOnly): The minimum number of replicas to scale down to. -* **refreshPeriodInSeconds**: int (WriteOnly): The amount of seconds to wait between auto scale updates. -* **targetUtilization**: int (WriteOnly): The target utilization percentage to use for determining whether to scale the cluster. +* **creationScript**: [ScriptReference](#scriptreference): Script reference +* **startupScript**: [ScriptReference](#scriptreference): Script reference -## AKSServiceCreateRequestDataCollection +## ServiceManagedResourcesSettings ### Properties -* **eventHubEnabled**: bool (WriteOnly): Option for enabling/disabling Event Hub. -* **storageEnabled**: bool (WriteOnly): Option for enabling/disabling storage. +* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) -## AKSServiceCreateRequestLivenessProbeRequirements +## SetupScripts ### Properties -* **failureThreshold**: int (WriteOnly): The number of failures to allow before returning an unhealthy status. -* **initialDelaySeconds**: int (WriteOnly): The delay before the first probe in seconds. -* **periodSeconds**: int (WriteOnly): The length of time between probes in seconds. -* **successThreshold**: int (WriteOnly): The number of successful probes before returning a healthy status. -* **timeoutSeconds**: int (WriteOnly): The probe timeout in seconds. +* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts -## ListWorkspaceKeysResult +## SharedPrivateLinkResource ### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## RegistryListCredentialsResult +## SharedPrivateLinkResourceProperty ### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## Password +## Sku ### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise -## ListNotebookKeysResult +## SparkMavenPackage ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **artifact**: string (WriteOnly) +* **group**: string (WriteOnly) +* **version**: string (WriteOnly) -## ComputeSecrets -* **Discriminator**: computeType +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **leafDomainLabel**: string: Leaf domain label of public endpoint +* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring -### Base Properties -### AksComputeSecrets -#### Properties -* **adminKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. -* **computeType**: 'AKS' (Required): The type of compute -* **imagePullSecretName**: string (ReadOnly): Image registry pull secret. -* **userKubeConfig**: string (ReadOnly): Content of kubeconfig file that can be used to connect to the Kubernetes cluster. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute -* **databricksAccessToken**: string (ReadOnly): access token for databricks account. +## SystemService +### Properties +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## AmlComputeNodesInformation +## UserAssignedIdentity ### Properties -* **computeType**: 'AKS' | 'AmlCompute' | 'ComputeInstance' | 'DataFactory' | 'DataLakeAnalytics' | 'Databricks' | 'HDInsight' | 'SynapseSpark' | 'VirtualMachine' | string (ReadOnly): The type of compute -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. -## AmlComputeNodeInformation +## VirtualMachineImage ### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. +* **id**: string (Required): Virtual Machine image path -## NotebookAccessTokenResult +## VirtualMachineProperties ### Properties -* **accessToken**: string (ReadOnly) -* **expiresIn**: int (ReadOnly) -* **hostName**: string (ReadOnly) -* **notebookResourceId**: string (ReadOnly) -* **publicDns**: string (ReadOnly) -* **refreshToken**: string (ReadOnly) -* **scope**: string (ReadOnly) -* **tokenType**: string (ReadOnly) +* **address**: string: Public IP address of the virtual machine. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **isNotebookInstanceCompute**: bool: Indicates whether this compute will be used for running notebooks. +* **sshPort**: int: Port open for ssh connections. +* **virtualMachineSize**: string: Virtual Machine size -## ListNotebookKeysResult +## VirtualMachineSshCredentials ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account -## ListStorageAccountKeysResult +## WorkspaceConnectionProps ### Properties -* **userStorageKey**: string (ReadOnly) +* **authType**: string: Authorization type of the workspace connection. +* **category**: string: Category of the workspace connection. +* **target**: string: Target of the workspace connection. +* **value**: string: Value details of the workspace connection. +* **valueFormat**: 'JSON' | string: format for the workspace connection value + +## WorkspaceProperties +### Properties +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.md index e0149845b5..f4761ca998 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2021-07-01/types.md @@ -81,150 +81,73 @@ * **ApiVersion**: 2021-07-01 * **Output**: [ListStorageAccountKeysResult](#liststorageaccountkeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **mlFlowTrackingUri**: string (ReadOnly): The URI associated with this workspace that machine learning flow must point at to set up tracking. -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed. -* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **storageHnsEnabled**: bool (ReadOnly): If the storage associated with the workspace has hierarchical namespace(HNS) enabled. -* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. - -## IdentityForCmk -### Properties -* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [PrivateEndpointConnectionTags](#privateendpointconnectiontags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. - -## Sku +## AksNetworkingConfiguration ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## SystemData +## AKSProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster +* **loadBalancerSubnet**: string: Load Balancer Subnet +* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## PrivateEndpointConnectionTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## ServiceManagedResourcesSettings +## AmlComputeNodesInformation ### Properties -* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## CosmosDbSettings +## AmlComputeProperties ### Properties -* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## SharedPrivateLinkResource +## AssignedUser ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. -## SharedPrivateLinkResourceProperty +## AutoPauseProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **delayInMinutes**: int +* **enabled**: bool -## WorkspaceTags +## AutoScaleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool +* **maxNodeCount**: int +* **minNodeCount**: int ## Compute * **Discriminator**: computeType @@ -288,75 +211,154 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## ErrorResponse +## ComputeInstanceApplication ### Properties -* **error**: [ErrorDetail](#errordetail): The error detail. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ErrorDetail +## ComputeInstanceConnectivityEndpoints ### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## ErrorAdditionalInfo +## ComputeInstanceCreatedBy ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. -## AKSProperties +## ComputeInstanceLastOperation ### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster -* **loadBalancerSubnet**: string: Load Balancer Subnet -* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. +* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. +* **operationTime**: string: Time of the last operation. -## AksNetworkingConfiguration +## ComputeInstanceProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. +* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. +* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). +* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. +* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. +* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. +* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. +* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. +* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. +* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. +* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmSize**: string: Virtual Machine Size -## SslConfiguration +## ComputeInstanceSshSettings ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **leafDomainLabel**: string: Leaf domain label of public endpoint -* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. -## SystemService +## ComputeResourceTags ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +### Additional Properties +* **Additional Properties Type**: string -## AmlComputeProperties -### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **computeType**: 'AKS' (Required): The type of compute + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## CosmosDbSettings +### Properties +* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database + +## DatabricksProperties +### Properties +* **databricksAccessToken**: string: Databricks access token +* **workspaceUrl**: string: Workspace Url + +## DataLakeAnalyticsProperties +### Properties +* **dataLakeStoreAccountName**: string: DataLake Store Account Name + +## EncryptionProperty +### Properties +* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. + +## ErrorResponse +### Properties +* **error**: [ErrorDetail](#errordetail): The error detail. + +## HDInsightProperties +### Properties +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. + +## IdentityForCmk +### Properties +* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault + +## KeyVaultProperties +### Properties +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. + +## ListNotebookKeysResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## ListNotebookKeysResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## ListStorageAccountKeysResult +### Properties +* **userStorageKey**: string (ReadOnly) + +## ListWorkspaceKeysResult +### Properties +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) ## NodeStateCounts ### Properties @@ -367,81 +369,91 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## NotebookAccessTokenResult ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +* **accessToken**: string (ReadOnly) +* **expiresIn**: int (ReadOnly) +* **hostName**: string (ReadOnly) +* **notebookResourceId**: string (ReadOnly) +* **publicDns**: string (ReadOnly) +* **refreshToken**: string (ReadOnly) +* **scope**: string (ReadOnly) +* **tokenType**: string (ReadOnly) -## ResourceId +## NotebookPreparationError ### Properties -* **id**: string (Required): The ID of the resource +* **errorMessage**: string +* **statusCode**: int -## UserAccountCredentials +## NotebookResourceInfo ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component -## VirtualMachineImage +## Password ### Properties -* **id**: string (Required): Virtual Machine image path +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ComputeInstanceProperties +## PersonalComputeInstanceSettings ### Properties -* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. -* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. -* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). -* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. -* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. -* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. -* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. -* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. -* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. -* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. -* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmSize**: string: Virtual Machine Size +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. -## ComputeInstanceApplication +## PrivateEndpoint ### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to -## ComputeInstanceConnectivityEndpoints +## PrivateEndpointConnection ### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [PrivateEndpointConnectionTags](#privateendpointconnectiontags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ComputeInstanceCreatedBy +## PrivateEndpointConnectionProperties ### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## ComputeInstanceLastOperation +## PrivateEndpointConnectionTags ### Properties -* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. -* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. -* **operationTime**: string: Time of the last operation. +### Additional Properties +* **Additional Properties Type**: string -## PersonalComputeInstanceSettings +## PrivateEndpointConnectionTags ### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. +### Additional Properties +* **Additional Properties Type**: string -## AssignedUser +## PrivateLinkServiceConnectionState ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## SetupScripts +## RegistryListCredentialsResult ### Properties -* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## ScriptsToExecute +## ResourceId ### Properties -* **creationScript**: [ScriptReference](#scriptreference): Script reference -* **startupScript**: [ScriptReference](#scriptreference): Script reference +* **id**: string (Required): The ID of the resource + +## ScaleSettings +### Properties +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. ## ScriptReference ### Properties @@ -450,34 +462,44 @@ * **scriptSource**: string: The storage source of the script: inline, workspace. * **timeout**: string: Optional time period passed to timeout command. -## ComputeInstanceSshSettings +## ScriptsToExecute ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +* **creationScript**: [ScriptReference](#scriptreference): Script reference +* **startupScript**: [ScriptReference](#scriptreference): Script reference -## DatabricksProperties +## ServiceManagedResourcesSettings ### Properties -* **databricksAccessToken**: string: Databricks access token -* **workspaceUrl**: string: Workspace Url +* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) -## DataLakeAnalyticsProperties +## SetupScripts ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts -## HDInsightProperties +## SharedPrivateLinkResource ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## VirtualMachineSshCredentials +## SharedPrivateLinkResourceProperty ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise + +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **leafDomainLabel**: string: Leaf domain label of public endpoint +* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring ## SynapseSparkProperties ### Properties @@ -492,16 +514,41 @@ * **subscriptionId**: string: Azure subscription identifier. * **workspaceName**: string: Name of Azure Machine Learning workspace. -## AutoPauseProperties +## SystemData ### Properties -* **delayInMinutes**: int -* **enabled**: bool +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AutoScaleProperties +## SystemService ### Properties -* **enabled**: bool -* **maxNodeCount**: int -* **minNodeCount**: int +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. + +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. + +## VirtualMachineImage +### Properties +* **id**: string (Required): Virtual Machine image path ## VirtualMachineProperties ### Properties @@ -511,10 +558,12 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ComputeResourceTags +## VirtualMachineSshCredentials ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account ## WorkspaceConnectionProps ### Properties @@ -524,84 +573,35 @@ * **value**: string: Value details of the workspace connection. * **valueFormat**: 'JSON' | string: format for the workspace connection value -## PrivateEndpointConnectionTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult -### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) - -## Password -### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ListNotebookKeysResult -### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **computeType**: 'AKS' (Required): The type of compute - -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - - -## AmlComputeNodesInformation -### Properties -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. - -## AmlComputeNodeInformation -### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. - -## NotebookAccessTokenResult -### Properties -* **accessToken**: string (ReadOnly) -* **expiresIn**: int (ReadOnly) -* **hostName**: string (ReadOnly) -* **notebookResourceId**: string (ReadOnly) -* **publicDns**: string (ReadOnly) -* **refreshToken**: string (ReadOnly) -* **scope**: string (ReadOnly) -* **tokenType**: string (ReadOnly) - -## ListNotebookKeysResult +## WorkspaceProperties ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **mlFlowTrackingUri**: string (ReadOnly): The URI associated with this workspace that machine learning flow must point at to set up tracking. +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed. +* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **storageHnsEnabled**: bool (ReadOnly): If the storage associated with the workspace has hierarchical namespace(HNS) enabled. +* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. -## ListStorageAccountKeysResult +## WorkspaceTags ### Properties -* **userStorageKey**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.md b/generated/machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.md index b1623fad73..68bfd2858f 100644 --- a/generated/machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.md +++ b/generated/machinelearningservices/microsoft.machinelearningservices/2022-01-01-preview/types.md @@ -81,155 +81,73 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [ListStorageAccountKeysResult](#liststorageaccountkeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. - -## WorkspaceProperties -### Properties -* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. -* **allowRecoverSoftDeletedWorkspace**: 'False' | 'True' | string: Allow a soft deleted workspace to be recovered -* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created -* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created -* **description**: string: The description of this workspace. -* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services -* **encryption**: [EncryptionProperty](#encryptionproperty) -* **friendlyName**: string: The friendly name for this workspace. This name in mutable -* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service -* **imageBuildCompute**: string: The compute name for image build -* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created -* **mlFlowTrackingUri**: string (ReadOnly): The URI associated with this workspace that machine learning flow must point at to set up tracking. -* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) -* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. -* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed. -* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) -* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. -* **softDeleteEnabled**: 'False' | 'True' | string: create a workspace with soft delete capability -* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created -* **storageHnsEnabled**: bool (ReadOnly): If the storage associated with the workspace has hierarchical namespace(HNS) enabled. -* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. -* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. - -## EncryptionProperty -### Properties -* **cosmosDbResourceId**: string: The Bring-Your-Own cosmosdb account that customer brings to store data -* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) -* **searchAccountResourceId**: string: The Bring-Your-Own search account that customer brings to store index -* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. -* **storageAccountResourceId**: string: The Bring-Your-Own storage account that customer brings to store data - -## IdentityForCmk -### Properties -* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault - -## KeyVaultProperties -### Properties -* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. -* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. -* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. - -## NotebookResourceInfo -### Properties -* **fqdn**: string -* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) -* **resourceId**: string: the data plane resourceId that used to initialize notebook component - -## NotebookPreparationError -### Properties -* **errorMessage**: string -* **statusCode**: int - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **identity**: [Identity](#identity): Identity for the resource. -* **location**: string: Specifies the location of the resource. -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **sku**: [Sku](#sku): Sku of the resource -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **tags**: [PrivateEndpointConnectionTags](#privateendpointconnectiontags): Contains resource tags defined as key/value pairs. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. - -## Sku +## AksNetworkingConfiguration ### Properties -* **name**: string: Name of the sku -* **tier**: string: Tier of the sku like Basic or Enterprise +* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. +* **dockerBridgeCidr**: 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. +* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. +* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to -## SystemData +## AKSProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **agentCount**: int: Number of agents +* **agentVmSize**: string: Agent virtual machine size +* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking +* **clusterFqdn**: string: Cluster full qualified domain name +* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster +* **loadBalancerSubnet**: string: Load Balancer Subnet +* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type +* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring +* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services -## PrivateEndpointConnectionTags +## AmlComputeNodeInformation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nodeId**: string (ReadOnly): ID of the compute node. +* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. +* **port**: int (ReadOnly): SSH port number of the node. +* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. +* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. +* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. -## ServiceManagedResourcesSettings +## AmlComputeNodesInformation ### Properties -* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) +* **nextLink**: string (ReadOnly): The continuation token. +* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. -## CosmosDbSettings +## AmlComputeProperties ### Properties -* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database +* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. +* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. +* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. +* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. +* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. +* **isolatedNetwork**: bool: Network is isolated or not +* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. +* **osType**: 'Linux' | 'Windows' | string: Compute OS Type +* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. +* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. +* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. +* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute +* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority +* **vmSize**: string: Virtual Machine Size -## SharedPrivateLinkResource +## AssignedUser ### Properties -* **name**: string: Unique name of the private link. -* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. +* **objectId**: string (Required): User’s AAD Object Id. +* **tenantId**: string (Required): User’s AAD Tenant Id. -## SharedPrivateLinkResourceProperty +## AutoPauseProperties ### Properties -* **groupId**: string: The private link resource group id. -* **privateLinkResourceId**: string: The resource id that private link links to. -* **requestMessage**: string: Request message. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. +* **delayInMinutes**: int +* **enabled**: bool -## WorkspaceTags +## AutoScaleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool +* **maxNodeCount**: int +* **minNodeCount**: int ## Compute * **Discriminator**: computeType @@ -293,75 +211,157 @@ * **properties**: [VirtualMachineProperties](#virtualmachineproperties) -## ErrorResponse +## ComputeInstanceApplication ### Properties -* **error**: [ErrorDetail](#errordetail): The error detail. +* **displayName**: string: Name of the ComputeInstance application. +* **endpointUri**: string: Application' endpoint URI. -## ErrorDetail +## ComputeInstanceConnectivityEndpoints ### Properties -* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. -* **code**: string (ReadOnly): The error code. -* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. -* **message**: string (ReadOnly): The error message. -* **target**: string (ReadOnly): The error target. +* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). +* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. -## ErrorAdditionalInfo +## ComputeInstanceCreatedBy ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. +* **userName**: string (ReadOnly): Name of the user. +* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. -## AKSProperties +## ComputeInstanceLastOperation ### Properties -* **agentCount**: int: Number of agents -* **agentVmSize**: string: Agent virtual machine size -* **aksNetworkingConfiguration**: [AksNetworkingConfiguration](#aksnetworkingconfiguration): Advance configuration for AKS networking -* **clusterFqdn**: string: Cluster full qualified domain name -* **clusterPurpose**: 'DenseProd' | 'DevTest' | 'FastProd' | string: Intended usage of the cluster -* **loadBalancerSubnet**: string: Load Balancer Subnet -* **loadBalancerType**: 'InternalLoadBalancer' | 'PublicIp' | string: Load Balancer Type -* **sslConfiguration**: [SslConfiguration](#sslconfiguration): The ssl configuration for scoring -* **systemServices**: [SystemService](#systemservice)[] (ReadOnly): System services +* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. +* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. +* **operationTime**: string: Time of the last operation. -## AksNetworkingConfiguration +## ComputeInstanceProperties ### Properties -* **dnsServiceIP**: string: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. -* **dockerBridgeCidr**: 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. -* **serviceCidr**: string: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. -* **subnetId**: string: Virtual network subnet resource ID the compute nodes belong to +* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. +* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. +* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). +* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. +* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. +* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. +* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. +* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. +* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. +* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. +* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. +* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. +* **vmSize**: string: Virtual Machine Size -## SslConfiguration +## ComputeInstanceSshSettings ### Properties -* **cert**: string: Cert data -* **cname**: string: CNAME of the cert -* **key**: string: Key data -* **leafDomainLabel**: string: Leaf domain label of public endpoint -* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. -* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring +* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. +* **adminUserName**: string (ReadOnly): Describes the admin user name. +* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. +* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. -## SystemService +## ComputeResourceTags ### Properties -* **publicIpAddress**: string (ReadOnly): Public IP address -* **systemServiceType**: string (ReadOnly): The type of this system service. -* **version**: string (ReadOnly): The version for this type. +### Additional Properties +* **Additional Properties Type**: string -## AmlComputeProperties +## ComputeSecrets +* **Discriminator**: computeType + +### Base Properties +### AksComputeSecrets +#### Properties +* **computeType**: 'AKS' (Required): The type of compute + +### DatabricksComputeSecrets +#### Properties +* **computeType**: 'Databricks' (Required): The type of compute + +### VirtualMachineSecrets +#### Properties +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine +* **computeType**: 'VirtualMachine' (Required): The type of compute + + +## CosmosDbSettings ### Properties -* **allocationState**: 'Resizing' | 'Steady' | string (ReadOnly): Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. -* **allocationStateTransitionTime**: string (ReadOnly): The time at which the compute entered its current allocation state. -* **currentNodeCount**: int (ReadOnly): The number of compute nodes currently assigned to the compute. -* **enableNodePublicIp**: bool: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. -* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered by various compute nodes during node setup. -* **isolatedNetwork**: bool: Network is isolated or not -* **nodeStateCounts**: [NodeStateCounts](#nodestatecounts) (ReadOnly): Counts of various compute node states on the amlCompute. -* **osType**: 'Linux' | 'Windows' | string: Compute OS Type -* **remoteLoginPortPublicAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: 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. -* **scaleSettings**: [ScaleSettings](#scalesettings): scale settings for AML Compute -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **targetNodeCount**: int (ReadOnly): The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. -* **userAccountCredentials**: [UserAccountCredentials](#useraccountcredentials): Settings for user account that gets created on each on the nodes of a compute. -* **virtualMachineImage**: [VirtualMachineImage](#virtualmachineimage): Virtual Machine image for Windows AML Compute -* **vmPriority**: 'Dedicated' | 'LowPriority' | string: Virtual Machine priority -* **vmSize**: string: Virtual Machine Size +* **collectionsThroughput**: int: The throughput of the collections in cosmosdb database + +## DatabricksProperties +### Properties +* **databricksAccessToken**: string: Databricks access token +* **workspaceUrl**: string: Workspace Url + +## DataLakeAnalyticsProperties +### Properties +* **dataLakeStoreAccountName**: string: DataLake Store Account Name + +## EncryptionProperty +### Properties +* **cosmosDbResourceId**: string: The Bring-Your-Own cosmosdb account that customer brings to store data +* **identity**: [IdentityForCmk](#identityforcmk): Identity that will be used to access key vault for encryption at rest +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) (Required) +* **searchAccountResourceId**: string: The Bring-Your-Own search account that customer brings to store index +* **status**: 'Disabled' | 'Enabled' | string (Required): Indicates whether or not the encryption is enabled for the workspace. +* **storageAccountResourceId**: string: The Bring-Your-Own storage account that customer brings to store data + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. + +## ErrorDetail +### Properties +* **additionalInfo**: [ErrorAdditionalInfo](#erroradditionalinfo)[] (ReadOnly): The error additional info. +* **code**: string (ReadOnly): The error code. +* **details**: [ErrorDetail](#errordetail)[] (ReadOnly): The error details. +* **message**: string (ReadOnly): The error message. +* **target**: string (ReadOnly): The error target. + +## ErrorResponse +### Properties +* **error**: [ErrorDetail](#errordetail): The error detail. + +## HDInsightProperties +### Properties +* **address**: string: Public IP address of the master node of the cluster. +* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine +* **sshPort**: int: Port open for ssh connections on the master node of the cluster. + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): dictionary containing all the user assigned identities, with resourceId of the UAI as key. + +## IdentityForCmk +### Properties +* **userAssignedIdentity**: string: The ArmId of the user assigned identity that will be used to access the customer managed key vault + +## KeyVaultProperties +### Properties +* **identityClientId**: string: For future use - The client id of the identity which will be used to access key vault. +* **keyIdentifier**: string (Required): Key vault uri to access the encryption key. +* **keyVaultArmId**: string (Required): The ArmId of the keyVault where the customer owned encryption key is present. + +## ListNotebookKeysResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## ListNotebookKeysResult +### Properties +* **primaryAccessKey**: string (ReadOnly) +* **secondaryAccessKey**: string (ReadOnly) + +## ListStorageAccountKeysResult +### Properties +* **userStorageKey**: string (ReadOnly) + +## ListWorkspaceKeysResult +### Properties +* **appInsightsInstrumentationKey**: string (ReadOnly) +* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) +* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) +* **userStorageKey**: string (ReadOnly) +* **userStorageResourceId**: string (ReadOnly) ## NodeStateCounts ### Properties @@ -372,81 +372,91 @@ * **runningNodeCount**: int (ReadOnly): Number of compute nodes which are running jobs. * **unusableNodeCount**: int (ReadOnly): Number of compute nodes which are in unusable state. -## ScaleSettings +## NotebookAccessTokenResult ### Properties -* **maxNodeCount**: int (Required): Max number of nodes to use -* **minNodeCount**: int: Min number of nodes to use -* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. +* **accessToken**: string (ReadOnly) +* **expiresIn**: int (ReadOnly) +* **hostName**: string (ReadOnly) +* **notebookResourceId**: string (ReadOnly) +* **publicDns**: string (ReadOnly) +* **refreshToken**: string (ReadOnly) +* **scope**: string (ReadOnly) +* **tokenType**: string (ReadOnly) -## ResourceId +## NotebookPreparationError ### Properties -* **id**: string (Required): The ID of the resource +* **errorMessage**: string +* **statusCode**: int -## UserAccountCredentials +## NotebookResourceInfo ### Properties -* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. -* **adminUserPassword**: string: Password of the administrator user account. -* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. +* **fqdn**: string +* **notebookPreparationError**: [NotebookPreparationError](#notebookpreparationerror) +* **resourceId**: string: the data plane resourceId that used to initialize notebook component -## VirtualMachineImage +## Password ### Properties -* **id**: string (Required): Virtual Machine image path +* **name**: string (ReadOnly) +* **value**: string (ReadOnly) -## ComputeInstanceProperties +## PersonalComputeInstanceSettings ### Properties -* **applications**: [ComputeInstanceApplication](#computeinstanceapplication)[] (ReadOnly): Describes available applications and their endpoints on this ComputeInstance. -* **applicationSharingPolicy**: 'Personal' | 'Shared' | string: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. -* **computeInstanceAuthorizationType**: 'personal' | string: The Compute Instance Authorization type. Available values are personal (default). -* **connectivityEndpoints**: [ComputeInstanceConnectivityEndpoints](#computeinstanceconnectivityendpoints) (ReadOnly): Defines all connectivity endpoints and properties for an ComputeInstance. -* **createdBy**: [ComputeInstanceCreatedBy](#computeinstancecreatedby) (ReadOnly): Describes information on user who created this ComputeInstance. -* **errors**: [ErrorResponse](#errorresponse)[] (ReadOnly): Collection of errors encountered on this ComputeInstance. -* **lastOperation**: [ComputeInstanceLastOperation](#computeinstancelastoperation) (ReadOnly): The last operation on ComputeInstance. -* **personalComputeInstanceSettings**: [PersonalComputeInstanceSettings](#personalcomputeinstancesettings): Settings for a personal compute instance. -* **setupScripts**: [SetupScripts](#setupscripts): Details of customized scripts to execute for setting up the cluster. -* **sshSettings**: [ComputeInstanceSshSettings](#computeinstancesshsettings): Specifies policy and settings for SSH access. -* **state**: 'CreateFailed' | 'Creating' | 'Deleting' | 'JobRunning' | 'Restarting' | 'Running' | 'SettingUp' | 'SetupFailed' | 'Starting' | 'Stopped' | 'Stopping' | 'Unknown' | 'Unusable' | 'UserSettingUp' | 'UserSetupFailed' | string (ReadOnly): Current state of an ComputeInstance. -* **subnet**: [ResourceId](#resourceid): Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. -* **vmSize**: string: Virtual Machine Size +* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. -## ComputeInstanceApplication +## PrivateEndpoint ### Properties -* **displayName**: string: Name of the ComputeInstance application. -* **endpointUri**: string: Application' endpoint URI. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **subnetArmId**: string (ReadOnly): The ARM identifier for Subnet resource that private endpoint links to -## ComputeInstanceConnectivityEndpoints +## PrivateEndpointConnection ### Properties -* **privateIpAddress**: string (ReadOnly): Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). -* **publicIpAddress**: string (ReadOnly): Public IP Address of this ComputeInstance. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **identity**: [Identity](#identity): Identity for the resource. +* **location**: string: Specifies the location of the resource. +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **sku**: [Sku](#sku): Sku of the resource +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **tags**: [PrivateEndpointConnectionTags](#privateendpointconnectiontags): Contains resource tags defined as key/value pairs. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ComputeInstanceCreatedBy +## PrivateEndpointConnectionProperties ### Properties -* **userId**: string (ReadOnly): Uniquely identifies the user within his/her organization. -* **userName**: string (ReadOnly): Name of the user. -* **userOrgId**: string (ReadOnly): Uniquely identifies user' Azure Active Directory organization. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## ComputeInstanceLastOperation +## PrivateEndpointConnectionTags ### Properties -* **operationName**: 'Create' | 'Delete' | 'Reimage' | 'Restart' | 'Start' | 'Stop' | string: Name of the last operation. -* **operationStatus**: 'CreateFailed' | 'DeleteFailed' | 'InProgress' | 'ReimageFailed' | 'RestartFailed' | 'StartFailed' | 'StopFailed' | 'Succeeded' | string: Operation status. -* **operationTime**: string: Time of the last operation. +### Additional Properties +* **Additional Properties Type**: string -## PersonalComputeInstanceSettings +## PrivateEndpointConnectionTags ### Properties -* **assignedUser**: [AssignedUser](#assigneduser): A user that can be assigned to a compute instance. +### Additional Properties +* **Additional Properties Type**: string -## AssignedUser +## PrivateLinkServiceConnectionState ### Properties -* **objectId**: string (Required): User’s AAD Object Id. -* **tenantId**: string (Required): User’s AAD Tenant Id. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. -## SetupScripts +## RegistryListCredentialsResult ### Properties -* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts +* **location**: string (ReadOnly) +* **passwords**: [Password](#password)[] (ReadOnly): Array of Password +* **username**: string (ReadOnly) -## ScriptsToExecute +## ResourceId ### Properties -* **creationScript**: [ScriptReference](#scriptreference): Script reference -* **startupScript**: [ScriptReference](#scriptreference): Script reference +* **id**: string (Required): The ID of the resource + +## ScaleSettings +### Properties +* **maxNodeCount**: int (Required): Max number of nodes to use +* **minNodeCount**: int: Min number of nodes to use +* **nodeIdleTimeBeforeScaleDown**: string: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. ## ScriptReference ### Properties @@ -455,34 +465,44 @@ * **scriptSource**: string: The storage source of the script: inline, workspace. * **timeout**: string: Optional time period passed to timeout command. -## ComputeInstanceSshSettings +## ScriptsToExecute ### Properties -* **adminPublicKey**: string: Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. -* **adminUserName**: string (ReadOnly): Describes the admin user name. -* **sshPort**: int (ReadOnly): Describes the port for connecting through SSH. -* **sshPublicAccess**: 'Disabled' | 'Enabled' | string: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. +* **creationScript**: [ScriptReference](#scriptreference): Script reference +* **startupScript**: [ScriptReference](#scriptreference): Script reference -## DatabricksProperties +## ServiceManagedResourcesSettings ### Properties -* **databricksAccessToken**: string: Databricks access token -* **workspaceUrl**: string: Workspace Url +* **cosmosDb**: [CosmosDbSettings](#cosmosdbsettings) -## DataLakeAnalyticsProperties +## SetupScripts ### Properties -* **dataLakeStoreAccountName**: string: DataLake Store Account Name +* **scripts**: [ScriptsToExecute](#scriptstoexecute): Customized setup scripts -## HDInsightProperties +## SharedPrivateLinkResource ### Properties -* **address**: string: Public IP address of the master node of the cluster. -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials): Admin credentials for virtual machine -* **sshPort**: int: Port open for ssh connections on the master node of the cluster. +* **name**: string: Unique name of the private link. +* **properties**: [SharedPrivateLinkResourceProperty](#sharedprivatelinkresourceproperty): Properties of a shared private link resource. -## VirtualMachineSshCredentials +## SharedPrivateLinkResourceProperty ### Properties -* **password**: string: Password of admin account -* **privateKeyData**: string: Private key data -* **publicKeyData**: string: Public key data -* **username**: string: Username of admin account +* **groupId**: string: The private link resource group id. +* **privateLinkResourceId**: string: The resource id that private link links to. +* **requestMessage**: string: Request message. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string: The private endpoint connection status. + +## Sku +### Properties +* **name**: string: Name of the sku +* **tier**: string: Tier of the sku like Basic or Enterprise + +## SslConfiguration +### Properties +* **cert**: string: Cert data +* **cname**: string: CNAME of the cert +* **key**: string: Key data +* **leafDomainLabel**: string: Leaf domain label of public endpoint +* **overwriteExistingDomain**: bool: Indicates whether to overwrite existing domain label. +* **status**: 'Auto' | 'Disabled' | 'Enabled' | string: Enable or disable ssl for scoring ## SynapseSparkProperties ### Properties @@ -497,16 +517,41 @@ * **subscriptionId**: string: Azure subscription identifier. * **workspaceName**: string: Name of Azure Machine Learning workspace. -## AutoPauseProperties +## SystemData ### Properties -* **delayInMinutes**: int -* **enabled**: bool +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AutoScaleProperties +## SystemService ### Properties -* **enabled**: bool -* **maxNodeCount**: int -* **minNodeCount**: int +* **publicIpAddress**: string (ReadOnly): Public IP address +* **systemServiceType**: string (ReadOnly): The type of this system service. +* **version**: string (ReadOnly): The version for this type. + +## UserAccountCredentials +### Properties +* **adminUserName**: string (Required): Name of the administrator user account which can be used to SSH to nodes. +* **adminUserPassword**: string: Password of the administrator user account. +* **adminUserSshPublicKey**: string: SSH public key of the administrator user account. + +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The clientId(aka appId) of the user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the user assigned identity. + +## VirtualMachineImage +### Properties +* **id**: string (Required): Virtual Machine image path ## VirtualMachineProperties ### Properties @@ -516,10 +561,12 @@ * **sshPort**: int: Port open for ssh connections. * **virtualMachineSize**: string: Virtual Machine size -## ComputeResourceTags +## VirtualMachineSshCredentials ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: string: Password of admin account +* **privateKeyData**: string: Private key data +* **publicKeyData**: string: Public key data +* **username**: string: Username of admin account ## WorkspaceConnectionProps ### Properties @@ -529,84 +576,37 @@ * **value**: string: Value details of the workspace connection. * **valueFormat**: 'JSON' | string: format for the workspace connection value -## PrivateEndpointConnectionTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ListWorkspaceKeysResult -### Properties -* **appInsightsInstrumentationKey**: string (ReadOnly) -* **containerRegistryCredentials**: [RegistryListCredentialsResult](#registrylistcredentialsresult) (ReadOnly) -* **notebookAccessKeys**: [ListNotebookKeysResult](#listnotebookkeysresult) (ReadOnly) -* **userStorageKey**: string (ReadOnly) -* **userStorageResourceId**: string (ReadOnly) - -## RegistryListCredentialsResult -### Properties -* **location**: string (ReadOnly) -* **passwords**: [Password](#password)[] (ReadOnly): Array of Password -* **username**: string (ReadOnly) - -## Password -### Properties -* **name**: string (ReadOnly) -* **value**: string (ReadOnly) - -## ListNotebookKeysResult -### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) - -## ComputeSecrets -* **Discriminator**: computeType - -### Base Properties -### AksComputeSecrets -#### Properties -* **computeType**: 'AKS' (Required): The type of compute - -### DatabricksComputeSecrets -#### Properties -* **computeType**: 'Databricks' (Required): The type of compute - -### VirtualMachineSecrets -#### Properties -* **administratorAccount**: [VirtualMachineSshCredentials](#virtualmachinesshcredentials) (ReadOnly): Admin credentials for virtual machine -* **computeType**: 'VirtualMachine' (Required): The type of compute - - -## AmlComputeNodesInformation -### Properties -* **nextLink**: string (ReadOnly): The continuation token. -* **nodes**: [AmlComputeNodeInformation](#amlcomputenodeinformation)[] (ReadOnly): The collection of returned AmlCompute nodes details. - -## AmlComputeNodeInformation -### Properties -* **nodeId**: string (ReadOnly): ID of the compute node. -* **nodeState**: 'idle' | 'leaving' | 'preempted' | 'preparing' | 'running' | 'unusable' | string (ReadOnly): State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. -* **port**: int (ReadOnly): SSH port number of the node. -* **privateIpAddress**: string (ReadOnly): Private IP address of the compute node. -* **publicIpAddress**: string (ReadOnly): Public IP address of the compute node. -* **runId**: string (ReadOnly): ID of the Experiment running on the node, if any else null. - -## NotebookAccessTokenResult -### Properties -* **accessToken**: string (ReadOnly) -* **expiresIn**: int (ReadOnly) -* **hostName**: string (ReadOnly) -* **notebookResourceId**: string (ReadOnly) -* **publicDns**: string (ReadOnly) -* **refreshToken**: string (ReadOnly) -* **scope**: string (ReadOnly) -* **tokenType**: string (ReadOnly) - -## ListNotebookKeysResult +## WorkspaceProperties ### Properties -* **primaryAccessKey**: string (ReadOnly) -* **secondaryAccessKey**: string (ReadOnly) +* **allowPublicAccessWhenBehindVnet**: bool: The flag to indicate whether to allow public access when behind VNet. +* **allowRecoverSoftDeletedWorkspace**: 'False' | 'True' | string: Allow a soft deleted workspace to be recovered +* **applicationInsights**: string: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created +* **containerRegistry**: string: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created +* **description**: string: The description of this workspace. +* **discoveryUrl**: string: Url for the discovery service to identify regional endpoints for machine learning experimentation services +* **encryption**: [EncryptionProperty](#encryptionproperty) +* **friendlyName**: string: The friendly name for this workspace. This name in mutable +* **hbiWorkspace**: bool: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service +* **imageBuildCompute**: string: The compute name for image build +* **keyVault**: string: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created +* **mlFlowTrackingUri**: string (ReadOnly): The URI associated with this workspace that machine learning flow must point at to set up tracking. +* **notebookInfo**: [NotebookResourceInfo](#notebookresourceinfo) (ReadOnly) +* **primaryUserAssignedIdentity**: string: The user assigned identity resource id that represents the workspace identity. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections in the workspace. +* **privateLinkCount**: int (ReadOnly): Count of private connections in the workspace +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether requests from Public Network are allowed. +* **serviceManagedResourcesSettings**: [ServiceManagedResourcesSettings](#servicemanagedresourcessettings) +* **serviceProvisionedResourceGroup**: string (ReadOnly): The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[]: The list of shared private link resources in this workspace. +* **softDeleteEnabled**: 'False' | 'True' | string: create a workspace with soft delete capability +* **storageAccount**: string: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created +* **storageHnsEnabled**: bool (ReadOnly): If the storage associated with the workspace has hierarchical namespace(HNS) enabled. +* **tenantId**: string (ReadOnly): The tenant id associated with this workspace. +* **workspaceId**: string (ReadOnly): The immutable id associated with this workspace. -## ListStorageAccountKeysResult +## WorkspaceTags ### Properties -* **userStorageKey**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/maintenance/log.out b/generated/maintenance/log.out index c6fceb4eeb..72e163d59a 100644 --- a/generated/maintenance/log.out +++ b/generated/maintenance/log.out @@ -3,47 +3,47 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.maintenance-2021-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.maintenance/applyupdates under path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default' has no body defined. -info | autorest.bicep took 19ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.maintenance-2021-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.maintenance/applyupdates under path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.maintenance-2021-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.maintenance/applyupdates under path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default' has no body defined. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.maintenance-2020-07-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.maintenance/applyupdates under path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default' has no body defined. info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.maintenance-2020-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.maintenance/applyupdates under path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default' has no body defined. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.maintenance-2018-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.maintenance/applyupdates under path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default' has no body defined. -info | autorest.bicep took 2ms -info | Autorest completed in 14.86s. 12 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 14.54s. 12 files generated. diff --git a/generated/maintenance/microsoft.maintenance/2020-07-01-preview/types.md b/generated/maintenance/microsoft.maintenance/2020-07-01-preview/types.md index 35bda4b367..47017c1640 100644 --- a/generated/maintenance/microsoft.maintenance/2020-07-01-preview/types.md +++ b/generated/maintenance/microsoft.maintenance/2020-07-01-preview/types.md @@ -47,6 +47,11 @@ ### Additional Properties * **Additional Properties Type**: string +## MaintenanceConfigurationTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## MaintenanceWindow ### Properties * **duration**: string: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. @@ -55,8 +60,3 @@ * **startDateTime**: string: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. * **timeZone**: string: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. -## MaintenanceConfigurationTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/maintenance/microsoft.maintenance/2021-04-01-preview/types.md b/generated/maintenance/microsoft.maintenance/2021-04-01-preview/types.md index 33574184af..a4b20c7331 100644 --- a/generated/maintenance/microsoft.maintenance/2021-04-01-preview/types.md +++ b/generated/maintenance/microsoft.maintenance/2021-04-01-preview/types.md @@ -36,14 +36,25 @@ * **maintenanceConfigurationId**: string: The maintenance configuration Id * **resourceId**: string: The unique resourceId -## SystemData +## InputLinuxParameters ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **classificationsToInclude**: string[]: Classification category of patches to be patched +* **packageNameMasksToExclude**: string[]: Package names to be excluded for patching. +* **packageNameMasksToInclude**: string[]: Package names to be included for patching. + +## InputPatchConfiguration +### Properties +* **linuxParameters**: [InputLinuxParameters](#inputlinuxparameters): Input properties for patching a Linux machine. +* **rebootSetting**: 'AlwaysReboot' | 'NeverReboot' | 'RebootIfRequired' | string: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. +* **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. +* **windowsParameters**: [InputWindowsParameters](#inputwindowsparameters): Input properties for patching a Windows machine. + +## InputWindowsParameters +### Properties +* **classificationsToInclude**: string[]: Classification category of patches to be patched +* **excludeKbsRequiringReboot**: bool: Exclude patches which need reboot +* **kbNumbersToExclude**: string[]: Windows KBID to be excluded for patching. +* **kbNumbersToInclude**: string[]: Windows KBID to be included for patching. ## MaintenanceConfigurationProperties ### Properties @@ -59,24 +70,33 @@ ### Additional Properties * **Additional Properties Type**: string -## InputPatchConfiguration +## MaintenanceConfigurationTags ### Properties -* **linuxParameters**: [InputLinuxParameters](#inputlinuxparameters): Input properties for patching a Linux machine. -* **rebootSetting**: 'AlwaysReboot' | 'NeverReboot' | 'RebootIfRequired' | string: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. -* **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. -* **windowsParameters**: [InputWindowsParameters](#inputwindowsparameters): Input properties for patching a Windows machine. +### Additional Properties +* **Additional Properties Type**: string -## InputLinuxParameters +## MaintenanceWindow ### Properties -* **classificationsToInclude**: string[]: Classification category of patches to be patched -* **packageNameMasksToExclude**: string[]: Package names to be excluded for patching. -* **packageNameMasksToInclude**: string[]: Package names to be included for patching. +* **duration**: string: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. +* **expirationDateTime**: string: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. +* **recurEvery**: string: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6. +* **startDateTime**: string: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. +* **timeZone**: string: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ## SoftwareUpdateConfigurationTasks ### Properties * **postTasks**: [TaskProperties](#taskproperties)[]: List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] * **preTasks**: [TaskProperties](#taskproperties)[]: List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TaskProperties ### Properties * **parameters**: [TaskPropertiesParameters](#taskpropertiesparameters): Gets or sets the parameters of the task. @@ -88,23 +108,3 @@ ### Additional Properties * **Additional Properties Type**: string -## InputWindowsParameters -### Properties -* **classificationsToInclude**: string[]: Classification category of patches to be patched -* **excludeKbsRequiringReboot**: bool: Exclude patches which need reboot -* **kbNumbersToExclude**: string[]: Windows KBID to be excluded for patching. -* **kbNumbersToInclude**: string[]: Windows KBID to be included for patching. - -## MaintenanceWindow -### Properties -* **duration**: string: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. -* **expirationDateTime**: string: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. -* **recurEvery**: string: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6. -* **startDateTime**: string: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. -* **timeZone**: string: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. - -## MaintenanceConfigurationTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/maintenance/microsoft.maintenance/2021-05-01/types.md b/generated/maintenance/microsoft.maintenance/2021-05-01/types.md index 7dd87087e2..fa3a6514a6 100644 --- a/generated/maintenance/microsoft.maintenance/2021-05-01/types.md +++ b/generated/maintenance/microsoft.maintenance/2021-05-01/types.md @@ -36,15 +36,6 @@ * **maintenanceConfigurationId**: string: The maintenance configuration Id * **resourceId**: string: The unique resourceId -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## MaintenanceConfigurationProperties ### Properties * **extensionProperties**: [MaintenanceConfigurationPropertiesExtensionProperties](#maintenanceconfigurationpropertiesextensionproperties): Gets or sets extensionProperties of the maintenanceConfiguration @@ -58,6 +49,11 @@ ### Additional Properties * **Additional Properties Type**: string +## MaintenanceConfigurationTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## MaintenanceWindow ### Properties * **duration**: string: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. @@ -66,8 +62,12 @@ * **startDateTime**: string: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. * **timeZone**: string: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. -## MaintenanceConfigurationTags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/maintenance/microsoft.maintenance/2021-09-01-preview/types.md b/generated/maintenance/microsoft.maintenance/2021-09-01-preview/types.md index 9c18b91e1a..05829103b8 100644 --- a/generated/maintenance/microsoft.maintenance/2021-09-01-preview/types.md +++ b/generated/maintenance/microsoft.maintenance/2021-09-01-preview/types.md @@ -36,14 +36,25 @@ * **maintenanceConfigurationId**: string: The maintenance configuration Id * **resourceId**: string: The unique resourceId -## SystemData +## InputLinuxParameters ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **classificationsToInclude**: string[]: Classification category of patches to be patched +* **packageNameMasksToExclude**: string[]: Package names to be excluded for patching. +* **packageNameMasksToInclude**: string[]: Package names to be included for patching. + +## InputPatchConfiguration +### Properties +* **linuxParameters**: [InputLinuxParameters](#inputlinuxparameters): Input properties for patching a Linux machine. +* **rebootSetting**: 'Always' | 'IfRequired' | 'Never' | string: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. +* **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. +* **windowsParameters**: [InputWindowsParameters](#inputwindowsparameters): Input properties for patching a Windows machine. + +## InputWindowsParameters +### Properties +* **classificationsToInclude**: string[]: Classification category of patches to be patched +* **excludeKbsRequiringReboot**: bool: Exclude patches which need reboot +* **kbNumbersToExclude**: string[]: Windows KBID to be excluded for patching. +* **kbNumbersToInclude**: string[]: Windows KBID to be included for patching. ## MaintenanceConfigurationProperties ### Properties @@ -59,24 +70,33 @@ ### Additional Properties * **Additional Properties Type**: string -## InputPatchConfiguration +## MaintenanceConfigurationTags ### Properties -* **linuxParameters**: [InputLinuxParameters](#inputlinuxparameters): Input properties for patching a Linux machine. -* **rebootSetting**: 'Always' | 'IfRequired' | 'Never' | string: Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. -* **tasks**: [SoftwareUpdateConfigurationTasks](#softwareupdateconfigurationtasks): Task properties of the software update configuration. -* **windowsParameters**: [InputWindowsParameters](#inputwindowsparameters): Input properties for patching a Windows machine. +### Additional Properties +* **Additional Properties Type**: string -## InputLinuxParameters +## MaintenanceWindow ### Properties -* **classificationsToInclude**: string[]: Classification category of patches to be patched -* **packageNameMasksToExclude**: string[]: Package names to be excluded for patching. -* **packageNameMasksToInclude**: string[]: Package names to be included for patching. +* **duration**: string: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. +* **expirationDateTime**: string: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. +* **recurEvery**: string: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6. +* **startDateTime**: string: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. +* **timeZone**: string: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. ## SoftwareUpdateConfigurationTasks ### Properties * **postTasks**: [TaskProperties](#taskproperties)[]: List of post tasks. e.g. [{'source' :'runbook', 'taskScope': 'Resource', 'parameters': { 'arg1': 'value1'}}] * **preTasks**: [TaskProperties](#taskproperties)[]: List of pre tasks. e.g. [{'source' :'runbook', 'taskScope': 'Global', 'parameters': { 'arg1': 'value1'}}] +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TaskProperties ### Properties * **parameters**: [TaskPropertiesParameters](#taskpropertiesparameters): Gets or sets the parameters of the task. @@ -88,23 +108,3 @@ ### Additional Properties * **Additional Properties Type**: string -## InputWindowsParameters -### Properties -* **classificationsToInclude**: string[]: Classification category of patches to be patched -* **excludeKbsRequiringReboot**: bool: Exclude patches which need reboot -* **kbNumbersToExclude**: string[]: Windows KBID to be excluded for patching. -* **kbNumbersToInclude**: string[]: Windows KBID to be included for patching. - -## MaintenanceWindow -### Properties -* **duration**: string: Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00. -* **expirationDateTime**: string: Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59. -* **recurEvery**: string: Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6. -* **startDateTime**: string: Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. -* **timeZone**: string: Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time. - -## MaintenanceConfigurationTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/managednetwork/log.out b/generated/managednetwork/log.out index 28102ca190..ff20ad93cf 100644 --- a/generated/managednetwork/log.out +++ b/generated/managednetwork/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.managednetwork-2019-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedNetwork' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managednetwork/resource-manager/Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json:975:5 @@ -54,5 +54,5 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'HubAndSpokePeeringPolicyProperties' has a property 'hub' that is already declared the parent schema 'ManagedNetworkPeeringPolicyProperties' but isn't significantly different. The property has been removed from HubAndSpokePeeringPolicyProperties warning | PreCheck/PropertyRedeclarationWarning | Schema 'HubAndSpokePeeringPolicyProperties' has a property 'spokes' that is already declared the parent schema 'ManagedNetworkPeeringPolicyProperties' but isn't significantly different. The property has been removed from HubAndSpokePeeringPolicyProperties warning | PreCheck/PropertyRedeclarationWarning | Schema 'MeshPeeringPolicyProperties' has a property 'mesh' that is already declared the parent schema 'ManagedNetworkPeeringPolicyProperties' but isn't significantly different. The property has been removed from MeshPeeringPolicyProperties -info | autorest.bicep took 14ms -info | Autorest completed in 5.01s. 2 files generated. +info | autorest.bicep took 11ms +info | Autorest completed in 4.89s. 2 files generated. diff --git a/generated/managednetwork/microsoft.managednetwork/2019-06-01-preview/types.md b/generated/managednetwork/microsoft.managednetwork/2019-06-01-preview/types.md index b27f5e1b03..cd0e8484b0 100644 --- a/generated/managednetwork/microsoft.managednetwork/2019-06-01-preview/types.md +++ b/generated/managednetwork/microsoft.managednetwork/2019-06-01-preview/types.md @@ -42,13 +42,6 @@ * **properties**: [ScopeAssignmentProperties](#scopeassignmentproperties): Properties of Managed Network * **type**: 'Microsoft.ManagedNetwork/scopeAssignments' (ReadOnly, DeployTimeConstant): The resource type -## ManagedNetworkProperties -### Properties -* **connectivity**: [ConnectivityCollection](#connectivitycollection) (ReadOnly): The collection of Connectivity related groups and policies within the Managed Network -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the ManagedNetwork resource. -* **scope**: [Scope](#scope): Scope of a Managed Network - ## ConnectivityCollection ### Properties * **groups**: [ManagedNetworkGroup](#managednetworkgroup)[] (ReadOnly): The collection of connectivity related Managed Network Groups within the Managed Network @@ -72,10 +65,6 @@ * **subscriptions**: [ResourceId](#resourceid)[]: The collection of subscriptions covered by the Managed Network * **virtualNetworks**: [ResourceId](#resourceid)[]: The collection of virtual nets covered by the Managed Network -## ResourceId -### Properties -* **id**: string: Resource Id - ## ManagedNetworkPeeringPolicy ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -93,6 +82,17 @@ * **spokes**: [ResourceId](#resourceid)[]: Gets or sets the spokes group IDs * **type**: 'HubAndSpokeTopology' | 'MeshTopology' | string (Required): Gets or sets the connectivity type of a network structure policy +## ManagedNetworkProperties +### Properties +* **connectivity**: [ConnectivityCollection](#connectivitycollection) (ReadOnly): The collection of Connectivity related groups and policies within the Managed Network +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the ManagedNetwork resource. +* **scope**: [Scope](#scope): Scope of a Managed Network + +## ResourceId +### Properties +* **id**: string: Resource Id + ## Scope ### Properties * **managementGroups**: [ResourceId](#resourceid)[]: The collection of management groups covered by the Managed Network @@ -100,14 +100,14 @@ * **subscriptions**: [ResourceId](#resourceid)[]: The collection of subscriptions covered by the Managed Network * **virtualNetworks**: [ResourceId](#resourceid)[]: The collection of virtual nets covered by the Managed Network -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ScopeAssignmentProperties ### Properties * **assignedManagedNetwork**: string: The managed network ID with scope will be assigned to. * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the ManagedNetwork resource. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/managedservices/log.out b/generated/managedservices/log.out index dbf818d477..4425c9351e 100644 --- a/generated/managedservices/log.out +++ b/generated/managedservices/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.managedservices-2022-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistrationDefinitionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json:737:5 @@ -21,10 +21,10 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2022-01-01-preview/managedservices.json:1231:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.managedservices-2020-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistrationDefinitionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json:685:5 @@ -39,10 +39,10 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json:1192:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.managedservices-2019-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistrationDefinitionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json:661:5 @@ -60,7 +60,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.managedservices-2019-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistrationDefinitionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-06-01/managedservices.json:505:5 @@ -76,7 +76,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.managedservices-2019-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistrationDefinitionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2019-04-01-preview/managedservices.json:505:5 @@ -92,7 +92,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.managedservices-2018-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RegistrationDefinitionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2018-06-01-preview/managedservices.json:499:5 @@ -105,5 +105,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2018-06-01-preview/managedservices.json:811:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms -info | Autorest completed in 13.06s. 12 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 12.77s. 12 files generated. diff --git a/generated/managedservices/microsoft.managedservices/2018-06-01-preview/types.md b/generated/managedservices/microsoft.managedservices/2018-06-01-preview/types.md index 3bc3c9fc0b..6cea97eead 100644 --- a/generated/managedservices/microsoft.managedservices/2018-06-01-preview/types.md +++ b/generated/managedservices/microsoft.managedservices/2018-06-01-preview/types.md @@ -19,6 +19,20 @@ * **properties**: [RegistrationDefinitionProperties](#registrationdefinitionproperties): Properties of a registration definition. * **type**: 'Microsoft.ManagedServices/registrationDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Authorization +### Properties +* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. +* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription +* **principalIdDisplayName**: string: Display name of the principal Id. +* **roleDefinitionId**: string (Required): 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. + +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + ## RegistrationAssignmentProperties ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' (ReadOnly): Current state of the registration definition. @@ -33,13 +47,6 @@ * **properties**: [RegistrationAssignmentPropertiesRegistrationDefinitionProperties](#registrationassignmentpropertiesregistrationdefinitionproperties): Properties of registration definition inside registration assignment. * **type**: string (ReadOnly): Type of the resource (Microsoft.ManagedServices/registrationDefinitions). -## Plan -### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. - ## RegistrationAssignmentPropertiesRegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[]: Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. @@ -51,13 +58,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating': Current state of the registration definition. * **registrationDefinitionName**: string: Name of the registration definition. -## Authorization -### Properties -* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. -* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription -* **principalIdDisplayName**: string: Display name of the principal Id. -* **roleDefinitionId**: string (Required): 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. - ## RegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[] (Required): Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. diff --git a/generated/managedservices/microsoft.managedservices/2019-04-01-preview/types.md b/generated/managedservices/microsoft.managedservices/2019-04-01-preview/types.md index b127385a68..be5c48e90c 100644 --- a/generated/managedservices/microsoft.managedservices/2019-04-01-preview/types.md +++ b/generated/managedservices/microsoft.managedservices/2019-04-01-preview/types.md @@ -19,6 +19,20 @@ * **properties**: [RegistrationDefinitionProperties](#registrationdefinitionproperties): Properties of a registration definition. * **type**: 'Microsoft.ManagedServices/registrationDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Authorization +### Properties +* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. +* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription +* **principalIdDisplayName**: string: Display name of the principal Id. +* **roleDefinitionId**: string (Required): 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. + +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + ## RegistrationAssignmentProperties ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Current state of the registration definition. @@ -33,13 +47,6 @@ * **properties**: [RegistrationAssignmentPropertiesRegistrationDefinitionProperties](#registrationassignmentpropertiesregistrationdefinitionproperties): Properties of registration definition inside registration assignment. * **type**: string (ReadOnly): Type of the resource (Microsoft.ManagedServices/registrationDefinitions). -## Plan -### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. - ## RegistrationAssignmentPropertiesRegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[]: Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. @@ -51,13 +58,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string: Current state of the registration definition. * **registrationDefinitionName**: string: Name of the registration definition. -## Authorization -### Properties -* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. -* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription -* **principalIdDisplayName**: string: Display name of the principal Id. -* **roleDefinitionId**: string (Required): 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. - ## RegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[] (Required): Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. diff --git a/generated/managedservices/microsoft.managedservices/2019-06-01/types.md b/generated/managedservices/microsoft.managedservices/2019-06-01/types.md index 0a7787ad0d..e5dd7f6fdb 100644 --- a/generated/managedservices/microsoft.managedservices/2019-06-01/types.md +++ b/generated/managedservices/microsoft.managedservices/2019-06-01/types.md @@ -19,6 +19,20 @@ * **properties**: [RegistrationDefinitionProperties](#registrationdefinitionproperties): Properties of a registration definition. * **type**: 'Microsoft.ManagedServices/registrationDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Authorization +### Properties +* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. +* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription +* **principalIdDisplayName**: string: Display name of the principal Id. +* **roleDefinitionId**: string (Required): 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. + +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + ## RegistrationAssignmentProperties ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Current state of the registration definition. @@ -33,13 +47,6 @@ * **properties**: [RegistrationAssignmentPropertiesRegistrationDefinitionProperties](#registrationassignmentpropertiesregistrationdefinitionproperties): Properties of registration definition inside registration assignment. * **type**: string (ReadOnly): Type of the resource (Microsoft.ManagedServices/registrationDefinitions). -## Plan -### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. - ## RegistrationAssignmentPropertiesRegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[]: Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. @@ -51,13 +58,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string: Current state of the registration definition. * **registrationDefinitionName**: string: Name of the registration definition. -## Authorization -### Properties -* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. -* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription -* **principalIdDisplayName**: string: Display name of the principal Id. -* **roleDefinitionId**: string (Required): 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. - ## RegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[] (Required): Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. diff --git a/generated/managedservices/microsoft.managedservices/2019-09-01/types.md b/generated/managedservices/microsoft.managedservices/2019-09-01/types.md index c051c3bbe1..d99c1f5593 100644 --- a/generated/managedservices/microsoft.managedservices/2019-09-01/types.md +++ b/generated/managedservices/microsoft.managedservices/2019-09-01/types.md @@ -19,6 +19,20 @@ * **properties**: [RegistrationDefinitionProperties](#registrationdefinitionproperties): Properties of a registration definition. * **type**: 'Microsoft.ManagedServices/registrationDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Authorization +### Properties +* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. +* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription +* **principalIdDisplayName**: string: Display name of the principal Id. +* **roleDefinitionId**: string (Required): 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. + +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + ## RegistrationAssignmentProperties ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Current state of the registration definition. @@ -33,13 +47,6 @@ * **properties**: [RegistrationAssignmentPropertiesRegistrationDefinitionProperties](#registrationassignmentpropertiesregistrationdefinitionproperties): Properties of registration definition inside registration assignment. * **type**: string (ReadOnly): Type of the resource (Microsoft.ManagedServices/registrationDefinitions). -## Plan -### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. - ## RegistrationAssignmentPropertiesRegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[]: Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. @@ -51,13 +58,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string: Current state of the registration definition. * **registrationDefinitionName**: string: Name of the registration definition. -## Authorization -### Properties -* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. -* **principalId**: string (Required): Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription -* **principalIdDisplayName**: string: Display name of the principal Id. -* **roleDefinitionId**: string (Required): 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. - ## RegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[] (Required): Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. diff --git a/generated/managedservices/microsoft.managedservices/2020-02-01-preview/types.md b/generated/managedservices/microsoft.managedservices/2020-02-01-preview/types.md index 6b98363af6..1aed804ba3 100644 --- a/generated/managedservices/microsoft.managedservices/2020-02-01-preview/types.md +++ b/generated/managedservices/microsoft.managedservices/2020-02-01-preview/types.md @@ -19,6 +19,38 @@ * **properties**: [RegistrationDefinitionProperties](#registrationdefinitionproperties): The properties of a registration definition. * **type**: 'Microsoft.ManagedServices/registrationDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Authorization +### Properties +* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. +* **principalId**: string (Required): The identifier of the Azure Active Directory principal. +* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. +* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + +## EligibleApprover +### Properties +* **principalId**: string (Required): The identifier of the Azure Active Directory principal. +* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. + +## EligibleAuthorization +### Properties +* **justInTimeAccessPolicy**: [JustInTimeAccessPolicy](#justintimeaccesspolicy): Just-in-time access policy setting. +* **principalId**: string (Required): The identifier of the Azure Active Directory principal. +* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. +* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + +## JustInTimeAccessPolicy +### Properties +* **managedByTenantApprovers**: [EligibleApprover](#eligibleapprover)[]: The list of managedByTenant approvers for the eligible authorization. +* **maximumActivationDuration**: string: The maximum access duration in ISO 8601 format for just-in-time access requests. +* **multiFactorAuthProvider**: 'Azure' | 'None' | string (Required): The multi-factor authorization provider to be used for just-in-time access requests. + +## Plan +### Properties +* **name**: string (Required): Azure Marketplace plan name. +* **product**: string (Required): Azure Marketplace product code. +* **publisher**: string (Required): Azure Marketplace publisher ID. +* **version**: string (Required): Azure Marketplace plan's version. + ## RegistrationAssignmentProperties ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the registration definition. @@ -33,13 +65,6 @@ * **properties**: [RegistrationAssignmentPropertiesRegistrationDefinitionProperties](#registrationassignmentpropertiesregistrationdefinitionproperties): The properties of the registration definition associated with the registration assignment. * **type**: string (ReadOnly): The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). -## Plan -### Properties -* **name**: string (Required): Azure Marketplace plan name. -* **product**: string (Required): Azure Marketplace product code. -* **publisher**: string (Required): Azure Marketplace publisher ID. -* **version**: string (Required): Azure Marketplace plan's version. - ## RegistrationAssignmentPropertiesRegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[]: The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. @@ -52,31 +77,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string: The current provisioning state of the registration definition. * **registrationDefinitionName**: string: The name of the registration definition. -## Authorization -### Properties -* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. -* **principalId**: string (Required): The identifier of the Azure Active Directory principal. -* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. -* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. - -## EligibleAuthorization -### Properties -* **justInTimeAccessPolicy**: [JustInTimeAccessPolicy](#justintimeaccesspolicy): Just-in-time access policy setting. -* **principalId**: string (Required): The identifier of the Azure Active Directory principal. -* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. -* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. - -## JustInTimeAccessPolicy -### Properties -* **managedByTenantApprovers**: [EligibleApprover](#eligibleapprover)[]: The list of managedByTenant approvers for the eligible authorization. -* **maximumActivationDuration**: string: The maximum access duration in ISO 8601 format for just-in-time access requests. -* **multiFactorAuthProvider**: 'Azure' | 'None' | string (Required): The multi-factor authorization provider to be used for just-in-time access requests. - -## EligibleApprover -### Properties -* **principalId**: string (Required): The identifier of the Azure Active Directory principal. -* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. - ## RegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[] (Required): The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. diff --git a/generated/managedservices/microsoft.managedservices/2022-01-01-preview/types.md b/generated/managedservices/microsoft.managedservices/2022-01-01-preview/types.md index 2c65c538e4..35e73fb00d 100644 --- a/generated/managedservices/microsoft.managedservices/2022-01-01-preview/types.md +++ b/generated/managedservices/microsoft.managedservices/2022-01-01-preview/types.md @@ -21,6 +21,38 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.ManagedServices/registrationDefinitions' (ReadOnly, DeployTimeConstant): The resource type +## Authorization +### Properties +* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. +* **principalId**: string (Required): The identifier of the Azure Active Directory principal. +* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. +* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + +## EligibleApprover +### Properties +* **principalId**: string (Required): The identifier of the Azure Active Directory principal. +* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. + +## EligibleAuthorization +### Properties +* **justInTimeAccessPolicy**: [JustInTimeAccessPolicy](#justintimeaccesspolicy): Just-in-time access policy setting. +* **principalId**: string (Required): The identifier of the Azure Active Directory principal. +* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. +* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. + +## JustInTimeAccessPolicy +### Properties +* **managedByTenantApprovers**: [EligibleApprover](#eligibleapprover)[]: The list of managedByTenant approvers for the eligible authorization. +* **maximumActivationDuration**: string: The maximum access duration in ISO 8601 format for just-in-time access requests. +* **multiFactorAuthProvider**: 'Azure' | 'None' | string (Required): The multi-factor authorization provider to be used for just-in-time access requests. + +## Plan +### Properties +* **name**: string (Required): Azure Marketplace plan name. +* **product**: string (Required): Azure Marketplace product code. +* **publisher**: string (Required): Azure Marketplace publisher ID. +* **version**: string (Required): Azure Marketplace plan's version. + ## RegistrationAssignmentProperties ### Properties * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the registration definition. @@ -36,13 +68,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). -## Plan -### Properties -* **name**: string (Required): Azure Marketplace plan name. -* **product**: string (Required): Azure Marketplace product code. -* **publisher**: string (Required): Azure Marketplace publisher ID. -* **version**: string (Required): Azure Marketplace plan's version. - ## RegistrationAssignmentPropertiesRegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[]: The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. @@ -55,40 +80,6 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string: The current provisioning state of the registration definition. * **registrationDefinitionName**: string: The name of the registration definition. -## Authorization -### Properties -* **delegatedRoleDefinitionIds**: string[]: The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. -* **principalId**: string (Required): The identifier of the Azure Active Directory principal. -* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. -* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. - -## EligibleAuthorization -### Properties -* **justInTimeAccessPolicy**: [JustInTimeAccessPolicy](#justintimeaccesspolicy): Just-in-time access policy setting. -* **principalId**: string (Required): The identifier of the Azure Active Directory principal. -* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. -* **roleDefinitionId**: string (Required): The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. - -## JustInTimeAccessPolicy -### Properties -* **managedByTenantApprovers**: [EligibleApprover](#eligibleapprover)[]: The list of managedByTenant approvers for the eligible authorization. -* **maximumActivationDuration**: string: The maximum access duration in ISO 8601 format for just-in-time access requests. -* **multiFactorAuthProvider**: 'Azure' | 'None' | string (Required): The multi-factor authorization provider to be used for just-in-time access requests. - -## EligibleApprover -### Properties -* **principalId**: string (Required): The identifier of the Azure Active Directory principal. -* **principalIdDisplayName**: string: The display name of the Azure Active Directory principal. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## RegistrationDefinitionProperties ### Properties * **authorizations**: [Authorization](#authorization)[] (Required): The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. @@ -101,3 +92,12 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state of the registration definition. * **registrationDefinitionName**: string: The name of the registration definition. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/managementgroups/log.out b/generated/managementgroups/log.out index f10884def6..61b54f7137 100644 --- a/generated/managementgroups/log.out +++ b/generated/managementgroups/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.management-2021-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2021-04-01/management.json:896:5 @@ -66,10 +66,10 @@ warning | PreCheck/SchemaMissingType | The schema 'CreateParentGroupInfo' with a - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2021-04-01/management.json:1902:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.management/managementgroups/subscriptions under path '/providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}' has no body defined. -info | autorest.bicep took 12ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.management-2020-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2020-10-01/management.json:891:5 @@ -132,7 +132,7 @@ info | Resource type microsoft.management/managementgroups/subscriptions unde info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.management-2020-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2020-05-01/management.json:885:5 @@ -192,10 +192,10 @@ warning | PreCheck/SchemaMissingType | The schema 'CreateParentGroupInfo' with a - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2020-05-01/management.json:1866:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.management/managementgroups/subscriptions under path '/providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.management-2020-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2020-02-01/management.json:803:5 @@ -254,7 +254,7 @@ info | Resource type microsoft.management/managementgroups/subscriptions unde info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.management-2019-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/stable/2019-11-01/management.json:614:5 @@ -305,7 +305,7 @@ info | Resource type microsoft.management/managementgroups/subscriptions unde info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.management-2018-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json:594:5 @@ -351,10 +351,10 @@ warning | PreCheck/SchemaMissingType | The schema 'CreateParentGroupInfo' with a - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json:1383:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.management/managementgroups/subscriptions under path '/providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}' has no body defined. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.management-2018-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json:465:5 @@ -392,10 +392,10 @@ warning | PreCheck/SchemaMissingType | The schema 'CreateParentGroupInfo' with a - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json:1088:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.management/managementgroups/subscriptions under path '/providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}' has no body defined. -info | autorest.bicep took 3ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.management-2017-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/preview/2017-11-01-preview/management.json:370:5 @@ -420,7 +420,7 @@ info | Resource type microsoft.management/managementgroups/subscriptions unde info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.management-2017-08-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/managementgroups/resource-manager/Microsoft.Management/preview/2017-08-31-preview/management.json:167:5 diff --git a/generated/managementgroups/microsoft.management/2017-11-01-preview/types.md b/generated/managementgroups/microsoft.management/2017-11-01-preview/types.md index 53ac71cf76..7c928a630a 100644 --- a/generated/managementgroups/microsoft.management/2017-11-01-preview/types.md +++ b/generated/managementgroups/microsoft.management/2017-11-01-preview/types.md @@ -19,13 +19,6 @@ * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## ManagementGroupProperties -### Properties -* **children**: [ManagementGroupChildInfo](#managementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [ManagementGroupDetails](#managementgroupdetails) (ReadOnly): The details of a management group. -* **displayName**: string (ReadOnly): The friendly name of the management group. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## ManagementGroupChildInfo ### Properties * **childId**: string (ReadOnly): The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 @@ -40,6 +33,13 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## ManagementGroupProperties +### Properties +* **children**: [ManagementGroupChildInfo](#managementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [ManagementGroupDetails](#managementgroupdetails) (ReadOnly): The details of a management group. +* **displayName**: string (ReadOnly): The friendly name of the management group. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + ## ParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. diff --git a/generated/managementgroups/microsoft.management/2018-01-01-preview/types.md b/generated/managementgroups/microsoft.management/2018-01-01-preview/types.md index 0f2d9a25e9..40f35308bf 100644 --- a/generated/managementgroups/microsoft.management/2018-01-01-preview/types.md +++ b/generated/managementgroups/microsoft.management/2018-01-01-preview/types.md @@ -17,14 +17,6 @@ * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -41,6 +33,14 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## CreateManagementGroupProperties +### Properties +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + ## CreateParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. diff --git a/generated/managementgroups/microsoft.management/2018-03-01-preview/types.md b/generated/managementgroups/microsoft.management/2018-03-01-preview/types.md index cb48300c4c..f289d71da7 100644 --- a/generated/managementgroups/microsoft.management/2018-03-01-preview/types.md +++ b/generated/managementgroups/microsoft.management/2018-03-01-preview/types.md @@ -17,14 +17,6 @@ * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -41,6 +33,14 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## CreateManagementGroupProperties +### Properties +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + ## CreateParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. diff --git a/generated/managementgroups/microsoft.management/2019-11-01/types.md b/generated/managementgroups/microsoft.management/2019-11-01/types.md index 6c760d6cc7..698349de6e 100644 --- a/generated/managementgroups/microsoft.management/2019-11-01/types.md +++ b/generated/managementgroups/microsoft.management/2019-11-01/types.md @@ -17,15 +17,6 @@ * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **path**: [ManagementGroupPathElement](#managementgrouppathelement)[] (ReadOnly): The hierarchial path from the root group to the current group. -* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -42,6 +33,15 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## CreateManagementGroupProperties +### Properties +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **path**: [ManagementGroupPathElement](#managementgrouppathelement)[] (ReadOnly): The hierarchial path from the root group to the current group. +* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + ## CreateParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. diff --git a/generated/managementgroups/microsoft.management/2020-02-01/types.md b/generated/managementgroups/microsoft.management/2020-02-01/types.md index 56fd791400..dd3e0efd20 100644 --- a/generated/managementgroups/microsoft.management/2020-02-01/types.md +++ b/generated/managementgroups/microsoft.management/2020-02-01/types.md @@ -26,15 +26,6 @@ * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **path**: [ManagementGroupPathElement](#managementgrouppathelement)[] (ReadOnly): The path from the root to the current group. -* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -51,6 +42,21 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## CreateManagementGroupProperties +### Properties +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **path**: [ManagementGroupPathElement](#managementgrouppathelement)[] (ReadOnly): The path from the root to the current group. +* **roles**: string[] (ReadOnly): The roles definitions associated with the management group. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + +## CreateOrUpdateSettingsProperties +### Properties +* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup +* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 + ## CreateParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. @@ -62,9 +68,3 @@ * **displayName**: string (ReadOnly): The friendly name of the group. * **name**: string (ReadOnly): The name of the group. -## CreateOrUpdateSettingsProperties -### Properties -* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup -* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 - diff --git a/generated/managementgroups/microsoft.management/2020-05-01/types.md b/generated/managementgroups/microsoft.management/2020-05-01/types.md index d06d6d63ea..38601d145c 100644 --- a/generated/managementgroups/microsoft.management/2020-05-01/types.md +++ b/generated/managementgroups/microsoft.management/2020-05-01/types.md @@ -27,13 +27,6 @@ * **properties**: [SubscriptionUnderManagementGroupProperties](#subscriptionundermanagementgroupproperties) (ReadOnly): The generic properties of subscription under a management group. * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -50,23 +43,34 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## CreateManagementGroupProperties +### Properties +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + +## CreateOrUpdateSettingsProperties +### Properties +* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup +* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 + ## CreateParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. * **id**: string: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 * **name**: string (ReadOnly): The name of the parent management group +## DescendantParentGroupInfo +### Properties +* **id**: string (ReadOnly): The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 + ## ManagementGroupPathElement ### Properties * **displayName**: string (ReadOnly): The friendly name of the group. * **name**: string (ReadOnly): The name of the group. -## CreateOrUpdateSettingsProperties -### Properties -* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup -* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 - ## SubscriptionUnderManagementGroupProperties ### Properties * **displayName**: string (ReadOnly): The friendly name of the subscription. @@ -74,7 +78,3 @@ * **state**: string (ReadOnly): The state of the subscription. * **tenant**: string (ReadOnly): The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 -## DescendantParentGroupInfo -### Properties -* **id**: string (ReadOnly): The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 - diff --git a/generated/managementgroups/microsoft.management/2020-10-01/types.md b/generated/managementgroups/microsoft.management/2020-10-01/types.md index c8321d9815..4d6cd5d92c 100644 --- a/generated/managementgroups/microsoft.management/2020-10-01/types.md +++ b/generated/managementgroups/microsoft.management/2020-10-01/types.md @@ -27,13 +27,6 @@ * **properties**: [SubscriptionUnderManagementGroupProperties](#subscriptionundermanagementgroupproperties) (ReadOnly): The generic properties of subscription under a management group. * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -51,23 +44,34 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. +## CreateManagementGroupProperties +### Properties +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + +## CreateOrUpdateSettingsProperties +### Properties +* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup +* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 + ## CreateParentGroupInfo ### Properties * **displayName**: string (ReadOnly): The friendly name of the parent management group. * **id**: string: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 * **name**: string (ReadOnly): The name of the parent management group +## DescendantParentGroupInfo +### Properties +* **id**: string (ReadOnly): The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 + ## ManagementGroupPathElement ### Properties * **displayName**: string (ReadOnly): The friendly name of the group. * **name**: string (ReadOnly): The name of the group. -## CreateOrUpdateSettingsProperties -### Properties -* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup -* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 - ## SubscriptionUnderManagementGroupProperties ### Properties * **displayName**: string (ReadOnly): The friendly name of the subscription. @@ -75,7 +79,3 @@ * **state**: string (ReadOnly): The state of the subscription. * **tenant**: string (ReadOnly): The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 -## DescendantParentGroupInfo -### Properties -* **id**: string (ReadOnly): The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 - diff --git a/generated/managementgroups/microsoft.management/2021-04-01/types.md b/generated/managementgroups/microsoft.management/2021-04-01/types.md index 1f986f08c2..ac4267cee3 100644 --- a/generated/managementgroups/microsoft.management/2021-04-01/types.md +++ b/generated/managementgroups/microsoft.management/2021-04-01/types.md @@ -27,13 +27,6 @@ * **properties**: [SubscriptionUnderManagementGroupProperties](#subscriptionundermanagementgroupproperties) (ReadOnly): The generic properties of subscription under a management group. * **type**: 'Microsoft.Management/managementGroups/subscriptions' (ReadOnly, DeployTimeConstant): The resource type -## CreateManagementGroupProperties -### Properties -* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. -* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. -* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 - ## CreateManagementGroupChildInfo ### Properties * **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. @@ -52,10 +45,18 @@ * **updatedTime**: string (ReadOnly): The date and time when this object was last updated. * **version**: int (ReadOnly): The version number of the object. -## ManagementGroupPathElement +## CreateManagementGroupProperties ### Properties -* **displayName**: string (ReadOnly): The friendly name of the group. -* **name**: string (ReadOnly): The name of the group. +* **children**: [CreateManagementGroupChildInfo](#createmanagementgroupchildinfo)[] (ReadOnly): The list of children. +* **details**: [CreateManagementGroupDetails](#createmanagementgroupdetails): The details of a management group used during creation. +* **displayName**: string: The friendly name of the management group. If no value is passed then this field will be set to the groupId. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 + +## CreateOrUpdateSettingsProperties +### Properties +* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup +* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. +* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 ## CreateParentGroupInfo ### Properties @@ -63,11 +64,14 @@ * **id**: string: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 * **name**: string (ReadOnly): The name of the parent management group -## CreateOrUpdateSettingsProperties +## DescendantParentGroupInfo ### Properties -* **defaultManagementGroup**: string: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup -* **requireAuthorizationForGroupCreation**: bool: Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. -* **tenantId**: string (ReadOnly): The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 +* **id**: string (ReadOnly): The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 + +## ManagementGroupPathElement +### Properties +* **displayName**: string (ReadOnly): The friendly name of the group. +* **name**: string (ReadOnly): The name of the group. ## SubscriptionUnderManagementGroupProperties ### Properties @@ -76,7 +80,3 @@ * **state**: string (ReadOnly): The state of the subscription. * **tenant**: string (ReadOnly): The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 -## DescendantParentGroupInfo -### Properties -* **id**: string (ReadOnly): The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 - diff --git a/generated/managementpartner/log.out b/generated/managementpartner/log.out index 2ac3c09f65..2e0c338e99 100644 --- a/generated/managementpartner/log.out +++ b/generated/managementpartner/log.out @@ -3,12 +3,12 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.managementpartner-2018-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.managementpartner/partners under path '/providers/Microsoft.ManagementPartner/partners/{partnerId}' has no body defined. -info | autorest.bicep took 11ms -info | Autorest completed in 4.27s. 2 files generated. +info | autorest.bicep took 8ms +info | Autorest completed in 4.29s. 2 files generated. diff --git a/generated/maps/log.out b/generated/maps/log.out index b9b5a30fec..a911f5816a 100644 --- a/generated/maps/log.out +++ b/generated/maps/log.out @@ -18,7 +18,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.maps-2021-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -36,7 +36,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 13ms @@ -57,7 +57,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagedServiceIdentity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/preview/2021-07-01-preview/maps-management.json:947:5 @@ -70,7 +70,7 @@ warning | PreCheck/SchemaMissingType | The schema 'MetricSpecification' with an warning | PreCheck/SchemaMissingType | The schema 'Dimension' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/preview/2021-07-01-preview/maps-management.json:1128:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.maps-2021-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -88,7 +88,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/stable/2021-02-01/maps-management.json:1038:5 @@ -99,7 +99,7 @@ warning | PreCheck/SchemaMissingType | The schema 'MetricSpecification' with an warning | PreCheck/SchemaMissingType | The schema 'Dimension' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/stable/2021-02-01/maps-management.json:1103:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.maps-2020-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -117,7 +117,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/preview/2020-02-01-preview/maps-management.json:1161:5 @@ -146,7 +146,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/maps-management.json:550:5 @@ -173,7 +173,7 @@ warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.14.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json:550:5 @@ -182,5 +182,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type a warning | PreCheck/SchemaMissingType | The schema 'MapsAccountProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json:793:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms -info | Autorest completed in 14.08s. 12 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 13.67s. 12 files generated. diff --git a/generated/maps/microsoft.maps/2017-01-01-preview/types.md b/generated/maps/microsoft.maps/2017-01-01-preview/types.md index 2345489a42..50d5dcbb8b 100644 --- a/generated/maps/microsoft.maps/2017-01-01-preview/types.md +++ b/generated/maps/microsoft.maps/2017-01-01-preview/types.md @@ -17,15 +17,6 @@ * **ApiVersion**: 2017-01-01-preview * **Output**: [MapsAccountKeys](#mapsaccountkeys) -## MapsAccountProperties -### Properties -* **x-ms-client-id**: string (ReadOnly): A unique identifier for the maps account - -## Sku -### Properties -* **name**: string (Required): The name of the SKU, in standard format (such as S0). -* **tier**: string (ReadOnly): Gets the sku tier. This is based on the SKU name. - ## MapsAccountCreateParametersTags ### Properties ### Additional Properties @@ -37,3 +28,12 @@ * **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. * **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. +## MapsAccountProperties +### Properties +* **x-ms-client-id**: string (ReadOnly): A unique identifier for the maps account + +## Sku +### Properties +* **name**: string (Required): The name of the SKU, in standard format (such as S0). +* **tier**: string (ReadOnly): Gets the sku tier. This is based on the SKU name. + diff --git a/generated/maps/microsoft.maps/2018-05-01/types.md b/generated/maps/microsoft.maps/2018-05-01/types.md index 8f6965e664..16de99efe5 100644 --- a/generated/maps/microsoft.maps/2018-05-01/types.md +++ b/generated/maps/microsoft.maps/2018-05-01/types.md @@ -17,15 +17,6 @@ * **ApiVersion**: 2018-05-01 * **Output**: [MapsAccountKeys](#mapsaccountkeys) -## MapsAccountProperties -### Properties -* **x-ms-client-id**: string (ReadOnly): A unique identifier for the maps account - -## Sku -### Properties -* **name**: string (Required): The name of the SKU, in standard format (such as S0). -* **tier**: string (ReadOnly): Gets the sku tier. This is based on the SKU name. - ## MapsAccountCreateParametersTags ### Properties ### Additional Properties @@ -37,3 +28,12 @@ * **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. * **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. +## MapsAccountProperties +### Properties +* **x-ms-client-id**: string (ReadOnly): A unique identifier for the maps account + +## Sku +### Properties +* **name**: string (Required): The name of the SKU, in standard format (such as S0). +* **tier**: string (ReadOnly): Gets the sku tier. This is based on the SKU name. + diff --git a/generated/maps/microsoft.maps/2020-02-01-preview/types.md b/generated/maps/microsoft.maps/2020-02-01-preview/types.md index c0300184b6..16d9cfc7c3 100644 --- a/generated/maps/microsoft.maps/2020-02-01-preview/types.md +++ b/generated/maps/microsoft.maps/2020-02-01-preview/types.md @@ -40,34 +40,31 @@ * **ApiVersion**: 2020-02-01-preview * **Output**: [MapsAccountKeys](#mapsaccountkeys) -## MapsAccountProperties -### Properties -* **x-ms-client-id**: string (ReadOnly): A unique identifier for the maps account - -## Sku +## CreatorCreateParametersTags ### Properties -* **name**: string (Required): The name of the SKU, in standard format (such as S0). -* **tier**: string (ReadOnly): Gets the sku tier. This is based on the SKU name. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## CreatorProperties ### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled ## MapsAccountCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CreatorProperties +## MapsAccountKeys ### Properties -* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled +* **id**: string (ReadOnly): The full Azure resource identifier of the Maps Account. +* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. +* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. -## CreatorCreateParametersTags +## MapsAccountProperties +### Properties +* **x-ms-client-id**: string (ReadOnly): A unique identifier for the maps account + +## PrivateAtlasCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -76,14 +73,17 @@ ### Properties * **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled -## PrivateAtlasCreateParametersTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of the SKU, in standard format (such as S0). +* **tier**: string (ReadOnly): Gets the sku tier. This is based on the SKU name. -## MapsAccountKeys +## SystemData ### Properties -* **id**: string (ReadOnly): The full Azure resource identifier of the Maps Account. -* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. -* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. diff --git a/generated/maps/microsoft.maps/2021-02-01/types.md b/generated/maps/microsoft.maps/2021-02-01/types.md index 87396ab50d..94fece7481 100644 --- a/generated/maps/microsoft.maps/2021-02-01/types.md +++ b/generated/maps/microsoft.maps/2021-02-01/types.md @@ -30,6 +30,18 @@ * **ApiVersion**: 2021-02-01 * **Output**: [MapsAccountKeys](#mapsaccountkeys) +## CreatorProperties +### Properties +* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled +* **storageUnits**: int (Required): The storage units to be allocated. Integer values from 1 to 100, inclusive. + +## MapsAccountKeys +### Properties +* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. +* **primaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the primary key. +* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. +* **secondaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the secondary key. + ## MapsAccountProperties ### Properties * **disableLocalAuth**: bool: Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage. @@ -55,20 +67,8 @@ ### Additional Properties * **Additional Properties Type**: string -## CreatorProperties -### Properties -* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled -* **storageUnits**: int (Required): The storage units to be allocated. Integer values from 1 to 100, inclusive. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MapsAccountKeys -### Properties -* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. -* **primaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the primary key. -* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. -* **secondaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the secondary key. - diff --git a/generated/maps/microsoft.maps/2021-07-01-preview/types.md b/generated/maps/microsoft.maps/2021-07-01-preview/types.md index 46f040dc1b..258a0b55fb 100644 --- a/generated/maps/microsoft.maps/2021-07-01-preview/types.md +++ b/generated/maps/microsoft.maps/2021-07-01-preview/types.md @@ -31,6 +31,21 @@ * **ApiVersion**: 2021-07-01-preview * **Output**: [MapsAccountKeys](#mapsaccountkeys) +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## CreatorProperties +### Properties +* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled +* **storageUnits**: int (Required): The storage units to be allocated. Integer values from 1 to 100, inclusive. + +## LinkedResource +### Properties +* **id**: string (Required): ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'. +* **uniqueName**: string (Required): A provided name which uniquely identifies the linked resource. + ## ManagedServiceIdentity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -43,10 +58,12 @@ ### Additional Properties * **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## MapsAccountKeys ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. +* **primaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the primary key. +* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. +* **secondaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the secondary key. ## MapsAccountProperties ### Properties @@ -55,11 +72,6 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the Map account resource. * **uniqueId**: string (ReadOnly): A unique identifier for the maps account -## LinkedResource -### Properties -* **id**: string (Required): ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'. -* **uniqueName**: string (Required): A provided name which uniquely identifies the linked resource. - ## Sku ### Properties * **name**: 'G2' | 'S0' | 'S1' | string (Required): The name of the SKU, in standard format (such as S0). @@ -79,20 +91,8 @@ ### Additional Properties * **Additional Properties Type**: string -## CreatorProperties -### Properties -* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled -* **storageUnits**: int (Required): The storage units to be allocated. Integer values from 1 to 100, inclusive. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MapsAccountKeys -### Properties -* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. -* **primaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the primary key. -* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. -* **secondaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the secondary key. - diff --git a/generated/maps/microsoft.maps/2021-12-01-preview/types.md b/generated/maps/microsoft.maps/2021-12-01-preview/types.md index 9a8e89c749..73dd491d2a 100644 --- a/generated/maps/microsoft.maps/2021-12-01-preview/types.md +++ b/generated/maps/microsoft.maps/2021-12-01-preview/types.md @@ -38,6 +38,38 @@ * **Input**: [AccountSasParameters](#accountsasparameters) * **Output**: [MapsAccountSasToken](#mapsaccountsastoken) +## AccountSasParameters +### Properties +* **expiry**: string (Required, WriteOnly): The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z" +* **maxRatePerSecond**: int (Required, WriteOnly): Required parameter which represents the desired maximum request per second to allowed for the given SAS token. This does not guarantee perfect accuracy in measurements but provides application safe guards of abuse with eventual enforcement. +* **principalId**: string (Required, WriteOnly): The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Map Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id. +* **regions**: string[] (WriteOnly): Optional, allows control of which region locations are permitted access to Azure Maps REST APIs with the SAS token. Example: "eastus", "westus2". Omitting this parameter will allow all region locations to be accessible. +* **signingKey**: 'primaryKey' | 'secondaryKey' | string (Required, WriteOnly): The Map account key to use for signing. +* **start**: string (Required, WriteOnly): The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z". + +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## CorsRule +### Properties +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains + +## CorsRules +### Properties +* **corsRules**: [CorsRule](#corsrule)[]: The list of CORS rules. You can include up to five CorsRule elements in the request. + +## CreatorProperties +### Properties +* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled +* **storageUnits**: int (Required): The storage units to be allocated. Integer values from 1 to 100, inclusive. + +## LinkedResource +### Properties +* **id**: string (Required): ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'. +* **uniqueName**: string (Required): A provided name which uniquely identifies the linked resource. + ## ManagedServiceIdentity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -50,10 +82,12 @@ ### Additional Properties * **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## MapsAccountKeys ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. +* **primaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the primary key. +* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. +* **secondaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the secondary key. ## MapsAccountProperties ### Properties @@ -63,18 +97,9 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the Map account resource. * **uniqueId**: string (ReadOnly): A unique identifier for the maps account -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The list of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains - -## LinkedResource +## MapsAccountSasToken ### Properties -* **id**: string (Required): ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'. -* **uniqueName**: string (Required): A provided name which uniquely identifies the linked resource. +* **accountSasToken**: string (ReadOnly): The shared access signature access token. ## Sku ### Properties @@ -95,33 +120,8 @@ ### Additional Properties * **Additional Properties Type**: string -## CreatorProperties -### Properties -* **provisioningState**: string (ReadOnly): The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled -* **storageUnits**: int (Required): The storage units to be allocated. Integer values from 1 to 100, inclusive. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MapsAccountKeys -### Properties -* **primaryKey**: string (ReadOnly): The primary key for accessing the Maps REST APIs. -* **primaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the primary key. -* **secondaryKey**: string (ReadOnly): The secondary key for accessing the Maps REST APIs. -* **secondaryKeyLastUpdated**: string (ReadOnly): The last updated date and time of the secondary key. - -## AccountSasParameters -### Properties -* **expiry**: string (Required, WriteOnly): The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z" -* **maxRatePerSecond**: int (Required, WriteOnly): Required parameter which represents the desired maximum request per second to allowed for the given SAS token. This does not guarantee perfect accuracy in measurements but provides application safe guards of abuse with eventual enforcement. -* **principalId**: string (Required, WriteOnly): The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Map Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id. -* **regions**: string[] (WriteOnly): Optional, allows control of which region locations are permitted access to Azure Maps REST APIs with the SAS token. Example: "eastus", "westus2". Omitting this parameter will allow all region locations to be accessible. -* **signingKey**: 'primaryKey' | 'secondaryKey' | string (Required, WriteOnly): The Map account key to use for signing. -* **start**: string (Required, WriteOnly): The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z". - -## MapsAccountSasToken -### Properties -* **accountSasToken**: string (ReadOnly): The shared access signature access token. - diff --git a/generated/mariadb/log.out b/generated/mariadb/log.out index e4e79c49a1..5b3803760f 100644 --- a/generated/mariadb/log.out +++ b/generated/mariadb/log.out @@ -8,11 +8,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.dbformariadb-2018-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServerProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json:1524:5 @@ -86,11 +86,11 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json:2511:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'LogFile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from LogFile -info | autorest.bicep took 14ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.dbformariadb-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServerProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json:1601:5 @@ -202,14 +202,14 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'LogFile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from LogFile warning | ? | Operation 'TopQueryStatistics/ListByServer' really should not have a media type (because there should be no body) warning | ? | Operation 'WaitStatistics/ListByServer' really should not have a media type (because there should be no body) -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.dbformariadb-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/Servers.json:107:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 11.15s. 4 files generated. +info | Autorest completed in 10.49s. 4 files generated. diff --git a/generated/mariadb/microsoft.dbformariadb/2018-06-01-preview/types.md b/generated/mariadb/microsoft.dbformariadb/2018-06-01-preview/types.md index 3a4d2d4c95..19ea086d0c 100644 --- a/generated/mariadb/microsoft.dbformariadb/2018-06-01-preview/types.md +++ b/generated/mariadb/microsoft.dbformariadb/2018-06-01-preview/types.md @@ -58,12 +58,46 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.DBforMariaDB/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **source**: string: Source of the configuration. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + ## ResourceIdentity ### Properties * **principalId**: string (ReadOnly): The Azure Active Directory principal id. * **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. * **type**: 'SystemAssigned' | string (ReadOnly): The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +## SecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## ServerForCreateTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ServerPropertiesForCreate * **Discriminator**: createMode @@ -102,13 +136,6 @@ * **sourceServerId**: string (Required, WriteOnly): The master server id to create replica from. -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. -* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. -* **storageMB**: int: Max storage allowed for a server. - ## Sku ### Properties * **capacity**: int: The scale up/out capacity, representing server's compute units. @@ -117,39 +144,12 @@ * **size**: string: The size code, to be interpreted by resource as appropriate. * **tier**: 'Basic' | 'GeneralPurpose' | 'MemoryOptimized' | string: The tier of the particular SKU, e.g. Basic. -## ServerForCreateTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **source**: string: Source of the configuration. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## SecurityAlertPolicyProperties +## StorageProfile ### Properties -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. +* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. +* **storageMB**: int: Max storage allowed for a server. ## VirtualNetworkRuleProperties ### Properties diff --git a/generated/mariadb/microsoft.dbformariadb/2018-06-01/types.md b/generated/mariadb/microsoft.dbformariadb/2018-06-01/types.md index 0ecdb371dd..762dedfeca 100644 --- a/generated/mariadb/microsoft.dbformariadb/2018-06-01/types.md +++ b/generated/mariadb/microsoft.dbformariadb/2018-06-01/types.md @@ -66,6 +66,73 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.DBforMariaDB/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **source**: string: Source of the configuration. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the private endpoint connection. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. + +## SecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## ServerForCreateTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id of the private endpoint connection. +* **properties**: [ServerPrivateEndpointConnectionProperties](#serverprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ServerPrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) +* **privateLinkServiceConnectionState**: [ServerPrivateLinkServiceConnectionStateProperty](#serverprivatelinkserviceconnectionstateproperty) (ReadOnly) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. + +## ServerPrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (ReadOnly): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. + ## ServerPropertiesForCreate * **Discriminator**: createMode @@ -106,34 +173,6 @@ * **sourceServerId**: string (Required, WriteOnly): The master server id to create replica from. -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id of the private endpoint connection. -* **properties**: [ServerPrivateEndpointConnectionProperties](#serverprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ServerPrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) -* **privateLinkServiceConnectionState**: [ServerPrivateLinkServiceConnectionStateProperty](#serverprivatelinkserviceconnectionstateproperty) (ReadOnly) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## ServerPrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (ReadOnly): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. - -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. -* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. -* **storageMB**: int: Max storage allowed for a server. - ## Sku ### Properties * **capacity**: int: The scale up/out capacity, representing server's compute units. @@ -142,51 +181,12 @@ * **size**: string: The size code, to be interpreted by resource as appropriate. * **tier**: 'Basic' | 'GeneralPurpose' | 'MemoryOptimized' | string: The tier of the particular SKU, e.g. Basic. -## ServerForCreateTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **source**: string: Source of the configuration. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the private endpoint connection. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## SecurityAlertPolicyProperties +## StorageProfile ### Properties -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. +* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. +* **storageMB**: int: Max storage allowed for a server. ## VirtualNetworkRuleProperties ### Properties diff --git a/generated/marketplace/log.out b/generated/marketplace/log.out index 6a0f91a450..47f6584cc9 100644 --- a/generated/marketplace/log.out +++ b/generated/marketplace/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.marketplace-2021-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PlanRequesterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json:1979:5 @@ -19,10 +19,10 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'planDetails-requestDate' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-12-01/Marketplace.json#/components/schemas/planDetails-requestDate -info | autorest.bicep took 18ms +info | autorest.bicep took 25ms info | Processing batch task - {"tag":"microsoft.marketplace-2021-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PlanRequesterDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json:1714:5 @@ -40,7 +40,7 @@ warning | Modeler/MissingType | The schema 'planDetails-requestDate' has no type info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.marketplace-2020-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse-error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json:511:9 @@ -51,10 +51,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json:812:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.marketplace-2020-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse-error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json:473:9 @@ -65,5 +65,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'planDetails-requestDate' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#/components/schemas/planDetails-requestDate -info | autorest.bicep took 1ms -info | Autorest completed in 11.47s. 8 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 10.87s. 8 files generated. diff --git a/generated/marketplace/microsoft.marketplace/2020-01-01/types.md b/generated/marketplace/microsoft.marketplace/2020-01-01/types.md index 9003376dfc..52a73ad044 100644 --- a/generated/marketplace/microsoft.marketplace/2020-01-01/types.md +++ b/generated/marketplace/microsoft.marketplace/2020-01-01/types.md @@ -18,19 +18,6 @@ * **properties**: [OfferProperties](#offerproperties) * **type**: 'Microsoft.Marketplace/privateStores/offers' (ReadOnly, DeployTimeConstant): The resource type -## PrivateStoreProperties -### Properties -* **availability**: 'disabled' | 'enabled' | string: Indicates private store availability -* **customerTag**: string: Customer tag -* **eTag**: string: Identifier for purposes of race condition -* **hasCommercialAssociation**: bool: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription -* **hasMultiTenantAssociation**: bool: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD -* **isGov**: bool: Is government -* **privateStoreId**: string: Private Store id -* **privateStoreName**: string: Private Store Name -* **tenantIds**: string[]: Tenant ids -* **tenantTag**: string: Tenant Tag - ## OfferProperties ### Properties * **createdAt**: string (ReadOnly): Private store offer creation date @@ -59,3 +46,16 @@ * **skuId**: string (ReadOnly): Identifier for this plan * **stackType**: string (ReadOnly): Stack type (classic or arm) +## PrivateStoreProperties +### Properties +* **availability**: 'disabled' | 'enabled' | string: Indicates private store availability +* **customerTag**: string: Customer tag +* **eTag**: string: Identifier for purposes of race condition +* **hasCommercialAssociation**: bool: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription +* **hasMultiTenantAssociation**: bool: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD +* **isGov**: bool: Is government +* **privateStoreId**: string: Private Store id +* **privateStoreName**: string: Private Store Name +* **tenantIds**: string[]: Tenant ids +* **tenantTag**: string: Tenant Tag + diff --git a/generated/marketplace/microsoft.marketplace/2020-12-01/types.md b/generated/marketplace/microsoft.marketplace/2020-12-01/types.md index 2c2336480d..38fcbfd475 100644 --- a/generated/marketplace/microsoft.marketplace/2020-12-01/types.md +++ b/generated/marketplace/microsoft.marketplace/2020-12-01/types.md @@ -31,17 +31,27 @@ * **plans**: [PlanRequesterDetails](#planrequesterdetails)[] (ReadOnly): Gets list of plans with requesters details * **publisherId**: string: Gets or sets publisher Id +## PlanDetails +### Properties +* **justification**: string: Gets or sets user's justification for the plan's request +* **planId**: string: Gets or sets Plan Id +* **requestDate**: any (ReadOnly): Anything +* **status**: 'Approved' | 'None' | 'Pending' | 'Rejected' | string (ReadOnly): Gets the plan status + ## PlanRequesterDetails ### Properties * **planDisplayName**: string (ReadOnly): Gets the plan display name * **planId**: string (ReadOnly): Gets the plan id * **requesters**: [UserRequestDetails](#userrequestdetails)[] (ReadOnly): Gets requesters details list -## UserRequestDetails +## RequestApprovalProperties ### Properties -* **date**: string (ReadOnly): Gets request date -* **justification**: string (ReadOnly): Gets justification -* **user**: string (ReadOnly): Gets user id +* **isClosed**: bool (ReadOnly): Gets a value indicating whether the request is closed +* **messageCode**: int: Gets or sets the request approval message code +* **offerDisplayName**: string (ReadOnly): Gets offer display name +* **offerId**: string: Gets or sets unique offer id. +* **plansDetails**: [PlanDetails](#plandetails)[]: Gets or sets the plans details +* **publisherId**: string: The offer's publisher id ## SystemData ### Properties @@ -52,19 +62,9 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -## RequestApprovalProperties -### Properties -* **isClosed**: bool (ReadOnly): Gets a value indicating whether the request is closed -* **messageCode**: int: Gets or sets the request approval message code -* **offerDisplayName**: string (ReadOnly): Gets offer display name -* **offerId**: string: Gets or sets unique offer id. -* **plansDetails**: [PlanDetails](#plandetails)[]: Gets or sets the plans details -* **publisherId**: string: The offer's publisher id - -## PlanDetails +## UserRequestDetails ### Properties -* **justification**: string: Gets or sets user's justification for the plan's request -* **planId**: string: Gets or sets Plan Id -* **requestDate**: any (ReadOnly): Anything -* **status**: 'Approved' | 'None' | 'Pending' | 'Rejected' | string (ReadOnly): Gets the plan status +* **date**: string (ReadOnly): Gets request date +* **justification**: string (ReadOnly): Gets justification +* **user**: string (ReadOnly): Gets user id diff --git a/generated/marketplace/microsoft.marketplace/2021-06-01/types.md b/generated/marketplace/microsoft.marketplace/2021-06-01/types.md index 1866d3d068..d0e2d9fc88 100644 --- a/generated/marketplace/microsoft.marketplace/2021-06-01/types.md +++ b/generated/marketplace/microsoft.marketplace/2021-06-01/types.md @@ -50,43 +50,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Read only system data * **type**: 'Microsoft.Marketplace/privateStores/requestApprovals' (ReadOnly, DeployTimeConstant): The resource type -## PrivateStoreProperties -### Properties -* **availability**: 'disabled' | 'enabled' | string: Indicates private store availability -* **branding**: [PrivateStorePropertiesBranding](#privatestorepropertiesbranding): Gets or sets list of branding characteristics -* **collectionIds**: string[] (ReadOnly): Gets list of associated collection ids -* **eTag**: string: Identifier for purposes of race condition -* **isGov**: bool: Is government -* **notificationsSettings**: [NotificationsSettingsProperties](#notificationssettingsproperties): Describes the json payload for notifications settings -* **privateStoreId**: string (ReadOnly): Private Store id -* **privateStoreName**: string: Private Store Name -* **tenantId**: string: Tenant id - -## PrivateStorePropertiesBranding -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NotificationsSettingsProperties -### Properties -* **recipients**: [Recipient](#recipient)[]: Gets or sets list of notified recipients for new requests -* **sendToAllMarketplaceAdmins**: bool: Gets or sets whether to send email to all marketplace admins for new requests - -## Recipient -### Properties -* **displayName**: string (ReadOnly): Display Name -* **emailAddress**: string (ReadOnly): Email Address -* **principalId**: string: Principal ID - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources - ## AdminRequestApprovalProperties ### Properties * **adminAction**: 'Approved' | 'Rejected' | string: Gets or sets admin action @@ -99,20 +62,6 @@ * **plans**: [PlanRequesterDetails](#planrequesterdetails)[] (ReadOnly): Gets list of plans with requesters details * **publisherId**: string: Gets or sets publisher Id -## PlanRequesterDetails -### Properties -* **planDisplayName**: string (ReadOnly): Gets the plan display name -* **planId**: string (ReadOnly): Gets the plan id -* **requesters**: [UserRequestDetails](#userrequestdetails)[] (ReadOnly): Gets requesters details list - -## UserRequestDetails -### Properties -* **date**: string (ReadOnly): Gets request date -* **justification**: string (ReadOnly): Gets justification -* **subscriptionId**: string: Gets the subscription id that the user is requesting to add the plan to -* **subscriptionName**: string: Gets the subscription name that the user is requesting to add the plan to -* **user**: string (ReadOnly): Gets user id - ## CollectionProperties ### Properties * **allSubscriptions**: bool: Indicating whether all subscriptions are selected (=true) or not (=false). @@ -123,6 +72,11 @@ * **numberOfOffers**: int (ReadOnly): Gets the number of offers associated with the collection. * **subscriptionsList**: string[]: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request +## NotificationsSettingsProperties +### Properties +* **recipients**: [Recipient](#recipient)[]: Gets or sets list of notified recipients for new requests +* **sendToAllMarketplaceAdmins**: bool: Gets or sets whether to send email to all marketplace admins for new requests + ## OfferProperties ### Properties * **createdAt**: string (ReadOnly): Private store offer creation date @@ -151,6 +105,44 @@ * **skuId**: string (ReadOnly): Identifier for this plan * **stackType**: string (ReadOnly): Stack type (classic or arm) +## PlanDetails +### Properties +* **justification**: string: Gets or sets user's justification for the plan's request +* **planId**: string: Gets or sets Plan Id +* **requestDate**: any (ReadOnly): Anything +* **status**: 'Approved' | 'None' | 'Pending' | 'Rejected' | string (ReadOnly): Gets the plan status +* **subscriptionId**: string: Gets or sets the subscription id that the user is requesting to add the plan to +* **subscriptionName**: string: Gets or sets the subscription name that the user is requesting to add the plan to + +## PlanRequesterDetails +### Properties +* **planDisplayName**: string (ReadOnly): Gets the plan display name +* **planId**: string (ReadOnly): Gets the plan id +* **requesters**: [UserRequestDetails](#userrequestdetails)[] (ReadOnly): Gets requesters details list + +## PrivateStoreProperties +### Properties +* **availability**: 'disabled' | 'enabled' | string: Indicates private store availability +* **branding**: [PrivateStorePropertiesBranding](#privatestorepropertiesbranding): Gets or sets list of branding characteristics +* **collectionIds**: string[] (ReadOnly): Gets list of associated collection ids +* **eTag**: string: Identifier for purposes of race condition +* **isGov**: bool: Is government +* **notificationsSettings**: [NotificationsSettingsProperties](#notificationssettingsproperties): Describes the json payload for notifications settings +* **privateStoreId**: string (ReadOnly): Private Store id +* **privateStoreName**: string: Private Store Name +* **tenantId**: string: Tenant id + +## PrivateStorePropertiesBranding +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Recipient +### Properties +* **displayName**: string (ReadOnly): Display Name +* **emailAddress**: string (ReadOnly): Email Address +* **principalId**: string: Principal ID + ## RequestApprovalProperties ### Properties * **isClosed**: bool (ReadOnly): Gets a value indicating whether the request is closed @@ -160,12 +152,20 @@ * **plansDetails**: [PlanDetails](#plandetails)[]: Gets or sets the plans details * **publisherId**: string: The offer's publisher id -## PlanDetails +## SystemData ### Properties -* **justification**: string: Gets or sets user's justification for the plan's request -* **planId**: string: Gets or sets Plan Id -* **requestDate**: any (ReadOnly): Anything -* **status**: 'Approved' | 'None' | 'Pending' | 'Rejected' | string (ReadOnly): Gets the plan status -* **subscriptionId**: string: Gets or sets the subscription id that the user is requesting to add the plan to -* **subscriptionName**: string: Gets or sets the subscription name that the user is requesting to add the plan to +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources + +## UserRequestDetails +### Properties +* **date**: string (ReadOnly): Gets request date +* **justification**: string (ReadOnly): Gets justification +* **subscriptionId**: string: Gets the subscription id that the user is requesting to add the plan to +* **subscriptionName**: string: Gets the subscription name that the user is requesting to add the plan to +* **user**: string (ReadOnly): Gets user id diff --git a/generated/marketplace/microsoft.marketplace/2021-12-01/types.md b/generated/marketplace/microsoft.marketplace/2021-12-01/types.md index da8c41e193..2f037d67b0 100644 --- a/generated/marketplace/microsoft.marketplace/2021-12-01/types.md +++ b/generated/marketplace/microsoft.marketplace/2021-12-01/types.md @@ -66,43 +66,6 @@ * **ApiVersion**: 2021-12-01 * **Output**: [SubscriptionsContextList](#subscriptionscontextlist) -## PrivateStoreProperties -### Properties -* **availability**: 'disabled' | 'enabled' | string: Indicates private store availability -* **branding**: [PrivateStorePropertiesBranding](#privatestorepropertiesbranding): Gets or sets list of branding characteristics -* **collectionIds**: string[] (ReadOnly): Gets list of associated collection ids -* **eTag**: string: Identifier for purposes of race condition -* **isGov**: bool: Is government -* **notificationsSettings**: [NotificationsSettingsProperties](#notificationssettingsproperties): Describes the json payload for notifications settings -* **privateStoreId**: string (ReadOnly): Private Store id -* **privateStoreName**: string: Private Store Name -* **tenantId**: string: Tenant id - -## PrivateStorePropertiesBranding -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NotificationsSettingsProperties -### Properties -* **recipients**: [Recipient](#recipient)[]: Gets or sets list of notified recipients for new requests -* **sendToAllMarketplaceAdmins**: bool: Gets or sets whether to send email to all marketplace admins for new requests - -## Recipient -### Properties -* **displayName**: string (ReadOnly): Display Name -* **emailAddress**: string (ReadOnly): Email Address -* **principalId**: string: Principal ID - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources - ## AdminRequestApprovalProperties ### Properties * **adminAction**: 'Approved' | 'Rejected' | string: Gets or sets admin action @@ -115,20 +78,6 @@ * **plans**: [PlanRequesterDetails](#planrequesterdetails)[] (ReadOnly): Gets list of plans with requesters details * **publisherId**: string: Gets or sets publisher Id -## PlanRequesterDetails -### Properties -* **planDisplayName**: string (ReadOnly): Gets the plan display name -* **planId**: string (ReadOnly): Gets the plan id -* **requesters**: [UserRequestDetails](#userrequestdetails)[] (ReadOnly): Gets requesters details list - -## UserRequestDetails -### Properties -* **date**: string (ReadOnly): Gets request date -* **justification**: string (ReadOnly): Gets justification -* **subscriptionId**: string: Gets the subscription id that the user is requesting to add the plan to -* **subscriptionName**: string: Gets the subscription name that the user is requesting to add the plan to -* **user**: string (ReadOnly): Gets user id - ## CollectionProperties ### Properties * **allSubscriptions**: bool: Indicating whether all subscriptions are selected (=true) or not (=false). @@ -139,6 +88,24 @@ * **numberOfOffers**: int (ReadOnly): Gets the number of offers associated with the collection. * **subscriptionsList**: string[]: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request +## NewNotifications +### Properties +* **displayName**: string (ReadOnly): Gets offer display name +* **icon**: string (ReadOnly): Gets or sets the icon url +* **isFuturePlansEnabled**: bool (ReadOnly): Gets a value indicating whether future plans is enabled. +* **messageCode**: int (ReadOnly): Gets or sets the notification message id +* **offerId**: string (ReadOnly): Gets offer id +* **plans**: [PlanNotificationDetails](#plannotificationdetails)[] (ReadOnly): Gets or sets removed plans notifications + +## NewPlansNotificationsList +### Properties +* **newPlansNotifications**: [NewNotifications](#newnotifications)[] (ReadOnly): Array of NewNotifications + +## NotificationsSettingsProperties +### Properties +* **recipients**: [Recipient](#recipient)[]: Gets or sets list of notified recipients for new requests +* **sendToAllMarketplaceAdmins**: bool: Gets or sets whether to send email to all marketplace admins for new requests + ## OfferProperties ### Properties * **createdAt**: string (ReadOnly): Private store offer creation date @@ -167,15 +134,6 @@ * **skuId**: string (ReadOnly): Identifier for this plan * **stackType**: string (ReadOnly): Stack type (classic or arm) -## RequestApprovalProperties -### Properties -* **isClosed**: bool (ReadOnly): Gets a value indicating whether the request is closed -* **messageCode**: int: Gets or sets the request approval message code -* **offerDisplayName**: string (ReadOnly): Gets offer display name -* **offerId**: string: Gets or sets unique offer id. -* **plansDetails**: [PlanDetails](#plandetails)[]: Gets or sets the plans details -* **publisherId**: string: The offer's publisher id - ## PlanDetails ### Properties * **justification**: string: Gets or sets user's justification for the plan's request @@ -185,27 +143,48 @@ * **subscriptionId**: string: Gets or sets the subscription id that the user is requesting to add the plan to * **subscriptionName**: string: Gets or sets the subscription name that the user is requesting to add the plan to -## NewPlansNotificationsList +## PlanNotificationDetails ### Properties -* **newPlansNotifications**: [NewNotifications](#newnotifications)[] (ReadOnly): Array of NewNotifications +* **planDisplayName**: string (ReadOnly): Gets or sets the plan display name +* **planId**: string (ReadOnly): Gets or sets the plan id -## NewNotifications +## PlanRequesterDetails ### Properties -* **displayName**: string (ReadOnly): Gets offer display name -* **icon**: string (ReadOnly): Gets or sets the icon url -* **isFuturePlansEnabled**: bool (ReadOnly): Gets a value indicating whether future plans is enabled. -* **messageCode**: int (ReadOnly): Gets or sets the notification message id -* **offerId**: string (ReadOnly): Gets offer id -* **plans**: [PlanNotificationDetails](#plannotificationdetails)[] (ReadOnly): Gets or sets removed plans notifications +* **planDisplayName**: string (ReadOnly): Gets the plan display name +* **planId**: string (ReadOnly): Gets the plan id +* **requesters**: [UserRequestDetails](#userrequestdetails)[] (ReadOnly): Gets requesters details list -## PlanNotificationDetails +## PrivateStoreProperties ### Properties -* **planDisplayName**: string (ReadOnly): Gets or sets the plan display name -* **planId**: string (ReadOnly): Gets or sets the plan id +* **availability**: 'disabled' | 'enabled' | string: Indicates private store availability +* **branding**: [PrivateStorePropertiesBranding](#privatestorepropertiesbranding): Gets or sets list of branding characteristics +* **collectionIds**: string[] (ReadOnly): Gets list of associated collection ids +* **eTag**: string: Identifier for purposes of race condition +* **isGov**: bool: Is government +* **notificationsSettings**: [NotificationsSettingsProperties](#notificationssettingsproperties): Describes the json payload for notifications settings +* **privateStoreId**: string (ReadOnly): Private Store id +* **privateStoreName**: string: Private Store Name +* **tenantId**: string: Tenant id -## StopSellSubscriptions +## PrivateStorePropertiesBranding ### Properties -* **subscriptions**: string[] (WriteOnly): Array of StopSellSubscriptionsItem +### Additional Properties +* **Additional Properties Type**: string + +## Recipient +### Properties +* **displayName**: string (ReadOnly): Display Name +* **emailAddress**: string (ReadOnly): Email Address +* **principalId**: string: Principal ID + +## RequestApprovalProperties +### Properties +* **isClosed**: bool (ReadOnly): Gets a value indicating whether the request is closed +* **messageCode**: int: Gets or sets the request approval message code +* **offerDisplayName**: string (ReadOnly): Gets offer display name +* **offerId**: string: Gets or sets unique offer id. +* **plansDetails**: [PlanDetails](#plandetails)[]: Gets or sets the plans details +* **publisherId**: string: The offer's publisher id ## StopSellOffersPlansNotificationsList ### Properties @@ -222,7 +201,28 @@ * **publicContext**: bool (ReadOnly): True if the offer has public plans * **subscriptionsIds**: string[] (ReadOnly): The subscriptions related to private plans +## StopSellSubscriptions +### Properties +* **subscriptions**: string[] (WriteOnly): Array of StopSellSubscriptionsItem + ## SubscriptionsContextList ### Properties * **subscriptionsIds**: string[] (ReadOnly): Array of SubscriptionsContextListSubscriptionsIdsItem +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that creates/modifies resources + +## UserRequestDetails +### Properties +* **date**: string (ReadOnly): Gets request date +* **justification**: string (ReadOnly): Gets justification +* **subscriptionId**: string: Gets the subscription id that the user is requesting to add the plan to +* **subscriptionName**: string: Gets the subscription name that the user is requesting to add the plan to +* **user**: string (ReadOnly): Gets user id + diff --git a/generated/marketplacenotifications/log.out b/generated/marketplacenotifications/log.out index 983e17a31b..081d991134 100644 --- a/generated/marketplacenotifications/log.out +++ b/generated/marketplacenotifications/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.marketplacenotifications-2021-03-03"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse-error' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json:226:9 @@ -14,4 +14,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json:313:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 4.35s. 0 files generated. +info | Autorest completed in 4.2s. 0 files generated. diff --git a/generated/marketplaceordering/log.out b/generated/marketplaceordering/log.out index 3ccf399d75..eb9cac4218 100644 --- a/generated/marketplaceordering/log.out +++ b/generated/marketplaceordering/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.marketplaceordering-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AgreementTerms' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json:384:5 @@ -27,8 +27,8 @@ info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.marketplaceordering-2015-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 5.9s. 4 files generated. +info | Autorest completed in 5.61s. 4 files generated. diff --git a/generated/mediaservices/log.out b/generated/mediaservices/log.out index aaadc4995c..f8140b6d21 100644 --- a/generated/mediaservices/log.out +++ b/generated/mediaservices/log.out @@ -12,7 +12,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.media-2021-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -24,7 +24,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. @@ -32,7 +32,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 35ms +info | autorest.bicep took 31ms info | Processing batch task - {"tag":"microsoft.media-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -44,7 +44,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. @@ -52,7 +52,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 23ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.media-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -64,7 +64,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Hls' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json:1125:5 @@ -126,7 +126,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 24ms +info | autorest.bicep took 31ms info | Processing batch task - {"tag":"microsoft.media-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -138,10 +138,10 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.media-2018-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -153,7 +153,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Hls' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/streamingservice.json:1078:5 @@ -252,7 +252,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 23ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.media-2020-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -264,12 +264,12 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.media-2019-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -281,12 +281,12 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.media-2019-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -298,7 +298,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mediaservices/resource-manager/Microsoft.Media/preview/2019-05-01-preview/Common.json:20:5 @@ -408,7 +408,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 28ms +info | autorest.bicep took 52ms info | Processing batch task - {"tag":"microsoft.media-2015-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -420,7 +420,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApiEndpoint' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mediaservices/resource-manager/Microsoft.Media/stable/2015-10-01/media.json:587:5 @@ -465,7 +465,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Hls' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/streamingservice.json:1078:5 @@ -522,7 +522,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 13ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.media-2018-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -534,7 +534,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Hls' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/streamingservice.json:1078:5 @@ -621,5 +621,5 @@ warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 12ms -info | Autorest completed in 64.61s. 24 files generated. +info | autorest.bicep took 17ms +info | Autorest completed in 61.52s. 24 files generated. diff --git a/generated/mediaservices/microsoft.media/2015-10-01/types.md b/generated/mediaservices/microsoft.media/2015-10-01/types.md index e4ce518e0c..111ec18822 100644 --- a/generated/mediaservices/microsoft.media/2015-10-01/types.md +++ b/generated/mediaservices/microsoft.media/2015-10-01/types.md @@ -16,20 +16,15 @@ * **ApiVersion**: 2015-10-01 * **Output**: [ServiceKeys](#servicekeys) -## MediaServiceProperties -### Properties -* **apiEndpoints**: [ApiEndpoint](#apiendpoint)[] (ReadOnly): Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. - ## ApiEndpoint ### Properties * **endpoint**: string: The Media Services REST endpoint. * **majorVersion**: string: The version of Media Services REST API. -## StorageAccount +## MediaServiceProperties ### Properties -* **id**: string (Required): 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). -* **isPrimary**: bool (Required): Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false. +* **apiEndpoints**: [ApiEndpoint](#apiendpoint)[] (ReadOnly): Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. ## ResourceTags ### Properties @@ -44,3 +39,8 @@ * **secondaryAuthEndpoint**: string (ReadOnly): The secondary authorization endpoint. * **secondaryKey**: string (ReadOnly): The secondary key for the Media Service resource. +## StorageAccount +### Properties +* **id**: string (Required): 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). +* **isPrimary**: bool (Required): Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false. + diff --git a/generated/mediaservices/microsoft.media/2018-03-30-preview/types.md b/generated/mediaservices/microsoft.media/2018-03-30-preview/types.md index c378d93d57..bf9b9205bb 100644 --- a/generated/mediaservices/microsoft.media/2018-03-30-preview/types.md +++ b/generated/mediaservices/microsoft.media/2018-03-30-preview/types.md @@ -112,20 +112,19 @@ * **ApiVersion**: 2018-03-30-preview * **Output**: [ListPathsResponse](#listpathsresponse) -## MediaServiceProperties +## AkamaiAccessControl ### Properties -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## StorageAccount +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **id**: string: 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. -* **type**: 'Primary' | 'Secondary' (Required): The type of the storage account. +* **base64Key**: string: authentication key +* **expiration**: string: The exact time the authentication key. +* **identifier**: string: identifier of the key -## TrackedResourceTags +## AssetContainerSas ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. ## AssetProperties ### Properties @@ -138,20 +137,66 @@ * **storageAccountName**: string: The name of the storage account. * **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. -## ContentKeyPolicyProperties +## CbcsDrmConfiguration ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## ContentKeyPolicyOption +## CencDrmConfiguration ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## Codec +* **Discriminator**: @odata.type + +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2': The encoding profile to be used when encoding audio with AAC. + +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. + +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. + +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed': Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify drm configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled + +## CommonEncryptionCenc +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify drm configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -186,18 +231,12 @@ * **widevineTemplate**: string (Required): The Widevine template. -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -213,6 +252,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -229,10 +286,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -284,52 +344,85 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The exact time the Live Event was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: The Live Event description. -* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. -* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. -* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. -* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. -* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the Live Event. -* **streamOptions**: 'Default' | 'LowLatency'[]: The stream options. -* **vanityUrl**: bool: The Live Event vanity URL flag. - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding +## DefaultKey ### Properties -* **encodingType**: 'Basic' | 'None': The encoding type for Live Event. -* **presetName**: string: The encoding preset name. +* **label**: string: Label can be used to specify Content Key when creating Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventInput +## Deinterlace ### Properties -* **accessToken**: string: The access token. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. -* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' (Required): The streaming protocol for the Live Event. +* **mode**: 'AutoPixelAdaptive' | 'Off': The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst': The field parity for de-interlacing, defaults to Auto. -## LiveEventEndpoint +## EnabledProtocols ### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. +* **dash**: bool (Required): Enable Dash protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable Hls protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## LiveEventPreview +## EnvelopeEncryption ### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. -* **previewLocator**: string: The preview locator Guid. -* **streamingPolicyName**: string: The name of streaming policy used for LiveEvent preview +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customLicenseAcquisitionUrlTemplate**: string: LicenseAcquisitionUrlTemplate is used to point to user specified service to delivery content keys +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## LiveEventPreviewAccessControl +## Filters ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90': The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto + +## Format +* **Discriminator**: @odata.type + +### Base Properties +* **filenamePattern**: string: 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. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. + +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. + +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. + +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. + + +## H264Layer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int: The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **entropyMode**: 'Cabac' | 'Cavlc': 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: string: Which level of the H.264 standard should be used when encoding this layer. 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main': Which profile of the H.264 standard should be used when encoding this layer. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. + +## Hls +### Properties +* **fragmentsPerTsSegment**: int: The amount of fragments per HTTP Live Streaming (HLS) segment. ## IPAccessControl ### Properties @@ -341,298 +434,148 @@ * **name**: string: The friendly name for the IP address range. * **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## TrackedResourceTags +## JobError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## LiveOutputProperties +## JobErrorDetail ### Properties -* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. -* **assetName**: string (Required): The asset name. -* **created**: string (ReadOnly): The exact time the Live Output was created. -* **description**: string: The description of the Live Output. -* **hls**: [Hls](#hls): The HLS configuration. -* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. -* **manifestName**: string: The manifest file name. -* **outputSnapTime**: int: The output snapshot time. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' (ReadOnly): The resource state of the Live Output. +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## Hls -### Properties -* **fragmentsPerTsSegment**: int: The amount of fragments per HTTP Live Streaming (HLS) segment. +## JobInput +* **Discriminator**: @odata.type -## StreamingEndpointProperties -### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. -* **availabilitySetName**: string: AvailabilitySet name -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the StreamingEndpoint -* **description**: string: The StreamingEndpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The StreamingEndpoint host name. -* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the StreamingEndpoint. -* **scaleUnits**: int: The number of scale units. - -## StreamingEndpointAccessControl -### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. - -## AkamaiAccessControl -### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list - -## AkamaiSignatureHeaderAuthenticationKey -### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The exact time the authentication key. -* **identifier**: string: identifier of the key - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StreamingLocatorProperties -### Properties -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorUserDefinedContentKey](#streaminglocatoruserdefinedcontentkey)[]: ContentKeys used by this Streaming Locator -* **created**: string (ReadOnly): Creation time of Streaming Locator -* **defaultContentKeyPolicyName**: string: Default ContentKeyPolicy used by this Streaming Locator -* **endTime**: string: EndTime of Streaming Locator -* **startTime**: string: StartTime of Streaming Locator -* **streamingLocatorId**: string: StreamingLocatorId of Streaming Locator -* **streamingPolicyName**: string (Required): Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' - -## StreamingLocatorUserDefinedContentKey -### Properties -* **id**: string (Required): ID of Content Key -* **label**: string: The Content Key description -* **value**: string: The Content Key secret - -## StreamingPolicyProperties -### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme - -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify drm configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled - -## TrackSelection -### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) - -## TrackPropertyCondition -### Properties -* **operation**: 'Equal' | 'Unknown' (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' (Required): Track property type -* **value**: string: Track property value +### Base Properties +* **label**: string: A label that is assigned to a JobInput, 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'. +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. -## DefaultKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating Streaming Locator -* **policyName**: string: Policy used by Default Key +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## StreamingPolicyContentKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key -## CbcsDrmConfiguration -### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +## JobOutput +* **Discriminator**: @odata.type -## StreamingPolicyFairPlayConfiguration -### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. +### Base Properties +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the job completion percentage. The value is an estimate and not intended to be used to predict job completion times. To determine if the JobOutput is complete, use the State property. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. -## StreamingPolicyPlayReadyConfiguration -### Properties -* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady -## StreamingPolicyWidevineConfiguration +## JobProperties ### Properties -* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. +* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal': 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. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. -## EnabledProtocols +## JpgLayer ### Properties -* **dash**: bool (Required): Enable Dash protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable Hls protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. -## CommonEncryptionCenc +## ListContainerSasInput ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify drm configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' (WriteOnly): The permissions to set on the SAS URL. -## CencDrmConfiguration +## ListContentKeysResponse ### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator -## EnvelopeEncryption +## ListPathsResponse ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customLicenseAcquisitionUrlTemplate**: string: LicenseAcquisitionUrlTemplate is used to point to user specified service to delivery content keys -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator -## NoEncryption +## LiveEventEncoding ### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **encodingType**: 'Basic' | 'None': The encoding type for Live Event. +* **presetName**: string: The encoding preset name. -## TransformProperties +## LiveEventEndpoint ### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -## TransformOutput +## LiveEventInput ### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob': 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 default is stop. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal': 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. - -## Preset -* **Discriminator**: @odata.type - -### Base Properties -### BuiltInStandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' (Required): The built-in preset to be used for encoding videos. - -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[]: The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[]: The list of outputs to be produced by the encoder. - -### VideoAnalyzerPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **audioInsightsOnly**: bool: Whether to only extract audio insights when processing a video file. - - -## Codec -* **Discriminator**: @odata.type - -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2': The encoding profile to be used when encoding audio with AAC. - -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. - -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. - -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed': Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: 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. - -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. - -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. - +* **accessToken**: string: The access token. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. +* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' (Required): The streaming protocol for the Live Event. -## H264Layer +## LiveEventPreview ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int: The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **entropyMode**: 'Cabac' | 'Cavlc': 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: string: Which level of the H.264 standard should be used when encoding this layer. 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main': Which profile of the H.264 standard should be used when encoding this layer. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. +* **previewLocator**: string: The preview locator Guid. +* **streamingPolicyName**: string: The name of streaming policy used for LiveEvent preview -## JpgLayer -### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +## LiveEventPreviewAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## PngLayer +## LiveEventProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **created**: string (ReadOnly): The exact time the Live Event was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: The Live Event description. +* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. +* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. +* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. +* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. +* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the Live Event. +* **streamOptions**: 'Default' | 'LowLatency'[]: The stream options. +* **vanityUrl**: bool: The Live Event vanity URL flag. -## Filters +## LiveOutputProperties ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90': The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. +* **assetName**: string (Required): The asset name. +* **created**: string (ReadOnly): The exact time the Live Output was created. +* **description**: string: The description of the Live Output. +* **hls**: [Hls](#hls): The HLS configuration. +* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. +* **manifestName**: string: The manifest file name. +* **outputSnapTime**: int: The output snapshot time. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' (ReadOnly): The resource state of the Live Output. -## Rectangle +## MediaServiceProperties ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -## Deinterlace +## NoEncryption ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off': The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst': The field parity for de-interlacing, defaults to Auto. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -656,97 +599,70 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format -* **Discriminator**: @odata.type - -### Base Properties -* **filenamePattern**: string: 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. -### JpgFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. - -### Mp4Format -#### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. - -### PngFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. - -### TransportStreamFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. - - -## JobProperties +## PngLayer ### Properties -* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal': 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. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. -## JobInput +## Preset * **Discriminator**: @odata.type ### Base Properties -* **label**: string: A label that is assigned to a JobInput, 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'. -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. - -### JobInputHttp +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' (Required): The built-in preset to be used for encoding videos. -### JobInputs +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. - - -## JobOutput -* **Discriminator**: @odata.type +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[]: The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[]: The list of outputs to be produced by the encoder. -### Base Properties -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the job completion percentage. The value is an estimate and not intended to be used to predict job completion times. To determine if the JobOutput is complete, use the State property. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. - +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **audioInsightsOnly**: bool: Whether to only extract audio insights when processing a video file. -## JobError -### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## JobErrorDetail +## Rectangle ### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). -## ListContainerSasInput +## StorageAccount ### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' (WriteOnly): The permissions to set on the SAS URL. +* **id**: string: 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. +* **type**: 'Primary' | 'Secondary' (Required): The type of the storage account. -## AssetContainerSas +## StreamingEndpointAccessControl ### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## ListContentKeysResponse +## StreamingEndpointProperties ### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. +* **availabilitySetName**: string: AvailabilitySet name +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the StreamingEndpoint +* **description**: string: The StreamingEndpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The StreamingEndpoint host name. +* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the StreamingEndpoint. +* **scaleUnits**: int: The number of scale units. ## StreamingLocatorContentKey ### Properties @@ -757,10 +673,22 @@ * **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' (ReadOnly): Encryption type of Content Key * **value**: string (ReadOnly): Value of Content Key -## ListPathsResponse +## StreamingLocatorProperties ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorUserDefinedContentKey](#streaminglocatoruserdefinedcontentkey)[]: ContentKeys used by this Streaming Locator +* **created**: string (ReadOnly): Creation time of Streaming Locator +* **defaultContentKeyPolicyName**: string: Default ContentKeyPolicy used by this Streaming Locator +* **endTime**: string: EndTime of Streaming Locator +* **startTime**: string: StartTime of Streaming Locator +* **streamingLocatorId**: string: StreamingLocatorId of Streaming Locator +* **streamingPolicyName**: string (Required): Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' + +## StreamingLocatorUserDefinedContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **label**: string: The Content Key description +* **value**: string: The Content Key secret ## StreamingPath ### Properties @@ -768,3 +696,75 @@ * **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair * **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' (ReadOnly): Streaming protocol +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key + +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key + +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. + +## StreamingPolicyPlayReadyConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady + +## StreamingPolicyProperties +### Properties +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme + +## StreamingPolicyWidevineConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackPropertyCondition +### Properties +* **operation**: 'Equal' | 'Unknown' (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' (Required): Track property type +* **value**: string: Track property value + +## TrackSelection +### Properties +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) + +## TransformOutput +### Properties +* **onError**: 'ContinueJob' | 'StopProcessingJob': 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 default is stop. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal': 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. + +## TransformProperties +### Properties +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. + diff --git a/generated/mediaservices/microsoft.media/2018-06-01-preview/types.md b/generated/mediaservices/microsoft.media/2018-06-01-preview/types.md index 6ca822ad43..8aff42697a 100644 --- a/generated/mediaservices/microsoft.media/2018-06-01-preview/types.md +++ b/generated/mediaservices/microsoft.media/2018-06-01-preview/types.md @@ -112,20 +112,19 @@ * **ApiVersion**: 2018-06-01-preview * **Output**: [ListPathsResponse](#listpathsresponse) -## MediaServiceProperties +## AkamaiAccessControl ### Properties -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## StorageAccount +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **id**: string: 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. -* **type**: 'Primary' | 'Secondary' (Required): The type of the storage account. +* **base64Key**: string: authentication key +* **expiration**: string: The exact time the authentication key. +* **identifier**: string: identifier of the key -## TrackedResourceTags +## AssetContainerSas ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. ## AssetProperties ### Properties @@ -138,20 +137,66 @@ * **storageAccountName**: string: The name of the storage account. * **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. -## ContentKeyPolicyProperties +## CbcsDrmConfiguration ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## ContentKeyPolicyOption +## CencDrmConfiguration ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## Codec +* **Discriminator**: @odata.type + +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2': The encoding profile to be used when encoding audio with AAC. + +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. + +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. + +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed': Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled + +## CommonEncryptionCenc +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -186,18 +231,12 @@ * **widevineTemplate**: string (Required): The Widevine template. -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -213,6 +252,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -229,10 +286,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -284,53 +344,85 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The exact time the Live Event was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: The Live Event description. -* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. -* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. -* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. -* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. -* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the Live Event. -* **streamOptions**: 'Default' | 'LowLatency'[]: The stream options. -* **vanityUrl**: bool: The Live Event vanity URL flag. - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding +## DefaultKey ### Properties -* **encodingType**: 'Basic' | 'None': The encoding type for Live Event. -* **presetName**: string: The encoding preset name. +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventInput +## Deinterlace ### Properties -* **accessToken**: string: The access token. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. -* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' (Required): The streaming protocol for the Live Event. +* **mode**: 'AutoPixelAdaptive' | 'Off': The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst': The field parity for de-interlacing, defaults to Auto. -## LiveEventEndpoint +## EnabledProtocols ### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. +* **dash**: bool (Required): Enable DASH protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable HLS protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## LiveEventPreview +## EnvelopeEncryption ### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. -* **alternativeMediaId**: string: An Alternative Media Identifier associated with the preview url. This identifier can be used to distinguish the preview of different live events for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. -* **previewLocator**: string: The preview locator Guid. -* **streamingPolicyName**: string: The name of streaming policy used for LiveEvent preview +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customKeyAcquisitionUrlTemplate**: string: KeyAcquisitionUrlTemplate is used to point to user specified service to delivery content keys +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## LiveEventPreviewAccessControl +## Filters ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90': The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto + +## Format +* **Discriminator**: @odata.type + +### Base Properties +* **filenamePattern**: string: 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. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. + +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. + +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. + +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. + + +## H264Layer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int: The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **entropyMode**: 'Cabac' | 'Cavlc': 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: string: Which level of the H.264 standard should be used when encoding this layer. 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main': Which profile of the H.264 standard should be used when encoding this layer. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. + +## Hls +### Properties +* **fragmentsPerTsSegment**: int: The amount of fragments per HTTP Live Streaming (HLS) segment. ## IPAccessControl ### Properties @@ -342,302 +434,155 @@ * **name**: string: The friendly name for the IP address range. * **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## TrackedResourceTags +## JobError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## LiveOutputProperties +## JobErrorDetail ### Properties -* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. -* **assetName**: string (Required): The asset name. -* **created**: string (ReadOnly): The exact time the Live Output was created. -* **description**: string: The description of the Live Output. -* **hls**: [Hls](#hls): The HLS configuration. -* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. -* **manifestName**: string: The manifest file name. -* **outputSnapTime**: int: The output snapshot time. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' (ReadOnly): The resource state of the Live Output. +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## Hls -### Properties -* **fragmentsPerTsSegment**: int: The amount of fragments per HTTP Live Streaming (HLS) segment. +## JobInput +* **Discriminator**: @odata.type -## StreamingEndpointProperties -### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. -* **availabilitySetName**: string: AvailabilitySet name -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the StreamingEndpoint -* **description**: string: The StreamingEndpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The StreamingEndpoint host name. -* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the StreamingEndpoint. -* **scaleUnits**: int: The number of scale units. - -## StreamingEndpointAccessControl -### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. - -## AkamaiAccessControl -### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list - -## AkamaiSignatureHeaderAuthenticationKey -### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The exact time the authentication key. -* **identifier**: string: identifier of the key - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StreamingLocatorProperties -### Properties -* **alternativeMediaId**: string: An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: ContentKeys used by this Streaming Locator -* **created**: string (ReadOnly): Creation time of Streaming Locator -* **defaultContentKeyPolicyName**: string: Default ContentKeyPolicy used by this Streaming Locator -* **endTime**: string: EndTime of Streaming Locator -* **startTime**: string: StartTime of Streaming Locator -* **streamingLocatorId**: string: StreamingLocatorId of Streaming Locator -* **streamingPolicyName**: string (Required): Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' - -## StreamingLocatorContentKey -### Properties -* **id**: string (Required): ID of Content Key -* **label**: string: Label of Content Key -* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this Content Key -* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' (ReadOnly): Encryption type of Content Key -* **value**: string: Value of Content Key - -## TrackSelection -### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) - -## TrackPropertyCondition -### Properties -* **operation**: 'Equal' | 'Unknown' (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' (Required): Track property type -* **value**: string: Track property value - -## StreamingPolicyProperties -### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme +### Base Properties +* **label**: string: A label that is assigned to a JobInput, 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'. +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## DefaultKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Default Key -## StreamingPolicyContentKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +## JobOutput +* **Discriminator**: @odata.type -## CbcsDrmConfiguration -### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +### Base Properties +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the job completion percentage. The value is an estimate and not intended to be used to predict job completion times. To determine if the JobOutput is complete, use the State property. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. -## StreamingPolicyFairPlayConfiguration -### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. -## StreamingPolicyPlayReadyConfiguration +## JobProperties ### Properties -* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady +* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided correlation data that will be returned in Job completed events. +* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal': 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. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. -## StreamingPolicyWidevineConfiguration +## JobPropertiesCorrelationData ### Properties -* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. +### Additional Properties +* **Additional Properties Type**: string -## EnabledProtocols +## JpgLayer ### Properties -* **dash**: bool (Required): Enable DASH protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable HLS protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. -## CommonEncryptionCenc +## ListContainerSasInput ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' (WriteOnly): The permissions to set on the SAS URL. -## CencDrmConfiguration +## ListContentKeysResponse ### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator -## EnvelopeEncryption +## ListPathsResponse ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customKeyAcquisitionUrlTemplate**: string: KeyAcquisitionUrlTemplate is used to point to user specified service to delivery content keys -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator -## NoEncryption +## LiveEventEncoding ### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **encodingType**: 'Basic' | 'None': The encoding type for Live Event. +* **presetName**: string: The encoding preset name. -## TransformProperties +## LiveEventEndpoint ### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -## TransformOutput +## LiveEventInput ### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob': 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 default is stop. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal': 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. - -## Preset -* **Discriminator**: @odata.type - -### Base Properties -### BuiltInStandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' (Required): The built-in preset to be used for encoding videos. - -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[]: The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[]: The list of outputs to be produced by the encoder. - -### VideoAnalyzerPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **audioInsightsOnly**: bool: Whether to only extract audio insights when processing a video file. - - -## Codec -* **Discriminator**: @odata.type - -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2': The encoding profile to be used when encoding audio with AAC. - -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. - -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. - -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed': Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: 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. - -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. - -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. - +* **accessToken**: string: The access token. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. +* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' (Required): The streaming protocol for the Live Event. -## H264Layer +## LiveEventPreview ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int: The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **entropyMode**: 'Cabac' | 'Cavlc': 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: string: Which level of the H.264 standard should be used when encoding this layer. 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main': Which profile of the H.264 standard should be used when encoding this layer. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. +* **alternativeMediaId**: string: An Alternative Media Identifier associated with the preview url. This identifier can be used to distinguish the preview of different live events for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. +* **previewLocator**: string: The preview locator Guid. +* **streamingPolicyName**: string: The name of streaming policy used for LiveEvent preview -## JpgLayer +## LiveEventPreviewAccessControl ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## PngLayer +## LiveEventProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **created**: string (ReadOnly): The exact time the Live Event was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: The Live Event description. +* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. +* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. +* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. +* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. +* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the Live Event. +* **streamOptions**: 'Default' | 'LowLatency'[]: The stream options. +* **vanityUrl**: bool: The Live Event vanity URL flag. -## Filters +## LiveOutputProperties ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90': The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. +* **assetName**: string (Required): The asset name. +* **created**: string (ReadOnly): The exact time the Live Output was created. +* **description**: string: The description of the Live Output. +* **hls**: [Hls](#hls): The HLS configuration. +* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. +* **manifestName**: string: The manifest file name. +* **outputSnapTime**: int: The output snapshot time. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' (ReadOnly): The resource state of the Live Output. -## Rectangle +## MediaServiceProperties ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -## Deinterlace +## NoEncryption ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off': The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst': The field parity for de-interlacing, defaults to Auto. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -661,112 +606,167 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format +## PngLayer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. + +## Preset * **Discriminator**: @odata.type ### Base Properties -* **filenamePattern**: string: 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. -### JpgFormat +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' (Required): The built-in preset to be used for encoding videos. -### Mp4Format +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[]: The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[]: The list of outputs to be produced by the encoder. -### PngFormat +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **audioInsightsOnly**: bool: Whether to only extract audio insights when processing a video file. -### TransportStreamFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. +## Rectangle +### Properties +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). -## JobProperties +## StorageAccount ### Properties -* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided correlation data that will be returned in Job completed events. -* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal': 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. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. +* **id**: string: 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. +* **type**: 'Primary' | 'Secondary' (Required): The type of the storage account. -## JobPropertiesCorrelationData +## StreamingEndpointAccessControl ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## JobInput -* **Discriminator**: @odata.type +## StreamingEndpointProperties +### Properties +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. +* **availabilitySetName**: string: AvailabilitySet name +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the StreamingEndpoint +* **description**: string: The StreamingEndpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The StreamingEndpoint host name. +* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' (ReadOnly): The resource state of the StreamingEndpoint. +* **scaleUnits**: int: The number of scale units. -### Base Properties -* **label**: string: A label that is assigned to a JobInput, 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'. -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +## StreamingLocatorContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **label**: string: Label of Content Key +* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this Content Key +* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' (ReadOnly): Encryption type of Content Key +* **value**: string: Value of Content Key -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. +## StreamingLocatorProperties +### Properties +* **alternativeMediaId**: string: An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: ContentKeys used by this Streaming Locator +* **created**: string (ReadOnly): Creation time of Streaming Locator +* **defaultContentKeyPolicyName**: string: Default ContentKeyPolicy used by this Streaming Locator +* **endTime**: string: EndTime of Streaming Locator +* **startTime**: string: StartTime of Streaming Locator +* **streamingLocatorId**: string: StreamingLocatorId of Streaming Locator +* **streamingPolicyName**: string (Required): Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay' -### JobInputs -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. +## StreamingPath +### Properties +* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' (ReadOnly): Encryption scheme +* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair +* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' (ReadOnly): Streaming protocol +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key -## JobOutput -* **Discriminator**: @odata.type +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key -### Base Properties -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the job completion percentage. The value is an estimate and not intended to be used to predict job completion times. To determine if the JobOutput is complete, use the State property. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. +## StreamingPolicyPlayReadyConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady -## JobError +## StreamingPolicyProperties ### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme -## JobErrorDetail +## StreamingPolicyWidevineConfiguration ### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. +* **customLicenseAcquisitionUrlTemplate**: string: The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys. -## ListContainerSasInput +## TrackedResourceTags ### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' (WriteOnly): The permissions to set on the SAS URL. +### Additional Properties +* **Additional Properties Type**: string -## AssetContainerSas +## TrackedResourceTags ### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. +### Additional Properties +* **Additional Properties Type**: string -## ListContentKeysResponse +## TrackedResourceTags ### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## ListPathsResponse +## TrackPropertyCondition ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +* **operation**: 'Equal' | 'Unknown' (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' (Required): Track property type +* **value**: string: Track property value -## StreamingPath +## TrackSelection ### Properties -* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' (ReadOnly): Encryption scheme -* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair -* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' (ReadOnly): Streaming protocol +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) + +## TransformOutput +### Properties +* **onError**: 'ContinueJob' | 'StopProcessingJob': 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 default is stop. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal': 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. + +## TransformProperties +### Properties +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. diff --git a/generated/mediaservices/microsoft.media/2018-07-01/types.md b/generated/mediaservices/microsoft.media/2018-07-01/types.md index 5d99080563..e6744ca0fe 100644 --- a/generated/mediaservices/microsoft.media/2018-07-01/types.md +++ b/generated/mediaservices/microsoft.media/2018-07-01/types.md @@ -135,49 +135,19 @@ * **ApiVersion**: 2018-07-01 * **Output**: [ListStreamingLocatorsResponse](#liststreaminglocatorsresponse) -## MediaServiceProperties -### Properties -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. - -## StorageAccount -### Properties -* **id**: string: 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. -* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MediaFilterProperties -### Properties -* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality -* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. -* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. - -## FirstQuality -### Properties -* **bitrate**: int (Required): The first quality bitrate. - -## PresentationTimeRange +## AkamaiAccessControl ### Properties -* **endTimestamp**: int: The absolute end time boundary. -* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. -* **liveBackoffDuration**: int: The relative to end right edge. -* **presentationWindowDuration**: int: The relative to end sliding window. -* **startTimestamp**: int: The absolute start time boundary. -* **timescale**: int: The time scale of time stamps. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## FilterTrackSelection +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. +* **base64Key**: string: authentication key +* **expiration**: string: The expiration time of the authentication key. +* **identifier**: string: identifier of the key -## FilterTrackPropertyCondition +## AssetContainerSas ### Properties -* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. -* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. -* **value**: string (Required): The track property value. +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. ## AssetProperties ### Properties @@ -190,20 +160,77 @@ * **storageAccountName**: string: The name of the storage account. * **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' | string (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. -## ContentKeyPolicyProperties +## AssetStreamingLocator ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **assetName**: string (ReadOnly): Asset Name. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string (ReadOnly): The end time of the Streaming Locator. +* **name**: string (ReadOnly): Streaming Locator name. +* **startTime**: string (ReadOnly): The start time of the Streaming Locator. +* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. -## ContentKeyPolicyOption +## CbcsDrmConfiguration ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## CencDrmConfiguration +### Properties +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## Codec +* **Discriminator**: @odata.type + +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. + +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. + +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. + +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled + +## CommonEncryptionCenc +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -238,18 +265,12 @@ * **widevineTemplate**: string (Required): The Widevine template. -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -265,6 +286,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -281,10 +320,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -336,388 +378,291 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The exact time the Live Event was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: The Live Event description. -* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. -* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. -* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. -* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. -* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the Live Event. -* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. -* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: The Live Event transcription. -* **vanityUrl**: bool: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding -### Properties -* **encodingType**: 'Basic' | 'None' | 'Premium1080p' | 'Standard' | string: The encoding type for Live Event. This value is specified at creation time and cannot be updated. -* **presetName**: string: The encoding preset name. This value is specified at creation time and cannot be updated. - -## LiveEventInput +## DefaultKey ### Properties -* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for Live Event Input. -* **accessToken**: string: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. -* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventInputAccessControl +## Deinterlace ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. -## IPAccessControl +## EnabledProtocols ### Properties -* **allow**: [IPRange](#iprange)[]: The IP allow list. +* **dash**: bool (Required): Enable DASH protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable HLS protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## IPRange +## EnvelopeEncryption ### Properties -* **address**: string: The IP address. -* **name**: string: The friendly name for the IP address range. -* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customKeyAcquisitionUrlTemplate**: 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. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## LiveEventEndpoint +## Filters ### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto -## LiveEventPreview +## FilterTrackPropertyCondition ### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. -* **alternativeMediaId**: string: An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. -* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. -* **streamingPolicyName**: string: The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. +* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. +* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. +* **value**: string (Required): The track property value. -## LiveEventPreviewAccessControl +## FilterTrackSelection ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. -## LiveEventTranscription +## FirstQuality ### Properties -* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. -* **language**: string: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. -* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. +* **bitrate**: int (Required): The first quality bitrate. -## LiveEventInputTrackSelection -### Properties -* **operation**: string: Comparing operation. -* **property**: string: Property name to select. -* **value**: string: Property value to select. +## Format +* **Discriminator**: @odata.type -## LiveEventOutputTranscriptionTrack -### Properties -* **trackName**: string (Required): The output track name. +### Base Properties +* **filenamePattern**: string (Required): 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. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. -## LiveOutputProperties +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. + +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. + + +## H264Layer ### Properties -* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. -* **assetName**: string (Required): The asset name. -* **created**: string (ReadOnly): The exact time the Live Output was created. -* **description**: string: The description of the Live Output. -* **hls**: [Hls](#hls): The HLS configuration. -* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. -* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. -* **outputSnapTime**: int: The output snapshot time. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the Live Output. +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **entropyMode**: 'Cabac' | 'Cavlc' | 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. ## Hls ### Properties * **fragmentsPerTsSegment**: int: The amount of fragments per HTTP Live Streaming (HLS) segment. -## StreamingEndpointProperties +## IPAccessControl ### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. -* **availabilitySetName**: string: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the StreamingEndpoint -* **description**: string: The StreamingEndpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The StreamingEndpoint host name. -* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the StreamingEndpoint. -* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +* **allow**: [IPRange](#iprange)[]: The IP allow list. -## StreamingEndpointAccessControl +## IPRange ### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **address**: string: The IP address. +* **name**: string: The friendly name for the IP address range. +* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## AkamaiAccessControl +## JobError ### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## AkamaiSignatureHeaderAuthenticationKey +## JobErrorDetail ### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The expiration time of the authentication key. -* **identifier**: string: identifier of the key +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## JobInput +* **Discriminator**: @odata.type -## StreamingLocatorProperties -### Properties -* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string: The end time of the Streaming Locator. -* **filters**: string[]: A list of asset or account filters which apply to this streaming locator -* **startTime**: string: The start time of the Streaming Locator. -* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (Required): 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' +### Base Properties +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## StreamingLocatorContentKey -### Properties -* **id**: string (Required): ID of Content Key -* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy -* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key -* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key -* **value**: string: Value of Content Key +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. -## TrackSelection -### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## TrackPropertyCondition -### Properties -* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type -* **value**: string: Track property value -## StreamingPolicyProperties -### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme +## JobOutput +* **Discriminator**: @odata.type -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### Base Properties +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **label**: string: 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. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key -## DefaultKey +## JobProperties ### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Default Key +* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. +* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal' | 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. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -## StreamingPolicyContentKey +## JobPropertiesCorrelationData ### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +### Additional Properties +* **Additional Properties Type**: string -## CbcsDrmConfiguration +## JpgLayer ### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. -## StreamingPolicyFairPlayConfiguration +## ListContainerSasInput ### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: 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. +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. -## StreamingPolicyPlayReadyConfiguration +## ListContentKeysResponse ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator -## StreamingPolicyWidevineConfiguration +## ListPathsResponse ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator -## EnabledProtocols +## ListStreamingLocatorsResponse ### Properties -* **dash**: bool (Required): Enable DASH protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable HLS protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. -## CommonEncryptionCenc +## LiveEventEncoding ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **encodingType**: 'Basic' | 'None' | 'Premium1080p' | 'Standard' | string: The encoding type for Live Event. This value is specified at creation time and cannot be updated. +* **presetName**: string: The encoding preset name. This value is specified at creation time and cannot be updated. -## CencDrmConfiguration +## LiveEventEndpoint ### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -## EnvelopeEncryption +## LiveEventInput ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customKeyAcquisitionUrlTemplate**: 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. -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for Live Event Input. +* **accessToken**: string: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. +* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. -## NoEncryption +## LiveEventInputAccessControl ### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## TransformProperties +## LiveEventInputTrackSelection ### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +* **operation**: string: Comparing operation. +* **property**: string: Property name to select. +* **value**: string: Property value to select. -## TransformOutput +## LiveEventOutputTranscriptionTrack ### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. - -## Preset -* **Discriminator**: @odata.type - -### Base Properties -### BuiltInStandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncodingExperimental' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | string (Required): The built-in preset to be used for encoding videos. - -### FaceDetectorPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. -* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. - -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. - -### VideoAnalyzerPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. - - -## Codec -* **Discriminator**: @odata.type - -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. - -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. - -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. - -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: 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. - -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. +* **trackName**: string (Required): The output track name. -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. +## LiveEventPreview +### Properties +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. +* **alternativeMediaId**: string: An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. +* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. +* **streamingPolicyName**: string: The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. +## LiveEventPreviewAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## H264Layer +## LiveEventProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **entropyMode**: 'Cabac' | 'Cavlc' | 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **created**: string (ReadOnly): The exact time the Live Event was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: The Live Event description. +* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. +* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. +* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. +* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. +* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the Live Event. +* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. +* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: The Live Event transcription. +* **vanityUrl**: bool: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. -## JpgLayer +## LiveEventTranscription ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. +* **language**: string: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. +* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. -## PngLayer +## LiveOutputProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. +* **assetName**: string (Required): The asset name. +* **created**: string (ReadOnly): The exact time the Live Output was created. +* **description**: string: The description of the Live Output. +* **hls**: [Hls](#hls): The HLS configuration. +* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. +* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. +* **outputSnapTime**: int: The output snapshot time. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the Live Output. -## Filters +## MediaFilterProperties ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality +* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. +* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. -## Rectangle +## MediaServiceProperties ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -## Deinterlace +## NoEncryption ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -741,127 +686,182 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format +## PngLayer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. + +## PresentationTimeRange +### Properties +* **endTimestamp**: int: The absolute end time boundary. +* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. +* **liveBackoffDuration**: int: The relative to end right edge. +* **presentationWindowDuration**: int: The relative to end sliding window. +* **startTimestamp**: int: The absolute start time boundary. +* **timescale**: int: The time scale of time stamps. + +## Preset * **Discriminator**: @odata.type ### Base Properties -* **filenamePattern**: string (Required): 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. -### JpgFormat +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncodingExperimental' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | string (Required): The built-in preset to be used for encoding videos. -### Mp4Format +### FaceDetectorPreset #### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. +* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. -### PngFormat +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### TransportStreamFormat +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. -## JobProperties +## Rectangle ### Properties -* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. -* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal' | 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. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). -## JobPropertiesCorrelationData +## StorageAccount ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: 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. +* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. -## JobInput -* **Discriminator**: @odata.type +## StreamingEndpointAccessControl +### Properties +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -### Base Properties -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +## StreamingEndpointProperties +### Properties +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. +* **availabilitySetName**: string: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the StreamingEndpoint +* **description**: string: The StreamingEndpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The StreamingEndpoint host name. +* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the StreamingEndpoint. +* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. +## StreamingLocatorContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy +* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key +* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key +* **value**: string: Value of Content Key -### JobInputs -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. +## StreamingLocatorProperties +### Properties +* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string: The end time of the Streaming Locator. +* **filters**: string[]: A list of asset or account filters which apply to this streaming locator +* **startTime**: string: The start time of the Streaming Locator. +* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (Required): 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' +## StreamingPath +### Properties +* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme +* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair +* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol -## JobOutput -* **Discriminator**: @odata.type +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key -### Base Properties -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **label**: string: 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. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: 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. -## JobError +## StreamingPolicyPlayReadyConfiguration ### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. +* **customLicenseAcquisitionUrlTemplate**: 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. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady -## JobErrorDetail +## StreamingPolicyProperties ### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme -## ListContainerSasInput +## StreamingPolicyWidevineConfiguration ### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. +* **customLicenseAcquisitionUrlTemplate**: 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. -## AssetContainerSas +## TrackedResourceTags ### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. +### Additional Properties +* **Additional Properties Type**: string -## ListContentKeysResponse +## TrackedResourceTags ### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## ListPathsResponse +## TrackedResourceTags ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## StreamingPath +## TrackPropertyCondition ### Properties -* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme -* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair -* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol +* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type +* **value**: string: Track property value -## ListStreamingLocatorsResponse +## TrackSelection ### Properties -* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) -## AssetStreamingLocator +## TransformOutput ### Properties -* **assetName**: string (ReadOnly): Asset Name. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string (ReadOnly): The end time of the Streaming Locator. -* **name**: string (ReadOnly): Streaming Locator name. -* **startTime**: string (ReadOnly): The start time of the Streaming Locator. -* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. +* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. + +## TransformProperties +### Properties +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. diff --git a/generated/mediaservices/microsoft.media/2019-05-01-preview/types.md b/generated/mediaservices/microsoft.media/2019-05-01-preview/types.md index 0434be18c3..b1719eb11a 100644 --- a/generated/mediaservices/microsoft.media/2019-05-01-preview/types.md +++ b/generated/mediaservices/microsoft.media/2019-05-01-preview/types.md @@ -135,49 +135,19 @@ * **ApiVersion**: 2019-05-01-preview * **Output**: [ListStreamingLocatorsResponse](#liststreaminglocatorsresponse) -## MediaServiceProperties -### Properties -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. - -## StorageAccount -### Properties -* **id**: string: 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. -* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MediaFilterProperties -### Properties -* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality -* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. -* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. - -## FirstQuality -### Properties -* **bitrate**: int (Required): The first quality bitrate. - -## PresentationTimeRange +## AkamaiAccessControl ### Properties -* **endTimestamp**: int: The absolute end time boundary. -* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. -* **liveBackoffDuration**: int: The relative to end right edge. -* **presentationWindowDuration**: int: The relative to end sliding window. -* **startTimestamp**: int: The absolute start time boundary. -* **timescale**: int: The time scale of time stamps. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## FilterTrackSelection +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. +* **base64Key**: string: authentication key +* **expiration**: string: The expiration time of the authentication key. +* **identifier**: string: identifier of the key -## FilterTrackPropertyCondition +## AssetContainerSas ### Properties -* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. -* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. -* **value**: string (Required): The track property value. +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. ## AssetProperties ### Properties @@ -190,20 +160,77 @@ * **storageAccountName**: string: The name of the storage account. * **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' | string (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. -## ContentKeyPolicyProperties +## AssetStreamingLocator ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **assetName**: string (ReadOnly): Asset Name. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string (ReadOnly): The end time of the Streaming Locator. +* **name**: string (ReadOnly): Streaming Locator name. +* **startTime**: string (ReadOnly): The start time of the Streaming Locator. +* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. -## ContentKeyPolicyOption +## CbcsDrmConfiguration ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## CencDrmConfiguration +### Properties +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## Codec +* **Discriminator**: @odata.type + +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. + +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. + +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. + +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled + +## CommonEncryptionCenc +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -238,18 +265,12 @@ * **widevineTemplate**: string (Required): The Widevine template. -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -265,6 +286,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -281,10 +320,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -336,388 +378,291 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The exact time the Live Event was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: The Live Event description. -* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. -* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. -* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. -* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. -* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the Live Event. -* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. -* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: The Live Event transcription. -* **vanityUrl**: bool: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding -### Properties -* **encodingType**: 'Basic' | 'None' | 'Premium1080p' | 'Standard' | string: The encoding type for Live Event. This value is specified at creation time and cannot be updated. -* **presetName**: string: The encoding preset name. This value is specified at creation time and cannot be updated. - -## LiveEventInput +## DefaultKey ### Properties -* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for Live Event Input. -* **accessToken**: string: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. -* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventInputAccessControl +## Deinterlace ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. -## IPAccessControl +## EnabledProtocols ### Properties -* **allow**: [IPRange](#iprange)[]: The IP allow list. +* **dash**: bool (Required): Enable DASH protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable HLS protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## IPRange +## EnvelopeEncryption ### Properties -* **address**: string: The IP address. -* **name**: string: The friendly name for the IP address range. -* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customKeyAcquisitionUrlTemplate**: 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. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## LiveEventEndpoint +## Filters ### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto -## LiveEventPreview +## FilterTrackPropertyCondition ### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. -* **alternativeMediaId**: string: An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. -* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. -* **streamingPolicyName**: string: The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. +* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. +* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. +* **value**: string (Required): The track property value. -## LiveEventPreviewAccessControl +## FilterTrackSelection ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. -## LiveEventTranscription +## FirstQuality ### Properties -* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. -* **language**: string: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. -* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. +* **bitrate**: int (Required): The first quality bitrate. -## LiveEventInputTrackSelection -### Properties -* **operation**: string: Comparing operation. -* **property**: string: Property name to select. -* **value**: string: Property value to select. +## Format +* **Discriminator**: @odata.type -## LiveEventOutputTranscriptionTrack -### Properties -* **trackName**: string (Required): The output track name. +### Base Properties +* **filenamePattern**: string (Required): 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. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. -## LiveOutputProperties +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. + +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. + + +## H264Layer ### Properties -* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. -* **assetName**: string (Required): The asset name. -* **created**: string (ReadOnly): The exact time the Live Output was created. -* **description**: string: The description of the Live Output. -* **hls**: [Hls](#hls): The HLS configuration. -* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. -* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. -* **outputSnapTime**: int: The output snapshot time. -* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the Live Output. +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **entropyMode**: 'Cabac' | 'Cavlc' | 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. ## Hls ### Properties * **fragmentsPerTsSegment**: int: The amount of fragments per HTTP Live Streaming (HLS) segment. -## StreamingEndpointProperties +## IPAccessControl ### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. -* **availabilitySetName**: string: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the StreamingEndpoint -* **description**: string: The StreamingEndpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The StreamingEndpoint host name. -* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the StreamingEndpoint. -* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +* **allow**: [IPRange](#iprange)[]: The IP allow list. -## StreamingEndpointAccessControl +## IPRange ### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **address**: string: The IP address. +* **name**: string: The friendly name for the IP address range. +* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## AkamaiAccessControl +## JobError ### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## AkamaiSignatureHeaderAuthenticationKey +## JobErrorDetail ### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The expiration time of the authentication key. -* **identifier**: string: identifier of the key +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## JobInput +* **Discriminator**: @odata.type -## StreamingLocatorProperties -### Properties -* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string: The end time of the Streaming Locator. -* **filters**: string[]: A list of asset or account filters which apply to this streaming locator -* **startTime**: string: The start time of the Streaming Locator. -* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (Required): 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' +### Base Properties +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## StreamingLocatorContentKey -### Properties -* **id**: string (Required): ID of Content Key -* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy -* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key -* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key -* **value**: string: Value of Content Key +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. -## TrackSelection -### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## TrackPropertyCondition -### Properties -* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type -* **value**: string: Track property value -## StreamingPolicyProperties -### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme +## JobOutput +* **Discriminator**: @odata.type -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### Base Properties +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **label**: string: 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. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key -## DefaultKey +## JobProperties ### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Default Key +* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. +* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal' | 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. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -## StreamingPolicyContentKey +## JobPropertiesCorrelationData ### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +### Additional Properties +* **Additional Properties Type**: string -## CbcsDrmConfiguration +## JpgLayer ### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. -## StreamingPolicyFairPlayConfiguration +## ListContainerSasInput ### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: 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. +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. -## StreamingPolicyPlayReadyConfiguration +## ListContentKeysResponse ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator -## StreamingPolicyWidevineConfiguration +## ListPathsResponse ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator -## EnabledProtocols +## ListStreamingLocatorsResponse ### Properties -* **dash**: bool (Required): Enable DASH protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable HLS protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. -## CommonEncryptionCenc +## LiveEventEncoding ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **encodingType**: 'Basic' | 'None' | 'Premium1080p' | 'Standard' | string: The encoding type for Live Event. This value is specified at creation time and cannot be updated. +* **presetName**: string: The encoding preset name. This value is specified at creation time and cannot be updated. -## CencDrmConfiguration +## LiveEventEndpoint ### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -## EnvelopeEncryption +## LiveEventInput ### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customKeyAcquisitionUrlTemplate**: 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. -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for Live Event Input. +* **accessToken**: string: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the Live Event. +* **keyFrameIntervalDuration**: string: ISO 8601 timespan duration of the key frame interval duration. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. -## NoEncryption +## LiveEventInputAccessControl ### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## TransformProperties +## LiveEventInputTrackSelection ### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +* **operation**: string: Comparing operation. +* **property**: string: Property name to select. +* **value**: string: Property value to select. -## TransformOutput +## LiveEventOutputTranscriptionTrack ### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. - -## Preset -* **Discriminator**: @odata.type - -### Base Properties -### BuiltInStandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncodingExperimental' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | string (Required): The built-in preset to be used for encoding videos. - -### FaceDetectorPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. -* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. - -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. - -### VideoAnalyzerPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. - - -## Codec -* **Discriminator**: @odata.type - -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. - -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. - -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. - -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: 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. - -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. +* **trackName**: string (Required): The output track name. -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. +## LiveEventPreview +### Properties +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for Live Event preview. +* **alternativeMediaId**: string: An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. +* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. +* **streamingPolicyName**: string: The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated. +## LiveEventPreviewAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## H264Layer +## LiveEventProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **entropyMode**: 'Cabac' | 'Cavlc' | 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **created**: string (ReadOnly): The exact time the Live Event was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: The Live Event description. +* **encoding**: [LiveEventEncoding](#liveeventencoding): The Live Event encoding. +* **input**: [LiveEventInput](#liveeventinput) (Required): The Live Event input. +* **lastModified**: string (ReadOnly): The exact time the Live Event was last modified. +* **preview**: [LiveEventPreview](#liveeventpreview): The Live Event preview. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Event. +* **resourceState**: 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the Live Event. +* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. +* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: The Live Event transcription. +* **vanityUrl**: bool: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. -## JpgLayer +## LiveEventTranscription ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. +* **language**: string: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. +* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. -## PngLayer +## LiveOutputProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **archiveWindowLength**: string (Required): ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. +* **assetName**: string (Required): The asset name. +* **created**: string (ReadOnly): The exact time the Live Output was created. +* **description**: string: The description of the Live Output. +* **hls**: [Hls](#hls): The HLS configuration. +* **lastModified**: string (ReadOnly): The exact time the Live Output was last modified. +* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. +* **outputSnapTime**: int: The output snapshot time. +* **provisioningState**: string (ReadOnly): The provisioning state of the Live Output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the Live Output. -## Filters +## MediaFilterProperties ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality +* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. +* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. -## Rectangle +## MediaServiceProperties ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -## Deinterlace +## NoEncryption ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -741,127 +686,182 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format +## PngLayer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. + +## PresentationTimeRange +### Properties +* **endTimestamp**: int: The absolute end time boundary. +* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. +* **liveBackoffDuration**: int: The relative to end right edge. +* **presentationWindowDuration**: int: The relative to end sliding window. +* **startTimestamp**: int: The absolute start time boundary. +* **timescale**: int: The time scale of time stamps. + +## Preset * **Discriminator**: @odata.type ### Base Properties -* **filenamePattern**: string (Required): 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. -### JpgFormat +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncodingExperimental' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | string (Required): The built-in preset to be used for encoding videos. -### Mp4Format +### FaceDetectorPreset #### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. +* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. -### PngFormat +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### TransportStreamFormat +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. -## JobProperties +## Rectangle ### Properties -* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. -* **created**: string (ReadOnly): The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal' | 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. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). -## JobPropertiesCorrelationData +## StorageAccount ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: 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. +* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. -## JobInput -* **Discriminator**: @odata.type +## StreamingEndpointAccessControl +### Properties +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -### Base Properties -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +## StreamingEndpointProperties +### Properties +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): StreamingEndpoint access control definition. +* **availabilitySetName**: string: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the StreamingEndpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the StreamingEndpoint +* **description**: string: The StreamingEndpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The StreamingEndpoint host name. +* **lastModified**: string (ReadOnly): The exact time the StreamingEndpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the StreamingEndpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the StreamingEndpoint. +* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. +## StreamingLocatorContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy +* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key +* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key +* **value**: string: Value of Content Key -### JobInputs -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. +## StreamingLocatorProperties +### Properties +* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string: The end time of the Streaming Locator. +* **filters**: string[]: A list of asset or account filters which apply to this streaming locator +* **startTime**: string: The start time of the Streaming Locator. +* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (Required): 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' +## StreamingPath +### Properties +* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme +* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair +* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol -## JobOutput -* **Discriminator**: @odata.type +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key -### Base Properties -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **label**: string: 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. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: 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. -## JobError +## StreamingPolicyPlayReadyConfiguration ### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. +* **customLicenseAcquisitionUrlTemplate**: 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. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady -## JobErrorDetail +## StreamingPolicyProperties ### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme -## ListContainerSasInput +## StreamingPolicyWidevineConfiguration ### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. +* **customLicenseAcquisitionUrlTemplate**: 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. -## AssetContainerSas +## TrackedResourceTags ### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. +### Additional Properties +* **Additional Properties Type**: string -## ListContentKeysResponse +## TrackedResourceTags ### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## ListPathsResponse +## TrackedResourceTags ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## StreamingPath +## TrackPropertyCondition ### Properties -* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme -* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair -* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol +* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type +* **value**: string: Track property value -## ListStreamingLocatorsResponse +## TrackSelection ### Properties -* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) -## AssetStreamingLocator +## TransformOutput ### Properties -* **assetName**: string (ReadOnly): Asset Name. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string (ReadOnly): The end time of the Streaming Locator. -* **name**: string (ReadOnly): Streaming Locator name. -* **startTime**: string (ReadOnly): The start time of the Streaming Locator. -* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. +* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. + +## TransformProperties +### Properties +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. diff --git a/generated/mediaservices/microsoft.media/2020-02-01-preview/types.md b/generated/mediaservices/microsoft.media/2020-02-01-preview/types.md index dd32619bf3..8f493e82b5 100644 --- a/generated/mediaservices/microsoft.media/2020-02-01-preview/types.md +++ b/generated/mediaservices/microsoft.media/2020-02-01-preview/types.md @@ -9,37 +9,25 @@ * **properties**: [MediaGraphProperties](#mediagraphproperties): Class for Media Graph properties. * **type**: 'Microsoft.Media/mediaServices/mediaGraphs' (ReadOnly, DeployTimeConstant): The resource type -## MediaGraphProperties -### Properties -* **created**: string (ReadOnly): Date the Media Graph was created. -* **description**: string: Media Graph description. -* **lastModified**: string (ReadOnly): Date the Media Graph was last modified. -* **sinks**: [MediaGraphSink](#mediagraphsink)[] (Required): Media Graph sinks. -* **sources**: [MediaGraphSource](#mediagraphsource)[] (Required): Media Graph sources. -* **state**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Media Graph state which indicates the resource allocation status for running the media graph pipeline. - -## MediaGraphSink +## MediaGraphCertificateSource * **Discriminator**: @odata.type ### Base Properties -* **inputs**: string[] (Required): Sink inputs. -* **name**: string (Required): Sink name. -### MediaGraphAssetSink +### MediaGraphPemCertificateList #### Properties -* **@odata.type**: '#Microsoft.Media.MediaGraphAssetSink' (Required): The discriminator for derived types. -* **assetName**: string (Required): Asset name. +* **@odata.type**: '#Microsoft.Media.MediaGraphPemCertificateList' (Required): The discriminator for derived types. +* **certificates**: string[] (Required): PEM formatted public certificates, one per entry. -## MediaGraphSource +## MediaGraphCredentials * **Discriminator**: @odata.type ### Base Properties -* **name**: string (Required): Source name. -### MediaGraphRtspSource +### MediaGraphUsernamePasswordCredentials #### Properties -* **@odata.type**: '#Microsoft.Media.MediaGraphRtspSource' (Required): The discriminator for derived types. -* **endpoint**: [MediaGraphEndpoint](#mediagraphendpoint) (Required): Base class for endpoints. -* **transport**: 'Http' | 'Tcp' | string (Required): Underlying RTSP transport. This can be used to enable or disable HTTP tunneling. +* **@odata.type**: '#Microsoft.Media.MediaGraphUsernamePasswordCredentials' (Required): The discriminator for derived types. +* **password**: string (Required): Password for a username/password pair. +* **username**: string (Required): Username for a username/password pair. ## MediaGraphEndpoint @@ -59,25 +47,37 @@ * **validationOptions**: [MediaGraphTlsValidationOptions](#mediagraphtlsvalidationoptions): Options for controlling the authentication of TLS endpoints. -## MediaGraphCredentials +## MediaGraphProperties +### Properties +* **created**: string (ReadOnly): Date the Media Graph was created. +* **description**: string: Media Graph description. +* **lastModified**: string (ReadOnly): Date the Media Graph was last modified. +* **sinks**: [MediaGraphSink](#mediagraphsink)[] (Required): Media Graph sinks. +* **sources**: [MediaGraphSource](#mediagraphsource)[] (Required): Media Graph sources. +* **state**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Media Graph state which indicates the resource allocation status for running the media graph pipeline. + +## MediaGraphSink * **Discriminator**: @odata.type ### Base Properties -### MediaGraphUsernamePasswordCredentials +* **inputs**: string[] (Required): Sink inputs. +* **name**: string (Required): Sink name. +### MediaGraphAssetSink #### Properties -* **@odata.type**: '#Microsoft.Media.MediaGraphUsernamePasswordCredentials' (Required): The discriminator for derived types. -* **password**: string (Required): Password for a username/password pair. -* **username**: string (Required): Username for a username/password pair. +* **@odata.type**: '#Microsoft.Media.MediaGraphAssetSink' (Required): The discriminator for derived types. +* **assetName**: string (Required): Asset name. -## MediaGraphCertificateSource +## MediaGraphSource * **Discriminator**: @odata.type ### Base Properties -### MediaGraphPemCertificateList +* **name**: string (Required): Source name. +### MediaGraphRtspSource #### Properties -* **@odata.type**: '#Microsoft.Media.MediaGraphPemCertificateList' (Required): The discriminator for derived types. -* **certificates**: string[] (Required): PEM formatted public certificates, one per entry. +* **@odata.type**: '#Microsoft.Media.MediaGraphRtspSource' (Required): The discriminator for derived types. +* **endpoint**: [MediaGraphEndpoint](#mediagraphendpoint) (Required): Base class for endpoints. +* **transport**: 'Http' | 'Tcp' | string (Required): Underlying RTSP transport. This can be used to enable or disable HTTP tunneling. ## MediaGraphTlsValidationOptions diff --git a/generated/mediaservices/microsoft.media/2020-05-01/types.md b/generated/mediaservices/microsoft.media/2020-05-01/types.md index 24823886df..7965c2aa2a 100644 --- a/generated/mediaservices/microsoft.media/2020-05-01/types.md +++ b/generated/mediaservices/microsoft.media/2020-05-01/types.md @@ -162,76 +162,24 @@ * **ApiVersion**: 2020-05-01 * **Output**: [ListStreamingLocatorsResponse](#liststreaminglocatorsresponse) -## MediaServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The Principal ID of the identity. -* **tenantId**: string (ReadOnly): The Tenant ID of the identity. -* **type**: 'None' | 'SystemAssigned' | string (Required): The identity type. - -## MediaServiceProperties -### Properties -* **encryption**: [AccountEncryption](#accountencryption) -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -* **storageAuthentication**: 'ManagedIdentity' | 'System' | string - ## AccountEncryption ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) * **type**: 'CustomerKey' | 'SystemKey' | string (Required): The type of key used to encrypt the Account Key. -## KeyVaultProperties -### Properties -* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt the Media Services account, including the key version. -* **keyIdentifier**: string: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). - -## StorageAccount -### Properties -* **id**: string: 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. -* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MediaFilterProperties -### Properties -* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality -* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. -* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. - -## FirstQuality -### Properties -* **bitrate**: int (Required): The first quality bitrate. - -## PresentationTimeRange +## AkamaiAccessControl ### Properties -* **endTimestamp**: int: The absolute end time boundary. -* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. -* **liveBackoffDuration**: int: The relative to end right edge. -* **presentationWindowDuration**: int: The relative to end sliding window. -* **startTimestamp**: int: The absolute start time boundary. -* **timescale**: int: The time scale of time stamps. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## FilterTrackSelection +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. +* **base64Key**: string: authentication key +* **expiration**: string: The expiration time of the authentication key. +* **identifier**: string: identifier of the key -## FilterTrackPropertyCondition +## AssetContainerSas ### Properties -* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. -* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. -* **value**: string (Required): The track property value. +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. ## AssetProperties ### Properties @@ -244,20 +192,100 @@ * **storageAccountName**: string: The name of the storage account. * **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' | string (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. -## ContentKeyPolicyProperties +## AssetStreamingLocator ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **assetName**: string (ReadOnly): Asset Name. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string (ReadOnly): The end time of the Streaming Locator. +* **name**: string (ReadOnly): Streaming Locator name. +* **startTime**: string (ReadOnly): The start time of the Streaming Locator. +* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. -## ContentKeyPolicyOption +## CbcsDrmConfiguration ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## CencDrmConfiguration +### Properties +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## ClipTime +* **Discriminator**: @odata.type + +### Base Properties +### AbsoluteClipTime +#### Properties +* **@odata.type**: '#Microsoft.Media.AbsoluteClipTime' (Required): The discriminator for derived types. +* **time**: string (Required): The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. + +### UtcClipTime +#### Properties +* **@odata.type**: '#Microsoft.Media.UtcClipTime' (Required): The discriminator for derived types. +* **time**: string (Required): The time position on the timeline of the input media based on Utc time. + + +## Codec +* **Discriminator**: @odata.type + +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. + +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. + +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. + +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: 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. + +### H265Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H265Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. +* **layers**: [H265Layer](#h265layer)[]: The collection of output H.265 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: Specifies 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. +* **spriteColumn**: int: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled + +## CommonEncryptionCenc +### Properties +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -298,18 +326,12 @@ * **playbackDurationSeconds**: int (Required): Playback duration * **storageDurationSeconds**: int (Required): Storage duration -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -325,6 +347,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -341,10 +381,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -396,440 +439,398 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The creation time for the live event -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: A description for the live event. -* **encoding**: [LiveEventEncoding](#liveeventencoding): Specifies the live event type and optional encoding settings for encoding live events. -* **hostnamePrefix**: string: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. -* **input**: [LiveEventInput](#liveeventinput) (Required): The live event input. -* **lastModified**: string (ReadOnly): The last modified time of the live event. -* **preview**: [LiveEventPreview](#liveeventpreview): Live event preview settings. -* **provisioningState**: string (ReadOnly): The provisioning state of the live event. -* **resourceState**: 'Allocating' | 'Deleting' | 'Running' | 'StandBy' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. -* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. -* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. -* **useStaticHostname**: bool: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding -### Properties -* **encodingType**: 'None' | 'Premium1080p' | 'Standard' | string: Live event type. When encodingType is set to None, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. -* **keyFrameInterval**: string: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. -* **presetName**: string: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. -* **stretchMode**: 'AutoFit' | 'AutoSize' | 'None' | string: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize - -## LiveEventInput +## DefaultKey ### Properties -* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for live event input. -* **accessToken**: string: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the live event. -* **keyFrameIntervalDuration**: string: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The input protocol for the live event. This is specified at creation time and cannot be updated. +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventInputAccessControl +## Deinterlace ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. -## IPAccessControl +## EdgePolicies ### Properties -* **allow**: [IPRange](#iprange)[]: The IP allow list. +* **usageDataCollectionPolicy**: [EdgeUsageDataCollectionPolicy](#edgeusagedatacollectionpolicy) (ReadOnly) -## IPRange +## EdgeUsageDataCollectionPolicy ### Properties -* **address**: string: The IP address. -* **name**: string: The friendly name for the IP address range. -* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). - -## LiveEventEndpoint -### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. - -## LiveEventPreview -### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for the live event preview endpoint. -* **alternativeMediaId**: string: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. Do not share the preview URL with the live event audience. -* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. -* **streamingPolicyName**: string: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. - -## LiveEventPreviewAccessControl -### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **dataCollectionFrequency**: string (ReadOnly): Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. +* **dataReportingFrequency**: string (ReadOnly): Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. +* **eventHubDetails**: [EdgeUsageDataEventHub](#edgeusagedataeventhub) (ReadOnly) +* **maxAllowedUnreportedUsageDuration**: string (ReadOnly): Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. -## LiveEventTranscription +## EdgeUsageDataEventHub ### Properties -* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. -* **language**: string: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. -* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. +* **name**: string (ReadOnly): Name of the Event Hub where usage will be reported. +* **namespace**: string (ReadOnly): Namespace of the Event Hub where usage will be reported. +* **token**: string (ReadOnly): SAS token needed to interact with Event Hub. -## LiveEventInputTrackSelection +## EnabledProtocols ### Properties -* **operation**: string: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. -* **property**: string: Property name to select. This property is reserved for future use, any value set on this property will be ignored. -* **value**: string: Property value to select. This property is reserved for future use, any value set on this property will be ignored. +* **dash**: bool (Required): Enable DASH protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable HLS protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## LiveEventOutputTranscriptionTrack +## EnvelopeEncryption ### Properties -* **trackName**: string (Required): The output track name. This property is reserved for future use, any value set on this property will be ignored. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customKeyAcquisitionUrlTemplate**: 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. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## TrackedResourceTags +## FaceDetectorPresetExperimentalOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## LiveOutputProperties -### Properties -* **archiveWindowLength**: string (Required): ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. -* **assetName**: string (Required): The asset that the live output will write to. -* **created**: string (ReadOnly): The creation time the live output. -* **description**: string: The description of the live output. -* **hls**: [Hls](#hls): HTTP Live Streaming (HLS) packing setting for the live output. -* **lastModified**: string (ReadOnly): The time the live output was last modified. -* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. -* **outputSnapTime**: int: The initial timestamp that the live output will start at, any content before this value will not be archived. -* **provisioningState**: string (ReadOnly): The provisioning state of the live output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the live output. - -## Hls -### Properties -* **fragmentsPerTsSegment**: int: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. - -## PrivateEndpointConnectionProperties +## Filters ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto -## PrivateEndpoint +## FilterTrackPropertyCondition ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. +* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. +* **value**: string (Required): The track property value. -## PrivateLinkServiceConnectionState +## FilterTrackSelection ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. -## StreamingEndpointProperties +## FirstQuality ### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): Streaming endpoint access control definition. -* **availabilitySetName**: string: This feature is deprecated, do not set a value for this property. -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the streaming endpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the streaming endpoint -* **description**: string: The streaming endpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The streaming endpoint host name. -* **lastModified**: string (ReadOnly): The exact time the streaming endpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the streaming endpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the streaming endpoint. -* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +* **bitrate**: int (Required): The first quality bitrate. -## StreamingEndpointAccessControl -### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +## Format +* **Discriminator**: @odata.type -## AkamaiAccessControl -### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list +### Base Properties +* **filenamePattern**: string (Required): The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {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. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. -## AkamaiSignatureHeaderAuthenticationKey -### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The expiration time of the authentication key. -* **identifier**: string: identifier of the key +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. -## StreamingLocatorProperties -### Properties -* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string: The end time of the Streaming Locator. -* **filters**: string[]: A list of asset or account filters which apply to this streaming locator -* **startTime**: string: The start time of the Streaming Locator. -* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (Required): 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' +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. -## StreamingLocatorContentKey -### Properties -* **id**: string (Required): ID of Content Key -* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy -* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key -* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key -* **value**: string: Value of Content Key -## TrackSelection +## H264Layer ### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **entropyMode**: 'Cabac' | 'Cavlc' | 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. -## TrackPropertyCondition +## H265Layer ### Properties -* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type -* **value**: string: Track property value +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: Specifies 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. +* **bufferWindow**: 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). +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: string: We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Main' | string: We currently support Main. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. -## StreamingPolicyProperties +## Hls ### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme +* **fragmentsPerTsSegment**: int: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +## InputDefinition +* **Discriminator**: @odata.type -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +### Base Properties +* **includedTracks**: [TrackDescriptor](#trackdescriptor)[]: The list of TrackDescriptors which define the metadata and selection of tracks in the input. +### FromAllInputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.FromAllInputFile' (Required): The discriminator for derived types. -## DefaultKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Default Key +### FromEachInputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.FromEachInputFile' (Required): The discriminator for derived types. -## StreamingPolicyContentKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +### InputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.InputFile' (Required): The discriminator for derived types. +* **filename**: string: Name of the file that this input definition applies to. -## CbcsDrmConfiguration -### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## StreamingPolicyFairPlayConfiguration +## IPAccessControl ### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: 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. +* **allow**: [IPRange](#iprange)[]: The IP allow list. -## StreamingPolicyPlayReadyConfiguration +## IPRange ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady +* **address**: string: The IP address. +* **name**: string: The friendly name for the IP address range. +* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## StreamingPolicyWidevineConfiguration +## JobError ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## EnabledProtocols +## JobErrorDetail ### Properties -* **dash**: bool (Required): Enable DASH protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable HLS protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## CommonEncryptionCenc -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +## JobInput +* **Discriminator**: @odata.type -## CencDrmConfiguration -### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +### Base Properties +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## EnvelopeEncryption -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customKeyAcquisitionUrlTemplate**: 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. -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. -## NoEncryption -### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## TransformProperties -### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +### JobInputSequence +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputSequence' (Required): The discriminator for derived types. +* **inputs**: [JobInputClip](#jobinputclip)[]: JobInputs that make up the timeline. -## TransformOutput -### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. -## Preset +## JobInputClip * **Discriminator**: @odata.type ### Base Properties -### BuiltInStandardEncoderPreset +* **end**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. +* **files**: string[]: List of files. Required for JobInputHttp. Maximum of 4000 characters each. +* **inputDefinitions**: [InputDefinition](#inputdefinition)[]: Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. +* **label**: 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'. +* **start**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. +### JobInputAsset #### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncoding' | 'ContentAwareEncodingExperimental' | 'CopyAllBitrateNonInterleaved' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | 'H265AdaptiveStreaming' | 'H265ContentAwareEncoding' | 'H265SingleBitrate1080p' | 'H265SingleBitrate4K' | 'H265SingleBitrate720p' | string (Required): The built-in preset to be used for encoding videos. +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -### FaceDetectorPreset +### JobInputHttp #### Properties -* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. -* **blurType**: 'Black' | 'Box' | 'High' | 'Low' | 'Med' | string: Blur type -* **experimentalOptions**: [FaceDetectorPresetExperimentalOptions](#facedetectorpresetexperimentaloptions): Dictionary containing key value pairs for parameters not exposed in the preset itself -* **mode**: 'Analyze' | 'Combined' | 'Redact' | string: This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. -* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### VideoAnalyzerPreset +## JobOutput +* **Discriminator**: @odata.type + +### Base Properties +* **endTime**: string (ReadOnly): The UTC date and time at which this Job Output finished processing. +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **label**: string: 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. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. +* **startTime**: string (ReadOnly): The UTC date and time at which this Job Output began processing. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset #### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. + + +## JobProperties +### Properties +* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. +* **created**: string (ReadOnly): The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **endTime**: string (ReadOnly): The UTC date and time at which this Job finished processing. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal' | 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. +* **startTime**: string (ReadOnly): The UTC date and time at which this Job began processing. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. + +## JobPropertiesCorrelationData +### Properties +### Additional Properties +* **Additional Properties Type**: string +## JpgLayer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. + +## KeyVaultProperties +### Properties +* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt the Media Services account, including the key version. +* **keyIdentifier**: string: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). + +## ListContainerSasInput +### Properties +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. + +## ListContentKeysResponse +### Properties +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator + +## ListEdgePoliciesInput +### Properties +* **deviceId**: string (WriteOnly): Unique identifier of the edge device. -## FaceDetectorPresetExperimentalOptions +## ListPathsResponse ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator -## Codec -* **Discriminator**: @odata.type +## ListStreamingLocatorsResponse +### Properties +* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. +## LiveEventEncoding +### Properties +* **encodingType**: 'None' | 'Premium1080p' | 'Standard' | string: Live event type. When encodingType is set to None, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. +* **keyFrameInterval**: string: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. +* **presetName**: string: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. +* **stretchMode**: 'AutoFit' | 'AutoSize' | 'None' | string: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. +## LiveEventEndpoint +### Properties +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. +## LiveEventInput +### Properties +* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for live event input. +* **accessToken**: string: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the live event. +* **keyFrameIntervalDuration**: string: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The input protocol for the live event. This is specified at creation time and cannot be updated. -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: 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. +## LiveEventInputAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -### H265Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H265Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. -* **layers**: [H265Layer](#h265layer)[]: The collection of output H.265 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: Specifies 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. +## LiveEventInputTrackSelection +### Properties +* **operation**: string: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. +* **property**: string: Property name to select. This property is reserved for future use, any value set on this property will be ignored. +* **value**: string: Property value to select. This property is reserved for future use, any value set on this property will be ignored. -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. -* **spriteColumn**: int: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. +## LiveEventOutputTranscriptionTrack +### Properties +* **trackName**: string (Required): The output track name. This property is reserved for future use, any value set on this property will be ignored. -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. +## LiveEventPreview +### Properties +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for the live event preview endpoint. +* **alternativeMediaId**: string: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. Do not share the preview URL with the live event audience. +* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. +* **streamingPolicyName**: string: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. +## LiveEventPreviewAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## H264Layer +## LiveEventProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **entropyMode**: 'Cabac' | 'Cavlc' | 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **created**: string (ReadOnly): The creation time for the live event +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: A description for the live event. +* **encoding**: [LiveEventEncoding](#liveeventencoding): Specifies the live event type and optional encoding settings for encoding live events. +* **hostnamePrefix**: string: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. +* **input**: [LiveEventInput](#liveeventinput) (Required): The live event input. +* **lastModified**: string (ReadOnly): The last modified time of the live event. +* **preview**: [LiveEventPreview](#liveeventpreview): Live event preview settings. +* **provisioningState**: string (ReadOnly): The provisioning state of the live event. +* **resourceState**: 'Allocating' | 'Deleting' | 'Running' | 'StandBy' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. +* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. +* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. +* **useStaticHostname**: bool: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state -## H265Layer +## LiveEventTranscription ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: Specifies 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. -* **bufferWindow**: 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). -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: string: We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Main' | string: We currently support Main. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. +* **language**: string: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. +* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. -## JpgLayer +## LiveOutputProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +* **archiveWindowLength**: string (Required): ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. +* **assetName**: string (Required): The asset that the live output will write to. +* **created**: string (ReadOnly): The creation time the live output. +* **description**: string: The description of the live output. +* **hls**: [Hls](#hls): HTTP Live Streaming (HLS) packing setting for the live output. +* **lastModified**: string (ReadOnly): The time the live output was last modified. +* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. +* **outputSnapTime**: int: The initial timestamp that the live output will start at, any content before this value will not be archived. +* **provisioningState**: string (ReadOnly): The provisioning state of the live output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the live output. -## PngLayer +## MediaFilterProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality +* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. +* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. -## Filters +## MediaServiceIdentity ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **principalId**: string (ReadOnly): The Principal ID of the identity. +* **tenantId**: string (ReadOnly): The Tenant ID of the identity. +* **type**: 'None' | 'SystemAssigned' | string (Required): The identity type. -## Rectangle +## MediaServiceProperties ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **encryption**: [AccountEncryption](#accountencryption) +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. +* **storageAuthentication**: 'ManagedIdentity' | 'System' | string -## Deinterlace +## NoEncryption ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -853,124 +854,174 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format -* **Discriminator**: @odata.type - -### Base Properties -* **filenamePattern**: string (Required): The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {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. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. -### JpgFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. - -### Mp4Format -#### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. - -### PngFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. - -### TransportStreamFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. - - -## JobProperties +## PngLayer ### Properties -* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. -* **created**: string (ReadOnly): The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **endTime**: string (ReadOnly): The UTC date and time at which this Job finished processing. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal' | 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. -* **startTime**: string (ReadOnly): The UTC date and time at which this Job began processing. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. -## JobPropertiesCorrelationData +## PresentationTimeRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endTimestamp**: int: The absolute end time boundary. +* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. +* **liveBackoffDuration**: int: The relative to end right edge. +* **presentationWindowDuration**: int: The relative to end sliding window. +* **startTimestamp**: int: The absolute start time boundary. +* **timescale**: int: The time scale of time stamps. -## JobInput +## Preset * **Discriminator**: @odata.type ### Base Properties -### JobInputAsset +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncoding' | 'ContentAwareEncodingExperimental' | 'CopyAllBitrateNonInterleaved' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | 'H265AdaptiveStreaming' | 'H265ContentAwareEncoding' | 'H265SingleBitrate1080p' | 'H265SingleBitrate4K' | 'H265SingleBitrate720p' | string (Required): The built-in preset to be used for encoding videos. -### JobInputHttp +### FaceDetectorPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. +* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. +* **blurType**: 'Black' | 'Box' | 'High' | 'Low' | 'Med' | string: Blur type +* **experimentalOptions**: [FaceDetectorPresetExperimentalOptions](#facedetectorpresetexperimentaloptions): Dictionary containing key value pairs for parameters not exposed in the preset itself +* **mode**: 'Analyze' | 'Combined' | 'Redact' | string: This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. +* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. -### JobInputs +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### JobInputSequence +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputSequence' (Required): The discriminator for derived types. -* **inputs**: [JobInputClip](#jobinputclip)[]: JobInputs that make up the timeline. +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. -## JobInputClip -* **Discriminator**: @odata.type +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -### Base Properties -* **end**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. -* **files**: string[]: List of files. Required for JobInputHttp. Maximum of 4000 characters each. -* **inputDefinitions**: [InputDefinition](#inputdefinition)[]: Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. -* **label**: 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'. -* **start**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## Rectangle +### Properties +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). -## ClipTime -* **Discriminator**: @odata.type +## StorageAccount +### Properties +* **id**: string: 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. +* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. -### Base Properties -### AbsoluteClipTime -#### Properties -* **@odata.type**: '#Microsoft.Media.AbsoluteClipTime' (Required): The discriminator for derived types. -* **time**: string (Required): The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. +## StreamingEndpointAccessControl +### Properties +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -### UtcClipTime -#### Properties -* **@odata.type**: '#Microsoft.Media.UtcClipTime' (Required): The discriminator for derived types. -* **time**: string (Required): The time position on the timeline of the input media based on Utc time. +## StreamingEndpointProperties +### Properties +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): Streaming endpoint access control definition. +* **availabilitySetName**: string: This feature is deprecated, do not set a value for this property. +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the streaming endpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the streaming endpoint +* **description**: string: The streaming endpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The streaming endpoint host name. +* **lastModified**: string (ReadOnly): The exact time the streaming endpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the streaming endpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the streaming endpoint. +* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +## StreamingLocatorContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy +* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key +* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key +* **value**: string: Value of Content Key -## InputDefinition -* **Discriminator**: @odata.type +## StreamingLocatorProperties +### Properties +* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string: The end time of the Streaming Locator. +* **filters**: string[]: A list of asset or account filters which apply to this streaming locator +* **startTime**: string: The start time of the Streaming Locator. +* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (Required): 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' -### Base Properties -* **includedTracks**: [TrackDescriptor](#trackdescriptor)[]: The list of TrackDescriptors which define the metadata and selection of tracks in the input. -### FromAllInputFile -#### Properties -* **@odata.type**: '#Microsoft.Media.FromAllInputFile' (Required): The discriminator for derived types. +## StreamingPath +### Properties +* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme +* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair +* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol -### FromEachInputFile -#### Properties -* **@odata.type**: '#Microsoft.Media.FromEachInputFile' (Required): The discriminator for derived types. +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key -### InputFile -#### Properties -* **@odata.type**: '#Microsoft.Media.InputFile' (Required): The discriminator for derived types. -* **filename**: string: Name of the file that this input definition applies to. +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key + +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: 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. + +## StreamingPolicyPlayReadyConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: 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. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady + +## StreamingPolicyProperties +### Properties +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme + +## StreamingPolicyWidevineConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: 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. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackDescriptor * **Discriminator**: @odata.type @@ -1001,92 +1052,41 @@ * **trackId**: int (Required): Track identifier to select -## JobOutput -* **Discriminator**: @odata.type - -### Base Properties -* **endTime**: string (ReadOnly): The UTC date and time at which this Job Output finished processing. -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **label**: string: 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. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. -* **startTime**: string (ReadOnly): The UTC date and time at which this Job Output began processing. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. - - -## JobError -### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. - -## JobErrorDetail -### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. - -## ListContainerSasInput -### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. - -## AssetContainerSas -### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. - -## ListContentKeysResponse -### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator - -## ListEdgePoliciesInput -### Properties -* **deviceId**: string (WriteOnly): Unique identifier of the edge device. - -## EdgePolicies +## TrackedResourceTags ### Properties -* **usageDataCollectionPolicy**: [EdgeUsageDataCollectionPolicy](#edgeusagedatacollectionpolicy) (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## EdgeUsageDataCollectionPolicy +## TrackedResourceTags ### Properties -* **dataCollectionFrequency**: string (ReadOnly): Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. -* **dataReportingFrequency**: string (ReadOnly): Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. -* **eventHubDetails**: [EdgeUsageDataEventHub](#edgeusagedataeventhub) (ReadOnly) -* **maxAllowedUnreportedUsageDuration**: string (ReadOnly): Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. +### Additional Properties +* **Additional Properties Type**: string -## EdgeUsageDataEventHub +## TrackedResourceTags ### Properties -* **name**: string (ReadOnly): Name of the Event Hub where usage will be reported. -* **namespace**: string (ReadOnly): Namespace of the Event Hub where usage will be reported. -* **token**: string (ReadOnly): SAS token needed to interact with Event Hub. +### Additional Properties +* **Additional Properties Type**: string -## ListPathsResponse +## TrackPropertyCondition ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type +* **value**: string: Track property value -## StreamingPath +## TrackSelection ### Properties -* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme -* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair -* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) -## ListStreamingLocatorsResponse +## TransformOutput ### Properties -* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. +* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. -## AssetStreamingLocator +## TransformProperties ### Properties -* **assetName**: string (ReadOnly): Asset Name. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string (ReadOnly): The end time of the Streaming Locator. -* **name**: string (ReadOnly): Streaming Locator name. -* **startTime**: string (ReadOnly): The start time of the Streaming Locator. -* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. diff --git a/generated/mediaservices/microsoft.media/2021-05-01/types.md b/generated/mediaservices/microsoft.media/2021-05-01/types.md index 849b41256a..84339035aa 100644 --- a/generated/mediaservices/microsoft.media/2021-05-01/types.md +++ b/generated/mediaservices/microsoft.media/2021-05-01/types.md @@ -28,57 +28,63 @@ * **Input**: [ListEdgePoliciesInput](#listedgepoliciesinput) * **Output**: [EdgePolicies](#edgepolicies) -## MediaServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The Principal ID of the identity. -* **tenantId**: string (ReadOnly): The Tenant ID of the identity. -* **type**: 'None' | 'SystemAssigned' | string (Required): The identity type. - -## MediaServiceProperties +## AccessControl ### Properties -* **encryption**: [AccountEncryption](#accountencryption) -* **keyDelivery**: [KeyDelivery](#keydelivery) -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -* **storageAuthentication**: 'ManagedIdentity' | 'System' | string +* **defaultAction**: 'Allow' | 'Deny' | string: The behavior for IP access control in Key Delivery. +* **ipAllowList**: string[]: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ## AccountEncryption ### Properties * **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties) * **type**: 'CustomerKey' | 'SystemKey' | string (Required): The type of key used to encrypt the Account Key. -## KeyVaultProperties +## EdgePolicies ### Properties -* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt the Media Services account, including the key version. -* **keyIdentifier**: string: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). +* **usageDataCollectionPolicy**: [EdgeUsageDataCollectionPolicy](#edgeusagedatacollectionpolicy) (ReadOnly) + +## EdgeUsageDataCollectionPolicy +### Properties +* **dataCollectionFrequency**: string (ReadOnly): Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. +* **dataReportingFrequency**: string (ReadOnly): Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. +* **eventHubDetails**: [EdgeUsageDataEventHub](#edgeusagedataeventhub) (ReadOnly) +* **maxAllowedUnreportedUsageDuration**: string (ReadOnly): Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. + +## EdgeUsageDataEventHub +### Properties +* **name**: string (ReadOnly): Name of the Event Hub where usage will be reported. +* **namespace**: string (ReadOnly): Namespace of the Event Hub where usage will be reported. +* **token**: string (ReadOnly): SAS token needed to interact with Event Hub. ## KeyDelivery ### Properties * **accessControl**: [AccessControl](#accesscontrol) -## AccessControl +## KeyVaultProperties ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: The behavior for IP access control in Key Delivery. -* **ipAllowList**: string[]: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. +* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt the Media Services account, including the key version. +* **keyIdentifier**: string: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). -## StorageAccount +## ListEdgePoliciesInput ### Properties -* **id**: string: 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. -* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. +* **deviceId**: string (WriteOnly): Unique identifier of the edge device. -## SystemData +## MediaServiceIdentity ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **principalId**: string (ReadOnly): The Principal ID of the identity. +* **tenantId**: string (ReadOnly): The Tenant ID of the identity. +* **type**: 'None' | 'SystemAssigned' | string (Required): The identity type. -## TrackedResourceTags +## MediaServiceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **encryption**: [AccountEncryption](#accountencryption) +* **keyDelivery**: [KeyDelivery](#keydelivery) +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. +* **storageAuthentication**: 'ManagedIdentity' | 'System' | string + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnectionProperties ### Properties @@ -86,34 +92,28 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -## ListEdgePoliciesInput -### Properties -* **deviceId**: string (WriteOnly): Unique identifier of the edge device. - -## EdgePolicies +## StorageAccount ### Properties -* **usageDataCollectionPolicy**: [EdgeUsageDataCollectionPolicy](#edgeusagedatacollectionpolicy) (ReadOnly) +* **id**: string: 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. +* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. -## EdgeUsageDataCollectionPolicy +## SystemData ### Properties -* **dataCollectionFrequency**: string (ReadOnly): Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. -* **dataReportingFrequency**: string (ReadOnly): Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. -* **eventHubDetails**: [EdgeUsageDataEventHub](#edgeusagedataeventhub) (ReadOnly) -* **maxAllowedUnreportedUsageDuration**: string (ReadOnly): Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## EdgeUsageDataEventHub +## TrackedResourceTags ### Properties -* **name**: string (ReadOnly): Name of the Event Hub where usage will be reported. -* **namespace**: string (ReadOnly): Namespace of the Event Hub where usage will be reported. -* **token**: string (ReadOnly): SAS token needed to interact with Event Hub. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/mediaservices/microsoft.media/2021-06-01/types.md b/generated/mediaservices/microsoft.media/2021-06-01/types.md index ed8121954e..a57ed77c5f 100644 --- a/generated/mediaservices/microsoft.media/2021-06-01/types.md +++ b/generated/mediaservices/microsoft.media/2021-06-01/types.md @@ -163,31 +163,10 @@ * **ApiVersion**: 2021-06-01 * **Output**: [ListStreamingLocatorsResponse](#liststreaminglocatorsresponse) -## MediaServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The Principal ID of the identity. -* **tenantId**: string (ReadOnly): The Tenant ID of the identity. -* **type**: string (Required): The identity type. -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. - -## UserAssignedManagedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) - -## UserAssignedManagedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID. -* **principalId**: string (ReadOnly): The principal ID. - -## MediaServiceProperties +## AccessControl ### Properties -* **encryption**: [AccountEncryption](#accountencryption) -* **keyDelivery**: [KeyDelivery](#keydelivery) -* **mediaServiceId**: string (ReadOnly): The Media Services account ID. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for resources under the Media Services account. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. -* **storageAuthentication**: 'ManagedIdentity' | 'System' | string +* **defaultAction**: 'Allow' | 'Deny' | string: The behavior for IP access control in Key Delivery. +* **ipAllowList**: string[]: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ## AccountEncryption ### Properties @@ -196,100 +175,125 @@ * **status**: string (ReadOnly): The current status of the Key Vault mapping. * **type**: 'CustomerKey' | 'SystemKey' | string (Required): The type of key used to encrypt the Account Key. -## ResourceIdentity +## AkamaiAccessControl ### Properties -* **userAssignedIdentity**: string: The user assigned managed identity's ARM ID to use when accessing a resource. -* **useSystemAssignedIdentity**: bool (Required): Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## KeyVaultProperties +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt the Media Services account, including the key version. -* **keyIdentifier**: string: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). +* **base64Key**: string: authentication key +* **expiration**: string: The expiration time of the authentication key. +* **identifier**: string: identifier of the key -## KeyDelivery +## AssetContainerSas ### Properties -* **accessControl**: [AccessControl](#accesscontrol) +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. -## AccessControl +## AssetProperties ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: The behavior for IP access control in Key Delivery. -* **ipAllowList**: string[]: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. +* **alternateId**: string: The alternate ID of the Asset. +* **assetId**: string (ReadOnly): The Asset ID. +* **container**: string: The name of the asset blob container. +* **created**: string (ReadOnly): The creation date of the Asset. +* **description**: string: The Asset description. +* **lastModified**: string (ReadOnly): The last modified date of the Asset. +* **storageAccountName**: string: The name of the storage account. +* **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' | string (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. -## StorageAccount +## AssetStreamingLocator ### Properties -* **id**: string: 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. -* **identity**: [ResourceIdentity](#resourceidentity) -* **status**: string (ReadOnly): The current status of the storage account mapping. -* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. +* **assetName**: string (ReadOnly): Asset Name. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string (ReadOnly): The end time of the Streaming Locator. +* **name**: string (ReadOnly): Streaming Locator name. +* **startTime**: string (ReadOnly): The start time of the Streaming Locator. +* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. -## SystemData +## CbcsDrmConfiguration ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## TrackedResourceTags +## CencDrmConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## MediaFilterProperties -### Properties -* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality -* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. -* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. +## ClipTime +* **Discriminator**: @odata.type -## FirstQuality -### Properties -* **bitrate**: int (Required): The first quality bitrate. +### Base Properties +### AbsoluteClipTime +#### Properties +* **@odata.type**: '#Microsoft.Media.AbsoluteClipTime' (Required): The discriminator for derived types. +* **time**: string (Required): The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. -## PresentationTimeRange -### Properties -* **endTimestamp**: int: The absolute end time boundary. -* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. -* **liveBackoffDuration**: int: The relative to end right edge. -* **presentationWindowDuration**: int: The relative to end sliding window. -* **startTimestamp**: int: The absolute start time boundary. -* **timescale**: int: The time scale of time stamps. +### UtcClipTime +#### Properties +* **@odata.type**: '#Microsoft.Media.UtcClipTime' (Required): The discriminator for derived types. +* **time**: string (Required): The time position on the timeline of the input media based on Utc time. -## FilterTrackSelection -### Properties -* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. -## FilterTrackPropertyCondition -### Properties -* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. -* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. -* **value**: string (Required): The track property value. +## Codec +* **Discriminator**: @odata.type -## AssetProperties -### Properties -* **alternateId**: string: The alternate ID of the Asset. -* **assetId**: string (ReadOnly): The Asset ID. -* **container**: string: The name of the asset blob container. -* **created**: string (ReadOnly): The creation date of the Asset. -* **description**: string: The Asset description. -* **lastModified**: string (ReadOnly): The last modified date of the Asset. -* **storageAccountName**: string: The name of the storage account. -* **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' | string (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. -## ContentKeyPolicyProperties +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. + +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. + +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: 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. + +### H265Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H265Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. +* **layers**: [H265Layer](#h265layer)[]: The collection of output H.265 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: Specifies 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. +* **spriteColumn**: int: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## ContentKeyPolicyOption +## CommonEncryptionCenc ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -330,18 +334,12 @@ * **playbackDurationSeconds**: int (Required): Playback duration * **storageDurationSeconds**: int (Required): Storage duration -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -357,6 +355,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -373,10 +389,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -428,452 +447,406 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The creation time for the live event -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: A description for the live event. -* **encoding**: [LiveEventEncoding](#liveeventencoding): Specifies the live event type and optional encoding settings for encoding live events. -* **hostnamePrefix**: string: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. -* **input**: [LiveEventInput](#liveeventinput) (Required): The live event input. -* **lastModified**: string (ReadOnly): The last modified time of the live event. -* **preview**: [LiveEventPreview](#liveeventpreview): Live event preview settings. -* **provisioningState**: string (ReadOnly): The provisioning state of the live event. -* **resourceState**: 'Allocating' | 'Deleting' | 'Running' | 'StandBy' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. -* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. -* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. -* **useStaticHostname**: bool: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding +## DefaultKey ### Properties -* **encodingType**: 'None' | 'PassthroughBasic' | 'PassthroughStandard' | 'Premium1080p' | 'Standard' | string: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. -* **keyFrameInterval**: string: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. -* **presetName**: string: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. -* **stretchMode**: 'AutoFit' | 'AutoSize' | 'None' | string: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize - -## LiveEventInput -### Properties -* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for live event input. -* **accessToken**: string: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the live event. -* **keyFrameIntervalDuration**: string: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The input protocol for the live event. This is specified at creation time and cannot be updated. - -## LiveEventInputAccessControl -### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. - -## IPAccessControl -### Properties -* **allow**: [IPRange](#iprange)[]: The IP allow list. - -## IPRange -### Properties -* **address**: string: The IP address. -* **name**: string: The friendly name for the IP address range. -* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventEndpoint +## Deinterlace ### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. +* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. -## LiveEventPreview +## EdgePolicies ### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for the live event preview endpoint. -* **alternativeMediaId**: string: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. Do not share the preview URL with the live event audience. -* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. -* **streamingPolicyName**: string: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. +* **usageDataCollectionPolicy**: [EdgeUsageDataCollectionPolicy](#edgeusagedatacollectionpolicy) (ReadOnly) -## LiveEventPreviewAccessControl +## EdgeUsageDataCollectionPolicy ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **dataCollectionFrequency**: string (ReadOnly): Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. +* **dataReportingFrequency**: string (ReadOnly): Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. +* **eventHubDetails**: [EdgeUsageDataEventHub](#edgeusagedataeventhub) (ReadOnly) +* **maxAllowedUnreportedUsageDuration**: string (ReadOnly): Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. -## LiveEventTranscription +## EdgeUsageDataEventHub ### Properties -* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. -* **language**: string: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. -* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. +* **name**: string (ReadOnly): Name of the Event Hub where usage will be reported. +* **namespace**: string (ReadOnly): Namespace of the Event Hub where usage will be reported. +* **token**: string (ReadOnly): SAS token needed to interact with Event Hub. -## LiveEventInputTrackSelection +## EnabledProtocols ### Properties -* **operation**: string: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. -* **property**: string: Property name to select. This property is reserved for future use, any value set on this property will be ignored. -* **value**: string: Property value to select. This property is reserved for future use, any value set on this property will be ignored. +* **dash**: bool (Required): Enable DASH protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable HLS protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## LiveEventOutputTranscriptionTrack +## EnvelopeEncryption ### Properties -* **trackName**: string (Required): The output track name. This property is reserved for future use, any value set on this property will be ignored. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customKeyAcquisitionUrlTemplate**: 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. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## TrackedResourceTags +## FaceDetectorPresetExperimentalOptions ### Properties ### Additional Properties * **Additional Properties Type**: string -## LiveOutputProperties -### Properties -* **archiveWindowLength**: string (Required): ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. -* **assetName**: string (Required): The asset that the live output will write to. -* **created**: string (ReadOnly): The creation time the live output. -* **description**: string: The description of the live output. -* **hls**: [Hls](#hls): HTTP Live Streaming (HLS) packing setting for the live output. -* **lastModified**: string (ReadOnly): The time the live output was last modified. -* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. -* **outputSnapTime**: int: The initial timestamp that the live output will start at, any content before this value will not be archived. -* **provisioningState**: string (ReadOnly): The provisioning state of the live output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the live output. - -## Hls -### Properties -* **fragmentsPerTsSegment**: int: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. - -## PrivateEndpointConnectionProperties +## Filters ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto -## PrivateEndpoint +## FilterTrackPropertyCondition ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. +* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. +* **value**: string (Required): The track property value. -## PrivateLinkServiceConnectionState +## FilterTrackSelection ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. -## StreamingEndpointProperties +## FirstQuality ### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): Streaming endpoint access control definition. -* **availabilitySetName**: string: This feature is deprecated, do not set a value for this property. -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the streaming endpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the streaming endpoint -* **description**: string: The streaming endpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The streaming endpoint host name. -* **lastModified**: string (ReadOnly): The exact time the streaming endpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the streaming endpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the streaming endpoint. -* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +* **bitrate**: int (Required): The first quality bitrate. -## StreamingEndpointAccessControl -### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +## Format +* **Discriminator**: @odata.type -## AkamaiAccessControl -### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list +### Base Properties +* **filenamePattern**: string (Required): The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {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. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. -## AkamaiSignatureHeaderAuthenticationKey -### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The expiration time of the authentication key. -* **identifier**: string: identifier of the key +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. -## StreamingLocatorProperties -### Properties -* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string: The end time of the Streaming Locator. -* **filters**: string[]: A list of asset or account filters which apply to this streaming locator -* **startTime**: string: The start time of the Streaming Locator. -* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (Required): 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' +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. -## StreamingLocatorContentKey -### Properties -* **id**: string (Required): ID of Content Key -* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy -* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key -* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key -* **value**: string: Value of Content Key -## TrackSelection +## H264Layer ### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **entropyMode**: 'Cabac' | 'Cavlc' | 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. -## TrackPropertyCondition +## H265Layer ### Properties -* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type -* **value**: string: Track property value +* **@odata.type**: string (Required): The discriminator for derived types. +* **adaptiveBFrame**: bool: Specifies 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. +* **bufferWindow**: 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). +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: string: We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Main' | string: We currently support Main. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. -## StreamingPolicyProperties +## Hls ### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme +* **fragmentsPerTsSegment**: int: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +## InputDefinition +* **Discriminator**: @odata.type -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +### Base Properties +* **includedTracks**: [TrackDescriptor](#trackdescriptor)[]: The list of TrackDescriptors which define the metadata and selection of tracks in the input. +### FromAllInputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.FromAllInputFile' (Required): The discriminator for derived types. -## DefaultKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Default Key +### FromEachInputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.FromEachInputFile' (Required): The discriminator for derived types. -## StreamingPolicyContentKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +### InputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.InputFile' (Required): The discriminator for derived types. +* **filename**: string: Name of the file that this input definition applies to. -## CbcsDrmConfiguration -### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## StreamingPolicyFairPlayConfiguration +## IPAccessControl ### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: 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. +* **allow**: [IPRange](#iprange)[]: The IP allow list. -## StreamingPolicyPlayReadyConfiguration +## IPRange ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady +* **address**: string: The IP address. +* **name**: string: The friendly name for the IP address range. +* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## StreamingPolicyWidevineConfiguration +## JobError ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## EnabledProtocols +## JobErrorDetail ### Properties -* **dash**: bool (Required): Enable DASH protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable HLS protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## CommonEncryptionCenc -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +## JobInput +* **Discriminator**: @odata.type -## CencDrmConfiguration -### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +### Base Properties +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## EnvelopeEncryption -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customKeyAcquisitionUrlTemplate**: 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. -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. -## NoEncryption -### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## TransformProperties -### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +### JobInputSequence +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputSequence' (Required): The discriminator for derived types. +* **inputs**: [JobInputClip](#jobinputclip)[]: JobInputs that make up the timeline. -## TransformOutput -### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. -## Preset +## JobInputClip * **Discriminator**: @odata.type ### Base Properties -### BuiltInStandardEncoderPreset +* **end**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. +* **files**: string[]: List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. +* **inputDefinitions**: [InputDefinition](#inputdefinition)[]: Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. +* **label**: 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'. +* **start**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. +### JobInputAsset #### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **configurations**: [PresetConfigurations](#presetconfigurations): An object of optional configuration settings for encoder. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncoding' | 'ContentAwareEncodingExperimental' | 'CopyAllBitrateNonInterleaved' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | 'H265AdaptiveStreaming' | 'H265ContentAwareEncoding' | 'H265SingleBitrate1080p' | 'H265SingleBitrate4K' | 'H265SingleBitrate720p' | string (Required): The built-in preset to be used for encoding videos. +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -### FaceDetectorPreset +### JobInputHttp #### Properties -* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. -* **blurType**: 'Black' | 'Box' | 'High' | 'Low' | 'Med' | string: Blur type -* **experimentalOptions**: [FaceDetectorPresetExperimentalOptions](#facedetectorpresetexperimentaloptions): Dictionary containing key value pairs for parameters not exposed in the preset itself -* **mode**: 'Analyze' | 'Combined' | 'Redact' | string: This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. -* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### VideoAnalyzerPreset +## JobOutput +* **Discriminator**: @odata.type + +### Base Properties +* **endTime**: string (ReadOnly): The UTC date and time at which this Job Output finished processing. +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **label**: string: 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. +* **presetOverride**: [Preset](#preset): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. +* **startTime**: string (ReadOnly): The UTC date and time at which this Job Output began processing. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset #### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. -## PresetConfigurations +## JobProperties ### Properties -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency. -* **interleaveOutput**: 'InterleavedOutput' | 'NonInterleavedOutput' | string: Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files. -* **keyFrameIntervalInSeconds**: int: The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players. -* **maxBitrateBps**: int: The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity. -* **maxHeight**: int: The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K. -* **maxLayers**: int: The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job. -* **minBitrateBps**: int: The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth. -* **minHeight**: int: The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P. +* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. +* **created**: string (ReadOnly): The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **endTime**: string (ReadOnly): The UTC date and time at which this Job finished processing. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal' | 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. +* **startTime**: string (ReadOnly): The UTC date and time at which this Job began processing. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -## FaceDetectorPresetExperimentalOptions +## JobPropertiesCorrelationData ### Properties ### Additional Properties * **Additional Properties Type**: string -## Codec -* **Discriminator**: @odata.type +## JpgLayer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. +## KeyDelivery +### Properties +* **accessControl**: [AccessControl](#accesscontrol) + +## KeyVaultProperties +### Properties +* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt the Media Services account, including the key version. +* **keyIdentifier**: string: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). + +## ListContainerSasInput +### Properties +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. + +## ListContentKeysResponse +### Properties +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator + +## ListEdgePoliciesInput +### Properties +* **deviceId**: string (WriteOnly): Unique identifier of the edge device. + +## ListPathsResponse +### Properties +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator + +## ListStreamingLocatorsResponse +### Properties +* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. +## LiveEventEncoding +### Properties +* **encodingType**: 'None' | 'PassthroughBasic' | 'PassthroughStandard' | 'Premium1080p' | 'Standard' | string: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. +* **keyFrameInterval**: string: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. +* **presetName**: string: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. +* **stretchMode**: 'AutoFit' | 'AutoSize' | 'None' | string: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. +## LiveEventEndpoint +### Properties +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: 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. +## LiveEventInput +### Properties +* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for live event input. +* **accessToken**: string: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the live event. +* **keyFrameIntervalDuration**: string: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The input protocol for the live event. This is specified at creation time and cannot be updated. -### H265Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H265Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. -* **layers**: [H265Layer](#h265layer)[]: The collection of output H.265 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: Specifies 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. +## LiveEventInputAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. -* **spriteColumn**: int: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. +## LiveEventInputTrackSelection +### Properties +* **operation**: string: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. +* **property**: string: Property name to select. This property is reserved for future use, any value set on this property will be ignored. +* **value**: string: Property value to select. This property is reserved for future use, any value set on this property will be ignored. -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. +## LiveEventOutputTranscriptionTrack +### Properties +* **trackName**: string (Required): The output track name. This property is reserved for future use, any value set on this property will be ignored. +## LiveEventPreview +### Properties +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for the live event preview endpoint. +* **alternativeMediaId**: string: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. Do not share the preview URL with the live event audience. +* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. +* **streamingPolicyName**: string: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. -## H264Layer +## LiveEventPreviewAccessControl ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **entropyMode**: 'Cabac' | 'Cavlc' | 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## H265Layer +## LiveEventProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **adaptiveBFrame**: bool: Specifies 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. -* **bufferWindow**: 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). -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: string: We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Main' | string: We currently support Main. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **created**: string (ReadOnly): The creation time for the live event +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: A description for the live event. +* **encoding**: [LiveEventEncoding](#liveeventencoding): Specifies the live event type and optional encoding settings for encoding live events. +* **hostnamePrefix**: string: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. +* **input**: [LiveEventInput](#liveeventinput) (Required): The live event input. +* **lastModified**: string (ReadOnly): The last modified time of the live event. +* **preview**: [LiveEventPreview](#liveeventpreview): Live event preview settings. +* **provisioningState**: string (ReadOnly): The provisioning state of the live event. +* **resourceState**: 'Allocating' | 'Deleting' | 'Running' | 'StandBy' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. +* **streamOptions**: 'Default' | 'LowLatency' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. +* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. +* **useStaticHostname**: bool: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state -## JpgLayer +## LiveEventTranscription ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. +* **language**: string: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. +* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. -## PngLayer +## LiveOutputProperties ### Properties -* **@odata.type**: string (Required): The discriminator for derived types. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **archiveWindowLength**: string (Required): ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. +* **assetName**: string (Required): The asset that the live output will write to. +* **created**: string (ReadOnly): The creation time the live output. +* **description**: string: The description of the live output. +* **hls**: [Hls](#hls): HTTP Live Streaming (HLS) packing setting for the live output. +* **lastModified**: string (ReadOnly): The time the live output was last modified. +* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. +* **outputSnapTime**: int: The initial timestamp that the live output will start at, any content before this value will not be archived. +* **provisioningState**: string (ReadOnly): The provisioning state of the live output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the live output. -## Filters +## MediaFilterProperties ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality +* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. +* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. -## Rectangle +## MediaServiceIdentity ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **principalId**: string (ReadOnly): The Principal ID of the identity. +* **tenantId**: string (ReadOnly): The Tenant ID of the identity. +* **type**: string (Required): The identity type. +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. -## Deinterlace +## MediaServiceProperties ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. +* **encryption**: [AccountEncryption](#accountencryption) +* **keyDelivery**: [KeyDelivery](#keydelivery) +* **mediaServiceId**: string (ReadOnly): The Media Services account ID. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for resources under the Media Services account. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. +* **storageAuthentication**: 'ManagedIdentity' | 'System' | string + +## NoEncryption +### Properties +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -897,124 +870,193 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format +## PngLayer +### Properties +* **@odata.type**: string (Required): The discriminator for derived types. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. + +## PresentationTimeRange +### Properties +* **endTimestamp**: int: The absolute end time boundary. +* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. +* **liveBackoffDuration**: int: The relative to end right edge. +* **presentationWindowDuration**: int: The relative to end sliding window. +* **startTimestamp**: int: The absolute start time boundary. +* **timescale**: int: The time scale of time stamps. + +## Preset * **Discriminator**: @odata.type ### Base Properties -* **filenamePattern**: string (Required): The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {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. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. -### JpgFormat +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **configurations**: [PresetConfigurations](#presetconfigurations): An object of optional configuration settings for encoder. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncoding' | 'ContentAwareEncodingExperimental' | 'CopyAllBitrateNonInterleaved' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | 'H265AdaptiveStreaming' | 'H265ContentAwareEncoding' | 'H265SingleBitrate1080p' | 'H265SingleBitrate4K' | 'H265SingleBitrate720p' | string (Required): The built-in preset to be used for encoding videos. -### Mp4Format +### FaceDetectorPreset #### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. +* **blurType**: 'Black' | 'Box' | 'High' | 'Low' | 'Med' | string: Blur type +* **experimentalOptions**: [FaceDetectorPresetExperimentalOptions](#facedetectorpresetexperimentaloptions): Dictionary containing key value pairs for parameters not exposed in the preset itself +* **mode**: 'Analyze' | 'Combined' | 'Redact' | string: This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. +* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. -### PngFormat +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### TransportStreamFormat +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. -## JobProperties +## PresetConfigurations ### Properties -* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. -* **created**: string (ReadOnly): The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **endTime**: string (ReadOnly): The UTC date and time at which this Job finished processing. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal' | 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. -* **startTime**: string (ReadOnly): The UTC date and time at which this Job began processing. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency. +* **interleaveOutput**: 'InterleavedOutput' | 'NonInterleavedOutput' | string: Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files. +* **keyFrameIntervalInSeconds**: int: The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players. +* **maxBitrateBps**: int: The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity. +* **maxHeight**: int: The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K. +* **maxLayers**: int: The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job. +* **minBitrateBps**: int: The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth. +* **minHeight**: int: The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P. -## JobPropertiesCorrelationData +## PrivateEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## JobInput -* **Discriminator**: @odata.type - -### Base Properties -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -### JobInputs -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. -### JobInputSequence -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputSequence' (Required): The discriminator for derived types. -* **inputs**: [JobInputClip](#jobinputclip)[]: JobInputs that make up the timeline. +## Rectangle +### Properties +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). +## ResourceIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned managed identity's ARM ID to use when accessing a resource. +* **useSystemAssignedIdentity**: bool (Required): Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. -## JobInputClip -* **Discriminator**: @odata.type +## StorageAccount +### Properties +* **id**: string: 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. +* **identity**: [ResourceIdentity](#resourceidentity) +* **status**: string (ReadOnly): The current status of the storage account mapping. +* **type**: 'Primary' | 'Secondary' | string (Required): The type of the storage account. -### Base Properties -* **end**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. -* **files**: string[]: List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. -* **inputDefinitions**: [InputDefinition](#inputdefinition)[]: Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. -* **label**: 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'. -* **start**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +## StreamingEndpointAccessControl +### Properties +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. +## StreamingEndpointProperties +### Properties +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): Streaming endpoint access control definition. +* **availabilitySetName**: string: This feature is deprecated, do not set a value for this property. +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the streaming endpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the streaming endpoint +* **description**: string: The streaming endpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The streaming endpoint host name. +* **lastModified**: string (ReadOnly): The exact time the streaming endpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the streaming endpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the streaming endpoint. +* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +## StreamingLocatorContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy +* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key +* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key +* **value**: string: Value of Content Key -## ClipTime -* **Discriminator**: @odata.type +## StreamingLocatorProperties +### Properties +* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string: The end time of the Streaming Locator. +* **filters**: string[]: A list of asset or account filters which apply to this streaming locator +* **startTime**: string: The start time of the Streaming Locator. +* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (Required): 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' -### Base Properties -### AbsoluteClipTime -#### Properties -* **@odata.type**: '#Microsoft.Media.AbsoluteClipTime' (Required): The discriminator for derived types. -* **time**: string (Required): The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. +## StreamingPath +### Properties +* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme +* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair +* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol -### UtcClipTime -#### Properties -* **@odata.type**: '#Microsoft.Media.UtcClipTime' (Required): The discriminator for derived types. -* **time**: string (Required): The time position on the timeline of the input media based on Utc time. +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key -## InputDefinition -* **Discriminator**: @odata.type +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: 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. -### Base Properties -* **includedTracks**: [TrackDescriptor](#trackdescriptor)[]: The list of TrackDescriptors which define the metadata and selection of tracks in the input. -### FromAllInputFile -#### Properties -* **@odata.type**: '#Microsoft.Media.FromAllInputFile' (Required): The discriminator for derived types. +## StreamingPolicyPlayReadyConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: 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. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady -### FromEachInputFile -#### Properties -* **@odata.type**: '#Microsoft.Media.FromEachInputFile' (Required): The discriminator for derived types. +## StreamingPolicyProperties +### Properties +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme -### InputFile -#### Properties -* **@odata.type**: '#Microsoft.Media.InputFile' (Required): The discriminator for derived types. -* **filename**: string: Name of the file that this input definition applies to. +## StreamingPolicyWidevineConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: 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. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackDescriptor * **Discriminator**: @odata.type @@ -1045,93 +1087,51 @@ * **trackId**: int (Required): Track identifier to select -## JobOutput -* **Discriminator**: @odata.type - -### Base Properties -* **endTime**: string (ReadOnly): The UTC date and time at which this Job Output finished processing. -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **label**: string: 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. -* **presetOverride**: [Preset](#preset): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. -* **startTime**: string (ReadOnly): The UTC date and time at which this Job Output began processing. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. - - -## JobError -### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. - -## JobErrorDetail -### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. - -## ListContainerSasInput -### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. - -## AssetContainerSas -### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. - -## ListContentKeysResponse +## TrackedResourceTags ### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## ListEdgePoliciesInput +## TrackedResourceTags ### Properties -* **deviceId**: string (WriteOnly): Unique identifier of the edge device. +### Additional Properties +* **Additional Properties Type**: string -## EdgePolicies +## TrackedResourceTags ### Properties -* **usageDataCollectionPolicy**: [EdgeUsageDataCollectionPolicy](#edgeusagedatacollectionpolicy) (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## EdgeUsageDataCollectionPolicy +## TrackPropertyCondition ### Properties -* **dataCollectionFrequency**: string (ReadOnly): Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. -* **dataReportingFrequency**: string (ReadOnly): Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. -* **eventHubDetails**: [EdgeUsageDataEventHub](#edgeusagedataeventhub) (ReadOnly) -* **maxAllowedUnreportedUsageDuration**: string (ReadOnly): Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. +* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type +* **value**: string: Track property value -## EdgeUsageDataEventHub +## TrackSelection ### Properties -* **name**: string (ReadOnly): Name of the Event Hub where usage will be reported. -* **namespace**: string (ReadOnly): Namespace of the Event Hub where usage will be reported. -* **token**: string (ReadOnly): SAS token needed to interact with Event Hub. +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) -## ListPathsResponse +## TransformOutput ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. -## StreamingPath +## TransformProperties ### Properties -* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme -* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair -* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. -## ListStreamingLocatorsResponse +## UserAssignedManagedIdentities ### Properties -* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) -## AssetStreamingLocator +## UserAssignedManagedIdentity ### Properties -* **assetName**: string (ReadOnly): Asset Name. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string (ReadOnly): The end time of the Streaming Locator. -* **name**: string (ReadOnly): Streaming Locator name. -* **startTime**: string (ReadOnly): The start time of the Streaming Locator. -* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. +* **clientId**: string (ReadOnly): The client ID. +* **principalId**: string (ReadOnly): The principal ID. diff --git a/generated/mediaservices/microsoft.media/2021-11-01/types.md b/generated/mediaservices/microsoft.media/2021-11-01/types.md index eee6ea3d67..3599001c12 100644 --- a/generated/mediaservices/microsoft.media/2021-11-01/types.md +++ b/generated/mediaservices/microsoft.media/2021-11-01/types.md @@ -145,43 +145,24 @@ * **ApiVersion**: 2021-11-01 * **Output**: [ListStreamingLocatorsResponse](#liststreaminglocatorsresponse) -## MediaFilterProperties -### Properties -* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality -* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. -* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. - -## FirstQuality -### Properties -* **bitrate**: int (Required): The first quality bitrate. - -## PresentationTimeRange +## AkamaiAccessControl ### Properties -* **endTimestamp**: int: The absolute end time boundary. -* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. -* **liveBackoffDuration**: int: The relative to end right edge. -* **presentationWindowDuration**: int: The relative to end sliding window. -* **startTimestamp**: int: The absolute start time boundary. -* **timescale**: int: The time scale of time stamps. +* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list -## FilterTrackSelection +## AkamaiSignatureHeaderAuthenticationKey ### Properties -* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. +* **base64Key**: string: authentication key +* **expiration**: string: The expiration time of the authentication key. +* **identifier**: string: identifier of the key -## FilterTrackPropertyCondition +## ArmStreamingEndpointCurrentSku ### Properties -* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. -* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. -* **value**: string (Required): The track property value. +* **capacity**: int: The streaming endpoint sku capacity. +* **name**: string (ReadOnly): The streaming endpoint sku name. -## SystemData +## AssetContainerSas ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. ## AssetProperties ### Properties @@ -194,53 +175,106 @@ * **storageAccountName**: string: The name of the storage account. * **storageEncryptionFormat**: 'MediaStorageClientEncryption' | 'None' | string (ReadOnly): The Asset encryption format. One of None or MediaStorageEncryption. +## AssetStreamingLocator +### Properties +* **assetName**: string (ReadOnly): Asset Name. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string (ReadOnly): The end time of the Streaming Locator. +* **name**: string (ReadOnly): Streaming Locator name. +* **startTime**: string (ReadOnly): The start time of the Streaming Locator. +* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. + ## AssetTrackProperties ### Properties * **provisioningState**: 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the asset track. * **track**: [TrackBase](#trackbase): Base type for concrete track types. A derived type must be used to represent the Track. -## TrackBase +## CbcsDrmConfiguration +### Properties +* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## CencDrmConfiguration +### Properties +* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy +* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy + +## ClipTime * **Discriminator**: @odata.type ### Base Properties -### AudioTrack +### AbsoluteClipTime #### Properties -* **@odata.type**: '#Microsoft.Media.AudioTrack' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.AbsoluteClipTime' (Required): The discriminator for derived types. +* **time**: string (Required): The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. -### TextTrack +### UtcClipTime #### Properties -* **@odata.type**: '#Microsoft.Media.TextTrack' (Required): The discriminator for derived types. -* **displayName**: string: The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. -* **fileName**: string: The file name to the source file. This file is located in the storage container of the asset. -* **hlsSettings**: [HlsSettings](#hlssettings): The HLS setting for a text track. -* **languageCode**: string (ReadOnly): The RFC5646 language code for the text track. -* **playerVisibility**: 'Hidden' | 'Visible' | string: When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible". +* **@odata.type**: '#Microsoft.Media.UtcClipTime' (Required): The discriminator for derived types. +* **time**: string (Required): The time position on the timeline of the input media based on Utc time. -### VideoTrack + +## Codec +* **Discriminator**: @odata.type + +### Base Properties +* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. +### AacAudio #### Properties -* **@odata.type**: '#Microsoft.Media.VideoTrack' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. +* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. +### CopyAudio +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. -## HlsSettings -### Properties -* **characteristics**: string: The characteristics for the HLS setting. -* **default**: bool: The default for the HLS setting. -* **forced**: bool: The forced for the HLS setting. +### CopyVideo +#### Properties +* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. -## ContentKeyPolicyProperties +### H264Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. +* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. +* **rateControlMode**: 'ABR' | 'CBR' | 'CRF' | string: The video rate control mode +* **sceneChangeDetection**: bool: 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. + +### H265Video +#### Properties +* **@odata.type**: '#Microsoft.Media.H265Video' (Required): The discriminator for derived types. +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. +* **layers**: [H265Layer](#h265layer)[]: The collection of output H.265 layers to be produced by the encoder. +* **sceneChangeDetection**: bool: Specifies 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. + +### JpgImage +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. +* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. +* **spriteColumn**: int: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. + +### PngImage +#### Properties +* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. +* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. + + +## CommonEncryptionCbcs ### Properties -* **created**: string (ReadOnly): The creation date of the Policy -* **description**: string: A description for the Policy. -* **lastModified**: string (ReadOnly): The last modified date of the Policy -* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. -* **policyId**: string (ReadOnly): The legacy Policy ID. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## ContentKeyPolicyOption +## CommonEncryptionCenc ### Properties -* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. -* **name**: string: The Policy Option description. -* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. -* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## ContentKeyPolicyConfiguration * **Discriminator**: @odata.type @@ -281,18 +315,12 @@ * **playbackDurationSeconds**: int (Required): Playback duration * **storageDurationSeconds**: int (Required): Storage duration -## ContentKeyPolicyPlayReadyLicense +## ContentKeyPolicyOption ### Properties -* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. -* **beginDate**: string: The begin date of license -* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. -* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. -* **expirationDate**: string: The expiration date of license. -* **gracePeriod**: string: The grace period of license. -* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. -* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. -* **relativeBeginDate**: string: The relative begin date of license. -* **relativeExpirationDate**: string: The relative expiration date of license. +* **configuration**: [ContentKeyPolicyConfiguration](#contentkeypolicyconfiguration) (Required): Base class for Content Key Policy configuration. A derived class must be used to create a configuration. +* **name**: string: The Policy Option description. +* **policyOptionId**: string (ReadOnly): The legacy Policy Option ID. +* **restriction**: [ContentKeyPolicyRestriction](#contentkeypolicyrestriction) (Required): Base class for Content Key Policy restrictions. A derived class must be used to create a restriction. ## ContentKeyPolicyPlayReadyContentKeyLocation * **Discriminator**: @odata.type @@ -308,6 +336,24 @@ * **keyId**: string (Required): The content key ID. +## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +### Properties +* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. +* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. + +## ContentKeyPolicyPlayReadyLicense +### Properties +* **allowTestDevices**: bool (Required): A flag indicating whether test devices can use the license. +* **beginDate**: string: The begin date of license +* **contentKeyLocation**: [ContentKeyPolicyPlayReadyContentKeyLocation](#contentkeypolicyplayreadycontentkeylocation) (Required): Base class for content key ID location. A derived class must be used to represent the location. +* **contentType**: 'UltraVioletDownload' | 'UltraVioletStreaming' | 'Unknown' | 'Unspecified' | string (Required): The PlayReady content type. +* **expirationDate**: string: The expiration date of license. +* **gracePeriod**: string: The grace period of license. +* **licenseType**: 'NonPersistent' | 'Persistent' | 'Unknown' | string (Required): The license type. +* **playRight**: [ContentKeyPolicyPlayReadyPlayRight](#contentkeypolicyplayreadyplayright): Configures the Play Right in the PlayReady license. +* **relativeBeginDate**: string: The relative begin date of license. +* **relativeExpirationDate**: string: The relative expiration date of license. + ## ContentKeyPolicyPlayReadyPlayRight ### Properties * **agcAndColorStripeRestriction**: int: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive. @@ -324,10 +370,13 @@ * **uncompressedDigitalAudioOpl**: int: Specifies the output protection level for uncompressed digital audio. * **uncompressedDigitalVideoOpl**: int: Specifies the output protection level for uncompressed digital video. -## ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction +## ContentKeyPolicyProperties ### Properties -* **bestEffort**: bool (Required): Indicates whether this restriction is enforced on a Best Effort basis. -* **configurationData**: int (Required): Configures the restriction control bits. Must be between 0 and 3 inclusive. +* **created**: string (ReadOnly): The creation date of the Policy +* **description**: string: A description for the Policy. +* **lastModified**: string (ReadOnly): The last modified date of the Policy +* **options**: [ContentKeyPolicyOption](#contentkeypolicyoption)[] (Required): The Key Policy options. +* **policyId**: string (ReadOnly): The legacy Policy ID. ## ContentKeyPolicyRestriction * **Discriminator**: @odata.type @@ -379,440 +428,365 @@ * **claimType**: string: Token claim type. * **claimValue**: string: Token claim value. -## LiveEventProperties -### Properties -* **created**: string (ReadOnly): The creation time for the live event -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **description**: string: A description for the live event. -* **encoding**: [LiveEventEncoding](#liveeventencoding): Specifies the live event type and optional encoding settings for encoding live events. -* **hostnamePrefix**: string: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. -* **input**: [LiveEventInput](#liveeventinput) (Required): The live event input. -* **lastModified**: string (ReadOnly): The last modified time of the live event. -* **preview**: [LiveEventPreview](#liveeventpreview): Live event preview settings. -* **provisioningState**: string (ReadOnly): The provisioning state of the live event. -* **resourceState**: 'Allocating' | 'Deleting' | 'Running' | 'StandBy' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. -* **streamOptions**: 'Default' | 'LowLatency' | 'LowLatencyV2' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. -* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. -* **useStaticHostname**: bool: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state - ## CrossSiteAccessPolicies ### Properties * **clientAccessPolicy**: string: The content of clientaccesspolicy.xml used by Silverlight. * **crossDomainPolicy**: string: The content of crossdomain.xml used by Silverlight. -## LiveEventEncoding +## DefaultKey ### Properties -* **encodingType**: 'None' | 'PassthroughBasic' | 'PassthroughStandard' | 'Premium1080p' | 'Standard' | string: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. -* **keyFrameInterval**: string: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. -* **presetName**: string: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. -* **stretchMode**: 'AutoFit' | 'AutoSize' | 'None' | string: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Default Key -## LiveEventInput +## Deinterlace ### Properties -* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for live event input. -* **accessToken**: string: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the live event. -* **keyFrameIntervalDuration**: string: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. -* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The input protocol for the live event. This is specified at creation time and cannot be updated. +* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. +* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. -## LiveEventInputAccessControl +## EnabledProtocols ### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +* **dash**: bool (Required): Enable DASH protocol or not +* **download**: bool (Required): Enable Download protocol or not +* **hls**: bool (Required): Enable HLS protocol or not +* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not -## IPAccessControl +## EnvelopeEncryption ### Properties -* **allow**: [IPRange](#iprange)[]: The IP allow list. +* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted +* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy +* **customKeyAcquisitionUrlTemplate**: 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. +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled -## IPRange +## FaceDetectorPresetExperimentalOptions ### Properties -* **address**: string: The IP address. -* **name**: string: The friendly name for the IP address range. -* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). +### Additional Properties +* **Additional Properties Type**: string -## LiveEventEndpoint +## Filters ### Properties -* **protocol**: string: The endpoint protocol. -* **url**: string: The endpoint URL. +* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. +* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. +* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. +* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto -## LiveEventPreview -### Properties -* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for the live event preview endpoint. -* **alternativeMediaId**: string: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. -* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. Do not share the preview URL with the live event audience. -* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. -* **streamingPolicyName**: string: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. - -## LiveEventPreviewAccessControl -### Properties -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. - -## LiveEventTranscription -### Properties -* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. -* **language**: string: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. -* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. - -## LiveEventInputTrackSelection -### Properties -* **operation**: string: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. -* **property**: string: Property name to select. This property is reserved for future use, any value set on this property will be ignored. -* **value**: string: Property value to select. This property is reserved for future use, any value set on this property will be ignored. - -## LiveEventOutputTranscriptionTrack -### Properties -* **trackName**: string (Required): The output track name. This property is reserved for future use, any value set on this property will be ignored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LiveOutputProperties +## FilterTrackPropertyCondition ### Properties -* **archiveWindowLength**: string (Required): ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. -* **assetName**: string (Required): The asset that the live output will write to. -* **created**: string (ReadOnly): The creation time the live output. -* **description**: string: The description of the live output. -* **hls**: [Hls](#hls): HTTP Live Streaming (HLS) packing setting for the live output. -* **lastModified**: string (ReadOnly): The time the live output was last modified. -* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. -* **outputSnapTime**: int: The initial timestamp that the live output will start at, any content before this value will not be archived. -* **provisioningState**: string (ReadOnly): The provisioning state of the live output. -* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the live output. +* **operation**: 'Equal' | 'NotEqual' | string (Required): The track property condition operation. +* **property**: 'Bitrate' | 'FourCC' | 'Language' | 'Name' | 'Type' | 'Unknown' | string (Required): The track property type. +* **value**: string (Required): The track property value. -## Hls +## FilterTrackSelection ### Properties -* **fragmentsPerTsSegment**: int: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. +* **trackSelections**: [FilterTrackPropertyCondition](#filtertrackpropertycondition)[] (Required): The track selections. -## StreamingEndpointProperties +## FirstQuality ### Properties -* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): Streaming endpoint access control definition. -* **availabilitySetName**: string: This feature is deprecated, do not set a value for this property. -* **cdnEnabled**: bool: The CDN enabled flag. -* **cdnProfile**: string: The CDN profile name. -* **cdnProvider**: string: The CDN provider name. -* **created**: string (ReadOnly): The exact time the streaming endpoint was created. -* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. -* **customHostNames**: string[]: The custom host names of the streaming endpoint -* **description**: string: The streaming endpoint description. -* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. -* **hostName**: string (ReadOnly): The streaming endpoint host name. -* **lastModified**: string (ReadOnly): The exact time the streaming endpoint was last modified. -* **maxCacheAge**: int: Max cache age -* **provisioningState**: string (ReadOnly): The provisioning state of the streaming endpoint. -* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the streaming endpoint. -* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +* **bitrate**: int (Required): The first quality bitrate. -## StreamingEndpointAccessControl -### Properties -* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control -* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. +## Format +* **Discriminator**: @odata.type -## AkamaiAccessControl -### Properties -* **akamaiSignatureHeaderAuthenticationKeyList**: [AkamaiSignatureHeaderAuthenticationKey](#akamaisignatureheaderauthenticationkey)[]: authentication key list +### Base Properties +* **filenamePattern**: string (Required): The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {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. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. +### JpgFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. -## AkamaiSignatureHeaderAuthenticationKey -### Properties -* **base64Key**: string: authentication key -* **expiration**: string: The expiration time of the authentication key. -* **identifier**: string: identifier of the key +### Mp4Format +#### Properties +* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. -## ArmStreamingEndpointCurrentSku -### Properties -* **capacity**: int: The streaming endpoint sku capacity. -* **name**: string (ReadOnly): The streaming endpoint sku name. +### PngFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### TransportStreamFormat +#### Properties +* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. -## StreamingLocatorProperties -### Properties -* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator -* **assetName**: string (Required): Asset Name -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string: The end time of the Streaming Locator. -* **filters**: string[]: A list of asset or account filters which apply to this streaming locator -* **startTime**: string: The start time of the Streaming Locator. -* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (Required): 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' -## StreamingLocatorContentKey +## H264Layer ### Properties -* **id**: string (Required): ID of Content Key -* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy -* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key -* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key -* **value**: string: Value of Content Key +* **adaptiveBFrame**: bool: 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. +* **bufferWindow**: 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). +* **crf**: int: The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 23. +* **entropyMode**: 'Cabac' | 'Cavlc' | 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. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: 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. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. -## TrackSelection +## H265Layer ### Properties -* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) +* **adaptiveBFrame**: bool: Specifies 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. +* **bFrames**: int: 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. +* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. +* **bufferWindow**: 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). +* **crf**: int: The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 28. +* **frameRate**: 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. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **level**: string: We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. +* **maxBitrate**: int: 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. +* **profile**: 'Auto' | 'Main' | 'Main10' | string: We currently support Main. Default is Auto. +* **referenceFrames**: int: 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. +* **slices**: int: 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. +* **width**: 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. -## TrackPropertyCondition +## Hls ### Properties -* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation -* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type -* **value**: string: Track property value +* **fragmentsPerTsSegment**: int: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. -## StreamingPolicyProperties +## HlsSettings ### Properties -* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme -* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme -* **created**: string (ReadOnly): Creation time of Streaming Policy -* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy -* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme -* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme +* **characteristics**: string: The characteristics for the HLS setting. +* **default**: bool: The default for the HLS setting. +* **forced**: bool: The forced for the HLS setting. -## CommonEncryptionCbcs -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CbcsDrmConfiguration](#cbcsdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +## InputDefinition +* **Discriminator**: @odata.type -## StreamingPolicyContentKeys -### Properties -* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme -* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key +### Base Properties +* **includedTracks**: [TrackDescriptor](#trackdescriptor)[]: The list of TrackDescriptors which define the metadata and selection of tracks in the input. +### FromAllInputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.FromAllInputFile' (Required): The discriminator for derived types. -## DefaultKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Default Key +### FromEachInputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.FromEachInputFile' (Required): The discriminator for derived types. -## StreamingPolicyContentKey -### Properties -* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator -* **policyName**: string: Policy used by Content Key -* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +### InputFile +#### Properties +* **@odata.type**: '#Microsoft.Media.InputFile' (Required): The discriminator for derived types. +* **filename**: string: Name of the file that this input definition applies to. -## CbcsDrmConfiguration -### Properties -* **fairPlay**: [StreamingPolicyFairPlayConfiguration](#streamingpolicyfairplayconfiguration): Class to specify configurations of FairPlay in Streaming Policy -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy -## StreamingPolicyFairPlayConfiguration +## IPAccessControl ### Properties -* **allowPersistentLicense**: bool (Required): All license to be persistent or not -* **customLicenseAcquisitionUrlTemplate**: 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. +* **allow**: [IPRange](#iprange)[]: The IP allow list. -## StreamingPolicyPlayReadyConfiguration +## IPRange ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. -* **playReadyCustomAttributes**: string: Custom attributes for PlayReady +* **address**: string: The IP address. +* **name**: string: The friendly name for the IP address range. +* **subnetPrefixLength**: int: The subnet mask prefix length (see CIDR notation). -## StreamingPolicyWidevineConfiguration +## JobError ### Properties -* **customLicenseAcquisitionUrlTemplate**: 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. +* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. +* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. +* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. +* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. +* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. -## EnabledProtocols +## JobErrorDetail ### Properties -* **dash**: bool (Required): Enable DASH protocol or not -* **download**: bool (Required): Enable Download protocol or not -* **hls**: bool (Required): Enable HLS protocol or not -* **smoothStreaming**: bool (Required): Enable SmoothStreaming protocol or not +* **code**: string (ReadOnly): Code describing the error detail. +* **message**: string (ReadOnly): A human-readable representation of the error. -## CommonEncryptionCenc -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **drm**: [CencDrmConfiguration](#cencdrmconfiguration): Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +## JobInput +* **Discriminator**: @odata.type -## CencDrmConfiguration -### Properties -* **playReady**: [StreamingPolicyPlayReadyConfiguration](#streamingpolicyplayreadyconfiguration): Class to specify configurations of PlayReady in Streaming Policy -* **widevine**: [StreamingPolicyWidevineConfiguration](#streamingpolicywidevineconfiguration): Class to specify configurations of Widevine in Streaming Policy +### Base Properties +### JobInputAsset +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -## EnvelopeEncryption -### Properties -* **clearTracks**: [TrackSelection](#trackselection)[]: Representing which tracks should not be encrypted -* **contentKeys**: [StreamingPolicyContentKeys](#streamingpolicycontentkeys): Class to specify properties of all content keys in Streaming Policy -* **customKeyAcquisitionUrlTemplate**: 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. -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputHttp +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. -## NoEncryption -### Properties -* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled +### JobInputs +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. +* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. -## TransformProperties -### Properties -* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: An optional verbose description of the Transform. -* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. +### JobInputSequence +#### Properties +* **@odata.type**: '#Microsoft.Media.JobInputSequence' (Required): The discriminator for derived types. +* **inputs**: [JobInputClip](#jobinputclip)[]: JobInputs that make up the timeline. -## TransformOutput -### Properties -* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. -* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. -## Preset +## JobInputClip * **Discriminator**: @odata.type ### Base Properties -### BuiltInStandardEncoderPreset +* **end**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. +* **files**: string[]: List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. +* **inputDefinitions**: [InputDefinition](#inputdefinition)[]: Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. +* **label**: 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'. +* **start**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. +### JobInputAsset #### Properties -* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. -* **configurations**: [PresetConfigurations](#presetconfigurations): An object of optional configuration settings for encoder. -* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncoding' | 'ContentAwareEncodingExperimental' | 'CopyAllBitrateNonInterleaved' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | 'H265AdaptiveStreaming' | 'H265ContentAwareEncoding' | 'H265SingleBitrate1080p' | 'H265SingleBitrate4K' | 'H265SingleBitrate720p' | string (Required): The built-in preset to be used for encoding videos. +* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the input Asset. -### FaceDetectorPreset +### JobInputHttp #### Properties -* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. -* **blurType**: 'Black' | 'Box' | 'High' | 'Low' | 'Med' | string: Blur type -* **experimentalOptions**: [FaceDetectorPresetExperimentalOptions](#facedetectorpresetexperimentaloptions): Dictionary containing key value pairs for parameters not exposed in the preset itself -* **mode**: 'Analyze' | 'Combined' | 'Redact' | string: This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. -* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. +* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. +* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. -### StandardEncoderPreset -#### Properties -* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. -* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. -* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. -* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### VideoAnalyzerPreset +## JobOutput +* **Discriminator**: @odata.type + +### Base Properties +* **endTime**: string (ReadOnly): The UTC date and time at which this Job Output finished processing. +* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. +* **label**: string: 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. +* **presetOverride**: [Preset](#preset): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. +* **startTime**: string (ReadOnly): The UTC date and time at which this Job Output began processing. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +### JobOutputAsset #### Properties -* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. -* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. +* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. +* **assetName**: string (Required): The name of the output Asset. -## PresetConfigurations +## JobProperties ### Properties -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency. -* **interleaveOutput**: 'InterleavedOutput' | 'NonInterleavedOutput' | string: Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files. -* **keyFrameIntervalInSeconds**: int: The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players. -* **maxBitrateBps**: int: The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity. -* **maxHeight**: int: The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K. -* **maxLayers**: int: The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job. -* **minBitrateBps**: int: The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth. -* **minHeight**: int: The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P. +* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. +* **created**: string (ReadOnly): The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: Optional customer supplied description of the Job. +* **endTime**: string (ReadOnly): The UTC date and time at which this Job finished processing. +* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. +* **lastModified**: string (ReadOnly): The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. +* **priority**: 'High' | 'Low' | 'Normal' | 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. +* **startTime**: string (ReadOnly): The UTC date and time at which this Job began processing. +* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -## FaceDetectorPresetExperimentalOptions +## JobPropertiesCorrelationData ### Properties ### Additional Properties * **Additional Properties Type**: string -## Codec -* **Discriminator**: @odata.type +## JpgLayer +### Properties +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. +* **width**: 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. -### Base Properties -* **label**: string: An optional label for the codec. The label can be used to control muxing behavior. -### AacAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.AacAudio' (Required): The discriminator for derived types. -* **profile**: 'AacLc' | 'HeAacV1' | 'HeAacV2' | string: The encoding profile to be used when encoding audio with AAC. +## ListContainerSasInput +### Properties +* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. +* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. -### CopyAudio -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyAudio' (Required): The discriminator for derived types. +## ListContentKeysResponse +### Properties +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator -### CopyVideo -#### Properties -* **@odata.type**: '#Microsoft.Media.CopyVideo' (Required): The discriminator for derived types. +## ListPathsResponse +### Properties +* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator +* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator -### H264Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H264Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. The default value is Balanced. -* **layers**: [H264Layer](#h264layer)[]: The collection of output H.264 layers to be produced by the encoder. -* **rateControlMode**: 'ABR' | 'CBR' | 'CRF' | string: The video rate control mode -* **sceneChangeDetection**: bool: 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. +## ListStreamingLocatorsResponse +### Properties +* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. -### H265Video -#### Properties -* **@odata.type**: '#Microsoft.Media.H265Video' (Required): The discriminator for derived types. -* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. -* **layers**: [H265Layer](#h265layer)[]: The collection of output H.265 layers to be produced by the encoder. -* **sceneChangeDetection**: bool: Specifies 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. +## LiveEventEncoding +### Properties +* **encodingType**: 'None' | 'PassthroughBasic' | 'PassthroughStandard' | 'Premium1080p' | 'Standard' | string: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. +* **keyFrameInterval**: string: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. +* **presetName**: string: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. +* **stretchMode**: 'AutoFit' | 'AutoSize' | 'None' | string: The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize -### JpgImage -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgImage' (Required): The discriminator for derived types. -* **layers**: [JpgLayer](#jpglayer)[]: A collection of output JPEG image layers to be produced by the encoder. -* **spriteColumn**: int: Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. +## LiveEventEndpoint +### Properties +* **protocol**: string: The endpoint protocol. +* **url**: string: The endpoint URL. -### PngImage -#### Properties -* **@odata.type**: '#Microsoft.Media.PngImage' (Required): The discriminator for derived types. -* **layers**: [PngLayer](#pnglayer)[]: A collection of output PNG image layers to be produced by the encoder. +## LiveEventInput +### Properties +* **accessControl**: [LiveEventInputAccessControl](#liveeventinputaccesscontrol): The IP access control for live event input. +* **accessToken**: string: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The input endpoints for the live event. +* **keyFrameIntervalDuration**: string: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. +* **streamingProtocol**: 'FragmentedMP4' | 'RTMP' | string (Required): The input protocol for the live event. This is specified at creation time and cannot be updated. +## LiveEventInputAccessControl +### Properties +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## H264Layer +## LiveEventInputTrackSelection ### Properties -* **adaptiveBFrame**: bool: 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. -* **bufferWindow**: 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). -* **crf**: int: The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 23. -* **entropyMode**: 'Cabac' | 'Cavlc' | 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. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: 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. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Baseline' | 'High' | 'High422' | 'High444' | 'Main' | string: We currently support Baseline, Main, High, High422, High444. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **operation**: string: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. +* **property**: string: Property name to select. This property is reserved for future use, any value set on this property will be ignored. +* **value**: string: Property value to select. This property is reserved for future use, any value set on this property will be ignored. -## H265Layer +## LiveEventOutputTranscriptionTrack ### Properties -* **adaptiveBFrame**: bool: Specifies 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. -* **bFrames**: int: 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. -* **bitrate**: int (Required): The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. -* **bufferWindow**: 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). -* **crf**: int: The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 28. -* **frameRate**: 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. -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **level**: string: We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. -* **maxBitrate**: int: 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. -* **profile**: 'Auto' | 'Main' | 'Main10' | string: We currently support Main. Default is Auto. -* **referenceFrames**: int: 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. -* **slices**: int: 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. -* **width**: 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. +* **trackName**: string (Required): The output track name. This property is reserved for future use, any value set on this property will be ignored. -## JpgLayer +## LiveEventPreview ### Properties -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **quality**: int: The compression quality of the JPEG output. Range is from 0-100 and the default is 70. -* **width**: 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. +* **accessControl**: [LiveEventPreviewAccessControl](#liveeventpreviewaccesscontrol): The IP access control for the live event preview endpoint. +* **alternativeMediaId**: string: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. +* **endpoints**: [LiveEventEndpoint](#liveeventendpoint)[]: The endpoints for preview. Do not share the preview URL with the live event audience. +* **previewLocator**: string: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. +* **streamingPolicyName**: string: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. -## PngLayer +## LiveEventPreviewAccessControl ### Properties -* **height**: 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. -* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. -* **width**: 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. +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. -## Filters +## LiveEventProperties ### Properties -* **crop**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -* **deinterlace**: [Deinterlace](#deinterlace): Describes the de-interlacing settings. -* **overlays**: [Overlay](#overlay)[]: The properties of overlays to be applied to the input video. These could be audio, image or video overlays. -* **rotation**: 'Auto' | 'None' | 'Rotate0' | 'Rotate180' | 'Rotate270' | 'Rotate90' | string: The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto +* **created**: string (ReadOnly): The creation time for the live event +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **description**: string: A description for the live event. +* **encoding**: [LiveEventEncoding](#liveeventencoding): Specifies the live event type and optional encoding settings for encoding live events. +* **hostnamePrefix**: string: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. +* **input**: [LiveEventInput](#liveeventinput) (Required): The live event input. +* **lastModified**: string (ReadOnly): The last modified time of the live event. +* **preview**: [LiveEventPreview](#liveeventpreview): Live event preview settings. +* **provisioningState**: string (ReadOnly): The provisioning state of the live event. +* **resourceState**: 'Allocating' | 'Deleting' | 'Running' | 'StandBy' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. +* **streamOptions**: 'Default' | 'LowLatency' | 'LowLatencyV2' | string[]: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. +* **transcriptions**: [LiveEventTranscription](#liveeventtranscription)[]: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. +* **useStaticHostname**: bool: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state -## Rectangle +## LiveEventTranscription ### Properties -* **height**: string: 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%). -* **left**: 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%). -* **top**: 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%). -* **width**: 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%). +* **inputTrackSelection**: [LiveEventInputTrackSelection](#liveeventinputtrackselection)[]: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. +* **language**: string: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. +* **outputTranscriptionTrack**: [LiveEventOutputTranscriptionTrack](#liveeventoutputtranscriptiontrack): Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. -## Deinterlace +## LiveOutputProperties ### Properties -* **mode**: 'AutoPixelAdaptive' | 'Off' | string: The deinterlacing mode. Defaults to AutoPixelAdaptive. -* **parity**: 'Auto' | 'BottomFieldFirst' | 'TopFieldFirst' | string: The field parity for de-interlacing, defaults to Auto. +* **archiveWindowLength**: string (Required): ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. +* **assetName**: string (Required): The asset that the live output will write to. +* **created**: string (ReadOnly): The creation time the live output. +* **description**: string: The description of the live output. +* **hls**: [Hls](#hls): HTTP Live Streaming (HLS) packing setting for the live output. +* **lastModified**: string (ReadOnly): The time the live output was last modified. +* **manifestName**: string: The manifest file name. If not provided, the service will generate one automatically. +* **outputSnapTime**: int: The initial timestamp that the live output will start at, any content before this value will not be archived. +* **provisioningState**: string (ReadOnly): The provisioning state of the live output. +* **resourceState**: 'Creating' | 'Deleting' | 'Running' | string (ReadOnly): The resource state of the live output. + +## MediaFilterProperties +### Properties +* **firstQuality**: [FirstQuality](#firstquality): Filter First Quality +* **presentationTimeRange**: [PresentationTimeRange](#presentationtimerange): The presentation time range, this is asset related and not recommended for Account Filter. +* **tracks**: [FilterTrackSelection](#filtertrackselection)[]: The tracks selection conditions. + +## NoEncryption +### Properties +* **enabledProtocols**: [EnabledProtocols](#enabledprotocols): Class to specify which protocols are enabled ## Overlay * **Discriminator**: @odata.type @@ -836,123 +810,185 @@ * **position**: [Rectangle](#rectangle): Describes the properties of a rectangular window applied to the input media before processing it. -## Format -* **Discriminator**: @odata.type - -### Base Properties -* **filenamePattern**: string (Required): The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {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. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. -### JpgFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.JpgFormat' (Required): The discriminator for derived types. - -### Mp4Format -#### Properties -* **@odata.type**: '#Microsoft.Media.Mp4Format' (Required): The discriminator for derived types. - -### PngFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.PngFormat' (Required): The discriminator for derived types. - -### TransportStreamFormat -#### Properties -* **@odata.type**: '#Microsoft.Media.TransportStreamFormat' (Required): The discriminator for derived types. - - -## JobProperties +## PngLayer ### Properties -* **correlationData**: [JobPropertiesCorrelationData](#jobpropertiescorrelationdata): Customer provided key, value pairs that will be returned in Job and JobOutput state events. -* **created**: string (ReadOnly): The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **description**: string: Optional customer supplied description of the Job. -* **endTime**: string (ReadOnly): The UTC date and time at which this Job finished processing. -* **input**: [JobInput](#jobinput) (Required): Base class for inputs to a Job. -* **lastModified**: string (ReadOnly): The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. -* **outputs**: [JobOutput](#joboutput)[] (Required): The outputs for the Job. -* **priority**: 'High' | 'Low' | 'Normal' | 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. -* **startTime**: string (ReadOnly): The UTC date and time at which this Job began processing. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. +* **height**: 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. +* **label**: string: The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. +* **width**: 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. -## JobPropertiesCorrelationData +## PresentationTimeRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endTimestamp**: int: The absolute end time boundary. +* **forceEndTimestamp**: bool: The indicator of forcing existing of end time stamp. +* **liveBackoffDuration**: int: The relative to end right edge. +* **presentationWindowDuration**: int: The relative to end sliding window. +* **startTimestamp**: int: The absolute start time boundary. +* **timescale**: int: The time scale of time stamps. -## JobInput +## Preset * **Discriminator**: @odata.type ### Base Properties -### JobInputAsset +### BuiltInStandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +* **@odata.type**: '#Microsoft.Media.BuiltInStandardEncoderPreset' (Required): The discriminator for derived types. +* **configurations**: [PresetConfigurations](#presetconfigurations): An object of optional configuration settings for encoder. +* **presetName**: 'AACGoodQualityAudio' | 'AdaptiveStreaming' | 'ContentAwareEncoding' | 'ContentAwareEncodingExperimental' | 'CopyAllBitrateNonInterleaved' | 'H264MultipleBitrate1080p' | 'H264MultipleBitrate720p' | 'H264MultipleBitrateSD' | 'H264SingleBitrate1080p' | 'H264SingleBitrate720p' | 'H264SingleBitrateSD' | 'H265AdaptiveStreaming' | 'H265ContentAwareEncoding' | 'H265SingleBitrate1080p' | 'H265SingleBitrate4K' | 'H265SingleBitrate720p' | string (Required): The built-in preset to be used for encoding videos. -### JobInputHttp +### FaceDetectorPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. +* **@odata.type**: '#Microsoft.Media.FaceDetectorPreset' (Required): The discriminator for derived types. +* **blurType**: 'Black' | 'Box' | 'High' | 'Low' | 'Med' | string: Blur type +* **experimentalOptions**: [FaceDetectorPresetExperimentalOptions](#facedetectorpresetexperimentaloptions): Dictionary containing key value pairs for parameters not exposed in the preset itself +* **mode**: 'Analyze' | 'Combined' | 'Redact' | string: This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. +* **resolution**: 'SourceResolution' | 'StandardDefinition' | string: 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. -### JobInputs +### StandardEncoderPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputs' (Required): The discriminator for derived types. -* **inputs**: [JobInput](#jobinput)[]: List of inputs to a Job. +* **@odata.type**: '#Microsoft.Media.StandardEncoderPreset' (Required): The discriminator for derived types. +* **codecs**: [Codec](#codec)[] (Required): The list of codecs to be used when encoding the input video. +* **filters**: [Filters](#filters): Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. +* **formats**: [Format](#format)[] (Required): The list of outputs to be produced by the encoder. -### JobInputSequence +### VideoAnalyzerPreset #### Properties -* **@odata.type**: '#Microsoft.Media.JobInputSequence' (Required): The discriminator for derived types. -* **inputs**: [JobInputClip](#jobinputclip)[]: JobInputs that make up the timeline. +* **@odata.type**: '#Microsoft.Media.VideoAnalyzerPreset' (Required): The discriminator for derived types. +* **insightsToExtract**: 'AllInsights' | 'AudioInsightsOnly' | 'VideoInsightsOnly' | string: 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. -## JobInputClip -* **Discriminator**: @odata.type +## PresetConfigurations +### Properties +* **complexity**: 'Balanced' | 'Quality' | 'Speed' | string: Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency. +* **interleaveOutput**: 'InterleavedOutput' | 'NonInterleavedOutput' | string: Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files. +* **keyFrameIntervalInSeconds**: int: The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players. +* **maxBitrateBps**: int: The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity. +* **maxHeight**: int: The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K. +* **maxLayers**: int: The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job. +* **minBitrateBps**: int: The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth. +* **minHeight**: int: The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P. -### Base Properties -* **end**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. -* **files**: string[]: List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. -* **inputDefinitions**: [InputDefinition](#inputdefinition)[]: Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. -* **label**: 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'. -* **start**: [ClipTime](#cliptime): Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media. -### JobInputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the input Asset. +## Rectangle +### Properties +* **height**: string: 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%). +* **left**: 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%). +* **top**: 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%). +* **width**: 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%). -### JobInputHttp -#### Properties -* **@odata.type**: '#Microsoft.Media.JobInputHttp' (Required): The discriminator for derived types. -* **baseUri**: string: 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. The query strings will not be returned in service responses to prevent sensitive data exposure. +## StreamingEndpointAccessControl +### Properties +* **akamai**: [AkamaiAccessControl](#akamaiaccesscontrol): Akamai access control +* **ip**: [IPAccessControl](#ipaccesscontrol): The IP access control. + +## StreamingEndpointProperties +### Properties +* **accessControl**: [StreamingEndpointAccessControl](#streamingendpointaccesscontrol): Streaming endpoint access control definition. +* **availabilitySetName**: string: This feature is deprecated, do not set a value for this property. +* **cdnEnabled**: bool: The CDN enabled flag. +* **cdnProfile**: string: The CDN profile name. +* **cdnProvider**: string: The CDN provider name. +* **created**: string (ReadOnly): The exact time the streaming endpoint was created. +* **crossSiteAccessPolicies**: [CrossSiteAccessPolicies](#crosssiteaccesspolicies): The client access policy. +* **customHostNames**: string[]: The custom host names of the streaming endpoint +* **description**: string: The streaming endpoint description. +* **freeTrialEndTime**: string (ReadOnly): The free trial expiration time. +* **hostName**: string (ReadOnly): The streaming endpoint host name. +* **lastModified**: string (ReadOnly): The exact time the streaming endpoint was last modified. +* **maxCacheAge**: int: Max cache age +* **provisioningState**: string (ReadOnly): The provisioning state of the streaming endpoint. +* **resourceState**: 'Deleting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The resource state of the streaming endpoint. +* **scaleUnits**: int (Required): The number of scale units. Use the Scale operation to adjust this value. +## StreamingLocatorContentKey +### Properties +* **id**: string (Required): ID of Content Key +* **labelReferenceInStreamingPolicy**: string: Label of Content Key as specified in the Streaming Policy +* **policyName**: string (ReadOnly): ContentKeyPolicy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[] (ReadOnly): Tracks which use this Content Key +* **type**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | string (ReadOnly): Encryption type of Content Key +* **value**: string: Value of Content Key -## ClipTime -* **Discriminator**: @odata.type +## StreamingLocatorProperties +### Properties +* **alternativeMediaId**: string: Alternative Media ID of this Streaming Locator +* **assetName**: string (Required): Asset Name +* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[]: The ContentKeys used by this Streaming Locator. +* **created**: string (ReadOnly): The creation time of the Streaming Locator. +* **defaultContentKeyPolicyName**: string: Name of the default ContentKeyPolicy used by this Streaming Locator. +* **endTime**: string: The end time of the Streaming Locator. +* **filters**: string[]: A list of asset or account filters which apply to this streaming locator +* **startTime**: string: The start time of the Streaming Locator. +* **streamingLocatorId**: string: The StreamingLocatorId of the Streaming Locator. +* **streamingPolicyName**: string (Required): 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' -### Base Properties -### AbsoluteClipTime -#### Properties -* **@odata.type**: '#Microsoft.Media.AbsoluteClipTime' (Required): The discriminator for derived types. -* **time**: string (Required): The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. +## StreamingPath +### Properties +* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme +* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair +* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol -### UtcClipTime -#### Properties -* **@odata.type**: '#Microsoft.Media.UtcClipTime' (Required): The discriminator for derived types. -* **time**: string (Required): The time position on the timeline of the input media based on Utc time. +## StreamingPolicyContentKey +### Properties +* **label**: string: Label can be used to specify Content Key when creating a Streaming Locator +* **policyName**: string: Policy used by Content Key +* **tracks**: [TrackSelection](#trackselection)[]: Tracks which use this content key +## StreamingPolicyContentKeys +### Properties +* **defaultKey**: [DefaultKey](#defaultkey): Class to specify properties of default content key for each encryption scheme +* **keyToTrackMappings**: [StreamingPolicyContentKey](#streamingpolicycontentkey)[]: Representing tracks needs separate content key -## InputDefinition +## StreamingPolicyFairPlayConfiguration +### Properties +* **allowPersistentLicense**: bool (Required): All license to be persistent or not +* **customLicenseAcquisitionUrlTemplate**: 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. + +## StreamingPolicyPlayReadyConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: 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. +* **playReadyCustomAttributes**: string: Custom attributes for PlayReady + +## StreamingPolicyProperties +### Properties +* **commonEncryptionCbcs**: [CommonEncryptionCbcs](#commonencryptioncbcs): Class for CommonEncryptionCbcs encryption scheme +* **commonEncryptionCenc**: [CommonEncryptionCenc](#commonencryptioncenc): Class for envelope encryption scheme +* **created**: string (ReadOnly): Creation time of Streaming Policy +* **defaultContentKeyPolicyName**: string: Default ContentKey used by current Streaming Policy +* **envelopeEncryption**: [EnvelopeEncryption](#envelopeencryption): Class for EnvelopeEncryption encryption scheme +* **noEncryption**: [NoEncryption](#noencryption): Class for NoEncryption scheme + +## StreamingPolicyWidevineConfiguration +### Properties +* **customLicenseAcquisitionUrlTemplate**: 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. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackBase * **Discriminator**: @odata.type ### Base Properties -* **includedTracks**: [TrackDescriptor](#trackdescriptor)[]: The list of TrackDescriptors which define the metadata and selection of tracks in the input. -### FromAllInputFile +### AudioTrack #### Properties -* **@odata.type**: '#Microsoft.Media.FromAllInputFile' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.AudioTrack' (Required): The discriminator for derived types. -### FromEachInputFile +### TextTrack #### Properties -* **@odata.type**: '#Microsoft.Media.FromEachInputFile' (Required): The discriminator for derived types. +* **@odata.type**: '#Microsoft.Media.TextTrack' (Required): The discriminator for derived types. +* **displayName**: string: The display name of the text track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA. +* **fileName**: string: The file name to the source file. This file is located in the storage container of the asset. +* **hlsSettings**: [HlsSettings](#hlssettings): The HLS setting for a text track. +* **languageCode**: string (ReadOnly): The RFC5646 language code for the text track. +* **playerVisibility**: 'Hidden' | 'Visible' | string: When PlayerVisibility is set to "Visible", the text track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to "Hidden", the text will not be available to the client. The default value is "Visible". -### InputFile +### VideoTrack #### Properties -* **@odata.type**: '#Microsoft.Media.InputFile' (Required): The discriminator for derived types. -* **filename**: string: Name of the file that this input definition applies to. +* **@odata.type**: '#Microsoft.Media.VideoTrack' (Required): The discriminator for derived types. ## TrackDescriptor @@ -984,72 +1020,36 @@ * **trackId**: int (Required): Track identifier to select -## JobOutput -* **Discriminator**: @odata.type - -### Base Properties -* **endTime**: string (ReadOnly): The UTC date and time at which this Job Output finished processing. -* **error**: [JobError](#joberror) (ReadOnly): Details of JobOutput errors. -* **label**: string: 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. -* **presetOverride**: [Preset](#preset): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. -* **progress**: int (ReadOnly): If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. -* **startTime**: string (ReadOnly): The UTC date and time at which this Job Output began processing. -* **state**: 'Canceled' | 'Canceling' | 'Error' | 'Finished' | 'Processing' | 'Queued' | 'Scheduled' | string (ReadOnly): Describes the state of the JobOutput. -### JobOutputAsset -#### Properties -* **@odata.type**: '#Microsoft.Media.JobOutputAsset' (Required): The discriminator for derived types. -* **assetName**: string (Required): The name of the output Asset. - - -## JobError -### Properties -* **category**: 'Configuration' | 'Content' | 'Download' | 'Service' | 'Upload' | string (ReadOnly): Helps with categorization of errors. -* **code**: 'ConfigurationUnsupported' | 'ContentMalformed' | 'ContentUnsupported' | 'DownloadNotAccessible' | 'DownloadTransientError' | 'ServiceError' | 'ServiceTransientError' | 'UploadNotAccessible' | 'UploadTransientError' | string (ReadOnly): Error code describing the error. -* **details**: [JobErrorDetail](#joberrordetail)[] (ReadOnly): An array of details about specific errors that led to this reported error. -* **message**: string (ReadOnly): A human-readable language-dependent representation of the error. -* **retry**: 'DoNotRetry' | 'MayRetry' | string (ReadOnly): Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. - -## JobErrorDetail -### Properties -* **code**: string (ReadOnly): Code describing the error detail. -* **message**: string (ReadOnly): A human-readable representation of the error. - -## ListContainerSasInput -### Properties -* **expiryTime**: string (WriteOnly): The SAS URL expiration time. This must be less than 24 hours from the current time. -* **permissions**: 'Read' | 'ReadWrite' | 'ReadWriteDelete' | string (WriteOnly): The permissions to set on the SAS URL. - -## AssetContainerSas +## TrackedResourceTags ### Properties -* **assetContainerSasUrls**: string[] (ReadOnly): The list of Asset container SAS URLs. +### Additional Properties +* **Additional Properties Type**: string -## ListContentKeysResponse +## TrackedResourceTags ### Properties -* **contentKeys**: [StreamingLocatorContentKey](#streaminglocatorcontentkey)[] (ReadOnly): ContentKeys used by current Streaming Locator +### Additional Properties +* **Additional Properties Type**: string -## ListPathsResponse +## TrackPropertyCondition ### Properties -* **downloadPaths**: string[] (ReadOnly): Download Paths supported by current Streaming Locator -* **streamingPaths**: [StreamingPath](#streamingpath)[] (ReadOnly): Streaming Paths supported by current Streaming Locator +* **operation**: 'Equal' | 'Unknown' | string (Required): Track property condition operation +* **property**: 'FourCC' | 'Unknown' | string (Required): Track property type +* **value**: string: Track property value -## StreamingPath +## TrackSelection ### Properties -* **encryptionScheme**: 'CommonEncryptionCbcs' | 'CommonEncryptionCenc' | 'EnvelopeEncryption' | 'NoEncryption' | string (ReadOnly): Encryption scheme -* **paths**: string[] (ReadOnly): Streaming paths for each protocol and encryptionScheme pair -* **streamingProtocol**: 'Dash' | 'Download' | 'Hls' | 'SmoothStreaming' | string (ReadOnly): Streaming protocol +* **trackSelections**: [TrackPropertyCondition](#trackpropertycondition)[]: TrackSelections is a track property condition list which can specify track(s) -## ListStreamingLocatorsResponse +## TransformOutput ### Properties -* **streamingLocators**: [AssetStreamingLocator](#assetstreaminglocator)[] (ReadOnly): The list of Streaming Locators. +* **onError**: 'ContinueJob' | 'StopProcessingJob' | string: 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'. +* **preset**: [Preset](#preset) (Required): Base type for all Presets, which define the recipe or instructions on how the input media files should be processed. +* **relativePriority**: 'High' | 'Low' | 'Normal' | 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. -## AssetStreamingLocator +## TransformProperties ### Properties -* **assetName**: string (ReadOnly): Asset Name. -* **created**: string (ReadOnly): The creation time of the Streaming Locator. -* **defaultContentKeyPolicyName**: string (ReadOnly): Name of the default ContentKeyPolicy used by this Streaming Locator. -* **endTime**: string (ReadOnly): The end time of the Streaming Locator. -* **name**: string (ReadOnly): Streaming Locator name. -* **startTime**: string (ReadOnly): The start time of the Streaming Locator. -* **streamingLocatorId**: string (ReadOnly): StreamingLocatorId of the Streaming Locator. -* **streamingPolicyName**: string (ReadOnly): Name of the Streaming Policy used by this Streaming Locator. +* **created**: string (ReadOnly): The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **description**: string: An optional verbose description of the Transform. +* **lastModified**: string (ReadOnly): The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. +* **outputs**: [TransformOutput](#transformoutput)[] (Required): An array of one or more TransformOutputs that the Transform should generate. diff --git a/generated/migrate/log.out b/generated/migrate/log.out index dca405788e..ddb33a7b94 100644 --- a/generated/migrate/log.out +++ b/generated/migrate/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.migrate-2018-02-02"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json:1737:5 @@ -22,12 +22,12 @@ warning | PreCheck/SchemaMissingType | The schema 'CheckNameAvailabilityResult' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json:1795:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.migrate-2019-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/migrate.json:1913:5 @@ -40,23 +40,23 @@ info | Processing batch task - {"tag":"microsoft.offazure-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.migrate-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.offazure-2020-07-07"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2020-07-07/migrate.json:6424:5 @@ -64,4 +64,4 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2020-07-07/migrate.json:6433:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms -info | Autorest completed in 20.46s. 10 files generated. +info | Autorest completed in 19.68s. 10 files generated. diff --git a/generated/migrate/microsoft.migrate/2018-02-02/types.md b/generated/migrate/microsoft.migrate/2018-02-02/types.md index cca11c0000..12141c8b76 100644 --- a/generated/migrate/microsoft.migrate/2018-02-02/types.md +++ b/generated/migrate/microsoft.migrate/2018-02-02/types.md @@ -32,28 +32,6 @@ * **properties**: [AssessmentProperties](#assessmentproperties) (Required): Properties of an assessment. * **type**: 'Microsoft.Migrate/projects/groups/assessments' (ReadOnly, DeployTimeConstant): The resource type -## ProjectProperties -### Properties -* **createdTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. -* **customerWorkspaceId**: string: ARM ID of the Service Map workspace created by user. -* **customerWorkspaceLocation**: string: Location of the Service Map workspace created by user. -* **discoveryStatus**: 'Completed' | 'InProgress' | 'NotStarted' | 'Unknown' | string (ReadOnly): Reports whether project is under discovery. -* **lastAssessmentTimestamp**: string (ReadOnly): Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created. -* **lastDiscoverySessionId**: string (ReadOnly): Session id of the last discovery. -* **lastDiscoveryTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. This value will be null until discovery is complete. -* **numberOfAssessments**: int (ReadOnly): Number of assessments created in the project. -* **numberOfGroups**: int (ReadOnly): Number of groups created in the project. -* **numberOfMachines**: int (ReadOnly): Number of machines in the project. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string: Provisioning state of the project. -* **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. - -## GroupProperties -### Properties -* **assessments**: string[] (ReadOnly): List of References to Assessments created on this group. -* **createdTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. -* **machines**: string[] (Required): List of machine names that are part of this group. -* **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. - ## AssessmentProperties ### Properties * **azureHybridUseBenefit**: 'No' | 'Unknown' | 'Yes' | string (Required): AHUB discount on windows virtual machines. @@ -78,3 +56,25 @@ * **timeRange**: 'Day' | 'Month' | 'Week' | string (Required): Time range of performance data used to recommend a size. * **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. +## GroupProperties +### Properties +* **assessments**: string[] (ReadOnly): List of References to Assessments created on this group. +* **createdTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. +* **machines**: string[] (Required): List of machine names that are part of this group. +* **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. + +## ProjectProperties +### Properties +* **createdTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. +* **customerWorkspaceId**: string: ARM ID of the Service Map workspace created by user. +* **customerWorkspaceLocation**: string: Location of the Service Map workspace created by user. +* **discoveryStatus**: 'Completed' | 'InProgress' | 'NotStarted' | 'Unknown' | string (ReadOnly): Reports whether project is under discovery. +* **lastAssessmentTimestamp**: string (ReadOnly): Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created. +* **lastDiscoverySessionId**: string (ReadOnly): Session id of the last discovery. +* **lastDiscoveryTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. This value will be null until discovery is complete. +* **numberOfAssessments**: int (ReadOnly): Number of assessments created in the project. +* **numberOfGroups**: int (ReadOnly): Number of groups created in the project. +* **numberOfMachines**: int (ReadOnly): Number of machines in the project. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string: Provisioning state of the project. +* **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. + diff --git a/generated/migrate/microsoft.migrate/2019-10-01/types.md b/generated/migrate/microsoft.migrate/2019-10-01/types.md index 9ef10d17ac..cf73043c6a 100644 --- a/generated/migrate/microsoft.migrate/2019-10-01/types.md +++ b/generated/migrate/microsoft.migrate/2019-10-01/types.md @@ -82,58 +82,6 @@ * **properties**: [CollectorProperties](#collectorproperties) * **type**: 'Microsoft.Migrate/assessmentProjects/vmwarecollectors' (ReadOnly, DeployTimeConstant): The resource type -## ProjectProperties -### Properties -* **assessmentSolutionId**: string: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. -* **createdTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. -* **customerStorageAccountArmId**: string: The ARM id of the storage account used for interactions when public access is disabled. -* **customerWorkspaceId**: string: The ARM id of service map workspace created by customer. -* **customerWorkspaceLocation**: string: Location of service map workspace created by customer. -* **lastAssessmentTimestamp**: string (ReadOnly): Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created. -* **numberOfAssessments**: int (ReadOnly): Number of assessments created in the project. -* **numberOfGroups**: int (ReadOnly): Number of groups created in the project. -* **numberOfMachines**: int (ReadOnly): Number of machines in the project. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the project. -* **projectStatus**: 'Active' | 'Inactive' | string: Assessment project status. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the project. -* **publicNetworkAccess**: 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. -* **serviceEndpoint**: string (ReadOnly): Endpoint at which the collector agent can call agent REST API. -* **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. - -## PrivateEndpointConnection -### Properties -* **eTag**: string: For optimistic concurrency control. -* **id**: string (ReadOnly): Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName} -* **name**: string (ReadOnly): Name of the private endpoint endpoint connection. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (Required): Private endpoint connection properties. -* **type**: string (ReadOnly): Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections]. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ResourceId](#resourceid) (ReadOnly): ARM id for a resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): State of a private endpoint connection. -* **provisioningState**: 'Accepted' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Indicates whether there is an ongoing operation on the private endpoint. - -## ResourceId -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: Actions required on the private endpoint connection. -* **description**: string: Description of the private endpoint connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Connection status of the private endpoint connection. - -## GroupProperties -### Properties -* **areAssessmentsRunning**: bool (ReadOnly): If the assessments are in running state. -* **assessments**: string[] (ReadOnly): List of References to Assessments created on this group. -* **createdTimestamp**: string (ReadOnly): Time when this group was created. Date-Time represented in ISO-8601 format. -* **groupStatus**: 'Completed' | 'Created' | 'Invalid' | 'Running' | 'Updated' | string (ReadOnly): Whether the group has been created and is valid. -* **groupType**: string: The type of group. -* **machineCount**: int (ReadOnly): Number of machines part of this group. -* **updatedTimestamp**: string (ReadOnly): Time when this group was last updated. Date-Time represented in ISO-8601 format. - ## AssessmentProperties ### Properties * **azureDiskType**: 'Premium' | 'Standard' | 'StandardOrPremium' | 'StandardSSD' | 'Unknown' | string (Required): Storage type selected for this disk. @@ -167,18 +115,6 @@ * **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. * **vmUptime**: [VmUptime](#vmuptime) (Required) -## VmUptime -### Properties -* **daysPerMonth**: int: Number of days in a month for VM uptime. -* **hoursPerDay**: int: Number of hours per day for VM uptime. - -## CollectorProperties -### Properties -* **agentProperties**: [CollectorAgentProperties](#collectoragentproperties) -* **createdTimestamp**: string (ReadOnly): Time when this collector was created. Date-Time represented in ISO-8601 format. -* **discoverySiteId**: string: The ARM id of the discovery service site. -* **updatedTimestamp**: string (ReadOnly): Time when this collector was updated. Date-Time represented in ISO-8601 format. - ## CollectorAgentProperties ### Properties * **id**: string (ReadOnly) @@ -194,9 +130,73 @@ * **objectId**: string: Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. * **tenantId**: string: Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +## CollectorProperties +### Properties +* **agentProperties**: [CollectorAgentProperties](#collectoragentproperties) +* **createdTimestamp**: string (ReadOnly): Time when this collector was created. Date-Time represented in ISO-8601 format. +* **discoverySiteId**: string: The ARM id of the discovery service site. +* **updatedTimestamp**: string (ReadOnly): Time when this collector was updated. Date-Time represented in ISO-8601 format. + +## GroupProperties +### Properties +* **areAssessmentsRunning**: bool (ReadOnly): If the assessments are in running state. +* **assessments**: string[] (ReadOnly): List of References to Assessments created on this group. +* **createdTimestamp**: string (ReadOnly): Time when this group was created. Date-Time represented in ISO-8601 format. +* **groupStatus**: 'Completed' | 'Created' | 'Invalid' | 'Running' | 'Updated' | string (ReadOnly): Whether the group has been created and is valid. +* **groupType**: string: The type of group. +* **machineCount**: int (ReadOnly): Number of machines part of this group. +* **updatedTimestamp**: string (ReadOnly): Time when this group was last updated. Date-Time represented in ISO-8601 format. + ## ImportCollectorProperties ### Properties * **createdTimestamp**: string (ReadOnly) * **discoverySiteId**: string * **updatedTimestamp**: string (ReadOnly) +## PrivateEndpointConnection +### Properties +* **eTag**: string: For optimistic concurrency control. +* **id**: string (ReadOnly): Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName} +* **name**: string (ReadOnly): Name of the private endpoint endpoint connection. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (Required): Private endpoint connection properties. +* **type**: string (ReadOnly): Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections]. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [ResourceId](#resourceid) (ReadOnly): ARM id for a resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): State of a private endpoint connection. +* **provisioningState**: 'Accepted' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Indicates whether there is an ongoing operation on the private endpoint. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: Actions required on the private endpoint connection. +* **description**: string: Description of the private endpoint connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Connection status of the private endpoint connection. + +## ProjectProperties +### Properties +* **assessmentSolutionId**: string: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. +* **createdTimestamp**: string (ReadOnly): Time when this project was created. Date-Time represented in ISO-8601 format. +* **customerStorageAccountArmId**: string: The ARM id of the storage account used for interactions when public access is disabled. +* **customerWorkspaceId**: string: The ARM id of service map workspace created by customer. +* **customerWorkspaceLocation**: string: Location of service map workspace created by customer. +* **lastAssessmentTimestamp**: string (ReadOnly): Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created. +* **numberOfAssessments**: int (ReadOnly): Number of assessments created in the project. +* **numberOfGroups**: int (ReadOnly): Number of groups created in the project. +* **numberOfMachines**: int (ReadOnly): Number of machines in the project. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the project. +* **projectStatus**: 'Active' | 'Inactive' | string: Assessment project status. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Succeeded' | string (ReadOnly): Provisioning state of the project. +* **publicNetworkAccess**: 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. +* **serviceEndpoint**: string (ReadOnly): Endpoint at which the collector agent can call agent REST API. +* **updatedTimestamp**: string (ReadOnly): Time when this project was last updated. Date-Time represented in ISO-8601 format. + +## ResourceId +### Properties +* **id**: string (ReadOnly) + +## VmUptime +### Properties +* **daysPerMonth**: int: Number of days in a month for VM uptime. +* **hoursPerDay**: int: Number of hours per day for VM uptime. + diff --git a/generated/migrate/microsoft.migrate/2020-05-01/types.md b/generated/migrate/microsoft.migrate/2020-05-01/types.md index ff22c08589..cb2ae35764 100644 --- a/generated/migrate/microsoft.migrate/2020-05-01/types.md +++ b/generated/migrate/microsoft.migrate/2020-05-01/types.md @@ -23,6 +23,12 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Migrate/migrateProjects/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type +## ConnectionStateRequestBodyProperties +### Properties +* **privateEndpoint**: [ResourceId](#resourceid) (ReadOnly) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private endpoint connection state. +* **provisioningState**: 'Accepted' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state. + ## MigrateProjectProperties ### Properties * **lastSummaryRefreshedTime**: string (ReadOnly): Last summary refresh time. @@ -34,6 +40,11 @@ * **summary**: [MigrateProjectPropertiesSummary](#migrateprojectpropertiessummary) (ReadOnly): Project summary. * **utilityStorageAccountId**: string: Utility storage account id. +## MigrateProjectPropertiesSummary +### Properties +### Additional Properties +* **Additional Properties Type**: [ProjectSummary](#projectsummary) + ## PrivateEndpointConnection ### Properties * **eTag**: string (ReadOnly): Gets the tag for optimistic concurrency control. @@ -49,30 +60,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private endpoint connection state. * **provisioningState**: 'Accepted' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state. -## ResourceId -### Properties -* **id**: string (ReadOnly) - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: Action required. * **description**: string: Description of the object. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Private link connection state. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## MigrateProjectPropertiesSummary -### Properties -### Additional Properties -* **Additional Properties Type**: [ProjectSummary](#projectsummary) - ## ProjectSummary ### Properties * **extendedSummary**: [ProjectSummaryExtendedSummary](#projectsummaryextendedsummary): Extended summary. @@ -85,9 +78,16 @@ ### Additional Properties * **Additional Properties Type**: string -## ConnectionStateRequestBodyProperties +## ResourceId ### Properties -* **privateEndpoint**: [ResourceId](#resourceid) (ReadOnly) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private endpoint connection state. -* **provisioningState**: 'Accepted' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state. +* **id**: string (ReadOnly) + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. diff --git a/generated/migrate/microsoft.offazure/2020-01-01/types.md b/generated/migrate/microsoft.offazure/2020-01-01/types.md index 3c5403a9d9..65d7c50020 100644 --- a/generated/migrate/microsoft.offazure/2020-01-01/types.md +++ b/generated/migrate/microsoft.offazure/2020-01-01/types.md @@ -51,47 +51,6 @@ * **properties**: [VCenterProperties](#vcenterproperties): Class for vCenter properties. * **type**: 'Microsoft.OffAzure/VMwareSites/vCenters' (ReadOnly, DeployTimeConstant): The resource type -## SiteProperties -### Properties -* **agentDetails**: [SiteAgentProperties](#siteagentproperties): Class for site agent properties. -* **applianceName**: string: Appliance Name. -* **discoverySolutionId**: string: ARM ID of migration hub solution for SDS. -* **serviceEndpoint**: string (ReadOnly): Service endpoint. -* **servicePrincipalIdentityDetails**: [SiteSpnProperties](#sitespnproperties): Class for site properties. - -## SiteAgentProperties -### Properties -* **id**: string (ReadOnly): ID of the agent. -* **keyVaultId**: string: Key vault ARM Id. -* **keyVaultUri**: string: Key vault URI. -* **lastHeartBeatUtc**: string (ReadOnly): Last heartbeat time of the agent in UTC. -* **version**: string (ReadOnly): Version of the agent. - -## SiteSpnProperties -### Properties -* **aadAuthority**: string: AAD Authority URL which was used to request the token for the service principal. -* **applicationId**: string: Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string: Intended audience for the service principal. -* **objectId**: string: Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **rawCertData**: string: Raw certificate data for building certificate expiry flows. -* **tenantId**: string: Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## HyperVSiteTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HyperVClusterProperties -### Properties -* **createdTimestamp**: string (ReadOnly): Timestamp marking Hyper-V cluster creation. -* **errors**: [HealthErrorDetails](#healtherrordetails)[] (ReadOnly): Errors for Hyper-V clusters. -* **fqdn**: string: FQDN/IPAddress of the Hyper-V cluster. -* **functionalLevel**: int (ReadOnly): Functional level of the Hyper-V cluster. -* **hostFqdnList**: string[]: List of hosts (FQDN) currently being tracked by the cluster. -* **runAsAccountId**: string: Run as account ID of the Hyper-V cluster. -* **status**: string (ReadOnly): Status of the Hyper-V cluster. -* **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the Hyper-V cluster. - ## HealthErrorDetails ### Properties * **code**: string (ReadOnly): Error name. @@ -109,6 +68,17 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVClusterProperties +### Properties +* **createdTimestamp**: string (ReadOnly): Timestamp marking Hyper-V cluster creation. +* **errors**: [HealthErrorDetails](#healtherrordetails)[] (ReadOnly): Errors for Hyper-V clusters. +* **fqdn**: string: FQDN/IPAddress of the Hyper-V cluster. +* **functionalLevel**: int (ReadOnly): Functional level of the Hyper-V cluster. +* **hostFqdnList**: string[]: List of hosts (FQDN) currently being tracked by the cluster. +* **runAsAccountId**: string: Run as account ID of the Hyper-V cluster. +* **status**: string (ReadOnly): Status of the Hyper-V cluster. +* **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the Hyper-V cluster. + ## HyperVHostProperties ### Properties * **createdTimestamp**: string (ReadOnly): Timestamp marking Hyper-V host creation. @@ -118,11 +88,36 @@ * **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the Hyper-V host. * **version**: string (ReadOnly): Version of the Hyper-V host. -## VMwareSiteTags +## HyperVSiteTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## SiteAgentProperties +### Properties +* **id**: string (ReadOnly): ID of the agent. +* **keyVaultId**: string: Key vault ARM Id. +* **keyVaultUri**: string: Key vault URI. +* **lastHeartBeatUtc**: string (ReadOnly): Last heartbeat time of the agent in UTC. +* **version**: string (ReadOnly): Version of the agent. + +## SiteProperties +### Properties +* **agentDetails**: [SiteAgentProperties](#siteagentproperties): Class for site agent properties. +* **applianceName**: string: Appliance Name. +* **discoverySolutionId**: string: ARM ID of migration hub solution for SDS. +* **serviceEndpoint**: string (ReadOnly): Service endpoint. +* **servicePrincipalIdentityDetails**: [SiteSpnProperties](#sitespnproperties): Class for site properties. + +## SiteSpnProperties +### Properties +* **aadAuthority**: string: AAD Authority URL which was used to request the token for the service principal. +* **applicationId**: string: Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string: Intended audience for the service principal. +* **objectId**: string: Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **rawCertData**: string: Raw certificate data for building certificate expiry flows. +* **tenantId**: string: Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + ## VCenterProperties ### Properties * **createdTimestamp**: string (ReadOnly): Timestamp marking vCenter creation. @@ -135,3 +130,8 @@ * **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the vCenter. * **version**: string (ReadOnly): Version of the vCenter. +## VMwareSiteTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/migrate/microsoft.offazure/2020-07-07/types.md b/generated/migrate/microsoft.offazure/2020-07-07/types.md index ff4bffb6db..20afc65da8 100644 --- a/generated/migrate/microsoft.offazure/2020-07-07/types.md +++ b/generated/migrate/microsoft.offazure/2020-07-07/types.md @@ -76,56 +76,6 @@ * **properties**: [VCenterProperties](#vcenterproperties): Class for vCenter properties. * **type**: 'Microsoft.OffAzure/VMwareSites/vCenters' (ReadOnly, DeployTimeConstant): The resource type -## SiteProperties -### Properties -* **agentDetails**: [SiteAgentProperties](#siteagentproperties): Class for site agent properties. -* **applianceName**: string: Appliance Name. -* **discoverySolutionId**: string: ARM ID of migration hub solution for SDS. -* **serviceEndpoint**: string (ReadOnly): Service endpoint. -* **servicePrincipalIdentityDetails**: [SiteSpnProperties](#sitespnproperties): Class for site properties. - -## SiteAgentProperties -### Properties -* **id**: string (ReadOnly): ID of the agent. -* **keyVaultId**: string: Key vault ARM Id. -* **keyVaultUri**: string: Key vault URI. -* **lastHeartBeatUtc**: string (ReadOnly): Last heartbeat time of the agent in UTC. -* **version**: string (ReadOnly): Version of the agent. - -## SiteSpnProperties -### Properties -* **aadAuthority**: string: AAD Authority URL which was used to request the token for the service principal. -* **applicationId**: string: Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string: Intended audience for the service principal. -* **objectId**: string: Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **rawCertData**: string: Raw certificate data for building certificate expiry flows. -* **tenantId**: string: Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## HyperVSiteTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HyperVClusterProperties -### Properties -* **createdTimestamp**: string (ReadOnly): Timestamp marking Hyper-V cluster creation. -* **errors**: [HealthErrorDetails](#healtherrordetails)[] (ReadOnly): Errors for Hyper-V clusters. -* **fqdn**: string: FQDN/IPAddress of the Hyper-V cluster. -* **functionalLevel**: int (ReadOnly): Functional level of the Hyper-V cluster. -* **hostFqdnList**: string[]: List of hosts (FQDN) currently being tracked by the cluster. -* **runAsAccountId**: string: Run as account ID of the Hyper-V cluster. -* **status**: string (ReadOnly): Status of the Hyper-V cluster. -* **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the Hyper-V cluster. - ## HealthErrorDetails ### Properties * **code**: string (ReadOnly): Error name. @@ -143,6 +93,17 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVClusterProperties +### Properties +* **createdTimestamp**: string (ReadOnly): Timestamp marking Hyper-V cluster creation. +* **errors**: [HealthErrorDetails](#healtherrordetails)[] (ReadOnly): Errors for Hyper-V clusters. +* **fqdn**: string: FQDN/IPAddress of the Hyper-V cluster. +* **functionalLevel**: int (ReadOnly): Functional level of the Hyper-V cluster. +* **hostFqdnList**: string[]: List of hosts (FQDN) currently being tracked by the cluster. +* **runAsAccountId**: string: Run as account ID of the Hyper-V cluster. +* **status**: string (ReadOnly): Status of the Hyper-V cluster. +* **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the Hyper-V cluster. + ## HyperVHostProperties ### Properties * **createdTimestamp**: string (ReadOnly): Timestamp marking Hyper-V host creation. @@ -152,6 +113,11 @@ * **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the Hyper-V host. * **version**: string (ReadOnly): Version of the Hyper-V host. +## HyperVSiteTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## MasterSiteProperties ### Properties * **allowMultipleSites**: bool: Value indicating whether multiple sites per site type are allowed. @@ -175,20 +141,49 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) * **provisioningState**: 'Accepted' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly) -## ResourceId -### Properties -* **id**: string (ReadOnly) - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string * **description**: string * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string -## VMwareSiteTags +## ResourceId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) + +## SiteAgentProperties +### Properties +* **id**: string (ReadOnly): ID of the agent. +* **keyVaultId**: string: Key vault ARM Id. +* **keyVaultUri**: string: Key vault URI. +* **lastHeartBeatUtc**: string (ReadOnly): Last heartbeat time of the agent in UTC. +* **version**: string (ReadOnly): Version of the agent. + +## SiteProperties +### Properties +* **agentDetails**: [SiteAgentProperties](#siteagentproperties): Class for site agent properties. +* **applianceName**: string: Appliance Name. +* **discoverySolutionId**: string: ARM ID of migration hub solution for SDS. +* **serviceEndpoint**: string (ReadOnly): Service endpoint. +* **servicePrincipalIdentityDetails**: [SiteSpnProperties](#sitespnproperties): Class for site properties. + +## SiteSpnProperties +### Properties +* **aadAuthority**: string: AAD Authority URL which was used to request the token for the service principal. +* **applicationId**: string: Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string: Intended audience for the service principal. +* **objectId**: string: Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **rawCertData**: string: Raw certificate data for building certificate expiry flows. +* **tenantId**: string: Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## VCenterProperties ### Properties @@ -202,3 +197,8 @@ * **updatedTimestamp**: string (ReadOnly): Timestamp marking last updated on the vCenter. * **version**: string (ReadOnly): Version of the vCenter. +## VMwareSiteTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/migrateprojects/log.out b/generated/migrateprojects/log.out index efd6a7d115..288f512820 100644 --- a/generated/migrateprojects/log.out +++ b/generated/migrateprojects/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.migrate-2018-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms -info | Autorest completed in 5.89s. 2 files generated. +info | autorest.bicep took 13ms +info | Autorest completed in 5.65s. 2 files generated. diff --git a/generated/migrateprojects/microsoft.migrate/2018-09-01-preview/types.md b/generated/migrateprojects/microsoft.migrate/2018-09-01-preview/types.md index e4af4d0e4d..2f921decc6 100644 --- a/generated/migrateprojects/microsoft.migrate/2018-09-01-preview/types.md +++ b/generated/migrateprojects/microsoft.migrate/2018-09-01-preview/types.md @@ -35,6 +35,10 @@ ### Additional Properties * **Additional Properties Type**: [ProjectSummary](#projectsummary) +## MigrateProjectTags +### Properties +* **additionalProperties**: string + ## ProjectSummary * **Discriminator**: instanceType @@ -61,9 +65,16 @@ ### Additional Properties * **Additional Properties Type**: string -## MigrateProjectTags +## SolutionDetails ### Properties -* **additionalProperties**: string +* **assessmentCount**: int: Gets or sets the count of assessments reported by the solution. +* **extendedDetails**: [SolutionDetailsExtendedDetails](#solutiondetailsextendeddetails): Gets or sets the extended details reported by the solution. +* **groupCount**: int: Gets or sets the count of groups reported by the solution. + +## SolutionDetailsExtendedDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SolutionProperties ### Properties @@ -75,17 +86,6 @@ * **summary**: [SolutionSummary](#solutionsummary): The solution summary class. * **tool**: 'Carbonite' | 'Cloudamize' | 'CorentTech' | 'DataMigrationAssistant' | 'DatabaseMigrationService' | 'ServerAssessment' | 'ServerAssessmentV1' | 'ServerDiscovery' | 'ServerMigration' | 'ServerMigration_Replication' | 'Turbonomic' | 'Zerto' | string: Gets or sets the tool being used in the solution. -## SolutionDetails -### Properties -* **assessmentCount**: int: Gets or sets the count of assessments reported by the solution. -* **extendedDetails**: [SolutionDetailsExtendedDetails](#solutiondetailsextendeddetails): Gets or sets the extended details reported by the solution. -* **groupCount**: int: Gets or sets the count of groups reported by the solution. - -## SolutionDetailsExtendedDetails -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SolutionSummary * **Discriminator**: instanceType diff --git a/generated/mixedreality/log.out b/generated/mixedreality/log.out index de3992c660..09197d4b5d 100644 --- a/generated/mixedreality/log.out +++ b/generated/mixedreality/log.out @@ -7,14 +7,14 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.mixedreality-2021-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationPage' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mixedreality/resource-manager/Microsoft.MixedReality/preview/2021-03-01-preview/proxy.json:394:5 @@ -23,42 +23,42 @@ warning | PreCheck/SchemaMissingType | The schema 'ObjectAnchorsAccount-identity warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.mixedreality-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationPage' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mixedreality/resource-manager/Microsoft.MixedReality/stable/2021-01-01/proxy.json:385:5 warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.mixedreality-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationPage' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mixedreality/resource-manager/Microsoft.MixedReality/stable/2020-05-01/proxy.json:331:5 warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.mixedreality-2020-04-06-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationPage' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mixedreality/resource-manager/Microsoft.MixedReality/preview/2020-04-06-preview/proxy.json:331:5 @@ -72,7 +72,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationPage' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mixedreality/resource-manager/Microsoft.MixedReality/preview/2019-12-02-preview/proxy.json:214:5 @@ -84,10 +84,10 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mixedreality/resource-manager/Microsoft.MixedReality/preview/2019-02-28-preview/mixedreality.json:581:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms -info | Autorest completed in 13.86s. 12 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 13.32s. 12 files generated. diff --git a/generated/mixedreality/microsoft.mixedreality/2020-04-06-preview/types.md b/generated/mixedreality/microsoft.mixedreality/2020-04-06-preview/types.md index 4c5ae44ef9..304ac30f58 100644 --- a/generated/mixedreality/microsoft.mixedreality/2020-04-06-preview/types.md +++ b/generated/mixedreality/microsoft.mixedreality/2020-04-06-preview/types.md @@ -21,12 +21,23 @@ * **ApiVersion**: 2020-04-06-preview * **Output**: [AccountKeys](#accountkeys) +## AccountKeys +### Properties +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## MixedRealityAccountProperties +### Properties +* **accountDomain**: string (ReadOnly): Correspond domain name of certain Spatial Anchors Account +* **accountId**: string (ReadOnly): unique id of certain account. +* **storageAccountName**: string: The name of the storage account associated with this accountId + ## Sku ### Properties * **capacity**: int: 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. @@ -35,12 +46,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. -## MixedRealityAccountProperties -### Properties -* **accountDomain**: string (ReadOnly): Correspond domain name of certain Spatial Anchors Account -* **accountId**: string (ReadOnly): unique id of certain account. -* **storageAccountName**: string: The name of the storage account associated with this accountId - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -55,8 +60,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - diff --git a/generated/mixedreality/microsoft.mixedreality/2020-05-01/types.md b/generated/mixedreality/microsoft.mixedreality/2020-05-01/types.md index 0cdfd79375..f4b234858d 100644 --- a/generated/mixedreality/microsoft.mixedreality/2020-05-01/types.md +++ b/generated/mixedreality/microsoft.mixedreality/2020-05-01/types.md @@ -21,12 +21,23 @@ * **ApiVersion**: 2020-05-01 * **Output**: [AccountKeys](#accountkeys) +## AccountKeys +### Properties +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## MixedRealityAccountProperties +### Properties +* **accountDomain**: string (ReadOnly): Correspond domain name of certain Spatial Anchors Account +* **accountId**: string (ReadOnly): unique id of certain account. +* **storageAccountName**: string: The name of the storage account associated with this accountId + ## Sku ### Properties * **capacity**: int: 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. @@ -35,12 +46,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. -## MixedRealityAccountProperties -### Properties -* **accountDomain**: string (ReadOnly): Correspond domain name of certain Spatial Anchors Account -* **accountId**: string (ReadOnly): unique id of certain account. -* **storageAccountName**: string: The name of the storage account associated with this accountId - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -55,8 +60,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - diff --git a/generated/mixedreality/microsoft.mixedreality/2021-01-01/types.md b/generated/mixedreality/microsoft.mixedreality/2021-01-01/types.md index 3337e66528..df34a4c582 100644 --- a/generated/mixedreality/microsoft.mixedreality/2021-01-01/types.md +++ b/generated/mixedreality/microsoft.mixedreality/2021-01-01/types.md @@ -42,12 +42,28 @@ * **ApiVersion**: 2021-01-01 * **Output**: [AccountKeys](#accountkeys) +## AccountKeys +### Properties +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. + +## AccountKeys +### Properties +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## MixedRealityAccountProperties +### Properties +* **accountDomain**: string (ReadOnly): Correspond domain name of certain Spatial Anchors Account +* **accountId**: string (ReadOnly): unique id of certain account. +* **storageAccountName**: string: The name of the storage account associated with this accountId + ## Sku ### Properties * **capacity**: int: 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. @@ -56,12 +72,6 @@ * **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. -## MixedRealityAccountProperties -### Properties -* **accountDomain**: string (ReadOnly): Correspond domain name of certain Spatial Anchors Account -* **accountId**: string (ReadOnly): unique id of certain account. -* **storageAccountName**: string: The name of the storage account associated with this accountId - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -81,13 +91,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - diff --git a/generated/mixedreality/microsoft.mixedreality/2021-03-01-preview/types.md b/generated/mixedreality/microsoft.mixedreality/2021-03-01-preview/types.md index 99ad682dbf..e95d1c9867 100644 --- a/generated/mixedreality/microsoft.mixedreality/2021-03-01-preview/types.md +++ b/generated/mixedreality/microsoft.mixedreality/2021-03-01-preview/types.md @@ -63,19 +63,20 @@ * **ApiVersion**: 2021-03-01-preview * **Output**: [AccountKeys](#accountkeys) -## ObjectAnchorsAccountIdentity +## AccountKeys ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. -## Sku +## AccountKeys ### Properties -* **capacity**: int: 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. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code -* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. + +## AccountKeys +### Properties +* **primaryKey**: string (ReadOnly): value of primary key. +* **secondaryKey**: string (ReadOnly): value of secondary key. ## Identity ### Properties @@ -89,6 +90,20 @@ * **accountId**: string (ReadOnly): unique id of certain account. * **storageAccountName**: string: The name of the storage account associated with this accountId +## ObjectAnchorsAccountIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. + +## Sku +### Properties +* **capacity**: int: 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. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU. Ex - P3. It is typically a letter+number code +* **size**: string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard': This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -113,18 +128,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - -## AccountKeys -### Properties -* **primaryKey**: string (ReadOnly): value of primary key. -* **secondaryKey**: string (ReadOnly): value of secondary key. - diff --git a/generated/mobilenetwork/log.out b/generated/mobilenetwork/log.out index 283f1daef1..abbe2370df 100644 --- a/generated/mobilenetwork/log.out +++ b/generated/mobilenetwork/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.mobilenetwork-2022-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'AttachedDataNetwork' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from AttachedDataNetwork @@ -19,11 +19,11 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'PacketCoreDataPlane' h warning | PreCheck/PropertyRedeclarationWarning | Schema 'Service' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Service warning | PreCheck/PropertyRedeclarationWarning | Schema 'SimPolicy' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SimPolicy warning | PreCheck/PropertyRedeclarationWarning | Schema 'Slice' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from Slice -info | autorest.bicep took 18ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.mobilenetwork-2022-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms -info | Autorest completed in 10.98s. 4 files generated. +info | autorest.bicep took 6ms +info | Autorest completed in 10.45s. 4 files generated. diff --git a/generated/mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.md b/generated/mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.md index 144f79824d..5e535b4222 100644 --- a/generated/mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.md +++ b/generated/mobilenetwork/microsoft.mobilenetwork/2022-01-01-preview/types.md @@ -125,47 +125,87 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [SimIdListResult](#simidlistresult) -## MobileNetworkPropertiesFormat +## Ambr +### Properties +* **downlink**: string (Required): Bit rate. +* **uplink**: string (Required): Bit rate. + +## AttachedDataNetworkPropertiesFormat ### Properties +* **naptConfiguration**: [NaptConfiguration](#naptconfiguration): The Network Address and Port Translation settings to use for the attached data network. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **publicLandMobileNetworkIdentifier**: [PlmnId](#plmnid) (Required): Public Land Mobile Network (PLMN) ID. -* **serviceKey**: string (ReadOnly): The mobile network resource identifier +* **userEquipmentAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. +At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. +* **userEquipmentStaticAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. +The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. +At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. +* **userPlaneDataInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties -## PlmnId +## AttachedDataNetworkResourceId ### Properties -* **mcc**: string (Required): Mobile Country Code. -* **mnc**: string (Required): Mobile Network Code. +* **id**: string (Required): Attached Data Network resource ID. -## SystemData +## CustomLocationResourceId ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string (Required): Azure ARC custom location resource ID. -## TrackedResourceTags +## DataNetworkConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **5qi**: int: 5G QoS Identifier priority level. +* **additionalAllowedSessionTypes**: 'IPv4' | 'IPv6' | string[]: Allowed session types in addition to the default session type. Must not duplicate the default session type. +* **allocationAndRetentionPriorityLevel**: int: ARP priority level. +* **allowedServices**: [ServiceResourceId](#serviceresourceid)[] (Required): List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. +* **dataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. +* **defaultSessionType**: 'IPv4' | 'IPv6' | string: PDU session type (IPv4/IPv6). +* **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. +* **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. +* **sessionAmbr**: [Ambr](#ambr) (Required): Aggregate Maximum Bit Rate. ## DataNetworkPropertiesFormat ### Properties * **description**: string: An optional description for this data network. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -## TrackedResourceTags +## DataNetworkResourceId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Data Network resource ID. -## ServicePropertiesFormat +## InterfaceProperties +### Properties +* **name**: string (Required): The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. + +## MobileNetworkPropertiesFormat ### Properties -* **pccRules**: [PccRuleConfiguration](#pccruleconfiguration)[] (Required): The set of PCC Rules that make up this service. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **servicePrecedence**: int (Required): A precedence value that is used to decide between services when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all services configured in the Mobile Network. -* **serviceQosPolicy**: [QosPolicy](#qospolicy): QoS policy +* **publicLandMobileNetworkIdentifier**: [PlmnId](#plmnid) (Required): Public Land Mobile Network (PLMN) ID. +* **serviceKey**: string (ReadOnly): The mobile network resource identifier + +## MobileNetworkResourceId +### Properties +* **id**: string (Required): Mobile Network resource ID. + +## NaptConfiguration +### Properties +* **enabled**: 'Disabled' | 'Enabled' | string: Whether Network Address and Port Translation is enabled. +* **pinholeLimits**: int: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. +* **pinholeTimeouts**: [PinholeTimeouts](#pinholetimeouts): Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. +* **portRange**: [PortRange](#portrange): Range of port numbers to use as translated ports on each translated address. +If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) +* **portReuseHoldTime**: [PortReuseHoldTimes](#portreuseholdtimes): The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. + +## PacketCoreControlPlanePropertiesFormat +### Properties +* **controlPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties +* **coreNetworkTechnology**: '5GC' | 'EPC' | string: Core network type. +* **customLocation**: [CustomLocationResourceId](#customlocationresourceid): Reference to an Azure ARC custom location resource. +* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid) (Required): Reference to a Mobile Network resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **version**: string: The version of the packet core software that is deployed. + +## PacketCoreDataPlanePropertiesFormat +### Properties +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **userPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties ## PccRuleConfiguration ### Properties @@ -184,18 +224,26 @@ * **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. * **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. -## Ambr +## PinholeTimeouts ### Properties -* **downlink**: string (Required): Bit rate. -* **uplink**: string (Required): Bit rate. +* **icmp**: int: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. +* **tcp**: int: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. +* **udp**: int: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. -## ServiceDataFlowTemplate +## PlmnId ### Properties -* **direction**: 'Bidirectional' | 'Downlink' | 'Uplink' | string (Required): Service data flow direction. -* **ports**: string[]: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as -. For example: [`8080`, `8082-8085`]. -* **protocol**: string[] (Required): A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. -* **remoteIpList**: string[] (Required): The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). -* **templateName**: string (Required): The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. +* **mcc**: string (Required): Mobile Country Code. +* **mnc**: string (Required): Mobile Network Code. + +## PortRange +### Properties +* **maxPort**: int: The maximum port number +* **minPort**: int: The minimum port number + +## PortReuseHoldTimes +### Properties +* **tcp**: int: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. +* **udp**: int: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ## QosPolicy ### Properties @@ -205,10 +253,29 @@ * **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. * **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. -## TrackedResourceTags +## ServiceDataFlowTemplate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **direction**: 'Bidirectional' | 'Downlink' | 'Uplink' | string (Required): Service data flow direction. +* **ports**: string[]: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as -. For example: [`8080`, `8082-8085`]. +* **protocol**: string[] (Required): A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. +* **remoteIpList**: string[] (Required): The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). +* **templateName**: string (Required): The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. + +## ServicePropertiesFormat +### Properties +* **pccRules**: [PccRuleConfiguration](#pccruleconfiguration)[] (Required): The set of PCC Rules that make up this service. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **servicePrecedence**: int (Required): A precedence value that is used to decide between services when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all services configured in the Mobile Network. +* **serviceQosPolicy**: [QosPolicy](#qospolicy): QoS policy + +## ServiceResourceId +### Properties +* **id**: string (Required): Service resource ID. + +## SimIdListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [SubResource](#subresource)[] (ReadOnly): A list of sim profile ids in a resource group. ## SimPolicyPropertiesFormat ### Properties @@ -219,54 +286,43 @@ * **sliceConfigurations**: [SliceConfiguration](#sliceconfiguration)[] (Required): The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. * **ueAmbr**: [Ambr](#ambr) (Required): Aggregate Maximum Bit Rate. -## SliceResourceId -### Properties -* **id**: string (Required): Slice resource ID. - -## SliceConfiguration -### Properties -* **dataNetworkConfigurations**: [DataNetworkConfiguration](#datanetworkconfiguration)[] (Required): The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. -* **defaultDataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. -* **slice**: [SliceResourceId](#sliceresourceid) (Required): Reference to a Slice resource. - -## DataNetworkConfiguration +## SimPolicyResourceId ### Properties -* **5qi**: int: 5G QoS Identifier priority level. -* **additionalAllowedSessionTypes**: 'IPv4' | 'IPv6' | string[]: Allowed session types in addition to the default session type. Must not duplicate the default session type. -* **allocationAndRetentionPriorityLevel**: int: ARP priority level. -* **allowedServices**: [ServiceResourceId](#serviceresourceid)[] (Required): List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. -* **dataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. -* **defaultSessionType**: 'IPv4' | 'IPv6' | string: PDU session type (IPv4/IPv6). -* **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. -* **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. -* **sessionAmbr**: [Ambr](#ambr) (Required): Aggregate Maximum Bit Rate. +* **id**: string (Required): SIM Policy resource ID. -## ServiceResourceId +## SimPropertiesFormat ### Properties -* **id**: string (Required): Service resource ID. +* **authenticationKey**: string (WriteOnly): The ki value for the sim. +* **configurationState**: 'Complete' | 'Incomplete' | string (ReadOnly): The configuration state of the resource - complete or incomplete. +* **deviceType**: string: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. +* **integratedCircuitCardIdentifier**: string: The Integrated Circuit Card ID (ICC Id) for the sim. +* **internationalMobileSubscriberIdentity**: string (Required): The International Mobile Subscriber Identity (IMSI) for the sim. +* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid): Reference to a Mobile Network resource. +* **operatorKeyCode**: string (WriteOnly): The Opc value for the sim. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **simPolicy**: [SimPolicyResourceId](#simpolicyresourceid): Reference to a SIM Policy resource. +* **staticIpConfiguration**: [SimStaticIpProperties](#simstaticipproperties)[]: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. -## DataNetworkResourceId +## SimStaticIpProperties ### Properties -* **id**: string (Required): Data Network resource ID. +* **attachedDataNetwork**: [AttachedDataNetworkResourceId](#attacheddatanetworkresourceid): Reference to an Attached Data Network resource. +* **slice**: [SliceResourceId](#sliceresourceid): Reference to a Slice resource. +* **staticIp**: [SimStaticIpPropertiesStaticIp](#simstaticippropertiesstaticip): The static IP configuration for the sim to use at the defined network scope. -## TrackedResourceTags +## SimStaticIpPropertiesStaticIp ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipv4Address**: string: IPv4 address. ## SitePropertiesFormat ### Properties * **networkFunctions**: [SubResource](#subresource)[]: An array of ids of the network functions deployed on the site, maintained by the user. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -## SubResource -### Properties -* **id**: string (Required): Resource ID. - -## TrackedResourceTags +## SliceConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataNetworkConfigurations**: [DataNetworkConfiguration](#datanetworkconfiguration)[] (Required): The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. +* **defaultDataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. +* **slice**: [SliceResourceId](#sliceresourceid) (Required): Reference to a Slice resource. ## SlicePropertiesFormat ### Properties @@ -274,131 +330,75 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. * **snssai**: [Snssai](#snssai) (Required): Single-Network Slice Selection Assistance Information (S-NSSAI). +## SliceResourceId +### Properties +* **id**: string (Required): Slice resource ID. + ## Snssai ### Properties * **sd**: string: Slice Differentiator (SD). * **sst**: int (Required): Slice/Service Type (SST). -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PacketCoreControlPlanePropertiesFormat -### Properties -* **controlPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties -* **coreNetworkTechnology**: '5GC' | 'EPC' | string: Core network type. -* **customLocation**: [CustomLocationResourceId](#customlocationresourceid): Reference to an Azure ARC custom location resource. -* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid) (Required): Reference to a Mobile Network resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **version**: string: The version of the packet core software that is deployed. - -## InterfaceProperties -### Properties -* **name**: string (Required): The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. - -## CustomLocationResourceId +## SubResource ### Properties -* **id**: string (Required): Azure ARC custom location resource ID. +* **id**: string (Required): Resource ID. -## MobileNetworkResourceId +## SystemData ### Properties -* **id**: string (Required): Mobile Network resource ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCoreDataPlanePropertiesFormat -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **userPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AttachedDataNetworkPropertiesFormat -### Properties -* **naptConfiguration**: [NaptConfiguration](#naptconfiguration): The Network Address and Port Translation settings to use for the attached data network. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **userEquipmentAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. -At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. -* **userEquipmentStaticAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. -The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. -At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. -* **userPlaneDataInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties - -## NaptConfiguration -### Properties -* **enabled**: 'Disabled' | 'Enabled' | string: Whether Network Address and Port Translation is enabled. -* **pinholeLimits**: int: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. -* **pinholeTimeouts**: [PinholeTimeouts](#pinholetimeouts): Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. -* **portRange**: [PortRange](#portrange): Range of port numbers to use as translated ports on each translated address. -If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) -* **portReuseHoldTime**: [PortReuseHoldTimes](#portreuseholdtimes): The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. - -## PinholeTimeouts -### Properties -* **icmp**: int: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. -* **tcp**: int: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. -* **udp**: int: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. - -## PortRange -### Properties -* **maxPort**: int: The maximum port number -* **minPort**: int: The minimum port number - -## PortReuseHoldTimes -### Properties -* **tcp**: int: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. -* **udp**: int: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SimPropertiesFormat +## TrackedResourceTags ### Properties -* **authenticationKey**: string (WriteOnly): The ki value for the sim. -* **configurationState**: 'Complete' | 'Incomplete' | string (ReadOnly): The configuration state of the resource - complete or incomplete. -* **deviceType**: string: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. -* **integratedCircuitCardIdentifier**: string: The Integrated Circuit Card ID (ICC Id) for the sim. -* **internationalMobileSubscriberIdentity**: string (Required): The International Mobile Subscriber Identity (IMSI) for the sim. -* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid): Reference to a Mobile Network resource. -* **operatorKeyCode**: string (WriteOnly): The Opc value for the sim. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **simPolicy**: [SimPolicyResourceId](#simpolicyresourceid): Reference to a SIM Policy resource. -* **staticIpConfiguration**: [SimStaticIpProperties](#simstaticipproperties)[]: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. +### Additional Properties +* **Additional Properties Type**: string -## SimPolicyResourceId +## TrackedResourceTags ### Properties -* **id**: string (Required): SIM Policy resource ID. +### Additional Properties +* **Additional Properties Type**: string -## SimStaticIpProperties +## TrackedResourceTags ### Properties -* **attachedDataNetwork**: [AttachedDataNetworkResourceId](#attacheddatanetworkresourceid): Reference to an Attached Data Network resource. -* **slice**: [SliceResourceId](#sliceresourceid): Reference to a Slice resource. -* **staticIp**: [SimStaticIpPropertiesStaticIp](#simstaticippropertiesstaticip): The static IP configuration for the sim to use at the defined network scope. +### Additional Properties +* **Additional Properties Type**: string -## AttachedDataNetworkResourceId +## TrackedResourceTags ### Properties -* **id**: string (Required): Attached Data Network resource ID. +### Additional Properties +* **Additional Properties Type**: string -## SimStaticIpPropertiesStaticIp +## TrackedResourceTags ### Properties -* **ipv4Address**: string: IPv4 address. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SimIdListResult +## TrackedResourceTags ### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [SubResource](#subresource)[] (ReadOnly): A list of sim profile ids in a resource group. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.md b/generated/mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.md index 1eb9663d41..b7eef08e35 100644 --- a/generated/mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.md +++ b/generated/mobilenetwork/microsoft.mobilenetwork/2022-03-01-preview/types.md @@ -125,47 +125,90 @@ * **ApiVersion**: 2022-03-01-preview * **Output**: [SimIdListResult](#simidlistresult) -## MobileNetworkPropertiesFormat +## Ambr +### Properties +* **downlink**: string (Required): Bit rate. +* **uplink**: string (Required): Bit rate. + +## AttachedDataNetworkPropertiesFormat ### Properties +* **naptConfiguration**: [NaptConfiguration](#naptconfiguration): The Network Address and Port Translation settings to use for the attached data network. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **publicLandMobileNetworkIdentifier**: [PlmnId](#plmnid) (Required): Public Land Mobile Network (PLMN) ID. -* **serviceKey**: string (ReadOnly): The mobile network resource identifier +* **userEquipmentAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. +At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. +* **userEquipmentStaticAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. +The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. +At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. +* **userPlaneDataInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties -## PlmnId +## AttachedDataNetworkResourceId ### Properties -* **mcc**: string (Required): Mobile Country Code. -* **mnc**: string (Required): Mobile Network Code. +* **id**: string (Required): Attached Data Network resource ID. -## SystemData +## CustomLocationResourceId ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string (Required): Azure ARC custom location resource ID. -## TrackedResourceTags +## DataNetworkConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **5qi**: int: 5G QoS Identifier priority level. +* **additionalAllowedSessionTypes**: 'IPv4' | 'IPv6' | string[]: Allowed session types in addition to the default session type. Must not duplicate the default session type. +* **allocationAndRetentionPriorityLevel**: int: ARP priority level. +* **allowedServices**: [ServiceResourceId](#serviceresourceid)[] (Required): List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. +* **dataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. +* **defaultSessionType**: 'IPv4' | 'IPv6' | string: PDU session type (IPv4/IPv6). +* **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. +* **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. +* **sessionAmbr**: [Ambr](#ambr) (Required): Aggregate Maximum Bit Rate. ## DataNetworkPropertiesFormat ### Properties * **description**: string: An optional description for this data network. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -## TrackedResourceTags +## DataNetworkResourceId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (Required): Data Network resource ID. -## ServicePropertiesFormat +## InterfaceProperties +### Properties +* **ipv4Address**: string: IPv4 address. +* **ipv4Gateway**: string: IPv4 address. +* **ipv4Subnet**: string: IPv4 address mask. +* **name**: string (Required): The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. + +## MobileNetworkPropertiesFormat ### Properties -* **pccRules**: [PccRuleConfiguration](#pccruleconfiguration)[] (Required): The set of PCC Rules that make up this service. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **servicePrecedence**: int (Required): A precedence value that is used to decide between services when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all services configured in the Mobile Network. -* **serviceQosPolicy**: [QosPolicy](#qospolicy): QoS policy +* **publicLandMobileNetworkIdentifier**: [PlmnId](#plmnid) (Required): Public Land Mobile Network (PLMN) ID. +* **serviceKey**: string (ReadOnly): The mobile network resource identifier + +## MobileNetworkResourceId +### Properties +* **id**: string (Required): Mobile Network resource ID. + +## NaptConfiguration +### Properties +* **enabled**: 'Disabled' | 'Enabled' | string: Whether Network Address and Port Translation is enabled. +* **pinholeLimits**: int: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. +* **pinholeTimeouts**: [PinholeTimeouts](#pinholetimeouts): Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. +* **portRange**: [PortRange](#portrange): Range of port numbers to use as translated ports on each translated address. +If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) +* **portReuseHoldTime**: [PortReuseHoldTimes](#portreuseholdtimes): The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. + +## PacketCoreControlPlanePropertiesFormat +### Properties +* **controlPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties +* **coreNetworkTechnology**: '5GC' | 'EPC' | string: Core network type. +* **customLocation**: [CustomLocationResourceId](#customlocationresourceid): Reference to an Azure ARC custom location resource. +* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid) (Required): Reference to a Mobile Network resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **version**: string: The version of the packet core software that is deployed. + +## PacketCoreDataPlanePropertiesFormat +### Properties +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **userPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties ## PccRuleConfiguration ### Properties @@ -184,18 +227,26 @@ * **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. * **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. -## Ambr +## PinholeTimeouts ### Properties -* **downlink**: string (Required): Bit rate. -* **uplink**: string (Required): Bit rate. +* **icmp**: int: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. +* **tcp**: int: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. +* **udp**: int: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. -## ServiceDataFlowTemplate +## PlmnId ### Properties -* **direction**: 'Bidirectional' | 'Downlink' | 'Uplink' | string (Required): Service data flow direction. -* **ports**: string[]: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as -. For example: [`8080`, `8082-8085`]. -* **protocol**: string[] (Required): A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. -* **remoteIpList**: string[] (Required): The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). -* **templateName**: string (Required): The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. +* **mcc**: string (Required): Mobile Country Code. +* **mnc**: string (Required): Mobile Network Code. + +## PortRange +### Properties +* **maxPort**: int: The maximum port number +* **minPort**: int: The minimum port number + +## PortReuseHoldTimes +### Properties +* **tcp**: int: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. +* **udp**: int: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. ## QosPolicy ### Properties @@ -205,10 +256,29 @@ * **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. * **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. -## TrackedResourceTags +## ServiceDataFlowTemplate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **direction**: 'Bidirectional' | 'Downlink' | 'Uplink' | string (Required): Service data flow direction. +* **ports**: string[]: The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as -. For example: [`8080`, `8082-8085`]. +* **protocol**: string[] (Required): A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. +* **remoteIpList**: string[] (Required): The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). +* **templateName**: string (Required): The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. + +## ServicePropertiesFormat +### Properties +* **pccRules**: [PccRuleConfiguration](#pccruleconfiguration)[] (Required): The set of PCC Rules that make up this service. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **servicePrecedence**: int (Required): A precedence value that is used to decide between services when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all services configured in the Mobile Network. +* **serviceQosPolicy**: [QosPolicy](#qospolicy): QoS policy + +## ServiceResourceId +### Properties +* **id**: string (Required): Service resource ID. + +## SimIdListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [SubResource](#subresource)[] (ReadOnly): A list of sim profile ids in a resource group. ## SimPolicyPropertiesFormat ### Properties @@ -219,54 +289,43 @@ * **sliceConfigurations**: [SliceConfiguration](#sliceconfiguration)[] (Required): The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. * **ueAmbr**: [Ambr](#ambr) (Required): Aggregate Maximum Bit Rate. -## SliceResourceId -### Properties -* **id**: string (Required): Slice resource ID. - -## SliceConfiguration -### Properties -* **dataNetworkConfigurations**: [DataNetworkConfiguration](#datanetworkconfiguration)[] (Required): The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. -* **defaultDataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. -* **slice**: [SliceResourceId](#sliceresourceid) (Required): Reference to a Slice resource. - -## DataNetworkConfiguration +## SimPolicyResourceId ### Properties -* **5qi**: int: 5G QoS Identifier priority level. -* **additionalAllowedSessionTypes**: 'IPv4' | 'IPv6' | string[]: Allowed session types in addition to the default session type. Must not duplicate the default session type. -* **allocationAndRetentionPriorityLevel**: int: ARP priority level. -* **allowedServices**: [ServiceResourceId](#serviceresourceid)[] (Required): List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. -* **dataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. -* **defaultSessionType**: 'IPv4' | 'IPv6' | string: PDU session type (IPv4/IPv6). -* **preemptionCapability**: 'MayPreempt' | 'NotPreempt' | string: Preemption capability. -* **preemptionVulnerability**: 'NotPreemptable' | 'Preemptable' | string: Preemption vulnerability. -* **sessionAmbr**: [Ambr](#ambr) (Required): Aggregate Maximum Bit Rate. +* **id**: string (Required): SIM Policy resource ID. -## ServiceResourceId +## SimPropertiesFormat ### Properties -* **id**: string (Required): Service resource ID. +* **authenticationKey**: string (WriteOnly): The ki value for the sim. +* **deviceType**: string: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. +* **integratedCircuitCardIdentifier**: string: The Integrated Circuit Card ID (ICC Id) for the sim. +* **internationalMobileSubscriberIdentity**: string (Required): The International Mobile Subscriber Identity (IMSI) for the sim. +* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid): Reference to a Mobile Network resource. +* **operatorKeyCode**: string (WriteOnly): The Opc value for the sim. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. +* **simPolicy**: [SimPolicyResourceId](#simpolicyresourceid): Reference to a SIM Policy resource. +* **simState**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): The state of the sim resource. +* **staticIpConfiguration**: [SimStaticIpProperties](#simstaticipproperties)[]: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. -## DataNetworkResourceId +## SimStaticIpProperties ### Properties -* **id**: string (Required): Data Network resource ID. +* **attachedDataNetwork**: [AttachedDataNetworkResourceId](#attacheddatanetworkresourceid): Reference to an Attached Data Network resource. +* **slice**: [SliceResourceId](#sliceresourceid): Reference to a Slice resource. +* **staticIp**: [SimStaticIpPropertiesStaticIp](#simstaticippropertiesstaticip): The static IP configuration for the sim to use at the defined network scope. -## TrackedResourceTags +## SimStaticIpPropertiesStaticIp ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipv4Address**: string: IPv4 address. ## SitePropertiesFormat ### Properties * **networkFunctions**: [SubResource](#subresource)[]: An array of ids of the network functions deployed on the site, maintained by the user. * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -## SubResource -### Properties -* **id**: string (Required): Resource ID. - -## TrackedResourceTags +## SliceConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dataNetworkConfigurations**: [DataNetworkConfiguration](#datanetworkconfiguration)[] (Required): The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. +* **defaultDataNetwork**: [DataNetworkResourceId](#datanetworkresourceid) (Required): Reference to a Data Network resource. +* **slice**: [SliceResourceId](#sliceresourceid) (Required): Reference to a Slice resource. ## SlicePropertiesFormat ### Properties @@ -274,134 +333,75 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. * **snssai**: [Snssai](#snssai) (Required): Single-Network Slice Selection Assistance Information (S-NSSAI). +## SliceResourceId +### Properties +* **id**: string (Required): Slice resource ID. + ## Snssai ### Properties * **sd**: string: Slice Differentiator (SD). * **sst**: int (Required): Slice/Service Type (SST). -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PacketCoreControlPlanePropertiesFormat -### Properties -* **controlPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties -* **coreNetworkTechnology**: '5GC' | 'EPC' | string: Core network type. -* **customLocation**: [CustomLocationResourceId](#customlocationresourceid): Reference to an Azure ARC custom location resource. -* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid) (Required): Reference to a Mobile Network resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **version**: string: The version of the packet core software that is deployed. - -## InterfaceProperties -### Properties -* **ipv4Address**: string: IPv4 address. -* **ipv4Gateway**: string: IPv4 address. -* **ipv4Subnet**: string: IPv4 address mask. -* **name**: string (Required): The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. - -## CustomLocationResourceId +## SubResource ### Properties -* **id**: string (Required): Azure ARC custom location resource ID. +* **id**: string (Required): Resource ID. -## MobileNetworkResourceId +## SystemData ### Properties -* **id**: string (Required): Mobile Network resource ID. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCoreDataPlanePropertiesFormat -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **userPlaneAccessInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AttachedDataNetworkPropertiesFormat -### Properties -* **naptConfiguration**: [NaptConfiguration](#naptconfiguration): The Network Address and Port Translation settings to use for the attached data network. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **userEquipmentAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session. -At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. -* **userEquipmentStaticAddressPoolPrefix**: string[]: The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session. -The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource. -At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size. -* **userPlaneDataInterface**: [InterfaceProperties](#interfaceproperties) (Required): Interface properties - -## NaptConfiguration -### Properties -* **enabled**: 'Disabled' | 'Enabled' | string: Whether Network Address and Port Translation is enabled. -* **pinholeLimits**: int: Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. -* **pinholeTimeouts**: [PinholeTimeouts](#pinholetimeouts): Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. -* **portRange**: [PortRange](#portrange): Range of port numbers to use as translated ports on each translated address. -If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.) -* **portReuseHoldTime**: [PortReuseHoldTimes](#portreuseholdtimes): The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. - -## PinholeTimeouts -### Properties -* **icmp**: int: Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. -* **tcp**: int: Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. -* **udp**: int: Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. - -## PortRange -### Properties -* **maxPort**: int: The maximum port number -* **minPort**: int: The minimum port number - -## PortReuseHoldTimes -### Properties -* **tcp**: int: Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. -* **udp**: int: Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SimPropertiesFormat +## TrackedResourceTags ### Properties -* **authenticationKey**: string (WriteOnly): The ki value for the sim. -* **deviceType**: string: An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. -* **integratedCircuitCardIdentifier**: string: The Integrated Circuit Card ID (ICC Id) for the sim. -* **internationalMobileSubscriberIdentity**: string (Required): The International Mobile Subscriber Identity (IMSI) for the sim. -* **mobileNetwork**: [MobileNetworkResourceId](#mobilenetworkresourceid): Reference to a Mobile Network resource. -* **operatorKeyCode**: string (WriteOnly): The Opc value for the sim. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | string (ReadOnly): The current provisioning state. -* **simPolicy**: [SimPolicyResourceId](#simpolicyresourceid): Reference to a SIM Policy resource. -* **simState**: 'Disabled' | 'Enabled' | 'Invalid' | string (ReadOnly): The state of the sim resource. -* **staticIpConfiguration**: [SimStaticIpProperties](#simstaticipproperties)[]: A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. +### Additional Properties +* **Additional Properties Type**: string -## SimPolicyResourceId +## TrackedResourceTags ### Properties -* **id**: string (Required): SIM Policy resource ID. +### Additional Properties +* **Additional Properties Type**: string -## SimStaticIpProperties +## TrackedResourceTags ### Properties -* **attachedDataNetwork**: [AttachedDataNetworkResourceId](#attacheddatanetworkresourceid): Reference to an Attached Data Network resource. -* **slice**: [SliceResourceId](#sliceresourceid): Reference to a Slice resource. -* **staticIp**: [SimStaticIpPropertiesStaticIp](#simstaticippropertiesstaticip): The static IP configuration for the sim to use at the defined network scope. +### Additional Properties +* **Additional Properties Type**: string -## AttachedDataNetworkResourceId +## TrackedResourceTags ### Properties -* **id**: string (Required): Attached Data Network resource ID. +### Additional Properties +* **Additional Properties Type**: string -## SimStaticIpPropertiesStaticIp +## TrackedResourceTags ### Properties -* **ipv4Address**: string: IPv4 address. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SimIdListResult +## TrackedResourceTags ### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [SubResource](#subresource)[] (ReadOnly): A list of sim profile ids in a resource group. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/monitor/log.out b/generated/monitor/log.out index d9cb50e057..0d9a4535c4 100644 --- a/generated/monitor/log.out +++ b/generated/monitor/log.out @@ -30,7 +30,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.insights-2015-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -60,7 +60,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json:305:5 @@ -127,7 +127,7 @@ warning | PreCheck/SchemaMissingType | The schema 'EventData' with an undefined warning | PreCheck/SchemaMissingType | The schema 'EventDataCollection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json:307:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 12ms +info | autorest.bicep took 29ms info | Processing batch task - {"tag":"microsoft.insights-2016-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -157,7 +157,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Incident' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json:129:5 @@ -232,7 +232,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json:199:5 @@ -275,7 +275,7 @@ warning | PreCheck/SchemaMissingType | The schema 'MetricValue' with an undefine warning | PreCheck/SchemaMissingType | The schema 'MetadataValue' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json:240:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2022-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -305,7 +305,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms @@ -338,7 +338,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'LocalizableString' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json:86:5 @@ -375,7 +375,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MetricBaselinesResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json:123:5 @@ -424,7 +424,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ActionGroupPatchBody-tags' wi warning | PreCheck/SchemaMissingType | The schema 'ActionGroupPatch' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/actionGroups_API.json:829:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2018-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -454,7 +454,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json:429:5 @@ -522,7 +522,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.insights-2018-04-16"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -552,7 +552,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms @@ -585,7 +585,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MetricNamespaceName' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json:80:5 @@ -622,7 +622,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json:95:5 @@ -659,7 +659,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkScopesResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json:782:5 @@ -682,7 +682,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseCommon' with an warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json:1142:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -712,7 +712,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ActivityLogAlertResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json:335:5 @@ -761,7 +761,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DataCollectionEndpoint-configurationAccess' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-09-01-preview/dataCollectionEndpoints_API.json:374:9 @@ -827,10 +827,10 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.insights-2021-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -860,7 +860,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TagsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json:878:5 @@ -873,7 +873,7 @@ warning | PreCheck/SchemaMissingType | The schema 'AzureMonitorPrivateLinkScopeP warning | PreCheck/SchemaMissingType | The schema 'AzureMonitorPrivateLinkScopeListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json:993:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2021-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -903,10 +903,10 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.insights-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -936,7 +936,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -969,7 +969,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms @@ -1002,7 +1002,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DataCollectionEndpoint-configurationAccess' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json:374:9 @@ -1030,7 +1030,7 @@ warning | PreCheck/SchemaMissingType | The schema 'DataCollectionRuleResource-sy - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json:793:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.insights-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1060,7 +1060,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-06-01/actionGroups_API.json:338:5 @@ -1131,7 +1131,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json:290:5 @@ -1190,7 +1190,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ActionGroupPatchBody-tags' wi warning | PreCheck/SchemaMissingType | The schema 'ActionGroupPatch' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/actionGroups_API.json:673:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2021-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1220,10 +1220,10 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2020-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1253,7 +1253,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ScheduledQueryRuleProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json:330:5 @@ -1262,7 +1262,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ScheduledQueryRuleResourcePat warning | PreCheck/SchemaMissingType | The schema 'ScheduledQueryRuleResourceCollection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json:470:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2020-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1292,7 +1292,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagementGroupProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json:202:5 @@ -1303,7 +1303,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ManagementGroupDiagnosticSett warning | PreCheck/SchemaMissingType | The schema 'ManagementGroupDiagnosticSettingsResourceCollection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json:292:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.insights-2019-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1333,7 +1333,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -1366,7 +1366,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/actionGroups_API.json:338:5 @@ -1443,7 +1443,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -1476,7 +1476,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DataCollectionRuleAssociationProxyOnlyResource-properties' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2019-11-01-preview/dataCollectionRuleAssociations_API.json:292:9 @@ -1520,7 +1520,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'GuestDiagnosticSettingsAssociationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json:312:5 @@ -1577,7 +1577,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/activityLogAlerts_API.json:296:5 @@ -1634,7 +1634,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'LocalizableString' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/metrics_API.json:141:5 @@ -1661,7 +1661,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ServiceDiagnosticSettingsReso warning | PreCheck/SchemaMissingType | The schema 'ServiceDiagnosticSettingsResourcePatch-tags' with an undefined type and additionalProperties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json:373:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.insights-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -1691,7 +1691,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -1724,7 +1724,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json:171:5 @@ -1769,7 +1769,7 @@ warning | DeprecatedConfig | Using directive.23.suppress which is deprecated and warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RuleManagementEventClaimsDataSource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/alertRules_API.json:375:5 @@ -1824,5 +1824,5 @@ warning | PreCheck/SchemaMissingType | The schema 'AutoscaleSettingResourceColle warning | PreCheck/SchemaMissingType | The schema 'ScaleRuleMetricDimension' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/autoscale_API.json:834:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms -info | Autorest completed in 86.08s. 54 files generated. +info | autorest.bicep took 6ms +info | Autorest completed in 82.1s. 54 files generated. diff --git a/generated/monitor/microsoft.insights/2014-04-01/types.md b/generated/monitor/microsoft.insights/2014-04-01/types.md index cb4a44a36c..7081445074 100644 --- a/generated/monitor/microsoft.insights/2014-04-01/types.md +++ b/generated/monitor/microsoft.insights/2014-04-01/types.md @@ -33,6 +33,78 @@ * **name**: string (Required): the name of the alert rule. * **provisioningState**: string: the provisioning state. +## AutoscaleNotification +### Properties +* **email**: [EmailNotification](#emailnotification): Email notification of an autoscale event. +* **operation**: 'Scale' (Required): the operation associated with the notification and its value must be "scale" +* **webhooks**: [WebhookNotification](#webhooknotification)[]: the collection of webhook notifications. + +## AutoscaleProfile +### Properties +* **capacity**: [ScaleCapacity](#scalecapacity) (Required): The number of instances that can be used during this profile. +* **fixedDate**: [TimeWindow](#timewindow): A specific date-time for the profile. +* **name**: string (Required): the name of the profile. +* **recurrence**: [Recurrence](#recurrence): The repeating times at which this profile begins. This element is not used if the FixedDate element is used. +* **rules**: [ScaleRule](#scalerule)[] (Required): the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. + +## AutoscaleSetting +### Properties +* **enabled**: bool: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. +* **name**: string: the name of the autoscale setting. +* **notifications**: [AutoscaleNotification](#autoscalenotification)[]: the collection of notifications. +* **profiles**: [AutoscaleProfile](#autoscaleprofile)[] (Required): the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. +* **targetResourceLocation**: string: the location of the resource that the autoscale setting should be added to. +* **targetResourceUri**: string: the resource identifier of the resource that the autoscale setting should be added to. + +## EmailNotification +### Properties +* **customEmails**: string[]: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. +* **sendToSubscriptionAdministrator**: bool: a value indicating whether to send email to subscription administrator. +* **sendToSubscriptionCoAdministrators**: bool: a value indicating whether to send email to subscription co-administrators. + +## ManagementEventAggregationCondition +### Properties +* **operator**: 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual': Operators allowed in the rule condition. +* **threshold**: int: The threshold value that activates the alert. +* **windowSize**: 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. + +## MetricTrigger +### Properties +* **dimensions**: [ScaleRuleMetricDimension](#scalerulemetricdimension)[]: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. +* **dividePerInstance**: bool: a value indicating whether metric should divide per instance. +* **metricName**: string (Required): the name of the metric that defines what the rule monitors. +* **metricNamespace**: string: the namespace of the metric that defines what the rule monitors. +* **metricResourceLocation**: string: the location of the resource the rule monitors. +* **metricResourceUri**: string (Required): the resource identifier of the resource the rule monitors. +* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEquals' (Required): the operator that is used to compare the metric data and the threshold. +* **statistic**: 'Average' | 'Count' | 'Max' | 'Min' | 'Sum' (Required): the metric statistic type. How the metrics from multiple instances are combined. +* **threshold**: int (Required): the threshold of the metric that triggers the scale action. +* **timeAggregation**: 'Average' | 'Count' | 'Last' | 'Maximum' | 'Minimum' | 'Total' (Required): time aggregation type. How the data that is collected should be combined over time. The default value is Average. +* **timeGrain**: string (Required): 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. +* **timeWindow**: string (Required): 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. + +## Recurrence +### Properties +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'None' | 'Second' | 'Week' | 'Year' (Required): 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. +* **schedule**: [RecurrentSchedule](#recurrentschedule) (Required): The scheduling constraints for when the profile begins. + +## RecurrentSchedule +### Properties +* **days**: string[] (Required): the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. +* **hours**: int[] (Required): 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). +* **minutes**: int[] (Required): A collection of minutes at which the profile takes effect at. +* **timeZone**: string (Required): 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 + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## RuleAction * **Discriminator**: odata.type @@ -50,11 +122,6 @@ * **serviceUri**: string: the service uri to Post the notification when the alert activates or resolves. -## RuleWebhookActionProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## RuleCondition * **Discriminator**: odata.type @@ -111,55 +178,17 @@ ### Properties * **emailAddress**: string: the email address. -## ManagementEventAggregationCondition -### Properties -* **operator**: 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual': Operators allowed in the rule condition. -* **threshold**: int: The threshold value that activates the alert. -* **windowSize**: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AutoscaleSetting -### Properties -* **enabled**: bool: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. -* **name**: string: the name of the autoscale setting. -* **notifications**: [AutoscaleNotification](#autoscalenotification)[]: the collection of notifications. -* **profiles**: [AutoscaleProfile](#autoscaleprofile)[] (Required): the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. -* **targetResourceLocation**: string: the location of the resource that the autoscale setting should be added to. -* **targetResourceUri**: string: the resource identifier of the resource that the autoscale setting should be added to. - -## AutoscaleNotification -### Properties -* **email**: [EmailNotification](#emailnotification): Email notification of an autoscale event. -* **operation**: 'Scale' (Required): the operation associated with the notification and its value must be "scale" -* **webhooks**: [WebhookNotification](#webhooknotification)[]: the collection of webhook notifications. - -## EmailNotification -### Properties -* **customEmails**: string[]: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. -* **sendToSubscriptionAdministrator**: bool: a value indicating whether to send email to subscription administrator. -* **sendToSubscriptionCoAdministrators**: bool: a value indicating whether to send email to subscription co-administrators. - -## WebhookNotification -### Properties -* **properties**: [WebhookNotificationProperties](#webhooknotificationproperties): a property bag of settings. This value can be empty. -* **serviceUri**: string: the service address to receive the notification. - -## WebhookNotificationProperties +## RuleWebhookActionProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## AutoscaleProfile +## ScaleAction ### Properties -* **capacity**: [ScaleCapacity](#scalecapacity) (Required): The number of instances that can be used during this profile. -* **fixedDate**: [TimeWindow](#timewindow): A specific date-time for the profile. -* **name**: string (Required): the name of the profile. -* **recurrence**: [Recurrence](#recurrence): The repeating times at which this profile begins. This element is not used if the FixedDate element is used. -* **rules**: [ScaleRule](#scalerule)[] (Required): the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. +* **cooldown**: string (Required): 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. +* **direction**: 'Decrease' | 'Increase' | 'None' (Required): the scale direction. Whether the scaling action increases or decreases the number of instances. +* **type**: 'ChangeCount' | 'ExactCount' | 'PercentChangeCount' | 'ServiceAllowedNextValue' (Required): the type of action that should occur when the scale rule fires. +* **value**: string: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. ## ScaleCapacity ### Properties @@ -167,58 +196,29 @@ * **maximum**: string (Required): 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. * **minimum**: string (Required): the minimum number of instances for the resource. -## TimeWindow -### Properties -* **end**: string (Required): the end time for the profile in ISO 8601 format. -* **start**: string (Required): the start time for the profile in ISO 8601 format. -* **timeZone**: 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 - -## Recurrence -### Properties -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'None' | 'Second' | 'Week' | 'Year' (Required): 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. -* **schedule**: [RecurrentSchedule](#recurrentschedule) (Required): The scheduling constraints for when the profile begins. - -## RecurrentSchedule -### Properties -* **days**: string[] (Required): the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. -* **hours**: int[] (Required): 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). -* **minutes**: int[] (Required): A collection of minutes at which the profile takes effect at. -* **timeZone**: string (Required): 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 - ## ScaleRule ### Properties * **metricTrigger**: [MetricTrigger](#metrictrigger) (Required): The trigger that results in a scaling action. * **scaleAction**: [ScaleAction](#scaleaction) (Required): The parameters for the scaling action. -## MetricTrigger -### Properties -* **dimensions**: [ScaleRuleMetricDimension](#scalerulemetricdimension)[]: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. -* **dividePerInstance**: bool: a value indicating whether metric should divide per instance. -* **metricName**: string (Required): the name of the metric that defines what the rule monitors. -* **metricNamespace**: string: the namespace of the metric that defines what the rule monitors. -* **metricResourceLocation**: string: the location of the resource the rule monitors. -* **metricResourceUri**: string (Required): the resource identifier of the resource the rule monitors. -* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEquals' (Required): the operator that is used to compare the metric data and the threshold. -* **statistic**: 'Average' | 'Count' | 'Max' | 'Min' | 'Sum' (Required): the metric statistic type. How the metrics from multiple instances are combined. -* **threshold**: int (Required): the threshold of the metric that triggers the scale action. -* **timeAggregation**: 'Average' | 'Count' | 'Last' | 'Maximum' | 'Minimum' | 'Total' (Required): time aggregation type. How the data that is collected should be combined over time. The default value is Average. -* **timeGrain**: string (Required): 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. -* **timeWindow**: string (Required): 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. - ## ScaleRuleMetricDimension ### Properties * **DimensionName**: string (Required): Name of the dimension. * **Operator**: 'Equals' | 'NotEquals' | string (Required): 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 * **Values**: string[] (Required): list of dimension values. For example: ["App1","App2"]. -## ScaleAction +## TimeWindow ### Properties -* **cooldown**: string (Required): 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. -* **direction**: 'Decrease' | 'Increase' | 'None' (Required): the scale direction. Whether the scaling action increases or decreases the number of instances. -* **type**: 'ChangeCount' | 'ExactCount' | 'PercentChangeCount' | 'ServiceAllowedNextValue' (Required): the type of action that should occur when the scale rule fires. -* **value**: string: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. +* **end**: string (Required): the end time for the profile in ISO 8601 format. +* **start**: string (Required): the start time for the profile in ISO 8601 format. +* **timeZone**: 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 -## ResourceTags +## WebhookNotification +### Properties +* **properties**: [WebhookNotificationProperties](#webhooknotificationproperties): a property bag of settings. This value can be empty. +* **serviceUri**: string: the service address to receive the notification. + +## WebhookNotificationProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/monitor/microsoft.insights/2015-04-01/types.md b/generated/monitor/microsoft.insights/2015-04-01/types.md index 52cffc8c9b..004a4ffbbd 100644 --- a/generated/monitor/microsoft.insights/2015-04-01/types.md +++ b/generated/monitor/microsoft.insights/2015-04-01/types.md @@ -11,37 +11,12 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Insights/autoscalesettings' (ReadOnly, DeployTimeConstant): The resource type -## AutoscaleSetting -### Properties -* **enabled**: bool: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. -* **name**: string: the name of the autoscale setting. -* **notifications**: [AutoscaleNotification](#autoscalenotification)[]: the collection of notifications. -* **profiles**: [AutoscaleProfile](#autoscaleprofile)[] (Required): the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. -* **targetResourceLocation**: string: the location of the resource that the autoscale setting should be added to. -* **targetResourceUri**: string: the resource identifier of the resource that the autoscale setting should be added to. - ## AutoscaleNotification ### Properties * **email**: [EmailNotification](#emailnotification): Email notification of an autoscale event. * **operation**: 'Scale' (Required): the operation associated with the notification and its value must be "scale" * **webhooks**: [WebhookNotification](#webhooknotification)[]: the collection of webhook notifications. -## EmailNotification -### Properties -* **customEmails**: string[]: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. -* **sendToSubscriptionAdministrator**: bool: a value indicating whether to send email to subscription administrator. -* **sendToSubscriptionCoAdministrators**: bool: a value indicating whether to send email to subscription co-administrators. - -## WebhookNotification -### Properties -* **properties**: [WebhookNotificationProperties](#webhooknotificationproperties): a property bag of settings. This value can be empty. -* **serviceUri**: string: the service address to receive the notification. - -## WebhookNotificationProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AutoscaleProfile ### Properties * **capacity**: [ScaleCapacity](#scalecapacity) (Required): The number of instances that can be used during this profile. @@ -50,17 +25,35 @@ * **recurrence**: [Recurrence](#recurrence): The repeating times at which this profile begins. This element is not used if the FixedDate element is used. * **rules**: [ScaleRule](#scalerule)[] (Required): the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. -## ScaleCapacity +## AutoscaleSetting ### Properties -* **default**: string (Required): 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. -* **maximum**: string (Required): 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. -* **minimum**: string (Required): the minimum number of instances for the resource. +* **enabled**: bool: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. +* **name**: string: the name of the autoscale setting. +* **notifications**: [AutoscaleNotification](#autoscalenotification)[]: the collection of notifications. +* **profiles**: [AutoscaleProfile](#autoscaleprofile)[] (Required): the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. +* **targetResourceLocation**: string: the location of the resource that the autoscale setting should be added to. +* **targetResourceUri**: string: the resource identifier of the resource that the autoscale setting should be added to. -## TimeWindow +## EmailNotification ### Properties -* **end**: string (Required): the end time for the profile in ISO 8601 format. -* **start**: string (Required): the start time for the profile in ISO 8601 format. -* **timeZone**: 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 +* **customEmails**: string[]: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. +* **sendToSubscriptionAdministrator**: bool: a value indicating whether to send email to subscription administrator. +* **sendToSubscriptionCoAdministrators**: bool: a value indicating whether to send email to subscription co-administrators. + +## MetricTrigger +### Properties +* **dimensions**: [ScaleRuleMetricDimension](#scalerulemetricdimension)[]: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. +* **dividePerInstance**: bool: a value indicating whether metric should divide per instance. +* **metricName**: string (Required): the name of the metric that defines what the rule monitors. +* **metricNamespace**: string: the namespace of the metric that defines what the rule monitors. +* **metricResourceLocation**: string: the location of the resource the rule monitors. +* **metricResourceUri**: string (Required): the resource identifier of the resource the rule monitors. +* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEquals' (Required): the operator that is used to compare the metric data and the threshold. +* **statistic**: 'Average' | 'Count' | 'Max' | 'Min' | 'Sum' (Required): the metric statistic type. How the metrics from multiple instances are combined. +* **threshold**: int (Required): the threshold of the metric that triggers the scale action. +* **timeAggregation**: 'Average' | 'Count' | 'Last' | 'Maximum' | 'Minimum' | 'Total' (Required): time aggregation type. How the data that is collected should be combined over time. The default value is Average. +* **timeGrain**: string (Required): 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. +* **timeWindow**: string (Required): 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. ## Recurrence ### Properties @@ -74,40 +67,47 @@ * **minutes**: int[] (Required): A collection of minutes at which the profile takes effect at. * **timeZone**: string (Required): 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 +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScaleAction +### Properties +* **cooldown**: string (Required): 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. +* **direction**: 'Decrease' | 'Increase' | 'None' (Required): the scale direction. Whether the scaling action increases or decreases the number of instances. +* **type**: 'ChangeCount' | 'ExactCount' | 'PercentChangeCount' | 'ServiceAllowedNextValue' (Required): the type of action that should occur when the scale rule fires. +* **value**: string: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. + +## ScaleCapacity +### Properties +* **default**: string (Required): 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. +* **maximum**: string (Required): 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. +* **minimum**: string (Required): the minimum number of instances for the resource. + ## ScaleRule ### Properties * **metricTrigger**: [MetricTrigger](#metrictrigger) (Required): The trigger that results in a scaling action. * **scaleAction**: [ScaleAction](#scaleaction) (Required): The parameters for the scaling action. -## MetricTrigger -### Properties -* **dimensions**: [ScaleRuleMetricDimension](#scalerulemetricdimension)[]: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. -* **dividePerInstance**: bool: a value indicating whether metric should divide per instance. -* **metricName**: string (Required): the name of the metric that defines what the rule monitors. -* **metricNamespace**: string: the namespace of the metric that defines what the rule monitors. -* **metricResourceLocation**: string: the location of the resource the rule monitors. -* **metricResourceUri**: string (Required): the resource identifier of the resource the rule monitors. -* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEquals' (Required): the operator that is used to compare the metric data and the threshold. -* **statistic**: 'Average' | 'Count' | 'Max' | 'Min' | 'Sum' (Required): the metric statistic type. How the metrics from multiple instances are combined. -* **threshold**: int (Required): the threshold of the metric that triggers the scale action. -* **timeAggregation**: 'Average' | 'Count' | 'Last' | 'Maximum' | 'Minimum' | 'Total' (Required): time aggregation type. How the data that is collected should be combined over time. The default value is Average. -* **timeGrain**: string (Required): 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. -* **timeWindow**: string (Required): 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. - ## ScaleRuleMetricDimension ### Properties * **DimensionName**: string (Required): Name of the dimension. * **Operator**: 'Equals' | 'NotEquals' | string (Required): 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 * **Values**: string[] (Required): list of dimension values. For example: ["App1","App2"]. -## ScaleAction +## TimeWindow ### Properties -* **cooldown**: string (Required): 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. -* **direction**: 'Decrease' | 'Increase' | 'None' (Required): the scale direction. Whether the scaling action increases or decreases the number of instances. -* **type**: 'ChangeCount' | 'ExactCount' | 'PercentChangeCount' | 'ServiceAllowedNextValue' (Required): the type of action that should occur when the scale rule fires. -* **value**: string: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. +* **end**: string (Required): the end time for the profile in ISO 8601 format. +* **start**: string (Required): the start time for the profile in ISO 8601 format. +* **timeZone**: 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 -## ResourceTags +## WebhookNotification +### Properties +* **properties**: [WebhookNotificationProperties](#webhooknotificationproperties): a property bag of settings. This value can be empty. +* **serviceUri**: string: the service address to receive the notification. + +## WebhookNotificationProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/monitor/microsoft.insights/2015-07-01/types.md b/generated/monitor/microsoft.insights/2015-07-01/types.md index 733f559135..bf69fe5d91 100644 --- a/generated/monitor/microsoft.insights/2015-07-01/types.md +++ b/generated/monitor/microsoft.insights/2015-07-01/types.md @@ -11,25 +11,12 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'microsoft.insights/diagnosticSettings' (ReadOnly, DeployTimeConstant): The resource type -## ServiceDiagnosticSettings -### Properties -* **logs**: [LogSettings](#logsettings)[]: the list of logs settings. -* **metrics**: [MetricSettings](#metricsettings)[]: the list of metric settings. -* **serviceBusRuleId**: string: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming Diagnostic Logs. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'. -* **storageAccountId**: string: The resource ID of the storage account to which you would like to send Diagnostic Logs. -* **workspaceId**: string: The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 - ## LogSettings ### Properties * **category**: string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. * **enabled**: bool (Required): a value indicating whether this log is enabled. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. -## RetentionPolicy -### Properties -* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. -* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. - ## MetricSettings ### Properties * **enabled**: bool (Required): a value indicating whether this timegrain is enabled. @@ -41,3 +28,16 @@ ### Additional Properties * **Additional Properties Type**: string +## RetentionPolicy +### Properties +* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. +* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. + +## ServiceDiagnosticSettings +### Properties +* **logs**: [LogSettings](#logsettings)[]: the list of logs settings. +* **metrics**: [MetricSettings](#metricsettings)[]: the list of metric settings. +* **serviceBusRuleId**: string: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming Diagnostic Logs. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'. +* **storageAccountId**: string: The resource ID of the storage account to which you would like to send Diagnostic Logs. +* **workspaceId**: string: The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + diff --git a/generated/monitor/microsoft.insights/2016-03-01/types.md b/generated/monitor/microsoft.insights/2016-03-01/types.md index f5ed31224a..fc8a6fe284 100644 --- a/generated/monitor/microsoft.insights/2016-03-01/types.md +++ b/generated/monitor/microsoft.insights/2016-03-01/types.md @@ -33,6 +33,35 @@ * **name**: string (Required): the name of the alert rule. * **provisioningState**: string: the provisioning state. +## LogProfileProperties +### Properties +* **categories**: string[] (Required): the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.' +* **locations**: string[] (Required): List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the 'global' location. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy) (Required): Specifies the retention policy for the log. +* **serviceBusRuleId**: string: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'. +* **storageAccountId**: string: the resource id of the storage account to which you would like to send the Activity Log. + +## ManagementEventAggregationCondition +### Properties +* **operator**: 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual': Operators allowed in the rule condition. +* **threshold**: int: The threshold value that activates the alert. +* **windowSize**: 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. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionPolicy +### Properties +* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. +* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. + ## RuleAction * **Discriminator**: odata.type @@ -50,11 +79,6 @@ * **serviceUri**: string: the service uri to Post the notification when the alert activates or resolves. -## RuleWebhookActionProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## RuleCondition * **Discriminator**: odata.type @@ -111,31 +135,7 @@ ### Properties * **emailAddress**: string: the email address. -## ManagementEventAggregationCondition -### Properties -* **operator**: 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual': Operators allowed in the rule condition. -* **threshold**: int: The threshold value that activates the alert. -* **windowSize**: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LogProfileProperties -### Properties -* **categories**: string[] (Required): the categories of the logs. These categories are created as is convenient to the user. Some values are: 'Write', 'Delete', and/or 'Action.' -* **locations**: string[] (Required): List of regions for which Activity Log events should be stored or streamed. It is a comma separated list of valid ARM locations including the 'global' location. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy) (Required): Specifies the retention policy for the log. -* **serviceBusRuleId**: string: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'. -* **storageAccountId**: string: the resource id of the storage account to which you would like to send the Activity Log. - -## RetentionPolicy -### Properties -* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. -* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. - -## ResourceTags +## RuleWebhookActionProperties ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/monitor/microsoft.insights/2016-09-01/types.md b/generated/monitor/microsoft.insights/2016-09-01/types.md index 0926bb36c0..ad82185f13 100644 --- a/generated/monitor/microsoft.insights/2016-09-01/types.md +++ b/generated/monitor/microsoft.insights/2016-09-01/types.md @@ -11,26 +11,12 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'microsoft.insights/diagnosticSettings' (ReadOnly, DeployTimeConstant): The resource type -## ServiceDiagnosticSettings -### Properties -* **eventHubAuthorizationRuleId**: string: The resource Id for the event hub namespace authorization rule. -* **logs**: [LogSettings](#logsettings)[]: the list of logs settings. -* **metrics**: [MetricSettings](#metricsettings)[]: the list of metric settings. -* **serviceBusRuleId**: string: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming Diagnostic Logs. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'. -* **storageAccountId**: string: The resource ID of the storage account to which you would like to send Diagnostic Logs. -* **workspaceId**: string: The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 - ## LogSettings ### Properties * **category**: string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. * **enabled**: bool (Required): a value indicating whether this log is enabled. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. -## RetentionPolicy -### Properties -* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. -* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. - ## MetricSettings ### Properties * **enabled**: bool (Required): a value indicating whether this timegrain is enabled. @@ -42,3 +28,17 @@ ### Additional Properties * **Additional Properties Type**: string +## RetentionPolicy +### Properties +* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. +* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. + +## ServiceDiagnosticSettings +### Properties +* **eventHubAuthorizationRuleId**: string: The resource Id for the event hub namespace authorization rule. +* **logs**: [LogSettings](#logsettings)[]: the list of logs settings. +* **metrics**: [MetricSettings](#metricsettings)[]: the list of metric settings. +* **serviceBusRuleId**: string: The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming Diagnostic Logs. The rule ID is of the format: '{service bus resource ID}/authorizationrules/{key name}'. +* **storageAccountId**: string: The resource ID of the storage account to which you would like to send Diagnostic Logs. +* **workspaceId**: string: The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 + diff --git a/generated/monitor/microsoft.insights/2017-03-01-preview/types.md b/generated/monitor/microsoft.insights/2017-03-01-preview/types.md index f2a77fd5a1..a87ee0daf7 100644 --- a/generated/monitor/microsoft.insights/2017-03-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2017-03-01-preview/types.md @@ -19,10 +19,6 @@ * **enabled**: bool: Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. * **scopes**: string[] (Required): 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. -## ActivityLogAlertActionList -### Properties -* **actionGroups**: [ActivityLogAlertActionGroup](#activitylogalertactiongroup)[]: The list of activity log alerts. - ## ActivityLogAlertActionGroup ### Properties * **actionGroupId**: string (Required): The resourceId of the action group. This cannot be null or empty. @@ -33,6 +29,10 @@ ### Additional Properties * **Additional Properties Type**: string +## ActivityLogAlertActionList +### Properties +* **actionGroups**: [ActivityLogAlertActionGroup](#activitylogalertactiongroup)[]: The list of activity log alerts. + ## ActivityLogAlertAllOfCondition ### Properties * **allOf**: [ActivityLogAlertLeafCondition](#activitylogalertleafcondition)[] (Required): The list of activity log alert conditions. diff --git a/generated/monitor/microsoft.insights/2017-04-01/types.md b/generated/monitor/microsoft.insights/2017-04-01/types.md index 779048eef7..64d16f74d8 100644 --- a/generated/monitor/microsoft.insights/2017-04-01/types.md +++ b/generated/monitor/microsoft.insights/2017-04-01/types.md @@ -33,6 +33,37 @@ * **smsReceivers**: [SmsReceiver](#smsreceiver)[]: The list of SMS receivers that are part of this action group. * **webhookReceivers**: [WebhookReceiver](#webhookreceiver)[]: The list of webhook receivers that are part of this action group. +## ActivityLogAlert +### Properties +* **actions**: [ActivityLogAlertActionList](#activitylogalertactionlist) (Required): A list of activity log alert actions. +* **condition**: [ActivityLogAlertAllOfCondition](#activitylogalertallofcondition) (Required): An Activity Log alert condition that is met when all its member conditions are met. +* **description**: string: A description of this activity log alert. +* **enabled**: bool: Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. +* **scopes**: string[] (Required): 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. + +## ActivityLogAlertActionGroup +### Properties +* **actionGroupId**: string (Required): The resourceId of the action group. This cannot be null or empty. +* **webhookProperties**: [ActivityLogAlertActionGroupWebhookProperties](#activitylogalertactiongroupwebhookproperties): the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. + +## ActivityLogAlertActionGroupWebhookProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ActivityLogAlertActionList +### Properties +* **actionGroups**: [ActivityLogAlertActionGroup](#activitylogalertactiongroup)[]: The list of activity log alerts. + +## ActivityLogAlertAllOfCondition +### Properties +* **allOf**: [ActivityLogAlertLeafCondition](#activitylogalertleafcondition)[] (Required): The list of activity log alert conditions. + +## ActivityLogAlertLeafCondition +### Properties +* **equals**: string (Required): The field value will be compared to this value (case-insensitive) to determine if the condition is met. +* **field**: string (Required): 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.'. + ## AutomationRunbookReceiver ### Properties * **automationAccountId**: string (Required): The Azure automation account Id which holds this runbook and authenticate to Azure resource. @@ -61,56 +92,25 @@ * **ticketConfiguration**: string (Required): JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well. * **workspaceId**: string (Required): OMS LA instance identifier. -## SmsReceiver -### Properties -* **countryCode**: string (Required): The country code of the SMS receiver. -* **name**: string (Required): The name of the SMS receiver. Names must be unique across all receivers within an action group. -* **phoneNumber**: string (Required): The phone number of the SMS receiver. -* **status**: 'Disabled' | 'Enabled' | 'NotSpecified' (ReadOnly): Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications. - -## WebhookReceiver -### Properties -* **name**: string (Required): The name of the webhook receiver. Names must be unique across all receivers within an action group. -* **serviceUri**: string (Required): The URI where webhooks should be sent. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ActivityLogAlert -### Properties -* **actions**: [ActivityLogAlertActionList](#activitylogalertactionlist) (Required): A list of activity log alert actions. -* **condition**: [ActivityLogAlertAllOfCondition](#activitylogalertallofcondition) (Required): An Activity Log alert condition that is met when all its member conditions are met. -* **description**: string: A description of this activity log alert. -* **enabled**: bool: Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. -* **scopes**: string[] (Required): 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. - -## ActivityLogAlertActionList -### Properties -* **actionGroups**: [ActivityLogAlertActionGroup](#activitylogalertactiongroup)[]: The list of activity log alerts. - -## ActivityLogAlertActionGroup -### Properties -* **actionGroupId**: string (Required): The resourceId of the action group. This cannot be null or empty. -* **webhookProperties**: [ActivityLogAlertActionGroupWebhookProperties](#activitylogalertactiongroupwebhookproperties): the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. - -## ActivityLogAlertActionGroupWebhookProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ActivityLogAlertAllOfCondition -### Properties -* **allOf**: [ActivityLogAlertLeafCondition](#activitylogalertleafcondition)[] (Required): The list of activity log alert conditions. - -## ActivityLogAlertLeafCondition +## SmsReceiver ### Properties -* **equals**: string (Required): The field value will be compared to this value (case-insensitive) to determine if the condition is met. -* **field**: string (Required): 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.'. +* **countryCode**: string (Required): The country code of the SMS receiver. +* **name**: string (Required): The name of the SMS receiver. Names must be unique across all receivers within an action group. +* **phoneNumber**: string (Required): The phone number of the SMS receiver. +* **status**: 'Disabled' | 'Enabled' | 'NotSpecified' (ReadOnly): Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications. -## ResourceTags +## WebhookReceiver ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of the webhook receiver. Names must be unique across all receivers within an action group. +* **serviceUri**: string (Required): The URI where webhooks should be sent. diff --git a/generated/monitor/microsoft.insights/2017-05-01-preview/types.md b/generated/monitor/microsoft.insights/2017-05-01-preview/types.md index 2680aa09ae..8cb7b85841 100644 --- a/generated/monitor/microsoft.insights/2017-05-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2017-05-01-preview/types.md @@ -26,11 +26,6 @@ * **enabled**: bool (Required): a value indicating whether this log is enabled. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. -## RetentionPolicy -### Properties -* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. -* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. - ## MetricSettings ### Properties * **category**: string: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. @@ -38,3 +33,8 @@ * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. * **timeGrain**: string: the timegrain of the metric in ISO8601 format. +## RetentionPolicy +### Properties +* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. +* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. + diff --git a/generated/monitor/microsoft.insights/2018-03-01/types.md b/generated/monitor/microsoft.insights/2018-03-01/types.md index e3fc8e3910..2f8339f50d 100644 --- a/generated/monitor/microsoft.insights/2018-03-01/types.md +++ b/generated/monitor/microsoft.insights/2018-03-01/types.md @@ -57,6 +57,11 @@ * **httpTriggerUrl**: string (Required): The http trigger url where http request sent to. * **name**: string (Required): The name of the azure function receiver. Names must be unique across all receivers within an action group. +## DynamicThresholdFailingPeriods +### Properties +* **minFailingPeriodsToAlert**: int (Required): The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. +* **numberOfEvaluationPeriods**: int (Required): 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. + ## EmailReceiver ### Properties * **emailAddress**: string (Required): The email address of this receiver. @@ -77,45 +82,6 @@ * **name**: string (Required): The name of the logic app receiver. Names must be unique across all receivers within an action group. * **resourceId**: string (Required): The azure resource id of the logic app receiver. -## SmsReceiver -### Properties -* **countryCode**: string (Required): The country code of the SMS receiver. -* **name**: string (Required): The name of the SMS receiver. Names must be unique across all receivers within an action group. -* **phoneNumber**: string (Required): The phone number of the SMS receiver. -* **status**: 'Disabled' | 'Enabled' | 'NotSpecified' (ReadOnly): Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications. - -## VoiceReceiver -### Properties -* **countryCode**: string (Required): The country code of the voice receiver. -* **name**: string (Required): The name of the voice receiver. Names must be unique across all receivers within an action group. -* **phoneNumber**: string (Required): The phone number of the voice receiver. - -## WebhookReceiver -### Properties -* **name**: string (Required): The name of the webhook receiver. Names must be unique across all receivers within an action group. -* **serviceUri**: string (Required): The URI where webhooks should be sent. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MetricAlertProperties -### Properties -* **actions**: [MetricAlertAction](#metricalertaction)[]: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. -* **autoMitigate**: bool: the flag that indicates whether the alert should be auto resolved or not. The default is true. -* **criteria**: [MetricAlertCriteria](#metricalertcriteria) (Required): The rule criteria that defines the conditions of the alert rule. -* **description**: string: the description of the metric alert that will be included in the alert email. -* **enabled**: bool (Required): the flag that indicates whether the metric alert is enabled. -* **evaluationFrequency**: string (Required): how often the metric alert is evaluated represented in ISO 8601 duration format. -* **isMigrated**: bool (ReadOnly): the value indicating whether this alert rule is migrated. -* **lastUpdatedTime**: string (ReadOnly): Last time the rule was updated in ISO8601 format. -* **scopes**: string[] (Required): the list of resource id's that this metric alert is scoped to. -* **severity**: int (Required): Alert severity {0, 1, 2, 3, 4} -* **targetResourceRegion**: 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. -* **targetResourceType**: 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. -* **windowSize**: string (Required): the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. - ## MetricAlertAction ### Properties * **actionGroupId**: string: the id of the action group to use. @@ -148,6 +114,42 @@ * **webTestId**: string (Required): The Application Insights web test Id. +## MetricAlertProperties +### Properties +* **actions**: [MetricAlertAction](#metricalertaction)[]: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. +* **autoMitigate**: bool: the flag that indicates whether the alert should be auto resolved or not. The default is true. +* **criteria**: [MetricAlertCriteria](#metricalertcriteria) (Required): The rule criteria that defines the conditions of the alert rule. +* **description**: string: the description of the metric alert that will be included in the alert email. +* **enabled**: bool (Required): the flag that indicates whether the metric alert is enabled. +* **evaluationFrequency**: string (Required): how often the metric alert is evaluated represented in ISO 8601 duration format. +* **isMigrated**: bool (ReadOnly): the value indicating whether this alert rule is migrated. +* **lastUpdatedTime**: string (ReadOnly): Last time the rule was updated in ISO8601 format. +* **scopes**: string[] (Required): the list of resource id's that this metric alert is scoped to. +* **severity**: int (Required): Alert severity {0, 1, 2, 3, 4} +* **targetResourceRegion**: 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. +* **targetResourceType**: 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. +* **windowSize**: string (Required): the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. + +## MetricCriteria +### Properties +* **criterionType**: 'DynamicThresholdCriterion' | 'StaticThresholdCriterion' | string (Required): Specifies the type of threshold criteria +* **dimensions**: [MetricDimension](#metricdimension)[]: List of dimension conditions. +* **metricName**: string (Required): Name of the metric. +* **metricNamespace**: string: Namespace of the metric. +* **name**: string (Required): Name of the criteria. +* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): the criteria operator. +* **skipMetricValidation**: bool: Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped. +* **threshold**: int (Required): the criteria threshold value that activates the alert. +* **timeAggregation**: 'Average' | 'Count' | 'Maximum' | 'Minimum' | 'Total' | string (Required): the criteria time aggregation types. +### Additional Properties +* **Additional Properties Type**: any + +## MetricDimension +### Properties +* **name**: string (Required): Name of the dimension. +* **operator**: string (Required): the dimension operator. Only 'Include' and 'Exclude' are supported +* **values**: string[] (Required): list of dimension values. + ## MultiMetricCriteria * **Discriminator**: criterionType @@ -173,33 +175,31 @@ * **threshold**: int (Required): the criteria threshold value that activates the alert. -## MetricDimension -### Properties -* **name**: string (Required): Name of the dimension. -* **operator**: string (Required): the dimension operator. Only 'Include' and 'Exclude' are supported -* **values**: string[] (Required): list of dimension values. - -## DynamicThresholdFailingPeriods -### Properties -* **minFailingPeriodsToAlert**: int (Required): The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. -* **numberOfEvaluationPeriods**: int (Required): 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. - -## MetricCriteria +## ResourceTags ### Properties -* **criterionType**: 'DynamicThresholdCriterion' | 'StaticThresholdCriterion' | string (Required): Specifies the type of threshold criteria -* **dimensions**: [MetricDimension](#metricdimension)[]: List of dimension conditions. -* **metricName**: string (Required): Name of the metric. -* **metricNamespace**: string: Namespace of the metric. -* **name**: string (Required): Name of the criteria. -* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): the criteria operator. -* **skipMetricValidation**: bool: Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped. -* **threshold**: int (Required): the criteria threshold value that activates the alert. -* **timeAggregation**: 'Average' | 'Count' | 'Maximum' | 'Minimum' | 'Total' | string (Required): the criteria time aggregation types. ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## SmsReceiver +### Properties +* **countryCode**: string (Required): The country code of the SMS receiver. +* **name**: string (Required): The name of the SMS receiver. Names must be unique across all receivers within an action group. +* **phoneNumber**: string (Required): The phone number of the SMS receiver. +* **status**: 'Disabled' | 'Enabled' | 'NotSpecified' (ReadOnly): Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications. + +## VoiceReceiver +### Properties +* **countryCode**: string (Required): The country code of the voice receiver. +* **name**: string (Required): The name of the voice receiver. Names must be unique across all receivers within an action group. +* **phoneNumber**: string (Required): The phone number of the voice receiver. + +## WebhookReceiver +### Properties +* **name**: string (Required): The name of the webhook receiver. Names must be unique across all receivers within an action group. +* **serviceUri**: string (Required): The URI where webhooks should be sent. + diff --git a/generated/monitor/microsoft.insights/2018-04-16/types.md b/generated/monitor/microsoft.insights/2018-04-16/types.md index 2fdd499188..6a84782a77 100644 --- a/generated/monitor/microsoft.insights/2018-04-16/types.md +++ b/generated/monitor/microsoft.insights/2018-04-16/types.md @@ -13,20 +13,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Insights/scheduledQueryRules' (ReadOnly, DeployTimeConstant): The resource type -## LogSearchRule -### Properties -* **action**: [Action](#action) (Required): Action descriptor. -* **autoMitigate**: bool: The flag that indicates whether the alert should be automatically resolved or not. The default is false. -* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule -* **description**: string: The description of the Log Search rule. -* **displayName**: string: The display name of the alert rule -* **enabled**: 'false' | 'true' | string: The flag which indicates whether the Log Search rule is enabled. Value should be true or false -* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule -* **lastUpdatedTime**: string (ReadOnly): Last time the rule was updated in IS08601 format. -* **provisioningState**: 'Canceled' | 'Deploying' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the scheduled query rule -* **schedule**: [Schedule](#schedule): Defines how often to run the search and the time interval. -* **source**: [Source](#source) (Required): Specifies the log search query. - ## Action * **Discriminator**: odata.type @@ -51,11 +37,16 @@ * **customWebhookPayload**: string: Custom payload to be sent for all webhook URI in Azure action group * **emailSubject**: string: Custom subject override for all email ids in Azure action group -## TriggerCondition +## Criteria ### Properties -* **metricTrigger**: [LogMetricTrigger](#logmetrictrigger): A log metrics trigger descriptor. -* **threshold**: int (Required): Result or count threshold based on which rule should be triggered. -* **thresholdOperator**: 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Result Condition Evaluation criteria. +* **dimensions**: [Dimension](#dimension)[]: List of Dimensions for creating metric +* **metricName**: string (Required): Name of the metric + +## Dimension +### Properties +* **name**: string (Required): Name of the dimension +* **operator**: 'Include' | string (Required): Operator for dimension values +* **values**: string[] (Required): List of dimension values ## LogMetricTrigger ### Properties @@ -64,16 +55,24 @@ * **threshold**: int: The threshold of the metric trigger. * **thresholdOperator**: 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string: Result Condition Evaluation criteria. -## Criteria +## LogSearchRule ### Properties -* **dimensions**: [Dimension](#dimension)[]: List of Dimensions for creating metric -* **metricName**: string (Required): Name of the metric +* **action**: [Action](#action) (Required): Action descriptor. +* **autoMitigate**: bool: The flag that indicates whether the alert should be automatically resolved or not. The default is false. +* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule +* **description**: string: The description of the Log Search rule. +* **displayName**: string: The display name of the alert rule +* **enabled**: 'false' | 'true' | string: The flag which indicates whether the Log Search rule is enabled. Value should be true or false +* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule +* **lastUpdatedTime**: string (ReadOnly): Last time the rule was updated in IS08601 format. +* **provisioningState**: 'Canceled' | 'Deploying' | 'Failed' | 'Succeeded' | string (ReadOnly): Provisioning state of the scheduled query rule +* **schedule**: [Schedule](#schedule): Defines how often to run the search and the time interval. +* **source**: [Source](#source) (Required): Specifies the log search query. -## Dimension +## ResourceTags ### Properties -* **name**: string (Required): Name of the dimension -* **operator**: 'Include' | string (Required): Operator for dimension values -* **values**: string[] (Required): List of dimension values +### Additional Properties +* **Additional Properties Type**: string ## Schedule ### Properties @@ -87,8 +86,9 @@ * **query**: string: Log search query. Required for action type - AlertingAction * **queryType**: 'ResultCount' | string: Set value to 'ResultAccount' -## ResourceTags +## TriggerCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **metricTrigger**: [LogMetricTrigger](#logmetrictrigger): A log metrics trigger descriptor. +* **threshold**: int (Required): Result or count threshold based on which rule should be triggered. +* **thresholdOperator**: 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | string (Required): Result Condition Evaluation criteria. diff --git a/generated/monitor/microsoft.insights/2018-06-01-preview/types.md b/generated/monitor/microsoft.insights/2018-06-01-preview/types.md index 6a68e7644e..3732f74012 100644 --- a/generated/monitor/microsoft.insights/2018-06-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2018-06-01-preview/types.md @@ -22,12 +22,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'microsoft.insights/guestDiagnosticSettingsAssociation' (ReadOnly, DeployTimeConstant): The resource type -## GuestDiagnosticSettings -### Properties -* **dataSources**: [DataSource](#datasource)[]: the array of data source object which are configured to collect and send data -* **osType**: 'Linux' | 'Windows' | string: Operating system type for the configuration -* **proxySetting**: string - ## DataSource ### Properties * **configuration**: [DataSourceConfiguration](#datasourceconfiguration) (Required) @@ -40,43 +34,49 @@ * **perfCounters**: [PerformanceCounterConfiguration](#performancecounterconfiguration)[]: Performance counter configuration * **providers**: [EtwProviderConfiguration](#etwproviderconfiguration)[]: ETW providers configuration -## EventLogConfiguration +## EtwEventConfiguration ### Properties * **filter**: string -* **logName**: string (Required) - -## PerformanceCounterConfiguration -### Properties -* **instance**: string +* **id**: int (Required) * **name**: string (Required) -* **samplingPeriod**: string (Required) ## EtwProviderConfiguration ### Properties * **events**: [EtwEventConfiguration](#etweventconfiguration)[] (Required): Array of EtwEventConfiguration * **id**: string (Required) -## EtwEventConfiguration +## EventLogConfiguration ### Properties * **filter**: string -* **id**: int (Required) -* **name**: string (Required) +* **logName**: string (Required) -## SinkConfiguration +## GuestDiagnosticSettings ### Properties -* **kind**: 'ApplicationInsights' | 'EventHub' | 'LogAnalytics' | string (Required) +* **dataSources**: [DataSource](#datasource)[]: the array of data source object which are configured to collect and send data +* **osType**: 'Linux' | 'Windows' | string: Operating system type for the configuration +* **proxySetting**: string + +## GuestDiagnosticSettingsAssociation +### Properties +* **guestDiagnosticSettingsName**: string (Required): The guest diagnostic settings name. + +## PerformanceCounterConfiguration +### Properties +* **instance**: string +* **name**: string (Required) +* **samplingPeriod**: string (Required) ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## GuestDiagnosticSettingsAssociation -### Properties -* **guestDiagnosticSettingsName**: string (Required): The guest diagnostic settings name. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## SinkConfiguration +### Properties +* **kind**: 'ApplicationInsights' | 'EventHub' | 'LogAnalytics' | string (Required) + diff --git a/generated/monitor/microsoft.insights/2018-09-01/types.md b/generated/monitor/microsoft.insights/2018-09-01/types.md index cbebaa7996..902554c3d8 100644 --- a/generated/monitor/microsoft.insights/2018-09-01/types.md +++ b/generated/monitor/microsoft.insights/2018-09-01/types.md @@ -72,6 +72,11 @@ * **name**: string (Required): The name of the logic app receiver. Names must be unique across all receivers within an action group. * **resourceId**: string (Required): The azure resource id of the logic app receiver. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SmsReceiver ### Properties * **countryCode**: string (Required): The country code of the SMS receiver. @@ -90,8 +95,3 @@ * **name**: string (Required): The name of the webhook receiver. Names must be unique across all receivers within an action group. * **serviceUri**: string (Required): The URI where webhooks should be sent. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2019-03-01/types.md b/generated/monitor/microsoft.insights/2019-03-01/types.md index 48924c53f4..32937603e3 100644 --- a/generated/monitor/microsoft.insights/2019-03-01/types.md +++ b/generated/monitor/microsoft.insights/2019-03-01/types.md @@ -57,6 +57,11 @@ * **name**: string (Required): The name of the azure function receiver. Names must be unique across all receivers within an action group. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. +## AzureResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## EmailReceiver ### Properties * **emailAddress**: string (Required): The email address of this receiver. @@ -98,8 +103,3 @@ * **serviceUri**: string (Required): The URI where webhooks should be sent. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. -## AzureResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2019-06-01/types.md b/generated/monitor/microsoft.insights/2019-06-01/types.md index 424909e986..6e824b7d7c 100644 --- a/generated/monitor/microsoft.insights/2019-06-01/types.md +++ b/generated/monitor/microsoft.insights/2019-06-01/types.md @@ -57,6 +57,11 @@ * **name**: string (Required): The name of the azure function receiver. Names must be unique across all receivers within an action group. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. +## AzureResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## EmailReceiver ### Properties * **emailAddress**: string (Required): The email address of this receiver. @@ -102,8 +107,3 @@ * **useAadAuth**: bool: Indicates whether or not use AAD authentication. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. -## AzureResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2019-10-17-preview/types.md b/generated/monitor/microsoft.insights/2019-10-17-preview/types.md index 35eeb8bb96..b0d109633f 100644 --- a/generated/monitor/microsoft.insights/2019-10-17-preview/types.md +++ b/generated/monitor/microsoft.insights/2019-10-17-preview/types.md @@ -51,17 +51,17 @@ ### Properties * **id**: string: Resource id of the private endpoint. +## PrivateLinkScopesResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PrivateLinkServiceConnectionStateProperty ### Properties * **actionsRequired**: string (ReadOnly): The actions required for private link service connection. * **description**: string (Required): The private link service connection description. * **status**: string (Required): The private link service connection status. -## PrivateLinkScopesResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ScopedResourceProperties ### Properties * **linkedResourceId**: string: The resource id of the scoped Azure monitor resource. diff --git a/generated/monitor/microsoft.insights/2019-11-01-preview/types.md b/generated/monitor/microsoft.insights/2019-11-01-preview/types.md index 70a8cfc15a..241043c8e2 100644 --- a/generated/monitor/microsoft.insights/2019-11-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2019-11-01-preview/types.md @@ -29,6 +29,18 @@ * **description**: string: Description of the association. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. +## DataCollectionRuleDataSources +### Properties +* **extensions**: [ExtensionDataSource](#extensiondatasource)[]: The list of Azure VM extension data source configurations. +* **performanceCounters**: [PerfCounterDataSource](#perfcounterdatasource)[]: The list of performance counter data source configurations. +* **syslog**: [SyslogDataSource](#syslogdatasource)[]: The list of Syslog data source configurations. +* **windowsEventLogs**: [WindowsEventLogDataSource](#windowseventlogdatasource)[]: The list of Windows Event Log data source configurations. + +## DataCollectionRuleDestinations +### Properties +* **azureMonitorMetrics**: [DestinationsSpecAzureMonitorMetrics](#destinationsspecazuremonitormetrics): Azure Monitor Metrics destination. +* **logAnalytics**: [LogAnalyticsDestination](#loganalyticsdestination)[]: List of Log Analytics destinations. + ## DataCollectionRuleResourceProperties ### Properties * **dataFlows**: [DataFlow](#dataflow)[]: The specification of data flows. @@ -39,17 +51,20 @@ This property is optional and can be omitted if the rule is meant to be used via * **immutableId**: string (ReadOnly): The immutable ID of this data collection rule. This property is READ-ONLY. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. +## DataCollectionRuleResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DataFlow ### Properties * **destinations**: string[]: List of destinations for this data flow. * **streams**: 'Microsoft-Event' | 'Microsoft-InsightsMetrics' | 'Microsoft-Perf' | 'Microsoft-Syslog' | 'Microsoft-WindowsEvent' | string[]: List of streams for this data flow. -## DataCollectionRuleDataSources +## DestinationsSpecAzureMonitorMetrics ### Properties -* **extensions**: [ExtensionDataSource](#extensiondatasource)[]: The list of Azure VM extension data source configurations. -* **performanceCounters**: [PerfCounterDataSource](#perfcounterdatasource)[]: The list of performance counter data source configurations. -* **syslog**: [SyslogDataSource](#syslogdatasource)[]: The list of Syslog data source configurations. -* **windowsEventLogs**: [WindowsEventLogDataSource](#windowseventlogdatasource)[]: The list of Windows Event Log data source configurations. +* **name**: string: A friendly name for the destination. +This name should be unique across all destinations (regardless of type) within the data collection rule. ## ExtensionDataSource ### Properties @@ -61,6 +76,13 @@ This name should be unique across all data sources (regardless of type) within t * **streams**: 'Microsoft-Event' | 'Microsoft-InsightsMetrics' | 'Microsoft-Perf' | 'Microsoft-Syslog' | 'Microsoft-WindowsEvent' | 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. +## LogAnalyticsDestination +### Properties +* **name**: string: A friendly name for the destination. +This name should be unique across all destinations (regardless of type) within the data collection rule. +* **workspaceId**: string (ReadOnly): The Customer ID of the Log Analytics workspace. +* **workspaceResourceId**: string: The resource ID of the Log Analytics workspace. + ## PerfCounterDataSource ### Properties * **counterSpecifiers**: string[]: A list of specifier names of the performance counters you want to collect. @@ -89,25 +111,3 @@ This name should be unique across all data sources (regardless of type) within t A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. * **xPathQueries**: string[]: A list of Windows Event Log queries in XPATH format. -## DataCollectionRuleDestinations -### Properties -* **azureMonitorMetrics**: [DestinationsSpecAzureMonitorMetrics](#destinationsspecazuremonitormetrics): Azure Monitor Metrics destination. -* **logAnalytics**: [LogAnalyticsDestination](#loganalyticsdestination)[]: List of Log Analytics destinations. - -## DestinationsSpecAzureMonitorMetrics -### Properties -* **name**: string: A friendly name for the destination. -This name should be unique across all destinations (regardless of type) within the data collection rule. - -## LogAnalyticsDestination -### Properties -* **name**: string: A friendly name for the destination. -This name should be unique across all destinations (regardless of type) within the data collection rule. -* **workspaceId**: string (ReadOnly): The Customer ID of the Log Analytics workspace. -* **workspaceResourceId**: string: The resource ID of the Log Analytics workspace. - -## DataCollectionRuleResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2020-05-01-preview/types.md b/generated/monitor/microsoft.insights/2020-05-01-preview/types.md index 7691815f05..2e6ff944d0 100644 --- a/generated/monitor/microsoft.insights/2020-05-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2020-05-01-preview/types.md @@ -13,23 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Insights/scheduledQueryRules' (ReadOnly, DeployTimeConstant): The resource type -## ScheduledQueryRuleProperties -### Properties -* **actions**: [Action](#action)[]: Array of Action -* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule -* **criteria**: [ScheduledQueryRuleCriteria](#scheduledqueryrulecriteria): The rule criteria that defines the conditions of the scheduled query rule. -* **description**: string: The description of the scheduled query rule. -* **displayName**: string: The display name of the alert rule -* **enabled**: bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false -* **evaluationFrequency**: string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. -* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule -* **muteActionsDuration**: string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. -* **overrideQueryTimeRange**: string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods) -* **scopes**: string[]: The list of resource id's that this scheduled query rule is scoped to. -* **severity**: int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest -* **targetResourceTypes**: 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 -* **windowSize**: string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). - ## Action ### Properties * **actionGroupId**: string: Action Group resource Id to invoke when the alert fires. @@ -40,10 +23,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ScheduledQueryRuleCriteria -### Properties -* **allOf**: [Condition](#condition)[]: A list of conditions to evaluate against the specified scopes - ## Condition ### Properties * **dimensions**: [Dimension](#dimension)[]: List of Dimensions conditions @@ -55,16 +34,37 @@ * **threshold**: int (Required): the criteria threshold value that activates the alert. * **timeAggregation**: 'Average' | 'Count' | 'Maximum' | 'Minimum' | 'Total' | string (Required): Aggregation type +## ConditionFailingPeriods +### Properties +* **minFailingPeriodsToAlert**: int: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 +* **numberOfEvaluationPeriods**: int: 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 + ## Dimension ### Properties * **name**: string (Required): Name of the dimension * **operator**: 'Exclude' | 'Include' | string (Required): Operator for dimension values * **values**: string[] (Required): List of dimension values -## ConditionFailingPeriods +## ScheduledQueryRuleCriteria ### Properties -* **minFailingPeriodsToAlert**: int: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 -* **numberOfEvaluationPeriods**: int: 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 +* **allOf**: [Condition](#condition)[]: A list of conditions to evaluate against the specified scopes + +## ScheduledQueryRuleProperties +### Properties +* **actions**: [Action](#action)[]: Array of Action +* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule +* **criteria**: [ScheduledQueryRuleCriteria](#scheduledqueryrulecriteria): The rule criteria that defines the conditions of the scheduled query rule. +* **description**: string: The description of the scheduled query rule. +* **displayName**: string: The display name of the alert rule +* **enabled**: bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false +* **evaluationFrequency**: string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. +* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule +* **muteActionsDuration**: string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. +* **overrideQueryTimeRange**: string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods) +* **scopes**: string[]: The list of resource id's that this scheduled query rule is scoped to. +* **severity**: int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest +* **targetResourceTypes**: 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 +* **windowSize**: string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). ## TrackedResourceTags ### Properties diff --git a/generated/monitor/microsoft.insights/2020-10-01/types.md b/generated/monitor/microsoft.insights/2020-10-01/types.md index 80ba764794..e9d8ab4852 100644 --- a/generated/monitor/microsoft.insights/2020-10-01/types.md +++ b/generated/monitor/microsoft.insights/2020-10-01/types.md @@ -11,18 +11,6 @@ * **tags**: [AzureResourceTags](#azureresourcetags): The tags of the resource. * **type**: 'Microsoft.Insights/activityLogAlerts' (ReadOnly, DeployTimeConstant): The resource type -## AlertRuleProperties -### Properties -* **actions**: [ActionList](#actionlist) (Required): A list of Activity Log Alert rule actions. -* **condition**: [AlertRuleAllOfCondition](#alertruleallofcondition) (Required): An Activity Log Alert rule condition that is met when all its member conditions are met. -* **description**: string: A description of this Activity Log Alert rule. -* **enabled**: bool: Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. -* **scopes**: string[] (Required): A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. - -## ActionList -### Properties -* **actionGroups**: [ActionGroup](#actiongroup)[]: The list of the Action Groups. - ## ActionGroup ### Properties * **actionGroupId**: string (Required): The resource ID of the Action Group. This cannot be null or empty. @@ -33,6 +21,10 @@ ### Additional Properties * **Additional Properties Type**: string +## ActionList +### Properties +* **actionGroups**: [ActionGroup](#actiongroup)[]: The list of the Action Groups. + ## AlertRuleAllOfCondition ### Properties * **allOf**: [AlertRuleAnyOfOrLeafCondition](#alertruleanyoforleafcondition)[] (Required): The list of Activity Log Alert rule conditions. @@ -52,6 +44,14 @@ The possible values for this field are (case-insensitive): 'resourceId', 'catego * **field**: string: The name of the Activity Log event's 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'. +## AlertRuleProperties +### Properties +* **actions**: [ActionList](#actionlist) (Required): A list of Activity Log Alert rule actions. +* **condition**: [AlertRuleAllOfCondition](#alertruleallofcondition) (Required): An Activity Log Alert rule condition that is met when all its member conditions are met. +* **description**: string: A description of this Activity Log Alert rule. +* **enabled**: bool: Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. +* **scopes**: string[] (Required): A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. + ## AzureResourceTags ### Properties ### Additional Properties diff --git a/generated/monitor/microsoft.insights/2021-02-01-preview/types.md b/generated/monitor/microsoft.insights/2021-02-01-preview/types.md index 17d60f197d..327a8aa8dd 100644 --- a/generated/monitor/microsoft.insights/2021-02-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2021-02-01-preview/types.md @@ -14,27 +14,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Insights/scheduledQueryRules' (ReadOnly, DeployTimeConstant): The resource type -## ScheduledQueryRuleProperties -### Properties -* **actions**: [Actions](#actions): Actions to invoke when the alert fires. -* **autoMitigate**: bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert. -* **checkWorkspaceAlertsStorageConfigured**: bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert. -* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule -* **criteria**: [ScheduledQueryRuleCriteria](#scheduledqueryrulecriteria): The rule criteria that defines the conditions of the scheduled query rule. -* **description**: string: The description of the scheduled query rule. -* **displayName**: string: The display name of the alert rule -* **enabled**: bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false -* **evaluationFrequency**: string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert. -* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule -* **isWorkspaceAlertsStorageConfigured**: bool (ReadOnly): The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. -* **muteActionsDuration**: string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert. -* **overrideQueryTimeRange**: string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. -* **scopes**: string[]: The list of resource id's that this scheduled query rule is scoped to. -* **severity**: int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert. -* **skipQueryValidation**: bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert. -* **targetResourceTypes**: 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. Relevant only for rules of the kind LogAlert -* **windowSize**: string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert. - ## Actions ### Properties * **actionGroups**: string[]: Action Group resource Ids to invoke when the alert fires. @@ -45,10 +24,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ScheduledQueryRuleCriteria -### Properties -* **allOf**: [Condition](#condition)[]: A list of conditions to evaluate against the specified scopes - ## Condition ### Properties * **dimensions**: [Dimension](#dimension)[]: List of Dimensions conditions @@ -61,16 +36,41 @@ * **threshold**: int: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert. * **timeAggregation**: 'Average' | 'Count' | 'Maximum' | 'Minimum' | 'Total' | string: Aggregation type. Relevant and required only for rules of the kind LogAlert. +## ConditionFailingPeriods +### Properties +* **minFailingPeriodsToAlert**: int: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 +* **numberOfEvaluationPeriods**: int: 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 + ## Dimension ### Properties * **name**: string (Required): Name of the dimension * **operator**: 'Exclude' | 'Include' | string (Required): Operator for dimension values * **values**: string[] (Required): List of dimension values -## ConditionFailingPeriods +## ScheduledQueryRuleCriteria ### Properties -* **minFailingPeriodsToAlert**: int: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 -* **numberOfEvaluationPeriods**: int: 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 +* **allOf**: [Condition](#condition)[]: A list of conditions to evaluate against the specified scopes + +## ScheduledQueryRuleProperties +### Properties +* **actions**: [Actions](#actions): Actions to invoke when the alert fires. +* **autoMitigate**: bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert. +* **checkWorkspaceAlertsStorageConfigured**: bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert. +* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule +* **criteria**: [ScheduledQueryRuleCriteria](#scheduledqueryrulecriteria): The rule criteria that defines the conditions of the scheduled query rule. +* **description**: string: The description of the scheduled query rule. +* **displayName**: string: The display name of the alert rule +* **enabled**: bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false +* **evaluationFrequency**: string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert. +* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule +* **isWorkspaceAlertsStorageConfigured**: bool (ReadOnly): The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. +* **muteActionsDuration**: string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert. +* **overrideQueryTimeRange**: string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. +* **scopes**: string[]: The list of resource id's that this scheduled query rule is scoped to. +* **severity**: int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert. +* **skipQueryValidation**: bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert. +* **targetResourceTypes**: 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. Relevant only for rules of the kind LogAlert +* **windowSize**: string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert. ## SystemData ### Properties diff --git a/generated/monitor/microsoft.insights/2021-04-01/types.md b/generated/monitor/microsoft.insights/2021-04-01/types.md index 866e731cc4..90441535c7 100644 --- a/generated/monitor/microsoft.insights/2021-04-01/types.md +++ b/generated/monitor/microsoft.insights/2021-04-01/types.md @@ -39,15 +39,6 @@ * **tags**: [DataCollectionRuleResourceTags](#datacollectionruleresourcetags): Resource tags. * **type**: 'Microsoft.Insights/dataCollectionRules' (ReadOnly, DeployTimeConstant): The resource type -## DataCollectionEndpointResourceProperties -### Properties -* **configurationAccess**: [DataCollectionEndpointConfigurationAccess](#datacollectionendpointconfigurationaccess): The endpoint used by agents to access their configuration. -* **description**: string: Description of the data collection endpoint. -* **immutableId**: string: The immutable ID of this data collection endpoint resource. This property is READ-ONLY. -* **logsIngestion**: [DataCollectionEndpointLogsIngestion](#datacollectionendpointlogsingestion): The endpoint used by clients to ingest logs. -* **networkAcls**: [DataCollectionEndpointNetworkAcls](#datacollectionendpointnetworkacls): Network access control rules for the endpoints. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. This property is READ-ONLY. - ## DataCollectionEndpointConfigurationAccess ### Properties * **endpoint**: string (ReadOnly): The endpoint. This property is READ-ONLY. @@ -60,6 +51,15 @@ ### Properties * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The configuration to set whether network access from public internet to the endpoints are allowed. +## DataCollectionEndpointResourceProperties +### Properties +* **configurationAccess**: [DataCollectionEndpointConfigurationAccess](#datacollectionendpointconfigurationaccess): The endpoint used by agents to access their configuration. +* **description**: string: Description of the data collection endpoint. +* **immutableId**: string: The immutable ID of this data collection endpoint resource. This property is READ-ONLY. +* **logsIngestion**: [DataCollectionEndpointLogsIngestion](#datacollectionendpointlogsingestion): The endpoint used by clients to ingest logs. +* **networkAcls**: [DataCollectionEndpointNetworkAcls](#datacollectionendpointnetworkacls): Network access control rules for the endpoints. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. This property is READ-ONLY. + ## DataCollectionEndpointResourceSystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -90,6 +90,18 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## DataCollectionRuleDataSources +### Properties +* **extensions**: [ExtensionDataSource](#extensiondatasource)[]: The list of Azure VM extension data source configurations. +* **performanceCounters**: [PerfCounterDataSource](#perfcounterdatasource)[]: The list of performance counter data source configurations. +* **syslog**: [SyslogDataSource](#syslogdatasource)[]: The list of Syslog data source configurations. +* **windowsEventLogs**: [WindowsEventLogDataSource](#windowseventlogdatasource)[]: The list of Windows Event Log data source configurations. + +## DataCollectionRuleDestinations +### Properties +* **azureMonitorMetrics**: [DestinationsSpecAzureMonitorMetrics](#destinationsspecazuremonitormetrics): Azure Monitor Metrics destination. +* **logAnalytics**: [LogAnalyticsDestination](#loganalyticsdestination)[]: List of Log Analytics destinations. + ## DataCollectionRuleResourceProperties ### Properties * **dataFlows**: [DataFlow](#dataflow)[]: The specification of data flows. @@ -100,17 +112,29 @@ This property is optional and can be omitted if the rule is meant to be used via * **immutableId**: string (ReadOnly): The immutable ID of this data collection rule. This property is READ-ONLY. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. +## DataCollectionRuleResourceSystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## DataCollectionRuleResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## DataFlow ### Properties * **destinations**: string[]: List of destinations for this data flow. * **streams**: 'Microsoft-Event' | 'Microsoft-InsightsMetrics' | 'Microsoft-Perf' | 'Microsoft-Syslog' | 'Microsoft-WindowsEvent' | string[]: List of streams for this data flow. -## DataCollectionRuleDataSources +## DestinationsSpecAzureMonitorMetrics ### Properties -* **extensions**: [ExtensionDataSource](#extensiondatasource)[]: The list of Azure VM extension data source configurations. -* **performanceCounters**: [PerfCounterDataSource](#perfcounterdatasource)[]: The list of performance counter data source configurations. -* **syslog**: [SyslogDataSource](#syslogdatasource)[]: The list of Syslog data source configurations. -* **windowsEventLogs**: [WindowsEventLogDataSource](#windowseventlogdatasource)[]: The list of Windows Event Log data source configurations. +* **name**: string: A friendly name for the destination. +This name should be unique across all destinations (regardless of type) within the data collection rule. ## ExtensionDataSource ### Properties @@ -122,6 +146,13 @@ This name should be unique across all data sources (regardless of type) within t * **streams**: 'Microsoft-Event' | 'Microsoft-InsightsMetrics' | 'Microsoft-Perf' | 'Microsoft-Syslog' | 'Microsoft-WindowsEvent' | 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. +## LogAnalyticsDestination +### Properties +* **name**: string: A friendly name for the destination. +This name should be unique across all destinations (regardless of type) within the data collection rule. +* **workspaceId**: string (ReadOnly): The Customer ID of the Log Analytics workspace. +* **workspaceResourceId**: string: The resource ID of the Log Analytics workspace. + ## PerfCounterDataSource ### Properties * **counterSpecifiers**: string[]: A list of specifier names of the performance counters you want to collect. @@ -150,34 +181,3 @@ This name should be unique across all data sources (regardless of type) within t A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. * **xPathQueries**: string[]: A list of Windows Event Log queries in XPATH format. -## DataCollectionRuleDestinations -### Properties -* **azureMonitorMetrics**: [DestinationsSpecAzureMonitorMetrics](#destinationsspecazuremonitormetrics): Azure Monitor Metrics destination. -* **logAnalytics**: [LogAnalyticsDestination](#loganalyticsdestination)[]: List of Log Analytics destinations. - -## DestinationsSpecAzureMonitorMetrics -### Properties -* **name**: string: A friendly name for the destination. -This name should be unique across all destinations (regardless of type) within the data collection rule. - -## LogAnalyticsDestination -### Properties -* **name**: string: A friendly name for the destination. -This name should be unique across all destinations (regardless of type) within the data collection rule. -* **workspaceId**: string (ReadOnly): The Customer ID of the Log Analytics workspace. -* **workspaceResourceId**: string: The resource ID of the Log Analytics workspace. - -## DataCollectionRuleResourceSystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DataCollectionRuleResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2021-05-01-preview/types.md b/generated/monitor/microsoft.insights/2021-05-01-preview/types.md index 220638fc35..4c16f85c07 100644 --- a/generated/monitor/microsoft.insights/2021-05-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2021-05-01-preview/types.md @@ -22,6 +22,20 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Insights/diagnosticSettings' (ReadOnly, DeployTimeConstant): The resource type +## AutoscaleNotification +### Properties +* **email**: [EmailNotification](#emailnotification): Email notification of an autoscale event. +* **operation**: 'Scale' (Required): the operation associated with the notification and its value must be "scale" +* **webhooks**: [WebhookNotification](#webhooknotification)[]: the collection of webhook notifications. + +## AutoscaleProfile +### Properties +* **capacity**: [ScaleCapacity](#scalecapacity) (Required): The number of instances that can be used during this profile. +* **fixedDate**: [TimeWindow](#timewindow): A specific date-time for the profile. +* **name**: string (Required): the name of the profile. +* **recurrence**: [Recurrence](#recurrence): The repeating times at which this profile begins. This element is not used if the FixedDate element is used. +* **rules**: [ScaleRule](#scalerule)[] (Required): the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. + ## AutoscaleSetting ### Properties * **enabled**: bool: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'. @@ -32,11 +46,22 @@ * **targetResourceLocation**: string: the location of the resource that the autoscale setting should be added to. * **targetResourceUri**: string: the resource identifier of the resource that the autoscale setting should be added to. -## AutoscaleNotification +## AutoscaleSettingResourceTags ### Properties -* **email**: [EmailNotification](#emailnotification): Email notification of an autoscale event. -* **operation**: 'Scale' (Required): the operation associated with the notification and its value must be "scale" -* **webhooks**: [WebhookNotification](#webhooknotification)[]: the collection of webhook notifications. +### Additional Properties +* **Additional Properties Type**: string + +## DiagnosticSettings +### Properties +* **eventHubAuthorizationRuleId**: string: The resource Id for the event hub authorization rule. +* **eventHubName**: string: The name of the event hub. If none is specified, the default event hub will be selected. +* **logAnalyticsDestinationType**: string: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.) +* **logs**: [LogSettings](#logsettings)[]: The list of logs settings. +* **marketplacePartnerId**: string: The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. +* **metrics**: [MetricSettings](#metricsettings)[]: The list of metric settings. +* **serviceBusRuleId**: string: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. +* **storageAccountId**: string: The resource ID of the storage account to which you would like to send Diagnostic Logs. +* **workspaceId**: string: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 ## EmailNotification ### Properties @@ -44,41 +69,40 @@ * **sendToSubscriptionAdministrator**: bool: a value indicating whether to send email to subscription administrator. * **sendToSubscriptionCoAdministrators**: bool: a value indicating whether to send email to subscription co-administrators. -## WebhookNotification +## LogSettings ### Properties -* **properties**: [WebhookNotificationProperties](#webhooknotificationproperties): a property bag of settings. This value can be empty. -* **serviceUri**: string: the service address to receive the notification. +* **category**: string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. +* **categoryGroup**: string: Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. +* **enabled**: bool (Required): a value indicating whether this log is enabled. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. -## WebhookNotificationProperties +## MetricSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **category**: string: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. +* **enabled**: bool (Required): a value indicating whether this category is enabled. +* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. +* **timeGrain**: string: the timegrain of the metric in ISO8601 format. + +## MetricTrigger +### Properties +* **dimensions**: [ScaleRuleMetricDimension](#scalerulemetricdimension)[]: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. +* **dividePerInstance**: bool: a value indicating whether metric should divide per instance. +* **metricName**: string (Required): the name of the metric that defines what the rule monitors. +* **metricNamespace**: string: the namespace of the metric that defines what the rule monitors. +* **metricResourceLocation**: string: the location of the resource the rule monitors. +* **metricResourceUri**: string (Required): the resource identifier of the resource the rule monitors. +* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEquals' (Required): the operator that is used to compare the metric data and the threshold. +* **statistic**: 'Average' | 'Count' | 'Max' | 'Min' | 'Sum' (Required): the metric statistic type. How the metrics from multiple instances are combined. +* **threshold**: int (Required): the threshold of the metric that triggers the scale action. +* **timeAggregation**: 'Average' | 'Count' | 'Last' | 'Maximum' | 'Minimum' | 'Total' (Required): time aggregation type. How the data that is collected should be combined over time. The default value is Average. +* **timeGrain**: string (Required): 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. +* **timeWindow**: string (Required): 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. ## PredictiveAutoscalePolicy ### Properties * **scaleLookAheadTime**: string: the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format. * **scaleMode**: 'Disabled' | 'Enabled' | 'ForecastOnly' (Required): the predictive autoscale mode -## AutoscaleProfile -### Properties -* **capacity**: [ScaleCapacity](#scalecapacity) (Required): The number of instances that can be used during this profile. -* **fixedDate**: [TimeWindow](#timewindow): A specific date-time for the profile. -* **name**: string (Required): the name of the profile. -* **recurrence**: [Recurrence](#recurrence): The repeating times at which this profile begins. This element is not used if the FixedDate element is used. -* **rules**: [ScaleRule](#scalerule)[] (Required): the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. - -## ScaleCapacity -### Properties -* **default**: string (Required): 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. -* **maximum**: string (Required): 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. -* **minimum**: string (Required): the minimum number of instances for the resource. - -## TimeWindow -### Properties -* **end**: string (Required): the end time for the profile in ISO 8601 format. -* **start**: string (Required): the start time for the profile in ISO 8601 format. -* **timeZone**: 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 - ## Recurrence ### Properties * **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'None' | 'Second' | 'Week' | 'Year' (Required): 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. @@ -91,39 +115,35 @@ * **minutes**: int[] (Required): A collection of minutes at which the profile takes effect at. * **timeZone**: string (Required): 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 +## RetentionPolicy +### Properties +* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. +* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. + +## ScaleAction +### Properties +* **cooldown**: string (Required): 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. +* **direction**: 'Decrease' | 'Increase' | 'None' (Required): the scale direction. Whether the scaling action increases or decreases the number of instances. +* **type**: 'ChangeCount' | 'ExactCount' | 'PercentChangeCount' | 'ServiceAllowedNextValue' (Required): the type of action that should occur when the scale rule fires. +* **value**: string: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. + +## ScaleCapacity +### Properties +* **default**: string (Required): 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. +* **maximum**: string (Required): 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. +* **minimum**: string (Required): the minimum number of instances for the resource. + ## ScaleRule ### Properties * **metricTrigger**: [MetricTrigger](#metrictrigger) (Required): The trigger that results in a scaling action. * **scaleAction**: [ScaleAction](#scaleaction) (Required): The parameters for the scaling action. -## MetricTrigger -### Properties -* **dimensions**: [ScaleRuleMetricDimension](#scalerulemetricdimension)[]: List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. -* **dividePerInstance**: bool: a value indicating whether metric should divide per instance. -* **metricName**: string (Required): the name of the metric that defines what the rule monitors. -* **metricNamespace**: string: the namespace of the metric that defines what the rule monitors. -* **metricResourceLocation**: string: the location of the resource the rule monitors. -* **metricResourceUri**: string (Required): the resource identifier of the resource the rule monitors. -* **operator**: 'Equals' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEquals' (Required): the operator that is used to compare the metric data and the threshold. -* **statistic**: 'Average' | 'Count' | 'Max' | 'Min' | 'Sum' (Required): the metric statistic type. How the metrics from multiple instances are combined. -* **threshold**: int (Required): the threshold of the metric that triggers the scale action. -* **timeAggregation**: 'Average' | 'Count' | 'Last' | 'Maximum' | 'Minimum' | 'Total' (Required): time aggregation type. How the data that is collected should be combined over time. The default value is Average. -* **timeGrain**: string (Required): 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. -* **timeWindow**: string (Required): 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. - ## ScaleRuleMetricDimension ### Properties * **DimensionName**: string (Required): Name of the dimension. * **Operator**: 'Equals' | 'NotEquals' | string (Required): 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 * **Values**: string[] (Required): list of dimension values. For example: ["App1","App2"]. -## ScaleAction -### Properties -* **cooldown**: string (Required): 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. -* **direction**: 'Decrease' | 'Increase' | 'None' (Required): the scale direction. Whether the scaling action increases or decreases the number of instances. -* **type**: 'ChangeCount' | 'ExactCount' | 'PercentChangeCount' | 'ServiceAllowedNextValue' (Required): the type of action that should occur when the scale rule fires. -* **value**: string: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -133,39 +153,19 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AutoscaleSettingResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DiagnosticSettings -### Properties -* **eventHubAuthorizationRuleId**: string: The resource Id for the event hub authorization rule. -* **eventHubName**: string: The name of the event hub. If none is specified, the default event hub will be selected. -* **logAnalyticsDestinationType**: string: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.) -* **logs**: [LogSettings](#logsettings)[]: The list of logs settings. -* **marketplacePartnerId**: string: The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. -* **metrics**: [MetricSettings](#metricsettings)[]: The list of metric settings. -* **serviceBusRuleId**: string: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. -* **storageAccountId**: string: The resource ID of the storage account to which you would like to send Diagnostic Logs. -* **workspaceId**: string: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 - -## LogSettings +## TimeWindow ### Properties -* **category**: string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. -* **categoryGroup**: string: Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. -* **enabled**: bool (Required): a value indicating whether this log is enabled. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. +* **end**: string (Required): the end time for the profile in ISO 8601 format. +* **start**: string (Required): the start time for the profile in ISO 8601 format. +* **timeZone**: 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 -## RetentionPolicy +## WebhookNotification ### Properties -* **days**: int (Required): the number of days for the retention in days. A value of 0 will retain the events indefinitely. -* **enabled**: bool (Required): a value indicating whether the retention policy is enabled. +* **properties**: [WebhookNotificationProperties](#webhooknotificationproperties): a property bag of settings. This value can be empty. +* **serviceUri**: string: the service address to receive the notification. -## MetricSettings +## WebhookNotificationProperties ### Properties -* **category**: string: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. -* **enabled**: bool (Required): a value indicating whether this category is enabled. -* **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Specifies the retention policy for the log. -* **timeGrain**: string: the timegrain of the metric in ISO8601 format. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/monitor/microsoft.insights/2021-07-01-preview/types.md b/generated/monitor/microsoft.insights/2021-07-01-preview/types.md index ea8217eef8..02b7be6378 100644 --- a/generated/monitor/microsoft.insights/2021-07-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2021-07-01-preview/types.md @@ -31,12 +31,6 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Insights/privateLinkScopes/scopedResources' (ReadOnly, DeployTimeConstant): The resource type -## AzureMonitorPrivateLinkScopeProperties -### Properties -* **accessModeSettings**: [AccessModeSettings](#accessmodesettings) (Required): Properties that define the scope private link mode settings. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. -* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. - ## AccessModeSettings ### Properties * **exclusions**: [AccessModeSettingsExclusion](#accessmodesettingsexclusion)[]: List of exclusions that override the default access mode settings for specific private endpoint connections. @@ -49,6 +43,16 @@ * **privateEndpointConnectionName**: string: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings. * **queryAccessMode**: 'Open' | 'PrivateOnly' | string: Access mode types. +## AzureMonitorPrivateLinkScopeProperties +### Properties +* **accessModeSettings**: [AccessModeSettings](#accessmodesettings) (Required): Properties that define the scope private link mode settings. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connections. +* **provisioningState**: string (ReadOnly): Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -62,16 +66,17 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## ScopedResourceProperties +### Properties +* **linkedResourceId**: string: The resource id of the scoped Azure monitor resource. +* **provisioningState**: string (ReadOnly): State of the private endpoint connection. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -86,8 +91,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ScopedResourceProperties -### Properties -* **linkedResourceId**: string: The resource id of the scoped Azure monitor resource. -* **provisioningState**: string (ReadOnly): State of the private endpoint connection. - diff --git a/generated/monitor/microsoft.insights/2021-08-01/types.md b/generated/monitor/microsoft.insights/2021-08-01/types.md index d761ccc4ba..e9032c297c 100644 --- a/generated/monitor/microsoft.insights/2021-08-01/types.md +++ b/generated/monitor/microsoft.insights/2021-08-01/types.md @@ -14,27 +14,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Insights/scheduledQueryRules' (ReadOnly, DeployTimeConstant): The resource type -## ScheduledQueryRuleProperties -### Properties -* **actions**: [Actions](#actions): Actions to invoke when the alert fires. -* **autoMitigate**: bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert. -* **checkWorkspaceAlertsStorageConfigured**: bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert. -* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule -* **criteria**: [ScheduledQueryRuleCriteria](#scheduledqueryrulecriteria): The rule criteria that defines the conditions of the scheduled query rule. -* **description**: string: The description of the scheduled query rule. -* **displayName**: string: The display name of the alert rule -* **enabled**: bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false -* **evaluationFrequency**: string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert. -* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule -* **isWorkspaceAlertsStorageConfigured**: bool (ReadOnly): The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. -* **muteActionsDuration**: string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert. -* **overrideQueryTimeRange**: string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. -* **scopes**: string[]: The list of resource id's that this scheduled query rule is scoped to. -* **severity**: int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert. -* **skipQueryValidation**: bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert. -* **targetResourceTypes**: 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. Relevant only for rules of the kind LogAlert -* **windowSize**: string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert. - ## Actions ### Properties * **actionGroups**: string[]: Action Group resource Ids to invoke when the alert fires. @@ -45,10 +24,6 @@ ### Additional Properties * **Additional Properties Type**: string -## ScheduledQueryRuleCriteria -### Properties -* **allOf**: [Condition](#condition)[]: A list of conditions to evaluate against the specified scopes - ## Condition ### Properties * **dimensions**: [Dimension](#dimension)[]: List of Dimensions conditions @@ -61,16 +36,41 @@ * **threshold**: int: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert. * **timeAggregation**: 'Average' | 'Count' | 'Maximum' | 'Minimum' | 'Total' | string: Aggregation type. Relevant and required only for rules of the kind LogAlert. +## ConditionFailingPeriods +### Properties +* **minFailingPeriodsToAlert**: int: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 +* **numberOfEvaluationPeriods**: int: 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 + ## Dimension ### Properties * **name**: string (Required): Name of the dimension * **operator**: 'Exclude' | 'Include' | string (Required): Operator for dimension values * **values**: string[] (Required): List of dimension values -## ConditionFailingPeriods +## ScheduledQueryRuleCriteria ### Properties -* **minFailingPeriodsToAlert**: int: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 -* **numberOfEvaluationPeriods**: int: 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 +* **allOf**: [Condition](#condition)[]: A list of conditions to evaluate against the specified scopes + +## ScheduledQueryRuleProperties +### Properties +* **actions**: [Actions](#actions): Actions to invoke when the alert fires. +* **autoMitigate**: bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert. +* **checkWorkspaceAlertsStorageConfigured**: bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert. +* **createdWithApiVersion**: string (ReadOnly): The api-version used when creating this alert rule +* **criteria**: [ScheduledQueryRuleCriteria](#scheduledqueryrulecriteria): The rule criteria that defines the conditions of the scheduled query rule. +* **description**: string: The description of the scheduled query rule. +* **displayName**: string: The display name of the alert rule +* **enabled**: bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false +* **evaluationFrequency**: string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert. +* **isLegacyLogAnalyticsRule**: bool (ReadOnly): True if alert rule is legacy Log Analytic rule +* **isWorkspaceAlertsStorageConfigured**: bool (ReadOnly): The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false. +* **muteActionsDuration**: string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert. +* **overrideQueryTimeRange**: string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. +* **scopes**: string[]: The list of resource id's that this scheduled query rule is scoped to. +* **severity**: int: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert. +* **skipQueryValidation**: bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert. +* **targetResourceTypes**: 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. Relevant only for rules of the kind LogAlert +* **windowSize**: string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert. ## SystemData ### Properties diff --git a/generated/monitor/microsoft.insights/2021-09-01-preview/types.md b/generated/monitor/microsoft.insights/2021-09-01-preview/types.md index a6fee98a36..0081b70828 100644 --- a/generated/monitor/microsoft.insights/2021-09-01-preview/types.md +++ b/generated/monitor/microsoft.insights/2021-09-01-preview/types.md @@ -39,14 +39,10 @@ * **tags**: [DataCollectionRuleResourceTags](#datacollectionruleresourcetags): Resource tags. * **type**: 'Microsoft.Insights/dataCollectionRules' (ReadOnly, DeployTimeConstant): The resource type -## DataCollectionEndpointResourceProperties +## ColumnDefinition ### Properties -* **configurationAccess**: [DataCollectionEndpointConfigurationAccess](#datacollectionendpointconfigurationaccess): The endpoint used by clients to access their configuration. -* **description**: string: Description of the data collection endpoint. -* **immutableId**: string: The immutable ID of this data collection endpoint resource. This property is READ-ONLY. -* **logsIngestion**: [DataCollectionEndpointLogsIngestion](#datacollectionendpointlogsingestion): The endpoint used by clients to ingest logs. -* **networkAcls**: [DataCollectionEndpointNetworkAcls](#datacollectionendpointnetworkacls): Network access control rules for the endpoints. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. This property is READ-ONLY. +* **name**: string: The name of the column. +* **type**: 'boolean' | 'datetime' | 'dynamic' | 'int' | 'long' | 'real' | 'string' | string: The type of the column data. ## DataCollectionEndpointConfigurationAccess ### Properties @@ -60,6 +56,15 @@ ### Properties * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: The configuration to set whether network access from public internet to the endpoints are allowed. +## DataCollectionEndpointResourceProperties +### Properties +* **configurationAccess**: [DataCollectionEndpointConfigurationAccess](#datacollectionendpointconfigurationaccess): The endpoint used by clients to access their configuration. +* **description**: string: Description of the data collection endpoint. +* **immutableId**: string: The immutable ID of this data collection endpoint resource. This property is READ-ONLY. +* **logsIngestion**: [DataCollectionEndpointLogsIngestion](#datacollectionendpointlogsingestion): The endpoint used by clients to ingest logs. +* **networkAcls**: [DataCollectionEndpointNetworkAcls](#datacollectionendpointnetworkacls): Network access control rules for the endpoints. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. This property is READ-ONLY. + ## DataCollectionEndpointResourceSystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -74,6 +79,10 @@ ### Additional Properties * **Additional Properties Type**: string +## DataCollectionRuleAssociationMetadata +### Properties +* **provisionedBy**: string (ReadOnly): Azure offering managing this resource on-behalf-of customer. + ## DataCollectionRuleAssociationProxyOnlyResourceProperties ### Properties * **dataCollectionEndpointId**: string: The resource ID of the data collection endpoint that is to be associated. @@ -82,10 +91,6 @@ * **metadata**: [DataCollectionRuleAssociationMetadata](#datacollectionruleassociationmetadata) (ReadOnly): Metadata about the resource * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. -## DataCollectionRuleAssociationMetadata -### Properties -* **provisionedBy**: string (ReadOnly): Azure offering managing this resource on-behalf-of customer. - ## DataCollectionRuleAssociationProxyOnlyResourceSystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -95,6 +100,24 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## DataCollectionRuleDataSources +### Properties +* **extensions**: [ExtensionDataSource](#extensiondatasource)[]: The list of Azure VM extension data source configurations. +* **iisLogs**: [IisLogsDataSource](#iislogsdatasource)[]: The list of IIS logs source configurations. +* **logFiles**: [LogFilesDataSource](#logfilesdatasource)[]: The list of Log files source configurations. +* **performanceCounters**: [PerfCounterDataSource](#perfcounterdatasource)[]: The list of performance counter data source configurations. +* **syslog**: [SyslogDataSource](#syslogdatasource)[]: The list of Syslog data source configurations. +* **windowsEventLogs**: [WindowsEventLogDataSource](#windowseventlogdatasource)[]: The list of Windows Event Log data source configurations. + +## DataCollectionRuleDestinations +### Properties +* **azureMonitorMetrics**: [DestinationsSpecAzureMonitorMetrics](#destinationsspecazuremonitormetrics): Azure Monitor Metrics destination. +* **logAnalytics**: [LogAnalyticsDestination](#loganalyticsdestination)[]: List of Log Analytics destinations. + +## DataCollectionRuleMetadata +### Properties +* **provisionedBy**: string (ReadOnly): Azure offering managing this resource on-behalf-of customer. + ## DataCollectionRuleResourceProperties ### Properties * **dataCollectionEndpointId**: string: The resource ID of the data collection endpoint that this rule can be used with. @@ -108,6 +131,25 @@ This property is optional and can be omitted if the rule is meant to be used via * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The resource provisioning state. * **streamDeclarations**: [DataCollectionRuleStreamDeclarations](#datacollectionrulestreamdeclarations): Declaration of custom streams used in this rule. +## DataCollectionRuleResourceSystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## DataCollectionRuleResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## DataCollectionRuleStreamDeclarations +### Properties +### Additional Properties +* **Additional Properties Type**: [StreamDeclaration](#streamdeclaration) + ## DataFlow ### Properties * **destinations**: string[]: List of destinations for this data flow. @@ -115,14 +157,10 @@ This property is optional and can be omitted if the rule is meant to be used via * **streams**: 'Microsoft-Event' | 'Microsoft-InsightsMetrics' | 'Microsoft-Perf' | 'Microsoft-Syslog' | 'Microsoft-WindowsEvent' | string[]: List of streams for this data flow. * **transformKql**: string: The KQL query to transform stream data. -## DataCollectionRuleDataSources +## DestinationsSpecAzureMonitorMetrics ### Properties -* **extensions**: [ExtensionDataSource](#extensiondatasource)[]: The list of Azure VM extension data source configurations. -* **iisLogs**: [IisLogsDataSource](#iislogsdatasource)[]: The list of IIS logs source configurations. -* **logFiles**: [LogFilesDataSource](#logfilesdatasource)[]: The list of Log files source configurations. -* **performanceCounters**: [PerfCounterDataSource](#perfcounterdatasource)[]: The list of performance counter data source configurations. -* **syslog**: [SyslogDataSource](#syslogdatasource)[]: The list of Syslog data source configurations. -* **windowsEventLogs**: [WindowsEventLogDataSource](#windowseventlogdatasource)[]: The list of Windows Event Log data source configurations. +* **name**: string: A friendly name for the destination. +This name should be unique across all destinations (regardless of type) within the data collection rule. ## ExtensionDataSource ### Properties @@ -141,6 +179,13 @@ A stream indicates what schema will be used for this data and usually what table This name should be unique across all data sources (regardless of type) within the data collection rule. * **streams**: string[] (Required): IIS streams +## LogAnalyticsDestination +### Properties +* **name**: string: A friendly name for the destination. +This name should be unique across all destinations (regardless of type) within the data collection rule. +* **workspaceId**: string (ReadOnly): The Customer ID of the Log Analytics workspace. +* **workspaceResourceId**: string: The resource ID of the Log Analytics workspace. + ## LogFilesDataSource ### Properties * **filePatterns**: string[] (Required): File Patterns where the log files are located @@ -170,6 +215,10 @@ This name should be unique across all data sources (regardless of type) within t * **streams**: 'Microsoft-InsightsMetrics' | 'Microsoft-Perf' | 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. +## StreamDeclaration +### Properties +* **columns**: [ColumnDefinition](#columndefinition)[]: List of columns used by data in this stream. + ## SyslogDataSource ### Properties * **facilityNames**: '*' | 'auth' | 'authpriv' | 'cron' | 'daemon' | 'kern' | 'local0' | 'local1' | 'local2' | 'local3' | 'local4' | 'local5' | 'local6' | 'local7' | 'lpr' | 'mail' | 'mark' | 'news' | 'syslog' | 'user' | 'uucp' | string[]: The list of facility names. @@ -187,52 +236,3 @@ This name should be unique across all data sources (regardless of type) within t A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. * **xPathQueries**: string[]: A list of Windows Event Log queries in XPATH format. -## DataCollectionRuleDestinations -### Properties -* **azureMonitorMetrics**: [DestinationsSpecAzureMonitorMetrics](#destinationsspecazuremonitormetrics): Azure Monitor Metrics destination. -* **logAnalytics**: [LogAnalyticsDestination](#loganalyticsdestination)[]: List of Log Analytics destinations. - -## DestinationsSpecAzureMonitorMetrics -### Properties -* **name**: string: A friendly name for the destination. -This name should be unique across all destinations (regardless of type) within the data collection rule. - -## LogAnalyticsDestination -### Properties -* **name**: string: A friendly name for the destination. -This name should be unique across all destinations (regardless of type) within the data collection rule. -* **workspaceId**: string (ReadOnly): The Customer ID of the Log Analytics workspace. -* **workspaceResourceId**: string: The resource ID of the Log Analytics workspace. - -## DataCollectionRuleMetadata -### Properties -* **provisionedBy**: string (ReadOnly): Azure offering managing this resource on-behalf-of customer. - -## DataCollectionRuleStreamDeclarations -### Properties -### Additional Properties -* **Additional Properties Type**: [StreamDeclaration](#streamdeclaration) - -## StreamDeclaration -### Properties -* **columns**: [ColumnDefinition](#columndefinition)[]: List of columns used by data in this stream. - -## ColumnDefinition -### Properties -* **name**: string: The name of the column. -* **type**: 'boolean' | 'datetime' | 'dynamic' | 'int' | 'long' | 'real' | 'string' | string: The type of the column data. - -## DataCollectionRuleResourceSystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DataCollectionRuleResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2021-09-01/types.md b/generated/monitor/microsoft.insights/2021-09-01/types.md index 27b8ddbb73..316937e008 100644 --- a/generated/monitor/microsoft.insights/2021-09-01/types.md +++ b/generated/monitor/microsoft.insights/2021-09-01/types.md @@ -58,6 +58,11 @@ * **name**: string (Required): The name of the azure function receiver. Names must be unique across all receivers within an action group. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. +## AzureResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## EmailReceiver ### Properties * **emailAddress**: string (Required): The email address of this receiver. @@ -112,8 +117,3 @@ * **useAadAuth**: bool: Indicates whether or not use AAD authentication. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. -## AzureResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/monitor/microsoft.insights/2022-04-01/types.md b/generated/monitor/microsoft.insights/2022-04-01/types.md index 7c84babd0f..b18db687fb 100644 --- a/generated/monitor/microsoft.insights/2022-04-01/types.md +++ b/generated/monitor/microsoft.insights/2022-04-01/types.md @@ -58,6 +58,11 @@ * **name**: string (Required): The name of the azure function receiver. Names must be unique across all receivers within an action group. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. +## AzureResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## EmailReceiver ### Properties * **emailAddress**: string (Required): The email address of this receiver. @@ -112,8 +117,3 @@ * **useAadAuth**: bool: Indicates whether or not use AAD authentication. * **useCommonAlertSchema**: bool: Indicates whether to use common alert schema. -## AzureResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/msi/log.out b/generated/msi/log.out index c81b422bed..80d1c50064 100644 --- a/generated/msi/log.out +++ b/generated/msi/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.managedidentity-2021-09-30-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2021-09-30-preview/ManagedIdentity.json:411:5 @@ -29,12 +29,12 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationDisplay' with an und warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2021-09-30-preview/ManagedIdentity.json:712:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.managedidentity-2018-11-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json:354:5 @@ -58,7 +58,7 @@ info | Processing batch task - {"tag":"microsoft.managedidentity-2015-08-31-p warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2015-08-31-preview/ManagedIdentity.json:354:5 @@ -76,4 +76,4 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2015-08-31-preview/ManagedIdentity.json:533:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 7.58s. 6 files generated. +info | Autorest completed in 7.49s. 6 files generated. diff --git a/generated/msi/microsoft.managedidentity/2018-11-30/types.md b/generated/msi/microsoft.managedidentity/2018-11-30/types.md index 6ddeac66e9..b8b4f0dd3a 100644 --- a/generated/msi/microsoft.managedidentity/2018-11-30/types.md +++ b/generated/msi/microsoft.managedidentity/2018-11-30/types.md @@ -11,14 +11,14 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.ManagedIdentity/userAssignedIdentities' (ReadOnly, DeployTimeConstant): The resource type +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UserAssignedIdentityProperties ### Properties * **clientId**: string (ReadOnly): The id of the app associated with the identity. This is a random generated UUID by MSI. * **principalId**: string (ReadOnly): The id of the service principal object associated with the created identity. * **tenantId**: string (ReadOnly): The id of the tenant which the identity belongs to. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/msi/microsoft.managedidentity/2021-09-30-preview/types.md b/generated/msi/microsoft.managedidentity/2021-09-30-preview/types.md index 568f7a798e..a81cf11fc5 100644 --- a/generated/msi/microsoft.managedidentity/2021-09-30-preview/types.md +++ b/generated/msi/microsoft.managedidentity/2021-09-30-preview/types.md @@ -16,17 +16,6 @@ * **ApiVersion**: 2021-09-30-preview * **Output**: [AssociatedResourcesListResult](#associatedresourceslistresult) -## UserAssignedIdentityProperties -### Properties -* **clientId**: string (ReadOnly): The id of the app associated with the identity. This is a random generated UUID by MSI. -* **principalId**: string (ReadOnly): The id of the service principal object associated with the created identity. -* **tenantId**: string (ReadOnly): The id of the tenant which the identity belongs to. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AssociatedResourcesListResult ### Properties * **nextLink**: string (ReadOnly): The url to get the next page of results, if any. @@ -42,3 +31,14 @@ * **subscriptionId**: string (ReadOnly): The ID of the subscription this resource belongs to. * **type**: string (ReadOnly): The type of this resource. +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UserAssignedIdentityProperties +### Properties +* **clientId**: string (ReadOnly): The id of the app associated with the identity. This is a random generated UUID by MSI. +* **principalId**: string (ReadOnly): The id of the service principal object associated with the created identity. +* **tenantId**: string (ReadOnly): The id of the tenant which the identity belongs to. + diff --git a/generated/mysql/log.out b/generated/mysql/log.out index 8c3d0d1020..8d9f5b033b 100644 --- a/generated/mysql/log.out +++ b/generated/mysql/log.out @@ -10,12 +10,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.dbformysql-2017-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServerProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json:1936:5 @@ -95,12 +95,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ServerAdministratorResourceLi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json:3034:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'LogFile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from LogFile -info | autorest.bicep took 20ms +info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.dbformysql-2017-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServerProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json:1811:5 @@ -178,12 +178,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ServerAdministratorResourceLi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json:2804:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'LogFile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from LogFile -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.dbformysql-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryTextProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2018-06-01/QueryPerformanceInsights.json:380:5 @@ -231,7 +231,7 @@ info | Processing batch task - {"tag":"microsoft.dbformysql-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/DataEncryptionKeys.json:299:5 @@ -250,7 +250,7 @@ info | Processing batch task - {"tag":"microsoft.dbformysql-2020-07-01-previe warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DelegatedSubnetArguments' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json:1532:5 @@ -297,12 +297,12 @@ warning | PreCheck/SchemaMissingType | The schema 'NameAvailability' with an und warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json:2524:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.dbformysql-2021-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json:2538:5 @@ -312,11 +312,11 @@ info | Processing batch task - {"tag":"microsoft.dbformysql-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2021-05-01/mysql.json:2646:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 4ms -info | Autorest completed in 21.18s. 14 files generated. +info | Autorest completed in 19.94s. 14 files generated. diff --git a/generated/mysql/microsoft.dbformysql/2017-12-01-preview/types.md b/generated/mysql/microsoft.dbformysql/2017-12-01-preview/types.md index 2f30db3b25..991c530731 100644 --- a/generated/mysql/microsoft.dbformysql/2017-12-01-preview/types.md +++ b/generated/mysql/microsoft.dbformysql/2017-12-01-preview/types.md @@ -67,12 +67,74 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.DBforMySQL/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **source**: string: Source of the configuration. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (ReadOnly): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. + ## ResourceIdentity ### Properties * **principalId**: string (ReadOnly): The Azure Active Directory principal id. * **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. * **type**: 'SystemAssigned' | string (ReadOnly): The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +## SecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## ServerAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. +* **login**: string (Required): The server administrator login account name. +* **sid**: string (Required): The server administrator Sid (Secure ID). +* **tenantId**: string (Required): The server Active Directory Administrator tenant id. + +## ServerForCreateTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id of the private endpoint connection. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + ## ServerPropertiesForCreate * **Discriminator**: createMode @@ -115,34 +177,6 @@ * **sourceServerId**: string (Required, WriteOnly): The master server id to create replica from. -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id of the private endpoint connection. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (ReadOnly): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. - -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. -* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. -* **storageMB**: int: Max storage allowed for a server. - ## Sku ### Properties * **capacity**: int: The scale up/out capacity, representing server's compute units. @@ -151,46 +185,12 @@ * **size**: string: The size code, to be interpreted by resource as appropriate. * **tier**: 'Basic' | 'GeneralPurpose' | 'MemoryOptimized' | string: The tier of the particular SKU, e.g. Basic. -## ServerForCreateTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServerAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. -* **login**: string (Required): The server administrator login account name. -* **sid**: string (Required): The server administrator Sid (Secure ID). -* **tenantId**: string (Required): The server Active Directory Administrator tenant id. - -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **source**: string: Source of the configuration. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## SecurityAlertPolicyProperties +## StorageProfile ### Properties -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. +* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. +* **storageMB**: int: Max storage allowed for a server. ## VirtualNetworkRuleProperties ### Properties diff --git a/generated/mysql/microsoft.dbformysql/2017-12-01/types.md b/generated/mysql/microsoft.dbformysql/2017-12-01/types.md index 67e0952f4b..a217dd45b0 100644 --- a/generated/mysql/microsoft.dbformysql/2017-12-01/types.md +++ b/generated/mysql/microsoft.dbformysql/2017-12-01/types.md @@ -67,12 +67,74 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.DBforMySQL/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **source**: string: Source of the configuration. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + ## ResourceIdentity ### Properties * **principalId**: string (ReadOnly): The Azure Active Directory principal id. * **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. * **type**: 'SystemAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +## SecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## ServerAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. +* **login**: string (Required): The server administrator login account name. +* **sid**: string (Required): The server administrator Sid (Secure ID). +* **tenantId**: string (Required): The server Active Directory Administrator tenant id. + +## ServerForCreateTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id of the private endpoint connection. +* **properties**: [ServerPrivateEndpointConnectionProperties](#serverprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ServerPrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) +* **privateLinkServiceConnectionState**: [ServerPrivateLinkServiceConnectionStateProperty](#serverprivatelinkserviceconnectionstateproperty) (ReadOnly) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. + +## ServerPrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (ReadOnly): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. + ## ServerPropertiesForCreate * **Discriminator**: createMode @@ -115,34 +177,6 @@ * **sourceServerId**: string (Required, WriteOnly): The master server id to create replica from. -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id of the private endpoint connection. -* **properties**: [ServerPrivateEndpointConnectionProperties](#serverprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ServerPrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) -* **privateLinkServiceConnectionState**: [ServerPrivateLinkServiceConnectionStateProperty](#serverprivatelinkserviceconnectionstateproperty) (ReadOnly) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## ServerPrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (ReadOnly): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. - -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. -* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. -* **storageMB**: int: Max storage allowed for a server. - ## Sku ### Properties * **capacity**: int: The scale up/out capacity, representing server's compute units. @@ -151,46 +185,12 @@ * **size**: string: The size code, to be interpreted by resource as appropriate. * **tier**: 'Basic' | 'GeneralPurpose' | 'MemoryOptimized' | string: The tier of the particular SKU, e.g. Basic. -## ServerForCreateTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServerAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. -* **login**: string (Required): The server administrator login account name. -* **sid**: string (Required): The server administrator Sid (Secure ID). -* **tenantId**: string (Required): The server Active Directory Administrator tenant id. - -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **source**: string: Source of the configuration. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## SecurityAlertPolicyProperties +## StorageProfile ### Properties -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. +* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. +* **storageMB**: int: Max storage allowed for a server. ## VirtualNetworkRuleProperties ### Properties diff --git a/generated/mysql/microsoft.dbformysql/2020-07-01-preview/types.md b/generated/mysql/microsoft.dbformysql/2020-07-01-preview/types.md index 643c7ef97d..9467b05f81 100644 --- a/generated/mysql/microsoft.dbformysql/2020-07-01-preview/types.md +++ b/generated/mysql/microsoft.dbformysql/2020-07-01-preview/types.md @@ -41,12 +41,43 @@ * **properties**: [ServerKeyProperties](#serverkeyproperties): Properties for a key execution. * **type**: 'Microsoft.DBForMySql/flexibleServers/keys' (ReadOnly, DeployTimeConstant): The resource type +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## DelegatedSubnetArguments +### Properties +* **subnetArmResourceId**: string: delegated subnet arm resource id. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## MaintenanceWindow +### Properties +* **customWindow**: string: indicates whether custom window is enabled or disabled +* **dayOfWeek**: int: day of week for maintenance window +* **startHour**: int: start hour for maintenance window +* **startMinute**: int: start minute for maintenance window + +## PrivateDnsZoneArguments +### Properties +* **privateDnsZoneArmResourceId**: string: private dns zone arm resource id. + +## ServerKeyProperties +### Properties +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | string (Required): The key type like 'AzureKeyVault'. +* **uri**: string: The URI of the key. + ## ServerProperties ### Properties * **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). @@ -74,20 +105,15 @@ * **tags**: [ServerPropertiesTags](#serverpropertiestags): Application-specific metadata in the form of key-value pairs. * **version**: '5.7' | string: The version of a server. -## DelegatedSubnetArguments -### Properties -* **subnetArmResourceId**: string: delegated subnet arm resource id. - -## MaintenanceWindow +## ServerPropertiesTags ### Properties -* **customWindow**: string: indicates whether custom window is enabled or disabled -* **dayOfWeek**: int: day of week for maintenance window -* **startHour**: int: start hour for maintenance window -* **startMinute**: int: start minute for maintenance window +### Additional Properties +* **Additional Properties Type**: string -## PrivateDnsZoneArguments +## Sku ### Properties -* **privateDnsZoneArmResourceId**: string: private dns zone arm resource id. +* **name**: string (Required): The name of the sku, e.g. Standard_D32s_v3. +* **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. GeneralPurpose. ## StorageProfile ### Properties @@ -97,34 +123,8 @@ * **storageIops**: int: Storage IOPS for a server. * **storageMB**: int: Max storage allowed for a server. -## ServerPropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Sku -### Properties -* **name**: string (Required): The name of the sku, e.g. Standard_D32s_v3. -* **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. GeneralPurpose. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## ServerKeyProperties -### Properties -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | string (Required): The key type like 'AzureKeyVault'. -* **uri**: string: The URI of the key. - diff --git a/generated/mysql/microsoft.dbformysql/2021-05-01-preview/types.md b/generated/mysql/microsoft.dbformysql/2021-05-01-preview/types.md index 350f25f09a..06ab321a9c 100644 --- a/generated/mysql/microsoft.dbformysql/2021-05-01-preview/types.md +++ b/generated/mysql/microsoft.dbformysql/2021-05-01-preview/types.md @@ -34,12 +34,47 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DBforMySQL/flexibleServers/firewallRules' (ReadOnly, DeployTimeConstant): The resource type +## Backup +### Properties +* **backupRetentionDays**: int: Backup retention days for the server. +* **earliestRestoreDate**: string (ReadOnly): Earliest restore point creation time (ISO8601 format) +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enum to indicate whether value is 'Enabled' or 'Disabled' + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## HighAvailability +### Properties +* **mode**: 'Disabled' | 'Enabled' | 'SameZone' | 'ZoneRedundant' | string: High availability mode for a server. +* **standbyAvailabilityZone**: string: Availability zone of the standby server. +* **state**: 'CreatingStandby' | 'FailingOver' | 'Healthy' | 'NotEnabled' | 'RemovingStandby' | string (ReadOnly): The state of server high availability. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## MaintenanceWindow +### Properties +* **customWindow**: string: indicates whether custom window is enabled or disabled +* **dayOfWeek**: int: day of week for maintenance window +* **startHour**: int: start hour for maintenance window +* **startMinute**: int: start minute for maintenance window + +## Network +### Properties +* **delegatedSubnetResourceId**: string: Delegated subnet resource id used to setup vnet for a server. +* **privateDnsZoneResourceId**: string: Private DNS zone resource id. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Enum to indicate whether value is 'Enabled' or 'Disabled' + ## ServerProperties ### Properties * **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). @@ -59,30 +94,10 @@ * **storage**: [Storage](#storage): Storage Profile properties of a server * **version**: '5.7' | '8.0.21' | string: The version of a server. -## Backup -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **earliestRestoreDate**: string (ReadOnly): Earliest restore point creation time (ISO8601 format) -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enum to indicate whether value is 'Enabled' or 'Disabled' - -## HighAvailability -### Properties -* **mode**: 'Disabled' | 'Enabled' | 'SameZone' | 'ZoneRedundant' | string: High availability mode for a server. -* **standbyAvailabilityZone**: string: Availability zone of the standby server. -* **state**: 'CreatingStandby' | 'FailingOver' | 'Healthy' | 'NotEnabled' | 'RemovingStandby' | string (ReadOnly): The state of server high availability. - -## MaintenanceWindow -### Properties -* **customWindow**: string: indicates whether custom window is enabled or disabled -* **dayOfWeek**: int: day of week for maintenance window -* **startHour**: int: start hour for maintenance window -* **startMinute**: int: start minute for maintenance window - -## Network +## Sku ### Properties -* **delegatedSubnetResourceId**: string: Delegated subnet resource id used to setup vnet for a server. -* **privateDnsZoneResourceId**: string: Private DNS zone resource id. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Enum to indicate whether value is 'Enabled' or 'Disabled' +* **name**: string (Required): The name of the sku, e.g. Standard_D32s_v3. +* **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. GeneralPurpose. ## Storage ### Properties @@ -91,11 +106,6 @@ * **storageSizeGB**: int: Max storage size allowed for a server. * **storageSku**: string (ReadOnly): The sku name of the server storage. -## Sku -### Properties -* **name**: string (Required): The name of the sku, e.g. Standard_D32s_v3. -* **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. GeneralPurpose. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -110,13 +120,3 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - diff --git a/generated/mysql/microsoft.dbformysql/2021-05-01/types.md b/generated/mysql/microsoft.dbformysql/2021-05-01/types.md index 839f556bcd..a93933db4e 100644 --- a/generated/mysql/microsoft.dbformysql/2021-05-01/types.md +++ b/generated/mysql/microsoft.dbformysql/2021-05-01/types.md @@ -34,6 +34,36 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DBforMySQL/flexibleServers/firewallRules' (ReadOnly, DeployTimeConstant): The resource type +## Backup +### Properties +* **backupRetentionDays**: int: Backup retention days for the server. +* **earliestRestoreDate**: string (ReadOnly): Earliest restore point creation time (ISO8601 format) +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enum to indicate whether value is 'Enabled' or 'Disabled' + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## DataEncryption +### Properties +* **geoBackupKeyUri**: string: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup +* **geoBackupUserAssignedIdentityId**: string: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup +* **primaryKeyUri**: string: Primary key uri +* **primaryUserAssignedIdentityId**: string: Primary user identity resource id +* **type**: 'AzureKeyVault' | 'SystemManaged': The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## HighAvailability +### Properties +* **mode**: 'Disabled' | 'SameZone' | 'ZoneRedundant' | string: High availability mode for a server. +* **standbyAvailabilityZone**: string: Availability zone of the standby server. +* **state**: 'CreatingStandby' | 'FailingOver' | 'Healthy' | 'NotEnabled' | 'RemovingStandby' | string (ReadOnly): The state of server high availability. + ## Identity ### Properties * **principalId**: string (ReadOnly): ObjectId from the KeyVault @@ -46,6 +76,19 @@ ### Additional Properties * **Additional Properties Type**: any +## MaintenanceWindow +### Properties +* **customWindow**: string: indicates whether custom window is enabled or disabled +* **dayOfWeek**: int: day of week for maintenance window +* **startHour**: int: start hour for maintenance window +* **startMinute**: int: start minute for maintenance window + +## Network +### Properties +* **delegatedSubnetResourceId**: string: Delegated subnet resource id used to setup vnet for a server. +* **privateDnsZoneResourceId**: string: Private DNS zone resource id. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Enum to indicate whether value is 'Enabled' or 'Disabled' + ## ServerProperties ### Properties * **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). @@ -66,38 +109,10 @@ * **storage**: [Storage](#storage): Storage Profile properties of a server * **version**: '5.7' | '8.0.21' | string: The version of a server. -## Backup -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **earliestRestoreDate**: string (ReadOnly): Earliest restore point creation time (ISO8601 format) -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enum to indicate whether value is 'Enabled' or 'Disabled' - -## DataEncryption -### Properties -* **geoBackupKeyUri**: string: Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup -* **geoBackupUserAssignedIdentityId**: string: Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup -* **primaryKeyUri**: string: Primary key uri -* **primaryUserAssignedIdentityId**: string: Primary user identity resource id -* **type**: 'AzureKeyVault' | 'SystemManaged': The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. - -## HighAvailability -### Properties -* **mode**: 'Disabled' | 'SameZone' | 'ZoneRedundant' | string: High availability mode for a server. -* **standbyAvailabilityZone**: string: Availability zone of the standby server. -* **state**: 'CreatingStandby' | 'FailingOver' | 'Healthy' | 'NotEnabled' | 'RemovingStandby' | string (ReadOnly): The state of server high availability. - -## MaintenanceWindow -### Properties -* **customWindow**: string: indicates whether custom window is enabled or disabled -* **dayOfWeek**: int: day of week for maintenance window -* **startHour**: int: start hour for maintenance window -* **startMinute**: int: start minute for maintenance window - -## Network +## Sku ### Properties -* **delegatedSubnetResourceId**: string: Delegated subnet resource id used to setup vnet for a server. -* **privateDnsZoneResourceId**: string: Private DNS zone resource id. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): Enum to indicate whether value is 'Enabled' or 'Disabled' +* **name**: string (Required): The name of the sku, e.g. Standard_D32s_v3. +* **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. GeneralPurpose. ## Storage ### Properties @@ -106,11 +121,6 @@ * **storageSizeGB**: int: Max storage size allowed for a server. * **storageSku**: string (ReadOnly): The sku name of the server storage. -## Sku -### Properties -* **name**: string (Required): The name of the sku, e.g. Standard_D32s_v3. -* **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. GeneralPurpose. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -125,13 +135,3 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - diff --git a/generated/netapp/log.out b/generated/netapp/log.out index 89fa95a58f..9e9c2a97c6 100644 --- a/generated/netapp/log.out +++ b/generated/netapp/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.netapp-2021-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-10-01/netapp.json:3489:5 @@ -33,10 +33,10 @@ warning | PreCheck/SchemaMissingType | The schema 'cloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'cloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-10-01/netapp.json:6325:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 20ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.netapp-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-08-01/netapp.json:3036:5 @@ -66,7 +66,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.netapp-2021-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-06-01/netapp.json:2849:5 @@ -96,7 +96,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.netapp-2021-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/netapp.json:2769:5 @@ -126,7 +126,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.netapp-2021-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/preview/2021-04-01-preview/netapp.json:2723:5 @@ -153,10 +153,10 @@ warning | PreCheck/SchemaMissingType | The schema 'cloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'cloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/preview/2021-04-01-preview/netapp.json:5177:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.netapp-2021-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-02-01/netapp.json:2686:5 @@ -183,10 +183,10 @@ warning | PreCheck/SchemaMissingType | The schema 'cloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'cloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-02-01/netapp.json:5035:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.netapp-2020-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-12-01/netapp.json:2679:5 @@ -213,10 +213,10 @@ warning | PreCheck/SchemaMissingType | The schema 'cloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'cloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-12-01/netapp.json:5016:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.netapp-2020-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-11-01/netapp.json:2567:5 @@ -243,10 +243,10 @@ warning | PreCheck/SchemaMissingType | The schema 'cloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'cloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-11-01/netapp.json:4842:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.netapp-2020-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-09-01/netapp.json:2535:5 @@ -272,7 +272,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.netapp-2020-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-08-01/netapp.json:2535:5 @@ -295,10 +295,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportP warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-dataProtection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-08-01/netapp.json:3790:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.netapp-2020-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/netapp.json:2535:5 @@ -321,10 +321,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportP warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-dataProtection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-07-01/netapp.json:3790:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.netapp-2020-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json:2535:5 @@ -347,10 +347,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportP warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-dataProtection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json:3787:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.netapp-2020-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-05-01/netapp.json:2535:5 @@ -373,10 +373,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportP warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-dataProtection' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-05-01/netapp.json:3677:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.netapp-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/netapp.json:1465:5 @@ -397,10 +397,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumeProperties-dataProtecti warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-03-01/netapp.json:2460:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.netapp-2020-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-02-01/netapp.json:1465:5 @@ -421,10 +421,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumeProperties-dataProtecti warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-02-01/netapp.json:2465:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.netapp-2019-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-11-01/netapp.json:1458:5 @@ -445,10 +445,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumeProperties-dataProtecti warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-11-01/netapp.json:2422:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.netapp-2019-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-10-01/netapp.json:1432:5 @@ -472,7 +472,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.netapp-2019-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-08-01/netapp.json:1199:5 @@ -493,10 +493,10 @@ warning | PreCheck/SchemaMissingType | The schema 'volumeProperties-dataProtecti warning | PreCheck/SchemaMissingType | The schema 'volumePatchProperties-exportPolicy' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-08-01/netapp.json:2095:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.netapp-2019-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-07-01/netapp.json:1199:5 @@ -519,10 +519,10 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.netapp-2019-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-06-01/netapp.json:1199:5 @@ -545,10 +545,10 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.netapp-2019-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-05-01/netapp.json:981:5 @@ -578,7 +578,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.netapp-2017-08-15"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json:937:5 @@ -602,4 +602,4 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 4ms -info | Autorest completed in 71.44s. 44 files generated. +info | Autorest completed in 67.66s. 44 files generated. diff --git a/generated/netapp/microsoft.netapp/2017-08-15/types.md b/generated/netapp/microsoft.netapp/2017-08-15/types.md index 028d342fc0..3e234edbfe 100644 --- a/generated/netapp/microsoft.netapp/2017-08-15/types.md +++ b/generated/netapp/microsoft.netapp/2017-08-15/types.md @@ -60,6 +60,16 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **nfsv3**: bool: Allows NFSv3 protocol +* **nfsv4**: bool: Allows NFSv4 protocol +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + ## PoolProperties ### Properties * **poolId**: string (ReadOnly): UUID v4 used to identify the Pool @@ -67,6 +77,13 @@ * **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system * **size**: int: Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +## SnapshotProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the snapshot +* **fileSystemId**: string (Required): UUID v4 used to identify the FileSystem +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + ## VolumeProperties ### Properties * **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets @@ -81,20 +98,3 @@ ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Array of exportPolicyRule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **nfsv3**: bool: Allows NFSv3 protocol -* **nfsv4**: bool: Allows NFSv4 protocol -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## SnapshotProperties -### Properties -* **creationDate**: string (ReadOnly): The creation date of the snapshot -* **fileSystemId**: string (Required): UUID v4 used to identify the FileSystem -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - diff --git a/generated/netapp/microsoft.netapp/2019-05-01/types.md b/generated/netapp/microsoft.netapp/2019-05-01/types.md index 3193480d83..0bd4b84fd5 100644 --- a/generated/netapp/microsoft.netapp/2019-05-01/types.md +++ b/generated/netapp/microsoft.netapp/2019-05-01/types.md @@ -60,31 +60,6 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). - -## VolumeProperties -### Properties -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[]: List of mount targets -* **protocolTypes**: string[]: Set of protocol types -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotId**: string: UUID v4 used to identify the Snapshot -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **usageThreshold**: int (Required): 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. - -## VolumePropertiesExportPolicy -### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule - ## ExportPolicyRule ### Properties * **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names @@ -108,6 +83,13 @@ * **startIp**: string: The start of IPv4 address range to use when creating a new mount target * **subnet**: string: The subnet +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). + ## SnapshotProperties ### Properties * **creationDate**: string (ReadOnly): The creation date of the snapshot @@ -115,3 +97,21 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +## VolumeProperties +### Properties +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[]: List of mount targets +* **protocolTypes**: string[]: Set of protocol types +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotId**: string: UUID v4 used to identify the Snapshot +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **usageThreshold**: int (Required): 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. + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + diff --git a/generated/netapp/microsoft.netapp/2019-06-01/types.md b/generated/netapp/microsoft.netapp/2019-06-01/types.md index a97528b3af..5063929642 100644 --- a/generated/netapp/microsoft.netapp/2019-06-01/types.md +++ b/generated/netapp/microsoft.netapp/2019-06-01/types.md @@ -60,31 +60,6 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). - -## VolumeProperties -### Properties -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **protocolTypes**: string[]: Set of protocol types -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **usageThreshold**: int (Required): 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. - -## VolumePropertiesExportPolicy -### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule - ## ExportPolicyRule ### Properties * **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names @@ -108,6 +83,13 @@ * **startIp**: string: The start of IPv4 address range to use when creating a new mount target * **subnet**: string: The subnet +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). + ## SnapshotProperties ### Properties * **creationDate**: string (ReadOnly): The creation date of the snapshot @@ -115,3 +97,21 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +## VolumeProperties +### Properties +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **protocolTypes**: string[]: Set of protocol types +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **usageThreshold**: int (Required): 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. + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + diff --git a/generated/netapp/microsoft.netapp/2019-07-01/types.md b/generated/netapp/microsoft.netapp/2019-07-01/types.md index 3ec32854a1..86fbc94fc2 100644 --- a/generated/netapp/microsoft.netapp/2019-07-01/types.md +++ b/generated/netapp/microsoft.netapp/2019-07-01/types.md @@ -60,31 +60,6 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). - -## VolumeProperties -### Properties -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS fro SMB protocol -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **usageThreshold**: int (Required): 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. - -## VolumePropertiesExportPolicy -### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule - ## ExportPolicyRule ### Properties * **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names @@ -108,6 +83,13 @@ * **startIp**: string: The start of IPv4 address range to use when creating a new mount target * **subnet**: string: The subnet +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). + ## SnapshotProperties ### Properties * **created**: string (ReadOnly): The creation date of the snapshot @@ -115,3 +97,21 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +## VolumeProperties +### Properties +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS fro SMB protocol +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **usageThreshold**: int (Required): 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. + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + diff --git a/generated/netapp/microsoft.netapp/2019-08-01/types.md b/generated/netapp/microsoft.netapp/2019-08-01/types.md index 3eedd35d61..a5c0e3b080 100644 --- a/generated/netapp/microsoft.netapp/2019-08-01/types.md +++ b/generated/netapp/microsoft.netapp/2019-08-01/types.md @@ -60,10 +60,28 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags +## ExportPolicyRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **nfsv3**: bool: Allows NFSv3 protocol +* **nfsv41**: bool: Allows NFSv4.1 protocol +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## MountTargetProperties +### Properties +* **endIp**: string: The end of IPv4 address range to use when creating a new mount target +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +* **startIp**: string: The start of IPv4 address range to use when creating a new mount target +* **subnet**: string: The subnet ## PoolProperties ### Properties @@ -72,11 +90,40 @@ * **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system * **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +## ReplicationObject +### Properties +* **endpointType**: string (Required): Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **fileSystemId**: string: UUID v4 used to identify the FileSystem +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + ## VolumeProperties ### Properties * **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. @@ -98,54 +145,7 @@ ### Properties * **replication**: [ReplicationObject](#replicationobject): Replication properties -## ReplicationObject -### Properties -* **endpointType**: string (Required): Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: string (Required): Schedule - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **nfsv3**: bool: Allows NFSv3 protocol -* **nfsv41**: bool: Allows NFSv4.1 protocol -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **endIp**: string: The end of IPv4 address range to use when creating a new mount target -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN -* **startIp**: string: The start of IPv4 address range to use when creating a new mount target -* **subnet**: string: The subnet - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **fileSystemId**: string: UUID v4 used to identify the FileSystem -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2019-10-01/types.md b/generated/netapp/microsoft.netapp/2019-10-01/types.md index e3848fb1cc..b0c943260f 100644 --- a/generated/netapp/microsoft.netapp/2019-10-01/types.md +++ b/generated/netapp/microsoft.netapp/2019-10-01/types.md @@ -60,10 +60,28 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags +## ExportPolicyRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **nfsv3**: bool: Allows NFSv3 protocol +* **nfsv41**: bool: Allows NFSv4.1 protocol +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## MountTargetProperties +### Properties +* **endIp**: string: The end of IPv4 address range to use when creating a new mount target +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +* **startIp**: string: The start of IPv4 address range to use when creating a new mount target +* **subnet**: string: The subnet ## PoolProperties ### Properties @@ -72,11 +90,41 @@ * **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system * **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **fileSystemId**: string: UUID v4 used to identify the FileSystem +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + ## VolumeProperties ### Properties * **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. @@ -99,55 +147,7 @@ ### Properties * **replication**: [ReplicationObject](#replicationobject): Replication properties -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **nfsv3**: bool: Allows NFSv3 protocol -* **nfsv41**: bool: Allows NFSv4.1 protocol -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **endIp**: string: The end of IPv4 address range to use when creating a new mount target -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN -* **startIp**: string: The start of IPv4 address range to use when creating a new mount target -* **subnet**: string: The subnet - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **fileSystemId**: string: UUID v4 used to identify the FileSystem -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2019-11-01/types.md b/generated/netapp/microsoft.netapp/2019-11-01/types.md index 86918cc941..45419b80af 100644 --- a/generated/netapp/microsoft.netapp/2019-11-01/types.md +++ b/generated/netapp/microsoft.netapp/2019-11-01/types.md @@ -60,10 +60,27 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags +## ExportPolicyRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **nfsv3**: bool: Allows NFSv3 protocol +* **nfsv41**: bool: Allows NFSv4.1 protocol +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## MountTargetProperties +### Properties +* **endIp**: string: The end of IPv4 address range to use when creating a new mount target +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +* **startIp**: string: The start of IPv4 address range to use when creating a new mount target +* **subnet**: string: The subnet ## PoolProperties ### Properties @@ -72,11 +89,36 @@ * **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system * **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **fileSystemId**: string: UUID v4 used to identify the FileSystem +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + ## VolumeProperties ### Properties * **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. @@ -99,49 +141,7 @@ ### Properties * **replication**: [ReplicationObject](#replicationobject): Replication properties -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **nfsv3**: bool: Allows NFSv3 protocol -* **nfsv41**: bool: Allows NFSv4.1 protocol -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **endIp**: string: The end of IPv4 address range to use when creating a new mount target -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN -* **startIp**: string: The start of IPv4 address range to use when creating a new mount target -* **subnet**: string: The subnet - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **fileSystemId**: string: UUID v4 used to identify the FileSystem -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - diff --git a/generated/netapp/microsoft.netapp/2020-02-01/types.md b/generated/netapp/microsoft.netapp/2020-02-01/types.md index 63bd50860c..e9285de25b 100644 --- a/generated/netapp/microsoft.netapp/2020-02-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-02-01/types.md @@ -61,10 +61,27 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags +## ExportPolicyRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## MountTargetProperties +### Properties +* **endIp**: string: The end of IPv4 address range to use when creating a new mount target +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +* **startIp**: string: The start of IPv4 address range to use when creating a new mount target +* **subnet**: string: The subnet ## PoolProperties ### Properties @@ -73,11 +90,35 @@ * **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system * **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + ## VolumeProperties ### Properties * **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. @@ -102,52 +143,11 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **endIp**: string: The end of IPv4 address range to use when creating a new mount target -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN -* **startIp**: string: The start of IPv4 address range to use when creating a new mount target -* **subnet**: string: The subnet - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SnapshotProperties +## VolumeSnapshotProperties ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +* **snapshotPolicyId**: string: Snapshot Policy ResourceId diff --git a/generated/netapp/microsoft.netapp/2020-03-01/types.md b/generated/netapp/microsoft.netapp/2020-03-01/types.md index ceaa9346b6..ab6eb40301 100644 --- a/generated/netapp/microsoft.netapp/2020-03-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-03-01/types.md @@ -61,10 +61,27 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags +## ExportPolicyRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## MountTargetProperties +### Properties +* **endIp**: string: The end of IPv4 address range to use when creating a new mount target +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +* **startIp**: string: The start of IPv4 address range to use when creating a new mount target +* **subnet**: string: The subnet ## PoolProperties ### Properties @@ -73,11 +90,35 @@ * **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system * **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | 'monthly' | 'weekly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + ## VolumeProperties ### Properties * **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. @@ -101,52 +142,11 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | 'monthly' | 'weekly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **endIp**: string: The end of IPv4 address range to use when creating a new mount target -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **gateway**: string: The gateway of the IPv4 address range to use when creating a new mount target -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **netmask**: string: The netmask of the IPv4 address range to use when creating a new mount target -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN -* **startIp**: string: The start of IPv4 address range to use when creating a new mount target -* **subnet**: string: The subnet - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SnapshotProperties +## VolumeSnapshotProperties ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +* **snapshotPolicyId**: string: Snapshot Policy ResourceId diff --git a/generated/netapp/microsoft.netapp/2020-05-01/types.md b/generated/netapp/microsoft.netapp/2020-05-01/types.md index 0bfe412982..09715708ed 100644 --- a/generated/netapp/microsoft.netapp/2020-05-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-05-01/types.md @@ -95,11 +95,6 @@ * **status**: string: Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -112,77 +107,20 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups -### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VolumeProperties +## BackupProperties ### Properties -* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **isRestoring**: bool: Restoring -* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **label**: string: Label for backup * **provisioningState**: string (ReadOnly): Azure lifecycle management -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **usageThreshold**: int (Required): 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. -* **volumeType**: string: What type of volume is this - -## VolumePropertiesDataProtection -### Properties -* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties -* **replication**: [ReplicationObject](#replicationobject): Replication properties -* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties - -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId +* **size**: int (ReadOnly): Size of backup -## VolumePropertiesExportPolicy +## DailySchedule ### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes ## ExportPolicyRule ### Properties @@ -201,6 +139,20 @@ * **unixReadOnly**: bool: Read only access * **unixReadWrite**: bool: Read and write access +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + ## MountTargetProperties ### Properties * **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget @@ -208,24 +160,45 @@ * **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget * **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). + +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BackupProperties +## ResourceTags ### Properties -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup +### Additional Properties +* **Additional Properties Type**: string -## SnapshotProperties +## ResourceTags ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SnapshotPolicyProperties ### Properties @@ -237,26 +210,58 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days -## DailySchedule +## SnapshotProperties ### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot -## HourlySchedule +## VolumeBackupProperties ### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID -## MonthlySchedule +## VolumeBackups ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + +## VolumeProperties +### Properties +* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **isRestoring**: bool: Restoring +* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **usageThreshold**: int (Required): 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. +* **volumeType**: string: What type of volume is this + +## VolumePropertiesDataProtection +### Properties +* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties +* **replication**: [ReplicationObject](#replicationobject): Replication properties +* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + +## VolumeSnapshotProperties +### Properties +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -266,8 +271,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2020-06-01/types.md b/generated/netapp/microsoft.netapp/2020-06-01/types.md index ccbb57ff4a..f04eee055c 100644 --- a/generated/netapp/microsoft.netapp/2020-06-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-06-01/types.md @@ -97,11 +97,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -114,82 +109,21 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups -### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). -* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps -* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VolumeProperties +## BackupProperties ### Properties -* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **isRestoring**: bool: Restoring -* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **label**: string: Label for backup * **provisioningState**: string (ReadOnly): Azure lifecycle management -* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume -* **usageThreshold**: int (Required): 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. -* **volumeType**: string: What type of volume is this - -## VolumePropertiesDataProtection -### Properties -* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties -* **replication**: [ReplicationObject](#replicationobject): Replication properties -* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties - -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId +* **size**: int (ReadOnly): Size of backup -## VolumePropertiesExportPolicy +## DailySchedule ### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes ## ExportPolicyRule ### Properties @@ -208,6 +142,20 @@ * **unixReadOnly**: bool: Read only access * **unixReadWrite**: bool: Read and write access +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + ## MountTargetProperties ### Properties * **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget @@ -215,25 +163,48 @@ * **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget * **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps +* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps + +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BackupProperties +## ResourceTags ### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup +### Additional Properties +* **Additional Properties Type**: string -## SnapshotProperties +## ResourceTags ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SnapshotPolicyProperties ### Properties @@ -245,26 +216,60 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days -## DailySchedule +## SnapshotProperties ### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot -## HourlySchedule +## VolumeBackupProperties ### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID -## MonthlySchedule +## VolumeBackups ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + +## VolumeProperties +### Properties +* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **isRestoring**: bool: Restoring +* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume +* **usageThreshold**: int (Required): 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. +* **volumeType**: string: What type of volume is this + +## VolumePropertiesDataProtection +### Properties +* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties +* **replication**: [ReplicationObject](#replicationobject): Replication properties +* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + +## VolumeSnapshotProperties +### Properties +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -274,8 +279,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2020-07-01/types.md b/generated/netapp/microsoft.netapp/2020-07-01/types.md index 31c7ab281b..6cab5284d1 100644 --- a/generated/netapp/microsoft.netapp/2020-07-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-07-01/types.md @@ -99,11 +99,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -116,82 +111,21 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups -### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). -* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps -* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VolumeProperties +## BackupProperties ### Properties -* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **isRestoring**: bool: Restoring -* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **label**: string: Label for backup * **provisioningState**: string (ReadOnly): Azure lifecycle management -* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, ntfs for dual protocol or CIFS protocol -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume -* **usageThreshold**: int (Required): 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. -* **volumeType**: string: What type of volume is this - -## VolumePropertiesDataProtection -### Properties -* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties -* **replication**: [ReplicationObject](#replicationobject): Replication properties -* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties - -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId +* **size**: int (ReadOnly): Size of backup -## VolumePropertiesExportPolicy +## DailySchedule ### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes ## ExportPolicyRule ### Properties @@ -210,6 +144,20 @@ * **unixReadOnly**: bool: Read only access * **unixReadWrite**: bool: Read and write access +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + ## MountTargetProperties ### Properties * **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget @@ -217,25 +165,48 @@ * **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget * **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps +* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps + +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BackupProperties +## ResourceTags ### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup +### Additional Properties +* **Additional Properties Type**: string -## SnapshotProperties +## ResourceTags ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SnapshotPolicyProperties ### Properties @@ -247,26 +218,60 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days -## DailySchedule +## SnapshotProperties ### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot -## HourlySchedule +## VolumeBackupProperties ### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID -## MonthlySchedule +## VolumeBackups ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + +## VolumeProperties +### Properties +* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **isRestoring**: bool: Restoring +* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, ntfs for dual protocol or CIFS protocol +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume +* **usageThreshold**: int (Required): 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. +* **volumeType**: string: What type of volume is this + +## VolumePropertiesDataProtection +### Properties +* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties +* **replication**: [ReplicationObject](#replicationobject): Replication properties +* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + +## VolumeSnapshotProperties +### Properties +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -276,8 +281,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2020-08-01/types.md b/generated/netapp/microsoft.netapp/2020-08-01/types.md index 88c2555010..e12f1f4e11 100644 --- a/generated/netapp/microsoft.netapp/2020-08-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-08-01/types.md @@ -99,11 +99,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -116,82 +111,21 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups -### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PoolProperties -### Properties -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). -* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps -* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VolumeProperties +## BackupProperties ### Properties -* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **isRestoring**: bool: Restoring -* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **label**: string: Label for backup * **provisioningState**: string (ReadOnly): Azure lifecycle management -* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, ntfs for dual protocol or CIFS protocol -* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system -* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume -* **usageThreshold**: int (Required): 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. -* **volumeType**: string: What type of volume is this - -## VolumePropertiesDataProtection -### Properties -* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties -* **replication**: [ReplicationObject](#replicationobject): Replication properties -* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties - -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId +* **size**: int (ReadOnly): Size of backup -## VolumePropertiesExportPolicy +## DailySchedule ### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes ## ExportPolicyRule ### Properties @@ -210,6 +144,20 @@ * **unixReadOnly**: bool: Read only access * **unixReadWrite**: bool: Read and write access +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + ## MountTargetProperties ### Properties * **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget @@ -217,25 +165,48 @@ * **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget * **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN +## PoolProperties +### Properties +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). +* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps +* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps + +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BackupProperties +## ResourceTags ### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup +### Additional Properties +* **Additional Properties Type**: string -## SnapshotProperties +## ResourceTags ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SnapshotPolicyProperties ### Properties @@ -247,26 +218,60 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days -## DailySchedule +## SnapshotProperties ### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot -## HourlySchedule +## VolumeBackupProperties ### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID -## MonthlySchedule +## VolumeBackups ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + +## VolumeProperties +### Properties +* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **isRestoring**: bool: Restoring +* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, ntfs for dual protocol or CIFS protocol +* **serviceLevel**: 'Premium' | 'Standard' | 'Ultra' | string: The service level of the file system +* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true). +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume +* **usageThreshold**: int (Required): 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. +* **volumeType**: string: What type of volume is this + +## VolumePropertiesDataProtection +### Properties +* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties +* **replication**: [ReplicationObject](#replicationobject): Replication properties +* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + +## VolumeSnapshotProperties +### Properties +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -276,8 +281,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2020-09-01/types.md b/generated/netapp/microsoft.netapp/2020-09-01/types.md index 6e4ea06245..ce984e17a4 100644 --- a/generated/netapp/microsoft.netapp/2020-09-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-09-01/types.md @@ -100,11 +100,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -117,16 +112,59 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -138,11 +176,68 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **name**: string (ReadOnly): Snapshot policy name +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **backupId**: string: UUID v4 or resource identifier used to identify the Backup. @@ -173,103 +268,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **name**: string (ReadOnly): Snapshot policy name -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -279,8 +284,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2020-11-01/types.md b/generated/netapp/microsoft.netapp/2020-11-01/types.md index e6f1c73b28..7315f88fc5 100644 --- a/generated/netapp/microsoft.netapp/2020-11-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-11-01/types.md @@ -76,6 +76,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/snapshotPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: 'Microsoft.NetApp' | string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -103,24 +107,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: 'Microsoft.NetApp' | string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -133,16 +119,60 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -154,11 +184,77 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **name**: string (ReadOnly): Snapshot policy name +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **backupId**: string: UUID v4 or resource identifier used to identify the Backup. @@ -190,104 +286,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **name**: string (ReadOnly): Snapshot policy name -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -297,8 +302,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2020-12-01/types.md b/generated/netapp/microsoft.netapp/2020-12-01/types.md index d860ba6a05..f712b44ab6 100644 --- a/generated/netapp/microsoft.netapp/2020-12-01/types.md +++ b/generated/netapp/microsoft.netapp/2020-12-01/types.md @@ -76,6 +76,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/snapshotPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -104,24 +108,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -134,16 +120,61 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup +* **volumeName**: string (ReadOnly): Volume name -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -155,11 +186,76 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **backupId**: string: UUID v4 or resource identifier used to identify the Backup. @@ -192,104 +288,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **volumeName**: string (ReadOnly): Volume name - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -299,8 +304,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2021-02-01/types.md b/generated/netapp/microsoft.netapp/2021-02-01/types.md index 38e35c5614..ace75a87ff 100644 --- a/generated/netapp/microsoft.netapp/2021-02-01/types.md +++ b/generated/netapp/microsoft.netapp/2021-02-01/types.md @@ -76,6 +76,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/snapshotPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -104,24 +108,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -134,16 +120,62 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup +* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups +* **volumeName**: string (ReadOnly): Volume name -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -155,11 +187,76 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **backupId**: string: UUID v4 or resource identifier used to identify the Backup. @@ -192,105 +289,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups -* **volumeName**: string (ReadOnly): Volume name - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -300,8 +305,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2021-04-01-preview/types.md b/generated/netapp/microsoft.netapp/2021-04-01-preview/types.md index d346f189cb..40b3b7ed66 100644 --- a/generated/netapp/microsoft.netapp/2021-04-01-preview/types.md +++ b/generated/netapp/microsoft.netapp/2021-04-01-preview/types.md @@ -76,6 +76,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/snapshotPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -104,24 +108,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **dailyBackupsToKeep**: int: Daily backups count to keep @@ -134,16 +120,62 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup +* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups +* **volumeName**: string (ReadOnly): Volume name -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -155,11 +187,76 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **backupId**: string: UUID v4 or resource identifier used to identify the Backup. @@ -195,105 +292,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string (Required): Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups -* **volumeName**: string (ReadOnly): Volume name - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -303,8 +308,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2021-04-01/types.md b/generated/netapp/microsoft.netapp/2021-04-01/types.md index 4a74cd0a65..445f79ae49 100644 --- a/generated/netapp/microsoft.netapp/2021-04-01/types.md +++ b/generated/netapp/microsoft.netapp/2021-04-01/types.md @@ -83,6 +83,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/snapshotPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -112,24 +116,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **backupPolicyId**: string (ReadOnly): Backup Policy Resource ID @@ -143,16 +129,63 @@ * **weeklyBackupsToKeep**: int: Weekly backups count to keep * **yearlyBackupsToKeep**: int: Yearly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup +* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups +* **volumeName**: string (ReadOnly): Volume name -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **chownMode**: 'Restricted' | 'Unrestricted' | string: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -166,11 +199,76 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **backupId**: string: UUID v4 or resource identifier used to identify the Backup. @@ -206,106 +304,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **chownMode**: 'Restricted' | 'Unrestricted' | string: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups -* **volumeName**: string (ReadOnly): Volume name - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -315,8 +320,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2021-06-01/types.md b/generated/netapp/microsoft.netapp/2021-06-01/types.md index d096fa84f2..0fd8b909c1 100644 --- a/generated/netapp/microsoft.netapp/2021-06-01/types.md +++ b/generated/netapp/microsoft.netapp/2021-06-01/types.md @@ -81,6 +81,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/snapshotPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -110,24 +114,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **backupPolicyId**: string (ReadOnly): Backup Policy Resource ID @@ -140,16 +126,63 @@ * **volumesAssigned**: int (ReadOnly): Volumes using current backup policy * **weeklyBackupsToKeep**: int: Weekly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup +* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups +* **volumeName**: string (ReadOnly): Volume name -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **chownMode**: 'Restricted' | 'Unrestricted' | string: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN ## PoolProperties ### Properties @@ -163,11 +196,76 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + ## VolumeProperties ### Properties * **avsDataStore**: 'Disabled' | 'Enabled' | string: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose @@ -211,106 +309,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **chownMode**: 'Restricted' | 'Unrestricted' | string: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups -* **volumeName**: string (ReadOnly): Volume name - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -320,8 +325,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2021-08-01/types.md b/generated/netapp/microsoft.netapp/2021-08-01/types.md index eac6366d3e..46bc995775 100644 --- a/generated/netapp/microsoft.netapp/2021-08-01/types.md +++ b/generated/netapp/microsoft.netapp/2021-08-01/types.md @@ -92,6 +92,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/volumeGroups' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -122,24 +126,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **backupPolicyId**: string (ReadOnly): Backup Policy Resource ID @@ -151,16 +137,68 @@ * **volumesAssigned**: int (ReadOnly): Volumes using current backup policy * **weeklyBackupsToKeep**: int: Weekly backups count to keep -## VolumeBackups +## BackupProperties ### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (ReadOnly): Size of backup +* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups +* **volumeName**: string (ReadOnly): Volume name -## ResourceTags +## DailySchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## ExportPolicyRule +### Properties +* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names +* **chownMode**: 'Restricted' | 'Unrestricted' | string: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. +* **cifs**: bool: Allows CIFS protocol +* **hasRootAccess**: bool: Has root access to volume +* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later +* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later +* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes +* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes +* **ruleIndex**: int: Order index +* **unixReadOnly**: bool: Read only access +* **unixReadWrite**: bool: Read and write access + +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## MountTargetProperties +### Properties +* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget +* **ipAddress**: string (ReadOnly): The mount target's IPv4 address +* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget +* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN + +## PlacementKeyValuePairs +### Properties +* **key**: string (Required): Key for an application specific parameter for the placement of volumes in the volume group +* **value**: string (Required): Value for an application specific parameter for the placement of volumes in the volume group ## PoolProperties ### Properties @@ -174,11 +212,109 @@ * **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps * **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SnapshotPolicyProperties +### Properties +* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties +* **enabled**: bool: The property to decide policy is enabled or not +* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties +* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days + +## SnapshotProperties +### Properties +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## VolumeBackupProperties +### Properties +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID + +## VolumeBackups +### Properties +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name + +## VolumeGroupMetaData +### Properties +* **applicationIdentifier**: string: Application specific identifier +* **applicationType**: 'SAP-HANA' | string: Application Type +* **deploymentSpecId**: string: Application specific identifier of deployment rules for the volume group +* **globalPlacementRules**: [PlacementKeyValuePairs](#placementkeyvaluepairs)[]: Application specific placement rules for the volume group +* **groupDescription**: string: Group Description +* **volumesCount**: int (ReadOnly): Number of volumes in volume group + +## VolumeGroupProperties +### Properties +* **groupMetaData**: [VolumeGroupMetaData](#volumegroupmetadata): Volume group properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **volumes**: [VolumeGroupVolumeProperties](#volumegroupvolumeproperties)[]: List of volumes from group + +## VolumeGroupVolumeProperties +### Properties +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [VolumeProperties](#volumeproperties) (Required): Volume properties +* **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource +* **type**: string (ReadOnly): Resource type + ## VolumeProperties ### Properties * **avsDataStore**: 'Disabled' | 'Enabled' | string: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose @@ -228,111 +364,13 @@ * **replication**: [ReplicationObject](#replicationobject): Replication properties * **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId - ## VolumePropertiesExportPolicy ### Properties * **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule -## ExportPolicyRule -### Properties -* **allowedClients**: string: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names -* **chownMode**: 'Restricted' | 'Unrestricted' | string: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. -* **cifs**: bool: Allows CIFS protocol -* **hasRootAccess**: bool: Has root access to volume -* **kerberos5iReadOnly**: bool: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5iReadWrite**: bool: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadOnly**: bool: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5pReadWrite**: bool: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadOnly**: bool: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later -* **kerberos5ReadWrite**: bool: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later -* **nfsv3**: bool: Allows NFSv3 protocol. Enable only for NFSv3 type volumes -* **nfsv41**: bool: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes -* **ruleIndex**: int: Order index -* **unixReadOnly**: bool: Read only access -* **unixReadWrite**: bool: Read and write access - -## MountTargetProperties -### Properties -* **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget -* **ipAddress**: string (ReadOnly): The mount target's IPv4 address -* **mountTargetId**: string (ReadOnly): UUID v4 used to identify the MountTarget -* **smbServerFqdn**: string: The SMB server's Fully Qualified Domain Name, FQDN - -## PlacementKeyValuePairs -### Properties -* **key**: string (Required): Key for an application specific parameter for the placement of volumes in the volume group -* **value**: string (Required): Value for an application specific parameter for the placement of volumes in the volume group - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupProperties -### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups -* **volumeName**: string (ReadOnly): Volume name - -## SnapshotProperties -### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot - -## SnapshotPolicyProperties -### Properties -* **dailySchedule**: [DailySchedule](#dailyschedule): Daily Schedule properties -* **enabled**: bool: The property to decide policy is enabled or not -* **hourlySchedule**: [HourlySchedule](#hourlyschedule): Hourly Schedule properties -* **monthlySchedule**: [MonthlySchedule](#monthlyschedule): Monthly Schedule properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days - -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule -### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## MonthlySchedule +## VolumeSnapshotProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **snapshotPolicyId**: string: Snapshot Policy ResourceId ## WeeklySchedule ### Properties @@ -342,41 +380,3 @@ * **snapshotsToKeep**: int: Weekly snapshot count to keep * **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VolumeGroupProperties -### Properties -* **groupMetaData**: [VolumeGroupMetaData](#volumegroupmetadata): Volume group properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **volumes**: [VolumeGroupVolumeProperties](#volumegroupvolumeproperties)[]: List of volumes from group - -## VolumeGroupMetaData -### Properties -* **applicationIdentifier**: string: Application specific identifier -* **applicationType**: 'SAP-HANA' | string: Application Type -* **deploymentSpecId**: string: Application specific identifier of deployment rules for the volume group -* **globalPlacementRules**: [PlacementKeyValuePairs](#placementkeyvaluepairs)[]: Application specific placement rules for the volume group -* **groupDescription**: string: Group Description -* **volumesCount**: int (ReadOnly): Number of volumes in volume group - -## VolumeGroupVolumeProperties -### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [VolumeProperties](#volumeproperties) (Required): Volume properties -* **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource -* **type**: string (ReadOnly): Resource type - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/netapp/microsoft.netapp/2021-10-01/types.md b/generated/netapp/microsoft.netapp/2021-10-01/types.md index 2c6969cf1d..1c4cdcbf4f 100644 --- a/generated/netapp/microsoft.netapp/2021-10-01/types.md +++ b/generated/netapp/microsoft.netapp/2021-10-01/types.md @@ -106,6 +106,10 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: 'Microsoft.NetApp/netAppAccounts/volumeGroups' (ReadOnly, DeployTimeConstant): The resource type +## AccountEncryption +### Properties +* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. + ## AccountProperties ### Properties * **activeDirectories**: [ActiveDirectory](#activedirectory)[]: Active Directories @@ -137,30 +141,6 @@ * **statusDetails**: string (ReadOnly): Any details in regards to the Status of the Active Directory * **username**: string: Username of Active Directory domain administrator -## LdapSearchScopeOpt -### Properties -* **groupDN**: string: This specifies the group DN, which overrides the base DN for group lookups. -* **groupMembershipFilter**: string: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. -* **userDN**: string: This specifies the user DN, which overrides the base DN for user lookups. - -## AccountEncryption -### Properties -* **keySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp'. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## BackupPolicyProperties ### Properties * **backupPolicyId**: string (ReadOnly): Backup Policy Resource ID @@ -172,107 +152,24 @@ * **volumesAssigned**: int (ReadOnly): Volumes using current backup policy * **weeklyBackupsToKeep**: int: Weekly backups count to keep -## VolumeBackups -### Properties -* **backupsCount**: int: Total count of backups for volume -* **policyEnabled**: bool: Policy enabled -* **volumeName**: string: Volume name - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PoolProperties -### Properties -* **coolAccess**: bool: If enabled (true) the pool can contain cool Access enabled volumes. -* **encryptionType**: 'Double' | 'Single' | string: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. -* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool -* **serviceLevel**: 'Premium' | 'Standard' | 'StandardZRS' | 'Ultra' | string (Required): The service level of the file system -* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104). -* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps -* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VolumeProperties +## BackupProperties ### Properties -* **avsDataStore**: 'Disabled' | 'Enabled' | string: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose -* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. -* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. -* **capacityPoolResourceId**: string: Pool Resource Id used in case of creating a volume through volume group -* **cloneProgress**: int (ReadOnly): When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. -* **coolAccess**: bool: Specifies whether Cool Access(tiering) is enabled for the volume. -* **coolnessPeriod**: int: Specifies the number of days after which data that is not accessed by clients will be tiered. -* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets -* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication -* **defaultGroupQuotaInKiBs**: int: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. -* **defaultUserQuotaInKiBs**: int: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . -* **enableSubvolumes**: 'Disabled' | 'Enabled' | string: Flag indicating whether subvolume operations are enabled on the volume -* **encryptionKeySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp' -* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules -* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. -* **isDefaultQuotaEnabled**: bool: Specifies if default quota is enabled for the volume. -* **isRestoring**: bool: Restoring -* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later -* **ldapEnabled**: bool: Specifies whether LDAP is enabled or not for a given NFS volume. -* **maximumNumberOfFiles**: int (ReadOnly): Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. -* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets -* **networkFeatures**: 'Basic' | 'Standard' | string: Basic network, or Standard features available to the volume. -* **networkSiblingSetId**: string (ReadOnly): Network Sibling Set ID for the the group of volumes sharing networking resources. -* **placementRules**: [PlacementKeyValuePairs](#placementkeyvaluepairs)[]: Application specific placement rules for the particular volume -* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup +* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled +* **creationDate**: string (ReadOnly): The creation date of the backup +* **failureReason**: string (ReadOnly): Failure reason +* **label**: string: Label for backup * **provisioningState**: string (ReadOnly): Azure lifecycle management -* **proximityPlacementGroup**: string: Proximity placement group associated with the volume -* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol -* **serviceLevel**: 'Premium' | 'Standard' | 'StandardZRS' | 'Ultra' | string: The service level of the file system -* **smbContinuouslyAvailable**: bool: Enables continuously available share property for smb volume. Only applicable for SMB volume -* **smbEncryption**: bool: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later -* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (default to true). -* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. -* **storageToNetworkProximity**: 'Default' | 'T1' | 'T2' | string (ReadOnly): Provides storage to network proximity information for the volume. -* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes -* **t2Network**: string (ReadOnly): T2 network information -* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume and this will be accepted as input only for manual qosType volume -* **unixPermissions**: string: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. -* **usageThreshold**: int (Required): 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. -* **volumeGroupName**: string (ReadOnly): Volume Group Name -* **volumeSpecName**: string: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log -* **volumeType**: string: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection - -## VolumePropertiesDataProtection -### Properties -* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties -* **replication**: [ReplicationObject](#replicationobject): Replication properties -* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties - -## VolumeBackupProperties -### Properties -* **backupEnabled**: bool: Backup Enabled -* **backupPolicyId**: string: Backup Policy Resource ID -* **policyEnforced**: bool: Policy Enforced -* **vaultId**: string: Vault Resource ID - -## ReplicationObject -### Properties -* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication -* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. -* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. -* **replicationId**: string: Id -* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule - -## VolumeSnapshotProperties -### Properties -* **snapshotPolicyId**: string: Snapshot Policy ResourceId +* **size**: int (ReadOnly): Size of backup +* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups +* **volumeName**: string (ReadOnly): Volume name -## VolumePropertiesExportPolicy +## DailySchedule ### Properties -* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Daily snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes ## ExportPolicyRule ### Properties @@ -292,6 +189,26 @@ * **unixReadOnly**: bool: Read only access * **unixReadWrite**: bool: Read and write access +## HourlySchedule +### Properties +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Hourly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + +## LdapSearchScopeOpt +### Properties +* **groupDN**: string: This specifies the group DN, which overrides the base DN for group lookups. +* **groupMembershipFilter**: string: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. +* **userDN**: string: This specifies the user DN, which overrides the base DN for user lookups. + +## MonthlySchedule +### Properties +* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Monthly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes + ## MountTargetProperties ### Properties * **fileSystemId**: string (Required): UUID v4 used to identify the MountTarget @@ -304,35 +221,60 @@ * **key**: string (Required): Key for an application specific parameter for the placement of volumes in the volume group * **value**: string (Required): Value for an application specific parameter for the placement of volumes in the volume group +## PoolProperties +### Properties +* **coolAccess**: bool: If enabled (true) the pool can contain cool Access enabled volumes. +* **encryptionType**: 'Double' | 'Single' | string: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. +* **poolId**: string (ReadOnly): UUID v4 used to identify the Pool +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **qosType**: 'Auto' | 'Manual' | string: The qos type of the pool +* **serviceLevel**: 'Premium' | 'Standard' | 'StandardZRS' | 'Ultra' | string (Required): The service level of the file system +* **size**: int (Required): Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104). +* **totalThroughputMibps**: int (ReadOnly): Total throughput of pool in Mibps +* **utilizedThroughputMibps**: int (ReadOnly): Utilized throughput of pool in Mibps + +## ReplicationObject +### Properties +* **endpointType**: 'dst' | 'src' | string: Indicates whether the local volume is the source or destination for the Volume Replication +* **remoteVolumeRegion**: string: The remote region for the other end of the Volume Replication. +* **remoteVolumeResourceId**: string (Required): The resource ID of the remote volume. +* **replicationId**: string: Id +* **replicationSchedule**: '_10minutely' | 'daily' | 'hourly' | string: Schedule + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BackupProperties +## ResourceTags ### Properties -* **backupId**: string (ReadOnly): UUID v4 used to identify the Backup -* **backupType**: 'Manual' | 'Scheduled' | string (ReadOnly): Type of backup Manual or Scheduled -* **creationDate**: string (ReadOnly): The creation date of the backup -* **failureReason**: string (ReadOnly): Failure reason -* **label**: string: Label for backup -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (ReadOnly): Size of backup -* **useExistingSnapshot**: bool: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups -* **volumeName**: string (ReadOnly): Volume name +### Additional Properties +* **Additional Properties Type**: string -## SnapshotProperties +## ResourceTags ### Properties -* **created**: string (ReadOnly): The creation date of the snapshot -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot +### Additional Properties +* **Additional Properties Type**: string -## SubvolumeProperties +## ResourceTags ### Properties -* **parentPath**: string: parent path to the subvolume -* **path**: string: Path to the subvolume -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **size**: int (WriteOnly): Truncate subvolume to the provided size in bytes +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## SnapshotPolicyProperties ### Properties @@ -343,45 +285,40 @@ * **provisioningState**: string (ReadOnly): Azure lifecycle management * **weeklySchedule**: [WeeklySchedule](#weeklyschedule): Weekly Schedule properties, make a snapshot every week at a specific day or days -## DailySchedule -### Properties -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Daily snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes - -## HourlySchedule +## SnapshotProperties ### Properties -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Hourly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **created**: string (ReadOnly): The creation date of the snapshot +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **snapshotId**: string (ReadOnly): UUID v4 used to identify the Snapshot -## MonthlySchedule +## SubvolumeProperties ### Properties -* **daysOfMonth**: string: Indicates which days of the month snapshot should be taken. A comma delimited string. -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Monthly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **parentPath**: string: parent path to the subvolume +* **path**: string: Path to the subvolume +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **size**: int (WriteOnly): Truncate subvolume to the provided size in bytes -## WeeklySchedule +## SystemData ### Properties -* **day**: string: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english -* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken -* **minute**: int: Indicates which minute snapshot should be taken -* **snapshotsToKeep**: int: Weekly snapshot count to keep -* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceTags +## VolumeBackupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupEnabled**: bool: Backup Enabled +* **backupPolicyId**: string: Backup Policy Resource ID +* **policyEnforced**: bool: Policy Enforced +* **vaultId**: string: Vault Resource ID -## VolumeGroupProperties +## VolumeBackups ### Properties -* **groupMetaData**: [VolumeGroupMetaData](#volumegroupmetadata): Volume group properties -* **provisioningState**: string (ReadOnly): Azure lifecycle management -* **volumes**: [VolumeGroupVolumeProperties](#volumegroupvolumeproperties)[]: List of volumes from group +* **backupsCount**: int: Total count of backups for volume +* **policyEnabled**: bool: Policy enabled +* **volumeName**: string: Volume name ## VolumeGroupMetaData ### Properties @@ -392,6 +329,12 @@ * **groupDescription**: string: Group Description * **volumesCount**: int (ReadOnly): Number of volumes in volume group +## VolumeGroupProperties +### Properties +* **groupMetaData**: [VolumeGroupMetaData](#volumegroupmetadata): Volume group properties +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **volumes**: [VolumeGroupVolumeProperties](#volumegroupvolumeproperties)[]: List of volumes from group + ## VolumeGroupVolumeProperties ### Properties * **id**: string (ReadOnly): Resource Id @@ -400,13 +343,70 @@ * **tags**: [ResourceTags](#resourcetags): Tags are a list of key-value pairs that describe the resource * **type**: string (ReadOnly): Resource type -## ResourceTags +## VolumeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **avsDataStore**: 'Disabled' | 'Enabled' | string: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose +* **backupId**: string: UUID v4 or resource identifier used to identify the Backup. +* **baremetalTenantId**: string (ReadOnly): Unique Baremetal Tenant Identifier. +* **capacityPoolResourceId**: string: Pool Resource Id used in case of creating a volume through volume group +* **cloneProgress**: int (ReadOnly): When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. +* **coolAccess**: bool: Specifies whether Cool Access(tiering) is enabled for the volume. +* **coolnessPeriod**: int: Specifies the number of days after which data that is not accessed by clients will be tiered. +* **creationToken**: string (Required): A unique file path for the volume. Used when creating mount targets +* **dataProtection**: [VolumePropertiesDataProtection](#volumepropertiesdataprotection): DataProtection type volumes include an object containing details of the replication +* **defaultGroupQuotaInKiBs**: int: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. +* **defaultUserQuotaInKiBs**: int: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . +* **enableSubvolumes**: 'Disabled' | 'Enabled' | string: Flag indicating whether subvolume operations are enabled on the volume +* **encryptionKeySource**: string: Encryption Key Source. Possible values are: 'Microsoft.NetApp' +* **exportPolicy**: [VolumePropertiesExportPolicy](#volumepropertiesexportpolicy): Set of export policy rules +* **fileSystemId**: string (ReadOnly): Unique FileSystem Identifier. +* **isDefaultQuotaEnabled**: bool: Specifies if default quota is enabled for the volume. +* **isRestoring**: bool: Restoring +* **kerberosEnabled**: bool: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later +* **ldapEnabled**: bool: Specifies whether LDAP is enabled or not for a given NFS volume. +* **maximumNumberOfFiles**: int (ReadOnly): Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. +* **mountTargets**: [MountTargetProperties](#mounttargetproperties)[] (ReadOnly): List of mount targets +* **networkFeatures**: 'Basic' | 'Standard' | string: Basic network, or Standard features available to the volume. +* **networkSiblingSetId**: string (ReadOnly): Network Sibling Set ID for the the group of volumes sharing networking resources. +* **placementRules**: [PlacementKeyValuePairs](#placementkeyvaluepairs)[]: Application specific placement rules for the particular volume +* **protocolTypes**: string[]: Set of protocol types, default NFSv3, CIFS for SMB protocol +* **provisioningState**: string (ReadOnly): Azure lifecycle management +* **proximityPlacementGroup**: string: Proximity placement group associated with the volume +* **securityStyle**: 'ntfs' | 'unix' | string: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol +* **serviceLevel**: 'Premium' | 'Standard' | 'StandardZRS' | 'Ultra' | string: The service level of the file system +* **smbContinuouslyAvailable**: bool: Enables continuously available share property for smb volume. Only applicable for SMB volume +* **smbEncryption**: bool: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later +* **snapshotDirectoryVisible**: bool: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (default to true). +* **snapshotId**: string: UUID v4 or resource identifier used to identify the Snapshot. +* **storageToNetworkProximity**: 'Default' | 'T1' | 'T2' | string (ReadOnly): Provides storage to network proximity information for the volume. +* **subnetId**: string (Required): The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes +* **t2Network**: string (ReadOnly): T2 network information +* **throughputMibps**: int: Maximum throughput in Mibps that can be achieved by this volume and this will be accepted as input only for manual qosType volume +* **unixPermissions**: string: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. +* **usageThreshold**: int (Required): 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. +* **volumeGroupName**: string (ReadOnly): Volume Group Name +* **volumeSpecName**: string: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log +* **volumeType**: string: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection -## ResourceTags +## VolumePropertiesDataProtection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backup**: [VolumeBackupProperties](#volumebackupproperties): Volume Backup Properties +* **replication**: [ReplicationObject](#replicationobject): Replication properties +* **snapshot**: [VolumeSnapshotProperties](#volumesnapshotproperties): Volume Snapshot Properties + +## VolumePropertiesExportPolicy +### Properties +* **rules**: [ExportPolicyRule](#exportpolicyrule)[]: Export policy rule + +## VolumeSnapshotProperties +### Properties +* **snapshotPolicyId**: string: Snapshot Policy ResourceId + +## WeeklySchedule +### Properties +* **day**: string: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english +* **hour**: int: Indicates which hour in UTC timezone a snapshot should be taken +* **minute**: int: Indicates which minute snapshot should be taken +* **snapshotsToKeep**: int: Weekly snapshot count to keep +* **usedBytes**: int: Resource size in bytes, current storage usage for the volume in bytes diff --git a/generated/network/log.out b/generated/network/log.out index 024e03c540..204cf5f6c5 100644 --- a/generated/network/log.out +++ b/generated/network/log.out @@ -86,7 +86,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.network-2022-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -172,7 +172,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2022-02-01-preview/network.json:38:5 @@ -197,7 +197,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ExtendedLocation' with an und warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'NetworkManagerConnection' has a property 'etag' that is already declared the parent schema 'ProxyResource' but isn't significantly different. The property has been removed from NetworkManagerConnection warning | PreCheck/PropertyRedeclarationWarning | Schema 'ScopeConnection' has a property 'etag' that is already declared the parent schema 'ProxyResource' but isn't significantly different. The property has been removed from ScopeConnection -info | autorest.bicep took 23ms +info | autorest.bicep took 21ms info | Processing batch task - {"tag":"microsoft.network-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -283,7 +283,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/applicationGateway.json:1156:5 @@ -1694,7 +1694,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 153ms +info | autorest.bicep took 147ms info | Processing batch task - {"tag":"microsoft.network-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1780,7 +1780,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/applicationGateway.json:1156:5 @@ -3133,7 +3133,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 138ms +info | autorest.bicep took 161ms info | Processing batch task - {"tag":"microsoft.network-2021-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3219,7 +3219,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2021-05-01-preview/network.json:38:5 @@ -3244,7 +3244,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ExtendedLocation' with an und warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'NetworkManagerConnection' has a property 'etag' that is already declared the parent schema 'ProxyResource' but isn't significantly different. The property has been removed from NetworkManagerConnection warning | PreCheck/PropertyRedeclarationWarning | Schema 'ScopeConnection' has a property 'etag' that is already declared the parent schema 'ProxyResource' but isn't significantly different. The property has been removed from ScopeConnection -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.network-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3330,7 +3330,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2021-03-01/applicationGateway.json:1156:5 @@ -4745,7 +4745,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 148ms +info | autorest.bicep took 153ms info | Processing batch task - {"tag":"microsoft.network-2021-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4831,7 +4831,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2021-02-01/applicationGateway.json:1156:5 @@ -6236,7 +6236,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 162ms +info | autorest.bicep took 173ms info | Processing batch task - {"tag":"microsoft.network-2020-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6322,7 +6322,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-11-01/applicationGateway.json:1156:5 @@ -7713,7 +7713,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 141ms +info | autorest.bicep took 167ms info | Processing batch task - {"tag":"microsoft.network-2021-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -7799,7 +7799,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'NetworkManager' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2021-02-01-preview/networkManager.json:443:5 @@ -7901,7 +7901,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'NspAssociation' has a warning | PreCheck/PropertyRedeclarationWarning | Schema 'PerimeterAssociableResource' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'PerimeterAssociableResource' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'PerimeterAssociableResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from PerimeterAssociableResource -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.network-2021-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -7987,7 +7987,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/network.json:38:5 @@ -8016,7 +8016,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'NetworkSecurityPerimet warning | PreCheck/PropertyRedeclarationWarning | Schema 'PerimeterAssociableResource' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'PerimeterAssociableResource' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'PerimeterAssociableResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from PerimeterAssociableResource -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.network-2020-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -8102,7 +8102,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-08-01/applicationGateway.json:1156:5 @@ -9487,7 +9487,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 174ms +info | autorest.bicep took 125ms info | Processing batch task - {"tag":"microsoft.network-2020-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -9573,7 +9573,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-07-01/applicationGateway.json:1156:5 @@ -10948,7 +10948,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 111ms +info | autorest.bicep took 137ms info | Processing batch task - {"tag":"microsoft.network-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -11034,7 +11034,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/applicationGateway.json:1156:5 @@ -12387,7 +12387,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 139ms +info | autorest.bicep took 179ms info | Processing batch task - {"tag":"microsoft.network-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -12473,7 +12473,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationGateway.json:1156:5 @@ -13768,7 +13768,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 156ms +info | autorest.bicep took 162ms info | Processing batch task - {"tag":"microsoft.network-2020-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -13854,7 +13854,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/applicationGateway.json:860:5 @@ -15085,7 +15085,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 107ms +info | autorest.bicep took 101ms info | Processing batch task - {"tag":"microsoft.network-2020-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -15171,7 +15171,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/applicationGateway.json:860:5 @@ -16380,7 +16380,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 118ms +info | autorest.bicep took 146ms info | Processing batch task - {"tag":"microsoft.network-2019-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16466,7 +16466,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/applicationGateway.json:860:5 @@ -17647,7 +17647,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 147ms +info | autorest.bicep took 139ms info | Processing batch task - {"tag":"microsoft.network-2019-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -17733,7 +17733,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/applicationGateway.json:860:5 @@ -18898,7 +18898,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 105ms +info | autorest.bicep took 102ms info | Processing batch task - {"tag":"microsoft.network-2019-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18984,7 +18984,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/applicationGateway.json:860:5 @@ -20115,7 +20115,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 101ms +info | autorest.bicep took 97ms info | Processing batch task - {"tag":"microsoft.network-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -20201,7 +20201,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/applicationGateway.json:777:5 @@ -21298,7 +21298,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink warning | PreCheck/PropertyRedeclarationWarning | Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 81ms +info | autorest.bicep took 85ms info | Processing batch task - {"tag":"microsoft.network-2019-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -21384,7 +21384,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/applicationGateway.json:777:5 @@ -22458,7 +22458,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 104ms +info | autorest.bicep took 90ms info | Processing batch task - {"tag":"microsoft.network-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -22544,7 +22544,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/applicationGateway.json:777:5 @@ -23596,7 +23596,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 108ms +info | autorest.bicep took 73ms info | Processing batch task - {"tag":"microsoft.network-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -23682,7 +23682,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/applicationGateway.json:780:5 @@ -24682,7 +24682,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 72ms +info | autorest.bicep took 99ms info | Processing batch task - {"tag":"microsoft.network-2019-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -24768,7 +24768,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayOnDemandProbe' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2019-02-01/applicationGateway.json:777:5 @@ -25711,7 +25711,7 @@ warning | PreCheck/SchemaMissingType | The schema 'MatchCondition' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 83ms +info | autorest.bicep took 77ms info | Processing batch task - {"tag":"microsoft.network-2018-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -25797,7 +25797,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-12-01/applicationGateway.json:695:5 @@ -26724,7 +26724,7 @@ warning | PreCheck/SchemaMissingType | The schema 'MatchCondition' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 77ms +info | autorest.bicep took 66ms info | Processing batch task - {"tag":"microsoft.network-2018-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -26810,7 +26810,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/applicationGateway.json:695:5 @@ -27709,7 +27709,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VpnProfileResponse' with an u warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 78ms +info | autorest.bicep took 59ms info | Processing batch task - {"tag":"microsoft.network-2018-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -27795,7 +27795,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json:587:5 @@ -28682,7 +28682,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VpnProfileResponse' with an u warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 84ms +info | autorest.bicep took 64ms info | Processing batch task - {"tag":"microsoft.network-2018-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -28768,7 +28768,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json:587:5 @@ -29639,7 +29639,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VpnProfileResponse' with an u warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 68ms +info | autorest.bicep took 55ms info | Processing batch task - {"tag":"microsoft.network-2018-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -29725,7 +29725,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureFirewallIPConfigurationPropertiesFormat' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/azureFirewall.json:260:5 @@ -30436,7 +30436,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ServiceEndpointPolicyListResu warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 53ms +info | autorest.bicep took 51ms info | Processing batch task - {"tag":"microsoft.network-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -30522,7 +30522,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureFirewallIPConfigurationPropertiesFormat' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/azureFirewall.json:260:5 @@ -31211,7 +31211,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Policies' with an undefined t warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 47ms +info | autorest.bicep took 42ms info | Processing batch task - {"tag":"microsoft.network-2018-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -31297,7 +31297,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AzureFirewallIPConfigurationPropertiesFormat' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/azureFirewall.json:260:5 @@ -31968,7 +31968,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Policies' with an undefined t warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 46ms +info | autorest.bicep took 40ms info | Processing batch task - {"tag":"microsoft.network-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -32054,7 +32054,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/applicationGateway.json:587:5 @@ -32733,7 +32733,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/applicationGateway.json:587:5 @@ -33297,7 +33297,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'NetworkWatcher' has a warning | PreCheck/PropertyRedeclarationWarning | Schema 'NetworkWatcher' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NetworkWatcher warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 37ms +info | autorest.bicep took 41ms info | Processing batch task - {"tag":"microsoft.network-2017-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -33383,7 +33383,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/applicationGateway.json:542:5 @@ -33940,7 +33940,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VpnDeviceScriptParameters' wi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 46ms +info | autorest.bicep took 38ms info | Processing batch task - {"tag":"microsoft.network-2017-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -34026,7 +34026,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/applicationGateway.json:542:5 @@ -34581,7 +34581,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VpnDeviceScriptParameters' wi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 32ms +info | autorest.bicep took 34ms info | Processing batch task - {"tag":"microsoft.network-2017-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -34667,7 +34667,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/applicationGateway.json:542:5 @@ -35204,7 +35204,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VpnDeviceScriptParameters' wi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 44ms +info | autorest.bicep took 50ms info | Processing batch task - {"tag":"microsoft.network-2017-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -35290,7 +35290,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/applicationGateway.json:490:5 @@ -35781,7 +35781,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VirtualNetworkGatewayListConn warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 30ms +info | autorest.bicep took 36ms info | Processing batch task - {"tag":"microsoft.network-2017-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -35867,7 +35867,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/applicationGateway.json:490:5 @@ -36354,7 +36354,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VirtualNetworkGatewayListConn warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 41ms +info | autorest.bicep took 32ms info | Processing batch task - {"tag":"microsoft.network-2017-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -36440,7 +36440,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/applicationGateway.json:390:5 @@ -36883,7 +36883,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LocalNetworkGatewayListResult warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 28ms +info | autorest.bicep took 25ms info | Processing batch task - {"tag":"microsoft.network-2016-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -36969,7 +36969,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/applicationGateway.json:367:5 @@ -37377,7 +37377,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LocalNetworkGatewayListResult - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/virtualNetworkGateway.json:1665:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 15ms +info | autorest.bicep took 35ms info | Processing batch task - {"tag":"microsoft.network-2016-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -37463,7 +37463,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewayBackendHealth' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/applicationGateway.json:367:5 @@ -37845,7 +37845,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LocalNetworkGatewayListResult - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/virtualNetworkGateway.json:1681:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 22ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.network-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -37931,7 +37931,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewaySku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-06-01/network.json:4298:5 @@ -38225,7 +38225,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-06-01/network.json:8159:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 19ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.network-2016-03-30"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -38311,7 +38311,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewaySku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-03-30/network.json:3973:5 @@ -38575,7 +38575,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2016-03-30/network.json:7369:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.network-2015-06-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -38661,7 +38661,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewaySku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/applicationGateway.json:317:5 @@ -38923,7 +38923,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LocalNetworkGatewayListResult - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/virtualNetworkGateway.json:1310:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 12ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.network-2015-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -39009,7 +39009,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApplicationGatewaySku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2015-05-01-preview/network.json:3742:5 @@ -39237,5 +39237,5 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2015-05-01-preview/network.json:6646:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 9ms -info | Autorest completed in 1015.73s. 156 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 988.58s. 156 files generated. diff --git a/generated/network/microsoft.network/2015-05-01-preview/types.md b/generated/network/microsoft.network/2015-05-01-preview/types.md index 3fdc0b6403..82d0233ab0 100644 --- a/generated/network/microsoft.network/2015-05-01-preview/types.md +++ b/generated/network/microsoft.network/2015-05-01-preview/types.md @@ -183,20 +183,14 @@ * **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) * **type**: 'Microsoft.Network/virtualnetworks/subnets' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets backend address pool of application gateway resource -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Gets or sets backend http settings of application gateway resource -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Gets or sets frontend IP addresses of application gateway resource -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Gets or sets frontend ports of application gateway resource -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Gets or sets subnets of application gateway resource -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Gets or sets HTTP listeners of application gateway resource -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Gets operational state of application gateway resource -* **provisioningState**: string: Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Gets or sets request routing rules of application gateway resource -* **resourceGuid**: string: Gets or sets resource guid property of the ApplicationGateway resource -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: Gets or sets ssl certificates of application gateway resource +* **addressPrefixes**: string[]: Gets or sets List of address blocks reserved for this virtual network in CIDR notation + +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Gets or sets the dns name +* **ipAddress**: string: Gets or sets the ip address ## ApplicationGatewayBackendAddressPool ### Properties @@ -211,15 +205,6 @@ * **backendIPConfigurations**: [SubResource](#subresource)[]: Gets or sets backendIPConfiguration of application gateway * **provisioningState**: string: Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Gets or sets the dns name -* **ipAddress**: string: Gets or sets the ip address - -## SubResource -### Properties -* **id**: string: Resource Id - ## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -261,18 +246,6 @@ * **port**: int: Gets or sets the frontend port * **provisioningState**: string: Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of application gateway - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed -* **subnet**: [SubResource](#subresource) - ## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -288,6 +261,33 @@ * **provisioningState**: string: Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed * **sslCertificate**: [SubResource](#subresource) +## ApplicationGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of application gateway + +## ApplicationGatewayIPConfigurationPropertiesFormat +### Properties +* **provisioningState**: string: Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed +* **subnet**: [SubResource](#subresource) + +## ApplicationGatewayPropertiesFormat +### Properties +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets backend address pool of application gateway resource +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Gets or sets backend http settings of application gateway resource +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Gets or sets frontend IP addresses of application gateway resource +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Gets or sets frontend ports of application gateway resource +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Gets or sets subnets of application gateway resource +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Gets or sets HTTP listeners of application gateway resource +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Gets operational state of application gateway resource +* **provisioningState**: string: Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Gets or sets request routing rules of application gateway resource +* **resourceGuid**: string: Gets or sets resource guid property of the ApplicationGateway resource +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: Gets or sets ssl certificates of application gateway resource + ## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -323,107 +323,29 @@ * **provisioningState**: string: Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed * **publicCertData**: string: Gets or sets the certificate public data -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet -* **egressBytesTransferred**: int: The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int: The Ingress Bytes Transferred in this connection -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource -* **routingWeight**: int: The Routing weight. -* **sharedKey**: string: The IPsec share key. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## LocalNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string (ReadOnly): Resource Id -* **location**: string (Required): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets -* **provisioningState**: string: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the LocalNetworkGateway resource - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: Gets or sets List of address blocks reserved for this virtual network in CIDR notation - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string (ReadOnly): Resource Id -* **location**: string (Required): Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## VirtualNetworkGatewayPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **enableBgp**: bool: EnableBgp Flag -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **ipConfigurations**: [VirtualNetworkGatewayIpConfiguration](#virtualnetworkgatewayipconfiguration)[]: IpConfigurations for Virtual network gateway. -* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGateway resource -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **authorizationKey**: string: Gets or sets the authorization key +* **authorizationUseStatus**: 'Available' | 'InUse' | string: Gets or sets AuthorizationUseStatus +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -## VirtualNetworkGatewayIpConfiguration +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VirtualNetworkGatewayIpConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIpConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: Gets or sets the privateIPAddress of the Network Interface IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of BackendAddressPool -## ResourceTags +## BackendAddressPoolPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendIPConfigurations**: [SubResource](#subresource)[]: Gets collection of references to IPs defined in NICs +* **loadBalancingRules**: [SubResource](#subresource)[]: Gets Load Balancing rules that use this Backend Address Pool +* **outboundNatRule**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the PublicIP resource Updating/Deleting/Failed -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: Gets or sets list of authorizations -* **circuitProvisioningState**: string: Gets or sets CircuitProvisioningState state of the resource -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: Gets or sets list of peerings -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **serviceKey**: string: Gets or sets ServiceKey -* **serviceProviderNotes**: string: Gets or sets ServiceProviderNotes -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: Gets or sets ServiceProviderProvisioningState state of the resource +* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses ## ExpressRouteCircuitAuthorization ### Properties @@ -432,12 +354,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: Gets or sets the authorization key -* **authorizationUseStatus**: 'Available' | 'InUse' | string: Gets or sets AuthorizationUseStatus -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed - ## ExpressRouteCircuitPeering ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -445,6 +361,13 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedPublicPrefixes**: string[]: Gets or sets the reference of AdvertisedPublicPrefixes +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: Gets or sets AdvertisedPublicPrefixState of the Peering resource +* **customerASN**: int: Gets or Sets CustomerAsn of the peering. +* **routingRegistryName**: string: Gets or Sets RoutingRegistryName of the config. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: Gets or sets the azure ASN @@ -461,17 +384,16 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains Stats associated with the peering * **vlanId**: int: Gets or sets the vlan id -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedPublicPrefixes**: string[]: Gets or sets the reference of AdvertisedPublicPrefixes -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: Gets or sets AdvertisedPublicPrefixState of the Peering resource -* **customerASN**: int: Gets or Sets CustomerAsn of the peering. -* **routingRegistryName**: string: Gets or Sets RoutingRegistryName of the config. - -## ExpressRouteCircuitStats +## ExpressRouteCircuitPropertiesFormat ### Properties -* **bytesIn**: int: Gets BytesIn of the peering. -* **bytesOut**: int: Gets BytesOut of the peering. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: Gets or sets list of authorizations +* **circuitProvisioningState**: string: Gets or sets CircuitProvisioningState state of the resource +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: Gets or sets list of peerings +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **serviceKey**: string: Gets or sets ServiceKey +* **serviceProviderNotes**: string: Gets or sets ServiceProviderNotes +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: Gets or sets ServiceProviderProvisioningState state of the resource ## ExpressRouteCircuitServiceProviderProperties ### Properties @@ -485,36 +407,10 @@ * **name**: string: Gets or sets name of the sku. * **tier**: 'Premium' | 'Standard' | string: Gets or sets tier of the sku. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets Pools of backend IP addresses -* **frontendIPConfigurations**: [FrontendIpConfiguration](#frontendipconfiguration)[]: Gets or sets frontend IP addresses of the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: Gets or sets inbound NAT pools -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of inbound rules -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Gets or sets load balancing rules -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: Gets or sets outbound NAT rules -* **probes**: [Probe](#probe)[]: Gets or sets list of Load balancer probes -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the Load balancer resource - -## BackendAddressPool -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of BackendAddressPool - -## BackendAddressPoolPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **backendIPConfigurations**: [SubResource](#subresource)[]: Gets collection of references to IPs defined in NICs -* **loadBalancingRules**: [SubResource](#subresource)[]: Gets Load Balancing rules that use this Backend Address Pool -* **outboundNatRule**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **bytesIn**: int: Gets BytesIn of the peering. +* **bytesOut**: int: Gets BytesOut of the peering. ## FrontendIpConfiguration ### Properties @@ -569,6 +465,18 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets Pools of backend IP addresses +* **frontendIPConfigurations**: [FrontendIpConfiguration](#frontendipconfiguration)[]: Gets or sets frontend IP addresses of the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: Gets or sets inbound NAT pools +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of inbound rules +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Gets or sets load balancing rules +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: Gets or sets outbound NAT rules +* **probes**: [Probe](#probe)[]: Gets or sets list of Load balancer probes +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the Load balancer resource + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -589,58 +497,22 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -## OutboundNatRule +## LocalNetworkGateway ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the loadbalancer - -## OutboundNatRulePropertiesFormat -### Properties -* **allocatedOutboundPorts**: int (Required): Gets or sets the number of outbound ports to be used for SNAT -* **backendAddressPool**: [SubResource](#subresource) (Required) -* **frontendIPConfigurations**: [SubResource](#subresource)[]: Gets or sets Frontend IP addresses of the load balancer -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed - -## Probe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ProbePropertiesFormat](#probepropertiesformat) - -## ProbePropertiesFormat -### Properties -* **intervalInSeconds**: int: 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 -* **loadBalancingRules**: [SubResource](#subresource)[]: Gets Load balancer rules that use this probe -* **numberOfProbes**: int: 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. -* **port**: int (Required): Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Tcp' | string (Required): 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 -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **requestPath**: 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string (ReadOnly): Resource Id +* **location**: string (Required): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type -## NetworkInterfacePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): Dns Settings of a network interface -* **enableIPForwarding**: bool: Gets or sets whether IPForwarding is enabled on the NIC -* **ipConfigurations**: [NetworkInterfaceIpConfiguration](#networkinterfaceipconfiguration)[]: Gets or sets list of IPConfigurations of the NetworkInterface -* **macAddress**: string: Gets the MAC Address of the network interface -* **networkSecurityGroup**: [SubResource](#subresource) -* **primary**: bool: Gets whether this is a primary NIC on a virtual machine -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the network interface resource -* **virtualMachine**: [SubResource](#subresource) +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets +* **provisioningState**: string: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the LocalNetworkGateway resource ## NetworkInterfaceDnsSettings ### Properties @@ -666,10 +538,17 @@ * **publicIPAddress**: [SubResource](#subresource) * **subnet**: [SubResource](#subresource) -## ResourceTags +## NetworkInterfacePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): Dns Settings of a network interface +* **enableIPForwarding**: bool: Gets or sets whether IPForwarding is enabled on the NIC +* **ipConfigurations**: [NetworkInterfaceIpConfiguration](#networkinterfaceipconfiguration)[]: Gets or sets list of IPConfigurations of the NetworkInterface +* **macAddress**: string: Gets the MAC Address of the network interface +* **networkSecurityGroup**: [SubResource](#subresource) +* **primary**: bool: Gets whether this is a primary NIC on a virtual machine +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the network interface resource +* **virtualMachine**: [SubResource](#subresource) ## NetworkSecurityGroupPropertiesFormat ### Properties @@ -680,30 +559,42 @@ * **securityRules**: [SecurityRule](#securityrule)[]: Gets or sets Security rules of network security group * **subnets**: [SubResource](#subresource)[]: Gets collection of references to subnets -## SecurityRule +## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the loadbalancer -## SecurityRulePropertiesFormat +## OutboundNatRulePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny' -* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). +* **allocatedOutboundPorts**: int (Required): Gets or sets the number of outbound ports to be used for SNAT +* **backendAddressPool**: [SubResource](#subresource) (Required) +* **frontendIPConfigurations**: [SubResource](#subresource)[]: Gets or sets Frontend IP addresses of the load balancer * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -## ResourceTags +## Probe ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ProbePropertiesFormat](#probepropertiesformat) + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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 +* **loadBalancingRules**: [SubResource](#subresource)[]: Gets Load balancer rules that use this probe +* **numberOfProbes**: int: 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. +* **port**: int (Required): Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Tcp' | string (Required): 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 +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **requestPath**: 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 + +## PublicIpAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. ## PublicIpAddressPropertiesFormat ### Properties @@ -715,22 +606,70 @@ * **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string (Required): Gets or sets PrivateIP allocation method (Static/Dynamic) * **resourceGuid**: string: Gets or sets resource guid property of the PublicIP resource -## PublicIpAddressDnsSettings +## ResourceTags ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## RouteTablePropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed -* **routes**: [Route](#route)[]: Gets or sets Routes in a Route Table -* **subnets**: [SubResource](#subresource)[]: Gets collection of references to subnets +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## Route ### Properties @@ -746,27 +685,31 @@ * **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets NextHopType. * **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed -## ResourceTags +## RouteTablePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed +* **routes**: [Route](#route)[]: Gets or sets Routes in a Route Table +* **subnets**: [SubResource](#subresource)[]: Gets collection of references to subnets -## ResourceTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) -## VirtualNetworkPropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandard DHCP option for a subnet overrides VNET DHCP options. +* **access**: 'Allow' | 'Deny' | string (Required): Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny' +* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetwork resource -* **subnets**: [Subnet](#subnet)[]: Gets or sets List of subnets in a VirtualNetwork - -## DhcpOptions -### Properties -* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ## Subnet ### Properties @@ -783,8 +726,65 @@ * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed * **routeTable**: [SubResource](#subresource) -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string (ReadOnly): Resource Id +* **location**: string (Required): Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet +* **egressBytesTransferred**: int: The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int: The Ingress Bytes Transferred in this connection +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource +* **routingWeight**: int: The Routing weight. +* **sharedKey**: string: The IPsec share key. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIpConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VirtualNetworkGatewayIpConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIpConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: Gets or sets the privateIPAddress of the Network Interface IP Configuration +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **enableBgp**: bool: EnableBgp Flag +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **ipConfigurations**: [VirtualNetworkGatewayIpConfiguration](#virtualnetworkgatewayipconfiguration)[]: IpConfigurations for Virtual network gateway. +* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGateway resource +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. + +## VirtualNetworkPropertiesFormat +### Properties +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandard DHCP option for a subnet overrides VNET DHCP options. +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetwork resource +* **subnets**: [Subnet](#subnet)[]: Gets or sets List of subnets in a VirtualNetwork diff --git a/generated/network/microsoft.network/2015-06-15/types.md b/generated/network/microsoft.network/2015-06-15/types.md index 83f905bf76..9cb53d26dd 100644 --- a/generated/network/microsoft.network/2015-06-15/types.md +++ b/generated/network/microsoft.network/2015-06-15/types.md @@ -183,22 +183,14 @@ * **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) * **type**: 'Microsoft.Network/virtualnetworks/subnets' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Gets or sets subnets of application gateway resource -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. + +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address ## ApplicationGatewayBackendAddressPool ### Properties @@ -213,239 +205,6 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## BackendAddressPool -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. - -## BackendAddressPoolPropertiesFormat -### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## SubResource -### Properties -* **id**: string: Resource Identifier. - -## InboundNatRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. - -## InboundNatRulePropertiesFormat -### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## PublicIPAddress -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration): IPConfiguration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **resourceGuid**: string: The resource GUID property of the public IP resource. - -## PublicIPAddressDnsSettings -### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. - -## IPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. - -## IPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## Subnet -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) - -## SubnetPropertiesFormat -### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[]: Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **routeTable**: [RouteTable](#routetable): Route table resource. - -## NetworkSecurityGroup -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkSecurityGroupPropertiesFormat -### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[]: A collection of references to subnets. - -## SecurityRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Azure resource manager sub resource properties. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[]: A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets NextHopType. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -489,6 +248,23 @@ * **port**: int: Frontend port * **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayHttpListener +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. + +## ApplicationGatewayHttpListenerPropertiesFormat +### Properties +* **frontendIPConfiguration**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **frontendPort**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Azure resource manager sub resource properties. + ## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -501,22 +277,19 @@ * **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **subnet**: [SubResource](#subresource): Azure resource manager sub resource properties. -## ApplicationGatewayHttpListener +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource Identifier. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. -## ApplicationGatewayHttpListenerPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **frontendPort**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **backendAddressPool**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **backendHttpSettings**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## ApplicationGatewayProbe ### Properties @@ -535,6 +308,23 @@ * **timeout**: int: 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. * **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +## ApplicationGatewayPropertiesFormat +### Properties +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Gets or sets subnets of application gateway resource +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. + ## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -551,203 +341,69 @@ * **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. * **urlPathMap**: [SubResource](#subresource): Azure resource manager sub resource properties. -## ApplicationGatewaySku -### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | string: Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. -* **tier**: 'Standard' | string: Tier of an application gateway. - -## ApplicationGatewaySslCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **backendHttpSettings**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int: The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int: The ingress bytes transferred in this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **provisioningState**: string: The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## LocalNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Identifier. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: Gets or sets this BGP speaker's ASN -* **bgpPeeringAddress**: string: Gets or sets the BGP peering address and BGP identifier of this BGP speaker -* **peerWeight**: int: Gets or sets the weight added to routes learned from this BGP speaker - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## VirtualNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string: The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - -## VirtualNetworkGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **subnet**: [SubResource](#subresource): Azure resource manager sub resource properties. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku name -Basic/HighPerformance/Standard -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku tier -Basic/HighPerformance/Standard - -## VpnClientConfiguration +## ApplicationGatewaySku ### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for Virtual network gateway. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | string: Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. +* **tier**: 'Standard' | string: Tier of an application gateway. -## VpnClientRevokedCertificate +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -## VpnClientRevokedCertificatePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **provisioningState**: string: The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## VpnClientRootCertificate +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource Identifier. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat): Properties of SSL certificates of application gateway +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -## VpnClientRootCertificatePropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **provisioningState**: string: The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Gets or sets the certificate public data +* **defaultBackendAddressPool**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BackendAddressPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ExpressRouteCircuitPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## BgpSettings +### Properties +* **asn**: int: Gets or sets this BGP speaker's ASN +* **bgpPeeringAddress**: string: Gets or sets the BGP peering address and BGP identifier of this BGP speaker +* **peerWeight**: int: Gets or sets the weight added to routes learned from this BGP speaker + +## DhcpOptions +### Properties +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -756,12 +412,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -769,6 +419,13 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -785,17 +442,16 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. - -## ExpressRouteCircuitStats +## ExpressRouteCircuitPropertiesFormat ### Properties -* **bytesIn**: int: Gets BytesIn of the peering. -* **bytesOut**: int: Gets BytesOut of the peering. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. ## ExpressRouteCircuitServiceProviderProperties ### Properties @@ -809,22 +465,10 @@ * **name**: string: The name of the SKU. * **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +* **bytesIn**: int: Gets BytesIn of the peering. +* **bytesOut**: int: Gets BytesOut of the peering. ## FrontendIPConfiguration ### Properties @@ -861,6 +505,51 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -868,18 +557,102 @@ * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -## LoadBalancingRulePropertiesFormat +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **frontendPort**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## LocalNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Identifier. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Azure resource manager sub resource properties. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **frontendPort**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Azure resource manager sub resource properties. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[]: A collection of references to subnets. ## OutboundNatRule ### Properties @@ -912,6 +685,67 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration): IPConfiguration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties @@ -947,6 +781,151 @@ ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets NextHopType. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[]: A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[]: Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **routeTable**: [RouteTable](#routetable): Route table resource. + +## SubResource +### Properties +* **id**: string: Resource Identifier. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int: The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int: The ingress bytes transferred in this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **provisioningState**: string: The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **subnet**: [SubResource](#subresource): Azure resource manager sub resource properties. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Azure resource manager sub resource properties. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string: The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku name -Basic/HighPerformance/Standard +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku tier -Basic/HighPerformance/Standard + ## VirtualNetworkPropertiesFormat ### Properties * **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. @@ -955,12 +934,33 @@ * **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. * **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -## DhcpOptions +## VpnClientConfiguration ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for Virtual network gateway. -## ResourceTags +## VpnClientRevokedCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string: The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource Identifier. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string: The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Gets or sets the certificate public data diff --git a/generated/network/microsoft.network/2016-03-30/types.md b/generated/network/microsoft.network/2016-03-30/types.md index 76df28574f..5d74cdec6f 100644 --- a/generated/network/microsoft.network/2016-03-30/types.md +++ b/generated/network/microsoft.network/2016-03-30/types.md @@ -183,272 +183,27 @@ * **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) * **type**: 'Microsoft.Network/virtualNetworks/subnets' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat -### Properties -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets backend address pool of application gateway resource -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Gets or sets backend http settings of application gateway resource -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Gets or sets frontend IP addresses of application gateway resource -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Gets or sets frontend ports of application gateway resource -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Gets or sets subnets of application gateway resource -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Gets or sets HTTP listeners of application gateway resource -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Gets operational state of application gateway resource -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Gets or sets probes of application gateway resource -* **provisioningState**: string: Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Gets or sets request routing rules of application gateway resource -* **resourceGuid**: string: Gets or sets resource GUID property of the ApplicationGateway resource -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: Gets or sets ssl certificates of application gateway resource -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: Gets or sets URL path map of application gateway resource - -## ApplicationGatewayBackendAddressPool -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayBackendAddressPoolPropertiesFormat](#applicationgatewaybackendaddresspoolpropertiesformat): Properties of Backend Address Pool of application gateway - -## ApplicationGatewayBackendAddressPoolPropertiesFormat +## AddressSpace ### Properties -* **backendAddresses**: [ApplicationGatewayBackendAddress](#applicationgatewaybackendaddress)[]: Gets or sets the backend addresses -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets collection of references to IPs defined in NICs -* **provisioningState**: string: Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed +* **addressPrefixes**: string[]: Gets or sets List of address blocks reserved for this virtual network in CIDR notation ## ApplicationGatewayBackendAddress ### Properties * **fqdn**: string: Gets or sets the dns name * **ipAddress**: string: Gets or sets the ip address -## NetworkInterfaceIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IPConfiguration - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets the reference of ApplicationGatewayBackendAddressPool resource -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets the reference of LoadBalancerBackendAddressPool resource -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of references of LoadBalancerInboundNatRules -* **primary**: bool: Gets whether this is a primary customer address on the NIC -* **privateIPAddress**: string -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource -* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource - -## BackendAddressPool +## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of BackendAddressPool +* **properties**: [ApplicationGatewayBackendAddressPoolPropertiesFormat](#applicationgatewaybackendaddresspoolpropertiesformat): Properties of Backend Address Pool of application gateway -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayBackendAddressPoolPropertiesFormat ### Properties +* **backendAddresses**: [ApplicationGatewayBackendAddress](#applicationgatewaybackendaddress)[]: Gets or sets the backend addresses * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets collection of references to IPs defined in NICs -* **loadBalancingRules**: [SubResource](#subresource)[]: Gets Load Balancing rules that use this Backend Address Pool -* **outboundNatRule**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the PublicIP resource Updating/Deleting/Failed - -## SubResource -### Properties -* **id**: string: Resource Id - -## InboundNatRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of Inbound NAT rule - -## InboundNatRulePropertiesFormat -### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a NetworkInterface -* **backendPort**: int: 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 -* **enableFloatingIP**: bool: 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 -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int: 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 -* **idleTimeoutInMinutes**: int: 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 -* **protocol**: 'Tcp' | 'Udp' | string: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed - -## PublicIPAddress -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): PublicIpAddress properties -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: Gets or sets the idle timeout of the public IP address -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration): IPConfiguration -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) -* **resourceGuid**: string: Gets or sets resource GUID property of the PublicIP resource - -## PublicIPAddressDnsSettings -### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. - -## IPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IPConfiguration - -## IPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource -* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource - -## Subnet -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) - -## SubnetPropertiesFormat -### Properties -* **addressPrefix**: string: Gets or sets Address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[]: Gets array of references to the network interface IP configurations using subnet -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **routeTable**: [RouteTable](#routetable): RouteTable resource - -## NetworkSecurityGroup -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## NetworkSecurityGroupPropertiesFormat -### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: Gets or sets Default security rules of network security group -* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Gets collection of references to Network Interfaces -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource GUID property of the network security group resource -* **securityRules**: [SecurityRule](#securityrule)[]: Gets or sets Security rules of network security group -* **subnets**: [Subnet](#subnet)[]: Gets collection of references to subnets - -## SecurityRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny' -* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. - -## NetworkInterface -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): Dns Settings of a network interface -* **enableIPForwarding**: bool: Gets or sets whether IPForwarding is enabled on the NIC -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets or sets list of IPConfigurations of the NetworkInterface -* **macAddress**: string: Gets the MAC Address of the network interface -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource -* **primary**: bool: Gets whether this is a primary NIC on a virtual machine -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource GUID property of the network interface resource -* **virtualMachine**: [SubResource](#subresource) - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: string[]: Gets or sets list of Applied DNS servers IP addresses -* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses -* **internalDnsNameLabel**: string: Gets or sets the Internal DNS name -* **internalDomainNameSuffix**: string: Gets or sets internal domain name suffix of the NIC. -* **internalFqdn**: string: Gets or sets the internal FQDN. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed -* **routes**: [Route](#route)[]: Gets or sets Routes in a Route Table -* **subnets**: [Subnet](#subnet)[]: Gets collection of references to subnets - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: Gets or sets the destination CIDR to which the route applies. -* **nextHopIpAddress**: 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. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets or sets the type of Azure hop the packet should be sent to. -* **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string: Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed ## ApplicationGatewayBackendHttpSettings ### Properties @@ -493,6 +248,23 @@ * **port**: int: Gets or sets the frontend port * **provisioningState**: string: Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed +## ApplicationGatewayHttpListener +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of Http listener of application gateway + +## ApplicationGatewayHttpListenerPropertiesFormat +### Properties +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: [SubResource](#subresource) +* **hostName**: string: Gets or sets the host name of http listener +* **protocol**: 'Http' | 'Https' | string: Gets or sets the protocol +* **provisioningState**: string: Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed +* **requireServerNameIndication**: bool: Gets or sets the requireServerNameIndication of http listener +* **sslCertificate**: [SubResource](#subresource) + ## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -505,22 +277,19 @@ * **provisioningState**: string: Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed * **subnet**: [SubResource](#subresource) -## ApplicationGatewayHttpListener +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of Http listener of application gateway +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of application gateway -## ApplicationGatewayHttpListenerPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: [SubResource](#subresource) -* **hostName**: string: Gets or sets the host name of http listener -* **protocol**: 'Http' | 'Https' | string: Gets or sets the protocol -* **provisioningState**: string: Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed -* **requireServerNameIndication**: bool: Gets or sets the requireServerNameIndication of http listener -* **sslCertificate**: [SubResource](#subresource) +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **paths**: string[]: Gets or sets the path rules of URL path map +* **provisioningState**: string: Gets or sets path rule of URL path map resource Updating/Deleting/Failed ## ApplicationGatewayProbe ### Properties @@ -539,6 +308,23 @@ * **timeout**: int: Gets or sets probing timeout in seconds * **unhealthyThreshold**: int: Gets or sets probing unhealthy threshold +## ApplicationGatewayPropertiesFormat +### Properties +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets backend address pool of application gateway resource +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Gets or sets backend http settings of application gateway resource +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Gets or sets frontend IP addresses of application gateway resource +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Gets or sets frontend ports of application gateway resource +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Gets or sets subnets of application gateway resource +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Gets or sets HTTP listeners of application gateway resource +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Gets operational state of application gateway resource +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Gets or sets probes of application gateway resource +* **provisioningState**: string: Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Gets or sets request routing rules of application gateway resource +* **resourceGuid**: string: Gets or sets resource GUID property of the ApplicationGateway resource +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: Gets or sets ssl certificates of application gateway resource +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: Gets or sets URL path map of application gateway resource + ## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -557,202 +343,67 @@ ## ApplicationGatewaySku ### Properties -* **capacity**: int: Gets or sets capacity (instance count) of application gateway -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | string: Gets or sets name of application gateway SKU -* **tier**: 'Standard' | string: Gets or sets tier of application gateway - -## ApplicationGatewaySslCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of application gateway - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Gets or sets the certificate data -* **password**: string: Gets or sets the certificate password -* **provisioningState**: string: Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed -* **publicCertData**: string: Gets or sets the certificate public data - -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of probe of application gateway - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource) -* **defaultBackendHttpSettings**: [SubResource](#subresource) -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Gets or sets path rule of URL path map resource -* **provisioningState**: string: Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed - -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of application gateway - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **paths**: string[]: Gets or sets the path rules of URL path map -* **provisioningState**: string: Gets or sets path rule of URL path map resource Updating/Deleting/Failed - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet -* **egressBytesTransferred**: int: The Egress Bytes Transferred in this connection -* **enableBgp**: bool: EnableBgp Flag -* **ingressBytesTransferred**: int: The Ingress Bytes Transferred in this connection -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource GUID property of the VirtualNetworkGatewayConnection resource -* **routingWeight**: int: The Routing weight. -* **sharedKey**: string: The IPsec share key. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## LocalNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets -* **provisioningState**: string: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource GUID property of the LocalNetworkGateway resource - -## BgpSettings -### Properties -* **asn**: int: Gets or sets this BGP speaker's ASN -* **bgpPeeringAddress**: string: Gets or sets the BGP peering address and BGP identifier of this BGP speaker -* **peerWeight**: int: Gets or sets the weight added to routes learned from this BGP speaker - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: Gets or sets List of address blocks reserved for this virtual network in CIDR notation - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## VirtualNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **enableBgp**: bool: EnableBgp Flag -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IpConfigurations for Virtual network gateway. -* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource GUID property of the VirtualNetworkGateway resource -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. - -## VirtualNetworkGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku name -Basic/HighPerformance/Standard -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku tier -Basic/HighPerformance/Standard - -## VpnClientConfiguration -### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for Virtual network gateway. +* **capacity**: int: Gets or sets capacity (instance count) of application gateway +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | string: Gets or sets name of application gateway SKU +* **tier**: 'Standard' | string: Gets or sets tier of application gateway -## VpnClientRevokedCertificate +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of application gateway -## VpnClientRevokedCertificatePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **provisioningState**: string: Gets or sets Provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed -* **thumbprint**: string: Gets or sets the revoked Vpn client certificate thumbprint +* **data**: string: Gets or sets the certificate data +* **password**: string: Gets or sets the certificate password +* **provisioningState**: string: Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed +* **publicCertData**: string: Gets or sets the certificate public data -## VpnClientRootCertificate +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat): Properties of SSL certificates of application gateway +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of probe of application gateway -## VpnClientRootCertificatePropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **provisioningState**: string: Gets or sets Provisioning state of the VPN client root certificate resource Updating/Deleting/Failed -* **publicCertData**: string: Gets or sets the certificate public data +* **defaultBackendAddressPool**: [SubResource](#subresource) +* **defaultBackendHttpSettings**: [SubResource](#subresource) +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Gets or sets path rule of URL path map resource +* **provisioningState**: string: Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: Gets or sets the authorization key +* **authorizationUseStatus**: 'Available' | 'InUse' | string: Gets or sets AuthorizationUseStatus +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -## ResourceTags +## BackendAddressPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of BackendAddressPool -## ExpressRouteCircuitPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **allowClassicOperations**: bool: allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: Gets or sets list of authorizations -* **circuitProvisioningState**: string: Gets or sets CircuitProvisioningState state of the resource -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: Gets or sets list of peerings -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **serviceKey**: string: Gets or sets ServiceKey -* **serviceProviderNotes**: string: Gets or sets ServiceProviderNotes -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: Gets or sets ServiceProviderProvisioningState state of the resource +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets collection of references to IPs defined in NICs +* **loadBalancingRules**: [SubResource](#subresource)[]: Gets Load Balancing rules that use this Backend Address Pool +* **outboundNatRule**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the PublicIP resource Updating/Deleting/Failed + +## BgpSettings +### Properties +* **asn**: int: Gets or sets this BGP speaker's ASN +* **bgpPeeringAddress**: string: Gets or sets the BGP peering address and BGP identifier of this BGP speaker +* **peerWeight**: int: Gets or sets the weight added to routes learned from this BGP speaker + +## DhcpOptions +### Properties +* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses ## ExpressRouteCircuitAuthorization ### Properties @@ -761,12 +412,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: Gets or sets the authorization key -* **authorizationUseStatus**: 'Available' | 'InUse' | string: Gets or sets AuthorizationUseStatus -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed - ## ExpressRouteCircuitPeering ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -774,6 +419,13 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedPublicPrefixes**: string[]: Gets or sets the reference of AdvertisedPublicPrefixes +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: Gets or sets AdvertisedPublicPrefixState of the Peering resource +* **customerASN**: int: Gets or Sets CustomerAsn of the peering. +* **routingRegistryName**: string: Gets or Sets RoutingRegistryName of the config. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: Gets or sets the azure ASN @@ -790,19 +442,17 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains Stats associated with the peering * **vlanId**: int: Gets or sets the vlan id -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedPublicPrefixes**: string[]: Gets or sets the reference of AdvertisedPublicPrefixes -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: Gets or sets AdvertisedPublicPrefixState of the Peering resource -* **customerASN**: int: Gets or Sets CustomerAsn of the peering. -* **routingRegistryName**: string: Gets or Sets RoutingRegistryName of the config. - -## ExpressRouteCircuitStats +## ExpressRouteCircuitPropertiesFormat ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +* **allowClassicOperations**: bool: allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: Gets or sets list of authorizations +* **circuitProvisioningState**: string: Gets or sets CircuitProvisioningState state of the resource +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: Gets or sets list of peerings +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **serviceKey**: string: Gets or sets ServiceKey +* **serviceProviderNotes**: string: Gets or sets ServiceProviderNotes +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: Gets or sets ServiceProviderProvisioningState state of the resource ## ExpressRouteCircuitServiceProviderProperties ### Properties @@ -816,22 +466,12 @@ * **name**: string: Gets or sets name of the sku. * **tier**: 'Premium' | 'Standard' | string: Gets or sets tier of the sku. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets Pools of backend IP addresses -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Gets or sets frontend IP addresses of the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: Gets or sets inbound NAT pools -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of inbound rules -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Gets or sets load balancing rules -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: Gets or sets outbound NAT rules -* **probes**: [Probe](#probe)[]: Gets or sets list of Load balancer probes -* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource GUID property of the Load balancer resource +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. ## FrontendIPConfiguration ### Properties @@ -868,6 +508,51 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of Inbound NAT rule + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a NetworkInterface +* **backendPort**: int: 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 +* **enableFloatingIP**: bool: 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 +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int: 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 +* **idleTimeoutInMinutes**: int: 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 +* **protocol**: 'Tcp' | 'Udp' | string: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IPConfiguration + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource +* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets Pools of backend IP addresses +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Gets or sets frontend IP addresses of the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: Gets or sets inbound NAT pools +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of inbound rules +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Gets or sets load balancing rules +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: Gets or sets outbound NAT rules +* **probes**: [Probe](#probe)[]: Gets or sets list of Load balancer probes +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource GUID property of the Load balancer resource + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -875,18 +560,105 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource * **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer -## LoadBalancingRulePropertiesFormat +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource) +* **backendPort**: int: 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 +* **enableFloatingIP**: bool: 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 +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int (Required): 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 +* **idleTimeoutInMinutes**: int: 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 +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: Gets or sets the load distribution policy for this rule +* **probe**: [SubResource](#subresource) +* **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed + +## LocalNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets +* **provisioningState**: string: Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource GUID property of the LocalNetworkGateway resource + +## NetworkInterface +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: string[]: Gets or sets list of Applied DNS servers IP addresses +* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses +* **internalDnsNameLabel**: string: Gets or sets the Internal DNS name +* **internalDomainNameSuffix**: string: Gets or sets internal domain name suffix of the NIC. +* **internalFqdn**: string: Gets or sets the internal FQDN. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IPConfiguration + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets the reference of ApplicationGatewayBackendAddressPool resource +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets the reference of LoadBalancerBackendAddressPool resource +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of references of LoadBalancerInboundNatRules +* **primary**: bool: Gets whether this is a primary customer address on the NIC +* **privateIPAddress**: string +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource +* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): Dns Settings of a network interface +* **enableIPForwarding**: bool: Gets or sets whether IPForwarding is enabled on the NIC +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets or sets list of IPConfigurations of the NetworkInterface +* **macAddress**: string: Gets the MAC Address of the network interface +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource +* **primary**: bool: Gets whether this is a primary NIC on a virtual machine +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource GUID property of the network interface resource +* **virtualMachine**: [SubResource](#subresource) + +## NetworkSecurityGroup +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## NetworkSecurityGroupPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendPort**: int: 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 -* **enableFloatingIP**: bool: 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 -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int (Required): 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 -* **idleTimeoutInMinutes**: int: 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 -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: Gets or sets the load distribution policy for this rule -* **probe**: [SubResource](#subresource) -* **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: Gets or sets Default security rules of network security group +* **networkInterfaces**: [NetworkInterface](#networkinterface)[]: Gets collection of references to Network Interfaces * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource GUID property of the network security group resource +* **securityRules**: [SecurityRule](#securityrule)[]: Gets or sets Security rules of network security group +* **subnets**: [Subnet](#subnet)[]: Gets collection of references to subnets ## OutboundNatRule ### Properties @@ -919,6 +691,68 @@ * **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed * **requestPath**: 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 +## PublicIPAddress +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): PublicIpAddress properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: Gets or sets the idle timeout of the public IP address +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration): IPConfiguration +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) +* **resourceGuid**: string: Gets or sets resource GUID property of the PublicIP resource + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties @@ -954,6 +788,151 @@ ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: Gets or sets the destination CIDR to which the route applies. +* **nextHopIpAddress**: 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. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets or sets the type of Azure hop the packet should be sent to. +* **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## RouteTablePropertiesFormat +### Properties +* **provisioningState**: string: Gets or sets Provisioning state of the resource Updating/Deleting/Failed +* **routes**: [Route](#route)[]: Gets or sets Routes in a Route Table +* **subnets**: [Subnet](#subnet)[]: Gets collection of references to subnets + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny' +* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: Gets or sets Address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[]: Gets array of references to the network interface IP configurations using subnet +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **routeTable**: [RouteTable](#routetable): RouteTable resource + +## SubResource +### Properties +* **id**: string: Resource Id + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet +* **egressBytesTransferred**: int: The Egress Bytes Transferred in this connection +* **enableBgp**: bool: EnableBgp Flag +* **ingressBytesTransferred**: int: The Ingress Bytes Transferred in this connection +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource GUID property of the VirtualNetworkGatewayConnection resource +* **routingWeight**: int: The Routing weight. +* **sharedKey**: string: The IPsec share key. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: Gets or sets PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **enableBgp**: bool: EnableBgp Flag +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IpConfigurations for Virtual network gateway. +* **provisioningState**: string: Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource GUID property of the VirtualNetworkGateway resource +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku name -Basic/HighPerformance/Standard +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | string: Gateway sku tier -Basic/HighPerformance/Standard + ## VirtualNetworkPropertiesFormat ### Properties * **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets @@ -962,12 +941,33 @@ * **resourceGuid**: string: Gets or sets resource GUID property of the VirtualNetwork resource * **subnets**: [Subnet](#subnet)[]: Gets or sets List of subnets in a VirtualNetwork -## DhcpOptions +## VpnClientConfiguration ### Properties -* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for Virtual network gateway. -## ResourceTags +## VpnClientRevokedCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string: Gets or sets Provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed +* **thumbprint**: string: Gets or sets the revoked Vpn client certificate thumbprint + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string: Gets or sets Provisioning state of the VPN client root certificate resource Updating/Deleting/Failed +* **publicCertData**: string: Gets or sets the certificate public data diff --git a/generated/network/microsoft.network/2016-06-01/types.md b/generated/network/microsoft.network/2016-06-01/types.md index d155f060ac..00debaf08a 100644 --- a/generated/network/microsoft.network/2016-06-01/types.md +++ b/generated/network/microsoft.network/2016-06-01/types.md @@ -193,24 +193,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of application gateway resource -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of application gateway resource -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of application gateway resource -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of application gateway resource -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of application gateway resource -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application gateway resource -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: HTTP listeners of application gateway resource -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of application gateway resource -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of application gateway resource -* **provisioningState**: string: Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of application gateway resource -* **resourceGuid**: string: Resource guid property of the ApplicationGateway resource -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of application gateway resource -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of application gateway resource +* **addressPrefixes**: string[]: Gets or sets list of address blocks reserved for this virtual network in CIDR notation ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -224,6 +209,11 @@ * **data**: string: Certificate public data * **provisioningState**: string: Provisioning state of the authentication certificate resource Updating/Deleting/Failed +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Dns name +* **ipAddress**: string: Ip address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated @@ -237,436 +227,383 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in NICs * **provisioningState**: string: Provisioning state of the backend address pool resource Updating/Deleting/Failed -## ApplicationGatewayBackendAddress +## ApplicationGatewayBackendHttpSettings ### Properties -* **fqdn**: string: Dns name -* **ipAddress**: string: Ip address +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of application gateway -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettingsPropertiesFormat +### Properties +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to Application Gateway Authentication Certificates +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie affinity +* **port**: int: Port +* **probe**: [SubResource](#subresource) +* **protocol**: 'Http' | 'Https' | string: Protocol +* **provisioningState**: string: Provisioning state of the backend http settings resource Updating/Deleting/Failed +* **requestTimeout**: int: Request timeout + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IPConfiguration +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of application gateway -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets the reference of ApplicationGatewayBackendAddressPool resource -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets the reference of LoadBalancerBackendAddressPool resource -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of references of LoadBalancerInboundNatRules -* **primary**: bool: Gets whether this is a primary customer address on the NIC -* **privateIPAddress**: string -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) +* **privateIPAddress**: string: PrivateIPAddress of the Network Interface IP Configuration * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource -* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource +* **provisioningState**: string: Provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## BackendAddressPool +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of BackendAddressPool +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend Port of application gateway -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IPs defined in NICs -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets Load Balancing rules that use this Backend Address Pool -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) -* **provisioningState**: string: Get provisioning state of the PublicIP resource Updating/Deleting/Failed +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource Updating/Deleting/Failed -## SubResource +## ApplicationGatewayHttpListener ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of Http listener of application gateway -## InboundNatRule +## ApplicationGatewayHttpListenerPropertiesFormat +### Properties +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: [SubResource](#subresource) +* **hostName**: string: Host name of http listener +* **protocol**: 'Http' | 'Https' | string: Protocol +* **provisioningState**: string: Provisioning state of the http listener resource Updating/Deleting/Failed +* **requireServerNameIndication**: bool: RequireServerNameIndication of http listener +* **sslCertificate**: [SubResource](#subresource) + +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of Inbound NAT rule +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of application gateway -## InboundNatRulePropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a NetworkInterface -* **backendPort**: int: 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 -* **enableFloatingIP**: bool: 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 -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int: 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 -* **idleTimeoutInMinutes**: int: 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 -* **protocol**: 'Tcp' | 'Udp' | string: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **provisioningState**: string: Provisioning state of the application gateway subnet resource Updating/Deleting/Failed +* **subnet**: [SubResource](#subresource) -## PublicIPAddress +## ApplicationGatewayPathRule ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): PublicIpAddress properties -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of application gateway -## PublicIPAddressPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: Gets or sets the idle timeout of the public IP address -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) -* **resourceGuid**: string: Gets or sets resource guid property of the PublicIP resource +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **paths**: string[]: Path rules of URL path map +* **provisioningState**: string: Path rule of URL path map resource Updating/Deleting/Failed -## PublicIPAddressDnsSettings +## ApplicationGatewayProbe ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of application gateway -## IPConfiguration +## ApplicationGatewayProbePropertiesFormat +### Properties +* **host**: string: Host to send probe to +* **interval**: int: Probing interval in seconds +* **path**: string: Relative path of probe +* **protocol**: 'Http' | 'Https' | string: Protocol +* **provisioningState**: string: Provisioning state of the backend http settings resource Updating/Deleting/Failed +* **timeout**: int: Probing timeout in seconds +* **unhealthyThreshold**: int: Probing unhealthy threshold + +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of application gateway resource +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of application gateway resource +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of application gateway resource +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of application gateway resource +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of application gateway resource +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application gateway resource +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: HTTP listeners of application gateway resource +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of application gateway resource +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of application gateway resource +* **provisioningState**: string: Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of application gateway resource +* **resourceGuid**: string: Resource guid property of the ApplicationGateway resource +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of application gateway resource +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of application gateway resource + +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IPConfiguration +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of Request routing rule of application gateway -## IPConfigurationPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource -* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **httpListener**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the request routing rule resource Updating/Deleting/Failed +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type +* **urlPathMap**: [SubResource](#subresource) -## Subnet +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of application gateway +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | string: Name of application gateway SKU +* **tier**: 'Standard' | string: Tier of application gateway + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of application gateway -## SubnetPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **addressPrefix**: string: Gets or sets Address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets array of references to the network interface IP configurations using subnet -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource -* **provisioningState**: string: Gets provisioning state of the resource -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets array of references to the external resources using subnet -* **routeTable**: [RouteTable](#routetable): RouteTable resource +* **data**: string: SSL Certificate data +* **password**: string: SSL Certificate password +* **provisioningState**: string: Provisioning state of the ssl certificate resource Updating/Deleting/Failed +* **publicCertData**: string: SSL Certificate public data -## NetworkSecurityGroup +## ApplicationGatewaySslPolicy ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on Application Gateway + +## ApplicationGatewayUrlPathMap +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of application gateway -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: Gets or default security rules of network security group -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets collection of references to Network Interfaces +* **defaultBackendAddressPool**: [SubResource](#subresource) +* **defaultBackendHttpSettings**: [SubResource](#subresource) +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource +* **provisioningState**: string: Provisioning state of the backend http settings resource Updating/Deleting/Failed + +## AuthorizationPropertiesFormat +### Properties +* **authorizationKey**: string: Gets or sets the authorization key +* **authorizationUseStatus**: 'Available' | 'InUse' | string: Gets or sets AuthorizationUseStatus * **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the network security group resource -* **securityRules**: [SecurityRule](#securityrule)[]: Gets or sets security rules of network security group -* **subnets**: [Subnet](#subnet)[] (ReadOnly): Gets collection of references to subnets -## SecurityRule +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of BackendAddressPool -## SecurityRulePropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny' -* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. - -## NetworkInterface -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IPs defined in NICs +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets Load Balancing rules that use this Backend Address Pool +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) +* **provisioningState**: string: Get provisioning state of the PublicIP resource Updating/Deleting/Failed -## NetworkInterfacePropertiesFormat +## BgpSettings ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): Dns settings of a network interface -* **enableIPForwarding**: bool: Gets or sets whether IPForwarding is enabled on the NIC -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets or sets list of IPConfigurations of the network interface -* **macAddress**: string: Gets the MAC address of the network interface -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource -* **primary**: bool: Gets whether this is a primary NIC on a virtual machine -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the network interface resource -* **virtualMachine**: [SubResource](#subresource) +* **asn**: int: Gets or sets this BGP speaker's ASN +* **bgpPeeringAddress**: string: Gets or sets the BGP peering address and BGP identifier of this BGP speaker +* **peerWeight**: int: Gets or sets the weight added to routes learned from this BGP speaker -## NetworkInterfaceDnsSettings +## DhcpOptions ### Properties -* **appliedDnsServers**: string[]: Gets or sets list of Applied DNS servers IP addresses * **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses -* **internalDnsNameLabel**: string: Gets or sets the internal DNS name -* **internalDomainNameSuffix**: string: Gets or sets internal domain name suffix of the NIC. -* **internalFqdn**: string: Gets or sets the internal fqdn. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **location**: string: Resource location -* **name**: string (ReadOnly): Resource name -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string (ReadOnly): Resource type - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: Gets provisioning state of the resource Updating/Deleting/Failed -* **routes**: [Route](#route)[]: Gets or sets Routes in a Route Table -* **subnets**: [Subnet](#subnet)[] (ReadOnly): Gets collection of references to subnets - -## Route +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: Gets or sets the destination CIDR to which the route applies. -* **nextHopIpAddress**: 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. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets or sets the type of Azure hop the packet should be sent to. -* **provisioningState**: string: Gets provisioning state of the resource Updating/Deleting/Failed - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## ApplicationGatewayBackendHttpSettings +## ExpressRouteCircuitPeering ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of application gateway - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to Application Gateway Authentication Certificates -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie affinity -* **port**: int: Port -* **probe**: [SubResource](#subresource) -* **protocol**: 'Http' | 'Https' | string: Protocol -* **provisioningState**: string: Provisioning state of the backend http settings resource Updating/Deleting/Failed -* **requestTimeout**: int: Request timeout +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ApplicationGatewayFrontendIPConfiguration +## ExpressRouteCircuitPeeringConfig ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of application gateway +* **advertisedPublicPrefixes**: string[]: Gets or sets the reference of AdvertisedPublicPrefixes +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: Gets or sets AdvertisedPublicPrefixState of the Peering resource +* **customerASN**: int: Gets or Sets CustomerAsn of the peering. +* **routingRegistryName**: string: Gets or Sets RoutingRegistryName of the config. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the Network Interface IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string: Provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) +* **azureASN**: int: Gets or sets the azure ASN +* **gatewayManagerEtag**: string: Gets or sets the GatewayManager Etag +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering config +* **peerASN**: int: Gets or sets the peer ASN +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: Gets or sets PeeringType +* **primaryAzurePort**: string: Gets or sets the primary port +* **primaryPeerAddressPrefix**: string: Gets or sets the primary address prefix +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **secondaryAzurePort**: string: Gets or sets the secondary port +* **secondaryPeerAddressPrefix**: string: Gets or sets the secondary address prefix +* **sharedKey**: string: Gets or sets the shared key +* **state**: 'Disabled' | 'Enabled' | string: Gets or sets state of Peering +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains Stats associated with the peering +* **vlanId**: int: Gets or sets the vlan id -## ApplicationGatewayFrontendPort +## ExpressRouteCircuitPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend Port of application gateway +* **allowClassicOperations**: bool: allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: Gets or sets list of authorizations +* **circuitProvisioningState**: string: Gets or sets CircuitProvisioningState state of the resource +* **gatewayManagerEtag**: string: Gets or sets the GatewayManager Etag +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: Gets or sets list of peerings +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **serviceKey**: string: Gets or sets ServiceKey +* **serviceProviderNotes**: string: Gets or sets ServiceProviderNotes +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: Gets or sets ServiceProviderProvisioningState state of the resource -## ApplicationGatewayFrontendPortPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource Updating/Deleting/Failed +* **bandwidthInMbps**: int: Gets or sets BandwidthInMbps. +* **peeringLocation**: string: Gets or sets peering location. +* **serviceProviderName**: string: Gets or sets serviceProviderName. -## ApplicationGatewayIPConfiguration +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of application gateway +* **family**: 'MeteredData' | 'UnlimitedData' | string: Gets or sets family of the sku. +* **name**: string: Gets or sets name of the sku. +* **tier**: 'Premium' | 'Standard' | string: Gets or sets tier of the sku. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource Updating/Deleting/Failed -* **subnet**: [SubResource](#subresource) +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayHttpListener +## FrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of Http listener of application gateway +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer -## ApplicationGatewayHttpListenerPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: [SubResource](#subresource) -* **hostName**: string: Host name of http listener -* **protocol**: 'Http' | 'Https' | string: Protocol -* **provisioningState**: string: Provisioning state of the http listener resource Updating/Deleting/Failed -* **requireServerNameIndication**: bool: RequireServerNameIndication of http listener -* **sslCertificate**: [SubResource](#subresource) +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets Load Balancing rules URIs that use this frontend IP +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP +* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource +* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource -## ApplicationGatewayProbe +## InboundNatPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of application gateway +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool -## ApplicationGatewayProbePropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **host**: string: Host to send probe to -* **interval**: int: Probing interval in seconds -* **path**: string: Relative path of probe -* **protocol**: 'Http' | 'Https' | string: Protocol -* **provisioningState**: string: Provisioning state of the backend http settings resource Updating/Deleting/Failed -* **timeout**: int: Probing timeout in seconds -* **unhealthyThreshold**: int: Probing unhealthy threshold +* **backendPort**: int (Required): 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 +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPortRangeEnd**: int (Required): 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 +* **frontendPortRangeStart**: int (Required): 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 +* **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -## ApplicationGatewayRequestRoutingRule +## InboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of Request routing rule of application gateway - -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **httpListener**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the request routing rule resource Updating/Deleting/Failed -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type -* **urlPathMap**: [SubResource](#subresource) +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of Inbound NAT rule -## ApplicationGatewaySku +## InboundNatRulePropertiesFormat ### Properties -* **capacity**: int: Capacity (instance count) of application gateway -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | string: Name of application gateway SKU -* **tier**: 'Standard' | string: Tier of application gateway +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a NetworkInterface +* **backendPort**: int: 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 +* **enableFloatingIP**: bool: 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 +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int: 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 +* **idleTimeoutInMinutes**: int: 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 +* **protocol**: 'Tcp' | 'Udp' | string: Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -## ApplicationGatewaySslCertificate +## IPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of application gateway - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: SSL Certificate data -* **password**: string: SSL Certificate password -* **provisioningState**: string: Provisioning state of the ssl certificate resource Updating/Deleting/Failed -* **publicCertData**: string: SSL Certificate public data - -## ApplicationGatewaySslPolicy -### Properties -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on Application Gateway +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IPConfiguration -## ApplicationGatewayUrlPathMap +## IPConfigurationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of application gateway +* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource +* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource -## ApplicationGatewayUrlPathMapPropertiesFormat +## LoadBalancerPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource) -* **defaultBackendHttpSettings**: [SubResource](#subresource) -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource -* **provisioningState**: string: Provisioning state of the backend http settings resource Updating/Deleting/Failed +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets Pools of backend IP addresses +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Gets or sets frontend IP addresses of the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: Gets or sets inbound NAT pools +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of inbound rules +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Gets or sets load balancing rules +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: Gets or sets outbound NAT rules +* **probes**: [Probe](#probe)[]: Gets or sets list of Load balancer probes +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the Load balancer resource -## ApplicationGatewayPathRule +## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of application gateway - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **paths**: string[]: Path rules of URL path map -* **provisioningState**: string: Path rule of URL path map resource Updating/Deleting/Failed - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer -## VirtualNetworkGatewayConnectionPropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet -* **egressBytesTransferred**: int: The Egress Bytes Transferred in this connection -* **enableBgp**: bool: EnableBgp Flag -* **ingressBytesTransferred**: int: The Ingress Bytes Transferred in this connection -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string: Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource -* **routingWeight**: int: The Routing weight. -* **sharedKey**: string: The IPsec share key. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **backendAddressPool**: [SubResource](#subresource) +* **backendPort**: int: 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 +* **enableFloatingIP**: bool: 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 +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int (Required): 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 +* **idleTimeoutInMinutes**: int: 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 +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: Gets or sets the load distribution policy for this rule +* **probe**: [SubResource](#subresource) +* **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed ## LocalNetworkGateway ### Properties @@ -686,94 +623,145 @@ * **provisioningState**: string: Gets provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed * **resourceGuid**: string: Gets or sets resource guid property of the LocalNetworkGateway resource -## BgpSettings +## NetworkInterface ### Properties -* **asn**: int: Gets or sets this BGP speaker's ASN -* **bgpPeeringAddress**: string: Gets or sets the BGP peering address and BGP identifier of this BGP speaker -* **peerWeight**: int: Gets or sets the weight added to routes learned from this BGP speaker +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type -## AddressSpace +## NetworkInterfaceDnsSettings ### Properties -* **addressPrefixes**: string[]: Gets or sets list of address blocks reserved for this virtual network in CIDR notation +* **appliedDnsServers**: string[]: Gets or sets list of Applied DNS servers IP addresses +* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses +* **internalDnsNameLabel**: string: Gets or sets the internal DNS name +* **internalDomainNameSuffix**: string: Gets or sets internal domain name suffix of the NIC. +* **internalFqdn**: string: Gets or sets the internal fqdn. -## ResourceTags +## NetworkInterfaceIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IPConfiguration -## VirtualNetworkGateway +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Gets or sets the reference of ApplicationGatewayBackendAddressPool resource +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets the reference of LoadBalancerBackendAddressPool resource +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of references of LoadBalancerInboundNatRules +* **primary**: bool: Gets whether this is a primary customer address on the NIC +* **privateIPAddress**: string +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource +* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): Dns settings of a network interface +* **enableIPForwarding**: bool: Gets or sets whether IPForwarding is enabled on the NIC +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Gets or sets list of IPConfigurations of the network interface +* **macAddress**: string: Gets the MAC address of the network interface +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource +* **primary**: bool: Gets whether this is a primary NIC on a virtual machine +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the network interface resource +* **virtualMachine**: [SubResource](#subresource) + +## NetworkSecurityGroup ### Properties * **etag**: string: Gets a unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **location**: string: Resource location * **name**: string (ReadOnly): Resource name -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string (ReadOnly): Resource type -## VirtualNetworkGatewayPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **enableBgp**: bool: EnableBgp Flag -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IpConfigurations for Virtual network gateway. -* **provisioningState**: string: Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGateway resource -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: Gets or default security rules of network security group +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets collection of references to Network Interfaces +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the network security group resource +* **securityRules**: [SecurityRule](#securityrule)[]: Gets or sets security rules of network security group +* **subnets**: [Subnet](#subnet)[] (ReadOnly): Gets collection of references to subnets -## VirtualNetworkGatewayIPConfiguration +## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## OutboundNatRulePropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) +* **allocatedOutboundPorts**: int: Gets or sets the number of outbound ports to be used for SNAT +* **backendAddressPool**: [SubResource](#subresource) (Required) +* **frontendIPConfigurations**: [SubResource](#subresource)[]: Gets or sets Frontend IP addresses of the load balancer * **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) -## VirtualNetworkGatewaySku +## Probe ### Properties -* **capacity**: int: The capacity -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ProbePropertiesFormat](#probepropertiesformat) -## VpnClientConfiguration +## ProbePropertiesFormat ### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for Virtual network gateway. +* **intervalInSeconds**: int: 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 +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets Load balancer rules that use this probe +* **numberOfProbes**: int: 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. +* **port**: int (Required): Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Tcp' | string (Required): Gets or sets 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 +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **requestPath**: 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 -## VpnClientRevokedCertificate +## PublicIPAddress ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): PublicIpAddress properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type -## VpnClientRevokedCertificatePropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **provisioningState**: string: Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed -* **thumbprint**: string: Gets or sets the revoked Vpn client certificate thumbprint +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## VpnClientRootCertificate +## PublicIPAddressPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: Gets or sets the idle timeout of the public IP address +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: Gets or sets PrivateIP address version (IPv4/IPv6) +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) +* **resourceGuid**: string: Gets or sets resource guid property of the PublicIP resource + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat): Properties of SSL certificates of application gateway +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink -## VpnClientRootCertificatePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **provisioningState**: string: Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed -* **publicCertData**: string: Gets or sets the certificate public data +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource ## ResourceTags ### Properties @@ -785,220 +773,228 @@ ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitPropertiesFormat +## ResourceTags ### Properties -* **allowClassicOperations**: bool: allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: Gets or sets list of authorizations -* **circuitProvisioningState**: string: Gets or sets CircuitProvisioningState state of the resource -* **gatewayManagerEtag**: string: Gets or sets the GatewayManager Etag -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: Gets or sets list of peerings -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **serviceKey**: string: Gets or sets ServiceKey -* **serviceProviderNotes**: string: Gets or sets ServiceProviderNotes -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: Gets or sets ServiceProviderProvisioningState state of the resource +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitAuthorization +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +### Additional Properties +* **Additional Properties Type**: string -## AuthorizationPropertiesFormat +## ResourceTags ### Properties -* **authorizationKey**: string: Gets or sets the authorization key -* **authorizationUseStatus**: 'Available' | 'InUse' | string: Gets or sets AuthorizationUseStatus -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeering +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated -* **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringPropertiesFormat +## ResourceTags ### Properties -* **azureASN**: int: Gets or sets the azure ASN -* **gatewayManagerEtag**: string: Gets or sets the GatewayManager Etag -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering config -* **peerASN**: int: Gets or sets the peer ASN -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: Gets or sets PeeringType -* **primaryAzurePort**: string: Gets or sets the primary port -* **primaryPeerAddressPrefix**: string: Gets or sets the primary address prefix -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **secondaryAzurePort**: string: Gets or sets the secondary port -* **secondaryPeerAddressPrefix**: string: Gets or sets the secondary address prefix -* **sharedKey**: string: Gets or sets the shared key -* **state**: 'Disabled' | 'Enabled' | string: Gets or sets state of Peering -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains Stats associated with the peering -* **vlanId**: int: Gets or sets the vlan id +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringConfig +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags ### Properties -* **advertisedPublicPrefixes**: string[]: Gets or sets the reference of AdvertisedPublicPrefixes -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: Gets or sets AdvertisedPublicPrefixState of the Peering resource -* **customerASN**: int: Gets or Sets CustomerAsn of the peering. -* **routingRegistryName**: string: Gets or Sets RoutingRegistryName of the config. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitStats +## ResourceTags ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitServiceProviderProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: Gets or sets BandwidthInMbps. -* **peeringLocation**: string: Gets or sets peering location. -* **serviceProviderName**: string: Gets or sets serviceProviderName. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitSku +## ResourceTags ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: Gets or sets family of the sku. -* **name**: string: Gets or sets name of the sku. -* **tier**: 'Premium' | 'Standard' | string: Gets or sets tier of the sku. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Gets or sets Pools of backend IP addresses -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Gets or sets frontend IP addresses of the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: Gets or sets inbound NAT pools -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: Gets or sets list of inbound rules -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Gets or sets load balancing rules -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: Gets or sets outbound NAT rules -* **probes**: [Probe](#probe)[]: Gets or sets list of Load balancer probes -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **resourceGuid**: string: Gets or sets resource guid property of the Load balancer resource +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfiguration +## Route ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## FrontendIPConfigurationPropertiesFormat +## RoutePropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets Load Balancing rules URIs that use this frontend IP -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP -* **privateIPAddress**: string: Gets or sets the privateIPAddress of the IP Configuration -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): PublicIPAddress resource -* **subnet**: [Subnet](#subnet): Subnet in a VirtualNetwork resource +* **addressPrefix**: string: Gets or sets the destination CIDR to which the route applies. +* **nextHopIpAddress**: 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. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): Gets or sets the type of Azure hop the packet should be sent to. +* **provisioningState**: string: Gets provisioning state of the resource Updating/Deleting/Failed -## InboundNatPool +## RouteTable ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type -## InboundNatPoolPropertiesFormat +## RouteTablePropertiesFormat ### Properties -* **backendPort**: int (Required): 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 -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPortRangeEnd**: int (Required): 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 -* **frontendPortRangeStart**: int (Required): 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 -* **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **provisioningState**: string: Gets provisioning state of the resource Updating/Deleting/Failed +* **routes**: [Route](#route)[]: Gets or sets Routes in a Route Table +* **subnets**: [Subnet](#subnet)[] (ReadOnly): Gets collection of references to subnets -## LoadBalancingRule +## SecurityRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) -## LoadBalancingRulePropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendPort**: int: 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 -* **enableFloatingIP**: bool: 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 -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int (Required): 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 -* **idleTimeoutInMinutes**: int: 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 -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: Gets or sets the load distribution policy for this rule -* **probe**: [SubResource](#subresource) -* **protocol**: 'Tcp' | 'Udp' | string (Required): Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp +* **access**: 'Allow' | 'Deny' | string (Required): Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny' +* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). * **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -## OutboundNatRule +## Subnet ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer +* **name**: string: Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) -## OutboundNatRulePropertiesFormat +## SubnetPropertiesFormat ### Properties -* **allocatedOutboundPorts**: int: Gets or sets the number of outbound ports to be used for SNAT -* **backendAddressPool**: [SubResource](#subresource) (Required) -* **frontendIPConfigurations**: [SubResource](#subresource)[]: Gets or sets Frontend IP addresses of the load balancer -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **addressPrefix**: string: Gets or sets Address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets array of references to the network interface IP configurations using subnet +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource +* **provisioningState**: string: Gets provisioning state of the resource +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets array of references to the external resources using subnet +* **routeTable**: [RouteTable](#routetable): RouteTable resource -## Probe +## SubResource ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [ProbePropertiesFormat](#probepropertiesformat) -## ProbePropertiesFormat +## VirtualNetworkGateway ### Properties -* **intervalInSeconds**: int: 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 -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets Load balancer rules that use this probe -* **numberOfProbes**: int: 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. -* **port**: int (Required): Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Tcp' | string (Required): Gets or sets 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 -* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed -* **requestPath**: 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 +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **location**: string: Resource location +* **name**: string (ReadOnly): Resource name +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string (ReadOnly): Resource type -## ResourceTags +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string: Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string: Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet +* **egressBytesTransferred**: int: The Egress Bytes Transferred in this connection +* **enableBgp**: bool: EnableBgp Flag +* **ingressBytesTransferred**: int: The Ingress Bytes Transferred in this connection +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string: Gets provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource +* **routingWeight**: int: The Routing weight. +* **sharedKey**: string: The IPsec share key. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method (Static/Dynamic) +* **provisioningState**: string: Gets provisioning state of the PublicIP resource Updating/Deleting/Failed +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## ResourceTags +## VirtualNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **enableBgp**: bool: EnableBgp Flag +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IpConfigurations for Virtual network gateway. +* **provisioningState**: string: Gets provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed +* **resourceGuid**: string: Gets or sets resource guid property of the VirtualNetworkGateway resource +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: The capacity +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway sku name -Basic/HighPerformance/Standard/UltraPerformance +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway sku tier -Basic/HighPerformance/Standard/UltraPerformance -## ResourceTags +## VirtualNetworkPeering ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) -## ResourceTags +## VirtualNetworkPeeringPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowForwardedTraffic**: bool: Gets or sets whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed +* **allowGatewayTransit**: bool: Gets or sets if gatewayLinks can be used in remote virtual network’s link to this virtual network +* **allowVirtualNetworkAccess**: bool: Gets or sets whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: Gets the status of the virtual network peering +* **provisioningState**: string: Gets provisioning state of the resource +* **remoteVirtualNetwork**: [SubResource](#subresource) +* **useRemoteGateways**: bool: Gets or sets 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 1 peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. ## VirtualNetworkPropertiesFormat ### Properties @@ -1009,29 +1005,33 @@ * **subnets**: [Subnet](#subnet)[]: Gets or sets list of subnets in a VirtualNetwork * **VirtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: Gets or sets list of peerings in a VirtualNetwork -## DhcpOptions +## VpnClientConfiguration ### Properties -* **dnsServers**: string[]: Gets or sets list of DNS servers IP addresses +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for Virtual network gateway. -## VirtualNetworkPeering +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated * **id**: string: Resource Id -* **name**: string: Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway -## VirtualNetworkPeeringPropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Gets or sets whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed -* **allowGatewayTransit**: bool: Gets or sets if gatewayLinks can be used in remote virtual network’s link to this virtual network -* **allowVirtualNetworkAccess**: bool: Gets or sets whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: Gets the status of the virtual network peering -* **provisioningState**: string: Gets provisioning state of the resource -* **remoteVirtualNetwork**: [SubResource](#subresource) -* **useRemoteGateways**: bool: Gets or sets 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 1 peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. +* **provisioningState**: string: Gets provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed +* **thumbprint**: string: Gets or sets the revoked Vpn client certificate thumbprint -## ResourceTags +## VpnClientRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated +* **id**: string: Resource Id +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string: Gets provisioning state of the VPN client root certificate resource Updating/Deleting/Failed +* **publicCertData**: string: Gets or sets the certificate public data diff --git a/generated/network/microsoft.network/2016-09-01/types.md b/generated/network/microsoft.network/2016-09-01/types.md index 9ef2122867..bace5080a3 100644 --- a/generated/network/microsoft.network/2016-09-01/types.md +++ b/generated/network/microsoft.network/2016-09-01/types.md @@ -215,25 +215,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -247,6 +231,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -260,443 +249,389 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. +* **port**: int: Port +* **probe**: [SubResource](#subresource) +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource) +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource) -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource) -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -## SubnetPropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroup +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **httpListener**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. +* **urlPathMap**: [SubResource](#subresource) -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. +* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## NetworkInterface +## ApplicationGatewaySslPolicy +### Properties +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource) - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **defaultBackendAddressPool**: [SubResource](#subresource) +* **defaultBackendHttpSettings**: [SubResource](#subresource) +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool (Required): Whether the web application firewall is enabled. +* **firewallMode**: 'Detection' | 'Prevention' | string: Web application firewall mode. Possible values are: 'Detection' and 'Prevention'. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceNavigationLink +## BackendAddressPool ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ResourceNavigationLinkFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## RouteTable +## BgpSettings ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## RouteTablePropertiesFormat +## DhcpOptions ### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## Route +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## RoutePropertiesFormat +## ExpressRouteCircuitPeering ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ResourceTags +## ExpressRouteCircuitPeeringConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ResourceTags +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureASN**: int: The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayBackendHttpSettings +## ExpressRouteCircuitPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. -* **port**: int: Port -* **probe**: [SubResource](#subresource) -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayFrontendIPConfiguration +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayFrontendPort +## FrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -## ApplicationGatewayFrontendPortPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ApplicationGatewayIPConfiguration +## InboundNatPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## ApplicationGatewayIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource) +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayHttpListener +## InboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## ApplicationGatewayHttpListenerPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: [SubResource](#subresource) -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource) +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayProbe +## IPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## ApplicationGatewayProbePropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ApplicationGatewayRequestRoutingRule +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties * **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **httpListener**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. -* **urlPathMap**: [SubResource](#subresource) - -## ApplicationGatewaySku -### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. -* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. - -## ApplicationGatewaySslCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'. - -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource) -* **defaultBackendHttpSettings**: [SubResource](#subresource) -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **enabled**: bool (Required): Whether the web application firewall is enabled. -* **firewallMode**: 'Detection' | 'Prevention' | string: Web application firewall mode. Possible values are: 'Detection' and 'Prevention'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource) +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## LocalNetworkGateway ### Properties @@ -716,292 +651,204 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string (Required): The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[] (Required): IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string (Required): The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) (Required) -* **subnet**: [SubResource](#subresource) (Required) - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string (Required): Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string (Required): Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VpnClientConfiguration +## NetworkInterfacePropertiesFormat ### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource) -## VpnClientRevokedCertificate +## NetworkSecurityGroup ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientRootCertificate +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. -## VpnClientRootCertificatePropertiesFormat +## OutboundNatRulePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required) +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## PacketCaptureFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ResourceTags +## PacketCaptureParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPropertiesFormat +## PacketCaptureStorageLocation ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ExpressRouteCircuitAuthorization +## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat) -## AuthorizationPropertiesFormat +## ProbePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. -## ExpressRouteCircuitPeering +## PublicIPAddress ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) - -## ExpressRouteCircuitPeeringPropertiesFormat -### Properties -* **azureASN**: int: The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringConfig +## PublicIPAddressDnsSettings ### Properties -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteCircuitStats +## PublicIPAddressPropertiesFormat ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## ExpressRouteCircuitServiceProviderProperties +## ResourceNavigationLink ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## ExpressRouteCircuitSku +## ResourceNavigationLinkFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. - -## FrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. - -## FrontendIPConfigurationPropertiesFormat -### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## InboundNatPool -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. - -## InboundNatPoolPropertiesFormat -### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## LoadBalancingRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. - -## LoadBalancingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource) -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required) -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat) +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1023,38 +870,30 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1071,18 +910,145 @@ ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## Route ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## DhcpOptions +## RoutePropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) (Required) +* **subnet**: [SubResource](#subresource) (Required) + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string (Required): The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[] (Required): IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string (Required): The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string (Required): Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string (Required): Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. ## VirtualNetworkPeering ### Properties @@ -1101,8 +1067,42 @@ * **remoteVirtualNetwork**: [SubResource](#subresource) * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2016-12-01/types.md b/generated/network/microsoft.network/2016-12-01/types.md index 07b8b4b419..5e9ba2d026 100644 --- a/generated/network/microsoft.network/2016-12-01/types.md +++ b/generated/network/microsoft.network/2016-12-01/types.md @@ -239,25 +239,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -271,6 +255,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -284,395 +273,177 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. +* **port**: int: Port +* **probe**: [SubResource](#subresource) +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## BackendAddressPool +## ApplicationGatewayConnectionDraining +### Properties +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource) +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource) -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource) -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -## SubnetPropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroup +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **httpListener**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. +* **urlPathMap**: [SubResource](#subresource) -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. +* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource) - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. -* **port**: int: Port -* **probe**: [SubResource](#subresource) -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource) - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: [SubResource](#subresource) -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource) - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **protocol**: 'Http' | 'Https' | string: Protocol. Possible values are: 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayRequestRoutingRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. - -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **httpListener**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. -* **urlPathMap**: [SubResource](#subresource) - -## ApplicationGatewaySku -### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. -* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. - -## ApplicationGatewaySslCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'. - -## ApplicationGatewayUrlPathMap +## ApplicationGatewaySslPolicy +### Properties +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. Possible values are: 'TLSv1_0', 'TLSv1_1', and 'TLSv1_2'. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -686,65 +457,30 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **enabled**: bool (Required): Whether the web application firewall is enabled or not. * **firewallMode**: 'Detection' | 'Prevention' | string: Web application firewall mode. Possible values are: 'Detection' and 'Prevention'. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## LocalNetworkGateway +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## LocalNetworkGatewayPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## BgpSettings ### Properties @@ -752,119 +488,9 @@ * **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. * **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## VirtualNetworkGatewayPropertiesFormat -### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings) -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - -## VirtualNetworkGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. - -## VpnClientConfiguration -### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. - -## VpnClientRevokedCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. - -## VpnClientRevokedCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. - -## VpnClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -873,12 +499,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -886,6 +506,13 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -905,61 +532,18 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. - -## RouteFilter -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. - -## RouteFilterRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' - -## RouteFilterRuleTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCircuitStats +## ExpressRouteCircuitPropertiesFormat ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. ## ExpressRouteCircuitServiceProviderProperties ### Properties @@ -971,24 +555,14 @@ ### Properties * **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. * **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. -## LoadBalancerPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. ## FrontendIPConfiguration ### Properties @@ -1025,6 +599,51 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1045,6 +664,98 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource) + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1059,6 +770,30 @@ * **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + ## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1076,6 +811,86 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties @@ -1096,38 +911,30 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1139,33 +946,192 @@ ### Additional Properties * **Additional Properties Type**: string -## RouteFilterRuleTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## RoutePropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## DhcpOptions +## RouteTable ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings) +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | string: Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. ## VirtualNetworkPeering ### Properties @@ -1184,8 +1150,42 @@ * **remoteVirtualNetwork**: [SubResource](#subresource) * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-03-01/types.md b/generated/network/microsoft.network/2017-03-01/types.md index 3a858cae01..8fcd3469ce 100644 --- a/generated/network/microsoft.network/2017-03-01/types.md +++ b/generated/network/microsoft.network/2017-03-01/types.md @@ -239,25 +239,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -271,6 +255,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -284,608 +273,232 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **port**: int: Port +* **probe**: [SubResource](#subresource) +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## BackendAddressPool +## ApplicationGatewayConnectionDraining +### Properties +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. + +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource) +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource) -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource) -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -## SubnetPropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroup +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **httpListener**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource) -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## NetworkInterface +## ApplicationGatewaySslPolicy +### Properties +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource) - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **port**: int: Port -* **probe**: [SubResource](#subresource) -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource) - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: [SubResource](#subresource) -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource) - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayRequestRoutingRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. - -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **httpListener**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource) - -## ApplicationGatewaySku -### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. - -## ApplicationGatewaySslCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. - -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource) -* **defaultBackendHttpSettings**: [SubResource](#subresource) -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## VirtualNetworkGatewayPropertiesFormat -### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - -## VirtualNetworkGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -## VpnClientConfiguration +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **defaultBackendAddressPool**: [SubResource](#subresource) +* **defaultBackendHttpSettings**: [SubResource](#subresource) +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRevokedCertificate +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## VpnClientRevokedCertificatePropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRootCertificate +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ResourceTags +## BackendAddressPoolPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -894,12 +507,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -907,6 +514,13 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -927,62 +541,30 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## Ipv6ExpressRouteCircuitPeeringConfig -### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' - -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. - -## RouteFilter -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. - -## RouteFilterRulePropertiesFormat +## ExpressRouteCircuitPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## RouteFilterRuleTags +## ExpressRouteCircuitServiceProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ResourceTags +## ExpressRouteCircuitSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. ## ExpressRouteCircuitStats ### Properties @@ -991,69 +573,104 @@ * **secondarybytesIn**: int: Gets BytesIn of the peering. * **secondarybytesOut**: int: Gets BytesOut of the peering. -## ExpressRouteCircuitServiceProviderProperties +## FrontendIPConfiguration ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -## ExpressRouteCircuitSku +## FrontendIPConfigurationPropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## InboundNatPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## LoadBalancerPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## FrontendIPConfiguration +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## FrontendIPConfigurationPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. * **privateIPAddress**: string: The private IP address of the IP configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. * **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## InboundNatPool +## IpsecPolicy ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## InboundNatPoolPropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. ## LoadBalancingRule ### Properties @@ -1075,6 +692,98 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource) + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1089,6 +798,30 @@ * **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + ## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1106,6 +839,91 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties @@ -1126,38 +944,30 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1169,33 +979,189 @@ ### Additional Properties * **Additional Properties Type**: string +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + ## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkPropertiesFormat +## RouteTable ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DhcpOptions +## RouteTablePropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1214,8 +1180,42 @@ * **remoteVirtualNetwork**: [SubResource](#subresource) * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-03-30/types.md b/generated/network/microsoft.network/2017-03-30/types.md index 77988f562d..b0bfcf6ac0 100644 --- a/generated/network/microsoft.network/2017-03-30/types.md +++ b/generated/network/microsoft.network/2017-03-30/types.md @@ -239,25 +239,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat) * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -271,6 +255,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -284,608 +273,232 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **port**: int: Port +* **probe**: [SubResource](#subresource) +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## BackendAddressPool +## ApplicationGatewayConnectionDraining +### Properties +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. + +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource) +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource) -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource) -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -## SubnetPropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroup +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application gateway SSL policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **backendAddressPool**: [SubResource](#subresource) +* **backendHttpSettings**: [SubResource](#subresource) +* **httpListener**: [SubResource](#subresource) +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource) -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string (Required): 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. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: string (Required): 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. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## NetworkInterface +## ApplicationGatewaySslPolicy +### Properties +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource) - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **port**: int: Port -* **probe**: [SubResource](#subresource) -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource) - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPort**: [SubResource](#subresource) -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource) - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayRequestRoutingRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. - -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **httpListener**: [SubResource](#subresource) -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource) - -## ApplicationGatewaySku -### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'WAF_Large' | 'WAF_Medium' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'WAF' | string: Tier of an application gateway. - -## ApplicationGatewaySslCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: SSL protocols to be disabled on application gateway. - -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource) -* **defaultBackendHttpSettings**: [SubResource](#subresource) -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of probe of an application gateway. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource) -* **backendHttpSettings**: [SubResource](#subresource) -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource) -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## VirtualNetworkGatewayPropertiesFormat -### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource) -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - -## VirtualNetworkGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource) -* **subnet**: [SubResource](#subresource) - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -## VpnClientConfiguration +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **defaultBackendAddressPool**: [SubResource](#subresource) +* **defaultBackendHttpSettings**: [SubResource](#subresource) +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRevokedCertificate +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## VpnClientRevokedCertificatePropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRootCertificate +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ResourceTags +## BackendAddressPoolPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly) +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -894,12 +507,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -907,6 +514,13 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -927,62 +541,30 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## Ipv6ExpressRouteCircuitPeeringConfig -### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' - -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. - -## RouteFilter -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. - -## RouteFilterRulePropertiesFormat +## ExpressRouteCircuitPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## RouteFilterRuleTags +## ExpressRouteCircuitServiceProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ResourceTags +## ExpressRouteCircuitSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. ## ExpressRouteCircuitStats ### Properties @@ -991,69 +573,104 @@ * **secondarybytesIn**: int: Gets BytesIn of the peering. * **secondarybytesOut**: int: Gets BytesOut of the peering. -## ExpressRouteCircuitServiceProviderProperties +## FrontendIPConfiguration ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -## ExpressRouteCircuitSku +## FrontendIPConfigurationPropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## InboundNatPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## LoadBalancerPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## FrontendIPConfiguration +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource) +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## FrontendIPConfigurationPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. * **privateIPAddress**: string: The private IP address of the IP configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. * **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## InboundNatPool +## IpsecPolicy ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## InboundNatPoolPropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendIPConfiguration**: [SubResource](#subresource) -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. ## LoadBalancingRule ### Properties @@ -1075,6 +692,98 @@ * **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource) + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1089,6 +798,30 @@ * **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + ## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1106,6 +839,91 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IPConfiguration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties @@ -1126,38 +944,30 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1169,33 +979,189 @@ ### Additional Properties * **Additional Properties Type**: string +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + ## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkPropertiesFormat +## RouteTable ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DhcpOptions +## RouteTablePropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat) + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string (Required): 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. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: string (Required): 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. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat) + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource) +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource) +* **subnet**: [SubResource](#subresource) + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource) +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1214,8 +1180,42 @@ * **remoteVirtualNetwork**: [SubResource](#subresource) * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-06-01/types.md b/generated/network/microsoft.network/2017-06-01/types.md index c46414aa87..035f66b2ce 100644 --- a/generated/network/microsoft.network/2017-06-01/types.md +++ b/generated/network/microsoft.network/2017-06-01/types.md @@ -250,26 +250,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -284,6 +267,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -298,386 +286,164 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## BackendAddressPool +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## SubResource +## ApplicationGatewayFrontendIPConfiguration ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## SecurityRule +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## SecurityRulePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -759,22 +525,6 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - ## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. @@ -783,35 +533,179 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup +## AuthorizationPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BackendAddressPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## VirtualNetworkGatewayConnectionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## BgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. + +## DhcpOptions +### Properties +* **dnsServers**: string[]: The list of DNS servers IP addresses. + +## ExpressRouteCircuitAuthorization +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) + +## ExpressRouteCircuitPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) + +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + +## ExpressRouteCircuitPeeringPropertiesFormat +### Properties +* **azureASN**: int: The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. + +## ExpressRouteCircuitPropertiesFormat +### Properties +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. + +## ExpressRouteCircuitServiceProviderProperties +### Properties +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. + +## ExpressRouteCircuitSku +### Properties +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | 'Transport' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. + +## ExpressRouteCircuitStats +### Properties +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. + +## FrontendIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## FrontendIPConfigurationPropertiesFormat +### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## InboundNatPool +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. + +## InboundNatPoolPropertiesFormat +### Properties +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -824,6 +718,46 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -842,219 +776,177 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. - -## VpnClientRevokedCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. -## VpnClientRootCertificate +## NetworkSecurityGroup ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## NetworkSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## NetworkWatcherPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -## ExpressRouteCircuitPropertiesFormat +## OutboundNatRule ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. -## ExpressRouteCircuitAuthorization +## OutboundNatRulePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AuthorizationPropertiesFormat +## PacketCaptureFilter ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteCircuitPeering +## PacketCaptureParameters ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringPropertiesFormat +## PacketCaptureStorageLocation ### Properties -* **azureASN**: int: The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## Probe ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## ExpressRouteCircuitPeeringConfig +## ProbePropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. -## RouteFilter +## PublicIPAddress ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## RouteFilterPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## RouteFilterRule +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. -## RouteFilterRuleTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1064,128 +956,65 @@ ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | 'Transport' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfigurationPropertiesFormat +## ResourceTags ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1207,76 +1036,210 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## Route ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## PacketCaptureFilter +## RouteFilter ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PacketCaptureStorageLocation +## RouteFilterPropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ResourceTags +## RouteFilterRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. -## ResourceTags +## RouteFilterRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' ## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkPropertiesFormat +## RouteTable ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DhcpOptions +## RouteTablePropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1295,8 +1258,45 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-08-01/types.md b/generated/network/microsoft.network/2017-08-01/types.md index 581f46e4b2..36451e427a 100644 --- a/generated/network/microsoft.network/2017-08-01/types.md +++ b/generated/network/microsoft.network/2017-08-01/types.md @@ -252,26 +252,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -286,6 +269,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -300,391 +288,164 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## BackendAddressPool +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## SubResource +## ApplicationGatewayFrontendIPConfiguration ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## SecurityRule +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## SecurityRulePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -766,22 +527,6 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - ## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. @@ -790,35 +535,179 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup +## AuthorizationPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BackendAddressPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## VirtualNetworkGatewayConnectionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## BgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. + +## DhcpOptions +### Properties +* **dnsServers**: string[]: The list of DNS servers IP addresses. + +## ExpressRouteCircuitAuthorization +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) + +## ExpressRouteCircuitPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) + +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + +## ExpressRouteCircuitPeeringPropertiesFormat +### Properties +* **azureASN**: int: The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. + +## ExpressRouteCircuitPropertiesFormat +### Properties +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. + +## ExpressRouteCircuitServiceProviderProperties +### Properties +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. + +## ExpressRouteCircuitSku +### Properties +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. + +## ExpressRouteCircuitStats +### Properties +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. + +## FrontendIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## FrontendIPConfigurationPropertiesFormat +### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## InboundNatPool +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. + +## InboundNatPoolPropertiesFormat +### Properties +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'Tcp' | 'Udp' | string: The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -831,6 +720,51 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -849,219 +783,182 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VpnClientConfiguration +## NetworkInterfacePropertiesFormat ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. -## VpnClientRevokedCertificate +## NetworkSecurityGroup ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientRootCertificate +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. -## ResourceTags +## OutboundNatRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ExpressRouteCircuitPropertiesFormat +## PacketCaptureFilter ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteCircuitAuthorization +## PacketCaptureParameters ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## AuthorizationPropertiesFormat +## PacketCaptureStorageLocation ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ExpressRouteCircuitPeering +## Probe ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## ExpressRouteCircuitPeeringPropertiesFormat +## ProbePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. - -## Ipv6ExpressRouteCircuitPeeringConfig -### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' - -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **requestPath**: 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. -## RouteFilter +## PublicIPAddress ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## RouteFilterPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## RouteFilterRule +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. -## RouteFilterRuleTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1071,133 +968,65 @@ ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. - -## FrontendIPConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfigurationPropertiesFormat +## ResourceTags ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'Tcp' | 'Udp' | string (Required): The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1219,76 +1048,210 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## Route ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## PacketCaptureFilter +## RouteFilter ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PacketCaptureStorageLocation +## RouteFilterPropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ResourceTags +## RouteFilterRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. -## ResourceTags +## RouteFilterRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' ## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RouteFilterRuleTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkPropertiesFormat +## RouteTable ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DhcpOptions +## RouteTablePropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1307,8 +1270,45 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-09-01/types.md b/generated/network/microsoft.network/2017-09-01/types.md index f2036b8139..5aa1233805 100644 --- a/generated/network/microsoft.network/2017-09-01/types.md +++ b/generated/network/microsoft.network/2017-09-01/types.md @@ -264,26 +264,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -298,6 +281,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -312,420 +300,170 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. ## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties @@ -801,23 +539,7 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. * **enabled**: bool (Required): Whether the web application firewall is enabled or not. @@ -825,192 +547,50 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## ApplicationSecurityGroup ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat -### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. - -## VirtualNetworkGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. - -## VpnClientRevokedCertificate +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## VpnClientRevokedCertificatePropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRootCertificate +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ResourceTags +## BackendAddressPoolPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -1019,12 +599,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1032,6 +606,15 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -1052,101 +635,38 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## Ipv6ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## RouteFilter +## ExpressRouteCircuitSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. - -## RouteFilterRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' - -## RouteFilterRuleTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCircuitStats +## ExpressRouteCircuitStats ### Properties * **primarybytesIn**: int: Gets BytesIn of the peering. * **primarybytesOut**: int: Gets BytesOut of the peering. * **secondarybytesIn**: int: Gets BytesIn of the peering. * **secondarybytesOut**: int: Gets BytesOut of the peering. -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. - ## FrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1183,6 +703,74 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1204,79 +792,112 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## OutboundNatRule +## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## OutboundNatRulePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## Probe +## NetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ProbePropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## LoadBalancerSku +## NetworkInterfaceIPConfiguration ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## ResourceTags +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## NetworkInterfacePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## NetworkSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. ## NetworkWatcherPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -## ResourceTags +## OutboundNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. -## PacketCaptureParameters +## OutboundNatRulePropertiesFormat ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## PacketCaptureFilter ### Properties @@ -1286,13 +907,86 @@ * **remoteIPAddress**: 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. * **remotePort**: 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. -## PacketCaptureStorageLocation +## PacketCaptureParameters ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. - -## ResourceTags +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. + +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1302,7 +996,7 @@ ### Additional Properties * **Additional Properties Type**: string -## RouteFilterRuleTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1317,20 +1011,287 @@ ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## ResourceTags ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. -* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +### Additional Properties +* **Additional Properties Type**: string -## DhcpOptions +## ResourceTags ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RouteFilterRuleTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RouteFilterRuleTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1350,8 +1311,47 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. +* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-10-01/types.md b/generated/network/microsoft.network/2017-10-01/types.md index 369b801db2..5427d66fa3 100644 --- a/generated/network/microsoft.network/2017-10-01/types.md +++ b/generated/network/microsoft.network/2017-10-01/types.md @@ -276,27 +276,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -311,6 +293,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -325,415 +312,165 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -815,216 +552,84 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway +## ApplicationSecurityGroup ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## VirtualNetworkGatewayPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkGatewayIPConfiguration +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## VpnClientRevokedCertificate +## BackendAddressPoolPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRevokedCertificatePropertiesFormat +## BgpSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## VpnClientRootCertificate +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## VpnClientRootCertificatePropertiesFormat +## ConnectionMonitorParameters ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ResourceTags +## ConnectionMonitorSource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -1033,12 +638,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1046,6 +645,15 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -1066,64 +674,30 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## Ipv6ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## RouteFilter +## ExpressRouteCircuitSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. - -## RouteFilterRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' - -## RouteFilterRuleTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. ## ExpressRouteCircuitStats ### Properties @@ -1132,35 +706,6 @@ * **secondarybytesIn**: int: Gets BytesIn of the peering. * **secondarybytesOut**: int: Gets BytesOut of the peering. -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. - ## FrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1197,6 +742,74 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1218,6 +831,99 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1232,6 +938,30 @@ * **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + ## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1249,9 +979,51 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. -## LoadBalancerSku +## PublicIPAddress ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties @@ -1273,64 +1045,50 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1342,7 +1100,7 @@ ### Additional Properties * **Additional Properties Type**: string -## RouteFilterRuleTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1357,20 +1115,223 @@ ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## ResourceTags ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. -* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +### Additional Properties +* **Additional Properties Type**: string -## DhcpOptions +## ResourceTags ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **tags**: [RouteFilterRuleTags](#routefilterruletags): Resource tags. + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RouteFilterRuleTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RouteFilterRuleTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1390,8 +1351,47 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. +* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2017-11-01/types.md b/generated/network/microsoft.network/2017-11-01/types.md index 46abb2225a..60a7f52a79 100644 --- a/generated/network/microsoft.network/2017-11-01/types.md +++ b/generated/network/microsoft.network/2017-11-01/types.md @@ -275,27 +275,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -310,6 +292,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -324,421 +311,165 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## IpTag -### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -820,23 +551,7 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. * **enabled**: bool (Required): Whether the web application firewall is enabled or not. @@ -844,192 +559,76 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway +## ApplicationSecurityGroup ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## VirtualNetworkGatewayPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkGatewayIPConfiguration +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## VpnClientRevokedCertificate +## BackendAddressPoolPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRevokedCertificatePropertiesFormat +## BgpSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## VpnClientRootCertificate +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## VpnClientRootCertificatePropertiesFormat +## ConnectionMonitorParameters ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ResourceTags +## ConnectionMonitorSource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -1038,12 +637,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1051,6 +644,15 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -1071,58 +673,30 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## Ipv6ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## RouteFilter +## ExpressRouteCircuitSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource - -## RouteFilterRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. ## ExpressRouteCircuitStats ### Properties @@ -1131,35 +705,6 @@ * **secondarybytesIn**: int: Gets BytesIn of the peering. * **secondarybytesOut**: int: Gets BytesOut of the peering. -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. - ## FrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1198,6 +743,79 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1219,6 +837,99 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1233,6 +944,30 @@ * **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + ## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1250,11 +985,54 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. -## LoadBalancerSku +## PublicIPAddress ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. - -## ResourceTags +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1274,64 +1052,50 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1353,20 +1117,217 @@ ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## ResourceTags ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. -* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +### Additional Properties +* **Additional Properties Type**: string -## DhcpOptions +## ResourceTags ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1386,8 +1347,47 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. +* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2018-01-01/types.md b/generated/network/microsoft.network/2018-01-01/types.md index 03eb866258..16be1bd918 100644 --- a/generated/network/microsoft.network/2018-01-01/types.md +++ b/generated/network/microsoft.network/2018-01-01/types.md @@ -275,27 +275,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -310,6 +292,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -324,421 +311,165 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## IpTag -### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -820,23 +551,7 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. * **enabled**: bool (Required): Whether the web application firewall is enabled or not. @@ -846,192 +561,76 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway +## ApplicationSecurityGroup ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## VirtualNetworkGatewayPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkGatewayIPConfiguration +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## VpnClientRevokedCertificate +## BackendAddressPoolPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRevokedCertificatePropertiesFormat +## BgpSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## VpnClientRootCertificate +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## VpnClientRootCertificatePropertiesFormat +## ConnectionMonitorParameters ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ResourceTags +## ConnectionMonitorSource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -1040,12 +639,6 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat -### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - ## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1053,6 +646,15 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -1073,58 +675,30 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## Ipv6ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitPeeringConfig +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## RouteFilter +## ExpressRouteCircuitSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource - -## RouteFilterRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. ## ExpressRouteCircuitStats ### Properties @@ -1133,35 +707,6 @@ * **secondarybytesIn**: int: Gets BytesIn of the peering. * **secondarybytesOut**: int: Gets BytesOut of the peering. -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. - ## FrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1200,6 +745,79 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS2' | 'PFS2048' | 'PFS24' | string (Required): The DH Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1221,6 +839,99 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.' * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## LocalNetworkGatewayPropertiesFormat +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## OutboundNatRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1235,6 +946,30 @@ * **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + ## Probe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1252,11 +987,54 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. -## LoadBalancerSku +## PublicIPAddress ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. - -## ResourceTags +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1276,64 +1054,50 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1355,20 +1119,217 @@ ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## ResourceTags ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. -* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +### Additional Properties +* **Additional Properties Type**: string -## DhcpOptions +## ResourceTags ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1388,8 +1349,47 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network. +* **enableVmProtection**: bool: Indicates if Vm protection is enabled for all the subnets in a Virtual Network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2018-02-01/types.md b/generated/network/microsoft.network/2018-02-01/types.md index 8e53007911..4cde6f86d3 100644 --- a/generated/network/microsoft.network/2018-02-01/types.md +++ b/generated/network/microsoft.network/2018-02-01/types.md @@ -319,27 +319,9 @@ * **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. * **type**: 'Microsoft.Network/virtualNetworks/virtualNetworkPeerings' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -354,6 +336,11 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -368,421 +355,165 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: Port +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat +### Properties +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. - -## SecurityRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## IpTag -### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: Port -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. @@ -864,23 +595,7 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. * **enabled**: bool (Required): Whether the web application firewall is enabled or not. @@ -890,177 +605,69 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. - -## LocalNetworkGateway +## ApplicationSecurityGroup ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## VirtualNetworkGatewayPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkGatewayIPConfiguration +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. -* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## VpnClientRevokedCertificate +## BackendAddressPoolPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientRevokedCertificatePropertiesFormat +## BgpSettings ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## VpnClientRootCertificate +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## VpnClientRootCertificatePropertiesFormat +## ConnectionMonitorParameters ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ResourceTags +## ConnectionMonitorSource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1071,23 +678,9 @@ * **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. * **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCircuitPropertiesFormat +## DhcpOptions ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **dnsServers**: string[]: The list of DNS servers IP addresses. ## ExpressRouteCircuitAuthorization ### Properties @@ -1096,11 +689,21 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## AuthorizationPropertiesFormat +## ExpressRouteCircuitConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) + +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. * **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. ## ExpressRouteCircuitPeering ### Properties @@ -1109,6 +712,15 @@ * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. * **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +## ExpressRouteCircuitPeeringConfig +### Properties +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. + ## ExpressRouteCircuitPeeringPropertiesFormat ### Properties * **azureASN**: int: The Azure ASN. @@ -1130,81 +742,22 @@ * **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## ExpressRouteCircuitConnection +## ExpressRouteCircuitPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitConnectionPropertiesFormat +## ExpressRouteCircuitReference ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. - -## Ipv6ExpressRouteCircuitPeeringConfig -### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' - -## ExpressRouteCircuitPeeringConfig -### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. - -## RouteFilter -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteFilterPropertiesFormat -### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. - -## RouteFilterRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource - -## RouteFilterRulePropertiesFormat -### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +* **id**: string: Corresponding Express Route Circuit Id. ## ExpressRouteCircuitServiceProviderProperties ### Properties @@ -1218,27 +771,12 @@ * **name**: string: The name of the SKU. * **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference +## ExpressRouteCircuitStats ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. ## ExpressRouteCrossConnectionPeering ### Properties @@ -1265,22 +803,18 @@ * **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' * **vlanId**: int: The VLAN ID. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## LoadBalancerPropertiesFormat +## ExpressRouteCrossConnectionProperties ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. ## FrontendIPConfiguration ### Properties @@ -1320,6 +854,79 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + ## LoadBalancingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1341,45 +948,200 @@ * **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. * **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## OutboundNatRule +## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## OutboundNatRulePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## Probe +## NetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ProbePropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## LoadBalancerSku +## NetworkInterfaceIPConfiguration ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## ResourceTags +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## OutboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. + +## OutboundNatRulePropertiesFormat +### Properties +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. + +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties @@ -1396,64 +1158,50 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1475,21 +1223,232 @@ ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkPropertiesFormat +## ResourceTags ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +### Additional Properties +* **Additional Properties Type**: string -## DhcpOptions +## ResourceTags ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. + +## VirtualNetworkGatewaySku +### Properties +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU name. +* **tier**: 'Basic' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw2' | 'VpnGw3' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1509,8 +1468,49 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VpnClientConfiguration +### Properties +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. diff --git a/generated/network/microsoft.network/2018-04-01/types.md b/generated/network/microsoft.network/2018-04-01/types.md index accb30bc48..174dd43ea8 100644 --- a/generated/network/microsoft.network/2018-04-01/types.md +++ b/generated/network/microsoft.network/2018-04-01/types.md @@ -390,29 +390,9 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -427,14 +407,19 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayAutoscaleBounds +### Properties +* **max**: int (Required): Upper bound on number of Application Gateway instances. +* **min**: int (Required): Lower bound on number of Application Gateway instances. + ## ApplicationGatewayAutoscaleConfiguration ### Properties * **bounds**: [ApplicationGatewayAutoscaleBounds](#applicationgatewayautoscalebounds) (Required): Application Gateway autoscale bounds on number of Application Gateway instance. -## ApplicationGatewayAutoscaleBounds +## ApplicationGatewayBackendAddress ### Properties -* **max**: int (Required): Upper bound on number of Application Gateway instances. -* **min**: int (Required): Lower bound on number of Application Gateway instances. +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address ## ApplicationGatewayBackendAddressPool ### Properties @@ -450,419 +435,165 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. - -## BackendAddressPoolPropertiesFormat -### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## SubResource +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **id**: string: Resource ID. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## SecurityRule +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## SecurityRulePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## IpTag -### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. ## ApplicationGatewayRedirectConfiguration ### Properties @@ -946,23 +677,7 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. * **enabled**: bool (Required): Whether the web application firewall is enabled or not. @@ -972,27 +687,34 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup +## ApplicationSecurityGroup ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ApplicationSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallPropertiesFormat +## AzureFirewallApplicationRule ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by a Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by a Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **description**: string: Description of the rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetUrls**: string[]: List of URLs for this rule. ## AzureFirewallApplicationRuleCollection ### Properties @@ -1008,18 +730,6 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection - -## AzureFirewallApplicationRule -### Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetUrls**: string[]: List of URLs for this rule. - ## AzureFirewallApplicationRuleProtocol ### Properties * **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. @@ -1040,6 +750,15 @@ * **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. * **subnet**: [SubResource](#subresource): Reference to another subresource. +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. + ## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -1054,68 +773,30 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by a Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by a Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## IpsecPolicy +## AzureFirewallRCAction ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## LocalNetworkGateway +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## LocalNetworkGatewayPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## BgpSettings ### Properties @@ -1123,121 +804,112 @@ * **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. * **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## AddressSpace +## ConnectionMonitorDestination ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ResourceTags +## ConnectionMonitorParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## TunnelConnectionHealth +## ConnectionMonitorSource ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## VirtualNetworkGateway +## ConnectionMonitorTags ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkGatewayPropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## VirtualNetworkGatewayIPConfiguration +## DdosProtectionPlanTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## VirtualNetworkGatewaySku +## DhcpOptions ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## VpnClientConfiguration +## ExpressRouteCircuitAuthorization ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## VpnClientRevokedCertificate +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## VpnClientRevokedCertificatePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## VpnClientRootCertificate +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## VpnClientRootCertificatePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DdosProtectionPlanPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## DdosProtectionPlanTags +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. ## ExpressRouteCircuitPropertiesFormat ### Properties @@ -1252,62 +924,170 @@ * **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. * **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitAuthorization +## ExpressRouteCircuitReference ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **id**: string: Corresponding Express Route Circuit Id. -## AuthorizationPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ExpressRouteCircuitPeering +## ExpressRouteCircuitSku +### Properties +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. + +## ExpressRouteCircuitStats +### Properties +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. + +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## ExpressRouteCircuitPeeringPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **azureASN**: int (ReadOnly): The Azure ASN. * **gatewayManagerEtag**: string: The GatewayManager Etag. * **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. * **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. * **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. * **peerASN**: int: The peer ASN. * **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. +* **primaryAzurePort**: string (ReadOnly): The primary port. * **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. * **secondaryPeerAddressPrefix**: string: The secondary address prefix. * **sharedKey**: string: The shared key. * **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## ExpressRouteCircuitConnection +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. + +## FrontendIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## FrontendIPConfigurationPropertiesFormat +### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## HubVirtualNetworkConnection +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## HubVirtualNetworkConnectionProperties +### Properties +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## InboundNatPool +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. + +## InboundNatPoolPropertiesFormat +### Properties +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## ExpressRouteCircuitConnectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc ## Ipv6ExpressRouteCircuitPeeringConfig ### Properties @@ -1317,227 +1097,357 @@ * **secondaryPeerAddressPrefix**: string: The secondary address prefix. * **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -## ExpressRouteCircuitPeeringConfig +## LoadBalancerPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## RouteFilter +## LoadBalancerSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## RouteFilterPropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## OutboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. + +## OutboundNatRulePropertiesFormat +### Properties +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## Policies +### Properties +* **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. +* **allowVnetToVnetTraffic**: bool: True if Vnet to Vnet traffic is allowed. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. + +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRule +## ResourceNavigationLinkFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. -## RouteFilterRulePropertiesFormat +## ResourceTags ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats +## ResourceTags ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitServiceProviderProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitSku +## ResourceTags ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitReference +## ResourceTags ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeering +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeeringProperties +## ResourceTags ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfigurationPropertiesFormat +## ResourceTags ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1559,79 +1469,138 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## Route ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ConnectionMonitorDestination +## RouteTable ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorSource +## RouteTablePropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ConnectionMonitorTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PacketCaptureParameters +## SecurityRulePropertiesFormat ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PacketCaptureFilter +## ServiceEndpointPropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. -## PacketCaptureStorageLocation +## Subnet ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## ResourceTags +## SubnetPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. ## VirtualHubProperties ### Properties @@ -1640,53 +1609,69 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## HubVirtualNetworkConnection +## VirtualNetworkGateway ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties -### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. - -## ResourceTags +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1706,10 +1691,17 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. ## VirtualWanProperties ### Properties @@ -1718,18 +1710,39 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientRevokedCertificate ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. -* **policies**: [Policies](#policies): Policies for vpn gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -1751,15 +1764,13 @@ * **routingWeight**: int: routing weight for vpn connection. * **sharedKey**: string: SharedKey for the vpn connection. -## Policies -### Properties -* **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. -* **allowVnetToVnetTraffic**: bool: True if Vnet to Vnet traffic is allowed. - -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. +* **policies**: [Policies](#policies): Policies for vpn gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. ## VpnSiteProperties ### Properties @@ -1771,14 +1782,3 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWAN**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/network/microsoft.network/2018-06-01/types.md b/generated/network/microsoft.network/2018-06-01/types.md index 2808e0d81d..9c90fc508c 100644 --- a/generated/network/microsoft.network/2018-06-01/types.md +++ b/generated/network/microsoft.network/2018-06-01/types.md @@ -390,29 +390,9 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -427,14 +407,19 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayAutoscaleBounds +### Properties +* **max**: int (Required): Upper bound on number of Application Gateway instances. +* **min**: int (Required): Lower bound on number of Application Gateway instances. + ## ApplicationGatewayAutoscaleConfiguration ### Properties * **bounds**: [ApplicationGatewayAutoscaleBounds](#applicationgatewayautoscalebounds) (Required): Application Gateway autoscale bounds on number of Application Gateway instance. -## ApplicationGatewayAutoscaleBounds +## ApplicationGatewayBackendAddress ### Properties -* **max**: int (Required): Upper bound on number of Application Gateway instances. -* **min**: int (Required): Lower bound on number of Application Gateway instances. +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address ## ApplicationGatewayBackendAddressPool ### Properties @@ -450,419 +435,165 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. - -## BackendAddressPoolPropertiesFormat -### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## SubResource +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **id**: string: Resource ID. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## SecurityRule +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## SecurityRulePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. - -## NetworkInterface -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceNavigationLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource - -## RoutePropertiesFormat -### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. - -## IpTag -### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc - -## PublicIPAddressSku -### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationGatewayBackendHttpSettings -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. - -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayHttpListener -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayProbe -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayProbePropertiesFormat -### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. ## ApplicationGatewayRedirectConfiguration ### Properties @@ -946,23 +677,7 @@ * **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties * **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. * **enabled**: bool (Required): Whether the web application firewall is enabled or not. @@ -972,27 +687,34 @@ * **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. * **ruleSetVersion**: string (Required): The version of the rule set type. -## ApplicationGatewayFirewallDisabledRuleGroup +## ApplicationSecurityGroup ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ApplicationSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallPropertiesFormat +## AzureFirewallApplicationRule ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by a Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by a Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **description**: string: Description of the rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetUrls**: string[]: List of URLs for this rule. ## AzureFirewallApplicationRuleCollection ### Properties @@ -1008,18 +730,6 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection - -## AzureFirewallApplicationRule -### Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetUrls**: string[]: List of URLs for this rule. - ## AzureFirewallApplicationRuleProtocol ### Properties * **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. @@ -1040,6 +750,15 @@ * **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. * **subnet**: [SubResource](#subresource): Reference to another subresource. +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. + ## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -1054,68 +773,30 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by a Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by a Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## IpsecPolicy +## AzureFirewallRCAction ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## LocalNetworkGateway +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## LocalNetworkGatewayPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundNatRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## BgpSettings ### Properties @@ -1123,121 +804,112 @@ * **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. * **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## AddressSpace +## ConnectionMonitorDestination ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ResourceTags +## ConnectionMonitorParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## TunnelConnectionHealth +## ConnectionMonitorSource ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## VirtualNetworkGateway +## ConnectionMonitorTags ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkGatewayPropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## VirtualNetworkGatewayIPConfiguration +## DdosProtectionPlanTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## VirtualNetworkGatewaySku +## DhcpOptions ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## VpnClientConfiguration +## ExpressRouteCircuitAuthorization ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## VpnClientRevokedCertificate +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## VpnClientRevokedCertificatePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## VpnClientRootCertificate +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## VpnClientRootCertificatePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DdosProtectionPlanPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## DdosProtectionPlanTags +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. ## ExpressRouteCircuitPropertiesFormat ### Properties @@ -1252,62 +924,170 @@ * **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. * **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ExpressRouteCircuitAuthorization +## ExpressRouteCircuitReference ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **id**: string: Corresponding Express Route Circuit Id. -## AuthorizationPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ExpressRouteCircuitPeering +## ExpressRouteCircuitSku +### Properties +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. + +## ExpressRouteCircuitStats +### Properties +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. + +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## ExpressRouteCircuitPeeringPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **azureASN**: int (ReadOnly): The Azure ASN. * **gatewayManagerEtag**: string: The GatewayManager Etag. * **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. * **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. * **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. * **peerASN**: int: The peer ASN. * **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. +* **primaryAzurePort**: string (ReadOnly): The primary port. * **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. * **secondaryPeerAddressPrefix**: string: The secondary address prefix. * **sharedKey**: string: The shared key. * **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. * **vlanId**: int: The VLAN ID. -## ExpressRouteCircuitConnection +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. + +## FrontendIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## FrontendIPConfigurationPropertiesFormat +### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## HubVirtualNetworkConnection +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## HubVirtualNetworkConnectionProperties +### Properties +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## InboundNatPool +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. + +## InboundNatPoolPropertiesFormat +### Properties +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## InboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## ExpressRouteCircuitConnectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpsecPolicy +### Properties +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. + +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc ## Ipv6ExpressRouteCircuitPeeringConfig ### Properties @@ -1317,227 +1097,357 @@ * **secondaryPeerAddressPrefix**: string: The secondary address prefix. * **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -## ExpressRouteCircuitPeeringConfig +## LoadBalancerPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## RouteFilter +## LoadBalancerSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## LocalNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## RouteFilterPropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkInterfaceDnsSettings +### Properties +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. + +## NetworkInterfaceIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## OutboundNatRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. + +## OutboundNatRulePropertiesFormat +### Properties +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## Policies +### Properties +* **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. +* **allowVnetToVnetTraffic**: bool: True if Vnet to Vnet traffic is allowed. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. + +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRule +## ResourceNavigationLinkFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. -## RouteFilterRulePropertiesFormat +## ResourceTags ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats +## ResourceTags ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitServiceProviderProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitSku +## ResourceTags ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitReference +## ResourceTags ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeering +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeeringProperties +## ResourceTags ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundNatRules**: [OutboundNatRule](#outboundnatrule)[]: The outbound NAT rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfigurationPropertiesFormat +## ResourceTags ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundNatRulePropertiesFormat](#outboundnatrulepropertiesformat): Outbound NAT pool of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundNatRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **frontendIPConfigurations**: [SubResource](#subresource)[]: The Frontend IP addresses of the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1559,79 +1469,138 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## Route ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource + +## RouteFilter +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteFilterPropertiesFormat +### Properties +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. + +## RouteFilterRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource + +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ConnectionMonitorDestination +## RouteTable ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorSource +## RouteTablePropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ConnectionMonitorTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PacketCaptureParameters +## SecurityRulePropertiesFormat ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PacketCaptureFilter +## ServiceEndpointPropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. -## PacketCaptureStorageLocation +## Subnet ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## ResourceTags +## SubnetPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. ## VirtualHubProperties ### Properties @@ -1640,53 +1609,69 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## HubVirtualNetworkConnection +## VirtualNetworkGateway ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties -### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. - -## ResourceTags +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1706,10 +1691,17 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. ## VirtualWanProperties ### Properties @@ -1718,18 +1710,39 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientRevokedCertificate ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. -* **policies**: [Policies](#policies): Policies for vpn gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -1751,15 +1764,13 @@ * **routingWeight**: int: routing weight for vpn connection. * **sharedKey**: string: SharedKey for the vpn connection. -## Policies -### Properties -* **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. -* **allowVnetToVnetTraffic**: bool: True if Vnet to Vnet traffic is allowed. - -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. +* **policies**: [Policies](#policies): Policies for vpn gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. ## VpnSiteProperties ### Properties @@ -1771,14 +1782,3 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWAN**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/network/microsoft.network/2018-07-01/types.md b/generated/network/microsoft.network/2018-07-01/types.md index 81801a9b5e..3b6fb85060 100644 --- a/generated/network/microsoft.network/2018-07-01/types.md +++ b/generated/network/microsoft.network/2018-07-01/types.md @@ -426,29 +426,9 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -463,14 +443,19 @@ * **data**: string: Certificate public data. * **provisioningState**: string: Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +## ApplicationGatewayAutoscaleBounds +### Properties +* **max**: int (Required): Upper bound on number of Application Gateway instances. +* **min**: int (Required): Lower bound on number of Application Gateway instances. + ## ApplicationGatewayAutoscaleConfiguration ### Properties * **bounds**: [ApplicationGatewayAutoscaleBounds](#applicationgatewayautoscalebounds) (Required): Application Gateway autoscale bounds on number of Application Gateway instance. -## ApplicationGatewayAutoscaleBounds +## ApplicationGatewayBackendAddress ### Properties -* **max**: int (Required): Upper bound on number of Application Gateway instances. -* **min**: int (Required): Lower bound on number of Application Gateway instances. +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address ## ApplicationGatewayBackendAddressPool ### Properties @@ -486,683 +471,648 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroup +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. - -## BackendAddressPoolPropertiesFormat -### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## SubResource +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **id**: string: Resource ID. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## SecurityRule +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## SecurityRulePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkInterface +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRequestRoutingRule ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## ResourceTags +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## ApplicationGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## ResourceNavigationLink +## ApplicationGatewaySslCertificate ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## RouteTable +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## RouteTablePropertiesFormat +## ApplicationGatewaySslPolicy ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy -## Route +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## RoutePropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## ServiceEndpointPolicy +## ApplicationSecurityGroup ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## ServiceEndpointPolicyPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **provisioningState**: string: The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ServiceEndpointPolicyDefinition +## AuthorizationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallApplicationRule ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string: The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **description**: string: Description of the rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetUrls**: string[]: List of URLs for this rule. -## ResourceTags +## AzureFirewallApplicationRuleCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ServiceEndpointPropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## IpTag +## AzureFirewallApplicationRuleProtocol ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource -## PublicIPAddressSku +## AzureFirewallIPConfiguration ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ResourceTags +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **internalPublicIpAddress**: [SubResource](#subresource): Reference to another subresource. +* **privateIPAddress**: string: The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayBackendHttpSettings +## AzureFirewallNetworkRule ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. + +## AzureFirewallNetworkRuleCollection +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ApplicationGatewayFrontendIPConfiguration +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by a Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by a Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## AzureFirewallRCAction ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## ApplicationGatewayFrontendPort +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ApplicationGatewayFrontendPortPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayIPConfiguration +## BgpSettings ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayHttpListener +## ConnectionMonitorParameters ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorSource ### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayProbe +## ConnectionMonitorTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbeHealthResponseMatch +## DdosProtectionPlanTags ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfiguration +## DeviceProperties ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DhcpOptions ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitAuthorization ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewaySku -### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeeringConfig ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPropertiesFormat ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **allowClassicOperations**: bool: Allow classic operations +* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitReference ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **id**: string: Corresponding Express Route Circuit Id. -## ResourceTags +## ExpressRouteCircuitServiceProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ResourceTags +## ExpressRouteCircuitSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. -## AzureFirewallPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by a Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by a Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## AzureFirewallApplicationRuleCollection +## ExpressRouteCrossConnectionPeering ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **vlanId**: int: The VLAN ID. -## AzureFirewallRCAction +## ExpressRouteCrossConnectionProperties ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## AzureFirewallApplicationRule +## FrontendIPConfiguration ### Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetUrls**: string[]: List of URLs for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## FrontendIPConfigurationPropertiesFormat +### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRuleProtocol +## HubVirtualNetworkConnection ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnectionProperties +### Properties +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## InboundNatPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **internalPublicIpAddress**: [SubResource](#subresource): Reference to another subresource. -* **privateIPAddress**: string: The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. - -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## AzureFirewallNetworkRule +## InboundNatRulePropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## IPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1175,6 +1125,57 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1193,434 +1194,335 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VpnClientConfiguration +## NetworkInterfacePropertiesFormat ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **virtualMachine**: [SubResource](#subresource): Reference to another subresource. -## VpnClientRevokedCertificate +## NetworkSecurityGroup ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnClientRootCertificate +## OutboundRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -## ResourceTags +## OutboundRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## PacketCaptureFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## DdosProtectionPlanPropertiesFormat +## PacketCaptureParameters ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## DdosProtectionPlanTags +## PacketCaptureStorageLocation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ExpressRouteCircuitPropertiesFormat +## Policies ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. +* **allowVnetToVnetTraffic**: bool: True if Vnet to Vnet traffic is allowed. -## ExpressRouteCircuitAuthorization +## Probe ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## AuthorizationPropertiesFormat +## ProbePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. -## ExpressRouteCircuitPeering +## PublicIPAddress ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ExpressRouteCircuitPeeringPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteCircuitConnection +## PublicIPAddressPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## ExpressRouteCircuitConnectionPropertiesFormat +## PublicIPAddressSku ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## Ipv6ExpressRouteCircuitPeeringConfig +## PublicIPPrefixPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **ipPrefix**: string: The allocated Prefix +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## ExpressRouteCircuitPeeringConfig +## PublicIPPrefixSku ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## RouteFilter +## ReferencedPublicIpAddress ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: The PublicIPAddress Reference + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterPropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. -## RouteFilterRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +### Additional Properties +* **Additional Properties Type**: string -## RouteFilterRulePropertiesFormat +## ResourceTags ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats +## ResourceTags ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitServiceProviderProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitSku +## ResourceTags ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard' and 'Premium'. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitReference +## ResourceTags ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeering +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeeringProperties +## ResourceTags ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +### Additional Properties +* **Additional Properties Type**: string -## FrontendIPConfigurationPropertiesFormat +## ResourceTags ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1642,108 +1544,174 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## Route ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## ConnectionMonitorSource +## RouteFilter ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorTags +## RouteFilterPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PacketCaptureParameters +## RouteFilterRule ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -## PacketCaptureFilter +## RouteFilterRulePropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PacketCaptureStorageLocation +## SecurityRulePropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinition ### Properties -* **ipPrefix**: string: The allocated Prefix -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string: The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## PublicIPPrefixSku +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **provisioningState**: string: The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -## ResourceTags +## ServiceEndpointPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## ResourceTags +## SubnetPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The address prefix for the subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. ## VirtualHubProperties ### Properties @@ -1752,53 +1720,70 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## HubVirtualNetworkConnection +## VirtualNetworkGateway ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties -### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. - -## ResourceTags +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorizationKey. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -1818,10 +1803,17 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. ## VirtualWanProperties ### Properties @@ -1830,18 +1822,39 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientRevokedCertificate ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. -* **policies**: [Policies](#policies): Policies for vpn gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -1863,15 +1876,13 @@ * **routingWeight**: int: routing weight for vpn connection. * **sharedKey**: string: SharedKey for the vpn connection. -## Policies -### Properties -* **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. -* **allowVnetToVnetTraffic**: bool: True if Vnet to Vnet traffic is allowed. - -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. +* **policies**: [Policies](#policies): Policies for vpn gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. ## VpnSiteProperties ### Properties @@ -1883,14 +1894,3 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWAN**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/network/microsoft.network/2018-08-01/types.md b/generated/network/microsoft.network/2018-08-01/types.md index 3ff36ce99d..1cb19542e1 100644 --- a/generated/network/microsoft.network/2018-08-01/types.md +++ b/generated/network/microsoft.network/2018-08-01/types.md @@ -527,31 +527,9 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: Trusted Root certificates of the application gateway resource. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -570,6 +548,11 @@ ### Properties * **minCapacity**: int (Required): Lower bound on number of Application Gateway instances +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -584,880 +567,867 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. - -## NetworkInterfaceIPConfigurationPropertiesFormat -### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. - -## ApplicationSecurityGroup -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ResourceTags +## ApplicationGatewayConnectionDraining ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## BackendAddressPool +## ApplicationGatewayCustomError ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## SubResource +## ApplicationGatewayFirewallExclusion ### Properties -* **id**: string: Resource ID. +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## InboundNatRule +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddress +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## IPConfiguration +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Delegation +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -## InterfaceEndpoint +## ApplicationGatewayProbe ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## InterfaceEndpointProperties +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. -* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. -* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. -* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## EndpointService +## ApplicationGatewayProbePropertiesFormat ### Properties -* **id**: string: A unique identifier of the service being referenced by the interface endpoint. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkInterface +## ApplicationGatewayPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: Trusted Root certificates of the application gateway resource. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRedirectConfiguration ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources -* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkSecurityGroup +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## ResourceTags +## ApplicationGatewaySslPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy -## NetworkInterfaceTapConfiguration +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource +* **data**: string: Certificate public data. +* **keyvaultSecretId**: string: KeyVault Secret Id for certificate. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkTap +## ApplicationGatewayUrlPathMap ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## FrontendIPConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## FrontendIPConfigurationPropertiesFormat +## ApplicationSecurityGroup ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ApplicationSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## IPConfigurationProfile +## AzureFirewallApplicationRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## IPConfigurationProfilePropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceNavigationLink +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ResourceNavigationLinkFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **privateIPAddress**: string: The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## RouteTable +## AzureFirewallNatRCAction ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection -## RouteTablePropertiesFormat +## AzureFirewallNatRule ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## Route +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## RoutePropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceAssociationLink +## AzureFirewallNetworkRuleCollection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPolicy +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallRCAction ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## ServiceEndpointPolicyDefinition +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## IpTag +## ConnectionMonitorParameters ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## PublicIPAddressSku +## ConnectionMonitorSource ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## Container ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationGatewayCustomError +## ContainerNetworkInterface ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendIPConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayHttpListener +## DdosProtectionPlanTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayHttpListenerPropertiesFormat +## DeviceProperties ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayProbe +## DhcpOptions ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayProbePropertiesFormat +## EndpointService ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **id**: string: A unique identifier of the service being referenced by the interface endpoint. -## ApplicationGatewayProbeHealthResponseMatch +## ExpressRouteCircuitAuthorization ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## ApplicationGatewayRedirectConfiguration +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewaySku +## ExpressRouteCircuitPeeringId ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. + +## ExpressRouteCircuitPropertiesFormat +### Properties +* **allowClassicOperations**: bool: Allow classic operations +* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitReference ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **data**: string: Certificate public data. -* **keyvaultSecretId**: string: KeyVault Secret Id for certificate. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayUrlPathMap +## ExpressRouteConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayPathRule +## ExpressRouteConnectionId ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCrossConnectionPeering ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCrossConnectionProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ResourceTags +## ExpressRouteGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ResourceTags +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## AzureFirewallPropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## AzureFirewallApplicationRuleCollection +## ExpressRouteLink ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteLinkPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallRCAction +## ExpressRoutePortPropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## AzureFirewallApplicationRule +## FrontendIPConfiguration ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRuleProtocol +## FrontendIPConfigurationPropertiesFormat ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection -## AzureFirewallIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAddress**: string: The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRCAction +## InboundNatRule ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## AzureFirewallNatRule +## InboundNatRulePropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNetworkRuleCollection +## InterfaceEndpoint ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InterfaceEndpointProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. +* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. +* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. +* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## IPConfiguration ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## ResourceTags +## IPConfigurationProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1470,6 +1440,57 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1488,403 +1509,378 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings +## NetworkInterface ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AddressSpace +## NetworkInterfaceDnsSettings ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ResourceTags +## NetworkInterfaceIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## TunnelConnectionHealth +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VirtualNetworkGateway +## NetworkInterfacePropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources +* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## NetworkInterfaceTapConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. + +## NetworkInterfaceTapConfigurationPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource + +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VirtualNetworkGatewayIPConfiguration +## OutboundRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -## VirtualNetworkGatewaySku +## OutboundRulePropertiesFormat ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientConfiguration +## P2SVpnGatewayProperties ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. * **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## VpnClientRevokedCertificate +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## VpnClientRevokedCertificatePropertiesFormat +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## VpnClientRootCertificate +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## VpnClientRootCertificatePropertiesFormat +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags +## P2SVpnServerConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration -## ResourceTags +## P2SVpnServerConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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 Parent VirtualWan resource name. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: vpnProtocols for the P2SVpnServerConfiguration. -## DdosProtectionPlanPropertiesFormat +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## DdosProtectionPlanTags +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## ExpressRouteCircuitPropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificate ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitAuthorization +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## AuthorizationPropertiesFormat +## PacketCaptureFilter ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteCircuitPeering +## PacketCaptureParameters ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## ExpressRouteCircuitPeeringPropertiesFormat +## ProbePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **requestPath**: 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. -## ExpressRouteCircuitConnection +## PublicIPAddress ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ExpressRouteCircuitConnectionPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteConnectionId +## PublicIPAddressPropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## Ipv6ExpressRouteCircuitPeeringConfig +## PublicIPAddressSku ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## ExpressRouteCircuitPeeringConfig +## PublicIPPrefixPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **ipPrefix**: string: The allocated Prefix +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## RouteFilter +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## RouteFilterPropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **id**: string: The PublicIPAddress Reference -## RouteFilterRule +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference -### Properties -* **id**: string: Corresponding Express Route Circuit Id. - -## ExpressRouteCrossConnectionPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) - -## ExpressRouteCrossConnectionPeeringProperties -### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteGatewayProperties +## ResourceTags ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## ResourceTags ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## ResourceTags ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnection +## ResourceTags ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnectionProperties +## ResourceTags ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringId +## ResourceTags ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +### Additional Properties +* **Additional Properties Type**: string -## VirtualHubId +## ResourceTags ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRoutePortPropertiesFormat +## ResourceTags ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLink +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkPropertiesFormat +## ResourceTags ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1896,96 +1892,55 @@ ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2002,56 +1957,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2063,129 +2007,189 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## Route ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## ResourceTags +## RouteFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorParameters +## RouteFilterPropertiesFormat ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ConnectionMonitorDestination +## RouteFilterRule ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -## ConnectionMonitorSource +## RouteFilterRulePropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' -## ConnectionMonitorTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PacketCaptureParameters +## RouteTable ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PacketCaptureFilter +## RouteTablePropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PacketCaptureStorageLocation +## SecurityRule ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## P2SVpnGatewayProperties +## SecurityRulePropertiesFormat ### Properties -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## VpnClientConnectionHealth +## ServiceAssociationLink ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -## ResourceTags +## ServiceAssociationLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. -## ResourceTags +## ServiceDelegationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: string[]: Describes the actions permitted to the service upon delegation +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicy ### Properties -* **ipPrefix**: string: The allocated Prefix -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyDefinition ### Properties -* **id**: string: The PublicIPAddress Reference +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixSku +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## ServiceEndpointPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2198,55 +2202,80 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: list of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: list of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. -## HubVirtualNetworkConnection +## VirtualHubRouteTable ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: list of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2266,15 +2295,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2288,89 +2338,47 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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 Parent VirtualWan resource name. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: vpnProtocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2394,10 +2402,13 @@ * **sharedKey**: string: SharedKey for the vpn connection. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. ## VpnSiteProperties ### Properties @@ -2410,14 +2421,3 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/network/microsoft.network/2018-10-01/types.md b/generated/network/microsoft.network/2018-10-01/types.md index 8f0a5722bc..bce21abfbb 100644 --- a/generated/network/microsoft.network/2018-10-01/types.md +++ b/generated/network/microsoft.network/2018-10-01/types.md @@ -528,49 +528,9 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: Trusted Root certificates of the application gateway resource. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -589,6 +549,11 @@ ### Properties * **minCapacity**: int (Required): Lower bound on number of Application Gateway instances +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -603,911 +568,904 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHeaderConfiguration ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **headerName**: string: Header name of the header configuration +* **headerValue**: string: Header value of the header configuration -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Delegation +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) - -## InterfaceEndpoint -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## InterfaceEndpointProperties +## ApplicationGatewayProbePropertiesFormat ### Properties -* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. -* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. -* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. -* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## EndpointService +## ApplicationGatewayPropertiesFormat ### Properties -* **id**: string: A unique identifier of the service being referenced by the interface endpoint. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: Trusted Root certificates of the application gateway resource. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkInterface +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkInterfacePropertiesFormat -### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources -* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkSecurityGroup +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## NetworkSecurityGroupPropertiesFormat -### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## SecurityRule +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRewriteRule ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -## ResourceTags +## ApplicationGatewayRewriteRuleActionSet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set -## NetworkInterfaceTapConfiguration +## ApplicationGatewayRewriteRuleSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. - -## NetworkInterfaceTapConfigurationPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## VirtualNetworkTap +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewaySku ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## FrontendIPConfiguration +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## FrontendIPConfigurationPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## ResourceTags +## ApplicationGatewaySslPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy -## ResourceTags +## ApplicationGatewayTrustedRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## ResourceTags +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## IPConfigurationProfile +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. - -## IPConfigurationProfilePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## ResourceNavigationLink +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceNavigationLinkFormat +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## RouteTable +## ApplicationSecurityGroup ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## RouteTablePropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## Route +## AuthorizationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## RoutePropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource -## ServiceAssociationLink +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ServiceEndpointPolicy +## AzureFirewallNatRCAction ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNatRule ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicyDefinition +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceEndpointPropertiesFormat +## AzureFirewallNetworkRuleCollection ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## IpTag +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## PublicIPAddressSku +## AzureFirewallPropertiesFormat ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## BgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. + +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## ConnectionMonitorDestination +### Properties +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorParameters ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayCustomError +## ConnectionMonitorSource ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayFrontendIPConfiguration +## ConnectionMonitorTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## Container ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **id**: string: Resource ID. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayHttpListenerPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayProbe +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbeHealthResponseMatch +## DdosProtectionPlanTags ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfiguration +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRequestRoutingRule +## DhcpOptions ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## EndpointService ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **id**: string: A unique identifier of the service being referenced by the interface endpoint. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. - -## ApplicationGatewayRewriteRuleSetPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitConnection ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeering ### Properties -* **headerName**: string: Header name of the header configuration -* **headerValue**: string: Header value of the header configuration +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ApplicationGatewaySku +## ExpressRouteCircuitPeeringConfig ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitPropertiesFormat ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy +* **allowClassicOperations**: bool: Allow classic operations +* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitReference ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayPathRule +## ExpressRouteConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteConnectionId ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteConnectionProperties ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCrossConnectionPeering ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## ApplicationGatewayFirewallExclusion +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **vlanId**: int: The VLAN ID. -## ResourceTags +## ExpressRouteCrossConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ResourceTags +## ExpressRouteGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## AzureFirewallPropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## AzureFirewallApplicationRuleCollection +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. + +## ExpressRouteLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteLinkPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallRCAction +## ExpressRoutePortPropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## AzureFirewallApplicationRule +## FrontendIPConfiguration ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRuleProtocol +## FrontendIPConfigurationPropertiesFormat ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection -## AzureFirewallIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRCAction +## InboundNatRule ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## AzureFirewallNatRule +## InboundNatRulePropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNetworkRuleCollection +## InterfaceEndpoint ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InterfaceEndpointProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. +* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. +* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. +* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## IPConfiguration ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## ResourceTags +## IPConfigurationProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1520,6 +1478,57 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1538,403 +1547,390 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings +## ManagedServiceIdentity ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## AddressSpace +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ResourceTags +## NetworkInterface ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## TunnelConnectionHealth +## NetworkInterfaceDnsSettings ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGateway +## NetworkInterfaceIPConfiguration ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources +* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## NetworkInterfaceTapConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. + +## NetworkInterfaceTapConfigurationPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource + +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VirtualNetworkGatewayIPConfiguration +## OutboundRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -## VirtualNetworkGatewaySku +## OutboundRulePropertiesFormat ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientConfiguration +## P2SVpnGatewayProperties ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. * **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## VpnClientRevokedCertificate +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## VpnClientRevokedCertificatePropertiesFormat +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## VpnClientRootCertificate +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## VpnClientRootCertificatePropertiesFormat +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags +## P2SVpnServerConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration -## ResourceTags +## P2SVpnServerConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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 Parent VirtualWan resource name. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: vpnProtocols for the P2SVpnServerConfiguration. -## DdosProtectionPlanPropertiesFormat +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## DdosProtectionPlanTags +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## ExpressRouteCircuitPropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificate ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitAuthorization +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## AuthorizationPropertiesFormat +## PacketCaptureFilter ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteCircuitPeering +## PacketCaptureParameters ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## ExpressRouteCircuitPeeringPropertiesFormat +## ProbePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **requestPath**: 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. -## ExpressRouteCircuitConnection +## PublicIPAddress ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ExpressRouteCircuitConnectionPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteConnectionId +## PublicIPAddressPropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## Ipv6ExpressRouteCircuitPeeringConfig +## PublicIPAddressSku ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## ExpressRouteCircuitPeeringConfig +## PublicIPPrefixPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **ipPrefix**: string: The allocated Prefix +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## RouteFilter +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## RouteFilterPropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **id**: string: The PublicIPAddress Reference -## RouteFilterRule +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference -### Properties -* **id**: string: Corresponding Express Route Circuit Id. - -## ExpressRouteCrossConnectionPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) - -## ExpressRouteCrossConnectionPeeringProperties -### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteGatewayProperties +## ResourceTags ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## ResourceTags ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## ResourceTags ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnection +## ResourceTags ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnectionProperties +## ResourceTags ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringId +## ResourceTags ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +### Additional Properties +* **Additional Properties Type**: string -## VirtualHubId +## ResourceTags ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRoutePortPropertiesFormat +## ResourceTags ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLink +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkPropertiesFormat +## ResourceTags ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1946,96 +1942,55 @@ ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2052,56 +2007,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2113,129 +2057,189 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## Route ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## ResourceTags +## RouteFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorParameters +## RouteFilterPropertiesFormat ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ConnectionMonitorDestination +## RouteFilterRule ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -## ConnectionMonitorSource +## RouteFilterRulePropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' -## ConnectionMonitorTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PacketCaptureParameters +## RouteTable ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PacketCaptureFilter +## RouteTablePropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PacketCaptureStorageLocation +## SecurityRule ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## P2SVpnGatewayProperties +## SecurityRulePropertiesFormat ### Properties -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## VpnClientConnectionHealth +## ServiceAssociationLink ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -## ResourceTags +## ServiceAssociationLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. -## ResourceTags +## ServiceDelegationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: string[]: Describes the actions permitted to the service upon delegation +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicy ### Properties -* **ipPrefix**: string: The allocated Prefix -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyDefinition ### Properties -* **id**: string: The PublicIPAddress Reference +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixSku +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## ServiceEndpointPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2248,55 +2252,80 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: list of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: list of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. -## HubVirtualNetworkConnection +## VirtualHubRouteTable ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: list of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2316,15 +2345,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2338,89 +2388,47 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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 Parent VirtualWan resource name. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: vpnProtocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2444,10 +2452,13 @@ * **sharedKey**: string: SharedKey for the vpn connection. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. ## VpnSiteProperties ### Properties @@ -2460,14 +2471,3 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/network/microsoft.network/2018-11-01/types.md b/generated/network/microsoft.network/2018-11-01/types.md index afb38de3c4..15eaa25a37 100644 --- a/generated/network/microsoft.network/2018-11-01/types.md +++ b/generated/network/microsoft.network/2018-11-01/types.md @@ -540,49 +540,9 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationGatewayPropertiesFormat +## AddressSpace ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: Trusted Root certificates of the application gateway resource. -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -602,6 +562,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -616,917 +581,916 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHeaderConfiguration ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **headerName**: string: Header name of the header configuration +* **headerValue**: string: Header value of the header configuration -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## PublicIPAddressPropertiesFormat -### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. - -## DdosSettings -### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Delegation +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## InterfaceEndpoint +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## InterfaceEndpointProperties +## ApplicationGatewayPropertiesFormat ### Properties -* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. -* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. -* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. -* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: Authentication certificates of the application gateway resource. +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: Backend address pool of the application gateway resource. +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: Backend http settings of the application gateway resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: Frontend IP addresses of the application gateway resource. +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: Frontend ports of the application gateway resource. +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Subnets of application the gateway resource. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: Http listeners of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: Redirect configurations of the application gateway resource. +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: SSL certificates of the application gateway resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: Trusted Root certificates of the application gateway resource. +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: URL path map of the application gateway resource. +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## EndpointService +## ApplicationGatewayRedirectConfiguration ### Properties -* **id**: string: A unique identifier of the service being referenced by the interface endpoint. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterface +## ApplicationGatewayRedirectConfigurationPropertiesFormat +### Properties +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. + +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources -* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRule ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -## NetworkSecurityGroup +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set + +## ApplicationGatewayRewriteRuleSet +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisks '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisks '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## ResourceTags +## ApplicationGatewaySslPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy -## NetworkInterfaceTapConfiguration +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkTap +## ApplicationGatewayUrlPathMap ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## FrontendIPConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## FrontendIPConfigurationPropertiesFormat +## ApplicationSecurityGroup ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ApplicationSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## IPConfigurationProfile +## AzureFirewallApplicationRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## IPConfigurationProfilePropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceNavigationLink +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ResourceNavigationLinkFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## RouteTable +## AzureFirewallNatRCAction ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection -## RouteTablePropertiesFormat +## AzureFirewallNatRule ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## Route +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## RoutePropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceAssociationLink +## AzureFirewallNetworkRuleCollection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPolicy +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallRCAction ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## ServiceEndpointPolicyDefinition +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceEndpointPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## IpTag +## ConnectionMonitorDestination ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## PublicIPAddressSku +## ConnectionMonitorParameters ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ResourceTags +## ConnectionMonitorSource +### Properties +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. + +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## Container ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayCustomError +## ContainerNetworkInterface ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendIPConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayHttpListener +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayHttpListenerPropertiesFormat +## DdosProtectionPlanTags ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbe +## DdosSettings +### Properties +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayProbePropertiesFormat +## DeviceProperties ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayProbeHealthResponseMatch +## DhcpOptions ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRedirectConfiguration +## EndpointService ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **id**: string: A unique identifier of the service being referenced by the interface endpoint. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ExpressRouteCircuitAuthorization ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. - -## ApplicationGatewayRewriteRuleSetPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitPeeringConfig ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPeeringId ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration -* **headerValue**: string: Header value of the header configuration +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewaySku +## ExpressRouteCircuitPropertiesFormat ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **allowClassicOperations**: bool: Allow classic operations +* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitReference ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitSku ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitStats ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteConnection ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayUrlPathMap +## ExpressRouteConnectionId ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayPathRule +## ExpressRouteCrossConnectionPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCrossConnectionProperties ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteGatewayProperties ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayFirewallExclusion +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ResourceTags +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ResourceTags +## ExpressRouteLink ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallPropertiesFormat +## ExpressRouteLinkPropertiesFormat ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallApplicationRuleCollection +## ExpressRoutePortPropertiesFormat ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FrontendIPConfiguration ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallRCAction +## FrontendIPConfigurationPropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRule +## HubVirtualNetworkConnection ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection -## AzureFirewallApplicationRuleProtocol +## HubVirtualNetworkConnectionProperties ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallIPConfiguration +## InboundNatPool ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRuleCollection +## InboundNatRule ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## AzureFirewallNatRuleCollectionProperties +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRCAction +## InterfaceEndpoint ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNatRule +## InterfaceEndpointProperties ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. +* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. +* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. +* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRuleCollection +## IPConfiguration ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. - -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## AzureFirewallNetworkRule +## IPConfigurationProfile ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## IPConfigurationProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1539,6 +1503,57 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1557,422 +1572,403 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace +## ManagedServiceIdentity ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## ResourceTags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VirtualNetworkGatewaySku +## NetworkInterfacePropertiesFormat ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources +* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## NetworkInterfaceTapConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. + +## NetworkInterfaceTapConfigurationPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource + +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## OutboundRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. + +## OutboundRulePropertiesFormat +### Properties +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VpnClientConfiguration +## P2SVpnGatewayProperties ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. * **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## VpnClientRevokedCertificate +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## VpnClientRevokedCertificatePropertiesFormat +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## VpnClientRootCertificate +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## VpnClientRootCertificatePropertiesFormat +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## P2SVpnServerConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration -## DdosCustomPolicyPropertiesFormat +## P2SVpnServerConfigurationProperties ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: vpnProtocols for the P2SVpnServerConfiguration. -## ProtocolCustomSettingsFormat +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## ResourceTags +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## DdosProtectionPlanPropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificate ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## DdosProtectionPlanTags +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## ExpressRouteCircuitPropertiesFormat +## PacketCaptureFilter ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteCircuitAuthorization +## PacketCaptureParameters ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## AuthorizationPropertiesFormat +## PacketCaptureStorageLocation ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ExpressRouteCircuitPeering +## Probe ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## ExpressRouteCircuitPeeringPropertiesFormat +## ProbePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **requestPath**: 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. -## ExpressRouteCircuitConnection +## ProtocolCustomSettingsFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ExpressRouteCircuitConnectionPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteConnectionId +## PublicIPAddressPropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## Ipv6ExpressRouteCircuitPeeringConfig +## PublicIPAddressSku ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## ExpressRouteCircuitPeeringConfig +## PublicIPPrefixPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **ipPrefix**: string: The allocated Prefix +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## RouteFilter +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## RouteFilterPropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **id**: string: The PublicIPAddress Reference -## RouteFilterRule +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference -### Properties -* **id**: string: Corresponding Express Route Circuit Id. - -## ExpressRouteCrossConnectionPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) - -## ExpressRouteCrossConnectionPeeringProperties +## ResourceTags ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteGatewayProperties +## ResourceTags ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## ResourceTags ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## ResourceTags ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnection +## ResourceTags ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnectionProperties +## ResourceTags ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringId +## ResourceTags ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +### Additional Properties +* **Additional Properties Type**: string -## VirtualHubId +## ResourceTags ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRoutePortPropertiesFormat +## ResourceTags ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLink +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkPropertiesFormat +## ResourceTags ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1984,96 +1980,55 @@ ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2090,56 +2045,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2151,129 +2095,189 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## Route ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## ResourceTags +## RouteFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorParameters +## RouteFilterPropertiesFormat ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ConnectionMonitorDestination +## RouteFilterRule ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -## ConnectionMonitorSource +## RouteFilterRulePropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' -## ConnectionMonitorTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PacketCaptureParameters +## RouteTable ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PacketCaptureFilter +## RouteTablePropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PacketCaptureStorageLocation +## SecurityRule ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## P2SVpnGatewayProperties +## SecurityRulePropertiesFormat ### Properties -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisks '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisks '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## VpnClientConnectionHealth +## ServiceAssociationLink ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -## ResourceTags +## ServiceAssociationLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. -## ResourceTags +## ServiceDelegationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: string[]: Describes the actions permitted to the service upon delegation +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicy ### Properties -* **ipPrefix**: string: The allocated Prefix -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyDefinition ### Properties -* **id**: string: The PublicIPAddress Reference +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixSku +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## ServiceEndpointPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2286,55 +2290,80 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: list of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: list of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. -## HubVirtualNetworkConnection +## VirtualHubRouteTable ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: list of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2354,15 +2383,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2376,89 +2426,47 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: vpnProtocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2482,10 +2490,13 @@ * **sharedKey**: string: SharedKey for the vpn connection. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: list of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. ## VpnSiteProperties ### Properties @@ -2498,14 +2509,3 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/network/microsoft.network/2018-12-01/types.md b/generated/network/microsoft.network/2018-12-01/types.md index 6f64694474..9bdba866b0 100644 --- a/generated/network/microsoft.network/2018-12-01/types.md +++ b/generated/network/microsoft.network/2018-12-01/types.md @@ -552,50 +552,21 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -615,6 +586,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -629,984 +605,929 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHeaderConfiguration ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **headerName**: string: Header name of the header configuration +* **headerValue**: string: Header value of the header configuration -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## Delegation +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## InterfaceEndpoint +## ApplicationGatewayRedirectConfiguration ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## InterfaceEndpointProperties -### Properties -* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. -* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. -* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. -* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## EndpointService +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **id**: string: A unique identifier of the service being referenced by the interface endpoint. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkInterface +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources -* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRule ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## NetworkSecurityGroup +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRewriteRuleCondition ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## SecurityRule +## ApplicationGatewayRewriteRuleSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## SecurityRulePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. -* **priority**: int: 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. -* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ResourceTags +## ApplicationGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## NetworkInterfaceTapConfiguration +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. - -## NetworkInterfaceTapConfigurationPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTap +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewaySslPolicy ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy -## FrontendIPConfiguration +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## FrontendIPConfigurationPropertiesFormat -### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## ResourceTags +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## IPConfigurationProfile +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. - -## IPConfigurationProfilePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## ResourceNavigationLink +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceNavigationLinkFormat +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## RouteTable +## ApplicationSecurityGroup ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## RouteTablePropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## Route +## AuthorizationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## RoutePropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource -## ServiceAssociationLink +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ServiceEndpointPolicy +## AzureFirewallNatRCAction ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection -## ServiceEndpointPolicyPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +## AzureFirewallNatRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicyDefinition +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceEndpointPropertiesFormat +## AzureFirewallNetworkRuleCollection ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## IpTag +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## PublicIPAddressSku +## AzureFirewallPropertiesFormat ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Alert' | 'Allow' | 'Deny' | string: The action type of a rule collection -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayConnectionDraining +## BgpSettings ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayCustomError +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayFrontendIPConfiguration +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayFrontendPort +## ConnectionMonitorSource ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayFrontendPortPropertiesFormat +## ConnectionMonitorTags ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayIPConfiguration +## Container ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat -### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayHttpListenerPropertiesFormat -### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayProbe +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayProbePropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayProbeHealthResponseMatch +## ContainerNetworkInterfaceIpConfiguration ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRedirectConfiguration +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayRequestRoutingRule +## DdosCustomPolicyPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. + +## DdosProtectionPlanTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRewriteRuleSet +## DdosSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## DeviceProperties ### Properties -* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRewriteRule +## DhcpOptions ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRewriteRuleActionSet +## EndpointService ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set +* **id**: string: A unique identifier of the service being referenced by the interface endpoint. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitAuthorization ### Properties -* **headerName**: string: Header name of the header configuration -* **headerValue**: string: Header value of the header configuration +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitConnection ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) -## ApplicationGatewaySku +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitPeeringId ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **allowClassicOperations**: bool: Allow classic operations +* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitReference ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayPathRule +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Local'. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteConnection ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteConnectionId ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewayFirewallExclusion +## ExpressRouteConnectionProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **routingWeight**: int: The routing weight associated to the connection. -## ResourceTags +## ExpressRouteCrossConnectionPeering ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **vlanId**: int: The VLAN ID. -## ApplicationGateway +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ResourceTags +## ExpressRouteGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## WebApplicationFirewallCustomRule +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions -* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## MatchCondition +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **matchValues**: string[] (Required): Match value -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables -* **negationConditon**: bool: Describes if this is negate condition or not -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## MatchVariable +## ExpressRouteLink ### Properties -* **selector**: string: Describes field of the matchVariable collection -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## PolicySettings +## ExpressRouteLinkPropertiesFormat ### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ResourceTags +## ExpressRoutePortPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## ResourceTags +## FrontendIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRuleCollection +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Alert' | 'Allow' | 'Deny' | string: The action type of a rule collection - -## AzureFirewallApplicationRule -### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. - -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallIPConfiguration +## InboundNatPool ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRuleCollection +## InboundNatRule ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## AzureFirewallNatRuleCollectionProperties +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRCAction +## InterfaceEndpoint ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNatRule +## InterfaceEndpointProperties ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. +* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. +* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. +* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRuleCollection +## IPConfiguration ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. - -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## AzureFirewallNetworkRule +## IPConfigurationProfile ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## IPConfigurationProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1619,6 +1540,57 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1637,441 +1609,483 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings +## ManagedServiceIdentity ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## AddressSpace +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ResourceTags +## MatchCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchValues**: string[] (Required): Match value +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables +* **negationConditon**: bool: Describes if this is negate condition or not +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## TunnelConnectionHealth +## MatchVariable ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **selector**: string: Describes field of the matchVariable collection +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VirtualNetworkGatewaySku +## NetworkInterfacePropertiesFormat ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources +* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientConfiguration +## NetworkInterfaceTapConfiguration ### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. + +## NetworkInterfaceTapConfigurationPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource + +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## NetworkSecurityGroupPropertiesFormat +### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## NetworkWatcherPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## OutboundRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. + +## OutboundRulePropertiesFormat +### Properties +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## P2SVpnGatewayProperties +### Properties +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. * **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. + +## P2SVpnServerConfigRadiusClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. + +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## P2SVpnServerConfigRadiusServerRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. + +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. + +## P2SVpnServerConfiguration +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration + +## P2SVpnServerConfigurationProperties +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. -## VpnClientRevokedCertificate +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## VpnClientRevokedCertificatePropertiesFormat +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnClientRootCertificate +## P2SVpnServerConfigVpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## VpnClientRootCertificatePropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DdosCustomPolicyPropertiesFormat +## PacketCaptureFilter ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ProtocolCustomSettingsFormat +## PacketCaptureParameters ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ResourceTags +## PacketCaptureStorageLocation ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## DdosProtectionPlanPropertiesFormat +## PeerExpressRouteCircuitConnection ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat) -## DdosProtectionPlanTags +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ExpressRouteCircuitPropertiesFormat +## PolicySettings ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **allowGlobalReach**: bool: Flag to enable Global Reach on the circuit. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level -## ExpressRouteCircuitAuthorization +## Probe ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat) +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## AuthorizationPropertiesFormat +## ProbePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. -## ExpressRouteCircuitPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat) - -## ExpressRouteCircuitPeeringPropertiesFormat +## ProtocolCustomSettingsFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## ExpressRouteCircuitConnection +## PublicIPAddress ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat) +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ExpressRouteCircuitConnectionPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteConnectionId +## PublicIPAddressPropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## Ipv6ExpressRouteCircuitPeeringConfig +## PublicIPAddressSku ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## ExpressRouteCircuitPeeringConfig +## PublicIPPrefixPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **ipPrefix**: string: The allocated Prefix +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## RouteFilter +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## RouteFilterPropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **id**: string: The PublicIPAddress Reference -## RouteFilterRule +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## RouteFilterRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PeerExpressRouteCircuitConnection +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat) +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## PeerExpressRouteCircuitConnectionPropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitStats +## ResourceTags ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitServiceProviderProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitSku +## ResourceTags ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Local'. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteCrossConnectionProperties +## ResourceTags ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference) -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitReference +## ResourceTags ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeering +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties) +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCrossConnectionPeeringProperties +## ResourceTags ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteGatewayProperties +## ResourceTags ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## ResourceTags ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## ResourceTags ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnection +## ResourceTags ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnectionProperties +## ResourceTags ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **routingWeight**: int: The routing weight associated to the connection. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringId +## ResourceTags ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +### Additional Properties +* **Additional Properties Type**: string -## VirtualHubId +## ResourceTags ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRoutePortPropertiesFormat +## ResourceTags ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLink +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkPropertiesFormat +## ResourceTags ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2083,96 +2097,55 @@ ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): Protocol - TCP, UDP or All -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2189,190 +2162,204 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## Route ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat) -* **type**: string (ReadOnly): Sub Resource type. - -## ContainerNetworkInterfacePropertiesFormat -### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## Container +## RouteFilter ### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ContainerNetworkInterfaceIpConfiguration -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. - -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags +## RouteFilterPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## NetworkWatcherPropertiesFormat +## RouteFilterRule ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -## ResourceTags +## RouteFilterRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **access**: 'Allow' | 'Deny' | string (Required): Indicates whether the traffic is allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' -## ConnectionMonitorParameters +## RoutePropertiesFormat ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ConnectionMonitorDestination +## RouteTable ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorSource +## RouteTablePropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ConnectionMonitorTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PacketCaptureParameters +## SecurityRulePropertiesFormat ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: Array of PacketCaptureFilter -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. Possible values are: 'Inbound and Outbound'. +* **priority**: int: 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. +* **protocol**: '*' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PacketCaptureFilter +## ServiceAssociationLink ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -## PacketCaptureStorageLocation +## ServiceAssociationLinkPropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. -## P2SVpnGatewayProperties +## ServiceDelegationPropertiesFormat ### Properties -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **actions**: string[]: Describes the actions permitted to the service upon delegation +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) -## VpnClientConnectionHealth +## ServiceEndpointPolicy ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## ResourceTags +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **ipPrefix**: string: The allocated Prefix -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | 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'. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ReferencedPublicIpAddress +## ServiceEndpointPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. -## PublicIPPrefixSku +## Subnet ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## ResourceTags +## SubnetPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2385,55 +2372,80 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. -## HubVirtualNetworkConnection +## VirtualHubRouteTable ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual network Gateway connection status +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: PrivateIP allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2453,15 +2465,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2475,89 +2508,47 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): Array of SubResource -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2581,10 +2572,13 @@ * **sharedKey**: string: SharedKey for the vpn connection. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The provisioning state of the resource. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. ## VpnSiteProperties ### Properties @@ -2597,14 +2591,20 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties +## WebApplicationFirewallCustomRule ### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions +* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-02-01/types.md b/generated/network/microsoft.network/2019-02-01/types.md index 3615fb00e3..94817f5018 100644 --- a/generated/network/microsoft.network/2019-02-01/types.md +++ b/generated/network/microsoft.network/2019-02-01/types.md @@ -565,50 +565,21 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -628,6 +599,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -642,996 +618,990 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **port**: int: Frontend port +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHeaderConfiguration ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **headerName**: string: Header name of the header configuration +* **headerValue**: string: Header value of the header configuration -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## Delegation +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## InterfaceEndpoint +## ApplicationGatewayRedirectConfiguration ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## InterfaceEndpointProperties -### Properties -* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. -* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. -* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. -* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## EndpointService +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **id**: string: A unique identifier of the service being referenced by the interface endpoint. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkInterface +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources -* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRule ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## NetworkSecurityGroup +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRewriteRuleCondition ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## SecurityRule +## ApplicationGatewayRewriteRuleSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## SecurityRulePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', 'Icmp', 'Esp', and '*'. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ResourceTags +## ApplicationGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## NetworkInterfaceTapConfiguration +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## VirtualNetworkTap +## ApplicationGatewaySslPolicy ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy + +## ApplicationGatewayTrustedRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## FrontendIPConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## FrontendIPConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## ResourceTags +## ApplicationSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ApplicationSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## IPConfigurationProfile +## AuthorizationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## IPConfigurationProfilePropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceNavigationLink +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ResourceNavigationLinkFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## RouteTable +## AzureFirewallNatRCAction ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection -## RouteTablePropertiesFormat +## AzureFirewallNatRule ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## Route +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## RoutePropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceAssociationLink +## AzureFirewallNetworkRuleCollection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPolicy +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallRCAction ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection -## ServiceEndpointPolicyDefinition +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceEndpointPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## IpTag +## ConnectionMonitorDestination ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## PublicIPAddressSku +## ConnectionMonitorParameters ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ResourceTags +## ConnectionMonitorSource +### Properties +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. + +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## Container +### Properties +* **id**: string: Resource ID. + +## ContainerNetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat -### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayCustomError -### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. - -## ApplicationGatewayFrontendIPConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayHttpListenerPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayProbe +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanTags ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://: -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbeHealthResponseMatch +## DdosSettings ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayRedirectConfiguration +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRequestRoutingRule +## DhcpOptions ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## EndpointService ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **id**: string: A unique identifier of the service being referenced by the interface endpoint. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. - -## ApplicationGatewayRewriteRuleSetPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. - -## ApplicationGatewayRewriteRule -### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. - -## ApplicationGatewayRewriteRuleActionSet -### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set - -## ApplicationGatewayHeaderConfiguration -### Properties -* **headerName**: string: Header name of the header configuration -* **headerValue**: string: Header value of the header configuration +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitConnection ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -## ApplicationGatewaySku +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitPeeringConfig ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **allowClassicOperations**: bool: Allow classic operations +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitReference ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayPathRule +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitSku ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Local'. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitStats ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteConnection ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayFirewallExclusion +## ExpressRouteConnectionId ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ResourceTags +## ExpressRouteConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCrossConnectionPeering ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration -* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGateway +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **vlanId**: int: The VLAN ID. -## ResourceTags +## ExpressRouteCrossConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## WebApplicationFirewallCustomRule +## ExpressRouteGatewayProperties ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions -* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## MatchCondition +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **matchValues**: string[] (Required): Match value -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables -* **negationConditon**: bool: Describes if this is negate condition or not -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## MatchVariable +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **selector**: string: Describes field of the matchVariable collection -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## PolicySettings +## ExpressRouteLink ### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ResourceTags +## ExpressRouteLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ResourceTags +## ExpressRoutePortPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## AzureFirewallPropertiesFormat +## FrontendIPConfiguration ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRuleCollection +## FrontendIPConfigurationPropertiesFormat +### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallApplicationRule +## InboundNatPool ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallApplicationRuleProtocol +## InboundNatPoolPropertiesFormat ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallIPConfiguration +## InboundNatRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## AzureFirewallIPConfigurationPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNatRuleCollection +## InterfaceEndpoint ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [InterfaceEndpointProperties](#interfaceendpointproperties): Properties of the interface endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNatRuleCollectionProperties +## InterfaceEndpointProperties ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **endpointService**: [EndpointService](#endpointservice): Identifies the service being brought into the virtual network. +* **fqdn**: string: A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this interface endpoint. +* **owner**: string (ReadOnly): A read-only property that identifies who created this interface endpoint. +* **provisioningState**: string (ReadOnly): The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNatRCAction +## IPConfiguration ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## AzureFirewallNatRule +## IPConfigurationProfile ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## AzureFirewallNetworkRuleCollection +## IPConfigurationProfilePropertiesFormat ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## IpsecPolicy ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## ResourceTags +## IpTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc -## VirtualNetworkGatewayConnectionPropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## IpsecPolicy +## LoadBalancerSku ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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" +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. ## LocalNetworkGateway ### Properties @@ -1651,280 +1621,263 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings +## ManagedServiceIdentity ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## AddressSpace +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ResourceTags +## MatchCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchValues**: string[] (Required): Match value +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables +* **negationConditon**: bool: Describes if this is negate condition or not +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms -## TunnelConnectionHealth +## MatchVariable ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **selector**: string: Describes field of the matchVariable collection +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable -## VirtualNetworkGateway +## NatGatewayPropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: string: The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string: The resource GUID property of the nat gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. + +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. - -## VpnClientRevokedCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources +* **interfaceEndpoint**: [InterfaceEndpoint](#interfaceendpoint) (ReadOnly): Interface endpoint resource. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientRootCertificate +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DdosCustomPolicyPropertiesFormat -### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ProtocolCustomSettingsFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource -## ResourceTags +## NetworkProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -## DdosProtectionPlanPropertiesFormat +## NetworkSecurityGroup ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosProtectionPlanTags +## NetworkSecurityGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitAuthorization +## OutboundRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -## AuthorizationPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. Possible values are: 'Tcp', 'Udp', and 'All'. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ExpressRouteCircuitPeering +## P2SVpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitConnection +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## ExpressRouteConnectionId +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## Ipv6ExpressRouteCircuitPeeringConfig +## P2SVpnServerConfiguration ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [RouteFilter](#routefilter): Route Filter Resource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration -## ExpressRouteCircuitPeeringConfig +## P2SVpnServerConfigurationProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. -## RouteFilter +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## RouteFilterPropertiesFormat +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## RouteFilterRule +## P2SVpnServerConfigVpnClientRootCertificate ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## RouteFilterRulePropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## ResourceTags +## PacketCaptureFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. + +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -1943,149 +1896,162 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: string (ReadOnly): Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ExpressRouteCircuitStats +## PolicySettings ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level -## ExpressRouteCircuitServiceProviderProperties +## Probe ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -## ExpressRouteCircuitSku +## ProbePropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Local'. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. -## ResourceTags +## ProtocolCustomSettingsFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## ExpressRouteCrossConnectionProperties +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## PublicIPPrefixPropertiesFormat +### Properties +* **ipPrefix**: string: The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. + +## PublicIPPrefixSku ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## ExpressRouteCircuitReference +## ReferencedPublicIpAddress ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **id**: string: The PublicIPAddress Reference. -## ExpressRouteCrossConnectionPeering +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -## ExpressRouteCrossConnectionPeeringProperties +## ResourceNavigationLinkFormat ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. Possible values are: 'Disabled' and 'Enabled' -* **vlanId**: int: The VLAN ID. +* **link**: string: Link to the external resource +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteGatewayProperties +## ResourceTags ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## ResourceTags ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## ResourceTags ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnection +## ResourceTags ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteConnectionProperties +## ResourceTags ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteCircuitPeeringId +## ResourceTags ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +### Additional Properties +* **Additional Properties Type**: string -## VirtualHubId +## ResourceTags ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRoutePortPropertiesFormat +## ResourceTags ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s) -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLink +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkPropertiesFormat +## ResourceTags ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2097,96 +2063,55 @@ ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port" -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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" -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. Possible values are: 'Tcp', 'Udp', and 'All'. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2198,18 +2123,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: string: The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string: The resource GUID property of the nat gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2221,56 +2143,50 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2282,130 +2198,200 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## Route ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource -## ConnectionMonitorDestination +## RouteFilter ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteFilterPropertiesFormat](#routefilterpropertiesformat): Route Filter Resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorSource +## RouteFilterPropertiesFormat ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ConnectionMonitorTags +## RouteFilterRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource -## PacketCaptureParameters +## RouteFilterRulePropertiesFormat ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'] +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. Valid value is: 'Community' -## PacketCaptureFilter +## RoutePropertiesFormat ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## PacketCaptureStorageLocation +## RouteTable ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## P2SVpnGatewayProperties +## RouteTablePropertiesFormat ### Properties -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientConnectionHealth +## SecurityRule ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## ResourceTags +## SecurityRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', 'Icmp', 'Esp', and '*'. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## ResourceTags +## ServiceAssociationLink ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -## PublicIPPrefixPropertiesFormat +## ServiceAssociationLinkPropertiesFormat ### Properties -* **ipPrefix**: string: The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. -## ReferencedPublicIpAddress +## ServiceDelegationPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **actions**: string[]: Describes the actions permitted to the service upon delegation +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) -## PublicIPPrefixSku +## ServiceEndpointPolicy ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. + +## ServiceEndpointPolicyDefinitionPropertiesFormat +### Properties +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **interfaceEndpoints**: [InterfaceEndpoint](#interfaceendpoint)[] (ReadOnly): An array of references to interface endpoints +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2418,55 +2404,81 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. -## HubVirtualNetworkConnection +## VirtualHubRouteTable ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2486,15 +2498,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2508,89 +2541,47 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2615,10 +2606,13 @@ * **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. ## VpnSiteProperties ### Properties @@ -2631,14 +2625,20 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties +## WebApplicationFirewallCustomRule ### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions +* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration +* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-04-01/types.md b/generated/network/microsoft.network/2019-04-01/types.md index a665a2ce02..675f547b4e 100644 --- a/generated/network/microsoft.network/2019-04-01/types.md +++ b/generated/network/microsoft.network/2019-04-01/types.md @@ -601,50 +601,21 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -664,6 +635,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -678,1036 +654,931 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **port**: int: Frontend port. +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHeaderConfiguration ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable private end point on the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable private link service on the subnet. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. - -## Delegation -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. - -## ServiceDelegationPropertiesFormat -### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). - -## IPConfigurationProfile -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. - -## IPConfigurationProfilePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkInterface +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRule ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## PrivateEndpoint +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -## PrivateEndpointProperties +## ApplicationGatewayRewriteRuleCondition ### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## PrivateLinkServiceConnection +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. - -## PrivateLinkServiceConnectionProperties -### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## PrivateLinkServiceConnectionState +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ResourceTags +## ApplicationGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## NetworkInterfaceTapConfiguration +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. - -## NetworkInterfaceTapConfigurationPropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTap +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewaySslPolicy ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## FrontendIPConfiguration +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## FrontendIPConfigurationPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## ApplicationGatewayUrlPathMap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## ResourceTags +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## ResourceNavigationLink +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. - -## ResourceNavigationLinkFormat -### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. - -## RouteTable -### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## RouteTablePropertiesFormat -### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## RoutePropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ServiceAssociationLink +## AzureFirewallApplicationRuleCollection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string: Resource type. - -## ServiceAssociationLinkPropertiesFormat -### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ServiceEndpointPolicy +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource. -## ServiceEndpointPolicyDefinition +## AzureFirewallIPConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallNatRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ServiceEndpointPropertiesFormat +## AzureFirewallNatRule ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## IpTag +## AzureFirewallNatRuleCollection ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## PublicIPAddressSku +## AzureFirewallNatRuleCollectionProperties ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ApplicationGatewayBackendHttpSettings +## AzureFirewallNetworkRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ApplicationGatewayConnectionDraining +## AzureFirewallPropertiesFormat ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -## ApplicationGatewayCustomError +## AzureFirewallRCAction ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ApplicationGatewayFrontendIPConfiguration +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayFrontendPort +## BastionHostIPConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ApplicationGatewayFrontendPortPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port. -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ApplicationGatewayIPConfiguration +## BastionHostPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfigurationPropertiesFormat +## BgpSettings ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayHttpListener +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayProbe +## ConnectionMonitorParameters ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayProbePropertiesFormat +## ConnectionMonitorSource ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayProbeHealthResponseMatch +## ConnectionMonitorTags ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfiguration +## Container ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRule +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayRewriteRuleSet +## ContainerNetworkInterfaceIpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayRewriteRule +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayRewriteRuleActionSet +## DdosCustomPolicyPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayHeaderConfiguration +## DdosProtectionPlanPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRewriteRuleCondition +## DdosProtectionPlanTags ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewaySku +## DdosSettings ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewaySslCertificate +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewaySslCertificatePropertiesFormat +## DeviceProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySslPolicy +## DhcpOptions ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitAuthorization ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayTrustedRootCertificatePropertiesFormat -### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPeeringId ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCircuitPropertiesFormat ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ResourceTags +## ExpressRouteCircuitReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Corresponding Express Route Circuit Id. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGateway +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ResourceTags +## ExpressRouteCircuitStats ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## WebApplicationFirewallCustomRule +## ExpressRouteConnection ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## MatchCondition +## ExpressRouteConnectionId ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Describes if this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## MatchVariable +## ExpressRouteConnectionProperties ### Properties -* **selector**: string: Describes field of the matchVariable collection. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## PolicySettings +## ExpressRouteCrossConnectionPeering ### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ResourceTags +## ExpressRouteCrossConnectionPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ResourceTags +## ExpressRouteCrossConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## AzureFirewallPropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## AzureFirewallApplicationRuleCollection +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## AzureFirewallRCAction +## ExpressRouteLink ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallApplicationRule +## ExpressRouteLinkPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallApplicationRuleProtocol +## ExpressRoutePortPropertiesFormat ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## AzureFirewallIPConfiguration +## FrontendIPConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallIPConfigurationPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNatRuleCollection +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## AzureFirewallNatRuleCollectionProperties +## HubVirtualNetworkConnectionProperties ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRCAction +## InboundNatPool ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -## AzureFirewallNatRule +## InboundNatPoolPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. - -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. - -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -## BastionHostPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## BastionHostIPConfiguration +## IPConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## BastionHostIPConfigurationPropertiesFormat +## IPConfigurationProfile ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## IPConfigurationProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1720,6 +1591,57 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1738,250 +1660,263 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## BgpSettings +## ManagedServiceIdentity ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## AddressSpace +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ResourceTags +## MatchCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Describes if this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## TunnelConnectionHealth +## MatchVariable +### Properties +* **selector**: string: Describes field of the matchVariable collection. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. + +## NatGatewayPropertiesFormat +### Properties +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: string: The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string: The resource GUID property of the nat gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. + +## NatGatewaySku ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## VirtualNetworkGateway +## NetworkInterface ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VpnClientConfiguration +## NetworkInterfacePropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientRevokedCertificate +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VpnClientRootCertificate +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. + +## NetworkSecurityGroup ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## NetworkWatcherPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -## DdosCustomPolicyPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ProtocolCustomSettingsFormat +## P2SVpnGatewayProperties ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## ResourceTags +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## DdosProtectionPlanPropertiesFormat +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## DdosProtectionPlanTags +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitPropertiesFormat +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## ExpressRouteCircuitAuthorization +## P2SVpnServerConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration. -## AuthorizationPropertiesFormat +## P2SVpnServerConfigurationProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. -## ExpressRouteCircuitPeering +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. - -## ExpressRouteCircuitPeeringPropertiesFormat -### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitConnection +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## P2SVpnServerConfigVpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2001,224 +1936,101 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: string (ReadOnly): Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCrossConnectionProperties +## PolicySettings ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -## ExpressRouteCircuitReference +## PrivateEndpoint ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCrossConnectionPeering +## PrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. - -## ExpressRouteCrossConnectionPeeringProperties -### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteGatewayProperties +## PrivateEndpointConnectionProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. - -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds -### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. - -## ExpressRouteConnection -### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. - -## ExpressRouteConnectionProperties +## PrivateEndpointProperties ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. - -## ExpressRouteCircuitPeeringId -### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. - -## VirtualHubId -### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRoutePortPropertiesFormat -### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkServiceConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. - -## ExpressRouteLinkPropertiesFormat -### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateLinkServiceConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## LoadBalancerPropertiesFormat +## PrivateLinkServiceConnectionState ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## InboundNatPool +## PrivateLinkServiceIpConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. - -## InboundNatPoolPropertiesFormat -### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## LoadBalancingRule +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## LoadBalancingRulePropertiesFormat +## PrivateLinkServiceProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of references to the private link service IP configuration. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## OutboundRule +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **subscriptions**: string[]: The list of subscriptions. -## OutboundRulePropertiesFormat +## PrivateLinkServicePropertiesVisibility ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subscriptions**: string[]: The list of subscriptions. ## Probe ### Properties @@ -2237,9 +2049,81 @@ * **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **requestPath**: 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. -## LoadBalancerSku +## ProtocolCustomSettingsFormat ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## PublicIPPrefixPropertiesFormat +### Properties +* **ipPrefix**: string: The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. + +## PublicIPPrefixSku +### Properties +* **name**: 'Standard' | string: Name of a public IP prefix SKU. + +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. ## ResourceTags ### Properties @@ -2251,18 +2135,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: string: The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string: The resource GUID property of the nat gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2274,56 +2155,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2335,81 +2205,70 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2421,56 +2280,40 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkServiceProperties +## ResourceTags ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of references to the private link service IP configuration. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServicePropertiesAutoApproval +## ResourceTags ### Properties -* **subscriptions**: string[]: The list of subscriptions. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceIpConfigurationProperties +## ResourceTags ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnection +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServicePropertiesVisibility +## ResourceTags ### Properties -* **subscriptions**: string[]: The list of subscriptions. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2482,30 +2325,33 @@ ### Additional Properties * **Additional Properties Type**: string -## PublicIPPrefixPropertiesFormat +## ResourceTags ### Properties -* **ipPrefix**: string: The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +### Additional Properties +* **Additional Properties Type**: string -## ReferencedPublicIpAddress +## ResourceTags ### Properties -* **id**: string: The PublicIPAddress Reference. +### Additional Properties +* **Additional Properties Type**: string -## PublicIPPrefixSku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + ## RouteFilterPropertiesFormat ### Properties * **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit ipv6 peerings. @@ -2528,20 +2374,157 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. * **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ResourceTags +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## RouteTable +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceAssociationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string: Resource type. + +## ServiceAssociationLinkPropertiesFormat +### Properties +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. + +## ServiceDelegationPropertiesFormat +### Properties +* **actions**: string[]: Describes the actions permitted to the service upon delegation. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). + +## ServiceEndpointPolicy +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## ServiceEndpointPolicyDefinition +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. + +## ServiceEndpointPolicyDefinitionPropertiesFormat +### Properties +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable private end point on the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable private link service on the subnet. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2554,55 +2537,81 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. -## HubVirtualNetworkConnection +## VirtualHubRouteTable ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2622,15 +2631,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2644,89 +2674,50 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration. - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2752,10 +2743,13 @@ * **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. ## VpnSiteProperties ### Properties @@ -2768,14 +2762,20 @@ * **siteKey**: string: The key for vpn-site that can be used for connections. * **virtualWan**: [SubResource](#subresource): Reference to another subresource. -## DeviceProperties +## WebApplicationFirewallCustomRule ### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-06-01/types.md b/generated/network/microsoft.network/2019-06-01/types.md index 4e0fab6517..6d5982c03e 100644 --- a/generated/network/microsoft.network/2019-06-01/types.md +++ b/generated/network/microsoft.network/2019-06-01/types.md @@ -623,50 +623,21 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: Resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -686,6 +657,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -700,1665 +676,1573 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: string: Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Gets whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. -* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayFrontendPort ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRule +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -* **type**: string (ReadOnly): Type of the resource. +* **port**: int: Frontend port. +* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHeaderConfiguration ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP resource. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: string: The provisioning state of the resource. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## Delegation +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: string: Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: Resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## IPConfigurationProfile +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkSecurityGroup +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## SecurityRule +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## SecurityRulePropertiesFormat +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -## NetworkInterface +## ApplicationGatewayRewriteRuleCondition ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkInterfaceDnsSettings +## ApplicationGatewaySku ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## PrivateEndpoint +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## PrivateEndpointProperties -### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## PrivateLinkServiceConnection +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewaySslPolicy ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## PrivateLinkServiceConnectionState +## ApplicationGatewayTrustedRootCertificate ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## ResourceTags +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. - -## VirtualNetworkTap +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. + +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkTapPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. +* **provisioningState**: string (ReadOnly): The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## FrontendIPConfiguration +## AuthorizationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallApplicationRule ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceTags +## AzureFirewallApplicationRuleCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource. -## ResourceNavigationLink +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ResourceNavigationLinkFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## RouteTable +## AzureFirewallNatRCAction ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## RouteTablePropertiesFormat +## AzureFirewallNatRule ### Properties -* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## Route +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## RoutePropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceAssociationLink +## AzureFirewallNetworkRuleCollection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string: Resource type. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPolicy +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallPublicIPAddress ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **address**: string: Public IP Address value. -## ServiceEndpointPolicyDefinition +## AzureFirewallRCAction +### Properties +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. + +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Gets collection of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Gets outbound rules that use this backend address pool. +* **provisioningState**: string: Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## BastionHostIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ServiceEndpointPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: string: The provisioning state of the resource. -* **service**: string: The type of the endpoint service. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## IpTag +## BastionHostPropertiesFormat ### Properties -* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. -* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PublicIPAddressSku +## BgpSettings ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ResourceTags +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorSource ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayCustomError +## ConnectionMonitorTags ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayFrontendIPConfiguration +## Container ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string: Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port. -* **provisioningState**: string: Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **provisioningState**: string: Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayHttpListenerPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayProbe +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -## ApplicationGatewayProbePropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayProbeHealthResponseMatch +## DdosProtectionPlanPropertiesFormat ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRedirectConfiguration +## DdosProtectionPlanTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DdosSettings ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayRequestRoutingRule +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## DeviceProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string: Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRewriteRuleSet +## DhcpOptions ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitAuthorization ### Properties -* **provisioningState**: string (ReadOnly): Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitConnection ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeering ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitPeeringConfig ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewaySku +## ExpressRouteCircuitPeeringId ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: string: Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitPropertiesFormat ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitReference ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: string: Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: string: Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **primarybytesIn**: int: Gets BytesIn of the peering. +* **primarybytesOut**: int: Gets BytesOut of the peering. +* **secondarybytesIn**: int: Gets BytesIn of the peering. +* **secondarybytesOut**: int: Gets BytesOut of the peering. -## ApplicationGatewayPathRule +## ExpressRouteConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: string: Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ApplicationGatewayFirewallExclusion -### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGateway +## ExpressRouteCrossConnectionPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WebApplicationFirewallCustomRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. - -## MatchCondition -### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Describes if this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. - -## MatchVariable -### Properties -* **selector**: string: Describes field of the matchVariable collection. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. - -## PolicySettings -### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## AzureFirewallPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## AzureFirewallApplicationRuleCollection +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## AzureFirewallApplicationRule +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## AzureFirewallApplicationRuleProtocol +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | string: The protocol type of a Application Rule resource. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## HubIPAddresses +## ExpressRouteLink ### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallPublicIPAddress +## ExpressRouteLinkPropertiesFormat ### Properties -* **address**: string: Public IP Address value. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallIPConfiguration +## ExpressRoutePortPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. -## AzureFirewallIPConfigurationPropertiesFormat +## FirewallPolicyFilterRuleAction ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **type**: 'Alert ' | 'Allow' | 'Deny' | string: The action type of a rule -## AzureFirewallNatRuleCollection +## FirewallPolicyNatRuleAction ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **type**: 'DNAT' | 'SNAT' | string: The action type of a rule -## AzureFirewallNatRuleCollectionProperties +## FirewallPolicyPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +## FirewallPolicyRule +* **Discriminator**: ruleType -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +### Base Properties +* **name**: string: Name of the Rule +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule + +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule * **translatedAddress**: string: The translated address for this NAT rule. * **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. + +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type * **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ResourceTags + +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## BastionHostPropertiesFormat +## FirewallPolicyRuleGroupProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **priority**: int: Priority of the Firewall Policy Rule Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## BastionHostIPConfiguration +## FrontendIPConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## BastionHostIPConfigurationPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound pools URIs that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Inbound rules URIs that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): Gets load balancing rules URIs that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): Read only. Outbound rules URIs that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## HubIPAddresses ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## VirtualNetworkGatewayConnectionPropertiesFormat +## HubVirtualNetworkConnection ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## IpsecPolicy +## HubVirtualNetworkConnectionProperties ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## LocalNetworkGateway +## InboundNatPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## TunnelConnectionHealth +## InboundNatPoolPropertiesFormat ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkGateway +## InboundNatRule ### Properties -* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## VirtualNetworkGatewayIPConfiguration +## IPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## IPConfigurationProfile ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## VirtualNetworkGatewaySku +## IPConfigurationProfilePropertiesFormat ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VpnClientConfiguration +## IPConfigurationPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VpnClientRevokedCertificate +## IpsecPolicy ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## VpnClientRevokedCertificatePropertiesFormat +## IpTag ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **ipTagType**: string: Gets or sets the ipTag type: Example FirstPartyUsage. +* **tag**: string: Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc. -## VpnClientRootCertificate +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VpnClientRootCertificatePropertiesFormat +## LoadBalancerPropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## ResourceTags +## LoadBalancerSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. -## ResourceTags +## LoadBalancingRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## DdosCustomPolicyPropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS custom policy resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ProtocolCustomSettingsFormat +## LocalNetworkGateway ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## LocalNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: string (ReadOnly): The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the LocalNetworkGateway resource. -## DdosProtectionPlanPropertiesFormat +## ManagedServiceIdentity ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## DdosProtectionPlanTags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ExpressRouteCircuitPropertiesFormat +## MatchCondition ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Describes if this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## ExpressRouteCircuitAuthorization +## MatchVariable ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **selector**: string: Describes field of the matchVariable collection. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## AuthorizationPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: string: The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string: The resource GUID property of the nat gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## ExpressRouteCircuitPeering +## NatGatewaySku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitConnection +## NetworkInterfaceIPConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Gets whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string: The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteConnectionId +## NetworkInterfacePropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Gets whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkInterfaceTapConfiguration ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ExpressRouteCircuitPeeringConfig +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **provisioningState**: string (ReadOnly): The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## PeerExpressRouteCircuitConnection +## NetworkProfilePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. + +## NetworkSecurityGroup +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: string (ReadOnly): Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitStats +## NetworkWatcherPropertiesFormat ### Properties -* **primarybytesIn**: int: Gets BytesIn of the peering. -* **primarybytesOut**: int: Gets BytesOut of the peering. -* **secondarybytesIn**: int: Gets BytesIn of the peering. -* **secondarybytesOut**: int: Gets BytesOut of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitServiceProviderProperties +## OutboundRule ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCircuitSku +## OutboundRulePropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. +* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## P2SVpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## ExpressRouteCrossConnectionProperties +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitReference +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## ExpressRouteCrossConnectionPeering +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## ExpressRouteCrossConnectionPeeringProperties +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Gets whether the provider or the customer last modified the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. -## ResourceTags +## P2SVpnServerConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration. -## ExpressRouteGatewayProperties +## P2SVpnServerConfigurationProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## ExpressRouteConnection +## P2SVpnServerConfigVpnClientRootCertificate ### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## ExpressRouteConnectionProperties +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicCertData**: string (Required): The certificate public data. + +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. + +## PacketCaptureParameters +### Properties +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringId +## PacketCaptureStorageLocation ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## VirtualHubId +## PeerExpressRouteCircuitConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Gets name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): Provisioning state of the peer express route circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -## ExpressRoutePortPropertiesFormat +## PolicySettings ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the ExpressRoutePort resource. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -## ExpressRouteLink +## PrivateEndpoint ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateEndpointConnection ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: string (ReadOnly): The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## FirewallPolicyPropertiesFormat +## PrivateEndpointProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## PrivateLinkServiceConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyRuleGroupProperties +## PrivateLinkServiceConnectionProperties ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: Name of the Rule -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## FirewallPolicyFilterRuleAction +## PrivateLinkServiceIpConfiguration ### Properties -* **type**: 'Alert ' | 'Allow' | 'Deny' | string: The action type of a rule +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType +## PrivateLinkServiceIpConfigurationProperties +### Properties +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. +## PrivateLinkServiceProperties +### Properties +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of references to the private link service IP configuration. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +## PrivateLinkServicePropertiesAutoApproval +### Properties +* **subscriptions**: string[]: The list of subscriptions. +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyRuleConditionApplicationProtocol +## Probe ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyNatRuleAction +## ProbePropertiesFormat ### Properties -* **type**: 'DNAT' | 'SNAT' | string: The action type of a rule +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **requestPath**: 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. -## LoadBalancerPropertiesFormat +## ProtocolCustomSettingsFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## InboundNatPool +## PublicIPAddress ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## InboundNatPoolPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP resource. -## LoadBalancingRule +## PublicIPAddressSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## LoadBalancingRulePropertiesFormat +## PublicIPPrefixPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **ipPrefix**: string: The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## OutboundRule +## PublicIPPrefixSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## OutboundRulePropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: string: Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **id**: string: The PublicIPAddress Reference. -## Probe +## ResourceNavigationLink ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## ProbePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: string: Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **requestPath**: 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. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: string (ReadOnly): Provisioning state of the ResourceNavigationLink resource. -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2370,18 +2254,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: string: The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string: The resource GUID property of the nat gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2393,56 +2274,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2454,81 +2324,60 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2540,56 +2389,50 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkServiceProperties +## ResourceTags ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of references to the private link service IP configuration. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Gets an array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServicePropertiesAutoApproval +## ResourceTags ### Properties -* **subscriptions**: string[]: The list of subscriptions. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceIpConfiguration +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceIpConfigurationProperties +## ResourceTags ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnection +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnectionProperties +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServicePropertiesVisibility +## ResourceTags ### Properties -* **subscriptions**: string[]: The list of subscriptions. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2601,30 +2444,33 @@ ### Additional Properties * **Additional Properties Type**: string -## PublicIPPrefixPropertiesFormat +## ResourceTags ### Properties -* **ipPrefix**: string: The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: string: The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +### Additional Properties +* **Additional Properties Type**: string -## ReferencedPublicIpAddress +## ResourceTags ### Properties -* **id**: string: The PublicIPAddress Reference. +### Additional Properties +* **Additional Properties Type**: string -## PublicIPPrefixSku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + ## RouteFilterPropertiesFormat ### Properties * **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit ipv6 peerings. @@ -2647,20 +2493,157 @@ * **provisioningState**: string (ReadOnly): The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'. * **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -## ResourceTags +## RouteTable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## RouteTablePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disableBgpRoutePropagation**: bool: Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: string: The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: string: The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceAssociationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string: Resource type. + +## ServiceAssociationLinkPropertiesFormat +### Properties +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: string (ReadOnly): Provisioning state of the ServiceAssociationLink resource. + +## ServiceDelegationPropertiesFormat +### Properties +* **actions**: string[]: Describes the actions permitted to the service upon delegation. +* **provisioningState**: string (ReadOnly): The provisioning state of the resource. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). + +## ServiceEndpointPolicy +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## ServiceEndpointPolicyDefinition +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. + +## ServiceEndpointPolicyDefinitionPropertiesFormat +### Properties +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: string (ReadOnly): The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: string (ReadOnly): The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: string: The provisioning state of the resource. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: Gets an array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): Gets an array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. +* **provisioningState**: string: The provisioning state of the resource. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: Gets an array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: Gets an array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2673,55 +2656,81 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. +## VirtualHubRoute +### Properties +* **addressPrefixes**: string[]: List of all addressPrefixes. +* **nextHopIpAddress**: string: NextHop ip address. + ## VirtualHubRouteTable ### Properties * **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. -## VirtualHubRoute +## VirtualNetworkGateway ### Properties -* **addressPrefixes**: string[]: List of all addressPrefixes. -* **nextHopIpAddress**: string: NextHop ip address. +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGatewayConnection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnection +## VirtualNetworkGatewayIPConfiguration ### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. - -## HubVirtualNetworkConnectionProperties -### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: string (ReadOnly): The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: string (ReadOnly): The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resource GUID property of the VirtualNetworkGateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2741,15 +2750,36 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: string: The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: string (ReadOnly): The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the virtual network tap. ## VirtualWanProperties ### Properties @@ -2763,89 +2793,50 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration. - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: string (ReadOnly): The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **provisioningState**: string (ReadOnly): The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2872,6 +2863,32 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. +## VpnGatewayProperties +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnSiteLink +### Properties +* **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. +* **type**: string (ReadOnly): Resource type. + ## VpnSiteLinkConnection ### Properties * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. @@ -2897,10 +2914,12 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VpnSiteLinkProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. +* **ipAddress**: string: The ip-address for the vpn-site-link. +* **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VpnSiteProperties ### Properties @@ -2914,39 +2933,20 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## VpnSiteLink +## WebApplicationFirewallCustomRule ### Properties +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. * **etag**: string (ReadOnly): Gets a unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. -* **type**: string (ReadOnly): Resource type. - -## VpnSiteLinkProperties -### Properties -* **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. -* **ipAddress**: string: The ip-address for the vpn-site-link. -* **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## VpnLinkBgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. - -## VpnLinkProviderProperties -### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: Gets name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: string (ReadOnly): Provisioning state of the WebApplicationFirewallPolicy. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-07-01/types.md b/generated/network/microsoft.network/2019-07-01/types.md index a92d668967..a72f90e91c 100644 --- a/generated/network/microsoft.network/2019-07-01/types.md +++ b/generated/network/microsoft.network/2019-07-01/types.md @@ -646,50 +646,21 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -709,6 +680,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -723,1060 +699,1028 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource -### Properties -* **id**: string: Resource ID. - -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayHeaderConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP address resource. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. - -## Delegation -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. - -## ServiceDelegationPropertiesFormat -### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). - -## IPConfigurationProfile -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## NetworkSecurityGroup -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkInterface +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRule ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## PrivateEndpoint +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -## PrivateEndpointProperties +## ApplicationGatewayRewriteRuleCondition ### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## PrivateLinkServiceConnection +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ResourceTags +## ApplicationGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## NetworkInterfaceTapConfiguration +## ApplicationGatewaySslCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## VirtualNetworkTap +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## FrontendIPConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## FrontendIPConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## ResourceNavigationLink +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## ResourceNavigationLinkFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## RouteTable +## AuthorizationPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RouteTablePropertiesFormat +## AzureFirewallApplicationRule ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## Route +## AzureFirewallApplicationRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## RoutePropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## ServiceAssociationLink +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string: Resource type. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ServiceEndpointPolicy +## AzureFirewallNatRCAction ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNatRule ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicyDefinition +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceEndpointPropertiesFormat +## AzureFirewallNetworkRuleCollection ### Properties -* **locations**: string[]: A list of locations. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. + +## AzureFirewallNetworkRuleCollectionPropertiesFormat +### Properties +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## IpTag +## AzureFirewallPropertiesFormat ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddressSku +## AzureFirewallPublicIPAddress ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **address**: string: Public IP Address value. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayCustomError -### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ApplicationGatewayFrontendIPConfiguration +## BastionHostIPConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ApplicationGatewayFrontendPortPropertiesFormat +## BastionHostPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## BgpSettings ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayIPConfigurationPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayHttpListener +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayProbe +## ConnectionMonitorSource ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayProbePropertiesFormat +## ConnectionMonitorTags ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbeHealthResponseMatch +## Container ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **id**: string: Resource ID. -## ApplicationGatewayRedirectConfiguration +## ContainerNetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayRedirectConfigurationPropertiesFormat -### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRule +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayRewriteRuleSet +## ContainerNetworkInterfaceIpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayRewriteRuleActionSet +## DdosCustomPolicyPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayHeaderConfiguration +## DdosProtectionPlanPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRewriteRuleCondition +## DdosProtectionPlanTags ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewaySku +## DdosSettings ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewaySslCertificate +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewaySslCertificatePropertiesFormat +## DeviceProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySslPolicy +## DhcpOptions ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitAuthorization ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewayTrustedRootCertificatePropertiesFormat -### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeering ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ApplicationGatewayFirewallExclusion -### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ResourceTags +## ExpressRouteCircuitPeeringId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The ID of the ExpressRoute circuit peering. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## ApplicationGateway -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ResourceTags +## ExpressRouteCircuitPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## WebApplicationFirewallCustomRule +## ExpressRouteCircuitReference ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. +* **id**: string: Corresponding Express Route Circuit Id. -## MatchCondition +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Describes if this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## MatchVariable +## ExpressRouteCircuitSku ### Properties -* **selector**: string: Describes field of the matchVariable collection. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## PolicySettings +## ExpressRouteCircuitStats ### Properties -* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ResourceTags +## ExpressRouteConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## AzureFirewallPropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **routingWeight**: int: The routing weight associated to the connection. -## AzureFirewallApplicationRuleCollection +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## AzureFirewallApplicationRule +## ExpressRouteCrossConnectionProperties ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## AzureFirewallApplicationRuleProtocol +## ExpressRouteGatewayProperties ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## HubIPAddresses +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## AzureFirewallPublicIPAddress +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **address**: string: Public IP Address value. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## AzureFirewallIPConfiguration +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. - -## AzureFirewallIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallNatRuleCollection +## ExpressRouteLinkMacSecConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## AzureFirewallNatRuleCollectionProperties +## ExpressRouteLinkPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallNatRCAction +## ExpressRoutePortPropertiesFormat ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the express route port resource. + +## FirewallPolicyFilterRuleAction ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **type**: 'Alert ' | 'Allow' | 'Deny' | string: The action type of a rule. + +## FirewallPolicyNatRuleAction +### Properties +* **type**: 'DNAT' | 'SNAT' | string: The action type of a rule. + +## FirewallPolicyPropertiesFormat +### Properties +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. + +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. + +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. * **translatedAddress**: string: The translated address for this NAT rule. * **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection + +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType + +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. + +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. + + +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. + +## FirewallPolicyRuleGroupProperties +### Properties +* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. + +## FrontendIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## HubIPAddresses ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## ResourceTags +## HubVirtualNetworkConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## BastionHostPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## BastionHostIPConfiguration +## InboundNatPool ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## BastionHostIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ResourceTags +## InboundNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. + +## IPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationProfile +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. + +## IPConfigurationProfilePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## IpsecPolicy ### Properties @@ -1789,6 +1733,58 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + ## LocalNetworkGateway ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -1807,256 +1803,271 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string: The resource GUID property of the local network gateway resource. -## BgpSettings +## ManagedServiceIdentity ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## AddressSpace +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ResourceTags +## MatchCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Describes if this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## TrafficSelectorPolicy +## MatchVariable ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format +* **selector**: string: Describes field of the matchVariable collection. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## TunnelConnectionHealth +## NatGatewayPropertiesFormat ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string: The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## VirtualNetworkGateway +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## VirtualNetworkGatewaySku +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VpnClientConfiguration +## NetworkInterfacePropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientRevokedCertificate +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VpnClientRootCertificate +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. + +## NetworkSecurityGroup ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## NetworkWatcherPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## DdosCustomPolicyPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ProtocolCustomSettingsFormat +## P2SVpnGatewayProperties ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -## ResourceTags +## P2SVpnServerConfigRadiusClientRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. -## DdosProtectionPlanPropertiesFormat +## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **thumbprint**: string: The Radius client root certificate thumbprint. -## DdosProtectionPlanTags +## P2SVpnServerConfigRadiusServerRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitPropertiesFormat +## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **publicCertData**: string (Required): The certificate public data. -## ExpressRouteCircuitAuthorization +## P2SVpnServerConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration. -## AuthorizationPropertiesFormat +## P2SVpnServerConfigurationProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **name**: string: 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. +* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. +* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. +* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. +* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. -## ExpressRouteCircuitPeering +## P2SVpnServerConfigVpnClientRevokedCertificate ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## ExpressRouteCircuitConnection +## P2SVpnServerConfigVpnClientRootCertificate ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2076,334 +2087,200 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference -### Properties -* **id**: string: Corresponding Express Route Circuit Id. - -## ExpressRouteCrossConnectionPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. - -## ExpressRouteCrossConnectionPeeringProperties -### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteGatewayProperties -### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. - -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. - -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds -### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. - -## ExpressRouteConnection -### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. - -## ExpressRouteConnectionProperties +## PolicySettings ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +* **enabledState**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -## ExpressRouteCircuitPeeringId +## PrivateEndpoint ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateEndpointConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PrivateEndpointProperties ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the express route port resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkServiceConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceConnectionProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ExpressRouteLinkMacSecConfig +## PrivateLinkServiceConnectionState ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## PrivateLinkServiceIpConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyRuleGroupProperties +## PrivateLinkServiceProperties ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyFilterRuleAction +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **type**: 'Alert ' | 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType - -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. - -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. - +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyRuleConditionApplicationProtocol +## PrivateLinkServicePropertiesVisibility ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyNatRuleAction +## Probe ### Properties -* **type**: 'DNAT' | 'SNAT' | string: The action type of a rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerPropertiesFormat +## ProbePropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +* **requestPath**: 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. -## InboundNatPool +## ProtocolCustomSettingsFormat +### Properties +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## InboundNatPoolPropertiesFormat +## PublicIPAddressDnsSettings ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP address resource. -## LoadBalancingRule +## PublicIPAddressSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## LoadBalancingRulePropertiesFormat +## PublicIPPrefixPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **ipPrefix**: string: The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## OutboundRule +## PublicIPPrefixSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## OutboundRulePropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **id**: string: The PublicIPAddress Reference. -## Probe +## ResourceNavigationLink ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## ProbePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2415,18 +2292,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string: The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2438,56 +2312,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2499,81 +2362,60 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **p2SVpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2585,56 +2427,55 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkServiceProperties +## ResourceTags ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServicePropertiesAutoApproval +## ResourceTags ### Properties -* **subscriptions**: string[]: The list of subscriptions. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceIpConfigurationProperties +## ResourceTags ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnection +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointConnectionProperties +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServicePropertiesVisibility +## ResourceTags ### Properties -* **subscriptions**: string[]: The list of subscriptions. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2646,30 +2487,33 @@ ### Additional Properties * **Additional Properties Type**: string -## PublicIPPrefixPropertiesFormat +## ResourceTags ### Properties -* **ipPrefix**: string: The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +### Additional Properties +* **Additional Properties Type**: string -## ReferencedPublicIpAddress +## ResourceTags ### Properties -* **id**: string: The PublicIPAddress Reference. +### Additional Properties +* **Additional Properties Type**: string -## PublicIPPrefixSku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Route +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + ## RouteFilterPropertiesFormat ### Properties * **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit ipv6 peerings. @@ -2692,20 +2536,162 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## RouteTable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## RouteTablePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## SecurityRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. + +## SecurityRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. + +## ServiceAssociationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string: Resource type. + +## ServiceAssociationLinkPropertiesFormat +### Properties +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ServiceDelegationPropertiesFormat +### Properties +* **actions**: string[]: Describes the actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). + +## ServiceEndpointPolicy +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## ServiceEndpointPolicyDefinition +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. + +## ServiceEndpointPolicyDefinitionPropertiesFormat +### Properties +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. + +## Subnet +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. + +## TrafficSelectorPolicy +### Properties +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2718,39 +2704,101 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. +## VirtualHubRoute +### Properties +* **addressPrefixes**: string[]: List of all addressPrefixes. +* **nextHopIpAddress**: string: NextHop ip address. + ## VirtualHubRouteTable ### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + +## VirtualNetworkGateway +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. + +## VirtualNetworkGatewayIPConfiguration +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. + +## VirtualNetworkGatewayIPConfigurationPropertiesFormat +### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## VirtualNetworkGatewayPropertiesFormat +### Properties +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## VirtualHubRoute +## VirtualNetworkGatewaySku ### Properties -* **addressPrefixes**: string[]: List of all addressPrefixes. -* **nextHopIpAddress**: string: NextHop ip address. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. -## HubVirtualNetworkConnection +## VirtualNetworkPeering ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkPeeringPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -2764,37 +2812,30 @@ * **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. * **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. - -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -2805,17 +2846,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -2828,89 +2858,50 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## P2SVpnServerConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigurationProperties](#p2svpnserverconfigurationproperties): Parameters for P2SVpnServerConfiguration. - -## P2SVpnServerConfigurationProperties -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: 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. -* **p2SVpnGateways**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SVpnGateways. -* **p2SVpnServerConfigRadiusClientRootCertificates**: [P2SVpnServerConfigRadiusClientRootCertificate](#p2svpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigRadiusServerRootCertificates**: [P2SVpnServerConfigRadiusServerRootCertificate](#p2svpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRevokedCertificates**: [P2SVpnServerConfigVpnClientRevokedCertificate](#p2svpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of P2SVpnServerConfiguration. -* **p2SVpnServerConfigVpnClientRootCertificates**: [P2SVpnServerConfigVpnClientRootCertificate](#p2svpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of P2SVpnServerConfiguration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **radiusServerAddress**: string: The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. -* **radiusServerSecret**: string: The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for P2SVpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificate -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat](#p2svpnserverconfigradiusclientrootcertificatepropertiesformat): Properties of the Radius client root certificate of P2SVpnServerConfiguration. - -## P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## P2SVpnServerConfigRadiusServerRootCertificate +## VpnClientConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat](#p2svpnserverconfigradiusserverrootcertificatepropertiesformat) (Required): Properties of Radius Server root certificate of P2SVpnServerConfiguration. +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat +## VpnClientConnectionHealth ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. -## P2SVpnServerConfigVpnClientRevokedCertificate +## VpnClientRevokedCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat +## VpnClientRevokedCertificatePropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **thumbprint**: string: The revoked VPN client certificate thumbprint. -## P2SVpnServerConfigVpnClientRootCertificate +## VpnClientRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat](#p2svpnserverconfigvpnclientrootcertificatepropertiesformat) (Required): Properties of VPN client root certificate of P2SVpnServerConfiguration. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. -## P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat +## VpnClientRootCertificatePropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **publicCertData**: string (Required): The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnGatewayProperties -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. - ## VpnConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -2937,6 +2928,32 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. +## VpnGatewayProperties +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnSiteLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. +* **type**: string (ReadOnly): Resource type. + ## VpnSiteLinkConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -2962,10 +2979,12 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VpnSiteLinkProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. +* **ipAddress**: string: The ip-address for the vpn-site-link. +* **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VpnSiteProperties ### Properties @@ -2979,39 +2998,20 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## VpnSiteLink +## WebApplicationFirewallCustomRule ### Properties +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. -* **type**: string (ReadOnly): Resource type. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. -## VpnSiteLinkProperties +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -* **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. -* **ipAddress**: string: The ip-address for the vpn-site-link. -* **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## VpnLinkBgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. - -## VpnLinkProviderProperties -### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-08-01/types.md b/generated/network/microsoft.network/2019-08-01/types.md index b194a93f3b..221c32873f 100644 --- a/generated/network/microsoft.network/2019-08-01/types.md +++ b/generated/network/microsoft.network/2019-08-01/types.md @@ -648,50 +648,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string: The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -711,6 +688,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. @@ -725,1108 +707,1097 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string: Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource -### Properties -* **id**: string: Resource ID. - -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string: Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayHeaderConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string: The resource GUID property of the public IP address resource. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string: Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string: Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string: Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. - -## Delegation -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties -* **actions**: string[]: Describes the actions permitted to the service upon delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). - -## IPConfigurationProfile -### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string: The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkSecurityGroup +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string: Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## SecurityRule +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string: Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterface +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string: The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool: Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRuleCondition ### Properties -* **appliedDnsServers**: 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: 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. -* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## PrivateEndpoint +## ApplicationGatewayRewriteRuleSet ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## PrivateEndpointProperties +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## PrivateLinkServiceConnection +## ApplicationGatewaySku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewaySslCertificate ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string: Type of the resource. -## PrivateLinkServiceConnectionState +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## ResourceTags +## ApplicationGatewaySslPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string: Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string: Type of the resource. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## FrontendIPConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## FrontendIPConfigurationPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceTags +## AzureFirewallApplicationRuleCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceNavigationLink +## AzureFirewallApplicationRuleCollectionPropertiesFormat +### Properties +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. + +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## ResourceNavigationLinkFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## RouteTable +## AzureFirewallNatRCAction ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## RouteTablePropertiesFormat +## AzureFirewallNatRule ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## Route +## AzureFirewallNatRuleCollection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## RoutePropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ServiceAssociationLink +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string: Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. + +## AzureFirewallPropertiesFormat +### Properties +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ServiceEndpointPolicy +## AzureFirewallPublicIPAddress ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Public IP Address value. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallRCAction ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ServiceEndpointPolicyDefinition +## AzureFirewallSku +### Properties +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Standard' | string: Tier of an Azure Firewall. + +## BackendAddressPool ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## BastionHostIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ServiceEndpointPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **locations**: string[]: A list of locations. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## IpTag +## BastionHostPropertiesFormat ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PublicIPAddressSku +## BgpSettings ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ResourceTags +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorDestination ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string: Type of the resource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorSource ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayCustomError +## ConnectionMonitorTags ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayFrontendIPConfiguration +## Container ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string: Type of the resource. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string: Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayHttpListenerPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayProbe +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string: Type of the resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanTags ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbeHealthResponseMatch +## DdosSettings ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayRedirectConfiguration +## Delegation ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string: Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRequestRoutingRule +## DhcpOptions ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string: Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitAuthorization ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. - -## ApplicationGatewayRewriteRule -### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPeering ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeeringConfig ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitPeeringId ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewaySku +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitPropertiesFormat ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string: Type of the resource. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string: Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitReference ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string: Type of the resource. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitSku ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string: Type of the resource. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewayPathRule +## ExpressRouteConnection ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string: Type of the resource. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteConnectionId ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteConnectionProperties ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **authorizationKey**: string: Authorization key to establish the connection. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCrossConnectionPeering ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string: Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ResourceTags +## ExpressRouteCrossConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGateway +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ResourceTags +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## WebApplicationFirewallCustomRule +## ExpressRouteLink ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## MatchCondition +## ExpressRouteLinkMacSecConfig ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Describes if this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## MatchVariable +## ExpressRouteLinkPropertiesFormat ### Properties -* **selector**: string: Describes field of the matchVariable collection. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ManagedRulesDefinition +## ExpressRoutePortPropertiesFormat ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: Describes the Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): Describes the ruleSets that are associated with the policy. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the express route port resource. -## OwaspCrsExclusionEntry +## FirewallPolicyFilterRuleAction ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ManagedRuleSet +## FirewallPolicyNatRuleAction ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **type**: 'DNAT' | string: The action type of a rule. -## ManagedRuleGroupOverride +## FirewallPolicyPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -## ManagedRuleOverride -### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: Describes the state of the managed rule. Defaults to Disabled if not specified. +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. + +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + + +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType + +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. -## PolicySettings -### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## ResourceTags +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## AzureFirewallPropertiesFormat +## FirewallPolicyRuleGroupProperties ### Properties -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **priority**: int: Priority of the Firewall Policy Rule Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## AzureFirewallApplicationRuleCollection +## FrontendIPConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. - -## AzureFirewallApplicationRule -### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. - -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## HubIPAddresses ### Properties * **privateIPAddress**: string: Private IP Address associated with azure firewall. * **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress -### Properties -* **address**: string: Public IP Address value. - -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## AzureFirewallIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## AzureFirewallNetworkRule +## IPConfiguration ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## AzureFirewallSku +## IPConfigurationProfile ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Standard' | string: Tier of an Azure Firewall. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## IPConfigurationProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## BastionHostPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## BastionHostIPConfiguration +## IpsecPolicy ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## BastionHostIPConfigurationPropertiesFormat +## IpTag ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## ResourceTags +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VirtualNetworkGatewayConnectionPropertiesFormat +## LoadBalancerPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the load balancer resource. -## IpsecPolicy +## LoadBalancerSku ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## LocalNetworkGateway ### Properties @@ -1846,258 +1817,249 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string: The resource GUID property of the local network gateway resource. -## BgpSettings +## ManagedRuleGroupOverride ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **ruleGroupName**: string (Required): Describes the managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## AddressSpace +## ManagedRuleOverride ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: Describes the state of the managed rule. Defaults to Disabled if not specified. -## ResourceTags +## ManagedRulesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: Describes the Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): Describes the ruleSets that are associated with the policy. -## TrafficSelectorPolicy +## ManagedRuleSet ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## TunnelConnectionHealth +## ManagedServiceIdentity ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## VirtualNetworkGateway +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## VirtualNetworkGatewayPropertiesFormat +## MatchCondition ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Describes if this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## VirtualNetworkGatewayIPConfiguration +## MatchVariable ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **selector**: string: Describes field of the matchVariable collection. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int: The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string: The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## VpnClientConfiguration +## NatGatewaySku ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## VpnClientRevokedCertificate +## NetworkInterface ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **appliedDnsServers**: 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: 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. +* **internalFqdn**: string: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VpnClientRootCertificate +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VpnClientRootCertificatePropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +### Properties +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. + +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ResourceTags +## NetworkInterfacePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string: The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool: Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[]: A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## ResourceTags +## NetworkInterfaceTapConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## DdosCustomPolicyPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ProtocolCustomSettingsFormat +## NetworkProfilePropertiesFormat ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosProtectionPlanPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[]: The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. - -## DdosProtectionPlanTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string: The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ExpressRouteCircuitAuthorization +## OutboundRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## AuthorizationPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitPeering +## OwaspCrsExclusionEntry +### Properties +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitConnection +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string: The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2117,334 +2079,283 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats +## PolicySettings ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. -## ExpressRouteCircuitServiceProviderProperties +## PrivateEndpoint ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitSku +## PrivateEndpointConnection ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCrossConnectionProperties +## PrivateEndpointProperties ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteCircuitReference +## PrivateLinkServiceConnection ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteCrossConnectionPeering +## PrivateLinkServiceConnectionProperties +### Properties +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## PrivateLinkServiceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteCrossConnectionPeeringProperties +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string: Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## PrivateLinkServiceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## ExpressRouteGatewayProperties +## PrivateLinkServicePropertiesAutoApproval +### Properties +* **subscriptions**: string[]: The list of subscriptions. + +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. + +## Probe +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. + +## ProbePropertiesFormat ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **requestPath**: 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. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## ProtocolCustomSettingsFormat ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PublicIPAddress ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ExpressRouteConnection +## PublicIPAddressDnsSettings ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## ExpressRouteConnectionProperties +## PublicIPAddressPropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string: The resource GUID property of the public IP address resource. -## ExpressRouteCircuitPeeringId +## PublicIPAddressSku ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## VirtualHubId +## PublicIPPrefixPropertiesFormat ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **ipPrefix**: string: The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. -## ResourceTags +## PublicIPPrefixSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## ExpressRoutePortPropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the express route port resource. +* **id**: string: The PublicIPAddress Reference. -## ExpressRouteLink +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkPropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FirewallPolicyPropertiesFormat +## ResourceTags ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FirewallPolicyRuleGroupProperties +## ResourceTags ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyFilterRuleAction +## ResourceTags ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType - -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. - -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. - +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyRuleConditionApplicationProtocol +## ResourceTags ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyNatRuleAction +## ResourceTags ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2456,18 +2367,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string: The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2479,56 +2387,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[]: List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[]: Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string: A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2540,92 +2437,70 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfigurationProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2637,127 +2512,191 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkServiceProperties +## Route ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -## PrivateLinkServicePropertiesAutoApproval +## RouteFilterPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PrivateLinkServiceIpConfiguration +## RouteFilterRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PrivateLinkServiceIpConfigurationProperties +## RouteFilterRulePropertiesFormat +### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. + +## RoutePropertiesFormat +### Properties +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## RouteTable +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateEndpointConnection +## SecurityRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateEndpointConnectionProperties +## SecurityRulePropertiesFormat ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateLinkServicePropertiesVisibility +## ServiceAssociationLink ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string: Resource type. -## ResourceTags +## ServiceAssociationLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## ServiceDelegationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: string[]: Describes the actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicy ### Properties -* **ipPrefix**: string: The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[]: The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string: The resource GUID property of the public IP prefix resource. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyDefinition ### Properties -* **id**: string: The PublicIPAddress Reference. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixSku +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## ServiceEndpointPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## RouteFilterPropertiesFormat +## ServiceEndpointPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: A collection of references to express route circuit peerings. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **service**: string: The type of the endpoint service. -## RouteFilterRule +## Subnet ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterRulePropertiesFormat +## SubnetPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[]: An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[]: An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2772,61 +2711,90 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. +## VirtualHubRoute +### Properties +* **addressPrefixes**: string[]: List of all addressPrefixes. +* **nextHopIpAddress**: string: NextHop ip address. + ## VirtualHubRouteTable ### Properties * **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. -## VirtualHubRoute +## VirtualNetworkBgpCommunities ### Properties -* **addressPrefixes**: string[]: List of all addressPrefixes. -* **nextHopIpAddress**: string: NextHop ip address. +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network -## HubVirtualNetworkConnection +## VirtualNetworkGateway ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **etag**: string: A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string: The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkBgpCommunities +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int: The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -2846,29 +2814,37 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualRouterPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. -* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. -* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualRouterAsn**: int: VirtualRouter ASN. -* **virtualRouterIps**: string[]: VirtualRouter IPs - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. ## VirtualRouterPeeringProperties ### Properties @@ -2876,6 +2852,15 @@ * **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +## VirtualRouterPropertiesFormat +### Properties +* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. +* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. +* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualRouterAsn**: int: VirtualRouter ASN. +* **virtualRouterIps**: string[]: VirtualRouter IPs + ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -2886,18 +2871,49 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string: A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -2925,35 +2941,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -2972,37 +2986,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3013,29 +2996,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3044,6 +3004,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3051,18 +3036,33 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-09-01/types.md b/generated/network/microsoft.network/2019-09-01/types.md index b687fc45a6..5a80d5bf59 100644 --- a/generated/network/microsoft.network/2019-09-01/types.md +++ b/generated/network/microsoft.network/2019-09-01/types.md @@ -670,50 +670,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -733,6 +710,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -747,1114 +729,1056 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource -### Properties -* **id**: string: Resource ID. - -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayHeaderConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostnames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. - -## Delegation -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayProbePropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): Describes the actions permitted to the service upon delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). - -## IPConfigurationProfile -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## NetworkSecurityGroup +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## SecurityRule +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterface +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -## NetworkInterfaceDnsSettings +## ApplicationGatewayRewriteRuleCondition ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## PrivateEndpoint +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## PrivateEndpointProperties +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## PrivateLinkServiceConnection +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## ResourceTags +## ApplicationGatewaySslPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkTapPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## FrontendIPConfiguration +## ApplicationGatewayWebApplicationFirewallConfiguration +### Properties +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## FrontendIPConfigurationPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceNavigationLink +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## RouteTable -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## Route +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -## RoutePropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceAssociationLink +## AzureFirewallNatRCAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNatRule ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicy +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ServiceEndpointPolicyDefinition +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **locations**: string[]: A list of locations. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## IpTag +## AzureFirewallPublicIPAddress ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **address**: string: Public IP Address value. -## PublicIPAddressSku +## AzureFirewallRCAction ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Standard' | string: Tier of an Azure Firewall. -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayCustomError -### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ApplicationGatewayFrontendIPConfiguration +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ApplicationGatewayFrontendPortPropertiesFormat +## BastionHostPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## BgpSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayIPConfigurationPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayHttpListener +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostnames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -## ApplicationGatewayProbe +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayProbePropertiesFormat +## ConnectionMonitorTags ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbeHealthResponseMatch +## Container ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **id**: string: Resource ID. -## ApplicationGatewayRedirectConfiguration +## ContainerNetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayRedirectConfigurationPropertiesFormat -### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRule +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayRewriteRuleSet +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayRewriteRuleActionSet +## DdosCustomPolicyPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayHeaderConfiguration +## DdosProtectionPlanPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRewriteRuleCondition +## DdosProtectionPlanTags ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewaySku +## DdosSettings ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewaySslCertificate +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewaySslCertificatePropertiesFormat +## DeviceProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySslPolicy +## DhcpOptions ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat -### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPeeringId ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCircuitPropertiesFormat ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ResourceTags +## ExpressRouteCircuitReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Corresponding Express Route Circuit Id. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGateway +## ExpressRouteCircuitSku +### Properties +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. + +## ExpressRouteCircuitStats +### Properties +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. + +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## WebApplicationFirewallCustomRule +## ExpressRouteConnectionProperties +### Properties +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. + +## ExpressRouteCrossConnectionPeering ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## MatchCondition +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Describes if this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## MatchVariable +## ExpressRouteCrossConnectionProperties ### Properties -* **selector**: string: Describes field of the matchVariable collection. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ManagedRulesDefinition +## ExpressRouteGatewayProperties ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: Describes the Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): Describes the ruleSets that are associated with the policy. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## OwaspCrsExclusionEntry +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ManagedRuleSet +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ManagedRuleGroupOverride +## ExpressRouteLink ### Properties -* **ruleGroupName**: string (Required): Describes the managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ManagedRuleOverride +## ExpressRouteLinkMacSecConfig ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: Describes the state of the managed rule. Defaults to Disabled if not specified. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## PolicySettings +## ExpressRouteLinkPropertiesFormat ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ResourceTags +## ExpressRoutePortPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ResourceTags +## FirewallPolicyFilterRuleAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## AzureFirewallPropertiesFormat +## FirewallPolicyNatRuleAction ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **type**: 'DNAT' | string: The action type of a rule. + +## FirewallPolicyPropertiesFormat +### Properties +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. * **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. + +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + + +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType + +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. + +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. + -## AzureFirewallApplicationRuleCollection +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FirewallPolicyRuleGroupProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **priority**: int: Priority of the Firewall Policy Rule Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## AzureFirewallApplicationRule +## FrontendIPConfiguration ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRuleProtocol +## FrontendIPConfigurationPropertiesFormat ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## HubIPAddresses ### Properties * **privateIPAddress**: string: Private IP Address associated with azure firewall. * **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress -### Properties -* **address**: string: Public IP Address value. - -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## AzureFirewallIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. - -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - -## AzureFirewallSku -### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Standard' | string: Tier of an Azure Firewall. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## BastionHostPropertiesFormat +## IPConfiguration ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## BastionHostIPConfiguration +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## BastionHostIPConfigurationPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. ## IpsecPolicy ### Properties @@ -1867,6 +1791,58 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + ## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1885,258 +1861,249 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## BgpSettings +## ManagedRuleGroupOverride ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **ruleGroupName**: string (Required): Describes the managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## AddressSpace +## ManagedRuleOverride ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: Describes the state of the managed rule. Defaults to Disabled if not specified. -## ResourceTags +## ManagedRulesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: Describes the Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): Describes the ruleSets that are associated with the policy. -## TrafficSelectorPolicy +## ManagedRuleSet ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## TunnelConnectionHealth +## ManagedServiceIdentity ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## VirtualNetworkGateway +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## VirtualNetworkGatewayPropertiesFormat +## MatchCondition ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Describes if this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): Describes operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## VirtualNetworkGatewayIPConfiguration +## MatchVariable ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **selector**: string: Describes field of the matchVariable collection. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## VpnClientConfiguration +## NatGatewaySku ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## VpnClientRevokedCertificate +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VpnClientRootCertificate +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VpnClientRootCertificatePropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +### Properties +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. + +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference of ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference of LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ResourceTags +## NetworkInterfacePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## ResourceTags +## NetworkInterfaceTapConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## DdosCustomPolicyPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ProtocolCustomSettingsFormat +## NetworkProfilePropertiesFormat ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosProtectionPlanPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. - -## DdosProtectionPlanTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ExpressRouteCircuitAuthorization +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## AuthorizationPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitPeering +## OwaspCrsExclusionEntry +### Properties +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitConnection +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference of AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2156,346 +2123,315 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats +## PolicySettings ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: Describes if it is in detection mode or prevention mode at policy level. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: Describes if the policy is in enabled state or disabled state. -## ExpressRouteCircuitServiceProviderProperties +## PrivateEndpoint ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitSku +## PrivateEndpointConnection ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCrossConnectionProperties +## PrivateEndpointProperties ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteCircuitReference +## PrivateLinkServiceConnection ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteCrossConnectionPeering +## PrivateLinkServiceConnectionProperties +### Properties +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## PrivateLinkServiceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteCrossConnectionPeeringProperties +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## PrivateLinkServiceProperties +### Properties +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. + +## PrivateLinkServicePropertiesAutoApproval +### Properties +* **subscriptions**: string[]: The list of subscriptions. + +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. + +## Probe +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. + +## ProtocolCustomSettingsFormat +### Properties +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -## ResourceTags +## PublicIPAddressSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## ExpressRouteGatewayProperties +## PublicIPPrefixPropertiesFormat ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PublicIPPrefixSku ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## ReferencedPublicIpAddress ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **id**: string: The PublicIPAddress Reference. -## ExpressRouteConnection +## ResourceNavigationLink ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteConnectionProperties +## ResourceNavigationLinkFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. - -## ExpressRouteCircuitPeeringId -### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. - -## VirtualHubId -### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ExpressRoutePortPropertiesFormat -### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. - -## ExpressRouteLink +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkPropertiesFormat +## ResourceTags ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +### Additional Properties +* **Additional Properties Type**: string -## ExpressRouteLinkMacSecConfig +## ResourceTags ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FirewallPolicyPropertiesFormat +## ResourceTags ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FirewallPolicyRuleGroupProperties +## ResourceTags ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyFilterRuleAction +## ResourceTags ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType - -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. - -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. - +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyRuleConditionApplicationProtocol +## ResourceTags ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyNatRuleAction +## ResourceTags ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +### Additional Properties +* **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2507,18 +2443,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2530,56 +2463,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2591,226 +2513,241 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination) (Required): Describes the destination of connection monitor. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource) (Required): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): Describes the storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfiguration +## Route ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -## P2SConnectionConfigurationProperties +## RouteFilterPropertiesFormat ### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## VpnClientConnectionHealth +## RouteFilterRule ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## ResourceTags +## RouteFilterRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServiceProperties +## RouteTable ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PrivateLinkServicePropertiesAutoApproval +## RouteTablePropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServiceIpConfiguration +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServiceIpConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateEndpointConnection +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ServiceDelegationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **actions**: string[] (ReadOnly): Describes the actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. - -## ReferencedPublicIpAddress -### Properties -* **id**: string: The PublicIPAddress Reference. - -## PublicIPPrefixSku -### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## ServiceEndpointPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## RouteFilterPropertiesFormat +## ServiceEndpointPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **service**: string: The type of the endpoint service. -## RouteFilterRule +## Subnet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterRulePropertiesFormat +## SubnetPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2827,15 +2764,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -2856,30 +2793,99 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## HubVirtualNetworkConnection +## VirtualNetworkBgpCommunities +### Properties +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. + +## VirtualNetworkGateway +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. + +## VirtualNetworkGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. + +## VirtualNetworkPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. + +## VirtualNetworkPeeringPropertiesFormat +### Properties +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -2890,46 +2896,34 @@ * **enableDdosProtection**: bool: 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. * **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. - -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -2940,17 +2934,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -2962,18 +2945,49 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3001,35 +3015,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3048,37 +3060,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3089,29 +3070,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3120,6 +3078,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3127,18 +3110,35 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): Describes type of rule. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: Describes custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-11-01/types.md b/generated/network/microsoft.network/2019-11-01/types.md index c0f09b3b11..d44601f7a7 100644 --- a/generated/network/microsoft.network/2019-11-01/types.md +++ b/generated/network/microsoft.network/2019-11-01/types.md @@ -682,50 +682,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -745,6 +722,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -759,1771 +741,1730 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource -### Properties -* **id**: string: Resource ID. - -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayHeaderConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## Delegation +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## IPConfigurationProfile +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkSecurityGroup +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## SecurityRule +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## SecurityRulePropertiesFormat +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## NetworkInterface +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkInterfaceDnsSettings +## ApplicationGatewaySku ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## PrivateEndpoint +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointProperties +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## PrivateLinkServiceConnection +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## ApplicationGatewayUrlConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## VirtualNetworkTapPropertiesFormat -### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## FrontendIPConfiguration +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## FrontendIPConfigurationPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceNavigationLink +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## RouteTable -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## Route +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## RoutePropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallIpGroups ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ServiceAssociationLink +## AzureFirewallNatRCAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNatRule ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicy +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ServiceEndpointPolicyDefinition +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **locations**: string[]: A list of locations. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## IpTag +## AzureFirewallPublicIPAddress ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **address**: string: Public IP Address value. -## PublicIPAddressSku +## AzureFirewallRCAction ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Standard' | string: Tier of an Azure Firewall. -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationGatewayConnectionDraining +## BastionHostIPConfiguration ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ApplicationGatewayCustomError -### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. - -## ApplicationGatewayFrontendIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayFrontendPort -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ApplicationGatewayFrontendPortPropertiesFormat +## BastionHostPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayIPConfigurationPropertiesFormat +## BgpSettings ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayHttpListener +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayProbe +## ConnectionMonitorEndpoint ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. -## ApplicationGatewayProbePropertiesFormat +## ConnectionMonitorEndpointFilter ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ApplicationGatewayProbeHealthResponseMatch +## ConnectionMonitorEndpointFilterItem ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ApplicationGatewayRedirectConfiguration +## ConnectionMonitorHttpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ConnectionMonitorIcmpConfiguration ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ApplicationGatewayRequestRoutingRule +## ConnectionMonitorOutput ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ConnectionMonitorParameters ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ApplicationGatewayRewriteRuleSet +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ConnectionMonitorSuccessThreshold ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ApplicationGatewayRewriteRule +## ConnectionMonitorTags ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRewriteRuleActionSet +## ConnectionMonitorTcpConfiguration ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayHeaderConfiguration +## ConnectionMonitorTestConfiguration ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayUrlConfiguration +## ConnectionMonitorTestGroup ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayRewriteRuleCondition +## ConnectionMonitorWorkspaceSettings ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewaySku +## Container ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **id**: string: Resource ID. -## ApplicationGatewaySslCertificate +## ContainerNetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewaySslCertificatePropertiesFormat +## ContainerNetworkInterfaceConfiguration ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewaySslPolicy +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayTrustedRootCertificate +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayUrlPathMap +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayUrlPathMapPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayPathRule +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayPathRulePropertiesFormat +## DdosProtectionPlanTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayWebApplicationFirewallConfiguration +## DdosSettings ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayFirewallDisabledRuleGroup +## Delegation ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayFirewallExclusion +## DeviceProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ResourceTags +## DhcpOptions ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitAuthorization ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGateway +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## WebApplicationFirewallCustomRule +## ExpressRouteCircuitPeering ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## MatchCondition +## ExpressRouteCircuitPeeringConfig ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## MatchVariable +## ExpressRouteCircuitPeeringId ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ManagedRulesDefinition +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## OwaspCrsExclusionEntry +## ExpressRouteCircuitPropertiesFormat ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting Global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ManagedRuleSet +## ExpressRouteCircuitReference ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **id**: string: Corresponding Express Route Circuit Id. -## ManagedRuleGroupOverride +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ManagedRuleOverride +## ExpressRouteCircuitSku ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## PolicySettings +## ExpressRouteCircuitStats ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ResourceTags +## ExpressRouteConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## AzureFirewallPropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. - -## AzureFirewallAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **routingWeight**: int: The routing weight associated to the connection. -## AzureFirewallApplicationRuleCollection +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. - -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## AzureFirewallApplicationRule +## ExpressRouteCrossConnectionProperties ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## AzureFirewallApplicationRuleProtocol +## ExpressRouteGatewayProperties ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## HubIPAddresses +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## AzureFirewallPublicIPAddress +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **address**: string: Public IP Address value. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## AzureFirewallIPConfiguration +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## AzureFirewallIPConfigurationPropertiesFormat +## ExpressRouteLinkMacSecConfig ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## AzureFirewallIpGroups +## ExpressRouteLinkPropertiesFormat ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallNatRuleCollection +## ExpressRoutePortPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## AzureFirewallNatRuleCollectionProperties +## FirewallPolicyFilterRuleAction ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## AzureFirewallNatRCAction +## FirewallPolicyNatRuleAction ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **type**: 'DNAT' | string: The action type of a rule. -## AzureFirewallNatRule +## FirewallPolicyPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. + +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. + +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. * **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. * **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. + +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## AzureFirewallSku + +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Standard' | string: Tier of an Azure Firewall. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## ResourceTags +## FirewallPolicyRuleGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## BastionHostPropertiesFormat +## FlowLogFormatParameters ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. + +## FlowLogPropertiesFormat +### Properties +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## BastionHostIPConfiguration +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## BastionHostIPConfigurationPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## HttpHeader ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## IpsecPolicy +## HubIPAddresses ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## LocalNetworkGateway +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## LocalNetworkGatewayPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## BgpSettings +## InboundNatPool ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AddressSpace +## InboundNatPoolPropertiesFormat ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## InboundNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## TrafficSelectorPolicy +## InboundNatRulePropertiesFormat ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## TunnelConnectionHealth +## IPConfiguration ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGateway +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## VirtualNetworkGatewayPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayIPConfiguration +## IPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkGatewaySku +## IpsecPolicy ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## VpnClientConfiguration +## IpTag ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VpnClientRevokedCertificate +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VpnClientRevokedCertificatePropertiesFormat +## LoadBalancerPropertiesFormat ### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## VpnClientRootCertificate +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VpnClientRootCertificatePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. -## ResourceTags +## LocalNetworkGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## LocalNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## DdosCustomPolicyPropertiesFormat +## ManagedRuleGroupOverride ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ProtocolCustomSettingsFormat +## ManagedRuleOverride ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## ResourceTags +## ManagedRulesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## DdosProtectionPlanPropertiesFormat +## ManagedRuleSet ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## DdosProtectionPlanTags +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ExpressRouteCircuitPropertiesFormat +## MatchCondition ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting Global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## ExpressRouteCircuitAuthorization +## MatchVariable ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## AuthorizationPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## ExpressRouteCircuitPeering +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitConnection +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. - -## ExpressRouteCircuitConnectionPropertiesFormat -### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## ExpressRouteConnectionId +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteCircuitPeeringConfig +## NetworkInterfacePropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## PeerExpressRouteCircuitConnection +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku +## NetworkProfilePropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCrossConnectionProperties +## NetworkSecurityGroupPropertiesFormat ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitReference +## NetworkWatcherPropertiesFormat ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCrossConnectionPeering +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCrossConnectionPeeringProperties +## OutboundRulePropertiesFormat ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. -## ResourceTags +## OwaspCrsExclusionEntry ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteGatewayProperties +## P2SConnectionConfiguration +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. + +## P2SConnectionConfigurationProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## P2SVpnGateway ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## P2SVpnGatewayProperties ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnection +## PacketCaptureFilter ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteConnectionProperties +## PacketCaptureParameters ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringId +## PacketCaptureStorageLocation ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## VirtualHubId +## PeerExpressRouteCircuitConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PolicySettings ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ExpressRouteLink +## PrivateEndpoint ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. - -## ExpressRouteLinkPropertiesFormat -### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkMacSecConfig +## PrivateEndpointConnection ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## FirewallPolicyPropertiesFormat +## PrivateEndpointProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## PrivateLinkServiceConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyRuleGroupProperties +## PrivateLinkServiceConnectionProperties ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## FirewallPolicyRule -* **Discriminator**: ruleType +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. +## PrivateLinkServiceIpConfiguration +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +## PrivateLinkServiceIpConfigurationProperties +### Properties +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +## PrivateLinkServiceProperties +### Properties +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyFilterRuleAction +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. +## Probe +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. +## ProtocolCustomSettingsFormat +### Properties +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## FirewallPolicyRuleConditionApplicationProtocol +## PublicIPAddress ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FirewallPolicyNatRuleAction +## PublicIPAddressDnsSettings ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## IpGroupPropertiesFormat +## PublicIPAddressPropertiesFormat ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -## ResourceTags +## PublicIPAddressSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## LoadBalancerPropertiesFormat +## PublicIPPrefixPropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## InboundNatPool +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## InboundNatPoolPropertiesFormat +## ReferencedPublicIpAddress ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **id**: string: The PublicIPAddress Reference. -## LoadBalancingRule +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## LoadBalancingRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2535,18 +2476,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2558,56 +2496,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2619,343 +2546,353 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FlowLogPropertiesFormat +## ResourceTags ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. +### Additional Properties +* **Additional Properties Type**: string -## TrafficAnalyticsProperties +## ResourceTags ### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +### Additional Properties +* **Additional Properties Type**: string -## TrafficAnalyticsConfigurationProperties +## ResourceTags ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +### Additional Properties +* **Additional Properties Type**: string -## FlowLogFormatParameters +## ResourceTags ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +### Additional Properties +* **Additional Properties Type**: string -## RetentionPolicyParameters +## ResourceTags ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## RetentionPolicyParameters ### Properties -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. -## P2SConnectionConfiguration +## Route ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -## P2SConnectionConfigurationProperties +## RouteFilterPropertiesFormat ### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## VpnClientConnectionHealth +## RouteFilterRule ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## ResourceTags +## RouteFilterRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ResourceTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServiceProperties +## RouteTable ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PrivateLinkServicePropertiesAutoApproval +## RouteTablePropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServiceIpConfiguration +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServiceIpConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateEndpointConnection +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ServiceDelegationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PublicIPPrefixSku +## ServiceEndpointPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## RouteFilterRule +## SubResource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## RouteFilterRulePropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## ResourceTags +## TrafficAnalyticsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -2972,15 +2909,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3001,30 +2938,99 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## HubVirtualNetworkConnection +## VirtualNetworkBgpCommunities +### Properties +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. + +## VirtualNetworkGateway +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. + +## VirtualNetworkGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. + +## VirtualNetworkPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. + +## VirtualNetworkPeeringPropertiesFormat +### Properties +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -3035,46 +3041,34 @@ * **enableDdosProtection**: bool: 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. * **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. - -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3085,17 +3079,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3107,18 +3090,49 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3146,35 +3160,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3193,37 +3205,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3234,29 +3215,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3265,6 +3223,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3272,18 +3255,35 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2019-12-01/types.md b/generated/network/microsoft.network/2019-12-01/types.md index 204869ae49..024d6e4ba1 100644 --- a/generated/network/microsoft.network/2019-12-01/types.md +++ b/generated/network/microsoft.network/2019-12-01/types.md @@ -696,50 +696,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -759,6 +736,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -773,1180 +755,1198 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource -### Properties -* **id**: string: Resource ID. - -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayHeaderConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. + +## ApplicationGatewayProbePropertiesFormat +### Properties +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## Delegation +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## IPConfigurationProfile +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayRewriteRule +### Properties +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. + +## ApplicationGatewayRewriteRuleActionSet +### Properties +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. + +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## FlowLog +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayUrlConfiguration ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## FlowLogFormatParameters +## ApplicationGatewayUrlPathMap ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## RetentionPolicyParameters +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## NetworkInterface +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## NetworkInterfacePropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## NetworkInterfaceDnsSettings +## AuthorizationPropertiesFormat ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## AzureFirewallAdditionalProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointProperties +## AzureFirewallApplicationRule ### Properties -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## PrivateLinkServiceConnection +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateLinkServiceConnectionProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## NetworkInterfaceTapConfiguration +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkTap +## AzureFirewallIpGroups ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallNatRCAction ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## FrontendIPConfiguration +## AzureFirewallNatRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## ResourceNavigationLink +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## RouteTable -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## Route +## AzureFirewallPublicIPAddress ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **address**: string: Public IP Address value. -## RoutePropertiesFormat +## AzureFirewallRCAction ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Standard' | string: Tier of an Azure Firewall. -## ServiceAssociationLink +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ServiceAssociationLinkPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ServiceEndpointPolicy +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ServiceEndpointPolicyPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ServiceEndpointPolicyDefinition +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BgpSettings ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ResourceTags +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **locations**: string[]: A list of locations. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. + +## ConnectionMonitorEndpoint +### Properties +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. + +## ConnectionMonitorEndpointFilter +### Properties +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. + +## ConnectionMonitorEndpointFilterItem +### Properties +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. + +## ConnectionMonitorHttpConfiguration +### Properties +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". + +## ConnectionMonitorIcmpConfiguration +### Properties +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. + +## ConnectionMonitorOutput +### Properties +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters +### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## IpTag +## ConnectionMonitorSource ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## PublicIPAddressSku +## ConnectionMonitorSuccessThreshold ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorTcpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorTestConfiguration ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorTestGroup ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayCustomError +## ConnectionMonitorWorkspaceSettings ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewayFrontendIPConfiguration +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayHttpListenerPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayProbe +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanTags ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayProbeHealthResponseMatch +## DdosSettings ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayRedirectConfiguration +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRequestRoutingRule +## DhcpOptions +### Properties +* **dnsServers**: string[]: The list of DNS servers IP addresses. + +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitPeering ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPeeringConfig ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeeringId ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayUrlConfiguration +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitPropertiesFormat ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewaySku +## ExpressRouteCircuitReference ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitSku ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitStats ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteConnectionId ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. + +## ExpressRouteConnectionProperties +### Properties +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayUrlPathMap +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayPathRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCrossConnectionProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteGatewayProperties ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayFirewallExclusion +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WebApplicationFirewallPolicyPropertiesFormat -### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## ApplicationGateway +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ResourceTags +## ExpressRouteLinkMacSecConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## WebApplicationFirewallCustomRule +## ExpressRouteLinkPropertiesFormat ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## MatchCondition +## ExpressRoutePortPropertiesFormat ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## MatchVariable +## FirewallPolicyFilterRuleAction ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ManagedRulesDefinition +## FirewallPolicyNatRuleAction ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **type**: 'DNAT' | string: The action type of a rule. -## OwaspCrsExclusionEntry +## FirewallPolicyPropertiesFormat ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -## ManagedRuleSet -### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +## FirewallPolicyRule +* **Discriminator**: ruleType -## ManagedRuleGroupOverride -### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. -## ManagedRuleOverride -### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## PolicySettings -### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. -## AzureFirewallPropertiesFormat +### NatRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NatRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + + +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## AzureFirewallAdditionalProperties +## FirewallPolicyRuleGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## AzureFirewallApplicationRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FlowLogFormatParameters ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. + +## FlowLogPropertiesFormat +### Properties +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallRCAction +## FrontendIPConfiguration ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRule +## FrontendIPConfigurationPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRuleProtocol +## HttpHeader ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. ## HubIPAddresses ### Properties * **privateIPAddress**: string: Private IP Address associated with azure firewall. * **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress -### Properties -* **address**: string: Public IP Address value. - -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## AzureFirewallIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## AzureFirewallIpGroups -### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. - -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - -## AzureFirewallSku -### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Standard' | string: Tier of an Azure Firewall. -## ResourceTags +## IPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## BastionHostPropertiesFormat +## IPConfigurationBgpPeeringAddress ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## BastionHostIPConfiguration +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## BastionHostIPConfigurationPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. ## IpsecPolicy ### Properties @@ -1959,6 +1959,63 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. + +## Ipv6CircuitConnectionConfig +### Properties +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + ## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1978,274 +2035,259 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## BgpSettings +## ManagedRuleGroupOverride ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## IPConfigurationBgpPeeringAddress +## ManagedRuleOverride ### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## AddressSpace +## ManagedRulesDefinition ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ResourceTags +## ManagedRuleSet +### Properties +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## TrafficSelectorPolicy +## MatchCondition ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## TunnelConnectionHealth +## MatchVariable ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## VirtualNetworkGateway +## NatGatewayPropertiesFormat +### Properties +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. + +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## VpnClientConfiguration +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## VpnClientRevokedCertificate +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientRootCertificate +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRootCertificatePropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## DdosCustomPolicyPropertiesFormat +## NetworkProfilePropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. - -## ProtocolCustomSettingsFormat -### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosProtectionPlanPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## DdosProtectionPlanTags +## NetworkVirtualAppliancePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bootStrapConfigurationBlob**: string[]: BootStrapConfigurationBlob storage URLs. +* **cloudInitConfigurationBlob**: string[]: CloudInitConfigurationBlob storage URLs. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteCircuitPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ExpressRouteCircuitAuthorization +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## AuthorizationPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitPeering +## OwaspCrsExclusionEntry +### Properties +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitConnection +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2263,360 +2305,272 @@ * **connectionName**: string: The name of the express route circuit connection resource. * **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitReference +## PolicySettings ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ExpressRouteCrossConnectionPeering +## PrivateEndpoint +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## PrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteCrossConnectionPeeringProperties +## PrivateEndpointConnectionProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. -## ResourceTags +## PrivateEndpointProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteGatewayProperties +## PrivateLinkServiceConnection ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PrivateLinkServiceConnectionProperties ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PrivateLinkServiceConnectionState ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ExpressRouteConnection +## PrivateLinkServiceIpConfiguration ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteConnectionProperties +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. - -## ExpressRouteCircuitPeeringId -### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualHubId +## PrivateLinkServiceProperties ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## ResourceTags +## PrivateLinkServicePropertiesAutoApproval ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **subscriptions**: string[]: The list of subscriptions. -## ExpressRoutePortPropertiesFormat +## PrivateLinkServicePropertiesVisibility ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **subscriptions**: string[]: The list of subscriptions. -## ExpressRouteLink +## Probe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteLinkPropertiesFormat +## ProbePropertiesFormat ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **requestPath**: 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. -## ResourceTags +## ProtocolCustomSettingsFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## FirewallPolicyPropertiesFormat +## PublicIPAddress ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ResourceTags +## PublicIPAddressDnsSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## FirewallPolicyRuleGroupProperties +## PublicIPAddressPropertiesFormat ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -## FirewallPolicyFilterRuleAction +## PublicIPAddressSku ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType +## PublicIPPrefixPropertiesFormat +### Properties +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. +## PublicIPPrefixSku +### Properties +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -### NatRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NatRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## FirewallPolicyRuleConditionApplicationProtocol +## ResourceTags ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyNatRuleAction +## ResourceTags ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +### Additional Properties +* **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2628,18 +2582,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2651,56 +2602,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2712,142 +2652,102 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **bootStrapConfigurationBlob**: string[]: BootStrapConfigurationBlob storage URLs. -* **cloudInitConfigurationBlob**: string[]: CloudInitConfigurationBlob storage URLs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat -### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters -### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. - -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -2857,191 +2757,225 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## RetentionPolicyParameters ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. -## PacketCaptureStorageLocation +## Route ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -## P2SVpnGatewayProperties +## RouteFilterPropertiesFormat ### Properties -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## P2SConnectionConfiguration +## RouteFilterRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **location**: string: Resource location. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## P2SConnectionConfigurationProperties +## RouteFilterRulePropertiesFormat ### Properties +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## VpnClientConnectionHealth +## RoutePropertiesFormat ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## RouteTable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## RouteTablePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServiceProperties +## SecurityRule ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServicePropertiesAutoApproval +## SecurityRulePropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateLinkServiceIpConfiguration +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. + +## ServiceAssociationLinkPropertiesFormat +### Properties +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ServiceDelegationPropertiesFormat +### Properties +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## PrivateLinkServiceIpConfigurationProperties +## ServiceEndpointPolicy ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnection +## ServiceEndpointPolicyDefinition ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PrivateEndpointConnectionProperties +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## PrivateLinkServicePropertiesVisibility +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## ServiceEndpointPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## PublicIPPrefixPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. - -## ReferencedPublicIpAddress -### Properties -* **id**: string: The PublicIPAddress Reference. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## PublicIPPrefixSku +## SubResource ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **id**: string: Resource ID. -## ResourceTags +## TrafficAnalyticsConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## RouteFilterPropertiesFormat +## TrafficAnalyticsProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## RouteFilterRule +## TrafficSelectorPolicy ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## RouteFilterRulePropertiesFormat +## TunnelConnectionHealth ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3058,15 +2992,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3087,30 +3021,102 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## HubVirtualNetworkConnection +## VirtualNetworkBgpCommunities +### Properties +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. + +## VirtualNetworkGateway +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. + +## VirtualNetworkGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. + +## VirtualNetworkPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. + +## VirtualNetworkPeeringPropertiesFormat +### Properties +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -3121,46 +3127,34 @@ * **enableDdosProtection**: bool: 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. * **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. - -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3171,17 +3165,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3193,18 +3176,49 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3232,35 +3246,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3279,37 +3291,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3320,29 +3301,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3351,6 +3309,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3359,18 +3342,35 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-03-01/types.md b/generated/network/microsoft.network/2020-03-01/types.md index b5754685d7..7ad6674eb2 100644 --- a/generated/network/microsoft.network/2020-03-01/types.md +++ b/generated/network/microsoft.network/2020-03-01/types.md @@ -730,51 +730,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -794,6 +770,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -808,1199 +789,1288 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource -### Properties -* **id**: string: Resource ID. - -## InboundNatRule +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayHeaderConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## PublicIPAddress +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayIPConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. + +## ApplicationGatewayProbePropertiesFormat +### Properties +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## Delegation +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## IPConfigurationProfile +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## NetworkSecurityGroup +## ApplicationGatewayRewriteRule +### Properties +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. + +## ApplicationGatewayRewriteRuleActionSet +### Properties +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. + +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## FlowLog +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayUrlConfiguration ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## FlowLogFormatParameters +## ApplicationGatewayUrlPathMap ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## RetentionPolicyParameters +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## NetworkInterface +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## NetworkInterfacePropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## NetworkInterfaceDnsSettings +## AuthorizationPropertiesFormat ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## AzureFirewallAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateEndpointProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## CustomDnsConfigPropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## PrivateLinkServiceConnection +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PrivateLinkServiceConnectionState +## AzureFirewallIpGroups ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ResourceTags +## AzureFirewallNatRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## NetworkInterfaceTapConfiguration +## AzureFirewallNatRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## VirtualNetworkTap +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. - -## FrontendIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallPublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Public IP Address value. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Standard' | string: Tier of an Azure Firewall. -## ResourceNavigationLink +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ResourceNavigationLinkFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RouteTable +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## RouteTablePropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## RoutePropertiesFormat +## BastionHostPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceAssociationLink +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ServiceAssociationLinkPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ServiceEndpointPolicy +## ConnectionMonitorEndpoint ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. -## ServiceEndpointPolicyPropertiesFormat +## ConnectionMonitorEndpointFilter ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ServiceEndpointPolicyDefinition +## ConnectionMonitorEndpointFilterItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## ConnectionMonitorHttpConfiguration ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ResourceTags +## ConnectionMonitorIcmpConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorOutput ### Properties -* **locations**: string[]: A list of locations. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters +### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## IpTag +## ConnectionMonitorSource ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## PublicIPAddressSku +## ConnectionMonitorSuccessThreshold ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorTcpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorTestConfiguration ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorTestGroup ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayCustomError +## ConnectionMonitorWorkspaceSettings ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewayFrontendIPConfiguration +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayHttpListenerPropertiesFormat +## CustomDnsConfigPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayProbe +## DdosCustomPolicyPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbeHealthResponseMatch +## DdosProtectionPlanTags ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfiguration +## DdosSettings +### Properties +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRequestRoutingRule +## DhcpOptions +### Properties +* **dnsServers**: string[]: The list of DNS servers IP addresses. + +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitPeering ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPeeringConfig ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeeringId ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayUrlConfiguration +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitPropertiesFormat ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewaySku +## ExpressRouteCircuitReference ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitSku ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitStats ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteConnectionId ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. + +## ExpressRouteConnectionProperties +### Properties +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayUrlPathMap +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayPathRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCrossConnectionProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteGatewayProperties ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayFirewallExclusion +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WebApplicationFirewallPolicyPropertiesFormat -### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## ApplicationGateway +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ResourceTags +## ExpressRouteLinkMacSecConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## WebApplicationFirewallCustomRule +## ExpressRouteLinkPropertiesFormat ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## MatchCondition +## ExpressRoutePortPropertiesFormat ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## MatchVariable +## FirewallPolicyFilterRuleAction ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ManagedRulesDefinition +## FirewallPolicyNatRuleAction ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **type**: 'DNAT' | string: The action type of a rule. -## OwaspCrsExclusionEntry +## FirewallPolicyPropertiesFormat ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -## ManagedRuleSet -### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +## FirewallPolicyRule +* **Discriminator**: ruleType -## ManagedRuleGroupOverride -### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. -## ManagedRuleOverride -### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## PolicySettings -### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. -## AzureFirewallPropertiesFormat +### NatRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NatRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + + +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## AzureFirewallAdditionalProperties +## FirewallPolicyRuleGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## AzureFirewallApplicationRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FlowLogFormatParameters ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. + +## FlowLogPropertiesFormat +### Properties +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallRCAction +## FrontendIPConfiguration ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRule +## FrontendIPConfigurationPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRuleProtocol +## HttpHeader ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. ## HubIPAddresses ### Properties * **privateIPAddress**: string: Private IP Address associated with azure firewall. * **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress +## HubVirtualNetworkConnection ### Properties -* **address**: string: Public IP Address value. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## AzureFirewallIPConfiguration +## HubVirtualNetworkConnectionProperties +### Properties +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. * **type**: string (ReadOnly): Type of the resource. -## AzureFirewallIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallIpGroups -### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. - -## AzureFirewallNatRuleCollection +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNatRuleCollectionProperties +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## AzureFirewallNatRCAction +## IpAllocationPropertiesFormat ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## AzureFirewallNatRule +## IpAllocationPropertiesFormatAllocationTags ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +### Additional Properties +* **Additional Properties Type**: string -## AzureFirewallNetworkRuleCollection +## IPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## IPConfigurationBgpPeeringAddress ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## AzureFirewallNetworkRule +## IPConfigurationProfile ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## AzureFirewallSku +## IPConfigurationProfilePropertiesFormat ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Standard' | string: Tier of an Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## BastionHostPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## BastionHostIPConfiguration +## IpsecPolicy ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## BastionHostIPConfigurationPropertiesFormat +## IpTag ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## ResourceTags +## Ipv6CircuitConnectionConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VirtualNetworkGatewayConnectionPropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## IpsecPolicy +## LoadBalancerSku ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## LocalNetworkGateway ### Properties @@ -2021,281 +2091,259 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## BgpSettings +## ManagedRuleGroupOverride ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## IPConfigurationBgpPeeringAddress +## ManagedRuleOverride ### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## AddressSpace +## ManagedRulesDefinition ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ResourceTags +## ManagedRuleSet +### Properties +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## TrafficSelectorPolicy +## MatchCondition ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## TunnelConnectionHealth +## MatchVariable ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## VirtualNetworkGateway +## NatGatewayPropertiesFormat +### Properties +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. + +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## RadiusServer +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## VpnClientRevokedCertificate +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientRootCertificate +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRootCertificatePropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## DdosCustomPolicyPropertiesFormat +## NetworkProfilePropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. - -## ProtocolCustomSettingsFormat -### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosProtectionPlanPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## DdosProtectionPlanTags +## NetworkVirtualAppliancePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bootStrapConfigurationBlob**: string[]: BootStrapConfigurationBlob storage URLs. +* **cloudInitConfigurationBlob**: string[]: CloudInitConfigurationBlob storage URLs. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteCircuitPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ExpressRouteCircuitAuthorization +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## AuthorizationPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitPeering +## OwaspCrsExclusionEntry +### Properties +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitConnection +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2315,379 +2363,256 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference -### Properties -* **id**: string: Corresponding Express Route Circuit Id. - -## ExpressRouteCrossConnectionPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. - -## ExpressRouteCrossConnectionPeeringProperties +## PolicySettings ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ResourceTags +## PrivateDnsZoneConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## ExpressRouteGatewayProperties +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. - -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. - -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds -### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. - -## ExpressRouteConnection -### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ExpressRouteConnectionProperties +## PrivateDnsZonePropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: The routing weight associated to the connection. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## ExpressRouteCircuitPeeringId +## PrivateEndpoint ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateEndpointConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PrivateEndpointProperties ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkServiceConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceConnectionProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ExpressRouteLinkMacSecConfig +## PrivateLinkServiceConnectionState ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## PrivateLinkServiceIpConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyRuleGroupProperties +## PrivateLinkServiceProperties ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyFilterRuleAction +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType - -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. - -### NatRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NatRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **subscriptions**: string[]: The list of subscriptions. +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyRuleConditionApplicationProtocol +## Probe ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyNatRuleAction +## ProbePropertiesFormat ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## IpAllocationPropertiesFormat +## ProtocolCustomSettingsFormat ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## IpAllocationPropertiesFormatAllocationTags +## PublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ResourceTags +## PublicIPAddressDnsSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## IpGroupPropertiesFormat +## PublicIPAddressPropertiesFormat ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -## ResourceTags +## PublicIPAddressSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## LoadBalancerPropertiesFormat +## PublicIPPrefixPropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## InboundNatPool +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## InboundNatPoolPropertiesFormat +## RadiusServer ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. + +## RecordSet +### Properties +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## LoadBalancingRule +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. + +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## LoadBalancingRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2699,18 +2624,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2722,56 +2644,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2783,142 +2694,117 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **bootStrapConfigurationBlob**: string[]: BootStrapConfigurationBlob storage URLs. -* **cloudInitConfigurationBlob**: string[]: CloudInitConfigurationBlob storage URLs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -2928,57 +2814,40 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfigurationProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2990,165 +2859,228 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateDnsZoneGroupPropertiesFormat +## RetentionPolicyParameters ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PrivateDnsZoneConfig +## RouteFilterRule ### Properties -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PrivateDnsZonePropertiesFormat +## RouteFilterRulePropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## RecordSet +## RoutePropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. -## PrivateLinkServiceProperties +## RouteTable ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServicePropertiesAutoApproval +## SecurityPartnerProviderPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## PrivateLinkServiceIpConfiguration +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServiceIpConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateEndpointConnection +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ServiceDelegationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PublicIPPrefixSku +## ServiceEndpointPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## RouteFilterRule +## SubResource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## RouteFilterRulePropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## ResourceTags +## TrafficAnalyticsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## SecurityPartnerProviderPropertiesFormat +## TunnelConnectionHealth ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3166,15 +3098,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3195,30 +3127,103 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## HubVirtualNetworkConnection +## VirtualNetworkBgpCommunities +### Properties +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. + +## VirtualNetworkGateway +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkGatewayConnectionPropertiesFormat +### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. + +## VirtualNetworkGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. + +## VirtualNetworkPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. + +## VirtualNetworkPeeringPropertiesFormat +### Properties +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -3231,45 +3236,33 @@ * **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. - -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3280,17 +3273,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3302,18 +3284,50 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VpnClientConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnGatewayProperties +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3342,35 +3356,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3390,37 +3402,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3431,29 +3412,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3462,6 +3420,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3470,18 +3453,35 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-04-01/types.md b/generated/network/microsoft.network/2020-04-01/types.md index 47e423fec1..2b0001810f 100644 --- a/generated/network/microsoft.network/2020-04-01/types.md +++ b/generated/network/microsoft.network/2020-04-01/types.md @@ -750,51 +750,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -814,6 +790,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -828,1237 +809,1211 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## SubResource +## ApplicationGatewayHeaderConfiguration ### Properties -* **id**: string: Resource ID. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## InboundNatRule +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties -### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. - -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. - -## DdosSettings -### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. - -## PublicIPAddressDnsSettings -### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## Delegation +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## IPConfigurationProfile +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkSecurityGroup +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## SecurityRule +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## SecurityRulePropertiesFormat +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## FlowLog +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## FlowLogPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewaySku ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## FlowLogFormatParameters +## ApplicationGatewaySslCertificate ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## RetentionPolicyParameters +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## ResourceTags +## ApplicationGatewaySslPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## NetworkInterface +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayUrlConfiguration ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## PrivateEndpoint +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointProperties +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## CustomDnsConfigPropertiesFormat +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## PrivateLinkServiceConnection +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PrivateLinkServiceConnectionProperties +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## PrivateLinkServiceConnectionState +## AuthorizationPropertiesFormat ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## NetworkInterfaceTapConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. - -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallApplicationRule ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## VirtualNetworkTap +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## FrontendIPConfiguration +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. * **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallIpGroups ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ResourceTags +## AzureFirewallNatRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ResourceTags +## AzureFirewallNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ResourceNavigationLink +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## RouteTable +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## RouteTablePropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## Route +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## RoutePropertiesFormat +## AzureFirewallPublicIPAddress ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **address**: string: Public IP Address value. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ServiceAssociationLink +## AzureFirewallSku +### Properties +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. + +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ServiceAssociationLinkPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ServiceEndpointPolicy +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ServiceEndpointPolicyPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ServiceEndpointPolicyDefinition +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BgpSettings ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ResourceTags +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## IpTag +## ConnectionMonitorEndpoint ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. -## PublicIPAddressSku +## ConnectionMonitorEndpointFilter ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ResourceTags +## ConnectionMonitorEndpointFilterItem ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorHttpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorIcmpConfiguration ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. + +## ConnectionMonitorOutput +### Properties +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters +### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorSource ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayCustomError +## ConnectionMonitorSuccessThreshold ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ApplicationGatewayFrontendIPConfiguration +## ConnectionMonitorTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ConnectionMonitorTcpConfiguration ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayFrontendPort +## ConnectionMonitorTestConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayFrontendPortPropertiesFormat +## ConnectionMonitorTestGroup ### Properties -* **port**: int: Frontend port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayIPConfiguration +## ConnectionMonitorWorkspaceSettings +### Properties +* **workspaceResourceId**: string: Log analytics workspace resource ID. + +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayHttpListenerPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayProbe +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayProbePropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ApplicationGatewayProbeHealthResponseMatch +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayRedirectConfiguration +## CustomDnsConfigPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayRequestRoutingRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayRequestRoutingRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayRewriteRuleSet -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. - -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. - -## ApplicationGatewayRewriteRule -### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRewriteRuleActionSet +## DdosProtectionPlanTags ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayHeaderConfiguration +## DdosSettings ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayUrlConfiguration +## Delegation ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayRewriteRuleCondition +## DeviceProperties ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySku +## DhcpOptions ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. - -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPropertiesFormat ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitReference ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ResourceTags +## ExpressRouteCircuitSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGateway +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## WebApplicationFirewallCustomRule +## ExpressRouteConnectionProperties ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. - -## MatchCondition -### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## MatchVariable +## ExpressRouteCrossConnectionPeering ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ManagedRulesDefinition +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## OwaspCrsExclusionEntry +## ExpressRouteCrossConnectionProperties ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ManagedRuleSet +## ExpressRouteGatewayProperties ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ManagedRuleGroupOverride +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ManagedRuleOverride +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## PolicySettings +## ExpressRouteLink ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ResourceTags +## ExpressRouteLinkMacSecConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## ResourceTags +## ExpressRouteLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallPropertiesFormat +## ExpressRoutePortPropertiesFormat ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIpAddresses**: [HubIPAddresses](#hubipaddresses) (ReadOnly): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## AzureFirewallAdditionalProperties +## FirewallPolicyFilterRuleAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## AzureFirewallApplicationRuleCollection +## FirewallPolicyNatRuleAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **type**: 'DNAT' | string: The action type of a rule. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FirewallPolicyPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +## FirewallPolicyRule +* **Discriminator**: ruleType -## AzureFirewallApplicationRule -### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +### Base Properties +* **name**: string: The name of the rule. +* **priority**: int: Priority of the Firewall Policy Rule resource. +### FirewallPolicyFilterRule +#### Properties +* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. +* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. +* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. + +### FirewallPolicyNatRule +#### Properties +* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. +* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. +* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + + +## FirewallPolicyRuleCondition +* **Discriminator**: ruleConditionType + +### Base Properties +* **description**: string: Description of the rule condition. +* **name**: string: Name of the rule condition. +### ApplicationRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. +* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. +* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule condition. -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +### NatRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NatRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## HubIPAddresses -### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. +### NetworkRuleCondition +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. +* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## AzureFirewallPublicIPAddress -### Properties -* **address**: string: Public IP Address value. -## AzureFirewallIPConfiguration +## FirewallPolicyRuleConditionApplicationProtocol ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. -## AzureFirewallIPConfigurationPropertiesFormat +## FirewallPolicyRuleGroupProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **priority**: int: Priority of the Firewall Policy Rule Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. -## AzureFirewallIpGroups +## FirewallPolicyThreatIntelWhitelist ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallNatRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNatRuleCollectionProperties +## FlowLogFormatParameters ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## AzureFirewallNatRule +## FlowLogPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallNetworkRuleCollection +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## HttpHeader ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## AzureFirewallSku +## HubIPAddresses ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPAddresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: List of Public IP addresses associated with azure firewall. -## ResourceTags +## HubRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## BastionHostPropertiesFormat +## HubRouteTableProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## BastionHostIPConfiguration +## HubVirtualNetworkConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. -## BastionHostIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## ResourceTags +## InboundNatPool ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. - -## IpsecPolicy -### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## LocalNetworkGateway +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## LocalNetworkGatewayPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## BgpSettings +## IpAllocationPropertiesFormat ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## IpAllocationPropertiesFormatAllocationTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IPConfiguration +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. ## IPConfigurationBgpPeeringAddress ### Properties @@ -2067,687 +2022,659 @@ * **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. * **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags +## IPConfigurationProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## TrafficSelectorPolicy +## IPConfigurationProfilePropertiesFormat ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## TunnelConnectionHealth +## IPConfigurationPropertiesFormat ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGateway +## IpGroupPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VirtualNetworkGatewayPropertiesFormat +## IpsecPolicy ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## VirtualNetworkGatewayIPConfiguration +## IpTag ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## Ipv6CircuitConnectionConfig ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VirtualNetworkGatewaySku +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VpnClientConfiguration +## LoadBalancerBackendAddress ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## RadiusServer +## LoadBalancerBackendAddressPropertiesFormat ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## VpnClientRevokedCertificate +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VpnClientRevokedCertificatePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnClientRootCertificate +## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ResourceTags +## ManagedRuleGroupOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ResourceTags +## ManagedRuleOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## DdosCustomPolicyPropertiesFormat +## ManagedRulesDefinition ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ProtocolCustomSettingsFormat +## ManagedRuleSet ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ResourceTags +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## DdosProtectionPlanPropertiesFormat +## MatchCondition ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## DdosProtectionPlanTags +## MatchVariable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## ExpressRouteCircuitPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## ExpressRouteCircuitAuthorization +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AuthorizationPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitPeering +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## ExpressRouteCircuitConnection +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. - -## ExpressRouteCircuitConnectionPropertiesFormat -### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## Ipv6CircuitConnectionConfig +## NetworkInterfacePropertiesFormat ### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## ExpressRouteConnectionId +## NetworkInterfaceTapConfiguration ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ExpressRouteCircuitPeeringConfig +## NetworkProfilePropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## PeerExpressRouteCircuitConnection +## NetworkSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **bootStrapConfigurationBlob**: string[]: BootStrapConfigurationBlob storage URLs. +* **cloudInitConfigurationBlob**: string[]: CloudInitConfigurationBlob storage URLs. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteCircuitSku +## NetworkWatcherPropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCrossConnectionProperties +## OutboundRulePropertiesFormat ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ExpressRouteCircuitReference +## OwaspCrsExclusionEntry ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCrossConnectionPeering +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCrossConnectionPeeringProperties +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ResourceTags +## P2SVpnGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteGatewayProperties +## P2SVpnGatewayProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PacketCaptureFilter ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PacketCaptureParameters ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteConnection +## PacketCaptureStorageLocation ### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## PeerExpressRouteCircuitConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteConnectionProperties +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. -## ExpressRouteCircuitPeeringId +## PolicySettings ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## RoutingConfiguration +## PrivateDnsZoneConfig ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## PropagatedRouteTable +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VnetRoute +## PrivateDnsZonePropertiesFormat ### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## StaticRoute +## PrivateEndpoint ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateEndpointConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PrivateEndpointProperties ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkServiceConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceConnectionProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ExpressRouteLinkMacSecConfig +## PrivateLinkServiceConnectionState ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'gcm-aes-128' | 'gcm-aes-256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## PrivateLinkServiceIpConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyThreatIntelWhitelist +## PrivateLinkServiceProperties ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## ResourceTags +## PrivateLinkServicePropertiesAutoApproval ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyRuleGroupProperties +## PrivateLinkServicePropertiesVisibility ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Group resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: Group of Firewall Policy rules. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **name**: string: The name of the rule. -* **priority**: int: Priority of the Firewall Policy Rule resource. -### FirewallPolicyFilterRule -#### Properties -* **action**: [FirewallPolicyFilterRuleAction](#firewallpolicyfilterruleaction): Properties of the FirewallPolicyFilterRuleAction. -* **ruleConditions**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition)[]: Collection of rule conditions used by a rule. -* **ruleType**: 'FirewallPolicyFilterRule' (Required): The type of the rule. - -### FirewallPolicyNatRule -#### Properties -* **action**: [FirewallPolicyNatRuleAction](#firewallpolicynatruleaction): Properties of the FirewallPolicyNatRuleAction. -* **ruleCondition**: [FirewallPolicyRuleCondition](#firewallpolicyrulecondition): Properties of a rule. -* **ruleType**: 'FirewallPolicyNatRule' (Required): The type of the rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyFilterRuleAction +## Probe ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRuleCondition -* **Discriminator**: ruleConditionType - -### Base Properties -* **description**: string: Description of the rule condition. -* **name**: string: Name of the rule condition. -### ApplicationRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule condition. -* **protocols**: [FirewallPolicyRuleConditionApplicationProtocol](#firewallpolicyruleconditionapplicationprotocol)[]: Array of Application Protocols. -* **ruleConditionType**: 'ApplicationRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule condition. - -### NatRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NatRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - -### NetworkRuleCondition -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleConditionNetworkProtocols. -* **ruleConditionType**: 'NetworkRuleCondition' (Required): Rule Condition Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyRuleConditionApplicationProtocol +## ProbePropertiesFormat ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule condition. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyNatRuleAction +## PropagatedRouteTable ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## IpAllocationPropertiesFormat +## ProtocolCustomSettingsFormat ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## IpAllocationPropertiesFormatAllocationTags +## PublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ResourceTags +## PublicIPAddressDnsSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## IpGroupPropertiesFormat +## PublicIPAddressPropertiesFormat ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -## ResourceTags +## PublicIPAddressSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## LoadBalancerPropertiesFormat +## PublicIPPrefixPropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## InboundNatPool +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## InboundNatPoolPropertiesFormat +## RadiusServer +### Properties +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. + +## RecordSet ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## LoadBalancingRule +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. + +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## LoadBalancingRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2759,18 +2686,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2782,56 +2706,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2843,142 +2756,117 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **bootStrapConfigurationBlob**: string[]: BootStrapConfigurationBlob storage URLs. -* **cloudInitConfigurationBlob**: string[]: CloudInitConfigurationBlob storage URLs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -2988,58 +2876,40 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfigurationProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3051,165 +2921,240 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateDnsZoneGroupPropertiesFormat +## RetentionPolicyParameters ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PrivateDnsZoneConfig +## RouteFilterRule ### Properties -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PrivateDnsZonePropertiesFormat +## RouteFilterRulePropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## RecordSet +## RoutePropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. -## PrivateLinkServiceProperties +## RouteTable ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServicePropertiesAutoApproval +## RoutingConfiguration ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## PrivateLinkServiceIpConfiguration +## SecurityPartnerProviderPropertiesFormat +### Properties +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. + +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServiceIpConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateEndpointConnection +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ServiceDelegationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). + +## ServiceEndpointPolicy +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## ResourceTags +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ReferencedPublicIpAddress +## ServiceEndpointPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## PublicIPPrefixSku +## StaticRoute ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## RouteFilterRule +## SubResource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## RouteFilterRulePropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## ResourceTags +## TrafficAnalyticsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## SecurityPartnerProviderPropertiesFormat +## TunnelConnectionHealth ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. + +## VirtualHubId +### Properties +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3227,15 +3172,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3256,47 +3201,103 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## HubVirtualNetworkConnection +## VirtualNetworkBgpCommunities +### Properties +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. + +## VirtualNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [HubVirtualNetworkConnectionProperties](#hubvirtualnetworkconnectionproperties): Parameters for HubVirtualNetworkConnection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## ResourceTags +## VirtualNetworkGatewayIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubRouteTableProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## HubRoute +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. + +## VirtualNetworkPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. + +## VirtualNetworkPeeringPropertiesFormat +### Properties +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -3312,42 +3313,30 @@ * **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. * **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. - -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. - -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3358,17 +3347,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3380,18 +3358,54 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3421,35 +3435,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3469,37 +3481,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3510,29 +3491,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3541,6 +3499,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3549,18 +3532,35 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-05-01/types.md b/generated/network/microsoft.network/2020-05-01/types.md index fdf9e6a8a3..ff5705b901 100644 --- a/generated/network/microsoft.network/2020-05-01/types.md +++ b/generated/network/microsoft.network/2020-05-01/types.md @@ -799,53 +799,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -865,6 +839,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -879,1287 +858,1285 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayConnectionDraining ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayCustomError ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ResourceTags +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## SubResource +## ApplicationGatewayHeaderConfiguration ### Properties -* **id**: string: Resource ID. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## InboundNatRule +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties -### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. - -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayPathRule ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## Subnet +## ApplicationGatewayPrivateLinkConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPrivateLinkConfigurationProperties ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## Delegation +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedRootCertificates**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## FlowLog +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. - -## TrafficAnalyticsConfigurationProperties -### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## FlowLogFormatParameters +## ApplicationGatewayRewriteRule ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## RetentionPolicyParameters +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## ResourceTags +## ApplicationGatewayRewriteRuleCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## NetworkInterface +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkInterfaceDnsSettings +## ApplicationGatewaySku ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## PrivateEndpoint +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointProperties +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## CustomDnsConfigPropertiesFormat +## ApplicationGatewaySslPolicy ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## PrivateLinkServiceConnection +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## ApplicationGatewayUrlConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## ApplicationGatewayWebApplicationFirewallConfiguration +### Properties +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkTapPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. - -## FrontendIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## FrontendIPConfigurationPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceNavigationLink +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## RouteTable -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## Route +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## RoutePropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallIpGroups ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ServiceAssociationLink +## AzureFirewallNatRCAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNatRule ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicy +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ServiceEndpointPolicyDefinition +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ResourceTags +## AzureFirewallPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceEndpointPropertiesFormat -### Properties -* **locations**: string[]: A list of locations. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## IpTag +## AzureFirewallPublicIPAddress ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **address**: string: Public IP Address value. -## PublicIPAddressSku +## AzureFirewallRCAction ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayCustomError -### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ApplicationGatewayFrontendIPConfiguration +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ApplicationGatewayFrontendPort +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayFrontendPortPropertiesFormat +## BgpConnectionProperties ### Properties -* **port**: int: Frontend port. +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## BgpSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayIPConfigurationPropertiesFormat +## BreakOutCategoryPolicies ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ApplicationGatewayHttpListener +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayPrivateEndpointConnection +## ConnectionMonitorEndpoint ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. -## ApplicationGatewayPrivateEndpointConnectionProperties +## ConnectionMonitorEndpointFilter ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ApplicationGatewayPrivateLinkConfiguration +## ConnectionMonitorEndpointFilterItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ApplicationGatewayPrivateLinkConfigurationProperties +## ConnectionMonitorHttpConfiguration ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ApplicationGatewayPrivateLinkIpConfiguration +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ConnectionMonitorOutput ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters +### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ApplicationGatewayProbe +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayProbePropertiesFormat +## ConnectionMonitorSuccessThreshold ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ApplicationGatewayProbeHealthResponseMatch +## ConnectionMonitorTags ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfiguration +## ConnectionMonitorTcpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ConnectionMonitorTestConfiguration ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayRequestRoutingRule +## ConnectionMonitorTestGroup +### Properties +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. + +## ConnectionMonitorWorkspaceSettings +### Properties +* **workspaceResourceId**: string: Log analytics workspace resource ID. + +## Container +### Properties +* **id**: string: Resource ID. + +## ContainerNetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ContainerNetworkInterfaceConfiguration ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. + +## ContainerNetworkInterfaceConfigurationPropertiesFormat +### Properties +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayRewriteRuleSet +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayRewriteRuleActionSet +## CustomDnsConfigPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayHeaderConfiguration +## DdosCustomPolicyPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayUrlConfiguration +## DdosProtectionPlanPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRewriteRuleCondition +## DdosProtectionPlanTags ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewaySku +## DdosSettings ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewaySslCertificate +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewaySslCertificatePropertiesFormat +## DeviceProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySslPolicy +## DhcpOptions ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayTrustedRootCertificate +## DnsSettings +### Properties +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. + +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat -### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPeeringId ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCircuitPropertiesFormat ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ResourceTags +## ExpressRouteCircuitReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Corresponding Express Route Circuit Id. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGateway +## ExpressRouteCircuitSku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ResourceTags +## ExpressRouteCircuitStats ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## WebApplicationFirewallCustomRule +## ExpressRouteConnection ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## MatchCondition +## ExpressRouteConnectionId ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## MatchVariable +## ExpressRouteConnectionProperties ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ManagedRulesDefinition +## ExpressRouteCrossConnectionPeering ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## OwaspCrsExclusionEntry +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ManagedRuleSet +## ExpressRouteCrossConnectionProperties ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string: The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ManagedRuleGroupOverride +## ExpressRouteGatewayProperties ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ManagedRuleOverride +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## PolicySettings +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ResourceTags +## ExpressRouteLink ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ResourceTags +## ExpressRouteLinkMacSecConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -## AzureFirewallPropertiesFormat +## ExpressRouteLinkPropertiesFormat ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## AzureFirewallAdditionalProperties +## ExpressRoutePortPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## AzureFirewallApplicationRuleCollection +## FirewallPolicyFilterRuleCollectionAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FirewallPolicyNatRuleCollectionAction ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **type**: 'DNAT' | string: The action type of a rule. -## AzureFirewallRCAction +## FirewallPolicyPropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -## AzureFirewallApplicationRule -### Properties +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties * **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. * **targetFqdns**: string[]: List of FQDNs for this rule. -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## HubIPAddresses -### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## HubPublicIPAddresses -### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress +## FirewallPolicyRuleApplicationProtocol ### Properties -* **address**: string: Public IP Address value. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## AzureFirewallIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType -## AzureFirewallIPConfigurationPropertiesFormat +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## AzureFirewallIpGroups +## FirewallPolicyThreatIntelWhitelist ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallNatRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallNatRuleCollectionProperties +## FlowLogFormatParameters ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. + +## FlowLogPropertiesFormat +### Properties +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallNatRCAction +## FrontendIPConfiguration ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallNatRule +## FrontendIPConfigurationPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRuleCollection +## HttpHeader ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## HubIPAddresses ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. + +## HubIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## HubPublicIPAddresses ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallSku +## HubRoute ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## ResourceTags +## HubRouteTableProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## BastionHostPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## BastionHostIPConfiguration +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## BastionHostIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ResourceTags +## InboundNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## IpsecPolicy +## IpAllocationPropertiesFormat ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## LocalNetworkGateway +## IpAllocationPropertiesFormatAllocationTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## IPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. ## IPConfigurationBgpPeeringAddress ### Properties @@ -2168,695 +2145,657 @@ * **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. * **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## AddressSpace +## IPConfigurationProfile ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## IPConfigurationProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## TrafficSelectorPolicy +## IPConfigurationPropertiesFormat ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## TunnelConnectionHealth +## IpGroupPropertiesFormat ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VirtualNetworkGateway +## IpsecPolicy ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## VirtualNetworkGatewayPropertiesFormat +## IpTag ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VirtualNetworkGatewayIPConfiguration +## Ipv6CircuitConnectionConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VirtualNetworkGatewaySku +## LoadBalancerBackendAddress ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## VpnClientConfiguration +## LoadBalancerBackendAddressPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## RadiusServer +## LoadBalancerPropertiesFormat ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## VpnClientRevokedCertificate +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VpnClientRevokedCertificatePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnClientRootCertificate +## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ResourceTags +## ManagedRuleGroupOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ResourceTags +## ManagedRuleOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## DdosCustomPolicyPropertiesFormat +## ManagedRulesDefinition ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ProtocolCustomSettingsFormat +## ManagedRuleSet ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ResourceTags +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## DdosProtectionPlanPropertiesFormat +## MatchCondition ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## DdosProtectionPlanTags +## MatchVariable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## ExpressRouteCircuitPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. - -## ExpressRouteCircuitAuthorization -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## AuthorizationPropertiesFormat +## NatGatewaySku ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## ExpressRouteCircuitPeering +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitConnection +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## Ipv6CircuitConnectionConfig +## NetworkInterfacePropertiesFormat ### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## ExpressRouteConnectionId +## NetworkInterfaceTapConfiguration ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ExpressRouteCircuitPeeringConfig +## NetworkProfilePropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## PeerExpressRouteCircuitConnection +## NetworkSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteCircuitStats +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteCircuitServiceProviderProperties +## NetworkWatcherPropertiesFormat ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitSku +## Office365PolicyProperties ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCrossConnectionProperties +## OutboundRulePropertiesFormat ### Properties -* **bandwidthInMbps**: int: The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string: The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ExpressRouteCircuitReference +## OwaspCrsExclusionEntry ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCrossConnectionPeering +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCrossConnectionPeeringProperties +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ResourceTags +## P2SVpnGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteGatewayProperties +## P2SVpnGatewayProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. - -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. - -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds -### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnection +## PacketCaptureFilter ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteConnectionProperties +## PacketCaptureParameters ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringId +## PacketCaptureStorageLocation ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## RoutingConfiguration +## PeerExpressRouteCircuitConnection ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## PropagatedRouteTable +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VnetRoute +## PolicySettings ### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## StaticRoute +## PrivateDnsZoneConfig ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## VirtualHubId +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## PrivateDnsZonePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## ExpressRoutePortPropertiesFormat +## PrivateEndpoint ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLink +## PrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateEndpointConnectionProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ExpressRouteLinkMacSecConfig +## PrivateEndpointProperties ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## PrivateLinkServiceConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceConnectionProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## DnsSettings +## PrivateLinkServiceConnectionState ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## FirewallPolicyThreatIntelWhitelist +## PrivateLinkServiceIpConfiguration ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateLinkServiceIpConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyRuleCollectionGroupProperties +## PrivateLinkServiceProperties ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyFilterRuleCollectionAction +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. - -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyRuleApplicationProtocol +## PrivateLinkServicePropertiesVisibility ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyNatRuleCollectionAction +## Probe ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## IpAllocationPropertiesFormat +## ProbePropertiesFormat ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## IpAllocationPropertiesFormatAllocationTags +## PropagatedRouteTable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## ResourceTags +## ProtocolCustomSettingsFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## IpGroupPropertiesFormat +## PublicIPAddress ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ResourceTags +## PublicIPAddressDnsSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## LoadBalancerPropertiesFormat +## PublicIPAddressPropertiesFormat ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -## InboundNatPool +## PublicIPAddressSku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -## InboundNatPoolPropertiesFormat +## PublicIPPrefixPropertiesFormat ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## LoadBalancingRule +## PublicIPPrefixSku ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. -## LoadBalancingRulePropertiesFormat +## RadiusServer ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. + +## RecordSet +### Properties +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## OutboundRule +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. + +## ResourceNavigationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## OutboundRulePropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2868,18 +2807,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2891,56 +2827,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -2952,161 +2877,127 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3116,59 +3007,40 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfigurationProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3180,165 +3052,246 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateDnsZoneGroupPropertiesFormat +## RetentionPolicyParameters ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PrivateDnsZoneConfig +## RouteFilterRule ### Properties -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PrivateDnsZonePropertiesFormat +## RouteFilterRulePropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## RecordSet +## RoutePropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. -## PrivateLinkServiceProperties +## RouteTable ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServicePropertiesAutoApproval +## RoutingConfiguration ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## PrivateLinkServiceIpConfiguration +## SecurityPartnerProviderPropertiesFormat +### Properties +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. + +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServiceIpConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateEndpointConnection +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ServiceDelegationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## ServiceEndpointPolicyDefinition +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## ResourceTags +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ReferencedPublicIpAddress +## ServiceEndpointPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## PublicIPPrefixSku +## StaticRoute ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## RouteFilterRule +## SubResource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## RouteFilterRulePropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## ResourceTags +## TrafficAnalyticsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## SecurityPartnerProviderPropertiesFormat +## TunnelConnectionHealth ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualApplianceNicProperties +### Properties +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. + +## VirtualApplianceSiteProperties +### Properties +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3360,15 +3313,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3389,55 +3342,103 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubRoute +## VirtualNetworkGatewayIPConfiguration ### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## ResourceTags +## VirtualNetworkGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. + +## VirtualNetworkPeering +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. + +## VirtualNetworkPeeringPropertiesFormat +### Properties +* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. +* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. +* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. +* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **useRemoteGateways**: bool: 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. ## VirtualNetworkPropertiesFormat ### Properties @@ -3453,42 +3454,30 @@ * **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. * **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. - -## DhcpOptions -### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. - -## VirtualNetworkPeering +## VirtualNetworkTap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkPeeringPropertiesFormat](#virtualnetworkpeeringpropertiesformat): Properties of the virtual network peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPeeringPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **allowForwardedTraffic**: bool: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. -* **allowGatewayTransit**: bool: If gateway links can be used in remote virtual networking to link to this virtual network. -* **allowVirtualNetworkAccess**: bool: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. -* **peeringState**: 'Connected' | 'Disconnected' | 'Initiated' | string: The status of the virtual network peering. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **useRemoteGateways**: bool: 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. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3499,17 +3488,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3521,18 +3499,54 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3562,35 +3576,33 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnSiteLinkConnectionProperties +## VpnLinkBgpSettings ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3610,37 +3622,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3651,29 +3632,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3682,6 +3640,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3690,18 +3673,35 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-06-01/types.md b/generated/network/microsoft.network/2020-06-01/types.md index 10a31a2020..712d11be8f 100644 --- a/generated/network/microsoft.network/2020-06-01/types.md +++ b/generated/network/microsoft.network/2020-06-01/types.md @@ -834,55 +834,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -902,6 +874,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -916,1284 +893,1400 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayClientAuthConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayCustomError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## BackendAddressPool +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## SubResource +## ApplicationGatewayHeaderConfiguration ### Properties -* **id**: string: Resource ID. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## InboundNatRule +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties -### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. - -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayPathRule ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## Subnet +## ApplicationGatewayPrivateLinkConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPrivateLinkConfigurationProperties ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## Delegation +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## FlowLog +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## TrafficAnalyticsProperties +## ApplicationGatewayRewriteRule ### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## FlowLogFormatParameters +## ApplicationGatewayRewriteRuleCondition ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## RetentionPolicyParameters +## ApplicationGatewayRewriteRuleSet ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## ResourceTags +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkInterface +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## NetworkInterfaceDnsSettings +## ApplicationGatewaySslPolicy ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## PrivateEndpoint +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointProperties +## ApplicationGatewaySslProfilePropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## CustomDnsConfigPropertiesFormat -### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## PrivateLinkServiceConnection +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **data**: string: Certificate public data. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## PrivateLinkServiceConnectionState +## ApplicationGatewayTrustedRootCertificate ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayUrlConfiguration +### Properties +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## ApplicationGatewayWebApplicationFirewallConfiguration +### Properties +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkTapPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. - -## FrontendIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## FrontendIPConfigurationPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceNavigationLink +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## RouteTable -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## RouteTablePropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## Route +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## RoutePropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallIpGroups ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ServiceAssociationLink +## AzureFirewallNatRCAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNatRule ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceEndpointPolicy +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ServiceEndpointPolicyDefinition +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **locations**: string[]: A list of locations. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## IpTag +## AzureFirewallPublicIPAddress ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **address**: string: Public IP Address value. -## PublicIPAddressSku +## AzureFirewallRCAction ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## ApplicationGatewayBackendHttpSettings +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. - -## ApplicationGatewayConnectionDraining -### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. - -## ApplicationGatewayCustomError -### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## ApplicationGatewayFrontendIPConfiguration +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ApplicationGatewayFrontendPort +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayFrontendPortPropertiesFormat +## BgpConnectionProperties ### Properties -* **port**: int: Frontend port. +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## BgpSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayIPConfigurationPropertiesFormat +## BreakOutCategoryPolicies ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ApplicationGatewayHttpListener +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorDestination ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayPrivateEndpointConnection +## ConnectionMonitorEndpoint ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## ApplicationGatewayPrivateEndpointConnectionProperties +## ConnectionMonitorEndpointFilter ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ApplicationGatewayPrivateLinkConfiguration +## ConnectionMonitorEndpointFilterItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ApplicationGatewayPrivateLinkConfigurationProperties +## ConnectionMonitorEndpointScope ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ApplicationGatewayPrivateLinkIpConfiguration +## ConnectionMonitorEndpointScopeItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ConnectionMonitorHttpConfiguration ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ApplicationGatewayProbe +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ApplicationGatewayProbePropertiesFormat +## ConnectionMonitorOutput ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. -## ApplicationGatewayProbeHealthResponseMatch +## ConnectionMonitorParameters ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ApplicationGatewayRedirectConfiguration +## ConnectionMonitorSource +### Properties +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. + +## ConnectionMonitorSuccessThreshold +### Properties +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. + +## ConnectionMonitorTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ConnectionMonitorTcpConfiguration +### Properties +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. + +## ConnectionMonitorTestConfiguration +### Properties +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. + +## ConnectionMonitorTestGroup +### Properties +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. + +## ConnectionMonitorWorkspaceSettings +### Properties +* **workspaceResourceId**: string: Log analytics workspace resource ID. + +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRule +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayRewriteRuleSet +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayRewriteRuleActionSet +## CustomDnsConfigPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayHeaderConfiguration +## CustomIpPrefixPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -## ApplicationGatewayUrlConfiguration +## DdosCustomPolicyPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayRewriteRuleCondition +## DdosProtectionPlanPropertiesFormat ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewaySku +## DdosProtectionPlanTags ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewaySslCertificate +## DdosSettings +### Properties +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewaySslCertificatePropertiesFormat +## DeviceProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySslPolicy +## DhcpOptions ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewaySslProfile +## DnsSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. -## ApplicationGatewaySslProfilePropertiesFormat +## DscpConfigurationPropertiesFormat ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. - -## ApplicationGatewayClientAuthConfiguration -### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat -### Properties -* **data**: string: Certificate public data. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPropertiesFormat ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitReference ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ResourceTags +## ExpressRouteCircuitSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGateway +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## WebApplicationFirewallCustomRule +## ExpressRouteConnectionProperties +### Properties +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. + +## ExpressRouteCrossConnectionPeering ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## MatchCondition +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## MatchVariable +## ExpressRouteCrossConnectionProperties ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ManagedRulesDefinition +## ExpressRouteGatewayProperties ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## OwaspCrsExclusionEntry +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ManagedRuleSet +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ManagedRuleGroupOverride +## ExpressRouteLink ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ManagedRuleOverride +## ExpressRouteLinkMacSecConfig ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## PolicySettings +## ExpressRouteLinkPropertiesFormat ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ResourceTags +## ExpressRoutePortPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ResourceTags +## FirewallPolicyFilterRuleCollectionAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## AzureFirewallPropertiesFormat +## FirewallPolicyNatRuleCollectionAction ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. - -## AzureFirewallAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureFirewallApplicationRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **type**: 'DNAT' | string: The action type of a rule. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FirewallPolicyPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +## FirewallPolicyRule +* **Discriminator**: ruleType -## AzureFirewallApplicationRule -### Properties +### Base Properties * **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. * **targetFqdns**: string[]: List of FQDNs for this rule. -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## HubIPAddresses +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + + +## FirewallPolicyRuleApplicationProtocol ### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## HubPublicIPAddresses +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType + +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## AzureFirewallPublicIPAddress +## FirewallPolicyThreatIntelWhitelist ### Properties -* **address**: string: Public IP Address value. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallIPConfiguration +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallIPConfigurationPropertiesFormat +## FlowLogFormatParameters ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## AzureFirewallIpGroups +## FlowLogPropertiesFormat ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallNatRuleCollection +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallNatRuleCollectionProperties +## FrontendIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNatRule +## HttpHeader ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## AzureFirewallNetworkRuleCollection +## HubIPAddresses ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## HubIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## HubPublicIPAddresses ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallSku +## HubRoute ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## ResourceTags +## HubRouteTableProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## BastionHostPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## BastionHostIPConfiguration +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## BastionHostIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## InboundNatRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. + +## InboundNatRulePropertiesFormat +### Properties +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## InboundSecurityRuleProperties +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. + +## InboundSecurityRules +### Properties +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. + +## IpAllocationPropertiesFormat +### Properties +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## IpAllocationPropertiesFormatAllocationTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualNetworkGatewayConnectionPropertiesFormat +## IPConfiguration +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. + +## IPConfigurationBgpPeeringAddress +### Properties +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. + +## IPConfigurationProfile +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. + +## IPConfigurationProfilePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IpGroupPropertiesFormat +### Properties +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## IpsecPolicy ### Properties @@ -2206,6 +2299,74 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. + +## Ipv6CircuitConnectionConfig +### Properties +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerBackendAddress +### Properties +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. + +## LoadBalancerBackendAddressPropertiesFormat +### Properties +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + ## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -2225,322 +2386,282 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## BgpSettings +## ManagedRuleGroupOverride ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## IPConfigurationBgpPeeringAddress +## ManagedRuleOverride ### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## AddressSpace +## ManagedRulesDefinition ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ResourceTags +## ManagedRuleSet +### Properties +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## TrafficSelectorPolicy +## MatchCondition ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## TunnelConnectionHealth +## MatchVariable ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## VirtualNetworkGateway +## NatGatewayPropertiesFormat +### Properties +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. + +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkGatewayPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VirtualNetworkGatewayIPConfiguration +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. - -## VirtualNetworkGatewayIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. - -## VpnClientConfiguration -### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -## RadiusServer +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## VpnClientRevokedCertificate +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## VpnClientRootCertificate +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRootCertificatePropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## CustomIpPrefixPropertiesFormat +## NetworkProfilePropertiesFormat ### Properties -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosCustomPolicyPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. - -## ProtocolCustomSettingsFormat -### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## NetworkVirtualAppliancePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## DdosProtectionPlanPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## DdosProtectionPlanTags +## O365BreakOutCategoryPolicies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## DscpConfigurationPropertiesFormat +## O365PolicyProperties ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## QosIpRange +## Office365PolicyProperties ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## QosPortRange +## OutboundRule ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## OutboundRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitPropertiesFormat +## OwaspCrsExclusionEntry ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCircuitAuthorization +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## AuthorizationPropertiesFormat +## P2SConnectionConfigurationProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitPeering +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. - -## ExpressRouteCircuitPeeringPropertiesFormat -### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. - -## ExpressRouteCircuitConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2557,397 +2678,125 @@ * **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. * **connectionName**: string: The name of the express route circuit connection resource. * **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteCrossConnectionProperties -### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. - -## ExpressRouteCircuitReference -### Properties -* **id**: string: Corresponding Express Route Circuit Id. - -## ExpressRouteCrossConnectionPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. - -## ExpressRouteCrossConnectionPeeringProperties -### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteGatewayProperties -### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. - -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. - -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds -### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. - -## ExpressRouteConnection -### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. - -## ExpressRouteConnectionProperties -### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. - -## ExpressRouteCircuitPeeringId -### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. - -## RoutingConfiguration -### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. - -## PropagatedRouteTable -### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. - -## VnetRoute -### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. - -## StaticRoute -### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. - -## VirtualHubId -### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRoutePortPropertiesFormat -### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. - -## ExpressRouteLink -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. - -## ExpressRouteLinkPropertiesFormat -### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## FirewallPolicyPropertiesFormat -### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. - -## DnsSettings -### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. - -## FirewallPolicyThreatIntelWhitelist -### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## FirewallPolicyRuleCollectionGroupProperties -### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - - -## FirewallPolicyFilterRuleCollectionAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. - -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - - -## FirewallPolicyRuleApplicationProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. - -## FirewallPolicyNatRuleCollectionAction -### Properties -* **type**: 'DNAT' | string: The action type of a rule. - -## IpAllocationPropertiesFormat -### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IpAllocationPropertiesFormatAllocationTags +## PolicySettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ResourceTags +## PrivateDnsZoneConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## IpGroupPropertiesFormat +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## PrivateDnsZonePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## LoadBalancerPropertiesFormat +## PrivateEndpoint ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## InboundNatPool +## PrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## InboundNatPoolPropertiesFormat +## PrivateEndpointConnectionProperties ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## LoadBalancingRule +## PrivateEndpointProperties +### Properties +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## PrivateLinkServiceConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## LoadBalancingRulePropertiesFormat +## PrivateLinkServiceConnectionProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## OutboundRule +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## PrivateLinkServiceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## OutboundRulePropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## PrivateLinkServiceProperties +### Properties +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. + +## PrivateLinkServicePropertiesAutoApproval +### Properties +* **subscriptions**: string[]: The list of subscriptions. + +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. ## Probe ### Properties @@ -2967,9 +2816,112 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **requestPath**: 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. -## LoadBalancerSku +## PropagatedRouteTable ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. + +## ProtocolCustomSettingsFormat +### Properties +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. + +## PublicIPPrefixPropertiesFormat +### Properties +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. + +## PublicIPPrefixSku +### Properties +* **name**: 'Standard' | string: Name of a public IP prefix SKU. + +## QosIpRange +### Properties +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. + +## QosPortRange +### Properties +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. + +## RadiusServer +### Properties +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. + +## RecordSet +### Properties +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. + +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## ResourceTags ### Properties @@ -2981,18 +2933,15 @@ ### Additional Properties * **Additional Properties Type**: string -## NatGatewayPropertiesFormat +## ResourceTags ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## NatGatewaySku +## ResourceTags ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3004,56 +2953,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3065,187 +3003,152 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3255,60 +3158,40 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## ResourceTags ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureFilter +## ResourceTags ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +### Additional Properties +* **Additional Properties Type**: string -## PacketCaptureStorageLocation +## ResourceTags ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## P2SVpnGatewayProperties +## ResourceTags ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +### Additional Properties +* **Additional Properties Type**: string -## P2SConnectionConfigurationProperties +## ResourceTags ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientConnectionHealth +## ResourceTags ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3320,166 +3203,246 @@ ### Additional Properties * **Additional Properties Type**: string -## PrivateDnsZoneGroupPropertiesFormat +## RetentionPolicyParameters ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PrivateDnsZoneConfig +## RouteFilterRule ### Properties -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PrivateDnsZonePropertiesFormat +## RouteFilterRulePropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## RecordSet +## RoutePropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. -## PrivateLinkServiceProperties +## RouteTable ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## RouteTablePropertiesFormat +### Properties +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateLinkServicePropertiesAutoApproval +## RoutingConfiguration ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## PrivateLinkServiceIpConfiguration +## SecurityPartnerProviderPropertiesFormat +### Properties +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. + +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateLinkServiceIpConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateEndpointConnection +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ServiceDelegationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ReferencedPublicIpAddress +## ServiceEndpointPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## PublicIPPrefixSku +## StaticRoute ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -## RouteFilterPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## RouteFilterRule +## SubResource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## RouteFilterRulePropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## ResourceTags +## TrafficAnalyticsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## SecurityPartnerProviderPropertiesFormat +## TunnelConnectionHealth ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualApplianceNicProperties +### Properties +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. + +## VirtualApplianceSiteProperties +### Properties +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3502,15 +3465,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3531,78 +3494,85 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute -### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfiguration ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -3623,15 +3593,44 @@ * **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VirtualNetworkTap +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3642,17 +3641,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3664,19 +3652,54 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3706,41 +3729,40 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayIpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **id**: string: The identifier of the IP configuration for a VPN Gateway. +* **privateIpAddress**: string: The private IP address of this IP configuration. +* **publicIpAddress**: string: The public IP address of this IP configuration. -## VpnSiteLinkConnectionProperties +## VpnGatewayProperties ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnGatewayIpConfiguration +## VpnLinkBgpSettings ### Properties -* **id**: string: The identifier of the IP configuration for a VPN Gateway. -* **privateIpAddress**: string: The private IP address of this IP configuration. -* **publicIpAddress**: string: The public IP address of this IP configuration. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3760,37 +3782,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3801,40 +3792,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3843,6 +3800,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3851,18 +3833,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-07-01/types.md b/generated/network/microsoft.network/2020-07-01/types.md index 8f98e2a930..ef4ef528ca 100644 --- a/generated/network/microsoft.network/2020-07-01/types.md +++ b/generated/network/microsoft.network/2020-07-01/types.md @@ -841,55 +841,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -909,6 +881,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -923,1436 +900,1417 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress +## ApplicationGatewayBackendHttpSettings ### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettingsPropertiesFormat +### Properties +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. + +## ApplicationGatewayClientAuthConfiguration +### Properties +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. + +## ApplicationGatewayConnectionDraining +### Properties +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. + +## ApplicationGatewayCustomError +### Properties +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. + +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationSecurityGroup +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## ApplicationGatewayHeaderConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## BackendAddressPool +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayIPConfiguration ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayPathRule ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## InboundNatRule +## ApplicationGatewayPathRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayPrivateLinkConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddress +## ApplicationGatewayPrivateLinkConfigurationProperties +### Properties +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## ExtendedLocation -### Properties -* **name**: string (Required): The name of the extended location. -* **type**: 'EdgeZone' | string (Required): The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## DdosSettings +## ApplicationGatewayProbe ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## IPConfiguration +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## Subnet +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## Delegation +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayRewriteRule +### Properties +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. + +## ApplicationGatewayRewriteRuleActionSet +### Properties +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. + +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkSecurityGroup +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## SecurityRule +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslProfilePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## FlowLog +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **data**: string: Certificate public data. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. - -## TrafficAnalyticsConfigurationProperties -### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. -## FlowLogFormatParameters +## ApplicationGatewayTrustedRootCertificate ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## RetentionPolicyParameters +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## ApplicationGatewayUrlConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## NetworkInterface +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## NetworkInterfaceDnsSettings +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## PrivateEndpoint +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## PrivateEndpointProperties +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## CustomDnsConfigPropertiesFormat -### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. - -## PrivateLinkServiceConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## PrivateLinkServiceConnectionProperties +## AuthorizationPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateLinkService +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateLinkServiceProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## PrivateLinkServicePropertiesAutoApproval +## AzureFirewallApplicationRuleProtocol ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## PrivateLinkServiceIpConfiguration +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceIpConfigurationProperties +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## FrontendIPConfiguration +## AzureFirewallIpGroups ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallNatRCAction ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## PrivateEndpointConnection +## AzureFirewallNatRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## PrivateEndpointConnectionProperties +## AzureFirewallNatRuleCollectionProperties ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## PrivateLinkServicePropertiesVisibility -### Properties -* **subscriptions**: string[]: The list of subscriptions. - -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## NetworkInterfaceTapConfiguration +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. - -## VirtualNetworkTap -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallPublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Public IP Address value. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## ResourceNavigationLink +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ResourceNavigationLinkFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RouteTable +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## RouteTablePropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## Route +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RoutePropertiesFormat +## BgpConnectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceAssociationLink +## BreakOutCategoryPolicies ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ServiceAssociationLinkPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ServiceEndpointPolicy +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ServiceEndpointPolicyPropertiesFormat +## ConnectionMonitorEndpoint ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## ServiceEndpointPolicyDefinition +## ConnectionMonitorEndpointFilter ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## ConnectionMonitorEndpointFilterItem ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ResourceTags +## ConnectionMonitorEndpointScope ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorEndpointScopeItem ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## IpTag +## ConnectionMonitorHttpConfiguration ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## NatGateway +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## NatGatewayPropertiesFormat +## ConnectionMonitorOutput ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. -## NatGatewaySku +## ConnectionMonitorParameters ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ResourceTags +## ConnectionMonitorSource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## PublicIPAddressSku +## ConnectionMonitorSuccessThreshold ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorTcpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorTestConfiguration ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorTestGroup ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayCustomError +## ConnectionMonitorWorkspaceSettings ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewayFrontendIPConfiguration +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterface ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayIPConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayHttpListenerPropertiesFormat +## CustomDnsConfigPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. + +## CustomIpPrefixPropertiesFormat +### Properties +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -## ApplicationGatewayPrivateEndpointConnection +## DdosCustomPolicyPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayPrivateEndpointConnectionProperties +## DdosProtectionPlanPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayPrivateLinkConfiguration +## DdosProtectionPlanTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayPrivateLinkConfigurationProperties +## DdosSettings ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayPrivateLinkIpConfiguration +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## DeviceProperties ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayProbe +## DhcpOptions ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayProbePropertiesFormat +## DnsSettings ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. + +## DscpConfigurationPropertiesFormat +### Properties +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayProbeHealthResponseMatch +## ExpressRouteCircuitAuthorization ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRedirectConfiguration +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. - -## ApplicationGatewayRewriteRule -### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitReference ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayUrlConfiguration +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitSku ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewaySku +## ExpressRouteCircuitStats ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewaySslCertificate +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewaySslProfile +## ExpressRouteConnectionId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewaySslProfilePropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. - -## ApplicationGatewayClientAuthConfiguration -### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **data**: string: Certificate public data. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayUrlPathMap +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ApplicationGatewayPathRule +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ApplicationGatewayFirewallExclusion +## ExpressRouteLinkMacSecConfig ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ResourceTags +## ExpressRouteLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRoutePortPropertiesFormat ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ApplicationGateway +## ExtendedLocation ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string (Required): The name of the extended location. +* **type**: 'EdgeZone' | string (Required): The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## ResourceTags +## FirewallPolicyCertificateAuthority ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## WebApplicationFirewallCustomRule +## FirewallPolicyFilterRuleCollectionAction ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## MatchCondition +## FirewallPolicyIntrusionDetection ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## MatchVariable +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## ManagedRulesDefinition +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## OwaspCrsExclusionEntry +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## ManagedRuleSet +## FirewallPolicyNatRuleCollectionAction ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **type**: 'DNAT' | string: The action type of a rule. -## ManagedRuleGroupOverride +## FirewallPolicyPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. -## ManagedRuleOverride -### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +## FirewallPolicyRule +* **Discriminator**: ruleType -## PolicySettings -### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +### Base Properties +* **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## AzureFirewallPropertiesFormat -### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallAdditionalProperties +## FirewallPolicyRuleApplicationProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## AzureFirewallApplicationRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType -## AzureFirewallApplicationRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## AzureFirewallApplicationRule -### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -## AzureFirewallApplicationRuleProtocol +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## HubIPAddresses +## FirewallPolicySku ### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## HubPublicIPAddresses +## FirewallPolicyThreatIntelWhitelist ### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallPublicIPAddress +## FirewallPolicyTransportSecurity ### Properties -* **address**: string: Public IP Address value. +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. -## AzureFirewallIPConfiguration +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallIPConfigurationPropertiesFormat +## FlowLogFormatParameters ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## AzureFirewallIpGroups +## FlowLogPropertiesFormat ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallNatRuleCollection +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallNatRuleCollectionProperties +## FrontendIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNatRule +## HttpHeader ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## AzureFirewallNetworkRuleCollection +## HubIPAddresses ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## HubIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## HubPublicIPAddresses ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallSku +## HubRoute ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## ResourceTags +## HubRouteTableProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## BastionHostPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## BastionHostIPConfiguration +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## BastionHostIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ResourceTags +## InboundNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## IpsecPolicy +## InboundSecurityRuleProperties ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## LocalNetworkGateway +## InboundSecurityRules ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## LocalNetworkGatewayPropertiesFormat +## IpAllocationPropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## BgpSettings +## IpAllocationPropertiesFormatAllocationTags ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +### Additional Properties +* **Additional Properties Type**: string + +## IPConfiguration +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. ## IPConfigurationBgpPeeringAddress ### Properties @@ -2361,671 +2319,706 @@ * **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. * **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## AddressSpace +## IPConfigurationProfile +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. + +## IPConfigurationProfilePropertiesFormat ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## TrafficSelectorPolicy +## IpGroupPropertiesFormat ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## TunnelConnectionHealth +## IpsecPolicy ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## VirtualNetworkGateway +## IpTag ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VirtualNetworkGatewayPropertiesFormat +## Ipv6CircuitConnectionConfig ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VirtualNetworkGatewayIPConfiguration +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## LoadBalancerBackendAddress ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## VirtualNetworkGatewaySku +## LoadBalancerBackendAddressPropertiesFormat ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## VpnClientConfiguration +## LoadBalancerPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## RadiusServer +## LoadBalancerSku ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. -## VpnClientRevokedCertificate +## LoadBalancingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VpnClientRevokedCertificatePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnClientRootCertificate +## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ResourceTags +## ManagedRuleGroupOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## CustomIpPrefixPropertiesFormat +## ManagedRuleOverride ### Properties -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## ResourceTags +## ManagedRulesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## DdosCustomPolicyPropertiesFormat +## ManagedRuleSet ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ProtocolCustomSettingsFormat +## ManagedServiceIdentity ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## ResourceTags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## DdosProtectionPlanPropertiesFormat +## MatchCondition ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## DdosProtectionPlanTags +## MatchVariable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## DscpConfigurationPropertiesFormat +## NatGateway ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. -## QosIpRange +## NatGatewayPropertiesFormat ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## QosPortRange +## NatGatewaySku ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## ResourceTags +## NetworkInterface ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitAuthorization +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. -## AuthorizationPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteCircuitPeering +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ExpressRouteCircuitConnection +## NetworkProfilePropertiesFormat +### Properties +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. + +## NetworkSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## Ipv6CircuitConnectionConfig +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnectionId +## NetworkWatcherPropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## Ipv6ExpressRouteCircuitPeeringConfig +## O365BreakOutCategoryPolicies ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## ExpressRouteCircuitPeeringConfig +## O365PolicyProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## PeerExpressRouteCircuitConnection +## Office365PolicyProperties +### Properties +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. + +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties -### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. - -## ExpressRouteCircuitSku -### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. - -## ResourceTags +## OwaspCrsExclusionEntry ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCrossConnectionProperties +## P2SConnectionConfiguration ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitReference +## P2SConnectionConfigurationProperties ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCrossConnectionPeering +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCrossConnectionPeeringProperties +## P2SVpnGatewayProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## PacketCaptureFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteGatewayProperties +## PacketCaptureParameters ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. - -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PacketCaptureStorageLocation ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ExpressRouteConnection +## PeerExpressRouteCircuitConnection ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteConnectionProperties +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. -## ExpressRouteCircuitPeeringId +## PolicySettings ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## RoutingConfiguration +## PrivateDnsZoneConfig ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## PropagatedRouteTable +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VnetRoute +## PrivateDnsZonePropertiesFormat ### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## StaticRoute +## PrivateEndpoint ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateEndpointConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PrivateEndpointProperties ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkService ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. - -## ExpressRouteLinkPropertiesFormat -### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## PrivateLinkServiceConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceConnectionProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## DnsSettings +## PrivateLinkServiceConnectionState ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## FirewallPolicyIntrusionDetection +## PrivateLinkServiceIpConfiguration ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyIntrusionDetectionConfiguration +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## PrivateLinkServiceProperties ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicySku +## PrivateLinkServicePropertiesVisibility ### Properties -* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyThreatIntelWhitelist +## Probe ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyTransportSecurity +## ProbePropertiesFormat ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyCertificateAuthority +## PropagatedRouteTable ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## ResourceTags +## ProtocolCustomSettingsFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## FirewallPolicyRuleCollectionGroupProperties +## PublicIPAddress ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. -## FirewallPolicyFilterRuleCollectionAction +## PublicIPPrefixPropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## FirewallPolicyRule -* **Discriminator**: ruleType +## PublicIPPrefixSku +### Properties +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. +## QosIpRange +### Properties +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +## QosPortRange +### Properties +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +## RadiusServer +### Properties +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. +## RecordSet +### Properties +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## FirewallPolicyRuleApplicationProtocol +## ReferencedPublicIpAddress ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +* **id**: string: The PublicIPAddress Reference. -## FirewallPolicyNatRuleCollectionAction +## ResourceNavigationLink ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## IpAllocationPropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3035,113 +3028,65 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3163,56 +3108,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3224,187 +3158,147 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3414,181 +3308,247 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## RetentionPolicyParameters ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PacketCaptureFilter +## RouteFilterRule ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PacketCaptureStorageLocation +## RouteFilterRulePropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## P2SVpnGatewayProperties +## RoutePropertiesFormat ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## RouteTable ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## P2SConnectionConfigurationProperties +## RouteTablePropertiesFormat ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientConnectionHealth +## RoutingConfiguration ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## ResourceTags +## SecurityPartnerProviderPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -## PrivateDnsZoneGroupPropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateDnsZoneConfig +## ServiceAssociationLink ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateDnsZonePropertiesFormat +## ServiceAssociationLinkPropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RecordSet +## ServiceDelegationPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. + +## StaticRoute +### Properties +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. -## ReferencedPublicIpAddress +## Subnet ### Properties -* **id**: string: The PublicIPAddress Reference. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. -## PublicIPPrefixSku +## SubnetPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## RouteFilterPropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## RouteFilterRule +## TrafficAnalyticsProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## RouteFilterRulePropertiesFormat +## TrafficSelectorPolicy ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## SecurityPartnerProviderPropertiesFormat +## VirtualApplianceSiteProperties ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3611,15 +3571,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3640,78 +3600,88 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute -### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfiguration ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -3734,15 +3704,44 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. + +## VirtualNetworkTap +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3753,17 +3752,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3775,20 +3763,54 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3818,41 +3840,41 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection +## VpnGatewayIpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **id**: string: The identifier of the IP configuration for a VPN Gateway. +* **privateIpAddress**: string: The private IP address of this IP configuration. +* **publicIpAddress**: string: The public IP address of this IP configuration. -## VpnSiteLinkConnectionProperties +## VpnGatewayProperties ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## VpnGatewayIpConfiguration +## VpnLinkBgpSettings ### Properties -* **id**: string: The identifier of the IP configuration for a VPN Gateway. -* **privateIpAddress**: string: The private IP address of this IP configuration. -* **publicIpAddress**: string: The public IP address of this IP configuration. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## ResourceTags +## VpnLinkProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3872,37 +3894,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3913,40 +3904,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3955,6 +3912,31 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -3963,18 +3945,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-08-01/types.md b/generated/network/microsoft.network/2020-08-01/types.md index 834847308e..6cf4dc845f 100644 --- a/generated/network/microsoft.network/2020-08-01/types.md +++ b/generated/network/microsoft.network/2020-08-01/types.md @@ -854,55 +854,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -922,6 +894,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -936,2121 +913,2132 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress +## ApplicationGatewayBackendHttpSettings ### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettingsPropertiesFormat +### Properties +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. + +## ApplicationGatewayClientAuthConfiguration +### Properties +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. + +## ApplicationGatewayConnectionDraining +### Properties +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. + +## ApplicationGatewayCustomError +### Properties +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. + +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationSecurityGroup +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## ApplicationGatewayHeaderConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## BackendAddressPool +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **location**: string: The location of the backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayIPConfiguration ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayPathRule ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## InboundNatRule +## ApplicationGatewayPathRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayPrivateLinkConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddress +## ApplicationGatewayPrivateLinkConfigurationProperties +### Properties +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExtendedLocation +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **name**: string (Required): The name of the extended location. -* **type**: 'EdgeZone' | string (Required): The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayProbe ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## DdosSettings +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## PublicIPAddressDnsSettings +## ApplicationGatewayProbePropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## IPConfiguration +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## Subnet +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayIPConfiguration +## ApplicationGatewayRewriteRule +### Properties +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. + +## ApplicationGatewayRewriteRuleActionSet +### Properties +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. + +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## Delegation +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -* **type**: string: Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## IPConfigurationProfile +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewaySslProfilePropertiesFormat ### Properties +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## NetworkSecurityGroup +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **data**: string: Certificate public data. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## SecurityRule +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -* **type**: string: The type of the resource. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. -## FlowLog +## ApplicationGatewayUrlConfiguration +### Properties +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. - -## TrafficAnalyticsConfigurationProperties -### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. - -## FlowLogFormatParameters -### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. - -## RetentionPolicyParameters -### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## NetworkInterface +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## NetworkInterfacePropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## NetworkInterfaceDnsSettings +## AuthorizationPropertiesFormat ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## AzureFirewallAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateEndpointProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## CustomDnsConfigPropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## PrivateLinkServiceConnection +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PrivateLinkServiceConnectionState +## AzureFirewallIpGroups ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ResourceTags +## AzureFirewallNatRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## PrivateLinkService +## AzureFirewallNatRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## PrivateLinkServiceProperties +## AzureFirewallNatRuleCollectionProperties ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## PrivateLinkServicePropertiesAutoApproval +## AzureFirewallNetworkRule ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## PrivateLinkServiceIpConfiguration +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## PrivateLinkServiceIpConfigurationProperties +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## FrontendIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## PrivateEndpointConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## PrivateEndpointConnectionProperties +## AzureFirewallPublicIPAddress ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **address**: string: Public IP Address value. -## PrivateLinkServicePropertiesVisibility +## AzureFirewallRCAction ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## NetworkInterfaceTapConfiguration +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **location**: string: The location of the backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## VirtualNetworkTapPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ResourceTags +## BastionHostPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ResourceNavigationLink +## BreakOutCategoryPolicies ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ResourceNavigationLinkFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## RouteTable +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## RouteTablePropertiesFormat +## ConnectionMonitorEndpoint ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## Route +## ConnectionMonitorEndpointFilter ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -* **type**: string: The type of the resource. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## RoutePropertiesFormat +## ConnectionMonitorEndpointFilterItem ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ResourceTags +## ConnectionMonitorEndpointScope ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ServiceAssociationLink +## ConnectionMonitorEndpointScopeItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## ServiceAssociationLinkPropertiesFormat +## ConnectionMonitorHttpConfiguration ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ServiceEndpointPolicy +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ServiceEndpointPolicyPropertiesFormat +## ConnectionMonitorOutput +### Properties +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters ### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ServiceEndpointPolicyDefinition +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## ConnectionMonitorSuccessThreshold ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceEndpointPropertiesFormat +## ConnectionMonitorTcpConfiguration ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## IpTag +## ConnectionMonitorTestConfiguration ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## NatGateway +## ConnectionMonitorTestGroup ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## NatGatewayPropertiesFormat +## ConnectionMonitorWorkspaceSettings ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## NatGatewaySku +## Container ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **id**: string: Resource ID. -## ResourceTags +## ContainerNetworkInterface ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## PublicIPAddressSku +## ContainerNetworkInterfaceConfiguration ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendHttpSettings +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationGatewayConnectionDraining +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayCustomError +## CustomDnsConfigPropertiesFormat ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayFrontendIPConfiguration +## CustomIpPrefixPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayFrontendPort +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayFrontendPortPropertiesFormat +## DdosProtectionPlanTags ### Properties -* **port**: int: Frontend port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayHttpListener +## DdosSettings +### Properties +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **type**: string: Resource type. -## ApplicationGatewayHttpListenerPropertiesFormat +## DeviceProperties ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayPrivateEndpointConnection +## DhcpOptions ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayPrivateEndpointConnectionProperties +## DnsSettings ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. + +## DscpConfigurationPropertiesFormat +### Properties +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayPrivateLinkConfiguration +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPrivateLinkConfigurationProperties -### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ApplicationGatewayPrivateLinkIpConfiguration +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayProbe +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayProbePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayRedirectConfigurationPropertiesFormat -### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitReference ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitSku ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitStats ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewayUrlConfiguration +## ExpressRouteConnection ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteConnectionId ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewaySku +## ExpressRouteConnectionProperties ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewaySslCertificate +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewaySslPolicy +## ExpressRouteCrossConnectionProperties ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewaySslProfile +## ExpressRouteGatewayProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewaySslProfilePropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayClientAuthConfiguration +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat +## ExpressRouteLinkMacSecConfig ### Properties -* **data**: string: Certificate public data. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteLinkPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRoutePortPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayUrlPathMapPropertiesFormat -### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ApplicationGatewayPathRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayPathRulePropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayWebApplicationFirewallConfiguration -### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. - -## ApplicationGatewayFirewallDisabledRuleGroup -### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. - -## ApplicationGatewayFirewallExclusion -### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WebApplicationFirewallPolicyPropertiesFormat -### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. - -## ApplicationGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WebApplicationFirewallCustomRule -### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. - -## MatchCondition -### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. - -## MatchVariable -### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. - -## ManagedRulesDefinition +## ExtendedLocation ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **name**: string (Required): The name of the extended location. +* **type**: 'EdgeZone' | string (Required): The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## OwaspCrsExclusionEntry +## FirewallPolicyCertificateAuthority ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## ManagedRuleSet +## FirewallPolicyFilterRuleCollectionAction ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ManagedRuleGroupOverride +## FirewallPolicyIntrusionDetection ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## ManagedRuleOverride +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## PolicySettings +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## ResourceTags +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## ResourceTags +## FirewallPolicyNatRuleCollectionAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'DNAT' | string: The action type of a rule. -## AzureFirewallPropertiesFormat +## FirewallPolicyPropertiesFormat ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. * **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. - -## AzureFirewallAdditionalProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureFirewallApplicationRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. - -## AzureFirewallApplicationRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +## FirewallPolicyRule +* **Discriminator**: ruleType -## AzureFirewallApplicationRule -### Properties +### Base Properties * **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. * **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## HubIPAddresses -### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## HubPublicIPAddresses -### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress +## FirewallPolicyRuleApplicationProtocol ### Properties -* **address**: string: Public IP Address value. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## AzureFirewallIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType -## AzureFirewallIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## AzureFirewallIpGroups -### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## AzureFirewallNatRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## AzureFirewallNatRuleCollectionProperties +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## AzureFirewallNetworkRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +## FirewallPolicySku +### Properties +* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## FirewallPolicyThreatIntelWhitelist ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallNetworkRule +## FirewallPolicyTransportSecurity ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. -## AzureFirewallSku +## FlowLog ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## FlowLogFormatParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## BastionHostPropertiesFormat +## FlowLogPropertiesFormat ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## BastionHostIPConfiguration +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## BastionHostIPConfigurationPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## HttpHeader ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## VirtualNetworkGatewayConnectionPropertiesFormat +## HubIPAddresses ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. + +## HubIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## IpsecPolicy +## HubPublicIPAddresses ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## LocalNetworkGateway +## HubRoute ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## LocalNetworkGatewayPropertiesFormat +## HubRouteTableProperties ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## BgpSettings +## HubVirtualNetworkConnectionProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## IPConfigurationBgpPeeringAddress +## InboundNatPool ### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AddressSpace +## InboundNatPoolPropertiesFormat ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## InboundNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## TrafficSelectorPolicy +## InboundNatRulePropertiesFormat ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## TunnelConnectionHealth +## InboundSecurityRuleProperties ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## VirtualNetworkGateway +## InboundSecurityRules ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## VirtualNetworkGatewayPropertiesFormat +## IpAllocationPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## IpAllocationPropertiesFormatAllocationTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkGatewayIPConfiguration +## IPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## IPConfigurationBgpPeeringAddress ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. + +## IPConfigurationProfile +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. + +## IPConfigurationProfilePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + +## IPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewaySku +## IpGroupPropertiesFormat ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnClientConfiguration +## IpsecPolicy ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## RadiusServer +## IpTag ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VpnClientRevokedCertificate +## Ipv6CircuitConnectionConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VpnClientRevokedCertificatePropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VpnClientRootCertificate +## LoadBalancerBackendAddress ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## VpnClientRootCertificatePropertiesFormat +## LoadBalancerBackendAddressPropertiesFormat +### Properties +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## LoadBalancerPropertiesFormat ### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## ResourceTags +## LoadBalancerSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. -## ResourceTags +## LoadBalancingRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## CustomIpPrefixPropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -## ResourceTags +## LocalNetworkGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosCustomPolicyPropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ProtocolCustomSettingsFormat +## ManagedRuleGroupOverride ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ResourceTags +## ManagedRuleOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## DdosProtectionPlanPropertiesFormat +## ManagedRulesDefinition ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## DdosProtectionPlanTags +## ManagedRuleSet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## DscpConfigurationPropertiesFormat +## ManagedServiceIdentity ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## QosIpRange +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## QosPortRange +## MatchCondition ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## ResourceTags +## MatchVariable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## ExpressRouteCircuitPropertiesFormat +## NatGateway ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. + +## NatGatewayPropertiesFormat +### Properties +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## ExpressRouteCircuitAuthorization +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AuthorizationPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitPeering +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteCircuitConnection +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId +## NetworkProfilePropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkSecurityGroup ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringConfig +## NetworkSecurityGroupPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PeerExpressRouteCircuitConnection +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats +## O365BreakOutCategoryPolicies ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## ExpressRouteCircuitServiceProviderProperties +## O365PolicyProperties ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## ExpressRouteCircuitSku +## Office365PolicyProperties ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCrossConnectionProperties +## OutboundRulePropertiesFormat ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ExpressRouteCircuitReference +## OwaspCrsExclusionEntry ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCrossConnectionPeering +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCrossConnectionPeeringProperties +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ResourceTags +## P2SVpnGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteGatewayProperties +## P2SVpnGatewayProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PacketCaptureFilter ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PacketCaptureParameters ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteConnection +## PacketCaptureStorageLocation +### Properties +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. + +## PeerExpressRouteCircuitConnection ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteConnectionProperties +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. -## ExpressRouteCircuitPeeringId +## PolicySettings ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## RoutingConfiguration +## PrivateDnsZoneConfig ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## PropagatedRouteTable +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VnetRoute +## PrivateDnsZonePropertiesFormat ### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## StaticRoute +## PrivateEndpoint ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateEndpointConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PrivateEndpointProperties ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkService ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceConnection ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkMacSecConfig +## PrivateLinkServiceConnectionProperties ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ResourceTags +## PrivateLinkServiceConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceIpConfiguration ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## DnsSettings +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyIntrusionDetection +## PrivateLinkServiceProperties ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyIntrusionDetectionConfiguration +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## PrivateLinkServicePropertiesVisibility ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## Probe ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicySku +## ProbePropertiesFormat ### Properties -* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyThreatIntelWhitelist +## PropagatedRouteTable ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## FirewallPolicyTransportSecurity +## ProtocolCustomSettingsFormat ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## FirewallPolicyCertificateAuthority +## PublicIPAddress ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ResourceTags +## PublicIPAddressDnsSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## FirewallPolicyRuleCollectionGroupProperties +## PublicIPAddressPropertiesFormat ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. -## FirewallPolicyFilterRuleCollectionAction +## PublicIPPrefixPropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## FirewallPolicyRule -* **Discriminator**: ruleType +## PublicIPPrefixSku +### Properties +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. +## QosIpRange +### Properties +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +## QosPortRange +### Properties +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +## RadiusServer +### Properties +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. +## RecordSet +### Properties +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## FirewallPolicyRuleApplicationProtocol +## ReferencedPublicIpAddress ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +* **id**: string: The PublicIPAddress Reference. -## FirewallPolicyNatRuleCollectionAction +## ResourceNavigationLink ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## IpAllocationPropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3060,113 +3048,65 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3188,56 +3128,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3249,187 +3178,147 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration -### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3439,181 +3328,252 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## RetentionPolicyParameters ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **type**: string: The type of the resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PacketCaptureFilter +## RouteFilterRule ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PacketCaptureStorageLocation +## RouteFilterRulePropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## P2SVpnGatewayProperties +## RoutePropertiesFormat ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## RouteTable ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## P2SConnectionConfigurationProperties +## RouteTablePropertiesFormat ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientConnectionHealth +## RoutingConfiguration ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## ResourceTags +## SecurityPartnerProviderPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **type**: string: The type of the resource. -## PrivateDnsZoneGroupPropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateDnsZoneConfig +## ServiceAssociationLink ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateDnsZonePropertiesFormat +## ServiceAssociationLinkPropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RecordSet +## ServiceDelegationPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PublicIPPrefixSku +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. + +## StaticRoute +### Properties +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. + +## Subnet +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. + +## SubnetPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## RouteFilterPropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## RouteFilterRule +## TrafficAnalyticsProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## RouteFilterRulePropertiesFormat +## TrafficSelectorPolicy ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## SecurityPartnerProviderPropertiesFormat +## VirtualApplianceSiteProperties ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3636,15 +3596,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3665,78 +3625,88 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute -### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfiguration ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -3760,15 +3730,44 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network Peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. + +## VirtualRouterPeeringProperties +### Properties +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3779,17 +3778,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3801,77 +3789,82 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. -* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnConnection +## VpnClientRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnConnectionProperties](#vpnconnectionproperties): Parameters for VpnConnection. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. -## VpnConnectionProperties +## VpnClientRootCertificatePropertiesFormat ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **dpdTimeoutSeconds**: int: DPD timeout in seconds for vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableInternetSecurity**: bool: Enable internet security. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVpnSite**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. +* **publicCertData**: string (Required): The certificate public data. -## VpnSiteLinkConnection +## VpnConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **properties**: [VpnConnectionProperties](#vpnconnectionproperties): Parameters for VpnConnection. -## VpnSiteLinkConnectionProperties +## VpnConnectionProperties ### Properties * **connectionBandwidth**: int: Expected bandwidth in MBPS. * **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **dpdTimeoutSeconds**: int: DPD timeout in seconds for vpn connection. * **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. * **enableBgp**: bool: EnableBgp flag. +* **enableInternetSecurity**: bool: Enable internet security. * **enableRateLimiting**: bool: EnableBgp flag. * **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. * **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVpnSite**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. * **routingWeight**: int: Routing weight for vpn connection. * **sharedKey**: string: SharedKey for the vpn connection. * **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. * **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. ## VpnGatewayIpConfiguration ### Properties @@ -3898,14 +3891,40 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. +## VpnGatewayProperties +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. +* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + ## VpnNatRuleMapping ### Properties * **addressSpace**: string: Address space for Vpn NatRule mapping. -## ResourceTags +## VpnServerConfigRadiusClientRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3925,37 +3944,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3966,40 +3954,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -4008,6 +3962,34 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -4016,18 +3998,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2020-11-01/types.md b/generated/network/microsoft.network/2020-11-01/types.md index ee7e02fee0..ac93d1fa5c 100644 --- a/generated/network/microsoft.network/2020-11-01/types.md +++ b/generated/network/microsoft.network/2020-11-01/types.md @@ -855,55 +855,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -923,6 +895,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -937,1412 +914,1477 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress +## ApplicationGatewayBackendHttpSettings ### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettingsPropertiesFormat +### Properties +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. + +## ApplicationGatewayClientAuthConfiguration +### Properties +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. + +## ApplicationGatewayConnectionDraining +### Properties +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. + +## ApplicationGatewayCustomError +### Properties +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. + +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationSecurityGroup +## ApplicationGatewayFrontendPort ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties +* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## ApplicationGatewayHeaderConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## BackendAddressPool +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **location**: string: The location of the backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayIPConfiguration ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **subnet**: [SubResource](#subresource): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## SubResource +## ApplicationGatewayPathRule ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## InboundNatRule +## ApplicationGatewayPathRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayPrivateLinkConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddress +## ApplicationGatewayPrivateLinkConfigurationProperties +### Properties +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExtendedLocation +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **name**: string (Required): The name of the extended location. -* **type**: 'EdgeZone' | string (Required): The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayProbe ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## DdosSettings +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## PublicIPAddressDnsSettings +## ApplicationGatewayProbePropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## IPConfiguration +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## Subnet +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayIPConfiguration +## ApplicationGatewayRewriteRule +### Properties +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. + +## ApplicationGatewayRewriteRuleActionSet +### Properties +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. + +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## Delegation +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -* **type**: string: Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## IPConfigurationProfile +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewaySslProfilePropertiesFormat ### Properties +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## NetworkSecurityGroup +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **data**: string: Certificate public data. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## SecurityRule +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -* **type**: string: The type of the resource. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. -## FlowLog +## ApplicationGatewayUrlConfiguration +### Properties +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. + +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. - -## TrafficAnalyticsProperties -### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. - -## TrafficAnalyticsConfigurationProperties -### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. - -## FlowLogFormatParameters -### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. - -## RetentionPolicyParameters -### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. -## ResourceTags +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## NetworkInterface +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## NetworkInterfacePropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## NetworkInterfaceDnsSettings +## AuthorizationPropertiesFormat ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint +## AzureFirewallAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateEndpointProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## CustomDnsConfigPropertiesFormat +## AzureFirewallApplicationRuleProtocol ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## PrivateLinkServiceConnection +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PrivateLinkServiceConnectionState +## AzureFirewallIpGroups ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ResourceTags +## AzureFirewallNatRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## PrivateLinkService +## AzureFirewallNatRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## PrivateLinkServiceProperties +## AzureFirewallNatRuleCollectionProperties ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## PrivateLinkServicePropertiesAutoApproval +## AzureFirewallNetworkRule ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## PrivateLinkServiceIpConfiguration +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## PrivateLinkServiceIpConfigurationProperties +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## FrontendIPConfiguration +## AzureFirewallPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## FrontendIPConfigurationPropertiesFormat -### Properties -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## PrivateEndpointConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## PrivateEndpointConnectionProperties +## AzureFirewallPublicIPAddress ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **address**: string: Public IP Address value. -## PrivateLinkServicePropertiesVisibility +## AzureFirewallRCAction ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## NetworkInterfaceTapConfiguration +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **location**: string: The location of the backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## VirtualNetworkTapPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ResourceTags +## BastionHostPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ResourceNavigationLink +## BreakOutCategoryPolicies ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ResourceNavigationLinkFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## RouteTable +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## RouteTablePropertiesFormat +## ConnectionMonitorEndpoint ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## Route +## ConnectionMonitorEndpointFilter ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -* **type**: string: The type of the resource. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## RoutePropertiesFormat +## ConnectionMonitorEndpointFilterItem ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ResourceTags +## ConnectionMonitorEndpointScope ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ServiceAssociationLink +## ConnectionMonitorEndpointScopeItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## ServiceAssociationLinkPropertiesFormat +## ConnectionMonitorHttpConfiguration ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ServiceEndpointPolicy +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ServiceEndpointPolicyPropertiesFormat +## ConnectionMonitorOutput +### Properties +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters ### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ServiceEndpointPolicyDefinition +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## ConnectionMonitorSuccessThreshold ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceEndpointPropertiesFormat +## ConnectionMonitorTcpConfiguration ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## IpTag +## ConnectionMonitorTestConfiguration ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## NatGateway +## ConnectionMonitorTestGroup ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## NatGatewayPropertiesFormat +## ConnectionMonitorWorkspaceSettings ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## NatGatewaySku +## Container ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **id**: string: Resource ID. -## ResourceTags +## ContainerNetworkInterface ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## PublicIPAddressSku +## ContainerNetworkInterfaceConfiguration ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ResourceTags +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendHttpSettings +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationGatewayConnectionDraining +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayCustomError +## CustomDnsConfigPropertiesFormat ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayFrontendIPConfiguration +## CustomIpPrefixPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayFrontendPort +## DdosProtectionPlanPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayFrontendPortPropertiesFormat +## DdosProtectionPlanTags ### Properties -* **port**: int: Frontend port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayHttpListener +## DdosSettings +### Properties +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **type**: string: Resource type. -## ApplicationGatewayHttpListenerPropertiesFormat +## DeviceProperties ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayPrivateEndpointConnection +## DhcpOptions ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayPrivateEndpointConnectionProperties +## DnsSettings ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. + +## DscpConfigurationPropertiesFormat +### Properties +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayPrivateLinkConfiguration +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPrivateLinkConfigurationProperties -### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ApplicationGatewayPrivateLinkIpConfiguration +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayProbe +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayProbePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. - -## ApplicationGatewayProbeHealthResponseMatch -### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. - -## ApplicationGatewayRedirectConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayRedirectConfigurationPropertiesFormat -### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayRewriteRuleSet -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitPropertiesFormat ### Properties +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. - -## ApplicationGatewayRewriteRule -### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. - -## ApplicationGatewayRewriteRuleActionSet -### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitReference ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayUrlConfiguration +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitSku ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewaySku +## ExpressRouteCircuitStats ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewaySslCertificate +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewaySslProfile +## ExpressRouteConnectionId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewaySslProfilePropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. - -## ApplicationGatewayClientAuthConfiguration -### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **data**: string: Certificate public data. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayUrlPathMap +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ApplicationGatewayPathRule +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteLinkMacSecConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteLinkPropertiesFormat ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRoutePortPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ApplicationGatewayFirewallExclusion +## ExtendedLocation ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **name**: string (Required): The name of the extended location. +* **type**: 'EdgeZone' | string (Required): The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## ResourceTags +## FirewallPolicyCertificateAuthority ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## WebApplicationFirewallPolicyPropertiesFormat +## FirewallPolicyFilterRuleCollectionAction ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ApplicationGateway +## FirewallPolicyInsights ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. +* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. +* **retentionDays**: int: Number of days the insights should be enabled on the policy. -## ResourceTags +## FirewallPolicyIntrusionDetection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## WebApplicationFirewallCustomRule +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## MatchCondition +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## MatchVariable +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## ManagedRulesDefinition +## FirewallPolicyLogAnalyticsResources ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. +* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. -## OwaspCrsExclusionEntry +## FirewallPolicyLogAnalyticsWorkspace ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **region**: string: Region to configure the Workspace. +* **workspaceId**: [SubResource](#subresource): Reference to another subresource. -## ManagedRuleSet +## FirewallPolicyNatRuleCollectionAction ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **type**: 'DNAT' | string: The action type of a rule. -## ManagedRuleGroupOverride +## FirewallPolicyPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. +* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. -## ManagedRuleOverride +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties +* **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. + +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. + +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + + +## FirewallPolicyRuleApplicationProtocol ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## PolicySettings +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType + +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## ResourceTags +## FirewallPolicySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## ResourceTags +## FirewallPolicySnat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. -## AzureFirewallPropertiesFormat +## FirewallPolicyThreatIntelWhitelist ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallAdditionalProperties +## FirewallPolicyTransportSecurity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. -## AzureFirewallApplicationRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FlowLogFormatParameters ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. + +## FlowLogPropertiesFormat +### Properties +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallRCAction +## FrontendIPConfiguration ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRule +## FrontendIPConfigurationPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRuleProtocol +## HttpHeader ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. ## HubIPAddresses ### Properties * **privateIPAddress**: string: Private IP Address associated with azure firewall. * **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. -## HubPublicIPAddresses +## HubIPConfigurationPropertiesFormat ### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallPublicIPAddress +## HubPublicIPAddresses ### Properties -* **address**: string: Public IP Address value. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallIPConfiguration +## HubRoute ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## AzureFirewallIPConfigurationPropertiesFormat +## HubRouteTableProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## AzureFirewallIpGroups +## HubVirtualNetworkConnectionProperties ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## AzureFirewallNetworkRule +## InboundSecurityRuleProperties ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## AzureFirewallSku +## InboundSecurityRules ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## ResourceTags +## IpAllocationPropertiesFormat +### Properties +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## IpAllocationPropertiesFormatAllocationTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BastionHostPropertiesFormat +## IPConfiguration ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## BastionHostIPConfiguration +## IPConfigurationBgpPeeringAddress +### Properties +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. + +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## BastionHostIPConfigurationPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. ## IpsecPolicy ### Properties @@ -2355,728 +2397,672 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## LocalNetworkGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## LocalNetworkGatewayPropertiesFormat -### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. - -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## IPConfigurationBgpPeeringAddress -### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. - -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TrafficSelectorPolicy -### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. - -## TunnelConnectionHealth -### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. - -## VirtualNetworkGateway +## IpTag ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VirtualNetworkGatewayPropertiesFormat +## Ipv6CircuitConnectionConfig ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VirtualNetworkGatewayIPConfiguration +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## LoadBalancerBackendAddress ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## VirtualNetworkGatewaySku +## LoadBalancerBackendAddressPropertiesFormat ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## VpnClientConfiguration +## LoadBalancerPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## RadiusServer +## LoadBalancerSku ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. -## VpnClientRevokedCertificate +## LoadBalancingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VpnClientRevokedCertificatePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnClientRootCertificate +## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ResourceTags +## ManagedRuleGroupOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## CustomIpPrefixPropertiesFormat +## ManagedRuleOverride ### Properties -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## ResourceTags +## ManagedRulesDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## DdosCustomPolicyPropertiesFormat +## ManagedRuleSet ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ProtocolCustomSettingsFormat +## ManagedServiceIdentity ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## ResourceTags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## DdosProtectionPlanPropertiesFormat +## MatchCondition ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## DdosProtectionPlanTags +## MatchVariable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## DscpConfigurationPropertiesFormat +## NatGateway ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. -## QosIpRange +## NatGatewayPropertiesFormat ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## QosPortRange +## NatGatewaySku ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## ResourceTags +## NetworkInterface ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitAuthorization +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. -## AuthorizationPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## ExpressRouteCircuitPeering +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## ExpressRouteCircuitConnection +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId +## NetworkProfilePropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkSecurityGroup ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringConfig +## NetworkSecurityGroupPropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PeerExpressRouteCircuitConnection +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkWatcherPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats +## O365BreakOutCategoryPolicies ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## ExpressRouteCircuitServiceProviderProperties +## O365PolicyProperties ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## ExpressRouteCircuitSku +## Office365PolicyProperties ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCrossConnectionProperties +## OutboundRulePropertiesFormat ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ExpressRouteCircuitReference +## OwaspCrsExclusionEntry ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCrossConnectionPeering +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCrossConnectionPeeringProperties +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ResourceTags +## P2SVpnGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteGatewayProperties +## P2SVpnGatewayProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. + +## PacketCaptureFilter +### Properties +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PacketCaptureParameters ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PacketCaptureStorageLocation ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ExpressRouteConnection +## PeerExpressRouteCircuitConnection ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteConnectionProperties +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. -## ExpressRouteCircuitPeeringId +## PolicySettings ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## RoutingConfiguration +## PrivateDnsZoneConfig ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## PropagatedRouteTable +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VnetRoute +## PrivateDnsZonePropertiesFormat ### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## StaticRoute +## PrivateEndpoint ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateEndpointConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PrivateEndpointProperties ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteLink +## PrivateLinkService ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceConnection ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. + +## PrivateLinkServiceConnectionProperties +### Properties +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ExpressRouteLinkMacSecConfig +## PrivateLinkServiceConnectionState ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ResourceTags +## PrivateLinkServiceIpConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyPropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## DnsSettings +## PrivateLinkServiceProperties ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyInsights +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. -* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. -* **retentionDays**: int: Number of days the insights should be enabled on the policy. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyLogAnalyticsResources +## PrivateLinkServicePropertiesVisibility ### Properties -* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. -* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyLogAnalyticsWorkspace +## Probe ### Properties -* **region**: string: Region to configure the Workspace. -* **workspaceId**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyIntrusionDetection +## ProbePropertiesFormat ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyIntrusionDetectionConfiguration +## PropagatedRouteTable ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## ProtocolCustomSettingsFormat ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## PublicIPAddressDnsSettings ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## FirewallPolicySku +## PublicIPAddressPropertiesFormat ### Properties -* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -## FirewallPolicySnat +## PublicIPAddressSku ### Properties -* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. -## FirewallPolicyThreatIntelWhitelist +## PublicIPPrefixPropertiesFormat ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## FirewallPolicyTransportSecurity +## PublicIPPrefixSku ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. -## FirewallPolicyCertificateAuthority +## QosIpRange ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. -## ResourceTags +## QosPortRange ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. -## FirewallPolicyRuleCollectionGroupProperties +## RadiusServer ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. -## FirewallPolicyFilterRuleCollectionAction +## RecordSet ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. - -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## FirewallPolicyRuleApplicationProtocol +## ReferencedPublicIpAddress ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +* **id**: string: The PublicIPAddress Reference. -## FirewallPolicyNatRuleCollectionAction +## ResourceNavigationLink ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## IpAllocationPropertiesFormat +## ResourceNavigationLinkFormat ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3086,113 +3072,55 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat -### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat -### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. - -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3214,56 +3142,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3275,187 +3192,157 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3465,181 +3352,253 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## RetentionPolicyParameters ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **type**: string: The type of the resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PacketCaptureFilter +## RouteFilterRule ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PacketCaptureStorageLocation +## RouteFilterRulePropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## P2SVpnGatewayProperties +## RoutePropertiesFormat ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## RouteTable ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## P2SConnectionConfigurationProperties +## RouteTablePropertiesFormat ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientConnectionHealth +## RoutingConfiguration ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## ResourceTags +## SecurityPartnerProviderPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **type**: string: The type of the resource. -## PrivateDnsZoneGroupPropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateDnsZoneConfig +## ServiceAssociationLink ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateDnsZonePropertiesFormat +## ServiceAssociationLinkPropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RecordSet +## ServiceDelegationPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. + +## ServiceEndpointPolicyPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. + +## ServiceEndpointPropertiesFormat +### Properties +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. + +## StaticRoute +### Properties +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. + +## Subnet +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. - -## ReferencedPublicIpAddress -### Properties -* **id**: string: The PublicIPAddress Reference. - -## PublicIPPrefixSku -### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## RouteFilterPropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## RouteFilterRule +## TrafficAnalyticsProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## RouteFilterRulePropertiesFormat +## TrafficSelectorPolicy ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## SecurityPartnerProviderPropertiesFormat +## VirtualApplianceSiteProperties ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3662,15 +3621,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3691,78 +3650,88 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute -### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfiguration ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -3786,15 +3755,44 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. + +## VirtualNetworkTapPropertiesFormat +### Properties +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. + +## VirtualRouterPeeringProperties +### Properties +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## VirtualRouterPropertiesFormat ### Properties @@ -3805,17 +3803,6 @@ * **virtualRouterAsn**: int: VirtualRouter ASN. * **virtualRouterIps**: string[]: VirtualRouter IPs. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualRouterPeeringProperties -### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -3827,21 +3814,55 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. -* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3872,34 +3893,6 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. - -## VpnSiteLinkConnectionProperties -### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. - ## VpnGatewayIpConfiguration ### Properties * **id**: string: The identifier of the IP configuration for a VPN Gateway. @@ -3925,14 +3918,40 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. +## VpnGatewayProperties +### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. +* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + ## VpnNatRuleMapping ### Properties * **addressSpace**: string: Address space for Vpn NatRule mapping. -## ResourceTags +## VpnServerConfigRadiusClientRootCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -3952,37 +3971,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -3993,40 +3981,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -4035,6 +3989,34 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -4043,18 +4025,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2021-02-01-preview/types.md b/generated/network/microsoft.network/2021-02-01-preview/types.md index 1b97aab066..79e987ac80 100644 --- a/generated/network/microsoft.network/2021-02-01-preview/types.md +++ b/generated/network/microsoft.network/2021-02-01-preview/types.md @@ -216,87 +216,96 @@ * **Input**: [QueryRequestOptions](#queryrequestoptions) * **Output**: [NetworkManagerEffectiveSecurityAdminRulesListResult](#networkmanagereffectivesecurityadminruleslistresult) -## NetworkManagerProperties -### Properties -* **description**: string: A description of the network manager. -* **displayName**: string: A friendly name for the network manager. -* **networkManagerScopeAccesses**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[]: Scope Access. -* **networkManagerScopes**: [NetworkManagerPropertiesNetworkManagerScopes](#networkmanagerpropertiesnetworkmanagerscopes): Scope of Network Manager. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +## ActiveBaseSecurityAdminRule +* **Discriminator**: kind -## NetworkManagerPropertiesNetworkManagerScopes -### Properties -* **managementGroups**: string[]: List of management groups. -* **subscriptions**: string[]: List of subscriptions. +### Base Properties +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationDescription**: string (ReadOnly): A description of the security admin configuration. +* **configurationDisplayName**: string (ReadOnly): A display name of the security admin configuration. +* **id**: string (ReadOnly): Resource ID. +* **region**: string (ReadOnly): Deployment region. +* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection +* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. +* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. +* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +### ActiveSecurityAdminRule +#### Properties +* **kind**: 'Custom' (Required): Whether the rule is custom or default. +* **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### ActiveDefaultSecurityAdminRule +#### Properties +* **kind**: 'Default' (Required): Whether the rule is custom or default. +* **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string -## ConnectivityConfigurationProperties +## ActiveBaseSecurityUserRule +* **Discriminator**: kind + +### Base Properties +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationDescription**: string (ReadOnly): A description of the security user configuration. +* **configurationDisplayName**: string (ReadOnly): A display name of the security user configuration. +* **id**: string (ReadOnly): Resource ID. +* **region**: string (ReadOnly): Deployment region. +* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection +* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. +* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. +* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +### ActiveSecurityUserRule +#### Properties +* **kind**: 'Custom' (Required): Whether the rule is custom or default. +* **properties**: [UserRulePropertiesFormat](#userrulepropertiesformat) (ReadOnly): Security rule resource. + +### ActiveDefaultSecurityUserRule +#### Properties +* **kind**: 'Default' (Required): Whether the rule is custom or default. +* **properties**: [DefaultUserRulePropertiesFormat](#defaultuserrulepropertiesformat) (ReadOnly): Security default user rule resource. + + +## ActiveConfigurationParameter ### Properties -* **appliesToGroups**: [ConnectivityGroupItem](#connectivitygroupitem)[]: Groups for configuration -* **connectivityTopology**: 'HubAndSpoke' | 'Mesh' | string (Required): Connectivity topology type. -* **deleteExistingPeering**: 'False' | 'True' | string: Flag if need to remove current existing peerings. -* **description**: string: A description of the connectivity configuration. -* **displayName**: string: A friendly name for the resource. -* **hubs**: [Hub](#hub)[]: List of hubItems -* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## ConnectivityGroupItem +## ActiveConfigurationParameter ### Properties -* **groupConnectivity**: 'DirectlyConnected' | 'None' | string: Group connectivity type. -* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. -* **networkGroupId**: string: Network group Id. -* **useHubGateway**: 'False' | 'True' | string: Flag if need to use hub gateway. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## Hub +## ActiveConfigurationParameter ### Properties -* **resourceId**: string: Resource Id. -* **resourceType**: string: Resource Type. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## NetworkGroupProperties +## ActiveConnectivityConfiguration ### Properties -* **conditionalMembership**: string: Network group conditional filter. -* **description**: string: A description of the network group. -* **displayName**: string: A friendly name for the network group. -* **groupMembers**: [GroupMembersItem](#groupmembersitem)[]: Group members of network group. -* **memberType**: string: Group member type. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration +* **region**: string (ReadOnly): Deployment region. -## GroupMembersItem +## ActiveConnectivityConfigurationsListResult ### Properties -* **resourceId**: string: Resource Id. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveConnectivityConfiguration](#activeconnectivityconfiguration)[] (ReadOnly): Gets a page of active connectivity configurations. -## SecurityConfigurationPropertiesFormat +## ActiveSecurityAdminRulesListResult ### Properties -* **deleteExistingNSGs**: 'False' | 'True' | string: Flag if need to delete existing network security groups. -* **description**: string: A description of the security configuration. -* **displayName**: string: A display name of the security configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityType**: 'AdminPolicy' | 'UserPolicy' | string: Security Type. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveBaseSecurityAdminRule](#activebasesecurityadminrule)[] (ReadOnly): Gets a page of active security admin rules. -## RuleCollectionPropertiesFormat +## ActiveSecurityUserRulesListResult ### Properties -* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[]: Groups for configuration -* **description**: string: A description of the rule collection. -* **displayName**: string: A display name of the rule collection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveBaseSecurityUserRule](#activebasesecurityuserrule)[] (ReadOnly): Gets a page of active security user rules. -## NetworkManagerSecurityGroupItem +## AddressPrefixItem ### Properties -* **networkGroupId**: string: Network manager group Id. +* **addressPrefix**: string: Address prefix. +* **addressPrefixType**: 'IPPrefix' | 'ServiceTag' | string: Address prefix type. ## AdminPropertiesFormat ### Properties @@ -312,10 +321,28 @@ * **sourcePortRanges**: string[]: The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. -## AddressPrefixItem +## ConfigurationGroup ### Properties -* **addressPrefix**: string: Address prefix. -* **addressPrefixType**: 'IPPrefix' | 'ServiceTag' | string: Address prefix type. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [NetworkGroupProperties](#networkgroupproperties) (ReadOnly): Properties of network group + +## ConnectivityConfigurationProperties +### Properties +* **appliesToGroups**: [ConnectivityGroupItem](#connectivitygroupitem)[]: Groups for configuration +* **connectivityTopology**: 'HubAndSpoke' | 'Mesh' | string (Required): Connectivity topology type. +* **deleteExistingPeering**: 'False' | 'True' | string: Flag if need to remove current existing peerings. +* **description**: string: A description of the connectivity configuration. +* **displayName**: string: A friendly name for the resource. +* **hubs**: [Hub](#hub)[]: List of hubItems +* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ConnectivityGroupItem +### Properties +* **groupConnectivity**: 'DirectlyConnected' | 'None' | string: Group connectivity type. +* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. +* **networkGroupId**: string: Network group Id. +* **useHubGateway**: 'False' | 'True' | string: Flag if need to use hub gateway. ## DefaultAdminPropertiesFormat ### Properties @@ -332,18 +359,6 @@ * **sourcePortRanges**: string[] (ReadOnly): The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[] (ReadOnly): The CIDR or source IP ranges. -## UserRulePropertiesFormat -### Properties -* **description**: string: A description for this rule. -* **destinationPortRanges**: string[]: The destination port ranges. -* **destinations**: [AddressPrefixItem](#addressprefixitem)[]: The destination address prefixes. CIDR or destination IP ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic. -* **displayName**: string: A friendly name for the rule. -* **protocol**: 'Ah' | 'Any' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourcePortRanges**: string[]: The source port ranges. -* **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. - ## DefaultUserRulePropertiesFormat ### Properties * **description**: string (ReadOnly): A description for this rule. Restricted to 140 chars. @@ -357,169 +372,76 @@ * **sourcePortRanges**: string[] (ReadOnly): The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[] (ReadOnly): The CIDR or source IP ranges. -## NetworkSecurityPerimeterProperties -### Properties -* **description**: string: A description of the network security perimeter. -* **displayName**: string: A friendly name for the network security perimeter. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NspProfileProperties -### Properties -* **accessRulesVersion**: string (ReadOnly): Version number that increases with every update to access rules within the profile. -* **enabledLogCategories**: [LoggingCategory](#loggingcategory)[]: Gets the enabled log categories. - -## LoggingCategory -### Properties -* **name**: string: The name of the logging category. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NspAccessRuleProperties -### Properties -* **addressPrefixes**: string[]: Inbound address prefixes (IPv4/IPv6) -* **direction**: 'Inbound' | 'Outbound' | string: Direction that specifies whether the access rules is inbound/outbound. -* **fullyQualifiedDomainNames**: string[]: Outbound rules fully qualified domain name format. -* **networkSecurityPerimeters**: [PerimeterBasedAccessRule](#perimeterbasedaccessrule)[]: Inbound rule specified by the perimeter id. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subscriptions**: string[]: Subscription id in the ARM id format. - -## PerimeterBasedAccessRule -### Properties -* **id**: string: NSP id in the ARM id format. -* **location**: string (ReadOnly): Location of the NSP supplied. -* **perimeterGuid**: string (ReadOnly): Resource guid of the NSP supplied. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NspAssociationProperties -### Properties -* **accessMode**: 'Audit' | 'Enforced' | 'Learning' | string: Access mode on the association. -* **hasProvisioningIssues**: string (ReadOnly): Specifies if there are provisioning issues -* **privateLinkResource**: [SubResource](#subresource): Reference to another subresource. -* **profile**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## SubResource -### Properties -* **id**: string: Resource ID. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ActiveConfigurationParameter -### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. - -## ActiveConnectivityConfigurationsListResult -### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveConnectivityConfiguration](#activeconnectivityconfiguration)[] (ReadOnly): Gets a page of active connectivity configurations. - -## ActiveConnectivityConfiguration -### Properties -* **commitTime**: string (ReadOnly): Deployment time string. -* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration -* **region**: string (ReadOnly): Deployment region. - -## ConfigurationGroup -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [NetworkGroupProperties](#networkgroupproperties) (ReadOnly): Properties of network group - -## ActiveConfigurationParameter -### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. - -## ActiveSecurityAdminRulesListResult -### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveBaseSecurityAdminRule](#activebasesecurityadminrule)[] (ReadOnly): Gets a page of active security admin rules. - -## ActiveBaseSecurityAdminRule +## EffectiveBaseSecurityAdminRule * **Discriminator**: kind ### Base Properties -* **commitTime**: string (ReadOnly): Deployment time string. * **configurationDescription**: string (ReadOnly): A description of the security admin configuration. * **configurationDisplayName**: string (ReadOnly): A display name of the security admin configuration. * **id**: string (ReadOnly): Resource ID. -* **region**: string (ReadOnly): Deployment region. * **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection * **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. * **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. * **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### ActiveSecurityAdminRule +### EffectiveSecurityAdminRule #### Properties * **kind**: 'Custom' (Required): Whether the rule is custom or default. * **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. -### ActiveDefaultSecurityAdminRule +### EffectiveDefaultSecurityAdminRule #### Properties * **kind**: 'Default' (Required): Whether the rule is custom or default. * **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. -## ActiveConfigurationParameter +## EffectiveConnectivityConfiguration ### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration -## ActiveSecurityUserRulesListResult +## EffectiveVirtualNetwork +### Properties +* **id**: string (ReadOnly): Effective vnet Id. +* **location**: string (ReadOnly): Location of vnet. +* **membershipType**: 'Dynamic' | 'Static' | string (ReadOnly): Membership Type. + +## EffectiveVirtualNetworksListResult ### Properties * **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveBaseSecurityUserRule](#activebasesecurityuserrule)[] (ReadOnly): Gets a page of active security user rules. +* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork -## ActiveBaseSecurityUserRule -* **Discriminator**: kind +## EffectiveVirtualNetworksListResult +### Properties +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork -### Base Properties -* **commitTime**: string (ReadOnly): Deployment time string. -* **configurationDescription**: string (ReadOnly): A description of the security user configuration. -* **configurationDisplayName**: string (ReadOnly): A display name of the security user configuration. -* **id**: string (ReadOnly): Resource ID. -* **region**: string (ReadOnly): Deployment region. -* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection -* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. -* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. -* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### ActiveSecurityUserRule -#### Properties -* **kind**: 'Custom' (Required): Whether the rule is custom or default. -* **properties**: [UserRulePropertiesFormat](#userrulepropertiesformat) (ReadOnly): Security rule resource. +## EffectiveVirtualNetworksParameter +### Properties +* **conditionalMembers**: string (WriteOnly): Conditional Members. +* **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. -### ActiveDefaultSecurityUserRule -#### Properties -* **kind**: 'Default' (Required): Whether the rule is custom or default. -* **properties**: [DefaultUserRulePropertiesFormat](#defaultuserrulepropertiesformat) (ReadOnly): Security default user rule resource. +## GroupMembersItem +### Properties +* **resourceId**: string: Resource Id. +## Hub +### Properties +* **resourceId**: string: Resource Id. +* **resourceType**: string: Resource Type. -## NetworkManagerDeploymentStatusParameter +## LoggingCategory ### Properties -* **deploymentTypes**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (WriteOnly): List of deployment types. -* **regions**: string[] (WriteOnly): List of locations. -* **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. +* **name**: string: The name of the logging category. -## NetworkManagerDeploymentStatusListResult +## NetworkGroupProperties ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [NetworkManagerDeploymentStatus](#networkmanagerdeploymentstatus)[] (ReadOnly): Gets a page of Network Manager Deployment Status +* **conditionalMembership**: string: Network group conditional filter. +* **description**: string: A description of the network group. +* **displayName**: string: A friendly name for the network group. +* **groupMembers**: [GroupMembersItem](#groupmembersitem)[]: Group members of network group. +* **memberType**: string: Group member type. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. ## NetworkManagerDeploymentStatus ### Properties @@ -530,74 +452,152 @@ * **errorMessage**: string (ReadOnly): Error Message. * **region**: string (ReadOnly): Region Name. -## EffectiveVirtualNetworksParameter +## NetworkManagerDeploymentStatusListResult ### Properties -* **conditionalMembers**: string (WriteOnly): Conditional Members. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [NetworkManagerDeploymentStatus](#networkmanagerdeploymentstatus)[] (ReadOnly): Gets a page of Network Manager Deployment Status + +## NetworkManagerDeploymentStatusParameter +### Properties +* **deploymentTypes**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (WriteOnly): List of deployment types. +* **regions**: string[] (WriteOnly): List of locations. * **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. -## EffectiveVirtualNetworksListResult +## NetworkManagerEffectiveConnectivityConfigurationListResult ### Properties * **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork +* **value**: [EffectiveConnectivityConfiguration](#effectiveconnectivityconfiguration)[] (ReadOnly): Gets a page of NetworkManagerEffectiveConnectivityConfiguration -## EffectiveVirtualNetwork +## NetworkManagerEffectiveSecurityAdminRulesListResult ### Properties -* **id**: string (ReadOnly): Effective vnet Id. -* **location**: string (ReadOnly): Location of vnet. -* **membershipType**: 'Dynamic' | 'Static' | string (ReadOnly): Membership Type. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveBaseSecurityAdminRule](#effectivebasesecurityadminrule)[] (ReadOnly): Gets a page of NetworkManagerEffectiveSecurityAdminRules + +## NetworkManagerProperties +### Properties +* **description**: string: A description of the network manager. +* **displayName**: string: A friendly name for the network manager. +* **networkManagerScopeAccesses**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[]: Scope Access. +* **networkManagerScopes**: [NetworkManagerPropertiesNetworkManagerScopes](#networkmanagerpropertiesnetworkmanagerscopes): Scope of Network Manager. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## NetworkManagerPropertiesNetworkManagerScopes +### Properties +* **managementGroups**: string[]: List of management groups. +* **subscriptions**: string[]: List of subscriptions. + +## NetworkManagerSecurityGroupItem +### Properties +* **networkGroupId**: string: Network manager group Id. + +## NetworkSecurityPerimeterProperties +### Properties +* **description**: string: A description of the network security perimeter. +* **displayName**: string: A friendly name for the network security perimeter. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## NspAccessRuleProperties +### Properties +* **addressPrefixes**: string[]: Inbound address prefixes (IPv4/IPv6) +* **direction**: 'Inbound' | 'Outbound' | string: Direction that specifies whether the access rules is inbound/outbound. +* **fullyQualifiedDomainNames**: string[]: Outbound rules fully qualified domain name format. +* **networkSecurityPerimeters**: [PerimeterBasedAccessRule](#perimeterbasedaccessrule)[]: Inbound rule specified by the perimeter id. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subscriptions**: string[]: Subscription id in the ARM id format. + +## NspAssociationProperties +### Properties +* **accessMode**: 'Audit' | 'Enforced' | 'Learning' | string: Access mode on the association. +* **hasProvisioningIssues**: string (ReadOnly): Specifies if there are provisioning issues +* **privateLinkResource**: [SubResource](#subresource): Reference to another subresource. +* **profile**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Accepted' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## NspProfileProperties +### Properties +* **accessRulesVersion**: string (ReadOnly): Version number that increases with every update to access rules within the profile. +* **enabledLogCategories**: [LoggingCategory](#loggingcategory)[]: Gets the enabled log categories. + +## PerimeterBasedAccessRule +### Properties +* **id**: string: NSP id in the ARM id format. +* **location**: string (ReadOnly): Location of the NSP supplied. +* **perimeterGuid**: string (ReadOnly): Resource guid of the NSP supplied. ## QueryRequestOptions ### Properties * **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## EffectiveVirtualNetworksListResult +## QueryRequestOptions ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. ## QueryRequestOptions ### Properties * **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## NetworkManagerEffectiveConnectivityConfigurationListResult +## ResourceTags ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveConnectivityConfiguration](#effectiveconnectivityconfiguration)[] (ReadOnly): Gets a page of NetworkManagerEffectiveConnectivityConfiguration +### Additional Properties +* **Additional Properties Type**: string -## EffectiveConnectivityConfiguration +## ResourceTags ### Properties -* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration +### Additional Properties +* **Additional Properties Type**: string -## QueryRequestOptions +## ResourceTags ### Properties -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +### Additional Properties +* **Additional Properties Type**: string -## NetworkManagerEffectiveSecurityAdminRulesListResult +## ResourceTags ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveBaseSecurityAdminRule](#effectivebasesecurityadminrule)[] (ReadOnly): Gets a page of NetworkManagerEffectiveSecurityAdminRules +### Additional Properties +* **Additional Properties Type**: string -## EffectiveBaseSecurityAdminRule -* **Discriminator**: kind +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -### Base Properties -* **configurationDescription**: string (ReadOnly): A description of the security admin configuration. -* **configurationDisplayName**: string (ReadOnly): A display name of the security admin configuration. -* **id**: string (ReadOnly): Resource ID. -* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection -* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. -* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. -* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### EffectiveSecurityAdminRule -#### Properties -* **kind**: 'Custom' (Required): Whether the rule is custom or default. -* **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. +## RuleCollectionPropertiesFormat +### Properties +* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[]: Groups for configuration +* **description**: string: A description of the rule collection. +* **displayName**: string: A display name of the rule collection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -### EffectiveDefaultSecurityAdminRule -#### Properties -* **kind**: 'Default' (Required): Whether the rule is custom or default. -* **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. +## SecurityConfigurationPropertiesFormat +### Properties +* **deleteExistingNSGs**: 'False' | 'True' | string: Flag if need to delete existing network security groups. +* **description**: string: A description of the security configuration. +* **displayName**: string: A display name of the security configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityType**: 'AdminPolicy' | 'UserPolicy' | string: Security Type. + +## SubResource +### Properties +* **id**: string: Resource ID. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserRulePropertiesFormat +### Properties +* **description**: string: A description for this rule. +* **destinationPortRanges**: string[]: The destination port ranges. +* **destinations**: [AddressPrefixItem](#addressprefixitem)[]: The destination address prefixes. CIDR or destination IP ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic. +* **displayName**: string: A friendly name for the rule. +* **protocol**: 'Ah' | 'Any' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourcePortRanges**: string[]: The source port ranges. +* **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. diff --git a/generated/network/microsoft.network/2021-02-01/types.md b/generated/network/microsoft.network/2021-02-01/types.md index 1da03b7daf..bcf3cba3f6 100644 --- a/generated/network/microsoft.network/2021-02-01/types.md +++ b/generated/network/microsoft.network/2021-02-01/types.md @@ -866,55 +866,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -934,6 +906,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -948,1472 +925,1470 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayClientAuthConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayCustomError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## SubResource +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -* **id**: string: Resource ID. +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **location**: string: The location of the backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## GatewayLoadBalancerTunnelInterface +## ApplicationGatewayHeaderConfiguration ### Properties -* **identifier**: int: Identifier of gateway load balancer tunnel interface. -* **port**: int: Port of gateway load balancer tunnel interface. -* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. -* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## InboundNatRule +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayIPConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddress +## ApplicationGatewayIPConfigurationPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ExtendedLocation +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayPrivateEndpointConnection ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. +* **type**: string (ReadOnly): Type of the resource. + +## ApplicationGatewayPrivateEndpointConnectionProperties +### Properties +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -## DdosSettings +## ApplicationGatewayPrivateLinkConfiguration ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayPrivateLinkConfigurationProperties ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IPConfiguration +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties +* **primary**: bool: Whether the ip configuration is primary or not. * **privateIPAddress**: string: The private IP address of the IP configuration. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. + +## ApplicationGatewayProbePropertiesFormat +### Properties +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ApplicationGatewayIPConfiguration +## ApplicationGatewayPropertiesFormat +### Properties +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. + +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## Delegation +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -* **type**: string: Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## NetworkSecurityGroup +## ApplicationGatewayRewriteRuleCondition +### Properties +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. + +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## SecurityRule +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -* **type**: string: The type of the resource. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## FlowLog +## ApplicationGatewaySslPolicy +### Properties +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. + +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewaySslProfilePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## TrafficAnalyticsProperties +## ApplicationGatewayTrustedClientCertificate ### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. +* **data**: string: Certificate public data. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **validatedCertData**: string (ReadOnly): Validated certificate data. -## FlowLogFormatParameters +## ApplicationGatewayTrustedRootCertificate ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## RetentionPolicyParameters +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## ApplicationGatewayUrlConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## NetworkInterface +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources -## NetworkInterfaceDnsSettings +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## PrivateEndpoint +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## PrivateEndpointProperties +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource id of private endpoint. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## CustomDnsConfigPropertiesFormat +## AuthorizationPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServiceConnection +## AzureFirewallAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateLinkServiceConnectionProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -* **resolvedPrivateLinkServiceLocation**: string: The location for the resolved private link service. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## ResourceTags +## AzureFirewallApplicationRuleProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. -## PrivateLinkService +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceProperties +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string: The resource id of private link service. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PrivateLinkServicePropertiesAutoApproval +## AzureFirewallIpGroups ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## PrivateLinkServiceIpConfiguration +## AzureFirewallNatRCAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## PrivateLinkServiceIpConfigurationProperties +## AzureFirewallNatRule ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## FrontendIPConfiguration +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## PrivateEndpointConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. - -## PrivateEndpointConnectionProperties -### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## PrivateLinkServicePropertiesVisibility -### Properties -* **subscriptions**: string[]: The list of subscriptions. - -## ResourceTags +## AzureFirewallNetworkRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## NetworkInterfaceTapConfiguration +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. - -## VirtualNetworkTap -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallPublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Public IP Address value. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceTags +## AzureFirewallSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## ResourceNavigationLink +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ResourceNavigationLinkFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **location**: string: The location of the backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. -## RouteTable +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## RouteTablePropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## Route +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -* **type**: string: The type of the resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RoutePropertiesFormat +## BgpConnectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceAssociationLink +## BreakOutCategoryPolicies ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ServiceAssociationLinkPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ServiceEndpointPolicy +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ServiceEndpointPolicyPropertiesFormat +## ConnectionMonitorEndpoint ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## ServiceEndpointPolicyDefinition +## ConnectionMonitorEndpointFilter ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## ConnectionMonitorEndpointFilterItem ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ResourceTags +## ConnectionMonitorEndpointScope ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorEndpointScopeItem ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## IpTag +## ConnectionMonitorHttpConfiguration ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## NatGateway +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## NatGatewayPropertiesFormat +## ConnectionMonitorOutput ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. -## NatGatewaySku +## ConnectionMonitorParameters ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ResourceTags +## ConnectionMonitorSource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## PublicIPAddressSku +## ConnectionMonitorSuccessThreshold ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ResourceTags +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorTcpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorTestConfiguration ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorTestGroup ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayCustomError +## ConnectionMonitorWorkspaceSettings ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewayFrontendIPConfiguration +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat -### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayFrontendPortPropertiesFormat -### Properties -* **port**: int: Frontend port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayHttpListener +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayHttpListenerPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayPrivateEndpointConnection +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateEndpointConnectionProperties +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPrivateLinkConfiguration +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPrivateLinkConfigurationProperties +## CustomDnsConfigPropertiesFormat ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayPrivateLinkIpConfiguration +## CustomIpPrefix ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [CustomIpPrefixPropertiesFormat](#customipprefixpropertiesformat): Custom IP prefix properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## CustomIpPrefixPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **authorizationMessage**: string: Authorization message for WAN validation. +* **childCustomIpPrefixes**: [CustomIpPrefix](#customipprefix)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **customIpPrefixParent**: [CustomIpPrefix](#customipprefix): Custom IP prefix resource. +* **failedReason**: string (ReadOnly): The reason why resource is in failed state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **signedMessage**: string: Signed message for WAN validation. -## ApplicationGatewayProbe +## DdosCustomPolicyPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayProbePropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayProbeHealthResponseMatch +## DdosProtectionPlanTags ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRedirectConfiguration +## DdosSettings +### Properties +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. + +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **type**: string: Resource type. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DeviceProperties ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRequestRoutingRule +## DhcpOptions ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## DnsSettings ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. + +## DscpConfigurationPropertiesFormat +### Properties +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. + +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitPeering ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPeeringConfig ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPeeringId ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayUrlConfiguration +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitPropertiesFormat ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewaySku +## ExpressRouteCircuitReference ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteCircuitSku ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewaySslPolicy +## ExpressRouteCircuitStats ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewaySslProfile +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewaySslProfilePropertiesFormat +## ExpressRouteConnectionId ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewayClientAuthConfiguration +## ExpressRouteConnectionProperties ### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. -* **data**: string: Certificate public data. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **validatedCertData**: string (ReadOnly): Validated certificate data. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayUrlPathMap +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ApplicationGatewayPathRule +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteLinkMacSecConfig ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteLinkPropertiesFormat ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRoutePortPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ApplicationGatewayFirewallExclusion +## ExtendedLocation ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## ResourceTags +## FirewallPolicyCertificateAuthority ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## WebApplicationFirewallPolicyPropertiesFormat +## FirewallPolicyFilterRuleCollectionAction ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ApplicationGateway +## FirewallPolicyInsights ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. +* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. +* **retentionDays**: int: Number of days the insights should be enabled on the policy. -## ResourceTags +## FirewallPolicyIntrusionDetection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## WebApplicationFirewallCustomRule +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## MatchCondition +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## MatchVariable +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## ManagedRulesDefinition +## FirewallPolicyLogAnalyticsResources ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. +* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. -## OwaspCrsExclusionEntry +## FirewallPolicyLogAnalyticsWorkspace ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **region**: string: Region to configure the Workspace. +* **workspaceId**: [SubResource](#subresource): Reference to another subresource. -## ManagedRuleSet +## FirewallPolicyNatRuleCollectionAction ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **type**: 'DNAT' | string: The action type of a rule. -## ManagedRuleGroupOverride +## FirewallPolicyPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. +* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. -## ManagedRuleOverride -### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +## FirewallPolicyRule +* **Discriminator**: ruleType -## PolicySettings -### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +### Base Properties +* **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## AzureFirewallPropertiesFormat -### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallAdditionalProperties +## FirewallPolicyRuleApplicationProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## AzureFirewallApplicationRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType -## AzureFirewallApplicationRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## AzureFirewallRCAction -### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## AzureFirewallApplicationRule + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## AzureFirewallApplicationRuleProtocol +## FirewallPolicySku ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## HubIPAddresses +## FirewallPolicySnat ### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. -## HubPublicIPAddresses +## FirewallPolicyThreatIntelWhitelist ### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallPublicIPAddress +## FirewallPolicyTransportSecurity ### Properties -* **address**: string: Public IP Address value. +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. -## AzureFirewallIPConfiguration +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallIPConfigurationPropertiesFormat +## FlowLogFormatParameters ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## AzureFirewallIpGroups +## FlowLogPropertiesFormat ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallNatRuleCollection +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallNatRuleCollectionProperties +## FrontendIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNatRCAction +## GatewayLoadBalancerTunnelInterface ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **identifier**: int: Identifier of gateway load balancer tunnel interface. +* **port**: int: Port of gateway load balancer tunnel interface. +* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. +* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. -## AzureFirewallNatRule +## HttpHeader ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## AzureFirewallNetworkRuleCollection +## HubIPAddresses ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## HubIPConfigurationPropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallNetworkRule +## HubPublicIPAddresses ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallSku +## HubRoute ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## ResourceTags +## HubRouteTableProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## BastionHostPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## BastionHostIPConfiguration +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## BastionHostIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## Sku +## InboundNatRule ### Properties -* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## InboundNatRulePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VirtualNetworkGatewayConnectionPropertiesFormat +## InboundSecurityRuleProperties ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## IpsecPolicy +## InboundSecurityRules ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## LocalNetworkGateway +## IpAllocationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## LocalNetworkGatewayPropertiesFormat +## IpAllocationPropertiesFormatAllocationTags ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. +### Additional Properties +* **Additional Properties Type**: string -## BgpSettings +## IPConfiguration ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. ## IPConfigurationBgpPeeringAddress ### Properties @@ -2422,740 +2397,727 @@ * **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. * **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## AddressSpace -### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TrafficSelectorPolicy +## IPConfigurationProfile ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## TunnelConnectionHealth +## IPConfigurationProfilePropertiesFormat ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGateway +## IPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## VirtualNetworkGatewayIPConfiguration +## IpsecPolicy ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## IpTag ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## VirtualNetworkGatewayNatRule +## Ipv6CircuitConnectionConfig ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. -* **type**: string (ReadOnly): Resource type. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## VirtualNetworkGatewayNatRuleProperties +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. -* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. -* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. -* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## VpnNatRuleMapping +## LoadBalancerBackendAddress ### Properties -* **addressSpace**: string: Address space for Vpn NatRule mapping. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## VirtualNetworkGatewaySku +## LoadBalancerBackendAddressPropertiesFormat ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## VpnClientConfiguration +## LoadBalancerPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## RadiusServer +## LoadBalancerSku ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. -## VpnClientRevokedCertificate +## LoadBalancingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VpnClientRevokedCertificatePropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## VpnClientRootCertificate +## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRootCertificatePropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ResourceTags +## ManagedRuleGroupOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ResourceTags +## ManagedRuleOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## CustomIpPrefixPropertiesFormat +## ManagedRulesDefinition ### Properties -* **authorizationMessage**: string: Authorization message for WAN validation. -* **childCustomIpPrefixes**: [CustomIpPrefix](#customipprefix)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. -* **customIpPrefixParent**: [CustomIpPrefix](#customipprefix): Custom IP prefix resource. -* **failedReason**: string (ReadOnly): The reason why resource is in failed state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -* **signedMessage**: string: Signed message for WAN validation. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## CustomIpPrefix +## ManagedRuleSet ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [CustomIpPrefixPropertiesFormat](#customipprefixpropertiesformat): Custom IP prefix properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ResourceTags +## ManagedServiceIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## ResourceTags +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## DdosCustomPolicyPropertiesFormat +## MatchCondition ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## ProtocolCustomSettingsFormat +## MatchVariable ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## ResourceTags +## NatGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. -## DdosProtectionPlanPropertiesFormat +## NatGatewayPropertiesFormat ### Properties +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## DdosProtectionPlanTags +## NatGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## DscpConfigurationPropertiesFormat +## NetworkInterface ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## QosIpRange +## NetworkInterfaceDnsSettings ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## QosPortRange +## NetworkInterfaceIPConfiguration ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. -## ResourceTags +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## ExpressRouteCircuitPropertiesFormat +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. + +## NetworkInterfacePropertiesFormat +### Properties +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources -## ExpressRouteCircuitAuthorization +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## AuthorizationPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ExpressRouteCircuitPeering -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. - -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkProfilePropertiesFormat ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ExpressRouteCircuitConnection +## NetworkSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## Ipv6CircuitConnectionConfig +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnectionId +## NetworkWatcherPropertiesFormat ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## Ipv6ExpressRouteCircuitPeeringConfig +## O365BreakOutCategoryPolicies ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## ExpressRouteCircuitPeeringConfig +## O365PolicyProperties ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## PeerExpressRouteCircuitConnection +## Office365PolicyProperties +### Properties +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. + +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats +## OwaspCrsExclusionEntry ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteCircuitServiceProviderProperties +## P2SConnectionConfiguration ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitSku +## P2SConnectionConfigurationProperties ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ResourceTags +## P2SVpnGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCrossConnectionProperties +## P2SVpnGatewayProperties ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteCircuitReference +## PacketCaptureFilter ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRouteCrossConnectionPeering +## PacketCaptureParameters ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCrossConnectionPeeringProperties +## PacketCaptureStorageLocation ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## ResourceTags +## PeerExpressRouteCircuitConnection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteGatewayProperties +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PolicySettings ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PrivateDnsZoneConfig ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string (ReadOnly): The id of the privateDnsZoneConfig. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **type**: string (ReadOnly): Type of resource. Will be specified as private dns zone configurations. -## ExpressRouteConnection +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteConnectionProperties +## PrivateDnsZonePropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **privateDnsZoneId**: string: The resource id of the private dns zone. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## ExpressRouteCircuitPeeringId +## PrivateEndpoint ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## RoutingConfiguration +## PrivateEndpointConnection ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## PropagatedRouteTable +## PrivateEndpointConnectionProperties ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VnetRoute +## PrivateEndpointProperties ### Properties -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource id of private endpoint. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## StaticRoute +## PrivateLinkService ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualHubId +## PrivateLinkServiceConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateLinkServiceConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **resolvedPrivateLinkServiceLocation**: string: The location for the resolved private link service. -## ExpressRoutePortPropertiesFormat +## PrivateLinkServiceConnectionState ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ExpressRouteLink +## PrivateLinkServiceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## PrivateLinkServiceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string: The resource id of private link service. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyPropertiesFormat +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **subscriptions**: string[]: The list of subscriptions. -## DnsSettings +## PrivateLinkServicePropertiesVisibility ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyInsights +## Probe ### Properties -* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. -* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. -* **retentionDays**: int: Number of days the insights should be enabled on the policy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyLogAnalyticsResources +## ProbePropertiesFormat ### Properties -* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. -* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyLogAnalyticsWorkspace +## PropagatedRouteTable ### Properties -* **region**: string: Region to configure the Workspace. -* **workspaceId**: [SubResource](#subresource): Reference to another subresource. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## FirewallPolicyIntrusionDetection +## ProtocolCustomSettingsFormat ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## FirewallPolicyIntrusionDetectionConfiguration +## PublicIPAddress ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## PublicIPAddressDnsSettings ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## PublicIPAddressPropertiesFormat ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -## FirewallPolicySku +## PublicIPAddressSku ### Properties -* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. -## FirewallPolicySnat +## PublicIPPrefixPropertiesFormat ### Properties -* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## FirewallPolicyThreatIntelWhitelist +## PublicIPPrefixSku ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. -## FirewallPolicyTransportSecurity +## QosIpRange ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. -## FirewallPolicyCertificateAuthority +## QosPortRange ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. -## ResourceTags +## RadiusServer ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. -## FirewallPolicyRuleCollectionGroupProperties +## RecordSet ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## FirewallPolicyFilterRuleCollectionAction +## ReferencedPublicIpAddress ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. - -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - +* **id**: string: The PublicIPAddress Reference. -## FirewallPolicyRuleApplicationProtocol +## ResourceNavigationLink ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## FirewallPolicyNatRuleCollectionAction +## ResourceNavigationLinkFormat ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IpAllocationPropertiesFormat +## ResourceTags ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3165,114 +3127,65 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3294,56 +3207,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3355,187 +3257,147 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3545,185 +3407,257 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## RetentionPolicyParameters ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **type**: string: The type of the resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PacketCaptureFilter +## RouteFilterRule ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PacketCaptureStorageLocation +## RouteFilterRulePropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## P2SVpnGatewayProperties +## RoutePropertiesFormat ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## RouteTable ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## P2SConnectionConfigurationProperties +## RouteTablePropertiesFormat ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientConnectionHealth +## RoutingConfiguration ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## ResourceTags +## SecurityPartnerProviderPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **type**: string: The type of the resource. -## PrivateDnsZoneGroupPropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateDnsZoneConfig +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string (ReadOnly): The id of the privateDnsZoneConfig. +* **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -* **type**: string (ReadOnly): Type of resource. Will be specified as private dns zone configurations. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateDnsZonePropertiesFormat +## ServiceAssociationLinkPropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## RecordSet +## ServiceDelegationPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PublicIPPrefixSku +## ServiceEndpointPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## ResourceTags +## Sku +### Properties +* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. + +## StaticRoute +### Properties +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. + +## Subnet +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## RouteFilterPropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## RouteFilterRule +## TrafficAnalyticsProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## RouteFilterRulePropertiesFormat +## TrafficSelectorPolicy ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## SecurityPartnerProviderPropertiesFormat +## VirtualApplianceSiteProperties ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3747,15 +3681,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3776,79 +3710,109 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute -### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfiguration ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayNatRuleProperties ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. +* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. +* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. +* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## VirtualNetworkBgpCommunities +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -3874,35 +3838,54 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualRouterPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. -* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. -* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualRouterAsn**: int: VirtualRouter ASN. -* **virtualRouterIps**: string[]: VirtualRouter IPs. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. -## ResourceTags +## VirtualRouterPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VirtualRouterPeeringProperties +## VirtualRouterPropertiesFormat ### Properties -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. +* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. +* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. +* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualRouterAsn**: int: VirtualRouter ASN. +* **virtualRouterIps**: string[]: VirtualRouter IPs. ## VirtualWanProperties ### Properties @@ -3915,21 +3898,55 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. -* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -3960,34 +3977,6 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. - -## VpnSiteLinkConnectionProperties -### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. - ## VpnGatewayIpConfiguration ### Properties * **id**: string: The identifier of the IP configuration for a VPN Gateway. @@ -4013,10 +4002,40 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. +* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnNatRuleMapping +### Properties +* **addressSpace**: string: Address space for Vpn NatRule mapping. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -4036,37 +4055,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -4077,40 +4065,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -4119,6 +4073,34 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -4127,18 +4109,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2021-03-01/types.md b/generated/network/microsoft.network/2021-03-01/types.md index 3b8adf4ce8..bd7da9c83f 100644 --- a/generated/network/microsoft.network/2021-03-01/types.md +++ b/generated/network/microsoft.network/2021-03-01/types.md @@ -867,57 +867,27 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.Network/vpnSites' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **globalConfiguration**: [ApplicationGatewayGlobalConfiguration](#applicationgatewayglobalconfiguration): Application Gateway global configuration. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **loadDistributionPolicies**: [ApplicationGatewayLoadDistributionPolicy](#applicationgatewayloaddistributionpolicy)[]: Load distribution policies of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -937,6 +907,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -951,2299 +926,2280 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayClientAuthConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayCustomError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## SubResource +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -* **id**: string: Resource ID. +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **location**: string: The location of the backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## GatewayLoadBalancerTunnelInterface +## ApplicationGatewayGlobalConfiguration ### Properties -* **identifier**: int: Identifier of gateway load balancer tunnel interface. -* **port**: int: Port of gateway load balancer tunnel interface. -* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. -* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. +* **enableRequestBuffering**: bool: Enable request buffering. +* **enableResponseBuffering**: bool: Enable response buffering. -## InboundNatRule +## ApplicationGatewayHeaderConfiguration +### Properties +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. + +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **frontendPortRangeEnd**: int: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. -* **frontendPortRangeStart**: int: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +## ApplicationGatewayIPConfiguration ### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddress +## ApplicationGatewayIPConfigurationPropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. + +## ApplicationGatewayLoadDistributionPolicy ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayLoadDistributionPolicyPropertiesFormat](#applicationgatewayloaddistributionpolicypropertiesformat): Properties of Load Distribution Policy of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ExtendedLocation +## ApplicationGatewayLoadDistributionPolicyPropertiesFormat ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **loadDistributionAlgorithm**: 'IpHash' | 'LeastConnections' | 'RoundRobin' | string: Load Distribution Algorithm enums. +* **loadDistributionTargets**: [ApplicationGatewayLoadDistributionTarget](#applicationgatewayloaddistributiontarget)[]: Load Distribution Targets resource of an application gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayLoadDistributionTarget ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. - -## DdosSettings -### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayLoadDistributionTargetPropertiesFormat](#applicationgatewayloaddistributiontargetpropertiesformat) +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayLoadDistributionTargetPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **weightPerServer**: int: Weight per server. Range between 1 and 100. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ApplicationGatewayIPConfiguration +## ApplicationGatewayPrivateLinkConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ApplicationGatewayPrivateLinkConfigurationProperties ### Properties +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Delegation +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -* **type**: string: Resource type. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **globalConfiguration**: [ApplicationGatewayGlobalConfiguration](#applicationgatewayglobalconfiguration): Application Gateway global configuration. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **loadDistributionPolicies**: [ApplicationGatewayLoadDistributionPolicy](#applicationgatewayloaddistributionpolicy)[]: Load distribution policies of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -* **type**: string: The type of the resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## FlowLog +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## TrafficAnalyticsProperties +## ApplicationGatewayRewriteRule ### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. - -## FlowLogFormatParameters -### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. - -## RetentionPolicyParameters -### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## ResourceTags +## ApplicationGatewayRewriteRuleCondition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## NetworkInterface +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkInterfaceDnsSettings +## ApplicationGatewaySku ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## PrivateEndpoint +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointProperties +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the private endpoint IP configuration is included. -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **customNetworkInterfaceName**: string: The custom name of the network interface attached to the private endpoint. -* **ipConfigurations**: [PrivateEndpointIPConfiguration](#privateendpointipconfiguration)[]: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## CustomDnsConfigPropertiesFormat +## ApplicationGatewaySslPolicy ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## PrivateEndpointIPConfiguration +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource that is unique within a resource group. -* **properties**: [PrivateEndpointIPConfigurationProperties](#privateendpointipconfigurationproperties): Properties of an IP Configuration of the private endpoint. -* **type**: string (ReadOnly): The resource type. +* **id**: string: Resource ID. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointIPConfigurationProperties +## ApplicationGatewaySslProfilePropertiesFormat ### Properties -* **groupId**: string: The ID of a group obtained from the remote resource that this private endpoint should connect to. -* **memberName**: string: The member name of a group obtained from the remote resource that this private endpoint should connect to. -* **privateIPAddress**: string: A private ip address obtained from the private endpoint's subnet. +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## PrivateLinkServiceConnection +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. +* **data**: string: Certificate public data. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **validatedCertData**: string (ReadOnly): Validated certificate data. -## PrivateLinkService +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceProperties +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## PrivateLinkServicePropertiesAutoApproval +## ApplicationGatewayUrlConfiguration ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## PrivateLinkServiceIpConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceIpConfigurationProperties +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultLoadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## FrontendIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. -* **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FrontendIPConfigurationPropertiesFormat +## ApplicationGatewayWebApplicationFirewallConfiguration ### Properties -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. -## PrivateEndpointConnection +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PrivateEndpointConnectionProperties +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## PrivateLinkServicePropertiesVisibility +## AuthorizationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## NetworkInterfaceTapConfiguration +## AzureFirewallApplicationRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## VirtualNetworkTap +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallIpGroups ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## ResourceTags +## AzureFirewallNatRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ResourceTags +## AzureFirewallNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ResourceNavigationLink +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## RouteTable +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## RouteTablePropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## Route -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -* **type**: string: The type of the resource. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## RoutePropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallPublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Public IP Address value. -## ServiceAssociationLink +## AzureFirewallRCAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallSku ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## ServiceEndpointPolicy +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ServiceEndpointPolicyPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **contextualServiceEndpointPolicies**: string[]: A collection of contextual service endpoint policy. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **location**: string: The location of the backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceAlias**: string: The alias indicating if the policy belongs to a service -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. -## ServiceEndpointPolicyDefinition +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -* **type**: string: The type of the resource. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## ResourceTags +## BastionHostPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disableCopyPaste**: bool: Enable/Disable Copy/Paste feature of the Bastion Host resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **enableFileCopy**: bool: Enable/Disable File Copy feature of the Bastion Host resource. +* **enableIpConnect**: bool: Enable/Disable IP Connect feature of the Bastion Host resource. +* **enableShareableLink**: bool: Enable/Disable Shareable Link of the Bastion Host resource. +* **enableTunneling**: bool: Enable/Disable Tunneling feature of the Bastion Host resource. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **scaleUnits**: int: The scale units for the Bastion Host resource. -## ServiceEndpointPropertiesFormat +## BgpConnectionProperties ### Properties -* **locations**: string[]: A list of locations. +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **hubVirtualNetworkConnection**: [SubResource](#subresource): Reference to another subresource. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. -## IpTag +## BgpSettings ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## NatGateway +## BreakOutCategoryPolicies ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## NatGatewayPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NatGatewaySku +## ConnectionMonitorDestination ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ResourceTags +## ConnectionMonitorEndpoint ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## PublicIPAddressSku +## ConnectionMonitorEndpointFilter ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ResourceTags +## ConnectionMonitorEndpointFilterItem ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorEndpointScope ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorEndpointScopeItem ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## ApplicationGatewayConnectionDraining +## ConnectionMonitorHttpConfiguration ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ApplicationGatewayCustomError +## ConnectionMonitorIcmpConfiguration ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ApplicationGatewayFrontendIPConfiguration +## ConnectionMonitorOutput ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ApplicationGatewayFrontendPort +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayFrontendPortPropertiesFormat +## ConnectionMonitorSuccessThreshold ### Properties -* **port**: int: Frontend port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ApplicationGatewayGlobalConfiguration +## ConnectionMonitorTags ### Properties -* **enableRequestBuffering**: bool: Enable request buffering. -* **enableResponseBuffering**: bool: Enable response buffering. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayHttpListener +## ConnectionMonitorTcpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorTestConfiguration ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayLoadDistributionPolicy +## ConnectionMonitorTestGroup ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayLoadDistributionPolicyPropertiesFormat](#applicationgatewayloaddistributionpolicypropertiesformat): Properties of Load Distribution Policy of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayLoadDistributionPolicyPropertiesFormat +## ConnectionMonitorWorkspaceSettings ### Properties -* **loadDistributionAlgorithm**: 'IpHash' | 'LeastConnections' | 'RoundRobin' | string: Load Distribution Algorithm enums. -* **loadDistributionTargets**: [ApplicationGatewayLoadDistributionTarget](#applicationgatewayloaddistributiontarget)[]: Load Distribution Targets resource of an application gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewayLoadDistributionTarget +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayLoadDistributionTargetPropertiesFormat](#applicationgatewayloaddistributiontargetpropertiesformat) -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayLoadDistributionTargetPropertiesFormat -### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **weightPerServer**: int: Weight per server. Range between 1 and 100. - -## ApplicationGatewayPrivateEndpointConnection +## ContainerNetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayPrivateEndpointConnectionProperties -### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateLinkConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateLinkConfigurationProperties +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPrivateLinkIpConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayProbe -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayProbePropertiesFormat +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## ApplicationGatewayProbeHealthResponseMatch +## CustomDnsConfigPropertiesFormat ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayRedirectConfiguration +## CustomIpPrefix ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayRedirectConfigurationPropertiesFormat -### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. - -## ApplicationGatewayRequestRoutingRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [CustomIpPrefixPropertiesFormat](#customipprefixpropertiesformat): Custom IP prefix properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## CustomIpPrefixPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **authorizationMessage**: string: Authorization message for WAN validation. +* **childCustomIpPrefixes**: [CustomIpPrefix](#customipprefix)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **customIpPrefixParent**: [CustomIpPrefix](#customipprefix): Custom IP prefix resource. +* **failedReason**: string (ReadOnly): The reason why resource is in failed state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. - -## ApplicationGatewayRewriteRuleSet -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **signedMessage**: string: Signed message for WAN validation. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## DdosCustomPolicyPropertiesFormat ### Properties +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. - -## ApplicationGatewayRewriteRule -### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. - -## ApplicationGatewayRewriteRuleActionSet -### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. - -## ApplicationGatewayHeaderConfiguration -### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayUrlConfiguration +## DdosProtectionPlanPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRewriteRuleCondition +## DdosProtectionPlanTags ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewaySku +## DdosSettings ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewaySslCertificate +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **type**: string: Resource type. -## ApplicationGatewaySslCertificatePropertiesFormat +## DeviceProperties ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewaySslPolicy +## DhcpOptions ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewaySslProfile +## DnsSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. -## ApplicationGatewaySslProfilePropertiesFormat +## DscpConfigurationPropertiesFormat ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **qosDefinitionCollection**: [QosDefinition](#qosdefinition)[]: QoS object definitions +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayClientAuthConfiguration +## ExplicitProxySettings ### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **enableExplicitProxy**: bool: When set to true, explicit proxy mode is enabled. +* **httpPort**: int: Port number for explicit proxy http protocol, cannot be greater than 64000. +* **httpsPort**: int: Port number for explicit proxy https protocol, cannot be greater than 64000. +* **pacFile**: string: SAS URL for PAC file. +* **pacFilePort**: int: Port number for firewall to serve PAC file. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat -### Properties -* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. -* **data**: string: Certificate public data. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **validatedCertData**: string (ReadOnly): Validated certificate data. - -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayUrlPathMap +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultLoadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayPathRule +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitPropertiesFormat ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitReference ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayFirewallExclusion +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ResourceTags +## ExpressRouteCircuitSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteCircuitStats ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGateway +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## WebApplicationFirewallCustomRule +## ExpressRouteConnectionProperties ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## MatchCondition +## ExpressRouteCrossConnectionPeering ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## MatchVariable +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ManagedRulesDefinition +## ExpressRouteCrossConnectionProperties ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## OwaspCrsExclusionEntry +## ExpressRouteGatewayProperties ### Properties -* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ManagedRuleSet +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ManagedRuleGroupOverride +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ManagedRuleOverride +## ExpressRouteLink ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## PolicySettings +## ExpressRouteLinkMacSecConfig ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ResourceTags +## ExpressRouteLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ResourceTags +## ExpressRoutePortPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## AzureFirewallPropertiesFormat +## ExtendedLocation ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## AzureFirewallAdditionalProperties +## FirewallPolicyCertificateAuthority ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## AzureFirewallApplicationRuleCollection +## FirewallPolicyFilterRuleCollectionAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FirewallPolicyInsights ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. +* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. +* **retentionDays**: int: Number of days the insights should be enabled on the policy. -## AzureFirewallRCAction +## FirewallPolicyIntrusionDetection ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## AzureFirewallApplicationRule +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -## AzureFirewallApplicationRuleProtocol +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. - -## HubIPAddresses -### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. - -## HubPublicIPAddresses -### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. - -## AzureFirewallPublicIPAddress -### Properties -* **address**: string: Public IP Address value. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## AzureFirewallIPConfiguration +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## AzureFirewallIPConfigurationPropertiesFormat +## FirewallPolicyLogAnalyticsResources ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. +* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. -## AzureFirewallIpGroups +## FirewallPolicyLogAnalyticsWorkspace ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **region**: string: Region to configure the Workspace. +* **workspaceId**: [SubResource](#subresource): Reference to another subresource. -## AzureFirewallNatRuleCollection +## FirewallPolicyNatRuleCollectionAction ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **type**: 'DNAT' | string: The action type of a rule. -## AzureFirewallNatRuleCollectionProperties +## FirewallPolicyPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **explicitProxySettings**: [ExplicitProxySettings](#explicitproxysettings): Explicit Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. +* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. +* **sql**: [FirewallPolicySQL](#firewallpolicysql): SQL Settings in Firewall Policy. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +## FirewallPolicyRule +* **Discriminator**: ruleType -## AzureFirewallNatRule -### Properties +### Base Properties * **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. + +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. * **translatedAddress**: string: The translated address for this NAT rule. * **translatedFqdn**: string: The translated FQDN for this NAT rule. * **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. - -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. - -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **destinationFqdns**: string[]: List of destination FQDNs. * **destinationIpGroups**: string[]: List of destination IpGroups for this rule. * **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## AzureFirewallSku -### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## ResourceTags +## FirewallPolicyRuleApplicationProtocol ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## BastionHostPropertiesFormat -### Properties -* **disableCopyPaste**: bool: Enable/Disable Copy/Paste feature of the Bastion Host resource. -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **enableFileCopy**: bool: Enable/Disable File Copy feature of the Bastion Host resource. -* **enableIpConnect**: bool: Enable/Disable IP Connect feature of the Bastion Host resource. -* **enableShareableLink**: bool: Enable/Disable Shareable Link of the Bastion Host resource. -* **enableTunneling**: bool: Enable/Disable Tunneling feature of the Bastion Host resource. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **scaleUnits**: int: The scale units for the Bastion Host resource. +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType -## BastionHostIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. -## BastionHostIPConfigurationPropertiesFormat +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## Sku +## FirewallPolicySku ### Properties -* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. +* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## ResourceTags +## FirewallPolicySnat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. -## VirtualNetworkGatewayConnectionPropertiesFormat +## FirewallPolicySQL ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **allowSqlRedirect**: bool: A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. -## IpsecPolicy +## FirewallPolicyThreatIntelWhitelist ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## LocalNetworkGateway +## FirewallPolicyTransportSecurity +### Properties +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. + +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## LocalNetworkGatewayPropertiesFormat +## FlowLogFormatParameters ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## BgpSettings +## FlowLogPropertiesFormat ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## IPConfigurationBgpPeeringAddress +## FrontendIPConfiguration ### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AddressSpace +## FrontendIPConfigurationPropertiesFormat ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## GatewayLoadBalancerTunnelInterface ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **identifier**: int: Identifier of gateway load balancer tunnel interface. +* **port**: int: Port of gateway load balancer tunnel interface. +* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. +* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. -## TrafficSelectorPolicy +## HttpHeader ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## TunnelConnectionHealth +## HubIPAddresses ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. -## VirtualNetworkGateway +## HubIPConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayPropertiesFormat +## HubPublicIPAddresses ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. + +## HubRoute +### Properties +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). + +## HubRouteTableProperties +### Properties +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## VirtualNetworkGatewayIPConfiguration +## HubVirtualNetworkConnectionProperties +### Properties +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. + +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkGatewayNatRule +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayNatRuleProperties +## InboundNatRulePropertiesFormat ### Properties -* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. -* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. -* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. -* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **frontendPortRangeEnd**: int: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. +* **frontendPortRangeStart**: int: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## VpnNatRuleMapping +## InboundSecurityRuleProperties ### Properties -* **addressSpace**: string: Address space for Vpn NatRule mapping. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## VirtualNetworkGatewaySku +## InboundSecurityRules ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## VpnClientConfiguration +## IpAllocationPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## RadiusServer +## IpAllocationPropertiesFormatAllocationTags ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientRevokedCertificate +## IPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## VpnClientRevokedCertificatePropertiesFormat +## IPConfigurationBgpPeeringAddress ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## VpnClientRootCertificate +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRootCertificatePropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## CustomIpPrefixPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **authorizationMessage**: string: Authorization message for WAN validation. -* **childCustomIpPrefixes**: [CustomIpPrefix](#customipprefix)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. -* **customIpPrefixParent**: [CustomIpPrefix](#customipprefix): Custom IP prefix resource. -* **failedReason**: string (ReadOnly): The reason why resource is in failed state. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -* **signedMessage**: string: Signed message for WAN validation. -## CustomIpPrefix +## IpsecPolicy ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [CustomIpPrefixPropertiesFormat](#customipprefixpropertiesformat): Custom IP prefix properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## ResourceTags +## IpTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## ResourceTags +## Ipv6CircuitConnectionConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## DdosCustomPolicyPropertiesFormat +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerBackendAddress +### Properties +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. + +## LoadBalancerBackendAddressPropertiesFormat +### Properties +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## ProtocolCustomSettingsFormat +## LoadBalancerSku ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. -## ResourceTags +## LoadBalancingRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## DdosProtectionPlanPropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## DdosProtectionPlanTags +## LocalNetworkGateway ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DscpConfigurationPropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **qosDefinitionCollection**: [QosDefinition](#qosdefinition)[]: QoS object definitions -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## QosIpRange +## ManagedRuleGroupOverride ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## QosPortRange +## ManagedRuleOverride ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## QosDefinition +## ManagedRulesDefinition ### Properties -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ResourceTags +## ManagedRuleSet +### Properties +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. + +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. + +## ManagedServiceIdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## ExpressRouteCircuitPropertiesFormat +## MatchCondition ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## ExpressRouteCircuitAuthorization +## MatchVariable +### Properties +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. + +## NatGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. -## AuthorizationPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## ExpressRouteCircuitPeering +## NatGatewaySku +### Properties +* **name**: 'Standard' | string: Name of Nat Gateway SKU. + +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitPeeringPropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCircuitConnection +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId -### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## Ipv6ExpressRouteCircuitPeeringConfig +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteCircuitPeeringConfig +## NetworkInterfacePropertiesFormat ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources -## PeerExpressRouteCircuitConnection +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ExpressRouteCircuitStats +## NetworkProfilePropertiesFormat ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ExpressRouteCircuitServiceProviderProperties +## NetworkSecurityGroup ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitSku +## NetworkSecurityGroupPropertiesFormat ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## NetworkVirtualAppliancePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sshPublicKey**: string: Public key for SSH login. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteCrossConnectionProperties +## NetworkWatcherPropertiesFormat ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ExpressRouteCircuitReference +## O365BreakOutCategoryPolicies ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## ExpressRouteCrossConnectionPeering +## O365PolicyProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## ExpressRouteCrossConnectionPeeringProperties +## Office365PolicyProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## ResourceTags +## OutboundRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteGatewayProperties +## OutboundRulePropertiesFormat ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[] (ReadOnly): List of ExpressRoute connections to the ExpressRoute gateway. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. - -## ExpressRouteGatewayPropertiesAutoScaleConfiguration -### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## OwaspCrsExclusionEntry ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **matchVariable**: 'RequestArgNames' | 'RequestCookieNames' | 'RequestHeaderNames' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRouteConnection +## P2SConnectionConfiguration ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteConnectionProperties +## P2SConnectionConfigurationProperties ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitPeeringId +## P2SVpnGateway ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## RoutingConfiguration +## P2SVpnGatewayProperties ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## PropagatedRouteTable +## PacketCaptureFilter ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## VnetRoute +## PacketCaptureParameters ### Properties -* **bgpConnections**: [SubResource](#subresource)[] (ReadOnly): The list of references to HubBgpConnection objects. -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## StaticRoute +## PacketCaptureStorageLocation ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## VirtualHubId +## PeerExpressRouteCircuitConnection ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRoutePortPropertiesFormat +## PolicySettings ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. + +## PrivateDnsZoneConfig +### Properties +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. + +## PrivateDnsZoneGroupPropertiesFormat +### Properties +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ExpressRouteLink +## PrivateDnsZonePropertiesFormat +### Properties +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. + +## PrivateEndpoint ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateEndpointConnection ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. + +## PrivateEndpointConnectionProperties +### Properties +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ExpressRouteLinkMacSecConfig +## PrivateEndpointIPConfiguration ### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the resource that is unique within a resource group. +* **properties**: [PrivateEndpointIPConfigurationProperties](#privateendpointipconfigurationproperties): Properties of an IP Configuration of the private endpoint. +* **type**: string (ReadOnly): The resource type. -## ResourceTags +## PrivateEndpointIPConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **groupId**: string: The ID of a group obtained from the remote resource that this private endpoint should connect to. +* **memberName**: string: The member name of a group obtained from the remote resource that this private endpoint should connect to. +* **privateIPAddress**: string: A private ip address obtained from the private endpoint's subnet. -## FirewallPolicyPropertiesFormat +## PrivateEndpointProperties ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **explicitProxySettings**: [ExplicitProxySettings](#explicitproxysettings): Explicit Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the private endpoint IP configuration is included. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **customNetworkInterfaceName**: string: The custom name of the network interface attached to the private endpoint. +* **ipConfigurations**: [PrivateEndpointIPConfiguration](#privateendpointipconfiguration)[]: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. -* **sql**: [FirewallPolicySQL](#firewallpolicysql): SQL Settings in Firewall Policy. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## DnsSettings +## PrivateLinkService ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExplicitProxySettings +## PrivateLinkServiceConnection ### Properties -* **enableExplicitProxy**: bool: When set to true, explicit proxy mode is enabled. -* **httpPort**: int: Port number for explicit proxy http protocol, cannot be greater than 64000. -* **httpsPort**: int: Port number for explicit proxy https protocol, cannot be greater than 64000. -* **pacFile**: string: SAS URL for PAC file. -* **pacFilePort**: int: Port number for firewall to serve PAC file. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyInsights +## PrivateLinkServiceConnectionProperties ### Properties -* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. -* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. -* **retentionDays**: int: Number of days the insights should be enabled on the policy. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## FirewallPolicyLogAnalyticsResources +## PrivateLinkServiceConnectionState ### Properties -* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. -* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## FirewallPolicyLogAnalyticsWorkspace +## PrivateLinkServiceIpConfiguration ### Properties -* **region**: string: Region to configure the Workspace. -* **workspaceId**: [SubResource](#subresource): Reference to another subresource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyIntrusionDetection +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyIntrusionDetectionConfiguration +## PrivateLinkServiceProperties ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **subscriptions**: string[]: The list of subscriptions. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## PrivateLinkServicePropertiesVisibility ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **subscriptions**: string[]: The list of subscriptions. + +## Probe +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. + +## ProbePropertiesFormat +### Properties +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. + +## PropagatedRouteTable +### Properties +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. + +## ProtocolCustomSettingsFormat +### Properties +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. + +## PublicIPAddress +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. + +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -## FirewallPolicySku +## PublicIPAddressSku ### Properties -* **tier**: 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. -## FirewallPolicySnat +## PublicIPPrefixPropertiesFormat ### Properties -* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## FirewallPolicySQL +## PublicIPPrefixSku ### Properties -* **allowSqlRedirect**: bool: A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. -## FirewallPolicyThreatIntelWhitelist +## QosDefinition ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## FirewallPolicyTransportSecurity +## QosIpRange ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. -## FirewallPolicyCertificateAuthority +## QosPortRange ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. -## ResourceTags +## RadiusServer ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. -## FirewallPolicyRuleCollectionGroupProperties +## RecordSet ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## FirewallPolicyFilterRuleCollectionAction +## ReferencedPublicIpAddress ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRule -* **Discriminator**: ruleType - -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. - -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. - -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - +* **id**: string: The PublicIPAddress Reference. -## FirewallPolicyRuleApplicationProtocol +## ResourceNavigationLink ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -## FirewallPolicyNatRuleCollectionAction +## ResourceNavigationLinkFormat ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## IpAllocationPropertiesFormat +## ResourceTags ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3253,114 +3209,65 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3382,56 +3289,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3443,188 +3339,147 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sshPublicKey**: string: Public key for SSH login. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## ResourceTags ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorIcmpConfiguration +## ResourceTags ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSuccessThreshold +## ResourceTags ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTcpConfiguration +## ResourceTags ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestGroup +## ResourceTags ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3634,181 +3489,260 @@ ### Additional Properties * **Additional Properties Type**: string -## PacketCaptureParameters +## RetentionPolicyParameters ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. + +## Route +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **type**: string: The type of the resource. + +## RouteFilterPropertiesFormat +### Properties +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## PacketCaptureFilter +## RouteFilterRule ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## PacketCaptureStorageLocation +## RouteFilterRulePropertiesFormat ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## P2SVpnGatewayProperties +## RoutePropertiesFormat ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## RouteTable ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## P2SConnectionConfigurationProperties +## RouteTablePropertiesFormat ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## VpnClientConnectionHealth +## RoutingConfiguration ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## ResourceTags +## SecurityPartnerProviderPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## SecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **type**: string: The type of the resource. -## PrivateDnsZoneGroupPropertiesFormat +## SecurityRulePropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## PrivateDnsZoneConfig +## ServiceAssociationLink ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. * **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## PrivateDnsZonePropertiesFormat +## ServiceAssociationLinkPropertiesFormat ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## RecordSet +## ServiceDelegationPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## ResourceTags +## ServiceEndpointPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **type**: string: The type of the resource. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ReferencedPublicIpAddress +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **id**: string: The PublicIPAddress Reference. +* **contextualServiceEndpointPolicies**: string[]: A collection of contextual service endpoint policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceAlias**: string: The alias indicating if the policy belongs to a service +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PublicIPPrefixSku +## ServiceEndpointPropertiesFormat ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## ResourceTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. + +## StaticRoute +### Properties +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. + +## Subnet +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. + +## SubnetPropertiesFormat +### Properties +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. + +## SubResource +### Properties +* **id**: string: Resource ID. -## RouteFilterPropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## RouteFilterRule +## TrafficAnalyticsProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## RouteFilterRulePropertiesFormat +## TrafficSelectorPolicy ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## ResourceTags +## TunnelConnectionHealth ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. -## ResourceTags +## VirtualApplianceNicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. -## SecurityPartnerProviderPropertiesFormat +## VirtualApplianceSiteProperties ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3832,15 +3766,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3861,80 +3795,109 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags +## VirtualNetworkBgpCommunities ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## BgpConnectionProperties +## VirtualNetworkGateway ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **hubVirtualNetworkConnection**: [SubResource](#subresource): Reference to another subresource. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubRouteTableProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute -### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayIPConfiguration ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayNatRuleProperties ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. +* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. +* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. +* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## VirtualNetworkBgpCommunities +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## DhcpOptions +## VirtualNetworkGatewaySku ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -3960,29 +3923,39 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualRouterPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. -* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. -* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualRouterAsn**: int: VirtualRouter ASN. -* **virtualRouterIps**: string[]: VirtualRouter IPs. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. ## VirtualRouterPeeringProperties ### Properties @@ -3990,6 +3963,15 @@ * **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +## VirtualRouterPropertiesFormat +### Properties +* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. +* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. +* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualRouterAsn**: int: VirtualRouter ASN. +* **virtualRouterIps**: string[]: VirtualRouter IPs. + ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -4001,22 +3983,56 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpConnections**: [SubResource](#subresource)[] (ReadOnly): The list of references to HubBgpConnection objects. +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **enableBgpRouteTranslationForNat**: bool: Enable BGP routes translation for NAT on this VpnGateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. -* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -4047,34 +4063,6 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. - -## VpnSiteLinkConnectionProperties -### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. - ## VpnGatewayIpConfiguration ### Properties * **id**: string: The identifier of the IP configuration for a VPN Gateway. @@ -4100,10 +4088,41 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **enableBgpRouteTranslationForNat**: bool: Enable BGP routes translation for NAT on this VpnGateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. +* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnNatRuleMapping +### Properties +* **addressSpace**: string: Address space for Vpn NatRule mapping. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -4123,37 +4142,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -4164,40 +4152,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -4206,6 +4160,34 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -4214,18 +4196,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings +## VpnSiteProperties ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## VpnLinkProviderProperties +## WebApplicationFirewallCustomRule ### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## ResourceTags +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2021-05-01-preview/types.md b/generated/network/microsoft.network/2021-05-01-preview/types.md index 0004862873..f03dc22b92 100644 --- a/generated/network/microsoft.network/2021-05-01-preview/types.md +++ b/generated/network/microsoft.network/2021-05-01-preview/types.md @@ -215,106 +215,96 @@ * **Input**: [QueryRequestOptions](#queryrequestoptions) * **Output**: [NetworkManagerEffectiveSecurityAdminRulesListResult](#networkmanagereffectivesecurityadminruleslistresult) -## NetworkManagerConnectionProperties -### Properties -* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. -* **description**: string: A description of the scope connection. -* **networkManagerId**: string: Network Manager Id. +## ActiveBaseSecurityAdminRule +* **Discriminator**: kind -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### Base Properties +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationDescription**: string (ReadOnly): A description of the security admin configuration. +* **configurationDisplayName**: string (ReadOnly): A display name of the security admin configuration. +* **id**: string (ReadOnly): Resource ID. +* **region**: string (ReadOnly): Deployment region. +* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection +* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. +* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. +* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +### ActiveSecurityAdminRule +#### Properties +* **kind**: 'Custom' (Required): Whether the rule is custom or default. +* **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. -## NetworkManagerProperties -### Properties -* **description**: string: A description of the network manager. -* **displayName**: string: A friendly name for the network manager. -* **networkManagerScopeAccesses**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (Required): Scope Access. -* **networkManagerScopes**: [NetworkManagerPropertiesNetworkManagerScopes](#networkmanagerpropertiesnetworkmanagerscopes) (Required): Scope of Network Manager. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### ActiveDefaultSecurityAdminRule +#### Properties +* **kind**: 'Default' (Required): Whether the rule is custom or default. +* **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. -## NetworkManagerPropertiesNetworkManagerScopes -### Properties -* **crossTenantScopes**: [CrossTenantScopes](#crosstenantscopes)[] (ReadOnly): List of cross tenant scopes. -* **managementGroups**: string[]: List of management groups. -* **subscriptions**: string[]: List of subscriptions. -## CrossTenantScopes -### Properties -* **managementGroups**: string[] (ReadOnly): List of management groups. -* **subscriptions**: string[] (ReadOnly): List of subscriptions. -* **tenantId**: string (ReadOnly): Tenant ID. +## ActiveBaseSecurityUserRule +* **Discriminator**: kind -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationDescription**: string (ReadOnly): A description of the security user configuration. +* **configurationDisplayName**: string (ReadOnly): A display name of the security user configuration. +* **id**: string (ReadOnly): Resource ID. +* **region**: string (ReadOnly): Deployment region. +* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection +* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. +* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. +* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +### ActiveSecurityUserRule +#### Properties +* **kind**: 'Custom' (Required): Whether the rule is custom or default. +* **properties**: [UserRulePropertiesFormat](#userrulepropertiesformat) (ReadOnly): Security rule resource. -## ConnectivityConfigurationProperties -### Properties -* **appliesToGroups**: [ConnectivityGroupItem](#connectivitygroupitem)[] (Required): Groups for configuration -* **connectivityTopology**: 'HubAndSpoke' | 'Mesh' | string (Required): Connectivity topology type. -* **deleteExistingPeering**: 'False' | 'True' | string: Flag if need to remove current existing peerings. -* **description**: string: A description of the connectivity configuration. -* **displayName**: string: A friendly name for the resource. -* **hubs**: [Hub](#hub)[]: List of hubItems -* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### ActiveDefaultSecurityUserRule +#### Properties +* **kind**: 'Default' (Required): Whether the rule is custom or default. +* **properties**: [DefaultUserRulePropertiesFormat](#defaultuserrulepropertiesformat) (ReadOnly): Security default user rule resource. -## ConnectivityGroupItem + +## ActiveConfigurationParameter ### Properties -* **groupConnectivity**: 'DirectlyConnected' | 'None' | string (Required): Group connectivity type. -* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. -* **networkGroupId**: string (Required): Network group Id. -* **useHubGateway**: 'False' | 'True' | string: Flag if need to use hub gateway. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## Hub +## ActiveConfigurationParameter ### Properties -* **resourceId**: string: Resource Id. -* **resourceType**: string: Resource Type. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## NetworkGroupProperties +## ActiveConfigurationParameter ### Properties -* **description**: string: A description of the network group. -* **displayName**: string: A friendly name for the network group. -* **memberType**: string (Required): Group member type. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## StaticMemberProperties +## ActiveConnectivityConfiguration ### Properties -* **resourceId**: string: Resource Id. +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration +* **region**: string (ReadOnly): Deployment region. -## ScopeConnectionProperties +## ActiveConnectivityConfigurationsListResult ### Properties -* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. -* **description**: string: A description of the scope connection. -* **resourceId**: string: Resource ID. -* **tenantId**: string: Tenant ID. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveConnectivityConfiguration](#activeconnectivityconfiguration)[] (ReadOnly): Gets a page of active connectivity configurations. -## SecurityConfigurationPropertiesFormat +## ActiveSecurityAdminRulesListResult ### Properties -* **applyOnNetworkIntentPolicyBasedServices**: 'All' | 'None' | string[]: Enum list of network intent policy based services. -* **deleteExistingNSGs**: 'False' | 'True' | string: Flag if need to delete existing network security groups. -* **description**: string: A description of the security configuration. -* **displayName**: string: A display name of the security configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityType**: 'AdminPolicy' | 'UserPolicy' | string: Security Type. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveBaseSecurityAdminRule](#activebasesecurityadminrule)[] (ReadOnly): Gets a page of active security admin rules. -## RuleCollectionPropertiesFormat +## ActiveSecurityUserRulesListResult ### Properties -* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (Required): Groups for configuration -* **description**: string: A description of the rule collection. -* **displayName**: string: A display name of the rule collection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveBaseSecurityUserRule](#activebasesecurityuserrule)[] (ReadOnly): Gets a page of active security user rules. -## NetworkManagerSecurityGroupItem +## AddressPrefixItem ### Properties -* **networkGroupId**: string (Required): Network manager group Id. +* **addressPrefix**: string: Address prefix. +* **addressPrefixType**: 'IPPrefix' | 'ServiceTag' | string: Address prefix type. ## AdminPropertiesFormat ### Properties @@ -330,10 +320,34 @@ * **sourcePortRanges**: string[]: The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. -## AddressPrefixItem +## ConfigurationGroup ### Properties -* **addressPrefix**: string: Address prefix. -* **addressPrefixType**: 'IPPrefix' | 'ServiceTag' | string: Address prefix type. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [NetworkGroupProperties](#networkgroupproperties) (ReadOnly): Properties of network group + +## ConnectivityConfigurationProperties +### Properties +* **appliesToGroups**: [ConnectivityGroupItem](#connectivitygroupitem)[] (Required): Groups for configuration +* **connectivityTopology**: 'HubAndSpoke' | 'Mesh' | string (Required): Connectivity topology type. +* **deleteExistingPeering**: 'False' | 'True' | string: Flag if need to remove current existing peerings. +* **description**: string: A description of the connectivity configuration. +* **displayName**: string: A friendly name for the resource. +* **hubs**: [Hub](#hub)[]: List of hubItems +* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ConnectivityGroupItem +### Properties +* **groupConnectivity**: 'DirectlyConnected' | 'None' | string (Required): Group connectivity type. +* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. +* **networkGroupId**: string (Required): Network group Id. +* **useHubGateway**: 'False' | 'True' | string: Flag if need to use hub gateway. + +## CrossTenantScopes +### Properties +* **managementGroups**: string[] (ReadOnly): List of management groups. +* **subscriptions**: string[] (ReadOnly): List of subscriptions. +* **tenantId**: string (ReadOnly): Tenant ID. ## DefaultAdminPropertiesFormat ### Properties @@ -350,18 +364,6 @@ * **sourcePortRanges**: string[] (ReadOnly): The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[] (ReadOnly): The CIDR or source IP ranges. -## UserRulePropertiesFormat -### Properties -* **description**: string: A description for this rule. -* **destinationPortRanges**: string[]: The destination port ranges. -* **destinations**: [AddressPrefixItem](#addressprefixitem)[]: The destination address prefixes. CIDR or destination IP ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic. -* **displayName**: string: A friendly name for the rule. -* **protocol**: 'Ah' | 'Any' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourcePortRanges**: string[]: The source port ranges. -* **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. - ## DefaultUserRulePropertiesFormat ### Properties * **description**: string (ReadOnly): A description for this rule. Restricted to 140 chars. @@ -375,107 +377,72 @@ * **sourcePortRanges**: string[] (ReadOnly): The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[] (ReadOnly): The CIDR or source IP ranges. -## ActiveConfigurationParameter -### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. - -## ActiveConnectivityConfigurationsListResult -### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveConnectivityConfiguration](#activeconnectivityconfiguration)[] (ReadOnly): Gets a page of active connectivity configurations. - -## ActiveConnectivityConfiguration -### Properties -* **commitTime**: string (ReadOnly): Deployment time string. -* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration -* **region**: string (ReadOnly): Deployment region. - -## ConfigurationGroup -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [NetworkGroupProperties](#networkgroupproperties) (ReadOnly): Properties of network group - -## ActiveConfigurationParameter -### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. - -## ActiveSecurityAdminRulesListResult -### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveBaseSecurityAdminRule](#activebasesecurityadminrule)[] (ReadOnly): Gets a page of active security admin rules. - -## ActiveBaseSecurityAdminRule +## EffectiveBaseSecurityAdminRule * **Discriminator**: kind ### Base Properties -* **commitTime**: string (ReadOnly): Deployment time string. * **configurationDescription**: string (ReadOnly): A description of the security admin configuration. * **configurationDisplayName**: string (ReadOnly): A display name of the security admin configuration. * **id**: string (ReadOnly): Resource ID. -* **region**: string (ReadOnly): Deployment region. * **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection * **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. * **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. * **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### ActiveSecurityAdminRule +### EffectiveSecurityAdminRule #### Properties * **kind**: 'Custom' (Required): Whether the rule is custom or default. * **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. -### ActiveDefaultSecurityAdminRule +### EffectiveDefaultSecurityAdminRule #### Properties * **kind**: 'Default' (Required): Whether the rule is custom or default. * **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. -## ActiveConfigurationParameter +## EffectiveConnectivityConfiguration ### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration -## ActiveSecurityUserRulesListResult +## EffectiveVirtualNetwork ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveBaseSecurityUserRule](#activebasesecurityuserrule)[] (ReadOnly): Gets a page of active security user rules. +* **id**: string (ReadOnly): Effective vnet Id. +* **location**: string (ReadOnly): Location of vnet. +* **membershipType**: 'Dynamic' | 'Static' | string (ReadOnly): Membership Type. -## ActiveBaseSecurityUserRule -* **Discriminator**: kind +## EffectiveVirtualNetworksListResult +### Properties +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork -### Base Properties -* **commitTime**: string (ReadOnly): Deployment time string. -* **configurationDescription**: string (ReadOnly): A description of the security user configuration. -* **configurationDisplayName**: string (ReadOnly): A display name of the security user configuration. -* **id**: string (ReadOnly): Resource ID. -* **region**: string (ReadOnly): Deployment region. -* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection -* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. -* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. -* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### ActiveSecurityUserRule -#### Properties -* **kind**: 'Custom' (Required): Whether the rule is custom or default. -* **properties**: [UserRulePropertiesFormat](#userrulepropertiesformat) (ReadOnly): Security rule resource. +## EffectiveVirtualNetworksListResult +### Properties +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork -### ActiveDefaultSecurityUserRule -#### Properties -* **kind**: 'Default' (Required): Whether the rule is custom or default. -* **properties**: [DefaultUserRulePropertiesFormat](#defaultuserrulepropertiesformat) (ReadOnly): Security default user rule resource. +## EffectiveVirtualNetworksParameter +### Properties +* **conditionalMembers**: string (WriteOnly): Conditional Members. +* **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. +## Hub +### Properties +* **resourceId**: string: Resource Id. +* **resourceType**: string: Resource Type. -## NetworkManagerDeploymentStatusParameter +## NetworkGroupProperties ### Properties -* **deploymentTypes**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (WriteOnly): List of deployment types. -* **regions**: string[] (WriteOnly): List of locations. -* **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. +* **description**: string: A description of the network group. +* **displayName**: string: A friendly name for the network group. +* **memberType**: string (Required): Group member type. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkManagerDeploymentStatusListResult +## NetworkManagerConnectionProperties ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [NetworkManagerDeploymentStatus](#networkmanagerdeploymentstatus)[] (ReadOnly): Gets a page of Network Manager Deployment Status +* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. +* **description**: string: A description of the scope connection. +* **networkManagerId**: string: Network Manager Id. ## NetworkManagerDeploymentStatus ### Properties @@ -486,74 +453,107 @@ * **errorMessage**: string (ReadOnly): Error Message. * **region**: string (ReadOnly): Region Name. -## EffectiveVirtualNetworksParameter +## NetworkManagerDeploymentStatusListResult ### Properties -* **conditionalMembers**: string (WriteOnly): Conditional Members. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [NetworkManagerDeploymentStatus](#networkmanagerdeploymentstatus)[] (ReadOnly): Gets a page of Network Manager Deployment Status + +## NetworkManagerDeploymentStatusParameter +### Properties +* **deploymentTypes**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (WriteOnly): List of deployment types. +* **regions**: string[] (WriteOnly): List of locations. * **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. -## EffectiveVirtualNetworksListResult +## NetworkManagerEffectiveConnectivityConfigurationListResult ### Properties * **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork +* **value**: [EffectiveConnectivityConfiguration](#effectiveconnectivityconfiguration)[] (ReadOnly): Gets a page of NetworkManagerEffectiveConnectivityConfiguration -## EffectiveVirtualNetwork +## NetworkManagerEffectiveSecurityAdminRulesListResult ### Properties -* **id**: string (ReadOnly): Effective vnet Id. -* **location**: string (ReadOnly): Location of vnet. -* **membershipType**: 'Dynamic' | 'Static' | string (ReadOnly): Membership Type. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveBaseSecurityAdminRule](#effectivebasesecurityadminrule)[] (ReadOnly): Gets a page of NetworkManagerEffectiveSecurityAdminRules + +## NetworkManagerProperties +### Properties +* **description**: string: A description of the network manager. +* **displayName**: string: A friendly name for the network manager. +* **networkManagerScopeAccesses**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (Required): Scope Access. +* **networkManagerScopes**: [NetworkManagerPropertiesNetworkManagerScopes](#networkmanagerpropertiesnetworkmanagerscopes) (Required): Scope of Network Manager. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## NetworkManagerPropertiesNetworkManagerScopes +### Properties +* **crossTenantScopes**: [CrossTenantScopes](#crosstenantscopes)[] (ReadOnly): List of cross tenant scopes. +* **managementGroups**: string[]: List of management groups. +* **subscriptions**: string[]: List of subscriptions. + +## NetworkManagerSecurityGroupItem +### Properties +* **networkGroupId**: string (Required): Network manager group Id. ## QueryRequestOptions ### Properties * **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## EffectiveVirtualNetworksListResult +## QueryRequestOptions ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. ## QueryRequestOptions ### Properties * **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## NetworkManagerEffectiveConnectivityConfigurationListResult +## ResourceTags ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveConnectivityConfiguration](#effectiveconnectivityconfiguration)[] (ReadOnly): Gets a page of NetworkManagerEffectiveConnectivityConfiguration +### Additional Properties +* **Additional Properties Type**: string -## EffectiveConnectivityConfiguration +## RuleCollectionPropertiesFormat ### Properties -* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration +* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (Required): Groups for configuration +* **description**: string: A description of the rule collection. +* **displayName**: string: A display name of the rule collection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## QueryRequestOptions +## ScopeConnectionProperties ### Properties -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. +* **description**: string: A description of the scope connection. +* **resourceId**: string: Resource ID. +* **tenantId**: string: Tenant ID. -## NetworkManagerEffectiveSecurityAdminRulesListResult +## SecurityConfigurationPropertiesFormat ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveBaseSecurityAdminRule](#effectivebasesecurityadminrule)[] (ReadOnly): Gets a page of NetworkManagerEffectiveSecurityAdminRules - -## EffectiveBaseSecurityAdminRule -* **Discriminator**: kind +* **applyOnNetworkIntentPolicyBasedServices**: 'All' | 'None' | string[]: Enum list of network intent policy based services. +* **deleteExistingNSGs**: 'False' | 'True' | string: Flag if need to delete existing network security groups. +* **description**: string: A description of the security configuration. +* **displayName**: string: A display name of the security configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityType**: 'AdminPolicy' | 'UserPolicy' | string: Security Type. -### Base Properties -* **configurationDescription**: string (ReadOnly): A description of the security admin configuration. -* **configurationDisplayName**: string (ReadOnly): A display name of the security admin configuration. -* **id**: string (ReadOnly): Resource ID. -* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection -* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. -* **ruleCollectionDisplayName**: string (ReadOnly): A display name of the rule collection. -* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### EffectiveSecurityAdminRule -#### Properties -* **kind**: 'Custom' (Required): Whether the rule is custom or default. -* **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. +## StaticMemberProperties +### Properties +* **resourceId**: string: Resource Id. -### EffectiveDefaultSecurityAdminRule -#### Properties -* **kind**: 'Default' (Required): Whether the rule is custom or default. -* **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +## UserRulePropertiesFormat +### Properties +* **description**: string: A description for this rule. +* **destinationPortRanges**: string[]: The destination port ranges. +* **destinations**: [AddressPrefixItem](#addressprefixitem)[]: The destination address prefixes. CIDR or destination IP ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic. +* **displayName**: string: A friendly name for the rule. +* **protocol**: 'Ah' | 'Any' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourcePortRanges**: string[]: The source port ranges. +* **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. diff --git a/generated/network/microsoft.network/2021-05-01/types.md b/generated/network/microsoft.network/2021-05-01/types.md index 4215d7a4bc..2830c3124f 100644 --- a/generated/network/microsoft.network/2021-05-01/types.md +++ b/generated/network/microsoft.network/2021-05-01/types.md @@ -898,57 +898,27 @@ * **Input**: [IdpsQueryObject](#idpsqueryobject) * **Output**: [QueryResults](#queryresults) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **globalConfiguration**: [ApplicationGatewayGlobalConfiguration](#applicationgatewayglobalconfiguration): Application Gateway global configuration. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **loadDistributionPolicies**: [ApplicationGatewayLoadDistributionPolicy](#applicationgatewayloaddistributionpolicy)[]: Load distribution policies of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -968,6 +938,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -982,1520 +957,1584 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayClientAuthConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayConnectionDraining ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## ResourceTags +## ApplicationGatewayCustomError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. -## SubResource +## ApplicationGatewayFirewallDisabledRuleGroup ### Properties -* **id**: string: Resource ID. +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. -## BackendAddressPool +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound NAT rules that use this backend address pool. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **location**: string: The location of the backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **inboundNatRulesPortMapping**: [NatRulePortMapping](#natruleportmapping)[] (ReadOnly): Collection of inbound NAT rule port mappings. -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NatRulePortMapping +## ApplicationGatewayGlobalConfiguration ### Properties -* **backendPort**: int: Backend port. -* **frontendPort**: int: Frontend port. -* **inboundNatRuleName**: string: Name of inbound NAT rule. +* **enableRequestBuffering**: bool: Enable request buffering. +* **enableResponseBuffering**: bool: Enable response buffering. -## GatewayLoadBalancerTunnelInterface +## ApplicationGatewayHeaderConfiguration ### Properties -* **identifier**: int: Identifier of gateway load balancer tunnel interface. -* **port**: int: Port of gateway load balancer tunnel interface. -* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. -* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## InboundNatRule +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **frontendPortRangeEnd**: int: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. -* **frontendPortRangeStart**: int: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties -### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. - -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ExtendedLocation +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayLoadDistributionPolicy ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayLoadDistributionPolicyPropertiesFormat](#applicationgatewayloaddistributionpolicypropertiesformat): Properties of Load Distribution Policy of an application gateway. +* **type**: string (ReadOnly): Type of the resource. + +## ApplicationGatewayLoadDistributionPolicyPropertiesFormat +### Properties +* **loadDistributionAlgorithm**: 'IpHash' | 'LeastConnections' | 'RoundRobin' | string: Load Distribution Algorithm enums. +* **loadDistributionTargets**: [ApplicationGatewayLoadDistributionTarget](#applicationgatewayloaddistributiontarget)[]: Load Distribution Targets resource of an application gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -## DdosSettings +## ApplicationGatewayLoadDistributionTarget ### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayLoadDistributionTargetPropertiesFormat](#applicationgatewayloaddistributiontargetpropertiesformat) +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressDnsSettings +## ApplicationGatewayLoadDistributionTargetPropertiesFormat ### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **weightPerServer**: int: Weight per server. Range between 1 and 100. -## IPConfiguration +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ApplicationGatewayIPConfiguration +## ApplicationGatewayPrivateLinkConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ApplicationGatewayPrivateLinkConfigurationProperties ### Properties +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Delegation +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -* **type**: string: Resource type. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. -## NetworkSecurityGroup +## ApplicationGatewayProbePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPropertiesFormat ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **globalConfiguration**: [ApplicationGatewayGlobalConfiguration](#applicationgatewayglobalconfiguration): Application Gateway global configuration. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **loadDistributionPolicies**: [ApplicationGatewayLoadDistributionPolicy](#applicationgatewayloaddistributionpolicy)[]: Load distribution policies of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## SecurityRule +## ApplicationGatewayRedirectConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -* **type**: string: The type of the resource. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SecurityRulePropertiesFormat +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## FlowLog +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## TrafficAnalyticsProperties +## ApplicationGatewayRewriteRule ### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## FlowLogFormatParameters +## ApplicationGatewayRewriteRuleCondition ### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## RetentionPolicyParameters +## ApplicationGatewayRewriteRuleSet ### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## ResourceTags +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## NetworkInterface +## ApplicationGatewaySku +### Properties +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. + +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **vnetEncryptionSupported**: bool (ReadOnly): Whether the virtual machine this nic is attached to supports encryption. -* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## NetworkInterfaceDnsSettings +## ApplicationGatewaySslPolicy ### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## PrivateEndpoint +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointProperties +## ApplicationGatewaySslProfilePropertiesFormat ### Properties -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the private endpoint IP configuration is included. -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **customNetworkInterfaceName**: string: The custom name of the network interface attached to the private endpoint. -* **ipConfigurations**: [PrivateEndpointIPConfiguration](#privateendpointipconfiguration)[]: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## CustomDnsConfigPropertiesFormat -### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## PrivateEndpointIPConfiguration +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource that is unique within a resource group. -* **properties**: [PrivateEndpointIPConfigurationProperties](#privateendpointipconfigurationproperties): Properties of an IP Configuration of the private endpoint. -* **type**: string (ReadOnly): The resource type. +* **id**: string: Resource ID. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointIPConfigurationProperties +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **groupId**: string: The ID of a group obtained from the remote resource that this private endpoint should connect to. -* **memberName**: string: The member name of a group obtained from the remote resource that this private endpoint should connect to. -* **privateIPAddress**: string: A private ip address obtained from the private endpoint's subnet. +* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. +* **data**: string: Certificate public data. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **validatedCertData**: string (ReadOnly): Validated certificate data. -## PrivateLinkServiceConnection +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## PrivateLinkServiceConnectionState +## ApplicationGatewayUrlConfiguration ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## ResourceTags +## ApplicationGatewayUrlPathMap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkService +## ApplicationGatewayUrlPathMapPropertiesFormat +### Properties +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultLoadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ApplicationGatewayWebApplicationFirewallConfiguration +### Properties +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## PrivateLinkServiceProperties +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## PrivateLinkServicePropertiesAutoApproval +## AuthorizationPropertiesFormat ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServiceIpConfiguration +## AzureFirewallAdditionalProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## AzureFirewallApplicationRule +### Properties +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. + +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## PrivateLinkServiceIpConfigurationProperties +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## FrontendIPConfiguration +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. * **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FrontendIPConfigurationPropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. - -## PrivateEndpointConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## PrivateEndpointConnectionProperties +## AzureFirewallIpGroups ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## PrivateLinkServicePropertiesVisibility +## AzureFirewallNatRCAction ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ResourceTags +## AzureFirewallNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## NetworkInterfaceTapConfiguration +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## NetworkInterfaceTapConfigurationPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## VirtualNetworkTap +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## VirtualNetworkTapPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ResourceTags +## AzureFirewallPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallPublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Public IP Address value. -## ResourceTags +## AzureFirewallRCAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## ResourceNavigationLink +## AzureFirewallSku +### Properties +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of an Azure Firewall. + +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## ResourceNavigationLinkFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound NAT rules that use this backend address pool. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **location**: string: The location of the backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. -## RouteTable +## BastionHostIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## RouteTablePropertiesFormat +## BastionHostIPConfigurationPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## Route +## BastionHostPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -* **type**: string: The type of the resource. +* **disableCopyPaste**: bool: Enable/Disable Copy/Paste feature of the Bastion Host resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **enableFileCopy**: bool: Enable/Disable File Copy feature of the Bastion Host resource. +* **enableIpConnect**: bool: Enable/Disable IP Connect feature of the Bastion Host resource. +* **enableShareableLink**: bool: Enable/Disable Shareable Link of the Bastion Host resource. +* **enableTunneling**: bool: Enable/Disable Tunneling feature of the Bastion Host resource. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **scaleUnits**: int: The scale units for the Bastion Host resource. -## RoutePropertiesFormat +## BgpConnectionProperties ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **hubVirtualNetworkConnection**: [SubResource](#subresource): Reference to another subresource. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## BgpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ServiceAssociationLink +## BreakOutCategoryPolicies ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ServiceAssociationLinkPropertiesFormat +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ServiceEndpointPolicy +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ServiceEndpointPolicyPropertiesFormat +## ConnectionMonitorEndpoint ### Properties -* **contextualServiceEndpointPolicies**: string[]: A collection of contextual service endpoint policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceAlias**: string: The alias indicating if the policy belongs to a service -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## ServiceEndpointPolicyDefinition +## ConnectionMonitorEndpointFilter ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -* **type**: string: The type of the resource. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## ConnectionMonitorEndpointFilterItem ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ResourceTags +## ConnectionMonitorEndpointScope ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ServiceEndpointPropertiesFormat +## ConnectionMonitorEndpointScopeItem ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## IpTag +## ConnectionMonitorHttpConfiguration ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## NatGateway +## ConnectionMonitorIcmpConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## NatGatewayPropertiesFormat +## ConnectionMonitorOutput ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. + +## ConnectionMonitorParameters +### Properties +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## NatGatewaySku +## ConnectionMonitorSource ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ResourceTags +## ConnectionMonitorSuccessThreshold +### Properties +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. + +## ConnectionMonitorTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PublicIPAddressSku +## ConnectionMonitorTcpConfiguration ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ResourceTags +## ConnectionMonitorTestConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayBackendHttpSettings +## ConnectionMonitorTestGroup ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## ConnectionMonitorWorkspaceSettings ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **workspaceResourceId**: string: Log analytics workspace resource ID. -## ApplicationGatewayConnectionDraining +## Container ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **id**: string: Resource ID. -## ApplicationGatewayCustomError +## ContainerNetworkInterface ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendIPConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayFrontendPort +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayFrontendPortPropertiesFormat +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **port**: int: Frontend port. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayGlobalConfiguration +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **enableRequestBuffering**: bool: Enable request buffering. -* **enableResponseBuffering**: bool: Enable response buffering. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayHttpListener +## CustomDnsConfigPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayHttpListenerPropertiesFormat +## CustomIpPrefixPropertiesFormat ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. +* **authorizationMessage**: string: Authorization message for WAN validation. +* **childCustomIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **customIpPrefixParent**: [SubResource](#subresource): Reference to another subresource. +* **failedReason**: string (ReadOnly): The reason why resource is in failed state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **signedMessage**: string: Signed message for WAN validation. -## ApplicationGatewayLoadDistributionPolicy +## DdosCustomPolicyPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayLoadDistributionPolicyPropertiesFormat](#applicationgatewayloaddistributionpolicypropertiesformat): Properties of Load Distribution Policy of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayLoadDistributionPolicyPropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **loadDistributionAlgorithm**: 'IpHash' | 'LeastConnections' | 'RoundRobin' | string: Load Distribution Algorithm enums. -* **loadDistributionTargets**: [ApplicationGatewayLoadDistributionTarget](#applicationgatewayloaddistributiontarget)[]: Load Distribution Targets resource of an application gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayLoadDistributionTarget +## DdosProtectionPlanTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayLoadDistributionTargetPropertiesFormat](#applicationgatewayloaddistributiontargetpropertiesformat) -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayLoadDistributionTargetPropertiesFormat +## DdosSettings ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **weightPerServer**: int: Weight per server. Range between 1 and 100. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayPrivateEndpointConnection +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **type**: string: Resource type. -## ApplicationGatewayPrivateEndpointConnectionProperties +## DeviceProperties ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayPrivateLinkConfiguration +## DhcpOptions ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayPrivateLinkConfigurationProperties +## DnsSettings ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. -## ApplicationGatewayPrivateLinkIpConfiguration +## DscpConfigurationPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **qosDefinitionCollection**: [QosDefinition](#qosdefinition)[]: QoS object definitions +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ExclusionManagedRule ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **ruleId**: string (Required): Identifier for the managed rule. -## ApplicationGatewayProbe +## ExclusionManagedRuleGroup ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **ruleGroupName**: string (Required): The managed rule group for exclusion. +* **rules**: [ExclusionManagedRule](#exclusionmanagedrule)[]: List of rules that will be excluded. If none specified, all rules in the group will be excluded. -## ApplicationGatewayProbePropertiesFormat +## ExclusionManagedRuleSet ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **ruleGroups**: [ExclusionManagedRuleGroup](#exclusionmanagedrulegroup)[]: Defines the rule groups to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ApplicationGatewayProbeHealthResponseMatch +## ExplicitProxySettings ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **enableExplicitProxy**: bool: When set to true, explicit proxy mode is enabled. +* **httpPort**: int: Port number for explicit proxy http protocol, cannot be greater than 64000. +* **httpsPort**: int: Port number for explicit proxy https protocol, cannot be greater than 64000. +* **pacFile**: string: SAS URL for PAC file. +* **pacFilePort**: int: Port number for firewall to serve PAC file. -## ApplicationGatewayRedirectConfiguration +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRedirectConfigurationPropertiesFormat -### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. - -## ApplicationGatewayRequestRoutingRule +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayRewriteRuleSet +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayRewriteRuleSetPropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayRewriteRule +## ExpressRouteCircuitPeeringId ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayRewriteRuleActionSet +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayHeaderConfiguration +## ExpressRouteCircuitPropertiesFormat ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayUrlConfiguration +## ExpressRouteCircuitReference ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayRewriteRuleCondition +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewaySku +## ExpressRouteCircuitSku ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitStats +### Properties +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. + +## ExpressRouteConnection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ApplicationGatewaySslCertificatePropertiesFormat +## ExpressRouteConnectionId ### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## ApplicationGatewaySslPolicy +## ExpressRouteConnectionProperties ### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGatewaySslProfile +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewaySslProfilePropertiesFormat -### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ApplicationGatewayClientAuthConfiguration +## ExpressRouteCrossConnectionPeeringProperties ### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCrossConnectionProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat +## ExpressRouteGatewayProperties ### Properties -* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. -* **data**: string: Certificate public data. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[]: List of ExpressRoute connections to the ExpressRoute gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **validatedCertData**: string (ReadOnly): Validated certificate data. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## ApplicationGatewayUrlPathMap +## ExpressRouteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteLinkMacSecConfig ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultLoadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ApplicationGatewayPathRule +## ExpressRouteLinkPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRoutePortPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExtendedLocation ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## ApplicationGatewayFirewallDisabledRuleGroup +## FilterItems ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **field**: string (WriteOnly): The name of the field we would like to filter +* **values**: string[] (WriteOnly): List of values to filter the current field by -## ApplicationGatewayFirewallExclusion +## FirewallPolicyCertificateAuthority ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## ResourceTags +## FirewallPolicyFilterRuleCollectionAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## WebApplicationFirewallPolicyPropertiesFormat +## FirewallPolicyInsights ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. +* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. +* **retentionDays**: int: Number of days the insights should be enabled on the policy. -## ApplicationGateway +## FirewallPolicyIntrusionDetection ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## ResourceTags +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## WebApplicationFirewallCustomRule +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## MatchCondition +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## MatchVariable +## FirewallPolicyLogAnalyticsResources ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. +* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. -## ManagedRulesDefinition +## FirewallPolicyLogAnalyticsWorkspace ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **region**: string: Region to configure the Workspace. +* **workspaceId**: [SubResource](#subresource): Reference to another subresource. -## OwaspCrsExclusionEntry +## FirewallPolicyNatRuleCollectionAction ### Properties -* **exclusionManagedRuleSets**: [ExclusionManagedRuleSet](#exclusionmanagedruleset)[]: The managed rule sets that are associated with the exclusion. -* **matchVariable**: 'RequestArgKeys' | 'RequestArgNames' | 'RequestArgValues' | 'RequestCookieKeys' | 'RequestCookieNames' | 'RequestCookieValues' | 'RequestHeaderKeys' | 'RequestHeaderNames' | 'RequestHeaderValues' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **type**: 'DNAT' | string: The action type of a rule. -## ExclusionManagedRuleSet +## FirewallPolicyPropertiesFormat ### Properties -* **ruleGroups**: [ExclusionManagedRuleGroup](#exclusionmanagedrulegroup)[]: Defines the rule groups to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **explicitProxySettings**: [ExplicitProxySettings](#explicitproxysettings): Explicit Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. +* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. +* **sql**: [FirewallPolicySQL](#firewallpolicysql): SQL Settings in Firewall Policy. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. -## ExclusionManagedRuleGroup -### Properties -* **ruleGroupName**: string (Required): The managed rule group for exclusion. -* **rules**: [ExclusionManagedRule](#exclusionmanagedrule)[]: List of rules that will be excluded. If none specified, all rules in the group will be excluded. +## FirewallPolicyRule +* **Discriminator**: ruleType -## ExclusionManagedRule -### Properties -* **ruleId**: string (Required): Identifier for the managed rule. +### Base Properties +* **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. -## ManagedRuleSet -### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ManagedRuleGroupOverride +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + + +## FirewallPolicyRuleApplicationProtocol ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## ManagedRuleOverride +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType + +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## PolicySettings +## FirewallPolicySku ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## ResourceTags +## FirewallPolicySnat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. -## ResourceTags +## FirewallPolicySQL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowSqlRedirect**: bool: A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. -## AzureFirewallPropertiesFormat +## FirewallPolicyThreatIntelWhitelist ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallAdditionalProperties +## FirewallPolicyTransportSecurity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. -## AzureFirewallApplicationRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FlowLogFormatParameters ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. + +## FlowLogPropertiesFormat +### Properties +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## AzureFirewallRCAction +## FrontendIPConfiguration ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## AzureFirewallApplicationRule +## FrontendIPConfigurationPropertiesFormat ### Properties -* **description**: string: Description of the rule. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## AzureFirewallApplicationRuleProtocol +## GatewayLoadBalancerTunnelInterface ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +* **identifier**: int: Identifier of gateway load balancer tunnel interface. +* **port**: int: Port of gateway load balancer tunnel interface. +* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. +* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. + +## HttpHeader +### Properties +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. ## HubIPAddresses ### Properties * **privateIPAddress**: string: Private IP Address associated with azure firewall. * **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +## HubIPConfigurationPropertiesFormat +### Properties +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. + ## HubPublicIPAddresses ### Properties * **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. * **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress +## HubRoute ### Properties -* **address**: string: Public IP Address value. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## AzureFirewallIPConfiguration +## HubRouteTableProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## AzureFirewallIPConfigurationPropertiesFormat +## HubVirtualNetworkConnectionProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## AzureFirewallIpGroups +## IdpsQueryObject ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **filters**: [FilterItems](#filteritems)[] (WriteOnly): Describers the filters to filter response by +* **orderBy**: [OrderBy](#orderby) (WriteOnly): Describes a column to sort +* **resultsPerPage**: int (WriteOnly): The number of the results to return in each page +* **search**: string (WriteOnly): Search term in all columns +* **skip**: int (WriteOnly): The number of records matching the filter to skip -## AzureFirewallNatRuleCollection +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNatRuleCollectionProperties +## InboundNatPoolPropertiesFormat ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. - -## AzureFirewallNatRCAction -### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. - -## AzureFirewallNatRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. -## AzureFirewallNetworkRuleCollection +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## AzureFirewallNetworkRuleCollectionPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **frontendPortRangeEnd**: int: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. +* **frontendPortRangeStart**: int: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## AzureFirewallNetworkRule +## InboundSecurityRuleProperties ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## AzureFirewallSku +## InboundSecurityRules ### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## ResourceTags +## IpAllocationPropertiesFormat +### Properties +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. + +## IpAllocationPropertiesFormatAllocationTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BastionHostPropertiesFormat +## IPConfiguration ### Properties -* **disableCopyPaste**: bool: Enable/Disable Copy/Paste feature of the Bastion Host resource. -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **enableFileCopy**: bool: Enable/Disable File Copy feature of the Bastion Host resource. -* **enableIpConnect**: bool: Enable/Disable IP Connect feature of the Bastion Host resource. -* **enableShareableLink**: bool: Enable/Disable Shareable Link of the Bastion Host resource. -* **enableTunneling**: bool: Enable/Disable Tunneling feature of the Bastion Host resource. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **scaleUnits**: int: The scale units for the Bastion Host resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## BastionHostIPConfiguration +## IPConfigurationBgpPeeringAddress +### Properties +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. + +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## BastionHostIPConfigurationPropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## IPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## VirtualNetworkGatewayConnectionPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. ## IpsecPolicy ### Properties @@ -2508,6 +2547,79 @@ * **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. * **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +## IpTag +### Properties +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. + +## Ipv6CircuitConnectionConfig +### Properties +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. + +## Ipv6ExpressRouteCircuitPeeringConfig +### Properties +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. + +## LoadBalancerBackendAddress +### Properties +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. + +## LoadBalancerBackendAddressPropertiesFormat +### Properties +* **inboundNatRulesPortMapping**: [NatRulePortMapping](#natruleportmapping)[] (ReadOnly): Collection of inbound NAT rule port mappings. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. + +## LoadBalancerPropertiesFormat +### Properties +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. + +## LoadBalancerSku +### Properties +* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. + +## LoadBalancingRule +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. + +## LoadBalancingRulePropertiesFormat +### Properties +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + ## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -2527,365 +2639,316 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## BgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. - -## IPConfigurationBgpPeeringAddress -### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. - -## AddressSpace +## ManagedRuleGroupOverride ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ResourceTags +## ManagedRuleOverride ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## TrafficSelectorPolicy +## ManagedRulesDefinition ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## TunnelConnectionHealth +## ManagedRuleSet ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## VirtualNetworkGateway +## ManagedServiceIdentity ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## VirtualNetworkGatewayPropertiesFormat +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **disableIPSecReplayProtection**: bool: disableIPSecReplayProtection flag. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## VirtualNetworkGatewayIPConfiguration +## MatchCondition ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## MatchVariable ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## VirtualNetworkGatewayNatRule +## NatGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. -## VirtualNetworkGatewayNatRuleProperties +## NatGatewayPropertiesFormat ### Properties -* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. -* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. -* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. -* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. - -## VpnNatRuleMapping -### Properties -* **addressSpace**: string: Address space for Vpn NatRule mapping. -* **portRange**: string: Port range for Vpn NatRule mapping. - -## VirtualNetworkGatewaySku -### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## VpnClientConfiguration +## NatGatewaySku ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## RadiusServer +## NatRulePortMapping ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +* **backendPort**: int: Backend port. +* **frontendPort**: int: Frontend port. +* **inboundNatRuleName**: string: Name of inbound NAT rule. -## VpnClientRevokedCertificate +## NetworkInterface ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VpnClientRevokedCertificatePropertiesFormat +## NetworkInterfaceDnsSettings ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## VpnClientRootCertificate +## NetworkInterfaceIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. - -## VpnClientRootCertificatePropertiesFormat -### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. -## ResourceTags +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. -## ResourceTags +## NetworkInterfaceIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## CustomIpPrefixPropertiesFormat +## NetworkInterfacePropertiesFormat ### Properties -* **authorizationMessage**: string: Authorization message for WAN validation. -* **childCustomIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. -* **customIpPrefixParent**: [SubResource](#subresource): Reference to another subresource. -* **failedReason**: string (ReadOnly): The reason why resource is in failed state. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -* **signedMessage**: string: Signed message for WAN validation. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **vnetEncryptionSupported**: bool (ReadOnly): Whether the virtual machine this nic is attached to supports encryption. +* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources -## ResourceTags +## NetworkInterfaceTapConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## DdosCustomPolicyPropertiesFormat +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ProtocolCustomSettingsFormat +## NetworkProfilePropertiesFormat ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ResourceTags +## NetworkSecurityGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## DdosProtectionPlanPropertiesFormat +## NetworkSecurityGroupPropertiesFormat ### Properties +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. - -## DdosProtectionPlanTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## DscpConfigurationPropertiesFormat +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **qosDefinitionCollection**: [QosDefinition](#qosdefinition)[]: QoS object definitions -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **sshPublicKey**: string: Public key for SSH login. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## QosIpRange +## NetworkWatcherPropertiesFormat ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## QosPortRange +## O365BreakOutCategoryPolicies ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## QosDefinition +## O365PolicyProperties ### Properties -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## ResourceTags +## Office365PolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## ExpressRouteCircuitPropertiesFormat +## OrderBy ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. +* **field**: string (WriteOnly): Describes the actual column name to sort by +* **order**: 'Ascending' | 'Descending' | string (WriteOnly): Describes if results should be in ascending/descending order -## ExpressRouteCircuitAuthorization +## OutboundRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. * **type**: string (ReadOnly): Type of the resource. -## AuthorizationPropertiesFormat +## OutboundRulePropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitPeering +## OwaspCrsExclusionEntry +### Properties +* **exclusionManagedRuleSets**: [ExclusionManagedRuleSet](#exclusionmanagedruleset)[]: The managed rule sets that are associated with the exclusion. +* **matchVariable**: 'RequestArgKeys' | 'RequestArgNames' | 'RequestArgValues' | 'RequestCookieKeys' | 'RequestCookieNames' | 'RequestCookieValues' | 'RequestHeaderKeys' | 'RequestHeaderNames' | 'RequestHeaderValues' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## P2SConnectionConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. -## ExpressRouteCircuitPeeringPropertiesFormat +## P2SConnectionConfigurationProperties ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteCircuitConnection +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCircuitConnectionPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## Ipv6CircuitConnectionConfig -### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. - -## ExpressRouteConnectionId +## PacketCaptureFilter ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## Ipv6ExpressRouteCircuitPeeringConfig +## PacketCaptureParameters ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## ExpressRouteCircuitPeeringConfig +## PacketCaptureStorageLocation ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. ## PeerExpressRouteCircuitConnection ### Properties @@ -2905,395 +2968,335 @@ * **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCircuitStats -### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. - -## ExpressRouteCircuitServiceProviderProperties +## PolicySettings ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## ExpressRouteCircuitSku +## PrivateDnsZoneConfig ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## ResourceTags +## PrivateDnsZoneGroupPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ExpressRouteCrossConnectionProperties +## PrivateDnsZonePropertiesFormat ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## ExpressRouteCircuitReference +## PrivateEndpoint ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteCrossConnectionPeering +## PrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteCrossConnectionPeeringProperties +## PrivateEndpointConnectionProperties ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. -## ResourceTags +## PrivateEndpointIPConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the resource that is unique within a resource group. +* **properties**: [PrivateEndpointIPConfigurationProperties](#privateendpointipconfigurationproperties): Properties of an IP Configuration of the private endpoint. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteGatewayProperties +## PrivateEndpointIPConfigurationProperties ### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[]: List of ExpressRoute connections to the ExpressRoute gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **groupId**: string: The ID of a group obtained from the remote resource that this private endpoint should connect to. +* **memberName**: string: The member name of a group obtained from the remote resource that this private endpoint should connect to. +* **privateIPAddress**: string: A private ip address obtained from the private endpoint's subnet. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## PrivateEndpointProperties ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the private endpoint IP configuration is included. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **customNetworkInterfaceName**: string: The custom name of the network interface attached to the private endpoint. +* **ipConfigurations**: [PrivateEndpointIPConfiguration](#privateendpointipconfiguration)[]: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## PrivateLinkService ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteConnection +## PrivateLinkServiceConnection ### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteConnectionProperties +## PrivateLinkServiceConnectionProperties ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. - -## ExpressRouteCircuitPeeringId -### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. - -## RoutingConfiguration -### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. - -## PropagatedRouteTable -### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. - -## VnetRoute -### Properties -* **bgpConnections**: [SubResource](#subresource)[] (ReadOnly): The list of references to HubBgpConnection objects. -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. - -## StaticRoute -### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. - -## VirtualHubId -### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ExpressRoutePortPropertiesFormat +## PrivateLinkServiceConnectionState ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ExpressRouteLink +## PrivateLinkServiceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. -## ExpressRouteLinkPropertiesFormat +## PrivateLinkServiceIpConfigurationProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## ResourceTags +## PrivateLinkServiceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -## FirewallPolicyPropertiesFormat +## PrivateLinkServicePropertiesAutoApproval ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **explicitProxySettings**: [ExplicitProxySettings](#explicitproxysettings): Explicit Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. -* **sql**: [FirewallPolicySQL](#firewallpolicysql): SQL Settings in Firewall Policy. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **subscriptions**: string[]: The list of subscriptions. -## DnsSettings +## PrivateLinkServicePropertiesVisibility ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **subscriptions**: string[]: The list of subscriptions. -## ExplicitProxySettings +## Probe ### Properties -* **enableExplicitProxy**: bool: When set to true, explicit proxy mode is enabled. -* **httpPort**: int: Port number for explicit proxy http protocol, cannot be greater than 64000. -* **httpsPort**: int: Port number for explicit proxy https protocol, cannot be greater than 64000. -* **pacFile**: string: SAS URL for PAC file. -* **pacFilePort**: int: Port number for firewall to serve PAC file. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyInsights +## ProbePropertiesFormat ### Properties -* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. -* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. -* **retentionDays**: int: Number of days the insights should be enabled on the policy. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyLogAnalyticsResources +## PropagatedRouteTable ### Properties -* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. -* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -## FirewallPolicyLogAnalyticsWorkspace +## ProtocolCustomSettingsFormat ### Properties -* **region**: string: Region to configure the Workspace. -* **workspaceId**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -## FirewallPolicyIntrusionDetection +## PublicIPAddress ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FirewallPolicyIntrusionDetectionConfiguration +## PublicIPAddressDnsSettings ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## PublicIPAddressPropertiesFormat ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## PublicIPAddressSku ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. -## FirewallPolicySku +## PublicIPPrefixPropertiesFormat ### Properties -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. -## FirewallPolicySnat +## PublicIPPrefixSku ### Properties -* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. -## FirewallPolicySQL +## QosDefinition ### Properties -* **allowSqlRedirect**: bool: A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## FirewallPolicyThreatIntelWhitelist +## QosIpRange ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. -## FirewallPolicyTransportSecurity +## QosPortRange ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. -## FirewallPolicyCertificateAuthority +## QueryResults ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **matchingRecordsCount**: int (ReadOnly): Number of total records matching the query. +* **signatures**: [SingleQueryResult](#singlequeryresult)[] (ReadOnly): Array containing the results of the query -## ResourceTags +## RadiusServer ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. -## FirewallPolicyRuleCollectionGroupProperties +## RecordSet ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. - -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType - -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. - +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. -## FirewallPolicyFilterRuleCollectionAction +## ReferencedPublicIpAddress ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. - -## FirewallPolicyRule -* **Discriminator**: ruleType +* **id**: string: The PublicIPAddress Reference. -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyRuleApplicationProtocol +## ResourceTags ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyNatRuleCollectionAction +## ResourceTags ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +### Additional Properties +* **Additional Properties Type**: string -## SignaturesOverridesProperties +## ResourceTags ### Properties -* **signatures**: [Signatures](#signatures): Dictionary of +### Additional Properties +* **Additional Properties Type**: string -## Signatures +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IpAllocationPropertiesFormat +## ResourceTags ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3303,114 +3306,65 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3432,56 +3386,55 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3493,372 +3446,407 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sshPublicKey**: string: Public key for SSH login. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## RetentionPolicyParameters ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. -## ConnectionMonitorHttpConfiguration +## Route ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **type**: string: The type of the resource. -## HttpHeader +## RouteFilterPropertiesFormat ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ConnectionMonitorIcmpConfiguration +## RouteFilterRule ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## ConnectionMonitorSuccessThreshold +## RouteFilterRulePropertiesFormat ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ConnectionMonitorTcpConfiguration +## RoutePropertiesFormat ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ConnectionMonitorTestGroup +## RouteTable ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ConnectionMonitorTags +## RouteTablePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ResourceTags +## RoutingConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## PacketCaptureParameters +## RoutingIntentProperties ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. - -## PacketCaptureFilter -### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **routingPolicies**: [RoutingPolicy](#routingpolicy)[]: List of routing policies. -## PacketCaptureStorageLocation +## RoutingPolicy ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **destinations**: string[] (Required): List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). +* **name**: string (Required): The unique name for the routing policy. +* **nextHop**: string (Required): The next hop resource id on which this routing policy is applicable to. -## P2SVpnGatewayProperties +## SecurityPartnerProviderPropertiesFormat ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. * **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **type**: string: The type of the resource. -## P2SConnectionConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. - -## VpnClientConnectionHealth -### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## ResourceTags +## ServiceAssociationLink ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceAssociationLinkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateDnsZoneGroupPropertiesFormat +## ServiceDelegationPropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## PrivateDnsZoneConfig +## ServiceEndpointPolicy ### Properties -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PrivateDnsZonePropertiesFormat +## ServiceEndpointPolicyDefinition ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **type**: string: The type of the resource. -## RecordSet +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **description**: string: A description for this rule. Restricted to 140 chars. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## ResourceTags +## ServiceEndpointPolicyPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **contextualServiceEndpointPolicies**: string[]: A collection of contextual service endpoint policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceAlias**: string: The alias indicating if the policy belongs to a service +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PublicIPPrefixPropertiesFormat +## ServiceEndpointPropertiesFormat ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **service**: string: The type of the endpoint service. -## ReferencedPublicIpAddress +## SignatureOverridesFilterValuesQuery ### Properties -* **id**: string: The PublicIPAddress Reference. +* **filterName**: string (WriteOnly): Describes the name of the column which values will be returned -## PublicIPPrefixSku +## SignatureOverridesFilterValuesResponse ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **filterValues**: string[] (ReadOnly): Describes the possible values -## ResourceTags +## Signatures ### Properties ### Additional Properties * **Additional Properties Type**: string -## RouteFilterPropertiesFormat +## SignaturesOverridesProperties ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **signatures**: [Signatures](#signatures): Dictionary of -## RouteFilterRule +## SingleQueryResult +### Properties +* **description**: string (ReadOnly): Describes what is the signature enforces +* **destinationPorts**: string[] (ReadOnly): Describes the list of destination ports related to this signature +* **direction**: int (ReadOnly): Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional +* **group**: string (ReadOnly): Describes the groups the signature belongs to +* **inheritedFromParentPolicy**: bool (ReadOnly): Describes if this override is inherited from base policy or not +* **lastUpdated**: string (ReadOnly): Describes the last updated time of the signature (provided from 3rd party vendor) +* **mode**: int (ReadOnly): The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny +* **protocol**: string (ReadOnly): Describes the protocol the signatures is being enforced in +* **severity**: int (ReadOnly): Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High +* **signatureId**: int (ReadOnly): The ID of the signature +* **sourcePorts**: string[] (ReadOnly): Describes the list of source ports related to this signature + +## Sku +### Properties +* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. + +## StaticRoute +### Properties +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. + +## Subnet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. -## RouteFilterRulePropertiesFormat +## SubnetPropertiesFormat ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource ID. -## ResourceTags +## TrafficAnalyticsConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## SecurityPartnerProviderPropertiesFormat +## TrafficAnalyticsProperties ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. + +## TrafficSelectorPolicy +### Properties +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. + +## TunnelConnectionHealth +### Properties +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualApplianceNicProperties +### Properties +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. + +## VirtualApplianceSiteProperties +### Properties +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -3882,15 +3870,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -3911,97 +3899,115 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BgpConnectionProperties +## VirtualNetworkBgpCommunities ### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **hubVirtualNetworkConnection**: [SubResource](#subresource): Reference to another subresource. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## HubRouteTableProperties +## VirtualNetworkEncryption ### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. +* **enabled**: bool (Required): Indicates if encryption is enabled on the virtual network. +* **enforcement**: 'AllowUnencrypted' | 'DropUnencrypted' | string: If the encrypted VNet allows VM that does not support encryption -## HubRoute +## VirtualNetworkGateway ### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGatewayIPConfiguration ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## RoutingIntentProperties +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingPolicies**: [RoutingPolicy](#routingpolicy)[]: List of routing policies. - -## RoutingPolicy -### Properties -* **destinations**: string[] (Required): List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). -* **name**: string (Required): The unique name for the routing policy. -* **nextHop**: string (Required): The next hop resource id on which this routing policy is applicable to. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualNetworkGatewayNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayNatRuleProperties ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **encryption**: [VirtualNetworkEncryption](#virtualnetworkencryption): Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. -* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. +* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. +* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. +* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. - -## VirtualNetworkBgpCommunities -### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## DhcpOptions +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **disableIPSecReplayProtection**: bool: disableIPSecReplayProtection flag. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## VirtualNetworkEncryption +## VirtualNetworkGatewaySku ### Properties -* **enabled**: bool (Required): Indicates if encryption is enabled on the virtual network. -* **enforcement**: 'AllowUnencrypted' | 'DropUnencrypted' | string: If the encrypted VNet allows VM that does not support encryption +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -4028,29 +4034,40 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **encryption**: [VirtualNetworkEncryption](#virtualnetworkencryption): Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. +* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualRouterPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. -* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. -* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualRouterAsn**: int: VirtualRouter ASN. -* **virtualRouterIps**: string[]: VirtualRouter IPs. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. ## VirtualRouterPeeringProperties ### Properties @@ -4058,6 +4075,15 @@ * **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +## VirtualRouterPropertiesFormat +### Properties +* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. +* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. +* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualRouterAsn**: int: VirtualRouter ASN. +* **virtualRouterIps**: string[]: VirtualRouter IPs. + ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -4069,22 +4095,56 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpConnections**: [SubResource](#subresource)[] (ReadOnly): The list of references to HubBgpConnection objects. +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. + +## VpnClientConfiguration +### Properties +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. + +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. + +## VpnClientRevokedCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. -## VpnGatewayProperties +## VpnClientRootCertificatePropertiesFormat ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **enableBgpRouteTranslationForNat**: bool: Enable BGP routes translation for NAT on this VpnGateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. -* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **publicCertData**: string (Required): The certificate public data. ## VpnConnection ### Properties @@ -4115,34 +4175,6 @@ * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. * **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. -## VpnSiteLinkConnection -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. - -## VpnSiteLinkConnectionProperties -### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. - ## VpnGatewayIpConfiguration ### Properties * **id**: string: The identifier of the IP configuration for a VPN Gateway. @@ -4168,10 +4200,42 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## ResourceTags +## VpnGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **enableBgpRouteTranslationForNat**: bool: Enable BGP routes translation for NAT on this VpnGateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. +* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. + +## VpnLinkBgpSettings +### Properties +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. + +## VpnLinkProviderProperties +### Properties +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. + +## VpnNatRuleMapping +### Properties +* **addressSpace**: string: Address space for Vpn NatRule mapping. +* **portRange**: string: Port range for Vpn NatRule mapping. + +## VpnServerConfigRadiusClientRootCertificate +### Properties +* **name**: string: The certificate name. +* **thumbprint**: string: The Radius client root certificate thumbprint. + +## VpnServerConfigRadiusServerRootCertificate +### Properties +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnServerConfigurationProperties ### Properties @@ -4191,37 +4255,6 @@ * **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. * **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## AadAuthenticationParameters -### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. - -## P2SVpnGateway -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigRadiusClientRootCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The Radius client root certificate thumbprint. - -## VpnServerConfigRadiusServerRootCertificate -### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. - ## VpnServerConfigVpnClientRevokedCertificate ### Properties * **name**: string: The certificate name. @@ -4232,40 +4265,6 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnSiteProperties -### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. - -## DeviceProperties -### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. - -## O365PolicyProperties -### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. - -## O365BreakOutCategoryPolicies -### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. - ## VpnSiteLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -4274,6 +4273,34 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -4282,63 +4309,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. - -## VpnLinkProviderProperties -### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignatureOverridesFilterValuesQuery -### Properties -* **filterName**: string (WriteOnly): Describes the name of the column which values will be returned - -## SignatureOverridesFilterValuesResponse -### Properties -* **filterValues**: string[] (ReadOnly): Describes the possible values - -## IdpsQueryObject -### Properties -* **filters**: [FilterItems](#filteritems)[] (WriteOnly): Describers the filters to filter response by -* **orderBy**: [OrderBy](#orderby) (WriteOnly): Describes a column to sort -* **resultsPerPage**: int (WriteOnly): The number of the results to return in each page -* **search**: string (WriteOnly): Search term in all columns -* **skip**: int (WriteOnly): The number of records matching the filter to skip - -## FilterItems -### Properties -* **field**: string (WriteOnly): The name of the field we would like to filter -* **values**: string[] (WriteOnly): List of values to filter the current field by - -## OrderBy +## VpnSiteProperties ### Properties -* **field**: string (WriteOnly): Describes the actual column name to sort by -* **order**: 'Ascending' | 'Descending' | string (WriteOnly): Describes if results should be in ascending/descending order +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## QueryResults +## WebApplicationFirewallCustomRule ### Properties -* **matchingRecordsCount**: int (ReadOnly): Number of total records matching the query. -* **signatures**: [SingleQueryResult](#singlequeryresult)[] (ReadOnly): Array containing the results of the query +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## SingleQueryResult +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -* **description**: string (ReadOnly): Describes what is the signature enforces -* **destinationPorts**: string[] (ReadOnly): Describes the list of destination ports related to this signature -* **direction**: int (ReadOnly): Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional -* **group**: string (ReadOnly): Describes the groups the signature belongs to -* **inheritedFromParentPolicy**: bool (ReadOnly): Describes if this override is inherited from base policy or not -* **lastUpdated**: string (ReadOnly): Describes the last updated time of the signature (provided from 3rd party vendor) -* **mode**: int (ReadOnly): The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny -* **protocol**: string (ReadOnly): Describes the protocol the signatures is being enforced in -* **severity**: int (ReadOnly): Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High -* **signatureId**: int (ReadOnly): The ID of the signature -* **sourcePorts**: string[] (ReadOnly): Describes the list of source ports related to this signature +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2021-08-01/types.md b/generated/network/microsoft.network/2021-08-01/types.md index bdbe3f38ae..238023e560 100644 --- a/generated/network/microsoft.network/2021-08-01/types.md +++ b/generated/network/microsoft.network/2021-08-01/types.md @@ -918,60 +918,27 @@ * **Input**: [IdpsQueryObject](#idpsqueryobject) * **Output**: [QueryResults](#queryresults) -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. - -## ManagedServiceIdentityUserAssignedIdentities +## AadAuthenticationParameters ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. +* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. +* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AddressSpace ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. -## ApplicationGatewayPropertiesFormat +## ApplicationGateway ### Properties -* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). -* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. -* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). -* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). -* **backendSettingsCollection**: [ApplicationGatewayBackendSettings](#applicationgatewaybackendsettings)[]: Backend 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). -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. -* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. -* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. -* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). -* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). -* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). -* **globalConfiguration**: [ApplicationGatewayGlobalConfiguration](#applicationgatewayglobalconfiguration): Application Gateway global configuration. -* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). -* **listeners**: [ApplicationGatewayListener](#applicationgatewaylistener)[]: 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). -* **loadDistributionPolicies**: [ApplicationGatewayLoadDistributionPolicy](#applicationgatewayloaddistributionpolicy)[]: Load distribution policies of the application gateway resource. -* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. -* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. -* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. -* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). -* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. -* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. -* **routingRules**: [ApplicationGatewayRoutingRule](#applicationgatewayroutingrule)[]: Routing rules of the application gateway resource. -* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. -* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). -* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). -* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). -* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. ## ApplicationGatewayAuthenticationCertificate ### Properties @@ -991,6 +958,11 @@ * **maxCapacity**: int: Upper bound on number of Application Gateway capacity. * **minCapacity**: int (Required): Lower bound on number of Application Gateway capacity. +## ApplicationGatewayBackendAddress +### Properties +* **fqdn**: string: Fully qualified domain name (FQDN). +* **ipAddress**: string: IP address. + ## ApplicationGatewayBackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -1005,2389 +977,2421 @@ * **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): Collection of references to IPs defined in network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendAddress -### Properties -* **fqdn**: string: Fully qualified domain name (FQDN). -* **ipAddress**: string: IP address. - -## NetworkInterfaceIPConfiguration +## ApplicationGatewayBackendHttpSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. -* **type**: string: Resource type. +* **name**: string: Name of the backend http settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceIPConfigurationPropertiesFormat +## ApplicationGatewayBackendHttpSettingsPropertiesFormat ### Properties -* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. -* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. -* **primary**: bool: Whether this is a primary customer address on the network interface. -* **privateIPAddress**: string: Private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. +* **affinityCookieName**: string: Cookie name to use for the affinity cookie. +* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. +* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. +* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. +* **hostName**: string: Host header to be sent to the backend servers. +* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. +* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. +* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. +* **requestTimeout**: int: 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. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ApplicationSecurityGroup +## ApplicationGatewayBackendSettings ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the backend settings that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayBackendSettingsPropertiesFormat](#applicationgatewaybackendsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ApplicationSecurityGroupPropertiesFormat +## ApplicationGatewayBackendSettingsPropertiesFormat ### Properties +* **hostName**: string: Server name indication to be sent to the backend servers for Tls protocol. +* **pickHostNameFromBackendAddress**: bool: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false. +* **port**: int: The destination port on the backend. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **timeout**: int: Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds. +* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. -## ResourceTags +## ApplicationGatewayClientAuthConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. -## SubResource +## ApplicationGatewayConnectionDraining ### Properties -* **id**: string: Resource ID. +* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. +* **enabled**: bool (Required): Whether connection draining is enabled or not. -## BackendAddressPool +## ApplicationGatewayCustomError +### Properties +* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. +* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. + +## ApplicationGatewayFirewallDisabledRuleGroup +### Properties +* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. +* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. + +## ApplicationGatewayFirewallExclusion +### Properties +* **matchVariable**: string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. + +## ApplicationGatewayFrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## BackendAddressPoolPropertiesFormat +## ApplicationGatewayFrontendIPConfigurationPropertiesFormat ### Properties -* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. -* **drainPeriodInSeconds**: int: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound NAT rules that use this backend address pool. -* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. -* **location**: string: The location of the backend address pool. -* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. +* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## LoadBalancerBackendAddress +## ApplicationGatewayFrontendPort ### Properties -* **name**: string: Name of the backend address. -* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the frontend port that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## LoadBalancerBackendAddressPropertiesFormat +## ApplicationGatewayFrontendPortPropertiesFormat ### Properties -* **adminState**: 'Down' | 'Drain' | 'None' | 'Up' | string: A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. -* **inboundNatRulesPortMapping**: [NatRulePortMapping](#natruleportmapping)[] (ReadOnly): Collection of inbound NAT rule port mappings. -* **ipAddress**: string: IP Address belonging to the referenced virtual network. -* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **port**: int: Frontend port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NatRulePortMapping +## ApplicationGatewayGlobalConfiguration ### Properties -* **backendPort**: int: Backend port. -* **frontendPort**: int: Frontend port. -* **inboundNatRuleName**: string: Name of inbound NAT rule. +* **enableRequestBuffering**: bool: Enable request buffering. +* **enableResponseBuffering**: bool: Enable response buffering. -## GatewayLoadBalancerTunnelInterface +## ApplicationGatewayHeaderConfiguration ### Properties -* **identifier**: int: Identifier of gateway load balancer tunnel interface. -* **port**: int: Port of gateway load balancer tunnel interface. -* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. -* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. +* **headerName**: string: Header name of the header configuration. +* **headerValue**: string: Header value of the header configuration. -## InboundNatRule +## ApplicationGatewayHttpListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. * **type**: string (ReadOnly): Type of the resource. -## InboundNatRulePropertiesFormat +## ApplicationGatewayHttpListenerPropertiesFormat ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. -* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. * **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int: 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. -* **frontendPortRangeEnd**: int: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. -* **frontendPortRangeStart**: int: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **hostName**: string: Host name of HTTP listener. +* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. +* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties -### Properties -* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. -* **groupId**: string (ReadOnly): The group ID for current private link connection. -* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. - -## PublicIPAddress +## ApplicationGatewayIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. -* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. - -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. +* **name**: string: Name of the IP configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PublicIPAddressPropertiesFormat +## ApplicationGatewayIPConfigurationPropertiesFormat ### Properties -* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. -* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted -* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. -* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. -* **ipAddress**: string: The IP address associated with the public IP address resource. -* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. -* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. -* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. - -## DdosSettings -### Properties -* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. -* **protectedIP**: bool: Enables DDoS protection on the public IP. -* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. - -## PublicIPAddressDnsSettings -### Properties -* **domainNameLabel**: string: 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. -* **fqdn**: 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. -* **reverseFqdn**: 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. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## IPConfiguration +## ApplicationGatewayListener ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. +* **name**: string: Name of the listener that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayListenerPropertiesFormat](#applicationgatewaylistenerpropertiesformat): Properties of listener of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationPropertiesFormat +## ApplicationGatewayListenerPropertiesFormat ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. +* **sslProfile**: [SubResource](#subresource): Reference to another subresource. -## Subnet +## ApplicationGatewayLoadDistributionPolicy ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. -* **type**: string: Resource type. +* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayLoadDistributionPolicyPropertiesFormat](#applicationgatewayloaddistributionpolicypropertiesformat): Properties of Load Distribution Policy of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## SubnetPropertiesFormat +## ApplicationGatewayLoadDistributionPolicyPropertiesFormat ### Properties -* **addressPrefix**: string: The address prefix for the subnet. -* **addressPrefixes**: string[]: List of address prefixes for the subnet. -* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. -* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. -* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. -* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. -* **natGateway**: [SubResource](#subresource): Reference to another subresource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. -* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **loadDistributionAlgorithm**: 'IpHash' | 'LeastConnections' | 'RoundRobin' | string: Load Distribution Algorithm enums. +* **loadDistributionTargets**: [ApplicationGatewayLoadDistributionTarget](#applicationgatewayloaddistributiontarget)[]: Load Distribution Targets resource of an application gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. -* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. -* **routeTable**: [RouteTable](#routetable): Route table resource. -* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. -* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. -* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## ApplicationGatewayIPConfiguration +## ApplicationGatewayLoadDistributionTarget ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayIPConfigurationPropertiesFormat](#applicationgatewayipconfigurationpropertiesformat): Properties of IP configuration of an application gateway. +* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayLoadDistributionTargetPropertiesFormat](#applicationgatewayloaddistributiontargetpropertiesformat) * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayIPConfigurationPropertiesFormat +## ApplicationGatewayLoadDistributionTargetPropertiesFormat ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **weightPerServer**: int: Weight per server. Range between 1 and 100. -## Delegation +## ApplicationGatewayPathRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. -* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. -* **type**: string: Resource type. +* **name**: string: Name of the path rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ServiceDelegationPropertiesFormat +## ApplicationGatewayPathRulePropertiesFormat ### Properties -* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **paths**: string[]: Path rules of URL path map. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -## IPConfigurationProfile +## ApplicationGatewayPrivateEndpointConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the private endpoint connection on an application gateway. +* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## IPConfigurationProfilePropertiesFormat +## ApplicationGatewayPrivateEndpointConnectionProperties ### Properties +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## NetworkSecurityGroup +## ApplicationGatewayPrivateLinkConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the private link configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkSecurityGroupPropertiesFormat +## ApplicationGatewayPrivateLinkConfigurationProperties ### Properties -* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. -* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. -* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## SecurityRule +## ApplicationGatewayPrivateLinkIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. -* **type**: string: The type of the resource. +* **name**: string: The name of application gateway private link ip configuration. +* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. +* **type**: string (ReadOnly): The resource type. -## SecurityRulePropertiesFormat +## ApplicationGatewayPrivateLinkIpConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. -* **description**: string: A description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: 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. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. -* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. -* **priority**: int: 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. -* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourceAddressPrefix**: 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. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. -* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. -* **sourcePortRanges**: string[]: The source port ranges. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## FlowLog +## ApplicationGatewayProbe ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the probe that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## FlowLogPropertiesFormat +## ApplicationGatewayProbeHealthResponseMatch ### Properties -* **enabled**: bool: Flag to enable/disable flow logging. -* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. -* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. +* **body**: string: Body that must be contained in the health response. Default value is empty. +* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. + +## ApplicationGatewayProbePropertiesFormat +### Properties +* **host**: string: Host name to send the probe to. +* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. +* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. +* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. +* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. +* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. +* **pickHostNameFromBackendSettings**: bool: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. +* **port**: int: 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. +* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. -* **storageId**: string (Required): ID of the storage account which is used to store the flow log. -* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. -* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. +* **timeout**: int: 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. +* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. -## TrafficAnalyticsProperties +## ApplicationGatewayPropertiesFormat ### Properties -* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. +* **authenticationCertificates**: [ApplicationGatewayAuthenticationCertificate](#applicationgatewayauthenticationcertificate)[]: 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). +* **autoscaleConfiguration**: [ApplicationGatewayAutoscaleConfiguration](#applicationgatewayautoscaleconfiguration): Application Gateway autoscale configuration. +* **backendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: 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). +* **backendHttpSettingsCollection**: [ApplicationGatewayBackendHttpSettings](#applicationgatewaybackendhttpsettings)[]: 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). +* **backendSettingsCollection**: [ApplicationGatewayBackendSettings](#applicationgatewaybackendsettings)[]: Backend 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). +* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the application gateway resource. +* **enableFips**: bool: Whether FIPS is enabled on the application gateway resource. +* **enableHttp2**: bool: Whether HTTP2 is enabled on the application gateway resource. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **forceFirewallPolicyAssociation**: bool: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. +* **frontendIPConfigurations**: [ApplicationGatewayFrontendIPConfiguration](#applicationgatewayfrontendipconfiguration)[]: 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). +* **frontendPorts**: [ApplicationGatewayFrontendPort](#applicationgatewayfrontendport)[]: 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). +* **gatewayIPConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: 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). +* **globalConfiguration**: [ApplicationGatewayGlobalConfiguration](#applicationgatewayglobalconfiguration): Application Gateway global configuration. +* **httpListeners**: [ApplicationGatewayHttpListener](#applicationgatewayhttplistener)[]: 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). +* **listeners**: [ApplicationGatewayListener](#applicationgatewaylistener)[]: 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). +* **loadDistributionPolicies**: [ApplicationGatewayLoadDistributionPolicy](#applicationgatewayloaddistributionpolicy)[]: Load distribution policies of the application gateway resource. +* **operationalState**: 'Running' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): Operational state of the application gateway resource. +* **privateEndpointConnections**: [ApplicationGatewayPrivateEndpointConnection](#applicationgatewayprivateendpointconnection)[] (ReadOnly): Private Endpoint connections on application gateway. +* **privateLinkConfigurations**: [ApplicationGatewayPrivateLinkConfiguration](#applicationgatewayprivatelinkconfiguration)[]: PrivateLink configurations on application gateway. +* **probes**: [ApplicationGatewayProbe](#applicationgatewayprobe)[]: Probes of the application gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **redirectConfigurations**: [ApplicationGatewayRedirectConfiguration](#applicationgatewayredirectconfiguration)[]: 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). +* **requestRoutingRules**: [ApplicationGatewayRequestRoutingRule](#applicationgatewayrequestroutingrule)[]: Request routing rules of the application gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application gateway resource. +* **rewriteRuleSets**: [ApplicationGatewayRewriteRuleSet](#applicationgatewayrewriteruleset)[]: Rewrite rules for the application gateway resource. +* **routingRules**: [ApplicationGatewayRoutingRule](#applicationgatewayroutingrule)[]: Routing rules of the application gateway resource. +* **sku**: [ApplicationGatewaySku](#applicationgatewaysku): SKU of an application gateway. +* **sslCertificates**: [ApplicationGatewaySslCertificate](#applicationgatewaysslcertificate)[]: 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). +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **sslProfiles**: [ApplicationGatewaySslProfile](#applicationgatewaysslprofile)[]: SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). +* **trustedClientCertificates**: [ApplicationGatewayTrustedClientCertificate](#applicationgatewaytrustedclientcertificate)[]: Trusted client 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**: [ApplicationGatewayTrustedRootCertificate](#applicationgatewaytrustedrootcertificate)[]: 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). +* **urlPathMaps**: [ApplicationGatewayUrlPathMap](#applicationgatewayurlpathmap)[]: 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). +* **webApplicationFirewallConfiguration**: [ApplicationGatewayWebApplicationFirewallConfiguration](#applicationgatewaywebapplicationfirewallconfiguration): Application gateway web application firewall configuration. -## TrafficAnalyticsConfigurationProperties +## ApplicationGatewayRedirectConfiguration ### Properties -* **enabled**: bool: Flag to enable/disable traffic analytics. -* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. -* **workspaceId**: string: The resource guid of the attached workspace. -* **workspaceRegion**: string: The location of the attached workspace. -* **workspaceResourceId**: string: Resource Id of the attached workspace. - -## FlowLogFormatParameters -### Properties -* **type**: 'JSON' | string: The file type of flow log. -* **version**: int: The version (revision) of the flow log. - -## RetentionPolicyParameters -### Properties -* **days**: int: Number of days to retain flow log records. -* **enabled**: bool: Flag to enable/disable retention. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## ResourceTags +## ApplicationGatewayRedirectConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **includePath**: bool: Include path in the redirected url. +* **includeQueryString**: bool: Include query string in the redirected url. +* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. +* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. +* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. +* **targetListener**: [SubResource](#subresource): Reference to another subresource. +* **targetUrl**: string: Url to redirect the request to. +* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. -## NetworkInterface +## ApplicationGatewayRequestRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the request routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfacePropertiesFormat +## ApplicationGatewayRequestRoutingRulePropertiesFormat ### Properties -* **auxiliaryMode**: 'Floating' | 'MaxConnections' | 'None' | string: Auxiliary mode of Network Interface resource. -* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. -* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. -* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. -* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. -* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. -* **macAddress**: string (ReadOnly): The MAC address of the network interface. -* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. -* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. -* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. -* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **httpListener**: [SubResource](#subresource): Reference to another subresource. +* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **priority**: int: Priority of the request routing rule. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. -* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. -* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **vnetEncryptionSupported**: bool (ReadOnly): Whether the virtual machine this nic is attached to supports encryption. -* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources - -## NetworkInterfaceDnsSettings -### Properties -* **appliedDnsServers**: string[] (ReadOnly): 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. -* **dnsServers**: string[]: 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. -* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. -* **internalDomainNameSuffix**: string (ReadOnly): 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. -* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. +* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. -## PrivateEndpoint +## ApplicationGatewayRewriteRule ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. +* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. +* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. +* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. -## PrivateEndpointProperties +## ApplicationGatewayRewriteRuleActionSet ### Properties -* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the private endpoint IP configuration is included. -* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. -* **customNetworkInterfaceName**: string: The custom name of the network interface attached to the private endpoint. -* **ipConfigurations**: [PrivateEndpointIPConfiguration](#privateendpointipconfiguration)[]: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. -* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. +* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. +* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. -## CustomDnsConfigPropertiesFormat +## ApplicationGatewayRewriteRuleCondition ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. +* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. +* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. +* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. +* **variable**: string: The condition parameter of the RewriteRuleCondition. -## PrivateEndpointIPConfiguration +## ApplicationGatewayRewriteRuleSet ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource that is unique within a resource group. -* **properties**: [PrivateEndpointIPConfigurationProperties](#privateendpointipconfigurationproperties): Properties of an IP Configuration of the private endpoint. -* **type**: string (ReadOnly): The resource type. +* **id**: string: Resource ID. +* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. -## PrivateEndpointIPConfigurationProperties +## ApplicationGatewayRewriteRuleSetPropertiesFormat ### Properties -* **groupId**: string: The ID of a group obtained from the remote resource that this private endpoint should connect to. -* **memberName**: string: The member name of a group obtained from the remote resource that this private endpoint should connect to. -* **privateIPAddress**: string: A private ip address obtained from the private endpoint's subnet. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. -## PrivateLinkServiceConnection +## ApplicationGatewayRoutingRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the routing rule that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayRoutingRulePropertiesFormat](#applicationgatewayroutingrulepropertiesformat): Properties of routing rule of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceConnectionProperties +## ApplicationGatewayRoutingRulePropertiesFormat ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **privateLinkServiceId**: string: The resource id of private link service. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendSettings**: [SubResource](#subresource): Reference to another subresource. +* **listener**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -## ResourceTags +## ApplicationGatewaySku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity (instance count) of an application gateway. +* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. +* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. -## PrivateLinkService +## ApplicationGatewaySslCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceProperties +## ApplicationGatewaySslCertificatePropertiesFormat ### Properties -* **alias**: string (ReadOnly): The alias of the private link service. -* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. -* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. -* **fqdns**: string[]: The list of Fqdn. -* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. -* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. -* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. +* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. -## PrivateLinkServicePropertiesAutoApproval +## ApplicationGatewaySslPolicy ### Properties -* **subscriptions**: string[]: The list of subscriptions. +* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. +* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. +* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. +* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. +* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. -## PrivateLinkServiceIpConfiguration +## ApplicationGatewaySslProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of private link service ip configuration. -* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the SSL profile that is unique within an Application Gateway. +* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateLinkServiceIpConfigurationProperties +## ApplicationGatewaySslProfilePropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. +* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. -## FrontendIPConfiguration +## ApplicationGatewayTrustedClientCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: 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. -* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. * **type**: string (ReadOnly): Type of the resource. -* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## FrontendIPConfigurationPropertiesFormat +## ApplicationGatewayTrustedClientCertificatePropertiesFormat ### Properties -* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. -* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. -* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. -* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. +* **data**: string: Certificate public data. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **validatedCertData**: string (ReadOnly): Validated certificate data. -## PrivateEndpointConnection +## ApplicationGatewayTrustedRootCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The resource type. +* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. +* **type**: string (ReadOnly): Type of the resource. -## PrivateEndpointConnectionProperties +## ApplicationGatewayTrustedRootCertificatePropertiesFormat ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **data**: string: Certificate public data. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## PrivateLinkServicePropertiesVisibility +## ApplicationGatewayUrlConfiguration ### Properties -* **subscriptions**: string[]: The list of subscriptions. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. +* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. +* **reroute**: bool: 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. -## NetworkInterfaceTapConfiguration +## ApplicationGatewayUrlPathMap ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. -* **type**: string (ReadOnly): Sub Resource type. +* **name**: string: Name of the URL path map that is unique within an Application Gateway. +* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. +* **type**: string (ReadOnly): Type of the resource. -## NetworkInterfaceTapConfigurationPropertiesFormat +## ApplicationGatewayUrlPathMapPropertiesFormat ### Properties +* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. +* **defaultLoadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. +* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## VirtualNetworkTap +## ApplicationGatewayWebApplicationFirewallConfiguration +### Properties +* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. +* **enabled**: bool (Required): Whether the web application firewall is enabled or not. +* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. +* **maxRequestBodySize**: int: Maximum request body size for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **requestBodyCheck**: bool: Whether allow WAF to check request Body. +* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. +* **ruleSetVersion**: string (Required): The version of the rule set type. + +## ApplicationSecurityGroup ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **location**: string: Resource location. * **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **properties**: [ApplicationSecurityGroupPropertiesFormat](#applicationsecuritygrouppropertiesformat): Application security group properties. * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: string (ReadOnly): Resource type. -## VirtualNetworkTapPropertiesFormat +## ApplicationSecurityGroupPropertiesFormat ### Properties -* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. -* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. -* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. -* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ResourceTags +## AuthorizationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **authorizationKey**: string: The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## AzureFirewallAdditionalProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## AzureFirewallApplicationRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **fqdnTags**: string[]: List of FQDN Tags for this rule. +* **name**: string: Name of the application rule. +* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **targetFqdns**: string[]: List of FQDNs for this rule. -## ResourceNavigationLink +## AzureFirewallApplicationRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. -## ResourceNavigationLinkFormat +## AzureFirewallApplicationRuleCollectionPropertiesFormat ### Properties -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the application rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. -## RouteTable +## AzureFirewallApplicationRuleProtocol +### Properties +* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. +* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. + +## AzureFirewallIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. +* **type**: string (ReadOnly): Type of the resource. -## RouteTablePropertiesFormat +## AzureFirewallIPConfigurationPropertiesFormat ### Properties -* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. +* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. -* **routes**: [Route](#route)[]: Collection of routes contained within a route table. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## Route +## AzureFirewallIpGroups ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. -* **type**: string: The type of the resource. +* **changeNumber**: string (ReadOnly): The iteration number. +* **id**: string (ReadOnly): Resource ID. -## RoutePropertiesFormat +## AzureFirewallNatRCAction ### Properties -* **addressPrefix**: string: The destination CIDR to which the route applies. -* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. -* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. -* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. -## ResourceTags +## AzureFirewallNatRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the NAT rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## ServiceAssociationLink +## AzureFirewallNatRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. -## ServiceAssociationLinkPropertiesFormat +## AzureFirewallNatRuleCollectionProperties ### Properties -* **allowDelete**: bool: If true, the resource can be deleted. -* **link**: string: Link to the external resource. -* **linkedResourceType**: string: Resource type of the linked resource. -* **locations**: string[]: A list of locations. +* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. +* **priority**: int: Priority of the NAT rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. -## ServiceEndpointPolicy +## AzureFirewallNetworkRule +### Properties +* **description**: string: Description of the rule. +* **destinationAddresses**: string[]: List of destination IP addresses. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **name**: string: Name of the network rule. +* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. + +## AzureFirewallNetworkRuleCollection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. +* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. -## ServiceEndpointPolicyPropertiesFormat +## AzureFirewallNetworkRuleCollectionPropertiesFormat ### Properties -* **contextualServiceEndpointPolicies**: string[]: A collection of contextual service endpoint policy. +* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. +* **priority**: int: Priority of the network rule collection resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. -* **serviceAlias**: string: The alias indicating if the policy belongs to a service -* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. -* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. - -## ServiceEndpointPolicyDefinition -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. -* **type**: string: The type of the resource. +* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. -## ServiceEndpointPolicyDefinitionPropertiesFormat +## AzureFirewallPropertiesFormat ### Properties -* **description**: string: A description for this rule. Restricted to 140 chars. +* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. +* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. +* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. +* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. +* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. +* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. +* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. +* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. +* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: Service endpoint name. -* **serviceResources**: string[]: A list of service resources. +* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## AzureFirewallPublicIPAddress ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **address**: string: Public IP Address value. -## ServiceEndpointPropertiesFormat +## AzureFirewallRCAction ### Properties -* **locations**: string[]: A list of locations. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **service**: string: The type of the endpoint service. +* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. -## IpTag +## AzureFirewallSku ### Properties -* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. -* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. +* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of an Azure Firewall. -## NatGateway +## BackendAddressPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. -* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. +* **name**: 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. +* **properties**: [BackendAddressPoolPropertiesFormat](#backendaddresspoolpropertiesformat): Properties of the backend address pool. +* **type**: string (ReadOnly): Type of the resource. -## NatGatewayPropertiesFormat +## BackendAddressPoolPropertiesFormat ### Properties -* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. +* **backendIPConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[] (ReadOnly): An array of references to IP addresses defined in network interfaces. +* **drainPeriodInSeconds**: int: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound NAT rules that use this backend address pool. +* **loadBalancerBackendAddresses**: [LoadBalancerBackendAddress](#loadbalancerbackendaddress)[]: An array of backend addresses. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this backend address pool. +* **location**: string: The location of the backend address pool. +* **outboundRule**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this backend address pool. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. -* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. -* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. +* **tunnelInterfaces**: [GatewayLoadBalancerTunnelInterface](#gatewayloadbalancertunnelinterface)[]: An array of gateway load balancer tunnel interfaces. -## NatGatewaySku +## BastionHostIPConfiguration ### Properties -* **name**: 'Standard' | string: Name of Nat Gateway SKU. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. +* **type**: string (ReadOnly): Ip configuration type. -## ResourceTags +## BastionHostIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. +* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. -## PublicIPAddressSku +## BastionHostPropertiesFormat ### Properties -* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. +* **disableCopyPaste**: bool: Enable/Disable Copy/Paste feature of the Bastion Host resource. +* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. +* **enableFileCopy**: bool: Enable/Disable File Copy feature of the Bastion Host resource. +* **enableIpConnect**: bool: Enable/Disable IP Connect feature of the Bastion Host resource. +* **enableShareableLink**: bool: Enable/Disable Shareable Link of the Bastion Host resource. +* **enableTunneling**: bool: Enable/Disable Tunneling feature of the Bastion Host resource. +* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **scaleUnits**: int: The scale units for the Bastion Host resource. -## ResourceTags +## BgpConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. +* **hubVirtualNetworkConnection**: [SubResource](#subresource): Reference to another subresource. +* **peerAsn**: int: Peer ASN. +* **peerIp**: string: Peer IP. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayBackendHttpSettings +## BgpSettings ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend http settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendHttpSettingsPropertiesFormat](#applicationgatewaybackendhttpsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. +* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. +* **peerWeight**: int: The weight added to routes learned from this BGP speaker. -## ApplicationGatewayBackendHttpSettingsPropertiesFormat +## BreakOutCategoryPolicies ### Properties -* **affinityCookieName**: string: Cookie name to use for the affinity cookie. -* **authenticationCertificates**: [SubResource](#subresource)[]: Array of references to application gateway authentication certificates. -* **connectionDraining**: [ApplicationGatewayConnectionDraining](#applicationgatewayconnectiondraining): 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. -* **cookieBasedAffinity**: 'Disabled' | 'Enabled' | string: Cookie based affinity. -* **hostName**: string: Host header to be sent to the backend servers. -* **path**: string: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. -* **pickHostNameFromBackendAddress**: bool: Whether to pick host header should be picked from the host name of the backend server. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **probeEnabled**: bool: Whether the probe is enabled. Default value is false. -* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestTimeout**: int: 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. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **allow**: bool: Flag to control breakout of o365 allow category. +* **default**: bool: Flag to control breakout of o365 default category. +* **optimize**: bool: Flag to control breakout of o365 optimize category. -## ApplicationGatewayConnectionDraining +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **drainTimeoutInSec**: int (Required): The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. -* **enabled**: bool (Required): Whether connection draining is enabled or not. +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## ApplicationGatewayBackendSettings +## ConnectionMonitorDestination ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the backend settings that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayBackendSettingsPropertiesFormat](#applicationgatewaybackendsettingspropertiesformat): Properties of Backend address pool settings of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: Address of the connection monitor destination (IP or domain name). +* **port**: int: The destination port used by connection monitor. +* **resourceId**: string: The ID of the resource used as the destination by connection monitor. -## ApplicationGatewayBackendSettingsPropertiesFormat +## ConnectionMonitorEndpoint ### Properties -* **hostName**: string: Server name indication to be sent to the backend servers for Tls protocol. -* **pickHostNameFromBackendAddress**: bool: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false. -* **port**: int: The destination port on the backend. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds. -* **trustedRootCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted root certificates. +* **address**: string: Address of the connection monitor endpoint (IP or domain name). +* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. +* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. +* **name**: string (Required): The name of the connection monitor endpoint. +* **resourceId**: string: Resource ID of the connection monitor endpoint. +* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. +* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. -## ApplicationGatewayCustomError +## ConnectionMonitorEndpointFilter ### Properties -* **customErrorPageUrl**: string: Error page URL of the application gateway customer error. -* **statusCode**: 'HttpStatus403' | 'HttpStatus502' | string: Status code of the application gateway customer error. +* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. +* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. -## ApplicationGatewayFrontendIPConfiguration +## ConnectionMonitorEndpointFilterItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend IP configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendIPConfigurationPropertiesFormat](#applicationgatewayfrontendipconfigurationpropertiesformat): Properties of Frontend IP configuration of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: The address of the filter item. +* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. -## ApplicationGatewayFrontendIPConfigurationPropertiesFormat +## ConnectionMonitorEndpointScope ### Properties -* **privateIPAddress**: string: PrivateIPAddress of the network interface IP Configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **privateLinkConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. +* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. -## ApplicationGatewayFrontendPort +## ConnectionMonitorEndpointScopeItem ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the frontend port that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayFrontendPortPropertiesFormat](#applicationgatewayfrontendportpropertiesformat): Properties of Frontend port of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. -## ApplicationGatewayFrontendPortPropertiesFormat +## ConnectionMonitorHttpConfiguration ### Properties -* **port**: int: Frontend port. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **method**: 'Get' | 'Post' | string: The HTTP method to use. +* **path**: string: The path component of the URI. For instance, "/dir1/dir2". +* **port**: int: The port to connect to. +* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. +* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. +* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". -## ApplicationGatewayGlobalConfiguration +## ConnectionMonitorIcmpConfiguration ### Properties -* **enableRequestBuffering**: bool: Enable request buffering. -* **enableResponseBuffering**: bool: Enable response buffering. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -## ApplicationGatewayHttpListener +## ConnectionMonitorOutput ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the HTTP listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayHttpListenerPropertiesFormat](#applicationgatewayhttplistenerpropertiesformat): Properties of HTTP listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. +* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. -## ApplicationGatewayHttpListenerPropertiesFormat +## ConnectionMonitorParameters ### Properties -* **customErrorConfigurations**: [ApplicationGatewayCustomError](#applicationgatewaycustomerror)[]: Custom error configurations of the HTTP listener. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **hostName**: string: Host name of HTTP listener. -* **hostNames**: string[]: List of Host names for HTTP Listener that allows special wildcard characters as well. -* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. +* **autoStart**: bool: Determines if the connection monitor will start automatically once created. +* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. +* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. +* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. +* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. +* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. +* **notes**: string: Optional notes to be associated with the connection monitor. +* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requireServerNameIndication**: bool: Applicable only if protocol is https. Enables SNI for multi-hosting. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. +* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. +* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. +* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. -## ApplicationGatewayListener +## ConnectionMonitorSource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the listener that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayListenerPropertiesFormat](#applicationgatewaylistenerpropertiesformat): Properties of listener of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **port**: int: The source port used by connection monitor. +* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. -## ApplicationGatewayListenerPropertiesFormat +## ConnectionMonitorSuccessThreshold ### Properties -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslCertificate**: [SubResource](#subresource): Reference to another subresource. -* **sslProfile**: [SubResource](#subresource): Reference to another subresource. +* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. +* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. -## ApplicationGatewayLoadDistributionPolicy +## ConnectionMonitorTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayLoadDistributionPolicyPropertiesFormat](#applicationgatewayloaddistributionpolicypropertiesformat): Properties of Load Distribution Policy of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayLoadDistributionPolicyPropertiesFormat +## ConnectionMonitorTcpConfiguration ### Properties -* **loadDistributionAlgorithm**: 'IpHash' | 'LeastConnections' | 'RoundRobin' | string: Load Distribution Algorithm enums. -* **loadDistributionTargets**: [ApplicationGatewayLoadDistributionTarget](#applicationgatewayloaddistributiontarget)[]: Load Distribution Targets resource of an application gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. +* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **port**: int: The port to connect to. -## ApplicationGatewayLoadDistributionTarget +## ConnectionMonitorTestConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the load distribution policy that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayLoadDistributionTargetPropertiesFormat](#applicationgatewayloaddistributiontargetpropertiesformat) -* **type**: string (ReadOnly): Type of the resource. +* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. +* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. +* **name**: string (Required): The name of the connection monitor test configuration. +* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. +* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. +* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. +* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. +* **testFrequencySec**: int: The frequency of test evaluation, in seconds. -## ApplicationGatewayLoadDistributionTargetPropertiesFormat +## ConnectionMonitorTestGroup ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **weightPerServer**: int: Weight per server. Range between 1 and 100. +* **destinations**: string[] (Required): List of destination endpoint names. +* **disable**: bool: Value indicating whether test group is disabled. +* **name**: string (Required): The name of the connection monitor test group. +* **sources**: string[] (Required): List of source endpoint names. +* **testConfigurations**: string[] (Required): List of test configuration names. -## ApplicationGatewayPrivateEndpointConnection +## ConnectionMonitorWorkspaceSettings +### Properties +* **workspaceResourceId**: string: Log analytics workspace resource ID. + +## Container ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private endpoint connection on an application gateway. -* **properties**: [ApplicationGatewayPrivateEndpointConnectionProperties](#applicationgatewayprivateendpointconnectionproperties): Properties of Private Link Resource of an application gateway. -* **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayPrivateEndpointConnectionProperties +## ContainerNetworkInterface ### Properties -* **linkIdentifier**: string (ReadOnly): The consumer link id. -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateLinkConfiguration +## ContainerNetworkInterfaceConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the private link configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPrivateLinkConfigurationProperties](#applicationgatewayprivatelinkconfigurationproperties): Properties of private link configuration on an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateLinkConfigurationProperties +## ContainerNetworkInterfaceConfigurationPropertiesFormat ### Properties -* **ipConfigurations**: [ApplicationGatewayPrivateLinkIpConfiguration](#applicationgatewayprivatelinkipconfiguration)[]: An array of application gateway private link ip configurations. +* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. +* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayPrivateLinkIpConfiguration +## ContainerNetworkInterfaceIpConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of application gateway private link ip configuration. -* **properties**: [ApplicationGatewayPrivateLinkIpConfigurationProperties](#applicationgatewayprivatelinkipconfigurationproperties): Properties of an application gateway private link IP configuration. -* **type**: string (ReadOnly): The resource type. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ApplicationGatewayPrivateLinkIpConfigurationProperties +## ContainerNetworkInterfaceIpConfigurationPropertiesFormat ### Properties -* **primary**: bool: Whether the ip configuration is primary or not. -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **subnet**: [SubResource](#subresource): Reference to another subresource. -## ApplicationGatewayProbe +## ContainerNetworkInterfacePropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the probe that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayProbePropertiesFormat](#applicationgatewayprobepropertiesformat): Properties of probe of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **container**: [Container](#container): Reference to container resource in remote resource provider. +* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. +* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ApplicationGatewayProbePropertiesFormat +## CustomDnsConfigPropertiesFormat ### Properties -* **host**: string: Host name to send the probe to. -* **interval**: int: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. -* **match**: [ApplicationGatewayProbeHealthResponseMatch](#applicationgatewayprobehealthresponsematch): Application gateway probe health response match. -* **minServers**: int: Minimum number of servers that are always marked healthy. Default value is 0. -* **path**: string: Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. -* **pickHostNameFromBackendHttpSettings**: bool: Whether the host header should be picked from the backend http settings. Default value is false. -* **pickHostNameFromBackendSettings**: bool: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. -* **port**: int: 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. -* **protocol**: 'Http' | 'Https' | 'Tcp' | 'Tls' | string: Application Gateway protocol. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **timeout**: int: 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. -* **unhealthyThreshold**: int: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: A list of private ip addresses of the private endpoint. -## ApplicationGatewayProbeHealthResponseMatch +## CustomIpPrefixPropertiesFormat ### Properties -* **body**: string: Body that must be contained in the health response. Default value is empty. -* **statusCodes**: string[]: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. +* **authorizationMessage**: string: Authorization message for WAN validation. +* **childCustomIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. +* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. +* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. +* **customIpPrefixParent**: [SubResource](#subresource): Reference to another subresource. +* **failedReason**: string (ReadOnly): The reason why resource is in failed state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. +* **signedMessage**: string: Signed message for WAN validation. -## ApplicationGatewayRedirectConfiguration +## DdosCustomPolicyPropertiesFormat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the redirect configuration that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRedirectConfigurationPropertiesFormat](#applicationgatewayredirectconfigurationpropertiesformat): Properties of redirect configuration of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ApplicationGatewayRedirectConfigurationPropertiesFormat +## DdosProtectionPlanPropertiesFormat ### Properties -* **includePath**: bool: Include path in the redirected url. -* **includeQueryString**: bool: Include query string in the redirected url. -* **pathRules**: [SubResource](#subresource)[]: Path rules specifying redirect configuration. -* **redirectType**: 'Found' | 'Permanent' | 'SeeOther' | 'Temporary' | string: Redirect type enum. -* **requestRoutingRules**: [SubResource](#subresource)[]: Request routing specifying redirect configuration. -* **targetListener**: [SubResource](#subresource): Reference to another subresource. -* **targetUrl**: string: Url to redirect the request to. -* **urlPathMaps**: [SubResource](#subresource)[]: Url path maps specifying default redirect configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. +* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. -## ApplicationGatewayRequestRoutingRule +## DdosProtectionPlanTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the request routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRequestRoutingRulePropertiesFormat](#applicationgatewayrequestroutingrulepropertiesformat): Properties of request routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationGatewayRequestRoutingRulePropertiesFormat +## DdosSettings ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **httpListener**: [SubResource](#subresource): Reference to another subresource. -* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **priority**: int: Priority of the request routing rule. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. -* **urlPathMap**: [SubResource](#subresource): Reference to another subresource. +* **ddosCustomPolicy**: [SubResource](#subresource): Reference to another subresource. +* **protectedIP**: bool: Enables DDoS protection on the public IP. +* **protectionCoverage**: 'Basic' | 'Standard' | string: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. -## ApplicationGatewayRewriteRuleSet +## Delegation ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the rewrite rule set that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRewriteRuleSetPropertiesFormat](#applicationgatewayrewriterulesetpropertiesformat): Properties of rewrite rule set of the application gateway. - -## ApplicationGatewayRewriteRuleSetPropertiesFormat -### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rewriteRules**: [ApplicationGatewayRewriteRule](#applicationgatewayrewriterule)[]: Rewrite rules in the rewrite rule set. +* **name**: string: The name of the resource that is unique within a subnet. This name can be used to access the resource. +* **properties**: [ServiceDelegationPropertiesFormat](#servicedelegationpropertiesformat): Properties of a service delegation. +* **type**: string: Resource type. -## ApplicationGatewayRewriteRule +## DeviceProperties ### Properties -* **actionSet**: [ApplicationGatewayRewriteRuleActionSet](#applicationgatewayrewriteruleactionset): Set of actions in the Rewrite Rule in Application Gateway. -* **conditions**: [ApplicationGatewayRewriteRuleCondition](#applicationgatewayrewriterulecondition)[]: Conditions based on which the action set execution will be evaluated. -* **name**: string: Name of the rewrite rule that is unique within an Application Gateway. -* **ruleSequence**: int: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. +* **deviceModel**: string: Model of the device. +* **deviceVendor**: string: Name of the device Vendor. +* **linkSpeedInMbps**: int: Link speed. -## ApplicationGatewayRewriteRuleActionSet +## DhcpOptions ### Properties -* **requestHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Request Header Actions in the Action Set. -* **responseHeaderConfigurations**: [ApplicationGatewayHeaderConfiguration](#applicationgatewayheaderconfiguration)[]: Response Header Actions in the Action Set. -* **urlConfiguration**: [ApplicationGatewayUrlConfiguration](#applicationgatewayurlconfiguration): Url configuration of the Actions set in Application Gateway. +* **dnsServers**: string[]: The list of DNS servers IP addresses. -## ApplicationGatewayHeaderConfiguration +## DnsSettings ### Properties -* **headerName**: string: Header name of the header configuration. -* **headerValue**: string: Header value of the header configuration. +* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. +* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. +* **servers**: string[]: List of Custom DNS Servers. -## ApplicationGatewayUrlConfiguration +## DscpConfigurationPropertiesFormat ### Properties -* **modifiedPath**: string: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. -* **modifiedQueryString**: string: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. -* **reroute**: bool: 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. +* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. +* **qosDefinitionCollection**: [QosDefinition](#qosdefinition)[]: QoS object definitions +* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. -## ApplicationGatewayRewriteRuleCondition +## ExclusionManagedRule ### Properties -* **ignoreCase**: bool: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. -* **negate**: bool: Setting this value as truth will force to check the negation of the condition given by the user. -* **pattern**: string: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. -* **variable**: string: The condition parameter of the RewriteRuleCondition. +* **ruleId**: string (Required): Identifier for the managed rule. -## ApplicationGatewayRoutingRule +## ExclusionManagedRuleGroup ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the routing rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayRoutingRulePropertiesFormat](#applicationgatewayroutingrulepropertiesformat): Properties of routing rule of the application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **ruleGroupName**: string (Required): The managed rule group for exclusion. +* **rules**: [ExclusionManagedRule](#exclusionmanagedrule)[]: List of rules that will be excluded. If none specified, all rules in the group will be excluded. -## ApplicationGatewayRoutingRulePropertiesFormat +## ExclusionManagedRuleSet ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendSettings**: [SubResource](#subresource): Reference to another subresource. -* **listener**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleType**: 'Basic' | 'PathBasedRouting' | string: Rule type. +* **ruleGroups**: [ExclusionManagedRuleGroup](#exclusionmanagedrulegroup)[]: Defines the rule groups to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## ApplicationGatewaySku +## ExplicitProxySettings ### Properties -* **capacity**: int: Capacity (instance count) of an application gateway. -* **name**: 'Standard_Large' | 'Standard_Medium' | 'Standard_Small' | 'Standard_v2' | 'WAF_Large' | 'WAF_Medium' | 'WAF_v2' | string: Name of an application gateway SKU. -* **tier**: 'Standard' | 'Standard_v2' | 'WAF' | 'WAF_v2' | string: Tier of an application gateway. +* **enableExplicitProxy**: bool: When set to true, explicit proxy mode is enabled. +* **httpPort**: int: Port number for explicit proxy http protocol, cannot be greater than 64000. +* **httpsPort**: int: Port number for explicit proxy https protocol, cannot be greater than 64000. +* **pacFile**: string: SAS URL for PAC file. +* **pacFilePort**: int: Port number for firewall to serve PAC file. -## ApplicationGatewaySslCertificate +## ExpressRouteCircuitAuthorization ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslCertificatePropertiesFormat](#applicationgatewaysslcertificatepropertiesformat): Properties of SSL certificates of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewaySslCertificatePropertiesFormat -### Properties -* **data**: string: Base-64 encoded pfx certificate. Only applicable in PUT Request. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **password**: string: Password for the pfx file specified in data. Only applicable in PUT request. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (ReadOnly): Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. - -## ApplicationGatewaySslPolicy -### Properties -* **cipherSuites**: 'TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_128_CBC_SHA256' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA' | 'TLS_DHE_DSS_WITH_AES_256_CBC_SHA256' | 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_DHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_DHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | string[]: Ssl cipher suites to be enabled in the specified order to application gateway. -* **disabledSslProtocols**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string[]: Ssl protocols to be disabled on application gateway. -* **minProtocolVersion**: 'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | string: Ssl protocol enums. -* **policyName**: 'AppGwSslPolicy20150501' | 'AppGwSslPolicy20170401' | 'AppGwSslPolicy20170401S' | string: Ssl predefined policy name enums. -* **policyType**: 'Custom' | 'Predefined' | string: Type of Ssl Policy. - -## ApplicationGatewaySslProfile +## ExpressRouteCircuitConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the SSL profile that is unique within an Application Gateway. -* **properties**: [ApplicationGatewaySslProfilePropertiesFormat](#applicationgatewaysslprofilepropertiesformat): Properties of SSL profile of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewaySslProfilePropertiesFormat +## ExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **clientAuthConfiguration**: [ApplicationGatewayClientAuthConfiguration](#applicationgatewayclientauthconfiguration): Application gateway client authentication configuration. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authorizationKey**: string: The authorization key. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sslPolicy**: [ApplicationGatewaySslPolicy](#applicationgatewaysslpolicy): Application Gateway Ssl policy. -* **trustedClientCertificates**: [SubResource](#subresource)[]: Array of references to application gateway trusted client certificates. - -## ApplicationGatewayClientAuthConfiguration -### Properties -* **verifyClientCertIssuerDN**: bool: Verify client certificate issuer name on the application gateway. -## ApplicationGatewayTrustedClientCertificate +## ExpressRouteCircuitPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the trusted client certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedClientCertificatePropertiesFormat](#applicationgatewaytrustedclientcertificatepropertiesformat): Trusted client certificates properties of an application gateway. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. * **type**: string (ReadOnly): Type of the resource. -## ApplicationGatewayTrustedClientCertificatePropertiesFormat +## ExpressRouteCircuitPeeringConfig ### Properties -* **clientCertIssuerDN**: string (ReadOnly): Distinguished name of client certificate issuer. -* **data**: string: Certificate public data. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **validatedCertData**: string (ReadOnly): Validated certificate data. +* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. +* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. +* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. +* **customerASN**: int: The CustomerASN of the peering. +* **legacyMode**: int: The legacy mode of the peering. +* **routingRegistryName**: string: The RoutingRegistryName of the configuration. -## ApplicationGatewayTrustedRootCertificate +## ExpressRouteCircuitPeeringId ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the trusted root certificate that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayTrustedRootCertificatePropertiesFormat](#applicationgatewaytrustedrootcertificatepropertiesformat): Trusted Root certificates properties of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: The ID of the ExpressRoute circuit peering. -## ApplicationGatewayTrustedRootCertificatePropertiesFormat +## ExpressRouteCircuitPeeringPropertiesFormat ### Properties -* **data**: string: Certificate public data. -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **azureASN**: int: The Azure ASN. +* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. +* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string: The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryAzurePort**: string: The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. +* **vlanId**: int: The VLAN ID. -## ApplicationGatewayUrlPathMap -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the URL path map that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayUrlPathMapPropertiesFormat](#applicationgatewayurlpathmappropertiesformat): Properties of UrlPathMap of the application gateway. -* **type**: string (ReadOnly): Type of the resource. - -## ApplicationGatewayUrlPathMapPropertiesFormat +## ExpressRouteCircuitPropertiesFormat ### Properties -* **defaultBackendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **defaultBackendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **defaultLoadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **defaultRedirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **defaultRewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. -* **pathRules**: [ApplicationGatewayPathRule](#applicationgatewaypathrule)[]: Path rule of URL path map resource. +* **allowClassicOperations**: bool: Allow classic operations. +* **authorizationKey**: string: The authorizationKey. +* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. +* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. +* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. +* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **globalReachEnabled**: bool: Flag denoting global reach status. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceKey**: string: The ServiceKey. +* **serviceProviderNotes**: string: The ServiceProviderNotes. +* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ApplicationGatewayPathRule +## ExpressRouteCircuitReference ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the path rule that is unique within an Application Gateway. -* **properties**: [ApplicationGatewayPathRulePropertiesFormat](#applicationgatewaypathrulepropertiesformat): Properties of path rule of an application gateway. -* **type**: string (ReadOnly): Type of the resource. +* **id**: string: Corresponding Express Route Circuit Id. -## ApplicationGatewayPathRulePropertiesFormat +## ExpressRouteCircuitServiceProviderProperties ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendHttpSettings**: [SubResource](#subresource): Reference to another subresource. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **loadDistributionPolicy**: [SubResource](#subresource): Reference to another subresource. -* **paths**: string[]: Path rules of URL path map. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **redirectConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **rewriteRuleSet**: [SubResource](#subresource): Reference to another subresource. +* **bandwidthInMbps**: int: The BandwidthInMbps. +* **peeringLocation**: string: The peering location. +* **serviceProviderName**: string: The serviceProviderName. -## ApplicationGatewayWebApplicationFirewallConfiguration +## ExpressRouteCircuitSku ### Properties -* **disabledRuleGroups**: [ApplicationGatewayFirewallDisabledRuleGroup](#applicationgatewayfirewalldisabledrulegroup)[]: The disabled rule groups. -* **enabled**: bool (Required): Whether the web application firewall is enabled or not. -* **exclusions**: [ApplicationGatewayFirewallExclusion](#applicationgatewayfirewallexclusion)[]: The exclusion list. -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **firewallMode**: 'Detection' | 'Prevention' | string (Required): Web application firewall mode. -* **maxRequestBodySize**: int: Maximum request body size for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **requestBodyCheck**: bool: Whether allow WAF to check request Body. -* **ruleSetType**: string (Required): The type of the web application firewall rule set. Possible values are: 'OWASP'. -* **ruleSetVersion**: string (Required): The version of the rule set type. +* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. +* **name**: string: The name of the SKU. +* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. -## ApplicationGatewayFirewallDisabledRuleGroup +## ExpressRouteCircuitStats ### Properties -* **ruleGroupName**: string (Required): The name of the rule group that will be disabled. -* **rules**: int[]: The list of rules that will be disabled. If null, all rules of the rule group will be disabled. +* **primarybytesIn**: int: The Primary BytesIn of the peering. +* **primarybytesOut**: int: The primary BytesOut of the peering. +* **secondarybytesIn**: int: The secondary BytesIn of the peering. +* **secondarybytesOut**: int: The secondary BytesOut of the peering. -## ApplicationGatewayFirewallExclusion +## ExpressRouteConnection ### Properties -* **matchVariable**: string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **id**: string: Resource ID. +* **name**: string (Required): The name of the resource. +* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. -## ResourceTags +## ExpressRouteConnectionId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. -## WebApplicationFirewallPolicyPropertiesFormat +## ExpressRouteConnectionProperties ### Properties -* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. -* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. -* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. -* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. -* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. -* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **authorizationKey**: string: Authorization key to establish the connection. +* **enableInternetSecurity**: bool: Enable internet security. +* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. +* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **routingWeight**: int: The routing weight associated to the connection. -## ApplicationGateway +## ExpressRouteCrossConnectionPeering ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Identity for the resource. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [ApplicationGatewayPropertiesFormat](#applicationgatewaypropertiesformat): Properties of the application gateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. -* **zones**: string[]: A list of availability zones denoting where the resource needs to come from. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. -## ResourceTags +## ExpressRouteCrossConnectionPeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureASN**: int (ReadOnly): The Azure ASN. +* **gatewayManagerEtag**: string: The GatewayManager Etag. +* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. +* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **peerASN**: int: The peer ASN. +* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. +* **primaryAzurePort**: string (ReadOnly): The primary port. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The secondary port. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **sharedKey**: string: The shared key. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **vlanId**: int: The VLAN ID. -## WebApplicationFirewallCustomRule +## ExpressRouteCrossConnectionProperties ### Properties -* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. -* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. -* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. -* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. +* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. +* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. +* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. +* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. +* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. +* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. +* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. +* **sTag**: int (ReadOnly): The identifier of the circuit traffic. -## MatchCondition +## ExpressRouteGatewayProperties ### Properties -* **matchValues**: string[] (Required): Match value. -* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. -* **negationConditon**: bool: Whether this is negate condition or not. -* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. -* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. +* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. +* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[]: List of ExpressRoute connections to the ExpressRoute gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. -## MatchVariable +## ExpressRouteGatewayPropertiesAutoScaleConfiguration ### Properties -* **selector**: string: The selector of match variable. -* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. +* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. -## ManagedRulesDefinition +## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds ### Properties -* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. -* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. +* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. +* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. -## OwaspCrsExclusionEntry +## ExpressRouteLink ### Properties -* **exclusionManagedRuleSets**: [ExclusionManagedRuleSet](#exclusionmanagedruleset)[]: The managed rule sets that are associated with the exclusion. -* **matchVariable**: 'RequestArgKeys' | 'RequestArgNames' | 'RequestArgValues' | 'RequestCookieKeys' | 'RequestCookieNames' | 'RequestCookieValues' | 'RequestHeaderKeys' | 'RequestHeaderNames' | 'RequestHeaderValues' | string (Required): The variable to be excluded. -* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. -* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of child port resource that is unique among child port resources of the parent. +* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. -## ExclusionManagedRuleSet +## ExpressRouteLinkMacSecConfig ### Properties -* **ruleGroups**: [ExclusionManagedRuleGroup](#exclusionmanagedrulegroup)[]: Defines the rule groups to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. +* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. +* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. +* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. -## ExclusionManagedRuleGroup +## ExpressRouteLinkPropertiesFormat ### Properties -* **ruleGroupName**: string (Required): The managed rule group for exclusion. -* **rules**: [ExclusionManagedRule](#exclusionmanagedrule)[]: List of rules that will be excluded. If none specified, all rules in the group will be excluded. +* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. +* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. +* **interfaceName**: string (ReadOnly): Name of Azure router interface. +* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. +* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. +* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. -## ExclusionManagedRule +## ExpressRoutePortAuthorizationPropertiesFormat ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. +* **authorizationKey**: string (ReadOnly): The authorization key. +* **authorizationUseStatus**: 'Available' | 'InUse' | string (ReadOnly): The authorization use status. +* **circuitResourceUri**: string (ReadOnly): The reference to the ExpressRoute circuit resource using the authorization. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ManagedRuleSet +## ExpressRoutePortPropertiesFormat ### Properties -* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. -* **ruleSetType**: string (Required): Defines the rule set type to use. -* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. +* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. +* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. +* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. +* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. +* **etherType**: string (ReadOnly): Ether type of the physical port. +* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. +* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). +* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. +* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. -## ManagedRuleGroupOverride +## ExtendedLocation ### Properties -* **ruleGroupName**: string (Required): The managed rule group to override. -* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. -## ManagedRuleOverride +## FilterItems ### Properties -* **ruleId**: string (Required): Identifier for the managed rule. -* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. +* **field**: string (WriteOnly): The name of the field we would like to filter +* **values**: string[] (WriteOnly): List of values to filter the current field by -## PolicySettings +## FirewallPolicyCertificateAuthority ### Properties -* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. -* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. -* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. -* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. -* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. +* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. +* **name**: string: Name of the CA certificate. -## ResourceTags +## FirewallPolicyFilterRuleCollectionAction ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'Allow' | 'Deny' | string: The action type of a rule. -## ResourceTags +## FirewallPolicyInsights ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. +* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. +* **retentionDays**: int: Number of days the insights should be enabled on the policy. -## AzureFirewallPropertiesFormat +## FirewallPolicyIntrusionDetection ### Properties -* **additionalProperties**: [AzureFirewallAdditionalProperties](#azurefirewalladditionalproperties): The additional properties of azure firewall. -* **applicationRuleCollections**: [AzureFirewallApplicationRuleCollection](#azurefirewallapplicationrulecollection)[]: Collection of application rule collections used by Azure Firewall. -* **firewallPolicy**: [SubResource](#subresource): Reference to another subresource. -* **hubIPAddresses**: [HubIPAddresses](#hubipaddresses): IP addresses associated with azure firewall. -* **ipConfigurations**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration)[]: IP configuration of the Azure Firewall resource. -* **ipGroups**: [AzureFirewallIpGroups](#azurefirewallipgroups)[] (ReadOnly): List of IpGroups associated with azure firewall. -* **managementIpConfiguration**: [AzureFirewallIPConfiguration](#azurefirewallipconfiguration): IP configuration of an Azure Firewall. -* **natRuleCollections**: [AzureFirewallNatRuleCollection](#azurefirewallnatrulecollection)[]: Collection of NAT rule collections used by Azure Firewall. -* **networkRuleCollections**: [AzureFirewallNetworkRuleCollection](#azurefirewallnetworkrulecollection)[]: Collection of network rule collections used by Azure Firewall. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sku**: [AzureFirewallSku](#azurefirewallsku): SKU of an Azure Firewall. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## AzureFirewallAdditionalProperties +## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: Description of the bypass traffic rule. +* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports or ranges. +* **name**: string: Name of the bypass traffic rule. +* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. +* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## AzureFirewallApplicationRuleCollection +## FirewallPolicyIntrusionDetectionConfiguration ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallApplicationRuleCollectionPropertiesFormat](#azurefirewallapplicationrulecollectionpropertiesformat): Properties of the application rule collection. +* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. +* **privateRanges**: string[]: IDPS Private IP address ranges are used to identify traffic direction (i.e. inbound, outbound, etc.). By default, only ranges defined by IANA RFC 1918 are considered private IP addresses. To modify default ranges, specify your Private IP address ranges with this property +* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. -## AzureFirewallApplicationRuleCollectionPropertiesFormat +## FirewallPolicyIntrusionDetectionSignatureSpecification ### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the application rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallApplicationRule](#azurefirewallapplicationrule)[]: Collection of rules used by a application rule collection. +* **id**: string: Signature id. +* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. -## AzureFirewallRCAction +## FirewallPolicyLogAnalyticsResources ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule collection. +* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. +* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. -## AzureFirewallApplicationRule +## FirewallPolicyLogAnalyticsWorkspace +### Properties +* **region**: string: Region to configure the Workspace. +* **workspaceId**: [SubResource](#subresource): Reference to another subresource. + +## FirewallPolicyNatRuleCollectionAction +### Properties +* **type**: 'DNAT' | string: The action type of a rule. + +## FirewallPolicyPropertiesFormat ### Properties +* **basePolicy**: [SubResource](#subresource): Reference to another subresource. +* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. +* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. +* **explicitProxySettings**: [ExplicitProxySettings](#explicitproxysettings): Explicit Proxy Settings in Firewall Policy. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. +* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. +* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. +* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. +* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. +* **sql**: [FirewallPolicySQL](#firewallpolicysql): SQL Settings in Firewall Policy. +* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. +* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. +* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. + +## FirewallPolicyRule +* **Discriminator**: ruleType + +### Base Properties * **description**: string: Description of the rule. +* **name**: string: Name of the rule. +### ApplicationRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. * **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **name**: string: Name of the application rule. -* **protocols**: [AzureFirewallApplicationRuleProtocol](#azurefirewallapplicationruleprotocol)[]: Array of ApplicationRuleProtocols. +* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. +* **ruleType**: 'ApplicationRule' (Required): Rule Type. * **sourceAddresses**: string[]: List of source IP addresses for this rule. * **sourceIpGroups**: string[]: List of source IpGroups for this rule. * **targetFqdns**: string[]: List of FQDNs for this rule. +* **targetUrls**: string[]: List of Urls for this rule condition. +* **terminateTLS**: bool: Terminate TLS connections for this rule. +* **webCategories**: string[]: List of destination azure web categories. -## AzureFirewallApplicationRuleProtocol -### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. This field is optional. -* **protocolType**: 'Http' | 'Https' | 'Mssql' | string: The protocol type of a Application Rule resource. +### NatRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NatRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **translatedAddress**: string: The translated address for this NAT rule. +* **translatedFqdn**: string: The translated FQDN for this NAT rule. +* **translatedPort**: string: The translated port for this NAT rule. -## HubIPAddresses -### Properties -* **privateIPAddress**: string: Private IP Address associated with azure firewall. -* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. +### NetworkRule +#### Properties +* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. +* **destinationFqdns**: string[]: List of destination FQDNs. +* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. +* **destinationPorts**: string[]: List of destination ports. +* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. +* **ruleType**: 'NetworkRule' (Required): Rule Type. +* **sourceAddresses**: string[]: List of source IP addresses for this rule. +* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -## HubPublicIPAddresses -### Properties -* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. -* **count**: int: The number of Public IP addresses associated with azure firewall. -## AzureFirewallPublicIPAddress +## FirewallPolicyRuleApplicationProtocol ### Properties -* **address**: string: Public IP Address value. +* **port**: int: Port number for the protocol, cannot be greater than 64000. +* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. -## AzureFirewallIPConfiguration -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AzureFirewallIPConfigurationPropertiesFormat](#azurefirewallipconfigurationpropertiesformat): Properties of IP configuration of an Azure Firewall. -* **type**: string (ReadOnly): Type of the resource. +## FirewallPolicyRuleCollection +* **Discriminator**: ruleCollectionType -## AzureFirewallIPConfigurationPropertiesFormat +### Base Properties +* **name**: string: The name of the rule collection. +* **priority**: int: Priority of the Firewall Policy Rule Collection resource. +### FirewallPolicyFilterRuleCollection +#### Properties +* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + +### FirewallPolicyNatRuleCollection +#### Properties +* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. +* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. +* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. + + +## FirewallPolicyRuleCollectionGroupProperties ### Properties -* **privateIPAddress**: string (ReadOnly): The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. +* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. -## AzureFirewallIpGroups +## FirewallPolicySku ### Properties -* **changeNumber**: string (ReadOnly): The iteration number. -* **id**: string (ReadOnly): Resource ID. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of Firewall Policy. -## AzureFirewallNatRuleCollection +## FirewallPolicySnat ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNatRuleCollectionProperties](#azurefirewallnatrulecollectionproperties): Properties of the NAT rule collection. +* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. -## AzureFirewallNatRuleCollectionProperties +## FirewallPolicySQL ### Properties -* **action**: [AzureFirewallNatRCAction](#azurefirewallnatrcaction): AzureFirewall NAT Rule Collection Action. -* **priority**: int: Priority of the NAT rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNatRule](#azurefirewallnatrule)[]: Collection of rules used by a NAT rule collection. +* **allowSqlRedirect**: bool: A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. -## AzureFirewallNatRCAction +## FirewallPolicyThreatIntelWhitelist ### Properties -* **type**: 'Dnat' | 'Snat' | string: The action type of a NAT rule collection. +* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. +* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. -## AzureFirewallNatRule +## FirewallPolicyTransportSecurity ### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the NAT rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. -## AzureFirewallNetworkRuleCollection +## FlowLog ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. -* **properties**: [AzureFirewallNetworkRuleCollectionPropertiesFormat](#azurefirewallnetworkrulecollectionpropertiesformat): Properties of the network rule collection. - -## AzureFirewallNetworkRuleCollectionPropertiesFormat -### Properties -* **action**: [AzureFirewallRCAction](#azurefirewallrcaction): Properties of the AzureFirewallRCAction. -* **priority**: int: Priority of the network rule collection resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [AzureFirewallNetworkRule](#azurefirewallnetworkrule)[]: Collection of rules used by a network rule collection. - -## AzureFirewallNetworkRule -### Properties -* **description**: string: Description of the rule. -* **destinationAddresses**: string[]: List of destination IP addresses. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **name**: string: Name of the network rule. -* **protocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of AzureFirewallNetworkRuleProtocols. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. - -## AzureFirewallSku -### Properties -* **name**: 'AZFW_Hub' | 'AZFW_VNet' | string: Name of an Azure Firewall SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of an Azure Firewall. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [FlowLogPropertiesFormat](#flowlogpropertiesformat): Parameters that define the configuration of flow log. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## FlowLogFormatParameters ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **type**: 'JSON' | string: The file type of flow log. +* **version**: int: The version (revision) of the flow log. -## BastionHostPropertiesFormat +## FlowLogPropertiesFormat ### Properties -* **disableCopyPaste**: bool: Enable/Disable Copy/Paste feature of the Bastion Host resource. -* **dnsName**: string: FQDN for the endpoint on which bastion host is accessible. -* **enableFileCopy**: bool: Enable/Disable File Copy feature of the Bastion Host resource. -* **enableIpConnect**: bool: Enable/Disable IP Connect feature of the Bastion Host resource. -* **enableShareableLink**: bool: Enable/Disable Shareable Link of the Bastion Host resource. -* **enableTunneling**: bool: Enable/Disable Tunneling feature of the Bastion Host resource. -* **ipConfigurations**: [BastionHostIPConfiguration](#bastionhostipconfiguration)[]: IP configuration of the Bastion Host resource. +* **enabled**: bool: Flag to enable/disable flow logging. +* **flowAnalyticsConfiguration**: [TrafficAnalyticsProperties](#trafficanalyticsproperties): Parameters that define the configuration of traffic analytics. +* **format**: [FlowLogFormatParameters](#flowlogformatparameters): Parameters that define the flow log format. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **scaleUnits**: int: The scale units for the Bastion Host resource. +* **retentionPolicy**: [RetentionPolicyParameters](#retentionpolicyparameters): Parameters that define the retention policy for flow log. +* **storageId**: string (Required): ID of the storage account which is used to store the flow log. +* **targetResourceGuid**: string (ReadOnly): Guid of network security group to which flow log will be applied. +* **targetResourceId**: string (Required): ID of network security group to which flow log will be applied. -## BastionHostIPConfiguration +## FrontendIPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [BastionHostIPConfigurationPropertiesFormat](#bastionhostipconfigurationpropertiesformat): Properties of IP configuration of an Bastion Host. -* **type**: string (ReadOnly): Ip configuration type. +* **name**: 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. +* **properties**: [FrontendIPConfigurationPropertiesFormat](#frontendipconfigurationpropertiesformat): Properties of Frontend IP Configuration of the load balancer. +* **type**: string (ReadOnly): Type of the resource. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -## BastionHostIPConfigurationPropertiesFormat +## FrontendIPConfigurationPropertiesFormat ### Properties +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **inboundNatPools**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound pools that use this frontend IP. +* **inboundNatRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to inbound rules that use this frontend IP. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to load balancing rules that use this frontend IP. +* **outboundRules**: [SubResource](#subresource)[] (ReadOnly): An array of references to outbound rules that use this frontend IP. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. * **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource) (Required): Reference to another subresource. -* **subnet**: [SubResource](#subresource) (Required): Reference to another subresource. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualNetworkGatewayConnectionPropertiesFormat -### Properties -* **authorizationKey**: string: The authorizationKey. -* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. -* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. -* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. -* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. -* **enableBgp**: bool: EnableBgp flag. -* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. -* **gatewayCustomBgpIpAddresses**: [GatewayCustomBgpIpAddressIpConfiguration](#gatewaycustombgpipaddressipconfiguration)[]: GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection. -* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. -* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. -* **peer**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. -* **routingWeight**: int: The routing weight. -* **sharedKey**: string: The IPSec shared key. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. -* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. -* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. ## GatewayCustomBgpIpAddressIpConfiguration ### Properties * **customBgpIpAddress**: string (Required): The custom BgpPeeringAddress which belongs to IpconfigurationId. * **ipConfigurationId**: string (Required): The IpconfigurationId of ipconfiguration which belongs to gateway. -## IpsecPolicy +## GatewayLoadBalancerTunnelInterface ### Properties -* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. -* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). -* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). -* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). -* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). -* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. -* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. -* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. +* **identifier**: int: Identifier of gateway load balancer tunnel interface. +* **port**: int: Port of gateway load balancer tunnel interface. +* **protocol**: 'Native' | 'None' | 'VXLAN' | string: Protocol of gateway load balancer tunnel interface. +* **type**: 'External' | 'Internal' | 'None' | string: Traffic type of gateway load balancer tunnel interface. -## LocalNetworkGateway +## HttpHeader ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: string: The name in HTTP header. +* **value**: string: The value in HTTP header. -## LocalNetworkGatewayPropertiesFormat +## HubIPAddresses ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **fqdn**: string: FQDN of local network gateway. -* **gatewayIpAddress**: string: IP address of local network gateway. -* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. +* **privateIPAddress**: string: Private IP Address associated with azure firewall. +* **publicIPs**: [HubPublicIPAddresses](#hubpublicipaddresses): Public IP addresses associated with azure firewall. -## BgpSettings +## HubIPConfigurationPropertiesFormat ### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -* **bgpPeeringAddresses**: [IPConfigurationBgpPeeringAddress](#ipconfigurationbgppeeringaddress)[]: BGP peering address with IP configuration ID for virtual network gateway. -* **peerWeight**: int: The weight added to routes learned from this BGP speaker. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## IPConfigurationBgpPeeringAddress +## HubPublicIPAddresses ### Properties -* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. -* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. -* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. -* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. +* **addresses**: [AzureFirewallPublicIPAddress](#azurefirewallpublicipaddress)[]: The list of Public IP addresses associated with azure firewall or IP addresses to be retained. +* **count**: int: The number of Public IP addresses associated with azure firewall. -## AddressSpace +## HubRoute ### Properties -* **addressPrefixes**: string[]: A list of address blocks reserved for this virtual network in CIDR notation. +* **destinations**: string[] (Required): List of all destinations. +* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). +* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. +* **nextHop**: string (Required): NextHop resource ID. +* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). -## ResourceTags +## HubRouteTableProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. +* **labels**: string[]: List of labels associated with this route table. +* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routes**: [HubRoute](#hubroute)[]: List of all routes. -## TrafficSelectorPolicy +## HubVirtualNetworkConnectionProperties ### Properties -* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. -* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. +* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. +* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. +* **enableInternetSecurity**: bool: Enable internet security. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -## TunnelConnectionHealth +## IdpsQueryObject ### Properties -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. -* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. -* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. -* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. -* **tunnel**: string (ReadOnly): Tunnel name. +* **filters**: [FilterItems](#filteritems)[] (WriteOnly): Describers the filters to filter response by +* **orderBy**: [OrderBy](#orderby) (WriteOnly): Describes a column to sort +* **resultsPerPage**: int (WriteOnly): The number of the results to return in each page +* **search**: string (WriteOnly): Search term in all columns +* **skip**: int (WriteOnly): The number of records matching the filter to skip -## VirtualNetworkGateway +## InboundNatPool ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **name**: 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. +* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayPropertiesFormat +## InboundNatPoolPropertiesFormat ### Properties -* **activeActive**: bool: ActiveActive flag. -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **disableIPSecReplayProtection**: bool: disableIPSecReplayProtection flag. -* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. -* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. -* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. -* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. -* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. -* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. -* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. -* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. -* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPortRangeEnd**: int (Required): 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. +* **frontendPortRangeStart**: int (Required): 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. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. -* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. -* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. -* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. -* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. -* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## VirtualNetworkGatewayIPConfiguration +## InboundNatRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. +* **name**: 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. +* **properties**: [InboundNatRulePropertiesFormat](#inboundnatrulepropertiesformat): Properties of the inbound NAT rule. +* **type**: string (ReadOnly): Type of the resource. -## VirtualNetworkGatewayIPConfigurationPropertiesFormat +## InboundNatRulePropertiesFormat ### Properties -* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. -* **subnet**: [SubResource](#subresource): Reference to another subresource. - -## VirtualNetworkGatewayNatRule -### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. -* **type**: string (ReadOnly): Resource type. - -## VirtualNetworkGatewayNatRuleProperties -### Properties -* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. -* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. -* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. -* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration) (ReadOnly): IPConfiguration in a network interface. +* **backendPort**: int: The port used for the internal endpoint. Acceptable values range from 1 to 65535. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int: 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. +* **frontendPortRangeEnd**: int: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. +* **frontendPortRangeStart**: int: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. +* **idleTimeoutInMinutes**: int: 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. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string: The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## VpnNatRuleMapping +## InboundSecurityRuleProperties ### Properties -* **addressSpace**: string: Address space for Vpn NatRule mapping. -* **portRange**: string: Port range for Vpn NatRule mapping. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. -## VirtualNetworkGatewaySku +## InboundSecurityRules ### Properties -* **capacity**: int (ReadOnly): The capacity. -* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. -* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. +* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. +* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. +* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. -## VpnClientConfiguration +## IpAllocationPropertiesFormat ### Properties -* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. -* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. -* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. -* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. -* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. -* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. -* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. -* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. +* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. +* **ipamAllocationId**: string: The IPAM allocation ID. +* **prefix**: string: The address prefix for the IpAllocation. +* **prefixLength**: int: The address prefix length for the IpAllocation. +* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. +* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. +* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -## RadiusServer +## IpAllocationPropertiesFormatAllocationTags ### Properties -* **radiusServerAddress**: string (Required): The address of this radius server. -* **radiusServerScore**: int: The initial score assigned to this radius server. -* **radiusServerSecret**: string: The secret used for this radius server. +### Additional Properties +* **Additional Properties Type**: string -## VpnClientRevokedCertificate +## IPConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. +* **properties**: [IPConfigurationPropertiesFormat](#ipconfigurationpropertiesformat): Properties of IP configuration. -## VpnClientRevokedCertificatePropertiesFormat +## IPConfigurationBgpPeeringAddress ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. +* **customBgpIpAddresses**: string[]: The list of custom BGP peering addresses which belong to IP configuration. +* **defaultBgpIpAddresses**: string[] (ReadOnly): The list of default BGP peering addresses which belong to IP configuration. +* **ipconfigurationId**: string: The ID of IP configuration which belongs to gateway. +* **tunnelIpAddresses**: string[] (ReadOnly): The list of tunnel public IP addresses which belong to IP configuration. -## VpnClientRootCertificate +## IPConfigurationProfile ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. +* **name**: string: The name of the resource. This name can be used to access the resource. +* **properties**: [IPConfigurationProfilePropertiesFormat](#ipconfigurationprofilepropertiesformat): IP configuration profile properties. +* **type**: string (ReadOnly): Sub Resource type. -## VpnClientRootCertificatePropertiesFormat +## IPConfigurationProfilePropertiesFormat ### Properties * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicCertData**: string (Required): The certificate public data. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## CustomIpPrefixPropertiesFormat +## IPConfigurationPropertiesFormat ### Properties -* **authorizationMessage**: string: Authorization message for WAN validation. -* **childCustomIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all Children for IPv6 /48 CustomIpPrefix. -* **cidr**: string: The prefix range in CIDR notation. Should include the start address and the prefix length. -* **commissionedState**: 'Commissioned' | 'Commissioning' | 'Decommissioning' | 'Deprovisioning' | 'Provisioned' | 'Provisioning' | string: The commissioned state of the Custom IP Prefix. -* **customIpPrefixParent**: [SubResource](#subresource): Reference to another subresource. -* **failedReason**: string (ReadOnly): The reason why resource is in failed state. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIpPrefixes**: [SubResource](#subresource)[] (ReadOnly): The list of all referenced PublicIpPrefixes. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the custom IP prefix resource. -* **signedMessage**: string: Signed message for WAN validation. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## DdosCustomPolicyPropertiesFormat +## IpGroupPropertiesFormat ### Properties -* **protocolCustomSettings**: [ProtocolCustomSettingsFormat](#protocolcustomsettingsformat)[]: The protocol-specific DDoS policy customization parameters. +* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. +* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. +* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [SubResource](#subresource)[] (ReadOnly): The list of public IPs associated with the DDoS custom policy resource. This list is read-only. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -## ProtocolCustomSettingsFormat +## IpsecPolicy ### Properties -* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. -* **sourceRateOverride**: string: The customized DDoS protection source rate. -* **triggerRateOverride**: string: The customized DDoS protection trigger rate. -* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. +* **dhGroup**: 'DHGroup1' | 'DHGroup14' | 'DHGroup2' | 'DHGroup2048' | 'DHGroup24' | 'ECP256' | 'ECP384' | 'None' | string (Required): The DH Groups used in IKE Phase 1 for initial SA. +* **ikeEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES256' | string (Required): The IKE encryption algorithm (IKE phase 2). +* **ikeIntegrity**: 'GCMAES128' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | 'SHA384' | string (Required): The IKE integrity algorithm (IKE phase 2). +* **ipsecEncryption**: 'AES128' | 'AES192' | 'AES256' | 'DES' | 'DES3' | 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'None' | string (Required): The IPSec encryption algorithm (IKE phase 1). +* **ipsecIntegrity**: 'GCMAES128' | 'GCMAES192' | 'GCMAES256' | 'MD5' | 'SHA1' | 'SHA256' | string (Required): The IPSec integrity algorithm (IKE phase 1). +* **pfsGroup**: 'ECP256' | 'ECP384' | 'None' | 'PFS1' | 'PFS14' | 'PFS2' | 'PFS2048' | 'PFS24' | 'PFSMM' | string (Required): The Pfs Groups used in IKE Phase 2 for new child SA. +* **saDataSizeKilobytes**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. +* **saLifeTimeSeconds**: int (Required): The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. -## ResourceTags +## IpTag ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ipTagType**: string: The IP tag type. Example: FirstPartyUsage. +* **tag**: string: The value of the IP tag associated with the public IP. Example: SQL. -## DdosProtectionPlanPropertiesFormat +## Ipv6CircuitConnectionConfig ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. -* **virtualNetworks**: [SubResource](#subresource)[] (ReadOnly): The list of virtual networks associated with the DDoS protection plan resource. This list is read-only. +* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -## DdosProtectionPlanTags +## Ipv6ExpressRouteCircuitPeeringConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. +* **primaryPeerAddressPrefix**: string: The primary address prefix. +* **routeFilter**: [SubResource](#subresource): Reference to another subresource. +* **secondaryPeerAddressPrefix**: string: The secondary address prefix. +* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -## DscpConfigurationPropertiesFormat +## LoadBalancerBackendAddress ### Properties -* **associatedNetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): Associated Network Interfaces to the DSCP Configuration. -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **qosCollectionId**: string (ReadOnly): Qos Collection ID generated by RNM. -* **qosDefinitionCollection**: [QosDefinition](#qosdefinition)[]: QoS object definitions -* **resourceGuid**: string (ReadOnly): The resource GUID property of the DSCP Configuration resource. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **name**: string: Name of the backend address. +* **properties**: [LoadBalancerBackendAddressPropertiesFormat](#loadbalancerbackendaddresspropertiesformat): Properties of the load balancer backend addresses. -## QosIpRange +## LoadBalancerBackendAddressPropertiesFormat ### Properties -* **endIP**: string: End IP Address. -* **startIP**: string: Start IP Address. +* **adminState**: 'Down' | 'Drain' | 'None' | 'Up' | string: A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. +* **inboundNatRulesPortMapping**: [NatRulePortMapping](#natruleportmapping)[] (ReadOnly): Collection of inbound NAT rule port mappings. +* **ipAddress**: string: IP Address belonging to the referenced virtual network. +* **loadBalancerFrontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **networkInterfaceIPConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. +* **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. -## QosPortRange +## LoadBalancerPropertiesFormat ### Properties -* **end**: int: Qos Port Range end. -* **start**: int: Qos Port Range start. +* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. +* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. +* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. +* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. +* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. +* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. -## QosDefinition +## LoadBalancerSku ### Properties -* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. -* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. -* **markings**: int[]: List of markings to be used in the configuration. -* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. -* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. -* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. +* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. -## ResourceTags +## LoadBalancingRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## ExpressRouteCircuitPropertiesFormat +## LoadBalancingRulePropertiesFormat ### Properties -* **allowClassicOperations**: bool: Allow classic operations. -* **authorizationKey**: string: The authorizationKey. -* **authorizations**: [ExpressRouteCircuitAuthorization](#expressroutecircuitauthorization)[]: The list of authorizations. -* **bandwidthInGbps**: int: The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource. -* **circuitProvisioningState**: string: The CircuitProvisioningState state of the resource. -* **expressRoutePort**: [SubResource](#subresource): Reference to another subresource. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **globalReachEnabled**: bool: Flag denoting global reach status. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[]: The list of peerings. +* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. +* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. +* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". +* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. +* **enableFloatingIP**: bool: 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. +* **enableTcpReset**: bool: 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. +* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. +* **frontendPort**: int (Required): 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". +* **idleTimeoutInMinutes**: int: 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. +* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. +* **probe**: [SubResource](#subresource): Reference to another subresource. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **serviceKey**: string: The ServiceKey. -* **serviceProviderNotes**: string: The ServiceProviderNotes. -* **serviceProviderProperties**: [ExpressRouteCircuitServiceProviderProperties](#expressroutecircuitserviceproviderproperties): Contains ServiceProviderProperties in an ExpressRouteCircuit. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **stag**: int (ReadOnly): The identifier of the circuit traffic. Outer tag for QinQ encapsulation. -## ExpressRouteCircuitAuthorization +## LocalNetworkGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [AuthorizationPropertiesFormat](#authorizationpropertiesformat): Properties of ExpressRouteCircuitAuthorization. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [LocalNetworkGatewayPropertiesFormat](#localnetworkgatewaypropertiesformat) (Required): LocalNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## AuthorizationPropertiesFormat +## LocalNetworkGatewayPropertiesFormat ### Properties -* **authorizationKey**: string: The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string: The authorization use status. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **fqdn**: string: FQDN of local network gateway. +* **gatewayIpAddress**: string: IP address of local network gateway. +* **localNetworkAddressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the local network gateway resource. -## ExpressRouteCircuitPeering +## ManagedRuleGroupOverride ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitPeeringPropertiesFormat](#expressroutecircuitpeeringpropertiesformat): Properties of the express route circuit peering. -* **type**: string (ReadOnly): Type of the resource. +* **ruleGroupName**: string (Required): The managed rule group to override. +* **rules**: [ManagedRuleOverride](#managedruleoverride)[]: List of rules that will be disabled. If none specified, all rules in the group will be disabled. -## ExpressRouteCircuitPeeringPropertiesFormat +## ManagedRuleOverride ### Properties -* **azureASN**: int: The Azure ASN. -* **connections**: [ExpressRouteCircuitConnection](#expressroutecircuitconnection)[]: The list of circuit connections associated with Azure Private Peering for this circuit. -* **expressRouteConnection**: [ExpressRouteConnectionId](#expressrouteconnectionid): The ID of the ExpressRouteConnection. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeredConnections**: [PeerExpressRouteCircuitConnection](#peerexpressroutecircuitconnection)[] (ReadOnly): The list of peered circuit connections associated with Azure Private Peering for this circuit. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string: The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryAzurePort**: string: The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **stats**: [ExpressRouteCircuitStats](#expressroutecircuitstats): Contains stats associated with the peering. -* **vlanId**: int: The VLAN ID. +* **ruleId**: string (Required): Identifier for the managed rule. +* **state**: 'Disabled' | string: The state of the managed rule. Defaults to Disabled if not specified. -## ExpressRouteCircuitConnection +## ManagedRulesDefinition ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCircuitConnectionPropertiesFormat](#expressroutecircuitconnectionpropertiesformat): Properties of the express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **exclusions**: [OwaspCrsExclusionEntry](#owaspcrsexclusionentry)[]: The Exclusions that are applied on the policy. +* **managedRuleSets**: [ManagedRuleSet](#managedruleset)[] (Required): The managed rule sets that are associated with the policy. -## ExpressRouteCircuitConnectionPropertiesFormat +## ManagedRuleSet ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authorizationKey**: string: The authorization key. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **ipv6CircuitConnectionConfig**: [Ipv6CircuitConnectionConfig](#ipv6circuitconnectionconfig): IPv6 Circuit Connection properties for global reach. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **ruleGroupOverrides**: [ManagedRuleGroupOverride](#managedrulegroupoverride)[]: Defines the rule group overrides to apply to the rule set. +* **ruleSetType**: string (Required): Defines the rule set type to use. +* **ruleSetVersion**: string (Required): Defines the version of the rule set to use. -## Ipv6CircuitConnectionConfig +## ManagedServiceIdentity ### Properties -* **addressPrefix**: string: /125 IP address space to carve out customer addresses for global reach. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **principalId**: string (ReadOnly): The principal id of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': 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. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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}'. -## ExpressRouteConnectionId +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **id**: string (ReadOnly): The ID of the ExpressRouteConnection. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## Ipv6ExpressRouteCircuitPeeringConfig +## MatchCondition ### Properties -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **primaryPeerAddressPrefix**: string: The primary address prefix. -* **routeFilter**: [SubResource](#subresource): Reference to another subresource. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. +* **matchValues**: string[] (Required): Match value. +* **matchVariables**: [MatchVariable](#matchvariable)[] (Required): List of match variables. +* **negationConditon**: bool: Whether this is negate condition or not. +* **operator**: 'BeginsWith' | 'Contains' | 'EndsWith' | 'Equal' | 'GeoMatch' | 'GreaterThan' | 'GreaterThanOrEqual' | 'IPMatch' | 'LessThan' | 'LessThanOrEqual' | 'Regex' | string (Required): The operator to be matched. +* **transforms**: 'HtmlEntityDecode' | 'Lowercase' | 'RemoveNulls' | 'Trim' | 'UrlDecode' | 'UrlEncode' | string[]: List of transforms. -## ExpressRouteCircuitPeeringConfig +## MatchVariable ### Properties -* **advertisedCommunities**: string[]: The communities of bgp peering. Specified for microsoft peering. -* **advertisedPublicPrefixes**: string[]: The reference to AdvertisedPublicPrefixes. -* **advertisedPublicPrefixesState**: 'Configured' | 'Configuring' | 'NotConfigured' | 'ValidationNeeded' | string (ReadOnly): The advertised public prefix state of the Peering resource. -* **customerASN**: int: The CustomerASN of the peering. -* **legacyMode**: int: The legacy mode of the peering. -* **routingRegistryName**: string: The RoutingRegistryName of the configuration. +* **selector**: string: The selector of match variable. +* **variableName**: 'PostArgs' | 'QueryString' | 'RemoteAddr' | 'RequestBody' | 'RequestCookies' | 'RequestHeaders' | 'RequestMethod' | 'RequestUri' | string (Required): Match Variable. -## PeerExpressRouteCircuitConnection +## NatGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. -* **type**: string (ReadOnly): Type of the resource. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NatGatewayPropertiesFormat](#natgatewaypropertiesformat): Nat Gateway properties. +* **sku**: [NatGatewaySku](#natgatewaysku): SKU of nat gateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the zone in which Nat Gateway should be deployed. -## PeerExpressRouteCircuitConnectionPropertiesFormat +## NatGatewayPropertiesFormat ### Properties -* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. -* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. -* **connectionName**: string: The name of the express route circuit connection resource. -* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. -* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **idleTimeoutInMinutes**: int: The idle timeout of the nat gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIpAddresses**: [SubResource](#subresource)[]: An array of public ip addresses associated with the nat gateway resource. +* **publicIpPrefixes**: [SubResource](#subresource)[]: An array of public ip prefixes associated with the nat gateway resource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the NAT gateway resource. +* **subnets**: [SubResource](#subresource)[] (ReadOnly): An array of references to the subnets using this nat gateway resource. -## ExpressRouteCircuitStats +## NatGatewaySku ### Properties -* **primarybytesIn**: int: The Primary BytesIn of the peering. -* **primarybytesOut**: int: The primary BytesOut of the peering. -* **secondarybytesIn**: int: The secondary BytesIn of the peering. -* **secondarybytesOut**: int: The secondary BytesOut of the peering. +* **name**: 'Standard' | string: Name of Nat Gateway SKU. -## ExpressRouteCircuitServiceProviderProperties +## NatRulePortMapping ### Properties -* **bandwidthInMbps**: int: The BandwidthInMbps. -* **peeringLocation**: string: The peering location. -* **serviceProviderName**: string: The serviceProviderName. +* **backendPort**: int: Backend port. +* **frontendPort**: int: Frontend port. +* **inboundNatRuleName**: string: Name of inbound NAT rule. -## ExpressRouteCircuitSku +## NetworkInterface ### Properties -* **family**: 'MeteredData' | 'UnlimitedData' | string: The family of the SKU. -* **name**: string: The name of the SKU. -* **tier**: 'Basic' | 'Local' | 'Premium' | 'Standard' | string: The tier of the SKU. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkInterfacePropertiesFormat](#networkinterfacepropertiesformat): NetworkInterface properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## NetworkInterfaceDnsSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appliedDnsServers**: string[] (ReadOnly): 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. +* **dnsServers**: string[]: 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. +* **internalDnsNameLabel**: string: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. +* **internalDomainNameSuffix**: string (ReadOnly): 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. +* **internalFqdn**: string (ReadOnly): Fully qualified DNS name supporting internal communications between VMs in the same virtual network. -## ExpressRouteCrossConnectionProperties +## NetworkInterfaceIPConfiguration ### Properties -* **bandwidthInMbps**: int (ReadOnly): The circuit bandwidth In Mbps. -* **expressRouteCircuit**: [ExpressRouteCircuitReference](#expressroutecircuitreference): Reference to an express route circuit. -* **peeringLocation**: string (ReadOnly): The peering location of the ExpressRoute circuit. -* **peerings**: [ExpressRouteCrossConnectionPeering](#expressroutecrossconnectionpeering)[]: The list of peerings. -* **primaryAzurePort**: string (ReadOnly): The name of the primary port. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [NetworkInterfaceIPConfigurationPropertiesFormat](#networkinterfaceipconfigurationpropertiesformat): Properties of IP configuration. +* **type**: string: Resource type. + +## NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties +### Properties +* **fqdns**: string[] (ReadOnly): List of FQDNs for current private link connection. +* **groupId**: string (ReadOnly): The group ID for current private link connection. +* **requiredMemberName**: string (ReadOnly): The required member name for current private link connection. + +## NetworkInterfaceIPConfigurationPropertiesFormat +### Properties +* **applicationGatewayBackendAddressPools**: [ApplicationGatewayBackendAddressPool](#applicationgatewaybackendaddresspool)[]: The reference to ApplicationGatewayBackendAddressPool resource. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the IP configuration is included. +* **gatewayLoadBalancer**: [SubResource](#subresource): Reference to another subresource. +* **loadBalancerBackendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: The reference to LoadBalancerBackendAddressPool resource. +* **loadBalancerInboundNatRules**: [InboundNatRule](#inboundnatrule)[]: A list of references of LoadBalancerInboundNatRules. +* **primary**: bool: Whether this is a primary customer address on the network interface. +* **privateIPAddress**: string: Private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **privateLinkConnectionProperties**: [NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties](#networkinterfaceipconfigurationprivatelinkconnectionproperties) (ReadOnly): PrivateLinkConnection properties for the network interface. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The name of the secondary port. -* **serviceProviderNotes**: string: Additional read only notes set by the connectivity provider. -* **serviceProviderProvisioningState**: 'Deprovisioning' | 'NotProvisioned' | 'Provisioned' | 'Provisioning' | string: The ServiceProviderProvisioningState state of the resource. -* **sTag**: int (ReadOnly): The identifier of the circuit traffic. +* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **virtualNetworkTaps**: [VirtualNetworkTap](#virtualnetworktap)[]: The reference to Virtual Network Taps. -## ExpressRouteCircuitReference +## NetworkInterfacePropertiesFormat ### Properties -* **id**: string: Corresponding Express Route Circuit Id. +* **auxiliaryMode**: 'Floating' | 'MaxConnections' | 'None' | string: Auxiliary mode of Network Interface resource. +* **dnsSettings**: [NetworkInterfaceDnsSettings](#networkinterfacednssettings): DNS settings of a network interface. +* **dscpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **enableAcceleratedNetworking**: bool: If the network interface is accelerated networking enabled. +* **enableIPForwarding**: bool: Indicates whether IP forwarding is enabled on this network interface. +* **hostedWorkloads**: string[] (ReadOnly): A list of references to linked BareMetal resources. +* **ipConfigurations**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration)[]: A list of IPConfigurations of the network interface. +* **macAddress**: string (ReadOnly): The MAC address of the network interface. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Network Interface resource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **nicType**: 'Elastic' | 'Standard' | string: Type of Network Interface resource. +* **primary**: bool (ReadOnly): Whether this is a primary network interface on a virtual machine. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkService**: [PrivateLinkService](#privatelinkservice): Private link service resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network interface resource. +* **tapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): A list of TapConfigurations of the network interface. +* **virtualMachine**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **vnetEncryptionSupported**: bool (ReadOnly): Whether the virtual machine this nic is attached to supports encryption. +* **workloadType**: string: WorkloadType of the NetworkInterface for BareMetal resources -## ExpressRouteCrossConnectionPeering +## NetworkInterfaceTapConfiguration ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [ExpressRouteCrossConnectionPeeringProperties](#expressroutecrossconnectionpeeringproperties): Properties of express route cross connection peering. +* **properties**: [NetworkInterfaceTapConfigurationPropertiesFormat](#networkinterfacetapconfigurationpropertiesformat): Properties of Virtual Network Tap configuration. +* **type**: string (ReadOnly): Sub Resource type. -## ExpressRouteCrossConnectionPeeringProperties +## NetworkInterfaceTapConfigurationPropertiesFormat ### Properties -* **azureASN**: int (ReadOnly): The Azure ASN. -* **gatewayManagerEtag**: string: The GatewayManager Etag. -* **ipv6PeeringConfig**: [Ipv6ExpressRouteCircuitPeeringConfig](#ipv6expressroutecircuitpeeringconfig): Contains IPv6 peering config. -* **lastModifiedBy**: string (ReadOnly): Who was the last to modify the peering. -* **microsoftPeeringConfig**: [ExpressRouteCircuitPeeringConfig](#expressroutecircuitpeeringconfig): Specifies the peering configuration. -* **peerASN**: int: The peer ASN. -* **peeringType**: 'AzurePrivatePeering' | 'AzurePublicPeering' | 'MicrosoftPeering' | string: The peering type. -* **primaryAzurePort**: string (ReadOnly): The primary port. -* **primaryPeerAddressPrefix**: string: The primary address prefix. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **secondaryAzurePort**: string (ReadOnly): The secondary port. -* **secondaryPeerAddressPrefix**: string: The secondary address prefix. -* **sharedKey**: string: The shared key. -* **state**: 'Disabled' | 'Enabled' | string: The state of peering. -* **vlanId**: int: The VLAN ID. +* **virtualNetworkTap**: [VirtualNetworkTap](#virtualnetworktap): Virtual Network Tap resource. -## ResourceTags +## NetworkProfilePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExpressRouteGatewayProperties -### Properties -* **autoScaleConfiguration**: [ExpressRouteGatewayPropertiesAutoScaleConfiguration](#expressroutegatewaypropertiesautoscaleconfiguration): Configuration for auto scaling. -* **expressRouteConnections**: [ExpressRouteConnection](#expressrouteconnection)[]: List of ExpressRoute connections to the ExpressRoute gateway. +* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. +* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [VirtualHubId](#virtualhubid) (Required): Virtual Hub identifier. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. -## ExpressRouteGatewayPropertiesAutoScaleConfiguration +## NetworkSecurityGroup ### Properties -* **bounds**: [ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds](#expressroutegatewaypropertiesautoscaleconfigurationbounds): Minimum and maximum number of scale units to deploy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [NetworkSecurityGroupPropertiesFormat](#networksecuritygrouppropertiesformat): Network Security Group resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds +## NetworkSecurityGroupPropertiesFormat ### Properties -* **max**: int: Maximum number of scale units deployed for ExpressRoute gateway. -* **min**: int: Minimum number of scale units deployed for ExpressRoute gateway. +* **defaultSecurityRules**: [SecurityRule](#securityrule)[] (ReadOnly): The default security rules of network security group. +* **flowLogs**: [FlowLog](#flowlog)[] (ReadOnly): A collection of references to flow log resources. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): A collection of references to network interfaces. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the network security group resource. +* **securityRules**: [SecurityRule](#securityrule)[]: A collection of security rules of the network security group. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## ExpressRouteConnection +## NetworkVirtualAppliancePropertiesFormat ### Properties -* **id**: string: Resource ID. -* **name**: string (Required): The name of the resource. -* **properties**: [ExpressRouteConnectionProperties](#expressrouteconnectionproperties): Properties of the ExpressRouteConnection subresource. +* **addressPrefix**: string (ReadOnly): Address Prefix. +* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. +* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. +* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. +* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. +* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sshPublicKey**: string: Public key for SSH login. +* **virtualApplianceAsn**: int: VirtualAppliance ASN. +* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. +* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ExpressRouteConnectionProperties +## NetworkWatcherPropertiesFormat ### Properties -* **authorizationKey**: string: Authorization key to establish the connection. -* **enableInternetSecurity**: bool: Enable internet security. -* **expressRouteCircuitPeering**: [ExpressRouteCircuitPeeringId](#expressroutecircuitpeeringid) (Required): ExpressRoute circuit peering identifier. -* **expressRouteGatewayBypass**: bool: Enable FastPath to vWan Firewall hub. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: The routing weight associated to the connection. -## ExpressRouteCircuitPeeringId +## O365BreakOutCategoryPolicies ### Properties -* **id**: string: The ID of the ExpressRoute circuit peering. +* **allow**: bool: Flag to control allow category. +* **default**: bool: Flag to control default category. +* **optimize**: bool: Flag to control optimize category. -## RoutingConfiguration +## O365PolicyProperties ### Properties -* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. -* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. -* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. +* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. -## PropagatedRouteTable +## Office365PolicyProperties ### Properties -* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. -* **labels**: string[]: The list of labels. +* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. -## VnetRoute +## OrderBy ### Properties -* **bgpConnections**: [SubResource](#subresource)[] (ReadOnly): The list of references to HubBgpConnection objects. -* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. +* **field**: string (WriteOnly): Describes the actual column name to sort by +* **order**: 'Ascending' | 'Descending' | string (WriteOnly): Describes if results should be in ascending/descending order -## StaticRoute +## OutboundRule ### Properties -* **addressPrefixes**: string[]: List of all address prefixes. -* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. -* **nextHopIpAddress**: string: The ip address of the next hop. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. +* **type**: string (ReadOnly): Type of the resource. -## VirtualHubId +## OutboundRulePropertiesFormat ### Properties -* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. +* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. +* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. +* **enableTcpReset**: bool: 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. +* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. +* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. +* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## OwaspCrsExclusionEntry ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **exclusionManagedRuleSets**: [ExclusionManagedRuleSet](#exclusionmanagedruleset)[]: The managed rule sets that are associated with the exclusion. +* **matchVariable**: 'RequestArgKeys' | 'RequestArgNames' | 'RequestArgValues' | 'RequestCookieKeys' | 'RequestCookieNames' | 'RequestCookieValues' | 'RequestHeaderKeys' | 'RequestHeaderNames' | 'RequestHeaderValues' | string (Required): The variable to be excluded. +* **selector**: string (Required): When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. +* **selectorMatchOperator**: 'Contains' | 'EndsWith' | 'Equals' | 'EqualsAny' | 'StartsWith' | string (Required): When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. -## ExpressRoutePortPropertiesFormat +## P2SConnectionConfiguration ### Properties -* **allocationDate**: string (ReadOnly): Date of the physical port allocation to be used in Letter of Authorization. -* **bandwidthInGbps**: int: Bandwidth of procured ports in Gbps. -* **circuits**: [SubResource](#subresource)[] (ReadOnly): Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource. -* **encapsulation**: 'Dot1Q' | 'QinQ' | string: Encapsulation method on physical ports. -* **etherType**: string (ReadOnly): Ether type of the physical port. -* **links**: [ExpressRouteLink](#expressroutelink)[]: The set of physical links of the ExpressRoutePort resource. -* **mtu**: string (ReadOnly): Maximum transmission unit of the physical port pair(s). -* **peeringLocation**: string: The name of the peering location that the ExpressRoutePort is mapped to physically. -* **provisionedBandwidthInGbps**: int (ReadOnly): Aggregate Gbps of associated circuit bandwidths. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. + +## P2SConnectionConfigurationProperties +### Properties +* **configurationPolicyGroupAssociations**: [SubResource](#subresource)[] (ReadOnly): List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. +* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. +* **previousConfigurationPolicyGroupAssociations**: [VpnServerConfigurationPolicyGroup](#vpnserverconfigurationpolicygroup)[] (ReadOnly): List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the express route port resource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -## ExpressRouteLink +## P2SVpnGateway ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: Name of child port resource that is unique among child port resources of the parent. -* **properties**: [ExpressRouteLinkPropertiesFormat](#expressroutelinkpropertiesformat): Properties specific to ExpressRouteLink resources. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ExpressRouteLinkPropertiesFormat +## P2SVpnGatewayProperties ### Properties -* **adminState**: 'Disabled' | 'Enabled' | string: Administrative state of the physical port. -* **connectorType**: 'LC' | 'SC' | string (ReadOnly): Physical fiber port type. -* **interfaceName**: string (ReadOnly): Name of Azure router interface. -* **macSecConfig**: [ExpressRouteLinkMacSecConfig](#expressroutelinkmacsecconfig): ExpressRouteLink Mac Security Configuration. -* **patchPanelId**: string (ReadOnly): Mapping between physical port to patch panel port. +* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. +* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rackId**: string (ReadOnly): Mapping of physical patch panel to rack. -* **routerName**: string (ReadOnly): Name of Azure router associated with physical port. - -## ExpressRouteLinkMacSecConfig -### Properties -* **cakSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CAK key. -* **cipher**: 'GcmAes128' | 'GcmAes256' | 'GcmAesXpn128' | 'GcmAesXpn256' | string: Mac security cipher. -* **cknSecretIdentifier**: string: Keyvault Secret Identifier URL containing Mac security CKN key. -* **sciState**: 'Disabled' | 'Enabled' | string: Sci mode enabled/disabled. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. +* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. +* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## PacketCaptureFilter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **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. +* **localPort**: 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. +* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. +* **remoteIPAddress**: 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. +* **remotePort**: 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. -## ExpressRoutePortAuthorizationPropertiesFormat +## PacketCaptureParameters ### Properties -* **authorizationKey**: string (ReadOnly): The authorization key. -* **authorizationUseStatus**: 'Available' | 'InUse' | string (ReadOnly): The authorization use status. -* **circuitResourceUri**: string (ReadOnly): The reference to the ExpressRoute circuit resource using the authorization. +* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. +* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. +* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. +* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. +* **totalBytesPerSession**: int: Maximum size of the capture output. -## FirewallPolicyPropertiesFormat +## PacketCaptureStorageLocation ### Properties -* **basePolicy**: [SubResource](#subresource): Reference to another subresource. -* **childPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Child Firewall Policies. -* **dnsSettings**: [DnsSettings](#dnssettings): DNS Proxy Settings in Firewall Policy. -* **explicitProxySettings**: [ExplicitProxySettings](#explicitproxysettings): Explicit Proxy Settings in Firewall Policy. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Azure Firewalls that this Firewall Policy is associated with. -* **insights**: [FirewallPolicyInsights](#firewallpolicyinsights): Firewall Policy Insights. -* **intrusionDetection**: [FirewallPolicyIntrusionDetection](#firewallpolicyintrusiondetection): Configuration for intrusion detection mode and rules. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollectionGroups**: [SubResource](#subresource)[] (ReadOnly): List of references to FirewallPolicyRuleCollectionGroups. -* **sku**: [FirewallPolicySku](#firewallpolicysku): SKU of Firewall policy. -* **snat**: [FirewallPolicySnat](#firewallpolicysnat): The private IP addresses/IP ranges to which traffic will not be SNAT. -* **sql**: [FirewallPolicySQL](#firewallpolicysql): SQL Settings in Firewall Policy. -* **threatIntelMode**: 'Alert' | 'Deny' | 'Off' | string: The operation mode for Threat Intel. -* **threatIntelWhitelist**: [FirewallPolicyThreatIntelWhitelist](#firewallpolicythreatintelwhitelist): ThreatIntel Whitelist for Firewall Policy. -* **transportSecurity**: [FirewallPolicyTransportSecurity](#firewallpolicytransportsecurity): Configuration needed to perform TLS termination & initiation. +* **filePath**: 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. +* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. +* **storagePath**: 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. -## DnsSettings +## PeerExpressRouteCircuitConnection ### Properties -* **enableProxy**: bool: Enable DNS Proxy on Firewalls attached to the Firewall Policy. -* **requireProxyForNetworkRules**: bool: FQDNs in Network Rules are supported when set to true. -* **servers**: string[]: List of Custom DNS Servers. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PeerExpressRouteCircuitConnectionPropertiesFormat](#peerexpressroutecircuitconnectionpropertiesformat): Properties of the peer express route circuit connection. +* **type**: string (ReadOnly): Type of the resource. -## ExplicitProxySettings +## PeerExpressRouteCircuitConnectionPropertiesFormat ### Properties -* **enableExplicitProxy**: bool: When set to true, explicit proxy mode is enabled. -* **httpPort**: int: Port number for explicit proxy http protocol, cannot be greater than 64000. -* **httpsPort**: int: Port number for explicit proxy https protocol, cannot be greater than 64000. -* **pacFile**: string: SAS URL for PAC file. -* **pacFilePort**: int: Port number for firewall to serve PAC file. +* **addressPrefix**: string: /29 IP address space to carve out Customer addresses for tunnels. +* **authResourceGuid**: string: The resource guid of the authorization used for the express route circuit connection. +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): Express Route Circuit connection state. +* **connectionName**: string: The name of the express route circuit connection resource. +* **expressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **peerExpressRouteCircuitPeering**: [SubResource](#subresource): Reference to another subresource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## FirewallPolicyInsights +## PolicySettings ### Properties -* **isEnabled**: bool: A flag to indicate if the insights are enabled on the policy. -* **logAnalyticsResources**: [FirewallPolicyLogAnalyticsResources](#firewallpolicyloganalyticsresources): Log Analytics Resources for Firewall Policy Insights. -* **retentionDays**: int: Number of days the insights should be enabled on the policy. +* **fileUploadLimitInMb**: int: Maximum file upload size in Mb for WAF. +* **maxRequestBodySizeInKb**: int: Maximum request body size in Kb for WAF. +* **mode**: 'Detection' | 'Prevention' | string: The mode of the policy. +* **requestBodyCheck**: bool: Whether to allow WAF to check request Body. +* **state**: 'Disabled' | 'Enabled' | string: The state of the policy. -## FirewallPolicyLogAnalyticsResources +## PrivateDnsZoneConfig ### Properties -* **defaultWorkspaceId**: [SubResource](#subresource): Reference to another subresource. -* **workspaces**: [FirewallPolicyLogAnalyticsWorkspace](#firewallpolicyloganalyticsworkspace)[]: List of workspaces for Firewall Policy Insights. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. -## FirewallPolicyLogAnalyticsWorkspace +## PrivateDnsZoneGroupPropertiesFormat ### Properties -* **region**: string: Region to configure the Workspace. -* **workspaceId**: [SubResource](#subresource): Reference to another subresource. +* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## FirewallPolicyIntrusionDetection +## PrivateDnsZonePropertiesFormat ### Properties -* **configuration**: [FirewallPolicyIntrusionDetectionConfiguration](#firewallpolicyintrusiondetectionconfiguration): The operation for configuring intrusion detection. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **privateDnsZoneId**: string: The resource id of the private dns zone. +* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. -## FirewallPolicyIntrusionDetectionConfiguration +## PrivateEndpoint ### Properties -* **bypassTrafficSettings**: [FirewallPolicyIntrusionDetectionBypassTrafficSpecifications](#firewallpolicyintrusiondetectionbypasstrafficspecifications)[]: List of rules for traffic to bypass. -* **privateRanges**: string[]: IDPS Private IP address ranges are used to identify traffic direction (i.e. inbound, outbound, etc.). By default, only ranges defined by IANA RFC 1918 are considered private IP addresses. To modify default ranges, specify your Private IP address ranges with this property -* **signatureOverrides**: [FirewallPolicyIntrusionDetectionSignatureSpecification](#firewallpolicyintrusiondetectionsignaturespecification)[]: List of specific signatures states. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateEndpointProperties](#privateendpointproperties): Properties of the private endpoint. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## FirewallPolicyIntrusionDetectionBypassTrafficSpecifications +## PrivateEndpointConnection ### Properties -* **description**: string: Description of the bypass traffic rule. -* **destinationAddresses**: string[]: List of destination IP addresses or ranges for this rule. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports or ranges. -* **name**: string: Name of the bypass traffic rule. -* **protocol**: 'ANY' | 'ICMP' | 'TCP' | 'UDP' | string: Possible intrusion detection bypass traffic protocols. -* **sourceAddresses**: string[]: List of source IP addresses or ranges for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyIntrusionDetectionSignatureSpecification +## PrivateEndpointConnectionProperties ### Properties -* **id**: string: Signature id. -* **mode**: 'Alert' | 'Deny' | 'Off' | string: Possible state values. +* **linkIdentifier**: string (ReadOnly): The consumer link id. +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): Private endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## FirewallPolicySku +## PrivateEndpointIPConfiguration ### Properties -* **tier**: 'Basic' | 'Premium' | 'Standard' | string: Tier of Firewall Policy. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the resource that is unique within a resource group. +* **properties**: [PrivateEndpointIPConfigurationProperties](#privateendpointipconfigurationproperties): Properties of an IP Configuration of the private endpoint. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicySnat +## PrivateEndpointIPConfigurationProperties ### Properties -* **privateRanges**: string[]: List of private IP addresses/IP address ranges to not be SNAT. +* **groupId**: string: The ID of a group obtained from the remote resource that this private endpoint should connect to. +* **memberName**: string: The member name of a group obtained from the remote resource that this private endpoint should connect to. +* **privateIPAddress**: string: A private ip address obtained from the private endpoint's subnet. -## FirewallPolicySQL +## PrivateEndpointProperties ### Properties -* **allowSqlRedirect**: bool: A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. +* **applicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: Application security groups in which the private endpoint IP configuration is included. +* **customDnsConfigs**: [CustomDnsConfigPropertiesFormat](#customdnsconfigpropertiesformat)[]: An array of custom dns configurations. +* **customNetworkInterfaceName**: string: The custom name of the network interface attached to the private endpoint. +* **ipConfigurations**: [PrivateEndpointIPConfiguration](#privateendpointipconfiguration)[]: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: 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. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private endpoint. +* **privateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A grouping of information about the connection to the remote resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyThreatIntelWhitelist +## PrivateLinkService ### Properties -* **fqdns**: string[]: List of FQDNs for the ThreatIntel Whitelist. -* **ipAddresses**: string[]: List of IP addresses for the ThreatIntel Whitelist. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PrivateLinkServiceProperties](#privatelinkserviceproperties): Properties of the private link service. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## FirewallPolicyTransportSecurity +## PrivateLinkServiceConnection ### Properties -* **certificateAuthority**: [FirewallPolicyCertificateAuthority](#firewallpolicycertificateauthority): Trusted Root certificates properties for tls. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Properties of the PrivateLinkServiceConnection. +* **type**: string (ReadOnly): The resource type. -## FirewallPolicyCertificateAuthority +## PrivateLinkServiceConnectionProperties ### Properties -* **keyVaultSecretId**: string: Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. -* **name**: string: Name of the CA certificate. +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): A collection of information about the state of the connection between service consumer and provider. +* **privateLinkServiceId**: string: The resource id of private link service. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestMessage**: string: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## ResourceTags +## PrivateLinkServiceConnectionState ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## FirewallPolicyRuleCollectionGroupProperties +## PrivateLinkServiceIpConfiguration ### Properties -* **priority**: int: Priority of the Firewall Policy Rule Collection Group resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of private link service ip configuration. +* **properties**: [PrivateLinkServiceIpConfigurationProperties](#privatelinkserviceipconfigurationproperties): Properties of private link service IP configuration. +* **type**: string (ReadOnly): The resource type. + +## PrivateLinkServiceIpConfigurationProperties +### Properties +* **primary**: bool: Whether the ip configuration is primary or not. +* **privateIPAddress**: string: The private IP address of the IP configuration. +* **privateIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **ruleCollections**: [FirewallPolicyRuleCollection](#firewallpolicyrulecollection)[]: Group of Firewall Policy rule collections. +* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. -## FirewallPolicyRuleCollection -* **Discriminator**: ruleCollectionType +## PrivateLinkServiceProperties +### Properties +* **alias**: string (ReadOnly): The alias of the private link service. +* **autoApproval**: [PrivateLinkServicePropertiesAutoApproval](#privatelinkservicepropertiesautoapproval): The auto-approval list of the private link service. +* **enableProxyProtocol**: bool: Whether the private link service is enabled for proxy protocol or not. +* **fqdns**: string[]: The list of Fqdn. +* **ipConfigurations**: [PrivateLinkServiceIpConfiguration](#privatelinkserviceipconfiguration)[]: An array of private link service IP configurations. +* **loadBalancerFrontendIpConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: An array of references to the load balancer IP configurations. +* **networkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): An array of references to the network interfaces created for this private link service. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): An array of list about connections to the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **visibility**: [PrivateLinkServicePropertiesVisibility](#privatelinkservicepropertiesvisibility): The visibility list of the private link service. -### Base Properties -* **name**: string: The name of the rule collection. -* **priority**: int: Priority of the Firewall Policy Rule Collection resource. -### FirewallPolicyFilterRuleCollection -#### Properties -* **action**: [FirewallPolicyFilterRuleCollectionAction](#firewallpolicyfilterrulecollectionaction): Properties of the FirewallPolicyFilterRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyFilterRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. +## PrivateLinkServicePropertiesAutoApproval +### Properties +* **subscriptions**: string[]: The list of subscriptions. -### FirewallPolicyNatRuleCollection -#### Properties -* **action**: [FirewallPolicyNatRuleCollectionAction](#firewallpolicynatrulecollectionaction): Properties of the FirewallPolicyNatRuleCollectionAction. -* **ruleCollectionType**: 'FirewallPolicyNatRuleCollection' (Required): The type of the rule collection. -* **rules**: [FirewallPolicyRule](#firewallpolicyrule)[]: List of rules included in a rule collection. +## PrivateLinkServicePropertiesVisibility +### Properties +* **subscriptions**: string[]: The list of subscriptions. +## Probe +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: 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. +* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. +* **type**: string (ReadOnly): Type of the resource. -## FirewallPolicyFilterRuleCollectionAction +## ProbePropertiesFormat ### Properties -* **type**: 'Allow' | 'Deny' | string: The action type of a rule. +* **intervalInSeconds**: int: 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. +* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. +* **numberOfProbes**: int: 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. +* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. +* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **requestPath**: 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. -## FirewallPolicyRule -* **Discriminator**: ruleType +## PropagatedRouteTable +### Properties +* **ids**: [SubResource](#subresource)[]: The list of resource ids of all the RouteTables. +* **labels**: string[]: The list of labels. -### Base Properties -* **description**: string: Description of the rule. -* **name**: string: Name of the rule. -### ApplicationRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **fqdnTags**: string[]: List of FQDN Tags for this rule. -* **protocols**: [FirewallPolicyRuleApplicationProtocol](#firewallpolicyruleapplicationprotocol)[]: Array of Application Protocols. -* **ruleType**: 'ApplicationRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **targetFqdns**: string[]: List of FQDNs for this rule. -* **targetUrls**: string[]: List of Urls for this rule condition. -* **terminateTLS**: bool: Terminate TLS connections for this rule. -* **webCategories**: string[]: List of destination azure web categories. +## ProtocolCustomSettingsFormat +### Properties +* **protocol**: 'Syn' | 'Tcp' | 'Udp' | string: The protocol for which the DDoS protection policy is being customized. +* **sourceRateOverride**: string: The customized DDoS protection source rate. +* **triggerRateOverride**: string: The customized DDoS protection trigger rate. +* **triggerSensitivityOverride**: 'Default' | 'High' | 'Low' | 'Relaxed' | 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. -### NatRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NatRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. -* **translatedAddress**: string: The translated address for this NAT rule. -* **translatedFqdn**: string: The translated FQDN for this NAT rule. -* **translatedPort**: string: The translated port for this NAT rule. +## PublicIPAddress +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [PublicIPAddressPropertiesFormat](#publicipaddresspropertiesformat): Public IP address properties. +* **sku**: [PublicIPAddressSku](#publicipaddresssku): SKU of a public IP address. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. +* **zones**: string[]: A list of availability zones denoting the IP allocated for the resource needs to come from. -### NetworkRule -#### Properties -* **destinationAddresses**: string[]: List of destination IP addresses or Service Tags. -* **destinationFqdns**: string[]: List of destination FQDNs. -* **destinationIpGroups**: string[]: List of destination IpGroups for this rule. -* **destinationPorts**: string[]: List of destination ports. -* **ipProtocols**: 'Any' | 'ICMP' | 'TCP' | 'UDP' | string[]: Array of FirewallPolicyRuleNetworkProtocols. -* **ruleType**: 'NetworkRule' (Required): Rule Type. -* **sourceAddresses**: string[]: List of source IP addresses for this rule. -* **sourceIpGroups**: string[]: List of source IpGroups for this rule. +## PublicIPAddressDnsSettings +### Properties +* **domainNameLabel**: string: 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. +* **fqdn**: 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. +* **reverseFqdn**: 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. + +## PublicIPAddressPropertiesFormat +### Properties +* **ddosSettings**: [DdosSettings](#ddossettings): Contains the DDoS protection settings of the public IP. +* **deleteOption**: 'Delete' | 'Detach' | string: Specify what happens to the public IP address when the VM using it is deleted +* **dnsSettings**: [PublicIPAddressDnsSettings](#publicipaddressdnssettings): Contains FQDN of the DNS record associated with the public IP address. +* **idleTimeoutInMinutes**: int: The idle timeout of the public IP address. +* **ipAddress**: string: The IP address associated with the public IP address resource. +* **ipConfiguration**: [IPConfiguration](#ipconfiguration) (ReadOnly): IP configuration. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP address. +* **linkedPublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. +* **migrationPhase**: 'Abort' | 'Commit' | 'Committed' | 'None' | 'Prepare' | string: Migration phase of Public IP Address. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **publicIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **publicIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP address resource. +* **servicePublicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. + +## PublicIPAddressSku +### Properties +* **name**: 'Basic' | 'Standard' | string: Name of a public IP address SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP address SKU. + +## PublicIPPrefixPropertiesFormat +### Properties +* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. +* **ipPrefix**: string (ReadOnly): The allocated Prefix. +* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. +* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. +* **prefixLength**: int: The Length of the Public IP Prefix. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. +* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. + +## PublicIPPrefixSku +### Properties +* **name**: 'Standard' | string: Name of a public IP prefix SKU. +* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. + +## QosDefinition +### Properties +* **destinationIpRanges**: [QosIpRange](#qosiprange)[]: Destination IP ranges. +* **destinationPortRanges**: [QosPortRange](#qosportrange)[]: Destination port ranges. +* **markings**: int[]: List of markings to be used in the configuration. +* **protocol**: 'Ah' | 'All' | 'DoNotUse' | 'Esp' | 'Gre' | 'Icmp' | 'Tcp' | 'Udp' | 'Vxlan' | string: RNM supported protocol types. +* **sourceIpRanges**: [QosIpRange](#qosiprange)[]: Source IP ranges. +* **sourcePortRanges**: [QosPortRange](#qosportrange)[]: Sources port ranges. + +## QosIpRange +### Properties +* **endIP**: string: End IP Address. +* **startIP**: string: Start IP Address. + +## QosPortRange +### Properties +* **end**: int: Qos Port Range end. +* **start**: int: Qos Port Range start. + +## QueryResults +### Properties +* **matchingRecordsCount**: int (ReadOnly): Number of total records matching the query. +* **signatures**: [SingleQueryResult](#singlequeryresult)[] (ReadOnly): Array containing the results of the query + +## RadiusServer +### Properties +* **radiusServerAddress**: string (Required): The address of this radius server. +* **radiusServerScore**: int: The initial score assigned to this radius server. +* **radiusServerSecret**: string: The secret used for this radius server. + +## RecordSet +### Properties +* **fqdn**: string: Fqdn that resolves to private endpoint ip address. +* **ipAddresses**: string[]: The private ip address of the private endpoint. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **recordSetName**: string: Recordset name. +* **recordType**: string: Resource record type. +* **ttl**: int: Recordset time to live. + +## ReferencedPublicIpAddress +### Properties +* **id**: string: The PublicIPAddress Reference. + +## ResourceNavigationLink +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ResourceNavigationLinkFormat](#resourcenavigationlinkformat): Properties of ResourceNavigationLink. +* **type**: string (ReadOnly): Resource type. + +## ResourceNavigationLinkFormat +### Properties +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyRuleApplicationProtocol +## ResourceTags ### Properties -* **port**: int: Port number for the protocol, cannot be greater than 64000. -* **protocolType**: 'Http' | 'Https' | string: The application protocol type of a Rule. +### Additional Properties +* **Additional Properties Type**: string -## FirewallPolicyNatRuleCollectionAction +## ResourceTags ### Properties -* **type**: 'DNAT' | string: The action type of a rule. +### Additional Properties +* **Additional Properties Type**: string -## SignaturesOverridesProperties +## ResourceTags ### Properties -* **signatures**: [Signatures](#signatures): Dictionary of +### Additional Properties +* **Additional Properties Type**: string -## Signatures +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## IpAllocationPropertiesFormat +## ResourceTags ### Properties -* **allocationTags**: [IpAllocationPropertiesFormatAllocationTags](#ipallocationpropertiesformatallocationtags): IpAllocation tags. -* **ipamAllocationId**: string: The IPAM allocation ID. -* **prefix**: string: The address prefix for the IpAllocation. -* **prefixLength**: int: The address prefix length for the IpAllocation. -* **prefixType**: 'IPv4' | 'IPv6' | string: IP address version. -* **subnet**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **type**: 'Hypernet' | 'Undefined' | string: IpAllocation type. -* **virtualNetwork**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## IpAllocationPropertiesFormatAllocationTags +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -3397,114 +3401,65 @@ ### Additional Properties * **Additional Properties Type**: string -## IpGroupPropertiesFormat +## ResourceTags ### Properties -* **firewallPolicies**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall Policies resources that this IpGroups is associated with. -* **firewalls**: [SubResource](#subresource)[] (ReadOnly): List of references to Firewall resources that this IpGroups is associated with. -* **ipAddresses**: string[]: IpAddresses/IpAddressPrefixes in the IpGroups resource. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LoadBalancerPropertiesFormat +## ResourceTags ### Properties -* **backendAddressPools**: [BackendAddressPool](#backendaddresspool)[]: Collection of backend address pools used by a load balancer. -* **frontendIPConfigurations**: [FrontendIPConfiguration](#frontendipconfiguration)[]: Object representing the frontend IPs to be used for the load balancer. -* **inboundNatPools**: [InboundNatPool](#inboundnatpool)[]: 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. -* **inboundNatRules**: [InboundNatRule](#inboundnatrule)[]: 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. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Object collection representing the load balancing rules Gets the provisioning. -* **outboundRules**: [OutboundRule](#outboundrule)[]: The outbound rules. -* **probes**: [Probe](#probe)[]: Collection of probe objects used in the load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the load balancer resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPool +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [InboundNatPoolPropertiesFormat](#inboundnatpoolpropertiesformat): Properties of Inbound NAT pool. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## InboundNatPoolPropertiesFormat +## ResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPortRangeEnd**: int (Required): 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. -* **frontendPortRangeStart**: int (Required): 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. -* **idleTimeoutInMinutes**: int: 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. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [LoadBalancingRulePropertiesFormat](#loadbalancingrulepropertiesformat): Properties of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancingRulePropertiesFormat +## ResourceTags ### Properties -* **backendAddressPool**: [SubResource](#subresource): Reference to another subresource. -* **backendAddressPools**: [SubResource](#subresource)[]: An array of references to pool of DIPs. -* **backendPort**: int: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". -* **disableOutboundSnat**: bool: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. -* **enableFloatingIP**: bool: 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. -* **enableTcpReset**: bool: 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. -* **frontendIPConfiguration**: [SubResource](#subresource): Reference to another subresource. -* **frontendPort**: int (Required): 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". -* **idleTimeoutInMinutes**: int: 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. -* **loadDistribution**: 'Default' | 'SourceIP' | 'SourceIPProtocol' | string: The load distribution policy for this rule. -* **probe**: [SubResource](#subresource): Reference to another subresource. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The transport protocol for the endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRule +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [OutboundRulePropertiesFormat](#outboundrulepropertiesformat): Outbound rule of the load balancer. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## OutboundRulePropertiesFormat +## ResourceTags ### Properties -* **allocatedOutboundPorts**: int: The number of outbound ports to be used for NAT. -* **backendAddressPool**: [SubResource](#subresource) (Required): Reference to another subresource. -* **enableTcpReset**: bool: 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. -* **frontendIPConfigurations**: [SubResource](#subresource)[] (Required): The Frontend IP addresses of the load balancer. -* **idleTimeoutInMinutes**: int: The timeout for the TCP idle connection. -* **protocol**: 'All' | 'Tcp' | 'Udp' | string (Required): The protocol for the outbound rule in load balancer. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Probe +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: 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. -* **properties**: [ProbePropertiesFormat](#probepropertiesformat): Load balancer probe resource. -* **type**: string (ReadOnly): Type of the resource. +### Additional Properties +* **Additional Properties Type**: string -## ProbePropertiesFormat +## ResourceTags ### Properties -* **intervalInSeconds**: int: 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. -* **loadBalancingRules**: [SubResource](#subresource)[] (ReadOnly): The load balancer rules that use this probe. -* **numberOfProbes**: int: 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. -* **port**: int (Required): The port for communicating the probe. Possible values range from 1 to 65535, inclusive. -* **protocol**: 'Http' | 'Https' | 'Tcp' | string (Required): 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. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **requestPath**: 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. +### Additional Properties +* **Additional Properties Type**: string -## LoadBalancerSku +## ResourceTags ### Properties -* **name**: 'Basic' | 'Gateway' | 'Standard' | string: Name of a load balancer SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a load balancer SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3526,56 +3481,45 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkProfilePropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaceConfigurations**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration)[]: List of chid container network interface configurations. -* **containerNetworkInterfaces**: [ContainerNetworkInterface](#containernetworkinterface)[] (ReadOnly): List of child container network interfaces. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the network profile resource. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceConfigurationPropertiesFormat](#containernetworkinterfaceconfigurationpropertiesformat): Container network interface configuration properties. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceConfigurationPropertiesFormat +## ResourceTags ### Properties -* **containerNetworkInterfaces**: [SubResource](#subresource)[]: A list of container network interfaces created from this container network interface configuration. -* **ipConfigurations**: [IPConfigurationProfile](#ipconfigurationprofile)[]: A list of ip configurations of the container network interface configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterface +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfacePropertiesFormat](#containernetworkinterfacepropertiesformat): Properties of container network interface. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfacePropertiesFormat +## ResourceTags ### Properties -* **container**: [Container](#container): Reference to container resource in remote resource provider. -* **containerNetworkInterfaceConfiguration**: [ContainerNetworkInterfaceConfiguration](#containernetworkinterfaceconfiguration) (ReadOnly): Container network interface configuration child resource. -* **ipConfigurations**: [ContainerNetworkInterfaceIpConfiguration](#containernetworkinterfaceipconfiguration)[] (ReadOnly): Reference to the ip configuration on this container nic. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Container +## ResourceTags ### Properties -* **id**: string: Resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfiguration +## ResourceTags ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the resource. This name can be used to access the resource. -* **properties**: [ContainerNetworkInterfaceIpConfigurationPropertiesFormat](#containernetworkinterfaceipconfigurationpropertiesformat): Properties of the container network interface IP configuration. -* **type**: string (ReadOnly): Sub Resource type. +### Additional Properties +* **Additional Properties Type**: string -## ContainerNetworkInterfaceIpConfigurationPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -3587,396 +3531,417 @@ ### Additional Properties * **Additional Properties Type**: string -## NetworkVirtualAppliancePropertiesFormat +## ResourceTags ### Properties -* **addressPrefix**: string (ReadOnly): Address Prefix. -* **bootStrapConfigurationBlobs**: string[]: BootStrapConfigurationBlobs storage URLs. -* **cloudInitConfiguration**: string: CloudInitConfiguration string in plain text. -* **cloudInitConfigurationBlobs**: string[]: CloudInitConfigurationBlob storage URLs. -* **inboundSecurityRules**: [SubResource](#subresource)[] (ReadOnly): List of references to InboundSecurityRules. -* **nvaSku**: [VirtualApplianceSkuProperties](#virtualapplianceskuproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sshPublicKey**: string: Public key for SSH login. -* **virtualApplianceAsn**: int: VirtualAppliance ASN. -* **virtualApplianceNics**: [VirtualApplianceNicProperties](#virtualappliancenicproperties)[] (ReadOnly): List of Virtual Appliance Network Interfaces. -* **virtualApplianceSites**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualApplianceSite. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSkuProperties +## ResourceTags ### Properties -* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. -* **marketPlaceVersion**: string: Virtual Appliance Version. -* **vendor**: string: Virtual Appliance Vendor. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceNicProperties +## ResourceTags ### Properties -* **name**: string (ReadOnly): NIC name. -* **privateIpAddress**: string (ReadOnly): Private IP address. -* **publicIpAddress**: string (ReadOnly): Public IP address. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InboundSecurityRuleProperties +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [InboundSecurityRules](#inboundsecurityrules)[]: List of allowed rules. +### Additional Properties +* **Additional Properties Type**: string -## InboundSecurityRules +## ResourceTags ### Properties -* **destinationPortRange**: int: NVA port ranges to be opened up. One needs to provide specific ports. -* **protocol**: 'TCP' | 'UDP' | string: Protocol. This should be either TCP or UDP. -* **sourceAddressPrefix**: string: The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed. +### Additional Properties +* **Additional Properties Type**: string -## VirtualApplianceSiteProperties +## ResourceTags ### Properties -* **addressPrefix**: string: Address Prefix. -* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## Office365PolicyProperties +## ResourceTags ### Properties -* **breakOutCategories**: [BreakOutCategoryPolicies](#breakoutcategorypolicies): Network Virtual Appliance Sku Properties. +### Additional Properties +* **Additional Properties Type**: string -## BreakOutCategoryPolicies +## ResourceTags ### Properties -* **allow**: bool: Flag to control breakout of o365 allow category. -* **default**: bool: Flag to control breakout of o365 default category. -* **optimize**: bool: Flag to control breakout of o365 optimize category. +### Additional Properties +* **Additional Properties Type**: string -## NetworkWatcherPropertiesFormat +## ResourceTags ### Properties -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorParameters +## ResourceTags ### Properties -* **autoStart**: bool: Determines if the connection monitor will start automatically once created. -* **connectionMonitorType**: 'MultiEndpoint' | 'SingleSourceDestination' | string (ReadOnly): Type of connection monitor. -* **destination**: [ConnectionMonitorDestination](#connectionmonitordestination): Describes the destination of connection monitor. -* **endpoints**: [ConnectionMonitorEndpoint](#connectionmonitorendpoint)[]: List of connection monitor endpoints. -* **monitoringIntervalInSeconds**: int: Monitoring interval in seconds. -* **monitoringStatus**: string (ReadOnly): The monitoring status of the connection monitor. -* **notes**: string: Optional notes to be associated with the connection monitor. -* **outputs**: [ConnectionMonitorOutput](#connectionmonitoroutput)[]: List of connection monitor outputs. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **source**: [ConnectionMonitorSource](#connectionmonitorsource): Describes the source of connection monitor. -* **startTime**: string (ReadOnly): The date and time when the connection monitor was started. -* **testConfigurations**: [ConnectionMonitorTestConfiguration](#connectionmonitortestconfiguration)[]: List of connection monitor test configurations. -* **testGroups**: [ConnectionMonitorTestGroup](#connectionmonitortestgroup)[]: List of connection monitor test groups. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorDestination +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor destination (IP or domain name). -* **port**: int: The destination port used by connection monitor. -* **resourceId**: string: The ID of the resource used as the destination by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpoint +## ResourceTags ### Properties -* **address**: string: Address of the connection monitor endpoint (IP or domain name). -* **coverageLevel**: 'AboveAverage' | 'Average' | 'BelowAverage' | 'Default' | 'Full' | 'Low' | string: Test coverage for the endpoint. -* **filter**: [ConnectionMonitorEndpointFilter](#connectionmonitorendpointfilter): Describes the connection monitor endpoint filter. -* **name**: string (Required): The name of the connection monitor endpoint. -* **resourceId**: string: Resource ID of the connection monitor endpoint. -* **scope**: [ConnectionMonitorEndpointScope](#connectionmonitorendpointscope): Describes the connection monitor endpoint scope. -* **type**: 'AzureSubnet' | 'AzureVM' | 'AzureVNet' | 'ExternalAddress' | 'MMAWorkspaceMachine' | 'MMAWorkspaceNetwork' | string: The endpoint type. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilter +## ResourceTags ### Properties -* **items**: [ConnectionMonitorEndpointFilterItem](#connectionmonitorendpointfilteritem)[]: List of items in the filter. -* **type**: 'Include' | string: The behavior of the endpoint filter. Currently only 'Include' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointFilterItem +## ResourceTags ### Properties -* **address**: string: The address of the filter item. -* **type**: 'AgentAddress' | string: The type of item included in the filter. Currently only 'AgentAddress' is supported. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScope +## ResourceTags ### Properties -* **exclude**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be excluded from the endpoint scope. -* **include**: [ConnectionMonitorEndpointScopeItem](#connectionmonitorendpointscopeitem)[]: List of items which needs to be included to the endpoint scope. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorEndpointScopeItem +## ResourceTags ### Properties -* **address**: string: The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorOutput +## ResourceTags ### Properties -* **type**: 'Workspace' | string: Connection monitor output destination type. Currently, only "Workspace" is supported. -* **workspaceSettings**: [ConnectionMonitorWorkspaceSettings](#connectionmonitorworkspacesettings): Describes the settings for producing output into a log analytics workspace. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorWorkspaceSettings +## ResourceTags ### Properties -* **workspaceResourceId**: string: Log analytics workspace resource ID. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorSource +## ResourceTags ### Properties -* **port**: int: The source port used by connection monitor. -* **resourceId**: string (Required): The ID of the resource used as the source by connection monitor. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorTestConfiguration +## ResourceTags ### Properties -* **httpConfiguration**: [ConnectionMonitorHttpConfiguration](#connectionmonitorhttpconfiguration): Describes the HTTP configuration. -* **icmpConfiguration**: [ConnectionMonitorIcmpConfiguration](#connectionmonitoricmpconfiguration): Describes the ICMP configuration. -* **name**: string (Required): The name of the connection monitor test configuration. -* **preferredIPVersion**: 'IPv4' | 'IPv6' | string: The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. -* **protocol**: 'Http' | 'Icmp' | 'Tcp' | string (Required): The protocol to use in test evaluation. -* **successThreshold**: [ConnectionMonitorSuccessThreshold](#connectionmonitorsuccessthreshold): Describes the threshold for declaring a test successful. -* **tcpConfiguration**: [ConnectionMonitorTcpConfiguration](#connectionmonitortcpconfiguration): Describes the TCP configuration. -* **testFrequencySec**: int: The frequency of test evaluation, in seconds. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionMonitorHttpConfiguration +## ResourceTags ### Properties -* **method**: 'Get' | 'Post' | string: The HTTP method to use. -* **path**: string: The path component of the URI. For instance, "/dir1/dir2". -* **port**: int: The port to connect to. -* **preferHTTPS**: bool: Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. -* **requestHeaders**: [HttpHeader](#httpheader)[]: The HTTP headers to transmit with the request. -* **validStatusCodeRanges**: string[]: HTTP status codes to consider successful. For instance, "2xx,301-304,418". +### Additional Properties +* **Additional Properties Type**: string -## HttpHeader +## RetentionPolicyParameters ### Properties -* **name**: string: The name in HTTP header. -* **value**: string: The value in HTTP header. +* **days**: int: Number of days to retain flow log records. +* **enabled**: bool: Flag to enable/disable retention. -## ConnectionMonitorIcmpConfiguration +## Route ### Properties -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RoutePropertiesFormat](#routepropertiesformat): Route resource. +* **type**: string: The type of the resource. -## ConnectionMonitorSuccessThreshold +## RouteFilterPropertiesFormat ### Properties -* **checksFailedPercent**: int: The maximum percentage of failed checks permitted for a test to evaluate as successful. -* **roundTripTimeMs**: int: The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. +* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. +* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. -## ConnectionMonitorTcpConfiguration +## RouteFilterRule ### Properties -* **destinationPortBehavior**: 'ListenIfAvailable' | 'None' | string: Destination port behavior. -* **disableTraceRoute**: bool: Value indicating whether path evaluation with trace route should be disabled. -* **port**: int: The port to connect to. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## ConnectionMonitorTestGroup +## RouteFilterRulePropertiesFormat ### Properties -* **destinations**: string[] (Required): List of destination endpoint names. -* **disable**: bool: Value indicating whether test group is disabled. -* **name**: string (Required): The name of the connection monitor test group. -* **sources**: string[] (Required): List of source endpoint names. -* **testConfigurations**: string[] (Required): List of test configuration names. +* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. +* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. -## ConnectionMonitorTags +## RoutePropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressPrefix**: string: The destination CIDR to which the route applies. +* **hasBgpOverride**: bool: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. +* **nextHopIpAddress**: string: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. +* **nextHopType**: 'Internet' | 'None' | 'VirtualAppliance' | 'VirtualNetworkGateway' | 'VnetLocal' | string (Required): The type of Azure hop the packet should be sent to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## ResourceTags +## RouteTable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [RouteTablePropertiesFormat](#routetablepropertiesformat): Route Table resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## PacketCaptureParameters +## RouteTablePropertiesFormat ### Properties -* **bytesToCapturePerPacket**: int: Number of bytes captured per packet, the remaining bytes are truncated. -* **filters**: [PacketCaptureFilter](#packetcapturefilter)[]: A list of packet capture filters. +* **disableBgpRoutePropagation**: bool: Whether to disable the routes learned by BGP on that route table. True means disable. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **storageLocation**: [PacketCaptureStorageLocation](#packetcapturestoragelocation) (Required): The storage location for a packet capture session. -* **target**: string (Required): The ID of the targeted resource, only VM is currently supported. -* **timeLimitInSeconds**: int: Maximum duration of the capture session in seconds. -* **totalBytesPerSession**: int: Maximum size of the capture output. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the route table. +* **routes**: [Route](#route)[]: Collection of routes contained within a route table. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PacketCaptureFilter +## RoutingConfiguration ### Properties -* **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. -* **localPort**: 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. -* **protocol**: 'Any' | 'TCP' | 'UDP' | string: Protocol to be filtered on. -* **remoteIPAddress**: 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. -* **remotePort**: 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. +* **associatedRouteTable**: [SubResource](#subresource): Reference to another subresource. +* **propagatedRouteTables**: [PropagatedRouteTable](#propagatedroutetable): The list of RouteTables to advertise the routes to. +* **vnetRoutes**: [VnetRoute](#vnetroute): List of routes that control routing from VirtualHub into a virtual network connection. -## PacketCaptureStorageLocation +## RoutingIntentProperties ### Properties -* **filePath**: 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. -* **storageId**: string: The ID of the storage account to save the packet capture session. Required if no local file path is provided. -* **storagePath**: 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. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingPolicies**: [RoutingPolicy](#routingpolicy)[]: List of routing policies. -## P2SVpnGatewayProperties +## RoutingPolicy ### Properties -* **customDnsServers**: string[]: List of all customer specified DNS servers IP addresses. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. -* **p2SConnectionConfigurations**: [P2SConnectionConfiguration](#p2sconnectionconfiguration)[]: List of all p2s connection configurations of the gateway. +* **destinations**: string[] (Required): List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). +* **name**: string (Required): The unique name for the routing policy. +* **nextHop**: string (Required): The next hop resource id on which this routing policy is applicable to. + +## SecurityPartnerProviderPropertiesFormat +### Properties +* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. * **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnClientConnectionHealth**: [VpnClientConnectionHealth](#vpnclientconnectionhealth) (ReadOnly): VpnClientConnectionHealth properties. -* **vpnGatewayScaleUnit**: int: The scale unit for this p2s vpn gateway. -* **vpnServerConfiguration**: [SubResource](#subresource): Reference to another subresource. -## P2SConnectionConfiguration +## SecurityRule ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [P2SConnectionConfigurationProperties](#p2sconnectionconfigurationproperties): Parameters for P2SConnectionConfiguration. +* **properties**: [SecurityRulePropertiesFormat](#securityrulepropertiesformat): Security rule resource. +* **type**: string: The type of the resource. -## P2SConnectionConfigurationProperties +## SecurityRulePropertiesFormat ### Properties -* **configurationPolicyGroupAssociations**: [SubResource](#subresource)[] (ReadOnly): List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. -* **enableInternetSecurity**: bool: Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. -* **previousConfigurationPolicyGroupAssociations**: [VpnServerConfigurationPolicyGroup](#vpnserverconfigurationpolicygroup)[] (ReadOnly): List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. +* **access**: 'Allow' | 'Deny' | string (Required): Whether network traffic is allowed or denied. +* **description**: string: A description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: 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. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as destination. +* **destinationPortRange**: string: The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. +* **priority**: int: 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. +* **protocol**: '*' | 'Ah' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **sourceAddressPrefix**: 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. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourceApplicationSecurityGroups**: [ApplicationSecurityGroup](#applicationsecuritygroup)[]: The application security group specified as source. +* **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. +* **sourcePortRanges**: string[]: The source port ranges. -## VpnServerConfigurationPolicyGroup +## ServiceAssociationLink ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnServerConfigurationPolicyGroupProperties](#vpnserverconfigurationpolicygroupproperties): Parameters for VpnServerConfigurationPolicyGroup. +* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceAssociationLinkPropertiesFormat](#serviceassociationlinkpropertiesformat): Properties of ServiceAssociationLink. * **type**: string (ReadOnly): Resource type. -## VpnServerConfigurationPolicyGroupProperties +## ServiceAssociationLinkPropertiesFormat ### Properties -* **isDefault**: bool: Shows if this is a Default VpnServerConfigurationPolicyGroup or not. -* **p2SConnectionConfigurations**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SConnectionConfigurations. -* **policyMembers**: [VpnServerConfigurationPolicyGroupMember](#vpnserverconfigurationpolicygroupmember)[]: Multiple PolicyMembers for VpnServerConfigurationPolicyGroup. -* **priority**: int: Priority for VpnServerConfigurationPolicyGroup. +* **allowDelete**: bool: If true, the resource can be deleted. +* **link**: string: Link to the external resource. +* **linkedResourceType**: string: Resource type of the linked resource. +* **locations**: string[]: A list of locations. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnServerConfigurationPolicyGroupMember +## ServiceDelegationPropertiesFormat ### Properties -* **attributeType**: 'AADGroupId' | 'CertificateGroupId' | 'RadiusAzureGroupId' | string: The Vpn Policy member attribute type. -* **attributeValue**: string: The value of Attribute used for this VpnServerConfigurationPolicyGroupMember. -* **name**: string: Name of the VpnServerConfigurationPolicyGroupMember. +* **actions**: string[] (ReadOnly): The actions permitted to the service upon delegation. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **serviceName**: string: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). -## VpnClientConnectionHealth +## ServiceEndpointPolicy ### Properties -* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. -* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. -* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. -* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **kind**: string (ReadOnly): Kind of service endpoint policy. This is metadata used for the Azure portal experience. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [ServiceEndpointPolicyPropertiesFormat](#serviceendpointpolicypropertiesformat): Service Endpoint Policy resource. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## ServiceEndpointPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [ServiceEndpointPolicyDefinitionPropertiesFormat](#serviceendpointpolicydefinitionpropertiesformat): Service Endpoint policy definition resource. +* **type**: string: The type of the resource. -## ResourceTags +## ServiceEndpointPolicyDefinitionPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **description**: string: A description for this rule. Restricted to 140 chars. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: Service endpoint name. +* **serviceResources**: string[]: A list of service resources. -## PrivateDnsZoneGroupPropertiesFormat +## ServiceEndpointPolicyPropertiesFormat ### Properties -* **privateDnsZoneConfigs**: [PrivateDnsZoneConfig](#privatednszoneconfig)[]: A collection of private dns zone configurations of the private dns zone group. +* **contextualServiceEndpointPolicies**: string[]: A collection of contextual service endpoint policy. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the service endpoint policy resource. +* **serviceAlias**: string: The alias indicating if the policy belongs to a service +* **serviceEndpointPolicyDefinitions**: [ServiceEndpointPolicyDefinition](#serviceendpointpolicydefinition)[]: A collection of service endpoint policy definitions of the service endpoint policy. +* **subnets**: [Subnet](#subnet)[] (ReadOnly): A collection of references to subnets. -## PrivateDnsZoneConfig +## ServiceEndpointPropertiesFormat ### Properties -* **name**: string: Name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [PrivateDnsZonePropertiesFormat](#privatednszonepropertiesformat): Properties of the private dns zone configuration resource. +* **locations**: string[]: A list of locations. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **service**: string: The type of the endpoint service. -## PrivateDnsZonePropertiesFormat +## SignatureOverridesFilterValuesQuery ### Properties -* **privateDnsZoneId**: string: The resource id of the private dns zone. -* **recordSets**: [RecordSet](#recordset)[] (ReadOnly): A collection of information regarding a recordSet, holding information to identify private resources. +* **filterName**: string (WriteOnly): Describes the name of the column which values will be returned -## RecordSet +## SignatureOverridesFilterValuesResponse ### Properties -* **fqdn**: string: Fqdn that resolves to private endpoint ip address. -* **ipAddresses**: string[]: The private ip address of the private endpoint. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **recordSetName**: string: Recordset name. -* **recordType**: string: Resource record type. -* **ttl**: int: Recordset time to live. +* **filterValues**: string[] (ReadOnly): Describes the possible values -## ResourceTags +## Signatures ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## SignaturesOverridesProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **signatures**: [Signatures](#signatures): Dictionary of -## PublicIPPrefixPropertiesFormat +## SingleQueryResult ### Properties -* **customIPPrefix**: [SubResource](#subresource): Reference to another subresource. -* **ipPrefix**: string (ReadOnly): The allocated Prefix. -* **ipTags**: [IpTag](#iptag)[]: The list of tags associated with the public IP prefix. -* **loadBalancerFrontendIpConfiguration**: [SubResource](#subresource) (ReadOnly): Reference to another subresource. -* **natGateway**: [NatGateway](#natgateway): Nat Gateway resource. -* **prefixLength**: int: The Length of the Public IP Prefix. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddresses**: [ReferencedPublicIpAddress](#referencedpublicipaddress)[] (ReadOnly): The list of all referenced PublicIPAddresses. -* **publicIPAddressVersion**: 'IPv4' | 'IPv6' | string: IP address version. -* **resourceGuid**: string (ReadOnly): The resource GUID property of the public IP prefix resource. +* **description**: string (ReadOnly): Describes what is the signature enforces +* **destinationPorts**: string[] (ReadOnly): Describes the list of destination ports related to this signature +* **direction**: int (ReadOnly): Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional +* **group**: string (ReadOnly): Describes the groups the signature belongs to +* **inheritedFromParentPolicy**: bool (ReadOnly): Describes if this override is inherited from base policy or not +* **lastUpdated**: string (ReadOnly): Describes the last updated time of the signature (provided from 3rd party vendor) +* **mode**: int (ReadOnly): The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny +* **protocol**: string (ReadOnly): Describes the protocol the signatures is being enforced in +* **severity**: int (ReadOnly): Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High +* **signatureId**: int (ReadOnly): The ID of the signature +* **sourcePorts**: string[] (ReadOnly): Describes the list of source ports related to this signature -## ReferencedPublicIpAddress +## Sku ### Properties -* **id**: string: The PublicIPAddress Reference. +* **name**: 'Basic' | 'Standard' | string: The name of this Bastion Host. -## PublicIPPrefixSku +## StaticRoute ### Properties -* **name**: 'Standard' | string: Name of a public IP prefix SKU. -* **tier**: 'Global' | 'Regional' | string: Tier of a public IP prefix SKU. +* **addressPrefixes**: string[]: List of all address prefixes. +* **name**: string: The name of the StaticRoute that is unique within a VnetRoute. +* **nextHopIpAddress**: string: The ip address of the next hop. -## ResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [SubnetPropertiesFormat](#subnetpropertiesformat): Properties of the subnet. +* **type**: string: Resource type. -## RouteFilterPropertiesFormat +## SubnetPropertiesFormat ### Properties -* **ipv6Peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit ipv6 peerings. -* **peerings**: [ExpressRouteCircuitPeering](#expressroutecircuitpeering)[] (ReadOnly): A collection of references to express route circuit peerings. +* **addressPrefix**: string: The address prefix for the subnet. +* **addressPrefixes**: string[]: List of address prefixes for the subnet. +* **applicationGatewayIpConfigurations**: [ApplicationGatewayIPConfiguration](#applicationgatewayipconfiguration)[]: Application gateway IP configurations of virtual network resource. +* **delegations**: [Delegation](#delegation)[]: An array of references to the delegations on the subnet. +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this subnet. +* **ipConfigurationProfiles**: [IPConfigurationProfile](#ipconfigurationprofile)[] (ReadOnly): Array of IP configuration profiles which reference this subnet. +* **ipConfigurations**: [IPConfiguration](#ipconfiguration)[] (ReadOnly): An array of references to the network interface IP configurations using subnet. +* **natGateway**: [SubResource](#subresource): Reference to another subresource. +* **networkSecurityGroup**: [NetworkSecurityGroup](#networksecuritygroup): NetworkSecurityGroup resource. +* **privateEndpointNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateEndpoints**: [PrivateEndpoint](#privateendpoint)[] (ReadOnly): An array of references to private endpoints. +* **privateLinkServiceNetworkPolicies**: 'Disabled' | 'Enabled' | string: Enable or Disable apply network policies on private link service in the subnet. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **rules**: [RouteFilterRule](#routefilterrule)[]: Collection of RouteFilterRules contained within a route filter. +* **purpose**: string (ReadOnly): A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. +* **resourceNavigationLinks**: [ResourceNavigationLink](#resourcenavigationlink)[] (ReadOnly): An array of references to the external resources using subnet. +* **routeTable**: [RouteTable](#routetable): Route table resource. +* **serviceAssociationLinks**: [ServiceAssociationLink](#serviceassociationlink)[] (ReadOnly): An array of references to services injecting into this subnet. +* **serviceEndpointPolicies**: [ServiceEndpointPolicy](#serviceendpointpolicy)[]: An array of service endpoint policies. +* **serviceEndpoints**: [ServiceEndpointPropertiesFormat](#serviceendpointpropertiesformat)[]: An array of service endpoints. -## RouteFilterRule +## SubResource ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [RouteFilterRulePropertiesFormat](#routefilterrulepropertiesformat): Route Filter Rule Resource. -## RouteFilterRulePropertiesFormat +## TrafficAnalyticsConfigurationProperties ### Properties -* **access**: 'Allow' | 'Deny' | string (Required): Access to be allowed or denied. -* **communities**: string[] (Required): The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routeFilterRuleType**: 'Community' | string (Required): The rule type of the rule. +* **enabled**: bool: Flag to enable/disable traffic analytics. +* **trafficAnalyticsInterval**: int: The interval in minutes which would decide how frequently TA service should do flow analytics. +* **workspaceId**: string: The resource guid of the attached workspace. +* **workspaceRegion**: string: The location of the attached workspace. +* **workspaceResourceId**: string: Resource Id of the attached workspace. -## ResourceTags +## TrafficAnalyticsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **networkWatcherFlowAnalyticsConfiguration**: [TrafficAnalyticsConfigurationProperties](#trafficanalyticsconfigurationproperties): Parameters that define the configuration of traffic analytics. -## ResourceTags +## TrafficSelectorPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **localAddressRanges**: string[] (Required): A collection of local address spaces in CIDR format. +* **remoteAddressRanges**: string[] (Required): A collection of remote address spaces in CIDR format. -## SecurityPartnerProviderPropertiesFormat +## TunnelConnectionHealth ### Properties -* **connectionStatus**: 'Connected' | 'NotConnected' | 'PartiallyConnected' | 'Unknown' | string (ReadOnly): The current state of the connection with Security Partner Provider. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **egressBytesTransferred**: int (ReadOnly): The Egress Bytes Transferred in this connection. +* **ingressBytesTransferred**: int (ReadOnly): The Ingress Bytes Transferred in this connection. +* **lastConnectionEstablishedUtcTime**: string (ReadOnly): The time at which connection was established in Utc format. +* **tunnel**: string (ReadOnly): Tunnel name. + +## VirtualApplianceNicProperties +### Properties +* **name**: string (ReadOnly): NIC name. +* **privateIpAddress**: string (ReadOnly): Private IP address. +* **publicIpAddress**: string (ReadOnly): Public IP address. + +## VirtualApplianceSiteProperties +### Properties +* **addressPrefix**: string: Address Prefix. +* **o365Policy**: [Office365PolicyProperties](#office365policyproperties): Network Virtual Appliance Sku Properties. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **securityProviderName**: 'Checkpoint' | 'IBoss' | 'ZScaler' | string: The Security Providers. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -## ResourceTags +## VirtualApplianceSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bundledScaleUnit**: string: Virtual Appliance Scale Unit. +* **marketPlaceVersion**: string: Virtual Appliance Version. +* **vendor**: string: Virtual Appliance Vendor. -## ResourceTags +## VirtualHubId ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. ## VirtualHubProperties ### Properties @@ -4001,15 +3966,15 @@ * **virtualWan**: [SubResource](#subresource): Reference to another subresource. * **vpnGateway**: [SubResource](#subresource): Reference to another subresource. -## VirtualHubRouteTable -### Properties -* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. - ## VirtualHubRoute ### Properties * **addressPrefixes**: string[]: List of all addressPrefixes. * **nextHopIpAddress**: string: NextHop ip address. +## VirtualHubRouteTable +### Properties +* **routes**: [VirtualHubRoute](#virtualhubroute)[]: List of all routes. + ## VirtualHubRouteTableV2 ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. @@ -4030,97 +3995,116 @@ * **nextHops**: string[]: NextHops ip address. * **nextHopType**: string: The type of next hops. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BgpConnectionProperties -### Properties -* **connectionState**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the VirtualHub to Peer. -* **hubVirtualNetworkConnection**: [SubResource](#subresource): Reference to another subresource. -* **peerAsn**: int: Peer ASN. -* **peerIp**: string: Peer IP. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## HubRouteTableProperties -### Properties -* **associatedConnections**: string[] (ReadOnly): List of all connections associated with this route table. -* **labels**: string[]: List of labels associated with this route table. -* **propagatingConnections**: string[] (ReadOnly): List of all connections that advertise to this route table. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routes**: [HubRoute](#hubroute)[]: List of all routes. - -## HubRoute +## VirtualNetworkBgpCommunities ### Properties -* **destinations**: string[] (Required): List of all destinations. -* **destinationType**: string (Required): The type of destinations (eg: CIDR, ResourceId, Service). -* **name**: string (Required): The name of the Route that is unique within a RouteTable. This name can be used to access this route. -* **nextHop**: string (Required): NextHop resource ID. -* **nextHopType**: string (Required): The type of next hop (eg: ResourceId). +* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. +* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. -## HubVirtualNetworkConnectionProperties +## VirtualNetworkEncryption ### Properties -* **allowHubToRemoteVnetTransit**: bool: Deprecated: VirtualHub to RemoteVnet transit to enabled or not. -* **allowRemoteVnetToUseHubVnetGateways**: bool: Deprecated: Allow RemoteVnet to use Virtual Hub's gateways. -* **enableInternetSecurity**: bool: Enable internet security. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVirtualNetwork**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. +* **enabled**: bool (Required): Indicates if encryption is enabled on the virtual network. +* **enforcement**: 'AllowUnencrypted' | 'DropUnencrypted' | string: If the encrypted VNet allows VM that does not support encryption -## HubIPConfigurationPropertiesFormat +## VirtualNetworkGateway ### Properties -* **privateIPAddress**: string: The private IP address of the IP configuration. -* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **publicIPAddress**: [PublicIPAddress](#publicipaddress): Public IP address resource. -* **subnet**: [Subnet](#subnet): Subnet in a virtual network resource. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **extendedLocation**: [ExtendedLocation](#extendedlocation): ExtendedLocation complex type. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkGatewayPropertiesFormat](#virtualnetworkgatewaypropertiesformat) (Required): VirtualNetworkGateway properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## RoutingIntentProperties +## VirtualNetworkGatewayConnectionPropertiesFormat ### Properties +* **authorizationKey**: string: The authorizationKey. +* **connectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Gateway connection type. +* **connectionProtocol**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): Virtual Network Gateway connection status. +* **connectionType**: 'ExpressRoute' | 'IPsec' | 'VPNClient' | 'Vnet2Vnet' | string (Required): Gateway connection type. +* **dpdTimeoutSeconds**: int: The dead peer detection timeout of this connection in seconds. +* **egressBytesTransferred**: int (ReadOnly): The egress bytes transferred in this connection. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **expressRouteGatewayBypass**: bool: Bypass ExpressRoute Gateway for data forwarding. +* **gatewayCustomBgpIpAddresses**: [GatewayCustomBgpIpAddressIpConfiguration](#gatewaycustombgpipaddressipconfiguration)[]: GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection. +* **ingressBytesTransferred**: int (ReadOnly): The ingress bytes transferred in this connection. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **localNetworkGateway2**: [LocalNetworkGateway](#localnetworkgateway): A common class for general resource information. +* **peer**: [SubResource](#subresource): Reference to another subresource. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **routingPolicies**: [RoutingPolicy](#routingpolicy)[]: List of routing policies. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway connection resource. +* **routingWeight**: int: The routing weight. +* **sharedKey**: string: The IPSec shared key. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. +* **tunnelConnectionStatus**: [TunnelConnectionHealth](#tunnelconnectionhealth)[] (ReadOnly): Collection of all tunnels' connection health status. +* **useLocalAzureIpAddress**: bool: Use private local Azure IP for the connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **virtualNetworkGateway1**: [VirtualNetworkGateway](#virtualnetworkgateway) (Required): A common class for general resource information. +* **virtualNetworkGateway2**: [VirtualNetworkGateway](#virtualnetworkgateway): A common class for general resource information. -## RoutingPolicy +## VirtualNetworkGatewayIPConfiguration ### Properties -* **destinations**: string[] (Required): List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). -* **name**: string (Required): The unique name for the routing policy. -* **nextHop**: string (Required): The next hop resource id on which this routing policy is applicable to. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayIPConfigurationPropertiesFormat](#virtualnetworkgatewayipconfigurationpropertiesformat): Properties of VirtualNetworkGatewayIPConfiguration. -## ResourceTags +## VirtualNetworkGatewayIPConfigurationPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **privateIPAddress**: string (ReadOnly): Private IP Address for this gateway. +* **privateIPAllocationMethod**: 'Dynamic' | 'Static' | string: IP address allocation method. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicIPAddress**: [SubResource](#subresource): Reference to another subresource. +* **subnet**: [SubResource](#subresource): Reference to another subresource. -## VirtualNetworkPropertiesFormat +## VirtualNetworkGatewayNatRule ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. -* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. -* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. -* **enableDdosProtection**: bool: 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. -* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. -* **encryption**: [VirtualNetworkEncryption](#virtualnetworkencryption): Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. -* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network -* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. -* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. -* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VirtualNetworkGatewayNatRuleProperties](#virtualnetworkgatewaynatruleproperties): Parameters for VirtualNetworkGatewayNatRule. +* **type**: string (ReadOnly): Resource type. -## VirtualNetworkBgpCommunities +## VirtualNetworkGatewayNatRuleProperties ### Properties -* **regionalCommunity**: string (ReadOnly): The BGP community associated with the region of the virtual network. -* **virtualNetworkCommunity**: string (Required): The BGP community associated with the virtual network. +* **externalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address external mapping for NAT. +* **internalMappings**: [VpnNatRuleMapping](#vpnnatrulemapping)[]: The private IP address internal mapping for NAT. +* **ipConfigurationId**: string: The IP Configuration ID this NAT rule applies to. +* **mode**: 'EgressSnat' | 'IngressSnat' | string: The Source NAT direction of a VPN NAT. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## DhcpOptions +## VirtualNetworkGatewayPropertiesFormat ### Properties -* **dnsServers**: string[]: The list of DNS servers IP addresses. +* **activeActive**: bool: ActiveActive flag. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **customRoutes**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **disableIPSecReplayProtection**: bool: disableIPSecReplayProtection flag. +* **enableBgp**: bool: Whether BGP is enabled for this virtual network gateway or not. +* **enableBgpRouteTranslationForNat**: bool: EnableBgpRouteTranslationForNat flag. +* **enableDnsForwarding**: bool: Whether dns forwarding is enabled or not. +* **enablePrivateIpAddress**: bool: Whether private IP needs to be enabled on this gateway for connections or not. +* **gatewayDefaultSite**: [SubResource](#subresource): Reference to another subresource. +* **gatewayType**: 'ExpressRoute' | 'LocalGateway' | 'Vpn' | string: The type of this virtual network gateway. +* **inboundDnsForwardingEndpoint**: string (ReadOnly): The IP address allocated by the gateway to which dns requests can be sent. +* **ipConfigurations**: [VirtualNetworkGatewayIPConfiguration](#virtualnetworkgatewayipconfiguration)[]: IP configurations for virtual network gateway. +* **natRules**: [VirtualNetworkGatewayNatRule](#virtualnetworkgatewaynatrule)[]: NatRules for virtual network gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network gateway resource. +* **sku**: [VirtualNetworkGatewaySku](#virtualnetworkgatewaysku): VirtualNetworkGatewaySku details. +* **vNetExtendedLocationResourceId**: string: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. +* **vpnClientConfiguration**: [VpnClientConfiguration](#vpnclientconfiguration): VpnClientConfiguration for P2S client. +* **vpnGatewayGeneration**: 'Generation1' | 'Generation2' | 'None' | string: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. +* **vpnType**: 'PolicyBased' | 'RouteBased' | string: The type of this virtual network gateway. -## VirtualNetworkEncryption +## VirtualNetworkGatewaySku ### Properties -* **enabled**: bool (Required): Indicates if encryption is enabled on the virtual network. -* **enforcement**: 'AllowUnencrypted' | 'DropUnencrypted' | string: If the encrypted VNet allows VM that does not support encryption +* **capacity**: int (ReadOnly): The capacity. +* **name**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU name. +* **tier**: 'Basic' | 'ErGw1AZ' | 'ErGw2AZ' | 'ErGw3AZ' | 'HighPerformance' | 'Standard' | 'UltraPerformance' | 'VpnGw1' | 'VpnGw1AZ' | 'VpnGw2' | 'VpnGw2AZ' | 'VpnGw3' | 'VpnGw3AZ' | 'VpnGw4' | 'VpnGw4AZ' | 'VpnGw5' | 'VpnGw5AZ' | string: Gateway SKU tier. ## VirtualNetworkPeering ### Properties @@ -4147,29 +4131,40 @@ * **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network peering resource. * **useRemoteGateways**: bool: 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. -## ResourceTags +## VirtualNetworkPropertiesFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpCommunities**: [VirtualNetworkBgpCommunities](#virtualnetworkbgpcommunities): Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. +* **ddosProtectionPlan**: [SubResource](#subresource): Reference to another subresource. +* **dhcpOptions**: [DhcpOptions](#dhcpoptions): 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. +* **enableDdosProtection**: bool: 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. +* **enableVmProtection**: bool: Indicates if VM protection is enabled for all the subnets in the virtual network. +* **encryption**: [VirtualNetworkEncryption](#virtualnetworkencryption): Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. +* **flowTimeoutInMinutes**: int: The FlowTimeout value (in minutes) for the Virtual Network +* **ipAllocations**: [SubResource](#subresource)[]: Array of IpAllocation which reference this VNET. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceGuid**: string (ReadOnly): The resourceGuid property of the Virtual Network resource. +* **subnets**: [Subnet](#subnet)[]: A list of subnets in a Virtual Network. +* **virtualNetworkPeerings**: [VirtualNetworkPeering](#virtualnetworkpeering)[]: A list of peerings in a Virtual Network. -## ResourceTags +## VirtualNetworkTap ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **location**: string: Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [VirtualNetworkTapPropertiesFormat](#virtualnetworktappropertiesformat): Virtual Network Tap properties. +* **tags**: [ResourceTags](#resourcetags): Resource tags. +* **type**: string (ReadOnly): Resource type. -## VirtualRouterPropertiesFormat +## VirtualNetworkTapPropertiesFormat ### Properties -* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. -* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. -* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **destinationLoadBalancerFrontEndIPConfiguration**: [FrontendIPConfiguration](#frontendipconfiguration): Frontend IP address of the load balancer. +* **destinationNetworkInterfaceIPConfiguration**: [NetworkInterfaceIPConfiguration](#networkinterfaceipconfiguration): IPConfiguration in a network interface. +* **destinationPort**: int: The VXLAN destination port that will receive the tapped traffic. +* **networkInterfaceTapConfigurations**: [NetworkInterfaceTapConfiguration](#networkinterfacetapconfiguration)[] (ReadOnly): Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualRouterAsn**: int: VirtualRouter ASN. -* **virtualRouterIps**: string[]: VirtualRouter IPs. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resourceGuid**: string (ReadOnly): The resource GUID property of the virtual network tap resource. ## VirtualRouterPeeringProperties ### Properties @@ -4177,6 +4172,15 @@ * **peerIp**: string: Peer IP. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +## VirtualRouterPropertiesFormat +### Properties +* **hostedGateway**: [SubResource](#subresource): Reference to another subresource. +* **hostedSubnet**: [SubResource](#subresource): Reference to another subresource. +* **peerings**: [SubResource](#subresource)[] (ReadOnly): List of references to VirtualRouterPeerings. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualRouterAsn**: int: VirtualRouter ASN. +* **virtualRouterIps**: string[]: VirtualRouter IPs. + ## VirtualWanProperties ### Properties * **allowBranchToBranchTraffic**: bool: True if branch to branch traffic is allowed. @@ -4188,80 +4192,85 @@ * **virtualHubs**: [SubResource](#subresource)[] (ReadOnly): List of VirtualHubs in the VirtualWAN. * **vpnSites**: [SubResource](#subresource)[] (ReadOnly): List of VpnSites in the VirtualWAN. -## ResourceTags +## VnetRoute ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **bgpConnections**: [SubResource](#subresource)[] (ReadOnly): The list of references to HubBgpConnection objects. +* **staticRoutes**: [StaticRoute](#staticroute)[]: List of all Static Routes. -## VpnGatewayProperties +## VpnClientConfiguration ### Properties -* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. -* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. -* **enableBgpRouteTranslationForNat**: bool: Enable BGP routes translation for NAT on this VpnGateway. -* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. -* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. -* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **virtualHub**: [SubResource](#subresource): Reference to another subresource. -* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. +* **aadAudience**: string: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadIssuer**: string: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **aadTenant**: string: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. +* **radiusServerAddress**: string: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. +* **radiusServers**: [RadiusServer](#radiusserver)[]: The radiusServers property for multiple radius server configuration. +* **radiusServerSecret**: string: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. +* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the virtual network gateway.. +* **vpnClientAddressPool**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for virtual network gateway P2S client. +* **vpnClientProtocols**: 'IkeV2' | 'OpenVPN' | 'SSTP' | string[]: VpnClientProtocols for Virtual network gateway. +* **vpnClientRevokedCertificates**: [VpnClientRevokedCertificate](#vpnclientrevokedcertificate)[]: VpnClientRevokedCertificate for Virtual network gateway. +* **vpnClientRootCertificates**: [VpnClientRootCertificate](#vpnclientrootcertificate)[]: VpnClientRootCertificate for virtual network gateway. -## VpnConnection +## VpnClientConnectionHealth +### Properties +* **allocatedIpAddresses**: string[]: List of allocated ip addresses to the connected p2s vpn clients. +* **totalEgressBytesTransferred**: int (ReadOnly): Total of the Egress Bytes Transferred in this connection. +* **totalIngressBytesTransferred**: int (ReadOnly): Total of the Ingress Bytes Transferred in this P2S Vpn connection. +* **vpnClientConnectionsCount**: int: The total of p2s vpn clients connected at this time to this P2SVpnGateway. + +## VpnClientRevokedCertificate ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnConnectionProperties](#vpnconnectionproperties): Parameters for VpnConnection. +* **properties**: [VpnClientRevokedCertificatePropertiesFormat](#vpnclientrevokedcertificatepropertiesformat): Properties of the revoked VPN client certificate of virtual network gateway. -## VpnConnectionProperties +## VpnClientRevokedCertificatePropertiesFormat ### Properties -* **connectionBandwidth**: int: Expected bandwidth in MBPS. -* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. -* **dpdTimeoutSeconds**: int: DPD timeout in seconds for vpn connection. -* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **enableBgp**: bool: EnableBgp flag. -* **enableInternetSecurity**: bool: Enable internet security. -* **enableRateLimiting**: bool: EnableBgp flag. -* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **remoteVpnSite**: [SubResource](#subresource): Reference to another subresource. -* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. -* **routingWeight**: int: Routing weight for vpn connection. -* **sharedKey**: string: SharedKey for the vpn connection. -* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. -* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. -* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. -* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. + +## VpnClientRootCertificate +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnClientRootCertificatePropertiesFormat](#vpnclientrootcertificatepropertiesformat) (Required): Properties of SSL certificates of application gateway. + +## VpnClientRootCertificatePropertiesFormat +### Properties +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **publicCertData**: string (Required): The certificate public data. -## VpnSiteLinkConnection +## VpnConnection ### Properties * **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. * **id**: string: Resource ID. * **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. -* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. -* **type**: string (ReadOnly): Resource type. +* **properties**: [VpnConnectionProperties](#vpnconnectionproperties): Parameters for VpnConnection. -## VpnSiteLinkConnectionProperties +## VpnConnectionProperties ### Properties * **connectionBandwidth**: int: Expected bandwidth in MBPS. * **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **dpdTimeoutSeconds**: int: DPD timeout in seconds for vpn connection. * **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. -* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. * **enableBgp**: bool: EnableBgp flag. +* **enableInternetSecurity**: bool: Enable internet security. * **enableRateLimiting**: bool: EnableBgp flag. * **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. -* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. * **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **remoteVpnSite**: [SubResource](#subresource): Reference to another subresource. +* **routingConfiguration**: [RoutingConfiguration](#routingconfiguration): Routing Configuration indicating the associated and propagated route tables for this connection. * **routingWeight**: int: Routing weight for vpn connection. * **sharedKey**: string: SharedKey for the vpn connection. +* **trafficSelectorPolicies**: [TrafficSelectorPolicy](#trafficselectorpolicy)[]: The Traffic Selector Policies to be considered by this connection. * **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. * **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. * **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. -* **vpnGatewayCustomBgpAddresses**: [GatewayCustomBgpIpAddressIpConfiguration](#gatewaycustombgpipaddressipconfiguration)[]: vpnGatewayCustomBgpAddresses used by this connection. -* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. -* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. +* **vpnLinkConnections**: [VpnSiteLinkConnection](#vpnsitelinkconnection)[]: List of all vpn site link connections to the gateway. ## VpnGatewayIpConfiguration ### Properties @@ -4288,50 +4297,32 @@ * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. * **type**: 'Dynamic' | 'Static' | string: The type of NAT rule for VPN NAT. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VpnServerConfigurationProperties +## VpnGatewayProperties ### Properties -* **aadAuthenticationParameters**: [AadAuthenticationParameters](#aadauthenticationparameters): AAD Vpn authentication type related parameters. -* **configurationPolicyGroups**: [VpnServerConfigurationPolicyGroup](#vpnserverconfigurationpolicygroup)[]: List of all VpnServerConfigurationPolicyGroups. -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **name**: string: The name of the VpnServerConfiguration that is unique within a resource group. -* **p2SVpnGateways**: [P2SVpnGateway](#p2svpngateway)[] (ReadOnly): List of references to P2SVpnGateways. -* **provisioningState**: string (ReadOnly): The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. -* **radiusClientRootCertificates**: [VpnServerConfigRadiusClientRootCertificate](#vpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of VpnServerConfiguration. -* **radiusServerAddress**: string: The radius server address property of the VpnServerConfiguration resource for point to site client connection. -* **radiusServerRootCertificates**: [VpnServerConfigRadiusServerRootCertificate](#vpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of VpnServerConfiguration. -* **radiusServers**: [RadiusServer](#radiusserver)[]: Multiple Radius Server configuration for VpnServerConfiguration. -* **radiusServerSecret**: string: The radius secret property of the VpnServerConfiguration resource for point to site client connection. -* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the VpnServerConfiguration. -* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for VpnServerConfiguration. -* **vpnClientRevokedCertificates**: [VpnServerConfigVpnClientRevokedCertificate](#vpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of VpnServerConfiguration. -* **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. -* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. +* **bgpSettings**: [BgpSettings](#bgpsettings): BGP settings details. +* **connections**: [VpnConnection](#vpnconnection)[]: List of all vpn connections to the gateway. +* **enableBgpRouteTranslationForNat**: bool: Enable BGP routes translation for NAT on this VpnGateway. +* **ipConfigurations**: [VpnGatewayIpConfiguration](#vpngatewayipconfiguration)[] (ReadOnly): List of all IPs configured on the gateway. +* **isRoutingPreferenceInternet**: bool: Enable Routing Preference property for the Public IP Interface of the VpnGateway. +* **natRules**: [VpnGatewayNatRule](#vpngatewaynatrule)[]: List of all the nat Rules associated with the gateway. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **virtualHub**: [SubResource](#subresource): Reference to another subresource. +* **vpnGatewayScaleUnit**: int: The scale unit for this vpn gateway. -## AadAuthenticationParameters +## VpnLinkBgpSettings ### Properties -* **aadAudience**: string: AAD Vpn authentication parameter AAD audience. -* **aadIssuer**: string: AAD Vpn authentication parameter AAD issuer. -* **aadTenant**: string: AAD Vpn authentication parameter AAD tenant. +* **asn**: int: The BGP speaker's ASN. +* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. -## P2SVpnGateway +## VpnLinkProviderProperties ### Properties -* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. -* **id**: string: Resource ID. -* **location**: string: Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [P2SVpnGatewayProperties](#p2svpngatewayproperties): Parameters for P2SVpnGateway. -* **tags**: [ResourceTags](#resourcetags): Resource tags. -* **type**: string (ReadOnly): Resource type. +* **linkProviderName**: string: Name of the link provider. +* **linkSpeedInMbps**: int: Link speed. -## ResourceTags +## VpnNatRuleMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addressSpace**: string: Address space for Vpn NatRule mapping. +* **portRange**: string: Port range for Vpn NatRule mapping. ## VpnServerConfigRadiusClientRootCertificate ### Properties @@ -4343,49 +4334,56 @@ * **name**: string: The certificate name. * **publicCertData**: string: The certificate public data. -## VpnServerConfigVpnClientRevokedCertificate -### Properties -* **name**: string: The certificate name. -* **thumbprint**: string: The revoked VPN client certificate thumbprint. - -## VpnServerConfigVpnClientRootCertificate +## VpnServerConfigurationPolicyGroup ### Properties -* **name**: string: The certificate name. -* **publicCertData**: string: The certificate public data. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnServerConfigurationPolicyGroupProperties](#vpnserverconfigurationpolicygroupproperties): Parameters for VpnServerConfigurationPolicyGroup. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## VpnServerConfigurationPolicyGroupMember ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **attributeType**: 'AADGroupId' | 'CertificateGroupId' | 'RadiusAzureGroupId' | string: The Vpn Policy member attribute type. +* **attributeValue**: string: The value of Attribute used for this VpnServerConfigurationPolicyGroupMember. +* **name**: string: Name of the VpnServerConfigurationPolicyGroupMember. -## VpnSiteProperties +## VpnServerConfigurationPolicyGroupProperties ### Properties -* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. -* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. -* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. -* **ipAddress**: string: The ip-address for the vpn-site. -* **isSecuritySite**: bool: IsSecuritySite flag. -* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **isDefault**: bool: Shows if this is a Default VpnServerConfigurationPolicyGroup or not. +* **p2SConnectionConfigurations**: [SubResource](#subresource)[] (ReadOnly): List of references to P2SConnectionConfigurations. +* **policyMembers**: [VpnServerConfigurationPolicyGroupMember](#vpnserverconfigurationpolicygroupmember)[]: Multiple PolicyMembers for VpnServerConfigurationPolicyGroup. +* **priority**: int: Priority for VpnServerConfigurationPolicyGroup. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **siteKey**: string: The key for vpn-site that can be used for connections. -* **virtualWan**: [SubResource](#subresource): Reference to another subresource. -* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## DeviceProperties +## VpnServerConfigurationProperties ### Properties -* **deviceModel**: string: Model of the device. -* **deviceVendor**: string: Name of the device Vendor. -* **linkSpeedInMbps**: int: Link speed. +* **aadAuthenticationParameters**: [AadAuthenticationParameters](#aadauthenticationparameters): AAD Vpn authentication type related parameters. +* **configurationPolicyGroups**: [VpnServerConfigurationPolicyGroup](#vpnserverconfigurationpolicygroup)[]: List of all VpnServerConfigurationPolicyGroups. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **name**: string: The name of the VpnServerConfiguration that is unique within a resource group. +* **p2SVpnGateways**: [P2SVpnGateway](#p2svpngateway)[] (ReadOnly): List of references to P2SVpnGateways. +* **provisioningState**: string (ReadOnly): The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. +* **radiusClientRootCertificates**: [VpnServerConfigRadiusClientRootCertificate](#vpnserverconfigradiusclientrootcertificate)[]: Radius client root certificate of VpnServerConfiguration. +* **radiusServerAddress**: string: The radius server address property of the VpnServerConfiguration resource for point to site client connection. +* **radiusServerRootCertificates**: [VpnServerConfigRadiusServerRootCertificate](#vpnserverconfigradiusserverrootcertificate)[]: Radius Server root certificate of VpnServerConfiguration. +* **radiusServers**: [RadiusServer](#radiusserver)[]: Multiple Radius Server configuration for VpnServerConfiguration. +* **radiusServerSecret**: string: The radius secret property of the VpnServerConfiguration resource for point to site client connection. +* **vpnAuthenticationTypes**: 'AAD' | 'Certificate' | 'Radius' | string[]: VPN authentication types for the VpnServerConfiguration. +* **vpnClientIpsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: VpnClientIpsecPolicies for VpnServerConfiguration. +* **vpnClientRevokedCertificates**: [VpnServerConfigVpnClientRevokedCertificate](#vpnserverconfigvpnclientrevokedcertificate)[]: VPN client revoked certificate of VpnServerConfiguration. +* **vpnClientRootCertificates**: [VpnServerConfigVpnClientRootCertificate](#vpnserverconfigvpnclientrootcertificate)[]: VPN client root certificate of VpnServerConfiguration. +* **vpnProtocols**: 'IkeV2' | 'OpenVPN' | string[]: VPN protocols for the VpnServerConfiguration. -## O365PolicyProperties +## VpnServerConfigVpnClientRevokedCertificate ### Properties -* **breakOutCategories**: [O365BreakOutCategoryPolicies](#o365breakoutcategorypolicies): Office365 breakout categories. +* **name**: string: The certificate name. +* **thumbprint**: string: The revoked VPN client certificate thumbprint. -## O365BreakOutCategoryPolicies +## VpnServerConfigVpnClientRootCertificate ### Properties -* **allow**: bool: Flag to control allow category. -* **default**: bool: Flag to control default category. -* **optimize**: bool: Flag to control optimize category. +* **name**: string: The certificate name. +* **publicCertData**: string: The certificate public data. ## VpnSiteLink ### Properties @@ -4395,6 +4393,35 @@ * **properties**: [VpnSiteLinkProperties](#vpnsitelinkproperties): Parameters for VpnSite. * **type**: string (ReadOnly): Resource type. +## VpnSiteLinkConnection +### Properties +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **id**: string: Resource ID. +* **name**: string: The name of the resource that is unique within a resource group. This name can be used to access the resource. +* **properties**: [VpnSiteLinkConnectionProperties](#vpnsitelinkconnectionproperties): Parameters for VpnConnection. +* **type**: string (ReadOnly): Resource type. + +## VpnSiteLinkConnectionProperties +### Properties +* **connectionBandwidth**: int: Expected bandwidth in MBPS. +* **connectionStatus**: 'Connected' | 'Connecting' | 'NotConnected' | 'Unknown' | string (ReadOnly): The current state of the vpn connection. +* **egressBytesTransferred**: int (ReadOnly): Egress bytes transferred. +* **egressNatRules**: [SubResource](#subresource)[]: List of egress NatRules. +* **enableBgp**: bool: EnableBgp flag. +* **enableRateLimiting**: bool: EnableBgp flag. +* **ingressBytesTransferred**: int (ReadOnly): Ingress bytes transferred. +* **ingressNatRules**: [SubResource](#subresource)[]: List of ingress NatRules. +* **ipsecPolicies**: [IpsecPolicy](#ipsecpolicy)[]: The IPSec Policies to be considered by this connection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **routingWeight**: int: Routing weight for vpn connection. +* **sharedKey**: string: SharedKey for the vpn connection. +* **useLocalAzureIpAddress**: bool: Use local azure ip to initiate connection. +* **usePolicyBasedTrafficSelectors**: bool: Enable policy-based traffic selectors. +* **vpnConnectionProtocolType**: 'IKEv1' | 'IKEv2' | string: Gateway connection protocol. +* **vpnGatewayCustomBgpAddresses**: [GatewayCustomBgpIpAddressIpConfiguration](#gatewaycustombgpipaddressipconfiguration)[]: vpnGatewayCustomBgpAddresses used by this connection. +* **vpnLinkConnectionMode**: 'Default' | 'InitiatorOnly' | 'ResponderOnly' | string: Vpn link connection mode. +* **vpnSiteLink**: [SubResource](#subresource): Reference to another subresource. + ## VpnSiteLinkProperties ### Properties * **bgpProperties**: [VpnLinkBgpSettings](#vpnlinkbgpsettings): BGP settings details for a link. @@ -4403,63 +4430,36 @@ * **linkProperties**: [VpnLinkProviderProperties](#vpnlinkproviderproperties): List of properties of a link provider. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## VpnLinkBgpSettings -### Properties -* **asn**: int: The BGP speaker's ASN. -* **bgpPeeringAddress**: string: The BGP peering address and BGP identifier of this BGP speaker. - -## VpnLinkProviderProperties -### Properties -* **linkProviderName**: string: Name of the link provider. -* **linkSpeedInMbps**: int: Link speed. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignatureOverridesFilterValuesQuery -### Properties -* **filterName**: string (WriteOnly): Describes the name of the column which values will be returned - -## SignatureOverridesFilterValuesResponse -### Properties -* **filterValues**: string[] (ReadOnly): Describes the possible values - -## IdpsQueryObject -### Properties -* **filters**: [FilterItems](#filteritems)[] (WriteOnly): Describers the filters to filter response by -* **orderBy**: [OrderBy](#orderby) (WriteOnly): Describes a column to sort -* **resultsPerPage**: int (WriteOnly): The number of the results to return in each page -* **search**: string (WriteOnly): Search term in all columns -* **skip**: int (WriteOnly): The number of records matching the filter to skip - -## FilterItems -### Properties -* **field**: string (WriteOnly): The name of the field we would like to filter -* **values**: string[] (WriteOnly): List of values to filter the current field by - -## OrderBy +## VpnSiteProperties ### Properties -* **field**: string (WriteOnly): Describes the actual column name to sort by -* **order**: 'Ascending' | 'Descending' | string (WriteOnly): Describes if results should be in ascending/descending order +* **addressSpace**: [AddressSpace](#addressspace): AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. +* **bgpProperties**: [BgpSettings](#bgpsettings): BGP settings details. +* **deviceProperties**: [DeviceProperties](#deviceproperties): List of properties of the device. +* **ipAddress**: string: The ip-address for the vpn-site. +* **isSecuritySite**: bool: IsSecuritySite flag. +* **o365Policy**: [O365PolicyProperties](#o365policyproperties): The Office365 breakout policy. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **siteKey**: string: The key for vpn-site that can be used for connections. +* **virtualWan**: [SubResource](#subresource): Reference to another subresource. +* **vpnSiteLinks**: [VpnSiteLink](#vpnsitelink)[]: List of all vpn site links. -## QueryResults +## WebApplicationFirewallCustomRule ### Properties -* **matchingRecordsCount**: int (ReadOnly): Number of total records matching the query. -* **signatures**: [SingleQueryResult](#singlequeryresult)[] (ReadOnly): Array containing the results of the query +* **action**: 'Allow' | 'Block' | 'Log' | string (Required): Type of Actions. +* **etag**: string (ReadOnly): A unique read-only string that changes whenever the resource is updated. +* **matchConditions**: [MatchCondition](#matchcondition)[] (Required): List of match conditions. +* **name**: string: The name of the resource that is unique within a policy. This name can be used to access the resource. +* **priority**: int (Required): Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. +* **ruleType**: 'Invalid' | 'MatchRule' | string (Required): The rule type. -## SingleQueryResult +## WebApplicationFirewallPolicyPropertiesFormat ### Properties -* **description**: string (ReadOnly): Describes what is the signature enforces -* **destinationPorts**: string[] (ReadOnly): Describes the list of destination ports related to this signature -* **direction**: int (ReadOnly): Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional -* **group**: string (ReadOnly): Describes the groups the signature belongs to -* **inheritedFromParentPolicy**: bool (ReadOnly): Describes if this override is inherited from base policy or not -* **lastUpdated**: string (ReadOnly): Describes the last updated time of the signature (provided from 3rd party vendor) -* **mode**: int (ReadOnly): The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny -* **protocol**: string (ReadOnly): Describes the protocol the signatures is being enforced in -* **severity**: int (ReadOnly): Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High -* **signatureId**: int (ReadOnly): The ID of the signature -* **sourcePorts**: string[] (ReadOnly): Describes the list of source ports related to this signature +* **applicationGateways**: [ApplicationGateway](#applicationgateway)[] (ReadOnly): A collection of references to application gateways. +* **customRules**: [WebApplicationFirewallCustomRule](#webapplicationfirewallcustomrule)[]: The custom rules inside the policy. +* **httpListeners**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway http listeners. +* **managedRules**: [ManagedRulesDefinition](#managedrulesdefinition) (Required): Allow to exclude some variable satisfy the condition for the WAF check. +* **pathBasedRules**: [SubResource](#subresource)[] (ReadOnly): A collection of references to application gateway path rules. +* **policySettings**: [PolicySettings](#policysettings): Defines contents of a web application firewall global configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **resourceState**: 'Creating' | 'Deleting' | 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string (ReadOnly): Resource status of the policy. diff --git a/generated/network/microsoft.network/2022-02-01-preview/types.md b/generated/network/microsoft.network/2022-02-01-preview/types.md index cc6d07838b..dfb356c8f7 100644 --- a/generated/network/microsoft.network/2022-02-01-preview/types.md +++ b/generated/network/microsoft.network/2022-02-01-preview/types.md @@ -204,99 +204,92 @@ * **Input**: [QueryRequestOptions](#queryrequestoptions) * **Output**: [NetworkManagerEffectiveSecurityAdminRulesListResult](#networkmanagereffectivesecurityadminruleslistresult) -## NetworkManagerConnectionProperties -### Properties -* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. -* **description**: string: A description of the scope connection. -* **networkManagerId**: string: Network Manager Id. +## ActiveBaseSecurityAdminRule +* **Discriminator**: kind -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### Base Properties +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationDescription**: string (ReadOnly): A description of the security admin configuration. +* **id**: string (ReadOnly): Resource ID. +* **region**: string (ReadOnly): Deployment region. +* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection +* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. +* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +### ActiveSecurityAdminRule +#### Properties +* **kind**: 'Custom' (Required): Whether the rule is custom or default. +* **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. -## NetworkManagerProperties -### Properties -* **description**: string: A description of the network manager. -* **networkManagerScopeAccesses**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (Required): Scope Access. -* **networkManagerScopes**: [NetworkManagerPropertiesNetworkManagerScopes](#networkmanagerpropertiesnetworkmanagerscopes) (Required): Scope of Network Manager. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### ActiveDefaultSecurityAdminRule +#### Properties +* **kind**: 'Default' (Required): Whether the rule is custom or default. +* **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. -## NetworkManagerPropertiesNetworkManagerScopes -### Properties -* **crossTenantScopes**: [CrossTenantScopes](#crosstenantscopes)[] (ReadOnly): List of cross tenant scopes. -* **managementGroups**: string[]: List of management groups. -* **subscriptions**: string[]: List of subscriptions. -## CrossTenantScopes -### Properties -* **managementGroups**: string[] (ReadOnly): List of management groups. -* **subscriptions**: string[] (ReadOnly): List of subscriptions. -* **tenantId**: string (ReadOnly): Tenant ID. +## ActiveBaseSecurityUserRule +* **Discriminator**: kind -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationDescription**: string (ReadOnly): A description of the security user configuration. +* **id**: string (ReadOnly): Resource ID. +* **region**: string (ReadOnly): Deployment region. +* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection +* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. +* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +### ActiveSecurityUserRule +#### Properties +* **kind**: 'Custom' (Required): Whether the rule is custom or default. +* **properties**: [UserRulePropertiesFormat](#userrulepropertiesformat) (ReadOnly): Security rule resource. -## ConnectivityConfigurationProperties -### Properties -* **appliesToGroups**: [ConnectivityGroupItem](#connectivitygroupitem)[] (Required): Groups for configuration -* **connectivityTopology**: 'HubAndSpoke' | 'Mesh' | string (Required): Connectivity topology type. -* **deleteExistingPeering**: 'False' | 'True' | string: Flag if need to remove current existing peerings. -* **description**: string: A description of the connectivity configuration. -* **hubs**: [Hub](#hub)[]: List of hubItems -* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +### ActiveDefaultSecurityUserRule +#### Properties +* **kind**: 'Default' (Required): Whether the rule is custom or default. +* **properties**: [DefaultUserRulePropertiesFormat](#defaultuserrulepropertiesformat) (ReadOnly): Security default user rule resource. -## ConnectivityGroupItem + +## ActiveConfigurationParameter ### Properties -* **groupConnectivity**: 'DirectlyConnected' | 'None' | string (Required): Group connectivity type. -* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. -* **networkGroupId**: string (Required): Network group Id. -* **useHubGateway**: 'False' | 'True' | string: Flag if need to use hub gateway. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## Hub +## ActiveConfigurationParameter ### Properties -* **resourceId**: string: Resource Id. -* **resourceType**: string: Resource Type. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## NetworkGroupProperties +## ActiveConfigurationParameter ### Properties -* **description**: string: A description of the network group. -* **memberType**: string (Required): Group member type. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **regions**: string[] (WriteOnly): List of regions. +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## StaticMemberProperties +## ActiveConnectivityConfiguration ### Properties -* **resourceId**: string: Resource Id. +* **commitTime**: string (ReadOnly): Deployment time string. +* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration +* **region**: string (ReadOnly): Deployment region. -## ScopeConnectionProperties +## ActiveConnectivityConfigurationsListResult ### Properties -* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. -* **description**: string: A description of the scope connection. -* **resourceId**: string: Resource ID. -* **tenantId**: string: Tenant ID. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveConnectivityConfiguration](#activeconnectivityconfiguration)[] (ReadOnly): Gets a page of active connectivity configurations. -## SecurityAdminConfigurationPropertiesFormat +## ActiveSecurityAdminRulesListResult ### Properties -* **applyOnNetworkIntentPolicyBasedServices**: 'All' | 'None' | string[]: Enum list of network intent policy based services. -* **description**: string: A description of the security configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveBaseSecurityAdminRule](#activebasesecurityadminrule)[] (ReadOnly): Gets a page of active security admin rules. -## AdminRuleCollectionPropertiesFormat +## ActiveSecurityUserRulesListResult ### Properties -* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (Required): Groups for configuration -* **description**: string: A description of the admin rule collection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [ActiveBaseSecurityUserRule](#activebasesecurityuserrule)[] (ReadOnly): Gets a page of active security user rules. -## NetworkManagerSecurityGroupItem +## AddressPrefixItem ### Properties -* **networkGroupId**: string (Required): Network manager group Id. +* **addressPrefix**: string: Address prefix. +* **addressPrefixType**: 'IPPrefix' | 'ServiceTag' | string: Address prefix type. ## AdminPropertiesFormat ### Properties @@ -311,10 +304,39 @@ * **sourcePortRanges**: string[]: The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. -## AddressPrefixItem +## AdminRuleCollectionPropertiesFormat ### Properties -* **addressPrefix**: string: Address prefix. -* **addressPrefixType**: 'IPPrefix' | 'ServiceTag' | string: Address prefix type. +* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (Required): Groups for configuration +* **description**: string: A description of the admin rule collection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ConfigurationGroup +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [NetworkGroupProperties](#networkgroupproperties) (ReadOnly): Properties of network group + +## ConnectivityConfigurationProperties +### Properties +* **appliesToGroups**: [ConnectivityGroupItem](#connectivitygroupitem)[] (Required): Groups for configuration +* **connectivityTopology**: 'HubAndSpoke' | 'Mesh' | string (Required): Connectivity topology type. +* **deleteExistingPeering**: 'False' | 'True' | string: Flag if need to remove current existing peerings. +* **description**: string: A description of the connectivity configuration. +* **hubs**: [Hub](#hub)[]: List of hubItems +* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## ConnectivityGroupItem +### Properties +* **groupConnectivity**: 'DirectlyConnected' | 'None' | string (Required): Group connectivity type. +* **isGlobal**: 'False' | 'True' | string: Flag if global mesh is supported. +* **networkGroupId**: string (Required): Network group Id. +* **useHubGateway**: 'False' | 'True' | string: Flag if need to use hub gateway. + +## CrossTenantScopes +### Properties +* **managementGroups**: string[] (ReadOnly): List of management groups. +* **subscriptions**: string[] (ReadOnly): List of subscriptions. +* **tenantId**: string (ReadOnly): Tenant ID. ## DefaultAdminPropertiesFormat ### Properties @@ -330,29 +352,6 @@ * **sourcePortRanges**: string[] (ReadOnly): The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[] (ReadOnly): The CIDR or source IP ranges. -## SecurityUserConfigurationPropertiesFormat -### Properties -* **deleteExistingNSGs**: 'False' | 'True' | string: Flag if need to delete existing network security groups. -* **description**: string: A description of the security user configuration. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## UserRuleCollectionPropertiesFormat -### Properties -* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (Required): Groups for configuration -* **description**: string: A description of the user rule collection. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. - -## UserRulePropertiesFormat -### Properties -* **description**: string: A description for this rule. -* **destinationPortRanges**: string[]: The destination port ranges. -* **destinations**: [AddressPrefixItem](#addressprefixitem)[]: The destination address prefixes. CIDR or destination IP ranges. -* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic. -* **protocol**: 'Ah' | 'Any' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -* **sourcePortRanges**: string[]: The source port ranges. -* **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. - ## DefaultUserRulePropertiesFormat ### Properties * **description**: string (ReadOnly): A description for this rule. Restricted to 140 chars. @@ -365,103 +364,69 @@ * **sourcePortRanges**: string[] (ReadOnly): The source port ranges. * **sources**: [AddressPrefixItem](#addressprefixitem)[] (ReadOnly): The CIDR or source IP ranges. -## ActiveConfigurationParameter -### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. - -## ActiveConnectivityConfigurationsListResult -### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveConnectivityConfiguration](#activeconnectivityconfiguration)[] (ReadOnly): Gets a page of active connectivity configurations. - -## ActiveConnectivityConfiguration -### Properties -* **commitTime**: string (ReadOnly): Deployment time string. -* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration -* **region**: string (ReadOnly): Deployment region. - -## ConfigurationGroup -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [NetworkGroupProperties](#networkgroupproperties) (ReadOnly): Properties of network group - -## ActiveConfigurationParameter -### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. - -## ActiveSecurityAdminRulesListResult -### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveBaseSecurityAdminRule](#activebasesecurityadminrule)[] (ReadOnly): Gets a page of active security admin rules. - -## ActiveBaseSecurityAdminRule +## EffectiveBaseSecurityAdminRule * **Discriminator**: kind ### Base Properties -* **commitTime**: string (ReadOnly): Deployment time string. * **configurationDescription**: string (ReadOnly): A description of the security admin configuration. * **id**: string (ReadOnly): Resource ID. -* **region**: string (ReadOnly): Deployment region. * **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection * **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. * **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### ActiveSecurityAdminRule +### EffectiveSecurityAdminRule #### Properties * **kind**: 'Custom' (Required): Whether the rule is custom or default. * **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. -### ActiveDefaultSecurityAdminRule +### EffectiveDefaultSecurityAdminRule #### Properties * **kind**: 'Default' (Required): Whether the rule is custom or default. * **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. -## ActiveConfigurationParameter +## EffectiveConnectivityConfiguration ### Properties -* **regions**: string[] (WriteOnly): List of regions. -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration -## ActiveSecurityUserRulesListResult +## EffectiveVirtualNetwork ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [ActiveBaseSecurityUserRule](#activebasesecurityuserrule)[] (ReadOnly): Gets a page of active security user rules. +* **id**: string (ReadOnly): Effective vnet Id. +* **location**: string (ReadOnly): Location of vnet. +* **membershipType**: 'Dynamic' | 'Static' | string (ReadOnly): Membership Type. -## ActiveBaseSecurityUserRule -* **Discriminator**: kind +## EffectiveVirtualNetworksListResult +### Properties +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork -### Base Properties -* **commitTime**: string (ReadOnly): Deployment time string. -* **configurationDescription**: string (ReadOnly): A description of the security user configuration. -* **id**: string (ReadOnly): Resource ID. -* **region**: string (ReadOnly): Deployment region. -* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection -* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. -* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### ActiveSecurityUserRule -#### Properties -* **kind**: 'Custom' (Required): Whether the rule is custom or default. -* **properties**: [UserRulePropertiesFormat](#userrulepropertiesformat) (ReadOnly): Security rule resource. +## EffectiveVirtualNetworksListResult +### Properties +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork -### ActiveDefaultSecurityUserRule -#### Properties -* **kind**: 'Default' (Required): Whether the rule is custom or default. -* **properties**: [DefaultUserRulePropertiesFormat](#defaultuserrulepropertiesformat) (ReadOnly): Security default user rule resource. +## EffectiveVirtualNetworksParameter +### Properties +* **conditionalMembers**: string (WriteOnly): Conditional Members. +* **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. +## Hub +### Properties +* **resourceId**: string: Resource Id. +* **resourceType**: string: Resource Type. -## NetworkManagerDeploymentStatusParameter +## NetworkGroupProperties ### Properties -* **deploymentTypes**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (WriteOnly): List of deployment types. -* **regions**: string[] (WriteOnly): List of locations. -* **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. +* **description**: string: A description of the network group. +* **memberType**: string (Required): Group member type. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkManagerDeploymentStatusListResult +## NetworkManagerConnectionProperties ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [NetworkManagerDeploymentStatus](#networkmanagerdeploymentstatus)[] (ReadOnly): Gets a page of Network Manager Deployment Status +* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. +* **description**: string: A description of the scope connection. +* **networkManagerId**: string: Network Manager Id. ## NetworkManagerDeploymentStatus ### Properties @@ -472,72 +437,107 @@ * **errorMessage**: string (ReadOnly): Error Message. * **region**: string (ReadOnly): Region Name. -## EffectiveVirtualNetworksParameter +## NetworkManagerDeploymentStatusListResult ### Properties -* **conditionalMembers**: string (WriteOnly): Conditional Members. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [NetworkManagerDeploymentStatus](#networkmanagerdeploymentstatus)[] (ReadOnly): Gets a page of Network Manager Deployment Status + +## NetworkManagerDeploymentStatusParameter +### Properties +* **deploymentTypes**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (WriteOnly): List of deployment types. +* **regions**: string[] (WriteOnly): List of locations. * **skipToken**: string (WriteOnly): Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. -## EffectiveVirtualNetworksListResult +## NetworkManagerEffectiveConnectivityConfigurationListResult ### Properties * **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork +* **value**: [EffectiveConnectivityConfiguration](#effectiveconnectivityconfiguration)[] (ReadOnly): Gets a page of NetworkManagerEffectiveConnectivityConfiguration -## EffectiveVirtualNetwork +## NetworkManagerEffectiveSecurityAdminRulesListResult ### Properties -* **id**: string (ReadOnly): Effective vnet Id. -* **location**: string (ReadOnly): Location of vnet. -* **membershipType**: 'Dynamic' | 'Static' | string (ReadOnly): Membership Type. +* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **value**: [EffectiveBaseSecurityAdminRule](#effectivebasesecurityadminrule)[] (ReadOnly): Gets a page of NetworkManagerEffectiveSecurityAdminRules + +## NetworkManagerProperties +### Properties +* **description**: string: A description of the network manager. +* **networkManagerScopeAccesses**: 'Connectivity' | 'SecurityAdmin' | 'SecurityUser' | string[] (Required): Scope Access. +* **networkManagerScopes**: [NetworkManagerPropertiesNetworkManagerScopes](#networkmanagerpropertiesnetworkmanagerscopes) (Required): Scope of Network Manager. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. + +## NetworkManagerPropertiesNetworkManagerScopes +### Properties +* **crossTenantScopes**: [CrossTenantScopes](#crosstenantscopes)[] (ReadOnly): List of cross tenant scopes. +* **managementGroups**: string[]: List of management groups. +* **subscriptions**: string[]: List of subscriptions. + +## NetworkManagerSecurityGroupItem +### Properties +* **networkGroupId**: string (Required): Network manager group Id. ## QueryRequestOptions ### Properties * **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## EffectiveVirtualNetworksListResult +## QueryRequestOptions ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveVirtualNetwork](#effectivevirtualnetwork)[] (ReadOnly): Gets a page of EffectiveVirtualNetwork +* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. ## QueryRequestOptions ### Properties * **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -## NetworkManagerEffectiveConnectivityConfigurationListResult +## ResourceTags ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveConnectivityConfiguration](#effectiveconnectivityconfiguration)[] (ReadOnly): Gets a page of NetworkManagerEffectiveConnectivityConfiguration +### Additional Properties +* **Additional Properties Type**: string -## EffectiveConnectivityConfiguration +## ScopeConnectionProperties ### Properties -* **configurationGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ConnectivityConfigurationProperties](#connectivityconfigurationproperties) (ReadOnly): Properties of network manager connectivity configuration +* **connectionState**: 'Conflict' | 'Connected' | 'Pending' | 'Rejected' | 'Revoked' | string (ReadOnly): The current scope connection state. +* **description**: string: A description of the scope connection. +* **resourceId**: string: Resource ID. +* **tenantId**: string: Tenant ID. -## QueryRequestOptions +## SecurityAdminConfigurationPropertiesFormat ### Properties -* **skipToken**: string (WriteOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. +* **applyOnNetworkIntentPolicyBasedServices**: 'All' | 'None' | string[]: Enum list of network intent policy based services. +* **description**: string: A description of the security configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## NetworkManagerEffectiveSecurityAdminRulesListResult +## SecurityUserConfigurationPropertiesFormat ### Properties -* **skipToken**: string (ReadOnly): When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. -* **value**: [EffectiveBaseSecurityAdminRule](#effectivebasesecurityadminrule)[] (ReadOnly): Gets a page of NetworkManagerEffectiveSecurityAdminRules +* **deleteExistingNSGs**: 'False' | 'True' | string: Flag if need to delete existing network security groups. +* **description**: string: A description of the security user configuration. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. -## EffectiveBaseSecurityAdminRule -* **Discriminator**: kind +## StaticMemberProperties +### Properties +* **resourceId**: string: Resource Id. -### Base Properties -* **configurationDescription**: string (ReadOnly): A description of the security admin configuration. -* **id**: string (ReadOnly): Resource ID. -* **ruleCollectionAppliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (ReadOnly): Groups for rule collection -* **ruleCollectionDescription**: string (ReadOnly): A description of the rule collection. -* **ruleGroups**: [ConfigurationGroup](#configurationgroup)[] (ReadOnly): Effective configuration groups. -### EffectiveSecurityAdminRule -#### Properties -* **kind**: 'Custom' (Required): Whether the rule is custom or default. -* **properties**: [AdminPropertiesFormat](#adminpropertiesformat) (ReadOnly): Security admin rule resource. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -### EffectiveDefaultSecurityAdminRule -#### Properties -* **kind**: 'Default' (Required): Whether the rule is custom or default. -* **properties**: [DefaultAdminPropertiesFormat](#defaultadminpropertiesformat) (ReadOnly): Security default admin rule resource. +## UserRuleCollectionPropertiesFormat +### Properties +* **appliesToGroups**: [NetworkManagerSecurityGroupItem](#networkmanagersecuritygroupitem)[] (Required): Groups for configuration +* **description**: string: A description of the user rule collection. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +## UserRulePropertiesFormat +### Properties +* **description**: string: A description for this rule. +* **destinationPortRanges**: string[]: The destination port ranges. +* **destinations**: [AddressPrefixItem](#addressprefixitem)[]: The destination address prefixes. CIDR or destination IP ranges. +* **direction**: 'Inbound' | 'Outbound' | string (Required): The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic. +* **protocol**: 'Ah' | 'Any' | 'Esp' | 'Icmp' | 'Tcp' | 'Udp' | string (Required): Network protocol this rule applies to. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The current provisioning state. +* **sourcePortRanges**: string[]: The source port ranges. +* **sources**: [AddressPrefixItem](#addressprefixitem)[]: The CIDR or source IP ranges. diff --git a/generated/notificationhubs/log.out b/generated/notificationhubs/log.out index 78e12aae33..aea6b87cf6 100644 --- a/generated/notificationhubs/log.out +++ b/generated/notificationhubs/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.notificationhubs-2017-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json:1495:5 @@ -89,11 +89,11 @@ warning | PreCheck/SchemaMissingType | The schema 'DebugSendResult' with an unde warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json:2313:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.notificationhubs-2016-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CheckAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json:1248:5 @@ -164,11 +164,11 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json:1886:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.notificationhubs-2014-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CheckAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json:1109:5 @@ -230,4 +230,4 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json:1750:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms -info | Autorest completed in 9.91s. 6 files generated. +info | Autorest completed in 8.97s. 6 files generated. diff --git a/generated/notificationhubs/microsoft.notificationhubs/2014-09-01/types.md b/generated/notificationhubs/microsoft.notificationhubs/2014-09-01/types.md index 71a90c9846..f9e48c5cc4 100644 --- a/generated/notificationhubs/microsoft.notificationhubs/2014-09-01/types.md +++ b/generated/notificationhubs/microsoft.notificationhubs/2014-09-01/types.md @@ -52,49 +52,6 @@ * **ApiVersion**: 2014-09-01 * **Output**: [ResourceListKeys](#resourcelistkeys) -## NamespaceProperties -### Properties -* **createdAt**: string: The time the namespace was created. -* **critical**: bool: Whether or not the namespace is set as Critical. -* **enabled**: bool: Whether or not the namespace is currently enabled. -* **name**: string: The name of the namespace. -* **namespaceType**: 'Messaging' | 'NotificationHub': Gets or sets the namespace type. -* **provisioningState**: string: Gets or sets provisioning state of the Namespace. -* **region**: 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 -* **scaleUnit**: string: ScaleUnit where the namespace gets created -* **serviceBusEndpoint**: string: Endpoint you can use to perform NotificationHub operations. -* **status**: string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting -* **subscriptionId**: string: The Id of the Azure subscription associated with the namespace. - -## NamespaceCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessAuthorizationRuleProperties -### Properties -* **claimType**: string: The type of the claim. -* **claimValue**: string: The value of the claim. -* **createdTime**: string: The time at which the authorization rule was created. -* **keyName**: string: The name of the key that was used. -* **modifiedTime**: string: The most recent time the rule was updated. -* **primaryKey**: string: The primary key that was used. -* **revision**: int: The revision number for the rule. -* **rights**: 'Listen' | 'Manage' | 'Send'[]: The rights associated with the rule. -* **secondaryKey**: string: The secondary key that was used. - -## NotificationHubProperties -### Properties -* **admCredential**: [AdmCredential](#admcredential): Description of a NotificationHub AdmCredential. -* **apnsCredential**: [ApnsCredential](#apnscredential): Description of a NotificationHub ApnsCredential. -* **authorizationRules**: [SharedAccessAuthorizationRuleProperties](#sharedaccessauthorizationruleproperties)[]: The AuthorizationRules of the created NotificationHub -* **baiduCredential**: [BaiduCredential](#baiducredential): Description of a NotificationHub BaiduCredential. -* **gcmCredential**: [GcmCredential](#gcmcredential): Description of a NotificationHub GcmCredential. -* **mpnsCredential**: [MpnsCredential](#mpnscredential): Description of a NotificationHub MpnsCredential. -* **name**: string: The NotificationHub name. -* **registrationTtl**: string: The RegistrationTtl of the created NotificationHub -* **wnsCredential**: [WnsCredential](#wnscredential): Description of a NotificationHub WnsCredential. - ## AdmCredential ### Properties * **properties**: [AdmCredentialProperties](#admcredentialproperties): Description of a NotificationHub AdmCredential. @@ -145,21 +102,42 @@ * **mpnsCertificate**: string: Gets or sets the MPNS certificate. * **thumbprint**: string: Gets or sets the Mpns certificate Thumbprint -## WnsCredential +## NamespaceCreateOrUpdateParametersTags ### Properties -* **properties**: [WnsCredentialProperties](#wnscredentialproperties): Description of a NotificationHub WnsCredential. +### Additional Properties +* **Additional Properties Type**: string -## WnsCredentialProperties +## NamespaceProperties ### Properties -* **packageSid**: string: Gets or sets the package ID for this credential. -* **secretKey**: string: Gets or sets the secret key. -* **windowsLiveEndpoint**: string: Gets or sets the Windows Live endpoint. +* **createdAt**: string: The time the namespace was created. +* **critical**: bool: Whether or not the namespace is set as Critical. +* **enabled**: bool: Whether or not the namespace is currently enabled. +* **name**: string: The name of the namespace. +* **namespaceType**: 'Messaging' | 'NotificationHub': Gets or sets the namespace type. +* **provisioningState**: string: Gets or sets provisioning state of the Namespace. +* **region**: 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 +* **scaleUnit**: string: ScaleUnit where the namespace gets created +* **serviceBusEndpoint**: string: Endpoint you can use to perform NotificationHub operations. +* **status**: string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting +* **subscriptionId**: string: The Id of the Azure subscription associated with the namespace. ## NotificationHubCreateOrUpdateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## NotificationHubProperties +### Properties +* **admCredential**: [AdmCredential](#admcredential): Description of a NotificationHub AdmCredential. +* **apnsCredential**: [ApnsCredential](#apnscredential): Description of a NotificationHub ApnsCredential. +* **authorizationRules**: [SharedAccessAuthorizationRuleProperties](#sharedaccessauthorizationruleproperties)[]: The AuthorizationRules of the created NotificationHub +* **baiduCredential**: [BaiduCredential](#baiducredential): Description of a NotificationHub BaiduCredential. +* **gcmCredential**: [GcmCredential](#gcmcredential): Description of a NotificationHub GcmCredential. +* **mpnsCredential**: [MpnsCredential](#mpnscredential): Description of a NotificationHub MpnsCredential. +* **name**: string: The NotificationHub name. +* **registrationTtl**: string: The RegistrationTtl of the created NotificationHub +* **wnsCredential**: [WnsCredential](#wnscredential): Description of a NotificationHub WnsCredential. + ## ResourceListKeys ### Properties * **primaryConnectionString**: string (ReadOnly): Gets or sets the primaryConnectionString of the created Namespace AuthorizationRule. @@ -170,3 +148,25 @@ * **primaryConnectionString**: string (ReadOnly): Gets or sets the primaryConnectionString of the created Namespace AuthorizationRule. * **secondaryConnectionString**: string (ReadOnly): Gets or sets the secondaryConnectionString of the created Namespace AuthorizationRule +## SharedAccessAuthorizationRuleProperties +### Properties +* **claimType**: string: The type of the claim. +* **claimValue**: string: The value of the claim. +* **createdTime**: string: The time at which the authorization rule was created. +* **keyName**: string: The name of the key that was used. +* **modifiedTime**: string: The most recent time the rule was updated. +* **primaryKey**: string: The primary key that was used. +* **revision**: int: The revision number for the rule. +* **rights**: 'Listen' | 'Manage' | 'Send'[]: The rights associated with the rule. +* **secondaryKey**: string: The secondary key that was used. + +## WnsCredential +### Properties +* **properties**: [WnsCredentialProperties](#wnscredentialproperties): Description of a NotificationHub WnsCredential. + +## WnsCredentialProperties +### Properties +* **packageSid**: string: Gets or sets the package ID for this credential. +* **secretKey**: string: Gets or sets the secret key. +* **windowsLiveEndpoint**: string: Gets or sets the Windows Live endpoint. + diff --git a/generated/notificationhubs/microsoft.notificationhubs/2016-03-01/types.md b/generated/notificationhubs/microsoft.notificationhubs/2016-03-01/types.md index 51d599deb5..dc244e6944 100644 --- a/generated/notificationhubs/microsoft.notificationhubs/2016-03-01/types.md +++ b/generated/notificationhubs/microsoft.notificationhubs/2016-03-01/types.md @@ -58,54 +58,6 @@ * **ApiVersion**: 2016-03-01 * **Output**: [ResourceListKeys](#resourcelistkeys) -## NamespaceProperties -### Properties -* **createdAt**: string: The time the namespace was created. -* **critical**: bool: Whether or not the namespace is set as Critical. -* **enabled**: bool: Whether or not the namespace is currently enabled. -* **name**: string: The name of the namespace. -* **namespaceType**: 'Messaging' | 'NotificationHub': The namespace type. -* **provisioningState**: string: Provisioning state of the Namespace. -* **region**: 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 -* **scaleUnit**: string: ScaleUnit where the namespace gets created -* **serviceBusEndpoint**: string: Endpoint you can use to perform NotificationHub operations. -* **status**: string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting -* **subscriptionId**: string: The Id of the Azure subscription associated with the namespace. - -## Sku -### Properties -* **capacity**: int: The capacity of the resource -* **family**: string: The Sku Family -* **name**: 'Basic' | 'Free' | 'Standard' | string (Required): Name of the notification hub sku -* **size**: string: The Sku size -* **tier**: string: The tier of particular sku - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessAuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[]: The rights associated with the rule. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NotificationHubProperties -### Properties -* **admCredential**: [AdmCredential](#admcredential): Description of a NotificationHub AdmCredential. -* **apnsCredential**: [ApnsCredential](#apnscredential): Description of a NotificationHub ApnsCredential. -* **authorizationRules**: [SharedAccessAuthorizationRuleProperties](#sharedaccessauthorizationruleproperties)[]: The AuthorizationRules of the created NotificationHub -* **baiduCredential**: [BaiduCredential](#baiducredential): Description of a NotificationHub BaiduCredential. -* **gcmCredential**: [GcmCredential](#gcmcredential): Description of a NotificationHub GcmCredential. -* **mpnsCredential**: [MpnsCredential](#mpnscredential): Description of a NotificationHub MpnsCredential. -* **name**: string: The NotificationHub name. -* **registrationTtl**: string: The RegistrationTtl of the created NotificationHub -* **wnsCredential**: [WnsCredential](#wnscredential): Description of a NotificationHub WnsCredential. - ## AdmCredential ### Properties * **properties**: [AdmCredentialProperties](#admcredentialproperties): Description of a NotificationHub AdmCredential. @@ -156,25 +108,31 @@ * **mpnsCertificate**: string: The MPNS certificate. * **thumbprint**: string: The MPNS certificate Thumbprint -## WnsCredential -### Properties -* **properties**: [WnsCredentialProperties](#wnscredentialproperties): Description of a NotificationHub WnsCredential. - -## WnsCredentialProperties -### Properties -* **packageSid**: string: The package ID for this credential. -* **secretKey**: string: The secret key. -* **windowsLiveEndpoint**: string: The Windows Live endpoint. - -## ResourceTags +## NamespaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string: The time the namespace was created. +* **critical**: bool: Whether or not the namespace is set as Critical. +* **enabled**: bool: Whether or not the namespace is currently enabled. +* **name**: string: The name of the namespace. +* **namespaceType**: 'Messaging' | 'NotificationHub': The namespace type. +* **provisioningState**: string: Provisioning state of the Namespace. +* **region**: 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 +* **scaleUnit**: string: ScaleUnit where the namespace gets created +* **serviceBusEndpoint**: string: Endpoint you can use to perform NotificationHub operations. +* **status**: string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting +* **subscriptionId**: string: The Id of the Azure subscription associated with the namespace. -## ResourceTags +## NotificationHubProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **admCredential**: [AdmCredential](#admcredential): Description of a NotificationHub AdmCredential. +* **apnsCredential**: [ApnsCredential](#apnscredential): Description of a NotificationHub ApnsCredential. +* **authorizationRules**: [SharedAccessAuthorizationRuleProperties](#sharedaccessauthorizationruleproperties)[]: The AuthorizationRules of the created NotificationHub +* **baiduCredential**: [BaiduCredential](#baiducredential): Description of a NotificationHub BaiduCredential. +* **gcmCredential**: [GcmCredential](#gcmcredential): Description of a NotificationHub GcmCredential. +* **mpnsCredential**: [MpnsCredential](#mpnscredential): Description of a NotificationHub MpnsCredential. +* **name**: string: The NotificationHub name. +* **registrationTtl**: string: The RegistrationTtl of the created NotificationHub +* **wnsCredential**: [WnsCredential](#wnscredential): Description of a NotificationHub WnsCredential. ## ResourceListKeys ### Properties @@ -192,3 +150,45 @@ * **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created AuthorizationRule * **secondaryKey**: string (ReadOnly): SecondaryKey of the created AuthorizationRule +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SharedAccessAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[]: The rights associated with the rule. + +## Sku +### Properties +* **capacity**: int: The capacity of the resource +* **family**: string: The Sku Family +* **name**: 'Basic' | 'Free' | 'Standard' | string (Required): Name of the notification hub sku +* **size**: string: The Sku size +* **tier**: string: The tier of particular sku + +## WnsCredential +### Properties +* **properties**: [WnsCredentialProperties](#wnscredentialproperties): Description of a NotificationHub WnsCredential. + +## WnsCredentialProperties +### Properties +* **packageSid**: string: The package ID for this credential. +* **secretKey**: string: The secret key. +* **windowsLiveEndpoint**: string: The Windows Live endpoint. + diff --git a/generated/notificationhubs/microsoft.notificationhubs/2017-04-01/types.md b/generated/notificationhubs/microsoft.notificationhubs/2017-04-01/types.md index d833b24501..c15623128c 100644 --- a/generated/notificationhubs/microsoft.notificationhubs/2017-04-01/types.md +++ b/generated/notificationhubs/microsoft.notificationhubs/2017-04-01/types.md @@ -58,65 +58,6 @@ * **ApiVersion**: 2017-04-01 * **Output**: [ResourceListKeys](#resourcelistkeys) -## NamespaceProperties -### Properties -* **createdAt**: string: The time the namespace was created. -* **critical**: bool: Whether or not the namespace is set as Critical. -* **dataCenter**: string: Data center for the namespace -* **enabled**: bool: Whether or not the namespace is currently enabled. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **name**: string: The name of the namespace. -* **namespaceType**: 'Messaging' | 'NotificationHub': The namespace type. -* **provisioningState**: string: Provisioning state of the Namespace. -* **region**: 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 -* **scaleUnit**: string: ScaleUnit where the namespace gets created -* **serviceBusEndpoint**: string: Endpoint you can use to perform NotificationHub operations. -* **status**: string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting -* **subscriptionId**: string: The Id of the Azure subscription associated with the namespace. -* **updatedAt**: string: The time the namespace was updated. - -## Sku -### Properties -* **capacity**: int: The capacity of the resource -* **family**: string: The Sku Family -* **name**: 'Basic' | 'Free' | 'Standard' | string (Required): Name of the notification hub sku -* **size**: string: The Sku size -* **tier**: string: The tier of particular sku - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessAuthorizationRuleProperties -### Properties -* **claimType**: string (ReadOnly): A string that describes the claim type -* **claimValue**: string (ReadOnly): A string that describes the claim value -* **createdTime**: string (ReadOnly): The created time for this rule -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **modifiedTime**: string (ReadOnly): The last modified time for this rule -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **revision**: int (ReadOnly): The revision number for the rule -* **rights**: 'Listen' | 'Manage' | 'Send'[]: The rights associated with the rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NotificationHubProperties -### Properties -* **admCredential**: [AdmCredential](#admcredential): Description of a NotificationHub AdmCredential. -* **apnsCredential**: [ApnsCredential](#apnscredential): Description of a NotificationHub ApnsCredential. -* **authorizationRules**: [SharedAccessAuthorizationRuleProperties](#sharedaccessauthorizationruleproperties)[]: The AuthorizationRules of the created NotificationHub -* **baiduCredential**: [BaiduCredential](#baiducredential): Description of a NotificationHub BaiduCredential. -* **gcmCredential**: [GcmCredential](#gcmcredential): Description of a NotificationHub GcmCredential. -* **mpnsCredential**: [MpnsCredential](#mpnscredential): Description of a NotificationHub MpnsCredential. -* **name**: string: The NotificationHub name. -* **registrationTtl**: string: The RegistrationTtl of the created NotificationHub -* **wnsCredential**: [WnsCredential](#wnscredential): Description of a NotificationHub WnsCredential. - ## AdmCredential ### Properties * **properties**: [AdmCredentialProperties](#admcredentialproperties): Description of a NotificationHub AdmCredential. @@ -171,25 +112,34 @@ * **mpnsCertificate**: string: The MPNS certificate. * **thumbprint**: string: The MPNS certificate Thumbprint -## WnsCredential -### Properties -* **properties**: [WnsCredentialProperties](#wnscredentialproperties): Description of a NotificationHub WnsCredential. - -## WnsCredentialProperties -### Properties -* **packageSid**: string: The package ID for this credential. -* **secretKey**: string: The secret key. -* **windowsLiveEndpoint**: string: The Windows Live endpoint. - -## ResourceTags +## NamespaceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string: The time the namespace was created. +* **critical**: bool: Whether or not the namespace is set as Critical. +* **dataCenter**: string: Data center for the namespace +* **enabled**: bool: Whether or not the namespace is currently enabled. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **name**: string: The name of the namespace. +* **namespaceType**: 'Messaging' | 'NotificationHub': The namespace type. +* **provisioningState**: string: Provisioning state of the Namespace. +* **region**: 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 +* **scaleUnit**: string: ScaleUnit where the namespace gets created +* **serviceBusEndpoint**: string: Endpoint you can use to perform NotificationHub operations. +* **status**: string: Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting +* **subscriptionId**: string: The Id of the Azure subscription associated with the namespace. +* **updatedAt**: string: The time the namespace was updated. -## ResourceTags +## NotificationHubProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **admCredential**: [AdmCredential](#admcredential): Description of a NotificationHub AdmCredential. +* **apnsCredential**: [ApnsCredential](#apnscredential): Description of a NotificationHub ApnsCredential. +* **authorizationRules**: [SharedAccessAuthorizationRuleProperties](#sharedaccessauthorizationruleproperties)[]: The AuthorizationRules of the created NotificationHub +* **baiduCredential**: [BaiduCredential](#baiducredential): Description of a NotificationHub BaiduCredential. +* **gcmCredential**: [GcmCredential](#gcmcredential): Description of a NotificationHub GcmCredential. +* **mpnsCredential**: [MpnsCredential](#mpnscredential): Description of a NotificationHub MpnsCredential. +* **name**: string: The NotificationHub name. +* **registrationTtl**: string: The RegistrationTtl of the created NotificationHub +* **wnsCredential**: [WnsCredential](#wnscredential): Description of a NotificationHub WnsCredential. ## ResourceListKeys ### Properties @@ -207,3 +157,53 @@ * **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created AuthorizationRule * **secondaryKey**: string (ReadOnly): SecondaryKey of the created AuthorizationRule +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SharedAccessAuthorizationRuleProperties +### Properties +* **claimType**: string (ReadOnly): A string that describes the claim type +* **claimValue**: string (ReadOnly): A string that describes the claim value +* **createdTime**: string (ReadOnly): The created time for this rule +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **modifiedTime**: string (ReadOnly): The last modified time for this rule +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **revision**: int (ReadOnly): The revision number for the rule +* **rights**: 'Listen' | 'Manage' | 'Send'[]: The rights associated with the rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## Sku +### Properties +* **capacity**: int: The capacity of the resource +* **family**: string: The Sku Family +* **name**: 'Basic' | 'Free' | 'Standard' | string (Required): Name of the notification hub sku +* **size**: string: The Sku size +* **tier**: string: The tier of particular sku + +## WnsCredential +### Properties +* **properties**: [WnsCredentialProperties](#wnscredentialproperties): Description of a NotificationHub WnsCredential. + +## WnsCredentialProperties +### Properties +* **packageSid**: string: The package ID for this credential. +* **secretKey**: string: The secret key. +* **windowsLiveEndpoint**: string: The Windows Live endpoint. + diff --git a/generated/oep/log.out b/generated/oep/log.out index 8540b7de03..8f3a4f1e2c 100644 --- a/generated/oep/log.out +++ b/generated/oep/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.openenergyplatform-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 16ms -info | Autorest completed in 4.6s. 2 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 4.3s. 2 files generated. diff --git a/generated/oep/microsoft.openenergyplatform/2021-06-01-preview/types.md b/generated/oep/microsoft.openenergyplatform/2021-06-01-preview/types.md index 6a8c179391..041c43a484 100644 --- a/generated/oep/microsoft.openenergyplatform/2021-06-01-preview/types.md +++ b/generated/oep/microsoft.openenergyplatform/2021-06-01-preview/types.md @@ -12,6 +12,10 @@ * **tags**: [EnergyServiceTags](#energyservicetags): Resource tags. * **type**: 'Microsoft.OpenEnergyPlatform/energyServices' (ReadOnly, DeployTimeConstant): The resource type +## DataPartitionNames +### Properties +* **name**: string + ## EnergyServiceProperties ### Properties * **authAppId**: string @@ -19,9 +23,10 @@ * **dnsName**: string (ReadOnly) * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) -## DataPartitionNames +## EnergyServiceTags ### Properties -* **name**: string +### Additional Properties +* **Additional Properties Type**: string ## SystemData ### Properties @@ -32,8 +37,3 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## EnergyServiceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/operationalinsights/log.out b/generated/operationalinsights/log.out index a5b539b125..8fec2fce86 100644 --- a/generated/operationalinsights/log.out +++ b/generated/operationalinsights/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.operationalinsights-2015-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'LinkedServiceProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/LinkedServices.json:234:5 @@ -63,11 +63,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ProxyResource' (1 d - properties.tags: => {"$ref":"#/components/schemas/schemas:87","description":"Resource tags"} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ProxyResource' -> 'ProxyResourceAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 11ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2015-03-20"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json:712:5 @@ -126,11 +126,11 @@ warning | PreCheck/SchemaMissingType | The schema 'AvailableServiceTier' with an warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'WorkspacePurgeBodyFilters-value' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json#/components/schemas/WorkspacePurgeBodyFilters-value -info | autorest.bicep took 17ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2019-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/Clusters.json:336:5 @@ -183,7 +183,7 @@ info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2019-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryPacksResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-09-01-preview/QueryPacks_API.json:402:5 @@ -217,11 +217,11 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ErrorInfo' (1 diffe warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorResponse' -> 'ErrorResponseAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorInfo' -> 'ErrorInfoAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2020-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DataExport' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json:245:5 @@ -366,7 +366,7 @@ info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2021-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2021-12-01-preview/Operations.json:75:5 @@ -395,7 +395,7 @@ info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2020-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DataExport' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/DataExports.json:245:5 @@ -531,7 +531,7 @@ info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json:334:5 @@ -568,11 +568,11 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkspacePatch' with an undef warning | PreCheck/SchemaMissingType | The schema 'WorkspaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json:674:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Clusters.json:333:5 @@ -621,13 +621,13 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkspacePatch' with an undef warning | PreCheck/SchemaMissingType | The schema 'WorkspaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json:661:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.operationalinsights-2019-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 2ms -info | Autorest completed in 30.58s. 20 files generated. +info | Autorest completed in 28.18s. 20 files generated. diff --git a/generated/operationalinsights/microsoft.operationalinsights/2015-03-20/types.md b/generated/operationalinsights/microsoft.operationalinsights/2015-03-20/types.md index 4c1353f113..511a0f175f 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2015-03-20/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2015-03-20/types.md @@ -26,6 +26,11 @@ * **ApiVersion**: 2015-03-20 * **Output**: [SharedKeys](#sharedkeys) +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SavedSearchProperties ### Properties * **category**: string (Required): The category of the saved search. This helps the user to find a saved search faster. @@ -34,10 +39,15 @@ * **tags**: [Tag](#tag)[]: The tags attached to the saved search. * **version**: int: The version number of the query language. The current version is 2 and is the default. -## Tag +## SharedKeys ### Properties -* **name**: string (Required): The tag name. -* **value**: string (Required): The tag value. +* **primarySharedKey**: string (ReadOnly): The primary shared key of a workspace. +* **secondarySharedKey**: string (ReadOnly): The secondary shared key of a workspace. + +## StorageAccount +### Properties +* **id**: string (Required): The Azure Resource Manager ID of the storage account resource. +* **key**: string (Required): The storage account key. ## StorageInsightProperties ### Properties @@ -51,18 +61,8 @@ * **description**: string: Description of the state of the storage insight. * **state**: 'ERROR' | 'OK' | string (Required): The state of the storage insight connection to the workspace -## StorageAccount -### Properties -* **id**: string (Required): The Azure Resource Manager ID of the storage account resource. -* **key**: string (Required): The storage account key. - -## ProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedKeys +## Tag ### Properties -* **primarySharedKey**: string (ReadOnly): The primary shared key of a workspace. -* **secondarySharedKey**: string (ReadOnly): The secondary shared key of a workspace. +* **name**: string (Required): The tag name. +* **value**: string (Required): The tag value. diff --git a/generated/operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.md b/generated/operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.md index 5fd293290e..4260e0f14b 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2015-11-01-preview/types.md @@ -33,30 +33,30 @@ * **properties**: [LinkedServiceProperties](#linkedserviceproperties) (Required): Linked service properties. * **type**: 'Microsoft.OperationalInsights/workspaces/linkedServices' (ReadOnly, DeployTimeConstant): The resource type -## WorkspaceProperties +## LinkedServiceProperties ### Properties -* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. -* **portalUrl**: string (ReadOnly): This is a legacy property and is not used anymore. Kept here for backward compatibility. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | string: The provisioning state of the workspace. -* **retentionInDays**: int: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. -* **sku**: [Sku](#sku): The SKU (tier) of a workspace. -* **source**: string (ReadOnly): This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. +* **resourceId**: string (Required): The resource id of the resource that will be linked to the workspace. -## Sku +## ProxyResourceTags ### Properties -* **name**: 'CapacityReservation' | 'Free' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProxyResourceTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: 'CapacityReservation' | 'Free' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. -## LinkedServiceProperties +## WorkspaceProperties ### Properties -* **resourceId**: string (Required): The resource id of the resource that will be linked to the workspace. +* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. +* **portalUrl**: string (ReadOnly): This is a legacy property and is not used anymore. Kept here for backward compatibility. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | string: The provisioning state of the workspace. +* **retentionInDays**: int: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. +* **sku**: [Sku](#sku): The SKU (tier) of a workspace. +* **source**: string (ReadOnly): This is a read-only legacy property. It is always set to 'Azure' by the service. Kept here for backward compatibility. diff --git a/generated/operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.md b/generated/operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.md index 853ea98b46..00525bfd2d 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2019-08-01-preview/types.md @@ -40,12 +40,6 @@ * **properties**: [LinkedStorageAccountsProperties](#linkedstorageaccountsproperties) (Required): Linked storage accounts properties. * **type**: 'Microsoft.OperationalInsights/workspaces/linkedStorageAccounts' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. - ## ClusterProperties ### Properties * **clusterId**: string (ReadOnly): The ID associated with the cluster. @@ -53,22 +47,6 @@ * **nextLink**: string: The link used to get the next page of recommendations. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | string (ReadOnly): The provisioning state of the cluster. -## KeyVaultProperties -### Properties -* **keyName**: string: The name of the key associated with the Log Analytics cluster. -* **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. -* **keyVersion**: string: The version of the key associated with the Log Analytics cluster. - -## Sku -### Properties -* **capacity**: int: The capacity value -* **name**: 'CapacityReservation' | string: The name of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DataExportProperties ### Properties * **createdDate**: string: The latest data export rule modification time. @@ -88,6 +66,18 @@ ### Properties * **eventHubName**: string: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. + +## KeyVaultProperties +### Properties +* **keyName**: string: The name of the key associated with the Log Analytics cluster. +* **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. +* **keyVersion**: string: The version of the key associated with the Log Analytics cluster. + ## LinkedServiceProperties ### Properties * **resourceId**: string: The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access @@ -98,3 +88,13 @@ * **dataSourceType**: 'AzureWatson' | 'CustomLogs' (ReadOnly): Linked storage accounts type. * **storageAccountIds**: string[]: Linked storage accounts resources ids. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **capacity**: int: The capacity value +* **name**: 'CapacityReservation' | string: The name of the SKU. + diff --git a/generated/operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.md b/generated/operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.md index 19c55de2e5..5f95c0b24e 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2019-09-01-preview/types.md @@ -28,11 +28,6 @@ * **timeCreated**: string (ReadOnly): Creation Date for the Log Analytics QueryPack, in ISO 8601 format. * **timeModified**: string (ReadOnly): Last modified date of the Log Analytics QueryPack, in ISO 8601 format. -## QueryPacksResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## LogAnalyticsQueryPackQueryProperties ### Properties * **author**: string (ReadOnly): Object Id of user creating the query. @@ -57,6 +52,11 @@ ### Additional Properties * **Additional Properties Type**: string[] +## QueryPacksResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC) diff --git a/generated/operationalinsights/microsoft.operationalinsights/2019-09-01/types.md b/generated/operationalinsights/microsoft.operationalinsights/2019-09-01/types.md index e64198d20a..6500dd9cac 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2019-09-01/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2019-09-01/types.md @@ -28,11 +28,6 @@ * **timeCreated**: string (ReadOnly): Creation Date for the Log Analytics QueryPack, in ISO 8601 format. * **timeModified**: string (ReadOnly): Last modified date of the Log Analytics QueryPack, in ISO 8601 format. -## QueryPacksResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## LogAnalyticsQueryPackQueryProperties ### Properties * **author**: string (ReadOnly): Object Id of user creating the query. @@ -57,6 +52,11 @@ ### Additional Properties * **Additional Properties Type**: string[] +## QueryPacksResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC) diff --git a/generated/operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.md b/generated/operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.md index f4d811a04c..e9ea0bcc98 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2020-03-01-preview/types.md @@ -86,12 +86,6 @@ * **tags**: [StorageInsightTags](#storageinsighttags): Resource tags. * **type**: 'Microsoft.OperationalInsights/workspaces/storageInsightConfigs' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. - ## ClusterProperties ### Properties * **clusterId**: string (ReadOnly): The ID associated with the cluster. @@ -99,56 +93,11 @@ * **nextLink**: string: The link used to get the next page of recommendations. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster. -## KeyVaultProperties -### Properties -* **keyName**: string: The name of the key associated with the Log Analytics cluster. -* **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. -* **keyVersion**: string: The version of the key associated with the Log Analytics cluster. - ## ClusterSku ### Properties * **capacity**: int: The capacity value * **name**: 'CapacityReservation' | string: The name of the SKU. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WorkspaceProperties -### Properties -* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. -* **privateLinkScopedResources**: [PrivateLinkScopedResource](#privatelinkscopedresource)[] (ReadOnly): List of linked private link scope resources. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string: The provisioning state of the workspace. -* **publicNetworkAccessForIngestion**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled -* **publicNetworkAccessForQuery**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled -* **retentionInDays**: int: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. -* **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. -* **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. - -## PrivateLinkScopedResource -### Properties -* **resourceId**: string: The full resource Id of the private link scope resource. -* **scopeId**: string: The private link scope unique Identifier. - -## WorkspaceSku -### Properties -* **capacityReservationLevel**: int: The capacity reservation level for this workspace, when CapacityReservation sku is selected. -* **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. -* **maxCapacityReservationLevel**: int (ReadOnly): The maximum capacity reservation level available for this workspace, when CapacityReservation sku is selected. -* **name**: 'CapacityReservation' | 'Free' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. - -## WorkspaceCapping -### Properties -* **dailyQuotaGb**: int: The workspace daily quota for ingestion. -1 means unlimited. -* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. -* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DataExportProperties ### Properties * **createdDate**: string: The latest data export rule modification time. @@ -158,6 +107,11 @@ * **lastModifiedDate**: string: Date and time when the export was last modified. * **tableNames**: string[] (Required): An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. +## DataSourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Destination ### Properties * **metaData**: [DestinationMetaData](#destinationmetadata): Destination meta data. @@ -168,10 +122,17 @@ ### Properties * **eventHubName**: string: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. -## DataSourceTags +## Identity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. + +## KeyVaultProperties +### Properties +* **keyName**: string: The name of the key associated with the Log Analytics cluster. +* **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. +* **keyVersion**: string: The version of the key associated with the Log Analytics cluster. ## LinkedServiceProperties ### Properties @@ -189,6 +150,11 @@ * **dataSourceType**: 'Alerts' | 'AzureWatson' | 'CustomLogs' | 'Ingestion' | 'Query' (ReadOnly): Linked storage accounts type. * **storageAccountIds**: string[]: Linked storage accounts resources ids. +## PrivateLinkScopedResource +### Properties +* **resourceId**: string: The full resource Id of the private link scope resource. +* **scopeId**: string: The private link scope unique Identifier. + ## SavedSearchProperties ### Properties * **category**: string (Required): The category of the saved search. This helps the user to find a saved search faster. @@ -199,10 +165,10 @@ * **tags**: [Tag](#tag)[]: The tags attached to the saved search. * **version**: int: The version number of the query language. The current version is 2 and is the default. -## Tag +## StorageAccount ### Properties -* **name**: string (Required): The tag name. -* **value**: string (Required): The tag value. +* **id**: string (Required): The Azure Resource Manager ID of the storage account resource. +* **key**: string (Required): The storage account key. ## StorageInsightProperties ### Properties @@ -216,13 +182,47 @@ * **description**: string: Description of the state of the storage insight. * **state**: 'ERROR' | 'OK' | string (Required): The state of the storage insight connection to the workspace -## StorageAccount +## StorageInsightTags ### Properties -* **id**: string (Required): The Azure Resource Manager ID of the storage account resource. -* **key**: string (Required): The storage account key. +### Additional Properties +* **Additional Properties Type**: string -## StorageInsightTags +## Tag +### Properties +* **name**: string (Required): The tag name. +* **value**: string (Required): The tag value. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceCapping +### Properties +* **dailyQuotaGb**: int: The workspace daily quota for ingestion. -1 means unlimited. +* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. +* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. + +## WorkspaceProperties +### Properties +* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. +* **privateLinkScopedResources**: [PrivateLinkScopedResource](#privatelinkscopedresource)[] (ReadOnly): List of linked private link scope resources. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string: The provisioning state of the workspace. +* **publicNetworkAccessForIngestion**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled +* **publicNetworkAccessForQuery**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled +* **retentionInDays**: int: The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. +* **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. +* **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. + +## WorkspaceSku +### Properties +* **capacityReservationLevel**: int: The capacity reservation level for this workspace, when CapacityReservation sku is selected. +* **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. +* **maxCapacityReservationLevel**: int (ReadOnly): The maximum capacity reservation level available for this workspace, when CapacityReservation sku is selected. +* **name**: 'CapacityReservation' | 'Free' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. + diff --git a/generated/operationalinsights/microsoft.operationalinsights/2020-08-01/types.md b/generated/operationalinsights/microsoft.operationalinsights/2020-08-01/types.md index 4ebec34d84..f2f37f9234 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2020-08-01/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2020-08-01/types.md @@ -86,12 +86,6 @@ * **tags**: [StorageInsightTags](#storageinsighttags): Resource tags. * **type**: 'Microsoft.OperationalInsights/workspaces/storageInsightConfigs' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' (Required): The identity type. - ## ClusterProperties ### Properties * **clusterId**: string (ReadOnly): The ID associated with the cluster. @@ -99,65 +93,11 @@ * **nextLink**: string: The link used to get the next page of recommendations. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster. -## KeyVaultProperties -### Properties -* **keyName**: string: The name of the key associated with the Log Analytics cluster. -* **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. -* **keyVersion**: string: The version of the key associated with the Log Analytics cluster. - ## ClusterSku ### Properties * **capacity**: int: The capacity value * **name**: 'CapacityReservation' | string: The name of the SKU. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## WorkspaceProperties -### Properties -* **createdDate**: string (ReadOnly): Workspace creation date. -* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. -* **features**: [WorkspaceFeatures](#workspacefeatures): Workspace features. -* **forceCmkForQuery**: bool: Indicates whether customer managed storage is mandatory for query management. -* **modifiedDate**: string (ReadOnly): Workspace modification date. -* **privateLinkScopedResources**: [PrivateLinkScopedResource](#privatelinkscopedresource)[] (ReadOnly): List of linked private link scope resources. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string: The provisioning state of the workspace. -* **publicNetworkAccessForIngestion**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled -* **publicNetworkAccessForQuery**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled -* **retentionInDays**: int: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. -* **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. -* **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. - -## WorkspaceFeatures -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## PrivateLinkScopedResource -### Properties -* **resourceId**: string: The full resource Id of the private link scope resource. -* **scopeId**: string: The private link scope unique Identifier. - -## WorkspaceSku -### Properties -* **capacityReservationLevel**: int: The capacity reservation level for this workspace, when CapacityReservation sku is selected. -* **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. -* **maxCapacityReservationLevel**: int (ReadOnly): The maximum capacity reservation level available for this workspace, when CapacityReservation sku is selected. -* **name**: 'CapacityReservation' | 'Free' | 'LACluster' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. - -## WorkspaceCapping -### Properties -* **dailyQuotaGb**: int: The workspace daily quota for ingestion. -* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. -* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DataExportProperties ### Properties * **createdDate**: string: The latest data export rule modification time. @@ -167,6 +107,11 @@ * **lastModifiedDate**: string: Date and time when the export was last modified. * **tableNames**: string[] (Required): An array of tables to export, for example: [“Heartbeat, SecurityEvent”]. +## DataSourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Destination ### Properties * **metaData**: [DestinationMetaData](#destinationmetadata): Destination meta data. @@ -177,10 +122,17 @@ ### Properties * **eventHubName**: string: Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account. -## DataSourceTags +## Identity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' (Required): The identity type. + +## KeyVaultProperties +### Properties +* **keyName**: string: The name of the key associated with the Log Analytics cluster. +* **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. +* **keyVersion**: string: The version of the key associated with the Log Analytics cluster. ## LinkedServiceProperties ### Properties @@ -198,6 +150,11 @@ * **dataSourceType**: 'Alerts' | 'AzureWatson' | 'CustomLogs' | 'Query' (ReadOnly): Linked storage accounts type. * **storageAccountIds**: string[]: Linked storage accounts resources ids. +## PrivateLinkScopedResource +### Properties +* **resourceId**: string: The full resource Id of the private link scope resource. +* **scopeId**: string: The private link scope unique Identifier. + ## SavedSearchProperties ### Properties * **category**: string (Required): The category of the saved search. This helps the user to find a saved search faster. @@ -208,10 +165,10 @@ * **tags**: [Tag](#tag)[]: The tags attached to the saved search. * **version**: int: The version number of the query language. The current version is 2 and is the default. -## Tag +## StorageAccount ### Properties -* **name**: string (Required): The tag name. -* **value**: string (Required): The tag value. +* **id**: string (Required): The Azure Resource Manager ID of the storage account resource. +* **key**: string (Required): The storage account key. ## StorageInsightProperties ### Properties @@ -225,13 +182,56 @@ * **description**: string: Description of the state of the storage insight. * **state**: 'ERROR' | 'OK' | string (Required): The state of the storage insight connection to the workspace -## StorageAccount +## StorageInsightTags ### Properties -* **id**: string (Required): The Azure Resource Manager ID of the storage account resource. -* **key**: string (Required): The storage account key. +### Additional Properties +* **Additional Properties Type**: string -## StorageInsightTags +## Tag +### Properties +* **name**: string (Required): The tag name. +* **value**: string (Required): The tag value. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## WorkspaceCapping +### Properties +* **dailyQuotaGb**: int: The workspace daily quota for ingestion. +* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. +* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. + +## WorkspaceFeatures +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceProperties +### Properties +* **createdDate**: string (ReadOnly): Workspace creation date. +* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. +* **features**: [WorkspaceFeatures](#workspacefeatures): Workspace features. +* **forceCmkForQuery**: bool: Indicates whether customer managed storage is mandatory for query management. +* **modifiedDate**: string (ReadOnly): Workspace modification date. +* **privateLinkScopedResources**: [PrivateLinkScopedResource](#privatelinkscopedresource)[] (ReadOnly): List of linked private link scope resources. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string: The provisioning state of the workspace. +* **publicNetworkAccessForIngestion**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled +* **publicNetworkAccessForQuery**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled +* **retentionInDays**: int: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. +* **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. +* **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. + +## WorkspaceSku +### Properties +* **capacityReservationLevel**: int: The capacity reservation level for this workspace, when CapacityReservation sku is selected. +* **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. +* **maxCapacityReservationLevel**: int (ReadOnly): The maximum capacity reservation level available for this workspace, when CapacityReservation sku is selected. +* **name**: 'CapacityReservation' | 'Free' | 'LACluster' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. + diff --git a/generated/operationalinsights/microsoft.operationalinsights/2020-10-01/types.md b/generated/operationalinsights/microsoft.operationalinsights/2020-10-01/types.md index 235cafe7a6..22930e2679 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2020-10-01/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2020-10-01/types.md @@ -25,22 +25,17 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.OperationalInsights/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. - -## IdentityUserAssignedIdentities +## AssociatedWorkspace ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +* **associateDate**: string (ReadOnly): The time of workspace association. +* **resourceId**: string (ReadOnly): The ResourceId id the assigned workspace. +* **workspaceId**: string (ReadOnly): The id of the assigned workspace. +* **workspaceName**: string (ReadOnly): The name id the assigned workspace. -## UserIdentityProperties +## CapacityReservationProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **lastSkuUpdate**: string (ReadOnly): The last time Sku was updated. +* **minCapacity**: int (ReadOnly): Minimum CapacityReservation value in GB. ## ClusterProperties ### Properties @@ -55,17 +50,22 @@ * **lastModifiedDate**: string (ReadOnly): The last time the cluster was updated. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster. -## AssociatedWorkspace +## ClusterSku ### Properties -* **associateDate**: string (ReadOnly): The time of workspace association. -* **resourceId**: string (ReadOnly): The ResourceId id the assigned workspace. -* **workspaceId**: string (ReadOnly): The id of the assigned workspace. -* **workspaceName**: string (ReadOnly): The name id the assigned workspace. +* **capacity**: int: The capacity value +* **name**: 'CapacityReservation' | string: The name of the SKU. -## CapacityReservationProperties +## Identity ### Properties -* **lastSkuUpdate**: string (ReadOnly): The last time Sku was updated. -* **minCapacity**: int (ReadOnly): Minimum CapacityReservation value in GB. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) ## KeyVaultProperties ### Properties @@ -74,16 +74,42 @@ * **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. * **keyVersion**: string: The version of the key associated with the Log Analytics cluster. -## ClusterSku +## PrivateLinkScopedResource ### Properties -* **capacity**: int: The capacity value -* **name**: 'CapacityReservation' | string: The name of the SKU. +* **resourceId**: string: The full resource Id of the private link scope resource. +* **scopeId**: string: The private link scope unique Identifier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## UserIdentityProperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## WorkspaceCapping +### Properties +* **dailyQuotaGb**: int: The workspace daily quota for ingestion. +* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. +* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. + +## WorkspaceFeatures +### Properties +* **clusterResourceId**: string: Dedicated LA cluster resourceId that is linked to the workspaces. +* **disableLocalAuth**: bool: Disable Non-AAD based Auth. +* **enableDataExport**: bool: Flag that indicate if data should be exported. +* **enableLogAccessUsingOnlyResourcePermissions**: bool: Flag that indicate which permission to use - resource or workspace or both. +* **immediatePurgeDataOn30Days**: bool: Flag that describes if we want to remove the data after 30 days. +### Additional Properties +* **Additional Properties Type**: any + ## WorkspaceProperties ### Properties * **createdDate**: string (ReadOnly): Workspace creation date. @@ -99,35 +125,9 @@ * **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. * **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. -## WorkspaceFeatures -### Properties -* **clusterResourceId**: string: Dedicated LA cluster resourceId that is linked to the workspaces. -* **disableLocalAuth**: bool: Disable Non-AAD based Auth. -* **enableDataExport**: bool: Flag that indicate if data should be exported. -* **enableLogAccessUsingOnlyResourcePermissions**: bool: Flag that indicate which permission to use - resource or workspace or both. -* **immediatePurgeDataOn30Days**: bool: Flag that describes if we want to remove the data after 30 days. -### Additional Properties -* **Additional Properties Type**: any - -## PrivateLinkScopedResource -### Properties -* **resourceId**: string: The full resource Id of the private link scope resource. -* **scopeId**: string: The private link scope unique Identifier. - ## WorkspaceSku ### Properties * **capacityReservationLevel**: int: The capacity reservation level for this workspace, when CapacityReservation sku is selected. * **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. * **name**: 'CapacityReservation' | 'Free' | 'LACluster' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. -## WorkspaceCapping -### Properties -* **dailyQuotaGb**: int: The workspace daily quota for ingestion. -* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. -* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/operationalinsights/microsoft.operationalinsights/2021-06-01/types.md b/generated/operationalinsights/microsoft.operationalinsights/2021-06-01/types.md index 3e91025529..052ae27498 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2021-06-01/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2021-06-01/types.md @@ -25,22 +25,17 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.OperationalInsights/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. - -## IdentityUserAssignedIdentities +## AssociatedWorkspace ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) +* **associateDate**: string (ReadOnly): The time of workspace association. +* **resourceId**: string (ReadOnly): The ResourceId id the assigned workspace. +* **workspaceId**: string (ReadOnly): The id of the assigned workspace. +* **workspaceName**: string (ReadOnly): The name id the assigned workspace. -## UserIdentityProperties +## CapacityReservationProperties ### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **lastSkuUpdate**: string (ReadOnly): The last time Sku was updated. +* **minCapacity**: int (ReadOnly): Minimum CapacityReservation value in GB. ## ClusterProperties ### Properties @@ -55,17 +50,22 @@ * **lastModifiedDate**: string (ReadOnly): The last time the cluster was updated. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster. -## AssociatedWorkspace +## ClusterSku ### Properties -* **associateDate**: string (ReadOnly): The time of workspace association. -* **resourceId**: string (ReadOnly): The ResourceId id the assigned workspace. -* **workspaceId**: string (ReadOnly): The id of the assigned workspace. -* **workspaceName**: string (ReadOnly): The name id the assigned workspace. +* **capacity**: int: The capacity value +* **name**: 'CapacityReservation' | string: The name of the SKU. -## CapacityReservationProperties +## Identity ### Properties -* **lastSkuUpdate**: string (ReadOnly): The last time Sku was updated. -* **minCapacity**: int (ReadOnly): Minimum CapacityReservation value in GB. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' (Required): Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user 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}'. + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserIdentityProperties](#useridentityproperties) ## KeyVaultProperties ### Properties @@ -74,16 +74,42 @@ * **keyVaultUri**: string: The Key Vault uri which holds they key associated with the Log Analytics cluster. * **keyVersion**: string: The version of the key associated with the Log Analytics cluster. -## ClusterSku +## PrivateLinkScopedResource ### Properties -* **capacity**: int: The capacity value -* **name**: 'CapacityReservation' | string: The name of the SKU. +* **resourceId**: string: The full resource Id of the private link scope resource. +* **scopeId**: string: The private link scope unique Identifier. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## UserIdentityProperties +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## WorkspaceCapping +### Properties +* **dailyQuotaGb**: int: The workspace daily quota for ingestion. +* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. +* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. + +## WorkspaceFeatures +### Properties +* **clusterResourceId**: string: Dedicated LA cluster resourceId that is linked to the workspaces. +* **disableLocalAuth**: bool: Disable Non-AAD based Auth. +* **enableDataExport**: bool: Flag that indicate if data should be exported. +* **enableLogAccessUsingOnlyResourcePermissions**: bool: Flag that indicate which permission to use - resource or workspace or both. +* **immediatePurgeDataOn30Days**: bool: Flag that describes if we want to remove the data after 30 days. +### Additional Properties +* **Additional Properties Type**: any + ## WorkspaceProperties ### Properties * **createdDate**: string (ReadOnly): Workspace creation date. @@ -99,35 +125,9 @@ * **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. * **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. -## WorkspaceFeatures -### Properties -* **clusterResourceId**: string: Dedicated LA cluster resourceId that is linked to the workspaces. -* **disableLocalAuth**: bool: Disable Non-AAD based Auth. -* **enableDataExport**: bool: Flag that indicate if data should be exported. -* **enableLogAccessUsingOnlyResourcePermissions**: bool: Flag that indicate which permission to use - resource or workspace or both. -* **immediatePurgeDataOn30Days**: bool: Flag that describes if we want to remove the data after 30 days. -### Additional Properties -* **Additional Properties Type**: any - -## PrivateLinkScopedResource -### Properties -* **resourceId**: string: The full resource Id of the private link scope resource. -* **scopeId**: string: The private link scope unique Identifier. - ## WorkspaceSku ### Properties * **capacityReservationLevel**: int: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. * **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. * **name**: 'CapacityReservation' | 'Free' | 'LACluster' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. -## WorkspaceCapping -### Properties -* **dailyQuotaGb**: int: The workspace daily quota for ingestion. -* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. -* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.md b/generated/operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.md index f3c5c24c1e..e660388e81 100644 --- a/generated/operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.md +++ b/generated/operationalinsights/microsoft.operationalinsights/2021-12-01-preview/types.md @@ -23,76 +23,21 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.OperationalInsights/workspaces/tables' (ReadOnly, DeployTimeConstant): The resource type -## WorkspaceProperties -### Properties -* **createdDate**: string (ReadOnly): Workspace creation date. -* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. -* **defaultDataCollectionRuleResourceId**: string: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. -* **features**: [WorkspaceFeatures](#workspacefeatures): Workspace features. -* **forceCmkForQuery**: bool: Indicates whether customer managed storage is mandatory for query management. -* **modifiedDate**: string (ReadOnly): Workspace modification date. -* **privateLinkScopedResources**: [PrivateLinkScopedResource](#privatelinkscopedresource)[] (ReadOnly): List of linked private link scope resources. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the workspace. -* **publicNetworkAccessForIngestion**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled -* **publicNetworkAccessForQuery**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled -* **retentionInDays**: int: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. -* **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. -* **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. - -## WorkspaceFeatures +## Column ### Properties -* **clusterResourceId**: string: Dedicated LA cluster resourceId that is linked to the workspaces. -* **disableLocalAuth**: bool: Disable Non-AAD based Auth. -* **enableDataExport**: bool: Flag that indicate if data should be exported. -* **enableLogAccessUsingOnlyResourcePermissions**: bool: Flag that indicate which permission to use - resource or workspace or both. -* **immediatePurgeDataOn30Days**: bool: Flag that describes if we want to remove the data after 30 days. -### Additional Properties -* **Additional Properties Type**: any +* **dataTypeHint**: 'armPath' | 'guid' | 'ip' | 'uri' | string: Column data type logical hint. +* **description**: string: Column description. +* **displayName**: string: Column display name. +* **isDefaultDisplay**: bool (ReadOnly): Is displayed by default. +* **isHidden**: bool (ReadOnly): Is column hidden. +* **name**: string: Column name. +* **type**: 'boolean' | 'dateTime' | 'dynamic' | 'guid' | 'int' | 'long' | 'real' | 'string' | string: Column data type. ## PrivateLinkScopedResource ### Properties * **resourceId**: string: The full resource Id of the private link scope resource. * **scopeId**: string: The private link scope unique Identifier. -## WorkspaceSku -### Properties -* **capacityReservationLevel**: int: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. -* **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. -* **name**: 'CapacityReservation' | 'Free' | 'LACluster' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. - -## WorkspaceCapping -### Properties -* **dailyQuotaGb**: int: The workspace daily quota for ingestion. -* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. -* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## TableProperties -### Properties -* **archiveRetentionInDays**: int (ReadOnly): The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) -* **lastPlanModifiedDate**: string (ReadOnly): The timestamp that table plan was last modified (UTC). -* **plan**: 'Analytics' | 'Basic' | string: Instruct the system how to handle and charge the logs ingested to this table. -* **provisioningState**: 'InProgress' | 'Succeeded' | 'Updating' | string (ReadOnly): Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. -* **restoredLogs**: [RestoredLogs](#restoredlogs): Restore parameters. -* **resultStatistics**: [ResultStatistics](#resultstatistics): Search job execution statistics. -* **retentionInDays**: int: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. -* **schema**: [Schema](#schema): Table's schema. -* **searchResults**: [SearchResults](#searchresults): Parameters of the search job that initiated this table. -* **totalRetentionInDays**: int: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. - ## RestoredLogs ### Properties * **endRestoreTime**: string: The timestamp to end the restore by (UTC). @@ -120,16 +65,6 @@ * **tableSubType**: 'Any' | 'Classic' | 'DataCollectionRuleBased' | string (ReadOnly): The subtype describes what APIs can be used to interact with the table, and what features are available against it. * **tableType**: 'CustomLog' | 'Microsoft' | 'RestoredLogs' | 'SearchResults' | string (ReadOnly): Table's creator. -## Column -### Properties -* **dataTypeHint**: 'armPath' | 'guid' | 'ip' | 'uri' | string: Column data type logical hint. -* **description**: string: Column description. -* **displayName**: string: Column display name. -* **isDefaultDisplay**: bool (ReadOnly): Is displayed by default. -* **isHidden**: bool (ReadOnly): Is column hidden. -* **name**: string: Column name. -* **type**: 'boolean' | 'dateTime' | 'dynamic' | 'guid' | 'int' | 'long' | 'real' | 'string' | string: Column data type. - ## SearchResults ### Properties * **description**: string: Search job Description. @@ -139,3 +74,68 @@ * **sourceTable**: string (ReadOnly): The table used in the search job. * **startSearchTime**: string: The timestamp to start the search from (UTC) +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **archiveRetentionInDays**: int (ReadOnly): The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays) +* **lastPlanModifiedDate**: string (ReadOnly): The timestamp that table plan was last modified (UTC). +* **plan**: 'Analytics' | 'Basic' | string: Instruct the system how to handle and charge the logs ingested to this table. +* **provisioningState**: 'InProgress' | 'Succeeded' | 'Updating' | string (ReadOnly): Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. +* **restoredLogs**: [RestoredLogs](#restoredlogs): Restore parameters. +* **resultStatistics**: [ResultStatistics](#resultstatistics): Search job execution statistics. +* **retentionInDays**: int: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. +* **schema**: [Schema](#schema): Table's schema. +* **searchResults**: [SearchResults](#searchresults): Parameters of the search job that initiated this table. +* **totalRetentionInDays**: int: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## WorkspaceCapping +### Properties +* **dailyQuotaGb**: int: The workspace daily quota for ingestion. +* **dataIngestionStatus**: 'ApproachingQuota' | 'ForceOff' | 'ForceOn' | 'OverQuota' | 'RespectQuota' | 'SubscriptionSuspended' | string (ReadOnly): The status of data ingestion for this workspace. +* **quotaNextResetTime**: string (ReadOnly): The time when the quota will be rest. + +## WorkspaceFeatures +### Properties +* **clusterResourceId**: string: Dedicated LA cluster resourceId that is linked to the workspaces. +* **disableLocalAuth**: bool: Disable Non-AAD based Auth. +* **enableDataExport**: bool: Flag that indicate if data should be exported. +* **enableLogAccessUsingOnlyResourcePermissions**: bool: Flag that indicate which permission to use - resource or workspace or both. +* **immediatePurgeDataOn30Days**: bool: Flag that describes if we want to remove the data after 30 days. +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceProperties +### Properties +* **createdDate**: string (ReadOnly): Workspace creation date. +* **customerId**: string (ReadOnly): This is a read-only property. Represents the ID associated with the workspace. +* **defaultDataCollectionRuleResourceId**: string: The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}. +* **features**: [WorkspaceFeatures](#workspacefeatures): Workspace features. +* **forceCmkForQuery**: bool: Indicates whether customer managed storage is mandatory for query management. +* **modifiedDate**: string (ReadOnly): Workspace modification date. +* **privateLinkScopedResources**: [PrivateLinkScopedResource](#privatelinkscopedresource)[] (ReadOnly): List of linked private link scope resources. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'ProvisioningAccount' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the workspace. +* **publicNetworkAccessForIngestion**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled +* **publicNetworkAccessForQuery**: 'Disabled' | 'Enabled' | string: The network access type for operating on the Log Analytics Workspace. By default it is Enabled +* **retentionInDays**: int: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. +* **sku**: [WorkspaceSku](#workspacesku): The SKU (tier) of a workspace. +* **workspaceCapping**: [WorkspaceCapping](#workspacecapping): The daily volume cap for ingestion. + +## WorkspaceSku +### Properties +* **capacityReservationLevel**: int: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. +* **lastSkuUpdate**: string (ReadOnly): The last time when the sku was updated. +* **name**: 'CapacityReservation' | 'Free' | 'LACluster' | 'PerGB2018' | 'PerNode' | 'Premium' | 'Standalone' | 'Standard' | string (Required): The name of the SKU. + diff --git a/generated/operationsmanagement/log.out b/generated/operationsmanagement/log.out index 0e0def27b4..fcd2ab3e52 100644 --- a/generated/operationsmanagement/log.out +++ b/generated/operationsmanagement/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.operationsmanagement-2015-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json:693:5 @@ -42,5 +42,5 @@ warning | PreCheck/SchemaMissingType | The schema 'CodeMessageError' with an und - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json:1000:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 11ms -info | Autorest completed in 4.82s. 2 files generated. +info | autorest.bicep took 13ms +info | Autorest completed in 4.54s. 2 files generated. diff --git a/generated/operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.md b/generated/operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.md index 17fa32dcf6..14786cc24a 100644 --- a/generated/operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.md +++ b/generated/operationsmanagement/microsoft.operationsmanagement/2015-11-01-preview/types.md @@ -32,6 +32,11 @@ * **tags**: [SolutionTags](#solutiontags): Resource tags * **type**: 'Microsoft.OperationsManagement/solutions' (ReadOnly, DeployTimeConstant): The resource type +## ArmTemplateParameter +### Properties +* **name**: string: name of the parameter. +* **value**: string: value for the parameter. In Jtoken + ## ManagementAssociationProperties ### Properties * **applicationId**: string (Required): The applicationId of the appliance for this association. @@ -44,11 +49,6 @@ * **provisioningState**: string (ReadOnly): The provisioning state for the ManagementConfiguration. * **template**: any (Required): Any object -## ArmTemplateParameter -### Properties -* **name**: string: name of the parameter. -* **value**: string: value for the parameter. In Jtoken - ## SolutionPlan ### Properties * **name**: string: 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. diff --git a/generated/orbital/log.out b/generated/orbital/log.out index 12d38ab97e..fc47a72b9d 100644 --- a/generated/orbital/log.out +++ b/generated/orbital/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.orbital-2022-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ContactsProperties-contactProfile' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json:1467:9 @@ -22,11 +22,11 @@ warning | PreCheck/SchemaMissingType | The schema 'AvailableGroundStation-proper - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json:1945:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'AvailableGroundStationProperties' -> 'AvailableGroundStationPropertiesAutoGenerated' -info | autorest.bicep took 17ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.orbital-2021-04-04-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms -info | Autorest completed in 7.74s. 4 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 7.43s. 4 files generated. diff --git a/generated/orbital/microsoft.orbital/2021-04-04-preview/types.md b/generated/orbital/microsoft.orbital/2021-04-04-preview/types.md index 7efb8f9154..700de7995f 100644 --- a/generated/orbital/microsoft.orbital/2021-04-04-preview/types.md +++ b/generated/orbital/microsoft.orbital/2021-04-04-preview/types.md @@ -43,13 +43,35 @@ * **Input**: [ContactParameters](#contactparameters) * **Output**: [AvailableContactsListResult](#availablecontactslistresult) -## ContactProfilesProperties +## AvailableContacts ### Properties -* **autoTrackingConfiguration**: 'disabled' | 'sBand' | 'xBand': Auto track configuration. -* **eventHubUri**: string: The URI of the Event Hub used for telemetry -* **links**: [ContactProfileLink](#contactprofilelink)[] (Required): Links of the Contact Profile -* **minimumElevationDegrees**: int: Minimum viable elevation for the contact in decimal degrees. -* **minimumViableContactDuration**: string: Minimum viable contact duration in ISO 8601 format. +* **groundStationName**: string (ReadOnly): Name of Azure Ground Station. +* **properties**: [ContactInstanceProperties](#contactinstanceproperties) (ReadOnly): Contact Instance Properties +* **spacecraft**: [ResourceReference](#resourcereference) (ReadOnly): Resource Reference + +## AvailableContactsListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [AvailableContacts](#availablecontacts)[] (ReadOnly): A list of available contacts + +## ContactInstanceProperties +### Properties +* **endAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the end of the contact in decimal degrees. +* **endElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact end. +* **maximumElevationDegrees**: int (ReadOnly): Maximum elevation of the antenna during the contact in decimal degrees. +* **rxEndTime**: string (ReadOnly): Time to lost receiving a signal. +* **rxStartTime**: string (ReadOnly): Earliest time to receive a signal. +* **startAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the start of the contact in decimal degrees. +* **startElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact start. +* **txEndTime**: string (ReadOnly): Time at which antenna transmit will be disabled. +* **txStartTime**: string (ReadOnly): Time at which antenna transmit will be enabled. + +## ContactParameters +### Properties +* **contactProfile**: [ResourceReference](#resourcereference) (Required, WriteOnly): Resource Reference +* **endTime**: string (Required, WriteOnly): End time of a contact. +* **groundStationName**: string (Required, WriteOnly): Name of Azure Ground Station. +* **startTime**: string (Required, WriteOnly): Start time of a contact. ## ContactProfileLink ### Properties @@ -69,48 +91,13 @@ * **endPoint**: [EndPoint](#endpoint) (Required): Customer End point to store/retrieve data during a contact. * **modulationConfiguration**: string: Configuration for modulation -## EndPoint -### Properties -* **endPointName**: string (Required): Name of an end point. -* **ipAddress**: string (Required): IP Address. -* **port**: string (Required): TCP port to listen on to receive data. -* **protocol**: 'TCP' | 'UDP' | string (Required): Protocol either UDP or TCP. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SpacecraftsProperties -### Properties -* **authorizationStatus**: 'Allowed' | 'Denied' | 'Pending' (ReadOnly): Authorization status of spacecraft. -* **authorizationStatusExtended**: string (ReadOnly): Details of the authorization status. -* **links**: [SpacecraftLink](#spacecraftlink)[]: Links of the Spacecraft -* **noradId**: string (Required): NORAD ID of the spacecraft. -* **titleLine**: string: Title line of Two Line Element (TLE). -* **tleLine1**: string: Line 1 of Two Line Element (TLE). -* **tleLine2**: string: Line 2 of Two Line Element (TLE). - -## SpacecraftLink -### Properties -* **bandwidthMHz**: int (Required): Bandwidth in MHz -* **centerFrequencyMHz**: int (Required): Center Frequency in MHz -* **direction**: 'downlink' | 'uplink' | string (Required): Direction (uplink or downlink) -* **polarization**: 'LHCP' | 'RHCP' | 'dualRhcpLhcp' | 'linearHorizontal' | 'linearVertical' | string (Required): polarization. eg (RHCP, LHCP) - -## TrackedResourceTags +## ContactProfilesProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoTrackingConfiguration**: 'disabled' | 'sBand' | 'xBand': Auto track configuration. +* **eventHubUri**: string: The URI of the Event Hub used for telemetry +* **links**: [ContactProfileLink](#contactprofilelink)[] (Required): Links of the Contact Profile +* **minimumElevationDegrees**: int: Minimum viable elevation for the contact in decimal degrees. +* **minimumViableContactDuration**: string: Minimum viable contact duration in ISO 8601 format. ## ContactsProperties ### Properties @@ -130,37 +117,50 @@ * **txEndTime**: string (ReadOnly): Transmit end time of a contact. * **txStartTime**: string (ReadOnly): Transmit start time of a contact. +## EndPoint +### Properties +* **endPointName**: string (Required): Name of an end point. +* **ipAddress**: string (Required): IP Address. +* **port**: string (Required): TCP port to listen on to receive data. +* **protocol**: 'TCP' | 'UDP' | string (Required): Protocol either UDP or TCP. + ## ResourceReference ### Properties * **id**: string: Resource ID. -## ContactParameters +## SpacecraftLink ### Properties -* **contactProfile**: [ResourceReference](#resourcereference) (Required, WriteOnly): Resource Reference -* **endTime**: string (Required, WriteOnly): End time of a contact. -* **groundStationName**: string (Required, WriteOnly): Name of Azure Ground Station. -* **startTime**: string (Required, WriteOnly): Start time of a contact. +* **bandwidthMHz**: int (Required): Bandwidth in MHz +* **centerFrequencyMHz**: int (Required): Center Frequency in MHz +* **direction**: 'downlink' | 'uplink' | string (Required): Direction (uplink or downlink) +* **polarization**: 'LHCP' | 'RHCP' | 'dualRhcpLhcp' | 'linearHorizontal' | 'linearVertical' | string (Required): polarization. eg (RHCP, LHCP) -## AvailableContactsListResult +## SpacecraftsProperties ### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [AvailableContacts](#availablecontacts)[] (ReadOnly): A list of available contacts +* **authorizationStatus**: 'Allowed' | 'Denied' | 'Pending' (ReadOnly): Authorization status of spacecraft. +* **authorizationStatusExtended**: string (ReadOnly): Details of the authorization status. +* **links**: [SpacecraftLink](#spacecraftlink)[]: Links of the Spacecraft +* **noradId**: string (Required): NORAD ID of the spacecraft. +* **titleLine**: string: Title line of Two Line Element (TLE). +* **tleLine1**: string: Line 1 of Two Line Element (TLE). +* **tleLine2**: string: Line 2 of Two Line Element (TLE). -## AvailableContacts +## SystemData ### Properties -* **groundStationName**: string (ReadOnly): Name of Azure Ground Station. -* **properties**: [ContactInstanceProperties](#contactinstanceproperties) (ReadOnly): Contact Instance Properties -* **spacecraft**: [ResourceReference](#resourcereference) (ReadOnly): Resource Reference +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ContactInstanceProperties +## TrackedResourceTags ### Properties -* **endAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the end of the contact in decimal degrees. -* **endElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact end. -* **maximumElevationDegrees**: int (ReadOnly): Maximum elevation of the antenna during the contact in decimal degrees. -* **rxEndTime**: string (ReadOnly): Time to lost receiving a signal. -* **rxStartTime**: string (ReadOnly): Earliest time to receive a signal. -* **startAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the start of the contact in decimal degrees. -* **startElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact start. -* **txEndTime**: string (ReadOnly): Time at which antenna transmit will be disabled. -* **txStartTime**: string (ReadOnly): Time at which antenna transmit will be enabled. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/orbital/microsoft.orbital/2022-03-01/types.md b/generated/orbital/microsoft.orbital/2022-03-01/types.md index d8cdb8de3e..95c129089d 100644 --- a/generated/orbital/microsoft.orbital/2022-03-01/types.md +++ b/generated/orbital/microsoft.orbital/2022-03-01/types.md @@ -43,15 +43,48 @@ * **Input**: [ContactParameters](#contactparameters) * **Output**: [AvailableContactsListResult](#availablecontactslistresult) -## ContactProfileProperties +## AuthorizedGroundstation ### Properties -* **autoTrackingConfiguration**: 'disabled' | 'sBand' | 'xBand': Auto track configuration. -* **eventHubUri**: string: The URI of the Event Hub used for telemetry -* **links**: [ContactProfileLink](#contactprofilelink)[] (Required): Links of the Contact Profile -* **minimumElevationDegrees**: int: Minimum viable elevation for the contact in decimal degrees. -* **minimumViableContactDuration**: string: Minimum viable contact duration in ISO 8601 format. -* **networkConfiguration**: [ContactProfilesPropertiesNetworkConfiguration](#contactprofilespropertiesnetworkconfiguration) (Required): Network configuration of customer virtual network. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current state of the resource's creation, deletion, or modification +* **expirationDate**: string: Date of authorization expiration +* **groundStation**: string: Groundstation name + +## AvailableContacts +### Properties +* **groundStationName**: string (ReadOnly): Name of Azure Ground Station. +* **properties**: [AvailableContactsProperties](#availablecontactsproperties) (ReadOnly): Properties of Contact resource. +* **spacecraft**: [AvailableContactsSpacecraft](#availablecontactsspacecraft) (ReadOnly): The reference to the spacecraft resource. + +## AvailableContactsListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [AvailableContacts](#availablecontacts)[] (ReadOnly): A list of available contacts + +## AvailableContactsProperties +### Properties +* **endAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the end of the contact in decimal degrees. +* **endElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact end. +* **maximumElevationDegrees**: int (ReadOnly): Maximum elevation of the antenna during the contact in decimal degrees. +* **rxEndTime**: string (ReadOnly): Time to lost receiving a signal. +* **rxStartTime**: string (ReadOnly): Earliest time to receive a signal. +* **startAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the start of the contact in decimal degrees. +* **startElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact start. +* **txEndTime**: string (ReadOnly): Time at which antenna transmit will be disabled. +* **txStartTime**: string (ReadOnly): Time at which antenna transmit will be enabled. + +## AvailableContactsSpacecraft +### Properties +* **id**: string (ReadOnly): Resource ID. + +## ContactParameters +### Properties +* **contactProfile**: [ContactParametersContactProfile](#contactparameterscontactprofile) (Required, WriteOnly): The reference to the contact profile resource. +* **endTime**: string (Required, WriteOnly): End time of a contact. +* **groundStationName**: string (Required, WriteOnly): Name of Azure Ground Station. +* **startTime**: string (Required, WriteOnly): Start time of a contact. + +## ContactParametersContactProfile +### Properties +* **id**: string (WriteOnly): Resource ID. ## ContactProfileLink ### Properties @@ -73,59 +106,20 @@ * **modulationConfiguration**: string: Configuration for modulation * **name**: string (Required): Channel name -## EndPoint +## ContactProfileProperties ### Properties -* **endPointName**: string (Required): Name of an end point. -* **ipAddress**: string (Required): IP Address. -* **port**: string (Required): TCP port to listen on to receive data. -* **protocol**: 'TCP' | 'UDP' | string (Required): Protocol either UDP or TCP. +* **autoTrackingConfiguration**: 'disabled' | 'sBand' | 'xBand': Auto track configuration. +* **eventHubUri**: string: The URI of the Event Hub used for telemetry +* **links**: [ContactProfileLink](#contactprofilelink)[] (Required): Links of the Contact Profile +* **minimumElevationDegrees**: int: Minimum viable elevation for the contact in decimal degrees. +* **minimumViableContactDuration**: string: Minimum viable contact duration in ISO 8601 format. +* **networkConfiguration**: [ContactProfilesPropertiesNetworkConfiguration](#contactprofilespropertiesnetworkconfiguration) (Required): Network configuration of customer virtual network. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current state of the resource's creation, deletion, or modification ## ContactProfilesPropertiesNetworkConfiguration ### Properties * **subnetId**: string (Required): Customer subnet ARM resource identifier. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SpacecraftsProperties -### Properties -* **links**: [SpacecraftLink](#spacecraftlink)[]: Links of the Spacecraft -* **noradId**: string (Required): NORAD ID of the spacecraft. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current state of the resource's creation, deletion, or modification -* **titleLine**: string: Title line of Two Line Element (TLE). -* **tleLine1**: string: Line 1 of Two Line Element (TLE). -* **tleLine2**: string: Line 2 of Two Line Element (TLE). - -## SpacecraftLink -### Properties -* **authorizations**: [AuthorizedGroundstation](#authorizedgroundstation)[] (ReadOnly): Authorized Ground Stations -* **bandwidthMHz**: int (Required): Bandwidth in MHz -* **centerFrequencyMHz**: int (Required): Center Frequency in MHz -* **direction**: 'downlink' | 'uplink' | string (Required): Direction (uplink or downlink) -* **name**: string (Required): Link name -* **polarization**: 'LHCP' | 'RHCP' | 'linearHorizontal' | 'linearVertical' | string (Required): polarization. eg (RHCP, LHCP) - -## AuthorizedGroundstation -### Properties -* **expirationDate**: string: Date of authorization expiration -* **groundStation**: string: Groundstation name - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ContactsProperties ### Properties * **antennaConfiguration**: [ContactsPropertiesAntennaConfiguration](#contactspropertiesantennaconfiguration) (ReadOnly): The configuration associated with the allocated antenna. @@ -155,41 +149,47 @@ ### Properties * **id**: string: Resource ID. -## ContactParameters +## EndPoint ### Properties -* **contactProfile**: [ContactParametersContactProfile](#contactparameterscontactprofile) (Required, WriteOnly): The reference to the contact profile resource. -* **endTime**: string (Required, WriteOnly): End time of a contact. -* **groundStationName**: string (Required, WriteOnly): Name of Azure Ground Station. -* **startTime**: string (Required, WriteOnly): Start time of a contact. +* **endPointName**: string (Required): Name of an end point. +* **ipAddress**: string (Required): IP Address. +* **port**: string (Required): TCP port to listen on to receive data. +* **protocol**: 'TCP' | 'UDP' | string (Required): Protocol either UDP or TCP. -## ContactParametersContactProfile +## SpacecraftLink ### Properties -* **id**: string (WriteOnly): Resource ID. +* **authorizations**: [AuthorizedGroundstation](#authorizedgroundstation)[] (ReadOnly): Authorized Ground Stations +* **bandwidthMHz**: int (Required): Bandwidth in MHz +* **centerFrequencyMHz**: int (Required): Center Frequency in MHz +* **direction**: 'downlink' | 'uplink' | string (Required): Direction (uplink or downlink) +* **name**: string (Required): Link name +* **polarization**: 'LHCP' | 'RHCP' | 'linearHorizontal' | 'linearVertical' | string (Required): polarization. eg (RHCP, LHCP) -## AvailableContactsListResult +## SpacecraftsProperties ### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [AvailableContacts](#availablecontacts)[] (ReadOnly): A list of available contacts +* **links**: [SpacecraftLink](#spacecraftlink)[]: Links of the Spacecraft +* **noradId**: string (Required): NORAD ID of the spacecraft. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: The current state of the resource's creation, deletion, or modification +* **titleLine**: string: Title line of Two Line Element (TLE). +* **tleLine1**: string: Line 1 of Two Line Element (TLE). +* **tleLine2**: string: Line 2 of Two Line Element (TLE). -## AvailableContacts +## SystemData ### Properties -* **groundStationName**: string (ReadOnly): Name of Azure Ground Station. -* **properties**: [AvailableContactsProperties](#availablecontactsproperties) (ReadOnly): Properties of Contact resource. -* **spacecraft**: [AvailableContactsSpacecraft](#availablecontactsspacecraft) (ReadOnly): The reference to the spacecraft resource. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AvailableContactsProperties +## TrackedResourceTags ### Properties -* **endAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the end of the contact in decimal degrees. -* **endElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact end. -* **maximumElevationDegrees**: int (ReadOnly): Maximum elevation of the antenna during the contact in decimal degrees. -* **rxEndTime**: string (ReadOnly): Time to lost receiving a signal. -* **rxStartTime**: string (ReadOnly): Earliest time to receive a signal. -* **startAzimuthDegrees**: int (ReadOnly): Azimuth of the antenna at the start of the contact in decimal degrees. -* **startElevationDegrees**: int (ReadOnly): Spacecraft elevation above the horizon at contact start. -* **txEndTime**: string (ReadOnly): Time at which antenna transmit will be disabled. -* **txStartTime**: string (ReadOnly): Time at which antenna transmit will be enabled. +### Additional Properties +* **Additional Properties Type**: string -## AvailableContactsSpacecraft +## TrackedResourceTags ### Properties -* **id**: string (ReadOnly): Resource ID. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/peering/log.out b/generated/peering/log.out index 5182cdb4f4..ab26a6ff6f 100644 --- a/generated/peering/log.out +++ b/generated/peering/log.out @@ -3,53 +3,53 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.peering-2022-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.peering-2021-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.peering-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.peering-2020-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.peering-2020-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.peering-2020-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.peering-2019-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.peering-2019-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 25.8s. 16 files generated. +info | Autorest completed in 23.86s. 16 files generated. diff --git a/generated/peering/microsoft.peering/2019-08-01-preview/types.md b/generated/peering/microsoft.peering/2019-08-01-preview/types.md index 8dd2d575f9..b9754a3be2 100644 --- a/generated/peering/microsoft.peering/2019-08-01-preview/types.md +++ b/generated/peering/microsoft.peering/2019-08-01-preview/types.md @@ -42,32 +42,25 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactInfo**: [ContactInfo](#contactinfo): The contact information of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string (ReadOnly): The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string (ReadOnly): The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. ## ContactInfo ### Properties * **emails**: string[]: The list of email addresses. * **phone**: string[]: The list of contact numbers. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Transit' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool: The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -79,47 +72,45 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession +## ExchangeConnection ### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string (ReadOnly): The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string (ReadOnly): The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. +* **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. +* **connectionIdentifier**: string: The unique identifier (GUID) for the connection. +* **connectionState**: 'Active' | 'Approved' | 'None' | 'PendingApproval' | 'ProvisioningCompleted' | 'ProvisioningFailed' | 'ProvisioningStarted' | 'Validating' | string (ReadOnly): The state of the connection. +* **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## SubResource +## PeerAsnProperties ### Properties -* **id**: string: The identifier of the referenced resource. +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactInfo**: [ContactInfo](#contactinfo): The contact information of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. -## PeeringPropertiesExchange +## PeeringProperties ### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -## ExchangeConnection +## PeeringPropertiesDirect ### Properties -* **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. -* **connectionIdentifier**: string: The unique identifier (GUID) for the connection. -* **connectionState**: 'Active' | 'Approved' | 'None' | 'PendingApproval' | 'ProvisioningCompleted' | 'ProvisioningFailed' | 'ProvisioningStarted' | 'Validating' | string (ReadOnly): The state of the connection. -* **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Transit' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool: The flag that indicates whether or not the peering is used for peering service. -## PeeringSku +## PeeringPropertiesExchange ### Properties -* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. -* **name**: 'Basic_Direct_Free' | 'Basic_Exchange_Free' | 'Premium_Direct_Free' | 'Premium_Direct_Metered' | 'Premium_Direct_Unlimited' | 'Premium_Exchange_Metered' | string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. -## PeeringTags +## PeeringServicePrefixProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **learnedType**: 'None' | 'ViaPartner' | 'ViaSession' | string: The prefix learned type +* **prefix**: string: Valid route prefix +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | string: The prefix validation state +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. ## PeeringServiceProperties ### Properties @@ -132,10 +123,19 @@ ### Additional Properties * **Additional Properties Type**: string -## PeeringServicePrefixProperties +## PeeringSku ### Properties -* **learnedType**: 'None' | 'ViaPartner' | 'ViaSession' | string: The prefix learned type -* **prefix**: string: Valid route prefix -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | string: The prefix validation state -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. +* **name**: 'Basic_Direct_Free' | 'Basic_Exchange_Free' | 'Premium_Direct_Free' | 'Premium_Direct_Metered' | 'Premium_Direct_Unlimited' | 'Premium_Exchange_Metered' | string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. + +## PeeringTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SubResource +### Properties +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2019-09-01-preview/types.md b/generated/peering/microsoft.peering/2019-09-01-preview/types.md index 5c3b07941b..677a478cae 100644 --- a/generated/peering/microsoft.peering/2019-09-01-preview/types.md +++ b/generated/peering/microsoft.peering/2019-09-01-preview/types.md @@ -42,33 +42,25 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactInfo**: [ContactInfo](#contactinfo): The contact information of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string (ReadOnly): The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string (ReadOnly): The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. ## ContactInfo ### Properties * **emails**: string[]: The list of email addresses. * **phone**: string[]: The list of contact numbers. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Transit' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -81,48 +73,57 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession +## ExchangeConnection ### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string (ReadOnly): The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string (ReadOnly): The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. +* **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. +* **connectionIdentifier**: string: The unique identifier (GUID) for the connection. +* **connectionState**: 'Active' | 'Approved' | 'None' | 'PendingApproval' | 'ProvisioningCompleted' | 'ProvisioningFailed' | 'ProvisioningStarted' | 'Validating' | string (ReadOnly): The state of the connection. +* **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. +* **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## SubResource +## PeerAsnProperties ### Properties -* **id**: string: The identifier of the referenced resource. +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactInfo**: [ContactInfo](#contactinfo): The contact information of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. -## PeeringPropertiesExchange +## PeeringProperties ### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Transit' | string: The type of direct peering. * **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. -## ExchangeConnection +## PeeringPropertiesExchange ### Properties -* **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. -* **connectionIdentifier**: string: The unique identifier (GUID) for the connection. -* **connectionState**: 'Active' | 'Approved' | 'None' | 'PendingApproval' | 'ProvisioningCompleted' | 'ProvisioningFailed' | 'ProvisioningStarted' | 'Validating' | string (ReadOnly): The state of the connection. -* **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. -* **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. -## PeeringSku +## PeeringServicePrefixEvent ### Properties -* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. -* **name**: 'Basic_Direct_Free' | 'Basic_Exchange_Free' | 'Premium_Direct_Free' | 'Premium_Direct_Metered' | 'Premium_Direct_Unlimited' | 'Premium_Exchange_Metered' | string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. -## PeeringTags +## PeeringServicePrefixProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. ## PeeringServiceProperties ### Properties @@ -135,20 +136,19 @@ ### Additional Properties * **Additional Properties Type**: string -## PeeringServicePrefixProperties +## PeeringSku ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. +* **name**: 'Basic_Direct_Free' | 'Basic_Exchange_Free' | 'Premium_Direct_Free' | 'Premium_Direct_Metered' | 'Premium_Direct_Unlimited' | 'Premium_Exchange_Metered' | string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. -## PeeringServicePrefixEvent +## PeeringTags ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +### Additional Properties +* **Additional Properties Type**: string + +## SubResource +### Properties +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2020-01-01-preview/types.md b/generated/peering/microsoft.peering/2020-01-01-preview/types.md index 7f4b883cac..3de2b00497 100644 --- a/generated/peering/microsoft.peering/2020-01-01-preview/types.md +++ b/generated/peering/microsoft.peering/2020-01-01-preview/types.md @@ -61,13 +61,19 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. ## ContactDetail ### Properties @@ -75,20 +81,6 @@ * **phone**: string: The phone number of the contact. * **role**: 'Noc' | 'Other' | 'Policy' | 'Service' | 'Technical' | string: The role of the contact. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -101,29 +93,6 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession -### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. - -## SubResource -### Properties -* **id**: string: The identifier of the referenced resource. - -## PeeringPropertiesExchange -### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. - ## ExchangeConnection ### Properties * **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. @@ -132,17 +101,32 @@ * **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. * **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## PeeringSku +## PeerAsnProperties ### Properties -* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. -* **name**: string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. -## PeeringTags +## PeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. + +## PeeringPropertiesExchange +### Properties +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. ## PeeringRegisteredAsnProperties ### Properties @@ -158,6 +142,24 @@ * **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +## PeeringServicePrefixEvent +### Properties +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. + +## PeeringServicePrefixProperties +### Properties +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **peeringServicePrefixKey**: string: The peering service prefix key +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## PeeringServiceProperties ### Properties * **peeringServiceLocation**: string: The PeeringServiceLocation of the Customer. @@ -173,21 +175,19 @@ ### Additional Properties * **Additional Properties Type**: string -## PeeringServicePrefixProperties +## PeeringSku ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **peeringServicePrefixKey**: string: The peering service prefix key -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. +* **name**: string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. -## PeeringServicePrefixEvent +## PeeringTags ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +### Additional Properties +* **Additional Properties Type**: string + +## SubResource +### Properties +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2020-04-01/types.md b/generated/peering/microsoft.peering/2020-04-01/types.md index f25af099d9..c466e5fbb9 100644 --- a/generated/peering/microsoft.peering/2020-04-01/types.md +++ b/generated/peering/microsoft.peering/2020-04-01/types.md @@ -61,13 +61,19 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. ## ContactDetail ### Properties @@ -75,20 +81,6 @@ * **phone**: string: The phone number of the contact. * **role**: 'Escalation' | 'Noc' | 'Other' | 'Policy' | 'Service' | 'Technical' | string: The role of the contact. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -101,29 +93,6 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession -### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. - -## SubResource -### Properties -* **id**: string: The identifier of the referenced resource. - -## PeeringPropertiesExchange -### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. - ## ExchangeConnection ### Properties * **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. @@ -132,17 +101,32 @@ * **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. * **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## PeeringSku +## PeerAsnProperties ### Properties -* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. -* **name**: string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. -## PeeringTags +## PeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. + +## PeeringPropertiesExchange +### Properties +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. ## PeeringRegisteredAsnProperties ### Properties @@ -158,6 +142,24 @@ * **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +## PeeringServicePrefixEvent +### Properties +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. + +## PeeringServicePrefixProperties +### Properties +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **peeringServicePrefixKey**: string: The peering service prefix key +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## PeeringServiceProperties ### Properties * **peeringServiceLocation**: string: The PeeringServiceLocation of the Customer. @@ -173,21 +175,19 @@ ### Additional Properties * **Additional Properties Type**: string -## PeeringServicePrefixProperties +## PeeringSku ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **peeringServicePrefixKey**: string: The peering service prefix key -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. +* **name**: string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. -## PeeringServicePrefixEvent +## PeeringTags ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +### Additional Properties +* **Additional Properties Type**: string + +## SubResource +### Properties +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2020-10-01/types.md b/generated/peering/microsoft.peering/2020-10-01/types.md index 81bf6079d4..2cf4df4b30 100644 --- a/generated/peering/microsoft.peering/2020-10-01/types.md +++ b/generated/peering/microsoft.peering/2020-10-01/types.md @@ -61,13 +61,19 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. ## ContactDetail ### Properties @@ -75,20 +81,6 @@ * **phone**: string: The phone number of the contact. * **role**: 'Escalation' | 'Noc' | 'Other' | 'Policy' | 'Service' | 'Technical' | string: The role of the contact. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -102,29 +94,6 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession -### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. - -## SubResource -### Properties -* **id**: string: The identifier of the referenced resource. - -## PeeringPropertiesExchange -### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. - ## ExchangeConnection ### Properties * **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. @@ -133,17 +102,32 @@ * **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. * **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## PeeringSku +## PeerAsnProperties ### Properties -* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. -* **name**: string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. -## PeeringTags +## PeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. + +## PeeringPropertiesExchange +### Properties +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. ## PeeringRegisteredAsnProperties ### Properties @@ -159,6 +143,24 @@ * **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +## PeeringServicePrefixEvent +### Properties +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. + +## PeeringServicePrefixProperties +### Properties +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **peeringServicePrefixKey**: string: The peering service prefix key +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## PeeringServiceProperties ### Properties * **peeringServiceLocation**: string: The PeeringServiceLocation of the Customer. @@ -174,21 +176,19 @@ ### Additional Properties * **Additional Properties Type**: string -## PeeringServicePrefixProperties +## PeeringSku ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **peeringServicePrefixKey**: string: The peering service prefix key -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. +* **name**: string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. -## PeeringServicePrefixEvent +## PeeringTags ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +### Additional Properties +* **Additional Properties Type**: string + +## SubResource +### Properties +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2021-01-01/types.md b/generated/peering/microsoft.peering/2021-01-01/types.md index 6e22061a69..42f0c7245b 100644 --- a/generated/peering/microsoft.peering/2021-01-01/types.md +++ b/generated/peering/microsoft.peering/2021-01-01/types.md @@ -61,13 +61,19 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. ## ContactDetail ### Properties @@ -75,20 +81,6 @@ * **phone**: string: The phone number of the contact. * **role**: 'Escalation' | 'Noc' | 'Other' | 'Policy' | 'Service' | 'Technical' | string: The role of the contact. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | 'Voice' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -102,29 +94,6 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession -### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. - -## SubResource -### Properties -* **id**: string: The identifier of the referenced resource. - -## PeeringPropertiesExchange -### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. - ## ExchangeConnection ### Properties * **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. @@ -133,17 +102,32 @@ * **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. * **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## PeeringSku +## PeerAsnProperties ### Properties -* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. -* **name**: string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string: The validation state of the ASN associated with the peer. -## PeeringTags +## PeeringProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | 'Voice' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. + +## PeeringPropertiesExchange +### Properties +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. ## PeeringRegisteredAsnProperties ### Properties @@ -159,6 +143,24 @@ * **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +## PeeringServicePrefixEvent +### Properties +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. + +## PeeringServicePrefixProperties +### Properties +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **peeringServicePrefixKey**: string: The peering service prefix key +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## PeeringServiceProperties ### Properties * **peeringServiceLocation**: string: The location (state/province) of the customer. @@ -176,21 +178,19 @@ ### Additional Properties * **Additional Properties Type**: string -## PeeringServicePrefixProperties +## PeeringSku ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **peeringServicePrefixKey**: string: The peering service prefix key -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **family**: 'Direct' | 'Exchange' | string: The family of the peering SKU. +* **name**: string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string: The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string: The tier of the peering SKU. -## PeeringServicePrefixEvent +## PeeringTags ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +### Additional Properties +* **Additional Properties Type**: string + +## SubResource +### Properties +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2021-06-01/types.md b/generated/peering/microsoft.peering/2021-06-01/types.md index cff573a600..3cacd88e73 100644 --- a/generated/peering/microsoft.peering/2021-06-01/types.md +++ b/generated/peering/microsoft.peering/2021-06-01/types.md @@ -70,13 +70,29 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string (ReadOnly): The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. + +## ConnectionMonitorTestProperties +### Properties +* **destination**: string: The Connection Monitor test destination +* **destinationPort**: int: The Connection Monitor test destination port +* **isTestSuccessful**: bool (ReadOnly): The flag that indicates if the Connection Monitor test is successful or not. +* **path**: string[] (ReadOnly): The path representing the Connection Monitor test. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **sourceAgent**: string: The Connection Monitor test source agent +* **testFrequencyInSec**: int: The Connection Monitor test frequency in seconds ## ContactDetail ### Properties @@ -84,20 +100,6 @@ * **phone**: string: The phone number of the contact. * **role**: 'Escalation' | 'Noc' | 'Other' | 'Policy' | 'Service' | 'Technical' | string: The role of the contact. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | 'Voice' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -111,29 +113,6 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession -### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. - -## SubResource -### Properties -* **id**: string: The identifier of the referenced resource. - -## PeeringPropertiesExchange -### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. - ## ExchangeConnection ### Properties * **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. @@ -142,17 +121,38 @@ * **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. * **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## PeeringSku +## LogAnalyticsWorkspaceProperties ### Properties -* **family**: 'Direct' | 'Exchange' | string (ReadOnly): The family of the peering SKU. -* **name**: string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string (ReadOnly): The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string (ReadOnly): The tier of the peering SKU. +* **connectedAgents**: string[] (ReadOnly): The list of connected agents. +* **key**: string (ReadOnly): The Workspace Key. +* **workspaceID**: string (ReadOnly): The Workspace ID. -## PeeringTags +## PeerAsnProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string (ReadOnly): The validation state of the ASN associated with the peer. + +## PeeringProperties +### Properties +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | 'Voice' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. + +## PeeringPropertiesExchange +### Properties +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. ## PeeringRegisteredAsnProperties ### Properties @@ -168,6 +168,24 @@ * **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +## PeeringServicePrefixEvent +### Properties +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. + +## PeeringServicePrefixProperties +### Properties +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **peeringServicePrefixKey**: string: The peering service prefix key +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## PeeringServiceProperties ### Properties * **logAnalyticsWorkspaceProperties**: [LogAnalyticsWorkspaceProperties](#loganalyticsworkspaceproperties): The properties that define a Log Analytics Workspace. @@ -177,12 +195,6 @@ * **providerPrimaryPeeringLocation**: string: The primary peering (Microsoft/service provider) location to be used for customer traffic. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -## LogAnalyticsWorkspaceProperties -### Properties -* **connectedAgents**: string[] (ReadOnly): The list of connected agents. -* **key**: string (ReadOnly): The Workspace Key. -* **workspaceID**: string (ReadOnly): The Workspace ID. - ## PeeringServiceSku ### Properties * **name**: string: The name of the peering service SKU. @@ -192,31 +204,19 @@ ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorTestProperties +## PeeringSku ### Properties -* **destination**: string: The Connection Monitor test destination -* **destinationPort**: int: The Connection Monitor test destination port -* **isTestSuccessful**: bool (ReadOnly): The flag that indicates if the Connection Monitor test is successful or not. -* **path**: string[] (ReadOnly): The path representing the Connection Monitor test. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **sourceAgent**: string: The Connection Monitor test source agent -* **testFrequencyInSec**: int: The Connection Monitor test frequency in seconds +* **family**: 'Direct' | 'Exchange' | string (ReadOnly): The family of the peering SKU. +* **name**: string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string (ReadOnly): The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string (ReadOnly): The tier of the peering SKU. -## PeeringServicePrefixProperties +## PeeringTags ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **peeringServicePrefixKey**: string: The peering service prefix key -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## PeeringServicePrefixEvent +## SubResource ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +* **id**: string: The identifier of the referenced resource. diff --git a/generated/peering/microsoft.peering/2022-01-01/types.md b/generated/peering/microsoft.peering/2022-01-01/types.md index 7363393f7f..b8da92407c 100644 --- a/generated/peering/microsoft.peering/2022-01-01/types.md +++ b/generated/peering/microsoft.peering/2022-01-01/types.md @@ -70,13 +70,29 @@ * **properties**: [PeeringServicePrefixProperties](#peeringserviceprefixproperties): The peering service prefix properties class. * **type**: 'Microsoft.Peering/peeringServices/prefixes' (ReadOnly, DeployTimeConstant): The resource type -## PeerAsnProperties +## BgpSession ### Properties -* **errorMessage**: string (ReadOnly): The error message for the validation state -* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. -* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. -* **peerName**: string: The name of the peer. -* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string (ReadOnly): The validation state of the ASN associated with the peer. +* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. +* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. +* **md5AuthenticationKey**: string: The MD5 authentication key of the session. +* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. +* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. +* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. +* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. +* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. +* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. +* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. +* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. + +## ConnectionMonitorTestProperties +### Properties +* **destination**: string: The Connection Monitor test destination +* **destinationPort**: int: The Connection Monitor test destination port +* **isTestSuccessful**: bool (ReadOnly): The flag that indicates if the Connection Monitor test is successful or not. +* **path**: string[] (ReadOnly): The path representing the Connection Monitor test. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +* **sourceAgent**: string: The Connection Monitor test source agent +* **testFrequencyInSec**: int: The Connection Monitor test frequency in seconds ## ContactDetail ### Properties @@ -84,20 +100,6 @@ * **phone**: string: The phone number of the contact. * **role**: 'Escalation' | 'Noc' | 'Other' | 'Policy' | 'Service' | 'Technical' | string: The role of the contact. -## PeeringProperties -### Properties -* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. -* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. -* **peeringLocation**: string: The location of the peering. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. - -## PeeringPropertiesDirect -### Properties -* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. -* **directPeeringType**: 'Cdn' | 'Edge' | 'EdgeZoneForOperators' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | 'Voice' | string: The type of direct peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. -* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. - ## DirectConnection ### Properties * **bandwidthInMbps**: int: The bandwidth of the connection. @@ -111,29 +113,6 @@ * **sessionAddressProvider**: 'Microsoft' | 'Peer' | string: The field indicating if Microsoft provides session ip addresses. * **useForPeeringService**: bool: The flag that indicates whether or not the connection is used for peering service. -## BgpSession -### Properties -* **maxPrefixesAdvertisedV4**: int: The maximum number of prefixes advertised over the IPv4 session. -* **maxPrefixesAdvertisedV6**: int: The maximum number of prefixes advertised over the IPv6 session. -* **md5AuthenticationKey**: string: The MD5 authentication key of the session. -* **microsoftSessionIPv4Address**: string: The IPv4 session address on Microsoft's end. -* **microsoftSessionIPv6Address**: string: The IPv6 session address on Microsoft's end. -* **peerSessionIPv4Address**: string: The IPv4 session address on peer's end. -* **peerSessionIPv6Address**: string: The IPv6 session address on peer's end. -* **sessionPrefixV4**: string: The IPv4 prefix that contains both ends' IPv4 addresses. -* **sessionPrefixV6**: string: The IPv6 prefix that contains both ends' IPv6 addresses. -* **sessionStateV4**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv4 session. -* **sessionStateV6**: 'Active' | 'Connect' | 'Established' | 'Idle' | 'None' | 'OpenConfirm' | 'OpenReceived' | 'OpenSent' | 'PendingAdd' | 'PendingRemove' | 'PendingUpdate' | string (ReadOnly): The state of the IPv6 session. - -## SubResource -### Properties -* **id**: string: The identifier of the referenced resource. - -## PeeringPropertiesExchange -### Properties -* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. -* **peerAsn**: [SubResource](#subresource): The sub resource. - ## ExchangeConnection ### Properties * **bgpSession**: [BgpSession](#bgpsession): The properties that define a BGP session. @@ -142,17 +121,38 @@ * **errorMessage**: string (ReadOnly): The error message related to the connection state, if any. * **peeringDBFacilityId**: int: The PeeringDB.com ID of the facility at which the connection has to be set up. -## PeeringSku +## LogAnalyticsWorkspaceProperties ### Properties -* **family**: 'Direct' | 'Exchange' | string (ReadOnly): The family of the peering SKU. -* **name**: string: The name of the peering SKU. -* **size**: 'Free' | 'Metered' | 'Unlimited' | string (ReadOnly): The size of the peering SKU. -* **tier**: 'Basic' | 'Premium' | string (ReadOnly): The tier of the peering SKU. +* **connectedAgents**: string[] (ReadOnly): The list of connected agents. +* **key**: string (ReadOnly): The Workspace Key. +* **workspaceID**: string (ReadOnly): The Workspace ID. -## PeeringTags +## PeerAsnProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **errorMessage**: string (ReadOnly): The error message for the validation state +* **peerAsn**: int: The Autonomous System Number (ASN) of the peer. +* **peerContactDetail**: [ContactDetail](#contactdetail)[]: The contact details of the peer. +* **peerName**: string: The name of the peer. +* **validationState**: 'Approved' | 'Failed' | 'None' | 'Pending' | string (ReadOnly): The validation state of the ASN associated with the peer. + +## PeeringProperties +### Properties +* **direct**: [PeeringPropertiesDirect](#peeringpropertiesdirect): The properties that define a direct peering. +* **exchange**: [PeeringPropertiesExchange](#peeringpropertiesexchange): The properties that define an exchange peering. +* **peeringLocation**: string: The location of the peering. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + +## PeeringPropertiesDirect +### Properties +* **connections**: [DirectConnection](#directconnection)[]: The set of connections that constitute a direct peering. +* **directPeeringType**: 'Cdn' | 'Edge' | 'EdgeZoneForOperators' | 'Internal' | 'Ix' | 'IxRs' | 'Transit' | 'Voice' | string: The type of direct peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. +* **useForPeeringService**: bool (ReadOnly): The flag that indicates whether or not the peering is used for peering service. + +## PeeringPropertiesExchange +### Properties +* **connections**: [ExchangeConnection](#exchangeconnection)[]: The set of connections that constitute an exchange peering. +* **peerAsn**: [SubResource](#subresource): The sub resource. ## PeeringRegisteredAsnProperties ### Properties @@ -168,6 +168,24 @@ * **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +## PeeringServicePrefixEvent +### Properties +* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. +* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. +* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. +* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. +* **eventType**: string (ReadOnly): The type of the event associated with a prefix. + +## PeeringServicePrefixProperties +### Properties +* **errorMessage**: string (ReadOnly): The error message for validation state +* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix +* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type +* **peeringServicePrefixKey**: string: The peering service prefix key +* **prefix**: string: The prefix from which your traffic originates. +* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. + ## PeeringServiceProperties ### Properties * **logAnalyticsWorkspaceProperties**: [LogAnalyticsWorkspaceProperties](#loganalyticsworkspaceproperties): The properties that define a Log Analytics Workspace. @@ -177,12 +195,6 @@ * **providerPrimaryPeeringLocation**: string: The primary peering (Microsoft/service provider) location to be used for customer traffic. * **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -## LogAnalyticsWorkspaceProperties -### Properties -* **connectedAgents**: string[] (ReadOnly): The list of connected agents. -* **key**: string (ReadOnly): The Workspace Key. -* **workspaceID**: string (ReadOnly): The Workspace ID. - ## PeeringServiceSku ### Properties * **name**: string: The name of the peering service SKU. @@ -192,31 +204,19 @@ ### Additional Properties * **Additional Properties Type**: string -## ConnectionMonitorTestProperties +## PeeringSku ### Properties -* **destination**: string: The Connection Monitor test destination -* **destinationPort**: int: The Connection Monitor test destination port -* **isTestSuccessful**: bool (ReadOnly): The flag that indicates if the Connection Monitor test is successful or not. -* **path**: string[] (ReadOnly): The path representing the Connection Monitor test. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. -* **sourceAgent**: string: The Connection Monitor test source agent -* **testFrequencyInSec**: int: The Connection Monitor test frequency in seconds +* **family**: 'Direct' | 'Exchange' | string (ReadOnly): The family of the peering SKU. +* **name**: string: The name of the peering SKU. +* **size**: 'Free' | 'Metered' | 'Unlimited' | string (ReadOnly): The size of the peering SKU. +* **tier**: 'Basic' | 'Premium' | string (ReadOnly): The tier of the peering SKU. -## PeeringServicePrefixProperties +## PeeringTags ### Properties -* **errorMessage**: string (ReadOnly): The error message for validation state -* **events**: [PeeringServicePrefixEvent](#peeringserviceprefixevent)[] (ReadOnly): The list of events for peering service prefix -* **learnedType**: 'None' | 'ViaServiceProvider' | 'ViaSession' | string (ReadOnly): The prefix learned type -* **peeringServicePrefixKey**: string: The peering service prefix key -* **prefix**: string: The prefix from which your traffic originates. -* **prefixValidationState**: 'Failed' | 'Invalid' | 'None' | 'Pending' | 'Unknown' | 'Verified' | 'Warning' | string (ReadOnly): The prefix validation state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. +### Additional Properties +* **Additional Properties Type**: string -## PeeringServicePrefixEvent +## SubResource ### Properties -* **eventDescription**: string (ReadOnly): The description of the event associated with a prefix. -* **eventLevel**: string (ReadOnly): The level of the event associated with a prefix. -* **eventSummary**: string (ReadOnly): The summary of the event associated with a prefix. -* **eventTimestamp**: string (ReadOnly): The timestamp of the event associated with a prefix. -* **eventType**: string (ReadOnly): The type of the event associated with a prefix. +* **id**: string: The identifier of the referenced resource. diff --git a/generated/policyinsights/log.out b/generated/policyinsights/log.out index 310dba2229..7136f31497 100644 --- a/generated/policyinsights/log.out +++ b/generated/policyinsights/log.out @@ -13,7 +13,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.policyinsights-2018-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -26,7 +26,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyTrackedResourcesQueryResults' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json:233:5 @@ -102,7 +102,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RemediationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/remediations.json:1054:5 @@ -127,7 +127,7 @@ warning | PreCheck/SchemaMissingType | The schema 'TypedErrorInfo' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'TypedErrorInfo-info' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/remediations.json#/components/schemas/TypedErrorInfo-info -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.policyinsights-2019-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -140,7 +140,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyEventsQueryResults' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json:680:5 @@ -201,7 +201,7 @@ warning | Modeler/MissingType | The schema 'components·hezmy5·schemas·compone file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json#/components/schemas/components·hezmy5·schemas·componentstatedetails·additionalproperties warning | Modeler/MissingType | The schema 'TypedErrorInfo-info' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyMetadata.json#/components/schemas/TypedErrorInfo-info -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.policyinsights-2022-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -214,7 +214,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CheckRestrictionsRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2022-03-01/checkPolicyRestrictions.json:167:5 @@ -253,7 +253,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AttestationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-01-01/attestations.json:545:5 @@ -285,7 +285,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CheckRestrictionsRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2020-07-01/checkPolicyRestrictions.json:122:5 @@ -324,7 +324,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RemediationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-07-01/remediations.json:1054:5 @@ -362,7 +362,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CheckRestrictionsRequest' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2020-07-01-preview/checkPolicyRestrictions.json:122:5 @@ -388,7 +388,7 @@ warning | PreCheck/SchemaMissingType | The schema 'TypedErrorInfo' with an undef warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'TypedErrorInfo-info' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyMetadata.json#/components/schemas/TypedErrorInfo-info -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.policyinsights-2018-04-04"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -401,7 +401,7 @@ warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyEventsQueryResults' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json:584:5 @@ -437,4 +437,4 @@ warning | Modeler/MissingType | The schema 'components·1twbxlw·schemas·policy warning | Modeler/MissingType | The schema 'components·1yhb3ub·schemas·policystate·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json#/components/schemas/components·1yhb3ub·schemas·policystate·additionalproperties info | autorest.bicep took 0ms -info | Autorest completed in 28.9s. 8 files generated. +info | Autorest completed in 26.99s. 8 files generated. diff --git a/generated/policyinsights/microsoft.policyinsights/2018-07-01-preview/types.md b/generated/policyinsights/microsoft.policyinsights/2018-07-01-preview/types.md index fc5220205b..a5a923a64a 100644 --- a/generated/policyinsights/microsoft.policyinsights/2018-07-01-preview/types.md +++ b/generated/policyinsights/microsoft.policyinsights/2018-07-01-preview/types.md @@ -14,15 +14,28 @@ * **ApiVersion**: 2018-07-01-preview * **Output**: [RemediationDeploymentsListResult](#remediationdeploymentslistresult) -## RemediationProperties +## ErrorDefinition +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[] (ReadOnly): Additional scenario specific error details. +* **code**: string (ReadOnly): Service specific error code which serves as the substatus for the HTTP error code. +* **details**: [ErrorDefinition](#errordefinition)[] (ReadOnly): Internal error details. +* **message**: string (ReadOnly): Description of the error. +* **target**: string (ReadOnly): The target of the error. + +## RemediationDeployment ### Properties * **createdOn**: string (ReadOnly): The time at which the remediation was created. -* **deploymentStatus**: [RemediationDeploymentSummary](#remediationdeploymentsummary): The deployment status summary for all deployments created by the remediation. -* **filters**: [RemediationFilters](#remediationfilters): The filters that will be applied to determine which resources to remediate. -* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation was last updated. -* **policyAssignmentId**: string: The resource ID of the policy assignment that should be remediated. -* **policyDefinitionReferenceId**: string: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. -* **provisioningState**: string (ReadOnly): The status of the remediation. +* **deploymentId**: string (ReadOnly): Resource ID of the template deployment that will remediate the resource. +* **error**: [ErrorDefinition](#errordefinition) (ReadOnly): Error definition. +* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation deployment was last updated. +* **remediatedResourceId**: string (ReadOnly): Resource ID of the resource that is being remediated by the deployment. +* **resourceLocation**: string (ReadOnly): Location of the resource that is being remediated. +* **status**: string (ReadOnly): Status of the remediation deployment. + +## RemediationDeploymentsListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [RemediationDeployment](#remediationdeployment)[] (ReadOnly): Array of deployments for the remediation. ## RemediationDeploymentSummary ### Properties @@ -34,28 +47,15 @@ ### Properties * **locations**: string[]: The resource locations that will be remediated. -## RemediationDeploymentsListResult -### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [RemediationDeployment](#remediationdeployment)[] (ReadOnly): Array of deployments for the remediation. - -## RemediationDeployment +## RemediationProperties ### Properties * **createdOn**: string (ReadOnly): The time at which the remediation was created. -* **deploymentId**: string (ReadOnly): Resource ID of the template deployment that will remediate the resource. -* **error**: [ErrorDefinition](#errordefinition) (ReadOnly): Error definition. -* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation deployment was last updated. -* **remediatedResourceId**: string (ReadOnly): Resource ID of the resource that is being remediated by the deployment. -* **resourceLocation**: string (ReadOnly): Location of the resource that is being remediated. -* **status**: string (ReadOnly): Status of the remediation deployment. - -## ErrorDefinition -### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[] (ReadOnly): Additional scenario specific error details. -* **code**: string (ReadOnly): Service specific error code which serves as the substatus for the HTTP error code. -* **details**: [ErrorDefinition](#errordefinition)[] (ReadOnly): Internal error details. -* **message**: string (ReadOnly): Description of the error. -* **target**: string (ReadOnly): The target of the error. +* **deploymentStatus**: [RemediationDeploymentSummary](#remediationdeploymentsummary): The deployment status summary for all deployments created by the remediation. +* **filters**: [RemediationFilters](#remediationfilters): The filters that will be applied to determine which resources to remediate. +* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation was last updated. +* **policyAssignmentId**: string: The resource ID of the policy assignment that should be remediated. +* **policyDefinitionReferenceId**: string: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. +* **provisioningState**: string (ReadOnly): The status of the remediation. ## TypedErrorInfo ### Properties diff --git a/generated/policyinsights/microsoft.policyinsights/2019-07-01/types.md b/generated/policyinsights/microsoft.policyinsights/2019-07-01/types.md index d36a02583b..c5bb471ffb 100644 --- a/generated/policyinsights/microsoft.policyinsights/2019-07-01/types.md +++ b/generated/policyinsights/microsoft.policyinsights/2019-07-01/types.md @@ -14,16 +14,28 @@ * **ApiVersion**: 2019-07-01 * **Output**: [RemediationDeploymentsListResult](#remediationdeploymentslistresult) -## RemediationProperties +## ErrorDefinition +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[] (ReadOnly): Additional scenario specific error details. +* **code**: string (ReadOnly): Service specific error code which serves as the substatus for the HTTP error code. +* **details**: [ErrorDefinition](#errordefinition)[] (ReadOnly): Internal error details. +* **message**: string (ReadOnly): Description of the error. +* **target**: string (ReadOnly): The target of the error. + +## RemediationDeployment ### Properties * **createdOn**: string (ReadOnly): The time at which the remediation was created. -* **deploymentStatus**: [RemediationDeploymentSummary](#remediationdeploymentsummary) (ReadOnly): The deployment status summary for all deployments created by the remediation. -* **filters**: [RemediationFilters](#remediationfilters): The filters that will be applied to determine which resources to remediate. -* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation was last updated. -* **policyAssignmentId**: string: The resource ID of the policy assignment that should be remediated. -* **policyDefinitionReferenceId**: string: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. -* **provisioningState**: string (ReadOnly): The status of the remediation. -* **resourceDiscoveryMode**: 'ExistingNonCompliant' | 'ReEvaluateCompliance' | string: The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. +* **deploymentId**: string (ReadOnly): Resource ID of the template deployment that will remediate the resource. +* **error**: [ErrorDefinition](#errordefinition) (ReadOnly): Error definition. +* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation deployment was last updated. +* **remediatedResourceId**: string (ReadOnly): Resource ID of the resource that is being remediated by the deployment. +* **resourceLocation**: string (ReadOnly): Location of the resource that is being remediated. +* **status**: string (ReadOnly): Status of the remediation deployment. + +## RemediationDeploymentsListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [RemediationDeployment](#remediationdeployment)[] (ReadOnly): Array of deployments for the remediation. ## RemediationDeploymentSummary ### Properties @@ -35,28 +47,16 @@ ### Properties * **locations**: string[]: The resource locations that will be remediated. -## RemediationDeploymentsListResult -### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [RemediationDeployment](#remediationdeployment)[] (ReadOnly): Array of deployments for the remediation. - -## RemediationDeployment +## RemediationProperties ### Properties * **createdOn**: string (ReadOnly): The time at which the remediation was created. -* **deploymentId**: string (ReadOnly): Resource ID of the template deployment that will remediate the resource. -* **error**: [ErrorDefinition](#errordefinition) (ReadOnly): Error definition. -* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation deployment was last updated. -* **remediatedResourceId**: string (ReadOnly): Resource ID of the resource that is being remediated by the deployment. -* **resourceLocation**: string (ReadOnly): Location of the resource that is being remediated. -* **status**: string (ReadOnly): Status of the remediation deployment. - -## ErrorDefinition -### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[] (ReadOnly): Additional scenario specific error details. -* **code**: string (ReadOnly): Service specific error code which serves as the substatus for the HTTP error code. -* **details**: [ErrorDefinition](#errordefinition)[] (ReadOnly): Internal error details. -* **message**: string (ReadOnly): Description of the error. -* **target**: string (ReadOnly): The target of the error. +* **deploymentStatus**: [RemediationDeploymentSummary](#remediationdeploymentsummary) (ReadOnly): The deployment status summary for all deployments created by the remediation. +* **filters**: [RemediationFilters](#remediationfilters): The filters that will be applied to determine which resources to remediate. +* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation was last updated. +* **policyAssignmentId**: string: The resource ID of the policy assignment that should be remediated. +* **policyDefinitionReferenceId**: string: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. +* **provisioningState**: string (ReadOnly): The status of the remediation. +* **resourceDiscoveryMode**: 'ExistingNonCompliant' | 'ReEvaluateCompliance' | string: The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. ## TypedErrorInfo ### Properties diff --git a/generated/policyinsights/microsoft.policyinsights/2021-01-01/types.md b/generated/policyinsights/microsoft.policyinsights/2021-01-01/types.md index a8e42d2586..b49ca571dd 100644 --- a/generated/policyinsights/microsoft.policyinsights/2021-01-01/types.md +++ b/generated/policyinsights/microsoft.policyinsights/2021-01-01/types.md @@ -10,6 +10,11 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.PolicyInsights/attestations' (ReadOnly, DeployTimeConstant): The resource type +## AttestationEvidence +### Properties +* **description**: string: The description for this piece of evidence. +* **sourceUri**: string: The URI location of the evidence. + ## AttestationProperties ### Properties * **comments**: string: Comments describing why this attestation was created. @@ -22,11 +27,6 @@ * **policyDefinitionReferenceId**: string: The policy definition reference ID from a policy set definition that the attestation is setting the state for. If the policy assignment assigns a policy set definition the attestation can choose a definition within the set definition with this property or omit this and set the state for the entire set definition. * **provisioningState**: string (ReadOnly): The status of the attestation. -## AttestationEvidence -### Properties -* **description**: string: The description for this piece of evidence. -* **sourceUri**: string: The URI location of the evidence. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/policyinsights/microsoft.policyinsights/2021-10-01/types.md b/generated/policyinsights/microsoft.policyinsights/2021-10-01/types.md index f3bd7ce14e..ef282c914c 100644 --- a/generated/policyinsights/microsoft.policyinsights/2021-10-01/types.md +++ b/generated/policyinsights/microsoft.policyinsights/2021-10-01/types.md @@ -15,6 +15,39 @@ * **ApiVersion**: 2021-10-01 * **Output**: [RemediationDeploymentsListResult](#remediationdeploymentslistresult) +## ErrorDefinition +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[] (ReadOnly): Additional scenario specific error details. +* **code**: string (ReadOnly): Service specific error code which serves as the substatus for the HTTP error code. +* **details**: [ErrorDefinition](#errordefinition)[] (ReadOnly): Internal error details. +* **message**: string (ReadOnly): Description of the error. +* **target**: string (ReadOnly): The target of the error. + +## RemediationDeployment +### Properties +* **createdOn**: string (ReadOnly): The time at which the remediation was created. +* **deploymentId**: string (ReadOnly): Resource ID of the template deployment that will remediate the resource. +* **error**: [ErrorDefinition](#errordefinition) (ReadOnly): Error definition. +* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation deployment was last updated. +* **remediatedResourceId**: string (ReadOnly): Resource ID of the resource that is being remediated by the deployment. +* **resourceLocation**: string (ReadOnly): Location of the resource that is being remediated. +* **status**: string (ReadOnly): Status of the remediation deployment. + +## RemediationDeploymentsListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to get the next set of results. +* **value**: [RemediationDeployment](#remediationdeployment)[] (ReadOnly): Array of deployments for the remediation. + +## RemediationDeploymentSummary +### Properties +* **failedDeployments**: int (ReadOnly): The number of deployments required by the remediation that have failed. +* **successfulDeployments**: int (ReadOnly): The number of deployments required by the remediation that have succeeded. +* **totalDeployments**: int (ReadOnly): The number of deployments required by the remediation. + +## RemediationFilters +### Properties +* **locations**: string[]: The resource locations that will be remediated. + ## RemediationProperties ### Properties * **correlationId**: string (ReadOnly): The remediation correlation Id. Can be used to find events related to the remediation in the activity log. @@ -31,20 +64,10 @@ * **resourceDiscoveryMode**: 'ExistingNonCompliant' | 'ReEvaluateCompliance' | string: The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified. * **statusMessage**: string (ReadOnly): The remediation status message. Provides additional details regarding the state of the remediation. -## RemediationDeploymentSummary -### Properties -* **failedDeployments**: int (ReadOnly): The number of deployments required by the remediation that have failed. -* **successfulDeployments**: int (ReadOnly): The number of deployments required by the remediation that have succeeded. -* **totalDeployments**: int (ReadOnly): The number of deployments required by the remediation. - ## RemediationPropertiesFailureThreshold ### Properties * **percentage**: int: A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold. -## RemediationFilters -### Properties -* **locations**: string[]: The resource locations that will be remediated. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -54,29 +77,6 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## RemediationDeploymentsListResult -### Properties -* **nextLink**: string (ReadOnly): The URL to get the next set of results. -* **value**: [RemediationDeployment](#remediationdeployment)[] (ReadOnly): Array of deployments for the remediation. - -## RemediationDeployment -### Properties -* **createdOn**: string (ReadOnly): The time at which the remediation was created. -* **deploymentId**: string (ReadOnly): Resource ID of the template deployment that will remediate the resource. -* **error**: [ErrorDefinition](#errordefinition) (ReadOnly): Error definition. -* **lastUpdatedOn**: string (ReadOnly): The time at which the remediation deployment was last updated. -* **remediatedResourceId**: string (ReadOnly): Resource ID of the resource that is being remediated by the deployment. -* **resourceLocation**: string (ReadOnly): Location of the resource that is being remediated. -* **status**: string (ReadOnly): Status of the remediation deployment. - -## ErrorDefinition -### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[] (ReadOnly): Additional scenario specific error details. -* **code**: string (ReadOnly): Service specific error code which serves as the substatus for the HTTP error code. -* **details**: [ErrorDefinition](#errordefinition)[] (ReadOnly): Internal error details. -* **message**: string (ReadOnly): Description of the error. -* **target**: string (ReadOnly): The target of the error. - ## TypedErrorInfo ### Properties * **info**: any (ReadOnly): Anything diff --git a/generated/portal/log.out b/generated/portal/log.out index 6179c4829c..415b8ed1ff 100644 --- a/generated/portal/log.out +++ b/generated/portal/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.portal-2020-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json:682:9 @@ -16,10 +16,10 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 15ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.portal-2019-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/portal.json:606:9 @@ -30,7 +30,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.portal-2018-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/portal/resource-manager/Microsoft.Portal/preview/2018-10-01-preview/portal.json:595:9 @@ -38,10 +38,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.portal-2015-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceProviderOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/portal/resource-manager/Microsoft.Portal/preview/2015-08-01-preview/portal.json:595:9 @@ -49,5 +49,5 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms -info | Autorest completed in 9.45s. 8 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 8.49s. 8 files generated. diff --git a/generated/portal/microsoft.portal/2015-08-01-preview/types.md b/generated/portal/microsoft.portal/2015-08-01-preview/types.md index 37f4a06b22..212bf49832 100644 --- a/generated/portal/microsoft.portal/2015-08-01-preview/types.md +++ b/generated/portal/microsoft.portal/2015-08-01-preview/types.md @@ -11,16 +11,6 @@ * **tags**: [DashboardTags](#dashboardtags): Resource tags * **type**: 'Microsoft.Portal/dashboards' (ReadOnly, DeployTimeConstant): The resource type -## DashboardProperties -### Properties -* **lenses**: [DashboardPropertiesLenses](#dashboardpropertieslenses): The dashboard lenses. -* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. - -## DashboardPropertiesLenses -### Properties -### Additional Properties -* **Additional Properties Type**: [DashboardLens](#dashboardlens) - ## DashboardLens ### Properties * **metadata**: [DashboardLensMetadata](#dashboardlensmetadata): The dashboard len's metadata. @@ -37,16 +27,16 @@ ### Additional Properties * **Additional Properties Type**: [DashboardParts](#dashboardparts) -## DashboardParts -### Properties -* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. -* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. - ## DashboardPartMetadata ### Properties ### Additional Properties * **Additional Properties Type**: any +## DashboardParts +### Properties +* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. +* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. + ## DashboardPartsPosition ### Properties * **colSpan**: int (Required): The dashboard's part column span. @@ -60,6 +50,16 @@ ### Additional Properties * **Additional Properties Type**: any +## DashboardProperties +### Properties +* **lenses**: [DashboardPropertiesLenses](#dashboardpropertieslenses): The dashboard lenses. +* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. + +## DashboardPropertiesLenses +### Properties +### Additional Properties +* **Additional Properties Type**: [DashboardLens](#dashboardlens) + ## DashboardPropertiesMetadata ### Properties ### Additional Properties diff --git a/generated/portal/microsoft.portal/2018-10-01-preview/types.md b/generated/portal/microsoft.portal/2018-10-01-preview/types.md index 2d6f568ed5..e00e780151 100644 --- a/generated/portal/microsoft.portal/2018-10-01-preview/types.md +++ b/generated/portal/microsoft.portal/2018-10-01-preview/types.md @@ -11,16 +11,6 @@ * **tags**: [DashboardTags](#dashboardtags): Resource tags * **type**: 'Microsoft.Portal/dashboards' (ReadOnly, DeployTimeConstant): The resource type -## DashboardProperties -### Properties -* **lenses**: [DashboardPropertiesLenses](#dashboardpropertieslenses): The dashboard lenses. -* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. - -## DashboardPropertiesLenses -### Properties -### Additional Properties -* **Additional Properties Type**: [DashboardLens](#dashboardlens) - ## DashboardLens ### Properties * **metadata**: [DashboardLensMetadata](#dashboardlensmetadata): The dashboard len's metadata. @@ -37,16 +27,16 @@ ### Additional Properties * **Additional Properties Type**: [DashboardParts](#dashboardparts) -## DashboardParts -### Properties -* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. -* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. - ## DashboardPartMetadata ### Properties ### Additional Properties * **Additional Properties Type**: any +## DashboardParts +### Properties +* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. +* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. + ## DashboardPartsPosition ### Properties * **colSpan**: int (Required): The dashboard's part column span. @@ -60,6 +50,16 @@ ### Additional Properties * **Additional Properties Type**: any +## DashboardProperties +### Properties +* **lenses**: [DashboardPropertiesLenses](#dashboardpropertieslenses): The dashboard lenses. +* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. + +## DashboardPropertiesLenses +### Properties +### Additional Properties +* **Additional Properties Type**: [DashboardLens](#dashboardlens) + ## DashboardPropertiesMetadata ### Properties ### Additional Properties diff --git a/generated/portal/microsoft.portal/2019-01-01-preview/types.md b/generated/portal/microsoft.portal/2019-01-01-preview/types.md index 6f6b8c6e4f..f5a9bc4a42 100644 --- a/generated/portal/microsoft.portal/2019-01-01-preview/types.md +++ b/generated/portal/microsoft.portal/2019-01-01-preview/types.md @@ -20,15 +20,9 @@ * **properties**: [ConfigurationProperties](#configurationproperties): Tenant configuration properties. * **type**: 'Microsoft.Portal/tenantConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## DashboardProperties -### Properties -* **lenses**: [DashboardPropertiesLenses](#dashboardpropertieslenses): The dashboard lenses. -* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. - -## DashboardPropertiesLenses +## ConfigurationProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [DashboardLens](#dashboardlens) +* **enforcePrivateMarkdownStorage**: bool: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ## DashboardLens ### Properties @@ -46,16 +40,16 @@ ### Additional Properties * **Additional Properties Type**: [DashboardParts](#dashboardparts) -## DashboardParts -### Properties -* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. -* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. - ## DashboardPartMetadata ### Properties ### Additional Properties * **Additional Properties Type**: any +## DashboardParts +### Properties +* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. +* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. + ## DashboardPartsPosition ### Properties * **colSpan**: int (Required): The dashboard's part column span. @@ -69,6 +63,16 @@ ### Additional Properties * **Additional Properties Type**: any +## DashboardProperties +### Properties +* **lenses**: [DashboardPropertiesLenses](#dashboardpropertieslenses): The dashboard lenses. +* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. + +## DashboardPropertiesLenses +### Properties +### Additional Properties +* **Additional Properties Type**: [DashboardLens](#dashboardlens) + ## DashboardPropertiesMetadata ### Properties ### Additional Properties @@ -79,7 +83,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ConfigurationProperties -### Properties -* **enforcePrivateMarkdownStorage**: bool: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. - diff --git a/generated/portal/microsoft.portal/2020-09-01-preview/types.md b/generated/portal/microsoft.portal/2020-09-01-preview/types.md index 65383962e1..0dec6f4092 100644 --- a/generated/portal/microsoft.portal/2020-09-01-preview/types.md +++ b/generated/portal/microsoft.portal/2020-09-01-preview/types.md @@ -20,10 +20,9 @@ * **properties**: [ConfigurationProperties](#configurationproperties): Tenant configuration properties. * **type**: 'Microsoft.Portal/tenantConfigurations' (ReadOnly, DeployTimeConstant): The resource type -## DashboardProperties +## ConfigurationProperties ### Properties -* **lenses**: [DashboardLens](#dashboardlens)[]: The dashboard lenses. -* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. +* **enforcePrivateMarkdownStorage**: bool: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. ## DashboardLens ### Properties @@ -36,11 +35,6 @@ ### Additional Properties * **Additional Properties Type**: any -## DashboardParts -### Properties -* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. -* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. - ## DashboardPartMetadata * **Discriminator**: type @@ -52,21 +46,10 @@ * **type**: 'Extension/HubsExtension/PartType/MarkdownPart' (Required): The type of dashboard part. -## MarkdownPartMetadataSettings -### Properties -* **content**: [MarkdownPartMetadataSettingsContent](#markdownpartmetadatasettingscontent): The content of markdown part. - -## MarkdownPartMetadataSettingsContent -### Properties -* **settings**: [MarkdownPartMetadataSettingsContentSettings](#markdownpartmetadatasettingscontentsettings): The setting of the content of markdown part. - -## MarkdownPartMetadataSettingsContentSettings +## DashboardParts ### Properties -* **content**: string: The content of the markdown part. -* **markdownSource**: int: The source of the content of the markdown part. -* **markdownUri**: string: The uri of markdown content. -* **subtitle**: string: The subtitle of the markdown part. -* **title**: string: The title of the markdown part. +* **metadata**: [DashboardPartMetadata](#dashboardpartmetadata): A dashboard part metadata. +* **position**: [DashboardPartsPosition](#dashboardpartsposition) (Required): The dashboard's part position. ## DashboardPartsPosition ### Properties @@ -81,6 +64,11 @@ ### Additional Properties * **Additional Properties Type**: any +## DashboardProperties +### Properties +* **lenses**: [DashboardLens](#dashboardlens)[]: The dashboard lenses. +* **metadata**: [DashboardPropertiesMetadata](#dashboardpropertiesmetadata): The dashboard metadata. + ## DashboardPropertiesMetadata ### Properties ### Additional Properties @@ -91,7 +79,19 @@ ### Additional Properties * **Additional Properties Type**: string -## ConfigurationProperties +## MarkdownPartMetadataSettings ### Properties -* **enforcePrivateMarkdownStorage**: bool: When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. +* **content**: [MarkdownPartMetadataSettingsContent](#markdownpartmetadatasettingscontent): The content of markdown part. + +## MarkdownPartMetadataSettingsContent +### Properties +* **settings**: [MarkdownPartMetadataSettingsContentSettings](#markdownpartmetadatasettingscontentsettings): The setting of the content of markdown part. + +## MarkdownPartMetadataSettingsContentSettings +### Properties +* **content**: string: The content of the markdown part. +* **markdownSource**: int: The source of the content of the markdown part. +* **markdownUri**: string: The uri of markdown content. +* **subtitle**: string: The subtitle of the markdown part. +* **title**: string: The title of the markdown part. diff --git a/generated/postgresql/log.out b/generated/postgresql/log.out index 4ca2cdda8a..359775eba3 100644 --- a/generated/postgresql/log.out +++ b/generated/postgresql/log.out @@ -12,11 +12,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageEditionCapability' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json:1161:5 @@ -71,7 +71,7 @@ info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageEditionCapability' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json:1161:5 @@ -123,7 +123,7 @@ info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2020-11-05-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DatabaseProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-11-05-preview/Databases.json:238:5 @@ -136,7 +136,7 @@ info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2020-02-14-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageEditionCapability' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json:1079:5 @@ -179,11 +179,11 @@ warning | PreCheck/SchemaMissingType | The schema 'NameAvailability' with an und warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json:1817:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2017-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServerProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json:1814:5 @@ -261,11 +261,11 @@ warning | PreCheck/SchemaMissingType | The schema 'ServerAdministratorResourceLi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json:2804:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'LogFile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from LogFile -info | autorest.bicep took 6ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json:384:5 @@ -313,7 +313,7 @@ info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json:299:5 @@ -322,7 +322,7 @@ info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.dbforpostgresql-2017-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServerProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json:1942:5 @@ -403,4 +403,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ServerAdministratorResourceLi warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'LogFile' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from LogFile info | autorest.bicep took 4ms -info | Autorest completed in 24.75s. 16 files generated. +info | Autorest completed in 23.2s. 16 files generated. diff --git a/generated/postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.md b/generated/postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.md index 7492eaf06f..2cc87ab49f 100644 --- a/generated/postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.md +++ b/generated/postgresql/microsoft.dbforpostgresql/2017-12-01-preview/types.md @@ -67,12 +67,74 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.DBforPostgreSQL/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **source**: string: Source of the configuration. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (ReadOnly): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. + ## ResourceIdentity ### Properties * **principalId**: string (ReadOnly): The Azure Active Directory principal id. * **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. * **type**: 'SystemAssigned' | string (ReadOnly): The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +## SecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## ServerAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. +* **login**: string (Required): The server administrator login account name. +* **sid**: string (Required): The server administrator Sid (Secure ID). +* **tenantId**: string (Required): The server Active Directory Administrator tenant id. + +## ServerForCreateTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id of the private endpoint connection. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + ## ServerPropertiesForCreate * **Discriminator**: createMode @@ -115,34 +177,6 @@ * **sourceServerId**: string (Required, WriteOnly): The master server id to create replica from. -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id of the private endpoint connection. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) (ReadOnly) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (ReadOnly): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. - -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. -* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. -* **storageMB**: int: Max storage allowed for a server. - ## Sku ### Properties * **capacity**: int: The scale up/out capacity, representing server's compute units. @@ -151,46 +185,12 @@ * **size**: string: The size code, to be interpreted by resource as appropriate. * **tier**: 'Basic' | 'GeneralPurpose' | 'MemoryOptimized' | string: The tier of the particular SKU, e.g. Basic. -## ServerForCreateTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServerAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. -* **login**: string (Required): The server administrator login account name. -* **sid**: string (Required): The server administrator Sid (Secure ID). -* **tenantId**: string (Required): The server Active Directory Administrator tenant id. - -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **source**: string: Source of the configuration. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## SecurityAlertPolicyProperties +## StorageProfile ### Properties -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. +* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. +* **storageMB**: int: Max storage allowed for a server. ## VirtualNetworkRuleProperties ### Properties diff --git a/generated/postgresql/microsoft.dbforpostgresql/2017-12-01/types.md b/generated/postgresql/microsoft.dbforpostgresql/2017-12-01/types.md index f753bfdaed..086edfb817 100644 --- a/generated/postgresql/microsoft.dbforpostgresql/2017-12-01/types.md +++ b/generated/postgresql/microsoft.dbforpostgresql/2017-12-01/types.md @@ -67,12 +67,74 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.DBforPostgreSQL/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **source**: string: Source of the configuration. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + +## PrivateEndpointProperty +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + ## ResourceIdentity ### Properties * **principalId**: string (ReadOnly): The Azure Active Directory principal id. * **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. * **type**: 'SystemAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +## SecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## ServerAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. +* **login**: string (Required): The server administrator login account name. +* **sid**: string (Required): The server administrator Sid (Secure ID). +* **tenantId**: string (Required): The server Active Directory Administrator tenant id. + +## ServerForCreateTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource ID of the Private Endpoint Connection. +* **properties**: [ServerPrivateEndpointConnectionProperties](#serverprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ServerPrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) +* **privateLinkServiceConnectionState**: [ServerPrivateLinkServiceConnectionStateProperty](#serverprivatelinkserviceconnectionstateproperty) (ReadOnly) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. + +## ServerPrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (ReadOnly): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. + ## ServerPropertiesForCreate * **Discriminator**: createMode @@ -115,34 +177,6 @@ * **sourceServerId**: string (Required, WriteOnly): The master server id to create replica from. -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID of the Private Endpoint Connection. -* **properties**: [ServerPrivateEndpointConnectionProperties](#serverprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ServerPrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) (ReadOnly) -* **privateLinkServiceConnectionState**: [ServerPrivateLinkServiceConnectionStateProperty](#serverprivatelinkserviceconnectionstateproperty) (ReadOnly) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## ServerPrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (ReadOnly): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): The private link service connection status. - -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. -* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. -* **storageMB**: int: Max storage allowed for a server. - ## Sku ### Properties * **capacity**: int: The scale up/out capacity, representing server's compute units. @@ -151,46 +185,12 @@ * **size**: string: The size code, to be interpreted by resource as appropriate. * **tier**: 'Basic' | 'GeneralPurpose' | 'MemoryOptimized' | string: The tier of the particular SKU, e.g. Basic. -## ServerForCreateTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServerAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. -* **login**: string (Required): The server administrator login account name. -* **sid**: string (Required): The server administrator Sid (Secure ID). -* **tenantId**: string (Required): The server Active Directory Administrator tenant id. - -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **source**: string: Source of the configuration. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - -## SecurityAlertPolicyProperties +## StorageProfile ### Properties -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: Enable Geo-redundant or not for server backup. +* **storageAutogrow**: 'Disabled' | 'Enabled' | string: Enable Storage Auto Grow. +* **storageMB**: int: Max storage allowed for a server. ## VirtualNetworkRuleProperties ### Properties diff --git a/generated/postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.md b/generated/postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.md index bb97373af0..5ffb3d821c 100644 --- a/generated/postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.md +++ b/generated/postgresql/microsoft.dbforpostgresql/2020-02-14-preview/types.md @@ -22,12 +22,24 @@ * **properties**: [FirewallRuleProperties](#firewallruleproperties) (Required): The properties of a server firewall rule. * **type**: 'Microsoft.DBForPostgreSql/flexibleServers/firewallRules' (ReadOnly, DeployTimeConstant): The resource type +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'SystemAssigned': The identity type. +## MaintenanceWindow +### Properties +* **customWindow**: string: indicates whether custom window is enabled or disabled +* **dayOfWeek**: int: day of week for maintenance window +* **startHour**: int: start hour for maintenance window +* **startMinute**: int: start minute for maintenance window + ## ServerProperties ### Properties * **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). @@ -61,23 +73,10 @@ ### Properties * **subnetArmResourceId**: string: delegated subnet arm resource id. -## MaintenanceWindow -### Properties -* **customWindow**: string: indicates whether custom window is enabled or disabled -* **dayOfWeek**: int: day of week for maintenance window -* **startHour**: int: start hour for maintenance window -* **startMinute**: int: start minute for maintenance window - ## ServerPropertiesPrivateDnsZoneArguments ### Properties * **privateDnsZoneArmResourceId**: string: private dns zone arm resource id. -## StorageProfile -### Properties -* **backupRetentionDays**: int: Backup retention days for the server. -* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: A value indicating whether Geo-Redundant backup is enabled on the server. -* **storageMB**: int: Max storage allowed for a server. - ## ServerPropertiesTags ### Properties ### Additional Properties @@ -88,13 +87,14 @@ * **name**: string (Required): The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. * **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. Burstable. +## StorageProfile +### Properties +* **backupRetentionDays**: int: Backup retention days for the server. +* **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: A value indicating whether Geo-Redundant backup is enabled on the server. +* **storageMB**: int: Max storage allowed for a server. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - diff --git a/generated/postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.md b/generated/postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.md index aaf274573e..b8cb49b739 100644 --- a/generated/postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.md +++ b/generated/postgresql/microsoft.dbforpostgresql/2021-06-01-preview/types.md @@ -33,30 +33,31 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DBforPostgreSQL/flexibleServers/firewallRules' (ReadOnly, DeployTimeConstant): The resource type -## ServerProperties -### Properties -* **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **availabilityZone**: string: availability zone information of the server. -* **backup**: [Backup](#backup): Backup properties of a server -* **createMode**: 'Create' | 'Default' | 'PointInTimeRestore' | 'Update' | string (WriteOnly): The mode to create a new PostgreSQL server. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of a server. -* **highAvailability**: [HighAvailability](#highavailability): High availability properties of a server -* **maintenanceWindow**: [MaintenanceWindow](#maintenancewindow): Maintenance window properties of a server. -* **minorVersion**: string (ReadOnly): The minor version of the server. -* **network**: [Network](#network): Network properties of a server -* **pointInTimeUTC**: string (WriteOnly): Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. -* **sourceServerResourceId**: string (WriteOnly): The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. -* **state**: 'Disabled' | 'Dropping' | 'Ready' | 'Starting' | 'Stopped' | 'Stopping' | 'Updating' | string (ReadOnly): A state of a server that is visible to user. -* **storage**: [Storage](#storage): Storage properties of a server -* **version**: '11' | '12' | '13' | string: The version of a server. - ## Backup ### Properties * **backupRetentionDays**: int: Backup retention days for the server. * **earliestRestoreDate**: string (ReadOnly): The earliest restore point time (ISO8601 format) for server. * **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: A value indicating whether Geo-Redundant backup is enabled on the server. +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: 'Boolean' | 'Enumeration' | 'Integer' | 'Numeric' | string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **documentationLink**: string (ReadOnly): Configuration documentation link. +* **isConfigPendingRestart**: bool (ReadOnly): Configuration is pending restart or not. +* **isDynamicConfig**: bool (ReadOnly): Configuration dynamic or static. +* **isReadOnly**: bool (ReadOnly): Configuration read-only or not. +* **source**: string: Source of the configuration. +* **unit**: string (ReadOnly): Configuration unit. +* **value**: string: Value of the configuration. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + ## HighAvailability ### Properties * **mode**: 'Disabled' | 'ZoneRedundant' | string: The HA mode for the server. @@ -76,15 +77,33 @@ * **privateDnsZoneArmResourceId**: string: private dns zone arm resource id. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): public network access is enabled or not -## Storage +## ServerProperties ### Properties -* **storageSizeGB**: int: Max storage allowed for a server. +* **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **availabilityZone**: string: availability zone information of the server. +* **backup**: [Backup](#backup): Backup properties of a server +* **createMode**: 'Create' | 'Default' | 'PointInTimeRestore' | 'Update' | string (WriteOnly): The mode to create a new PostgreSQL server. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of a server. +* **highAvailability**: [HighAvailability](#highavailability): High availability properties of a server +* **maintenanceWindow**: [MaintenanceWindow](#maintenancewindow): Maintenance window properties of a server. +* **minorVersion**: string (ReadOnly): The minor version of the server. +* **network**: [Network](#network): Network properties of a server +* **pointInTimeUTC**: string (WriteOnly): Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. +* **sourceServerResourceId**: string (WriteOnly): The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. +* **state**: 'Disabled' | 'Dropping' | 'Ready' | 'Starting' | 'Stopped' | 'Stopping' | 'Updating' | string (ReadOnly): A state of a server that is visible to user. +* **storage**: [Storage](#storage): Storage properties of a server +* **version**: '11' | '12' | '13' | string: The version of a server. ## Sku ### Properties * **name**: string (Required): The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. * **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. Burstable. +## Storage +### Properties +* **storageSizeGB**: int: Max storage allowed for a server. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -99,22 +118,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: 'Boolean' | 'Enumeration' | 'Integer' | 'Numeric' | string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **documentationLink**: string (ReadOnly): Configuration documentation link. -* **isConfigPendingRestart**: bool (ReadOnly): Configuration is pending restart or not. -* **isDynamicConfig**: bool (ReadOnly): Configuration dynamic or static. -* **isReadOnly**: bool (ReadOnly): Configuration read-only or not. -* **source**: string: Source of the configuration. -* **unit**: string (ReadOnly): Configuration unit. -* **value**: string: Value of the configuration. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - diff --git a/generated/postgresql/microsoft.dbforpostgresql/2021-06-01/types.md b/generated/postgresql/microsoft.dbforpostgresql/2021-06-01/types.md index dfd88d7aba..d700ccf73c 100644 --- a/generated/postgresql/microsoft.dbforpostgresql/2021-06-01/types.md +++ b/generated/postgresql/microsoft.dbforpostgresql/2021-06-01/types.md @@ -43,30 +43,36 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.DBforPostgreSQL/flexibleServers/firewallRules' (ReadOnly, DeployTimeConstant): The resource type -## ServerProperties -### Properties -* **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **availabilityZone**: string: availability zone information of the server. -* **backup**: [Backup](#backup): Backup properties of a server -* **createMode**: 'Create' | 'Default' | 'PointInTimeRestore' | 'Update' | string (WriteOnly): The mode to create a new PostgreSQL server. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of a server. -* **highAvailability**: [HighAvailability](#highavailability): High availability properties of a server -* **maintenanceWindow**: [MaintenanceWindow](#maintenancewindow): Maintenance window properties of a server. -* **minorVersion**: string (ReadOnly): The minor version of the server. -* **network**: [Network](#network): Network properties of a server -* **pointInTimeUTC**: string (WriteOnly): Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. -* **sourceServerResourceId**: string (WriteOnly): The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. -* **state**: 'Disabled' | 'Dropping' | 'Ready' | 'Starting' | 'Stopped' | 'Stopping' | 'Updating' | string (ReadOnly): A state of a server that is visible to user. -* **storage**: [Storage](#storage): Storage properties of a server -* **version**: '11' | '12' | '13' | string: The version of a server. - ## Backup ### Properties * **backupRetentionDays**: int: Backup retention days for the server. * **earliestRestoreDate**: string (ReadOnly): The earliest restore point time (ISO8601 format) for server. * **geoRedundantBackup**: 'Disabled' | 'Enabled' | string: A value indicating whether Geo-Redundant backup is enabled on the server. +## ConfigurationProperties +### Properties +* **allowedValues**: string (ReadOnly): Allowed values of the configuration. +* **dataType**: 'Boolean' | 'Enumeration' | 'Integer' | 'Numeric' | string (ReadOnly): Data type of the configuration. +* **defaultValue**: string (ReadOnly): Default value of the configuration. +* **description**: string (ReadOnly): Description of the configuration. +* **documentationLink**: string (ReadOnly): Configuration documentation link. +* **isConfigPendingRestart**: bool (ReadOnly): Configuration is pending restart or not. +* **isDynamicConfig**: bool (ReadOnly): Configuration dynamic or static. +* **isReadOnly**: bool (ReadOnly): Configuration read-only or not. +* **source**: string: Source of the configuration. +* **unit**: string (ReadOnly): Configuration unit. +* **value**: string: Value of the configuration. + +## DatabaseProperties +### Properties +* **charset**: string: The charset of the database. +* **collation**: string: The collation of the database. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. +* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. + ## HighAvailability ### Properties * **mode**: 'Disabled' | 'ZoneRedundant' | string: The HA mode for the server. @@ -86,15 +92,33 @@ * **privateDnsZoneArmResourceId**: string: private dns zone arm resource id. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | string (ReadOnly): public network access is enabled or not -## Storage +## ServerProperties ### Properties -* **storageSizeGB**: int: Max storage allowed for a server. +* **administratorLogin**: string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **availabilityZone**: string: availability zone information of the server. +* **backup**: [Backup](#backup): Backup properties of a server +* **createMode**: 'Create' | 'Default' | 'PointInTimeRestore' | 'Update' | string (WriteOnly): The mode to create a new PostgreSQL server. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of a server. +* **highAvailability**: [HighAvailability](#highavailability): High availability properties of a server +* **maintenanceWindow**: [MaintenanceWindow](#maintenancewindow): Maintenance window properties of a server. +* **minorVersion**: string (ReadOnly): The minor version of the server. +* **network**: [Network](#network): Network properties of a server +* **pointInTimeUTC**: string (WriteOnly): Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. +* **sourceServerResourceId**: string (WriteOnly): The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. +* **state**: 'Disabled' | 'Dropping' | 'Ready' | 'Starting' | 'Stopped' | 'Stopping' | 'Updating' | string (ReadOnly): A state of a server that is visible to user. +* **storage**: [Storage](#storage): Storage properties of a server +* **version**: '11' | '12' | '13' | string: The version of a server. ## Sku ### Properties * **name**: string (Required): The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. * **tier**: 'Burstable' | 'GeneralPurpose' | 'MemoryOptimized' | string (Required): The tier of the particular SKU, e.g. Burstable. +## Storage +### Properties +* **storageSizeGB**: int: Max storage allowed for a server. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -109,27 +133,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ConfigurationProperties -### Properties -* **allowedValues**: string (ReadOnly): Allowed values of the configuration. -* **dataType**: 'Boolean' | 'Enumeration' | 'Integer' | 'Numeric' | string (ReadOnly): Data type of the configuration. -* **defaultValue**: string (ReadOnly): Default value of the configuration. -* **description**: string (ReadOnly): Description of the configuration. -* **documentationLink**: string (ReadOnly): Configuration documentation link. -* **isConfigPendingRestart**: bool (ReadOnly): Configuration is pending restart or not. -* **isDynamicConfig**: bool (ReadOnly): Configuration dynamic or static. -* **isReadOnly**: bool (ReadOnly): Configuration read-only or not. -* **source**: string: Source of the configuration. -* **unit**: string (ReadOnly): Configuration unit. -* **value**: string: Value of the configuration. - -## DatabaseProperties -### Properties -* **charset**: string: The charset of the database. -* **collation**: string: The collation of the database. - -## FirewallRuleProperties -### Properties -* **endIpAddress**: string (Required): The end IP address of the server firewall rule. Must be IPv4 format. -* **startIpAddress**: string (Required): The start IP address of the server firewall rule. Must be IPv4 format. - diff --git a/generated/postgresqlhsc/log.out b/generated/postgresqlhsc/log.out index f64b8c7431..4e108dbdee 100644 --- a/generated/postgresqlhsc/log.out +++ b/generated/postgresqlhsc/log.out @@ -4,5 +4,5 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) -info | Autorest completed in 1.89s. 0 files generated. +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +info | Autorest completed in 1.78s. 0 files generated. diff --git a/generated/powerbidedicated/log.out b/generated/powerbidedicated/log.out index d81e30bd9b..115c0631ed 100644 --- a/generated/powerbidedicated/log.out +++ b/generated/powerbidedicated/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.powerbidedicated-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2021-01-01/powerbidedicated.json:622:5 @@ -18,7 +18,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.powerbidedicated-2017-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json:614:5 @@ -28,4 +28,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse-error' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json:946:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 6.72s. 4 files generated. +info | Autorest completed in 6.35s. 4 files generated. diff --git a/generated/powerbidedicated/microsoft.powerbidedicated/2017-10-01/types.md b/generated/powerbidedicated/microsoft.powerbidedicated/2017-10-01/types.md index b4160541dd..a56304a6c8 100644 --- a/generated/powerbidedicated/microsoft.powerbidedicated/2017-10-01/types.md +++ b/generated/powerbidedicated/microsoft.powerbidedicated/2017-10-01/types.md @@ -12,6 +12,10 @@ * **tags**: [ResourceTags](#resourcetags): Key-value pairs of additional resource provisioning properties. * **type**: 'Microsoft.PowerBIDedicated/capacities' (ReadOnly, DeployTimeConstant): The resource type +## DedicatedCapacityAdministrators +### Properties +* **members**: string[]: An array of administrator user identities. + ## DedicatedCapacityProperties ### Properties * **administration**: [DedicatedCapacityAdministrators](#dedicatedcapacityadministrators): An array of administrator user identities @@ -21,10 +25,6 @@ * **state**: 'Deleting' | 'Failed' | 'Paused' | 'Pausing' | 'Preparing' | 'Provisioning' | 'Resuming' | 'Scaling' | 'Succeeded' | 'Suspended' | 'Suspending' | 'Updating' | string (ReadOnly): The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. * **tenantId**: string (ReadOnly): Tenant ID for the capacity. Used for creating Pro Plus capacity. -## DedicatedCapacityAdministrators -### Properties -* **members**: string[]: An array of administrator user identities. - ## ResourceSku ### Properties * **capacity**: int: The capacity of the SKU. diff --git a/generated/powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.md b/generated/powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.md index 4fcc9bece3..f3cae67e87 100644 --- a/generated/powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.md +++ b/generated/powerbidedicated/microsoft.powerbidedicated/2021-01-01/types.md @@ -38,19 +38,15 @@ * **name**: string (Required): Name of the SKU level. * **tier**: 'AutoScale' | string: The name of the Azure pricing tier to which the SKU applies. -## SystemData +## CapacitySku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC) -* **createdBy**: string: An identifier for the identity that created the resource -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created/modified the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: An identifier for the identity that last modified the resource -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created/modified the resource. +* **capacity**: int: The capacity of the SKU. +* **name**: string (Required): Name of the SKU level. +* **tier**: 'AutoPremiumHost' | 'PBIE_Azure' | 'Premium' | string: The name of the Azure pricing tier to which the SKU applies. -## ResourceTags +## DedicatedCapacityAdministrators ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **members**: string[]: An array of administrator user identities. ## DedicatedCapacityProperties ### Properties @@ -61,18 +57,22 @@ * **state**: 'Deleting' | 'Failed' | 'Paused' | 'Pausing' | 'Preparing' | 'Provisioning' | 'Resuming' | 'Scaling' | 'Succeeded' | 'Suspended' | 'Suspending' | 'Updating' | string (ReadOnly): The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. * **tenantId**: string (ReadOnly): Tenant ID for the capacity. Used for creating Pro Plus capacity. -## DedicatedCapacityAdministrators -### Properties -* **members**: string[]: An array of administrator user identities. - -## CapacitySku +## ResourceTags ### Properties -* **capacity**: int: The capacity of the SKU. -* **name**: string (Required): Name of the SKU level. -* **tier**: 'AutoPremiumHost' | 'PBIE_Azure' | 'Premium' | string: The name of the Azure pricing tier to which the SKU applies. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC) +* **createdBy**: string: An identifier for the identity that created the resource +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created/modified the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: An identifier for the identity that last modified the resource +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created/modified the resource. + diff --git a/generated/powerbiembedded/log.out b/generated/powerbiembedded/log.out index 1b87660f99..1ff26e7992 100644 --- a/generated/powerbiembedded/log.out +++ b/generated/powerbiembedded/log.out @@ -3,12 +3,12 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.powerbi-2016-01-29"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 10ms -info | Autorest completed in 4.7s. 2 files generated. +info | autorest.bicep took 14ms +info | Autorest completed in 4.46s. 2 files generated. diff --git a/generated/powerbiprivatelinks/log.out b/generated/powerbiprivatelinks/log.out index e4210312ca..41439c3303 100644 --- a/generated/powerbiprivatelinks/log.out +++ b/generated/powerbiprivatelinks/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.powerbi-2020-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms -info | Autorest completed in 5.1s. 2 files generated. +info | autorest.bicep took 12ms +info | Autorest completed in 4.83s. 2 files generated. diff --git a/generated/powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.md b/generated/powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.md index 4f4f7c16e7..c839c21926 100644 --- a/generated/powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.md +++ b/generated/powerbiprivatelinks/microsoft.powerbi/2020-06-01/types.md @@ -22,10 +22,15 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## TenantProperties +## ConnectionState ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (WriteOnly): Specifies the private endpoint connections of the resource. -* **tenantId**: string (WriteOnly): Specifies the tenant id of the resource. +* **actionsRequired**: string (WriteOnly): Actions required (if any). +* **description**: string (WriteOnly): Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (WriteOnly): Status of the connection. + +## PrivateEndpoint +### Properties +* **id**: string (WriteOnly): Specifies the id of private endpoint. ## PrivateEndpointConnection ### Properties @@ -41,16 +46,6 @@ * **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate) (WriteOnly): ConnectionState information. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (WriteOnly): Provisioning state of the Private Endpoint Connection. -## PrivateEndpoint -### Properties -* **id**: string (WriteOnly): Specifies the id of private endpoint. - -## ConnectionState -### Properties -* **actionsRequired**: string (WriteOnly): Actions required (if any). -* **description**: string (WriteOnly): Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (WriteOnly): Status of the connection. - ## SystemData ### Properties * **createdAt**: string (WriteOnly): The timestamp of resource creation (UTC). @@ -60,6 +55,11 @@ * **lastModifiedBy**: string (WriteOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (WriteOnly): The type of identity that created the resource. +## TenantProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (WriteOnly): Specifies the private endpoint connections of the resource. +* **tenantId**: string (WriteOnly): Specifies the tenant id of the resource. + ## TenantResourceTags ### Properties ### Additional Properties diff --git a/generated/powerplatform/log.out b/generated/powerplatform/log.out index b155803c05..8a594279d0 100644 --- a/generated/powerplatform/log.out +++ b/generated/powerplatform/log.out @@ -3,13 +3,13 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.powerplatform-2020-10-30-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'VirtualNetworkPropertiesList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json:580:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 18ms -info | Autorest completed in 5.38s. 2 files generated. +info | autorest.bicep took 12ms +info | Autorest completed in 5.13s. 2 files generated. diff --git a/generated/powerplatform/microsoft.powerplatform/2020-10-30-preview/types.md b/generated/powerplatform/microsoft.powerplatform/2020-10-30-preview/types.md index 2df41daf20..ea8fba63bc 100644 --- a/generated/powerplatform/microsoft.powerplatform/2020-10-30-preview/types.md +++ b/generated/powerplatform/microsoft.powerplatform/2020-10-30-preview/types.md @@ -40,26 +40,38 @@ ### Properties * **description**: string: The description of the account. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## EnterprisePolicyIdentity ### Properties * **systemAssignedIdentityPrincipalId**: string (ReadOnly): The principal id of EnterprisePolicy identity. * **tenantId**: string (ReadOnly): The tenant id associated with the EnterprisePolicy. * **type**: 'None' | 'SystemAssigned': The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. +## KeyProperties +### Properties +* **name**: string: The identifier of the key vault key used to encrypt data. +* **version**: string: The version of the identity which will be used to access key vault. + +## KeyVaultProperties +### Properties +* **id**: string: Uri of KeyVault +* **key**: [KeyProperties](#keyproperties): Url and version of the KeyVault Secret + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + ## Properties ### Properties * **encryption**: [PropertiesEncryption](#propertiesencryption): The encryption settings for a configuration store. @@ -71,16 +83,6 @@ * **keyVault**: [KeyVaultProperties](#keyvaultproperties): Settings concerning key vault encryption for a configuration store. * **state**: 'Disabled' | 'Enabled' | 'NotConfigured' | string: The state of onboarding, which only appears in the response. -## KeyVaultProperties -### Properties -* **id**: string: Uri of KeyVault -* **key**: [KeyProperties](#keyproperties): Url and version of the KeyVault Secret - -## KeyProperties -### Properties -* **name**: string: The identifier of the key vault key used to encrypt data. -* **version**: string: The version of the identity which will be used to access key vault. - ## PropertiesLockbox ### Properties * **state**: 'Disabled' | 'Enabled' | 'NotConfigured' | string: The state of onboarding, which only appears in the response. @@ -89,38 +91,36 @@ ### Properties * **virtualNetworks**: [VirtualNetworkPropertiesList](#virtualnetworkpropertieslist): A list of private link resources -## VirtualNetworkPropertiesList -### Properties -* **nextLink**: string: Next page link if any. -* **value**: [VirtualNetworkProperties](#virtualnetworkproperties)[]: Array of virtual networks. - -## VirtualNetworkProperties -### Properties -* **id**: string: Uri of the virtual network. -* **subnet**: [SubnetProperties](#subnetproperties): Properties of a subnet. - ## SubnetProperties ### Properties * **name**: string: Subnet name. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateEndpointConnectionProperties +## TrackedResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpoint +## VirtualNetworkProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **id**: string: Uri of the virtual network. +* **subnet**: [SubnetProperties](#subnetproperties): Properties of a subnet. -## PrivateLinkServiceConnectionState +## VirtualNetworkPropertiesList ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **nextLink**: string: Next page link if any. +* **value**: [VirtualNetworkProperties](#virtualnetworkproperties)[]: Array of virtual networks. diff --git a/generated/privatedns/log.out b/generated/privatedns/log.out index c2d6b817c6..5906c44118 100644 --- a/generated/privatedns/log.out +++ b/generated/privatedns/log.out @@ -8,7 +8,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.network-2018-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateZoneProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/privatedns/resource-manager/Microsoft.Network/stable/2018-09-01/privatedns.json:1371:5 @@ -64,7 +64,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet -info | autorest.bicep took 13ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.network-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -72,7 +72,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateZoneProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/privatedns/resource-manager/Microsoft.Network/stable/2020-01-01/privatedns.json:1371:5 @@ -120,7 +120,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.network-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -128,7 +128,7 @@ warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateZoneProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/privatedns/resource-manager/Microsoft.Network/stable/2020-06-01/privatedns.json:1371:5 @@ -176,5 +176,5 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecordSet' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from RecordSet -info | autorest.bicep took 3ms -info | Autorest completed in 9.87s. 6 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 9.55s. 6 files generated. diff --git a/generated/privatedns/microsoft.network/2018-09-01/types.md b/generated/privatedns/microsoft.network/2018-09-01/types.md index 5f239ba98d..6d6092cf3e 100644 --- a/generated/privatedns/microsoft.network/2018-09-01/types.md +++ b/generated/privatedns/microsoft.network/2018-09-01/types.md @@ -104,6 +104,23 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Network/privateDnsZones/virtualNetworkLinks' (ReadOnly, DeployTimeConstant): The resource type +## AaaaRecord +### Properties +* **ipv6Address**: string: The IPv6 address of this AAAA record. + +## ARecord +### Properties +* **ipv4Address**: string: The IPv4 address of this A record. + +## CnameRecord +### Properties +* **cname**: string: The canonical name for this CNAME record. + +## MxRecord +### Properties +* **exchange**: string: The domain name of the mail host for this MX record. +* **preference**: int: The preference value for this MX record. + ## PrivateZoneProperties ### Properties * **maxNumberOfRecordSets**: int (ReadOnly): The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored. @@ -114,10 +131,9 @@ * **numberOfVirtualNetworkLinksWithRegistration**: int (ReadOnly): The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. -## TrackedResourceTags +## PtrRecord ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ptrdname**: string: The PTR target domain name for this PTR record. ## RecordSetProperties ### Properties @@ -134,32 +150,11 @@ * **ttl**: int: The TTL (time-to-live) of the records in the record set. * **txtRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. -## AaaaRecord -### Properties -* **ipv6Address**: string: The IPv6 address of this AAAA record. - -## ARecord -### Properties -* **ipv4Address**: string: The IPv4 address of this A record. - -## CnameRecord -### Properties -* **cname**: string: The canonical name for this CNAME record. - ## RecordSetPropertiesMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string -## MxRecord -### Properties -* **exchange**: string: The domain name of the mail host for this MX record. -* **preference**: int: The preference value for this MX record. - -## PtrRecord -### Properties -* **ptrdname**: string: The PTR target domain name for this PTR record. - ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -177,6 +172,20 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## SubResource +### Properties +* **id**: string: Resource ID. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. @@ -188,12 +197,3 @@ * **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **virtualNetworkLinkState**: 'Completed' | 'InProgress' | string (ReadOnly): The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. -## SubResource -### Properties -* **id**: string: Resource ID. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/privatedns/microsoft.network/2020-01-01/types.md b/generated/privatedns/microsoft.network/2020-01-01/types.md index b0dec9f940..ac2f99b144 100644 --- a/generated/privatedns/microsoft.network/2020-01-01/types.md +++ b/generated/privatedns/microsoft.network/2020-01-01/types.md @@ -104,6 +104,23 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Network/privateDnsZones/virtualNetworkLinks' (ReadOnly, DeployTimeConstant): The resource type +## AaaaRecord +### Properties +* **ipv6Address**: string: The IPv6 address of this AAAA record. + +## ARecord +### Properties +* **ipv4Address**: string: The IPv4 address of this A record. + +## CnameRecord +### Properties +* **cname**: string: The canonical name for this CNAME record. + +## MxRecord +### Properties +* **exchange**: string: The domain name of the mail host for this MX record. +* **preference**: int: The preference value for this MX record. + ## PrivateZoneProperties ### Properties * **internalId**: string (ReadOnly): Private zone internal Id @@ -115,10 +132,9 @@ * **numberOfVirtualNetworkLinksWithRegistration**: int (ReadOnly): The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. -## TrackedResourceTags +## PtrRecord ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ptrdname**: string: The PTR target domain name for this PTR record. ## RecordSetProperties ### Properties @@ -135,32 +151,11 @@ * **ttl**: int: The TTL (time-to-live) of the records in the record set. * **txtRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. -## AaaaRecord -### Properties -* **ipv6Address**: string: The IPv6 address of this AAAA record. - -## ARecord -### Properties -* **ipv4Address**: string: The IPv4 address of this A record. - -## CnameRecord -### Properties -* **cname**: string: The canonical name for this CNAME record. - ## RecordSetPropertiesMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string -## MxRecord -### Properties -* **exchange**: string: The domain name of the mail host for this MX record. -* **preference**: int: The preference value for this MX record. - -## PtrRecord -### Properties -* **ptrdname**: string: The PTR target domain name for this PTR record. - ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -178,6 +173,20 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## SubResource +### Properties +* **id**: string: Resource ID. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. @@ -189,12 +198,3 @@ * **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **virtualNetworkLinkState**: 'Completed' | 'InProgress' | string (ReadOnly): The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. -## SubResource -### Properties -* **id**: string: Resource ID. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/privatedns/microsoft.network/2020-06-01/types.md b/generated/privatedns/microsoft.network/2020-06-01/types.md index a8e058b297..5008e74dfe 100644 --- a/generated/privatedns/microsoft.network/2020-06-01/types.md +++ b/generated/privatedns/microsoft.network/2020-06-01/types.md @@ -104,6 +104,23 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Network/privateDnsZones/virtualNetworkLinks' (ReadOnly, DeployTimeConstant): The resource type +## AaaaRecord +### Properties +* **ipv6Address**: string: The IPv6 address of this AAAA record. + +## ARecord +### Properties +* **ipv4Address**: string: The IPv4 address of this A record. + +## CnameRecord +### Properties +* **cname**: string: The canonical name for this CNAME record. + +## MxRecord +### Properties +* **exchange**: string: The domain name of the mail host for this MX record. +* **preference**: int: The preference value for this MX record. + ## PrivateZoneProperties ### Properties * **internalId**: string (ReadOnly): Private zone internal Id @@ -115,10 +132,9 @@ * **numberOfVirtualNetworkLinksWithRegistration**: int (ReadOnly): The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. -## TrackedResourceTags +## PtrRecord ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **ptrdname**: string: The PTR target domain name for this PTR record. ## RecordSetProperties ### Properties @@ -135,32 +151,11 @@ * **ttl**: int: The TTL (time-to-live) of the records in the record set. * **txtRecords**: [TxtRecord](#txtrecord)[]: The list of TXT records in the record set. -## AaaaRecord -### Properties -* **ipv6Address**: string: The IPv6 address of this AAAA record. - -## ARecord -### Properties -* **ipv4Address**: string: The IPv4 address of this A record. - -## CnameRecord -### Properties -* **cname**: string: The canonical name for this CNAME record. - ## RecordSetPropertiesMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string -## MxRecord -### Properties -* **exchange**: string: The domain name of the mail host for this MX record. -* **preference**: int: The preference value for this MX record. - -## PtrRecord -### Properties -* **ptrdname**: string: The PTR target domain name for this PTR record. - ## SoaRecord ### Properties * **email**: string: The email contact for this SOA record. @@ -178,6 +173,20 @@ * **target**: string: The target domain name for this SRV record. * **weight**: int: The weight value for this SRV record. +## SubResource +### Properties +* **id**: string: Resource ID. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TxtRecord ### Properties * **value**: string[]: The text value of this TXT record. @@ -189,12 +198,3 @@ * **virtualNetwork**: [SubResource](#subresource): Reference to another subresource. * **virtualNetworkLinkState**: 'Completed' | 'InProgress' | string (ReadOnly): The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. -## SubResource -### Properties -* **id**: string: Resource ID. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/providerhub/log.out b/generated/providerhub/log.out index 009469a5d8..c0f24e9a4b 100644 --- a/generated/providerhub/log.out +++ b/generated/providerhub/log.out @@ -7,14 +7,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.providerhub-2021-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CustomRolloutSpecification-canary' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-09-01-preview/providerhub.json:2238:9 @@ -185,14 +185,14 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ResourceTypeReg warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DefaultRolloutProperties' -> 'DefaultRolloutPropertiesAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'NotificationRegistrationProperties' -> 'NotificationRegistrationPropertiesAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 25ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.providerhub-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CustomRolloutSpecification-canary' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json:2238:9 @@ -370,7 +370,7 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CustomRolloutSpecification-canary' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json:2180:9 @@ -497,14 +497,14 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ResourceTypeReg warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DefaultRolloutProperties' -> 'DefaultRolloutPropertiesAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'NotificationRegistrationProperties' -> 'NotificationRegistrationPropertiesAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.providerhub-2020-11-20"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CustomRolloutSpecification-canary' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json:2158:9 @@ -629,5 +629,5 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ResourceTypeReg warning | PreNamer/DeduplicateName | Deduplicating schema name: 'DefaultRolloutProperties' -> 'DefaultRolloutPropertiesAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'NotificationRegistrationProperties' -> 'NotificationRegistrationPropertiesAutoGenerated' warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms -info | Autorest completed in 19.28s. 8 files generated. +info | autorest.bicep took 13ms +info | Autorest completed in 18.31s. 8 files generated. diff --git a/generated/providerhub/microsoft.providerhub/2020-11-20/types.md b/generated/providerhub/microsoft.providerhub/2020-11-20/types.md index 9bc294b1af..d0a749a974 100644 --- a/generated/providerhub/microsoft.providerhub/2020-11-20/types.md +++ b/generated/providerhub/microsoft.providerhub/2020-11-20/types.md @@ -90,6 +90,182 @@ * **properties**: [SkuResourceProperties](#skuresourceproperties) * **type**: 'Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus' (ReadOnly, DeployTimeConstant): The resource type +## AuthorizationActionMapping +### Properties +* **desired**: string +* **original**: string + +## CustomRolloutProperties +### Properties +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **specification**: [CustomRolloutPropertiesSpecification](#customrolloutpropertiesspecification) (Required) +* **status**: [CustomRolloutPropertiesStatus](#customrolloutpropertiesstatus) + +## CustomRolloutPropertiesSpecification +### Properties +* **canary**: [CustomRolloutSpecificationCanary](#customrolloutspecificationcanary) (Required) +* **providerRegistration**: [CustomRolloutSpecificationProviderRegistration](#customrolloutspecificationproviderregistration) +* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration + +## CustomRolloutPropertiesStatus +### Properties +* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem +* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of + +## CustomRolloutSpecificationCanary +### Properties +* **regions**: string[]: Array of TrafficRegionsItem + +## CustomRolloutSpecificationProviderRegistration +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## CustomRolloutStatusFailedOrSkippedRegions +### Properties +### Additional Properties +* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) + +## DefaultRolloutProperties +### Properties +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) +* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) + +## DefaultRolloutPropertiesSpecification +### Properties +* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) +* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) +* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) +* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) +* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) +* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) +* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) + +## DefaultRolloutPropertiesStatus +### Properties +* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem +* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of +* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string +* **nextTrafficRegionScheduledTime**: string +* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string + +## DefaultRolloutSpecificationCanary +### Properties +* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem +* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem + +## DefaultRolloutSpecificationHighTraffic +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationLowTraffic +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationMediumTraffic +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationProviderRegistration +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## DefaultRolloutSpecificationRestOfTheWorldGroupOne +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationRestOfTheWorldGroupTwo +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## ExtendedErrorInfo +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo +* **code**: string +* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo +* **message**: string +* **target**: string + +## ExtendedLocationOptions +### Properties +* **supportedPolicy**: string +* **type**: string + +## LightHouseAuthorization +### Properties +* **principalId**: string (Required) +* **roleDefinitionId**: string (Required) + +## LinkedAccessCheck +### Properties +* **actionName**: string +* **linkedAction**: string +* **linkedActionVerb**: string +* **linkedProperty**: string +* **linkedType**: string + +## LoggingRule +### Properties +* **action**: string (Required) +* **detailLevel**: 'Body' | 'None' | string (Required) +* **direction**: 'None' | 'Request' | 'Response' | string (Required) +* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) + +## LoggingRuleHiddenPropertyPaths +### Properties +* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem +* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem + +## NotificationEndpoint +### Properties +* **locations**: string[]: Array of NotificationEndpointLocationsItem +* **notificationDestination**: string + +## NotificationRegistrationProperties +### Properties +* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem +* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string +* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint +* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string + +## OperationsDefinition +### Properties +* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) +* **display**: [OperationsDefinitionDisplay](#operationsdefinitiondisplay) (Required, WriteOnly): Display information of the operation. +* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. +* **name**: string (Required, WriteOnly): Name of the operation. +* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) +* **properties**: any (WriteOnly): Anything + +## OperationsDefinitionDisplay +### Properties +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) + +## ProviderHubMetadataProviderAuthentication +### Properties +* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem + +## ProviderHubMetadataThirdPartyProviderAuthorization +### Properties +* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization +* **managedByTenantId**: string + ## ProviderRegistrationProperties ### Properties * **capabilities**: [ResourceProviderCapabilities](#resourceprovidercapabilities)[]: Array of ResourceProviderCapabilities @@ -108,6 +284,23 @@ * **subscriptionLifecycleNotificationSpecifications**: [ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#providerregistrationpropertiessubscriptionlifecyclenotificationspecifications) * **templateDeploymentOptions**: [ResourceProviderManifestPropertiesTemplateDeploymentOptions](#resourceprovidermanifestpropertiestemplatedeploymentoptions) +## ProviderRegistrationPropertiesProviderHubMetadata +### Properties +* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) +* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization +* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) + +## ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications +### Properties +* **softDeleteTTL**: string +* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction + +## ResourceProviderAuthorization +### Properties +* **applicationId**: string +* **managedByRoleDefinitionId**: string +* **roleDefinitionId**: string + ## ResourceProviderCapabilities ### Properties * **effect**: 'Allow' | 'Disallow' | 'NotSpecified' | string (Required) @@ -129,82 +322,43 @@ * **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem * **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -## ServiceTreeInfo -### Properties -* **componentId**: string -* **serviceId**: string - ## ResourceProviderManifestPropertiesProviderAuthentication ### Properties * **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem -## ResourceProviderAuthorization -### Properties -* **applicationId**: string -* **managedByRoleDefinitionId**: string -* **roleDefinitionId**: string - -## ProviderRegistrationPropertiesProviderHubMetadata -### Properties -* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) -* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization -* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) - -## ProviderHubMetadataProviderAuthentication -### Properties -* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem - -## ProviderHubMetadataThirdPartyProviderAuthorization -### Properties -* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization -* **managedByTenantId**: string - -## LightHouseAuthorization -### Properties -* **principalId**: string (Required) -* **roleDefinitionId**: string (Required) - ## ResourceProviderManifestPropertiesRequestHeaderOptions ### Properties * **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string -## ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications -### Properties -* **softDeleteTTL**: string -* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction - -## SubscriptionStateOverrideAction -### Properties -* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) - ## ResourceProviderManifestPropertiesTemplateDeploymentOptions ### Properties * **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption * **preflightSupported**: bool -## CustomRolloutProperties +## ResourceTypeEndpoint ### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **specification**: [CustomRolloutPropertiesSpecification](#customrolloutpropertiesspecification) (Required) -* **status**: [CustomRolloutPropertiesStatus](#customrolloutpropertiesstatus) +* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem +* **enabled**: bool +* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension +* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) +* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem +* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem +* **timeout**: string -## CustomRolloutPropertiesSpecification +## ResourceTypeEndpointFeaturesRule ### Properties -* **canary**: [CustomRolloutSpecificationCanary](#customrolloutspecificationcanary) (Required) -* **providerRegistration**: [CustomRolloutSpecificationProviderRegistration](#customrolloutspecificationproviderregistration) -* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## CustomRolloutSpecificationCanary +## ResourceTypeExtension ### Properties -* **regions**: string[]: Array of TrafficRegionsItem +* **endpointUri**: string +* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory +* **timeout**: string -## CustomRolloutSpecificationProviderRegistration +## ResourceTypeExtensionOptionsResourceCreationBegin ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType +* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType ## ResourceTypeRegistration ### Properties @@ -245,50 +399,15 @@ * **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) * **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## AuthorizationActionMapping -### Properties -* **desired**: string -* **original**: string - ## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications ### Properties * **enableDefaultValidation**: bool * **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem -## ResourceTypeEndpoint -### Properties -* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem -* **enabled**: bool -* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension -* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) -* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem -* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem -* **timeout**: string - -## ResourceTypeExtension -### Properties -* **endpointUri**: string -* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory -* **timeout**: string - -## ResourceTypeEndpointFeaturesRule -### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) - -## ExtendedLocationOptions -### Properties -* **supportedPolicy**: string -* **type**: string - ## ResourceTypeRegistrationPropertiesExtensionOptions ### Properties * **resourceCreationBegin**: [ResourceTypeExtensionOptionsResourceCreationBegin](#resourcetypeextensionoptionsresourcecreationbegin) -## ResourceTypeExtensionOptionsResourceCreationBegin -### Properties -* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType -* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType - ## ResourceTypeRegistrationPropertiesFeaturesRule ### Properties * **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) @@ -298,26 +417,6 @@ * **applicationId**: string * **type**: 'Actor' | 'DelegatedResourceIdentity' | 'NotSpecified' | 'SystemAssigned' | 'UserAssigned' | string -## LinkedAccessCheck -### Properties -* **actionName**: string -* **linkedAction**: string -* **linkedActionVerb**: string -* **linkedProperty**: string -* **linkedType**: string - -## LoggingRule -### Properties -* **action**: string (Required) -* **detailLevel**: 'Body' | 'None' | string (Required) -* **direction**: 'None' | 'Request' | 'Response' | string (Required) -* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) - -## LoggingRuleHiddenPropertyPaths -### Properties -* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem -* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem - ## ResourceTypeRegistrationPropertiesRequestHeaderOptions ### Properties * **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string @@ -333,151 +432,39 @@ * **softDeleteTTL**: string * **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction -## SubscriptionStateRule -### Properties -* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string - -## SwaggerSpecification -### Properties -* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem -* **swaggerSpecFolderUri**: string - ## ResourceTypeRegistrationPropertiesTemplateDeploymentOptions ### Properties * **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption * **preflightSupported**: bool -## ThrottlingRule -### Properties -* **action**: string (Required) -* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric -* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem - -## ThrottlingMetric -### Properties -* **interval**: string -* **limit**: int (Required) -* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) - -## CustomRolloutPropertiesStatus -### Properties -* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem -* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of - -## CustomRolloutStatusFailedOrSkippedRegions -### Properties -### Additional Properties -* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) - -## ExtendedErrorInfo -### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo -* **code**: string -* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo -* **message**: string -* **target**: string - -## TypedErrorInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (Required) - -## DefaultRolloutProperties -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) -* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) - -## DefaultRolloutPropertiesSpecification -### Properties -* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) -* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) -* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) -* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) -* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) -* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration -* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) -* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) - -## DefaultRolloutSpecificationCanary -### Properties -* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem -* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem - -## DefaultRolloutSpecificationHighTraffic -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationLowTraffic -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationMediumTraffic -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationProviderRegistration -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## DefaultRolloutSpecificationRestOfTheWorldGroupOne -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationRestOfTheWorldGroupTwo -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutPropertiesStatus -### Properties -* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem -* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of -* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string -* **nextTrafficRegionScheduledTime**: string -* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string - ## RolloutStatusBaseFailedOrSkippedRegions ### Properties ### Additional Properties * **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) -## NotificationRegistrationProperties +## ServiceTreeInfo ### Properties -* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem -* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string -* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint -* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **componentId**: string +* **serviceId**: string -## NotificationEndpoint +## SkuCapability ### Properties -* **locations**: string[]: Array of NotificationEndpointLocationsItem -* **notificationDestination**: string +* **name**: string (Required) +* **value**: string (Required) -## OperationsDefinition +## SkuCost ### Properties -* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) -* **display**: [OperationsDefinitionDisplay](#operationsdefinitiondisplay) (Required, WriteOnly): Display information of the operation. -* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. -* **name**: string (Required, WriteOnly): Name of the operation. -* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) -* **properties**: any (WriteOnly): Anything +* **extendedUnit**: string +* **meterId**: string (Required) +* **quantity**: int -## OperationsDefinitionDisplay +## SkuLocationInfo ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem +* **location**: string (Required) +* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string +* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail +* **zones**: string[]: Array of SkuLocationInfoZonesItem ## SkuResourceProperties ### Properties @@ -499,11 +486,6 @@ * **size**: string * **tier**: string -## SkuCapability -### Properties -* **name**: string (Required) -* **value**: string (Required) - ## SkuSettingCapacity ### Properties * **default**: int @@ -511,22 +493,40 @@ * **minimum**: int (Required) * **scaleType**: 'Automatic' | 'Manual' | 'None' | string -## SkuCost +## SkuZoneDetail ### Properties -* **extendedUnit**: string -* **meterId**: string (Required) -* **quantity**: int +* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability +* **name**: string[]: Array of SkuZoneDetailNameItem -## SkuLocationInfo +## SubscriptionStateOverrideAction ### Properties -* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem -* **location**: string (Required) -* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string -* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail -* **zones**: string[]: Array of SkuLocationInfoZonesItem +* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) -## SkuZoneDetail +## SubscriptionStateRule ### Properties -* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability -* **name**: string[]: Array of SkuZoneDetailNameItem +* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string + +## SwaggerSpecification +### Properties +* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem +* **swaggerSpecFolderUri**: string + +## ThrottlingMetric +### Properties +* **interval**: string +* **limit**: int (Required) +* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) + +## ThrottlingRule +### Properties +* **action**: string (Required) +* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric +* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem + +## TypedErrorInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (Required) diff --git a/generated/providerhub/microsoft.providerhub/2021-05-01-preview/types.md b/generated/providerhub/microsoft.providerhub/2021-05-01-preview/types.md index a6a1ff46f5..ed5ecccc0f 100644 --- a/generated/providerhub/microsoft.providerhub/2021-05-01-preview/types.md +++ b/generated/providerhub/microsoft.providerhub/2021-05-01-preview/types.md @@ -90,6 +90,187 @@ * **properties**: [SkuResourceProperties](#skuresourceproperties) * **type**: 'Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus' (ReadOnly, DeployTimeConstant): The resource type +## AuthorizationActionMapping +### Properties +* **desired**: string +* **original**: string + +## CustomRolloutProperties +### Properties +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **specification**: [CustomRolloutPropertiesSpecification](#customrolloutpropertiesspecification) (Required) +* **status**: [CustomRolloutPropertiesStatus](#customrolloutpropertiesstatus) + +## CustomRolloutPropertiesSpecification +### Properties +* **canary**: [CustomRolloutSpecificationCanary](#customrolloutspecificationcanary) (Required) +* **providerRegistration**: [CustomRolloutSpecificationProviderRegistration](#customrolloutspecificationproviderregistration) +* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration + +## CustomRolloutPropertiesStatus +### Properties +* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem +* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of + +## CustomRolloutSpecificationCanary +### Properties +* **regions**: string[]: Array of TrafficRegionsItem + +## CustomRolloutSpecificationProviderRegistration +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## CustomRolloutStatusFailedOrSkippedRegions +### Properties +### Additional Properties +* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) + +## DefaultRolloutProperties +### Properties +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) +* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) + +## DefaultRolloutPropertiesSpecification +### Properties +* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) +* **expeditedRollout**: [DefaultRolloutSpecificationExpeditedRollout](#defaultrolloutspecificationexpeditedrollout) +* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) +* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) +* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) +* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) +* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) +* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) + +## DefaultRolloutPropertiesStatus +### Properties +* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem +* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of +* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string +* **nextTrafficRegionScheduledTime**: string +* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string + +## DefaultRolloutSpecificationCanary +### Properties +* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem +* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem + +## DefaultRolloutSpecificationExpeditedRollout +### Properties +* **enabled**: bool: Indicates whether expedited rollout is enabled/disabled + +## DefaultRolloutSpecificationHighTraffic +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationLowTraffic +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationMediumTraffic +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationProviderRegistration +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## DefaultRolloutSpecificationRestOfTheWorldGroupOne +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## DefaultRolloutSpecificationRestOfTheWorldGroupTwo +### Properties +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## ExtendedErrorInfo +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo +* **code**: string +* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo +* **message**: string +* **target**: string + +## ExtendedLocationOptions +### Properties +* **supportedPolicy**: string +* **type**: string + +## LightHouseAuthorization +### Properties +* **principalId**: string (Required) +* **roleDefinitionId**: string (Required) + +## LinkedAccessCheck +### Properties +* **actionName**: string +* **linkedAction**: string +* **linkedActionVerb**: string +* **linkedProperty**: string +* **linkedType**: string + +## LoggingRule +### Properties +* **action**: string (Required) +* **detailLevel**: 'Body' | 'None' | string (Required) +* **direction**: 'None' | 'Request' | 'Response' | string (Required) +* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) + +## LoggingRuleHiddenPropertyPaths +### Properties +* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem +* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem + +## NotificationEndpoint +### Properties +* **locations**: string[]: Array of NotificationEndpointLocationsItem +* **notificationDestination**: string + +## NotificationRegistrationProperties +### Properties +* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem +* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string +* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint +* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string + +## OperationsDefinition +### Properties +* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) +* **display**: [OperationsDefinitionDisplay](#operationsdefinitiondisplay) (Required, WriteOnly): Display information of the operation. +* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. +* **name**: string (Required, WriteOnly): Name of the operation. +* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) +* **properties**: any (WriteOnly): Anything + +## OperationsDefinitionDisplay +### Properties +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) + +## ProviderHubMetadataProviderAuthentication +### Properties +* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem + +## ProviderHubMetadataThirdPartyProviderAuthorization +### Properties +* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization +* **managedByTenantId**: string + ## ProviderRegistrationProperties ### Properties * **capabilities**: [ResourceProviderCapabilities](#resourceprovidercapabilities)[]: Array of ResourceProviderCapabilities @@ -106,6 +287,22 @@ * **requestHeaderOptions**: [ResourceProviderManifestPropertiesRequestHeaderOptions](#resourceprovidermanifestpropertiesrequestheaderoptions) * **requiredFeatures**: string[]: Array of ResourceProviderManifestPropertiesRequiredFeaturesItem +## ProviderRegistrationPropertiesProviderHubMetadata +### Properties +* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) +* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization +* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) + +## ResourceConcurrencyControlOption +### Properties +* **policy**: 'NotSpecified' | 'SynchronizeBeginExtension' | string + +## ResourceProviderAuthorization +### Properties +* **applicationId**: string +* **managedByRoleDefinitionId**: string +* **roleDefinitionId**: string + ## ResourceProviderCapabilities ### Properties * **effect**: 'Allow' | 'Disallow' | 'NotSpecified' | string (Required) @@ -127,67 +324,38 @@ * **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem * **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -## ServiceTreeInfo -### Properties -* **componentId**: string -* **serviceId**: string - ## ResourceProviderManifestPropertiesProviderAuthentication ### Properties * **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem -## ResourceProviderAuthorization -### Properties -* **applicationId**: string -* **managedByRoleDefinitionId**: string -* **roleDefinitionId**: string - -## ProviderRegistrationPropertiesProviderHubMetadata -### Properties -* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) -* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization -* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) - -## ProviderHubMetadataProviderAuthentication -### Properties -* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem - -## ProviderHubMetadataThirdPartyProviderAuthorization -### Properties -* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization -* **managedByTenantId**: string - -## LightHouseAuthorization -### Properties -* **principalId**: string (Required) -* **roleDefinitionId**: string (Required) - ## ResourceProviderManifestPropertiesRequestHeaderOptions ### Properties * **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string -## CustomRolloutProperties +## ResourceTypeEndpoint ### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **specification**: [CustomRolloutPropertiesSpecification](#customrolloutpropertiesspecification) (Required) -* **status**: [CustomRolloutPropertiesStatus](#customrolloutpropertiesstatus) +* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem +* **enabled**: bool +* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension +* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) +* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem +* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem +* **timeout**: string -## CustomRolloutPropertiesSpecification +## ResourceTypeEndpointFeaturesRule ### Properties -* **canary**: [CustomRolloutSpecificationCanary](#customrolloutspecificationcanary) (Required) -* **providerRegistration**: [CustomRolloutSpecificationProviderRegistration](#customrolloutspecificationproviderregistration) -* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## CustomRolloutSpecificationCanary +## ResourceTypeExtension ### Properties -* **regions**: string[]: Array of TrafficRegionsItem +* **endpointUri**: string +* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory +* **timeout**: string -## CustomRolloutSpecificationProviderRegistration +## ResourceTypeExtensionOptionsResourceCreationBegin ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType +* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType ## ResourceTypeRegistration ### Properties @@ -212,69 +380,34 @@ * **identityManagement**: [ResourceTypeRegistrationPropertiesIdentityManagement](#resourcetyperegistrationpropertiesidentitymanagement) * **isPureProxy**: bool * **linkedAccessChecks**: [LinkedAccessCheck](#linkedaccesscheck)[]: Array of LinkedAccessCheck -* **loggingRules**: [LoggingRule](#loggingrule)[]: Array of LoggingRule -* **management**: [ResourceTypeRegistrationPropertiesManagement](#resourcetyperegistrationpropertiesmanagement) -* **marketplaceType**: 'AddOn' | 'Bypass' | 'NotSpecified' | 'Store' | string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **regionality**: 'Global' | 'NotSpecified' | 'Regional' | string -* **requestHeaderOptions**: [ResourceTypeRegistrationPropertiesRequestHeaderOptions](#resourcetyperegistrationpropertiesrequestheaderoptions) -* **requiredFeatures**: string[]: Array of ResourceTypeRegistrationPropertiesRequiredFeaturesItem -* **resourceConcurrencyControlOptions**: [ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions](#resourcetyperegistrationpropertiesresourceconcurrencycontroloptions): Dictionary of -* **resourceDeletionPolicy**: 'CascadeDeleteAll' | 'CascadeDeleteProxyOnlyChildren' | 'NotSpecified' | string -* **resourceGraphConfiguration**: [ResourceTypeRegistrationPropertiesResourceGraphConfiguration](#resourcetyperegistrationpropertiesresourcegraphconfiguration) -* **resourceMovePolicy**: [ResourceTypeRegistrationPropertiesResourceMovePolicy](#resourcetyperegistrationpropertiesresourcemovepolicy) -* **routingType**: 'CascadeExtension' | 'Default' | 'Extension' | 'Failover' | 'Fanout' | 'HostBased' | 'LocationBased' | 'ProxyOnly' | 'Tenant' | string -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -* **subscriptionLifecycleNotificationSpecifications**: [ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#resourcetyperegistrationpropertiessubscriptionlifecyclenotificationspecifications) -* **subscriptionStateRules**: [SubscriptionStateRule](#subscriptionstaterule)[]: Array of SubscriptionStateRule -* **swaggerSpecifications**: [SwaggerSpecification](#swaggerspecification)[]: Array of SwaggerSpecification -* **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) -* **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule - -## AuthorizationActionMapping -### Properties -* **desired**: string -* **original**: string - -## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications -### Properties -* **enableDefaultValidation**: bool -* **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem - -## ResourceTypeEndpoint -### Properties -* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem -* **enabled**: bool -* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension -* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) -* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem -* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem -* **timeout**: string - -## ResourceTypeExtension -### Properties -* **endpointUri**: string -* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory -* **timeout**: string - -## ResourceTypeEndpointFeaturesRule -### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) +* **loggingRules**: [LoggingRule](#loggingrule)[]: Array of LoggingRule +* **management**: [ResourceTypeRegistrationPropertiesManagement](#resourcetyperegistrationpropertiesmanagement) +* **marketplaceType**: 'AddOn' | 'Bypass' | 'NotSpecified' | 'Store' | string +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **regionality**: 'Global' | 'NotSpecified' | 'Regional' | string +* **requestHeaderOptions**: [ResourceTypeRegistrationPropertiesRequestHeaderOptions](#resourcetyperegistrationpropertiesrequestheaderoptions) +* **requiredFeatures**: string[]: Array of ResourceTypeRegistrationPropertiesRequiredFeaturesItem +* **resourceConcurrencyControlOptions**: [ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions](#resourcetyperegistrationpropertiesresourceconcurrencycontroloptions): Dictionary of +* **resourceDeletionPolicy**: 'CascadeDeleteAll' | 'CascadeDeleteProxyOnlyChildren' | 'NotSpecified' | string +* **resourceGraphConfiguration**: [ResourceTypeRegistrationPropertiesResourceGraphConfiguration](#resourcetyperegistrationpropertiesresourcegraphconfiguration) +* **resourceMovePolicy**: [ResourceTypeRegistrationPropertiesResourceMovePolicy](#resourcetyperegistrationpropertiesresourcemovepolicy) +* **routingType**: 'CascadeExtension' | 'Default' | 'Extension' | 'Failover' | 'Fanout' | 'HostBased' | 'LocationBased' | 'ProxyOnly' | 'Tenant' | string +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo +* **subscriptionLifecycleNotificationSpecifications**: [ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#resourcetyperegistrationpropertiessubscriptionlifecyclenotificationspecifications) +* **subscriptionStateRules**: [SubscriptionStateRule](#subscriptionstaterule)[]: Array of SubscriptionStateRule +* **swaggerSpecifications**: [SwaggerSpecification](#swaggerspecification)[]: Array of SwaggerSpecification +* **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) +* **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## ExtendedLocationOptions +## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications ### Properties -* **supportedPolicy**: string -* **type**: string +* **enableDefaultValidation**: bool +* **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem ## ResourceTypeRegistrationPropertiesExtensionOptions ### Properties * **resourceCreationBegin**: [ResourceTypeExtensionOptionsResourceCreationBegin](#resourcetypeextensionoptionsresourcecreationbegin) -## ResourceTypeExtensionOptionsResourceCreationBegin -### Properties -* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType -* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType - ## ResourceTypeRegistrationPropertiesFeaturesRule ### Properties * **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) @@ -284,26 +417,6 @@ * **applicationId**: string * **type**: 'Actor' | 'DelegatedResourceIdentity' | 'NotSpecified' | 'SystemAssigned' | 'UserAssigned' | string -## LinkedAccessCheck -### Properties -* **actionName**: string -* **linkedAction**: string -* **linkedActionVerb**: string -* **linkedProperty**: string -* **linkedType**: string - -## LoggingRule -### Properties -* **action**: string (Required) -* **detailLevel**: 'Body' | 'None' | string (Required) -* **direction**: 'None' | 'Request' | 'Response' | string (Required) -* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) - -## LoggingRuleHiddenPropertyPaths -### Properties -* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem -* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem - ## ResourceTypeRegistrationPropertiesManagement ### Properties * **incidentContactEmail**: string @@ -324,10 +437,6 @@ ### Additional Properties * **Additional Properties Type**: [ResourceConcurrencyControlOption](#resourceconcurrencycontroloption) -## ResourceConcurrencyControlOption -### Properties -* **policy**: 'NotSpecified' | 'SynchronizeBeginExtension' | string - ## ResourceTypeRegistrationPropertiesResourceGraphConfiguration ### Properties * **apiVersion**: string @@ -344,161 +453,39 @@ * **softDeleteTTL**: string * **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction -## SubscriptionStateOverrideAction -### Properties -* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) - -## SubscriptionStateRule -### Properties -* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string - -## SwaggerSpecification -### Properties -* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem -* **swaggerSpecFolderUri**: string - ## ResourceTypeRegistrationPropertiesTemplateDeploymentOptions ### Properties * **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption * **preflightSupported**: bool -## ThrottlingRule -### Properties -* **action**: string (Required) -* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric -* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem - -## ThrottlingMetric -### Properties -* **interval**: string -* **limit**: int (Required) -* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) - -## CustomRolloutPropertiesStatus -### Properties -* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem -* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of - -## CustomRolloutStatusFailedOrSkippedRegions -### Properties -### Additional Properties -* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) - -## ExtendedErrorInfo -### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo -* **code**: string -* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo -* **message**: string -* **target**: string - -## TypedErrorInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (Required) - -## DefaultRolloutProperties -### Properties -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) -* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) - -## DefaultRolloutPropertiesSpecification -### Properties -* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) -* **expeditedRollout**: [DefaultRolloutSpecificationExpeditedRollout](#defaultrolloutspecificationexpeditedrollout) -* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) -* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) -* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) -* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) -* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration -* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) -* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) - -## DefaultRolloutSpecificationCanary -### Properties -* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem -* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem - -## DefaultRolloutSpecificationExpeditedRollout -### Properties -* **enabled**: bool: Indicates whether expedited rollout is enabled/disabled - -## DefaultRolloutSpecificationHighTraffic -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationLowTraffic -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationMediumTraffic -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationProviderRegistration -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## DefaultRolloutSpecificationRestOfTheWorldGroupOne -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutSpecificationRestOfTheWorldGroupTwo -### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string - -## DefaultRolloutPropertiesStatus -### Properties -* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem -* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of -* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string -* **nextTrafficRegionScheduledTime**: string -* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string - ## RolloutStatusBaseFailedOrSkippedRegions ### Properties ### Additional Properties * **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) -## NotificationRegistrationProperties +## ServiceTreeInfo ### Properties -* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem -* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string -* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint -* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **componentId**: string +* **serviceId**: string -## NotificationEndpoint +## SkuCapability ### Properties -* **locations**: string[]: Array of NotificationEndpointLocationsItem -* **notificationDestination**: string +* **name**: string (Required) +* **value**: string (Required) -## OperationsDefinition +## SkuCost ### Properties -* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) -* **display**: [OperationsDefinitionDisplay](#operationsdefinitiondisplay) (Required, WriteOnly): Display information of the operation. -* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. -* **name**: string (Required, WriteOnly): Name of the operation. -* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) -* **properties**: any (WriteOnly): Anything +* **extendedUnit**: string +* **meterId**: string (Required) +* **quantity**: int -## OperationsDefinitionDisplay +## SkuLocationInfo ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem +* **location**: string (Required) +* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string +* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail +* **zones**: string[]: Array of SkuLocationInfoZonesItem ## SkuResourceProperties ### Properties @@ -520,11 +507,6 @@ * **size**: string * **tier**: string -## SkuCapability -### Properties -* **name**: string (Required) -* **value**: string (Required) - ## SkuSettingCapacity ### Properties * **default**: int @@ -532,22 +514,40 @@ * **minimum**: int (Required) * **scaleType**: 'Automatic' | 'Manual' | 'None' | string -## SkuCost +## SkuZoneDetail ### Properties -* **extendedUnit**: string -* **meterId**: string (Required) -* **quantity**: int +* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability +* **name**: string[]: Array of SkuZoneDetailNameItem -## SkuLocationInfo +## SubscriptionStateOverrideAction ### Properties -* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem -* **location**: string (Required) -* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string -* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail -* **zones**: string[]: Array of SkuLocationInfoZonesItem +* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) -## SkuZoneDetail +## SubscriptionStateRule ### Properties -* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability -* **name**: string[]: Array of SkuZoneDetailNameItem +* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string + +## SwaggerSpecification +### Properties +* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem +* **swaggerSpecFolderUri**: string + +## ThrottlingMetric +### Properties +* **interval**: string +* **limit**: int (Required) +* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) + +## ThrottlingRule +### Properties +* **action**: string (Required) +* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric +* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem + +## TypedErrorInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (Required) diff --git a/generated/providerhub/microsoft.providerhub/2021-06-01-preview/types.md b/generated/providerhub/microsoft.providerhub/2021-06-01-preview/types.md index fdb920d425..2366e16d54 100644 --- a/generated/providerhub/microsoft.providerhub/2021-06-01-preview/types.md +++ b/generated/providerhub/microsoft.providerhub/2021-06-01-preview/types.md @@ -99,107 +99,10 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus' (ReadOnly, DeployTimeConstant): The resource type -## ProviderRegistrationProperties -### Properties -* **capabilities**: [ResourceProviderCapabilities](#resourceprovidercapabilities)[]: Array of ResourceProviderCapabilities -* **featuresRule**: [ResourceProviderManifestPropertiesFeaturesRule](#resourceprovidermanifestpropertiesfeaturesrule) -* **management**: [ResourceProviderManifestPropertiesManagement](#resourceprovidermanifestpropertiesmanagement) -* **metadata**: any: Anything -* **namespace**: string -* **providerAuthentication**: [ResourceProviderManifestPropertiesProviderAuthentication](#resourceprovidermanifestpropertiesproviderauthentication) -* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization -* **providerHubMetadata**: [ProviderRegistrationPropertiesProviderHubMetadata](#providerregistrationpropertiesproviderhubmetadata) -* **providerType**: 'AuthorizationFree' | 'External' | 'Hidden' | 'Internal' | 'LegacyRegistrationRequired' | 'NotSpecified' | 'RegistrationFree' | 'TenantOnly' | string -* **providerVersion**: string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **requestHeaderOptions**: [ResourceProviderManifestPropertiesRequestHeaderOptions](#resourceprovidermanifestpropertiesrequestheaderoptions) -* **requiredFeatures**: string[]: Array of ResourceProviderManifestPropertiesRequiredFeaturesItem -* **subscriptionLifecycleNotificationSpecifications**: [ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#providerregistrationpropertiessubscriptionlifecyclenotificationspecifications) -* **templateDeploymentOptions**: [ResourceProviderManifestPropertiesTemplateDeploymentOptions](#resourceprovidermanifestpropertiestemplatedeploymentoptions) - -## ResourceProviderCapabilities -### Properties -* **effect**: 'Allow' | 'Disallow' | 'NotSpecified' | string (Required) -* **quotaId**: string (Required) -* **requiredFeatures**: string[]: Array of ResourceProviderCapabilitiesRequiredFeaturesItem - -## ResourceProviderManifestPropertiesFeaturesRule -### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) - -## ResourceProviderManifestPropertiesManagement -### Properties -* **incidentContactEmail**: string -* **incidentRoutingService**: string -* **incidentRoutingTeam**: string -* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem -* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string -* **resourceAccessRoles**: any[]: Array of any -* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo - -## ServiceTreeInfo -### Properties -* **componentId**: string -* **serviceId**: string - -## ResourceProviderManifestPropertiesProviderAuthentication -### Properties -* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem - -## ResourceProviderAuthorization -### Properties -* **applicationId**: string -* **managedByRoleDefinitionId**: string -* **roleDefinitionId**: string - -## ProviderRegistrationPropertiesProviderHubMetadata -### Properties -* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) -* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization -* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) - -## ProviderHubMetadataProviderAuthentication -### Properties -* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem - -## ProviderHubMetadataThirdPartyProviderAuthorization -### Properties -* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization -* **managedByTenantId**: string - -## LightHouseAuthorization -### Properties -* **principalId**: string (Required) -* **roleDefinitionId**: string (Required) - -## ResourceProviderManifestPropertiesRequestHeaderOptions -### Properties -* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string - -## ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications -### Properties -* **softDeleteTTL**: string -* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction - -## SubscriptionStateOverrideAction -### Properties -* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) - -## ResourceProviderManifestPropertiesTemplateDeploymentOptions -### Properties -* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption -* **preflightSupported**: bool - -## SystemData +## AuthorizationActionMapping ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **desired**: string +* **original**: string ## CustomRolloutProperties ### Properties @@ -213,6 +116,11 @@ * **providerRegistration**: [CustomRolloutSpecificationProviderRegistration](#customrolloutspecificationproviderregistration) * **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +## CustomRolloutPropertiesStatus +### Properties +* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem +* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of + ## CustomRolloutSpecificationCanary ### Properties * **regions**: string[]: Array of TrafficRegionsItem @@ -225,103 +133,96 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ResourceTypeRegistration +## CustomRolloutStatusFailedOrSkippedRegions ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ResourceTypeRegistrationProperties](#resourcetyperegistrationproperties) -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +### Additional Properties +* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) -## ResourceTypeRegistrationProperties +## DefaultRolloutProperties ### Properties -* **allowedUnauthorizedActions**: string[]: Array of ResourceTypeRegistrationPropertiesAllowedUnauthorizedActionsItem -* **authorizationActionMappings**: [AuthorizationActionMapping](#authorizationactionmapping)[]: Array of AuthorizationActionMapping -* **checkNameAvailabilitySpecifications**: [ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications](#resourcetyperegistrationpropertieschecknameavailabilityspecifications) -* **defaultApiVersion**: string -* **disallowedActionVerbs**: string[]: Array of ResourceTypeRegistrationPropertiesDisallowedActionVerbsItem -* **enableAsyncOperation**: bool -* **enableThirdPartyS2S**: bool -* **endpoints**: [ResourceTypeEndpoint](#resourcetypeendpoint)[]: Array of ResourceTypeEndpoint -* **extendedLocations**: [ExtendedLocationOptions](#extendedlocationoptions)[]: Array of ExtendedLocationOptions -* **extensionOptions**: [ResourceTypeRegistrationPropertiesExtensionOptions](#resourcetyperegistrationpropertiesextensionoptions) -* **featuresRule**: [ResourceTypeRegistrationPropertiesFeaturesRule](#resourcetyperegistrationpropertiesfeaturesrule) -* **identityManagement**: [ResourceTypeRegistrationPropertiesIdentityManagement](#resourcetyperegistrationpropertiesidentitymanagement) -* **isPureProxy**: bool -* **linkedAccessChecks**: [LinkedAccessCheck](#linkedaccesscheck)[]: Array of LinkedAccessCheck -* **loggingRules**: [LoggingRule](#loggingrule)[]: Array of LoggingRule -* **management**: [ResourceTypeRegistrationPropertiesManagement](#resourcetyperegistrationpropertiesmanagement) -* **marketplaceType**: 'AddOn' | 'Bypass' | 'NotSpecified' | 'Store' | string -* **openApiConfiguration**: [OpenApiConfiguration](#openapiconfiguration) * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **regionality**: 'Global' | 'NotSpecified' | 'Regional' | string -* **requestHeaderOptions**: [ResourceTypeRegistrationPropertiesRequestHeaderOptions](#resourcetyperegistrationpropertiesrequestheaderoptions) -* **requiredFeatures**: string[]: Array of ResourceTypeRegistrationPropertiesRequiredFeaturesItem -* **resourceConcurrencyControlOptions**: [ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions](#resourcetyperegistrationpropertiesresourceconcurrencycontroloptions): Dictionary of -* **resourceDeletionPolicy**: 'CascadeDeleteAll' | 'CascadeDeleteProxyOnlyChildren' | 'NotSpecified' | string -* **resourceGraphConfiguration**: [ResourceTypeRegistrationPropertiesResourceGraphConfiguration](#resourcetyperegistrationpropertiesresourcegraphconfiguration) -* **resourceMovePolicy**: [ResourceTypeRegistrationPropertiesResourceMovePolicy](#resourcetyperegistrationpropertiesresourcemovepolicy) -* **routingType**: 'CascadeExtension' | 'Default' | 'Extension' | 'Failover' | 'Fanout' | 'HostBased' | 'LocationBased' | 'ProxyOnly' | 'Tenant' | string -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -* **subscriptionLifecycleNotificationSpecifications**: [ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#resourcetyperegistrationpropertiessubscriptionlifecyclenotificationspecifications) -* **subscriptionStateRules**: [SubscriptionStateRule](#subscriptionstaterule)[]: Array of SubscriptionStateRule -* **swaggerSpecifications**: [SwaggerSpecification](#swaggerspecification)[]: Array of SwaggerSpecification -* **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) -* **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule +* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) +* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) -## AuthorizationActionMapping +## DefaultRolloutPropertiesSpecification ### Properties -* **desired**: string -* **original**: string +* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) +* **expeditedRollout**: [DefaultRolloutSpecificationExpeditedRollout](#defaultrolloutspecificationexpeditedrollout) +* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) +* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) +* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) +* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) +* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) +* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) -## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications +## DefaultRolloutPropertiesStatus ### Properties -* **enableDefaultValidation**: bool -* **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem +* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem +* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of +* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string +* **nextTrafficRegionScheduledTime**: string +* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string -## ResourceTypeEndpoint +## DefaultRolloutSpecificationCanary ### Properties -* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem -* **enabled**: bool -* **endpointType**: 'Canary' | 'NotSpecified' | 'Production' | 'TestInProduction' | string -* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension -* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) -* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem -* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem -* **timeout**: string +* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem +* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem -## ResourceTypeExtension +## DefaultRolloutSpecificationExpeditedRollout ### Properties -* **endpointUri**: string -* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory -* **timeout**: string +* **enabled**: bool: Indicates whether expedited rollout is enabled/disabled -## ResourceTypeEndpointFeaturesRule +## DefaultRolloutSpecificationHighTraffic ### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ExtendedLocationOptions +## DefaultRolloutSpecificationLowTraffic ### Properties -* **supportedPolicy**: string -* **type**: string +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ResourceTypeRegistrationPropertiesExtensionOptions +## DefaultRolloutSpecificationMediumTraffic ### Properties -* **resourceCreationBegin**: [ResourceTypeExtensionOptionsResourceCreationBegin](#resourcetypeextensionoptionsresourcecreationbegin) +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ResourceTypeExtensionOptionsResourceCreationBegin +## DefaultRolloutSpecificationProviderRegistration ### Properties -* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType -* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ResourceTypeRegistrationPropertiesFeaturesRule +## DefaultRolloutSpecificationRestOfTheWorldGroupOne ### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ResourceTypeRegistrationPropertiesIdentityManagement +## DefaultRolloutSpecificationRestOfTheWorldGroupTwo ### Properties -* **applicationId**: string -* **type**: 'Actor' | 'DelegatedResourceIdentity' | 'NotSpecified' | 'SystemAssigned' | 'UserAssigned' | string +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## ExtendedErrorInfo +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo +* **code**: string +* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo +* **message**: string +* **target**: string + +## ExtendedLocationOptions +### Properties +* **supportedPolicy**: string +* **type**: string + +## LightHouseAuthorization +### Properties +* **principalId**: string (Required) +* **roleDefinitionId**: string (Required) ## LinkedAccessCheck ### Properties @@ -331,361 +232,438 @@ * **linkedProperty**: string * **linkedType**: string -## LoggingRule -### Properties -* **action**: string (Required) -* **detailLevel**: 'Body' | 'None' | string (Required) -* **direction**: 'None' | 'Request' | 'Response' | string (Required) -* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) - -## LoggingRuleHiddenPropertyPaths +## LocalizedOperationDefinition ### Properties -* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem -* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem +* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) +* **display**: [LocalizedOperationDefinitionDisplay](#localizedoperationdefinitiondisplay) (Required, WriteOnly): Display information of the operation. +* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. +* **name**: string (Required, WriteOnly): Name of the operation. +* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) +* **properties**: any (WriteOnly): Anything -## ResourceTypeRegistrationPropertiesManagement +## LocalizedOperationDefinitionDisplay ### Properties -* **incidentContactEmail**: string -* **incidentRoutingService**: string -* **incidentRoutingTeam**: string -* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem -* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string -* **resourceAccessRoles**: any[]: Array of any -* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo +* **cs**: [LocalizedOperationDisplayDefinitionCs](#localizedoperationdisplaydefinitioncs) (WriteOnly): Display information of the operation for cs locale. +* **de**: [LocalizedOperationDisplayDefinitionDe](#localizedoperationdisplaydefinitionde) (WriteOnly): Display information of the operation for de locale. +* **default**: [LocalizedOperationDisplayDefinitionDefault](#localizedoperationdisplaydefinitiondefault) (Required, WriteOnly): Display information of the operation. +* **en**: [LocalizedOperationDisplayDefinitionEn](#localizedoperationdisplaydefinitionen) (WriteOnly): Display information of the operation for en locale. +* **es**: [LocalizedOperationDisplayDefinitionEs](#localizedoperationdisplaydefinitiones) (WriteOnly): Display information of the operation for es locale. +* **fr**: [LocalizedOperationDisplayDefinitionFr](#localizedoperationdisplaydefinitionfr) (WriteOnly): Display information of the operation for fr locale. +* **hu**: [LocalizedOperationDisplayDefinitionHu](#localizedoperationdisplaydefinitionhu) (WriteOnly): Display information of the operation for hu locale. +* **it**: [LocalizedOperationDisplayDefinitionIt](#localizedoperationdisplaydefinitionit) (WriteOnly): Display information of the operation for it locale. +* **ja**: [LocalizedOperationDisplayDefinitionJa](#localizedoperationdisplaydefinitionja) (WriteOnly): Display information of the operation for ja locale. +* **ko**: [LocalizedOperationDisplayDefinitionKo](#localizedoperationdisplaydefinitionko) (WriteOnly): Display information of the operation for ko locale. +* **nl**: [LocalizedOperationDisplayDefinitionNl](#localizedoperationdisplaydefinitionnl) (WriteOnly): Display information of the operation for nl locale. +* **pl**: [LocalizedOperationDisplayDefinitionPl](#localizedoperationdisplaydefinitionpl) (WriteOnly): Display information of the operation for pl locale. +* **ptBR**: [LocalizedOperationDisplayDefinitionPtBR](#localizedoperationdisplaydefinitionptbr) (WriteOnly): Display information of the operation for pt-BR locale. +* **ptPT**: [LocalizedOperationDisplayDefinitionPt](#localizedoperationdisplaydefinitionpt) (WriteOnly): Display information of the operation for pt-PT locale. +* **ru**: [LocalizedOperationDisplayDefinitionRu](#localizedoperationdisplaydefinitionru) (WriteOnly): Display information of the operation for ru locale. +* **sv**: [LocalizedOperationDisplayDefinitionSv](#localizedoperationdisplaydefinitionsv) (WriteOnly): Display information of the operation for sv locale. +* **zhHans**: [LocalizedOperationDisplayDefinitionZhHans](#localizedoperationdisplaydefinitionzhhans) (WriteOnly): Display information of the operation for zh-Hans locale. +* **zhHant**: [LocalizedOperationDisplayDefinitionZhHant](#localizedoperationdisplaydefinitionzhhant) (WriteOnly): Display information of the operation for zh-Hant locale. -## OpenApiConfiguration +## LocalizedOperationDisplayDefinitionCs ### Properties -* **validation**: [OpenApiValidation](#openapivalidation) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## OpenApiValidation +## LocalizedOperationDisplayDefinitionDe ### Properties -* **allowNoncompliantCollectionResponse**: bool: Indicates whether a non compliance response is allowed for a LIST call +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesRequestHeaderOptions +## LocalizedOperationDisplayDefinitionDefault ### Properties -* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions +## LocalizedOperationDisplayDefinitionEn ### Properties -### Additional Properties -* **Additional Properties Type**: [ResourceConcurrencyControlOption](#resourceconcurrencycontroloption) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceConcurrencyControlOption +## LocalizedOperationDisplayDefinitionEs ### Properties -* **policy**: 'NotSpecified' | 'SynchronizeBeginExtension' | string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesResourceGraphConfiguration +## LocalizedOperationDisplayDefinitionFr ### Properties -* **apiVersion**: string -* **enabled**: bool +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesResourceMovePolicy +## LocalizedOperationDisplayDefinitionHu ### Properties -* **crossResourceGroupMoveEnabled**: bool -* **crossSubscriptionMoveEnabled**: bool -* **validationRequired**: bool +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications +## LocalizedOperationDisplayDefinitionIt ### Properties -* **softDeleteTTL**: string -* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## SubscriptionStateRule +## LocalizedOperationDisplayDefinitionJa ### Properties -* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## SwaggerSpecification +## LocalizedOperationDisplayDefinitionKo ### Properties -* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem -* **swaggerSpecFolderUri**: string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesTemplateDeploymentOptions +## LocalizedOperationDisplayDefinitionNl ### Properties -* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption -* **preflightSupported**: bool +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ThrottlingRule +## LocalizedOperationDisplayDefinitionPl ### Properties -* **action**: string (Required) -* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric -* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ThrottlingMetric +## LocalizedOperationDisplayDefinitionPt ### Properties -* **interval**: string -* **limit**: int (Required) -* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## CustomRolloutPropertiesStatus +## LocalizedOperationDisplayDefinitionPtBR ### Properties -* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem -* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## CustomRolloutStatusFailedOrSkippedRegions +## LocalizedOperationDisplayDefinitionRu ### Properties -### Additional Properties -* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ExtendedErrorInfo +## LocalizedOperationDisplayDefinitionSv ### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo -* **code**: string -* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo -* **message**: string -* **target**: string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## TypedErrorInfo +## LocalizedOperationDisplayDefinitionZhHans ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (Required) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## DefaultRolloutProperties +## LocalizedOperationDisplayDefinitionZhHant +### Properties +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) + +## LoggingRule +### Properties +* **action**: string (Required) +* **detailLevel**: 'Body' | 'None' | string (Required) +* **direction**: 'None' | 'Request' | 'Response' | string (Required) +* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) + +## LoggingRuleHiddenPropertyPaths ### Properties +* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem +* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem + +## NotificationEndpoint +### Properties +* **locations**: string[]: Array of NotificationEndpointLocationsItem +* **notificationDestination**: string + +## NotificationRegistrationProperties +### Properties +* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem +* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string +* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint +* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) -* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) -## DefaultRolloutPropertiesSpecification +## OpenApiConfiguration ### Properties -* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) -* **expeditedRollout**: [DefaultRolloutSpecificationExpeditedRollout](#defaultrolloutspecificationexpeditedrollout) -* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) -* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) -* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) -* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) -* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration -* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) -* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) +* **validation**: [OpenApiValidation](#openapivalidation) -## DefaultRolloutSpecificationCanary +## OpenApiValidation ### Properties -* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem -* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem +* **allowNoncompliantCollectionResponse**: bool: Indicates whether a non compliance response is allowed for a LIST call -## DefaultRolloutSpecificationExpeditedRollout +## OperationsPutContentProperties ### Properties -* **enabled**: bool: Indicates whether expedited rollout is enabled/disabled +* **contents**: [LocalizedOperationDefinition](#localizedoperationdefinition)[] (WriteOnly): Operations content. -## DefaultRolloutSpecificationHighTraffic +## ProviderHubMetadataProviderAuthentication ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem -## DefaultRolloutSpecificationLowTraffic +## ProviderHubMetadataThirdPartyProviderAuthorization ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization +* **managedByTenantId**: string -## DefaultRolloutSpecificationMediumTraffic +## ProviderRegistrationProperties ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **capabilities**: [ResourceProviderCapabilities](#resourceprovidercapabilities)[]: Array of ResourceProviderCapabilities +* **featuresRule**: [ResourceProviderManifestPropertiesFeaturesRule](#resourceprovidermanifestpropertiesfeaturesrule) +* **management**: [ResourceProviderManifestPropertiesManagement](#resourceprovidermanifestpropertiesmanagement) +* **metadata**: any: Anything +* **namespace**: string +* **providerAuthentication**: [ResourceProviderManifestPropertiesProviderAuthentication](#resourceprovidermanifestpropertiesproviderauthentication) +* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization +* **providerHubMetadata**: [ProviderRegistrationPropertiesProviderHubMetadata](#providerregistrationpropertiesproviderhubmetadata) +* **providerType**: 'AuthorizationFree' | 'External' | 'Hidden' | 'Internal' | 'LegacyRegistrationRequired' | 'NotSpecified' | 'RegistrationFree' | 'TenantOnly' | string +* **providerVersion**: string +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **requestHeaderOptions**: [ResourceProviderManifestPropertiesRequestHeaderOptions](#resourceprovidermanifestpropertiesrequestheaderoptions) +* **requiredFeatures**: string[]: Array of ResourceProviderManifestPropertiesRequiredFeaturesItem +* **subscriptionLifecycleNotificationSpecifications**: [ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#providerregistrationpropertiessubscriptionlifecyclenotificationspecifications) +* **templateDeploymentOptions**: [ResourceProviderManifestPropertiesTemplateDeploymentOptions](#resourceprovidermanifestpropertiestemplatedeploymentoptions) -## DefaultRolloutSpecificationProviderRegistration +## ProviderRegistrationPropertiesProviderHubMetadata ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) +* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization +* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) -## DefaultRolloutSpecificationRestOfTheWorldGroupOne +## ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **softDeleteTTL**: string +* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction -## DefaultRolloutSpecificationRestOfTheWorldGroupTwo +## ResourceConcurrencyControlOption ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **policy**: 'NotSpecified' | 'SynchronizeBeginExtension' | string -## DefaultRolloutPropertiesStatus +## ResourceProviderAuthorization ### Properties -* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem -* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of -* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string -* **nextTrafficRegionScheduledTime**: string -* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string +* **applicationId**: string +* **managedByRoleDefinitionId**: string +* **roleDefinitionId**: string -## RolloutStatusBaseFailedOrSkippedRegions +## ResourceProviderCapabilities ### Properties -### Additional Properties -* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) +* **effect**: 'Allow' | 'Disallow' | 'NotSpecified' | string (Required) +* **quotaId**: string (Required) +* **requiredFeatures**: string[]: Array of ResourceProviderCapabilitiesRequiredFeaturesItem -## NotificationRegistrationProperties +## ResourceProviderManifestPropertiesFeaturesRule ### Properties -* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem -* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string -* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint -* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## NotificationEndpoint +## ResourceProviderManifestPropertiesManagement ### Properties -* **locations**: string[]: Array of NotificationEndpointLocationsItem -* **notificationDestination**: string +* **incidentContactEmail**: string +* **incidentRoutingService**: string +* **incidentRoutingTeam**: string +* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem +* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string +* **resourceAccessRoles**: any[]: Array of any +* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -## OperationsPutContentProperties +## ResourceProviderManifestPropertiesProviderAuthentication ### Properties -* **contents**: [LocalizedOperationDefinition](#localizedoperationdefinition)[] (WriteOnly): Operations content. +* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem -## LocalizedOperationDefinition +## ResourceProviderManifestPropertiesRequestHeaderOptions ### Properties -* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) -* **display**: [LocalizedOperationDefinitionDisplay](#localizedoperationdefinitiondisplay) (Required, WriteOnly): Display information of the operation. -* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. -* **name**: string (Required, WriteOnly): Name of the operation. -* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) -* **properties**: any (WriteOnly): Anything +* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string -## LocalizedOperationDefinitionDisplay +## ResourceProviderManifestPropertiesTemplateDeploymentOptions ### Properties -* **cs**: [LocalizedOperationDisplayDefinitionCs](#localizedoperationdisplaydefinitioncs) (WriteOnly): Display information of the operation for cs locale. -* **de**: [LocalizedOperationDisplayDefinitionDe](#localizedoperationdisplaydefinitionde) (WriteOnly): Display information of the operation for de locale. -* **default**: [LocalizedOperationDisplayDefinitionDefault](#localizedoperationdisplaydefinitiondefault) (Required, WriteOnly): Display information of the operation. -* **en**: [LocalizedOperationDisplayDefinitionEn](#localizedoperationdisplaydefinitionen) (WriteOnly): Display information of the operation for en locale. -* **es**: [LocalizedOperationDisplayDefinitionEs](#localizedoperationdisplaydefinitiones) (WriteOnly): Display information of the operation for es locale. -* **fr**: [LocalizedOperationDisplayDefinitionFr](#localizedoperationdisplaydefinitionfr) (WriteOnly): Display information of the operation for fr locale. -* **hu**: [LocalizedOperationDisplayDefinitionHu](#localizedoperationdisplaydefinitionhu) (WriteOnly): Display information of the operation for hu locale. -* **it**: [LocalizedOperationDisplayDefinitionIt](#localizedoperationdisplaydefinitionit) (WriteOnly): Display information of the operation for it locale. -* **ja**: [LocalizedOperationDisplayDefinitionJa](#localizedoperationdisplaydefinitionja) (WriteOnly): Display information of the operation for ja locale. -* **ko**: [LocalizedOperationDisplayDefinitionKo](#localizedoperationdisplaydefinitionko) (WriteOnly): Display information of the operation for ko locale. -* **nl**: [LocalizedOperationDisplayDefinitionNl](#localizedoperationdisplaydefinitionnl) (WriteOnly): Display information of the operation for nl locale. -* **pl**: [LocalizedOperationDisplayDefinitionPl](#localizedoperationdisplaydefinitionpl) (WriteOnly): Display information of the operation for pl locale. -* **ptBR**: [LocalizedOperationDisplayDefinitionPtBR](#localizedoperationdisplaydefinitionptbr) (WriteOnly): Display information of the operation for pt-BR locale. -* **ptPT**: [LocalizedOperationDisplayDefinitionPt](#localizedoperationdisplaydefinitionpt) (WriteOnly): Display information of the operation for pt-PT locale. -* **ru**: [LocalizedOperationDisplayDefinitionRu](#localizedoperationdisplaydefinitionru) (WriteOnly): Display information of the operation for ru locale. -* **sv**: [LocalizedOperationDisplayDefinitionSv](#localizedoperationdisplaydefinitionsv) (WriteOnly): Display information of the operation for sv locale. -* **zhHans**: [LocalizedOperationDisplayDefinitionZhHans](#localizedoperationdisplaydefinitionzhhans) (WriteOnly): Display information of the operation for zh-Hans locale. -* **zhHant**: [LocalizedOperationDisplayDefinitionZhHant](#localizedoperationdisplaydefinitionzhhant) (WriteOnly): Display information of the operation for zh-Hant locale. +* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption +* **preflightSupported**: bool + +## ResourceTypeEndpoint +### Properties +* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem +* **enabled**: bool +* **endpointType**: 'Canary' | 'NotSpecified' | 'Production' | 'TestInProduction' | string +* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension +* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) +* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem +* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem +* **timeout**: string + +## ResourceTypeEndpointFeaturesRule +### Properties +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## LocalizedOperationDisplayDefinitionCs +## ResourceTypeExtension ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **endpointUri**: string +* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory +* **timeout**: string -## LocalizedOperationDisplayDefinitionDe +## ResourceTypeExtensionOptionsResourceCreationBegin ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType +* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType -## LocalizedOperationDisplayDefinitionDefault +## ResourceTypeRegistration ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ResourceTypeRegistrationProperties](#resourcetyperegistrationproperties) +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## LocalizedOperationDisplayDefinitionEn +## ResourceTypeRegistrationProperties ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **allowedUnauthorizedActions**: string[]: Array of ResourceTypeRegistrationPropertiesAllowedUnauthorizedActionsItem +* **authorizationActionMappings**: [AuthorizationActionMapping](#authorizationactionmapping)[]: Array of AuthorizationActionMapping +* **checkNameAvailabilitySpecifications**: [ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications](#resourcetyperegistrationpropertieschecknameavailabilityspecifications) +* **defaultApiVersion**: string +* **disallowedActionVerbs**: string[]: Array of ResourceTypeRegistrationPropertiesDisallowedActionVerbsItem +* **enableAsyncOperation**: bool +* **enableThirdPartyS2S**: bool +* **endpoints**: [ResourceTypeEndpoint](#resourcetypeendpoint)[]: Array of ResourceTypeEndpoint +* **extendedLocations**: [ExtendedLocationOptions](#extendedlocationoptions)[]: Array of ExtendedLocationOptions +* **extensionOptions**: [ResourceTypeRegistrationPropertiesExtensionOptions](#resourcetyperegistrationpropertiesextensionoptions) +* **featuresRule**: [ResourceTypeRegistrationPropertiesFeaturesRule](#resourcetyperegistrationpropertiesfeaturesrule) +* **identityManagement**: [ResourceTypeRegistrationPropertiesIdentityManagement](#resourcetyperegistrationpropertiesidentitymanagement) +* **isPureProxy**: bool +* **linkedAccessChecks**: [LinkedAccessCheck](#linkedaccesscheck)[]: Array of LinkedAccessCheck +* **loggingRules**: [LoggingRule](#loggingrule)[]: Array of LoggingRule +* **management**: [ResourceTypeRegistrationPropertiesManagement](#resourcetyperegistrationpropertiesmanagement) +* **marketplaceType**: 'AddOn' | 'Bypass' | 'NotSpecified' | 'Store' | string +* **openApiConfiguration**: [OpenApiConfiguration](#openapiconfiguration) +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **regionality**: 'Global' | 'NotSpecified' | 'Regional' | string +* **requestHeaderOptions**: [ResourceTypeRegistrationPropertiesRequestHeaderOptions](#resourcetyperegistrationpropertiesrequestheaderoptions) +* **requiredFeatures**: string[]: Array of ResourceTypeRegistrationPropertiesRequiredFeaturesItem +* **resourceConcurrencyControlOptions**: [ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions](#resourcetyperegistrationpropertiesresourceconcurrencycontroloptions): Dictionary of +* **resourceDeletionPolicy**: 'CascadeDeleteAll' | 'CascadeDeleteProxyOnlyChildren' | 'NotSpecified' | string +* **resourceGraphConfiguration**: [ResourceTypeRegistrationPropertiesResourceGraphConfiguration](#resourcetyperegistrationpropertiesresourcegraphconfiguration) +* **resourceMovePolicy**: [ResourceTypeRegistrationPropertiesResourceMovePolicy](#resourcetyperegistrationpropertiesresourcemovepolicy) +* **routingType**: 'CascadeExtension' | 'Default' | 'Extension' | 'Failover' | 'Fanout' | 'HostBased' | 'LocationBased' | 'ProxyOnly' | 'Tenant' | string +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo +* **subscriptionLifecycleNotificationSpecifications**: [ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#resourcetyperegistrationpropertiessubscriptionlifecyclenotificationspecifications) +* **subscriptionStateRules**: [SubscriptionStateRule](#subscriptionstaterule)[]: Array of SubscriptionStateRule +* **swaggerSpecifications**: [SwaggerSpecification](#swaggerspecification)[]: Array of SwaggerSpecification +* **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) +* **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## LocalizedOperationDisplayDefinitionEs +## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **enableDefaultValidation**: bool +* **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem -## LocalizedOperationDisplayDefinitionFr +## ResourceTypeRegistrationPropertiesExtensionOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **resourceCreationBegin**: [ResourceTypeExtensionOptionsResourceCreationBegin](#resourcetypeextensionoptionsresourcecreationbegin) -## LocalizedOperationDisplayDefinitionHu +## ResourceTypeRegistrationPropertiesFeaturesRule ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## LocalizedOperationDisplayDefinitionIt +## ResourceTypeRegistrationPropertiesIdentityManagement ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **applicationId**: string +* **type**: 'Actor' | 'DelegatedResourceIdentity' | 'NotSpecified' | 'SystemAssigned' | 'UserAssigned' | string -## LocalizedOperationDisplayDefinitionJa +## ResourceTypeRegistrationPropertiesManagement ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **incidentContactEmail**: string +* **incidentRoutingService**: string +* **incidentRoutingTeam**: string +* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem +* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string +* **resourceAccessRoles**: any[]: Array of any +* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -## LocalizedOperationDisplayDefinitionKo +## ResourceTypeRegistrationPropertiesRequestHeaderOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string -## LocalizedOperationDisplayDefinitionNl +## ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +### Additional Properties +* **Additional Properties Type**: [ResourceConcurrencyControlOption](#resourceconcurrencycontroloption) -## LocalizedOperationDisplayDefinitionPl +## ResourceTypeRegistrationPropertiesResourceGraphConfiguration ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **apiVersion**: string +* **enabled**: bool -## LocalizedOperationDisplayDefinitionPtBR +## ResourceTypeRegistrationPropertiesResourceMovePolicy ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **crossResourceGroupMoveEnabled**: bool +* **crossSubscriptionMoveEnabled**: bool +* **validationRequired**: bool -## LocalizedOperationDisplayDefinitionPt +## ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **softDeleteTTL**: string +* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction -## LocalizedOperationDisplayDefinitionRu +## ResourceTypeRegistrationPropertiesTemplateDeploymentOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption +* **preflightSupported**: bool -## LocalizedOperationDisplayDefinitionSv +## RolloutStatusBaseFailedOrSkippedRegions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +### Additional Properties +* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) -## LocalizedOperationDisplayDefinitionZhHans +## ServiceTreeInfo ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **componentId**: string +* **serviceId**: string -## LocalizedOperationDisplayDefinitionZhHant +## SkuCapability ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **name**: string (Required) +* **value**: string (Required) + +## SkuCost +### Properties +* **extendedUnit**: string +* **meterId**: string (Required) +* **quantity**: int + +## SkuLocationInfo +### Properties +* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem +* **location**: string (Required) +* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string +* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail +* **zones**: string[]: Array of SkuLocationInfoZonesItem ## SkuResourceProperties ### Properties @@ -707,11 +685,6 @@ * **size**: string * **tier**: string -## SkuCapability -### Properties -* **name**: string (Required) -* **value**: string (Required) - ## SkuSettingCapacity ### Properties * **default**: int @@ -719,22 +692,49 @@ * **minimum**: int (Required) * **scaleType**: 'Automatic' | 'Manual' | 'None' | string -## SkuCost +## SkuZoneDetail ### Properties -* **extendedUnit**: string -* **meterId**: string (Required) -* **quantity**: int +* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability +* **name**: string[]: Array of SkuZoneDetailNameItem -## SkuLocationInfo +## SubscriptionStateOverrideAction ### Properties -* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem -* **location**: string (Required) -* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string -* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail -* **zones**: string[]: Array of SkuLocationInfoZonesItem +* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) -## SkuZoneDetail +## SubscriptionStateRule ### Properties -* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability -* **name**: string[]: Array of SkuZoneDetailNameItem +* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string + +## SwaggerSpecification +### Properties +* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem +* **swaggerSpecFolderUri**: string + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## ThrottlingMetric +### Properties +* **interval**: string +* **limit**: int (Required) +* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) + +## ThrottlingRule +### Properties +* **action**: string (Required) +* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric +* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem + +## TypedErrorInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (Required) diff --git a/generated/providerhub/microsoft.providerhub/2021-09-01-preview/types.md b/generated/providerhub/microsoft.providerhub/2021-09-01-preview/types.md index d2f8f8117b..f54f361c0b 100644 --- a/generated/providerhub/microsoft.providerhub/2021-09-01-preview/types.md +++ b/generated/providerhub/microsoft.providerhub/2021-09-01-preview/types.md @@ -99,108 +99,10 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.ProviderHub/providerRegistrations/resourcetypeRegistrations/skus' (ReadOnly, DeployTimeConstant): The resource type -## ProviderRegistrationProperties -### Properties -* **capabilities**: [ResourceProviderCapabilities](#resourceprovidercapabilities)[]: Array of ResourceProviderCapabilities -* **featuresRule**: [ResourceProviderManifestPropertiesFeaturesRule](#resourceprovidermanifestpropertiesfeaturesrule) -* **management**: [ResourceProviderManifestPropertiesManagement](#resourceprovidermanifestpropertiesmanagement) -* **metadata**: any: Anything -* **namespace**: string -* **providerAuthentication**: [ResourceProviderManifestPropertiesProviderAuthentication](#resourceprovidermanifestpropertiesproviderauthentication) -* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization -* **providerHubMetadata**: [ProviderRegistrationPropertiesProviderHubMetadata](#providerregistrationpropertiesproviderhubmetadata) -* **providerType**: 'AuthorizationFree' | 'External' | 'Hidden' | 'Internal' | 'LegacyRegistrationRequired' | 'NotSpecified' | 'RegistrationFree' | 'TenantOnly' | string -* **providerVersion**: string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **requestHeaderOptions**: [ResourceProviderManifestPropertiesRequestHeaderOptions](#resourceprovidermanifestpropertiesrequestheaderoptions) -* **requiredFeatures**: string[]: Array of ResourceProviderManifestPropertiesRequiredFeaturesItem -* **subscriptionLifecycleNotificationSpecifications**: [ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#providerregistrationpropertiessubscriptionlifecyclenotificationspecifications) -* **templateDeploymentOptions**: [ResourceProviderManifestPropertiesTemplateDeploymentOptions](#resourceprovidermanifestpropertiestemplatedeploymentoptions) - -## ResourceProviderCapabilities -### Properties -* **effect**: 'Allow' | 'Disallow' | 'NotSpecified' | string (Required) -* **quotaId**: string (Required) -* **requiredFeatures**: string[]: Array of ResourceProviderCapabilitiesRequiredFeaturesItem - -## ResourceProviderManifestPropertiesFeaturesRule -### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) - -## ResourceProviderManifestPropertiesManagement -### Properties -* **incidentContactEmail**: string -* **incidentRoutingService**: string -* **incidentRoutingTeam**: string -* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem -* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string -* **resourceAccessRoles**: any[]: Array of any -* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo - -## ServiceTreeInfo -### Properties -* **componentId**: string -* **readiness**: 'ClosingDown' | 'Deprecated' | 'GA' | 'InDevelopment' | 'InternalOnly' | 'PrivatePreview' | 'PublicPreview' | 'RemovedFromARM' | 'Retired' | string -* **serviceId**: string - -## ResourceProviderManifestPropertiesProviderAuthentication -### Properties -* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem - -## ResourceProviderAuthorization -### Properties -* **applicationId**: string -* **managedByRoleDefinitionId**: string -* **roleDefinitionId**: string - -## ProviderRegistrationPropertiesProviderHubMetadata -### Properties -* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) -* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization -* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) - -## ProviderHubMetadataProviderAuthentication -### Properties -* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem - -## ProviderHubMetadataThirdPartyProviderAuthorization -### Properties -* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization -* **managedByTenantId**: string - -## LightHouseAuthorization -### Properties -* **principalId**: string (Required) -* **roleDefinitionId**: string (Required) - -## ResourceProviderManifestPropertiesRequestHeaderOptions -### Properties -* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string - -## ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications -### Properties -* **softDeleteTTL**: string -* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction - -## SubscriptionStateOverrideAction -### Properties -* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) -* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) - -## ResourceProviderManifestPropertiesTemplateDeploymentOptions -### Properties -* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption -* **preflightSupported**: bool - -## SystemData +## AuthorizationActionMapping ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **desired**: string +* **original**: string ## CustomRolloutProperties ### Properties @@ -214,6 +116,11 @@ * **providerRegistration**: [CustomRolloutSpecificationProviderRegistration](#customrolloutspecificationproviderregistration) * **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +## CustomRolloutPropertiesStatus +### Properties +* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem +* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of + ## CustomRolloutSpecificationCanary ### Properties * **regions**: string[]: Array of TrafficRegionsItem @@ -226,103 +133,96 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ResourceTypeRegistration +## CustomRolloutStatusFailedOrSkippedRegions ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ResourceTypeRegistrationProperties](#resourcetyperegistrationproperties) -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +### Additional Properties +* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) -## ResourceTypeRegistrationProperties +## DefaultRolloutProperties ### Properties -* **allowedUnauthorizedActions**: string[]: Array of ResourceTypeRegistrationPropertiesAllowedUnauthorizedActionsItem -* **authorizationActionMappings**: [AuthorizationActionMapping](#authorizationactionmapping)[]: Array of AuthorizationActionMapping -* **checkNameAvailabilitySpecifications**: [ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications](#resourcetyperegistrationpropertieschecknameavailabilityspecifications) -* **defaultApiVersion**: string -* **disallowedActionVerbs**: string[]: Array of ResourceTypeRegistrationPropertiesDisallowedActionVerbsItem -* **enableAsyncOperation**: bool -* **enableThirdPartyS2S**: bool -* **endpoints**: [ResourceTypeEndpoint](#resourcetypeendpoint)[]: Array of ResourceTypeEndpoint -* **extendedLocations**: [ExtendedLocationOptions](#extendedlocationoptions)[]: Array of ExtendedLocationOptions -* **extensionOptions**: [ResourceTypeRegistrationPropertiesExtensionOptions](#resourcetyperegistrationpropertiesextensionoptions) -* **featuresRule**: [ResourceTypeRegistrationPropertiesFeaturesRule](#resourcetyperegistrationpropertiesfeaturesrule) -* **identityManagement**: [ResourceTypeRegistrationPropertiesIdentityManagement](#resourcetyperegistrationpropertiesidentitymanagement) -* **isPureProxy**: bool -* **linkedAccessChecks**: [LinkedAccessCheck](#linkedaccesscheck)[]: Array of LinkedAccessCheck -* **loggingRules**: [LoggingRule](#loggingrule)[]: Array of LoggingRule -* **management**: [ResourceTypeRegistrationPropertiesManagement](#resourcetyperegistrationpropertiesmanagement) -* **marketplaceType**: 'AddOn' | 'Bypass' | 'NotSpecified' | 'Store' | string -* **openApiConfiguration**: [OpenApiConfiguration](#openapiconfiguration) * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **regionality**: 'Global' | 'NotSpecified' | 'Regional' | string -* **requestHeaderOptions**: [ResourceTypeRegistrationPropertiesRequestHeaderOptions](#resourcetyperegistrationpropertiesrequestheaderoptions) -* **requiredFeatures**: string[]: Array of ResourceTypeRegistrationPropertiesRequiredFeaturesItem -* **resourceConcurrencyControlOptions**: [ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions](#resourcetyperegistrationpropertiesresourceconcurrencycontroloptions): Dictionary of -* **resourceDeletionPolicy**: 'CascadeDeleteAll' | 'CascadeDeleteProxyOnlyChildren' | 'NotSpecified' | string -* **resourceGraphConfiguration**: [ResourceTypeRegistrationPropertiesResourceGraphConfiguration](#resourcetyperegistrationpropertiesresourcegraphconfiguration) -* **resourceMovePolicy**: [ResourceTypeRegistrationPropertiesResourceMovePolicy](#resourcetyperegistrationpropertiesresourcemovepolicy) -* **routingType**: 'CascadeExtension' | 'Default' | 'Extension' | 'Failover' | 'Fanout' | 'HostBased' | 'LocationBased' | 'ProxyOnly' | 'Tenant' | string -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -* **subscriptionLifecycleNotificationSpecifications**: [ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#resourcetyperegistrationpropertiessubscriptionlifecyclenotificationspecifications) -* **subscriptionStateRules**: [SubscriptionStateRule](#subscriptionstaterule)[]: Array of SubscriptionStateRule -* **swaggerSpecifications**: [SwaggerSpecification](#swaggerspecification)[]: Array of SwaggerSpecification -* **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) -* **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule +* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) +* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) -## AuthorizationActionMapping +## DefaultRolloutPropertiesSpecification ### Properties -* **desired**: string -* **original**: string +* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) +* **expeditedRollout**: [DefaultRolloutSpecificationExpeditedRollout](#defaultrolloutspecificationexpeditedrollout) +* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) +* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) +* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) +* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) +* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration +* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) +* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) -## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications +## DefaultRolloutPropertiesStatus ### Properties -* **enableDefaultValidation**: bool -* **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem +* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem +* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of +* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string +* **nextTrafficRegionScheduledTime**: string +* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string -## ResourceTypeEndpoint +## DefaultRolloutSpecificationCanary ### Properties -* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem -* **enabled**: bool -* **endpointType**: 'Canary' | 'NotSpecified' | 'Production' | 'TestInProduction' | string -* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension -* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) -* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem -* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem -* **timeout**: string +* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem +* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem -## ResourceTypeExtension +## DefaultRolloutSpecificationExpeditedRollout ### Properties -* **endpointUri**: string -* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory -* **timeout**: string +* **enabled**: bool: Indicates whether expedited rollout is enabled/disabled -## ResourceTypeEndpointFeaturesRule +## DefaultRolloutSpecificationHighTraffic ### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ExtendedLocationOptions +## DefaultRolloutSpecificationLowTraffic ### Properties -* **supportedPolicy**: string -* **type**: string +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ResourceTypeRegistrationPropertiesExtensionOptions +## DefaultRolloutSpecificationMediumTraffic ### Properties -* **resourceCreationBegin**: [ResourceTypeExtensionOptionsResourceCreationBegin](#resourcetypeextensionoptionsresourcecreationbegin) +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ResourceTypeExtensionOptionsResourceCreationBegin +## DefaultRolloutSpecificationProviderRegistration ### Properties -* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType -* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ResourceTypeRegistrationPropertiesFeaturesRule +## DefaultRolloutSpecificationRestOfTheWorldGroupOne ### Properties -* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string -## ResourceTypeRegistrationPropertiesIdentityManagement +## DefaultRolloutSpecificationRestOfTheWorldGroupTwo ### Properties -* **applicationId**: string -* **type**: 'Actor' | 'DelegatedResourceIdentity' | 'NotSpecified' | 'SystemAssigned' | 'UserAssigned' | string +* **regions**: string[]: Array of TrafficRegionsItem +* **waitDuration**: string + +## ExtendedErrorInfo +### Properties +* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo +* **code**: string +* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo +* **message**: string +* **target**: string + +## ExtendedLocationOptions +### Properties +* **supportedPolicy**: string +* **type**: string + +## LightHouseAuthorization +### Properties +* **principalId**: string (Required) +* **roleDefinitionId**: string (Required) ## LinkedAccessCheck ### Properties @@ -332,361 +232,439 @@ * **linkedProperty**: string * **linkedType**: string -## LoggingRule +## LocalizedOperationDefinition ### Properties -* **action**: string (Required) -* **detailLevel**: 'Body' | 'None' | string (Required) -* **direction**: 'None' | 'Request' | 'Response' | string (Required) -* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) - -## LoggingRuleHiddenPropertyPaths +* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) +* **display**: [LocalizedOperationDefinitionDisplay](#localizedoperationdefinitiondisplay) (Required, WriteOnly): Display information of the operation. +* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. +* **name**: string (Required, WriteOnly): Name of the operation. +* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) +* **properties**: any (WriteOnly): Anything + +## LocalizedOperationDefinitionDisplay ### Properties -* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem -* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem +* **cs**: [LocalizedOperationDisplayDefinitionCs](#localizedoperationdisplaydefinitioncs) (WriteOnly): Display information of the operation for cs locale. +* **de**: [LocalizedOperationDisplayDefinitionDe](#localizedoperationdisplaydefinitionde) (WriteOnly): Display information of the operation for de locale. +* **default**: [LocalizedOperationDisplayDefinitionDefault](#localizedoperationdisplaydefinitiondefault) (Required, WriteOnly): Display information of the operation. +* **en**: [LocalizedOperationDisplayDefinitionEn](#localizedoperationdisplaydefinitionen) (WriteOnly): Display information of the operation for en locale. +* **es**: [LocalizedOperationDisplayDefinitionEs](#localizedoperationdisplaydefinitiones) (WriteOnly): Display information of the operation for es locale. +* **fr**: [LocalizedOperationDisplayDefinitionFr](#localizedoperationdisplaydefinitionfr) (WriteOnly): Display information of the operation for fr locale. +* **hu**: [LocalizedOperationDisplayDefinitionHu](#localizedoperationdisplaydefinitionhu) (WriteOnly): Display information of the operation for hu locale. +* **it**: [LocalizedOperationDisplayDefinitionIt](#localizedoperationdisplaydefinitionit) (WriteOnly): Display information of the operation for it locale. +* **ja**: [LocalizedOperationDisplayDefinitionJa](#localizedoperationdisplaydefinitionja) (WriteOnly): Display information of the operation for ja locale. +* **ko**: [LocalizedOperationDisplayDefinitionKo](#localizedoperationdisplaydefinitionko) (WriteOnly): Display information of the operation for ko locale. +* **nl**: [LocalizedOperationDisplayDefinitionNl](#localizedoperationdisplaydefinitionnl) (WriteOnly): Display information of the operation for nl locale. +* **pl**: [LocalizedOperationDisplayDefinitionPl](#localizedoperationdisplaydefinitionpl) (WriteOnly): Display information of the operation for pl locale. +* **ptBR**: [LocalizedOperationDisplayDefinitionPtBR](#localizedoperationdisplaydefinitionptbr) (WriteOnly): Display information of the operation for pt-BR locale. +* **ptPT**: [LocalizedOperationDisplayDefinitionPt](#localizedoperationdisplaydefinitionpt) (WriteOnly): Display information of the operation for pt-PT locale. +* **ru**: [LocalizedOperationDisplayDefinitionRu](#localizedoperationdisplaydefinitionru) (WriteOnly): Display information of the operation for ru locale. +* **sv**: [LocalizedOperationDisplayDefinitionSv](#localizedoperationdisplaydefinitionsv) (WriteOnly): Display information of the operation for sv locale. +* **zhHans**: [LocalizedOperationDisplayDefinitionZhHans](#localizedoperationdisplaydefinitionzhhans) (WriteOnly): Display information of the operation for zh-Hans locale. +* **zhHant**: [LocalizedOperationDisplayDefinitionZhHant](#localizedoperationdisplaydefinitionzhhant) (WriteOnly): Display information of the operation for zh-Hant locale. -## ResourceTypeRegistrationPropertiesManagement +## LocalizedOperationDisplayDefinitionCs ### Properties -* **incidentContactEmail**: string -* **incidentRoutingService**: string -* **incidentRoutingTeam**: string -* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem -* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string -* **resourceAccessRoles**: any[]: Array of any -* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem -* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## OpenApiConfiguration +## LocalizedOperationDisplayDefinitionDe ### Properties -* **validation**: [OpenApiValidation](#openapivalidation) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## OpenApiValidation +## LocalizedOperationDisplayDefinitionDefault ### Properties -* **allowNoncompliantCollectionResponse**: bool: Indicates whether a non compliance response is allowed for a LIST call +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesRequestHeaderOptions +## LocalizedOperationDisplayDefinitionEn ### Properties -* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions +## LocalizedOperationDisplayDefinitionEs ### Properties -### Additional Properties -* **Additional Properties Type**: [ResourceConcurrencyControlOption](#resourceconcurrencycontroloption) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceConcurrencyControlOption +## LocalizedOperationDisplayDefinitionFr ### Properties -* **policy**: 'NotSpecified' | 'SynchronizeBeginExtension' | string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesResourceGraphConfiguration +## LocalizedOperationDisplayDefinitionHu ### Properties -* **apiVersion**: string -* **enabled**: bool +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesResourceMovePolicy +## LocalizedOperationDisplayDefinitionIt ### Properties -* **crossResourceGroupMoveEnabled**: bool -* **crossSubscriptionMoveEnabled**: bool -* **validationRequired**: bool +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications +## LocalizedOperationDisplayDefinitionJa ### Properties -* **softDeleteTTL**: string -* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## SubscriptionStateRule +## LocalizedOperationDisplayDefinitionKo ### Properties -* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## SwaggerSpecification +## LocalizedOperationDisplayDefinitionNl ### Properties -* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem -* **swaggerSpecFolderUri**: string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ResourceTypeRegistrationPropertiesTemplateDeploymentOptions +## LocalizedOperationDisplayDefinitionPl ### Properties -* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption -* **preflightSupported**: bool +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ThrottlingRule +## LocalizedOperationDisplayDefinitionPt ### Properties -* **action**: string (Required) -* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric -* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ThrottlingMetric +## LocalizedOperationDisplayDefinitionPtBR ### Properties -* **interval**: string -* **limit**: int (Required) -* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## CustomRolloutPropertiesStatus +## LocalizedOperationDisplayDefinitionRu ### Properties -* **completedRegions**: string[]: Array of CustomRolloutStatusCompletedRegionsItem -* **failedOrSkippedRegions**: [CustomRolloutStatusFailedOrSkippedRegions](#customrolloutstatusfailedorskippedregions): Dictionary of +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## CustomRolloutStatusFailedOrSkippedRegions +## LocalizedOperationDisplayDefinitionSv ### Properties -### Additional Properties -* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## ExtendedErrorInfo +## LocalizedOperationDisplayDefinitionZhHans ### Properties -* **additionalInfo**: [TypedErrorInfo](#typederrorinfo)[]: Array of TypedErrorInfo -* **code**: string -* **details**: [ExtendedErrorInfo](#extendederrorinfo)[]: Array of ExtendedErrorInfo -* **message**: string -* **target**: string +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## TypedErrorInfo +## LocalizedOperationDisplayDefinitionZhHant ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (Required) +* **description**: string (Required, WriteOnly) +* **operation**: string (Required, WriteOnly) +* **provider**: string (Required, WriteOnly) +* **resource**: string (Required, WriteOnly) -## DefaultRolloutProperties +## LoggingRule ### Properties +* **action**: string (Required) +* **detailLevel**: 'Body' | 'None' | string (Required) +* **direction**: 'None' | 'Request' | 'Response' | string (Required) +* **hiddenPropertyPaths**: [LoggingRuleHiddenPropertyPaths](#loggingrulehiddenpropertypaths) + +## LoggingRuleHiddenPropertyPaths +### Properties +* **hiddenPathsOnRequest**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnRequestItem +* **hiddenPathsOnResponse**: string[]: Array of LoggingHiddenPropertyPathHiddenPathsOnResponseItem + +## NotificationEndpoint +### Properties +* **locations**: string[]: Array of NotificationEndpointLocationsItem +* **notificationDestination**: string + +## NotificationRegistrationProperties +### Properties +* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem +* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string +* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint +* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string * **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string -* **specification**: [DefaultRolloutPropertiesSpecification](#defaultrolloutpropertiesspecification) -* **status**: [DefaultRolloutPropertiesStatus](#defaultrolloutpropertiesstatus) -## DefaultRolloutPropertiesSpecification +## OpenApiConfiguration ### Properties -* **canary**: [DefaultRolloutSpecificationCanary](#defaultrolloutspecificationcanary) -* **expeditedRollout**: [DefaultRolloutSpecificationExpeditedRollout](#defaultrolloutspecificationexpeditedrollout) -* **highTraffic**: [DefaultRolloutSpecificationHighTraffic](#defaultrolloutspecificationhightraffic) -* **lowTraffic**: [DefaultRolloutSpecificationLowTraffic](#defaultrolloutspecificationlowtraffic) -* **mediumTraffic**: [DefaultRolloutSpecificationMediumTraffic](#defaultrolloutspecificationmediumtraffic) -* **providerRegistration**: [DefaultRolloutSpecificationProviderRegistration](#defaultrolloutspecificationproviderregistration) -* **resourceTypeRegistrations**: [ResourceTypeRegistration](#resourcetyperegistration)[]: Array of ResourceTypeRegistration -* **restOfTheWorldGroupOne**: [DefaultRolloutSpecificationRestOfTheWorldGroupOne](#defaultrolloutspecificationrestoftheworldgroupone) -* **restOfTheWorldGroupTwo**: [DefaultRolloutSpecificationRestOfTheWorldGroupTwo](#defaultrolloutspecificationrestoftheworldgrouptwo) +* **validation**: [OpenApiValidation](#openapivalidation) -## DefaultRolloutSpecificationCanary +## OpenApiValidation ### Properties -* **regions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationRegionsItem -* **skipRegions**: string[]: Array of CanaryTrafficRegionRolloutConfigurationSkipRegionsItem +* **allowNoncompliantCollectionResponse**: bool: Indicates whether a non compliance response is allowed for a LIST call -## DefaultRolloutSpecificationExpeditedRollout +## OperationsPutContentProperties ### Properties -* **enabled**: bool: Indicates whether expedited rollout is enabled/disabled +* **contents**: [LocalizedOperationDefinition](#localizedoperationdefinition)[] (WriteOnly): Operations content. -## DefaultRolloutSpecificationHighTraffic +## ProviderHubMetadataProviderAuthentication ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem -## DefaultRolloutSpecificationLowTraffic +## ProviderHubMetadataThirdPartyProviderAuthorization ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **authorizations**: [LightHouseAuthorization](#lighthouseauthorization)[]: Array of LightHouseAuthorization +* **managedByTenantId**: string -## DefaultRolloutSpecificationMediumTraffic +## ProviderRegistrationProperties ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **capabilities**: [ResourceProviderCapabilities](#resourceprovidercapabilities)[]: Array of ResourceProviderCapabilities +* **featuresRule**: [ResourceProviderManifestPropertiesFeaturesRule](#resourceprovidermanifestpropertiesfeaturesrule) +* **management**: [ResourceProviderManifestPropertiesManagement](#resourceprovidermanifestpropertiesmanagement) +* **metadata**: any: Anything +* **namespace**: string +* **providerAuthentication**: [ResourceProviderManifestPropertiesProviderAuthentication](#resourceprovidermanifestpropertiesproviderauthentication) +* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization +* **providerHubMetadata**: [ProviderRegistrationPropertiesProviderHubMetadata](#providerregistrationpropertiesproviderhubmetadata) +* **providerType**: 'AuthorizationFree' | 'External' | 'Hidden' | 'Internal' | 'LegacyRegistrationRequired' | 'NotSpecified' | 'RegistrationFree' | 'TenantOnly' | string +* **providerVersion**: string +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **requestHeaderOptions**: [ResourceProviderManifestPropertiesRequestHeaderOptions](#resourceprovidermanifestpropertiesrequestheaderoptions) +* **requiredFeatures**: string[]: Array of ResourceProviderManifestPropertiesRequiredFeaturesItem +* **subscriptionLifecycleNotificationSpecifications**: [ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#providerregistrationpropertiessubscriptionlifecyclenotificationspecifications) +* **templateDeploymentOptions**: [ResourceProviderManifestPropertiesTemplateDeploymentOptions](#resourceprovidermanifestpropertiestemplatedeploymentoptions) -## DefaultRolloutSpecificationProviderRegistration +## ProviderRegistrationPropertiesProviderHubMetadata ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [ProviderRegistrationProperties](#providerregistrationproperties) -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **providerAuthentication**: [ProviderHubMetadataProviderAuthentication](#providerhubmetadataproviderauthentication) +* **providerAuthorizations**: [ResourceProviderAuthorization](#resourceproviderauthorization)[]: Array of ResourceProviderAuthorization +* **thirdPartyProviderAuthorization**: [ProviderHubMetadataThirdPartyProviderAuthorization](#providerhubmetadatathirdpartyproviderauthorization) -## DefaultRolloutSpecificationRestOfTheWorldGroupOne +## ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **softDeleteTTL**: string +* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction -## DefaultRolloutSpecificationRestOfTheWorldGroupTwo +## ResourceConcurrencyControlOption ### Properties -* **regions**: string[]: Array of TrafficRegionsItem -* **waitDuration**: string +* **policy**: 'NotSpecified' | 'SynchronizeBeginExtension' | string -## DefaultRolloutPropertiesStatus +## ResourceProviderAuthorization ### Properties -* **completedRegions**: string[]: Array of RolloutStatusBaseCompletedRegionsItem -* **failedOrSkippedRegions**: [RolloutStatusBaseFailedOrSkippedRegions](#rolloutstatusbasefailedorskippedregions): Dictionary of -* **nextTrafficRegion**: 'Canary' | 'HighTraffic' | 'LowTraffic' | 'MediumTraffic' | 'None' | 'NotSpecified' | 'RestOfTheWorldGroupOne' | 'RestOfTheWorldGroupTwo' | string -* **nextTrafficRegionScheduledTime**: string -* **subscriptionReregistrationResult**: 'ConditionalUpdate' | 'Failed' | 'ForcedUpdate' | 'NotApplicable' | string +* **applicationId**: string +* **managedByRoleDefinitionId**: string +* **roleDefinitionId**: string -## RolloutStatusBaseFailedOrSkippedRegions +## ResourceProviderCapabilities ### Properties -### Additional Properties -* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) +* **effect**: 'Allow' | 'Disallow' | 'NotSpecified' | string (Required) +* **quotaId**: string (Required) +* **requiredFeatures**: string[]: Array of ResourceProviderCapabilitiesRequiredFeaturesItem -## NotificationRegistrationProperties +## ResourceProviderManifestPropertiesFeaturesRule ### Properties -* **includedEvents**: string[]: Array of NotificationRegistrationPropertiesIncludedEventsItem -* **messageScope**: 'NotSpecified' | 'RegisteredSubscriptions' | string -* **notificationEndpoints**: [NotificationEndpoint](#notificationendpoint)[]: Array of NotificationEndpoint -* **notificationMode**: 'EventHub' | 'NotSpecified' | 'WebHook' | string -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## NotificationEndpoint +## ResourceProviderManifestPropertiesManagement ### Properties -* **locations**: string[]: Array of NotificationEndpointLocationsItem -* **notificationDestination**: string +* **incidentContactEmail**: string +* **incidentRoutingService**: string +* **incidentRoutingTeam**: string +* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem +* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string +* **resourceAccessRoles**: any[]: Array of any +* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -## OperationsPutContentProperties +## ResourceProviderManifestPropertiesProviderAuthentication ### Properties -* **contents**: [LocalizedOperationDefinition](#localizedoperationdefinition)[] (WriteOnly): Operations content. +* **allowedAudiences**: string[] (Required): Array of ResourceProviderAuthenticationAllowedAudiencesItem -## LocalizedOperationDefinition +## ResourceProviderManifestPropertiesRequestHeaderOptions ### Properties -* **actionType**: 'Internal' | 'NotSpecified' | string (WriteOnly) -* **display**: [LocalizedOperationDefinitionDisplay](#localizedoperationdefinitiondisplay) (Required, WriteOnly): Display information of the operation. -* **isDataAction**: bool (WriteOnly): Indicates whether the operation applies to data-plane. -* **name**: string (Required, WriteOnly): Name of the operation. -* **origin**: 'NotSpecified' | 'System' | 'User' | string (WriteOnly) -* **properties**: any (WriteOnly): Anything +* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string -## LocalizedOperationDefinitionDisplay +## ResourceProviderManifestPropertiesTemplateDeploymentOptions ### Properties -* **cs**: [LocalizedOperationDisplayDefinitionCs](#localizedoperationdisplaydefinitioncs) (WriteOnly): Display information of the operation for cs locale. -* **de**: [LocalizedOperationDisplayDefinitionDe](#localizedoperationdisplaydefinitionde) (WriteOnly): Display information of the operation for de locale. -* **default**: [LocalizedOperationDisplayDefinitionDefault](#localizedoperationdisplaydefinitiondefault) (Required, WriteOnly): Display information of the operation. -* **en**: [LocalizedOperationDisplayDefinitionEn](#localizedoperationdisplaydefinitionen) (WriteOnly): Display information of the operation for en locale. -* **es**: [LocalizedOperationDisplayDefinitionEs](#localizedoperationdisplaydefinitiones) (WriteOnly): Display information of the operation for es locale. -* **fr**: [LocalizedOperationDisplayDefinitionFr](#localizedoperationdisplaydefinitionfr) (WriteOnly): Display information of the operation for fr locale. -* **hu**: [LocalizedOperationDisplayDefinitionHu](#localizedoperationdisplaydefinitionhu) (WriteOnly): Display information of the operation for hu locale. -* **it**: [LocalizedOperationDisplayDefinitionIt](#localizedoperationdisplaydefinitionit) (WriteOnly): Display information of the operation for it locale. -* **ja**: [LocalizedOperationDisplayDefinitionJa](#localizedoperationdisplaydefinitionja) (WriteOnly): Display information of the operation for ja locale. -* **ko**: [LocalizedOperationDisplayDefinitionKo](#localizedoperationdisplaydefinitionko) (WriteOnly): Display information of the operation for ko locale. -* **nl**: [LocalizedOperationDisplayDefinitionNl](#localizedoperationdisplaydefinitionnl) (WriteOnly): Display information of the operation for nl locale. -* **pl**: [LocalizedOperationDisplayDefinitionPl](#localizedoperationdisplaydefinitionpl) (WriteOnly): Display information of the operation for pl locale. -* **ptBR**: [LocalizedOperationDisplayDefinitionPtBR](#localizedoperationdisplaydefinitionptbr) (WriteOnly): Display information of the operation for pt-BR locale. -* **ptPT**: [LocalizedOperationDisplayDefinitionPt](#localizedoperationdisplaydefinitionpt) (WriteOnly): Display information of the operation for pt-PT locale. -* **ru**: [LocalizedOperationDisplayDefinitionRu](#localizedoperationdisplaydefinitionru) (WriteOnly): Display information of the operation for ru locale. -* **sv**: [LocalizedOperationDisplayDefinitionSv](#localizedoperationdisplaydefinitionsv) (WriteOnly): Display information of the operation for sv locale. -* **zhHans**: [LocalizedOperationDisplayDefinitionZhHans](#localizedoperationdisplaydefinitionzhhans) (WriteOnly): Display information of the operation for zh-Hans locale. -* **zhHant**: [LocalizedOperationDisplayDefinitionZhHant](#localizedoperationdisplaydefinitionzhhant) (WriteOnly): Display information of the operation for zh-Hant locale. +* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption +* **preflightSupported**: bool + +## ResourceTypeEndpoint +### Properties +* **apiVersions**: string[]: Array of ResourceTypeEndpointApiVersionsItem +* **enabled**: bool +* **endpointType**: 'Canary' | 'NotSpecified' | 'Production' | 'TestInProduction' | string +* **extensions**: [ResourceTypeExtension](#resourcetypeextension)[]: Array of ResourceTypeExtension +* **featuresRule**: [ResourceTypeEndpointFeaturesRule](#resourcetypeendpointfeaturesrule) +* **locations**: string[]: Array of ResourceTypeEndpointLocationsItem +* **requiredFeatures**: string[]: Array of ResourceTypeEndpointRequiredFeaturesItem +* **timeout**: string + +## ResourceTypeEndpointFeaturesRule +### Properties +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## LocalizedOperationDisplayDefinitionCs +## ResourceTypeExtension ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **endpointUri**: string +* **extensionCategories**: 'NotSpecified' | 'ResourceCreationBegin' | 'ResourceCreationCompleted' | 'ResourceCreationValidate' | 'ResourceDeletionBegin' | 'ResourceDeletionCompleted' | 'ResourceDeletionValidate' | 'ResourceMoveBegin' | 'ResourceMoveCompleted' | 'ResourcePatchBegin' | 'ResourcePatchCompleted' | 'ResourcePatchValidate' | 'ResourcePostAction' | 'ResourceReadBegin' | 'ResourceReadValidate' | 'SubscriptionLifecycleNotification' | string[]: Array of ExtensionCategory +* **timeout**: string -## LocalizedOperationDisplayDefinitionDe +## ResourceTypeExtensionOptionsResourceCreationBegin ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **request**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType +* **response**: 'DoNotMergeExistingReadOnlyAndSecretProperties' | 'IncludeInternalMetadata' | 'NotSpecified' | string[]: Array of ExtensionOptionType -## LocalizedOperationDisplayDefinitionDefault +## ResourceTypeRegistration ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [ResourceTypeRegistrationProperties](#resourcetyperegistrationproperties) +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## LocalizedOperationDisplayDefinitionEn +## ResourceTypeRegistrationProperties ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **allowedUnauthorizedActions**: string[]: Array of ResourceTypeRegistrationPropertiesAllowedUnauthorizedActionsItem +* **authorizationActionMappings**: [AuthorizationActionMapping](#authorizationactionmapping)[]: Array of AuthorizationActionMapping +* **checkNameAvailabilitySpecifications**: [ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications](#resourcetyperegistrationpropertieschecknameavailabilityspecifications) +* **defaultApiVersion**: string +* **disallowedActionVerbs**: string[]: Array of ResourceTypeRegistrationPropertiesDisallowedActionVerbsItem +* **enableAsyncOperation**: bool +* **enableThirdPartyS2S**: bool +* **endpoints**: [ResourceTypeEndpoint](#resourcetypeendpoint)[]: Array of ResourceTypeEndpoint +* **extendedLocations**: [ExtendedLocationOptions](#extendedlocationoptions)[]: Array of ExtendedLocationOptions +* **extensionOptions**: [ResourceTypeRegistrationPropertiesExtensionOptions](#resourcetyperegistrationpropertiesextensionoptions) +* **featuresRule**: [ResourceTypeRegistrationPropertiesFeaturesRule](#resourcetyperegistrationpropertiesfeaturesrule) +* **identityManagement**: [ResourceTypeRegistrationPropertiesIdentityManagement](#resourcetyperegistrationpropertiesidentitymanagement) +* **isPureProxy**: bool +* **linkedAccessChecks**: [LinkedAccessCheck](#linkedaccesscheck)[]: Array of LinkedAccessCheck +* **loggingRules**: [LoggingRule](#loggingrule)[]: Array of LoggingRule +* **management**: [ResourceTypeRegistrationPropertiesManagement](#resourcetyperegistrationpropertiesmanagement) +* **marketplaceType**: 'AddOn' | 'Bypass' | 'NotSpecified' | 'Store' | string +* **openApiConfiguration**: [OpenApiConfiguration](#openapiconfiguration) +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'MovingResources' | 'NotSpecified' | 'RolloutInProgress' | 'Running' | 'Succeeded' | 'TransientFailure' | string +* **regionality**: 'Global' | 'NotSpecified' | 'Regional' | string +* **requestHeaderOptions**: [ResourceTypeRegistrationPropertiesRequestHeaderOptions](#resourcetyperegistrationpropertiesrequestheaderoptions) +* **requiredFeatures**: string[]: Array of ResourceTypeRegistrationPropertiesRequiredFeaturesItem +* **resourceConcurrencyControlOptions**: [ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions](#resourcetyperegistrationpropertiesresourceconcurrencycontroloptions): Dictionary of +* **resourceDeletionPolicy**: 'CascadeDeleteAll' | 'CascadeDeleteProxyOnlyChildren' | 'NotSpecified' | string +* **resourceGraphConfiguration**: [ResourceTypeRegistrationPropertiesResourceGraphConfiguration](#resourcetyperegistrationpropertiesresourcegraphconfiguration) +* **resourceMovePolicy**: [ResourceTypeRegistrationPropertiesResourceMovePolicy](#resourcetyperegistrationpropertiesresourcemovepolicy) +* **routingType**: 'CascadeExtension' | 'Default' | 'Extension' | 'Failover' | 'Fanout' | 'HostBased' | 'LocationBased' | 'ProxyOnly' | 'Tenant' | string +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo +* **subscriptionLifecycleNotificationSpecifications**: [ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications](#resourcetyperegistrationpropertiessubscriptionlifecyclenotificationspecifications) +* **subscriptionStateRules**: [SubscriptionStateRule](#subscriptionstaterule)[]: Array of SubscriptionStateRule +* **swaggerSpecifications**: [SwaggerSpecification](#swaggerspecification)[]: Array of SwaggerSpecification +* **templateDeploymentOptions**: [ResourceTypeRegistrationPropertiesTemplateDeploymentOptions](#resourcetyperegistrationpropertiestemplatedeploymentoptions) +* **throttlingRules**: [ThrottlingRule](#throttlingrule)[]: Array of ThrottlingRule -## LocalizedOperationDisplayDefinitionEs +## ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **enableDefaultValidation**: bool +* **resourceTypesWithCustomValidation**: string[]: Array of CheckNameAvailabilitySpecificationsResourceTypesWithCustomValidationItem -## LocalizedOperationDisplayDefinitionFr +## ResourceTypeRegistrationPropertiesExtensionOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **resourceCreationBegin**: [ResourceTypeExtensionOptionsResourceCreationBegin](#resourcetypeextensionoptionsresourcecreationbegin) -## LocalizedOperationDisplayDefinitionHu +## ResourceTypeRegistrationPropertiesFeaturesRule ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **requiredFeaturesPolicy**: 'All' | 'Any' | string (Required) -## LocalizedOperationDisplayDefinitionIt +## ResourceTypeRegistrationPropertiesIdentityManagement ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **applicationId**: string +* **type**: 'Actor' | 'DelegatedResourceIdentity' | 'NotSpecified' | 'SystemAssigned' | 'UserAssigned' | string -## LocalizedOperationDisplayDefinitionJa +## ResourceTypeRegistrationPropertiesManagement ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **incidentContactEmail**: string +* **incidentRoutingService**: string +* **incidentRoutingTeam**: string +* **manifestOwners**: string[]: Array of ResourceProviderManagementManifestOwnersItem +* **resourceAccessPolicy**: 'AcisActionAllowed' | 'AcisReadAllowed' | 'NotSpecified' | string +* **resourceAccessRoles**: any[]: Array of any +* **schemaOwners**: string[]: Array of ResourceProviderManagementSchemaOwnersItem +* **serviceTreeInfos**: [ServiceTreeInfo](#servicetreeinfo)[]: Array of ServiceTreeInfo -## LocalizedOperationDisplayDefinitionKo +## ResourceTypeRegistrationPropertiesRequestHeaderOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **optInHeaders**: 'ClientGroupMembership' | 'NotSpecified' | 'SignedAuxiliaryTokens' | 'SignedUserToken' | 'UnboundedClientGroupMembership' | string -## LocalizedOperationDisplayDefinitionNl +## ResourceTypeRegistrationPropertiesResourceConcurrencyControlOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +### Additional Properties +* **Additional Properties Type**: [ResourceConcurrencyControlOption](#resourceconcurrencycontroloption) -## LocalizedOperationDisplayDefinitionPl +## ResourceTypeRegistrationPropertiesResourceGraphConfiguration ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **apiVersion**: string +* **enabled**: bool -## LocalizedOperationDisplayDefinitionPtBR +## ResourceTypeRegistrationPropertiesResourceMovePolicy ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **crossResourceGroupMoveEnabled**: bool +* **crossSubscriptionMoveEnabled**: bool +* **validationRequired**: bool -## LocalizedOperationDisplayDefinitionPt +## ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **softDeleteTTL**: string +* **subscriptionStateOverrideActions**: [SubscriptionStateOverrideAction](#subscriptionstateoverrideaction)[]: Array of SubscriptionStateOverrideAction -## LocalizedOperationDisplayDefinitionRu +## ResourceTypeRegistrationPropertiesTemplateDeploymentOptions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **preflightOptions**: 'ContinueDeploymentOnFailure' | 'DefaultValidationOnly' | 'None' | string[]: Array of PreflightOption +* **preflightSupported**: bool -## LocalizedOperationDisplayDefinitionSv +## RolloutStatusBaseFailedOrSkippedRegions ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +### Additional Properties +* **Additional Properties Type**: [ExtendedErrorInfo](#extendederrorinfo) -## LocalizedOperationDisplayDefinitionZhHans +## ServiceTreeInfo ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **componentId**: string +* **readiness**: 'ClosingDown' | 'Deprecated' | 'GA' | 'InDevelopment' | 'InternalOnly' | 'PrivatePreview' | 'PublicPreview' | 'RemovedFromARM' | 'Retired' | string +* **serviceId**: string -## LocalizedOperationDisplayDefinitionZhHant +## SkuCapability ### Properties -* **description**: string (Required, WriteOnly) -* **operation**: string (Required, WriteOnly) -* **provider**: string (Required, WriteOnly) -* **resource**: string (Required, WriteOnly) +* **name**: string (Required) +* **value**: string (Required) + +## SkuCost +### Properties +* **extendedUnit**: string +* **meterId**: string (Required) +* **quantity**: int + +## SkuLocationInfo +### Properties +* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem +* **location**: string (Required) +* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string +* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail +* **zones**: string[]: Array of SkuLocationInfoZonesItem ## SkuResourceProperties ### Properties @@ -708,11 +686,6 @@ * **size**: string * **tier**: string -## SkuCapability -### Properties -* **name**: string (Required) -* **value**: string (Required) - ## SkuSettingCapacity ### Properties * **default**: int @@ -720,22 +693,49 @@ * **minimum**: int (Required) * **scaleType**: 'Automatic' | 'Manual' | 'None' | string -## SkuCost +## SkuZoneDetail ### Properties -* **extendedUnit**: string -* **meterId**: string (Required) -* **quantity**: int +* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability +* **name**: string[]: Array of SkuZoneDetailNameItem -## SkuLocationInfo +## SubscriptionStateOverrideAction ### Properties -* **extendedLocations**: string[]: Array of SkuLocationInfoExtendedLocationsItem -* **location**: string (Required) -* **type**: 'ArcZone' | 'EdgeZone' | 'NotSpecified' | string -* **zoneDetails**: [SkuZoneDetail](#skuzonedetail)[]: Array of SkuZoneDetail -* **zones**: string[]: Array of SkuLocationInfoZonesItem +* **action**: 'BillingCancellation' | 'DeleteAllResources' | 'NoOp' | 'NotDefined' | 'SoftDeleteAllResources' | 'UndoSoftDelete' | string (Required) +* **state**: 'Deleted' | 'Registered' | 'Suspended' | 'SuspendedToDeleted' | 'SuspendedToRegistered' | 'SuspendedToUnregistered' | 'SuspendedToWarned' | 'Unregistered' | 'Warned' | 'WarnedToDeleted' | 'WarnedToRegistered' | 'WarnedToSuspended' | 'WarnedToUnregistered' | string (Required) -## SkuZoneDetail +## SubscriptionStateRule ### Properties -* **capabilities**: [SkuCapability](#skucapability)[]: Array of SkuCapability -* **name**: string[]: Array of SkuZoneDetailNameItem +* **allowedActions**: string[]: Array of SubscriptionStateRuleAllowedActionsItem +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'NotDefined' | 'PastDue' | 'Warned' | string + +## SwaggerSpecification +### Properties +* **apiVersions**: string[]: Array of SwaggerSpecificationApiVersionsItem +* **swaggerSpecFolderUri**: string + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## ThrottlingMetric +### Properties +* **interval**: string +* **limit**: int (Required) +* **type**: 'NotSpecified' | 'NumberOfRequests' | 'NumberOfResources' | string (Required) + +## ThrottlingRule +### Properties +* **action**: string (Required) +* **metrics**: [ThrottlingMetric](#throttlingmetric)[] (Required): Array of ThrottlingMetric +* **requiredFeatures**: string[]: Array of ThrottlingRuleRequiredFeaturesItem + +## TypedErrorInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (Required) diff --git a/generated/purview/log.out b/generated/purview/log.out index fdca9d653a..f05f714794 100644 --- a/generated/purview/log.out +++ b/generated/purview/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.purview-2020-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Account-sku' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/purview/resource-manager/Microsoft.Purview/preview/2020-12-01-preview/purview.json:972:9 @@ -24,12 +24,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorResponseModel-error' wit - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/purview/resource-manager/Microsoft.Purview/preview/2020-12-01-preview/purview.json:1329:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'AccountSku' -> 'AccountSkuAutoGenerated' -info | autorest.bicep took 12ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.purview-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Account-sku' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json:1021:9 @@ -43,5 +43,5 @@ warning | PreCheck/SchemaMissingType | The schema 'TrackedResource-systemData' w - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json:1914:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'AccountSku' -> 'AccountSkuAutoGenerated' -info | autorest.bicep took 3ms -info | Autorest completed in 7.44s. 4 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 7.25s. 4 files generated. diff --git a/generated/purview/microsoft.purview/2020-12-01-preview/types.md b/generated/purview/microsoft.purview/2020-12-01-preview/types.md index 71cb87a969..cb65f02e3f 100644 --- a/generated/purview/microsoft.purview/2020-12-01-preview/types.md +++ b/generated/purview/microsoft.purview/2020-12-01-preview/types.md @@ -27,11 +27,10 @@ * **ApiVersion**: 2020-12-01-preview * **Output**: [AccessKeys](#accesskeys) -## Identity +## AccessKeys ### Properties -* **principalId**: string (ReadOnly): Service principal object Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'SystemAssigned' | string: Identity Type +* **atlasKafkaPrimaryEndpoint**: string (ReadOnly): Gets or sets the primary connection string. +* **atlasKafkaSecondaryEndpoint**: string (ReadOnly): Gets or sets the secondary connection string. ## AccountProperties ### Properties @@ -48,11 +47,6 @@ * **publicNetworkAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: Gets or sets the public network access. * **systemData**: [AccountPropertiesSystemData](#accountpropertiessystemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -## CloudConnectors -### Properties -* **awsExternalId**: string (ReadOnly): AWS external identifier. -Configured in AWS to allow use of the role arn used for scanning - ## AccountPropertiesEndpoints ### Properties * **catalog**: string (ReadOnly): Gets the catalog endpoint. @@ -65,6 +59,35 @@ Configured in AWS to allow use of the role arn used for scanning * **resourceGroup**: string (ReadOnly): Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. * **storageAccount**: string (ReadOnly): Gets the managed storage account resource identifier. +## AccountPropertiesSystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of the last modification the resource (UTC). +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that last modified the resource. + +## AccountSku +### Properties +* **capacity**: int: Gets or sets the sku capacity. +* **name**: 'Standard' | string: Gets or sets the sku name. + +## CloudConnectors +### Properties +* **awsExternalId**: string (ReadOnly): AWS external identifier. +Configured in AWS to allow use of the role arn used for scanning + +## Identity +### Properties +* **principalId**: string (ReadOnly): Service principal object Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'SystemAssigned' | string: Identity Type + +## PrivateEndpoint +### Properties +* **id**: string: The private endpoint identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Gets or sets the identifier. @@ -78,37 +101,14 @@ Configured in AWS to allow use of the role arn used for scanning * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The private link service connection state. * **provisioningState**: string (ReadOnly): The provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: The private endpoint identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: The required actions. * **description**: string: The description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Unknown' | string: The status. -## AccountPropertiesSystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of the last modification the resource (UTC). -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that last modified the resource. - -## AccountSku -### Properties -* **capacity**: int: Gets or sets the sku capacity. -* **name**: 'Standard' | string: Gets or sets the sku name. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AccessKeys -### Properties -* **atlasKafkaPrimaryEndpoint**: string (ReadOnly): Gets or sets the primary connection string. -* **atlasKafkaSecondaryEndpoint**: string (ReadOnly): Gets or sets the secondary connection string. - diff --git a/generated/purview/microsoft.purview/2021-07-01/types.md b/generated/purview/microsoft.purview/2021-07-01/types.md index 647abedf1c..8d1cb6b8c8 100644 --- a/generated/purview/microsoft.purview/2021-07-01/types.md +++ b/generated/purview/microsoft.purview/2021-07-01/types.md @@ -28,22 +28,10 @@ * **ApiVersion**: 2021-07-01 * **Output**: [AccessKeys](#accesskeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): Service principal object Id -* **tenantId**: string (ReadOnly): Tenant Id -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity Type -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): User Assigned Identities - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccessKeys ### Properties -* **clientId**: string (ReadOnly): Gets or Sets Client ID -* **principalId**: string (ReadOnly): Gets or Sets Principal ID +* **atlasKafkaPrimaryEndpoint**: string (ReadOnly): Gets or sets the primary connection string. +* **atlasKafkaSecondaryEndpoint**: string (ReadOnly): Gets or sets the secondary connection string. ## AccountProperties ### Properties @@ -59,11 +47,6 @@ * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'SoftDeleted' | 'SoftDeleting' | 'Succeeded' | 'Unknown' | string (ReadOnly): Gets or sets the state of the provisioning. * **publicNetworkAccess**: 'Disabled' | 'Enabled' | 'NotSpecified' | string: Gets or sets the public network access. -## CloudConnectors -### Properties -* **awsExternalId**: string (ReadOnly): AWS external identifier. -Configured in AWS to allow use of the role arn used for scanning - ## AccountPropertiesEndpoints ### Properties * **catalog**: string (ReadOnly): Gets the catalog endpoint. @@ -76,6 +59,32 @@ Configured in AWS to allow use of the role arn used for scanning * **resourceGroup**: string (ReadOnly): Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. * **storageAccount**: string (ReadOnly): Gets the managed storage account resource identifier. +## AccountSku +### Properties +* **capacity**: int: Gets or sets the sku capacity. +* **name**: 'Standard' | string: Gets or sets the sku name. + +## CloudConnectors +### Properties +* **awsExternalId**: string (ReadOnly): AWS external identifier. +Configured in AWS to allow use of the role arn used for scanning + +## Identity +### Properties +* **principalId**: string (ReadOnly): Service principal object Id +* **tenantId**: string (ReadOnly): Tenant Id +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Identity Type +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): User Assigned Identities + +## IdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## PrivateEndpoint +### Properties +* **id**: string: The private endpoint identifier. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Gets or sets the identifier. @@ -89,21 +98,12 @@ Configured in AWS to allow use of the role arn used for scanning * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): The private link service connection state. * **provisioningState**: string (ReadOnly): The provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: The private endpoint identifier. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: The required actions. * **description**: string: The description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Unknown' | string: The status. -## AccountSku -### Properties -* **capacity**: int: Gets or sets the sku capacity. -* **name**: 'Standard' | string: Gets or sets the sku name. - ## TrackedResourceSystemData ### Properties * **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). @@ -118,8 +118,8 @@ Configured in AWS to allow use of the role arn used for scanning ### Additional Properties * **Additional Properties Type**: string -## AccessKeys +## UserAssignedIdentity ### Properties -* **atlasKafkaPrimaryEndpoint**: string (ReadOnly): Gets or sets the primary connection string. -* **atlasKafkaSecondaryEndpoint**: string (ReadOnly): Gets or sets the secondary connection string. +* **clientId**: string (ReadOnly): Gets or Sets Client ID +* **principalId**: string (ReadOnly): Gets or Sets Principal ID diff --git a/generated/quantum/log.out b/generated/quantum/log.out index 4de294e16c..81c174d626 100644 --- a/generated/quantum/log.out +++ b/generated/quantum/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.quantum-2019-11-04-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WorkspaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/quantum/resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json:413:5 @@ -23,12 +23,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkspaceResourceProperties' warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/quantum/resource-manager/Microsoft.Quantum/preview/2019-11-04-preview/quantum.json:854:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.quantum-2022-01-10-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'WorkspaceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/quantum/resource-manager/Microsoft.Quantum/preview/2022-01-10-preview/quantum.json:418:5 @@ -41,5 +41,5 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkspaceResourceProperties' warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/quantum/resource-manager/Microsoft.Quantum/preview/2022-01-10-preview/quantum.json:861:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms -info | Autorest completed in 6.68s. 4 files generated. +info | autorest.bicep took 3ms +info | Autorest completed in 6.39s. 4 files generated. diff --git a/generated/quantum/microsoft.quantum/2019-11-04-preview/types.md b/generated/quantum/microsoft.quantum/2019-11-04-preview/types.md index 3b8244c628..8ceccd311f 100644 --- a/generated/quantum/microsoft.quantum/2019-11-04-preview/types.md +++ b/generated/quantum/microsoft.quantum/2019-11-04-preview/types.md @@ -13,20 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Quantum/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## QuantumWorkspaceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. - -## WorkspaceResourceProperties -### Properties -* **endpointUri**: string (ReadOnly): The URI of the workspace endpoint. -* **providers**: [Provider](#provider)[]: List of Providers selected for this Workspace -* **provisioningState**: 'Failed' | 'ProviderDeleting' | 'ProviderLaunching' | 'ProviderProvisioning' | 'ProviderUpdating' | 'Succeeded' | string (ReadOnly): Provisioning status field -* **storageAccount**: string: ARM Resource Id of the storage account associated with this workspace. -* **usable**: 'No' | 'Partial' | 'Yes' | string (ReadOnly): Whether the current workspace is ready to accept Jobs. - ## Provider ### Properties * **applicationName**: string: The provider's marketplace application display name. @@ -36,6 +22,12 @@ * **provisioningState**: 'Deleted' | 'Deleting' | 'Failed' | 'Launching' | 'Succeeded' | 'Updating' | string: Provisioning status field * **resourceUsageId**: string: Id to track resource usage for the provider. +## QuantumWorkspaceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -50,3 +42,11 @@ ### Additional Properties * **Additional Properties Type**: string +## WorkspaceResourceProperties +### Properties +* **endpointUri**: string (ReadOnly): The URI of the workspace endpoint. +* **providers**: [Provider](#provider)[]: List of Providers selected for this Workspace +* **provisioningState**: 'Failed' | 'ProviderDeleting' | 'ProviderLaunching' | 'ProviderProvisioning' | 'ProviderUpdating' | 'Succeeded' | string (ReadOnly): Provisioning status field +* **storageAccount**: string: ARM Resource Id of the storage account associated with this workspace. +* **usable**: 'No' | 'Partial' | 'Yes' | string (ReadOnly): Whether the current workspace is ready to accept Jobs. + diff --git a/generated/quantum/microsoft.quantum/2022-01-10-preview/types.md b/generated/quantum/microsoft.quantum/2022-01-10-preview/types.md index a13af688ab..7534a39308 100644 --- a/generated/quantum/microsoft.quantum/2022-01-10-preview/types.md +++ b/generated/quantum/microsoft.quantum/2022-01-10-preview/types.md @@ -13,20 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Quantum/workspaces' (ReadOnly, DeployTimeConstant): The resource type -## QuantumWorkspaceIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. - -## WorkspaceResourceProperties -### Properties -* **endpointUri**: string (ReadOnly): The URI of the workspace endpoint. -* **providers**: [Provider](#provider)[]: List of Providers selected for this Workspace -* **provisioningState**: 'Failed' | 'ProviderDeleting' | 'ProviderLaunching' | 'ProviderProvisioning' | 'ProviderUpdating' | 'Succeeded' | string (ReadOnly): Provisioning status field -* **storageAccount**: string: ARM Resource Id of the storage account associated with this workspace. -* **usable**: 'No' | 'Partial' | 'Yes' | string (ReadOnly): Whether the current workspace is ready to accept Jobs. - ## Provider ### Properties * **applicationName**: string: The provider's marketplace application display name. @@ -36,6 +22,12 @@ * **provisioningState**: 'Deleted' | 'Deleting' | 'Failed' | 'Launching' | 'Succeeded' | 'Updating' | string: Provisioning status field * **resourceUsageId**: string: Id to track resource usage for the provider. +## QuantumWorkspaceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -50,3 +42,11 @@ ### Additional Properties * **Additional Properties Type**: string +## WorkspaceResourceProperties +### Properties +* **endpointUri**: string (ReadOnly): The URI of the workspace endpoint. +* **providers**: [Provider](#provider)[]: List of Providers selected for this Workspace +* **provisioningState**: 'Failed' | 'ProviderDeleting' | 'ProviderLaunching' | 'ProviderProvisioning' | 'ProviderUpdating' | 'Succeeded' | string (ReadOnly): Provisioning status field +* **storageAccount**: string: ARM Resource Id of the storage account associated with this workspace. +* **usable**: 'No' | 'Partial' | 'Yes' | string (ReadOnly): Whether the current workspace is ready to accept Jobs. + diff --git a/generated/quota/log.out b/generated/quota/log.out index 3b4b51071e..715e06ab7b 100644 --- a/generated/quota/log.out +++ b/generated/quota/log.out @@ -4,21 +4,21 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.quota-2021-03-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.quota-2021-03-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms -info | Autorest completed in 6.8s. 4 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 6.53s. 4 files generated. diff --git a/generated/quota/microsoft.quota/2021-03-15-preview/types.md b/generated/quota/microsoft.quota/2021-03-15-preview/types.md index ffcceeb70c..6057d637d9 100644 --- a/generated/quota/microsoft.quota/2021-03-15-preview/types.md +++ b/generated/quota/microsoft.quota/2021-03-15-preview/types.md @@ -9,6 +9,17 @@ * **properties**: [QuotaProperties](#quotaproperties): Quota properties for the specified resource. * **type**: 'Microsoft.Quota/quotas' (ReadOnly, DeployTimeConstant): The resource type +## LimitJsonObject +* **Discriminator**: limitObjectType + +### Base Properties +### LimitObject +#### Properties +* **limitObjectType**: 'LimitValue' (Required): The limit object type. +* **limitType**: 'Independent' | 'Shared' | string: The quota or usages limit types. +* **value**: int (Required): The quota/limit value + + ## QuotaProperties ### Properties * **isQuotaApplicable**: bool (ReadOnly): States if quota can be requested for this resource. @@ -23,17 +34,6 @@ This parameter is optional because, for some resources like compute, the period * **resourceType**: string: Resource types. For extensibility, it is a string. * **unit**: string (ReadOnly): The quota units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation. -## LimitJsonObject -* **Discriminator**: limitObjectType - -### Base Properties -### LimitObject -#### Properties -* **limitObjectType**: 'LimitValue' (Required): The limit object type. -* **limitType**: 'Independent' | 'Shared' | string: The quota or usages limit types. -* **value**: int (Required): The quota/limit value - - ## ResourceName ### Properties * **localizedValue**: string (ReadOnly): Resource display name. diff --git a/generated/recommendationsservice/log.out b/generated/recommendationsservice/log.out index 419b152dca..3398cd14cf 100644 --- a/generated/recommendationsservice/log.out +++ b/generated/recommendationsservice/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.recommendationsservice-2022-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms -info | Autorest completed in 5.35s. 2 files generated. +info | autorest.bicep took 12ms +info | Autorest completed in 5.09s. 2 files generated. diff --git a/generated/recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.md b/generated/recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.md index 4da1bb3cb4..02d43c0c71 100644 --- a/generated/recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.md +++ b/generated/recommendationsservice/microsoft.recommendationsservice/2022-02-01/types.md @@ -58,19 +58,9 @@ * **principalID**: string: AAD principal ID. * **principalType**: 'Application' | 'User' | string: AAD principal type. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags +## ModelingInputData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string: Connection string to raw input data. ## ModelingResourceProperties ### Properties @@ -80,21 +70,31 @@ * **provisioningState**: string (ReadOnly): The resource provisioning state. * **size**: 'Large' | 'Medium' | 'Small' | string: Modeling size controls the maximum supported input data size. -## ModelingInputData +## ServiceEndpointResourceProperties ### Properties -* **connectionString**: string: Connection string to raw input data. +* **pairedLocation**: string (ReadOnly): The paired location that will be used by this ServiceEndpoint. +* **preAllocatedCapacity**: int: ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity. +* **provisioningState**: string (ReadOnly): The resource provisioning state. +* **url**: string (ReadOnly): The URL where the ServiceEndpoint API is accessible at. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceEndpointResourceProperties +## TrackedResourceTags ### Properties -* **pairedLocation**: string (ReadOnly): The paired location that will be used by this ServiceEndpoint. -* **preAllocatedCapacity**: int: ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity. -* **provisioningState**: string (ReadOnly): The resource provisioning state. -* **url**: string (ReadOnly): The URL where the ServiceEndpoint API is accessible at. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties diff --git a/generated/recoveryservices/log.out b/generated/recoveryservices/log.out index d3be7d68dc..3700a7210c 100644 --- a/generated/recoveryservices/log.out +++ b/generated/recoveryservices/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2022-02-01/vaults.json:1700:5 @@ -16,10 +16,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2022-02-01/vaults.json:1746:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-01-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/preview/2022-01-31-preview/vaults.json:1863:5 @@ -29,10 +29,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/preview/2022-01-31-preview/vaults.json:1909:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2022-01-01/vaults.json:1700:5 @@ -42,10 +42,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2022-01-01/vaults.json:1746:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-12-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-12-01/vaults.json:1686:5 @@ -55,10 +55,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-12-01/vaults.json:1732:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json:1706:5 @@ -68,10 +68,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/preview/2021-11-01-preview/vaults.json:1756:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-08-01/vaults.json:1686:5 @@ -81,10 +81,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-08-01/vaults.json:1732:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-07-01/vaults.json:1686:5 @@ -94,10 +94,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-07-01/vaults.json:1732:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaults.json:1686:5 @@ -107,10 +107,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaults.json:1732:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaults.json:1686:5 @@ -120,10 +120,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaults.json:1732:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-03-01/vaults.json:1605:5 @@ -133,10 +133,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-03-01/vaults.json:1651:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-02-10"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-02-10/vaults.json:1605:5 @@ -149,14 +149,14 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2016-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2020-02-02"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2020-02-02/vaults.json:1545:5 @@ -169,7 +169,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2020-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2020-10-01/vaults.json:1605:5 @@ -179,10 +179,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2020-10-01/vaults.json:1651:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/vaults.json:1605:5 @@ -192,5 +192,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/vaults.json:1651:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 3ms -info | Autorest completed in 40.58s. 30 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 39.15s. 30 files generated. diff --git a/generated/recoveryservices/microsoft.recoveryservices/2016-06-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2016-06-01/types.md index cb822ba380..0aeed6ef25 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2016-06-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2016-06-01/types.md @@ -39,18 +39,9 @@ * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'None' | 'SystemAssigned' | string (Required): The identity type. -## VaultProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## PrivateEndpointConnectionVaultProperties +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. -* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. +* **id**: string (ReadOnly): Gets or sets id. ## PrivateEndpointConnection ### Properties @@ -58,9 +49,10 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. -## PrivateEndpoint +## PrivateEndpointConnectionVaultProperties ### Properties -* **id**: string (ReadOnly): Gets or sets id. +* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. +* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. ## PrivateLinkServiceConnectionState ### Properties @@ -68,17 +60,10 @@ * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -89,10 +74,17 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. ## VaultExtendedInfo ### Properties @@ -101,3 +93,11 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2020-02-02/types.md b/generated/recoveryservices/microsoft.recoveryservices/2020-02-02/types.md index b7a3bd829c..1c411093f7 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2020-02-02/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2020-02-02/types.md @@ -33,6 +33,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -45,39 +54,9 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties -### Properties -* **keyUri**: string: The key uri of the Customer Managed Key - -## PrivateEndpointConnectionVaultProperties +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. -* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. +* **id**: string (ReadOnly): Gets or sets id. ## PrivateEndpointConnection ### Properties @@ -85,9 +64,10 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. -## PrivateEndpoint +## PrivateEndpointConnectionVaultProperties ### Properties -* **id**: string (ReadOnly): Gets or sets id. +* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. +* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. ## PrivateLinkServiceConnectionState ### Properties @@ -95,6 +75,20 @@ * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. +## RawCertificateData +### Properties +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string + +## Sku +### Properties +* **name**: 'RS0' | 'Standard' | string (Required): The Sku name. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## UpgradeDetails ### Properties * **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. @@ -107,19 +101,10 @@ * **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. * **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. -## Sku -### Properties -* **name**: 'RS0' | 'Standard' | string (Required): The Sku name. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RawCertificateData +## UserIdentity ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -128,3 +113,18 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2020-10-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2020-10-01/types.md index a75b433f62..31ceaf991f 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2020-10-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2020-10-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,39 +55,9 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties -### Properties -* **keyUri**: string: The key uri of the Customer Managed Key - -## PrivateEndpointConnectionVaultProperties +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. -* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. +* **id**: string (ReadOnly): Gets or sets id. ## PrivateEndpointConnection ### Properties @@ -86,9 +65,10 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. -## PrivateEndpoint +## PrivateEndpointConnectionVaultProperties ### Properties -* **id**: string (ReadOnly): Gets or sets id. +* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. +* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. ## PrivateLinkServiceConnectionState ### Properties @@ -96,17 +76,10 @@ * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -127,10 +100,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -139,3 +124,18 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-01-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-01-01/types.md index 8eea35598e..b428bc0e3a 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-01-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-01-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,39 +55,9 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties -### Properties -* **keyUri**: string: The key uri of the Customer Managed Key - -## PrivateEndpointConnectionVaultProperties +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. -* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. +* **id**: string (ReadOnly): Gets or sets id. ## PrivateEndpointConnection ### Properties @@ -86,9 +65,10 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. -## PrivateEndpoint +## PrivateEndpointConnectionVaultProperties ### Properties -* **id**: string (ReadOnly): Gets or sets id. +* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. +* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. ## PrivateLinkServiceConnectionState ### Properties @@ -96,17 +76,10 @@ * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -127,10 +100,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -139,3 +124,18 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-02-10/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-02-10/types.md index eb7302be6d..b095f1434e 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-02-10/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-02-10/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,39 +55,9 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties -### Properties -* **keyUri**: string: The key uri of the Customer Managed Key - -## PrivateEndpointConnectionVaultProperties +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. -* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. +* **id**: string (ReadOnly): Gets or sets id. ## PrivateEndpointConnection ### Properties @@ -86,9 +65,10 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. -## PrivateEndpoint +## PrivateEndpointConnectionVaultProperties ### Properties -* **id**: string (ReadOnly): Gets or sets id. +* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. +* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. ## PrivateLinkServiceConnectionState ### Properties @@ -96,17 +76,10 @@ * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -127,10 +100,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -139,3 +124,18 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-03-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-03-01/types.md index be2698a634..9ea016d841 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-03-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-03-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,39 +55,9 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties -### Properties -* **keyUri**: string: The key uri of the Customer Managed Key - -## PrivateEndpointConnectionVaultProperties +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. -* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. +* **id**: string (ReadOnly): Gets or sets id. ## PrivateEndpointConnection ### Properties @@ -86,9 +65,10 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. -## PrivateEndpoint +## PrivateEndpointConnectionVaultProperties ### Properties -* **id**: string (ReadOnly): Gets or sets id. +* **id**: string (ReadOnly): Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. +* **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. ## PrivateLinkServiceConnectionState ### Properties @@ -96,17 +76,10 @@ * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -127,10 +100,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -139,3 +124,18 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-04-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-04-01/types.md index dc62e278af..7e18ff58fa 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-04-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-04-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,44 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -93,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -143,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -155,3 +130,28 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-06-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-06-01/types.md index 4bc087aacd..e92d8536ac 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-06-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-06-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,44 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -93,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -143,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -155,3 +130,28 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-07-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-07-01/types.md index 630040ef4d..1994db8a69 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-07-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-07-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,44 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -93,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -143,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -155,3 +130,28 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-08-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-08-01/types.md index 67b6bca35f..80715c71b3 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-08-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-08-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,44 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -93,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -143,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -155,3 +130,28 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.md index c6ef9a2b7e..806d0c9b39 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-11-01-preview/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,45 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -94,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -144,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -156,3 +130,29 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2021-12-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2021-12-01/types.md index 2579815eb3..5a5f142732 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2021-12-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2021-12-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,44 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -93,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -143,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -155,3 +130,28 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2022-01-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2022-01-01/types.md index 1289876a36..32652d38e6 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2022-01-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2022-01-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,45 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -94,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -144,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -156,3 +130,29 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.md b/generated/recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.md index 9342679d70..752477cee9 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2022-01-31-preview/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,45 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -94,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -144,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -156,3 +130,29 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservices/microsoft.recoveryservices/2022-02-01/types.md b/generated/recoveryservices/microsoft.recoveryservices/2022-02-01/types.md index 8c8442c29d..0947ed61d0 100644 --- a/generated/recoveryservices/microsoft.recoveryservices/2022-02-01/types.md +++ b/generated/recoveryservices/microsoft.recoveryservices/2022-02-01/types.md @@ -34,6 +34,15 @@ * **properties**: [VaultExtendedInfo](#vaultextendedinfo): Vault extended information. * **type**: 'Microsoft.RecoveryServices/vaults/extendedInformation' (ReadOnly, DeployTimeConstant): The resource type +## CmkKekIdentity +### Properties +* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned +* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field + +## CmkKeyVaultProperties +### Properties +* **keyUri**: string: The key uri of the Customer Managed Key + ## IdentityData ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. @@ -46,45 +55,15 @@ ### Additional Properties * **Additional Properties Type**: [UserIdentity](#useridentity) -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. - -## VaultProperties -### Properties -* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version -* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. -* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource -* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation -* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. -* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. -* **provisioningState**: string (ReadOnly): Provisioning State. -* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. - -## VaultPropertiesEncryption -### Properties -* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state -* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK -* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK - -## CmkKekIdentity -### Properties -* **userAssignedIdentity**: string: The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned -* **useSystemAssignedIdentity**: bool: Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field - -## CmkKeyVaultProperties +## PrivateEndpoint ### Properties -* **keyUri**: string: The key uri of the Customer Managed Key +* **id**: string (ReadOnly): Gets or sets id. -## VaultPropertiesMoveDetails +## PrivateEndpointConnection ### Properties -* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation -* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation -* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation -* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation -* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. ## PrivateEndpointConnectionVaultProperties ### Properties @@ -94,33 +73,16 @@ * **properties**: [PrivateEndpointConnection](#privateendpointconnection) (ReadOnly): Private Endpoint Connection Response Properties. * **type**: string (ReadOnly): The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint network resource that is linked to the Private Endpoint connection. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): Gets or sets private link service connection state. -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string (ReadOnly): Gets or sets provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Gets or sets id. - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): Gets or sets actions required. * **description**: string (ReadOnly): Gets or sets description. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (ReadOnly): Gets or sets the status. -## UpgradeDetails +## RawCertificateData ### Properties -* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. -* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. -* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. -* **operationId**: string (ReadOnly): ID of the vault upgrade operation. -* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. -* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. -* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. -* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. -* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. +* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. +* **certificate**: any: The base64 encoded certificate raw data string ## Sku ### Properties @@ -144,10 +106,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RawCertificateData +## UpgradeDetails ### Properties -* **authType**: 'AAD' | 'ACS' | 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid' | string: Specifies the authentication type. -* **certificate**: any: The base64 encoded certificate raw data string +* **endTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has ended. +* **lastUpdatedTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation status was last updated. +* **message**: string (ReadOnly): Message to the user containing information about the upgrade operation. +* **operationId**: string (ReadOnly): ID of the vault upgrade operation. +* **previousResourceId**: string (ReadOnly): Resource ID of the vault before the upgrade. +* **startTimeUtc**: string (ReadOnly): UTC time at which the upgrade operation has started. +* **status**: 'Failed' | 'InProgress' | 'Unknown' | 'Upgraded' | string (ReadOnly): Status of the vault upgrade operation. +* **triggerType**: 'ForcedUpgrade' | 'UserTriggered' | string (ReadOnly): The way the vault upgrade was triggered. +* **upgradedResourceId**: string (ReadOnly): Resource ID of the upgraded vault. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. ## VaultExtendedInfo ### Properties @@ -156,3 +130,29 @@ * **encryptionKeyThumbprint**: string: Encryption key thumbprint. * **integrityKey**: string: Integrity key. +## VaultProperties +### Properties +* **backupStorageVersion**: 'Unassigned' | 'V1' | 'V2' | string (ReadOnly): Backup storage version +* **encryption**: [VaultPropertiesEncryption](#vaultpropertiesencryption): Customer Managed Key details of the resource. +* **moveDetails**: [VaultPropertiesMoveDetails](#vaultpropertiesmovedetails): The details of the latest move operation performed on the Azure Resource +* **moveState**: 'CommitFailed' | 'CommitTimedout' | 'CriticalFailure' | 'Failure' | 'InProgress' | 'MoveSucceeded' | 'PartialSuccess' | 'PrepareFailed' | 'PrepareTimedout' | 'Unknown' | string (ReadOnly): The State of the Resource after the move operation +* **privateEndpointConnections**: [PrivateEndpointConnectionVaultProperties](#privateendpointconnectionvaultproperties)[] (ReadOnly): List of private endpoint connection. +* **privateEndpointStateForBackup**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **privateEndpointStateForSiteRecovery**: 'Enabled' | 'None' | string (ReadOnly): Private endpoint state for backup. +* **provisioningState**: string (ReadOnly): Provisioning State. +* **upgradeDetails**: [UpgradeDetails](#upgradedetails): Details for upgrading vault. + +## VaultPropertiesEncryption +### Properties +* **infrastructureEncryption**: 'Disabled' | 'Enabled' | string: Enabling/Disabling the Double Encryption state +* **kekIdentity**: [CmkKekIdentity](#cmkkekidentity): The details of the identity used for CMK +* **keyVaultProperties**: [CmkKeyVaultProperties](#cmkkeyvaultproperties): The properties of the Key Vault which hosts CMK + +## VaultPropertiesMoveDetails +### Properties +* **completionTimeUtc**: string (ReadOnly): End Time of the Resource Move Operation +* **operationId**: string (ReadOnly): OperationId of the Resource Move Operation +* **sourceResourceId**: string (ReadOnly): Source Resource of the Resource Move Operation +* **startTimeUtc**: string (ReadOnly): Start Time of the Resource Move Operation +* **targetResourceId**: string (ReadOnly): Target Resource of the Resource Move Operation + diff --git a/generated/recoveryservicesbackup/log.out b/generated/recoveryservicesbackup/log.out index 803471f50e..5ca056efe3 100644 --- a/generated/recoveryservicesbackup/log.out +++ b/generated/recoveryservicesbackup/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2022-02-01/bms.json:4610:5 @@ -58,12 +58,12 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'type' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'status' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 info | Resource type microsoft.recoveryservices/vaults/backupresourceguardproxies under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}' has no body defined. -info | autorest.bicep took 63ms +info | autorest.bicep took 22ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2022-01-01/bms.json:4610:5 @@ -111,12 +111,12 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'type' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'status' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 info | Resource type microsoft.recoveryservices/vaults/backupresourceguardproxies under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}' has no body defined. -info | autorest.bicep took 13ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-12-01/bms.json:4610:5 @@ -164,20 +164,20 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'type' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'status' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 info | Resource type microsoft.recoveryservices/vaults/backupresourceguardproxies under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}' has no body defined. -info | autorest.bicep took 15ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-11-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2018-12-20"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'NewErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/bms.json:870:5 @@ -198,12 +198,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ProtectedItemResource' with a warning | PreCheck/SchemaMissingType | The schema 'RecoveryPointResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/bms.json:4131:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-10-01/bms.json:4598:5 @@ -251,12 +251,12 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'type' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 warning | PreCheck/PropertyRedeclarationWarning | Schema 'RecoveryPointTierInformationV2' has a property 'status' that is already declared the parent schema 'RecoveryPointTierInformation' but isn't significantly different. The property has been removed from RecoveryPointTierInformationV2 info | Resource type microsoft.recoveryservices/vaults/backupresourceguardproxies under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}' has no body defined. -info | autorest.bicep took 16ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-08-01/bms.json:4424:5 @@ -307,7 +307,7 @@ info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-07-01" warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-07-01/bms.json:4433:5 @@ -353,12 +353,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResour - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-07-01/bms.json:11639:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.recoveryservices/vaults/backupresourceguardproxies under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}' has no body defined. -info | autorest.bicep took 19ms +info | autorest.bicep took 29ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/bms.json:4015:5 @@ -401,12 +401,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/bms.json:11102:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigExtendedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/bms.json:4138:5 @@ -453,12 +453,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/bms.json:11287:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 13ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-03-01/bms.json:3975:5 @@ -501,12 +501,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-03-01/bms.json:11044:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 14ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-02-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-02-10/bms.json:3975:5 @@ -554,7 +554,7 @@ info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-02-01- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2021-02-01-preview/bms.json:4232:5 @@ -605,7 +605,7 @@ info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-02-01" warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-02-01/bms.json:3975:5 @@ -648,12 +648,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-02-01/bms.json:11040:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 21ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/bms.json:3531:5 @@ -694,12 +694,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-01-01/bms.json:9953:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-12-01/bms.json:3120:5 @@ -736,12 +736,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-12-01/bms.json:9475:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceEncryptionConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-10-01/bms.json:3122:5 @@ -778,12 +778,12 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-10-01/bms.json:9461:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 17ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2020-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'NewErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-07-01/bms.json:239:5 @@ -793,17 +793,17 @@ info | Processing batch task - {"tag":"microsoft.recoveryservices-2020-02-02" warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2020-02-02/bms.json:343:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2019-06-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceVaultConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json:2715:5 @@ -820,12 +820,12 @@ warning | PreCheck/SchemaMissingType | The schema 'RecoveryPointResource' with a warning | PreCheck/SchemaMissingType | The schema 'RestoreRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json:4718:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2019-05-13"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupResourceVaultConfigResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-05-13/bms.json:2644:5 @@ -842,12 +842,12 @@ warning | PreCheck/SchemaMissingType | The schema 'RecoveryPointResource' with a warning | PreCheck/SchemaMissingType | The schema 'RestoreRequestResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-05-13/bms.json:4604:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 7ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2017-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json:1328:5 @@ -859,7 +859,7 @@ info | Processing batch task - {"tag":"microsoft.recoveryservices-2016-06-01" warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json:1960:5 @@ -884,12 +884,12 @@ warning | PreCheck/SchemaMissingType | The schema 'BackupEngineBaseResource' wit warning | PreCheck/SchemaMissingType | The schema 'OperationResultInfoBaseResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json:4423:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 39ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2016-08-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -897,7 +897,7 @@ info | Processing batch task - {"tag":"microsoft.recoveryservices-2016-12-01" warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupEngineBaseResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json:2020:5 @@ -916,5 +916,5 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadItemResource' with an warning | PreCheck/SchemaMissingType | The schema 'WorkloadProtectableItemResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json:3588:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 154.64s. 46 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 145.74s. 46 files generated. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.md index b0e78e22ef..9bcae62642 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-06-01/types.md @@ -24,6 +24,40 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/backupPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: The state of the backup policy associated with this backup item. +* **recoveryPointCount**: int: The number of available backup copies for this backup item. + +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. + +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: The retention times of retention policy. + +## Day +### Properties +* **date**: int +* **isLast**: bool + +## MabFileFolderProtectedItemExtendedInfo +### Properties +* **lastRefreshedAt**: string: The last day and time the agent synced with the service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: The number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly': Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of the retention policy. + ## ProtectedItem * **Discriminator**: protectedItemType @@ -59,23 +93,6 @@ * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped': The backup state of the backup item. -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: The last day and time the agent synced with the service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: The number of backup copies associated with the backup item. - -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: The state of the backup policy associated with this backup item. -* **recoveryPointCount**: int: The number of available backup copies for this backup item. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -99,6 +116,22 @@ * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): The base class for backup schedules. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: Count of the duration types. Retention duration is determined by the combining the Count times and durationType. + For example, if Count = 3 and durationType = Weeks, then the retention duration is three weeks. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years': The retention duration type of the retention policy. + ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -117,33 +150,22 @@ * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: The retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: Count of the duration types. Retention duration is determined by the combining the Count times and durationType. - For example, if Count = 3 and durationType = Weeks, then the retention duration is three weeks. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years': The retention duration type of the retention policy. +## SchedulePolicy +* **Discriminator**: schedulePolicyType -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly': Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of the retention policy. +### Base Properties +### LongTermSchedulePolicy +#### Properties +* **schedulePolicyType**: 'LongTermSchedulePolicy' (Required): This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### SimpleSchedulePolicy +#### Properties +* **schedulePolicyType**: 'SimpleSchedulePolicy' (Required): This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: This list is the days of the week when the schedule runs. +* **scheduleRunFrequency**: 'Daily' | 'Invalid' | 'Weekly': Defines the frequency interval (daily or weekly) for the schedule policy. +* **scheduleRunTimes**: string[]: List of times, during a day, when the schedule runs. +* **scheduleWeeklyFrequency**: int: The number of times per week the schedule runs. -## Day -### Properties -* **date**: int -* **isLast**: bool ## WeeklyRetentionFormat ### Properties @@ -165,25 +187,3 @@ * **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. * **retentionTimes**: string[]: Retention times for the retention policy. -## SchedulePolicy -* **Discriminator**: schedulePolicyType - -### Base Properties -### LongTermSchedulePolicy -#### Properties -* **schedulePolicyType**: 'LongTermSchedulePolicy' (Required): This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. - -### SimpleSchedulePolicy -#### Properties -* **schedulePolicyType**: 'SimpleSchedulePolicy' (Required): This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: This list is the days of the week when the schedule runs. -* **scheduleRunFrequency**: 'Daily' | 'Invalid' | 'Weekly': Defines the frequency interval (daily or weekly) for the schedule policy. -* **scheduleRunTimes**: string[]: List of times, during a day, when the schedule runs. -* **scheduleWeeklyFrequency**: int: The number of times per week the schedule runs. - - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.md index 9bb25b62e1..3055417a09 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2016-12-01/types.md @@ -24,6 +24,45 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/backupstorageconfig' (ReadOnly, DeployTimeConstant): The resource type +## BackupResourceConfig +### Properties +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. + +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container + +## GenericContainerExtendedInfo +### Properties +* **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information +* **rawCertData**: string: Public key of container cert +* **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container + +## GenericContainerExtendedInfoServiceEndpoints +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MabContainerExtendedInfo +### Properties +* **backupItems**: string[]: List of backup items associated with this container. +* **backupItemType**: 'AzureFileShare' | 'AzureSqlDb' | 'Client' | 'Exchange' | 'FileFolder' | 'GenericDataSource' | 'Invalid' | 'SAPAseDatabase' | 'SAPHanaDatabase' | 'SQLDB' | 'SQLDataBase' | 'Sharepoint' | 'SystemState' | 'VM' | 'VMwareVM' | string: Type of backup items associated with this container. +* **lastBackupStatus**: string: Latest backup status of this container. +* **lastRefreshedAt**: string: Time stamp when this container was refreshed. +* **policyName**: string: Backup policy associated with this container. + +## MABContainerHealthDetails +### Properties +* **code**: int: Health Code +* **message**: string: Health Message +* **recommendations**: string[]: Health Recommended Actions +* **title**: string: Health Title + ## ProtectionContainer * **Discriminator**: containerType @@ -109,50 +148,11 @@ Backup is VMAppContainer * **protectedItemCount**: int: Number of items backed up in this container. -## GenericContainerExtendedInfo -### Properties -* **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information -* **rawCertData**: string: Public key of container cert -* **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container - -## ContainerIdentityInfo -### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container - -## GenericContainerExtendedInfoServiceEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MabContainerExtendedInfo -### Properties -* **backupItems**: string[]: List of backup items associated with this container. -* **backupItemType**: 'AzureFileShare' | 'AzureSqlDb' | 'Client' | 'Exchange' | 'FileFolder' | 'GenericDataSource' | 'Invalid' | 'SAPAseDatabase' | 'SAPHanaDatabase' | 'SQLDB' | 'SQLDataBase' | 'Sharepoint' | 'SystemState' | 'VM' | 'VMwareVM' | string: Type of backup items associated with this container. -* **lastBackupStatus**: string: Latest backup status of this container. -* **lastRefreshedAt**: string: Time stamp when this container was refreshed. -* **policyName**: string: Backup policy associated with this container. - -## MABContainerHealthDetails -### Properties -* **code**: int: Health Code -* **message**: string: Health Message -* **recommendations**: string[]: Health Recommended Actions -* **title**: string: Health Title - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## BackupResourceConfig -### Properties -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.md index 18891b701e..f0eba8e8aa 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-05-13/types.md @@ -24,6 +24,75 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/backupPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileshareProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. + +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## GenericProtectedItemSourceAssociations +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MabFileFolderProtectedItemExtendedInfo +### Properties +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + ## ProtectedItem * **Discriminator**: protectedItemType @@ -109,58 +178,6 @@ * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. - -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. - -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. - -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -209,6 +226,22 @@ * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -227,54 +260,6 @@ * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -310,8 +295,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags +## WeeklyRetentionFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. + +## WeeklyRetentionSchedule +### Properties +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## YearlyRetentionSchedule +### Properties +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.md index 116505db69..cbdb88a482 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2019-06-15/types.md @@ -36,6 +36,25 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/backupPolicies' (ReadOnly, DeployTimeConstant): The resource type +## AzureFileshareProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. + +## AzureFileshareProtectedItemKpisHealths +### Properties +### Additional Properties +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + ## BackupResourceVaultConfig ### Properties * **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. @@ -44,11 +63,71 @@ * **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | string: Storage type. * **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ResourceTags +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. + +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month + +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string +## GenericProtectedItemSourceAssociations +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + +## MabFileFolderProtectedItemExtendedInfo +### Properties +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + ## ProtectedItem * **Discriminator**: protectedItemType @@ -134,75 +213,6 @@ * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. - -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) - -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status - -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title - -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. - -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. - -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -252,10 +262,33 @@ * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -275,54 +308,6 @@ * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -358,8 +343,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags +## WeeklyRetentionFormat ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. + +## WeeklyRetentionSchedule +### Properties +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## YearlyRetentionSchedule +### Properties +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-02-02/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-02-02/types.md index b859042661..14e96ccd51 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-02-02/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-02-02/types.md @@ -12,16 +12,16 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + ## PrivateEndpointConnection ### Properties * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State * **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection -## PrivateEndpoint -### Properties -* **id**: string: Gets or sets id - ## PrivateLinkServiceConnectionState ### Properties * **actionRequired**: string: Gets or sets actions required diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.md index 4c3ed61444..fc5a3d48f8 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-10-01/types.md @@ -72,18 +72,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -93,95 +99,56 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath +### Properties +### Additional Properties +* **Additional Properties Type**: string ## GenericContainerExtendedInfo ### Properties @@ -189,18 +156,26 @@ Backup is VMAppContainer * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -216,10 +191,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -306,74 +306,90 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -424,10 +440,48 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -447,54 +501,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -530,29 +536,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.md index f4f7b30a28..871522a9f0 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2020-12-01/types.md @@ -72,18 +72,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -93,95 +99,56 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath +### Properties +### Additional Properties +* **Additional Properties Type**: string ## GenericContainerExtendedInfo ### Properties @@ -189,18 +156,26 @@ Backup is VMAppContainer * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -216,10 +191,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -306,74 +306,90 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -424,10 +440,48 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -447,54 +501,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -530,29 +536,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.md index c3dda943e2..17cdbd0d89 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-01-01/types.md @@ -72,18 +72,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -93,95 +99,56 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath +### Properties +### Additional Properties +* **Additional Properties Type**: string ## GenericContainerExtendedInfo ### Properties @@ -189,18 +156,26 @@ Backup is VMAppContainer * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -216,10 +191,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -306,74 +306,90 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -424,10 +440,48 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -447,54 +501,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -530,29 +536,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.md index cbe690d594..ba13d9b58a 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01-preview/types.md @@ -96,19 +96,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -118,139 +123,84 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. -## ResourceTags +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -266,10 +216,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -356,74 +331,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -474,76 +485,87 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string - -## RetentionPolicy -* **Discriminator**: retentionPolicyType +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceGuardProxyBase +### Properties +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -580,45 +602,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.md index 6f9c60460c..8468276421 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-01/types.md @@ -84,18 +84,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -105,139 +111,83 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. -## ResourceTags +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -253,10 +203,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -343,74 +318,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -461,10 +472,53 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -484,54 +538,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -567,29 +573,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.md index 5e2238642e..4f3fb8ca34 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-02-10/types.md @@ -84,18 +84,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -105,139 +111,83 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. -## ResourceTags +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -253,10 +203,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -343,74 +318,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -461,10 +472,53 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -484,54 +538,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -567,29 +573,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.md index 6dbcc28780..76262890ed 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-03-01/types.md @@ -84,18 +84,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -105,139 +111,83 @@ * **lastUpdateStatus**: 'Failed' | 'Invalid' | 'NotEnabled' | 'PartiallyFailed' | 'PartiallySucceeded' | 'Succeeded' | string * **subscriptionId**: string: Key Vault Subscription Id -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. -## ResourceTags +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -253,10 +203,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -343,74 +318,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -461,10 +472,53 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -484,54 +538,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -567,29 +573,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.md index 06316a7a86..100c7795ff 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-04-01/types.md @@ -96,18 +96,31 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ## BackupResourceEncryptionConfig ### Properties @@ -119,139 +132,83 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -## ResourceTags +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -267,10 +224,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -357,74 +339,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. - -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +## ProtectionContainer +* **Discriminator**: containerType -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. + +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -475,76 +493,76 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string - -## RetentionPolicy -* **Discriminator**: retentionPolicyType - -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. - -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -581,41 +599,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.md index a61c82632b..ffd82e303d 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-06-01/types.md @@ -84,18 +84,24 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. ## BackupResourceEncryptionConfig ### Properties @@ -107,139 +113,83 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type. +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. + +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. -## ResourceTags +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -255,10 +205,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -345,74 +320,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -463,10 +474,53 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceHealthDetails ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RetentionDuration +### Properties +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. ## RetentionPolicy * **Discriminator**: retentionPolicyType @@ -486,54 +540,6 @@ Backup is VMAppContainer * **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -## DailyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## RetentionDuration -### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. - -## MonthlyRetentionSchedule -### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - -## DailyRetentionFormat -### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. - -## Day -### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month - -## WeeklyRetentionFormat -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. - -## WeeklyRetentionSchedule -### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. - -## YearlyRetentionSchedule -### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. - ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -569,29 +575,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.md index f13e571fdc..0f3507fd93 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-07-01/types.md @@ -108,19 +108,31 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ## BackupResourceEncryptionConfig ### Properties @@ -132,139 +144,84 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -## ResourceTags +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -280,10 +237,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -371,74 +353,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -490,76 +508,93 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -## RetentionPolicy -* **Discriminator**: retentionPolicyType +## ResourceGuardProxyBase +### Properties +* **description**: string (ReadOnly) +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -596,58 +631,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **description**: string (ReadOnly) -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.md index 93485189e3..79221681fd 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-08-01/types.md @@ -108,19 +108,31 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ## BackupResourceEncryptionConfig ### Properties @@ -132,139 +144,84 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -## ResourceTags +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -280,10 +237,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -371,74 +353,110 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -490,76 +508,93 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -## RetentionPolicy -* **Discriminator**: retentionPolicyType +## ResourceGuardProxyBase +### Properties +* **description**: string (ReadOnly) +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -596,58 +631,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **description**: string (ReadOnly) -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.md index 5d1d5f5fb3..532669d12c 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-10-01/types.md @@ -108,20 +108,33 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state ## BackupResourceEncryptionConfig ### Properties @@ -133,145 +146,92 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadContainerAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. -## ResourceTags +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **protectableObjectType**: string: Type of the protectable object associated with this container -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## HourlySchedule +### Properties +* **interval**: int: Interval at which backup needs to be triggered. For hourly the value + can be 4/6/8/12 +* **scheduleWindowDuration**: int: To specify duration of the backup window +* **scheduleWindowStartTime**: string: To specify start time of the backup window + +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -287,10 +247,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -380,74 +365,116 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **protectableObjectType**: string: Type of the protectable object associated with this container +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadContainerAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -499,76 +526,93 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -## RetentionPolicy -* **Discriminator**: retentionPolicyType +## ResourceGuardProxyBase +### Properties +* **description**: string (ReadOnly) +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -593,13 +637,6 @@ For example, when Count = 3 and DurationType = Weeks, retention duration will be * **scheduleWeeklyFrequency**: int: At every number weeks this schedule has to be run. -## HourlySchedule -### Properties -* **interval**: int: Interval at which backup needs to be triggered. For hourly the value - can be 4/6/8/12 -* **scheduleWindowDuration**: int: To specify duration of the backup window -* **scheduleWindowStartTime**: string: To specify start time of the backup window - ## Settings ### Properties * **isCompression**: bool: Workload compression flag. This has been added so that 'isSqlCompression' @@ -613,60 +650,23 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **description**: string (ReadOnly) -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection - -## PrivateEndpoint +## WeeklyRetentionFormat ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateLinkServiceConnectionState +## WeeklyRetentionSchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.md index d21a959738..e5115bdf6e 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2021-12-01/types.md @@ -108,20 +108,38 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureIaaSVMProtectionPolicyTieringPolicy +### Properties +### Additional Properties +* **Additional Properties Type**: [TieringPolicy](#tieringpolicy) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state ## BackupResourceEncryptionConfig ### Properties @@ -133,145 +151,96 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadContainerAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailySchedule +### Properties +* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -## ResourceTags +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **protectableObjectType**: string: Type of the protectable object associated with this container -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## HourlySchedule +### Properties +* **interval**: int: Interval at which backup needs to be triggered. For hourly the value + can be 4/6/8/12 +* **scheduleWindowDuration**: int: To specify duration of the backup window +* **scheduleWindowStartTime**: string: To specify start time of the backup window + +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -287,10 +256,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -380,74 +374,116 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **protectableObjectType**: string: Type of the protectable object associated with this container +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### AzureStorageContainer +#### Properties +* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. + +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +## ProtectionIntent +* **Discriminator**: protectionIntentItemType -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadContainerAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -503,76 +539,93 @@ Tiering policy specifies the criteria to move RP to the target tier. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -## RetentionPolicy -* **Discriminator**: retentionPolicyType +## ResourceGuardProxyBase +### Properties +* **description**: string (ReadOnly) +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -605,37 +658,6 @@ For example, when Count = 3 and DurationType = Weeks, retention duration will be * **weeklySchedule**: [WeeklySchedule](#weeklyschedule) -## HourlySchedule -### Properties -* **interval**: int: Interval at which backup needs to be triggered. For hourly the value - can be 4/6/8/12 -* **scheduleWindowDuration**: int: To specify duration of the backup window -* **scheduleWindowStartTime**: string: To specify start time of the backup window - -## DailySchedule -### Properties -* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. - -## WeeklySchedule -### Properties -* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Array of DayOfWeek -* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. - -## AzureIaaSVMProtectionPolicyTieringPolicy -### Properties -### Additional Properties -* **Additional Properties Type**: [TieringPolicy](#tieringpolicy) - -## TieringPolicy -### Properties -* **duration**: int: Number of days/weeks/months/years to retain backups in current tier before tiering. -Used only if TieringMode is set to TierAfter -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. -* **tieringMode**: 'DoNotTier' | 'Invalid' | 'TierAfter' | 'TierRecommended' | string: Tiering Mode to control automatic tiering of recovery points. Supported values are: -1. TierRecommended: Tier all recovery points recommended to be tiered -2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. -3. DoNotTier: Do not tier any recovery points - ## Settings ### Properties * **isCompression**: bool: Workload compression flag. This has been added so that 'isSqlCompression' @@ -657,60 +679,38 @@ Tiering policy specifies the criteria to move RP to the target tier. ### Additional Properties * **Additional Properties Type**: [TieringPolicy](#tieringpolicy) -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **description**: string (ReadOnly) -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state - -## ResourceTags +## TieringPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **duration**: int: Number of days/weeks/months/years to retain backups in current tier before tiering. +Used only if TieringMode is set to TierAfter +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +* **tieringMode**: 'DoNotTier' | 'Invalid' | 'TierAfter' | 'TierRecommended' | string: Tiering Mode to control automatic tiering of recovery points. Supported values are: +1. TierRecommended: Tier all recovery points recommended to be tiered +2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. +3. DoNotTier: Do not tier any recovery points -## PrivateEndpointConnection +## WeeklyRetentionFormat ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateEndpoint +## WeeklyRetentionSchedule ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## PrivateLinkServiceConnectionState +## WeeklySchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Array of DayOfWeek +* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.md index f0eded7acb..ec47284970 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-01-01/types.md @@ -108,20 +108,33 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state ## BackupResourceEncryptionConfig ### Properties @@ -133,145 +146,96 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadContainerAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailySchedule +### Properties +* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -## ResourceTags +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **protectableObjectType**: string: Type of the protectable object associated with this container -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## HourlySchedule +### Properties +* **interval**: int: Interval at which backup needs to be triggered. For hourly the value + can be 4/6/8/12 +* **scheduleWindowDuration**: int: To specify duration of the backup window +* **scheduleWindowStartTime**: string: To specify start time of the backup window + +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -287,10 +251,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -380,74 +369,116 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **protectableObjectType**: string: Type of the protectable object associated with this container +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadContainerAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -500,76 +531,93 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -## RetentionPolicy -* **Discriminator**: retentionPolicyType +## ResourceGuardProxyBase +### Properties +* **description**: string (ReadOnly) +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -602,22 +650,6 @@ For example, when Count = 3 and DurationType = Weeks, retention duration will be * **weeklySchedule**: [WeeklySchedule](#weeklyschedule) -## HourlySchedule -### Properties -* **interval**: int: Interval at which backup needs to be triggered. For hourly the value - can be 4/6/8/12 -* **scheduleWindowDuration**: int: To specify duration of the backup window -* **scheduleWindowStartTime**: string: To specify start time of the backup window - -## DailySchedule -### Properties -* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. - -## WeeklySchedule -### Properties -* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Array of DayOfWeek -* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. - ## Settings ### Properties * **isCompression**: bool: Workload compression flag. This has been added so that 'isSqlCompression' @@ -631,60 +663,28 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **description**: string (ReadOnly) -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection +## WeeklyRetentionFormat ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateEndpoint +## WeeklyRetentionSchedule ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## PrivateLinkServiceConnectionState +## WeeklySchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Array of DayOfWeek +* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.md b/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.md index 506b48d3a7..68b3de6009 100644 --- a/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.md +++ b/generated/recoveryservicesbackup/microsoft.recoveryservices/2022-02-01/types.md @@ -108,20 +108,33 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.RecoveryServices/vaults/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## BackupResourceVaultConfig +## AzureFileshareProtectedItemExtendedInfo ### Properties -* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. -* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable -* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests -* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} +* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. -## ResourceTags +## AzureFileshareProtectedItemKpisHealths ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) + +## AzureSqlProtectedItemExtendedInfo +### Properties +* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. +* **policyState**: string: State of the backup policy associated with this backup item. +* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. + +## BackupResourceConfig +### Properties +* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. +* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. +* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state ## BackupResourceEncryptionConfig ### Properties @@ -133,145 +146,96 @@ * **userAssignedIdentity**: string (ReadOnly): User Assigned Identity Id * **useSystemAssignedIdentity**: bool (ReadOnly): bool to indicate whether to use system Assigned Identity or not -## ResourceTags +## BackupResourceVaultConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enhancedSecurityState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Enabled or Disabled. +* **isSoftDeleteFeatureStateEditable**: bool: Is soft delete feature state editable +* **resourceGuardOperationRequests**: string[]: ResourceGuard Operation Requests +* **softDeleteFeatureState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Soft Delete feature state +* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type +* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -## ProtectionIntent -* **Discriminator**: protectionIntentItemType +## ContainerIdentityInfo +### Properties +* **aadTenantId**: string: Protection container identity - AAD Tenant +* **audience**: string: Protection container identity - Audience +* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal +* **uniqueName**: string: Unique name of the container -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId -* **policyId**: string: ID of the backup policy with which this item is backed up. -* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not -* **sourceResourceId**: string: ARM ID of the resource to be backed up. -### AzureResourceProtectionIntent -#### Properties -* **friendlyName**: string: Friendly name of the VM represented by this backup item. -* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. +## DailyRetentionFormat +### Properties +* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. -### AzureWorkloadContainerAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. +## DailyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -### AzureWorkloadSQLAutoProtectionIntent -#### Properties -* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. -* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set +## DailySchedule +### Properties +* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. +## Day +### Properties +* **date**: int: Date of the month +* **isLast**: bool: Whether Date is last date of month -## ResourceTags +## DPMProtectedItemExtendedInfo +### Properties +* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. +* **isCollocated**: bool: To check if backup item is collocated. +* **isPresentOnCloud**: bool: To check if backup item is cloud protected. +* **lastBackupStatus**: string: Last backup status information on backup item. +* **lastRefreshedAt**: string: Last refresh time on backup item. +* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. +* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. +* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. +* **onPremiseRecoveryPointCount**: int: disk recovery point count. +* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. +* **protected**: bool: To check if backup item is disk protected. +* **protectionGroupName**: string: Protection group name of the backup item. +* **recoveryPointCount**: int: cloud recovery point count. +* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. + +## DPMProtectedItemExtendedInfoProtectableObjectLoadPath ### Properties ### Additional Properties * **Additional Properties Type**: string -## ProtectionContainer -* **Discriminator**: containerType - -### Base Properties -* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. -* **friendlyName**: string: Friendly name of the container. -* **healthStatus**: string: Status of health of the container. -* **protectableObjectType**: string: Type of the protectable object associated with this container -* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. -### AzureBackupServerContainer -#### Properties -* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlContainer -#### Properties -* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### GenericContainer -#### Properties -* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information -* **fabricName**: string: Name of the container's fabric - -### AzureIaaSClassicComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureIaaSComputeVMContainer -#### Properties -* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureSqlagWorkloadContainerProtectionContainer -#### Properties -* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### AzureStorageContainer -#### Properties -* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. -* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **protectedItemCount**: int: Number of items backed up in this container. -* **resourceGroup**: string: Resource group name of Recovery Services Vault. -* **sourceResourceId**: string: Fully qualified ARM url. -* **storageAccountVersion**: string: Storage account version. - -### AzureVMAppContainerProtectionContainer -#### Properties -* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer - -### MabContainer -#### Properties -* **agentVersion**: string: Agent version of this container. -* **canReRegister**: bool: Can the container be registered one more time. -* **containerHealthState**: string: Health state of mab container. -* **containerId**: int: ContainerID represents the container. -* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. -Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is -Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload -Backup is VMAppContainer -* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. -* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. -* **protectedItemCount**: int: Number of items backed up in this container. - - ## GenericContainerExtendedInfo ### Properties * **containerIdentityInfo**: [ContainerIdentityInfo](#containeridentityinfo): Container identity information * **rawCertData**: string: Public key of container cert * **serviceEndpoints**: [GenericContainerExtendedInfoServiceEndpoints](#genericcontainerextendedinfoserviceendpoints): Azure Backup Service Endpoints for the container -## ContainerIdentityInfo +## GenericContainerExtendedInfoServiceEndpoints ### Properties -* **aadTenantId**: string: Protection container identity - AAD Tenant -* **audience**: string: Protection container identity - Audience -* **servicePrincipalClientId**: string: Protection container identity - AAD Service Principal -* **uniqueName**: string: Unique name of the container +### Additional Properties +* **Additional Properties Type**: string -## GenericContainerExtendedInfoServiceEndpoints +## GenericProtectedItemSourceAssociations ### Properties ### Additional Properties * **Additional Properties Type**: string +## HourlySchedule +### Properties +* **interval**: int: Interval at which backup needs to be triggered. For hourly the value + can be 4/6/8/12 +* **scheduleWindowDuration**: int: To specify duration of the backup window +* **scheduleWindowStartTime**: string: To specify start time of the backup window + +## InstantRPAdditionalDetails +### Properties +* **azureBackupRGNamePrefix**: string +* **azureBackupRGNameSuffix**: string + +## KPIResourceHealthDetails +### Properties +* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status +* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status + ## MabContainerExtendedInfo ### Properties * **backupItems**: string[]: List of backup items associated with this container. @@ -287,10 +251,35 @@ Backup is VMAppContainer * **recommendations**: string[]: Health Recommended Actions * **title**: string: Health Title -## ResourceTags +## MabFileFolderProtectedItemExtendedInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **lastRefreshedAt**: string: Last time when the agent data synced to service. +* **oldestRecoveryPoint**: string: The oldest backup copy available. +* **recoveryPointCount**: int: Number of backup copies associated with the backup item. + +## MonthlyRetentionSchedule +### Properties +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. + +## PrivateEndpoint +### Properties +* **id**: string: Gets or sets id + +## PrivateEndpointConnection +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State +* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string: Gets or sets actions required +* **description**: string: Gets or sets description +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status ## ProtectedItem * **Discriminator**: protectedItemType @@ -380,74 +369,116 @@ Backup is VMAppContainer * **protectionState**: 'IRPending' | 'Invalid' | 'Protected' | 'ProtectionError' | 'ProtectionPaused' | 'ProtectionStopped' | string: Backup state of the backed up item. -## AzureFileshareProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: Indicates consistency of policy object and policy applied to this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. -* **resourceState**: string (ReadOnly): Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} -* **resourceStateSyncTime**: string (ReadOnly): The resource state sync time for this backup item. +## ProtectionContainer +* **Discriminator**: containerType -## AzureFileshareProtectedItemKpisHealths -### Properties -### Additional Properties -* **Additional Properties Type**: [KPIResourceHealthDetails](#kpiresourcehealthdetails) +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **friendlyName**: string: Friendly name of the container. +* **healthStatus**: string: Status of health of the container. +* **protectableObjectType**: string: Type of the protectable object associated with this container +* **registrationStatus**: string: Status of registration of the container with the Recovery Services Vault. +### AzureBackupServerContainer +#### Properties +* **containerType**: 'AzureBackupServerContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## KPIResourceHealthDetails -### Properties -* **resourceHealthDetails**: [ResourceHealthDetails](#resourcehealthdetails)[]: Resource Health Status -* **resourceHealthStatus**: 'Healthy' | 'Invalid' | 'PersistentDegraded' | 'PersistentUnhealthy' | 'TransientDegraded' | 'TransientUnhealthy' | string: Resource Health Status +### AzureSqlContainer +#### Properties +* **containerType**: 'AzureSqlContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## ResourceHealthDetails -### Properties -* **code**: int (ReadOnly): Health Code -* **message**: string (ReadOnly): Health Message -* **recommendations**: string[] (ReadOnly): Health Recommended Actions -* **title**: string (ReadOnly): Health Title +### GenericContainer +#### Properties +* **containerType**: 'GenericContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInformation**: [GenericContainerExtendedInfo](#genericcontainerextendedinfo): Container extended information +* **fabricName**: string: Name of the container's fabric -## DPMProtectedItemExtendedInfo -### Properties -* **diskStorageUsedInBytes**: string: Used Disk storage in bytes. -* **isCollocated**: bool: To check if backup item is collocated. -* **isPresentOnCloud**: bool: To check if backup item is cloud protected. -* **lastBackupStatus**: string: Last backup status information on backup item. -* **lastRefreshedAt**: string: Last refresh time on backup item. -* **oldestRecoveryPoint**: string: Oldest cloud recovery point time. -* **onPremiseLatestRecoveryPoint**: string: latest disk recovery point time. -* **onPremiseOldestRecoveryPoint**: string: Oldest disk recovery point time. -* **onPremiseRecoveryPointCount**: int: disk recovery point count. -* **protectableObjectLoadPath**: [DPMProtectedItemExtendedInfoProtectableObjectLoadPath](#dpmprotecteditemextendedinfoprotectableobjectloadpath): Attribute to provide information on various DBs. -* **protected**: bool: To check if backup item is disk protected. -* **protectionGroupName**: string: Protection group name of the backup item. -* **recoveryPointCount**: int: cloud recovery point count. -* **totalDiskStorageSizeInBytes**: string: total Disk storage in bytes. +### AzureIaaSClassicComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.ClassicCompute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## DPMProtectedItemExtendedInfoProtectableObjectLoadPath -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureIaaSComputeVMContainer +#### Properties +* **containerType**: 'Microsoft.Compute/virtualMachines' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## GenericProtectedItemSourceAssociations -### Properties -### Additional Properties -* **Additional Properties Type**: string +### AzureSqlagWorkloadContainerProtectionContainer +#### Properties +* **containerType**: 'SQLAGWorkLoadContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer -## MabFileFolderProtectedItemExtendedInfo -### Properties -* **lastRefreshedAt**: string: Last time when the agent data synced to service. -* **oldestRecoveryPoint**: string: The oldest backup copy available. -* **recoveryPointCount**: int: Number of backup copies associated with the backup item. +### AzureStorageContainer +#### Properties +* **acquireStorageAccountLock**: 'Acquire' | 'NotAcquire' | string: Whether storage account lock is to be acquired for this container or not. +* **containerType**: 'StorageContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **protectedItemCount**: int: Number of items backed up in this container. +* **resourceGroup**: string: Resource group name of Recovery Services Vault. +* **sourceResourceId**: string: Fully qualified ARM url. +* **storageAccountVersion**: string: Storage account version. -## AzureSqlProtectedItemExtendedInfo -### Properties -* **oldestRecoveryPoint**: string: The oldest backup copy available for this item in the service. -* **policyState**: string: State of the backup policy associated with this backup item. -* **recoveryPointCount**: int: Number of available backup copies associated with this backup item. +### AzureVMAppContainerProtectionContainer +#### Properties +* **containerType**: 'VMAppContainer' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer + +### MabContainer +#### Properties +* **agentVersion**: string: Agent version of this container. +* **canReRegister**: bool: Can the container be registered one more time. +* **containerHealthState**: string: Health state of mab container. +* **containerId**: int: ContainerID represents the container. +* **containerType**: 'Windows' (Required): Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. +Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is +Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload +Backup is VMAppContainer +* **extendedInfo**: [MabContainerExtendedInfo](#mabcontainerextendedinfo): Additional information of the container. +* **mabContainerHealthDetails**: [MABContainerHealthDetails](#mabcontainerhealthdetails)[]: Health details on this mab container. +* **protectedItemCount**: int: Number of items backed up in this container. + + +## ProtectionIntent +* **Discriminator**: protectionIntentItemType + +### Base Properties +* **backupManagementType**: 'AzureBackupServer' | 'AzureIaasVM' | 'AzureSql' | 'AzureStorage' | 'AzureWorkload' | 'DPM' | 'DefaultBackup' | 'Invalid' | 'MAB' | string: Backup management type to execute the current job. +* **itemId**: string: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId +* **policyId**: string: ID of the backup policy with which this item is backed up. +* **protectionState**: 'Invalid' | 'NotProtected' | 'Protected' | 'Protecting' | 'ProtectionFailed' | string: Specifies whether the container is registered or not +* **sourceResourceId**: string: ARM ID of the resource to be backed up. +### AzureResourceProtectionIntent +#### Properties +* **friendlyName**: string: Friendly name of the VM represented by this backup item. +* **protectionIntentItemType**: 'AzureResourceItem' (Required): backup protectionIntent type. + +### AzureWorkloadContainerAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadContainerAutoProtectionIntent' (Required): backup protectionIntent type. + +### AzureWorkloadSQLAutoProtectionIntent +#### Properties +* **protectionIntentItemType**: 'AzureWorkloadSQLAutoProtectionIntent' (Required): backup protectionIntent type. +* **workloadItemType**: 'Invalid' | 'SAPAseDatabase' | 'SAPAseSystem' | 'SAPHanaDatabase' | 'SAPHanaSystem' | 'SQLDataBase' | 'SQLInstance' | string: Workload item type of the item for which intent is to be set -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string ## ProtectionPolicy * **Discriminator**: backupManagementType @@ -500,76 +531,93 @@ Backup is VMAppContainer * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## InstantRPAdditionalDetails +## ResourceGuardOperationDetail ### Properties -* **azureBackupRGNamePrefix**: string -* **azureBackupRGNameSuffix**: string +* **defaultResourceRequest**: string (ReadOnly) +* **vaultCriticalOperation**: string (ReadOnly) -## RetentionPolicy -* **Discriminator**: retentionPolicyType +## ResourceGuardProxyBase +### Properties +* **description**: string (ReadOnly) +* **lastUpdatedTime**: string (ReadOnly) +* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail +* **resourceGuardResourceId**: string (ReadOnly) -### Base Properties -### LongTermRetentionPolicy -#### Properties -* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. -* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. -* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. -* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. -* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. +## ResourceHealthDetails +### Properties +* **code**: int (ReadOnly): Health Code +* **message**: string (ReadOnly): Health Message +* **recommendations**: string[] (ReadOnly): Health Recommended Actions +* **title**: string (ReadOnly): Health Title -### SimpleRetentionPolicy -#### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## RetentionDuration +## ResourceTags ### Properties -* **count**: int: 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. -* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## MonthlyRetentionSchedule +## ResourceTags ### Properties -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## DailyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheMonth**: [Day](#day)[]: List of days of the month. +### Additional Properties +* **Additional Properties Type**: string -## Day +## ResourceTags ### Properties -* **date**: int: Date of the month -* **isLast**: bool: Whether Date is last date of month +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionFormat +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. -* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. +### Additional Properties +* **Additional Properties Type**: string -## WeeklyRetentionSchedule +## ResourceTags ### Properties -* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. -* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionTimes**: string[]: Retention times of retention policy. +### Additional Properties +* **Additional Properties Type**: string -## YearlyRetentionSchedule +## RetentionDuration ### Properties -* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **count**: int: 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. +* **durationType**: 'Days' | 'Invalid' | 'Months' | 'Weeks' | 'Years' | string: Retention duration type of retention policy. + +## RetentionPolicy +* **Discriminator**: retentionPolicyType + +### Base Properties +### LongTermRetentionPolicy +#### Properties +* **dailySchedule**: [DailyRetentionSchedule](#dailyretentionschedule): Daily retention schedule. +* **monthlySchedule**: [MonthlyRetentionSchedule](#monthlyretentionschedule): Monthly retention schedule. +* **retentionPolicyType**: 'LongTermRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. +* **weeklySchedule**: [WeeklyRetentionSchedule](#weeklyretentionschedule): Weekly retention schedule. +* **yearlySchedule**: [YearlyRetentionSchedule](#yearlyretentionschedule): Yearly retention schedule. + +### SimpleRetentionPolicy +#### Properties * **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. -* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. -* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. -* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. -* **retentionTimes**: string[]: Retention times of retention policy. +* **retentionPolicyType**: 'SimpleRetentionPolicy' (Required): This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. + ## SchedulePolicy * **Discriminator**: schedulePolicyType @@ -602,22 +650,6 @@ For example, when Count = 3 and DurationType = Weeks, retention duration will be * **weeklySchedule**: [WeeklySchedule](#weeklyschedule) -## HourlySchedule -### Properties -* **interval**: int: Interval at which backup needs to be triggered. For hourly the value - can be 4/6/8/12 -* **scheduleWindowDuration**: int: To specify duration of the backup window -* **scheduleWindowStartTime**: string: To specify start time of the backup window - -## DailySchedule -### Properties -* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. - -## WeeklySchedule -### Properties -* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Array of DayOfWeek -* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. - ## Settings ### Properties * **isCompression**: bool: Workload compression flag. This has been added so that 'isSqlCompression' @@ -631,60 +663,28 @@ will be deprecated once clients upgrade to consider this flag. * **retentionPolicy**: [RetentionPolicy](#retentionpolicy): Base class for retention policy. * **schedulePolicy**: [SchedulePolicy](#schedulepolicy): Base class for backup schedule. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGuardProxyBase -### Properties -* **description**: string (ReadOnly) -* **lastUpdatedTime**: string (ReadOnly) -* **resourceGuardOperationDetails**: [ResourceGuardOperationDetail](#resourceguardoperationdetail)[] (ReadOnly): Array of ResourceGuardOperationDetail -* **resourceGuardResourceId**: string (ReadOnly) - -## ResourceGuardOperationDetail -### Properties -* **defaultResourceRequest**: string (ReadOnly) -* **vaultCriticalOperation**: string (ReadOnly) - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupResourceConfig -### Properties -* **crossRegionRestoreFlag**: bool: Opt in details of Cross Region Restore feature. -* **dedupState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault Dedup state -* **storageModelType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageType**: 'GeoRedundant' | 'Invalid' | 'LocallyRedundant' | 'ReadAccessGeoZoneRedundant' | 'ZoneRedundant' | string: Storage type -* **storageTypeState**: 'Invalid' | 'Locked' | 'Unlocked' | string: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. -* **xcoolState**: 'Disabled' | 'Enabled' | 'Invalid' | string: Vault x-cool state - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateEndpointConnection +## WeeklyRetentionFormat ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint network resource that is linked to the Private Endpoint connection -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Private Link Service Connection State -* **provisioningState**: 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | string: Gets or sets provisioning state of the private endpoint connection +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of the week. +* **weeksOfTheMonth**: 'First' | 'Fourth' | 'Invalid' | 'Last' | 'Second' | 'Third'[]: List of weeks of month. -## PrivateEndpoint +## WeeklyRetentionSchedule ### Properties -* **id**: string: Gets or sets id +* **daysOfTheWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: List of days of week for weekly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionTimes**: string[]: Retention times of retention policy. -## PrivateLinkServiceConnectionState +## WeeklySchedule ### Properties -* **actionRequired**: string: Gets or sets actions required -* **description**: string: Gets or sets description -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Gets or sets the status +* **scheduleRunDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Array of DayOfWeek +* **scheduleRunTimes**: string[]: List of times of day this schedule has to be run. -## ResourceTags +## YearlyRetentionSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **monthsOfYear**: 'April' | 'August' | 'December' | 'February' | 'Invalid' | 'January' | 'July' | 'June' | 'March' | 'May' | 'November' | 'October' | 'September'[]: List of months of year of yearly retention policy. +* **retentionDuration**: [RetentionDuration](#retentionduration): Retention duration. +* **retentionScheduleDaily**: [DailyRetentionFormat](#dailyretentionformat): Daily retention format. +* **retentionScheduleFormatType**: 'Daily' | 'Invalid' | 'Weekly' | string: Retention schedule format type for monthly retention policy. +* **retentionScheduleWeekly**: [WeeklyRetentionFormat](#weeklyretentionformat): Weekly retention format. +* **retentionTimes**: string[]: Retention times of retention policy. diff --git a/generated/recoveryservicessiterecovery/log.out b/generated/recoveryservicessiterecovery/log.out index 8b5f1f09e8..a321a06611 100644 --- a/generated/recoveryservicessiterecovery/log.out +++ b/generated/recoveryservicessiterecovery/log.out @@ -9,7 +9,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18,10 +18,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 55ms +info | autorest.bicep took 53ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2022-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -30,10 +30,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 37ms +info | autorest.bicep took 49ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -42,10 +42,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 52ms +info | autorest.bicep took 32ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -54,7 +54,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 37ms @@ -66,10 +66,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 34ms +info | autorest.bicep took 32ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -78,10 +78,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 30ms +info | autorest.bicep took 29ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -90,10 +90,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 31ms +info | autorest.bicep took 36ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -102,10 +102,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 32ms +info | autorest.bicep took 34ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -114,12 +114,12 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/service.json:20191:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 29ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -128,14 +128,14 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ReplicationProtectionIntent' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-03-01/service.json:18210:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-03-01/service.json:18425:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 30ms +info | autorest.bicep took 31ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2021-02-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -144,12 +144,12 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-02-10/service.json:20191:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 34ms +info | autorest.bicep took 31ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2018-07-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -158,14 +158,14 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ReplicationProtectionIntent' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json:18210:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json:18425:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 30ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.recoveryservices-2018-01-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -174,7 +174,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json:14658:5 @@ -188,10 +188,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/service.json:11607:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 30ms -info | Autorest completed in 230.19s. 28 files generated. +info | autorest.bicep took 14ms +info | Autorest completed in 214.72s. 28 files generated. diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.md index 1ab89954d0..1017574cd2 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2016-08-10/types.md @@ -100,170 +100,88 @@ * **properties**: [CreateRecoveryPlanInputProperties](#createrecoveryplaninputproperties) (Required): Recovery plan creation properties. * **type**: 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties -### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. - -## FabricCreationInputProperties +## A2AProtectedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. - -### HyperVSiteDetails -#### Properties -* **instanceType**: 'HyperVSite' (Required): Gets the class type. - -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. - -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentVersion**: string (ReadOnly): The agent Version. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. - -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **rcmServiceEndpoint**: string (ReadOnly): The endpoint for making requests to the RCM Service. -* **srsServiceEndpoint**: string (ReadOnly): The endpoint for making requests to the SRS Service. - +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -## MasterTargetServer +## A2AProtectedManagedDiskDetails ### Properties -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskType**: string (ReadOnly): The type of disk. +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryDiskId**: string (ReadOnly): Recovery disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -## DataStore +## A2AVmDiskInputDetails ### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. +* **diskUri**: string (WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. -## RetentionVolume +## A2AVmManagedDiskInputDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. +* **diskId**: string (WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. +* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. -## HealthError +## AddVCenterRequestProperties ### Properties -* **childErrors**: [HealthError](#healtherror)[] (ReadOnly): The child health errors. -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCode**: string (ReadOnly): Error code. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **roleAssignments**: [RoleAssignment](#roleassignment)[] (ReadOnly): The Azure role assignments. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -279,42 +197,11 @@ * **recoveryNetworkId**: string: Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input ## CreateProtectionContainerInputProperties ### Properties @@ -327,18 +214,60 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **PolicyId**: string (WriteOnly): Applicable policy. +* **policyId**: string (ReadOnly): Policy ARM Id. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput -* **Discriminator**: instanceType +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager': The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. -### Base Properties -### A2AContainerCreationInput -#### Properties -* **instanceType**: 'A2A' (Required): The class type. +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. ## EnableProtectionInputProperties ### Properties @@ -370,12 +299,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -601,120 +524,118 @@ * **instanceType**: 'San' (Required): The class type. -## A2AProtectedDiskDetails +## EncryptionDetails ### Properties -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## A2AProtectedManagedDiskDetails +## FabricCreationInputProperties ### Properties -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskType**: string (ReadOnly): The type of disk. -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryDiskId**: string (ReadOnly): Recovery disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AVmManagedDiskInputDetails -### Properties -* **diskId**: string (WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. -* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. -## VMNicDetails -### Properties -* **ipAddressType**: string (ReadOnly): Ip address type. -* **nicId**: string (ReadOnly): The nic Id. -* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. -* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **vMNetworkName**: string (ReadOnly): VM network name. -* **vMSubnetName**: string (ReadOnly): VM subnet name. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **roleAssignments**: [RoleAssignment](#roleassignment)[] (ReadOnly): The Azure role assignments. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly): The input endpoint name. -* **privatePort**: int (ReadOnly): The input endpoint private port. -* **protocol**: string (ReadOnly): The input endpoint protocol. -* **publicPort**: int (ReadOnly): The input endpoint public port. -## RoleAssignment -### Properties -* **id**: string (ReadOnly): The ARM Id of the role assignment. -* **name**: string (ReadOnly): The name of the role assignment. -* **principalId**: string (ReadOnly): Principal Id. -* **roleDefinitionId**: string (ReadOnly): Role definition id. -* **scope**: string (ReadOnly): Role assignment scope. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### HyperVSiteDetails +#### Properties +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## DiskDetails -### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## AzureVmDiskDetails -### Properties -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentVersion**: string (ReadOnly): The agent Version. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## OSDetails +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **rcmServiceEndpoint**: string (ReadOnly): The endpoint for making requests to the RCM Service. +* **srsServiceEndpoint**: string (ReadOnly): The endpoint for making requests to the SRS Service. + + +## HealthError ### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. +* **childErrors**: [HealthError](#healtherror)[] (ReadOnly): The child health errors. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCode**: string (ReadOnly): Error code. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. ## InMageAgentDetails ### Properties @@ -722,10 +643,23 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2ProtectedDiskDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **healthErrorCode**: string (ReadOnly): The health error code for the disk. +* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. +* **protectionStage**: string (ReadOnly): The protection stage. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. +* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. +* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. ## InMageDiskExclusionInput ### Properties @@ -736,17 +670,6 @@ ### Properties * **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. -## InMageVolumeExclusionOptions -### Properties -* **OnlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. - -## OSDiskDetails -### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. - ## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -765,70 +688,77 @@ * **sourceDataInMB**: int (ReadOnly): The source data transit in MB. * **targetDataInMB**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2ProtectedDiskDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. -* **healthErrorCode**: string (ReadOnly): The health error code for the disk. -* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. -* **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. -* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. -* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. -* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. +### Additional Properties +* **Additional Properties Type**: string -## CreateProtectionContainerMappingInputProperties +## InMageVolumeExclusionOptions ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **PolicyId**: string (WriteOnly): Applicable policy. -* **policyId**: string (ReadOnly): Policy ARM Id. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. +* **OnlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## ProtectionContainerMappingProviderSpecificDetails +## InputEndpoint ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **endpointName**: string (ReadOnly): The input endpoint name. +* **privatePort**: int (ReadOnly): The input endpoint private port. +* **protocol**: string (ReadOnly): The input endpoint protocol. +* **publicPort**: int (ReadOnly): The input endpoint public port. -## ReplicationProviderSpecificContainerMappingInput +## MasterTargetServer ### Properties -* **instanceType**: string (WriteOnly): The class type. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1015,30 +945,41 @@ * **recoveryPointHistory**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateRecoveryPlanInputProperties +## ProcessServer ### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager': The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status -## RecoveryPlanGroup +## ProtectionContainerFabricSpecificDetails ### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. ## RecoveryPlanAction ### Properties @@ -1071,8 +1012,67 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. * **virtualMachineId**: string: The virtual machine Id. +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +### Properties +* **instanceType**: string (WriteOnly): The class type. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RoleAssignment +### Properties +* **id**: string (ReadOnly): The ARM Id of the role assignment. +* **name**: string (ReadOnly): The name of the role assignment. +* **principalId**: string (ReadOnly): Principal Id. +* **roleDefinitionId**: string (ReadOnly): Role definition id. +* **scope**: string (ReadOnly): Role assignment scope. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + +## VMNicDetails +### Properties +* **ipAddressType**: string (ReadOnly): Ip address type. +* **nicId**: string (ReadOnly): The nic Id. +* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. +* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **vMNetworkName**: string (ReadOnly): VM network name. +* **vMSubnetName**: string (ReadOnly): VM subnet name. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.md index b656cbd64e..16b3a7e9a1 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-01-10/types.md @@ -120,207 +120,128 @@ * **properties**: [CreateRecoveryPlanInputProperties](#createrecoveryplaninputproperties) (Required): Recovery plan creation properties. * **type**: 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties -### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. - -## FabricCreationInputProperties -### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. - -### HyperVSiteDetails -#### Properties -* **instanceType**: 'HyperVSite' (Required): Gets the class type. - -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. - -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. - -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. - - -## VersionDetails +## A2AProtectedDiskDetails ### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -## MasterTargetServer +## A2AProtectedManagedDiskDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskType**: string (ReadOnly): The type of disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -## DataStore +## A2AVmDiskInputDetails ### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. +* **diskUri**: string (WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. -## HealthError +## A2AVmManagedDiskInputDetails ### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. +* **diskId**: string (WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## InnerHealthError +## AddRecoveryServicesProviderInputProperties ### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineName**: string (Required, WriteOnly): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. -## RetentionVolume +## AddVCenterRequestProperties ### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **roleAssignments**: [RoleAssignment](#roleassignment)[] (ReadOnly): The Azure role assignments. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -336,70 +257,92 @@ * **recoveryNetworkId**: string: Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. +## CreateProtectionContainerInputProperties +### Properties +* **fabricFriendlyName**: string (ReadOnly): Fabric friendly name. +* **fabricSpecificDetails**: [ProtectionContainerFabricSpecificDetails](#protectioncontainerfabricspecificdetails) (ReadOnly): Base class for fabric specific details of container. +* **fabricType**: string (ReadOnly): The fabric type. +* **friendlyName**: string (ReadOnly): The name. +* **pairingStatus**: string (ReadOnly): The pairing status of this cloud. +* **protectedItemCount**: int (ReadOnly): Number of protected PEs +* **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. +* **role**: string (ReadOnly): The role of this cloud. -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. +## CreateProtectionContainerMappingInputProperties +### Properties +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. -## CreateProtectionContainerInputProperties +## CurrentJobDetails ### Properties -* **fabricFriendlyName**: string (ReadOnly): Fabric friendly name. -* **fabricSpecificDetails**: [ProtectionContainerFabricSpecificDetails](#protectioncontainerfabricspecificdetails) (ReadOnly): Base class for fabric specific details of container. -* **fabricType**: string (ReadOnly): The fabric type. -* **friendlyName**: string (ReadOnly): The name. -* **pairingStatus**: string (ReadOnly): The pairing status of this cloud. -* **protectedItemCount**: int (ReadOnly): Number of protected PEs -* **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. -* **role**: string (ReadOnly): The role of this cloud. +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. -## ProtectionContainerFabricSpecificDetails +## CurrentScenarioDetails ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. -## ReplicationProviderSpecificContainerCreationInput -* **Discriminator**: instanceType +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. -### Base Properties -### A2AContainerCreationInput -#### Properties -* **instanceType**: 'A2A' (Required): The class type. +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. ## EnableMigrationInputProperties ### Properties @@ -419,12 +362,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -462,41 +399,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The disk type. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The disk type. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -527,12 +429,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -766,154 +662,142 @@ * **instanceType**: 'San' (Required): The class type. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key url / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskType**: string (ReadOnly): The type of disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmManagedDiskInputDetails -### Properties -* **diskId**: string (WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **ipAddressType**: string (ReadOnly): Ip address type. -* **nicId**: string (ReadOnly): The nic Id. -* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. -* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **vMNetworkName**: string (ReadOnly): VM network name. -* **vMSubnetName**: string (ReadOnly): VM subnet name. +## FabricSpecificCreationInput +* **Discriminator**: instanceType + +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. + +### HyperVSiteDetails +#### Properties +* **instanceType**: 'HyperVSite' (Required): Gets the class type. + +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **roleAssignments**: [RoleAssignment](#roleassignment)[] (ReadOnly): The Azure role assignments. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## InputEndpoint + +## HealthError ### Properties -* **endpointName**: string (ReadOnly): The input endpoint name. -* **privatePort**: int (ReadOnly): The input endpoint private port. -* **protocol**: string (ReadOnly): The input endpoint protocol. -* **publicPort**: int (ReadOnly): The input endpoint public port. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## RoleAssignment +## IdentityProviderDetails ### Properties -* **id**: string (ReadOnly): The ARM Id of the role assignment. -* **name**: string (ReadOnly): The name of the role assignment. -* **principalId**: string (ReadOnly): Principal Id. -* **roleDefinitionId**: string (ReadOnly): Role definition id. -* **scope**: string (ReadOnly): Role assignment scope. +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -## AzureToAzureVmSyncedConfigDetailsTags +## IdentityProviderInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ## InitialReplicationDetails ### Properties * **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. * **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails -### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. - -## AzureVmDiskDetails -### Properties -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. - -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -921,10 +805,23 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2ProtectedDiskDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **healthErrorCode**: string (ReadOnly): The health error code for the disk. +* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. +* **protectionStage**: string (ReadOnly): The protection stage. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. +* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. +* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. ## InMageDiskExclusionInput ### Properties @@ -935,17 +832,6 @@ ### Properties * **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. -## InMageVolumeExclusionOptions -### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. - -## OSDiskDetails -### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. - ## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -964,144 +850,103 @@ * **sourceDataInMB**: int (ReadOnly): The source data transit in MB. * **targetDataInMB**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2ProtectedDiskDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. -* **healthErrorCode**: string (ReadOnly): The health error code for the disk. -* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. -* **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. -* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. -* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. -* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. +### Additional Properties +* **Additional Properties Type**: string -## CreateProtectionContainerMappingInputProperties +## InMageVolumeExclusionOptions ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. +## InnerHealthError +### Properties +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. +## InputEndpoint +### Properties +* **endpointName**: string (ReadOnly): The input endpoint name. +* **privatePort**: int (ReadOnly): The input endpoint private port. +* **protocol**: string (ReadOnly): The input endpoint protocol. +* **publicPort**: int (ReadOnly): The input endpoint public port. -## AddRecoveryServicesProviderInputProperties +## KeyEncryptionKeyInfo ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineName**: string (Required, WriteOnly): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **keyIdentifier**: string (WriteOnly): The key url / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for key. -## IdentityProviderDetails +## MasterTargetServer ### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status -## IdentityProviderInput +## MobilityServiceUpdate ### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType -## AddVCenterRequestProperties +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1286,30 +1131,63 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateRecoveryPlanInputProperties +## ProcessServer ### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status -## RecoveryPlanGroup +## ProtectionContainerFabricSpecificDetails ### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails +* **Discriminator**: instanceType + +### Base Properties +### A2AProtectionContainerMappingDetails +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. + +### VMwareCbtProtectionContainerMappingDetails +#### Properties +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. + ## RecoveryPlanAction ### Properties @@ -1342,8 +1220,130 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. * **virtualMachineId**: string: The virtual machine Id. +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RoleAssignment +### Properties +* **id**: string (ReadOnly): The ARM Id of the role assignment. +* **name**: string (ReadOnly): The name of the role assignment. +* **principalId**: string (ReadOnly): Principal Id. +* **roleDefinitionId**: string (ReadOnly): Role definition id. +* **scope**: string (ReadOnly): Role assignment scope. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **ipAddressType**: string (ReadOnly): Ip address type. +* **nicId**: string (ReadOnly): The nic Id. +* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. +* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **vMNetworkName**: string (ReadOnly): VM network name. +* **vMSubnetName**: string (ReadOnly): VM subnet name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The disk type. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The disk type. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.md index 400e3e8bd0..566aef6669 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2018-07-10/types.md @@ -140,326 +140,180 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties -### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. - -## FabricCreationInputProperties -### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. - -### HyperVSiteDetails -#### Properties -* **instanceType**: 'HyperVSite' (Required): Gets the class type. - -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **authCertificate**: string (WriteOnly): The certificate to be used for AAD authentication. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **vmwareSiteId**: string: The ARM Id of the VMware site. - -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. - -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. - -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. - - -## AgentDetails -### Properties -* **agentId**: string (ReadOnly): The Id of the agent running on the server. -* **biosId**: string (ReadOnly): The machine BIOS Id. -* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The details of agent disks. -* **fqdn**: string (ReadOnly): The machine FQDN. -* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. - -## AgentDiskDetails +## A2AProtectedDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk Id. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskName**: string (ReadOnly): The disk name. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lunId**: int (ReadOnly): The lun of disk. - -## DraDetails -### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **version**: string (ReadOnly): The DRA version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -## ProcessServerDetails +## A2AProtectedManagedDiskDetails ### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **id**: string (ReadOnly): The process server Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The process server version. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## PushInstallerDetails +## A2AProtectionIntentDiskInputDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The push installer version. +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery VHD storage account Id. -## RcmProxyDetails +## A2AProtectionIntentManagedDiskInputDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The RCM proxy version. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Arm Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails) (WriteOnly): Recovery Resource Group custom input. +* **recoveryResourceGroupId**: string (ReadOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## ReplicationAgentDetails +## A2AUnprotectedDiskDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The replication agent version. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -## ReprotectAgentDetails +## A2AVmDiskInputDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **version**: string (ReadOnly): The version. +* **diskUri**: string (WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. -## IdentityProviderInput +## A2AVmManagedDiskInputDetails ### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## VersionDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string (WriteOnly): The Id of the machine where the provider is getting added. +* **machineName**: string (Required, WriteOnly): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. -## MasterTargetServer +## AddVCenterRequestProperties ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. -## DataStore +## AgentDetails ### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. +* **agentId**: string (ReadOnly): The Id of the agent running on the server. +* **biosId**: string (ReadOnly): The machine BIOS Id. +* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The details of agent disks. +* **fqdn**: string (ReadOnly): The machine FQDN. +* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. -## RetentionVolume +## AgentDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk Id. +* **diskName**: string (ReadOnly): The disk name. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lunId**: int (ReadOnly): The lun of disk. -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -475,42 +329,11 @@ * **recoveryNetworkId**: string: Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input ## CreateProtectionContainerInputProperties ### Properties @@ -523,22 +346,133 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: '6c7da455-506f-43ff-a16a-8eb101aebb70' (Required): The class type. - -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto protection is enabled. +* **autoProtectionOfDataDiskStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **policyId**: string (ReadOnly): The ID of Policy governing this PE. +* **primaryContainerFriendlyName**: string (ReadOnly): The primary container Name. +* **primaryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetId**: string (ReadOnly): The recovery availability set Id. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryBootDiagStorageAccountId**: string (ReadOnly): The boot diagnostic storage account. +* **recoveryContainerFriendlyName**: string (ReadOnly): The recovery container Name. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupId**: string (ReadOnly): The recovery proximity placement group custom details. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkId**: string (ReadOnly): The recovery virtual network Id. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. + + +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for secret. +* **secretIdentifier**: string (WriteOnly): The secret URL / identifier. +## DraDetails +### Properties +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **version**: string (ReadOnly): The DRA version. ## EnableMigrationInputProperties ### Properties @@ -553,14 +487,8 @@ * **policyId**: string (Required): The policy Id. * **providerSpecificDetails**: [EnableMigrationProviderSpecificInput](#enablemigrationproviderspecificinput) (Required): Enable migration provider specific input. * **recoveryServicesProviderId**: string (ReadOnly): The recovery services provider ARM Id. -* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. -* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. - -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. +* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. +* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -589,39 +517,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The disk type. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -652,12 +547,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -968,180 +857,163 @@ * **instanceType**: 'San' (Required): The class type. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for secret. -* **secretIdentifier**: string (WriteOnly): The secret URL / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the test failover NIC has accelerated networking enabled. -* **ipAddressType**: string (ReadOnly): Ip address type. -* **nicId**: string (ReadOnly): The nic Id. -* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): The target backend address pools for the NIC. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryPublicIpAddressId**: string (ReadOnly): The id of the public IP address resource associated with the NIC. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **tfoIPConfigs**: [IPConfig](#ipconfig)[] (ReadOnly): The IP configurations to be used by NIC during test failover. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **tfoVMSubnetName**: string (ReadOnly): The subnet to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. -* **vMSubnetName**: string (ReadOnly): VM subnet name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. -## IPConfig -### Properties -* **lBBackendAddressPoolIds**: string[] (ReadOnly): The backend address pools associated with the IP configuration. -* **publicIpAddressId**: string (ReadOnly): The Id of the public IP address associated with the IP configuration. -* **staticIPAddress**: string (ReadOnly): The static IP address of the IP configuration. +### HyperVSiteDetails +#### Properties +* **instanceType**: 'HyperVSite' (Required): Gets the class type. + +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **authCertificate**: string (WriteOnly): The certificate to be used for AAD authentication. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **vmwareSiteId**: string: The ARM Id of the VMware site. + +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. + +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## AzureToAzureVmSyncedConfigDetails + +## HealthError ### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InputEndpoint +## IdentityProviderDetails ### Properties -* **endpointName**: string (ReadOnly): The input endpoint name. -* **privatePort**: int (ReadOnly): The input endpoint private port. -* **protocol**: string (ReadOnly): The input endpoint protocol. -* **publicPort**: int (ReadOnly): The input endpoint public port. +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -## AzureToAzureVmSyncedConfigDetailsTags +## IdentityProviderInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ## InitialReplicationDetails ### Properties * **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. * **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails -### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. - -## AzureVmDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. - -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1149,79 +1021,63 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageDiskExclusionInput -### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. - -## InMageDiskSignatureExclusionOptions -### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. - -## InMageVolumeExclusionOptions +## InMageAzureV2DiskInputDetails ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. * **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. * **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1242,16 +1098,16 @@ ### Additional Properties * **Additional Properties Type**: string -## InMageRcmDisksDefaultInput +## InMageRcmDiskInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The disk encryption set ARM Id. +* **diskId**: string (WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The disk encryption set ARM Id. -* **diskId**: string (WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The log storage account ARM Id. @@ -1286,18 +1142,6 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. -## InMageRcmProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **diskName**: string (ReadOnly): The disk name. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - ## InMageRcmNicDetails ### Properties * **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. @@ -1314,120 +1158,121 @@ * **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. * **testSubnetName**: string (ReadOnly): Test subnet name. -## CreateProtectionContainerMappingInputProperties +## InMageRcmProtectedDiskDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **diskName**: string (ReadOnly): The disk name. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType +## InMageReplicationDetailsConsistencyPoints +### Properties +### Additional Properties +* **Additional Properties Type**: string -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. +## InMageVolumeExclusionOptions +### Properties +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. +## InnerHealthError +### Properties +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. + +## InputEndpoint +### Properties +* **endpointName**: string (ReadOnly): The input endpoint name. +* **privatePort**: int (ReadOnly): The input endpoint private port. +* **protocol**: string (ReadOnly): The input endpoint protocol. +* **publicPort**: int (ReadOnly): The input endpoint public port. + +## IPConfig +### Properties +* **lBBackendAddressPoolIds**: string[] (ReadOnly): The backend address pools associated with the IP configuration. +* **publicIpAddressId**: string (ReadOnly): The Id of the public IP address associated with the IP configuration. +* **staticIPAddress**: string (ReadOnly): The static IP address of the IP configuration. + +## KeyEncryptionKeyInfo +### Properties +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. + +## MasterTargetServer +### Properties +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status +## MobilityServiceUpdate +### Properties +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## ReplicationProviderSpecificContainerMappingInput +## NetworkMappingFabricSpecificSettings * **Discriminator**: instanceType ### Base Properties -### A2AContainerMappingInput +### AzureToAzureNetworkMappingSettings #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. -### VMwareCbtContainerMappingInput +### VmmToAzureNetworkMappingSettings #### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - - -## AddRecoveryServicesProviderInputProperties -### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string (WriteOnly): The Id of the machine where the provider is getting added. -* **machineName**: string (Required, WriteOnly): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. -## AddVCenterRequestProperties +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1628,61 +1473,91 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **id**: string (ReadOnly): The process server Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The process server version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto protection is enabled. -* **autoProtectionOfDataDiskStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **policyId**: string (ReadOnly): The ID of Policy governing this PE. -* **primaryContainerFriendlyName**: string (ReadOnly): The primary container Name. -* **primaryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetId**: string (ReadOnly): The recovery availability set Id. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryBootDiagStorageAccountId**: string (ReadOnly): The boot diagnostic storage account. -* **recoveryContainerFriendlyName**: string (ReadOnly): The recovery container Name. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupId**: string (ReadOnly): The recovery proximity placement group custom details. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkId**: string (ReadOnly): The recovery virtual network Id. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - - -## StorageAccountCustomDetails -* **Discriminator**: resourceType +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -1699,105 +1574,39 @@ * **appConsistentFrequencyInMinutes**: int (WriteOnly): The app consistent snapshot frequency (in minutes). * **crashConsistentFrequencyInMinutes**: int (WriteOnly): The crash consistent snapshot frequency (in minutes). * **multiVmSyncStatus**: 'Disable' | 'Enable' | string (Required, WriteOnly): A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. -* **policyName**: string (Required, WriteOnly): The protection profile input. -* **recoveryPointHistory**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -* **resourceType**: 'New' (Required): The class type. - - -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **policyName**: string (Required, WriteOnly): The protection profile input. +* **recoveryPointHistory**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. * **resourceType**: 'New' (Required): The class type. -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery VHD storage account Id. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The push installer version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Arm Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails) (WriteOnly): Recovery Resource Group custom input. -* **recoveryResourceGroupId**: string (ReadOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The RCM proxy version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string (WriteOnly): The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -1829,6 +1638,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -1856,7 +1672,191 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string (WriteOnly): The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The replication agent version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: '6c7da455-506f-43ff-a16a-8eb101aebb70' (Required): The class type. + +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string (Required): The migration solution Id. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the test failover NIC has accelerated networking enabled. +* **ipAddressType**: string (ReadOnly): Ip address type. +* **nicId**: string (ReadOnly): The nic Id. +* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): The target backend address pools for the NIC. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryPublicIpAddressId**: string (ReadOnly): The id of the public IP address resource associated with the NIC. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **tfoIPConfigs**: [IPConfig](#ipconfig)[] (ReadOnly): The IP configurations to be used by NIC during test failover. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **tfoVMSubnetName**: string (ReadOnly): The subnet to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. +* **vMSubnetName**: string (ReadOnly): VM subnet name. + +## VMwareCbtDiskInput +### Properties +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The disk type. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.md index f74a9c4702..766ed5e331 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-02-10/types.md @@ -140,378 +140,188 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties -### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. - -## FabricCreationInputProperties -### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. - -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. - -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. - -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. - -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. - - -## A2AZoneDetails -### Properties -* **source**: string (ReadOnly): Source zone info. -* **target**: string (ReadOnly): The target zone info. - -## HyperVHostDetails -### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. - -## AgentDetails -### Properties -* **agentId**: string (ReadOnly): The Id of the agent running on the server. -* **biosId**: string (ReadOnly): The machine BIOS Id. -* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The disks. -* **fqdn**: string (ReadOnly): The machine FQDN. -* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. - -## AgentDiskDetails +## A2AProtectedDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk Id. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskName**: string (ReadOnly): The disk name. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lunId**: int (ReadOnly): The lun of disk. - -## DraDetails -### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **version**: string (ReadOnly): The version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## MarsAgentDetails +## A2AProtectedManagedDiskDetails ### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## ProcessServerDetails +## A2AProtectionIntentDiskInputDetails ### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -## PushInstallerDetails +## A2AProtectionIntentManagedDiskInputDetails ### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## RcmProxyDetails +## A2AUnprotectedDiskDetails ### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -## ReplicationAgentDetails +## A2AVmDiskInputDetails ### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## ReprotectAgentDetails +## A2AVmManagedDiskInputDetails ### Properties -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **version**: string (ReadOnly): The version. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## IdentityProviderInput +## A2AZoneDetails ### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **source**: string (ReadOnly): Source zone info. +* **target**: string (ReadOnly): The target zone info. -## VersionDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. -## MasterTargetServer +## AddVCenterRequestProperties ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. -## DataStore +## AgentDetails ### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. +* **agentId**: string (ReadOnly): The Id of the agent running on the server. +* **biosId**: string (ReadOnly): The machine BIOS Id. +* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The disks. +* **fqdn**: string (ReadOnly): The machine FQDN. +* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. -## RetentionVolume +## AgentDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk Id. +* **diskName**: string (ReadOnly): The disk name. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lunId**: int (ReadOnly): The lun of disk. -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -527,42 +337,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -575,26 +354,129 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. + +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -609,16 +491,10 @@ * **migrationState**: 'DisableMigrationFailed' | 'DisableMigrationInProgress' | 'EnableMigrationFailed' | 'EnableMigrationInProgress' | 'InitialSeedingFailed' | 'InitialSeedingInProgress' | 'MigrationFailed' | 'MigrationInProgress' | 'MigrationSucceeded' | 'None' | 'Replicating' | string (ReadOnly): The migration status. * **migrationStateDescription**: string (ReadOnly): The migration state description. * **policyFriendlyName**: string (ReadOnly): The name of policy governing this item. -* **policyId**: string (Required): The policy Id. -* **providerSpecificDetails**: [EnableMigrationProviderSpecificInput](#enablemigrationproviderspecificinput) (Required): Enable migration provider specific input. -* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. -* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. - -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. +* **policyId**: string (Required): The policy Id. +* **providerSpecificDetails**: [EnableMigrationProviderSpecificInput](#enablemigrationproviderspecificinput) (Required): Enable migration provider specific input. +* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. +* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -665,63 +541,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -753,12 +572,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1140,178 +953,152 @@ * **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## DiskDetails + +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1320,22 +1107,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1356,6 +1127,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1363,44 +1162,53 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. + +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1410,29 +1218,31 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1442,35 +1252,8 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1491,18 +1274,62 @@ ### Additional Properties * **Additional Properties Type**: string -## InMageRcmDisksDefaultInput +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + +## InMageRcmDisksDefaultInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -## InMageRcmDiskInput +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1536,6 +1363,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1564,187 +1407,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackMobilityAgentDetails +## InMageVolumeExclusionOptions ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackProtectedDiskDetails +## InnerHealthError ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackSyncDetails +## InputEndpoint ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackNicDetails +## IPConfigDetails ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## CreateProtectionContainerMappingInputProperties +## KeyEncryptionKeyInfo ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## MarsAgentDetails +### Properties +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## IdentityProviderDetails +## MobilityServiceUpdate ### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType -## AddVCenterRequestProperties +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1928,56 +1719,105 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -1999,96 +1839,40 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2120,6 +1904,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2147,7 +1938,216 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string (Required): The migration solution Id. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.md index e0f4ef6320..cf3a2a5fbe 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-03-01/types.md @@ -140,326 +140,180 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties -### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. - -## FabricCreationInputProperties -### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. - -### HyperVSiteDetails -#### Properties -* **instanceType**: 'HyperVSite' (Required): Gets the class type. - -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **authCertificate**: string (WriteOnly): The certificate to be used for AAD authentication. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **vmwareSiteId**: string: The ARM Id of the VMware site. - -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. - -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. - -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. - - -## AgentDetails -### Properties -* **agentId**: string (ReadOnly): The Id of the agent running on the server. -* **biosId**: string (ReadOnly): The machine BIOS Id. -* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The details of agent disks. -* **fqdn**: string (ReadOnly): The machine FQDN. -* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. - -## AgentDiskDetails +## A2AProtectedDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk Id. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskName**: string (ReadOnly): The disk name. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lunId**: int (ReadOnly): The lun of disk. - -## DraDetails -### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **version**: string (ReadOnly): The DRA version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -## ProcessServerDetails +## A2AProtectedManagedDiskDetails ### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **id**: string (ReadOnly): The process server Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The process server version. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## PushInstallerDetails +## A2AProtectionIntentDiskInputDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The push installer version. +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery VHD storage account Id. -## RcmProxyDetails +## A2AProtectionIntentManagedDiskInputDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The RCM proxy version. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Arm Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails) (WriteOnly): Recovery Resource Group custom input. +* **recoveryResourceGroupId**: string (ReadOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## ReplicationAgentDetails +## A2AUnprotectedDiskDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The replication agent version. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -## ReprotectAgentDetails +## A2AVmDiskInputDetails ### Properties -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **version**: string (ReadOnly): The version. +* **diskUri**: string (WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. -## IdentityProviderInput +## A2AVmManagedDiskInputDetails ### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## VersionDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string (WriteOnly): The Id of the machine where the provider is getting added. +* **machineName**: string (Required, WriteOnly): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. -## MasterTargetServer +## AddVCenterRequestProperties ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. -## DataStore +## AgentDetails ### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. +* **agentId**: string (ReadOnly): The Id of the agent running on the server. +* **biosId**: string (ReadOnly): The machine BIOS Id. +* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The details of agent disks. +* **fqdn**: string (ReadOnly): The machine FQDN. +* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. -## RetentionVolume +## AgentDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk Id. +* **diskName**: string (ReadOnly): The disk name. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lunId**: int (ReadOnly): The lun of disk. -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -475,42 +329,11 @@ * **recoveryNetworkId**: string: Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input ## CreateProtectionContainerInputProperties ### Properties @@ -523,22 +346,133 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: '6c7da455-506f-43ff-a16a-8eb101aebb70' (Required): The class type. - -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto protection is enabled. +* **autoProtectionOfDataDiskStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **policyId**: string (ReadOnly): The ID of Policy governing this PE. +* **primaryContainerFriendlyName**: string (ReadOnly): The primary container Name. +* **primaryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetId**: string (ReadOnly): The recovery availability set Id. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **recoveryBootDiagStorageAccountId**: string (ReadOnly): The boot diagnostic storage account. +* **recoveryContainerFriendlyName**: string (ReadOnly): The recovery container Name. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupId**: string (ReadOnly): The recovery proximity placement group custom details. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkId**: string (ReadOnly): The recovery virtual network Id. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. + + +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for secret. +* **secretIdentifier**: string (WriteOnly): The secret URL / identifier. +## DraDetails +### Properties +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **version**: string (ReadOnly): The DRA version. ## EnableMigrationInputProperties ### Properties @@ -553,14 +487,8 @@ * **policyId**: string (Required): The policy Id. * **providerSpecificDetails**: [EnableMigrationProviderSpecificInput](#enablemigrationproviderspecificinput) (Required): Enable migration provider specific input. * **recoveryServicesProviderId**: string (ReadOnly): The recovery services provider ARM Id. -* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. -* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. - -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. +* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. +* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -589,39 +517,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The disk type. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -652,12 +547,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -968,180 +857,163 @@ * **instanceType**: 'San' (Required): The class type. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for secret. -* **secretIdentifier**: string (WriteOnly): The secret URL / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the test failover NIC has accelerated networking enabled. -* **ipAddressType**: string (ReadOnly): Ip address type. -* **nicId**: string (ReadOnly): The nic Id. -* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): The target backend address pools for the NIC. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryPublicIpAddressId**: string (ReadOnly): The id of the public IP address resource associated with the NIC. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **tfoIPConfigs**: [IPConfig](#ipconfig)[] (ReadOnly): The IP configurations to be used by NIC during test failover. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **tfoVMSubnetName**: string (ReadOnly): The subnet to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. -* **vMSubnetName**: string (ReadOnly): VM subnet name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. -## IPConfig -### Properties -* **lBBackendAddressPoolIds**: string[] (ReadOnly): The backend address pools associated with the IP configuration. -* **publicIpAddressId**: string (ReadOnly): The Id of the public IP address associated with the IP configuration. -* **staticIPAddress**: string (ReadOnly): The static IP address of the IP configuration. +### HyperVSiteDetails +#### Properties +* **instanceType**: 'HyperVSite' (Required): Gets the class type. + +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **authCertificate**: string (WriteOnly): The certificate to be used for AAD authentication. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **vmwareSiteId**: string: The ARM Id of the VMware site. + +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. + +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## AzureToAzureVmSyncedConfigDetails + +## HealthError ### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InputEndpoint +## IdentityProviderDetails ### Properties -* **endpointName**: string (ReadOnly): The input endpoint name. -* **privatePort**: int (ReadOnly): The input endpoint private port. -* **protocol**: string (ReadOnly): The input endpoint protocol. -* **publicPort**: int (ReadOnly): The input endpoint public port. +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -## AzureToAzureVmSyncedConfigDetailsTags +## IdentityProviderInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. ## InitialReplicationDetails ### Properties * **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. * **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails -### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. - -## AzureVmDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. - -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1149,79 +1021,63 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageDiskExclusionInput -### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. - -## InMageDiskSignatureExclusionOptions -### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. - -## InMageVolumeExclusionOptions +## InMageAzureV2DiskInputDetails ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. * **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. * **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1242,16 +1098,16 @@ ### Additional Properties * **Additional Properties Type**: string -## InMageRcmDisksDefaultInput +## InMageRcmDiskInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The disk encryption set ARM Id. +* **diskId**: string (WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The disk encryption set ARM Id. -* **diskId**: string (WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The log storage account ARM Id. @@ -1286,18 +1142,6 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. -## InMageRcmProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **diskName**: string (ReadOnly): The disk name. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - ## InMageRcmNicDetails ### Properties * **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. @@ -1314,120 +1158,121 @@ * **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. * **testSubnetName**: string (ReadOnly): Test subnet name. -## CreateProtectionContainerMappingInputProperties +## InMageRcmProtectedDiskDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **diskName**: string (ReadOnly): The disk name. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType +## InMageReplicationDetailsConsistencyPoints +### Properties +### Additional Properties +* **Additional Properties Type**: string -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. +## InMageVolumeExclusionOptions +### Properties +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. +## InnerHealthError +### Properties +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC) +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. + +## InputEndpoint +### Properties +* **endpointName**: string (ReadOnly): The input endpoint name. +* **privatePort**: int (ReadOnly): The input endpoint private port. +* **protocol**: string (ReadOnly): The input endpoint protocol. +* **publicPort**: int (ReadOnly): The input endpoint public port. + +## IPConfig +### Properties +* **lBBackendAddressPoolIds**: string[] (ReadOnly): The backend address pools associated with the IP configuration. +* **publicIpAddressId**: string (ReadOnly): The Id of the public IP address associated with the IP configuration. +* **staticIPAddress**: string (ReadOnly): The static IP address of the IP configuration. + +## KeyEncryptionKeyInfo +### Properties +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. + +## MasterTargetServer +### Properties +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status +## MobilityServiceUpdate +### Properties +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## ReplicationProviderSpecificContainerMappingInput +## NetworkMappingFabricSpecificSettings * **Discriminator**: instanceType ### Base Properties -### A2AContainerMappingInput +### AzureToAzureNetworkMappingSettings #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. -### VMwareCbtContainerMappingInput +### VmmToAzureNetworkMappingSettings #### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - - -## AddRecoveryServicesProviderInputProperties -### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string (WriteOnly): The Id of the machine where the provider is getting added. -* **machineName**: string (Required, WriteOnly): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. -## AddVCenterRequestProperties +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1628,61 +1473,91 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **id**: string (ReadOnly): The process server Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The process server version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto protection is enabled. -* **autoProtectionOfDataDiskStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **policyId**: string (ReadOnly): The ID of Policy governing this PE. -* **primaryContainerFriendlyName**: string (ReadOnly): The primary container Name. -* **primaryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetId**: string (ReadOnly): The recovery availability set Id. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryBootDiagStorageAccountId**: string (ReadOnly): The boot diagnostic storage account. -* **recoveryContainerFriendlyName**: string (ReadOnly): The recovery container Name. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric Name. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupId**: string (ReadOnly): The recovery proximity placement group custom details. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkId**: string (ReadOnly): The recovery virtual network Id. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - - -## StorageAccountCustomDetails -* **Discriminator**: resourceType +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -1699,105 +1574,39 @@ * **appConsistentFrequencyInMinutes**: int (WriteOnly): The app consistent snapshot frequency (in minutes). * **crashConsistentFrequencyInMinutes**: int (WriteOnly): The crash consistent snapshot frequency (in minutes). * **multiVmSyncStatus**: 'Disable' | 'Enable' | string (Required, WriteOnly): A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. -* **policyName**: string (Required, WriteOnly): The protection profile input. -* **recoveryPointHistory**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -* **resourceType**: 'New' (Required): The class type. - - -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **policyName**: string (Required, WriteOnly): The protection profile input. +* **recoveryPointHistory**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. * **resourceType**: 'New' (Required): The class type. -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery VHD storage account Id. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The push installer version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account Arm Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails) (WriteOnly): Recovery Resource Group custom input. -* **recoveryResourceGroupId**: string (ReadOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The RCM proxy version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string (WriteOnly): The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -1829,6 +1638,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -1856,7 +1672,191 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string (WriteOnly): The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The replication agent version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: '6c7da455-506f-43ff-a16a-8eb101aebb70' (Required): The class type. + +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health of the DRA. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string (Required): The migration solution Id. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the test failover NIC has accelerated networking enabled. +* **ipAddressType**: string (ReadOnly): Ip address type. +* **nicId**: string (ReadOnly): The nic Id. +* **primaryNicStaticIPAddress**: string (ReadOnly): Primary nic static IP address. +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): The target backend address pools for the NIC. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicIpAddressType**: string (ReadOnly): IP allocation type for recovery VM. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryPublicIpAddressId**: string (ReadOnly): The id of the public IP address resource associated with the NIC. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **recoveryVMSubnetName**: string (ReadOnly): Recovery VM subnet name. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **replicaNicStaticIPAddress**: string (ReadOnly): Replica nic static IP address. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **tfoIPConfigs**: [IPConfig](#ipconfig)[] (ReadOnly): The IP configurations to be used by NIC during test failover. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **tfoVMSubnetName**: string (ReadOnly): The subnet to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. +* **vMSubnetName**: string (ReadOnly): VM subnet name. + +## VMwareCbtDiskInput +### Properties +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The disk type. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.md index 96aaf81420..cfefdcde6d 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-04-01/types.md @@ -140,378 +140,188 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties -### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. - -## FabricCreationInputProperties -### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. - -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. - -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. - -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. - -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. - - -## A2AZoneDetails -### Properties -* **source**: string (ReadOnly): Source zone info. -* **target**: string (ReadOnly): The target zone info. - -## HyperVHostDetails -### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. - -## AgentDetails -### Properties -* **agentId**: string (ReadOnly): The Id of the agent running on the server. -* **biosId**: string (ReadOnly): The machine BIOS Id. -* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The disks. -* **fqdn**: string (ReadOnly): The machine FQDN. -* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. - -## AgentDiskDetails +## A2AProtectedDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The disk Id. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskName**: string (ReadOnly): The disk name. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lunId**: int (ReadOnly): The lun of disk. - -## DraDetails -### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **version**: string (ReadOnly): The version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## MarsAgentDetails +## A2AProtectedManagedDiskDetails ### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## ProcessServerDetails +## A2AProtectionIntentDiskInputDetails ### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -## PushInstallerDetails +## A2AProtectionIntentManagedDiskInputDetails ### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## RcmProxyDetails +## A2AUnprotectedDiskDetails ### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -## ReplicationAgentDetails +## A2AVmDiskInputDetails ### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## ReprotectAgentDetails +## A2AVmManagedDiskInputDetails ### Properties -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **version**: string (ReadOnly): The version. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -## IdentityProviderInput +## A2AZoneDetails ### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **source**: string (ReadOnly): Source zone info. +* **target**: string (ReadOnly): The target zone info. -## VersionDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. -## MasterTargetServer +## AddVCenterRequestProperties ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. -## DataStore +## AgentDetails ### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. +* **agentId**: string (ReadOnly): The Id of the agent running on the server. +* **biosId**: string (ReadOnly): The machine BIOS Id. +* **disks**: [AgentDiskDetails](#agentdiskdetails)[] (ReadOnly): The disks. +* **fqdn**: string (ReadOnly): The machine FQDN. +* **machineId**: string (ReadOnly): The Id of the machine to which the agent is registered. -## RetentionVolume +## AgentDiskDetails ### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk Id. +* **diskName**: string (ReadOnly): The disk name. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lunId**: int (ReadOnly): The lun of disk. -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -527,42 +337,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -575,26 +354,129 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. + +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -609,16 +491,10 @@ * **migrationState**: 'DisableMigrationFailed' | 'DisableMigrationInProgress' | 'EnableMigrationFailed' | 'EnableMigrationInProgress' | 'InitialSeedingFailed' | 'InitialSeedingInProgress' | 'MigrationFailed' | 'MigrationInProgress' | 'MigrationSucceeded' | 'None' | 'Replicating' | string (ReadOnly): The migration status. * **migrationStateDescription**: string (ReadOnly): The migration state description. * **policyFriendlyName**: string (ReadOnly): The name of policy governing this item. -* **policyId**: string (Required): The policy Id. -* **providerSpecificDetails**: [EnableMigrationProviderSpecificInput](#enablemigrationproviderspecificinput) (Required): Enable migration provider specific input. -* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. -* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. - -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. +* **policyId**: string (Required): The policy Id. +* **providerSpecificDetails**: [EnableMigrationProviderSpecificInput](#enablemigrationproviderspecificinput) (Required): Enable migration provider specific input. +* **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. +* **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -665,63 +541,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -753,12 +572,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1140,178 +953,152 @@ * **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## DiskDetails + +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1320,22 +1107,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1356,6 +1127,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1363,44 +1162,53 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. + +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1410,29 +1218,31 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1442,35 +1252,8 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1491,18 +1274,62 @@ ### Additional Properties * **Additional Properties Type**: string -## InMageRcmDisksDefaultInput +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + +## InMageRcmDisksDefaultInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -## InMageRcmDiskInput +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1536,6 +1363,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1564,187 +1407,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackMobilityAgentDetails +## InMageVolumeExclusionOptions ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackProtectedDiskDetails +## InnerHealthError ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackSyncDetails +## InputEndpoint ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackNicDetails +## IPConfigDetails ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## CreateProtectionContainerMappingInputProperties +## KeyEncryptionKeyInfo ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## MarsAgentDetails +### Properties +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## IdentityProviderDetails +## MobilityServiceUpdate ### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType -## AddVCenterRequestProperties +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1928,56 +1719,105 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -1999,96 +1839,40 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2120,6 +1904,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2147,7 +1938,216 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string (Required): The migration solution Id. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.md index 8091d7a21c..834e2a4ab9 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-06-01/types.md @@ -140,122 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -273,263 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails -### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -545,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -593,26 +355,131 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -632,12 +499,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -659,86 +520,29 @@ * **performAutoResync**: string: A value indicating whether auto resync is to be done. * **protectedDisks**: [VMwareCbtProtectedDiskDetails](#vmwarecbtprotecteddiskdetails)[] (ReadOnly): The list of protected disks. * **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required. -* **resyncRetryCount**: int (ReadOnly): The resync retry count. -* **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. -* **seedDiskTags**: [VMwareCbtEnableMigrationInputSeedDiskTags](#vmwarecbtenablemigrationinputseeddisktags): The tags for the seed disks. -* **snapshotRunAsAccountId**: string (Required): The snapshot run as account Id. -* **sqlServerLicenseType**: 'AHUB' | 'NoLicenseType' | 'NotSpecified' | 'PAYG' | string: The SQL Server license type. -* **targetAvailabilitySetId**: string: The target availability set ARM Id. -* **targetAvailabilityZone**: string: The target availability zone. -* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. -* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. -* **targetGeneration**: string (ReadOnly): The target generation. -* **targetLocation**: string (ReadOnly): The target location. -* **targetNetworkId**: string (Required): The target network ARM Id. -* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. -* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. -* **targetResourceGroupId**: string (Required): The target resource group ARM Id. -* **targetSubnetName**: string (WriteOnly): The target subnet name. -* **targetVmName**: string: The target VM name. -* **targetVmSize**: string: The target VM size. -* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. -* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. -* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. - - -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required. +* **resyncRetryCount**: int (ReadOnly): The resync retry count. +* **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. +* **seedDiskTags**: [VMwareCbtEnableMigrationInputSeedDiskTags](#vmwarecbtenablemigrationinputseeddisktags): The tags for the seed disks. +* **snapshotRunAsAccountId**: string (Required): The snapshot run as account Id. +* **sqlServerLicenseType**: 'AHUB' | 'NoLicenseType' | 'NotSpecified' | 'PAYG' | string: The SQL Server license type. +* **targetAvailabilitySetId**: string: The target availability set ARM Id. +* **targetAvailabilityZone**: string: The target availability zone. +* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. +* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. +* **targetGeneration**: string (ReadOnly): The target generation. +* **targetLocation**: string (ReadOnly): The target location. +* **targetNetworkId**: string (Required): The target network ARM Id. +* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. +* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. +* **targetResourceGroupId**: string (Required): The target resource group ARM Id. +* **targetSubnetName**: string (WriteOnly): The target subnet name. +* **targetVmName**: string: The target VM name. +* **targetVmSize**: string: The target VM size. +* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. +* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. +* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. ## EnableProtectionInputProperties ### Properties @@ -771,12 +575,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1166,180 +964,153 @@ * **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1348,22 +1119,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1384,6 +1139,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1391,44 +1174,54 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. + +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1438,29 +1231,31 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1470,36 +1265,8 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1535,18 +1302,77 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + ## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1580,6 +1406,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1608,194 +1450,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1979,56 +1762,107 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2050,96 +1884,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2171,6 +1950,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2198,8 +1984,222 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.md index 63cba5559b..16a9e78365 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-07-01/types.md @@ -140,122 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -273,263 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails -### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -545,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -593,26 +355,131 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -632,12 +499,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -659,86 +520,29 @@ * **performAutoResync**: string: A value indicating whether auto resync is to be done. * **protectedDisks**: [VMwareCbtProtectedDiskDetails](#vmwarecbtprotecteddiskdetails)[] (ReadOnly): The list of protected disks. * **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required. -* **resyncRetryCount**: int (ReadOnly): The resync retry count. -* **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. -* **seedDiskTags**: [VMwareCbtEnableMigrationInputSeedDiskTags](#vmwarecbtenablemigrationinputseeddisktags): The tags for the seed disks. -* **snapshotRunAsAccountId**: string (Required): The snapshot run as account Id. -* **sqlServerLicenseType**: 'AHUB' | 'NoLicenseType' | 'NotSpecified' | 'PAYG' | string: The SQL Server license type. -* **targetAvailabilitySetId**: string: The target availability set ARM Id. -* **targetAvailabilityZone**: string: The target availability zone. -* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. -* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. -* **targetGeneration**: string (ReadOnly): The target generation. -* **targetLocation**: string (ReadOnly): The target location. -* **targetNetworkId**: string (Required): The target network ARM Id. -* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. -* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. -* **targetResourceGroupId**: string (Required): The target resource group ARM Id. -* **targetSubnetName**: string (WriteOnly): The target subnet name. -* **targetVmName**: string: The target VM name. -* **targetVmSize**: string: The target VM size. -* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. -* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. -* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. - - -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required. +* **resyncRetryCount**: int (ReadOnly): The resync retry count. +* **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. +* **seedDiskTags**: [VMwareCbtEnableMigrationInputSeedDiskTags](#vmwarecbtenablemigrationinputseeddisktags): The tags for the seed disks. +* **snapshotRunAsAccountId**: string (Required): The snapshot run as account Id. +* **sqlServerLicenseType**: 'AHUB' | 'NoLicenseType' | 'NotSpecified' | 'PAYG' | string: The SQL Server license type. +* **targetAvailabilitySetId**: string: The target availability set ARM Id. +* **targetAvailabilityZone**: string: The target availability zone. +* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. +* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. +* **targetGeneration**: string (ReadOnly): The target generation. +* **targetLocation**: string (ReadOnly): The target location. +* **targetNetworkId**: string (Required): The target network ARM Id. +* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. +* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. +* **targetResourceGroupId**: string (Required): The target resource group ARM Id. +* **targetSubnetName**: string (WriteOnly): The target subnet name. +* **targetVmName**: string: The target VM name. +* **targetVmSize**: string: The target VM size. +* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. +* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. +* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. ## EnableProtectionInputProperties ### Properties @@ -771,12 +575,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1166,180 +964,153 @@ * **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1348,22 +1119,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1384,6 +1139,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1391,44 +1174,54 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. + +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1438,29 +1231,31 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1470,36 +1265,8 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1535,18 +1302,77 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + ## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1580,6 +1406,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1608,194 +1450,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1979,56 +1762,107 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2050,96 +1884,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2171,6 +1950,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2198,8 +1984,222 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.md index 67670c7438..9cf0d3fd4f 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-08-01/types.md @@ -140,122 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -273,263 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails -### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -545,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -593,26 +355,134 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string: The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -632,12 +502,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -666,79 +530,22 @@ * **snapshotRunAsAccountId**: string (Required): The snapshot run as account Id. * **sqlServerLicenseType**: 'AHUB' | 'NoLicenseType' | 'NotSpecified' | 'PAYG' | string: The SQL Server license type. * **targetAvailabilitySetId**: string: The target availability set ARM Id. -* **targetAvailabilityZone**: string: The target availability zone. -* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. -* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. -* **targetGeneration**: string (ReadOnly): The target generation. -* **targetLocation**: string (ReadOnly): The target location. -* **targetNetworkId**: string (Required): The target network ARM Id. -* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. -* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. -* **targetResourceGroupId**: string (Required): The target resource group ARM Id. -* **targetSubnetName**: string (WriteOnly): The target subnet name. -* **targetVmName**: string: The target VM name. -* **targetVmSize**: string: The target VM size. -* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. -* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. -* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. - - -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **targetAvailabilityZone**: string: The target availability zone. +* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. +* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. +* **targetGeneration**: string (ReadOnly): The target generation. +* **targetLocation**: string (ReadOnly): The target location. +* **targetNetworkId**: string (Required): The target network ARM Id. +* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. +* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. +* **targetResourceGroupId**: string (Required): The target resource group ARM Id. +* **targetSubnetName**: string (WriteOnly): The target subnet name. +* **targetVmName**: string: The target VM name. +* **targetVmSize**: string: The target VM size. +* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. +* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. +* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. ## EnableProtectionInputProperties ### Properties @@ -771,12 +578,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1167,180 +968,153 @@ * **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1349,22 +1123,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1385,6 +1143,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1392,44 +1178,54 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. + +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1439,29 +1235,31 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1471,36 +1269,8 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1536,18 +1306,77 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + ## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1581,6 +1410,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1609,196 +1454,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1982,59 +1766,108 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string: The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2056,96 +1889,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2177,6 +1955,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2204,8 +1989,223 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.md index 3d8e303589..bfed920aba 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-10-01/types.md @@ -140,122 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -273,263 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails -### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. - -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer +## AzureToAzureVmSyncedConfigDetails ### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## MobilityServiceUpdate +## AzureToAzureVmSyncedConfigDetailsTags ### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. +### Additional Properties +* **Additional Properties Type**: string -## RunAsAccount +## AzureVmDiskDetails ### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -545,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -593,26 +355,134 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string: The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. + +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -632,12 +502,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -666,79 +530,22 @@ * **snapshotRunAsAccountId**: string (Required): The snapshot run as account Id. * **sqlServerLicenseType**: 'AHUB' | 'NoLicenseType' | 'NotSpecified' | 'PAYG' | string: The SQL Server license type. * **targetAvailabilitySetId**: string: The target availability set ARM Id. -* **targetAvailabilityZone**: string: The target availability zone. -* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. -* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. -* **targetGeneration**: string (ReadOnly): The target generation. -* **targetLocation**: string (ReadOnly): The target location. -* **targetNetworkId**: string (Required): The target network ARM Id. -* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. -* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. -* **targetResourceGroupId**: string (Required): The target resource group ARM Id. -* **targetSubnetName**: string (WriteOnly): The target subnet name. -* **targetVmName**: string: The target VM name. -* **targetVmSize**: string: The target VM size. -* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. -* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. -* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. - - -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **targetAvailabilityZone**: string: The target availability zone. +* **targetBootDiagnosticsStorageAccountId**: string: The target boot diagnostics storage account ARM Id. +* **targetDiskTags**: [VMwareCbtEnableMigrationInputTargetDiskTags](#vmwarecbtenablemigrationinputtargetdisktags): The tags for the target disks. +* **targetGeneration**: string (ReadOnly): The target generation. +* **targetLocation**: string (ReadOnly): The target location. +* **targetNetworkId**: string (Required): The target network ARM Id. +* **targetNicTags**: [VMwareCbtEnableMigrationInputTargetNicTags](#vmwarecbtenablemigrationinputtargetnictags): The tags for the target NICs. +* **targetProximityPlacementGroupId**: string: The target proximity placement group ARM Id. +* **targetResourceGroupId**: string (Required): The target resource group ARM Id. +* **targetSubnetName**: string (WriteOnly): The target subnet name. +* **targetVmName**: string: The target VM name. +* **targetVmSize**: string: The target VM size. +* **targetVmTags**: [VMwareCbtEnableMigrationInputTargetVmTags](#vmwarecbtenablemigrationinputtargetvmtags): The target VM tags. +* **vmNics**: [VMwareCbtNicDetails](#vmwarecbtnicdetails)[] (ReadOnly): The network details. +* **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. ## EnableProtectionInputProperties ### Properties @@ -771,12 +578,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1167,180 +968,153 @@ * **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionInfo +## EncryptionDetails ### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. -## DiskEncryptionKeyInfo +## FabricCreationInputProperties ### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## KeyEncryptionKeyInfo -### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AProtectedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. + +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. -## DiskDetails +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1349,22 +1123,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1385,6 +1143,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1392,44 +1178,54 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. + +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. -## InMageProtectedDiskDetails +## InMageAzureV2ProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1439,29 +1235,31 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. +* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. +* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2DiskInputDetails +## InMageDiskExclusionInput ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2ProtectedDiskDetails +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageProtectedDiskDetails ### Properties * **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. * **diskId**: string (ReadOnly): The disk id. * **diskName**: string (ReadOnly): The disk name. * **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The disk file system capacity in bytes. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. * **healthErrorCode**: string (ReadOnly): The health error code for the disk. * **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. * **progressHealth**: string (ReadOnly): The Progress Health. * **progressStatus**: string (ReadOnly): The Progress Status. * **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMegaBytes**: int (ReadOnly): The PS data transit in MB. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. * **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. * **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. * **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. @@ -1471,36 +1269,8 @@ * **resyncStartTime**: string (ReadOnly): The resync start time. * **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. * **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. -* **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InMageAzureV2EnableProtectionInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties @@ -1536,18 +1306,77 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + ## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1581,6 +1410,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1609,196 +1454,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -1982,59 +1766,108 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string: The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2056,96 +1889,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2177,6 +1955,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2204,8 +1989,223 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.md index 0bc39a2566..f70b596c7b 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-11-01/types.md @@ -140,123 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -274,282 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails +## AzureToAzureVmSyncedConfigDetails ### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. - -## MobilityServiceUpdate -### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. - -## RunAsAccount -### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. - -## InMageFabricSwitchProviderBlockingErrorDetails -### Properties -* **errorCode**: string (ReadOnly): The error code. -* **errorMessage**: string (ReadOnly): The error message. -* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. -* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. -* **possibleCauses**: string (ReadOnly): The possible causes. -* **recommendedAction**: string (ReadOnly): The recommended action. - -## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters +## AzureToAzureVmSyncedConfigDetailsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags +## AzureVmDiskDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -565,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -613,26 +355,134 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string: The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. + +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -652,12 +502,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -703,63 +547,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -793,12 +580,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1190,190 +971,164 @@ * **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. * **resyncTransferredBytes**: int (ReadOnly): The resync transferred bytes from source VM to target for all selected disks on source VM. * **targetDataStoreName**: string (ReadOnly): The target datastore name. -* **targetvCenterId**: string (ReadOnly): The target vCenter Id. -* **targetVmName**: string (ReadOnly): The target VM name. -* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. - - -## DiskEncryptionInfo -### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **targetvCenterId**: string (ReadOnly): The target vCenter Id. +* **targetVmName**: string (ReadOnly): The target VM name. +* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionKeyInfo -### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. -## KeyEncryptionKeyInfo +## EncryptionDetails ### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. ## ExtendedLocation ### Properties * **name**: string (Required): The name of the extended location. * **type**: 'EdgeZone' | string (Required): The extended location type. -## A2AProtectedDiskDetails +## FabricCreationInputProperties ### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## DiskDetails +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. + +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. + + +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1382,22 +1137,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1418,6 +1157,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1425,62 +1192,40 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +### Additional Properties +* **Additional Properties Type**: string -## InMageProtectedDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. * **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. -* **healthErrorCode**: string (ReadOnly): The health error code for the disk. -* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. -* **progressHealth**: string (ReadOnly): The Progress Health. -* **progressStatus**: string (ReadOnly): The Progress Status. -* **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. -* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. -* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. -* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. -* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. -* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. -* **resyncStartTime**: string (ReadOnly): The resync start time. -* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. -* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2DiskInputDetails -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. ## InMageAzureV2ProtectedDiskDetails ### Properties @@ -1508,19 +1253,6 @@ * **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. * **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## InMageAzureV2SwitchProviderBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1547,21 +1279,59 @@ * **targetResourceId**: string (ReadOnly): The target resource Id. * **targetVaultId**: string (ReadOnly): The target vault Id. -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags +## InMageDiskExclusionInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2EnableProtectionInputTargetNicTags +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageFabricSwitchProviderBlockingErrorDetails +### Properties +* **errorCode**: string (ReadOnly): The error code. +* **errorMessage**: string (ReadOnly): The error message. +* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. +* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. +* **possibleCauses**: string (ReadOnly): The possible causes. +* **recommendedAction**: string (ReadOnly): The recommended action. + +## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageAzureV2EnableProtectionInputTargetVmTags +## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## InMageProtectedDiskDetails +### Properties +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **healthErrorCode**: string (ReadOnly): The health error code for the disk. +* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. +* **progressHealth**: string (ReadOnly): The Progress Health. +* **progressStatus**: string (ReadOnly): The Progress Status. +* **protectionStage**: string (ReadOnly): The protection stage. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. +* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. +* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. +* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. +* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. +* **resyncStartTime**: string (ReadOnly): The resync start time. +* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. +* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. + ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1596,18 +1366,77 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + ## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1641,6 +1470,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1669,196 +1514,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -2042,59 +1826,108 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string: The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2116,96 +1949,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2237,6 +2015,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2266,8 +2051,223 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (Required, WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (Required, WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (Required, WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (Required, WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.md index ebc87fc95a..2c5ac64b60 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2021-12-01/types.md @@ -140,123 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -274,282 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails +## AzureToAzureVmSyncedConfigDetails ### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. - -## MobilityServiceUpdate -### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. - -## RunAsAccount -### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. - -## InMageFabricSwitchProviderBlockingErrorDetails -### Properties -* **errorCode**: string (ReadOnly): The error code. -* **errorMessage**: string (ReadOnly): The error message. -* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. -* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. -* **possibleCauses**: string (ReadOnly): The possible causes. -* **recommendedAction**: string (ReadOnly): The recommended action. - -## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters +## AzureToAzureVmSyncedConfigDetailsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags +## AzureVmDiskDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -565,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -613,26 +355,134 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string: The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. + +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -652,12 +502,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -703,63 +547,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -793,12 +580,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1190,190 +971,164 @@ * **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. * **resyncTransferredBytes**: int (ReadOnly): The resync transferred bytes from source VM to target for all selected disks on source VM. * **targetDataStoreName**: string (ReadOnly): The target datastore name. -* **targetvCenterId**: string (ReadOnly): The target vCenter Id. -* **targetVmName**: string (ReadOnly): The target VM name. -* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. - - -## DiskEncryptionInfo -### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **targetvCenterId**: string (ReadOnly): The target vCenter Id. +* **targetVmName**: string (ReadOnly): The target VM name. +* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionKeyInfo -### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. -## KeyEncryptionKeyInfo +## EncryptionDetails ### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. ## ExtendedLocation ### Properties * **name**: string (Required): The name of the extended location. * **type**: 'EdgeZone' | string (Required): The extended location type. -## A2AProtectedDiskDetails +## FabricCreationInputProperties ### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## DiskDetails +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. + +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. + + +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1382,22 +1137,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1418,6 +1157,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1425,62 +1192,40 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +### Additional Properties +* **Additional Properties Type**: string -## InMageProtectedDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. * **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. -* **healthErrorCode**: string (ReadOnly): The health error code for the disk. -* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. -* **progressHealth**: string (ReadOnly): The Progress Health. -* **progressStatus**: string (ReadOnly): The Progress Status. -* **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. -* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. -* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. -* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. -* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. -* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. -* **resyncStartTime**: string (ReadOnly): The resync start time. -* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. -* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2DiskInputDetails -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. ## InMageAzureV2ProtectedDiskDetails ### Properties @@ -1508,19 +1253,6 @@ * **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. * **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## InMageAzureV2SwitchProviderBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1547,21 +1279,59 @@ * **targetResourceId**: string (ReadOnly): The target resource Id. * **targetVaultId**: string (ReadOnly): The target vault Id. -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags +## InMageDiskExclusionInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2EnableProtectionInputTargetNicTags +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageFabricSwitchProviderBlockingErrorDetails +### Properties +* **errorCode**: string (ReadOnly): The error code. +* **errorMessage**: string (ReadOnly): The error message. +* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. +* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. +* **possibleCauses**: string (ReadOnly): The possible causes. +* **recommendedAction**: string (ReadOnly): The recommended action. + +## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageAzureV2EnableProtectionInputTargetVmTags +## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## InMageProtectedDiskDetails +### Properties +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **healthErrorCode**: string (ReadOnly): The health error code for the disk. +* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. +* **progressHealth**: string (ReadOnly): The Progress Health. +* **progressStatus**: string (ReadOnly): The Progress Status. +* **protectionStage**: string (ReadOnly): The protection stage. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. +* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. +* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. +* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. +* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. +* **resyncStartTime**: string (ReadOnly): The resync start time. +* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. +* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. + ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1596,18 +1366,77 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +## InMageRcmDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. + ## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails ### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. ## InMageRcmLastAgentUpgradeErrorDetails ### Properties @@ -1641,6 +1470,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1669,196 +1514,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. - +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. -## AddRecoveryServicesProviderInputProperties +## MasterTargetServer ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## StorageMappingInputProperties +## MobilityServiceUpdate ### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. -## AddVCenterRequestProperties +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType + +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. + +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -2042,59 +1826,108 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string: The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2116,96 +1949,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2237,6 +2015,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2266,8 +2051,223 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.md index a30e8c3ca1..3f480c91bd 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-01-01/types.md @@ -140,123 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -274,282 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails +## AzureToAzureVmSyncedConfigDetails ### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. - -## MobilityServiceUpdate -### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. - -## RunAsAccount -### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. - -## InMageFabricSwitchProviderBlockingErrorDetails -### Properties -* **errorCode**: string (ReadOnly): The error code. -* **errorMessage**: string (ReadOnly): The error message. -* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. -* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. -* **possibleCauses**: string (ReadOnly): The possible causes. -* **recommendedAction**: string (ReadOnly): The recommended action. - -## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters +## AzureToAzureVmSyncedConfigDetailsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags +## AzureVmDiskDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -565,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -613,26 +355,134 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string: The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. + +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -652,12 +502,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -705,67 +549,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testNetworkId**: string (ReadOnly): Source network Id. -* **testSubnetName**: string (ReadOnly): Test subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -799,12 +582,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1196,190 +973,164 @@ * **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. * **resyncTransferredBytes**: int (ReadOnly): The resync transferred bytes from source VM to target for all selected disks on source VM. * **targetDataStoreName**: string (ReadOnly): The target datastore name. -* **targetvCenterId**: string (ReadOnly): The target vCenter Id. -* **targetVmName**: string (ReadOnly): The target VM name. -* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. - - -## DiskEncryptionInfo -### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **targetvCenterId**: string (ReadOnly): The target vCenter Id. +* **targetVmName**: string (ReadOnly): The target VM name. +* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionKeyInfo -### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. -## KeyEncryptionKeyInfo +## EncryptionDetails ### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. ## ExtendedLocation ### Properties * **name**: string (Required): The name of the extended location. * **type**: 'EdgeZone' | string (Required): The extended location type. -## A2AProtectedDiskDetails +## FabricCreationInputProperties ### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## DiskDetails +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. + +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. + + +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1388,22 +1139,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1424,6 +1159,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1431,62 +1194,40 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +### Additional Properties +* **Additional Properties Type**: string -## InMageProtectedDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. * **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. -* **healthErrorCode**: string (ReadOnly): The health error code for the disk. -* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. -* **progressHealth**: string (ReadOnly): The Progress Health. -* **progressStatus**: string (ReadOnly): The Progress Status. -* **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. -* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. -* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. -* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. -* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. -* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. -* **resyncStartTime**: string (ReadOnly): The resync start time. -* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. -* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2DiskInputDetails -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. ## InMageAzureV2ProtectedDiskDetails ### Properties @@ -1514,19 +1255,6 @@ * **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. * **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## InMageAzureV2SwitchProviderBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1553,21 +1281,59 @@ * **targetResourceId**: string (ReadOnly): The target resource Id. * **targetVaultId**: string (ReadOnly): The target vault Id. -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags +## InMageDiskExclusionInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2EnableProtectionInputTargetNicTags +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageFabricSwitchProviderBlockingErrorDetails +### Properties +* **errorCode**: string (ReadOnly): The error code. +* **errorMessage**: string (ReadOnly): The error message. +* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. +* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. +* **possibleCauses**: string (ReadOnly): The possible causes. +* **recommendedAction**: string (ReadOnly): The recommended action. + +## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageAzureV2EnableProtectionInputTargetVmTags +## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## InMageProtectedDiskDetails +### Properties +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **healthErrorCode**: string (ReadOnly): The health error code for the disk. +* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. +* **progressHealth**: string (ReadOnly): The Progress Health. +* **progressStatus**: string (ReadOnly): The Progress Status. +* **protectionStage**: string (ReadOnly): The protection stage. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. +* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. +* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. +* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. +* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. +* **resyncStartTime**: string (ReadOnly): The resync start time. +* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. +* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. + ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1602,19 +1368,78 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. -## InMageRcmDisksDefaultInput +## InMageRcmDiskInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails +### Properties +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. + ## InMageRcmLastAgentUpgradeErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1647,6 +1472,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1675,196 +1516,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. +## MasterTargetServer +### Properties +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## AddRecoveryServicesProviderInputProperties +## MobilityServiceUpdate ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. + +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. -## AddVCenterRequestProperties +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -2048,59 +1828,108 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string: The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2122,96 +1951,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2243,6 +2017,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2272,8 +2053,227 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testNetworkId**: string (ReadOnly): Source network Id. +* **testSubnetName**: string (ReadOnly): Test subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.md b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.md index 36c4c76ed7..b276f8a397 100644 --- a/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.md +++ b/generated/recoveryservicessiterecovery/microsoft.recoveryservices/2022-02-01/types.md @@ -140,123 +140,144 @@ * **properties**: [VaultSettingCreationInputProperties](#vaultsettingcreationinputproperties) (Required): Input to create vault setting. * **type**: 'Microsoft.RecoveryServices/vaults/replicationVaultSettings' (ReadOnly, DeployTimeConstant): The resource type -## ConfigureAlertRequestProperties +## A2AProtectedDiskDetails ### Properties -* **customEmailAddresses**: string[]: The custom email address for sending emails. -* **locale**: string: The locale for the email notification. -* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **diskUri**: string (ReadOnly): The disk uri. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. +* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -## FabricCreationInputProperties +## A2AProtectedManagedDiskDetails ### Properties -* **bcdrState**: string (ReadOnly): BCDR state of the fabric. -* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. -* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -* **friendlyName**: string (ReadOnly): Friendly name of the fabric. -* **health**: string (ReadOnly): Health of fabric. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. -* **internalIdentifier**: string (ReadOnly): Dra Registration Id. -* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. - -## FabricSpecificCreationInput -* **Discriminator**: instanceType - -### Base Properties -### AzureFabricCreationInput -#### Properties -* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. -* **instanceType**: 'Azure' (Required): Gets the class type. -* **location**: string: The Location. -* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. - -### HyperVSiteDetails -#### Properties -* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. -* **instanceType**: 'HyperVSite' (Required): Gets the class type. +* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. +* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. +* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The managed disk Arm id. +* **diskName**: string (ReadOnly): The disk name. +* **diskState**: string (ReadOnly): The disk state. +* **diskType**: string (ReadOnly): The type of disk. +* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. +* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. +* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. +* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). +* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). +* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. +* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. +* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. +* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. +* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. +* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. +* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. +* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. +* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. +* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). +* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. -### InMageRcmFabricCreationInput -#### Properties -* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. -* **controlPlaneUri**: string (ReadOnly): The control plane Uri. -* **dataPlaneUri**: string (ReadOnly): The data plane Uri. -* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. -* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. -* **physicalSiteId**: string (Required): The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. -* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. -* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. -* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. +## A2AProtectionIntentDiskInputDetails +### Properties +* **diskUri**: string (Required): The disk Uri. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -### VmmDetails -#### Properties -* **instanceType**: 'VMM' (Required): Gets the class type. +## A2AProtectionIntentManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required): The disk Id. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. +* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -### VMwareDetails -#### Properties -* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The agent Version. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **csServiceStatus**: string (ReadOnly): The CS service status. -* **databaseServerLoad**: string (ReadOnly): The database server load. -* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. -* **hostName**: string (ReadOnly): The host name. -* **instanceType**: 'VMware' (Required): Gets the class type. -* **ipAddress**: string (ReadOnly): The IP address. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. -* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **processServerCount**: string (ReadOnly): The number of process servers. -* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. -* **protectedServers**: string (ReadOnly): The number of protected servers. -* **psTemplateVersion**: string (ReadOnly): PS template version. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. -* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. -* **webLoad**: string (ReadOnly): The web load. -* **webLoadStatus**: string (ReadOnly): The web load status. +## A2AUnprotectedDiskDetails +### Properties +* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. +* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. -### VMwareV2FabricCreationInput -#### Properties -* **instanceType**: 'VMwareV2' (Required): Gets the class type. -* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. -* **physicalSiteId**: string: The ARM Id of the physical site. -* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. -* **serviceContainerId**: string (ReadOnly): The service container Id. -* **serviceEndpoint**: string (ReadOnly): The service endpoint. -* **serviceResourceId**: string (ReadOnly): The service resource Id. -* **vmwareSiteId**: string: The ARM Id of the VMware site. +## A2AVmDiskInputDetails +### Properties +* **diskUri**: string (Required, WriteOnly): The disk Uri. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. +* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +## A2AVmManagedDiskInputDetails +### Properties +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). +* **diskId**: string (Required, WriteOnly): The disk Id. +* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. +* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. +* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. +* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. +* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. ## A2AZoneDetails ### Properties * **source**: string (ReadOnly): Source zone info. * **target**: string (ReadOnly): The target zone info. -## HyperVHostDetails +## AddRecoveryServicesProviderInputProperties ### Properties -* **id**: string (ReadOnly): The Hyper-V host Id. -* **marsAgentVersion**: string (ReadOnly): The Mars agent version. -* **name**: string (ReadOnly): The Hyper-V host name. +* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. +* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **biosId**: string: The Bios Id of the machine. +* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. +* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. +* **draIdentifier**: string (ReadOnly): The DRA Id. +* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. +* **fabricType**: string (ReadOnly): Type of the site. +* **friendlyName**: string (ReadOnly): Friendly name of the DRA. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. +* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. +* **machineId**: string: The Id of the machine where the provider is getting added. +* **machineName**: string (Required): The name of the machine where the provider is getting added. +* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. +* **providerVersion**: string (ReadOnly): The provider version. +* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. +* **providerVersionState**: string (ReadOnly): DRA version status. +* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **serverVersion**: string (ReadOnly): The fabric provider. + +## AddVCenterRequestProperties +### Properties +* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. +* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. +* **friendlyName**: string: The friendly name of the vCenter. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. +* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. +* **internalId**: string (ReadOnly): VCenter internal ID. +* **ipAddress**: string: The IP address of the vCenter to be discovered. +* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. +* **port**: string: The port number for discovery. +* **processServerId**: string: The process server Id from where the discovery is orchestrated. +* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. ## AgentDetails ### Properties @@ -274,282 +295,34 @@ * **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. * **lunId**: int (ReadOnly): The lun of disk. -## DraDetails +## AzureToAzureVmSyncedConfigDetails ### Properties -* **biosId**: string (ReadOnly): The DRA Bios Id. -* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The DRA Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. -* **name**: string (ReadOnly): The DRA name. -* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. -* **version**: string (ReadOnly): The version. +* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. +* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. -## HealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## InnerHealthError -### Properties -* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). -* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. -* **entityId**: string (ReadOnly): ID of the entity. -* **errorCategory**: string (ReadOnly): Category of error. -* **errorCode**: string (ReadOnly): Error code. -* **errorId**: string (ReadOnly): The health error unique id. -* **errorLevel**: string (ReadOnly): Level of error. -* **errorMessage**: string (ReadOnly): Error message. -* **errorSource**: string (ReadOnly): Source of error. -* **errorType**: string (ReadOnly): Type of error. -* **possibleCauses**: string (ReadOnly): Possible causes of error. -* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. -* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. -* **summaryMessage**: string (ReadOnly): Summary message of the entity. - -## MarsAgentDetails -### Properties -* **biosId**: string (ReadOnly): The Mars agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The Mars agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The Mars agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. -* **name**: string (ReadOnly): The Mars agent name. -* **version**: string (ReadOnly): The version. - -## ProcessServerDetails -### Properties -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available disk space. -* **biosId**: string (ReadOnly): The process server Bios Id. -* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The process server Fqdn. -* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **id**: string (ReadOnly): The process server Id. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. -* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. -* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **name**: string (ReadOnly): The process server name. -* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. -* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **systemLoad**: int (ReadOnly): The system load. -* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total disk space. -* **usedMemoryInBytes**: int (ReadOnly): The used memory. -* **usedSpaceInBytes**: int (ReadOnly): The used disk space. -* **version**: string (ReadOnly): The version. - -## PushInstallerDetails -### Properties -* **biosId**: string (ReadOnly): The push installer Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The push installer Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The push installer Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. -* **name**: string (ReadOnly): The push installer name. -* **version**: string (ReadOnly): The version. - -## RcmProxyDetails -### Properties -* **biosId**: string (ReadOnly): The RCM proxy Bios Id. -* **clientAuthenticationType**: string (ReadOnly): The client authentication type. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The RCM proxy Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. -* **name**: string (ReadOnly): The RCM proxy name. -* **version**: string (ReadOnly): The version. - -## ReplicationAgentDetails -### Properties -* **biosId**: string (ReadOnly): The replication agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The replication agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The replication agent Id. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. -* **name**: string (ReadOnly): The replication agent name. -* **version**: string (ReadOnly): The version. - -## ReprotectAgentDetails -### Properties -* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. -* **biosId**: string (ReadOnly): The reprotect agent Bios Id. -* **fabricObjectId**: string (ReadOnly): The fabric object Id. -* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. -* **id**: string (ReadOnly): The reprotect agent Id. -* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. -* **name**: string (ReadOnly): The reprotect agent name. -* **protectedItemCount**: int (ReadOnly): The protected item count. -* **vcenterId**: string (ReadOnly): The Vcenter Id. -* **version**: string (ReadOnly): The version. - -## IdentityProviderInput -### Properties -* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## IdentityProviderDetails -### Properties -* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. -* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. -* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. - -## VersionDetails -### Properties -* **expiryDate**: string (ReadOnly): Version expiry date. -* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. -* **version**: string (ReadOnly): The agent version. - -## MasterTargetServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. -* **diskCount**: int (ReadOnly): Disk count of the master target. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **id**: string (ReadOnly): The server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. -* **marsAgentVersion**: string (ReadOnly): MARS agent version. -* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **name**: string (ReadOnly): The server name. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the master target. -* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. -* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. -* **versionStatus**: string (ReadOnly): Version status. - -## DataStore -### Properties -* **capacity**: string (ReadOnly): The capacity of data store in GBs. -* **freeSpace**: string (ReadOnly): The free space of data store in GBs. -* **symbolicName**: string (ReadOnly): The symbolic name of data store. -* **type**: string (ReadOnly): The type of data store. -* **uuid**: string (ReadOnly): The uuid of data store. - -## RetentionVolume -### Properties -* **capacityInBytes**: int (ReadOnly): The volume capacity. -* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. -* **thresholdPercentage**: int (ReadOnly): The threshold percentage. -* **volumeName**: string (ReadOnly): The volume name. - -## ProcessServer -### Properties -* **agentExpiryDate**: string (ReadOnly): Agent expiry date. -* **agentVersion**: string (ReadOnly): The version of the scout component on the server. -* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **availableMemoryInBytes**: int (ReadOnly): The available memory. -* **availableSpaceInBytes**: int (ReadOnly): The available space. -* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. -* **cpuLoadStatus**: string (ReadOnly): The CPU load status. -* **friendlyName**: string (ReadOnly): The Process Server's friendly name. -* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. -* **hostId**: string (ReadOnly): The agent generated Id. -* **id**: string (ReadOnly): The Process Server Id. -* **ipAddress**: string (ReadOnly): The IP address of the server. -* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. -* **machineCount**: string (ReadOnly): The servers configured with this PS. -* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. -* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. -* **memoryUsageStatus**: string (ReadOnly): The memory usage status. -* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. -* **osType**: string (ReadOnly): The OS type of the server. -* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. -* **psServiceStatus**: string (ReadOnly): The PS service status. -* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. -* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. -* **spaceUsageStatus**: string (ReadOnly): The space usage status. -* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. -* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. -* **systemLoad**: string (ReadOnly): The percentage of the system load. -* **systemLoadStatus**: string (ReadOnly): The system load status. -* **throughputInBytes**: int (ReadOnly): The throughput in bytes. -* **throughputInMBps**: int (ReadOnly): The throughput in MBps. -* **throughputStatus**: string (ReadOnly): The throughput status. -* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. -* **totalMemoryInBytes**: int (ReadOnly): The total memory. -* **totalSpaceInBytes**: int (ReadOnly): The total space. -* **versionStatus**: string (ReadOnly): Version status. - -## MobilityServiceUpdate -### Properties -* **osType**: string (ReadOnly): The OS type. -* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. -* **version**: string (ReadOnly): The version of the latest update. - -## RunAsAccount -### Properties -* **accountId**: string (ReadOnly): The CS RunAs account Id. -* **accountName**: string (ReadOnly): The CS RunAs account name. - -## InMageFabricSwitchProviderBlockingErrorDetails -### Properties -* **errorCode**: string (ReadOnly): The error code. -* **errorMessage**: string (ReadOnly): The error message. -* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. -* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. -* **possibleCauses**: string (ReadOnly): The possible causes. -* **recommendedAction**: string (ReadOnly): The recommended action. - -## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters +## AzureToAzureVmSyncedConfigDetailsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags +## AzureVmDiskDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (ReadOnly): The disk resource id. +* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. +* **maxSizeMB**: string (ReadOnly): Max side in MB. +* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. +* **targetDiskName**: string (ReadOnly): The target Azure disk name. +* **vhdId**: string (ReadOnly): The VHD id. +* **vhdName**: string (ReadOnly): VHD name. +* **vhdType**: string (ReadOnly): VHD type. -## EncryptionDetails +## ConfigureAlertRequestProperties ### Properties -* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. -* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. -* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. +* **customEmailAddresses**: string[]: The custom email address for sending emails. +* **locale**: string: The locale for the email notification. +* **sendToOwners**: string: A value indicating whether to send email to subscription administrator. ## CreateNetworkMappingInputProperties ### Properties @@ -565,42 +338,11 @@ * **recoveryNetworkId**: string (Required): Recovery network Id. * **state**: string (ReadOnly): The pairing state for network mapping. -## FabricSpecificCreateNetworkMappingInput -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'AzureToAzure' (Required): The instance type. -* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. - -### VmmToAzureCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToAzure' (Required): The instance type. - -### VmmToVmmCreateNetworkMappingInput -#### Properties -* **instanceType**: 'VmmToVmm' (Required): The instance type. - - -## NetworkMappingFabricSpecificSettings -* **Discriminator**: instanceType - -### Base Properties -### AzureToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. -* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. -* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. - -### VmmToAzureNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. - -### VmmToVmmNetworkMappingSettings -#### Properties -* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. - +## CreatePolicyInputProperties +### Properties +* **friendlyName**: string (ReadOnly): The FriendlyName. +* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. +* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. ## CreateProtectionContainerInputProperties ### Properties @@ -613,26 +355,134 @@ * **providerSpecificInput**: [ReplicationProviderSpecificContainerCreationInput](#replicationproviderspecificcontainercreationinput)[] (WriteOnly): Provider specific inputs for container creation. * **role**: string (ReadOnly): The role of this cloud. -## ProtectionContainerFabricSpecificDetails +## CreateProtectionContainerMappingInputProperties ### Properties -* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. +* **health**: string (ReadOnly): Health of pairing. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. +* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. +* **policyId**: string: Applicable policy. +* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. +* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. +* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. +* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. +* **state**: string (ReadOnly): Association Status. +* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. +* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. +* **targetProtectionContainerId**: string: The target unique protection container name. -## ReplicationProviderSpecificContainerCreationInput +## CreateProtectionIntentProperties +### Properties +* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. +* **friendlyName**: string (ReadOnly): The name. +* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. +* **jobId**: string (ReadOnly): The job Id. +* **jobState**: string (ReadOnly): The job state. +* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. + +## CreateProtectionIntentProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2AContainerCreationInput +### A2ACreateProtectionIntentInput #### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string: The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. +* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. +* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). +* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. * **instanceType**: 'A2A' (Required): The class type. +* **multiVmGroupId**: string: The multi vm group id. +* **multiVmGroupName**: string: The multi vm group name. +* **primaryLocation**: string (Required): The primary location for the virtual machine. +* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. +* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. +* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. +* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. +* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. +* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. +* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. +* **recoveryAvailabilityZone**: string: The recovery availability zone. +* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **recoveryLocation**: string (Required): The recovery location for the virtual machine. +* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. +* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. +* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. +* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. +* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. +* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. +* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. +* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. -### A2ACrossClusterMigrationContainerCreationInput -#### Properties -* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. -### VMwareCbtContainerCreationInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. +## CreateRecoveryPlanInputProperties +### Properties +* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. +* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. +* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. +* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. +* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. +* **friendlyName**: string (ReadOnly): The friendly name. +* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. +* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. +* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. +* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. +* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. +* **primaryFabricId**: string (Required): The primary fabric Id. +* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. +* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. +* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. +* **recoveryFabricId**: string (Required): The recovery fabric Id. +* **replicationProviders**: string[] (ReadOnly): The list of replication providers. +## CurrentJobDetails +### Properties +* **jobId**: string (ReadOnly): The ARM Id of the job being executed. +* **jobName**: string (ReadOnly): The job name. +* **startTime**: string (ReadOnly): The start time of the job. + +## CurrentScenarioDetails +### Properties +* **jobId**: string (ReadOnly): ARM Id of the job being executed. +* **scenarioName**: string (ReadOnly): Scenario name. +* **startTime**: string (ReadOnly): Start time of the workflow. + +## DataStore +### Properties +* **capacity**: string (ReadOnly): The capacity of data store in GBs. +* **freeSpace**: string (ReadOnly): The free space of data store in GBs. +* **symbolicName**: string (ReadOnly): The symbolic name of data store. +* **type**: string (ReadOnly): The type of data store. +* **uuid**: string (ReadOnly): The uuid of data store. + +## DiskDetails +### Properties +* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. +* **vhdId**: string (ReadOnly): The VHD Id. +* **vhdName**: string (ReadOnly): The VHD name. +* **vhdType**: string (ReadOnly): The type of the volume. + +## DiskEncryptionInfo +### Properties +* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). +* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. + +## DiskEncryptionKeyInfo +### Properties +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. +* **secretIdentifier**: string (WriteOnly): The secret url / identifier. + +## DraDetails +### Properties +* **biosId**: string (ReadOnly): The DRA Bios Id. +* **forwardProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in forward direction. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The DRA Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the DRA. +* **name**: string (ReadOnly): The DRA name. +* **reverseProtectedItemCount**: int (ReadOnly): The count of protected items which are protected in reverse direction. +* **version**: string (ReadOnly): The version. ## EnableMigrationInputProperties ### Properties @@ -652,12 +502,6 @@ * **testMigrateState**: 'None' | 'TestMigrationCleanupInProgress' | 'TestMigrationFailed' | 'TestMigrationInProgress' | 'TestMigrationSucceeded' | string (ReadOnly): The test migrate state. * **testMigrateStateDescription**: string (ReadOnly): The test migrate state description. -## CurrentJobDetails -### Properties -* **jobId**: string (ReadOnly): The ARM Id of the job being executed. -* **jobName**: string (ReadOnly): The job name. -* **startTime**: string (ReadOnly): The start time of the job. - ## EnableMigrationProviderSpecificInput * **Discriminator**: instanceType @@ -705,67 +549,6 @@ * **vmwareMachineId**: string (Required): The ARM Id of the VM discovered in VMware. -## VMwareCbtDiskInput -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. - -## VMwareCbtProtectedDiskDetails -### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskPath**: string (ReadOnly): The disk path. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. -* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. -* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. -* **targetDiskName**: string (ReadOnly): The name for the target managed disk. -* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. - -## VMwareCbtEnableMigrationInputSeedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetNicTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtEnableMigrationInputTargetVmTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VMwareCbtNicDetails -### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testNetworkId**: string (ReadOnly): Source network Id. -* **testSubnetName**: string (ReadOnly): Test subnet name. - ## EnableProtectionInputProperties ### Properties * **activeLocation**: string (ReadOnly): The Current active location of the PE. @@ -799,12 +582,6 @@ * **testFailoverState**: string (ReadOnly): The Test failover state. * **testFailoverStateDescription**: string (ReadOnly): The Test failover state description. -## CurrentScenarioDetails -### Properties -* **jobId**: string (ReadOnly): ARM Id of the job being executed. -* **scenarioName**: string (ReadOnly): Scenario name. -* **startTime**: string (ReadOnly): Start time of the workflow. - ## EnableProtectionProviderSpecificInput * **Discriminator**: instanceType @@ -1196,190 +973,164 @@ * **resyncState**: 'None' | 'PreparedForResynchronization' | 'StartedResynchronization' | string (ReadOnly): The resync state. * **resyncTransferredBytes**: int (ReadOnly): The resync transferred bytes from source VM to target for all selected disks on source VM. * **targetDataStoreName**: string (ReadOnly): The target datastore name. -* **targetvCenterId**: string (ReadOnly): The target vCenter Id. -* **targetVmName**: string (ReadOnly): The target VM name. -* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. - - -## DiskEncryptionInfo -### Properties -* **diskEncryptionKeyInfo**: [DiskEncryptionKeyInfo](#diskencryptionkeyinfo) (WriteOnly): Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). -* **keyEncryptionKeyInfo**: [KeyEncryptionKeyInfo](#keyencryptionkeyinfo) (WriteOnly): Key Encryption Key (KEK) information. +* **targetvCenterId**: string (ReadOnly): The target vCenter Id. +* **targetVmName**: string (ReadOnly): The target VM name. +* **vmNics**: [InMageRcmFailbackNicDetails](#inmagercmfailbacknicdetails)[] (ReadOnly): The network details. -## DiskEncryptionKeyInfo -### Properties -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM id for secret. -* **secretIdentifier**: string (WriteOnly): The secret url / identifier. -## KeyEncryptionKeyInfo +## EncryptionDetails ### Properties -* **keyIdentifier**: string (WriteOnly): The key URL / identifier. -* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. +* **kekCertExpiryDate**: string (ReadOnly): The key encryption key certificate expiry date. +* **kekCertThumbprint**: string (ReadOnly): The key encryption key certificate thumbprint. +* **kekState**: string (ReadOnly): The key encryption key state for the Vmm. ## ExtendedLocation ### Properties * **name**: string (Required): The name of the extended location. * **type**: 'EdgeZone' | string (Required): The extended location type. -## A2AProtectedDiskDetails +## FabricCreationInputProperties ### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **diskUri**: string (ReadOnly): The disk uri. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskAzureStorageAccountId**: string (ReadOnly): The primary disk storage account. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryAzureStorageAccountId**: string (ReadOnly): The recovery disk storage account. -* **recoveryDiskUri**: string (ReadOnly): Recovery disk uri. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +* **bcdrState**: string (ReadOnly): BCDR state of the fabric. +* **customDetails**: [FabricSpecificCreationInput](#fabricspecificcreationinput): Fabric provider specific settings. +* **encryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. +* **friendlyName**: string (ReadOnly): Friendly name of the fabric. +* **health**: string (ReadOnly): Health of fabric. +* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Fabric health error details. +* **internalIdentifier**: string (ReadOnly): Dra Registration Id. +* **rolloverEncryptionDetails**: [EncryptionDetails](#encryptiondetails) (ReadOnly): Encryption details for the fabric. -## A2AProtectedManagedDiskDetails -### Properties -* **allowedDiskLevelOperation**: string[] (ReadOnly): The disk level operations list. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source virtual machine in MB. -* **dataPendingInStagingStorageAccountInMB**: int (ReadOnly): The data pending for replication in MB at staging account. -* **dekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for secret (BEK). -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **diskId**: string (ReadOnly): The managed disk Arm id. -* **diskName**: string (ReadOnly): The disk name. -* **diskState**: string (ReadOnly): The disk state. -* **diskType**: string (ReadOnly): The type of disk. -* **failoverDiskName**: string (ReadOnly): The failover name for the managed disk. -* **isDiskEncrypted**: bool (ReadOnly): A value indicating whether vm has encrypted os disk or not. -* **isDiskKeyEncrypted**: bool (ReadOnly): A value indicating whether disk key got encrypted or not. -* **kekKeyVaultArmId**: string (ReadOnly): The KeyVault resource id for key (KEK). -* **keyIdentifier**: string (ReadOnly): The key URL / identifier (KEK). -* **monitoringJobType**: string (ReadOnly): The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. -* **monitoringPercentageCompletion**: int (ReadOnly): The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. -* **primaryDiskEncryptionSetId**: string (ReadOnly): The primary disk encryption set Id. -* **primaryStagingAzureStorageAccountId**: string (ReadOnly): The primary staging storage account. -* **recoveryDiskEncryptionSetId**: string (ReadOnly): The recovery disk encryption set Id. -* **recoveryOrignalTargetDiskId**: string (ReadOnly): Recovery original target disk Arm Id. -* **recoveryReplicaDiskAccountType**: string (ReadOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryReplicaDiskId**: string (ReadOnly): Recovery replica disk Arm Id. -* **recoveryResourceGroupId**: string (ReadOnly): The recovery disk resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (ReadOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. -* **recoveryTargetDiskId**: string (ReadOnly): Recovery target disk Arm Id. -* **resyncRequired**: bool (ReadOnly): A value indicating whether resync is required for this disk. -* **secretIdentifier**: string (ReadOnly): The secret URL / identifier (BEK). -* **tfoDiskName**: string (ReadOnly): The test failover name for the managed disk. +## FabricSpecificCreateNetworkMappingInput +* **Discriminator**: instanceType -## A2AUnprotectedDiskDetails -### Properties -* **diskAutoProtectionStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto protection is enabled. -* **diskLunId**: int (ReadOnly): The source lun Id for the data disk. +### Base Properties +### AzureToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'AzureToAzure' (Required): The instance type. +* **primaryNetworkId**: string (Required, WriteOnly): The primary azure vnet Id. -## A2AVmDiskInputDetails -### Properties -* **diskUri**: string (Required, WriteOnly): The disk Uri. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Id. -* **recoveryAzureStorageAccountId**: string (Required, WriteOnly): The recovery VHD storage account Id. +### VmmToAzureCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToAzure' (Required): The instance type. -## A2AVmManagedDiskInputDetails -### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo) (WriteOnly): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required, WriteOnly): The disk Id. -* **primaryStagingAzureStorageAccountId**: string (Required, WriteOnly): The primary staging storage account Arm Id. -* **recoveryDiskEncryptionSetId**: string (WriteOnly): The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string (WriteOnly): The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupId**: string (Required, WriteOnly): The target resource group Arm Id. -* **recoveryTargetDiskAccountType**: string (WriteOnly): The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +### VmmToVmmCreateNetworkMappingInput +#### Properties +* **instanceType**: 'VmmToVmm' (Required): The instance type. -## VMNicDetails -### Properties -* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. -* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. -* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. -* **nicId**: string (ReadOnly): The nic Id. -* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. -* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. -* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. -* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. -* **replicaNicId**: string (ReadOnly): The replica nic Id. -* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. -* **selectionType**: string (ReadOnly): Selection type for failover. -* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. -* **targetNicName**: string (ReadOnly): Target NIC name. -* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. -* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. -* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. -* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. -* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. -* **vMNetworkName**: string (ReadOnly): VM network name. -## IPConfigDetails -### Properties -* **ipAddressType**: string (ReadOnly) -* **isPrimary**: bool (ReadOnly) -* **isSeletedForFailover**: bool (ReadOnly) -* **name**: string (ReadOnly) -* **recoveryIPAddressType**: string (ReadOnly) -* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem -* **recoveryPublicIPAddressId**: string (ReadOnly) -* **recoveryStaticIPAddress**: string (ReadOnly) -* **recoverySubnetName**: string (ReadOnly) -* **staticIPAddress**: string (ReadOnly) -* **subnetName**: string (ReadOnly) -* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem -* **tfoPublicIPAddressId**: string (ReadOnly) -* **tfoStaticIPAddress**: string (ReadOnly) -* **tfoSubnetName**: string (ReadOnly) +## FabricSpecificCreationInput +* **Discriminator**: instanceType -## AzureToAzureVmSyncedConfigDetails -### Properties -* **inputEndpoints**: [InputEndpoint](#inputendpoint)[] (ReadOnly): The Azure VM input endpoints. -* **tags**: [AzureToAzureVmSyncedConfigDetailsTags](#azuretoazurevmsyncedconfigdetailstags) (ReadOnly): The Azure VM tags. +### Base Properties +### AzureFabricCreationInput +#### Properties +* **containerIds**: string[] (ReadOnly): The container Ids for the Azure fabric. +* **instanceType**: 'Azure' (Required): Gets the class type. +* **location**: string: The Location. +* **zones**: [A2AZoneDetails](#a2azonedetails)[] (ReadOnly): The zones. -## InputEndpoint -### Properties -* **endpointName**: string (ReadOnly) -* **privatePort**: int (ReadOnly) -* **protocol**: string (ReadOnly) -* **publicPort**: int (ReadOnly) +### HyperVSiteDetails +#### Properties +* **hyperVHosts**: [HyperVHostDetails](#hypervhostdetails)[] (ReadOnly): The list of Hyper-V hosts associated with the fabric. +* **instanceType**: 'HyperVSite' (Required): Gets the class type. -## AzureToAzureVmSyncedConfigDetailsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### InMageRcmFabricCreationInput +#### Properties +* **agentDetails**: [AgentDetails](#agentdetails)[] (ReadOnly): The list of agent details. +* **controlPlaneUri**: string (ReadOnly): The control plane Uri. +* **dataPlaneUri**: string (ReadOnly): The data plane Uri. +* **dras**: [DraDetails](#dradetails)[] (ReadOnly): The list of DRAs. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. +* **marsAgents**: [MarsAgentDetails](#marsagentdetails)[] (ReadOnly): The list of Mars agents. +* **physicalSiteId**: string (Required): The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **pushInstallers**: [PushInstallerDetails](#pushinstallerdetails)[] (ReadOnly): The list of push installers. +* **rcmProxies**: [RcmProxyDetails](#rcmproxydetails)[] (ReadOnly): The list of RCM proxies. +* **replicationAgents**: [ReplicationAgentDetails](#replicationagentdetails)[] (ReadOnly): The list of replication agents. +* **reprotectAgents**: [ReprotectAgentDetails](#reprotectagentdetails)[] (ReadOnly): The list of reprotect agents. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **sourceAgentIdentity**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. +* **sourceAgentIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. +* **vmwareSiteId**: string (Required): The ARM Id of the VMware site. -## InitialReplicationDetails -### Properties -* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. -* **initialReplicationType**: string (ReadOnly): Initial replication type. +### VmmDetails +#### Properties +* **instanceType**: 'VMM' (Required): Gets the class type. -## DiskDetails +### VMwareDetails +#### Properties +* **agentCount**: string (ReadOnly): The number of source and target servers configured to talk to this CS. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The agent Version. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **csServiceStatus**: string (ReadOnly): The CS service status. +* **databaseServerLoad**: string (ReadOnly): The database server load. +* **databaseServerLoadStatus**: string (ReadOnly): The database server load status. +* **hostName**: string (ReadOnly): The host name. +* **instanceType**: 'VMware' (Required): Gets the class type. +* **ipAddress**: string (ReadOnly): The IP address. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from CS server. +* **masterTargetServers**: [MasterTargetServer](#mastertargetserver)[] (ReadOnly): The list of Master Target servers associated with the fabric. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **processServerCount**: string (ReadOnly): The number of process servers. +* **processServers**: [ProcessServer](#processserver)[] (ReadOnly): The list of Process Servers associated with the fabric. +* **protectedServers**: string (ReadOnly): The number of protected servers. +* **psTemplateVersion**: string (ReadOnly): PS template version. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this CS. +* **runAsAccounts**: [RunAsAccount](#runasaccount)[] (ReadOnly): The list of run as accounts created on the server. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): CS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **switchProviderBlockingErrorDetails**: [InMageFabricSwitchProviderBlockingErrorDetails](#inmagefabricswitchproviderblockingerrordetails)[] (ReadOnly): The switch provider blocking error information. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. +* **webLoad**: string (ReadOnly): The web load. +* **webLoadStatus**: string (ReadOnly): The web load status. + +### VMwareV2FabricCreationInput +#### Properties +* **instanceType**: 'VMwareV2' (Required): Gets the class type. +* **migrationSolutionId**: string (Required): The ARM Id of the migration solution. +* **physicalSiteId**: string: The ARM Id of the physical site. +* **processServers**: [ProcessServerDetails](#processserverdetails)[] (ReadOnly): The list of process servers. +* **serviceContainerId**: string (ReadOnly): The service container Id. +* **serviceEndpoint**: string (ReadOnly): The service endpoint. +* **serviceResourceId**: string (ReadOnly): The service resource Id. +* **vmwareSiteId**: string: The ARM Id of the VMware site. + + +## HealthError ### Properties -* **maxSizeMB**: int (ReadOnly): The hard disk max size in MB. -* **vhdId**: string (ReadOnly): The VHD Id. -* **vhdName**: string (ReadOnly): The VHD name. -* **vhdType**: string (ReadOnly): The type of the volume. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **innerHealthErrors**: [InnerHealthError](#innerhealtherror)[] (ReadOnly): The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## AzureVmDiskDetails +## HyperVHostDetails ### Properties -* **customTargetDiskName**: string (ReadOnly): The custom target Azure disk name. -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk resource id. -* **lunId**: string (ReadOnly): Ordinal\LunId of the disk for the Azure VM. -* **maxSizeMB**: string (ReadOnly): Max side in MB. -* **targetDiskLocation**: string (ReadOnly): Blob uri of the Azure disk. -* **targetDiskName**: string (ReadOnly): The target Azure disk name. -* **vhdId**: string (ReadOnly): The VHD id. -* **vhdName**: string (ReadOnly): VHD name. -* **vhdType**: string (ReadOnly): VHD type. +* **id**: string (ReadOnly): The Hyper-V host Id. +* **marsAgentVersion**: string (ReadOnly): The Mars agent version. +* **name**: string (ReadOnly): The Hyper-V host name. ## HyperVReplicaAzureDiskInputDetails ### Properties @@ -1388,22 +1139,6 @@ * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. * **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## OSDetails -### Properties -* **osEdition**: string (ReadOnly): The OSEdition. -* **oSMajorVersion**: string (ReadOnly): The OS Major Version. -* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. -* **osType**: string (ReadOnly): VM Disk details. -* **oSVersion**: string (ReadOnly): The OS Version. -* **productType**: string (ReadOnly): Product type. - -## HyperVReplicaAzureManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. -* **diskId**: string (ReadOnly): The disk Id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. - ## HyperVReplicaAzureEnableProtectionInputSeedManagedDiskTags ### Properties ### Additional Properties @@ -1424,6 +1159,34 @@ ### Additional Properties * **Additional Properties Type**: string +## HyperVReplicaAzureManagedDiskDetails +### Properties +* **diskEncryptionSetId**: string (ReadOnly): The disk encryption set ARM Id. +* **diskId**: string (ReadOnly): The disk Id. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. + +## IdentityProviderDetails +### Properties +* **aadAuthority**: string (ReadOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (ReadOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (ReadOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (ReadOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (ReadOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## IdentityProviderInput +### Properties +* **aadAuthority**: string (Required, WriteOnly): The base authority for Azure Active Directory authentication. +* **applicationId**: string (Required, WriteOnly): The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **audience**: string (Required, WriteOnly): The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **objectId**: string (Required, WriteOnly): The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. +* **tenantId**: string (Required, WriteOnly): The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. + +## InitialReplicationDetails +### Properties +* **initialReplicationProgressPercentage**: string (ReadOnly): The initial replication progress percentage. +* **initialReplicationType**: string (ReadOnly): Initial replication type. + ## InMageAgentDetails ### Properties * **agentExpiryDate**: string (ReadOnly): Agent expiry date. @@ -1431,62 +1194,40 @@ * **agentVersion**: string (ReadOnly): The agent version. * **postUpdateRebootStatus**: string (ReadOnly): A value indicating whether reboot is required after update is applied. -## InMageReplicationDetailsConsistencyPoints +## InMageAzureV2DiskInputDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. +* **diskId**: string (WriteOnly): The DiskId. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. -## InMageDiskExclusionInput +## InMageAzureV2EnableProtectionInputSeedManagedDiskTags ### Properties -* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. -* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. +### Additional Properties +* **Additional Properties Type**: string -## InMageDiskSignatureExclusionOptions +## InMageAzureV2EnableProtectionInputTargetManagedDiskTags ### Properties -* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## InMageVolumeExclusionOptions +## InMageAzureV2EnableProtectionInputTargetNicTags ### Properties -* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. -* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. +### Additional Properties +* **Additional Properties Type**: string -## OSDiskDetails +## InMageAzureV2EnableProtectionInputTargetVmTags ### Properties -* **osType**: string (ReadOnly): The type of the OS on the VM. -* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. -* **vhdName**: string (ReadOnly): The OS disk VHD name. +### Additional Properties +* **Additional Properties Type**: string -## InMageProtectedDiskDetails +## InMageAzureV2ManagedDiskDetails ### Properties -* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. * **diskId**: string (ReadOnly): The disk id. -* **diskName**: string (ReadOnly): The disk name. -* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. -* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. -* **healthErrorCode**: string (ReadOnly): The health error code for the disk. -* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. -* **progressHealth**: string (ReadOnly): The Progress Health. -* **progressStatus**: string (ReadOnly): The Progress Status. -* **protectionStage**: string (ReadOnly): The protection stage. -* **psDataInMB**: int (ReadOnly): The PS data transit in MB. -* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. -* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. -* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. -* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. -* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. -* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. -* **resyncStartTime**: string (ReadOnly): The resync start time. -* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. -* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. -* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. -* **targetDataInMB**: int (ReadOnly): The target data transit in MB. - -## InMageAzureV2DiskInputDetails -### Properties -* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (WriteOnly): The DiskId. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. -* **logStorageAccountId**: string (WriteOnly): The LogStorageAccountId. +* **replicaDiskType**: string (ReadOnly): The replica disk type. +* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. +* **targetDiskName**: string (ReadOnly): The target disk name. ## InMageAzureV2ProtectedDiskDetails ### Properties @@ -1514,19 +1255,6 @@ * **sourceDataInMegaBytes**: int (ReadOnly): The source data transit in MB. * **targetDataInMegaBytes**: int (ReadOnly): The target data transit in MB. -## InMageAzureV2ManagedDiskDetails -### Properties -* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM ID. -* **diskId**: string (ReadOnly): The disk id. -* **replicaDiskType**: string (ReadOnly): The replica disk type. -* **seedManagedDiskId**: string (ReadOnly): Seed managed disk Id. -* **targetDiskName**: string (ReadOnly): The target disk name. - -## InMageAzureV2EnableProtectionInputSeedManagedDiskTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## InMageAzureV2SwitchProviderBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1553,21 +1281,59 @@ * **targetResourceId**: string (ReadOnly): The target resource Id. * **targetVaultId**: string (ReadOnly): The target vault Id. -## InMageAzureV2EnableProtectionInputTargetManagedDiskTags +## InMageDiskExclusionInput ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diskSignatureOptions**: [InMageDiskSignatureExclusionOptions](#inmagedisksignatureexclusionoptions)[] (WriteOnly): The guest disk signature based option for disk exclusion. +* **volumeOptions**: [InMageVolumeExclusionOptions](#inmagevolumeexclusionoptions)[] (WriteOnly): The volume label based option for disk exclusion. -## InMageAzureV2EnableProtectionInputTargetNicTags +## InMageDiskSignatureExclusionOptions +### Properties +* **diskSignature**: string (WriteOnly): The guest signature of disk to be excluded from replication. + +## InMageFabricSwitchProviderBlockingErrorDetails +### Properties +* **errorCode**: string (ReadOnly): The error code. +* **errorMessage**: string (ReadOnly): The error message. +* **errorMessageParameters**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters](#inmagefabricswitchproviderblockingerrordetailserrormessageparameters) (ReadOnly): The error message parameters. +* **errorTags**: [InMageFabricSwitchProviderBlockingErrorDetailsErrorTags](#inmagefabricswitchproviderblockingerrordetailserrortags) (ReadOnly): The error tags. +* **possibleCauses**: string (ReadOnly): The possible causes. +* **recommendedAction**: string (ReadOnly): The recommended action. + +## InMageFabricSwitchProviderBlockingErrorDetailsErrorMessageParameters ### Properties ### Additional Properties * **Additional Properties Type**: string -## InMageAzureV2EnableProtectionInputTargetVmTags +## InMageFabricSwitchProviderBlockingErrorDetailsErrorTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## InMageProtectedDiskDetails +### Properties +* **diskCapacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskResized**: string (ReadOnly): A value indicating whether disk is resized. +* **fileSystemCapacityInBytes**: int (ReadOnly): The file system capacity in bytes. +* **healthErrorCode**: string (ReadOnly): The health error code for the disk. +* **lastRpoCalculatedTime**: string (ReadOnly): The last RPO calculated time. +* **progressHealth**: string (ReadOnly): The Progress Health. +* **progressStatus**: string (ReadOnly): The Progress Status. +* **protectionStage**: string (ReadOnly): The protection stage. +* **psDataInMB**: int (ReadOnly): The PS data transit in MB. +* **resyncDurationInSeconds**: int (ReadOnly): The resync duration in seconds. +* **resyncLast15MinutesTransferredBytes**: int (ReadOnly): The resync last 15 minutes transferred bytes. +* **resyncLastDataTransferTimeUTC**: string (ReadOnly): The last data transfer time in UTC. +* **resyncProcessedBytes**: int (ReadOnly): The resync processed bytes. +* **resyncProgressPercentage**: int (ReadOnly): The resync progress percentage. +* **resyncRequired**: string (ReadOnly): A value indicating whether resync is required for this disk. +* **resyncStartTime**: string (ReadOnly): The resync start time. +* **resyncTotalTransferredBytes**: int (ReadOnly): The resync total transferred bytes. +* **rpoInSeconds**: int (ReadOnly): The RPO in seconds. +* **sourceDataInMB**: int (ReadOnly): The source data transit in MB. +* **targetDataInMB**: int (ReadOnly): The target data transit in MB. + ## InMageRcmAgentUpgradeBlockingErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1602,19 +1368,78 @@ * **vmFqdn**: string (ReadOnly): The VM fqdn. * **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. -## InMageRcmDisksDefaultInput +## InMageRcmDiskInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. -## InMageRcmDiskInput +## InMageRcmDisksDefaultInput ### Properties * **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. -* **diskId**: string (Required, WriteOnly): The disk Id. * **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required, WriteOnly): The DiskType. * **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +## InMageRcmFailbackDiscoveredProtectedVmDetails +### Properties +* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. +* **datastores**: string[] (ReadOnly): The list of datastores. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. +* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. +* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **osName**: string (ReadOnly): The VM's OS name. +* **powerStatus**: string (ReadOnly): The VM power status. +* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. +* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. +* **vCenterId**: string (ReadOnly): The VCenter Id. +* **vmFqdn**: string (ReadOnly): The VM fqdn. +* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. + +## InMageRcmFailbackMobilityAgentDetails +### Properties +* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. +* **driverVersion**: string (ReadOnly): The driver version. +* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. +* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. +* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. +* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. +* **latestVersion**: string (ReadOnly): The latest agent version available. +* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. +* **version**: string (ReadOnly): The agent version. + +## InMageRcmFailbackNicDetails +### Properties +* **adapterType**: string (ReadOnly): The adapter type. +* **macAddress**: string (ReadOnly): The mac address. +* **networkName**: string (ReadOnly): The network name. +* **sourceIpAddress**: string (ReadOnly): The IP address. + +## InMageRcmFailbackProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. +* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. +* **diskId**: string (ReadOnly): The disk Id (reported by source agent). +* **diskName**: string (ReadOnly): The disk name. +* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). +* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **lastSyncTime**: string (ReadOnly): The last sync time. +* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. + +## InMageRcmFailbackSyncDetails +### Properties +* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. +* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. +* **lastRefreshTime**: string (ReadOnly): The last refresh time. +* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. +* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. +* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. +* **startTime**: string (ReadOnly): The start time. +* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. + ## InMageRcmLastAgentUpgradeErrorDetails ### Properties * **errorCode**: string (ReadOnly): The error code. @@ -1647,6 +1472,22 @@ * **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. * **version**: string (ReadOnly): The agent version. +## InMageRcmNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **sourceSubnetName**: string (ReadOnly): Source subnet name. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testSubnetName**: string (ReadOnly): Test subnet name. + ## InMageRcmProtectedDiskDetails ### Properties * **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. @@ -1675,196 +1516,135 @@ * **startTime**: string (ReadOnly): The start time. * **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. -## InMageRcmNicDetails +## InMageReplicationDetailsConsistencyPoints ### Properties -* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. -* **isSelectedForFailover**: string (ReadOnly): A value indicating whether this NIC is selected for failover. -* **nicId**: string (ReadOnly): The NIC Id. -* **sourceIPAddress**: string (ReadOnly): The source IP address. -* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **sourceNetworkId**: string (ReadOnly): Source network Id. -* **sourceSubnetName**: string (ReadOnly): Source subnet name. -* **targetIPAddress**: string (ReadOnly): The target IP address. -* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **targetSubnetName**: string (ReadOnly): Target subnet name. -* **testIPAddress**: string (ReadOnly): The test IP address. -* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. -* **testSubnetName**: string (ReadOnly): Test subnet name. +### Additional Properties +* **Additional Properties Type**: string -## InMageRcmFailbackDiscoveredProtectedVmDetails +## InMageVolumeExclusionOptions ### Properties -* **createdTimestamp**: string (ReadOnly): The SDS created timestamp. -* **datastores**: string[] (ReadOnly): The list of datastores. -* **ipAddresses**: string[] (ReadOnly): The list of IP addresses. -* **isDeleted**: bool (ReadOnly): A value indicating whether the VM is deleted. -* **lastDiscoveryTimeInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. -* **osName**: string (ReadOnly): The VM's OS name. -* **powerStatus**: string (ReadOnly): The VM power status. -* **updatedTimestamp**: string (ReadOnly): The SDS updated timestamp. -* **vCenterFqdn**: string (ReadOnly): The VCenter fqdn. -* **vCenterId**: string (ReadOnly): The VCenter Id. -* **vmFqdn**: string (ReadOnly): The VM fqdn. -* **vmwareToolsStatus**: string (ReadOnly): The VMware tools status. +* **onlyExcludeIfSingleVolume**: string (WriteOnly): 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. +* **volumeLabel**: string (WriteOnly): The volume label. The disk having any volume with this label will be excluded from replication. -## InMageRcmFailbackMobilityAgentDetails +## InnerHealthError ### Properties -* **agentVersionExpiryDate**: string (ReadOnly): The agent version expiry date. -* **driverVersion**: string (ReadOnly): The driver version. -* **driverVersionExpiryDate**: string (ReadOnly): The driver version expiry date. -* **isUpgradeable**: string (ReadOnly): A value indicating whether agent is upgradeable or not. -* **lastHeartbeatUtc**: string (ReadOnly): The time of the last heartbeat received from the agent. -* **latestUpgradableVersionWithoutReboot**: string (ReadOnly): The latest upgradeable version available without reboot. -* **latestVersion**: string (ReadOnly): The latest agent version available. -* **reasonsBlockingUpgrade**: 'AgentNoHeartbeat' | 'AlreadyOnLatestVersion' | 'DistroIsNotReported' | 'DistroNotSupportedForUpgrade' | 'IncompatibleApplianceVersion' | 'InvalidAgentVersion' | 'InvalidDriverVersion' | 'MissingUpgradePath' | 'NotProtected' | 'ProcessServerNoHeartbeat' | 'RcmProxyNoHeartbeat' | 'RebootRequired' | 'Unknown' | 'UnsupportedProtectionScenario' | string[] (ReadOnly): The whether update is possible or not. -* **version**: string (ReadOnly): The agent version. +* **creationTimeUtc**: string (ReadOnly): Error creation time (UTC). +* **customerResolvability**: 'Allowed' | 'NotAllowed' | string (ReadOnly): Value indicating whether the health error is customer resolvable. +* **entityId**: string (ReadOnly): ID of the entity. +* **errorCategory**: string (ReadOnly): Category of error. +* **errorCode**: string (ReadOnly): Error code. +* **errorId**: string (ReadOnly): The health error unique id. +* **errorLevel**: string (ReadOnly): Level of error. +* **errorMessage**: string (ReadOnly): Error message. +* **errorSource**: string (ReadOnly): Source of error. +* **errorType**: string (ReadOnly): Type of error. +* **possibleCauses**: string (ReadOnly): Possible causes of error. +* **recommendedAction**: string (ReadOnly): Recommended action to resolve error. +* **recoveryProviderErrorMessage**: string (ReadOnly): DRA error message. +* **summaryMessage**: string (ReadOnly): Summary message of the entity. -## InMageRcmFailbackProtectedDiskDetails +## InputEndpoint ### Properties -* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. -* **dataPendingAtSourceAgentInMB**: int (ReadOnly): The data pending at source agent in MB. -* **dataPendingInLogDataStoreInMB**: int (ReadOnly): The data pending in log data store in MB. -* **diskId**: string (ReadOnly): The disk Id (reported by source agent). -* **diskName**: string (ReadOnly): The disk name. -* **diskUuid**: string (ReadOnly): The disk Uuid (reported by vCenter). -* **irDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. -* **isInitialReplicationComplete**: string (ReadOnly): A value indicating whether initial replication is complete or not. -* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. -* **lastSyncTime**: string (ReadOnly): The last sync time. -* **resyncDetails**: [InMageRcmFailbackSyncDetails](#inmagercmfailbacksyncdetails) (ReadOnly): InMageRcmFailback disk level sync details. +* **endpointName**: string (ReadOnly) +* **privatePort**: int (ReadOnly) +* **protocol**: string (ReadOnly) +* **publicPort**: int (ReadOnly) -## InMageRcmFailbackSyncDetails +## IPConfigDetails ### Properties -* **last15MinutesTransferredBytes**: int (ReadOnly): The bytes transferred in last 15 minutes from source VM to target. -* **lastDataTransferTimeUtc**: string (ReadOnly): The time of the last data transfer from source VM to target. -* **lastRefreshTime**: string (ReadOnly): The last refresh time. -* **processedBytes**: int (ReadOnly): The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. -* **progressHealth**: 'InProgress' | 'NoProgress' | 'None' | 'Queued' | 'SlowProgress' | string (ReadOnly): The progress health. -* **progressPercentage**: int (ReadOnly): Progress in percentage. Progress percentage is calculated based on processed bytes. -* **startTime**: string (ReadOnly): The start time. -* **transferredBytes**: int (ReadOnly): The transferred bytes from source VM to azure for the disk. +* **ipAddressType**: string (ReadOnly) +* **isPrimary**: bool (ReadOnly) +* **isSeletedForFailover**: bool (ReadOnly) +* **name**: string (ReadOnly) +* **recoveryIPAddressType**: string (ReadOnly) +* **recoveryLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsRecoveryLBBackendAddressPoolIdsItem +* **recoveryPublicIPAddressId**: string (ReadOnly) +* **recoveryStaticIPAddress**: string (ReadOnly) +* **recoverySubnetName**: string (ReadOnly) +* **staticIPAddress**: string (ReadOnly) +* **subnetName**: string (ReadOnly) +* **tfoLBBackendAddressPoolIds**: string[] (ReadOnly): Array of IPConfigDetailsTfoLBBackendAddressPoolIdsItem +* **tfoPublicIPAddressId**: string (ReadOnly) +* **tfoStaticIPAddress**: string (ReadOnly) +* **tfoSubnetName**: string (ReadOnly) -## InMageRcmFailbackNicDetails +## KeyEncryptionKeyInfo ### Properties -* **adapterType**: string (ReadOnly): The adapter type. -* **macAddress**: string (ReadOnly): The mac address. -* **networkName**: string (ReadOnly): The network name. -* **sourceIpAddress**: string (ReadOnly): The IP address. +* **keyIdentifier**: string (WriteOnly): The key URL / identifier. +* **keyVaultResourceArmId**: string (WriteOnly): The KeyVault resource ARM Id for key. -## CreateProtectionContainerMappingInputProperties +## MarsAgentDetails ### Properties -* **health**: string (ReadOnly): Health of pairing. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): Health error. -* **policyFriendlyName**: string (ReadOnly): Friendly name of replication policy. -* **policyId**: string: Applicable policy. -* **providerSpecificDetails**: [ProtectionContainerMappingProviderSpecificDetails](#protectioncontainermappingproviderspecificdetails) (ReadOnly): Container mapping provider specific details. -* **providerSpecificInput**: [ReplicationProviderSpecificContainerMappingInput](#replicationproviderspecificcontainermappinginput) (WriteOnly): Provider specific input for pairing operations. -* **sourceFabricFriendlyName**: string (ReadOnly): Friendly name of source fabric. -* **sourceProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of source protection container. -* **state**: string (ReadOnly): Association Status. -* **targetFabricFriendlyName**: string (ReadOnly): Friendly name of target fabric. -* **targetProtectionContainerFriendlyName**: string (ReadOnly): Friendly name of paired container. -* **targetProtectionContainerId**: string: The target unique protection container name. - -## ProtectionContainerMappingProviderSpecificDetails -* **Discriminator**: instanceType - -### Base Properties -### A2AProtectionContainerMappingDetails -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (ReadOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. -* **jobScheduleName**: string (ReadOnly): The job schedule arm name. -* **scheduleName**: string (ReadOnly): The schedule arm name. - -### InMageRcmProtectionContainerMappingDetails -#### Properties -* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. -* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. - -### VMwareCbtProtectionContainerMappingDetails -#### Properties -* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. -* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. -* **keyVaultUri**: string (ReadOnly): The target key vault URI. -* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (ReadOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. -* **targetLocation**: string (ReadOnly): The target location. - - -## ReplicationProviderSpecificContainerMappingInput -* **Discriminator**: instanceType - -### Base Properties -### A2AContainerMappingInput -#### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string (WriteOnly): The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. -* **instanceType**: 'A2A' (Required): The class type. - -### VMwareCbtContainerMappingInput -#### Properties -* **instanceType**: 'VMwareCbt' (Required): The class type. -* **keyVaultId**: string (WriteOnly): The target key vault ARM Id. -* **keyVaultUri**: string (WriteOnly): The target key vault URL. -* **serviceBusConnectionStringSecretName**: string (WriteOnly): The secret name of the service bus connection string. -* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. -* **storageAccountSasSecretName**: string (WriteOnly): The secret name of the storage account. -* **targetLocation**: string (Required, WriteOnly): The target location. +* **biosId**: string (ReadOnly): The Mars agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The Mars agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The Mars agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the Mars agent. +* **name**: string (ReadOnly): The Mars agent name. +* **version**: string (ReadOnly): The version. +## MasterTargetServer +### Properties +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **dataStores**: [DataStore](#datastore)[] (ReadOnly): The list of data stores in the fabric. +* **diskCount**: int (ReadOnly): Disk count of the master target. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **id**: string (ReadOnly): The server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **marsAgentExpiryDate**: string (ReadOnly): MARS agent expiry date. +* **marsAgentVersion**: string (ReadOnly): MARS agent version. +* **marsAgentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **name**: string (ReadOnly): The server name. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the master target. +* **retentionVolumes**: [RetentionVolume](#retentionvolume)[] (ReadOnly): The retention volumes of Master target Server. +* **validationErrors**: [HealthError](#healtherror)[] (ReadOnly): Validation errors. +* **versionStatus**: string (ReadOnly): Version status. -## AddRecoveryServicesProviderInputProperties +## MobilityServiceUpdate ### Properties -* **allowedScenarios**: string[] (ReadOnly): The scenarios allowed on this provider. -* **authenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **authenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **biosId**: string: The Bios Id of the machine. -* **connectionStatus**: string (ReadOnly): A value indicating whether DRA is responsive. -* **dataPlaneAuthenticationIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **dataPlaneAuthenticationIdentityInput**: [IdentityProviderInput](#identityproviderinput) (WriteOnly): Identity provider input. -* **draIdentifier**: string (ReadOnly): The DRA Id. -* **fabricFriendlyName**: string (ReadOnly): The fabric friendly name. -* **fabricType**: string (ReadOnly): Type of the site. -* **friendlyName**: string (ReadOnly): Friendly name of the DRA. -* **healthErrorDetails**: [HealthError](#healtherror)[] (ReadOnly): The recovery services provider health error details. -* **lastHeartBeat**: string (ReadOnly): Time when last heartbeat was sent by the DRA. -* **machineId**: string: The Id of the machine where the provider is getting added. -* **machineName**: string (Required): The name of the machine where the provider is getting added. -* **protectedItemCount**: int (ReadOnly): Number of protected VMs currently managed by the DRA. -* **providerVersion**: string (ReadOnly): The provider version. -* **providerVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. -* **providerVersionExpiryDate**: string (ReadOnly): Expiry date of the version. -* **providerVersionState**: string (ReadOnly): DRA version status. -* **resourceAccessIdentityDetails**: [IdentityProviderDetails](#identityproviderdetails) (ReadOnly): Identity provider details. -* **resourceAccessIdentityInput**: [IdentityProviderInput](#identityproviderinput) (Required, WriteOnly): Identity provider input. -* **serverVersion**: string (ReadOnly): The fabric provider. +* **osType**: string (ReadOnly): The OS type. +* **rebootStatus**: string (ReadOnly): The reboot status of the update - whether it is required or not. +* **version**: string (ReadOnly): The version of the latest update. + +## NetworkMappingFabricSpecificSettings +* **Discriminator**: instanceType -## StorageMappingInputProperties -### Properties -* **targetStorageClassificationId**: string: The ID of the storage object. +### Base Properties +### AzureToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'AzureToAzure' (Required): Gets the Instance type. +* **primaryFabricLocation**: string (ReadOnly): The primary fabric location. +* **recoveryFabricLocation**: string (ReadOnly): The recovery fabric location. -## AddVCenterRequestProperties +### VmmToAzureNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToAzure' (Required): Gets the Instance type. + +### VmmToVmmNetworkMappingSettings +#### Properties +* **instanceType**: 'VmmToVmm' (Required): Gets the Instance type. + + +## OSDetails ### Properties -* **discoveryStatus**: string (ReadOnly): The VCenter discovery status. -* **fabricArmResourceName**: string (ReadOnly): The ARM resource name of the fabric containing this VCenter. -* **friendlyName**: string: The friendly name of the vCenter. -* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors for this VCenter. -* **infrastructureId**: string (ReadOnly): The infrastructure Id of vCenter. -* **internalId**: string (ReadOnly): VCenter internal ID. -* **ipAddress**: string: The IP address of the vCenter to be discovered. -* **lastHeartbeat**: string (ReadOnly): The time when the last heartbeat was received by vCenter. -* **port**: string: The port number for discovery. -* **processServerId**: string: The process server Id from where the discovery is orchestrated. -* **runAsAccountId**: string: The account Id which has privileges to discover the vCenter. +* **osEdition**: string (ReadOnly): The OSEdition. +* **oSMajorVersion**: string (ReadOnly): The OS Major Version. +* **oSMinorVersion**: string (ReadOnly): The OS Minor Version. +* **osType**: string (ReadOnly): VM Disk details. +* **oSVersion**: string (ReadOnly): The OS Version. +* **productType**: string (ReadOnly): Product type. -## CreatePolicyInputProperties +## OSDiskDetails ### Properties -* **friendlyName**: string (ReadOnly): The FriendlyName. -* **providerSpecificDetails**: [PolicyProviderSpecificDetails](#policyproviderspecificdetails) (ReadOnly): Base class for Provider specific details for policies. -* **providerSpecificInput**: [PolicyProviderSpecificInput](#policyproviderspecificinput) (WriteOnly): Base class for provider specific input. +* **osType**: string (ReadOnly): The type of the OS on the VM. +* **osVhdId**: string (ReadOnly): The id of the disk containing the OS. +* **vhdName**: string (ReadOnly): The OS disk VHD name. ## PolicyProviderSpecificDetails * **Discriminator**: instanceType @@ -2048,59 +1828,108 @@ * **recoveryPointHistoryInMinutes**: int (WriteOnly): The duration in minutes until which the recovery points need to be stored. -## CreateProtectionIntentProperties +## ProcessServer ### Properties -* **creationTimeUTC**: string (ReadOnly): The creation time in UTC. -* **friendlyName**: string (ReadOnly): The name. -* **isActive**: bool (ReadOnly): A value indicating whether the intent object is active. -* **jobId**: string (ReadOnly): The job Id. -* **jobState**: string (ReadOnly): The job state. -* **providerSpecificDetails**: [CreateProtectionIntentProviderSpecificDetails](#createprotectionintentproviderspecificdetails): Create protection intent provider specific input. +* **agentExpiryDate**: string (ReadOnly): Agent expiry date. +* **agentVersion**: string (ReadOnly): The version of the scout component on the server. +* **agentVersionDetails**: [VersionDetails](#versiondetails) (ReadOnly): Version related details. +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available space. +* **cpuLoad**: string (ReadOnly): The percentage of the CPU load. +* **cpuLoadStatus**: string (ReadOnly): The CPU load status. +* **friendlyName**: string (ReadOnly): The Process Server's friendly name. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): Health errors. +* **hostId**: string (ReadOnly): The agent generated Id. +* **id**: string (ReadOnly): The Process Server Id. +* **ipAddress**: string (ReadOnly): The IP address of the server. +* **lastHeartbeat**: string (ReadOnly): The last heartbeat received from the server. +* **machineCount**: string (ReadOnly): The servers configured with this PS. +* **marsCommunicationStatus**: string (ReadOnly): The MARS communication status. +* **marsRegistrationStatus**: string (ReadOnly): The MARS registration status. +* **memoryUsageStatus**: string (ReadOnly): The memory usage status. +* **mobilityServiceUpdates**: [MobilityServiceUpdate](#mobilityserviceupdate)[] (ReadOnly): The list of the mobility service updates available on the Process Server. +* **osType**: string (ReadOnly): The OS type of the server. +* **osVersion**: string (ReadOnly): OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. +* **psServiceStatus**: string (ReadOnly): The PS service status. +* **psStatsRefreshTime**: string (ReadOnly): The process server stats refresh time. +* **replicationPairCount**: string (ReadOnly): The number of replication pairs configured in this PS. +* **spaceUsageStatus**: string (ReadOnly): The space usage status. +* **sslCertExpiryDate**: string (ReadOnly): The PS SSL cert expiry date. +* **sslCertExpiryRemainingDays**: int (ReadOnly): CS SSL cert expiry date. +* **systemLoad**: string (ReadOnly): The percentage of the system load. +* **systemLoadStatus**: string (ReadOnly): The system load status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputInMBps**: int (ReadOnly): The throughput in MBps. +* **throughputStatus**: string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total space. +* **versionStatus**: string (ReadOnly): Version status. -## CreateProtectionIntentProviderSpecificDetails +## ProcessServerDetails +### Properties +* **availableMemoryInBytes**: int (ReadOnly): The available memory. +* **availableSpaceInBytes**: int (ReadOnly): The available disk space. +* **biosId**: string (ReadOnly): The process server Bios Id. +* **diskUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The process server Fqdn. +* **freeSpacePercentage**: int (ReadOnly): The free disk space percentage. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **historicHealth**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **id**: string (ReadOnly): The process server Id. +* **ipAddresses**: string[] (ReadOnly): The list of IP addresses for communicating with the RCM component. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the process server. +* **memoryUsagePercentage**: int (ReadOnly): The memory usage percentage. +* **memoryUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **name**: string (ReadOnly): The process server name. +* **processorUsagePercentage**: int (ReadOnly): The processor usage percentage. +* **processorUsageStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **systemLoad**: int (ReadOnly): The system load. +* **systemLoadStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputInBytes**: int (ReadOnly): The throughput in bytes. +* **throughputStatus**: 'Critical' | 'Healthy' | 'Unknown' | 'Warning' | string (ReadOnly): The throughput status. +* **throughputUploadPendingDataInBytes**: int (ReadOnly): The uploading pending data in bytes. +* **totalMemoryInBytes**: int (ReadOnly): The total memory. +* **totalSpaceInBytes**: int (ReadOnly): The total disk space. +* **usedMemoryInBytes**: int (ReadOnly): The used memory. +* **usedSpaceInBytes**: int (ReadOnly): The used disk space. +* **version**: string (ReadOnly): The version. + +## ProtectionContainerFabricSpecificDetails +### Properties +* **instanceType**: string (ReadOnly): Gets the class type. Overridden in derived classes. + +## ProtectionContainerMappingProviderSpecificDetails * **Discriminator**: instanceType ### Base Properties -### A2ACreateProtectionIntentInput +### A2AProtectionContainerMappingDetails #### Properties -* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto update is enabled. -* **automationAccountArmId**: string: The automation account arm id. -* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string: A value indicating the type authentication to use for automation Account. -* **autoProtectionOfDataDisk**: 'Disabled' | 'Enabled' | string: A value indicating whether the auto protection is enabled. -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **fabricObjectId**: string (Required): The fabric specific object Id of the virtual machine. -* **instanceType**: 'A2A' (Required): The class type. -* **multiVmGroupId**: string: The multi vm group id. -* **multiVmGroupName**: string: The multi vm group name. -* **primaryLocation**: string (Required): The primary location for the virtual machine. -* **primaryStagingStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (ReadOnly): Storage account custom input. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails) (WriteOnly): Storage account custom input. -* **protectionProfile**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (ReadOnly): Protection Profile custom input. -* **protectionProfileCustomInput**: [ProtectionProfileCustomDetails](#protectionprofilecustomdetails) (WriteOnly): Protection Profile custom input. -* **recoveryAvailabilitySet**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (ReadOnly): Recovery Availability Set custom input. -* **recoveryAvailabilitySetCustomInput**: [RecoveryAvailabilitySetCustomDetails](#recoveryavailabilitysetcustomdetails) (WriteOnly): Recovery Availability Set custom input. -* **recoveryAvailabilityType**: 'AvailabilitySet' | 'AvailabilityZone' | 'Single' | string (Required): The recovery availability type of the virtual machine. -* **recoveryAvailabilityZone**: string: The recovery availability zone. -* **recoveryBootDiagStorageAccount**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryLocation**: string (Required): The recovery location for the virtual machine. -* **recoveryProximityPlacementGroup**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (ReadOnly): Recovery Proximity placement group custom input. -* **recoveryProximityPlacementGroupCustomInput**: [RecoveryProximityPlacementGroupCustomDetails](#recoveryproximityplacementgroupcustomdetails) (WriteOnly): Recovery Proximity placement group custom input. -* **recoveryResourceGroupId**: string (Required): The recovery resource group Id. Valid for V2 scenarios. -* **recoverySubscriptionId**: string (Required): The recovery subscription Id of the virtual machine. -* **recoveryVirtualNetwork**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (ReadOnly): Recovery Virtual network custom input. -* **recoveryVirtualNetworkCustomInput**: [RecoveryVirtualNetworkCustomDetails](#recoveryvirtualnetworkcustomdetails) (WriteOnly): Recovery Virtual network custom input. -* **vmDisks**: [A2AProtectionIntentDiskInputDetails](#a2aprotectionintentdiskinputdetails)[]: The list of vm disk inputs. -* **vmManagedDisks**: [A2AProtectionIntentManagedDiskInputDetails](#a2aprotectionintentmanageddiskinputdetails)[]: The list of vm managed disk inputs. - +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (ReadOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (ReadOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (ReadOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): Gets the class type. Overridden in derived classes. +* **jobScheduleName**: string (ReadOnly): The job schedule arm name. +* **scheduleName**: string (ReadOnly): The schedule arm name. -## StorageAccountCustomDetails -* **Discriminator**: resourceType +### InMageRcmProtectionContainerMappingDetails +#### Properties +* **enableAgentAutoUpgrade**: string (ReadOnly): A value indicating whether the flag for enable agent auto upgrade. +* **instanceType**: 'InMageRcm' (Required): Gets the class type. Overridden in derived classes. -### Base Properties -### ExistingStorageAccount +### VMwareCbtProtectionContainerMappingDetails #### Properties -* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. -* **resourceType**: 'Existing' (Required): The class type. +* **instanceType**: 'VMwareCbt' (Required): Gets the class type. Overridden in derived classes. +* **keyVaultId**: string (ReadOnly): The target key vault ARM Id. +* **keyVaultUri**: string (ReadOnly): The target key vault URI. +* **serviceBusConnectionStringSecretName**: string (ReadOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (ReadOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (ReadOnly): The secret name of the storage account. +* **targetLocation**: string (ReadOnly): The target location. ## ProtectionProfileCustomDetails @@ -2122,96 +1951,41 @@ * **resourceType**: 'New' (Required): The class type. -## RecoveryAvailabilitySetCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryAvailabilitySet -#### Properties -* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryProximityPlacementGroupCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryProximityPlacementGroup -#### Properties -* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - - -## RecoveryVirtualNetworkCustomDetails -* **Discriminator**: resourceType - -### Base Properties -### ExistingRecoveryVirtualNetwork -#### Properties -* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. -* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. -* **resourceType**: 'Existing' (Required): The class type. - -### NewRecoveryVirtualNetwork -#### Properties -* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. -* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. -* **resourceType**: 'New' (Required): The class type. - - -## A2AProtectionIntentDiskInputDetails +## PushInstallerDetails ### Properties -* **diskUri**: string (Required): The disk Uri. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryAzureStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. +* **biosId**: string (ReadOnly): The push installer Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The push installer Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The push installer Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the push installer. +* **name**: string (ReadOnly): The push installer name. +* **version**: string (ReadOnly): The version. -## A2AProtectionIntentManagedDiskInputDetails +## RcmProxyDetails ### Properties -* **diskEncryptionInfo**: [DiskEncryptionInfo](#diskencryptioninfo): Recovery disk encryption info (BEK and KEK). -* **diskId**: string (Required): The disk Id. -* **primaryStagingStorageAccountCustomInput**: [StorageAccountCustomDetails](#storageaccountcustomdetails): Storage account custom input. -* **recoveryDiskEncryptionSetId**: string: The recovery disk encryption set Id. -* **recoveryReplicaDiskAccountType**: string: The replica disk type. Its an optional value and will be same as source disk type if not user provided. -* **recoveryResourceGroupCustomInput**: [RecoveryResourceGroupCustomDetails](#recoveryresourcegroupcustomdetails): Recovery Resource Group custom input. -* **recoveryTargetDiskAccountType**: string: The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. +* **biosId**: string (ReadOnly): The RCM proxy Bios Id. +* **clientAuthenticationType**: string (ReadOnly): The client authentication type. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The RCM proxy Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The RCM proxy Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the RCM proxy. +* **name**: string (ReadOnly): The RCM proxy name. +* **version**: string (ReadOnly): The version. -## RecoveryResourceGroupCustomDetails +## RecoveryAvailabilitySetCustomDetails * **Discriminator**: resourceType ### Base Properties -### ExistingRecoveryResourceGroup +### ExistingRecoveryAvailabilitySet #### Properties -* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **recoveryAvailabilitySetId**: string (WriteOnly): The recovery availability set Id. Will throw error, if resource does not exist. * **resourceType**: 'Existing' (Required): The class type. -## CreateRecoveryPlanInputProperties -### Properties -* **allowedOperations**: string[] (ReadOnly): The list of allowed operations. -* **currentScenario**: [CurrentScenarioDetails](#currentscenariodetails) (ReadOnly): Current scenario details of the protected entity. -* **currentScenarioStatus**: string (ReadOnly): The recovery plan status. -* **currentScenarioStatusDescription**: string (ReadOnly): The recovery plan status description. -* **failoverDeploymentModel**: 'Classic' | 'NotApplicable' | 'ResourceManager' | string: The failover deployment model. -* **friendlyName**: string (ReadOnly): The friendly name. -* **groups**: [RecoveryPlanGroup](#recoveryplangroup)[] (Required): The recovery plan groups. -* **lastPlannedFailoverTime**: string (ReadOnly): The start time of the last planned failover. -* **lastTestFailoverTime**: string (ReadOnly): The start time of the last test failover. -* **lastUnplannedFailoverTime**: string (ReadOnly): The start time of the last unplanned failover. -* **primaryFabricFriendlyName**: string (ReadOnly): The primary fabric friendly name. -* **primaryFabricId**: string (Required): The primary fabric Id. -* **providerSpecificDetails**: [RecoveryPlanProviderSpecificDetails](#recoveryplanproviderspecificdetails)[] (ReadOnly): The provider id and provider specific details. -* **providerSpecificInput**: [RecoveryPlanProviderSpecificInput](#recoveryplanproviderspecificinput)[] (WriteOnly): The provider specific input. -* **recoveryFabricFriendlyName**: string (ReadOnly): The recovery fabric friendly name. -* **recoveryFabricId**: string (Required): The recovery fabric Id. -* **replicationProviders**: string[] (ReadOnly): The list of replication providers. - -## RecoveryPlanGroup -### Properties -* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. -* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. -* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. -* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. - ## RecoveryPlanAction ### Properties * **actionName**: string (Required): The action name. @@ -2243,6 +2017,13 @@ * **timeout**: string: The script timeout. +## RecoveryPlanGroup +### Properties +* **endGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The end group actions. +* **groupType**: 'Boot' | 'Failover' | 'Shutdown' | string (Required): The group type. +* **replicationProtectedItems**: [RecoveryPlanProtectedItem](#recoveryplanprotecteditem)[]: The list of protected items. +* **startGroupActions**: [RecoveryPlanAction](#recoveryplanaction)[]: The start group actions. + ## RecoveryPlanProtectedItem ### Properties * **id**: string: The ARM Id of the recovery plan protected item. @@ -2272,8 +2053,227 @@ * **recoveryZone**: string (WriteOnly): The recovery zone. +## RecoveryProximityPlacementGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryProximityPlacementGroup +#### Properties +* **recoveryProximityPlacementGroupId**: string (WriteOnly): The recovery proximity placement group Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryResourceGroupCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryResourceGroup +#### Properties +* **recoveryResourceGroupId**: string: The recovery resource group Id. Valid for V2 scenarios. +* **resourceType**: 'Existing' (Required): The class type. + + +## RecoveryVirtualNetworkCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingRecoveryVirtualNetwork +#### Properties +* **recoverySubnetName**: string (WriteOnly): The recovery subnet name. +* **recoveryVirtualNetworkId**: string (Required, WriteOnly): The recovery virtual network Id. Will throw error, if resource does not exist. +* **resourceType**: 'Existing' (Required): The class type. + +### NewRecoveryVirtualNetwork +#### Properties +* **recoveryVirtualNetworkName**: string (WriteOnly): The recovery virtual network name. +* **recoveryVirtualNetworkResourceGroupName**: string (WriteOnly): The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM. +* **resourceType**: 'New' (Required): The class type. + + +## ReplicationAgentDetails +### Properties +* **biosId**: string (ReadOnly): The replication agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The replication agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The replication agent Id. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the replication agent. +* **name**: string (ReadOnly): The replication agent name. +* **version**: string (ReadOnly): The version. + +## ReplicationProviderSpecificContainerCreationInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerCreationInput +#### Properties +* **instanceType**: 'A2A' (Required): The class type. + +### A2ACrossClusterMigrationContainerCreationInput +#### Properties +* **instanceType**: 'A2ACrossClusterMigration' (Required): The class type. + +### VMwareCbtContainerCreationInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. + + +## ReplicationProviderSpecificContainerMappingInput +* **Discriminator**: instanceType + +### Base Properties +### A2AContainerMappingInput +#### Properties +* **agentAutoUpdateStatus**: 'Disabled' | 'Enabled' | string (WriteOnly): A value indicating whether the auto update is enabled. +* **automationAccountArmId**: string (WriteOnly): The automation account arm id. +* **automationAccountAuthenticationType**: 'RunAsAccount' | 'SystemAssignedIdentity' | string (WriteOnly): A value indicating the type authentication to use for automation Account. +* **instanceType**: 'A2A' (Required): The class type. + +### VMwareCbtContainerMappingInput +#### Properties +* **instanceType**: 'VMwareCbt' (Required): The class type. +* **keyVaultId**: string (WriteOnly): The target key vault ARM Id. +* **keyVaultUri**: string (WriteOnly): The target key vault URL. +* **serviceBusConnectionStringSecretName**: string (WriteOnly): The secret name of the service bus connection string. +* **storageAccountId**: string (Required, WriteOnly): The storage account ARM Id. +* **storageAccountSasSecretName**: string (WriteOnly): The secret name of the storage account. +* **targetLocation**: string (Required, WriteOnly): The target location. + + +## ReprotectAgentDetails +### Properties +* **accessibleDatastores**: string[] (ReadOnly): The list of accessible datastores fetched from discovery. +* **biosId**: string (ReadOnly): The reprotect agent Bios Id. +* **fabricObjectId**: string (ReadOnly): The fabric object Id. +* **fqdn**: string (ReadOnly): The reprotect agent Fqdn. +* **health**: 'Critical' | 'None' | 'Normal' | 'Warning' | string (ReadOnly): The health. +* **healthErrors**: [HealthError](#healtherror)[] (ReadOnly): The health errors. +* **id**: string (ReadOnly): The reprotect agent Id. +* **lastDiscoveryInUtc**: string (ReadOnly): The last time when SDS information discovered in SRS. +* **lastHeartbeatUtc**: string (ReadOnly): The last heartbeat received from the reprotect agent. +* **name**: string (ReadOnly): The reprotect agent name. +* **protectedItemCount**: int (ReadOnly): The protected item count. +* **vcenterId**: string (ReadOnly): The Vcenter Id. +* **version**: string (ReadOnly): The version. + +## RetentionVolume +### Properties +* **capacityInBytes**: int (ReadOnly): The volume capacity. +* **freeSpaceInBytes**: int (ReadOnly): The free space available in this volume. +* **thresholdPercentage**: int (ReadOnly): The threshold percentage. +* **volumeName**: string (ReadOnly): The volume name. + +## RunAsAccount +### Properties +* **accountId**: string (ReadOnly): The CS RunAs account Id. +* **accountName**: string (ReadOnly): The CS RunAs account name. + +## StorageAccountCustomDetails +* **Discriminator**: resourceType + +### Base Properties +### ExistingStorageAccount +#### Properties +* **azureStorageAccountId**: string (Required, WriteOnly): The storage account Arm Id. Throw error, if resource does not exists. +* **resourceType**: 'Existing' (Required): The class type. + + +## StorageMappingInputProperties +### Properties +* **targetStorageClassificationId**: string: The ID of the storage object. + ## VaultSettingCreationInputProperties ### Properties * **migrationSolutionId**: string: The migration solution Id. * **vmwareToAzureProviderType**: string: VMware to Azure provider type. +## VersionDetails +### Properties +* **expiryDate**: string (ReadOnly): Version expiry date. +* **status**: 'Deprecated' | 'NotSupported' | 'SecurityUpdateRequired' | 'Supported' | 'UpdateRequired' | string (ReadOnly): A value indicating whether security update required. +* **version**: string (ReadOnly): The agent version. + +## VMNicDetails +### Properties +* **enableAcceleratedNetworkingOnRecovery**: bool (ReadOnly): A value indicating whether the NIC has accelerated networking enabled. +* **enableAcceleratedNetworkingOnTfo**: bool (ReadOnly): Whether the TFO NIC has accelerated networking enabled. +* **ipConfigs**: [IPConfigDetails](#ipconfigdetails)[] (ReadOnly): The IP configurations of the NIC. +* **nicId**: string (ReadOnly): The nic Id. +* **recoveryNetworkSecurityGroupId**: string (ReadOnly): The id of the NSG associated with the NIC. +* **recoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs. +* **recoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs. +* **recoveryVMNetworkId**: string (ReadOnly): Recovery VM network Id. +* **replicaNicId**: string (ReadOnly): The replica nic Id. +* **reuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. +* **selectionType**: string (ReadOnly): Selection type for failover. +* **sourceNicArmId**: string (ReadOnly): The source nic ARM Id. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **tfoNetworkSecurityGroupId**: string (ReadOnly): The NSG to be used by NIC during test failover. +* **tfoRecoveryNicName**: string (ReadOnly): The name of the NIC to be used when creating target NICs in TFO. +* **tfoRecoveryNicResourceGroupName**: string (ReadOnly): The resource group of the NIC to be used when creating target NICs in TFO. +* **tfoReuseExistingNic**: bool (ReadOnly): A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. +* **tfoVMNetworkId**: string (ReadOnly): The network to be used by NIC during test failover. +* **vMNetworkName**: string (ReadOnly): VM network name. + +## VMwareCbtDiskInput +### Properties +* **diskEncryptionSetId**: string (WriteOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (Required, WriteOnly): The disk Id. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (WriteOnly): The DiskType. +* **isOSDisk**: string (Required, WriteOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (Required, WriteOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (Required, WriteOnly): The key vault secret name of the log storage account. + +## VMwareCbtEnableMigrationInputSeedDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetDiskTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetNicTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtEnableMigrationInputTargetVmTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## VMwareCbtNicDetails +### Properties +* **isPrimaryNic**: string (ReadOnly): A value indicating whether this is the primary NIC. +* **isSelectedForMigration**: string (ReadOnly): A value indicating whether this NIC is selected for migration. +* **nicId**: string (ReadOnly): The NIC Id. +* **sourceIPAddress**: string (ReadOnly): The source IP address. +* **sourceIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **sourceNetworkId**: string (ReadOnly): Source network Id. +* **targetIPAddress**: string (ReadOnly): The target IP address. +* **targetIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **targetNicName**: string (ReadOnly): Target NIC name. +* **targetSubnetName**: string (ReadOnly): Target subnet name. +* **testIPAddress**: string (ReadOnly): The test IP address. +* **testIPAddressType**: 'Dynamic' | 'Static' | string (ReadOnly): The source IP address type. +* **testNetworkId**: string (ReadOnly): Source network Id. +* **testSubnetName**: string (ReadOnly): Test subnet name. + +## VMwareCbtProtectedDiskDetails +### Properties +* **capacityInBytes**: int (ReadOnly): The disk capacity in bytes. +* **diskEncryptionSetId**: string (ReadOnly): The DiskEncryptionSet ARM Id. +* **diskId**: string (ReadOnly): The disk id. +* **diskName**: string (ReadOnly): The disk name. +* **diskPath**: string (ReadOnly): The disk path. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (ReadOnly): The DiskType. +* **isOSDisk**: string (ReadOnly): A value indicating whether the disk is the OS disk. +* **logStorageAccountId**: string (ReadOnly): The log storage account ARM Id. +* **logStorageAccountSasSecretName**: string (ReadOnly): The key vault secret name of the log storage account. +* **seedManagedDiskId**: string (ReadOnly): The ARM Id of the seed managed disk. +* **targetDiskName**: string (ReadOnly): The name for the target managed disk. +* **targetManagedDiskId**: string (ReadOnly): The ARM Id of the target managed disk. + diff --git a/generated/redhatopenshift/log.out b/generated/redhatopenshift/log.out index fb519dfb49..47fdf4221a 100644 --- a/generated/redhatopenshift/log.out +++ b/generated/redhatopenshift/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.redhatopenshift-2020-04-30"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'APIServerProfile' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json:403:5 @@ -45,17 +45,17 @@ warning | PreCheck/SchemaMissingType | The schema 'ServicePrincipalProfile' with warning | PreCheck/SchemaMissingType | The schema 'WorkerProfile' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json:746:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.redhatopenshift-2021-09-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.redhatopenshift-2022-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 8.06s. 6 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 7.58s. 6 files generated. diff --git a/generated/redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.md b/generated/redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.md index 5410b936a2..166d72a72e 100644 --- a/generated/redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.md +++ b/generated/redhatopenshift/microsoft.redhatopenshift/2020-04-30/types.md @@ -16,18 +16,6 @@ * **ApiVersion**: 2020-04-30 * **Output**: [OpenShiftClusterCredentials](#openshiftclustercredentials) -## OpenShiftClusterProperties -### Properties -* **apiserverProfile**: [APIServerProfile](#apiserverprofile): APIServerProfile represents an API server profile. -* **clusterProfile**: [ClusterProfile](#clusterprofile): ClusterProfile represents a cluster profile. -* **consoleProfile**: [ConsoleProfile](#consoleprofile): ConsoleProfile represents a console profile. -* **ingressProfiles**: [IngressProfile](#ingressprofile)[]: The cluster ingress profiles. -* **masterProfile**: [MasterProfile](#masterprofile): MasterProfile represents a master profile. -* **networkProfile**: [NetworkProfile](#networkprofile): NetworkProfile represents a network profile. -* **provisioningState**: 'AdminUpdating' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ProvisioningState represents a provisioning state. -* **servicePrincipalProfile**: [ServicePrincipalProfile](#serviceprincipalprofile): ServicePrincipalProfile represents a service principal profile. -* **workerProfiles**: [WorkerProfile](#workerprofile)[]: The cluster worker profiles. - ## APIServerProfile ### Properties * **ip**: string: The IP of the cluster API server (immutable). @@ -61,11 +49,33 @@ * **podCidr**: string: The CIDR used for OpenShift/Kubernetes Pods (immutable). * **serviceCidr**: string: The CIDR used for OpenShift/Kubernetes Services (immutable). +## OpenShiftClusterCredentials +### Properties +* **kubeadminPassword**: string (ReadOnly): The password for the kubeadmin user +* **kubeadminUsername**: string (ReadOnly): The username for the kubeadmin user + +## OpenShiftClusterProperties +### Properties +* **apiserverProfile**: [APIServerProfile](#apiserverprofile): APIServerProfile represents an API server profile. +* **clusterProfile**: [ClusterProfile](#clusterprofile): ClusterProfile represents a cluster profile. +* **consoleProfile**: [ConsoleProfile](#consoleprofile): ConsoleProfile represents a console profile. +* **ingressProfiles**: [IngressProfile](#ingressprofile)[]: The cluster ingress profiles. +* **masterProfile**: [MasterProfile](#masterprofile): MasterProfile represents a master profile. +* **networkProfile**: [NetworkProfile](#networkprofile): NetworkProfile represents a network profile. +* **provisioningState**: 'AdminUpdating' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ProvisioningState represents a provisioning state. +* **servicePrincipalProfile**: [ServicePrincipalProfile](#serviceprincipalprofile): ServicePrincipalProfile represents a service principal profile. +* **workerProfiles**: [WorkerProfile](#workerprofile)[]: The cluster worker profiles. + ## ServicePrincipalProfile ### Properties * **clientId**: string: The client ID used for the cluster (immutable). * **clientSecret**: string: The client secret used for the cluster (immutable). +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## WorkerProfile ### Properties * **count**: int: The number of worker VMs. Must be between 3 and 20 (immutable). @@ -74,13 +84,3 @@ * **subnetId**: string: The Azure resource ID of the worker subnet (immutable). * **vmSize**: 'Standard_D2s_v3' | 'Standard_D4s_v3' | 'Standard_D8s_v3' | string: VMSize represents a VM size. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## OpenShiftClusterCredentials -### Properties -* **kubeadminPassword**: string (ReadOnly): The password for the kubeadmin user -* **kubeadminUsername**: string (ReadOnly): The username for the kubeadmin user - diff --git a/generated/redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.md b/generated/redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.md index c98a84e03c..32ebf4b2a1 100644 --- a/generated/redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.md +++ b/generated/redhatopenshift/microsoft.redhatopenshift/2021-09-01-preview/types.md @@ -22,18 +22,6 @@ * **ApiVersion**: 2021-09-01-preview * **Output**: [OpenShiftClusterCredentials](#openshiftclustercredentials) -## OpenShiftClusterProperties -### Properties -* **apiserverProfile**: [APIServerProfile](#apiserverprofile): APIServerProfile represents an API server profile. -* **clusterProfile**: [ClusterProfile](#clusterprofile): ClusterProfile represents a cluster profile. -* **consoleProfile**: [ConsoleProfile](#consoleprofile): ConsoleProfile represents a console profile. -* **ingressProfiles**: [IngressProfile](#ingressprofile)[]: The cluster ingress profiles. -* **masterProfile**: [MasterProfile](#masterprofile): MasterProfile represents a master profile. -* **networkProfile**: [NetworkProfile](#networkprofile): NetworkProfile represents a network profile. -* **provisioningState**: 'AdminUpdating' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ProvisioningState represents a provisioning state. -* **servicePrincipalProfile**: [ServicePrincipalProfile](#serviceprincipalprofile): ServicePrincipalProfile represents a service principal profile. -* **workerProfiles**: [WorkerProfile](#workerprofile)[]: The cluster worker profiles. - ## APIServerProfile ### Properties * **ip**: string: The IP of the cluster API server. @@ -70,21 +58,32 @@ * **serviceCidr**: string: The CIDR used for OpenShift/Kubernetes Services. * **softwareDefinedNetwork**: 'OVNKubernetes' | 'OpenShiftSDN' | string: SoftwareDefinedNetwork constants. +## OpenShiftClusterAdminKubeconfig +### Properties +* **kubeconfig**: string (ReadOnly): The base64-encoded kubeconfig file. + +## OpenShiftClusterCredentials +### Properties +* **kubeadminPassword**: string (ReadOnly): The password for the kubeadmin user. +* **kubeadminUsername**: string (ReadOnly): The username for the kubeadmin user. + +## OpenShiftClusterProperties +### Properties +* **apiserverProfile**: [APIServerProfile](#apiserverprofile): APIServerProfile represents an API server profile. +* **clusterProfile**: [ClusterProfile](#clusterprofile): ClusterProfile represents a cluster profile. +* **consoleProfile**: [ConsoleProfile](#consoleprofile): ConsoleProfile represents a console profile. +* **ingressProfiles**: [IngressProfile](#ingressprofile)[]: The cluster ingress profiles. +* **masterProfile**: [MasterProfile](#masterprofile): MasterProfile represents a master profile. +* **networkProfile**: [NetworkProfile](#networkprofile): NetworkProfile represents a network profile. +* **provisioningState**: 'AdminUpdating' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ProvisioningState represents a provisioning state. +* **servicePrincipalProfile**: [ServicePrincipalProfile](#serviceprincipalprofile): ServicePrincipalProfile represents a service principal profile. +* **workerProfiles**: [WorkerProfile](#workerprofile)[]: The cluster worker profiles. + ## ServicePrincipalProfile ### Properties * **clientId**: string: The client ID used for the cluster. * **clientSecret**: string: The client secret used for the cluster. -## WorkerProfile -### Properties -* **count**: int: The number of worker VMs. -* **diskEncryptionSetId**: string: The resource ID of an associated DiskEncryptionSet, if applicable. -* **diskSizeGB**: int: The disk size of the worker VMs. -* **encryptionAtHost**: 'Disabled' | 'Enabled' | string: EncryptionAtHost represents encryption at host state -* **name**: string: The worker profile name. -* **subnetId**: string: The Azure resource ID of the worker subnet. -* **vmSize**: 'Standard_D16as_v4' | 'Standard_D16s_v3' | 'Standard_D2s_v3' | 'Standard_D32as_v4' | 'Standard_D32s_v3' | 'Standard_D4as_v4' | 'Standard_D4s_v3' | 'Standard_D8as_v4' | 'Standard_D8s_v3' | 'Standard_E16s_v3' | 'Standard_E32s_v3' | 'Standard_E4s_v3' | 'Standard_E64i_v3' | 'Standard_E64is_v3' | 'Standard_E8s_v3' | 'Standard_F16s_v2' | 'Standard_F32s_v2' | 'Standard_F4s_v2' | 'Standard_F72s_v2' | 'Standard_F8s_v2' | 'Standard_G5' | 'Standard_GS5' | 'Standard_M128ms' | string: VMSize represents a VM size. - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -99,12 +98,13 @@ ### Additional Properties * **Additional Properties Type**: string -## OpenShiftClusterAdminKubeconfig -### Properties -* **kubeconfig**: string (ReadOnly): The base64-encoded kubeconfig file. - -## OpenShiftClusterCredentials +## WorkerProfile ### Properties -* **kubeadminPassword**: string (ReadOnly): The password for the kubeadmin user. -* **kubeadminUsername**: string (ReadOnly): The username for the kubeadmin user. +* **count**: int: The number of worker VMs. +* **diskEncryptionSetId**: string: The resource ID of an associated DiskEncryptionSet, if applicable. +* **diskSizeGB**: int: The disk size of the worker VMs. +* **encryptionAtHost**: 'Disabled' | 'Enabled' | string: EncryptionAtHost represents encryption at host state +* **name**: string: The worker profile name. +* **subnetId**: string: The Azure resource ID of the worker subnet. +* **vmSize**: 'Standard_D16as_v4' | 'Standard_D16s_v3' | 'Standard_D2s_v3' | 'Standard_D32as_v4' | 'Standard_D32s_v3' | 'Standard_D4as_v4' | 'Standard_D4s_v3' | 'Standard_D8as_v4' | 'Standard_D8s_v3' | 'Standard_E16s_v3' | 'Standard_E32s_v3' | 'Standard_E4s_v3' | 'Standard_E64i_v3' | 'Standard_E64is_v3' | 'Standard_E8s_v3' | 'Standard_F16s_v2' | 'Standard_F32s_v2' | 'Standard_F4s_v2' | 'Standard_F72s_v2' | 'Standard_F8s_v2' | 'Standard_G5' | 'Standard_GS5' | 'Standard_M128ms' | string: VMSize represents a VM size. diff --git a/generated/redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.md b/generated/redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.md index 25637a9d5c..1c6f37ee24 100644 --- a/generated/redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.md +++ b/generated/redhatopenshift/microsoft.redhatopenshift/2022-04-01/types.md @@ -22,18 +22,6 @@ * **ApiVersion**: 2022-04-01 * **Output**: [OpenShiftClusterCredentials](#openshiftclustercredentials) -## OpenShiftClusterProperties -### Properties -* **apiserverProfile**: [APIServerProfile](#apiserverprofile): APIServerProfile represents an API server profile. -* **clusterProfile**: [ClusterProfile](#clusterprofile): ClusterProfile represents a cluster profile. -* **consoleProfile**: [ConsoleProfile](#consoleprofile): ConsoleProfile represents a console profile. -* **ingressProfiles**: [IngressProfile](#ingressprofile)[]: The cluster ingress profiles. -* **masterProfile**: [MasterProfile](#masterprofile): MasterProfile represents a master profile. -* **networkProfile**: [NetworkProfile](#networkprofile): NetworkProfile represents a network profile. -* **provisioningState**: 'AdminUpdating' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ProvisioningState represents a provisioning state. -* **servicePrincipalProfile**: [ServicePrincipalProfile](#serviceprincipalprofile): ServicePrincipalProfile represents a service principal profile. -* **workerProfiles**: [WorkerProfile](#workerprofile)[]: The cluster worker profiles. - ## APIServerProfile ### Properties * **ip**: string: The IP of the cluster API server. @@ -72,23 +60,32 @@ For more details on restricted VM sizes, see: https://docs.microsoft.com/en-us/a * **podCidr**: string: The CIDR used for OpenShift/Kubernetes Pods. * **serviceCidr**: string: The CIDR used for OpenShift/Kubernetes Services. +## OpenShiftClusterAdminKubeconfig +### Properties +* **kubeconfig**: string (ReadOnly): The base64-encoded kubeconfig file. + +## OpenShiftClusterCredentials +### Properties +* **kubeadminPassword**: string (ReadOnly): The password for the kubeadmin user. +* **kubeadminUsername**: string (ReadOnly): The username for the kubeadmin user. + +## OpenShiftClusterProperties +### Properties +* **apiserverProfile**: [APIServerProfile](#apiserverprofile): APIServerProfile represents an API server profile. +* **clusterProfile**: [ClusterProfile](#clusterprofile): ClusterProfile represents a cluster profile. +* **consoleProfile**: [ConsoleProfile](#consoleprofile): ConsoleProfile represents a console profile. +* **ingressProfiles**: [IngressProfile](#ingressprofile)[]: The cluster ingress profiles. +* **masterProfile**: [MasterProfile](#masterprofile): MasterProfile represents a master profile. +* **networkProfile**: [NetworkProfile](#networkprofile): NetworkProfile represents a network profile. +* **provisioningState**: 'AdminUpdating' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ProvisioningState represents a provisioning state. +* **servicePrincipalProfile**: [ServicePrincipalProfile](#serviceprincipalprofile): ServicePrincipalProfile represents a service principal profile. +* **workerProfiles**: [WorkerProfile](#workerprofile)[]: The cluster worker profiles. + ## ServicePrincipalProfile ### Properties * **clientId**: string: The client ID used for the cluster. * **clientSecret**: string: The client secret used for the cluster. -## WorkerProfile -### Properties -* **count**: int: The number of worker VMs. -* **diskEncryptionSetId**: string: The resource ID of an associated DiskEncryptionSet, if applicable. -* **diskSizeGB**: int: The disk size of the worker VMs. -* **encryptionAtHost**: 'Disabled' | 'Enabled' | string: EncryptionAtHost represents encryption at host state -* **name**: string: The worker profile name. -* **subnetId**: string: The Azure resource ID of the worker subnet. -* **vmSize**: string: VM size availability varies by region. -If a node contains insufficient compute resources (memory, cpu, etc.), pods might fail to run correctly. -For more details on restricted VM sizes, see: https://docs.microsoft.com/en-us/azure/openshift/support-policies-v4#supported-virtual-machine-sizes - ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -103,12 +100,15 @@ For more details on restricted VM sizes, see: https://docs.microsoft.com/en-us/a ### Additional Properties * **Additional Properties Type**: string -## OpenShiftClusterAdminKubeconfig -### Properties -* **kubeconfig**: string (ReadOnly): The base64-encoded kubeconfig file. - -## OpenShiftClusterCredentials +## WorkerProfile ### Properties -* **kubeadminPassword**: string (ReadOnly): The password for the kubeadmin user. -* **kubeadminUsername**: string (ReadOnly): The username for the kubeadmin user. +* **count**: int: The number of worker VMs. +* **diskEncryptionSetId**: string: The resource ID of an associated DiskEncryptionSet, if applicable. +* **diskSizeGB**: int: The disk size of the worker VMs. +* **encryptionAtHost**: 'Disabled' | 'Enabled' | string: EncryptionAtHost represents encryption at host state +* **name**: string: The worker profile name. +* **subnetId**: string: The Azure resource ID of the worker subnet. +* **vmSize**: string: VM size availability varies by region. +If a node contains insufficient compute resources (memory, cpu, etc.), pods might fail to run correctly. +For more details on restricted VM sizes, see: https://docs.microsoft.com/en-us/azure/openshift/support-policies-v4#supported-virtual-machine-sizes diff --git a/generated/redis/log.out b/generated/redis/log.out index 9d5a039e6e..f64e32a5e0 100644 --- a/generated/redis/log.out +++ b/generated/redis/log.out @@ -10,7 +10,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.cache-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -20,7 +20,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/redis.json:1831:5 @@ -100,7 +100,7 @@ warning | Modeler/MissingType | The schema 'components·jb1v7t·schemas·redisco warning | Modeler/MissingType | The schema 'components·pgz285·schemas·operationstatus·properties·properties·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2021-06-01/redis.json#/components/schemas/components·pgz285·schemas·operationstatus·properties·properties·additionalproperties warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorDetail' -> 'ErrorDetailAutoGenerated' -info | autorest.bicep took 15ms +info | autorest.bicep took 25ms info | Processing batch task - {"tag":"microsoft.cache-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -110,7 +110,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json:1784:5 @@ -193,7 +193,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json:1781:5 @@ -278,7 +278,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'Resource' (4 differ - properties.type.description: "Resource type." => "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" - title: => "Resource" warning | PreNamer/DeduplicateName | Deduplicating schema name: 'Resource' -> 'ResourceAutoGenerated' -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.cache-2019-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -288,7 +288,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/redis.json:1353:5 @@ -377,7 +377,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json:1348:5 @@ -454,7 +454,7 @@ warning | PreCheck/SchemaMissingType | The schema 'UpgradeNotification' with an warning | PreCheck/SchemaMissingType | The schema 'NotificationListResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json:2153:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.cache-2017-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -464,7 +464,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json:1345:5 @@ -551,7 +551,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2017-02-01/redis.json:1161:5 @@ -630,7 +630,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json:955:5 @@ -691,7 +691,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2015-08-01/redis.json:371:5 @@ -721,4 +721,4 @@ warning | PreCheck/SchemaMissingType | The schema 'RedisRebootParameters' with a - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redis/resource-manager/Microsoft.Cache/stable/2015-08-01/redis.json:648:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 24.18s. 18 files generated. +info | Autorest completed in 22.78s. 18 files generated. diff --git a/generated/redis/microsoft.cache/2015-08-01/types.md b/generated/redis/microsoft.cache/2015-08-01/types.md index f65abf3480..fada671c9e 100644 --- a/generated/redis/microsoft.cache/2015-08-01/types.md +++ b/generated/redis/microsoft.cache/2015-08-01/types.md @@ -16,6 +16,11 @@ * **ApiVersion**: 2015-08-01 * **Output**: [RedisListKeysResult](#redislistkeysresult) +## RedisListKeysResult +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + ## RedisProperties ### Properties * **enableNonSslPort**: bool: If the value is true, then the non-SLL Redis server port (6379) will be enabled. @@ -37,12 +42,6 @@ ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): Which family to use. Valid values: (C, P). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): What type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). - ## RedisPropertiesTenantSettings ### Properties ### Additional Properties @@ -53,8 +52,9 @@ ### Additional Properties * **Additional Properties Type**: string -## RedisListKeysResult +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): Which family to use. Valid values: (C, P). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): What type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). diff --git a/generated/redis/microsoft.cache/2016-04-01/types.md b/generated/redis/microsoft.cache/2016-04-01/types.md index fd9c76bb95..8d6a642c49 100644 --- a/generated/redis/microsoft.cache/2016-04-01/types.md +++ b/generated/redis/microsoft.cache/2016-04-01/types.md @@ -35,6 +35,16 @@ * **ApiVersion**: 2016-04-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + ## RedisCreateProperties ### Properties * **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. @@ -51,22 +61,16 @@ * **subnetId**: 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 * **tenantSettings**: [RedisPropertiesTenantSettings](#redispropertiestenantsettings): tenantSettings -## RedisAccessKeys +## RedisFirewallRuleProperties ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **endIP**: string (Required): highest IP address included in the range +* **startIP**: string (Required): lowest IP address included in the range ## RedisPropertiesRedisConfiguration ### Properties ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - ## RedisPropertiesTenantSettings ### Properties ### Additional Properties @@ -77,11 +81,6 @@ ### Additional Properties * **Additional Properties Type**: string -## RedisFirewallRuleProperties -### Properties -* **endIP**: string (Required): highest IP address included in the range -* **startIP**: string (Required): lowest IP address included in the range - ## ScheduleEntries ### Properties * **scheduleEntries**: [ScheduleEntry](#scheduleentry)[] (Required): List of patch schedules for a Redis cache. @@ -92,8 +91,9 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) diff --git a/generated/redis/microsoft.cache/2017-02-01/types.md b/generated/redis/microsoft.cache/2017-02-01/types.md index 34c08bb112..bd19e74acb 100644 --- a/generated/redis/microsoft.cache/2017-02-01/types.md +++ b/generated/redis/microsoft.cache/2017-02-01/types.md @@ -44,6 +44,16 @@ * **ApiVersion**: 2017-02-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + ## RedisCreateProperties ### Properties * **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. @@ -61,52 +71,36 @@ * **subnetId**: 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 * **tenantSettings**: [RedisPropertiesTenantSettings](#redispropertiestenantsettings): tenantSettings -## RedisAccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. - -## RedisLinkedServerList +## RedisFirewallRuleProperties ### Properties -* **value**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of linked server Ids of a Redis cache. +* **endIP**: string (Required): highest IP address included in the range +* **startIP**: string (Required): lowest IP address included in the range ## RedisLinkedServer ### Properties * **id**: string (ReadOnly): Linked server Id. -## RedisPropertiesRedisConfiguration +## RedisLinkedServerCreateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. +* **linkedRedisCacheLocation**: string (Required): Location of the linked redis cache. +* **provisioningState**: string (ReadOnly): Terminal state of the link between primary and secondary redis cache. +* **serverRole**: 'Primary' | 'Secondary' (Required): Role of the linked server. -## Sku +## RedisLinkedServerList ### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) +* **value**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of linked server Ids of a Redis cache. -## RedisPropertiesTenantSettings +## RedisPropertiesRedisConfiguration ### Properties ### Additional Properties * **Additional Properties Type**: string -## TrackedResourceTags +## RedisPropertiesTenantSettings ### Properties ### Additional Properties * **Additional Properties Type**: string -## RedisFirewallRuleProperties -### Properties -* **endIP**: string (Required): highest IP address included in the range -* **startIP**: string (Required): lowest IP address included in the range - -## RedisLinkedServerCreateProperties -### Properties -* **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. -* **linkedRedisCacheLocation**: string (Required): Location of the linked redis cache. -* **provisioningState**: string (ReadOnly): Terminal state of the link between primary and secondary redis cache. -* **serverRole**: 'Primary' | 'Secondary' (Required): Role of the linked server. - ## ScheduleEntries ### Properties * **scheduleEntries**: [ScheduleEntry](#scheduleentry)[] (Required): List of patch schedules for a Redis cache. @@ -117,8 +111,14 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/redis/microsoft.cache/2017-10-01/types.md b/generated/redis/microsoft.cache/2017-10-01/types.md index 91dd2f3284..1358ad6186 100644 --- a/generated/redis/microsoft.cache/2017-10-01/types.md +++ b/generated/redis/microsoft.cache/2017-10-01/types.md @@ -44,43 +44,21 @@ * **ApiVersion**: 2017-10-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) -## RedisCreateProperties -### Properties -* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. -* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. -* **hostName**: string (ReadOnly): Redis host name. -* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache -* **port**: int (ReadOnly): Redis non-SSL port. -* **provisioningState**: string (ReadOnly): Redis instance provisioning status. -* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. -* **redisVersion**: string (ReadOnly): Redis version. -* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. -* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. -* **sslPort**: int (ReadOnly): Redis SSL port. -* **staticIP**: string: Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. -* **subnetId**: 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 -* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings - ## RedisAccessKeys ### Properties * **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. * **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. -## RedisLinkedServer +## RedisAccessKeys ### Properties -* **id**: string (ReadOnly): Linked server Id. +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. ## RedisCommonPropertiesRedisConfiguration ### Properties ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - ## RedisCommonPropertiesTenantSettings ### Properties ### Additional Properties @@ -91,11 +69,32 @@ ### Additional Properties * **Additional Properties Type**: string +## RedisCreateProperties +### Properties +* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. +* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. +* **hostName**: string (ReadOnly): Redis host name. +* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache +* **port**: int (ReadOnly): Redis non-SSL port. +* **provisioningState**: string (ReadOnly): Redis instance provisioning status. +* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. +* **redisVersion**: string (ReadOnly): Redis version. +* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. +* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. +* **sslPort**: int (ReadOnly): Redis SSL port. +* **staticIP**: string: Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. +* **subnetId**: 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 +* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings + ## RedisFirewallRuleProperties ### Properties * **endIP**: string (Required): highest IP address included in the range * **startIP**: string (Required): lowest IP address included in the range +## RedisLinkedServer +### Properties +* **id**: string (ReadOnly): Linked server Id. + ## RedisLinkedServerCreateProperties ### Properties * **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. @@ -113,8 +112,9 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) diff --git a/generated/redis/microsoft.cache/2018-03-01/types.md b/generated/redis/microsoft.cache/2018-03-01/types.md index a461a35d0d..4671166d47 100644 --- a/generated/redis/microsoft.cache/2018-03-01/types.md +++ b/generated/redis/microsoft.cache/2018-03-01/types.md @@ -44,44 +44,21 @@ * **ApiVersion**: 2018-03-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) -## RedisCreateProperties -### Properties -* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. -* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. -* **hostName**: string (ReadOnly): Redis host name. -* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache -* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') -* **port**: int (ReadOnly): Redis non-SSL port. -* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. -* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. -* **redisVersion**: string (ReadOnly): Redis version. -* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. -* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. -* **sslPort**: int (ReadOnly): Redis SSL port. -* **staticIP**: string: Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. -* **subnetId**: 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 -* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings - ## RedisAccessKeys ### Properties * **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. * **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. -## RedisLinkedServer +## RedisAccessKeys ### Properties -* **id**: string (ReadOnly): Linked server Id. +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. ## RedisCommonPropertiesRedisConfiguration ### Properties ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **capacity**: int (Required): 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, 5). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - ## RedisCommonPropertiesTenantSettings ### Properties ### Additional Properties @@ -92,11 +69,33 @@ ### Additional Properties * **Additional Properties Type**: string +## RedisCreateProperties +### Properties +* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. +* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. +* **hostName**: string (ReadOnly): Redis host name. +* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache +* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') +* **port**: int (ReadOnly): Redis non-SSL port. +* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. +* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. +* **redisVersion**: string (ReadOnly): Redis version. +* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. +* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. +* **sslPort**: int (ReadOnly): Redis SSL port. +* **staticIP**: string: Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network. +* **subnetId**: 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 +* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings + ## RedisFirewallRuleProperties ### Properties * **endIP**: string (Required): highest IP address included in the range * **startIP**: string (Required): lowest IP address included in the range +## RedisLinkedServer +### Properties +* **id**: string (ReadOnly): Linked server Id. + ## RedisLinkedServerCreateProperties ### Properties * **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. @@ -114,8 +113,9 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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, 5). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) diff --git a/generated/redis/microsoft.cache/2019-07-01/types.md b/generated/redis/microsoft.cache/2019-07-01/types.md index c57ee22fdb..bae6ac82f1 100644 --- a/generated/redis/microsoft.cache/2019-07-01/types.md +++ b/generated/redis/microsoft.cache/2019-07-01/types.md @@ -44,6 +44,31 @@ * **ApiVersion**: 2019-07-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisCommonPropertiesRedisConfiguration +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RedisCommonPropertiesTenantSettings +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RedisCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## RedisCreateProperties ### Properties * **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. @@ -64,10 +89,10 @@ * **subnetId**: 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 * **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings -## RedisAccessKeys +## RedisFirewallRuleProperties ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **endIP**: string (Required): highest IP address included in the range +* **startIP**: string (Required): lowest IP address included in the range ## RedisInstanceDetails ### Properties @@ -81,32 +106,6 @@ ### Properties * **id**: string (ReadOnly): Linked server Id. -## RedisCommonPropertiesRedisConfiguration -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Sku -### Properties -* **capacity**: int (Required): 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, 5). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - -## RedisCommonPropertiesTenantSettings -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RedisCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## RedisFirewallRuleProperties -### Properties -* **endIP**: string (Required): highest IP address included in the range -* **startIP**: string (Required): lowest IP address included in the range - ## RedisLinkedServerCreateProperties ### Properties * **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. @@ -124,8 +123,9 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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, 5). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) diff --git a/generated/redis/microsoft.cache/2020-06-01/types.md b/generated/redis/microsoft.cache/2020-06-01/types.md index 915e9c2197..6855c8ec86 100644 --- a/generated/redis/microsoft.cache/2020-06-01/types.md +++ b/generated/redis/microsoft.cache/2020-06-01/types.md @@ -53,44 +53,9 @@ * **ApiVersion**: 2020-06-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) -## RedisCreateProperties -### Properties -* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. -* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. -* **hostName**: string (ReadOnly): Redis host name. -* **instances**: [RedisInstanceDetails](#redisinstancedetails)[] (ReadOnly): List of the Redis instances associated with the cache -* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache -* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') -* **port**: int (ReadOnly): Redis non-SSL port. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified redis cache -* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' -* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. -* **redisVersion**: string (ReadOnly): Redis version. -* **replicasPerMaster**: int: The number of replicas to be created per master. -* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. -* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. -* **sslPort**: int (ReadOnly): Redis SSL port. -* **staticIP**: string: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. -* **subnetId**: 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 -* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings - -## RedisAccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. - -## RedisInstanceDetails -### Properties -* **isMaster**: bool (ReadOnly): Specifies whether the instance is a master node. -* **nonSslPort**: int (ReadOnly): If enableNonSslPort is true, provides Redis instance Non-SSL port. -* **shardId**: int (ReadOnly): If clustering is enabled, the Shard ID of Redis Instance -* **sslPort**: int (ReadOnly): Redis instance SSL port. -* **zone**: string (ReadOnly): If the Cache uses availability zones, specifies availability zone where this instance is located. - -## RedisLinkedServer +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Linked server Id. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -105,16 +70,22 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. * **description**: string (ReadOnly): The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + ## RedisCommonPropertiesRedisConfiguration ### Properties * **aof-storage-connection-string-0**: string: First storage account connection string @@ -131,12 +102,6 @@ ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - ## RedisCommonPropertiesTenantSettings ### Properties ### Additional Properties @@ -147,11 +112,45 @@ ### Additional Properties * **Additional Properties Type**: string +## RedisCreateProperties +### Properties +* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. +* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. +* **hostName**: string (ReadOnly): Redis host name. +* **instances**: [RedisInstanceDetails](#redisinstancedetails)[] (ReadOnly): List of the Redis instances associated with the cache +* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache +* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') +* **port**: int (ReadOnly): Redis non-SSL port. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified redis cache +* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' +* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. +* **redisVersion**: string (ReadOnly): Redis version. +* **replicasPerMaster**: int: The number of replicas to be created per master. +* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. +* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. +* **sslPort**: int (ReadOnly): Redis SSL port. +* **staticIP**: string: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. +* **subnetId**: 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 +* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings + ## RedisFirewallRuleProperties ### Properties * **endIP**: string (Required): highest IP address included in the range * **startIP**: string (Required): lowest IP address included in the range +## RedisInstanceDetails +### Properties +* **isMaster**: bool (ReadOnly): Specifies whether the instance is a master node. +* **nonSslPort**: int (ReadOnly): If enableNonSslPort is true, provides Redis instance Non-SSL port. +* **shardId**: int (ReadOnly): If clustering is enabled, the Shard ID of Redis Instance +* **sslPort**: int (ReadOnly): Redis instance SSL port. +* **zone**: string (ReadOnly): If the Cache uses availability zones, specifies availability zone where this instance is located. + +## RedisLinkedServer +### Properties +* **id**: string (ReadOnly): Linked server Id. + ## RedisLinkedServerCreateProperties ### Properties * **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. @@ -169,8 +168,9 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) diff --git a/generated/redis/microsoft.cache/2020-12-01/types.md b/generated/redis/microsoft.cache/2020-12-01/types.md index 9d743b6f4c..03820da4c5 100644 --- a/generated/redis/microsoft.cache/2020-12-01/types.md +++ b/generated/redis/microsoft.cache/2020-12-01/types.md @@ -54,46 +54,9 @@ * **ApiVersion**: 2020-12-01 * **Output**: [RedisAccessKeys](#redisaccesskeys) -## RedisCreateProperties -### Properties -* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. -* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. -* **hostName**: string (ReadOnly): Redis host name. -* **instances**: [RedisInstanceDetails](#redisinstancedetails)[] (ReadOnly): List of the Redis instances associated with the cache -* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache -* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') -* **port**: int (ReadOnly): Redis non-SSL port. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified redis cache -* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' -* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. -* **redisVersion**: string: Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) -* **replicasPerMaster**: int: The number of replicas to be created per primary. -* **replicasPerPrimary**: int: The number of replicas to be created per primary. -* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. -* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. -* **sslPort**: int (ReadOnly): Redis SSL port. -* **staticIP**: string: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. -* **subnetId**: 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 -* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings - -## RedisAccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. - -## RedisInstanceDetails -### Properties -* **isMaster**: bool (ReadOnly): Specifies whether the instance is a primary node. -* **isPrimary**: bool (ReadOnly): Specifies whether the instance is a primary node. -* **nonSslPort**: int (ReadOnly): If enableNonSslPort is true, provides Redis instance Non-SSL port. -* **shardId**: int (ReadOnly): If clustering is enabled, the Shard ID of Redis Instance -* **sslPort**: int (ReadOnly): Redis instance SSL port. -* **zone**: string (ReadOnly): If the Cache uses availability zones, specifies availability zone where this instance is located. - -## RedisLinkedServer +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Linked server Id. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -108,16 +71,22 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. * **description**: string (ReadOnly): The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + ## RedisCommonPropertiesRedisConfiguration ### Properties * **aof-storage-connection-string-0**: string: First storage account connection string @@ -135,12 +104,6 @@ ### Additional Properties * **Additional Properties Type**: string -## Sku -### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - ## RedisCommonPropertiesTenantSettings ### Properties ### Additional Properties @@ -151,11 +114,47 @@ ### Additional Properties * **Additional Properties Type**: string +## RedisCreateProperties +### Properties +* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. +* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. +* **hostName**: string (ReadOnly): Redis host name. +* **instances**: [RedisInstanceDetails](#redisinstancedetails)[] (ReadOnly): List of the Redis instances associated with the cache +* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache +* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') +* **port**: int (ReadOnly): Redis non-SSL port. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified redis cache +* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' +* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. +* **redisVersion**: string: Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) +* **replicasPerMaster**: int: The number of replicas to be created per primary. +* **replicasPerPrimary**: int: The number of replicas to be created per primary. +* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. +* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. +* **sslPort**: int (ReadOnly): Redis SSL port. +* **staticIP**: string: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. +* **subnetId**: 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 +* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings + ## RedisFirewallRuleProperties ### Properties * **endIP**: string (Required): highest IP address included in the range * **startIP**: string (Required): lowest IP address included in the range +## RedisInstanceDetails +### Properties +* **isMaster**: bool (ReadOnly): Specifies whether the instance is a primary node. +* **isPrimary**: bool (ReadOnly): Specifies whether the instance is a primary node. +* **nonSslPort**: int (ReadOnly): If enableNonSslPort is true, provides Redis instance Non-SSL port. +* **shardId**: int (ReadOnly): If clustering is enabled, the Shard ID of Redis Instance +* **sslPort**: int (ReadOnly): Redis instance SSL port. +* **zone**: string (ReadOnly): If the Cache uses availability zones, specifies availability zone where this instance is located. + +## RedisLinkedServer +### Properties +* **id**: string (ReadOnly): Linked server Id. + ## RedisLinkedServerCreateProperties ### Properties * **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. @@ -173,8 +172,9 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) diff --git a/generated/redis/microsoft.cache/2021-06-01/types.md b/generated/redis/microsoft.cache/2021-06-01/types.md index 9845f8f226..bfad961704 100644 --- a/generated/redis/microsoft.cache/2021-06-01/types.md +++ b/generated/redis/microsoft.cache/2021-06-01/types.md @@ -62,56 +62,9 @@ * **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). * **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - -## RedisCreateProperties -### Properties -* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. -* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. -* **hostName**: string (ReadOnly): Redis host name. -* **instances**: [RedisInstanceDetails](#redisinstancedetails)[] (ReadOnly): List of the Redis instances associated with the cache -* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache -* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') -* **port**: int (ReadOnly): Redis non-SSL port. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified redis cache -* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' -* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. -* **redisVersion**: string: Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) -* **replicasPerMaster**: int: The number of replicas to be created per primary. -* **replicasPerPrimary**: int: The number of replicas to be created per primary. -* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. -* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. -* **sslPort**: int (ReadOnly): Redis SSL port. -* **staticIP**: string: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. -* **subnetId**: 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 -* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings - -## RedisAccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. - -## RedisInstanceDetails -### Properties -* **isMaster**: bool (ReadOnly): Specifies whether the instance is a primary node. -* **isPrimary**: bool (ReadOnly): Specifies whether the instance is a primary node. -* **nonSslPort**: int (ReadOnly): If enableNonSslPort is true, provides Redis instance Non-SSL port. -* **shardId**: int (ReadOnly): If clustering is enabled, the Shard ID of Redis Instance -* **sslPort**: int (ReadOnly): Redis instance SSL port. -* **zone**: string (ReadOnly): If the Cache uses availability zones, specifies availability zone where this instance is located. - -## RedisLinkedServer +## PrivateEndpoint ### Properties -* **id**: string (ReadOnly): Linked server Id. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -126,16 +79,22 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. * **description**: string (ReadOnly): The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + +## RedisAccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. + ## RedisCommonPropertiesRedisConfiguration ### Properties * **aof-storage-connection-string-0**: string: First storage account connection string @@ -155,12 +114,6 @@ ### Additional Properties * **Additional Properties Type**: any -## Sku -### Properties -* **capacity**: int (Required): 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). -* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). -* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) - ## RedisCommonPropertiesTenantSettings ### Properties ### Additional Properties @@ -171,11 +124,47 @@ ### Additional Properties * **Additional Properties Type**: string +## RedisCreateProperties +### Properties +* **accessKeys**: [RedisAccessKeys](#redisaccesskeys) (ReadOnly): Redis cache access keys. +* **enableNonSslPort**: bool: Specifies whether the non-ssl Redis server port (6379) is enabled. +* **hostName**: string (ReadOnly): Redis host name. +* **instances**: [RedisInstanceDetails](#redisinstancedetails)[] (ReadOnly): List of the Redis instances associated with the cache +* **linkedServers**: [RedisLinkedServer](#redislinkedserver)[] (ReadOnly): List of the linked servers associated with the cache +* **minimumTlsVersion**: '1.0' | '1.1' | '1.2' | string: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') +* **port**: int (ReadOnly): Redis non-SSL port. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified redis cache +* **provisioningState**: 'Creating' | 'Deleting' | 'Disabled' | 'Failed' | 'Linking' | 'Provisioning' | 'RecoveringScaleFailure' | 'Scaling' | 'Succeeded' | 'Unlinking' | 'Unprovisioning' | 'Updating' | string (ReadOnly): Redis instance provisioning status. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' +* **redisConfiguration**: [RedisCommonPropertiesRedisConfiguration](#rediscommonpropertiesredisconfiguration): 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. +* **redisVersion**: string: Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6) +* **replicasPerMaster**: int: The number of replicas to be created per primary. +* **replicasPerPrimary**: int: The number of replicas to be created per primary. +* **shardCount**: int: The number of shards to be created on a Premium Cluster Cache. +* **sku**: [Sku](#sku) (Required): SKU parameters supplied to the create Redis operation. +* **sslPort**: int (ReadOnly): Redis SSL port. +* **staticIP**: string: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. +* **subnetId**: 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 +* **tenantSettings**: [RedisCommonPropertiesTenantSettings](#rediscommonpropertiestenantsettings): A dictionary of tenant settings + ## RedisFirewallRuleProperties ### Properties * **endIP**: string (Required): highest IP address included in the range * **startIP**: string (Required): lowest IP address included in the range +## RedisInstanceDetails +### Properties +* **isMaster**: bool (ReadOnly): Specifies whether the instance is a primary node. +* **isPrimary**: bool (ReadOnly): Specifies whether the instance is a primary node. +* **nonSslPort**: int (ReadOnly): If enableNonSslPort is true, provides Redis instance Non-SSL port. +* **shardId**: int (ReadOnly): If clustering is enabled, the Shard ID of Redis Instance +* **sslPort**: int (ReadOnly): Redis instance SSL port. +* **zone**: string (ReadOnly): If the Cache uses availability zones, specifies availability zone where this instance is located. + +## RedisLinkedServer +### Properties +* **id**: string (ReadOnly): Linked server Id. + ## RedisLinkedServerCreateProperties ### Properties * **linkedRedisCacheId**: string (Required): Fully qualified resourceId of the linked redis cache. @@ -193,8 +182,19 @@ * **maintenanceWindow**: string: ISO8601 timespan specifying how much time cache patching can take. * **startHourUtc**: int (Required): Start hour after which cache patching can start. -## RedisAccessKeys +## Sku ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate with Redis cache. -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate with Redis cache. +* **capacity**: int (Required): 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). +* **family**: 'C' | 'P' | string (Required): The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). +* **name**: 'Basic' | 'Premium' | 'Standard' | string (Required): The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) + +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. diff --git a/generated/redisenterprise/log.out b/generated/redisenterprise/log.out index 45e3676c7b..eabc2d64e0 100644 --- a/generated/redisenterprise/log.out +++ b/generated/redisenterprise/log.out @@ -3,22 +3,22 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.cache-2022-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.cache-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.cache-2021-02-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2021-02-01-preview/redisenterprise.json:1190:5 @@ -56,7 +56,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.cache-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-03-01/redisenterprise.json:1128:5 @@ -87,10 +87,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ImportClusterParameters' with warning | PreCheck/SchemaMissingType | The schema 'ExportClusterParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-03-01/redisenterprise.json:1566:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.cache-2020-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Sku' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/redisenterprise.json:1131:5 @@ -120,4 +120,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ExportClusterParameters' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/redisenterprise.json:1520:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 13.84s. 10 files generated. +info | Autorest completed in 12.8s. 10 files generated. diff --git a/generated/redisenterprise/microsoft.cache/2020-10-01-preview/types.md b/generated/redisenterprise/microsoft.cache/2020-10-01-preview/types.md index 92aa0e2eb1..675745317b 100644 --- a/generated/redisenterprise/microsoft.cache/2020-10-01-preview/types.md +++ b/generated/redisenterprise/microsoft.cache/2020-10-01-preview/types.md @@ -36,6 +36,11 @@ * **ApiVersion**: 2020-10-01-preview * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate + ## ClusterProperties ### Properties * **hostName**: string (ReadOnly): DNS name of the cluster endpoint @@ -45,6 +50,26 @@ * **redisVersion**: string (ReadOnly): Version of redis the cluster supports, e.g. '6' * **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status +## DatabaseProperties +### Properties +* **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. +* **clusteringPolicy**: 'EnterpriseCluster' | 'OSSCluster' | string: Clustering policy - default is OSSCluster. Specified at create time. +* **evictionPolicy**: 'AllKeysLFU' | 'AllKeysLRU' | 'AllKeysRandom' | 'NoEviction' | 'VolatileLFU' | 'VolatileLRU' | 'VolatileRandom' | 'VolatileTTL' | string: Redis eviction policy - default is VolatileLRU +* **modules**: [Module](#module)[]: Optional set of redis modules to enable in this database - modules can only be added at creation time. +* **port**: int: TCP port of the database endpoint. Specified at create time. Defaults to an available port. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Current provisioning status +* **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status + +## Module +### Properties +* **args**: string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. +* **name**: string (Required): The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' +* **version**: string (ReadOnly): The version of the module, e.g. '1.0'. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -58,10 +83,6 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. @@ -78,24 +99,3 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseProperties -### Properties -* **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. -* **clusteringPolicy**: 'EnterpriseCluster' | 'OSSCluster' | string: Clustering policy - default is OSSCluster. Specified at create time. -* **evictionPolicy**: 'AllKeysLFU' | 'AllKeysLRU' | 'AllKeysRandom' | 'NoEviction' | 'VolatileLFU' | 'VolatileLRU' | 'VolatileRandom' | 'VolatileTTL' | string: Redis eviction policy - default is VolatileLRU -* **modules**: [Module](#module)[]: Optional set of redis modules to enable in this database - modules can only be added at creation time. -* **port**: int: TCP port of the database endpoint. Specified at create time. Defaults to an available port. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Current provisioning status -* **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status - -## Module -### Properties -* **args**: string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. -* **name**: string (Required): The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' -* **version**: string (ReadOnly): The version of the module, e.g. '1.0'. - -## AccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate - diff --git a/generated/redisenterprise/microsoft.cache/2021-02-01-preview/types.md b/generated/redisenterprise/microsoft.cache/2021-02-01-preview/types.md index 770664910c..f326939a75 100644 --- a/generated/redisenterprise/microsoft.cache/2021-02-01-preview/types.md +++ b/generated/redisenterprise/microsoft.cache/2021-02-01-preview/types.md @@ -36,6 +36,11 @@ * **ApiVersion**: 2021-02-01-preview * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate + ## ClusterProperties ### Properties * **hostName**: string (ReadOnly): DNS name of the cluster endpoint @@ -45,39 +50,6 @@ * **redisVersion**: string (ReadOnly): Version of redis the cluster supports, e.g. '6' * **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## Sku -### Properties -* **capacity**: int: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. -* **name**: 'EnterpriseFlash_F1500' | 'EnterpriseFlash_F300' | 'EnterpriseFlash_F700' | 'Enterprise_E10' | 'Enterprise_E100' | 'Enterprise_E20' | 'Enterprise_E50' | string (Required): The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DatabaseProperties ### Properties * **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. @@ -113,8 +85,36 @@ * **rdbEnabled**: bool: Sets whether RDB is enabled. * **rdbFrequency**: '12h' | '1h' | '6h' | string: Sets the frequency at which a snapshot of the database is created. -## AccessKeys +## PrivateEndpoint ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + +## Sku +### Properties +* **capacity**: int: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. +* **name**: 'EnterpriseFlash_F1500' | 'EnterpriseFlash_F300' | 'EnterpriseFlash_F700' | 'Enterprise_E10' | 'Enterprise_E100' | 'Enterprise_E20' | 'Enterprise_E50' | string (Required): The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/redisenterprise/microsoft.cache/2021-03-01/types.md b/generated/redisenterprise/microsoft.cache/2021-03-01/types.md index 9d3dc4709c..6677f36420 100644 --- a/generated/redisenterprise/microsoft.cache/2021-03-01/types.md +++ b/generated/redisenterprise/microsoft.cache/2021-03-01/types.md @@ -36,6 +36,11 @@ * **ApiVersion**: 2021-03-01 * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate + ## ClusterProperties ### Properties * **hostName**: string (ReadOnly): DNS name of the cluster endpoint @@ -45,6 +50,34 @@ * **redisVersion**: string (ReadOnly): Version of redis the cluster supports, e.g. '6' * **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status +## DatabaseProperties +### Properties +* **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. +* **clusteringPolicy**: 'EnterpriseCluster' | 'OSSCluster' | string: Clustering policy - default is OSSCluster. Specified at create time. +* **evictionPolicy**: 'AllKeysLFU' | 'AllKeysLRU' | 'AllKeysRandom' | 'NoEviction' | 'VolatileLFU' | 'VolatileLRU' | 'VolatileRandom' | 'VolatileTTL' | string: Redis eviction policy - default is VolatileLRU +* **modules**: [Module](#module)[]: Optional set of redis modules to enable in this database - modules can only be added at creation time. +* **persistence**: [Persistence](#persistence): Persistence-related configuration for the RedisEnterprise database +* **port**: int: TCP port of the database endpoint. Specified at create time. Defaults to an available port. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Current provisioning status +* **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status + +## Module +### Properties +* **args**: string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. +* **name**: string (Required): The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' +* **version**: string (ReadOnly): The version of the module, e.g. '1.0'. + +## Persistence +### Properties +* **aofEnabled**: bool: Sets whether AOF is enabled. +* **aofFrequency**: '1s' | 'always' | string: Sets the frequency at which data is written to disk. +* **rdbEnabled**: bool: Sets whether RDB is enabled. +* **rdbFrequency**: '12h' | '1h' | '6h' | string: Sets the frequency at which a snapshot of the database is created. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -58,10 +91,6 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. @@ -78,32 +107,3 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseProperties -### Properties -* **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. -* **clusteringPolicy**: 'EnterpriseCluster' | 'OSSCluster' | string: Clustering policy - default is OSSCluster. Specified at create time. -* **evictionPolicy**: 'AllKeysLFU' | 'AllKeysLRU' | 'AllKeysRandom' | 'NoEviction' | 'VolatileLFU' | 'VolatileLRU' | 'VolatileRandom' | 'VolatileTTL' | string: Redis eviction policy - default is VolatileLRU -* **modules**: [Module](#module)[]: Optional set of redis modules to enable in this database - modules can only be added at creation time. -* **persistence**: [Persistence](#persistence): Persistence-related configuration for the RedisEnterprise database -* **port**: int: TCP port of the database endpoint. Specified at create time. Defaults to an available port. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Current provisioning status -* **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status - -## Module -### Properties -* **args**: string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. -* **name**: string (Required): The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' -* **version**: string (ReadOnly): The version of the module, e.g. '1.0'. - -## Persistence -### Properties -* **aofEnabled**: bool: Sets whether AOF is enabled. -* **aofFrequency**: '1s' | 'always' | string: Sets the frequency at which data is written to disk. -* **rdbEnabled**: bool: Sets whether RDB is enabled. -* **rdbFrequency**: '12h' | '1h' | '6h' | string: Sets the frequency at which a snapshot of the database is created. - -## AccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate - diff --git a/generated/redisenterprise/microsoft.cache/2021-08-01/types.md b/generated/redisenterprise/microsoft.cache/2021-08-01/types.md index 3bc3577bb1..3e659d822d 100644 --- a/generated/redisenterprise/microsoft.cache/2021-08-01/types.md +++ b/generated/redisenterprise/microsoft.cache/2021-08-01/types.md @@ -36,6 +36,11 @@ * **ApiVersion**: 2021-08-01 * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate + ## ClusterProperties ### Properties * **hostName**: string (ReadOnly): DNS name of the cluster endpoint @@ -45,6 +50,34 @@ * **redisVersion**: string (ReadOnly): Version of redis the cluster supports, e.g. '6' * **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status +## DatabaseProperties +### Properties +* **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. +* **clusteringPolicy**: 'EnterpriseCluster' | 'OSSCluster' | string: Clustering policy - default is OSSCluster. Specified at create time. +* **evictionPolicy**: 'AllKeysLFU' | 'AllKeysLRU' | 'AllKeysRandom' | 'NoEviction' | 'VolatileLFU' | 'VolatileLRU' | 'VolatileRandom' | 'VolatileTTL' | string: Redis eviction policy - default is VolatileLRU +* **modules**: [Module](#module)[]: Optional set of redis modules to enable in this database - modules can only be added at creation time. +* **persistence**: [Persistence](#persistence): Persistence-related configuration for the RedisEnterprise database +* **port**: int: TCP port of the database endpoint. Specified at create time. Defaults to an available port. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Current provisioning status +* **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status + +## Module +### Properties +* **args**: string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. +* **name**: string (Required): The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' +* **version**: string (ReadOnly): The version of the module, e.g. '1.0'. + +## Persistence +### Properties +* **aofEnabled**: bool: Sets whether AOF is enabled. +* **aofFrequency**: '1s' | 'always' | string: Sets the frequency at which data is written to disk. +* **rdbEnabled**: bool: Sets whether RDB is enabled. +* **rdbFrequency**: '12h' | '1h' | '6h' | string: Sets the frequency at which a snapshot of the database is created. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -58,10 +91,6 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. @@ -78,32 +107,3 @@ ### Additional Properties * **Additional Properties Type**: string -## DatabaseProperties -### Properties -* **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. -* **clusteringPolicy**: 'EnterpriseCluster' | 'OSSCluster' | string: Clustering policy - default is OSSCluster. Specified at create time. -* **evictionPolicy**: 'AllKeysLFU' | 'AllKeysLRU' | 'AllKeysRandom' | 'NoEviction' | 'VolatileLFU' | 'VolatileLRU' | 'VolatileRandom' | 'VolatileTTL' | string: Redis eviction policy - default is VolatileLRU -* **modules**: [Module](#module)[]: Optional set of redis modules to enable in this database - modules can only be added at creation time. -* **persistence**: [Persistence](#persistence): Persistence-related configuration for the RedisEnterprise database -* **port**: int: TCP port of the database endpoint. Specified at create time. Defaults to an available port. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Current provisioning status -* **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status - -## Module -### Properties -* **args**: string: Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. -* **name**: string (Required): The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' -* **version**: string (ReadOnly): The version of the module, e.g. '1.0'. - -## Persistence -### Properties -* **aofEnabled**: bool: Sets whether AOF is enabled. -* **aofFrequency**: '1s' | 'always' | string: Sets the frequency at which data is written to disk. -* **rdbEnabled**: bool: Sets whether RDB is enabled. -* **rdbFrequency**: '12h' | '1h' | '6h' | string: Sets the frequency at which a snapshot of the database is created. - -## AccessKeys -### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate - diff --git a/generated/redisenterprise/microsoft.cache/2022-01-01/types.md b/generated/redisenterprise/microsoft.cache/2022-01-01/types.md index b478997a4b..3b638b5cf0 100644 --- a/generated/redisenterprise/microsoft.cache/2022-01-01/types.md +++ b/generated/redisenterprise/microsoft.cache/2022-01-01/types.md @@ -36,6 +36,11 @@ * **ApiVersion**: 2022-01-01 * **Output**: [AccessKeys](#accesskeys) +## AccessKeys +### Properties +* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate +* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate + ## ClusterProperties ### Properties * **hostName**: string (ReadOnly): DNS name of the cluster endpoint @@ -45,39 +50,6 @@ * **redisVersion**: string (ReadOnly): Version of redis the cluster supports, e.g. '6' * **resourceState**: 'CreateFailed' | 'Creating' | 'DeleteFailed' | 'Deleting' | 'DisableFailed' | 'Disabled' | 'Disabling' | 'EnableFailed' | 'Enabling' | 'Running' | 'UpdateFailed' | 'Updating' | string (ReadOnly): Current resource status -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. - -## Sku -### Properties -* **capacity**: int: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. -* **name**: 'EnterpriseFlash_F1500' | 'EnterpriseFlash_F300' | 'EnterpriseFlash_F700' | 'Enterprise_E10' | 'Enterprise_E100' | 'Enterprise_E20' | 'Enterprise_E50' | string (Required): The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DatabaseProperties ### Properties * **clientProtocol**: 'Encrypted' | 'Plaintext' | string: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. @@ -113,8 +85,36 @@ * **rdbEnabled**: bool: Sets whether RDB is enabled. * **rdbFrequency**: '12h' | '1h' | '6h' | string: Sets the frequency at which a snapshot of the database is created. -## AccessKeys +## PrivateEndpoint ### Properties -* **primaryKey**: string (ReadOnly): The current primary key that clients can use to authenticate -* **secondaryKey**: string (ReadOnly): The current secondary key that clients can use to authenticate +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. + +## Sku +### Properties +* **capacity**: int: The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. +* **name**: 'EnterpriseFlash_F1500' | 'EnterpriseFlash_F300' | 'EnterpriseFlash_F700' | 'Enterprise_E10' | 'Enterprise_E100' | 'Enterprise_E20' | 'Enterprise_E50' | string (Required): The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/relay/log.out b/generated/relay/log.out index ee3ebb8531..643c367c32 100644 --- a/generated/relay/log.out +++ b/generated/relay/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.relay-2021-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AuthorizationRule' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/authorizationRules.json:941:5 @@ -21,10 +21,10 @@ warning | PreCheck/SchemaMissingType | The schema 'WcfRelay-properties' with an warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 24ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.relay-2017-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/relay.json:1656:5 @@ -71,10 +71,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/relay.json:2171:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.relay-2016-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/relay/resource-manager/Microsoft.Relay/stable/2016-07-01/relay.json:1882:5 @@ -122,7 +122,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.relay-2018-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceNamespacePatch' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/relay/resource-manager/Microsoft.Relay/preview/2018-01-01-preview/Namespaces-preview.json:401:5 @@ -172,4 +172,4 @@ warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an unde warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 12.32s. 8 files generated. +info | Autorest completed in 11.6s. 8 files generated. diff --git a/generated/relay/microsoft.relay/2016-07-01/types.md b/generated/relay/microsoft.relay/2016-07-01/types.md index 39c0bf6772..6ce01bb21b 100644 --- a/generated/relay/microsoft.relay/2016-07-01/types.md +++ b/generated/relay/microsoft.relay/2016-07-01/types.md @@ -72,23 +72,29 @@ * **ApiVersion**: 2016-07-01 * **Output**: [AuthorizationRuleKeys](#authorizationrulekeys) -## RelayNamespaceProperties +## AuthorizationRuleKeys ### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **keyName**: string (ReadOnly): A string that describes the authorization rule +* **primaryConnectionString**: string (ReadOnly): PrimaryConnectionString of the created Namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token +* **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created Namespace AuthorizationRule +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token -## Sku +## AuthorizationRuleKeys ### Properties -* **name**: 'Standard' | string (Required): Name of this Sku -* **tier**: 'Standard' | string (Required): The tier of this particular SKU +* **keyName**: string (ReadOnly): A string that describes the authorization rule +* **primaryConnectionString**: string (ReadOnly): PrimaryConnectionString of the created Namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token +* **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created Namespace AuthorizationRule +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token -## TrackedResourceTags +## AuthorizationRuleKeys ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyName**: string (ReadOnly): A string that describes the authorization rule +* **primaryConnectionString**: string (ReadOnly): PrimaryConnectionString of the created Namespace AuthorizationRule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token +* **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created Namespace AuthorizationRule +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token ## AuthorizationRuleProperties ### Properties @@ -102,6 +108,24 @@ * **updatedAt**: string (ReadOnly): The time the namespace was updated. * **userMetadata**: 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. +## RelayNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. + +## Sku +### Properties +* **name**: 'Standard' | string (Required): Name of this Sku +* **tier**: 'Standard' | string (Required): The tier of this particular SKU + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## WcfRelayProperties ### Properties * **createdAt**: string (ReadOnly): The time the WCFRelay was created. @@ -113,27 +137,3 @@ * **updatedAt**: string (ReadOnly): The time the namespace was updated. * **userMetadata**: 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. -## AuthorizationRuleKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule -* **primaryConnectionString**: string (ReadOnly): PrimaryConnectionString of the created Namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token -* **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created Namespace AuthorizationRule -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token - -## AuthorizationRuleKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule -* **primaryConnectionString**: string (ReadOnly): PrimaryConnectionString of the created Namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token -* **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created Namespace AuthorizationRule -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token - -## AuthorizationRuleKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule -* **primaryConnectionString**: string (ReadOnly): PrimaryConnectionString of the created Namespace AuthorizationRule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token -* **secondaryConnectionString**: string (ReadOnly): SecondaryConnectionString of the created Namespace AuthorizationRule -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token - diff --git a/generated/relay/microsoft.relay/2017-04-01/types.md b/generated/relay/microsoft.relay/2017-04-01/types.md index 2d36bee583..fb12432fb3 100644 --- a/generated/relay/microsoft.relay/2017-04-01/types.md +++ b/generated/relay/microsoft.relay/2017-04-01/types.md @@ -72,23 +72,29 @@ * **ApiVersion**: 2017-04-01 * **Output**: [AccessKeys](#accesskeys) -## RelayNamespaceProperties +## AccessKeys ### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. -* **provisioningState**: 'Created' | 'Deleted' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' (ReadOnly) -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. -## Sku +## AccessKeys ### Properties -* **name**: 'Standard' (Required): Name of this SKU. -* **tier**: 'Standard': The tier of this SKU. +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. -## TrackedResourceTags +## AccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. ## AuthorizationRuleProperties ### Properties @@ -102,6 +108,24 @@ * **updatedAt**: string (ReadOnly): The time the namespace was updated. * **userMetadata**: 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. +## RelayNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. +* **provisioningState**: 'Created' | 'Deleted' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' (ReadOnly) +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. + +## Sku +### Properties +* **name**: 'Standard' (Required): Name of this SKU. +* **tier**: 'Standard': The tier of this SKU. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## WcfRelayProperties ### Properties * **createdAt**: string (ReadOnly): The time the WCF relay was created. @@ -113,27 +137,3 @@ * **updatedAt**: string (ReadOnly): The time the namespace was updated. * **userMetadata**: 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. -## AccessKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. - diff --git a/generated/relay/microsoft.relay/2018-01-01-preview/types.md b/generated/relay/microsoft.relay/2018-01-01-preview/types.md index 8e4561b977..db24c7cd75 100644 --- a/generated/relay/microsoft.relay/2018-01-01-preview/types.md +++ b/generated/relay/microsoft.relay/2018-01-01-preview/types.md @@ -32,24 +32,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Relay/namespaces/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## RelayNamespaceProperties -### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. -* **provisioningState**: 'Created' | 'Deleted' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' (ReadOnly) -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. - -## Sku -### Properties -* **name**: 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Standard' | string: The tier of this SKU. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## NetworkRuleSetProperties ### Properties * **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set @@ -60,22 +42,40 @@ * **action**: 'Allow' | string: The IP Filter Action * **ipMask**: string: IP Mask +## PrivateEndpoint +### Properties +* **id**: string: Full identifier of the private endpoint resource. + ## PrivateEndpointConnectionProperties ### Properties * **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint object properties. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): An object that represents the approval state of the private link connection. * **provisioningState**: 'Creating' | 'Deleting' | 'DeletingByProxy' | 'Succeeded' | 'Unknown' | 'Updating' | 'UpdatingByProxy' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string: Full identifier of the private endpoint resource. - ## PrivateLinkServiceConnectionState ### Properties * **actionRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval or rejection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## RelayNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. +* **provisioningState**: 'Created' | 'Deleted' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' (ReadOnly) +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. + +## Sku +### Properties +* **name**: 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Standard' | string: The tier of this SKU. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/relay/microsoft.relay/2021-11-01/types.md b/generated/relay/microsoft.relay/2021-11-01/types.md index af48a65aba..6073fcb369 100644 --- a/generated/relay/microsoft.relay/2021-11-01/types.md +++ b/generated/relay/microsoft.relay/2021-11-01/types.md @@ -104,16 +104,60 @@ * **ApiVersion**: 2021-11-01 * **Output**: [AccessKeys](#accesskeys) -## RelayNamespaceProperties +## AccessKeys ### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. -* **provisioningState**: string (ReadOnly): Provisioning state of the Namespace. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | 'SecuredByPerimeter' | string: This determines if traffic is allowed over public network. By default it is enabled. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **status**: string (ReadOnly): Status of the Namespace. +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. + +## AccessKeys +### Properties +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. + +## AuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. + +## ConnectionState +### Properties +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. + +## HybridConnectionProperties +### Properties +* **createdAt**: string (ReadOnly): The time the hybrid connection was created. +* **listenerCount**: int (ReadOnly): The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. +* **requiresClientAuthorization**: bool: Returns true if client authorization is needed for this hybrid connection; otherwise, false. * **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **userMetadata**: 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. + +## NetworkRuleSetProperties +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set +* **ipRules**: [NWRuleSetIpRules](#nwrulesetiprules)[]: List of IpRules + +## NWRuleSetIpRules +### Properties +* **action**: 'Allow' | string: The IP Filter Action +* **ipMask**: string: IP Mask + +## PrivateEndpoint +### Properties +* **id**: string: The ARM identifier for Private Endpoint. ## PrivateEndpointConnection ### Properties @@ -130,14 +174,21 @@ * **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. -## PrivateEndpoint +## RelayNamespaceProperties ### Properties -* **id**: string: The ARM identifier for Private Endpoint. +* **createdAt**: string (ReadOnly): The time the namespace was created. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. +* **provisioningState**: string (ReadOnly): Provisioning state of the Namespace. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | 'SecuredByPerimeter' | string: This determines if traffic is allowed over public network. By default it is enabled. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **status**: string (ReadOnly): Status of the Namespace. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. -## ConnectionState +## Sku ### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +* **name**: 'Standard' | string (Required): Name of this SKU. +* **tier**: 'Standard' | string: The tier of this SKU. ## SystemData ### Properties @@ -148,38 +199,11 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## Sku -### Properties -* **name**: 'Standard' | string (Required): Name of this SKU. -* **tier**: 'Standard' | string: The tier of this SKU. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send' | string[] (Required): The rights associated with the rule. - -## HybridConnectionProperties -### Properties -* **createdAt**: string (ReadOnly): The time the hybrid connection was created. -* **listenerCount**: int (ReadOnly): The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. -* **requiresClientAuthorization**: bool: Returns true if client authorization is needed for this hybrid connection; otherwise, false. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. -* **userMetadata**: 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. - -## NetworkRuleSetProperties -### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default Action for Network Rule Set -* **ipRules**: [NWRuleSetIpRules](#nwrulesetiprules)[]: List of IpRules - -## NWRuleSetIpRules -### Properties -* **action**: 'Allow' | string: The IP Filter Action -* **ipMask**: string: IP Mask - ## WcfRelayProperties ### Properties * **createdAt**: string (ReadOnly): The time the WCF relay was created. @@ -191,27 +215,3 @@ * **updatedAt**: string (ReadOnly): The time the namespace was updated. * **userMetadata**: 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. -## AccessKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit secondary key for signing and validating the SAS token. - diff --git a/generated/reservations/log.out b/generated/reservations/log.out index bb09227539..4be5ca465b 100644 --- a/generated/reservations/log.out +++ b/generated/reservations/log.out @@ -3,16 +3,16 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.capacity-2022-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.capacity-2020-10-25"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceName' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/quota.json:466:5 @@ -22,22 +22,22 @@ warning | PreCheck/SchemaMissingType | The schema 'QuotaLimitsResponse' with an - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/quota.json:497:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.capacity-2021-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.capacity-2020-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.capacity-2019-07-19"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceName' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json:534:5 @@ -56,29 +56,29 @@ warning | Modeler/MissingType | The enum schema 'ContactMethodType' with an unde warning | Modeler/MissingType | The enum schema 'SupportContactType' with an undefined type and enum values is ambiguous. This has been auto-corrected to 'type:string' warning | Skipping path '/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/autoQuotaIncrease': Found mismatch between type segments (1) and name segments (0) warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.capacity-2020-11-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.capacity-2019-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.capacity-2018-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.capacity-2017-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 21.53s. 12 files generated. +info | Autorest completed in 19.9s. 12 files generated. diff --git a/generated/reservations/microsoft.capacity/2019-04-01/types.md b/generated/reservations/microsoft.capacity/2019-04-01/types.md index fe52f4b6b9..71fb02931b 100644 --- a/generated/reservations/microsoft.capacity/2019-04-01/types.md +++ b/generated/reservations/microsoft.capacity/2019-04-01/types.md @@ -12,6 +12,38 @@ * **sku**: [SkuName](#skuname) (WriteOnly) * **type**: 'Microsoft.Capacity/reservationOrders' (ReadOnly, DeployTimeConstant): The resource type +## AppliedScopeProperties +### Properties +* **displayName**: string (ReadOnly): Management group display name +* **managementGroupId**: string (ReadOnly): Management group ID of the format /providers/Microsoft.Management/managementGroups/{managementGroupId} +* **tenantId**: string (ReadOnly): Tenant ID of the applied scope type + +## ExtendedStatusInfo +### Properties +* **message**: string (ReadOnly): The message giving detailed information about the status code. +* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) + +## PaymentDetail +### Properties +* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. +* **billingCurrencyTotal**: [Price](#price) (ReadOnly) +* **dueDate**: string (ReadOnly): Date when the payment needs to be done. +* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) +* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. + +## Price +### Properties +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. + +## PurchaseRequest +### Properties +* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. +* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) +* **sku**: [SkuName](#skuname) (ReadOnly) + ## PurchaseRequestProperties ### Properties * **appliedScopes**: string[] (WriteOnly): List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. @@ -33,42 +65,37 @@ * **reservedResourceType**: 'AppService' | 'AzureDataExplorer' | 'BlockBlob' | 'CosmosDb' | 'Databricks' | 'DedicatedHost' | 'ManagedDisk' | 'MariaDb' | 'MySql' | 'PostgreSql' | 'RedHat' | 'RedHatOsa' | 'RedisCache' | 'SapHana' | 'SqlAzureHybridBenefit' | 'SqlDataWarehouse' | 'SqlDatabases' | 'SuseLinux' | 'VMwareCloudSimple' | 'VirtualMachines' | string (WriteOnly): The type of the resource that is being reserved. * **term**: 'P1Y' | 'P3Y' | string: Represent the term of Reservation. -## ReservationOrderBillingPlanInformation +## PurchaseRequestPropertiesReservedResourceProperties ### Properties -* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **startDate**: string (ReadOnly): Date when the billing plan has started. -* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail +* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. -## Price +## RenewPropertiesResponse +### Properties +* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. +* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. +* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) + +## RenewPropertiesResponseBillingCurrencyTotal ### Properties * **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. +* **currencyCode**: string (ReadOnly) -## PaymentDetail +## RenewPropertiesResponsePricingCurrencyTotal ### Properties -* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. -* **billingCurrencyTotal**: [Price](#price) (ReadOnly) -* **dueDate**: string (ReadOnly): Date when the payment needs to be done. -* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) -* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly) -## ExtendedStatusInfo +## ReservationMergeProperties ### Properties -* **message**: string (ReadOnly): The message giving detailed information about the status code. -* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) +* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} +* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -## ReservationResponse +## ReservationOrderBillingPlanInformation ### Properties -* **etag**: int (ReadOnly) -* **id**: string (ReadOnly): Identifier of the reservation -* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. -* **name**: string (ReadOnly): Name of the reservation -* **properties**: [ReservationProperties](#reservationproperties) (ReadOnly) -* **sku**: [SkuName](#skuname) (ReadOnly) -* **type**: string (ReadOnly): Type of resource. "Microsoft.Capacity/reservationOrders/reservations" +* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **startDate**: string (ReadOnly): Date when the billing plan has started. +* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail ## ReservationProperties ### Properties @@ -98,42 +125,15 @@ * **swapProperties**: [ReservationSwapProperties](#reservationswapproperties) (ReadOnly) * **term**: 'P1Y' | 'P3Y' | string (ReadOnly): Represent the term of Reservation. -## AppliedScopeProperties -### Properties -* **displayName**: string (ReadOnly): Management group display name -* **managementGroupId**: string (ReadOnly): Management group ID of the format /providers/Microsoft.Management/managementGroups/{managementGroupId} -* **tenantId**: string (ReadOnly): Tenant ID of the applied scope type - -## ReservationMergeProperties -### Properties -* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} - -## RenewPropertiesResponse -### Properties -* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. -* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. -* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) - -## RenewPropertiesResponseBillingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly) - -## RenewPropertiesResponsePricingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly) - -## PurchaseRequest +## ReservationResponse ### Properties +* **etag**: int (ReadOnly) +* **id**: string (ReadOnly): Identifier of the reservation * **location**: string (ReadOnly): The Azure Region where the reserved resource lives. -* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) +* **name**: string (ReadOnly): Name of the reservation +* **properties**: [ReservationProperties](#reservationproperties) (ReadOnly) * **sku**: [SkuName](#skuname) (ReadOnly) - -## SkuName -### Properties -* **name**: string (WriteOnly) +* **type**: string (ReadOnly): Type of resource. "Microsoft.Capacity/reservationOrders/reservations" ## ReservationSplitProperties ### Properties @@ -145,7 +145,7 @@ * **swapDestination**: string (ReadOnly): Reservation Resource Id that the original resource gets swapped to. Format of the resource Id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} * **swapSource**: string (ReadOnly): Resource Id of the Source Reservation that gets swapped. Format of the resource Id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -## PurchaseRequestPropertiesReservedResourceProperties +## SkuName ### Properties -* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. +* **name**: string (WriteOnly) diff --git a/generated/reservations/microsoft.capacity/2020-10-01-preview/types.md b/generated/reservations/microsoft.capacity/2020-10-01-preview/types.md index bf89f91dd9..010525661c 100644 --- a/generated/reservations/microsoft.capacity/2020-10-01-preview/types.md +++ b/generated/reservations/microsoft.capacity/2020-10-01-preview/types.md @@ -12,6 +12,32 @@ * **sku**: [SkuName](#skuname) (WriteOnly) * **type**: 'Microsoft.Capacity/reservationOrders' (ReadOnly, DeployTimeConstant): The resource type +## ExtendedStatusInfo +### Properties +* **message**: string (ReadOnly): The message giving detailed information about the status code. +* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) + +## PaymentDetail +### Properties +* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. +* **billingCurrencyTotal**: [Price](#price) (ReadOnly) +* **dueDate**: string (ReadOnly): Date when the payment needs to be done. +* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) +* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. + +## Price +### Properties +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. + +## PurchaseRequest +### Properties +* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. +* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) +* **sku**: [SkuName](#skuname) (ReadOnly) + ## PurchaseRequestProperties ### Properties * **appliedScopes**: string[] (WriteOnly): List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. @@ -32,42 +58,37 @@ * **reservedResourceType**: 'AppService' | 'AzureDataExplorer' | 'BlockBlob' | 'CosmosDb' | 'Databricks' | 'DedicatedHost' | 'ManagedDisk' | 'MariaDb' | 'MySql' | 'PostgreSql' | 'RedHat' | 'RedHatOsa' | 'RedisCache' | 'SapHana' | 'SqlAzureHybridBenefit' | 'SqlDataWarehouse' | 'SqlDatabases' | 'SuseLinux' | 'VMwareCloudSimple' | 'VirtualMachines' | string (WriteOnly): The type of the resource that is being reserved. * **term**: 'P1Y' | 'P3Y' | string: Represent the term of Reservation. -## ReservationOrderBillingPlanInformation +## PurchaseRequestPropertiesReservedResourceProperties ### Properties -* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **startDate**: string (ReadOnly): Date when the billing plan has started. -* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail +* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. -## Price +## RenewPropertiesResponse +### Properties +* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. +* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. +* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) + +## RenewPropertiesResponseBillingCurrencyTotal ### Properties * **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. +* **currencyCode**: string (ReadOnly) -## PaymentDetail +## RenewPropertiesResponsePricingCurrencyTotal ### Properties -* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. -* **billingCurrencyTotal**: [Price](#price) (ReadOnly) -* **dueDate**: string (ReadOnly): Date when the payment needs to be done. -* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) -* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly) -## ExtendedStatusInfo +## ReservationMergeProperties ### Properties -* **message**: string (ReadOnly): The message giving detailed information about the status code. -* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) +* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} +* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -## ReservationResponse +## ReservationOrderBillingPlanInformation ### Properties -* **etag**: int (ReadOnly) -* **id**: string (ReadOnly): Identifier of the reservation -* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. -* **name**: string (ReadOnly): Name of the reservation -* **properties**: [ReservationProperties](#reservationproperties) (ReadOnly) -* **sku**: [SkuName](#skuname) (ReadOnly) -* **type**: string (ReadOnly): Type of resource. "Microsoft.Capacity/reservationOrders/reservations" +* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **startDate**: string (ReadOnly): Date when the billing plan has started. +* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail ## ReservationProperties ### Properties @@ -93,43 +114,22 @@ * **splitProperties**: [ReservationSplitProperties](#reservationsplitproperties) (ReadOnly) * **term**: 'P1Y' | 'P3Y' | string (ReadOnly): Represent the term of Reservation. -## ReservationMergeProperties -### Properties -* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} - -## RenewPropertiesResponse -### Properties -* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. -* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. -* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) - -## RenewPropertiesResponseBillingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly) - -## RenewPropertiesResponsePricingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly) - -## PurchaseRequest +## ReservationResponse ### Properties +* **etag**: int (ReadOnly) +* **id**: string (ReadOnly): Identifier of the reservation * **location**: string (ReadOnly): The Azure Region where the reserved resource lives. -* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) +* **name**: string (ReadOnly): Name of the reservation +* **properties**: [ReservationProperties](#reservationproperties) (ReadOnly) * **sku**: [SkuName](#skuname) (ReadOnly) - -## SkuName -### Properties -* **name**: string (WriteOnly) +* **type**: string (ReadOnly): Type of resource. "Microsoft.Capacity/reservationOrders/reservations" ## ReservationSplitProperties ### Properties * **splitDestinations**: string[] (ReadOnly): List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} * **splitSource**: string (ReadOnly): Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -## PurchaseRequestPropertiesReservedResourceProperties +## SkuName ### Properties -* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. +* **name**: string (WriteOnly) diff --git a/generated/reservations/microsoft.capacity/2021-07-01/types.md b/generated/reservations/microsoft.capacity/2021-07-01/types.md index 42df82e15a..4959b255ec 100644 --- a/generated/reservations/microsoft.capacity/2021-07-01/types.md +++ b/generated/reservations/microsoft.capacity/2021-07-01/types.md @@ -13,6 +13,32 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Capacity/reservationOrders' (ReadOnly, DeployTimeConstant): The resource type +## ExtendedStatusInfo +### Properties +* **message**: string (ReadOnly): The message giving detailed information about the status code. +* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'Processing' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) + +## PaymentDetail +### Properties +* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. +* **billingCurrencyTotal**: [Price](#price) (ReadOnly) +* **dueDate**: string (ReadOnly): Date when the payment needs to be done. +* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) +* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. + +## Price +### Properties +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. + +## PurchaseRequest +### Properties +* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. +* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) +* **sku**: [SkuName](#skuname) (ReadOnly) + ## PurchaseRequestProperties ### Properties * **appliedScopes**: string[] (WriteOnly): List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. @@ -33,32 +59,37 @@ * **reservedResourceType**: 'AVS' | 'AppService' | 'AzureDataExplorer' | 'AzureFiles' | 'BlockBlob' | 'CosmosDb' | 'DataFactory' | 'Databricks' | 'DedicatedHost' | 'ManagedDisk' | 'MariaDb' | 'MySql' | 'NetAppStorage' | 'PostgreSql' | 'RedHat' | 'RedHatOsa' | 'RedisCache' | 'SapHana' | 'SqlAzureHybridBenefit' | 'SqlDataWarehouse' | 'SqlDatabases' | 'SqlEdge' | 'SuseLinux' | 'VMwareCloudSimple' | 'VirtualMachines' | string (WriteOnly): The type of the resource that is being reserved. * **term**: 'P1Y' | 'P3Y' | 'P5Y' | string: Represent the term of Reservation. -## ReservationOrderBillingPlanInformation +## PurchaseRequestPropertiesReservedResourceProperties ### Properties -* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **startDate**: string (ReadOnly): Date when the billing plan has started. -* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail +* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. -## Price +## RenewPropertiesResponse +### Properties +* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. +* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. +* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) + +## RenewPropertiesResponseBillingCurrencyTotal ### Properties * **amount**: int (ReadOnly) * **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. -## PaymentDetail +## RenewPropertiesResponsePricingCurrencyTotal ### Properties -* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. -* **billingCurrencyTotal**: [Price](#price) (ReadOnly) -* **dueDate**: string (ReadOnly): Date when the payment needs to be done. -* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) -* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. -## ExtendedStatusInfo +## ReservationMergeProperties ### Properties -* **message**: string (ReadOnly): The message giving detailed information about the status code. -* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'Processing' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) +* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} +* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + +## ReservationOrderBillingPlanInformation +### Properties +* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **startDate**: string (ReadOnly): Date when the billing plan has started. +* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail ## ReservationResponse ### Properties @@ -72,6 +103,11 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Type of resource. "Microsoft.Capacity/reservationOrders/reservations" +## ReservationSplitProperties +### Properties +* **splitDestinations**: string[] (ReadOnly): List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} +* **splitSource**: string (ReadOnly): Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + ## ReservationsProperties ### Properties * **appliedScopes**: string[] (ReadOnly): List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. @@ -104,42 +140,6 @@ * **userFriendlyRenewState**: string (ReadOnly): The renew state of the reservation for display, e.g. On * **utilization**: [ReservationsPropertiesUtilization](#reservationspropertiesutilization) (ReadOnly): Reservation utilization -## ReservationMergeProperties -### Properties -* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} - -## RenewPropertiesResponse -### Properties -* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. -* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. -* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) - -## RenewPropertiesResponseBillingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. - -## RenewPropertiesResponsePricingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. - -## PurchaseRequest -### Properties -* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. -* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) -* **sku**: [SkuName](#skuname) (ReadOnly) - -## SkuName -### Properties -* **name**: string (WriteOnly) - -## ReservationSplitProperties -### Properties -* **splitDestinations**: string[] (ReadOnly): List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -* **splitSource**: string (ReadOnly): Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} - ## ReservationsPropertiesUtilization ### Properties * **aggregates**: [ReservationUtilizationAggregates](#reservationutilizationaggregates)[] (ReadOnly): The array of aggregates of a reservation's utilization @@ -152,6 +152,10 @@ * **value**: int (ReadOnly): The aggregate value * **valueUnit**: string (ReadOnly): The aggregate value unit +## SkuName +### Properties +* **name**: string (WriteOnly) + ## SystemData ### Properties * **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). @@ -161,7 +165,3 @@ * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## PurchaseRequestPropertiesReservedResourceProperties -### Properties -* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. - diff --git a/generated/reservations/microsoft.capacity/2022-03-01/types.md b/generated/reservations/microsoft.capacity/2022-03-01/types.md index 90001a9aba..ceb52483bf 100644 --- a/generated/reservations/microsoft.capacity/2022-03-01/types.md +++ b/generated/reservations/microsoft.capacity/2022-03-01/types.md @@ -13,6 +13,32 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Capacity/reservationOrders' (ReadOnly, DeployTimeConstant): The resource type +## ExtendedStatusInfo +### Properties +* **message**: string (ReadOnly): The message giving detailed information about the status code. +* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'Processing' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) + +## PaymentDetail +### Properties +* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. +* **billingCurrencyTotal**: [Price](#price) (ReadOnly) +* **dueDate**: string (ReadOnly): Date when the payment needs to be done. +* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) +* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. + +## Price +### Properties +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. + +## PurchaseRequest +### Properties +* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. +* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) +* **sku**: [SkuName](#skuname) (ReadOnly) + ## PurchaseRequestProperties ### Properties * **appliedScopes**: string[] (WriteOnly): List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. @@ -34,32 +60,37 @@ * **reservedResourceType**: 'AVS' | 'AppService' | 'AzureDataExplorer' | 'AzureFiles' | 'BlockBlob' | 'CosmosDb' | 'DataFactory' | 'Databricks' | 'DedicatedHost' | 'ManagedDisk' | 'MariaDb' | 'MySql' | 'NetAppStorage' | 'PostgreSql' | 'RedHat' | 'RedHatOsa' | 'RedisCache' | 'SapHana' | 'SqlAzureHybridBenefit' | 'SqlDataWarehouse' | 'SqlDatabases' | 'SqlEdge' | 'SuseLinux' | 'VMwareCloudSimple' | 'VirtualMachineSoftware' | 'VirtualMachines' | string (WriteOnly): The type of the resource that is being reserved. * **term**: 'P1Y' | 'P3Y' | 'P5Y' | string: Represent the term of Reservation. -## ReservationOrderBillingPlanInformation +## PurchaseRequestPropertiesReservedResourceProperties ### Properties -* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **startDate**: string (ReadOnly): Date when the billing plan has started. -* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail +* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. -## Price +## RenewPropertiesResponse +### Properties +* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. +* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. +* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) + +## RenewPropertiesResponseBillingCurrencyTotal ### Properties * **amount**: int (ReadOnly) * **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. -## PaymentDetail +## RenewPropertiesResponsePricingCurrencyTotal ### Properties -* **billingAccount**: string (ReadOnly): Shows the Account that is charged for this payment. -* **billingCurrencyTotal**: [Price](#price) (ReadOnly) -* **dueDate**: string (ReadOnly): Date when the payment needs to be done. -* **extendedStatusInfo**: [ExtendedStatusInfo](#extendedstatusinfo) (ReadOnly) -* **paymentDate**: string (ReadOnly): Date when the transaction is completed. Is null when it is scheduled. -* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) -* **status**: 'Cancelled' | 'Failed' | 'Scheduled' | 'Succeeded' | string (ReadOnly): Describes whether the payment is completed, failed, cancelled or scheduled in the future. +* **amount**: int (ReadOnly) +* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. -## ExtendedStatusInfo +## ReservationMergeProperties ### Properties -* **message**: string (ReadOnly): The message giving detailed information about the status code. -* **statusCode**: 'Active' | 'Expired' | 'Merged' | 'None' | 'PaymentInstrumentError' | 'Pending' | 'Processing' | 'PurchaseError' | 'Split' | 'Succeeded' | string (ReadOnly) +* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} +* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + +## ReservationOrderBillingPlanInformation +### Properties +* **nextPaymentDueDate**: string (ReadOnly): For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. +* **pricingCurrencyTotal**: [Price](#price) (ReadOnly) +* **startDate**: string (ReadOnly): Date when the billing plan has started. +* **transactions**: [PaymentDetail](#paymentdetail)[] (ReadOnly): Array of PaymentDetail ## ReservationResponse ### Properties @@ -73,6 +104,11 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Type of resource. "Microsoft.Capacity/reservationOrders/reservations" +## ReservationSplitProperties +### Properties +* **splitDestinations**: string[] (ReadOnly): List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} +* **splitSource**: string (ReadOnly): Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} + ## ReservationsProperties ### Properties * **appliedScopes**: string[] (ReadOnly): List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. @@ -106,42 +142,6 @@ * **userFriendlyRenewState**: string (ReadOnly): The renew state of the reservation for display, e.g. On * **utilization**: [ReservationsPropertiesUtilization](#reservationspropertiesutilization) (ReadOnly): Reservation utilization -## ReservationMergeProperties -### Properties -* **mergeDestination**: string (ReadOnly): Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -* **mergeSources**: string[] (ReadOnly): Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} - -## RenewPropertiesResponse -### Properties -* **billingCurrencyTotal**: [RenewPropertiesResponseBillingCurrencyTotal](#renewpropertiesresponsebillingcurrencytotal) (ReadOnly): Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. -* **pricingCurrencyTotal**: [RenewPropertiesResponsePricingCurrencyTotal](#renewpropertiesresponsepricingcurrencytotal) (ReadOnly): Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. -* **purchaseProperties**: [PurchaseRequest](#purchaserequest) (ReadOnly) - -## RenewPropertiesResponseBillingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. - -## RenewPropertiesResponsePricingCurrencyTotal -### Properties -* **amount**: int (ReadOnly) -* **currencyCode**: string (ReadOnly): The ISO 4217 3-letter currency code for the currency used by this purchase record. - -## PurchaseRequest -### Properties -* **location**: string (ReadOnly): The Azure Region where the reserved resource lives. -* **properties**: [PurchaseRequestProperties](#purchaserequestproperties) (ReadOnly) -* **sku**: [SkuName](#skuname) (ReadOnly) - -## SkuName -### Properties -* **name**: string (WriteOnly) - -## ReservationSplitProperties -### Properties -* **splitDestinations**: string[] (ReadOnly): List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} -* **splitSource**: string (ReadOnly): Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} - ## ReservationsPropertiesUtilization ### Properties * **aggregates**: [ReservationUtilizationAggregates](#reservationutilizationaggregates)[] (ReadOnly): The array of aggregates of a reservation's utilization @@ -154,6 +154,10 @@ * **value**: int (ReadOnly): The aggregate value * **valueUnit**: string (ReadOnly): The aggregate value unit +## SkuName +### Properties +* **name**: string (WriteOnly) + ## SystemData ### Properties * **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). @@ -163,7 +167,3 @@ * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## PurchaseRequestPropertiesReservedResourceProperties -### Properties -* **instanceFlexibility**: 'Off' | 'On' | string (WriteOnly): Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. - diff --git a/generated/resourceconnector/log.out b/generated/resourceconnector/log.out index 574382a9b5..36ca40a96d 100644 --- a/generated/resourceconnector/log.out +++ b/generated/resourceconnector/log.out @@ -3,11 +3,11 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.resourceconnector-2021-10-31-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms -info | Autorest completed in 4.76s. 2 files generated. +info | autorest.bicep took 20ms +info | Autorest completed in 4.49s. 2 files generated. diff --git a/generated/resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.md b/generated/resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.md index 93a99b6599..ec359a8f6d 100644 --- a/generated/resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.md +++ b/generated/resourceconnector/microsoft.resourceconnector/2021-10-31-preview/types.md @@ -18,11 +18,15 @@ * **ApiVersion**: 2021-10-31-preview * **Output**: [ApplianceListCredentialResults](#appliancelistcredentialresults) -## Identity +## ApplianceCredentialKubeconfig ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. +* **name**: 'clusterUser' | string (ReadOnly): Name which contains the role of the kubeconfig. +* **value**: string (ReadOnly): Contains the kubeconfig value. + +## ApplianceListCredentialResults +### Properties +* **hybridConnectionConfig**: [HybridConnectionConfig](#hybridconnectionconfig) (ReadOnly): Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS). +* **kubeconfigs**: [ApplianceCredentialKubeconfig](#appliancecredentialkubeconfig)[] (ReadOnly): The list of appliance kubeconfigs. ## ApplianceProperties ### Properties @@ -37,6 +41,19 @@ ### Properties * **provider**: 'HCI' | 'SCVMM' | 'VMWare' | string: Information about the connected appliance. +## HybridConnectionConfig +### Properties +* **expirationTime**: int (ReadOnly): Timestamp when this token will be expired. +* **hybridConnectionName**: string (ReadOnly): Name of the connection +* **relay**: string (ReadOnly): Name of the notification service. +* **token**: string (ReadOnly): Listener access token + +## Identity +### Properties +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). @@ -51,20 +68,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ApplianceListCredentialResults -### Properties -* **hybridConnectionConfig**: [HybridConnectionConfig](#hybridconnectionconfig) (ReadOnly): Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS). -* **kubeconfigs**: [ApplianceCredentialKubeconfig](#appliancecredentialkubeconfig)[] (ReadOnly): The list of appliance kubeconfigs. - -## HybridConnectionConfig -### Properties -* **expirationTime**: int (ReadOnly): Timestamp when this token will be expired. -* **hybridConnectionName**: string (ReadOnly): Name of the connection -* **relay**: string (ReadOnly): Name of the notification service. -* **token**: string (ReadOnly): Listener access token - -## ApplianceCredentialKubeconfig -### Properties -* **name**: 'clusterUser' | string (ReadOnly): Name which contains the role of the kubeconfig. -* **value**: string (ReadOnly): Contains the kubeconfig value. - diff --git a/generated/resourcegraph/log.out b/generated/resourcegraph/log.out index a66f2d209d..fd84301825 100644 --- a/generated/resourcegraph/log.out +++ b/generated/resourcegraph/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.resourcegraph-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryRequestOptions' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourcegraph.json:191:5 @@ -28,7 +28,7 @@ info | Processing batch task - {"tag":"microsoft.resourcegraph-2020-09-01-pre warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceChangeData-beforeSnapshot' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json:217:9 @@ -37,12 +37,12 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceChangeData-afterSnaps warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'ResourceChangeList-$skipToken' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2020-09-01-preview/resourcechanges.json#/components/schemas/ResourceChangeList-$skipToken -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resourcegraph-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryRequestOptions' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/resourcegraph.json:191:5 @@ -55,12 +55,12 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation' with an undefined warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2021-03-01/resourcegraph.json:549:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resourcegraph-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryRequestOptions' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcegraph.json:187:5 @@ -84,7 +84,7 @@ info | Processing batch task - {"tag":"microsoft.resourcegraph-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryRequestOptions' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/stable/2019-04-01/resourcegraph.json:178:5 @@ -102,7 +102,7 @@ info | Processing batch task - {"tag":"microsoft.resourcegraph-2018-09-01-pre warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'QueryRequestOptions' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json:268:5 @@ -140,4 +140,4 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'ResourceChangeList-$skipToken' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json#/components/schemas/ResourceChangeList-$skipToken info | autorest.bicep took 7ms -info | Autorest completed in 13.02s. 2 files generated. +info | Autorest completed in 12.2s. 2 files generated. diff --git a/generated/resourcehealth/log.out b/generated/resourcehealth/log.out index 33cc9411a8..b0e4aa13da 100644 --- a/generated/resourcehealth/log.out +++ b/generated/resourcehealth/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.resourcehealth-2017-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'availabilityStatusListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json:473:5 @@ -28,7 +28,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.resourcehealth-2015-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'availabilityStatusListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json:401:5 @@ -44,7 +44,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resourcehealth-2018-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'events' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json:529:5 @@ -80,7 +80,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resourcehealth-2020-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2020-05-01-preview/ResourceHealth.json:303:5 @@ -90,7 +90,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resourcehealth-2018-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'events' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json:500:5 @@ -124,7 +124,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resourcehealth-2020-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'operationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json:477:5 @@ -132,4 +132,4 @@ warning | PreCheck/SchemaMissingType | The schema 'operation' with an undefined - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2020-05-01/ResourceHealth.json:492:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 13.97s. 0 files generated. +info | Autorest completed in 13.28s. 0 files generated. diff --git a/generated/resourcemover/log.out b/generated/resourcemover/log.out index 6d8968ac0f..acd519a5d9 100644 --- a/generated/resourcemover/log.out +++ b/generated/resourcemover/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.migrate-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MoveResourceProperties-moveStatus' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2021-08-01/resourcemovercollection.json:1293:9 @@ -31,10 +31,10 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2021-08-01/resourcemovercollection.json:2491:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 23ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.migrate-2019-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MoveResourceProperties-moveStatus' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcemover/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/resourcemovercollection.json:1293:9 @@ -59,10 +59,10 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcemover/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/resourcemovercollection.json:2385:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.migrate-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MoveResourceProperties-moveStatus' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2021-01-01/resourcemovercollection.json:1293:9 @@ -87,5 +87,5 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resourcemover/resource-manager/Microsoft.Migrate/stable/2021-01-01/resourcemovercollection.json:2385:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms -info | Autorest completed in 11.09s. 6 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 10.29s. 6 files generated. diff --git a/generated/resourcemover/microsoft.migrate/2019-10-01-preview/types.md b/generated/resourcemover/microsoft.migrate/2019-10-01-preview/types.md index 05962f4827..755211c736 100644 --- a/generated/resourcemover/microsoft.migrate/2019-10-01-preview/types.md +++ b/generated/resourcemover/microsoft.migrate/2019-10-01-preview/types.md @@ -22,12 +22,49 @@ * **properties**: [MoveResourceProperties](#moveresourceproperties): Defines the move resource properties. * **type**: 'Microsoft.Migrate/moveCollections/moveResources' (ReadOnly, DeployTimeConstant): The resource type +## AutomaticResolutionProperties +### Properties +* **moveResourceId**: string: Gets the MoveResource ARM ID of +the dependent resource if the resolution type is Automatic. + ## Identity ### Properties * **principalId**: string: Gets or sets the principal id. * **tenantId**: string: Gets or sets the tenant id. * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: The type of identity used for the resource mover service. +## JobStatus +### Properties +* **jobName**: 'InitialSync' | string (ReadOnly): Defines the job name. +* **jobProgress**: string (ReadOnly): Gets or sets the monitoring job percentage. + +## LBBackendAddressPoolResourceSettings +### Properties +* **name**: string: Gets or sets the backend address pool name. + +## LBFrontendIPConfigurationResourceSettings +### Properties +* **name**: string: Gets or sets the frontend IP configuration name. +* **privateIpAddress**: string: 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. +* **privateIpAllocationMethod**: string: Gets or sets PrivateIP allocation method (Static/Dynamic). +* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. +* **zones**: string: Gets or sets the csv list of zones. + +## LoadBalancerBackendAddressPoolReference +### Properties +* **name**: string: Gets the name of the proxy resource on the target side. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## LoadBalancerNatRuleReference +### Properties +* **name**: string: Gets the name of the proxy resource on the target side. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## ManualResolutionProperties +### Properties +* **targetId**: string: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. + ## MoveCollectionProperties ### Properties * **errors**: [MoveCollectionPropertiesErrors](#movecollectionpropertieserrors) (ReadOnly): Defines the move collection errors. @@ -39,32 +76,11 @@ ### Properties * **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. -## MoveResourceErrorBody -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [MoveResourceErrorBody](#moveresourceerrorbody)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - ## MoveCollectionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MoveResourceProperties -### Properties -* **dependsOn**: [MoveResourceDependency](#moveresourcedependency)[] (ReadOnly): Gets or sets the move resource dependencies. -* **dependsOnOverrides**: [MoveResourceDependencyOverride](#moveresourcedependencyoverride)[]: Gets or sets the move resource dependencies overrides. -* **errors**: [MoveResourcePropertiesErrors](#moveresourcepropertieserrors) (ReadOnly): Defines the move resource errors. -* **existingTargetId**: string: Gets or sets the existing target ARM Id of the resource. -* **isResolveRequired**: bool (ReadOnly): Gets a value indicating whether the resolve action is required over the move collection. -* **moveStatus**: [MoveResourcePropertiesMoveStatus](#moveresourcepropertiesmovestatus) (ReadOnly): Defines the move resource status. -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Defines the provisioning states. -* **resourceSettings**: [ResourceSettings](#resourcesettings): Gets or sets the resource settings. -* **sourceId**: string (Required): Gets or sets the Source ARM Id of the resource. -* **sourceResourceSettings**: [ResourceSettings](#resourcesettings) (ReadOnly): Gets or sets the resource settings. -* **targetId**: string (ReadOnly): Gets or sets the Target ARM Id of the resource. - ## MoveResourceDependency ### Properties * **automaticResolution**: [AutomaticResolutionProperties](#automaticresolutionproperties): Defines the properties for automatic resolution. @@ -75,21 +91,37 @@ * **resolutionStatus**: string: Gets the dependency resolution status. * **resolutionType**: 'Automatic' | 'Manual' | string: Defines the resolution type. -## AutomaticResolutionProperties -### Properties -* **moveResourceId**: string: Gets the MoveResource ARM ID of -the dependent resource if the resolution type is Automatic. - -## ManualResolutionProperties -### Properties -* **targetId**: string: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. - ## MoveResourceDependencyOverride ### Properties * **id**: string: Gets or sets the ARM ID of the dependent resource. * **targetId**: string: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. +## MoveResourceError +### Properties +* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. + +## MoveResourceErrorBody +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [MoveResourceErrorBody](#moveresourceerrorbody)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## MoveResourceProperties +### Properties +* **dependsOn**: [MoveResourceDependency](#moveresourcedependency)[] (ReadOnly): Gets or sets the move resource dependencies. +* **dependsOnOverrides**: [MoveResourceDependencyOverride](#moveresourcedependencyoverride)[]: Gets or sets the move resource dependencies overrides. +* **errors**: [MoveResourcePropertiesErrors](#moveresourcepropertieserrors) (ReadOnly): Defines the move resource errors. +* **existingTargetId**: string: Gets or sets the existing target ARM Id of the resource. +* **isResolveRequired**: bool (ReadOnly): Gets a value indicating whether the resolve action is required over the move collection. +* **moveStatus**: [MoveResourcePropertiesMoveStatus](#moveresourcepropertiesmovestatus) (ReadOnly): Defines the move resource status. +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Defines the provisioning states. +* **resourceSettings**: [ResourceSettings](#resourcesettings): Gets or sets the resource settings. +* **sourceId**: string (Required): Gets or sets the Source ARM Id of the resource. +* **sourceResourceSettings**: [ResourceSettings](#resourcesettings) (ReadOnly): Gets or sets the resource settings. +* **targetId**: string (ReadOnly): Gets or sets the Target ARM Id of the resource. + ## MoveResourcePropertiesErrors ### Properties * **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. @@ -100,14 +132,48 @@ the dependent resource. * **jobStatus**: [JobStatus](#jobstatus): Defines the job status. * **moveState**: 'AssignmentPending' | 'CommitFailed' | 'CommitInProgress' | 'CommitPending' | 'Committed' | 'DeleteSourcePending' | 'DiscardFailed' | 'DiscardInProgress' | 'MoveFailed' | 'MoveInProgress' | 'MovePending' | 'PrepareFailed' | 'PrepareInProgress' | 'PreparePending' | 'ResourceMoveCompleted' | string (ReadOnly): Defines the MoveResource states. -## MoveResourceError +## NicIpConfigurationResourceSettings ### Properties -* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. +* **loadBalancerBackendAddressPools**: [LoadBalancerBackendAddressPoolReference](#loadbalancerbackendaddresspoolreference)[]: Gets or sets the references of the load balancer backend address pools. +* **loadBalancerNatRules**: [LoadBalancerNatRuleReference](#loadbalancernatrulereference)[]: Gets or sets the references of the load balancer NAT rules. +* **name**: string: Gets or sets the IP configuration name. +* **primary**: bool: Gets or sets a value indicating whether this IP configuration is the primary. +* **privateIpAddress**: string: Gets or sets the private IP address of the network interface IP Configuration. +* **privateIpAllocationMethod**: string: Gets or sets the private IP address allocation method. +* **publicIp**: [PublicIpReference](#publicipreference): Defines reference to a public IP. +* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. -## JobStatus +## NsgReference ### Properties -* **jobName**: 'InitialSync' | string (ReadOnly): Defines the job name. -* **jobProgress**: string (ReadOnly): Gets or sets the monitoring job percentage. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## NsgSecurityRule +### Properties +* **access**: string: Gets or sets whether network traffic is allowed or denied. +Possible values are “Allow” and “Deny”. +* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string: Gets or sets destination address prefix. CIDR or source IP range. + A “*” can also be used to match all source IPs. Default tags such +as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. +* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between +0 and 65535. A “*” can also be used to match all ports. +* **direction**: 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. +* **name**: string: Gets or sets the Security rule name. +* **priority**: int: 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. +* **protocol**: string: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). +* **sourceAddressPrefix**: string: Gets or sets source address prefix. CIDR or source IP range. A +“*” 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. +* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and +65535. A “*” can also be used to match all ports. + +## PublicIpReference +### Properties +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. ## ResourceSettings * **Discriminator**: resourceType @@ -193,80 +259,14 @@ DDOS protection should be switched on. * **resourceType**: 'resourceGroups' (Required): The resource type. For example, the value can be Microsoft.Compute/virtualMachines. -## LBBackendAddressPoolResourceSettings -### Properties -* **name**: string: Gets or sets the backend address pool name. - -## LBFrontendIPConfigurationResourceSettings -### Properties -* **name**: string: Gets or sets the frontend IP configuration name. -* **privateIpAddress**: string: 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. -* **privateIpAllocationMethod**: string: Gets or sets PrivateIP allocation method (Static/Dynamic). -* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. -* **zones**: string: Gets or sets the csv list of zones. - ## SubnetReference ### Properties * **name**: string: Gets the name of the proxy resource on the target side. * **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. -## NicIpConfigurationResourceSettings -### Properties -* **loadBalancerBackendAddressPools**: [LoadBalancerBackendAddressPoolReference](#loadbalancerbackendaddresspoolreference)[]: Gets or sets the references of the load balancer backend address pools. -* **loadBalancerNatRules**: [LoadBalancerNatRuleReference](#loadbalancernatrulereference)[]: Gets or sets the references of the load balancer NAT rules. -* **name**: string: Gets or sets the IP configuration name. -* **primary**: bool: Gets or sets a value indicating whether this IP configuration is the primary. -* **privateIpAddress**: string: Gets or sets the private IP address of the network interface IP Configuration. -* **privateIpAllocationMethod**: string: Gets or sets the private IP address allocation method. -* **publicIp**: [PublicIpReference](#publicipreference): Defines reference to a public IP. -* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. - -## LoadBalancerBackendAddressPoolReference -### Properties -* **name**: string: Gets the name of the proxy resource on the target side. -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## LoadBalancerNatRuleReference -### Properties -* **name**: string: Gets the name of the proxy resource on the target side. -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## PublicIpReference -### Properties -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## NsgSecurityRule -### Properties -* **access**: string: Gets or sets whether network traffic is allowed or denied. -Possible values are “Allow” and “Deny”. -* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string: Gets or sets destination address prefix. CIDR or source IP range. - A “*” can also be used to match all source IPs. Default tags such -as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. -* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between -0 and 65535. A “*” can also be used to match all ports. -* **direction**: 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. -* **name**: string: Gets or sets the Security rule name. -* **priority**: int: 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. -* **protocol**: string: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). -* **sourceAddressPrefix**: string: Gets or sets source address prefix. CIDR or source IP range. A -“*” 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. -* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and -65535. A “*” can also be used to match all ports. - ## SubnetResourceSettings ### Properties * **addressPrefix**: string: Gets or sets address prefix for the subnet. * **name**: string: Gets or sets the Subnet name. * **networkSecurityGroup**: [NsgReference](#nsgreference): Defines reference to NSG. -## NsgReference -### Properties -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - diff --git a/generated/resourcemover/microsoft.migrate/2021-01-01/types.md b/generated/resourcemover/microsoft.migrate/2021-01-01/types.md index 47586d8cdb..9e3883b9d0 100644 --- a/generated/resourcemover/microsoft.migrate/2021-01-01/types.md +++ b/generated/resourcemover/microsoft.migrate/2021-01-01/types.md @@ -22,12 +22,49 @@ * **properties**: [MoveResourceProperties](#moveresourceproperties): Defines the move resource properties. * **type**: 'Microsoft.Migrate/moveCollections/moveResources' (ReadOnly, DeployTimeConstant): The resource type +## AutomaticResolutionProperties +### Properties +* **moveResourceId**: string: Gets the MoveResource ARM ID of +the dependent resource if the resolution type is Automatic. + ## Identity ### Properties * **principalId**: string: Gets or sets the principal id. * **tenantId**: string: Gets or sets the tenant id. * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: The type of identity used for the resource mover service. +## JobStatus +### Properties +* **jobName**: 'InitialSync' | string (ReadOnly): Defines the job name. +* **jobProgress**: string (ReadOnly): Gets or sets the monitoring job percentage. + +## LBBackendAddressPoolResourceSettings +### Properties +* **name**: string: Gets or sets the backend address pool name. + +## LBFrontendIPConfigurationResourceSettings +### Properties +* **name**: string: Gets or sets the frontend IP configuration name. +* **privateIpAddress**: string: 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. +* **privateIpAllocationMethod**: string: Gets or sets PrivateIP allocation method (Static/Dynamic). +* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. +* **zones**: string: Gets or sets the csv list of zones. + +## LoadBalancerBackendAddressPoolReference +### Properties +* **name**: string: Gets the name of the proxy resource on the target side. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## LoadBalancerNatRuleReference +### Properties +* **name**: string: Gets the name of the proxy resource on the target side. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## ManualResolutionProperties +### Properties +* **targetId**: string: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. + ## MoveCollectionProperties ### Properties * **errors**: [MoveCollectionPropertiesErrors](#movecollectionpropertieserrors) (ReadOnly): Defines the move collection errors. @@ -39,32 +76,11 @@ ### Properties * **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. -## MoveResourceErrorBody -### Properties -* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. -* **details**: [MoveResourceErrorBody](#moveresourceerrorbody)[] (ReadOnly): A list of additional details about the error. -* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. -* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. - ## MoveCollectionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## MoveResourceProperties -### Properties -* **dependsOn**: [MoveResourceDependency](#moveresourcedependency)[] (ReadOnly): Gets or sets the move resource dependencies. -* **dependsOnOverrides**: [MoveResourceDependencyOverride](#moveresourcedependencyoverride)[]: Gets or sets the move resource dependencies overrides. -* **errors**: [MoveResourcePropertiesErrors](#moveresourcepropertieserrors) (ReadOnly): Defines the move resource errors. -* **existingTargetId**: string: Gets or sets the existing target ARM Id of the resource. -* **isResolveRequired**: bool (ReadOnly): Gets a value indicating whether the resolve action is required over the move collection. -* **moveStatus**: [MoveResourcePropertiesMoveStatus](#moveresourcepropertiesmovestatus) (ReadOnly): Defines the move resource status. -* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Defines the provisioning states. -* **resourceSettings**: [ResourceSettings](#resourcesettings): Gets or sets the resource settings. -* **sourceId**: string (Required): Gets or sets the Source ARM Id of the resource. -* **sourceResourceSettings**: [ResourceSettings](#resourcesettings) (ReadOnly): Gets or sets the resource settings. -* **targetId**: string (ReadOnly): Gets or sets the Target ARM Id of the resource. - ## MoveResourceDependency ### Properties * **automaticResolution**: [AutomaticResolutionProperties](#automaticresolutionproperties): Defines the properties for automatic resolution. @@ -75,21 +91,37 @@ * **resolutionStatus**: string: Gets the dependency resolution status. * **resolutionType**: 'Automatic' | 'Manual' | string: Defines the resolution type. -## AutomaticResolutionProperties -### Properties -* **moveResourceId**: string: Gets the MoveResource ARM ID of -the dependent resource if the resolution type is Automatic. - -## ManualResolutionProperties -### Properties -* **targetId**: string: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. - ## MoveResourceDependencyOverride ### Properties * **id**: string: Gets or sets the ARM ID of the dependent resource. * **targetId**: string: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. +## MoveResourceError +### Properties +* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. + +## MoveResourceErrorBody +### Properties +* **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. +* **details**: [MoveResourceErrorBody](#moveresourceerrorbody)[] (ReadOnly): A list of additional details about the error. +* **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. +* **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. + +## MoveResourceProperties +### Properties +* **dependsOn**: [MoveResourceDependency](#moveresourcedependency)[] (ReadOnly): Gets or sets the move resource dependencies. +* **dependsOnOverrides**: [MoveResourceDependencyOverride](#moveresourcedependencyoverride)[]: Gets or sets the move resource dependencies overrides. +* **errors**: [MoveResourcePropertiesErrors](#moveresourcepropertieserrors) (ReadOnly): Defines the move resource errors. +* **existingTargetId**: string: Gets or sets the existing target ARM Id of the resource. +* **isResolveRequired**: bool (ReadOnly): Gets a value indicating whether the resolve action is required over the move collection. +* **moveStatus**: [MoveResourcePropertiesMoveStatus](#moveresourcepropertiesmovestatus) (ReadOnly): Defines the move resource status. +* **provisioningState**: 'Creating' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): Defines the provisioning states. +* **resourceSettings**: [ResourceSettings](#resourcesettings): Gets or sets the resource settings. +* **sourceId**: string (Required): Gets or sets the Source ARM Id of the resource. +* **sourceResourceSettings**: [ResourceSettings](#resourcesettings) (ReadOnly): Gets or sets the resource settings. +* **targetId**: string (ReadOnly): Gets or sets the Target ARM Id of the resource. + ## MoveResourcePropertiesErrors ### Properties * **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. @@ -100,14 +132,48 @@ the dependent resource. * **jobStatus**: [JobStatus](#jobstatus): Defines the job status. * **moveState**: 'AssignmentPending' | 'CommitFailed' | 'CommitInProgress' | 'CommitPending' | 'Committed' | 'DeleteSourcePending' | 'DiscardFailed' | 'DiscardInProgress' | 'MoveFailed' | 'MoveInProgress' | 'MovePending' | 'PrepareFailed' | 'PrepareInProgress' | 'PreparePending' | 'ResourceMoveCompleted' | string (ReadOnly): Defines the MoveResource states. -## MoveResourceError +## NicIpConfigurationResourceSettings ### Properties -* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. +* **loadBalancerBackendAddressPools**: [LoadBalancerBackendAddressPoolReference](#loadbalancerbackendaddresspoolreference)[]: Gets or sets the references of the load balancer backend address pools. +* **loadBalancerNatRules**: [LoadBalancerNatRuleReference](#loadbalancernatrulereference)[]: Gets or sets the references of the load balancer NAT rules. +* **name**: string: Gets or sets the IP configuration name. +* **primary**: bool: Gets or sets a value indicating whether this IP configuration is the primary. +* **privateIpAddress**: string: Gets or sets the private IP address of the network interface IP Configuration. +* **privateIpAllocationMethod**: string: Gets or sets the private IP address allocation method. +* **publicIp**: [PublicIpReference](#publicipreference): Defines reference to a public IP. +* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. -## JobStatus +## NsgReference ### Properties -* **jobName**: 'InitialSync' | string (ReadOnly): Defines the job name. -* **jobProgress**: string (ReadOnly): Gets or sets the monitoring job percentage. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## NsgSecurityRule +### Properties +* **access**: string: Gets or sets whether network traffic is allowed or denied. +Possible values are “Allow” and “Deny”. +* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string: Gets or sets destination address prefix. CIDR or source IP range. + A “*” can also be used to match all source IPs. Default tags such +as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. +* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between +0 and 65535. A “*” can also be used to match all ports. +* **direction**: 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. +* **name**: string: Gets or sets the Security rule name. +* **priority**: int: 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. +* **protocol**: string: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). +* **sourceAddressPrefix**: string: Gets or sets source address prefix. CIDR or source IP range. A +“*” 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. +* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and +65535. A “*” can also be used to match all ports. + +## PublicIpReference +### Properties +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. ## ResourceSettings * **Discriminator**: resourceType @@ -193,80 +259,14 @@ DDOS protection should be switched on. * **resourceType**: 'resourceGroups' (Required): The resource type. For example, the value can be Microsoft.Compute/virtualMachines. -## LBBackendAddressPoolResourceSettings -### Properties -* **name**: string: Gets or sets the backend address pool name. - -## LBFrontendIPConfigurationResourceSettings -### Properties -* **name**: string: Gets or sets the frontend IP configuration name. -* **privateIpAddress**: string: 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. -* **privateIpAllocationMethod**: string: Gets or sets PrivateIP allocation method (Static/Dynamic). -* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. -* **zones**: string: Gets or sets the csv list of zones. - ## SubnetReference ### Properties * **name**: string: Gets the name of the proxy resource on the target side. * **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. -## NicIpConfigurationResourceSettings -### Properties -* **loadBalancerBackendAddressPools**: [LoadBalancerBackendAddressPoolReference](#loadbalancerbackendaddresspoolreference)[]: Gets or sets the references of the load balancer backend address pools. -* **loadBalancerNatRules**: [LoadBalancerNatRuleReference](#loadbalancernatrulereference)[]: Gets or sets the references of the load balancer NAT rules. -* **name**: string: Gets or sets the IP configuration name. -* **primary**: bool: Gets or sets a value indicating whether this IP configuration is the primary. -* **privateIpAddress**: string: Gets or sets the private IP address of the network interface IP Configuration. -* **privateIpAllocationMethod**: string: Gets or sets the private IP address allocation method. -* **publicIp**: [PublicIpReference](#publicipreference): Defines reference to a public IP. -* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. - -## LoadBalancerBackendAddressPoolReference -### Properties -* **name**: string: Gets the name of the proxy resource on the target side. -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## LoadBalancerNatRuleReference -### Properties -* **name**: string: Gets the name of the proxy resource on the target side. -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## PublicIpReference -### Properties -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## NsgSecurityRule -### Properties -* **access**: string: Gets or sets whether network traffic is allowed or denied. -Possible values are “Allow” and “Deny”. -* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string: Gets or sets destination address prefix. CIDR or source IP range. - A “*” can also be used to match all source IPs. Default tags such -as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. -* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between -0 and 65535. A “*” can also be used to match all ports. -* **direction**: 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. -* **name**: string: Gets or sets the Security rule name. -* **priority**: int: 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. -* **protocol**: string: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). -* **sourceAddressPrefix**: string: Gets or sets source address prefix. CIDR or source IP range. A -“*” 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. -* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and -65535. A “*” can also be used to match all ports. - ## SubnetResourceSettings ### Properties * **addressPrefix**: string: Gets or sets address prefix for the subnet. * **name**: string: Gets or sets the Subnet name. * **networkSecurityGroup**: [NsgReference](#nsgreference): Defines reference to NSG. -## NsgReference -### Properties -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - diff --git a/generated/resourcemover/microsoft.migrate/2021-08-01/types.md b/generated/resourcemover/microsoft.migrate/2021-08-01/types.md index 2aa727d8e5..f3e7d8310c 100644 --- a/generated/resourcemover/microsoft.migrate/2021-08-01/types.md +++ b/generated/resourcemover/microsoft.migrate/2021-08-01/types.md @@ -24,12 +24,59 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Migrate/moveCollections/moveResources' (ReadOnly, DeployTimeConstant): The resource type +## AutomaticResolutionProperties +### Properties +* **moveResourceId**: string: Gets the MoveResource ARM ID of +the dependent resource if the resolution type is Automatic. + +## AvailabilitySetResourceSettingsTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## Identity ### Properties * **principalId**: string: Gets or sets the principal id. * **tenantId**: string: Gets or sets the tenant id. * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: The type of identity used for the resource mover service. +## JobStatus +### Properties +* **jobName**: 'InitialSync' | string (ReadOnly): Defines the job name. +* **jobProgress**: string (ReadOnly): Gets or sets the monitoring job percentage. + +## LBBackendAddressPoolResourceSettings +### Properties +* **name**: string: Gets or sets the backend address pool name. + +## LBFrontendIPConfigurationResourceSettings +### Properties +* **name**: string: Gets or sets the frontend IP configuration name. +* **privateIpAddress**: string: 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. +* **privateIpAllocationMethod**: string: Gets or sets PrivateIP allocation method (Static/Dynamic). +* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. +* **zones**: string: Gets or sets the csv list of zones. + +## LoadBalancerBackendAddressPoolReference +### Properties +* **name**: string: Gets the name of the proxy resource on the target side. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## LoadBalancerNatRuleReference +### Properties +* **name**: string: Gets the name of the proxy resource on the target side. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. + +## LoadBalancerResourceSettingsTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ManualResolutionProperties +### Properties +* **targetId**: string: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. + ## MoveCollectionProperties ### Properties * **errors**: [MoveCollectionPropertiesErrors](#movecollectionpropertieserrors) (ReadOnly): Defines the move collection errors. @@ -41,6 +88,31 @@ ### Properties * **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. +## MoveCollectionTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MoveResourceDependency +### Properties +* **automaticResolution**: [AutomaticResolutionProperties](#automaticresolutionproperties): Defines the properties for automatic resolution. +* **dependencyType**: 'RequiredForMove' | 'RequiredForPrepare' | string: Defines the dependency type. +* **id**: string: Gets the source ARM ID of the dependent resource. +* **isOptional**: string: Gets or sets a value indicating whether the dependency is optional. +* **manualResolution**: [ManualResolutionProperties](#manualresolutionproperties): Defines the properties for manual resolution. +* **resolutionStatus**: string: Gets the dependency resolution status. +* **resolutionType**: 'Automatic' | 'Manual' | string: Defines the resolution type. + +## MoveResourceDependencyOverride +### Properties +* **id**: string: Gets or sets the ARM ID of the dependent resource. +* **targetId**: string: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of +the dependent resource. + +## MoveResourceError +### Properties +* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. + ## MoveResourceErrorBody ### Properties * **code**: string (ReadOnly): An identifier for the error. Codes are invariant and are intended to be consumed programmatically. @@ -48,20 +120,6 @@ * **message**: string (ReadOnly): A message describing the error, intended to be suitable for display in a user interface. * **target**: string (ReadOnly): The target of the particular error. For example, the name of the property in error. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## MoveCollectionTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## MoveResourceProperties ### Properties * **dependsOn**: [MoveResourceDependency](#moveresourcedependency)[] (ReadOnly): Gets or sets the move resource dependencies. @@ -76,49 +134,73 @@ * **sourceResourceSettings**: [ResourceSettings](#resourcesettings) (ReadOnly): Gets or sets the resource settings. * **targetId**: string (ReadOnly): Gets or sets the Target ARM Id of the resource. -## MoveResourceDependency +## MoveResourcePropertiesErrors ### Properties -* **automaticResolution**: [AutomaticResolutionProperties](#automaticresolutionproperties): Defines the properties for automatic resolution. -* **dependencyType**: 'RequiredForMove' | 'RequiredForPrepare' | string: Defines the dependency type. -* **id**: string: Gets the source ARM ID of the dependent resource. -* **isOptional**: string: Gets or sets a value indicating whether the dependency is optional. -* **manualResolution**: [ManualResolutionProperties](#manualresolutionproperties): Defines the properties for manual resolution. -* **resolutionStatus**: string: Gets the dependency resolution status. -* **resolutionType**: 'Automatic' | 'Manual' | string: Defines the resolution type. +* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. -## AutomaticResolutionProperties +## MoveResourcePropertiesMoveStatus ### Properties -* **moveResourceId**: string: Gets the MoveResource ARM ID of -the dependent resource if the resolution type is Automatic. +* **errors**: [MoveResourceError](#moveresourceerror): An error response from the azure resource mover service. +* **jobStatus**: [JobStatus](#jobstatus): Defines the job status. +* **moveState**: 'AssignmentPending' | 'CommitFailed' | 'CommitInProgress' | 'CommitPending' | 'Committed' | 'DeleteSourcePending' | 'DiscardFailed' | 'DiscardInProgress' | 'MoveFailed' | 'MoveInProgress' | 'MovePending' | 'PrepareFailed' | 'PrepareInProgress' | 'PreparePending' | 'ResourceMoveCompleted' | string (ReadOnly): Defines the MoveResource states. -## ManualResolutionProperties +## NetworkInterfaceResourceSettingsTags ### Properties -* **targetId**: string: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. +### Additional Properties +* **Additional Properties Type**: string -## MoveResourceDependencyOverride +## NetworkSecurityGroupResourceSettingsTags ### Properties -* **id**: string: Gets or sets the ARM ID of the dependent resource. -* **targetId**: string: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of -the dependent resource. +### Additional Properties +* **Additional Properties Type**: string -## MoveResourcePropertiesErrors +## NicIpConfigurationResourceSettings ### Properties -* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. +* **loadBalancerBackendAddressPools**: [LoadBalancerBackendAddressPoolReference](#loadbalancerbackendaddresspoolreference)[]: Gets or sets the references of the load balancer backend address pools. +* **loadBalancerNatRules**: [LoadBalancerNatRuleReference](#loadbalancernatrulereference)[]: Gets or sets the references of the load balancer NAT rules. +* **name**: string: Gets or sets the IP configuration name. +* **primary**: bool: Gets or sets a value indicating whether this IP configuration is the primary. +* **privateIpAddress**: string: Gets or sets the private IP address of the network interface IP Configuration. +* **privateIpAllocationMethod**: string: Gets or sets the private IP address allocation method. +* **publicIp**: [PublicIpReference](#publicipreference): Defines reference to a public IP. +* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. -## MoveResourcePropertiesMoveStatus +## NsgReference ### Properties -* **errors**: [MoveResourceError](#moveresourceerror): An error response from the azure resource mover service. -* **jobStatus**: [JobStatus](#jobstatus): Defines the job status. -* **moveState**: 'AssignmentPending' | 'CommitFailed' | 'CommitInProgress' | 'CommitPending' | 'Committed' | 'DeleteSourcePending' | 'DiscardFailed' | 'DiscardInProgress' | 'MoveFailed' | 'MoveInProgress' | 'MovePending' | 'PrepareFailed' | 'PrepareInProgress' | 'PreparePending' | 'ResourceMoveCompleted' | string (ReadOnly): Defines the MoveResource states. +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. -## MoveResourceError +## NsgSecurityRule ### Properties -* **properties**: [MoveResourceErrorBody](#moveresourceerrorbody): An error response from the Azure Migrate service. +* **access**: string: Gets or sets whether network traffic is allowed or denied. +Possible values are “Allow” and “Deny”. +* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. +* **destinationAddressPrefix**: string: Gets or sets destination address prefix. CIDR or source IP range. + A “*” can also be used to match all source IPs. Default tags such +as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. +* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between +0 and 65535. A “*” can also be used to match all ports. +* **direction**: 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. +* **name**: string: Gets or sets the Security rule name. +* **priority**: int: 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. +* **protocol**: string: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). +* **sourceAddressPrefix**: string: Gets or sets source address prefix. CIDR or source IP range. A +“*” 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. +* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and +65535. A “*” can also be used to match all ports. -## JobStatus +## PublicIPAddressResourceSettingsTags ### Properties -* **jobName**: 'InitialSync' | string (ReadOnly): Defines the job name. -* **jobProgress**: string (ReadOnly): Gets or sets the monitoring job percentage. +### Additional Properties +* **Additional Properties Type**: string + +## PublicIpReference +### Properties +* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. ## ResourceSettings * **Discriminator**: resourceType @@ -214,124 +296,42 @@ DDOS protection should be switched on. * **resourceType**: 'resourceGroups' (Required): The resource type. For example, the value can be Microsoft.Compute/virtualMachines. -## AvailabilitySetResourceSettingsTags +## SqlDatabaseResourceSettingsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VirtualMachineResourceSettingsTags +## SqlElasticPoolResourceSettingsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## LBBackendAddressPoolResourceSettings -### Properties -* **name**: string: Gets or sets the backend address pool name. - -## LBFrontendIPConfigurationResourceSettings -### Properties -* **name**: string: Gets or sets the frontend IP configuration name. -* **privateIpAddress**: string: 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. -* **privateIpAllocationMethod**: string: Gets or sets PrivateIP allocation method (Static/Dynamic). -* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. -* **zones**: string: Gets or sets the csv list of zones. - ## SubnetReference ### Properties * **name**: string: Gets the name of the proxy resource on the target side. * **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. -## LoadBalancerResourceSettingsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NicIpConfigurationResourceSettings -### Properties -* **loadBalancerBackendAddressPools**: [LoadBalancerBackendAddressPoolReference](#loadbalancerbackendaddresspoolreference)[]: Gets or sets the references of the load balancer backend address pools. -* **loadBalancerNatRules**: [LoadBalancerNatRuleReference](#loadbalancernatrulereference)[]: Gets or sets the references of the load balancer NAT rules. -* **name**: string: Gets or sets the IP configuration name. -* **primary**: bool: Gets or sets a value indicating whether this IP configuration is the primary. -* **privateIpAddress**: string: Gets or sets the private IP address of the network interface IP Configuration. -* **privateIpAllocationMethod**: string: Gets or sets the private IP address allocation method. -* **publicIp**: [PublicIpReference](#publicipreference): Defines reference to a public IP. -* **subnet**: [SubnetReference](#subnetreference): Defines reference to subnet. - -## LoadBalancerBackendAddressPoolReference -### Properties -* **name**: string: Gets the name of the proxy resource on the target side. -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## LoadBalancerNatRuleReference -### Properties -* **name**: string: Gets the name of the proxy resource on the target side. -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## PublicIpReference -### Properties -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## NetworkInterfaceResourceSettingsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## NsgSecurityRule -### Properties -* **access**: string: Gets or sets whether network traffic is allowed or denied. -Possible values are “Allow” and “Deny”. -* **description**: string: Gets or sets a description for this rule. Restricted to 140 chars. -* **destinationAddressPrefix**: string: Gets or sets destination address prefix. CIDR or source IP range. - A “*” can also be used to match all source IPs. Default tags such -as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. -* **destinationPortRange**: string: Gets or sets Destination Port or Range. Integer or range between -0 and 65535. A “*” can also be used to match all ports. -* **direction**: 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. -* **name**: string: Gets or sets the Security rule name. -* **priority**: int: 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. -* **protocol**: string: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). -* **sourceAddressPrefix**: string: Gets or sets source address prefix. CIDR or source IP range. A -“*” 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. -* **sourcePortRange**: string: Gets or sets Source Port or Range. Integer or range between 0 and -65535. A “*” can also be used to match all ports. - -## NetworkSecurityGroupResourceSettingsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PublicIPAddressResourceSettingsTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SubnetResourceSettings ### Properties * **addressPrefix**: string: Gets or sets address prefix for the subnet. * **name**: string: Gets or sets the Subnet name. * **networkSecurityGroup**: [NsgReference](#nsgreference): Defines reference to NSG. -## NsgReference -### Properties -* **sourceArmResourceId**: string (Required): Gets the ARM resource ID of the tracked resource being referenced. - -## VirtualNetworkResourceSettingsTags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## SqlDatabaseResourceSettingsTags +## VirtualMachineResourceSettingsTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlElasticPoolResourceSettingsTags +## VirtualNetworkResourceSettingsTags ### Properties ### Additional Properties * **Additional Properties Type**: string diff --git a/generated/resources/log.out b/generated/resources/log.out index ae655dfd79..198a52157f 100644 --- a/generated/resources/log.out +++ b/generated/resources/log.out @@ -51,7 +51,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.resources-2022-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -102,7 +102,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms @@ -156,7 +156,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms @@ -210,7 +210,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-09-01/dataPolicyManifests.json:123:5 @@ -278,7 +278,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 15ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.authorization-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -329,7 +329,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/policyAssignments.json:697:5 @@ -377,7 +377,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.authorization-2020-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -428,7 +428,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/preview/2020-07-01-preview/policyExemptions.json:378:5 @@ -491,7 +491,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/privateLinks.json:596:5 @@ -568,7 +568,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/resources.json:4480:5 @@ -719,7 +719,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.authorization-2017-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -770,7 +770,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagementLockOwner' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2017-04-01/locks.json:1045:5 @@ -785,7 +785,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2017-04-01/locks.json:1158:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.solutions-2020-08-21-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -836,7 +836,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Application' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json:1300:5 @@ -922,7 +922,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 11ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.resources-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -973,7 +973,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PairedRegion' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json:283:5 @@ -1165,7 +1165,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.resources-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1216,7 +1216,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentScriptListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json:814:5 @@ -1373,7 +1373,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 11ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.resources-2019-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1424,7 +1424,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentScriptListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json:810:5 @@ -1436,7 +1436,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.features-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1487,10 +1487,10 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.features-2015-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1541,7 +1541,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FeatureProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json:276:5 @@ -1554,7 +1554,7 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json:349:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.authorization-2016-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1605,7 +1605,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagementLockOwner' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/locks.json:943:5 @@ -1671,7 +1671,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ManagementLockProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json:597:5 @@ -1731,7 +1731,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-03-01/policyAssignments.json:580:5 @@ -1830,7 +1830,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2019-09-01/policyAssignments.json:586:5 @@ -1878,7 +1878,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.authorization-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1929,7 +1929,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2019-06-01/policyAssignments.json:538:5 @@ -2016,7 +2016,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2019-01-01/policyAssignments.json:535:5 @@ -2052,7 +2052,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.authorization-2018-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2103,7 +2103,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policyAssignments.json:535:5 @@ -2139,7 +2139,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.authorization-2018-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2190,7 +2190,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json:523:5 @@ -2275,7 +2275,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json:487:5 @@ -2300,7 +2300,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.authorization-2016-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2351,7 +2351,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyDefinitionProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json:353:5 @@ -2371,7 +2371,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.resources-2022-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2422,7 +2422,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -2481,7 +2481,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TemplateSpecsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2021-05-01/templateSpecs.json:618:5 @@ -2495,7 +2495,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.resources-2021-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2546,7 +2546,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TemplateSpecsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/preview/2021-03-01-preview/templateSpecs.json:618:5 @@ -2560,7 +2560,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 1ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.resources-2019-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2611,7 +2611,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TemplateSpecsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json:614:5 @@ -2673,7 +2673,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyDefinitionProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-04-01/policy.json:551:5 @@ -2690,7 +2690,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentListResult' w warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{policyAssignmentId}': Unable to locate "/providers/" segment warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.authorization-2015-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2741,7 +2741,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyDefinitionProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json:551:5 @@ -2758,7 +2758,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentListResult' w warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/{policyAssignmentId}': Unable to locate "/providers/" segment warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 1ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.resources-2020-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2809,7 +2809,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2020-08-01/resources.json:4367:5 @@ -2956,7 +2956,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.resources-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3007,7 +3007,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json:4357:5 @@ -3152,7 +3152,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.resources-2019-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3203,7 +3203,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json:4318:5 @@ -3342,7 +3342,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.resources-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3393,7 +3393,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-08-01/resources.json:4019:5 @@ -3575,7 +3575,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-07-01/resources.json:4019:5 @@ -3704,7 +3704,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.resources-2019-05-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3755,7 +3755,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-05-10/resources.json:2724:5 @@ -3872,7 +3872,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.resources-2019-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3923,7 +3923,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-05-01/resources.json:2648:5 @@ -4091,7 +4091,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/resources.json:2429:5 @@ -4208,7 +4208,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.resources-2018-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4259,7 +4259,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json:2421:5 @@ -4376,7 +4376,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.resources-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4427,7 +4427,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json:1988:5 @@ -4540,7 +4540,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.resources-2017-05-10"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4591,7 +4591,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json:1980:5 @@ -4753,7 +4753,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json:1931:5 @@ -4875,7 +4875,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.resources-2016-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4926,7 +4926,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json:1682:5 @@ -5085,7 +5085,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeploymentExtendedFilter' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json:1683:5 @@ -5191,7 +5191,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.resources-2015-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5242,7 +5242,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PolicyAssignmentProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/resources.json:2128:5 @@ -5435,7 +5435,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PairedRegion' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json:273:5 @@ -5526,7 +5526,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PairedRegion' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/subscriptions.json:268:5 @@ -5617,7 +5617,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Location' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/subscriptions.json:263:5 @@ -5704,7 +5704,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Location' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json:253:5 @@ -5738,7 +5738,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ErrorResponse' (3 d - properties.error.description: "The error details." => "The error object." - title: => "Error response" warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ErrorResponse' -> 'ErrorResponseAutoGenerated' -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.resources-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5789,7 +5789,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Location' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json:253:5 @@ -5874,7 +5874,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Application' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json:1291:5 @@ -5979,7 +5979,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.solutions-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6030,7 +6030,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Application' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json:1004:5 @@ -6074,7 +6074,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.solutions-2017-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6125,7 +6125,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Application' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json:875:5 @@ -6166,7 +6166,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.solutions-2016-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6217,7 +6217,7 @@ warning | DeprecatedConfig | Using directive.45.suppress which is deprecated and warning | DeprecatedConfig | Using directive.46.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.47.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Appliance' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/resources/resource-manager/Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json:900:5 @@ -6260,5 +6260,5 @@ warning | Skipping path '/{applianceId}': Unable to locate "/providers/" segment warning | Skipping path '/{applianceDefinitionId}': Unable to locate "/providers/" segment warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms -info | Autorest completed in 168.44s. 94 files generated. +info | autorest.bicep took 4ms +info | Autorest completed in 159.4s. 94 files generated. diff --git a/generated/resources/microsoft.authorization/2016-09-01/types.md b/generated/resources/microsoft.authorization/2016-09-01/types.md index 2cb39cd227..2c8dcd1fff 100644 --- a/generated/resources/microsoft.authorization/2016-09-01/types.md +++ b/generated/resources/microsoft.authorization/2016-09-01/types.md @@ -9,13 +9,13 @@ * **properties**: [ManagementLockProperties](#managementlockproperties) (Required): The lock properties. * **type**: 'Microsoft.Authorization/locks' (ReadOnly, DeployTimeConstant): The resource type +## ManagementLockOwner +### Properties +* **applicationId**: string: The application ID of the lock owner. + ## ManagementLockProperties ### Properties * **level**: 'CanNotDelete' | 'NotSpecified' | 'ReadOnly' | string (Required): 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. * **notes**: string: Notes about the lock. Maximum of 512 characters. * **owners**: [ManagementLockOwner](#managementlockowner)[]: The owners of the lock. -## ManagementLockOwner -### Properties -* **applicationId**: string: The application ID of the lock owner. - diff --git a/generated/resources/microsoft.authorization/2017-04-01/types.md b/generated/resources/microsoft.authorization/2017-04-01/types.md index 2e710db6cd..fd69cb8869 100644 --- a/generated/resources/microsoft.authorization/2017-04-01/types.md +++ b/generated/resources/microsoft.authorization/2017-04-01/types.md @@ -9,13 +9,13 @@ * **properties**: [ManagementLockProperties](#managementlockproperties) (Required): The lock properties. * **type**: 'Microsoft.Authorization/locks' (ReadOnly, DeployTimeConstant): The resource type +## ManagementLockOwner +### Properties +* **applicationId**: string: The application ID of the lock owner. + ## ManagementLockProperties ### Properties * **level**: 'CanNotDelete' | 'NotSpecified' | 'ReadOnly' | string (Required): 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. * **notes**: string: Notes about the lock. Maximum of 512 characters. * **owners**: [ManagementLockOwner](#managementlockowner)[]: The owners of the lock. -## ManagementLockOwner -### Properties -* **applicationId**: string: The application ID of the lock owner. - diff --git a/generated/resources/microsoft.authorization/2017-06-01-preview/types.md b/generated/resources/microsoft.authorization/2017-06-01-preview/types.md index ffe0a47e03..170b9155f6 100644 --- a/generated/resources/microsoft.authorization/2017-06-01-preview/types.md +++ b/generated/resources/microsoft.authorization/2017-06-01-preview/types.md @@ -29,10 +29,10 @@ * **policyDefinitionId**: string: The ID of the policy definition. * **scope**: string: The scope for the policy assignment. -## PolicySku +## PolicyDefinitionReference ### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. +* **parameters**: any: Any object +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. ## PolicySetDefinitionProperties ### Properties @@ -43,8 +43,8 @@ * **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. -## PolicyDefinitionReference +## PolicySku ### Properties -* **parameters**: any: Any object -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2018-03-01/types.md b/generated/resources/microsoft.authorization/2018-03-01/types.md index fcb5b956ca..b91347a648 100644 --- a/generated/resources/microsoft.authorization/2018-03-01/types.md +++ b/generated/resources/microsoft.authorization/2018-03-01/types.md @@ -38,11 +38,6 @@ * **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. * **scope**: string: The scope for the policy assignment. -## PolicySku -### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. - ## PolicyDefinitionProperties ### Properties * **description**: string: The policy definition description. @@ -53,6 +48,11 @@ * **policyRule**: any: Any object * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. +## PolicyDefinitionReference +### Properties +* **parameters**: any: Any object +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. + ## PolicySetDefinitionProperties ### Properties * **description**: string: The policy set definition description. @@ -62,8 +62,8 @@ * **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. -## PolicyDefinitionReference +## PolicySku ### Properties -* **parameters**: any: Any object -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2018-05-01/types.md b/generated/resources/microsoft.authorization/2018-05-01/types.md index e23551ef48..58732fee23 100644 --- a/generated/resources/microsoft.authorization/2018-05-01/types.md +++ b/generated/resources/microsoft.authorization/2018-05-01/types.md @@ -46,11 +46,6 @@ * **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. * **scope**: string: The scope for the policy assignment. -## PolicySku -### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. - ## PolicyDefinitionProperties ### Properties * **description**: string: The policy definition description. @@ -61,6 +56,11 @@ * **policyRule**: any: Any object * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. +## PolicyDefinitionReference +### Properties +* **parameters**: any: Any object +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. + ## PolicySetDefinitionProperties ### Properties * **description**: string: The policy set definition description. @@ -70,8 +70,8 @@ * **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. -## PolicyDefinitionReference +## PolicySku ### Properties -* **parameters**: any: Any object -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2019-01-01/types.md b/generated/resources/microsoft.authorization/2019-01-01/types.md index c5bb368b76..aee193da74 100644 --- a/generated/resources/microsoft.authorization/2019-01-01/types.md +++ b/generated/resources/microsoft.authorization/2019-01-01/types.md @@ -46,11 +46,6 @@ * **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. * **scope**: string: The scope for the policy assignment. -## PolicySku -### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. - ## PolicyDefinitionProperties ### Properties * **description**: string: The policy definition description. @@ -61,6 +56,11 @@ * **policyRule**: any: Any object * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. +## PolicyDefinitionReference +### Properties +* **parameters**: any: Any object +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. + ## PolicySetDefinitionProperties ### Properties * **description**: string: The policy set definition description. @@ -70,8 +70,8 @@ * **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. -## PolicyDefinitionReference +## PolicySku ### Properties -* **parameters**: any: Any object -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2019-06-01/types.md b/generated/resources/microsoft.authorization/2019-06-01/types.md index 0ed6110f5b..10f3a5f533 100644 --- a/generated/resources/microsoft.authorization/2019-06-01/types.md +++ b/generated/resources/microsoft.authorization/2019-06-01/types.md @@ -47,11 +47,6 @@ * **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. * **scope**: string: The scope for the policy assignment. -## PolicySku -### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. - ## PolicyDefinitionProperties ### Properties * **description**: string: The policy definition description. @@ -62,6 +57,11 @@ * **policyRule**: any: Any object * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. +## PolicyDefinitionReference +### Properties +* **parameters**: any: Any object +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. + ## PolicySetDefinitionProperties ### Properties * **description**: string: The policy set definition description. @@ -71,8 +71,8 @@ * **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. * **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. -## PolicyDefinitionReference +## PolicySku ### Properties -* **parameters**: any: Any object -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition. +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2019-09-01/types.md b/generated/resources/microsoft.authorization/2019-09-01/types.md index 3fb212f99e..dddcf90abe 100644 --- a/generated/resources/microsoft.authorization/2019-09-01/types.md +++ b/generated/resources/microsoft.authorization/2019-09-01/types.md @@ -36,40 +36,10 @@ * **tenantId**: string (ReadOnly): The tenant ID of the resource identity. * **type**: 'None' | 'SystemAssigned': The identity type. This is the only required field when adding a system assigned identity to a resource. -## PolicyAssignmentProperties -### Properties -* **description**: string: This message will be part of response in case of policy violation. -* **displayName**: string: The display name of the policy assignment. -* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. -* **metadata**: any: Any object -* **notScopes**: string[]: The policy's excluded scopes. -* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. -* **scope**: string: The scope for the policy assignment. - -## ParameterValues +## ParameterDefinitions ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) - -## ParameterValuesValue -### Properties -* **value**: any: Any object - -## PolicySku -### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. - -## PolicyDefinitionProperties -### Properties -* **description**: string: The policy definition description. -* **displayName**: string: The display name of the policy definition. -* **metadata**: any: Any object -* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyRule**: any: Any object -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) ## ParameterDefinitions ### Properties @@ -90,20 +60,30 @@ ### Additional Properties * **Additional Properties Type**: any -## PolicySetDefinitionProperties +## ParameterValues ### Properties -* **description**: string: The policy set definition description. -* **displayName**: string: The display name of the policy set definition. -* **metadata**: any: Any object -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. -* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +### Additional Properties +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) -## ParameterDefinitions +## ParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) + +## ParameterValuesValue +### Properties +* **value**: any: Any object + +## PolicyAssignmentProperties +### Properties +* **description**: string: This message will be part of response in case of policy violation. +* **displayName**: string: The display name of the policy assignment. +* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. +* **metadata**: any: Any object +* **notScopes**: string[]: The policy's excluded scopes. +* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. +* **scope**: string: The scope for the policy assignment. ## PolicyDefinitionGroup ### Properties @@ -113,6 +93,16 @@ * **displayName**: string: The group's display name. * **name**: string (Required): The name of the group. +## PolicyDefinitionProperties +### Properties +* **description**: string: The policy definition description. +* **displayName**: string: The display name of the policy definition. +* **metadata**: any: Any object +* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyRule**: any: Any object +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + ## PolicyDefinitionReference ### Properties * **groupNames**: string[]: The name of the groups that this policy definition reference belongs to. @@ -120,8 +110,18 @@ * **policyDefinitionId**: string (Required): The ID of the policy definition or policy set definition. * **policyDefinitionReferenceId**: string: A unique id (within the policy set definition) for this policy definition reference. -## ParameterValues +## PolicySetDefinitionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) +* **description**: string: The policy set definition description. +* **displayName**: string: The display name of the policy set definition. +* **metadata**: any: Any object +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. +* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + +## PolicySku +### Properties +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2020-03-01/types.md b/generated/resources/microsoft.authorization/2020-03-01/types.md index 23afe35d10..261b229df0 100644 --- a/generated/resources/microsoft.authorization/2020-03-01/types.md +++ b/generated/resources/microsoft.authorization/2020-03-01/types.md @@ -36,40 +36,10 @@ * **tenantId**: string (ReadOnly): The tenant ID of the resource identity. * **type**: 'None' | 'SystemAssigned': The identity type. This is the only required field when adding a system assigned identity to a resource. -## PolicyAssignmentProperties -### Properties -* **description**: string: This message will be part of response in case of policy violation. -* **displayName**: string: The display name of the policy assignment. -* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. -* **metadata**: any: Any object -* **notScopes**: string[]: The policy's excluded scopes. -* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. -* **scope**: string: The scope for the policy assignment. - -## ParameterValues +## ParameterDefinitions ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) - -## ParameterValuesValue -### Properties -* **value**: any: Any object - -## PolicySku -### Properties -* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. -* **tier**: string: The policy sku tier. Possible values are Free and Standard. - -## PolicyDefinitionProperties -### Properties -* **description**: string: The policy definition description. -* **displayName**: string: The display name of the policy definition. -* **metadata**: any: Any object -* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyRule**: any: Any object -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) ## ParameterDefinitions ### Properties @@ -90,20 +60,30 @@ ### Additional Properties * **Additional Properties Type**: any -## PolicySetDefinitionProperties +## ParameterValues ### Properties -* **description**: string: The policy set definition description. -* **displayName**: string: The display name of the policy set definition. -* **metadata**: any: Any object -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. -* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +### Additional Properties +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) -## ParameterDefinitions +## ParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) + +## ParameterValuesValue +### Properties +* **value**: any: Any object + +## PolicyAssignmentProperties +### Properties +* **description**: string: This message will be part of response in case of policy violation. +* **displayName**: string: The display name of the policy assignment. +* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. +* **metadata**: any: Any object +* **notScopes**: string[]: The policy's excluded scopes. +* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. +* **scope**: string: The scope for the policy assignment. ## PolicyDefinitionGroup ### Properties @@ -113,6 +93,16 @@ * **displayName**: string: The group's display name. * **name**: string (Required): The name of the group. +## PolicyDefinitionProperties +### Properties +* **description**: string: The policy definition description. +* **displayName**: string: The display name of the policy definition. +* **metadata**: any: Any object +* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyRule**: any: Any object +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + ## PolicyDefinitionReference ### Properties * **groupNames**: string[]: The name of the groups that this policy definition reference belongs to. @@ -120,8 +110,18 @@ * **policyDefinitionId**: string (Required): The ID of the policy definition or policy set definition. * **policyDefinitionReferenceId**: string: A unique id (within the policy set definition) for this policy definition reference. -## ParameterValues +## PolicySetDefinitionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) +* **description**: string: The policy set definition description. +* **displayName**: string: The display name of the policy set definition. +* **metadata**: any: Any object +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. +* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + +## PolicySku +### Properties +* **name**: string (Required): The name of the policy sku. Possible values are A0 and A1. +* **tier**: string: The policy sku tier. Possible values are Free and Standard. diff --git a/generated/resources/microsoft.authorization/2020-05-01/types.md b/generated/resources/microsoft.authorization/2020-05-01/types.md index 5b25a213ce..73586aed3d 100644 --- a/generated/resources/microsoft.authorization/2020-05-01/types.md +++ b/generated/resources/microsoft.authorization/2020-05-01/types.md @@ -29,24 +29,15 @@ * **properties**: [ResourceManagementPrivateLinkEndpointConnections](#resourcemanagementprivatelinkendpointconnections) (ReadOnly) * **type**: 'Microsoft.Authorization/resourceManagementPrivateLinks' (ReadOnly, DeployTimeConstant): The resource type -## ManagementLockProperties -### Properties -* **level**: 'CanNotDelete' | 'NotSpecified' | 'ReadOnly' | string (Required): 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. -* **notes**: string: Notes about the lock. Maximum of 512 characters. -* **owners**: [ManagementLockOwner](#managementlockowner)[]: The owners of the lock. - ## ManagementLockOwner ### Properties * **applicationId**: string: The application ID of the lock owner. -## SystemData +## ManagementLockProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **level**: 'CanNotDelete' | 'NotSpecified' | 'ReadOnly' | string (Required): 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. +* **notes**: string: Notes about the lock. Maximum of 512 characters. +* **owners**: [ManagementLockOwner](#managementlockowner)[]: The owners of the lock. ## PrivateLinkAssociationProperties ### Properties @@ -59,3 +50,12 @@ ### Properties * **privateEndpointConnections**: string[] (ReadOnly): The private endpoint connections. +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/resources/microsoft.authorization/2020-09-01/types.md b/generated/resources/microsoft.authorization/2020-09-01/types.md index 4d945ba482..3dc0ff20dd 100644 --- a/generated/resources/microsoft.authorization/2020-09-01/types.md +++ b/generated/resources/microsoft.authorization/2020-09-01/types.md @@ -35,41 +35,15 @@ * **tenantId**: string (ReadOnly): The tenant ID of the resource identity. * **type**: 'None' | 'SystemAssigned': The identity type. This is the only required field when adding a system assigned identity to a resource. -## PolicyAssignmentProperties -### Properties -* **description**: string: This message will be part of response in case of policy violation. -* **displayName**: string: The display name of the policy assignment. -* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. -* **metadata**: any: Any object -* **nonComplianceMessages**: [NonComplianceMessage](#noncompliancemessage)[]: The messages that describe why a resource is non-compliant with the policy. -* **notScopes**: string[]: The policy's excluded scopes. -* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. -* **scope**: string (ReadOnly): The scope for the policy assignment. - ## NonComplianceMessage ### Properties * **message**: string (Required): 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. * **policyDefinitionReferenceId**: 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. -## ParameterValues +## ParameterDefinitions ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) - -## ParameterValuesValue -### Properties -* **value**: any: Any object - -## PolicyDefinitionProperties -### Properties -* **description**: string: The policy definition description. -* **displayName**: string: The display name of the policy definition. -* **metadata**: any: Any object -* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyRule**: any: Any object -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) ## ParameterDefinitions ### Properties @@ -92,20 +66,31 @@ ### Additional Properties * **Additional Properties Type**: any -## PolicySetDefinitionProperties +## ParameterValues ### Properties -* **description**: string: The policy set definition description. -* **displayName**: string: The display name of the policy set definition. -* **metadata**: any: Any object -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. -* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +### Additional Properties +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) -## ParameterDefinitions +## ParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) + +## ParameterValuesValue +### Properties +* **value**: any: Any object + +## PolicyAssignmentProperties +### Properties +* **description**: string: This message will be part of response in case of policy violation. +* **displayName**: string: The display name of the policy assignment. +* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. +* **metadata**: any: Any object +* **nonComplianceMessages**: [NonComplianceMessage](#noncompliancemessage)[]: The messages that describe why a resource is non-compliant with the policy. +* **notScopes**: string[]: The policy's excluded scopes. +* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. +* **scope**: string (ReadOnly): The scope for the policy assignment. ## PolicyDefinitionGroup ### Properties @@ -115,6 +100,16 @@ * **displayName**: string: The group's display name. * **name**: string (Required): The name of the group. +## PolicyDefinitionProperties +### Properties +* **description**: string: The policy definition description. +* **displayName**: string: The display name of the policy definition. +* **metadata**: any: Any object +* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyRule**: any: Any object +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + ## PolicyDefinitionReference ### Properties * **groupNames**: string[]: The name of the groups that this policy definition reference belongs to. @@ -122,8 +117,13 @@ * **policyDefinitionId**: string (Required): The ID of the policy definition or policy set definition. * **policyDefinitionReferenceId**: string: A unique id (within the policy set definition) for this policy definition reference. -## ParameterValues +## PolicySetDefinitionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) +* **description**: string: The policy set definition description. +* **displayName**: string: The display name of the policy set definition. +* **metadata**: any: Any object +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. +* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. diff --git a/generated/resources/microsoft.authorization/2021-06-01/types.md b/generated/resources/microsoft.authorization/2021-06-01/types.md index c529edb66a..15e04849e1 100644 --- a/generated/resources/microsoft.authorization/2021-06-01/types.md +++ b/generated/resources/microsoft.authorization/2021-06-01/types.md @@ -44,55 +44,15 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## UserAssignedIdentitiesValue -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## PolicyAssignmentProperties -### Properties -* **description**: string: This message will be part of response in case of policy violation. -* **displayName**: string: The display name of the policy assignment. -* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. -* **metadata**: any: Any object -* **nonComplianceMessages**: [NonComplianceMessage](#noncompliancemessage)[]: The messages that describe why a resource is non-compliant with the policy. -* **notScopes**: string[]: The policy's excluded scopes. -* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. -* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. -* **scope**: string (ReadOnly): The scope for the policy assignment. - ## NonComplianceMessage ### Properties * **message**: string (Required): 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. * **policyDefinitionReferenceId**: 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. -## ParameterValues +## ParameterDefinitions ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) - -## ParameterValuesValue -### Properties -* **value**: any: Any object - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## PolicyDefinitionProperties -### Properties -* **description**: string: The policy definition description. -* **displayName**: string: The display name of the policy definition. -* **metadata**: any: Any object -* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyRule**: any: Any object -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) ## ParameterDefinitions ### Properties @@ -115,20 +75,31 @@ ### Additional Properties * **Additional Properties Type**: any -## PolicySetDefinitionProperties +## ParameterValues ### Properties -* **description**: string: The policy set definition description. -* **displayName**: string: The display name of the policy set definition. -* **metadata**: any: Any object -* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. -* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. -* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. -* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. +### Additional Properties +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) -## ParameterDefinitions +## ParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterDefinitionsValue](#parameterdefinitionsvalue) +* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) + +## ParameterValuesValue +### Properties +* **value**: any: Any object + +## PolicyAssignmentProperties +### Properties +* **description**: string: This message will be part of response in case of policy violation. +* **displayName**: string: The display name of the policy assignment. +* **enforcementMode**: 'Default' | 'DoNotEnforce' | string: The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. +* **metadata**: any: Any object +* **nonComplianceMessages**: [NonComplianceMessage](#noncompliancemessage)[]: The messages that describe why a resource is non-compliant with the policy. +* **notScopes**: string[]: The policy's excluded scopes. +* **parameters**: [ParameterValues](#parametervalues): The parameter values for the policy rule. The keys are the parameter names. +* **policyDefinitionId**: string: The ID of the policy definition or policy set definition being assigned. +* **scope**: string (ReadOnly): The scope for the policy assignment. ## PolicyDefinitionGroup ### Properties @@ -138,6 +109,16 @@ * **displayName**: string: The group's display name. * **name**: string (Required): The name of the group. +## PolicyDefinitionProperties +### Properties +* **description**: string: The policy definition description. +* **displayName**: string: The display name of the policy definition. +* **metadata**: any: Any object +* **mode**: string: The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyRule**: any: Any object +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + ## PolicyDefinitionReference ### Properties * **groupNames**: string[]: The name of the groups that this policy definition reference belongs to. @@ -145,8 +126,27 @@ * **policyDefinitionId**: string (Required): The ID of the policy definition or policy set definition. * **policyDefinitionReferenceId**: string: A unique id (within the policy set definition) for this policy definition reference. -## ParameterValues +## PolicySetDefinitionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ParameterValuesValue](#parametervaluesvalue) +* **description**: string: The policy set definition description. +* **displayName**: string: The display name of the policy set definition. +* **metadata**: any: Any object +* **parameters**: [ParameterDefinitions](#parameterdefinitions): The parameter definitions for parameters used in the policy. The keys are the parameter names. +* **policyDefinitionGroups**: [PolicyDefinitionGroup](#policydefinitiongroup)[]: The metadata describing groups of policy definition references within the policy set definition. +* **policyDefinitions**: [PolicyDefinitionReference](#policydefinitionreference)[] (Required): An array of policy definition references. +* **policyType**: 'BuiltIn' | 'Custom' | 'NotSpecified' | 'Static' | string: The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserAssignedIdentitiesValue +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. diff --git a/generated/resources/microsoft.features/2021-07-01/types.md b/generated/resources/microsoft.features/2021-07-01/types.md index 8b5bbc3300..986747020b 100644 --- a/generated/resources/microsoft.features/2021-07-01/types.md +++ b/generated/resources/microsoft.features/2021-07-01/types.md @@ -9,6 +9,14 @@ * **properties**: [SubscriptionFeatureRegistrationProperties](#subscriptionfeatureregistrationproperties) * **type**: 'Microsoft.Features/featureProviders/subscriptionFeatureRegistrations' (ReadOnly, DeployTimeConstant): The resource type +## AuthorizationProfile +### Properties +* **approvedTime**: string (ReadOnly): The approved time +* **approver**: string (ReadOnly): The approver +* **requestedTime**: string (ReadOnly): The requested time +* **requester**: string (ReadOnly): The requester +* **requesterObjectId**: string (ReadOnly): The requester object id + ## SubscriptionFeatureRegistrationProperties ### Properties * **approvalType**: 'ApprovalRequired' | 'AutoApproval' | 'NotSpecified' | string (ReadOnly): The feature approval type. @@ -26,14 +34,6 @@ * **subscriptionId**: string (ReadOnly): The subscriptionId. * **tenantId**: string (ReadOnly): The tenantId. -## AuthorizationProfile -### Properties -* **approvedTime**: string (ReadOnly): The approved time -* **approver**: string (ReadOnly): The approver -* **requestedTime**: string (ReadOnly): The requested time -* **requester**: string (ReadOnly): The requester -* **requesterObjectId**: string (ReadOnly): The requester object id - ## SubscriptionFeatureRegistrationPropertiesMetadata ### Properties ### Additional Properties diff --git a/generated/resources/microsoft.resources/2015-11-01/types.md b/generated/resources/microsoft.resources/2015-11-01/types.md index f39cbf1b2b..fd33ae36f6 100644 --- a/generated/resources/microsoft.resources/2015-11-01/types.md +++ b/generated/resources/microsoft.resources/2015-11-01/types.md @@ -20,6 +20,19 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): Gets or sets the tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## BasicDependency +### Properties +* **id**: string (ReadOnly): Gets or sets the ID of the dependency. +* **resourceName**: string (ReadOnly): Gets or sets the dependency resource name. +* **resourceType**: string (ReadOnly): Gets or sets the dependency resource type. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): Gets the list of dependencies. +* **id**: string (ReadOnly): Gets or sets the ID of the dependency. +* **resourceName**: string (ReadOnly): Gets or sets the dependency resource name. +* **resourceType**: string (ReadOnly): Gets or sets the dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): Gets or sets the correlation ID of the deployment. @@ -35,18 +48,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): Gets or sets the timestamp of the template deployment. -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): Gets the list of dependencies. -* **id**: string (ReadOnly): Gets or sets the ID of the dependency. -* **resourceName**: string (ReadOnly): Gets or sets the dependency resource name. -* **resourceType**: string (ReadOnly): Gets or sets the dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): Gets or sets the ID of the dependency. -* **resourceName**: string (ReadOnly): Gets or sets the dependency resource name. -* **resourceType**: string (ReadOnly): Gets or sets the dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -56,11 +61,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ParametersLink ### Properties * **contentVersion**: string: If included it must match the ContentVersion in the template. @@ -85,11 +85,6 @@ ### Additional Properties * **Additional Properties Type**: string -## TemplateLink -### Properties -* **contentVersion**: string: If included it must match the ContentVersion in the template. -* **uri**: string (Required): URI referencing the template. - ## ResourceGroupProperties ### Properties * **provisioningState**: string (ReadOnly): Gets resource group provisioning state. @@ -99,3 +94,8 @@ ### Additional Properties * **Additional Properties Type**: string +## TemplateLink +### Properties +* **contentVersion**: string: If included it must match the ContentVersion in the template. +* **uri**: string (Required): URI referencing the template. + diff --git a/generated/resources/microsoft.resources/2016-02-01/types.md b/generated/resources/microsoft.resources/2016-02-01/types.md index a3c8c3340a..cdda399fc6 100644 --- a/generated/resources/microsoft.resources/2016-02-01/types.md +++ b/generated/resources/microsoft.resources/2016-02-01/types.md @@ -20,6 +20,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The api versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: The debug detail level. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -36,22 +63,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: The debug detail level. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -61,11 +76,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ParametersLink ### Properties * **contentVersion**: string: If included it must match the ContentVersion in the template. @@ -86,26 +96,11 @@ * **properties**: [ProviderResourceTypeProperties](#providerresourcetypeproperties) (ReadOnly): The properties. * **resourceType**: string (ReadOnly): The resource type. -## AliasType -### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. - -## AliasPathType -### Properties -* **apiVersions**: string[] (ReadOnly): The api versions. -* **path**: string (ReadOnly): The path of an alias. - ## ProviderResourceTypeProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## TemplateLink -### Properties -* **contentVersion**: string: If included it must match the ContentVersion in the template. -* **uri**: string (Required): URI referencing the template. - ## ResourceGroupProperties ### Properties * **provisioningState**: string (ReadOnly): The provisioning state. @@ -115,3 +110,8 @@ ### Additional Properties * **Additional Properties Type**: string +## TemplateLink +### Properties +* **contentVersion**: string: If included it must match the ContentVersion in the template. +* **uri**: string (Required): URI referencing the template. + diff --git a/generated/resources/microsoft.resources/2016-07-01/types.md b/generated/resources/microsoft.resources/2016-07-01/types.md index d8291a9c2d..e696c6fbbb 100644 --- a/generated/resources/microsoft.resources/2016-07-01/types.md +++ b/generated/resources/microsoft.resources/2016-07-01/types.md @@ -20,6 +20,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The api versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: The debug detail level. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -36,22 +63,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: The debug detail level. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -61,11 +76,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ParametersLink ### Properties * **contentVersion**: string: If included it must match the ContentVersion in the template. @@ -87,37 +97,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The api versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included it must match the ContentVersion in the template. * **uri**: string (Required): URI referencing the template. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2016-09-01/types.md b/generated/resources/microsoft.resources/2016-09-01/types.md index 36e3bad4ba..213a6b3c4d 100644 --- a/generated/resources/microsoft.resources/2016-09-01/types.md +++ b/generated/resources/microsoft.resources/2016-09-01/types.md @@ -21,6 +21,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -37,22 +64,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -62,11 +77,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -88,37 +98,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2017-05-10/types.md b/generated/resources/microsoft.resources/2017-05-10/types.md index 5f3c7e773d..bbc13801a9 100644 --- a/generated/resources/microsoft.resources/2017-05-10/types.md +++ b/generated/resources/microsoft.resources/2017-05-10/types.md @@ -21,6 +21,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -37,22 +64,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -62,11 +77,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -88,37 +98,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2018-02-01/types.md b/generated/resources/microsoft.resources/2018-02-01/types.md index 23853e9208..7e574f0569 100644 --- a/generated/resources/microsoft.resources/2018-02-01/types.md +++ b/generated/resources/microsoft.resources/2018-02-01/types.md @@ -21,6 +21,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -38,22 +65,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -63,11 +78,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -95,37 +105,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2018-05-01/types.md b/generated/resources/microsoft.resources/2018-05-01/types.md index ab62bb59f2..46ea163057 100644 --- a/generated/resources/microsoft.resources/2018-05-01/types.md +++ b/generated/resources/microsoft.resources/2018-05-01/types.md @@ -22,6 +22,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -39,22 +66,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -64,11 +79,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -96,37 +106,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2019-03-01/types.md b/generated/resources/microsoft.resources/2019-03-01/types.md index 7f54824668..e78713347e 100644 --- a/generated/resources/microsoft.resources/2019-03-01/types.md +++ b/generated/resources/microsoft.resources/2019-03-01/types.md @@ -22,6 +22,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -39,22 +66,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -64,11 +79,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -98,37 +108,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2019-05-01/types.md b/generated/resources/microsoft.resources/2019-05-01/types.md index f0577cc961..d8e3df740f 100644 --- a/generated/resources/microsoft.resources/2019-05-01/types.md +++ b/generated/resources/microsoft.resources/2019-05-01/types.md @@ -22,6 +22,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -40,22 +67,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -65,11 +80,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -99,37 +109,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2019-05-10/types.md b/generated/resources/microsoft.resources/2019-05-10/types.md index d69fe515d4..ab3c47fe0d 100644 --- a/generated/resources/microsoft.resources/2019-05-10/types.md +++ b/generated/resources/microsoft.resources/2019-05-10/types.md @@ -22,6 +22,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -40,22 +67,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -65,11 +80,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -99,37 +109,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2019-06-01-preview/types.md b/generated/resources/microsoft.resources/2019-06-01-preview/types.md index 6db5dd2fae..4aa30b57a8 100644 --- a/generated/resources/microsoft.resources/2019-06-01-preview/types.md +++ b/generated/resources/microsoft.resources/2019-06-01-preview/types.md @@ -24,6 +24,26 @@ * **tags**: [TemplateSpecVersionTags](#templatespecversiontags): Resource tags. * **type**: 'Microsoft.Resources/templateSpecs/versions' (ReadOnly, DeployTimeConstant): The resource type +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TemplateSpecArtifact +* **Discriminator**: kind + +### Base Properties +* **path**: string (Required): A filesystem safe relative path of the artifact. +### TemplateSpecTemplateArtifact +#### Properties +* **kind**: 'template' (Required): The kind of artifact. +* **template**: any (Required): Any object + + ## TemplateSpecProperties ### Properties * **description**: string: Template Spec description. @@ -35,43 +55,23 @@ ### Additional Properties * **Additional Properties Type**: [TemplateSpecVersionInfo](#templatespecversioninfo) +## TemplateSpecTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TemplateSpecVersionInfo ### Properties * **description**: string (ReadOnly): Template Spec version description. * **timeCreated**: string (ReadOnly): The timestamp of when the version was created. * **timeModified**: string (ReadOnly): The timestamp of when the version was last modified. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TemplateSpecTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TemplateSpecVersionProperties ### Properties * **artifacts**: [TemplateSpecArtifact](#templatespecartifact)[]: An array of Template Spec artifacts. * **description**: string: Template Spec version description. * **template**: any: Any object -## TemplateSpecArtifact -* **Discriminator**: kind - -### Base Properties -* **path**: string (Required): A filesystem safe relative path of the artifact. -### TemplateSpecTemplateArtifact -#### Properties -* **kind**: 'template' (Required): The kind of artifact. -* **template**: any (Required): Any object - - ## TemplateSpecVersionTags ### Properties ### Additional Properties diff --git a/generated/resources/microsoft.resources/2019-07-01/types.md b/generated/resources/microsoft.resources/2019-07-01/types.md index 2610f49415..cee2e9be1d 100644 --- a/generated/resources/microsoft.resources/2019-07-01/types.md +++ b/generated/resources/microsoft.resources/2019-07-01/types.md @@ -22,6 +22,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -40,22 +67,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -65,11 +80,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -99,37 +109,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2019-08-01/types.md b/generated/resources/microsoft.resources/2019-08-01/types.md index 57579b5733..fc23344250 100644 --- a/generated/resources/microsoft.resources/2019-08-01/types.md +++ b/generated/resources/microsoft.resources/2019-08-01/types.md @@ -22,6 +22,33 @@ * **tags**: [ResourceGroupTags](#resourcegrouptags): The tags attached to the resource group. * **type**: 'Microsoft.Resources/resourceGroups' (ReadOnly, DeployTimeConstant): The resource type +## AliasPathType +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. + +## AliasType +### Properties +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -40,22 +67,10 @@ * **templateLink**: [TemplateLink](#templatelink): Entity representing the reference to the template. * **timestamp**: string (ReadOnly): The timestamp of the template deployment. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency -### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. - -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -65,11 +80,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. @@ -99,37 +109,27 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## AliasType +## ProviderResourceTypeProperties ### Properties -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPathType](#aliaspathtype)[] (ReadOnly): The paths for an alias. +### Additional Properties +* **Additional Properties Type**: string -## AliasPathType +## ResourceGroupProperties ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. +* **provisioningState**: string (ReadOnly): The provisioning state. -## ProviderResourceTypeProperties +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. * **uri**: string (Required): The URI of the template to deploy. -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2019-10-01-preview/types.md b/generated/resources/microsoft.resources/2019-10-01-preview/types.md index 504671d434..bb55ea08f2 100644 --- a/generated/resources/microsoft.resources/2019-10-01-preview/types.md +++ b/generated/resources/microsoft.resources/2019-10-01-preview/types.md @@ -24,36 +24,6 @@ * **properties**: [AzurePowerShellScriptProperties](#azurepowershellscriptproperties) (Required): Properties of the Azure PowerShell script object. -## ManagedServiceIdentity -### Properties -* **tenantId**: string (ReadOnly): ID of the Azure Active Directory. -* **type**: 'UserAssigned' | string: Type of the managed identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): Client App Id associated with this identity. -* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this identity. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## DeploymentScriptTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AzureCliScriptProperties ### Properties * **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' @@ -72,29 +42,53 @@ * **supportingScriptUris**: string[]: Supporting files for the external script. * **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D +## AzurePowerShellScriptProperties +### Properties +* **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' +* **azPowerShellVersion**: string (Required): Azure PowerShell module version to be used. +* **cleanupPreference**: 'Always' | 'OnExpiration' | 'OnSuccess' | string: The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. +* **containerSettings**: [ContainerConfiguration](#containerconfiguration): Settings to customize ACI container instance. +* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to pass over to the script. +* **forceUpdateTag**: string: Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. +* **outputs**: [DeploymentScriptPropertiesBaseOutputs](#deploymentscriptpropertiesbaseoutputs) (ReadOnly): List of script outputs. +* **primaryScriptUri**: string: Uri for the script. This is the entry point for the external script. +* **provisioningState**: 'Canceled' | 'Creating' | 'Failed' | 'ProvisioningResources' | 'Running' | 'Succeeded' | string (ReadOnly): State of the script execution. This only appears in the response. +* **retentionInterval**: string (Required): Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day). +* **scriptContent**: string: Script body. +* **status**: [ScriptStatus](#scriptstatus) (ReadOnly): Generic object modeling results of script execution. +* **storageAccountSettings**: [StorageAccountConfiguration](#storageaccountconfiguration): Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage +* **supportingScriptUris**: string[]: Supporting files for the external script. +* **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D + ## ContainerConfiguration ### Properties * **containerGroupName**: string: Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property. -## EnvironmentVariable +## DeploymentScriptPropertiesBaseOutputs ### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. +### Additional Properties +* **Additional Properties Type**: any ## DeploymentScriptPropertiesBaseOutputs ### Properties ### Additional Properties * **Additional Properties Type**: any -## ScriptStatus +## DeploymentScriptTags ### Properties -* **containerInstanceId**: string (ReadOnly): ACI resource Id. -* **endTime**: string (ReadOnly): End time of the script execution. -* **error**: [ErrorResponse](#errorresponse): Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) -* **expirationTime**: string (ReadOnly): Time the deployment script resource will expire. -* **startTime**: string (ReadOnly): Start time of the script execution. -* **storageAccountId**: string (ReadOnly): Storage account resource Id. +### Additional Properties +* **Additional Properties Type**: string + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -104,36 +98,42 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo +## ManagedServiceIdentity ### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. +* **tenantId**: string (ReadOnly): ID of the Azure Active Directory. +* **type**: 'UserAssigned' | string: Type of the managed identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. + +## ManagedServiceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## ScriptStatus +### Properties +* **containerInstanceId**: string (ReadOnly): ACI resource Id. +* **endTime**: string (ReadOnly): End time of the script execution. +* **error**: [ErrorResponse](#errorresponse): Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) +* **expirationTime**: string (ReadOnly): Time the deployment script resource will expire. +* **startTime**: string (ReadOnly): Start time of the script execution. +* **storageAccountId**: string (ReadOnly): Storage account resource Id. ## StorageAccountConfiguration ### Properties * **storageAccountKey**: string: The storage account access key. * **storageAccountName**: string: The storage account name. -## AzurePowerShellScriptProperties +## SystemData ### Properties -* **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' -* **azPowerShellVersion**: string (Required): Azure PowerShell module version to be used. -* **cleanupPreference**: 'Always' | 'OnExpiration' | 'OnSuccess' | string: The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. -* **containerSettings**: [ContainerConfiguration](#containerconfiguration): Settings to customize ACI container instance. -* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to pass over to the script. -* **forceUpdateTag**: string: Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. -* **outputs**: [DeploymentScriptPropertiesBaseOutputs](#deploymentscriptpropertiesbaseoutputs) (ReadOnly): List of script outputs. -* **primaryScriptUri**: string: Uri for the script. This is the entry point for the external script. -* **provisioningState**: 'Canceled' | 'Creating' | 'Failed' | 'ProvisioningResources' | 'Running' | 'Succeeded' | string (ReadOnly): State of the script execution. This only appears in the response. -* **retentionInterval**: string (Required): Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day). -* **scriptContent**: string: Script body. -* **status**: [ScriptStatus](#scriptstatus) (ReadOnly): Generic object modeling results of script execution. -* **storageAccountSettings**: [StorageAccountConfiguration](#storageaccountconfiguration): Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage -* **supportingScriptUris**: string[]: Supporting files for the external script. -* **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## DeploymentScriptPropertiesBaseOutputs +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **clientId**: string (ReadOnly): Client App Id associated with this identity. +* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this identity. diff --git a/generated/resources/microsoft.resources/2019-10-01/types.md b/generated/resources/microsoft.resources/2019-10-01/types.md index c6d63590b2..6e17f75666 100644 --- a/generated/resources/microsoft.resources/2019-10-01/types.md +++ b/generated/resources/microsoft.resources/2019-10-01/types.md @@ -32,6 +32,43 @@ * **properties**: [Tags](#tags) (Required): A dictionary of name and value pairs. * **type**: 'Microsoft.Resources/tags' (ReadOnly, DeployTimeConstant): The resource type +## Alias +### Properties +* **defaultPath**: string (ReadOnly): The default path for an alias. +* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. +* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. + +## AliasPath +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **path**: string (ReadOnly): The path of an alias. +* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. + +## AliasPattern +### Properties +* **phrase**: string (ReadOnly): The alias pattern phrase. +* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern +* **variable**: string (ReadOnly): The alias pattern variable. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -53,22 +90,15 @@ * **timestamp**: string (ReadOnly): The timestamp of the template deployment. * **validatedResources**: [ResourceReference](#resourcereference)[] (ReadOnly): Array of validated resources. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency +## DeploymentTags ### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: string -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -78,21 +108,12 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. * **provisioningState**: string (ReadOnly): The state of the provisioning for the on error deployment. * **type**: 'LastSuccessful' | 'SpecificDeployment': The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. -## ResourceReference -### Properties -* **id**: string (ReadOnly): The fully qualified resource Id. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -116,46 +137,11 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## Alias -### Properties -* **defaultPath**: string (ReadOnly): The default path for an alias. -* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. -* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. - -## AliasPattern -### Properties -* **phrase**: string (ReadOnly): The alias pattern phrase. -* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern -* **variable**: string (ReadOnly): The alias pattern variable. - -## AliasPath -### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **path**: string (ReadOnly): The path of an alias. -* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. - ## ProviderResourceTypeProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - -## TemplateLink -### Properties -* **contentVersion**: string: If included, must match the ContentVersion in the template. -* **uri**: string (Required): The URI of the template to deploy. - -## DeploymentTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ResourceGroupProperties ### Properties * **provisioningState**: string (ReadOnly): The provisioning state. @@ -165,6 +151,10 @@ ### Additional Properties * **Additional Properties Type**: string +## ResourceReference +### Properties +* **id**: string (ReadOnly): The fully qualified resource Id. + ## Tags ### Properties * **tags**: [Tags](#tags): Dictionary of @@ -174,3 +164,13 @@ ### Additional Properties * **Additional Properties Type**: string +## TemplateLink +### Properties +* **contentVersion**: string: If included, must match the ContentVersion in the template. +* **uri**: string (Required): The URI of the template to deploy. + +## ZoneMapping +### Properties +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem + diff --git a/generated/resources/microsoft.resources/2020-06-01/types.md b/generated/resources/microsoft.resources/2020-06-01/types.md index 43d9df91ca..5739f7ebaa 100644 --- a/generated/resources/microsoft.resources/2020-06-01/types.md +++ b/generated/resources/microsoft.resources/2020-06-01/types.md @@ -32,6 +32,55 @@ * **properties**: [Tags](#tags) (Required): A dictionary of name and value pairs. * **type**: 'Microsoft.Resources/tags' (ReadOnly, DeployTimeConstant): The resource type +## Alias +### Properties +* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **defaultPath**: string (ReadOnly): The default path for an alias. +* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. +* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. + +## AliasPath +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **path**: string (ReadOnly): The path of an alias. +* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. + +## AliasPathMetadata +### Properties +* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. +* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. + +## AliasPattern +### Properties +* **phrase**: string (ReadOnly): The alias pattern phrase. +* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern +* **variable**: string (ReadOnly): The alias pattern variable. + +## ApiProfile +### Properties +* **apiVersion**: string (ReadOnly): The API version. +* **profileVersion**: string (ReadOnly): The profile version. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -54,22 +103,15 @@ * **timestamp**: string (ReadOnly): The timestamp of the template deployment. * **validatedResources**: [ResourceReference](#resourcereference)[] (ReadOnly): Array of validated resources. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency +## DeploymentTags ### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: string -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -79,11 +121,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ExpressionEvaluationOptions ### Properties * **scope**: 'Inner' | 'NotSpecified' | 'Outer' | string (WriteOnly): The scope to be used for evaluation of parameters, variables and functions in a nested template. @@ -94,10 +131,6 @@ * **provisioningState**: string (ReadOnly): The state of the provisioning for the on error deployment. * **type**: 'LastSuccessful' | 'SpecificDeployment': The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. -## ResourceReference -### Properties -* **id**: string (ReadOnly): The fully qualified resource Id. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -123,60 +156,11 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## Alias -### Properties -* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **defaultPath**: string (ReadOnly): The default path for an alias. -* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. -* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. - -## AliasPathMetadata -### Properties -* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. -* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. - -## AliasPattern -### Properties -* **phrase**: string (ReadOnly): The alias pattern phrase. -* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern -* **variable**: string (ReadOnly): The alias pattern variable. - -## AliasPath -### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **path**: string (ReadOnly): The path of an alias. -* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. - -## ApiProfile -### Properties -* **apiVersion**: string (ReadOnly): The API version. -* **profileVersion**: string (ReadOnly): The profile version. - ## ProviderResourceTypeProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - -## TemplateLink -### Properties -* **contentVersion**: string: If included, must match the ContentVersion in the template. -* **id**: string: The resource id of a Template Spec. Use either the id or uri property, but not both. -* **relativePath**: string: Applicable only if this template link references a Template Spec. This relativePath property can optionally be used to reference a Template Spec artifact by path. -* **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. - -## DeploymentTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ResourceGroupProperties ### Properties * **provisioningState**: string (ReadOnly): The provisioning state. @@ -186,6 +170,10 @@ ### Additional Properties * **Additional Properties Type**: string +## ResourceReference +### Properties +* **id**: string (ReadOnly): The fully qualified resource Id. + ## Tags ### Properties * **tags**: [Tags](#tags): Dictionary of @@ -195,3 +183,15 @@ ### Additional Properties * **Additional Properties Type**: string +## TemplateLink +### Properties +* **contentVersion**: string: If included, must match the ContentVersion in the template. +* **id**: string: The resource id of a Template Spec. Use either the id or uri property, but not both. +* **relativePath**: string: Applicable only if this template link references a Template Spec. This relativePath property can optionally be used to reference a Template Spec artifact by path. +* **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. + +## ZoneMapping +### Properties +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem + diff --git a/generated/resources/microsoft.resources/2020-08-01/types.md b/generated/resources/microsoft.resources/2020-08-01/types.md index f350ccd8c1..f557f46f27 100644 --- a/generated/resources/microsoft.resources/2020-08-01/types.md +++ b/generated/resources/microsoft.resources/2020-08-01/types.md @@ -32,6 +32,55 @@ * **properties**: [Tags](#tags) (Required): A dictionary of name and value pairs. * **type**: 'Microsoft.Resources/tags' (ReadOnly, DeployTimeConstant): The resource type +## Alias +### Properties +* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **defaultPath**: string (ReadOnly): The default path for an alias. +* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. +* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. + +## AliasPath +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **path**: string (ReadOnly): The path of an alias. +* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. + +## AliasPathMetadata +### Properties +* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. +* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. + +## AliasPattern +### Properties +* **phrase**: string (ReadOnly): The alias pattern phrase. +* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern +* **variable**: string (ReadOnly): The alias pattern variable. + +## ApiProfile +### Properties +* **apiVersion**: string (ReadOnly): The API version. +* **profileVersion**: string (ReadOnly): The profile version. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -53,22 +102,15 @@ * **timestamp**: string (ReadOnly): The timestamp of the template deployment. * **validatedResources**: [ResourceReference](#resourcereference)[] (ReadOnly): Array of validated resources. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency +## DeploymentTags ### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: string -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -78,21 +120,12 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. * **provisioningState**: string (ReadOnly): The state of the provisioning for the on error deployment. * **type**: 'LastSuccessful' | 'SpecificDeployment': The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. -## ResourceReference -### Properties -* **id**: string (ReadOnly): The fully qualified resource Id. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -106,6 +139,12 @@ * **registrationState**: string (ReadOnly): The registration state of the resource provider. * **resourceTypes**: [ProviderResourceType](#providerresourcetype)[] (ReadOnly): The collection of provider resource types. +## ProviderExtendedLocation +### Properties +* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. +* **location**: string (ReadOnly): The azure location. +* **type**: string (ReadOnly): The extended location type. + ## ProviderResourceType ### Properties * **aliases**: [Alias](#alias)[] (ReadOnly): The aliases that are supported by this resource type. @@ -119,66 +158,11 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## Alias -### Properties -* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **defaultPath**: string (ReadOnly): The default path for an alias. -* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. -* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. - -## AliasPathMetadata -### Properties -* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. -* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. - -## AliasPattern -### Properties -* **phrase**: string (ReadOnly): The alias pattern phrase. -* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern -* **variable**: string (ReadOnly): The alias pattern variable. - -## AliasPath -### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **path**: string (ReadOnly): The path of an alias. -* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. - -## ApiProfile -### Properties -* **apiVersion**: string (ReadOnly): The API version. -* **profileVersion**: string (ReadOnly): The profile version. - -## ProviderExtendedLocation -### Properties -* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. -* **location**: string (ReadOnly): The azure location. -* **type**: string (ReadOnly): The extended location type. - ## ProviderResourceTypeProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - -## TemplateLink -### Properties -* **contentVersion**: string: If included, must match the ContentVersion in the template. -* **id**: string: The resource id of a Template Spec. Use either the id or uri property, but not both. -* **relativePath**: string: Applicable only if this template link references a Template Spec. This relativePath property can optionally be used to reference a Template Spec artifact by path. -* **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. - -## DeploymentTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ResourceGroupProperties ### Properties * **provisioningState**: string (ReadOnly): The provisioning state. @@ -188,6 +172,10 @@ ### Additional Properties * **Additional Properties Type**: string +## ResourceReference +### Properties +* **id**: string (ReadOnly): The fully qualified resource Id. + ## Tags ### Properties * **tags**: [Tags](#tags): Dictionary of @@ -197,3 +185,15 @@ ### Additional Properties * **Additional Properties Type**: string +## TemplateLink +### Properties +* **contentVersion**: string: If included, must match the ContentVersion in the template. +* **id**: string: The resource id of a Template Spec. Use either the id or uri property, but not both. +* **relativePath**: string: Applicable only if this template link references a Template Spec. This relativePath property can optionally be used to reference a Template Spec artifact by path. +* **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. + +## ZoneMapping +### Properties +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem + diff --git a/generated/resources/microsoft.resources/2020-10-01/types.md b/generated/resources/microsoft.resources/2020-10-01/types.md index 4d385d9681..016b09f411 100644 --- a/generated/resources/microsoft.resources/2020-10-01/types.md +++ b/generated/resources/microsoft.resources/2020-10-01/types.md @@ -56,6 +56,95 @@ * **properties**: [Tags](#tags) (Required): A dictionary of name and value pairs. * **type**: 'Microsoft.Resources/tags' (ReadOnly, DeployTimeConstant): The resource type +## Alias +### Properties +* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **defaultPath**: string (ReadOnly): The default path for an alias. +* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. +* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. + +## AliasPath +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **path**: string (ReadOnly): The path of an alias. +* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. + +## AliasPathMetadata +### Properties +* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. +* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. + +## AliasPattern +### Properties +* **phrase**: string (ReadOnly): The alias pattern phrase. +* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern +* **variable**: string (ReadOnly): The alias pattern variable. + +## ApiProfile +### Properties +* **apiVersion**: string (ReadOnly): The API version. +* **profileVersion**: string (ReadOnly): The profile version. + +## AzureCliScriptProperties +### Properties +* **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' +* **azCliVersion**: string (Required): Azure CLI module version to be used. +* **cleanupPreference**: 'Always' | 'OnExpiration' | 'OnSuccess' | string: The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. +* **containerSettings**: [ContainerConfiguration](#containerconfiguration): Settings to customize ACI container instance. +* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to pass over to the script. +* **forceUpdateTag**: string: Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. +* **outputs**: [DeploymentScriptPropertiesBaseOutputs](#deploymentscriptpropertiesbaseoutputs) (ReadOnly): List of script outputs. +* **primaryScriptUri**: string: Uri for the script. This is the entry point for the external script. +* **provisioningState**: 'Canceled' | 'Creating' | 'Failed' | 'ProvisioningResources' | 'Running' | 'Succeeded' | string (ReadOnly): State of the script execution. This only appears in the response. +* **retentionInterval**: string (Required): Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day). +* **scriptContent**: string: Script body. +* **status**: [ScriptStatus](#scriptstatus) (ReadOnly): Generic object modeling results of script execution. +* **storageAccountSettings**: [StorageAccountConfiguration](#storageaccountconfiguration): Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage +* **supportingScriptUris**: string[]: Supporting files for the external script. +* **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D + +## AzurePowerShellScriptProperties +### Properties +* **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' +* **azPowerShellVersion**: string (Required): Azure PowerShell module version to be used. +* **cleanupPreference**: 'Always' | 'OnExpiration' | 'OnSuccess' | string: The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. +* **containerSettings**: [ContainerConfiguration](#containerconfiguration): Settings to customize ACI container instance. +* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to pass over to the script. +* **forceUpdateTag**: string: Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. +* **outputs**: [DeploymentScriptPropertiesBaseOutputs](#deploymentscriptpropertiesbaseoutputs) (ReadOnly): List of script outputs. +* **primaryScriptUri**: string: Uri for the script. This is the entry point for the external script. +* **provisioningState**: 'Canceled' | 'Creating' | 'Failed' | 'ProvisioningResources' | 'Running' | 'Succeeded' | string (ReadOnly): State of the script execution. This only appears in the response. +* **retentionInterval**: string (Required): Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day). +* **scriptContent**: string: Script body. +* **status**: [ScriptStatus](#scriptstatus) (ReadOnly): Generic object modeling results of script execution. +* **storageAccountSettings**: [StorageAccountConfiguration](#storageaccountconfiguration): Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage +* **supportingScriptUris**: string[]: Supporting files for the external script. +* **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## ContainerConfiguration +### Properties +* **containerGroupName**: string: Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -78,22 +167,36 @@ * **timestamp**: string (ReadOnly): The timestamp of the template deployment. * **validatedResources**: [ResourceReference](#resourcereference)[] (ReadOnly): Array of validated resources. -## DebugSetting +## DeploymentScriptPropertiesBaseOutputs ### Properties -* **detailLevel**: string: 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. +### Additional Properties +* **Additional Properties Type**: any -## Dependency +## DeploymentScriptPropertiesBaseOutputs ### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: any -## BasicDependency +## DeploymentScriptTags ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: string + +## DeploymentTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## EnvironmentVariable +### Properties +* **name**: string (Required): The name of the environment variable. +* **secureValue**: string: The value of the secure environment variable. +* **value**: string: The value of the environment variable. + +## ErrorAdditionalInfo +### Properties +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -103,25 +206,27 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ExpressionEvaluationOptions ### Properties * **scope**: 'Inner' | 'NotSpecified' | 'Outer' | string (WriteOnly): The scope to be used for evaluation of parameters, variables and functions in a nested template. +## ManagedServiceIdentity +### Properties +* **tenantId**: string (ReadOnly): ID of the Azure Active Directory. +* **type**: 'UserAssigned' | string: Type of the managed identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. + +## ManagedServiceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + ## OnErrorDeployment ### Properties * **deploymentName**: string: The deployment to be used on error case. * **provisioningState**: string (ReadOnly): The state of the provisioning for the on error deployment. * **type**: 'LastSuccessful' | 'SpecificDeployment': The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. -## ResourceReference -### Properties -* **id**: string (ReadOnly): The fully qualified resource Id. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -135,6 +240,12 @@ * **registrationState**: string (ReadOnly): The registration state of the resource provider. * **resourceTypes**: [ProviderResourceType](#providerresourcetype)[] (ReadOnly): The collection of provider resource types. +## ProviderExtendedLocation +### Properties +* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. +* **location**: string (ReadOnly): The azure location. +* **type**: string (ReadOnly): The extended location type. + ## ProviderResourceType ### Properties * **aliases**: [Alias](#alias)[] (ReadOnly): The aliases that are supported by this resource type. @@ -148,129 +259,23 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## Alias -### Properties -* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **defaultPath**: string (ReadOnly): The default path for an alias. -* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. -* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. - -## AliasPathMetadata -### Properties -* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. -* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. - -## AliasPattern -### Properties -* **phrase**: string (ReadOnly): The alias pattern phrase. -* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern -* **variable**: string (ReadOnly): The alias pattern variable. - -## AliasPath -### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **path**: string (ReadOnly): The path of an alias. -* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. - -## ApiProfile -### Properties -* **apiVersion**: string (ReadOnly): The API version. -* **profileVersion**: string (ReadOnly): The profile version. - -## ProviderExtendedLocation -### Properties -* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. -* **location**: string (ReadOnly): The azure location. -* **type**: string (ReadOnly): The extended location type. - ## ProviderResourceTypeProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - -## TemplateLink -### Properties -* **contentVersion**: string: If included, must match the ContentVersion in the template. -* **id**: string: The resource id of a Template Spec. Use either the id or uri property, but not both. -* **queryString**: string: The query string (for example, a SAS token) to be used with the templateLink URI. -* **relativePath**: string: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs -* **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. - -## DeploymentTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedServiceIdentity -### Properties -* **tenantId**: string (ReadOnly): ID of the Azure Active Directory. -* **type**: 'UserAssigned' | string: Type of the managed identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): Client App Id associated with this identity. -* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this identity. - -## SystemData +## ResourceGroupProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **provisioningState**: string (ReadOnly): The provisioning state. -## DeploymentScriptTags +## ResourceGroupTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AzureCliScriptProperties -### Properties -* **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' -* **azCliVersion**: string (Required): Azure CLI module version to be used. -* **cleanupPreference**: 'Always' | 'OnExpiration' | 'OnSuccess' | string: The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. -* **containerSettings**: [ContainerConfiguration](#containerconfiguration): Settings to customize ACI container instance. -* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to pass over to the script. -* **forceUpdateTag**: string: Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. -* **outputs**: [DeploymentScriptPropertiesBaseOutputs](#deploymentscriptpropertiesbaseoutputs) (ReadOnly): List of script outputs. -* **primaryScriptUri**: string: Uri for the script. This is the entry point for the external script. -* **provisioningState**: 'Canceled' | 'Creating' | 'Failed' | 'ProvisioningResources' | 'Running' | 'Succeeded' | string (ReadOnly): State of the script execution. This only appears in the response. -* **retentionInterval**: string (Required): Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day). -* **scriptContent**: string: Script body. -* **status**: [ScriptStatus](#scriptstatus) (ReadOnly): Generic object modeling results of script execution. -* **storageAccountSettings**: [StorageAccountConfiguration](#storageaccountconfiguration): Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage -* **supportingScriptUris**: string[]: Supporting files for the external script. -* **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D - -## ContainerConfiguration -### Properties -* **containerGroupName**: string: Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property. - -## EnvironmentVariable -### Properties -* **name**: string (Required): The name of the environment variable. -* **secureValue**: string: The value of the secure environment variable. -* **value**: string: The value of the environment variable. - -## DeploymentScriptPropertiesBaseOutputs +## ResourceReference ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **id**: string (ReadOnly): The fully qualified resource Id. ## ScriptStatus ### Properties @@ -286,44 +291,39 @@ * **storageAccountKey**: string: The storage account access key. * **storageAccountName**: string: The storage account name. -## AzurePowerShellScriptProperties -### Properties -* **arguments**: string: Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' -* **azPowerShellVersion**: string (Required): Azure PowerShell module version to be used. -* **cleanupPreference**: 'Always' | 'OnExpiration' | 'OnSuccess' | string: The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'. -* **containerSettings**: [ContainerConfiguration](#containerconfiguration): Settings to customize ACI container instance. -* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to pass over to the script. -* **forceUpdateTag**: string: Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID. -* **outputs**: [DeploymentScriptPropertiesBaseOutputs](#deploymentscriptpropertiesbaseoutputs) (ReadOnly): List of script outputs. -* **primaryScriptUri**: string: Uri for the script. This is the entry point for the external script. -* **provisioningState**: 'Canceled' | 'Creating' | 'Failed' | 'ProvisioningResources' | 'Running' | 'Succeeded' | string (ReadOnly): State of the script execution. This only appears in the response. -* **retentionInterval**: string (Required): Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P1D means one day). -* **scriptContent**: string: Script body. -* **status**: [ScriptStatus](#scriptstatus) (ReadOnly): Generic object modeling results of script execution. -* **storageAccountSettings**: [StorageAccountConfiguration](#storageaccountconfiguration): Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage -* **supportingScriptUris**: string[]: Supporting files for the external script. -* **timeout**: string: Maximum allowed script execution time specified in ISO 8601 format. Default value is P1D - -## DeploymentScriptPropertiesBaseOutputs +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceGroupProperties +## Tags ### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. +* **tags**: [Tags](#tags): Dictionary of -## ResourceGroupTags +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## Tags +## TemplateLink ### Properties -* **tags**: [Tags](#tags): Dictionary of +* **contentVersion**: string: If included, must match the ContentVersion in the template. +* **id**: string: The resource id of a Template Spec. Use either the id or uri property, but not both. +* **queryString**: string: The query string (for example, a SAS token) to be used with the templateLink URI. +* **relativePath**: string: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs +* **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. -## Tags +## UserAssignedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): Client App Id associated with this identity. +* **principalId**: string (ReadOnly): Azure Active Directory principal ID associated with this identity. + +## ZoneMapping +### Properties +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2021-01-01/types.md b/generated/resources/microsoft.resources/2021-01-01/types.md index 16f7804035..4a4e3db7e8 100644 --- a/generated/resources/microsoft.resources/2021-01-01/types.md +++ b/generated/resources/microsoft.resources/2021-01-01/types.md @@ -32,6 +32,55 @@ * **properties**: [Tags](#tags) (Required): A dictionary of name and value pairs. * **type**: 'Microsoft.Resources/tags' (ReadOnly, DeployTimeConstant): The resource type +## Alias +### Properties +* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **defaultPath**: string (ReadOnly): The default path for an alias. +* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. +* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. + +## AliasPath +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **path**: string (ReadOnly): The path of an alias. +* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. + +## AliasPathMetadata +### Properties +* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. +* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. + +## AliasPattern +### Properties +* **phrase**: string (ReadOnly): The alias pattern phrase. +* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern +* **variable**: string (ReadOnly): The alias pattern variable. + +## ApiProfile +### Properties +* **apiVersion**: string (ReadOnly): The API version. +* **profileVersion**: string (ReadOnly): The profile version. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -54,22 +103,15 @@ * **timestamp**: string (ReadOnly): The timestamp of the template deployment. * **validatedResources**: [ResourceReference](#resourcereference)[] (ReadOnly): Array of validated resources. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency +## DeploymentTags ### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: string -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -79,11 +121,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ExpressionEvaluationOptions ### Properties * **scope**: 'Inner' | 'NotSpecified' | 'Outer' | string (WriteOnly): The scope to be used for evaluation of parameters, variables and functions in a nested template. @@ -94,10 +131,6 @@ * **provisioningState**: string (ReadOnly): The state of the provisioning for the on error deployment. * **type**: 'LastSuccessful' | 'SpecificDeployment': The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. -## ResourceReference -### Properties -* **id**: string (ReadOnly): The fully qualified resource Id. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -111,6 +144,12 @@ * **registrationState**: string (ReadOnly): The registration state of the resource provider. * **resourceTypes**: [ProviderResourceType](#providerresourcetype)[] (ReadOnly): The collection of provider resource types. +## ProviderExtendedLocation +### Properties +* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. +* **location**: string (ReadOnly): The azure location. +* **type**: string (ReadOnly): The extended location type. + ## ProviderResourceType ### Properties * **aliases**: [Alias](#alias)[] (ReadOnly): The aliases that are supported by this resource type. @@ -124,54 +163,33 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## Alias -### Properties -* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **defaultPath**: string (ReadOnly): The default path for an alias. -* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. -* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. - -## AliasPathMetadata +## ProviderResourceTypeProperties ### Properties -* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. -* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. +### Additional Properties +* **Additional Properties Type**: string -## AliasPattern +## ResourceGroupProperties ### Properties -* **phrase**: string (ReadOnly): The alias pattern phrase. -* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern -* **variable**: string (ReadOnly): The alias pattern variable. +* **provisioningState**: string (ReadOnly): The provisioning state. -## AliasPath +## ResourceGroupTags ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **path**: string (ReadOnly): The path of an alias. -* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +### Additional Properties +* **Additional Properties Type**: string -## ApiProfile +## ResourceReference ### Properties -* **apiVersion**: string (ReadOnly): The API version. -* **profileVersion**: string (ReadOnly): The profile version. +* **id**: string (ReadOnly): The fully qualified resource Id. -## ProviderExtendedLocation +## Tags ### Properties -* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. -* **location**: string (ReadOnly): The azure location. -* **type**: string (ReadOnly): The extended location type. +* **tags**: [Tags](#tags): Dictionary of -## ProviderResourceTypeProperties +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -180,26 +198,8 @@ * **relativePath**: string: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs * **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. -## DeploymentTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -* **tags**: [Tags](#tags): Dictionary of - -## Tags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2021-03-01-preview/types.md b/generated/resources/microsoft.resources/2021-03-01-preview/types.md index 29cf351908..ea6ed8ef3a 100644 --- a/generated/resources/microsoft.resources/2021-03-01-preview/types.md +++ b/generated/resources/microsoft.resources/2021-03-01-preview/types.md @@ -24,6 +24,20 @@ * **tags**: [TemplateSpecVersionTags](#templatespecversiontags): Resource tags. * **type**: 'Microsoft.Resources/templateSpecs/versions' (ReadOnly, DeployTimeConstant): The resource type +## LinkedTemplateArtifact +### Properties +* **path**: string (Required): A filesystem safe relative path of the artifact. +* **template**: any (Required): Any object + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TemplateSpecProperties ### Properties * **description**: string: Template Spec description. @@ -36,26 +50,17 @@ ### Additional Properties * **Additional Properties Type**: [TemplateSpecVersionInfo](#templatespecversioninfo) +## TemplateSpecTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TemplateSpecVersionInfo ### Properties * **description**: string (ReadOnly): Template Spec version description. * **timeCreated**: string (ReadOnly): The timestamp of when the version was created. * **timeModified**: string (ReadOnly): The timestamp of when the version was last modified. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TemplateSpecTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TemplateSpecVersionProperties ### Properties * **description**: string: Template Spec version description. @@ -64,11 +69,6 @@ * **metadata**: any: Any object * **uiFormDefinition**: any: Any object -## LinkedTemplateArtifact -### Properties -* **path**: string (Required): A filesystem safe relative path of the artifact. -* **template**: any (Required): Any object - ## TemplateSpecVersionTags ### Properties ### Additional Properties diff --git a/generated/resources/microsoft.resources/2021-04-01/types.md b/generated/resources/microsoft.resources/2021-04-01/types.md index 07df4eb049..0bae56271e 100644 --- a/generated/resources/microsoft.resources/2021-04-01/types.md +++ b/generated/resources/microsoft.resources/2021-04-01/types.md @@ -32,6 +32,55 @@ * **properties**: [Tags](#tags) (Required): A dictionary of name and value pairs. * **type**: 'Microsoft.Resources/tags' (ReadOnly, DeployTimeConstant): The resource type +## Alias +### Properties +* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **defaultPath**: string (ReadOnly): The default path for an alias. +* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +* **name**: string (ReadOnly): The alias name. +* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. +* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. + +## AliasPath +### Properties +* **apiVersions**: string[] (ReadOnly): The API versions. +* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) +* **path**: string (ReadOnly): The path of an alias. +* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. + +## AliasPathMetadata +### Properties +* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. +* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. + +## AliasPattern +### Properties +* **phrase**: string (ReadOnly): The alias pattern phrase. +* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern +* **variable**: string (ReadOnly): The alias pattern variable. + +## ApiProfile +### Properties +* **apiVersion**: string (ReadOnly): The API version. +* **profileVersion**: string (ReadOnly): The profile version. + +## BasicDependency +### Properties +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + +## DebugSetting +### Properties +* **detailLevel**: string: 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. + +## Dependency +### Properties +* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. +* **id**: string (ReadOnly): The ID of the dependency. +* **resourceName**: string (ReadOnly): The dependency resource name. +* **resourceType**: string (ReadOnly): The dependency resource type. + ## DeploymentProperties ### Properties * **correlationId**: string (ReadOnly): The correlation ID of the deployment. @@ -54,22 +103,15 @@ * **timestamp**: string (ReadOnly): The timestamp of the template deployment. * **validatedResources**: [ResourceReference](#resourcereference)[] (ReadOnly): Array of validated resources. -## DebugSetting -### Properties -* **detailLevel**: string: 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. - -## Dependency +## DeploymentTags ### Properties -* **dependsOn**: [BasicDependency](#basicdependency)[] (ReadOnly): The list of dependencies. -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +### Additional Properties +* **Additional Properties Type**: string -## BasicDependency +## ErrorAdditionalInfo ### Properties -* **id**: string (ReadOnly): The ID of the dependency. -* **resourceName**: string (ReadOnly): The dependency resource name. -* **resourceType**: string (ReadOnly): The dependency resource type. +* **info**: any (ReadOnly): Any object +* **type**: string (ReadOnly): The additional info type. ## ErrorResponse ### Properties @@ -79,11 +121,6 @@ * **message**: string (ReadOnly): The error message. * **target**: string (ReadOnly): The error target. -## ErrorAdditionalInfo -### Properties -* **info**: any (ReadOnly): Any object -* **type**: string (ReadOnly): The additional info type. - ## ExpressionEvaluationOptions ### Properties * **scope**: 'Inner' | 'NotSpecified' | 'Outer' | string (WriteOnly): The scope to be used for evaluation of parameters, variables and functions in a nested template. @@ -94,10 +131,6 @@ * **provisioningState**: string (ReadOnly): The state of the provisioning for the on error deployment. * **type**: 'LastSuccessful' | 'SpecificDeployment': The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. -## ResourceReference -### Properties -* **id**: string (ReadOnly): The fully qualified resource Id. - ## ParametersLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -112,6 +145,12 @@ * **registrationState**: string (ReadOnly): The registration state of the resource provider. * **resourceTypes**: [ProviderResourceType](#providerresourcetype)[] (ReadOnly): The collection of provider resource types. +## ProviderExtendedLocation +### Properties +* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. +* **location**: string (ReadOnly): The azure location. +* **type**: string (ReadOnly): The extended location type. + ## ProviderResourceType ### Properties * **aliases**: [Alias](#alias)[] (ReadOnly): The aliases that are supported by this resource type. @@ -125,54 +164,33 @@ * **resourceType**: string (ReadOnly): The resource type. * **zoneMappings**: [ZoneMapping](#zonemapping)[] (ReadOnly): Array of ZoneMapping -## Alias -### Properties -* **defaultMetadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **defaultPath**: string (ReadOnly): The default path for an alias. -* **defaultPattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. -* **name**: string (ReadOnly): The alias name. -* **paths**: [AliasPath](#aliaspath)[] (ReadOnly): The paths for an alias. -* **type**: 'Mask' | 'NotSpecified' | 'PlainText' (ReadOnly): The type of the alias. - -## AliasPathMetadata +## ProviderResourceTypeProperties ### Properties -* **attributes**: 'Modifiable' | 'None' | string (ReadOnly): The attributes of the token that the alias path is referring to. -* **type**: 'Any' | 'Array' | 'Boolean' | 'Integer' | 'NotSpecified' | 'Number' | 'Object' | 'String' | string (ReadOnly): The type of the token that the alias path is referring to. +### Additional Properties +* **Additional Properties Type**: string -## AliasPattern +## ResourceGroupProperties ### Properties -* **phrase**: string (ReadOnly): The alias pattern phrase. -* **type**: 'Extract' | 'NotSpecified' (ReadOnly): The type of alias pattern -* **variable**: string (ReadOnly): The alias pattern variable. +* **provisioningState**: string (ReadOnly): The provisioning state. -## AliasPath +## ResourceGroupTags ### Properties -* **apiVersions**: string[] (ReadOnly): The API versions. -* **metadata**: [AliasPathMetadata](#aliaspathmetadata) (ReadOnly) -* **path**: string (ReadOnly): The path of an alias. -* **pattern**: [AliasPattern](#aliaspattern) (ReadOnly): The type of the pattern for an alias path. +### Additional Properties +* **Additional Properties Type**: string -## ApiProfile +## ResourceReference ### Properties -* **apiVersion**: string (ReadOnly): The API version. -* **profileVersion**: string (ReadOnly): The profile version. +* **id**: string (ReadOnly): The fully qualified resource Id. -## ProviderExtendedLocation +## Tags ### Properties -* **extendedLocations**: string[] (ReadOnly): The extended locations for the azure location. -* **location**: string (ReadOnly): The azure location. -* **type**: string (ReadOnly): The extended location type. +* **tags**: [Tags](#tags): Dictionary of -## ProviderResourceTypeProperties +## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ZoneMapping -### Properties -* **location**: string (ReadOnly): The location of the zone mapping. -* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem - ## TemplateLink ### Properties * **contentVersion**: string: If included, must match the ContentVersion in the template. @@ -181,26 +199,8 @@ * **relativePath**: string: The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs * **uri**: string: The URI of the template to deploy. Use either the uri or id property, but not both. -## DeploymentTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceGroupProperties -### Properties -* **provisioningState**: string (ReadOnly): The provisioning state. - -## ResourceGroupTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## Tags -### Properties -* **tags**: [Tags](#tags): Dictionary of - -## Tags +## ZoneMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **location**: string (ReadOnly): The location of the zone mapping. +* **zones**: string[] (ReadOnly): Array of ZoneMappingZonesItem diff --git a/generated/resources/microsoft.resources/2021-05-01/types.md b/generated/resources/microsoft.resources/2021-05-01/types.md index 02b3cda4e3..42b383f283 100644 --- a/generated/resources/microsoft.resources/2021-05-01/types.md +++ b/generated/resources/microsoft.resources/2021-05-01/types.md @@ -24,6 +24,20 @@ * **tags**: [TemplateSpecVersionTags](#templatespecversiontags): Resource tags. * **type**: 'Microsoft.Resources/templateSpecs/versions' (ReadOnly, DeployTimeConstant): The resource type +## LinkedTemplateArtifact +### Properties +* **path**: string (Required): A filesystem safe relative path of the artifact. +* **template**: any (Required): Any object + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TemplateSpecProperties ### Properties * **description**: string: Template Spec description. @@ -36,26 +50,17 @@ ### Additional Properties * **Additional Properties Type**: [TemplateSpecVersionInfo](#templatespecversioninfo) +## TemplateSpecTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TemplateSpecVersionInfo ### Properties * **description**: string (ReadOnly): Template Spec version description. * **timeCreated**: string (ReadOnly): The timestamp of when the version was created. * **timeModified**: string (ReadOnly): The timestamp of when the version was last modified. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TemplateSpecTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TemplateSpecVersionProperties ### Properties * **description**: string: Template Spec version description. @@ -64,11 +69,6 @@ * **metadata**: any: Any object * **uiFormDefinition**: any: Any object -## LinkedTemplateArtifact -### Properties -* **path**: string (Required): A filesystem safe relative path of the artifact. -* **template**: any (Required): Any object - ## TemplateSpecVersionTags ### Properties ### Additional Properties diff --git a/generated/resources/microsoft.resources/2022-02-01/types.md b/generated/resources/microsoft.resources/2022-02-01/types.md index 68fe55c292..ce86295e79 100644 --- a/generated/resources/microsoft.resources/2022-02-01/types.md +++ b/generated/resources/microsoft.resources/2022-02-01/types.md @@ -24,6 +24,20 @@ * **tags**: [TemplateSpecVersionTags](#templatespecversiontags): Resource tags. * **type**: 'Microsoft.Resources/templateSpecs/versions' (ReadOnly, DeployTimeConstant): The resource type +## LinkedTemplateArtifact +### Properties +* **path**: string (Required): A filesystem safe relative path of the artifact. +* **template**: any (Required): Any object + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TemplateSpecProperties ### Properties * **description**: string: Template Spec description. @@ -36,26 +50,17 @@ ### Additional Properties * **Additional Properties Type**: [TemplateSpecVersionInfo](#templatespecversioninfo) +## TemplateSpecTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TemplateSpecVersionInfo ### Properties * **description**: string (ReadOnly): Template Spec version description. * **timeCreated**: string (ReadOnly): The timestamp of when the version was created. * **timeModified**: string (ReadOnly): The timestamp of when the version was last modified. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TemplateSpecTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## TemplateSpecVersionProperties ### Properties * **description**: string: Template Spec version description. @@ -64,11 +69,6 @@ * **metadata**: any: Any object * **uiFormDefinition**: any: Any object -## LinkedTemplateArtifact -### Properties -* **path**: string (Required): A filesystem safe relative path of the artifact. -* **template**: any (Required): Any object - ## TemplateSpecVersionTags ### Properties ### Additional Properties diff --git a/generated/resources/microsoft.solutions/2016-09-01-preview/types.md b/generated/resources/microsoft.solutions/2016-09-01-preview/types.md index ae8abde51b..2f8235a883 100644 --- a/generated/resources/microsoft.solutions/2016-09-01-preview/types.md +++ b/generated/resources/microsoft.solutions/2016-09-01-preview/types.md @@ -30,11 +30,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Solutions/appliances' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ApplianceArtifact ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **name**: string: The appliance artifact name. +* **type**: 'Custom' | 'Template': The appliance artifact type. +* **uri**: string: The appliance artifact blob uri. ## ApplianceDefinitionProperties ### Properties @@ -45,30 +45,25 @@ * **lockLevel**: 'CanNotDelete' | 'None' | 'ReadOnly' (Required): The appliance lock level. * **packageFileUri**: string (Required): The appliance definition package file Uri. -## ApplianceArtifact +## ApplianceProperties ### Properties -* **name**: string: The appliance artifact name. -* **type**: 'Custom' | 'Template': The appliance artifact type. -* **uri**: string: The appliance artifact blob uri. +* **applianceDefinitionId**: string: The fully qualified path of appliance definition Id. +* **managedResourceGroupId**: string (Required): The managed resource group Id. +* **outputs**: any (ReadOnly): Any object +* **parameters**: any: Any object +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the appliance. +* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. ## ApplianceProviderAuthorization ### Properties * **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. * **roleDefinitionId**: string (Required): 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. -## Sku -### Properties -* **capacity**: int: The SKU capacity. -* **family**: string: The SKU family. -* **model**: string: The SKU model. -* **name**: string (Required): The SKU name. -* **size**: string: The SKU size. -* **tier**: string: The SKU tier. - -## ResourceTags +## Identity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## Plan ### Properties @@ -78,17 +73,22 @@ * **publisher**: string (Required): The publisher ID. * **version**: string (Required): The plan's version. -## ApplianceProperties +## ResourceTags ### Properties -* **applianceDefinitionId**: string: The fully qualified path of appliance definition Id. -* **managedResourceGroupId**: string (Required): The managed resource group Id. -* **outputs**: any (ReadOnly): Any object -* **parameters**: any: Any object -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the appliance. -* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **capacity**: int: The SKU capacity. +* **family**: string: The SKU family. +* **model**: string: The SKU model. +* **name**: string (Required): The SKU name. +* **size**: string: The SKU size. +* **tier**: string: The SKU tier. + diff --git a/generated/resources/microsoft.solutions/2017-09-01/types.md b/generated/resources/microsoft.solutions/2017-09-01/types.md index 113ee011e0..0e4868fd06 100644 --- a/generated/resources/microsoft.solutions/2017-09-01/types.md +++ b/generated/resources/microsoft.solutions/2017-09-01/types.md @@ -30,11 +30,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Solutions/applications' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ApplicationArtifact ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **name**: string: The managed application artifact name. +* **type**: 'Custom' | 'Template': The managed application artifact type. +* **uri**: string: The managed application artifact blob uri. ## ApplicationDefinitionProperties ### Properties @@ -48,30 +48,25 @@ * **mainTemplate**: any: Any object * **packageFileUri**: string: The managed application definition package file Uri. Use this element -## ApplicationArtifact +## ApplicationProperties ### Properties -* **name**: string: The managed application artifact name. -* **type**: 'Custom' | 'Template': The managed application artifact type. -* **uri**: string: The managed application artifact blob uri. +* **applicationDefinitionId**: string: The fully qualified path of managed application definition Id. +* **managedResourceGroupId**: string (Required): The managed resource group Id. +* **outputs**: any (ReadOnly): Any object +* **parameters**: any: Any object +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the managed application. +* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. ## ApplicationProviderAuthorization ### Properties * **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. * **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. -## Sku -### Properties -* **capacity**: int: The SKU capacity. -* **family**: string: The SKU family. -* **model**: string: The SKU model. -* **name**: string (Required): The SKU name. -* **size**: string: The SKU size. -* **tier**: string: The SKU tier. - -## ResourceTags +## Identity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## Plan ### Properties @@ -81,17 +76,22 @@ * **publisher**: string (Required): The publisher ID. * **version**: string (Required): The plan's version. -## ApplicationProperties +## ResourceTags ### Properties -* **applicationDefinitionId**: string: The fully qualified path of managed application definition Id. -* **managedResourceGroupId**: string (Required): The managed resource group Id. -* **outputs**: any (ReadOnly): Any object -* **parameters**: any: Any object -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the managed application. -* **uiDefinitionUri**: string: The blob URI where the UI definition file is located. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **capacity**: int: The SKU capacity. +* **family**: string: The SKU family. +* **model**: string: The SKU model. +* **name**: string (Required): The SKU name. +* **size**: string: The SKU size. +* **tier**: string: The SKU tier. + diff --git a/generated/resources/microsoft.solutions/2018-06-01/types.md b/generated/resources/microsoft.solutions/2018-06-01/types.md index e19042d8fd..de0d795e62 100644 --- a/generated/resources/microsoft.solutions/2018-06-01/types.md +++ b/generated/resources/microsoft.solutions/2018-06-01/types.md @@ -30,11 +30,11 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Solutions/applications' (ReadOnly, DeployTimeConstant): The resource type -## Identity +## ApplicationArtifact ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned': The identity type. +* **name**: string: The managed application artifact name. +* **type**: 'Custom' | 'Template': The managed application artifact type. +* **uri**: string: The managed application artifact blob uri. ## ApplicationDefinitionProperties ### Properties @@ -48,30 +48,24 @@ * **mainTemplate**: any: Any object * **packageFileUri**: string: The managed application definition package file Uri. Use this element -## ApplicationArtifact +## ApplicationProperties ### Properties -* **name**: string: The managed application artifact name. -* **type**: 'Custom' | 'Template': The managed application artifact type. -* **uri**: string: The managed application artifact blob uri. +* **applicationDefinitionId**: string: The fully qualified path of managed application definition Id. +* **managedResourceGroupId**: string (Required): The managed resource group Id. +* **outputs**: any (ReadOnly): Any object +* **parameters**: any: Any object +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the managed application. ## ApplicationProviderAuthorization ### Properties * **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. * **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. -## Sku -### Properties -* **capacity**: int: The SKU capacity. -* **family**: string: The SKU family. -* **model**: string: The SKU model. -* **name**: string (Required): The SKU name. -* **size**: string: The SKU size. -* **tier**: string: The SKU tier. - -## ResourceTags +## Identity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned': The identity type. ## Plan ### Properties @@ -81,16 +75,22 @@ * **publisher**: string (Required): The publisher ID. * **version**: string (Required): The plan's version. -## ApplicationProperties +## ResourceTags ### Properties -* **applicationDefinitionId**: string: The fully qualified path of managed application definition Id. -* **managedResourceGroupId**: string (Required): The managed resource group Id. -* **outputs**: any (ReadOnly): Any object -* **parameters**: any: Any object -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'Ready' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the managed application. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **capacity**: int: The SKU capacity. +* **family**: string: The SKU family. +* **model**: string: The SKU model. +* **name**: string (Required): The SKU name. +* **size**: string: The SKU size. +* **tier**: string: The SKU tier. + diff --git a/generated/resources/microsoft.solutions/2019-07-01/types.md b/generated/resources/microsoft.solutions/2019-07-01/types.md index c4212cda8d..3d31ed4f33 100644 --- a/generated/resources/microsoft.solutions/2019-07-01/types.md +++ b/generated/resources/microsoft.solutions/2019-07-01/types.md @@ -40,6 +40,33 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Solutions/jitRequests' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationArtifact +### Properties +* **name**: 'Authorizations' | 'CustomRoleDefinition' | 'NotSpecified' | 'ViewDefinition' | string (Required): The managed application artifact name. +* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. +* **uri**: string (Required): The managed application artifact blob uri. + +## ApplicationAuthorization +### Properties +* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. +* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. + +## ApplicationBillingDetailsDefinition +### Properties +* **resourceUsageId**: string: The managed application resource usage Id. + +## ApplicationClientDetails +### Properties +* **applicationId**: string: The client application Id. +* **oid**: string: The client Oid. +* **puid**: string: The client Puid + +## ApplicationDefinitionArtifact +### Properties +* **name**: 'ApplicationResourceTemplate' | 'CreateUiDefinition' | 'MainTemplateParameters' | 'NotSpecified' | string (Required): The managed application artifact name. +* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. +* **uri**: string (Required): The managed application definition artifact blob uri. + ## ApplicationDefinitionProperties ### Properties * **artifacts**: [ApplicationDefinitionArtifact](#applicationdefinitionartifact)[]: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. @@ -57,82 +84,50 @@ * **packageFileUri**: string: The managed application definition package file Uri. Use this element * **policies**: [ApplicationPolicy](#applicationpolicy)[]: The managed application provider policies. -## ApplicationDefinitionArtifact -### Properties -* **name**: 'ApplicationResourceTemplate' | 'CreateUiDefinition' | 'MainTemplateParameters' | 'NotSpecified' | string (Required): The managed application artifact name. -* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. -* **uri**: string (Required): The managed application definition artifact blob uri. - -## ApplicationAuthorization -### Properties -* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. -* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. - ## ApplicationDeploymentPolicy ### Properties * **deploymentMode**: 'Complete' | 'Incremental' | 'NotSpecified' | string (Required): The deployment mode. -## ApplicationPackageLockingPolicyDefinition +## ApplicationJitAccessPolicy ### Properties -* **allowedActions**: string[]: The deny assignment excluded actions. -* **allowedDataActions**: string[]: The deny assignment excluded data actions. +* **jitAccessEnabled**: bool (Required): Whether the JIT access is enabled. +* **jitApprovalMode**: 'AutoApprove' | 'ManualApprove' | 'NotSpecified' | string: The Jit approval mode. +* **jitApprovers**: [JitApproverDefinition](#jitapproverdefinition)[]: The JIT approvers +* **maximumJitAccessDuration**: string: The maximum duration JIT access is granted. This is an ISO8601 time period value. ## ApplicationManagementPolicy ### Properties * **mode**: 'Managed' | 'NotSpecified' | 'Unmanaged' | string: The management mode. -## ApplicationNotificationPolicy -### Properties -* **notificationEndpoints**: [ApplicationNotificationEndpoint](#applicationnotificationendpoint)[] (Required): The managed application notification endpoint. - ## ApplicationNotificationEndpoint ### Properties * **uri**: string (Required): The managed application notification endpoint uri. -## ApplicationPolicy -### Properties -* **name**: string: The policy name -* **parameters**: string: The policy parameters. -* **policyDefinitionId**: string: The policy definition Id. - -## Sku -### Properties -* **capacity**: int: The SKU capacity. -* **family**: string: The SKU family. -* **model**: string: The SKU model. -* **name**: string (Required): The SKU name. -* **size**: string: The SKU size. -* **tier**: string: The SKU tier. - -## ResourceTags +## ApplicationNotificationPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notificationEndpoints**: [ApplicationNotificationEndpoint](#applicationnotificationendpoint)[] (Required): The managed application notification endpoint. -## Identity +## ApplicationPackageContact ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **contactName**: string: The contact name. +* **email**: string (Required): The contact email. +* **phone**: string (Required): The contact phone number. -## IdentityUserAssignedIdentities +## ApplicationPackageLockingPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedResourceIdentity](#userassignedresourceidentity) +* **allowedActions**: string[]: The deny assignment excluded actions. +* **allowedDataActions**: string[]: The deny assignment excluded data actions. -## UserAssignedResourceIdentity +## ApplicationPackageSupportUrls ### Properties -* **principalId**: string (ReadOnly): The principal id of user assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of user assigned identity. +* **governmentCloud**: string: The government cloud support URL. +* **publicAzure**: string: The public azure support URL. -## Plan +## ApplicationPolicy ### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **promotionCode**: string: The promotion code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. +* **name**: string: The policy name +* **parameters**: string: The policy parameters. +* **policyDefinitionId**: string: The policy definition Id. ## ApplicationProperties ### Properties @@ -152,34 +147,17 @@ * **supportUrls**: [ApplicationPackageSupportUrls](#applicationpackagesupporturls) (ReadOnly): The appliance package support URLs. * **updatedBy**: [ApplicationClientDetails](#applicationclientdetails) (ReadOnly): The application client details to track the entity creating/updating the managed app resource. -## ApplicationArtifact -### Properties -* **name**: 'Authorizations' | 'CustomRoleDefinition' | 'NotSpecified' | 'ViewDefinition' | string (Required): The managed application artifact name. -* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. -* **uri**: string (Required): The managed application artifact blob uri. - -## ApplicationBillingDetailsDefinition -### Properties -* **resourceUsageId**: string: The managed application resource usage Id. - -## ApplicationClientDetails -### Properties -* **applicationId**: string: The client application Id. -* **oid**: string: The client Oid. -* **puid**: string: The client Puid - -## ApplicationPackageContact +## Identity ### Properties -* **contactName**: string: The contact name. -* **email**: string (Required): The contact email. -* **phone**: string (Required): The contact phone number. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ApplicationJitAccessPolicy +## IdentityUserAssignedIdentities ### Properties -* **jitAccessEnabled**: bool (Required): Whether the JIT access is enabled. -* **jitApprovalMode**: 'AutoApprove' | 'ManualApprove' | 'NotSpecified' | string: The Jit approval mode. -* **jitApprovers**: [JitApproverDefinition](#jitapproverdefinition)[]: The JIT approvers -* **maximumJitAccessDuration**: string: The maximum duration JIT access is granted. This is an ISO8601 time period value. +### Additional Properties +* **Additional Properties Type**: [UserAssignedResourceIdentity](#userassignedresourceidentity) ## JitApproverDefinition ### Properties @@ -187,15 +165,10 @@ * **id**: string (Required): The approver service principal Id. * **type**: 'group' | 'user' | string: The approver type. -## ApplicationPackageSupportUrls -### Properties -* **governmentCloud**: string: The government cloud support URL. -* **publicAzure**: string: The public azure support URL. - -## ResourceTags +## JitAuthorizationPolicies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (Required): The the principal id that will be granted JIT access. +* **roleDefinitionId**: string (Required): The role definition id that will be granted to the Principal. ## JitRequestProperties ### Properties @@ -208,19 +181,46 @@ * **publisherTenantId**: string (ReadOnly): The publisher tenant id. * **updatedBy**: [ApplicationClientDetails](#applicationclientdetails) (ReadOnly): The application client details to track the entity creating/updating the managed app resource. -## JitAuthorizationPolicies -### Properties -* **principalId**: string (Required): The the principal id that will be granted JIT access. -* **roleDefinitionId**: string (Required): The role definition id that will be granted to the Principal. - ## JitSchedulingPolicy ### Properties * **duration**: string (Required): The required duration of the JIT request. * **startTime**: string (Required): The start time of the request. * **type**: 'NotSpecified' | 'Once' | 'Recurring' | string (Required, ReadOnly): The JIT request scheduling type. +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **promotionCode**: string: The promotion code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **capacity**: int: The SKU capacity. +* **family**: string: The SKU family. +* **model**: string: The SKU model. +* **name**: string (Required): The SKU name. +* **size**: string: The SKU size. +* **tier**: string: The SKU tier. + +## UserAssignedResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of user assigned identity. + diff --git a/generated/resources/microsoft.solutions/2020-08-21-preview/types.md b/generated/resources/microsoft.solutions/2020-08-21-preview/types.md index 6157d1a7a3..e99f746352 100644 --- a/generated/resources/microsoft.solutions/2020-08-21-preview/types.md +++ b/generated/resources/microsoft.solutions/2020-08-21-preview/types.md @@ -40,6 +40,33 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Solutions/jitRequests' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationArtifact +### Properties +* **name**: 'Authorizations' | 'CustomRoleDefinition' | 'NotSpecified' | 'ViewDefinition' | string (Required): The managed application artifact name. +* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. +* **uri**: string (Required): The managed application artifact blob uri. + +## ApplicationAuthorization +### Properties +* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. +* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. + +## ApplicationBillingDetailsDefinition +### Properties +* **resourceUsageId**: string: The managed application resource usage Id. + +## ApplicationClientDetails +### Properties +* **applicationId**: string: The client application Id. +* **oid**: string: The client Oid. +* **puid**: string: The client Puid + +## ApplicationDefinitionArtifact +### Properties +* **name**: 'ApplicationResourceTemplate' | 'CreateUiDefinition' | 'MainTemplateParameters' | 'NotSpecified' | string (Required): The managed application artifact name. +* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. +* **uri**: string (Required): The managed application definition artifact blob uri. + ## ApplicationDefinitionProperties ### Properties * **artifacts**: [ApplicationDefinitionArtifact](#applicationdefinitionartifact)[]: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. @@ -58,82 +85,50 @@ * **policies**: [ApplicationPolicy](#applicationpolicy)[]: The managed application provider policies. * **storageAccountId**: string: The storage account id for bring your own storage scenario. -## ApplicationDefinitionArtifact -### Properties -* **name**: 'ApplicationResourceTemplate' | 'CreateUiDefinition' | 'MainTemplateParameters' | 'NotSpecified' | string (Required): The managed application artifact name. -* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. -* **uri**: string (Required): The managed application definition artifact blob uri. - -## ApplicationAuthorization -### Properties -* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. -* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. - ## ApplicationDeploymentPolicy ### Properties * **deploymentMode**: 'Complete' | 'Incremental' | 'NotSpecified' | string (Required): The deployment mode. -## ApplicationPackageLockingPolicyDefinition +## ApplicationJitAccessPolicy ### Properties -* **allowedActions**: string[]: The deny assignment excluded actions. -* **allowedDataActions**: string[]: The deny assignment excluded data actions. +* **jitAccessEnabled**: bool (Required): Whether the JIT access is enabled. +* **jitApprovalMode**: 'AutoApprove' | 'ManualApprove' | 'NotSpecified' | string: The Jit approval mode. +* **jitApprovers**: [JitApproverDefinition](#jitapproverdefinition)[]: The JIT approvers +* **maximumJitAccessDuration**: string: The maximum duration JIT access is granted. This is an ISO8601 time period value. ## ApplicationManagementPolicy ### Properties * **mode**: 'Managed' | 'NotSpecified' | 'Unmanaged' | string: The management mode. -## ApplicationNotificationPolicy -### Properties -* **notificationEndpoints**: [ApplicationNotificationEndpoint](#applicationnotificationendpoint)[] (Required): The managed application notification endpoint. - ## ApplicationNotificationEndpoint ### Properties * **uri**: string (Required): The managed application notification endpoint uri. -## ApplicationPolicy -### Properties -* **name**: string: The policy name -* **parameters**: string: The policy parameters. -* **policyDefinitionId**: string: The policy definition Id. - -## Sku -### Properties -* **capacity**: int: The SKU capacity. -* **family**: string: The SKU family. -* **model**: string: The SKU model. -* **name**: string (Required): The SKU name. -* **size**: string: The SKU size. -* **tier**: string: The SKU tier. - -## ResourceTags +## ApplicationNotificationPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notificationEndpoints**: [ApplicationNotificationEndpoint](#applicationnotificationendpoint)[] (Required): The managed application notification endpoint. -## Identity +## ApplicationPackageContact ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **contactName**: string: The contact name. +* **email**: string (Required): The contact email. +* **phone**: string (Required): The contact phone number. -## IdentityUserAssignedIdentities +## ApplicationPackageLockingPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedResourceIdentity](#userassignedresourceidentity) +* **allowedActions**: string[]: The deny assignment excluded actions. +* **allowedDataActions**: string[]: The deny assignment excluded data actions. -## UserAssignedResourceIdentity +## ApplicationPackageSupportUrls ### Properties -* **principalId**: string (ReadOnly): The principal id of user assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of user assigned identity. +* **governmentCloud**: string: The government cloud support URL. +* **publicAzure**: string: The public azure support URL. -## Plan +## ApplicationPolicy ### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **promotionCode**: string: The promotion code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. +* **name**: string: The policy name +* **parameters**: string: The policy parameters. +* **policyDefinitionId**: string: The policy definition Id. ## ApplicationProperties ### Properties @@ -153,34 +148,17 @@ * **supportUrls**: [ApplicationPackageSupportUrls](#applicationpackagesupporturls) (ReadOnly): The appliance package support URLs. * **updatedBy**: [ApplicationClientDetails](#applicationclientdetails) (ReadOnly): The application client details to track the entity creating/updating the managed app resource. -## ApplicationArtifact -### Properties -* **name**: 'Authorizations' | 'CustomRoleDefinition' | 'NotSpecified' | 'ViewDefinition' | string (Required): The managed application artifact name. -* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. -* **uri**: string (Required): The managed application artifact blob uri. - -## ApplicationBillingDetailsDefinition -### Properties -* **resourceUsageId**: string: The managed application resource usage Id. - -## ApplicationClientDetails -### Properties -* **applicationId**: string: The client application Id. -* **oid**: string: The client Oid. -* **puid**: string: The client Puid - -## ApplicationPackageContact +## Identity ### Properties -* **contactName**: string: The contact name. -* **email**: string (Required): The contact email. -* **phone**: string (Required): The contact phone number. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ApplicationJitAccessPolicy +## IdentityUserAssignedIdentities ### Properties -* **jitAccessEnabled**: bool (Required): Whether the JIT access is enabled. -* **jitApprovalMode**: 'AutoApprove' | 'ManualApprove' | 'NotSpecified' | string: The Jit approval mode. -* **jitApprovers**: [JitApproverDefinition](#jitapproverdefinition)[]: The JIT approvers -* **maximumJitAccessDuration**: string: The maximum duration JIT access is granted. This is an ISO8601 time period value. +### Additional Properties +* **Additional Properties Type**: [UserAssignedResourceIdentity](#userassignedresourceidentity) ## JitApproverDefinition ### Properties @@ -188,15 +166,10 @@ * **id**: string (Required): The approver service principal Id. * **type**: 'group' | 'user' | string: The approver type. -## ApplicationPackageSupportUrls -### Properties -* **governmentCloud**: string: The government cloud support URL. -* **publicAzure**: string: The public azure support URL. - -## ResourceTags +## JitAuthorizationPolicies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (Required): The the principal id that will be granted JIT access. +* **roleDefinitionId**: string (Required): The role definition id that will be granted to the Principal. ## JitRequestProperties ### Properties @@ -209,19 +182,46 @@ * **publisherTenantId**: string (ReadOnly): The publisher tenant id. * **updatedBy**: [ApplicationClientDetails](#applicationclientdetails) (ReadOnly): The application client details to track the entity creating/updating the managed app resource. -## JitAuthorizationPolicies -### Properties -* **principalId**: string (Required): The the principal id that will be granted JIT access. -* **roleDefinitionId**: string (Required): The role definition id that will be granted to the Principal. - ## JitSchedulingPolicy ### Properties * **duration**: string (Required): The required duration of the JIT request. * **startTime**: string (Required): The start time of the request. * **type**: 'NotSpecified' | 'Once' | 'Recurring' | string (Required, ReadOnly): The JIT request scheduling type. +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **promotionCode**: string: The promotion code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **capacity**: int: The SKU capacity. +* **family**: string: The SKU family. +* **model**: string: The SKU model. +* **name**: string (Required): The SKU name. +* **size**: string: The SKU size. +* **tier**: string: The SKU tier. + +## UserAssignedResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of user assigned identity. + diff --git a/generated/saas/log.out b/generated/saas/log.out index a714c0a7a0..ca4e3e6b7e 100644 --- a/generated/saas/log.out +++ b/generated/saas/log.out @@ -5,5 +5,5 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) -info | Autorest completed in 1.92s. 0 files generated. +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +info | Autorest completed in 1.86s. 0 files generated. diff --git a/generated/scheduler/log.out b/generated/scheduler/log.out index 7389d3a535..1f392c22e5 100644 --- a/generated/scheduler/log.out +++ b/generated/scheduler/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.scheduler-2016-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobCollectionListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/scheduler/resource-manager/Microsoft.Scheduler/stable/2016-03-01/scheduler.json:721:5 @@ -69,10 +69,10 @@ warning | PreCheck/SchemaMissingType | The schema 'JobRecurrenceScheduleMonthlyO warning | PreCheck/SchemaMissingType | The schema 'JobStatus' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/scheduler/resource-manager/Microsoft.Scheduler/stable/2016-03-01/scheduler.json:1582:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 20ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.scheduler-2016-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobCollectionListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/scheduler/resource-manager/Microsoft.Scheduler/stable/2016-01-01/scheduler.json:723:5 @@ -138,7 +138,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.scheduler-2014-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'JobCollectionListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/scheduler/resource-manager/Microsoft.Scheduler/preview/2014-08-01-preview/scheduler.json:723:5 @@ -201,5 +201,5 @@ warning | PreCheck/SchemaMissingType | The schema 'JobRecurrenceScheduleMonthlyO warning | PreCheck/SchemaMissingType | The schema 'JobStatus' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/scheduler/resource-manager/Microsoft.Scheduler/preview/2014-08-01-preview/scheduler.json:1576:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Autorest completed in 8.94s. 6 files generated. diff --git a/generated/scheduler/microsoft.scheduler/2014-08-01-preview/types.md b/generated/scheduler/microsoft.scheduler/2014-08-01-preview/types.md index e85dafeff6..34f82bca92 100644 --- a/generated/scheduler/microsoft.scheduler/2014-08-01-preview/types.md +++ b/generated/scheduler/microsoft.scheduler/2014-08-01-preview/types.md @@ -20,40 +20,23 @@ * **properties**: [JobProperties](#jobproperties) * **type**: 'Microsoft.Scheduler/jobCollections/jobs' (ReadOnly, DeployTimeConstant): The resource type -## JobCollectionProperties -### Properties -* **quota**: [JobCollectionQuota](#jobcollectionquota) -* **sku**: [Sku](#sku) -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'Suspended': Gets or sets the state. - -## JobCollectionQuota -### Properties -* **maxJobCount**: int: Gets or set the maximum job count. -* **maxJobOccurrence**: int: Gets or sets the maximum job occurrence. -* **maxRecurrence**: [JobMaxRecurrence](#jobmaxrecurrence) - -## JobMaxRecurrence +## HttpAuthentication ### Properties -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). -* **interval**: int: Gets or sets the interval between retries. +* **type**: 'ActiveDirectoryOAuth' | 'Basic' | 'ClientCertificate' | 'NotSpecified': Gets or sets the http authentication type. -## Sku +## HttpRequest ### Properties -* **name**: 'Free' | 'Premium' | 'Standard': Gets or set the SKU. +* **authentication**: [HttpAuthentication](#httpauthentication) +* **body**: string: Gets or sets the request body. +* **headers**: [HttpRequestHeaders](#httprequestheaders): Gets or sets the headers. +* **method**: string: Gets or sets the method of the request. +* **uri**: string: Gets or sets the Uri. -## JobCollectionDefinitionTags +## HttpRequestHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## JobProperties -### Properties -* **action**: [JobAction](#jobaction) -* **recurrence**: [JobRecurrence](#jobrecurrence) -* **startTime**: string: Gets or sets the job start time. -* **state**: 'Completed' | 'Disabled' | 'Enabled' | 'Faulted': Gets or set the job state. -* **status**: [JobStatus](#jobstatus) (ReadOnly) - ## JobAction ### Properties * **errorAction**: [JobErrorAction](#joberroraction) @@ -64,6 +47,23 @@ * **serviceBusTopicMessage**: [ServiceBusTopicMessage](#servicebustopicmessage) * **type**: 'Http' | 'Https' | 'ServiceBusQueue' | 'ServiceBusTopic' | 'StorageQueue': Gets or sets the job action type. +## JobCollectionDefinitionTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## JobCollectionProperties +### Properties +* **quota**: [JobCollectionQuota](#jobcollectionquota) +* **sku**: [Sku](#sku) +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'Suspended': Gets or sets the state. + +## JobCollectionQuota +### Properties +* **maxJobCount**: int: Gets or set the maximum job count. +* **maxJobOccurrence**: int: Gets or sets the maximum job occurrence. +* **maxRecurrence**: [JobMaxRecurrence](#jobmaxrecurrence) + ## JobErrorAction ### Properties * **queueMessage**: [StorageQueueMessage](#storagequeuemessage) @@ -73,29 +73,47 @@ * **serviceBusTopicMessage**: [ServiceBusTopicMessage](#servicebustopicmessage) * **type**: 'Http' | 'Https' | 'ServiceBusQueue' | 'ServiceBusTopic' | 'StorageQueue': Gets or sets the job action type. -## StorageQueueMessage +## JobMaxRecurrence ### Properties -* **message**: string: Gets or sets the message. -* **queueName**: string: Gets or sets the queue name. -* **sasToken**: string: Gets or sets the SAS key. -* **storageAccount**: string: Gets or sets the storage account name. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). +* **interval**: int: Gets or sets the interval between retries. -## HttpRequest +## JobProperties ### Properties -* **authentication**: [HttpAuthentication](#httpauthentication) -* **body**: string: Gets or sets the request body. -* **headers**: [HttpRequestHeaders](#httprequestheaders): Gets or sets the headers. -* **method**: string: Gets or sets the method of the request. -* **uri**: string: Gets or sets the Uri. +* **action**: [JobAction](#jobaction) +* **recurrence**: [JobRecurrence](#jobrecurrence) +* **startTime**: string: Gets or sets the job start time. +* **state**: 'Completed' | 'Disabled' | 'Enabled' | 'Faulted': Gets or set the job state. +* **status**: [JobStatus](#jobstatus) (ReadOnly) -## HttpAuthentication +## JobRecurrence ### Properties -* **type**: 'ActiveDirectoryOAuth' | 'Basic' | 'ClientCertificate' | 'NotSpecified': Gets or sets the http authentication type. +* **count**: int: Gets or sets the maximum number of times that the job should run. +* **endTime**: string: Gets or sets the time at which the job will complete. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). +* **interval**: int: Gets or sets the interval between retries. +* **schedule**: [JobRecurrenceSchedule](#jobrecurrenceschedule) -## HttpRequestHeaders +## JobRecurrenceSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hours**: int[]: Gets or sets the hours of the day that the job should execute at. +* **minutes**: int[]: Gets or sets the minutes of the hour that the job should execute at. +* **monthDays**: int[]: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [JobRecurrenceScheduleMonthlyOccurrence](#jobrecurrenceschedulemonthlyoccurrence)[]: Gets or sets the occurrences of days within a month. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Gets or sets the days of the week that the job should execute on. + +## JobRecurrenceScheduleMonthlyOccurrence +### Properties +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **Occurrence**: int: Gets or sets the occurrence. Must be between -5 and 5. + +## JobStatus +### Properties +* **executionCount**: int (ReadOnly): Gets the number of times this job has executed. +* **failureCount**: int (ReadOnly): Gets the number of times this job has failed. +* **faultedCount**: int (ReadOnly): Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). +* **lastExecutionTime**: string (ReadOnly): Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. +* **nextExecutionTime**: string (ReadOnly): Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ## RetryPolicy ### Properties @@ -103,16 +121,6 @@ * **retryInterval**: string: Gets or sets the retry interval between retries. * **retryType**: 'Fixed' | 'None': Gets or sets the retry strategy to be used. -## ServiceBusQueueMessage -### Properties -* **authentication**: [ServiceBusAuthentication](#servicebusauthentication) -* **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) -* **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. -* **message**: string: Gets or sets the message. -* **namespace**: string: Gets or sets the namespace. -* **queueName**: string: Gets or sets the queue name. -* **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. - ## ServiceBusAuthentication ### Properties * **sasKey**: string: Gets or sets the SAS key. @@ -140,47 +148,39 @@ ### Additional Properties * **Additional Properties Type**: string -## ServiceBusTopicMessage +## ServiceBusMessageCustomMessageProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServiceBusQueueMessage ### Properties * **authentication**: [ServiceBusAuthentication](#servicebusauthentication) * **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) * **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. * **message**: string: Gets or sets the message. * **namespace**: string: Gets or sets the namespace. -* **topicPath**: string: Gets or sets the topic path. +* **queueName**: string: Gets or sets the queue name. * **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. -## ServiceBusMessageCustomMessageProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## JobRecurrence -### Properties -* **count**: int: Gets or sets the maximum number of times that the job should run. -* **endTime**: string: Gets or sets the time at which the job will complete. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). -* **interval**: int: Gets or sets the interval between retries. -* **schedule**: [JobRecurrenceSchedule](#jobrecurrenceschedule) - -## JobRecurrenceSchedule +## ServiceBusTopicMessage ### Properties -* **hours**: int[]: Gets or sets the hours of the day that the job should execute at. -* **minutes**: int[]: Gets or sets the minutes of the hour that the job should execute at. -* **monthDays**: int[]: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [JobRecurrenceScheduleMonthlyOccurrence](#jobrecurrenceschedulemonthlyoccurrence)[]: Gets or sets the occurrences of days within a month. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Gets or sets the days of the week that the job should execute on. +* **authentication**: [ServiceBusAuthentication](#servicebusauthentication) +* **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) +* **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. +* **message**: string: Gets or sets the message. +* **namespace**: string: Gets or sets the namespace. +* **topicPath**: string: Gets or sets the topic path. +* **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. -## JobRecurrenceScheduleMonthlyOccurrence +## Sku ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **Occurrence**: int: Gets or sets the occurrence. Must be between -5 and 5. +* **name**: 'Free' | 'Premium' | 'Standard': Gets or set the SKU. -## JobStatus +## StorageQueueMessage ### Properties -* **executionCount**: int (ReadOnly): Gets the number of times this job has executed. -* **failureCount**: int (ReadOnly): Gets the number of times this job has failed. -* **faultedCount**: int (ReadOnly): Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). -* **lastExecutionTime**: string (ReadOnly): Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. -* **nextExecutionTime**: string (ReadOnly): Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. +* **message**: string: Gets or sets the message. +* **queueName**: string: Gets or sets the queue name. +* **sasToken**: string: Gets or sets the SAS key. +* **storageAccount**: string: Gets or sets the storage account name. diff --git a/generated/scheduler/microsoft.scheduler/2016-01-01/types.md b/generated/scheduler/microsoft.scheduler/2016-01-01/types.md index 7ad2ac381d..ef32bad1ae 100644 --- a/generated/scheduler/microsoft.scheduler/2016-01-01/types.md +++ b/generated/scheduler/microsoft.scheduler/2016-01-01/types.md @@ -20,40 +20,23 @@ * **properties**: [JobProperties](#jobproperties) * **type**: 'Microsoft.Scheduler/jobCollections/jobs' (ReadOnly, DeployTimeConstant): The resource type -## JobCollectionProperties -### Properties -* **quota**: [JobCollectionQuota](#jobcollectionquota) -* **sku**: [Sku](#sku) -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'Suspended': Gets or sets the state. - -## JobCollectionQuota -### Properties -* **maxJobCount**: int: Gets or set the maximum job count. -* **maxJobOccurrence**: int: Gets or sets the maximum job occurrence. -* **maxRecurrence**: [JobMaxRecurrence](#jobmaxrecurrence) - -## JobMaxRecurrence +## HttpAuthentication ### Properties -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). -* **interval**: int: Gets or sets the interval between retries. +* **type**: 'ActiveDirectoryOAuth' | 'Basic' | 'ClientCertificate' | 'NotSpecified': Gets or sets the http authentication type. -## Sku +## HttpRequest ### Properties -* **name**: 'Free' | 'Premium' | 'Standard': Gets or set the SKU. +* **authentication**: [HttpAuthentication](#httpauthentication) +* **body**: string: Gets or sets the request body. +* **headers**: [HttpRequestHeaders](#httprequestheaders): Gets or sets the headers. +* **method**: string: Gets or sets the method of the request. +* **uri**: string: Gets or sets the Uri. -## JobCollectionDefinitionTags +## HttpRequestHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## JobProperties -### Properties -* **action**: [JobAction](#jobaction) -* **recurrence**: [JobRecurrence](#jobrecurrence) -* **startTime**: string: Gets or sets the job start time. -* **state**: 'Completed' | 'Disabled' | 'Enabled' | 'Faulted': Gets or set the job state. -* **status**: [JobStatus](#jobstatus) (ReadOnly) - ## JobAction ### Properties * **errorAction**: [JobErrorAction](#joberroraction) @@ -64,6 +47,23 @@ * **serviceBusTopicMessage**: [ServiceBusTopicMessage](#servicebustopicmessage) * **type**: 'Http' | 'Https' | 'ServiceBusQueue' | 'ServiceBusTopic' | 'StorageQueue': Gets or sets the job action type. +## JobCollectionDefinitionTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## JobCollectionProperties +### Properties +* **quota**: [JobCollectionQuota](#jobcollectionquota) +* **sku**: [Sku](#sku) +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'Suspended': Gets or sets the state. + +## JobCollectionQuota +### Properties +* **maxJobCount**: int: Gets or set the maximum job count. +* **maxJobOccurrence**: int: Gets or sets the maximum job occurrence. +* **maxRecurrence**: [JobMaxRecurrence](#jobmaxrecurrence) + ## JobErrorAction ### Properties * **queueMessage**: [StorageQueueMessage](#storagequeuemessage) @@ -73,29 +73,47 @@ * **serviceBusTopicMessage**: [ServiceBusTopicMessage](#servicebustopicmessage) * **type**: 'Http' | 'Https' | 'ServiceBusQueue' | 'ServiceBusTopic' | 'StorageQueue': Gets or sets the job action type. -## StorageQueueMessage +## JobMaxRecurrence ### Properties -* **message**: string: Gets or sets the message. -* **queueName**: string: Gets or sets the queue name. -* **sasToken**: string: Gets or sets the SAS key. -* **storageAccount**: string: Gets or sets the storage account name. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). +* **interval**: int: Gets or sets the interval between retries. -## HttpRequest +## JobProperties ### Properties -* **authentication**: [HttpAuthentication](#httpauthentication) -* **body**: string: Gets or sets the request body. -* **headers**: [HttpRequestHeaders](#httprequestheaders): Gets or sets the headers. -* **method**: string: Gets or sets the method of the request. -* **uri**: string: Gets or sets the Uri. +* **action**: [JobAction](#jobaction) +* **recurrence**: [JobRecurrence](#jobrecurrence) +* **startTime**: string: Gets or sets the job start time. +* **state**: 'Completed' | 'Disabled' | 'Enabled' | 'Faulted': Gets or set the job state. +* **status**: [JobStatus](#jobstatus) (ReadOnly) -## HttpAuthentication +## JobRecurrence ### Properties -* **type**: 'ActiveDirectoryOAuth' | 'Basic' | 'ClientCertificate' | 'NotSpecified': Gets or sets the http authentication type. +* **count**: int: Gets or sets the maximum number of times that the job should run. +* **endTime**: string: Gets or sets the time at which the job will complete. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). +* **interval**: int: Gets or sets the interval between retries. +* **schedule**: [JobRecurrenceSchedule](#jobrecurrenceschedule) -## HttpRequestHeaders +## JobRecurrenceSchedule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hours**: int[]: Gets or sets the hours of the day that the job should execute at. +* **minutes**: int[]: Gets or sets the minutes of the hour that the job should execute at. +* **monthDays**: int[]: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [JobRecurrenceScheduleMonthlyOccurrence](#jobrecurrenceschedulemonthlyoccurrence)[]: Gets or sets the occurrences of days within a month. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Gets or sets the days of the week that the job should execute on. + +## JobRecurrenceScheduleMonthlyOccurrence +### Properties +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **Occurrence**: int: Gets or sets the occurrence. Must be between -5 and 5. + +## JobStatus +### Properties +* **executionCount**: int (ReadOnly): Gets the number of times this job has executed. +* **failureCount**: int (ReadOnly): Gets the number of times this job has failed. +* **faultedCount**: int (ReadOnly): Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). +* **lastExecutionTime**: string (ReadOnly): Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. +* **nextExecutionTime**: string (ReadOnly): Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ## RetryPolicy ### Properties @@ -103,16 +121,6 @@ * **retryInterval**: string: Gets or sets the retry interval between retries. * **retryType**: 'Fixed' | 'None': Gets or sets the retry strategy to be used. -## ServiceBusQueueMessage -### Properties -* **authentication**: [ServiceBusAuthentication](#servicebusauthentication) -* **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) -* **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. -* **message**: string: Gets or sets the message. -* **namespace**: string: Gets or sets the namespace. -* **queueName**: string: Gets or sets the queue name. -* **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. - ## ServiceBusAuthentication ### Properties * **sasKey**: string: Gets or sets the SAS key. @@ -140,47 +148,39 @@ ### Additional Properties * **Additional Properties Type**: string -## ServiceBusTopicMessage +## ServiceBusMessageCustomMessageProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServiceBusQueueMessage ### Properties * **authentication**: [ServiceBusAuthentication](#servicebusauthentication) * **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) * **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. * **message**: string: Gets or sets the message. * **namespace**: string: Gets or sets the namespace. -* **topicPath**: string: Gets or sets the topic path. +* **queueName**: string: Gets or sets the queue name. * **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. -## ServiceBusMessageCustomMessageProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## JobRecurrence -### Properties -* **count**: int: Gets or sets the maximum number of times that the job should run. -* **endTime**: string: Gets or sets the time at which the job will complete. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). -* **interval**: int: Gets or sets the interval between retries. -* **schedule**: [JobRecurrenceSchedule](#jobrecurrenceschedule) - -## JobRecurrenceSchedule +## ServiceBusTopicMessage ### Properties -* **hours**: int[]: Gets or sets the hours of the day that the job should execute at. -* **minutes**: int[]: Gets or sets the minutes of the hour that the job should execute at. -* **monthDays**: int[]: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [JobRecurrenceScheduleMonthlyOccurrence](#jobrecurrenceschedulemonthlyoccurrence)[]: Gets or sets the occurrences of days within a month. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Gets or sets the days of the week that the job should execute on. +* **authentication**: [ServiceBusAuthentication](#servicebusauthentication) +* **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) +* **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. +* **message**: string: Gets or sets the message. +* **namespace**: string: Gets or sets the namespace. +* **topicPath**: string: Gets or sets the topic path. +* **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. -## JobRecurrenceScheduleMonthlyOccurrence +## Sku ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **Occurrence**: int: Gets or sets the occurrence. Must be between -5 and 5. +* **name**: 'Free' | 'Premium' | 'Standard': Gets or set the SKU. -## JobStatus +## StorageQueueMessage ### Properties -* **executionCount**: int (ReadOnly): Gets the number of times this job has executed. -* **failureCount**: int (ReadOnly): Gets the number of times this job has failed. -* **faultedCount**: int (ReadOnly): Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). -* **lastExecutionTime**: string (ReadOnly): Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. -* **nextExecutionTime**: string (ReadOnly): Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. +* **message**: string: Gets or sets the message. +* **queueName**: string: Gets or sets the queue name. +* **sasToken**: string: Gets or sets the SAS key. +* **storageAccount**: string: Gets or sets the storage account name. diff --git a/generated/scheduler/microsoft.scheduler/2016-03-01/types.md b/generated/scheduler/microsoft.scheduler/2016-03-01/types.md index 1107817fee..18278c66f4 100644 --- a/generated/scheduler/microsoft.scheduler/2016-03-01/types.md +++ b/generated/scheduler/microsoft.scheduler/2016-03-01/types.md @@ -20,40 +20,47 @@ * **properties**: [JobProperties](#jobproperties) * **type**: 'Microsoft.Scheduler/jobCollections/jobs' (ReadOnly, DeployTimeConstant): The resource type -## JobCollectionProperties -### Properties -* **quota**: [JobCollectionQuota](#jobcollectionquota) -* **sku**: [Sku](#sku) -* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'Suspended': Gets or sets the state. +## HttpAuthentication +* **Discriminator**: type -## JobCollectionQuota -### Properties -* **maxJobCount**: int: Gets or set the maximum job count. -* **maxJobOccurrence**: int: Gets or sets the maximum job occurrence. -* **maxRecurrence**: [JobMaxRecurrence](#jobmaxrecurrence) +### Base Properties +### OAuthAuthentication +#### Properties +* **audience**: string: Gets or sets the audience. +* **clientId**: string: Gets or sets the client identifier. +* **secret**: string: Gets or sets the secret, return value will always be empty. +* **tenant**: string: Gets or sets the tenant. +* **type**: 'ActiveDirectoryOAuth' (Required): Gets or sets the HTTP authentication type. -## JobMaxRecurrence -### Properties -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). -* **interval**: int: Gets or sets the interval between retries. +### BasicAuthentication +#### Properties +* **password**: string: Gets or sets the password, return value will always be empty. +* **type**: 'Basic' (Required): Gets or sets the HTTP authentication type. +* **username**: string: Gets or sets the username. -## Sku +### ClientCertAuthentication +#### Properties +* **certificateExpirationDate**: string: Gets or sets the certificate expiration date. +* **certificateSubjectName**: string: Gets or sets the certificate subject name. +* **certificateThumbprint**: string: Gets or sets the certificate thumbprint. +* **password**: string: Gets or sets the certificate password, return value will always be empty. +* **pfx**: string: Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty. +* **type**: 'ClientCertificate' (Required): Gets or sets the HTTP authentication type. + + +## HttpRequest ### Properties -* **name**: 'Free' | 'P10Premium' | 'P20Premium' | 'Standard': Gets or set the SKU. +* **authentication**: [HttpAuthentication](#httpauthentication) +* **body**: string: Gets or sets the request body. +* **headers**: [HttpRequestHeaders](#httprequestheaders): Gets or sets the headers. +* **method**: string: Gets or sets the method of the request. +* **uri**: string: Gets or sets the URI of the request. -## JobCollectionDefinitionTags +## HttpRequestHeaders ### Properties ### Additional Properties * **Additional Properties Type**: string -## JobProperties -### Properties -* **action**: [JobAction](#jobaction) -* **recurrence**: [JobRecurrence](#jobrecurrence) -* **startTime**: string: Gets or sets the job start time. -* **state**: 'Completed' | 'Disabled' | 'Enabled' | 'Faulted': Gets or set the job state. -* **status**: [JobStatus](#jobstatus) (ReadOnly) - ## JobAction ### Properties * **errorAction**: [JobErrorAction](#joberroraction) @@ -64,6 +71,23 @@ * **serviceBusTopicMessage**: [ServiceBusTopicMessage](#servicebustopicmessage) * **type**: 'Http' | 'Https' | 'ServiceBusQueue' | 'ServiceBusTopic' | 'StorageQueue': Gets or sets the job action type. +## JobCollectionDefinitionTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## JobCollectionProperties +### Properties +* **quota**: [JobCollectionQuota](#jobcollectionquota) +* **sku**: [Sku](#sku) +* **state**: 'Deleted' | 'Disabled' | 'Enabled' | 'Suspended': Gets or sets the state. + +## JobCollectionQuota +### Properties +* **maxJobCount**: int: Gets or set the maximum job count. +* **maxJobOccurrence**: int: Gets or sets the maximum job occurrence. +* **maxRecurrence**: [JobMaxRecurrence](#jobmaxrecurrence) + ## JobErrorAction ### Properties * **queueMessage**: [StorageQueueMessage](#storagequeuemessage) @@ -73,53 +97,47 @@ * **serviceBusTopicMessage**: [ServiceBusTopicMessage](#servicebustopicmessage) * **type**: 'Http' | 'Https' | 'ServiceBusQueue' | 'ServiceBusTopic' | 'StorageQueue': Gets or sets the job action type. -## StorageQueueMessage +## JobMaxRecurrence ### Properties -* **message**: string: Gets or sets the message. -* **queueName**: string: Gets or sets the queue name. -* **sasToken**: string: Gets or sets the SAS key. -* **storageAccount**: string: Gets or sets the storage account name. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). +* **interval**: int: Gets or sets the interval between retries. -## HttpRequest +## JobProperties ### Properties -* **authentication**: [HttpAuthentication](#httpauthentication) -* **body**: string: Gets or sets the request body. -* **headers**: [HttpRequestHeaders](#httprequestheaders): Gets or sets the headers. -* **method**: string: Gets or sets the method of the request. -* **uri**: string: Gets or sets the URI of the request. - -## HttpAuthentication -* **Discriminator**: type - -### Base Properties -### OAuthAuthentication -#### Properties -* **audience**: string: Gets or sets the audience. -* **clientId**: string: Gets or sets the client identifier. -* **secret**: string: Gets or sets the secret, return value will always be empty. -* **tenant**: string: Gets or sets the tenant. -* **type**: 'ActiveDirectoryOAuth' (Required): Gets or sets the HTTP authentication type. +* **action**: [JobAction](#jobaction) +* **recurrence**: [JobRecurrence](#jobrecurrence) +* **startTime**: string: Gets or sets the job start time. +* **state**: 'Completed' | 'Disabled' | 'Enabled' | 'Faulted': Gets or set the job state. +* **status**: [JobStatus](#jobstatus) (ReadOnly) -### BasicAuthentication -#### Properties -* **password**: string: Gets or sets the password, return value will always be empty. -* **type**: 'Basic' (Required): Gets or sets the HTTP authentication type. -* **username**: string: Gets or sets the username. +## JobRecurrence +### Properties +* **count**: int: Gets or sets the maximum number of times that the job should run. +* **endTime**: string: Gets or sets the time at which the job will complete. +* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). +* **interval**: int: Gets or sets the interval between retries. +* **schedule**: [JobRecurrenceSchedule](#jobrecurrenceschedule) -### ClientCertAuthentication -#### Properties -* **certificateExpirationDate**: string: Gets or sets the certificate expiration date. -* **certificateSubjectName**: string: Gets or sets the certificate subject name. -* **certificateThumbprint**: string: Gets or sets the certificate thumbprint. -* **password**: string: Gets or sets the certificate password, return value will always be empty. -* **pfx**: string: Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty. -* **type**: 'ClientCertificate' (Required): Gets or sets the HTTP authentication type. +## JobRecurrenceSchedule +### Properties +* **hours**: int[]: Gets or sets the hours of the day that the job should execute at. +* **minutes**: int[]: Gets or sets the minutes of the hour that the job should execute at. +* **monthDays**: int[]: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. +* **monthlyOccurrences**: [JobRecurrenceScheduleMonthlyOccurrence](#jobrecurrenceschedulemonthlyoccurrence)[]: Gets or sets the occurrences of days within a month. +* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Gets or sets the days of the week that the job should execute on. +## JobRecurrenceScheduleMonthlyOccurrence +### Properties +* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* **Occurrence**: int: Gets or sets the occurrence. Must be between -5 and 5. -## HttpRequestHeaders +## JobStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **executionCount**: int (ReadOnly): Gets the number of times this job has executed. +* **failureCount**: int (ReadOnly): Gets the number of times this job has failed. +* **faultedCount**: int (ReadOnly): Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). +* **lastExecutionTime**: string (ReadOnly): Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. +* **nextExecutionTime**: string (ReadOnly): Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. ## RetryPolicy ### Properties @@ -127,16 +145,6 @@ * **retryInterval**: string: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. * **retryType**: 'Fixed' | 'None': Gets or sets the retry strategy to be used. -## ServiceBusQueueMessage -### Properties -* **authentication**: [ServiceBusAuthentication](#servicebusauthentication) -* **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) -* **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. -* **message**: string: Gets or sets the message. -* **namespace**: string: Gets or sets the namespace. -* **queueName**: string: Gets or sets the queue name. -* **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. - ## ServiceBusAuthentication ### Properties * **sasKey**: string: Gets or sets the SAS key. @@ -164,47 +172,39 @@ ### Additional Properties * **Additional Properties Type**: string -## ServiceBusTopicMessage +## ServiceBusMessageCustomMessageProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ServiceBusQueueMessage ### Properties * **authentication**: [ServiceBusAuthentication](#servicebusauthentication) * **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) * **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. * **message**: string: Gets or sets the message. * **namespace**: string: Gets or sets the namespace. -* **topicPath**: string: Gets or sets the topic path. +* **queueName**: string: Gets or sets the queue name. * **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. -## ServiceBusMessageCustomMessageProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## JobRecurrence -### Properties -* **count**: int: Gets or sets the maximum number of times that the job should run. -* **endTime**: string: Gets or sets the time at which the job will complete. -* **frequency**: 'Day' | 'Hour' | 'Minute' | 'Month' | 'Week': Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). -* **interval**: int: Gets or sets the interval between retries. -* **schedule**: [JobRecurrenceSchedule](#jobrecurrenceschedule) - -## JobRecurrenceSchedule +## ServiceBusTopicMessage ### Properties -* **hours**: int[]: Gets or sets the hours of the day that the job should execute at. -* **minutes**: int[]: Gets or sets the minutes of the hour that the job should execute at. -* **monthDays**: int[]: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. -* **monthlyOccurrences**: [JobRecurrenceScheduleMonthlyOccurrence](#jobrecurrenceschedulemonthlyoccurrence)[]: Gets or sets the occurrences of days within a month. -* **weekDays**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: Gets or sets the days of the week that the job should execute on. +* **authentication**: [ServiceBusAuthentication](#servicebusauthentication) +* **brokeredMessageProperties**: [ServiceBusBrokeredMessageProperties](#servicebusbrokeredmessageproperties) +* **customMessageProperties**: [ServiceBusMessageCustomMessageProperties](#servicebusmessagecustommessageproperties): Gets or sets the custom message properties. +* **message**: string: Gets or sets the message. +* **namespace**: string: Gets or sets the namespace. +* **topicPath**: string: Gets or sets the topic path. +* **transportType**: 'AMQP' | 'NetMessaging' | 'NotSpecified': Gets or sets the transport type. -## JobRecurrenceScheduleMonthlyOccurrence +## Sku ### Properties -* **day**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. -* **Occurrence**: int: Gets or sets the occurrence. Must be between -5 and 5. +* **name**: 'Free' | 'P10Premium' | 'P20Premium' | 'Standard': Gets or set the SKU. -## JobStatus +## StorageQueueMessage ### Properties -* **executionCount**: int (ReadOnly): Gets the number of times this job has executed. -* **failureCount**: int (ReadOnly): Gets the number of times this job has failed. -* **faultedCount**: int (ReadOnly): Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). -* **lastExecutionTime**: string (ReadOnly): Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. -* **nextExecutionTime**: string (ReadOnly): Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. +* **message**: string: Gets or sets the message. +* **queueName**: string: Gets or sets the queue name. +* **sasToken**: string: Gets or sets the SAS key. +* **storageAccount**: string: Gets or sets the storage account name. diff --git a/generated/scvmm/log.out b/generated/scvmm/log.out index 27fb4f5e11..f84fdc2a77 100644 --- a/generated/scvmm/log.out +++ b/generated/scvmm/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.scvmm-2020-06-05-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 16ms diff --git a/generated/scvmm/microsoft.scvmm/2020-06-05-preview/types.md b/generated/scvmm/microsoft.scvmm/2020-06-05-preview/types.md index 4f0b19fed9..72af4ecfdd 100644 --- a/generated/scvmm/microsoft.scvmm/2020-06-05-preview/types.md +++ b/generated/scvmm/microsoft.scvmm/2020-06-05-preview/types.md @@ -89,10 +89,10 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.ScVmm/vmmServers/inventoryItems' (ReadOnly, DeployTimeConstant): The resource type -## ExtendedLocation +## AvailabilitySetListItem ### Properties -* **name**: string: The extended location name. -* **type**: string: The extended location type. +* **id**: string: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. +* **name**: string: Gets or sets the name of the availability set. ## AvailabilitySetProperties ### Properties @@ -100,29 +100,17 @@ * **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. * **vmmServerId**: string: ARM Id of the vmmServer resource in which this resource resides. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## AvailabilitySetTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CloudProperties +## Checkpoint ### Properties -* **cloudCapacity**: [CloudCapacity](#cloudcapacity) (ReadOnly): Cloud Capacity model -* **cloudName**: string (ReadOnly): Name of the cloud in VMMServer. -* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. -* **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. -* **storageQoSPolicies**: [StorageQoSPolicy](#storageqospolicy)[] (ReadOnly): List of QoS policies available for the cloud. -* **uuid**: string: Unique ID of the cloud. -* **vmmServerId**: string: ARM Id of the vmmServer resource in which this resource resides. +* **checkpointID**: string: Gets ID of the checkpoint. +* **description**: string: Gets description of the checkpoint. +* **name**: string: Gets name of the checkpoint. +* **parentCheckpointID**: string: Gets ID of parent of the checkpoint. ## CloudCapacity ### Properties @@ -130,50 +118,25 @@ * **memoryMB**: int: MemoryMB specifies a memory usage limit in megabytes. * **vmCount**: int: VMCount gives the max number of VMs that can be deployed in the cloud. -## StorageQoSPolicy -### Properties -* **bandwidthLimit**: int: The Bandwidth Limit for internet traffic. -* **id**: string: The ID of the QoS policy. -* **iopsMaximum**: int: The maximum IO operations per second. -* **iopsMinimum**: int: The minimum IO operations per second. -* **name**: string: The name of the policy. -* **policyId**: string: The underlying policy. - -## CloudTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## VirtualMachineProperties +## CloudProperties ### Properties -* **availabilitySets**: [AvailabilitySetListItem](#availabilitysetlistitem)[]: Availability Sets in vm. -* **checkpoints**: [Checkpoint](#checkpoint)[]: Checkpoints in the vm. -* **checkpointType**: string: Type of checkpoint supported for the vm. -* **cloudId**: string: ARM Id of the cloud resource to use for deploying the vm. -* **generation**: int: Gets or sets the generation for the vm. -* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Defines the resource properties. +* **cloudCapacity**: [CloudCapacity](#cloudcapacity) (ReadOnly): Cloud Capacity model +* **cloudName**: string (ReadOnly): Name of the cloud in VMMServer. * **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. -* **networkProfile**: [NetworkProfile](#networkprofile): Defines the resource properties. -* **osProfile**: [OsProfile](#osprofile): Defines the resource properties. -* **powerState**: string (ReadOnly): Gets the power state of the virtual machine. * **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. -* **storageProfile**: [StorageProfile](#storageprofile): Defines the resource properties. -* **templateId**: string: ARM Id of the template resource to use for deploying the vm. -* **uuid**: string: Unique ID of the virtual machine. +* **storageQoSPolicies**: [StorageQoSPolicy](#storageqospolicy)[] (ReadOnly): List of QoS policies available for the cloud. +* **uuid**: string: Unique ID of the cloud. * **vmmServerId**: string: ARM Id of the vmmServer resource in which this resource resides. -* **vmName**: string: VMName is the name of VM on the SCVMM server. -## AvailabilitySetListItem +## CloudTags ### Properties -* **id**: string: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. -* **name**: string: Gets or sets the name of the availability set. +### Additional Properties +* **Additional Properties Type**: string -## Checkpoint +## ExtendedLocation ### Properties -* **checkpointID**: string: Gets ID of the checkpoint. -* **description**: string: Gets description of the checkpoint. -* **name**: string: Gets name of the checkpoint. -* **parentCheckpointID**: string: Gets ID of parent of the checkpoint. +* **name**: string: The extended location name. +* **type**: string: The extended location type. ## HardwareProfile ### Properties @@ -185,9 +148,44 @@ * **limitCpuForMigration**: 'false' | 'true' | string: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. * **memoryMB**: int: MemoryMB is the size of a virtual machine's memory, in MB. -## NetworkProfile +## InventoryItemDetails ### Properties -* **networkInterfaces**: [NetworkInterfaces](#networkinterfaces)[]: Gets or sets the list of network interfaces associated with the virtual machine. +* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. +* **inventoryItemName**: string: Gets or sets the Managed Object name in VMM for the resource. + +## InventoryItemProperties +* **Discriminator**: inventoryType + +### Base Properties +* **inventoryItemName**: string (ReadOnly): Gets the Managed Object name in VMM for the inventory item. +* **managedResourceId**: string (ReadOnly): Gets the tracked resource id corresponding to the inventory resource. +* **provisioningState**: string (ReadOnly): Gets the provisioning state. +* **uuid**: string (ReadOnly): Gets the UUID (which is assigned by VMM) for the inventory item. +### CloudInventoryItem +#### Properties +* **inventoryType**: 'Cloud' (Required): They inventory type. + +### VirtualMachineInventoryItem +#### Properties +* **cloud**: [InventoryItemDetails](#inventoryitemdetails): Defines the resource properties. +* **inventoryType**: 'VirtualMachine' (Required): They inventory type. +* **ipAddresses**: string[]: Gets or sets the nic ip addresses. +* **osName**: string (ReadOnly): Gets or sets os name. +* **osType**: 'Linux' | 'Other' | 'Windows' | string (ReadOnly): Defines the different types of VM guest operating systems. +* **powerState**: string (ReadOnly): Gets the power state of the virtual machine. + +### VirtualMachineTemplateInventoryItem +#### Properties +* **cpuCount**: int (ReadOnly): Gets or sets the desired number of vCPUs for the vm. +* **inventoryType**: 'VirtualMachineTemplate' (Required): They inventory type. +* **memoryMB**: int (ReadOnly): MemoryMB is the desired size of a virtual machine's memory, in MB. +* **osName**: string (ReadOnly): Gets or sets os name. +* **osType**: 'Linux' | 'Other' | 'Windows' | string (ReadOnly): Defines the different types of VM guest operating systems. + +### VirtualNetworkInventoryItem +#### Properties +* **inventoryType**: 'VirtualNetwork' (Required): They inventory type. + ## NetworkInterfaces ### Properties @@ -203,6 +201,10 @@ * **nicId**: string: Gets or sets the nic id. * **virtualNetworkId**: string: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. +## NetworkProfile +### Properties +* **networkInterfaces**: [NetworkInterfaces](#networkinterfaces)[]: Gets or sets the list of network interfaces associated with the virtual machine. + ## OsProfile ### Properties * **adminPassword**: string (WriteOnly): Admin password of the virtual machine. @@ -214,6 +216,29 @@ ### Properties * **disks**: [VirtualDisk](#virtualdisk)[]: Gets or sets the list of virtual disks associated with the virtual machine. +## StorageQoSPolicy +### Properties +* **bandwidthLimit**: int: The Bandwidth Limit for internet traffic. +* **id**: string: The ID of the QoS policy. +* **iopsMaximum**: int: The maximum IO operations per second. +* **iopsMinimum**: int: The minimum IO operations per second. +* **name**: string: The name of the policy. +* **policyId**: string: The underlying policy. + +## StorageQoSPolicyDetails +### Properties +* **id**: string: The ID of the QoS policy. +* **name**: string: The name of the policy. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## VirtualDisk ### Properties * **bus**: int: Gets or sets the disk bus. @@ -231,10 +256,24 @@ * **vhdType**: string: Gets or sets the disk vhd type. * **volumeType**: string (ReadOnly): Gets or sets the disk volume type. -## StorageQoSPolicyDetails +## VirtualMachineProperties ### Properties -* **id**: string: The ID of the QoS policy. -* **name**: string: The name of the policy. +* **availabilitySets**: [AvailabilitySetListItem](#availabilitysetlistitem)[]: Availability Sets in vm. +* **checkpoints**: [Checkpoint](#checkpoint)[]: Checkpoints in the vm. +* **checkpointType**: string: Type of checkpoint supported for the vm. +* **cloudId**: string: ARM Id of the cloud resource to use for deploying the vm. +* **generation**: int: Gets or sets the generation for the vm. +* **hardwareProfile**: [HardwareProfile](#hardwareprofile): Defines the resource properties. +* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. +* **networkProfile**: [NetworkProfile](#networkprofile): Defines the resource properties. +* **osProfile**: [OsProfile](#osprofile): Defines the resource properties. +* **powerState**: string (ReadOnly): Gets the power state of the virtual machine. +* **provisioningState**: string (ReadOnly): Gets or sets the provisioning state. +* **storageProfile**: [StorageProfile](#storageprofile): Defines the resource properties. +* **templateId**: string: ARM Id of the template resource to use for deploying the vm. +* **uuid**: string: Unique ID of the virtual machine. +* **vmmServerId**: string: ARM Id of the vmmServer resource in which this resource resides. +* **vmName**: string: VMName is the name of VM on the SCVMM server. ## VirtualMachineTags ### Properties @@ -301,42 +340,3 @@ ### Additional Properties * **Additional Properties Type**: string -## InventoryItemProperties -* **Discriminator**: inventoryType - -### Base Properties -* **inventoryItemName**: string (ReadOnly): Gets the Managed Object name in VMM for the inventory item. -* **managedResourceId**: string (ReadOnly): Gets the tracked resource id corresponding to the inventory resource. -* **provisioningState**: string (ReadOnly): Gets the provisioning state. -* **uuid**: string (ReadOnly): Gets the UUID (which is assigned by VMM) for the inventory item. -### CloudInventoryItem -#### Properties -* **inventoryType**: 'Cloud' (Required): They inventory type. - -### VirtualMachineInventoryItem -#### Properties -* **cloud**: [InventoryItemDetails](#inventoryitemdetails): Defines the resource properties. -* **inventoryType**: 'VirtualMachine' (Required): They inventory type. -* **ipAddresses**: string[]: Gets or sets the nic ip addresses. -* **osName**: string (ReadOnly): Gets or sets os name. -* **osType**: 'Linux' | 'Other' | 'Windows' | string (ReadOnly): Defines the different types of VM guest operating systems. -* **powerState**: string (ReadOnly): Gets the power state of the virtual machine. - -### VirtualMachineTemplateInventoryItem -#### Properties -* **cpuCount**: int (ReadOnly): Gets or sets the desired number of vCPUs for the vm. -* **inventoryType**: 'VirtualMachineTemplate' (Required): They inventory type. -* **memoryMB**: int (ReadOnly): MemoryMB is the desired size of a virtual machine's memory, in MB. -* **osName**: string (ReadOnly): Gets or sets os name. -* **osType**: 'Linux' | 'Other' | 'Windows' | string (ReadOnly): Defines the different types of VM guest operating systems. - -### VirtualNetworkInventoryItem -#### Properties -* **inventoryType**: 'VirtualNetwork' (Required): They inventory type. - - -## InventoryItemDetails -### Properties -* **inventoryItemId**: string: Gets or sets the inventory Item ID for the resource. -* **inventoryItemName**: string: Gets or sets the Managed Object name in VMM for the resource. - diff --git a/generated/search/log.out b/generated/search/log.out index 2527575c08..cc91f919fb 100644 --- a/generated/search/log.out +++ b/generated/search/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.search-2020-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json:1271:5 @@ -59,10 +59,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/stable/2020-08-01/search.json:1929:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 17ms +info | autorest.bicep took 20ms info | Processing batch task - {"tag":"microsoft.search-2020-03-13"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/stable/2020-03-13/search.json:1042:5 @@ -108,7 +108,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.search-2015-08-19"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json:817:5 @@ -136,7 +136,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.search-2015-02-28"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/stable/2015-02-28/search.json:260:5 @@ -164,7 +164,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.search-2021-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/search.json:1343:5 @@ -237,7 +237,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.search-2020-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2020-08-01-preview/search.json:1271:5 @@ -290,10 +290,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2020-08-01-preview/search.json:1929:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.search-2019-10-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdminKeyResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2019-10-01-preview/search.json:1036:5 @@ -337,4 +337,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Identity' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/search/resource-manager/Microsoft.Search/preview/2019-10-01-preview/search.json:1549:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 17.23s. 14 files generated. +info | Autorest completed in 16.89s. 14 files generated. diff --git a/generated/search/microsoft.search/2015-02-28/types.md b/generated/search/microsoft.search/2015-02-28/types.md index dd3f793424..303d3d0b61 100644 --- a/generated/search/microsoft.search/2015-02-28/types.md +++ b/generated/search/microsoft.search/2015-02-28/types.md @@ -16,6 +16,16 @@ * **ApiVersion**: 2015-02-28 * **Output**: [AdminKeyResult](#adminkeyresult) +## AdminKeyResult +### Properties +* **primaryKey**: string (ReadOnly): The primary API key of the Search service. +* **secondaryKey**: string (ReadOnly): The secondary API key of the Search service. + +## SearchServiceCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SearchServiceProperties ### Properties * **partitionCount**: int: The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. @@ -26,13 +36,3 @@ ### Properties * **name**: 'free' | 'standard' | 'standard2': The SKU of the Search service. -## SearchServiceCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary API key of the Search service. -* **secondaryKey**: string (ReadOnly): The secondary API key of the Search service. - diff --git a/generated/search/microsoft.search/2015-08-19/types.md b/generated/search/microsoft.search/2015-08-19/types.md index 3058c08963..4798b0759a 100644 --- a/generated/search/microsoft.search/2015-08-19/types.md +++ b/generated/search/microsoft.search/2015-08-19/types.md @@ -23,41 +23,41 @@ * **ApiVersion**: 2015-08-19 * **Output**: [ListQueryKeysResult](#listquerykeysresult) +## AdminKeyResult +### Properties +* **primaryKey**: string (ReadOnly): The primary admin API key of the Search service. +* **secondaryKey**: string (ReadOnly): The secondary admin API key of the Search service. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'None' | 'SystemAssigned' (Required): The identity type. -## SearchServiceProperties +## ListQueryKeysResult ### Properties -* **hostingMode**: 'default' | 'highDensity': 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'. -* **partitionCount**: int: 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. -* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up. -* **replicaCount**: int: 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. -* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the Search service. Possible values include: 'running': The Search service is running and no provisioning operations are underway. 'provisioning': The Search service is being provisioned or scaled up or down. 'deleting': The Search service is being deleted. 'degraded': The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The Search service is disabled. In this state, the service will reject all API requests. 'error': The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. -* **statusDetails**: string (ReadOnly): The details of the Search service status. +* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. -## Sku +## QueryKey ### Properties -* **name**: 'basic' | 'free' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2': 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.' +* **key**: string (ReadOnly): The value of the query API key. +* **name**: string (ReadOnly): The name of the query API key; may be empty. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary admin API key of the Search service. -* **secondaryKey**: string (ReadOnly): The secondary admin API key of the Search service. - -## ListQueryKeysResult +## SearchServiceProperties ### Properties -* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. +* **hostingMode**: 'default' | 'highDensity': 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'. +* **partitionCount**: int: 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. +* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up. +* **replicaCount**: int: 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. +* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the Search service. Possible values include: 'running': The Search service is running and no provisioning operations are underway. 'provisioning': The Search service is being provisioned or scaled up or down. 'deleting': The Search service is being deleted. 'degraded': The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The Search service is disabled. In this state, the service will reject all API requests. 'error': The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. +* **statusDetails**: string (ReadOnly): The details of the Search service status. -## QueryKey +## Sku ### Properties -* **key**: string (ReadOnly): The value of the query API key. -* **name**: string (ReadOnly): The name of the query API key; may be empty. +* **name**: 'basic' | 'free' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2': 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.' diff --git a/generated/search/microsoft.search/2019-10-01-preview/types.md b/generated/search/microsoft.search/2019-10-01-preview/types.md index 077b0c1d11..5be4de86c9 100644 --- a/generated/search/microsoft.search/2019-10-01-preview/types.md +++ b/generated/search/microsoft.search/2019-10-01-preview/types.md @@ -32,32 +32,30 @@ * **ApiVersion**: 2019-10-01-preview * **Output**: [ListQueryKeysResult](#listquerykeysresult) +## AdminKeyResult +### Properties +* **primaryKey**: string (ReadOnly): The primary admin API key of the Search service. +* **secondaryKey**: string (ReadOnly): The secondary admin API key of the Search service. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'None' | 'SystemAssigned' (Required): The identity type. -## SearchServiceProperties +## IpRule ### Properties -* **hostingMode**: 'default' | 'highDensity': 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'. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. -* **partitionCount**: int: 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. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. -* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up. -* **replicaCount**: int: 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. -* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the Search service. Possible values include: 'running': The Search service is running and no provisioning operations are underway. 'provisioning': The Search service is being provisioned or scaled up or down. 'deleting': The Search service is being deleted. 'degraded': The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The Search service is disabled. In this state, the service will reject all API requests. 'error': The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. -* **statusDetails**: string (ReadOnly): The details of the Search service status. +* **value**: string: 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. + +## ListQueryKeysResult +### Properties +* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. ## NetworkRuleSet ### Properties * **endpointAccess**: 'Private' | 'Public': 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. * **ipRules**: [IpRule](#iprule)[]: 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. -## IpRule -### Properties -* **value**: string: 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. - ## PrivateEndpointConnection ### Properties * **id**: string: The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together. @@ -80,26 +78,28 @@ * **description**: string: The description for the private link service connection state. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected': Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. -## Sku +## QueryKey ### Properties -* **name**: 'basic' | 'free' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2': 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.' +* **key**: string (ReadOnly): The value of the query API key. +* **name**: string (ReadOnly): The name of the query API key; may be empty. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary admin API key of the Search service. -* **secondaryKey**: string (ReadOnly): The secondary admin API key of the Search service. - -## ListQueryKeysResult +## SearchServiceProperties ### Properties -* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. +* **hostingMode**: 'default' | 'highDensity': 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'. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. +* **partitionCount**: int: 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. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. +* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up. +* **replicaCount**: int: 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. +* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the Search service. Possible values include: 'running': The Search service is running and no provisioning operations are underway. 'provisioning': The Search service is being provisioned or scaled up or down. 'deleting': The Search service is being deleted. 'degraded': The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The Search service is disabled. In this state, the service will reject all API requests. 'error': The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. +* **statusDetails**: string (ReadOnly): The details of the Search service status. -## QueryKey +## Sku ### Properties -* **key**: string (ReadOnly): The value of the query API key. -* **name**: string (ReadOnly): The name of the query API key; may be empty. +* **name**: 'basic' | 'free' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2': 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.' diff --git a/generated/search/microsoft.search/2020-03-13/types.md b/generated/search/microsoft.search/2020-03-13/types.md index 2b1d440eb4..9d422cac1c 100644 --- a/generated/search/microsoft.search/2020-03-13/types.md +++ b/generated/search/microsoft.search/2020-03-13/types.md @@ -32,31 +32,29 @@ * **ApiVersion**: 2020-03-13 * **Output**: [ListQueryKeysResult](#listquerykeysresult) +## AdminKeyResult +### Properties +* **primaryKey**: string (ReadOnly): The primary admin API key of the Search service. +* **secondaryKey**: string (ReadOnly): The secondary admin API key of the Search service. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'None' | 'SystemAssigned' (Required): The identity type. -## SearchServiceProperties +## IpRule ### Properties -* **hostingMode**: 'default' | 'highDensity': 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'. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. -* **partitionCount**: int: 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. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. -* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up. -* **publicNetworkAccess**: 'disabled' | 'enabled': 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. -* **replicaCount**: int: 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. -* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the Search service. Possible values include: 'running': The Search service is running and no provisioning operations are underway. 'provisioning': The Search service is being provisioned or scaled up or down. 'deleting': The Search service is being deleted. 'degraded': The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The Search service is disabled. In this state, the service will reject all API requests. 'error': The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. -* **statusDetails**: string (ReadOnly): The details of the Search service status. +* **value**: string: 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. -## NetworkRuleSet +## ListQueryKeysResult ### Properties -* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. +* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. +* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. -## IpRule +## NetworkRuleSet ### Properties -* **value**: string: 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. +* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. ## PrivateEndpointConnection ### Properties @@ -80,27 +78,29 @@ * **description**: string: The description for the private link service connection state. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected': Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. -## Sku +## QueryKey ### Properties -* **name**: 'basic' | 'free' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2': 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.' +* **key**: string (ReadOnly): The value of the query API key. +* **name**: string (ReadOnly): The name of the query API key; may be empty. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary admin API key of the Search service. -* **secondaryKey**: string (ReadOnly): The secondary admin API key of the Search service. - -## ListQueryKeysResult +## SearchServiceProperties ### Properties -* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. -* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. +* **hostingMode**: 'default' | 'highDensity': 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'. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. +* **partitionCount**: int: 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. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. +* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up. +* **publicNetworkAccess**: 'disabled' | 'enabled': 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. +* **replicaCount**: int: 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. +* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the Search service. Possible values include: 'running': The Search service is running and no provisioning operations are underway. 'provisioning': The Search service is being provisioned or scaled up or down. 'deleting': The Search service is being deleted. 'degraded': The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The Search service is disabled. In this state, the service will reject all API requests. 'error': The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. +* **statusDetails**: string (ReadOnly): The details of the Search service status. -## QueryKey +## Sku ### Properties -* **key**: string (ReadOnly): The value of the query API key. -* **name**: string (ReadOnly): The name of the query API key; may be empty. +* **name**: 'basic' | 'free' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2': 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.' diff --git a/generated/search/microsoft.search/2020-08-01-preview/types.md b/generated/search/microsoft.search/2020-08-01-preview/types.md index 7a9fa40ac9..46d044947a 100644 --- a/generated/search/microsoft.search/2020-08-01-preview/types.md +++ b/generated/search/microsoft.search/2020-08-01-preview/types.md @@ -41,32 +41,29 @@ * **ApiVersion**: 2020-08-01-preview * **Output**: [ListQueryKeysResult](#listquerykeysresult) +## AdminKeyResult +### Properties +* **primaryKey**: string (ReadOnly): The primary admin API key of the search service. +* **secondaryKey**: string (ReadOnly): The secondary admin API key of the search service. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'None' | 'SystemAssigned' (Required): The identity type. -## SearchServiceProperties +## IpRule ### Properties -* **hostingMode**: 'default' | 'highDensity': 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'. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. -* **partitionCount**: int: 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. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. -* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. -* **publicNetworkAccess**: 'disabled' | 'enabled': 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. -* **replicaCount**: int: 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. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources managed by the Azure Cognitive Search service. -* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. -* **statusDetails**: string (ReadOnly): The details of the search service status. +* **value**: string: 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. -## NetworkRuleSet +## ListQueryKeysResult ### Properties -* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. +* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. +* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. -## IpRule +## NetworkRuleSet ### Properties -* **value**: string: 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. +* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. ## PrivateEndpointConnection ### Properties @@ -90,6 +87,24 @@ * **description**: string: The description for the private link service connection state. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected': Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. +## QueryKey +### Properties +* **key**: string (ReadOnly): The value of the query API key. +* **name**: string (ReadOnly): The name of the query API key; may be empty. + +## SearchServiceProperties +### Properties +* **hostingMode**: 'default' | 'highDensity': 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'. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. +* **partitionCount**: int: 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. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. +* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. +* **publicNetworkAccess**: 'disabled' | 'enabled': 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. +* **replicaCount**: int: 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. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources managed by the Azure Cognitive Search service. +* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. +* **statusDetails**: string (ReadOnly): The details of the search service status. + ## SharedPrivateLinkResource ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -115,18 +130,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary admin API key of the search service. -* **secondaryKey**: string (ReadOnly): The secondary admin API key of the search service. - -## ListQueryKeysResult -### Properties -* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. -* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. - -## QueryKey -### Properties -* **key**: string (ReadOnly): The value of the query API key. -* **name**: string (ReadOnly): The name of the query API key; may be empty. - diff --git a/generated/search/microsoft.search/2020-08-01/types.md b/generated/search/microsoft.search/2020-08-01/types.md index 073ce582d4..daefd3093f 100644 --- a/generated/search/microsoft.search/2020-08-01/types.md +++ b/generated/search/microsoft.search/2020-08-01/types.md @@ -41,32 +41,29 @@ * **ApiVersion**: 2020-08-01 * **Output**: [ListQueryKeysResult](#listquerykeysresult) +## AdminKeyResult +### Properties +* **primaryKey**: string (ReadOnly): The primary admin API key of the search service. +* **secondaryKey**: string (ReadOnly): The secondary admin API key of the search service. + ## Identity ### Properties * **principalId**: string (ReadOnly): The principal ID of resource identity. * **tenantId**: string (ReadOnly): The tenant ID of resource. * **type**: 'None' | 'SystemAssigned' (Required): The identity type. -## SearchServiceProperties +## IpRule ### Properties -* **hostingMode**: 'default' | 'highDensity': 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'. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. -* **partitionCount**: int: 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. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. -* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. -* **publicNetworkAccess**: 'disabled' | 'enabled': 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. -* **replicaCount**: int: 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. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources managed by the Azure Cognitive Search service. -* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. -* **statusDetails**: string (ReadOnly): The details of the search service status. +* **value**: string: 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. -## NetworkRuleSet +## ListQueryKeysResult ### Properties -* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. +* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. +* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. -## IpRule +## NetworkRuleSet ### Properties -* **value**: string: 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. +* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. ## PrivateEndpointConnection ### Properties @@ -90,6 +87,24 @@ * **description**: string: The description for the private link service connection state. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected': Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. +## QueryKey +### Properties +* **key**: string (ReadOnly): The value of the query API key. +* **name**: string (ReadOnly): The name of the query API key; may be empty. + +## SearchServiceProperties +### Properties +* **hostingMode**: 'default' | 'highDensity': 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'. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. +* **partitionCount**: int: 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. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. +* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. +* **publicNetworkAccess**: 'disabled' | 'enabled': 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. +* **replicaCount**: int: 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. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources managed by the Azure Cognitive Search service. +* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' (ReadOnly): The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. +* **statusDetails**: string (ReadOnly): The details of the search service status. + ## SharedPrivateLinkResource ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -115,18 +130,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary admin API key of the search service. -* **secondaryKey**: string (ReadOnly): The secondary admin API key of the search service. - -## ListQueryKeysResult -### Properties -* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. -* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. - -## QueryKey -### Properties -* **key**: string (ReadOnly): The value of the query API key. -* **name**: string (ReadOnly): The name of the query API key; may be empty. - diff --git a/generated/search/microsoft.search/2021-04-01-preview/types.md b/generated/search/microsoft.search/2021-04-01-preview/types.md index 13effa17d3..c8eb97074c 100644 --- a/generated/search/microsoft.search/2021-04-01-preview/types.md +++ b/generated/search/microsoft.search/2021-04-01-preview/types.md @@ -41,65 +41,46 @@ * **ApiVersion**: 2021-04-01-preview * **Output**: [ListQueryKeysResult](#listquerykeysresult) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of the system-assigned identity of the search service. -* **tenantId**: string (ReadOnly): The tenant ID of the system-assigned identity of the search service. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The list of user identities associated with the search service. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## UserAssignedManagedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) - -## UserAssignedManagedIdentity +## AdminKeyResult ### Properties -* **clientId**: string (ReadOnly): The client ID of user assigned identity. -* **principalId**: string (ReadOnly): The principal ID of user assigned identity. +* **primaryKey**: string (ReadOnly): The primary admin API key of the search service. +* **secondaryKey**: string (ReadOnly): The secondary admin API key of the search service. -## SearchServiceProperties +## DataPlaneAadOrApiKeyAuthOption ### Properties -* **authOptions**: [DataPlaneAuthOptions](#dataplaneauthoptions): Defines the options for how the data plane API of a Search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. -* **disabledDataExfiltrationOptions**: 'All' | string[]: A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. -* **disableLocalAuth**: bool: When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. -* **encryptionWithCmk**: [EncryptionWithCmk](#encryptionwithcmk): Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys. -* **eTag**: string (ReadOnly): A system generated property representing the service's etag that can be for optimistic concurrency control during updates. -* **hostingMode**: 'default' | 'highDensity': 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'. -* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. -* **partitionCount**: int: 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. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. -* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. -* **publicNetworkAccess**: 'disabled' | 'enabled' | 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. -* **replicaCount**: int: 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. -* **semanticSearch**: 'disabled' | 'free' | 'standard' | string: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources managed by the Azure Cognitive Search service. -* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' | 'stopped' (ReadOnly): The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. -* **statusDetails**: string (ReadOnly): The details of the search service status. +* **aadAuthFailureMode**: 'http401WithBearerChallenge' | 'http403': Describes what response the data plane API of a Search service would send for requests that failed authentication. ## DataPlaneAuthOptions ### Properties * **aadOrApiKey**: [DataPlaneAadOrApiKeyAuthOption](#dataplaneaadorapikeyauthoption): Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. * **apiKeyOnly**: any: Any object -## DataPlaneAadOrApiKeyAuthOption -### Properties -* **aadAuthFailureMode**: 'http401WithBearerChallenge' | 'http403': Describes what response the data plane API of a Search service would send for requests that failed authentication. - ## EncryptionWithCmk ### Properties * **encryptionComplianceStatus**: 'Compliant' | 'NonCompliant' (ReadOnly): Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'. * **enforcement**: 'Disabled' | 'Enabled' | 'Unspecified': Describes how a search service should enforce having one or more non customer encrypted resources. -## NetworkRuleSet +## Identity ### Properties -* **bypass**: 'AzurePortal' | 'None' | string: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. -* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. +* **principalId**: string (ReadOnly): The principal ID of the system-assigned identity of the search service. +* **tenantId**: string (ReadOnly): The tenant ID of the system-assigned identity of the search service. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string (Required): The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The list of user identities associated with the search service. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ## IpRule ### Properties * **value**: string: 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. +## ListQueryKeysResult +### Properties +* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. +* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. + +## NetworkRuleSet +### Properties +* **bypass**: 'AzurePortal' | 'None' | string: Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. +* **ipRules**: [IpRule](#iprule)[]: A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. + ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -122,6 +103,30 @@ * **description**: string: The description for the private link service connection state. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected': Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. +## QueryKey +### Properties +* **key**: string (ReadOnly): The value of the query API key. +* **name**: string (ReadOnly): The name of the query API key; may be empty. + +## SearchServiceProperties +### Properties +* **authOptions**: [DataPlaneAuthOptions](#dataplaneauthoptions): Defines the options for how the data plane API of a Search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. +* **disabledDataExfiltrationOptions**: 'All' | string[]: A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. +* **disableLocalAuth**: bool: When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. +* **encryptionWithCmk**: [EncryptionWithCmk](#encryptionwithcmk): Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys. +* **eTag**: string (ReadOnly): A system generated property representing the service's etag that can be for optimistic concurrency control during updates. +* **hostingMode**: 'default' | 'highDensity': 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'. +* **networkRuleSet**: [NetworkRuleSet](#networkruleset): Network specific rules that determine how the Azure Cognitive Search service may be reached. +* **partitionCount**: int: 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. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): The list of private endpoint connections to the Azure Cognitive Search service. +* **provisioningState**: 'failed' | 'provisioning' | 'succeeded' (ReadOnly): The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up. +* **publicNetworkAccess**: 'disabled' | 'enabled' | 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. +* **replicaCount**: int: 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. +* **semanticSearch**: 'disabled' | 'free' | 'standard' | string: Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources managed by the Azure Cognitive Search service. +* **status**: 'degraded' | 'deleting' | 'disabled' | 'error' | 'provisioning' | 'running' | 'stopped' (ReadOnly): The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. +* **statusDetails**: string (ReadOnly): The details of the search service status. + ## SharedPrivateLinkResource ### Properties * **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} @@ -147,18 +152,13 @@ ### Additional Properties * **Additional Properties Type**: string -## AdminKeyResult -### Properties -* **primaryKey**: string (ReadOnly): The primary admin API key of the search service. -* **secondaryKey**: string (ReadOnly): The secondary admin API key of the search service. - -## ListQueryKeysResult +## UserAssignedManagedIdentities ### Properties -* **nextLink**: string (ReadOnly): Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. -* **value**: [QueryKey](#querykey)[] (ReadOnly): The query keys for the Azure Cognitive Search service. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) -## QueryKey +## UserAssignedManagedIdentity ### Properties -* **key**: string (ReadOnly): The value of the query API key. -* **name**: string (ReadOnly): The name of the query API key; may be empty. +* **clientId**: string (ReadOnly): The client ID of user assigned identity. +* **principalId**: string (ReadOnly): The principal ID of user assigned identity. diff --git a/generated/security/log.out b/generated/security/log.out index 0ed26886dc..6c90b4f1ae 100644 --- a/generated/security/log.out +++ b/generated/security/log.out @@ -11,7 +11,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.security-2021-11-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -22,11 +22,11 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.security-2022-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -37,7 +37,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PricingList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2022-03-01/pricings.json:154:5 @@ -54,13 +54,13 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.security-2015-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -71,7 +71,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ExternalSecuritySolutionList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json:165:5 @@ -100,7 +100,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'AadConnectivityStat - x-ms-enum: => {"name":"AadConnectivityState","modelAsString":true,"values":[{"value":"Discovered"},{"value":"NotLicensed"},{"value":"Connected"}]} warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ExternalSecuritySolutionKind' -> 'ExternalSecuritySolutionKindAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'AadConnectivityState' -> 'AadConnectivityStateAutoGenerated' -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.security-2021-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -111,12 +111,12 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.security-2021-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -127,7 +127,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. @@ -142,11 +142,11 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.security-2021-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -157,7 +157,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SoftwareProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2021-05-01-preview/softwareInventories.json:253:5 @@ -174,11 +174,11 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.security-2020-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -189,11 +189,11 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.security-2019-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -204,7 +204,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutomationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/automations.json:299:5 @@ -216,7 +216,7 @@ warning | PreCheck/SchemaMissingType | The schema 'RegulatoryComplianceAssessmen - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json:487:5 warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.security-2017-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -227,7 +227,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PricingList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/pricings.json:284:5 @@ -259,7 +259,7 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource' with an undefin - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json:877:5 warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.security-2021-01-15-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -270,7 +270,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'IngestionSettingList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/preview/2021-01-15-preview/ingestionSettings.json:272:5 @@ -279,7 +279,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ConnectionStrings' with an un warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.security-2018-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -290,7 +290,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'PricingList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/pricings.json:154:5 @@ -307,7 +307,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AdvancedThreatProtectionProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json:118:5 @@ -324,7 +324,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ComplianceResultList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2017-08-01/complianceResults.json:117:5 @@ -341,7 +341,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TagsResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json:306:5 @@ -363,7 +363,7 @@ warning | PreCheck/SchemaMissingType | The schema 'TagsResource' with an undefin - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json:875:5 warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.security-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -374,7 +374,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Rule' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json:240:5 @@ -404,7 +404,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'AadConnectivityStat warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ExternalSecuritySolutionKind' -> 'ExternalSecuritySolutionKindAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'AadConnectivityState' -> 'AadConnectivityStateAutoGenerated' info | Resource type microsoft.security/servervulnerabilityassessments under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/serverVulnerabilityAssessments/{serverVulnerabilityAssessment}' has no body defined. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.security-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -415,11 +415,11 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.security-2021-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -430,7 +430,7 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. @@ -445,9 +445,9 @@ warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms -info | Autorest completed in 51.54s. 32 files generated. +info | autorest.bicep took 0ms +info | Autorest completed in 49.46s. 32 files generated. diff --git a/generated/security/microsoft.security/2015-06-01-preview/types.md b/generated/security/microsoft.security/2015-06-01-preview/types.md index 4b32f32520..f960e74be3 100644 --- a/generated/security/microsoft.security/2015-06-01-preview/types.md +++ b/generated/security/microsoft.security/2015-06-01-preview/types.md @@ -25,30 +25,6 @@ * **properties**: [JitNetworkAccessPolicyProperties](#jitnetworkaccesspolicyproperties) (Required) * **type**: 'Microsoft.Security/locations/jitNetworkAccessPolicies' (ReadOnly, DeployTimeConstant): The resource type -## PathRecommendation -### Properties -* **action**: 'Add' | 'Recommended' | 'Remove' | string (WriteOnly): The recommendation action of the VM/server or rule -* **common**: bool (WriteOnly): Whether the path is commonly run on the machine -* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (WriteOnly): The configuration status of the VM/server group or machine or rule on the machine -* **fileType**: 'Dll' | 'Exe' | 'Executable' | 'Msi' | 'Script' | 'Unknown' | string (WriteOnly): The type of the file (for Linux files - Executable is used) -* **path**: string (WriteOnly): The full path to whitelist -* **publisherInfo**: [PublisherInfo](#publisherinfo) (WriteOnly): Represents the publisher information of a process/rule -* **type**: 'BinarySignature' | 'File' | 'FileHash' | 'ProductSignature' | 'PublisherSignature' | 'VersionAndAboveSignature' | string (WriteOnly): The type of the rule to be allowed -* **usernames**: [UserRecommendation](#userrecommendation)[] (WriteOnly): Array of UserRecommendation -* **userSids**: string[] (WriteOnly): Array of PathRecommendationUserSidsItem - -## PublisherInfo -### Properties -* **binaryName**: string (WriteOnly): The "OriginalName" field taken from the file's version resource -* **productName**: string (WriteOnly): The product name taken from the file's version resource -* **publisherName**: string (WriteOnly): The Subject field of the x.509 certificate used to sign the code, using the following fields - O = Organization, L = Locality, S = State or Province, and C = Country -* **version**: string (WriteOnly): The binary file version taken from the file's version resource - -## UserRecommendation -### Properties -* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string (WriteOnly): The recommendation action of the VM/server or rule -* **username**: string (WriteOnly): Represents a user that is recommended to be allowed for a certain rule - ## AppWhitelistingGroupData ### Properties * **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (ReadOnly): The configuration status of the VM/server group or machine or rule on the machine @@ -65,26 +41,26 @@ * **issue**: 'ExecutableViolationsAudited' | 'MsiAndScriptViolationsAudited' | 'MsiAndScriptViolationsBlocked' | 'RulesViolatedManually' | 'ViolationsAudited' | 'ViolationsBlocked' | string (ReadOnly): An alert that VMs/servers within a group can have * **numberOfVms**: int (ReadOnly): The number of machines in the VM/server group that have this alert -## ProtectionMode -### Properties -* **exe**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group -* **executable**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group -* **msi**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group -* **script**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group - -## VmRecommendation -### Properties -* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (WriteOnly): The configuration status of the VM/server group or machine or rule on the machine -* **enforcementSupport**: 'NotSupported' | 'Supported' | 'Unknown' | string (WriteOnly): The VM/server supportability of Enforce feature -* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string (WriteOnly): The recommendation action of the VM/server or rule -* **resourceId**: string (WriteOnly): The full azure resource id of the machine - ## JitNetworkAccessPolicyProperties ### Properties * **provisioningState**: string (ReadOnly): Gets the provisioning state of the Just-in-Time policy. * **requests**: [JitNetworkAccessRequest](#jitnetworkaccessrequest)[]: Array of JitNetworkAccessRequest * **virtualMachines**: [JitNetworkAccessPolicyVirtualMachine](#jitnetworkaccesspolicyvirtualmachine)[] (Required): Configurations for Microsoft.Compute/virtualMachines resource type. +## JitNetworkAccessPolicyVirtualMachine +### Properties +* **id**: string (Required): Resource ID of the virtual machine that is linked to this policy +* **ports**: [JitNetworkAccessPortRule](#jitnetworkaccessportrule)[] (Required): Port configurations for the virtual machine +* **publicIpAddress**: string: Public IP address of the Azure Firewall that is linked to this policy, if applicable + +## JitNetworkAccessPortRule +### Properties +* **allowedSourceAddressPrefix**: string: 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". +* **allowedSourceAddressPrefixes**: string[]: Mutually exclusive with the "allowedSourceAddressPrefix" parameter. +* **maxRequestAccessDuration**: string (Required): Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day +* **number**: int (Required) +* **protocol**: '*' | 'TCP' | 'UDP' | string (Required) + ## JitNetworkAccessRequest ### Properties * **justification**: string: The justification for making the initiate request @@ -92,11 +68,6 @@ * **startTimeUtc**: string (Required): The start time of the request in UTC * **virtualMachines**: [JitNetworkAccessRequestVirtualMachine](#jitnetworkaccessrequestvirtualmachine)[] (Required): Array of JitNetworkAccessRequestVirtualMachine -## JitNetworkAccessRequestVirtualMachine -### Properties -* **id**: string (Required): Resource ID of the virtual machine that is linked to this policy -* **ports**: [JitNetworkAccessRequestPort](#jitnetworkaccessrequestport)[] (Required): The ports that were opened for the virtual machine - ## JitNetworkAccessRequestPort ### Properties * **allowedSourceAddressPrefix**: string: 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". @@ -107,17 +78,46 @@ * **status**: 'Initiated' | 'Revoked' | string (Required): The status of the port * **statusReason**: 'Expired' | 'NewerRequestInitiated' | 'UserRequested' | string (Required): A description of why the `status` has its value -## JitNetworkAccessPolicyVirtualMachine +## JitNetworkAccessRequestVirtualMachine ### Properties * **id**: string (Required): Resource ID of the virtual machine that is linked to this policy -* **ports**: [JitNetworkAccessPortRule](#jitnetworkaccessportrule)[] (Required): Port configurations for the virtual machine -* **publicIpAddress**: string: Public IP address of the Azure Firewall that is linked to this policy, if applicable +* **ports**: [JitNetworkAccessRequestPort](#jitnetworkaccessrequestport)[] (Required): The ports that were opened for the virtual machine -## JitNetworkAccessPortRule +## PathRecommendation ### Properties -* **allowedSourceAddressPrefix**: string: 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". -* **allowedSourceAddressPrefixes**: string[]: Mutually exclusive with the "allowedSourceAddressPrefix" parameter. -* **maxRequestAccessDuration**: string (Required): Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day -* **number**: int (Required) -* **protocol**: '*' | 'TCP' | 'UDP' | string (Required) +* **action**: 'Add' | 'Recommended' | 'Remove' | string (WriteOnly): The recommendation action of the VM/server or rule +* **common**: bool (WriteOnly): Whether the path is commonly run on the machine +* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (WriteOnly): The configuration status of the VM/server group or machine or rule on the machine +* **fileType**: 'Dll' | 'Exe' | 'Executable' | 'Msi' | 'Script' | 'Unknown' | string (WriteOnly): The type of the file (for Linux files - Executable is used) +* **path**: string (WriteOnly): The full path to whitelist +* **publisherInfo**: [PublisherInfo](#publisherinfo) (WriteOnly): Represents the publisher information of a process/rule +* **type**: 'BinarySignature' | 'File' | 'FileHash' | 'ProductSignature' | 'PublisherSignature' | 'VersionAndAboveSignature' | string (WriteOnly): The type of the rule to be allowed +* **usernames**: [UserRecommendation](#userrecommendation)[] (WriteOnly): Array of UserRecommendation +* **userSids**: string[] (WriteOnly): Array of PathRecommendationUserSidsItem + +## ProtectionMode +### Properties +* **exe**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group +* **executable**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group +* **msi**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group +* **script**: 'Audit' | 'Enforce' | 'None' | string (WriteOnly): The application control policy enforcement/protection mode of the VM/server group + +## PublisherInfo +### Properties +* **binaryName**: string (WriteOnly): The "OriginalName" field taken from the file's version resource +* **productName**: string (WriteOnly): The product name taken from the file's version resource +* **publisherName**: string (WriteOnly): The Subject field of the x.509 certificate used to sign the code, using the following fields - O = Organization, L = Locality, S = State or Province, and C = Country +* **version**: string (WriteOnly): The binary file version taken from the file's version resource + +## UserRecommendation +### Properties +* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string (WriteOnly): The recommendation action of the VM/server or rule +* **username**: string (WriteOnly): Represents a user that is recommended to be allowed for a certain rule + +## VmRecommendation +### Properties +* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (WriteOnly): The configuration status of the VM/server group or machine or rule on the machine +* **enforcementSupport**: 'NotSupported' | 'Supported' | 'Unknown' | string (WriteOnly): The VM/server supportability of Enforce feature +* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string (WriteOnly): The recommendation action of the VM/server or rule +* **resourceId**: string (WriteOnly): The full azure resource id of the machine diff --git a/generated/security/microsoft.security/2017-08-01-preview/types.md b/generated/security/microsoft.security/2017-08-01-preview/types.md index 8a1d2b5f06..c56829adc5 100644 --- a/generated/security/microsoft.security/2017-08-01-preview/types.md +++ b/generated/security/microsoft.security/2017-08-01-preview/types.md @@ -93,17 +93,6 @@ ### Properties * **isEnabled**: bool: Indicates whether Advanced Threat Protection is enabled. -## AutoProvisioningSettingProperties -### Properties -* **autoProvision**: 'Off' | 'On' | string (Required): Describes what kind of security agent provisioning action to take - -## DeviceSecurityGroupProperties -### Properties -* **allowlistRules**: [AllowlistCustomAlertRule](#allowlistcustomalertrule)[]: The allow-list custom alert rules. -* **denylistRules**: [DenylistCustomAlertRule](#denylistcustomalertrule)[]: The deny-list custom alert rules. -* **thresholdRules**: [ThresholdCustomAlertRule](#thresholdcustomalertrule)[]: The list of custom alert threshold rules. -* **timeWindowRules**: [TimeWindowCustomAlertRule](#timewindowcustomalertrule)[]: The list of custom alert time-window rules. - ## AllowlistCustomAlertRule * **Discriminator**: ruleType @@ -126,6 +115,14 @@ * **ruleType**: 'ProcessNotAllowed' (Required): The type of the custom alert rule. +## AutoProvisioningSettingProperties +### Properties +* **autoProvision**: 'Off' | 'On' | string (Required): Describes what kind of security agent provisioning action to take + +## DataExportSettingProperties +### Properties +* **enabled**: bool (Required): Is the data export setting is enabled + ## DenylistCustomAlertRule ### Properties * **denylistValues**: string[] (Required): The values to deny. The format of the values depends on the rule type. @@ -135,6 +132,89 @@ * **ruleType**: string (Required): The type of the custom alert rule. * **valueType**: 'IpCidr' | 'String' | string (ReadOnly): The value type of the items in the list. +## DeviceSecurityGroupProperties +### Properties +* **allowlistRules**: [AllowlistCustomAlertRule](#allowlistcustomalertrule)[]: The allow-list custom alert rules. +* **denylistRules**: [DenylistCustomAlertRule](#denylistcustomalertrule)[]: The deny-list custom alert rules. +* **thresholdRules**: [ThresholdCustomAlertRule](#thresholdcustomalertrule)[]: The list of custom alert threshold rules. +* **timeWindowRules**: [TimeWindowCustomAlertRule](#timewindowcustomalertrule)[]: The list of custom alert time-window rules. + +## InformationProtectionKeyword +### Properties +* **canBeNumeric**: bool: Indicates whether the keyword can be applied on numeric types or not. +* **custom**: bool: Indicates whether the keyword is custom or not. +* **excluded**: bool: Indicates whether the keyword is excluded or not. +* **pattern**: string: The keyword pattern. + +## InformationProtectionPolicyProperties +### Properties +* **informationTypes**: [InformationProtectionPolicyPropertiesInformationTypes](#informationprotectionpolicypropertiesinformationtypes): The sensitivity information types. +* **labels**: [InformationProtectionPolicyPropertiesLabels](#informationprotectionpolicypropertieslabels): Dictionary of sensitivity labels. +* **lastModifiedUtc**: string (ReadOnly): Describes the last UTC time the policy was modified. +* **version**: string (ReadOnly): Describes the version of the policy. + +## InformationProtectionPolicyPropertiesInformationTypes +### Properties +### Additional Properties +* **Additional Properties Type**: [InformationType](#informationtype) + +## InformationProtectionPolicyPropertiesLabels +### Properties +### Additional Properties +* **Additional Properties Type**: [SensitivityLabel](#sensitivitylabel) + +## InformationType +### Properties +* **custom**: bool: Indicates whether the information type is custom or not. +* **description**: string: The description of the information type. +* **displayName**: string: The name of the information type. +* **enabled**: bool: Indicates whether the information type is enabled or not. +* **keywords**: [InformationProtectionKeyword](#informationprotectionkeyword)[]: The information type keywords. +* **order**: int: The order of the information type. +* **recommendedLabelId**: string: The recommended label id to be associated with this information type. + +## IoTSecuritySolutionProperties +### Properties +* **autoDiscoveredResources**: string[] (ReadOnly): List of resources that were automatically discovered as relevant to the security solution. +* **disabledDataSources**: 'TwinData' | string[]: Disabled data sources. Disabling these data sources compromises the system. +* **displayName**: string (Required): Resource display name. +* **export**: 'RawEvents' | string[]: List of additional export to workspace data options +* **iotHubs**: string[] (Required): IoT Hub resource IDs +* **recommendationsConfiguration**: [RecommendationConfigurationProperties](#recommendationconfigurationproperties)[]: List of recommendation configuration +* **status**: 'Disabled' | 'Enabled' | string: Security solution status +* **userDefinedResources**: [UserDefinedResourcesProperties](#userdefinedresourcesproperties): Properties of the solution's user defined resources. +* **workspace**: string (Required): Workspace resource ID + +## PricingProperties +### Properties +* **pricingTier**: 'Free' | 'Standard' | string (Required): Pricing tier type + +## RecommendationConfigurationProperties +### Properties +* **name**: string (ReadOnly) +* **recommendationType**: 'IoT_ACRAuthentication' | 'IoT_AgentSendsUnutilizedMessages' | 'IoT_Baseline' | 'IoT_EdgeHubMemOptimize' | 'IoT_EdgeLoggingOptions' | 'IoT_IPFilter_DenyAll' | 'IoT_IPFilter_PermissiveRule' | 'IoT_InconsistentModuleSettings' | 'IoT_InstallAgent' | 'IoT_OpenPorts' | 'IoT_PermissiveFirewallPolicy' | 'IoT_PermissiveInputFirewallRules' | 'IoT_PermissiveOutputFirewallRules' | 'IoT_PrivilegedDockerOptions' | 'IoT_SharedCredentials' | 'IoT_VulnerableTLSCipherSuite' | string (Required): The recommendation type. +* **status**: 'Disabled' | 'Enabled' | string (Required): Recommendation status. The recommendation is not generated when the status is disabled + +## SecurityContactProperties +### Properties +* **alertNotifications**: 'Off' | 'On' | string (Required): Whether to send security alerts notifications to the security contact +* **alertsToAdmins**: 'Off' | 'On' | string (Required): Whether to send security alerts notifications to subscription admins +* **email**: string (Required): The email of this security contact +* **phone**: string: The phone number of this security contact + +## SensitivityLabel +### Properties +* **description**: string: The description of the sensitivity label. +* **displayName**: string: The name of the sensitivity label. +* **enabled**: bool: Indicates whether the label is enabled or not. +* **order**: int: The order of the sensitivity label. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None': The rank of the sensitivity label. + +## TagsResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ThresholdCustomAlertRule * **Discriminator**: ruleType @@ -284,91 +364,11 @@ * **ruleType**: 'UnauthorizedOperationsNotInAllowedRange' (Required): The type of the custom alert rule. -## InformationProtectionPolicyProperties -### Properties -* **informationTypes**: [InformationProtectionPolicyPropertiesInformationTypes](#informationprotectionpolicypropertiesinformationtypes): The sensitivity information types. -* **labels**: [InformationProtectionPolicyPropertiesLabels](#informationprotectionpolicypropertieslabels): Dictionary of sensitivity labels. -* **lastModifiedUtc**: string (ReadOnly): Describes the last UTC time the policy was modified. -* **version**: string (ReadOnly): Describes the version of the policy. - -## InformationProtectionPolicyPropertiesInformationTypes -### Properties -### Additional Properties -* **Additional Properties Type**: [InformationType](#informationtype) - -## InformationType -### Properties -* **custom**: bool: Indicates whether the information type is custom or not. -* **description**: string: The description of the information type. -* **displayName**: string: The name of the information type. -* **enabled**: bool: Indicates whether the information type is enabled or not. -* **keywords**: [InformationProtectionKeyword](#informationprotectionkeyword)[]: The information type keywords. -* **order**: int: The order of the information type. -* **recommendedLabelId**: string: The recommended label id to be associated with this information type. - -## InformationProtectionKeyword -### Properties -* **canBeNumeric**: bool: Indicates whether the keyword can be applied on numeric types or not. -* **custom**: bool: Indicates whether the keyword is custom or not. -* **excluded**: bool: Indicates whether the keyword is excluded or not. -* **pattern**: string: The keyword pattern. - -## InformationProtectionPolicyPropertiesLabels -### Properties -### Additional Properties -* **Additional Properties Type**: [SensitivityLabel](#sensitivitylabel) - -## SensitivityLabel -### Properties -* **description**: string: The description of the sensitivity label. -* **displayName**: string: The name of the sensitivity label. -* **enabled**: bool: Indicates whether the label is enabled or not. -* **order**: int: The order of the sensitivity label. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None': The rank of the sensitivity label. - -## IoTSecuritySolutionProperties -### Properties -* **autoDiscoveredResources**: string[] (ReadOnly): List of resources that were automatically discovered as relevant to the security solution. -* **disabledDataSources**: 'TwinData' | string[]: Disabled data sources. Disabling these data sources compromises the system. -* **displayName**: string (Required): Resource display name. -* **export**: 'RawEvents' | string[]: List of additional export to workspace data options -* **iotHubs**: string[] (Required): IoT Hub resource IDs -* **recommendationsConfiguration**: [RecommendationConfigurationProperties](#recommendationconfigurationproperties)[]: List of recommendation configuration -* **status**: 'Disabled' | 'Enabled' | string: Security solution status -* **userDefinedResources**: [UserDefinedResourcesProperties](#userdefinedresourcesproperties): Properties of the solution's user defined resources. -* **workspace**: string (Required): Workspace resource ID - -## RecommendationConfigurationProperties -### Properties -* **name**: string (ReadOnly) -* **recommendationType**: 'IoT_ACRAuthentication' | 'IoT_AgentSendsUnutilizedMessages' | 'IoT_Baseline' | 'IoT_EdgeHubMemOptimize' | 'IoT_EdgeLoggingOptions' | 'IoT_IPFilter_DenyAll' | 'IoT_IPFilter_PermissiveRule' | 'IoT_InconsistentModuleSettings' | 'IoT_InstallAgent' | 'IoT_OpenPorts' | 'IoT_PermissiveFirewallPolicy' | 'IoT_PermissiveInputFirewallRules' | 'IoT_PermissiveOutputFirewallRules' | 'IoT_PrivilegedDockerOptions' | 'IoT_SharedCredentials' | 'IoT_VulnerableTLSCipherSuite' | string (Required): The recommendation type. -* **status**: 'Disabled' | 'Enabled' | string (Required): Recommendation status. The recommendation is not generated when the status is disabled - ## UserDefinedResourcesProperties ### Properties * **query**: string (Required): Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs"" * **querySubscriptions**: string[] (Required): List of Azure subscription ids on which the user defined resources query should be executed. -## TagsResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PricingProperties -### Properties -* **pricingTier**: 'Free' | 'Standard' | string (Required): Pricing tier type - -## SecurityContactProperties -### Properties -* **alertNotifications**: 'Off' | 'On' | string (Required): Whether to send security alerts notifications to the security contact -* **alertsToAdmins**: 'Off' | 'On' | string (Required): Whether to send security alerts notifications to subscription admins -* **email**: string (Required): The email of this security contact -* **phone**: string: The phone number of this security contact - -## DataExportSettingProperties -### Properties -* **enabled**: bool (Required): Is the data export setting is enabled - ## WorkspaceSettingProperties ### Properties * **scope**: string (Required): All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope diff --git a/generated/security/microsoft.security/2019-01-01-preview/types.md b/generated/security/microsoft.security/2019-01-01-preview/types.md index a864bea70c..cdbdf1a798 100644 --- a/generated/security/microsoft.security/2019-01-01-preview/types.md +++ b/generated/security/microsoft.security/2019-01-01-preview/types.md @@ -50,77 +50,16 @@ * **state**: 'Disabled' | 'Enabled' | 'Expired' (Required): Possible states of the rule * **suppressionAlertsScope**: [SuppressionAlertsScope](#suppressionalertsscope) -## SuppressionAlertsScope -### Properties -* **allOf**: [ScopeElement](#scopeelement)[] (Required): All the conditions inside need to be true in order to suppress the alert - -## ScopeElement -### Properties -* **field**: string: The alert entity type to suppress by. -### Additional Properties -* **Additional Properties Type**: any - -## SecurityAssessmentMetadataProperties -### Properties -* **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition -* **categories**: 'Compute' | 'Data' | 'IdentityAndAccess' | 'IoT' | 'Networking' | string[]: Array of categories -* **description**: string: Human readable description of the assessment -* **displayName**: string (Required): User friendly display name of the assessment -* **implementationEffort**: 'High' | 'Low' | 'Moderate' | string: The implementation effort required to remediate this assessment -* **policyDefinitionId**: string (ReadOnly): Azure resource ID of the policy definition that turns this assessment calculation on -* **preview**: bool: True if this assessment is in preview release status -* **remediationDescription**: string: Human readable description of what you should do to mitigate this security issue -* **severity**: 'High' | 'Low' | 'Medium' | string (Required): The sub-assessment severity level -* **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats -* **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment - -## SecurityAssessmentProperties -### Properties -* **additionalData**: [SecurityAssessmentPropertiesAdditionalData](#securityassessmentpropertiesadditionaldata): Additional data regarding the assessment -* **displayName**: string (ReadOnly): User friendly display name of the assessment -* **links**: [AssessmentLinks](#assessmentlinks) (ReadOnly): Links relevant to the assessment -* **resourceDetails**: [ResourceDetails](#resourcedetails) (Required): Details of the resource that was assessed -* **status**: [AssessmentStatus](#assessmentstatus) (Required): The result of the assessment - -## SecurityAssessmentPropertiesAdditionalData -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AssessmentLinks ### Properties * **azurePortalUri**: string (ReadOnly): Link to assessment in Azure Portal -## ResourceDetails -* **Discriminator**: source - -### Base Properties -### AzureResourceDetails -#### Properties -* **id**: string (ReadOnly): Azure resource Id of the assessed resource -* **source**: 'Azure' (Required): The platform where the assessed resource resides - -### OnPremiseSqlResourceDetails -#### Properties -* **databaseName**: string (Required): The Sql database name installed on the machine -* **serverName**: string (Required): The Sql server name installed on the machine -* **source**: 'OnPremiseSql' (Required): The platform where the assessed resource resides - - ## AssessmentStatus ### Properties * **cause**: string: Programmatic code for the cause of the assessment status * **code**: 'Healthy' | 'NotApplicable' | 'Unhealthy' | string (Required): Programmatic code for the status of the assessment * **description**: string: Human readable description of the assessment status -## AutomationProperties -### Properties -* **actions**: [AutomationAction](#automationaction)[]: A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true. -* **description**: string: The security automation description. -* **isEnabled**: bool: Indicates whether the security automation is enabled. -* **scopes**: [AutomationScope](#automationscope)[]: 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. -* **sources**: [AutomationSource](#automationsource)[]: A collection of the source event types which evaluate the security automation set of rules. - ## AutomationAction * **Discriminator**: actionType @@ -144,6 +83,18 @@ * **workspaceResourceId**: string: The fully qualified Log Analytics Workspace Azure Resource ID. +## AutomationProperties +### Properties +* **actions**: [AutomationAction](#automationaction)[]: A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true. +* **description**: string: The security automation description. +* **isEnabled**: bool: Indicates whether the security automation is enabled. +* **scopes**: [AutomationScope](#automationscope)[]: 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. +* **sources**: [AutomationSource](#automationsource)[]: A collection of the source event types which evaluate the security automation set of rules. + +## AutomationRuleSet +### Properties +* **rules**: [AutomationTriggeringRule](#automationtriggeringrule)[]: Array of AutomationTriggeringRule + ## AutomationScope ### Properties * **description**: string: The resources scope description. @@ -154,10 +105,6 @@ * **eventSource**: 'Alerts' | 'Assessments' | 'AssessmentsSnapshot' | 'RegulatoryComplianceAssessment' | 'RegulatoryComplianceAssessmentSnapshot' | 'SecureScoreControls' | 'SecureScoreControlsSnapshot' | 'SecureScores' | 'SecureScoresSnapshot' | 'SubAssessments' | 'SubAssessmentsSnapshot' | string: A valid event source type. * **ruleSets**: [AutomationRuleSet](#automationruleset)[]: A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or'). -## AutomationRuleSet -### Properties -* **rules**: [AutomationTriggeringRule](#automationtriggeringrule)[]: Array of AutomationTriggeringRule - ## AutomationTriggeringRule ### Properties * **expectedValue**: string: The expected value. @@ -165,6 +112,59 @@ * **propertyJPath**: string: The JPath of the entity model property that should be checked. * **propertyType**: 'Boolean' | 'Integer' | 'Number' | 'String' | string: The data type of the compared operands (string, integer, floating point number or a boolean [true/false]] +## ResourceDetails +* **Discriminator**: source + +### Base Properties +### AzureResourceDetails +#### Properties +* **id**: string (ReadOnly): Azure resource Id of the assessed resource +* **source**: 'Azure' (Required): The platform where the assessed resource resides + +### OnPremiseSqlResourceDetails +#### Properties +* **databaseName**: string (Required): The Sql database name installed on the machine +* **serverName**: string (Required): The Sql server name installed on the machine +* **source**: 'OnPremiseSql' (Required): The platform where the assessed resource resides + + +## ScopeElement +### Properties +* **field**: string: The alert entity type to suppress by. +### Additional Properties +* **Additional Properties Type**: any + +## SecurityAssessmentMetadataProperties +### Properties +* **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition +* **categories**: 'Compute' | 'Data' | 'IdentityAndAccess' | 'IoT' | 'Networking' | string[]: Array of categories +* **description**: string: Human readable description of the assessment +* **displayName**: string (Required): User friendly display name of the assessment +* **implementationEffort**: 'High' | 'Low' | 'Moderate' | string: The implementation effort required to remediate this assessment +* **policyDefinitionId**: string (ReadOnly): Azure resource ID of the policy definition that turns this assessment calculation on +* **preview**: bool: True if this assessment is in preview release status +* **remediationDescription**: string: Human readable description of what you should do to mitigate this security issue +* **severity**: 'High' | 'Low' | 'Medium' | string (Required): The sub-assessment severity level +* **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats +* **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment + +## SecurityAssessmentProperties +### Properties +* **additionalData**: [SecurityAssessmentPropertiesAdditionalData](#securityassessmentpropertiesadditionaldata): Additional data regarding the assessment +* **displayName**: string (ReadOnly): User friendly display name of the assessment +* **links**: [AssessmentLinks](#assessmentlinks) (ReadOnly): Links relevant to the assessment +* **resourceDetails**: [ResourceDetails](#resourcedetails) (Required): Details of the resource that was assessed +* **status**: [AssessmentStatus](#assessmentstatus) (Required): The result of the assessment + +## SecurityAssessmentPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SuppressionAlertsScope +### Properties +* **allOf**: [ScopeElement](#scopeelement)[] (Required): All the conditions inside need to be true in order to suppress the alert + ## Tags ### Properties ### Additional Properties diff --git a/generated/security/microsoft.security/2019-08-01/types.md b/generated/security/microsoft.security/2019-08-01/types.md index 77bfd96419..8fce1c500e 100644 --- a/generated/security/microsoft.security/2019-08-01/types.md +++ b/generated/security/microsoft.security/2019-08-01/types.md @@ -21,12 +21,11 @@ * **tags**: [TagsResourceTags](#tagsresourcetags): Resource tags * **type**: 'Microsoft.Security/iotSecuritySolutions' (ReadOnly, DeployTimeConstant): The resource type -## DeviceSecurityGroupProperties +## AdditionalWorkspacesProperties ### Properties -* **allowlistRules**: [AllowlistCustomAlertRule](#allowlistcustomalertrule)[]: The allow-list custom alert rules. -* **denylistRules**: [DenylistCustomAlertRule](#denylistcustomalertrule)[]: The deny-list custom alert rules. -* **thresholdRules**: [ThresholdCustomAlertRule](#thresholdcustomalertrule)[]: The list of custom alert threshold rules. -* **timeWindowRules**: [TimeWindowCustomAlertRule](#timewindowcustomalertrule)[]: The list of custom alert time-window rules. +* **dataTypes**: 'Alerts' | 'RawEvents' | string[]: List of data types sent to workspace +* **type**: 'Sentinel' | string: Workspace type. +* **workspace**: string: Workspace resource id ## AllowlistCustomAlertRule * **Discriminator**: ruleType @@ -63,6 +62,47 @@ * **ruleType**: string (Required): The type of the custom alert rule. * **valueType**: 'IpCidr' | 'String' | string (ReadOnly): The value type of the items in the list. +## DeviceSecurityGroupProperties +### Properties +* **allowlistRules**: [AllowlistCustomAlertRule](#allowlistcustomalertrule)[]: The allow-list custom alert rules. +* **denylistRules**: [DenylistCustomAlertRule](#denylistcustomalertrule)[]: The deny-list custom alert rules. +* **thresholdRules**: [ThresholdCustomAlertRule](#thresholdcustomalertrule)[]: The list of custom alert threshold rules. +* **timeWindowRules**: [TimeWindowCustomAlertRule](#timewindowcustomalertrule)[]: The list of custom alert time-window rules. + +## IoTSecuritySolutionProperties +### Properties +* **additionalWorkspaces**: [AdditionalWorkspacesProperties](#additionalworkspacesproperties)[]: List of additional workspaces +* **autoDiscoveredResources**: string[] (ReadOnly): List of resources that were automatically discovered as relevant to the security solution. +* **disabledDataSources**: 'TwinData' | string[]: Disabled data sources. Disabling these data sources compromises the system. +* **displayName**: string (Required): Resource display name. +* **export**: 'RawEvents' | string[]: List of additional options for exporting to workspace data. +* **iotHubs**: string[] (Required): IoT Hub resource IDs +* **recommendationsConfiguration**: [RecommendationConfigurationProperties](#recommendationconfigurationproperties)[]: List of the configuration status for each recommendation type. +* **status**: 'Disabled' | 'Enabled' | string: Status of the IoT Security solution. +* **unmaskedIpLoggingStatus**: 'Disabled' | 'Enabled' | string: Unmasked IP address logging status +* **userDefinedResources**: [UserDefinedResourcesProperties](#userdefinedresourcesproperties): Properties of the IoT Security solution's user defined resources. +* **workspace**: string: Workspace resource ID + +## RecommendationConfigurationProperties +### Properties +* **name**: string (ReadOnly) +* **recommendationType**: 'IoT_ACRAuthentication' | 'IoT_AgentSendsUnutilizedMessages' | 'IoT_Baseline' | 'IoT_EdgeHubMemOptimize' | 'IoT_EdgeLoggingOptions' | 'IoT_IPFilter_DenyAll' | 'IoT_IPFilter_PermissiveRule' | 'IoT_InconsistentModuleSettings' | 'IoT_InstallAgent' | 'IoT_OpenPorts' | 'IoT_PermissiveFirewallPolicy' | 'IoT_PermissiveInputFirewallRules' | 'IoT_PermissiveOutputFirewallRules' | 'IoT_PrivilegedDockerOptions' | 'IoT_SharedCredentials' | 'IoT_VulnerableTLSCipherSuite' | string (Required): The type of IoT Security recommendation. +* **status**: 'Disabled' | 'Enabled' | string (Required): Recommendation status. When the recommendation status is disabled recommendations are not generated. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TagsResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ThresholdCustomAlertRule * **Discriminator**: ruleType @@ -212,48 +252,8 @@ * **ruleType**: 'UnauthorizedOperationsNotInAllowedRange' (Required): The type of the custom alert rule. -## IoTSecuritySolutionProperties -### Properties -* **additionalWorkspaces**: [AdditionalWorkspacesProperties](#additionalworkspacesproperties)[]: List of additional workspaces -* **autoDiscoveredResources**: string[] (ReadOnly): List of resources that were automatically discovered as relevant to the security solution. -* **disabledDataSources**: 'TwinData' | string[]: Disabled data sources. Disabling these data sources compromises the system. -* **displayName**: string (Required): Resource display name. -* **export**: 'RawEvents' | string[]: List of additional options for exporting to workspace data. -* **iotHubs**: string[] (Required): IoT Hub resource IDs -* **recommendationsConfiguration**: [RecommendationConfigurationProperties](#recommendationconfigurationproperties)[]: List of the configuration status for each recommendation type. -* **status**: 'Disabled' | 'Enabled' | string: Status of the IoT Security solution. -* **unmaskedIpLoggingStatus**: 'Disabled' | 'Enabled' | string: Unmasked IP address logging status -* **userDefinedResources**: [UserDefinedResourcesProperties](#userdefinedresourcesproperties): Properties of the IoT Security solution's user defined resources. -* **workspace**: string: Workspace resource ID - -## AdditionalWorkspacesProperties -### Properties -* **dataTypes**: 'Alerts' | 'RawEvents' | string[]: List of data types sent to workspace -* **type**: 'Sentinel' | string: Workspace type. -* **workspace**: string: Workspace resource id - -## RecommendationConfigurationProperties -### Properties -* **name**: string (ReadOnly) -* **recommendationType**: 'IoT_ACRAuthentication' | 'IoT_AgentSendsUnutilizedMessages' | 'IoT_Baseline' | 'IoT_EdgeHubMemOptimize' | 'IoT_EdgeLoggingOptions' | 'IoT_IPFilter_DenyAll' | 'IoT_IPFilter_PermissiveRule' | 'IoT_InconsistentModuleSettings' | 'IoT_InstallAgent' | 'IoT_OpenPorts' | 'IoT_PermissiveFirewallPolicy' | 'IoT_PermissiveInputFirewallRules' | 'IoT_PermissiveOutputFirewallRules' | 'IoT_PrivilegedDockerOptions' | 'IoT_SharedCredentials' | 'IoT_VulnerableTLSCipherSuite' | string (Required): The type of IoT Security recommendation. -* **status**: 'Disabled' | 'Enabled' | string (Required): Recommendation status. When the recommendation status is disabled recommendations are not generated. - ## UserDefinedResourcesProperties ### Properties * **query**: string (Required): Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs"" * **querySubscriptions**: string[] (Required): List of Azure subscription ids on which the user defined resources query should be executed. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TagsResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/security/microsoft.security/2020-01-01-preview/types.md b/generated/security/microsoft.security/2020-01-01-preview/types.md index 40963ce77b..7f1639e7ed 100644 --- a/generated/security/microsoft.security/2020-01-01-preview/types.md +++ b/generated/security/microsoft.security/2020-01-01-preview/types.md @@ -9,11 +9,6 @@ * **properties**: [ConnectorSettingProperties](#connectorsettingproperties): Describes properties of a connector setting * **type**: 'Microsoft.Security/connectors' (ReadOnly, DeployTimeConstant): The resource type -## ConnectorSettingProperties -### Properties -* **authenticationDetails**: [AuthenticationDetailsProperties](#authenticationdetailsproperties): Settings for cloud authentication management -* **hybridComputeSettings**: [HybridComputeSettingsProperties](#hybridcomputesettingsproperties): Settings for hybrid compute management - ## AuthenticationDetailsProperties * **Discriminator**: authenticationType @@ -50,6 +45,11 @@ * **type**: string (Required): Type field of the API key (write only) +## ConnectorSettingProperties +### Properties +* **authenticationDetails**: [AuthenticationDetailsProperties](#authenticationdetailsproperties): Settings for cloud authentication management +* **hybridComputeSettings**: [HybridComputeSettingsProperties](#hybridcomputesettingsproperties): Settings for hybrid compute management + ## HybridComputeSettingsProperties ### Properties * **autoProvision**: 'Off' | 'On' | string (Required): Whether or not to automatically install Azure Arc (hybrid compute) agents on machines diff --git a/generated/security/microsoft.security/2020-01-01/types.md b/generated/security/microsoft.security/2020-01-01/types.md index 856a75c132..30702725f5 100644 --- a/generated/security/microsoft.security/2020-01-01/types.md +++ b/generated/security/microsoft.security/2020-01-01/types.md @@ -48,88 +48,73 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties) (ReadOnly): describes ServerVulnerabilityAssessment properties. * **type**: 'Microsoft.Security/serverVulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## SecurityAssessmentMetadataProperties -### Properties -* **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | 'VerifiedPartner' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition -* **categories**: 'Compute' | 'Data' | 'IdentityAndAccess' | 'IoT' | 'Networking' | string[]: Array of categories -* **description**: string: Human readable description of the assessment -* **displayName**: string (Required): User friendly display name of the assessment -* **implementationEffort**: 'High' | 'Low' | 'Moderate' | string: The implementation effort required to remediate this assessment -* **partnerData**: [SecurityAssessmentMetadataPartnerData](#securityassessmentmetadatapartnerdata): Describes the partner that created the assessment -* **policyDefinitionId**: string (ReadOnly): Azure resource ID of the policy definition that turns this assessment calculation on -* **preview**: bool: True if this assessment is in preview release status -* **remediationDescription**: string: Human readable description of what you should do to mitigate this security issue -* **severity**: 'High' | 'Low' | 'Medium' | string (Required): The severity level of the assessment -* **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats -* **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment - -## SecurityAssessmentMetadataPartnerData -### Properties -* **partnerName**: string (Required): Name of the company of the partner -* **productName**: string: Name of the product of the partner that created the assessment -* **secret**: string (Required): Secret to authenticate the partner and verify it created the assessment - write only - -## SecurityAssessmentProperties +## AdaptiveApplicationControlGroupData ### Properties -* **additionalData**: [SecurityAssessmentPropertiesAdditionalData](#securityassessmentpropertiesadditionaldata): Additional data regarding the assessment -* **displayName**: string (ReadOnly): User friendly display name of the assessment -* **links**: [AssessmentLinks](#assessmentlinks) (ReadOnly): Links relevant to the assessment -* **metadata**: [SecurityAssessmentMetadataProperties](#securityassessmentmetadataproperties): Describes properties of an assessment metadata. -* **partnersData**: [SecurityAssessmentPartnerData](#securityassessmentpartnerdata): Data regarding 3rd party partner integration -* **resourceDetails**: [ResourceDetails](#resourcedetails) (Required): Details of the resource that was assessed -* **status**: [AssessmentStatus](#assessmentstatus) (Required): The result of the assessment +* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (ReadOnly): The configuration status of the machines group or machine or rule +* **enforcementMode**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group +* **issues**: [AdaptiveApplicationControlIssueSummary](#adaptiveapplicationcontrolissuesummary)[] (ReadOnly): Array of AdaptiveApplicationControlIssueSummary +* **pathRecommendations**: [PathRecommendation](#pathrecommendation)[]: Array of PathRecommendation +* **protectionMode**: [ProtectionMode](#protectionmode): The protection mode of the collection/file types. Exe/Msi/Script are used for Windows, Executable is used for Linux. +* **recommendationStatus**: 'NoStatus' | 'NotAvailable' | 'NotRecommended' | 'Recommended' | string (ReadOnly): The initial recommendation status of the machine group or machine +* **sourceSystem**: 'Azure_AppLocker' | 'Azure_AuditD' | 'NonAzure_AppLocker' | 'NonAzure_AuditD' | 'None' | string (ReadOnly): The source type of the machine group +* **vmRecommendations**: [VmRecommendation](#vmrecommendation)[]: Array of VmRecommendation -## SecurityAssessmentPropertiesAdditionalData +## AdaptiveApplicationControlIssueSummary ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **issue**: 'ExecutableViolationsAudited' | 'MsiAndScriptViolationsAudited' | 'MsiAndScriptViolationsBlocked' | 'RulesViolatedManually' | 'ViolationsAudited' | 'ViolationsBlocked' | string: An alert that machines within a group can have +* **numberOfVms**: int: The number of machines in the group that have this alert ## AssessmentLinks ### Properties * **azurePortalUri**: string (ReadOnly): Link to assessment in Azure Portal -## SecurityAssessmentPartnerData +## AssessmentStatus ### Properties -* **partnerName**: string (Required): Name of the company of the partner -* **secret**: string (Required): secret to authenticate the partner - write only - -## ResourceDetails -* **Discriminator**: source +* **cause**: string: Programmatic code for the cause of the assessment status +* **code**: 'Healthy' | 'NotApplicable' | 'Unhealthy' | string (Required): Programmatic code for the status of the assessment +* **description**: string: Human readable description of the assessment status -### Base Properties -### AzureResourceDetails -#### Properties -* **id**: string (ReadOnly): Azure resource Id of the assessed resource -* **source**: 'Azure' (Required): The platform where the assessed resource resides +## JitNetworkAccessPolicyProperties +### Properties +* **provisioningState**: string (ReadOnly): Gets the provisioning state of the Just-in-Time policy. +* **requests**: [JitNetworkAccessRequest](#jitnetworkaccessrequest)[]: Array of JitNetworkAccessRequest +* **virtualMachines**: [JitNetworkAccessPolicyVirtualMachine](#jitnetworkaccesspolicyvirtualmachine)[] (Required): Configurations for Microsoft.Compute/virtualMachines resource type. -### OnPremiseSqlResourceDetails -#### Properties -* **databaseName**: string (Required): The Sql database name installed on the machine -* **serverName**: string (Required): The Sql server name installed on the machine -* **source**: 'OnPremiseSql' (Required): The platform where the assessed resource resides +## JitNetworkAccessPolicyVirtualMachine +### Properties +* **id**: string (Required): Resource ID of the virtual machine that is linked to this policy +* **ports**: [JitNetworkAccessPortRule](#jitnetworkaccessportrule)[] (Required): Port configurations for the virtual machine +* **publicIpAddress**: string: Public IP address of the Azure Firewall that is linked to this policy, if applicable +## JitNetworkAccessPortRule +### Properties +* **allowedSourceAddressPrefix**: string: 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". +* **allowedSourceAddressPrefixes**: string[]: Mutually exclusive with the "allowedSourceAddressPrefix" parameter. +* **maxRequestAccessDuration**: string (Required): Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day +* **number**: int (Required) +* **protocol**: '*' | 'TCP' | 'UDP' | string (Required) -## AssessmentStatus +## JitNetworkAccessRequest ### Properties -* **cause**: string: Programmatic code for the cause of the assessment status -* **code**: 'Healthy' | 'NotApplicable' | 'Unhealthy' | string (Required): Programmatic code for the status of the assessment -* **description**: string: Human readable description of the assessment status +* **justification**: string: The justification for making the initiate request +* **requestor**: string (Required): The identity of the person who made the request +* **startTimeUtc**: string (Required): The start time of the request in UTC +* **virtualMachines**: [JitNetworkAccessRequestVirtualMachine](#jitnetworkaccessrequestvirtualmachine)[] (Required): Array of JitNetworkAccessRequestVirtualMachine -## AdaptiveApplicationControlGroupData +## JitNetworkAccessRequestPort ### Properties -* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string (ReadOnly): The configuration status of the machines group or machine or rule -* **enforcementMode**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group -* **issues**: [AdaptiveApplicationControlIssueSummary](#adaptiveapplicationcontrolissuesummary)[] (ReadOnly): Array of AdaptiveApplicationControlIssueSummary -* **pathRecommendations**: [PathRecommendation](#pathrecommendation)[]: Array of PathRecommendation -* **protectionMode**: [ProtectionMode](#protectionmode): The protection mode of the collection/file types. Exe/Msi/Script are used for Windows, Executable is used for Linux. -* **recommendationStatus**: 'NoStatus' | 'NotAvailable' | 'NotRecommended' | 'Recommended' | string (ReadOnly): The initial recommendation status of the machine group or machine -* **sourceSystem**: 'Azure_AppLocker' | 'Azure_AuditD' | 'NonAzure_AppLocker' | 'NonAzure_AuditD' | 'None' | string (ReadOnly): The source type of the machine group -* **vmRecommendations**: [VmRecommendation](#vmrecommendation)[]: Array of VmRecommendation +* **allowedSourceAddressPrefix**: string: 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". +* **allowedSourceAddressPrefixes**: string[]: Mutually exclusive with the "allowedSourceAddressPrefix" parameter. +* **endTimeUtc**: string (Required): The date & time at which the request ends in UTC +* **mappedPort**: int: The port which is mapped to this port's `number` in the Azure Firewall, if applicable +* **number**: int (Required) +* **status**: 'Initiated' | 'Revoked' | string (Required): The status of the port +* **statusReason**: 'Expired' | 'NewerRequestInitiated' | 'UserRequested' | string (Required): A description of why the `status` has its value -## AdaptiveApplicationControlIssueSummary +## JitNetworkAccessRequestVirtualMachine ### Properties -* **issue**: 'ExecutableViolationsAudited' | 'MsiAndScriptViolationsAudited' | 'MsiAndScriptViolationsBlocked' | 'RulesViolatedManually' | 'ViolationsAudited' | 'ViolationsBlocked' | string: An alert that machines within a group can have -* **numberOfVms**: int: The number of machines in the group that have this alert +* **id**: string (Required): Resource ID of the virtual machine that is linked to this policy +* **ports**: [JitNetworkAccessRequestPort](#jitnetworkaccessrequestport)[] (Required): The ports that were opened for the virtual machine ## PathRecommendation ### Properties @@ -143,6 +128,13 @@ * **usernames**: [UserRecommendation](#userrecommendation)[]: Array of UserRecommendation * **userSids**: string[]: Array of PathRecommendationUserSidsItem +## ProtectionMode +### Properties +* **exe**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group +* **executable**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group +* **msi**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group +* **script**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group + ## PublisherInfo ### Properties * **binaryName**: string: The "OriginalName" field taken from the file's version resource @@ -150,68 +142,76 @@ * **publisherName**: string: The Subject field of the x.509 certificate used to sign the code, using the following fields - O = Organization, L = Locality, S = State or Province, and C = Country * **version**: string: The binary file version taken from the file's version resource -## UserRecommendation -### Properties -* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string: The recommendation action of the machine or rule -* **username**: string: Represents a user that is recommended to be allowed for a certain rule +## ResourceDetails +* **Discriminator**: source -## ProtectionMode -### Properties -* **exe**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group -* **executable**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group -* **msi**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group -* **script**: 'Audit' | 'Enforce' | 'None' | string: The application control policy enforcement/protection mode of the machine group +### Base Properties +### AzureResourceDetails +#### Properties +* **id**: string (ReadOnly): Azure resource Id of the assessed resource +* **source**: 'Azure' (Required): The platform where the assessed resource resides -## VmRecommendation -### Properties -* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string: The configuration status of the machines group or machine or rule -* **enforcementSupport**: 'NotSupported' | 'Supported' | 'Unknown' | string: The machine supportability of Enforce feature -* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string: The recommendation action of the machine or rule -* **resourceId**: string: The full resource id of the machine +### OnPremiseSqlResourceDetails +#### Properties +* **databaseName**: string (Required): The Sql database name installed on the machine +* **serverName**: string (Required): The Sql server name installed on the machine +* **source**: 'OnPremiseSql' (Required): The platform where the assessed resource resides -## JitNetworkAccessPolicyProperties -### Properties -* **provisioningState**: string (ReadOnly): Gets the provisioning state of the Just-in-Time policy. -* **requests**: [JitNetworkAccessRequest](#jitnetworkaccessrequest)[]: Array of JitNetworkAccessRequest -* **virtualMachines**: [JitNetworkAccessPolicyVirtualMachine](#jitnetworkaccesspolicyvirtualmachine)[] (Required): Configurations for Microsoft.Compute/virtualMachines resource type. -## JitNetworkAccessRequest +## SecurityAssessmentMetadataPartnerData ### Properties -* **justification**: string: The justification for making the initiate request -* **requestor**: string (Required): The identity of the person who made the request -* **startTimeUtc**: string (Required): The start time of the request in UTC -* **virtualMachines**: [JitNetworkAccessRequestVirtualMachine](#jitnetworkaccessrequestvirtualmachine)[] (Required): Array of JitNetworkAccessRequestVirtualMachine +* **partnerName**: string (Required): Name of the company of the partner +* **productName**: string: Name of the product of the partner that created the assessment +* **secret**: string (Required): Secret to authenticate the partner and verify it created the assessment - write only -## JitNetworkAccessRequestVirtualMachine +## SecurityAssessmentMetadataProperties ### Properties -* **id**: string (Required): Resource ID of the virtual machine that is linked to this policy -* **ports**: [JitNetworkAccessRequestPort](#jitnetworkaccessrequestport)[] (Required): The ports that were opened for the virtual machine +* **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | 'VerifiedPartner' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition +* **categories**: 'Compute' | 'Data' | 'IdentityAndAccess' | 'IoT' | 'Networking' | string[]: Array of categories +* **description**: string: Human readable description of the assessment +* **displayName**: string (Required): User friendly display name of the assessment +* **implementationEffort**: 'High' | 'Low' | 'Moderate' | string: The implementation effort required to remediate this assessment +* **partnerData**: [SecurityAssessmentMetadataPartnerData](#securityassessmentmetadatapartnerdata): Describes the partner that created the assessment +* **policyDefinitionId**: string (ReadOnly): Azure resource ID of the policy definition that turns this assessment calculation on +* **preview**: bool: True if this assessment is in preview release status +* **remediationDescription**: string: Human readable description of what you should do to mitigate this security issue +* **severity**: 'High' | 'Low' | 'Medium' | string (Required): The severity level of the assessment +* **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats +* **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment -## JitNetworkAccessRequestPort +## SecurityAssessmentPartnerData ### Properties -* **allowedSourceAddressPrefix**: string: 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". -* **allowedSourceAddressPrefixes**: string[]: Mutually exclusive with the "allowedSourceAddressPrefix" parameter. -* **endTimeUtc**: string (Required): The date & time at which the request ends in UTC -* **mappedPort**: int: The port which is mapped to this port's `number` in the Azure Firewall, if applicable -* **number**: int (Required) -* **status**: 'Initiated' | 'Revoked' | string (Required): The status of the port -* **statusReason**: 'Expired' | 'NewerRequestInitiated' | 'UserRequested' | string (Required): A description of why the `status` has its value +* **partnerName**: string (Required): Name of the company of the partner +* **secret**: string (Required): secret to authenticate the partner - write only -## JitNetworkAccessPolicyVirtualMachine +## SecurityAssessmentProperties ### Properties -* **id**: string (Required): Resource ID of the virtual machine that is linked to this policy -* **ports**: [JitNetworkAccessPortRule](#jitnetworkaccessportrule)[] (Required): Port configurations for the virtual machine -* **publicIpAddress**: string: Public IP address of the Azure Firewall that is linked to this policy, if applicable +* **additionalData**: [SecurityAssessmentPropertiesAdditionalData](#securityassessmentpropertiesadditionaldata): Additional data regarding the assessment +* **displayName**: string (ReadOnly): User friendly display name of the assessment +* **links**: [AssessmentLinks](#assessmentlinks) (ReadOnly): Links relevant to the assessment +* **metadata**: [SecurityAssessmentMetadataProperties](#securityassessmentmetadataproperties): Describes properties of an assessment metadata. +* **partnersData**: [SecurityAssessmentPartnerData](#securityassessmentpartnerdata): Data regarding 3rd party partner integration +* **resourceDetails**: [ResourceDetails](#resourcedetails) (Required): Details of the resource that was assessed +* **status**: [AssessmentStatus](#assessmentstatus) (Required): The result of the assessment -## JitNetworkAccessPortRule +## SecurityAssessmentPropertiesAdditionalData ### Properties -* **allowedSourceAddressPrefix**: string: 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". -* **allowedSourceAddressPrefixes**: string[]: Mutually exclusive with the "allowedSourceAddressPrefix" parameter. -* **maxRequestAccessDuration**: string (Required): Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day -* **number**: int (Required) -* **protocol**: '*' | 'TCP' | 'UDP' | string (Required) +### Additional Properties +* **Additional Properties Type**: string ## ServerVulnerabilityAssessmentProperties ### Properties * **provisioningState**: 'Canceled' | 'Deprovisioning' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): The provisioningState of the vulnerability assessment capability on the VM +## UserRecommendation +### Properties +* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string: The recommendation action of the machine or rule +* **username**: string: Represents a user that is recommended to be allowed for a certain rule + +## VmRecommendation +### Properties +* **configurationStatus**: 'Configured' | 'Failed' | 'InProgress' | 'NoStatus' | 'NotConfigured' | string: The configuration status of the machines group or machine or rule +* **enforcementSupport**: 'NotSupported' | 'Supported' | 'Unknown' | string: The machine supportability of Enforce feature +* **recommendationAction**: 'Add' | 'Recommended' | 'Remove' | string: The recommendation action of the machine or rule +* **resourceId**: string: The full resource id of the machine + diff --git a/generated/security/microsoft.security/2021-06-01/types.md b/generated/security/microsoft.security/2021-06-01/types.md index b843e280e4..cae2a4d9fb 100644 --- a/generated/security/microsoft.security/2021-06-01/types.md +++ b/generated/security/microsoft.security/2021-06-01/types.md @@ -18,6 +18,55 @@ * **properties**: [SecurityAssessmentProperties](#securityassessmentproperties): Describes properties of an assessment. * **type**: 'Microsoft.Security/assessments' (ReadOnly, DeployTimeConstant): The resource type +## AssessmentLinks +### Properties +* **azurePortalUri**: string (ReadOnly): Link to assessment in Azure Portal + +## AssessmentStatus +### Properties +* **cause**: string: Programmatic code for the cause of the assessment status +* **code**: 'Healthy' | 'NotApplicable' | 'Unhealthy' | string (Required): Programmatic code for the status of the assessment +* **description**: string: Human readable description of the assessment status +* **firstEvaluationDate**: string (ReadOnly): The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format +* **statusChangeDate**: string (ReadOnly): The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format + +## ResourceDetails +* **Discriminator**: source + +### Base Properties +### AzureResourceDetails +#### Properties +* **id**: string (ReadOnly): Azure resource Id of the assessed resource +* **source**: 'Azure' (Required): The platform where the assessed resource resides + +### OnPremiseSqlResourceDetails +#### Properties +* **databaseName**: string (Required): The Sql database name installed on the machine +* **serverName**: string (Required): The Sql server name installed on the machine +* **source**: 'OnPremiseSql' (Required): The platform where the assessed resource resides + + +## SecurityAssessmentMetadataPartnerData +### Properties +* **partnerName**: string (Required): Name of the company of the partner +* **productName**: string: Name of the product of the partner that created the assessment +* **secret**: string (Required): Secret to authenticate the partner and verify it created the assessment - write only + +## SecurityAssessmentMetadataProperties +### Properties +* **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | 'VerifiedPartner' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition +* **categories**: 'Compute' | 'Data' | 'IdentityAndAccess' | 'IoT' | 'Networking' | string[]: Array of categories +* **description**: string: Human readable description of the assessment +* **displayName**: string (Required): User friendly display name of the assessment +* **implementationEffort**: 'High' | 'Low' | 'Moderate' | string: The implementation effort required to remediate this assessment +* **partnerData**: [SecurityAssessmentMetadataPartnerData](#securityassessmentmetadatapartnerdata): Describes the partner that created the assessment +* **policyDefinitionId**: string (ReadOnly): Azure resource ID of the policy definition that turns this assessment calculation on +* **preview**: bool: True if this assessment is in preview release status +* **remediationDescription**: string: Human readable description of what you should do to mitigate this security issue +* **severity**: 'High' | 'Low' | 'Medium' | string (Required): The severity level of the assessment +* **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats +* **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment + ## SecurityAssessmentMetadataPropertiesResponse ### Properties * **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | 'VerifiedPartner' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition @@ -37,17 +86,16 @@ * **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats * **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment -## SecurityAssessmentMetadataPartnerData -### Properties -* **partnerName**: string (Required): Name of the company of the partner -* **productName**: string: Name of the product of the partner that created the assessment -* **secret**: string (Required): Secret to authenticate the partner and verify it created the assessment - write only - ## SecurityAssessmentMetadataPropertiesResponsePublishDates ### Properties * **GA**: string * **public**: string (Required) +## SecurityAssessmentPartnerData +### Properties +* **partnerName**: string (Required): Name of the company of the partner +* **secret**: string (Required): secret to authenticate the partner - write only + ## SecurityAssessmentProperties ### Properties * **additionalData**: [SecurityAssessmentPropertiesBaseAdditionalData](#securityassessmentpropertiesbaseadditionaldata): Additional data regarding the assessment @@ -63,51 +111,3 @@ ### Additional Properties * **Additional Properties Type**: string -## AssessmentLinks -### Properties -* **azurePortalUri**: string (ReadOnly): Link to assessment in Azure Portal - -## SecurityAssessmentMetadataProperties -### Properties -* **assessmentType**: 'BuiltIn' | 'CustomPolicy' | 'CustomerManaged' | 'VerifiedPartner' | string (Required): BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition -* **categories**: 'Compute' | 'Data' | 'IdentityAndAccess' | 'IoT' | 'Networking' | string[]: Array of categories -* **description**: string: Human readable description of the assessment -* **displayName**: string (Required): User friendly display name of the assessment -* **implementationEffort**: 'High' | 'Low' | 'Moderate' | string: The implementation effort required to remediate this assessment -* **partnerData**: [SecurityAssessmentMetadataPartnerData](#securityassessmentmetadatapartnerdata): Describes the partner that created the assessment -* **policyDefinitionId**: string (ReadOnly): Azure resource ID of the policy definition that turns this assessment calculation on -* **preview**: bool: True if this assessment is in preview release status -* **remediationDescription**: string: Human readable description of what you should do to mitigate this security issue -* **severity**: 'High' | 'Low' | 'Medium' | string (Required): The severity level of the assessment -* **threats**: 'accountBreach' | 'dataExfiltration' | 'dataSpillage' | 'denialOfService' | 'elevationOfPrivilege' | 'maliciousInsider' | 'missingCoverage' | 'threatResistance' | string[]: Array of threats -* **userImpact**: 'High' | 'Low' | 'Moderate' | string: The user impact of the assessment - -## SecurityAssessmentPartnerData -### Properties -* **partnerName**: string (Required): Name of the company of the partner -* **secret**: string (Required): secret to authenticate the partner - write only - -## ResourceDetails -* **Discriminator**: source - -### Base Properties -### AzureResourceDetails -#### Properties -* **id**: string (ReadOnly): Azure resource Id of the assessed resource -* **source**: 'Azure' (Required): The platform where the assessed resource resides - -### OnPremiseSqlResourceDetails -#### Properties -* **databaseName**: string (Required): The Sql database name installed on the machine -* **serverName**: string (Required): The Sql server name installed on the machine -* **source**: 'OnPremiseSql' (Required): The platform where the assessed resource resides - - -## AssessmentStatus -### Properties -* **cause**: string: Programmatic code for the cause of the assessment status -* **code**: 'Healthy' | 'NotApplicable' | 'Unhealthy' | string (Required): Programmatic code for the status of the assessment -* **description**: string: Human readable description of the assessment status -* **firstEvaluationDate**: string (ReadOnly): The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format -* **statusChangeDate**: string (ReadOnly): The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format - diff --git a/generated/security/microsoft.security/2021-07-01-preview/types.md b/generated/security/microsoft.security/2021-07-01-preview/types.md index f0aed73830..b3ca71cf5b 100644 --- a/generated/security/microsoft.security/2021-07-01-preview/types.md +++ b/generated/security/microsoft.security/2021-07-01-preview/types.md @@ -34,37 +34,6 @@ * **tags**: [Tags](#tags): A list of key value pairs that describe the resource. * **type**: 'Microsoft.Security/securityConnectors' (ReadOnly, DeployTimeConstant): The resource type -## CustomAssessmentAutomationRequestProperties -### Properties -* **assessmentKey**: string (ReadOnly): The assessment metadata key used when an assessment is generated for this assessment automation. -* **compressedQuery**: string: Base 64 encoded KQL query representing the assessment automation results required. -* **description**: string: The description to relate to the assessments generated by this assessment automation. -* **displayName**: string: The display name of the assessments generated by this assessment automation. -* **remediationDescription**: string: The remediation description to relate to the assessments generated by this assessment automation. -* **severity**: 'High' | 'Low' | 'Medium' | string: The severity to relate to the assessments generated by this assessment automation. -* **supportedCloud**: 'AWS' | 'GCP' | string: Relevant cloud for the custom assessment automation. - -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - -## CustomEntityStoreAssignmentRequestProperties -### Properties -* **entityStoreDatabaseLink**: string (ReadOnly): The link to entity store database. -* **principal**: string: The principal assigned with entity store. If not provided, will use caller principal. Format of principal is: [AAD type]=[PrincipalObjectId];[TenantId] - -## SecurityConnectorProperties -### Properties -* **cloudName**: 'AWS' | 'Azure' | 'GCP' | string: The multi cloud resource's cloud name. -* **hierarchyIdentifier**: string: The multi cloud resource identifier (account id in case of AWS connector). -* **offerings**: [CloudOffering](#cloudoffering)[]: A collection of offerings for the security connector. -* **organizationalData**: [SecurityConnectorPropertiesOrganizationalData](#securityconnectorpropertiesorganizationaldata): The multi cloud account's organizational data - ## CloudOffering * **Discriminator**: offeringType @@ -99,6 +68,21 @@ ### Properties * **cloudRoleArn**: string: The cloud role ARN in AWS for this feature +## CustomAssessmentAutomationRequestProperties +### Properties +* **assessmentKey**: string (ReadOnly): The assessment metadata key used when an assessment is generated for this assessment automation. +* **compressedQuery**: string: Base 64 encoded KQL query representing the assessment automation results required. +* **description**: string: The description to relate to the assessments generated by this assessment automation. +* **displayName**: string: The display name of the assessments generated by this assessment automation. +* **remediationDescription**: string: The remediation description to relate to the assessments generated by this assessment automation. +* **severity**: 'High' | 'Low' | 'Medium' | string: The severity to relate to the assessments generated by this assessment automation. +* **supportedCloud**: 'AWS' | 'GCP' | string: Relevant cloud for the custom assessment automation. + +## CustomEntityStoreAssignmentRequestProperties +### Properties +* **entityStoreDatabaseLink**: string (ReadOnly): The link to entity store database. +* **principal**: string: The principal assigned with entity store. If not provided, will use caller principal. Format of principal is: [AAD type]=[PrincipalObjectId];[TenantId] + ## DefenderForContainersAwsOfferingCloudWatchToKinesis ### Properties * **cloudRoleArn**: string: The cloud role ARN in AWS for this feature @@ -134,6 +118,13 @@ ### Properties * **cloudRoleArn**: string: The cloud role ARN in AWS for this feature +## SecurityConnectorProperties +### Properties +* **cloudName**: 'AWS' | 'Azure' | 'GCP' | string: The multi cloud resource's cloud name. +* **hierarchyIdentifier**: string: The multi cloud resource identifier (account id in case of AWS connector). +* **offerings**: [CloudOffering](#cloudoffering)[]: A collection of offerings for the security connector. +* **organizationalData**: [SecurityConnectorPropertiesOrganizationalData](#securityconnectorpropertiesorganizationaldata): The multi cloud account's organizational data + ## SecurityConnectorPropertiesOrganizationalData ### Properties * **excludedAccountIds**: string[]: If the multi cloud account is of membership type organization, list of accounts excluded from offering @@ -141,6 +132,15 @@ * **parentHierarchyId**: string: If the multi cloud account is not of membership type organization, this will be the ID of the account's parent * **stacksetName**: string: If the multi cloud account is of membership type organization, this will be the name of the onboarding stackset +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. + ## Tags ### Properties ### Additional Properties diff --git a/generated/security/microsoft.security/2021-08-01-preview/types.md b/generated/security/microsoft.security/2021-08-01-preview/types.md index 0597006b61..e0a15b4cb1 100644 --- a/generated/security/microsoft.security/2021-08-01-preview/types.md +++ b/generated/security/microsoft.security/2021-08-01-preview/types.md @@ -28,6 +28,14 @@ * **tags**: [Tags](#tags): A list of key value pairs that describe the resource. * **type**: 'Microsoft.Security/standards' (ReadOnly, DeployTimeConstant): The resource type +## AssignedComponentItem +### Properties +* **key**: string: unique key to a security assessment object + +## AssignedStandardItem +### Properties +* **id**: string: full resourceId of the Microsoft.Security/standard object + ## AssignmentProperties ### Properties * **additionalData**: [AssignmentPropertiesAdditionalData](#assignmentpropertiesadditionaldata): Additional data about the assignment @@ -44,13 +52,18 @@ ### Properties * **exemptionCategory**: string: Exemption category of this assignment -## AssignedComponentItem +## StandardComponentProperties ### Properties -* **key**: string: unique key to a security assessment object +* **key**: string: Component Key matching componentMetadata -## AssignedStandardItem +## StandardProperties ### Properties -* **id**: string: full resourceId of the Microsoft.Security/standard object +* **category**: string: category of the standard provided +* **components**: [StandardComponentProperties](#standardcomponentproperties)[]: List of component objects containing component unique keys (such as assessment keys) to apply to standard scope. Currently only supports assessment keys. +* **description**: string: description of the standard +* **displayName**: string: display name of the standard, equivalent to the standardId +* **standardType**: string (ReadOnly): standard type (Custom or BuiltIn only currently) +* **supportedClouds**: 'AWS' | 'GCP'[]: List of all standard supported clouds. ## SystemData ### Properties @@ -66,19 +79,6 @@ ### Additional Properties * **Additional Properties Type**: string -## StandardProperties -### Properties -* **category**: string: category of the standard provided -* **components**: [StandardComponentProperties](#standardcomponentproperties)[]: List of component objects containing component unique keys (such as assessment keys) to apply to standard scope. Currently only supports assessment keys. -* **description**: string: description of the standard -* **displayName**: string: display name of the standard, equivalent to the standardId -* **standardType**: string (ReadOnly): standard type (Custom or BuiltIn only currently) -* **supportedClouds**: 'AWS' | 'GCP'[]: List of all standard supported clouds. - -## StandardComponentProperties -### Properties -* **key**: string: Component Key matching componentMetadata - ## Tags ### Properties ### Additional Properties diff --git a/generated/security/microsoft.security/2021-12-01-preview/types.md b/generated/security/microsoft.security/2021-12-01-preview/types.md index 681fd41e49..2ea0d0c033 100644 --- a/generated/security/microsoft.security/2021-12-01-preview/types.md +++ b/generated/security/microsoft.security/2021-12-01-preview/types.md @@ -14,33 +14,6 @@ * **tags**: [Tags](#tags): A list of key value pairs that describe the resource. * **type**: 'Microsoft.Security/securityConnectors' (ReadOnly, DeployTimeConstant): The resource type -## SecurityConnectorProperties -### Properties -* **environmentData**: [EnvironmentData](#environmentdata): The security connector environment data. -* **environmentName**: 'AWS' | 'Azure' | 'GCP' | 'Github' | string: The multi cloud resource's cloud name. -* **hierarchyIdentifier**: string: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). -* **offerings**: [CloudOffering](#cloudoffering)[]: A collection of offerings for the security connector. - -## EnvironmentData -* **Discriminator**: environmentType - -### Base Properties -### AWSEnvironmentData -#### Properties -* **environmentType**: 'AwsAccount' (Required): The type of the environment data. -* **organizationalData**: [AwsOrganizationalData](#awsorganizationaldata): The awsOrganization data - -### GcpProjectEnvironmentData -#### Properties -* **environmentType**: 'GcpProject' (Required): The type of the environment data. -* **organizationalData**: [GcpOrganizationalData](#gcporganizationaldata): The gcpOrganization data -* **projectDetails**: [GcpProjectDetails](#gcpprojectdetails): The details about the project represented by the security connector - -### GithubScopeEnvironmentData -#### Properties -* **environmentType**: 'GithubScope' (Required): The type of the environment data. - - ## AwsOrganizationalData * **Discriminator**: organizationMembershipType @@ -57,29 +30,6 @@ * **stacksetName**: string: If the multi cloud account is of membership type organization, this will be the name of the onboarding stackset -## GcpOrganizationalData -* **Discriminator**: organizationMembershipType - -### Base Properties -### GcpOrganizationalDataMember -#### Properties -* **organizationMembershipType**: 'Member' (Required): The multi cloud account's membership type in the organization -* **parentHierarchyId**: string: If the multi cloud account is not of membership type organization, this will be the ID of the project's parent - -### GcpOrganizationalDataOrganization -#### Properties -* **excludedProjectNumbers**: string[]: If the multi cloud account is of membership type organization, list of accounts excluded from offering -* **organizationMembershipType**: 'Organization' (Required): The multi cloud account's membership type in the organization -* **serviceAccountEmailAddress**: string: The service account email address which represents the organization level permissions container. -* **workloadIdentityProviderId**: string: The GCP workload identity provider id which represents the permissions required to auto provision security connectors - - -## GcpProjectDetails -### Properties -* **projectId**: string: The GCP Project id -* **projectNumber**: string: The unique GCP Project number -* **workloadIdentityPoolId**: string (ReadOnly): The GCP workload identity federation pool id - ## CloudOffering * **Discriminator**: offeringType @@ -241,10 +191,60 @@ ### Properties * **type**: 'Qualys' | 'TVM' | string: The Vulnerability Assessment solution to be provisioned. Can be either 'TVM' or 'Qualys' +## EnvironmentData +* **Discriminator**: environmentType + +### Base Properties +### AWSEnvironmentData +#### Properties +* **environmentType**: 'AwsAccount' (Required): The type of the environment data. +* **organizationalData**: [AwsOrganizationalData](#awsorganizationaldata): The awsOrganization data + +### GcpProjectEnvironmentData +#### Properties +* **environmentType**: 'GcpProject' (Required): The type of the environment data. +* **organizationalData**: [GcpOrganizationalData](#gcporganizationaldata): The gcpOrganization data +* **projectDetails**: [GcpProjectDetails](#gcpprojectdetails): The details about the project represented by the security connector + +### GithubScopeEnvironmentData +#### Properties +* **environmentType**: 'GithubScope' (Required): The type of the environment data. + + +## GcpOrganizationalData +* **Discriminator**: organizationMembershipType + +### Base Properties +### GcpOrganizationalDataMember +#### Properties +* **organizationMembershipType**: 'Member' (Required): The multi cloud account's membership type in the organization +* **parentHierarchyId**: string: If the multi cloud account is not of membership type organization, this will be the ID of the project's parent + +### GcpOrganizationalDataOrganization +#### Properties +* **excludedProjectNumbers**: string[]: If the multi cloud account is of membership type organization, list of accounts excluded from offering +* **organizationMembershipType**: 'Organization' (Required): The multi cloud account's membership type in the organization +* **serviceAccountEmailAddress**: string: The service account email address which represents the organization level permissions container. +* **workloadIdentityProviderId**: string: The GCP workload identity provider id which represents the permissions required to auto provision security connectors + + +## GcpProjectDetails +### Properties +* **projectId**: string: The GCP Project id +* **projectNumber**: string: The unique GCP Project number +* **workloadIdentityPoolId**: string (ReadOnly): The GCP workload identity federation pool id + ## InformationProtectionAwsOfferingInformationProtection ### Properties * **cloudRoleArn**: string: The cloud role ARN in AWS for this feature +## SecurityConnectorProperties +### Properties +* **environmentData**: [EnvironmentData](#environmentdata): The security connector environment data. +* **environmentName**: 'AWS' | 'Azure' | 'GCP' | 'Github' | string: The multi cloud resource's cloud name. +* **hierarchyIdentifier**: string: The multi cloud resource identifier (account id in case of AWS connector, project number in case of GCP connector). +* **offerings**: [CloudOffering](#cloudoffering)[]: A collection of offerings for the security connector. + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). diff --git a/generated/securityandcompliance/log.out b/generated/securityandcompliance/log.out index 0fa43c9209..8f393937b5 100644 --- a/generated/securityandcompliance/log.out +++ b/generated/securityandcompliance/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.securityandcompliance-2021-01-11"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityandcompliance/resource-manager/Microsoft.SecurityAndCompliance/stable/2021-01-11/common-types.json:205:5 @@ -31,10 +31,10 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'OperationResultsDescription-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityandcompliance/resource-manager/Microsoft.SecurityAndCompliance/stable/2021-01-11/common-types.json#/components/schemas/OperationResultsDescription-properties -info | autorest.bicep took 16ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.securityandcompliance-2021-03-08"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ServiceAccessPolicyEntry' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityandcompliance/resource-manager/Microsoft.SecurityAndCompliance/stable/2021-03-08/common-types.json:208:5 @@ -60,4 +60,4 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'OperationResultsDescription-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityandcompliance/resource-manager/Microsoft.SecurityAndCompliance/stable/2021-03-08/common-types.json#/components/schemas/OperationResultsDescription-properties info | autorest.bicep took 6ms -info | Autorest completed in 10.74s. 4 files generated. +info | Autorest completed in 10.35s. 4 files generated. diff --git a/generated/securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.md b/generated/securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.md index 26f3cb43e8..180fe34e5c 100644 --- a/generated/securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.md +++ b/generated/securityandcompliance/microsoft.securityandcompliance/2021-01-11/types.md @@ -125,22 +125,29 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## PrivateEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ServicesProperties +## PrivateEndpointConnection ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ServiceAccessPolicyEntry ### Properties @@ -169,38 +176,22 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState +## ServicesProperties ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## SystemData +## ServicesResourceIdentity ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. ## ServicesResourceTags ### Properties @@ -227,3 +218,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.md b/generated/securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.md index 746a09b2d3..d3d25d3e3a 100644 --- a/generated/securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.md +++ b/generated/securityandcompliance/microsoft.securityandcompliance/2021-03-08/types.md @@ -150,22 +150,29 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell/privateEndpointConnections' (ReadOnly, DeployTimeConstant): The resource type -## ServicesResourceIdentity +## PrivateEndpoint ### Properties -* **principalId**: string (ReadOnly): The principal ID of the resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of the resource. -* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## ServicesProperties +## PrivateEndpointConnection ### Properties -* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. -* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information -* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. -* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. -* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ServiceAccessPolicyEntry ### Properties @@ -194,38 +201,22 @@ ### Properties * **storageAccountName**: string: The name of the default export storage account. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - -## PrivateLinkServiceConnectionState +## ServicesProperties ### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +* **accessPolicies**: [ServiceAccessPolicyEntry](#serviceaccesspolicyentry)[]: The access policies of the service instance. +* **authenticationConfiguration**: [ServiceAuthenticationConfigurationInfo](#serviceauthenticationconfigurationinfo): Authentication configuration information +* **corsConfiguration**: [ServiceCorsConfigurationInfo](#servicecorsconfigurationinfo): The settings for the CORS configuration of the service instance. +* **cosmosDbConfiguration**: [ServiceCosmosDbConfigurationInfo](#servicecosmosdbconfigurationinfo): The settings for the Cosmos DB database backing the service. +* **exportConfiguration**: [ServiceExportConfigurationInfo](#serviceexportconfigurationinfo): Export operation configuration information +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: The list of private endpoint connections that are set up for this resource. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Deprovisioned' | 'Failed' | 'Succeeded' | 'Updating' | 'Verifying' | string (ReadOnly): The provisioning state. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Control permission for data plane traffic coming from public networks while private endpoint is enabled. -## SystemData +## ServicesResourceIdentity ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **principalId**: string (ReadOnly): The principal ID of the resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of the resource. +* **type**: 'None' | 'SystemAssigned' | string: Type of identity being specified, currently SystemAssigned and None are allowed. ## ServicesResourceTags ### Properties @@ -257,3 +248,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/securityinsights/log.out b/generated/securityinsights/log.out index 15f928d1a9..43124b1fed 100644 --- a/generated/securityinsights/log.out +++ b/generated/securityinsights/log.out @@ -1,53 +1,149 @@ - -WARNING: AutoRest has not been tested with Node versions greater than v14. - -AutoRest code generation utility [cli version: 3.4.2; node: v16.13.0] +AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] (C) 2018 Microsoft Corporation. https://aka.ms/autorest -info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.6.6) +info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +info | Processing batch task - {"tag":"microsoft.securityinsights-2022-04-01-preview"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. +info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +warning | SkippedSemanticValidation | Semantic validation was skipped. +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-graphQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2136:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-sampleQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2147:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-dataTypesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2158:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-connectivityCriteriaItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2169:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-instructionStepsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2188:11 +warning | PreCheck/SchemaMissingType | The schema 'Permissions-resourceProviderItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2547:11 +warning | PreCheck/SchemaMissingType | The schema 'Permissions-customsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2558:11 +warning | PreCheck/SchemaMissingType | The schema 'InstructionSteps-instructionsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/dataConnectors.json:2653:11 +warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. +warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties +warning | Modeler/MissingType | The schema 'components·2sbdb2·schemas·watchlistitemproperties·properties·itemskeyvalue·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/Watchlists.json#/components/schemas/components·2sbdb2·schemas·watchlistitemproperties·properties·itemskeyvalue·additionalproperties +warning | Modeler/MissingType | The schema 'components·84fvid·schemas·watchlistitemproperties·properties·entitymapping·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-04-01-preview/Watchlists.json#/components/schemas/components·84fvid·schemas·watchlistitemproperties·properties·entitymapping·additionalproperties +warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories': Unable to find type segments +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +info | autorest.bicep took 49ms +info | Processing batch task - {"tag":"microsoft.securityinsights-2022-01-01-preview"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. +info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +warning | SkippedSemanticValidation | Semantic validation was skipped. +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-graphQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2136:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-sampleQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2147:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-dataTypesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2158:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-connectivityCriteriaItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2169:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-instructionStepsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2188:11 +warning | PreCheck/SchemaMissingType | The schema 'Permissions-resourceProviderItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2547:11 +warning | PreCheck/SchemaMissingType | The schema 'Permissions-customsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2558:11 +warning | PreCheck/SchemaMissingType | The schema 'InstructionSteps-instructionsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/dataConnectors.json:2653:11 +warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. +warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties +warning | Modeler/MissingType | The schema 'components·2sbdb2·schemas·watchlistitemproperties·properties·itemskeyvalue·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#/components/schemas/components·2sbdb2·schemas·watchlistitemproperties·properties·itemskeyvalue·additionalproperties +warning | Modeler/MissingType | The schema 'components·84fvid·schemas·watchlistitemproperties·properties·entitymapping·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/Watchlists.json#/components/schemas/components·84fvid·schemas·watchlistitemproperties·properties·entitymapping·additionalproperties +warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories': Unable to find type segments +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +info | autorest.bicep took 40ms +info | Processing batch task - {"tag":"microsoft.securityinsights-2021-10-01-preview"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. +info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +warning | SkippedSemanticValidation | Semantic validation was skipped. +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-graphQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2067:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-sampleQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2078:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-dataTypesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2089:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-connectivityCriteriaItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2100:11 +warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-instructionStepsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2119:11 +warning | PreCheck/SchemaMissingType | The schema 'Permissions-resourceProviderItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2478:11 +warning | PreCheck/SchemaMissingType | The schema 'Permissions-customsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2489:11 +warning | PreCheck/SchemaMissingType | The schema 'InstructionSteps-instructionsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/dataConnectors.json:2584:11 +warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. +warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties +warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories': Unable to find type segments +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +info | autorest.bicep took 29ms info | Processing batch task - {"tag":"microsoft.securityinsights-2021-09-01-preview"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MicrosoftSecurityIncidentCreationAlertRuleTemplate-properties' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:3031:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/AlertRules.json:1256:9 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-graphQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:18317:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:1877:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-sampleQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:18357:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:1888:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-dataTypesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:18397:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:1899:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-connectivityCriteriaItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:18437:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:1910:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-instructionStepsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:18477:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:1929:11 warning | PreCheck/SchemaMissingType | The schema 'Permissions-resourceProviderItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:19798:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:2288:11 warning | PreCheck/SchemaMissingType | The schema 'Permissions-customsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:19838:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:2299:11 warning | PreCheck/SchemaMissingType | The schema 'InstructionSteps-instructionsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:20107:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/dataConnectors.json:2394:11 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ScheduledAlertRuleTemplate-properties' has a property 'tactics' that is already declared the parent schema 'QueryBasedAlertRuleTemplateProperties' but isn't significantly different. The property has been removed from ScheduledAlertRuleTemplate-properties -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-09-01-preview/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories': Unable to find type segments @@ -60,167 +156,173 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 30ms +info | autorest.bicep took 27ms +info | Processing batch task - {"tag":"microsoft.securityinsights-2021-10-01"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. +info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) +warning | SkippedSemanticValidation | Semantic validation was skipped. +warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. +warning | PreCheck/DuplicateSchema | Duplicate Schema named 'IncidentOwnerInfo' (1 differences): + - properties.ownerType: => {"x-ms-enum":{"modelAsString":true,"name":"OwnerType","values":[{"description":"The incident owner type is unknown","value":"Unknown"},{"description":"The incident owner type is an AAD user","value":"User"},{"description":"The incident owner type is an AAD group","value":"Group"}]},"$ref":"#/components/schemas/OwnerType","description":"The type of the owner the incident is assigned to."} +warning | PreCheck/PropertyRedeclarationWarning | Schema 'MCASDataConnectorDataTypes' has a property 'alerts' that is already declared the parent schema 'AlertsDataTypeOfDataConnector' but isn't significantly different. The property has been removed from MCASDataConnectorDataTypes +warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: + file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-10-01/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties +warning | PreNamer/DeduplicateName | Deduplicating schema name: 'IncidentOwnerInfo' -> 'IncidentOwnerInfoAutoGenerated' +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +warning | Unrecognized property type: any-object. Returning 'any'. +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.securityinsights-2021-04-01"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'IncidentAlertList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:2311:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json:1699:5 warning | PreCheck/SchemaMissingType | The schema 'CloudError' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:9117:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json:497:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 7ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.securityinsights-2020-01-01"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'MCASDataConnectorDataTypes' has a property 'alerts' that is already declared the parent schema 'AlertsDataTypeOfDataConnector' but isn't significantly different. The property has been removed from MCASDataConnectorDataTypes -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.securityinsights-2021-03-01-preview"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RepoList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:9816:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json:287:5 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-graphQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12386:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1190:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-sampleQueriesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12426:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1201:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-dataTypesItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12466:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1212:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-connectivityCriteriaItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12506:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1223:11 warning | PreCheck/SchemaMissingType | The schema 'CodelessUiConnectorConfigProperties-instructionStepsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12546:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1242:11 warning | PreCheck/SchemaMissingType | The schema 'Permissions-resourceProviderItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12674:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1286:11 warning | PreCheck/SchemaMissingType | The schema 'Permissions-customsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12714:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1297:11 warning | PreCheck/SchemaMissingType | The schema 'InstructionSteps-instructionsItem' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12983:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json:1392:11 warning | PreCheck/SchemaMissingType | The schema 'WatchlistList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:13392:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json:448:5 warning | PreCheck/SchemaMissingType | The schema 'WatchlistItemList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:13901:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json:598:5 warning | PreCheck/SchemaMissingType | The schema 'MicrosoftSecurityIncidentCreationAlertRuleTemplate-properties' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:15967:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json:1290:9 warning | PreCheck/SchemaMissingType | The schema 'EntityQueryList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:17208:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json:258:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'SourceControl' has a property 'systemData' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SourceControl -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories': Unable to find type segments warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 15ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.securityinsights-2019-01-01-preview"} . +warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. +warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AutomationRulesList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:1331:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json:394:5 warning | PreCheck/SchemaMissingType | The schema 'BookmarkExpandResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:1907:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json:555:5 warning | PreCheck/SchemaMissingType | The schema 'BookmarkExpandParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:2003:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json:584:5 warning | PreCheck/SchemaMissingType | The schema 'CaseCommentList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:2502:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json:728:5 warning | PreCheck/SchemaMissingType | The schema 'CaseList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:2643:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json:773:5 warning | PreCheck/SchemaMissingType | The schema 'EnrichmentDomainWhois' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:4404:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json:141:5 warning | PreCheck/SchemaMissingType | The schema 'EnrichmentDomainWhoisDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:4534:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json:173:5 warning | PreCheck/SchemaMissingType | The schema 'EnrichmentDomainWhoisRegistrarDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:4640:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json:200:5 warning | PreCheck/SchemaMissingType | The schema 'EnrichmentDomainWhoisContacts' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:4784:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json:229:5 warning | PreCheck/SchemaMissingType | The schema 'EnrichmentDomainWhoisContact' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:4818:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json:250:5 warning | PreCheck/SchemaMissingType | The schema 'EnrichmentIpGeodata' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:5065:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json:298:5 warning | PreCheck/SchemaMissingType | The schema 'EntityGetInsightsResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:5944:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:712:5 warning | PreCheck/SchemaMissingType | The schema 'EntityExpandParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6073:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:745:5 warning | PreCheck/SchemaMissingType | The schema 'EntityExpandResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6157:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:765:5 warning | PreCheck/SchemaMissingType | The schema 'EntityList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6392:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:832:5 warning | PreCheck/SchemaMissingType | The schema 'EntityTimelineResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6489:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:866:5 warning | PreCheck/SchemaMissingType | The schema 'EntityTimelineParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6535:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:909:5 warning | PreCheck/SchemaMissingType | The schema 'EntityQueryItemProperties-dataTypesItem' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6797:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:975:11 warning | PreCheck/SchemaMissingType | The schema 'InsightsTableResult-columnsItem' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:6957:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:1011:11 warning | PreCheck/SchemaMissingType | The schema 'InsightQueryItemProperties-tableQuery-columnsDefinitionsItem' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:7262:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:1081:15 warning | PreCheck/SchemaMissingType | The schema 'InsightQueryItemProperties-tableQuery-queriesDefinitionsItem' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:7332:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:1111:15 warning | PreCheck/SchemaMissingType | The schema 'InsightQueryItemProperties-tableQuery-queriesDefinitions-properties-itemsItem' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:7436:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:1128:21 warning | PreCheck/SchemaMissingType | The schema 'GetQueriesResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:7823:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json:1238:5 warning | PreCheck/SchemaMissingType | The schema 'MLBehaviorAnalyticsAlertRuleTemplate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:8730:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:2415:9 warning | PreCheck/SchemaMissingType | The schema 'EntityQueryList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12119:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:4035:5 warning | PreCheck/SchemaMissingType | The schema 'ConnectedEntity' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:12494:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:4136:5 warning | PreCheck/SchemaMissingType | The schema 'FusionAlertRuleTemplate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:13041:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:4344:9 warning | PreCheck/SchemaMissingType | The schema 'ThreatIntelligenceAlertRuleTemplate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:13312:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:4449:9 warning | PreCheck/SchemaMissingType | The schema 'MicrosoftSecurityIncidentCreationAlertRuleTemplate-properties' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:17648:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:6044:9 warning | PreCheck/SchemaMissingType | The schema 'Operation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:17911:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:6170:5 warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:18913:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:6578:5 warning | PreCheck/SchemaMissingType | The schema 'ResourceWithEtag' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:19001:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:6599:5 warning | PreCheck/SchemaMissingType | The schema 'ScheduledAlertRuleTemplate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:19490:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:6771:9 warning | PreCheck/SchemaMissingType | The schema 'SettingList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:20619:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:7306:5 warning | PreCheck/SchemaMissingType | The schema 'WatchlistList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:22325:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:7919:5 warning | PreCheck/SchemaMissingType | The schema 'WatchlistItemList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:22812:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:8064:5 warning | PreCheck/SchemaMissingType | The schema 'ThreatIntelligenceInformationList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:23443:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json:555:5 warning | PreCheck/SchemaMissingType | The schema 'ThreatIntelligenceMetricsList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:25299:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json:1055:5 warning | PreCheck/SchemaMissingType | The schema 'ThreatIntelligenceMetrics' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - - openapi-document.json:25344:4 + - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json:1070:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/DuplicateSchema | Duplicate Schema named 'AggregationsKind' (5 differences): - properties: {"kind":{"x-ms-enum":{"modelAsString":true,"name":"AggregationsKind"},"$ref":"#/components/schemas/AggregationsKind","description":"The kind of the setting"}} => @@ -271,16 +373,6 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'ThreatIntelligenceS - type: "object" => "string" - enum: => ["unsorted","ascending","descending"] - x-ms-enum: => {"modelAsString":true,"name":"ThreatIntelligenceSortingCriteria","values":[{"value":"unsorted"},{"value":"ascending"},{"value":"descending"}]} -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Modeler/MissingType | The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties warning | PreNamer/DeduplicateName | Deduplicating schema name: 'AggregationsKind' -> 'AggregationsKindAutoGenerated' @@ -295,5 +387,5 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'ResourceWithEta warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms -info | Generation Complete +info | autorest.bicep took 10ms +info | Autorest completed in 92.27s. 18 files generated. diff --git a/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json b/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json index ceb65a5faf..a12c7ef059 100644 --- a/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json +++ b/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":12,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":115,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdBy":{"Type":116,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"lastModifiedBy":{"Type":116,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled."},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":13,"Flags":1,"Description":"The type of object the automation rule triggers on"},"triggersWhen":{"Type":14,"Flags":1,"Description":"The type of event the automation rule triggers on"},"conditions":{"Type":82,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"6":{"Value":"Created"}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":16}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"conditionProperties":{"Type":17,"Flags":1,"Description":"The configuration of the automation rule condition"},"conditionType":{"Type":81,"Flags":1,"Description":"The type of the automation rule condition"}}}},{"2":{"Name":"AutomationRulePropertyValuesConditionProperties","Properties":{"propertyName":{"Type":70,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":79,"Flags":0,"Description":"The operator to use for evaluation the condition"},"propertyValues":{"Type":80,"Flags":0,"Description":"The values to use for evaluating the condition"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[71,72,73,74,75,76,77,78]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":15}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule action"}},"Elements":{"ModifyProperties":84,"RunPlaybook":112}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":85,"Flags":1,"Description":"The configuration of the modify properties automation rule action"},"actionType":{"Type":111,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleModifyPropertiesActionConfiguration","Properties":{"classification":{"Type":90,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":95,"Flags":0,"Description":"The classification reason the incident was closed with"},"labels":{"Type":100,"Flags":0,"Description":"List of labels to add to the incident"},"owner":{"Type":101,"Flags":0,"Description":"Information on the user an incident is assigned to"},"severity":{"Type":106,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":110,"Flags":0,"Description":"The status of the incident"}}}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[86,87,88,89]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[91,92,93,94]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":99,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[97,98]}},{"3":{"ItemType":96}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[102,103,104,105]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[107,108,109]}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":113,"Flags":1,"Description":"The configuration of the run playbook automation rule action"},"actionType":{"Type":114,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleRunPlaybookActionConfiguration","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":83}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2019-01-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":118,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":119,"Flags":10,"Description":"The resource api version"},"properties":{"Type":121,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":122,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":123,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":122,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":124,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":129,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[125,126,127,128]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2019-01-01-preview","ScopeType":16,"Body":120}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":131,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":132,"Flags":10,"Description":"The resource api version"},"properties":{"Type":134,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2019-01-01-preview","ScopeType":16,"Body":133}},{"6":{"Value":"Microsoft.SecurityInsights/cases"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/cases","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":136,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":137,"Flags":10,"Description":"The resource api version"},"properties":{"Type":139,"Flags":0,"Description":"Describes case properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"CaseProperties","Properties":{"caseNumber":{"Type":3,"Flags":2,"Description":"a sequential number"},"closeReason":{"Type":145,"Flags":0,"Description":"The reason the case was closed"},"closedReasonText":{"Type":4,"Flags":0,"Description":"the case close reason details"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the case was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the case"},"endTimeUtc":{"Type":4,"Flags":0,"Description":"The end time of the case"},"labels":{"Type":146,"Flags":0,"Description":"List of labels relevant to this case"},"lastComment":{"Type":4,"Flags":2,"Description":"the last comment in the case"},"lastUpdatedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the case was updated"},"metrics":{"Type":147,"Flags":2,"Description":"Dictionary of metrics, for example the number of alerts in the case"},"owner":{"Type":122,"Flags":0,"Description":"User information that made some action"},"relatedAlertIds":{"Type":148,"Flags":2,"Description":"List of related alert identifiers"},"relatedAlertProductNames":{"Type":149,"Flags":2,"Description":"List of related alert product names"},"tactics":{"Type":164,"Flags":2,"Description":"The tactics associated with case"},"severity":{"Type":170,"Flags":1,"Description":"The severity of the case"},"startTimeUtc":{"Type":4,"Flags":0,"Description":"The start time of the case"},"status":{"Type":175,"Flags":1,"Description":"The status of the case"},"title":{"Type":4,"Flags":1,"Description":"The title of the case"},"totalComments":{"Type":3,"Flags":2,"Description":"the number of total comments in the case"}}}},{"6":{"Value":"Resolved"}},{"6":{"Value":"Dismissed"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"FalsePositive"}},{"6":{"Value":"Other"}},{"5":{"Elements":[140,141,142,143,144]}},{"3":{"ItemType":4}},{"2":{"Name":"CasePropertiesMetrics","Properties":{},"AdditionalProperties":3}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[150,151,152,153,154,155,156,157,158,159,160,161,162]}},{"3":{"ItemType":163}},{"6":{"Value":"Critical"}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[165,166,167,168,169]}},{"6":{"Value":"Draft"}},{"6":{"Value":"New"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[171,172,173,174]}},{"4":{"Name":"Microsoft.SecurityInsights/cases@2019-01-01-preview","ScopeType":16,"Body":138}},{"6":{"Value":"Microsoft.SecurityInsights/cases/comments"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/cases/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":177,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":178,"Flags":10,"Description":"The resource api version"},"properties":{"Type":180,"Flags":0,"Description":"Case comment property bag."}}}},{"2":{"Name":"CaseCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"userInfo":{"Type":122,"Flags":2,"Description":"User information that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/cases/comments@2019-01-01-preview","ScopeType":16,"Body":179}},{"6":{"Value":"Microsoft.SecurityInsights/cases/relations"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/cases/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":182,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":183,"Flags":10,"Description":"The resource api version"},"properties":{"Type":185,"Flags":0,"Description":"Relation input properties"},"kind":{"Type":191,"Flags":2,"Description":"The type of relation node"},"etag":{"Type":4,"Flags":0,"Description":"ETag for relation"}}}},{"2":{"Name":"RelationsModelInputProperties","Properties":{"relationName":{"Type":4,"Flags":0,"Description":"Name of relation"},"sourceRelationNode":{"Type":186,"Flags":4,"Description":"Relation node"},"targetRelationNode":{"Type":186,"Flags":4,"Description":"Relation node"},"bookmarkId":{"Type":4,"Flags":2,"Description":"The case related bookmark id"},"caseIdentifier":{"Type":4,"Flags":2,"Description":"The case identifier"},"bookmarkName":{"Type":4,"Flags":2,"Description":"The case related bookmark name"}}}},{"2":{"Name":"RelationNode","Properties":{"relationNodeId":{"Type":4,"Flags":4,"Description":"Relation Node Id"},"relationNodeKind":{"Type":189,"Flags":6,"Description":"The type of relation node"},"etag":{"Type":4,"Flags":4,"Description":"Etag for relation node"},"relationAdditionalProperties":{"Type":190,"Flags":4,"Description":"Additional set of properties"}}}},{"6":{"Value":"Case"}},{"6":{"Value":"Bookmark"}},{"5":{"Elements":[187,188]}},{"2":{"Name":"RelationNodeRelationAdditionalProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"CasesToBookmarks"}},{"4":{"Name":"Microsoft.SecurityInsights/cases/relations@2019-01-01-preview","ScopeType":16,"Body":184}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"kind":{"Type":201,"Flags":1,"Description":"The kind of the alert rule"}}}},{"6":{"Value":"Scheduled"}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"6":{"Value":"Fusion"}},{"6":{"Value":"MLBehaviorAnalytics"}},{"6":{"Value":"ThreatIntelligence"}},{"5":{"Elements":[196,197,198,199,200]}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2019-01-01-preview","ScopeType":16,"Body":195}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":206,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":207,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":4,"Description":"The identity that created the resource."},"createdByType":{"Type":212,"Flags":4,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":4,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":4,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":217,"Flags":4,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":4,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[208,209,210,211]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[213,214,215,216]}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2019-01-01-preview","ScopeType":16,"Body":205}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/dataConnectors","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":219,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":220,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"kind":{"Type":235,"Flags":1,"Description":"The kind of the data connector"}}}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"AzureSecurityCenter"}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"6":{"Value":"ThreatIntelligence"}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"6":{"Value":"Office365"}},{"6":{"Value":"OfficeATP"}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"6":{"Value":"Dynamics365"}},{"6":{"Value":"MicrosoftThreatProtection"}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"5":{"Elements":[222,223,224,225,226,227,228,229,230,231,232,233,234]}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2019-01-01-preview","ScopeType":16,"Body":221}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/settings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":237,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":238,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"kind":{"Type":244,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"Anomalies"}},{"6":{"Value":"EyesOn"}},{"6":{"Value":"EntityAnalytics"}},{"6":{"Value":"Ueba"}},{"5":{"Elements":[240,241,242,243]}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2019-01-01-preview","ScopeType":16,"Body":239}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":246,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":247,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":250,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":271,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":276,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":277,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":101,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":278,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":283,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":287,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":251,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":266,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[252,253,254,255,256,257,258,259,260,261,262,263,264]}},{"3":{"ItemType":265}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[267,268,269,270]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[272,273,274,275]}},{"3":{"ItemType":96}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[279,280,281,282]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[284,285,286]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2019-01-01-preview","ScopeType":16,"Body":248}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":289,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":290,"Flags":10,"Description":"The resource api version"},"properties":{"Type":292,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":116,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2019-01-01-preview","ScopeType":16,"Body":291}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":294,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":295,"Flags":10,"Description":"The resource api version"},"properties":{"Type":134,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2019-01-01-preview","ScopeType":16,"Body":296}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":298,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":299,"Flags":10,"Description":"The resource api version"},"properties":{"Type":301,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":304,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":122,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":122,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":305,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[302,303]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2019-01-01-preview","ScopeType":16,"Body":300}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":307,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":308,"Flags":10,"Description":"The resource api version"},"properties":{"Type":310,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":122,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":122,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview","ScopeType":16,"Body":309}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":312,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":313,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":315,"Flags":4,"Description":"Describes threat intelligence entity properties"},"kind":{"Type":335,"Flags":1,"Description":"The kind of the threat intelligence entity"}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":316,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":317,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":319,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":323,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":326,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":329,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":330,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":331,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":332,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":333,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":334,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":318}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":322,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":321}},{"3":{"ItemType":320}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":325,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":324}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":328,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":327}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"6":{"Value":"indicator"}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2019-01-01-preview","ScopeType":16,"Body":314}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":12,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":117,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdBy":{"Type":118,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"lastModifiedBy":{"Type":118,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled."},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":14,"Flags":1,"Description":"The type of object the automation rule triggers on"},"triggersWhen":{"Type":16,"Flags":1,"Description":"The type of event the automation rule triggers on"},"conditions":{"Type":84,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"5":{"Elements":[13,4]}},{"6":{"Value":"Created"}},{"5":{"Elements":[15,4]}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":18}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"conditionProperties":{"Type":19,"Flags":1,"Description":"The configuration of the automation rule condition"},"conditionType":{"Type":83,"Flags":1,"Description":"The type of the automation rule condition"}}}},{"2":{"Name":"AutomationRulePropertyValuesConditionProperties","Properties":{"propertyName":{"Type":72,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":81,"Flags":0,"Description":"The operator to use for evaluation the condition"},"propertyValues":{"Type":82,"Flags":0,"Description":"The values to use for evaluating the condition"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,4]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[73,74,75,76,77,78,79,80,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":17}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule action"}},"Elements":{"ModifyProperties":86,"RunPlaybook":114}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":87,"Flags":1,"Description":"The configuration of the modify properties automation rule action"},"actionType":{"Type":113,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleModifyPropertiesActionConfiguration","Properties":{"classification":{"Type":92,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":97,"Flags":0,"Description":"The classification reason the incident was closed with"},"labels":{"Type":102,"Flags":0,"Description":"List of labels to add to the incident"},"owner":{"Type":103,"Flags":0,"Description":"Information on the user an incident is assigned to"},"severity":{"Type":108,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":112,"Flags":0,"Description":"The status of the incident"}}}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[88,89,90,91,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[93,94,95,96,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":101,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[99,100,4]}},{"3":{"ItemType":98}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[104,105,106,107,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[109,110,111,4]}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":115,"Flags":1,"Description":"The configuration of the run playbook automation rule action"},"actionType":{"Type":116,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleRunPlaybookActionConfiguration","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":85}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2019-01-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":120,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":121,"Flags":10,"Description":"The resource api version"},"properties":{"Type":123,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":124,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":125,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":124,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":126,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":131,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[127,128,129,130,4]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2019-01-01-preview","ScopeType":16,"Body":122}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":133,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":134,"Flags":10,"Description":"The resource api version"},"properties":{"Type":136,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2019-01-01-preview","ScopeType":16,"Body":135}},{"6":{"Value":"Microsoft.SecurityInsights/cases"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/cases","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":138,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":139,"Flags":10,"Description":"The resource api version"},"properties":{"Type":141,"Flags":0,"Description":"Describes case properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"CaseProperties","Properties":{"caseNumber":{"Type":3,"Flags":2,"Description":"a sequential number"},"closeReason":{"Type":147,"Flags":0,"Description":"The reason the case was closed"},"closedReasonText":{"Type":4,"Flags":0,"Description":"the case close reason details"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the case was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the case"},"endTimeUtc":{"Type":4,"Flags":0,"Description":"The end time of the case"},"labels":{"Type":148,"Flags":0,"Description":"List of labels relevant to this case"},"lastComment":{"Type":4,"Flags":2,"Description":"the last comment in the case"},"lastUpdatedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the case was updated"},"metrics":{"Type":149,"Flags":2,"Description":"Dictionary of metrics, for example the number of alerts in the case"},"owner":{"Type":124,"Flags":0,"Description":"User information that made some action"},"relatedAlertIds":{"Type":150,"Flags":2,"Description":"List of related alert identifiers"},"relatedAlertProductNames":{"Type":151,"Flags":2,"Description":"List of related alert product names"},"tactics":{"Type":166,"Flags":2,"Description":"The tactics associated with case"},"severity":{"Type":172,"Flags":1,"Description":"The severity of the case"},"startTimeUtc":{"Type":4,"Flags":0,"Description":"The start time of the case"},"status":{"Type":177,"Flags":1,"Description":"The status of the case"},"title":{"Type":4,"Flags":1,"Description":"The title of the case"},"totalComments":{"Type":3,"Flags":2,"Description":"the number of total comments in the case"}}}},{"6":{"Value":"Resolved"}},{"6":{"Value":"Dismissed"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"FalsePositive"}},{"6":{"Value":"Other"}},{"5":{"Elements":[142,143,144,145,146,4]}},{"3":{"ItemType":4}},{"2":{"Name":"CasePropertiesMetrics","Properties":{},"AdditionalProperties":3}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[152,153,154,155,156,157,158,159,160,161,162,163,164,4]}},{"3":{"ItemType":165}},{"6":{"Value":"Critical"}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[167,168,169,170,171,4]}},{"6":{"Value":"Draft"}},{"6":{"Value":"New"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[173,174,175,176,4]}},{"4":{"Name":"Microsoft.SecurityInsights/cases@2019-01-01-preview","ScopeType":16,"Body":140}},{"6":{"Value":"Microsoft.SecurityInsights/cases/comments"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/cases/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":179,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":180,"Flags":10,"Description":"The resource api version"},"properties":{"Type":182,"Flags":0,"Description":"Case comment property bag."}}}},{"2":{"Name":"CaseCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"userInfo":{"Type":124,"Flags":2,"Description":"User information that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/cases/comments@2019-01-01-preview","ScopeType":16,"Body":181}},{"6":{"Value":"Microsoft.SecurityInsights/cases/relations"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/cases/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":184,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":185,"Flags":10,"Description":"The resource api version"},"properties":{"Type":187,"Flags":0,"Description":"Relation input properties"},"kind":{"Type":194,"Flags":2,"Description":"The type of relation node"},"etag":{"Type":4,"Flags":0,"Description":"ETag for relation"}}}},{"2":{"Name":"RelationsModelInputProperties","Properties":{"relationName":{"Type":4,"Flags":0,"Description":"Name of relation"},"sourceRelationNode":{"Type":188,"Flags":4,"Description":"Relation node"},"targetRelationNode":{"Type":188,"Flags":4,"Description":"Relation node"},"bookmarkId":{"Type":4,"Flags":2,"Description":"The case related bookmark id"},"caseIdentifier":{"Type":4,"Flags":2,"Description":"The case identifier"},"bookmarkName":{"Type":4,"Flags":2,"Description":"The case related bookmark name"}}}},{"2":{"Name":"RelationNode","Properties":{"relationNodeId":{"Type":4,"Flags":4,"Description":"Relation Node Id"},"relationNodeKind":{"Type":191,"Flags":6,"Description":"The type of relation node"},"etag":{"Type":4,"Flags":4,"Description":"Etag for relation node"},"relationAdditionalProperties":{"Type":192,"Flags":4,"Description":"Additional set of properties"}}}},{"6":{"Value":"Case"}},{"6":{"Value":"Bookmark"}},{"5":{"Elements":[189,190,4]}},{"2":{"Name":"RelationNodeRelationAdditionalProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"CasesToBookmarks"}},{"5":{"Elements":[193,4]}},{"4":{"Name":"Microsoft.SecurityInsights/cases/relations@2019-01-01-preview","ScopeType":16,"Body":186}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":196,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":197,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"kind":{"Type":204,"Flags":1,"Description":"The kind of the alert rule"}}}},{"6":{"Value":"Scheduled"}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"6":{"Value":"Fusion"}},{"6":{"Value":"MLBehaviorAnalytics"}},{"6":{"Value":"ThreatIntelligence"}},{"5":{"Elements":[199,200,201,202,203,4]}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2019-01-01-preview","ScopeType":16,"Body":198}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":206,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":207,"Flags":10,"Description":"The resource api version"},"properties":{"Type":209,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":210,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":4,"Description":"The identity that created the resource."},"createdByType":{"Type":215,"Flags":4,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":4,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":4,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":220,"Flags":4,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":4,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[211,212,213,214,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[216,217,218,219,4]}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2019-01-01-preview","ScopeType":16,"Body":208}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/dataConnectors","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":222,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":223,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"kind":{"Type":238,"Flags":1,"Description":"The kind of the data connector"}}}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"AzureSecurityCenter"}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"6":{"Value":"ThreatIntelligence"}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"6":{"Value":"Office365"}},{"6":{"Value":"OfficeATP"}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"6":{"Value":"Dynamics365"}},{"6":{"Value":"MicrosoftThreatProtection"}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"5":{"Elements":[225,226,227,228,229,230,231,232,233,234,235,236,237,4]}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2019-01-01-preview","ScopeType":16,"Body":224}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/settings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":240,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":241,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"kind":{"Type":247,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"Anomalies"}},{"6":{"Value":"EyesOn"}},{"6":{"Value":"EntityAnalytics"}},{"6":{"Value":"Ueba"}},{"5":{"Elements":[243,244,245,246,4]}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2019-01-01-preview","ScopeType":16,"Body":242}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":249,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":250,"Flags":10,"Description":"The resource api version"},"properties":{"Type":252,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":253,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":274,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":279,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":280,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":103,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":281,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":286,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":290,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":254,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":269,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[255,256,257,258,259,260,261,262,263,264,265,266,267,4]}},{"3":{"ItemType":268}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[270,271,272,273,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[275,276,277,278,4]}},{"3":{"ItemType":98}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[282,283,284,285,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[287,288,289,4]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2019-01-01-preview","ScopeType":16,"Body":251}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":292,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":293,"Flags":10,"Description":"The resource api version"},"properties":{"Type":295,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":118,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2019-01-01-preview","ScopeType":16,"Body":294}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":297,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":298,"Flags":10,"Description":"The resource api version"},"properties":{"Type":136,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2019-01-01-preview","ScopeType":16,"Body":299}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":301,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":302,"Flags":10,"Description":"The resource api version"},"properties":{"Type":304,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":307,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":124,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":124,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":308,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[305,306,4]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2019-01-01-preview","ScopeType":16,"Body":303}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":310,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":311,"Flags":10,"Description":"The resource api version"},"properties":{"Type":313,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":124,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":124,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2019-01-01-preview","ScopeType":16,"Body":312}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2019-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":315,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":316,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":318,"Flags":4,"Description":"Describes threat intelligence entity properties"},"kind":{"Type":339,"Flags":1,"Description":"The kind of the threat intelligence entity"}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":319,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":320,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":322,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":326,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":329,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":332,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":333,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":334,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":335,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":336,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":337,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":321}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":325,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":324}},{"3":{"ItemType":323}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":328,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":327}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":331,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":330}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"6":{"Value":"indicator"}},{"5":{"Elements":[338,4]}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2019-01-01-preview","ScopeType":16,"Body":317}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md b/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md index f38a74e409..c9d3afd565 100644 --- a/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md +++ b/generated/securityinsights/microsoft.securityinsights/2019-01-01-preview/types.md @@ -6,7 +6,7 @@ * **apiVersion**: '2019-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: Etag of the azure resource * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'Fusion' | 'MLBehaviorAnalytics' | 'MicrosoftSecurityIncidentCreation' | 'Scheduled' | 'ThreatIntelligence' (Required): The kind of the alert rule +* **kind**: 'Fusion' | 'MLBehaviorAnalytics' | 'MicrosoftSecurityIncidentCreation' | 'Scheduled' | 'ThreatIntelligence' | string (Required): The kind of the alert rule * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.SecurityInsights/alertRules' (ReadOnly, DeployTimeConstant): The resource type @@ -76,7 +76,7 @@ * **apiVersion**: '2019-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: ETag for relation * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'CasesToBookmarks' (ReadOnly): The type of relation node +* **kind**: 'CasesToBookmarks' | string (ReadOnly): The type of relation node * **name**: string (Required, DeployTimeConstant): The resource name * **properties**: [RelationsModelInputProperties](#relationsmodelinputproperties): Relation input properties * **type**: 'Microsoft.SecurityInsights/cases/relations' (ReadOnly, DeployTimeConstant): The resource type @@ -87,7 +87,7 @@ * **apiVersion**: '2019-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: Etag of the azure resource * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'AmazonWebServicesCloudTrail' | 'AzureActiveDirectory' | 'AzureAdvancedThreatProtection' | 'AzureSecurityCenter' | 'Dynamics365' | 'MicrosoftCloudAppSecurity' | 'MicrosoftDefenderAdvancedThreatProtection' | 'MicrosoftThreatIntelligence' | 'MicrosoftThreatProtection' | 'Office365' | 'OfficeATP' | 'ThreatIntelligence' | 'ThreatIntelligenceTaxii' (Required): The kind of the data connector +* **kind**: 'AmazonWebServicesCloudTrail' | 'AzureActiveDirectory' | 'AzureAdvancedThreatProtection' | 'AzureSecurityCenter' | 'Dynamics365' | 'MicrosoftCloudAppSecurity' | 'MicrosoftDefenderAdvancedThreatProtection' | 'MicrosoftThreatIntelligence' | 'MicrosoftThreatProtection' | 'Office365' | 'OfficeATP' | 'ThreatIntelligence' | 'ThreatIntelligenceTaxii' | string (Required): The kind of the data connector * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.SecurityInsights/dataConnectors' (ReadOnly, DeployTimeConstant): The resource type @@ -127,7 +127,7 @@ * **apiVersion**: '2019-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: Etag of the azure resource * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'Anomalies' | 'EntityAnalytics' | 'EyesOn' | 'Ueba' (Required): The kind of the setting +* **kind**: 'Anomalies' | 'EntityAnalytics' | 'EyesOn' | 'Ueba' | string (Required): The kind of the setting * **name**: string (Required, DeployTimeConstant): The resource name * **type**: 'Microsoft.SecurityInsights/settings' (ReadOnly, DeployTimeConstant): The resource type @@ -137,7 +137,7 @@ * **apiVersion**: '2019-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: Etag of the azure resource * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'indicator' (Required): The kind of the threat intelligence entity +* **kind**: 'indicator' | string (Required): The kind of the threat intelligence entity * **name**: string (Required, DeployTimeConstant): The resource name * **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties * **type**: 'Microsoft.SecurityInsights/threatIntelligence/indicators' (ReadOnly, DeployTimeConstant): The resource type @@ -168,26 +168,6 @@ * **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. * **workflowId**: string (ReadOnly): The name of the logic app's workflow. -## SystemData -### Properties -* **createdAt**: string (WriteOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (WriteOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' (WriteOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (WriteOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (WriteOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' (WriteOnly): The type of identity that created the resource. - -## AutomationRuleProperties -### Properties -* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered -* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created -* **displayName**: string (Required): The display name of the automation rule -* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated -* **order**: int (Required): The order of execution of the automation rule -* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic - ## AutomationRuleAction * **Discriminator**: actionType @@ -204,63 +184,55 @@ * **actionType**: 'RunPlaybook' (Required): The type of the automation rule action +## AutomationRuleCondition +* **Discriminator**: conditionType + +### Base Properties +### AutomationRulePropertyValuesCondition +#### Properties +* **conditionProperties**: [AutomationRulePropertyValuesConditionProperties](#automationrulepropertyvaluesconditionproperties) (Required): The configuration of the automation rule condition +* **conditionType**: 'Property' (Required): The type of the automation rule condition + + ## AutomationRuleModifyPropertiesActionConfiguration ### Properties -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed * **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with * **labels**: [IncidentLabel](#incidentlabel)[]: List of labels to add to the incident * **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the incident -* **status**: 'Active' | 'Closed' | 'New': The status of the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string: The status of the incident -## IncidentLabel +## AutomationRuleProperties ### Properties -* **labelName**: string (Required): The name of the label -* **labelType**: 'System' | 'User' (ReadOnly): The type of the label +* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered +* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created +* **displayName**: string (Required): The display name of the automation rule +* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated +* **order**: int (Required): The order of execution of the automation rule +* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic -## IncidentOwnerInfo +## AutomationRulePropertyValuesConditionProperties ### Properties -* **assignedTo**: string: The name of the user the incident is assigned to. -* **email**: string: The email of the user the incident is assigned to. -* **objectId**: string: The object id of the user the incident is assigned to. -* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. +* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith' | string: The operator to use for evaluation the condition +* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url' | string: The property to evaluate in an automation rule property condition +* **propertyValues**: string[]: The values to use for evaluating the condition ## AutomationRuleRunPlaybookActionConfiguration ### Properties * **logicAppResourceId**: string: The resource id of the playbook resource * **tenantId**: string: The tenant id of the playbook resource -## ClientInfo -### Properties -* **email**: string: The email of the client. -* **name**: string: The name of the client. -* **objectId**: string: The object id of the client. -* **userPrincipalName**: string: The user principal name of the client. - ## AutomationRuleTriggeringLogic ### Properties * **conditions**: [AutomationRuleCondition](#automationrulecondition)[]: The conditions to evaluate to determine if the automation rule should be triggered on a given object * **expirationTimeUtc**: string: Determines when the automation rule should automatically expire and be disabled. * **isEnabled**: bool (Required): Determines whether the automation rule is enabled or disabled. -* **triggersOn**: 'Incidents' (Required): The type of object the automation rule triggers on -* **triggersWhen**: 'Created' (Required): The type of event the automation rule triggers on - -## AutomationRuleCondition -* **Discriminator**: conditionType - -### Base Properties -### AutomationRulePropertyValuesCondition -#### Properties -* **conditionProperties**: [AutomationRulePropertyValuesConditionProperties](#automationrulepropertyvaluesconditionproperties) (Required): The configuration of the automation rule condition -* **conditionType**: 'Property' (Required): The type of the automation rule condition - - -## AutomationRulePropertyValuesConditionProperties -### Properties -* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith': The operator to use for evaluation the condition -* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url': The property to evaluate in an automation rule property condition -* **propertyValues**: string[]: The values to use for evaluating the condition +* **triggersOn**: 'Incidents' | string (Required): The type of object the automation rule triggers on +* **triggersWhen**: 'Created' | string (Required): The type of event the automation rule triggers on ## BookmarkProperties ### Properties @@ -278,31 +250,17 @@ * **updated**: string: The last time the bookmark was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action -## UserInfo -### Properties -* **email**: string (ReadOnly): The email of the user. -* **name**: string (ReadOnly): The name of the user. -* **objectId**: string: The object id of the user. - -## IncidentInfo -### Properties -* **incidentId**: string: Incident Id -* **relationName**: string: Relation Name -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the incident -* **title**: string: The title of the incident - -## RelationProperties +## CaseCommentProperties ### Properties -* **relatedResourceId**: string (Required): The resource ID of the related resource -* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource -* **relatedResourceName**: string (ReadOnly): The name of the related resource -* **relatedResourceType**: string (ReadOnly): The resource type of the related resource +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **message**: string (Required): The comment message +* **userInfo**: [UserInfo](#userinfo) (ReadOnly): User information that made some action ## CaseProperties ### Properties * **caseNumber**: int (ReadOnly): a sequential number * **closedReasonText**: string: the case close reason details -* **closeReason**: 'Dismissed' | 'FalsePositive' | 'Other' | 'Resolved' | 'TruePositive': The reason the case was closed +* **closeReason**: 'Dismissed' | 'FalsePositive' | 'Other' | 'Resolved' | 'TruePositive' | string: The reason the case was closed * **createdTimeUtc**: string (ReadOnly): The time the case was created * **description**: string: The description of the case * **endTimeUtc**: string: The end time of the case @@ -313,10 +271,10 @@ * **owner**: [UserInfo](#userinfo): User information that made some action * **relatedAlertIds**: string[] (ReadOnly): List of related alert identifiers * **relatedAlertProductNames**: string[] (ReadOnly): List of related alert product names -* **severity**: 'Critical' | 'High' | 'Informational' | 'Low' | 'Medium' (Required): The severity of the case +* **severity**: 'Critical' | 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the case * **startTimeUtc**: string: The start time of the case -* **status**: 'Closed' | 'Draft' | 'InProgress' | 'New' (Required): The status of the case -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics associated with case +* **status**: 'Closed' | 'Draft' | 'InProgress' | 'New' | string (Required): The status of the case +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with case * **title**: string (Required): The title of the case * **totalComments**: int (ReadOnly): the number of total comments in the case @@ -325,39 +283,58 @@ ### Additional Properties * **Additional Properties Type**: int -## CaseCommentProperties +## ClientInfo ### Properties +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. + +## EntityCommonPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## IncidentAdditionalData +### Properties +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with incident + +## IncidentCommentProperties +### Properties +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action * **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated * **message**: string (Required): The comment message -* **userInfo**: [UserInfo](#userinfo) (ReadOnly): User information that made some action -## RelationsModelInputProperties +## IncidentInfo ### Properties -* **bookmarkId**: string (ReadOnly): The case related bookmark id -* **bookmarkName**: string (ReadOnly): The case related bookmark name -* **caseIdentifier**: string (ReadOnly): The case identifier -* **relationName**: string: Name of relation -* **sourceRelationNode**: [RelationNode](#relationnode) (WriteOnly): Relation node -* **targetRelationNode**: [RelationNode](#relationnode) (WriteOnly): Relation node +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident -## RelationNode +## IncidentLabel ### Properties -* **etag**: string (WriteOnly): Etag for relation node -* **relationAdditionalProperties**: [RelationNodeRelationAdditionalProperties](#relationnoderelationadditionalproperties) (WriteOnly): Additional set of properties -* **relationNodeId**: string (WriteOnly): Relation Node Id -* **relationNodeKind**: 'Bookmark' | 'Case' (ReadOnly, WriteOnly): The type of relation node +* **labelName**: string (Required): The name of the label +* **labelType**: 'System' | 'User' | string (ReadOnly): The type of the label -## RelationNodeRelationAdditionalProperties +## IncidentOwnerInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. ## IncidentProperties ### Properties * **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed * **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with * **createdTimeUtc**: string (ReadOnly): The time the incident was created * **description**: string: The description of the incident * **firstActivityTimeUtc**: string: The time of the first activity in the incident @@ -370,24 +347,65 @@ * **providerIncidentId**: string: The incident ID assigned by the incident provider * **providerName**: string: The name of the source provider that generated the incident * **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (Required): The severity of the incident -* **status**: 'Active' | 'Closed' | 'New' (Required): The status of the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident * **title**: string (Required): The title of the incident -## IncidentAdditionalData +## RelationNode ### Properties -* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident -* **alertsCount**: int (ReadOnly): The number of alerts in the incident -* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident -* **commentsCount**: int (ReadOnly): The number of comments in the incident -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics associated with incident +* **etag**: string (WriteOnly): Etag for relation node +* **relationAdditionalProperties**: [RelationNodeRelationAdditionalProperties](#relationnoderelationadditionalproperties) (WriteOnly): Additional set of properties +* **relationNodeId**: string (WriteOnly): Relation Node Id +* **relationNodeKind**: 'Bookmark' | 'Case' | string (ReadOnly, WriteOnly): The type of relation node -## IncidentCommentProperties +## RelationNodeRelationAdditionalProperties ### Properties -* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the comment was created -* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated -* **message**: string (Required): The comment message +### Additional Properties +* **Additional Properties Type**: string + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource + +## RelationsModelInputProperties +### Properties +* **bookmarkId**: string (ReadOnly): The case related bookmark id +* **bookmarkName**: string (ReadOnly): The case related bookmark name +* **caseIdentifier**: string (ReadOnly): The case identifier +* **relationName**: string: Name of relation +* **sourceRelationNode**: [RelationNode](#relationnode) (WriteOnly): Relation node +* **targetRelationNode**: [RelationNode](#relationnode) (WriteOnly): Relation node + +## SystemData +### Properties +* **createdAt**: string (WriteOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (WriteOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (WriteOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (WriteOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (WriteOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (WriteOnly): The type of identity that created the resource. + +## ThreatIntelligenceExternalReference +### Properties +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL + +## ThreatIntelligenceExternalReferenceHashes +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThreatIntelligenceGranularMarkingModel +### Properties +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors ## ThreatIntelligenceIndicatorProperties ### Properties @@ -422,35 +440,11 @@ * **validFrom**: string (WriteOnly): Valid from * **validUntil**: string (WriteOnly): Valid until -## EntityCommonPropertiesAdditionalData -### Properties -### Additional Properties -* **Additional Properties Type**: any - ## ThreatIntelligenceIndicatorPropertiesExtensions ### Properties ### Additional Properties * **Additional Properties Type**: any -## ThreatIntelligenceExternalReference -### Properties -* **description**: string (WriteOnly): External reference description -* **externalId**: string (WriteOnly): External reference ID -* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes -* **sourceName**: string (WriteOnly): External reference source name -* **url**: string (WriteOnly): External reference URL - -## ThreatIntelligenceExternalReferenceHashes -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ThreatIntelligenceGranularMarkingModel -### Properties -* **language**: string (WriteOnly): Language granular marking model -* **markingRef**: int (WriteOnly): marking reference granular marking model -* **selectors**: string[] (WriteOnly): granular marking model selectors - ## ThreatIntelligenceKillChainPhase ### Properties * **killChainName**: string (WriteOnly): Kill chainName name @@ -466,6 +460,25 @@ * **value**: string (WriteOnly): Value of parsed pattern * **valueType**: string (WriteOnly): Type of the value +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: any: Any object +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: any (Required): Any object +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + ## WatchlistProperties ### Properties * **contentType**: string: The content type of the raw content. Example : text/csv or text/tsv @@ -479,7 +492,7 @@ * **numberOfLinesToSkip**: int: The number of lines in a csv/tsv content to skip before the header * **provider**: string (Required): The provider of the watchlist * **rawContent**: string: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint -* **source**: 'Local file' | 'Remote storage' (Required): The source of the watchlist +* **source**: 'Local file' | 'Remote storage' | string (Required): The source of the watchlist * **tenantId**: string: The tenantId where the watchlist belongs to * **updated**: string: The last time the watchlist was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action @@ -489,16 +502,3 @@ * **watchlistItemsCount**: int: The number of Watchlist Items in the Watchlist * **watchlistType**: string: The type of the watchlist -## WatchlistItemProperties -### Properties -* **created**: string: The time the watchlist item was created -* **createdBy**: [UserInfo](#userinfo): User information that made some action -* **entityMapping**: any: Any object -* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not -* **itemsKeyValue**: any (Required): Any object -* **tenantId**: string: The tenantId to which the watchlist item belongs to -* **updated**: string: The last time the watchlist item was updated -* **updatedBy**: [UserInfo](#userinfo): User information that made some action -* **watchlistItemId**: string: The id (a Guid) of the watchlist item -* **watchlistItemType**: string: The type of the watchlist item - diff --git a/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.json b/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.json index aab53bf2b5..0db9e496cb 100644 --- a/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.json +++ b/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2020-01-01"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}},"Elements":{"Fusion":11,"MicrosoftSecurityIncidentCreation":33,"Scheduled":50}}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":12,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":32,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":17,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":31,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[13,14,15,16]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[18,19,20,21,22,23,24,25,26,27,28,29]}},{"3":{"ItemType":30}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":34,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":49,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":35,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":36,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":42,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":48,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"5":{"Elements":[37,38,39,40,41]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[43,44,45,46]}},{"3":{"ItemType":47}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":51,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":76,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":65,"Flags":0,"Description":"The tactics of the alert rule"},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":70,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":75,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."}}}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[52,53,54,55,56,57,58,59,60,61,62,63]}},{"3":{"ItemType":64}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[66,67,68,69]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[71,72,73,74]}},{"6":{"Value":"Scheduled"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2020-01-01","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":78,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":79,"Flags":10,"Description":"The resource api version"},"properties":{"Type":81,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2020-01-01","ScopeType":16,"Body":80}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":83,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":84,"Flags":10,"Description":"The resource api version"},"properties":{"Type":86,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":87,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":88,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":87,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":89,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":1,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":94,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[90,91,92,93]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2020-01-01","ScopeType":16,"Body":85}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2020-01-01"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":96,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":97,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}},"Elements":{"AmazonWebServicesCloudTrail":99,"AzureActiveDirectory":107,"AzureAdvancedThreatProtection":115,"AzureSecurityCenter":118,"MicrosoftCloudAppSecurity":121,"MicrosoftDefenderAdvancedThreatProtection":125,"Office365":128,"ThreatIntelligence":144}}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":100,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":106,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":101,"Flags":0,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":102,"Flags":0,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":105,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[103,104]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":108,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":114,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":110,"Flags":0,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":113,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[111,112]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":116,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":117,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":119,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":120,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":122,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":124,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":123,"Flags":0,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":110,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":110,"Flags":0,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":126,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":127,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":129,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":143,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":130,"Flags":0,"Description":"The available data types for office data connector."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":131,"Flags":0,"Description":"Exchange data type connection."},"sharePoint":{"Type":135,"Flags":0,"Description":"SharePoint data type connection."},"teams":{"Type":139,"Flags":0,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":134,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[132,133]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":138,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[136,137]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":142,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[140,141]}},{"6":{"Value":"Office365"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":145,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":151,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":146,"Flags":0,"Description":"The available data types for TI (Threat Intelligence) data connector."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":147,"Flags":0,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":150,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[148,149]}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2020-01-01","ScopeType":16,"Body":98}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":153,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":154,"Flags":10,"Description":"The resource api version"},"properties":{"Type":156,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":157,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":177,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":182,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":187,"Flags":0,"Description":"List of labels relevant to this incident"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":188,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":189,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":194,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":198,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":158,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":172,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[159,160,161,162,163,164,165,166,167,168,169,170]}},{"3":{"ItemType":171}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[173,174,175,176]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[178,179,180,181]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":186,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[184,185]}},{"3":{"ItemType":183}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[190,191,192,193]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[195,196,197]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2020-01-01","ScopeType":16,"Body":155}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":200,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":201,"Flags":10,"Description":"The resource api version"},"properties":{"Type":203,"Flags":0,"Description":"Incident comment property bag."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":204,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2020-01-01","ScopeType":16,"Body":202}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2020-01-01"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}},"Elements":{"Fusion":11,"MicrosoftSecurityIncidentCreation":33,"Scheduled":50}}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":12,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":32,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":17,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":31,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[13,14,15,16,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[18,19,20,21,22,23,24,25,26,27,28,29,4]}},{"3":{"ItemType":30}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":34,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":49,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":35,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":36,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":42,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":48,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"5":{"Elements":[37,38,39,40,41,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[43,44,45,46,4]}},{"3":{"ItemType":47}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":51,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":76,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":65,"Flags":0,"Description":"The tactics of the alert rule"},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":70,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":75,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."}}}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[52,53,54,55,56,57,58,59,60,61,62,63,4]}},{"3":{"ItemType":64}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[66,67,68,69,4]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[71,72,73,74]}},{"6":{"Value":"Scheduled"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2020-01-01","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":78,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":79,"Flags":10,"Description":"The resource api version"},"properties":{"Type":81,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2020-01-01","ScopeType":16,"Body":80}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":83,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":84,"Flags":10,"Description":"The resource api version"},"properties":{"Type":86,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":87,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":88,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":87,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":89,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":1,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":94,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[90,91,92,93,4]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2020-01-01","ScopeType":16,"Body":85}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2020-01-01"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":96,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":97,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}},"Elements":{"AmazonWebServicesCloudTrail":99,"AzureActiveDirectory":107,"AzureAdvancedThreatProtection":115,"AzureSecurityCenter":118,"MicrosoftCloudAppSecurity":121,"MicrosoftDefenderAdvancedThreatProtection":125,"Office365":128,"ThreatIntelligence":144}}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":100,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":106,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":101,"Flags":0,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":102,"Flags":0,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":105,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[103,104,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":108,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":114,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":110,"Flags":0,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":113,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[111,112,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":116,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":117,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":119,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":120,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":122,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":124,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":123,"Flags":0,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":110,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":110,"Flags":0,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":126,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":127,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":109,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":129,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":143,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":130,"Flags":0,"Description":"The available data types for office data connector."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":131,"Flags":0,"Description":"Exchange data type connection."},"sharePoint":{"Type":135,"Flags":0,"Description":"SharePoint data type connection."},"teams":{"Type":139,"Flags":0,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":134,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[132,133,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":138,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[136,137,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":142,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[140,141,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":145,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":151,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":146,"Flags":0,"Description":"The available data types for TI (Threat Intelligence) data connector."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":147,"Flags":0,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":150,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[148,149,4]}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2020-01-01","ScopeType":16,"Body":98}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":153,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":154,"Flags":10,"Description":"The resource api version"},"properties":{"Type":156,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":157,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":177,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":182,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":187,"Flags":0,"Description":"List of labels relevant to this incident"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":188,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":189,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":194,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":198,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":158,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":172,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[159,160,161,162,163,164,165,166,167,168,169,170,4]}},{"3":{"ItemType":171}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[173,174,175,176,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[178,179,180,181,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":186,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[184,185,4]}},{"3":{"ItemType":183}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[190,191,192,193,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[195,196,197,4]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2020-01-01","ScopeType":16,"Body":155}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2020-01-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":200,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":201,"Flags":10,"Description":"The resource api version"},"properties":{"Type":203,"Flags":0,"Description":"Incident comment property bag."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":204,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2020-01-01","ScopeType":16,"Body":202}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.md b/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.md index 42d6744e31..c30356b412 100644 --- a/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.md +++ b/generated/securityinsights/microsoft.securityinsights/2020-01-01/types.md @@ -116,44 +116,15 @@ * **properties**: [IncidentCommentProperties](#incidentcommentproperties): Incident comment property bag. * **type**: 'Microsoft.SecurityInsights/incidents/comments' (ReadOnly, DeployTimeConstant): The resource type -## FusionAlertRuleProperties -### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule - -## MicrosoftSecurityIncidentCreationAlertRuleProperties +## AADDataConnectorProperties ### Properties -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated -* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' (Required): The alerts' productName on which the cases will be generated -* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium'[]: the alerts' severities on which the cases will be generated +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string: The tenant id to connect to, and get the data from. -## ScheduledAlertRuleProperties +## AatpDataConnectorProperties ### Properties -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. -* **query**: string: The query that creates alerts for this rule. -* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. -* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the alert -* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. -* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation'[]: The tactics of the alert rule -* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. -* **triggerThreshold**: int: The threshold triggers this alert rule. +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string: The tenant id to connect to, and get the data from. ## ActionRequestProperties ### Properties @@ -161,6 +132,28 @@ * **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. * **workflowId**: string (ReadOnly): The name of the logic app's workflow. +## AlertsDataTypeOfDataConnector +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. + +## ASCDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## AwsCloudTrailDataConnectorDataTypes +### Properties +* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs): Logs data type. + +## AwsCloudTrailDataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## AwsCloudTrailDataConnectorProperties +### Properties +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes): The available data types for Amazon Web Services CloudTrail data connector. + ## BookmarkProperties ### Properties * **created**: string: The time the bookmark was created @@ -177,74 +170,106 @@ * **updated**: string: The last time the bookmark was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action -## UserInfo +## ClientInfo ### Properties -* **email**: string (ReadOnly): The email of the user. -* **name**: string (ReadOnly): The name of the user. -* **objectId**: string (Required): The object id of the user. +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. -## IncidentInfo +## DataConnectorDataTypeCommon ### Properties -* **incidentId**: string: Incident Id -* **relationName**: string: Relation Name -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the incident -* **title**: string: The title of the incident +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. -## AwsCloudTrailDataConnectorProperties +## FusionAlertRuleProperties ### Properties -* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. -* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes): The available data types for Amazon Web Services CloudTrail data connector. +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule -## AwsCloudTrailDataConnectorDataTypes +## IncidentAdditionalData ### Properties -* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs): Logs data type. +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with incident -## AwsCloudTrailDataConnectorDataTypesLogs +## IncidentCommentProperties ### Properties -* **state**: 'Disabled' | 'Enabled': Describe whether this data type connection is enabled or not. +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **message**: string (Required): The comment message -## AADDataConnectorProperties +## IncidentInfo ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string: The tenant id to connect to, and get the data from. +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident -## AlertsDataTypeOfDataConnector +## IncidentLabel ### Properties -* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. +* **labelName**: string (Required): The name of the label +* **labelType**: 'System' | 'User' | string (ReadOnly): The type of the label -## DataConnectorDataTypeCommon +## IncidentOwnerInfo ### Properties -* **state**: 'Disabled' | 'Enabled': Describe whether this data type connection is enabled or not. +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. -## AatpDataConnectorProperties +## IncidentProperties ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string: The tenant id to connect to, and get the data from. +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **title**: string (Required): The title of the incident -## ASCDataConnectorProperties +## McasDataConnectorDataTypes ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **subscriptionId**: string: The subscription id to connect to, and get the data from. +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. +* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. ## McasDataConnectorProperties ### Properties * **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes): The available data types for MCAS (Microsoft Cloud App Security) data connector. * **tenantId**: string: The tenant id to connect to, and get the data from. -## McasDataConnectorDataTypes -### Properties -* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. -* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. - ## MdatpDataConnectorProperties ### Properties * **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. * **tenantId**: string: The tenant id to connect to, and get the data from. -## OfficeDataConnectorProperties +## MicrosoftSecurityIncidentCreationAlertRuleProperties ### Properties -* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes): The available data types for office data connector. -* **tenantId**: string: The tenant id to connect to, and get the data from. +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated ## OfficeDataConnectorDataTypes ### Properties @@ -254,21 +279,37 @@ ## OfficeDataConnectorDataTypesExchange ### Properties -* **state**: 'Disabled' | 'Enabled': Describe whether this data type connection is enabled or not. +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. ## OfficeDataConnectorDataTypesSharePoint ### Properties -* **state**: 'Disabled' | 'Enabled': Describe whether this data type connection is enabled or not. +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. ## OfficeDataConnectorDataTypesTeams ### Properties -* **state**: 'Disabled' | 'Enabled': Describe whether this data type connection is enabled or not. +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. -## TIDataConnectorProperties +## OfficeDataConnectorProperties ### Properties -* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes): The available data types for TI (Threat Intelligence) data connector. +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes): The available data types for office data connector. * **tenantId**: string: The tenant id to connect to, and get the data from. -* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## ScheduledAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation' | string[]: The tactics of the alert rule +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. ## TIDataConnectorDataTypes ### Properties @@ -276,58 +317,17 @@ ## TIDataConnectorDataTypesIndicators ### Properties -* **state**: 'Disabled' | 'Enabled': Describe whether this data type connection is enabled or not. - -## IncidentProperties -### Properties -* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed -* **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with -* **createdTimeUtc**: string (ReadOnly): The time the incident was created -* **description**: string: The description of the incident -* **firstActivityTimeUtc**: string: The time of the first activity in the incident -* **incidentNumber**: int (ReadOnly): A sequential number -* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal -* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident -* **lastActivityTimeUtc**: string: The time of the last activity in the incident -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated -* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to -* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (Required): The severity of the incident -* **status**: 'Active' | 'Closed' | 'New' (Required): The status of the incident -* **title**: string (Required): The title of the incident - -## IncidentAdditionalData -### Properties -* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident -* **alertsCount**: int (ReadOnly): The number of alerts in the incident -* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident -* **commentsCount**: int (ReadOnly): The number of comments in the incident -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation'[] (ReadOnly): The tactics associated with incident - -## IncidentLabel -### Properties -* **labelName**: string (Required): The name of the label -* **labelType**: 'System' | 'User' (ReadOnly): The type of the label - -## IncidentOwnerInfo -### Properties -* **assignedTo**: string: The name of the user the incident is assigned to. -* **email**: string: The email of the user the incident is assigned to. -* **objectId**: string: The object id of the user the incident is assigned to. -* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. -## IncidentCommentProperties +## TIDataConnectorProperties ### Properties -* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the comment was created -* **message**: string (Required): The comment message +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string: The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. -## ClientInfo +## UserInfo ### Properties -* **email**: string: The email of the client. -* **name**: string: The name of the client. -* **objectId**: string: The object id of the client. -* **userPrincipalName**: string: The user principal name of the client. +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string (Required): The object id of the user. diff --git a/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json b/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json index c82b56a25f..6e7e22fd63 100644 --- a/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json +++ b/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":12,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":33,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":38,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":43,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":44,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":49,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":54,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":58,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":59,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":13,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":28,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26]}},{"3":{"ItemType":27}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[29,30,31,32]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[34,35,36,37]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":42,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[40,41]}},{"3":{"ItemType":39}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":48,"Flags":2,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[45,46,47]}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[50,51,52,53]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[55,56,57]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":65,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":70,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[61,62,63,64]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[66,67,68,69]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-03-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":76,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-03-01-preview","ScopeType":16,"Body":74}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":78,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":79,"Flags":10,"Description":"The resource api version"},"properties":{"Type":81,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-03-01-preview","ScopeType":16,"Body":80}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":83,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":84,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":86,"EntityAnalytics":89,"EyesOn":92,"Ueba":95}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":87,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":88,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":90,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":91,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":93,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":94,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":96,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":103,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":102,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[97,98,99,100]}},{"3":{"ItemType":101}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2021-03-01-preview","ScopeType":16,"Body":85}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":105,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":106,"Flags":10,"Description":"The resource api version"},"properties":{"Type":108,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2021-03-01-preview","ScopeType":16,"Body":107}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":110,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":111,"Flags":10,"Description":"The resource api version"},"properties":{"Type":113,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":116,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":120,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":121,"Flags":1,"Description":"metadata of a repository."}}}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[114,115]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[117,118]}},{"3":{"ItemType":119}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":126,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":125,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[123,124]}},{"3":{"ItemType":122}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2021-03-01-preview","ScopeType":16,"Body":112}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":128,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":129,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"AmazonWebServicesCloudTrail":131,"AzureActiveDirectory":139,"AzureAdvancedThreatProtection":147,"AzureSecurityCenter":150,"Dynamics365":153,"GenericUI":161,"MicrosoftCloudAppSecurity":202,"MicrosoftDefenderAdvancedThreatProtection":206,"MicrosoftThreatIntelligence":209,"MicrosoftThreatProtection":221,"Office365":229,"OfficeATP":245,"ThreatIntelligence":248,"ThreatIntelligenceTaxii":256}}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":132,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":138,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":133,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":134,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":137,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[135,136]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":140,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":146,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":142,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":145,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[143,144]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":148,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":149,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":151,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":152,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":154,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":160,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":155,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":156,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":159,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[157,158]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":162,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":201,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":163,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":165,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":167,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":169,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":173,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":174,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":176,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":200,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":164}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":166}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":168}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":171,"Flags":0,"Description":"type of connectivity"},"value":{"Type":172,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"3":{"ItemType":4}},{"3":{"ItemType":170}},{"2":{"Name":"Availability","Properties":{"status":{"Type":175,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":190,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":192,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":184,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":188,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":189,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[178,179,180,181,182,183]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[185,186,187]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":177}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":191}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":199,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":198,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[195,196,197]}},{"3":{"ItemType":194}},{"3":{"ItemType":193}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":203,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":205,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":204,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":142,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":142,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":207,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":208,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":210,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":220,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":211,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":212,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":216,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":215,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[213,214]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":219,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[217,218]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":222,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":228,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":223,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":224,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":227,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[225,226]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":230,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":244,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":231,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":232,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":236,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":240,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":235,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[233,234]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":239,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[237,238]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":243,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[241,242]}},{"6":{"Value":"Office365"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":246,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":247,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":249,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":255,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":250,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":251,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":254,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[252,253]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":267,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":261,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":262,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[258,259,260]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":263,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":266,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[264,265]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2021-03-01-preview","ScopeType":16,"Body":130}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":269,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":270,"Flags":10,"Description":"The resource api version"},"properties":{"Type":272,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":275,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":276,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":276,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":277,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[273,274]}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-03-01-preview","ScopeType":16,"Body":271}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":279,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":280,"Flags":10,"Description":"The resource api version"},"properties":{"Type":282,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":276,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":276,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-03-01-preview","ScopeType":16,"Body":281}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":284,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":285,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":287,"MLBehaviorAnalytics":310,"MicrosoftSecurityIncidentCreation":333,"Scheduled":352,"ThreatIntelligence":440}}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":288,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":309,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":293,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":308,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[289,290,291,292]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[294,295,296,297,298,299,300,301,302,303,304,305,306]}},{"3":{"ItemType":307}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":311,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":332,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":316,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":331,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[312,313,314,315]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[317,318,319,320,321,322,323,324,325,326,327,328,329]}},{"3":{"ItemType":330}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":334,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":351,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":335,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":336,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":344,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":350,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[337,338,339,340,341,342,343]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[345,346,347,348]}},{"3":{"ItemType":349}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":353,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":439,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":368,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":369,"Flags":0,"Description":"Incident Configuration property bag."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":404,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":409,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":410,"Flags":0,"Description":"Event grouping settings property bag."},"customDetails":{"Type":414,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":437,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":438,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[354,355,356,357,358,359,360,361,362,363,364,365,366]}},{"3":{"ItemType":367}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":370,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":374,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":394,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":398,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":399,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[371,372,373]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392]}},{"3":{"ItemType":393}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[395,396]}},{"3":{"ItemType":397}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[400,401,402,403]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[405,406,407,408]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":413,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[411,412]}},{"2":{"Name":"ScheduledAlertRuleCommonPropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":434,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":436,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[416,417,418,419,420,421,422,423,424,425,426,427,428,429,430,431,432,433]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":435}},{"3":{"ItemType":415}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":441,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":462,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":446,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":461,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[442,443,444,445]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[447,448,449,450,451,452,453,454,455,456,457,458,459]}},{"3":{"ItemType":460}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2021-03-01-preview","ScopeType":16,"Body":286}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":464,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":465,"Flags":10,"Description":"The resource api version"},"properties":{"Type":467,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2021-03-01-preview","ScopeType":16,"Body":466}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":472,"Expansion":502}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":473,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":501,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":474,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":496,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":498,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":500,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[475,476,477,478,479,480,481,482,483,484,485,486,487,488,489,490,491,492,493,494,495]}},{"3":{"ItemType":4}},{"3":{"ItemType":497}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":499}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":503,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":551,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":504,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":526,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":527,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":550,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[505,506,507,508,509,510,511,512,513,514,515,516,517,518,519,520,521,522,523,524,525]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[528,529,530,531,532,533,534,535,536,537,538,539,540,541,542,543,544,545,546,547,548]}},{"3":{"ItemType":549}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2021-03-01-preview","ScopeType":16,"Body":471}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":553,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":554,"Flags":10,"Description":"The resource api version"},"properties":{"Type":556,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":571,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":572,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":578,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":579,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":584,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":604,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":607,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[557,558,559,560,561,562,563,564,565,566,567,568,569,570]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":577,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[573,574,575,576]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":583,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[580,581,582]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":599,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":602,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":603,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[585,586,587,588,589,590,591,592,593,594,595,596,597,598]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[600,601]}},{"3":{"ItemType":584}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":605,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":606,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2021-03-01-preview","ScopeType":16,"Body":555}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":12,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":33,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":38,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":43,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":44,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":49,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":54,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":58,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":59,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":13,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":28,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,4]}},{"3":{"ItemType":27}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[29,30,31,32,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[34,35,36,37,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":42,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[40,41,4]}},{"3":{"ItemType":39}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":48,"Flags":2,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[45,46,47,4]}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[50,51,52,53,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[55,56,57,4]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":65,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":70,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[61,62,63,64,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[66,67,68,69,4]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-03-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":76,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-03-01-preview","ScopeType":16,"Body":74}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":78,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":79,"Flags":10,"Description":"The resource api version"},"properties":{"Type":81,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-03-01-preview","ScopeType":16,"Body":80}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":83,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":84,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":86,"EntityAnalytics":89,"EyesOn":92,"Ueba":95}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":87,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":88,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":90,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":91,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":93,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":94,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":96,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":103,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":102,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[97,98,99,100,4]}},{"3":{"ItemType":101}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2021-03-01-preview","ScopeType":16,"Body":85}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":105,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":106,"Flags":10,"Description":"The resource api version"},"properties":{"Type":108,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2021-03-01-preview","ScopeType":16,"Body":107}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":110,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":111,"Flags":10,"Description":"The resource api version"},"properties":{"Type":113,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":116,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":120,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":121,"Flags":1,"Description":"metadata of a repository."}}}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[114,115,4]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[117,118,4]}},{"3":{"ItemType":119}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":126,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":125,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[123,124,4]}},{"3":{"ItemType":122}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2021-03-01-preview","ScopeType":16,"Body":112}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":128,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":129,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"AmazonWebServicesCloudTrail":131,"AzureActiveDirectory":139,"AzureAdvancedThreatProtection":147,"AzureSecurityCenter":150,"Dynamics365":153,"GenericUI":161,"MicrosoftCloudAppSecurity":203,"MicrosoftDefenderAdvancedThreatProtection":207,"MicrosoftThreatIntelligence":210,"MicrosoftThreatProtection":222,"Office365":230,"OfficeATP":246,"ThreatIntelligence":249,"ThreatIntelligenceTaxii":257}}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":132,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":138,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":133,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":134,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":137,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[135,136,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":140,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":146,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":142,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":145,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[143,144,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":148,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":149,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":151,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":152,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":154,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":160,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":155,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":156,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":159,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[157,158,4]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":162,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":202,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":163,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":165,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":167,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":169,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":174,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":175,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":177,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":201,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":164}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":166}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":168}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":172,"Flags":0,"Description":"type of connectivity"},"value":{"Type":173,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"5":{"Elements":[171,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":170}},{"2":{"Name":"Availability","Properties":{"status":{"Type":176,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":191,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":193,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":185,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":189,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":190,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[179,180,181,182,183,184,4]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[186,187,188,4]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":178}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":192}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":200,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":199,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[196,197,198,4]}},{"3":{"ItemType":195}},{"3":{"ItemType":194}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":204,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":206,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":205,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":142,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":142,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":208,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":209,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":211,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":221,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":212,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":213,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":217,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":216,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[214,215,4]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":220,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[218,219,4]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":223,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":229,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":224,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":225,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":228,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[226,227,4]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":231,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":245,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":232,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":233,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":237,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":241,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":236,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[234,235,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":240,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[238,239,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":244,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[242,243,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":247,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":248,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":141,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":250,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":256,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":251,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":252,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":255,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[253,254,4]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":258,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":268,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":262,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":263,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[259,260,261,4]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":264,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":267,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[265,266,4]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2021-03-01-preview","ScopeType":16,"Body":130}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":270,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":271,"Flags":10,"Description":"The resource api version"},"properties":{"Type":273,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":276,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":277,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":277,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":278,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[274,275,4]}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-03-01-preview","ScopeType":16,"Body":272}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":280,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":281,"Flags":10,"Description":"The resource api version"},"properties":{"Type":283,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":277,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":277,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-03-01-preview","ScopeType":16,"Body":282}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":285,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":286,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":288,"MLBehaviorAnalytics":311,"MicrosoftSecurityIncidentCreation":334,"Scheduled":353,"ThreatIntelligence":441}}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":289,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":310,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":294,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":309,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[290,291,292,293,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[295,296,297,298,299,300,301,302,303,304,305,306,307,4]}},{"3":{"ItemType":308}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":312,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":333,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":317,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":332,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[313,314,315,316,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[318,319,320,321,322,323,324,325,326,327,328,329,330,4]}},{"3":{"ItemType":331}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":335,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":352,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":336,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":337,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":345,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":351,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[338,339,340,341,342,343,344,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[346,347,348,349,4]}},{"3":{"ItemType":350}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":354,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":440,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":369,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":370,"Flags":0,"Description":"Incident Configuration property bag."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":405,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":410,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":411,"Flags":0,"Description":"Event grouping settings property bag."},"customDetails":{"Type":415,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":438,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":439,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[355,356,357,358,359,360,361,362,363,364,365,366,367,4]}},{"3":{"ItemType":368}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":371,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":375,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":395,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":399,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":400,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[372,373,374,4]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392,393,4]}},{"3":{"ItemType":394}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[396,397,4]}},{"3":{"ItemType":398}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[401,402,403,404,4]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[406,407,408,409]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":414,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[412,413,4]}},{"2":{"Name":"ScheduledAlertRuleCommonPropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":435,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":437,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[417,418,419,420,421,422,423,424,425,426,427,428,429,430,431,432,433,434,4]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":436}},{"3":{"ItemType":416}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":442,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":463,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":447,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":462,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[443,444,445,446,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[448,449,450,451,452,453,454,455,456,457,458,459,460,4]}},{"3":{"ItemType":461}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2021-03-01-preview","ScopeType":16,"Body":287}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":465,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":466,"Flags":10,"Description":"The resource api version"},"properties":{"Type":468,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2021-03-01-preview","ScopeType":16,"Body":467}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2021-03-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":470,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":471,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":473,"Expansion":503}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":474,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":502,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":475,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":497,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":499,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":501,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[476,477,478,479,480,481,482,483,484,485,486,487,488,489,490,491,492,493,494,495,496,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":498}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":500}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":504,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":552,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":505,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":527,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":528,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":551,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[506,507,508,509,510,511,512,513,514,515,516,517,518,519,520,521,522,523,524,525,526,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[529,530,531,532,533,534,535,536,537,538,539,540,541,542,543,544,545,546,547,548,549,4]}},{"3":{"ItemType":550}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2021-03-01-preview","ScopeType":16,"Body":472}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2021-03-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":554,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":555,"Flags":10,"Description":"The resource api version"},"properties":{"Type":557,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":60,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":572,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":573,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":579,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":580,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":585,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":605,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":608,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[558,559,560,561,562,563,564,565,566,567,568,569,570,571,4]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":578,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[574,575,576,577,4]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":584,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[581,582,583,4]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":600,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":603,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":604,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[586,587,588,589,590,591,592,593,594,595,596,597,598,599,4]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[601,602,4]}},{"3":{"ItemType":585}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":606,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":607,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2021-03-01-preview","ScopeType":16,"Body":556}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md b/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md index f0e0de08fa..049962a97a 100644 --- a/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md +++ b/generated/securityinsights/microsoft.securityinsights/2021-03-01-preview/types.md @@ -272,68 +272,44 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type -## SystemData +## AADDataConnectorProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## FusionAlertRuleProperties +## AatpDataConnectorProperties ### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## MicrosoftSecurityIncidentCreationAlertRuleProperties +## ActionRequestProperties ### Properties -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated -* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' (Required): The alerts' productName on which the cases will be generated -* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium'[]: the alerts' severities on which the cases will be generated +* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. +* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. +* **workflowId**: string (ReadOnly): The name of the logic app's workflow. -## MLBehaviorAnalyticsAlertRuleProperties +## ActivityEntityQueriesProperties ### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule +* **content**: string: The entity query content to display in timeline +* **createdTimeUtc**: string (ReadOnly): The time the activity was created +* **description**: string: The entity query description +* **enabled**: bool: Determines whether this activity is enabled or disabled. +* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The type of the entity +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated +* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions +* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query +* **templateName**: string: The template id this activity was created from +* **title**: string: The entity query title -## ScheduledAlertRuleProperties +## ActivityEntityQueriesPropertiesEntitiesFilter ### Properties -* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **customDetails**: [ScheduledAlertRuleCommonPropertiesCustomDetails](#scheduledalertrulecommonpropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule -* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. -* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. -* **query**: string: The query that creates alerts for this rule. -* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. -* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the alert -* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. -* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[]: The tactics of the alert rule -* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. -* **triggerThreshold**: int: The threshold triggers this alert rule. +### Additional Properties +* **Additional Properties Type**: string[] + +## ActivityEntityQueriesPropertiesQueryDefinitions +### Properties +* **query**: string: The Activity query to run on a given entity ## AlertDetailsOverride ### Properties @@ -342,60 +318,23 @@ * **alertSeverityColumnName**: string: the column name to take the alert severity from * **alertTacticsColumnName**: string: the column name to take the alert tactics from -## ScheduledAlertRuleCommonPropertiesCustomDetails -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EntityMapping -### Properties -* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL': The V3 type of the mapped entity -* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping - -## FieldMapping -### Properties -* **columnName**: string: the column name to be mapped to the identifier -* **identifier**: string: the V3 identifier of the entity - -## EventGroupingSettings -### Properties -* **aggregationKind**: 'AlertPerResult' | 'SingleAlert': The event grouping aggregation kinds - -## IncidentConfiguration -### Properties -* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule -* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. - -## GroupingConfiguration +## AlertsDataTypeOfDataConnector ### Properties -* **enabled**: bool (Required): Grouping enabled -* **groupByAlertDetails**: 'DisplayName' | 'Severity'[]: A list of alert details to group by (when matchingMethod is Selected) -* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. -* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL'[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. -* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) -* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. -* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. -## ThreatIntelligenceAlertRuleProperties +## AnomaliesSettingsProperties ### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. -## ActionRequestProperties +## ASCDataConnectorProperties ### Properties -* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. -* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. -* **workflowId**: string (ReadOnly): The name of the logic app's workflow. +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. -## AwsCloudTrailDataConnectorProperties +## Availability ### Properties -* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. -* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. +* **isPreview**: bool: Set connector as preview +* **status**: '1': The connector Availability Status ## AwsCloudTrailDataConnectorDataTypes ### Properties @@ -403,43 +342,19 @@ ## AwsCloudTrailDataConnectorDataTypesLogs ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## AADDataConnectorProperties -### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. - -## AlertsDataTypeOfDataConnector -### Properties -* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. - -## DataConnectorDataTypeCommon -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## AatpDataConnectorProperties -### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. - -## ASCDataConnectorProperties -### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **subscriptionId**: string: The subscription id to connect to, and get the data from. - -## Dynamics365DataConnectorProperties -### Properties -* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## Dynamics365DataConnectorDataTypes +## AwsCloudTrailDataConnectorProperties ### Properties -* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. -## Dynamics365DataConnectorDataTypesDynamics365CdsActivities +## ClientInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. ## CodelessParameters ### Properties @@ -460,14 +375,9 @@ * **sampleQueries**: [CodelessUiConnectorConfigPropertiesSampleQueriesItem](#codelessuiconnectorconfigpropertiessamplequeriesitem)[] (Required): The sample queries for the connector * **title**: string (Required): Connector blade title -## Availability -### Properties -* **isPreview**: bool: Set connector as preview -* **status**: '1': The connector Availability Status - ## CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem ### Properties -* **type**: 'IsConnectedQuery': type of connectivity +* **type**: 'IsConnectedQuery' | string: type of connectivity * **value**: string[]: Queries for checking connectivity ## CodelessUiConnectorConfigPropertiesDataTypesItem @@ -487,190 +397,123 @@ * **instructions**: [InstructionStepsInstructionsItem](#instructionstepsinstructionsitem)[]: Instruction step details * **title**: string: Instruction step title -## InstructionStepsInstructionsItem -### Properties -* **parameters**: any: Any object -* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' (Required): The kind of the setting - -## Permissions +## CodelessUiConnectorConfigPropertiesSampleQueriesItem ### Properties -* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector -* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector +* **description**: string: The sample query description +* **query**: string: the sample query -## PermissionsCustomsItem +## ContentPathMap ### Properties -* **description**: string: Customs permissions description -* **name**: string: Customs permissions name +* **contentType**: 'AnalyticRule' | 'Workbook' | string: The content type of a source control path. +* **path**: string: The path to the content. -## PermissionsResourceProviderItem +## DataConnectorDataTypeCommon ### Properties -* **permissionsDisplayText**: string: Permission description text -* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings': Provider name -* **providerDisplayName**: string: Permission provider display name -* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector -* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace': Permission provider scope +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## RequiredPermissions +## Dynamics365DataConnectorDataTypes ### Properties -* **action**: bool: action permission -* **delete**: bool: delete permission -* **read**: bool: read permission -* **write**: bool: write permission +* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. -## CodelessUiConnectorConfigPropertiesSampleQueriesItem +## Dynamics365DataConnectorDataTypesDynamics365CdsActivities ### Properties -* **description**: string: The sample query description -* **query**: string: the sample query +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## McasDataConnectorProperties +## Dynamics365DataConnectorProperties ### Properties -* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. +* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. * **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## McasDataConnectorDataTypes +## EntityAnalyticsProperties ### Properties -* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. -* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. -## MdatpDataConnectorProperties +## EntityMapping ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The V3 type of the mapped entity +* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping -## MstiDataConnectorProperties +## EventGroupingSettings ### Properties -* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **aggregationKind**: 'AlertPerResult' | 'SingleAlert' | string: The event grouping aggregation kinds -## MstiDataConnectorDataTypes +## ExpansionEntityQueriesProperties ### Properties -* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. -* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. +* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query +* **displayName**: string (ReadOnly): The query display name +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string (ReadOnly): The type of the entity +* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query +* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[] (ReadOnly): List of the desired output types to be constructed from the result +* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted -## MstiDataConnectorDataTypesBingSafetyPhishingURL +## EyesOnSettingsProperties ### Properties -* **lookbackPeriod**: string (Required): lookback period -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. -## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed +## FieldMapping ### Properties -* **lookbackPeriod**: string (Required): lookback period -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **columnName**: string: the column name to be mapped to the identifier +* **identifier**: string: the V3 identifier of the entity -## MTPDataConnectorProperties +## FusionAlertRuleProperties ### Properties -* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule -## MTPDataConnectorDataTypes +## GroupingConfiguration ### Properties -* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. +* **enabled**: bool (Required): Grouping enabled +* **groupByAlertDetails**: 'DisplayName' | 'Severity' | string[]: A list of alert details to group by (when matchingMethod is Selected) +* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. +* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. +* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) +* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' | string (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. +* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents -## MTPDataConnectorDataTypesIncidents +## IncidentAdditionalData ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with incident -## OfficeDataConnectorProperties +## IncidentCommentProperties ### Properties -* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. - -## OfficeDataConnectorDataTypes -### Properties -* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. -* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. -* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. - -## OfficeDataConnectorDataTypesExchange -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## OfficeDataConnectorDataTypesSharePoint -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## OfficeDataConnectorDataTypesTeams -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## OfficeATPDataConnectorProperties -### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. - -## TIDataConnectorProperties -### Properties -* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. - -## TIDataConnectorDataTypes -### Properties -* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. - -## TIDataConnectorDataTypesIndicators -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## TiTaxiiDataConnectorProperties -### Properties -* **collectionId**: string: The collection id of the TAXII server. -* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. -* **friendlyName**: string: The friendly name for the TAXII server. -* **password**: string: The password for the TAXII server. -* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' (Required): The polling frequency for the TAXII server. -* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. -* **taxiiServer**: string: The API root for the TAXII server. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -* **userName**: string: The userName for the TAXII server. -* **workspaceId**: string: The workspace id. - -## TiTaxiiDataConnectorDataTypes -### Properties -* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. - -## TiTaxiiDataConnectorDataTypesTaxiiClient -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## ActivityEntityQueriesProperties -### Properties -* **content**: string: The entity query content to display in timeline -* **createdTimeUtc**: string (ReadOnly): The time the activity was created -* **description**: string: The entity query description -* **enabled**: bool: Determines whether this activity is enabled or disabled. -* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters -* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL': The type of the entity -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated -* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions -* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query -* **templateName**: string: The template id this activity was created from -* **title**: string: The entity query title +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message -## ActivityEntityQueriesPropertiesEntitiesFilter +## IncidentConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule +* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. -## ActivityEntityQueriesPropertiesQueryDefinitions +## IncidentLabel ### Properties -* **query**: string: The Activity query to run on a given entity +* **labelName**: string (Required): The name of the label +* **labelType**: 'System' | 'User' | string (ReadOnly): The type of the label -## ExpansionEntityQueriesProperties +## IncidentOwnerInfo ### Properties -* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query -* **displayName**: string (ReadOnly): The query display name -* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' (ReadOnly): The type of the entity -* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query -* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL'[] (ReadOnly): List of the desired output types to be constructed from the result -* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **ownerType**: 'Group' | 'Unknown' | 'User' | string (ReadOnly): The type of the owner the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. ## IncidentProperties ### Properties * **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed * **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with * **createdTimeUtc**: string (ReadOnly): The time the incident was created * **description**: string: The description of the incident * **firstActivityTimeUtc**: string: The time of the first activity in the incident @@ -683,60 +526,50 @@ * **providerIncidentId**: string: The incident ID assigned by the incident provider * **providerName**: string: The name of the source provider that generated the incident * **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (Required): The severity of the incident -* **status**: 'Active' | 'Closed' | 'New' (Required): The status of the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident * **teamInformation**: [TeamInformation](#teaminformation): Describes team information * **title**: string (Required): The title of the incident -## IncidentAdditionalData +## InstructionStepsInstructionsItem ### Properties -* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident -* **alertsCount**: int (ReadOnly): The number of alerts in the incident -* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident -* **commentsCount**: int (ReadOnly): The number of comments in the incident -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics associated with incident +* **parameters**: any: Any object +* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' | string (Required): The kind of the setting -## IncidentLabel +## McasDataConnectorDataTypes ### Properties -* **labelName**: string (Required): The name of the label -* **labelType**: 'System' | 'User' (ReadOnly): The type of the label +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. +* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. -## IncidentOwnerInfo +## McasDataConnectorProperties ### Properties -* **assignedTo**: string: The name of the user the incident is assigned to. -* **email**: string: The email of the user the incident is assigned to. -* **objectId**: string: The object id of the user the incident is assigned to. -* **ownerType**: 'Group' | 'Unknown' | 'User' (ReadOnly): The type of the owner the incident is assigned to. -* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. +* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## TeamInformation +## MdatpDataConnectorProperties ### Properties -* **description**: string (ReadOnly): The description of the team -* **name**: string (ReadOnly): The name of the team -* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team -* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created -* **teamId**: string (ReadOnly): Team ID +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## IncidentCommentProperties +## MetadataAuthor ### Properties -* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the comment was created -* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated -* **message**: string (Required): The comment message +* **email**: string: Email of author contact +* **link**: string: Link for author/vendor page +* **name**: string: Name of the author. Company or person. -## ClientInfo +## MetadataCategories ### Properties -* **email**: string: The email of the client. -* **name**: string: The name of the client. -* **objectId**: string: The object id of the client. -* **userPrincipalName**: string: The user principal name of the client. +* **domains**: string[]: domain for the solution content item +* **verticals**: string[]: Industry verticals for the solution content item -## RelationProperties +## MetadataDependencies ### Properties -* **relatedResourceId**: string (Required): The resource ID of the related resource -* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource -* **relatedResourceName**: string (ReadOnly): The name of the related resource -* **relatedResourceType**: string (ReadOnly): The resource type of the related resource +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string: The kind of content the metadata is for. +* **name**: string: Name of the content item +* **operator**: 'AND' | 'OR' | string: Operator used for list of dependencies in criteria array. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks ## MetadataProperties ### Properties @@ -745,7 +578,7 @@ * **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. * **dependencies**: [MetadataDependencies](#metadatadependencies): Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. * **firstPublishDate**: string: first publish date of solution content item -* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' (Required): The kind of content the metadata is for. +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string (Required): The kind of content the metadata is for. * **lastPublishDate**: string: last publish date of solution content item * **parentId**: string (Required): Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group) * **providers**: string[]: Providers for the solution content item @@ -753,29 +586,9 @@ * **support**: [MetadataSupport](#metadatasupport): Support information for the content item. * **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks -## MetadataAuthor -### Properties -* **email**: string: Email of author contact -* **link**: string: Link for author/vendor page -* **name**: string: Name of the author. Company or person. - -## MetadataCategories -### Properties -* **domains**: string[]: domain for the solution content item -* **verticals**: string[]: Industry verticals for the solution content item - -## MetadataDependencies -### Properties -* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. -* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator -* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate': The kind of content the metadata is for. -* **name**: string: Name of the content item -* **operator**: 'AND' | 'OR': Operator used for list of dependencies in criteria array. -* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks - ## MetadataSource ### Properties -* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' (Required): Source type of the content +* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' | string (Required): Source type of the content * **name**: string: Name of the content source. The repo name, solution name, LA workspace name etc. * **sourceId**: string: ID of the content source. The solution ID, workspace ID, etc @@ -784,36 +597,115 @@ * **email**: string: Email of support contact * **link**: string: Link for support help, like to support page to open a ticket etc. * **name**: string: Name of the support contact. Company or person. -* **tier**: 'Community' | 'Microsoft' | 'Partner' (Required): Type of support for content item +* **tier**: 'Community' | 'Microsoft' | 'Partner' | string (Required): Type of support for content item -## SentinelOnboardingStateProperties +## MicrosoftSecurityIncidentCreationAlertRuleProperties ### Properties -* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated -## AnomaliesSettingsProperties +## MLBehaviorAnalyticsAlertRuleProperties ### Properties -* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule -## EntityAnalyticsProperties +## MstiDataConnectorDataTypes ### Properties -* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. +* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. +* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. -## EyesOnSettingsProperties +## MstiDataConnectorDataTypesBingSafetyPhishingURL ### Properties -* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## UebaProperties +## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed ### Properties -* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs'[]: The relevant data sources that enriched by ueba +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## SourceControlProperties +## MstiDataConnectorProperties ### Properties -* **contentTypes**: 'AnalyticRule' | 'Workbook'[] (Required): Array of source control content types. -* **description**: string: A description of the source control -* **displayName**: string (Required): The display name of the source control -* **id**: string: The id (a Guid) of the source control -* **repository**: [Repository](#repository) (Required): metadata of a repository. -* **repoType**: 'DevOps' | 'Github' (Required): The type of repository. +* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MTPDataConnectorDataTypes +### Properties +* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. + +## MTPDataConnectorDataTypesIncidents +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MTPDataConnectorProperties +### Properties +* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeATPDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeDataConnectorDataTypes +### Properties +* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. +* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. +* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. + +## OfficeDataConnectorDataTypesExchange +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesSharePoint +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesTeams +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorProperties +### Properties +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## Permissions +### Properties +* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector +* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector + +## PermissionsCustomsItem +### Properties +* **description**: string: Customs permissions description +* **name**: string: Customs permissions name + +## PermissionsResourceProviderItem +### Properties +* **permissionsDisplayText**: string: Permission description text +* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings' | string: Provider name +* **providerDisplayName**: string: Permission provider display name +* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector +* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace' | string: Permission provider scope + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource ## Repository ### Properties @@ -823,10 +715,137 @@ * **pathMapping**: [ContentPathMap](#contentpathmap)[]: Dictionary of source control content type and path mapping. * **url**: string: Url of repository. -## ContentPathMap +## RequiredPermissions ### Properties -* **contentType**: 'AnalyticRule' | 'Workbook': The content type of a source control path. -* **path**: string: The path to the content. +* **action**: bool: action permission +* **delete**: bool: delete permission +* **read**: bool: read permission +* **write**: bool: write permission + +## ScheduledAlertRuleCommonPropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScheduledAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [ScheduledAlertRuleCommonPropertiesCustomDetails](#scheduledalertrulecommonpropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[]: The tactics of the alert rule +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. + +## SentinelOnboardingStateProperties +### Properties +* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting + +## SourceControlProperties +### Properties +* **contentTypes**: 'AnalyticRule' | 'Workbook' | string[] (Required): Array of source control content types. +* **description**: string: A description of the source control +* **displayName**: string (Required): The display name of the source control +* **id**: string: The id (a Guid) of the source control +* **repository**: [Repository](#repository) (Required): metadata of a repository. +* **repoType**: 'DevOps' | 'Github' | string (Required): The type of repository. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TeamInformation +### Properties +* **description**: string (ReadOnly): The description of the team +* **name**: string (ReadOnly): The name of the team +* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team +* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created +* **teamId**: string (ReadOnly): Team ID + +## ThreatIntelligenceAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule + +## TIDataConnectorDataTypes +### Properties +* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. + +## TIDataConnectorDataTypesIndicators +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TIDataConnectorProperties +### Properties +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## TiTaxiiDataConnectorDataTypes +### Properties +* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. + +## TiTaxiiDataConnectorDataTypesTaxiiClient +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TiTaxiiDataConnectorProperties +### Properties +* **collectionId**: string: The collection id of the TAXII server. +* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. +* **friendlyName**: string: The friendly name for the TAXII server. +* **password**: string: The password for the TAXII server. +* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' | string (Required): The polling frequency for the TAXII server. +* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. +* **taxiiServer**: string: The API root for the TAXII server. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **userName**: string: The userName for the TAXII server. +* **workspaceId**: string: The workspace id. + +## UebaProperties +### Properties +* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs' | string[]: The relevant data sources that enriched by ueba + +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: any: Any object +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: any (Required): Any object +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item ## WatchlistProperties ### Properties @@ -842,7 +861,7 @@ * **numberOfLinesToSkip**: int: The number of lines in a csv/tsv content to skip before the header * **provider**: string (Required): The provider of the watchlist * **rawContent**: string: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint -* **source**: 'Local file' | 'Remote storage' (Required): The source of the watchlist +* **source**: 'Local file' | 'Remote storage' | string (Required): The source of the watchlist * **tenantId**: string: The tenantId where the watchlist belongs to * **updated**: string: The last time the watchlist was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action @@ -852,22 +871,3 @@ * **watchlistItemsCount**: int: The number of Watchlist Items in the Watchlist * **watchlistType**: string: The type of the watchlist -## UserInfo -### Properties -* **email**: string (ReadOnly): The email of the user. -* **name**: string (ReadOnly): The name of the user. -* **objectId**: string: The object id of the user. - -## WatchlistItemProperties -### Properties -* **created**: string: The time the watchlist item was created -* **createdBy**: [UserInfo](#userinfo): User information that made some action -* **entityMapping**: any: Any object -* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not -* **itemsKeyValue**: any (Required): Any object -* **tenantId**: string: The tenantId to which the watchlist item belongs to -* **updated**: string: The last time the watchlist item was updated -* **updatedBy**: [UserInfo](#userinfo): User information that made some action -* **watchlistItemId**: string: The id (a Guid) of the watchlist item -* **watchlistItemType**: string: The type of the watchlist item - diff --git a/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.json b/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.json index d4a4648f80..65db60c9c3 100644 --- a/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.json +++ b/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":12,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":32,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":37,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":42,"Flags":0,"Description":"List of labels relevant to this incident"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":43,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":44,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":49,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":53,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":13,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":27,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25]}},{"3":{"ItemType":26}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[28,29,30,31]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[33,34,35,36]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":41,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[39,40]}},{"3":{"ItemType":38}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[45,46,47,48]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[50,51,52]}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":59,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":64,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[55,56,57,58]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[60,61,62,63]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-04-01","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":66,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":67,"Flags":10,"Description":"The resource api version"},"properties":{"Type":69,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":70,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-04-01","ScopeType":16,"Body":68}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-04-01","ScopeType":16,"Body":74}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":77,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":78,"Flags":10,"Description":"The resource api version"},"properties":{"Type":80,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":83,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":85,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. Example : This line will be skipped\nheader1,header2\nvalue1,value2"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. For now, only text/csv is valid"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. **Note** : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[81,82]}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-04-01","ScopeType":16,"Body":79}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":87,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":88,"Flags":10,"Description":"The resource api version"},"properties":{"Type":90,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-04-01","ScopeType":16,"Body":89}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":92,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":93,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":95,"Flags":4,"Description":"Describes threat intelligence entity properties"},"kind":{"Type":115,"Flags":1,"Description":"The kind of the threat intelligence entity"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":96,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":97,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":99,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":103,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":106,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":109,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":110,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":111,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":112,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":113,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":114,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":98}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":102,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":105,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":104}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":108,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":107}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"6":{"Value":"indicator"}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-04-01","ScopeType":16,"Body":94}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":12,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":32,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":37,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":42,"Flags":0,"Description":"List of labels relevant to this incident"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":43,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":44,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":49,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":53,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":13,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":27,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,4]}},{"3":{"ItemType":26}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[28,29,30,31,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[33,34,35,36,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":41,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[39,40,4]}},{"3":{"ItemType":38}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[45,46,47,48,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[50,51,52,4]}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":59,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":64,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[55,56,57,58,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[60,61,62,63,4]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-04-01","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":66,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":67,"Flags":10,"Description":"The resource api version"},"properties":{"Type":69,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":70,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-04-01","ScopeType":16,"Body":68}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-04-01","ScopeType":16,"Body":74}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":77,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":78,"Flags":10,"Description":"The resource api version"},"properties":{"Type":80,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":83,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":85,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. Example : This line will be skipped\nheader1,header2\nvalue1,value2"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. For now, only text/csv is valid"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. **Note** : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[81,82,4]}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-04-01","ScopeType":16,"Body":79}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":87,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":88,"Flags":10,"Description":"The resource api version"},"properties":{"Type":90,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":84,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-04-01","ScopeType":16,"Body":89}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2021-04-01"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":92,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":93,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":95,"Flags":4,"Description":"Describes threat intelligence entity properties"},"kind":{"Type":116,"Flags":1,"Description":"The kind of the threat intelligence entity"},"systemData":{"Type":54,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":96,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":97,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":99,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":103,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":106,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":109,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":110,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":111,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":112,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":113,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":114,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":98}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":102,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":105,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":104}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":108,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":107}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"6":{"Value":"indicator"}},{"5":{"Elements":[115,4]}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-04-01","ScopeType":16,"Body":94}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.md b/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.md index 3ffa25d86f..f6a6b6f456 100644 --- a/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.md +++ b/generated/securityinsights/microsoft.securityinsights/2021-04-01/types.md @@ -39,7 +39,7 @@ * **apiVersion**: '2021-04-01' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: Etag of the azure resource * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'indicator' (Required): The kind of the threat intelligence entity +* **kind**: 'indicator' | string (Required): The kind of the threat intelligence entity * **name**: string (Required, DeployTimeConstant): The resource name * **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. @@ -67,25 +67,17 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type -## IncidentProperties +## ClientInfo ### Properties -* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed -* **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with -* **createdTimeUtc**: string (ReadOnly): The time the incident was created -* **description**: string: The description of the incident -* **firstActivityTimeUtc**: string: The time of the first activity in the incident -* **incidentNumber**: int (ReadOnly): A sequential number -* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal -* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident -* **lastActivityTimeUtc**: string: The time of the last activity in the incident -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated -* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to -* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (Required): The severity of the incident -* **status**: 'Active' | 'Closed' | 'New' (Required): The status of the incident -* **title**: string (Required): The title of the incident +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. + +## EntityCommonPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: any ## IncidentAdditionalData ### Properties @@ -93,12 +85,19 @@ * **alertsCount**: int (ReadOnly): The number of alerts in the incident * **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident * **commentsCount**: int (ReadOnly): The number of comments in the incident -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation'[] (ReadOnly): The tactics associated with incident +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with incident + +## IncidentCommentProperties +### Properties +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message ## IncidentLabel ### Properties * **labelName**: string (Required): The name of the label -* **labelType**: 'System' | 'User' (ReadOnly): The type of the label +* **labelType**: 'System' | 'User' | string (ReadOnly): The type of the label ## IncidentOwnerInfo ### Properties @@ -107,35 +106,60 @@ * **objectId**: string: The object id of the user the incident is assigned to. * **userPrincipalName**: string: The user principal name of the user the incident is assigned to. +## IncidentProperties +### Properties +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **title**: string (Required): The title of the incident + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource + ## SystemData ### Properties * **createdAt**: string: The timestamp of resource creation (UTC). * **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. * **lastModifiedAt**: string: The timestamp of resource last modification (UTC) * **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## IncidentCommentProperties +## ThreatIntelligenceExternalReference ### Properties -* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the comment was created -* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated -* **message**: string (Required): The comment message +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL -## ClientInfo +## ThreatIntelligenceExternalReferenceHashes ### Properties -* **email**: string: The email of the client. -* **name**: string: The name of the client. -* **objectId**: string: The object id of the client. -* **userPrincipalName**: string: The user principal name of the client. +### Additional Properties +* **Additional Properties Type**: string -## RelationProperties +## ThreatIntelligenceGranularMarkingModel ### Properties -* **relatedResourceId**: string (Required): The resource ID of the related resource -* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource -* **relatedResourceName**: string (ReadOnly): The name of the related resource -* **relatedResourceType**: string (ReadOnly): The resource type of the related resource +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors ## ThreatIntelligenceIndicatorProperties ### Properties @@ -170,35 +194,11 @@ * **validFrom**: string (WriteOnly): Valid from * **validUntil**: string (WriteOnly): Valid until -## EntityCommonPropertiesAdditionalData -### Properties -### Additional Properties -* **Additional Properties Type**: any - ## ThreatIntelligenceIndicatorPropertiesExtensions ### Properties ### Additional Properties * **Additional Properties Type**: any -## ThreatIntelligenceExternalReference -### Properties -* **description**: string (WriteOnly): External reference description -* **externalId**: string (WriteOnly): External reference ID -* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes -* **sourceName**: string (WriteOnly): External reference source name -* **url**: string (WriteOnly): External reference URL - -## ThreatIntelligenceExternalReferenceHashes -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ThreatIntelligenceGranularMarkingModel -### Properties -* **language**: string (WriteOnly): Language granular marking model -* **markingRef**: int (WriteOnly): marking reference granular marking model -* **selectors**: string[] (WriteOnly): granular marking model selectors - ## ThreatIntelligenceKillChainPhase ### Properties * **killChainName**: string (WriteOnly): Kill chainName name @@ -214,6 +214,25 @@ * **value**: string (WriteOnly): Value of parsed pattern * **valueType**: string (WriteOnly): Type of the value +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: any: Any object +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: any (Required): Any object +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + ## WatchlistProperties ### Properties * **contentType**: string: The content type of the raw content. For now, only text/csv is valid @@ -230,7 +249,7 @@ * **rawContent**: string: The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2 -* **source**: 'Local file' | 'Remote storage' (Required): The source of the watchlist +* **source**: 'Local file' | 'Remote storage' | string (Required): The source of the watchlist * **tenantId**: string: The tenantId where the watchlist belongs to * **updated**: string: The last time the watchlist was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action @@ -239,22 +258,3 @@ value1,value2 * **watchlistId**: string: The id (a Guid) of the watchlist * **watchlistType**: string: The type of the watchlist -## UserInfo -### Properties -* **email**: string (ReadOnly): The email of the user. -* **name**: string (ReadOnly): The name of the user. -* **objectId**: string: The object id of the user. - -## WatchlistItemProperties -### Properties -* **created**: string: The time the watchlist item was created -* **createdBy**: [UserInfo](#userinfo): User information that made some action -* **entityMapping**: any: Any object -* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not -* **itemsKeyValue**: any (Required): Any object -* **tenantId**: string: The tenantId to which the watchlist item belongs to -* **updated**: string: The last time the watchlist item was updated -* **updatedBy**: [UserInfo](#userinfo): User information that made some action -* **watchlistItemId**: string: The id (a Guid) of the watchlist item -* **watchlistItemType**: string: The type of the watchlist item - diff --git a/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json b/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json index 320ba2bf4a..cbaf930838 100644 --- a/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json +++ b/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":22,"MLBehaviorAnalytics":45,"MicrosoftSecurityIncidentCreation":68,"NRT":87,"Scheduled":166,"ThreatIntelligence":200}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":16,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":21,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[12,13,14,15]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[17,18,19,20]}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":23,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":44,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":28,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":43,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[24,25,26,27]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[29,30,31,32,33,34,35,36,37,38,39,40,41]}},{"3":{"ItemType":42}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":46,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":67,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":51,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":66,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[47,48,49,50]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[52,53,54,55,56,57,58,59,60,61,62,63,64]}},{"3":{"ItemType":65}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":69,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":86,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":70,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":71,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":79,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":85,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[72,73,74,75,76,77,78]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[80,81,82,83]}},{"3":{"ItemType":84}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"NrtAlertRule","Properties":{"properties":{"Type":88,"Flags":0,"Description":"Nrt alert rule base property bag."},"kind":{"Type":165,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"NrtAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":93,"Flags":0,"Description":"The severity of the alert"},"tactics":{"Type":108,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":109,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":140,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":163,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":164,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[89,90,91,92]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[94,95,96,97,98,99,100,101,102,103,104,105,106]}},{"3":{"ItemType":107}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":110,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":114,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":134,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":138,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":139,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[111,112,113]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132]}},{"3":{"ItemType":133}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[135,136]}},{"3":{"ItemType":137}},{"3":{"ItemType":4}},{"2":{"Name":"QueryBasedAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":160,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":162,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":161}},{"3":{"ItemType":141}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"NRT"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":167,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":199,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"triggerOperator":{"Type":172,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":173,"Flags":0,"Description":"Event grouping settings property bag."},"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":181,"Flags":0,"Description":"The severity of the alert"},"tactics":{"Type":196,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":109,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":197,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":198,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":164,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[168,169,170,171]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":176,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[174,175]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[177,178,179,180]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[182,183,184,185,186,187,188,189,190,191,192,193,194]}},{"3":{"ItemType":195}},{"2":{"Name":"QueryBasedAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":141}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":201,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":222,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":206,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":221,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[202,203,204,205]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[207,208,209,210,211,212,213,214,215,216,217,218,219]}},{"3":{"ItemType":220}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2021-09-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":224,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":225,"Flags":10,"Description":"The resource api version"},"properties":{"Type":227,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2021-09-01-preview","ScopeType":16,"Body":226}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":229,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":230,"Flags":10,"Description":"The resource api version"},"properties":{"Type":232,"Flags":0,"Description":"Describes automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":233,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":340,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdBy":{"Type":341,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"lastModifiedBy":{"Type":341,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled."},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":234,"Flags":1,"Description":"The type of object the automation rule triggers on"},"triggersWhen":{"Type":235,"Flags":1,"Description":"The type of event the automation rule triggers on"},"conditions":{"Type":303,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"6":{"Value":"Created"}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":237}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"conditionProperties":{"Type":238,"Flags":1,"Description":"The configuration of the automation rule condition"},"conditionType":{"Type":302,"Flags":1,"Description":"The type of the automation rule condition"}}}},{"2":{"Name":"AutomationRulePropertyValuesConditionProperties","Properties":{"propertyName":{"Type":291,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":300,"Flags":0,"Description":"The operator to use for evaluation the condition"},"propertyValues":{"Type":301,"Flags":0,"Description":"The values to use for evaluating the condition"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[239,240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,286,287,288,289,290]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[292,293,294,295,296,297,298,299]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":236}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule action"}},"Elements":{"ModifyProperties":305,"RunPlaybook":337}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":306,"Flags":1,"Description":"The configuration of the modify properties automation rule action"},"actionType":{"Type":336,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleModifyPropertiesActionConfiguration","Properties":{"classification":{"Type":311,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":316,"Flags":0,"Description":"The classification reason the incident was closed with"},"labels":{"Type":321,"Flags":0,"Description":"List of labels to add to the incident"},"owner":{"Type":322,"Flags":0,"Description":"Information on the user an incident is assigned to"},"severity":{"Type":331,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":335,"Flags":0,"Description":"The status of the incident"}}}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[307,308,309,310]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[312,313,314,315]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":320,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[318,319]}},{"3":{"ItemType":317}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":326,"Flags":2,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[323,324,325]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[327,328,329,330]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[332,333,334]}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":338,"Flags":1,"Description":"The configuration of the run playbook automation rule action"},"actionType":{"Type":339,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleRunPlaybookActionConfiguration","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":304}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2021-09-01-preview","ScopeType":16,"Body":231}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":343,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":344,"Flags":10,"Description":"The resource api version"},"properties":{"Type":346,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":347,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":348,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":347,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":349,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":354,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[350,351,352,353]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2021-09-01-preview","ScopeType":16,"Body":345}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":356,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":357,"Flags":10,"Description":"The resource api version"},"properties":{"Type":359,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2021-09-01-preview","ScopeType":16,"Body":358}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":361,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":362,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":364,"Expansion":394}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":365,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":393,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":366,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":388,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":390,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":392,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[367,368,369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387]}},{"3":{"ItemType":4}},{"3":{"ItemType":389}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":391}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":395,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":443,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":396,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":418,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":419,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":442,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[397,398,399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[420,421,422,423,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,439,440]}},{"3":{"ItemType":441}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2021-09-01-preview","ScopeType":16,"Body":363}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":445,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":446,"Flags":10,"Description":"The resource api version"},"properties":{"Type":448,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":449,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":470,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":475,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":476,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":322,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":477,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":482,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":486,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":487,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":450,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":465,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[451,452,453,454,455,456,457,458,459,460,461,462,463]}},{"3":{"ItemType":464}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[466,467,468,469]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[471,472,473,474]}},{"3":{"ItemType":317}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[478,479,480,481]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[483,484,485]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-09-01-preview","ScopeType":16,"Body":447}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":489,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":490,"Flags":10,"Description":"The resource api version"},"properties":{"Type":492,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":341,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-09-01-preview","ScopeType":16,"Body":491}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":494,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":495,"Flags":10,"Description":"The resource api version"},"properties":{"Type":359,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-09-01-preview","ScopeType":16,"Body":496}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":498,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":499,"Flags":10,"Description":"The resource api version"},"properties":{"Type":501,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":516,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":517,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":523,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":524,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":529,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":549,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":552,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[502,503,504,505,506,507,508,509,510,511,512,513,514,515]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":522,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[518,519,520,521]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":528,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[525,526,527]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":544,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":547,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":548,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[530,531,532,533,534,535,536,537,538,539,540,541,542,543]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[545,546]}},{"3":{"ItemType":529}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":550,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":551,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2021-09-01-preview","ScopeType":16,"Body":500}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":554,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":555,"Flags":10,"Description":"The resource api version"},"properties":{"Type":557,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2021-09-01-preview","ScopeType":16,"Body":556}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":559,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":560,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":562,"EntityAnalytics":565,"EyesOn":568,"Ueba":571}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":563,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":564,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":566,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":567,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":569,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":570,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":572,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":579,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":578,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[573,574,575,576]}},{"3":{"ItemType":577}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2021-09-01-preview","ScopeType":16,"Body":561}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":581,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":582,"Flags":10,"Description":"The resource api version"},"properties":{"Type":584,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":587,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":591,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":592,"Flags":1,"Description":"metadata of a repository."}}}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[585,586]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[588,589]}},{"3":{"ItemType":590}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":597,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":596,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[594,595]}},{"3":{"ItemType":593}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2021-09-01-preview","ScopeType":16,"Body":583}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":599,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":600,"Flags":10,"Description":"The resource api version"},"properties":{"Type":602,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":605,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":347,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":347,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":606,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[603,604]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-09-01-preview","ScopeType":16,"Body":601}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":608,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":609,"Flags":10,"Description":"The resource api version"},"properties":{"Type":611,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":347,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":347,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-09-01-preview","ScopeType":16,"Body":610}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":613,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":614,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"APIPolling":616,"AmazonWebServicesCloudTrail":663,"AmazonWebServicesS3":671,"AzureActiveDirectory":680,"AzureAdvancedThreatProtection":688,"AzureSecurityCenter":691,"Dynamics365":694,"GenericUI":702,"MicrosoftCloudAppSecurity":705,"MicrosoftDefenderAdvancedThreatProtection":709,"MicrosoftThreatIntelligence":712,"MicrosoftThreatProtection":724,"Office365":732,"OfficeATP":748,"OfficeIRM":751,"ThreatIntelligence":754,"ThreatIntelligenceTaxii":762}}},{"2":{"Name":"CodelessApiPollingDataConnector","Properties":{"properties":{"Type":617,"Flags":0,"Description":"Represents Codeless API Polling data connector"},"kind":{"Type":662,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ApiPollingParameters","Properties":{"connectorUiConfig":{"Type":618,"Flags":0,"Description":"Config to describe the instructions blade"},"pollingConfig":{"Type":656,"Flags":0,"Description":"Config to describe the polling config for API poller connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":620,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":622,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":624,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":628,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":629,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":631,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":655,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":619}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":621}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":623}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":626,"Flags":0,"Description":"type of connectivity"},"value":{"Type":627,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"3":{"ItemType":4}},{"3":{"ItemType":625}},{"2":{"Name":"Availability","Properties":{"status":{"Type":630,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":645,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":647,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":639,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":643,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":644,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[633,634,635,636,637,638]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[640,641,642]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":632}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":646}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":654,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":653,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[650,651,652]}},{"3":{"ItemType":649}},{"3":{"ItemType":648}},{"2":{"Name":"CodelessConnectorPollingConfigProperties","Properties":{"isActive":{"Type":2,"Flags":0,"Description":"The poller active status"},"auth":{"Type":657,"Flags":1,"Description":"Describe the authentication properties needed to successfully authenticate with the server"},"request":{"Type":658,"Flags":1,"Description":"Describe the request properties needed to successfully pull from the server"},"paging":{"Type":659,"Flags":0,"Description":"Describe the properties needed to make a pagination call"},"response":{"Type":660,"Flags":0,"Description":"Describes the response from the external server"}}}},{"2":{"Name":"CodelessConnectorPollingAuthProperties","Properties":{"authType":{"Type":4,"Flags":1,"Description":"The authentication type"},"apiKeyName":{"Type":4,"Flags":0,"Description":"The header name which the token is sent with"},"apiKeyIdentifier":{"Type":4,"Flags":0,"Description":"A prefix send in the header before the actual token"},"isApiKeyInPostPayload":{"Type":4,"Flags":0,"Description":"Marks if the key should sent in header"},"flowName":{"Type":4,"Flags":0,"Description":"Describes the flow name, for example 'AuthCode' for Oauth 2.0"},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to issue a token, used in Oauth 2.0 flow"},"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to authorize the user, used in Oauth 2.0 flow"},"authorizationEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"redirectionEndpoint":{"Type":4,"Flags":0,"Description":"The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow"},"tokenEndpointHeaders":{"Type":0,"Flags":0,"Description":"Any object"},"tokenEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"isClientSecretInHeader":{"Type":2,"Flags":0,"Description":"Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow"},"scope":{"Type":4,"Flags":0,"Description":"The OAuth token scope"}}}},{"2":{"Name":"CodelessConnectorPollingRequestProperties","Properties":{"apiEndpoint":{"Type":4,"Flags":1,"Description":"Describe the endpoint we should pull the data from"},"rateLimitQps":{"Type":3,"Flags":0,"Description":"Defines the rate limit QPS"},"queryWindowInMin":{"Type":3,"Flags":1,"Description":"The window interval we will use the pull the data"},"httpMethod":{"Type":4,"Flags":1,"Description":"The http method type we will use in the poll request, GET or POST"},"queryTimeFormat":{"Type":4,"Flags":1,"Description":"The time format will be used the query events in a specific window"},"retryCount":{"Type":3,"Flags":0,"Description":"Describe the amount of time we should try and poll the data in case of failure"},"timeoutInSeconds":{"Type":3,"Flags":0,"Description":"The number of seconds we will consider as a request timeout"},"headers":{"Type":0,"Flags":0,"Description":"Any object"},"queryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"queryParametersTemplate":{"Type":4,"Flags":0,"Description":"For advanced scenarios for example user name/password embedded in nested JSON payload"},"startTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from a start of the time window"},"endTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from the end of the time window"}}}},{"2":{"Name":"CodelessConnectorPollingPagingProperties","Properties":{"pagingType":{"Type":4,"Flags":1,"Description":"Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'"},"nextPageParaName":{"Type":4,"Flags":0,"Description":"Defines the name of a next page attribute"},"nextPageTokenJsonPath":{"Type":4,"Flags":0,"Description":"Defines the path to a next page token JSON"},"pageCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page count attribute"},"pageTotalCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page total count attribute"},"pageTimeStampAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a paging time stamp attribute"},"searchTheLatestTimeStampFromEventsList":{"Type":4,"Flags":0,"Description":"Determines whether to search for the latest time stamp in the events list"},"pageSizeParaName":{"Type":4,"Flags":0,"Description":"Defines the name of the page size parameter"},"pageSize":{"Type":3,"Flags":0,"Description":"Defines the paging size"}}}},{"2":{"Name":"CodelessConnectorPollingResponseProperties","Properties":{"eventsJsonPaths":{"Type":661,"Flags":1,"Description":"Describes the path we should extract the data in the response"},"successStatusJsonPath":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status code in the response"},"successStatusValue":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status value in the response"},"isGzipCompressed":{"Type":2,"Flags":0,"Description":"Describes if the data in the response is Gzip"}}}},{"3":{"ItemType":4}},{"6":{"Value":"APIPolling"}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":664,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":670,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":665,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":666,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":669,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[667,668]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AwsS3DataConnector","Properties":{"properties":{"Type":672,"Flags":0,"Description":"Amazon Web Services S3 data connector properties."},"kind":{"Type":679,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsS3DataConnectorProperties","Properties":{"destinationTable":{"Type":4,"Flags":1,"Description":"The logs destination table name in LogAnalytics."},"sqsUrls":{"Type":673,"Flags":1,"Description":"The AWS sqs urls for the connector."},"roleArn":{"Type":4,"Flags":1,"Description":"The Aws Role Arn that is used to access the Aws account."},"dataTypes":{"Type":674,"Flags":1,"Description":"The available data types for Amazon Web Services S3 data connector."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AwsS3DataConnectorDataTypes","Properties":{"logs":{"Type":675,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsS3DataConnectorDataTypesLogs","Properties":{"state":{"Type":678,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[676,677]}},{"6":{"Value":"AmazonWebServicesS3"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":681,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":687,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":682,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":683,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":686,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[684,685]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":689,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":690,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":682,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":692,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":693,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":682,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":695,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":701,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":696,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":697,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":700,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[698,699]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":703,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":704,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":618,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":706,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":708,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":707,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":683,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":683,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":710,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":711,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":682,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":713,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":723,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":714,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":715,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":719,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":718,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[716,717]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":722,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[720,721]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":725,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":731,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":726,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":727,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":730,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[728,729]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":733,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":747,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":734,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":735,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":739,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":743,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":738,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[736,737]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":742,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[740,741]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":746,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[744,745]}},{"6":{"Value":"Office365"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":749,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":750,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":682,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"OfficeIRMDataConnector","Properties":{"properties":{"Type":752,"Flags":0,"Description":"OfficeIRM (Microsoft Insider Risk Management) data connector properties."},"kind":{"Type":753,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeIRMDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":682,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeIRM"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":755,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":761,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":756,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":757,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":760,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[758,759]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":763,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":773,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":767,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":768,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[764,765,766]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":769,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":772,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[770,771]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2021-09-01-preview","ScopeType":16,"Body":615}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":775,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":776,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":778,"Flags":4,"Description":"Describes threat intelligence entity properties"},"kind":{"Type":798,"Flags":1,"Description":"The kind of the threat intelligence entity"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":779,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":780,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":782,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":786,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":789,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":792,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":793,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":794,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":795,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":796,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":797,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":781}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":785,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":784}},{"3":{"ItemType":783}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":788,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":787}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":791,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":790}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"6":{"Value":"indicator"}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-09-01-preview","ScopeType":16,"Body":777}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":22,"MLBehaviorAnalytics":45,"MicrosoftSecurityIncidentCreation":68,"NRT":87,"Scheduled":166,"ThreatIntelligence":200}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":16,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":21,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[12,13,14,15,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[17,18,19,20,4]}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":23,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":44,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":28,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":43,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[24,25,26,27,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[29,30,31,32,33,34,35,36,37,38,39,40,41,4]}},{"3":{"ItemType":42}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":46,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":67,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":51,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":66,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[47,48,49,50,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[52,53,54,55,56,57,58,59,60,61,62,63,64,4]}},{"3":{"ItemType":65}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":69,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":86,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":70,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":71,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":79,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":85,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[72,73,74,75,76,77,78,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[80,81,82,83,4]}},{"3":{"ItemType":84}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"NrtAlertRule","Properties":{"properties":{"Type":88,"Flags":0,"Description":"Nrt alert rule base property bag."},"kind":{"Type":165,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"NrtAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":93,"Flags":0,"Description":"The severity of the alert"},"tactics":{"Type":108,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":109,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":140,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":163,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":164,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[89,90,91,92,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[94,95,96,97,98,99,100,101,102,103,104,105,106,4]}},{"3":{"ItemType":107}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":110,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":114,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":134,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":138,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":139,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[111,112,113,4]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,4]}},{"3":{"ItemType":133}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[135,136,4]}},{"3":{"ItemType":137}},{"3":{"ItemType":4}},{"2":{"Name":"QueryBasedAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":160,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":162,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,4]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":161}},{"3":{"ItemType":141}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"NRT"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":167,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":199,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"triggerOperator":{"Type":172,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":173,"Flags":0,"Description":"Event grouping settings property bag."},"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":181,"Flags":0,"Description":"The severity of the alert"},"tactics":{"Type":196,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":109,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":197,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":198,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":164,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[168,169,170,171]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":176,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[174,175,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[177,178,179,180,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[182,183,184,185,186,187,188,189,190,191,192,193,194,4]}},{"3":{"ItemType":195}},{"2":{"Name":"QueryBasedAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":141}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":201,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":222,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":206,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":221,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[202,203,204,205,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[207,208,209,210,211,212,213,214,215,216,217,218,219,4]}},{"3":{"ItemType":220}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2021-09-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":224,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":225,"Flags":10,"Description":"The resource api version"},"properties":{"Type":227,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2021-09-01-preview","ScopeType":16,"Body":226}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":229,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":230,"Flags":10,"Description":"The resource api version"},"properties":{"Type":232,"Flags":0,"Description":"Describes automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":233,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":342,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdBy":{"Type":343,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"lastModifiedBy":{"Type":343,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled."},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":235,"Flags":1,"Description":"The type of object the automation rule triggers on"},"triggersWhen":{"Type":237,"Flags":1,"Description":"The type of event the automation rule triggers on"},"conditions":{"Type":305,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"5":{"Elements":[234,4]}},{"6":{"Value":"Created"}},{"5":{"Elements":[236,4]}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":239}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"conditionProperties":{"Type":240,"Flags":1,"Description":"The configuration of the automation rule condition"},"conditionType":{"Type":304,"Flags":1,"Description":"The type of the automation rule condition"}}}},{"2":{"Name":"AutomationRulePropertyValuesConditionProperties","Properties":{"propertyName":{"Type":293,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":302,"Flags":0,"Description":"The operator to use for evaluation the condition"},"propertyValues":{"Type":303,"Flags":0,"Description":"The values to use for evaluating the condition"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,286,287,288,289,290,291,292,4]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[294,295,296,297,298,299,300,301,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":238}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule action"}},"Elements":{"ModifyProperties":307,"RunPlaybook":339}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":308,"Flags":1,"Description":"The configuration of the modify properties automation rule action"},"actionType":{"Type":338,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleModifyPropertiesActionConfiguration","Properties":{"classification":{"Type":313,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":318,"Flags":0,"Description":"The classification reason the incident was closed with"},"labels":{"Type":323,"Flags":0,"Description":"List of labels to add to the incident"},"owner":{"Type":324,"Flags":0,"Description":"Information on the user an incident is assigned to"},"severity":{"Type":333,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":337,"Flags":0,"Description":"The status of the incident"}}}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[309,310,311,312,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[314,315,316,317,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":322,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[320,321,4]}},{"3":{"ItemType":319}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":328,"Flags":2,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[325,326,327,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[329,330,331,332,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[334,335,336,4]}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":340,"Flags":1,"Description":"The configuration of the run playbook automation rule action"},"actionType":{"Type":341,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"AutomationRuleRunPlaybookActionConfiguration","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":306}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2021-09-01-preview","ScopeType":16,"Body":231}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":345,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":346,"Flags":10,"Description":"The resource api version"},"properties":{"Type":348,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":349,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":350,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":349,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":351,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":356,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[352,353,354,355,4]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2021-09-01-preview","ScopeType":16,"Body":347}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":358,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":359,"Flags":10,"Description":"The resource api version"},"properties":{"Type":361,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2021-09-01-preview","ScopeType":16,"Body":360}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":363,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":364,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":366,"Expansion":396}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":367,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":395,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":368,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":390,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":392,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":394,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":391}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":393}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":397,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":445,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":398,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":420,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":421,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":444,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[422,423,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,439,440,441,442,4]}},{"3":{"ItemType":443}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2021-09-01-preview","ScopeType":16,"Body":365}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":451,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":472,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":477,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":478,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":324,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":479,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":484,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":488,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":489,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":452,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":467,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[453,454,455,456,457,458,459,460,461,462,463,464,465,4]}},{"3":{"ItemType":466}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[468,469,470,471,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[473,474,475,476,4]}},{"3":{"ItemType":319}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[480,481,482,483,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[485,486,487,4]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-09-01-preview","ScopeType":16,"Body":449}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":491,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":492,"Flags":10,"Description":"The resource api version"},"properties":{"Type":494,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":343,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-09-01-preview","ScopeType":16,"Body":493}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":496,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":497,"Flags":10,"Description":"The resource api version"},"properties":{"Type":361,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-09-01-preview","ScopeType":16,"Body":498}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":500,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":501,"Flags":10,"Description":"The resource api version"},"properties":{"Type":503,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":518,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":519,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":525,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":526,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":531,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":551,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":554,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[504,505,506,507,508,509,510,511,512,513,514,515,516,517,4]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":524,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[520,521,522,523,4]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":530,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[527,528,529,4]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":546,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":549,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":550,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[532,533,534,535,536,537,538,539,540,541,542,543,544,545,4]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[547,548,4]}},{"3":{"ItemType":531}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":552,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":553,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2021-09-01-preview","ScopeType":16,"Body":502}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":556,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":557,"Flags":10,"Description":"The resource api version"},"properties":{"Type":559,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2021-09-01-preview","ScopeType":16,"Body":558}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":564,"EntityAnalytics":567,"EyesOn":570,"Ueba":573}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":565,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":566,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":568,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":569,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":571,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":572,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":574,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":581,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":580,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[575,576,577,578,4]}},{"3":{"ItemType":579}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2021-09-01-preview","ScopeType":16,"Body":563}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":583,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":584,"Flags":10,"Description":"The resource api version"},"properties":{"Type":586,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":589,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":593,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":594,"Flags":1,"Description":"metadata of a repository."}}}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[587,588,4]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[590,591,4]}},{"3":{"ItemType":592}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":599,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":598,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[596,597,4]}},{"3":{"ItemType":595}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2021-09-01-preview","ScopeType":16,"Body":585}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":601,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":602,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":607,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":349,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":349,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":608,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[605,606,4]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-09-01-preview","ScopeType":16,"Body":603}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":610,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":611,"Flags":10,"Description":"The resource api version"},"properties":{"Type":613,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":349,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":349,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-09-01-preview","ScopeType":16,"Body":612}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2021-09-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":615,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":616,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"APIPolling":618,"AmazonWebServicesCloudTrail":666,"AmazonWebServicesS3":674,"AzureActiveDirectory":683,"AzureAdvancedThreatProtection":691,"AzureSecurityCenter":694,"Dynamics365":697,"GenericUI":705,"MicrosoftCloudAppSecurity":708,"MicrosoftDefenderAdvancedThreatProtection":712,"MicrosoftThreatIntelligence":715,"MicrosoftThreatProtection":727,"Office365":735,"OfficeATP":751,"OfficeIRM":754,"ThreatIntelligence":757,"ThreatIntelligenceTaxii":765}}},{"2":{"Name":"CodelessApiPollingDataConnector","Properties":{"properties":{"Type":619,"Flags":0,"Description":"Represents Codeless API Polling data connector"},"kind":{"Type":665,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ApiPollingParameters","Properties":{"connectorUiConfig":{"Type":620,"Flags":0,"Description":"Config to describe the instructions blade"},"pollingConfig":{"Type":659,"Flags":0,"Description":"Config to describe the polling config for API poller connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":622,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":624,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":626,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":631,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":632,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":634,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":658,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":621}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":623}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":625}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":629,"Flags":0,"Description":"type of connectivity"},"value":{"Type":630,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"5":{"Elements":[628,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":627}},{"2":{"Name":"Availability","Properties":{"status":{"Type":633,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":648,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":650,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":642,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":646,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":647,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[636,637,638,639,640,641,4]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[643,644,645,4]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":635}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":649}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":657,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":656,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[653,654,655,4]}},{"3":{"ItemType":652}},{"3":{"ItemType":651}},{"2":{"Name":"CodelessConnectorPollingConfigProperties","Properties":{"isActive":{"Type":2,"Flags":0,"Description":"The poller active status"},"auth":{"Type":660,"Flags":1,"Description":"Describe the authentication properties needed to successfully authenticate with the server"},"request":{"Type":661,"Flags":1,"Description":"Describe the request properties needed to successfully pull from the server"},"paging":{"Type":662,"Flags":0,"Description":"Describe the properties needed to make a pagination call"},"response":{"Type":663,"Flags":0,"Description":"Describes the response from the external server"}}}},{"2":{"Name":"CodelessConnectorPollingAuthProperties","Properties":{"authType":{"Type":4,"Flags":1,"Description":"The authentication type"},"apiKeyName":{"Type":4,"Flags":0,"Description":"The header name which the token is sent with"},"apiKeyIdentifier":{"Type":4,"Flags":0,"Description":"A prefix send in the header before the actual token"},"isApiKeyInPostPayload":{"Type":4,"Flags":0,"Description":"Marks if the key should sent in header"},"flowName":{"Type":4,"Flags":0,"Description":"Describes the flow name, for example 'AuthCode' for Oauth 2.0"},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to issue a token, used in Oauth 2.0 flow"},"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to authorize the user, used in Oauth 2.0 flow"},"authorizationEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"redirectionEndpoint":{"Type":4,"Flags":0,"Description":"The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow"},"tokenEndpointHeaders":{"Type":0,"Flags":0,"Description":"Any object"},"tokenEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"isClientSecretInHeader":{"Type":2,"Flags":0,"Description":"Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow"},"scope":{"Type":4,"Flags":0,"Description":"The OAuth token scope"}}}},{"2":{"Name":"CodelessConnectorPollingRequestProperties","Properties":{"apiEndpoint":{"Type":4,"Flags":1,"Description":"Describe the endpoint we should pull the data from"},"rateLimitQps":{"Type":3,"Flags":0,"Description":"Defines the rate limit QPS"},"queryWindowInMin":{"Type":3,"Flags":1,"Description":"The window interval we will use the pull the data"},"httpMethod":{"Type":4,"Flags":1,"Description":"The http method type we will use in the poll request, GET or POST"},"queryTimeFormat":{"Type":4,"Flags":1,"Description":"The time format will be used the query events in a specific window"},"retryCount":{"Type":3,"Flags":0,"Description":"Describe the amount of time we should try and poll the data in case of failure"},"timeoutInSeconds":{"Type":3,"Flags":0,"Description":"The number of seconds we will consider as a request timeout"},"headers":{"Type":0,"Flags":0,"Description":"Any object"},"queryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"queryParametersTemplate":{"Type":4,"Flags":0,"Description":"For advanced scenarios for example user name/password embedded in nested JSON payload"},"startTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from a start of the time window"},"endTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from the end of the time window"}}}},{"2":{"Name":"CodelessConnectorPollingPagingProperties","Properties":{"pagingType":{"Type":4,"Flags":1,"Description":"Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'"},"nextPageParaName":{"Type":4,"Flags":0,"Description":"Defines the name of a next page attribute"},"nextPageTokenJsonPath":{"Type":4,"Flags":0,"Description":"Defines the path to a next page token JSON"},"pageCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page count attribute"},"pageTotalCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page total count attribute"},"pageTimeStampAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a paging time stamp attribute"},"searchTheLatestTimeStampFromEventsList":{"Type":4,"Flags":0,"Description":"Determines whether to search for the latest time stamp in the events list"},"pageSizeParaName":{"Type":4,"Flags":0,"Description":"Defines the name of the page size parameter"},"pageSize":{"Type":3,"Flags":0,"Description":"Defines the paging size"}}}},{"2":{"Name":"CodelessConnectorPollingResponseProperties","Properties":{"eventsJsonPaths":{"Type":664,"Flags":1,"Description":"Describes the path we should extract the data in the response"},"successStatusJsonPath":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status code in the response"},"successStatusValue":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status value in the response"},"isGzipCompressed":{"Type":2,"Flags":0,"Description":"Describes if the data in the response is Gzip"}}}},{"3":{"ItemType":4}},{"6":{"Value":"APIPolling"}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":667,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":673,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":668,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":669,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":672,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[670,671,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AwsS3DataConnector","Properties":{"properties":{"Type":675,"Flags":0,"Description":"Amazon Web Services S3 data connector properties."},"kind":{"Type":682,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsS3DataConnectorProperties","Properties":{"destinationTable":{"Type":4,"Flags":1,"Description":"The logs destination table name in LogAnalytics."},"sqsUrls":{"Type":676,"Flags":1,"Description":"The AWS sqs urls for the connector."},"roleArn":{"Type":4,"Flags":1,"Description":"The Aws Role Arn that is used to access the Aws account."},"dataTypes":{"Type":677,"Flags":1,"Description":"The available data types for Amazon Web Services S3 data connector."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AwsS3DataConnectorDataTypes","Properties":{"logs":{"Type":678,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsS3DataConnectorDataTypesLogs","Properties":{"state":{"Type":681,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[679,680,4]}},{"6":{"Value":"AmazonWebServicesS3"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":684,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":690,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":685,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":686,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":689,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[687,688,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":692,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":693,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":685,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":695,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":696,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":685,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":698,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":704,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":699,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":700,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":703,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[701,702,4]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":706,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":707,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":620,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":709,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":711,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":710,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":686,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":686,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":713,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":714,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":685,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":716,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":726,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":717,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":718,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":722,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":721,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[719,720,4]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":725,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[723,724,4]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":728,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":734,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":729,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":730,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":733,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[731,732,4]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":736,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":750,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":737,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":738,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":742,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":746,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":741,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[739,740,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":745,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[743,744,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":749,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[747,748,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":752,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":753,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":685,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"OfficeIRMDataConnector","Properties":{"properties":{"Type":755,"Flags":0,"Description":"OfficeIRM (Microsoft Insider Risk Management) data connector properties."},"kind":{"Type":756,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeIRMDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":685,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeIRM"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":758,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":764,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":759,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":760,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":763,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[761,762,4]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":766,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":776,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":770,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":771,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[767,768,769,4]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":772,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":775,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[773,774,4]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2021-09-01-preview","ScopeType":16,"Body":617}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2021-09-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":781,"Flags":4,"Description":"Describes threat intelligence entity properties"},"kind":{"Type":802,"Flags":1,"Description":"The kind of the threat intelligence entity"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":782,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":783,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":785,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":789,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":792,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":795,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":796,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":797,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":798,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":799,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":800,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":784}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":788,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":787}},{"3":{"ItemType":786}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":791,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":790}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":794,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":793}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"6":{"Value":"indicator"}},{"5":{"Elements":[801,4]}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-09-01-preview","ScopeType":16,"Body":780}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md b/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md index c026b329b6..7934a91065 100644 --- a/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md +++ b/generated/securityinsights/microsoft.securityinsights/2021-09-01-preview/types.md @@ -309,7 +309,7 @@ * **apiVersion**: '2021-09-01-preview' (ReadOnly, DeployTimeConstant): The resource api version * **etag**: string: Etag of the azure resource * **id**: string (ReadOnly, DeployTimeConstant): The resource id -* **kind**: 'indicator' (Required): The kind of the threat intelligence entity +* **kind**: 'indicator' | string (Required): The kind of the threat intelligence entity * **name**: string (Required, DeployTimeConstant): The resource name * **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. @@ -337,64 +337,44 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type -## SystemData +## AADDataConnectorProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## FusionAlertRuleProperties +## AatpDataConnectorProperties ### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## MicrosoftSecurityIncidentCreationAlertRuleProperties +## ActionRequestProperties ### Properties -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated -* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' (Required): The alerts' productName on which the cases will be generated -* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium'[]: the alerts' severities on which the cases will be generated +* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. +* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. +* **workflowId**: string (ReadOnly): The name of the logic app's workflow. -## MLBehaviorAnalyticsAlertRuleProperties +## ActivityEntityQueriesProperties ### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule +* **content**: string: The entity query content to display in timeline +* **createdTimeUtc**: string (ReadOnly): The time the activity was created +* **description**: string: The entity query description +* **enabled**: bool: Determines whether this activity is enabled or disabled. +* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The type of the entity +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated +* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions +* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query +* **templateName**: string: The template id this activity was created from +* **title**: string: The entity query title -## NrtAlertRuleProperties +## ActivityEntityQueriesPropertiesEntitiesFilter ### Properties -* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **customDetails**: [QueryBasedAlertRulePropertiesCustomDetails](#querybasedalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule -* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. -* **query**: string: The query that creates alerts for this rule. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the alert -* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. -* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[]: The tactics of the alert rule -* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> +### Additional Properties +* **Additional Properties Type**: string[] + +## ActivityEntityQueriesPropertiesQueryDefinitions +### Properties +* **query**: string: The Activity query to run on a given entity ## AlertDetailsOverride ### Properties @@ -403,94 +383,23 @@ * **alertSeverityColumnName**: string: the column name to take the alert severity from * **alertTacticsColumnName**: string: the column name to take the alert tactics from -## QueryBasedAlertRulePropertiesCustomDetails -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EntityMapping -### Properties -* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL': The V3 type of the mapped entity -* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping - -## FieldMapping -### Properties -* **columnName**: string: the column name to be mapped to the identifier -* **identifier**: string: the V3 identifier of the entity - -## IncidentConfiguration -### Properties -* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule -* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. - -## GroupingConfiguration -### Properties -* **enabled**: bool (Required): Grouping enabled -* **groupByAlertDetails**: 'DisplayName' | 'Severity'[]: A list of alert details to group by (when matchingMethod is Selected) -* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. -* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL'[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. -* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) -* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. -* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents - -## ScheduledAlertRuleProperties -### Properties -* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details -* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. -* **customDetails**: [QueryBasedAlertRulePropertiesCustomDetails](#querybasedalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert -* **description**: string: The description of the alert rule. -* **displayName**: string (Required): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule -* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. -* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. -* **query**: string: The query that creates alerts for this rule. -* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. -* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the alert -* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. -* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[]: The tactics of the alert rule -* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> -* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. -* **triggerThreshold**: int: The threshold triggers this alert rule. - -## QueryBasedAlertRulePropertiesCustomDetails -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EventGroupingSettings +## AlertsDataTypeOfDataConnector ### Properties -* **aggregationKind**: 'AlertPerResult' | 'SingleAlert': The event grouping aggregation kinds +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. -## ThreatIntelligenceAlertRuleProperties +## AnomaliesSettingsProperties ### Properties -* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. -* **description**: string (ReadOnly): The description of the alert rule. -* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. -* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. -* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (ReadOnly): The severity of the alert -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics of the alert rule +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. -## ActionRequestProperties +## ApiPollingParameters ### Properties -* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. -* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. -* **workflowId**: string (ReadOnly): The name of the logic app's workflow. +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade +* **pollingConfig**: [CodelessConnectorPollingConfigProperties](#codelessconnectorpollingconfigproperties): Config to describe the polling config for API poller connector -## AutomationRuleProperties +## ASCDataConnectorProperties ### Properties -* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered -* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created -* **displayName**: string (Required): The display name of the automation rule -* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated -* **order**: int (Required): The order of execution of the automation rule -* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. ## AutomationRuleAction * **Discriminator**: actionType @@ -508,64 +417,88 @@ * **actionType**: 'RunPlaybook' (Required): The type of the automation rule action +## AutomationRuleCondition +* **Discriminator**: conditionType + +### Base Properties +### AutomationRulePropertyValuesCondition +#### Properties +* **conditionProperties**: [AutomationRulePropertyValuesConditionProperties](#automationrulepropertyvaluesconditionproperties) (Required): The configuration of the automation rule condition +* **conditionType**: 'Property' (Required): The type of the automation rule condition + + ## AutomationRuleModifyPropertiesActionConfiguration ### Properties -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed * **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with * **labels**: [IncidentLabel](#incidentlabel)[]: List of labels to add to the incident * **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the incident -* **status**: 'Active' | 'Closed' | 'New': The status of the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string: The status of the incident -## IncidentLabel +## AutomationRuleProperties ### Properties -* **labelName**: string (Required): The name of the label -* **labelType**: 'System' | 'User' (ReadOnly): The type of the label +* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered +* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created +* **displayName**: string (Required): The display name of the automation rule +* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated +* **order**: int (Required): The order of execution of the automation rule +* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic -## IncidentOwnerInfo +## AutomationRulePropertyValuesConditionProperties ### Properties -* **assignedTo**: string: The name of the user the incident is assigned to. -* **email**: string: The email of the user the incident is assigned to. -* **objectId**: string: The object id of the user the incident is assigned to. -* **ownerType**: 'Group' | 'Unknown' | 'User' (ReadOnly): The type of the owner the incident is assigned to. -* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. +* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith' | string: The operator to use for evaluation the condition +* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url' | string: The property to evaluate in an automation rule property condition +* **propertyValues**: string[]: The values to use for evaluating the condition ## AutomationRuleRunPlaybookActionConfiguration ### Properties * **logicAppResourceId**: string: The resource id of the playbook resource * **tenantId**: string: The tenant id of the playbook resource -## ClientInfo -### Properties -* **email**: string: The email of the client. -* **name**: string: The name of the client. -* **objectId**: string: The object id of the client. -* **userPrincipalName**: string: The user principal name of the client. - ## AutomationRuleTriggeringLogic ### Properties * **conditions**: [AutomationRuleCondition](#automationrulecondition)[]: The conditions to evaluate to determine if the automation rule should be triggered on a given object * **expirationTimeUtc**: string: Determines when the automation rule should automatically expire and be disabled. * **isEnabled**: bool (Required): Determines whether the automation rule is enabled or disabled. -* **triggersOn**: 'Incidents' (Required): The type of object the automation rule triggers on -* **triggersWhen**: 'Created' (Required): The type of event the automation rule triggers on +* **triggersOn**: 'Incidents' | string (Required): The type of object the automation rule triggers on +* **triggersWhen**: 'Created' | string (Required): The type of event the automation rule triggers on -## AutomationRuleCondition -* **Discriminator**: conditionType +## Availability +### Properties +* **isPreview**: bool: Set connector as preview +* **status**: '1': The connector Availability Status -### Base Properties -### AutomationRulePropertyValuesCondition -#### Properties -* **conditionProperties**: [AutomationRulePropertyValuesConditionProperties](#automationrulepropertyvaluesconditionproperties) (Required): The configuration of the automation rule condition -* **conditionType**: 'Property' (Required): The type of the automation rule condition +## AwsCloudTrailDataConnectorDataTypes +### Properties +* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs) (Required): Logs data type. + +## AwsCloudTrailDataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. +## AwsCloudTrailDataConnectorProperties +### Properties +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. -## AutomationRulePropertyValuesConditionProperties +## AwsS3DataConnectorDataTypes ### Properties -* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith': The operator to use for evaluation the condition -* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url': The property to evaluate in an automation rule property condition -* **propertyValues**: string[]: The values to use for evaluating the condition +* **logs**: [AwsS3DataConnectorDataTypesLogs](#awss3dataconnectordatatypeslogs) (Required): Logs data type. + +## AwsS3DataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsS3DataConnectorProperties +### Properties +* **dataTypes**: [AwsS3DataConnectorDataTypes](#awss3dataconnectordatatypes) (Required): The available data types for Amazon Web Services S3 data connector. +* **destinationTable**: string (Required): The logs destination table name in LogAnalytics. +* **roleArn**: string (Required): The Aws Role Arn that is used to access the Aws account. +* **sqsUrls**: string[] (Required): The AWS sqs urls for the connector. ## BookmarkProperties ### Properties @@ -583,58 +516,74 @@ * **updated**: string: The last time the bookmark was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action -## UserInfo -### Properties -* **email**: string (ReadOnly): The email of the user. -* **name**: string (ReadOnly): The name of the user. -* **objectId**: string: The object id of the user. - -## IncidentInfo +## ClientInfo ### Properties -* **incidentId**: string: Incident Id -* **relationName**: string: Relation Name -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium': The severity of the incident -* **title**: string: The title of the incident +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. -## RelationProperties +## CodelessConnectorPollingAuthProperties ### Properties -* **relatedResourceId**: string (Required): The resource ID of the related resource -* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource -* **relatedResourceName**: string (ReadOnly): The name of the related resource -* **relatedResourceType**: string (ReadOnly): The resource type of the related resource +* **apiKeyIdentifier**: string: A prefix send in the header before the actual token +* **apiKeyName**: string: The header name which the token is sent with +* **authorizationEndpoint**: string: The endpoint used to authorize the user, used in Oauth 2.0 flow +* **authorizationEndpointQueryParameters**: any: Any object +* **authType**: string (Required): The authentication type +* **flowName**: string: Describes the flow name, for example 'AuthCode' for Oauth 2.0 +* **isApiKeyInPostPayload**: string: Marks if the key should sent in header +* **isClientSecretInHeader**: bool: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow +* **redirectionEndpoint**: string: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow +* **scope**: string: The OAuth token scope +* **tokenEndpoint**: string: The endpoint used to issue a token, used in Oauth 2.0 flow +* **tokenEndpointHeaders**: any: Any object +* **tokenEndpointQueryParameters**: any: Any object -## AwsCloudTrailDataConnectorProperties +## CodelessConnectorPollingConfigProperties ### Properties -* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. -* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. - -## AwsCloudTrailDataConnectorDataTypes -### Properties -* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs) (Required): Logs data type. - -## AwsCloudTrailDataConnectorDataTypesLogs -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **auth**: [CodelessConnectorPollingAuthProperties](#codelessconnectorpollingauthproperties) (Required): Describe the authentication properties needed to successfully authenticate with the server +* **isActive**: bool: The poller active status +* **paging**: [CodelessConnectorPollingPagingProperties](#codelessconnectorpollingpagingproperties): Describe the properties needed to make a pagination call +* **request**: [CodelessConnectorPollingRequestProperties](#codelessconnectorpollingrequestproperties) (Required): Describe the request properties needed to successfully pull from the server +* **response**: [CodelessConnectorPollingResponseProperties](#codelessconnectorpollingresponseproperties): Describes the response from the external server -## AwsS3DataConnectorProperties +## CodelessConnectorPollingPagingProperties ### Properties -* **dataTypes**: [AwsS3DataConnectorDataTypes](#awss3dataconnectordatatypes) (Required): The available data types for Amazon Web Services S3 data connector. -* **destinationTable**: string (Required): The logs destination table name in LogAnalytics. -* **roleArn**: string (Required): The Aws Role Arn that is used to access the Aws account. -* **sqsUrls**: string[] (Required): The AWS sqs urls for the connector. +* **nextPageParaName**: string: Defines the name of a next page attribute +* **nextPageTokenJsonPath**: string: Defines the path to a next page token JSON +* **pageCountAttributePath**: string: Defines the path to a page count attribute +* **pageSize**: int: Defines the paging size +* **pageSizeParaName**: string: Defines the name of the page size parameter +* **pageTimeStampAttributePath**: string: Defines the path to a paging time stamp attribute +* **pageTotalCountAttributePath**: string: Defines the path to a page total count attribute +* **pagingType**: string (Required): Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp' +* **searchTheLatestTimeStampFromEventsList**: string: Determines whether to search for the latest time stamp in the events list -## AwsS3DataConnectorDataTypes +## CodelessConnectorPollingRequestProperties ### Properties -* **logs**: [AwsS3DataConnectorDataTypesLogs](#awss3dataconnectordatatypeslogs) (Required): Logs data type. +* **apiEndpoint**: string (Required): Describe the endpoint we should pull the data from +* **endTimeAttributeName**: string: This will be used the query events from the end of the time window +* **headers**: any: Any object +* **httpMethod**: string (Required): The http method type we will use in the poll request, GET or POST +* **queryParameters**: any: Any object +* **queryParametersTemplate**: string: For advanced scenarios for example user name/password embedded in nested JSON payload +* **queryTimeFormat**: string (Required): The time format will be used the query events in a specific window +* **queryWindowInMin**: int (Required): The window interval we will use the pull the data +* **rateLimitQps**: int: Defines the rate limit QPS +* **retryCount**: int: Describe the amount of time we should try and poll the data in case of failure +* **startTimeAttributeName**: string: This will be used the query events from a start of the time window +* **timeoutInSeconds**: int: The number of seconds we will consider as a request timeout -## AwsS3DataConnectorDataTypesLogs +## CodelessConnectorPollingResponseProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **eventsJsonPaths**: string[] (Required): Describes the path we should extract the data in the response +* **isGzipCompressed**: bool: Describes if the data in the response is Gzip +* **successStatusJsonPath**: string: Describes the path we should extract the status code in the response +* **successStatusValue**: string: Describes the path we should extract the status value in the response -## ApiPollingParameters +## CodelessParameters ### Properties * **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade -* **pollingConfig**: [CodelessConnectorPollingConfigProperties](#codelessconnectorpollingconfigproperties): Config to describe the polling config for API poller connector ## CodelessUiConnectorConfigProperties ### Properties @@ -651,14 +600,9 @@ * **sampleQueries**: [CodelessUiConnectorConfigPropertiesSampleQueriesItem](#codelessuiconnectorconfigpropertiessamplequeriesitem)[] (Required): The sample queries for the connector * **title**: string (Required): Connector blade title -## Availability -### Properties -* **isPreview**: bool: Set connector as preview -* **status**: '1': The connector Availability Status - ## CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem ### Properties -* **type**: 'IsConnectedQuery': type of connectivity +* **type**: 'IsConnectedQuery' | string: type of connectivity * **value**: string[]: Queries for checking connectivity ## CodelessUiConnectorConfigPropertiesDataTypesItem @@ -678,422 +622,457 @@ * **instructions**: [InstructionStepsInstructionsItem](#instructionstepsinstructionsitem)[]: Instruction step details * **title**: string: Instruction step title -## InstructionStepsInstructionsItem +## CodelessUiConnectorConfigPropertiesSampleQueriesItem ### Properties -* **parameters**: any: Any object -* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' (Required): The kind of the setting +* **description**: string: The sample query description +* **query**: string: the sample query -## Permissions +## ContentPathMap ### Properties -* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector -* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector +* **contentType**: 'AnalyticRule' | 'Workbook' | string: The content type of a source control path. +* **path**: string: The path to the content. -## PermissionsCustomsItem +## DataConnectorDataTypeCommon ### Properties -* **description**: string: Customs permissions description -* **name**: string: Customs permissions name +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## PermissionsResourceProviderItem +## Dynamics365DataConnectorDataTypes ### Properties -* **permissionsDisplayText**: string: Permission description text -* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings': Provider name -* **providerDisplayName**: string: Permission provider display name -* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector -* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace': Permission provider scope +* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. -## RequiredPermissions +## Dynamics365DataConnectorDataTypesDynamics365CdsActivities ### Properties -* **action**: bool: action permission -* **delete**: bool: delete permission -* **read**: bool: read permission -* **write**: bool: write permission +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## CodelessUiConnectorConfigPropertiesSampleQueriesItem +## Dynamics365DataConnectorProperties ### Properties -* **description**: string: The sample query description -* **query**: string: the sample query +* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## CodelessConnectorPollingConfigProperties +## EntityAnalyticsProperties ### Properties -* **auth**: [CodelessConnectorPollingAuthProperties](#codelessconnectorpollingauthproperties) (Required): Describe the authentication properties needed to successfully authenticate with the server -* **isActive**: bool: The poller active status -* **paging**: [CodelessConnectorPollingPagingProperties](#codelessconnectorpollingpagingproperties): Describe the properties needed to make a pagination call -* **request**: [CodelessConnectorPollingRequestProperties](#codelessconnectorpollingrequestproperties) (Required): Describe the request properties needed to successfully pull from the server -* **response**: [CodelessConnectorPollingResponseProperties](#codelessconnectorpollingresponseproperties): Describes the response from the external server +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. -## CodelessConnectorPollingAuthProperties +## EntityCommonPropertiesAdditionalData ### Properties -* **apiKeyIdentifier**: string: A prefix send in the header before the actual token -* **apiKeyName**: string: The header name which the token is sent with -* **authorizationEndpoint**: string: The endpoint used to authorize the user, used in Oauth 2.0 flow -* **authorizationEndpointQueryParameters**: any: Any object -* **authType**: string (Required): The authentication type -* **flowName**: string: Describes the flow name, for example 'AuthCode' for Oauth 2.0 -* **isApiKeyInPostPayload**: string: Marks if the key should sent in header -* **isClientSecretInHeader**: bool: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow -* **redirectionEndpoint**: string: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow -* **scope**: string: The OAuth token scope -* **tokenEndpoint**: string: The endpoint used to issue a token, used in Oauth 2.0 flow -* **tokenEndpointHeaders**: any: Any object -* **tokenEndpointQueryParameters**: any: Any object +### Additional Properties +* **Additional Properties Type**: any -## CodelessConnectorPollingPagingProperties +## EntityMapping ### Properties -* **nextPageParaName**: string: Defines the name of a next page attribute -* **nextPageTokenJsonPath**: string: Defines the path to a next page token JSON -* **pageCountAttributePath**: string: Defines the path to a page count attribute -* **pageSize**: int: Defines the paging size -* **pageSizeParaName**: string: Defines the name of the page size parameter -* **pageTimeStampAttributePath**: string: Defines the path to a paging time stamp attribute -* **pageTotalCountAttributePath**: string: Defines the path to a page total count attribute -* **pagingType**: string (Required): Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp' -* **searchTheLatestTimeStampFromEventsList**: string: Determines whether to search for the latest time stamp in the events list +* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The V3 type of the mapped entity +* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping -## CodelessConnectorPollingRequestProperties +## EventGroupingSettings ### Properties -* **apiEndpoint**: string (Required): Describe the endpoint we should pull the data from -* **endTimeAttributeName**: string: This will be used the query events from the end of the time window -* **headers**: any: Any object -* **httpMethod**: string (Required): The http method type we will use in the poll request, GET or POST -* **queryParameters**: any: Any object -* **queryParametersTemplate**: string: For advanced scenarios for example user name/password embedded in nested JSON payload -* **queryTimeFormat**: string (Required): The time format will be used the query events in a specific window -* **queryWindowInMin**: int (Required): The window interval we will use the pull the data -* **rateLimitQps**: int: Defines the rate limit QPS -* **retryCount**: int: Describe the amount of time we should try and poll the data in case of failure -* **startTimeAttributeName**: string: This will be used the query events from a start of the time window -* **timeoutInSeconds**: int: The number of seconds we will consider as a request timeout +* **aggregationKind**: 'AlertPerResult' | 'SingleAlert' | string: The event grouping aggregation kinds -## CodelessConnectorPollingResponseProperties +## ExpansionEntityQueriesProperties ### Properties -* **eventsJsonPaths**: string[] (Required): Describes the path we should extract the data in the response -* **isGzipCompressed**: bool: Describes if the data in the response is Gzip -* **successStatusJsonPath**: string: Describes the path we should extract the status code in the response -* **successStatusValue**: string: Describes the path we should extract the status value in the response +* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query +* **displayName**: string (ReadOnly): The query display name +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string (ReadOnly): The type of the entity +* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query +* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[] (ReadOnly): List of the desired output types to be constructed from the result +* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted -## AADDataConnectorProperties +## EyesOnSettingsProperties ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. -## AlertsDataTypeOfDataConnector +## FieldMapping ### Properties -* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. +* **columnName**: string: the column name to be mapped to the identifier +* **identifier**: string: the V3 identifier of the entity -## DataConnectorDataTypeCommon +## FusionAlertRuleProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule -## AatpDataConnectorProperties +## GroupingConfiguration ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **enabled**: bool (Required): Grouping enabled +* **groupByAlertDetails**: 'DisplayName' | 'Severity' | string[]: A list of alert details to group by (when matchingMethod is Selected) +* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. +* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. +* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) +* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' | string (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. +* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents -## ASCDataConnectorProperties +## IncidentAdditionalData ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **subscriptionId**: string: The subscription id to connect to, and get the data from. +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with incident -## Dynamics365DataConnectorProperties +## IncidentCommentProperties ### Properties -* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message -## Dynamics365DataConnectorDataTypes +## IncidentConfiguration ### Properties -* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. +* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule +* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. -## Dynamics365DataConnectorDataTypesDynamics365CdsActivities +## IncidentInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident -## CodelessParameters +## IncidentLabel ### Properties -* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade +* **labelName**: string (Required): The name of the label +* **labelType**: 'System' | 'User' | string (ReadOnly): The type of the label -## McasDataConnectorProperties +## IncidentOwnerInfo ### Properties -* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **ownerType**: 'Group' | 'Unknown' | 'User' | string (ReadOnly): The type of the owner the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. + +## IncidentProperties +### Properties +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **providerIncidentId**: string: The incident ID assigned by the incident provider +* **providerName**: string: The name of the source provider that generated the incident +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **teamInformation**: [TeamInformation](#teaminformation): Describes team information +* **title**: string (Required): The title of the incident + +## InstructionStepsInstructionsItem +### Properties +* **parameters**: any: Any object +* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' | string (Required): The kind of the setting ## McasDataConnectorDataTypes ### Properties * **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. * **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. -## MdatpDataConnectorProperties +## McasDataConnectorProperties ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. * **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## MstiDataConnectorProperties +## MdatpDataConnectorProperties ### Properties -* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. * **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## MstiDataConnectorDataTypes -### Properties -* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. -* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. - -## MstiDataConnectorDataTypesBingSafetyPhishingURL -### Properties -* **lookbackPeriod**: string (Required): lookback period -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed +## MetadataAuthor ### Properties -* **lookbackPeriod**: string (Required): lookback period -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **email**: string: Email of author contact +* **link**: string: Link for author/vendor page +* **name**: string: Name of the author. Company or person. -## MTPDataConnectorProperties +## MetadataCategories ### Properties -* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **domains**: string[]: domain for the solution content item +* **verticals**: string[]: Industry verticals for the solution content item -## MTPDataConnectorDataTypes +## MetadataDependencies ### Properties -* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string: The kind of content the metadata is for. +* **name**: string: Name of the content item +* **operator**: 'AND' | 'OR' | string: Operator used for list of dependencies in criteria array. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks -## MTPDataConnectorDataTypesIncidents +## MetadataProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **author**: [MetadataAuthor](#metadataauthor): Publisher or creator of the content item. +* **categories**: [MetadataCategories](#metadatacategories): ies for the solution content item +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **dependencies**: [MetadataDependencies](#metadatadependencies): Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. +* **firstPublishDate**: string: first publish date of solution content item +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string (Required): The kind of content the metadata is for. +* **lastPublishDate**: string: last publish date of solution content item +* **parentId**: string (Required): Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group) +* **providers**: string[]: Providers for the solution content item +* **source**: [MetadataSource](#metadatasource): The original source of the content item, where it comes from. +* **support**: [MetadataSupport](#metadatasupport): Support information for the content item. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks -## OfficeDataConnectorProperties +## MetadataSource ### Properties -* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' | string (Required): Source type of the content +* **name**: string: Name of the content source. The repo name, solution name, LA workspace name etc. +* **sourceId**: string: ID of the content source. The solution ID, workspace ID, etc -## OfficeDataConnectorDataTypes +## MetadataSupport ### Properties -* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. -* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. -* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. +* **email**: string: Email of support contact +* **link**: string: Link for support help, like to support page to open a ticket etc. +* **name**: string: Name of the support contact. Company or person. +* **tier**: 'Community' | 'Microsoft' | 'Partner' | string (Required): Type of support for content item -## OfficeDataConnectorDataTypesExchange +## MicrosoftSecurityIncidentCreationAlertRuleProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated -## OfficeDataConnectorDataTypesSharePoint +## MLBehaviorAnalyticsAlertRuleProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule -## OfficeDataConnectorDataTypesTeams +## MstiDataConnectorDataTypes ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. +* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. -## OfficeATPDataConnectorProperties +## MstiDataConnectorDataTypesBingSafetyPhishingURL ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## OfficeIRMDataConnectorProperties +## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed ### Properties -* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. -* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## TIDataConnectorProperties +## MstiDataConnectorProperties ### Properties -* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. +* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. * **tenantId**: string (Required): The tenant id to connect to, and get the data from. -* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. -## TIDataConnectorDataTypes +## MTPDataConnectorDataTypes ### Properties -* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. +* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. -## TIDataConnectorDataTypesIndicators +## MTPDataConnectorDataTypesIncidents ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## TiTaxiiDataConnectorProperties +## MTPDataConnectorProperties ### Properties -* **collectionId**: string: The collection id of the TAXII server. -* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. -* **friendlyName**: string: The friendly name for the TAXII server. -* **password**: string: The password for the TAXII server. -* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' (Required): The polling frequency for the TAXII server. -* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. -* **taxiiServer**: string: The API root for the TAXII server. +* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. * **tenantId**: string (Required): The tenant id to connect to, and get the data from. -* **userName**: string: The userName for the TAXII server. -* **workspaceId**: string: The workspace id. - -## TiTaxiiDataConnectorDataTypes -### Properties -* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. -## TiTaxiiDataConnectorDataTypesTaxiiClient -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Describe whether this data type connection is enabled or not. - -## ActivityEntityQueriesProperties -### Properties -* **content**: string: The entity query content to display in timeline -* **createdTimeUtc**: string (ReadOnly): The time the activity was created -* **description**: string: The entity query description -* **enabled**: bool: Determines whether this activity is enabled or disabled. -* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters -* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL': The type of the entity -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated -* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions -* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query -* **templateName**: string: The template id this activity was created from -* **title**: string: The entity query title - -## ActivityEntityQueriesPropertiesEntitiesFilter +## NrtAlertRuleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [QueryBasedAlertRulePropertiesCustomDetails](#querybasedalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[]: The tactics of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> -## ActivityEntityQueriesPropertiesQueryDefinitions +## OfficeATPDataConnectorProperties ### Properties -* **query**: string: The Activity query to run on a given entity +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## ExpansionEntityQueriesProperties +## OfficeDataConnectorDataTypes ### Properties -* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query -* **displayName**: string (ReadOnly): The query display name -* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' (ReadOnly): The type of the entity -* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query -* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL'[] (ReadOnly): List of the desired output types to be constructed from the result -* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted +* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. +* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. +* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. -## IncidentProperties -### Properties -* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. -* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined': The reason the incident was closed -* **classificationComment**: string: Describes the reason the incident was closed -* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected': The classification reason the incident was closed with -* **createdTimeUtc**: string (ReadOnly): The time the incident was created -* **description**: string: The description of the incident -* **firstActivityTimeUtc**: string: The time of the first activity in the incident -* **incidentNumber**: int (ReadOnly): A sequential number -* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal -* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident -* **lastActivityTimeUtc**: string: The time of the last activity in the incident -* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated -* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to -* **providerIncidentId**: string: The incident ID assigned by the incident provider -* **providerName**: string: The name of the source provider that generated the incident -* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident -* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' (Required): The severity of the incident -* **status**: 'Active' | 'Closed' | 'New' (Required): The status of the incident -* **teamInformation**: [TeamInformation](#teaminformation): Describes team information -* **title**: string (Required): The title of the incident +## OfficeDataConnectorDataTypesExchange +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## IncidentAdditionalData +## OfficeDataConnectorDataTypesSharePoint ### Properties -* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident -* **alertsCount**: int (ReadOnly): The number of alerts in the incident -* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident -* **commentsCount**: int (ReadOnly): The number of comments in the incident -* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation'[] (ReadOnly): The tactics associated with incident +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## TeamInformation +## OfficeDataConnectorDataTypesTeams ### Properties -* **description**: string (ReadOnly): The description of the team -* **name**: string (ReadOnly): The name of the team -* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team -* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created -* **teamId**: string (ReadOnly): Team ID +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. -## IncidentCommentProperties +## OfficeDataConnectorProperties ### Properties -* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action -* **createdTimeUtc**: string (ReadOnly): The time the comment was created -* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated -* **message**: string (Required): The comment message +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## MetadataProperties +## OfficeIRMDataConnectorProperties ### Properties -* **author**: [MetadataAuthor](#metadataauthor): Publisher or creator of the content item. -* **categories**: [MetadataCategories](#metadatacategories): ies for the solution content item -* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. -* **dependencies**: [MetadataDependencies](#metadatadependencies): Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. -* **firstPublishDate**: string: first publish date of solution content item -* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' (Required): The kind of content the metadata is for. -* **lastPublishDate**: string: last publish date of solution content item -* **parentId**: string (Required): Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group) -* **providers**: string[]: Providers for the solution content item -* **source**: [MetadataSource](#metadatasource): The original source of the content item, where it comes from. -* **support**: [MetadataSupport](#metadatasupport): Support information for the content item. -* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. -## MetadataAuthor +## Permissions ### Properties -* **email**: string: Email of author contact -* **link**: string: Link for author/vendor page -* **name**: string: Name of the author. Company or person. +* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector +* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector -## MetadataCategories +## PermissionsCustomsItem ### Properties -* **domains**: string[]: domain for the solution content item -* **verticals**: string[]: Industry verticals for the solution content item +* **description**: string: Customs permissions description +* **name**: string: Customs permissions name -## MetadataDependencies +## PermissionsResourceProviderItem ### Properties -* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. -* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator -* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate': The kind of content the metadata is for. -* **name**: string: Name of the content item -* **operator**: 'AND' | 'OR': Operator used for list of dependencies in criteria array. -* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks +* **permissionsDisplayText**: string: Permission description text +* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings' | string: Provider name +* **providerDisplayName**: string: Permission provider display name +* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector +* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace' | string: Permission provider scope -## MetadataSource +## QueryBasedAlertRulePropertiesCustomDetails ### Properties -* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' (Required): Source type of the content -* **name**: string: Name of the content source. The repo name, solution name, LA workspace name etc. -* **sourceId**: string: ID of the content source. The solution ID, workspace ID, etc +### Additional Properties +* **Additional Properties Type**: string -## MetadataSupport +## QueryBasedAlertRulePropertiesCustomDetails ### Properties -* **email**: string: Email of support contact -* **link**: string: Link for support help, like to support page to open a ticket etc. -* **name**: string: Name of the support contact. Company or person. -* **tier**: 'Community' | 'Microsoft' | 'Partner' (Required): Type of support for content item +### Additional Properties +* **Additional Properties Type**: string -## SentinelOnboardingStateProperties +## RelationProperties ### Properties -* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource -## AnomaliesSettingsProperties +## Repository ### Properties -* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. +* **branch**: string: Branch name of repository. +* **deploymentLogsUrl**: string: Url to access repository action logs. +* **displayUrl**: string: Display url of repository. +* **pathMapping**: [ContentPathMap](#contentpathmap)[]: Dictionary of source control content type and path mapping. +* **url**: string: Url of repository. -## EntityAnalyticsProperties +## RequiredPermissions ### Properties -* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. +* **action**: bool: action permission +* **delete**: bool: delete permission +* **read**: bool: read permission +* **write**: bool: write permission -## EyesOnSettingsProperties +## ScheduledAlertRuleProperties ### Properties -* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [QueryBasedAlertRulePropertiesCustomDetails](#querybasedalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[]: The tactics of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. -## UebaProperties +## SentinelOnboardingStateProperties ### Properties -* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs'[]: The relevant data sources that enriched by ueba +* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting ## SourceControlProperties ### Properties -* **contentTypes**: 'AnalyticRule' | 'Workbook'[] (Required): Array of source control content types. +* **contentTypes**: 'AnalyticRule' | 'Workbook' | string[] (Required): Array of source control content types. * **description**: string: A description of the source control * **displayName**: string (Required): The display name of the source control * **id**: string: The id (a Guid) of the source control * **repository**: [Repository](#repository) (Required): metadata of a repository. -* **repoType**: 'DevOps' | 'Github' (Required): The type of repository. +* **repoType**: 'DevOps' | 'Github' | string (Required): The type of repository. -## Repository +## SystemData ### Properties -* **branch**: string: Branch name of repository. -* **deploymentLogsUrl**: string: Url to access repository action logs. -* **displayUrl**: string: Display url of repository. -* **pathMapping**: [ContentPathMap](#contentpathmap)[]: Dictionary of source control content type and path mapping. -* **url**: string: Url of repository. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ContentPathMap +## TeamInformation ### Properties -* **contentType**: 'AnalyticRule' | 'Workbook': The content type of a source control path. -* **path**: string: The path to the content. +* **description**: string (ReadOnly): The description of the team +* **name**: string (ReadOnly): The name of the team +* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team +* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created +* **teamId**: string (ReadOnly): Team ID + +## ThreatIntelligenceAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule + +## ThreatIntelligenceExternalReference +### Properties +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL + +## ThreatIntelligenceExternalReferenceHashes +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThreatIntelligenceGranularMarkingModel +### Properties +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors ## ThreatIntelligenceIndicatorProperties ### Properties @@ -1128,35 +1107,11 @@ * **validFrom**: string (WriteOnly): Valid from * **validUntil**: string (WriteOnly): Valid until -## EntityCommonPropertiesAdditionalData -### Properties -### Additional Properties -* **Additional Properties Type**: any - ## ThreatIntelligenceIndicatorPropertiesExtensions ### Properties ### Additional Properties * **Additional Properties Type**: any -## ThreatIntelligenceExternalReference -### Properties -* **description**: string (WriteOnly): External reference description -* **externalId**: string (WriteOnly): External reference ID -* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes -* **sourceName**: string (WriteOnly): External reference source name -* **url**: string (WriteOnly): External reference URL - -## ThreatIntelligenceExternalReferenceHashes -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ThreatIntelligenceGranularMarkingModel -### Properties -* **language**: string (WriteOnly): Language granular marking model -* **markingRef**: int (WriteOnly): marking reference granular marking model -* **selectors**: string[] (WriteOnly): granular marking model selectors - ## ThreatIntelligenceKillChainPhase ### Properties * **killChainName**: string (WriteOnly): Kill chainName name @@ -1172,6 +1127,64 @@ * **value**: string (WriteOnly): Value of parsed pattern * **valueType**: string (WriteOnly): Type of the value +## TIDataConnectorDataTypes +### Properties +* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. + +## TIDataConnectorDataTypesIndicators +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TIDataConnectorProperties +### Properties +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## TiTaxiiDataConnectorDataTypes +### Properties +* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. + +## TiTaxiiDataConnectorDataTypesTaxiiClient +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TiTaxiiDataConnectorProperties +### Properties +* **collectionId**: string: The collection id of the TAXII server. +* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. +* **friendlyName**: string: The friendly name for the TAXII server. +* **password**: string: The password for the TAXII server. +* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' | string (Required): The polling frequency for the TAXII server. +* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. +* **taxiiServer**: string: The API root for the TAXII server. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **userName**: string: The userName for the TAXII server. +* **workspaceId**: string: The workspace id. + +## UebaProperties +### Properties +* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs' | string[]: The relevant data sources that enriched by ueba + +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: any: Any object +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: any (Required): Any object +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + ## WatchlistProperties ### Properties * **contentType**: string: The content type of the raw content. Example : text/csv or text/tsv @@ -1186,7 +1199,7 @@ * **numberOfLinesToSkip**: int: The number of lines in a csv/tsv content to skip before the header * **provider**: string (Required): The provider of the watchlist * **rawContent**: string: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint -* **source**: 'Local file' | 'Remote storage' (Required): The source of the watchlist +* **source**: 'Local file' | 'Remote storage' | string (Required): The source of the watchlist * **tenantId**: string: The tenantId where the watchlist belongs to * **updated**: string: The last time the watchlist was updated * **updatedBy**: [UserInfo](#userinfo): User information that made some action @@ -1196,16 +1209,3 @@ * **watchlistItemsCount**: int: The number of Watchlist Items in the Watchlist * **watchlistType**: string: The type of the watchlist -## WatchlistItemProperties -### Properties -* **created**: string: The time the watchlist item was created -* **createdBy**: [UserInfo](#userinfo): User information that made some action -* **entityMapping**: any: Any object -* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not -* **itemsKeyValue**: any (Required): Any object -* **tenantId**: string: The tenantId to which the watchlist item belongs to -* **updated**: string: The last time the watchlist item was updated -* **updatedBy**: [UserInfo](#userinfo): User information that made some action -* **watchlistItemId**: string: The id (a Guid) of the watchlist item -* **watchlistItemType**: string: The type of the watchlist item - diff --git a/generated/securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json b/generated/securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json new file mode 100644 index 0000000000..7838b6a9b0 --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2021-10-01-preview/types.json @@ -0,0 +1 @@ +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2021-10-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":22,"MLBehaviorAnalytics":64,"MicrosoftSecurityIncidentCreation":92,"NRT":111,"Scheduled":195,"ThreatIntelligence":234}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":16,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":21,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[12,13,14,15,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[17,18,19,20,4]}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":23,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":63,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"sourceSettings":{"Type":35,"Flags":1,"Description":"Configuration for all supported source signals in fusion detection."},"scenarioExclusionPatterns":{"Type":37,"Flags":0,"Description":"Configuration to exclude scenarios in fusion detection."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":42,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":61,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":62,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"2":{"Name":"FusionSourceSettings","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this source signal is enabled or disabled in Fusion detection."},"sourceName":{"Type":4,"Flags":1,"Description":"Name of the Fusion source signal. Refer to Fusion alert rule template for supported values."},"sourceSubTypes":{"Type":34,"Flags":0,"Description":"Configuration for all source subtypes under this source signal consumed in fusion detection."}}}},{"2":{"Name":"FusionSourceSubTypeSetting","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this source subtype under source signal is enabled or disabled in Fusion detection."},"sourceSubTypeName":{"Type":4,"Flags":1,"Description":"The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values."},"sourceSubTypeDisplayName":{"Type":4,"Flags":2,"Description":"The display name of source subtype under a source signal consumed in Fusion detection."},"severityFilters":{"Type":26,"Flags":1,"Description":"Represents severity configuration for a source subtype consumed in Fusion detection."}}}},{"2":{"Name":"FusionSubTypeSeverityFilter","Properties":{"isSupported":{"Type":2,"Flags":2,"Description":"Determines whether this source subtype supports severity configuration or not."},"filters":{"Type":33,"Flags":0,"Description":"Individual Severity configuration settings for a given source subtype consumed in Fusion detection."}}}},{"2":{"Name":"FusionSubTypeSeverityFiltersItem","Properties":{"severity":{"Type":32,"Flags":1,"Description":"The severity of the alert"},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection."}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[28,29,30,31,4]}},{"3":{"ItemType":27}},{"3":{"ItemType":25}},{"3":{"ItemType":24}},{"2":{"Name":"FusionScenarioExclusionPattern","Properties":{"exclusionPattern":{"Type":4,"Flags":1,"Description":"Scenario exclusion pattern."},"dateAddedInUTC":{"Type":4,"Flags":1,"Description":"DateTime when scenario exclusion pattern is added in UTC."}}}},{"3":{"ItemType":36}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[38,39,40,41,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,4]}},{"3":{"ItemType":60}},{"3":{"ItemType":4}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":65,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":91,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":70,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":89,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":90,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[66,67,68,69,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,4]}},{"3":{"ItemType":88}},{"3":{"ItemType":4}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":93,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":110,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":94,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":95,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":103,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":109,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[96,97,98,99,100,101,102,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[104,105,106,107,4]}},{"3":{"ItemType":108}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"NrtAlertRule","Properties":{"properties":{"Type":112,"Flags":0,"Description":"Nrt alert rule base property bag."},"kind":{"Type":194,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"NrtAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"tactics":{"Type":131,"Flags":0,"Description":"The tactics of the alert rule"},"techniques":{"Type":132,"Flags":0,"Description":"The techniques of the alert rule"},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":137,"Flags":0,"Description":"The severity of the alert"},"incidentConfiguration":{"Type":138,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":169,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":192,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":193,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,4]}},{"3":{"ItemType":130}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[133,134,135,136,4]}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":139,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":143,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":163,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":167,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":168,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[140,141,142,4]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,4]}},{"3":{"ItemType":162}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[164,165,4]}},{"3":{"ItemType":166}},{"3":{"ItemType":4}},{"2":{"Name":"QueryBasedAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":189,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":191,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,4]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":190}},{"3":{"ItemType":170}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"NRT"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":196,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":233,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"triggerOperator":{"Type":201,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":202,"Flags":0,"Description":"Event grouping settings property bag."},"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"tactics":{"Type":224,"Flags":0,"Description":"The tactics of the alert rule"},"techniques":{"Type":225,"Flags":0,"Description":"The techniques of the alert rule"},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":230,"Flags":0,"Description":"The severity of the alert"},"incidentConfiguration":{"Type":138,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":231,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":232,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":193,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[197,198,199,200]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":205,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[203,204,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[206,207,208,209,210,211,212,213,214,215,216,217,218,219,220,221,222,4]}},{"3":{"ItemType":223}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[226,227,228,229,4]}},{"2":{"Name":"QueryBasedAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":170}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":235,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":261,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":240,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":259,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":260,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[236,237,238,239,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,4]}},{"3":{"ItemType":258}},{"3":{"ItemType":4}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2021-10-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":263,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":264,"Flags":10,"Description":"The resource api version"},"properties":{"Type":266,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2021-10-01-preview","ScopeType":16,"Body":265}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":268,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":269,"Flags":10,"Description":"The resource api version"},"properties":{"Type":271,"Flags":1,"Description":"Automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":272,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":383,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedBy":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"createdBy":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled"},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":274,"Flags":1},"triggersWhen":{"Type":276,"Flags":1},"conditions":{"Type":346,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"5":{"Elements":[273,4]}},{"6":{"Value":"Created"}},{"5":{"Elements":[275,4]}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":278}}},{"2":{"Name":"PropertyConditionProperties","Properties":{"conditionProperties":{"Type":279,"Flags":0},"conditionType":{"Type":345,"Flags":1}}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"propertyName":{"Type":334,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":343,"Flags":0},"propertyValues":{"Type":344,"Flags":0,"Description":"Array of AutomationRulePropertyValuesConditionPropertyValuesItem"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentLabel"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AlertProductNames"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[280,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,4]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[335,336,337,338,339,340,341,342,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":277}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1}},"Elements":{"ModifyProperties":348,"RunPlaybook":380}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":349,"Flags":0},"actionType":{"Type":379,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"IncidentPropertiesAction","Properties":{"severity":{"Type":354,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":358,"Flags":0,"Description":"The status of the incident"},"classification":{"Type":363,"Flags":0,"Description":"The reason the incident was closed"},"classificationReason":{"Type":368,"Flags":0,"Description":"The classification reason the incident was closed with"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"owner":{"Type":369,"Flags":0,"Description":"Information on the user an incident is assigned to"},"labels":{"Type":378,"Flags":0,"Description":"List of labels to add to the incident"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[350,351,352,353,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[355,356,357,4]}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[359,360,361,362,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[364,365,366,367,4]}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":373,"Flags":2,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[370,371,372,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":377,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"System"}},{"5":{"Elements":[375,376,4]}},{"3":{"ItemType":374}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":381,"Flags":0},"actionType":{"Type":382,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"PlaybookActionProperties","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":347}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2021-10-01-preview","ScopeType":16,"Body":270}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":386,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":387,"Flags":10,"Description":"The resource api version"},"properties":{"Type":389,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":390,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":416,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":421,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":422,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":369,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":423,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":428,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":432,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":433,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":391,"Flags":2,"Description":"List of product names of alerts in the incident"},"providerIncidentUrl":{"Type":4,"Flags":2,"Description":"The provider incident url to the incident in Microsoft 365 Defender portal"},"tactics":{"Type":410,"Flags":2,"Description":"The tactics associated with incident"},"techniques":{"Type":411,"Flags":2,"Description":"The techniques associated with incident's tactics'"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,4]}},{"3":{"ItemType":409}},{"3":{"ItemType":4}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[412,413,414,415,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[417,418,419,420,4]}},{"3":{"ItemType":374}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[424,425,426,427,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[429,430,431,4]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-10-01-preview","ScopeType":16,"Body":388}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":435,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":436,"Flags":10,"Description":"The resource api version"},"properties":{"Type":438,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":440,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":441,"Flags":0,"Description":"Describes related incident information for the bookmark"},"entityMappings":{"Type":450,"Flags":0,"Description":"Describes the entity mappings of the bookmark"},"tactics":{"Type":469,"Flags":0,"Description":"A list of relevant mitre attacks"},"techniques":{"Type":470,"Flags":0,"Description":"A list of relevant mitre techniques"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":446,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[442,443,444,445,4]}},{"2":{"Name":"BookmarkEntityMappings","Properties":{"entityType":{"Type":4,"Flags":0,"Description":"The entity type"},"fieldMappings":{"Type":449,"Flags":0,"Description":"Array of fields mapping for that entity type"}}}},{"2":{"Name":"EntityFieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"Alert V3 identifier"},"value":{"Type":4,"Flags":0,"Description":"The value of the identifier"}}}},{"3":{"ItemType":448}},{"3":{"ItemType":447}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,4]}},{"3":{"ItemType":468}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2021-10-01-preview","ScopeType":16,"Body":437}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":472,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":473,"Flags":10,"Description":"The resource api version"},"properties":{"Type":475,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2021-10-01-preview","ScopeType":16,"Body":474}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2021-10-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":477,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":478,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":480,"Expansion":510}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":481,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":509,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":482,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":504,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":506,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":508,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[483,484,485,486,487,488,489,490,491,492,493,494,495,496,497,498,499,500,501,502,503,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":505}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":507}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":511,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":559,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":512,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":534,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":535,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":558,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[536,537,538,539,540,541,542,543,544,545,546,547,548,549,550,551,552,553,554,555,556,4]}},{"3":{"ItemType":557}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2021-10-01-preview","ScopeType":16,"Body":479}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-10-01-preview","ScopeType":16,"Body":563}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":475,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-10-01-preview","ScopeType":16,"Body":568}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":573,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":588,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":589,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":595,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":596,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":601,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":621,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":624,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[574,575,576,577,578,579,580,581,582,583,584,585,586,587,4]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":594,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[590,591,592,593,4]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":600,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[597,598,599,4]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":616,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":619,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":620,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"5":{"Elements":[602,603,604,605,606,607,608,609,610,611,612,613,614,615,4]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[617,618,4]}},{"3":{"ItemType":601}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":622,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":623,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2021-10-01-preview","ScopeType":16,"Body":572}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":626,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":627,"Flags":10,"Description":"The resource api version"},"properties":{"Type":629,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2021-10-01-preview","ScopeType":16,"Body":628}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2021-10-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":631,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":632,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":634,"EntityAnalytics":637,"EyesOn":640,"Ueba":643}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":635,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":636,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":638,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":639,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":641,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":642,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":644,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":651,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":650,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[645,646,647,648,4]}},{"3":{"ItemType":649}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2021-10-01-preview","ScopeType":16,"Body":633}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":653,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":654,"Flags":10,"Description":"The resource api version"},"properties":{"Type":656,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":659,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":663,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":664,"Flags":1,"Description":"metadata of a repository."}}}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[657,658,4]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[660,661,4]}},{"3":{"ItemType":662}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":669,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":668,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[666,667,4]}},{"3":{"ItemType":665}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2021-10-01-preview","ScopeType":16,"Body":655}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"properties":{"Type":674,"Flags":4,"Description":"Describes threat intelligence entity properties"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":675,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":676,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":678,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":682,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":685,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":688,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":689,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":690,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":691,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":692,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":693,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":677}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":681,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":680}},{"3":{"ItemType":679}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":684,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":683}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":687,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":686}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-10-01-preview","ScopeType":16,"Body":673}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":695,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":696,"Flags":10,"Description":"The resource api version"},"properties":{"Type":698,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":701,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":702,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"watchlistItemsCount":{"Type":3,"Flags":0,"Description":"The number of Watchlist Items in the Watchlist"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[699,700,4]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-10-01-preview","ScopeType":16,"Body":697}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-10-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"},"properties":{"Type":707,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-10-01-preview","ScopeType":16,"Body":706}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2021-10-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":709,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":710,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"APIPolling":712,"AmazonWebServicesCloudTrail":760,"AmazonWebServicesS3":768,"AzureActiveDirectory":777,"AzureAdvancedThreatProtection":785,"AzureSecurityCenter":788,"Dynamics365":791,"GenericUI":799,"MicrosoftCloudAppSecurity":802,"MicrosoftDefenderAdvancedThreatProtection":806,"MicrosoftThreatIntelligence":809,"MicrosoftThreatProtection":821,"Office365":829,"Office365Project":845,"OfficeATP":853,"OfficeIRM":856,"OfficePowerBI":859,"ThreatIntelligence":867,"ThreatIntelligenceTaxii":875}}},{"2":{"Name":"CodelessApiPollingDataConnector","Properties":{"properties":{"Type":713,"Flags":0,"Description":"Represents Codeless API Polling data connector"},"kind":{"Type":759,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ApiPollingParameters","Properties":{"connectorUiConfig":{"Type":714,"Flags":0,"Description":"Config to describe the instructions blade"},"pollingConfig":{"Type":753,"Flags":0,"Description":"Config to describe the polling config for API poller connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":716,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":718,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":720,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":725,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":726,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":728,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":752,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":715}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":717}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":719}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":723,"Flags":0,"Description":"type of connectivity"},"value":{"Type":724,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"5":{"Elements":[722,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":721}},{"2":{"Name":"Availability","Properties":{"status":{"Type":727,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":742,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":744,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":736,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":740,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":741,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[730,731,732,733,734,735,4]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[737,738,739,4]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":729}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":743}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":751,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":750,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[747,748,749,4]}},{"3":{"ItemType":746}},{"3":{"ItemType":745}},{"2":{"Name":"CodelessConnectorPollingConfigProperties","Properties":{"isActive":{"Type":2,"Flags":0,"Description":"The poller active status"},"auth":{"Type":754,"Flags":1,"Description":"Describe the authentication properties needed to successfully authenticate with the server"},"request":{"Type":755,"Flags":1,"Description":"Describe the request properties needed to successfully pull from the server"},"paging":{"Type":756,"Flags":0,"Description":"Describe the properties needed to make a pagination call"},"response":{"Type":757,"Flags":0,"Description":"Describes the response from the external server"}}}},{"2":{"Name":"CodelessConnectorPollingAuthProperties","Properties":{"authType":{"Type":4,"Flags":1,"Description":"The authentication type"},"apiKeyName":{"Type":4,"Flags":0,"Description":"The header name which the token is sent with"},"apiKeyIdentifier":{"Type":4,"Flags":0,"Description":"A prefix send in the header before the actual token"},"isApiKeyInPostPayload":{"Type":4,"Flags":0,"Description":"Marks if the key should sent in header"},"flowName":{"Type":4,"Flags":0,"Description":"Describes the flow name, for example 'AuthCode' for Oauth 2.0"},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to issue a token, used in Oauth 2.0 flow"},"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to authorize the user, used in Oauth 2.0 flow"},"authorizationEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"redirectionEndpoint":{"Type":4,"Flags":0,"Description":"The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow"},"tokenEndpointHeaders":{"Type":0,"Flags":0,"Description":"Any object"},"tokenEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"isClientSecretInHeader":{"Type":2,"Flags":0,"Description":"Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow"},"scope":{"Type":4,"Flags":0,"Description":"The OAuth token scope"}}}},{"2":{"Name":"CodelessConnectorPollingRequestProperties","Properties":{"apiEndpoint":{"Type":4,"Flags":1,"Description":"Describe the endpoint we should pull the data from"},"rateLimitQps":{"Type":3,"Flags":0,"Description":"Defines the rate limit QPS"},"queryWindowInMin":{"Type":3,"Flags":1,"Description":"The window interval we will use the pull the data"},"httpMethod":{"Type":4,"Flags":1,"Description":"The http method type we will use in the poll request, GET or POST"},"queryTimeFormat":{"Type":4,"Flags":1,"Description":"The time format will be used the query events in a specific window"},"retryCount":{"Type":3,"Flags":0,"Description":"Describe the amount of time we should try and poll the data in case of failure"},"timeoutInSeconds":{"Type":3,"Flags":0,"Description":"The number of seconds we will consider as a request timeout"},"headers":{"Type":0,"Flags":0,"Description":"Any object"},"queryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"queryParametersTemplate":{"Type":4,"Flags":0,"Description":"For advanced scenarios for example user name/password embedded in nested JSON payload"},"startTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from a start of the time window"},"endTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from the end of the time window"}}}},{"2":{"Name":"CodelessConnectorPollingPagingProperties","Properties":{"pagingType":{"Type":4,"Flags":1,"Description":"Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'"},"nextPageParaName":{"Type":4,"Flags":0,"Description":"Defines the name of a next page attribute"},"nextPageTokenJsonPath":{"Type":4,"Flags":0,"Description":"Defines the path to a next page token JSON"},"pageCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page count attribute"},"pageTotalCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page total count attribute"},"pageTimeStampAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a paging time stamp attribute"},"searchTheLatestTimeStampFromEventsList":{"Type":4,"Flags":0,"Description":"Determines whether to search for the latest time stamp in the events list"},"pageSizeParaName":{"Type":4,"Flags":0,"Description":"Defines the name of the page size parameter"},"pageSize":{"Type":3,"Flags":0,"Description":"Defines the paging size"}}}},{"2":{"Name":"CodelessConnectorPollingResponseProperties","Properties":{"eventsJsonPaths":{"Type":758,"Flags":1,"Description":"Describes the path we should extract the data in the response"},"successStatusJsonPath":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status code in the response"},"successStatusValue":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status value in the response"},"isGzipCompressed":{"Type":2,"Flags":0,"Description":"Describes if the data in the response is Gzip"}}}},{"3":{"ItemType":4}},{"6":{"Value":"APIPolling"}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":761,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":767,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":762,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":763,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":766,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[764,765,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AwsS3DataConnector","Properties":{"properties":{"Type":769,"Flags":0,"Description":"Amazon Web Services S3 data connector properties."},"kind":{"Type":776,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsS3DataConnectorProperties","Properties":{"destinationTable":{"Type":4,"Flags":1,"Description":"The logs destination table name in LogAnalytics."},"sqsUrls":{"Type":770,"Flags":1,"Description":"The AWS sqs urls for the connector."},"roleArn":{"Type":4,"Flags":1,"Description":"The Aws Role Arn that is used to access the Aws account."},"dataTypes":{"Type":771,"Flags":1,"Description":"The available data types for Amazon Web Services S3 data connector."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AwsS3DataConnectorDataTypes","Properties":{"logs":{"Type":772,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsS3DataConnectorDataTypesLogs","Properties":{"state":{"Type":775,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[773,774,4]}},{"6":{"Value":"AmazonWebServicesS3"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":778,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":784,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":779,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":780,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":783,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[781,782,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":786,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":787,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":779,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":789,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":790,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":779,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":792,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":798,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":793,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":794,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":797,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[795,796,4]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":800,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":801,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":714,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":803,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":805,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":804,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":780,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":780,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":807,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":808,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":779,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":810,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":820,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":811,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":812,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":816,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":815,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[813,814,4]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":819,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[817,818,4]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":822,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":828,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":823,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":824,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":827,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[825,826,4]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":830,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":844,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":831,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":832,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":836,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":840,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":835,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[833,834,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":839,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[837,838,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":843,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[841,842,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"Office365ProjectDataConnector","Properties":{"properties":{"Type":846,"Flags":0,"Description":"Office Microsoft Project data connector properties."},"kind":{"Type":852,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Office365ProjectDataConnectorProperties","Properties":{"dataTypes":{"Type":847,"Flags":1,"Description":"The available data types for Office Microsoft Project data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Office365ProjectConnectorDataTypes","Properties":{"logs":{"Type":848,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"Office365ProjectConnectorDataTypesLogs","Properties":{"state":{"Type":851,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[849,850,4]}},{"6":{"Value":"Office365Project"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":854,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":855,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":779,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"OfficeIRMDataConnector","Properties":{"properties":{"Type":857,"Flags":0,"Description":"OfficeIRM (Microsoft Insider Risk Management) data connector properties."},"kind":{"Type":858,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeIRMDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":779,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeIRM"}},{"2":{"Name":"OfficePowerBIDataConnector","Properties":{"properties":{"Type":860,"Flags":0,"Description":"Office Microsoft PowerBI data connector properties."},"kind":{"Type":866,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficePowerBIDataConnectorProperties","Properties":{"dataTypes":{"Type":861,"Flags":1,"Description":"The available data types for Office Microsoft PowerBI data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficePowerBIConnectorDataTypes","Properties":{"logs":{"Type":862,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"OfficePowerBIConnectorDataTypesLogs","Properties":{"state":{"Type":865,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[863,864,4]}},{"6":{"Value":"OfficePowerBI"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":868,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":874,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":869,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":870,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":873,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[871,872,4]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":876,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":886,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":880,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":881,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[877,878,879,4]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":882,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":885,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[883,884,4]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2021-10-01-preview","ScopeType":16,"Body":711}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md b/generated/securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md new file mode 100644 index 0000000000..57c777ecbc --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2021-10-01-preview/types.md @@ -0,0 +1,1296 @@ +# Microsoft.SecurityInsights @ 2021-10-01-preview + +## Resource Microsoft.SecurityInsights/alertRules@2021-10-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules' (ReadOnly, DeployTimeConstant): The resource type +### FusionAlertRule +#### Properties +* **kind**: 'Fusion' (Required): The kind of the alert rule +* **properties**: [FusionAlertRuleProperties](#fusionalertruleproperties): Fusion alert rule base property bag. + +### MicrosoftSecurityIncidentCreationAlertRule +#### Properties +* **kind**: 'MicrosoftSecurityIncidentCreation' (Required): The kind of the alert rule +* **properties**: [MicrosoftSecurityIncidentCreationAlertRuleProperties](#microsoftsecurityincidentcreationalertruleproperties): MicrosoftSecurityIncidentCreation rule property bag. + +### MLBehaviorAnalyticsAlertRule +#### Properties +* **kind**: 'MLBehaviorAnalytics' (Required): The kind of the alert rule +* **properties**: [MLBehaviorAnalyticsAlertRuleProperties](#mlbehavioranalyticsalertruleproperties): MLBehaviorAnalytics alert rule base property bag. + +### NrtAlertRule +#### Properties +* **kind**: 'NRT' (Required): The kind of the alert rule +* **properties**: [NrtAlertRuleProperties](#nrtalertruleproperties): Nrt alert rule base property bag. + +### ScheduledAlertRule +#### Properties +* **kind**: 'Scheduled' (Required): The kind of the alert rule +* **properties**: [ScheduledAlertRuleProperties](#scheduledalertruleproperties): Scheduled alert rule base property bag. + +### ThreatIntelligenceAlertRule +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The kind of the alert rule +* **properties**: [ThreatIntelligenceAlertRuleProperties](#threatintelligencealertruleproperties): Threat Intelligence alert rule base property bag. + + +## Resource Microsoft.SecurityInsights/alertRules/actions@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ActionRequestProperties](#actionrequestproperties): Action property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules/actions' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/automationRules@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [AutomationRuleProperties](#automationruleproperties) (Required): Automation rule properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/automationRules' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [BookmarkProperties](#bookmarkproperties): Describes bookmark properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks/relations@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/dataConnectors@2021-10-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/dataConnectors' (ReadOnly, DeployTimeConstant): The resource type +### AwsCloudTrailDataConnector +#### Properties +* **kind**: 'AmazonWebServicesCloudTrail' (Required): The data connector kind +* **properties**: [AwsCloudTrailDataConnectorProperties](#awscloudtraildataconnectorproperties): Amazon Web Services CloudTrail data connector properties. + +### AwsS3DataConnector +#### Properties +* **kind**: 'AmazonWebServicesS3' (Required): The data connector kind +* **properties**: [AwsS3DataConnectorProperties](#awss3dataconnectorproperties): Amazon Web Services S3 data connector properties. + +### CodelessApiPollingDataConnector +#### Properties +* **kind**: 'APIPolling' (Required): The data connector kind +* **properties**: [ApiPollingParameters](#apipollingparameters): Represents Codeless API Polling data connector + +### AADDataConnector +#### Properties +* **kind**: 'AzureActiveDirectory' (Required): The data connector kind +* **properties**: [AADDataConnectorProperties](#aaddataconnectorproperties): AAD (Azure Active Directory) data connector properties. + +### AatpDataConnector +#### Properties +* **kind**: 'AzureAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [AatpDataConnectorProperties](#aatpdataconnectorproperties): AATP (Azure Advanced Threat Protection) data connector properties. + +### ASCDataConnector +#### Properties +* **kind**: 'AzureSecurityCenter' (Required): The data connector kind +* **properties**: [ASCDataConnectorProperties](#ascdataconnectorproperties): ASC (Azure Security Center) data connector properties. + +### Dynamics365DataConnector +#### Properties +* **kind**: 'Dynamics365' (Required): The data connector kind +* **properties**: [Dynamics365DataConnectorProperties](#dynamics365dataconnectorproperties): Dynamics365 data connector properties. + +### CodelessUiDataConnector +#### Properties +* **kind**: 'GenericUI' (Required): The data connector kind +* **properties**: [CodelessParameters](#codelessparameters): Represents Codeless UI data connector + +### McasDataConnector +#### Properties +* **kind**: 'MicrosoftCloudAppSecurity' (Required): The data connector kind +* **properties**: [McasDataConnectorProperties](#mcasdataconnectorproperties): MCAS (Microsoft Cloud App Security) data connector properties. + +### MdatpDataConnector +#### Properties +* **kind**: 'MicrosoftDefenderAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [MdatpDataConnectorProperties](#mdatpdataconnectorproperties): MDATP (Microsoft Defender Advanced Threat Protection) data connector properties. + +### MstiDataConnector +#### Properties +* **kind**: 'MicrosoftThreatIntelligence' (Required): The data connector kind +* **properties**: [MstiDataConnectorProperties](#mstidataconnectorproperties): Microsoft Threat Intelligence data connector properties. + +### MTPDataConnector +#### Properties +* **kind**: 'MicrosoftThreatProtection' (Required): The data connector kind +* **properties**: [MTPDataConnectorProperties](#mtpdataconnectorproperties): MTP (Microsoft Threat Protection) data connector properties. + +### OfficeDataConnector +#### Properties +* **kind**: 'Office365' (Required): The data connector kind +* **properties**: [OfficeDataConnectorProperties](#officedataconnectorproperties): Office data connector properties. + +### Office365ProjectDataConnector +#### Properties +* **kind**: 'Office365Project' (Required): The data connector kind +* **properties**: [Office365ProjectDataConnectorProperties](#office365projectdataconnectorproperties): Office Microsoft Project data connector properties. + +### OfficeATPDataConnector +#### Properties +* **kind**: 'OfficeATP' (Required): The data connector kind +* **properties**: [OfficeATPDataConnectorProperties](#officeatpdataconnectorproperties): OfficeATP (Office 365 Advanced Threat Protection) data connector properties. + +### OfficeIRMDataConnector +#### Properties +* **kind**: 'OfficeIRM' (Required): The data connector kind +* **properties**: [OfficeIRMDataConnectorProperties](#officeirmdataconnectorproperties): OfficeIRM (Microsoft Insider Risk Management) data connector properties. + +### OfficePowerBIDataConnector +#### Properties +* **kind**: 'OfficePowerBI' (Required): The data connector kind +* **properties**: [OfficePowerBIDataConnectorProperties](#officepowerbidataconnectorproperties): Office Microsoft PowerBI data connector properties. + +### TIDataConnector +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The data connector kind +* **properties**: [TIDataConnectorProperties](#tidataconnectorproperties): TI (Threat Intelligence) data connector properties. + +### TiTaxiiDataConnector +#### Properties +* **kind**: 'ThreatIntelligenceTaxii' (Required): The data connector kind +* **properties**: [TiTaxiiDataConnectorProperties](#titaxiidataconnectorproperties): Threat Intelligence TAXII data connector properties. + + +## Resource Microsoft.SecurityInsights/entityQueries@2021-10-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/entityQueries' (ReadOnly, DeployTimeConstant): The resource type +### ActivityCustomEntityQuery +#### Properties +* **kind**: 'Activity' (Required): the entity query kind +* **properties**: [ActivityEntityQueriesProperties](#activityentityqueriesproperties): Describes activity entity query properties + +### ExpansionEntityQuery +#### Properties +* **kind**: 'Expansion' (Required): the entity query kind +* **properties**: [ExpansionEntityQueriesProperties](#expansionentityqueriesproperties) (ReadOnly): Describes expansion entity query properties + + +## Resource Microsoft.SecurityInsights/incidents@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentProperties](#incidentproperties): Describes incident properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/comments@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentCommentProperties](#incidentcommentproperties): Incident comment property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/comments' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/relations@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/metadata@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [MetadataProperties](#metadataproperties): Metadata property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/metadata' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/onboardingStates@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SentinelOnboardingStateProperties](#sentinelonboardingstateproperties): The Sentinel onboarding state properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/onboardingStates' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/settings@2021-10-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/settings' (ReadOnly, DeployTimeConstant): The resource type +### Anomalies +#### Properties +* **kind**: 'Anomalies' (Required): The kind of the setting +* **properties**: [AnomaliesSettingsProperties](#anomaliessettingsproperties): Anomalies property bag. + +### EntityAnalytics +#### Properties +* **kind**: 'EntityAnalytics' (Required): The kind of the setting +* **properties**: [EntityAnalyticsProperties](#entityanalyticsproperties): EntityAnalytics property bag. + +### EyesOn +#### Properties +* **kind**: 'EyesOn' (Required): The kind of the setting +* **properties**: [EyesOnSettingsProperties](#eyesonsettingsproperties): EyesOn property bag. + +### Ueba +#### Properties +* **kind**: 'Ueba' (Required): The kind of the setting +* **properties**: [UebaProperties](#uebaproperties): Ueba property bag. + + +## Resource Microsoft.SecurityInsights/sourcecontrols@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SourceControlProperties](#sourcecontrolproperties): Describes source control properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/sourcecontrols' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/threatIntelligence/indicators@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/threatIntelligence/indicators' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistProperties](#watchlistproperties): Describes watchlist properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists/watchlistItems@2021-10-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistItemProperties](#watchlistitemproperties): Describes watchlist item properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type + +## AADDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## AatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## ActionRequestProperties +### Properties +* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. +* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. +* **workflowId**: string (ReadOnly): The name of the logic app's workflow. + +## ActivityEntityQueriesProperties +### Properties +* **content**: string: The entity query content to display in timeline +* **createdTimeUtc**: string (ReadOnly): The time the activity was created +* **description**: string: The entity query description +* **enabled**: bool: Determines whether this activity is enabled or disabled. +* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The type of the entity +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated +* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions +* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query +* **templateName**: string: The template id this activity was created from +* **title**: string: The entity query title + +## ActivityEntityQueriesPropertiesEntitiesFilter +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## ActivityEntityQueriesPropertiesQueryDefinitions +### Properties +* **query**: string: The Activity query to run on a given entity + +## AlertDetailsOverride +### Properties +* **alertDescriptionFormat**: string: the format containing columns name(s) to override the alert description +* **alertDisplayNameFormat**: string: the format containing columns name(s) to override the alert name +* **alertSeverityColumnName**: string: the column name to take the alert severity from +* **alertTacticsColumnName**: string: the column name to take the alert tactics from + +## AlertsDataTypeOfDataConnector +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. + +## AnomaliesSettingsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## ApiPollingParameters +### Properties +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade +* **pollingConfig**: [CodelessConnectorPollingConfigProperties](#codelessconnectorpollingconfigproperties): Config to describe the polling config for API poller connector + +## ASCDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## AutomationRuleAction +* **Discriminator**: actionType + +### Base Properties +* **order**: int (Required) +### AutomationRuleModifyPropertiesAction +#### Properties +* **actionConfiguration**: [IncidentPropertiesAction](#incidentpropertiesaction) +* **actionType**: 'ModifyProperties' (Required): The type of the automation rule action + +### AutomationRuleRunPlaybookAction +#### Properties +* **actionConfiguration**: [PlaybookActionProperties](#playbookactionproperties) +* **actionType**: 'RunPlaybook' (Required): The type of the automation rule action + + +## AutomationRuleCondition +* **Discriminator**: conditionType + +### Base Properties +### PropertyConditionProperties +#### Properties +* **conditionProperties**: [AutomationRulePropertyValuesCondition](#automationrulepropertyvaluescondition) +* **conditionType**: 'Property' (Required) + + +## AutomationRuleProperties +### Properties +* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered +* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created +* **displayName**: string (Required): The display name of the automation rule +* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated +* **order**: int (Required): The order of execution of the automation rule +* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic + +## AutomationRulePropertyValuesCondition +### Properties +* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith' | string +* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AlertProductNames' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentLabel' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url' | string: The property to evaluate in an automation rule property condition +* **propertyValues**: string[]: Array of AutomationRulePropertyValuesConditionPropertyValuesItem + +## AutomationRuleTriggeringLogic +### Properties +* **conditions**: [AutomationRuleCondition](#automationrulecondition)[]: The conditions to evaluate to determine if the automation rule should be triggered on a given object +* **expirationTimeUtc**: string: Determines when the automation rule should automatically expire and be disabled. +* **isEnabled**: bool (Required): Determines whether the automation rule is enabled or disabled +* **triggersOn**: 'Incidents' | string (Required) +* **triggersWhen**: 'Created' | string (Required) + +## Availability +### Properties +* **isPreview**: bool: Set connector as preview +* **status**: '1': The connector Availability Status + +## AwsCloudTrailDataConnectorDataTypes +### Properties +* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs) (Required): Logs data type. + +## AwsCloudTrailDataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsCloudTrailDataConnectorProperties +### Properties +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. + +## AwsS3DataConnectorDataTypes +### Properties +* **logs**: [AwsS3DataConnectorDataTypesLogs](#awss3dataconnectordatatypeslogs) (Required): Logs data type. + +## AwsS3DataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsS3DataConnectorProperties +### Properties +* **dataTypes**: [AwsS3DataConnectorDataTypes](#awss3dataconnectordatatypes) (Required): The available data types for Amazon Web Services S3 data connector. +* **destinationTable**: string (Required): The logs destination table name in LogAnalytics. +* **roleArn**: string (Required): The Aws Role Arn that is used to access the Aws account. +* **sqsUrls**: string[] (Required): The AWS sqs urls for the connector. + +## BookmarkEntityMappings +### Properties +* **entityType**: string: The entity type +* **fieldMappings**: [EntityFieldMapping](#entityfieldmapping)[]: Array of fields mapping for that entity type + +## BookmarkProperties +### Properties +* **created**: string: The time the bookmark was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **displayName**: string (Required): The display name of the bookmark +* **entityMappings**: [BookmarkEntityMappings](#bookmarkentitymappings)[]: Describes the entity mappings of the bookmark +* **eventTime**: string: The bookmark event time +* **incidentInfo**: [IncidentInfo](#incidentinfo): Describes related incident information for the bookmark +* **labels**: string[]: List of labels relevant to this bookmark +* **notes**: string: The notes of the bookmark +* **query**: string (Required): The query of the bookmark. +* **queryEndTime**: string: The end time for the query +* **queryResult**: string: The query result of the bookmark. +* **queryStartTime**: string: The start time for the query +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: A list of relevant mitre attacks +* **techniques**: string[]: A list of relevant mitre techniques +* **updated**: string: The last time the bookmark was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action + +## ClientInfo +### Properties +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. + +## CodelessConnectorPollingAuthProperties +### Properties +* **apiKeyIdentifier**: string: A prefix send in the header before the actual token +* **apiKeyName**: string: The header name which the token is sent with +* **authorizationEndpoint**: string: The endpoint used to authorize the user, used in Oauth 2.0 flow +* **authorizationEndpointQueryParameters**: any: Any object +* **authType**: string (Required): The authentication type +* **flowName**: string: Describes the flow name, for example 'AuthCode' for Oauth 2.0 +* **isApiKeyInPostPayload**: string: Marks if the key should sent in header +* **isClientSecretInHeader**: bool: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow +* **redirectionEndpoint**: string: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow +* **scope**: string: The OAuth token scope +* **tokenEndpoint**: string: The endpoint used to issue a token, used in Oauth 2.0 flow +* **tokenEndpointHeaders**: any: Any object +* **tokenEndpointQueryParameters**: any: Any object + +## CodelessConnectorPollingConfigProperties +### Properties +* **auth**: [CodelessConnectorPollingAuthProperties](#codelessconnectorpollingauthproperties) (Required): Describe the authentication properties needed to successfully authenticate with the server +* **isActive**: bool: The poller active status +* **paging**: [CodelessConnectorPollingPagingProperties](#codelessconnectorpollingpagingproperties): Describe the properties needed to make a pagination call +* **request**: [CodelessConnectorPollingRequestProperties](#codelessconnectorpollingrequestproperties) (Required): Describe the request properties needed to successfully pull from the server +* **response**: [CodelessConnectorPollingResponseProperties](#codelessconnectorpollingresponseproperties): Describes the response from the external server + +## CodelessConnectorPollingPagingProperties +### Properties +* **nextPageParaName**: string: Defines the name of a next page attribute +* **nextPageTokenJsonPath**: string: Defines the path to a next page token JSON +* **pageCountAttributePath**: string: Defines the path to a page count attribute +* **pageSize**: int: Defines the paging size +* **pageSizeParaName**: string: Defines the name of the page size parameter +* **pageTimeStampAttributePath**: string: Defines the path to a paging time stamp attribute +* **pageTotalCountAttributePath**: string: Defines the path to a page total count attribute +* **pagingType**: string (Required): Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp' +* **searchTheLatestTimeStampFromEventsList**: string: Determines whether to search for the latest time stamp in the events list + +## CodelessConnectorPollingRequestProperties +### Properties +* **apiEndpoint**: string (Required): Describe the endpoint we should pull the data from +* **endTimeAttributeName**: string: This will be used the query events from the end of the time window +* **headers**: any: Any object +* **httpMethod**: string (Required): The http method type we will use in the poll request, GET or POST +* **queryParameters**: any: Any object +* **queryParametersTemplate**: string: For advanced scenarios for example user name/password embedded in nested JSON payload +* **queryTimeFormat**: string (Required): The time format will be used the query events in a specific window +* **queryWindowInMin**: int (Required): The window interval we will use the pull the data +* **rateLimitQps**: int: Defines the rate limit QPS +* **retryCount**: int: Describe the amount of time we should try and poll the data in case of failure +* **startTimeAttributeName**: string: This will be used the query events from a start of the time window +* **timeoutInSeconds**: int: The number of seconds we will consider as a request timeout + +## CodelessConnectorPollingResponseProperties +### Properties +* **eventsJsonPaths**: string[] (Required): Describes the path we should extract the data in the response +* **isGzipCompressed**: bool: Describes if the data in the response is Gzip +* **successStatusJsonPath**: string: Describes the path we should extract the status code in the response +* **successStatusValue**: string: Describes the path we should extract the status value in the response + +## CodelessParameters +### Properties +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade + +## CodelessUiConnectorConfigProperties +### Properties +* **availability**: [Availability](#availability) (Required): Connector Availability Status +* **connectivityCriteria**: [CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem](#codelessuiconnectorconfigpropertiesconnectivitycriteriaitem)[] (Required): Define the way the connector check connectivity +* **customImage**: string: An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery +* **dataTypes**: [CodelessUiConnectorConfigPropertiesDataTypesItem](#codelessuiconnectorconfigpropertiesdatatypesitem)[] (Required): Data types to check for last data received +* **descriptionMarkdown**: string (Required): Connector description +* **graphQueries**: [CodelessUiConnectorConfigPropertiesGraphQueriesItem](#codelessuiconnectorconfigpropertiesgraphqueriesitem)[] (Required): The graph query to show the current data status +* **graphQueriesTableName**: string (Required): Name of the table the connector will insert the data to +* **instructionSteps**: [CodelessUiConnectorConfigPropertiesInstructionStepsItem](#codelessuiconnectorconfigpropertiesinstructionstepsitem)[] (Required): Instruction steps to enable the connector +* **permissions**: [Permissions](#permissions) (Required): Permissions required for the connector +* **publisher**: string (Required): Connector publisher name +* **sampleQueries**: [CodelessUiConnectorConfigPropertiesSampleQueriesItem](#codelessuiconnectorconfigpropertiessamplequeriesitem)[] (Required): The sample queries for the connector +* **title**: string (Required): Connector blade title + +## CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem +### Properties +* **type**: 'IsConnectedQuery' | string: type of connectivity +* **value**: string[]: Queries for checking connectivity + +## CodelessUiConnectorConfigPropertiesDataTypesItem +### Properties +* **lastDataReceivedQuery**: string: Query for indicate last data received +* **name**: string: Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder + +## CodelessUiConnectorConfigPropertiesGraphQueriesItem +### Properties +* **baseQuery**: string: The base query for the graph +* **legend**: string: The legend for the graph +* **metricName**: string: the metric that the query is checking + +## CodelessUiConnectorConfigPropertiesInstructionStepsItem +### Properties +* **description**: string: Instruction step description +* **instructions**: [InstructionStepsInstructionsItem](#instructionstepsinstructionsitem)[]: Instruction step details +* **title**: string: Instruction step title + +## CodelessUiConnectorConfigPropertiesSampleQueriesItem +### Properties +* **description**: string: The sample query description +* **query**: string: the sample query + +## ContentPathMap +### Properties +* **contentType**: 'AnalyticRule' | 'Workbook' | string: The content type of a source control path. +* **path**: string: The path to the content. + +## DataConnectorDataTypeCommon +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Dynamics365DataConnectorDataTypes +### Properties +* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. + +## Dynamics365DataConnectorDataTypesDynamics365CdsActivities +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Dynamics365DataConnectorProperties +### Properties +* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## EntityAnalyticsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## EntityCommonPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## EntityFieldMapping +### Properties +* **identifier**: string: Alert V3 identifier +* **value**: string: The value of the identifier + +## EntityMapping +### Properties +* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The V3 type of the mapped entity +* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping + +## EventGroupingSettings +### Properties +* **aggregationKind**: 'AlertPerResult' | 'SingleAlert' | string: The event grouping aggregation kinds + +## ExpansionEntityQueriesProperties +### Properties +* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query +* **displayName**: string (ReadOnly): The query display name +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string (ReadOnly): The type of the entity +* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query +* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[] (ReadOnly): List of the desired output types to be constructed from the result +* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted + +## EyesOnSettingsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## FieldMapping +### Properties +* **columnName**: string: the column name to be mapped to the identifier +* **identifier**: string: the V3 identifier of the entity + +## FusionAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **scenarioExclusionPatterns**: [FusionScenarioExclusionPattern](#fusionscenarioexclusionpattern)[]: Configuration to exclude scenarios in fusion detection. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **sourceSettings**: [FusionSourceSettings](#fusionsourcesettings)[] (Required): Configuration for all supported source signals in fusion detection. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## FusionScenarioExclusionPattern +### Properties +* **dateAddedInUTC**: string (Required): DateTime when scenario exclusion pattern is added in UTC. +* **exclusionPattern**: string (Required): Scenario exclusion pattern. + +## FusionSourceSettings +### Properties +* **enabled**: bool (Required): Determines whether this source signal is enabled or disabled in Fusion detection. +* **sourceName**: string (Required): Name of the Fusion source signal. Refer to Fusion alert rule template for supported values. +* **sourceSubTypes**: [FusionSourceSubTypeSetting](#fusionsourcesubtypesetting)[]: Configuration for all source subtypes under this source signal consumed in fusion detection. + +## FusionSourceSubTypeSetting +### Properties +* **enabled**: bool (Required): Determines whether this source subtype under source signal is enabled or disabled in Fusion detection. +* **severityFilters**: [FusionSubTypeSeverityFilter](#fusionsubtypeseverityfilter) (Required): Represents severity configuration for a source subtype consumed in Fusion detection. +* **sourceSubTypeDisplayName**: string (ReadOnly): The display name of source subtype under a source signal consumed in Fusion detection. +* **sourceSubTypeName**: string (Required): The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values. + +## FusionSubTypeSeverityFilter +### Properties +* **filters**: [FusionSubTypeSeverityFiltersItem](#fusionsubtypeseverityfiltersitem)[]: Individual Severity configuration settings for a given source subtype consumed in Fusion detection. +* **isSupported**: bool (ReadOnly): Determines whether this source subtype supports severity configuration or not. + +## FusionSubTypeSeverityFiltersItem +### Properties +* **enabled**: bool (Required): Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the alert + +## GroupingConfiguration +### Properties +* **enabled**: bool (Required): Grouping enabled +* **groupByAlertDetails**: 'DisplayName' | 'Severity' | string[]: A list of alert details to group by (when matchingMethod is Selected) +* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. +* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. +* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) +* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' | string (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. +* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents + +## IncidentAdditionalData +### Properties +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **providerIncidentUrl**: string (ReadOnly): The provider incident url to the incident in Microsoft 365 Defender portal +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics associated with incident +* **techniques**: string[] (ReadOnly): The techniques associated with incident's tactics' + +## IncidentCommentProperties +### Properties +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message + +## IncidentConfiguration +### Properties +* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule +* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. + +## IncidentInfo +### Properties +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident + +## IncidentLabel +### Properties +* **labelName**: string (Required): The name of the label +* **labelType**: 'System' | 'User' | string (ReadOnly): The type of the label + +## IncidentOwnerInfo +### Properties +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **ownerType**: 'Group' | 'Unknown' | 'User' | string (ReadOnly): The type of the owner the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. + +## IncidentProperties +### Properties +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **providerIncidentId**: string: The incident ID assigned by the incident provider +* **providerName**: string: The name of the source provider that generated the incident +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **teamInformation**: [TeamInformation](#teaminformation): Describes team information +* **title**: string (Required): The title of the incident + +## IncidentPropertiesAction +### Properties +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels to add to the incident +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string: The status of the incident + +## InstructionStepsInstructionsItem +### Properties +* **parameters**: any: Any object +* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' | string (Required): The kind of the setting + +## McasDataConnectorDataTypes +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. +* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. + +## McasDataConnectorProperties +### Properties +* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MdatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MetadataAuthor +### Properties +* **email**: string: Email of author contact +* **link**: string: Link for author/vendor page +* **name**: string: Name of the author. Company or person. + +## MetadataCategories +### Properties +* **domains**: string[]: domain for the solution content item +* **verticals**: string[]: Industry verticals for the solution content item + +## MetadataDependencies +### Properties +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string: The kind of content the metadata is for. +* **name**: string: Name of the content item +* **operator**: 'AND' | 'OR' | string: Operator used for list of dependencies in criteria array. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks + +## MetadataProperties +### Properties +* **author**: [MetadataAuthor](#metadataauthor): Publisher or creator of the content item. +* **categories**: [MetadataCategories](#metadatacategories): ies for the solution content item +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **dependencies**: [MetadataDependencies](#metadatadependencies): Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. +* **firstPublishDate**: string: first publish date of solution content item +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string (Required): The kind of content the metadata is for. +* **lastPublishDate**: string: last publish date of solution content item +* **parentId**: string (Required): Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group) +* **providers**: string[]: Providers for the solution content item +* **source**: [MetadataSource](#metadatasource): The original source of the content item, where it comes from. +* **support**: [MetadataSupport](#metadatasupport): Support information for the content item. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks + +## MetadataSource +### Properties +* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' | string (Required): Source type of the content +* **name**: string: Name of the content source. The repo name, solution name, LA workspace name etc. +* **sourceId**: string: ID of the content source. The solution ID, workspace ID, etc + +## MetadataSupport +### Properties +* **email**: string: Email of support contact +* **link**: string: Link for support help, like to support page to open a ticket etc. +* **name**: string: Name of the support contact. Company or person. +* **tier**: 'Community' | 'Microsoft' | 'Partner' | string (Required): Type of support for content item + +## MicrosoftSecurityIncidentCreationAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated + +## MLBehaviorAnalyticsAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## MstiDataConnectorDataTypes +### Properties +* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. +* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. + +## MstiDataConnectorDataTypesBingSafetyPhishingURL +### Properties +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed +### Properties +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MstiDataConnectorProperties +### Properties +* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MTPDataConnectorDataTypes +### Properties +* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. + +## MTPDataConnectorDataTypesIncidents +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MTPDataConnectorProperties +### Properties +* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## NrtAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [QueryBasedAlertRulePropertiesCustomDetails](#querybasedalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: The tactics of the alert rule +* **techniques**: string[]: The techniques of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> + +## Office365ProjectConnectorDataTypes +### Properties +* **logs**: [Office365ProjectConnectorDataTypesLogs](#office365projectconnectordatatypeslogs) (Required): Logs data type. + +## Office365ProjectConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Office365ProjectDataConnectorProperties +### Properties +* **dataTypes**: [Office365ProjectConnectorDataTypes](#office365projectconnectordatatypes) (Required): The available data types for Office Microsoft Project data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeATPDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeDataConnectorDataTypes +### Properties +* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. +* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. +* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. + +## OfficeDataConnectorDataTypesExchange +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesSharePoint +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesTeams +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorProperties +### Properties +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeIRMDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficePowerBIConnectorDataTypes +### Properties +* **logs**: [OfficePowerBIConnectorDataTypesLogs](#officepowerbiconnectordatatypeslogs) (Required): Logs data type. + +## OfficePowerBIConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficePowerBIDataConnectorProperties +### Properties +* **dataTypes**: [OfficePowerBIConnectorDataTypes](#officepowerbiconnectordatatypes) (Required): The available data types for Office Microsoft PowerBI data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## Permissions +### Properties +* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector +* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector + +## PermissionsCustomsItem +### Properties +* **description**: string: Customs permissions description +* **name**: string: Customs permissions name + +## PermissionsResourceProviderItem +### Properties +* **permissionsDisplayText**: string: Permission description text +* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings' | string: Provider name +* **providerDisplayName**: string: Permission provider display name +* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector +* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace' | string: Permission provider scope + +## PlaybookActionProperties +### Properties +* **logicAppResourceId**: string: The resource id of the playbook resource +* **tenantId**: string: The tenant id of the playbook resource + +## QueryBasedAlertRulePropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## QueryBasedAlertRulePropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource + +## Repository +### Properties +* **branch**: string: Branch name of repository. +* **deploymentLogsUrl**: string: Url to access repository action logs. +* **displayUrl**: string: Display url of repository. +* **pathMapping**: [ContentPathMap](#contentpathmap)[]: Dictionary of source control content type and path mapping. +* **url**: string: Url of repository. + +## RequiredPermissions +### Properties +* **action**: bool: action permission +* **delete**: bool: delete permission +* **read**: bool: read permission +* **write**: bool: write permission + +## ScheduledAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [QueryBasedAlertRulePropertiesCustomDetails](#querybasedalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: The tactics of the alert rule +* **techniques**: string[]: The techniques of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. + +## SentinelOnboardingStateProperties +### Properties +* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting + +## SourceControlProperties +### Properties +* **contentTypes**: 'AnalyticRule' | 'Workbook' | string[] (Required): Array of source control content types. +* **description**: string: A description of the source control +* **displayName**: string (Required): The display name of the source control +* **id**: string: The id (a Guid) of the source control +* **repository**: [Repository](#repository) (Required): metadata of a repository. +* **repoType**: 'DevOps' | 'Github' | string (Required): The type of repository. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TeamInformation +### Properties +* **description**: string (ReadOnly): The description of the team +* **name**: string (ReadOnly): The name of the team +* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team +* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created +* **teamId**: string (ReadOnly): Team ID + +## ThreatIntelligenceAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## ThreatIntelligenceExternalReference +### Properties +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL + +## ThreatIntelligenceExternalReferenceHashes +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThreatIntelligenceGranularMarkingModel +### Properties +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors + +## ThreatIntelligenceIndicatorProperties +### Properties +* **additionalData**: [EntityCommonPropertiesAdditionalData](#entitycommonpropertiesadditionaldata) (ReadOnly, WriteOnly): A bag of custom fields that should be part of the entity and will be presented to the user. +* **confidence**: int (WriteOnly): Confidence of threat intelligence entity +* **created**: string (WriteOnly): Created by +* **createdByRef**: string (WriteOnly): Created by reference of threat intelligence entity +* **defanged**: bool (WriteOnly): Is threat intelligence entity defanged +* **description**: string (WriteOnly): Description of a threat intelligence entity +* **displayName**: string (WriteOnly): Display name of a threat intelligence entity +* **extensions**: [ThreatIntelligenceIndicatorPropertiesExtensions](#threatintelligenceindicatorpropertiesextensions) (WriteOnly): Extensions map +* **externalId**: string (WriteOnly): External ID of threat intelligence entity +* **externalLastUpdatedTimeUtc**: string (WriteOnly): External last updated time in UTC +* **externalReferences**: [ThreatIntelligenceExternalReference](#threatintelligenceexternalreference)[] (WriteOnly): External References +* **friendlyName**: string (ReadOnly, WriteOnly): The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. +* **granularMarkings**: [ThreatIntelligenceGranularMarkingModel](#threatintelligencegranularmarkingmodel)[] (WriteOnly): Granular Markings +* **indicatorTypes**: string[] (WriteOnly): Indicator types of threat intelligence entities +* **killChainPhases**: [ThreatIntelligenceKillChainPhase](#threatintelligencekillchainphase)[] (WriteOnly): Kill chain phases +* **labels**: string[] (WriteOnly): Labels of threat intelligence entity +* **language**: string (WriteOnly): Language of threat intelligence entity +* **lastUpdatedTimeUtc**: string (WriteOnly): Last updated time in UTC +* **modified**: string (WriteOnly): Modified by +* **objectMarkingRefs**: string[] (WriteOnly): Threat intelligence entity object marking references +* **parsedPattern**: [ThreatIntelligenceParsedPattern](#threatintelligenceparsedpattern)[] (WriteOnly): Parsed patterns +* **pattern**: string (WriteOnly): Pattern of a threat intelligence entity +* **patternType**: string (WriteOnly): Pattern type of a threat intelligence entity +* **patternVersion**: string (WriteOnly): Pattern version of a threat intelligence entity +* **revoked**: bool (WriteOnly): Is threat intelligence entity revoked +* **source**: string (WriteOnly): Source of a threat intelligence entity +* **threatIntelligenceTags**: string[] (WriteOnly): List of tags +* **threatTypes**: string[] (WriteOnly): Threat types +* **validFrom**: string (WriteOnly): Valid from +* **validUntil**: string (WriteOnly): Valid until + +## ThreatIntelligenceIndicatorPropertiesExtensions +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## ThreatIntelligenceKillChainPhase +### Properties +* **killChainName**: string (WriteOnly): Kill chainName name +* **phaseName**: string (WriteOnly): Phase name + +## ThreatIntelligenceParsedPattern +### Properties +* **patternTypeKey**: string (WriteOnly): Pattern type key +* **patternTypeValues**: [ThreatIntelligenceParsedPatternTypeValue](#threatintelligenceparsedpatterntypevalue)[] (WriteOnly): Pattern type keys + +## ThreatIntelligenceParsedPatternTypeValue +### Properties +* **value**: string (WriteOnly): Value of parsed pattern +* **valueType**: string (WriteOnly): Type of the value + +## TIDataConnectorDataTypes +### Properties +* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. + +## TIDataConnectorDataTypesIndicators +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TIDataConnectorProperties +### Properties +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## TiTaxiiDataConnectorDataTypes +### Properties +* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. + +## TiTaxiiDataConnectorDataTypesTaxiiClient +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TiTaxiiDataConnectorProperties +### Properties +* **collectionId**: string: The collection id of the TAXII server. +* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. +* **friendlyName**: string: The friendly name for the TAXII server. +* **password**: string: The password for the TAXII server. +* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' | string (Required): The polling frequency for the TAXII server. +* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. +* **taxiiServer**: string: The API root for the TAXII server. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **userName**: string: The userName for the TAXII server. +* **workspaceId**: string: The workspace id. + +## UebaProperties +### Properties +* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs' | string[]: The relevant data sources that enriched by ueba + +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: any: Any object +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: any (Required): Any object +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + +## WatchlistProperties +### Properties +* **contentType**: string: The content type of the raw content. Example : text/csv or text/tsv +* **created**: string: The time the watchlist was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **defaultDuration**: string: The default duration of a watchlist (in ISO 8601 duration format) +* **description**: string: A description of the watchlist +* **displayName**: string (Required): The display name of the watchlist +* **isDeleted**: bool: A flag that indicates if the watchlist is deleted or not +* **itemsSearchKey**: string (Required): The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address. +* **labels**: string[]: List of labels relevant to this watchlist +* **numberOfLinesToSkip**: int: The number of lines in a csv/tsv content to skip before the header +* **provider**: string (Required): The provider of the watchlist +* **rawContent**: string: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint +* **source**: 'Local file' | 'Remote storage' | string (Required): The source of the watchlist +* **tenantId**: string: The tenantId where the watchlist belongs to +* **updated**: string: The last time the watchlist was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **uploadStatus**: string: The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted +* **watchlistAlias**: string: The alias of the watchlist +* **watchlistId**: string: The id (a Guid) of the watchlist +* **watchlistItemsCount**: int: The number of Watchlist Items in the Watchlist +* **watchlistType**: string: The type of the watchlist + diff --git a/generated/securityinsights/microsoft.securityinsights/2021-10-01/types.json b/generated/securityinsights/microsoft.securityinsights/2021-10-01/types.json new file mode 100644 index 0000000000..256c94292a --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2021-10-01/types.json @@ -0,0 +1 @@ +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":12,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":33,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":38,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":43,"Flags":0,"Description":"List of labels relevant to this incident"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":44,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":45,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":50,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":54,"Flags":1,"Description":"The status of the incident"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":13,"Flags":2,"Description":"List of product names of alerts in the incident"},"tactics":{"Type":28,"Flags":2,"Description":"The tactics associated with incident"}}}},{"3":{"ItemType":4}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,4]}},{"3":{"ItemType":27}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[29,30,31,32,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[34,35,36,37,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":42,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"AutoAssigned"}},{"5":{"Elements":[40,41,4]}},{"3":{"ItemType":39}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."}}}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[46,47,48,49,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[51,52,53,4]}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":60,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":65,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[56,57,58,59,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[61,62,63,64,4]}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2021-10-01","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":67,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":68,"Flags":10,"Description":"The resource api version"},"properties":{"Type":70,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":71,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2021-10-01","ScopeType":16,"Body":69}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":73,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":74,"Flags":10,"Description":"The resource api version"},"properties":{"Type":76,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2021-10-01","ScopeType":16,"Body":75}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":78,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":79,"Flags":10,"Description":"The resource api version"},"properties":{"Type":81,"Flags":4,"Description":"Describes threat intelligence entity properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":82,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":83,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":85,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":89,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":92,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":95,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":96,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":97,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":98,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":99,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":100,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":84}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":88,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":87}},{"3":{"ItemType":86}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":91,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":90}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":94,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":93}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2021-10-01","ScopeType":16,"Body":80}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":102,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":103,"Flags":10,"Description":"The resource api version"},"properties":{"Type":105,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":108,"Flags":1,"Description":"The source of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":109,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":109,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":110,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. Example : This line will be skipped\nheader1,header2\nvalue1,value2"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. For now, only text/csv is valid"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. **Note** : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[106,107,4]}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2021-10-01","ScopeType":16,"Body":104}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":112,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":113,"Flags":10,"Description":"The resource api version"},"properties":{"Type":115,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":109,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":109,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":0,"Flags":1,"Description":"Any object"},"entityMapping":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2021-10-01","ScopeType":16,"Body":114}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":117,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":118,"Flags":10,"Description":"The resource api version"},"properties":{"Type":120,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2021-10-01","ScopeType":16,"Body":119}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2021-10-01"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":122,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":123,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":125,"MicrosoftSecurityIncidentCreation":148,"Scheduled":165}}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":126,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":147,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":131,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":146,"Flags":2,"Description":"The tactics of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[127,128,129,130,4]}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[132,133,134,135,136,137,138,139,140,141,142,143,144,4]}},{"3":{"ItemType":145}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":149,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":164,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":150,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":151,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":157,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":163,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"5":{"Elements":[152,153,154,155,156,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[158,159,160,161,4]}},{"3":{"ItemType":162}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":166,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":252,"Flags":1,"Description":"The alert rule kind"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":181,"Flags":0,"Description":"The tactics of the alert rule"},"incidentConfiguration":{"Type":182,"Flags":0,"Description":"Incident Configuration property bag."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":217,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":222,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":223,"Flags":0,"Description":"Event grouping settings property bag."},"customDetails":{"Type":227,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":250,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":251,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"5":{"Elements":[167,168,169,170,171,172,173,174,175,176,177,178,179,4]}},{"3":{"ItemType":180}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":183,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":187,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":207,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":211,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":212,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[184,185,186,4]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,4]}},{"3":{"ItemType":206}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[208,209,4]}},{"3":{"ItemType":210}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[213,214,215,216,4]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[218,219,220,221]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":226,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[224,225,4]}},{"2":{"Name":"ScheduledAlertRuleCommonPropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":247,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":249,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[229,230,231,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246,4]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":248}},{"3":{"ItemType":228}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"Scheduled"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2021-10-01","ScopeType":16,"Body":124}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":254,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":255,"Flags":10,"Description":"The resource api version"},"properties":{"Type":257,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2021-10-01","ScopeType":16,"Body":256}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":259,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":260,"Flags":10,"Description":"The resource api version"},"properties":{"Type":262,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":109,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":263,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":109,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":264,"Flags":0,"Description":"Describes related incident information for the bookmark"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":269,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[265,266,267,268,4]}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2021-10-01","ScopeType":16,"Body":261}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2021-10-01"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":271,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":272,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"AmazonWebServicesCloudTrail":274,"AzureActiveDirectory":282,"AzureAdvancedThreatProtection":290,"AzureSecurityCenter":293,"MicrosoftCloudAppSecurity":296,"MicrosoftDefenderAdvancedThreatProtection":300,"Office365":303,"ThreatIntelligence":319}}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":275,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":281,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":276,"Flags":0,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":277,"Flags":0,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":280,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[278,279,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":283,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":289,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":284,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":285,"Flags":0,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":288,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[286,287,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":291,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":292,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":284,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":294,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":295,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":284,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":297,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":299,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":298,"Flags":0,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":285,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":285,"Flags":0,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":301,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":302,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":284,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":304,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":318,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":305,"Flags":0,"Description":"The available data types for office data connector."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":306,"Flags":0,"Description":"Exchange data type connection."},"sharePoint":{"Type":310,"Flags":0,"Description":"SharePoint data type connection."},"teams":{"Type":314,"Flags":0,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":309,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[307,308,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":313,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[311,312,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":317,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[315,316,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":320,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":326,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id to connect to, and get the data from."},"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":321,"Flags":0,"Description":"The available data types for TI (Threat Intelligence) data connector."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":322,"Flags":0,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":325,"Flags":0,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[323,324,4]}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2021-10-01","ScopeType":16,"Body":273}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2021-10-01"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":328,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":329,"Flags":10,"Description":"The resource api version"},"properties":{"Type":331,"Flags":1,"Description":"Automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":55,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":332,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":439,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedBy":{"Type":71,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"createdBy":{"Type":71,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled"},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":334,"Flags":1},"triggersWhen":{"Type":336,"Flags":1},"conditions":{"Type":406,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"5":{"Elements":[333,4]}},{"6":{"Value":"Created"}},{"5":{"Elements":[335,4]}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":338}}},{"2":{"Name":"PropertyConditionProperties","Properties":{"conditionProperties":{"Type":339,"Flags":0},"conditionType":{"Type":405,"Flags":1}}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"propertyName":{"Type":394,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":403,"Flags":0},"propertyValues":{"Type":404,"Flags":0,"Description":"Array of AutomationRulePropertyValuesConditionPropertyValuesItem"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentLabel"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AlertProductNames"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[340,341,342,343,344,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392,393,4]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[395,396,397,398,399,400,401,402,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":337}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1}},"Elements":{"ModifyProperties":408,"RunPlaybook":436}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":409,"Flags":0},"actionType":{"Type":435,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"IncidentPropertiesAction","Properties":{"severity":{"Type":414,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":418,"Flags":0,"Description":"The status of the incident"},"classification":{"Type":423,"Flags":0,"Description":"The reason the incident was closed"},"classificationReason":{"Type":428,"Flags":0,"Description":"The classification reason the incident was closed with"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"owner":{"Type":429,"Flags":0,"Description":"Information on the user an incident is assigned to"},"labels":{"Type":434,"Flags":0,"Description":"List of labels to add to the incident"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[410,411,412,413,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[415,416,417,4]}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[419,420,421,422,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[424,425,426,427,4]}},{"2":{"Name":"IncidentOwnerInfoAutoGenerated","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":433,"Flags":0,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[430,431,432,4]}},{"3":{"ItemType":39}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":437,"Flags":0},"actionType":{"Type":438,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"PlaybookActionProperties","Properties":{"logicAppResourceId":{"Type":4,"Flags":1,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":407}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2021-10-01","ScopeType":16,"Body":330}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2021-10-01/types.md b/generated/securityinsights/microsoft.securityinsights/2021-10-01/types.md new file mode 100644 index 0000000000..05e4ff7185 --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2021-10-01/types.md @@ -0,0 +1,663 @@ +# Microsoft.SecurityInsights @ 2021-10-01 + +## Resource Microsoft.SecurityInsights/alertRules@2021-10-01 +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules' (ReadOnly, DeployTimeConstant): The resource type +### FusionAlertRule +#### Properties +* **kind**: 'Fusion' (Required): The alert rule kind +* **properties**: [FusionAlertRuleProperties](#fusionalertruleproperties): Fusion alert rule base property bag. + +### MicrosoftSecurityIncidentCreationAlertRule +#### Properties +* **kind**: 'MicrosoftSecurityIncidentCreation' (Required): The alert rule kind +* **properties**: [MicrosoftSecurityIncidentCreationAlertRuleProperties](#microsoftsecurityincidentcreationalertruleproperties): MicrosoftSecurityIncidentCreation rule property bag. + +### ScheduledAlertRule +#### Properties +* **kind**: 'Scheduled' (Required): The alert rule kind +* **properties**: [ScheduledAlertRuleProperties](#scheduledalertruleproperties): Scheduled alert rule base property bag. + + +## Resource Microsoft.SecurityInsights/alertRules/actions@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ActionRequestProperties](#actionrequestproperties): Action property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules/actions' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/automationRules@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [AutomationRuleProperties](#automationruleproperties) (Required): Automation rule properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/automationRules' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [BookmarkProperties](#bookmarkproperties): Describes bookmark properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/dataConnectors@2021-10-01 +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/dataConnectors' (ReadOnly, DeployTimeConstant): The resource type +### AwsCloudTrailDataConnector +#### Properties +* **kind**: 'AmazonWebServicesCloudTrail' (Required): The data connector kind +* **properties**: [AwsCloudTrailDataConnectorProperties](#awscloudtraildataconnectorproperties): Amazon Web Services CloudTrail data connector properties. + +### AADDataConnector +#### Properties +* **kind**: 'AzureActiveDirectory' (Required): The data connector kind +* **properties**: [AADDataConnectorProperties](#aaddataconnectorproperties): AAD (Azure Active Directory) data connector properties. + +### AatpDataConnector +#### Properties +* **kind**: 'AzureAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [AatpDataConnectorProperties](#aatpdataconnectorproperties): AATP (Azure Advanced Threat Protection) data connector properties. + +### ASCDataConnector +#### Properties +* **kind**: 'AzureSecurityCenter' (Required): The data connector kind +* **properties**: [ASCDataConnectorProperties](#ascdataconnectorproperties): ASC (Azure Security Center) data connector properties. + +### McasDataConnector +#### Properties +* **kind**: 'MicrosoftCloudAppSecurity' (Required): The data connector kind +* **properties**: [McasDataConnectorProperties](#mcasdataconnectorproperties): MCAS (Microsoft Cloud App Security) data connector properties. + +### MdatpDataConnector +#### Properties +* **kind**: 'MicrosoftDefenderAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [MdatpDataConnectorProperties](#mdatpdataconnectorproperties): MDATP (Microsoft Defender Advanced Threat Protection) data connector properties. + +### OfficeDataConnector +#### Properties +* **kind**: 'Office365' (Required): The data connector kind +* **properties**: [OfficeDataConnectorProperties](#officedataconnectorproperties): Office data connector properties. + +### TIDataConnector +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The data connector kind +* **properties**: [TIDataConnectorProperties](#tidataconnectorproperties): TI (Threat Intelligence) data connector properties. + + +## Resource Microsoft.SecurityInsights/incidents@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentProperties](#incidentproperties): Describes incident properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/comments@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentCommentProperties](#incidentcommentproperties): Incident comment property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/comments' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/relations@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/onboardingStates@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SentinelOnboardingStateProperties](#sentinelonboardingstateproperties): The Sentinel onboarding state properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/onboardingStates' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/threatIntelligence/indicators@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/threatIntelligence/indicators' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistProperties](#watchlistproperties): Describes watchlist properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists/watchlistItems@2021-10-01 +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2021-10-01' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistItemProperties](#watchlistitemproperties): Describes watchlist item properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type + +## AADDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string: The tenant id to connect to, and get the data from. + +## AatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string: The tenant id to connect to, and get the data from. + +## ActionRequestProperties +### Properties +* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. +* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. +* **workflowId**: string (ReadOnly): The name of the logic app's workflow. + +## AlertDetailsOverride +### Properties +* **alertDescriptionFormat**: string: the format containing columns name(s) to override the alert description +* **alertDisplayNameFormat**: string: the format containing columns name(s) to override the alert name +* **alertSeverityColumnName**: string: the column name to take the alert severity from +* **alertTacticsColumnName**: string: the column name to take the alert tactics from + +## AlertsDataTypeOfDataConnector +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. + +## ASCDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## AutomationRuleAction +* **Discriminator**: actionType + +### Base Properties +* **order**: int (Required) +### AutomationRuleModifyPropertiesAction +#### Properties +* **actionConfiguration**: [IncidentPropertiesAction](#incidentpropertiesaction) +* **actionType**: 'ModifyProperties' (Required): The type of the automation rule action + +### AutomationRuleRunPlaybookAction +#### Properties +* **actionConfiguration**: [PlaybookActionProperties](#playbookactionproperties) +* **actionType**: 'RunPlaybook' (Required): The type of the automation rule action + + +## AutomationRuleCondition +* **Discriminator**: conditionType + +### Base Properties +### PropertyConditionProperties +#### Properties +* **conditionProperties**: [AutomationRulePropertyValuesCondition](#automationrulepropertyvaluescondition) +* **conditionType**: 'Property' (Required) + + +## AutomationRuleProperties +### Properties +* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered +* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created +* **displayName**: string (Required): The display name of the automation rule +* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated +* **order**: int (Required): The order of execution of the automation rule +* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic + +## AutomationRulePropertyValuesCondition +### Properties +* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith' | string +* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AlertProductNames' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentLabel' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url' | string: The property to evaluate in an automation rule property condition +* **propertyValues**: string[]: Array of AutomationRulePropertyValuesConditionPropertyValuesItem + +## AutomationRuleTriggeringLogic +### Properties +* **conditions**: [AutomationRuleCondition](#automationrulecondition)[]: The conditions to evaluate to determine if the automation rule should be triggered on a given object +* **expirationTimeUtc**: string: Determines when the automation rule should automatically expire and be disabled. +* **isEnabled**: bool (Required): Determines whether the automation rule is enabled or disabled +* **triggersOn**: 'Incidents' | string (Required) +* **triggersWhen**: 'Created' | string (Required) + +## AwsCloudTrailDataConnectorDataTypes +### Properties +* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs): Logs data type. + +## AwsCloudTrailDataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## AwsCloudTrailDataConnectorProperties +### Properties +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes): The available data types for Amazon Web Services CloudTrail data connector. + +## BookmarkProperties +### Properties +* **created**: string: The time the bookmark was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **displayName**: string (Required): The display name of the bookmark +* **eventTime**: string: The bookmark event time +* **incidentInfo**: [IncidentInfo](#incidentinfo): Describes related incident information for the bookmark +* **labels**: string[]: List of labels relevant to this bookmark +* **notes**: string: The notes of the bookmark +* **query**: string (Required): The query of the bookmark. +* **queryEndTime**: string: The end time for the query +* **queryResult**: string: The query result of the bookmark. +* **queryStartTime**: string: The start time for the query +* **updated**: string: The last time the bookmark was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action + +## ClientInfo +### Properties +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. + +## DataConnectorDataTypeCommon +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## EntityCommonPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## EntityMapping +### Properties +* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The V3 type of the mapped entity +* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping + +## EventGroupingSettings +### Properties +* **aggregationKind**: 'AlertPerResult' | 'SingleAlert' | string: The event grouping aggregation kinds + +## FieldMapping +### Properties +* **columnName**: string: the column name to be mapped to the identifier +* **identifier**: string: the V3 identifier of the entity + +## FusionAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics of the alert rule + +## GroupingConfiguration +### Properties +* **enabled**: bool (Required): Grouping enabled +* **groupByAlertDetails**: 'DisplayName' | 'Severity' | string[]: A list of alert details to group by (when matchingMethod is Selected) +* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. +* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. +* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) +* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' | string (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. +* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents + +## IncidentAdditionalData +### Properties +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[] (ReadOnly): The tactics associated with incident + +## IncidentCommentProperties +### Properties +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message + +## IncidentConfiguration +### Properties +* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule +* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. + +## IncidentInfo +### Properties +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident + +## IncidentLabel +### Properties +* **labelName**: string (Required): The name of the label +* **labelType**: 'AutoAssigned' | 'User' | string (ReadOnly): The type of the label + +## IncidentOwnerInfo +### Properties +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. + +## IncidentOwnerInfoAutoGenerated +### Properties +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **ownerType**: 'Group' | 'Unknown' | 'User' | string: The type of the owner the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. + +## IncidentProperties +### Properties +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **title**: string (Required): The title of the incident + +## IncidentPropertiesAction +### Properties +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels to add to the incident +* **owner**: [IncidentOwnerInfoAutoGenerated](#incidentownerinfoautogenerated): Information on the user an incident is assigned to +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string: The status of the incident + +## McasDataConnectorDataTypes +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. +* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. + +## McasDataConnectorProperties +### Properties +* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes): The available data types for MCAS (Microsoft Cloud App Security) data connector. +* **tenantId**: string: The tenant id to connect to, and get the data from. + +## MdatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string: The tenant id to connect to, and get the data from. + +## MicrosoftSecurityIncidentCreationAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated + +## OfficeDataConnectorDataTypes +### Properties +* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange): Exchange data type connection. +* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint): SharePoint data type connection. +* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams): Teams data type connection. + +## OfficeDataConnectorDataTypesExchange +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesSharePoint +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesTeams +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorProperties +### Properties +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes): The available data types for office data connector. +* **tenantId**: string: The tenant id to connect to, and get the data from. + +## PlaybookActionProperties +### Properties +* **logicAppResourceId**: string (Required): The resource id of the playbook resource +* **tenantId**: string: The tenant id of the playbook resource + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource + +## ScheduledAlertRuleCommonPropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScheduledAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [ScheduledAlertRuleCommonPropertiesCustomDetails](#scheduledalertrulecommonpropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | string[]: The tactics of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. + +## SentinelOnboardingStateProperties +### Properties +* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## ThreatIntelligenceExternalReference +### Properties +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL + +## ThreatIntelligenceExternalReferenceHashes +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThreatIntelligenceGranularMarkingModel +### Properties +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors + +## ThreatIntelligenceIndicatorProperties +### Properties +* **additionalData**: [EntityCommonPropertiesAdditionalData](#entitycommonpropertiesadditionaldata) (ReadOnly, WriteOnly): A bag of custom fields that should be part of the entity and will be presented to the user. +* **confidence**: int (WriteOnly): Confidence of threat intelligence entity +* **created**: string (WriteOnly): Created by +* **createdByRef**: string (WriteOnly): Created by reference of threat intelligence entity +* **defanged**: bool (WriteOnly): Is threat intelligence entity defanged +* **description**: string (WriteOnly): Description of a threat intelligence entity +* **displayName**: string (WriteOnly): Display name of a threat intelligence entity +* **extensions**: [ThreatIntelligenceIndicatorPropertiesExtensions](#threatintelligenceindicatorpropertiesextensions) (WriteOnly): Extensions map +* **externalId**: string (WriteOnly): External ID of threat intelligence entity +* **externalLastUpdatedTimeUtc**: string (WriteOnly): External last updated time in UTC +* **externalReferences**: [ThreatIntelligenceExternalReference](#threatintelligenceexternalreference)[] (WriteOnly): External References +* **friendlyName**: string (ReadOnly, WriteOnly): The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. +* **granularMarkings**: [ThreatIntelligenceGranularMarkingModel](#threatintelligencegranularmarkingmodel)[] (WriteOnly): Granular Markings +* **indicatorTypes**: string[] (WriteOnly): Indicator types of threat intelligence entities +* **killChainPhases**: [ThreatIntelligenceKillChainPhase](#threatintelligencekillchainphase)[] (WriteOnly): Kill chain phases +* **labels**: string[] (WriteOnly): Labels of threat intelligence entity +* **language**: string (WriteOnly): Language of threat intelligence entity +* **lastUpdatedTimeUtc**: string (WriteOnly): Last updated time in UTC +* **modified**: string (WriteOnly): Modified by +* **objectMarkingRefs**: string[] (WriteOnly): Threat intelligence entity object marking references +* **parsedPattern**: [ThreatIntelligenceParsedPattern](#threatintelligenceparsedpattern)[] (WriteOnly): Parsed patterns +* **pattern**: string (WriteOnly): Pattern of a threat intelligence entity +* **patternType**: string (WriteOnly): Pattern type of a threat intelligence entity +* **patternVersion**: string (WriteOnly): Pattern version of a threat intelligence entity +* **revoked**: bool (WriteOnly): Is threat intelligence entity revoked +* **source**: string (WriteOnly): Source of a threat intelligence entity +* **threatIntelligenceTags**: string[] (WriteOnly): List of tags +* **threatTypes**: string[] (WriteOnly): Threat types +* **validFrom**: string (WriteOnly): Valid from +* **validUntil**: string (WriteOnly): Valid until + +## ThreatIntelligenceIndicatorPropertiesExtensions +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## ThreatIntelligenceKillChainPhase +### Properties +* **killChainName**: string (WriteOnly): Kill chainName name +* **phaseName**: string (WriteOnly): Phase name + +## ThreatIntelligenceParsedPattern +### Properties +* **patternTypeKey**: string (WriteOnly): Pattern type key +* **patternTypeValues**: [ThreatIntelligenceParsedPatternTypeValue](#threatintelligenceparsedpatterntypevalue)[] (WriteOnly): Pattern type keys + +## ThreatIntelligenceParsedPatternTypeValue +### Properties +* **value**: string (WriteOnly): Value of parsed pattern +* **valueType**: string (WriteOnly): Type of the value + +## TIDataConnectorDataTypes +### Properties +* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators): Data type for indicators connection. + +## TIDataConnectorDataTypesIndicators +### Properties +* **state**: 'Disabled' | 'Enabled' | string: Describe whether this data type connection is enabled or not. + +## TIDataConnectorProperties +### Properties +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string: The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: any: Any object +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: any (Required): Any object +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + +## WatchlistProperties +### Properties +* **contentType**: string: The content type of the raw content. For now, only text/csv is valid +* **created**: string: The time the watchlist was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **defaultDuration**: string: The default duration of a watchlist (in ISO 8601 duration format) +* **description**: string: A description of the watchlist +* **displayName**: string (Required): The display name of the watchlist +* **isDeleted**: bool: A flag that indicates if the watchlist is deleted or not +* **itemsSearchKey**: string (Required): The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address. +* **labels**: string[]: List of labels relevant to this watchlist +* **numberOfLinesToSkip**: int: The number of lines in a csv content to skip before the header +* **provider**: string (Required): The provider of the watchlist +* **rawContent**: string: The raw content that represents to watchlist items to create. Example : This line will be skipped +header1,header2 +value1,value2 +* **source**: 'Local file' | 'Remote storage' | string (Required): The source of the watchlist +* **tenantId**: string: The tenantId where the watchlist belongs to +* **updated**: string: The last time the watchlist was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **uploadStatus**: string: The status of the Watchlist upload : New, InProgress or Complete. **Note** : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted +* **watchlistAlias**: string: The alias of the watchlist +* **watchlistId**: string: The id (a Guid) of the watchlist +* **watchlistType**: string: The type of the watchlist + diff --git a/generated/securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json b/generated/securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json new file mode 100644 index 0000000000..83a1617171 --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2022-01-01-preview/types.json @@ -0,0 +1 @@ +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2022-01-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":22,"MLBehaviorAnalytics":64,"MicrosoftSecurityIncidentCreation":92,"NRT":111,"Scheduled":195,"ThreatIntelligence":234}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":16,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":21,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[12,13,14,15,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[17,18,19,20,4]}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":23,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":63,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"sourceSettings":{"Type":35,"Flags":0,"Description":"Configuration for all supported source signals in fusion detection."},"scenarioExclusionPatterns":{"Type":37,"Flags":0,"Description":"Configuration to exclude scenarios in fusion detection."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":42,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":61,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":62,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"2":{"Name":"FusionSourceSettings","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this source signal is enabled or disabled in Fusion detection."},"sourceName":{"Type":4,"Flags":1,"Description":"Name of the Fusion source signal. Refer to Fusion alert rule template for supported values."},"sourceSubTypes":{"Type":34,"Flags":0,"Description":"Configuration for all source subtypes under this source signal consumed in fusion detection."}}}},{"2":{"Name":"FusionSourceSubTypeSetting","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this source subtype under source signal is enabled or disabled in Fusion detection."},"sourceSubTypeName":{"Type":4,"Flags":1,"Description":"The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values."},"sourceSubTypeDisplayName":{"Type":4,"Flags":2,"Description":"The display name of source subtype under a source signal consumed in Fusion detection."},"severityFilters":{"Type":26,"Flags":1,"Description":"Represents severity configuration for a source subtype consumed in Fusion detection."}}}},{"2":{"Name":"FusionSubTypeSeverityFilter","Properties":{"isSupported":{"Type":2,"Flags":2,"Description":"Determines whether this source subtype supports severity configuration or not."},"filters":{"Type":33,"Flags":0,"Description":"Individual Severity configuration settings for a given source subtype consumed in Fusion detection."}}}},{"2":{"Name":"FusionSubTypeSeverityFiltersItem","Properties":{"severity":{"Type":32,"Flags":1,"Description":"The severity of the alert"},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection."}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[28,29,30,31,4]}},{"3":{"ItemType":27}},{"3":{"ItemType":25}},{"3":{"ItemType":24}},{"2":{"Name":"FusionScenarioExclusionPattern","Properties":{"exclusionPattern":{"Type":4,"Flags":1,"Description":"Scenario exclusion pattern."},"dateAddedInUTC":{"Type":4,"Flags":1,"Description":"DateTime when scenario exclusion pattern is added in UTC."}}}},{"3":{"ItemType":36}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[38,39,40,41,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,4]}},{"3":{"ItemType":60}},{"3":{"ItemType":4}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":65,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":91,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":70,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":89,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":90,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[66,67,68,69,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,4]}},{"3":{"ItemType":88}},{"3":{"ItemType":4}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":93,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":110,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":94,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":95,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":103,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":109,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[96,97,98,99,100,101,102,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[104,105,106,107,4]}},{"3":{"ItemType":108}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"NrtAlertRule","Properties":{"properties":{"Type":112,"Flags":0,"Description":"Nrt alert rule base property bag."},"kind":{"Type":194,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"NrtAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":1,"Description":"The query that creates alerts for this rule."},"tactics":{"Type":131,"Flags":0,"Description":"The tactics of the alert rule"},"techniques":{"Type":132,"Flags":0,"Description":"The techniques of the alert rule"},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":137,"Flags":1,"Description":"The severity of the alert"},"incidentConfiguration":{"Type":138,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":169,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":192,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":193,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,4]}},{"3":{"ItemType":130}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[133,134,135,136,4]}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":139,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":143,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":163,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":167,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":168,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[140,141,142,4]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,4]}},{"3":{"ItemType":162}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[164,165,4]}},{"3":{"ItemType":166}},{"3":{"ItemType":4}},{"2":{"Name":"NrtAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":189,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":191,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,4]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":190}},{"3":{"ItemType":170}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"NRT"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":196,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":233,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":215,"Flags":0,"Description":"The tactics of the alert rule"},"techniques":{"Type":216,"Flags":0,"Description":"The techniques of the alert rule"},"incidentConfiguration":{"Type":138,"Flags":0,"Description":"Incident Configuration property bag."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":221,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":226,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":227,"Flags":0,"Description":"Event grouping settings property bag."},"customDetails":{"Type":231,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":232,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":193,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,4]}},{"3":{"ItemType":214}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[217,218,219,220,4]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[222,223,224,225]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":230,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[228,229,4]}},{"2":{"Name":"ScheduledAlertRuleCommonPropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":170}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":235,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":261,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":240,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":259,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":260,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[236,237,238,239,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,4]}},{"3":{"ItemType":258}},{"3":{"ItemType":4}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2022-01-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":263,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":264,"Flags":10,"Description":"The resource api version"},"properties":{"Type":266,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2022-01-01-preview","ScopeType":16,"Body":265}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":268,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":269,"Flags":10,"Description":"The resource api version"},"properties":{"Type":271,"Flags":1,"Description":"Automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":272,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":383,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedBy":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"createdBy":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled"},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":274,"Flags":1},"triggersWhen":{"Type":276,"Flags":1},"conditions":{"Type":346,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"5":{"Elements":[273,4]}},{"6":{"Value":"Created"}},{"5":{"Elements":[275,4]}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":278}}},{"2":{"Name":"PropertyConditionProperties","Properties":{"conditionProperties":{"Type":279,"Flags":0},"conditionType":{"Type":345,"Flags":1}}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"propertyName":{"Type":334,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":343,"Flags":0},"propertyValues":{"Type":344,"Flags":0,"Description":"Array of AutomationRulePropertyValuesConditionPropertyValuesItem"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentLabel"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AlertProductNames"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[280,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,4]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[335,336,337,338,339,340,341,342,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":277}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1}},"Elements":{"ModifyProperties":348,"RunPlaybook":380}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":349,"Flags":0},"actionType":{"Type":379,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"IncidentPropertiesAction","Properties":{"severity":{"Type":354,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":358,"Flags":0,"Description":"The status of the incident"},"classification":{"Type":363,"Flags":0,"Description":"The reason the incident was closed"},"classificationReason":{"Type":368,"Flags":0,"Description":"The classification reason the incident was closed with"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"owner":{"Type":369,"Flags":0,"Description":"Information on the user an incident is assigned to"},"labels":{"Type":378,"Flags":0,"Description":"List of labels to add to the incident"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[350,351,352,353,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[355,356,357,4]}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[359,360,361,362,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[364,365,366,367,4]}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":373,"Flags":2,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[370,371,372,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":377,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"AutoAssigned"}},{"5":{"Elements":[375,376,4]}},{"3":{"ItemType":374}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":381,"Flags":0},"actionType":{"Type":382,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"PlaybookActionProperties","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":347}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2022-01-01-preview","ScopeType":16,"Body":270}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":386,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":387,"Flags":10,"Description":"The resource api version"},"properties":{"Type":389,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":390,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":416,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":421,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":422,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":369,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":423,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":428,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":432,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":433,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":391,"Flags":2,"Description":"List of product names of alerts in the incident"},"providerIncidentUrl":{"Type":4,"Flags":2,"Description":"The provider incident url to the incident in Microsoft 365 Defender portal"},"tactics":{"Type":410,"Flags":2,"Description":"The tactics associated with incident"},"techniques":{"Type":411,"Flags":2,"Description":"The techniques associated with incident's tactics'"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,4]}},{"3":{"ItemType":409}},{"3":{"ItemType":4}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[412,413,414,415,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[417,418,419,420,4]}},{"3":{"ItemType":374}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[424,425,426,427,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[429,430,431,4]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2022-01-01-preview","ScopeType":16,"Body":388}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":435,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":436,"Flags":10,"Description":"The resource api version"},"properties":{"Type":438,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":440,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":441,"Flags":0,"Description":"Describes related incident information for the bookmark"},"entityMappings":{"Type":450,"Flags":0,"Description":"Describes the entity mappings of the bookmark"},"tactics":{"Type":469,"Flags":0,"Description":"A list of relevant mitre attacks"},"techniques":{"Type":470,"Flags":0,"Description":"A list of relevant mitre techniques"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":446,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[442,443,444,445,4]}},{"2":{"Name":"BookmarkEntityMappings","Properties":{"entityType":{"Type":4,"Flags":0,"Description":"The entity type"},"fieldMappings":{"Type":449,"Flags":0,"Description":"Array of fields mapping for that entity type"}}}},{"2":{"Name":"EntityFieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"Alert V3 identifier"},"value":{"Type":4,"Flags":0,"Description":"The value of the identifier"}}}},{"3":{"ItemType":448}},{"3":{"ItemType":447}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,4]}},{"3":{"ItemType":468}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2022-01-01-preview","ScopeType":16,"Body":437}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":472,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":473,"Flags":10,"Description":"The resource api version"},"properties":{"Type":475,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2022-01-01-preview","ScopeType":16,"Body":474}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2022-01-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":477,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":478,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":480,"Expansion":510}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":481,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":509,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":482,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":504,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":506,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":508,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[483,484,485,486,487,488,489,490,491,492,493,494,495,496,497,498,499,500,501,502,503,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":505}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":507}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":511,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":559,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":512,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":534,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":535,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":558,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[536,537,538,539,540,541,542,543,544,545,546,547,548,549,550,551,552,553,554,555,556,4]}},{"3":{"ItemType":557}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2022-01-01-preview","ScopeType":16,"Body":479}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2022-01-01-preview","ScopeType":16,"Body":563}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":475,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2022-01-01-preview","ScopeType":16,"Body":568}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":573,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":591,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":592,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":598,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":599,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":604,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":627,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":630,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"},"customVersion":{"Type":4,"Flags":0,"Description":"The custom version of the content. A optional free text"},"contentSchemaVersion":{"Type":4,"Flags":0,"Description":"Schema version of the content. Can be used to distinguish between different flow based on the schema version"},"icon":{"Type":4,"Flags":0,"Description":"the icon identifier. this id can later be fetched from the solution template"},"threatAnalysisTactics":{"Type":631,"Flags":0,"Description":"the tactics the resource covers"},"threatAnalysisTechniques":{"Type":632,"Flags":0,"Description":"the techniques the resource covers, these have to be aligned with the tactics being used"},"previewImages":{"Type":633,"Flags":0,"Description":"preview image file names. These will be taken from the solution artifacts"},"previewImagesDark":{"Type":634,"Flags":0,"Description":"preview image file names. These will be taken from the solution artifacts. used for dark theme support"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"6":{"Value":"AzureFunction"}},{"6":{"Value":"LogicAppsCustomConnector"}},{"6":{"Value":"AutomationRule"}},{"5":{"Elements":[574,575,576,577,578,579,580,581,582,583,584,585,586,587,588,589,590,4]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":597,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[593,594,595,596,4]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":603,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[600,601,602,4]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":622,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":625,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":626,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"6":{"Value":"AzureFunction"}},{"6":{"Value":"LogicAppsCustomConnector"}},{"6":{"Value":"AutomationRule"}},{"5":{"Elements":[605,606,607,608,609,610,611,612,613,614,615,616,617,618,619,620,621,4]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[623,624,4]}},{"3":{"ItemType":604}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":628,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":629,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2022-01-01-preview","ScopeType":16,"Body":572}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":636,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":637,"Flags":10,"Description":"The resource api version"},"properties":{"Type":639,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2022-01-01-preview","ScopeType":16,"Body":638}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2022-01-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":641,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":642,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":644,"EntityAnalytics":647,"EyesOn":650,"Ueba":653}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":645,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":646,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":648,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":649,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":651,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":652,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":654,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":661,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":660,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[655,656,657,658,4]}},{"3":{"ItemType":659}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2022-01-01-preview","ScopeType":16,"Body":643}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":663,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":664,"Flags":10,"Description":"The resource api version"},"properties":{"Type":666,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"version":{"Type":669,"Flags":0,"Description":"The version of the source control."},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":672,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":676,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":677,"Flags":1,"Description":"metadata of a repository."},"repositoryResourceInfo":{"Type":683,"Flags":0,"Description":"Resources created in user's repository for the source-control."},"lastDeploymentInfo":{"Type":687,"Flags":0,"Description":"Information regarding a deployment."}}}},{"6":{"Value":"V1"}},{"6":{"Value":"V2"}},{"5":{"Elements":[667,668,4]}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[670,671,4]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[673,674,4]}},{"3":{"ItemType":675}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":682,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":681,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[679,680,4]}},{"3":{"ItemType":678}},{"2":{"Name":"RepositoryResourceInfo","Properties":{"webhook":{"Type":684,"Flags":0,"Description":"Detail about the webhook object."},"gitHubResourceInfo":{"Type":685,"Flags":0,"Description":"Resources created in GitHub repository."},"azureDevOpsResourceInfo":{"Type":686,"Flags":0,"Description":"Resources created in Azure DevOps repository."}}}},{"2":{"Name":"Webhook","Properties":{"webhookId":{"Type":4,"Flags":0,"Description":"Unique identifier for the webhook."},"webhookUrl":{"Type":4,"Flags":0,"Description":"URL that gets invoked by the webhook."},"webhookSecretUpdateTime":{"Type":4,"Flags":0,"Description":"Time when the webhook secret was updated."},"rotateWebhookSecret":{"Type":2,"Flags":0,"Description":"A flag to instruct the backend service to rotate webhook secret."}}}},{"2":{"Name":"GitHubResourceInfo","Properties":{"appInstallationId":{"Type":4,"Flags":0,"Description":"GitHub application installation id."}}}},{"2":{"Name":"AzureDevOpsResourceInfo","Properties":{"pipelineId":{"Type":4,"Flags":0,"Description":"Id of the pipeline created for the source-control."},"serviceConnectionId":{"Type":4,"Flags":0,"Description":"Id of the service-connection created for the source-control."}}}},{"2":{"Name":"DeploymentInfo","Properties":{"deploymentFetchStatus":{"Type":691,"Flags":0,"Description":"Status while trying to fetch the deployment information."},"deployment":{"Type":692,"Flags":0,"Description":"Description about a deployment."},"message":{"Type":4,"Flags":0,"Description":"Additional details about the deployment that can be shown to the user."}}}},{"6":{"Value":"Success"}},{"6":{"Value":"Unauthorized"}},{"6":{"Value":"NotFound"}},{"5":{"Elements":[688,689,690,4]}},{"2":{"Name":"Deployment","Properties":{"deploymentId":{"Type":4,"Flags":0,"Description":"Deployment identifier."},"deploymentState":{"Type":697,"Flags":0,"Description":"The current state of the deployment."},"deploymentResult":{"Type":701,"Flags":0,"Description":"Status while trying to fetch the deployment information."},"deploymentTime":{"Type":4,"Flags":0,"Description":"The time when the deployment finished."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."}}}},{"6":{"Value":"In_Progress"}},{"6":{"Value":"Completed"}},{"6":{"Value":"Queued"}},{"6":{"Value":"Canceling"}},{"5":{"Elements":[693,694,695,696,4]}},{"6":{"Value":"Success"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Failed"}},{"5":{"Elements":[698,699,700,4]}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2022-01-01-preview","ScopeType":16,"Body":665}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":703,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":704,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":4,"Description":"Describes threat intelligence entity properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":707,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":708,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":710,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":714,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":717,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":720,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":721,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":722,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":723,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":724,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":725,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":709}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":713,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":712}},{"3":{"ItemType":711}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":716,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":715}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":719,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":718}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2022-01-01-preview","ScopeType":16,"Body":705}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":727,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":728,"Flags":10,"Description":"The resource api version"},"properties":{"Type":730,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":4,"Flags":0,"Description":"The filename of the watchlist, called 'source'"},"sourceType":{"Type":733,"Flags":0,"Description":"The sourceType of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":734,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"sasUri":{"Type":4,"Flags":0,"Description":"The Shared Access Signature (SAS) URI under which the large csv watchlist file is located and from which the watchlist and its items will be created"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"},"provisioningState":{"Type":739,"Flags":2,"Description":"The current provisioning state."}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[731,732,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"5":{"Elements":[735,736,737,738,4]}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2022-01-01-preview","ScopeType":16,"Body":729}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2022-01-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":741,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":742,"Flags":10,"Description":"The resource api version"},"properties":{"Type":744,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":745,"Flags":1,"Description":"key-value pairs for a watchlist item"},"entityMapping":{"Type":746,"Flags":0,"Description":"key-value pairs for a watchlist item entity mapping"}}}},{"2":{"Name":"WatchlistItemPropertiesItemsKeyValue","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"WatchlistItemPropertiesEntityMapping","Properties":{},"AdditionalProperties":0}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2022-01-01-preview","ScopeType":16,"Body":743}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2022-01-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":748,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":749,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"APIPolling":751,"AmazonWebServicesCloudTrail":799,"AmazonWebServicesS3":807,"AzureActiveDirectory":816,"AzureAdvancedThreatProtection":824,"AzureSecurityCenter":827,"Dynamics365":830,"GenericUI":838,"IOT":841,"MicrosoftCloudAppSecurity":844,"MicrosoftDefenderAdvancedThreatProtection":848,"MicrosoftThreatIntelligence":851,"MicrosoftThreatProtection":863,"Office365":871,"Office365Project":887,"OfficeATP":895,"OfficeIRM":898,"OfficePowerBI":901,"ThreatIntelligence":909,"ThreatIntelligenceTaxii":917}}},{"2":{"Name":"CodelessApiPollingDataConnector","Properties":{"properties":{"Type":752,"Flags":0,"Description":"Represents Codeless API Polling data connector"},"kind":{"Type":798,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ApiPollingParameters","Properties":{"connectorUiConfig":{"Type":753,"Flags":0,"Description":"Config to describe the instructions blade"},"pollingConfig":{"Type":792,"Flags":0,"Description":"Config to describe the polling config for API poller connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":755,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":757,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":759,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":764,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":765,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":767,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":791,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":754}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":756}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":758}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":762,"Flags":0,"Description":"type of connectivity"},"value":{"Type":763,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"5":{"Elements":[761,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":760}},{"2":{"Name":"Availability","Properties":{"status":{"Type":766,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":781,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":783,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":775,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":779,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":780,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[769,770,771,772,773,774,4]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[776,777,778,4]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":768}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":782}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":790,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":789,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[786,787,788,4]}},{"3":{"ItemType":785}},{"3":{"ItemType":784}},{"2":{"Name":"CodelessConnectorPollingConfigProperties","Properties":{"isActive":{"Type":2,"Flags":0,"Description":"The poller active status"},"auth":{"Type":793,"Flags":1,"Description":"Describe the authentication properties needed to successfully authenticate with the server"},"request":{"Type":794,"Flags":1,"Description":"Describe the request properties needed to successfully pull from the server"},"paging":{"Type":795,"Flags":0,"Description":"Describe the properties needed to make a pagination call"},"response":{"Type":796,"Flags":0,"Description":"Describes the response from the external server"}}}},{"2":{"Name":"CodelessConnectorPollingAuthProperties","Properties":{"authType":{"Type":4,"Flags":1,"Description":"The authentication type"},"apiKeyName":{"Type":4,"Flags":0,"Description":"The header name which the token is sent with"},"apiKeyIdentifier":{"Type":4,"Flags":0,"Description":"A prefix send in the header before the actual token"},"isApiKeyInPostPayload":{"Type":4,"Flags":0,"Description":"Marks if the key should sent in header"},"flowName":{"Type":4,"Flags":0,"Description":"Describes the flow name, for example 'AuthCode' for Oauth 2.0"},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to issue a token, used in Oauth 2.0 flow"},"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to authorize the user, used in Oauth 2.0 flow"},"authorizationEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"redirectionEndpoint":{"Type":4,"Flags":0,"Description":"The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow"},"tokenEndpointHeaders":{"Type":0,"Flags":0,"Description":"Any object"},"tokenEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"isClientSecretInHeader":{"Type":2,"Flags":0,"Description":"Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow"},"scope":{"Type":4,"Flags":0,"Description":"The OAuth token scope"}}}},{"2":{"Name":"CodelessConnectorPollingRequestProperties","Properties":{"apiEndpoint":{"Type":4,"Flags":1,"Description":"Describe the endpoint we should pull the data from"},"rateLimitQps":{"Type":3,"Flags":0,"Description":"Defines the rate limit QPS"},"queryWindowInMin":{"Type":3,"Flags":1,"Description":"The window interval we will use the pull the data"},"httpMethod":{"Type":4,"Flags":1,"Description":"The http method type we will use in the poll request, GET or POST"},"queryTimeFormat":{"Type":4,"Flags":1,"Description":"The time format will be used the query events in a specific window"},"retryCount":{"Type":3,"Flags":0,"Description":"Describe the amount of time we should try and poll the data in case of failure"},"timeoutInSeconds":{"Type":3,"Flags":0,"Description":"The number of seconds we will consider as a request timeout"},"headers":{"Type":0,"Flags":0,"Description":"Any object"},"queryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"queryParametersTemplate":{"Type":4,"Flags":0,"Description":"For advanced scenarios for example user name/password embedded in nested JSON payload"},"startTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from a start of the time window"},"endTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from the end of the time window"}}}},{"2":{"Name":"CodelessConnectorPollingPagingProperties","Properties":{"pagingType":{"Type":4,"Flags":1,"Description":"Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'"},"nextPageParaName":{"Type":4,"Flags":0,"Description":"Defines the name of a next page attribute"},"nextPageTokenJsonPath":{"Type":4,"Flags":0,"Description":"Defines the path to a next page token JSON"},"pageCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page count attribute"},"pageTotalCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page total count attribute"},"pageTimeStampAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a paging time stamp attribute"},"searchTheLatestTimeStampFromEventsList":{"Type":4,"Flags":0,"Description":"Determines whether to search for the latest time stamp in the events list"},"pageSizeParaName":{"Type":4,"Flags":0,"Description":"Defines the name of the page size parameter"},"pageSize":{"Type":3,"Flags":0,"Description":"Defines the paging size"}}}},{"2":{"Name":"CodelessConnectorPollingResponseProperties","Properties":{"eventsJsonPaths":{"Type":797,"Flags":1,"Description":"Describes the path we should extract the data in the response"},"successStatusJsonPath":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status code in the response"},"successStatusValue":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status value in the response"},"isGzipCompressed":{"Type":2,"Flags":0,"Description":"Describes if the data in the response is Gzip"}}}},{"3":{"ItemType":4}},{"6":{"Value":"APIPolling"}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":800,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":806,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":801,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":802,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":805,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[803,804,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AwsS3DataConnector","Properties":{"properties":{"Type":808,"Flags":0,"Description":"Amazon Web Services S3 data connector properties."},"kind":{"Type":815,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsS3DataConnectorProperties","Properties":{"destinationTable":{"Type":4,"Flags":1,"Description":"The logs destination table name in LogAnalytics."},"sqsUrls":{"Type":809,"Flags":1,"Description":"The AWS sqs urls for the connector."},"roleArn":{"Type":4,"Flags":1,"Description":"The Aws Role Arn that is used to access the Aws account."},"dataTypes":{"Type":810,"Flags":1,"Description":"The available data types for Amazon Web Services S3 data connector."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AwsS3DataConnectorDataTypes","Properties":{"logs":{"Type":811,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsS3DataConnectorDataTypesLogs","Properties":{"state":{"Type":814,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[812,813,4]}},{"6":{"Value":"AmazonWebServicesS3"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":817,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":823,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":819,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":822,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[820,821,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":825,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":826,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":828,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":829,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":831,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":837,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":832,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":833,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":836,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[834,835,4]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":839,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":840,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":753,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"IoTDataConnector","Properties":{"properties":{"Type":842,"Flags":0,"Description":"IoT data connector properties."},"kind":{"Type":843,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"IoTDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"IOT"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":845,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":847,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":846,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":819,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":819,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":849,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":850,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":852,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":862,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":853,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":854,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":858,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":857,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[855,856,4]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":861,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[859,860,4]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":864,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":870,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":865,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":866,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":869,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[867,868,4]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":872,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":886,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":873,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":874,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":878,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":882,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":877,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[875,876,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":881,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[879,880,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":885,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[883,884,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"Office365ProjectDataConnector","Properties":{"properties":{"Type":888,"Flags":0,"Description":"Office Microsoft Project data connector properties."},"kind":{"Type":894,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Office365ProjectDataConnectorProperties","Properties":{"dataTypes":{"Type":889,"Flags":1,"Description":"The available data types for Office Microsoft Project data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Office365ProjectConnectorDataTypes","Properties":{"logs":{"Type":890,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"Office365ProjectConnectorDataTypesLogs","Properties":{"state":{"Type":893,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[891,892,4]}},{"6":{"Value":"Office365Project"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":896,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":897,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"OfficeIRMDataConnector","Properties":{"properties":{"Type":899,"Flags":0,"Description":"OfficeIRM (Microsoft Insider Risk Management) data connector properties."},"kind":{"Type":900,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeIRMDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":818,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeIRM"}},{"2":{"Name":"OfficePowerBIDataConnector","Properties":{"properties":{"Type":902,"Flags":0,"Description":"Office Microsoft PowerBI data connector properties."},"kind":{"Type":908,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficePowerBIDataConnectorProperties","Properties":{"dataTypes":{"Type":903,"Flags":1,"Description":"The available data types for Office Microsoft PowerBI data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficePowerBIConnectorDataTypes","Properties":{"logs":{"Type":904,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"OfficePowerBIConnectorDataTypesLogs","Properties":{"state":{"Type":907,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[905,906,4]}},{"6":{"Value":"OfficePowerBI"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":910,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":916,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":911,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":912,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":915,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[913,914,4]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":918,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":928,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":922,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":923,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[919,920,921,4]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":924,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":927,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[925,926,4]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2022-01-01-preview","ScopeType":16,"Body":750}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md b/generated/securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md new file mode 100644 index 0000000000..77a5f64bd7 --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2022-01-01-preview/types.md @@ -0,0 +1,1364 @@ +# Microsoft.SecurityInsights @ 2022-01-01-preview + +## Resource Microsoft.SecurityInsights/alertRules@2022-01-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules' (ReadOnly, DeployTimeConstant): The resource type +### FusionAlertRule +#### Properties +* **kind**: 'Fusion' (Required): The kind of the alert rule +* **properties**: [FusionAlertRuleProperties](#fusionalertruleproperties): Fusion alert rule base property bag. + +### MicrosoftSecurityIncidentCreationAlertRule +#### Properties +* **kind**: 'MicrosoftSecurityIncidentCreation' (Required): The kind of the alert rule +* **properties**: [MicrosoftSecurityIncidentCreationAlertRuleProperties](#microsoftsecurityincidentcreationalertruleproperties): MicrosoftSecurityIncidentCreation rule property bag. + +### MLBehaviorAnalyticsAlertRule +#### Properties +* **kind**: 'MLBehaviorAnalytics' (Required): The kind of the alert rule +* **properties**: [MLBehaviorAnalyticsAlertRuleProperties](#mlbehavioranalyticsalertruleproperties): MLBehaviorAnalytics alert rule base property bag. + +### NrtAlertRule +#### Properties +* **kind**: 'NRT' (Required): The kind of the alert rule +* **properties**: [NrtAlertRuleProperties](#nrtalertruleproperties): Nrt alert rule base property bag. + +### ScheduledAlertRule +#### Properties +* **kind**: 'Scheduled' (Required): The kind of the alert rule +* **properties**: [ScheduledAlertRuleProperties](#scheduledalertruleproperties): Scheduled alert rule base property bag. + +### ThreatIntelligenceAlertRule +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The kind of the alert rule +* **properties**: [ThreatIntelligenceAlertRuleProperties](#threatintelligencealertruleproperties): Threat Intelligence alert rule base property bag. + + +## Resource Microsoft.SecurityInsights/alertRules/actions@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ActionRequestProperties](#actionrequestproperties): Action property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules/actions' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/automationRules@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [AutomationRuleProperties](#automationruleproperties) (Required): Automation rule properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/automationRules' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [BookmarkProperties](#bookmarkproperties): Describes bookmark properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks/relations@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/dataConnectors@2022-01-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/dataConnectors' (ReadOnly, DeployTimeConstant): The resource type +### AwsCloudTrailDataConnector +#### Properties +* **kind**: 'AmazonWebServicesCloudTrail' (Required): The data connector kind +* **properties**: [AwsCloudTrailDataConnectorProperties](#awscloudtraildataconnectorproperties): Amazon Web Services CloudTrail data connector properties. + +### AwsS3DataConnector +#### Properties +* **kind**: 'AmazonWebServicesS3' (Required): The data connector kind +* **properties**: [AwsS3DataConnectorProperties](#awss3dataconnectorproperties): Amazon Web Services S3 data connector properties. + +### CodelessApiPollingDataConnector +#### Properties +* **kind**: 'APIPolling' (Required): The data connector kind +* **properties**: [ApiPollingParameters](#apipollingparameters): Represents Codeless API Polling data connector + +### AADDataConnector +#### Properties +* **kind**: 'AzureActiveDirectory' (Required): The data connector kind +* **properties**: [AADDataConnectorProperties](#aaddataconnectorproperties): AAD (Azure Active Directory) data connector properties. + +### AatpDataConnector +#### Properties +* **kind**: 'AzureAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [AatpDataConnectorProperties](#aatpdataconnectorproperties): AATP (Azure Advanced Threat Protection) data connector properties. + +### ASCDataConnector +#### Properties +* **kind**: 'AzureSecurityCenter' (Required): The data connector kind +* **properties**: [ASCDataConnectorProperties](#ascdataconnectorproperties): ASC (Azure Security Center) data connector properties. + +### Dynamics365DataConnector +#### Properties +* **kind**: 'Dynamics365' (Required): The data connector kind +* **properties**: [Dynamics365DataConnectorProperties](#dynamics365dataconnectorproperties): Dynamics365 data connector properties. + +### CodelessUiDataConnector +#### Properties +* **kind**: 'GenericUI' (Required): The data connector kind +* **properties**: [CodelessParameters](#codelessparameters): Represents Codeless UI data connector + +### IoTDataConnector +#### Properties +* **kind**: 'IOT' (Required): The data connector kind +* **properties**: [IoTDataConnectorProperties](#iotdataconnectorproperties): IoT data connector properties. + +### McasDataConnector +#### Properties +* **kind**: 'MicrosoftCloudAppSecurity' (Required): The data connector kind +* **properties**: [McasDataConnectorProperties](#mcasdataconnectorproperties): MCAS (Microsoft Cloud App Security) data connector properties. + +### MdatpDataConnector +#### Properties +* **kind**: 'MicrosoftDefenderAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [MdatpDataConnectorProperties](#mdatpdataconnectorproperties): MDATP (Microsoft Defender Advanced Threat Protection) data connector properties. + +### MstiDataConnector +#### Properties +* **kind**: 'MicrosoftThreatIntelligence' (Required): The data connector kind +* **properties**: [MstiDataConnectorProperties](#mstidataconnectorproperties): Microsoft Threat Intelligence data connector properties. + +### MTPDataConnector +#### Properties +* **kind**: 'MicrosoftThreatProtection' (Required): The data connector kind +* **properties**: [MTPDataConnectorProperties](#mtpdataconnectorproperties): MTP (Microsoft Threat Protection) data connector properties. + +### OfficeDataConnector +#### Properties +* **kind**: 'Office365' (Required): The data connector kind +* **properties**: [OfficeDataConnectorProperties](#officedataconnectorproperties): Office data connector properties. + +### Office365ProjectDataConnector +#### Properties +* **kind**: 'Office365Project' (Required): The data connector kind +* **properties**: [Office365ProjectDataConnectorProperties](#office365projectdataconnectorproperties): Office Microsoft Project data connector properties. + +### OfficeATPDataConnector +#### Properties +* **kind**: 'OfficeATP' (Required): The data connector kind +* **properties**: [OfficeATPDataConnectorProperties](#officeatpdataconnectorproperties): OfficeATP (Office 365 Advanced Threat Protection) data connector properties. + +### OfficeIRMDataConnector +#### Properties +* **kind**: 'OfficeIRM' (Required): The data connector kind +* **properties**: [OfficeIRMDataConnectorProperties](#officeirmdataconnectorproperties): OfficeIRM (Microsoft Insider Risk Management) data connector properties. + +### OfficePowerBIDataConnector +#### Properties +* **kind**: 'OfficePowerBI' (Required): The data connector kind +* **properties**: [OfficePowerBIDataConnectorProperties](#officepowerbidataconnectorproperties): Office Microsoft PowerBI data connector properties. + +### TIDataConnector +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The data connector kind +* **properties**: [TIDataConnectorProperties](#tidataconnectorproperties): TI (Threat Intelligence) data connector properties. + +### TiTaxiiDataConnector +#### Properties +* **kind**: 'ThreatIntelligenceTaxii' (Required): The data connector kind +* **properties**: [TiTaxiiDataConnectorProperties](#titaxiidataconnectorproperties): Threat Intelligence TAXII data connector properties. + + +## Resource Microsoft.SecurityInsights/entityQueries@2022-01-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/entityQueries' (ReadOnly, DeployTimeConstant): The resource type +### ActivityCustomEntityQuery +#### Properties +* **kind**: 'Activity' (Required): the entity query kind +* **properties**: [ActivityEntityQueriesProperties](#activityentityqueriesproperties): Describes activity entity query properties + +### ExpansionEntityQuery +#### Properties +* **kind**: 'Expansion' (Required): the entity query kind +* **properties**: [ExpansionEntityQueriesProperties](#expansionentityqueriesproperties) (ReadOnly): Describes expansion entity query properties + + +## Resource Microsoft.SecurityInsights/incidents@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentProperties](#incidentproperties): Describes incident properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/comments@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentCommentProperties](#incidentcommentproperties): Incident comment property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/comments' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/relations@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/metadata@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [MetadataProperties](#metadataproperties): Metadata property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/metadata' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/onboardingStates@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SentinelOnboardingStateProperties](#sentinelonboardingstateproperties): The Sentinel onboarding state properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/onboardingStates' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/settings@2022-01-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/settings' (ReadOnly, DeployTimeConstant): The resource type +### Anomalies +#### Properties +* **kind**: 'Anomalies' (Required): The kind of the setting +* **properties**: [AnomaliesSettingsProperties](#anomaliessettingsproperties): Anomalies property bag. + +### EntityAnalytics +#### Properties +* **kind**: 'EntityAnalytics' (Required): The kind of the setting +* **properties**: [EntityAnalyticsProperties](#entityanalyticsproperties): EntityAnalytics property bag. + +### EyesOn +#### Properties +* **kind**: 'EyesOn' (Required): The kind of the setting +* **properties**: [EyesOnSettingsProperties](#eyesonsettingsproperties): EyesOn property bag. + +### Ueba +#### Properties +* **kind**: 'Ueba' (Required): The kind of the setting +* **properties**: [UebaProperties](#uebaproperties): Ueba property bag. + + +## Resource Microsoft.SecurityInsights/sourcecontrols@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SourceControlProperties](#sourcecontrolproperties): Describes source control properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/sourcecontrols' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/threatIntelligence/indicators@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/threatIntelligence/indicators' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistProperties](#watchlistproperties): Describes watchlist properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists/watchlistItems@2022-01-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-01-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistItemProperties](#watchlistitemproperties): Describes watchlist item properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type + +## AADDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## AatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## ActionRequestProperties +### Properties +* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. +* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. +* **workflowId**: string (ReadOnly): The name of the logic app's workflow. + +## ActivityEntityQueriesProperties +### Properties +* **content**: string: The entity query content to display in timeline +* **createdTimeUtc**: string (ReadOnly): The time the activity was created +* **description**: string: The entity query description +* **enabled**: bool: Determines whether this activity is enabled or disabled. +* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The type of the entity +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated +* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions +* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query +* **templateName**: string: The template id this activity was created from +* **title**: string: The entity query title + +## ActivityEntityQueriesPropertiesEntitiesFilter +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## ActivityEntityQueriesPropertiesQueryDefinitions +### Properties +* **query**: string: The Activity query to run on a given entity + +## AlertDetailsOverride +### Properties +* **alertDescriptionFormat**: string: the format containing columns name(s) to override the alert description +* **alertDisplayNameFormat**: string: the format containing columns name(s) to override the alert name +* **alertSeverityColumnName**: string: the column name to take the alert severity from +* **alertTacticsColumnName**: string: the column name to take the alert tactics from + +## AlertsDataTypeOfDataConnector +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. + +## AnomaliesSettingsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## ApiPollingParameters +### Properties +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade +* **pollingConfig**: [CodelessConnectorPollingConfigProperties](#codelessconnectorpollingconfigproperties): Config to describe the polling config for API poller connector + +## ASCDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## AutomationRuleAction +* **Discriminator**: actionType + +### Base Properties +* **order**: int (Required) +### AutomationRuleModifyPropertiesAction +#### Properties +* **actionConfiguration**: [IncidentPropertiesAction](#incidentpropertiesaction) +* **actionType**: 'ModifyProperties' (Required): The type of the automation rule action + +### AutomationRuleRunPlaybookAction +#### Properties +* **actionConfiguration**: [PlaybookActionProperties](#playbookactionproperties) +* **actionType**: 'RunPlaybook' (Required): The type of the automation rule action + + +## AutomationRuleCondition +* **Discriminator**: conditionType + +### Base Properties +### PropertyConditionProperties +#### Properties +* **conditionProperties**: [AutomationRulePropertyValuesCondition](#automationrulepropertyvaluescondition) +* **conditionType**: 'Property' (Required) + + +## AutomationRuleProperties +### Properties +* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered +* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created +* **displayName**: string (Required): The display name of the automation rule +* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated +* **order**: int (Required): The order of execution of the automation rule +* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic + +## AutomationRulePropertyValuesCondition +### Properties +* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith' | string +* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AlertProductNames' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentLabel' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url' | string: The property to evaluate in an automation rule property condition +* **propertyValues**: string[]: Array of AutomationRulePropertyValuesConditionPropertyValuesItem + +## AutomationRuleTriggeringLogic +### Properties +* **conditions**: [AutomationRuleCondition](#automationrulecondition)[]: The conditions to evaluate to determine if the automation rule should be triggered on a given object +* **expirationTimeUtc**: string: Determines when the automation rule should automatically expire and be disabled. +* **isEnabled**: bool (Required): Determines whether the automation rule is enabled or disabled +* **triggersOn**: 'Incidents' | string (Required) +* **triggersWhen**: 'Created' | string (Required) + +## Availability +### Properties +* **isPreview**: bool: Set connector as preview +* **status**: '1': The connector Availability Status + +## AwsCloudTrailDataConnectorDataTypes +### Properties +* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs) (Required): Logs data type. + +## AwsCloudTrailDataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsCloudTrailDataConnectorProperties +### Properties +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. + +## AwsS3DataConnectorDataTypes +### Properties +* **logs**: [AwsS3DataConnectorDataTypesLogs](#awss3dataconnectordatatypeslogs) (Required): Logs data type. + +## AwsS3DataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsS3DataConnectorProperties +### Properties +* **dataTypes**: [AwsS3DataConnectorDataTypes](#awss3dataconnectordatatypes) (Required): The available data types for Amazon Web Services S3 data connector. +* **destinationTable**: string (Required): The logs destination table name in LogAnalytics. +* **roleArn**: string (Required): The Aws Role Arn that is used to access the Aws account. +* **sqsUrls**: string[] (Required): The AWS sqs urls for the connector. + +## AzureDevOpsResourceInfo +### Properties +* **pipelineId**: string: Id of the pipeline created for the source-control. +* **serviceConnectionId**: string: Id of the service-connection created for the source-control. + +## BookmarkEntityMappings +### Properties +* **entityType**: string: The entity type +* **fieldMappings**: [EntityFieldMapping](#entityfieldmapping)[]: Array of fields mapping for that entity type + +## BookmarkProperties +### Properties +* **created**: string: The time the bookmark was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **displayName**: string (Required): The display name of the bookmark +* **entityMappings**: [BookmarkEntityMappings](#bookmarkentitymappings)[]: Describes the entity mappings of the bookmark +* **eventTime**: string: The bookmark event time +* **incidentInfo**: [IncidentInfo](#incidentinfo): Describes related incident information for the bookmark +* **labels**: string[]: List of labels relevant to this bookmark +* **notes**: string: The notes of the bookmark +* **query**: string (Required): The query of the bookmark. +* **queryEndTime**: string: The end time for the query +* **queryResult**: string: The query result of the bookmark. +* **queryStartTime**: string: The start time for the query +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: A list of relevant mitre attacks +* **techniques**: string[]: A list of relevant mitre techniques +* **updated**: string: The last time the bookmark was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action + +## ClientInfo +### Properties +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. + +## CodelessConnectorPollingAuthProperties +### Properties +* **apiKeyIdentifier**: string: A prefix send in the header before the actual token +* **apiKeyName**: string: The header name which the token is sent with +* **authorizationEndpoint**: string: The endpoint used to authorize the user, used in Oauth 2.0 flow +* **authorizationEndpointQueryParameters**: any: Any object +* **authType**: string (Required): The authentication type +* **flowName**: string: Describes the flow name, for example 'AuthCode' for Oauth 2.0 +* **isApiKeyInPostPayload**: string: Marks if the key should sent in header +* **isClientSecretInHeader**: bool: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow +* **redirectionEndpoint**: string: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow +* **scope**: string: The OAuth token scope +* **tokenEndpoint**: string: The endpoint used to issue a token, used in Oauth 2.0 flow +* **tokenEndpointHeaders**: any: Any object +* **tokenEndpointQueryParameters**: any: Any object + +## CodelessConnectorPollingConfigProperties +### Properties +* **auth**: [CodelessConnectorPollingAuthProperties](#codelessconnectorpollingauthproperties) (Required): Describe the authentication properties needed to successfully authenticate with the server +* **isActive**: bool: The poller active status +* **paging**: [CodelessConnectorPollingPagingProperties](#codelessconnectorpollingpagingproperties): Describe the properties needed to make a pagination call +* **request**: [CodelessConnectorPollingRequestProperties](#codelessconnectorpollingrequestproperties) (Required): Describe the request properties needed to successfully pull from the server +* **response**: [CodelessConnectorPollingResponseProperties](#codelessconnectorpollingresponseproperties): Describes the response from the external server + +## CodelessConnectorPollingPagingProperties +### Properties +* **nextPageParaName**: string: Defines the name of a next page attribute +* **nextPageTokenJsonPath**: string: Defines the path to a next page token JSON +* **pageCountAttributePath**: string: Defines the path to a page count attribute +* **pageSize**: int: Defines the paging size +* **pageSizeParaName**: string: Defines the name of the page size parameter +* **pageTimeStampAttributePath**: string: Defines the path to a paging time stamp attribute +* **pageTotalCountAttributePath**: string: Defines the path to a page total count attribute +* **pagingType**: string (Required): Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp' +* **searchTheLatestTimeStampFromEventsList**: string: Determines whether to search for the latest time stamp in the events list + +## CodelessConnectorPollingRequestProperties +### Properties +* **apiEndpoint**: string (Required): Describe the endpoint we should pull the data from +* **endTimeAttributeName**: string: This will be used the query events from the end of the time window +* **headers**: any: Any object +* **httpMethod**: string (Required): The http method type we will use in the poll request, GET or POST +* **queryParameters**: any: Any object +* **queryParametersTemplate**: string: For advanced scenarios for example user name/password embedded in nested JSON payload +* **queryTimeFormat**: string (Required): The time format will be used the query events in a specific window +* **queryWindowInMin**: int (Required): The window interval we will use the pull the data +* **rateLimitQps**: int: Defines the rate limit QPS +* **retryCount**: int: Describe the amount of time we should try and poll the data in case of failure +* **startTimeAttributeName**: string: This will be used the query events from a start of the time window +* **timeoutInSeconds**: int: The number of seconds we will consider as a request timeout + +## CodelessConnectorPollingResponseProperties +### Properties +* **eventsJsonPaths**: string[] (Required): Describes the path we should extract the data in the response +* **isGzipCompressed**: bool: Describes if the data in the response is Gzip +* **successStatusJsonPath**: string: Describes the path we should extract the status code in the response +* **successStatusValue**: string: Describes the path we should extract the status value in the response + +## CodelessParameters +### Properties +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade + +## CodelessUiConnectorConfigProperties +### Properties +* **availability**: [Availability](#availability) (Required): Connector Availability Status +* **connectivityCriteria**: [CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem](#codelessuiconnectorconfigpropertiesconnectivitycriteriaitem)[] (Required): Define the way the connector check connectivity +* **customImage**: string: An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery +* **dataTypes**: [CodelessUiConnectorConfigPropertiesDataTypesItem](#codelessuiconnectorconfigpropertiesdatatypesitem)[] (Required): Data types to check for last data received +* **descriptionMarkdown**: string (Required): Connector description +* **graphQueries**: [CodelessUiConnectorConfigPropertiesGraphQueriesItem](#codelessuiconnectorconfigpropertiesgraphqueriesitem)[] (Required): The graph query to show the current data status +* **graphQueriesTableName**: string (Required): Name of the table the connector will insert the data to +* **instructionSteps**: [CodelessUiConnectorConfigPropertiesInstructionStepsItem](#codelessuiconnectorconfigpropertiesinstructionstepsitem)[] (Required): Instruction steps to enable the connector +* **permissions**: [Permissions](#permissions) (Required): Permissions required for the connector +* **publisher**: string (Required): Connector publisher name +* **sampleQueries**: [CodelessUiConnectorConfigPropertiesSampleQueriesItem](#codelessuiconnectorconfigpropertiessamplequeriesitem)[] (Required): The sample queries for the connector +* **title**: string (Required): Connector blade title + +## CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem +### Properties +* **type**: 'IsConnectedQuery' | string: type of connectivity +* **value**: string[]: Queries for checking connectivity + +## CodelessUiConnectorConfigPropertiesDataTypesItem +### Properties +* **lastDataReceivedQuery**: string: Query for indicate last data received +* **name**: string: Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder + +## CodelessUiConnectorConfigPropertiesGraphQueriesItem +### Properties +* **baseQuery**: string: The base query for the graph +* **legend**: string: The legend for the graph +* **metricName**: string: the metric that the query is checking + +## CodelessUiConnectorConfigPropertiesInstructionStepsItem +### Properties +* **description**: string: Instruction step description +* **instructions**: [InstructionStepsInstructionsItem](#instructionstepsinstructionsitem)[]: Instruction step details +* **title**: string: Instruction step title + +## CodelessUiConnectorConfigPropertiesSampleQueriesItem +### Properties +* **description**: string: The sample query description +* **query**: string: the sample query + +## ContentPathMap +### Properties +* **contentType**: 'AnalyticRule' | 'Workbook' | string: The content type of a source control path. +* **path**: string: The path to the content. + +## DataConnectorDataTypeCommon +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Deployment +### Properties +* **deploymentId**: string: Deployment identifier. +* **deploymentLogsUrl**: string: Url to access repository action logs. +* **deploymentResult**: 'Canceled' | 'Failed' | 'Success' | string: Status while trying to fetch the deployment information. +* **deploymentState**: 'Canceling' | 'Completed' | 'In_Progress' | 'Queued' | string: The current state of the deployment. +* **deploymentTime**: string: The time when the deployment finished. + +## DeploymentInfo +### Properties +* **deployment**: [Deployment](#deployment): Description about a deployment. +* **deploymentFetchStatus**: 'NotFound' | 'Success' | 'Unauthorized' | string: Status while trying to fetch the deployment information. +* **message**: string: Additional details about the deployment that can be shown to the user. + +## Dynamics365DataConnectorDataTypes +### Properties +* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. + +## Dynamics365DataConnectorDataTypesDynamics365CdsActivities +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Dynamics365DataConnectorProperties +### Properties +* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## EntityAnalyticsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## EntityCommonPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## EntityFieldMapping +### Properties +* **identifier**: string: Alert V3 identifier +* **value**: string: The value of the identifier + +## EntityMapping +### Properties +* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The V3 type of the mapped entity +* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping + +## EventGroupingSettings +### Properties +* **aggregationKind**: 'AlertPerResult' | 'SingleAlert' | string: The event grouping aggregation kinds + +## ExpansionEntityQueriesProperties +### Properties +* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query +* **displayName**: string (ReadOnly): The query display name +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string (ReadOnly): The type of the entity +* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query +* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[] (ReadOnly): List of the desired output types to be constructed from the result +* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted + +## EyesOnSettingsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## FieldMapping +### Properties +* **columnName**: string: the column name to be mapped to the identifier +* **identifier**: string: the V3 identifier of the entity + +## FusionAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **scenarioExclusionPatterns**: [FusionScenarioExclusionPattern](#fusionscenarioexclusionpattern)[]: Configuration to exclude scenarios in fusion detection. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **sourceSettings**: [FusionSourceSettings](#fusionsourcesettings)[]: Configuration for all supported source signals in fusion detection. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## FusionScenarioExclusionPattern +### Properties +* **dateAddedInUTC**: string (Required): DateTime when scenario exclusion pattern is added in UTC. +* **exclusionPattern**: string (Required): Scenario exclusion pattern. + +## FusionSourceSettings +### Properties +* **enabled**: bool (Required): Determines whether this source signal is enabled or disabled in Fusion detection. +* **sourceName**: string (Required): Name of the Fusion source signal. Refer to Fusion alert rule template for supported values. +* **sourceSubTypes**: [FusionSourceSubTypeSetting](#fusionsourcesubtypesetting)[]: Configuration for all source subtypes under this source signal consumed in fusion detection. + +## FusionSourceSubTypeSetting +### Properties +* **enabled**: bool (Required): Determines whether this source subtype under source signal is enabled or disabled in Fusion detection. +* **severityFilters**: [FusionSubTypeSeverityFilter](#fusionsubtypeseverityfilter) (Required): Represents severity configuration for a source subtype consumed in Fusion detection. +* **sourceSubTypeDisplayName**: string (ReadOnly): The display name of source subtype under a source signal consumed in Fusion detection. +* **sourceSubTypeName**: string (Required): The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values. + +## FusionSubTypeSeverityFilter +### Properties +* **filters**: [FusionSubTypeSeverityFiltersItem](#fusionsubtypeseverityfiltersitem)[]: Individual Severity configuration settings for a given source subtype consumed in Fusion detection. +* **isSupported**: bool (ReadOnly): Determines whether this source subtype supports severity configuration or not. + +## FusionSubTypeSeverityFiltersItem +### Properties +* **enabled**: bool (Required): Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the alert + +## GitHubResourceInfo +### Properties +* **appInstallationId**: string: GitHub application installation id. + +## GroupingConfiguration +### Properties +* **enabled**: bool (Required): Grouping enabled +* **groupByAlertDetails**: 'DisplayName' | 'Severity' | string[]: A list of alert details to group by (when matchingMethod is Selected) +* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. +* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. +* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) +* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' | string (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. +* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents + +## IncidentAdditionalData +### Properties +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **providerIncidentUrl**: string (ReadOnly): The provider incident url to the incident in Microsoft 365 Defender portal +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics associated with incident +* **techniques**: string[] (ReadOnly): The techniques associated with incident's tactics' + +## IncidentCommentProperties +### Properties +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message + +## IncidentConfiguration +### Properties +* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule +* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. + +## IncidentInfo +### Properties +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident + +## IncidentLabel +### Properties +* **labelName**: string (Required): The name of the label +* **labelType**: 'AutoAssigned' | 'User' | string (ReadOnly): The type of the label + +## IncidentOwnerInfo +### Properties +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **ownerType**: 'Group' | 'Unknown' | 'User' | string (ReadOnly): The type of the owner the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. + +## IncidentProperties +### Properties +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **providerIncidentId**: string: The incident ID assigned by the incident provider +* **providerName**: string: The name of the source provider that generated the incident +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **teamInformation**: [TeamInformation](#teaminformation): Describes team information +* **title**: string (Required): The title of the incident + +## IncidentPropertiesAction +### Properties +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels to add to the incident +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string: The status of the incident + +## InstructionStepsInstructionsItem +### Properties +* **parameters**: any: Any object +* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' | string (Required): The kind of the setting + +## IoTDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## McasDataConnectorDataTypes +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. +* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. + +## McasDataConnectorProperties +### Properties +* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MdatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MetadataAuthor +### Properties +* **email**: string: Email of author contact +* **link**: string: Link for author/vendor page +* **name**: string: Name of the author. Company or person. + +## MetadataCategories +### Properties +* **domains**: string[]: domain for the solution content item +* **verticals**: string[]: Industry verticals for the solution content item + +## MetadataDependencies +### Properties +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'AutomationRule' | 'AzureFunction' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'LogicAppsCustomConnector' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string: The kind of content the metadata is for. +* **name**: string: Name of the content item +* **operator**: 'AND' | 'OR' | string: Operator used for list of dependencies in criteria array. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks + +## MetadataProperties +### Properties +* **author**: [MetadataAuthor](#metadataauthor): Publisher or creator of the content item. +* **categories**: [MetadataCategories](#metadatacategories): ies for the solution content item +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **contentSchemaVersion**: string: Schema version of the content. Can be used to distinguish between different flow based on the schema version +* **customVersion**: string: The custom version of the content. A optional free text +* **dependencies**: [MetadataDependencies](#metadatadependencies): Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. +* **firstPublishDate**: string: first publish date of solution content item +* **icon**: string: the icon identifier. this id can later be fetched from the solution template +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'AutomationRule' | 'AzureFunction' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'LogicAppsCustomConnector' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string (Required): The kind of content the metadata is for. +* **lastPublishDate**: string: last publish date of solution content item +* **parentId**: string (Required): Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group) +* **previewImages**: string[]: preview image file names. These will be taken from the solution artifacts +* **previewImagesDark**: string[]: preview image file names. These will be taken from the solution artifacts. used for dark theme support +* **providers**: string[]: Providers for the solution content item +* **source**: [MetadataSource](#metadatasource): The original source of the content item, where it comes from. +* **support**: [MetadataSupport](#metadatasupport): Support information for the content item. +* **threatAnalysisTactics**: string[]: the tactics the resource covers +* **threatAnalysisTechniques**: string[]: the techniques the resource covers, these have to be aligned with the tactics being used +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks + +## MetadataSource +### Properties +* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' | string (Required): Source type of the content +* **name**: string: Name of the content source. The repo name, solution name, LA workspace name etc. +* **sourceId**: string: ID of the content source. The solution ID, workspace ID, etc + +## MetadataSupport +### Properties +* **email**: string: Email of support contact +* **link**: string: Link for support help, like to support page to open a ticket etc. +* **name**: string: Name of the support contact. Company or person. +* **tier**: 'Community' | 'Microsoft' | 'Partner' | string (Required): Type of support for content item + +## MicrosoftSecurityIncidentCreationAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated + +## MLBehaviorAnalyticsAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## MstiDataConnectorDataTypes +### Properties +* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. +* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. + +## MstiDataConnectorDataTypesBingSafetyPhishingURL +### Properties +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed +### Properties +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MstiDataConnectorProperties +### Properties +* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MTPDataConnectorDataTypes +### Properties +* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. + +## MTPDataConnectorDataTypesIncidents +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MTPDataConnectorProperties +### Properties +* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## NrtAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [NrtAlertRulePropertiesCustomDetails](#nrtalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string (Required): The query that creates alerts for this rule. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: The tactics of the alert rule +* **techniques**: string[]: The techniques of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> + +## NrtAlertRulePropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Office365ProjectConnectorDataTypes +### Properties +* **logs**: [Office365ProjectConnectorDataTypesLogs](#office365projectconnectordatatypeslogs) (Required): Logs data type. + +## Office365ProjectConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Office365ProjectDataConnectorProperties +### Properties +* **dataTypes**: [Office365ProjectConnectorDataTypes](#office365projectconnectordatatypes) (Required): The available data types for Office Microsoft Project data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeATPDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeDataConnectorDataTypes +### Properties +* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. +* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. +* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. + +## OfficeDataConnectorDataTypesExchange +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesSharePoint +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesTeams +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorProperties +### Properties +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeIRMDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficePowerBIConnectorDataTypes +### Properties +* **logs**: [OfficePowerBIConnectorDataTypesLogs](#officepowerbiconnectordatatypeslogs) (Required): Logs data type. + +## OfficePowerBIConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficePowerBIDataConnectorProperties +### Properties +* **dataTypes**: [OfficePowerBIConnectorDataTypes](#officepowerbiconnectordatatypes) (Required): The available data types for Office Microsoft PowerBI data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## Permissions +### Properties +* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector +* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector + +## PermissionsCustomsItem +### Properties +* **description**: string: Customs permissions description +* **name**: string: Customs permissions name + +## PermissionsResourceProviderItem +### Properties +* **permissionsDisplayText**: string: Permission description text +* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings' | string: Provider name +* **providerDisplayName**: string: Permission provider display name +* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector +* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace' | string: Permission provider scope + +## PlaybookActionProperties +### Properties +* **logicAppResourceId**: string: The resource id of the playbook resource +* **tenantId**: string: The tenant id of the playbook resource + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource + +## Repository +### Properties +* **branch**: string: Branch name of repository. +* **deploymentLogsUrl**: string: Url to access repository action logs. +* **displayUrl**: string: Display url of repository. +* **pathMapping**: [ContentPathMap](#contentpathmap)[]: Dictionary of source control content type and path mapping. +* **url**: string: Url of repository. + +## RepositoryResourceInfo +### Properties +* **azureDevOpsResourceInfo**: [AzureDevOpsResourceInfo](#azuredevopsresourceinfo): Resources created in Azure DevOps repository. +* **gitHubResourceInfo**: [GitHubResourceInfo](#githubresourceinfo): Resources created in GitHub repository. +* **webhook**: [Webhook](#webhook): Detail about the webhook object. + +## RequiredPermissions +### Properties +* **action**: bool: action permission +* **delete**: bool: delete permission +* **read**: bool: read permission +* **write**: bool: write permission + +## ScheduledAlertRuleCommonPropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScheduledAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [ScheduledAlertRuleCommonPropertiesCustomDetails](#scheduledalertrulecommonpropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: The tactics of the alert rule +* **techniques**: string[]: The techniques of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. + +## SentinelOnboardingStateProperties +### Properties +* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting + +## SourceControlProperties +### Properties +* **contentTypes**: 'AnalyticRule' | 'Workbook' | string[] (Required): Array of source control content types. +* **description**: string: A description of the source control +* **displayName**: string (Required): The display name of the source control +* **id**: string: The id (a Guid) of the source control +* **lastDeploymentInfo**: [DeploymentInfo](#deploymentinfo): Information regarding a deployment. +* **repository**: [Repository](#repository) (Required): metadata of a repository. +* **repositoryResourceInfo**: [RepositoryResourceInfo](#repositoryresourceinfo): Resources created in user's repository for the source-control. +* **repoType**: 'DevOps' | 'Github' | string (Required): The type of repository. +* **version**: 'V1' | 'V2' | string: The version of the source control. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TeamInformation +### Properties +* **description**: string (ReadOnly): The description of the team +* **name**: string (ReadOnly): The name of the team +* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team +* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created +* **teamId**: string (ReadOnly): Team ID + +## ThreatIntelligenceAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## ThreatIntelligenceExternalReference +### Properties +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL + +## ThreatIntelligenceExternalReferenceHashes +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThreatIntelligenceGranularMarkingModel +### Properties +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors + +## ThreatIntelligenceIndicatorProperties +### Properties +* **additionalData**: [EntityCommonPropertiesAdditionalData](#entitycommonpropertiesadditionaldata) (ReadOnly, WriteOnly): A bag of custom fields that should be part of the entity and will be presented to the user. +* **confidence**: int (WriteOnly): Confidence of threat intelligence entity +* **created**: string (WriteOnly): Created by +* **createdByRef**: string (WriteOnly): Created by reference of threat intelligence entity +* **defanged**: bool (WriteOnly): Is threat intelligence entity defanged +* **description**: string (WriteOnly): Description of a threat intelligence entity +* **displayName**: string (WriteOnly): Display name of a threat intelligence entity +* **extensions**: [ThreatIntelligenceIndicatorPropertiesExtensions](#threatintelligenceindicatorpropertiesextensions) (WriteOnly): Extensions map +* **externalId**: string (WriteOnly): External ID of threat intelligence entity +* **externalLastUpdatedTimeUtc**: string (WriteOnly): External last updated time in UTC +* **externalReferences**: [ThreatIntelligenceExternalReference](#threatintelligenceexternalreference)[] (WriteOnly): External References +* **friendlyName**: string (ReadOnly, WriteOnly): The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. +* **granularMarkings**: [ThreatIntelligenceGranularMarkingModel](#threatintelligencegranularmarkingmodel)[] (WriteOnly): Granular Markings +* **indicatorTypes**: string[] (WriteOnly): Indicator types of threat intelligence entities +* **killChainPhases**: [ThreatIntelligenceKillChainPhase](#threatintelligencekillchainphase)[] (WriteOnly): Kill chain phases +* **labels**: string[] (WriteOnly): Labels of threat intelligence entity +* **language**: string (WriteOnly): Language of threat intelligence entity +* **lastUpdatedTimeUtc**: string (WriteOnly): Last updated time in UTC +* **modified**: string (WriteOnly): Modified by +* **objectMarkingRefs**: string[] (WriteOnly): Threat intelligence entity object marking references +* **parsedPattern**: [ThreatIntelligenceParsedPattern](#threatintelligenceparsedpattern)[] (WriteOnly): Parsed patterns +* **pattern**: string (WriteOnly): Pattern of a threat intelligence entity +* **patternType**: string (WriteOnly): Pattern type of a threat intelligence entity +* **patternVersion**: string (WriteOnly): Pattern version of a threat intelligence entity +* **revoked**: bool (WriteOnly): Is threat intelligence entity revoked +* **source**: string (WriteOnly): Source of a threat intelligence entity +* **threatIntelligenceTags**: string[] (WriteOnly): List of tags +* **threatTypes**: string[] (WriteOnly): Threat types +* **validFrom**: string (WriteOnly): Valid from +* **validUntil**: string (WriteOnly): Valid until + +## ThreatIntelligenceIndicatorPropertiesExtensions +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## ThreatIntelligenceKillChainPhase +### Properties +* **killChainName**: string (WriteOnly): Kill chainName name +* **phaseName**: string (WriteOnly): Phase name + +## ThreatIntelligenceParsedPattern +### Properties +* **patternTypeKey**: string (WriteOnly): Pattern type key +* **patternTypeValues**: [ThreatIntelligenceParsedPatternTypeValue](#threatintelligenceparsedpatterntypevalue)[] (WriteOnly): Pattern type keys + +## ThreatIntelligenceParsedPatternTypeValue +### Properties +* **value**: string (WriteOnly): Value of parsed pattern +* **valueType**: string (WriteOnly): Type of the value + +## TIDataConnectorDataTypes +### Properties +* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. + +## TIDataConnectorDataTypesIndicators +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TIDataConnectorProperties +### Properties +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## TiTaxiiDataConnectorDataTypes +### Properties +* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. + +## TiTaxiiDataConnectorDataTypesTaxiiClient +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TiTaxiiDataConnectorProperties +### Properties +* **collectionId**: string: The collection id of the TAXII server. +* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. +* **friendlyName**: string: The friendly name for the TAXII server. +* **password**: string: The password for the TAXII server. +* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' | string (Required): The polling frequency for the TAXII server. +* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. +* **taxiiServer**: string: The API root for the TAXII server. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **userName**: string: The userName for the TAXII server. +* **workspaceId**: string: The workspace id. + +## UebaProperties +### Properties +* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs' | string[]: The relevant data sources that enriched by ueba + +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: [WatchlistItemPropertiesEntityMapping](#watchlistitempropertiesentitymapping): key-value pairs for a watchlist item entity mapping +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: [WatchlistItemPropertiesItemsKeyValue](#watchlistitempropertiesitemskeyvalue) (Required): key-value pairs for a watchlist item +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + +## WatchlistItemPropertiesEntityMapping +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WatchlistItemPropertiesItemsKeyValue +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WatchlistProperties +### Properties +* **contentType**: string: The content type of the raw content. Example : text/csv or text/tsv +* **created**: string: The time the watchlist was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **defaultDuration**: string: The default duration of a watchlist (in ISO 8601 duration format) +* **description**: string: A description of the watchlist +* **displayName**: string (Required): The display name of the watchlist +* **isDeleted**: bool: A flag that indicates if the watchlist is deleted or not +* **itemsSearchKey**: string (Required): The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address. +* **labels**: string[]: List of labels relevant to this watchlist +* **numberOfLinesToSkip**: int: The number of lines in a csv/tsv content to skip before the header +* **provider**: string (Required): The provider of the watchlist +* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **rawContent**: string: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint +* **sasUri**: string: The Shared Access Signature (SAS) URI under which the large csv watchlist file is located and from which the watchlist and its items will be created +* **source**: string: The filename of the watchlist, called 'source' +* **sourceType**: 'Local file' | 'Remote storage' | string: The sourceType of the watchlist +* **tenantId**: string: The tenantId where the watchlist belongs to +* **updated**: string: The last time the watchlist was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **uploadStatus**: string: The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted +* **watchlistAlias**: string: The alias of the watchlist +* **watchlistId**: string: The id (a Guid) of the watchlist +* **watchlistType**: string: The type of the watchlist + +## Webhook +### Properties +* **rotateWebhookSecret**: bool: A flag to instruct the backend service to rotate webhook secret. +* **webhookId**: string: Unique identifier for the webhook. +* **webhookSecretUpdateTime**: string: Time when the webhook secret was updated. +* **webhookUrl**: string: URL that gets invoked by the webhook. + diff --git a/generated/securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json b/generated/securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json new file mode 100644 index 0000000000..ec672187c0 --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2022-04-01-preview/types.json @@ -0,0 +1 @@ +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules"}},{"6":{"Value":"2022-04-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/alertRules","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Fusion":22,"MLBehaviorAnalytics":64,"MicrosoftSecurityIncidentCreation":92,"NRT":111,"Scheduled":195,"ThreatIntelligence":234}}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":16,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":21,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[12,13,14,15,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[17,18,19,20,4]}},{"2":{"Name":"FusionAlertRule","Properties":{"properties":{"Type":23,"Flags":0,"Description":"Fusion alert rule base property bag."},"kind":{"Type":63,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"FusionAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"sourceSettings":{"Type":35,"Flags":0,"Description":"Configuration for all supported source signals in fusion detection."},"scenarioExclusionPatterns":{"Type":37,"Flags":0,"Description":"Configuration to exclude scenarios in fusion detection."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":42,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":61,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":62,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"2":{"Name":"FusionSourceSettings","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this source signal is enabled or disabled in Fusion detection."},"sourceName":{"Type":4,"Flags":1,"Description":"Name of the Fusion source signal. Refer to Fusion alert rule template for supported values."},"sourceSubTypes":{"Type":34,"Flags":0,"Description":"Configuration for all source subtypes under this source signal consumed in fusion detection."}}}},{"2":{"Name":"FusionSourceSubTypeSetting","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this source subtype under source signal is enabled or disabled in Fusion detection."},"sourceSubTypeName":{"Type":4,"Flags":1,"Description":"The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values."},"sourceSubTypeDisplayName":{"Type":4,"Flags":2,"Description":"The display name of source subtype under a source signal consumed in Fusion detection."},"severityFilters":{"Type":26,"Flags":1,"Description":"Represents severity configuration for a source subtype consumed in Fusion detection."}}}},{"2":{"Name":"FusionSubTypeSeverityFilter","Properties":{"isSupported":{"Type":2,"Flags":2,"Description":"Determines whether this source subtype supports severity configuration or not."},"filters":{"Type":33,"Flags":0,"Description":"Individual Severity configuration settings for a given source subtype consumed in Fusion detection."}}}},{"2":{"Name":"FusionSubTypeSeverityFiltersItem","Properties":{"severity":{"Type":32,"Flags":1,"Description":"The severity of the alert"},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection."}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[28,29,30,31,4]}},{"3":{"ItemType":27}},{"3":{"ItemType":25}},{"3":{"ItemType":24}},{"2":{"Name":"FusionScenarioExclusionPattern","Properties":{"exclusionPattern":{"Type":4,"Flags":1,"Description":"Scenario exclusion pattern."},"dateAddedInUTC":{"Type":4,"Flags":1,"Description":"DateTime when scenario exclusion pattern is added in UTC."}}}},{"3":{"ItemType":36}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[38,39,40,41,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,4]}},{"3":{"ItemType":60}},{"3":{"ItemType":4}},{"6":{"Value":"Fusion"}},{"2":{"Name":"MLBehaviorAnalyticsAlertRule","Properties":{"properties":{"Type":65,"Flags":0,"Description":"MLBehaviorAnalytics alert rule base property bag."},"kind":{"Type":91,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MLBehaviorAnalyticsAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"severity":{"Type":70,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":89,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":90,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[66,67,68,69,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,4]}},{"3":{"ItemType":88}},{"3":{"ItemType":4}},{"6":{"Value":"MLBehaviorAnalytics"}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRule","Properties":{"properties":{"Type":93,"Flags":0,"Description":"MicrosoftSecurityIncidentCreation rule property bag."},"kind":{"Type":110,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"MicrosoftSecurityIncidentCreationAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"displayNamesFilter":{"Type":94,"Flags":0,"Description":"the alerts' displayNames on which the cases will be generated"},"displayNamesExcludeFilter":{"Type":95,"Flags":0,"Description":"the alerts' displayNames on which the cases will not be generated"},"productFilter":{"Type":103,"Flags":1,"Description":"The alerts' productName on which the cases will be generated"},"severitiesFilter":{"Type":109,"Flags":0,"Description":"the alerts' severities on which the cases will be generated"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"Microsoft Cloud App Security"}},{"6":{"Value":"Azure Security Center"}},{"6":{"Value":"Azure Advanced Threat Protection"}},{"6":{"Value":"Azure Active Directory Identity Protection"}},{"6":{"Value":"Azure Security Center for IoT"}},{"6":{"Value":"Office 365 Advanced Threat Protection"}},{"6":{"Value":"Microsoft Defender Advanced Threat Protection"}},{"5":{"Elements":[96,97,98,99,100,101,102,4]}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[104,105,106,107,4]}},{"3":{"ItemType":108}},{"6":{"Value":"MicrosoftSecurityIncidentCreation"}},{"2":{"Name":"NrtAlertRule","Properties":{"properties":{"Type":112,"Flags":0,"Description":"Nrt alert rule base property bag."},"kind":{"Type":194,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"NrtAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"query":{"Type":4,"Flags":1,"Description":"The query that creates alerts for this rule."},"tactics":{"Type":131,"Flags":0,"Description":"The tactics of the alert rule"},"techniques":{"Type":132,"Flags":0,"Description":"The techniques of the alert rule"},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"severity":{"Type":137,"Flags":1,"Description":"The severity of the alert"},"incidentConfiguration":{"Type":138,"Flags":0,"Description":"Incident Configuration property bag."},"customDetails":{"Type":169,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":192,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":193,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,4]}},{"3":{"ItemType":130}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[133,134,135,136,4]}},{"2":{"Name":"IncidentConfiguration","Properties":{"createIncident":{"Type":2,"Flags":1,"Description":"Create incidents from alerts triggered by this analytics rule"},"groupingConfiguration":{"Type":139,"Flags":0,"Description":"Grouping configuration property bag."}}}},{"2":{"Name":"GroupingConfiguration","Properties":{"enabled":{"Type":2,"Flags":1,"Description":"Grouping enabled"},"reopenClosedIncident":{"Type":2,"Flags":1,"Description":"Re-open closed matching incidents"},"lookbackDuration":{"Type":4,"Flags":1,"Description":"Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)"},"matchingMethod":{"Type":143,"Flags":1,"Description":"Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty."},"groupByEntities":{"Type":163,"Flags":0,"Description":"A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used."},"groupByAlertDetails":{"Type":167,"Flags":0,"Description":"A list of alert details to group by (when matchingMethod is Selected)"},"groupByCustomDetails":{"Type":168,"Flags":0,"Description":"A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used."}}}},{"6":{"Value":"AllEntities"}},{"6":{"Value":"AnyAlert"}},{"6":{"Value":"Selected"}},{"5":{"Elements":[140,141,142,4]}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,4]}},{"3":{"ItemType":162}},{"6":{"Value":"DisplayName"}},{"6":{"Value":"Severity"}},{"5":{"Elements":[164,165,4]}},{"3":{"ItemType":166}},{"3":{"ItemType":4}},{"2":{"Name":"NrtAlertRulePropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"EntityMapping","Properties":{"entityType":{"Type":189,"Flags":0,"Description":"The V3 type of the mapped entity"},"fieldMappings":{"Type":191,"Flags":0,"Description":"array of field mappings for the given entity mapping"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"File"}},{"6":{"Value":"Process"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,4]}},{"2":{"Name":"FieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"the V3 identifier of the entity"},"columnName":{"Type":4,"Flags":0,"Description":"the column name to be mapped to the identifier"}}}},{"3":{"ItemType":190}},{"3":{"ItemType":170}},{"2":{"Name":"AlertDetailsOverride","Properties":{"alertDisplayNameFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert name"},"alertDescriptionFormat":{"Type":4,"Flags":0,"Description":"the format containing columns name(s) to override the alert description"},"alertTacticsColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert tactics from"},"alertSeverityColumnName":{"Type":4,"Flags":0,"Description":"the column name to take the alert severity from"}}}},{"6":{"Value":"NRT"}},{"2":{"Name":"ScheduledAlertRule","Properties":{"properties":{"Type":196,"Flags":0,"Description":"Scheduled alert rule base property bag."},"kind":{"Type":233,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ScheduledAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":0,"Description":"The Name of the alert rule template used to create this rule."},"templateVersion":{"Type":4,"Flags":0,"Description":"The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>"},"description":{"Type":4,"Flags":0,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":1,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert rule has been modified."},"suppressionDuration":{"Type":4,"Flags":1,"Description":"The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered."},"suppressionEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the suppression for this alert rule is enabled or disabled."},"tactics":{"Type":215,"Flags":0,"Description":"The tactics of the alert rule"},"techniques":{"Type":216,"Flags":0,"Description":"The techniques of the alert rule"},"incidentConfiguration":{"Type":138,"Flags":0,"Description":"Incident Configuration property bag."},"query":{"Type":4,"Flags":0,"Description":"The query that creates alerts for this rule."},"queryFrequency":{"Type":4,"Flags":0,"Description":"The frequency (in ISO 8601 duration format) for this alert rule to run."},"queryPeriod":{"Type":4,"Flags":0,"Description":"The period (in ISO 8601 duration format) that this alert rule looks at."},"severity":{"Type":221,"Flags":0,"Description":"The severity of the alert"},"triggerOperator":{"Type":226,"Flags":0,"Description":"The operation against the threshold that triggers alert rule."},"triggerThreshold":{"Type":3,"Flags":0,"Description":"The threshold triggers this alert rule."},"eventGroupingSettings":{"Type":227,"Flags":0,"Description":"Event grouping settings property bag."},"customDetails":{"Type":231,"Flags":0,"Description":"Dictionary of string key-value pairs of columns to be attached to the alert"},"entityMappings":{"Type":232,"Flags":0,"Description":"List of entity mappings of the alert rule"},"alertDetailsOverride":{"Type":193,"Flags":0,"Description":"Settings for how to dynamically override alert static details"}}}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,4]}},{"3":{"ItemType":214}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[217,218,219,220,4]}},{"6":{"Value":"GreaterThan"}},{"6":{"Value":"LessThan"}},{"6":{"Value":"Equal"}},{"6":{"Value":"NotEqual"}},{"5":{"Elements":[222,223,224,225]}},{"2":{"Name":"EventGroupingSettings","Properties":{"aggregationKind":{"Type":230,"Flags":0,"Description":"The event grouping aggregation kinds"}}}},{"6":{"Value":"SingleAlert"}},{"6":{"Value":"AlertPerResult"}},{"5":{"Elements":[228,229,4]}},{"2":{"Name":"ScheduledAlertRuleCommonPropertiesCustomDetails","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":170}},{"6":{"Value":"Scheduled"}},{"2":{"Name":"ThreatIntelligenceAlertRule","Properties":{"properties":{"Type":235,"Flags":0,"Description":"Threat Intelligence alert rule base property bag."},"kind":{"Type":261,"Flags":1,"Description":"The kind of the alert rule"}}}},{"2":{"Name":"ThreatIntelligenceAlertRuleProperties","Properties":{"alertRuleTemplateName":{"Type":4,"Flags":1,"Description":"The Name of the alert rule template used to create this rule."},"description":{"Type":4,"Flags":2,"Description":"The description of the alert rule."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for alerts created by this alert rule."},"enabled":{"Type":2,"Flags":1,"Description":"Determines whether this alert rule is enabled or disabled."},"lastModifiedUtc":{"Type":4,"Flags":2,"Description":"The last time that this alert has been modified."},"severity":{"Type":240,"Flags":2,"Description":"The severity of the alert"},"tactics":{"Type":259,"Flags":2,"Description":"The tactics of the alert rule"},"techniques":{"Type":260,"Flags":2,"Description":"The techniques of the alert rule"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[236,237,238,239,4]}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,4]}},{"3":{"ItemType":258}},{"3":{"ItemType":4}},{"6":{"Value":"ThreatIntelligence"}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules@2022-04-01-preview","ScopeType":16,"Body":10}},{"6":{"Value":"Microsoft.SecurityInsights/alertRules/actions"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/alertRules/actions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":263,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":264,"Flags":10,"Description":"The resource api version"},"properties":{"Type":266,"Flags":0,"Description":"Action property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ActionRequestProperties","Properties":{"triggerUri":{"Type":4,"Flags":5,"Description":"Logic App Callback URL for this specific workflow."},"logicAppResourceId":{"Type":4,"Flags":1,"Description":"Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}."},"workflowId":{"Type":4,"Flags":2,"Description":"The name of the logic app's workflow."}}}},{"4":{"Name":"Microsoft.SecurityInsights/alertRules/actions@2022-04-01-preview","ScopeType":16,"Body":265}},{"6":{"Value":"Microsoft.SecurityInsights/automationRules"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/automationRules","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":268,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":269,"Flags":10,"Description":"The resource api version"},"properties":{"Type":271,"Flags":1,"Description":"Automation rule properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AutomationRuleProperties","Properties":{"displayName":{"Type":4,"Flags":1,"Description":"The display name of the automation rule"},"order":{"Type":3,"Flags":1,"Description":"The order of execution of the automation rule"},"triggeringLogic":{"Type":272,"Flags":1,"Description":"Describes automation rule triggering logic"},"actions":{"Type":383,"Flags":1,"Description":"The actions to execute when the automation rule is triggered"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the automation rule was updated"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the automation rule was created"},"lastModifiedBy":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"},"createdBy":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"2":{"Name":"AutomationRuleTriggeringLogic","Properties":{"isEnabled":{"Type":2,"Flags":1,"Description":"Determines whether the automation rule is enabled or disabled"},"expirationTimeUtc":{"Type":4,"Flags":0,"Description":"Determines when the automation rule should automatically expire and be disabled."},"triggersOn":{"Type":274,"Flags":1},"triggersWhen":{"Type":276,"Flags":1},"conditions":{"Type":346,"Flags":0,"Description":"The conditions to evaluate to determine if the automation rule should be triggered on a given object"}}}},{"6":{"Value":"Incidents"}},{"5":{"Elements":[273,4]}},{"6":{"Value":"Created"}},{"5":{"Elements":[275,4]}},{"7":{"Name":"AutomationRuleCondition","Discriminator":"conditionType","BaseProperties":{},"Elements":{"Property":278}}},{"2":{"Name":"PropertyConditionProperties","Properties":{"conditionProperties":{"Type":279,"Flags":0},"conditionType":{"Type":345,"Flags":1}}}},{"2":{"Name":"AutomationRulePropertyValuesCondition","Properties":{"propertyName":{"Type":334,"Flags":0,"Description":"The property to evaluate in an automation rule property condition"},"operator":{"Type":343,"Flags":0},"propertyValues":{"Type":344,"Flags":0,"Description":"Array of AutomationRulePropertyValuesConditionPropertyValuesItem"}}}},{"6":{"Value":"IncidentTitle"}},{"6":{"Value":"IncidentDescription"}},{"6":{"Value":"IncidentSeverity"}},{"6":{"Value":"IncidentStatus"}},{"6":{"Value":"IncidentRelatedAnalyticRuleIds"}},{"6":{"Value":"IncidentTactics"}},{"6":{"Value":"IncidentLabel"}},{"6":{"Value":"IncidentProviderName"}},{"6":{"Value":"AccountAadTenantId"}},{"6":{"Value":"AccountAadUserId"}},{"6":{"Value":"AccountName"}},{"6":{"Value":"AccountNTDomain"}},{"6":{"Value":"AccountPUID"}},{"6":{"Value":"AccountSid"}},{"6":{"Value":"AccountObjectGuid"}},{"6":{"Value":"AccountUPNSuffix"}},{"6":{"Value":"AlertProductNames"}},{"6":{"Value":"AzureResourceResourceId"}},{"6":{"Value":"AzureResourceSubscriptionId"}},{"6":{"Value":"CloudApplicationAppId"}},{"6":{"Value":"CloudApplicationAppName"}},{"6":{"Value":"DNSDomainName"}},{"6":{"Value":"FileDirectory"}},{"6":{"Value":"FileName"}},{"6":{"Value":"FileHashValue"}},{"6":{"Value":"HostAzureID"}},{"6":{"Value":"HostName"}},{"6":{"Value":"HostNetBiosName"}},{"6":{"Value":"HostNTDomain"}},{"6":{"Value":"HostOSVersion"}},{"6":{"Value":"IoTDeviceId"}},{"6":{"Value":"IoTDeviceName"}},{"6":{"Value":"IoTDeviceType"}},{"6":{"Value":"IoTDeviceVendor"}},{"6":{"Value":"IoTDeviceModel"}},{"6":{"Value":"IoTDeviceOperatingSystem"}},{"6":{"Value":"IPAddress"}},{"6":{"Value":"MailboxDisplayName"}},{"6":{"Value":"MailboxPrimaryAddress"}},{"6":{"Value":"MailboxUPN"}},{"6":{"Value":"MailMessageDeliveryAction"}},{"6":{"Value":"MailMessageDeliveryLocation"}},{"6":{"Value":"MailMessageRecipient"}},{"6":{"Value":"MailMessageSenderIP"}},{"6":{"Value":"MailMessageSubject"}},{"6":{"Value":"MailMessageP1Sender"}},{"6":{"Value":"MailMessageP2Sender"}},{"6":{"Value":"MalwareCategory"}},{"6":{"Value":"MalwareName"}},{"6":{"Value":"ProcessCommandLine"}},{"6":{"Value":"ProcessId"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValueData"}},{"6":{"Value":"Url"}},{"5":{"Elements":[280,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,4]}},{"6":{"Value":"Equals"}},{"6":{"Value":"NotEquals"}},{"6":{"Value":"Contains"}},{"6":{"Value":"NotContains"}},{"6":{"Value":"StartsWith"}},{"6":{"Value":"NotStartsWith"}},{"6":{"Value":"EndsWith"}},{"6":{"Value":"NotEndsWith"}},{"5":{"Elements":[335,336,337,338,339,340,341,342,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Property"}},{"3":{"ItemType":277}},{"7":{"Name":"AutomationRuleAction","Discriminator":"actionType","BaseProperties":{"order":{"Type":3,"Flags":1}},"Elements":{"ModifyProperties":348,"RunPlaybook":380}}},{"2":{"Name":"AutomationRuleModifyPropertiesAction","Properties":{"actionConfiguration":{"Type":349,"Flags":0},"actionType":{"Type":379,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"IncidentPropertiesAction","Properties":{"severity":{"Type":354,"Flags":0,"Description":"The severity of the incident"},"status":{"Type":358,"Flags":0,"Description":"The status of the incident"},"classification":{"Type":363,"Flags":0,"Description":"The reason the incident was closed"},"classificationReason":{"Type":368,"Flags":0,"Description":"The classification reason the incident was closed with"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"owner":{"Type":369,"Flags":0,"Description":"Information on the user an incident is assigned to"},"labels":{"Type":378,"Flags":0,"Description":"List of labels to add to the incident"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[350,351,352,353,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[355,356,357,4]}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[359,360,361,362,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[364,365,366,367,4]}},{"2":{"Name":"IncidentOwnerInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the user the incident is assigned to."},"assignedTo":{"Type":4,"Flags":0,"Description":"The name of the user the incident is assigned to."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user the incident is assigned to."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the user the incident is assigned to."},"ownerType":{"Type":373,"Flags":0,"Description":"The type of the owner the incident is assigned to."}}}},{"6":{"Value":"Unknown"}},{"6":{"Value":"User"}},{"6":{"Value":"Group"}},{"5":{"Elements":[370,371,372,4]}},{"2":{"Name":"IncidentLabel","Properties":{"labelName":{"Type":4,"Flags":1,"Description":"The name of the label"},"labelType":{"Type":377,"Flags":2,"Description":"The type of the label"}}}},{"6":{"Value":"User"}},{"6":{"Value":"AutoAssigned"}},{"5":{"Elements":[375,376,4]}},{"3":{"ItemType":374}},{"6":{"Value":"ModifyProperties"}},{"2":{"Name":"AutomationRuleRunPlaybookAction","Properties":{"actionConfiguration":{"Type":381,"Flags":0},"actionType":{"Type":382,"Flags":1,"Description":"The type of the automation rule action"}}}},{"2":{"Name":"PlaybookActionProperties","Properties":{"logicAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the playbook resource"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenant id of the playbook resource"}}}},{"6":{"Value":"RunPlaybook"}},{"3":{"ItemType":347}},{"2":{"Name":"ClientInfo","Properties":{"email":{"Type":4,"Flags":0,"Description":"The email of the client."},"name":{"Type":4,"Flags":0,"Description":"The name of the client."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the client."},"userPrincipalName":{"Type":4,"Flags":0,"Description":"The user principal name of the client."}}}},{"4":{"Name":"Microsoft.SecurityInsights/automationRules@2022-04-01-preview","ScopeType":16,"Body":270}},{"6":{"Value":"Microsoft.SecurityInsights/incidents"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":386,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":387,"Flags":10,"Description":"The resource api version"},"properties":{"Type":389,"Flags":0,"Description":"Describes incident properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentProperties","Properties":{"additionalData":{"Type":390,"Flags":2,"Description":"Incident additional data property bag."},"classification":{"Type":416,"Flags":0,"Description":"The reason the incident was closed"},"classificationComment":{"Type":4,"Flags":0,"Description":"Describes the reason the incident was closed"},"classificationReason":{"Type":421,"Flags":0,"Description":"The classification reason the incident was closed with"},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the incident was created"},"description":{"Type":4,"Flags":0,"Description":"The description of the incident"},"firstActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the first activity in the incident"},"incidentUrl":{"Type":4,"Flags":2,"Description":"The deep-link url to the incident in Azure portal"},"incidentNumber":{"Type":3,"Flags":2,"Description":"A sequential number"},"labels":{"Type":422,"Flags":0,"Description":"List of labels relevant to this incident"},"providerName":{"Type":4,"Flags":0,"Description":"The name of the source provider that generated the incident"},"providerIncidentId":{"Type":4,"Flags":0,"Description":"The incident ID assigned by the incident provider"},"lastActivityTimeUtc":{"Type":4,"Flags":0,"Description":"The time of the last activity in the incident"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the incident was updated"},"owner":{"Type":369,"Flags":0,"Description":"Information on the user an incident is assigned to"},"relatedAnalyticRuleIds":{"Type":423,"Flags":2,"Description":"List of resource ids of Analytic rules related to the incident"},"severity":{"Type":428,"Flags":1,"Description":"The severity of the incident"},"status":{"Type":432,"Flags":1,"Description":"The status of the incident"},"teamInformation":{"Type":433,"Flags":0,"Description":"Describes team information"},"title":{"Type":4,"Flags":1,"Description":"The title of the incident"}}}},{"2":{"Name":"IncidentAdditionalData","Properties":{"alertsCount":{"Type":3,"Flags":2,"Description":"The number of alerts in the incident"},"bookmarksCount":{"Type":3,"Flags":2,"Description":"The number of bookmarks in the incident"},"commentsCount":{"Type":3,"Flags":2,"Description":"The number of comments in the incident"},"alertProductNames":{"Type":391,"Flags":2,"Description":"List of product names of alerts in the incident"},"providerIncidentUrl":{"Type":4,"Flags":2,"Description":"The provider incident url to the incident in Microsoft 365 Defender portal"},"tactics":{"Type":410,"Flags":2,"Description":"The tactics associated with incident"},"techniques":{"Type":411,"Flags":2,"Description":"The techniques associated with incident's tactics'"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,4]}},{"3":{"ItemType":409}},{"3":{"ItemType":4}},{"6":{"Value":"Undetermined"}},{"6":{"Value":"TruePositive"}},{"6":{"Value":"BenignPositive"}},{"6":{"Value":"FalsePositive"}},{"5":{"Elements":[412,413,414,415,4]}},{"6":{"Value":"SuspiciousActivity"}},{"6":{"Value":"SuspiciousButExpected"}},{"6":{"Value":"IncorrectAlertLogic"}},{"6":{"Value":"InaccurateData"}},{"5":{"Elements":[417,418,419,420,4]}},{"3":{"ItemType":374}},{"3":{"ItemType":4}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[424,425,426,427,4]}},{"6":{"Value":"New"}},{"6":{"Value":"Active"}},{"6":{"Value":"Closed"}},{"5":{"Elements":[429,430,431,4]}},{"2":{"Name":"TeamInformation","Properties":{"teamId":{"Type":4,"Flags":2,"Description":"Team ID"},"primaryChannelUrl":{"Type":4,"Flags":2,"Description":"The primary channel URL of the team"},"teamCreationTimeUtc":{"Type":4,"Flags":2,"Description":"The time the team was created"},"name":{"Type":4,"Flags":2,"Description":"The name of the team"},"description":{"Type":4,"Flags":2,"Description":"The description of the team"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents@2022-04-01-preview","ScopeType":16,"Body":388}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":435,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":436,"Flags":10,"Description":"The resource api version"},"properties":{"Type":438,"Flags":0,"Description":"Describes bookmark properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BookmarkProperties","Properties":{"created":{"Type":4,"Flags":0,"Description":"The time the bookmark was created"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the bookmark"},"labels":{"Type":440,"Flags":0,"Description":"List of labels relevant to this bookmark"},"notes":{"Type":4,"Flags":0,"Description":"The notes of the bookmark"},"query":{"Type":4,"Flags":1,"Description":"The query of the bookmark."},"queryResult":{"Type":4,"Flags":0,"Description":"The query result of the bookmark."},"updated":{"Type":4,"Flags":0,"Description":"The last time the bookmark was updated"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"eventTime":{"Type":4,"Flags":0,"Description":"The bookmark event time"},"queryStartTime":{"Type":4,"Flags":0,"Description":"The start time for the query"},"queryEndTime":{"Type":4,"Flags":0,"Description":"The end time for the query"},"incidentInfo":{"Type":441,"Flags":0,"Description":"Describes related incident information for the bookmark"},"entityMappings":{"Type":450,"Flags":0,"Description":"Describes the entity mappings of the bookmark"},"tactics":{"Type":469,"Flags":0,"Description":"A list of relevant mitre attacks"},"techniques":{"Type":470,"Flags":0,"Description":"A list of relevant mitre techniques"}}}},{"2":{"Name":"UserInfo","Properties":{"email":{"Type":4,"Flags":2,"Description":"The email of the user."},"name":{"Type":4,"Flags":2,"Description":"The name of the user."},"objectId":{"Type":4,"Flags":0,"Description":"The object id of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IncidentInfo","Properties":{"incidentId":{"Type":4,"Flags":0,"Description":"Incident Id"},"severity":{"Type":446,"Flags":0,"Description":"The severity of the incident"},"title":{"Type":4,"Flags":0,"Description":"The title of the incident"},"relationName":{"Type":4,"Flags":0,"Description":"Relation Name"}}}},{"6":{"Value":"High"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Low"}},{"6":{"Value":"Informational"}},{"5":{"Elements":[442,443,444,445,4]}},{"2":{"Name":"BookmarkEntityMappings","Properties":{"entityType":{"Type":4,"Flags":0,"Description":"The entity type"},"fieldMappings":{"Type":449,"Flags":0,"Description":"Array of fields mapping for that entity type"}}}},{"2":{"Name":"EntityFieldMapping","Properties":{"identifier":{"Type":4,"Flags":0,"Description":"Alert V3 identifier"},"value":{"Type":4,"Flags":0,"Description":"The value of the identifier"}}}},{"3":{"ItemType":448}},{"3":{"ItemType":447}},{"6":{"Value":"Reconnaissance"}},{"6":{"Value":"ResourceDevelopment"}},{"6":{"Value":"InitialAccess"}},{"6":{"Value":"Execution"}},{"6":{"Value":"Persistence"}},{"6":{"Value":"PrivilegeEscalation"}},{"6":{"Value":"DefenseEvasion"}},{"6":{"Value":"CredentialAccess"}},{"6":{"Value":"Discovery"}},{"6":{"Value":"LateralMovement"}},{"6":{"Value":"Collection"}},{"6":{"Value":"Exfiltration"}},{"6":{"Value":"CommandAndControl"}},{"6":{"Value":"Impact"}},{"6":{"Value":"PreAttack"}},{"6":{"Value":"ImpairProcessControl"}},{"6":{"Value":"InhibitResponseFunction"}},{"5":{"Elements":[451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,4]}},{"3":{"ItemType":468}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks@2022-04-01-preview","ScopeType":16,"Body":437}},{"6":{"Value":"Microsoft.SecurityInsights/bookmarks/relations"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/bookmarks/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":472,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":473,"Flags":10,"Description":"The resource api version"},"properties":{"Type":475,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelationProperties","Properties":{"relatedResourceId":{"Type":4,"Flags":1,"Description":"The resource ID of the related resource"},"relatedResourceName":{"Type":4,"Flags":2,"Description":"The name of the related resource"},"relatedResourceType":{"Type":4,"Flags":2,"Description":"The resource type of the related resource"},"relatedResourceKind":{"Type":4,"Flags":2,"Description":"The resource kind of the related resource"}}}},{"4":{"Name":"Microsoft.SecurityInsights/bookmarks/relations@2022-04-01-preview","ScopeType":16,"Body":474}},{"6":{"Value":"Microsoft.SecurityInsights/entityQueries"}},{"6":{"Value":"2022-04-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/entityQueries","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":477,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":478,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Activity":480,"Expansion":510}}},{"2":{"Name":"ActivityCustomEntityQuery","Properties":{"properties":{"Type":481,"Flags":0,"Description":"Describes activity entity query properties"},"kind":{"Type":509,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ActivityEntityQueriesProperties","Properties":{"title":{"Type":4,"Flags":0,"Description":"The entity query title"},"content":{"Type":4,"Flags":0,"Description":"The entity query content to display in timeline"},"description":{"Type":4,"Flags":0,"Description":"The entity query description"},"queryDefinitions":{"Type":482,"Flags":0,"Description":"The Activity query definitions"},"inputEntityType":{"Type":504,"Flags":0,"Description":"The type of the entity"},"requiredInputFieldsSets":{"Type":506,"Flags":0,"Description":"List of the fields of the source entity that are required to run the query"},"entitiesFilter":{"Type":508,"Flags":0,"Description":"The query applied only to entities matching to all filters"},"templateName":{"Type":4,"Flags":0,"Description":"The template id this activity was created from"},"enabled":{"Type":2,"Flags":0,"Description":"Determines whether this activity is enabled or disabled."},"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the activity was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The last time the activity was updated"}}}},{"2":{"Name":"ActivityEntityQueriesPropertiesQueryDefinitions","Properties":{"query":{"Type":4,"Flags":0,"Description":"The Activity query to run on a given entity"}}}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[483,484,485,486,487,488,489,490,491,492,493,494,495,496,497,498,499,500,501,502,503,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":505}},{"3":{"ItemType":4}},{"2":{"Name":"ActivityEntityQueriesPropertiesEntitiesFilter","Properties":{},"AdditionalProperties":507}},{"6":{"Value":"Activity"}},{"2":{"Name":"ExpansionEntityQuery","Properties":{"properties":{"Type":511,"Flags":2,"Description":"Describes expansion entity query properties"},"kind":{"Type":559,"Flags":1,"Description":"the entity query kind"}}}},{"2":{"Name":"ExpansionEntityQueriesProperties","Properties":{"dataSources":{"Type":512,"Flags":2,"Description":"List of the data sources that are required to run the query"},"displayName":{"Type":4,"Flags":2,"Description":"The query display name"},"inputEntityType":{"Type":534,"Flags":2,"Description":"The type of the entity"},"inputFields":{"Type":535,"Flags":2,"Description":"List of the fields of the source entity that are required to run the query"},"outputEntityTypes":{"Type":558,"Flags":2,"Description":"List of the desired output types to be constructed from the result"},"queryTemplate":{"Type":4,"Flags":2,"Description":"The template query string to be parsed and formatted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Account"}},{"6":{"Value":"Host"}},{"6":{"Value":"File"}},{"6":{"Value":"AzureResource"}},{"6":{"Value":"CloudApplication"}},{"6":{"Value":"DNS"}},{"6":{"Value":"FileHash"}},{"6":{"Value":"IP"}},{"6":{"Value":"Malware"}},{"6":{"Value":"Process"}},{"6":{"Value":"RegistryKey"}},{"6":{"Value":"RegistryValue"}},{"6":{"Value":"SecurityGroup"}},{"6":{"Value":"URL"}},{"6":{"Value":"IoTDevice"}},{"6":{"Value":"SecurityAlert"}},{"6":{"Value":"HuntingBookmark"}},{"6":{"Value":"MailCluster"}},{"6":{"Value":"MailMessage"}},{"6":{"Value":"Mailbox"}},{"6":{"Value":"SubmissionMail"}},{"5":{"Elements":[536,537,538,539,540,541,542,543,544,545,546,547,548,549,550,551,552,553,554,555,556,4]}},{"3":{"ItemType":557}},{"6":{"Value":"Expansion"}},{"4":{"Name":"Microsoft.SecurityInsights/entityQueries@2022-04-01-preview","ScopeType":16,"Body":479}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/comments"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/comments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Incident comment property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IncidentCommentProperties","Properties":{"createdTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was created"},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"The time the comment was updated"},"message":{"Type":4,"Flags":1,"Description":"The comment message"},"author":{"Type":384,"Flags":2,"Description":"Information on the client (user or application) that made some action"}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/comments@2022-04-01-preview","ScopeType":16,"Body":563}},{"6":{"Value":"Microsoft.SecurityInsights/incidents/relations"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/incidents/relations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":475,"Flags":0,"Description":"Relation property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.SecurityInsights/incidents/relations@2022-04-01-preview","ScopeType":16,"Body":568}},{"6":{"Value":"Microsoft.SecurityInsights/metadata"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/metadata","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":573,"Flags":0,"Description":"Metadata property bag."},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MetadataProperties","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"parentId":{"Type":4,"Flags":1,"Description":"Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)"},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"kind":{"Type":591,"Flags":1,"Description":"The kind of content the metadata is for."},"source":{"Type":592,"Flags":0,"Description":"The original source of the content item, where it comes from."},"author":{"Type":598,"Flags":0,"Description":"Publisher or creator of the content item."},"support":{"Type":599,"Flags":0,"Description":"Support information for the content item."},"dependencies":{"Type":604,"Flags":0,"Description":"Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies."},"categories":{"Type":627,"Flags":0,"Description":"ies for the solution content item"},"providers":{"Type":630,"Flags":0,"Description":"Providers for the solution content item"},"firstPublishDate":{"Type":4,"Flags":0,"Description":"first publish date of solution content item"},"lastPublishDate":{"Type":4,"Flags":0,"Description":"last publish date of solution content item"},"customVersion":{"Type":4,"Flags":0,"Description":"The custom version of the content. A optional free text"},"contentSchemaVersion":{"Type":4,"Flags":0,"Description":"Schema version of the content. Can be used to distinguish between different flow based on the schema version"},"icon":{"Type":4,"Flags":0,"Description":"the icon identifier. this id can later be fetched from the solution template"},"threatAnalysisTactics":{"Type":631,"Flags":0,"Description":"the tactics the resource covers"},"threatAnalysisTechniques":{"Type":632,"Flags":0,"Description":"the techniques the resource covers, these have to be aligned with the tactics being used"},"previewImages":{"Type":633,"Flags":0,"Description":"preview image file names. These will be taken from the solution artifacts"},"previewImagesDark":{"Type":634,"Flags":0,"Description":"preview image file names. These will be taken from the solution artifacts. used for dark theme support"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"6":{"Value":"AzureFunction"}},{"6":{"Value":"LogicAppsCustomConnector"}},{"6":{"Value":"AutomationRule"}},{"5":{"Elements":[574,575,576,577,578,579,580,581,582,583,584,585,586,587,588,589,590,4]}},{"2":{"Name":"MetadataSource","Properties":{"kind":{"Type":597,"Flags":1,"Description":"Source type of the content"},"name":{"Type":4,"Flags":0,"Description":"Name of the content source. The repo name, solution name, LA workspace name etc."},"sourceId":{"Type":4,"Flags":0,"Description":"ID of the content source. The solution ID, workspace ID, etc"}}}},{"6":{"Value":"LocalWorkspace"}},{"6":{"Value":"Community"}},{"6":{"Value":"Solution"}},{"6":{"Value":"SourceRepository"}},{"5":{"Elements":[593,594,595,596,4]}},{"2":{"Name":"MetadataAuthor","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the author. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of author contact"},"link":{"Type":4,"Flags":0,"Description":"Link for author/vendor page"}}}},{"2":{"Name":"MetadataSupport","Properties":{"tier":{"Type":603,"Flags":1,"Description":"Type of support for content item"},"name":{"Type":4,"Flags":0,"Description":"Name of the support contact. Company or person."},"email":{"Type":4,"Flags":0,"Description":"Email of support contact"},"link":{"Type":4,"Flags":0,"Description":"Link for support help, like to support page to open a ticket etc."}}}},{"6":{"Value":"Microsoft"}},{"6":{"Value":"Partner"}},{"6":{"Value":"Community"}},{"5":{"Elements":[600,601,602,4]}},{"2":{"Name":"MetadataDependencies","Properties":{"contentId":{"Type":4,"Flags":0,"Description":"Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId."},"kind":{"Type":622,"Flags":0,"Description":"The kind of content the metadata is for."},"version":{"Type":4,"Flags":0,"Description":"Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks"},"name":{"Type":4,"Flags":0,"Description":"Name of the content item"},"operator":{"Type":625,"Flags":0,"Description":"Operator used for list of dependencies in criteria array."},"criteria":{"Type":626,"Flags":0,"Description":"This is the list of dependencies we must fulfill, according to the AND/OR operator"}}}},{"6":{"Value":"DataConnector"}},{"6":{"Value":"DataType"}},{"6":{"Value":"Workbook"}},{"6":{"Value":"WorkbookTemplate"}},{"6":{"Value":"Playbook"}},{"6":{"Value":"PlaybookTemplate"}},{"6":{"Value":"AnalyticsRuleTemplate"}},{"6":{"Value":"AnalyticsRule"}},{"6":{"Value":"HuntingQuery"}},{"6":{"Value":"InvestigationQuery"}},{"6":{"Value":"Parser"}},{"6":{"Value":"Watchlist"}},{"6":{"Value":"WatchlistTemplate"}},{"6":{"Value":"Solution"}},{"6":{"Value":"AzureFunction"}},{"6":{"Value":"LogicAppsCustomConnector"}},{"6":{"Value":"AutomationRule"}},{"5":{"Elements":[605,606,607,608,609,610,611,612,613,614,615,616,617,618,619,620,621,4]}},{"6":{"Value":"AND"}},{"6":{"Value":"OR"}},{"5":{"Elements":[623,624,4]}},{"3":{"ItemType":604}},{"2":{"Name":"MetadataCategories","Properties":{"domains":{"Type":628,"Flags":0,"Description":"domain for the solution content item"},"verticals":{"Type":629,"Flags":0,"Description":"Industry verticals for the solution content item"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/metadata@2022-04-01-preview","ScopeType":16,"Body":572}},{"6":{"Value":"Microsoft.SecurityInsights/onboardingStates"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/onboardingStates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":636,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":637,"Flags":10,"Description":"The resource api version"},"properties":{"Type":639,"Flags":0,"Description":"The Sentinel onboarding state properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SentinelOnboardingStateProperties","Properties":{"customerManagedKey":{"Type":2,"Flags":0,"Description":"Flag that indicates the status of the CMK setting"}}}},{"4":{"Name":"Microsoft.SecurityInsights/onboardingStates@2022-04-01-preview","ScopeType":16,"Body":638}},{"6":{"Value":"Microsoft.SecurityInsights/settings"}},{"6":{"Value":"2022-04-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/settings","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":641,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":642,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"Anomalies":644,"EntityAnalytics":647,"EyesOn":654,"Ueba":657}}},{"2":{"Name":"Anomalies","Properties":{"properties":{"Type":645,"Flags":0,"Description":"Anomalies property bag."},"kind":{"Type":646,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"AnomaliesSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"Anomalies"}},{"2":{"Name":"EntityAnalytics","Properties":{"properties":{"Type":648,"Flags":0,"Description":"EntityAnalytics property bag."},"kind":{"Type":653,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EntityAnalyticsProperties","Properties":{"entityProviders":{"Type":652,"Flags":0,"Description":"The relevant entity providers that are synced"}}}},{"6":{"Value":"ActiveDirectory"}},{"6":{"Value":"AzureActiveDirectory"}},{"5":{"Elements":[649,650,4]}},{"3":{"ItemType":651}},{"6":{"Value":"EntityAnalytics"}},{"2":{"Name":"EyesOn","Properties":{"properties":{"Type":655,"Flags":0,"Description":"EyesOn property bag."},"kind":{"Type":656,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"EyesOnSettingsProperties","Properties":{"isEnabled":{"Type":2,"Flags":2,"Description":"Determines whether the setting is enable or disabled."}}}},{"6":{"Value":"EyesOn"}},{"2":{"Name":"Ueba","Properties":{"properties":{"Type":658,"Flags":0,"Description":"Ueba property bag."},"kind":{"Type":665,"Flags":1,"Description":"The kind of the setting"}}}},{"2":{"Name":"UebaProperties","Properties":{"dataSources":{"Type":664,"Flags":0,"Description":"The relevant data sources that enriched by ueba"}}}},{"6":{"Value":"AuditLogs"}},{"6":{"Value":"AzureActivity"}},{"6":{"Value":"SecurityEvent"}},{"6":{"Value":"SigninLogs"}},{"5":{"Elements":[659,660,661,662,4]}},{"3":{"ItemType":663}},{"6":{"Value":"Ueba"}},{"4":{"Name":"Microsoft.SecurityInsights/settings@2022-04-01-preview","ScopeType":16,"Body":643}},{"6":{"Value":"Microsoft.SecurityInsights/sourcecontrols"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":670,"Flags":0,"Description":"Describes source control properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the source control"},"version":{"Type":673,"Flags":0,"Description":"The version of the source control."},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the source control"},"description":{"Type":4,"Flags":0,"Description":"A description of the source control"},"repoType":{"Type":676,"Flags":1,"Description":"The type of repository."},"contentTypes":{"Type":680,"Flags":1,"Description":"Array of source control content types."},"repository":{"Type":681,"Flags":1,"Description":"metadata of a repository."},"repositoryResourceInfo":{"Type":687,"Flags":0,"Description":"Resources created in user's repository for the source-control."},"lastDeploymentInfo":{"Type":691,"Flags":0,"Description":"Information regarding a deployment."}}}},{"6":{"Value":"V1"}},{"6":{"Value":"V2"}},{"5":{"Elements":[671,672,4]}},{"6":{"Value":"Github"}},{"6":{"Value":"DevOps"}},{"5":{"Elements":[674,675,4]}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[677,678,4]}},{"3":{"ItemType":679}},{"2":{"Name":"Repository","Properties":{"url":{"Type":4,"Flags":0,"Description":"Url of repository."},"branch":{"Type":4,"Flags":0,"Description":"Branch name of repository."},"displayUrl":{"Type":4,"Flags":0,"Description":"Display url of repository."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."},"pathMapping":{"Type":686,"Flags":0,"Description":"Dictionary of source control content type and path mapping."}}}},{"2":{"Name":"ContentPathMap","Properties":{"contentType":{"Type":685,"Flags":0,"Description":"The content type of a source control path."},"path":{"Type":4,"Flags":0,"Description":"The path to the content."}}}},{"6":{"Value":"AnalyticRule"}},{"6":{"Value":"Workbook"}},{"5":{"Elements":[683,684,4]}},{"3":{"ItemType":682}},{"2":{"Name":"RepositoryResourceInfo","Properties":{"webhook":{"Type":688,"Flags":0,"Description":"Detail about the webhook object."},"gitHubResourceInfo":{"Type":689,"Flags":0,"Description":"Resources created in GitHub repository."},"azureDevOpsResourceInfo":{"Type":690,"Flags":0,"Description":"Resources created in Azure DevOps repository."}}}},{"2":{"Name":"Webhook","Properties":{"webhookId":{"Type":4,"Flags":0,"Description":"Unique identifier for the webhook."},"webhookUrl":{"Type":4,"Flags":0,"Description":"URL that gets invoked by the webhook."},"webhookSecretUpdateTime":{"Type":4,"Flags":0,"Description":"Time when the webhook secret was updated."},"rotateWebhookSecret":{"Type":2,"Flags":0,"Description":"A flag to instruct the backend service to rotate webhook secret."}}}},{"2":{"Name":"GitHubResourceInfo","Properties":{"appInstallationId":{"Type":4,"Flags":0,"Description":"GitHub application installation id."}}}},{"2":{"Name":"AzureDevOpsResourceInfo","Properties":{"pipelineId":{"Type":4,"Flags":0,"Description":"Id of the pipeline created for the source-control."},"serviceConnectionId":{"Type":4,"Flags":0,"Description":"Id of the service-connection created for the source-control."}}}},{"2":{"Name":"DeploymentInfo","Properties":{"deploymentFetchStatus":{"Type":695,"Flags":0,"Description":"Status while trying to fetch the deployment information."},"deployment":{"Type":696,"Flags":0,"Description":"Description about a deployment."},"message":{"Type":4,"Flags":0,"Description":"Additional details about the deployment that can be shown to the user."}}}},{"6":{"Value":"Success"}},{"6":{"Value":"Unauthorized"}},{"6":{"Value":"NotFound"}},{"5":{"Elements":[692,693,694,4]}},{"2":{"Name":"Deployment","Properties":{"deploymentId":{"Type":4,"Flags":0,"Description":"Deployment identifier."},"deploymentState":{"Type":701,"Flags":0,"Description":"The current state of the deployment."},"deploymentResult":{"Type":705,"Flags":0,"Description":"Status while trying to fetch the deployment information."},"deploymentTime":{"Type":4,"Flags":0,"Description":"The time when the deployment finished."},"deploymentLogsUrl":{"Type":4,"Flags":0,"Description":"Url to access repository action logs."}}}},{"6":{"Value":"In_Progress"}},{"6":{"Value":"Completed"}},{"6":{"Value":"Queued"}},{"6":{"Value":"Canceling"}},{"5":{"Elements":[697,698,699,700,4]}},{"6":{"Value":"Success"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Failed"}},{"5":{"Elements":[702,703,704,4]}},{"4":{"Name":"Microsoft.SecurityInsights/sourcecontrols@2022-04-01-preview","ScopeType":16,"Body":669}},{"6":{"Value":"Microsoft.SecurityInsights/threatIntelligence/indicators"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":707,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":708,"Flags":10,"Description":"The resource api version"},"properties":{"Type":710,"Flags":4,"Description":"Describes threat intelligence entity properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ThreatIntelligenceIndicatorProperties","Properties":{"threatIntelligenceTags":{"Type":711,"Flags":4,"Description":"List of tags"},"lastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"Last updated time in UTC"},"source":{"Type":4,"Flags":4,"Description":"Source of a threat intelligence entity"},"displayName":{"Type":4,"Flags":4,"Description":"Display name of a threat intelligence entity"},"description":{"Type":4,"Flags":4,"Description":"Description of a threat intelligence entity"},"indicatorTypes":{"Type":712,"Flags":4,"Description":"Indicator types of threat intelligence entities"},"pattern":{"Type":4,"Flags":4,"Description":"Pattern of a threat intelligence entity"},"patternType":{"Type":4,"Flags":4,"Description":"Pattern type of a threat intelligence entity"},"patternVersion":{"Type":4,"Flags":4,"Description":"Pattern version of a threat intelligence entity"},"killChainPhases":{"Type":714,"Flags":4,"Description":"Kill chain phases"},"parsedPattern":{"Type":718,"Flags":4,"Description":"Parsed patterns"},"externalId":{"Type":4,"Flags":4,"Description":"External ID of threat intelligence entity"},"createdByRef":{"Type":4,"Flags":4,"Description":"Created by reference of threat intelligence entity"},"defanged":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity defanged"},"externalLastUpdatedTimeUtc":{"Type":4,"Flags":4,"Description":"External last updated time in UTC"},"externalReferences":{"Type":721,"Flags":4,"Description":"External References"},"granularMarkings":{"Type":724,"Flags":4,"Description":"Granular Markings"},"labels":{"Type":725,"Flags":4,"Description":"Labels of threat intelligence entity"},"revoked":{"Type":2,"Flags":4,"Description":"Is threat intelligence entity revoked"},"confidence":{"Type":3,"Flags":4,"Description":"Confidence of threat intelligence entity"},"objectMarkingRefs":{"Type":726,"Flags":4,"Description":"Threat intelligence entity object marking references"},"language":{"Type":4,"Flags":4,"Description":"Language of threat intelligence entity"},"threatTypes":{"Type":727,"Flags":4,"Description":"Threat types"},"validFrom":{"Type":4,"Flags":4,"Description":"Valid from"},"validUntil":{"Type":4,"Flags":4,"Description":"Valid until"},"created":{"Type":4,"Flags":4,"Description":"Created by"},"modified":{"Type":4,"Flags":4,"Description":"Modified by"},"extensions":{"Type":728,"Flags":4,"Description":"Extensions map"},"additionalData":{"Type":729,"Flags":6,"Description":"A bag of custom fields that should be part of the entity and will be presented to the user."},"friendlyName":{"Type":4,"Flags":6,"Description":"The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceKillChainPhase","Properties":{"killChainName":{"Type":4,"Flags":4,"Description":"Kill chainName name"},"phaseName":{"Type":4,"Flags":4,"Description":"Phase name"}}}},{"3":{"ItemType":713}},{"2":{"Name":"ThreatIntelligenceParsedPattern","Properties":{"patternTypeKey":{"Type":4,"Flags":4,"Description":"Pattern type key"},"patternTypeValues":{"Type":717,"Flags":4,"Description":"Pattern type keys"}}}},{"2":{"Name":"ThreatIntelligenceParsedPatternTypeValue","Properties":{"valueType":{"Type":4,"Flags":4,"Description":"Type of the value"},"value":{"Type":4,"Flags":4,"Description":"Value of parsed pattern"}}}},{"3":{"ItemType":716}},{"3":{"ItemType":715}},{"2":{"Name":"ThreatIntelligenceExternalReference","Properties":{"description":{"Type":4,"Flags":4,"Description":"External reference description"},"externalId":{"Type":4,"Flags":4,"Description":"External reference ID"},"sourceName":{"Type":4,"Flags":4,"Description":"External reference source name"},"url":{"Type":4,"Flags":4,"Description":"External reference URL"},"hashes":{"Type":720,"Flags":4,"Description":"External reference hashes"}}}},{"2":{"Name":"ThreatIntelligenceExternalReferenceHashes","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":719}},{"2":{"Name":"ThreatIntelligenceGranularMarkingModel","Properties":{"language":{"Type":4,"Flags":4,"Description":"Language granular marking model"},"markingRef":{"Type":3,"Flags":4,"Description":"marking reference granular marking model"},"selectors":{"Type":723,"Flags":4,"Description":"granular marking model selectors"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":722}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ThreatIntelligenceIndicatorPropertiesExtensions","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"EntityCommonPropertiesAdditionalData","Properties":{},"AdditionalProperties":0}},{"4":{"Name":"Microsoft.SecurityInsights/threatIntelligence/indicators@2022-04-01-preview","ScopeType":16,"Body":709}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":731,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":732,"Flags":10,"Description":"The resource api version"},"properties":{"Type":734,"Flags":0,"Description":"Describes watchlist properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistProperties","Properties":{"watchlistId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist"},"displayName":{"Type":4,"Flags":1,"Description":"The display name of the watchlist"},"provider":{"Type":4,"Flags":1,"Description":"The provider of the watchlist"},"source":{"Type":4,"Flags":0,"Description":"The filename of the watchlist, called 'source'"},"sourceType":{"Type":737,"Flags":0,"Description":"The sourceType of the watchlist"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist was updated"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"description":{"Type":4,"Flags":0,"Description":"A description of the watchlist"},"watchlistType":{"Type":4,"Flags":0,"Description":"The type of the watchlist"},"watchlistAlias":{"Type":4,"Flags":0,"Description":"The alias of the watchlist"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist is deleted or not"},"labels":{"Type":738,"Flags":0,"Description":"List of labels relevant to this watchlist"},"defaultDuration":{"Type":4,"Flags":0,"Description":"The default duration of a watchlist (in ISO 8601 duration format)"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId where the watchlist belongs to"},"numberOfLinesToSkip":{"Type":3,"Flags":0,"Description":"The number of lines in a csv/tsv content to skip before the header"},"rawContent":{"Type":4,"Flags":0,"Description":"The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint"},"itemsSearchKey":{"Type":4,"Flags":1,"Description":"The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address."},"contentType":{"Type":4,"Flags":0,"Description":"The content type of the raw content. Example : text/csv or text/tsv"},"uploadStatus":{"Type":4,"Flags":0,"Description":"The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted"}}}},{"6":{"Value":"Local file"}},{"6":{"Value":"Remote storage"}},{"5":{"Elements":[735,736,4]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists@2022-04-01-preview","ScopeType":16,"Body":733}},{"6":{"Value":"Microsoft.SecurityInsights/watchlists/watchlistItems"}},{"6":{"Value":"2022-04-01-preview"}},{"2":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":740,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":741,"Flags":10,"Description":"The resource api version"},"properties":{"Type":743,"Flags":0,"Description":"Describes watchlist item properties"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"WatchlistItemProperties","Properties":{"watchlistItemType":{"Type":4,"Flags":0,"Description":"The type of the watchlist item"},"watchlistItemId":{"Type":4,"Flags":0,"Description":"The id (a Guid) of the watchlist item"},"tenantId":{"Type":4,"Flags":0,"Description":"The tenantId to which the watchlist item belongs to"},"isDeleted":{"Type":2,"Flags":0,"Description":"A flag that indicates if the watchlist item is deleted or not"},"created":{"Type":4,"Flags":0,"Description":"The time the watchlist item was created"},"updated":{"Type":4,"Flags":0,"Description":"The last time the watchlist item was updated"},"createdBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"updatedBy":{"Type":439,"Flags":0,"Description":"User information that made some action"},"itemsKeyValue":{"Type":744,"Flags":1,"Description":"key-value pairs for a watchlist item"},"entityMapping":{"Type":745,"Flags":0,"Description":"key-value pairs for a watchlist item entity mapping"}}}},{"2":{"Name":"WatchlistItemPropertiesItemsKeyValue","Properties":{},"AdditionalProperties":0}},{"2":{"Name":"WatchlistItemPropertiesEntityMapping","Properties":{},"AdditionalProperties":0}},{"4":{"Name":"Microsoft.SecurityInsights/watchlists/watchlistItems@2022-04-01-preview","ScopeType":16,"Body":742}},{"6":{"Value":"Microsoft.SecurityInsights/dataConnectors"}},{"6":{"Value":"2022-04-01-preview"}},{"7":{"Name":"Microsoft.SecurityInsights/dataConnectors","Discriminator":"kind","BaseProperties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":747,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":748,"Flags":10,"Description":"The resource api version"},"etag":{"Type":4,"Flags":0,"Description":"Etag of the azure resource"},"systemData":{"Type":11,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}},"Elements":{"APIPolling":750,"AmazonWebServicesCloudTrail":798,"AmazonWebServicesS3":806,"AzureActiveDirectory":815,"AzureAdvancedThreatProtection":823,"AzureSecurityCenter":826,"Dynamics365":829,"GenericUI":837,"IOT":840,"MicrosoftCloudAppSecurity":843,"MicrosoftDefenderAdvancedThreatProtection":847,"MicrosoftThreatIntelligence":850,"MicrosoftThreatProtection":862,"Office365":870,"Office365Project":886,"OfficeATP":894,"OfficeIRM":897,"OfficePowerBI":900,"ThreatIntelligence":908,"ThreatIntelligenceTaxii":916}}},{"2":{"Name":"CodelessApiPollingDataConnector","Properties":{"properties":{"Type":751,"Flags":0,"Description":"Represents Codeless API Polling data connector"},"kind":{"Type":797,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ApiPollingParameters","Properties":{"connectorUiConfig":{"Type":752,"Flags":0,"Description":"Config to describe the instructions blade"},"pollingConfig":{"Type":791,"Flags":0,"Description":"Config to describe the polling config for API poller connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigProperties","Properties":{"title":{"Type":4,"Flags":1,"Description":"Connector blade title"},"publisher":{"Type":4,"Flags":1,"Description":"Connector publisher name"},"descriptionMarkdown":{"Type":4,"Flags":1,"Description":"Connector description"},"customImage":{"Type":4,"Flags":0,"Description":"An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery"},"graphQueriesTableName":{"Type":4,"Flags":1,"Description":"Name of the table the connector will insert the data to"},"graphQueries":{"Type":754,"Flags":1,"Description":"The graph query to show the current data status"},"sampleQueries":{"Type":756,"Flags":1,"Description":"The sample queries for the connector"},"dataTypes":{"Type":758,"Flags":1,"Description":"Data types to check for last data received"},"connectivityCriteria":{"Type":763,"Flags":1,"Description":"Define the way the connector check connectivity"},"availability":{"Type":764,"Flags":1,"Description":"Connector Availability Status"},"permissions":{"Type":766,"Flags":1,"Description":"Permissions required for the connector"},"instructionSteps":{"Type":790,"Flags":1,"Description":"Instruction steps to enable the connector"}}}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesGraphQueriesItem","Properties":{"metricName":{"Type":4,"Flags":0,"Description":"the metric that the query is checking"},"legend":{"Type":4,"Flags":0,"Description":"The legend for the graph"},"baseQuery":{"Type":4,"Flags":0,"Description":"The base query for the graph"}}}},{"3":{"ItemType":753}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesSampleQueriesItem","Properties":{"description":{"Type":4,"Flags":0,"Description":"The sample query description"},"query":{"Type":4,"Flags":0,"Description":"the sample query"}}}},{"3":{"ItemType":755}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesDataTypesItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder"},"lastDataReceivedQuery":{"Type":4,"Flags":0,"Description":"Query for indicate last data received"}}}},{"3":{"ItemType":757}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem","Properties":{"type":{"Type":761,"Flags":0,"Description":"type of connectivity"},"value":{"Type":762,"Flags":0,"Description":"Queries for checking connectivity"}}}},{"6":{"Value":"IsConnectedQuery"}},{"5":{"Elements":[760,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":759}},{"2":{"Name":"Availability","Properties":{"status":{"Type":765,"Flags":0,"Description":"The connector Availability Status"},"isPreview":{"Type":2,"Flags":0,"Description":"Set connector as preview"}}}},{"6":{"Value":"1"}},{"2":{"Name":"Permissions","Properties":{"resourceProvider":{"Type":780,"Flags":0,"Description":"Resource provider permissions required for the connector"},"customs":{"Type":782,"Flags":0,"Description":"Customs permissions required for the connector"}}}},{"2":{"Name":"PermissionsResourceProviderItem","Properties":{"provider":{"Type":774,"Flags":0,"Description":"Provider name"},"permissionsDisplayText":{"Type":4,"Flags":0,"Description":"Permission description text"},"providerDisplayName":{"Type":4,"Flags":0,"Description":"Permission provider display name"},"scope":{"Type":778,"Flags":0,"Description":"Permission provider scope"},"requiredPermissions":{"Type":779,"Flags":0,"Description":"Required permissions for the connector"}}}},{"6":{"Value":"Microsoft.OperationalInsights/solutions"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/datasources"}},{"6":{"Value":"microsoft.aadiam/diagnosticSettings"}},{"6":{"Value":"Microsoft.OperationalInsights/workspaces/sharedKeys"}},{"6":{"Value":"Microsoft.Authorization/policyAssignments"}},{"5":{"Elements":[768,769,770,771,772,773,4]}},{"6":{"Value":"ResourceGroup"}},{"6":{"Value":"Subscription"}},{"6":{"Value":"Workspace"}},{"5":{"Elements":[775,776,777,4]}},{"2":{"Name":"RequiredPermissions","Properties":{"action":{"Type":2,"Flags":0,"Description":"action permission"},"write":{"Type":2,"Flags":0,"Description":"write permission"},"read":{"Type":2,"Flags":0,"Description":"read permission"},"delete":{"Type":2,"Flags":0,"Description":"delete permission"}}}},{"3":{"ItemType":767}},{"2":{"Name":"PermissionsCustomsItem","Properties":{"name":{"Type":4,"Flags":0,"Description":"Customs permissions name"},"description":{"Type":4,"Flags":0,"Description":"Customs permissions description"}}}},{"3":{"ItemType":781}},{"2":{"Name":"CodelessUiConnectorConfigPropertiesInstructionStepsItem","Properties":{"title":{"Type":4,"Flags":0,"Description":"Instruction step title"},"description":{"Type":4,"Flags":0,"Description":"Instruction step description"},"instructions":{"Type":789,"Flags":0,"Description":"Instruction step details"}}}},{"2":{"Name":"InstructionStepsInstructionsItem","Properties":{"parameters":{"Type":0,"Flags":0,"Description":"Any object"},"type":{"Type":788,"Flags":1,"Description":"The kind of the setting"}}}},{"6":{"Value":"CopyableLabel"}},{"6":{"Value":"InstructionStepsGroup"}},{"6":{"Value":"InfoMessage"}},{"5":{"Elements":[785,786,787,4]}},{"3":{"ItemType":784}},{"3":{"ItemType":783}},{"2":{"Name":"CodelessConnectorPollingConfigProperties","Properties":{"isActive":{"Type":2,"Flags":0,"Description":"The poller active status"},"auth":{"Type":792,"Flags":1,"Description":"Describe the authentication properties needed to successfully authenticate with the server"},"request":{"Type":793,"Flags":1,"Description":"Describe the request properties needed to successfully pull from the server"},"paging":{"Type":794,"Flags":0,"Description":"Describe the properties needed to make a pagination call"},"response":{"Type":795,"Flags":0,"Description":"Describes the response from the external server"}}}},{"2":{"Name":"CodelessConnectorPollingAuthProperties","Properties":{"authType":{"Type":4,"Flags":1,"Description":"The authentication type"},"apiKeyName":{"Type":4,"Flags":0,"Description":"The header name which the token is sent with"},"apiKeyIdentifier":{"Type":4,"Flags":0,"Description":"A prefix send in the header before the actual token"},"isApiKeyInPostPayload":{"Type":4,"Flags":0,"Description":"Marks if the key should sent in header"},"flowName":{"Type":4,"Flags":0,"Description":"Describes the flow name, for example 'AuthCode' for Oauth 2.0"},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to issue a token, used in Oauth 2.0 flow"},"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint used to authorize the user, used in Oauth 2.0 flow"},"authorizationEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"redirectionEndpoint":{"Type":4,"Flags":0,"Description":"The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow"},"tokenEndpointHeaders":{"Type":0,"Flags":0,"Description":"Any object"},"tokenEndpointQueryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"isClientSecretInHeader":{"Type":2,"Flags":0,"Description":"Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow"},"scope":{"Type":4,"Flags":0,"Description":"The OAuth token scope"}}}},{"2":{"Name":"CodelessConnectorPollingRequestProperties","Properties":{"apiEndpoint":{"Type":4,"Flags":1,"Description":"Describe the endpoint we should pull the data from"},"rateLimitQps":{"Type":3,"Flags":0,"Description":"Defines the rate limit QPS"},"queryWindowInMin":{"Type":3,"Flags":1,"Description":"The window interval we will use the pull the data"},"httpMethod":{"Type":4,"Flags":1,"Description":"The http method type we will use in the poll request, GET or POST"},"queryTimeFormat":{"Type":4,"Flags":1,"Description":"The time format will be used the query events in a specific window"},"retryCount":{"Type":3,"Flags":0,"Description":"Describe the amount of time we should try and poll the data in case of failure"},"timeoutInSeconds":{"Type":3,"Flags":0,"Description":"The number of seconds we will consider as a request timeout"},"headers":{"Type":0,"Flags":0,"Description":"Any object"},"queryParameters":{"Type":0,"Flags":0,"Description":"Any object"},"queryParametersTemplate":{"Type":4,"Flags":0,"Description":"For advanced scenarios for example user name/password embedded in nested JSON payload"},"startTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from a start of the time window"},"endTimeAttributeName":{"Type":4,"Flags":0,"Description":"This will be used the query events from the end of the time window"}}}},{"2":{"Name":"CodelessConnectorPollingPagingProperties","Properties":{"pagingType":{"Type":4,"Flags":1,"Description":"Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'"},"nextPageParaName":{"Type":4,"Flags":0,"Description":"Defines the name of a next page attribute"},"nextPageTokenJsonPath":{"Type":4,"Flags":0,"Description":"Defines the path to a next page token JSON"},"pageCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page count attribute"},"pageTotalCountAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a page total count attribute"},"pageTimeStampAttributePath":{"Type":4,"Flags":0,"Description":"Defines the path to a paging time stamp attribute"},"searchTheLatestTimeStampFromEventsList":{"Type":4,"Flags":0,"Description":"Determines whether to search for the latest time stamp in the events list"},"pageSizeParaName":{"Type":4,"Flags":0,"Description":"Defines the name of the page size parameter"},"pageSize":{"Type":3,"Flags":0,"Description":"Defines the paging size"}}}},{"2":{"Name":"CodelessConnectorPollingResponseProperties","Properties":{"eventsJsonPaths":{"Type":796,"Flags":1,"Description":"Describes the path we should extract the data in the response"},"successStatusJsonPath":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status code in the response"},"successStatusValue":{"Type":4,"Flags":0,"Description":"Describes the path we should extract the status value in the response"},"isGzipCompressed":{"Type":2,"Flags":0,"Description":"Describes if the data in the response is Gzip"}}}},{"3":{"ItemType":4}},{"6":{"Value":"APIPolling"}},{"2":{"Name":"AwsCloudTrailDataConnector","Properties":{"properties":{"Type":799,"Flags":0,"Description":"Amazon Web Services CloudTrail data connector properties."},"kind":{"Type":805,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsCloudTrailDataConnectorProperties","Properties":{"awsRoleArn":{"Type":4,"Flags":0,"Description":"The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account."},"dataTypes":{"Type":800,"Flags":1,"Description":"The available data types for Amazon Web Services CloudTrail data connector."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypes","Properties":{"logs":{"Type":801,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsCloudTrailDataConnectorDataTypesLogs","Properties":{"state":{"Type":804,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[802,803,4]}},{"6":{"Value":"AmazonWebServicesCloudTrail"}},{"2":{"Name":"AwsS3DataConnector","Properties":{"properties":{"Type":807,"Flags":0,"Description":"Amazon Web Services S3 data connector properties."},"kind":{"Type":814,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AwsS3DataConnectorProperties","Properties":{"destinationTable":{"Type":4,"Flags":1,"Description":"The logs destination table name in LogAnalytics."},"sqsUrls":{"Type":808,"Flags":1,"Description":"The AWS sqs urls for the connector."},"roleArn":{"Type":4,"Flags":1,"Description":"The Aws Role Arn that is used to access the Aws account."},"dataTypes":{"Type":809,"Flags":1,"Description":"The available data types for Amazon Web Services S3 data connector."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AwsS3DataConnectorDataTypes","Properties":{"logs":{"Type":810,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"AwsS3DataConnectorDataTypesLogs","Properties":{"state":{"Type":813,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[811,812,4]}},{"6":{"Value":"AmazonWebServicesS3"}},{"2":{"Name":"AADDataConnector","Properties":{"properties":{"Type":816,"Flags":0,"Description":"AAD (Azure Active Directory) data connector properties."},"kind":{"Type":822,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AADDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"2":{"Name":"AlertsDataTypeOfDataConnector","Properties":{"alerts":{"Type":818,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"2":{"Name":"DataConnectorDataTypeCommon","Properties":{"state":{"Type":821,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[819,820,4]}},{"6":{"Value":"AzureActiveDirectory"}},{"2":{"Name":"AatpDataConnector","Properties":{"properties":{"Type":824,"Flags":0,"Description":"AATP (Azure Advanced Threat Protection) data connector properties."},"kind":{"Type":825,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"AatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureAdvancedThreatProtection"}},{"2":{"Name":"ASCDataConnector","Properties":{"properties":{"Type":827,"Flags":0,"Description":"ASC (Azure Security Center) data connector properties."},"kind":{"Type":828,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"ASCDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"AzureSecurityCenter"}},{"2":{"Name":"Dynamics365DataConnector","Properties":{"properties":{"Type":830,"Flags":0,"Description":"Dynamics365 data connector properties."},"kind":{"Type":836,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Dynamics365DataConnectorProperties","Properties":{"dataTypes":{"Type":831,"Flags":1,"Description":"The available data types for Dynamics365 data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypes","Properties":{"dynamics365CdsActivities":{"Type":832,"Flags":1,"Description":"Common Data Service data type connection."}}}},{"2":{"Name":"Dynamics365DataConnectorDataTypesDynamics365CdsActivities","Properties":{"state":{"Type":835,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[833,834,4]}},{"6":{"Value":"Dynamics365"}},{"2":{"Name":"CodelessUiDataConnector","Properties":{"properties":{"Type":838,"Flags":0,"Description":"Represents Codeless UI data connector"},"kind":{"Type":839,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"CodelessParameters","Properties":{"connectorUiConfig":{"Type":752,"Flags":0,"Description":"Config to describe the instructions blade"}}}},{"6":{"Value":"GenericUI"}},{"2":{"Name":"IoTDataConnector","Properties":{"properties":{"Type":841,"Flags":0,"Description":"IoT data connector properties."},"kind":{"Type":842,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"IoTDataConnectorProperties","Properties":{"subscriptionId":{"Type":4,"Flags":0,"Description":"The subscription id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"IOT"}},{"2":{"Name":"McasDataConnector","Properties":{"properties":{"Type":844,"Flags":0,"Description":"MCAS (Microsoft Cloud App Security) data connector properties."},"kind":{"Type":846,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"McasDataConnectorProperties","Properties":{"dataTypes":{"Type":845,"Flags":1,"Description":"The available data types for MCAS (Microsoft Cloud App Security) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"McasDataConnectorDataTypes","Properties":{"discoveryLogs":{"Type":818,"Flags":0,"Description":"Common field for data type in data connectors."},"alerts":{"Type":818,"Flags":1,"Description":"Common field for data type in data connectors."}}}},{"6":{"Value":"MicrosoftCloudAppSecurity"}},{"2":{"Name":"MdatpDataConnector","Properties":{"properties":{"Type":848,"Flags":0,"Description":"MDATP (Microsoft Defender Advanced Threat Protection) data connector properties."},"kind":{"Type":849,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MdatpDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"MicrosoftDefenderAdvancedThreatProtection"}},{"2":{"Name":"MstiDataConnector","Properties":{"properties":{"Type":851,"Flags":0,"Description":"Microsoft Threat Intelligence data connector properties."},"kind":{"Type":861,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MstiDataConnectorProperties","Properties":{"dataTypes":{"Type":852,"Flags":1,"Description":"The available data types for Microsoft Threat Intelligence Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MstiDataConnectorDataTypes","Properties":{"bingSafetyPhishingURL":{"Type":853,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."},"microsoftEmergingThreatFeed":{"Type":857,"Flags":1,"Description":"Data type for Microsoft Threat Intelligence Platforms data connector."}}}},{"2":{"Name":"MstiDataConnectorDataTypesBingSafetyPhishingURL","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":856,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[854,855,4]}},{"2":{"Name":"MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed","Properties":{"lookbackPeriod":{"Type":4,"Flags":1,"Description":"lookback period"},"state":{"Type":860,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[858,859,4]}},{"6":{"Value":"MicrosoftThreatIntelligence"}},{"2":{"Name":"MTPDataConnector","Properties":{"properties":{"Type":863,"Flags":0,"Description":"MTP (Microsoft Threat Protection) data connector properties."},"kind":{"Type":869,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"MTPDataConnectorProperties","Properties":{"dataTypes":{"Type":864,"Flags":1,"Description":"The available data types for Microsoft Threat Protection Platforms data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"MTPDataConnectorDataTypes","Properties":{"incidents":{"Type":865,"Flags":1,"Description":"Data type for Microsoft Threat Protection Platforms data connector."}}}},{"2":{"Name":"MTPDataConnectorDataTypesIncidents","Properties":{"state":{"Type":868,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[866,867,4]}},{"6":{"Value":"MicrosoftThreatProtection"}},{"2":{"Name":"OfficeDataConnector","Properties":{"properties":{"Type":871,"Flags":0,"Description":"Office data connector properties."},"kind":{"Type":885,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeDataConnectorProperties","Properties":{"dataTypes":{"Type":872,"Flags":1,"Description":"The available data types for office data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficeDataConnectorDataTypes","Properties":{"exchange":{"Type":873,"Flags":1,"Description":"Exchange data type connection."},"sharePoint":{"Type":877,"Flags":1,"Description":"SharePoint data type connection."},"teams":{"Type":881,"Flags":1,"Description":"Teams data type connection."}}}},{"2":{"Name":"OfficeDataConnectorDataTypesExchange","Properties":{"state":{"Type":876,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[874,875,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesSharePoint","Properties":{"state":{"Type":880,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[878,879,4]}},{"2":{"Name":"OfficeDataConnectorDataTypesTeams","Properties":{"state":{"Type":884,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[882,883,4]}},{"6":{"Value":"Office365"}},{"2":{"Name":"Office365ProjectDataConnector","Properties":{"properties":{"Type":887,"Flags":0,"Description":"Office Microsoft Project data connector properties."},"kind":{"Type":893,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"Office365ProjectDataConnectorProperties","Properties":{"dataTypes":{"Type":888,"Flags":1,"Description":"The available data types for Office Microsoft Project data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"Office365ProjectConnectorDataTypes","Properties":{"logs":{"Type":889,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"Office365ProjectConnectorDataTypesLogs","Properties":{"state":{"Type":892,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[890,891,4]}},{"6":{"Value":"Office365Project"}},{"2":{"Name":"OfficeATPDataConnector","Properties":{"properties":{"Type":895,"Flags":0,"Description":"OfficeATP (Office 365 Advanced Threat Protection) data connector properties."},"kind":{"Type":896,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeATPDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeATP"}},{"2":{"Name":"OfficeIRMDataConnector","Properties":{"properties":{"Type":898,"Flags":0,"Description":"OfficeIRM (Microsoft Insider Risk Management) data connector properties."},"kind":{"Type":899,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficeIRMDataConnectorProperties","Properties":{"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."},"dataTypes":{"Type":817,"Flags":0,"Description":"Alerts data type for data connectors."}}}},{"6":{"Value":"OfficeIRM"}},{"2":{"Name":"OfficePowerBIDataConnector","Properties":{"properties":{"Type":901,"Flags":0,"Description":"Office Microsoft PowerBI data connector properties."},"kind":{"Type":907,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"OfficePowerBIDataConnectorProperties","Properties":{"dataTypes":{"Type":902,"Flags":1,"Description":"The available data types for Office Microsoft PowerBI data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"OfficePowerBIConnectorDataTypes","Properties":{"logs":{"Type":903,"Flags":1,"Description":"Logs data type."}}}},{"2":{"Name":"OfficePowerBIConnectorDataTypesLogs","Properties":{"state":{"Type":906,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[904,905,4]}},{"6":{"Value":"OfficePowerBI"}},{"2":{"Name":"TIDataConnector","Properties":{"properties":{"Type":909,"Flags":0,"Description":"TI (Threat Intelligence) data connector properties."},"kind":{"Type":915,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TIDataConnectorProperties","Properties":{"tipLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the feed to be imported."},"dataTypes":{"Type":910,"Flags":1,"Description":"The available data types for TI (Threat Intelligence) data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"2":{"Name":"TIDataConnectorDataTypes","Properties":{"indicators":{"Type":911,"Flags":1,"Description":"Data type for indicators connection."}}}},{"2":{"Name":"TIDataConnectorDataTypesIndicators","Properties":{"state":{"Type":914,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[912,913,4]}},{"6":{"Value":"ThreatIntelligence"}},{"2":{"Name":"TiTaxiiDataConnector","Properties":{"properties":{"Type":917,"Flags":0,"Description":"Threat Intelligence TAXII data connector properties."},"kind":{"Type":927,"Flags":1,"Description":"The data connector kind"}}}},{"2":{"Name":"TiTaxiiDataConnectorProperties","Properties":{"workspaceId":{"Type":4,"Flags":0,"Description":"The workspace id."},"friendlyName":{"Type":4,"Flags":0,"Description":"The friendly name for the TAXII server."},"taxiiServer":{"Type":4,"Flags":0,"Description":"The API root for the TAXII server."},"collectionId":{"Type":4,"Flags":0,"Description":"The collection id of the TAXII server."},"userName":{"Type":4,"Flags":0,"Description":"The userName for the TAXII server."},"password":{"Type":4,"Flags":0,"Description":"The password for the TAXII server."},"taxiiLookbackPeriod":{"Type":4,"Flags":0,"Description":"The lookback period for the TAXII server."},"pollingFrequency":{"Type":921,"Flags":1,"Description":"The polling frequency for the TAXII server."},"dataTypes":{"Type":922,"Flags":1,"Description":"The available data types for Threat Intelligence TAXII data connector."},"tenantId":{"Type":4,"Flags":1,"Description":"The tenant id to connect to, and get the data from."}}}},{"6":{"Value":"OnceAMinute"}},{"6":{"Value":"OnceAnHour"}},{"6":{"Value":"OnceADay"}},{"5":{"Elements":[918,919,920,4]}},{"2":{"Name":"TiTaxiiDataConnectorDataTypes","Properties":{"taxiiClient":{"Type":923,"Flags":1,"Description":"Data type for TAXII connector."}}}},{"2":{"Name":"TiTaxiiDataConnectorDataTypesTaxiiClient","Properties":{"state":{"Type":926,"Flags":1,"Description":"Describe whether this data type connection is enabled or not."}}}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[924,925,4]}},{"6":{"Value":"ThreatIntelligenceTaxii"}},{"4":{"Name":"Microsoft.SecurityInsights/dataConnectors@2022-04-01-preview","ScopeType":16,"Body":749}}] \ No newline at end of file diff --git a/generated/securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md b/generated/securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md new file mode 100644 index 0000000000..2f1b07e65a --- /dev/null +++ b/generated/securityinsights/microsoft.securityinsights/2022-04-01-preview/types.md @@ -0,0 +1,1362 @@ +# Microsoft.SecurityInsights @ 2022-04-01-preview + +## Resource Microsoft.SecurityInsights/alertRules@2022-04-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules' (ReadOnly, DeployTimeConstant): The resource type +### FusionAlertRule +#### Properties +* **kind**: 'Fusion' (Required): The kind of the alert rule +* **properties**: [FusionAlertRuleProperties](#fusionalertruleproperties): Fusion alert rule base property bag. + +### MicrosoftSecurityIncidentCreationAlertRule +#### Properties +* **kind**: 'MicrosoftSecurityIncidentCreation' (Required): The kind of the alert rule +* **properties**: [MicrosoftSecurityIncidentCreationAlertRuleProperties](#microsoftsecurityincidentcreationalertruleproperties): MicrosoftSecurityIncidentCreation rule property bag. + +### MLBehaviorAnalyticsAlertRule +#### Properties +* **kind**: 'MLBehaviorAnalytics' (Required): The kind of the alert rule +* **properties**: [MLBehaviorAnalyticsAlertRuleProperties](#mlbehavioranalyticsalertruleproperties): MLBehaviorAnalytics alert rule base property bag. + +### NrtAlertRule +#### Properties +* **kind**: 'NRT' (Required): The kind of the alert rule +* **properties**: [NrtAlertRuleProperties](#nrtalertruleproperties): Nrt alert rule base property bag. + +### ScheduledAlertRule +#### Properties +* **kind**: 'Scheduled' (Required): The kind of the alert rule +* **properties**: [ScheduledAlertRuleProperties](#scheduledalertruleproperties): Scheduled alert rule base property bag. + +### ThreatIntelligenceAlertRule +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The kind of the alert rule +* **properties**: [ThreatIntelligenceAlertRuleProperties](#threatintelligencealertruleproperties): Threat Intelligence alert rule base property bag. + + +## Resource Microsoft.SecurityInsights/alertRules/actions@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ActionRequestProperties](#actionrequestproperties): Action property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/alertRules/actions' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/automationRules@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [AutomationRuleProperties](#automationruleproperties) (Required): Automation rule properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/automationRules' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [BookmarkProperties](#bookmarkproperties): Describes bookmark properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/bookmarks/relations@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/bookmarks/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/dataConnectors@2022-04-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/dataConnectors' (ReadOnly, DeployTimeConstant): The resource type +### AwsCloudTrailDataConnector +#### Properties +* **kind**: 'AmazonWebServicesCloudTrail' (Required): The data connector kind +* **properties**: [AwsCloudTrailDataConnectorProperties](#awscloudtraildataconnectorproperties): Amazon Web Services CloudTrail data connector properties. + +### AwsS3DataConnector +#### Properties +* **kind**: 'AmazonWebServicesS3' (Required): The data connector kind +* **properties**: [AwsS3DataConnectorProperties](#awss3dataconnectorproperties): Amazon Web Services S3 data connector properties. + +### CodelessApiPollingDataConnector +#### Properties +* **kind**: 'APIPolling' (Required): The data connector kind +* **properties**: [ApiPollingParameters](#apipollingparameters): Represents Codeless API Polling data connector + +### AADDataConnector +#### Properties +* **kind**: 'AzureActiveDirectory' (Required): The data connector kind +* **properties**: [AADDataConnectorProperties](#aaddataconnectorproperties): AAD (Azure Active Directory) data connector properties. + +### AatpDataConnector +#### Properties +* **kind**: 'AzureAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [AatpDataConnectorProperties](#aatpdataconnectorproperties): AATP (Azure Advanced Threat Protection) data connector properties. + +### ASCDataConnector +#### Properties +* **kind**: 'AzureSecurityCenter' (Required): The data connector kind +* **properties**: [ASCDataConnectorProperties](#ascdataconnectorproperties): ASC (Azure Security Center) data connector properties. + +### Dynamics365DataConnector +#### Properties +* **kind**: 'Dynamics365' (Required): The data connector kind +* **properties**: [Dynamics365DataConnectorProperties](#dynamics365dataconnectorproperties): Dynamics365 data connector properties. + +### CodelessUiDataConnector +#### Properties +* **kind**: 'GenericUI' (Required): The data connector kind +* **properties**: [CodelessParameters](#codelessparameters): Represents Codeless UI data connector + +### IoTDataConnector +#### Properties +* **kind**: 'IOT' (Required): The data connector kind +* **properties**: [IoTDataConnectorProperties](#iotdataconnectorproperties): IoT data connector properties. + +### McasDataConnector +#### Properties +* **kind**: 'MicrosoftCloudAppSecurity' (Required): The data connector kind +* **properties**: [McasDataConnectorProperties](#mcasdataconnectorproperties): MCAS (Microsoft Cloud App Security) data connector properties. + +### MdatpDataConnector +#### Properties +* **kind**: 'MicrosoftDefenderAdvancedThreatProtection' (Required): The data connector kind +* **properties**: [MdatpDataConnectorProperties](#mdatpdataconnectorproperties): MDATP (Microsoft Defender Advanced Threat Protection) data connector properties. + +### MstiDataConnector +#### Properties +* **kind**: 'MicrosoftThreatIntelligence' (Required): The data connector kind +* **properties**: [MstiDataConnectorProperties](#mstidataconnectorproperties): Microsoft Threat Intelligence data connector properties. + +### MTPDataConnector +#### Properties +* **kind**: 'MicrosoftThreatProtection' (Required): The data connector kind +* **properties**: [MTPDataConnectorProperties](#mtpdataconnectorproperties): MTP (Microsoft Threat Protection) data connector properties. + +### OfficeDataConnector +#### Properties +* **kind**: 'Office365' (Required): The data connector kind +* **properties**: [OfficeDataConnectorProperties](#officedataconnectorproperties): Office data connector properties. + +### Office365ProjectDataConnector +#### Properties +* **kind**: 'Office365Project' (Required): The data connector kind +* **properties**: [Office365ProjectDataConnectorProperties](#office365projectdataconnectorproperties): Office Microsoft Project data connector properties. + +### OfficeATPDataConnector +#### Properties +* **kind**: 'OfficeATP' (Required): The data connector kind +* **properties**: [OfficeATPDataConnectorProperties](#officeatpdataconnectorproperties): OfficeATP (Office 365 Advanced Threat Protection) data connector properties. + +### OfficeIRMDataConnector +#### Properties +* **kind**: 'OfficeIRM' (Required): The data connector kind +* **properties**: [OfficeIRMDataConnectorProperties](#officeirmdataconnectorproperties): OfficeIRM (Microsoft Insider Risk Management) data connector properties. + +### OfficePowerBIDataConnector +#### Properties +* **kind**: 'OfficePowerBI' (Required): The data connector kind +* **properties**: [OfficePowerBIDataConnectorProperties](#officepowerbidataconnectorproperties): Office Microsoft PowerBI data connector properties. + +### TIDataConnector +#### Properties +* **kind**: 'ThreatIntelligence' (Required): The data connector kind +* **properties**: [TIDataConnectorProperties](#tidataconnectorproperties): TI (Threat Intelligence) data connector properties. + +### TiTaxiiDataConnector +#### Properties +* **kind**: 'ThreatIntelligenceTaxii' (Required): The data connector kind +* **properties**: [TiTaxiiDataConnectorProperties](#titaxiidataconnectorproperties): Threat Intelligence TAXII data connector properties. + + +## Resource Microsoft.SecurityInsights/entityQueries@2022-04-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/entityQueries' (ReadOnly, DeployTimeConstant): The resource type +### ActivityCustomEntityQuery +#### Properties +* **kind**: 'Activity' (Required): the entity query kind +* **properties**: [ActivityEntityQueriesProperties](#activityentityqueriesproperties): Describes activity entity query properties + +### ExpansionEntityQuery +#### Properties +* **kind**: 'Expansion' (Required): the entity query kind +* **properties**: [ExpansionEntityQueriesProperties](#expansionentityqueriesproperties) (ReadOnly): Describes expansion entity query properties + + +## Resource Microsoft.SecurityInsights/incidents@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentProperties](#incidentproperties): Describes incident properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/comments@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [IncidentCommentProperties](#incidentcommentproperties): Incident comment property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/comments' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/incidents/relations@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [RelationProperties](#relationproperties): Relation property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/incidents/relations' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/metadata@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [MetadataProperties](#metadataproperties): Metadata property bag. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/metadata' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/onboardingStates@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SentinelOnboardingStateProperties](#sentinelonboardingstateproperties): The Sentinel onboarding state properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/onboardingStates' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/settings@2022-04-01-preview +* **Valid Scope(s)**: Extension +* **Discriminator**: kind + +### Base Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/settings' (ReadOnly, DeployTimeConstant): The resource type +### Anomalies +#### Properties +* **kind**: 'Anomalies' (Required): The kind of the setting +* **properties**: [AnomaliesSettingsProperties](#anomaliessettingsproperties): Anomalies property bag. + +### EntityAnalytics +#### Properties +* **kind**: 'EntityAnalytics' (Required): The kind of the setting +* **properties**: [EntityAnalyticsProperties](#entityanalyticsproperties): EntityAnalytics property bag. + +### EyesOn +#### Properties +* **kind**: 'EyesOn' (Required): The kind of the setting +* **properties**: [EyesOnSettingsProperties](#eyesonsettingsproperties): EyesOn property bag. + +### Ueba +#### Properties +* **kind**: 'Ueba' (Required): The kind of the setting +* **properties**: [UebaProperties](#uebaproperties): Ueba property bag. + + +## Resource Microsoft.SecurityInsights/sourcecontrols@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [SourceControlProperties](#sourcecontrolproperties): Describes source control properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/sourcecontrols' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/threatIntelligence/indicators@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [ThreatIntelligenceIndicatorProperties](#threatintelligenceindicatorproperties) (WriteOnly): Describes threat intelligence entity properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/threatIntelligence/indicators' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistProperties](#watchlistproperties): Describes watchlist properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists' (ReadOnly, DeployTimeConstant): The resource type + +## Resource Microsoft.SecurityInsights/watchlists/watchlistItems@2022-04-01-preview +* **Valid Scope(s)**: Extension +### Properties +* **apiVersion**: '2022-04-01-preview' (ReadOnly, DeployTimeConstant): The resource api version +* **etag**: string: Etag of the azure resource +* **id**: string (ReadOnly, DeployTimeConstant): The resource id +* **name**: string (Required, DeployTimeConstant): The resource name +* **properties**: [WatchlistItemProperties](#watchlistitemproperties): Describes watchlist item properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: 'Microsoft.SecurityInsights/watchlists/watchlistItems' (ReadOnly, DeployTimeConstant): The resource type + +## AADDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## AatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## ActionRequestProperties +### Properties +* **logicAppResourceId**: string (Required): Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}. +* **triggerUri**: string (Required, WriteOnly): Logic App Callback URL for this specific workflow. +* **workflowId**: string (ReadOnly): The name of the logic app's workflow. + +## ActivityEntityQueriesProperties +### Properties +* **content**: string: The entity query content to display in timeline +* **createdTimeUtc**: string (ReadOnly): The time the activity was created +* **description**: string: The entity query description +* **enabled**: bool: Determines whether this activity is enabled or disabled. +* **entitiesFilter**: [ActivityEntityQueriesPropertiesEntitiesFilter](#activityentityqueriespropertiesentitiesfilter): The query applied only to entities matching to all filters +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The type of the entity +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the activity was updated +* **queryDefinitions**: [ActivityEntityQueriesPropertiesQueryDefinitions](#activityentityqueriespropertiesquerydefinitions): The Activity query definitions +* **requiredInputFieldsSets**: string[][]: List of the fields of the source entity that are required to run the query +* **templateName**: string: The template id this activity was created from +* **title**: string: The entity query title + +## ActivityEntityQueriesPropertiesEntitiesFilter +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## ActivityEntityQueriesPropertiesQueryDefinitions +### Properties +* **query**: string: The Activity query to run on a given entity + +## AlertDetailsOverride +### Properties +* **alertDescriptionFormat**: string: the format containing columns name(s) to override the alert description +* **alertDisplayNameFormat**: string: the format containing columns name(s) to override the alert name +* **alertSeverityColumnName**: string: the column name to take the alert severity from +* **alertTacticsColumnName**: string: the column name to take the alert tactics from + +## AlertsDataTypeOfDataConnector +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. + +## AnomaliesSettingsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## ApiPollingParameters +### Properties +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade +* **pollingConfig**: [CodelessConnectorPollingConfigProperties](#codelessconnectorpollingconfigproperties): Config to describe the polling config for API poller connector + +## ASCDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## AutomationRuleAction +* **Discriminator**: actionType + +### Base Properties +* **order**: int (Required) +### AutomationRuleModifyPropertiesAction +#### Properties +* **actionConfiguration**: [IncidentPropertiesAction](#incidentpropertiesaction) +* **actionType**: 'ModifyProperties' (Required): The type of the automation rule action + +### AutomationRuleRunPlaybookAction +#### Properties +* **actionConfiguration**: [PlaybookActionProperties](#playbookactionproperties) +* **actionType**: 'RunPlaybook' (Required): The type of the automation rule action + + +## AutomationRuleCondition +* **Discriminator**: conditionType + +### Base Properties +### PropertyConditionProperties +#### Properties +* **conditionProperties**: [AutomationRulePropertyValuesCondition](#automationrulepropertyvaluescondition) +* **conditionType**: 'Property' (Required) + + +## AutomationRuleProperties +### Properties +* **actions**: [AutomationRuleAction](#automationruleaction)[] (Required): The actions to execute when the automation rule is triggered +* **createdBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the automation rule was created +* **displayName**: string (Required): The display name of the automation rule +* **lastModifiedBy**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the automation rule was updated +* **order**: int (Required): The order of execution of the automation rule +* **triggeringLogic**: [AutomationRuleTriggeringLogic](#automationruletriggeringlogic) (Required): Describes automation rule triggering logic + +## AutomationRulePropertyValuesCondition +### Properties +* **operator**: 'Contains' | 'EndsWith' | 'Equals' | 'NotContains' | 'NotEndsWith' | 'NotEquals' | 'NotStartsWith' | 'StartsWith' | string +* **propertyName**: 'AccountAadTenantId' | 'AccountAadUserId' | 'AccountNTDomain' | 'AccountName' | 'AccountObjectGuid' | 'AccountPUID' | 'AccountSid' | 'AccountUPNSuffix' | 'AlertProductNames' | 'AzureResourceResourceId' | 'AzureResourceSubscriptionId' | 'CloudApplicationAppId' | 'CloudApplicationAppName' | 'DNSDomainName' | 'FileDirectory' | 'FileHashValue' | 'FileName' | 'HostAzureID' | 'HostNTDomain' | 'HostName' | 'HostNetBiosName' | 'HostOSVersion' | 'IPAddress' | 'IncidentDescription' | 'IncidentLabel' | 'IncidentProviderName' | 'IncidentRelatedAnalyticRuleIds' | 'IncidentSeverity' | 'IncidentStatus' | 'IncidentTactics' | 'IncidentTitle' | 'IoTDeviceId' | 'IoTDeviceModel' | 'IoTDeviceName' | 'IoTDeviceOperatingSystem' | 'IoTDeviceType' | 'IoTDeviceVendor' | 'MailMessageDeliveryAction' | 'MailMessageDeliveryLocation' | 'MailMessageP1Sender' | 'MailMessageP2Sender' | 'MailMessageRecipient' | 'MailMessageSenderIP' | 'MailMessageSubject' | 'MailboxDisplayName' | 'MailboxPrimaryAddress' | 'MailboxUPN' | 'MalwareCategory' | 'MalwareName' | 'ProcessCommandLine' | 'ProcessId' | 'RegistryKey' | 'RegistryValueData' | 'Url' | string: The property to evaluate in an automation rule property condition +* **propertyValues**: string[]: Array of AutomationRulePropertyValuesConditionPropertyValuesItem + +## AutomationRuleTriggeringLogic +### Properties +* **conditions**: [AutomationRuleCondition](#automationrulecondition)[]: The conditions to evaluate to determine if the automation rule should be triggered on a given object +* **expirationTimeUtc**: string: Determines when the automation rule should automatically expire and be disabled. +* **isEnabled**: bool (Required): Determines whether the automation rule is enabled or disabled +* **triggersOn**: 'Incidents' | string (Required) +* **triggersWhen**: 'Created' | string (Required) + +## Availability +### Properties +* **isPreview**: bool: Set connector as preview +* **status**: '1': The connector Availability Status + +## AwsCloudTrailDataConnectorDataTypes +### Properties +* **logs**: [AwsCloudTrailDataConnectorDataTypesLogs](#awscloudtraildataconnectordatatypeslogs) (Required): Logs data type. + +## AwsCloudTrailDataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsCloudTrailDataConnectorProperties +### Properties +* **awsRoleArn**: string: The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account. +* **dataTypes**: [AwsCloudTrailDataConnectorDataTypes](#awscloudtraildataconnectordatatypes) (Required): The available data types for Amazon Web Services CloudTrail data connector. + +## AwsS3DataConnectorDataTypes +### Properties +* **logs**: [AwsS3DataConnectorDataTypesLogs](#awss3dataconnectordatatypeslogs) (Required): Logs data type. + +## AwsS3DataConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## AwsS3DataConnectorProperties +### Properties +* **dataTypes**: [AwsS3DataConnectorDataTypes](#awss3dataconnectordatatypes) (Required): The available data types for Amazon Web Services S3 data connector. +* **destinationTable**: string (Required): The logs destination table name in LogAnalytics. +* **roleArn**: string (Required): The Aws Role Arn that is used to access the Aws account. +* **sqsUrls**: string[] (Required): The AWS sqs urls for the connector. + +## AzureDevOpsResourceInfo +### Properties +* **pipelineId**: string: Id of the pipeline created for the source-control. +* **serviceConnectionId**: string: Id of the service-connection created for the source-control. + +## BookmarkEntityMappings +### Properties +* **entityType**: string: The entity type +* **fieldMappings**: [EntityFieldMapping](#entityfieldmapping)[]: Array of fields mapping for that entity type + +## BookmarkProperties +### Properties +* **created**: string: The time the bookmark was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **displayName**: string (Required): The display name of the bookmark +* **entityMappings**: [BookmarkEntityMappings](#bookmarkentitymappings)[]: Describes the entity mappings of the bookmark +* **eventTime**: string: The bookmark event time +* **incidentInfo**: [IncidentInfo](#incidentinfo): Describes related incident information for the bookmark +* **labels**: string[]: List of labels relevant to this bookmark +* **notes**: string: The notes of the bookmark +* **query**: string (Required): The query of the bookmark. +* **queryEndTime**: string: The end time for the query +* **queryResult**: string: The query result of the bookmark. +* **queryStartTime**: string: The start time for the query +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: A list of relevant mitre attacks +* **techniques**: string[]: A list of relevant mitre techniques +* **updated**: string: The last time the bookmark was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action + +## ClientInfo +### Properties +* **email**: string: The email of the client. +* **name**: string: The name of the client. +* **objectId**: string: The object id of the client. +* **userPrincipalName**: string: The user principal name of the client. + +## CodelessConnectorPollingAuthProperties +### Properties +* **apiKeyIdentifier**: string: A prefix send in the header before the actual token +* **apiKeyName**: string: The header name which the token is sent with +* **authorizationEndpoint**: string: The endpoint used to authorize the user, used in Oauth 2.0 flow +* **authorizationEndpointQueryParameters**: any: Any object +* **authType**: string (Required): The authentication type +* **flowName**: string: Describes the flow name, for example 'AuthCode' for Oauth 2.0 +* **isApiKeyInPostPayload**: string: Marks if the key should sent in header +* **isClientSecretInHeader**: bool: Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow +* **redirectionEndpoint**: string: The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow +* **scope**: string: The OAuth token scope +* **tokenEndpoint**: string: The endpoint used to issue a token, used in Oauth 2.0 flow +* **tokenEndpointHeaders**: any: Any object +* **tokenEndpointQueryParameters**: any: Any object + +## CodelessConnectorPollingConfigProperties +### Properties +* **auth**: [CodelessConnectorPollingAuthProperties](#codelessconnectorpollingauthproperties) (Required): Describe the authentication properties needed to successfully authenticate with the server +* **isActive**: bool: The poller active status +* **paging**: [CodelessConnectorPollingPagingProperties](#codelessconnectorpollingpagingproperties): Describe the properties needed to make a pagination call +* **request**: [CodelessConnectorPollingRequestProperties](#codelessconnectorpollingrequestproperties) (Required): Describe the request properties needed to successfully pull from the server +* **response**: [CodelessConnectorPollingResponseProperties](#codelessconnectorpollingresponseproperties): Describes the response from the external server + +## CodelessConnectorPollingPagingProperties +### Properties +* **nextPageParaName**: string: Defines the name of a next page attribute +* **nextPageTokenJsonPath**: string: Defines the path to a next page token JSON +* **pageCountAttributePath**: string: Defines the path to a page count attribute +* **pageSize**: int: Defines the paging size +* **pageSizeParaName**: string: Defines the name of the page size parameter +* **pageTimeStampAttributePath**: string: Defines the path to a paging time stamp attribute +* **pageTotalCountAttributePath**: string: Defines the path to a page total count attribute +* **pagingType**: string (Required): Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp' +* **searchTheLatestTimeStampFromEventsList**: string: Determines whether to search for the latest time stamp in the events list + +## CodelessConnectorPollingRequestProperties +### Properties +* **apiEndpoint**: string (Required): Describe the endpoint we should pull the data from +* **endTimeAttributeName**: string: This will be used the query events from the end of the time window +* **headers**: any: Any object +* **httpMethod**: string (Required): The http method type we will use in the poll request, GET or POST +* **queryParameters**: any: Any object +* **queryParametersTemplate**: string: For advanced scenarios for example user name/password embedded in nested JSON payload +* **queryTimeFormat**: string (Required): The time format will be used the query events in a specific window +* **queryWindowInMin**: int (Required): The window interval we will use the pull the data +* **rateLimitQps**: int: Defines the rate limit QPS +* **retryCount**: int: Describe the amount of time we should try and poll the data in case of failure +* **startTimeAttributeName**: string: This will be used the query events from a start of the time window +* **timeoutInSeconds**: int: The number of seconds we will consider as a request timeout + +## CodelessConnectorPollingResponseProperties +### Properties +* **eventsJsonPaths**: string[] (Required): Describes the path we should extract the data in the response +* **isGzipCompressed**: bool: Describes if the data in the response is Gzip +* **successStatusJsonPath**: string: Describes the path we should extract the status code in the response +* **successStatusValue**: string: Describes the path we should extract the status value in the response + +## CodelessParameters +### Properties +* **connectorUiConfig**: [CodelessUiConnectorConfigProperties](#codelessuiconnectorconfigproperties): Config to describe the instructions blade + +## CodelessUiConnectorConfigProperties +### Properties +* **availability**: [Availability](#availability) (Required): Connector Availability Status +* **connectivityCriteria**: [CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem](#codelessuiconnectorconfigpropertiesconnectivitycriteriaitem)[] (Required): Define the way the connector check connectivity +* **customImage**: string: An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery +* **dataTypes**: [CodelessUiConnectorConfigPropertiesDataTypesItem](#codelessuiconnectorconfigpropertiesdatatypesitem)[] (Required): Data types to check for last data received +* **descriptionMarkdown**: string (Required): Connector description +* **graphQueries**: [CodelessUiConnectorConfigPropertiesGraphQueriesItem](#codelessuiconnectorconfigpropertiesgraphqueriesitem)[] (Required): The graph query to show the current data status +* **graphQueriesTableName**: string (Required): Name of the table the connector will insert the data to +* **instructionSteps**: [CodelessUiConnectorConfigPropertiesInstructionStepsItem](#codelessuiconnectorconfigpropertiesinstructionstepsitem)[] (Required): Instruction steps to enable the connector +* **permissions**: [Permissions](#permissions) (Required): Permissions required for the connector +* **publisher**: string (Required): Connector publisher name +* **sampleQueries**: [CodelessUiConnectorConfigPropertiesSampleQueriesItem](#codelessuiconnectorconfigpropertiessamplequeriesitem)[] (Required): The sample queries for the connector +* **title**: string (Required): Connector blade title + +## CodelessUiConnectorConfigPropertiesConnectivityCriteriaItem +### Properties +* **type**: 'IsConnectedQuery' | string: type of connectivity +* **value**: string[]: Queries for checking connectivity + +## CodelessUiConnectorConfigPropertiesDataTypesItem +### Properties +* **lastDataReceivedQuery**: string: Query for indicate last data received +* **name**: string: Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder + +## CodelessUiConnectorConfigPropertiesGraphQueriesItem +### Properties +* **baseQuery**: string: The base query for the graph +* **legend**: string: The legend for the graph +* **metricName**: string: the metric that the query is checking + +## CodelessUiConnectorConfigPropertiesInstructionStepsItem +### Properties +* **description**: string: Instruction step description +* **instructions**: [InstructionStepsInstructionsItem](#instructionstepsinstructionsitem)[]: Instruction step details +* **title**: string: Instruction step title + +## CodelessUiConnectorConfigPropertiesSampleQueriesItem +### Properties +* **description**: string: The sample query description +* **query**: string: the sample query + +## ContentPathMap +### Properties +* **contentType**: 'AnalyticRule' | 'Workbook' | string: The content type of a source control path. +* **path**: string: The path to the content. + +## DataConnectorDataTypeCommon +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Deployment +### Properties +* **deploymentId**: string: Deployment identifier. +* **deploymentLogsUrl**: string: Url to access repository action logs. +* **deploymentResult**: 'Canceled' | 'Failed' | 'Success' | string: Status while trying to fetch the deployment information. +* **deploymentState**: 'Canceling' | 'Completed' | 'In_Progress' | 'Queued' | string: The current state of the deployment. +* **deploymentTime**: string: The time when the deployment finished. + +## DeploymentInfo +### Properties +* **deployment**: [Deployment](#deployment): Description about a deployment. +* **deploymentFetchStatus**: 'NotFound' | 'Success' | 'Unauthorized' | string: Status while trying to fetch the deployment information. +* **message**: string: Additional details about the deployment that can be shown to the user. + +## Dynamics365DataConnectorDataTypes +### Properties +* **dynamics365CdsActivities**: [Dynamics365DataConnectorDataTypesDynamics365CdsActivities](#dynamics365dataconnectordatatypesdynamics365cdsactivities) (Required): Common Data Service data type connection. + +## Dynamics365DataConnectorDataTypesDynamics365CdsActivities +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Dynamics365DataConnectorProperties +### Properties +* **dataTypes**: [Dynamics365DataConnectorDataTypes](#dynamics365dataconnectordatatypes) (Required): The available data types for Dynamics365 data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## EntityAnalyticsProperties +### Properties +* **entityProviders**: 'ActiveDirectory' | 'AzureActiveDirectory' | string[]: The relevant entity providers that are synced + +## EntityCommonPropertiesAdditionalData +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## EntityFieldMapping +### Properties +* **identifier**: string: Alert V3 identifier +* **value**: string: The value of the identifier + +## EntityMapping +### Properties +* **entityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string: The V3 type of the mapped entity +* **fieldMappings**: [FieldMapping](#fieldmapping)[]: array of field mappings for the given entity mapping + +## EventGroupingSettings +### Properties +* **aggregationKind**: 'AlertPerResult' | 'SingleAlert' | string: The event grouping aggregation kinds + +## ExpansionEntityQueriesProperties +### Properties +* **dataSources**: string[] (ReadOnly): List of the data sources that are required to run the query +* **displayName**: string (ReadOnly): The query display name +* **inputEntityType**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string (ReadOnly): The type of the entity +* **inputFields**: string[] (ReadOnly): List of the fields of the source entity that are required to run the query +* **outputEntityTypes**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'HuntingBookmark' | 'IP' | 'IoTDevice' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityAlert' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[] (ReadOnly): List of the desired output types to be constructed from the result +* **queryTemplate**: string (ReadOnly): The template query string to be parsed and formatted + +## EyesOnSettingsProperties +### Properties +* **isEnabled**: bool (ReadOnly): Determines whether the setting is enable or disabled. + +## FieldMapping +### Properties +* **columnName**: string: the column name to be mapped to the identifier +* **identifier**: string: the V3 identifier of the entity + +## FusionAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **scenarioExclusionPatterns**: [FusionScenarioExclusionPattern](#fusionscenarioexclusionpattern)[]: Configuration to exclude scenarios in fusion detection. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **sourceSettings**: [FusionSourceSettings](#fusionsourcesettings)[]: Configuration for all supported source signals in fusion detection. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## FusionScenarioExclusionPattern +### Properties +* **dateAddedInUTC**: string (Required): DateTime when scenario exclusion pattern is added in UTC. +* **exclusionPattern**: string (Required): Scenario exclusion pattern. + +## FusionSourceSettings +### Properties +* **enabled**: bool (Required): Determines whether this source signal is enabled or disabled in Fusion detection. +* **sourceName**: string (Required): Name of the Fusion source signal. Refer to Fusion alert rule template for supported values. +* **sourceSubTypes**: [FusionSourceSubTypeSetting](#fusionsourcesubtypesetting)[]: Configuration for all source subtypes under this source signal consumed in fusion detection. + +## FusionSourceSubTypeSetting +### Properties +* **enabled**: bool (Required): Determines whether this source subtype under source signal is enabled or disabled in Fusion detection. +* **severityFilters**: [FusionSubTypeSeverityFilter](#fusionsubtypeseverityfilter) (Required): Represents severity configuration for a source subtype consumed in Fusion detection. +* **sourceSubTypeDisplayName**: string (ReadOnly): The display name of source subtype under a source signal consumed in Fusion detection. +* **sourceSubTypeName**: string (Required): The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values. + +## FusionSubTypeSeverityFilter +### Properties +* **filters**: [FusionSubTypeSeverityFiltersItem](#fusionsubtypeseverityfiltersitem)[]: Individual Severity configuration settings for a given source subtype consumed in Fusion detection. +* **isSupported**: bool (ReadOnly): Determines whether this source subtype supports severity configuration or not. + +## FusionSubTypeSeverityFiltersItem +### Properties +* **enabled**: bool (Required): Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the alert + +## GitHubResourceInfo +### Properties +* **appInstallationId**: string: GitHub application installation id. + +## GroupingConfiguration +### Properties +* **enabled**: bool (Required): Grouping enabled +* **groupByAlertDetails**: 'DisplayName' | 'Severity' | string[]: A list of alert details to group by (when matchingMethod is Selected) +* **groupByCustomDetails**: string[]: A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. +* **groupByEntities**: 'Account' | 'AzureResource' | 'CloudApplication' | 'DNS' | 'File' | 'FileHash' | 'Host' | 'IP' | 'MailCluster' | 'MailMessage' | 'Mailbox' | 'Malware' | 'Process' | 'RegistryKey' | 'RegistryValue' | 'SecurityGroup' | 'SubmissionMail' | 'URL' | string[]: A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. +* **lookbackDuration**: string (Required): Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) +* **matchingMethod**: 'AllEntities' | 'AnyAlert' | 'Selected' | string (Required): Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. +* **reopenClosedIncident**: bool (Required): Re-open closed matching incidents + +## IncidentAdditionalData +### Properties +* **alertProductNames**: string[] (ReadOnly): List of product names of alerts in the incident +* **alertsCount**: int (ReadOnly): The number of alerts in the incident +* **bookmarksCount**: int (ReadOnly): The number of bookmarks in the incident +* **commentsCount**: int (ReadOnly): The number of comments in the incident +* **providerIncidentUrl**: string (ReadOnly): The provider incident url to the incident in Microsoft 365 Defender portal +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics associated with incident +* **techniques**: string[] (ReadOnly): The techniques associated with incident's tactics' + +## IncidentCommentProperties +### Properties +* **author**: [ClientInfo](#clientinfo) (ReadOnly): Information on the client (user or application) that made some action +* **createdTimeUtc**: string (ReadOnly): The time the comment was created +* **lastModifiedTimeUtc**: string (ReadOnly): The time the comment was updated +* **message**: string (Required): The comment message + +## IncidentConfiguration +### Properties +* **createIncident**: bool (Required): Create incidents from alerts triggered by this analytics rule +* **groupingConfiguration**: [GroupingConfiguration](#groupingconfiguration): Grouping configuration property bag. + +## IncidentInfo +### Properties +* **incidentId**: string: Incident Id +* **relationName**: string: Relation Name +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **title**: string: The title of the incident + +## IncidentLabel +### Properties +* **labelName**: string (Required): The name of the label +* **labelType**: 'AutoAssigned' | 'User' | string (ReadOnly): The type of the label + +## IncidentOwnerInfo +### Properties +* **assignedTo**: string: The name of the user the incident is assigned to. +* **email**: string: The email of the user the incident is assigned to. +* **objectId**: string: The object id of the user the incident is assigned to. +* **ownerType**: 'Group' | 'Unknown' | 'User' | string: The type of the owner the incident is assigned to. +* **userPrincipalName**: string: The user principal name of the user the incident is assigned to. + +## IncidentProperties +### Properties +* **additionalData**: [IncidentAdditionalData](#incidentadditionaldata) (ReadOnly): Incident additional data property bag. +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **createdTimeUtc**: string (ReadOnly): The time the incident was created +* **description**: string: The description of the incident +* **firstActivityTimeUtc**: string: The time of the first activity in the incident +* **incidentNumber**: int (ReadOnly): A sequential number +* **incidentUrl**: string (ReadOnly): The deep-link url to the incident in Azure portal +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels relevant to this incident +* **lastActivityTimeUtc**: string: The time of the last activity in the incident +* **lastModifiedTimeUtc**: string (ReadOnly): The last time the incident was updated +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **providerIncidentId**: string: The incident ID assigned by the incident provider +* **providerName**: string: The name of the source provider that generated the incident +* **relatedAnalyticRuleIds**: string[] (ReadOnly): List of resource ids of Analytic rules related to the incident +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string (Required): The status of the incident +* **teamInformation**: [TeamInformation](#teaminformation): Describes team information +* **title**: string (Required): The title of the incident + +## IncidentPropertiesAction +### Properties +* **classification**: 'BenignPositive' | 'FalsePositive' | 'TruePositive' | 'Undetermined' | string: The reason the incident was closed +* **classificationComment**: string: Describes the reason the incident was closed +* **classificationReason**: 'InaccurateData' | 'IncorrectAlertLogic' | 'SuspiciousActivity' | 'SuspiciousButExpected' | string: The classification reason the incident was closed with +* **labels**: [IncidentLabel](#incidentlabel)[]: List of labels to add to the incident +* **owner**: [IncidentOwnerInfo](#incidentownerinfo): Information on the user an incident is assigned to +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the incident +* **status**: 'Active' | 'Closed' | 'New' | string: The status of the incident + +## InstructionStepsInstructionsItem +### Properties +* **parameters**: any: Any object +* **type**: 'CopyableLabel' | 'InfoMessage' | 'InstructionStepsGroup' | string (Required): The kind of the setting + +## IoTDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **subscriptionId**: string: The subscription id to connect to, and get the data from. + +## McasDataConnectorDataTypes +### Properties +* **alerts**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon) (Required): Common field for data type in data connectors. +* **discoveryLogs**: [DataConnectorDataTypeCommon](#dataconnectordatatypecommon): Common field for data type in data connectors. + +## McasDataConnectorProperties +### Properties +* **dataTypes**: [McasDataConnectorDataTypes](#mcasdataconnectordatatypes) (Required): The available data types for MCAS (Microsoft Cloud App Security) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MdatpDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MetadataAuthor +### Properties +* **email**: string: Email of author contact +* **link**: string: Link for author/vendor page +* **name**: string: Name of the author. Company or person. + +## MetadataCategories +### Properties +* **domains**: string[]: domain for the solution content item +* **verticals**: string[]: Industry verticals for the solution content item + +## MetadataDependencies +### Properties +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **criteria**: [MetadataDependencies](#metadatadependencies)[]: This is the list of dependencies we must fulfill, according to the AND/OR operator +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'AutomationRule' | 'AzureFunction' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'LogicAppsCustomConnector' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string: The kind of content the metadata is for. +* **name**: string: Name of the content item +* **operator**: 'AND' | 'OR' | string: Operator used for list of dependencies in criteria array. +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks + +## MetadataProperties +### Properties +* **author**: [MetadataAuthor](#metadataauthor): Publisher or creator of the content item. +* **categories**: [MetadataCategories](#metadatacategories): ies for the solution content item +* **contentId**: string: Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId. +* **contentSchemaVersion**: string: Schema version of the content. Can be used to distinguish between different flow based on the schema version +* **customVersion**: string: The custom version of the content. A optional free text +* **dependencies**: [MetadataDependencies](#metadatadependencies): Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. +* **firstPublishDate**: string: first publish date of solution content item +* **icon**: string: the icon identifier. this id can later be fetched from the solution template +* **kind**: 'AnalyticsRule' | 'AnalyticsRuleTemplate' | 'AutomationRule' | 'AzureFunction' | 'DataConnector' | 'DataType' | 'HuntingQuery' | 'InvestigationQuery' | 'LogicAppsCustomConnector' | 'Parser' | 'Playbook' | 'PlaybookTemplate' | 'Solution' | 'Watchlist' | 'WatchlistTemplate' | 'Workbook' | 'WorkbookTemplate' | string (Required): The kind of content the metadata is for. +* **lastPublishDate**: string: last publish date of solution content item +* **parentId**: string (Required): Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group) +* **previewImages**: string[]: preview image file names. These will be taken from the solution artifacts +* **previewImagesDark**: string[]: preview image file names. These will be taken from the solution artifacts. used for dark theme support +* **providers**: string[]: Providers for the solution content item +* **source**: [MetadataSource](#metadatasource): The original source of the content item, where it comes from. +* **support**: [MetadataSupport](#metadatasupport): Support information for the content item. +* **threatAnalysisTactics**: string[]: the tactics the resource covers +* **threatAnalysisTechniques**: string[]: the techniques the resource covers, these have to be aligned with the tactics being used +* **version**: string: Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks + +## MetadataSource +### Properties +* **kind**: 'Community' | 'LocalWorkspace' | 'Solution' | 'SourceRepository' | string (Required): Source type of the content +* **name**: string: Name of the content source. The repo name, solution name, LA workspace name etc. +* **sourceId**: string: ID of the content source. The solution ID, workspace ID, etc + +## MetadataSupport +### Properties +* **email**: string: Email of support contact +* **link**: string: Link for support help, like to support page to open a ticket etc. +* **name**: string: Name of the support contact. Company or person. +* **tier**: 'Community' | 'Microsoft' | 'Partner' | string (Required): Type of support for content item + +## MicrosoftSecurityIncidentCreationAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **displayNamesExcludeFilter**: string[]: the alerts' displayNames on which the cases will not be generated +* **displayNamesFilter**: string[]: the alerts' displayNames on which the cases will be generated +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **productFilter**: 'Azure Active Directory Identity Protection' | 'Azure Advanced Threat Protection' | 'Azure Security Center for IoT' | 'Azure Security Center' | 'Microsoft Cloud App Security' | 'Microsoft Defender Advanced Threat Protection' | 'Office 365 Advanced Threat Protection' | string (Required): The alerts' productName on which the cases will be generated +* **severitiesFilter**: 'High' | 'Informational' | 'Low' | 'Medium' | string[]: the alerts' severities on which the cases will be generated + +## MLBehaviorAnalyticsAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## MstiDataConnectorDataTypes +### Properties +* **bingSafetyPhishingURL**: [MstiDataConnectorDataTypesBingSafetyPhishingURL](#mstidataconnectordatatypesbingsafetyphishingurl) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. +* **microsoftEmergingThreatFeed**: [MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed](#mstidataconnectordatatypesmicrosoftemergingthreatfeed) (Required): Data type for Microsoft Threat Intelligence Platforms data connector. + +## MstiDataConnectorDataTypesBingSafetyPhishingURL +### Properties +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MstiDataConnectorDataTypesMicrosoftEmergingThreatFeed +### Properties +* **lookbackPeriod**: string (Required): lookback period +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MstiDataConnectorProperties +### Properties +* **dataTypes**: [MstiDataConnectorDataTypes](#mstidataconnectordatatypes) (Required): The available data types for Microsoft Threat Intelligence Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## MTPDataConnectorDataTypes +### Properties +* **incidents**: [MTPDataConnectorDataTypesIncidents](#mtpdataconnectordatatypesincidents) (Required): Data type for Microsoft Threat Protection Platforms data connector. + +## MTPDataConnectorDataTypesIncidents +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## MTPDataConnectorProperties +### Properties +* **dataTypes**: [MTPDataConnectorDataTypes](#mtpdataconnectordatatypes) (Required): The available data types for Microsoft Threat Protection Platforms data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## NrtAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [NrtAlertRulePropertiesCustomDetails](#nrtalertrulepropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string (Required): The query that creates alerts for this rule. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (Required): The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: The tactics of the alert rule +* **techniques**: string[]: The techniques of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> + +## NrtAlertRulePropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Office365ProjectConnectorDataTypes +### Properties +* **logs**: [Office365ProjectConnectorDataTypesLogs](#office365projectconnectordatatypeslogs) (Required): Logs data type. + +## Office365ProjectConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## Office365ProjectDataConnectorProperties +### Properties +* **dataTypes**: [Office365ProjectConnectorDataTypes](#office365projectconnectordatatypes) (Required): The available data types for Office Microsoft Project data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeATPDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeDataConnectorDataTypes +### Properties +* **exchange**: [OfficeDataConnectorDataTypesExchange](#officedataconnectordatatypesexchange) (Required): Exchange data type connection. +* **sharePoint**: [OfficeDataConnectorDataTypesSharePoint](#officedataconnectordatatypessharepoint) (Required): SharePoint data type connection. +* **teams**: [OfficeDataConnectorDataTypesTeams](#officedataconnectordatatypesteams) (Required): Teams data type connection. + +## OfficeDataConnectorDataTypesExchange +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesSharePoint +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorDataTypesTeams +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficeDataConnectorProperties +### Properties +* **dataTypes**: [OfficeDataConnectorDataTypes](#officedataconnectordatatypes) (Required): The available data types for office data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficeIRMDataConnectorProperties +### Properties +* **dataTypes**: [AlertsDataTypeOfDataConnector](#alertsdatatypeofdataconnector): Alerts data type for data connectors. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## OfficePowerBIConnectorDataTypes +### Properties +* **logs**: [OfficePowerBIConnectorDataTypesLogs](#officepowerbiconnectordatatypeslogs) (Required): Logs data type. + +## OfficePowerBIConnectorDataTypesLogs +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## OfficePowerBIDataConnectorProperties +### Properties +* **dataTypes**: [OfficePowerBIConnectorDataTypes](#officepowerbiconnectordatatypes) (Required): The available data types for Office Microsoft PowerBI data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. + +## Permissions +### Properties +* **customs**: [PermissionsCustomsItem](#permissionscustomsitem)[]: Customs permissions required for the connector +* **resourceProvider**: [PermissionsResourceProviderItem](#permissionsresourceprovideritem)[]: Resource provider permissions required for the connector + +## PermissionsCustomsItem +### Properties +* **description**: string: Customs permissions description +* **name**: string: Customs permissions name + +## PermissionsResourceProviderItem +### Properties +* **permissionsDisplayText**: string: Permission description text +* **provider**: 'Microsoft.Authorization/policyAssignments' | 'Microsoft.OperationalInsights/solutions' | 'Microsoft.OperationalInsights/workspaces' | 'Microsoft.OperationalInsights/workspaces/datasources' | 'Microsoft.OperationalInsights/workspaces/sharedKeys' | 'microsoft.aadiam/diagnosticSettings' | string: Provider name +* **providerDisplayName**: string: Permission provider display name +* **requiredPermissions**: [RequiredPermissions](#requiredpermissions): Required permissions for the connector +* **scope**: 'ResourceGroup' | 'Subscription' | 'Workspace' | string: Permission provider scope + +## PlaybookActionProperties +### Properties +* **logicAppResourceId**: string: The resource id of the playbook resource +* **tenantId**: string: The tenant id of the playbook resource + +## RelationProperties +### Properties +* **relatedResourceId**: string (Required): The resource ID of the related resource +* **relatedResourceKind**: string (ReadOnly): The resource kind of the related resource +* **relatedResourceName**: string (ReadOnly): The name of the related resource +* **relatedResourceType**: string (ReadOnly): The resource type of the related resource + +## Repository +### Properties +* **branch**: string: Branch name of repository. +* **deploymentLogsUrl**: string: Url to access repository action logs. +* **displayUrl**: string: Display url of repository. +* **pathMapping**: [ContentPathMap](#contentpathmap)[]: Dictionary of source control content type and path mapping. +* **url**: string: Url of repository. + +## RepositoryResourceInfo +### Properties +* **azureDevOpsResourceInfo**: [AzureDevOpsResourceInfo](#azuredevopsresourceinfo): Resources created in Azure DevOps repository. +* **gitHubResourceInfo**: [GitHubResourceInfo](#githubresourceinfo): Resources created in GitHub repository. +* **webhook**: [Webhook](#webhook): Detail about the webhook object. + +## RequiredPermissions +### Properties +* **action**: bool: action permission +* **delete**: bool: delete permission +* **read**: bool: read permission +* **write**: bool: write permission + +## ScheduledAlertRuleCommonPropertiesCustomDetails +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScheduledAlertRuleProperties +### Properties +* **alertDetailsOverride**: [AlertDetailsOverride](#alertdetailsoverride): Settings for how to dynamically override alert static details +* **alertRuleTemplateName**: string: The Name of the alert rule template used to create this rule. +* **customDetails**: [ScheduledAlertRuleCommonPropertiesCustomDetails](#scheduledalertrulecommonpropertiescustomdetails): Dictionary of string key-value pairs of columns to be attached to the alert +* **description**: string: The description of the alert rule. +* **displayName**: string (Required): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **entityMappings**: [EntityMapping](#entitymapping)[]: List of entity mappings of the alert rule +* **eventGroupingSettings**: [EventGroupingSettings](#eventgroupingsettings): Event grouping settings property bag. +* **incidentConfiguration**: [IncidentConfiguration](#incidentconfiguration): Incident Configuration property bag. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert rule has been modified. +* **query**: string: The query that creates alerts for this rule. +* **queryFrequency**: string: The frequency (in ISO 8601 duration format) for this alert rule to run. +* **queryPeriod**: string: The period (in ISO 8601 duration format) that this alert rule looks at. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string: The severity of the alert +* **suppressionDuration**: string (Required): The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered. +* **suppressionEnabled**: bool (Required): Determines whether the suppression for this alert rule is enabled or disabled. +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[]: The tactics of the alert rule +* **techniques**: string[]: The techniques of the alert rule +* **templateVersion**: string: The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2> +* **triggerOperator**: 'Equal' | 'GreaterThan' | 'LessThan' | 'NotEqual': The operation against the threshold that triggers alert rule. +* **triggerThreshold**: int: The threshold triggers this alert rule. + +## SentinelOnboardingStateProperties +### Properties +* **customerManagedKey**: bool: Flag that indicates the status of the CMK setting + +## SourceControlProperties +### Properties +* **contentTypes**: 'AnalyticRule' | 'Workbook' | string[] (Required): Array of source control content types. +* **description**: string: A description of the source control +* **displayName**: string (Required): The display name of the source control +* **id**: string: The id (a Guid) of the source control +* **lastDeploymentInfo**: [DeploymentInfo](#deploymentinfo): Information regarding a deployment. +* **repository**: [Repository](#repository) (Required): metadata of a repository. +* **repositoryResourceInfo**: [RepositoryResourceInfo](#repositoryresourceinfo): Resources created in user's repository for the source-control. +* **repoType**: 'DevOps' | 'Github' | string (Required): The type of repository. +* **version**: 'V1' | 'V2' | string: The version of the source control. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TeamInformation +### Properties +* **description**: string (ReadOnly): The description of the team +* **name**: string (ReadOnly): The name of the team +* **primaryChannelUrl**: string (ReadOnly): The primary channel URL of the team +* **teamCreationTimeUtc**: string (ReadOnly): The time the team was created +* **teamId**: string (ReadOnly): Team ID + +## ThreatIntelligenceAlertRuleProperties +### Properties +* **alertRuleTemplateName**: string (Required): The Name of the alert rule template used to create this rule. +* **description**: string (ReadOnly): The description of the alert rule. +* **displayName**: string (ReadOnly): The display name for alerts created by this alert rule. +* **enabled**: bool (Required): Determines whether this alert rule is enabled or disabled. +* **lastModifiedUtc**: string (ReadOnly): The last time that this alert has been modified. +* **severity**: 'High' | 'Informational' | 'Low' | 'Medium' | string (ReadOnly): The severity of the alert +* **tactics**: 'Collection' | 'CommandAndControl' | 'CredentialAccess' | 'DefenseEvasion' | 'Discovery' | 'Execution' | 'Exfiltration' | 'Impact' | 'ImpairProcessControl' | 'InhibitResponseFunction' | 'InitialAccess' | 'LateralMovement' | 'Persistence' | 'PreAttack' | 'PrivilegeEscalation' | 'Reconnaissance' | 'ResourceDevelopment' | string[] (ReadOnly): The tactics of the alert rule +* **techniques**: string[] (ReadOnly): The techniques of the alert rule + +## ThreatIntelligenceExternalReference +### Properties +* **description**: string (WriteOnly): External reference description +* **externalId**: string (WriteOnly): External reference ID +* **hashes**: [ThreatIntelligenceExternalReferenceHashes](#threatintelligenceexternalreferencehashes) (WriteOnly): External reference hashes +* **sourceName**: string (WriteOnly): External reference source name +* **url**: string (WriteOnly): External reference URL + +## ThreatIntelligenceExternalReferenceHashes +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ThreatIntelligenceGranularMarkingModel +### Properties +* **language**: string (WriteOnly): Language granular marking model +* **markingRef**: int (WriteOnly): marking reference granular marking model +* **selectors**: string[] (WriteOnly): granular marking model selectors + +## ThreatIntelligenceIndicatorProperties +### Properties +* **additionalData**: [EntityCommonPropertiesAdditionalData](#entitycommonpropertiesadditionaldata) (ReadOnly, WriteOnly): A bag of custom fields that should be part of the entity and will be presented to the user. +* **confidence**: int (WriteOnly): Confidence of threat intelligence entity +* **created**: string (WriteOnly): Created by +* **createdByRef**: string (WriteOnly): Created by reference of threat intelligence entity +* **defanged**: bool (WriteOnly): Is threat intelligence entity defanged +* **description**: string (WriteOnly): Description of a threat intelligence entity +* **displayName**: string (WriteOnly): Display name of a threat intelligence entity +* **extensions**: [ThreatIntelligenceIndicatorPropertiesExtensions](#threatintelligenceindicatorpropertiesextensions) (WriteOnly): Extensions map +* **externalId**: string (WriteOnly): External ID of threat intelligence entity +* **externalLastUpdatedTimeUtc**: string (WriteOnly): External last updated time in UTC +* **externalReferences**: [ThreatIntelligenceExternalReference](#threatintelligenceexternalreference)[] (WriteOnly): External References +* **friendlyName**: string (ReadOnly, WriteOnly): The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated. +* **granularMarkings**: [ThreatIntelligenceGranularMarkingModel](#threatintelligencegranularmarkingmodel)[] (WriteOnly): Granular Markings +* **indicatorTypes**: string[] (WriteOnly): Indicator types of threat intelligence entities +* **killChainPhases**: [ThreatIntelligenceKillChainPhase](#threatintelligencekillchainphase)[] (WriteOnly): Kill chain phases +* **labels**: string[] (WriteOnly): Labels of threat intelligence entity +* **language**: string (WriteOnly): Language of threat intelligence entity +* **lastUpdatedTimeUtc**: string (WriteOnly): Last updated time in UTC +* **modified**: string (WriteOnly): Modified by +* **objectMarkingRefs**: string[] (WriteOnly): Threat intelligence entity object marking references +* **parsedPattern**: [ThreatIntelligenceParsedPattern](#threatintelligenceparsedpattern)[] (WriteOnly): Parsed patterns +* **pattern**: string (WriteOnly): Pattern of a threat intelligence entity +* **patternType**: string (WriteOnly): Pattern type of a threat intelligence entity +* **patternVersion**: string (WriteOnly): Pattern version of a threat intelligence entity +* **revoked**: bool (WriteOnly): Is threat intelligence entity revoked +* **source**: string (WriteOnly): Source of a threat intelligence entity +* **threatIntelligenceTags**: string[] (WriteOnly): List of tags +* **threatTypes**: string[] (WriteOnly): Threat types +* **validFrom**: string (WriteOnly): Valid from +* **validUntil**: string (WriteOnly): Valid until + +## ThreatIntelligenceIndicatorPropertiesExtensions +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## ThreatIntelligenceKillChainPhase +### Properties +* **killChainName**: string (WriteOnly): Kill chainName name +* **phaseName**: string (WriteOnly): Phase name + +## ThreatIntelligenceParsedPattern +### Properties +* **patternTypeKey**: string (WriteOnly): Pattern type key +* **patternTypeValues**: [ThreatIntelligenceParsedPatternTypeValue](#threatintelligenceparsedpatterntypevalue)[] (WriteOnly): Pattern type keys + +## ThreatIntelligenceParsedPatternTypeValue +### Properties +* **value**: string (WriteOnly): Value of parsed pattern +* **valueType**: string (WriteOnly): Type of the value + +## TIDataConnectorDataTypes +### Properties +* **indicators**: [TIDataConnectorDataTypesIndicators](#tidataconnectordatatypesindicators) (Required): Data type for indicators connection. + +## TIDataConnectorDataTypesIndicators +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TIDataConnectorProperties +### Properties +* **dataTypes**: [TIDataConnectorDataTypes](#tidataconnectordatatypes) (Required): The available data types for TI (Threat Intelligence) data connector. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **tipLookbackPeriod**: string: The lookback period for the feed to be imported. + +## TiTaxiiDataConnectorDataTypes +### Properties +* **taxiiClient**: [TiTaxiiDataConnectorDataTypesTaxiiClient](#titaxiidataconnectordatatypestaxiiclient) (Required): Data type for TAXII connector. + +## TiTaxiiDataConnectorDataTypesTaxiiClient +### Properties +* **state**: 'Disabled' | 'Enabled' | string (Required): Describe whether this data type connection is enabled or not. + +## TiTaxiiDataConnectorProperties +### Properties +* **collectionId**: string: The collection id of the TAXII server. +* **dataTypes**: [TiTaxiiDataConnectorDataTypes](#titaxiidataconnectordatatypes) (Required): The available data types for Threat Intelligence TAXII data connector. +* **friendlyName**: string: The friendly name for the TAXII server. +* **password**: string: The password for the TAXII server. +* **pollingFrequency**: 'OnceADay' | 'OnceAMinute' | 'OnceAnHour' | string (Required): The polling frequency for the TAXII server. +* **taxiiLookbackPeriod**: string: The lookback period for the TAXII server. +* **taxiiServer**: string: The API root for the TAXII server. +* **tenantId**: string (Required): The tenant id to connect to, and get the data from. +* **userName**: string: The userName for the TAXII server. +* **workspaceId**: string: The workspace id. + +## UebaProperties +### Properties +* **dataSources**: 'AuditLogs' | 'AzureActivity' | 'SecurityEvent' | 'SigninLogs' | string[]: The relevant data sources that enriched by ueba + +## UserInfo +### Properties +* **email**: string (ReadOnly): The email of the user. +* **name**: string (ReadOnly): The name of the user. +* **objectId**: string: The object id of the user. + +## WatchlistItemProperties +### Properties +* **created**: string: The time the watchlist item was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **entityMapping**: [WatchlistItemPropertiesEntityMapping](#watchlistitempropertiesentitymapping): key-value pairs for a watchlist item entity mapping +* **isDeleted**: bool: A flag that indicates if the watchlist item is deleted or not +* **itemsKeyValue**: [WatchlistItemPropertiesItemsKeyValue](#watchlistitempropertiesitemskeyvalue) (Required): key-value pairs for a watchlist item +* **tenantId**: string: The tenantId to which the watchlist item belongs to +* **updated**: string: The last time the watchlist item was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **watchlistItemId**: string: The id (a Guid) of the watchlist item +* **watchlistItemType**: string: The type of the watchlist item + +## WatchlistItemPropertiesEntityMapping +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WatchlistItemPropertiesItemsKeyValue +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WatchlistProperties +### Properties +* **contentType**: string: The content type of the raw content. Example : text/csv or text/tsv +* **created**: string: The time the watchlist was created +* **createdBy**: [UserInfo](#userinfo): User information that made some action +* **defaultDuration**: string: The default duration of a watchlist (in ISO 8601 duration format) +* **description**: string: A description of the watchlist +* **displayName**: string (Required): The display name of the watchlist +* **isDeleted**: bool: A flag that indicates if the watchlist is deleted or not +* **itemsSearchKey**: string (Required): The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address. +* **labels**: string[]: List of labels relevant to this watchlist +* **numberOfLinesToSkip**: int: The number of lines in a csv/tsv content to skip before the header +* **provider**: string (Required): The provider of the watchlist +* **rawContent**: string: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint +* **source**: string: The filename of the watchlist, called 'source' +* **sourceType**: 'Local file' | 'Remote storage' | string: The sourceType of the watchlist +* **tenantId**: string: The tenantId where the watchlist belongs to +* **updated**: string: The last time the watchlist was updated +* **updatedBy**: [UserInfo](#userinfo): User information that made some action +* **uploadStatus**: string: The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted +* **watchlistAlias**: string: The alias of the watchlist +* **watchlistId**: string: The id (a Guid) of the watchlist +* **watchlistType**: string: The type of the watchlist + +## Webhook +### Properties +* **rotateWebhookSecret**: bool: A flag to instruct the backend service to rotate webhook secret. +* **webhookId**: string: Unique identifier for the webhook. +* **webhookSecretUpdateTime**: string: Time when the webhook secret was updated. +* **webhookUrl**: string: URL that gets invoked by the webhook. + diff --git a/generated/serialconsole/log.out b/generated/serialconsole/log.out index 589f8ae170..627b672fa1 100644 --- a/generated/serialconsole/log.out +++ b/generated/serialconsole/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.serialconsole-2018-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/serialconsole/resource-manager/Microsoft.SerialConsole/stable/2018-05-01/serialport.json:348:5 @@ -22,5 +22,5 @@ warning | PreCheck/SchemaMissingType | The schema 'CloudErrorBody' with an undef - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/serialconsole/resource-manager/Microsoft.SerialConsole/stable/2018-05-01/serialport.json:445:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used. -info | autorest.bicep took 11ms -info | Autorest completed in 4.69s. 2 files generated. +info | autorest.bicep took 10ms +info | Autorest completed in 4.37s. 2 files generated. diff --git a/generated/servicebus/log.out b/generated/servicebus/log.out index 5d88352ce3..688c73275d 100644 --- a/generated/servicebus/log.out +++ b/generated/servicebus/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.servicebus-2021-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceNamespacePatch' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-01-01-preview/namespace-preview.json:594:5 @@ -133,7 +133,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a p info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.servicebus-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ResourceNamespacePatch' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/namespace-preview.json:594:5 @@ -255,10 +255,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'sqlExpression' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'compatibilityLevel' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'requiresPreprocessing' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction -info | autorest.bicep took 7ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.servicebus-2018-01-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'IpFilterRule' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json:224:5 @@ -420,10 +420,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'sqlExpression' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'compatibilityLevel' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'requiresPreprocessing' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction -info | autorest.bicep took 8ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.servicebus-2021-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ArmDisasterRecovery-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/DisasterRecoveryConfig.json:323:9 @@ -443,10 +443,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'sqlExpression' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'compatibilityLevel' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'requiresPreprocessing' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction -info | autorest.bicep took 17ms +info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.servicebus-2017-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SBAuthorizationRuleListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json:978:5 @@ -570,10 +570,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'sqlExpression' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'compatibilityLevel' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction warning | PreCheck/PropertyRedeclarationWarning | Schema 'SqlRuleAction' has a property 'requiresPreprocessing' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction -info | autorest.bicep took 15ms +info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.servicebus-2015-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json:1823:5 @@ -635,5 +635,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json:2730:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrackedResource' has a property 'location' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from TrackedResource -info | autorest.bicep took 4ms -info | Autorest completed in 29.61s. 12 files generated. +info | autorest.bicep took 5ms +info | Autorest completed in 28.48s. 12 files generated. diff --git a/generated/servicebus/microsoft.servicebus/2015-08-01/types.md b/generated/servicebus/microsoft.servicebus/2015-08-01/types.md index ad088c4cf0..affb2f35c8 100644 --- a/generated/servicebus/microsoft.servicebus/2015-08-01/types.md +++ b/generated/servicebus/microsoft.servicebus/2015-08-01/types.md @@ -87,6 +87,19 @@ * **ApiVersion**: 2015-08-01 * **Output**: [ResourceListKeys](#resourcelistkeys) +## MessageCountDetails +### Properties +* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. +* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. +* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. +* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. +* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. + +## NamespaceCreateOrUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## NamespaceProperties ### Properties * **createACSNamespace**: bool: Indicates whether to create an ACS namespace. @@ -97,21 +110,6 @@ * **status**: 'Activating' | 'Active' | 'Created' | 'Creating' | 'Disabled' | 'Disabling' | 'Enabling' | 'Failed' | 'Removed' | 'Removing' | 'SoftDeleted' | 'SoftDeleting' | 'Unknown': State of the namespace. * **updatedAt**: string (ReadOnly): The time the namespace was updated. -## Sku -### Properties -* **capacity**: int: The specified messaging units for the tier. -* **name**: 'Basic' | 'Premium' | 'Standard' | string: Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): The billing tier of this particular SKU. - -## NamespaceCreateOrUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SharedAccessAuthorizationRuleProperties -### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. - ## QueueProperties ### Properties * **accessedAt**: string (ReadOnly): Last time a message was sent, or the last time there was a receive request to this queue. @@ -137,36 +135,39 @@ * **supportOrdering**: bool: A value that indicates whether the queue supports ordering. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## MessageCountDetails +## ResourceListKeys ### Properties -* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. -* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. -* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. -* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. -* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## TopicProperties +## ResourceListKeys ### Properties -* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. -* **autoDeleteOnIdle**: string: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. -* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **defaultMessageTimeToLive**: 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. -* **duplicateDetectionHistoryTimeWindow**: string: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. -* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. -* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. -* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. -* **entityAvailabilityStatus**: 'Available' | 'Limited' | 'Renaming' | 'Restoring' | 'Unknown': Entity availability status. -* **filteringMessagesBeforePublishing**: bool: Whether messages should be filtered before publishing. -* **isAnonymousAccessible**: bool: Value that indicates whether the message is accessible anonymously. -* **isExpress**: bool -* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. -* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. -* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. -* **subscriptionCount**: int (ReadOnly): Number of subscriptions. -* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## ResourceListKeys +### Properties +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## SharedAccessAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## Sku +### Properties +* **capacity**: int: The specified messaging units for the tier. +* **name**: 'Basic' | 'Premium' | 'Standard' | string: Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): The billing tier of this particular SKU. ## SubscriptionProperties ### Properties @@ -187,27 +188,26 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## ResourceListKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## ResourceListKeys -### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## ResourceListKeys +## TopicProperties ### Properties -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. +* **autoDeleteOnIdle**: string: TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. +* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **defaultMessageTimeToLive**: 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. +* **duplicateDetectionHistoryTimeWindow**: string: TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. +* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. +* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. +* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. +* **entityAvailabilityStatus**: 'Available' | 'Limited' | 'Renaming' | 'Restoring' | 'Unknown': Entity availability status. +* **filteringMessagesBeforePublishing**: bool: Whether messages should be filtered before publishing. +* **isAnonymousAccessible**: bool: Value that indicates whether the message is accessible anonymously. +* **isExpress**: bool +* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. +* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. +* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. +* **subscriptionCount**: int (ReadOnly): Number of subscriptions. +* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. diff --git a/generated/servicebus/microsoft.servicebus/2017-04-01/types.md b/generated/servicebus/microsoft.servicebus/2017-04-01/types.md index ed64c5a2bb..185e4e4333 100644 --- a/generated/servicebus/microsoft.servicebus/2017-04-01/types.md +++ b/generated/servicebus/microsoft.servicebus/2017-04-01/types.md @@ -122,28 +122,51 @@ * **ApiVersion**: 2017-04-01 * **Output**: [AccessKeys](#accesskeys) -## SBNamespaceProperties +## AccessKeys ### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created. -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBSku +## AccessKeys ### Properties -* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. -* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## TrackedResourceTags +## AccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBAuthorizationRuleProperties +## AccessKeys ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. + +## Action +### Properties +* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' ## ArmDisasterRecoveryProperties ### Properties @@ -153,6 +176,32 @@ * **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' * **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' +## CorrelationFilter +### Properties +* **contentType**: string: Content type of the message. +* **correlationId**: string: Identifier of the correlation. +* **label**: string: Application specific label. +* **messageId**: string: Identifier of the message. +* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters +* **replyTo**: string: Address of the queue to reply to. +* **replyToSessionId**: string: Session identifier to reply to. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sessionId**: string: Session identifier. +* **to**: string: Address to send to. + +## CorrelationFilterProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## MessageCountDetails +### Properties +* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. +* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. +* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. +* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. +* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. + ## MigrationConfigPropertiesProperties ### Properties * **migrationState**: string (ReadOnly): State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active @@ -177,9 +226,24 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing VNet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## Ruleproperties ### Properties -* **id**: string (Required): Resource ID of Virtual Network Subnet +* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. +* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. +* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types +* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. + +## SBAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## SBNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created. +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. ## SBQueueProperties ### Properties @@ -205,32 +269,11 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## MessageCountDetails -### Properties -* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. -* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. -* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. -* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. -* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. - -## SBTopicProperties +## SBSku ### Properties -* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. -* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. -* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **defaultMessageTimeToLive**: 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. -* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. -* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. -* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. -* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. -* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. -* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. -* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. -* **subscriptionCount**: int (ReadOnly): Number of subscriptions. -* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. +* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. ## SBSubscriptionProperties ### Properties @@ -252,36 +295,24 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## Ruleproperties -### Properties -* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. -* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. -* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types -* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. - -## Action -### Properties -* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' - -## CorrelationFilter -### Properties -* **contentType**: string: Content type of the message. -* **correlationId**: string: Identifier of the correlation. -* **label**: string: Application specific label. -* **messageId**: string: Identifier of the message. -* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters -* **replyTo**: string: Address of the queue to reply to. -* **replyToSessionId**: string: Session identifier to reply to. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sessionId**: string: Session identifier. -* **to**: string: Address to send to. - -## CorrelationFilterProperties +## SBTopicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. +* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. +* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **defaultMessageTimeToLive**: 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. +* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. +* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. +* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. +* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. +* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. +* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. +* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. +* **subscriptionCount**: int (ReadOnly): Number of subscriptions. +* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. ## SqlFilter ### Properties @@ -289,43 +320,12 @@ * **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. * **sqlExpression**: string: The SQL expression. e.g. MyProperty='ABC' -## AccessKeys -### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## AccessKeys +## Subnet ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **id**: string (Required): Resource ID of Virtual Network Subnet -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/servicebus/microsoft.servicebus/2018-01-01-preview/types.md b/generated/servicebus/microsoft.servicebus/2018-01-01-preview/types.md index 30b8bac6d1..2bb4bd9123 100644 --- a/generated/servicebus/microsoft.servicebus/2018-01-01-preview/types.md +++ b/generated/servicebus/microsoft.servicebus/2018-01-01-preview/types.md @@ -150,47 +150,51 @@ * **ApiVersion**: 2018-01-01-preview * **Output**: [AccessKeys](#accesskeys) -## Identity -### Properties -* **principalId**: string: ObjectId from the KeyVault -* **tenantId**: string: TenantId from the KeyVault -* **type**: 'SystemAssigned': Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' - -## SBNamespaceProperties -### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created -* **encryption**: [Encryption](#encryption): Properties to configure Encryption -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **status**: string (ReadOnly): Status of the namespace. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. -* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. - -## Encryption +## AccessKeys ### Properties -* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## KeyVaultProperties +## AccessKeys ### Properties -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBSku +## AccessKeys ### Properties -* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. -* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## TrackedResourceTags +## AccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBAuthorizationRuleProperties +## Action ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. +* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' ## ArmDisasterRecoveryProperties ### Properties @@ -200,12 +204,59 @@ * **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' * **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' +## ConnectionState +### Properties +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. + +## CorrelationFilter +### Properties +* **contentType**: string: Content type of the message. +* **correlationId**: string: Identifier of the correlation. +* **label**: string: Application specific label. +* **messageId**: string: Identifier of the message. +* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters +* **replyTo**: string: Address of the queue to reply to. +* **replyToSessionId**: string: Session identifier to reply to. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sessionId**: string: Session identifier. +* **to**: string: Address to send to. + +## CorrelationFilterProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Encryption +### Properties +* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties): Properties to configure keyVault Properties + +## Identity +### Properties +* **principalId**: string: ObjectId from the KeyVault +* **tenantId**: string: TenantId from the KeyVault +* **type**: 'SystemAssigned': Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' + ## IpFilterRuleProperties ### Properties * **action**: 'Accept' | 'Reject' | string: The IP Filter Action * **filterName**: string: IP Filter name * **ipMask**: string: IP Mask +## KeyVaultProperties +### Properties +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault + +## MessageCountDetails +### Properties +* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. +* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. +* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. +* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. +* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. + ## MigrationConfigPropertiesProperties ### Properties * **migrationState**: string (ReadOnly): State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active @@ -230,9 +281,9 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing VNet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## PrivateEndpoint ### Properties -* **id**: string (Required): Resource ID of Virtual Network Subnet +* **id**: string: The ARM identifier for Private Endpoint. ## PrivateEndpointConnectionProperties ### Properties @@ -240,14 +291,27 @@ * **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. -## PrivateEndpoint +## Ruleproperties ### Properties -* **id**: string: The ARM identifier for Private Endpoint. +* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. +* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. +* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types +* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. -## ConnectionState +## SBAuthorizationRuleProperties ### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## SBNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created +* **encryption**: [Encryption](#encryption): Properties to configure Encryption +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **status**: string (ReadOnly): Status of the namespace. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ## SBQueueProperties ### Properties @@ -273,32 +337,11 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## MessageCountDetails -### Properties -* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. -* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. -* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. -* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. -* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. - -## SBTopicProperties +## SBSku ### Properties -* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. -* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. -* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **defaultMessageTimeToLive**: 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. -* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. -* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. -* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. -* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. -* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. -* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. -* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. -* **subscriptionCount**: int (ReadOnly): Number of subscriptions. -* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. +* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. ## SBSubscriptionProperties ### Properties @@ -320,84 +363,41 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## Ruleproperties +## SBTopicProperties ### Properties -* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. -* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. -* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types -* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. +* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. +* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. +* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **defaultMessageTimeToLive**: 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. +* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. +* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. +* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. +* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. +* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. +* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. +* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. +* **subscriptionCount**: int (ReadOnly): Number of subscriptions. +* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. -## Action +## SqlFilter ### Properties * **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. * **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' +* **sqlExpression**: string: The SQL expression. e.g. MyProperty='ABC' -## CorrelationFilter +## Subnet ### Properties -* **contentType**: string: Content type of the message. -* **correlationId**: string: Identifier of the correlation. -* **label**: string: Application specific label. -* **messageId**: string: Identifier of the message. -* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters -* **replyTo**: string: Address of the queue to reply to. -* **replyToSessionId**: string: Session identifier to reply to. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sessionId**: string: Session identifier. -* **to**: string: Address to send to. +* **id**: string (Required): Resource ID of Virtual Network Subnet -## CorrelationFilterProperties +## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SqlFilter -### Properties -* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sqlExpression**: string: The SQL expression. e.g. MyProperty='ABC' - ## VirtualNetworkRuleProperties ### Properties * **virtualNetworkSubnetId**: string: Resource ID of Virtual Network Subnet -## AccessKeys -### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - -## AccessKeys -### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. - diff --git a/generated/servicebus/microsoft.servicebus/2021-01-01-preview/types.md b/generated/servicebus/microsoft.servicebus/2021-01-01-preview/types.md index a13b2df382..0a900b7894 100644 --- a/generated/servicebus/microsoft.servicebus/2021-01-01-preview/types.md +++ b/generated/servicebus/microsoft.servicebus/2021-01-01-preview/types.md @@ -144,106 +144,120 @@ * **ApiVersion**: 2021-01-01-preview * **Output**: [AccessKeys](#accesskeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): ObjectId from the KeyVault -* **tenantId**: string (ReadOnly): TenantId from the KeyVault -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities - -## IdentityUserAssignedIdentities +## AccessKeys ### Properties -### Additional Properties -* **Additional Properties Type**: [DictionaryValue](#dictionaryvalue) +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## DictionaryValue +## AccessKeys ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBNamespaceProperties +## AccessKeys ### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created -* **encryption**: [Encryption](#encryption): Properties to configure Encryption -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. -* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **status**: string (ReadOnly): Status of the namespace. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. -* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## Encryption +## AccessKeys ### Properties -* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault -* **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## KeyVaultProperties +## Action ### Properties -* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Version of KeyVault +* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' -## UserAssignedIdentityProperties +## ArmDisasterRecoveryProperties ### Properties -* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption +* **alternateName**: string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' -## PrivateEndpointConnection +## ConnectionState ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string (ReadOnly): Resource name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## PrivateEndpointConnectionProperties +## CorrelationFilter ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +* **contentType**: string: Content type of the message. +* **correlationId**: string: Identifier of the correlation. +* **label**: string: Application specific label. +* **messageId**: string: Identifier of the message. +* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters +* **replyTo**: string: Address of the queue to reply to. +* **replyToSessionId**: string: Session identifier to reply to. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sessionId**: string: Session identifier. +* **to**: string: Address to send to. -## PrivateEndpoint +## CorrelationFilterProperties ### Properties -* **id**: string: The ARM identifier for Private Endpoint. +### Additional Properties +* **Additional Properties Type**: string -## ConnectionState +## DictionaryValue ### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity -## SystemData +## Encryption ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault +* **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) -## SBSku +## Identity ### Properties -* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. -* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. +* **principalId**: string (ReadOnly): ObjectId from the KeyVault +* **tenantId**: string (ReadOnly): TenantId from the KeyVault +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities -## TrackedResourceTags +## IdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [DictionaryValue](#dictionaryvalue) -## SBAuthorizationRuleProperties +## KeyVaultProperties ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. +* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Version of KeyVault -## ArmDisasterRecoveryProperties +## MessageCountDetails ### Properties -* **alternateName**: string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' +* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. +* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. +* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. +* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. +* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. ## MigrationConfigPropertiesProperties ### Properties @@ -269,9 +283,46 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing VNet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## PrivateEndpoint ### Properties -* **id**: string (Required): Resource ID of Virtual Network Subnet +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id +* **name**: string (ReadOnly): Resource name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## Ruleproperties +### Properties +* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. +* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. +* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types +* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. + +## SBAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## SBNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created +* **encryption**: [Encryption](#encryption): Properties to configure Encryption +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. +* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **status**: string (ReadOnly): Status of the namespace. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ## SBQueueProperties ### Properties @@ -297,32 +348,11 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## MessageCountDetails -### Properties -* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. -* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. -* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. -* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. -* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. - -## SBTopicProperties +## SBSku ### Properties -* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. -* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. -* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **defaultMessageTimeToLive**: 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. -* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. -* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. -* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. -* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. -* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. -* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. -* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. -* **subscriptionCount**: int (ReadOnly): Number of subscriptions. -* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. +* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. ## SBSubscriptionProperties ### Properties @@ -344,36 +374,24 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## Ruleproperties -### Properties -* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. -* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. -* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types -* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. - -## Action -### Properties -* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' - -## CorrelationFilter -### Properties -* **contentType**: string: Content type of the message. -* **correlationId**: string: Identifier of the correlation. -* **label**: string: Application specific label. -* **messageId**: string: Identifier of the message. -* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters -* **replyTo**: string: Address of the queue to reply to. -* **replyToSessionId**: string: Session identifier to reply to. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sessionId**: string: Session identifier. -* **to**: string: Address to send to. - -## CorrelationFilterProperties +## SBTopicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. +* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. +* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **defaultMessageTimeToLive**: 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. +* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. +* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. +* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. +* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. +* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. +* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. +* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. +* **subscriptionCount**: int (ReadOnly): Number of subscriptions. +* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. ## SqlFilter ### Properties @@ -381,43 +399,25 @@ * **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. * **sqlExpression**: string: The SQL expression. e.g. MyProperty='ABC' -## AccessKeys +## Subnet ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **id**: string (Required): Resource ID of Virtual Network Subnet -## AccessKeys +## SystemData ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## UserAssignedIdentityProperties ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption diff --git a/generated/servicebus/microsoft.servicebus/2021-06-01-preview/types.md b/generated/servicebus/microsoft.servicebus/2021-06-01-preview/types.md index 3833e6bb75..9d2b13ad2f 100644 --- a/generated/servicebus/microsoft.servicebus/2021-06-01-preview/types.md +++ b/generated/servicebus/microsoft.servicebus/2021-06-01-preview/types.md @@ -144,107 +144,115 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [AccessKeys](#accesskeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): ObjectId from the KeyVault -* **tenantId**: string (ReadOnly): TenantId from the KeyVault -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccessKeys ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBNamespaceProperties +## AccessKeys ### Properties -* **createdAt**: string (ReadOnly): The time the namespace was created -* **disableLocalAuth**: bool: This property disables SAS authentication for the Service Bus namespace. -* **encryption**: [Encryption](#encryption): Properties to configure Encryption -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. -* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **status**: string (ReadOnly): Status of the namespace. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. -* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## Encryption +## AccessKeys ### Properties -* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault -* **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## KeyVaultProperties +## AccessKeys ### Properties -* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Version of KeyVault +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## UserAssignedIdentityProperties +## Action ### Properties -* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption +* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' -## PrivateEndpointConnection +## ArmDisasterRecoveryProperties ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string (ReadOnly): Resource name -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type +* **alternateName**: string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' -## PrivateEndpointConnectionProperties +## ConnectionState ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## PrivateEndpoint +## CorrelationFilter ### Properties -* **id**: string: The ARM identifier for Private Endpoint. +* **contentType**: string: Content type of the message. +* **correlationId**: string: Identifier of the correlation. +* **label**: string: Application specific label. +* **messageId**: string: Identifier of the message. +* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters +* **replyTo**: string: Address of the queue to reply to. +* **replyToSessionId**: string: Session identifier to reply to. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sessionId**: string: Session identifier. +* **to**: string: Address to send to. -## ConnectionState +## CorrelationFilterProperties ### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## Encryption ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault +* **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) -## SBSku +## Identity ### Properties -* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. -* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. +* **principalId**: string (ReadOnly): ObjectId from the KeyVault +* **tenantId**: string (ReadOnly): TenantId from the KeyVault +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities -## TrackedResourceTags +## IdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## SBAuthorizationRuleProperties +## KeyVaultProperties ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. +* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Version of KeyVault -## ArmDisasterRecoveryProperties +## MessageCountDetails ### Properties -* **alternateName**: string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' +* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. +* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. +* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. +* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. +* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. ## MigrationConfigPropertiesProperties ### Properties @@ -272,9 +280,53 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing VNet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## PrivateEndpoint ### Properties -* **id**: string (Required): Resource ID of Virtual Network Subnet +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id +* **name**: string (ReadOnly): Resource name +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## Ruleproperties +### Properties +* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. +* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. +* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types +* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. + +## SBAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## SBClientAffineProperties +### Properties +* **clientId**: string: Indicates the Client ID of the application that created the client-affine subscription. +* **isDurable**: bool: For client-affine subscriptions, this value indicates whether the subscription is durable or not. +* **isShared**: bool: For client-affine subscriptions, this value indicates whether the subscription is shared or not. + +## SBNamespaceProperties +### Properties +* **createdAt**: string (ReadOnly): The time the namespace was created +* **disableLocalAuth**: bool: This property disables SAS authentication for the Service Bus namespace. +* **encryption**: [Encryption](#encryption): Properties to configure Encryption +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. +* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **status**: string (ReadOnly): Status of the namespace. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ## SBQueueProperties ### Properties @@ -301,33 +353,11 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## MessageCountDetails -### Properties -* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. -* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. -* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. -* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. -* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. - -## SBTopicProperties +## SBSku ### Properties -* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. -* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. -* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **defaultMessageTimeToLive**: 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. -* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. -* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. -* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. -* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. -* **maxMessageSizeInKilobytes**: int: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. -* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. -* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. -* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. -* **subscriptionCount**: int (ReadOnly): Number of subscriptions. -* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. +* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. ## SBSubscriptionProperties ### Properties @@ -351,42 +381,25 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## SBClientAffineProperties -### Properties -* **clientId**: string: Indicates the Client ID of the application that created the client-affine subscription. -* **isDurable**: bool: For client-affine subscriptions, this value indicates whether the subscription is durable or not. -* **isShared**: bool: For client-affine subscriptions, this value indicates whether the subscription is shared or not. - -## Ruleproperties -### Properties -* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. -* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. -* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types -* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. - -## Action -### Properties -* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' - -## CorrelationFilter -### Properties -* **contentType**: string: Content type of the message. -* **correlationId**: string: Identifier of the correlation. -* **label**: string: Application specific label. -* **messageId**: string: Identifier of the message. -* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters -* **replyTo**: string: Address of the queue to reply to. -* **replyToSessionId**: string: Session identifier to reply to. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sessionId**: string: Session identifier. -* **to**: string: Address to send to. - -## CorrelationFilterProperties +## SBTopicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. +* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. +* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **defaultMessageTimeToLive**: 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. +* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. +* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. +* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. +* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. +* **maxMessageSizeInKilobytes**: int: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. +* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. +* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. +* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. +* **subscriptionCount**: int (ReadOnly): Number of subscriptions. +* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. ## SqlFilter ### Properties @@ -394,43 +407,30 @@ * **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. * **sqlExpression**: string: The SQL expression. e.g. MyProperty='ABC' -## AccessKeys +## Subnet ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **id**: string (Required): Resource ID of Virtual Network Subnet -## AccessKeys +## SystemData ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## UserAssignedIdentity ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## UserAssignedIdentityProperties +### Properties +* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption diff --git a/generated/servicebus/microsoft.servicebus/2021-11-01/types.md b/generated/servicebus/microsoft.servicebus/2021-11-01/types.md index 68652983ca..58bccd701c 100644 --- a/generated/servicebus/microsoft.servicebus/2021-11-01/types.md +++ b/generated/servicebus/microsoft.servicebus/2021-11-01/types.md @@ -155,109 +155,115 @@ * **ApiVersion**: 2021-11-01 * **Output**: [AccessKeys](#accesskeys) -## Identity -### Properties -* **principalId**: string (ReadOnly): ObjectId from the KeyVault -* **tenantId**: string (ReadOnly): TenantId from the KeyVault -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccessKeys ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## SBNamespaceProperties +## AccessKeys ### Properties -* **alternateName**: string: Alternate name for namespace -* **createdAt**: string (ReadOnly): The time the namespace was created -* **disableLocalAuth**: bool: This property disables SAS authentication for the Service Bus namespace. -* **encryption**: [Encryption](#encryption): Properties to configure Encryption -* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. -* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. -* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. -* **status**: string (ReadOnly): Status of the namespace. -* **updatedAt**: string (ReadOnly): The time the namespace was updated. -* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## Encryption +## AccessKeys ### Properties -* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption -* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault -* **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## KeyVaultProperties +## AccessKeys ### Properties -* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) -* **keyName**: string: Name of the Key from KeyVault -* **keyVaultUri**: string: Uri of KeyVault -* **keyVersion**: string: Version of KeyVault +* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled +* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled +* **keyName**: string (ReadOnly): A string that describes the authorization rule. +* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. +* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. +* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -## UserAssignedIdentityProperties +## Action ### Properties -* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption +* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' -## PrivateEndpointConnection +## ArmDisasterRecoveryProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **location**: string (ReadOnly): The geo-location where the resource lives -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" +* **alternateName**: string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing +* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. +* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' +* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' -## PrivateEndpointConnectionProperties +## ConnectionState ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. -* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. +* **description**: string: Description of the connection state. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. -## PrivateEndpoint +## CorrelationFilter ### Properties -* **id**: string: The ARM identifier for Private Endpoint. +* **contentType**: string: Content type of the message. +* **correlationId**: string: Identifier of the correlation. +* **label**: string: Application specific label. +* **messageId**: string: Identifier of the message. +* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters +* **replyTo**: string: Address of the queue to reply to. +* **replyToSessionId**: string: Session identifier to reply to. +* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. +* **sessionId**: string: Session identifier. +* **to**: string: Address to send to. -## ConnectionState +## CorrelationFilterProperties ### Properties -* **description**: string: Description of the connection state. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Status of the connection. +### Additional Properties +* **Additional Properties Type**: string -## SystemData +## Encryption ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **keySource**: 'Microsoft.KeyVault': Enumerates the possible value of keySource for Encryption +* **keyVaultProperties**: [KeyVaultProperties](#keyvaultproperties)[]: Properties of KeyVault +* **requireInfrastructureEncryption**: bool: Enable Infrastructure Encryption (Double Encryption) -## SBSku +## Identity ### Properties -* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. -* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. -* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. +* **principalId**: string (ReadOnly): ObjectId from the KeyVault +* **tenantId**: string (ReadOnly): TenantId from the KeyVault +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Properties for User Assigned Identities -## TrackedResourceTags +## IdentityUserAssignedIdentities ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## SBAuthorizationRuleProperties +## KeyVaultProperties ### Properties -* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. +* **identity**: [UserAssignedIdentityProperties](#userassignedidentityproperties) +* **keyName**: string: Name of the Key from KeyVault +* **keyVaultUri**: string: Uri of KeyVault +* **keyVersion**: string: Version of KeyVault -## ArmDisasterRecoveryProperties +## MessageCountDetails ### Properties -* **alternateName**: string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **partnerNamespace**: string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing -* **pendingReplicationOperationsCount**: int (ReadOnly): Number of entities pending to be replicated. -* **provisioningState**: 'Accepted' | 'Failed' | 'Succeeded' (ReadOnly): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' -* **role**: 'Primary' | 'PrimaryNotReplicating' | 'Secondary' (ReadOnly): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' +* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. +* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. +* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. +* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. +* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. ## MigrationConfigPropertiesProperties ### Properties @@ -285,9 +291,55 @@ * **ignoreMissingVnetServiceEndpoint**: bool: Value that indicates whether to ignore missing VNet Service Endpoint * **subnet**: [Subnet](#subnet): Properties supplied for Subnet -## Subnet +## PrivateEndpoint ### Properties -* **id**: string (Required): Resource ID of Virtual Network Subnet +* **id**: string: The ARM identifier for Private Endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **location**: string (ReadOnly): The geo-location where the resource lives +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the private endpoint connection resource. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): PrivateEndpoint information. +* **privateLinkServiceConnectionState**: [ConnectionState](#connectionstate): ConnectionState information. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: Provisioning state of the Private Endpoint Connection. + +## Ruleproperties +### Properties +* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. +* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. +* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types +* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. + +## SBAuthorizationRuleProperties +### Properties +* **rights**: 'Listen' | 'Manage' | 'Send'[] (Required): The rights associated with the rule. + +## SBClientAffineProperties +### Properties +* **clientId**: string: Indicates the Client ID of the application that created the client-affine subscription. +* **isDurable**: bool: For client-affine subscriptions, this value indicates whether the subscription is durable or not. +* **isShared**: bool: For client-affine subscriptions, this value indicates whether the subscription is shared or not. + +## SBNamespaceProperties +### Properties +* **alternateName**: string: Alternate name for namespace +* **createdAt**: string (ReadOnly): The time the namespace was created +* **disableLocalAuth**: bool: This property disables SAS authentication for the Service Bus namespace. +* **encryption**: [Encryption](#encryption): Properties to configure Encryption +* **metricId**: string (ReadOnly): Identifier for Azure Insights metrics +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: List of private endpoint connections. +* **provisioningState**: string (ReadOnly): Provisioning state of the namespace. +* **serviceBusEndpoint**: string (ReadOnly): Endpoint you can use to perform Service Bus operations. +* **status**: string (ReadOnly): Status of the namespace. +* **updatedAt**: string (ReadOnly): The time the namespace was updated. +* **zoneRedundant**: bool: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. ## SBQueueProperties ### Properties @@ -314,33 +366,11 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## MessageCountDetails -### Properties -* **activeMessageCount**: int (ReadOnly): Number of active messages in the queue, topic, or subscription. -* **deadLetterMessageCount**: int (ReadOnly): Number of messages that are dead lettered. -* **scheduledMessageCount**: int (ReadOnly): Number of scheduled messages. -* **transferDeadLetterMessageCount**: int (ReadOnly): Number of messages transferred into dead letters. -* **transferMessageCount**: int (ReadOnly): Number of messages transferred to another queue, topic, or subscription. - -## SBTopicProperties +## SBSku ### Properties -* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. -* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. -* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. -* **createdAt**: string (ReadOnly): Exact time the message was created. -* **defaultMessageTimeToLive**: 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. -* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. -* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. -* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. -* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. -* **maxMessageSizeInKilobytes**: int: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. -* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. -* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. -* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. -* **subscriptionCount**: int (ReadOnly): Number of subscriptions. -* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. -* **updatedAt**: string (ReadOnly): The exact time the message was updated. +* **capacity**: int: The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. +* **name**: 'Basic' | 'Premium' | 'Standard' (Required): Name of this SKU. +* **tier**: 'Basic' | 'Premium' | 'Standard': The billing tier of this particular SKU. ## SBSubscriptionProperties ### Properties @@ -364,42 +394,25 @@ * **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. * **updatedAt**: string (ReadOnly): The exact time the message was updated. -## SBClientAffineProperties -### Properties -* **clientId**: string: Indicates the Client ID of the application that created the client-affine subscription. -* **isDurable**: bool: For client-affine subscriptions, this value indicates whether the subscription is durable or not. -* **isShared**: bool: For client-affine subscriptions, this value indicates whether the subscription is shared or not. - -## Ruleproperties -### Properties -* **action**: [Action](#action): Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. -* **correlationFilter**: [CorrelationFilter](#correlationfilter): Represents the correlation filter expression. -* **filterType**: 'CorrelationFilter' | 'SqlFilter': Rule filter types -* **sqlFilter**: [SqlFilter](#sqlfilter): Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. - -## Action -### Properties -* **compatibilityLevel**: int: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sqlExpression**: string: SQL expression. e.g. MyProperty='ABC' - -## CorrelationFilter -### Properties -* **contentType**: string: Content type of the message. -* **correlationId**: string: Identifier of the correlation. -* **label**: string: Application specific label. -* **messageId**: string: Identifier of the message. -* **properties**: [CorrelationFilterProperties](#correlationfilterproperties): dictionary object for custom filters -* **replyTo**: string: Address of the queue to reply to. -* **replyToSessionId**: string: Session identifier to reply to. -* **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. -* **sessionId**: string: Session identifier. -* **to**: string: Address to send to. - -## CorrelationFilterProperties +## SBTopicProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **accessedAt**: string (ReadOnly): Last time the message was sent, or a request was received, for this topic. +* **autoDeleteOnIdle**: string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. +* **countDetails**: [MessageCountDetails](#messagecountdetails) (ReadOnly): Message Count Details. +* **createdAt**: string (ReadOnly): Exact time the message was created. +* **defaultMessageTimeToLive**: 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. +* **duplicateDetectionHistoryTimeWindow**: string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. +* **enableBatchedOperations**: bool: Value that indicates whether server-side batched operations are enabled. +* **enableExpress**: bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. +* **enablePartitioning**: bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. +* **maxMessageSizeInKilobytes**: int: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024. +* **maxSizeInMegabytes**: int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. +* **requiresDuplicateDetection**: bool: Value indicating if this topic requires duplicate detection. +* **sizeInBytes**: int (ReadOnly): Size of the topic, in bytes. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Disabled' | 'ReceiveDisabled' | 'Renaming' | 'Restoring' | 'SendDisabled' | 'Unknown': Entity status. +* **subscriptionCount**: int (ReadOnly): Number of subscriptions. +* **supportOrdering**: bool: Value that indicates whether the topic supports ordering. +* **updatedAt**: string (ReadOnly): The exact time the message was updated. ## SqlFilter ### Properties @@ -407,43 +420,30 @@ * **requiresPreprocessing**: bool: Value that indicates whether the rule action requires preprocessing. * **sqlExpression**: string: The SQL expression. e.g. MyProperty='ABC' -## AccessKeys +## Subnet ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **id**: string (Required): Resource ID of Virtual Network Subnet -## AccessKeys +## SystemData ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## AccessKeys +## TrackedResourceTags ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +### Additional Properties +* **Additional Properties Type**: string -## AccessKeys +## UserAssignedIdentity ### Properties -* **aliasPrimaryConnectionString**: string (ReadOnly): Primary connection string of the alias if GEO DR is enabled -* **aliasSecondaryConnectionString**: string (ReadOnly): Secondary connection string of the alias if GEO DR is enabled -* **keyName**: string (ReadOnly): A string that describes the authorization rule. -* **primaryConnectionString**: string (ReadOnly): Primary connection string of the created namespace authorization rule. -* **primaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. -* **secondaryConnectionString**: string (ReadOnly): Secondary connection string of the created namespace authorization rule. -* **secondaryKey**: string (ReadOnly): A base64-encoded 256-bit primary key for signing and validating the SAS token. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## UserAssignedIdentityProperties +### Properties +* **userAssignedIdentity**: string: ARM ID of user Identity selected for encryption diff --git a/generated/servicefabric/log.out b/generated/servicefabric/log.out index 2f7a08a592..d837324449 100644 --- a/generated/servicefabric/log.out +++ b/generated/servicefabric/log.out @@ -16,7 +16,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.servicefabric-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -32,7 +32,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'Cluster' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/cluster.json:758:9 @@ -61,7 +61,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'Cluster' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2020-03-01/cluster.json:699:9 @@ -74,7 +74,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'UniformInt64RangePartition warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'components·1jzyk61·schemas·cluster·allof·0' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2020-03-01/cluster.json#/components/schemas/components·1jzyk61·schemas·cluster·allof·0 -info | autorest.bicep took 8ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.servicefabric-2020-12-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -90,7 +90,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'NamedPartitionSchemeDescription' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-12-01-preview/application.json:1511:9 @@ -113,7 +113,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'ManagedCluster' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json:572:9 @@ -136,7 +136,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'Cluster' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-11-01-preview/cluster.json:699:9 @@ -149,7 +149,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'UniformInt64RangePartition warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'components·1jzyk61·schemas·cluster·allof·0' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-11-01-preview/cluster.json#/components/schemas/components·1jzyk61·schemas·cluster·allof·0 -info | autorest.bicep took 11ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.servicefabric-2019-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -165,7 +165,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableOperationDisplay' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-06-01-preview/cluster.json:555:5 @@ -292,7 +292,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'NamedPartitionSchemeDescri warning | PreCheck/EmptyParentSchemaWarning | Schema 'UniformInt64RangePartitionSchemeDescription' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-06-01-preview/application.json:2173:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.servicefabric-2019-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -308,7 +308,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableOperationDisplay' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2019-03-01/cluster.json:555:5 @@ -445,7 +445,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableOperationDisplay' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-03-01-preview/cluster.json:555:5 @@ -566,7 +566,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'NamedPartitionSchemeDescri warning | PreCheck/EmptyParentSchemaWarning | Schema 'UniformInt64RangePartitionSchemeDescription' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-03-01-preview/application.json:2070:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.servicefabric-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -582,7 +582,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableOperationDisplay' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json:555:5 @@ -653,7 +653,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'NamedPartitionSchemeDescription' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json:1308:5 @@ -931,7 +931,7 @@ warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ClusterVersionDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json:515:5 @@ -987,4 +987,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined t - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json:1244:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 41.37s. 22 files generated. +info | Autorest completed in 39.18s. 22 files generated. diff --git a/generated/servicefabric/microsoft.servicefabric/2016-09-01/types.md b/generated/servicefabric/microsoft.servicefabric/2016-09-01/types.md index 9f52b26075..e76188966e 100644 --- a/generated/servicefabric/microsoft.servicefabric/2016-09-01/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2016-09-01/types.md @@ -11,6 +11,34 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.ServiceFabric/clusters' (ReadOnly, DeployTimeConstant): The resource type +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id +* **clusterApplication**: string: Azure active directory cluster application id +* **tenantId**: string: Azure active directory tenant id + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): Certificate common name to be granted access; be careful using wild card common names +* **certificateIssuerThumbprint**: string (Required): Certificate issuer thumbprint +* **isAdmin**: bool (Required): Is this certificate used for admin access from the client, if false , it is used or query only access + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): Certificate thumbprint +* **isAdmin**: bool (Required): Is this certificate used for admin access from the client, if false, it is used or query only access + +## ClusterHealthPolicy +### Properties +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The available cluster code version which the cluster can upgrade to, note that you must choose upgradeMode to manual to upgrade to @@ -33,34 +61,30 @@ * **upgradeMode**: 'Automatic' | 'Manual' | string: Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not * **vmImage**: string: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ClusterVersionDetails -### Properties -* **codeVersion**: string: The ServiceFabric runtime version of the cluster -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id -* **clusterApplication**: string: Azure active directory cluster application id -* **tenantId**: string: Azure active directory tenant id - -## CertificateDescription +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location +* **maxPercentDeltaUnhealthyApplications**: int (Required): Additional unhealthy applications percentage +* **maxPercentDeltaUnhealthyNodes**: int (Required): Additional unhealthy nodes percentage +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): Additional unhealthy nodes percentage per upgrade domain -## ClientCertificateCommonName +## ClusterUpgradePolicy ### Properties -* **certificateCommonName**: string (Required): Certificate common name to be granted access; be careful using wild card common names -* **certificateIssuerThumbprint**: string (Required): Certificate issuer thumbprint -* **isAdmin**: bool (Required): Is this certificate used for admin access from the client, if false , it is used or query only access +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Delta health policy for the cluster +* **forceRestart**: bool: Force node to restart or not +* **healthCheckRetryTimeout**: string (Required): The length of time that health checks can fail continuously,it represents .Net TimeSpan +* **healthCheckStableDuration**: string (Required): The length of time that health checks must pass continuously,it represents .Net TimeSpan +* **healthCheckWaitDuration**: string (Required): The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **overrideUserUpgradePolicy**: bool: Use the user defined upgrade policy or not +* **upgradeDomainTimeout**: string (Required): The timeout for any upgrade domain,it represents .Net TimeSpan +* **upgradeReplicaSetCheckTimeout**: string (Required): Timeout for replica set upgrade to complete,it represents .Net TimeSpan +* **upgradeTimeout**: string (Required): The upgrade timeout,it represents .Net TimeSpan -## ClientCertificateThumbprint +## ClusterVersionDetails ### Properties -* **certificateThumbprint**: string (Required): Certificate thumbprint -* **isAdmin**: bool (Required): Is this certificate used for admin access from the client, if false, it is used or query only access +* **codeVersion**: string: The ServiceFabric runtime version of the cluster +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version ## DiagnosticsStorageAccountConfig ### Properties @@ -70,15 +94,10 @@ * **storageAccountName**: string (Required): Diagnostics storage account name * **tableEndpoint**: string (Required): Diagnostics storage account table endpoint -## SettingsSectionDescription -### Properties -* **name**: string (Required): The name of settings section -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): Collection of settings in the section, each setting is a tuple consisting of setting name and value - -## SettingsParameterDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The name of settings property -* **value**: string (Required): The value of the property +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## NodeTypeDescription ### Properties @@ -94,11 +113,6 @@ * **reverseProxyEndpointPort**: int: Endpoint used by reverse proxy * **vmInstanceCount**: int (Required): The number of node instances in the node type -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypeDescriptionCapacities ### Properties ### Additional Properties @@ -109,32 +123,18 @@ ### Additional Properties * **Additional Properties Type**: string -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Delta health policy for the cluster -* **forceRestart**: bool: Force node to restart or not -* **healthCheckRetryTimeout**: string (Required): The length of time that health checks can fail continuously,it represents .Net TimeSpan -* **healthCheckStableDuration**: string (Required): The length of time that health checks must pass continuously,it represents .Net TimeSpan -* **healthCheckWaitDuration**: string (Required): The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **overrideUserUpgradePolicy**: bool: Use the user defined upgrade policy or not -* **upgradeDomainTimeout**: string (Required): The timeout for any upgrade domain,it represents .Net TimeSpan -* **upgradeReplicaSetCheckTimeout**: string (Required): Timeout for replica set upgrade to complete,it represents .Net TimeSpan -* **upgradeTimeout**: string (Required): The upgrade timeout,it represents .Net TimeSpan - -## ClusterUpgradeDeltaHealthPolicy +## ResourceTags ### Properties -* **maxPercentDeltaUnhealthyApplications**: int (Required): Additional unhealthy applications percentage -* **maxPercentDeltaUnhealthyNodes**: int (Required): Additional unhealthy nodes percentage -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): Additional unhealthy nodes percentage per upgrade domain +### Additional Properties +* **Additional Properties Type**: string -## ClusterHealthPolicy +## SettingsParameterDescription ### Properties -* **maxPercentUnhealthyApplications**: int: 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. -* **maxPercentUnhealthyNodes**: int: 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. +* **name**: string (Required): The name of settings property +* **value**: string (Required): The value of the property -## ResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The name of settings section +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): Collection of settings in the section, each setting is a tuple consisting of setting name and value diff --git a/generated/servicefabric/microsoft.servicefabric/2017-07-01-preview/types.md b/generated/servicefabric/microsoft.servicefabric/2017-07-01-preview/types.md index 5300ff259b..58f86dc703 100644 --- a/generated/servicefabric/microsoft.servicefabric/2017-07-01-preview/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2017-07-01-preview/types.md @@ -51,6 +51,126 @@ * **properties**: [ApplicationTypeVersionResourceProperties](#applicationtypeversionresourceproperties): The properties of the application type version resource. * **type**: 'Microsoft.ServiceFabric/clusters/applicationTypes/versions' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationMetricDescription +### Properties +* **MaximumCapacity**: int: 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. +* **Name**: string: The name of the metric. +* **ReservationCapacity**: int: 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. +* **TotalApplicationCapacity**: int: 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. + +## ApplicationTypeParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response + +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeReplicaSetCheckTimeout**: 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). + +## ArmApplicationHealthPolicy +### Properties +* **ConsiderWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **DefaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **MaxPercentUnhealthyDeployedApplications**: int: 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. +* **ServiceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. + +## ArmRollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. + +## ArmServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. + +## ArmServiceTypeHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClusterHealthPolicy +### Properties +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | string[]: The list of add-on features to enable in the cluster. @@ -94,34 +214,29 @@ - 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. * **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ClusterVersionDetails -### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## CertificateDescription +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. -## ClientCertificateCommonName +## ClusterUpgradePolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ClientCertificateThumbprint +## ClusterVersionDetails ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. ## DiagnosticsStorageAccountConfig ### Properties @@ -131,15 +246,10 @@ * **storageAccountName**: string (Required): The Azure storage account name. * **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## NodeTypeDescription ### Properties @@ -159,11 +269,6 @@ * **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. * **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypeDescriptionCapacities ### Properties ### Additional Properties @@ -174,110 +279,52 @@ ### Additional Properties * **Additional Properties Type**: string -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. - -## ClusterUpgradeDeltaHealthPolicy -### Properties -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +## PartitionSchemeDescription +* **Discriminator**: PartitionScheme -## ClusterHealthPolicy -### Properties -* **maxPercentUnhealthyApplications**: int: 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. -* **maxPercentUnhealthyNodes**: int: 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. +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. +* **PartitionScheme**: 'Named' (Required): Specifies how the service is partitioned. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### SingletonPartitionSchemeDescription +#### Properties +* **PartitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. -## ApplicationResourceProperties -### Properties -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **HighKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘Count’ +* **LowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘Count’ +* **PartitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ApplicationMetricDescription -### Properties -* **MaximumCapacity**: int: 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. -* **Name**: string: The name of the metric. -* **ReservationCapacity**: int: 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. -* **TotalApplicationCapacity**: int: 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. -## ApplicationParameterList +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeReplicaSetCheckTimeout**: 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). - -## ArmApplicationHealthPolicy +## ServiceCorrelationDescription ### Properties -* **ConsiderWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **DefaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **MaxPercentUnhealthyDeployedApplications**: int: 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. -* **ServiceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. +* **Scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **ServiceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ArmServiceTypeHealthPolicy +## ServiceLoadMetricDescription ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **DefaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **Name**: string (Required): 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. +* **PrimaryDefaultLoad**: int: 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. +* **SecondaryDefaultLoad**: int: 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. +* **Weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. -## ArmServiceTypeHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +## ServicePlacementPolicyDescription +* **Discriminator**: Type -## ArmRollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -307,60 +354,13 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **Scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **ServiceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: PartitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. -* **PartitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **PartitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **HighKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘Count’ -* **LowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘Count’ -* **PartitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription -### Properties -* **DefaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **Name**: string (Required): 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. -* **PrimaryDefaultLoad**: int: 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. -* **SecondaryDefaultLoad**: int: 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. -* **Weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: Type - -### Base Properties - -## ApplicationTypeResourceProperties -### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. - -## ApplicationTypeVersionResourceProperties +## SettingsParameterDescription ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ApplicationTypeParameterList +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. diff --git a/generated/servicefabric/microsoft.servicefabric/2018-02-01/types.md b/generated/servicefabric/microsoft.servicefabric/2018-02-01/types.md index cf020bddc5..f88c286111 100644 --- a/generated/servicefabric/microsoft.servicefabric/2018-02-01/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2018-02-01/types.md @@ -11,6 +11,78 @@ * **tags**: [ResourceTags](#resourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/clusters' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationDeltaHealthPolicy +### Properties +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. + +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) + +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClusterHealthPolicy +### Properties +* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. @@ -56,44 +128,39 @@ - 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. * **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ClusterVersionDetails -### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## CertificateDescription -### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonNames -### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonName +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. -## ClientCertificateCommonName +## ClusterUpgradePolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ClientCertificateThumbprint +## ClusterVersionDetails ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. ## DiagnosticsStorageAccountConfig ### Properties @@ -103,15 +170,10 @@ * **storageAccountName**: string (Required): The Azure storage account name. * **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## NodeTypeDescription ### Properties @@ -131,11 +193,6 @@ * **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. * **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypeDescriptionCapacities ### Properties ### Additional Properties @@ -146,45 +203,20 @@ ### Additional Properties * **Additional Properties Type**: string -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. - -## ClusterUpgradeDeltaHealthPolicy +## ResourceTags ### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationDeltaHealthPolicyMap +## ServerCertificateCommonName ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ApplicationDeltaHealthPolicy +## ServerCertificateCommonNames ### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. ## ServiceTypeDeltaHealthPolicy ### Properties @@ -197,43 +229,6 @@ The check is performed after every upgrade domain upgrade completion to make sur ### Additional Properties * **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ClusterHealthPolicy -### Properties -* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. -* **maxPercentUnhealthyApplications**: int: 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. -* **maxPercentUnhealthyNodes**: int: 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. - -## ApplicationHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) - -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - ## ServiceTypeHealthPolicy ### Properties * **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. @@ -243,8 +238,13 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP ### Additional Properties * **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ResourceTags +## SettingsParameterDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. + +## SettingsSectionDescription +### Properties +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. diff --git a/generated/servicefabric/microsoft.servicefabric/2019-03-01-preview/types.md b/generated/servicefabric/microsoft.servicefabric/2019-03-01-preview/types.md index 779daeff1e..d7f508d44f 100644 --- a/generated/servicefabric/microsoft.servicefabric/2019-03-01-preview/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2019-03-01-preview/types.md @@ -60,6 +60,170 @@ * **tags**: [ProxyResourceTags](#proxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/clusters/applicationTypes/versions' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationDeltaHealthPolicy +### Properties +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. + +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) + +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) + +## ApplicationMetricDescription +### Properties +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. + +## ApplicationTypeParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response + +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeReplicaSetCheckTimeout**: 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). + +## ArmApplicationHealthPolicy +### Properties +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. + +## ArmRollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. + +## ArmServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. + +## ArmServiceTypeHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClusterHealthPolicy +### Properties +* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. @@ -106,44 +270,39 @@ - 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. * **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ClusterVersionDetails -### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## CertificateDescription -### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonNames -### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonName +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. -## ClientCertificateCommonName +## ClusterUpgradePolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ClientCertificateThumbprint +## ClusterVersionDetails ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. ## DiagnosticsStorageAccountConfig ### Properties @@ -153,15 +312,10 @@ * **storageAccountName**: string (Required): The Azure storage account name. * **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## NodeTypeDescription ### Properties @@ -181,11 +335,6 @@ * **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. * **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypeDescriptionCapacities ### Properties ### Additional Properties @@ -196,189 +345,82 @@ ### Additional Properties * **Additional Properties Type**: string -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ClusterUpgradeDeltaHealthPolicy -### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. -## ApplicationDeltaHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. -## ApplicationDeltaHealthPolicy -### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **HighKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘Count’ +* **LowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘Count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ServiceTypeDeltaHealthPolicy -### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. -## ServiceTypeDeltaHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) - -## ClusterHealthPolicy -### Properties -* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. -* **maxPercentUnhealthyApplications**: int: 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. -* **maxPercentUnhealthyNodes**: int: 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. +* **Additional Properties Type**: string -## ApplicationHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) - -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **Additional Properties Type**: string -## ServiceTypeHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **Additional Properties Type**: string -## ResourceTags +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationResourceProperties -### Properties -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. - -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. - -## ApplicationParameterList +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ServerCertificateCommonName ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeReplicaSetCheckTimeout**: 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). +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmApplicationHealthPolicy +## ServerCertificateCommonNames ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmServiceTypeHealthPolicy +## ServiceCorrelationDescription ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ArmServiceTypeHealthPolicyMap +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. -## ArmRollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +## ServicePlacementPolicyDescription +* **Discriminator**: Type -## ProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -409,75 +451,33 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **HighKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘Count’ -* **LowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘Count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: Type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApplicationTypeVersionResourceProperties -### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeParameterList +## SettingsParameterDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. diff --git a/generated/servicefabric/microsoft.servicefabric/2019-03-01/types.md b/generated/servicefabric/microsoft.servicefabric/2019-03-01/types.md index 83c1f48472..e72bf18183 100644 --- a/generated/servicefabric/microsoft.servicefabric/2019-03-01/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2019-03-01/types.md @@ -60,6 +60,170 @@ * **tags**: [ProxyResourceTags](#proxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/clusters/applicationTypes/versions' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationDeltaHealthPolicy +### Properties +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. + +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) + +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) + +## ApplicationMetricDescription +### Properties +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. + +## ApplicationTypeParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response + +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeReplicaSetCheckTimeout**: 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). + +## ArmApplicationHealthPolicy +### Properties +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. + +## ArmRollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. + +## ArmServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. + +## ArmServiceTypeHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClusterHealthPolicy +### Properties +* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. @@ -106,44 +270,39 @@ - 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. * **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ClusterVersionDetails -### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## CertificateDescription -### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonNames -### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonName +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. -## ClientCertificateCommonName +## ClusterUpgradePolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ClientCertificateThumbprint +## ClusterVersionDetails ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. ## DiagnosticsStorageAccountConfig ### Properties @@ -153,15 +312,10 @@ * **storageAccountName**: string (Required): The Azure storage account name. * **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## NodeTypeDescription ### Properties @@ -181,11 +335,6 @@ * **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. * **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypeDescriptionCapacities ### Properties ### Additional Properties @@ -196,189 +345,82 @@ ### Additional Properties * **Additional Properties Type**: string -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ClusterUpgradeDeltaHealthPolicy -### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. -## ApplicationDeltaHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. -## ApplicationDeltaHealthPolicy -### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **HighKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘Count’ +* **LowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘Count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ServiceTypeDeltaHealthPolicy -### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. -## ServiceTypeDeltaHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) - -## ClusterHealthPolicy -### Properties -* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. -* **maxPercentUnhealthyApplications**: int: 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. -* **maxPercentUnhealthyNodes**: int: 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. +* **Additional Properties Type**: string -## ApplicationHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) - -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **Additional Properties Type**: string -## ServiceTypeHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **Additional Properties Type**: string -## ResourceTags +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationResourceProperties -### Properties -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. - -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. - -## ApplicationParameterList +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ServerCertificateCommonName ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeReplicaSetCheckTimeout**: 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). +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmApplicationHealthPolicy +## ServerCertificateCommonNames ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmServiceTypeHealthPolicy +## ServiceCorrelationDescription ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ArmServiceTypeHealthPolicyMap +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. -## ArmRollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +## ServicePlacementPolicyDescription +* **Discriminator**: Type -## ProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -409,75 +451,33 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **HighKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘Count’ -* **LowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘Count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: Type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string - -## ApplicationTypeVersionResourceProperties -### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeParameterList +## SettingsParameterDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. diff --git a/generated/servicefabric/microsoft.servicefabric/2019-06-01-preview/types.md b/generated/servicefabric/microsoft.servicefabric/2019-06-01-preview/types.md index e1bca426b5..2d3aead25f 100644 --- a/generated/servicefabric/microsoft.servicefabric/2019-06-01-preview/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2019-06-01-preview/types.md @@ -61,6 +61,176 @@ * **tags**: [ProxyResourceTags](#proxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/clusters/applicationTypes/versions' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationDeltaHealthPolicy +### Properties +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. + +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) + +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) + +## ApplicationMetricDescription +### Properties +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. + +## ApplicationTypeParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response + +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeReplicaSetCheckTimeout**: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. + +## ArmApplicationHealthPolicy +### Properties +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. + +## ArmRollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. + +## ArmServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. + +## ArmServiceTypeHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClusterHealthPolicy +### Properties +* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. @@ -107,44 +277,39 @@ - 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. * **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ClusterVersionDetails -### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## CertificateDescription -### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonNames -### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonName +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. -## ClientCertificateCommonName +## ClusterUpgradePolicy ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ClientCertificateThumbprint +## ClusterVersionDetails ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. ## DiagnosticsStorageAccountConfig ### Properties @@ -155,15 +320,18 @@ * **storageAccountName**: string (Required): The Azure storage account name. * **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## SettingsSectionDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports -## SettingsParameterDescription +## ManagedIdentity ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. +* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. ## NodeTypeDescription ### Properties @@ -183,11 +351,6 @@ * **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. * **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypeDescriptionCapacities ### Properties ### Additional Properties @@ -198,213 +361,82 @@ ### Additional Properties * **Additional Properties Type**: string -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. - -## ClusterUpgradeDeltaHealthPolicy -### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. - -## ApplicationDeltaHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) - -## ApplicationDeltaHealthPolicy -### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. - -## ServiceTypeDeltaHealthPolicy -### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. - -## ServiceTypeDeltaHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ClusterHealthPolicy -### Properties -* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. -* **maxPercentUnhealthyApplications**: int: 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. +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. -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. -* **maxPercentUnhealthyNodes**: int: 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. +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. -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. +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **Count**: int (Required): The number of partitions. +* **HighKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘Count’ +* **LowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘Count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. -## ApplicationHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) - -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **Additional Properties Type**: string -## ServiceTypeHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **Additional Properties Type**: string -## ResourceTags +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. -* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. - -## UserAssignedIdentityMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. +* **Additional Properties Type**: string -## ApplicationParameterList +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ServerCertificateCommonName ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeReplicaSetCheckTimeout**: 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). +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmApplicationHealthPolicy +## ServerCertificateCommonNames ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmServiceTypeHealthPolicy +## ServiceCorrelationDescription ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ArmServiceTypeHealthPolicyMap +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. -## ArmRollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +## ServicePlacementPolicyDescription +* **Discriminator**: Type -## ProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -435,75 +467,43 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **Names**: string[] (Required): Array of size specified by the ‘Count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **Count**: int (Required): The number of partitions. -* **HighKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘Count’ -* **LowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘Count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: Type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeVersionResourceProperties +## SettingsParameterDescription ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ApplicationTypeParameterList +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ProxyResourceTags +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) diff --git a/generated/servicefabric/microsoft.servicefabric/2019-11-01-preview/types.md b/generated/servicefabric/microsoft.servicefabric/2019-11-01-preview/types.md index baf3ac1ba2..0a006623b9 100644 --- a/generated/servicefabric/microsoft.servicefabric/2019-11-01-preview/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2019-11-01-preview/types.md @@ -61,198 +61,160 @@ * **tags**: [ProxyResourceTags](#proxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/clusters/applicationTypes/versions' (ReadOnly, DeployTimeConstant): The resource type -## ClusterProperties +## ApplicationDeltaHealthPolicy ### Properties -* **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy) -* **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The Service Fabric runtime versions available for this cluster. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **certificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. -* **certificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. -* **clientCertificateCommonNames**: [ClientCertificateCommonName](#clientcertificatecommonname)[]: The list of client certificates referenced by common name that are allowed to manage the cluster. -* **clientCertificateThumbprints**: [ClientCertificateThumbprint](#clientcertificatethumbprint)[]: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. -* **clusterCodeVersion**: 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**. -* **clusterEndpoint**: string (ReadOnly): The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'AutoScale' | 'BaselineUpgrade' | 'Deploying' | 'EnforcingClusterVersion' | 'Ready' | 'UpdatingInfrastructure' | 'UpdatingUserCertificate' | 'UpdatingUserConfiguration' | 'UpgradeServiceUnreachable' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. - - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - - Ready - Indicates that the cluster is in a stable state. -* **diagnosticsStorageAccountConfig**: [DiagnosticsStorageAccountConfig](#diagnosticsstorageaccountconfig): The storage account information for storing Service Fabric diagnostic logs. -* **eventStoreServiceEnabled**: bool: Indicates if the event store service is enabled. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **managementEndpoint**: string (Required): The http management endpoint of the cluster. -* **nodeTypes**: [NodeTypeDescription](#nodetypedescription)[] (Required): The list of node types in the cluster. -* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster resource. -* **reliabilityLevel**: 'Bronze' | 'Gold' | 'None' | 'Platinum' | 'Silver' | 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). +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) - - 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. -* **reverseProxyCertificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. -* **reverseProxyCertificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. -* **upgradeDescription**: [ClusterUpgradePolicy](#clusterupgradepolicy): Describes the policy used when upgrading the cluster. -* **upgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. - - 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. -* **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. +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. -## ApplicationTypeVersionsCleanupPolicy -### Properties -* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. +If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. -## ClusterVersionDetails +## ApplicationHealthPolicyMap ### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) -## AzureActiveDirectory +## ApplicationMetricDescription ### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. -## CertificateDescription +## ApplicationParameterList ### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +### Additional Properties +* **Additional Properties Type**: string -## ServerCertificateCommonNames +## ApplicationResourceProperties ### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -## ServerCertificateCommonName +## ApplicationTypeParameterList ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +### Additional Properties +* **Additional Properties Type**: string -## ClientCertificateCommonName +## ApplicationTypeResourceProperties ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -## ClientCertificateThumbprint +## ApplicationTypeVersionResourceProperties ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -## DiagnosticsStorageAccountConfig +## ApplicationTypeVersionsCleanupPolicy ### Properties -* **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. -* **protectedAccountKeyName**: string (Required): The protected diagnostics storage key name. -* **protectedAccountKeyName2**: string: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. -* **queueEndpoint**: string (Required): The queue endpoint of the azure storage account. -* **storageAccountName**: string (Required): The Azure storage account name. -* **tableEndpoint**: string (Required): The table endpoint of the azure storage account. +* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. -## SettingsSectionDescription +## ApplicationUpgradePolicy ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. +* **upgradeReplicaSetCheckTimeout**: 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). -## SettingsParameterDescription +## ApplicationUserAssignedIdentity ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. -## NodeTypeDescription +## ArmApplicationHealthPolicy ### Properties -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypeDescriptionCapacities](#nodetypedescriptioncapacities): 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. -* **clientConnectionEndpointPort**: int (Required): The TCP cluster management endpoint port. -* **durabilityLevel**: 'Bronze' | 'Gold' | 'Silver' | 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. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **httpGatewayEndpointPort**: int (Required): The HTTP cluster management endpoint port. -* **isPrimary**: bool (Required): 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. -* **name**: string (Required): The name of the node type. -* **placementProperties**: [NodeTypeDescriptionPlacementProperties](#nodetypedescriptionplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. -* **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +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. -## NodeTypeDescriptionCapacities -### Properties -### Additional Properties -* **Additional Properties Type**: string +If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. -## NodeTypeDescriptionPlacementProperties +## ArmRollingUpgradeMonitoringPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. -## ClusterUpgradePolicy +## ArmServiceTypeHealthPolicy ### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ClusterUpgradeDeltaHealthPolicy +## ArmServiceTypeHealthPolicyMap ### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) -## ApplicationDeltaHealthPolicyMap +## AzureActiveDirectory ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. -## ApplicationDeltaHealthPolicy +## CertificateDescription ### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ServiceTypeDeltaHealthPolicy +## ClientCertificateCommonName ### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. -## ServiceTypeDeltaHealthPolicyMap +## ClientCertificateThumbprint ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ## ClusterHealthPolicy ### Properties @@ -275,35 +237,100 @@ The computation rounds up to tolerate one failure on small numbers of nodes. Def In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. -## ApplicationHealthPolicyMap +## ClusterProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) +* **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy) +* **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The Service Fabric runtime versions available for this cluster. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **certificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. +* **certificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. +* **clientCertificateCommonNames**: [ClientCertificateCommonName](#clientcertificatecommonname)[]: The list of client certificates referenced by common name that are allowed to manage the cluster. +* **clientCertificateThumbprints**: [ClientCertificateThumbprint](#clientcertificatethumbprint)[]: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. +* **clusterCodeVersion**: 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**. +* **clusterEndpoint**: string (ReadOnly): The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'AutoScale' | 'BaselineUpgrade' | 'Deploying' | 'EnforcingClusterVersion' | 'Ready' | 'UpdatingInfrastructure' | 'UpdatingUserCertificate' | 'UpdatingUserConfiguration' | 'UpgradeServiceUnreachable' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. + - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. + - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. + - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. + - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. + - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. + - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. + - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. + - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. + - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. + - Ready - Indicates that the cluster is in a stable state. +* **diagnosticsStorageAccountConfig**: [DiagnosticsStorageAccountConfig](#diagnosticsstorageaccountconfig): The storage account information for storing Service Fabric diagnostic logs. +* **eventStoreServiceEnabled**: bool: Indicates if the event store service is enabled. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **managementEndpoint**: string (Required): The http management endpoint of the cluster. +* **nodeTypes**: [NodeTypeDescription](#nodetypedescription)[] (Required): The list of node types in the cluster. +* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster resource. +* **reliabilityLevel**: 'Bronze' | 'Gold' | 'None' | 'Platinum' | 'Silver' | 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). -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. + - 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. +* **reverseProxyCertificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. +* **reverseProxyCertificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. +* **upgradeDescription**: [ClusterUpgradePolicy](#clusterupgradepolicy): Describes the policy used when upgrading the cluster. +* **upgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. + - 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. +* **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. + +## ClusterUpgradeDeltaHealthPolicy +### Properties +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. + +## ClusterUpgradePolicy +### Properties +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ServiceTypeHealthPolicy +## ClusterVersionDetails ### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. -## ServiceTypeHealthPolicyMap +## DiagnosticsStorageAccountConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. +* **protectedAccountKeyName**: string (Required): The protected diagnostics storage key name. +* **protectedAccountKeyName2**: string: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. +* **queueEndpoint**: string (Required): The queue endpoint of the azure storage account. +* **storageAccountName**: string (Required): The Azure storage account name. +* **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## ResourceTags +## EndpointRangeDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## ManagedIdentity ### Properties @@ -313,105 +340,110 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap +## NodeTypeDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypeDescriptionCapacities](#nodetypedescriptioncapacities): 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. +* **clientConnectionEndpointPort**: int (Required): The TCP cluster management endpoint port. +* **durabilityLevel**: 'Bronze' | 'Gold' | 'Silver' | string: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. + - 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. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **httpGatewayEndpointPort**: int (Required): The HTTP cluster management endpoint port. +* **isPrimary**: bool (Required): 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. +* **name**: string (Required): The name of the node type. +* **placementProperties**: [NodeTypeDescriptionPlacementProperties](#nodetypedescriptionplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. +* **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## ApplicationResourceProperties +## NodeTypeDescriptionCapacities ### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationUserAssignedIdentity +## NodeTypeDescriptionPlacementProperties ### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ApplicationParameterList +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. + +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. + +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **highKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘count’ +* **lowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. + + +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ProxyResourceTags ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. -* **upgradeReplicaSetCheckTimeout**: 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). +### Additional Properties +* **Additional Properties Type**: string -## ArmApplicationHealthPolicy +## ProxyResourceTags ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. +### Additional Properties +* **Additional Properties Type**: string -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. +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ArmServiceTypeHealthPolicy +## ServerCertificateCommonName ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmServiceTypeHealthPolicyMap +## ServerCertificateCommonNames ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmRollingUpgradeMonitoringPolicy +## ServiceCorrelationDescription ### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ProxyResourceTags +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. + +## ServicePlacementPolicyDescription +* **Discriminator**: type + +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -444,75 +476,43 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **highKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘count’ -* **lowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeVersionResourceProperties +## SettingsParameterDescription ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ApplicationTypeParameterList +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ProxyResourceTags +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) diff --git a/generated/servicefabric/microsoft.servicefabric/2020-01-01-preview/types.md b/generated/servicefabric/microsoft.servicefabric/2020-01-01-preview/types.md index de6f06bb2e..bf9e767517 100644 --- a/generated/servicefabric/microsoft.servicefabric/2020-01-01-preview/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2020-01-01-preview/types.md @@ -23,6 +23,32 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## ClientCertificate +### Properties +* **commonName**: string: Certificate Common name. +* **isAdmin**: bool (Required): Whether the certificate is admin or not. +* **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. +* **thumbprint**: string: Certificate Thumbprint. + +## EndpointRangeDescription +### Properties +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports + +## LoadBalancingRule +### Properties +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendPort**: int (Required): 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. +* **probeProtocol**: 'http' | 'https' | 'tcp' | string (Required): the reference to the load balancer probe used by the load balancing rule. +* **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. +* **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. + ## ManagedClusterProperties ### Properties * **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: client certificates for the cluster. @@ -53,42 +79,7 @@ * **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Describes load balancing rules. * **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## ClientCertificate -### Properties -* **commonName**: string: Certificate Common name. -* **isAdmin**: bool (Required): Whether the certificate is admin or not. -* **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. -* **thumbprint**: string: Certificate Thumbprint. - -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription -### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. - -## LoadBalancingRule -### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendPort**: int (Required): 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. -* **probeProtocol**: 'http' | 'https' | 'tcp' | string (Required): the reference to the load balancer probe used by the load balancing rule. -* **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. -* **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. Basic will have a minimum of 3 seed nodes and Standard a minimum of 5. Basic only allows 1 node type. - -## ResourceTags +## ManagedProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -111,11 +102,6 @@ * **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. * **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - ## NodeTypePropertiesCapacities ### Properties ### Additional Properties @@ -126,27 +112,24 @@ ### Additional Properties * **Additional Properties Type**: string -## VmssExtension +## ResourceTags ### Properties -* **name**: string (Required): The name of the extension. -* **properties**: [VmssExtensionProperties](#vmssextensionproperties) (Required): Describes the properties of a Virtual Machine Scale Set Extension. +### Additional Properties +* **Additional Properties Type**: string -## VmssExtensionProperties +## SettingsParameterDescription ### Properties -* **autoUpgradeMinorVersion**: bool: 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. -* **forceUpdateTag**: 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. -* **protectedSettings**: any: Any object -* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. -* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. -* **publisher**: string (Required): The name of the extension handler publisher. -* **settings**: any: Any object -* **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". -* **typeHandlerVersion**: string (Required): Specifies the version of the script handler. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## VaultSecretGroup +## SettingsSectionDescription ### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. + +## Sku +### Properties +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. Basic will have a minimum of 3 seed nodes and Standard a minimum of 5. Basic only allows 1 node type. ## SubResource ### Properties @@ -157,8 +140,25 @@ * **certificateStore**: string (Required): 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. * **certificateUrl**: string (Required): 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":""
    } -## ManagedProxyResourceTags +## VaultSecretGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmssExtension +### Properties +* **name**: string (Required): The name of the extension. +* **properties**: [VmssExtensionProperties](#vmssextensionproperties) (Required): Describes the properties of a Virtual Machine Scale Set Extension. + +## VmssExtensionProperties +### Properties +* **autoUpgradeMinorVersion**: bool: 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. +* **forceUpdateTag**: 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. +* **protectedSettings**: any: Any object +* **provisionAfterExtensions**: string[]: Collection of extension names after which this extension needs to be provisioned. +* **provisioningState**: string (ReadOnly): The provisioning state, which only appears in the response. +* **publisher**: string (Required): The name of the extension handler publisher. +* **settings**: any: Any object +* **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". +* **typeHandlerVersion**: string (Required): Specifies the version of the script handler. diff --git a/generated/servicefabric/microsoft.servicefabric/2020-03-01/types.md b/generated/servicefabric/microsoft.servicefabric/2020-03-01/types.md index afab4d53fe..cead6822e6 100644 --- a/generated/servicefabric/microsoft.servicefabric/2020-03-01/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2020-03-01/types.md @@ -61,198 +61,160 @@ * **tags**: [ProxyResourceTags](#proxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/clusters/applicationTypes/versions' (ReadOnly, DeployTimeConstant): The resource type -## ClusterProperties +## ApplicationDeltaHealthPolicy ### Properties -* **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy) -* **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The Service Fabric runtime versions available for this cluster. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **certificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. -* **certificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. -* **clientCertificateCommonNames**: [ClientCertificateCommonName](#clientcertificatecommonname)[]: The list of client certificates referenced by common name that are allowed to manage the cluster. -* **clientCertificateThumbprints**: [ClientCertificateThumbprint](#clientcertificatethumbprint)[]: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. -* **clusterCodeVersion**: 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**. -* **clusterEndpoint**: string (ReadOnly): The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'AutoScale' | 'BaselineUpgrade' | 'Deploying' | 'EnforcingClusterVersion' | 'Ready' | 'UpdatingInfrastructure' | 'UpdatingUserCertificate' | 'UpdatingUserConfiguration' | 'UpgradeServiceUnreachable' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. - - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - - Ready - Indicates that the cluster is in a stable state. -* **diagnosticsStorageAccountConfig**: [DiagnosticsStorageAccountConfig](#diagnosticsstorageaccountconfig): The storage account information for storing Service Fabric diagnostic logs. -* **eventStoreServiceEnabled**: bool: Indicates if the event store service is enabled. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **managementEndpoint**: string (Required): The http management endpoint of the cluster. -* **nodeTypes**: [NodeTypeDescription](#nodetypedescription)[] (Required): The list of node types in the cluster. -* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster resource. -* **reliabilityLevel**: 'Bronze' | 'Gold' | 'None' | 'Platinum' | 'Silver' | 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). +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) - - 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. -* **reverseProxyCertificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. -* **reverseProxyCertificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. -* **upgradeDescription**: [ClusterUpgradePolicy](#clusterupgradepolicy): Describes the policy used when upgrading the cluster. -* **upgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. - - 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. -* **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. +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. -## ApplicationTypeVersionsCleanupPolicy -### Properties -* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. +If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. -## ClusterVersionDetails +## ApplicationHealthPolicyMap ### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) -## AzureActiveDirectory +## ApplicationMetricDescription ### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. -## CertificateDescription +## ApplicationParameterList ### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +### Additional Properties +* **Additional Properties Type**: string -## ServerCertificateCommonNames +## ApplicationResourceProperties ### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -## ServerCertificateCommonName +## ApplicationTypeParameterList ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +### Additional Properties +* **Additional Properties Type**: string -## ClientCertificateCommonName +## ApplicationTypeResourceProperties ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -## ClientCertificateThumbprint +## ApplicationTypeVersionResourceProperties ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -## DiagnosticsStorageAccountConfig +## ApplicationTypeVersionsCleanupPolicy ### Properties -* **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. -* **protectedAccountKeyName**: string (Required): The protected diagnostics storage key name. -* **protectedAccountKeyName2**: string: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. -* **queueEndpoint**: string (Required): The queue endpoint of the azure storage account. -* **storageAccountName**: string (Required): The Azure storage account name. -* **tableEndpoint**: string (Required): The table endpoint of the azure storage account. +* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. -## SettingsSectionDescription +## ApplicationUpgradePolicy ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. +* **upgradeReplicaSetCheckTimeout**: 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). -## SettingsParameterDescription +## ApplicationUserAssignedIdentity ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. -## NodeTypeDescription +## ArmApplicationHealthPolicy ### Properties -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypeDescriptionCapacities](#nodetypedescriptioncapacities): 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. -* **clientConnectionEndpointPort**: int (Required): The TCP cluster management endpoint port. -* **durabilityLevel**: 'Bronze' | 'Gold' | 'Silver' | 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. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **httpGatewayEndpointPort**: int (Required): The HTTP cluster management endpoint port. -* **isPrimary**: bool (Required): 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. -* **name**: string (Required): The name of the node type. -* **placementProperties**: [NodeTypeDescriptionPlacementProperties](#nodetypedescriptionplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. -* **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +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. -## NodeTypeDescriptionCapacities -### Properties -### Additional Properties -* **Additional Properties Type**: string +If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. -## NodeTypeDescriptionPlacementProperties +## ArmRollingUpgradeMonitoringPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. -## ClusterUpgradePolicy +## ArmServiceTypeHealthPolicy ### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ClusterUpgradeDeltaHealthPolicy +## ArmServiceTypeHealthPolicyMap ### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) -## ApplicationDeltaHealthPolicyMap +## AzureActiveDirectory ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. -## ApplicationDeltaHealthPolicy +## CertificateDescription ### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ServiceTypeDeltaHealthPolicy +## ClientCertificateCommonName ### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. -## ServiceTypeDeltaHealthPolicyMap +## ClientCertificateThumbprint ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ## ClusterHealthPolicy ### Properties @@ -275,35 +237,100 @@ The computation rounds up to tolerate one failure on small numbers of nodes. Def In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. -## ApplicationHealthPolicyMap +## ClusterProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) +* **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy) +* **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The Service Fabric runtime versions available for this cluster. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **certificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. +* **certificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. +* **clientCertificateCommonNames**: [ClientCertificateCommonName](#clientcertificatecommonname)[]: The list of client certificates referenced by common name that are allowed to manage the cluster. +* **clientCertificateThumbprints**: [ClientCertificateThumbprint](#clientcertificatethumbprint)[]: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. +* **clusterCodeVersion**: 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**. +* **clusterEndpoint**: string (ReadOnly): The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'AutoScale' | 'BaselineUpgrade' | 'Deploying' | 'EnforcingClusterVersion' | 'Ready' | 'UpdatingInfrastructure' | 'UpdatingUserCertificate' | 'UpdatingUserConfiguration' | 'UpgradeServiceUnreachable' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. + - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. + - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. + - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. + - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. + - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. + - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. + - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. + - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. + - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. + - Ready - Indicates that the cluster is in a stable state. +* **diagnosticsStorageAccountConfig**: [DiagnosticsStorageAccountConfig](#diagnosticsstorageaccountconfig): The storage account information for storing Service Fabric diagnostic logs. +* **eventStoreServiceEnabled**: bool: Indicates if the event store service is enabled. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **managementEndpoint**: string (Required): The http management endpoint of the cluster. +* **nodeTypes**: [NodeTypeDescription](#nodetypedescription)[] (Required): The list of node types in the cluster. +* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster resource. +* **reliabilityLevel**: 'Bronze' | 'Gold' | 'None' | 'Platinum' | 'Silver' | 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). -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. + - 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. +* **reverseProxyCertificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. +* **reverseProxyCertificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. +* **upgradeDescription**: [ClusterUpgradePolicy](#clusterupgradepolicy): Describes the policy used when upgrading the cluster. +* **upgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. + - 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. +* **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. + +## ClusterUpgradeDeltaHealthPolicy +### Properties +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. + +## ClusterUpgradePolicy +### Properties +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## ServiceTypeHealthPolicy +## ClusterVersionDetails ### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. -## ServiceTypeHealthPolicyMap +## DiagnosticsStorageAccountConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. +* **protectedAccountKeyName**: string (Required): The protected diagnostics storage key name. +* **protectedAccountKeyName2**: string: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. +* **queueEndpoint**: string (Required): The queue endpoint of the azure storage account. +* **storageAccountName**: string (Required): The Azure storage account name. +* **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## ResourceTags +## EndpointRangeDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## ManagedIdentity ### Properties @@ -313,105 +340,110 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap +## NodeTypeDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypeDescriptionCapacities](#nodetypedescriptioncapacities): 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. +* **clientConnectionEndpointPort**: int (Required): The TCP cluster management endpoint port. +* **durabilityLevel**: 'Bronze' | 'Gold' | 'Silver' | string: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. + - 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. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **httpGatewayEndpointPort**: int (Required): The HTTP cluster management endpoint port. +* **isPrimary**: bool (Required): 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. +* **name**: string (Required): The name of the node type. +* **placementProperties**: [NodeTypeDescriptionPlacementProperties](#nodetypedescriptionplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. +* **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## ApplicationResourceProperties +## NodeTypeDescriptionCapacities ### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationUserAssignedIdentity +## NodeTypeDescriptionPlacementProperties ### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ApplicationParameterList +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. + +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. + +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **highKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘count’ +* **lowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. + + +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ProxyResourceTags ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. -* **upgradeReplicaSetCheckTimeout**: 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). +### Additional Properties +* **Additional Properties Type**: string -## ArmApplicationHealthPolicy +## ProxyResourceTags ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. +### Additional Properties +* **Additional Properties Type**: string -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. +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ArmServiceTypeHealthPolicy +## ServerCertificateCommonName ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmServiceTypeHealthPolicyMap +## ServerCertificateCommonNames ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmRollingUpgradeMonitoringPolicy +## ServiceCorrelationDescription ### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ProxyResourceTags +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. + +## ServicePlacementPolicyDescription +* **Discriminator**: type + +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -444,75 +476,43 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **highKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘count’ -* **lowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeVersionResourceProperties +## SettingsParameterDescription ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ApplicationTypeParameterList +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ProxyResourceTags +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) diff --git a/generated/servicefabric/microsoft.servicefabric/2020-12-01-preview/types.md b/generated/servicefabric/microsoft.servicefabric/2020-12-01-preview/types.md index 97df98aa68..941b84633e 100644 --- a/generated/servicefabric/microsoft.servicefabric/2020-12-01-preview/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2020-12-01-preview/types.md @@ -72,198 +72,160 @@ * **Input**: [UpgradableVersionsDescription](#upgradableversionsdescription) * **Output**: [UpgradableVersionPathResult](#upgradableversionpathresult) -## ClusterProperties +## ApplicationDeltaHealthPolicy ### Properties -* **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy) -* **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The Service Fabric runtime versions available for this cluster. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **certificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. -* **certificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. -* **clientCertificateCommonNames**: [ClientCertificateCommonName](#clientcertificatecommonname)[]: The list of client certificates referenced by common name that are allowed to manage the cluster. -* **clientCertificateThumbprints**: [ClientCertificateThumbprint](#clientcertificatethumbprint)[]: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. -* **clusterCodeVersion**: 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**. -* **clusterEndpoint**: string (ReadOnly): The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'AutoScale' | 'BaselineUpgrade' | 'Deploying' | 'EnforcingClusterVersion' | 'Ready' | 'UpdatingInfrastructure' | 'UpdatingUserCertificate' | 'UpdatingUserConfiguration' | 'UpgradeServiceUnreachable' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. - - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. - - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. - - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. - - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. - - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. - - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. - - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. - - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. - - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. - - Ready - Indicates that the cluster is in a stable state. -* **diagnosticsStorageAccountConfig**: [DiagnosticsStorageAccountConfig](#diagnosticsstorageaccountconfig): The storage account information for storing Service Fabric diagnostic logs. -* **eventStoreServiceEnabled**: bool: Indicates if the event store service is enabled. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **managementEndpoint**: string (Required): The http management endpoint of the cluster. -* **nodeTypes**: [NodeTypeDescription](#nodetypedescription)[] (Required): The list of node types in the cluster. -* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster resource. -* **reliabilityLevel**: 'Bronze' | 'Gold' | 'None' | 'Platinum' | 'Silver' | 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). +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) - - 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. -* **reverseProxyCertificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. -* **reverseProxyCertificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. -* **upgradeDescription**: [ClusterUpgradePolicy](#clusterupgradepolicy): Describes the policy used when upgrading the cluster. -* **upgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. - - 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. -* **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. +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. -## ApplicationTypeVersionsCleanupPolicy -### Properties -* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. +If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. -## ClusterVersionDetails +## ApplicationHealthPolicyMap ### Properties -* **codeVersion**: string: The Service Fabric runtime version of the cluster. -* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows -* **supportExpiryUtc**: string: The date of expiry of support of the version. +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) -## AzureActiveDirectory +## ApplicationMetricDescription ### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. -## CertificateDescription +## ApplicationParameterList ### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +### Additional Properties +* **Additional Properties Type**: string -## ServerCertificateCommonNames +## ApplicationResourceProperties ### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -## ServerCertificateCommonName +## ApplicationTypeParameterList ### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. +### Additional Properties +* **Additional Properties Type**: string -## ClientCertificateCommonName +## ApplicationTypeResourceProperties ### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. -## ClientCertificateThumbprint +## ApplicationTypeVersionResourceProperties ### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -## DiagnosticsStorageAccountConfig +## ApplicationTypeVersionsCleanupPolicy ### Properties -* **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. -* **protectedAccountKeyName**: string (Required): The protected diagnostics storage key name. -* **protectedAccountKeyName2**: string: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. -* **queueEndpoint**: string (Required): The queue endpoint of the azure storage account. -* **storageAccountName**: string (Required): The Azure storage account name. -* **tableEndpoint**: string (Required): The table endpoint of the azure storage account. +* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. -## SettingsSectionDescription +## ApplicationUpgradePolicy ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. +* **upgradeReplicaSetCheckTimeout**: 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). -## SettingsParameterDescription +## ApplicationUserAssignedIdentity ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. -## NodeTypeDescription +## ArmApplicationHealthPolicy ### Properties -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypeDescriptionCapacities](#nodetypedescriptioncapacities): 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. -* **clientConnectionEndpointPort**: int (Required): The TCP cluster management endpoint port. -* **durabilityLevel**: 'Bronze' | 'Gold' | 'Silver' | 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. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **httpGatewayEndpointPort**: int (Required): The HTTP cluster management endpoint port. -* **isPrimary**: bool (Required): 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. -* **name**: string (Required): The name of the node type. -* **placementProperties**: [NodeTypeDescriptionPlacementProperties](#nodetypedescriptionplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. -* **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +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. -## NodeTypeDescriptionCapacities -### Properties -### Additional Properties -* **Additional Properties Type**: string +If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. -## NodeTypeDescriptionPlacementProperties +## ArmRollingUpgradeMonitoringPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. -## ClusterUpgradePolicy +## ArmServiceTypeHealthPolicy ### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ClusterUpgradeDeltaHealthPolicy +## ArmServiceTypeHealthPolicyMap ### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) -## ApplicationDeltaHealthPolicyMap +## AzureActiveDirectory ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. -## ApplicationDeltaHealthPolicy +## CertificateDescription ### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ServiceTypeDeltaHealthPolicy +## ClientCertificateCommonName ### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. -## ServiceTypeDeltaHealthPolicyMap +## ClientCertificateThumbprint ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ## ClusterHealthPolicy ### Properties @@ -286,44 +248,100 @@ The computation rounds up to tolerate one failure on small numbers of nodes. Def In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. -## ApplicationHealthPolicyMap +## ClusterProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) +* **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy) +* **availableClusterVersions**: [ClusterVersionDetails](#clusterversiondetails)[] (ReadOnly): The Service Fabric runtime versions available for this cluster. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **certificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. +* **certificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. +* **clientCertificateCommonNames**: [ClientCertificateCommonName](#clientcertificatecommonname)[]: The list of client certificates referenced by common name that are allowed to manage the cluster. +* **clientCertificateThumbprints**: [ClientCertificateThumbprint](#clientcertificatethumbprint)[]: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. +* **clusterCodeVersion**: 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**. +* **clusterEndpoint**: string (ReadOnly): The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'AutoScale' | 'BaselineUpgrade' | 'Deploying' | 'EnforcingClusterVersion' | 'Ready' | 'UpdatingInfrastructure' | 'UpdatingUserCertificate' | 'UpdatingUserConfiguration' | 'UpgradeServiceUnreachable' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. + - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. + - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. + - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. + - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration. + - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate. + - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'. + - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version. + - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider. + - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted. + - Ready - Indicates that the cluster is in a stable state. +* **diagnosticsStorageAccountConfig**: [DiagnosticsStorageAccountConfig](#diagnosticsstorageaccountconfig): The storage account information for storing Service Fabric diagnostic logs. +* **eventStoreServiceEnabled**: bool: Indicates if the event store service is enabled. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **managementEndpoint**: string (Required): The http management endpoint of the cluster. +* **nodeTypes**: [NodeTypeDescription](#nodetypedescription)[] (Required): The list of node types in the cluster. +* **provisioningState**: 'Canceled' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the cluster resource. +* **reliabilityLevel**: 'Bronze' | 'Gold' | 'None' | 'Platinum' | 'Silver' | 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). -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. + - 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. +* **reverseProxyCertificate**: [CertificateDescription](#certificatedescription): Describes the certificate details. +* **reverseProxyCertificateCommonNames**: [ServerCertificateCommonNames](#servercertificatecommonnames): Describes a list of server certificates referenced by common name that are used to secure the cluster. +* **upgradeDescription**: [ClusterUpgradePolicy](#clusterupgradepolicy): Describes the policy used when upgrading the cluster. +* **upgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. + - 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. +* **vmImage**: string: The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used. -## ServiceTypeHealthPolicy +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. -## ServiceTypeHealthPolicyMap +## ClusterUpgradePolicy ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. -## SystemData +## ClusterVersionDetails ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **codeVersion**: string: The Service Fabric runtime version of the cluster. +* **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows +* **supportExpiryUtc**: string: The date of expiry of support of the version. + +## DiagnosticsStorageAccountConfig +### Properties +* **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. +* **protectedAccountKeyName**: string (Required): The protected diagnostics storage key name. +* **protectedAccountKeyName2**: string: The secondary protected diagnostics storage key name. If one of the storage account keys is rotated the cluster will fallback to using the other. +* **queueEndpoint**: string (Required): The queue endpoint of the azure storage account. +* **storageAccountName**: string (Required): The Azure storage account name. +* **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## ResourceTags +## EndpointRangeDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## ManagedIdentity ### Properties @@ -333,105 +351,110 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap +## NodeTypeDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypeDescriptionCapacities](#nodetypedescriptioncapacities): 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. +* **clientConnectionEndpointPort**: int (Required): The TCP cluster management endpoint port. +* **durabilityLevel**: 'Bronze' | 'Gold' | 'Silver' | string: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. + - 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. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **httpGatewayEndpointPort**: int (Required): The HTTP cluster management endpoint port. +* **isPrimary**: bool (Required): 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. +* **name**: string (Required): The name of the node type. +* **placementProperties**: [NodeTypeDescriptionPlacementProperties](#nodetypedescriptionplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. +* **vmInstanceCount**: int (Required): The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource. -## ApplicationResourceProperties +## NodeTypeDescriptionCapacities ### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationUserAssignedIdentity +## NodeTypeDescriptionPlacementProperties ### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. +### Additional Properties +* **Additional Properties Type**: string -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ApplicationParameterList +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. + +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. + +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **highKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘count’ +* **lowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. + + +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ProxyResourceTags ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. -* **upgradeReplicaSetCheckTimeout**: 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). +### Additional Properties +* **Additional Properties Type**: string -## ArmApplicationHealthPolicy +## ProxyResourceTags ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): Defines a ServiceTypeHealthPolicy per service type name. +### Additional Properties +* **Additional Properties Type**: string -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. +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation. +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ArmServiceTypeHealthPolicy +## ServerCertificateCommonName ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmServiceTypeHealthPolicyMap +## ServerCertificateCommonNames ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmRollingUpgradeMonitoringPolicy +## ServiceCorrelationDescription ### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ProxyResourceTags +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. + +## ServicePlacementPolicyDescription +* **Discriminator**: type + +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -464,83 +487,60 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **highKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘count’ -* **lowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeVersionResourceProperties +## SettingsParameterDescription ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ApplicationTypeParameterList +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ProxyResourceTags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UpgradableVersionPathResult +### Properties +* **supportedPath**: string[] (ReadOnly): Array of UpgradableVersionPathResultSupportedPathItem ## UpgradableVersionsDescription ### Properties * **targetVersion**: string (Required, WriteOnly): The target code version. -## UpgradableVersionPathResult +## UserAssignedIdentity ### Properties -* **supportedPath**: string[] (ReadOnly): Array of UpgradableVersionPathResultSupportedPathItem +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## UserAssignedIdentityMap +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) diff --git a/generated/servicefabric/microsoft.servicefabric/2021-06-01/types.md b/generated/servicefabric/microsoft.servicefabric/2021-06-01/types.md index 4fd36c34d7..931f2c7d6d 100644 --- a/generated/servicefabric/microsoft.servicefabric/2021-06-01/types.md +++ b/generated/servicefabric/microsoft.servicefabric/2021-06-01/types.md @@ -72,6 +72,182 @@ * **Input**: [UpgradableVersionsDescription](#upgradableversionsdescription) * **Output**: [UpgradableVersionPathResult](#upgradableversionpathresult) +## ApplicationDeltaHealthPolicy +### Properties +* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. +* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. + +## ApplicationDeltaHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) + +## ApplicationHealthPolicy +### Properties +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) + +## ApplicationMetricDescription +### Properties +* **maximumCapacity**: int: 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. +* **name**: string: The name of the metric. +* **reservationCapacity**: int: 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. +* **totalApplicationCapacity**: int: 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **maximumNodes**: int: 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. +* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. +* **minimumNodes**: int: 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. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **removeApplicationCapacity**: bool: Remove the current application capacity settings. +* **typeName**: string: The application type name as defined in the application manifest. +* **typeVersion**: string: The version of the application type as defined in the application manifest. +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. + +## ApplicationTypeParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response + +## ApplicationTypeVersionsCleanupPolicy +### Properties +* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. + +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. +* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. +* **upgradeReplicaSetCheckTimeout**: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. + +## ArmApplicationHealthPolicy +### Properties +* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int: 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. +* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. + +## ArmRollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package +* **healthCheckRetryTimeout**: 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. +* **healthCheckStableDuration**: 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. +* **healthCheckWaitDuration**: 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. +* **upgradeDomainTimeout**: 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. +* **upgradeTimeout**: 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. + +## ArmServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. + +## ArmServiceTypeHealthPolicyMap +### Properties +### Additional Properties +* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## CertificateDescription +### Properties +* **thumbprint**: string (Required): Thumbprint of the primary certificate. +* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. + +## ClientCertificateCommonName +### Properties +* **certificateCommonName**: string (Required): The common name of the client certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClientCertificateThumbprint +### Properties +* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. + +## ClusterHealthPolicy +### Properties +* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. +* **maxPercentUnhealthyApplications**: int: 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. +* **maxPercentUnhealthyNodes**: int: 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. + ## ClusterProperties ### Properties * **addOnFeatures**: 'BackupRestoreService' | 'DnsService' | 'RepairManager' | 'ResourceMonitorService' | string[]: The list of add-on features to enable in the cluster. @@ -124,9 +300,33 @@ * **vmssZonalUpgradeMode**: 'Hierarchical' | 'Parallel' | string: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added. * **waveUpgradePaused**: bool: Boolean to pause automatic runtime version upgrades to the cluster. -## ApplicationTypeVersionsCleanupPolicy +## ClusterUpgradeDeltaHealthPolicy ### Properties -* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. +* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. +* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. +* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. +* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. + +## ClusterUpgradePolicy +### Properties +* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **healthCheckRetryTimeout**: string (Required): 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. +* **healthCheckStableDuration**: string (Required): 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. +* **healthCheckWaitDuration**: string (Required): 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. +* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. +* **upgradeDomainTimeout**: string (Required): 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. +* **upgradeReplicaSetCheckTimeout**: string (Required): 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. +* **upgradeTimeout**: string (Required): 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. ## ClusterVersionDetails ### Properties @@ -134,39 +334,6 @@ * **environment**: 'Linux' | 'Windows' | string: Cluster operating system, the default will be Windows * **supportExpiryUtc**: string: The date of expiry of support of the version. -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## CertificateDescription -### Properties -* **thumbprint**: string (Required): Thumbprint of the primary certificate. -* **thumbprintSecondary**: string: Thumbprint of the secondary certificate. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonNames -### Properties -* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. -* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. - -## ServerCertificateCommonName -### Properties -* **certificateCommonName**: string (Required): The common name of the server certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. - -## ClientCertificateCommonName -### Properties -* **certificateCommonName**: string (Required): The common name of the client certificate. -* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. - -## ClientCertificateThumbprint -### Properties -* **certificateThumbprint**: string (Required): The thumbprint of the client certificate. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. - ## DiagnosticsStorageAccountConfig ### Properties * **blobEndpoint**: string (Required): The blob endpoint of the azure storage account. @@ -176,15 +343,18 @@ * **storageAccountName**: string (Required): The Azure storage account name. * **tableEndpoint**: string (Required): The table endpoint of the azure storage account. -## SettingsSectionDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports -## SettingsParameterDescription +## ManagedIdentity ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. +* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. ## NodeTypeDescription ### Properties @@ -206,12 +376,7 @@ * **reverseProxyEndpointPort**: int: The endpoint used by reverse proxy. * **vmInstanceCount**: int (Required): VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation. -## EndpointRangeDescription -### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports - -## NodeTypeDescriptionCapacities +## NodeTypeDescriptionCapacities ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -233,224 +398,82 @@ * **notificationChannel**: 'EmailSubscription' | 'EmailUser' | string (Required): The notification channel indicates the type of receivers subscribed to the notification, either user or subscription. * **receivers**: string[] (Required): List of targets that subscribe to the notification. -## ClusterUpgradePolicy -### Properties -* **deltaHealthPolicy**: [ClusterUpgradeDeltaHealthPolicy](#clusterupgradedeltahealthpolicy): Describes the delta health policies for the cluster upgrade. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **healthCheckRetryTimeout**: string (Required): 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. -* **healthCheckStableDuration**: string (Required): 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. -* **healthCheckWaitDuration**: string (Required): 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. -* **healthPolicy**: [ClusterHealthPolicy](#clusterhealthpolicy) (Required): Defines a health policy used to evaluate the health of the cluster or of a cluster node. -* **upgradeDomainTimeout**: string (Required): 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. -* **upgradeReplicaSetCheckTimeout**: string (Required): 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. -* **upgradeTimeout**: string (Required): 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. - -## ClusterUpgradeDeltaHealthPolicy -### Properties -* **applicationDeltaHealthPolicies**: [ApplicationDeltaHealthPolicyMap](#applicationdeltahealthpolicymap): 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. -* **maxPercentDeltaUnhealthyApplications**: int (Required): 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. -* **maxPercentDeltaUnhealthyNodes**: int (Required): 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. -* **maxPercentUpgradeDomainDeltaUnhealthyNodes**: int (Required): 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. - -## ApplicationDeltaHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ApplicationDeltaHealthPolicy](#applicationdeltahealthpolicy) - -## ApplicationDeltaHealthPolicy -### Properties -* **defaultServiceTypeDeltaHealthPolicy**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy): Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. -* **serviceTypeDeltaHealthPolicies**: [ServiceTypeDeltaHealthPolicyMap](#servicetypedeltahealthpolicymap): 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. - -## ServiceTypeDeltaHealthPolicy -### Properties -* **maxPercentDeltaUnhealthyServices**: int: 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. - -## ServiceTypeDeltaHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) +## PartitionSchemeDescription +* **Discriminator**: partitionScheme -## ClusterHealthPolicy -### Properties -* **applicationHealthPolicies**: [ApplicationHealthPolicyMap](#applicationhealthpolicymap): 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. -* **maxPercentUnhealthyApplications**: int: 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. +### Base Properties +### NamedPartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. +* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. -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. -* **maxPercentUnhealthyNodes**: int: 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. +### SingletonPartitionSchemeDescription +#### Properties +* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. -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. +### UniformInt64RangePartitionSchemeDescription +#### Properties +* **count**: int (Required): The number of partitions. +* **highKey**: string (Required): String indicating the upper bound of the partition key range that +should be split between the partition ‘count’ +* **lowKey**: string (Required): String indicating the lower bound of the partition key range that +should be split between the partition ‘count’ +* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. -## ApplicationHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ApplicationHealthPolicy](#applicationhealthpolicy) - -## ApplicationHealthPolicy -### Properties -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **serviceTypeHealthPolicies**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **Additional Properties Type**: string -## ServiceTypeHealthPolicyMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. +* **Additional Properties Type**: string -## ResourceTags +## ProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. -* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. - -## UserAssignedIdentityMap +## ProxyResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **maximumNodes**: int: 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. -* **metrics**: [ApplicationMetricDescription](#applicationmetricdescription)[]: List of application capacity metric description. -* **minimumNodes**: int: 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. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **removeApplicationCapacity**: bool: Remove the current application capacity settings. -* **typeName**: string: The application type name as defined in the application manifest. -* **typeVersion**: string: The version of the application type as defined in the application manifest. -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationMetricDescription -### Properties -* **maximumCapacity**: int: 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. -* **name**: string: The name of the metric. -* **reservationCapacity**: int: 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. -* **totalApplicationCapacity**: int: 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. +* **Additional Properties Type**: string -## ApplicationParameterList +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy +## ServerCertificateCommonName ### Properties -* **applicationHealthPolicy**: [ArmApplicationHealthPolicy](#armapplicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed and it will result in availability loss. -* **rollingUpgradeMonitoringPolicy**: [ArmRollingUpgradeMonitoringPolicy](#armrollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Invalid' | 'Monitored' | 'UnmonitoredAuto' | 'UnmonitoredManual' | string: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. -* **upgradeReplicaSetCheckTimeout**: 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). +* **certificateCommonName**: string (Required): The common name of the server certificate. +* **certificateIssuerThumbprint**: string (Required): The issuer thumbprint of the server certificate. -## ArmApplicationHealthPolicy +## ServerCertificateCommonNames ### Properties -* **considerWarningAsError**: bool: Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int: 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. -* **serviceTypeHealthPolicyMap**: [ArmServiceTypeHealthPolicyMap](#armservicetypehealthpolicymap): 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. +* **commonNames**: [ServerCertificateCommonName](#servercertificatecommonname)[]: The list of server certificates referenced by common name that are used to secure the cluster. +* **x509StoreName**: 'AddressBook' | 'AuthRoot' | 'CertificateAuthority' | 'Disallowed' | 'My' | 'Root' | 'TrustedPeople' | 'TrustedPublisher' | string: The local certificate store location. -## ArmServiceTypeHealthPolicy +## ServiceCorrelationDescription ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int: The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyReplicasPerPartition**: int: The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error. -* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. +* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. -## ArmServiceTypeHealthPolicyMap +## ServiceLoadMetricDescription ### Properties -### Additional Properties -* **Additional Properties Type**: [ArmServiceTypeHealthPolicy](#armservicetypehealthpolicy) +* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. +* **name**: string (Required): 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. +* **primaryDefaultLoad**: int: 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. +* **secondaryDefaultLoad**: int: 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. +* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. -## ArmRollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string: The activation Mode of the service package -* **healthCheckRetryTimeout**: 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. -* **healthCheckStableDuration**: 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. -* **healthCheckWaitDuration**: 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. -* **upgradeDomainTimeout**: 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. -* **upgradeTimeout**: 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. +## ServicePlacementPolicyDescription +* **Discriminator**: type -## ProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string +### Base Properties ## ServiceResourceProperties * **Discriminator**: serviceKind @@ -483,83 +506,60 @@ If no policy is specified for a service type name, the DefaultServiceTypeHealthP * **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). -## ServiceCorrelationDescription -### Properties -* **scheme**: 'Affinity' | 'AlignedAffinity' | 'Invalid' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full name of the service with 'fabric:' URI scheme. - -## PartitionSchemeDescription -* **Discriminator**: partitionScheme - -### Base Properties -### NamedPartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **names**: string[] (Required): Array of size specified by the ‘count’ parameter, for the names of the partitions. -* **partitionScheme**: 'Named' (Required): Specifies how the service is partitioned. - -### SingletonPartitionSchemeDescription -#### Properties -* **partitionScheme**: 'Singleton' (Required): Specifies how the service is partitioned. - -### UniformInt64RangePartitionSchemeDescription -#### Properties -* **count**: int (Required): The number of partitions. -* **highKey**: string (Required): String indicating the upper bound of the partition key range that -should be split between the partition ‘count’ -* **lowKey**: string (Required): String indicating the lower bound of the partition key range that -should be split between the partition ‘count’ -* **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. - - -## ServiceLoadMetricDescription +## ServiceTypeDeltaHealthPolicy ### Properties -* **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. -* **name**: string (Required): 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. -* **primaryDefaultLoad**: int: 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. -* **secondaryDefaultLoad**: int: 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. -* **weight**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. - -## ServicePlacementPolicyDescription -* **Discriminator**: type - -### Base Properties +* **maxPercentDeltaUnhealthyServices**: int: 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. -## ProxyResourceTags +## ServiceTypeDeltaHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeDeltaHealthPolicy](#servicetypedeltahealthpolicy) -## ApplicationTypeResourceProperties +## ServiceTypeHealthPolicy ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **maxPercentUnhealthyServices**: int: The maximum percentage of services allowed to be unhealthy before your application is considered in error. -## ProxyResourceTags +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeVersionResourceProperties +## SettingsParameterDescription ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **defaultParameterList**: [ApplicationTypeParameterList](#applicationtypeparameterlist) (ReadOnly): List of application type parameters that can be overridden when creating or updating the application. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ApplicationTypeParameterList +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ProxyResourceTags +## SystemData ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. + +## UpgradableVersionPathResult +### Properties +* **supportedPath**: string[] (ReadOnly): Array of UpgradableVersionPathResultSupportedPathItem ## UpgradableVersionsDescription ### Properties * **targetVersion**: string (Required, WriteOnly): The target code version. -## UpgradableVersionPathResult +## UserAssignedIdentity ### Properties -* **supportedPath**: string[] (ReadOnly): Array of UpgradableVersionPathResultSupportedPathItem +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. + +## UserAssignedIdentityMap +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) diff --git a/generated/servicefabricmanagedclusters/log.out b/generated/servicefabricmanagedclusters/log.out index 488abeb4e2..4d0b1cda4e 100644 --- a/generated/servicefabricmanagedclusters/log.out +++ b/generated/servicefabricmanagedclusters/log.out @@ -20,7 +20,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.servicefabric-2022-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -37,7 +37,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2022-02-01-preview/managedapplication.json:1112:9 @@ -64,7 +64,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'ManagedCluster' has an all warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 22ms +info | autorest.bicep took 21ms info | Processing batch task - {"tag":"microsoft.servicefabric-2022-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -81,7 +81,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2022-01-01/managedapplication.json:1112:9 @@ -108,7 +108,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'ManagedCluster' has an all warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.servicefabric-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -125,7 +125,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-11-01-preview/managedapplication.json:1112:9 @@ -152,7 +152,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'ManagedCluster' has an all warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 8ms +info | autorest.bicep took 9ms info | Processing batch task - {"tag":"microsoft.servicefabric-2021-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -169,7 +169,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/EmptyParentSchemaWarning | Schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' has an allOf list with an empty object schema as a parent, removing it. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-07-01-preview/managedapplication.json:1112:9 @@ -196,7 +196,7 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'ManagedCluster' has an all warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.servicefabric-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -213,7 +213,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/stable/2021-05-01/managedapplication.json:1105:5 @@ -407,7 +407,7 @@ warning | DeprecatedConfig | Using directive.11.suppress which is deprecated and warning | DeprecatedConfig | Using directive.12.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.13.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AddRemoveIncrementalNamedPartitionScalingMechanism' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2021-01-01-preview/managedapplication.json:1105:5 @@ -580,5 +580,5 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'ManagedCluster' has an all warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 12ms -info | Autorest completed in 32.03s. 12 files generated. +info | autorest.bicep took 7ms +info | Autorest completed in 30.01s. 12 files generated. diff --git a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.md b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.md index 32a6d73720..b5bcd5df20 100644 --- a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.md +++ b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-01-01-preview/types.md @@ -74,6 +74,90 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationHealthPolicy +### Properties +* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. +* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +* **version**: string: The version of the application type as defined in the application manifest. +This name must be the full Arm Resource ID for the referenced application type version. + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response + +## ApplicationTypeVersionsCleanupPolicy +### Properties +* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. + +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. +* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. +* **upgradeReplicaSetCheckTimeout**: int: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. + +## AzureActiveDirectory +### Properties +* **clientApplication**: string: Azure active directory client application id. +* **clusterApplication**: string: Azure active directory cluster application id. +* **tenantId**: string: Azure active directory tenant id. + +## ClientCertificate +### Properties +* **commonName**: string: Certificate common name. +* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. +* **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. +* **thumbprint**: string: Certificate thumbprint. + +## EndpointRangeDescription +### Properties +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports + +## LoadBalancingRule +### Properties +* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. +* **frontendPort**: int (Required): 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. +* **probeProtocol**: 'http' | 'https' | 'tcp' | string (Required): the reference to the load balancer probe used by the load balancing rule. +* **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. +* **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. + ## ManagedClusterProperties ### Properties * **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. @@ -106,40 +190,18 @@ * **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the virtual network of the cluster. * **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -## ApplicationTypeVersionsCleanupPolicy -### Properties -* **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. - -## AzureActiveDirectory -### Properties -* **clientApplication**: string: Azure active directory client application id. -* **clusterApplication**: string: Azure active directory cluster application id. -* **tenantId**: string: Azure active directory tenant id. - -## ClientCertificate -### Properties -* **commonName**: string: Certificate common name. -* **isAdmin**: bool (Required): Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. -* **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. -* **thumbprint**: string: Certificate thumbprint. - -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription +## ManagedIdentity ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. +* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## LoadBalancingRule +## ManagedProxyResourceTags ### Properties -* **backendPort**: int (Required): The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. -* **frontendPort**: int (Required): 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. -* **probeProtocol**: 'http' | 'https' | 'tcp' | string (Required): the reference to the load balancer probe used by the load balancing rule. -* **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. -* **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. +### Additional Properties +* **Additional Properties Type**: string ## NetworkSecurityRule ### Properties @@ -154,165 +216,35 @@ * **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. * **sourcePortRanges**: string[]: The source port ranges. -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. Basic requires a minimum of 3 nodes and Standard a minimum of 5. Basic only allows 1 node type. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. -* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. - -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -* **version**: string: The version of the application type as defined in the application manifest. -This name must be the full Arm Resource ID for the referenced application type version. - -## ApplicationUserAssignedIdentity +## NodeTypeProperties ### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. +* **dataDiskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **isPrimary**: bool (Required): 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. +* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. +* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. +* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. +* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. +* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. +* **vmInstanceCount**: int (Required): The number of nodes in the node type. +* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. +* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. +* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. -## ApplicationParameterList +## NodeTypePropertiesCapacities ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. -* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. -* **upgradeReplicaSetCheckTimeout**: int: 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). - -## ApplicationHealthPolicy -### Properties -* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. -* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. - -The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. -If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. -The computation rounds up to tolerate one failure on small numbers of partitions. -* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. - -The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. -If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. -The computation rounds up to tolerate one failure on small numbers of replicas. -* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. - -The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. -If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. -This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. -The computation rounds up to tolerate one failure on small numbers of services. - -## ServiceTypeHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) - -## RollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. -* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". - -## ProxyResourceTags +## NodeTypePropertiesPlacementProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceResourceProperties -* **Discriminator**: serviceKind - -### Base Properties -* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. -* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. -* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. -* **placementConstraints**: 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)". -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. -* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. -* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package -* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. -* **serviceTypeName**: string (Required): The name of the service type -### StatefulServiceProperties -#### Properties -* **hasPersistedState**: bool: 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. -* **minReplicaSetSize**: int: The minimum replica set size as a number. -* **quorumLossWaitDuration**: 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". -* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". -* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). -* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". -* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". -* **targetReplicaSetSize**: int: The target replica set size as a number. - -### StatelessServiceProperties -#### Properties -* **instanceCount**: int (Required): The instance count. -* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). - - -## ServiceCorrelation -### Properties -* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full ARM Resource ID describing the service resource - ## Partition * **Discriminator**: partitionScheme @@ -336,10 +268,39 @@ should be split between the partition ‘Count’ * **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ScalingPolicy +## ProxyResourceTags ### Properties -* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. -* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. +* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ## ScalingMechanism * **Discriminator**: kind @@ -360,6 +321,11 @@ should be split between the partition ‘Count’ * **scaleIncrement**: int (Required): The number of instances to add or remove during a scaling operation. +## ScalingPolicy +### Properties +* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. +* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. + ## ScalingTrigger * **Discriminator**: kind @@ -382,6 +348,11 @@ should be split between the partition ‘Count’ * **useOnlyPrimaryLoad**: bool (Required): Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. +## ServiceCorrelation +### Properties +* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full ARM Resource ID describing the service resource + ## ServiceLoadMetric ### Properties * **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. @@ -419,63 +390,115 @@ should be split between the partition ‘Count’ * **type**: 'RequiredDomainDistribution' (Required): The type of placement policy for a service fabric service. Following are the possible values. -## ProxyResourceTags +## ServiceResourceProperties +* **Discriminator**: serviceKind + +### Base Properties +* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. +* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. +* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. +* **placementConstraints**: 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)". +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. +* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. +* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package +* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. +* **serviceTypeName**: string (Required): The name of the service type +### StatefulServiceProperties +#### Properties +* **hasPersistedState**: bool: 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. +* **minReplicaSetSize**: int: The minimum replica set size as a number. +* **quorumLossWaitDuration**: 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". +* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". +* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). +* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". +* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". +* **targetReplicaSetSize**: int: The target replica set size as a number. + +### StatelessServiceProperties +#### Properties +* **instanceCount**: int (Required): The instance count. +* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). + + +## ServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. + +The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. +If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. +The computation rounds up to tolerate one failure on small numbers of partitions. +* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. + +The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. +If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. +The computation rounds up to tolerate one failure on small numbers of replicas. +* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. + +The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. +If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. +This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. +The computation rounds up to tolerate one failure on small numbers of services. + +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeResourceProperties +## SettingsParameterDescription ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ApplicationTypeVersionResourceProperties +## Sku ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. Basic requires a minimum of 3 nodes and Standard a minimum of 5. Basic only allows 1 node type. -## ProxyResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Azure resource identifier. -## NodeTypeProperties +## SystemData ### Properties -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. -* **dataDiskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **isPrimary**: bool (Required): 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. -* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. -* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. -* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. -* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. -* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -* **vmInstanceCount**: int (Required): The number of nodes in the node type. -* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. -* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. -* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. -## EndpointRangeDescription +## UserAssignedIdentity ### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NodeTypePropertiesCapacities +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## NodeTypePropertiesPlacementProperties +## VaultCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateStore**: string (Required): 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. +* **certificateUrl**: string (Required): 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":""
    } + +## VaultSecretGroup +### Properties +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmManagedIdentity +### Properties +* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ## VmssExtension ### Properties @@ -494,26 +517,3 @@ should be split between the partition ‘Count’ * **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (Required): Specifies the version of the script handler. -## VmManagedIdentity -### Properties -* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. - -## SubResource -### Properties -* **id**: string: Azure resource identifier. - -## VaultCertificate -### Properties -* **certificateStore**: string (Required): 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. -* **certificateUrl**: string (Required): 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":""
    } - -## ManagedProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.md b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.md index 06c0c04339..8dcdf1777c 100644 --- a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.md +++ b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-05-01/types.md @@ -74,37 +74,64 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type -## ManagedClusterProperties +## ApplicationHealthPolicy ### Properties -* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. -* **adminPassword**: string: VM admin user password. -* **adminUserName**: string (Required): VM admin user name. -* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to internet which can be overridden with custom Network Security Rules. The default value for this setting is false. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **clientConnectionPort**: int: The port used for client connections to the cluster. -* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. -* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. -* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. -* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -* **dnsName**: string (Required): The cluster dns name. -* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. -* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. -* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the virtual network of the cluster. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. +* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. +* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +* **version**: string: The version of the application type as defined in the application manifest. +This name must be the full Arm Resource ID for the referenced application type version. + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response ## ApplicationTypeVersionsCleanupPolicy ### Properties * **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. +* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. +* **upgradeReplicaSetCheckTimeout**: int: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. + ## AzureActiveDirectory ### Properties * **clientApplication**: string: Azure active directory client application id. @@ -118,15 +145,10 @@ * **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. * **thumbprint**: string: Certificate thumbprint. -## SettingsSectionDescription -### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. - -## SettingsParameterDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports ## LoadBalancingRule ### Properties @@ -137,36 +159,32 @@ * **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. * **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. -## NetworkSecurityRule -### Properties -* **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. -* **description**: string: Network security rule description. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'inbound' | 'outbound' | string (Required): Network security rule direction. -* **name**: string (Required): Network security rule name. -* **priority**: int (Required): The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. -* **protocol**: 'ah' | 'esp' | 'http' | 'https' | 'icmp' | 'tcp' | 'udp' | string (Required): Network protocol this rule applies to. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourcePortRanges**: string[]: The source port ranges. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. - -## ResourceTags +## ManagedClusterProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. +* **adminPassword**: string: VM admin user password. +* **adminUserName**: string (Required): VM admin user name. +* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to internet which can be overridden with custom Network Security Rules. The default value for this setting is false. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **clientConnectionPort**: int: The port used for client connections to the cluster. +* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. +* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. +* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. +* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +* **dnsName**: string (Required): The cluster dns name. +* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. +* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. +* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the virtual network of the cluster. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. ## ManagedIdentity ### Properties @@ -176,139 +194,56 @@ * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -* **version**: string: The version of the application type as defined in the application manifest. -This name must be the full Arm Resource ID for the referenced application type version. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationParameterList +## ManagedProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. -* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. -* **upgradeReplicaSetCheckTimeout**: int: 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). - -## ApplicationHealthPolicy +## NetworkSecurityRule ### Properties -* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. -* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. +* **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. +* **description**: string: Network security rule description. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'inbound' | 'outbound' | string (Required): Network security rule direction. +* **name**: string (Required): Network security rule name. +* **priority**: int (Required): The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. +* **protocol**: 'ah' | 'esp' | 'http' | 'https' | 'icmp' | 'tcp' | 'udp' | string (Required): Network protocol this rule applies to. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourcePortRanges**: string[]: The source port ranges. -## ServiceTypeHealthPolicy +## NodeTypeProperties ### Properties -* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. - -The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. -If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. -The computation rounds up to tolerate one failure on small numbers of partitions. -* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. - -The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. -If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. -The computation rounds up to tolerate one failure on small numbers of replicas. -* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. - -The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. -If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. -This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. -The computation rounds up to tolerate one failure on small numbers of services. +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. +* **dataDiskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. +* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **isPrimary**: bool (Required): 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. +* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. +* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. +* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. +* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. +* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. +* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. +* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. +* **vmInstanceCount**: int (Required): The number of nodes in the node type. +* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. +* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. +* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. -## ServiceTypeHealthPolicyMap +## NodeTypePropertiesCapacities ### Properties ### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) - -## RollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. -* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **Additional Properties Type**: string -## ProxyResourceTags +## NodeTypePropertiesPlacementProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceResourceProperties -* **Discriminator**: serviceKind - -### Base Properties -* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. -* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. -* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. -* **placementConstraints**: 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)". -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. -* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. -* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package -* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. -* **serviceTypeName**: string (Required): The name of the service type -### StatefulServiceProperties -#### Properties -* **hasPersistedState**: bool: 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. -* **minReplicaSetSize**: int: The minimum replica set size as a number. -* **quorumLossWaitDuration**: 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". -* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". -* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). -* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". -* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". -* **targetReplicaSetSize**: int: The target replica set size as a number. - -### StatelessServiceProperties -#### Properties -* **instanceCount**: int (Required): The instance count. -* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). - - -## ServiceCorrelation -### Properties -* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full ARM Resource ID describing the service resource - ## Partition * **Discriminator**: partitionScheme @@ -332,10 +267,39 @@ should be split between the partition ‘Count’ * **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ScalingPolicy +## ProxyResourceTags ### Properties -* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. -* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. +* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ## ScalingMechanism * **Discriminator**: kind @@ -356,6 +320,11 @@ should be split between the partition ‘Count’ * **scaleIncrement**: int (Required): The number of instances to add or remove during a scaling operation. +## ScalingPolicy +### Properties +* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. +* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. + ## ScalingTrigger * **Discriminator**: kind @@ -378,6 +347,11 @@ should be split between the partition ‘Count’ * **useOnlyPrimaryLoad**: bool (Required): Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. +## ServiceCorrelation +### Properties +* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full ARM Resource ID describing the service resource + ## ServiceLoadMetric ### Properties * **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. @@ -415,66 +389,115 @@ should be split between the partition ‘Count’ * **type**: 'RequiredDomainDistribution' (Required): The type of placement policy for a service fabric service. Following are the possible values. -## ProxyResourceTags +## ServiceResourceProperties +* **Discriminator**: serviceKind + +### Base Properties +* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. +* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. +* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. +* **placementConstraints**: 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)". +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. +* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. +* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package +* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. +* **serviceTypeName**: string (Required): The name of the service type +### StatefulServiceProperties +#### Properties +* **hasPersistedState**: bool: 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. +* **minReplicaSetSize**: int: The minimum replica set size as a number. +* **quorumLossWaitDuration**: 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". +* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". +* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). +* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". +* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". +* **targetReplicaSetSize**: int: The target replica set size as a number. + +### StatelessServiceProperties +#### Properties +* **instanceCount**: int (Required): The instance count. +* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). + + +## ServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. + +The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. +If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. +The computation rounds up to tolerate one failure on small numbers of partitions. +* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. + +The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. +If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. +The computation rounds up to tolerate one failure on small numbers of replicas. +* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. + +The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. +If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. +This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. +The computation rounds up to tolerate one failure on small numbers of services. + +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeResourceProperties +## SettingsParameterDescription ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ApplicationTypeVersionResourceProperties +## Sku ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. -## ProxyResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Azure resource identifier. -## NodeTypeProperties +## SystemData ### Properties -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. -* **dataDiskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. -* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **isPrimary**: bool (Required): 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. -* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. -* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. -* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. -* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. -* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. -* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. -* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -* **vmInstanceCount**: int (Required): The number of nodes in the node type. -* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. -* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. -* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. -## EndpointRangeDescription +## UserAssignedIdentity ### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NodeTypePropertiesCapacities +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## NodeTypePropertiesPlacementProperties +## VaultCertificate ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **certificateStore**: string (Required): 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. +* **certificateUrl**: string (Required): 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":""
    } + +## VaultSecretGroup +### Properties +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmManagedIdentity +### Properties +* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ## VmssExtension ### Properties @@ -493,26 +516,3 @@ should be split between the partition ‘Count’ * **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (Required): Specifies the version of the script handler. -## VmManagedIdentity -### Properties -* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. - -## SubResource -### Properties -* **id**: string: Azure resource identifier. - -## VaultCertificate -### Properties -* **certificateStore**: string (Required): 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. -* **certificateUrl**: string (Required): 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":""
    } - -## ManagedProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.md b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.md index b9b2db5bb3..99359f6d38 100644 --- a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.md +++ b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-07-01-preview/types.md @@ -75,40 +75,64 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type -## ManagedClusterProperties +## ApplicationHealthPolicy ### Properties -* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. -* **adminPassword**: string: VM admin user password. -* **adminUserName**: string (Required): VM admin user name. -* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **clientConnectionPort**: int: The port used for client connections to the cluster. -* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. -* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. -* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. -* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -* **dnsName**: string (Required): The cluster dns name. -* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. -* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. -* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. -* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. -* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. -* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. +* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. +* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +* **version**: string: The version of the application type as defined in the application manifest. +This name must be the full Arm Resource ID for the referenced application type version. + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response ## ApplicationTypeVersionsCleanupPolicy ### Properties * **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. +## ApplicationUpgradePolicy +### Properties +* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. +* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. +* **upgradeReplicaSetCheckTimeout**: int: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. + ## AzureActiveDirectory ### Properties * **clientApplication**: string: Azure active directory client application id. @@ -122,15 +146,16 @@ * **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. * **thumbprint**: string: Certificate thumbprint. -## SettingsSectionDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports -## SettingsParameterDescription +## FrontendConfiguration ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. +* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. +* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ## IPTag ### Properties @@ -146,36 +171,35 @@ * **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. * **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. -## NetworkSecurityRule -### Properties -* **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. -* **description**: string: Network security rule description. -* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. -* **destinationPortRanges**: string[]: The destination port ranges. -* **direction**: 'inbound' | 'outbound' | string (Required): Network security rule direction. -* **name**: string (Required): Network security rule name. -* **priority**: int (Required): The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. -* **protocol**: 'ah' | 'esp' | 'http' | 'https' | 'icmp' | 'tcp' | 'udp' | string (Required): Network protocol this rule applies to. -* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. -* **sourcePortRanges**: string[]: The source port ranges. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. - -## ResourceTags +## ManagedClusterProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. +* **adminPassword**: string: VM admin user password. +* **adminUserName**: string (Required): VM admin user name. +* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **clientConnectionPort**: int: The port used for client connections to the cluster. +* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. +* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. +* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. +* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +* **dnsName**: string (Required): The cluster dns name. +* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. +* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. +* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. +* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. +* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. +* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. ## ManagedIdentity ### Properties @@ -185,138 +209,63 @@ * **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -* **version**: string: The version of the application type as defined in the application manifest. -This name must be the full Arm Resource ID for the referenced application type version. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationParameterList +## ManagedProxyResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. -* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. -* **upgradeReplicaSetCheckTimeout**: int: 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). - -## ApplicationHealthPolicy -### Properties -* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. -* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. - -The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. -If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. -The computation rounds up to tolerate one failure on small numbers of partitions. -* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. - -The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. -If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. -The computation rounds up to tolerate one failure on small numbers of replicas. -* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. - -The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. -If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. -This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. -The computation rounds up to tolerate one failure on small numbers of services. - -## ServiceTypeHealthPolicyMap +## NetworkSecurityRule ### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) +* **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. +* **description**: string: Network security rule description. +* **destinationAddressPrefixes**: string[]: The destination address prefixes. CIDR or destination IP ranges. +* **destinationPortRanges**: string[]: The destination port ranges. +* **direction**: 'inbound' | 'outbound' | string (Required): Network security rule direction. +* **name**: string (Required): Network security rule name. +* **priority**: int (Required): The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. +* **protocol**: 'ah' | 'esp' | 'http' | 'https' | 'icmp' | 'tcp' | 'udp' | string (Required): Network protocol this rule applies to. +* **sourceAddressPrefixes**: string[]: The CIDR or source IP ranges. +* **sourcePortRanges**: string[]: The source port ranges. -## RollingUpgradeMonitoringPolicy +## NodeTypeProperties ### Properties -* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. -* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. +* **dataDiskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. +* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. +* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. +* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. +* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. +* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. +* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. +* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. +* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. +* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. +* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. +* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. +* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. +* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. -## ProxyResourceTags +## NodeTypePropertiesCapacities ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServiceResourceProperties -* **Discriminator**: serviceKind - -### Base Properties -* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. -* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. -* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. -* **placementConstraints**: 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)". -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. -* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. -* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package -* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. -* **serviceTypeName**: string (Required): The name of the service type -### StatefulServiceProperties -#### Properties -* **hasPersistedState**: bool: 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. -* **minReplicaSetSize**: int: The minimum replica set size as a number. -* **quorumLossWaitDuration**: 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". -* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". -* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). -* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". -* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". -* **targetReplicaSetSize**: int: The target replica set size as a number. - -### StatelessServiceProperties -#### Properties -* **instanceCount**: int (Required): The instance count. -* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). - +## NodeTypePropertiesPlacementProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ServiceCorrelation +## NodeTypeSku ### Properties -* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full ARM Resource ID describing the service resource +* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. +* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. +* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** ## Partition * **Discriminator**: partitionScheme @@ -341,10 +290,39 @@ should be split between the partition ‘Count’ * **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ScalingPolicy +## ProxyResourceTags ### Properties -* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. -* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. +* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ## ScalingMechanism * **Discriminator**: kind @@ -365,6 +343,11 @@ should be split between the partition ‘Count’ * **scaleIncrement**: int (Required): The number of instances to add or remove during a scaling operation. +## ScalingPolicy +### Properties +* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. +* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. + ## ScalingTrigger * **Discriminator**: kind @@ -387,6 +370,11 @@ should be split between the partition ‘Count’ * **useOnlyPrimaryLoad**: bool (Required): Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. +## ServiceCorrelation +### Properties +* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full ARM Resource ID describing the service resource + ## ServiceLoadMetric ### Properties * **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. @@ -424,74 +412,115 @@ should be split between the partition ‘Count’ * **type**: 'RequiredDomainDistribution' (Required): The type of placement policy for a service fabric service. Following are the possible values. -## ProxyResourceTags +## ServiceResourceProperties +* **Discriminator**: serviceKind + +### Base Properties +* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. +* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. +* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. +* **placementConstraints**: 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)". +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. +* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. +* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package +* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. +* **serviceTypeName**: string (Required): The name of the service type +### StatefulServiceProperties +#### Properties +* **hasPersistedState**: bool: 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. +* **minReplicaSetSize**: int: The minimum replica set size as a number. +* **quorumLossWaitDuration**: 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". +* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". +* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). +* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". +* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". +* **targetReplicaSetSize**: int: The target replica set size as a number. + +### StatelessServiceProperties +#### Properties +* **instanceCount**: int (Required): The instance count. +* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). + + +## ServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. + +The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. +If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. +The computation rounds up to tolerate one failure on small numbers of partitions. +* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. + +The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. +If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. +The computation rounds up to tolerate one failure on small numbers of replicas. +* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. + +The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. +If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. +This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. +The computation rounds up to tolerate one failure on small numbers of services. + +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeResourceProperties +## SettingsParameterDescription ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ApplicationTypeVersionResourceProperties +## Sku ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. -## ProxyResourceTags +## SubResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Azure resource identifier. -## NodeTypeProperties +## SystemData ### Properties -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. -* **dataDiskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. -* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. -* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. -* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. -* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. -* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. -* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. -* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. -* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. -* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. -* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. -* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. -* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. -## EndpointRangeDescription +## UserAssignedIdentity ### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NodeTypePropertiesCapacities +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## FrontendConfiguration +## VaultCertificate ### Properties -* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. -* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. -* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. +* **certificateStore**: string (Required): 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. +* **certificateUrl**: string (Required): 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":""
    } -## NodeTypePropertiesPlacementProperties +## VaultSecretGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmManagedIdentity +### Properties +* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ## VmssExtension ### Properties @@ -510,32 +539,3 @@ should be split between the partition ‘Count’ * **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (Required): Specifies the version of the script handler. -## VmManagedIdentity -### Properties -* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. - -## SubResource -### Properties -* **id**: string: Azure resource identifier. - -## VaultCertificate -### Properties -* **certificateStore**: string (Required): 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. -* **certificateUrl**: string (Required): 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":""
    } - -## NodeTypeSku -### Properties -* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. -* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. -* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** - -## ManagedProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.md b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.md index 9d4ba1b3da..d9358bbe0b 100644 --- a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.md +++ b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2021-11-01-preview/types.md @@ -75,51 +75,63 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type -## ManagedClusterProperties +## ApplicationHealthPolicy ### Properties -* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. -* **adminPassword**: string: VM admin user password. -* **adminUserName**: string (Required): VM admin user name. -* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. -* **auxiliarySubnets**: [Subnet](#subnet)[]: Auxiliary subnets for the cluster. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **clientConnectionPort**: int: The port used for client connections to the cluster. -* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. -* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. -* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. -* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -* **dnsName**: string (Required): The cluster dns name. -* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. -* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. -* **enableServicePublicIP**: bool: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. -* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. -* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. -* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. -* **ipv6Address**: string (ReadOnly): IPv6 address for the cluster if IPv6 is enabled. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **serviceEndpoints**: [ServiceEndpoint](#serviceendpoint)[]: Service endpoints for subnets in the cluster. -* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. -* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. +* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. +* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +* **version**: string: The version of the application type as defined in the application manifest. +This name must be the full Arm Resource ID for the referenced application type version. + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response ## ApplicationTypeVersionsCleanupPolicy ### Properties * **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. -## Subnet +## ApplicationUpgradePolicy ### Properties -* **enableIpv6**: bool: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. -* **name**: string (Required): Subnet name. -* **networkSecurityGroupId**: string: Full resource id for the network security group. -* **privateEndpointNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateLinkServiceNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. +* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. +* **upgradeReplicaSetCheckTimeout**: int: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. ## AzureActiveDirectory ### Properties @@ -134,15 +146,16 @@ * **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. * **thumbprint**: string: Certificate thumbprint. -## SettingsSectionDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports -## SettingsParameterDescription +## FrontendConfiguration ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. +* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. +* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ## IPTag ### Properties @@ -158,6 +171,53 @@ * **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. * **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. +## ManagedClusterProperties +### Properties +* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. +* **adminPassword**: string: VM admin user password. +* **adminUserName**: string (Required): VM admin user name. +* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. +* **auxiliarySubnets**: [Subnet](#subnet)[]: Auxiliary subnets for the cluster. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **clientConnectionPort**: int: The port used for client connections to the cluster. +* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. +* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. +* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. +* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +* **dnsName**: string (Required): The cluster dns name. +* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. +* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. +* **enableServicePublicIP**: bool: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. +* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. +* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. +* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. +* **ipv6Address**: string (ReadOnly): IPv6 address for the cluster if IPv6 is enabled. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **serviceEndpoints**: [ServiceEndpoint](#serviceendpoint)[]: Service endpoints for subnets in the cluster. +* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. +* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. +* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. + +## ManagedProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## NetworkSecurityRule ### Properties * **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. @@ -175,169 +235,51 @@ * **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. * **sourcePortRanges**: string[]: The source port ranges. -## ServiceEndpoint -### Properties -* **locations**: string[]: A list of locations. -* **service**: string (Required): The type of the endpoint service. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. -* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. - -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -* **version**: string: The version of the application type as defined in the application manifest. -This name must be the full Arm Resource ID for the referenced application type version. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationParameterList -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. -* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. -* **upgradeReplicaSetCheckTimeout**: int: 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). - -## ApplicationHealthPolicy -### Properties -* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. -* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. - -The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. -If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. -The computation rounds up to tolerate one failure on small numbers of partitions. -* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. - -The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. -If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. -The computation rounds up to tolerate one failure on small numbers of replicas. -* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. - -The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. -If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. -This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. -The computation rounds up to tolerate one failure on small numbers of services. - -## ServiceTypeHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) - -## RollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. -* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". - -## ProxyResourceTags +## NodeTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceResourceProperties -* **Discriminator**: serviceKind - -### Base Properties -* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. -* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. -* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. -* **placementConstraints**: 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)". -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. -* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. -* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package -* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. -* **serviceTypeName**: string (Required): The name of the service type -### StatefulServiceProperties -#### Properties -* **hasPersistedState**: bool: 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. -* **minReplicaSetSize**: int: The minimum replica set size as a number. -* **quorumLossWaitDuration**: 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". -* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". -* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). -* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". -* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". -* **targetReplicaSetSize**: int: The target replica set size as a number. - -### StatelessServiceProperties -#### Properties -* **instanceCount**: int (Required): The instance count. -* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). +* **additionalDataDisks**: [VmssDataDisk](#vmssdatadisk)[]: Additional managed data disks. +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. +* **dataDiskLetter**: string: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. +* **dataDiskSizeGB**: int: Disk size for the managed disk attached to the vms on the node type in GBs. +* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableEncryptionAtHost**: bool: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. +* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. +* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. +* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. +* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **useDefaultPublicLoadBalancer**: bool: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. +* **useTempDataDisk**: bool: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. +* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. +* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. +* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. +* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. +* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. +* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. +* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. +* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. +* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +## NodeTypePropertiesCapacities +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ServiceCorrelation +## NodeTypePropertiesPlacementProperties ### Properties -* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full ARM Resource ID describing the service resource +### Additional Properties +* **Additional Properties Type**: string + +## NodeTypeSku +### Properties +* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. +* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. +* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** ## Partition * **Discriminator**: partitionScheme @@ -362,10 +304,39 @@ should be split between the partition ‘Count’ * **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ScalingPolicy +## ProxyResourceTags ### Properties -* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. -* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. +* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ## ScalingMechanism * **Discriminator**: kind @@ -386,6 +357,11 @@ should be split between the partition ‘Count’ * **scaleIncrement**: int (Required): The number of instances to add or remove during a scaling operation. +## ScalingPolicy +### Properties +* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. +* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. + ## ScalingTrigger * **Discriminator**: kind @@ -408,6 +384,16 @@ should be split between the partition ‘Count’ * **useOnlyPrimaryLoad**: bool (Required): Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. +## ServiceCorrelation +### Properties +* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full ARM Resource ID describing the service resource + +## ServiceEndpoint +### Properties +* **locations**: string[]: A list of locations. +* **service**: string (Required): The type of the endpoint service. + ## ServiceLoadMetric ### Properties * **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. @@ -445,87 +431,130 @@ should be split between the partition ‘Count’ * **type**: 'RequiredDomainDistribution' (Required): The type of placement policy for a service fabric service. Following are the possible values. -## ProxyResourceTags +## ServiceResourceProperties +* **Discriminator**: serviceKind + +### Base Properties +* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. +* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. +* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. +* **placementConstraints**: 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)". +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. +* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. +* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package +* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. +* **serviceTypeName**: string (Required): The name of the service type +### StatefulServiceProperties +#### Properties +* **hasPersistedState**: bool: 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. +* **minReplicaSetSize**: int: The minimum replica set size as a number. +* **quorumLossWaitDuration**: 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". +* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". +* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). +* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". +* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". +* **targetReplicaSetSize**: int: The target replica set size as a number. + +### StatelessServiceProperties +#### Properties +* **instanceCount**: int (Required): The instance count. +* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). + + +## ServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. + +The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. +If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. +The computation rounds up to tolerate one failure on small numbers of partitions. +* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. + +The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. +If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. +The computation rounds up to tolerate one failure on small numbers of replicas. +* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. + +The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. +If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. +This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. +The computation rounds up to tolerate one failure on small numbers of services. + +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeResourceProperties +## SettingsParameterDescription ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ApplicationTypeVersionResourceProperties +## Sku ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. -## ProxyResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enableIpv6**: bool: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. +* **name**: string (Required): Subnet name. +* **networkSecurityGroupId**: string: Full resource id for the network security group. +* **privateEndpointNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateLinkServiceNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private link service in the subnet. -## NodeTypeProperties +## SubResource ### Properties -* **additionalDataDisks**: [VmssDataDisk](#vmssdatadisk)[]: Additional managed data disks. -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. -* **dataDiskLetter**: string: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. -* **dataDiskSizeGB**: int: Disk size for the managed disk attached to the vms on the node type in GBs. -* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableEncryptionAtHost**: bool: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. -* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. -* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. -* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. -* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **useDefaultPublicLoadBalancer**: bool: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. -* **useTempDataDisk**: bool: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. -* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. -* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. -* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. -* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. -* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. -* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. -* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. -* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +* **id**: string: Azure resource identifier. -## VmssDataDisk +## SystemData ### Properties -* **diskLetter**: string (Required): Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. -* **diskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required): Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **lun**: int (Required): 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 0 is reserved for the service fabric data disk. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. -## EndpointRangeDescription +## UserAssignedIdentity ### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NodeTypePropertiesCapacities +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## FrontendConfiguration +## VaultCertificate ### Properties -* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. -* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. -* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. +* **certificateStore**: string (Required): 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. +* **certificateUrl**: string (Required): 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":""
    } -## NodeTypePropertiesPlacementProperties +## VaultSecretGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmManagedIdentity +### Properties +* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## VmssDataDisk +### Properties +* **diskLetter**: string (Required): Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. +* **diskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required): Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **lun**: int (Required): 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 0 is reserved for the service fabric data disk. ## VmssExtension ### Properties @@ -544,32 +573,3 @@ should be split between the partition ‘Count’ * **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (Required): Specifies the version of the script handler. -## VmManagedIdentity -### Properties -* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. - -## SubResource -### Properties -* **id**: string: Azure resource identifier. - -## VaultCertificate -### Properties -* **certificateStore**: string (Required): 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. -* **certificateUrl**: string (Required): 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":""
    } - -## NodeTypeSku -### Properties -* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. -* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. -* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** - -## ManagedProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.md b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.md index 7b96dfdad0..81261be167 100644 --- a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.md +++ b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-01-01/types.md @@ -75,51 +75,63 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type -## ManagedClusterProperties +## ApplicationHealthPolicy ### Properties -* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. -* **adminPassword**: string: VM admin user password. -* **adminUserName**: string (Required): VM admin user name. -* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. -* **auxiliarySubnets**: [Subnet](#subnet)[]: Auxiliary subnets for the cluster. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **clientConnectionPort**: int: The port used for client connections to the cluster. -* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. -* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. -* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. -* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -* **dnsName**: string (Required): The cluster dns name. -* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. -* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. -* **enableServicePublicIP**: bool: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. -* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. -* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. -* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. -* **ipv6Address**: string (ReadOnly): IPv6 address for the cluster if IPv6 is enabled. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **serviceEndpoints**: [ServiceEndpoint](#serviceendpoint)[]: Service endpoints for subnets in the cluster. -* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. -* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. +* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. +* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +* **version**: string: The version of the application type as defined in the application manifest. +This name must be the full Arm Resource ID for the referenced application type version. + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response ## ApplicationTypeVersionsCleanupPolicy ### Properties * **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. -## Subnet +## ApplicationUpgradePolicy ### Properties -* **enableIpv6**: bool: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. -* **name**: string (Required): Subnet name. -* **networkSecurityGroupId**: string: Full resource id for the network security group. -* **privateEndpointNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateLinkServiceNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. +* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. +* **upgradeReplicaSetCheckTimeout**: int: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. ## AzureActiveDirectory ### Properties @@ -134,15 +146,16 @@ * **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. * **thumbprint**: string: Certificate thumbprint. -## SettingsSectionDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports -## SettingsParameterDescription +## FrontendConfiguration ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. +* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. +* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ## IPTag ### Properties @@ -159,6 +172,53 @@ * **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. * **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. +## ManagedClusterProperties +### Properties +* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. +* **adminPassword**: string: VM admin user password. +* **adminUserName**: string (Required): VM admin user name. +* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. +* **auxiliarySubnets**: [Subnet](#subnet)[]: Auxiliary subnets for the cluster. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **clientConnectionPort**: int: The port used for client connections to the cluster. +* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. +* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. +* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. +* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +* **dnsName**: string (Required): The cluster dns name. +* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. +* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. +* **enableServicePublicIP**: bool: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. +* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. +* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. +* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. +* **ipv6Address**: string (ReadOnly): IPv6 address for the cluster if IPv6 is enabled. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **serviceEndpoints**: [ServiceEndpoint](#serviceendpoint)[]: Service endpoints for subnets in the cluster. +* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. +* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. +* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. + +## ManagedProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## NetworkSecurityRule ### Properties * **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. @@ -176,169 +236,52 @@ * **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. * **sourcePortRanges**: string[]: The source port ranges. -## ServiceEndpoint -### Properties -* **locations**: string[]: A list of locations. -* **service**: string (Required): The type of the endpoint service. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. -* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. - -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -* **version**: string: The version of the application type as defined in the application manifest. -This name must be the full Arm Resource ID for the referenced application type version. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationParameterList -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. -* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. -* **upgradeReplicaSetCheckTimeout**: int: 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). - -## ApplicationHealthPolicy -### Properties -* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. -* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. - -The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. -If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. -The computation rounds up to tolerate one failure on small numbers of partitions. -* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. - -The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. -If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. -The computation rounds up to tolerate one failure on small numbers of replicas. -* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. - -The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. -If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. -This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. -The computation rounds up to tolerate one failure on small numbers of services. - -## ServiceTypeHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) - -## RollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. -* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". - -## ProxyResourceTags +## NodeTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceResourceProperties -* **Discriminator**: serviceKind - -### Base Properties -* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. -* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. -* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. -* **placementConstraints**: 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)". -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. -* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. -* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package -* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. -* **serviceTypeName**: string (Required): The name of the service type -### StatefulServiceProperties -#### Properties -* **hasPersistedState**: bool: 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. -* **minReplicaSetSize**: int: The minimum replica set size as a number. -* **quorumLossWaitDuration**: 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". -* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". -* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). -* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". -* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". -* **targetReplicaSetSize**: int: The target replica set size as a number. - -### StatelessServiceProperties -#### Properties -* **instanceCount**: int (Required): The instance count. -* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). +* **additionalDataDisks**: [VmssDataDisk](#vmssdatadisk)[]: Additional managed data disks. +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. +* **dataDiskLetter**: string: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. +* **dataDiskSizeGB**: int: Disk size for the managed disk attached to the vms on the node type in GBs. +* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableEncryptionAtHost**: bool: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **enableOverProvisioning**: bool: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. +* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. +* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. +* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. +* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **useDefaultPublicLoadBalancer**: bool: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. +* **useTempDataDisk**: bool: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. +* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. +* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. +* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. +* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. +* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. +* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. +* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. +* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. +* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +## NodeTypePropertiesCapacities +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ServiceCorrelation +## NodeTypePropertiesPlacementProperties ### Properties -* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full ARM Resource ID describing the service resource +### Additional Properties +* **Additional Properties Type**: string + +## NodeTypeSku +### Properties +* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. +* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. +* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** ## Partition * **Discriminator**: partitionScheme @@ -363,10 +306,39 @@ should be split between the partition ‘Count’ * **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ScalingPolicy +## ProxyResourceTags ### Properties -* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. -* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. +* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ## ScalingMechanism * **Discriminator**: kind @@ -387,6 +359,11 @@ should be split between the partition ‘Count’ * **scaleIncrement**: int (Required): The number of instances to add or remove during a scaling operation. +## ScalingPolicy +### Properties +* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. +* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. + ## ScalingTrigger * **Discriminator**: kind @@ -409,6 +386,16 @@ should be split between the partition ‘Count’ * **useOnlyPrimaryLoad**: bool (Required): Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. +## ServiceCorrelation +### Properties +* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full ARM Resource ID describing the service resource + +## ServiceEndpoint +### Properties +* **locations**: string[]: A list of locations. +* **service**: string (Required): The type of the endpoint service. + ## ServiceLoadMetric ### Properties * **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. @@ -446,88 +433,130 @@ should be split between the partition ‘Count’ * **type**: 'RequiredDomainDistribution' (Required): The type of placement policy for a service fabric service. Following are the possible values. -## ProxyResourceTags +## ServiceResourceProperties +* **Discriminator**: serviceKind + +### Base Properties +* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. +* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. +* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. +* **placementConstraints**: 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)". +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. +* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. +* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package +* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. +* **serviceTypeName**: string (Required): The name of the service type +### StatefulServiceProperties +#### Properties +* **hasPersistedState**: bool: 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. +* **minReplicaSetSize**: int: The minimum replica set size as a number. +* **quorumLossWaitDuration**: 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". +* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". +* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). +* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". +* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". +* **targetReplicaSetSize**: int: The target replica set size as a number. + +### StatelessServiceProperties +#### Properties +* **instanceCount**: int (Required): The instance count. +* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). + + +## ServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. + +The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. +If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. +The computation rounds up to tolerate one failure on small numbers of partitions. +* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. + +The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. +If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. +The computation rounds up to tolerate one failure on small numbers of replicas. +* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. + +The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. +If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. +This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. +The computation rounds up to tolerate one failure on small numbers of services. + +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeResourceProperties +## SettingsParameterDescription ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ApplicationTypeVersionResourceProperties +## Sku ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. -## ProxyResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enableIpv6**: bool: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. +* **name**: string (Required): Subnet name. +* **networkSecurityGroupId**: string: Full resource id for the network security group. +* **privateEndpointNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateLinkServiceNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private link service in the subnet. -## NodeTypeProperties +## SubResource ### Properties -* **additionalDataDisks**: [VmssDataDisk](#vmssdatadisk)[]: Additional managed data disks. -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. -* **dataDiskLetter**: string: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. -* **dataDiskSizeGB**: int: Disk size for the managed disk attached to the vms on the node type in GBs. -* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableEncryptionAtHost**: bool: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **enableOverProvisioning**: bool: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. -* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. -* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. -* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. -* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **useDefaultPublicLoadBalancer**: bool: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. -* **useTempDataDisk**: bool: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. -* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. -* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. -* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. -* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. -* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. -* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. -* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. -* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +* **id**: string: Azure resource identifier. -## VmssDataDisk +## SystemData ### Properties -* **diskLetter**: string (Required): Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. -* **diskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required): Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **lun**: int (Required): 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 0 is reserved for the service fabric data disk. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. -## EndpointRangeDescription +## UserAssignedIdentity ### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NodeTypePropertiesCapacities +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## FrontendConfiguration +## VaultCertificate ### Properties -* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. -* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. -* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. +* **certificateStore**: string (Required): 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. +* **certificateUrl**: string (Required): 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":""
    } -## NodeTypePropertiesPlacementProperties +## VaultSecretGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmManagedIdentity +### Properties +* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## VmssDataDisk +### Properties +* **diskLetter**: string (Required): Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. +* **diskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required): Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **lun**: int (Required): 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 0 is reserved for the service fabric data disk. ## VmssExtension ### Properties @@ -547,32 +576,3 @@ should be split between the partition ‘Count’ * **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (Required): Specifies the version of the script handler. -## VmManagedIdentity -### Properties -* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. - -## SubResource -### Properties -* **id**: string: Azure resource identifier. - -## VaultCertificate -### Properties -* **certificateStore**: string (Required): 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. -* **certificateUrl**: string (Required): 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":""
    } - -## NodeTypeSku -### Properties -* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. -* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. -* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** - -## ManagedProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.md b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.md index 8b88b3233f..dd8b26b4b2 100644 --- a/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.md +++ b/generated/servicefabricmanagedclusters/microsoft.servicefabric/2022-02-01-preview/types.md @@ -75,51 +75,63 @@ * **tags**: [ManagedProxyResourceTags](#managedproxyresourcetags): Azure resource tags. * **type**: 'Microsoft.ServiceFabric/managedClusters/nodeTypes' (ReadOnly, DeployTimeConstant): The resource type -## ManagedClusterProperties +## ApplicationHealthPolicy ### Properties -* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. -* **adminPassword**: string: VM admin user password. -* **adminUserName**: string (Required): VM admin user name. -* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. -* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. -* **auxiliarySubnets**: [Subnet](#subnet)[]: Auxiliary subnets for the cluster. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. -* **clientConnectionPort**: int: The port used for client connections to the cluster. -* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. -* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. -* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. -* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. -* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. -* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. -* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. -* **dnsName**: string (Required): The cluster dns name. -* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. -* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. -* **enableServicePublicIP**: bool: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. -* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. -* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. -* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. -* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. -* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. -* **ipv6Address**: string (ReadOnly): IPv6 address for the cluster if IPv6 is enabled. -* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **serviceEndpoints**: [ServiceEndpoint](#serviceendpoint)[]: Service endpoints for subnets in the cluster. -* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. -* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. +* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. +* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. +* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. +* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. + +## ApplicationParameterList +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ApplicationResourceProperties +### Properties +* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. +* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. +* **version**: string: The version of the application type as defined in the application manifest. +This name must be the full Arm Resource ID for the referenced application type version. + +## ApplicationTypeResourceProperties +### Properties +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. + +## ApplicationTypeVersionResourceProperties +### Properties +* **appPackageUrl**: string (Required): The URL to the application package +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response ## ApplicationTypeVersionsCleanupPolicy ### Properties * **maxUnusedVersionsToKeep**: int (Required): Number of unused versions per application type to keep. -## Subnet +## ApplicationUpgradePolicy ### Properties -* **enableIpv6**: bool: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. -* **name**: string (Required): Subnet name. -* **networkSecurityGroupId**: string: Full resource id for the network security group. -* **privateEndpointNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private end point in the subnet. -* **privateLinkServiceNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private link service in the subnet. +* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. +* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). +* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. +* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. +* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade +* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. +* **upgradeReplicaSetCheckTimeout**: int: 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). + +## ApplicationUserAssignedIdentity +### Properties +* **name**: string (Required): The friendly name of user assigned identity. +* **principalId**: string (Required): The principal id of user assigned identity. ## AzureActiveDirectory ### Properties @@ -134,15 +146,16 @@ * **issuerThumbprint**: string: Issuer thumbprint for the certificate. Only used together with CommonName. * **thumbprint**: string: Certificate thumbprint. -## SettingsSectionDescription +## EndpointRangeDescription ### Properties -* **name**: string (Required): The section name of the fabric settings. -* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. +* **endPort**: int (Required): End port of a range of ports +* **startPort**: int (Required): Starting port of a range of ports -## SettingsParameterDescription +## FrontendConfiguration ### Properties -* **name**: string (Required): The parameter name of fabric setting. -* **value**: string (Required): The parameter value of fabric setting. +* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. +* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. +* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. ## IPTag ### Properties @@ -159,6 +172,53 @@ * **probeRequestPath**: string: The probe request path. Only supported for HTTP/HTTPS probes. * **protocol**: 'tcp' | 'udp' | string (Required): The reference to the transport protocol used by the load balancing rule. +## ManagedClusterProperties +### Properties +* **addonFeatures**: 'BackupRestoreService' | 'DnsService' | 'ResourceMonitorService' | string[]: List of add-on features to enable on the cluster. +* **adminPassword**: string: VM admin user password. +* **adminUserName**: string (Required): VM admin user name. +* **allowRdpAccess**: bool: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. +* **applicationTypeVersionsCleanupPolicy**: [ApplicationTypeVersionsCleanupPolicy](#applicationtypeversionscleanuppolicy): The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. +* **auxiliarySubnets**: [Subnet](#subnet)[]: Auxiliary subnets for the cluster. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The settings to enable AAD authentication on the cluster. +* **clientConnectionPort**: int: The port used for client connections to the cluster. +* **clients**: [ClientCertificate](#clientcertificate)[]: Client certificates that are allowed to manage the cluster. +* **clusterCertificateThumbprints**: string[] (ReadOnly): List of thumbprints of the cluster certificates. +* **clusterCodeVersion**: string: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** 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**. +* **clusterId**: string (ReadOnly): A service generated unique identifier for the cluster resource. +* **clusterState**: 'BaselineUpgrade' | 'Deploying' | 'Ready' | 'UpgradeFailed' | 'Upgrading' | 'WaitingForNodes' | string (ReadOnly): The current state of the cluster. +* **clusterUpgradeCadence**: 'Wave0' | 'Wave1' | 'Wave2' | string: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. +* **clusterUpgradeMode**: 'Automatic' | 'Manual' | string: The upgrade mode of the cluster when new Service Fabric runtime version is available. +* **dnsName**: string (Required): The cluster dns name. +* **enableAutoOSUpgrade**: bool: Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false. +* **enableIpv6**: bool: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. +* **enableServicePublicIP**: bool: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. +* **fabricSettings**: [SettingsSectionDescription](#settingssectiondescription)[]: The list of custom fabric settings to configure the cluster. +* **fqdn**: string (ReadOnly): The fully qualified domain name associated with the public load balancer of the cluster. +* **httpGatewayConnectionPort**: int: The port used for HTTP connections to the cluster. +* **ipTags**: [IPTag](#iptag)[]: The list of IP tags associated with the default public IP address of the cluster. +* **ipv4Address**: string (ReadOnly): The IPv4 address associated with the public load balancer of the cluster. +* **ipv6Address**: string (ReadOnly): IPv6 address for the cluster if IPv6 is enabled. +* **loadBalancingRules**: [LoadBalancingRule](#loadbalancingrule)[]: Load balancing rules that are applied to the public load balancer of the cluster. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: Custom Network Security Rules that are applied to the Virtual Network of the cluster. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **serviceEndpoints**: [ServiceEndpoint](#serviceendpoint)[]: Service endpoints for subnets in the cluster. +* **subnetId**: string: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. +* **zonalResiliency**: bool: Indicates if the cluster has zone resiliency. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. +* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. + +## ManagedProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## NetworkSecurityRule ### Properties * **access**: 'allow' | 'deny' | string (Required): The network traffic is allowed or denied. @@ -176,169 +236,54 @@ * **sourcePortRange**: string: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. * **sourcePortRanges**: string[]: The source port ranges. -## ServiceEndpoint -### Properties -* **locations**: string[]: A list of locations. -* **service**: string (Required): The type of the endpoint service. - -## Sku -### Properties -* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: string: The type of identity that last modified the resource. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal id of the managed identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of the managed identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The type of managed identity for the resource. -* **userAssignedIdentities**: [UserAssignedIdentityMap](#userassignedidentitymap): The list of user 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}'. - -## UserAssignedIdentityMap -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client id of user assigned identity. -* **principalId**: string (ReadOnly): The principal id of user assigned identity. - -## ApplicationResourceProperties -### Properties -* **managedIdentities**: [ApplicationUserAssignedIdentity](#applicationuserassignedidentity)[]: List of user assigned identities for the application, each mapped to a friendly name. -* **parameters**: [ApplicationParameterList](#applicationparameterlist): List of application parameters with overridden values from their default values specified in the application manifest. -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **upgradePolicy**: [ApplicationUpgradePolicy](#applicationupgradepolicy): Describes the policy for a monitored application upgrade. -* **version**: string: The version of the application type as defined in the application manifest. -This name must be the full Arm Resource ID for the referenced application type version. - -## ApplicationUserAssignedIdentity -### Properties -* **name**: string (Required): The friendly name of user assigned identity. -* **principalId**: string (Required): The principal id of user assigned identity. - -## ApplicationParameterList -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ApplicationUpgradePolicy -### Properties -* **applicationHealthPolicy**: [ApplicationHealthPolicy](#applicationhealthpolicy): Defines a health policy used to evaluate the health of an application or one of its children entities. -* **forceRestart**: bool: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). -* **instanceCloseDelayDuration**: int: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. -* **recreateApplication**: bool: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. -* **rollingUpgradeMonitoringPolicy**: [RollingUpgradeMonitoringPolicy](#rollingupgrademonitoringpolicy): The policy used for monitoring the application upgrade -* **upgradeMode**: 'Monitored' | 'UnmonitoredAuto' | string: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. -* **upgradeReplicaSetCheckTimeout**: int: 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). - -## ApplicationHealthPolicy -### Properties -* **considerWarningAsError**: bool (Required): Indicates whether warnings are treated with the same severity as errors. -* **defaultServiceTypeHealthPolicy**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy): Represents the health policy used to evaluate the health of services belonging to a service type. -* **maxPercentUnhealthyDeployedApplications**: int (Required): 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. -* **serviceTypeHealthPolicyMap**: [ServiceTypeHealthPolicyMap](#servicetypehealthpolicymap): 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. - -## ServiceTypeHealthPolicy -### Properties -* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. - -The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. -If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. -The computation rounds up to tolerate one failure on small numbers of partitions. -* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. - -The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. -If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. -The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. -The computation rounds up to tolerate one failure on small numbers of replicas. -* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. - -The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. -If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. -This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. -The computation rounds up to tolerate one failure on small numbers of services. - -## ServiceTypeHealthPolicyMap -### Properties -### Additional Properties -* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) - -## RollingUpgradeMonitoringPolicy -### Properties -* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. -* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". -* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". - -## ProxyResourceTags +## NodeTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServiceResourceProperties -* **Discriminator**: serviceKind - -### Base Properties -* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. -* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. -* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. -* **placementConstraints**: 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)". -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response -* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. -* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. -* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package -* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. -* **serviceTypeName**: string (Required): The name of the service type -### StatefulServiceProperties -#### Properties -* **hasPersistedState**: bool: 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. -* **minReplicaSetSize**: int: The minimum replica set size as a number. -* **quorumLossWaitDuration**: 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". -* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". -* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). -* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". -* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". -* **targetReplicaSetSize**: int: The target replica set size as a number. +* **additionalDataDisks**: [VmssDataDisk](#vmssdatadisk)[]: Additional managed data disks. +* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. +* **dataDiskLetter**: string: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. +* **dataDiskSizeGB**: int: Disk size for the managed disk attached to the vms on the node type in GBs. +* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. +* **enableEncryptionAtHost**: bool: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. +* **enableOverProvisioning**: bool: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. +* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details +* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. +* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. +* **isSpotVM**: bool: Indicates whether the node type will be Spot Virtual Machines. Azure will allocate the VMs if there is capacity available and the VMs can be evicted at any time. +* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. +* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. +* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. +* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. +* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. +* **useDefaultPublicLoadBalancer**: bool: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. +* **useTempDataDisk**: bool: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. +* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. +* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. +* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. +* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. +* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. +* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. +* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. +* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. +* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. +* **zones**: string[]: Specifies the availability zones where the node type would span across. If the cluster is not spanning across availability zones, initiates az migration for the cluster. -### StatelessServiceProperties -#### Properties -* **instanceCount**: int (Required): The instance count. -* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. -* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). +## NodeTypePropertiesCapacities +### Properties +### Additional Properties +* **Additional Properties Type**: string +## NodeTypePropertiesPlacementProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ServiceCorrelation +## NodeTypeSku ### Properties -* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. -* **serviceName**: string (Required): The full ARM Resource ID describing the service resource +* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. +* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. +* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** ## Partition * **Discriminator**: partitionScheme @@ -363,10 +308,39 @@ should be split between the partition ‘Count’ * **partitionScheme**: 'UniformInt64Range' (Required): Specifies how the service is partitioned. -## ScalingPolicy +## ProxyResourceTags ### Properties -* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. -* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ProxyResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## RollingUpgradeMonitoringPolicy +### Properties +* **failureAction**: 'Manual' | 'Rollback' | string (Required): The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. +* **healthCheckRetryTimeout**: string (Required): The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckStableDuration**: string (Required): The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **healthCheckWaitDuration**: string (Required): The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeDomainTimeout**: string (Required): The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". +* **upgradeTimeout**: string (Required): The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ## ScalingMechanism * **Discriminator**: kind @@ -387,6 +361,11 @@ should be split between the partition ‘Count’ * **scaleIncrement**: int (Required): The number of instances to add or remove during a scaling operation. +## ScalingPolicy +### Properties +* **scalingMechanism**: [ScalingMechanism](#scalingmechanism) (Required): Describes the mechanism for performing a scaling operation. +* **scalingTrigger**: [ScalingTrigger](#scalingtrigger) (Required): Describes the trigger for performing a scaling operation. + ## ScalingTrigger * **Discriminator**: kind @@ -409,6 +388,16 @@ should be split between the partition ‘Count’ * **useOnlyPrimaryLoad**: bool (Required): Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. +## ServiceCorrelation +### Properties +* **scheme**: 'AlignedAffinity' | 'NonAlignedAffinity' | string (Required): The service correlation scheme. +* **serviceName**: string (Required): The full ARM Resource ID describing the service resource + +## ServiceEndpoint +### Properties +* **locations**: string[]: A list of locations. +* **service**: string (Required): The type of the endpoint service. + ## ServiceLoadMetric ### Properties * **defaultLoad**: int: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. @@ -446,90 +435,130 @@ should be split between the partition ‘Count’ * **type**: 'RequiredDomainDistribution' (Required): The type of placement policy for a service fabric service. Following are the possible values. -## ProxyResourceTags +## ServiceResourceProperties +* **Discriminator**: serviceKind + +### Base Properties +* **correlationScheme**: [ServiceCorrelation](#servicecorrelation)[]: A list that describes the correlation of the service with other services. +* **defaultMoveCost**: 'High' | 'Low' | 'Medium' | 'Zero' | string: Specifies the move cost for the service. +* **partitionDescription**: [Partition](#partition) (Required): Describes how the service is partitioned. +* **placementConstraints**: 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)". +* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **scalingPolicies**: [ScalingPolicy](#scalingpolicy)[]: Scaling policies for this service. +* **serviceLoadMetrics**: [ServiceLoadMetric](#serviceloadmetric)[]: The service load metrics is given as an array of ServiceLoadMetric objects. +* **servicePackageActivationMode**: 'ExclusiveProcess' | 'SharedProcess' | string: The activation Mode of the service package +* **servicePlacementPolicies**: [ServicePlacementPolicy](#serviceplacementpolicy)[]: A list that describes the correlation of the service with other services. +* **serviceTypeName**: string (Required): The name of the service type +### StatefulServiceProperties +#### Properties +* **hasPersistedState**: bool: 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. +* **minReplicaSetSize**: int: The minimum replica set size as a number. +* **quorumLossWaitDuration**: 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". +* **replicaRestartWaitDuration**: string: The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". +* **serviceKind**: 'Stateful' (Required): The kind of service (Stateless or Stateful). +* **servicePlacementTimeLimit**: string: The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". +* **standByReplicaKeepDuration**: string: The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". +* **targetReplicaSetSize**: int: The target replica set size as a number. + +### StatelessServiceProperties +#### Properties +* **instanceCount**: int (Required): The instance count. +* **minInstanceCount**: int: MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **minInstancePercentage**: int: MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. +* **serviceKind**: 'Stateless' (Required): The kind of service (Stateless or Stateful). + + +## ServiceTypeHealthPolicy +### Properties +* **maxPercentUnhealthyPartitionsPerService**: int (Required): The maximum allowed percentage of unhealthy partitions per service. + +The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. +If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. +The computation rounds up to tolerate one failure on small numbers of partitions. +* **maxPercentUnhealthyReplicasPerPartition**: int (Required): The maximum allowed percentage of unhealthy replicas per partition. + +The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. +If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. +The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. +The computation rounds up to tolerate one failure on small numbers of replicas. +* **maxPercentUnhealthyServices**: int (Required): The maximum allowed percentage of unhealthy services. + +The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. +If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. +This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. +The computation rounds up to tolerate one failure on small numbers of services. + +## ServiceTypeHealthPolicyMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ServiceTypeHealthPolicy](#servicetypehealthpolicy) -## ApplicationTypeResourceProperties +## SettingsParameterDescription ### Properties -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response. +* **name**: string (Required): The parameter name of fabric setting. +* **value**: string (Required): The parameter value of fabric setting. -## ProxyResourceTags +## SettingsSectionDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): The section name of the fabric settings. +* **parameters**: [SettingsParameterDescription](#settingsparameterdescription)[] (Required): The collection of parameters in the section. -## ApplicationTypeVersionResourceProperties +## Sku ### Properties -* **appPackageUrl**: string (Required): The URL to the application package -* **provisioningState**: string (ReadOnly): The current deployment or provisioning state, which only appears in the response +* **name**: 'Basic' | 'Standard' | string (Required): Sku Name. -## ProxyResourceTags +## Subnet ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enableIpv6**: bool: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. +* **name**: string (Required): Subnet name. +* **networkSecurityGroupId**: string: Full resource id for the network security group. +* **privateEndpointNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private end point in the subnet. +* **privateLinkServiceNetworkPolicies**: 'disabled' | 'enabled' | string: Enable or Disable apply network policies on private link service in the subnet. -## NodeTypeProperties +## SubResource ### Properties -* **additionalDataDisks**: [VmssDataDisk](#vmssdatadisk)[]: Additional managed data disks. -* **applicationPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **capacities**: [NodeTypePropertiesCapacities](#nodetypepropertiescapacities): 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. -* **dataDiskLetter**: string: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. -* **dataDiskSizeGB**: int: Disk size for the managed disk attached to the vms on the node type in GBs. -* **dataDiskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string: Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **enableAcceleratedNetworking**: bool: Specifies whether the network interface is accelerated networking-enabled. -* **enableEncryptionAtHost**: bool: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. -* **enableOverProvisioning**: bool: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. -* **ephemeralPorts**: [EndpointRangeDescription](#endpointrangedescription): Port range details -* **frontendConfigurations**: [FrontendConfiguration](#frontendconfiguration)[]: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. -* **isPrimary**: bool (Required): Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. -* **isSpotVM**: bool: Indicates whether the node type will be Spot Virtual Machines. Azure will allocate the VMs if there is capacity available and the VMs can be evicted at any time. -* **isStateless**: bool: Indicates if the node type can only host Stateless workloads. -* **multiplePlacementGroups**: bool: Indicates if scale set associated with the node type can be composed of multiple placement groups. -* **networkSecurityRules**: [NetworkSecurityRule](#networksecurityrule)[]: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. -* **placementProperties**: [NodeTypePropertiesPlacementProperties](#nodetypepropertiesplacementproperties): The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. -* **provisioningState**: 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'None' | 'Other' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state of the managed resource. -* **useDefaultPublicLoadBalancer**: bool: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. -* **useTempDataDisk**: bool: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. -* **vmExtensions**: [VmssExtension](#vmssextension)[]: Set of extensions that should be installed onto the virtual machines. -* **vmImageOffer**: string: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. -* **vmImagePublisher**: string: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. -* **vmImageSku**: string: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. -* **vmImageVersion**: string: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. -* **vmInstanceCount**: int (Required): The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale. -* **vmManagedIdentity**: [VmManagedIdentity](#vmmanagedidentity): Identities for the virtual machine scale set under the node type. -* **vmSecrets**: [VaultSecretGroup](#vaultsecretgroup)[]: The secrets to install in the virtual machines. -* **vmSize**: string: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. -* **zones**: string[]: Specifies the availability zones where the node type would span across. If the cluster is not spanning across availability zones, initiates az migration for the cluster. +* **id**: string: Azure resource identifier. -## VmssDataDisk +## SystemData ### Properties -* **diskLetter**: string (Required): Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. -* **diskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. -* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required): Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. -* **lun**: int (Required): 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 0 is reserved for the service fabric data disk. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: string: The type of identity that last modified the resource. -## EndpointRangeDescription +## UserAssignedIdentity ### Properties -* **endPort**: int (Required): End port of a range of ports -* **startPort**: int (Required): Starting port of a range of ports +* **clientId**: string (ReadOnly): The client id of user assigned identity. +* **principalId**: string (ReadOnly): The principal id of user assigned identity. -## NodeTypePropertiesCapacities +## UserAssignedIdentityMap ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## FrontendConfiguration +## VaultCertificate ### Properties -* **ipAddressType**: 'IPv4' | 'IPv6' | string: The IP address type. -* **loadBalancerBackendAddressPoolId**: string: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. -* **loadBalancerInboundNatPoolId**: string: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. +* **certificateStore**: string (Required): 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. +* **certificateUrl**: string (Required): 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":""
    } -## NodeTypePropertiesPlacementProperties +## VaultSecretGroup ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. +* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. + +## VmManagedIdentity +### Properties +* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +## VmssDataDisk +### Properties +* **diskLetter**: string (Required): Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. +* **diskSizeGB**: int (Required): Disk size for each vm in the node type in GBs. +* **diskType**: 'Premium_LRS' | 'StandardSSD_LRS' | 'Standard_LRS' | string (Required): Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. +* **lun**: int (Required): 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 0 is reserved for the service fabric data disk. ## VmssExtension ### Properties @@ -549,32 +578,3 @@ should be split between the partition ‘Count’ * **type**: string (Required): Specifies the type of the extension; an example is "CustomScriptExtension". * **typeHandlerVersion**: string (Required): Specifies the version of the script handler. -## VmManagedIdentity -### Properties -* **userAssignedIdentities**: string[]: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. - -## VaultSecretGroup -### Properties -* **sourceVault**: [SubResource](#subresource) (Required): Azure resource identifier. -* **vaultCertificates**: [VaultCertificate](#vaultcertificate)[] (Required): The list of key vault references in SourceVault which contain certificates. - -## SubResource -### Properties -* **id**: string: Azure resource identifier. - -## VaultCertificate -### Properties -* **certificateStore**: string (Required): 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. -* **certificateUrl**: string (Required): 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":""
    } - -## NodeTypeSku -### Properties -* **capacity**: int (Required): The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. -* **name**: string: The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. -* **tier**: string: Specifies the tier of the node type.

    Possible Values:
    **Standard** - -## ManagedProxyResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/servicefabricmesh/log.out b/generated/servicefabricmesh/log.out index d61ad41fce..9200b7e479 100644 --- a/generated/servicefabricmesh/log.out +++ b/generated/servicefabricmesh/log.out @@ -6,13 +6,13 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.servicefabricmesh-2018-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableOperationDisplay' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json:1781:5 @@ -137,13 +137,13 @@ warning | PreCheck/EmptyParentSchemaWarning | Schema 'AverageLoadScalingTrigger' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The schema 'AzureInternalMonitoringPipelineSinkDescription-fluentdConfigUrl' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#/components/schemas/AzureInternalMonitoringPipelineSinkDescription-fluentdConfigUrl -info | autorest.bicep took 18ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.servicefabricmesh-2018-07-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json:943:5 @@ -182,4 +182,4 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrackedResource' has a warning | Modeler/MissingType | The schema 'AzureInternalMonitoringPipelineSinkDescription-fluentdConfigUrl' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#/components/schemas/AzureInternalMonitoringPipelineSinkDescription-fluentdConfigUrl info | autorest.bicep took 4ms -info | Autorest completed in 9.23s. 4 files generated. +info | Autorest completed in 8.5s. 4 files generated. diff --git a/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.md b/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.md index 95192f8ced..92e849a184 100644 --- a/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.md +++ b/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-07-01-preview/types.md @@ -46,12 +46,68 @@ * **statusDetails**: string (ReadOnly): Gives additional information about the current status of the application deployment. * **unhealthyEvaluation**: string (ReadOnly): When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy. +## ContainerCodePackageProperties +### Properties +* **commands**: string[]: Command array to execute within the container in exec form. +* **diagnostics**: [DiagnosticsRef](#diagnosticsref): Reference to sinks in DiagnosticsDescription. +* **endpoints**: [EndpointProperties](#endpointproperties)[]: The endpoints exposed by this container. +* **entrypoint**: string: Override for the default entry point in the container. +* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to set in this container +* **image**: string (Required): The Container image to use. +* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Image registry credential. +* **instanceView**: [ContainerInstanceView](#containerinstanceview) (ReadOnly): Runtime information of a container instance. +* **labels**: [ContainerLabel](#containerlabel)[]: The labels to set in this container. +* **name**: string (Required): The name of the code package. +* **resources**: [ResourceRequirements](#resourcerequirements) (Required): This type describes the resource requirements for a container or a service. +* **settings**: [Setting](#setting)[]: The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". +* **volumeRefs**: [ContainerVolume](#containervolume)[]: The volumes to be attached to the container. + +## ContainerEvent +### Properties +* **count**: int: The count of the event. +* **firstTimestamp**: string: Date/time of the first event. +* **lastTimestamp**: string: Date/time of the last event. +* **message**: string: The event message +* **name**: string: The name of the container event. +* **type**: string: The event type. + +## ContainerInstanceView +### Properties +* **currentState**: [ContainerState](#containerstate): The container state. +* **events**: [ContainerEvent](#containerevent)[]: The events of this container instance. +* **previousState**: [ContainerState](#containerstate): The container state. +* **restartCount**: int: The number of times the container has been restarted. + +## ContainerLabel +### Properties +* **name**: string (Required): The name of the container label. +* **value**: string (Required): The value of the container label. + +## ContainerState +### Properties +* **detailStatus**: string: Human-readable status of this state. +* **exitCode**: string: The container exit code. +* **finishTime**: string: Date/time when the container state finished. +* **startTime**: string: Date/time when the container state started. +* **state**: string: The state of this container + +## ContainerVolume +### Properties +* **destinationPath**: string (Required): The path within the container at which the volume should be mounted. Only valid path characters are allowed. +* **name**: string (Required): Name of the volume. +* **readOnly**: bool: The flag indicating whether the volume is read only. Default is 'false'. + ## DiagnosticsDescription ### Properties * **defaultSinkRefs**: string[]: The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. * **enabled**: bool: Status of whether or not sinks are enabled. * **sinks**: [DiagnosticsSinkProperties](#diagnosticssinkproperties)[]: List of supported sinks that can be referenced. +## DiagnosticsRef +### Properties +* **enabled**: bool: Status of whether or not sinks are enabled. +* **sinkRefs**: string[]: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. + ## DiagnosticsSinkProperties * **Discriminator**: kind @@ -68,45 +124,6 @@ * **namespace**: string: Azure Internal monitoring pipeline account namespace. -## ServiceResourceDescription -### Properties -* **id**: string (ReadOnly): Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string: The name of the resource -* **properties**: [ServiceResourceProperties](#serviceresourceproperties) (Required): This type describes properties of a service resource. -* **type**: string (ReadOnly): The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. - -## ServiceResourceProperties -### Properties -* **codePackages**: [ContainerCodePackageProperties](#containercodepackageproperties)[] (Required): Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). -* **description**: string: User readable description of the service. -* **diagnostics**: [DiagnosticsRef](#diagnosticsref): Reference to sinks in DiagnosticsDescription. -* **healthState**: 'Error' | 'Invalid' | 'Ok' | 'Unknown' | 'Warning' | string: The health state of a resource such as Application, Service, or Network. -* **networkRefs**: [NetworkRef](#networkref)[]: The names of the private networks that this service needs to be part of. -* **osType**: 'Linux' | 'Windows' | string (Required): The Operating system type required by the code in service. -* **replicaCount**: int: The number of replicas of the service to create. Defaults to 1 if not specified. -* **status**: 'Active' | 'Creating' | 'Deleting' | 'Failed' | 'Unknown' | 'Upgrading' | string (ReadOnly): Represents the status of the service. - -## ContainerCodePackageProperties -### Properties -* **commands**: string[]: Command array to execute within the container in exec form. -* **diagnostics**: [DiagnosticsRef](#diagnosticsref): Reference to sinks in DiagnosticsDescription. -* **endpoints**: [EndpointProperties](#endpointproperties)[]: The endpoints exposed by this container. -* **entrypoint**: string: Override for the default entry point in the container. -* **environmentVariables**: [EnvironmentVariable](#environmentvariable)[]: The environment variables to set in this container -* **image**: string (Required): The Container image to use. -* **imageRegistryCredential**: [ImageRegistryCredential](#imageregistrycredential): Image registry credential. -* **instanceView**: [ContainerInstanceView](#containerinstanceview) (ReadOnly): Runtime information of a container instance. -* **labels**: [ContainerLabel](#containerlabel)[]: The labels to set in this container. -* **name**: string (Required): The name of the code package. -* **resources**: [ResourceRequirements](#resourcerequirements) (Required): This type describes the resource requirements for a container or a service. -* **settings**: [Setting](#setting)[]: The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". -* **volumeRefs**: [ContainerVolume](#containervolume)[]: The volumes to be attached to the container. - -## DiagnosticsRef -### Properties -* **enabled**: bool: Status of whether or not sinks are enabled. -* **sinkRefs**: string[]: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. - ## EndpointProperties ### Properties * **name**: string (Required): The name of the endpoint. @@ -123,39 +140,30 @@ * **server**: string (Required): Docker image registry server, without protocol such as `http` and `https`. * **username**: string (Required): The username for the private registry. -## ContainerInstanceView -### Properties -* **currentState**: [ContainerState](#containerstate): The container state. -* **events**: [ContainerEvent](#containerevent)[]: The events of this container instance. -* **previousState**: [ContainerState](#containerstate): The container state. -* **restartCount**: int: The number of times the container has been restarted. - -## ContainerState +## IngressConfig ### Properties -* **detailStatus**: string: Human-readable status of this state. -* **exitCode**: string: The container exit code. -* **finishTime**: string: Date/time when the container state finished. -* **startTime**: string: Date/time when the container state started. -* **state**: string: The state of this container +* **layer4**: [Layer4IngressConfig](#layer4ingressconfig)[]: Configuration for layer4 public connectivity for this network. +* **publicIPAddress**: string (ReadOnly): The public IP address for reaching this network. +* **qosLevel**: 'Bronze' | string: The QoS tier for ingress. -## ContainerEvent +## Layer4IngressConfig ### Properties -* **count**: int: The count of the event. -* **firstTimestamp**: string: Date/time of the first event. -* **lastTimestamp**: string: Date/time of the last event. -* **message**: string: The event message -* **name**: string: The name of the container event. -* **type**: string: The event type. +* **applicationName**: string: The application name which contains the service to be exposed. +* **endpointName**: string: The service endpoint that needs to be exposed. +* **name**: string: Layer4 ingress config name. +* **publicPort**: int: Specifies the public port at which the service endpoint below needs to be exposed. +* **serviceName**: string: The service whose endpoint needs to be exposed at the public port. -## ContainerLabel +## NetworkRef ### Properties -* **name**: string (Required): The name of the container label. -* **value**: string (Required): The value of the container label. +* **name**: string: Name of the network. -## ResourceRequirements +## NetworkResourceProperties ### Properties -* **limits**: [ResourceLimits](#resourcelimits): This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. -* **requests**: [ResourceRequests](#resourcerequests) (Required): This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. +* **addressPrefix**: string (Required): the address prefix for this network. +* **description**: string: User readable description of the network. +* **ingressConfig**: [IngressConfig](#ingressconfig): Describes public connectivity configuration for the network. +* **provisioningState**: string (ReadOnly): State of the resource. ## ResourceLimits ### Properties @@ -167,58 +175,48 @@ * **cpu**: int (Required): Requested number of CPU cores. At present, only full cores are supported. * **memoryInGB**: int (Required): The memory request in GB for this container. -## Setting +## ResourceRequirements ### Properties -* **name**: string: The name of the setting. -* **value**: string: The value of the setting. +* **limits**: [ResourceLimits](#resourcelimits): This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. +* **requests**: [ResourceRequests](#resourcerequests) (Required): This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. -## ContainerVolume +## ServiceResourceDescription ### Properties -* **destinationPath**: string (Required): The path within the container at which the volume should be mounted. Only valid path characters are allowed. -* **name**: string (Required): Name of the volume. -* **readOnly**: bool: The flag indicating whether the volume is read only. Default is 'false'. +* **id**: string (ReadOnly): Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string: The name of the resource +* **properties**: [ServiceResourceProperties](#serviceresourceproperties) (Required): This type describes properties of a service resource. +* **type**: string (ReadOnly): The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. -## NetworkRef +## ServiceResourceProperties ### Properties -* **name**: string: Name of the network. +* **codePackages**: [ContainerCodePackageProperties](#containercodepackageproperties)[] (Required): Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). +* **description**: string: User readable description of the service. +* **diagnostics**: [DiagnosticsRef](#diagnosticsref): Reference to sinks in DiagnosticsDescription. +* **healthState**: 'Error' | 'Invalid' | 'Ok' | 'Unknown' | 'Warning' | string: The health state of a resource such as Application, Service, or Network. +* **networkRefs**: [NetworkRef](#networkref)[]: The names of the private networks that this service needs to be part of. +* **osType**: 'Linux' | 'Windows' | string (Required): The Operating system type required by the code in service. +* **replicaCount**: int: The number of replicas of the service to create. Defaults to 1 if not specified. +* **status**: 'Active' | 'Creating' | 'Deleting' | 'Failed' | 'Unknown' | 'Upgrading' | string (ReadOnly): Represents the status of the service. + +## Setting +### Properties +* **name**: string: The name of the setting. +* **value**: string: The value of the setting. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## NetworkResourceProperties -### Properties -* **addressPrefix**: string (Required): the address prefix for this network. -* **description**: string: User readable description of the network. -* **ingressConfig**: [IngressConfig](#ingressconfig): Describes public connectivity configuration for the network. -* **provisioningState**: string (ReadOnly): State of the resource. - -## IngressConfig -### Properties -* **layer4**: [Layer4IngressConfig](#layer4ingressconfig)[]: Configuration for layer4 public connectivity for this network. -* **publicIPAddress**: string (ReadOnly): The public IP address for reaching this network. -* **qosLevel**: 'Bronze' | string: The QoS tier for ingress. - -## Layer4IngressConfig -### Properties -* **applicationName**: string: The application name which contains the service to be exposed. -* **endpointName**: string: The service endpoint that needs to be exposed. -* **name**: string: Layer4 ingress config name. -* **publicPort**: int: Specifies the public port at which the service endpoint below needs to be exposed. -* **serviceName**: string: The service whose endpoint needs to be exposed at the public port. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VolumeResourceProperties +## TrackedResourceTags ### Properties -* **azureFileParameters**: [VolumeProviderParametersAzureFile](#volumeproviderparametersazurefile): This type describes a volume provided by an Azure Files file share. -* **description**: string: User readable description of the volume. -* **provider**: 'SFAzureFile' | string (Required): Provider of the volume. -* **provisioningState**: string (ReadOnly): State of the resource. +### Additional Properties +* **Additional Properties Type**: string ## VolumeProviderParametersAzureFile ### Properties @@ -226,8 +224,10 @@ * **accountName**: string (Required): Name of the Azure storage account for the File Share. * **shareName**: string (Required): Name of the Azure Files file share that provides storage for the volume. -## TrackedResourceTags +## VolumeResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFileParameters**: [VolumeProviderParametersAzureFile](#volumeproviderparametersazurefile): This type describes a volume provided by an Azure Files file share. +* **description**: string: User readable description of the volume. +* **provider**: 'SFAzureFile' | string (Required): Provider of the volume. +* **provisioningState**: string (ReadOnly): State of the resource. diff --git a/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.md b/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.md index 249629a4ff..915d06d427 100644 --- a/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.md +++ b/generated/servicefabricmesh/microsoft.servicefabricmesh/2018-09-01-preview/types.md @@ -84,55 +84,23 @@ * **statusDetails**: string (ReadOnly): Gives additional information about the current status of the application. * **unhealthyEvaluation**: string (ReadOnly): When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy. -## DiagnosticsDescription +## ApplicationScopedVolume ### Properties -* **defaultSinkRefs**: string[]: The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. -* **enabled**: bool: Status of whether or not sinks are enabled. -* **sinks**: [DiagnosticsSinkProperties](#diagnosticssinkproperties)[]: List of supported sinks that can be referenced. +* **creationParameters**: [ApplicationScopedVolumeCreationParameters](#applicationscopedvolumecreationparameters) (Required): Describes parameters for creating application-scoped volumes. +* **destinationPath**: string (Required): The path within the container at which the volume should be mounted. Only valid path characters are allowed. +* **name**: string (Required): Name of the volume being referenced. +* **readOnly**: bool: The flag indicating whether the volume is read only. Default is 'false'. -## DiagnosticsSinkProperties +## ApplicationScopedVolumeCreationParameters * **Discriminator**: kind ### Base Properties -* **description**: string: A description of the sink. -* **name**: string: Name of the sink. This value is referenced by DiagnosticsReferenceDescription -### AzureInternalMonitoringPipelineSinkDescription +* **description**: string: User readable description of the volume. +### ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk #### Properties -* **accountName**: string: Azure Internal monitoring pipeline account. -* **autoKeyConfigUrl**: string: Azure Internal monitoring pipeline autokey associated with the certificate. -* **fluentdConfigUrl**: any: Anything -* **kind**: 'AzureInternalMonitoringPipeline' (Required): The kind of DiagnosticsSink. -* **maConfigUrl**: string: Azure Internal monitoring agent configuration. -* **namespace**: string: Azure Internal monitoring pipeline account namespace. - - -## ServiceResourceDescription -### Properties -* **id**: string (ReadOnly): Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string: The name of the resource -* **properties**: [ServiceResourceProperties](#serviceresourceproperties) (Required): This type describes properties of a service resource. -* **type**: string (ReadOnly): The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. - -## ServiceResourceProperties -### Properties -* **autoScalingPolicies**: [AutoScalingPolicy](#autoscalingpolicy)[]: Auto scaling policies -* **codePackages**: [ContainerCodePackageProperties](#containercodepackageproperties)[] (Required): Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). -* **description**: string: User readable description of the service. -* **diagnostics**: [DiagnosticsRef](#diagnosticsref): Reference to sinks in DiagnosticsDescription. -* **healthState**: 'Error' | 'Invalid' | 'Ok' | 'Unknown' | 'Warning' | string (ReadOnly): The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. -* **networkRefs**: [NetworkRef](#networkref)[]: The names of the private networks that this service needs to be part of. -* **osType**: 'Linux' | 'Windows' | string (Required): The operation system required by the code in service. -* **provisioningState**: string (ReadOnly): State of the resource. -* **replicaCount**: int: The number of replicas of the service to create. Defaults to 1 if not specified. -* **status**: 'Creating' | 'Deleting' | 'Failed' | 'Ready' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the resource. -* **statusDetails**: string (ReadOnly): Gives additional information about the current status of the service. -* **unhealthyEvaluation**: string (ReadOnly): When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. +* **kind**: 'ServiceFabricVolumeDisk' (Required): Specifies the application-scoped volume kind. +* **sizeDisk**: 'Large' | 'Medium' | 'Small' | string (Required): Volume size -## AutoScalingPolicy -### Properties -* **mechanism**: [AutoScalingMechanism](#autoscalingmechanism) (Required): Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism. -* **name**: string (Required): The name of the auto scaling policy. -* **trigger**: [AutoScalingTrigger](#autoscalingtrigger) (Required): Describes the trigger for performing auto scaling operation. ## AutoScalingMechanism * **Discriminator**: kind @@ -146,6 +114,22 @@ * **scaleIncrement**: int (Required): Each time auto scaling is performed, this number of containers will be added or removed. +## AutoScalingMetric +* **Discriminator**: kind + +### Base Properties +### AutoScalingResourceMetric +#### Properties +* **kind**: 'Resource' (Required): The type of auto scaling metric +* **name**: 'cpu' | 'memoryInGB' | string (Required): Enumerates the resources that are used for triggering auto scaling. + + +## AutoScalingPolicy +### Properties +* **mechanism**: [AutoScalingMechanism](#autoscalingmechanism) (Required): Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism. +* **name**: string (Required): The name of the auto scaling policy. +* **trigger**: [AutoScalingTrigger](#autoscalingtrigger) (Required): Describes the trigger for performing auto scaling operation. + ## AutoScalingTrigger * **Discriminator**: kind @@ -159,16 +143,6 @@ * **upperLoadThreshold**: int (Required): Upper load threshold (if average load is above this threshold, service will scale up). -## AutoScalingMetric -* **Discriminator**: kind - -### Base Properties -### AutoScalingResourceMetric -#### Properties -* **kind**: 'Resource' (Required): The type of auto scaling metric -* **name**: 'cpu' | 'memoryInGB' | string (Required): Enumerates the resources that are used for triggering auto scaling. - - ## ContainerCodePackageProperties ### Properties * **commands**: string[]: Command array to execute within the container in exec form. @@ -187,26 +161,14 @@ * **volumeRefs**: [VolumeReference](#volumereference)[]: Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime. * **volumes**: [ApplicationScopedVolume](#applicationscopedvolume)[]: Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime. -## DiagnosticsRef -### Properties -* **enabled**: bool: Status of whether or not sinks are enabled. -* **sinkRefs**: string[]: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. - -## EndpointProperties -### Properties -* **name**: string (Required): The name of the endpoint. -* **port**: int: Port used by the container. - -## EnvironmentVariable -### Properties -* **name**: string: The name of the environment variable. -* **value**: string: The value of the environment variable. - -## ImageRegistryCredential +## ContainerEvent ### Properties -* **password**: string: The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. -* **server**: string (Required): Docker image registry server, without protocol such as `http` and `https`. -* **username**: string (Required): The username for the private registry. +* **count**: int: The count of the event. +* **firstTimestamp**: string: Date/time of the first event. +* **lastTimestamp**: string: Date/time of the last event. +* **message**: string: The event message +* **name**: string: The name of the container event. +* **type**: string: The event type. ## ContainerInstanceView ### Properties @@ -215,6 +177,11 @@ * **previousState**: [ContainerState](#containerstate): The container state. * **restartCount**: int: The number of times the container has been restarted. +## ContainerLabel +### Properties +* **name**: string (Required): The name of the container label. +* **value**: string (Required): The value of the container label. + ## ContainerState ### Properties * **detailStatus**: string: Human-readable status of this state. @@ -223,82 +190,52 @@ * **startTime**: string: Date/time when the container state started. * **state**: string: The state of this container -## ContainerEvent -### Properties -* **count**: int: The count of the event. -* **firstTimestamp**: string: Date/time of the first event. -* **lastTimestamp**: string: Date/time of the last event. -* **message**: string: The event message -* **name**: string: The name of the container event. -* **type**: string: The event type. - -## ContainerLabel -### Properties -* **name**: string (Required): The name of the container label. -* **value**: string (Required): The value of the container label. - -## ReliableCollectionsRef -### Properties -* **doNotPersistState**: bool: False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache. -* **name**: string (Required): Name of ReliableCollection resource. Right now it's not used and you can use any string. - -## ResourceRequirements -### Properties -* **limits**: [ResourceLimits](#resourcelimits): This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. -* **requests**: [ResourceRequests](#resourcerequests) (Required): This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. - -## ResourceLimits -### Properties -* **cpu**: int: CPU limits in cores. At present, only full cores are supported. -* **memoryInGB**: int: The memory limit in GB. - -## ResourceRequests -### Properties -* **cpu**: int (Required): Requested number of CPU cores. At present, only full cores are supported. -* **memoryInGB**: int (Required): The memory request in GB for this container. - -## Setting -### Properties -* **name**: string: The name of the setting. -* **value**: string: The value of the setting. - -## VolumeReference +## DiagnosticsDescription ### Properties -* **destinationPath**: string (Required): The path within the container at which the volume should be mounted. Only valid path characters are allowed. -* **name**: string (Required): Name of the volume being referenced. -* **readOnly**: bool: The flag indicating whether the volume is read only. Default is 'false'. +* **defaultSinkRefs**: string[]: The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. +* **enabled**: bool: Status of whether or not sinks are enabled. +* **sinks**: [DiagnosticsSinkProperties](#diagnosticssinkproperties)[]: List of supported sinks that can be referenced. -## ApplicationScopedVolume +## DiagnosticsRef ### Properties -* **creationParameters**: [ApplicationScopedVolumeCreationParameters](#applicationscopedvolumecreationparameters) (Required): Describes parameters for creating application-scoped volumes. -* **destinationPath**: string (Required): The path within the container at which the volume should be mounted. Only valid path characters are allowed. -* **name**: string (Required): Name of the volume being referenced. -* **readOnly**: bool: The flag indicating whether the volume is read only. Default is 'false'. +* **enabled**: bool: Status of whether or not sinks are enabled. +* **sinkRefs**: string[]: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. -## ApplicationScopedVolumeCreationParameters +## DiagnosticsSinkProperties * **Discriminator**: kind ### Base Properties -* **description**: string: User readable description of the volume. -### ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk +* **description**: string: A description of the sink. +* **name**: string: Name of the sink. This value is referenced by DiagnosticsReferenceDescription +### AzureInternalMonitoringPipelineSinkDescription #### Properties -* **kind**: 'ServiceFabricVolumeDisk' (Required): Specifies the application-scoped volume kind. -* **sizeDisk**: 'Large' | 'Medium' | 'Small' | string (Required): Volume size +* **accountName**: string: Azure Internal monitoring pipeline account. +* **autoKeyConfigUrl**: string: Azure Internal monitoring pipeline autokey associated with the certificate. +* **fluentdConfigUrl**: any: Anything +* **kind**: 'AzureInternalMonitoringPipeline' (Required): The kind of DiagnosticsSink. +* **maConfigUrl**: string: Azure Internal monitoring agent configuration. +* **namespace**: string: Azure Internal monitoring pipeline account namespace. -## NetworkRef +## EndpointProperties ### Properties -* **endpointRefs**: [EndpointRef](#endpointref)[]: A list of endpoints that are exposed on this network. -* **name**: string: Name of the network +* **name**: string (Required): The name of the endpoint. +* **port**: int: Port used by the container. ## EndpointRef ### Properties * **name**: string: Name of the endpoint. -## TrackedResourceTags +## EnvironmentVariable ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name of the environment variable. +* **value**: string: The value of the environment variable. + +## GatewayDestination +### Properties +* **applicationName**: string (Required): Name of the service fabric Mesh application. +* **endpointName**: string (Required): name of the endpoint in the service. +* **serviceName**: string (Required): service that contains the endpoint. ## GatewayResourceProperties ### Properties @@ -329,17 +266,6 @@ * **match**: [HttpRouteMatchRule](#httproutematchrule) (Required): Describes a rule for http route matching. * **name**: string (Required): http route name. -## GatewayDestination -### Properties -* **applicationName**: string (Required): Name of the service fabric Mesh application. -* **endpointName**: string (Required): name of the endpoint in the service. -* **serviceName**: string (Required): service that contains the endpoint. - -## HttpRouteMatchRule -### Properties -* **headers**: [HttpRouteMatchHeader](#httproutematchheader)[]: headers and their values to match in request. -* **path**: [HttpRouteMatchPath](#httproutematchpath) (Required): Path to match for routing. - ## HttpRouteMatchHeader ### Properties * **name**: string (Required): Name of header to match in request. @@ -352,16 +278,21 @@ * **type**: 'prefix' | string (Required): how to match value in the Uri * **value**: string (Required): Uri path to match for request. -## TcpConfig +## HttpRouteMatchRule ### Properties -* **destination**: [GatewayDestination](#gatewaydestination) (Required): Describes destination endpoint for routing traffic. -* **name**: string (Required): tcp gateway config name. -* **port**: int (Required): Specifies the port at which the service endpoint below needs to be exposed. +* **headers**: [HttpRouteMatchHeader](#httproutematchheader)[]: headers and their values to match in request. +* **path**: [HttpRouteMatchPath](#httproutematchpath) (Required): Path to match for routing. -## TrackedResourceTags +## ImageRegistryCredential ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: string: The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. +* **server**: string (Required): Docker image registry server, without protocol such as `http` and `https`. +* **username**: string (Required): The username for the private registry. + +## NetworkRef +### Properties +* **endpointRefs**: [EndpointRef](#endpointref)[]: A list of endpoints that are exposed on this network. +* **name**: string: Name of the network ## NetworkResourceProperties * **Discriminator**: kind @@ -377,10 +308,25 @@ * **networkAddressPrefix**: string: Address space for a container network. This is expressed in CIDR notation. -## TrackedResourceTags +## ReliableCollectionsRef ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **doNotPersistState**: bool: False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache. +* **name**: string (Required): Name of ReliableCollection resource. Right now it's not used and you can use any string. + +## ResourceLimits +### Properties +* **cpu**: int: CPU limits in cores. At present, only full cores are supported. +* **memoryInGB**: int: The memory limit in GB. + +## ResourceRequests +### Properties +* **cpu**: int (Required): Requested number of CPU cores. At present, only full cores are supported. +* **memoryInGB**: int (Required): The memory request in GB for this container. + +## ResourceRequirements +### Properties +* **limits**: [ResourceLimits](#resourcelimits): This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. +* **requests**: [ResourceRequests](#resourcerequests) (Required): This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. ## SecretResourceProperties * **Discriminator**: kind @@ -396,29 +342,77 @@ * **kind**: 'inlinedValue' (Required): Describes the kind of secret. -## TrackedResourceTags +## SecretValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **value**: string (ReadOnly): The actual value of the secret. ## SecretValueResourceProperties ### Properties * **provisioningState**: string (ReadOnly): State of the resource. * **value**: string: The actual value of the secret. +## ServiceResourceDescription +### Properties +* **id**: string (ReadOnly): Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string: The name of the resource +* **properties**: [ServiceResourceProperties](#serviceresourceproperties) (Required): This type describes properties of a service resource. +* **type**: string (ReadOnly): The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. + +## ServiceResourceProperties +### Properties +* **autoScalingPolicies**: [AutoScalingPolicy](#autoscalingpolicy)[]: Auto scaling policies +* **codePackages**: [ContainerCodePackageProperties](#containercodepackageproperties)[] (Required): Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). +* **description**: string: User readable description of the service. +* **diagnostics**: [DiagnosticsRef](#diagnosticsref): Reference to sinks in DiagnosticsDescription. +* **healthState**: 'Error' | 'Invalid' | 'Ok' | 'Unknown' | 'Warning' | string (ReadOnly): The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. +* **networkRefs**: [NetworkRef](#networkref)[]: The names of the private networks that this service needs to be part of. +* **osType**: 'Linux' | 'Windows' | string (Required): The operation system required by the code in service. +* **provisioningState**: string (ReadOnly): State of the resource. +* **replicaCount**: int: The number of replicas of the service to create. Defaults to 1 if not specified. +* **status**: 'Creating' | 'Deleting' | 'Failed' | 'Ready' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the resource. +* **statusDetails**: string (ReadOnly): Gives additional information about the current status of the service. +* **unhealthyEvaluation**: string (ReadOnly): When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. + +## Setting +### Properties +* **name**: string: The name of the setting. +* **value**: string: The value of the setting. + +## TcpConfig +### Properties +* **destination**: [GatewayDestination](#gatewaydestination) (Required): Describes destination endpoint for routing traffic. +* **name**: string (Required): tcp gateway config name. +* **port**: int (Required): Specifies the port at which the service endpoint below needs to be exposed. + ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VolumeResourceProperties +## TrackedResourceTags ### Properties -* **azureFileParameters**: [VolumeProviderParametersAzureFile](#volumeproviderparametersazurefile): This type describes a volume provided by an Azure Files file share. -* **description**: string: User readable description of the volume. -* **provider**: 'SFAzureFile' | string (Required): Describes the provider of the volume resource. -* **provisioningState**: string (ReadOnly): State of the resource. -* **status**: 'Creating' | 'Deleting' | 'Failed' | 'Ready' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the resource. -* **statusDetails**: string (ReadOnly): Gives additional information about the current status of the volume. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## VolumeProviderParametersAzureFile ### Properties @@ -426,12 +420,18 @@ * **accountName**: string (Required): Name of the Azure storage account for the File Share. * **shareName**: string (Required): Name of the Azure Files file share that provides storage for the volume. -## TrackedResourceTags +## VolumeReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **destinationPath**: string (Required): The path within the container at which the volume should be mounted. Only valid path characters are allowed. +* **name**: string (Required): Name of the volume being referenced. +* **readOnly**: bool: The flag indicating whether the volume is read only. Default is 'false'. -## SecretValue +## VolumeResourceProperties ### Properties -* **value**: string (ReadOnly): The actual value of the secret. +* **azureFileParameters**: [VolumeProviderParametersAzureFile](#volumeproviderparametersazurefile): This type describes a volume provided by an Azure Files file share. +* **description**: string: User readable description of the volume. +* **provider**: 'SFAzureFile' | string (Required): Describes the provider of the volume resource. +* **provisioningState**: string (ReadOnly): State of the resource. +* **status**: 'Creating' | 'Deleting' | 'Failed' | 'Ready' | 'Unknown' | 'Upgrading' | string (ReadOnly): Status of the resource. +* **statusDetails**: string (ReadOnly): Gives additional information about the current status of the volume. diff --git a/generated/servicelinker/log.out b/generated/servicelinker/log.out index a14f6a3a09..cbe0070a3e 100644 --- a/generated/servicelinker/log.out +++ b/generated/servicelinker/log.out @@ -4,26 +4,26 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.servicelinker-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.servicelinker-2022-01-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.servicelinker-2022-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 8.12s. 6 files generated. +info | Autorest completed in 7.67s. 6 files generated. diff --git a/generated/servicelinker/microsoft.servicelinker/2021-11-01-preview/types.md b/generated/servicelinker/microsoft.servicelinker/2021-11-01-preview/types.md index 2e7dd556dc..10533c75b0 100644 --- a/generated/servicelinker/microsoft.servicelinker/2021-11-01-preview/types.md +++ b/generated/servicelinker/microsoft.servicelinker/2021-11-01-preview/types.md @@ -15,15 +15,6 @@ * **ApiVersion**: 2021-11-01-preview * **Output**: [SourceConfigurationResult](#sourceconfigurationresult) -## LinkerProperties -### Properties -* **authInfo**: [AuthInfoBase](#authinfobase): The authentication info -* **clientType**: 'django' | 'dotnet' | 'go' | 'java' | 'nodejs' | 'none' | 'php' | 'python' | 'ruby' | 'springBoot' | string: The application client type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **secretStore**: [SecretStore](#secretstore): An option to store secret value in secure place -* **targetId**: string: The resource Id of target service. -* **vNetSolution**: [VNetSolution](#vnetsolution): The VNet solution for linker - ## AuthInfoBase * **Discriminator**: authType @@ -59,13 +50,27 @@ * **subscriptionId**: string (Required): Subscription id for userAssignedIdentity. +## LinkerProperties +### Properties +* **authInfo**: [AuthInfoBase](#authinfobase): The authentication info +* **clientType**: 'django' | 'dotnet' | 'go' | 'java' | 'nodejs' | 'none' | 'php' | 'python' | 'ruby' | 'springBoot' | string: The application client type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **secretStore**: [SecretStore](#secretstore): An option to store secret value in secure place +* **targetId**: string: The resource Id of target service. +* **vNetSolution**: [VNetSolution](#vnetsolution): The VNet solution for linker + ## SecretStore ### Properties * **keyVaultId**: string: The key vault id to store secret -## VNetSolution +## SourceConfiguration ### Properties -* **type**: 'privateLink' | 'serviceEndpoint' | string: Type of VNet solution. +* **name**: string (ReadOnly): The name of setting. +* **value**: string (ReadOnly): The value of setting + +## SourceConfigurationResult +### Properties +* **configurations**: [SourceConfiguration](#sourceconfiguration)[] (ReadOnly): The configuration properties for source resource. ## SystemData ### Properties @@ -76,12 +81,7 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## SourceConfigurationResult -### Properties -* **configurations**: [SourceConfiguration](#sourceconfiguration)[] (ReadOnly): The configuration properties for source resource. - -## SourceConfiguration +## VNetSolution ### Properties -* **name**: string (ReadOnly): The name of setting. -* **value**: string (ReadOnly): The value of setting +* **type**: 'privateLink' | 'serviceEndpoint' | string: Type of VNet solution. diff --git a/generated/servicelinker/microsoft.servicelinker/2022-01-01-preview/types.md b/generated/servicelinker/microsoft.servicelinker/2022-01-01-preview/types.md index 6e54edf592..e819959114 100644 --- a/generated/servicelinker/microsoft.servicelinker/2022-01-01-preview/types.md +++ b/generated/servicelinker/microsoft.servicelinker/2022-01-01-preview/types.md @@ -15,16 +15,6 @@ * **ApiVersion**: 2022-01-01-preview * **Output**: [SourceConfigurationResult](#sourceconfigurationresult) -## LinkerProperties -### Properties -* **authInfo**: [AuthInfoBase](#authinfobase): The authentication info -* **clientType**: 'django' | 'dotnet' | 'go' | 'java' | 'nodejs' | 'none' | 'php' | 'python' | 'ruby' | 'springBoot' | string: The application client type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **scope**: string: connection scope in source service. -* **secretStore**: [SecretStore](#secretstore): An option to store secret value in secure place -* **targetService**: [TargetServiceBase](#targetservicebase): The target service properties -* **vNetSolution**: [VNetSolution](#vnetsolution): The VNet solution for linker - ## AuthInfoBase * **Discriminator**: authType @@ -60,6 +50,26 @@ * **subscriptionId**: string: Subscription id for userAssignedIdentity. +## AzureResourcePropertiesBase +* **Discriminator**: type + +### Base Properties +### AzureKeyVaultProperties +#### Properties +* **connectAsKubernetesCsiDriver**: bool: True if connect via Kubernetes CSI Driver. +* **type**: 'KeyVault' (Required): The azure resource type. + + +## LinkerProperties +### Properties +* **authInfo**: [AuthInfoBase](#authinfobase): The authentication info +* **clientType**: 'django' | 'dotnet' | 'go' | 'java' | 'nodejs' | 'none' | 'php' | 'python' | 'ruby' | 'springBoot' | string: The application client type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **scope**: string: connection scope in source service. +* **secretStore**: [SecretStore](#secretstore): An option to store secret value in secure place +* **targetService**: [TargetServiceBase](#targetservicebase): The target service properties +* **vNetSolution**: [VNetSolution](#vnetsolution): The VNet solution for linker + ## SecretInfoBase * **Discriminator**: secretType @@ -85,6 +95,24 @@ ### Properties * **keyVaultId**: string: The key vault id to store secret +## SourceConfiguration +### Properties +* **name**: string (ReadOnly): The name of setting. +* **value**: string (ReadOnly): The value of setting + +## SourceConfigurationResult +### Properties +* **configurations**: [SourceConfiguration](#sourceconfiguration)[] (ReadOnly): The configuration properties for source resource. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TargetServiceBase * **Discriminator**: type @@ -106,35 +134,7 @@ * **type**: 'ConfluentSchemaRegistry' (Required): The target service type. -## AzureResourcePropertiesBase -* **Discriminator**: type - -### Base Properties -### AzureKeyVaultProperties -#### Properties -* **connectAsKubernetesCsiDriver**: bool: True if connect via Kubernetes CSI Driver. -* **type**: 'KeyVault' (Required): The azure resource type. - - ## VNetSolution ### Properties * **type**: 'privateLink' | 'serviceEndpoint' | string: Type of VNet solution. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## SourceConfigurationResult -### Properties -* **configurations**: [SourceConfiguration](#sourceconfiguration)[] (ReadOnly): The configuration properties for source resource. - -## SourceConfiguration -### Properties -* **name**: string (ReadOnly): The name of setting. -* **value**: string (ReadOnly): The value of setting - diff --git a/generated/servicelinker/microsoft.servicelinker/2022-05-01/types.md b/generated/servicelinker/microsoft.servicelinker/2022-05-01/types.md index 84dcc20807..674566c878 100644 --- a/generated/servicelinker/microsoft.servicelinker/2022-05-01/types.md +++ b/generated/servicelinker/microsoft.servicelinker/2022-05-01/types.md @@ -15,16 +15,6 @@ * **ApiVersion**: 2022-05-01 * **Output**: [SourceConfigurationResult](#sourceconfigurationresult) -## LinkerProperties -### Properties -* **authInfo**: [AuthInfoBase](#authinfobase): The authentication info -* **clientType**: 'django' | 'dotnet' | 'go' | 'java' | 'nodejs' | 'none' | 'php' | 'python' | 'ruby' | 'springBoot' | string: The application client type -* **provisioningState**: string (ReadOnly): The provisioning state. -* **scope**: string: connection scope in source service. -* **secretStore**: [SecretStore](#secretstore): An option to store secret value in secure place -* **targetService**: [TargetServiceBase](#targetservicebase): The target service properties -* **vNetSolution**: [VNetSolution](#vnetsolution): The VNet solution for linker - ## AuthInfoBase * **Discriminator**: authType @@ -60,6 +50,26 @@ * **subscriptionId**: string: Subscription id for userAssignedIdentity. +## AzureResourcePropertiesBase +* **Discriminator**: type + +### Base Properties +### AzureKeyVaultProperties +#### Properties +* **connectAsKubernetesCsiDriver**: bool: True if connect via Kubernetes CSI Driver. +* **type**: 'KeyVault' (Required): The azure resource type. + + +## LinkerProperties +### Properties +* **authInfo**: [AuthInfoBase](#authinfobase): The authentication info +* **clientType**: 'django' | 'dotnet' | 'go' | 'java' | 'nodejs' | 'none' | 'php' | 'python' | 'ruby' | 'springBoot' | string: The application client type +* **provisioningState**: string (ReadOnly): The provisioning state. +* **scope**: string: connection scope in source service. +* **secretStore**: [SecretStore](#secretstore): An option to store secret value in secure place +* **targetService**: [TargetServiceBase](#targetservicebase): The target service properties +* **vNetSolution**: [VNetSolution](#vnetsolution): The VNet solution for linker + ## SecretInfoBase * **Discriminator**: secretType @@ -85,6 +95,24 @@ ### Properties * **keyVaultId**: string: The key vault id to store secret +## SourceConfiguration +### Properties +* **name**: string (ReadOnly): The name of setting. +* **value**: string (ReadOnly): The value of setting + +## SourceConfigurationResult +### Properties +* **configurations**: [SourceConfiguration](#sourceconfiguration)[] (ReadOnly): The configuration properties for source resource. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + ## TargetServiceBase * **Discriminator**: type @@ -106,35 +134,7 @@ * **type**: 'ConfluentSchemaRegistry' (Required): The target service type. -## AzureResourcePropertiesBase -* **Discriminator**: type - -### Base Properties -### AzureKeyVaultProperties -#### Properties -* **connectAsKubernetesCsiDriver**: bool: True if connect via Kubernetes CSI Driver. -* **type**: 'KeyVault' (Required): The azure resource type. - - ## VNetSolution ### Properties * **type**: 'privateLink' | 'serviceEndpoint' | string: Type of VNet solution. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## SourceConfigurationResult -### Properties -* **configurations**: [SourceConfiguration](#sourceconfiguration)[] (ReadOnly): The configuration properties for source resource. - -## SourceConfiguration -### Properties -* **name**: string (ReadOnly): The name of setting. -* **value**: string (ReadOnly): The value of setting - diff --git a/generated/signalr/log.out b/generated/signalr/log.out index 13eeb7611a..957373ad4b 100644 --- a/generated/signalr/log.out +++ b/generated/signalr/log.out @@ -9,7 +9,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.signalrservice-2022-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18,10 +18,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 17ms +info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.signalrservice-2021-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -30,7 +30,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 5ms @@ -42,10 +42,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.signalrservice-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -54,7 +54,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms @@ -66,7 +66,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 5ms @@ -78,10 +78,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.signalrservice-2020-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -90,10 +90,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.signalrservice-2018-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -102,13 +102,13 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'SignalRResource' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'SignalRResource' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'SignalRResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.signalrservice-2018-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -117,11 +117,11 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'SignalRResource' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'SignalRResource' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource warning | PreCheck/PropertyRedeclarationWarning | Schema 'SignalRResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource info | autorest.bicep took 2ms -info | Autorest completed in 23.12s. 18 files generated. +info | Autorest completed in 22.06s. 18 files generated. diff --git a/generated/signalr/microsoft.signalrservice/2018-03-01-preview/types.md b/generated/signalr/microsoft.signalrservice/2018-03-01-preview/types.md index 111107df74..accb052cd3 100644 --- a/generated/signalr/microsoft.signalrservice/2018-03-01-preview/types.md +++ b/generated/signalr/microsoft.signalrservice/2018-03-01-preview/types.md @@ -18,17 +18,6 @@ The geo region of a resource never changes after it is created. * **ApiVersion**: 2018-03-01-preview * **Output**: [SignalRKeys](#signalrkeys) -## SignalRCreateOrUpdateProperties -### Properties -* **externalIP**: string (ReadOnly): The publicly accessible IP of the SignalR service. -* **hostName**: string (ReadOnly): FQDN of the SignalR service instance. Format: xxx.service.signalr.net -* **hostNamePrefix**: string: Prefix for the hostName of the SignalR service. Retained for future use. -The hostname will be of format: <hostNamePrefix>.service.signalr.net. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicPort**: int (ReadOnly): The publicly accessibly port of the SignalR service which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessibly port of the SignalR service which is designed for customer server side usage. -* **version**: string (ReadOnly): Version of the SignalR resource. Probably you need the same or higher version of client SDKs. - ## ResourceSku ### Properties * **capacity**: int: Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not @@ -38,10 +27,16 @@ possible for the resource this may be omitted. * **size**: string: Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code. * **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. `Basic` is deprecated, use `Standard` instead for Basic tier -## SignalRUpdateParametersTags +## SignalRCreateOrUpdateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **externalIP**: string (ReadOnly): The publicly accessible IP of the SignalR service. +* **hostName**: string (ReadOnly): FQDN of the SignalR service instance. Format: xxx.service.signalr.net +* **hostNamePrefix**: string: Prefix for the hostName of the SignalR service. Retained for future use. +The hostname will be of format: <hostNamePrefix>.service.signalr.net. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicPort**: int (ReadOnly): The publicly accessibly port of the SignalR service which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessibly port of the SignalR service which is designed for customer server side usage. +* **version**: string (ReadOnly): Version of the SignalR resource. Probably you need the same or higher version of client SDKs. ## SignalRKeys ### Properties @@ -50,3 +45,8 @@ possible for the resource this may be omitted. * **secondaryConnectionString**: string (ReadOnly): SignalR connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## SignalRUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/signalr/microsoft.signalrservice/2018-10-01/types.md b/generated/signalr/microsoft.signalrservice/2018-10-01/types.md index 4b3c1ce4c4..3e21bcaf19 100644 --- a/generated/signalr/microsoft.signalrservice/2018-10-01/types.md +++ b/generated/signalr/microsoft.signalrservice/2018-10-01/types.md @@ -18,6 +18,26 @@ The geo region of a resource never changes after it is created. * **ApiVersion**: 2018-10-01 * **Output**: [SignalRKeys](#signalrkeys) +## ResourceSku +### Properties +* **capacity**: int: 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 +* **family**: string: Optional string. For future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string: Optional string. For future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + ## SignalRCreateOrUpdateProperties ### Properties * **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. @@ -36,10 +56,6 @@ The hostname will be of format: <hostNamePrefix>.service.signalr.net. * **serverPort**: int (ReadOnly): The publicly accessible port of the SignalR service which is designed for customer server side usage. * **version**: string (ReadOnly): Version of the SignalR resource. Probably you need the same or higher version of client SDKs. -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - ## SignalRFeature ### Properties * **flag**: 'EnableConnectivityLogs' | 'ServiceMode' | string (Required): FeatureFlags is the supported features of Azure SignalR service. @@ -53,27 +69,6 @@ The hostname will be of format: <hostNamePrefix>.service.signalr.net. ### Additional Properties * **Additional Properties Type**: string -## ResourceSku -### Properties -* **capacity**: int: 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 -* **family**: string: Optional string. For future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string: Optional string. For future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## SignalRUpdateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SignalRKeys ### Properties * **primaryConnectionString**: string (ReadOnly): SignalR connection string constructed via the primaryKey @@ -81,3 +76,8 @@ Allowed values: Standard_S1, Free_F1 * **secondaryConnectionString**: string (ReadOnly): SignalR connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## SignalRUpdateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/signalr/microsoft.signalrservice/2020-05-01/types.md b/generated/signalr/microsoft.signalrservice/2020-05-01/types.md index 553c84ab76..0e38a36e25 100644 --- a/generated/signalr/microsoft.signalrservice/2020-05-01/types.md +++ b/generated/signalr/microsoft.signalrservice/2020-05-01/types.md @@ -27,49 +27,14 @@ * **ApiVersion**: 2020-05-01 * **Output**: [SignalRKeys](#signalrkeys) -## SignalRProperties -### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the SignalR service. -* **features**: [SignalRFeature](#signalrfeature)[]: 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. -* **hostName**: string (ReadOnly): FQDN of the SignalR service instance. Format: xxx.service.signalr.net -* **hostNamePrefix**: string (ReadOnly): Prefix for the hostName of the SignalR service. Retained for future use. -The hostname will be of format: <hostNamePrefix>.service.signalr.net. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for SignalR -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the SignalR resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicPort**: int (ReadOnly): The publicly accessible port of the SignalR service which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the SignalR service which is designed for customer server side usage. -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the Azure SignalR is in server-less mode. -* **version**: string (ReadOnly): Version of the SignalR resource. Probably you need the same or higher version of client SDKs. - -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - -## SignalRFeature -### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. -* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. - -## SignalRFeatureProperties +## NetworkACL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## SignalRNetworkACLs +## PrivateEndpoint ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **id**: string: Full qualified Id of the private endpoint ## PrivateEndpointACL ### Properties @@ -77,11 +42,6 @@ The hostname will be of format: <hostNamePrefix>.service.signalr.net. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **name**: string (Required): Name of the private endpoint connection -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -95,40 +55,12 @@ The hostname will be of format: <hostNamePrefix>.service.signalr.net. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## ServerlessUpstreamSettings -### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. - -## UpstreamTemplate -### Properties -* **categoryPattern**: string: Gets or sets the matching pattern for category names. If not set, it matches any category. -There are 3 kind of patterns supported: - 1. "*", it to matches any category name - 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages" - 3. The single category name, for example, "connections", it matches the category "connections" -* **eventPattern**: string: Gets or sets the matching pattern for event names. If not set, it matches any event. -There are 3 kind of patterns supported: - 1. "*", it to matches any event name - 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect" - 3. The single event name, for example, "connect", it matches "connect" -* **hubPattern**: string: Gets or sets the matching pattern for hub names. If not set, it matches any hub. -There are 3 kind of patterns supported: - 1. "*", it to matches any hub name - 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2" - 3. The single hub name, for example, "hub1", it matches "hub1" -* **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. -For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. - ## ResourceSku ### Properties * **capacity**: int: Optional, integer. The unit count of SignalR resource. 1 by default. @@ -145,7 +77,23 @@ Allowed values: Standard_S1, Free_F1 `Basic` is deprecated, use `Standard` instead. -## TrackedResourceTags +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. + +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## SignalRFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. +* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## SignalRFeatureProperties ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -157,3 +105,55 @@ Allowed values: Standard_S1, Free_F1 * **secondaryConnectionString**: string (ReadOnly): SignalR connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## SignalRNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## SignalRProperties +### Properties +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the SignalR service. +* **features**: [SignalRFeature](#signalrfeature)[]: 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. +* **hostName**: string (ReadOnly): FQDN of the SignalR service instance. Format: xxx.service.signalr.net +* **hostNamePrefix**: string (ReadOnly): Prefix for the hostName of the SignalR service. Retained for future use. +The hostname will be of format: <hostNamePrefix>.service.signalr.net. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for SignalR +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the SignalR resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicPort**: int (ReadOnly): The publicly accessible port of the SignalR service which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the SignalR service which is designed for customer server side usage. +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the Azure SignalR is in server-less mode. +* **version**: string (ReadOnly): Version of the SignalR resource. Probably you need the same or higher version of client SDKs. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamTemplate +### Properties +* **categoryPattern**: string: Gets or sets the matching pattern for category names. If not set, it matches any category. +There are 3 kind of patterns supported: + 1. "*", it to matches any category name + 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages" + 3. The single category name, for example, "connections", it matches the category "connections" +* **eventPattern**: string: Gets or sets the matching pattern for event names. If not set, it matches any event. +There are 3 kind of patterns supported: + 1. "*", it to matches any event name + 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect" + 3. The single event name, for example, "connect", it matches "connect" +* **hubPattern**: string: Gets or sets the matching pattern for hub names. If not set, it matches any hub. +There are 3 kind of patterns supported: + 1. "*", it to matches any hub name + 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2" + 3. The single hub name, for example, "hub1", it matches "hub1" +* **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. +For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. + diff --git a/generated/signalr/microsoft.signalrservice/2020-07-01-preview/types.md b/generated/signalr/microsoft.signalrservice/2020-07-01-preview/types.md index 54369e5fdd..d67aa336f8 100644 --- a/generated/signalr/microsoft.signalrservice/2020-07-01-preview/types.md +++ b/generated/signalr/microsoft.signalrservice/2020-07-01-preview/types.md @@ -37,35 +37,69 @@ Only be used in response * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None * **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities +## ManagedIdentitySettings +### Properties +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + ## ManagedIdentityUserAssignedIdentities ### Properties ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## UserAssignedIdentityProperty +## NetworkACL ### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## SignalRProperties +## PrivateEndpoint ### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [SignalRFeature](#signalrfeature)[]: 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. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **id**: string: Full qualified Id of the private endpoint + +## PrivateEndpointACL +### Properties +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **name**: string (Required): Name of the private endpoint connection + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource Id for the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Private endpoint connection properties +* **type**: string (ReadOnly): The type of the resource - e.g. "Microsoft.SignalRService/SignalR" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + +## ResourceSku +### Properties +* **capacity**: int: 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 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ## SignalRCorsSettings ### Properties @@ -84,53 +118,52 @@ But keep in mind, the default value doesn't mean "false". It varies in terms of ### Additional Properties * **Additional Properties Type**: string +## SignalRKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + ## SignalRNetworkACLs ### Properties * **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches * **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints * **publicNetwork**: [NetworkACL](#networkacl): Network ACL -## PrivateEndpointACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **name**: string (Required): Name of the private endpoint connection - -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource Id for the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Private endpoint connection properties -* **type**: string (ReadOnly): The type of the resource - e.g. "Microsoft.SignalRService/SignalR" - -## PrivateEndpointConnectionProperties +## SignalRProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [SignalRFeature](#signalrfeature)[]: 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. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. - -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. ## SignalRTlsSettings ### Properties * **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled -## ServerlessUpstreamSettings +## TrackedResourceTags ### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. ## UpstreamTemplate ### Properties @@ -153,41 +186,8 @@ There are 3 kind of patterns supported: * **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. - -## ManagedIdentitySettings -### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. - -## ResourceSku -### Properties -* **capacity**: int: 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 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignalRKeys +## UserAssignedIdentityProperty ### Properties -* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity diff --git a/generated/signalr/microsoft.signalrservice/2021-04-01-preview/types.md b/generated/signalr/microsoft.signalrservice/2021-04-01-preview/types.md index 48af1d92b6..9a71f5601e 100644 --- a/generated/signalr/microsoft.signalrservice/2021-04-01-preview/types.md +++ b/generated/signalr/microsoft.signalrservice/2021-04-01-preview/types.md @@ -49,61 +49,24 @@ Only be used in response * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None * **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities +## ManagedIdentitySettings +### Properties +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + ## ManagedIdentityUserAssignedIdentities ### Properties ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## SignalRProperties -### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. - -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, its globally default value will be used -But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - -## SignalRFeature -### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. -- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. -- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. -* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. - -## SignalRFeatureProperties +## NetworkACL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## SignalRNetworkACLs +## PrivateEndpoint ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **id**: string: Full qualified Id of the private endpoint ## PrivateEndpointACL ### Properties @@ -111,11 +74,6 @@ But keep in mind, the default value doesn't mean "false". It varies in terms of * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **name**: string (Required): Name of the private endpoint connection -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -130,24 +88,31 @@ But keep in mind, the default value doesn't mean "false". It varies in terms of * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData +## ResourceSku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ## SharedPrivateLinkResource ### Properties @@ -165,13 +130,81 @@ But keep in mind, the default value doesn't mean "false". It varies in terms of * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## SignalRFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. +- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## SignalRFeatureProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SignalRKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + +## SignalRNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## SignalRProperties +### Properties +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. + +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, its globally default value will be used +But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + ## SignalRTlsSettings ### Properties * **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled -## ServerlessUpstreamSettings +## SystemData ### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. ## UpstreamTemplate ### Properties @@ -194,41 +227,8 @@ There are 3 kind of patterns supported: * **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. - -## ManagedIdentitySettings -### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. - -## ResourceSku -### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignalRKeys +## UserAssignedIdentityProperty ### Properties -* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity diff --git a/generated/signalr/microsoft.signalrservice/2021-06-01-preview/types.md b/generated/signalr/microsoft.signalrservice/2021-06-01-preview/types.md index 1fda60a8a3..bdba04d1d9 100644 --- a/generated/signalr/microsoft.signalrservice/2021-06-01-preview/types.md +++ b/generated/signalr/microsoft.signalrservice/2021-06-01-preview/types.md @@ -49,70 +49,24 @@ Only be used in response * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None * **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities +## ManagedIdentitySettings +### Properties +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + ## ManagedIdentityUserAssignedIdentities ### Properties ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## SignalRProperties -### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. - -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, its globally default value will be used -But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - -## SignalRFeature -### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. -- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. -- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. -* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. - -## SignalRFeatureProperties +## NetworkACL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## SignalRNetworkACLs +## PrivateEndpoint ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **id**: string: Full qualified Id of the private endpoint ## PrivateEndpointACL ### Properties @@ -120,11 +74,6 @@ When it's Disabled, public network access is always disabled no matter what you * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **name**: string (Required): Name of the private endpoint connection -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -139,24 +88,31 @@ When it's Disabled, public network access is always disabled no matter what you * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData +## ResourceSku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ## SharedPrivateLinkResource ### Properties @@ -174,13 +130,90 @@ When it's Disabled, public network access is always disabled no matter what you * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## SignalRFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. +- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## SignalRFeatureProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SignalRKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + +## SignalRNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## SignalRProperties +### Properties +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. + +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, its globally default value will be used +But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + ## SignalRTlsSettings ### Properties * **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled -## ServerlessUpstreamSettings +## SystemData ### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. ## UpstreamTemplate ### Properties @@ -203,41 +236,8 @@ There are 3 kind of patterns supported: * **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. - -## ManagedIdentitySettings -### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. - -## ResourceSku -### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignalRKeys +## UserAssignedIdentityProperty ### Properties -* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity diff --git a/generated/signalr/microsoft.signalrservice/2021-09-01-preview/types.md b/generated/signalr/microsoft.signalrservice/2021-09-01-preview/types.md index 34ccfa76dd..da3864ef26 100644 --- a/generated/signalr/microsoft.signalrservice/2021-09-01-preview/types.md +++ b/generated/signalr/microsoft.signalrservice/2021-09-01-preview/types.md @@ -49,71 +49,24 @@ Only be used in response * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None * **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities +## ManagedIdentitySettings +### Properties +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + ## ManagedIdentityUserAssignedIdentities ### Properties ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## SignalRProperties -### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. - -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, its globally default value will be used -But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **hostNamePrefix**: string (ReadOnly): Deprecated. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - -## SignalRFeature -### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. -- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. -- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. -* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. - -## SignalRFeatureProperties +## NetworkACL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## SignalRNetworkACLs +## PrivateEndpoint ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **id**: string: Full qualified Id of the private endpoint ## PrivateEndpointACL ### Properties @@ -121,11 +74,6 @@ When it's Disabled, public network access is always disabled no matter what you * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **name**: string (Required): Name of the private endpoint connection -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -140,24 +88,31 @@ When it's Disabled, public network access is always disabled no matter what you * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData +## ResourceSku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. ## SharedPrivateLinkResource ### Properties @@ -175,13 +130,91 @@ When it's Disabled, public network access is always disabled no matter what you * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## SignalRFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. +- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## SignalRFeatureProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SignalRKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + +## SignalRNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## SignalRProperties +### Properties +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. + +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, its globally default value will be used +But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **hostNamePrefix**: string (ReadOnly): Deprecated. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + ## SignalRTlsSettings ### Properties * **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled -## ServerlessUpstreamSettings +## SystemData ### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. ## UpstreamTemplate ### Properties @@ -204,41 +237,8 @@ There are 3 kind of patterns supported: * **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. - -## ManagedIdentitySettings -### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. - -## ResourceSku -### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignalRKeys +## UserAssignedIdentityProperty ### Properties -* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity diff --git a/generated/signalr/microsoft.signalrservice/2021-10-01/types.md b/generated/signalr/microsoft.signalrservice/2021-10-01/types.md index 8cc3377dda..30870ba23f 100644 --- a/generated/signalr/microsoft.signalrservice/2021-10-01/types.md +++ b/generated/signalr/microsoft.signalrservice/2021-10-01/types.md @@ -49,72 +49,24 @@ Only be used in response * **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represents the identity type: systemAssigned, userAssigned, None * **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities +## ManagedIdentitySettings +### Properties +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + ## ManagedIdentityUserAssignedIdentities ### Properties ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## SignalRProperties -### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. - -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, its globally default value will be used -But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **hostNamePrefix**: string (ReadOnly): Deprecated. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **resourceLogConfiguration**: [ResourceLogConfiguration](#resourcelogconfiguration): Resource log configuration of a Microsoft.SignalRService resource. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - -## SignalRFeature -### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. -- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. -- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. -* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. - -## SignalRFeatureProperties +## NetworkACL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## SignalRNetworkACLs +## PrivateEndpoint ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Azure Networking ACL Action. -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **id**: string: Full qualified Id of the private endpoint ## PrivateEndpointACL ### Properties @@ -122,11 +74,6 @@ When it's Disabled, public network access is always disabled no matter what you * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **name**: string (Required): Name of the private endpoint connection -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -142,29 +89,12 @@ When it's Disabled, public network access is always disabled no matter what you * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceLogConfiguration -### Properties -* **categories**: [ResourceLogCategory](#resourcelogcategory)[]: Gets or sets the list of category configurations. - ## ResourceLogCategory ### Properties * **enabled**: string: Indicates whether or the resource log category is enabled. @@ -174,6 +104,30 @@ Case insensitive. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. +## ResourceLogConfiguration +### Properties +* **categories**: [ResourceLogCategory](#resourcelogcategory)[]: Gets or sets the list of category configurations. + +## ResourceSku +### Properties +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. + ## SharedPrivateLinkResource ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -190,13 +144,92 @@ Case insensitive. * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## SignalRFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. +- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## SignalRFeatureProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SignalRKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + +## SignalRNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Azure Networking ACL Action. +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## SignalRProperties +### Properties +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. + +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, its globally default value will be used +But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **hostNamePrefix**: string (ReadOnly): Deprecated. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **resourceLogConfiguration**: [ResourceLogConfiguration](#resourcelogconfiguration): Resource log configuration of a Microsoft.SignalRService resource. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + ## SignalRTlsSettings ### Properties * **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled -## ServerlessUpstreamSettings +## SystemData ### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Upstream auth type enum. ## UpstreamTemplate ### Properties @@ -219,41 +252,8 @@ There are 3 kind of patterns supported: * **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Upstream auth type enum. - -## ManagedIdentitySettings -### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. - -## ResourceSku -### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SignalRKeys +## UserAssignedIdentityProperty ### Properties -* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity diff --git a/generated/signalr/microsoft.signalrservice/2022-02-01/types.md b/generated/signalr/microsoft.signalrservice/2022-02-01/types.md index c12532cf0f..1f3b6c13ae 100644 --- a/generated/signalr/microsoft.signalrservice/2022-02-01/types.md +++ b/generated/signalr/microsoft.signalrservice/2022-02-01/types.md @@ -60,76 +60,27 @@ * **ApiVersion**: 2022-02-01 * **Output**: [SignalRKeys](#signalrkeys) -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. -Only be used in response. -* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. -Only be used in response -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represents the identity type: systemAssigned, userAssigned, None -* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities - -## ManagedIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) - -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## SignalRProperties +## CustomCertificateProperties ### Properties -* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. - -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, its globally default value will be used -But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **hostNamePrefix**: string (ReadOnly): Deprecated. -* **liveTraceConfiguration**: [LiveTraceConfiguration](#livetraceconfiguration): Live trace configuration of a Microsoft.SignalRService resource. -* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **keyVaultBaseUri**: string (Required): Base uri of the KeyVault that stores certificate. +* **keyVaultSecretName**: string (Required): Certificate secret name. +* **keyVaultSecretVersion**: string: Certificate secret version. * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **resourceLogConfiguration**: [ResourceLogConfiguration](#resourcelogconfiguration): Resource log configuration of a Microsoft.SignalRService resource. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource -* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - -## SignalRCorsSettings -### Properties -* **allowedOrigins**: string[]: 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. -## SignalRFeature +## CustomDomainProperties ### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. -- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. -- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. -* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. +* **customCertificate**: [ResourceReference](#resourcereference) (Required): Reference to a resource. +* **domainName**: string (Required): The custom domain name. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## SignalRFeatureProperties +## LiveTraceCategory ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: string: Indicates whether or the live trace category is enabled. +Available values: true, false. +Case insensitive. +* **name**: string: Gets or sets the live trace category's name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. ## LiveTraceConfiguration ### Properties @@ -140,31 +91,39 @@ Otherwise, live trace client can't connect to the service, so that you are unabl Available values: true, false. Case insensitive. -## LiveTraceCategory +## ManagedIdentity ### Properties -* **enabled**: string: Indicates whether or the live trace category is enabled. -Available values: true, false. -Case insensitive. -* **name**: string: Gets or sets the live trace category's name. -Available values: ConnectivityLogs, MessagingLogs. -Case insensitive. +* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. +Only be used in response. +* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. +Only be used in response +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represents the identity type: systemAssigned, userAssigned, None +* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities -## SignalRNetworkACLs +## ManagedIdentitySettings ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Azure Networking ACL Action. -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. -## PrivateEndpointACL +## ManagedIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) + +## NetworkACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **name**: string (Required): Name of the private endpoint connection -## NetworkACL +## PrivateEndpoint +### Properties +* **id**: string: Full qualified Id of the private endpoint + +## PrivateEndpointACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **name**: string (Required): Name of the private endpoint connection ## PrivateEndpointConnection ### Properties @@ -181,29 +140,12 @@ Case insensitive. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceLogConfiguration -### Properties -* **categories**: [ResourceLogCategory](#resourcelogcategory)[]: Gets or sets the list of category configurations. - ## ResourceLogCategory ### Properties * **enabled**: string: Indicates whether or the resource log category is enabled. @@ -213,6 +155,34 @@ Case insensitive. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. +## ResourceLogConfiguration +### Properties +* **categories**: [ResourceLogCategory](#resourcelogcategory)[]: Gets or sets the list of category configurations. + +## ResourceReference +### Properties +* **id**: string: Resource ID. + +## ResourceSku +### Properties +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. + +## ServerlessUpstreamSettings +### Properties +* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. + ## SharedPrivateLinkResource ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -229,13 +199,93 @@ Case insensitive. * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource +## SignalRCorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## SignalRFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | 'ServiceMode' | string (Required): 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. +- EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +* **properties**: [SignalRFeatureProperties](#signalrfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## SignalRFeatureProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SignalRKeys +### Properties +* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey +* **primaryKey**: string (ReadOnly): The primary access key. +* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey +* **secondaryKey**: string (ReadOnly): The secondary access key. + +## SignalRNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Azure Networking ACL Action. +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## SignalRProperties +### Properties +* **cors**: [SignalRCorsSettings](#signalrcorssettings): Cross-Origin Resource Sharing (CORS) settings. +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [SignalRFeature](#signalrfeature)[]: List of the featureFlags. + +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, its globally default value will be used +But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **hostNamePrefix**: string (ReadOnly): Deprecated. +* **liveTraceConfiguration**: [LiveTraceConfiguration](#livetraceconfiguration): Live trace configuration of a Microsoft.SignalRService resource. +* **networkACLs**: [SignalRNetworkACLs](#signalrnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **resourceLogConfiguration**: [ResourceLogConfiguration](#resourcelogconfiguration): Resource log configuration of a Microsoft.SignalRService resource. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [SignalRTlsSettings](#signalrtlssettings): TLS settings for the resource +* **upstream**: [ServerlessUpstreamSettings](#serverlessupstreamsettings): The settings for the Upstream when the service is in server-less mode. +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + ## SignalRTlsSettings ### Properties * **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled -## ServerlessUpstreamSettings +## SystemData ### Properties -* **templates**: [UpstreamTemplate](#upstreamtemplate)[]: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Upstream auth type enum. ## UpstreamTemplate ### Properties @@ -258,58 +308,8 @@ There are 3 kind of patterns supported: * **urlTemplate**: string (Required): Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Upstream auth type enum. - -## ManagedIdentitySettings -### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. - -## ResourceSku -### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CustomCertificateProperties -### Properties -* **keyVaultBaseUri**: string (Required): Base uri of the KeyVault that stores certificate. -* **keyVaultSecretName**: string (Required): Certificate secret name. -* **keyVaultSecretVersion**: string: Certificate secret version. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. - -## CustomDomainProperties -### Properties -* **customCertificate**: [ResourceReference](#resourcereference) (Required): Reference to a resource. -* **domainName**: string (Required): The custom domain name. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. - -## ResourceReference -### Properties -* **id**: string: Resource ID. - -## SignalRKeys +## UserAssignedIdentityProperty ### Properties -* **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey -* **primaryKey**: string (ReadOnly): The primary access key. -* **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey -* **secondaryKey**: string (ReadOnly): The secondary access key. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity diff --git a/generated/softwareplan/log.out b/generated/softwareplan/log.out index 2dba9de01d..c89f74d181 100644 --- a/generated/softwareplan/log.out +++ b/generated/softwareplan/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.softwareplan-2019-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'HybridUseBenefitListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/softwareplan/resource-manager/Microsoft.SoftwarePlan/stable/2019-12-01/softwareplan.json:408:5 @@ -17,11 +17,11 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridUseBenefitModel' with a warning | PreCheck/SchemaMissingType | The schema 'HybridUseBenefitProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/softwareplan/resource-manager/Microsoft.SoftwarePlan/stable/2019-12-01/softwareplan.json:452:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.softwareplan-2019-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'HybridUseBenefitListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/softwareplan/resource-manager/Microsoft.SoftwarePlan/preview/2019-06-01-preview/softwareplan.json:408:5 @@ -31,4 +31,4 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridUseBenefitProperties' w - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/softwareplan/resource-manager/Microsoft.SoftwarePlan/preview/2019-06-01-preview/softwareplan.json:452:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 5.9s. 4 files generated. +info | Autorest completed in 5.46s. 4 files generated. diff --git a/generated/solutions/log.out b/generated/solutions/log.out index 0effd8a382..949dbb0c34 100644 --- a/generated/solutions/log.out +++ b/generated/solutions/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.solutions-2021-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -14,5 +14,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Skipping resource action listAllowedUpgradePlans under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/listAllowedUpgradePlans': failed to find a response schema -info | autorest.bicep took 15ms -info | Autorest completed in 5.48s. 2 files generated. +info | autorest.bicep took 22ms +info | Autorest completed in 5.2s. 2 files generated. diff --git a/generated/solutions/microsoft.solutions/2021-07-01/types.md b/generated/solutions/microsoft.solutions/2021-07-01/types.md index 1aa7cd9826..a237359f60 100644 --- a/generated/solutions/microsoft.solutions/2021-07-01/types.md +++ b/generated/solutions/microsoft.solutions/2021-07-01/types.md @@ -43,6 +43,33 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Solutions/jitRequests' (ReadOnly, DeployTimeConstant): The resource type +## ApplicationArtifact +### Properties +* **name**: 'Authorizations' | 'CustomRoleDefinition' | 'NotSpecified' | 'ViewDefinition' | string (Required): The managed application artifact name. +* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. +* **uri**: string (Required): The managed application artifact blob uri. + +## ApplicationAuthorization +### Properties +* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. +* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. + +## ApplicationBillingDetailsDefinition +### Properties +* **resourceUsageId**: string: The managed application resource usage Id. + +## ApplicationClientDetails +### Properties +* **applicationId**: string: The client application Id. +* **oid**: string: The client Oid. +* **puid**: string: The client Puid + +## ApplicationDefinitionArtifact +### Properties +* **name**: 'ApplicationResourceTemplate' | 'CreateUiDefinition' | 'MainTemplateParameters' | 'NotSpecified' | string (Required): The managed application artifact name. +* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. +* **uri**: string (Required): The managed application definition artifact blob uri. + ## ApplicationDefinitionProperties ### Properties * **artifacts**: [ApplicationDefinitionArtifact](#applicationdefinitionartifact)[]: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. @@ -62,91 +89,50 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Running' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning status of the managed application. * **storageAccountId**: string: The storage account id for bring your own storage scenario. -## ApplicationDefinitionArtifact -### Properties -* **name**: 'ApplicationResourceTemplate' | 'CreateUiDefinition' | 'MainTemplateParameters' | 'NotSpecified' | string (Required): The managed application artifact name. -* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. -* **uri**: string (Required): The managed application definition artifact blob uri. - -## ApplicationAuthorization -### Properties -* **principalId**: string (Required): The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. -* **roleDefinitionId**: string (Required): The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. - ## ApplicationDeploymentPolicy ### Properties * **deploymentMode**: 'Complete' | 'Incremental' | 'NotSpecified' | string (Required): The deployment mode. -## ApplicationPackageLockingPolicyDefinition +## ApplicationJitAccessPolicy ### Properties -* **allowedActions**: string[]: The deny assignment excluded actions. -* **allowedDataActions**: string[]: The deny assignment excluded data actions. +* **jitAccessEnabled**: bool (Required): Whether the JIT access is enabled. +* **jitApprovalMode**: 'AutoApprove' | 'ManualApprove' | 'NotSpecified' | string: The Jit approval mode. +* **jitApprovers**: [JitApproverDefinition](#jitapproverdefinition)[]: The JIT approvers +* **maximumJitAccessDuration**: string: The maximum duration JIT access is granted. This is an ISO8601 time period value. ## ApplicationManagementPolicy ### Properties * **mode**: 'Managed' | 'NotSpecified' | 'Unmanaged' | string: The management mode. -## ApplicationNotificationPolicy -### Properties -* **notificationEndpoints**: [ApplicationNotificationEndpoint](#applicationnotificationendpoint)[] (Required): The managed application notification endpoint. - ## ApplicationNotificationEndpoint ### Properties * **uri**: string (Required): The managed application notification endpoint uri. -## ApplicationPolicy -### Properties -* **name**: string: The policy name -* **parameters**: string: The policy parameters. -* **policyDefinitionId**: string: The policy definition Id. - -## Sku -### Properties -* **capacity**: int: The SKU capacity. -* **family**: string: The SKU family. -* **model**: string: The SKU model. -* **name**: string (Required): The SKU name. -* **size**: string: The SKU size. -* **tier**: string: The SKU tier. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceTags +## ApplicationNotificationPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **notificationEndpoints**: [ApplicationNotificationEndpoint](#applicationnotificationendpoint)[] (Required): The managed application notification endpoint. -## Identity +## ApplicationPackageContact ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +* **contactName**: string: The contact name. +* **email**: string (Required): The contact email. +* **phone**: string (Required): The contact phone number. -## IdentityUserAssignedIdentities +## ApplicationPackageLockingPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedResourceIdentity](#userassignedresourceidentity) +* **allowedActions**: string[]: The deny assignment excluded actions. +* **allowedDataActions**: string[]: The deny assignment excluded data actions. -## UserAssignedResourceIdentity +## ApplicationPackageSupportUrls ### Properties -* **principalId**: string (ReadOnly): The principal id of user assigned identity. -* **tenantId**: string (ReadOnly): The tenant id of user assigned identity. +* **governmentCloud**: string: The government cloud support URL. +* **publicAzure**: string: The public azure support URL. -## Plan +## ApplicationPolicy ### Properties -* **name**: string (Required): The plan name. -* **product**: string (Required): The product code. -* **promotionCode**: string: The promotion code. -* **publisher**: string (Required): The publisher ID. -* **version**: string (Required): The plan's version. +* **name**: string: The policy name +* **parameters**: string: The policy parameters. +* **policyDefinitionId**: string: The policy definition Id. ## ApplicationProperties ### Properties @@ -166,34 +152,17 @@ * **supportUrls**: [ApplicationPackageSupportUrls](#applicationpackagesupporturls) (ReadOnly): The appliance package support URLs. * **updatedBy**: [ApplicationClientDetails](#applicationclientdetails) (ReadOnly): The application client details to track the entity creating/updating the managed app resource. -## ApplicationArtifact -### Properties -* **name**: 'Authorizations' | 'CustomRoleDefinition' | 'NotSpecified' | 'ViewDefinition' | string (Required): The managed application artifact name. -* **type**: 'Custom' | 'NotSpecified' | 'Template' (Required): The managed application artifact type. -* **uri**: string (Required): The managed application artifact blob uri. - -## ApplicationBillingDetailsDefinition -### Properties -* **resourceUsageId**: string: The managed application resource usage Id. - -## ApplicationClientDetails -### Properties -* **applicationId**: string: The client application Id. -* **oid**: string: The client Oid. -* **puid**: string: The client Puid - -## ApplicationPackageContact +## Identity ### Properties -* **contactName**: string: The contact name. -* **email**: string (Required): The contact email. -* **phone**: string (Required): The contact phone number. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. -## ApplicationJitAccessPolicy +## IdentityUserAssignedIdentities ### Properties -* **jitAccessEnabled**: bool (Required): Whether the JIT access is enabled. -* **jitApprovalMode**: 'AutoApprove' | 'ManualApprove' | 'NotSpecified' | string: The Jit approval mode. -* **jitApprovers**: [JitApproverDefinition](#jitapproverdefinition)[]: The JIT approvers -* **maximumJitAccessDuration**: string: The maximum duration JIT access is granted. This is an ISO8601 time period value. +### Additional Properties +* **Additional Properties Type**: [UserAssignedResourceIdentity](#userassignedresourceidentity) ## JitApproverDefinition ### Properties @@ -201,15 +170,10 @@ * **id**: string (Required): The approver service principal Id. * **type**: 'group' | 'user' | string: The approver type. -## ApplicationPackageSupportUrls -### Properties -* **governmentCloud**: string: The government cloud support URL. -* **publicAzure**: string: The public azure support URL. - -## ResourceTags +## JitAuthorizationPolicies ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (Required): The the principal id that will be granted JIT access. +* **roleDefinitionId**: string (Required): The role definition id that will be granted to the Principal. ## JitRequestProperties ### Properties @@ -222,19 +186,55 @@ * **publisherTenantId**: string (ReadOnly): The publisher tenant id. * **updatedBy**: [ApplicationClientDetails](#applicationclientdetails) (ReadOnly): The application client details to track the entity creating/updating the managed app resource. -## JitAuthorizationPolicies -### Properties -* **principalId**: string (Required): The the principal id that will be granted JIT access. -* **roleDefinitionId**: string (Required): The role definition id that will be granted to the Principal. - ## JitSchedulingPolicy ### Properties * **duration**: string (Required): The required duration of the JIT request. * **startTime**: string (Required): The start time of the request. * **type**: 'NotSpecified' | 'Once' | 'Recurring' | string (Required): The JIT request scheduling type. +## Plan +### Properties +* **name**: string (Required): The plan name. +* **product**: string (Required): The product code. +* **promotionCode**: string: The promotion code. +* **publisher**: string (Required): The publisher ID. +* **version**: string (Required): The plan's version. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## Sku +### Properties +* **capacity**: int: The SKU capacity. +* **family**: string: The SKU family. +* **model**: string: The SKU model. +* **name**: string (Required): The SKU name. +* **size**: string: The SKU size. +* **tier**: string: The SKU tier. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## UserAssignedResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The principal id of user assigned identity. +* **tenantId**: string (ReadOnly): The tenant id of user assigned identity. + diff --git a/generated/sql/log.out b/generated/sql/log.out index 100b4cc056..9390e1a521 100644 --- a/generated/sql/log.out +++ b/generated/sql/log.out @@ -11,14 +11,14 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.sql-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated' @@ -26,14 +26,14 @@ warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourc info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/outboundfirewallrules under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 42ms +info | autorest.bicep took 59ms info | Processing batch task - {"tag":"microsoft.sql-2014-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DataMaskingPolicyProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/dataMasking.json:233:5 @@ -299,40 +299,40 @@ warning | PreNamer/DeduplicateName | Deduplicating schema name: 'RecommendedElas warning | PreNamer/DeduplicateName | Deduplicating schema name: 'RecommendedElasticPoolProperties' -> 'RecommendedElasticPoolPropertiesAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'RecommendedElasticPoolListResult' -> 'RecommendedElasticPoolListResultAutoGenerated' info | Resource type microsoft.sql/servers/disasterrecoveryconfiguration under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}' has no body defined. -info | autorest.bicep took 46ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.sql-2020-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules': Found mismatch between type segments (2) and name segments (1) info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 46ms +info | autorest.bicep took 28ms info | Processing batch task - {"tag":"microsoft.sql-2021-02-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules': Found mismatch between type segments (2) and name segments (1) info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 48ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.sql-2021-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated' @@ -340,14 +340,14 @@ warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourc info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/outboundfirewallrules under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 33ms +info | autorest.bicep took 43ms info | Processing batch task - {"tag":"microsoft.sql-2021-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated' @@ -355,38 +355,38 @@ warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourc info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/outboundfirewallrules under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 37ms +info | autorest.bicep took 52ms info | Processing batch task - {"tag":"microsoft.sql-2015-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules': Found mismatch between type segments (2) and name segments (1) -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.sql-2017-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated' info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 10ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.sql-2017-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms @@ -396,56 +396,56 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.sql-2019-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.sql-2020-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated' warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules': Found mismatch between type segments (2) and name segments (1) info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 26ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.sql-2020-02-02-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated' warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules': Found mismatch between type segments (2) and name segments (1) info | Resource type microsoft.sql/servers/jobagents/jobs/executions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}' has no body defined. info | Resource type microsoft.sql/servers/dnsaliases under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}' has no body defined. -info | autorest.bicep took 24ms +info | autorest.bicep took 42ms info | Processing batch task - {"tag":"microsoft.sql-2015-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 669.88s. 26 files generated. +info | Autorest completed in 637.47s. 26 files generated. diff --git a/generated/sql/microsoft.sql/2014-04-01/types.md b/generated/sql/microsoft.sql/2014-04-01/types.md index cddb10d54a..e5c560c54d 100644 --- a/generated/sql/microsoft.sql/2014-04-01/types.md +++ b/generated/sql/microsoft.sql/2014-04-01/types.md @@ -206,28 +206,6 @@ * **properties**: [FirewallRuleProperties](#firewallruleproperties): Represents the properties of a server firewall rule. * **type**: 'Microsoft.Sql/servers/firewallRules' (ReadOnly, DeployTimeConstant): The resource type -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Can only be specified when the server is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **externalAdministratorLogin**: string (ReadOnly): The display name of the Azure Active Directory object with admin permissions on this server. Legacy parameter, always null. To check for Active Directory admin, query .../servers/{serverName}/administrators -* **externalAdministratorSid**: string (ReadOnly): The ID of the Active Azure Directory object with admin permissions on this server. Legacy parameter, always null. To check for Active Directory admin, query .../servers/{serverName}/administrators. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **state**: 'Disabled' | 'Ready' (ReadOnly): The state of the server. -* **version**: '12.0' | '2.0' | string: The version of the server. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServerAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. -* **login**: string (Required): The server administrator login value. -* **sid**: string (Required): The server administrator Sid (Secure ID). -* **tenantId**: string (Required): The server Active Directory Administrator tenant id. - ## AdvisorProperties ### Properties * **advisorStatus**: 'GA' | 'LimitedPublicPreview' | 'PrivatePreview' | 'PublicPreview' (ReadOnly): Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. @@ -235,28 +213,15 @@ * **lastChecked**: string (ReadOnly): Gets the time when the current resource was analyzed for recommendations by this advisor. * **recommendationsStatus**: string (ReadOnly): Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available), LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. -## ServerTableAuditingPolicyProperties -### Properties -* **auditingState**: string: The state of the policy. -* **auditLogsTableName**: string: The audit logs table name. -* **eventTypesToAudit**: string: Comma-separated list of event types to audit. -* **fullAuditLogsTableName**: string: The full audit logs table name. -* **retentionDays**: string: The number of days to keep in the audit logs. -* **storageAccountKey**: string: The key of the auditing storage account. -* **storageAccountName**: string: The table storage account name -* **storageAccountResourceGroupName**: string: The table storage account resource group name -* **storageAccountSecondaryKey**: string: The secondary key of the auditing storage account. -* **storageAccountSubscriptionId**: string: The table storage subscription Id. -* **storageTableEndpoint**: string: The storage table endpoint. - -## ServerCommunicationLinkProperties -### Properties -* **partnerServer**: string (Required): The name of the partner server. -* **state**: string (ReadOnly): The state. - -## ServerConnectionPolicyProperties +## DatabaseConnectionPolicyProperties ### Properties -* **connectionType**: 'Default' | 'Proxy' | 'Redirect' (Required): The server connection type. +* **proxyDnsName**: string: The fully qualified host name of the auditing proxy. +* **proxyPort**: string: The port number of the auditing proxy. +* **redirectionState**: string: The state of proxy redirection. +* **securityEnabledAccess**: string: The state of security access. +* **state**: string: The connection policy state. +* **useServerDefault**: string: Whether server default is enabled or disabled. +* **visibility**: string: The visibility of the auditing proxy. ## DatabaseProperties ### Properties @@ -315,6 +280,102 @@ The list of SKUs may vary by region and support offer. To determine the service * **transparentDataEncryption**: [TransparentDataEncryption](#transparentdataencryption)[] (ReadOnly): The transparent data encryption info for this database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. +## DatabaseSecurityAlertPolicyProperties +### Properties +* **disabledAlerts**: string: 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. +* **emailAccountAdmins**: 'Disabled' | 'Enabled': Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string: Specifies the semicolon-separated list of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required. +* **storageEndpoint**: 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. +* **useServerDefault**: 'Disabled' | 'Enabled': Specifies whether to use the default server policy. + +## DatabaseTableAuditingPolicyProperties +### Properties +* **auditingState**: string: The state of the policy. +* **auditLogsTableName**: string: The audit logs table name. +* **eventTypesToAudit**: string: Comma-separated list of event types to audit. +* **fullAuditLogsTableName**: string: The full audit logs table name. +* **retentionDays**: string: The number of days to keep in the audit logs. +* **storageAccountKey**: string: The key of the auditing storage account. +* **storageAccountName**: string: The table storage account name +* **storageAccountResourceGroupName**: string: The table storage account resource group name +* **storageAccountSecondaryKey**: string: The secondary key of the auditing storage account. +* **storageAccountSubscriptionId**: string: The table storage subscription Id. +* **storageTableEndpoint**: string: The storage table endpoint. +* **useServerDefault**: string: Whether server default is enabled or disabled. + +## DataMaskingPolicyProperties +### Properties +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. + +## DataMaskingRuleProperties +### Properties +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. + +## DisasterRecoveryConfigurationProperties +### Properties +* **autoFailover**: 'Off' | 'On' | string (ReadOnly): Whether or not failover can be done automatically. +* **failoverPolicy**: 'Automatic' | 'Manual' | string (ReadOnly): How aggressive the automatic failover should be. +* **logicalServerName**: string (ReadOnly): Logical name of the server. +* **partnerLogicalServerName**: string (ReadOnly): Logical name of the partner server. +* **partnerServerId**: string (ReadOnly): Id of the partner server. +* **role**: 'None' | 'Primary' | 'Secondary' | string (ReadOnly): The role of the current server in the disaster recovery configuration. +* **status**: 'Creating' | 'Dropping' | 'FailingOver' | 'Ready' | string (ReadOnly): The status of the disaster recovery configuration. + +## ElasticPoolProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **databaseDtuMax**: int: The maximum DTU any one database can consume. +* **databaseDtuMin**: int: The minimum DTU all databases are guaranteed. +* **dtu**: int: The total shared DTU for the database elastic pool. +* **edition**: 'Basic' | 'BusinessCritical' | 'GeneralPurpose' | 'Premium' | 'Standard' | string: The edition of the recommended elastic pool. The ElasticPoolEdition enumeration contains all the valid editions. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **storageMB**: int: Gets storage limit for the database elastic pool in MB. +* **zoneRedundant**: bool: Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones. + +## FirewallRuleProperties +### Properties +* **endIpAddress**: string (Required): 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. +* **startIpAddress**: string (Required): 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. + +## GeoBackupPolicyProperties +### Properties +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. + +## ImportExtensionProperties +### Properties +* **administratorLogin**: string (Required, WriteOnly): The name of the SQL administrator. +* **administratorLoginPassword**: string (Required, WriteOnly): The password of the SQL administrator. +* **authenticationType**: 'ADPassword' | 'SQL' (WriteOnly): The authentication type. +* **operationMode**: 'Import' (Required, WriteOnly): The type of import operation being performed. This is always Import. +* **storageKey**: string (Required, WriteOnly): The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?." +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' (Required, WriteOnly): The type of the storage key to use. +* **storageUri**: string (Required, WriteOnly): The storage uri to use. + +## OperationImpact +### Properties +* **changeValueAbsolute**: int (ReadOnly): The absolute impact to dimension. +* **changeValueRelative**: int (ReadOnly): The relative impact to dimension (null if not applicable) +* **name**: string (ReadOnly): The name of the impact dimension. +* **unit**: string (ReadOnly): The unit in which estimated impact to dimension is measured. + ## RecommendedIndex ### Properties * **id**: string (ReadOnly): Resource ID. @@ -337,12 +398,45 @@ The list of SKUs may vary by region and support offer. To determine the service * **state**: 'Active' | 'Blocked' | 'Executing' | 'Expired' | 'Ignored' | 'Pending Revert' | 'Pending' | 'Reverted' | 'Reverting' | 'Success' | 'Verifying' (ReadOnly): The current recommendation state. * **table**: string (ReadOnly): The table on which to build index. -## OperationImpact +## ServerAdministratorProperties ### Properties -* **changeValueAbsolute**: int (ReadOnly): The absolute impact to dimension. -* **changeValueRelative**: int (ReadOnly): The relative impact to dimension (null if not applicable) -* **name**: string (ReadOnly): The name of the impact dimension. -* **unit**: string (ReadOnly): The unit in which estimated impact to dimension is measured. +* **administratorType**: 'ActiveDirectory' (Required): The type of administrator. +* **login**: string (Required): The server administrator login value. +* **sid**: string (Required): The server administrator Sid (Secure ID). +* **tenantId**: string (Required): The server Active Directory Administrator tenant id. + +## ServerCommunicationLinkProperties +### Properties +* **partnerServer**: string (Required): The name of the partner server. +* **state**: string (ReadOnly): The state. + +## ServerConnectionPolicyProperties +### Properties +* **connectionType**: 'Default' | 'Proxy' | 'Redirect' (Required): The server connection type. + +## ServerProperties +### Properties +* **administratorLogin**: string: Administrator username for the server. Can only be specified when the server is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **externalAdministratorLogin**: string (ReadOnly): The display name of the Azure Active Directory object with admin permissions on this server. Legacy parameter, always null. To check for Active Directory admin, query .../servers/{serverName}/administrators +* **externalAdministratorSid**: string (ReadOnly): The ID of the Active Azure Directory object with admin permissions on this server. Legacy parameter, always null. To check for Active Directory admin, query .../servers/{serverName}/administrators. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **state**: 'Disabled' | 'Ready' (ReadOnly): The state of the server. +* **version**: '12.0' | '2.0' | string: The version of the server. + +## ServerTableAuditingPolicyProperties +### Properties +* **auditingState**: string: The state of the policy. +* **auditLogsTableName**: string: The audit logs table name. +* **eventTypesToAudit**: string: Comma-separated list of event types to audit. +* **fullAuditLogsTableName**: string: The full audit logs table name. +* **retentionDays**: string: The number of days to keep in the audit logs. +* **storageAccountKey**: string: The key of the auditing storage account. +* **storageAccountName**: string: The table storage account name +* **storageAccountResourceGroupName**: string: The table storage account resource group name +* **storageAccountSecondaryKey**: string: The secondary key of the auditing storage account. +* **storageAccountSubscriptionId**: string: The table storage subscription Id. +* **storageTableEndpoint**: string: The storage table endpoint. ## ServiceTierAdvisor ### Properties @@ -379,124 +473,30 @@ The list of SKUs may vary by region and support offer. To determine the service * **serviceLevelObjective**: 'Basic' | 'DS100' | 'DS1000' | 'DS1200' | 'DS1500' | 'DS200' | 'DS2000' | 'DS300' | 'DS400' | 'DS500' | 'DS600' | 'DW100' | 'DW1000' | 'DW10000c' | 'DW1000c' | 'DW1200' | 'DW1500' | 'DW15000c' | 'DW1500c' | 'DW200' | 'DW2000' | 'DW2000c' | 'DW2500c' | 'DW300' | 'DW3000' | 'DW30000c' | 'DW3000c' | 'DW400' | 'DW500' | 'DW5000c' | 'DW600' | 'DW6000' | 'DW6000c' | 'DW7500c' | 'ElasticPool' | 'Free' | 'P1' | 'P11' | 'P15' | 'P2' | 'P3' | 'P4' | 'P6' | 'PRS1' | 'PRS2' | 'PRS4' | 'PRS6' | 'S0' | 'S1' | 'S12' | 'S2' | 'S3' | 'S4' | 'S6' | 'S7' | 'S9' | 'System' | 'System0' | 'System1' | 'System2' | 'System2L' | 'System3' | 'System3L' | 'System4' | 'System4L' | string (ReadOnly): The serviceLevelObjective for SLO usage metric. * **serviceLevelObjectiveId**: string (ReadOnly): The serviceLevelObjectiveId for SLO usage metric. -## TransparentDataEncryption -### Properties -* **id**: string (ReadOnly): Resource ID. -* **location**: string (ReadOnly): Resource location. -* **name**: string (ReadOnly): Resource name. -* **properties**: [TransparentDataEncryptionProperties](#transparentdataencryptionproperties): Represents the properties of a database transparent data encryption. -* **type**: string (ReadOnly): Resource type. - -## TransparentDataEncryptionProperties -### Properties -* **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. - ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DatabaseTableAuditingPolicyProperties -### Properties -* **auditingState**: string: The state of the policy. -* **auditLogsTableName**: string: The audit logs table name. -* **eventTypesToAudit**: string: Comma-separated list of event types to audit. -* **fullAuditLogsTableName**: string: The full audit logs table name. -* **retentionDays**: string: The number of days to keep in the audit logs. -* **storageAccountKey**: string: The key of the auditing storage account. -* **storageAccountName**: string: The table storage account name -* **storageAccountResourceGroupName**: string: The table storage account resource group name -* **storageAccountSecondaryKey**: string: The secondary key of the auditing storage account. -* **storageAccountSubscriptionId**: string: The table storage subscription Id. -* **storageTableEndpoint**: string: The storage table endpoint. -* **useServerDefault**: string: Whether server default is enabled or disabled. - -## DatabaseConnectionPolicyProperties -### Properties -* **proxyDnsName**: string: The fully qualified host name of the auditing proxy. -* **proxyPort**: string: The port number of the auditing proxy. -* **redirectionState**: string: The state of proxy redirection. -* **securityEnabledAccess**: string: The state of security access. -* **state**: string: The connection policy state. -* **useServerDefault**: string: Whether server default is enabled or disabled. -* **visibility**: string: The visibility of the auditing proxy. - -## DataMaskingPolicyProperties -### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. - -## DataMaskingRuleProperties -### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. - -## ImportExtensionProperties -### Properties -* **administratorLogin**: string (Required, WriteOnly): The name of the SQL administrator. -* **administratorLoginPassword**: string (Required, WriteOnly): The password of the SQL administrator. -* **authenticationType**: 'ADPassword' | 'SQL' (WriteOnly): The authentication type. -* **operationMode**: 'Import' (Required, WriteOnly): The type of import operation being performed. This is always Import. -* **storageKey**: string (Required, WriteOnly): The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?." -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' (Required, WriteOnly): The type of the storage key to use. -* **storageUri**: string (Required, WriteOnly): The storage uri to use. - -## GeoBackupPolicyProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. - -## DatabaseSecurityAlertPolicyProperties -### Properties -* **disabledAlerts**: string: 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. -* **emailAccountAdmins**: 'Disabled' | 'Enabled': Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string: Specifies the semicolon-separated list of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required. -* **storageEndpoint**: 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. -* **useServerDefault**: 'Disabled' | 'Enabled': Specifies whether to use the default server policy. - -## DisasterRecoveryConfigurationProperties -### Properties -* **autoFailover**: 'Off' | 'On' | string (ReadOnly): Whether or not failover can be done automatically. -* **failoverPolicy**: 'Automatic' | 'Manual' | string (ReadOnly): How aggressive the automatic failover should be. -* **logicalServerName**: string (ReadOnly): Logical name of the server. -* **partnerLogicalServerName**: string (ReadOnly): Logical name of the partner server. -* **partnerServerId**: string (ReadOnly): Id of the partner server. -* **role**: 'None' | 'Primary' | 'Secondary' | string (ReadOnly): The role of the current server in the disaster recovery configuration. -* **status**: 'Creating' | 'Dropping' | 'FailingOver' | 'Ready' | string (ReadOnly): The status of the disaster recovery configuration. - -## ElasticPoolProperties +## TrackedResourceTags ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **databaseDtuMax**: int: The maximum DTU any one database can consume. -* **databaseDtuMin**: int: The minimum DTU all databases are guaranteed. -* **dtu**: int: The total shared DTU for the database elastic pool. -* **edition**: 'Basic' | 'BusinessCritical' | 'GeneralPurpose' | 'Premium' | 'Standard' | string: The edition of the recommended elastic pool. The ElasticPoolEdition enumeration contains all the valid editions. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **storageMB**: int: Gets storage limit for the database elastic pool in MB. -* **zoneRedundant**: bool: Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones. +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FirewallRuleProperties +## TransparentDataEncryption ### Properties -* **endIpAddress**: string (Required): 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. -* **startIpAddress**: string (Required): 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. +* **id**: string (ReadOnly): Resource ID. +* **location**: string (ReadOnly): Resource location. +* **name**: string (ReadOnly): Resource name. +* **properties**: [TransparentDataEncryptionProperties](#transparentdataencryptionproperties): Represents the properties of a database transparent data encryption. +* **type**: string (ReadOnly): Resource type. + +## TransparentDataEncryptionProperties +### Properties +* **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. diff --git a/generated/sql/microsoft.sql/2015-05-01-preview/types.md b/generated/sql/microsoft.sql/2015-05-01-preview/types.md index 7cb9c3cad4..8e536f23f8 100644 --- a/generated/sql/microsoft.sql/2015-05-01-preview/types.md +++ b/generated/sql/microsoft.sql/2015-05-01-preview/types.md @@ -114,70 +114,6 @@ * **properties**: [VirtualNetworkRuleProperties](#virtualnetworkruleproperties): Properties of a virtual network rule. * **type**: 'Microsoft.Sql/servers/virtualNetworkRules' (ReadOnly, DeployTimeConstant): The resource type -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. - -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **collation**: string: Collation of the managed instance. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. - -## Sku -### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## DatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -262,45 +198,6 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## SyncGroupProperties -### Properties -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. - -## SyncGroupSchema -### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. - -## SyncGroupSchemaTable -### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. - -## SyncGroupSchemaTableColumn -### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. - -## SyncMemberProperties -### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **userName**: string: User name of the member database in the sync member. - ## EncryptionProtectorProperties ### Properties * **serverKeyName**: string: The name of the server key. @@ -318,12 +215,6 @@ For more information, see [Auditing to storage using Managed Identity authentica * **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. * **replicationState**: string (ReadOnly): Replication state of the failover group instance. -## PartnerInfo -### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. - ## FailoverGroupReadOnlyEndpoint ### Properties * **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. @@ -338,6 +229,50 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: string +## ManagedInstanceProperties +### Properties +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **collation**: string: Collation of the managed instance. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. + +## PartnerInfo +### Properties +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + ## ServerFirewallRuleProperties ### Properties * **endIpAddress**: string: 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. @@ -351,6 +286,22 @@ For more information, see [Auditing to storage using Managed Identity authentica * **thumbprint**: string: Thumbprint of the server key. * **uri**: string: The URI of the server key. +## ServerProperties +### Properties +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. + +## Sku +### Properties +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. + ## SyncAgentProperties ### Properties * **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. @@ -361,6 +312,55 @@ For more information, see [Auditing to storage using Managed Identity authentica * **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. * **version**: string (ReadOnly): Version of the sync agent. +## SyncGroupProperties +### Properties +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. + +## SyncGroupSchema +### Properties +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. + +## SyncGroupSchemaTable +### Properties +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. + +## SyncGroupSchemaTableColumn +### Properties +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. + +## SyncMemberProperties +### Properties +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **userName**: string: User name of the member database in the sync member. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## VirtualNetworkRuleProperties ### Properties * **ignoreMissingVnetServiceEndpoint**: bool: Create firewall rule before the virtual network has vnet service endpoint enabled. diff --git a/generated/sql/microsoft.sql/2017-03-01-preview/types.md b/generated/sql/microsoft.sql/2017-03-01-preview/types.md index 7d420abe09..bbdb75cf96 100644 --- a/generated/sql/microsoft.sql/2017-03-01-preview/types.md +++ b/generated/sql/microsoft.sql/2017-03-01-preview/types.md @@ -217,52 +217,7 @@ * **properties**: [SecurityAlertPolicyProperties](#securityalertpolicyproperties): Properties of a security alert policy. * **type**: 'Microsoft.Sql/servers/securityAlertPolicies' (ReadOnly, DeployTimeConstant): The resource type -## ManagedInstanceAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. - -## ManagedDatabaseProperties -### Properties -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ServerBlobAuditingPolicyProperties +## DatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -388,20 +343,22 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineSecondary' | 'Online' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Suspect' | string (ReadOnly): The status of the database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## Sku +## DatabaseVulnerabilityAssessmentProperties ### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## TrackedResourceTags +## DatabaseVulnerabilityAssessmentRuleBaselineItem ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **result**: string[] (Required): The rule baseline result -## DatabaseBlobAuditingPolicyProperties +## DatabaseVulnerabilityAssessmentRuleBaselineProperties +### Properties +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result + +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -475,6 +432,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -488,14 +446,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## LongTermRetentionPolicyProperties -### Properties -* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. -* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. -* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. -* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. - -## ExtendedDatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -583,41 +534,157 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## SensitivityLabelProperties +## JobAgentProperties ### Properties -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. -## DatabaseVulnerabilityAssessmentProperties +## JobCredentialProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. -## VulnerabilityAssessmentRecurringScansProperties +## JobExecutionProperties ### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. -## DatabaseVulnerabilityAssessmentRuleBaselineProperties +## JobExecutionTarget ### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. -## DatabaseVulnerabilityAssessmentRuleBaselineItem +## JobProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. -## ServerDnsAliasProperties +## JobSchedule ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the schedule type is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type -## ExtendedServerBlobAuditingPolicyProperties +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. + +## LongTermRetentionPolicyProperties +### Properties +* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. +* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. +* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. +* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## SecurityAlertPolicyProperties +### Properties +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. + +## SensitivityLabelProperties +### Properties +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' + +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -691,7 +758,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -705,102 +771,36 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## JobAgentProperties +## ServerDnsAliasProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## Sku +### Properties +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## JobCredentialProperties -### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. - -## JobProperties -### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. - -## JobSchedule -### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the schedule type is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type - -## JobExecutionProperties -### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. - -## JobExecutionTarget -### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. - -## JobStepProperties -### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. - -## JobStepAction -### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. - -## JobStepExecutionOptions -### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. - -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. diff --git a/generated/sql/microsoft.sql/2017-10-01-preview/types.md b/generated/sql/microsoft.sql/2017-10-01-preview/types.md index 707675e97b..fdf1f3d78b 100644 --- a/generated/sql/microsoft.sql/2017-10-01-preview/types.md +++ b/generated/sql/microsoft.sql/2017-10-01-preview/types.md @@ -83,68 +83,9 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Sql/servers/elasticPools' (ReadOnly, DeployTimeConstant): The resource type -## InstanceFailoverGroupProperties -### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. - -## ManagedInstancePairInfo -### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. - -## PartnerRegionInfo -### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. - -## InstanceFailoverGroupReadOnlyEndpoint -### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. - -## InstanceFailoverGroupReadWriteEndpoint -### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The key type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties +## BackupShortTermRetentionPolicyProperties ### Properties -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The key type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ## DatabaseProperties ### Properties @@ -196,22 +137,25 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Suspect' | string (ReadOnly): The status of the database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## Sku +## DatabaseVulnerabilityAssessmentProperties ### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## TrackedResourceTags +## DatabaseVulnerabilityAssessmentRuleBaselineItem ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **result**: string[] (Required): The rule baseline result -## BackupShortTermRetentionPolicyProperties +## DatabaseVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result + +## ElasticPoolPerDatabaseSettings +### Properties +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. ## ElasticPoolProperties ### Properties @@ -222,13 +166,69 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. * **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. -## ElasticPoolPerDatabaseSettings +## InstanceFailoverGroupProperties ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## ManagedInstanceEncryptionProtectorProperties +### Properties +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The key type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ManagedInstanceKeyProperties +### Properties +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The key type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ManagedInstancePairInfo +### Properties +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. + +## PartnerRegionInfo +### Properties +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. + +## Sku +### Properties +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VulnerabilityAssessmentRecurringScansProperties +### Properties +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + diff --git a/generated/sql/microsoft.sql/2018-06-01-preview/types.md b/generated/sql/microsoft.sql/2018-06-01-preview/types.md index 3e24ed922f..8fb775d11d 100644 --- a/generated/sql/microsoft.sql/2018-06-01-preview/types.md +++ b/generated/sql/microsoft.sql/2018-06-01-preview/types.md @@ -99,30 +99,43 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties +## AdministratorProperties ### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. -## Sku +## BaseLongTermRetentionPolicyProperties ### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. +* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. +* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. +* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. +* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## TrackedResourceTags +## InstancePoolProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. -## ResourceIdentity +## ManagedDatabaseProperties ### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ## ManagedInstanceProperties ### Properties @@ -156,40 +169,45 @@ List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTi An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". * **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -## TrackedResourceTags +## ManagedInstanceVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ManagedDatabaseProperties +## PrivateEndpointConnectionProperties ### Properties -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the private endpoint connection. -## TrackedResourceTags +## PrivateEndpointProperty ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource id of the private endpoint. -## BaseLongTermRetentionPolicyProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. -* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. -* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. -* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + +## SecurityAlertPolicyProperties +### Properties +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ## SensitivityLabelProperties ### Properties @@ -200,57 +218,39 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **labelName**: string: The label name. * **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -## ManagedInstanceVulnerabilityAssessmentProperties +## ServerVulnerabilityAssessmentProperties ### Properties * **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. * **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. * **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). * **storageContainerSasKey**: string (WriteOnly): 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. -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## SecurityAlertPolicyProperties +## Sku ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## PrivateEndpointConnectionProperties +## TrackedResourceTags ### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the private endpoint connection. +### Additional Properties +* **Additional Properties Type**: string -## PrivateEndpointProperty +## TrackedResourceTags ### Properties -* **id**: string: Resource id of the private endpoint. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkServiceConnectionStateProperty +## TrackedResourceTags ### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. +### Additional Properties +* **Additional Properties Type**: string -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. diff --git a/generated/sql/microsoft.sql/2019-06-01-preview/types.md b/generated/sql/microsoft.sql/2019-06-01-preview/types.md index 3d5e52fe94..3ef0998edd 100644 --- a/generated/sql/microsoft.sql/2019-06-01-preview/types.md +++ b/generated/sql/microsoft.sql/2019-06-01-preview/types.md @@ -83,72 +83,6 @@ * **properties**: [WorkloadClassifierProperties](#workloadclassifierproperties): Workload classifier definition. For more information look at sys.workload_management_workload_classifiers (DMV). * **type**: 'Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers' (ReadOnly, DeployTimeConstant): The resource type -## ManagedDatabaseProperties -### Properties -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AdministratorProperties ### Properties * **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. @@ -221,6 +155,62 @@ When source subscription belongs to a different tenant than target subscription, * **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. +## ManagedDatabaseProperties +### Properties +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. + +## PrivateEndpointProperty +### Properties +* **id**: string: Resource id of the private endpoint. + +## PrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ServerProperties +### Properties +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. + ## Sku ### Properties * **capacity**: int: Capacity of the particular SKU. @@ -229,11 +219,6 @@ When source subscription belongs to a different tenant than target subscription, * **size**: string: Size of the particular SKU * **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SyncGroupProperties ### Properties * **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. @@ -278,14 +263,20 @@ When source subscription belongs to a different tenant than target subscription, * **usePrivateLinkConnection**: bool: Whether to use private link connection. * **userName**: string: User name of the member database in the sync member. -## WorkloadGroupProperties +## TrackedResourceTags ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## WorkloadClassifierProperties ### Properties @@ -296,3 +287,12 @@ When source subscription belongs to a different tenant than target subscription, * **memberName**: string (Required): The workload classifier member name. * **startTime**: string: The workload classifier start time for classification. +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. + diff --git a/generated/sql/microsoft.sql/2020-02-02-preview/types.md b/generated/sql/microsoft.sql/2020-02-02-preview/types.md index 1f64f1e9e4..98a9699fda 100644 --- a/generated/sql/microsoft.sql/2020-02-02-preview/types.md +++ b/generated/sql/microsoft.sql/2020-02-02-preview/types.md @@ -572,316 +572,30 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties -### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. - -## Sku -### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstanceFailoverGroupProperties -### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. - -## ManagedInstancePairInfo -### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. - -## PartnerRegionInfo -### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. - -## InstanceFailoverGroupReadOnlyEndpoint -### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. - -## InstanceFailoverGroupReadWriteEndpoint -### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. - -## ServerTrustGroupProperties -### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | string[] (Required): Trust scope of the server trust group. - -## ServerInfo -### Properties -* **serverId**: string (Required): Server Id. - -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. - -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **collation**: string: Collation of the managed instance. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties +## AdministratorProperties ### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. -## ManagedInstanceAzureADOnlyAuthProperties +## AzureADOnlyAuthProperties ### Properties * **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BaseLongTermRetentionPolicyProperties -### Properties -* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. -* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. -* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. -* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. - -## ManagedBackupShortTermRetentionPolicyProperties +## BackupShortTermRetentionPolicyProperties ### Properties * **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties -### Properties -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## SqlAgentConfigurationProperties -### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. - -## ManagedInstanceVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. +## BaseLongTermRetentionPolicyProperties +### Properties +* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. +* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. +* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. +* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## ServerBlobAuditingPolicyProperties +## DatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -952,16 +666,6 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -978,10 +682,6 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - ## DatabaseProperties ### Properties * **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled @@ -1033,12 +733,44 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## TrackedResourceTags +## DatabaseVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## DatabaseBlobAuditingPolicyProperties +## DatabaseVulnerabilityAssessmentRuleBaselineItem +### Properties +* **result**: string[] (Required): The rule baseline result + +## DatabaseVulnerabilityAssessmentRuleBaselineProperties +### Properties +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result + +## ElasticPoolPerDatabaseSettings +### Properties +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. + +## ElasticPoolProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. + +## EncryptionProtectorProperties +### Properties +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1112,6 +844,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1125,11 +858,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1200,6 +929,16 @@ Note that for server level audit you should use the 'master' database as {databa 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) +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true + +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -1217,138 +956,347 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## MaintenanceWindowsProperties +## FailoverGroupProperties +### Properties +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## FailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. + +## MaintenanceWindowsProperties +### Properties +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## MaintenanceWindowTimeRange +## ManagedInstanceEncryptionProtectorProperties ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## SyncGroupProperties +## ManagedInstanceKeyProperties ### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. -## SyncGroupSchema +## ManagedInstancePairInfo ### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. -## SyncGroupSchemaTable +## ManagedInstancePecProperty ### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## SyncGroupSchemaTableColumn +## ManagedInstancePrivateEndpointConnectionProperties ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. -## SyncMemberProperties +## ManagedInstancePrivateEndpointProperty ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **id**: string: Resource id of the private endpoint. -## TransparentDataEncryptionProperties +## ManagedInstancePrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. + +## ManagedInstanceProperties +### Properties +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **collation**: string: Collation of the managed instance. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. + +## ManagedInstanceVulnerabilityAssessmentProperties +### Properties +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. + +## ManagedTransparentDataEncryptionProperties ### Properties * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## WorkloadGroupProperties +## PartnerInfo ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadClassifierProperties +## PartnerRegionInfo ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## ServerDevOpsAuditSettingsProperties +## PrivateEndpointConnectionProperties ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## ServerDnsAliasProperties +## PrivateEndpointProperty ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **id**: string: Resource id of the private endpoint. -## ElasticPoolProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ElasticPoolPerDatabaseSettings +## ResourceIdentity ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -## TrackedResourceTags +## SecurityAlertPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SecurityAlertsPolicyProperties ### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## ExtendedServerBlobAuditingPolicyProperties +## SensitivityLabelProperties +### Properties +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. + +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1432,7 +1380,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1446,156 +1393,192 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerFirewallRuleProperties ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. -## PartnerInfo +## ServerInfo ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **serverId**: string (Required): Server Id. -## FailoverGroupReadOnlyEndpoint +## ServerKeyProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. -## FailoverGroupReadWriteEndpoint +## ServerPrivateEndpointConnection ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## FailoverGroupTags +## ServerProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. -## ServerFirewallRuleProperties +## ServerTrustGroupProperties ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | string[] (Required): Trust scope of the server trust group. -## JobAgentProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## TrackedResourceTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## JobCredentialProperties +## SqlAgentConfigurationProperties ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## JobProperties +## SyncAgentProperties ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## JobSchedule +## SyncGroupProperties ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobExecutionProperties +## SyncGroupSchema ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobExecutionTarget +## SyncGroupSchemaTable ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobStepProperties +## SyncGroupSchemaTableColumn ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobStepAction +## SyncMemberProperties ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobStepExecutionOptions +## SystemData ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. +### Additional Properties +* **Additional Properties Type**: string -## SyncAgentProperties +## TrackedResourceTags ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TransparentDataEncryptionProperties +### Properties +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. ## VirtualNetworkRuleProperties ### Properties @@ -1603,10 +1586,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sql/microsoft.sql/2020-08-01-preview/types.md b/generated/sql/microsoft.sql/2020-08-01-preview/types.md index 02e63081bf..b2ce500bd6 100644 --- a/generated/sql/microsoft.sql/2020-08-01-preview/types.md +++ b/generated/sql/microsoft.sql/2020-08-01-preview/types.md @@ -581,165 +581,21 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties -### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. - -## Sku -### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstanceFailoverGroupProperties -### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. - -## ManagedInstancePairInfo -### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. - -## PartnerRegionInfo -### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. - -## InstanceFailoverGroupReadOnlyEndpoint -### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. - -## InstanceFailoverGroupReadWriteEndpoint -### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. - -## ServerTrustGroupProperties -### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | string[] (Required): Trust scope of the server trust group. - -## ServerInfo -### Properties -* **serverId**: string (Required): Server Id. - -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. - -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **collation**: string: Collation of the managed instance. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this database. -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties +## AdministratorProperties ### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. -## ManagedInstanceAzureADOnlyAuthProperties +## AzureADOnlyAuthProperties ### Properties * **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags +## BackupShortTermRetentionPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ## BaseLongTermRetentionPolicyProperties ### Properties @@ -748,151 +604,7 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. * **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties -### Properties -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## SqlAgentConfigurationProperties -### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. - -## ManagedInstanceVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. -* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerBlobAuditingPolicyProperties +## DatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -955,23 +667,13 @@ 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) * **isAzureMonitorTargetEnabled**: bool: 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true +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 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. +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/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview +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) @@ -989,9 +691,12 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties +## DatabaseExtensionsProperties ### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. +* **operationMode**: 'PolybaseImport' | string (Required, WriteOnly): Operation Mode. +* **storageKey**: string (Required, WriteOnly): Storage key. +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. +* **storageUri**: string (Required, WriteOnly): Storage Uri. ## DatabaseProperties ### Properties @@ -1046,12 +751,46 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## TrackedResourceTags +## DatabaseVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## DatabaseBlobAuditingPolicyProperties +## DatabaseVulnerabilityAssessmentRuleBaselineItem +### Properties +* **result**: string[] (Required): The rule baseline result + +## DatabaseVulnerabilityAssessmentRuleBaselineProperties +### Properties +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result + +## ElasticPoolPerDatabaseSettings +### Properties +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. + +## ElasticPoolProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. + +## EncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1125,6 +864,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1138,11 +878,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1213,6 +949,16 @@ Note that for server level audit you should use the 'master' database as {databa 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) +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true + +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -1230,147 +976,348 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DatabaseExtensionsProperties +## FailoverGroupProperties +### Properties +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## FailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. + +## MaintenanceWindowsProperties +### Properties +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties +### Properties +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. + +## ManagedInstanceEncryptionProtectorProperties ### Properties -* **operationMode**: 'PolybaseImport' | string (Required, WriteOnly): Operation Mode. -* **storageKey**: string (Required, WriteOnly): Storage key. -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. -* **storageUri**: string (Required, WriteOnly): Storage Uri. +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## MaintenanceWindowsProperties +## ManagedInstanceKeyProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. -## MaintenanceWindowTimeRange +## ManagedInstancePairInfo ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. -## SyncGroupProperties +## ManagedInstancePecProperty ### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## SyncGroupSchema +## ManagedInstancePrivateEndpointConnectionProperties ### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. -## SyncGroupSchemaTable +## ManagedInstancePrivateEndpointProperty ### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. +* **id**: string: Resource id of the private endpoint. -## SyncGroupSchemaTableColumn +## ManagedInstancePrivateLinkServiceConnectionStateProperty ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. -## SyncMemberProperties +## ManagedInstanceProperties ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **collation**: string: Collation of the managed instance. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this database. +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. -## TransparentDataEncryptionProperties +## ManagedInstanceVulnerabilityAssessmentProperties +### Properties +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. + +## ManagedTransparentDataEncryptionProperties ### Properties * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## WorkloadGroupProperties +## PartnerInfo ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadClassifierProperties +## PartnerRegionInfo ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## ServerDevOpsAuditSettingsProperties +## PrivateEndpointConnectionProperties ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## ServerDnsAliasProperties +## PrivateEndpointProperty ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **id**: string: Resource id of the private endpoint. -## ElasticPoolProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ElasticPoolPerDatabaseSettings +## ResourceIdentity ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -## TrackedResourceTags +## SecurityAlertPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SecurityAlertsPolicyProperties ### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## ExtendedServerBlobAuditingPolicyProperties +## SensitivityLabelProperties +### Properties +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. + +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1454,7 +1401,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1468,156 +1414,193 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerFirewallRuleProperties ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. -## PartnerInfo +## ServerInfo ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **serverId**: string (Required): Server Id. -## FailoverGroupReadOnlyEndpoint +## ServerKeyProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. -## FailoverGroupReadWriteEndpoint +## ServerPrivateEndpointConnection ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## FailoverGroupTags +## ServerProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. +* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace -## ServerFirewallRuleProperties +## ServerTrustGroupProperties ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | string[] (Required): Trust scope of the server trust group. -## JobAgentProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## TrackedResourceTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## JobCredentialProperties +## SqlAgentConfigurationProperties ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## JobProperties +## SyncAgentProperties ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## JobSchedule +## SyncGroupProperties ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobExecutionProperties +## SyncGroupSchema ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobExecutionTarget +## SyncGroupSchemaTable ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobStepProperties +## SyncGroupSchemaTableColumn ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobStepAction +## SyncMemberProperties ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobStepExecutionOptions +## SystemData ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. +### Additional Properties +* **Additional Properties Type**: string -## SyncAgentProperties +## TrackedResourceTags ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TransparentDataEncryptionProperties +### Properties +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. ## VirtualNetworkRuleProperties ### Properties @@ -1625,10 +1608,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sql/microsoft.sql/2020-11-01-preview/types.md b/generated/sql/microsoft.sql/2020-11-01-preview/types.md index 7e5331cdfd..4942664e07 100644 --- a/generated/sql/microsoft.sql/2020-11-01-preview/types.md +++ b/generated/sql/microsoft.sql/2020-11-01-preview/types.md @@ -581,188 +581,21 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties -### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. - -## Sku -### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstanceFailoverGroupProperties -### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. - -## ManagedInstancePairInfo -### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. - -## PartnerRegionInfo -### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. - -## InstanceFailoverGroupReadOnlyEndpoint -### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. - -## InstanceFailoverGroupReadWriteEndpoint -### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. - -## ServerTrustGroupProperties -### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. - -## ServerInfo -### Properties -* **serverId**: string (Required): Server Id. - -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use - -## ResourceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) - -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. - -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. -* **collation**: string: Collation of the managed instance. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstanceExternalAdministrator +## AdministratorProperties ### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. * **tenantId**: string: Tenant ID of the administrator. -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. - -## ManagedInstanceAzureADOnlyAuthProperties +## AzureADOnlyAuthProperties ### Properties * **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags +## BackupShortTermRetentionPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ## BaseLongTermRetentionPolicyProperties ### Properties @@ -771,164 +604,7 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. * **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties -### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## SqlAgentConfigurationProperties -### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. - -## ManagedInstanceVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. -* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace - -## ServerExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerBlobAuditingPolicyProperties +## DatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -996,16 +672,6 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -1022,9 +688,12 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties +## DatabaseExtensionsProperties ### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. +* **operationMode**: 'PolybaseImport' | string (Required, WriteOnly): Operation Mode. +* **storageKey**: string (Required, WriteOnly): Storage key. +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. +* **storageUri**: string (Required, WriteOnly): Storage Uri. ## DatabaseProperties ### Properties @@ -1080,12 +749,46 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Suspect' | string (ReadOnly): The status of the database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## TrackedResourceTags +## DatabaseVulnerabilityAssessmentProperties +### Properties +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. + +## DatabaseVulnerabilityAssessmentRuleBaselineItem +### Properties +* **result**: string[] (Required): The rule baseline result + +## DatabaseVulnerabilityAssessmentRuleBaselineProperties +### Properties +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result + +## ElasticPoolPerDatabaseSettings +### Properties +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. + +## ElasticPoolProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. + +## EncryptionProtectorProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## DatabaseBlobAuditingPolicyProperties +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1156,6 +859,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1169,11 +873,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1241,6 +941,16 @@ Note that for server level audit you should use the 'master' database as {databa 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) +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true + +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -1258,147 +968,367 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DatabaseExtensionsProperties +## FailoverGroupProperties ### Properties -* **operationMode**: 'PolybaseImport' | string (Required, WriteOnly): Operation Mode. -* **storageKey**: string (Required, WriteOnly): Storage key. -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. -* **storageUri**: string (Required, WriteOnly): Storage Uri. +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## FailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. + +## MaintenanceWindowsProperties +### Properties +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties +### Properties +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. + +## ManagedInstanceEncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ManagedInstanceExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ManagedInstanceKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ManagedInstancePairInfo +### Properties +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. + +## ManagedInstancePecProperty +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## MaintenanceWindowsProperties +## ManagedInstancePrivateEndpointConnectionProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. -## MaintenanceWindowTimeRange +## ManagedInstancePrivateEndpointProperty ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **id**: string: Resource id of the private endpoint. -## SyncGroupProperties +## ManagedInstancePrivateLinkServiceConnectionStateProperty ### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. -## SyncGroupSchema +## ManagedInstanceProperties ### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. +* **collation**: string: Collation of the managed instance. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. -## SyncGroupSchemaTable +## ManagedInstanceVulnerabilityAssessmentProperties ### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## SyncGroupSchemaTableColumn +## ManagedTransparentDataEncryptionProperties ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## SyncMemberProperties +## PartnerInfo ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## TransparentDataEncryptionProperties +## PartnerRegionInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadGroupProperties +## PrivateEndpointConnectionProperties ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## WorkloadClassifierProperties +## PrivateEndpointProperty ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **id**: string: Resource id of the private endpoint. -## ServerDevOpsAuditSettingsProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ServerDnsAliasProperties +## ResourceIdentity ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ElasticPoolProperties +## ResourceIdentityUserAssignedIdentities ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ElasticPoolPerDatabaseSettings +## SecurityAlertPolicyProperties ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## TrackedResourceTags +## SecurityAlertsPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SensitivityLabelProperties ### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## ExtendedServerBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1479,7 +1409,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1493,157 +1422,211 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ServerFirewallRuleProperties +### Properties +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. + +## ServerInfo +### Properties +* **serverId**: string (Required): Server Id. + +## ServerKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ServerPrivateEndpointConnection ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## PartnerInfo +## ServerProperties ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. +* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace -## FailoverGroupReadOnlyEndpoint +## ServerTrustGroupProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. -## FailoverGroupReadWriteEndpoint +## ServerVulnerabilityAssessmentProperties ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## FailoverGroupTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## ServerFirewallRuleProperties +## SqlAgentConfigurationProperties ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## JobAgentProperties +## SyncAgentProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## TrackedResourceTags +## SyncGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobCredentialProperties +## SyncGroupSchema ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobProperties +## SyncGroupSchemaTable ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobSchedule +## SyncGroupSchemaTableColumn ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobExecutionProperties +## SyncMemberProperties ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobExecutionTarget +## SystemData ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepProperties +## TrackedResourceTags ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +### Additional Properties +* **Additional Properties Type**: string -## JobStepAction +## TrackedResourceTags ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +### Additional Properties +* **Additional Properties Type**: string -## JobStepExecutionOptions +## TrackedResourceTags ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +### Additional Properties +* **Additional Properties Type**: string -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. +### Additional Properties +* **Additional Properties Type**: string -## SyncAgentProperties +## TransparentDataEncryptionProperties ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. ## VirtualNetworkRuleProperties ### Properties @@ -1651,10 +1634,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sql/microsoft.sql/2021-02-01-preview/types.md b/generated/sql/microsoft.sql/2021-02-01-preview/types.md index 96c4b1a671..a63ba0a6e2 100644 --- a/generated/sql/microsoft.sql/2021-02-01-preview/types.md +++ b/generated/sql/microsoft.sql/2021-02-01-preview/types.md @@ -599,188 +599,22 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties -### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. - -## Sku -### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## InstanceFailoverGroupProperties -### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. - -## ManagedInstancePairInfo -### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. - -## PartnerRegionInfo -### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. - -## InstanceFailoverGroupReadOnlyEndpoint -### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. - -## InstanceFailoverGroupReadWriteEndpoint -### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. - -## ServerTrustGroupProperties -### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. - -## ServerInfo -### Properties -* **serverId**: string (Required): Server Id. - -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use - -## ResourceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) - -## UserIdentity -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. - -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. -* **collation**: string: Collation of the managed instance. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstanceExternalAdministrator +## AdministratorProperties ### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. * **tenantId**: string: Tenant ID of the administrator. -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. - -## ManagedInstanceAzureADOnlyAuthProperties +## AzureADOnlyAuthProperties ### Properties * **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags +## BackupShortTermRetentionPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ## BaseLongTermRetentionPolicyProperties ### Properties @@ -789,166 +623,7 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. * **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties -### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## SqlAgentConfigurationProperties -### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. - -## ManagedInstanceVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. -* **federatedClientId**: string: The Client id used for cross tenant CMK scenario -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. -* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace - -## ServerExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerBlobAuditingPolicyProperties +## DatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1020,16 +695,6 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -1046,9 +711,12 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties +## DatabaseExtensionsProperties ### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. +* **operationMode**: 'PolybaseImport' | string (Required, WriteOnly): Operation Mode. +* **storageKey**: string (Required, WriteOnly): Storage key. +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. +* **storageUri**: string (Required, WriteOnly): Storage Uri. ## DatabaseProperties ### Properties @@ -1106,12 +774,46 @@ Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWa * **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Suspect' | string (ReadOnly): The status of the database. * **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## TrackedResourceTags +## DatabaseVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. + +## DatabaseVulnerabilityAssessmentRuleBaselineItem +### Properties +* **result**: string[] (Required): The rule baseline result + +## DatabaseVulnerabilityAssessmentRuleBaselineProperties +### Properties +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result + +## ElasticPoolPerDatabaseSettings +### Properties +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. + +## ElasticPoolProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. + +## EncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## DatabaseBlobAuditingPolicyProperties +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1186,6 +888,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1199,12 +902,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BackupShortTermRetentionPolicyProperties -### Properties -* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1276,6 +974,16 @@ Note that for server level audit you should use the 'master' database as {databa 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) +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true + +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -1293,152 +1001,376 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DatabaseExtensionsProperties +## FailoverGroupProperties ### Properties -* **operationMode**: 'PolybaseImport' | string (Required, WriteOnly): Operation Mode. -* **storageKey**: string (Required, WriteOnly): Storage key. -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. -* **storageUri**: string (Required, WriteOnly): Storage Uri. +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## FailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. ## LedgerDigestUploadsProperties ### Properties * **digestStorageEndpoint**: string: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. * **state**: 'Disabled' | 'Enabled' (ReadOnly): Specifies the state of ledger digest upload. -## MaintenanceWindowsProperties +## MaintenanceWindowsProperties +### Properties +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties +### Properties +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. + +## ManagedInstanceEncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ManagedInstanceExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ManagedInstanceKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ManagedInstancePairInfo +### Properties +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. + +## ManagedInstancePecProperty +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ManagedInstancePrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. + +## ManagedInstancePrivateEndpointProperty ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **id**: string: Resource id of the private endpoint. -## MaintenanceWindowTimeRange +## ManagedInstancePrivateLinkServiceConnectionStateProperty ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. -## SyncGroupProperties +## ManagedInstanceProperties ### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. +* **collation**: string: Collation of the managed instance. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage) +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. -## SyncGroupSchema +## ManagedInstanceVulnerabilityAssessmentProperties ### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## SyncGroupSchemaTable +## ManagedTransparentDataEncryptionProperties ### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## SyncGroupSchemaTableColumn +## OutboundFirewallRuleProperties ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **provisioningState**: string (ReadOnly): The state of the outbound rule. -## SyncMemberProperties +## PartnerInfo ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## TransparentDataEncryptionProperties +## PartnerRegionInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadGroupProperties +## PrivateEndpointConnectionProperties ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## WorkloadClassifierProperties +## PrivateEndpointProperty ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **id**: string: Resource id of the private endpoint. -## ServerDevOpsAuditSettingsProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ServerDnsAliasProperties +## ResourceIdentity ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ElasticPoolProperties +## ResourceIdentityUserAssignedIdentities ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ElasticPoolPerDatabaseSettings +## SecurityAlertPolicyProperties ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## TrackedResourceTags +## SecurityAlertsPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SensitivityLabelProperties ### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## ExtendedServerBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1523,7 +1455,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1537,161 +1468,213 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ServerFirewallRuleProperties +### Properties +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. + +## ServerInfo +### Properties +* **serverId**: string (Required): Server Id. + +## ServerKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ServerPrivateEndpointConnection ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## PartnerInfo +## ServerProperties ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. +* **federatedClientId**: string: The Client id used for cross tenant CMK scenario +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. +* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace -## FailoverGroupReadOnlyEndpoint +## ServerTrustGroupProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. -## FailoverGroupReadWriteEndpoint +## ServerVulnerabilityAssessmentProperties ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## FailoverGroupTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## ServerFirewallRuleProperties +## SqlAgentConfigurationProperties ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## JobAgentProperties +## SyncAgentProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## TrackedResourceTags +## SyncGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobCredentialProperties +## SyncGroupSchema ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobProperties +## SyncGroupSchemaTable ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobSchedule +## SyncGroupSchemaTableColumn ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobExecutionProperties +## SyncMemberProperties ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobExecutionTarget +## SystemData ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepProperties +## TrackedResourceTags ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +### Additional Properties +* **Additional Properties Type**: string -## JobStepAction +## TrackedResourceTags ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +### Additional Properties +* **Additional Properties Type**: string -## JobStepExecutionOptions +## TrackedResourceTags ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +### Additional Properties +* **Additional Properties Type**: string -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. +### Additional Properties +* **Additional Properties Type**: string -## OutboundFirewallRuleProperties +## TransparentDataEncryptionProperties ### Properties -* **provisioningState**: string (ReadOnly): The state of the outbound rule. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## SyncAgentProperties +## UserIdentity ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. ## VirtualNetworkRuleProperties ### Properties @@ -1699,10 +1682,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sql/microsoft.sql/2021-05-01-preview/types.md b/generated/sql/microsoft.sql/2021-05-01-preview/types.md index 203d845988..af9809960e 100644 --- a/generated/sql/microsoft.sql/2021-05-01-preview/types.md +++ b/generated/sql/microsoft.sql/2021-05-01-preview/types.md @@ -629,258 +629,234 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties +## AdministratorProperties ### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. -## Sku +## AzureADOnlyAuthProperties ### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## TrackedResourceTags +## BackupShortTermRetentionPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. -## InstanceFailoverGroupProperties +## BaseLongTermRetentionPolicyProperties ### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. +* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. +* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. +* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## ManagedInstancePairInfo +## DatabaseBlobAuditingPolicyProperties ### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. +* **auditActionsAndGroups**: string[]: 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 +LEDGER_OPERATION_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) +* **isAzureMonitorTargetEnabled**: bool: 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) +* **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. +* **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## PartnerRegionInfo +## DatabaseExtensionsProperties ### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **administratorLogin**: string (WriteOnly): Administrator login name. +* **administratorLoginPassword**: string (WriteOnly): Administrator login password. +* **authenticationType**: string (WriteOnly): Authentication type: SQL authentication or AD password. +* **databaseEdition**: string (WriteOnly): Database edition for the newly created database in the case of an import operation. +* **maxSizeBytes**: string (WriteOnly): Database max size in bytes for the newly created database in the case of an import operation. +* **networkIsolation**: [NetworkIsolationSettings](#networkisolationsettings) (WriteOnly): Contains the ARM resources for which to create private endpoint connection. +* **operationMode**: 'Export' | 'Import' | 'PolybaseImport' | string (Required, WriteOnly): Operation mode of the operation: Import, Export, or PolybaseImport. +* **serviceObjectiveName**: string (WriteOnly): Database service level objective for the newly created database in the case of an import operation. +* **storageKey**: string (Required, WriteOnly): Storage key for the storage account. +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. +* **storageUri**: string (Required, WriteOnly): Storage Uri for the storage account. -## InstanceFailoverGroupReadOnlyEndpoint +## DatabaseIdentity ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'UserAssigned' | string: The identity type +* **userAssignedIdentities**: [DatabaseIdentityUserAssignedIdentities](#databaseidentityuserassignedidentities): The resource ids of the user assigned identities to use -## InstanceFailoverGroupReadWriteEndpoint +## DatabaseIdentityUserAssignedIdentities ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +### Additional Properties +* **Additional Properties Type**: [DatabaseUserIdentity](#databaseuseridentity) -## ServerTrustGroupProperties +## DatabaseProperties ### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. +* **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: The collation of the database. +* **createMode**: 'Copy' | 'Default' | 'OnlineSecondary' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 'RestoreExternalBackup' | 'RestoreExternalBackupSecondary' | 'RestoreLongTermRetentionBackup' | 'Secondary' | string (WriteOnly): 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. +* **creationDate**: string (ReadOnly): The creation date of the database (ISO8601 format). +* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. +* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the database. +* **currentSku**: [Sku](#sku) (ReadOnly): An ARM Resource SKU. +* **databaseId**: string (ReadOnly): The ID of the database. +* **defaultSecondaryLocation**: string (ReadOnly): The default secondary region for this database. +* **earliestRestoreDate**: string (ReadOnly): This records the earliest start date and time that restore is available for this database (ISO8601 format). +* **elasticPoolId**: string: The resource identifier of the elastic pool containing this database. +* **failoverGroupId**: string (ReadOnly): Failover Group resource identifier that this database belongs to. +* **federatedClientId**: string: The Client id used for cross tenant per database CMK scenario +* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. +* **isInfraEncryptionEnabled**: bool (ReadOnly): Infra encryption is enabled for this database. +* **isLedgerOn**: bool: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The resource identifier of the long term retention backup associated with create operation of this database. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. +* **maxLogSizeBytes**: int (ReadOnly): The max log size for this database. +* **maxSizeBytes**: int: The max size of the database expressed in bytes. +* **minCapacity**: int: Minimal capacity that database will always have allocated, if not paused +* **pausedDate**: string (ReadOnly): The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. +* **readScale**: 'Disabled' | 'Enabled' | string: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **recoveryServicesRecoveryPointId**: string (WriteOnly): The resource identifier of the recovery point associated with create operation of this database. +* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. +* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The resource identifier of the restorable dropped database associated with create operation of this database. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **resumedDate**: string (ReadOnly): The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. +* **sampleName**: 'AdventureWorksLT' | 'WideWorldImportersFull' | 'WideWorldImportersStd' | string (WriteOnly): The name of the sample schema to apply when creating this database. +* **secondaryType**: 'Geo' | 'Named' | string: The secondary type of the database if it is a secondary. Valid values are Geo and Named. +* **sourceDatabaseDeletionDate**: string (WriteOnly): Specifies the time that the database was deleted. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **sourceResourceId**: string (WriteOnly): The resource identifier of the source associated with the create operation of this database. + +When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. + +When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of an existing database or existing sql pool, and restorePointInTime must be specified. + +When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. + +When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. + +This property allows to restore across subscriptions which is only supported for DataWarehouse edition. + +When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant +* **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Starting' | 'Stopped' | 'Stopping' | 'Suspect' | string (ReadOnly): The status of the database. +* **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## ServerInfo +## DatabaseUserIdentity ### Properties -* **serverId**: string (Required): Server Id. +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -## ResourceIdentity +## DatabaseVulnerabilityAssessmentProperties ### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## ResourceIdentityUserAssignedIdentities +## DatabaseVulnerabilityAssessmentRuleBaselineItem ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **result**: string[] (Required): The rule baseline result -## UserIdentity +## DatabaseVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. -* **collation**: string: Collation of the managed instance. -* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **servicePrincipal**: [ServicePrincipal](#serviceprincipal): The managed instance's service principal configuration for a resource. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstanceExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## ServicePrincipal -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory application client id. -* **principalId**: string (ReadOnly): The Azure Active Directory application object id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | string: Service principal type. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. - -## ManagedInstanceAzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BaseLongTermRetentionPolicyProperties -### Properties -* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. -* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. -* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. -* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. - -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## DistributedAvailabilityGroupProperties +## DistributedAvailabilityGroupProperties ### Properties * **distributedAvailabilityGroupId**: string (ReadOnly): The distributed availability group id * **lastHardenedLsn**: string (ReadOnly): The last hardened lsn @@ -893,121 +869,31 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **targetDatabase**: string: The name of the target database * **targetReplicaId**: string (ReadOnly): The target replica id -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties -### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ServerTrustCertificateProperties -### Properties -* **certificateName**: string (ReadOnly): The certificate name -* **publicBlob**: string: The certificate public blob -* **thumbprint**: string (ReadOnly): The certificate thumbprint - -## SqlAgentConfigurationProperties +## ElasticPoolPerDatabaseSettings ### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. -## ManagedInstanceVulnerabilityAssessmentProperties +## ElasticPoolProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. -## ServerProperties +## EncryptionProtectorProperties ### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. -* **federatedClientId**: string: The Client id used for cross tenant CMK scenario -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. -* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## ServerExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[] (ReadOnly): Group IDs. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerBlobAuditingPolicyProperties +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1079,19 +965,10 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1105,106 +982,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - -## ServerConnectionPolicyProperties -### Properties -* **connectionType**: 'Default' | 'Proxy' | 'Redirect' | string (Required): The server connection type. - -## DatabaseIdentity -### Properties -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'UserAssigned' | string: The identity type -* **userAssignedIdentities**: [DatabaseIdentityUserAssignedIdentities](#databaseidentityuserassignedidentities): The resource ids of the user assigned identities to use - -## DatabaseIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [DatabaseUserIdentity](#databaseuseridentity) - -## DatabaseUserIdentity -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. - -## DatabaseProperties -### Properties -* **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: The collation of the database. -* **createMode**: 'Copy' | 'Default' | 'OnlineSecondary' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 'RestoreExternalBackup' | 'RestoreExternalBackupSecondary' | 'RestoreLongTermRetentionBackup' | 'Secondary' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): The creation date of the database (ISO8601 format). -* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. -* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the database. -* **currentSku**: [Sku](#sku) (ReadOnly): An ARM Resource SKU. -* **databaseId**: string (ReadOnly): The ID of the database. -* **defaultSecondaryLocation**: string (ReadOnly): The default secondary region for this database. -* **earliestRestoreDate**: string (ReadOnly): This records the earliest start date and time that restore is available for this database (ISO8601 format). -* **elasticPoolId**: string: The resource identifier of the elastic pool containing this database. -* **failoverGroupId**: string (ReadOnly): Failover Group resource identifier that this database belongs to. -* **federatedClientId**: string: The Client id used for cross tenant per database CMK scenario -* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. -* **isInfraEncryptionEnabled**: bool (ReadOnly): Infra encryption is enabled for this database. -* **isLedgerOn**: bool: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The resource identifier of the long term retention backup associated with create operation of this database. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. -* **maxLogSizeBytes**: int (ReadOnly): The max log size for this database. -* **maxSizeBytes**: int: The max size of the database expressed in bytes. -* **minCapacity**: int: Minimal capacity that database will always have allocated, if not paused -* **pausedDate**: string (ReadOnly): The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. -* **readScale**: 'Disabled' | 'Enabled' | string: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **recoveryServicesRecoveryPointId**: string (WriteOnly): The resource identifier of the recovery point associated with create operation of this database. -* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. -* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The resource identifier of the restorable dropped database associated with create operation of this database. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **resumedDate**: string (ReadOnly): The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. -* **sampleName**: 'AdventureWorksLT' | 'WideWorldImportersFull' | 'WideWorldImportersStd' | string (WriteOnly): The name of the sample schema to apply when creating this database. -* **secondaryType**: 'Geo' | 'Named' | string: The secondary type of the database if it is a secondary. Valid values are Geo and Named. -* **sourceDatabaseDeletionDate**: string (WriteOnly): Specifies the time that the database was deleted. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **sourceResourceId**: string (WriteOnly): The resource identifier of the source associated with the create operation of this database. - -When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. - -When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of an existing database or existing sql pool, and restorePointInTime must be specified. - -When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. - -When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. - -This property allows to restore across subscriptions which is only supported for DataWarehouse edition. - -When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant -* **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Starting' | 'Stopped' | 'Stopping' | 'Suspect' | string (ReadOnly): The status of the database. -* **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1278,96 +1056,13 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) -* **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **queueDelayMs**: int: 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. -* **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. - -## BackupShortTermRetentionPolicyProperties -### Properties -* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties -### Properties -* **auditActionsAndGroups**: string[]: 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 -LEDGER_OPERATION_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) -* **isAzureMonitorTargetEnabled**: bool: 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. +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' 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}. +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. 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 +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) @@ -1386,164 +1081,384 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DatabaseExtensionsProperties +## FailoverGroupProperties +### Properties +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## FailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. + +## LedgerDigestUploadsProperties +### Properties +* **digestStorageEndpoint**: string: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. +* **state**: 'Disabled' | 'Enabled' (ReadOnly): Specifies the state of ledger digest upload. + +## MaintenanceWindowsProperties +### Properties +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties +### Properties +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. + +## ManagedInstanceEncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ManagedInstanceExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ManagedInstanceKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ManagedInstancePairInfo +### Properties +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. + +## ManagedInstancePecProperty +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ManagedInstancePrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. + +## ManagedInstancePrivateEndpointProperty +### Properties +* **id**: string: Resource id of the private endpoint. + +## ManagedInstancePrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. + +## ManagedInstanceProperties +### Properties +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. +* **collation**: string: Collation of the managed instance. +* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **servicePrincipal**: [ServicePrincipal](#serviceprincipal): The managed instance's service principal configuration for a resource. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. + +## ManagedInstanceVulnerabilityAssessmentProperties +### Properties +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall + +## ManagedTransparentDataEncryptionProperties ### Properties -* **administratorLogin**: string (WriteOnly): Administrator login name. -* **administratorLoginPassword**: string (WriteOnly): Administrator login password. -* **authenticationType**: string (WriteOnly): Authentication type: SQL authentication or AD password. -* **databaseEdition**: string (WriteOnly): Database edition for the newly created database in the case of an import operation. -* **maxSizeBytes**: string (WriteOnly): Database max size in bytes for the newly created database in the case of an import operation. -* **networkIsolation**: [NetworkIsolationSettings](#networkisolationsettings) (WriteOnly): Contains the ARM resources for which to create private endpoint connection. -* **operationMode**: 'Export' | 'Import' | 'PolybaseImport' | string (Required, WriteOnly): Operation mode of the operation: Import, Export, or PolybaseImport. -* **serviceObjectiveName**: string (WriteOnly): Database service level objective for the newly created database in the case of an import operation. -* **storageKey**: string (Required, WriteOnly): Storage key for the storage account. -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type. -* **storageUri**: string (Required, WriteOnly): Storage Uri for the storage account. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. ## NetworkIsolationSettings ### Properties * **sqlServerResourceId**: string (WriteOnly): The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. * **storageAccountResourceId**: string (WriteOnly): The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. -## LedgerDigestUploadsProperties -### Properties -* **digestStorageEndpoint**: string: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. -* **state**: 'Disabled' | 'Enabled' (ReadOnly): Specifies the state of ledger digest upload. - -## MaintenanceWindowsProperties -### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange - -## MaintenanceWindowTimeRange -### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. - -## SyncGroupProperties -### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. - -## SyncGroupSchema -### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. - -## SyncGroupSchemaTable -### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. - -## SyncGroupSchemaTableColumn +## OutboundFirewallRuleProperties ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **provisioningState**: string (ReadOnly): The state of the outbound rule. -## SyncMemberProperties +## PartnerInfo ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## TransparentDataEncryptionProperties +## PartnerRegionInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadGroupProperties +## PrivateEndpointConnectionProperties ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **groupIds**: string[] (ReadOnly): Group IDs. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## WorkloadClassifierProperties +## PrivateEndpointProperty ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **id**: string: Resource id of the private endpoint. -## ServerDevOpsAuditSettingsProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ServerDnsAliasProperties +## ResourceIdentity ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ElasticPoolProperties +## ResourceIdentityUserAssignedIdentities ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ElasticPoolPerDatabaseSettings +## SecurityAlertPolicyProperties ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## TrackedResourceTags +## SecurityAlertsPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SensitivityLabelProperties ### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## ExtendedServerBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1628,7 +1543,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1642,161 +1556,230 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerConnectionPolicyProperties +### Properties +* **connectionType**: 'Default' | 'Proxy' | 'Redirect' | string (Required): The server connection type. + +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ServerFirewallRuleProperties +### Properties +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. + +## ServerInfo +### Properties +* **serverId**: string (Required): Server Id. + +## ServerKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ServerProperties +### Properties +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. +* **federatedClientId**: string: The Client id used for cross tenant CMK scenario +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. +* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace + +## ServerTrustCertificateProperties ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **certificateName**: string (ReadOnly): The certificate name +* **publicBlob**: string: The certificate public blob +* **thumbprint**: string (ReadOnly): The certificate thumbprint -## PartnerInfo +## ServerTrustGroupProperties ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. -## FailoverGroupReadOnlyEndpoint +## ServerVulnerabilityAssessmentProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## FailoverGroupReadWriteEndpoint +## ServicePrincipal ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **clientId**: string (ReadOnly): The Azure Active Directory application client id. +* **principalId**: string (ReadOnly): The Azure Active Directory application object id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | string: Service principal type. -## FailoverGroupTags +## Sku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## ServerFirewallRuleProperties +## SqlAgentConfigurationProperties ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## JobAgentProperties +## SyncAgentProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## TrackedResourceTags +## SyncGroupProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobCredentialProperties +## SyncGroupSchema ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobProperties +## SyncGroupSchemaTable ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobSchedule +## SyncGroupSchemaTableColumn ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobExecutionProperties +## SyncMemberProperties ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobExecutionTarget +## SystemData ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepProperties +## TrackedResourceTags ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +### Additional Properties +* **Additional Properties Type**: string -## JobStepAction +## TrackedResourceTags ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +### Additional Properties +* **Additional Properties Type**: string -## JobStepExecutionOptions +## TrackedResourceTags ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +### Additional Properties +* **Additional Properties Type**: string -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. +### Additional Properties +* **Additional Properties Type**: string -## OutboundFirewallRuleProperties +## TransparentDataEncryptionProperties ### Properties -* **provisioningState**: string (ReadOnly): The state of the outbound rule. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## SyncAgentProperties +## UserIdentity ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. ## VirtualNetworkRuleProperties ### Properties @@ -1804,10 +1787,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sql/microsoft.sql/2021-08-01-preview/types.md b/generated/sql/microsoft.sql/2021-08-01-preview/types.md index 835e65af61..9f9184965e 100644 --- a/generated/sql/microsoft.sql/2021-08-01-preview/types.md +++ b/generated/sql/microsoft.sql/2021-08-01-preview/types.md @@ -638,258 +638,234 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties +## AdministratorProperties ### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. -## Sku +## AzureADOnlyAuthProperties ### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## TrackedResourceTags +## BackupShortTermRetentionPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. -## InstanceFailoverGroupProperties +## BaseLongTermRetentionPolicyProperties ### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. +* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. +* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. +* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## ManagedInstancePairInfo +## DatabaseBlobAuditingPolicyProperties ### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. +* **auditActionsAndGroups**: string[]: 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 +LEDGER_OPERATION_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) +* **isAzureMonitorTargetEnabled**: bool: 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) +* **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. +* **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## PartnerRegionInfo +## DatabaseExtensionsProperties ### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **administratorLogin**: string (WriteOnly): Administrator login name. +* **administratorLoginPassword**: string (WriteOnly): Administrator login password. +* **authenticationType**: string (WriteOnly): Authentication type: SQL authentication or AD password. +* **databaseEdition**: string (WriteOnly): Database edition for the newly created database in the case of an import operation. +* **maxSizeBytes**: string (WriteOnly): Database max size in bytes for the newly created database in the case of an import operation. +* **networkIsolation**: [NetworkIsolationSettings](#networkisolationsettings) (WriteOnly): Contains the ARM resources for which to create private endpoint connection. +* **operationMode**: 'Export' | 'Import' | 'PolybaseImport' | string (Required, WriteOnly): Operation mode of the operation: Import, Export, or PolybaseImport. +* **serviceObjectiveName**: string (WriteOnly): Database service level objective for the newly created database in the case of an import operation. +* **storageKey**: string (Required, WriteOnly): Storage key for the storage account. +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type: StorageAccessKey or SharedAccessKey. +* **storageUri**: string (Required, WriteOnly): Storage Uri for the storage account. -## InstanceFailoverGroupReadOnlyEndpoint +## DatabaseIdentity ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'UserAssigned' | string: The identity type +* **userAssignedIdentities**: [DatabaseIdentityUserAssignedIdentities](#databaseidentityuserassignedidentities): The resource ids of the user assigned identities to use -## InstanceFailoverGroupReadWriteEndpoint +## DatabaseIdentityUserAssignedIdentities ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +### Additional Properties +* **Additional Properties Type**: [DatabaseUserIdentity](#databaseuseridentity) -## ServerTrustGroupProperties +## DatabaseProperties ### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. +* **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: The collation of the database. +* **createMode**: 'Copy' | 'Default' | 'OnlineSecondary' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 'RestoreExternalBackup' | 'RestoreExternalBackupSecondary' | 'RestoreLongTermRetentionBackup' | 'Secondary' | string (WriteOnly): 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. +* **creationDate**: string (ReadOnly): The creation date of the database (ISO8601 format). +* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. +* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the database. +* **currentSku**: [Sku](#sku) (ReadOnly): An ARM Resource SKU. +* **databaseId**: string (ReadOnly): The ID of the database. +* **defaultSecondaryLocation**: string (ReadOnly): The default secondary region for this database. +* **earliestRestoreDate**: string (ReadOnly): This records the earliest start date and time that restore is available for this database (ISO8601 format). +* **elasticPoolId**: string: The resource identifier of the elastic pool containing this database. +* **failoverGroupId**: string (ReadOnly): Failover Group resource identifier that this database belongs to. +* **federatedClientId**: string: The Client id used for cross tenant per database CMK scenario +* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. +* **isInfraEncryptionEnabled**: bool (ReadOnly): Infra encryption is enabled for this database. +* **isLedgerOn**: bool: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The resource identifier of the long term retention backup associated with create operation of this database. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. +* **maxLogSizeBytes**: int (ReadOnly): The max log size for this database. +* **maxSizeBytes**: int: The max size of the database expressed in bytes. +* **minCapacity**: int: Minimal capacity that database will always have allocated, if not paused +* **pausedDate**: string (ReadOnly): The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. +* **readScale**: 'Disabled' | 'Enabled' | string: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **recoveryServicesRecoveryPointId**: string (WriteOnly): The resource identifier of the recovery point associated with create operation of this database. +* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. +* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The resource identifier of the restorable dropped database associated with create operation of this database. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **resumedDate**: string (ReadOnly): The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. +* **sampleName**: 'AdventureWorksLT' | 'WideWorldImportersFull' | 'WideWorldImportersStd' | string (WriteOnly): The name of the sample schema to apply when creating this database. +* **secondaryType**: 'Geo' | 'Named' | string: The secondary type of the database if it is a secondary. Valid values are Geo and Named. +* **sourceDatabaseDeletionDate**: string (WriteOnly): Specifies the time that the database was deleted. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **sourceResourceId**: string (WriteOnly): The resource identifier of the source associated with the create operation of this database. + +When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. + +When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of an existing database or existing sql pool, and restorePointInTime must be specified. + +When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. + +When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. + +This property allows to restore across subscriptions which is only supported for DataWarehouse edition. + +When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant +* **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Starting' | 'Stopped' | 'Stopping' | 'Suspect' | string (ReadOnly): The status of the database. +* **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## ServerInfo +## DatabaseUserIdentity ### Properties -* **serverId**: string (Required): Server Id. +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -## ResourceIdentity +## DatabaseVulnerabilityAssessmentProperties ### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## ResourceIdentityUserAssignedIdentities +## DatabaseVulnerabilityAssessmentRuleBaselineItem ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **result**: string[] (Required): The rule baseline result -## UserIdentity +## DatabaseVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. -* **collation**: string: Collation of the managed instance. -* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **servicePrincipal**: [ServicePrincipal](#serviceprincipal): The managed instance's service principal configuration for a resource. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstanceExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## ServicePrincipal -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory application client id. -* **principalId**: string (ReadOnly): The Azure Active Directory application object id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | string: Service principal type. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. - -## ManagedInstanceAzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BaseLongTermRetentionPolicyProperties -### Properties -* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. -* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. -* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. -* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. - -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - -## DistributedAvailabilityGroupProperties +## DistributedAvailabilityGroupProperties ### Properties * **distributedAvailabilityGroupId**: string (ReadOnly): The distributed availability group id * **lastHardenedLsn**: string (ReadOnly): The last hardened lsn @@ -902,121 +878,32 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **targetDatabase**: string: The name of the target database * **targetReplicaId**: string (ReadOnly): The target replica id -## ManagedInstanceEncryptionProtectorProperties -### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the managed instance key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ManagedInstanceKeyProperties -### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ServerTrustCertificateProperties +## ElasticPoolPerDatabaseSettings ### Properties -* **certificateName**: string (ReadOnly): The certificate name -* **publicBlob**: string: The certificate public blob -* **thumbprint**: string (ReadOnly): The certificate thumbprint +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. -## SqlAgentConfigurationProperties +## ElasticPoolProperties ### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the elastic pool that are used to provide high availability. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. -## ManagedInstanceVulnerabilityAssessmentProperties +## EncryptionProtectorProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. -* **federatedClientId**: string: The Client id used for cross tenant CMK scenario -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. -* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace - -## ServerExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[] (ReadOnly): Group IDs. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerBlobAuditingPolicyProperties +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1088,19 +975,10 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1114,106 +992,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - -## ServerConnectionPolicyProperties -### Properties -* **connectionType**: 'Default' | 'Proxy' | 'Redirect' | string (Required): The server connection type. - -## DatabaseIdentity -### Properties -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'UserAssigned' | string: The identity type -* **userAssignedIdentities**: [DatabaseIdentityUserAssignedIdentities](#databaseidentityuserassignedidentities): The resource ids of the user assigned identities to use - -## DatabaseIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [DatabaseUserIdentity](#databaseuseridentity) - -## DatabaseUserIdentity -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. - -## DatabaseProperties -### Properties -* **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: The collation of the database. -* **createMode**: 'Copy' | 'Default' | 'OnlineSecondary' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 'RestoreExternalBackup' | 'RestoreExternalBackupSecondary' | 'RestoreLongTermRetentionBackup' | 'Secondary' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): The creation date of the database (ISO8601 format). -* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. -* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the database. -* **currentSku**: [Sku](#sku) (ReadOnly): An ARM Resource SKU. -* **databaseId**: string (ReadOnly): The ID of the database. -* **defaultSecondaryLocation**: string (ReadOnly): The default secondary region for this database. -* **earliestRestoreDate**: string (ReadOnly): This records the earliest start date and time that restore is available for this database (ISO8601 format). -* **elasticPoolId**: string: The resource identifier of the elastic pool containing this database. -* **failoverGroupId**: string (ReadOnly): Failover Group resource identifier that this database belongs to. -* **federatedClientId**: string: The Client id used for cross tenant per database CMK scenario -* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. -* **isInfraEncryptionEnabled**: bool (ReadOnly): Infra encryption is enabled for this database. -* **isLedgerOn**: bool: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The resource identifier of the long term retention backup associated with create operation of this database. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. -* **maxLogSizeBytes**: int (ReadOnly): The max log size for this database. -* **maxSizeBytes**: int: The max size of the database expressed in bytes. -* **minCapacity**: int: Minimal capacity that database will always have allocated, if not paused -* **pausedDate**: string (ReadOnly): The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. -* **readScale**: 'Disabled' | 'Enabled' | string: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **recoveryServicesRecoveryPointId**: string (WriteOnly): The resource identifier of the recovery point associated with create operation of this database. -* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. -* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The resource identifier of the restorable dropped database associated with create operation of this database. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **resumedDate**: string (ReadOnly): The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. -* **sampleName**: 'AdventureWorksLT' | 'WideWorldImportersFull' | 'WideWorldImportersStd' | string (WriteOnly): The name of the sample schema to apply when creating this database. -* **secondaryType**: 'Geo' | 'Named' | string: The secondary type of the database if it is a secondary. Valid values are Geo and Named. -* **sourceDatabaseDeletionDate**: string (WriteOnly): Specifies the time that the database was deleted. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **sourceResourceId**: string (WriteOnly): The resource identifier of the source associated with the create operation of this database. - -When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. - -When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of an existing database or existing sql pool, and restorePointInTime must be specified. - -When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. - -When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. - -This property allows to restore across subscriptions which is only supported for DataWarehouse edition. - -When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant -* **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Starting' | 'Stopped' | 'Stopping' | 'Suspect' | string (ReadOnly): The status of the database. -* **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1287,96 +1066,13 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) -* **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **queueDelayMs**: int: 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. -* **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. - -## BackupShortTermRetentionPolicyProperties -### Properties -* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties -### Properties -* **auditActionsAndGroups**: string[]: 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 -LEDGER_OPERATION_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) -* **isAzureMonitorTargetEnabled**: bool: 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. +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' 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}. +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. 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 +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) @@ -1395,165 +1091,389 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DatabaseExtensionsProperties +## FailoverGroupProperties +### Properties +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## FailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## IPv6ServerFirewallRuleProperties +### Properties +* **endIPv6Address**: string: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress. +* **startIPv6Address**: string: The start IP address of the firewall rule. Must be IPv6 format. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. + +## LedgerDigestUploadsProperties +### Properties +* **digestStorageEndpoint**: string: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. +* **state**: 'Disabled' | 'Enabled' (ReadOnly): Specifies the state of ledger digest upload. + +## MaintenanceWindowsProperties +### Properties +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties +### Properties +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. + +## ManagedInstanceEncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ManagedInstanceExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ManagedInstanceKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ManagedInstancePairInfo +### Properties +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. + +## ManagedInstancePecProperty +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ManagedInstancePrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. + +## ManagedInstancePrivateEndpointProperty +### Properties +* **id**: string: Resource id of the private endpoint. + +## ManagedInstancePrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. + +## ManagedInstanceProperties +### Properties +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. +* **collation**: string: Collation of the managed instance. +* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **servicePrincipal**: [ServicePrincipal](#serviceprincipal): The managed instance's service principal configuration for a resource. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. + +## ManagedInstanceVulnerabilityAssessmentProperties +### Properties +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall + +## ManagedTransparentDataEncryptionProperties ### Properties -* **administratorLogin**: string (WriteOnly): Administrator login name. -* **administratorLoginPassword**: string (WriteOnly): Administrator login password. -* **authenticationType**: string (WriteOnly): Authentication type: SQL authentication or AD password. -* **databaseEdition**: string (WriteOnly): Database edition for the newly created database in the case of an import operation. -* **maxSizeBytes**: string (WriteOnly): Database max size in bytes for the newly created database in the case of an import operation. -* **networkIsolation**: [NetworkIsolationSettings](#networkisolationsettings) (WriteOnly): Contains the ARM resources for which to create private endpoint connection. -* **operationMode**: 'Export' | 'Import' | 'PolybaseImport' | string (Required, WriteOnly): Operation mode of the operation: Import, Export, or PolybaseImport. -* **serviceObjectiveName**: string (WriteOnly): Database service level objective for the newly created database in the case of an import operation. -* **storageKey**: string (Required, WriteOnly): Storage key for the storage account. -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type: StorageAccessKey or SharedAccessKey. -* **storageUri**: string (Required, WriteOnly): Storage Uri for the storage account. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. ## NetworkIsolationSettings ### Properties * **sqlServerResourceId**: string (WriteOnly): The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. * **storageAccountResourceId**: string (WriteOnly): The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. -## LedgerDigestUploadsProperties -### Properties -* **digestStorageEndpoint**: string: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. -* **state**: 'Disabled' | 'Enabled' (ReadOnly): Specifies the state of ledger digest upload. - -## MaintenanceWindowsProperties -### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange - -## MaintenanceWindowTimeRange -### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. - -## SyncGroupProperties -### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. - -## SyncGroupSchema -### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. - -## SyncGroupSchemaTable -### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. - -## SyncGroupSchemaTableColumn +## OutboundFirewallRuleProperties ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **provisioningState**: string (ReadOnly): The state of the outbound rule. -## SyncMemberProperties +## PartnerInfo ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## TransparentDataEncryptionProperties +## PartnerRegionInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadGroupProperties +## PrivateEndpointConnectionProperties ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **groupIds**: string[] (ReadOnly): Group IDs. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## WorkloadClassifierProperties +## PrivateEndpointProperty ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **id**: string: Resource id of the private endpoint. -## ServerDevOpsAuditSettingsProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ServerDnsAliasProperties +## ResourceIdentity ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ElasticPoolProperties +## ResourceIdentityUserAssignedIdentities ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the elastic pool that are used to provide high availability. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ElasticPoolPerDatabaseSettings +## SecurityAlertPolicyProperties ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## TrackedResourceTags +## SecurityAlertsPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SensitivityLabelProperties ### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## ExtendedServerBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1638,7 +1558,6 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1652,166 +1571,230 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerConnectionPolicyProperties ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **connectionType**: 'Default' | 'Proxy' | 'Redirect' | string (Required): The server connection type. + +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ServerFirewallRuleProperties +### Properties +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. + +## ServerInfo +### Properties +* **serverId**: string (Required): Server Id. + +## ServerKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## PartnerInfo +## ServerProperties ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. +* **federatedClientId**: string: The Client id used for cross tenant CMK scenario +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. +* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace -## FailoverGroupReadOnlyEndpoint +## ServerTrustCertificateProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **certificateName**: string (ReadOnly): The certificate name +* **publicBlob**: string: The certificate public blob +* **thumbprint**: string (ReadOnly): The certificate thumbprint -## FailoverGroupReadWriteEndpoint +## ServerTrustGroupProperties ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. -## FailoverGroupTags +## ServerVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## ServerFirewallRuleProperties +## ServicePrincipal ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **clientId**: string (ReadOnly): The Azure Active Directory application client id. +* **principalId**: string (ReadOnly): The Azure Active Directory application object id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | string: Service principal type. -## IPv6ServerFirewallRuleProperties +## Sku ### Properties -* **endIPv6Address**: string: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress. -* **startIPv6Address**: string: The start IP address of the firewall rule. Must be IPv6 format. +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## JobAgentProperties +## SqlAgentConfigurationProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## TrackedResourceTags +## SyncAgentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## JobCredentialProperties +## SyncGroupProperties ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobProperties +## SyncGroupSchema ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobSchedule +## SyncGroupSchemaTable ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobExecutionProperties +## SyncGroupSchemaTableColumn ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobExecutionTarget +## SyncMemberProperties ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobStepProperties +## SystemData ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepAction +## TrackedResourceTags ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +### Additional Properties +* **Additional Properties Type**: string -## JobStepExecutionOptions +## TrackedResourceTags ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +### Additional Properties +* **Additional Properties Type**: string -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. +### Additional Properties +* **Additional Properties Type**: string -## OutboundFirewallRuleProperties +## TrackedResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The state of the outbound rule. +### Additional Properties +* **Additional Properties Type**: string -## SyncAgentProperties +## TransparentDataEncryptionProperties ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. ## VirtualNetworkRuleProperties ### Properties @@ -1819,10 +1802,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sql/microsoft.sql/2021-11-01-preview/types.md b/generated/sql/microsoft.sql/2021-11-01-preview/types.md index 0191770327..a8c5799070 100644 --- a/generated/sql/microsoft.sql/2021-11-01-preview/types.md +++ b/generated/sql/microsoft.sql/2021-11-01-preview/types.md @@ -668,257 +668,239 @@ * **properties**: [ServerVulnerabilityAssessmentProperties](#servervulnerabilityassessmentproperties): Properties of a server Vulnerability Assessment. * **type**: 'Microsoft.Sql/servers/vulnerabilityAssessments' (ReadOnly, DeployTimeConstant): The resource type -## InstancePoolProperties +## AdministratorProperties ### Properties -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). -* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. -* **vCores**: int (Required): Count of vCores belonging to this instance pool. +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. +* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. +* **login**: string (Required): Login name of the server administrator. +* **sid**: string (Required): SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. -## Sku +## AdvancedThreatProtectionProperties ### Properties -* **capacity**: int: Capacity of the particular SKU. -* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **size**: string: Size of the particular SKU -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. -## TrackedResourceTags +## AzureADOnlyAuthProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -## InstanceFailoverGroupProperties +## BackupShortTermRetentionPolicyProperties ### Properties -* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. -* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. -* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. -## ManagedInstancePairInfo +## BaseLongTermRetentionPolicyProperties ### Properties -* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. -* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. +* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. +* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. +* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. +* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. -## PartnerRegionInfo +## DatabaseBlobAuditingPolicyProperties ### Properties -* **location**: string: Geo location of the partner managed instances. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **auditActionsAndGroups**: string[]: 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 +LEDGER_OPERATION_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) +* **isAzureMonitorTargetEnabled**: bool: 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) +* **isManagedIdentityInUse**: bool: Specifies whether Managed Identity is used to access blob storage +* **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. +* **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## InstanceFailoverGroupReadOnlyEndpoint +## DatabaseExtensionsProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **administratorLogin**: string (WriteOnly): Administrator login name. +* **administratorLoginPassword**: string (WriteOnly): Administrator login password. +* **authenticationType**: string (WriteOnly): Authentication type: SQL authentication or AD password. +* **databaseEdition**: string (WriteOnly): Database edition for the newly created database in the case of an import operation. +* **maxSizeBytes**: string (WriteOnly): Database max size in bytes for the newly created database in the case of an import operation. +* **networkIsolation**: [NetworkIsolationSettings](#networkisolationsettings) (WriteOnly): Contains the ARM resources for which to create private endpoint connection. +* **operationMode**: 'Export' | 'Import' | 'PolybaseImport' | string (Required, WriteOnly): Operation mode of the operation: Import, Export, or PolybaseImport. +* **serviceObjectiveName**: string (WriteOnly): Database service level objective for the newly created database in the case of an import operation. +* **storageKey**: string (Required, WriteOnly): Storage key for the storage account. +* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type: StorageAccessKey or SharedAccessKey. +* **storageUri**: string (Required, WriteOnly): Storage Uri for the storage account. -## InstanceFailoverGroupReadWriteEndpoint +## DatabaseIdentity ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'UserAssigned' | string: The identity type +* **userAssignedIdentities**: [DatabaseIdentityUserAssignedIdentities](#databaseidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ServerTrustGroupProperties +## DatabaseIdentityUserAssignedIdentities ### Properties -* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. -* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. +### Additional Properties +* **Additional Properties Type**: [DatabaseUserIdentity](#databaseuseridentity) -## ServerInfo +## DatabaseProperties ### Properties -* **serverId**: string (Required): Server Id. +* **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: The collation of the database. +* **createMode**: 'Copy' | 'Default' | 'OnlineSecondary' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 'RestoreExternalBackup' | 'RestoreExternalBackupSecondary' | 'RestoreLongTermRetentionBackup' | 'Secondary' | string (WriteOnly): 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. +* **creationDate**: string (ReadOnly): The creation date of the database (ISO8601 format). +* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. +* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the database. +* **currentSku**: [Sku](#sku) (ReadOnly): An ARM Resource SKU. +* **databaseId**: string (ReadOnly): The ID of the database. +* **defaultSecondaryLocation**: string (ReadOnly): The default secondary region for this database. +* **earliestRestoreDate**: string (ReadOnly): This records the earliest start date and time that restore is available for this database (ISO8601 format). +* **elasticPoolId**: string: The resource identifier of the elastic pool containing this database. +* **failoverGroupId**: string (ReadOnly): Failover Group resource identifier that this database belongs to. +* **federatedClientId**: string: The Client id used for cross tenant per database CMK scenario +* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. +* **isInfraEncryptionEnabled**: bool (ReadOnly): Infra encryption is enabled for this database. +* **isLedgerOn**: bool: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The resource identifier of the long term retention backup associated with create operation of this database. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. +* **maxLogSizeBytes**: int (ReadOnly): The max log size for this database. +* **maxSizeBytes**: int: The max size of the database expressed in bytes. +* **minCapacity**: int: Minimal capacity that database will always have allocated, if not paused +* **pausedDate**: string (ReadOnly): The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. +* **readScale**: 'Disabled' | 'Enabled' | string: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **recoveryServicesRecoveryPointId**: string (WriteOnly): The resource identifier of the recovery point associated with create operation of this database. +* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. +* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The resource identifier of the restorable dropped database associated with create operation of this database. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **resumedDate**: string (ReadOnly): The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. +* **sampleName**: 'AdventureWorksLT' | 'WideWorldImportersFull' | 'WideWorldImportersStd' | string (WriteOnly): The name of the sample schema to apply when creating this database. +* **secondaryType**: 'Geo' | 'Named' | string: The secondary type of the database if it is a secondary. Valid values are Geo and Named. +* **sourceDatabaseDeletionDate**: string (WriteOnly): Specifies the time that the database was deleted. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **sourceResourceId**: string (WriteOnly): The resource identifier of the source associated with the create operation of this database. + +This property is only supported for DataWarehouse edition and allows to restore across subscriptions. + +When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. + +When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. + +When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. + +When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. + +When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant +* **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Starting' | 'Stopped' | 'Stopping' | 'Suspect' | string (ReadOnly): The status of the database. +* **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. -## ResourceIdentity +## DatabaseUserIdentity ### Properties +* **clientId**: string (ReadOnly): The Azure Active Directory client id. * **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ResourceIdentityUserAssignedIdentities +## DatabaseVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserIdentity](#useridentity) +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## UserIdentity +## DatabaseVulnerabilityAssessmentRuleBaselineItem ### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **result**: string[] (Required): The rule baseline result -## ManagedInstanceProperties -### Properties -* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). -* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. -* **collation**: string: Collation of the managed instance. -* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. -* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. -* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. -* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). -* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. -* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. -* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) -* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. -* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. -* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **servicePrincipal**: [ServicePrincipal](#serviceprincipal): The managed instance's service principal configuration for a resource. -* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. -* **state**: string (ReadOnly): The state of the managed instance. -* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. -* **subnetId**: string: Subnet resource ID for the managed instance. -* **timezoneId**: 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". -* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. -* **zoneRedundant**: bool: Whether or not the multi-az is enabled. - -## ManagedInstanceExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ManagedInstancePecProperty -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## ManagedInstancePrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) -* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) -* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. - -## ManagedInstancePrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## ManagedInstancePrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: string (ReadOnly): The private link service connection description. -* **description**: string (Required): The private link service connection description. -* **status**: string (Required): The private link service connection status. - -## ServicePrincipal -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory application client id. -* **principalId**: string (ReadOnly): The Azure Active Directory application object id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | string: Service principal type. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedInstanceAdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. -* **login**: string (Required): Login name of the managed instance administrator. -* **sid**: string (Required): SID (object ID) of the managed instance administrator. -* **tenantId**: string: Tenant ID of the managed instance administrator. - -## ManagedInstanceAzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - -## ManagedDatabaseProperties -### Properties -* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: Collation of the managed database. -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). -* **creationDate**: string (ReadOnly): Creation date of the database. -* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. -* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. -* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. -* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. -* **restorePointInTime**: string (WriteOnly): 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. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. -* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. -* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BaseLongTermRetentionPolicyProperties -### Properties -* **monthlyRetention**: string: The monthly retention policy for an LTR backup in an ISO 8601 format. -* **weeklyRetention**: string: The weekly retention policy for an LTR backup in an ISO 8601 format. -* **weekOfYear**: int: The week of year to take the yearly backup in an ISO 8601 format. -* **yearlyRetention**: string: The yearly retention policy for an LTR backup in an ISO 8601 format. - -## ManagedBackupShortTermRetentionPolicyProperties -### Properties -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## SensitivityLabelProperties -### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. - -## SecurityAlertPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## ManagedTransparentDataEncryptionProperties -### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. - -## DatabaseVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall - -## VulnerabilityAssessmentRecurringScansProperties -### Properties -* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. -* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. -* **isEnabled**: bool: Recurring scans state. - -## DatabaseVulnerabilityAssessmentRuleBaselineProperties +## DatabaseVulnerabilityAssessmentRuleBaselineProperties ### Properties * **baselineResults**: [DatabaseVulnerabilityAssessmentRuleBaselineItem](#databasevulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## DatabaseVulnerabilityAssessmentRuleBaselineItem -### Properties -* **result**: string[] (Required): The rule baseline result - ## DistributedAvailabilityGroupProperties ### Properties * **distributedAvailabilityGroupId**: string (ReadOnly): The distributed availability group id @@ -932,130 +914,33 @@ An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standar * **targetDatabase**: string: The name of the target database * **targetReplicaId**: string (ReadOnly): The target replica id -## ManagedServerDnsAliasProperties +## ElasticPoolPerDatabaseSettings ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for managed server alias +* **maxCapacity**: int: The maximum capacity any one database can consume. +* **minCapacity**: int: The minimum capacity all databases are guaranteed. -## ManagedInstanceEncryptionProtectorProperties +## ElasticPoolProperties +### Properties +* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). +* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. +* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. +* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. +* **minCapacity**: int: Minimal capacity that serverless pool will not shrink below, if not paused +* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. +* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. +* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. + +## EncryptionProtectorProperties ### Properties * **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyName**: string: The name of the server key. * **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. * **thumbprint**: string (ReadOnly): Thumbprint of the server key. * **uri**: string (ReadOnly): The URI of the server key. -## ManagedInstanceKeyProperties -### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **thumbprint**: string (ReadOnly): Thumbprint of the key. -* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. - -## SecurityAlertsPolicyProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ServerTrustCertificateProperties -### Properties -* **certificateName**: string (ReadOnly): The certificate name -* **publicBlob**: string: The certificate public blob -* **thumbprint**: string (ReadOnly): The certificate thumbprint - -## SqlAgentConfigurationProperties -### Properties -* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. - -## ManagedInstanceVulnerabilityAssessmentProperties -### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall - -## ServerProperties -### Properties -* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. -* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). -* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. -* **federatedClientId**: string: The Client id used for cross tenant CMK scenario -* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. -* **keyId**: string: A CMK URI of the key to use for encryption. -* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' -* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. -* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' -* **state**: string (ReadOnly): The state of the server. -* **version**: string: The version of the server. -* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace - -## ServerExternalAdministrator -### Properties -* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. -* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. -* **login**: string: Login name of the server administrator. -* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. -* **sid**: string: SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## ServerPrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource ID. -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **groupIds**: string[] (ReadOnly): Group IDs. -* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) -* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. - -## PrivateEndpointProperty -### Properties -* **id**: string: Resource id of the private endpoint. - -## PrivateLinkServiceConnectionStateProperty -### Properties -* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. -* **description**: string (Required): The private link service connection description. -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AdministratorProperties -### Properties -* **administratorType**: 'ActiveDirectory' | string (Required): Type of the sever administrator. -* **azureADOnlyAuthentication**: bool (ReadOnly): Azure Active Directory only Authentication enabled. -* **login**: string (Required): Login name of the server administrator. -* **sid**: string (Required): SID (object ID) of the server administrator. -* **tenantId**: string: Tenant ID of the administrator. - -## AdvancedThreatProtectionProperties -### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. - -## ServerBlobAuditingPolicyProperties +## ExtendedDatabaseBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1127,20 +1012,11 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isManagedIdentityInUse**: bool: Specifies whether Managed Identity is used to access blob storage * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1154,106 +1030,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. - -## ServerConnectionPolicyProperties -### Properties -* **connectionType**: 'Default' | 'Proxy' | 'Redirect' | string (Required): The server connection type. - -## DatabaseIdentity -### Properties -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'UserAssigned' | string: The identity type -* **userAssignedIdentities**: [DatabaseIdentityUserAssignedIdentities](#databaseidentityuserassignedidentities): The resource ids of the user assigned identities to use - -## DatabaseIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [DatabaseUserIdentity](#databaseuseridentity) - -## DatabaseUserIdentity -### Properties -* **clientId**: string (ReadOnly): The Azure Active Directory client id. -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. - -## DatabaseProperties -### Properties -* **autoPauseDelay**: int: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled -* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. -* **collation**: string: The collation of the database. -* **createMode**: 'Copy' | 'Default' | 'OnlineSecondary' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 'RestoreExternalBackup' | 'RestoreExternalBackupSecondary' | 'RestoreLongTermRetentionBackup' | 'Secondary' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): The creation date of the database (ISO8601 format). -* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. -* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the database. -* **currentSku**: [Sku](#sku) (ReadOnly): An ARM Resource SKU. -* **databaseId**: string (ReadOnly): The ID of the database. -* **defaultSecondaryLocation**: string (ReadOnly): The default secondary region for this database. -* **earliestRestoreDate**: string (ReadOnly): This records the earliest start date and time that restore is available for this database (ISO8601 format). -* **elasticPoolId**: string: The resource identifier of the elastic pool containing this database. -* **failoverGroupId**: string (ReadOnly): Failover Group resource identifier that this database belongs to. -* **federatedClientId**: string: The Client id used for cross tenant per database CMK scenario -* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. -* **isInfraEncryptionEnabled**: bool (ReadOnly): Infra encryption is enabled for this database. -* **isLedgerOn**: bool: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. -* **longTermRetentionBackupResourceId**: string (WriteOnly): The resource identifier of the long term retention backup associated with create operation of this database. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. -* **maxLogSizeBytes**: int (ReadOnly): The max log size for this database. -* **maxSizeBytes**: int: The max size of the database expressed in bytes. -* **minCapacity**: int: Minimal capacity that database will always have allocated, if not paused -* **pausedDate**: string (ReadOnly): The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. -* **readScale**: 'Disabled' | 'Enabled' | string: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. -* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. -* **recoveryServicesRecoveryPointId**: string (WriteOnly): The resource identifier of the recovery point associated with create operation of this database. -* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. -* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the database. -* **restorableDroppedDatabaseId**: string (WriteOnly): The resource identifier of the restorable dropped database associated with create operation of this database. -* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. -* **resumedDate**: string (ReadOnly): The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. -* **sampleName**: 'AdventureWorksLT' | 'WideWorldImportersFull' | 'WideWorldImportersStd' | string (WriteOnly): The name of the sample schema to apply when creating this database. -* **secondaryType**: 'Geo' | 'Named' | string: The secondary type of the database if it is a secondary. Valid values are Geo and Named. -* **sourceDatabaseDeletionDate**: string (WriteOnly): Specifies the time that the database was deleted. -* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. -* **sourceResourceId**: string (WriteOnly): The resource identifier of the source associated with the create operation of this database. - -This property is only supported for DataWarehouse edition and allows to restore across subscriptions. - -When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. - -When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. - -When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. - -When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. - -When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant -* **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Starting' | 'Stopped' | 'Stopping' | 'Suspect' | string (ReadOnly): The status of the database. -* **zoneRedundant**: bool: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DatabaseBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1327,97 +1104,13 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) -* **isManagedIdentityInUse**: bool: Specifies whether Managed Identity is used to access blob storage -* **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **queueDelayMs**: int: 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. -* **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. - -## BackupShortTermRetentionPolicyProperties -### Properties -* **diffBackupIntervalInHours**: int: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. -* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. - -## ExtendedDatabaseBlobAuditingPolicyProperties -### Properties -* **auditActionsAndGroups**: string[]: 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 -LEDGER_OPERATION_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) -* **isAzureMonitorTargetEnabled**: bool: 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. +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' 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}. +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. 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 +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) @@ -1437,24 +1130,151 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DatabaseExtensionsProperties +## FailoverGroupProperties ### Properties -* **administratorLogin**: string (WriteOnly): Administrator login name. -* **administratorLoginPassword**: string (WriteOnly): Administrator login password. -* **authenticationType**: string (WriteOnly): Authentication type: SQL authentication or AD password. -* **databaseEdition**: string (WriteOnly): Database edition for the newly created database in the case of an import operation. -* **maxSizeBytes**: string (WriteOnly): Database max size in bytes for the newly created database in the case of an import operation. -* **networkIsolation**: [NetworkIsolationSettings](#networkisolationsettings) (WriteOnly): Contains the ARM resources for which to create private endpoint connection. -* **operationMode**: 'Export' | 'Import' | 'PolybaseImport' | string (Required, WriteOnly): Operation mode of the operation: Import, Export, or PolybaseImport. -* **serviceObjectiveName**: string (WriteOnly): Database service level objective for the newly created database in the case of an import operation. -* **storageKey**: string (Required, WriteOnly): Storage key for the storage account. -* **storageKeyType**: 'SharedAccessKey' | 'StorageAccessKey' | string (Required, WriteOnly): Storage key type: StorageAccessKey or SharedAccessKey. -* **storageUri**: string (Required, WriteOnly): Storage Uri for the storage account. +* **databases**: string[]: List of databases in the failover group. +* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. +* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. -## NetworkIsolationSettings +## FailoverGroupReadOnlyEndpoint ### Properties -* **sqlServerResourceId**: string (WriteOnly): The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. -* **storageAccountResourceId**: string (WriteOnly): The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## FailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## FailoverGroupTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## InstanceFailoverGroupProperties +### Properties +* **managedInstancePairs**: [ManagedInstancePairInfo](#managedinstancepairinfo)[] (Required): List of managed instance pairs in the failover group. +* **partnerRegions**: [PartnerRegionInfo](#partnerregioninfo)[] (Required): Partner region information for the failover group. +* **readOnlyEndpoint**: [InstanceFailoverGroupReadOnlyEndpoint](#instancefailovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. +* **readWriteEndpoint**: [InstanceFailoverGroupReadWriteEndpoint](#instancefailovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **replicationState**: string (ReadOnly): Replication state of the failover group instance. + +## InstanceFailoverGroupReadOnlyEndpoint +### Properties +* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. + +## InstanceFailoverGroupReadWriteEndpoint +### Properties +* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. + +## InstancePoolProperties +### Properties +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string (Required): The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). +* **subnetId**: string (Required): Resource ID of the subnet to place this instance pool in. +* **vCores**: int (Required): Count of vCores belonging to this instance pool. + +## IPv6ServerFirewallRuleProperties +### Properties +* **endIPv6Address**: string: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress. +* **startIPv6Address**: string: The start IP address of the firewall rule. Must be IPv6 format. + +## JobAgentProperties +### Properties +* **databaseId**: string (Required): Resource ID of the database to store job metadata in. +* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. + +## JobCredentialProperties +### Properties +* **password**: string (Required, WriteOnly): The credential password. +* **username**: string (Required): The credential user name. + +## JobExecutionProperties +### Properties +* **createTime**: string (ReadOnly): The time that the job execution was created. +* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. +* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. +* **endTime**: string (ReadOnly): The time that the job execution completed. +* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. +* **jobVersion**: int (ReadOnly): The job version number. +* **lastMessage**: string (ReadOnly): The last status or error message. +* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. +* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. +* **startTime**: string (ReadOnly): The time that the job execution started. +* **stepId**: int (ReadOnly): The job step id. +* **stepName**: string (ReadOnly): The job step name. +* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. + +## JobExecutionTarget +### Properties +* **databaseName**: string (ReadOnly): The database name. +* **serverName**: string (ReadOnly): The server name. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. + +## JobProperties +### Properties +* **description**: string: User-defined description of the job. +* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. +* **version**: int (ReadOnly): The job version number. + +## JobSchedule +### Properties +* **enabled**: bool: Whether or not the schedule is enabled. +* **endTime**: string: Schedule end time. +* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. +* **startTime**: string: Schedule start time. +* **type**: 'Once' | 'Recurring': Schedule interval type + +## JobStepAction +### Properties +* **source**: 'Inline' | string: The source of the action to execute. +* **type**: 'TSql' | string: Type of action being executed by the job step. +* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. + +## JobStepExecutionOptions +### Properties +* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. +* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. +* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. +* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. +* **timeoutSeconds**: int: Execution timeout for the job step. + +## JobStepOutput +### Properties +* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. +* **databaseName**: string (Required): The output destination database. +* **resourceGroupName**: string: The output destination resource group. +* **schemaName**: string: The output destination schema. +* **serverName**: string (Required): The output destination server name. +* **subscriptionId**: string: The output destination subscription id. +* **tableName**: string (Required): The output destination table. +* **type**: 'SqlDatabase' | string: The output destination type. + +## JobStepProperties +### Properties +* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. +* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. +* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. +* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. +* **stepId**: int: 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. +* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. + +## JobTarget +### Properties +* **databaseName**: string: The target database name. +* **elasticPoolName**: string: The target elastic pool name. +* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. +* **refreshCredential**: 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. +* **serverName**: string: The target server name. +* **shardMapName**: string: The target shard map. +* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. + +## JobTargetGroupProperties +### Properties +* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. ## LedgerDigestUploadsProperties ### Properties @@ -1465,138 +1285,238 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Properties * **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange -## MaintenanceWindowTimeRange +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedBackupShortTermRetentionPolicyProperties +### Properties +* **retentionDays**: int: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. + +## ManagedDatabaseProperties +### Properties +* **autoCompleteRestore**: bool (WriteOnly): Whether to auto complete restore of this managed database. +* **catalogCollation**: 'DATABASE_DEFAULT' | 'SQL_Latin1_General_CP1_CI_AS' | string: Collation of the metadata catalog. +* **collation**: string: Collation of the managed database. +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'RestoreExternalBackup' | 'RestoreLongTermRetentionBackup' | string (WriteOnly): 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. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). +* **creationDate**: string (ReadOnly): Creation date of the database. +* **defaultSecondaryLocation**: string (ReadOnly): Geo paired region. +* **earliestRestorePoint**: string (ReadOnly): Earliest restore point in time for point in time restore. +* **failoverGroupId**: string (ReadOnly): Instance Failover Group resource identifier that this managed database belongs to. +* **lastBackupName**: string (WriteOnly): Last backup file name for restore of this managed database. +* **longTermRetentionBackupResourceId**: string (WriteOnly): The name of the Long Term Retention backup to be used for restore of this managed database. +* **recoverableDatabaseId**: string (WriteOnly): The resource identifier of the recoverable database associated with create operation of this database. +* **restorableDroppedDatabaseId**: string (WriteOnly): The restorable dropped database resource id to restore when creating this database. +* **restorePointInTime**: string (WriteOnly): 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. +* **sourceDatabaseId**: string (WriteOnly): The resource identifier of the source database associated with create operation of this database. +* **status**: 'Creating' | 'Inaccessible' | 'Offline' | 'Online' | 'Restoring' | 'Shutdown' | 'Updating' | string (ReadOnly): Status of the database. +* **storageContainerSasToken**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. +* **storageContainerUri**: string (WriteOnly): Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. + +## ManagedInstanceAdministratorProperties +### Properties +* **administratorType**: 'ActiveDirectory' | string (Required): Type of the managed instance administrator. +* **login**: string (Required): Login name of the managed instance administrator. +* **sid**: string (Required): SID (object ID) of the managed instance administrator. +* **tenantId**: string: Tenant ID of the managed instance administrator. + +## ManagedInstanceAzureADOnlyAuthProperties +### Properties +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. + +## ManagedInstanceEncryptionProtectorProperties +### Properties +* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. +* **serverKeyName**: string: The name of the managed instance key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. + +## ManagedInstanceExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ManagedInstanceKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **thumbprint**: string (ReadOnly): Thumbprint of the key. +* **uri**: string (WriteOnly): The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. + +## ManagedInstancePairInfo +### Properties +* **partnerManagedInstanceId**: string: Id of Partner Managed Instance in pair. +* **primaryManagedInstanceId**: string: Id of Primary Managed Instance in pair. + +## ManagedInstancePecProperty +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [ManagedInstancePrivateEndpointConnectionProperties](#managedinstanceprivateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. + +## ManagedInstancePrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [ManagedInstancePrivateEndpointProperty](#managedinstanceprivateendpointproperty) +* **privateLinkServiceConnectionState**: [ManagedInstancePrivateLinkServiceConnectionStateProperty](#managedinstanceprivatelinkserviceconnectionstateproperty) +* **provisioningState**: string (ReadOnly): State of the Private Endpoint Connection. + +## ManagedInstancePrivateEndpointProperty +### Properties +* **id**: string: Resource id of the private endpoint. + +## ManagedInstancePrivateLinkServiceConnectionStateProperty +### Properties +* **actionsRequired**: string (ReadOnly): The private link service connection description. +* **description**: string (Required): The private link service connection description. +* **status**: string (Required): The private link service connection status. + +## ManagedInstanceProperties +### Properties +* **administratorLogin**: string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for managed instance creation). +* **administrators**: [ManagedInstanceExternalAdministrator](#managedinstanceexternaladministrator): Properties of a active directory administrator. +* **collation**: string: Collation of the managed instance. +* **currentBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string (ReadOnly): The storage account type used to store backups for this database. +* **dnsZone**: string (ReadOnly): The Dns Zone that the managed instance is in. +* **dnsZonePartner**: string (WriteOnly): The resource id of another managed instance whose DNS zone this managed instance will share after creation. +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the managed instance. +* **instancePoolId**: string: The Id of the instance pool this managed server belongs to. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **licenseType**: 'BasePrice' | 'LicenseIncluded' | 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). +* **maintenanceConfigurationId**: string: Specifies maintenance configuration id to apply to this managed instance. +* **managedInstanceCreateMode**: 'Default' | 'PointInTimeRestore' | string (WriteOnly): 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. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ManagedInstancePecProperty](#managedinstancepecproperty)[] (ReadOnly): List of private endpoint connections on a managed instance. +* **provisioningState**: 'Accepted' | 'Canceled' | 'Created' | 'Creating' | 'Deleted' | 'Deleting' | 'Failed' | 'NotSpecified' | 'Registering' | 'Running' | 'Succeeded' | 'TimedOut' | 'Unknown' | 'Unrecognized' | 'Updating' | string (ReadOnly) +* **proxyOverride**: 'Default' | 'Proxy' | 'Redirect' | string: Connection type used for connecting to the instance. +* **publicDataEndpointEnabled**: bool: Whether or not the public data endpoint is enabled. +* **requestedBackupStorageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage account type used to store backups for this database. +* **restorePointInTime**: string (WriteOnly): Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. +* **servicePrincipal**: [ServicePrincipal](#serviceprincipal): The managed instance's service principal configuration for a resource. +* **sourceManagedInstanceId**: string (WriteOnly): The resource identifier of the source managed instance associated with create operation of this instance. +* **state**: string (ReadOnly): The state of the managed instance. +* **storageSizeInGB**: int: Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only. +* **subnetId**: string: Subnet resource ID for the managed instance. +* **timezoneId**: 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". +* **vCores**: int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. +* **zoneRedundant**: bool: Whether or not the multi-az is enabled. + +## ManagedInstanceVulnerabilityAssessmentProperties ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## SyncGroupProperties +## ManagedServerDnsAliasProperties ### Properties -* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. -* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. -* **enableConflictLogging**: bool: If conflict logging is enabled. -* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. -* **hubDatabaseUserName**: string: User name for the sync group hub database credential. -* **interval**: int: Sync interval of the sync group. -* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. -* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. -* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. -* **usePrivateLinkConnection**: bool: If use private link connection is enabled. +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for managed server alias -## SyncGroupSchema +## ManagedTransparentDataEncryptionProperties ### Properties -* **masterSyncMemberName**: string: Name of master sync member where the schema is from. -* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. -## SyncGroupSchemaTable +## NetworkIsolationSettings ### Properties -* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. -* **quotedName**: string: Quoted name of sync group schema table. +* **sqlServerResourceId**: string (WriteOnly): The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. +* **storageAccountResourceId**: string (WriteOnly): The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. -## SyncGroupSchemaTableColumn +## OutboundFirewallRuleProperties ### Properties -* **dataSize**: string: Data size of the column. -* **dataType**: string: Data type of the column. -* **quotedName**: string: Quoted name of sync group table column. +* **provisioningState**: string (ReadOnly): The state of the outbound rule. -## SyncMemberProperties +## PartnerInfo ### Properties -* **databaseName**: string: Database name of the member database in the sync member. -* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. -* **password**: string (WriteOnly): Password of the member database in the sync member. -* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. -* **serverName**: string: Server name of the member database in the sync member -* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. -* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. -* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. -* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. -* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. -* **usePrivateLinkConnection**: bool: Whether to use private link connection. -* **userName**: string: User name of the member database in the sync member. +* **id**: string (Required): Resource identifier of the partner server. +* **location**: string (ReadOnly): Geo location of the partner server. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## TransparentDataEncryptionProperties +## PartnerRegionInfo ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. +* **location**: string: Geo location of the partner managed instances. +* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -## WorkloadGroupProperties +## PrivateEndpointConnectionProperties ### Properties -* **importance**: string: The workload group importance level. -* **maxResourcePercent**: int (Required): The workload group cap percentage resource. -* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. -* **minResourcePercent**: int (Required): The workload group minimum percentage resource. -* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. -* **queryExecutionTimeout**: int: The workload group query execution timeout. +* **groupIds**: string[] (ReadOnly): Group IDs. +* **privateEndpoint**: [PrivateEndpointProperty](#privateendpointproperty) +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionStateProperty](#privatelinkserviceconnectionstateproperty) +* **provisioningState**: 'Approving' | 'Dropping' | 'Failed' | 'Ready' | 'Rejecting' | string (ReadOnly): State of the private endpoint connection. -## WorkloadClassifierProperties +## PrivateEndpointProperty ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **id**: string: Resource id of the private endpoint. -## ServerDevOpsAuditSettingsProperties +## PrivateLinkServiceConnectionStateProperty ### Properties -* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) -* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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) -* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. +* **actionsRequired**: 'None' | string (ReadOnly): The actions required for private link service connection. +* **description**: string (Required): The private link service connection description. +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string (Required): The private link service connection status. -## ServerDnsAliasProperties +## ResourceIdentity ### Properties -* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. +* **userAssignedIdentities**: [ResourceIdentityUserAssignedIdentities](#resourceidentityuserassignedidentities): The resource ids of the user assigned identities to use -## ElasticPoolProperties +## ResourceIdentityUserAssignedIdentities ### Properties -* **creationDate**: string (ReadOnly): The creation date of the elastic pool (ISO8601 format). -* **highAvailabilityReplicaCount**: int: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. -* **licenseType**: 'BasePrice' | 'LicenseIncluded' | string: The license type to apply for this elastic pool. -* **maintenanceConfigurationId**: string: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. -* **maxSizeBytes**: int: The storage limit for the database elastic pool in bytes. -* **minCapacity**: int: Minimal capacity that serverless pool will not shrink below, if not paused -* **perDatabaseSettings**: [ElasticPoolPerDatabaseSettings](#elasticpoolperdatabasesettings): Per database settings of an elastic pool. -* **state**: 'Creating' | 'Disabled' | 'Ready' | string (ReadOnly): The state of the elastic pool. -* **zoneRedundant**: bool: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. +### Additional Properties +* **Additional Properties Type**: [UserIdentity](#useridentity) -## ElasticPoolPerDatabaseSettings +## SecurityAlertPolicyProperties ### Properties -* **maxCapacity**: int: The maximum capacity any one database can consume. -* **minCapacity**: int: The minimum capacity all databases are guaranteed. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## TrackedResourceTags +## SecurityAlertsPolicyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## EncryptionProtectorProperties +## SensitivityLabelProperties ### Properties -* **autoRotationEnabled**: bool: Key auto rotation opt-in flag. Either true or false. -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## ExtendedServerBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1682,7 +1602,6 @@ For more information, see [Diagnostic Settings REST API](https://go.microsoft.co or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) * **isManagedIdentityInUse**: bool: Specifies whether Managed Identity is used to access blob storage * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -1696,166 +1615,230 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## FailoverGroupProperties +## ServerConnectionPolicyProperties ### Properties -* **databases**: string[]: List of databases in the failover group. -* **partnerServers**: [PartnerInfo](#partnerinfo)[] (Required): List of partner server information for the failover group. -* **readOnlyEndpoint**: [FailoverGroupReadOnlyEndpoint](#failovergroupreadonlyendpoint): Read-only endpoint of the failover group instance. -* **readWriteEndpoint**: [FailoverGroupReadWriteEndpoint](#failovergroupreadwriteendpoint) (Required): Read-write endpoint of the failover group instance. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. -* **replicationState**: string (ReadOnly): Replication state of the failover group instance. +* **connectionType**: 'Default' | 'Proxy' | 'Redirect' | string (Required): The server connection type. + +## ServerDevOpsAuditSettingsProperties +### Properties +* **isAzureMonitorTargetEnabled**: bool: Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. +* **storageAccountAccessKey**: string (WriteOnly): 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) +* **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. + +## ServerDnsAliasProperties +### Properties +* **azureDnsRecord**: string (ReadOnly): The fully qualified DNS record for alias + +## ServerExternalAdministrator +### Properties +* **administratorType**: 'ActiveDirectory' | string: Type of the sever administrator. +* **azureADOnlyAuthentication**: bool: Azure Active Directory only Authentication enabled. +* **login**: string: Login name of the server administrator. +* **principalType**: 'Application' | 'Group' | 'User' | string: Principal Type of the sever administrator. +* **sid**: string: SID (object ID) of the server administrator. +* **tenantId**: string: Tenant ID of the administrator. + +## ServerFirewallRuleProperties +### Properties +* **endIpAddress**: string: 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. +* **startIpAddress**: 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. + +## ServerInfo +### Properties +* **serverId**: string (Required): Server Id. + +## ServerKeyProperties +### Properties +* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. +* **creationDate**: string (ReadOnly): The server key creation date. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the server key. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' + +## ServerPrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource ID. +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of a private endpoint connection. -## PartnerInfo +## ServerProperties ### Properties -* **id**: string (Required): Resource identifier of the partner server. -* **location**: string (ReadOnly): Geo location of the partner server. -* **replicationRole**: 'Primary' | 'Secondary' | string (ReadOnly): Local replication role of the failover group instance. +* **administratorLogin**: string: Administrator username for the server. Once created it cannot be changed. +* **administratorLoginPassword**: string (WriteOnly): The administrator login password (required for server creation). +* **administrators**: [ServerExternalAdministrator](#serverexternaladministrator): Properties of a active directory administrator. +* **federatedClientId**: string: The Client id used for cross tenant CMK scenario +* **fullyQualifiedDomainName**: string (ReadOnly): The fully qualified domain name of the server. +* **keyId**: string: A CMK URI of the key to use for encryption. +* **minimalTlsVersion**: string: Minimal TLS version. Allowed values: '1.0', '1.1', '1.2' +* **primaryUserAssignedIdentityId**: string: The resource id of a user assigned identity to be used by default. +* **privateEndpointConnections**: [ServerPrivateEndpointConnection](#serverprivateendpointconnection)[] (ReadOnly): List of private endpoint connections on a server +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **restrictOutboundNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' +* **state**: string (ReadOnly): The state of the server. +* **version**: string: The version of the server. +* **workspaceFeature**: 'Connected' | 'Disconnected' | string (ReadOnly): Whether or not existing server has a workspace created and if it allows connection from workspace -## FailoverGroupReadOnlyEndpoint +## ServerTrustCertificateProperties ### Properties -* **failoverPolicy**: 'Disabled' | 'Enabled' | string: Failover policy of the read-only endpoint for the failover group. +* **certificateName**: string (ReadOnly): The certificate name +* **publicBlob**: string: The certificate public blob +* **thumbprint**: string (ReadOnly): The certificate thumbprint -## FailoverGroupReadWriteEndpoint +## ServerTrustGroupProperties ### Properties -* **failoverPolicy**: 'Automatic' | 'Manual' | string (Required): Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. -* **failoverWithDataLossGracePeriodMinutes**: int: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. +* **groupMembers**: [ServerInfo](#serverinfo)[] (Required): Group members information for the server trust group. +* **trustScopes**: 'GlobalTransactions' | 'ServiceBroker' | string[] (Required): Trust scope of the server trust group. -## FailoverGroupTags +## ServerVulnerabilityAssessmentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall +* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall -## ServerFirewallRuleProperties +## ServicePrincipal ### Properties -* **endIpAddress**: string: 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. -* **startIpAddress**: 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. +* **clientId**: string (ReadOnly): The Azure Active Directory application client id. +* **principalId**: string (ReadOnly): The Azure Active Directory application object id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | string: Service principal type. -## IPv6ServerFirewallRuleProperties +## Sku ### Properties -* **endIPv6Address**: string: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress. -* **startIPv6Address**: string: The start IP address of the firewall rule. Must be IPv6 format. +* **capacity**: int: Capacity of the particular SKU. +* **family**: string: If the service has different generations of hardware, for the same SKU, then that can be captured here. +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **size**: string: Size of the particular SKU +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. -## JobAgentProperties +## SqlAgentConfigurationProperties ### Properties -* **databaseId**: string (Required): Resource ID of the database to store job metadata in. -* **state**: 'Creating' | 'Deleting' | 'Disabled' | 'Ready' | 'Updating' | string (ReadOnly): The state of the job agent. +* **state**: 'Disabled' | 'Enabled' | string: The state of Sql Agent. -## TrackedResourceTags +## SyncAgentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. +* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. +* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. +* **name**: string (ReadOnly): Name of the sync agent. +* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. +* **version**: string (ReadOnly): Version of the sync agent. -## JobCredentialProperties +## SyncGroupProperties ### Properties -* **password**: string (Required, WriteOnly): The credential password. -* **username**: string (Required): The credential user name. +* **conflictLoggingRetentionInDays**: int: Conflict logging retention period. +* **conflictResolutionPolicy**: 'HubWin' | 'MemberWin' | string: Conflict resolution policy of the sync group. +* **enableConflictLogging**: bool: If conflict logging is enabled. +* **hubDatabasePassword**: string (WriteOnly): Password for the sync group hub database credential. +* **hubDatabaseUserName**: string: User name for the sync group hub database credential. +* **interval**: int: Sync interval of the sync group. +* **lastSyncTime**: string (ReadOnly): Last sync time of the sync group. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync group if use private link connection is enabled. +* **schema**: [SyncGroupSchema](#syncgroupschema): Properties of sync group schema. +* **syncDatabaseId**: string: ARM resource id of the sync database in the sync group. +* **syncState**: 'Error' | 'Good' | 'NotReady' | 'Progressing' | 'Warning' | string (ReadOnly): Sync state of the sync group. +* **usePrivateLinkConnection**: bool: If use private link connection is enabled. -## JobProperties +## SyncGroupSchema ### Properties -* **description**: string: User-defined description of the job. -* **schedule**: [JobSchedule](#jobschedule): Scheduling properties of a job. -* **version**: int (ReadOnly): The job version number. +* **masterSyncMemberName**: string: Name of master sync member where the schema is from. +* **tables**: [SyncGroupSchemaTable](#syncgroupschematable)[]: List of tables in sync group schema. -## JobSchedule +## SyncGroupSchemaTable ### Properties -* **enabled**: bool: Whether or not the schedule is enabled. -* **endTime**: string: Schedule end time. -* **interval**: string: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. -* **startTime**: string: Schedule start time. -* **type**: 'Once' | 'Recurring': Schedule interval type +* **columns**: [SyncGroupSchemaTableColumn](#syncgroupschematablecolumn)[]: List of columns in sync group schema. +* **quotedName**: string: Quoted name of sync group schema table. -## JobExecutionProperties +## SyncGroupSchemaTableColumn ### Properties -* **createTime**: string (ReadOnly): The time that the job execution was created. -* **currentAttempts**: int (ReadOnly): Number of times the job execution has been attempted. -* **currentAttemptStartTime**: string (ReadOnly): Start time of the current attempt. -* **endTime**: string (ReadOnly): The time that the job execution completed. -* **jobExecutionId**: string (ReadOnly): The unique identifier of the job execution. -* **jobVersion**: int (ReadOnly): The job version number. -* **lastMessage**: string (ReadOnly): The last status or error message. -* **lifecycle**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Skipped' | 'Succeeded' | 'SucceededWithSkipped' | 'TimedOut' | 'WaitingForChildJobExecutions' | 'WaitingForRetry' | string (ReadOnly): The detailed state of the job execution. -* **provisioningState**: 'Canceled' | 'Created' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The ARM provisioning state of the job execution. -* **startTime**: string (ReadOnly): The time that the job execution started. -* **stepId**: int (ReadOnly): The job step id. -* **stepName**: string (ReadOnly): The job step name. -* **target**: [JobExecutionTarget](#jobexecutiontarget) (ReadOnly): The target that a job execution is executed on. +* **dataSize**: string: Data size of the column. +* **dataType**: string: Data type of the column. +* **quotedName**: string: Quoted name of sync group table column. -## JobExecutionTarget +## SyncMemberProperties ### Properties -* **databaseName**: string (ReadOnly): The database name. -* **serverName**: string (ReadOnly): The server name. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (ReadOnly): The type of the target. +* **databaseName**: string: Database name of the member database in the sync member. +* **databaseType**: 'AzureSqlDatabase' | 'SqlServerDatabase' | string: Type of the sync agent linked database. +* **password**: string (WriteOnly): Password of the member database in the sync member. +* **privateEndpointName**: string (ReadOnly): Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. +* **serverName**: string: Server name of the member database in the sync member +* **sqlServerDatabaseId**: string: SQL Server database id of the sync member. +* **syncAgentId**: string: ARM resource id of the sync agent in the sync member. +* **syncDirection**: 'Bidirectional' | 'OneWayHubToMember' | 'OneWayMemberToHub' | string: Sync direction of the sync member. +* **syncMemberAzureDatabaseResourceId**: string: ARM resource id of the sync member logical database, for sync members in Azure. +* **syncState**: 'DeProvisionFailed' | 'DeProvisioned' | 'DeProvisioning' | 'DisabledBackupRestore' | 'DisabledTombstoneCleanup' | 'ProvisionFailed' | 'Provisioned' | 'Provisioning' | 'ReprovisionFailed' | 'Reprovisioning' | 'SyncCancelled' | 'SyncCancelling' | 'SyncFailed' | 'SyncInProgress' | 'SyncSucceeded' | 'SyncSucceededWithWarnings' | 'UnProvisioned' | 'UnReprovisioned' | string (ReadOnly): Sync state of the sync member. +* **usePrivateLinkConnection**: bool: Whether to use private link connection. +* **userName**: string: User name of the member database in the sync member. -## JobStepProperties +## SystemData ### Properties -* **action**: [JobStepAction](#jobstepaction) (Required): The action to be executed by a job step. -* **credential**: string (Required): The resource ID of the job credential that will be used to connect to the targets. -* **executionOptions**: [JobStepExecutionOptions](#jobstepexecutionoptions): The execution options of a job step. -* **output**: [JobStepOutput](#jobstepoutput): The output configuration of a job step. -* **stepId**: int: 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. -* **targetGroup**: string (Required): The resource ID of the target group that the job step will be executed on. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## JobStepAction +## TrackedResourceTags ### Properties -* **source**: 'Inline' | string: The source of the action to execute. -* **type**: 'TSql' | string: Type of action being executed by the job step. -* **value**: string (Required): The action value, for example the text of the T-SQL script to execute. +### Additional Properties +* **Additional Properties Type**: string -## JobStepExecutionOptions +## TrackedResourceTags ### Properties -* **initialRetryIntervalSeconds**: int: Initial delay between retries for job step execution. -* **maximumRetryIntervalSeconds**: int: The maximum amount of time to wait between retries for job step execution. -* **retryAttempts**: int: Maximum number of times the job step will be reattempted if the first attempt fails. -* **retryIntervalBackoffMultiplier**: int: The backoff multiplier for the time between retries. -* **timeoutSeconds**: int: Execution timeout for the job step. +### Additional Properties +* **Additional Properties Type**: string -## JobStepOutput +## TrackedResourceTags ### Properties -* **credential**: string (Required): The resource ID of the credential to use to connect to the output destination. -* **databaseName**: string (Required): The output destination database. -* **resourceGroupName**: string: The output destination resource group. -* **schemaName**: string: The output destination schema. -* **serverName**: string (Required): The output destination server name. -* **subscriptionId**: string: The output destination subscription id. -* **tableName**: string (Required): The output destination table. -* **type**: 'SqlDatabase' | string: The output destination type. +### Additional Properties +* **Additional Properties Type**: string -## JobTargetGroupProperties +## TrackedResourceTags ### Properties -* **members**: [JobTarget](#jobtarget)[] (Required): Members of the target group. +### Additional Properties +* **Additional Properties Type**: string -## JobTarget +## TrackedResourceTags ### Properties -* **databaseName**: string: The target database name. -* **elasticPoolName**: string: The target elastic pool name. -* **membershipType**: 'Exclude' | 'Include': Whether the target is included or excluded from the group. -* **refreshCredential**: 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. -* **serverName**: string: The target server name. -* **shardMapName**: string: The target shard map. -* **type**: 'SqlDatabase' | 'SqlElasticPool' | 'SqlServer' | 'SqlShardMap' | 'TargetGroup' | string (Required): The type of the target. +### Additional Properties +* **Additional Properties Type**: string -## ServerKeyProperties +## TrackedResourceTags ### Properties -* **autoRotationEnabled**: bool (ReadOnly): Key auto rotation opt-in flag. Either true or false. -* **creationDate**: string (ReadOnly): The server key creation date. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required, WriteOnly): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the server key. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (WriteOnly): The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' +### Additional Properties +* **Additional Properties Type**: string -## OutboundFirewallRuleProperties +## TrackedResourceTags ### Properties -* **provisioningState**: string (ReadOnly): The state of the outbound rule. +### Additional Properties +* **Additional Properties Type**: string -## SyncAgentProperties +## TransparentDataEncryptionProperties ### Properties -* **expiryTime**: string (ReadOnly): Expiration time of the sync agent version. -* **isUpToDate**: bool (ReadOnly): If the sync agent version is up to date. -* **lastAliveTime**: string (ReadOnly): Last alive time of the sync agent. -* **name**: string (ReadOnly): Name of the sync agent. -* **state**: 'NeverConnected' | 'Offline' | 'Online' | string (ReadOnly): State of the sync agent. -* **syncDatabaseId**: string: ARM resource id of the sync database in the sync agent. -* **version**: string (ReadOnly): Version of the sync agent. +* **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the transparent data encryption. + +## UserIdentity +### Properties +* **clientId**: string (ReadOnly): The Azure Active Directory client id. +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. ## VirtualNetworkRuleProperties ### Properties @@ -1863,10 +1846,27 @@ For more information, see [Auditing to storage using Managed Identity authentica * **state**: 'Deleting' | 'Failed' | 'InProgress' | 'Initializing' | 'Ready' | 'Unknown' | string (ReadOnly): Virtual Network Rule State * **virtualNetworkSubnetId**: string (Required): The ARM resource id of the virtual network subnet. -## ServerVulnerabilityAssessmentProperties +## VulnerabilityAssessmentRecurringScansProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall -* **storageContainerPath**: string (Required, WriteOnly): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. Applies only if the storage account is not behind a Vnet or a firewall +* **emails**: string[]: Specifies an array of e-mail addresses to which the scan notification is sent. +* **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. +* **isEnabled**: bool: Recurring scans state. + +## WorkloadClassifierProperties +### Properties +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. + +## WorkloadGroupProperties +### Properties +* **importance**: string: The workload group importance level. +* **maxResourcePercent**: int (Required): The workload group cap percentage resource. +* **maxResourcePercentPerRequest**: int: The workload group request maximum grant percentage. +* **minResourcePercent**: int (Required): The workload group minimum percentage resource. +* **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. +* **queryExecutionTimeout**: int: The workload group query execution timeout. diff --git a/generated/sqlvirtualmachine/log.out b/generated/sqlvirtualmachine/log.out index 30b09c0170..d7bd09683a 100644 --- a/generated/sqlvirtualmachine/log.out +++ b/generated/sqlvirtualmachine/log.out @@ -3,17 +3,17 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.sqlvirtualmachine-2021-11-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.sqlvirtualmachine-2017-03-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms -info | Autorest completed in 8.21s. 4 files generated. +info | Autorest completed in 7.72s. 4 files generated. diff --git a/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.md b/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.md index 90815bafe6..d45de6b9ab 100644 --- a/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.md +++ b/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2017-03-01-preview/types.md @@ -32,31 +32,31 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.SqlVirtualMachine/sqlVirtualMachines' (ReadOnly, DeployTimeConstant): The resource type -## SqlVirtualMachineGroupProperties +## AdditionalFeaturesServerConfigurations ### Properties -* **clusterConfiguration**: 'Domainful' | string (ReadOnly): Cluster type. -* **clusterManagerType**: 'WSFC' | string (ReadOnly): Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -* **scaleType**: 'HA' | string (ReadOnly): Scale type. -* **sqlImageOffer**: string: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. -* **sqlImageSku**: 'Developer' | 'Enterprise' | string: SQL image sku. -* **wsfcDomainProfile**: [WsfcDomainProfile](#wsfcdomainprofile): Active Directory account details to operate Windows Server Failover Cluster. +* **isRServicesEnabled**: bool: Enable or disable R services (SQL 2016 onwards). -## WsfcDomainProfile +## AutoBackupSettings ### Properties -* **clusterBootstrapAccount**: string: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). -* **clusterOperatorAccount**: string: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. -* **domainFqdn**: string: Fully qualified name of the domain. -* **fileShareWitnessPath**: string: Optional path for fileshare witness. -* **ouPath**: string: Organizational Unit path in which the nodes and cluster will be present. -* **sqlServiceAccount**: string: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. -* **storageAccountPrimaryKey**: string (WriteOnly): Primary key of the witness storage account. -* **storageAccountUrl**: string: Fully qualified ARM resource id of the witness storage account. +* **backupScheduleType**: 'Automated' | 'Manual' | string: Backup schedule type. +* **backupSystemDbs**: bool: Include or exclude system databases from auto backup. +* **enable**: bool: Enable or disable autobackup on SQL virtual machine. +* **enableEncryption**: bool: Enable or disable encryption for backup on SQL virtual machine. +* **fullBackupFrequency**: 'Daily' | 'Weekly' | string: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. +* **fullBackupStartTime**: int: Start time of a given day during which full backups can take place. 0-23 hours. +* **fullBackupWindowHours**: int: Duration of the time window of a given day during which full backups can take place. 1-23 hours. +* **logBackupFrequency**: int: Frequency of log backups. 5-60 minutes. +* **password**: string (WriteOnly): Password for encryption on backup. +* **retentionPeriod**: int: Retention period of backup: 1-30 days. +* **storageAccessKey**: string (WriteOnly): Storage account key where backup will be taken to. +* **storageAccountUrl**: string: Storage account url where backup will be taken to. -## TrackedResourceTags +## AutoPatchingSettings ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Day of week to apply the patch on. +* **enable**: bool: Enable or disable autopatching on SQL virtual machine. +* **maintenanceWindowDuration**: int: Duration of patching. +* **maintenanceWindowStartingHour**: int: Hour of the day when patching is initiated. Local VM time. ## AvailabilityGroupListenerProperties ### Properties @@ -66,6 +66,14 @@ * **port**: int: Listener port. * **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. +## KeyVaultCredentialSettings +### Properties +* **azureKeyVaultUrl**: string: Azure Key Vault url. +* **credentialName**: string: Credential name. +* **enable**: bool: Enable or disable key vault credential setting. +* **servicePrincipalName**: string: Service principal name to access key vault. +* **servicePrincipalSecret**: string (WriteOnly): Service principal name secret to access key vault. + ## LoadBalancerConfiguration ### Properties * **loadBalancerResourceId**: string: Resource id of the load balancer. @@ -85,52 +93,6 @@ * **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. * **type**: 'SystemAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. -## SqlVirtualMachineProperties -### Properties -* **autoBackupSettings**: [AutoBackupSettings](#autobackupsettings): Configure backups for databases in your SQL virtual machine. -* **autoPatchingSettings**: [AutoPatchingSettings](#autopatchingsettings): Set a patching window during which Windows and SQL patches will be applied. -* **keyVaultCredentialSettings**: [KeyVaultCredentialSettings](#keyvaultcredentialsettings): Configure your SQL virtual machine to be able to connect to the Azure Key Vault service. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -* **serverConfigurationsManagementSettings**: [ServerConfigurationsManagementSettings](#serverconfigurationsmanagementsettings): Set the connectivity, storage and workload settings. -* **sqlImageOffer**: string: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. -* **sqlImageSku**: 'Developer' | 'Enterprise' | 'Express' | 'Standard' | 'Web' | string: SQL Server edition type. -* **sqlManagement**: 'Full' | 'LightWeight' | 'NoAgent' | string: SQL Server Management type. -* **sqlServerLicenseType**: 'AHUB' | 'DR' | 'PAYG' | string: SQL Server license type. -* **sqlVirtualMachineGroupResourceId**: string: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. -* **storageConfigurationSettings**: [StorageConfigurationSettings](#storageconfigurationsettings): Storage Configurations for SQL Data, Log and TempDb. -* **virtualMachineResourceId**: string: ARM Resource id of underlying virtual machine created from SQL marketplace image. -* **wsfcDomainCredentials**: [WsfcDomainCredentials](#wsfcdomaincredentials): Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. - -## AutoBackupSettings -### Properties -* **backupScheduleType**: 'Automated' | 'Manual' | string: Backup schedule type. -* **backupSystemDbs**: bool: Include or exclude system databases from auto backup. -* **enable**: bool: Enable or disable autobackup on SQL virtual machine. -* **enableEncryption**: bool: Enable or disable encryption for backup on SQL virtual machine. -* **fullBackupFrequency**: 'Daily' | 'Weekly' | string: Frequency of full backups. In both cases, full backups begin during the next scheduled time window. -* **fullBackupStartTime**: int: Start time of a given day during which full backups can take place. 0-23 hours. -* **fullBackupWindowHours**: int: Duration of the time window of a given day during which full backups can take place. 1-23 hours. -* **logBackupFrequency**: int: Frequency of log backups. 5-60 minutes. -* **password**: string (WriteOnly): Password for encryption on backup. -* **retentionPeriod**: int: Retention period of backup: 1-30 days. -* **storageAccessKey**: string (WriteOnly): Storage account key where backup will be taken to. -* **storageAccountUrl**: string: Storage account url where backup will be taken to. - -## AutoPatchingSettings -### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Day of week to apply the patch on. -* **enable**: bool: Enable or disable autopatching on SQL virtual machine. -* **maintenanceWindowDuration**: int: Duration of patching. -* **maintenanceWindowStartingHour**: int: Hour of the day when patching is initiated. Local VM time. - -## KeyVaultCredentialSettings -### Properties -* **azureKeyVaultUrl**: string: Azure Key Vault url. -* **credentialName**: string: Credential name. -* **enable**: bool: Enable or disable key vault credential setting. -* **servicePrincipalName**: string: Service principal name to access key vault. -* **servicePrincipalSecret**: string (WriteOnly): Service principal name secret to access key vault. - ## ServerConfigurationsManagementSettings ### Properties * **additionalFeaturesServerConfigurations**: [AdditionalFeaturesServerConfigurations](#additionalfeaturesserverconfigurations): Additional SQL Server feature settings. @@ -138,10 +100,6 @@ * **sqlStorageUpdateSettings**: [SqlStorageUpdateSettings](#sqlstorageupdatesettings): Set disk storage settings for SQL Server. * **sqlWorkloadTypeUpdateSettings**: [SqlWorkloadTypeUpdateSettings](#sqlworkloadtypeupdatesettings): Set workload type to optimize storage for SQL Server. -## AdditionalFeaturesServerConfigurations -### Properties -* **isRServicesEnabled**: bool: Enable or disable R services (SQL 2016 onwards). - ## SqlConnectivityUpdateSettings ### Properties * **connectivityType**: 'LOCAL' | 'PRIVATE' | 'PUBLIC' | string: SQL Server connectivity option. @@ -149,12 +107,43 @@ * **sqlAuthUpdatePassword**: string (WriteOnly): SQL Server sysadmin login password. * **sqlAuthUpdateUserName**: string (WriteOnly): SQL Server sysadmin login to create. +## SQLStorageSettings +### Properties +* **defaultFilePath**: string: SQL Server default file path +* **luns**: int[]: Logical Unit Numbers for the disks. + ## SqlStorageUpdateSettings ### Properties * **diskConfigurationType**: 'ADD' | 'EXTEND' | 'NEW' | string: Disk configuration to apply to SQL Server. * **diskCount**: int: Virtual machine disk count. * **startingDeviceId**: int: Device id of the first disk to be updated. +## SqlVirtualMachineGroupProperties +### Properties +* **clusterConfiguration**: 'Domainful' | string (ReadOnly): Cluster type. +* **clusterManagerType**: 'WSFC' | string (ReadOnly): Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. +* **scaleType**: 'HA' | string (ReadOnly): Scale type. +* **sqlImageOffer**: string: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. +* **sqlImageSku**: 'Developer' | 'Enterprise' | string: SQL image sku. +* **wsfcDomainProfile**: [WsfcDomainProfile](#wsfcdomainprofile): Active Directory account details to operate Windows Server Failover Cluster. + +## SqlVirtualMachineProperties +### Properties +* **autoBackupSettings**: [AutoBackupSettings](#autobackupsettings): Configure backups for databases in your SQL virtual machine. +* **autoPatchingSettings**: [AutoPatchingSettings](#autopatchingsettings): Set a patching window during which Windows and SQL patches will be applied. +* **keyVaultCredentialSettings**: [KeyVaultCredentialSettings](#keyvaultcredentialsettings): Configure your SQL virtual machine to be able to connect to the Azure Key Vault service. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. +* **serverConfigurationsManagementSettings**: [ServerConfigurationsManagementSettings](#serverconfigurationsmanagementsettings): Set the connectivity, storage and workload settings. +* **sqlImageOffer**: string: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. +* **sqlImageSku**: 'Developer' | 'Enterprise' | 'Express' | 'Standard' | 'Web' | string: SQL Server edition type. +* **sqlManagement**: 'Full' | 'LightWeight' | 'NoAgent' | string: SQL Server Management type. +* **sqlServerLicenseType**: 'AHUB' | 'DR' | 'PAYG' | string: SQL Server license type. +* **sqlVirtualMachineGroupResourceId**: string: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. +* **storageConfigurationSettings**: [StorageConfigurationSettings](#storageconfigurationsettings): Storage Configurations for SQL Data, Log and TempDb. +* **virtualMachineResourceId**: string: ARM Resource id of underlying virtual machine created from SQL marketplace image. +* **wsfcDomainCredentials**: [WsfcDomainCredentials](#wsfcdomaincredentials): Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. + ## SqlWorkloadTypeUpdateSettings ### Properties * **sqlWorkloadType**: 'DW' | 'GENERAL' | 'OLTP' | string: SQL Server workload type. @@ -167,10 +156,15 @@ * **sqlTempDbSettings**: [SQLStorageSettings](#sqlstoragesettings): Set disk storage settings for SQL Server. * **storageWorkloadType**: 'DW' | 'GENERAL' | 'OLTP' | string: Storage workload type. -## SQLStorageSettings +## TrackedResourceTags ### Properties -* **defaultFilePath**: string: SQL Server default file path -* **luns**: int[]: Logical Unit Numbers for the disks. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## WsfcDomainCredentials ### Properties @@ -178,8 +172,14 @@ * **clusterOperatorAccountPassword**: string: Cluster operator account password. * **sqlServiceAccountPassword**: string: SQL service account password. -## TrackedResourceTags +## WsfcDomainProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clusterBootstrapAccount**: string: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). +* **clusterOperatorAccount**: string: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. +* **domainFqdn**: string: Fully qualified name of the domain. +* **fileShareWitnessPath**: string: Optional path for fileshare witness. +* **ouPath**: string: Organizational Unit path in which the nodes and cluster will be present. +* **sqlServiceAccount**: string: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. +* **storageAccountPrimaryKey**: string (WriteOnly): Primary key of the witness storage account. +* **storageAccountUrl**: string: Fully qualified ARM resource id of the witness storage account. diff --git a/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.md b/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.md index a97f5170f0..b8e4407646 100644 --- a/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.md +++ b/generated/sqlvirtualmachine/microsoft.sqlvirtualmachine/2021-11-01-preview/types.md @@ -35,49 +35,9 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.SqlVirtualMachine/sqlVirtualMachines' (ReadOnly, DeployTimeConstant): The resource type -## SqlVirtualMachineGroupProperties -### Properties -* **clusterConfiguration**: 'Domainful' | string (ReadOnly): Cluster type. -* **clusterManagerType**: 'WSFC' | string (ReadOnly): Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -* **scaleType**: 'HA' | string (ReadOnly): Scale type. -* **sqlImageOffer**: string: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. -* **sqlImageSku**: 'Developer' | 'Enterprise' | string: SQL image sku. -* **wsfcDomainProfile**: [WsfcDomainProfile](#wsfcdomainprofile): Active Directory account details to operate Windows Server Failover Cluster. - -## WsfcDomainProfile -### Properties -* **clusterBootstrapAccount**: string: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). -* **clusterOperatorAccount**: string: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. -* **domainFqdn**: string: Fully qualified name of the domain. -* **fileShareWitnessPath**: string: Optional path for fileshare witness. -* **ouPath**: string: Organizational Unit path in which the nodes and cluster will be present. -* **sqlServiceAccount**: string: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. -* **storageAccountPrimaryKey**: string (WriteOnly): Primary key of the witness storage account. -* **storageAccountUrl**: string: Fully qualified ARM resource id of the witness storage account. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AvailabilityGroupListenerProperties +## AdditionalFeaturesServerConfigurations ### Properties -* **availabilityGroupConfiguration**: [AgConfiguration](#agconfiguration): Availability group configuration. -* **availabilityGroupName**: string: Name of the availability group. -* **createDefaultAvailabilityGroupIfNotExist**: bool: Create a default availability group if it does not exist. -* **loadBalancerConfigurations**: [LoadBalancerConfiguration](#loadbalancerconfiguration)[]: List of load balancer configurations for an availability group listener. -* **port**: int: Listener port. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. +* **isRServicesEnabled**: bool: Enable or disable R services (SQL 2016 onwards). ## AgConfiguration ### Properties @@ -91,56 +51,12 @@ * **role**: 'PRIMARY' | 'SECONDARY' | string: Replica Role in availability group. * **sqlVirtualMachineInstanceId**: string: Sql VirtualMachine Instance Id. -## LoadBalancerConfiguration -### Properties -* **loadBalancerResourceId**: string: Resource id of the load balancer. -* **privateIpAddress**: [PrivateIPAddress](#privateipaddress): A private IP address bound to the availability group listener. -* **probePort**: int: Probe port. -* **publicIpAddressResourceId**: string: Resource id of the public IP. -* **sqlVirtualMachineInstances**: string[]: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. - -## PrivateIPAddress -### Properties -* **ipAddress**: string: Private IP address bound to the availability group listener. -* **subnetResourceId**: string: Subnet used to include private IP. - -## ResourceIdentity -### Properties -* **principalId**: string (ReadOnly): The Azure Active Directory principal id. -* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. -* **type**: 'None' | 'SystemAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. - -## SqlVirtualMachineProperties -### Properties -* **assessmentSettings**: [AssessmentSettings](#assessmentsettings): Configure assessment for databases in your SQL virtual machine. -* **autoBackupSettings**: [AutoBackupSettings](#autobackupsettings): Configure backups for databases in your SQL virtual machine. -* **autoPatchingSettings**: [AutoPatchingSettings](#autopatchingsettings): Set a patching window during which Windows and SQL patches will be applied. -* **keyVaultCredentialSettings**: [KeyVaultCredentialSettings](#keyvaultcredentialsettings): Configure your SQL virtual machine to be able to connect to the Azure Key Vault service. -* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. -* **serverConfigurationsManagementSettings**: [ServerConfigurationsManagementSettings](#serverconfigurationsmanagementsettings): Set the connectivity, storage and workload settings. -* **sqlImageOffer**: string: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. -* **sqlImageSku**: 'Developer' | 'Enterprise' | 'Express' | 'Standard' | 'Web' | string: SQL Server edition type. -* **sqlManagement**: 'Full' | 'LightWeight' | 'NoAgent' | string: SQL Server Management type. -* **sqlServerLicenseType**: 'AHUB' | 'DR' | 'PAYG' | string: SQL Server license type. -* **sqlVirtualMachineGroupResourceId**: string: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. -* **storageConfigurationSettings**: [StorageConfigurationSettings](#storageconfigurationsettings): Storage Configurations for SQL Data, Log and TempDb. -* **virtualMachineResourceId**: string: ARM Resource id of underlying virtual machine created from SQL marketplace image. -* **wsfcDomainCredentials**: [WsfcDomainCredentials](#wsfcdomaincredentials): Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. - ## AssessmentSettings ### Properties * **enable**: bool: Enable or disable assessment feature on SQL virtual machine. * **runImmediately**: bool: Run assessment immediately on SQL virtual machine. * **schedule**: [Schedule](#schedule) -## Schedule -### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Day of week to apply the patch on. -* **enable**: bool: Enable or disable assessment schedule on SQL virtual machine. -* **monthlyOccurrence**: int: Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month -* **startTime**: string: Time of the day in HH:mm format. Eg. 17:30 -* **weeklyInterval**: int: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 - ## AutoBackupSettings ### Properties * **backupScheduleType**: 'Automated' | 'Manual' | string: Backup schedule type. @@ -165,6 +81,15 @@ * **maintenanceWindowDuration**: int: Duration of patching. * **maintenanceWindowStartingHour**: int: Hour of the day when patching is initiated. Local VM time. +## AvailabilityGroupListenerProperties +### Properties +* **availabilityGroupConfiguration**: [AgConfiguration](#agconfiguration): Availability group configuration. +* **availabilityGroupName**: string: Name of the availability group. +* **createDefaultAvailabilityGroupIfNotExist**: bool: Create a default availability group if it does not exist. +* **loadBalancerConfigurations**: [LoadBalancerConfiguration](#loadbalancerconfiguration)[]: List of load balancer configurations for an availability group listener. +* **port**: int: Listener port. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. + ## KeyVaultCredentialSettings ### Properties * **azureKeyVaultUrl**: string: Azure Key Vault url. @@ -173,6 +98,33 @@ * **servicePrincipalName**: string: Service principal name to access key vault. * **servicePrincipalSecret**: string (WriteOnly): Service principal name secret to access key vault. +## LoadBalancerConfiguration +### Properties +* **loadBalancerResourceId**: string: Resource id of the load balancer. +* **privateIpAddress**: [PrivateIPAddress](#privateipaddress): A private IP address bound to the availability group listener. +* **probePort**: int: Probe port. +* **publicIpAddressResourceId**: string: Resource id of the public IP. +* **sqlVirtualMachineInstances**: string[]: List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. + +## PrivateIPAddress +### Properties +* **ipAddress**: string: Private IP address bound to the availability group listener. +* **subnetResourceId**: string: Subnet used to include private IP. + +## ResourceIdentity +### Properties +* **principalId**: string (ReadOnly): The Azure Active Directory principal id. +* **tenantId**: string (ReadOnly): The Azure Active Directory tenant id. +* **type**: 'None' | 'SystemAssigned' | string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. + +## Schedule +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday': Day of week to apply the patch on. +* **enable**: bool: Enable or disable assessment schedule on SQL virtual machine. +* **monthlyOccurrence**: int: Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month +* **startTime**: string: Time of the day in HH:mm format. Eg. 17:30 +* **weeklyInterval**: int: Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 + ## ServerConfigurationsManagementSettings ### Properties * **additionalFeaturesServerConfigurations**: [AdditionalFeaturesServerConfigurations](#additionalfeaturesserverconfigurations): Additional SQL Server feature settings. @@ -181,10 +133,6 @@ * **sqlStorageUpdateSettings**: [SqlStorageUpdateSettings](#sqlstorageupdatesettings): Set disk storage settings for SQL Server. * **sqlWorkloadTypeUpdateSettings**: [SqlWorkloadTypeUpdateSettings](#sqlworkloadtypeupdatesettings): Set workload type to optimize storage for SQL Server. -## AdditionalFeaturesServerConfigurations -### Properties -* **isRServicesEnabled**: bool: Enable or disable R services (SQL 2016 onwards). - ## SqlConnectivityUpdateSettings ### Properties * **connectivityType**: 'LOCAL' | 'PRIVATE' | 'PUBLIC' | string: SQL Server connectivity option. @@ -200,12 +148,54 @@ * **maxServerMemoryMB**: int: SQL Server maximum memory. * **minServerMemoryMB**: int: SQL Server minimum memory. +## SQLStorageSettings +### Properties +* **defaultFilePath**: string: SQL Server default file path +* **luns**: int[]: Logical Unit Numbers for the disks. + ## SqlStorageUpdateSettings ### Properties * **diskConfigurationType**: 'ADD' | 'EXTEND' | 'NEW' | string: Disk configuration to apply to SQL Server. * **diskCount**: int: Virtual machine disk count. * **startingDeviceId**: int: Device id of the first disk to be updated. +## SQLTempDbSettings +### Properties +* **dataFileCount**: int: SQL Server default file count +* **dataFileSize**: int: SQL Server default file size +* **dataGrowth**: int: SQL Server default file autoGrowth size +* **defaultFilePath**: string: SQL Server default file path +* **logFileSize**: int: SQL Server default file size +* **logGrowth**: int: SQL Server default file autoGrowth size +* **luns**: int[]: Logical Unit Numbers for the disks. + +## SqlVirtualMachineGroupProperties +### Properties +* **clusterConfiguration**: 'Domainful' | string (ReadOnly): Cluster type. +* **clusterManagerType**: 'WSFC' | string (ReadOnly): Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. +* **scaleType**: 'HA' | string (ReadOnly): Scale type. +* **sqlImageOffer**: string: SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016. +* **sqlImageSku**: 'Developer' | 'Enterprise' | string: SQL image sku. +* **wsfcDomainProfile**: [WsfcDomainProfile](#wsfcdomainprofile): Active Directory account details to operate Windows Server Failover Cluster. + +## SqlVirtualMachineProperties +### Properties +* **assessmentSettings**: [AssessmentSettings](#assessmentsettings): Configure assessment for databases in your SQL virtual machine. +* **autoBackupSettings**: [AutoBackupSettings](#autobackupsettings): Configure backups for databases in your SQL virtual machine. +* **autoPatchingSettings**: [AutoPatchingSettings](#autopatchingsettings): Set a patching window during which Windows and SQL patches will be applied. +* **keyVaultCredentialSettings**: [KeyVaultCredentialSettings](#keyvaultcredentialsettings): Configure your SQL virtual machine to be able to connect to the Azure Key Vault service. +* **provisioningState**: string (ReadOnly): Provisioning state to track the async operation status. +* **serverConfigurationsManagementSettings**: [ServerConfigurationsManagementSettings](#serverconfigurationsmanagementsettings): Set the connectivity, storage and workload settings. +* **sqlImageOffer**: string: SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. +* **sqlImageSku**: 'Developer' | 'Enterprise' | 'Express' | 'Standard' | 'Web' | string: SQL Server edition type. +* **sqlManagement**: 'Full' | 'LightWeight' | 'NoAgent' | string: SQL Server Management type. +* **sqlServerLicenseType**: 'AHUB' | 'DR' | 'PAYG' | string: SQL Server license type. +* **sqlVirtualMachineGroupResourceId**: string: ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. +* **storageConfigurationSettings**: [StorageConfigurationSettings](#storageconfigurationsettings): Storage Configurations for SQL Data, Log and TempDb. +* **virtualMachineResourceId**: string: ARM Resource id of underlying virtual machine created from SQL marketplace image. +* **wsfcDomainCredentials**: [WsfcDomainCredentials](#wsfcdomaincredentials): Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. + ## SqlWorkloadTypeUpdateSettings ### Properties * **sqlWorkloadType**: 'DW' | 'GENERAL' | 'OLTP' | string: SQL Server workload type. @@ -219,20 +209,24 @@ * **sqlTempDbSettings**: [SQLTempDbSettings](#sqltempdbsettings) * **storageWorkloadType**: 'DW' | 'GENERAL' | 'OLTP' | string: Storage workload type. -## SQLStorageSettings +## SystemData ### Properties -* **defaultFilePath**: string: SQL Server default file path -* **luns**: int[]: Logical Unit Numbers for the disks. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## SQLTempDbSettings +## TrackedResourceTags ### Properties -* **dataFileCount**: int: SQL Server default file count -* **dataFileSize**: int: SQL Server default file size -* **dataGrowth**: int: SQL Server default file autoGrowth size -* **defaultFilePath**: string: SQL Server default file path -* **logFileSize**: int: SQL Server default file size -* **logGrowth**: int: SQL Server default file autoGrowth size -* **luns**: int[]: Logical Unit Numbers for the disks. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## WsfcDomainCredentials ### Properties @@ -240,8 +234,14 @@ * **clusterOperatorAccountPassword**: string: Cluster operator account password. * **sqlServiceAccountPassword**: string: SQL service account password. -## TrackedResourceTags +## WsfcDomainProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clusterBootstrapAccount**: string: Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). +* **clusterOperatorAccount**: string: Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. +* **domainFqdn**: string: Fully qualified name of the domain. +* **fileShareWitnessPath**: string: Optional path for fileshare witness. +* **ouPath**: string: Organizational Unit path in which the nodes and cluster will be present. +* **sqlServiceAccount**: string: Account name under which SQL service will run on all participating SQL virtual machines in the cluster. +* **storageAccountPrimaryKey**: string (WriteOnly): Primary key of the witness storage account. +* **storageAccountUrl**: string: Fully qualified ARM resource id of the witness storage account. diff --git a/generated/storage/log.out b/generated/storage/log.out index 7102d0976b..88d38d8d72 100644 --- a/generated/storage/log.out +++ b/generated/storage/log.out @@ -35,7 +35,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.storage-2021-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -70,7 +70,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2021-09-01/storage.json:2187:5 @@ -365,7 +365,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceProperties warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 31ms +info | autorest.bicep took 28ms info | Processing batch task - {"tag":"microsoft.storage-2021-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -400,7 +400,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2021-08-01/storage.json:2160:5 @@ -729,7 +729,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2021-06-01/storage.json:1867:5 @@ -1070,7 +1070,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2021-04-01/storage.json:1753:5 @@ -1376,7 +1376,7 @@ warning | PreCheck/DuplicateSchema | Duplicate Schema named 'CloudErrorBody' (1 warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CloudError' -> 'CloudErrorAutoGenerated' warning | PreNamer/DeduplicateName | Deduplicating schema name: 'CloudErrorBody' -> 'CloudErrorBodyAutoGenerated' info | Resource type microsoft.storage/storageaccounts/tableservices/tables under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}' has no body defined. -info | autorest.bicep took 14ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.storage-2021-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1411,7 +1411,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2021-02-01/storage.json:1753:5 @@ -1697,7 +1697,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionList warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.storage/storageaccounts/tableservices/tables under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}' has no body defined. -info | autorest.bicep took 13ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.storage-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1732,7 +1732,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2021-01-01/storage.json:1753:5 @@ -2012,7 +2012,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionList warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.storage/storageaccounts/tableservices/tables under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}' has no body defined. -info | autorest.bicep took 15ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.storage-2020-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2047,7 +2047,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json:1741:5 @@ -2323,7 +2323,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionList warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.storage/storageaccounts/tableservices/tables under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}' has no body defined. -info | autorest.bicep took 14ms +info | autorest.bicep took 27ms info | Processing batch task - {"tag":"microsoft.storage-2019-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2358,7 +2358,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json:1656:5 @@ -2618,7 +2618,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointConnectionList warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkResourceListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.storage/storageaccounts/tableservices/tables under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}' has no body defined. -info | autorest.bicep took 10ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.storage-2019-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2653,7 +2653,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/storage.json:794:5 @@ -2855,7 +2855,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/storage.json:778:5 @@ -2996,7 +2996,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerRequest' with a warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2018-11-01/blob.json:1207:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 11ms +info | autorest.bicep took 13ms info | Processing batch task - {"tag":"microsoft.storage-2018-07-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3031,7 +3031,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json:617:5 @@ -3150,7 +3150,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerRequest' with a warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json:1201:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.storage-2018-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3185,7 +3185,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageAccountManagementPolicies' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/managementpolicy.json:143:5 @@ -3309,7 +3309,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerResponse' with - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json:1006:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.storage-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3344,7 +3344,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json:644:5 @@ -3451,7 +3451,7 @@ warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerRequest' with a warning | PreCheck/SchemaMissingType | The schema 'LeaseContainerResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json:1006:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 6ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.storage-2017-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3486,7 +3486,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json:608:5 @@ -3604,7 +3604,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json:608:5 @@ -3722,7 +3722,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageAccountCheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json:485:5 @@ -3812,7 +3812,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageAccountCheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json:482:5 @@ -3867,7 +3867,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ServiceSasParameters' with an warning | PreCheck/SchemaMissingType | The schema 'ListServiceSasResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json:1269:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storage-2016-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3902,7 +3902,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageAccountCheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json:419:5 @@ -3949,7 +3949,7 @@ warning | PreCheck/SchemaMissingType | The schema 'UsageListResult' with an unde warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json:954:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.storage-2015-06-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3984,7 +3984,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageAccountCheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json:412:5 @@ -4021,7 +4021,7 @@ warning | PreCheck/SchemaMissingType | The schema 'UsageListResult' with an unde warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json:780:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.storage-2015-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4056,7 +4056,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'StorageAccountCheckNameAvailabilityParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/preview/2015-05-01-preview/storage.json:422:5 @@ -4096,4 +4096,4 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/preview/2015-05-01-preview/storage.json:795:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 1ms -info | Autorest completed in 99.28s. 40 files generated. +info | Autorest completed in 95.12s. 40 files generated. diff --git a/generated/storage/microsoft.storage/2015-05-01-preview/types.md b/generated/storage/microsoft.storage/2015-05-01-preview/types.md index 503bb1d867..eff8cca7fb 100644 --- a/generated/storage/microsoft.storage/2015-05-01-preview/types.md +++ b/generated/storage/microsoft.storage/2015-05-01-preview/types.md @@ -16,20 +16,6 @@ * **ApiVersion**: 2015-05-01-preview * **Output**: [StorageAccountKeys](#storageaccountkeys) -## StorageAccountPropertiesCreateParameters -### Properties -* **accountType**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS': Gets or sets the account type. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain) (ReadOnly): The custom domain assigned to this storage account. This can be set via Update. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS. -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS. -* **statusOfPrimary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. - ## CustomDomain ### Properties * **name**: string (ReadOnly): Gets or sets the custom domain name. Name is the CNAME source. @@ -51,3 +37,17 @@ * **key1**: string (ReadOnly): Gets the value of key 1. * **key2**: string (ReadOnly): Gets the value of key 2. +## StorageAccountPropertiesCreateParameters +### Properties +* **accountType**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS': Gets or sets the account type. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain) (ReadOnly): The custom domain assigned to this storage account. This can be set via Update. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS. +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS. +* **statusOfPrimary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. + diff --git a/generated/storage/microsoft.storage/2015-06-15/types.md b/generated/storage/microsoft.storage/2015-06-15/types.md index 150071fb19..2c286d3828 100644 --- a/generated/storage/microsoft.storage/2015-06-15/types.md +++ b/generated/storage/microsoft.storage/2015-06-15/types.md @@ -16,20 +16,6 @@ * **ApiVersion**: 2015-06-15 * **Output**: [StorageAccountKeys](#storageaccountkeys) -## StorageAccountPropertiesCreateParameters -### Properties -* **accountType**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): The sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **creationTime**: string (ReadOnly): The creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain) (ReadOnly): The custom domain assigned to this storage account. This can be set via Update. -* **lastGeoFailoverTime**: string (ReadOnly): The timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. -* **primaryLocation**: string (ReadOnly): The location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): The status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. -* **secondaryLocation**: string (ReadOnly): The location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'Available' | 'Unavailable' (ReadOnly): The status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'Available' | 'Unavailable' (ReadOnly): The status indicating whether the primary location of the storage account is available or unavailable. - ## CustomDomain ### Properties * **name**: string (ReadOnly): The custom domain name. Name is the CNAME source. @@ -52,3 +38,17 @@ * **key1**: string (ReadOnly): The value of key 1. * **key2**: string (ReadOnly): The value of key 2. +## StorageAccountPropertiesCreateParameters +### Properties +* **accountType**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): The sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **creationTime**: string (ReadOnly): The creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain) (ReadOnly): The custom domain assigned to this storage account. This can be set via Update. +* **lastGeoFailoverTime**: string (ReadOnly): The timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. +* **primaryLocation**: string (ReadOnly): The location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): The status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue or table object. +* **secondaryLocation**: string (ReadOnly): The location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'Available' | 'Unavailable' (ReadOnly): The status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'Available' | 'Unavailable' (ReadOnly): The status indicating whether the primary location of the storage account is available or unavailable. + diff --git a/generated/storage/microsoft.storage/2016-01-01/types.md b/generated/storage/microsoft.storage/2016-01-01/types.md index d6b6d4fe8d..7f6287d1c8 100644 --- a/generated/storage/microsoft.storage/2016-01-01/types.md +++ b/generated/storage/microsoft.storage/2016-01-01/types.md @@ -18,21 +18,6 @@ * **ApiVersion**: 2016-01-01 * **Output**: [StorageAccountListKeysResult](#storageaccountlistkeysresult) -## StorageAccountPropertiesCreateParameters -### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. - ## CustomDomain ### Properties * **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. @@ -43,15 +28,15 @@ * **keySource**: 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - ## EncryptionService ### Properties * **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. * **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. +## EncryptionServices +### Properties +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. + ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -69,13 +54,28 @@ ### Additional Properties * **Additional Properties Type**: string -## StorageAccountListKeysResult -### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. - ## StorageAccountKey ### Properties * **keyName**: string (ReadOnly): Name of the key. * **permissions**: 'FULL' | 'READ' (ReadOnly): Permissions for the key -- read-only or full permissions. * **value**: string (ReadOnly): Base 64-encoded value of the key. +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'Available' | 'Unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. + diff --git a/generated/storage/microsoft.storage/2016-05-01/types.md b/generated/storage/microsoft.storage/2016-05-01/types.md index 05a66f4b82..eb03222cc6 100644 --- a/generated/storage/microsoft.storage/2016-05-01/types.md +++ b/generated/storage/microsoft.storage/2016-05-01/types.md @@ -30,20 +30,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## StorageAccountPropertiesCreateParameters +## AccountSasParameters ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## CustomDomain ### Properties @@ -55,15 +51,15 @@ * **keySource**: 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - ## EncryptionService ### Properties * **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. * **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. +## EncryptionServices +### Properties +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. + ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -71,40 +67,13 @@ * **queue**: string (ReadOnly): Gets the queue endpoint. * **table**: string (ReadOnly): Gets the table endpoint. -## Sku -### Properties -* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - ## ListAccountSasResponse ### Properties * **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## StorageAccountListKeysResult -### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. - -## StorageAccountKey +## ListServiceSasResponse ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ServiceSasParameters ### Properties @@ -127,7 +96,38 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. diff --git a/generated/storage/microsoft.storage/2016-12-01/types.md b/generated/storage/microsoft.storage/2016-12-01/types.md index 30d60c38f3..230ce903cd 100644 --- a/generated/storage/microsoft.storage/2016-12-01/types.md +++ b/generated/storage/microsoft.storage/2016-12-01/types.md @@ -30,21 +30,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## StorageAccountPropertiesCreateParameters +## AccountSasParameters ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## CustomDomain ### Properties @@ -56,6 +51,11 @@ * **keySource**: 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. +## EncryptionService +### Properties +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. + ## EncryptionServices ### Properties * **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. @@ -63,11 +63,6 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -75,40 +70,13 @@ * **queue**: string (ReadOnly): Gets the queue endpoint. * **table**: string (ReadOnly): Gets the table endpoint. -## Sku -### Properties -* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - ## ListAccountSasResponse ### Properties * **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## StorageAccountListKeysResult -### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. - -## StorageAccountKey +## ListServiceSasResponse ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ServiceSasParameters ### Properties @@ -131,7 +99,39 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. diff --git a/generated/storage/microsoft.storage/2017-06-01/types.md b/generated/storage/microsoft.storage/2017-06-01/types.md index a82760a937..e92c7c0436 100644 --- a/generated/storage/microsoft.storage/2017-06-01/types.md +++ b/generated/storage/microsoft.storage/2017-06-01/types.md @@ -31,28 +31,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. - -## StorageAccountPropertiesCreateParameters +## AccountSasParameters ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## CustomDomain ### Properties @@ -65,11 +53,10 @@ * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -78,50 +65,44 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService +## Endpoints ### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. -## NetworkRuleSet +## Identity ### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## IPRule ### Properties * **action**: 'Allow': The action of virtual network rule. * **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## VirtualNetworkRule +## KeyVaultProperties ### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. -## Endpoints +## ListAccountSasResponse ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## Sku +## ListServiceSasResponse ### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **kind**: 'BlobStorage' | 'Storage' (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. -## SKUCapability +## NetworkRuleSet ### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules ## Restriction ### Properties @@ -129,36 +110,6 @@ * **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. * **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse -### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. - -## StorageAccountListKeysResult -### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. - -## StorageAccountKey -### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. - ## ServiceSasParameters ### Properties * **canonicalizedResource**: string (Required, WriteOnly): The canonical path to the signed resource. @@ -180,7 +131,56 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **kind**: 'BlobStorage' | 'Storage' (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2017-10-01/types.md b/generated/storage/microsoft.storage/2017-10-01/types.md index 1e47152d22..5ae9e91b6d 100644 --- a/generated/storage/microsoft.storage/2017-10-01/types.md +++ b/generated/storage/microsoft.storage/2017-10-01/types.md @@ -31,28 +31,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. - -## StorageAccountPropertiesCreateParameters +## AccountSasParameters ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## CustomDomain ### Properties @@ -65,11 +53,10 @@ * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -78,50 +65,44 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService +## Endpoints ### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. -## NetworkRuleSet +## Identity ### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## IPRule ### Properties * **action**: 'Allow': The action of virtual network rule. * **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## VirtualNetworkRule +## KeyVaultProperties ### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. -## Endpoints +## ListAccountSasResponse ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## Sku +## ListServiceSasResponse ### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **kind**: 'BlobStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. -## SKUCapability +## NetworkRuleSet ### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules ## Restriction ### Properties @@ -129,36 +110,6 @@ * **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. * **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse -### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. - -## StorageAccountListKeysResult -### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. - -## StorageAccountKey -### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. - ## ServiceSasParameters ### Properties * **canonicalizedResource**: string (Required, WriteOnly): The canonical path to the signed resource. @@ -180,7 +131,56 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **kind**: 'BlobStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, or table object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2018-02-01/types.md b/generated/storage/microsoft.storage/2018-02-01/types.md index f663e05bcf..9b154efaab 100644 --- a/generated/storage/microsoft.storage/2018-02-01/types.md +++ b/generated/storage/microsoft.storage/2018-02-01/types.md @@ -51,29 +51,34 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity +## AccountSasParameters ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. -## StorageAccountPropertiesCreateParameters +## ContainerProperties ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. +* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. +* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. + +## ContainerPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string ## CustomDomain ### Properties @@ -86,11 +91,10 @@ * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -99,29 +103,6 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -131,44 +112,11 @@ * **table**: string (ReadOnly): Gets the table endpoint. * **web**: string (ReadOnly): Gets the web endpoint. -## Sku -### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **kind**: 'BlobStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## SKUCapability -### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. - -## Restriction -### Properties -* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. -* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. -* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. - -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ContainerProperties +## Identity ### Properties -* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. -* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. -* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## ImmutabilityPolicyProperties ### Properties @@ -181,57 +129,42 @@ * **immutabilityPeriodSinceCreationInDays**: int (Required): The immutability period for the blobs in the container since the policy creation, in days. * **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## UpdateHistoryProperty +## IPRule ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + +## KeyVaultProperties +### Properties +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. ## LegalHoldProperties ### Properties * **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. * **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## TagProperty -### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. - -## ContainerPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - ## ListAccountSasResponse ### Properties * **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## StorageAccountListKeysResult +## ListServiceSasResponse ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. -## StorageAccountKey +## NetworkRuleSet ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## Restriction +### Properties +* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. +* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. +* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ## ServiceSasParameters ### Properties @@ -254,7 +187,74 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **kind**: 'BlobStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2018-03-01-preview/types.md b/generated/storage/microsoft.storage/2018-03-01-preview/types.md index 9b157512af..ab400a05e7 100644 --- a/generated/storage/microsoft.storage/2018-03-01-preview/types.md +++ b/generated/storage/microsoft.storage/2018-03-01-preview/types.md @@ -60,29 +60,34 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity +## AccountSasParameters ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. -## StorageAccountPropertiesCreateParameters +## ContainerProperties ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. +* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. +* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. + +## ContainerPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string ## CustomDomain ### Properties @@ -95,11 +100,10 @@ * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -108,29 +112,6 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -140,44 +121,11 @@ * **table**: string (ReadOnly): Gets the table endpoint. * **web**: string (ReadOnly): Gets the web endpoint. -## Sku -### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **kind**: 'BlobStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. - -## SKUCapability -### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. - -## Restriction -### Properties -* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. -* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. -* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. - -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ContainerProperties +## Identity ### Properties -* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. -* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. -* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## ImmutabilityPolicyProperties ### Properties @@ -190,62 +138,47 @@ * **immutabilityPeriodSinceCreationInDays**: int (Required): The immutability period for the blobs in the container since the policy creation, in days. * **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## UpdateHistoryProperty +## IPRule ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + +## KeyVaultProperties +### Properties +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. ## LegalHoldProperties ### Properties * **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. * **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## TagProperty +## ListAccountSasResponse ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ContainerPropertiesMetadata +## ListServiceSasResponse ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPoliciesRules ### Properties * **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. * **policy**: any: Any object -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse -### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. - -## StorageAccountListKeysResult +## NetworkRuleSet ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules -## StorageAccountKey +## Restriction ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. +* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. +* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ## ServiceSasParameters ### Properties @@ -268,7 +201,74 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **kind**: 'BlobStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the sku tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2018-07-01/types.md b/generated/storage/microsoft.storage/2018-07-01/types.md index 4e3a07614d..73662d8db3 100644 --- a/generated/storage/microsoft.storage/2018-07-01/types.md +++ b/generated/storage/microsoft.storage/2018-07-01/types.md @@ -60,49 +60,73 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity +## AccountSasParameters ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. -## StorageAccountPropertiesCreateParameters +## BlobServicePropertiesProperties ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **azureFilesAadIntegration**: bool: Enables Azure Files AAD Integration for SMB if sets to true. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **defaultServiceVersion**: 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. +* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The blob service properties for soft delete. + +## ContainerProperties +### Properties +* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. +* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. +* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. + +## ContainerPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## CorsRule +### Properties +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. + +## CorsRules +### Properties +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. ## CustomDomain ### Properties * **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. * **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled for the Blob service. + ## Encryption ### Properties * **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -111,35 +135,6 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -149,67 +144,17 @@ * **table**: string (ReadOnly): Gets the table endpoint. * **web**: string (ReadOnly): Gets the web endpoint. -## Sku -### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. -* **kind**: 'BlobStorage' | 'BlockBlobStorage' | 'FileStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the SKU tier. This is based on the SKU name. - -## SKUCapability -### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. - -## Restriction -### Properties -* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. -* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. -* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. - -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BlobServicePropertiesProperties -### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **defaultServiceVersion**: 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. -* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The blob service properties for soft delete. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## DeleteRetentionPolicy +## GeoReplicationStats ### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled for the Blob service. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## ContainerProperties +## Identity ### Properties -* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. -* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. -* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## ImmutabilityPolicyProperties ### Properties @@ -222,57 +167,42 @@ * **immutabilityPeriodSinceCreationInDays**: int (Required): The immutability period for the blobs in the container since the policy creation, in days. * **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## UpdateHistoryProperty +## IPRule ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + +## KeyVaultProperties +### Properties +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. ## LegalHoldProperties ### Properties * **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. * **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## TagProperty -### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. - -## ContainerPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - ## ListAccountSasResponse ### Properties * **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## StorageAccountListKeysResult +## ListServiceSasResponse ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. -## StorageAccountKey +## NetworkRuleSet ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## Restriction +### Properties +* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. +* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. +* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ## ServiceSasParameters ### Properties @@ -295,7 +225,77 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. +* **kind**: 'BlobStorage' | 'BlockBlobStorage' | 'FileStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the SKU tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **azureFilesAadIntegration**: bool: Enables Azure Files AAD Integration for SMB if sets to true. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2018-11-01/types.md b/generated/storage/microsoft.storage/2018-11-01/types.md index 24973877f2..634f837990 100644 --- a/generated/storage/microsoft.storage/2018-11-01/types.md +++ b/generated/storage/microsoft.storage/2018-11-01/types.md @@ -69,49 +69,81 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity +## AccountSasParameters ### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. -## StorageAccountPropertiesCreateParameters +## BlobServicePropertiesProperties ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **azureFilesAadIntegration**: bool: Enables Azure Files AAD Integration for SMB if sets to true. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **defaultServiceVersion**: 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. +* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The blob service properties for soft delete. + +## ContainerProperties +### Properties +* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. +* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. +* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. + +## ContainerPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## CorsRule +### Properties +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. + +## CorsRules +### Properties +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. ## CustomDomain ### Properties * **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. * **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. +## DateAfterCreation +### Properties +* **daysAfterCreationGreaterThan**: int (Required): Integer value indicating the age in days after creation + +## DateAfterModification +### Properties +* **daysAfterModificationGreaterThan**: int (Required): Integer value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled for the Blob service. + ## Encryption ### Properties * **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -120,35 +152,6 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -158,67 +161,17 @@ * **table**: string (ReadOnly): Gets the table endpoint. * **web**: string (ReadOnly): Gets the web endpoint. -## Sku -### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. -* **kind**: 'BlobStorage' | 'BlockBlobStorage' | 'FileStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the SKU tier. This is based on the SKU name. - -## SKUCapability -### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. - -## Restriction -### Properties -* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. -* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. -* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. - -## StorageAccountCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BlobServicePropertiesProperties -### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **defaultServiceVersion**: 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. -* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The blob service properties for soft delete. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## DeleteRetentionPolicy +## GeoReplicationStats ### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled for the Blob service. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## ContainerProperties +## Identity ### Properties -* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. -* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. -* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## ImmutabilityPolicyProperties ### Properties @@ -231,53 +184,29 @@ * **immutabilityPeriodSinceCreationInDays**: int (Required): The immutability period for the blobs in the container since the policy creation, in days. * **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## UpdateHistoryProperty +## IPRule ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + +## KeyVaultProperties +### Properties +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. ## LegalHoldProperties ### Properties * **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. * **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## TagProperty -### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. - -## ContainerPropertiesMetadata -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagementPolicyProperties -### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. - -## ManagementPolicySchema -### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. - -## ManagementPolicyRule +## ListAccountSasResponse ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ManagementPolicyDefinition +## ListServiceSasResponse ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPolicyAction ### Properties @@ -290,47 +219,48 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterModificationGreaterThan**: int (Required): Integer value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. -## ManagementPolicySnapShot +## ManagementPolicyFilter ### Properties -* **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. +* **blobTypes**: string[] (Required): An array of predefined enum values. Only blockBlob is supported. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. -## DateAfterCreation +## ManagementPolicyProperties ### Properties -* **daysAfterCreationGreaterThan**: int (Required): Integer value indicating the age in days after creation +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. -## ManagementPolicyFilter +## ManagementPolicyRule ### Properties -* **blobTypes**: string[] (Required): An array of predefined enum values. Only blockBlob is supported. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle -## AccountSasParameters +## ManagementPolicySchema ### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. -## ListAccountSasResponse +## ManagementPolicySnapShot ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## StorageAccountListKeysResult +## NetworkRuleSet ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules -## StorageAccountKey +## Restriction ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. +* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. +* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ## ServiceSasParameters ### Properties @@ -353,7 +283,77 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. +* **kind**: 'BlobStorage' | 'BlockBlobStorage' | 'FileStorage' | 'Storage' | 'StorageV2' (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_ZRS' (Required): Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the SKU tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **azureFilesAadIntegration**: bool: Enables Azure Files AAD Integration for SMB if sets to true. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2019-04-01/types.md b/generated/storage/microsoft.storage/2019-04-01/types.md index c2729ba620..4b4cdd8cc2 100644 --- a/generated/storage/microsoft.storage/2019-04-01/types.md +++ b/generated/storage/microsoft.storage/2019-04-01/types.md @@ -88,41 +88,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. - -## StorageAccountPropertiesCreateParameters -### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. - -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -133,22 +108,81 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. +## AzureFilesIdentityBasedAuthentication +### Properties +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. + +## BlobServicePropertiesProperties +### Properties +* **automaticSnapshotPolicyEnabled**: bool: Automatic Snapshot is enabled if set to true. +* **changeFeed**: [ChangeFeed](#changefeed): The blob service properties for change feed events. +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **defaultServiceVersion**: 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. +* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The blob service properties for soft delete. + +## ChangeFeed +### Properties +* **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. + +## ContainerProperties +### Properties +* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. +* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. +* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. + +## ContainerPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## CorsRule +### Properties +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. + +## CorsRules +### Properties +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. + ## CustomDomain ### Properties * **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. * **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. +## DateAfterCreation +### Properties +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation + +## DateAfterModification +### Properties +* **daysAfterModificationGreaterThan**: int (Required): Value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled for the Blob service. + ## Encryption ### Properties * **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault * **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. * **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## KeyVaultProperties +## EncryptionService ### Properties -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. ## EncryptionServices ### Properties @@ -157,35 +191,6 @@ * **queue**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. * **table**: [EncryptionService](#encryptionservice) (ReadOnly): A service that allows server-side encryption to be used. -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - ## Endpoints ### Properties * **blob**: string (ReadOnly): Gets the blob endpoint. @@ -195,73 +200,32 @@ * **table**: string (ReadOnly): Gets the table endpoint. * **web**: string (ReadOnly): Gets the web endpoint. -## Sku -### Properties -* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. -* **kind**: 'BlobStorage' | 'BlockBlobStorage' | 'FileStorage' | 'Storage' | 'StorageV2' | string (ReadOnly): Indicates the type of storage account. -* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. -* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. -* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the SKU tier. This is based on the SKU name. - -## SKUCapability +## FileServicePropertiesProperties ### Properties -* **name**: string (ReadOnly): The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. -* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## Restriction +## FileShareProperties ### Properties -* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. -* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. -* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the share was last modified. +* **metadata**: [FileSharePropertiesMetadata](#filesharepropertiesmetadata): A name-value pair to associate with the share as metadata. +* **shareQuota**: int: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). -## StorageAccountCreateParametersTags +## FileSharePropertiesMetadata ### Properties ### Additional Properties * **Additional Properties Type**: string -## BlobServicePropertiesProperties -### Properties -* **automaticSnapshotPolicyEnabled**: bool: Automatic Snapshot is enabled if set to true. -* **changeFeed**: [ChangeFeed](#changefeed): The blob service properties for change feed events. -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **defaultServiceVersion**: 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. -* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The blob service properties for soft delete. - -## ChangeFeed -### Properties -* **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## DeleteRetentionPolicy +## GeoReplicationStats ### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled for the Blob service. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## ContainerProperties +## Identity ### Properties -* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. -* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. -* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. ## ImmutabilityPolicyProperties ### Properties @@ -274,57 +238,56 @@ * **immutabilityPeriodSinceCreationInDays**: int (Required): The immutability period for the blobs in the container since the policy creation, in days. * **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## UpdateHistoryProperty +## IPRule ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + +## KeyVaultProperties +### Properties +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. ## LegalHoldProperties ### Properties * **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. * **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## TagProperty +## ListAccountSasResponse ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ContainerPropertiesMetadata +## ListServiceSasResponse ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. -## FileServicePropertiesProperties +## ManagementPolicyAction ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **baseBlob**: [ManagementPolicyBaseBlob](#managementpolicybaseblob): Management policy action for base blob. +* **snapshot**: [ManagementPolicySnapShot](#managementpolicysnapshot): Management policy action for snapshot. -## FileShareProperties +## ManagementPolicyBaseBlob ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the share was last modified. -* **metadata**: [FileSharePropertiesMetadata](#filesharepropertiesmetadata): A name-value pair to associate with the share as metadata. -* **shareQuota**: int: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). +* **delete**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. +* **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. +* **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. -## FileSharePropertiesMetadata +## ManagementPolicyDefinition ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobTypes**: string[] (Required): An array of predefined enum values. Only blockBlob is supported. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. ## ManagementPolicyProperties ### Properties * **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. * **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. -## ManagementPolicySchema -### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. - ## ManagementPolicyRule ### Properties * **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. @@ -332,63 +295,26 @@ * **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. * **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle -## ManagementPolicyDefinition -### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. - -## ManagementPolicyAction -### Properties -* **baseBlob**: [ManagementPolicyBaseBlob](#managementpolicybaseblob): Management policy action for base blob. -* **snapshot**: [ManagementPolicySnapShot](#managementpolicysnapshot): Management policy action for snapshot. - -## ManagementPolicyBaseBlob -### Properties -* **delete**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. -* **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. -* **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after last modification. - -## DateAfterModification +## ManagementPolicySchema ### Properties -* **daysAfterModificationGreaterThan**: int (Required): Value indicating the age in days after last modification +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - -## ManagementPolicyFilter -### Properties -* **blobTypes**: string[] (Required): An array of predefined enum values. Only blockBlob is supported. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse -### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. - -## StorageAccountListKeysResult +## NetworkRuleSet ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules -## StorageAccountKey +## Restriction ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **reasonCode**: 'NotAvailableForSubscription' | 'QuotaId' | string: 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. +* **type**: string (ReadOnly): The type of restrictions. As of now only possible value for this is location. +* **values**: string[] (ReadOnly): The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ## ServiceSasParameters ### Properties @@ -411,7 +337,81 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **capabilities**: [SKUCapability](#skucapability)[] (ReadOnly): The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. +* **kind**: 'BlobStorage' | 'BlockBlobStorage' | 'FileStorage' | 'Storage' | 'StorageV2' | string (ReadOnly): Indicates the type of storage account. +* **locations**: string[] (ReadOnly): The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **resourceType**: string (ReadOnly): The type of the resource, usually it is 'storageAccounts'. +* **restrictions**: [Restriction](#restriction)[]: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. +* **tier**: 'Premium' | 'Standard' (ReadOnly): Gets the SKU tier. This is based on the SKU name. + +## SKUCapability +### Properties +* **name**: string (ReadOnly): The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. +* **value**: string (ReadOnly): A string value to indicate states of given capability. Possibly 'true' or 'false'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2019-06-01/types.md b/generated/storage/microsoft.storage/2019-06-01/types.md index b04118e405..f1c0657502 100644 --- a/generated/storage/microsoft.storage/2019-06-01/types.md +++ b/generated/storage/microsoft.storage/2019-06-01/types.md @@ -163,44 +163,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. - -## StorageAccountPropertiesCreateParameters -### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. - -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -211,145 +183,56 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## StorageAccountMicrosoftEndpoints +## BlobInventoryPolicyDefinition ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. -## PrivateEndpointConnection +## BlobInventoryPolicyFilter ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateEndpoint +## BlobInventoryPolicyRule ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicySchema ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## RoutingPreference +## BlobRestoreParameters ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -368,37 +251,6 @@ * **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. * **retentionInDays**: int: 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. -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. - ## ContainerProperties ### Properties * **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. @@ -418,44 +270,52 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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 -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. -## UpdateHistoryProperty +## CorsRules ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. -## LegalHoldProperties +## CustomDomain ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## TagProperty +## DateAfterCreation ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## ContainerPropertiesMetadata +## DateAfterModification ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. + +## Encryption +### Properties +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. + +## EncryptionScopeKeyVaultProperties +### Properties +* **keyUri**: string: 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. ## EncryptionScopeProperties ### Properties @@ -465,9 +325,29 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **keyUri**: string: 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. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. + +## EncryptionServices +### Properties +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. + +## Endpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. ## FileServicePropertiesProperties ### Properties @@ -495,64 +375,62 @@ ### Additional Properties * **Additional Properties Type**: string -## BlobInventoryPolicyProperties +## GeoReplicationStats ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## BlobInventoryPolicySchema +## Identity ### Properties -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. -## BlobInventoryPolicyRule +## ImmutabilityPolicyProperties ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyDefinition +## ImmutabilityPolicyProperty ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. +* **allowProtectedAppendWrites**: bool: 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 +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## BlobInventoryPolicyFilter +## IPRule ### Properties -* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## SystemData +## KeyVaultProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## ManagementPolicyProperties +## LastAccessTimeTrackingPolicy ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 -## ManagementPolicySchema +## LegalHoldProperties ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## ManagementPolicyRule +## ListAccountSasResponse ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ManagementPolicyDefinition +## ListServiceSasResponse ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPolicyAction ### Properties @@ -567,10 +445,32 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + +## ManagementPolicyRule +### Properties +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle + +## ManagementPolicySchema +### Properties +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -578,27 +478,23 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## NetworkRuleSet ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules -## TagFilter +## ObjectReplicationPolicyFilter ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -615,14 +511,28 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PrivateEndpoint ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## QueueServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. ## QueueProperties ### Properties @@ -634,38 +544,22 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse -### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. - -## StorageAccountListKeysResult +## RestorePolicyProperties ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountKey +## RoutingPreference ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. ## ServiceSasParameters ### Properties @@ -688,7 +582,113 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2020-08-01-preview/types.md b/generated/storage/microsoft.storage/2020-08-01-preview/types.md index d33eb2fda5..bc6bcb46a9 100644 --- a/generated/storage/microsoft.storage/2020-08-01-preview/types.md +++ b/generated/storage/microsoft.storage/2020-08-01-preview/types.md @@ -164,49 +164,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'SystemAssigned' (Required): The identity type. - -## StorageAccountPropertiesCreateParameters -### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. - -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -217,151 +184,56 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Array of ResourceAccessRule -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## ResourceAccessRule -### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## StorageAccountMicrosoftEndpoints +## BlobInventoryPolicyDefinition ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. -## PrivateEndpointConnection +## BlobInventoryPolicyFilter ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateEndpoint +## BlobInventoryPolicyRule ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicySchema ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## RoutingPreference +## BlobRestoreParameters ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -380,37 +252,6 @@ * **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. * **retentionInDays**: int: 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. -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. - ## ContainerProperties ### Properties * **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. @@ -430,44 +271,52 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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 -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. -## UpdateHistoryProperty +## CorsRules ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. -## LegalHoldProperties +## CustomDomain ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## TagProperty +## DateAfterCreation ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## ContainerPropertiesMetadata +## DateAfterModification ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. + +## Encryption +### Properties +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. + +## EncryptionScopeKeyVaultProperties +### Properties +* **keyUri**: string: 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. ## EncryptionScopeProperties ### Properties @@ -477,27 +326,40 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **keyUri**: string: 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. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. -## FileServicePropertiesProperties +## EncryptionServices ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ProtocolSettings +## Endpoints ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## SmbSetting +## ExtendedLocation ### Properties -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## Multichannel +## FileServicePropertiesProperties ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. ## FileShareProperties ### Properties @@ -521,64 +383,62 @@ ### Additional Properties * **Additional Properties Type**: string -## BlobInventoryPolicyProperties +## GeoReplicationStats ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## BlobInventoryPolicySchema +## Identity ### Properties -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'SystemAssigned' (Required): The identity type. -## BlobInventoryPolicyRule +## ImmutabilityPolicyProperties ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyDefinition +## ImmutabilityPolicyProperty ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. +* **allowProtectedAppendWrites**: bool: 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 +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## BlobInventoryPolicyFilter +## IPRule ### Properties -* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## SystemData +## KeyVaultProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## ManagementPolicyProperties +## LastAccessTimeTrackingPolicy ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 -## ManagementPolicySchema +## LegalHoldProperties ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## ManagementPolicyRule +## ListAccountSasResponse ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ManagementPolicyDefinition +## ListServiceSasResponse ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPolicyAction ### Properties @@ -593,10 +453,32 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + +## ManagementPolicyRule +### Properties +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle + +## ManagementPolicySchema +### Properties +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -604,27 +486,28 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## Multichannel ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **enabled**: bool: Indicates whether multichannel is enabled -## TagFilter +## NetworkRuleSet ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Array of ResourceAccessRule +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## ObjectReplicationPolicyFilter +### Properties +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -641,14 +524,32 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PrivateEndpoint ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## QueueServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. + +## ProtocolSettings +### Properties +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol ## QueueProperties ### Properties @@ -660,38 +561,27 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse +## ResourceAccessRule ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## StorageAccountListKeysResult +## RestorePolicyProperties ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountKey +## RoutingPreference ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. ## ServiceSasParameters ### Properties @@ -714,7 +604,117 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## SmbSetting +### Properties +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded': Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2021-01-01/types.md b/generated/storage/microsoft.storage/2021-01-01/types.md index be03a1fab4..32186c3885 100644 --- a/generated/storage/microsoft.storage/2021-01-01/types.md +++ b/generated/storage/microsoft.storage/2021-01-01/types.md @@ -164,61 +164,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the identity. -* **principalId**: string (ReadOnly): The principal ID of the identity. - -## StorageAccountPropertiesCreateParameters -### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. - -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -229,156 +184,56 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## EncryptionIdentity -### Properties -* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## ResourceAccessRule -### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded' | string: Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## StorageAccountMicrosoftEndpoints +## BlobInventoryPolicyDefinition ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. -## PrivateEndpointConnection +## BlobInventoryPolicyFilter ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateEndpoint +## BlobInventoryPolicyRule ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicySchema ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## RoutingPreference +## BlobRestoreParameters ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -397,37 +252,6 @@ * **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. * **retentionInDays**: int: 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. -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. - ## ContainerProperties ### Properties * **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. @@ -447,44 +271,59 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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 -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. -## UpdateHistoryProperty +## CorsRules ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. -## LegalHoldProperties +## CustomDomain ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## TagProperty +## DateAfterCreation ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## ContainerPropertiesMetadata +## DateAfterModification ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. + +## Encryption +### Properties +* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. + +## EncryptionIdentity +### Properties +* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. + +## EncryptionScopeKeyVaultProperties +### Properties +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyUri**: string: 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. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. ## EncryptionScopeProperties ### Properties @@ -495,33 +334,40 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyUri**: string: 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. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. -## FileServicePropertiesProperties +## EncryptionServices ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ProtocolSettings +## Endpoints ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## SmbSetting +## ExtendedLocation ### Properties -* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. -* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. -* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. -* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## Multichannel +## FileServicePropertiesProperties ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. ## FileShareProperties ### Properties @@ -545,64 +391,68 @@ ### Additional Properties * **Additional Properties Type**: string -## BlobInventoryPolicyProperties +## GeoReplicationStats ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## BlobInventoryPolicySchema +## Identity ### Properties -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. -## BlobInventoryPolicyRule +## IdentityUserAssignedIdentities ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## BlobInventoryPolicyDefinition +## ImmutabilityPolicyProperties ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyFilter +## ImmutabilityPolicyProperty ### Properties -* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **allowProtectedAppendWrites**: bool: 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 +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## SystemData +## IPRule ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## ManagementPolicyProperties +## KeyVaultProperties ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## ManagementPolicySchema +## LastAccessTimeTrackingPolicy ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 + +## LegalHoldProperties +### Properties +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## ManagementPolicyRule +## ListAccountSasResponse ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ManagementPolicyDefinition +## ListServiceSasResponse ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPolicyAction ### Properties @@ -617,10 +467,32 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + +## ManagementPolicyRule +### Properties +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle + +## ManagementPolicySchema +### Properties +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -628,27 +500,28 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## Multichannel ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **enabled**: bool: Indicates whether multichannel is enabled -## TagFilter +## NetworkRuleSet ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## ObjectReplicationPolicyFilter +### Properties +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -665,14 +538,32 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PrivateEndpoint ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## QueueServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. + +## ProtocolSettings +### Properties +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol ## QueueProperties ### Properties @@ -684,38 +575,27 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse +## ResourceAccessRule ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## StorageAccountListKeysResult +## RestorePolicyProperties ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountKey +## RoutingPreference ### Properties -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. ## ServiceSasParameters ### Properties @@ -738,7 +618,127 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## SmbSetting +### Properties +* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. +* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. +* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the identity. +* **principalId**: string (ReadOnly): The principal ID of the identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded' | string: Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2021-02-01/types.md b/generated/storage/microsoft.storage/2021-02-01/types.md index 6cf87f81c8..33a9152f1d 100644 --- a/generated/storage/microsoft.storage/2021-02-01/types.md +++ b/generated/storage/microsoft.storage/2021-02-01/types.md @@ -164,64 +164,16 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the identity. -* **principalId**: string (ReadOnly): The principal ID of the identity. - -## StorageAccountPropertiesCreateParameters -### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. -* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. -* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. - -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -232,170 +184,56 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## EncryptionIdentity -### Properties -* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## KeyCreationTime -### Properties -* **key1**: string (ReadOnly) -* **key2**: string (ReadOnly) - -## KeyPolicy -### Properties -* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## ResourceAccessRule -### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded' | string: Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountMicrosoftEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## PrivateEndpointConnection +## BlobInventoryPolicyDefinition ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyFilter ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpoint +## BlobInventoryPolicyProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicyRule ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## RoutingPreference +## BlobInventoryPolicySchema ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## SasPolicy +## BlobRestoreParameters ### Properties -* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. -* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -414,37 +252,6 @@ * **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. * **retentionInDays**: int: 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. -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. - ## ContainerProperties ### Properties * **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. @@ -464,44 +271,59 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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 -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. -## UpdateHistoryProperty +## CorsRules ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. -## LegalHoldProperties +## CustomDomain ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## TagProperty +## DateAfterCreation ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## ContainerPropertiesMetadata +## DateAfterModification ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. + +## Encryption +### Properties +* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. + +## EncryptionIdentity +### Properties +* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. + +## EncryptionScopeKeyVaultProperties +### Properties +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyUri**: string: 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. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. ## EncryptionScopeProperties ### Properties @@ -512,33 +334,40 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyUri**: string: 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. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. -## FileServicePropertiesProperties +## EncryptionServices ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ProtocolSettings +## Endpoints ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## SmbSetting +## ExtendedLocation ### Properties -* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. -* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. -* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. -* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## Multichannel +## FileServicePropertiesProperties ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. ## FileShareProperties ### Properties @@ -562,64 +391,77 @@ ### Additional Properties * **Additional Properties Type**: string -## BlobInventoryPolicyProperties +## GeoReplicationStats ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## BlobInventoryPolicySchema +## Identity ### Properties -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. -## BlobInventoryPolicyRule +## IdentityUserAssignedIdentities ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. Each definition consists of a set of filters. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## BlobInventoryPolicyDefinition +## ImmutabilityPolicyProperties ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter) (Required): An object that defines the blob inventory rule filter conditions. +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyFilter +## ImmutabilityPolicyProperty ### Properties -* **blobTypes**: string[] (Required): An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value set to true. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value set to true. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **allowProtectedAppendWrites**: bool: 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 +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## SystemData +## IPRule ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## ManagementPolicyProperties +## KeyCreationTime ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **key1**: string (ReadOnly) +* **key2**: string (ReadOnly) -## ManagementPolicySchema +## KeyPolicy ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. -## ManagementPolicyRule +## KeyVaultProperties ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. + +## LastAccessTimeTrackingPolicy +### Properties +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 + +## LegalHoldProperties +### Properties +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. + +## ListAccountSasResponse +### Properties +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ManagementPolicyDefinition +## ListServiceSasResponse ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPolicyAction ### Properties @@ -634,10 +476,32 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + +## ManagementPolicyRule +### Properties +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle + +## ManagementPolicySchema +### Properties +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -645,27 +509,28 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## Multichannel ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **enabled**: bool: Indicates whether multichannel is enabled -## TagFilter +## NetworkRuleSet ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## ObjectReplicationPolicyFilter +### Properties +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -682,14 +547,32 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PrivateEndpoint ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## QueueServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. + +## ProtocolSettings +### Properties +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol ## QueueProperties ### Properties @@ -701,39 +584,32 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters +## ResourceAccessRule ### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## ListAccountSasResponse +## RestorePolicyProperties ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountListKeysResult +## RoutingPreference ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. -## StorageAccountKey +## SasPolicy ### Properties -* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. +* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. ## ServiceSasParameters ### Properties @@ -756,7 +632,131 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## Sku ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## SmbSetting +### Properties +* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. +* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. +* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. +* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. +* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the identity. +* **principalId**: string (ReadOnly): The principal ID of the identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'deprovisioning' | 'failed' | 'networkSourceDeleted' | 'provisioning' | 'succeeded' | string: Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2021-04-01/types.md b/generated/storage/microsoft.storage/2021-04-01/types.md index 7facbc8f47..ff9a4c9d9d 100644 --- a/generated/storage/microsoft.storage/2021-04-01/types.md +++ b/generated/storage/microsoft.storage/2021-04-01/types.md @@ -164,66 +164,22 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the identity. -* **principalId**: string (ReadOnly): The principal ID of the identity. - -## StorageAccountPropertiesCreateParameters +## AccessPolicy ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. -* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. -* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. +* **expiryTime**: string: Expiry time of the access policy +* **permission**: string: List of abbreviated permissions. +* **startTime**: string: Start time of the access policy -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareOwner' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -234,170 +190,61 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## EncryptionIdentity -### Properties -* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## KeyCreationTime -### Properties -* **key1**: string (ReadOnly) -* **key2**: string (ReadOnly) - -## KeyPolicy -### Properties -* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## ResourceAccessRule -### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountMicrosoftEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareOwner' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## PrivateEndpointConnection +## BlobInventoryPolicyDefinition ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. +* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. +* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. +* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. +* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts. -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyFilter ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpoint +## BlobInventoryPolicyProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicyRule ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## RoutingPreference +## BlobInventoryPolicySchema ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## SasPolicy +## BlobRestoreParameters ### Properties -* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. -* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -416,37 +263,6 @@ * **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. * **retentionInDays**: int: 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. -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. - ## ContainerProperties ### Properties * **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. @@ -467,50 +283,59 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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 -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. -## UpdateHistoryProperty +## CorsRules ### Properties -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. -## ImmutableStorageWithVersioning +## CustomDomain ### Properties -* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. -* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. -* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## LegalHoldProperties +## DateAfterCreation ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## TagProperty +## DateAfterModification ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification -## ContainerPropertiesMetadata +## DeleteRetentionPolicy ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. + +## Encryption +### Properties +* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. + +## EncryptionIdentity +### Properties +* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. + +## EncryptionScopeKeyVaultProperties +### Properties +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyUri**: string: 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. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. ## EncryptionScopeProperties ### Properties @@ -521,33 +346,40 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyUri**: string: 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. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. -## FileServicePropertiesProperties +## EncryptionServices ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ProtocolSettings +## Endpoints ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## SmbSetting +## ExtendedLocation ### Properties -* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. -* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. -* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. -* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## Multichannel +## FileServicePropertiesProperties ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. ## FileShareProperties ### Properties @@ -575,79 +407,83 @@ ### Additional Properties * **Additional Properties Type**: string -## SignedIdentifier +## GeoReplicationStats ### Properties -* **accessPolicy**: [AccessPolicy](#accesspolicy) -* **id**: string: An unique identifier of the stored access policy. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## AccessPolicy +## Identity ### Properties -* **expiryTime**: string: Expiry time of the access policy -* **permission**: string: List of abbreviated permissions. -* **startTime**: string: Start time of the access policy +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. -## BlobInventoryPolicyProperties +## IdentityUserAssignedIdentities ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## BlobInventoryPolicySchema +## ImmutabilityPolicyProperties ### Properties -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyRule +## ImmutabilityPolicyProperty ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **allowProtectedAppendWrites**: bool: 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 +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## BlobInventoryPolicyDefinition +## ImmutableStorageWithVersioning ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. -* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. -* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. -* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. -* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts. +* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. +* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. +* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. -## BlobInventoryPolicyFilter +## IPRule ### Properties -* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## SystemData +## KeyCreationTime ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **key1**: string (ReadOnly) +* **key2**: string (ReadOnly) -## ManagementPolicyProperties +## KeyPolicy ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. -## ManagementPolicySchema +## KeyVaultProperties ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## ManagementPolicyRule +## LastAccessTimeTrackingPolicy ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 -## ManagementPolicyDefinition +## LegalHoldProperties ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. + +## ListAccountSasResponse +### Properties +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. + +## ListServiceSasResponse +### Properties +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. ## ManagementPolicyAction ### Properties @@ -662,10 +498,32 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + +## ManagementPolicyRule +### Properties +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle + +## ManagementPolicySchema +### Properties +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -673,27 +531,28 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## Multichannel ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **enabled**: bool: Indicates whether multichannel is enabled -## TagFilter +## NetworkRuleSet ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## ObjectReplicationPolicyFilter +### Properties +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -710,14 +569,32 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PrivateEndpoint ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## QueueServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. + +## ProtocolSettings +### Properties +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol ## QueueProperties ### Properties @@ -729,39 +606,32 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters +## ResourceAccessRule ### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## ListAccountSasResponse +## RestorePolicyProperties ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountListKeysResult +## RoutingPreference ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. -## StorageAccountKey +## SasPolicy ### Properties -* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. +* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. ## ServiceSasParameters ### Properties @@ -784,7 +654,137 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## SignedIdentifier ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **accessPolicy**: [AccessPolicy](#accesspolicy) +* **id**: string: An unique identifier of the stored access policy. + +## Sku +### Properties +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## SmbSetting +### Properties +* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. +* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. +* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. +* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. +* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the identity. +* **principalId**: string (ReadOnly): The principal ID of the identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2021-06-01/types.md b/generated/storage/microsoft.storage/2021-06-01/types.md index 0cf392b47f..816309cec7 100644 --- a/generated/storage/microsoft.storage/2021-06-01/types.md +++ b/generated/storage/microsoft.storage/2021-06-01/types.md @@ -164,69 +164,28 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccessPolicy ### Properties -* **clientId**: string (ReadOnly): The client ID of the identity. -* **principalId**: string (ReadOnly): The principal ID of the identity. +* **expiryTime**: string: Expiry time of the access policy +* **permission**: string: List of abbreviated permissions. +* **startTime**: string: Start time of the access policy -## StorageAccountPropertiesCreateParameters +## AccountImmutabilityPolicyProperties ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **defaultToOAuthAuthentication**: bool: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **immutableStorageWithVersioning**: [ImmutableStorageAccount](#immutablestorageaccount): This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. -* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. -* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. +* **allowProtectedAppendWrites**: bool: This property can only be changed for disabled and 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. +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Disabled' | 'Locked' | 'Unlocked' | string: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -237,181 +196,61 @@ * **forestName**: string (Required): Specifies the Active Directory forest to get. * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## EncryptionIdentity -### Properties -* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## ImmutableStorageAccount -### Properties -* **enabled**: bool: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. -* **immutabilityPolicy**: [AccountImmutabilityPolicyProperties](#accountimmutabilitypolicyproperties): This defines account-level immutability policy properties. - -## AccountImmutabilityPolicyProperties -### Properties -* **allowProtectedAppendWrites**: bool: This property can only be changed for disabled and 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. -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Disabled' | 'Locked' | 'Unlocked' | string: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. - -## KeyCreationTime -### Properties -* **key1**: string (ReadOnly) -* **key2**: string (ReadOnly) - -## KeyPolicy -### Properties -* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## ResourceAccessRule -### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountMicrosoftEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## PrivateEndpointConnection +## BlobInventoryPolicyDefinition ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. +* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. +* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. +* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. +* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts.'Tags' field is only valid for non Hns accounts -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyFilter ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpoint +## BlobInventoryPolicyProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicyRule ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## RoutingPreference +## BlobInventoryPolicySchema ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## SasPolicy +## BlobRestoreParameters ### Properties -* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. -* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -427,39 +266,8 @@ ## ChangeFeed ### Properties -* **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. -* **retentionInDays**: int: 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. - -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. +* **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. +* **retentionInDays**: int: 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. ## ContainerProperties ### Properties @@ -483,59 +291,59 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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. -* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. -## UpdateHistoryProperty +## CorsRules ### Properties -* **allowProtectedAppendWrites**: bool: 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. -* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. -## ImmutableStorageWithVersioning +## CustomDomain ### Properties -* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. -* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. -* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## LegalHoldProperties +## DateAfterCreation ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **protectedAppendWritesHistory**: [ProtectedAppendWritesHistory](#protectedappendwriteshistory): Protected append writes history setting for the blob container with Legal holds. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## ProtectedAppendWritesHistory +## DateAfterModification ### Properties -* **allowProtectedAppendWritesAll**: bool: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification -## TagProperty +## DeleteRetentionPolicy ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. -## ContainerPropertiesMetadata +## Encryption ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. + +## EncryptionIdentity +### Properties +* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. + +## EncryptionScopeKeyVaultProperties +### Properties +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyUri**: string: 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. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. ## EncryptionScopeProperties ### Properties @@ -546,33 +354,40 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyUri**: string: 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. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. -## FileServicePropertiesProperties +## EncryptionServices ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ProtocolSettings +## Endpoints ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## SmbSetting +## ExtendedLocation ### Properties -* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. -* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. -* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. -* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## Multichannel +## FileServicePropertiesProperties ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. ## FileShareProperties ### Properties @@ -600,97 +415,130 @@ ### Additional Properties * **Additional Properties Type**: string -## SignedIdentifier +## GeoReplicationStats ### Properties -* **accessPolicy**: [AccessPolicy](#accesspolicy) -* **id**: string: An unique identifier of the stored access policy. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## AccessPolicy +## Identity ### Properties -* **expiryTime**: string: Expiry time of the access policy -* **permission**: string: List of abbreviated permissions. -* **startTime**: string: Start time of the access policy +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. -## BlobInventoryPolicyProperties +## IdentityUserAssignedIdentities ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## BlobInventoryPolicySchema +## ImmutabilityPolicyProperties ### Properties -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyRule +## ImmutabilityPolicyProperty ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **allowProtectedAppendWrites**: bool: 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. +* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## BlobInventoryPolicyDefinition +## ImmutableStorageAccount ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. -* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. -* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. -* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. -* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts.'Tags' field is only valid for non Hns accounts +* **enabled**: bool: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. +* **immutabilityPolicy**: [AccountImmutabilityPolicyProperties](#accountimmutabilitypolicyproperties): This defines account-level immutability policy properties. -## BlobInventoryPolicyFilter +## ImmutableStorageWithVersioning ### Properties -* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. +* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. +* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. -## SystemData +## IPRule ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## ManagementPolicyProperties +## KeyCreationTime ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **key1**: string (ReadOnly) +* **key2**: string (ReadOnly) -## ManagementPolicySchema +## KeyPolicy ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. -## ManagementPolicyRule +## KeyVaultProperties ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. + +## LastAccessTimeTrackingPolicy +### Properties +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 + +## LegalHoldProperties +### Properties +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **protectedAppendWritesHistory**: [ProtectedAppendWritesHistory](#protectedappendwriteshistory): Protected append writes history setting for the blob container with Legal holds. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. + +## ListAccountSasResponse +### Properties +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. + +## ListServiceSasResponse +### Properties +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. + +## ManagementPolicyAction +### Properties +* **baseBlob**: [ManagementPolicyBaseBlob](#managementpolicybaseblob): Management policy action for base blob. +* **snapshot**: [ManagementPolicySnapShot](#managementpolicysnapshot): Management policy action for snapshot. +* **version**: [ManagementPolicyVersion](#managementpolicyversion): Management policy action for blob version. + +## ManagementPolicyBaseBlob +### Properties +* **delete**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. +* **enableAutoTierToHotFromCool**: bool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. +* **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. +* **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. ## ManagementPolicyDefinition ### Properties * **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. * **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. -## ManagementPolicyAction +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties ### Properties -* **baseBlob**: [ManagementPolicyBaseBlob](#managementpolicybaseblob): Management policy action for base blob. -* **snapshot**: [ManagementPolicySnapShot](#managementpolicysnapshot): Management policy action for snapshot. -* **version**: [ManagementPolicyVersion](#managementpolicyversion): Management policy action for blob version. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. -## ManagementPolicyBaseBlob +## ManagementPolicyRule ### Properties -* **delete**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -* **enableAutoTierToHotFromCool**: bool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. -* **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -* **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle -## DateAfterModification +## ManagementPolicySchema ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -698,27 +546,28 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## Multichannel ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **enabled**: bool: Indicates whether multichannel is enabled -## TagFilter +## NetworkRuleSet ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## ObjectReplicationPolicyFilter +### Properties +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -735,14 +584,37 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PrivateEndpoint ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## QueueServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. + +## ProtectedAppendWritesHistory +### Properties +* **allowProtectedAppendWritesAll**: bool: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. + +## ProtocolSettings +### Properties +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol ## QueueProperties ### Properties @@ -754,39 +626,32 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters +## ResourceAccessRule ### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## ListAccountSasResponse +## RestorePolicyProperties ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountListKeysResult +## RoutingPreference ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. -## StorageAccountKey +## SasPolicy ### Properties -* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. +* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. ## ServiceSasParameters ### Properties @@ -809,7 +674,142 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## SignedIdentifier ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **accessPolicy**: [AccessPolicy](#accesspolicy) +* **id**: string: An unique identifier of the stored access policy. + +## Sku +### Properties +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## SmbSetting +### Properties +* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. +* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. +* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **defaultToOAuthAuthentication**: bool: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **immutableStorageWithVersioning**: [ImmutableStorageAccount](#immutablestorageaccount): This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. +* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. +* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **allowProtectedAppendWrites**: bool: 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. +* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the identity. +* **principalId**: string (ReadOnly): The principal ID of the identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2021-08-01/types.md b/generated/storage/microsoft.storage/2021-08-01/types.md index f173eb674f..1b4de7e49a 100644 --- a/generated/storage/microsoft.storage/2021-08-01/types.md +++ b/generated/storage/microsoft.storage/2021-08-01/types.md @@ -179,72 +179,28 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccessPolicy ### Properties -* **clientId**: string (ReadOnly): The client ID of the identity. -* **principalId**: string (ReadOnly): The principal ID of the identity. +* **expiryTime**: string: Expiry time of the access policy +* **permission**: string: List of abbreviated permissions. +* **startTime**: string: Start time of the access policy -## StorageAccountPropertiesCreateParameters +## AccountImmutabilityPolicyProperties ### Properties -* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. -* **allowedCopyScope**: 'AAD' | 'PrivateLink' | string: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **defaultToOAuthAuthentication**: bool: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **immutableStorageWithVersioning**: [ImmutableStorageAccount](#immutablestorageaccount): This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **isLocalUserEnabled**: bool: Enables local users feature, if set to true -* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. -* **isSftpEnabled**: bool: Enables Secure File Transfer Protocol, if set to true -* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. -* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. +* **allowProtectedAppendWrites**: bool: This property can only be changed for disabled and 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. +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Disabled' | 'Locked' | 'Unlocked' | string: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -257,182 +213,61 @@ * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. * **samAccountName**: string: Specifies the Active Directory SAMAccountName for Azure Storage. -## BlobRestoreStatus -### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. - -## BlobRestoreParameters -### Properties -* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. -* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. - -## BlobRestoreRange -### Properties -* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. -* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. - -## CustomDomain -### Properties -* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. -* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. - -## Encryption -### Properties -* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. -* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault -* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. - -## EncryptionIdentity -### Properties -* **federatedIdentityClientId**: string: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. -* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. - -## KeyVaultProperties -### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. - -## EncryptionServices -### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. - -## EncryptionService -### Properties -* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. -* **keyType**: 'Account' | 'Service' | 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. -* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. - -## GeoReplicationStats -### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. - -## ImmutableStorageAccount -### Properties -* **enabled**: bool: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. -* **immutabilityPolicy**: [AccountImmutabilityPolicyProperties](#accountimmutabilitypolicyproperties): This defines account-level immutability policy properties. - -## AccountImmutabilityPolicyProperties -### Properties -* **allowProtectedAppendWrites**: bool: This property can only be changed for disabled and 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. -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Disabled' | 'Locked' | 'Unlocked' | string: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. - -## KeyCreationTime -### Properties -* **key1**: string (ReadOnly) -* **key2**: string (ReadOnly) - -## KeyPolicy -### Properties -* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. - -## NetworkRuleSet -### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules - -## IPRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. - -## ResourceAccessRule -### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id - -## VirtualNetworkRule -### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. - -## Endpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountInternetEndpoints -### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. - -## StorageAccountMicrosoftEndpoints +## AzureFilesIdentityBasedAuthentication ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. -## PrivateEndpointConnection +## BlobInventoryPolicyDefinition ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. +* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. +* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. +* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. +* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts.'Tags' field is only valid for non Hns accounts -## PrivateEndpointConnectionProperties +## BlobInventoryPolicyFilter ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. +* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. -## PrivateEndpoint +## BlobInventoryPolicyProperties ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. -## PrivateLinkServiceConnectionState +## BlobInventoryPolicyRule ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -## RoutingPreference +## BlobInventoryPolicySchema ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory -## SasPolicy +## BlobRestoreParameters ### Properties -* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. -* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. +* **blobRanges**: [BlobRestoreRange](#blobrestorerange)[] (ReadOnly): Blob ranges to restore. +* **timeToRestore**: string (ReadOnly): Restore blob to the specified time. -## Sku +## BlobRestoreRange ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. +* **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. -## StorageAccountCreateParametersTags +## BlobRestoreStatus ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. ## BlobServicePropertiesProperties ### Properties @@ -451,37 +286,6 @@ * **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. * **retentionInDays**: int: 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. -## DeleteRetentionPolicy -### Properties -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. - -## CorsRules -### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. - -## CorsRule -### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. - -## LastAccessTimeTrackingPolicy -### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 - -## RestorePolicyProperties -### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. - ## ContainerProperties ### Properties * **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. @@ -504,59 +308,60 @@ * **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. * **version**: string (ReadOnly): The version of the deleted blob container. -## ImmutabilityPolicyProperties +## ContainerPropertiesMetadata ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +### Additional Properties +* **Additional Properties Type**: string -## ImmutabilityPolicyProperty +## CorsRule ### Properties -* **allowProtectedAppendWrites**: bool: 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. -* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. + +## CorsRules +### Properties +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. + +## CustomDomain +### Properties +* **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. +* **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. -## UpdateHistoryProperty +## DateAfterCreation ### Properties -* **allowProtectedAppendWrites**: bool: 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. -* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -## ImmutableStorageWithVersioning +## DateAfterModification ### Properties -* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. -* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. -* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification -## LegalHoldProperties +## DeleteRetentionPolicy ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **protectedAppendWritesHistory**: [ProtectedAppendWritesHistory](#protectedappendwriteshistory): Protected append writes history setting for the blob container with Legal holds. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. -## ProtectedAppendWritesHistory +## Encryption ### Properties -* **allowProtectedAppendWritesAll**: bool: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. +* **keySource**: 'Microsoft.Keyvault' | 'Microsoft.Storage' | string (Required): The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault +* **keyvaultproperties**: [KeyVaultProperties](#keyvaultproperties): Properties of key vault. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **services**: [EncryptionServices](#encryptionservices): A list of services that support encryption. -## TagProperty +## EncryptionIdentity ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **federatedIdentityClientId**: string: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. +* **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. -## ContainerPropertiesMetadata +## EncryptionScopeKeyVaultProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyUri**: string: 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. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. ## EncryptionScopeProperties ### Properties @@ -567,33 +372,40 @@ * **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. * **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. -## EncryptionScopeKeyVaultProperties +## EncryptionService ### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyUri**: string: 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. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. +* **enabled**: bool: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. +* **keyType**: 'Account' | 'Service' | 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. +* **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. -## FileServicePropertiesProperties +## EncryptionServices ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ProtocolSettings +## Endpoints ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## SmbSetting +## ExtendedLocation ### Properties -* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. -* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. -* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. -* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## Multichannel +## FileServicePropertiesProperties ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. ## FileShareProperties ### Properties @@ -621,100 +433,105 @@ ### Additional Properties * **Additional Properties Type**: string -## SignedIdentifier +## GeoReplicationStats ### Properties -* **accessPolicy**: [AccessPolicy](#accesspolicy) -* **id**: string: An unique identifier of the stored access policy. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## AccessPolicy +## Identity ### Properties -* **expiryTime**: string: Expiry time of the access policy -* **permission**: string: List of abbreviated permissions. -* **startTime**: string: Start time of the access policy +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. -## BlobInventoryPolicyProperties +## IdentityUserAssignedIdentities ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## BlobInventoryPolicySchema +## ImmutabilityPolicyProperties ### Properties -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## BlobInventoryPolicyRule +## ImmutabilityPolicyProperty ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **allowProtectedAppendWrites**: bool: 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. +* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## BlobInventoryPolicyDefinition +## ImmutableStorageAccount ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. -* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. -* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. -* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. -* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts.'Tags' field is only valid for non Hns accounts +* **enabled**: bool: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. +* **immutabilityPolicy**: [AccountImmutabilityPolicyProperties](#accountimmutabilitypolicyproperties): This defines account-level immutability policy properties. -## BlobInventoryPolicyFilter +## ImmutableStorageWithVersioning ### Properties -* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. -* **prefixMatch**: string[]: An array of strings for blob prefixes to be matched. +* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. +* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. +* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. -## SystemData +## IPRule ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## LocalUserProperties +## KeyCreationTime ### Properties -* **hasSharedKey**: bool: Indicates whether shared key exists. Set it to false to remove existing shared key. -* **hasSshKey**: bool: Indicates whether ssh key exists. Set it to false to remove existing SSH key. -* **hasSshPassword**: bool: Indicates whether ssh password exists. Set it to false to remove existing SSH password. -* **homeDirectory**: string: Optional, local user home directory. -* **permissionScopes**: [PermissionScope](#permissionscope)[]: The permission scopes of the local user. -* **sid**: string (ReadOnly): A unique Security Identifier that is generated by the server. -* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[]: Optional, local user ssh authorized keys for SFTP. +* **key1**: string (ReadOnly) +* **key2**: string (ReadOnly) -## PermissionScope +## KeyPolicy ### Properties -* **permissions**: string (Required): The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c). -* **resourceName**: string (Required): The name of resource, normally the container name or the file share name, used by the local user. -* **service**: string (Required): The service used by the local user, e.g. blob, file. +* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. -## SshPublicKey +## KeyVaultProperties ### Properties -* **description**: string: Optional. It is used to store the function/usage of the key -* **key**: string: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## ManagementPolicyProperties +## LastAccessTimeTrackingPolicy ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 -## ManagementPolicySchema +## LegalHoldProperties ### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **protectedAppendWritesHistory**: [ProtectedAppendWritesHistory](#protectedappendwriteshistory): Protected append writes history setting for the blob container with Legal holds. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## ManagementPolicyRule +## ListAccountSasResponse ### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## ManagementPolicyDefinition +## ListServiceSasResponse ### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. + +## LocalUserKeys +### Properties +* **sharedKey**: string (ReadOnly): Auto generated by the server for SMB authentication. +* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[] (ReadOnly): Optional, local user ssh authorized keys for SFTP. + +## LocalUserProperties +### Properties +* **hasSharedKey**: bool: Indicates whether shared key exists. Set it to false to remove existing shared key. +* **hasSshKey**: bool: Indicates whether ssh key exists. Set it to false to remove existing SSH key. +* **hasSshPassword**: bool: Indicates whether ssh password exists. Set it to false to remove existing SSH password. +* **homeDirectory**: string: Optional, local user home directory. +* **permissionScopes**: [PermissionScope](#permissionscope)[]: The permission scopes of the local user. +* **sid**: string (ReadOnly): A unique Security Identifier that is generated by the server. +* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[]: Optional, local user ssh authorized keys for SFTP. ## ManagementPolicyAction ### Properties @@ -729,10 +546,32 @@ * **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. * **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. -## DateAfterModification +## ManagementPolicyDefinition ### Properties -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. + +## ManagementPolicyFilter +### Properties +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. + +## ManagementPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + +## ManagementPolicyRule +### Properties +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle + +## ManagementPolicySchema +### Properties +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ## ManagementPolicySnapShot ### Properties @@ -740,27 +579,28 @@ * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## DateAfterCreation -### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation - ## ManagementPolicyVersion ### Properties * **delete**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. * **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define the number of days after creation. -## ManagementPolicyFilter +## Multichannel ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **enabled**: bool: Indicates whether multichannel is enabled -## TagFilter +## NetworkRuleSet ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules + +## ObjectReplicationPolicyFilter +### Properties +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ## ObjectReplicationPolicyProperties ### Properties @@ -777,14 +617,43 @@ * **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. * **sourceContainer**: string (Required): Required. Source container name. -## ObjectReplicationPolicyFilter +## PermissionScope ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **permissions**: string (Required): The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c). +* **resourceName**: string (Required): The name of resource, normally the container name or the file share name, used by the local user. +* **service**: string (Required): The service used by the local user, e.g. blob, file. -## QueueServicePropertiesProperties +## PrivateEndpoint ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. + +## ProtectedAppendWritesHistory +### Properties +* **allowProtectedAppendWritesAll**: bool: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. + +## ProtocolSettings +### Properties +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol ## QueueProperties ### Properties @@ -796,44 +665,32 @@ ### Additional Properties * **Additional Properties Type**: string -## TableServicePropertiesProperties +## QueueServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **tableName**: string (ReadOnly): Table name under the specified account - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse +## ResourceAccessRule ### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## StorageAccountListKeysResult +## RestorePolicyProperties ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## StorageAccountKey +## RoutingPreference ### Properties -* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. -## LocalUserKeys +## SasPolicy ### Properties -* **sharedKey**: string (ReadOnly): Auto generated by the server for SMB authentication. -* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[] (ReadOnly): Optional, local user ssh authorized keys for SFTP. +* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. +* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. ## ServiceSasParameters ### Properties @@ -856,7 +713,150 @@ * **startPk**: string (WriteOnly): The start of partition key. * **startRk**: string (WriteOnly): The start of row key. -## ListServiceSasResponse +## SignedIdentifier ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **accessPolicy**: [AccessPolicy](#accesspolicy) +* **id**: string: An unique identifier of the stored access policy. + +## Sku +### Properties +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. + +## SmbSetting +### Properties +* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. +* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. +* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. + +## SshPublicKey +### Properties +* **description**: string: Optional. It is used to store the function/usage of the key +* **key**: string: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB + +## StorageAccountCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageAccountInternetEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountKey +### Properties +* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. + +## StorageAccountListKeysResult +### Properties +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. + +## StorageAccountMicrosoftEndpoints +### Properties +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. + +## StorageAccountPropertiesCreateParameters +### Properties +* **accessTier**: 'Cool' | 'Hot': Required for storage accounts where kind = BlobStorage. The access tier used for billing. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. +* **allowedCopyScope**: 'AAD' | 'PrivateLink' | string: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **defaultToOAuthAuthentication**: bool: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **immutableStorageWithVersioning**: [ImmutableStorageAccount](#immutablestorageaccount): This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **isLocalUserEnabled**: bool: Enables local users feature, if set to true +* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. +* **isSftpEnabled**: bool: Enables Secure File Transfer Protocol, if set to true +* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. +* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TableProperties +### Properties +* **tableName**: string (ReadOnly): Table name under the specified account + +## TableServicePropertiesProperties +### Properties +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. + +## TagFilter +### Properties +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters + +## TagProperty +### Properties +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. + +## UpdateHistoryProperty +### Properties +* **allowProtectedAppendWrites**: bool: 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. +* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the identity. +* **principalId**: string (ReadOnly): The principal ID of the identity. + +## VirtualNetworkRule +### Properties +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. diff --git a/generated/storage/microsoft.storage/2021-09-01/types.md b/generated/storage/microsoft.storage/2021-09-01/types.md index 8978529101..88baafae29 100644 --- a/generated/storage/microsoft.storage/2021-09-01/types.md +++ b/generated/storage/microsoft.storage/2021-09-01/types.md @@ -179,74 +179,28 @@ * **Input**: [ServiceSasParameters](#servicesasparameters) * **Output**: [ListServiceSasResponse](#listservicesasresponse) -## ExtendedLocation -### Properties -* **name**: string: The name of the extended location. -* **type**: 'EdgeZone' | string: The type of extendedLocation. - -## Identity -### Properties -* **principalId**: string (ReadOnly): The principal ID of resource identity. -* **tenantId**: string (ReadOnly): The tenant ID of resource. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. -* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. - -## IdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity +## AccessPolicy ### Properties -* **clientId**: string (ReadOnly): The client ID of the identity. -* **principalId**: string (ReadOnly): The principal ID of the identity. +* **expiryTime**: string: Expiry time of the access policy +* **permission**: string: List of abbreviated permissions. +* **startTime**: string: Start time of the access policy -## StorageAccountPropertiesCreateParameters +## AccountImmutabilityPolicyProperties ### Properties -* **accessTier**: 'Cool' | 'Hot' | 'Premium': Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. -* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. -* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. -* **allowedCopyScope**: 'AAD' | 'PrivateLink' | string: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. -* **allowSharedKeyAccess**: bool: 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. -* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. -* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. -* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. -* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. -* **defaultToOAuthAuthentication**: bool: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. -* **dnsEndpointType**: 'AzureDnsZone' | 'Standard' | string: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. -* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. -* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. -* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. -* **immutableStorageWithVersioning**: [ImmutableStorageAccount](#immutablestorageaccount): This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. -* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. -* **isLocalUserEnabled**: bool: Enables local users feature, if set to true -* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. -* **isSftpEnabled**: bool: Enables Secure File Transfer Protocol, if set to true -* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. -* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. -* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. -* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. -* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set -* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account -* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. -* **routingPreference**: [RoutingPreference](#routingpreference): 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 -* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. -* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. -* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. -* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. -* **storageAccountSkuConversionStatus**: [StorageAccountSkuConversionStatus](#storageaccountskuconversionstatus) (ReadOnly): This defines the sku conversion status object for asynchronous sku conversions. -* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. +* **allowProtectedAppendWrites**: bool: This property can only be changed for disabled and 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. +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Disabled' | 'Locked' | 'Unlocked' | string: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. -## AzureFilesIdentityBasedAuthentication +## AccountSasParameters ### Properties -* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). -* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. -* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. +* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. ## ActiveDirectoryProperties ### Properties @@ -259,12 +213,47 @@ * **netBiosDomainName**: string (Required): Specifies the NetBIOS domain name. * **samAccountName**: string: Specifies the Active Directory SAMAccountName for Azure Storage. -## BlobRestoreStatus +## AzureFilesIdentityBasedAuthentication ### Properties -* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. -* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters -* **restoreId**: string (ReadOnly): Id for tracking blob restore request. -* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. +* **activeDirectoryProperties**: [ActiveDirectoryProperties](#activedirectoryproperties): Settings properties for Active Directory (AD). +* **defaultSharePermission**: 'None' | 'StorageFileDataSmbShareContributor' | 'StorageFileDataSmbShareElevatedContributor' | 'StorageFileDataSmbShareReader' | string: Default share permission for users using Kerberos authentication if RBAC role is not assigned. +* **directoryServiceOptions**: 'AADDS' | 'AD' | 'None' | string (Required): Indicates the directory service used. + +## BlobInventoryPolicyDefinition +### Properties +* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. +* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. +* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. +* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. +* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. + +## BlobInventoryPolicyFilter +### Properties +* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. +* **excludePrefix**: string[]: An array of strings with maximum 10 blob prefixes to be excluded from the inventory. +* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. +* **includeDeleted**: bool: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. +* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. +* **prefixMatch**: string[]: An array of strings with maximum 10 blob prefixes to be included in the inventory. + +## BlobInventoryPolicyProperties +### Properties +* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. +* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. + +## BlobInventoryPolicyRule +### Properties +* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. +* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. +* **enabled**: bool (Required): Rule is enabled when set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. + +## BlobInventoryPolicySchema +### Properties +* **destination**: string (ReadOnly): Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' +* **enabled**: bool (Required): Policy is enabled if set to true. +* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. +* **type**: 'Inventory' | string (Required): The valid value is Inventory ## BlobRestoreParameters ### Properties @@ -276,11 +265,92 @@ * **endRange**: string (ReadOnly): Blob end range. This is exclusive. Empty means account end. * **startRange**: string (ReadOnly): Blob start range. This is inclusive. Empty means account start. +## BlobRestoreStatus +### Properties +* **failureReason**: string (ReadOnly): Failure reason when blob restore is failed. +* **parameters**: [BlobRestoreParameters](#blobrestoreparameters) (ReadOnly): Blob restore parameters +* **restoreId**: string (ReadOnly): Id for tracking blob restore request. +* **status**: 'Complete' | 'Failed' | 'InProgress' | string (ReadOnly): The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. + +## BlobServicePropertiesProperties +### Properties +* **automaticSnapshotPolicyEnabled**: bool: Deprecated in favor of isVersioningEnabled property. +* **changeFeed**: [ChangeFeed](#changefeed): The blob service properties for change feed events. +* **containerDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **defaultServiceVersion**: 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. +* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **isVersioningEnabled**: bool: Versioning is enabled if set to true. +* **lastAccessTimeTrackingPolicy**: [LastAccessTimeTrackingPolicy](#lastaccesstimetrackingpolicy): The blob service properties for Last access time based tracking policy. +* **restorePolicy**: [RestorePolicyProperties](#restorepolicyproperties): The blob service properties for blob restore policy + +## ChangeFeed +### Properties +* **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. +* **retentionInDays**: int: 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. + +## ContainerProperties +### Properties +* **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. +* **deleted**: bool (ReadOnly): Indicates whether the blob container was deleted. +* **deletedTime**: string (ReadOnly): Blob container deletion time. +* **denyEncryptionScopeOverride**: bool: Block override of encryption scope from the container default. +* **enableNfsV3AllSquash**: bool: Enable NFSv3 all squash on blob container. +* **enableNfsV3RootSquash**: bool: Enable NFSv3 root squash on blob container. +* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. +* **immutableStorageWithVersioning**: [ImmutableStorageWithVersioning](#immutablestoragewithversioning): Object level immutability properties of the container. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. +* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. +* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. +* **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. +* **version**: string (ReadOnly): The version of the deleted blob container. + +## ContainerPropertiesMetadata +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## CorsRule +### Properties +* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. +* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. +* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains +* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. +* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. + +## CorsRules +### Properties +* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. + ## CustomDomain ### Properties * **name**: string (Required): Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. * **useSubDomainName**: bool: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. +## DateAfterCreation +### Properties +* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation +* **daysAfterLastTierChangeGreaterThan**: int: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. + +## DateAfterModification +### Properties +* **daysAfterCreationGreaterThan**: int: Value indicating the age in days after blob creation. +* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy +* **daysAfterLastTierChangeGreaterThan**: int: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. +* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification + +## DeleteRetentionPolicy +### Properties +* **allowPermanentDelete**: bool: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. +* **days**: int: 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. +* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. + ## Encryption ### Properties * **identity**: [EncryptionIdentity](#encryptionidentity): Encryption identity for the storage account. @@ -294,21 +364,20 @@ * **federatedIdentityClientId**: string: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. * **userAssignedIdentity**: string: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. -## KeyVaultProperties +## EncryptionScopeKeyVaultProperties ### Properties -* **currentVersionedKeyExpirationTimestamp**: string (ReadOnly): This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. * **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyname**: string: The name of KeyVault key. -* **keyvaulturi**: string: The Uri of KeyVault. -* **keyversion**: string: The version of KeyVault key. +* **keyUri**: string: 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. * **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## EncryptionServices +## EncryptionScopeProperties ### Properties -* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the encryption scope in UTC. +* **keyVaultProperties**: [EncryptionScopeKeyVaultProperties](#encryptionscopekeyvaultproperties): The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. +* **lastModifiedTime**: string (ReadOnly): Gets the last modification date and time of the encryption scope in UTC. +* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. +* **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. +* **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ## EncryptionService ### Properties @@ -316,576 +385,507 @@ * **keyType**: 'Account' | 'Service' | 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. * **lastEnabledTime**: string (ReadOnly): Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. -## GeoReplicationStats +## EncryptionServices ### Properties -* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. -* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. -* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. +* **blob**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **file**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **queue**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. +* **table**: [EncryptionService](#encryptionservice): A service that allows server-side encryption to be used. -## ImmutableStorageAccount +## Endpoints ### Properties -* **enabled**: bool: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. -* **immutabilityPolicy**: [AccountImmutabilityPolicyProperties](#accountimmutabilitypolicyproperties): This defines account-level immutability policy properties. +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. +* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## AccountImmutabilityPolicyProperties +## ExtendedLocation ### Properties -* **allowProtectedAppendWrites**: bool: This property can only be changed for disabled and 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. -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Disabled' | 'Locked' | 'Unlocked' | string: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. +* **name**: string: The name of the extended location. +* **type**: 'EdgeZone' | string: The type of extendedLocation. -## KeyCreationTime +## FileServicePropertiesProperties ### Properties -* **key1**: string (ReadOnly) -* **key2**: string (ReadOnly) +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service +* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. -## KeyPolicy +## FileShareProperties ### Properties -* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. +* **accessTier**: 'Cool' | 'Hot' | 'Premium' | 'TransactionOptimized' | string: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. +* **accessTierChangeTime**: string (ReadOnly): Indicates the last modification time for share access tier. +* **accessTierStatus**: string (ReadOnly): Indicates if there is a pending transition for access tier. +* **deleted**: bool (ReadOnly): Indicates whether the share was deleted. +* **deletedTime**: string (ReadOnly): The deleted time if the share was deleted. +* **enabledProtocols**: 'NFS' | 'SMB' | string: The authentication protocol that is used for the file share. Can only be specified when creating a share. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the share was last modified. +* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. +* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. +* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. +* **metadata**: [FileSharePropertiesMetadata](#filesharepropertiesmetadata): A name-value pair to associate with the share as metadata. +* **remainingRetentionDays**: int (ReadOnly): Remaining retention days for share that was soft deleted. +* **rootSquash**: 'AllSquash' | 'NoRootSquash' | 'RootSquash' | string: The property is for NFS share only. The default is NoRootSquash. +* **shareQuota**: int: 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. +* **shareUsageBytes**: int (ReadOnly): The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. +* **signedIdentifiers**: [SignedIdentifier](#signedidentifier)[]: List of stored access policies specified on the share. +* **snapshotTime**: string (ReadOnly): Creation time of share snapshot returned in the response of list shares with expand param "snapshots". +* **version**: string (ReadOnly): The version of the share. -## NetworkRuleSet +## FileSharePropertiesMetadata ### Properties -* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. -* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. -* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules -* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules -* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules +### Additional Properties +* **Additional Properties Type**: string -## IPRule +## GeoReplicationStats ### Properties -* **action**: 'Allow': The action of virtual network rule. -* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. +* **canFailover**: bool (ReadOnly): A boolean flag which indicates whether or not account failover is supported for the account. +* **lastSyncTime**: string (ReadOnly): All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. +* **status**: 'Bootstrap' | 'Live' | 'Unavailable' | string (ReadOnly): The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. -## ResourceAccessRule +## Identity ### Properties -* **resourceId**: string: Resource Id -* **tenantId**: string: Tenant Id +* **principalId**: string (ReadOnly): The principal ID of resource identity. +* **tenantId**: string (ReadOnly): The tenant ID of resource. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): The identity type. +* **userAssignedIdentities**: [IdentityUserAssignedIdentities](#identityuserassignedidentities): Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. -## VirtualNetworkRule +## IdentityUserAssignedIdentities ### Properties -* **action**: 'Allow': The action of virtual network rule. -* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. -* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## Endpoints +## ImmutabilityPolicyProperties ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **internetEndpoints**: [StorageAccountInternetEndpoints](#storageaccountinternetendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. -* **microsoftEndpoints**: [StorageAccountMicrosoftEndpoints](#storageaccountmicrosoftendpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. +* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. +* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. -## StorageAccountInternetEndpoints +## ImmutabilityPolicyProperty ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **allowProtectedAppendWrites**: bool: 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. +* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. +* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. +* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. -## StorageAccountMicrosoftEndpoints +## ImmutableStorageAccount ### Properties -* **blob**: string (ReadOnly): Gets the blob endpoint. -* **dfs**: string (ReadOnly): Gets the dfs endpoint. -* **file**: string (ReadOnly): Gets the file endpoint. -* **queue**: string (ReadOnly): Gets the queue endpoint. -* **table**: string (ReadOnly): Gets the table endpoint. -* **web**: string (ReadOnly): Gets the web endpoint. +* **enabled**: bool: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. +* **immutabilityPolicy**: [AccountImmutabilityPolicyProperties](#accountimmutabilitypolicyproperties): This defines account-level immutability policy properties. -## PrivateEndpointConnection +## ImmutableStorageWithVersioning ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. +* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. +* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. -## PrivateEndpointConnectionProperties +## IPRule ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +* **action**: 'Allow': The action of virtual network rule. +* **value**: string (Required): Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. -## PrivateEndpoint +## KeyCreationTime ### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint +* **key1**: string (ReadOnly) +* **key2**: string (ReadOnly) -## PrivateLinkServiceConnectionState +## KeyPolicy ### Properties -* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. +* **keyExpirationPeriodInDays**: int (Required): The key expiration period in days. -## RoutingPreference +## KeyVaultProperties ### Properties -* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published -* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published -* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. +* **currentVersionedKeyExpirationTimestamp**: string (ReadOnly): This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. +* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. +* **keyname**: string: The name of KeyVault key. +* **keyvaulturi**: string: The Uri of KeyVault. +* **keyversion**: string: The version of KeyVault key. +* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. -## SasPolicy +## LastAccessTimeTrackingPolicy ### Properties -* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. -* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. +* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only +* **enable**: bool (Required): When set to true last access time based tracking is enabled. +* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only +* **trackingGranularityInDays**: int: 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 -## StorageAccountSkuConversionStatus +## LegalHoldProperties ### Properties -* **endTime**: string (ReadOnly): This property represents the sku conversion end time. -* **skuConversionStatus**: 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): This property indicates the current sku conversion status. -* **startTime**: string (ReadOnly): This property represents the sku conversion start time. -* **targetSkuName**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (ReadOnly): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. +* **protectedAppendWritesHistory**: [ProtectedAppendWritesHistory](#protectedappendwriteshistory): Protected append writes history setting for the blob container with Legal holds. +* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. -## Sku +## ListAccountSasResponse ### Properties -* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. +* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. -## StorageAccountCreateParametersTags +## ListServiceSasResponse ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. -## BlobServicePropertiesProperties +## LocalUserKeys ### Properties -* **automaticSnapshotPolicyEnabled**: bool: Deprecated in favor of isVersioningEnabled property. -* **changeFeed**: [ChangeFeed](#changefeed): The blob service properties for change feed events. -* **containerDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **defaultServiceVersion**: 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. -* **deleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. -* **isVersioningEnabled**: bool: Versioning is enabled if set to true. -* **lastAccessTimeTrackingPolicy**: [LastAccessTimeTrackingPolicy](#lastaccesstimetrackingpolicy): The blob service properties for Last access time based tracking policy. -* **restorePolicy**: [RestorePolicyProperties](#restorepolicyproperties): The blob service properties for blob restore policy +* **sharedKey**: string (ReadOnly): Auto generated by the server for SMB authentication. +* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[] (ReadOnly): Optional, local user ssh authorized keys for SFTP. -## ChangeFeed +## LocalUserProperties ### Properties -* **enabled**: bool: Indicates whether change feed event logging is enabled for the Blob service. -* **retentionInDays**: int: 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. +* **hasSharedKey**: bool: Indicates whether shared key exists. Set it to false to remove existing shared key. +* **hasSshKey**: bool: Indicates whether ssh key exists. Set it to false to remove existing SSH key. +* **hasSshPassword**: bool: Indicates whether ssh password exists. Set it to false to remove existing SSH password. +* **homeDirectory**: string: Optional, local user home directory. +* **permissionScopes**: [PermissionScope](#permissionscope)[]: The permission scopes of the local user. +* **sid**: string (ReadOnly): A unique Security Identifier that is generated by the server. +* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[]: Optional, local user ssh authorized keys for SFTP. -## DeleteRetentionPolicy +## ManagementPolicyAction ### Properties -* **allowPermanentDelete**: bool: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. -* **days**: int: 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. -* **enabled**: bool: Indicates whether DeleteRetentionPolicy is enabled. +* **baseBlob**: [ManagementPolicyBaseBlob](#managementpolicybaseblob): Management policy action for base blob. +* **snapshot**: [ManagementPolicySnapShot](#managementpolicysnapshot): Management policy action for snapshot. +* **version**: [ManagementPolicyVersion](#managementpolicyversion): Management policy action for blob version. -## CorsRules +## ManagementPolicyBaseBlob ### Properties -* **corsRules**: [CorsRule](#corsrule)[]: The List of CORS rules. You can include up to five CorsRule elements in the request. +* **delete**: [DateAfterModification](#dateaftermodification): Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. +* **enableAutoTierToHotFromCool**: bool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. +* **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. +* **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. -## CorsRule +## ManagementPolicyDefinition ### Properties -* **allowedHeaders**: string[] (Required): Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. -* **allowedMethods**: 'DELETE' | 'GET' | 'HEAD' | 'MERGE' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | string[] (Required): Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. -* **allowedOrigins**: string[] (Required): Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains -* **exposedHeaders**: string[] (Required): Required if CorsRule element is present. A list of response headers to expose to CORS clients. -* **maxAgeInSeconds**: int (Required): Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. +* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. +* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. -## LastAccessTimeTrackingPolicy +## ManagementPolicyFilter ### Properties -* **blobType**: string[]: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only -* **enable**: bool (Required): When set to true last access time based tracking is enabled. -* **name**: 'AccessTimeTracking' | string: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only -* **trackingGranularityInDays**: int: 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 +* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters +* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. +* **prefixMatch**: string[]: An array of strings for prefixes to be match. -## RestorePolicyProperties +## ManagementPolicyProperties ### Properties -* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. -* **enabled**: bool (Required): Blob restore is enabled if set to true. -* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. -* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. +* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. +* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. -## ContainerProperties +## ManagementPolicyRule ### Properties -* **defaultEncryptionScope**: string: Default the container to use specified encryption scope for all writes. -* **deleted**: bool (ReadOnly): Indicates whether the blob container was deleted. -* **deletedTime**: string (ReadOnly): Blob container deletion time. -* **denyEncryptionScopeOverride**: bool: Block override of encryption scope from the container default. -* **enableNfsV3AllSquash**: bool: Enable NFSv3 all squash on blob container. -* **enableNfsV3RootSquash**: bool: Enable NFSv3 root squash on blob container. -* **hasImmutabilityPolicy**: bool (ReadOnly): The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **immutabilityPolicy**: [ImmutabilityPolicyProperties](#immutabilitypolicyproperties) (ReadOnly): The properties of an ImmutabilityPolicy of a blob container. -* **immutableStorageWithVersioning**: [ImmutableStorageWithVersioning](#immutablestoragewithversioning): Object level immutability properties of the container. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the container was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **legalHold**: [LegalHoldProperties](#legalholdproperties) (ReadOnly): The LegalHold property of a blob container. -* **metadata**: [ContainerPropertiesMetadata](#containerpropertiesmetadata): A name-value pair to associate with the container as metadata. -* **publicAccess**: 'Blob' | 'Container' | 'None': Specifies whether data in the container may be accessed publicly and the level of access. -* **remainingRetentionDays**: int (ReadOnly): Remaining retention days for soft deleted blob container. -* **version**: string (ReadOnly): The version of the deleted blob container. +* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. +* **enabled**: bool: Rule is enabled if set to true. +* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle -## ImmutabilityPolicyProperties +## ManagementPolicySchema ### Properties -* **etag**: string (ReadOnly): ImmutabilityPolicy Etag. -* **properties**: [ImmutabilityPolicyProperty](#immutabilitypolicyproperty): The properties of an ImmutabilityPolicy of a blob container. -* **updateHistory**: [UpdateHistoryProperty](#updatehistoryproperty)[] (ReadOnly): The ImmutabilityPolicy update history of the blob container. +* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. -## ImmutabilityPolicyProperty +## ManagementPolicySnapShot ### Properties -* **allowProtectedAppendWrites**: bool: 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. -* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. -* **immutabilityPeriodSinceCreationInDays**: int: The immutability period for the blobs in the container since the policy creation, in days. -* **state**: 'Locked' | 'Unlocked' | string (ReadOnly): The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. +* **delete**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. +* **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. +* **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. -## UpdateHistoryProperty +## ManagementPolicyVersion ### Properties -* **allowProtectedAppendWrites**: bool: 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. -* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. -* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. -* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. -* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. +* **delete**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. +* **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. +* **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. -## ImmutableStorageWithVersioning +## Multichannel ### Properties -* **enabled**: bool: This is an immutable property, when set to true it enables object level immutability at the container level. -* **migrationState**: 'Completed' | 'InProgress' | string (ReadOnly): This property denotes the container level immutability to object level immutability migration state. -* **timeStamp**: string (ReadOnly): Returns the date and time the object level immutability was enabled. +* **enabled**: bool: Indicates whether multichannel is enabled -## LegalHoldProperties +## NetworkRuleSet ### Properties -* **hasLegalHold**: bool (ReadOnly): The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. -* **protectedAppendWritesHistory**: [ProtectedAppendWritesHistory](#protectedappendwriteshistory): Protected append writes history setting for the blob container with Legal holds. -* **tags**: [TagProperty](#tagproperty)[]: The list of LegalHold tags of a blob container. +* **bypass**: 'AzureServices' | 'Logging' | 'Metrics' | 'None' | string: 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. +* **defaultAction**: 'Allow' | 'Deny' (Required): Specifies the default action of allow or deny when no other rules match. +* **ipRules**: [IPRule](#iprule)[]: Sets the IP ACL rules +* **resourceAccessRules**: [ResourceAccessRule](#resourceaccessrule)[]: Sets the resource access rules +* **virtualNetworkRules**: [VirtualNetworkRule](#virtualnetworkrule)[]: Sets the virtual network rules -## ProtectedAppendWritesHistory +## ObjectReplicationPolicyFilter ### Properties -* **allowProtectedAppendWritesAll**: bool: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **minCreationTime**: string: 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 +* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. -## TagProperty +## ObjectReplicationPolicyProperties ### Properties -* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. -* **tag**: string (ReadOnly): The tag value. -* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. -* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. +* **destinationAccount**: string (Required): Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. +* **enabledTime**: string (ReadOnly): Indicates when the policy is enabled on the source account. +* **policyId**: string (ReadOnly): A unique id for object replication policy. +* **rules**: [ObjectReplicationPolicyRule](#objectreplicationpolicyrule)[]: The storage account object replication rules. +* **sourceAccount**: string (Required): Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. -## ContainerPropertiesMetadata +## ObjectReplicationPolicyRule ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **destinationContainer**: string (Required): Required. Destination container name. +* **filters**: [ObjectReplicationPolicyFilter](#objectreplicationpolicyfilter): 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. +* **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. +* **sourceContainer**: string (Required): Required. Source container name. -## EncryptionScopeProperties +## PermissionScope ### Properties -* **creationTime**: string (ReadOnly): Gets the creation date and time of the encryption scope in UTC. -* **keyVaultProperties**: [EncryptionScopeKeyVaultProperties](#encryptionscopekeyvaultproperties): The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. -* **lastModifiedTime**: string (ReadOnly): Gets the last modification date and time of the encryption scope in UTC. -* **requireInfrastructureEncryption**: bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. -* **source**: 'Microsoft.KeyVault' | 'Microsoft.Storage' | string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. -* **state**: 'Disabled' | 'Enabled' | string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. +* **permissions**: string (Required): The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c). +* **resourceName**: string (Required): The name of resource, normally the container name or the file share name, used by the local user. +* **service**: string (Required): The service used by the local user, e.g. blob, file. -## EncryptionScopeKeyVaultProperties +## PrivateEndpoint ### Properties -* **currentVersionedKeyIdentifier**: string (ReadOnly): The object identifier of the current versioned Key Vault Key in use. -* **keyUri**: string: 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. -* **lastKeyRotationTimestamp**: string (ReadOnly): Timestamp of last rotation of the Key Vault Key. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## FileServicePropertiesProperties +## PrivateEndpointConnection ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -* **protocolSettings**: [ProtocolSettings](#protocolsettings): Protocol settings for file service -* **shareDeleteRetentionPolicy**: [DeleteRetentionPolicy](#deleteretentionpolicy): The service properties for soft delete. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties) (ReadOnly): Properties of the PrivateEndpointConnectProperties. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## ProtocolSettings +## PrivateEndpointConnectionProperties ### Properties -* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint) (ReadOnly): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## SmbSetting +## PrivateLinkServiceConnectionState ### Properties -* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. -* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. -* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' -* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. -* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. +* **actionRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. -## Multichannel +## ProtectedAppendWritesHistory ### Properties -* **enabled**: bool: Indicates whether multichannel is enabled +* **allowProtectedAppendWritesAll**: bool: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. -## FileShareProperties +## ProtocolSettings ### Properties -* **accessTier**: 'Cool' | 'Hot' | 'Premium' | 'TransactionOptimized' | string: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. -* **accessTierChangeTime**: string (ReadOnly): Indicates the last modification time for share access tier. -* **accessTierStatus**: string (ReadOnly): Indicates if there is a pending transition for access tier. -* **deleted**: bool (ReadOnly): Indicates whether the share was deleted. -* **deletedTime**: string (ReadOnly): The deleted time if the share was deleted. -* **enabledProtocols**: 'NFS' | 'SMB' | string: The authentication protocol that is used for the file share. Can only be specified when creating a share. -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the share was last modified. -* **leaseDuration**: 'Fixed' | 'Infinite' | string (ReadOnly): Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. -* **leaseState**: 'Available' | 'Breaking' | 'Broken' | 'Expired' | 'Leased' | string (ReadOnly): Lease state of the container. -* **leaseStatus**: 'Locked' | 'Unlocked' | string (ReadOnly): The lease status of the container. -* **metadata**: [FileSharePropertiesMetadata](#filesharepropertiesmetadata): A name-value pair to associate with the share as metadata. -* **remainingRetentionDays**: int (ReadOnly): Remaining retention days for share that was soft deleted. -* **rootSquash**: 'AllSquash' | 'NoRootSquash' | 'RootSquash' | string: The property is for NFS share only. The default is NoRootSquash. -* **shareQuota**: int: 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. -* **shareUsageBytes**: int (ReadOnly): The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. -* **signedIdentifiers**: [SignedIdentifier](#signedidentifier)[]: List of stored access policies specified on the share. -* **snapshotTime**: string (ReadOnly): Creation time of share snapshot returned in the response of list shares with expand param "snapshots". -* **version**: string (ReadOnly): The version of the share. +* **smb**: [SmbSetting](#smbsetting): Setting for SMB protocol -## FileSharePropertiesMetadata +## QueueProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **approximateMessageCount**: int (ReadOnly): Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. +* **metadata**: [QueuePropertiesMetadata](#queuepropertiesmetadata): A name-value pair that represents queue metadata. -## SignedIdentifier +## QueuePropertiesMetadata ### Properties -* **accessPolicy**: [AccessPolicy](#accesspolicy) -* **id**: string: An unique identifier of the stored access policy. +### Additional Properties +* **Additional Properties Type**: string -## AccessPolicy +## QueueServicePropertiesProperties ### Properties -* **expiryTime**: string: Expiry time of the access policy -* **permission**: string: List of abbreviated permissions. -* **startTime**: string: Start time of the access policy +* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## BlobInventoryPolicyProperties +## ResourceAccessRule ### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the last modified date and time of the blob inventory policy. -* **policy**: [BlobInventoryPolicySchema](#blobinventorypolicyschema) (Required): The storage account blob inventory policy rules. +* **resourceId**: string: Resource Id +* **tenantId**: string: Tenant Id -## BlobInventoryPolicySchema +## RestorePolicyProperties ### Properties -* **destination**: string (ReadOnly): Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' -* **enabled**: bool (Required): Policy is enabled if set to true. -* **rules**: [BlobInventoryPolicyRule](#blobinventorypolicyrule)[] (Required): The storage account blob inventory policy rules. The rule is applied when it is enabled. -* **type**: 'Inventory' | string (Required): The valid value is Inventory +* **days**: int: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. +* **enabled**: bool (Required): Blob restore is enabled if set to true. +* **lastEnabledTime**: string (ReadOnly): Deprecated in favor of minRestoreTime property. +* **minRestoreTime**: string (ReadOnly): Returns the minimum date and time that the restore can be started. -## BlobInventoryPolicyRule +## RoutingPreference ### Properties -* **definition**: [BlobInventoryPolicyDefinition](#blobinventorypolicydefinition) (Required): An object that defines the blob inventory rule. -* **destination**: string (Required): Container name where blob inventory files are stored. Must be pre-created. -* **enabled**: bool (Required): Rule is enabled when set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. +* **publishInternetEndpoints**: bool: A boolean flag which indicates whether internet routing storage endpoints are to be published +* **publishMicrosoftEndpoints**: bool: A boolean flag which indicates whether microsoft routing storage endpoints are to be published +* **routingChoice**: 'InternetRouting' | 'MicrosoftRouting' | string: Routing Choice defines the kind of network routing opted by the user. -## BlobInventoryPolicyDefinition +## SasPolicy ### Properties -* **filters**: [BlobInventoryPolicyFilter](#blobinventorypolicyfilter): An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. -* **format**: 'Csv' | 'Parquet' | string (Required): This is a required field, it specifies the format for the inventory files. -* **objectType**: 'Blob' | 'Container' | string (Required): This is a required field. This field specifies the scope of the inventory created either at the blob or container level. -* **schedule**: 'Daily' | 'Weekly' | string (Required): This is a required field. This field is used to schedule an inventory formation. -* **schemaFields**: string[] (Required): This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. +* **expirationAction**: 'Log' | string (Required): The SAS expiration action. Can only be Log. +* **sasExpirationPeriod**: string (Required): The SAS expiration period, DD.HH:MM:SS. -## BlobInventoryPolicyFilter +## ServiceSasParameters ### Properties -* **blobTypes**: string[]: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. -* **excludePrefix**: string[]: An array of strings with maximum 10 blob prefixes to be excluded from the inventory. -* **includeBlobVersions**: bool: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. -* **includeDeleted**: bool: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. -* **includeSnapshots**: bool: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. -* **prefixMatch**: string[]: An array of strings with maximum 10 blob prefixes to be included in the inventory. +* **canonicalizedResource**: string (Required, WriteOnly): The canonical path to the signed resource. +* **endPk**: string (WriteOnly): The end of partition key. +* **endRk**: string (WriteOnly): The end of row key. +* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. +* **rscc**: string (WriteOnly): The response header override for cache control. +* **rscd**: string (WriteOnly): The response header override for content disposition. +* **rsce**: string (WriteOnly): The response header override for content encoding. +* **rscl**: string (WriteOnly): The response header override for content language. +* **rsct**: string (WriteOnly): The response header override for content type. +* **signedExpiry**: string (WriteOnly): The time at which the shared access signature becomes invalid. +* **signedIdentifier**: string (WriteOnly): A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table. +* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. +* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). +* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. +* **signedResource**: 'b' | 'c' | 'f' | 's' | string (WriteOnly): The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). +* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. +* **startPk**: string (WriteOnly): The start of partition key. +* **startRk**: string (WriteOnly): The start of row key. -## SystemData +## SignedIdentifier ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **accessPolicy**: [AccessPolicy](#accesspolicy) +* **id**: string: An unique identifier of the stored access policy. -## LocalUserProperties +## Sku ### Properties -* **hasSharedKey**: bool: Indicates whether shared key exists. Set it to false to remove existing shared key. -* **hasSshKey**: bool: Indicates whether ssh key exists. Set it to false to remove existing SSH key. -* **hasSshPassword**: bool: Indicates whether ssh password exists. Set it to false to remove existing SSH password. -* **homeDirectory**: string: Optional, local user home directory. -* **permissionScopes**: [PermissionScope](#permissionscope)[]: The permission scopes of the local user. -* **sid**: string (ReadOnly): A unique Security Identifier that is generated by the server. -* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[]: Optional, local user ssh authorized keys for SFTP. +* **name**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (Required): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. +* **tier**: 'Premium' | 'Standard' (ReadOnly): The SKU tier. This is based on the SKU name. -## PermissionScope +## SmbSetting ### Properties -* **permissions**: string (Required): The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c). -* **resourceName**: string (Required): The name of resource, normally the container name or the file share name, used by the local user. -* **service**: string (Required): The service used by the local user, e.g. blob, file. +* **authenticationMethods**: string: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. +* **channelEncryption**: string: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. +* **kerberosTicketEncryption**: string: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' +* **multichannel**: [Multichannel](#multichannel): Multichannel setting. Applies to Premium FileStorage only. +* **versions**: string: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. ## SshPublicKey ### Properties * **description**: string: Optional. It is used to store the function/usage of the key * **key**: string: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB -## ManagementPolicyProperties -### Properties -* **lastModifiedTime**: string (ReadOnly): Returns the date and time the ManagementPolicies was last modified. -* **policy**: [ManagementPolicySchema](#managementpolicyschema) (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. - -## ManagementPolicySchema -### Properties -* **rules**: [ManagementPolicyRule](#managementpolicyrule)[] (Required): The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. - -## ManagementPolicyRule -### Properties -* **definition**: [ManagementPolicyDefinition](#managementpolicydefinition) (Required): An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. -* **enabled**: bool: Rule is enabled if set to true. -* **name**: string (Required): A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. -* **type**: 'Lifecycle' | string (Required): The valid value is Lifecycle - -## ManagementPolicyDefinition -### Properties -* **actions**: [ManagementPolicyAction](#managementpolicyaction) (Required): Actions are applied to the filtered blobs when the execution condition is met. -* **filters**: [ManagementPolicyFilter](#managementpolicyfilter): 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. - -## ManagementPolicyAction -### Properties -* **baseBlob**: [ManagementPolicyBaseBlob](#managementpolicybaseblob): Management policy action for base blob. -* **snapshot**: [ManagementPolicySnapShot](#managementpolicysnapshot): Management policy action for snapshot. -* **version**: [ManagementPolicyVersion](#managementpolicyversion): Management policy action for blob version. - -## ManagementPolicyBaseBlob -### Properties -* **delete**: [DateAfterModification](#dateaftermodification): Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. -* **enableAutoTierToHotFromCool**: bool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. -* **tierToArchive**: [DateAfterModification](#dateaftermodification): Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. -* **tierToCool**: [DateAfterModification](#dateaftermodification): Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. - -## DateAfterModification -### Properties -* **daysAfterCreationGreaterThan**: int: Value indicating the age in days after blob creation. -* **daysAfterLastAccessTimeGreaterThan**: int: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy -* **daysAfterLastTierChangeGreaterThan**: int: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. -* **daysAfterModificationGreaterThan**: int: Value indicating the age in days after last modification - -## ManagementPolicySnapShot -### Properties -* **delete**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. -* **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. -* **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. - -## DateAfterCreation +## StorageAccountCreateParametersTags ### Properties -* **daysAfterCreationGreaterThan**: int (Required): Value indicating the age in days after creation -* **daysAfterLastTierChangeGreaterThan**: int: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. +### Additional Properties +* **Additional Properties Type**: string -## ManagementPolicyVersion +## StorageAccountInternetEndpoints ### Properties -* **delete**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. -* **tierToArchive**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. -* **tierToCool**: [DateAfterCreation](#dateaftercreation): Object to define snapshot and version action conditions. +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## ManagementPolicyFilter +## StorageAccountKey ### Properties -* **blobIndexMatch**: [TagFilter](#tagfilter)[]: An array of blob index tag based filters, there can be at most 10 tag filters -* **blobTypes**: string[] (Required): An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. -* **prefixMatch**: string[]: An array of strings for prefixes to be match. +* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. +* **keyName**: string (ReadOnly): Name of the key. +* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. +* **value**: string (ReadOnly): Base 64-encoded value of the key. -## TagFilter +## StorageAccountListKeysResult ### Properties -* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters -* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported -* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters +* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. -## ObjectReplicationPolicyProperties +## StorageAccountMicrosoftEndpoints ### Properties -* **destinationAccount**: string (Required): Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. -* **enabledTime**: string (ReadOnly): Indicates when the policy is enabled on the source account. -* **policyId**: string (ReadOnly): A unique id for object replication policy. -* **rules**: [ObjectReplicationPolicyRule](#objectreplicationpolicyrule)[]: The storage account object replication rules. -* **sourceAccount**: string (Required): Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. +* **blob**: string (ReadOnly): Gets the blob endpoint. +* **dfs**: string (ReadOnly): Gets the dfs endpoint. +* **file**: string (ReadOnly): Gets the file endpoint. +* **queue**: string (ReadOnly): Gets the queue endpoint. +* **table**: string (ReadOnly): Gets the table endpoint. +* **web**: string (ReadOnly): Gets the web endpoint. -## ObjectReplicationPolicyRule +## StorageAccountPropertiesCreateParameters ### Properties -* **destinationContainer**: string (Required): Required. Destination container name. -* **filters**: [ObjectReplicationPolicyFilter](#objectreplicationpolicyfilter): 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. -* **ruleId**: string: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. -* **sourceContainer**: string (Required): Required. Source container name. +* **accessTier**: 'Cool' | 'Hot' | 'Premium': Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. +* **allowBlobPublicAccess**: bool: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. +* **allowCrossTenantReplication**: bool: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. +* **allowedCopyScope**: 'AAD' | 'PrivateLink' | string: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. +* **allowSharedKeyAccess**: bool: 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. +* **azureFilesIdentityBasedAuthentication**: [AzureFilesIdentityBasedAuthentication](#azurefilesidentitybasedauthentication): Settings for Azure Files identity based authentication. +* **blobRestoreStatus**: [BlobRestoreStatus](#blobrestorestatus) (ReadOnly): Blob restore status. +* **creationTime**: string (ReadOnly): Gets the creation date and time of the storage account in UTC. +* **customDomain**: [CustomDomain](#customdomain): The custom domain assigned to this storage account. This can be set via Update. +* **defaultToOAuthAuthentication**: bool: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. +* **dnsEndpointType**: 'AzureDnsZone' | 'Standard' | string: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. +* **encryption**: [Encryption](#encryption): The encryption settings on the storage account. +* **failoverInProgress**: bool (ReadOnly): If the failover is in progress, the value will be true, otherwise, it will be null. +* **geoReplicationStats**: [GeoReplicationStats](#georeplicationstats) (ReadOnly): Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. +* **immutableStorageWithVersioning**: [ImmutableStorageAccount](#immutablestorageaccount): This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. +* **isHnsEnabled**: bool: Account HierarchicalNamespace enabled if sets to true. +* **isLocalUserEnabled**: bool: Enables local users feature, if set to true +* **isNfsV3Enabled**: bool: NFS 3.0 protocol support enabled if set to true. +* **isSftpEnabled**: bool: Enables Secure File Transfer Protocol, if set to true +* **keyCreationTime**: [KeyCreationTime](#keycreationtime) (ReadOnly): Storage account keys creation time. +* **keyPolicy**: [KeyPolicy](#keypolicy): KeyPolicy assigned to the storage account. +* **largeFileSharesState**: 'Disabled' | 'Enabled' | string: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. +* **lastGeoFailoverTime**: string (ReadOnly): Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **minimumTlsVersion**: 'TLS1_0' | 'TLS1_1' | 'TLS1_2' | string: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. +* **networkAcls**: [NetworkRuleSet](#networkruleset): Network rule set +* **primaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **primaryLocation**: string (ReadOnly): Gets the location of the primary data center for the storage account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage account +* **provisioningState**: 'Creating' | 'ResolvingDNS' | 'Succeeded' (ReadOnly): Gets the status of the storage account at the time the operation was called. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. +* **routingPreference**: [RoutingPreference](#routingpreference): 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 +* **sasPolicy**: [SasPolicy](#saspolicy): SasPolicy assigned to the storage account. +* **secondaryEndpoints**: [Endpoints](#endpoints) (ReadOnly): The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. +* **secondaryLocation**: string (ReadOnly): Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. +* **statusOfPrimary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **statusOfSecondary**: 'available' | 'unavailable' (ReadOnly): Gets the status indicating whether the primary location of the storage account is available or unavailable. +* **storageAccountSkuConversionStatus**: [StorageAccountSkuConversionStatus](#storageaccountskuconversionstatus) (ReadOnly): This defines the sku conversion status object for asynchronous sku conversions. +* **supportsHttpsTrafficOnly**: bool: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. -## ObjectReplicationPolicyFilter +## StorageAccountSkuConversionStatus ### Properties -* **minCreationTime**: string: 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 -* **prefixMatch**: string[]: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. +* **endTime**: string (ReadOnly): This property represents the sku conversion end time. +* **skuConversionStatus**: 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): This property indicates the current sku conversion status. +* **startTime**: string (ReadOnly): This property represents the sku conversion start time. +* **targetSkuName**: 'Premium_LRS' | 'Premium_ZRS' | 'Standard_GRS' | 'Standard_GZRS' | 'Standard_LRS' | 'Standard_RAGRS' | 'Standard_RAGZRS' | 'Standard_ZRS' | string (ReadOnly): The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. -## QueueServicePropertiesProperties +## SystemData ### Properties -* **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## QueueProperties +## TableAccessPolicy ### Properties -* **approximateMessageCount**: int (ReadOnly): Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. -* **metadata**: [QueuePropertiesMetadata](#queuepropertiesmetadata): A name-value pair that represents queue metadata. +* **expiryTime**: string: Expiry time of the access policy +* **permission**: string (Required): Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' +* **startTime**: string: Start time of the access policy -## QueuePropertiesMetadata +## TableProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **signedIdentifiers**: [TableSignedIdentifier](#tablesignedidentifier)[]: List of stored access policies specified on the table. +* **tableName**: string (ReadOnly): Table name under the specified account ## TableServicePropertiesProperties ### Properties * **cors**: [CorsRules](#corsrules): Sets the CORS rules. You can include up to five CorsRule elements in the request. -## TableProperties -### Properties -* **signedIdentifiers**: [TableSignedIdentifier](#tablesignedidentifier)[]: List of stored access policies specified on the table. -* **tableName**: string (ReadOnly): Table name under the specified account - ## TableSignedIdentifier ### Properties * **accessPolicy**: [TableAccessPolicy](#tableaccesspolicy): Table Access Policy Properties Object. * **id**: string (Required): unique-64-character-value of the stored access policy. -## TableAccessPolicy -### Properties -* **expiryTime**: string: Expiry time of the access policy -* **permission**: string (Required): Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' -* **startTime**: string: Start time of the access policy - -## AccountSasParameters -### Properties -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **signedExpiry**: string (Required, WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (Required, WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResourceTypes**: 'c' | 'o' | 's' | string (Required, WriteOnly): The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. -* **signedServices**: 'b' | 'f' | 'q' | 't' | string (Required, WriteOnly): The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. - -## ListAccountSasResponse -### Properties -* **accountSasToken**: string (ReadOnly): List SAS credentials of storage account. - -## StorageAccountListKeysResult +## TagFilter ### Properties -* **keys**: [StorageAccountKey](#storageaccountkey)[] (ReadOnly): Gets the list of storage account keys and their properties for the specified storage account. +* **name**: string (Required): This is the filter tag name, it can have 1 - 128 characters +* **op**: string (Required): This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported +* **value**: string (Required): This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters -## StorageAccountKey +## TagProperty ### Properties -* **creationTime**: string (ReadOnly): Creation time of the key, in round trip date format. -* **keyName**: string (ReadOnly): Name of the key. -* **permissions**: 'Full' | 'Read' (ReadOnly): Permissions for the key -- read-only or full permissions. -* **value**: string (ReadOnly): Base 64-encoded value of the key. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who added the tag. +* **tag**: string (ReadOnly): The tag value. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who added the tag. +* **timestamp**: string (ReadOnly): Returns the date and time the tag was added. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who added the tag. -## LocalUserKeys +## UpdateHistoryProperty ### Properties -* **sharedKey**: string (ReadOnly): Auto generated by the server for SMB authentication. -* **sshAuthorizedKeys**: [SshPublicKey](#sshpublickey)[] (ReadOnly): Optional, local user ssh authorized keys for SFTP. +* **allowProtectedAppendWrites**: bool: 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. +* **allowProtectedAppendWritesAll**: bool: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' 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. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. +* **immutabilityPeriodSinceCreationInDays**: int (ReadOnly): The immutability period for the blobs in the container since the policy creation, in days. +* **objectIdentifier**: string (ReadOnly): Returns the Object ID of the user who updated the ImmutabilityPolicy. +* **tenantId**: string (ReadOnly): Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. +* **timestamp**: string (ReadOnly): Returns the date and time the ImmutabilityPolicy was updated. +* **update**: 'extend' | 'lock' | 'put' | string (ReadOnly): The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. +* **upn**: string (ReadOnly): Returns the User Principal Name of the user who updated the ImmutabilityPolicy. -## ServiceSasParameters +## UserAssignedIdentity ### Properties -* **canonicalizedResource**: string (Required, WriteOnly): The canonical path to the signed resource. -* **endPk**: string (WriteOnly): The end of partition key. -* **endRk**: string (WriteOnly): The end of row key. -* **keyToSign**: string (WriteOnly): The key to sign the account SAS token with. -* **rscc**: string (WriteOnly): The response header override for cache control. -* **rscd**: string (WriteOnly): The response header override for content disposition. -* **rsce**: string (WriteOnly): The response header override for content encoding. -* **rscl**: string (WriteOnly): The response header override for content language. -* **rsct**: string (WriteOnly): The response header override for content type. -* **signedExpiry**: string (WriteOnly): The time at which the shared access signature becomes invalid. -* **signedIdentifier**: string (WriteOnly): A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table. -* **signedIp**: string (WriteOnly): An IP address or a range of IP addresses from which to accept requests. -* **signedPermission**: 'a' | 'c' | 'd' | 'l' | 'p' | 'r' | 'u' | 'w' | string (WriteOnly): The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). -* **signedProtocol**: 'https' | 'https,http' (WriteOnly): The protocol permitted for a request made with the account SAS. -* **signedResource**: 'b' | 'c' | 'f' | 's' | string (WriteOnly): The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). -* **signedStart**: string (WriteOnly): The time at which the SAS becomes valid. -* **startPk**: string (WriteOnly): The start of partition key. -* **startRk**: string (WriteOnly): The start of row key. +* **clientId**: string (ReadOnly): The client ID of the identity. +* **principalId**: string (ReadOnly): The principal ID of the identity. -## ListServiceSasResponse +## VirtualNetworkRule ### Properties -* **serviceSasToken**: string (ReadOnly): List service SAS credentials of specific resource. +* **action**: 'Allow': The action of virtual network rule. +* **id**: string (Required): Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. +* **state**: 'Deprovisioning' | 'Failed' | 'NetworkSourceDeleted' | 'Provisioning' | 'Succeeded' | string: Gets the state of virtual network rule. diff --git a/generated/storagecache/log.out b/generated/storagecache/log.out index f440723d94..11f84a109c 100644 --- a/generated/storagecache/log.out +++ b/generated/storagecache/log.out @@ -3,34 +3,34 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.storagecache-2022-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 19ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.storagecache-2021-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.storagecache-2021-05-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.storagecache-2021-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagecache-2020-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApiOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-10-01/storagecache.json:1134:9 @@ -72,10 +72,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkusResult' with an u - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-10-01/storagecache.json:2126:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.storagecache-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApiOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json:1070:9 @@ -109,10 +109,10 @@ warning | PreCheck/SchemaMissingType | The schema 'ResourceSkusResult' with an u - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json:1808:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagecache-2019-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApiOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2019-11-01/storagecache.json:1011:9 @@ -163,7 +163,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.storagecache-2019-08-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApiOperation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json:1066:9 @@ -204,4 +204,4 @@ warning | Modeler/MissingType | The schema 'paths·fiq97y·subscriptions-subscri file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json#/components/schemas/paths·fiq97y·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-storagecache-caches-cachename-upgrade·post·responses·202·content·application-json·schema warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 2ms -info | Autorest completed in 21.78s. 16 files generated. +info | Autorest completed in 21.61s. 16 files generated. diff --git a/generated/storagecache/microsoft.storagecache/2019-08-01-preview/types.md b/generated/storagecache/microsoft.storagecache/2019-08-01-preview/types.md index 115bd58cd4..97c2d407d9 100644 --- a/generated/storagecache/microsoft.storagecache/2019-08-01-preview/types.md +++ b/generated/storagecache/microsoft.storagecache/2019-08-01-preview/types.md @@ -21,6 +21,11 @@ * **properties**: [StorageTargetProperties](#storagetargetproperties): Properties of the storage target. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## CacheHealth +### Properties +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheProperties ### Properties * **cacheSizeGB**: int: The size of this cache's cache, in GB. @@ -30,10 +35,9 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus): Properties describing the software upgrade state of the cache -## CacheHealth +## CacheSku ### Properties -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of cache health states. -* **statusDescription**: string: Describes explanation of state. +* **name**: string: Sku name for this cache. ## CacheUpgradeStatus ### Properties @@ -43,19 +47,6 @@ * **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. * **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. -## CacheSku -### Properties -* **name**: string: Sku name for this cache. - -## StorageTargetProperties -### Properties -* **clfs**: [ClfsTarget](#clfstarget): Storage container for use as a CLFS StorageTarget. -* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of cache namespace to target namespace associations. -* **nfs3**: [Nfs3Target](#nfs3target): An NFS mount point for use as a StorageTarget. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property -* **targetType**: 'clfs' | 'nfs3' | 'unknown' | string: Type for storage target. -* **unknown**: [UnknownTarget](#unknowntarget): Storage container for use as a Unknown StorageTarget. - ## ClfsTarget ### Properties * **target**: string: A fully qualified URL. @@ -71,12 +62,21 @@ * **target**: string: IP or name of an NFS Storage Target host, ie: 10.0.44.44 * **usageModel**: string: Identifies the primary usage model to be used for this storage target. GET choices from .../usageModels -## UnknownTarget +## StorageTargetProperties ### Properties -* **unknownMap**: [UnknownProperties](#unknownproperties): Properties of an unknown type of StorageTarget +* **clfs**: [ClfsTarget](#clfstarget): Storage container for use as a CLFS StorageTarget. +* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of cache namespace to target namespace associations. +* **nfs3**: [Nfs3Target](#nfs3target): An NFS mount point for use as a StorageTarget. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property +* **targetType**: 'clfs' | 'nfs3' | 'unknown' | string: Type for storage target. +* **unknown**: [UnknownTarget](#unknowntarget): Storage container for use as a Unknown StorageTarget. ## UnknownProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## UnknownTarget +### Properties +* **unknownMap**: [UnknownProperties](#unknownproperties): Properties of an unknown type of StorageTarget + diff --git a/generated/storagecache/microsoft.storagecache/2019-11-01/types.md b/generated/storagecache/microsoft.storagecache/2019-11-01/types.md index a9e47ffdd8..f4d890ed36 100644 --- a/generated/storagecache/microsoft.storagecache/2019-11-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2019-11-01/types.md @@ -21,6 +21,11 @@ * **properties**: [StorageTargetProperties](#storagetargetproperties): Properties of the Storage Target. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## CacheHealth +### Properties +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheProperties ### Properties * **cacheSizeGB**: int: The size of this Cache, in GB. @@ -30,10 +35,9 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus): Properties describing the software upgrade state of the Cache. -## CacheHealth +## CacheSku ### Properties -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. +* **name**: string: SKU name for this Cache. ## CacheUpgradeStatus ### Properties @@ -43,19 +47,6 @@ * **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. * **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. -## CacheSku -### Properties -* **name**: string: SKU name for this Cache. - -## StorageTargetProperties -### Properties -* **clfs**: [ClfsTarget](#clfstarget): Storage container for use as a CLFS Storage Target. -* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of Cache namespace junctions to target for namespace associations. -* **nfs3**: [Nfs3Target](#nfs3target): An NFSv3 mount point for use as a Storage Target. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property -* **targetType**: 'clfs' | 'nfs3' | 'unknown' | string: Type of the Storage Target. -* **unknown**: [UnknownTarget](#unknowntarget): Storage container for use as an Unknown Storage Target. - ## ClfsTarget ### Properties * **target**: string: A fully qualified URL. @@ -71,12 +62,21 @@ * **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). * **usageModel**: string: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels -## UnknownTarget +## StorageTargetProperties ### Properties -* **unknownMap**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. +* **clfs**: [ClfsTarget](#clfstarget): Storage container for use as a CLFS Storage Target. +* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of Cache namespace junctions to target for namespace associations. +* **nfs3**: [Nfs3Target](#nfs3target): An NFSv3 mount point for use as a Storage Target. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property +* **targetType**: 'clfs' | 'nfs3' | 'unknown' | string: Type of the Storage Target. +* **unknown**: [UnknownTarget](#unknowntarget): Storage container for use as an Unknown Storage Target. ## UnknownProperties ### Properties ### Additional Properties * **Additional Properties Type**: string +## UnknownTarget +### Properties +* **unknownMap**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. + diff --git a/generated/storagecache/microsoft.storagecache/2020-03-01/types.md b/generated/storagecache/microsoft.storagecache/2020-03-01/types.md index 60f4403e4d..eb7299f32b 100644 --- a/generated/storagecache/microsoft.storagecache/2020-03-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2020-03-01/types.md @@ -25,12 +25,26 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## CacheEncryptionSettings +### Properties +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. + +## CacheHealth +### Properties +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the cache. * **tenantId**: string (ReadOnly): The tenant id associated with the cache. * **type**: 'None' | 'SystemAssigned': The type of identity used for the cache +## CacheNetworkSettings +### Properties +* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. +* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. + ## CacheProperties ### Properties * **cacheSizeGB**: int: The size of this Cache, in GB. @@ -43,33 +57,14 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus): Properties describing the software upgrade state of the Cache. -## CacheEncryptionSettings -### Properties -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. - -## KeyVaultKeyReference -### Properties -* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. -* **sourceVault**: [KeyVaultKeyReferenceSourceVault](#keyvaultkeyreferencesourcevault) (Required): Describes a resource Id to source Key Vault. - -## KeyVaultKeyReferenceSourceVault -### Properties -* **id**: string: Resource Id. - -## CacheHealth -### Properties -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. - -## CacheNetworkSettings -### Properties -* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. -* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. - ## CacheSecuritySettings ### Properties * **rootSquash**: bool: root squash of cache property. +## CacheSku +### Properties +* **name**: string: SKU name for this Cache. + ## CacheUpgradeStatus ### Properties * **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. @@ -78,18 +73,29 @@ * **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. * **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. -## CacheSku +## ClfsTarget ### Properties -* **name**: string: SKU name for this Cache. +* **target**: string: A fully qualified URL. -## SystemData +## KeyVaultKeyReference ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **keyUrl**: string (Required): The URL referencing a key encryption key in Key Vault. +* **sourceVault**: [KeyVaultKeyReferenceSourceVault](#keyvaultkeyreferencesourcevault) (Required): Describes a resource Id to source Key Vault. + +## KeyVaultKeyReferenceSourceVault +### Properties +* **id**: string: Resource Id. + +## NamespaceJunction +### Properties +* **namespacePath**: string: Namespace path on a Cache for a Storage Target. +* **nfsExport**: string: NFS export where targetPath exists. +* **targetPath**: string: Path in Storage Target to which namespacePath points. + +## Nfs3Target +### Properties +* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). +* **usageModel**: string: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ## StorageTargetProperties * **Discriminator**: targetType @@ -113,27 +119,21 @@ * **targetType**: 'unknown' (Required): Type of the Storage Target. -## ClfsTarget -### Properties -* **target**: string: A fully qualified URL. - -## NamespaceJunction +## SystemData ### Properties -* **namespacePath**: string: Namespace path on a Cache for a Storage Target. -* **nfsExport**: string: NFS export where targetPath exists. -* **targetPath**: string: Path in Storage Target to which namespacePath points. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## Nfs3Target +## UnknownProperties ### Properties -* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). -* **usageModel**: string: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels +### Additional Properties +* **Additional Properties Type**: string ## UnknownTarget ### Properties * **unknownMap**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. -## UnknownProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/storagecache/microsoft.storagecache/2020-10-01/types.md b/generated/storagecache/microsoft.storagecache/2020-10-01/types.md index 66ee974512..70f64f6e0f 100644 --- a/generated/storagecache/microsoft.storagecache/2020-10-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2020-10-01/types.md @@ -25,12 +25,46 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## CacheActiveDirectorySettings +### Properties +* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. +* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. +* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. +* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. +* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. +* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. + +## CacheActiveDirectorySettingsCredentials +### Properties +* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. + +## CacheDirectorySettings +### Properties +* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. +* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. + +## CacheEncryptionSettings +### Properties +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. + +## CacheHealth +### Properties +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the cache. * **tenantId**: string (ReadOnly): The tenant id associated with the cache. * **type**: 'None' | 'SystemAssigned': The type of identity used for the cache +## CacheNetworkSettings +### Properties +* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. +* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. + ## CacheProperties ### Properties * **cacheSizeGB**: int: The size of this Cache, in GB. @@ -44,25 +78,21 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus): Properties describing the software upgrade state of the Cache. -## CacheDirectorySettings +## CacheSecuritySettings ### Properties -* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. -* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. +* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. -## CacheActiveDirectorySettings +## CacheSku ### Properties -* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. -* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. -* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. -* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. -* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. -* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. -* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **name**: string: SKU name for this Cache. -## CacheActiveDirectorySettingsCredentials +## CacheUpgradeStatus ### Properties -* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. -* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. +* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. +* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. +* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. +* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. ## CacheUsernameDownloadSettings ### Properties @@ -84,9 +114,9 @@ * **bindDn**: string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. * **bindPassword**: string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. -## CacheEncryptionSettings +## ClfsTarget ### Properties -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. +* **target**: string: A fully qualified URL. ## KeyVaultKeyReference ### Properties @@ -97,19 +127,17 @@ ### Properties * **id**: string: Resource Id. -## CacheHealth -### Properties -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. - -## CacheNetworkSettings +## NamespaceJunction ### Properties -* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. -* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. +* **namespacePath**: string: Namespace path on a Cache for a Storage Target. +* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. +* **nfsExport**: string: NFS export where targetPath exists. +* **targetPath**: string: Path in Storage Target to which namespacePath points. -## CacheSecuritySettings +## Nfs3Target ### Properties -* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. +* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). +* **usageModel**: string: Identifies the usage model to be used for this Storage Target. Get choices from .../usageModels ## NfsAccessPolicy ### Properties @@ -127,27 +155,6 @@ * **submountAccess**: bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. * **suid**: bool: Allow SUID semantics. -## CacheUpgradeStatus -### Properties -* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. -* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. -* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. -* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. -* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. - -## CacheSku -### Properties -* **name**: string: SKU name for this Cache. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - ## StorageTargetProperties * **Discriminator**: targetType @@ -170,28 +177,21 @@ * **targetType**: 'unknown' (Required): Type of the Storage Target. -## ClfsTarget -### Properties -* **target**: string: A fully qualified URL. - -## NamespaceJunction +## SystemData ### Properties -* **namespacePath**: string: Namespace path on a Cache for a Storage Target. -* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. -* **nfsExport**: string: NFS export where targetPath exists. -* **targetPath**: string: Path in Storage Target to which namespacePath points. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## Nfs3Target +## UnknownProperties ### Properties -* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). -* **usageModel**: string: Identifies the usage model to be used for this Storage Target. Get choices from .../usageModels +### Additional Properties +* **Additional Properties Type**: string ## UnknownTarget ### Properties * **unknownMap**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. -## UnknownProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/storagecache/microsoft.storagecache/2021-03-01/types.md b/generated/storagecache/microsoft.storagecache/2021-03-01/types.md index 26d0cafa5f..4c9571ba8b 100644 --- a/generated/storagecache/microsoft.storagecache/2021-03-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2021-03-01/types.md @@ -25,12 +25,55 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## BlobNfsTarget +### Properties +* **target**: string: A fully qualified URL. +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. + +## CacheActiveDirectorySettings +### Properties +* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. +* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. +* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. +* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. +* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. +* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. + +## CacheActiveDirectorySettingsCredentials +### Properties +* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. + +## CacheDirectorySettings +### Properties +* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. +* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. + +## CacheEncryptionSettings +### Properties +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. + +## CacheHealth +### Properties +* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheIdentity ### Properties * **principalId**: string (ReadOnly): The principal id of the cache. * **tenantId**: string (ReadOnly): The tenant id associated with the cache. * **type**: 'None' | 'SystemAssigned': The type of identity used for the cache +## CacheNetworkSettings +### Properties +* **dnsSearchDomain**: string: DNS search domain +* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. +* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. +* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. +* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. + ## CacheProperties ### Properties * **cacheSizeGB**: int: The size of this Cache, in GB. @@ -44,25 +87,26 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus): Properties describing the software upgrade state of the Cache. -## CacheDirectorySettings +## CacheSecuritySettings ### Properties -* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. -* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. +* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. -## CacheActiveDirectorySettings +## CacheSku ### Properties -* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. -* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. -* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. -* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. -* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. -* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. -* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **name**: string: SKU name for this Cache. -## CacheActiveDirectorySettingsCredentials +## CacheTags ### Properties -* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. -* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +### Additional Properties +* **Additional Properties Type**: string + +## CacheUpgradeStatus +### Properties +* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. +* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. +* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. +* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. +* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. ## CacheUsernameDownloadSettings ### Properties @@ -84,9 +128,14 @@ * **bindDn**: string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. * **bindPassword**: string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. -## CacheEncryptionSettings +## ClfsTarget ### Properties -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. +* **target**: string: A fully qualified URL. + +## Condition +### Properties +* **message**: string (ReadOnly): The issue requiring attention. +* **timestamp**: string (ReadOnly): The time when the condition was raised. ## KeyVaultKeyReference ### Properties @@ -97,28 +146,17 @@ ### Properties * **id**: string: Resource Id. -## CacheHealth -### Properties -* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. - -## Condition -### Properties -* **message**: string (ReadOnly): The issue requiring attention. -* **timestamp**: string (ReadOnly): The time when the condition was raised. - -## CacheNetworkSettings +## NamespaceJunction ### Properties -* **dnsSearchDomain**: string: DNS search domain -* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. -* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. -* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. -* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. +* **namespacePath**: string: Namespace path on a Cache for a Storage Target. +* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. +* **nfsExport**: string: NFS export where targetPath exists. +* **targetPath**: string: Path in Storage Target to which namespacePath points. -## CacheSecuritySettings +## Nfs3Target ### Properties -* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. +* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. ## NfsAccessPolicy ### Properties @@ -136,17 +174,15 @@ * **submountAccess**: bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. * **suid**: bool: Allow SUID semantics. -## CacheUpgradeStatus -### Properties -* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. -* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. -* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. -* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. -* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. - -## CacheSku +## StorageTargetProperties ### Properties -* **name**: string: SKU name for this Cache. +* **blobNfs**: [BlobNfsTarget](#blobnfstarget): Properties pertaining to the BlobNfsTarget. +* **clfs**: [ClfsTarget](#clfstarget): Properties pertaining to the ClfsTarget +* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of Cache namespace junctions to target for namespace associations. +* **nfs3**: [Nfs3Target](#nfs3target): Properties pertaining to the Nfs3Target +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property +* **targetType**: 'blobNfs' | 'clfs' | 'nfs3' | 'unknown' | string (Required): Type of the Storage Target. +* **unknown**: [UnknownTarget](#unknowntarget): Properties pertaining to the UnknownTarget ## SystemData ### Properties @@ -157,48 +193,12 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CacheTags +## UnknownProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StorageTargetProperties -### Properties -* **blobNfs**: [BlobNfsTarget](#blobnfstarget): Properties pertaining to the BlobNfsTarget. -* **clfs**: [ClfsTarget](#clfstarget): Properties pertaining to the ClfsTarget -* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of Cache namespace junctions to target for namespace associations. -* **nfs3**: [Nfs3Target](#nfs3target): Properties pertaining to the Nfs3Target -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property -* **targetType**: 'blobNfs' | 'clfs' | 'nfs3' | 'unknown' | string (Required): Type of the Storage Target. -* **unknown**: [UnknownTarget](#unknowntarget): Properties pertaining to the UnknownTarget - -## BlobNfsTarget -### Properties -* **target**: string: A fully qualified URL. -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. - -## ClfsTarget -### Properties -* **target**: string: A fully qualified URL. - -## NamespaceJunction -### Properties -* **namespacePath**: string: Namespace path on a Cache for a Storage Target. -* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. -* **nfsExport**: string: NFS export where targetPath exists. -* **targetPath**: string: Path in Storage Target to which namespacePath points. - -## Nfs3Target -### Properties -* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. - ## UnknownTarget ### Properties * **attributes**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. -## UnknownProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/storagecache/microsoft.storagecache/2021-05-01/types.md b/generated/storagecache/microsoft.storagecache/2021-05-01/types.md index 67616a882c..3d0dc09f85 100644 --- a/generated/storagecache/microsoft.storagecache/2021-05-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2021-05-01/types.md @@ -25,6 +25,42 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## BlobNfsTarget +### Properties +* **target**: string: A fully qualified URL. +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. + +## CacheActiveDirectorySettings +### Properties +* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. +* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. +* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. +* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. +* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. +* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. + +## CacheActiveDirectorySettingsCredentials +### Properties +* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. + +## CacheDirectorySettings +### Properties +* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. +* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. + +## CacheEncryptionSettings +### Properties +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. +* **rotationToLatestKeyVersionEnabled**: bool: Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault. + +## CacheHealth +### Properties +* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheIdentity ### Properties * **principalId**: string (ReadOnly): The principal ID for the system-assigned identity of the cache. @@ -37,10 +73,13 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## UserAssignedIdentitiesValue +## CacheNetworkSettings ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **dnsSearchDomain**: string: DNS search domain +* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. +* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. +* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. +* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. ## CacheProperties ### Properties @@ -55,25 +94,26 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus) (ReadOnly): Properties describing the software upgrade state of the Cache. -## CacheDirectorySettings +## CacheSecuritySettings ### Properties -* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. -* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. +* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. -## CacheActiveDirectorySettings +## CacheSku ### Properties -* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. -* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. -* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. -* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. -* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. -* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. -* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **name**: string: SKU name for this Cache. -## CacheActiveDirectorySettingsCredentials +## CacheTags ### Properties -* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. -* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +### Additional Properties +* **Additional Properties Type**: string + +## CacheUpgradeStatus +### Properties +* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. +* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. +* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. +* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. +* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. ## CacheUsernameDownloadSettings ### Properties @@ -95,10 +135,14 @@ * **bindDn**: string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. * **bindPassword**: string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. -## CacheEncryptionSettings +## ClfsTarget ### Properties -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. -* **rotationToLatestKeyVersionEnabled**: bool: Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault. +* **target**: string: A fully qualified URL. + +## Condition +### Properties +* **message**: string (ReadOnly): The issue requiring attention. +* **timestamp**: string (ReadOnly): The time when the condition was raised. ## KeyVaultKeyReference ### Properties @@ -109,28 +153,17 @@ ### Properties * **id**: string: Resource Id. -## CacheHealth -### Properties -* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. - -## Condition -### Properties -* **message**: string (ReadOnly): The issue requiring attention. -* **timestamp**: string (ReadOnly): The time when the condition was raised. - -## CacheNetworkSettings +## NamespaceJunction ### Properties -* **dnsSearchDomain**: string: DNS search domain -* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. -* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. -* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. -* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. +* **namespacePath**: string: Namespace path on a Cache for a Storage Target. +* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. +* **nfsExport**: string: NFS export where targetPath exists. +* **targetPath**: string: Path in Storage Target to which namespacePath points. -## CacheSecuritySettings +## Nfs3Target ### Properties -* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. +* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. ## NfsAccessPolicy ### Properties @@ -148,17 +181,15 @@ * **submountAccess**: bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. * **suid**: bool: Allow SUID semantics. -## CacheUpgradeStatus -### Properties -* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. -* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. -* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. -* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. -* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. - -## CacheSku +## StorageTargetProperties ### Properties -* **name**: string: SKU name for this Cache. +* **blobNfs**: [BlobNfsTarget](#blobnfstarget): Properties pertaining to the BlobNfsTarget. +* **clfs**: [ClfsTarget](#clfstarget): Properties pertaining to the ClfsTarget +* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of Cache namespace junctions to target for namespace associations. +* **nfs3**: [Nfs3Target](#nfs3target): Properties pertaining to the Nfs3Target +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property +* **targetType**: 'blobNfs' | 'clfs' | 'nfs3' | 'unknown' | string (Required): Type of the Storage Target. +* **unknown**: [UnknownTarget](#unknowntarget): Properties pertaining to the UnknownTarget ## SystemData ### Properties @@ -169,48 +200,17 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## CacheTags +## UnknownProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StorageTargetProperties -### Properties -* **blobNfs**: [BlobNfsTarget](#blobnfstarget): Properties pertaining to the BlobNfsTarget. -* **clfs**: [ClfsTarget](#clfstarget): Properties pertaining to the ClfsTarget -* **junctions**: [NamespaceJunction](#namespacejunction)[]: List of Cache namespace junctions to target for namespace associations. -* **nfs3**: [Nfs3Target](#nfs3target): Properties pertaining to the Nfs3Target -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property -* **targetType**: 'blobNfs' | 'clfs' | 'nfs3' | 'unknown' | string (Required): Type of the Storage Target. -* **unknown**: [UnknownTarget](#unknowntarget): Properties pertaining to the UnknownTarget - -## BlobNfsTarget -### Properties -* **target**: string: A fully qualified URL. -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. - -## ClfsTarget -### Properties -* **target**: string: A fully qualified URL. - -## NamespaceJunction -### Properties -* **namespacePath**: string: Namespace path on a Cache for a Storage Target. -* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. -* **nfsExport**: string: NFS export where targetPath exists. -* **targetPath**: string: Path in Storage Target to which namespacePath points. - -## Nfs3Target -### Properties -* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. - ## UnknownTarget ### Properties * **attributes**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. -## UnknownProperties +## UserAssignedIdentitiesValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/storagecache/microsoft.storagecache/2021-09-01/types.md b/generated/storagecache/microsoft.storagecache/2021-09-01/types.md index b54572cbe6..e1befdff73 100644 --- a/generated/storagecache/microsoft.storagecache/2021-09-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2021-09-01/types.md @@ -25,6 +25,42 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## BlobNfsTarget +### Properties +* **target**: string: A fully qualified URL. +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. + +## CacheActiveDirectorySettings +### Properties +* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. +* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. +* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. +* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. +* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. +* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. + +## CacheActiveDirectorySettingsCredentials +### Properties +* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. + +## CacheDirectorySettings +### Properties +* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. +* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. + +## CacheEncryptionSettings +### Properties +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. +* **rotationToLatestKeyVersionEnabled**: bool: Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault. + +## CacheHealth +### Properties +* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheIdentity ### Properties * **principalId**: string (ReadOnly): The principal ID for the system-assigned identity of the cache. @@ -37,10 +73,13 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## UserAssignedIdentitiesValue +## CacheNetworkSettings ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **dnsSearchDomain**: string: DNS search domain +* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. +* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. +* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. +* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. ## CacheProperties ### Properties @@ -55,25 +94,26 @@ * **subnet**: string: A fully qualified URL. * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus) (ReadOnly): Properties describing the software upgrade state of the Cache. -## CacheDirectorySettings +## CacheSecuritySettings ### Properties -* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. -* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. +* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. -## CacheActiveDirectorySettings +## CacheSku ### Properties -* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. -* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. -* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. -* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. -* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. -* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. -* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **name**: string: SKU name for this Cache. -## CacheActiveDirectorySettingsCredentials +## CacheTags ### Properties -* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. -* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +### Additional Properties +* **Additional Properties Type**: string + +## CacheUpgradeStatus +### Properties +* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. +* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. +* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. +* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. +* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. ## CacheUsernameDownloadSettings ### Properties @@ -95,10 +135,14 @@ * **bindDn**: string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. * **bindPassword**: string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. -## CacheEncryptionSettings +## ClfsTarget ### Properties -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. -* **rotationToLatestKeyVersionEnabled**: bool: Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault. +* **target**: string: A fully qualified URL. + +## Condition +### Properties +* **message**: string (ReadOnly): The issue requiring attention. +* **timestamp**: string (ReadOnly): The time when the condition was raised. ## KeyVaultKeyReference ### Properties @@ -109,28 +153,17 @@ ### Properties * **id**: string: Resource Id. -## CacheHealth -### Properties -* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. - -## Condition -### Properties -* **message**: string (ReadOnly): The issue requiring attention. -* **timestamp**: string (ReadOnly): The time when the condition was raised. - -## CacheNetworkSettings +## NamespaceJunction ### Properties -* **dnsSearchDomain**: string: DNS search domain -* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. -* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. -* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. -* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. +* **namespacePath**: string: Namespace path on a Cache for a Storage Target. +* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. +* **nfsExport**: string: NFS export where targetPath exists. +* **targetPath**: string: Path in Storage Target to which namespacePath points. -## CacheSecuritySettings +## Nfs3Target ### Properties -* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. +* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. ## NfsAccessPolicy ### Properties @@ -148,32 +181,6 @@ * **submountAccess**: bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. * **suid**: bool: Allow SUID semantics. -## CacheUpgradeStatus -### Properties -* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. -* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. -* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. -* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. -* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. - -## CacheSku -### Properties -* **name**: string: SKU name for this Cache. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## CacheTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## StorageTargetProperties ### Properties * **blobNfs**: [BlobNfsTarget](#blobnfstarget): Properties pertaining to the BlobNfsTarget. @@ -185,33 +192,26 @@ * **targetType**: 'blobNfs' | 'clfs' | 'nfs3' | 'unknown' | string (Required): Type of the Storage Target. * **unknown**: [UnknownTarget](#unknowntarget): Properties pertaining to the UnknownTarget -## BlobNfsTarget -### Properties -* **target**: string: A fully qualified URL. -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. - -## ClfsTarget -### Properties -* **target**: string: A fully qualified URL. - -## NamespaceJunction +## SystemData ### Properties -* **namespacePath**: string: Namespace path on a Cache for a Storage Target. -* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. -* **nfsExport**: string: NFS export where targetPath exists. -* **targetPath**: string: Path in Storage Target to which namespacePath points. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## Nfs3Target +## UnknownProperties ### Properties -* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. +### Additional Properties +* **Additional Properties Type**: string ## UnknownTarget ### Properties * **attributes**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. -## UnknownProperties +## UserAssignedIdentitiesValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/storagecache/microsoft.storagecache/2022-01-01/types.md b/generated/storagecache/microsoft.storagecache/2022-01-01/types.md index 7209952579..b45b1a9cca 100644 --- a/generated/storagecache/microsoft.storagecache/2022-01-01/types.md +++ b/generated/storagecache/microsoft.storagecache/2022-01-01/types.md @@ -25,6 +25,42 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageCache/caches/storageTargets' (ReadOnly, DeployTimeConstant): The resource type +## BlobNfsTarget +### Properties +* **target**: string: A fully qualified URL. +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. + +## CacheActiveDirectorySettings +### Properties +* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. +* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. +* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. +* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. +* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. +* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. + +## CacheActiveDirectorySettingsCredentials +### Properties +* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. + +## CacheDirectorySettings +### Properties +* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. +* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. + +## CacheEncryptionSettings +### Properties +* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. +* **rotationToLatestKeyVersionEnabled**: bool: Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault. + +## CacheHealth +### Properties +* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. +* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. +* **statusDescription**: string: Describes explanation of state. + ## CacheIdentity ### Properties * **principalId**: string (ReadOnly): The principal ID for the system-assigned identity of the cache. @@ -37,10 +73,13 @@ ### Additional Properties * **Additional Properties Type**: [UserAssignedIdentitiesValue](#userassignedidentitiesvalue) -## UserAssignedIdentitiesValue +## CacheNetworkSettings ### Properties -* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. +* **dnsSearchDomain**: string: DNS search domain +* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. +* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. +* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. +* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. ## CacheProperties ### Properties @@ -56,25 +95,26 @@ * **upgradeStatus**: [CacheUpgradeStatus](#cacheupgradestatus) (ReadOnly): Properties describing the software upgrade state of the Cache. * **zones**: string[]: Availability zones for resources. This field should only contain a single element in the array. -## CacheDirectorySettings +## CacheSecuritySettings ### Properties -* **activeDirectory**: [CacheActiveDirectorySettings](#cacheactivedirectorysettings): Active Directory settings used to join a cache to a domain. -* **usernameDownload**: [CacheUsernameDownloadSettings](#cacheusernamedownloadsettings): Settings for Extended Groups username and group download. +* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. -## CacheActiveDirectorySettings +## CacheSku ### Properties -* **cacheNetBiosName**: string (Required): The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. -* **credentials**: [CacheActiveDirectorySettingsCredentials](#cacheactivedirectorysettingscredentials): Active Directory admin credentials used to join the HPC Cache to a domain. -* **domainJoined**: 'Error' | 'No' | 'Yes' | string (ReadOnly): True if the HPC Cache is joined to the Active Directory domain. -* **domainName**: string (Required): The fully qualified domain name of the Active Directory domain controller. -* **domainNetBiosName**: string (Required): The Active Directory domain's NetBIOS name. -* **primaryDnsIpAddress**: string (Required): Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. -* **secondaryDnsIpAddress**: string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. +* **name**: string: SKU name for this Cache. -## CacheActiveDirectorySettingsCredentials +## CacheTags ### Properties -* **password**: string (Required): Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. -* **username**: string (Required): Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. +### Additional Properties +* **Additional Properties Type**: string + +## CacheUpgradeStatus +### Properties +* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. +* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. +* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. +* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. +* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. ## CacheUsernameDownloadSettings ### Properties @@ -96,10 +136,14 @@ * **bindDn**: string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. * **bindPassword**: string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. -## CacheEncryptionSettings +## ClfsTarget ### Properties -* **keyEncryptionKey**: [KeyVaultKeyReference](#keyvaultkeyreference): Describes a reference to Key Vault Key. -* **rotationToLatestKeyVersionEnabled**: bool: Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault. +* **target**: string: A fully qualified URL. + +## Condition +### Properties +* **message**: string (ReadOnly): The issue requiring attention. +* **timestamp**: string (ReadOnly): The time when the condition was raised. ## KeyVaultKeyReference ### Properties @@ -110,28 +154,17 @@ ### Properties * **id**: string: Resource Id. -## CacheHealth -### Properties -* **conditions**: [Condition](#condition)[] (ReadOnly): Outstanding conditions that need to be investigated and resolved. -* **state**: 'Degraded' | 'Down' | 'Flushing' | 'Healthy' | 'Stopped' | 'Stopping' | 'Transitioning' | 'Unknown' | 'Upgrading' | string: List of Cache health states. -* **statusDescription**: string: Describes explanation of state. - -## Condition -### Properties -* **message**: string (ReadOnly): The issue requiring attention. -* **timestamp**: string (ReadOnly): The time when the condition was raised. - -## CacheNetworkSettings +## NamespaceJunction ### Properties -* **dnsSearchDomain**: string: DNS search domain -* **dnsServers**: string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. -* **mtu**: int: The IPv4 maximum transmission unit configured for the subnet. -* **ntpServer**: string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. -* **utilityAddresses**: string[] (ReadOnly): Array of additional IP addresses used by this Cache. +* **namespacePath**: string: Namespace path on a Cache for a Storage Target. +* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. +* **nfsExport**: string: NFS export where targetPath exists. +* **targetPath**: string: Path in Storage Target to which namespacePath points. -## CacheSecuritySettings +## Nfs3Target ### Properties -* **accessPolicies**: [NfsAccessPolicy](#nfsaccesspolicy)[]: NFS access policies defined for this cache. +* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). +* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. ## NfsAccessPolicy ### Properties @@ -149,32 +182,6 @@ * **submountAccess**: bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. * **suid**: bool: Allow SUID semantics. -## CacheUpgradeStatus -### Properties -* **currentFirmwareVersion**: string (ReadOnly): Version string of the firmware currently installed on this Cache. -* **firmwareUpdateDeadline**: string (ReadOnly): Time at which the pending firmware update will automatically be installed on the Cache. -* **firmwareUpdateStatus**: 'available' | 'unavailable' | string (ReadOnly): True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. -* **lastFirmwareUpdate**: string (ReadOnly): Time of the last successful firmware update. -* **pendingFirmwareVersion**: string (ReadOnly): When firmwareUpdateAvailable is true, this field holds the version string for the update. - -## CacheSku -### Properties -* **name**: string: SKU name for this Cache. - -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## CacheTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## StorageTargetProperties ### Properties * **blobNfs**: [BlobNfsTarget](#blobnfstarget): Properties pertaining to the BlobNfsTarget. @@ -186,33 +193,26 @@ * **targetType**: 'blobNfs' | 'clfs' | 'nfs3' | 'unknown' | string (Required): Type of the Storage Target. * **unknown**: [UnknownTarget](#unknowntarget): Properties pertaining to the UnknownTarget -## BlobNfsTarget -### Properties -* **target**: string: A fully qualified URL. -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. - -## ClfsTarget -### Properties -* **target**: string: A fully qualified URL. - -## NamespaceJunction +## SystemData ### Properties -* **namespacePath**: string: Namespace path on a Cache for a Storage Target. -* **nfsAccessPolicy**: string: Name of the access policy applied to this junction. -* **nfsExport**: string: NFS export where targetPath exists. -* **targetPath**: string: Path in Storage Target to which namespacePath points. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## Nfs3Target +## UnknownProperties ### Properties -* **target**: string: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). -* **usageModel**: string: Identifies the StorageCache usage model to be used for this storage target. +### Additional Properties +* **Additional Properties Type**: string ## UnknownTarget ### Properties * **attributes**: [UnknownProperties](#unknownproperties): Properties of an unknown type of Storage Target. -## UnknownProperties +## UserAssignedIdentitiesValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string (ReadOnly): The client ID of the user-assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the user-assigned identity. diff --git a/generated/storageimportexport/log.out b/generated/storageimportexport/log.out index 6bbfd32db7..b2da2b8cf7 100644 --- a/generated/storageimportexport/log.out +++ b/generated/storageimportexport/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.importexport-2021-01-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storageimportexport/resource-manager/Microsoft.ImportExport/preview/2021-01-01/storageimportexport.json:552:5 @@ -67,7 +67,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 14ms info | Processing batch task - {"tag":"microsoft.importexport-2016-11-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json:552:5 @@ -128,7 +128,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.importexport-2020-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json:552:5 @@ -187,4 +187,4 @@ warning | PreCheck/SchemaMissingType | The schema 'ListOperationsResponse' with warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms -info | Autorest completed in 9.15s. 6 files generated. +info | Autorest completed in 9.04s. 6 files generated. diff --git a/generated/storageimportexport/microsoft.importexport/2016-11-01/types.md b/generated/storageimportexport/microsoft.importexport/2016-11-01/types.md index ed154551e7..f26ca5a140 100644 --- a/generated/storageimportexport/microsoft.importexport/2016-11-01/types.md +++ b/generated/storageimportexport/microsoft.importexport/2016-11-01/types.md @@ -18,33 +18,6 @@ * **ApiVersion**: 2016-11-01 * **Output**: [GetBitLockerKeysResponse](#getbitlockerkeysresponse) -## IdentityDetails -### Properties -* **principalId**: string (ReadOnly): Specifies the principal id for the identity for the job. -* **tenantId**: string (ReadOnly): Specifies the tenant id for the identity for the job. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (ReadOnly): The type of identity - -## JobDetails -### Properties -* **backupDriveManifest**: bool: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. -* **cancelRequested**: bool: Indicates whether a request has been submitted to cancel the job. -* **deliveryPackage**: [DeliveryPackageInformation](#deliverypackageinformation): Contains information about the delivery package being shipped by the customer to the Microsoft data center. -* **diagnosticsPath**: string: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. -* **driveList**: [DriveStatus](#drivestatus)[]: 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. -* **encryptionKey**: [EncryptionKeyDetails](#encryptionkeydetails): Specifies the encryption key properties -* **export**: [Export](#export): 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. -* **incompleteBlobListUri**: 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. -* **jobType**: string: The type of job -* **logLevel**: string: Default value is Error. Indicates whether error logging or verbose logging will be enabled. -* **percentComplete**: int: Overall percentage completed for the job. -* **provisioningState**: string: Specifies the provisioning state of the job. -* **returnAddress**: [ReturnAddress](#returnaddress): Specifies the return address information for the job. -* **returnPackage**: [PackageInfomation](#packageinfomation): Contains information about the package being shipped by the customer to the Microsoft data center. -* **returnShipping**: [ReturnShipping](#returnshipping): Specifies the return carrier and customer's account with the carrier. -* **shippingInformation**: [ShippingInformation](#shippinginformation): Contains information about the Microsoft datacenter to which the drives should be shipped. -* **state**: string: Current state of the job. -* **storageAccountId**: string: The resource identifier of the storage account where data will be imported to or exported from. - ## DeliveryPackageInformation ### Properties * **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. @@ -52,6 +25,11 @@ * **shipDate**: string: The date when the package is shipped. * **trackingNumber**: string (Required): The tracking number of the package. +## DriveBitLockerKey +### Properties +* **bitLockerKey**: string (ReadOnly): BitLocker recovery key or password +* **driveId**: string (ReadOnly): Drive ID + ## DriveStatus ### Properties * **bitLockerKey**: string: The BitLocker key used to encrypt the drive. @@ -83,6 +61,44 @@ * **blobPath**: string[]: A collection of blob-path strings. * **blobPathPrefix**: string[]: A collection of blob-prefix strings. +## GetBitLockerKeysResponse +### Properties +* **value**: [DriveBitLockerKey](#drivebitlockerkey)[] (ReadOnly): drive status + +## IdentityDetails +### Properties +* **principalId**: string (ReadOnly): Specifies the principal id for the identity for the job. +* **tenantId**: string (ReadOnly): Specifies the tenant id for the identity for the job. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (ReadOnly): The type of identity + +## JobDetails +### Properties +* **backupDriveManifest**: bool: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. +* **cancelRequested**: bool: Indicates whether a request has been submitted to cancel the job. +* **deliveryPackage**: [DeliveryPackageInformation](#deliverypackageinformation): Contains information about the delivery package being shipped by the customer to the Microsoft data center. +* **diagnosticsPath**: string: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. +* **driveList**: [DriveStatus](#drivestatus)[]: 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. +* **encryptionKey**: [EncryptionKeyDetails](#encryptionkeydetails): Specifies the encryption key properties +* **export**: [Export](#export): 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. +* **incompleteBlobListUri**: 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. +* **jobType**: string: The type of job +* **logLevel**: string: Default value is Error. Indicates whether error logging or verbose logging will be enabled. +* **percentComplete**: int: Overall percentage completed for the job. +* **provisioningState**: string: Specifies the provisioning state of the job. +* **returnAddress**: [ReturnAddress](#returnaddress): Specifies the return address information for the job. +* **returnPackage**: [PackageInfomation](#packageinfomation): Contains information about the package being shipped by the customer to the Microsoft data center. +* **returnShipping**: [ReturnShipping](#returnshipping): Specifies the return carrier and customer's account with the carrier. +* **shippingInformation**: [ShippingInformation](#shippinginformation): Contains information about the Microsoft datacenter to which the drives should be shipped. +* **state**: string: Current state of the job. +* **storageAccountId**: string: The resource identifier of the storage account where data will be imported to or exported from. + +## PackageInfomation +### Properties +* **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. +* **driveCount**: int (Required): The number of drives included in the package. +* **shipDate**: string (Required): The date when the package is shipped. +* **trackingNumber**: string (Required): The tracking number of the package. + ## ReturnAddress ### Properties * **city**: string (Required): The city name to use when returning the drives. @@ -95,13 +111,6 @@ * **streetAddress1**: string (Required): The first line of the street address to use when returning the drives. * **streetAddress2**: string: The second line of the street address to use when returning the drives. -## PackageInfomation -### Properties -* **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. -* **driveCount**: int (Required): The number of drives included in the package. -* **shipDate**: string (Required): The date when the package is shipped. -* **trackingNumber**: string (Required): The tracking number of the package. - ## ReturnShipping ### Properties * **carrierAccountNumber**: string (Required): The customer's account number with the carrier. @@ -128,12 +137,3 @@ * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## GetBitLockerKeysResponse -### Properties -* **value**: [DriveBitLockerKey](#drivebitlockerkey)[] (ReadOnly): drive status - -## DriveBitLockerKey -### Properties -* **bitLockerKey**: string (ReadOnly): BitLocker recovery key or password -* **driveId**: string (ReadOnly): Drive ID - diff --git a/generated/storageimportexport/microsoft.importexport/2020-08-01/types.md b/generated/storageimportexport/microsoft.importexport/2020-08-01/types.md index 085bcffc02..640166dd1e 100644 --- a/generated/storageimportexport/microsoft.importexport/2020-08-01/types.md +++ b/generated/storageimportexport/microsoft.importexport/2020-08-01/types.md @@ -18,33 +18,6 @@ * **ApiVersion**: 2020-08-01 * **Output**: [GetBitLockerKeysResponse](#getbitlockerkeysresponse) -## IdentityDetails -### Properties -* **principalId**: string (ReadOnly): Specifies the principal id for the identity for the job. -* **tenantId**: string (ReadOnly): Specifies the tenant id for the identity for the job. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (ReadOnly): The type of identity - -## JobDetails -### Properties -* **backupDriveManifest**: bool: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. -* **cancelRequested**: bool: Indicates whether a request has been submitted to cancel the job. -* **deliveryPackage**: [DeliveryPackageInformation](#deliverypackageinformation): Contains information about the delivery package being shipped by the customer to the Microsoft data center. -* **diagnosticsPath**: string: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. -* **driveList**: [DriveStatus](#drivestatus)[]: 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. -* **encryptionKey**: [EncryptionKeyDetails](#encryptionkeydetails): Specifies the encryption key properties -* **export**: [Export](#export): 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. -* **incompleteBlobListUri**: 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. -* **jobType**: string: The type of job -* **logLevel**: string: Default value is Error. Indicates whether error logging or verbose logging will be enabled. -* **percentComplete**: int: Overall percentage completed for the job. -* **provisioningState**: string: Specifies the provisioning state of the job. -* **returnAddress**: [ReturnAddress](#returnaddress): Specifies the return address information for the job. -* **returnPackage**: [PackageInformation](#packageinformation): Contains information about the package being shipped by the customer to the Microsoft data center. -* **returnShipping**: [ReturnShipping](#returnshipping): Specifies the return carrier and customer's account with the carrier. -* **shippingInformation**: [ShippingInformation](#shippinginformation): Contains information about the Microsoft datacenter to which the drives should be shipped. -* **state**: string: Current state of the job. -* **storageAccountId**: string: The resource identifier of the storage account where data will be imported to or exported from. - ## DeliveryPackageInformation ### Properties * **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. @@ -52,6 +25,11 @@ * **shipDate**: string: The date when the package is shipped. * **trackingNumber**: string (Required): The tracking number of the package. +## DriveBitLockerKey +### Properties +* **bitLockerKey**: string (ReadOnly): BitLocker recovery key or password +* **driveId**: string (ReadOnly): Drive ID + ## DriveStatus ### Properties * **bitLockerKey**: string: The BitLocker key used to encrypt the drive. @@ -83,6 +61,44 @@ * **blobPath**: string[]: A collection of blob-path strings. * **blobPathPrefix**: string[]: A collection of blob-prefix strings. +## GetBitLockerKeysResponse +### Properties +* **value**: [DriveBitLockerKey](#drivebitlockerkey)[] (ReadOnly): drive status + +## IdentityDetails +### Properties +* **principalId**: string (ReadOnly): Specifies the principal id for the identity for the job. +* **tenantId**: string (ReadOnly): Specifies the tenant id for the identity for the job. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (ReadOnly): The type of identity + +## JobDetails +### Properties +* **backupDriveManifest**: bool: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. +* **cancelRequested**: bool: Indicates whether a request has been submitted to cancel the job. +* **deliveryPackage**: [DeliveryPackageInformation](#deliverypackageinformation): Contains information about the delivery package being shipped by the customer to the Microsoft data center. +* **diagnosticsPath**: string: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. +* **driveList**: [DriveStatus](#drivestatus)[]: 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. +* **encryptionKey**: [EncryptionKeyDetails](#encryptionkeydetails): Specifies the encryption key properties +* **export**: [Export](#export): 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. +* **incompleteBlobListUri**: 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. +* **jobType**: string: The type of job +* **logLevel**: string: Default value is Error. Indicates whether error logging or verbose logging will be enabled. +* **percentComplete**: int: Overall percentage completed for the job. +* **provisioningState**: string: Specifies the provisioning state of the job. +* **returnAddress**: [ReturnAddress](#returnaddress): Specifies the return address information for the job. +* **returnPackage**: [PackageInformation](#packageinformation): Contains information about the package being shipped by the customer to the Microsoft data center. +* **returnShipping**: [ReturnShipping](#returnshipping): Specifies the return carrier and customer's account with the carrier. +* **shippingInformation**: [ShippingInformation](#shippinginformation): Contains information about the Microsoft datacenter to which the drives should be shipped. +* **state**: string: Current state of the job. +* **storageAccountId**: string: The resource identifier of the storage account where data will be imported to or exported from. + +## PackageInformation +### Properties +* **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. +* **driveCount**: int (Required): The number of drives included in the package. +* **shipDate**: string (Required): The date when the package is shipped. +* **trackingNumber**: string (Required): The tracking number of the package. + ## ReturnAddress ### Properties * **city**: string (Required): The city name to use when returning the drives. @@ -95,13 +111,6 @@ * **streetAddress1**: string (Required): The first line of the street address to use when returning the drives. * **streetAddress2**: string: The second line of the street address to use when returning the drives. -## PackageInformation -### Properties -* **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. -* **driveCount**: int (Required): The number of drives included in the package. -* **shipDate**: string (Required): The date when the package is shipped. -* **trackingNumber**: string (Required): The tracking number of the package. - ## ReturnShipping ### Properties * **carrierAccountNumber**: string (Required): The customer's account number with the carrier. @@ -128,12 +137,3 @@ * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## GetBitLockerKeysResponse -### Properties -* **value**: [DriveBitLockerKey](#drivebitlockerkey)[] (ReadOnly): drive status - -## DriveBitLockerKey -### Properties -* **bitLockerKey**: string (ReadOnly): BitLocker recovery key or password -* **driveId**: string (ReadOnly): Drive ID - diff --git a/generated/storageimportexport/microsoft.importexport/2021-01-01/types.md b/generated/storageimportexport/microsoft.importexport/2021-01-01/types.md index 6eaada1ac5..bc3324e0c2 100644 --- a/generated/storageimportexport/microsoft.importexport/2021-01-01/types.md +++ b/generated/storageimportexport/microsoft.importexport/2021-01-01/types.md @@ -18,33 +18,6 @@ * **ApiVersion**: 2021-01-01 * **Output**: [GetBitLockerKeysResponse](#getbitlockerkeysresponse) -## IdentityDetails -### Properties -* **principalId**: string (ReadOnly): Specifies the principal id for the identity for the job. -* **tenantId**: string (ReadOnly): Specifies the tenant id for the identity for the job. -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (ReadOnly): The type of identity - -## JobDetails -### Properties -* **backupDriveManifest**: bool: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. -* **cancelRequested**: bool: Indicates whether a request has been submitted to cancel the job. -* **deliveryPackage**: [DeliveryPackageInformation](#deliverypackageinformation): Contains information about the delivery package being shipped by the customer to the Microsoft data center. -* **diagnosticsPath**: string: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. -* **driveList**: [DriveStatus](#drivestatus)[]: 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. -* **encryptionKey**: [EncryptionKeyDetails](#encryptionkeydetails): Specifies the encryption key properties -* **export**: [Export](#export): 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. -* **incompleteBlobListUri**: 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. -* **jobType**: string: The type of job -* **logLevel**: string: Default value is Error. Indicates whether error logging or verbose logging will be enabled. -* **percentComplete**: int: Overall percentage completed for the job. -* **provisioningState**: string: Specifies the provisioning state of the job. -* **returnAddress**: [ReturnAddress](#returnaddress): Specifies the return address information for the job. -* **returnPackage**: [PackageInformation](#packageinformation): Contains information about the package being shipped by the customer to the Microsoft data center. -* **returnShipping**: [ReturnShipping](#returnshipping): Specifies the return carrier and customer's account with the carrier. -* **shippingInformation**: [ShippingInformation](#shippinginformation): Contains information about the Microsoft datacenter to which the drives should be shipped. -* **state**: string: Current state of the job. -* **storageAccountId**: string: The resource identifier of the storage account where data will be imported to or exported from. - ## DeliveryPackageInformation ### Properties * **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. @@ -52,6 +25,11 @@ * **shipDate**: string: The date when the package is shipped. * **trackingNumber**: string (Required): The tracking number of the package. +## DriveBitLockerKey +### Properties +* **bitLockerKey**: string (ReadOnly): BitLocker recovery key or password +* **driveId**: string (ReadOnly): Drive ID + ## DriveStatus ### Properties * **bitLockerKey**: string: The BitLocker key used to encrypt the drive. @@ -83,6 +61,44 @@ * **blobPath**: string[]: A collection of blob-path strings. * **blobPathPrefix**: string[]: A collection of blob-prefix strings. +## GetBitLockerKeysResponse +### Properties +* **value**: [DriveBitLockerKey](#drivebitlockerkey)[] (ReadOnly): drive status + +## IdentityDetails +### Properties +* **principalId**: string (ReadOnly): Specifies the principal id for the identity for the job. +* **tenantId**: string (ReadOnly): Specifies the tenant id for the identity for the job. +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string (ReadOnly): The type of identity + +## JobDetails +### Properties +* **backupDriveManifest**: bool: Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. +* **cancelRequested**: bool: Indicates whether a request has been submitted to cancel the job. +* **deliveryPackage**: [DeliveryPackageInformation](#deliverypackageinformation): Contains information about the delivery package being shipped by the customer to the Microsoft data center. +* **diagnosticsPath**: string: The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. +* **driveList**: [DriveStatus](#drivestatus)[]: 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. +* **encryptionKey**: [EncryptionKeyDetails](#encryptionkeydetails): Specifies the encryption key properties +* **export**: [Export](#export): 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. +* **incompleteBlobListUri**: 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. +* **jobType**: string: The type of job +* **logLevel**: string: Default value is Error. Indicates whether error logging or verbose logging will be enabled. +* **percentComplete**: int: Overall percentage completed for the job. +* **provisioningState**: string: Specifies the provisioning state of the job. +* **returnAddress**: [ReturnAddress](#returnaddress): Specifies the return address information for the job. +* **returnPackage**: [PackageInformation](#packageinformation): Contains information about the package being shipped by the customer to the Microsoft data center. +* **returnShipping**: [ReturnShipping](#returnshipping): Specifies the return carrier and customer's account with the carrier. +* **shippingInformation**: [ShippingInformation](#shippinginformation): Contains information about the Microsoft datacenter to which the drives should be shipped. +* **state**: string: Current state of the job. +* **storageAccountId**: string: The resource identifier of the storage account where data will be imported to or exported from. + +## PackageInformation +### Properties +* **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. +* **driveCount**: int (Required): The number of drives included in the package. +* **shipDate**: string (Required): The date when the package is shipped. +* **trackingNumber**: string (Required): The tracking number of the package. + ## ReturnAddress ### Properties * **city**: string (Required): The city name to use when returning the drives. @@ -95,13 +111,6 @@ * **streetAddress1**: string (Required): The first line of the street address to use when returning the drives. * **streetAddress2**: string: The second line of the street address to use when returning the drives. -## PackageInformation -### Properties -* **carrierName**: string (Required): The name of the carrier that is used to ship the import or export drives. -* **driveCount**: int (Required): The number of drives included in the package. -* **shipDate**: string (Required): The date when the package is shipped. -* **trackingNumber**: string (Required): The tracking number of the package. - ## ReturnShipping ### Properties * **carrierAccountNumber**: string (Required): The customer's account number with the carrier. @@ -128,12 +137,3 @@ * **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -## GetBitLockerKeysResponse -### Properties -* **value**: [DriveBitLockerKey](#drivebitlockerkey)[] (ReadOnly): drive status - -## DriveBitLockerKey -### Properties -* **bitLockerKey**: string (ReadOnly): BitLocker recovery key or password -* **driveId**: string (ReadOnly): Drive ID - diff --git a/generated/storagepool/log.out b/generated/storagepool/log.out index dd1db72fb6..f5abc64431 100644 --- a/generated/storagepool/log.out +++ b/generated/storagepool/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.storagepool-2021-08-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DiskPoolZoneListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagepool/resource-manager/Microsoft.StoragePool/stable/2021-08-01/storagepool.json:1358:5 @@ -24,7 +24,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 16ms info | Processing batch task - {"tag":"microsoft.storagepool-2021-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DiskPoolZoneListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagepool/resource-manager/Microsoft.StoragePool/preview/2021-04-01-preview/storagepool.json:1073:5 @@ -42,7 +42,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagepool-2020-03-15-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TrackedResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagepool/resource-manager/Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json:1514:5 @@ -55,5 +55,5 @@ warning | PreCheck/SchemaMissingType | The schema 'ErrorAdditionalInfo' with an warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagepool/resource-manager/Microsoft.StoragePool/preview/2020-03-15-preview/storagepool.json:1591:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 9.37s. 6 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 9.01s. 6 files generated. diff --git a/generated/storagepool/microsoft.storagepool/2020-03-15-preview/types.md b/generated/storagepool/microsoft.storagepool/2020-03-15-preview/types.md index 4cac95bc08..5948ba5d29 100644 --- a/generated/storagepool/microsoft.storagepool/2020-03-15-preview/types.md +++ b/generated/storagepool/microsoft.storagepool/2020-03-15-preview/types.md @@ -21,6 +21,21 @@ * **properties**: [IscsiTargetCreateProperties](#iscsitargetcreateproperties) (Required): Properties for iSCSI target create or update request. * **type**: 'Microsoft.StoragePool/diskPools/iscsiTargets' (ReadOnly, DeployTimeConstant): The resource type +## Acl +### Properties +* **credentials**: [IscsiTargetCredentials](#iscsitargetcredentials) (WriteOnly): Challenge Handshake Authentication Protocol (CHAP) credentials for an iSCSI target ACL. +* **initiatorIqn**: string (Required): iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". +* **mappedLuns**: string[] (Required): List of LUN names mapped to the ACL. + +## Attributes +### Properties +* **authentication**: bool (Required): Indicates whether or not authentication is enabled on the ACL. +* **prodModeWriteProtect**: bool (Required): Indicates whether or not write protect is enabled on the LUNs. + +## Disk +### Properties +* **id**: string (Required): Unique Azure Resource ID of the Managed Disk. + ## DiskPoolCreateProperties ### Properties * **additionalCapabilities**: string[]: List of additional capabilities for a Disk pool. @@ -31,24 +46,16 @@ * **subnetId**: string (Required): Azure Resource ID of a Subnet for the Disk pool. * **tier**: 'Basic' | 'Premium' | 'Standard' | string (Required): SKU of the VM host part of the Disk pool deployment -## Disk -### Properties -* **id**: string (Required): Unique Azure Resource ID of the Managed Disk. - -## SystemMetadata -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): A string identifier for the identity that created the resource. -* **createdByType**: string (ReadOnly): The type of identity that created the resource: user, application, managedIdentity. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC). -* **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource. -* **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity. - ## DiskPoolCreateTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## IscsiLun +### Properties +* **managedDiskAzureResourceId**: string (Required): Azure Resource ID of the Managed Disk. +* **name**: string (Required): User defined name for iSCSI LUN; example: "lun0" + ## IscsiTargetCreateProperties ### Properties * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Invalid' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): Provisioning state of the iSCSI target. @@ -56,33 +63,26 @@ * **targetIqn**: string: iSCSI target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". * **tpgs**: [TargetPortalGroupCreate](#targetportalgroupcreate)[] (Required): List of iSCSI target portal groups. Can have 1 portal group at most. -## TargetPortalGroupCreate -### Properties -* **acls**: [Acl](#acl)[] (Required): Access Control List (ACL) for an iSCSI target portal group. -* **attributes**: [Attributes](#attributes) (Required): Attributes of a iSCSI target portal group. -* **endpoints**: string[] (ReadOnly): List of private IPv4 addresses to connect to the iSCSI target. -* **luns**: [IscsiLun](#iscsilun)[] (Required): List of LUNs to be exposed through the iSCSI target portal group. -* **port**: int (ReadOnly): The port used by iSCSI target portal group. -* **tag**: int (ReadOnly): The tag associated with the iSCSI target portal group. - -## Acl -### Properties -* **credentials**: [IscsiTargetCredentials](#iscsitargetcredentials) (WriteOnly): Challenge Handshake Authentication Protocol (CHAP) credentials for an iSCSI target ACL. -* **initiatorIqn**: string (Required): iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". -* **mappedLuns**: string[] (Required): List of LUN names mapped to the ACL. - ## IscsiTargetCredentials ### Properties * **password**: string (Required): Password for Challenge Handshake Authentication Protocol (CHAP) authentication. * **username**: string (Required): Username for Challenge Handshake Authentication Protocol (CHAP) authentication. -## Attributes +## SystemMetadata ### Properties -* **authentication**: bool (Required): Indicates whether or not authentication is enabled on the ACL. -* **prodModeWriteProtect**: bool (Required): Indicates whether or not write protect is enabled on the LUNs. +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): A string identifier for the identity that created the resource. +* **createdByType**: string (ReadOnly): The type of identity that created the resource: user, application, managedIdentity. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC). +* **lastModifiedBy**: string (ReadOnly): A string identifier for the identity that last modified the resource. +* **lastModifiedByType**: string (ReadOnly): The type of identity that last modified the resource: user, application, managedIdentity. -## IscsiLun +## TargetPortalGroupCreate ### Properties -* **managedDiskAzureResourceId**: string (Required): Azure Resource ID of the Managed Disk. -* **name**: string (Required): User defined name for iSCSI LUN; example: "lun0" +* **acls**: [Acl](#acl)[] (Required): Access Control List (ACL) for an iSCSI target portal group. +* **attributes**: [Attributes](#attributes) (Required): Attributes of a iSCSI target portal group. +* **endpoints**: string[] (ReadOnly): List of private IPv4 addresses to connect to the iSCSI target. +* **luns**: [IscsiLun](#iscsilun)[] (Required): List of LUNs to be exposed through the iSCSI target portal group. +* **port**: int (ReadOnly): The port used by iSCSI target portal group. +* **tag**: int (ReadOnly): The tag associated with the iSCSI target portal group. diff --git a/generated/storagepool/microsoft.storagepool/2021-04-01-preview/types.md b/generated/storagepool/microsoft.storagepool/2021-04-01-preview/types.md index e8bb97b490..6610d7eed3 100644 --- a/generated/storagepool/microsoft.storagepool/2021-04-01-preview/types.md +++ b/generated/storagepool/microsoft.storagepool/2021-04-01-preview/types.md @@ -23,6 +23,15 @@ * **systemData**: [SystemMetadata](#systemmetadata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StoragePool/diskPools/iscsiTargets' (ReadOnly, DeployTimeConstant): The resource type +## Acl +### Properties +* **initiatorIqn**: string (Required): iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". +* **mappedLuns**: string[] (Required): List of LUN names mapped to the ACL. + +## Disk +### Properties +* **id**: string (Required): Unique Azure Resource ID of the Managed Disk. + ## DiskPoolCreateProperties ### Properties * **additionalCapabilities**: string[]: List of additional capabilities for a Disk Pool. @@ -32,29 +41,17 @@ * **status**: 'Healthy' | 'Invalid' | 'Running' | 'Stopped (deallocated)' | 'Stopped' | 'Unhealthy' | 'Unknown' | 'Updating' | string (ReadOnly): Operational status of the resource. * **subnetId**: string (Required): Azure Resource ID of a Subnet for the Disk Pool. -## Disk -### Properties -* **id**: string (Required): Unique Azure Resource ID of the Managed Disk. - -## Sku -### Properties -* **name**: string (Required): Sku name -* **tier**: string: Sku tier - -## SystemMetadata -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The type of identity that last modified the resource. -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - ## DiskPoolCreateTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## IscsiLun +### Properties +* **lun**: int (ReadOnly): Specifies the Logical Unit Number of the iSCSI LUN. +* **managedDiskAzureResourceId**: string (Required): Azure Resource ID of the Managed Disk. +* **name**: string (Required): User defined name for iSCSI LUN; example: "lun0" + ## IscsiTargetCreateProperties ### Properties * **aclMode**: 'Dynamic' | 'Static' | string (Required): ACL mode for iSCSI Target. @@ -66,14 +63,17 @@ * **status**: 'Healthy' | 'Invalid' | 'Running' | 'Stopped (deallocated)' | 'Stopped' | 'Unhealthy' | 'Unknown' | 'Updating' | string (ReadOnly): Operational status of the resource. * **targetIqn**: string: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". -## IscsiLun +## Sku ### Properties -* **lun**: int (ReadOnly): Specifies the Logical Unit Number of the iSCSI LUN. -* **managedDiskAzureResourceId**: string (Required): Azure Resource ID of the Managed Disk. -* **name**: string (Required): User defined name for iSCSI LUN; example: "lun0" +* **name**: string (Required): Sku name +* **tier**: string: Sku tier -## Acl +## SystemMetadata ### Properties -* **initiatorIqn**: string (Required): iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". -* **mappedLuns**: string[] (Required): List of LUN names mapped to the ACL. +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The type of identity that last modified the resource. +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. diff --git a/generated/storagepool/microsoft.storagepool/2021-08-01/types.md b/generated/storagepool/microsoft.storagepool/2021-08-01/types.md index 83060e550e..04ca599c65 100644 --- a/generated/storagepool/microsoft.storagepool/2021-08-01/types.md +++ b/generated/storagepool/microsoft.storagepool/2021-08-01/types.md @@ -27,6 +27,15 @@ * **systemData**: [SystemMetadata](#systemmetadata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StoragePool/diskPools/iscsiTargets' (ReadOnly, DeployTimeConstant): The resource type +## Acl +### Properties +* **initiatorIqn**: string (Required): iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". +* **mappedLuns**: string[] (Required): List of LUN names mapped to the ACL. + +## Disk +### Properties +* **id**: string (Required): Unique Azure Resource ID of the Managed Disk. + ## DiskPoolCreateProperties ### Properties * **additionalCapabilities**: string[]: List of additional capabilities for a Disk Pool. @@ -36,29 +45,17 @@ * **status**: 'Healthy' | 'Invalid' | 'Running' | 'Stopped (deallocated)' | 'Stopped' | 'Unhealthy' | 'Unknown' | 'Updating' | string (ReadOnly): Operational status of the resource. * **subnetId**: string (Required): Azure Resource ID of a Subnet for the Disk Pool. -## Disk -### Properties -* **id**: string (Required): Unique Azure Resource ID of the Managed Disk. - -## Sku -### Properties -* **name**: string (Required): Sku name -* **tier**: string: Sku tier - -## SystemMetadata -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The type of identity that last modified the resource. -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - ## DiskPoolCreateTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## IscsiLun +### Properties +* **lun**: int (ReadOnly): Specifies the Logical Unit Number of the iSCSI LUN. +* **managedDiskAzureResourceId**: string (Required): Azure Resource ID of the Managed Disk. +* **name**: string (Required): User defined name for iSCSI LUN; example: "lun0" + ## IscsiTargetCreateProperties ### Properties * **aclMode**: 'Dynamic' | 'Static' | string (Required): ACL mode for iSCSI Target. @@ -71,14 +68,17 @@ * **status**: 'Healthy' | 'Invalid' | 'Running' | 'Stopped (deallocated)' | 'Stopped' | 'Unhealthy' | 'Unknown' | 'Updating' | string (ReadOnly): Operational status of the resource. * **targetIqn**: string: iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". -## IscsiLun +## Sku ### Properties -* **lun**: int (ReadOnly): Specifies the Logical Unit Number of the iSCSI LUN. -* **managedDiskAzureResourceId**: string (Required): Azure Resource ID of the Managed Disk. -* **name**: string (Required): User defined name for iSCSI LUN; example: "lun0" +* **name**: string (Required): Sku name +* **tier**: string: Sku tier -## Acl +## SystemMetadata ### Properties -* **initiatorIqn**: string (Required): iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". -* **mappedLuns**: string[] (Required): List of LUN names mapped to the ACL. +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The type of identity that last modified the resource. +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. diff --git a/generated/storagesync/log.out b/generated/storagesync/log.out index a7194810aa..405523ee10 100644 --- a/generated/storagesync/log.out +++ b/generated/storagesync/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.storagesync-2020-09-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TriggerChangeDetectionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/storagesync.json:3316:5 @@ -32,10 +32,10 @@ warning | PreCheck/SchemaMissingType | The schema 'StorageSyncServiceUpdateParam - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/storagesync.json:4115:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 18ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.storagesync-2020-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TriggerChangeDetectionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json:3316:5 @@ -61,10 +61,10 @@ warning | PreCheck/SchemaMissingType | The schema 'StorageSyncServiceUpdateParam - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json:4095:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.storagesync-2019-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TriggerChangeDetectionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-10-01/storagesync.json:2845:5 @@ -90,10 +90,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'StorageSyncServiceCreateParameters-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-10-01/storagesync.json#/components/schemas/StorageSyncServiceCreateParameters-properties warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 10ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.storagesync-2019-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TriggerChangeDetectionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-06-01/storagesync.json:2845:5 @@ -119,10 +119,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'StorageSyncServiceCreateParameters-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-06-01/storagesync.json#/components/schemas/StorageSyncServiceCreateParameters-properties warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 5ms info | Processing batch task - {"tag":"microsoft.storagesync-2019-03-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'TriggerChangeDetectionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-03-01/storagesync.json:2845:5 @@ -148,10 +148,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'StorageSyncServiceCreateParameters-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-03-01/storagesync.json#/components/schemas/StorageSyncServiceCreateParameters-properties warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.storagesync-2019-02-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RecallActionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-02-01/storagesync.json:2689:5 @@ -175,10 +175,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'StorageSyncServiceCreateParameters-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-02-01/storagesync.json#/components/schemas/StorageSyncServiceCreateParameters-properties warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagesync-2018-10-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RecallActionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-10-01/storagesync.json:2689:5 @@ -202,10 +202,10 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Modeler/MissingType | The schema 'StorageSyncServiceCreateParameters-properties' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-10-01/storagesync.json#/components/schemas/StorageSyncServiceCreateParameters-properties warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagesync-2018-07-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RecallActionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json:2689:5 @@ -230,10 +230,10 @@ warning | Modeler/MissingType | The schema 'StorageSyncServiceCreateParameters-p file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json#/components/schemas/StorageSyncServiceCreateParameters-properties warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagesync-2018-04-02"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'RecallActionParameters' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json:2542:5 @@ -267,11 +267,11 @@ warning | Unrecognized property type: any-object. Returning 'any'. info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.storagesync-2017-06-05-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json:2387:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 3ms -info | Autorest completed in 39.22s. 20 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 37.81s. 20 files generated. diff --git a/generated/storagesync/microsoft.storagesync/2017-06-05-preview/types.md b/generated/storagesync/microsoft.storagesync/2017-06-05-preview/types.md index c6224c11ce..0d6cf3dc43 100644 --- a/generated/storagesync/microsoft.storagesync/2017-06-05-preview/types.md +++ b/generated/storagesync/microsoft.storagesync/2017-06-05-preview/types.md @@ -47,10 +47,18 @@ * **properties**: [ServerEndpointProperties](#serverendpointproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceProperties +## CloudEndpointProperties ### Properties -* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. -* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid +* **backupEnabled**: bool (ReadOnly): Backup Enabled +* **friendlyName**: string: Friendly Name +* **lastWorkflowId**: string: CloudEndpoint lastWorkflowId +* **partnershipId**: string: Partnership Id +* **provisioningState**: string: CloudEndpoint Provisioning State +* **storageAccount**: string: Storage Account name. +* **storageAccountKey**: string: Storage Account access key. +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountShareName**: string: Storage Account Share name +* **storageAccountTenantId**: string: Storage Account Tenant Id ## RegisteredServerProperties ### Properties @@ -67,24 +75,6 @@ * **serverRole**: string: Registered Server serverRole * **storageSyncServiceUid**: string: Registered Server storageSyncServiceUid -## SyncGroupProperties -### Properties -* **syncGroupStatus**: string (ReadOnly): Sync group status -* **uniqueId**: string: Unique Id - -## CloudEndpointProperties -### Properties -* **backupEnabled**: bool (ReadOnly): Backup Enabled -* **friendlyName**: string: Friendly Name -* **lastWorkflowId**: string: CloudEndpoint lastWorkflowId -* **partnershipId**: string: Partnership Id -* **provisioningState**: string: CloudEndpoint Provisioning State -* **storageAccount**: string: Storage Account name. -* **storageAccountKey**: string: Storage Account access key. -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountShareName**: string: Storage Account Share name -* **storageAccountTenantId**: string: Storage Account Tenant Id - ## ServerEndpointProperties ### Properties * **byteProgress**: int: Bytes in progress @@ -108,3 +98,13 @@ * **totalProgress**: int: Total progress * **volumeFreeSpacePercent**: int: Level of free space to be maintained by Cloud Tiering if it is enabled. +## StorageSyncServiceProperties +### Properties +* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. +* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid + +## SyncGroupProperties +### Properties +* **syncGroupStatus**: string (ReadOnly): Sync group status +* **uniqueId**: string: Unique Id + diff --git a/generated/storagesync/microsoft.storagesync/2018-04-02/types.md b/generated/storagesync/microsoft.storagesync/2018-04-02/types.md index 4de80420a4..982f59abbd 100644 --- a/generated/storagesync/microsoft.storagesync/2018-04-02/types.md +++ b/generated/storagesync/microsoft.storagesync/2018-04-02/types.md @@ -55,12 +55,19 @@ * **tags**: [ServerEndpointCreateParametersTags](#serverendpointcreateparameterstags) (WriteOnly): 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. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceProperties +## CloudEndpointCreateParametersProperties ### Properties -* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. -* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid +* **backupEnabled**: bool (ReadOnly): Backup Enabled +* **friendlyName**: string (ReadOnly): Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountShareName**: string: Storage Account Share name +* **storageAccountTenantId**: string: Storage Account Tenant Id -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -91,28 +98,6 @@ ### Additional Properties * **Additional Properties Type**: string -## SyncGroupCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## CloudEndpointCreateParametersProperties -### Properties -* **backupEnabled**: bool (ReadOnly): Backup Enabled -* **friendlyName**: string (ReadOnly): Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountShareName**: string: Storage Account Share name -* **storageAccountTenantId**: string: Storage Account Tenant Id - -## CloudEndpointCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ServerEndpointCreateParametersProperties ### Properties * **cloudTiering**: 'off' | 'on' | string: Type of the Feature Status @@ -130,3 +115,18 @@ ### Additional Properties * **Additional Properties Type**: string +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StorageSyncServiceProperties +### Properties +* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. +* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid + +## SyncGroupCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/storagesync/microsoft.storagesync/2018-07-01/types.md b/generated/storagesync/microsoft.storagesync/2018-07-01/types.md index 7bd0ef0fcd..3421056064 100644 --- a/generated/storagesync/microsoft.storagesync/2018-07-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2018-07-01/types.md @@ -47,10 +47,17 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupEnabled**: bool (ReadOnly): Backup Enabled +* **friendlyName**: string (ReadOnly): Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountShareName**: string: Storage Account Share name +* **storageAccountTenantId**: string: Storage Account Tenant Id ## RegisteredServerCreateParametersProperties ### Properties @@ -74,18 +81,6 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties -### Properties -* **backupEnabled**: bool (ReadOnly): Backup Enabled -* **friendlyName**: string (ReadOnly): Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountShareName**: string: Storage Account Share name -* **storageAccountTenantId**: string: Storage Account Tenant Id - ## ServerEndpointCreateParametersProperties ### Properties * **cloudTiering**: 'off' | 'on' | string: Type of the Feature Status @@ -99,3 +94,8 @@ * **tierFilesOlderThanDays**: int: Tier files older than days. * **volumeFreeSpacePercent**: int: Level of free space to be maintained by Cloud Tiering if it is enabled. +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + diff --git a/generated/storagesync/microsoft.storagesync/2018-10-01/types.md b/generated/storagesync/microsoft.storagesync/2018-10-01/types.md index f43a80333a..609135b3b5 100644 --- a/generated/storagesync/microsoft.storagesync/2018-10-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2018-10-01/types.md @@ -47,10 +47,17 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **friendlyName**: string (ReadOnly): Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountShareName**: string: Storage Account Share name +* **storageAccountTenantId**: string: Storage Account Tenant Id ## RegisteredServerCreateParametersProperties ### Properties @@ -74,18 +81,6 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties -### Properties -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **friendlyName**: string (ReadOnly): Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountShareName**: string: Storage Account Share name -* **storageAccountTenantId**: string: Storage Account Tenant Id - ## ServerEndpointCreateParametersProperties ### Properties * **cloudTiering**: 'off' | 'on' | string: Type of the Feature Status @@ -114,6 +109,11 @@ * **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the Health state * **uploadStatus**: [SyncSessionStatus](#syncsessionstatus) (ReadOnly): Sync Session status object. +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SyncProgressStatus ### Properties * **appliedBytes**: int (ReadOnly): Applied bytes diff --git a/generated/storagesync/microsoft.storagesync/2019-02-01/types.md b/generated/storagesync/microsoft.storagesync/2019-02-01/types.md index 5b1a99778c..bada242a62 100644 --- a/generated/storagesync/microsoft.storagesync/2019-02-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2019-02-01/types.md @@ -47,10 +47,23 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFileShareName**: string: Azure file share name +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **friendlyName**: string (ReadOnly): Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountTenantId**: string: Storage Account Tenant Id + +## FilesNotSyncingError +### Properties +* **errorCode**: int (ReadOnly): Error code (HResult) +* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code +* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code ## RegisteredServerCreateParametersProperties ### Properties @@ -74,18 +87,6 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties -### Properties -* **azureFileShareName**: string: Azure file share name -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **friendlyName**: string (ReadOnly): Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountTenantId**: string: Storage Account Tenant Id - ## ServerEndpointCreateParametersProperties ### Properties * **cloudTiering**: 'off' | 'on' | string: Type of the Feature Status @@ -117,6 +118,11 @@ * **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the Health state * **uploadStatus**: [SyncSessionStatus](#syncsessionstatus) (ReadOnly): Sync Session status object. +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SyncActivityStatus ### Properties * **appliedBytes**: int (ReadOnly): Applied bytes @@ -136,9 +142,3 @@ * **persistentFilesNotSyncingCount**: int (ReadOnly): Count of persistent files not syncing. Reserved for future use. * **transientFilesNotSyncingCount**: int (ReadOnly): Count of transient files not syncing. Reserved for future use. -## FilesNotSyncingError -### Properties -* **errorCode**: int (ReadOnly): Error code (HResult) -* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code -* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code - diff --git a/generated/storagesync/microsoft.storagesync/2019-03-01/types.md b/generated/storagesync/microsoft.storagesync/2019-03-01/types.md index 5c52497cdf..a11fc3129b 100644 --- a/generated/storagesync/microsoft.storagesync/2019-03-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2019-03-01/types.md @@ -47,10 +47,23 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFileShareName**: string: Azure file share name +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **friendlyName**: string: Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountTenantId**: string: Storage Account Tenant Id + +## FilesNotSyncingError +### Properties +* **errorCode**: int (ReadOnly): Error code (HResult) +* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code +* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code ## RegisteredServerCreateParametersProperties ### Properties @@ -74,18 +87,6 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties -### Properties -* **azureFileShareName**: string: Azure file share name -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **friendlyName**: string: Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountTenantId**: string: Storage Account Tenant Id - ## ServerEndpointCreateParametersProperties ### Properties * **cloudTiering**: 'off' | 'on' | string: Type of the Feature Status @@ -117,6 +118,11 @@ * **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the Health state * **uploadStatus**: [SyncSessionStatus](#syncsessionstatus) (ReadOnly): Sync Session status object. +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SyncActivityStatus ### Properties * **appliedBytes**: int (ReadOnly): Applied bytes @@ -136,9 +142,3 @@ * **persistentFilesNotSyncingCount**: int (ReadOnly): Count of persistent files not syncing. Reserved for future use. * **transientFilesNotSyncingCount**: int (ReadOnly): Count of transient files not syncing. Reserved for future use. -## FilesNotSyncingError -### Properties -* **errorCode**: int (ReadOnly): Error code (HResult) -* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code -* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code - diff --git a/generated/storagesync/microsoft.storagesync/2019-06-01/types.md b/generated/storagesync/microsoft.storagesync/2019-06-01/types.md index 81be36a633..e18778d827 100644 --- a/generated/storagesync/microsoft.storagesync/2019-06-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2019-06-01/types.md @@ -47,10 +47,17 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFileShareName**: string: Azure file share name +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **friendlyName**: string: Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountTenantId**: string: Storage Account Tenant Id ## RegisteredServerCreateParametersProperties ### Properties @@ -74,17 +81,12 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties +## ServerEndpointCloudTieringStatus ### Properties -* **azureFileShareName**: string: Azure file share name -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **friendlyName**: string: Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountTenantId**: string: Storage Account Tenant Id +* **health**: 'Error' | 'Healthy' | string (ReadOnly): Type of the cloud tiering health state +* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) +* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp ## ServerEndpointCreateParametersProperties ### Properties @@ -105,37 +107,22 @@ * **tierFilesOlderThanDays**: int: Tier files older than days. * **volumeFreeSpacePercent**: int: Level of free space to be maintained by Cloud Tiering if it is enabled. -## ServerEndpointCloudTieringStatus -### Properties -* **health**: 'Error' | 'Healthy' | string (ReadOnly): Type of the cloud tiering health state -* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) -* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp - -## ServerEndpointRecallStatus +## ServerEndpointFilesNotSyncingError ### Properties -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **recallErrors**: [ServerEndpointRecallError](#serverendpointrecallerror)[] (ReadOnly): Array of recall errors -* **totalRecallErrorsCount**: int (ReadOnly): Total count of recall errors. +* **errorCode**: int (ReadOnly): Error code (HResult) +* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code +* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code ## ServerEndpointRecallError ### Properties * **count**: int (ReadOnly): Count of occurences of the error * **errorCode**: int (ReadOnly): Error code (HResult) -## ServerEndpointSyncStatus +## ServerEndpointRecallStatus ### Properties -* **combinedHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state -* **downloadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. -* **downloadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state -* **downloadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. -* **lastUpdatedTimestamp**: string (ReadOnly): Last Updated Timestamp -* **offlineDataTransferStatus**: 'Complete' | 'InProgress' | 'NotRunning' | 'Stopping' | string (ReadOnly): Type of the Health state -* **syncActivity**: 'Download' | 'Upload' | 'UploadAndDownload' | string (ReadOnly): Type of the sync activity state -* **totalPersistentFilesNotSyncingCount**: int (ReadOnly): Total count of persistent files not syncing (combined upload + download). -* **uploadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. -* **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state -* **uploadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **recallErrors**: [ServerEndpointRecallError](#serverendpointrecallerror)[] (ReadOnly): Array of recall errors +* **totalRecallErrorsCount**: int (ReadOnly): Total count of recall errors. ## ServerEndpointSyncActivityStatus ### Properties @@ -156,9 +143,22 @@ * **persistentFilesNotSyncingCount**: int (ReadOnly): Count of persistent files not syncing. * **transientFilesNotSyncingCount**: int (ReadOnly): Count of transient files not syncing. -## ServerEndpointFilesNotSyncingError +## ServerEndpointSyncStatus ### Properties -* **errorCode**: int (ReadOnly): Error code (HResult) -* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code -* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code +* **combinedHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state +* **downloadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. +* **downloadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state +* **downloadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. +* **lastUpdatedTimestamp**: string (ReadOnly): Last Updated Timestamp +* **offlineDataTransferStatus**: 'Complete' | 'InProgress' | 'NotRunning' | 'Stopping' | string (ReadOnly): Type of the Health state +* **syncActivity**: 'Download' | 'Upload' | 'UploadAndDownload' | string (ReadOnly): Type of the sync activity state +* **totalPersistentFilesNotSyncingCount**: int (ReadOnly): Total count of persistent files not syncing (combined upload + download). +* **uploadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. +* **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state +* **uploadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. + +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/storagesync/microsoft.storagesync/2019-10-01/types.md b/generated/storagesync/microsoft.storagesync/2019-10-01/types.md index 2431f01a1c..4e53b6c9d6 100644 --- a/generated/storagesync/microsoft.storagesync/2019-10-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2019-10-01/types.md @@ -47,10 +47,55 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersTags +## CloudEndpointCreateParametersProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureFileShareName**: string: Azure file share name +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **friendlyName**: string: Friendly Name +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountTenantId**: string: Storage Account Tenant Id + +## CloudTieringCachePerformance +### Properties +* **cacheHitBytes**: int (ReadOnly): Count of bytes that were served from the local server +* **cacheHitBytesPercent**: int (ReadOnly): Percentage of total bytes (hit + miss) that were served from the local server +* **cacheMissBytes**: int (ReadOnly): Count of bytes that were served from the cloud +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## CloudTieringDatePolicyStatus +### Properties +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **tieredFilesMostRecentAccessTimestamp**: string (ReadOnly): Most recent access time of tiered files + +## CloudTieringFilesNotTiering +### Properties +* **errors**: [FilesNotTieringError](#filesnottieringerror)[] (ReadOnly): Array of tiering errors +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **totalFileCount**: int (ReadOnly): Last cloud tiering result (HResult) + +## CloudTieringSpaceSavings +### Properties +* **cachedSizeBytes**: int (ReadOnly): Cached content size on the server +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **spaceSavingsBytes**: int (ReadOnly): Count of bytes saved on the server +* **spaceSavingsPercent**: int (ReadOnly): Percentage of cached size over total size +* **totalSizeCloudBytes**: int (ReadOnly): Total size of content in the azure file share +* **volumeSizeBytes**: int (ReadOnly): Volume size + +## CloudTieringVolumeFreeSpacePolicyStatus +### Properties +* **currentVolumeFreeSpacePercent**: int (ReadOnly): Current volume free space percentage. +* **effectiveVolumeFreeSpacePolicy**: int (ReadOnly): In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## FilesNotTieringError +### Properties +* **errorCode**: int (ReadOnly): Error code (HResult) +* **fileCount**: int (ReadOnly): Count of files with this error ## RegisteredServerCreateParametersProperties ### Properties @@ -74,17 +119,18 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties +## ServerEndpointCloudTieringStatus ### Properties -* **azureFileShareName**: string: Azure file share name -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **friendlyName**: string: Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountTenantId**: string: Storage Account Tenant Id +* **cachePerformance**: [CloudTieringCachePerformance](#cloudtieringcacheperformance) (ReadOnly): Server endpoint cloud tiering status object. +* **datePolicyStatus**: [CloudTieringDatePolicyStatus](#cloudtieringdatepolicystatus) (ReadOnly): Status of the date policy +* **filesNotTiering**: [CloudTieringFilesNotTiering](#cloudtieringfilesnottiering) (ReadOnly): Server endpoint cloud tiering status object. +* **health**: 'Error' | 'Healthy' | string (ReadOnly): Type of the cloud tiering health state +* **healthLastUpdatedTimestamp**: string (ReadOnly): The last updated timestamp of health state +* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) +* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **spaceSavings**: [CloudTieringSpaceSavings](#cloudtieringspacesavings) (ReadOnly): Server endpoint cloud tiering status object. +* **volumeFreeSpacePolicyStatus**: [CloudTieringVolumeFreeSpacePolicyStatus](#cloudtieringvolumefreespacepolicystatus) (ReadOnly): Status of the volume free space policy ## ServerEndpointCreateParametersProperties ### Properties @@ -105,56 +151,16 @@ * **tierFilesOlderThanDays**: int: Tier files older than days. * **volumeFreeSpacePercent**: int: Level of free space to be maintained by Cloud Tiering if it is enabled. -## ServerEndpointCloudTieringStatus -### Properties -* **cachePerformance**: [CloudTieringCachePerformance](#cloudtieringcacheperformance) (ReadOnly): Server endpoint cloud tiering status object. -* **datePolicyStatus**: [CloudTieringDatePolicyStatus](#cloudtieringdatepolicystatus) (ReadOnly): Status of the date policy -* **filesNotTiering**: [CloudTieringFilesNotTiering](#cloudtieringfilesnottiering) (ReadOnly): Server endpoint cloud tiering status object. -* **health**: 'Error' | 'Healthy' | string (ReadOnly): Type of the cloud tiering health state -* **healthLastUpdatedTimestamp**: string (ReadOnly): The last updated timestamp of health state -* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) -* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **spaceSavings**: [CloudTieringSpaceSavings](#cloudtieringspacesavings) (ReadOnly): Server endpoint cloud tiering status object. -* **volumeFreeSpacePolicyStatus**: [CloudTieringVolumeFreeSpacePolicyStatus](#cloudtieringvolumefreespacepolicystatus) (ReadOnly): Status of the volume free space policy - -## CloudTieringCachePerformance -### Properties -* **cacheHitBytes**: int (ReadOnly): Count of bytes that were served from the local server -* **cacheHitBytesPercent**: int (ReadOnly): Percentage of total bytes (hit + miss) that were served from the local server -* **cacheMissBytes**: int (ReadOnly): Count of bytes that were served from the cloud -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp - -## CloudTieringDatePolicyStatus -### Properties -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **tieredFilesMostRecentAccessTimestamp**: string (ReadOnly): Most recent access time of tiered files - -## CloudTieringFilesNotTiering -### Properties -* **errors**: [FilesNotTieringError](#filesnottieringerror)[] (ReadOnly): Array of tiering errors -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **totalFileCount**: int (ReadOnly): Last cloud tiering result (HResult) - -## FilesNotTieringError +## ServerEndpointFilesNotSyncingError ### Properties * **errorCode**: int (ReadOnly): Error code (HResult) -* **fileCount**: int (ReadOnly): Count of files with this error - -## CloudTieringSpaceSavings -### Properties -* **cachedSizeBytes**: int (ReadOnly): Cached content size on the server -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **spaceSavingsBytes**: int (ReadOnly): Count of bytes saved on the server -* **spaceSavingsPercent**: int (ReadOnly): Percentage of cached size over total size -* **totalSizeCloudBytes**: int (ReadOnly): Total size of content in the azure file share -* **volumeSizeBytes**: int (ReadOnly): Volume size +* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code +* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code -## CloudTieringVolumeFreeSpacePolicyStatus +## ServerEndpointRecallError ### Properties -* **currentVolumeFreeSpacePercent**: int (ReadOnly): Current volume free space percentage. -* **effectiveVolumeFreeSpacePolicy**: int (ReadOnly): In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **count**: int (ReadOnly): Count of occurences of the error +* **errorCode**: int (ReadOnly): Error code (HResult) ## ServerEndpointRecallStatus ### Properties @@ -162,11 +168,6 @@ * **recallErrors**: [ServerEndpointRecallError](#serverendpointrecallerror)[] (ReadOnly): Array of recall errors * **totalRecallErrorsCount**: int (ReadOnly): Total count of recall errors. -## ServerEndpointRecallError -### Properties -* **count**: int (ReadOnly): Count of occurences of the error -* **errorCode**: int (ReadOnly): Error code (HResult) - ## ServerEndpointSyncStatus ### Properties * **combinedHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state @@ -181,6 +182,11 @@ * **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state * **uploadStatus**: [SyncSessionStatus](#syncsessionstatus) (ReadOnly): Sync Session status object. +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## SyncActivityStatus ### Properties * **appliedBytes**: int (ReadOnly): Applied bytes @@ -200,9 +206,3 @@ * **persistentFilesNotSyncingCount**: int (ReadOnly): Count of persistent files not syncing. * **transientFilesNotSyncingCount**: int (ReadOnly): Count of transient files not syncing. -## ServerEndpointFilesNotSyncingError -### Properties -* **errorCode**: int (ReadOnly): Error code (HResult) -* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code -* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code - diff --git a/generated/storagesync/microsoft.storagesync/2020-03-01/types.md b/generated/storagesync/microsoft.storagesync/2020-03-01/types.md index 4cca2aa625..b28f95f498 100644 --- a/generated/storagesync/microsoft.storagesync/2020-03-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2020-03-01/types.md @@ -56,15 +56,59 @@ * **properties**: [ServerEndpointCreateParametersProperties](#serverendpointcreateparametersproperties): ServerEndpoint Properties object. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersProperties +## CloudEndpointCreateParametersProperties ### Properties -* **incomingTrafficPolicy**: 'AllowAllTraffic' | 'AllowVirtualNetworksOnly' | string: Type of the Incoming Traffic Policy +* **azureFileShareName**: string: Azure file share name +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **friendlyName**: string: Friendly Name * **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): StorageSyncService lastWorkflowId -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage sync service -* **provisioningState**: string (ReadOnly): StorageSyncService Provisioning State -* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. -* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountTenantId**: string: Storage Account Tenant Id + +## CloudTieringCachePerformance +### Properties +* **cacheHitBytes**: int (ReadOnly): Count of bytes that were served from the local server +* **cacheHitBytesPercent**: int (ReadOnly): Percentage of total bytes (hit + miss) that were served from the local server +* **cacheMissBytes**: int (ReadOnly): Count of bytes that were served from the cloud +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## CloudTieringDatePolicyStatus +### Properties +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **tieredFilesMostRecentAccessTimestamp**: string (ReadOnly): Most recent access time of tiered files + +## CloudTieringFilesNotTiering +### Properties +* **errors**: [FilesNotTieringError](#filesnottieringerror)[] (ReadOnly): Array of tiering errors +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **totalFileCount**: int (ReadOnly): Last cloud tiering result (HResult) + +## CloudTieringSpaceSavings +### Properties +* **cachedSizeBytes**: int (ReadOnly): Cached content size on the server +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **spaceSavingsBytes**: int (ReadOnly): Count of bytes saved on the server +* **spaceSavingsPercent**: int (ReadOnly): Percentage of cached size over total size +* **totalSizeCloudBytes**: int (ReadOnly): Total size of content in the azure file share +* **volumeSizeBytes**: int (ReadOnly): Volume size + +## CloudTieringVolumeFreeSpacePolicyStatus +### Properties +* **currentVolumeFreeSpacePercent**: int (ReadOnly): Current volume free space percentage. +* **effectiveVolumeFreeSpacePolicy**: int (ReadOnly): In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## FilesNotTieringError +### Properties +* **errorCode**: int (ReadOnly): Error code (HResult) +* **fileCount**: int (ReadOnly): Count of files with this error + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -79,21 +123,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. * **description**: string (ReadOnly): The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. -## StorageSyncServiceCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## RegisteredServerCreateParametersProperties ### Properties * **agentVersion**: string: Registered Server Agent Version @@ -119,17 +154,18 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties +## ServerEndpointCloudTieringStatus ### Properties -* **azureFileShareName**: string: Azure file share name -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **friendlyName**: string: Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountTenantId**: string: Storage Account Tenant Id +* **cachePerformance**: [CloudTieringCachePerformance](#cloudtieringcacheperformance) (ReadOnly): Server endpoint cloud tiering status object. +* **datePolicyStatus**: [CloudTieringDatePolicyStatus](#cloudtieringdatepolicystatus) (ReadOnly): Status of the date policy +* **filesNotTiering**: [CloudTieringFilesNotTiering](#cloudtieringfilesnottiering) (ReadOnly): Server endpoint cloud tiering status object. +* **health**: 'Error' | 'Healthy' | string (ReadOnly): Type of the cloud tiering health state +* **healthLastUpdatedTimestamp**: string (ReadOnly): The last updated timestamp of health state +* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) +* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **spaceSavings**: [CloudTieringSpaceSavings](#cloudtieringspacesavings) (ReadOnly): Server endpoint cloud tiering status object. +* **volumeFreeSpacePolicyStatus**: [CloudTieringVolumeFreeSpacePolicyStatus](#cloudtieringvolumefreespacepolicystatus) (ReadOnly): Status of the volume free space policy ## ServerEndpointCreateParametersProperties ### Properties @@ -152,56 +188,16 @@ * **tierFilesOlderThanDays**: int: Tier files older than days. * **volumeFreeSpacePercent**: int: Level of free space to be maintained by Cloud Tiering if it is enabled. -## ServerEndpointCloudTieringStatus -### Properties -* **cachePerformance**: [CloudTieringCachePerformance](#cloudtieringcacheperformance) (ReadOnly): Server endpoint cloud tiering status object. -* **datePolicyStatus**: [CloudTieringDatePolicyStatus](#cloudtieringdatepolicystatus) (ReadOnly): Status of the date policy -* **filesNotTiering**: [CloudTieringFilesNotTiering](#cloudtieringfilesnottiering) (ReadOnly): Server endpoint cloud tiering status object. -* **health**: 'Error' | 'Healthy' | string (ReadOnly): Type of the cloud tiering health state -* **healthLastUpdatedTimestamp**: string (ReadOnly): The last updated timestamp of health state -* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) -* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **spaceSavings**: [CloudTieringSpaceSavings](#cloudtieringspacesavings) (ReadOnly): Server endpoint cloud tiering status object. -* **volumeFreeSpacePolicyStatus**: [CloudTieringVolumeFreeSpacePolicyStatus](#cloudtieringvolumefreespacepolicystatus) (ReadOnly): Status of the volume free space policy - -## CloudTieringCachePerformance -### Properties -* **cacheHitBytes**: int (ReadOnly): Count of bytes that were served from the local server -* **cacheHitBytesPercent**: int (ReadOnly): Percentage of total bytes (hit + miss) that were served from the local server -* **cacheMissBytes**: int (ReadOnly): Count of bytes that were served from the cloud -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp - -## CloudTieringDatePolicyStatus -### Properties -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **tieredFilesMostRecentAccessTimestamp**: string (ReadOnly): Most recent access time of tiered files - -## CloudTieringFilesNotTiering -### Properties -* **errors**: [FilesNotTieringError](#filesnottieringerror)[] (ReadOnly): Array of tiering errors -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **totalFileCount**: int (ReadOnly): Last cloud tiering result (HResult) - -## FilesNotTieringError +## ServerEndpointFilesNotSyncingError ### Properties * **errorCode**: int (ReadOnly): Error code (HResult) -* **fileCount**: int (ReadOnly): Count of files with this error - -## CloudTieringSpaceSavings -### Properties -* **cachedSizeBytes**: int (ReadOnly): Cached content size on the server -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **spaceSavingsBytes**: int (ReadOnly): Count of bytes saved on the server -* **spaceSavingsPercent**: int (ReadOnly): Percentage of cached size over total size -* **totalSizeCloudBytes**: int (ReadOnly): Total size of content in the azure file share -* **volumeSizeBytes**: int (ReadOnly): Volume size +* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code +* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code -## CloudTieringVolumeFreeSpacePolicyStatus +## ServerEndpointRecallError ### Properties -* **currentVolumeFreeSpacePercent**: int (ReadOnly): Current volume free space percentage. -* **effectiveVolumeFreeSpacePolicy**: int (ReadOnly): In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **count**: int (ReadOnly): Count of occurences of the error +* **errorCode**: int (ReadOnly): Error code (HResult) ## ServerEndpointRecallStatus ### Properties @@ -209,25 +205,6 @@ * **recallErrors**: [ServerEndpointRecallError](#serverendpointrecallerror)[] (ReadOnly): Array of recall errors * **totalRecallErrorsCount**: int (ReadOnly): Total count of recall errors. -## ServerEndpointRecallError -### Properties -* **count**: int (ReadOnly): Count of occurences of the error -* **errorCode**: int (ReadOnly): Error code (HResult) - -## ServerEndpointSyncStatus -### Properties -* **combinedHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state -* **downloadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. -* **downloadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state -* **downloadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. -* **lastUpdatedTimestamp**: string (ReadOnly): Last Updated Timestamp -* **offlineDataTransferStatus**: 'Complete' | 'InProgress' | 'NotRunning' | 'Stopping' | string (ReadOnly): Type of the Health state -* **syncActivity**: 'Download' | 'Upload' | 'UploadAndDownload' | string (ReadOnly): Type of the sync activity state -* **totalPersistentFilesNotSyncingCount**: int (ReadOnly): Total count of persistent files not syncing (combined upload + download). -* **uploadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. -* **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state -* **uploadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. - ## ServerEndpointSyncActivityStatus ### Properties * **appliedBytes**: int (ReadOnly): Applied bytes @@ -249,9 +226,32 @@ * **persistentFilesNotSyncingCount**: int (ReadOnly): Count of persistent files not syncing. * **transientFilesNotSyncingCount**: int (ReadOnly): Count of transient files not syncing. -## ServerEndpointFilesNotSyncingError +## ServerEndpointSyncStatus ### Properties -* **errorCode**: int (ReadOnly): Error code (HResult) -* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code -* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code +* **combinedHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state +* **downloadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. +* **downloadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state +* **downloadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. +* **lastUpdatedTimestamp**: string (ReadOnly): Last Updated Timestamp +* **offlineDataTransferStatus**: 'Complete' | 'InProgress' | 'NotRunning' | 'Stopping' | string (ReadOnly): Type of the Health state +* **syncActivity**: 'Download' | 'Upload' | 'UploadAndDownload' | string (ReadOnly): Type of the sync activity state +* **totalPersistentFilesNotSyncingCount**: int (ReadOnly): Total count of persistent files not syncing (combined upload + download). +* **uploadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. +* **uploadHealth**: 'Error' | 'Healthy' | 'NoActivity' | 'SyncBlockedForChangeDetectionPostRestore' | 'SyncBlockedForRestore' | string (ReadOnly): Type of the sync health state +* **uploadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. + +## StorageSyncServiceCreateParametersProperties +### Properties +* **incomingTrafficPolicy**: 'AllowAllTraffic' | 'AllowVirtualNetworksOnly' | string: Type of the Incoming Traffic Policy +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): StorageSyncService lastWorkflowId +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage sync service +* **provisioningState**: string (ReadOnly): StorageSyncService Provisioning State +* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. +* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid + +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/storagesync/microsoft.storagesync/2020-09-01/types.md b/generated/storagesync/microsoft.storagesync/2020-09-01/types.md index 9168c8f978..f5aa59eff5 100644 --- a/generated/storagesync/microsoft.storagesync/2020-09-01/types.md +++ b/generated/storagesync/microsoft.storagesync/2020-09-01/types.md @@ -62,15 +62,91 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints' (ReadOnly, DeployTimeConstant): The resource type -## StorageSyncServiceCreateParametersProperties +## CloudEndpointChangeEnumerationActivity ### Properties -* **incomingTrafficPolicy**: 'AllowAllTraffic' | 'AllowVirtualNetworksOnly' | string: Type of the Incoming Traffic Policy +* **deletesProgressPercent**: int (ReadOnly): Progress percentage for processing deletes. This is done separately from the rest of the enumeration run +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **minutesRemaining**: int (ReadOnly): Estimate of time remaining for the enumeration run +* **operationState**: 'EnumerationInProgress' | 'InitialEnumerationInProgress' | string (ReadOnly): State of change enumeration activity +* **processedDirectoriesCount**: int (ReadOnly): Count of directories processed +* **processedFilesCount**: int (ReadOnly): Count of files processed +* **progressPercent**: int (ReadOnly): Progress percentage for change enumeration run, excluding processing of deletes +* **startedTimestamp**: string (ReadOnly): Timestamp when change enumeration started +* **statusCode**: int (ReadOnly): When non-zero, indicates an issue that is delaying change enumeration +* **totalCountsState**: 'Calculating' | 'Final' | string (ReadOnly): State of the total counts of change enumeration activity +* **totalDirectoriesCount**: int (ReadOnly): Total count of directories enumerated +* **totalFilesCount**: int (ReadOnly): Total count of files enumerated +* **totalSizeBytes**: int (ReadOnly): Total enumerated size in bytes + +## CloudEndpointChangeEnumerationStatus +### Properties +* **activity**: [CloudEndpointChangeEnumerationActivity](#cloudendpointchangeenumerationactivity) (ReadOnly): Cloud endpoint change enumeration activity object +* **lastEnumerationStatus**: [CloudEndpointLastChangeEnumerationStatus](#cloudendpointlastchangeenumerationstatus) (ReadOnly): Cloud endpoint change enumeration status object +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## CloudEndpointCreateParametersProperties +### Properties +* **azureFileShareName**: string: Azure file share name +* **backupEnabled**: string (ReadOnly): Backup Enabled +* **changeEnumerationStatus**: [CloudEndpointChangeEnumerationStatus](#cloudendpointchangeenumerationstatus) (ReadOnly): Cloud endpoint change enumeration status object +* **friendlyName**: string: Friendly Name * **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): StorageSyncService lastWorkflowId -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage sync service -* **provisioningState**: string (ReadOnly): StorageSyncService Provisioning State -* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. -* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid +* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId +* **partnershipId**: string (ReadOnly): Partnership Id +* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State +* **storageAccountResourceId**: string: Storage Account Resource Id +* **storageAccountTenantId**: string: Storage Account Tenant Id + +## CloudEndpointLastChangeEnumerationStatus +### Properties +* **completedTimestamp**: string (ReadOnly): Timestamp when change enumeration completed +* **namespaceDirectoriesCount**: int (ReadOnly): Count of directories in the namespace +* **namespaceFilesCount**: int (ReadOnly): Count of files in the namespace +* **namespaceSizeBytes**: int (ReadOnly): Namespace size in bytes +* **nextRunTimestamp**: string (ReadOnly): Timestamp of when change enumeration is expected to run again +* **startedTimestamp**: string (ReadOnly): Timestamp when change enumeration started + +## CloudTieringCachePerformance +### Properties +* **cacheHitBytes**: int (ReadOnly): Count of bytes that were served from the local server +* **cacheHitBytesPercent**: int (ReadOnly): Percentage of total bytes (hit + miss) that were served from the local server +* **cacheMissBytes**: int (ReadOnly): Count of bytes that were served from the cloud +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## CloudTieringDatePolicyStatus +### Properties +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **tieredFilesMostRecentAccessTimestamp**: string (ReadOnly): Most recent access time of tiered files + +## CloudTieringFilesNotTiering +### Properties +* **errors**: [FilesNotTieringError](#filesnottieringerror)[] (ReadOnly): Array of tiering errors +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **totalFileCount**: int (ReadOnly): Last cloud tiering result (HResult) + +## CloudTieringSpaceSavings +### Properties +* **cachedSizeBytes**: int (ReadOnly): Cached content size on the server +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **spaceSavingsBytes**: int (ReadOnly): Count of bytes saved on the server +* **spaceSavingsPercent**: int (ReadOnly): Percentage of cached size over total size +* **totalSizeCloudBytes**: int (ReadOnly): Total size of content in the azure file share +* **volumeSizeBytes**: int (ReadOnly): Volume size + +## CloudTieringVolumeFreeSpacePolicyStatus +### Properties +* **currentVolumeFreeSpacePercent**: int (ReadOnly): Current volume free space percentage. +* **effectiveVolumeFreeSpacePolicy**: int (ReadOnly): In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. +* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp + +## FilesNotTieringError +### Properties +* **errorCode**: int (ReadOnly): Error code (HResult) +* **fileCount**: int (ReadOnly): Count of files with this error + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint ## PrivateEndpointConnection ### Properties @@ -86,30 +162,12 @@ * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (ReadOnly): A collection of information about the state of the connection between service consumer and provider. * **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. * **description**: string (ReadOnly): The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Pending' | 'Rejected' | string (ReadOnly): The private endpoint connection status. -## SystemData -### Properties -* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). -* **createdBy**: string (ReadOnly): The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. -* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. - -## StorageSyncServiceCreateParametersTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## RegisteredServerCreateParametersProperties ### Properties * **agentVersion**: string: Registered Server Agent Version @@ -136,49 +194,25 @@ * **serviceLocation**: string (ReadOnly): Service Location * **storageSyncServiceUid**: string (ReadOnly): Registered Server storageSyncServiceUid -## CloudEndpointCreateParametersProperties -### Properties -* **azureFileShareName**: string: Azure file share name -* **backupEnabled**: string (ReadOnly): Backup Enabled -* **changeEnumerationStatus**: [CloudEndpointChangeEnumerationStatus](#cloudendpointchangeenumerationstatus) (ReadOnly): Cloud endpoint change enumeration status object -* **friendlyName**: string: Friendly Name -* **lastOperationName**: string (ReadOnly): Resource Last Operation Name -* **lastWorkflowId**: string (ReadOnly): CloudEndpoint lastWorkflowId -* **partnershipId**: string (ReadOnly): Partnership Id -* **provisioningState**: string (ReadOnly): CloudEndpoint Provisioning State -* **storageAccountResourceId**: string: Storage Account Resource Id -* **storageAccountTenantId**: string: Storage Account Tenant Id - -## CloudEndpointChangeEnumerationStatus +## ServerEndpointBackgroundDataDownloadActivity ### Properties -* **activity**: [CloudEndpointChangeEnumerationActivity](#cloudendpointchangeenumerationactivity) (ReadOnly): Cloud endpoint change enumeration activity object -* **lastEnumerationStatus**: [CloudEndpointLastChangeEnumerationStatus](#cloudendpointlastchangeenumerationstatus) (ReadOnly): Cloud endpoint change enumeration status object -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **downloadedBytes**: int (ReadOnly): Running count of bytes downloaded +* **percentProgress**: int (ReadOnly): Progress percentage +* **startedTimestamp**: string (ReadOnly): Timestamp when the operation started +* **timestamp**: string (ReadOnly): Timestamp when properties were updated -## CloudEndpointChangeEnumerationActivity +## ServerEndpointCloudTieringStatus ### Properties -* **deletesProgressPercent**: int (ReadOnly): Progress percentage for processing deletes. This is done separately from the rest of the enumeration run +* **cachePerformance**: [CloudTieringCachePerformance](#cloudtieringcacheperformance) (ReadOnly): Server endpoint cloud tiering status object. +* **datePolicyStatus**: [CloudTieringDatePolicyStatus](#cloudtieringdatepolicystatus) (ReadOnly): Status of the date policy +* **filesNotTiering**: [CloudTieringFilesNotTiering](#cloudtieringfilesnottiering) (ReadOnly): Server endpoint cloud tiering status object. +* **health**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state +* **healthLastUpdatedTimestamp**: string (ReadOnly): The last updated timestamp of health state +* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) +* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp * **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **minutesRemaining**: int (ReadOnly): Estimate of time remaining for the enumeration run -* **operationState**: 'EnumerationInProgress' | 'InitialEnumerationInProgress' | string (ReadOnly): State of change enumeration activity -* **processedDirectoriesCount**: int (ReadOnly): Count of directories processed -* **processedFilesCount**: int (ReadOnly): Count of files processed -* **progressPercent**: int (ReadOnly): Progress percentage for change enumeration run, excluding processing of deletes -* **startedTimestamp**: string (ReadOnly): Timestamp when change enumeration started -* **statusCode**: int (ReadOnly): When non-zero, indicates an issue that is delaying change enumeration -* **totalCountsState**: 'Calculating' | 'Final' | string (ReadOnly): State of the total counts of change enumeration activity -* **totalDirectoriesCount**: int (ReadOnly): Total count of directories enumerated -* **totalFilesCount**: int (ReadOnly): Total count of files enumerated -* **totalSizeBytes**: int (ReadOnly): Total enumerated size in bytes - -## CloudEndpointLastChangeEnumerationStatus -### Properties -* **completedTimestamp**: string (ReadOnly): Timestamp when change enumeration completed -* **namespaceDirectoriesCount**: int (ReadOnly): Count of directories in the namespace -* **namespaceFilesCount**: int (ReadOnly): Count of files in the namespace -* **namespaceSizeBytes**: int (ReadOnly): Namespace size in bytes -* **nextRunTimestamp**: string (ReadOnly): Timestamp of when change enumeration is expected to run again -* **startedTimestamp**: string (ReadOnly): Timestamp when change enumeration started +* **spaceSavings**: [CloudTieringSpaceSavings](#cloudtieringspacesavings) (ReadOnly): Server endpoint cloud tiering status object. +* **volumeFreeSpacePolicyStatus**: [CloudTieringVolumeFreeSpacePolicyStatus](#cloudtieringvolumefreespacepolicystatus) (ReadOnly): Status of the volume free space policy ## ServerEndpointCreateParametersProperties ### Properties @@ -203,56 +237,16 @@ * **tierFilesOlderThanDays**: int: Tier files older than days. * **volumeFreeSpacePercent**: int: Level of free space to be maintained by Cloud Tiering if it is enabled. -## ServerEndpointCloudTieringStatus -### Properties -* **cachePerformance**: [CloudTieringCachePerformance](#cloudtieringcacheperformance) (ReadOnly): Server endpoint cloud tiering status object. -* **datePolicyStatus**: [CloudTieringDatePolicyStatus](#cloudtieringdatepolicystatus) (ReadOnly): Status of the date policy -* **filesNotTiering**: [CloudTieringFilesNotTiering](#cloudtieringfilesnottiering) (ReadOnly): Server endpoint cloud tiering status object. -* **health**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state -* **healthLastUpdatedTimestamp**: string (ReadOnly): The last updated timestamp of health state -* **lastCloudTieringResult**: int (ReadOnly): Last cloud tiering result (HResult) -* **lastSuccessTimestamp**: string (ReadOnly): Last cloud tiering success timestamp -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **spaceSavings**: [CloudTieringSpaceSavings](#cloudtieringspacesavings) (ReadOnly): Server endpoint cloud tiering status object. -* **volumeFreeSpacePolicyStatus**: [CloudTieringVolumeFreeSpacePolicyStatus](#cloudtieringvolumefreespacepolicystatus) (ReadOnly): Status of the volume free space policy - -## CloudTieringCachePerformance -### Properties -* **cacheHitBytes**: int (ReadOnly): Count of bytes that were served from the local server -* **cacheHitBytesPercent**: int (ReadOnly): Percentage of total bytes (hit + miss) that were served from the local server -* **cacheMissBytes**: int (ReadOnly): Count of bytes that were served from the cloud -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp - -## CloudTieringDatePolicyStatus -### Properties -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **tieredFilesMostRecentAccessTimestamp**: string (ReadOnly): Most recent access time of tiered files - -## CloudTieringFilesNotTiering -### Properties -* **errors**: [FilesNotTieringError](#filesnottieringerror)[] (ReadOnly): Array of tiering errors -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **totalFileCount**: int (ReadOnly): Last cloud tiering result (HResult) - -## FilesNotTieringError +## ServerEndpointFilesNotSyncingError ### Properties * **errorCode**: int (ReadOnly): Error code (HResult) -* **fileCount**: int (ReadOnly): Count of files with this error - -## CloudTieringSpaceSavings -### Properties -* **cachedSizeBytes**: int (ReadOnly): Cached content size on the server -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp -* **spaceSavingsBytes**: int (ReadOnly): Count of bytes saved on the server -* **spaceSavingsPercent**: int (ReadOnly): Percentage of cached size over total size -* **totalSizeCloudBytes**: int (ReadOnly): Total size of content in the azure file share -* **volumeSizeBytes**: int (ReadOnly): Volume size +* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code +* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code -## CloudTieringVolumeFreeSpacePolicyStatus +## ServerEndpointRecallError ### Properties -* **currentVolumeFreeSpacePercent**: int (ReadOnly): Current volume free space percentage. -* **effectiveVolumeFreeSpacePolicy**: int (ReadOnly): In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. -* **lastUpdatedTimestamp**: string (ReadOnly): Last updated timestamp +* **count**: int (ReadOnly): Count of occurences of the error +* **errorCode**: int (ReadOnly): Error code (HResult) ## ServerEndpointRecallStatus ### Properties @@ -260,33 +254,6 @@ * **recallErrors**: [ServerEndpointRecallError](#serverendpointrecallerror)[] (ReadOnly): Array of recall errors * **totalRecallErrorsCount**: int (ReadOnly): Total count of recall errors. -## ServerEndpointRecallError -### Properties -* **count**: int (ReadOnly): Count of occurences of the error -* **errorCode**: int (ReadOnly): Error code (HResult) - -## ServerEndpointSyncStatus -### Properties -* **backgroundDataDownloadActivity**: [ServerEndpointBackgroundDataDownloadActivity](#serverendpointbackgrounddatadownloadactivity) (ReadOnly): Background data download activity object -* **combinedHealth**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state -* **downloadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. -* **downloadHealth**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state -* **downloadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. -* **lastUpdatedTimestamp**: string (ReadOnly): Last Updated Timestamp -* **offlineDataTransferStatus**: 'Complete' | 'InProgress' | 'NotRunning' | 'Stopping' | string (ReadOnly): Type of the Health state -* **syncActivity**: 'Download' | 'Upload' | 'UploadAndDownload' | string (ReadOnly): Type of the sync activity state -* **totalPersistentFilesNotSyncingCount**: int (ReadOnly): Total count of persistent files not syncing (combined upload + download). -* **uploadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. -* **uploadHealth**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state -* **uploadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. - -## ServerEndpointBackgroundDataDownloadActivity -### Properties -* **downloadedBytes**: int (ReadOnly): Running count of bytes downloaded -* **percentProgress**: int (ReadOnly): Progress percentage -* **startedTimestamp**: string (ReadOnly): Timestamp when the operation started -* **timestamp**: string (ReadOnly): Timestamp when properties were updated - ## ServerEndpointSyncActivityStatus ### Properties * **appliedBytes**: int (ReadOnly): Applied bytes @@ -309,9 +276,42 @@ * **persistentFilesNotSyncingCount**: int (ReadOnly): Count of persistent files not syncing. * **transientFilesNotSyncingCount**: int (ReadOnly): Count of transient files not syncing. -## ServerEndpointFilesNotSyncingError +## ServerEndpointSyncStatus ### Properties -* **errorCode**: int (ReadOnly): Error code (HResult) -* **persistentCount**: int (ReadOnly): Count of persistent files not syncing with the specified error code -* **transientCount**: int (ReadOnly): Count of transient files not syncing with the specified error code +* **backgroundDataDownloadActivity**: [ServerEndpointBackgroundDataDownloadActivity](#serverendpointbackgrounddatadownloadactivity) (ReadOnly): Background data download activity object +* **combinedHealth**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state +* **downloadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. +* **downloadHealth**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state +* **downloadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. +* **lastUpdatedTimestamp**: string (ReadOnly): Last Updated Timestamp +* **offlineDataTransferStatus**: 'Complete' | 'InProgress' | 'NotRunning' | 'Stopping' | string (ReadOnly): Type of the Health state +* **syncActivity**: 'Download' | 'Upload' | 'UploadAndDownload' | string (ReadOnly): Type of the sync activity state +* **totalPersistentFilesNotSyncingCount**: int (ReadOnly): Total count of persistent files not syncing (combined upload + download). +* **uploadActivity**: [ServerEndpointSyncActivityStatus](#serverendpointsyncactivitystatus) (ReadOnly): Sync Session status object. +* **uploadHealth**: 'Error' | 'Healthy' | 'Unavailable' | string (ReadOnly): Type of the server endpoint health state +* **uploadStatus**: [ServerEndpointSyncSessionStatus](#serverendpointsyncsessionstatus) (ReadOnly): Sync Session status object. + +## StorageSyncServiceCreateParametersProperties +### Properties +* **incomingTrafficPolicy**: 'AllowAllTraffic' | 'AllowVirtualNetworksOnly' | string: Type of the Incoming Traffic Policy +* **lastOperationName**: string (ReadOnly): Resource Last Operation Name +* **lastWorkflowId**: string (ReadOnly): StorageSyncService lastWorkflowId +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): List of private endpoint connection associated with the specified storage sync service +* **provisioningState**: string (ReadOnly): StorageSyncService Provisioning State +* **storageSyncServiceStatus**: int (ReadOnly): Storage Sync service status. +* **storageSyncServiceUid**: string (ReadOnly): Storage Sync service Uid + +## StorageSyncServiceCreateParametersTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SystemData +### Properties +* **createdAt**: string (ReadOnly): The timestamp of resource creation (UTC). +* **createdBy**: string (ReadOnly): The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. +* **lastModifiedAt**: string (ReadOnly): The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string (ReadOnly): The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string (ReadOnly): The type of identity that created the resource. diff --git a/generated/storsimple1200series/log.out b/generated/storsimple1200series/log.out index 175dcf8ce0..7dbc454fdc 100644 --- a/generated/storsimple1200series/log.out +++ b/generated/storsimple1200series/log.out @@ -4,12 +4,12 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.storsimple-2016-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 16ms -info | Autorest completed in 9.5s. 2 files generated. +info | autorest.bicep took 15ms +info | Autorest completed in 9.04s. 2 files generated. diff --git a/generated/storsimple1200series/microsoft.storsimple/2016-10-01/types.md b/generated/storsimple1200series/microsoft.storsimple/2016-10-01/types.md index b201764996..d45a823aa1 100644 --- a/generated/storsimple1200series/microsoft.storsimple/2016-10-01/types.md +++ b/generated/storsimple1200series/microsoft.storsimple/2016-10-01/types.md @@ -122,34 +122,10 @@ * **properties**: [StorageDomainProperties](#storagedomainproperties) (Required): The storage domain properties. * **type**: 'Microsoft.StorSimple/managers/storageDomains' (ReadOnly, DeployTimeConstant): The resource type -## ManagerProperties -### Properties -* **cisIntrinsicSettings**: [ManagerIntrinsicSettings](#managerintrinsicsettings): Intrinsic settings which refers to the type of the StorSimple manager -* **provisioningState**: string (ReadOnly): Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created -* **sku**: [ManagerSku](#managersku): The Sku. - -## ManagerIntrinsicSettings -### Properties -* **type**: 'GardaV1' | 'HelsinkiV1' (Required): Refers to the type of the StorSimple Manager - -## ManagerSku -### Properties -* **name**: 'Standard' (Required): Refers to the sku name which should be "Standard" - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AccessControlRecordProperties ### Properties * **initiatorName**: string (Required): The Iscsi initiator name (IQN) -## RawCertificateData -### Properties -* **authType**: 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid': Specify the Authentication type -* **certificate**: string (Required): Gets or sets the base64 encoded certificate raw data string - ## AlertSettingsProperties ### Properties * **additionalRecipientEmailList**: string[]: List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent @@ -157,25 +133,20 @@ * **emailNotification**: 'Disabled' | 'Enabled' (Required): Value indicating whether user/admins will receive emails when an alert condition occurs on the system * **notificationToServiceOwners**: 'Disabled' | 'Enabled' (Required): Value indicating whether service owners will receive emails when an alert condition occurs on the system. Applicable only if emailNotification flag is Enabled. -## BackupScheduleGroupProperties +## AsymmetricEncryptedSecret ### Properties -* **startTime**: [Time](#time) (Required): The Time. +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' (Required): Algorithm used to encrypt "Value" +* **encryptionCertificateThumbprint**: string: Thumbprint certificate that was used to encrypt "Value" +* **value**: string (Required): The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. -## Time +## BackupScheduleGroupProperties ### Properties -* **hour**: int (Required): The hour. -* **minute**: int (Required): The minute. +* **startTime**: [Time](#time) (Required): The Time. ## ChapProperties ### Properties * **password**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret) (Required): 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. -## AsymmetricEncryptedSecret -### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' (Required): Algorithm used to encrypt "Value" -* **encryptionCertificateThumbprint**: string: Thumbprint certificate that was used to encrypt "Value" -* **value**: string (Required): The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null. - ## FileServerProperties ### Properties * **backupScheduleGroupId**: string (Required): The backup policy id. @@ -194,14 +165,6 @@ * **shareStatus**: 'Offline' | 'Online' (Required): The Share Status * **usedCapacityInBytes**: int (ReadOnly): The used capacity in Bytes. -## IscsiServerProperties -### Properties -* **backupScheduleGroupId**: string (Required): The backup policy id. -* **chapId**: string: The chap id. -* **description**: string: The description. -* **reverseChapId**: string: The reverse chap id. -* **storageDomainId**: string (Required): The storage domain id. - ## IscsiDiskProperties ### Properties * **accessControlRecords**: string[] (Required): The access control records. @@ -213,6 +176,14 @@ * **provisionedCapacityInBytes**: int (Required): The provisioned capacity in bytes. * **usedCapacityInBytes**: int (ReadOnly): The used capacity in bytes. +## IscsiServerProperties +### Properties +* **backupScheduleGroupId**: string (Required): The backup policy id. +* **chapId**: string: The chap id. +* **description**: string: The description. +* **reverseChapId**: string: The reverse chap id. +* **storageDomainId**: string (Required): The storage domain id. + ## ManagerExtendedInfoProperties ### Properties * **algorithm**: string (Required): Represents the encryption algorithm used to encrypt the other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used @@ -222,6 +193,30 @@ * **portalCertificateThumbprint**: string: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. * **version**: string: Represents the version of the ExtendedInfo object being persisted +## ManagerIntrinsicSettings +### Properties +* **type**: 'GardaV1' | 'HelsinkiV1' (Required): Refers to the type of the StorSimple Manager + +## ManagerProperties +### Properties +* **cisIntrinsicSettings**: [ManagerIntrinsicSettings](#managerintrinsicsettings): Intrinsic settings which refers to the type of the StorSimple manager +* **provisioningState**: string (ReadOnly): Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created +* **sku**: [ManagerSku](#managersku): The Sku. + +## ManagerSku +### Properties +* **name**: 'Standard' (Required): Refers to the sku name which should be "Standard" + +## RawCertificateData +### Properties +* **authType**: 'AccessControlService' | 'AzureActiveDirectory' | 'Invalid': Specify the Authentication type +* **certificate**: string (Required): Gets or sets the base64 encoded certificate raw data string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## StorageAccountCredentialProperties ### Properties * **accessKey**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): 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. @@ -237,3 +232,8 @@ * **encryptionStatus**: 'Disabled' | 'Enabled' (Required): The encryption status which indicates if encryption is enabled or not. * **storageAccountCredentialIds**: string[] (Required): The storage account credentials. +## Time +### Properties +* **hour**: int (Required): The hour. +* **minute**: int (Required): The minute. + diff --git a/generated/storsimple8000series/log.out b/generated/storsimple8000series/log.out index b050929f32..9c8c1325c4 100644 --- a/generated/storsimple8000series/log.out +++ b/generated/storsimple8000series/log.out @@ -4,12 +4,12 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.storsimple-2017-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 18ms -info | Autorest completed in 9.03s. 2 files generated. +info | Autorest completed in 8.81s. 2 files generated. diff --git a/generated/storsimple8000series/microsoft.storsimple/2017-06-01/types.md b/generated/storsimple8000series/microsoft.storsimple/2017-06-01/types.md index a3f7fa34d5..90cadb52d3 100644 --- a/generated/storsimple8000series/microsoft.storsimple/2017-06-01/types.md +++ b/generated/storsimple8000series/microsoft.storsimple/2017-06-01/types.md @@ -134,48 +134,11 @@ * **ApiVersion**: 2017-06-01 * **Output**: [SymmetricEncryptedSecret](#symmetricencryptedsecret) -## ManagerProperties -### Properties -* **cisIntrinsicSettings**: [ManagerIntrinsicSettings](#managerintrinsicsettings): Intrinsic settings which refers to the type of the StorSimple Manager. -* **provisioningState**: string: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. -* **sku**: [ManagerSku](#managersku): The Sku. - -## ManagerIntrinsicSettings -### Properties -* **type**: 'GardaV1' | 'HelsinkiV1' (Required): The type of StorSimple Manager. - -## ManagerSku -### Properties -* **name**: 'Standard' (Required): Refers to the sku name which should be "Standard" - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AccessControlRecordProperties ### Properties * **initiatorName**: string (Required): The iSCSI initiator name (IQN). * **volumeCount**: int (ReadOnly): The number of volumes using the access control record. -## BandwidthRateSettingProperties -### Properties -* **schedules**: [BandwidthSchedule](#bandwidthschedule)[] (Required): The schedules. -* **volumeCount**: int (ReadOnly): The number of volumes that uses the bandwidth setting. - -## BandwidthSchedule -### Properties -* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[] (Required): The days of the week when this schedule is applicable. -* **rateInMbps**: int (Required): The rate in Mbps. -* **start**: [Time](#time) (Required): The time. -* **stop**: [Time](#time) (Required): The time. - -## Time -### Properties -* **hours**: int (Required): The hour. -* **minutes**: int (Required): The minute. -* **seconds**: int (Required): The second. - ## AlertNotificationProperties ### Properties * **additionalRecipientEmailList**: string[]: The alert notification email list. @@ -183,6 +146,12 @@ * **emailNotification**: 'Disabled' | 'Enabled' (Required): Indicates whether email notification enabled or not. * **notificationToServiceOwners**: 'Disabled' | 'Enabled': Indicates whether email notification enabled or not. +## AsymmetricEncryptedSecret +### Properties +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' (Required): The algorithm used to encrypt "Value". +* **encryptionCertThumbprint**: string: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. +* **value**: string (Required): The value of the secret. + ## BackupPolicyProperties ### Properties * **backupPolicyCreationType**: 'BySSM' | 'BySaaS' (ReadOnly): The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager. @@ -202,46 +171,57 @@ * **scheduleStatus**: 'Disabled' | 'Enabled' (Required): The schedule status. * **startTime**: string (Required): The start time of the schedule. -## ScheduleRecurrence +## BandwidthRateSettingProperties ### Properties -* **recurrenceType**: 'Daily' | 'Hourly' | 'Minutes' | 'Weekly' (Required): The recurrence type. -* **recurrenceValue**: int (Required): The recurrence value. -* **weeklyDaysList**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The week days list. Applicable only for schedules of recurrence type 'weekly'. +* **schedules**: [BandwidthSchedule](#bandwidthschedule)[] (Required): The schedules. +* **volumeCount**: int (ReadOnly): The number of volumes that uses the bandwidth setting. -## TimeSettingsProperties +## BandwidthSchedule ### Properties -* **primaryTimeServer**: string: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'. -* **secondaryTimeServer**: string[]: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional. -* **timeZone**: string (Required): The timezone of device, like '(UTC -06:00) Central America' +* **days**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[] (Required): The days of the week when this schedule is applicable. +* **rateInMbps**: int (Required): The rate in Mbps. +* **start**: [Time](#time) (Required): The time. +* **stop**: [Time](#time) (Required): The time. -## VolumeContainerProperties +## FailoverSet ### Properties -* **bandWidthRateInMbps**: int: The bandwidth-rate set on the volume container. -* **bandwidthSettingId**: string: The ID of the bandwidth setting associated with the volume container. -* **encryptionKey**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. -* **encryptionStatus**: 'Disabled' | 'Enabled' (ReadOnly): The encryption status to indicates if encryption is enabled or not. -* **ownerShipStatus**: 'NotOwned' | 'Owned' (ReadOnly): The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. -* **storageAccountCredentialId**: string (Required): The path ID of storage account associated with the volume container. -* **totalCloudStorageUsageInBytes**: int (ReadOnly): The total cloud storage for the volume container. -* **volumeCount**: int (ReadOnly): The number of volumes in the volume Container. +* **eligibilityResult**: [FailoverSetEligibilityResult](#failoverseteligibilityresult) (ReadOnly): The eligibility result of failover set, for failover. +* **volumeContainers**: [VolumeContainerFailoverMetadata](#volumecontainerfailovermetadata)[] (ReadOnly): The list of meta data of volume containers, which are part of the failover set. -## AsymmetricEncryptedSecret +## FailoverSetEligibilityResult ### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' (Required): The algorithm used to encrypt "Value". -* **encryptionCertThumbprint**: string: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null. -* **value**: string (Required): The value of the secret. +* **errorMessage**: string (ReadOnly): The error message, if the failover set is not eligible for failover. +* **isEligibleForFailover**: bool (ReadOnly): Represents if this failover set is eligible for failover or not. -## VolumeProperties +## FailoverSetsList ### Properties -* **accessControlRecordIds**: string[] (Required): The IDs of the access control records, associated with the volume. -* **backupPolicyIds**: string[] (ReadOnly): The IDs of the backup policies, in which this volume is part of. -* **backupStatus**: 'Disabled' | 'Enabled' (ReadOnly): The backup status of the volume. -* **monitoringStatus**: 'Disabled' | 'Enabled' (Required): The monitoring status of the volume. -* **operationStatus**: 'Deleting' | 'None' | 'Restoring' | 'Updating' (ReadOnly): The operation status on the volume. -* **sizeInBytes**: int (Required): The size of the volume in bytes. -* **volumeContainerId**: string (ReadOnly): The ID of the volume container, in which this volume is created. -* **volumeStatus**: 'Offline' | 'Online' (Required): The volume status. -* **volumeType**: 'Archival' | 'LocallyPinned' | 'Tiered' (Required): The volume type. +* **value**: [FailoverSet](#failoverset)[] (ReadOnly): The list of failover sets. + +## FailoverTarget +### Properties +* **availableLocalStorageInBytes**: int (ReadOnly): The amount of free local storage available on the device in bytes. +* **availableTieredStorageInBytes**: int (ReadOnly): The amount of free tiered storage available for the device in bytes. +* **dataContainersCount**: int (ReadOnly): The count of data containers on the device. +* **deviceId**: string (ReadOnly): The path ID of the device. +* **deviceLocation**: string (ReadOnly): The geo location (applicable only for cloud appliances) of the device. +* **deviceSoftwareVersion**: string (ReadOnly): The software version of the device. +* **deviceStatus**: 'Creating' | 'Deactivated' | 'Deactivating' | 'Deleted' | 'MaintenanceMode' | 'Offline' | 'Online' | 'Provisioning' | 'ReadyToSetup' | 'RequiresAttention' | 'Unknown' (ReadOnly): The current status of the device. +* **eligibilityResult**: [TargetEligibilityResult](#targeteligibilityresult) (ReadOnly): The eligibility result of device, as a failover target device. +* **friendlyDeviceSoftwareVersion**: string (ReadOnly): The friendly name for the current version of software on the device. +* **modelDescription**: string (ReadOnly): The model number of the device. +* **volumesCount**: int (ReadOnly): The count of volumes on the device. + +## FailoverTargetsList +### Properties +* **value**: [FailoverTarget](#failovertarget)[] (ReadOnly): The list of all the failover targets. + +## Key +### Properties +* **activationKey**: string (ReadOnly): The activation key for the device. + +## ListFailoverTargetsRequest +### Properties +* **volumeContainers**: string[] (WriteOnly): The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets. ## ManagerExtendedInfoProperties ### Properties @@ -252,6 +232,31 @@ * **portalCertificateThumbprint**: string: Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it. * **version**: string: The version of the extended info being persisted. +## ManagerIntrinsicSettings +### Properties +* **type**: 'GardaV1' | 'HelsinkiV1' (Required): The type of StorSimple Manager. + +## ManagerProperties +### Properties +* **cisIntrinsicSettings**: [ManagerIntrinsicSettings](#managerintrinsicsettings): Intrinsic settings which refers to the type of the StorSimple Manager. +* **provisioningState**: string: Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created. +* **sku**: [ManagerSku](#managersku): The Sku. + +## ManagerSku +### Properties +* **name**: 'Standard' (Required): Refers to the sku name which should be "Standard" + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ScheduleRecurrence +### Properties +* **recurrenceType**: 'Daily' | 'Hourly' | 'Minutes' | 'Weekly' (Required): The recurrence type. +* **recurrenceValue**: int (Required): The recurrence value. +* **weeklyDaysList**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday'[]: The week days list. Applicable only for schedules of recurrence type 'weekly'. + ## StorageAccountCredentialProperties ### Properties * **accessKey**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. @@ -259,29 +264,51 @@ * **sslStatus**: 'Disabled' | 'Enabled' (Required): Signifies whether SSL needs to be enabled or not. * **volumesCount**: int (ReadOnly): The count of volumes using this storage account credential. -## Key +## SymmetricEncryptedSecret ### Properties -* **activationKey**: string (ReadOnly): The activation key for the device. +* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' (ReadOnly): The algorithm used to encrypt "Value". +* **value**: string (ReadOnly): The value of the secret itself. If the secret is in plaintext or null then EncryptionAlgorithm will be none. +* **valueCertificateThumbprint**: string (ReadOnly): The thumbprint of the cert that was used to encrypt "Value". -## FailoverSetsList +## TargetEligibilityErrorMessage ### Properties -* **value**: [FailoverSet](#failoverset)[] (ReadOnly): The list of failover sets. +* **message**: string (ReadOnly): The localized error message stating the reason why the device is not eligible as a target device. +* **resolution**: string (ReadOnly): The localized resolution message for the error. +* **resultCode**: 'LocalToTieredVolumesConversionWarning' | 'TargetAndSourceCannotBeSameError' | 'TargetInsufficientCapacityError' | 'TargetInsufficientLocalVolumeMemoryError' | 'TargetInsufficientTieredVolumeMemoryError' | 'TargetIsNotOnlineError' | 'TargetSourceIncompatibleVersionError' (ReadOnly): The result code for the error, due to which the device does not qualify as a failover target device. -## FailoverSet +## TargetEligibilityResult ### Properties -* **eligibilityResult**: [FailoverSetEligibilityResult](#failoverseteligibilityresult) (ReadOnly): The eligibility result of failover set, for failover. -* **volumeContainers**: [VolumeContainerFailoverMetadata](#volumecontainerfailovermetadata)[] (ReadOnly): The list of meta data of volume containers, which are part of the failover set. +* **eligibilityStatus**: 'Eligible' | 'NotEligible' (ReadOnly): The eligibility status of device, as a failover target device. +* **messages**: [TargetEligibilityErrorMessage](#targeteligibilityerrormessage)[] (ReadOnly): The list of error messages, if a device does not qualify as a failover target device. -## FailoverSetEligibilityResult +## Time ### Properties -* **errorMessage**: string (ReadOnly): The error message, if the failover set is not eligible for failover. -* **isEligibleForFailover**: bool (ReadOnly): Represents if this failover set is eligible for failover or not. +* **hours**: int (Required): The hour. +* **minutes**: int (Required): The minute. +* **seconds**: int (Required): The second. + +## TimeSettingsProperties +### Properties +* **primaryTimeServer**: string: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'. +* **secondaryTimeServer**: string[]: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional. +* **timeZone**: string (Required): The timezone of device, like '(UTC -06:00) Central America' ## VolumeContainerFailoverMetadata ### Properties * **volumeContainerId**: string (ReadOnly): The path ID of the volume container. * **volumes**: [VolumeFailoverMetadata](#volumefailovermetadata)[] (ReadOnly): The list of metadata of volumes inside the volume container, which contains valid cloud snapshots. +## VolumeContainerProperties +### Properties +* **bandWidthRateInMbps**: int: The bandwidth-rate set on the volume container. +* **bandwidthSettingId**: string: The ID of the bandwidth setting associated with the volume container. +* **encryptionKey**: [AsymmetricEncryptedSecret](#asymmetricencryptedsecret): Represent the secrets intended for encryption with asymmetric key pair. +* **encryptionStatus**: 'Disabled' | 'Enabled' (ReadOnly): The encryption status to indicates if encryption is enabled or not. +* **ownerShipStatus**: 'NotOwned' | 'Owned' (ReadOnly): The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. +* **storageAccountCredentialId**: string (Required): The path ID of storage account associated with the volume container. +* **totalCloudStorageUsageInBytes**: int (ReadOnly): The total cloud storage for the volume container. +* **volumeCount**: int (ReadOnly): The number of volumes in the volume Container. + ## VolumeFailoverMetadata ### Properties * **backupCreatedDate**: string (ReadOnly): The date at which the snapshot was taken. @@ -292,42 +319,15 @@ * **volumeId**: string (ReadOnly): The path ID of the volume. * **volumeType**: 'Archival' | 'LocallyPinned' | 'Tiered' (ReadOnly): The volume type. -## ListFailoverTargetsRequest -### Properties -* **volumeContainers**: string[] (WriteOnly): The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets. - -## FailoverTargetsList -### Properties -* **value**: [FailoverTarget](#failovertarget)[] (ReadOnly): The list of all the failover targets. - -## FailoverTarget -### Properties -* **availableLocalStorageInBytes**: int (ReadOnly): The amount of free local storage available on the device in bytes. -* **availableTieredStorageInBytes**: int (ReadOnly): The amount of free tiered storage available for the device in bytes. -* **dataContainersCount**: int (ReadOnly): The count of data containers on the device. -* **deviceId**: string (ReadOnly): The path ID of the device. -* **deviceLocation**: string (ReadOnly): The geo location (applicable only for cloud appliances) of the device. -* **deviceSoftwareVersion**: string (ReadOnly): The software version of the device. -* **deviceStatus**: 'Creating' | 'Deactivated' | 'Deactivating' | 'Deleted' | 'MaintenanceMode' | 'Offline' | 'Online' | 'Provisioning' | 'ReadyToSetup' | 'RequiresAttention' | 'Unknown' (ReadOnly): The current status of the device. -* **eligibilityResult**: [TargetEligibilityResult](#targeteligibilityresult) (ReadOnly): The eligibility result of device, as a failover target device. -* **friendlyDeviceSoftwareVersion**: string (ReadOnly): The friendly name for the current version of software on the device. -* **modelDescription**: string (ReadOnly): The model number of the device. -* **volumesCount**: int (ReadOnly): The count of volumes on the device. - -## TargetEligibilityResult -### Properties -* **eligibilityStatus**: 'Eligible' | 'NotEligible' (ReadOnly): The eligibility status of device, as a failover target device. -* **messages**: [TargetEligibilityErrorMessage](#targeteligibilityerrormessage)[] (ReadOnly): The list of error messages, if a device does not qualify as a failover target device. - -## TargetEligibilityErrorMessage -### Properties -* **message**: string (ReadOnly): The localized error message stating the reason why the device is not eligible as a target device. -* **resolution**: string (ReadOnly): The localized resolution message for the error. -* **resultCode**: 'LocalToTieredVolumesConversionWarning' | 'TargetAndSourceCannotBeSameError' | 'TargetInsufficientCapacityError' | 'TargetInsufficientLocalVolumeMemoryError' | 'TargetInsufficientTieredVolumeMemoryError' | 'TargetIsNotOnlineError' | 'TargetSourceIncompatibleVersionError' (ReadOnly): The result code for the error, due to which the device does not qualify as a failover target device. - -## SymmetricEncryptedSecret +## VolumeProperties ### Properties -* **encryptionAlgorithm**: 'AES256' | 'None' | 'RSAES_PKCS1_v_1_5' (ReadOnly): The algorithm used to encrypt "Value". -* **value**: string (ReadOnly): The value of the secret itself. If the secret is in plaintext or null then EncryptionAlgorithm will be none. -* **valueCertificateThumbprint**: string (ReadOnly): The thumbprint of the cert that was used to encrypt "Value". +* **accessControlRecordIds**: string[] (Required): The IDs of the access control records, associated with the volume. +* **backupPolicyIds**: string[] (ReadOnly): The IDs of the backup policies, in which this volume is part of. +* **backupStatus**: 'Disabled' | 'Enabled' (ReadOnly): The backup status of the volume. +* **monitoringStatus**: 'Disabled' | 'Enabled' (Required): The monitoring status of the volume. +* **operationStatus**: 'Deleting' | 'None' | 'Restoring' | 'Updating' (ReadOnly): The operation status on the volume. +* **sizeInBytes**: int (Required): The size of the volume in bytes. +* **volumeContainerId**: string (ReadOnly): The ID of the volume container, in which this volume is created. +* **volumeStatus**: 'Offline' | 'Online' (Required): The volume status. +* **volumeType**: 'Archival' | 'LocallyPinned' | 'Tiered' (Required): The volume type. diff --git a/generated/streamanalytics/log.out b/generated/streamanalytics/log.out index ee4aabc835..1e01b0880b 100644 --- a/generated/streamanalytics/log.out +++ b/generated/streamanalytics/log.out @@ -9,7 +9,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.streamanalytics-2021-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18,7 +18,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FunctionListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2021-10-01-preview/functions.json:999:5 @@ -30,7 +30,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 69ms +info | autorest.bicep took 24ms info | Processing batch task - {"tag":"microsoft.streamanalytics-2020-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -39,7 +39,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Cluster' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json:368:5 @@ -66,7 +66,7 @@ warning | PreCheck/SchemaMissingType | The schema 'PrivateLinkConnectionState' w warning | PreCheck/SchemaMissingType | The schema 'PrivateEndpointListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json:330:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.streamanalytics-2017-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -75,7 +75,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'FunctionListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json:980:5 @@ -86,7 +86,7 @@ warning | PreCheck/SchemaMissingType | The schema 'SubscriptionQuota-properties' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 10ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.streamanalytics-2020-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -95,7 +95,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubscriptionQuota-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/subscriptions.json:104:9 @@ -103,7 +103,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 15ms info | Processing batch task - {"tag":"microsoft.streamanalytics-2016-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -112,7 +112,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json:528:5 @@ -298,5 +298,5 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json:124:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 13ms -info | Autorest completed in 25.78s. 10 files generated. +info | autorest.bicep took 11ms +info | Autorest completed in 25.02s. 10 files generated. diff --git a/generated/streamanalytics/microsoft.streamanalytics/2016-03-01/types.md b/generated/streamanalytics/microsoft.streamanalytics/2016-03-01/types.md index 92573776d0..c970e7dff3 100644 --- a/generated/streamanalytics/microsoft.streamanalytics/2016-03-01/types.md +++ b/generated/streamanalytics/microsoft.streamanalytics/2016-03-01/types.md @@ -47,66 +47,16 @@ * **properties**: [TransformationProperties](#transformationproperties): The properties that are associated with a transformation. * **type**: 'Microsoft.StreamAnalytics/streamingjobs/transformations' (ReadOnly, DeployTimeConstant): The resource type -## StreamingJobProperties -### Properties -* **compatibilityLevel**: '1.0' | string: Controls certain runtime behaviors of the streaming job. -* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. -* **dataLocale**: 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. -* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **eventsLateArrivalMaxDelayInSeconds**: int: 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. -* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. -* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. -* **functions**: [Function](#function)[]: 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. -* **inputs**: [Input](#input)[]: 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. -* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. -* **jobState**: string (ReadOnly): Describes the state of the streaming job. -* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. -* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). -* **outputs**: [Output](#output)[]: 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. -* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. -* **outputStartTime**: 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. -* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. -* **sku**: [Sku](#sku): The properties that are associated with a SKU. -* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. - -## Function -### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. -* **type**: string (ReadOnly): Resource type - -## FunctionProperties -* **Discriminator**: type - -### Base Properties -* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -### ScalarFunctionProperties -#### Properties -* **properties**: [ScalarFunctionConfiguration](#scalarfunctionconfiguration): Describes the configuration of the scalar function. -* **type**: 'Scalar' (Required): Indicates the type of function. - - -## ScalarFunctionConfiguration +## AzureDataLakeStoreOutputDataSourceProperties ### Properties -* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. -* **inputs**: [FunctionInput](#functioninput)[]: A list of inputs describing the parameters of the function. -* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. - -## FunctionBinding -* **Discriminator**: type - -### Base Properties -### AzureMachineLearningWebServiceFunctionBinding -#### Properties -* **properties**: [AzureMachineLearningWebServiceFunctionBindingProperties](#azuremachinelearningwebservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. -* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. - -### JavaScriptFunctionBinding -#### Properties -* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. -* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. - +* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. +* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. +* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **refreshToken**: 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. +* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **tokenUserDisplayName**: 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. +* **tokenUserPrincipalName**: 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. ## AzureMachineLearningWebServiceFunctionBindingProperties ### Properties @@ -116,63 +66,69 @@ * **inputs**: [AzureMachineLearningWebServiceInputs](#azuremachinelearningwebserviceinputs): The inputs for the Azure Machine Learning web service endpoint. * **outputs**: [AzureMachineLearningWebServiceOutputColumn](#azuremachinelearningwebserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. -## AzureMachineLearningWebServiceInputs -### Properties -* **columnNames**: [AzureMachineLearningWebServiceInputColumn](#azuremachinelearningwebserviceinputcolumn)[]: A list of input columns for the Azure Machine Learning web service endpoint. -* **name**: string: The name of the input. This is the name provided while authoring the endpoint. - ## AzureMachineLearningWebServiceInputColumn ### Properties * **dataType**: string: 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 . * **mapTo**: int: The zero based index of the function parameter this input maps to. * **name**: string: The name of the input column. +## AzureMachineLearningWebServiceInputs +### Properties +* **columnNames**: [AzureMachineLearningWebServiceInputColumn](#azuremachinelearningwebserviceinputcolumn)[]: A list of input columns for the Azure Machine Learning web service endpoint. +* **name**: string: The name of the input. This is the name provided while authoring the endpoint. + ## AzureMachineLearningWebServiceOutputColumn ### Properties * **dataType**: string: 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 . * **name**: string: The name of the output column. -## JavaScriptFunctionBindingProperties +## AzureSqlDatabaseOutputDataSourceProperties ### Properties -* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## FunctionInput +## AzureTableOutputDataSourceProperties ### Properties -* **dataType**: string: 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 -* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **batchSize**: int: The number of rows to write to the Azure Table at a time. +* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. +* **partitionKey**: 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. +* **rowKey**: 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. +* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. -## FunctionOutput +## BlobOutputDataSourceProperties ### Properties -* **dataType**: string: 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 +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. -## Input +## BlobReferenceInputDataSourceProperties ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. -* **type**: string (ReadOnly): Resource type - -## InputProperties -* **Discriminator**: type - -### Base Properties -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -### ReferenceInputProperties -#### Properties -* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. -* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. - -### StreamInputProperties -#### Properties -* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. -* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +## BlobStreamInputDataSourceProperties +### Properties +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. -## Diagnostics +## CsvSerializationProperties ### Properties -* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **fieldDelimiter**: 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. ## DiagnosticCondition ### Properties @@ -180,77 +136,100 @@ * **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. * **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. -## Serialization +## Diagnostics +### Properties +* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. + +## DocumentDbOutputDataSourceProperties +### Properties +* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. +* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. +* **collectionNamePattern**: 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. +* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. +* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. +* **partitionKey**: 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. + +## EventHubOutputDataSourceProperties +### Properties +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. + +## EventHubStreamInputDataSourceProperties +### Properties +* **consumerGroupName**: string: 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. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. + +## Function +### Properties +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. +* **type**: string (ReadOnly): Resource type + +## FunctionBinding * **Discriminator**: type ### Base Properties -### AvroSerialization -#### Properties -* **properties**: any: Any object -* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - -### CsvSerialization +### AzureMachineLearningWebServiceFunctionBinding #### Properties -* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. -* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [AzureMachineLearningWebServiceFunctionBindingProperties](#azuremachinelearningwebservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. +* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. -### JsonSerialization +### JavaScriptFunctionBinding #### Properties -* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. -* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. +* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. -## CsvSerializationProperties +## FunctionInput ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **fieldDelimiter**: 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. +* **dataType**: string: 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 +* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. -## JsonSerializationProperties +## FunctionOutput ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **format**: 'Array' | 'LineSeparated' | string: 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. +* **dataType**: string: 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 -## ReferenceInputDataSource +## FunctionProperties * **Discriminator**: type ### Base Properties -### BlobReferenceInputDataSource +* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +### ScalarFunctionProperties #### Properties -* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. - +* **properties**: [ScalarFunctionConfiguration](#scalarfunctionconfiguration): Describes the configuration of the scalar function. +* **type**: 'Scalar' (Required): Indicates the type of function. -## BlobReferenceInputDataSourceProperties -### Properties -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. -## StorageAccount +## Input ### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. +* **type**: string (ReadOnly): Resource type -## StreamInputDataSource +## InputProperties * **Discriminator**: type ### Base Properties -### IoTHubStreamInputDataSource -#### Properties -* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. -* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubStreamInputDataSource +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +### ReferenceInputProperties #### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. +* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. -### BlobStreamInputDataSource +### StreamInputProperties #### Properties -* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. +* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. ## IoTHubStreamInputDataSourceProperties @@ -261,22 +240,14 @@ * **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. * **sharedAccessPolicyName**: 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. -## EventHubStreamInputDataSourceProperties +## JavaScriptFunctionBindingProperties ### Properties -* **consumerGroupName**: string: 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. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' -## BlobStreamInputDataSourceProperties +## JsonSerializationProperties ### Properties -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **format**: 'Array' | 'LineSeparated' | string: 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. ## Output ### Properties @@ -285,13 +256,6 @@ * **properties**: [OutputProperties](#outputproperties): The properties that are associated with an output. * **type**: string (ReadOnly): Resource type -## OutputProperties -### Properties -* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. - ## OutputDataSource * **Discriminator**: type @@ -342,24 +306,58 @@ * **type**: 'PowerBI' (Required): Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. -## AzureDataLakeStoreOutputDataSourceProperties +## OutputProperties ### Properties -* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. -* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. -* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. + +## PowerBIOutputDataSourceProperties +### Properties +* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. +* **groupId**: string: The ID of the Power BI group. +* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. * **refreshToken**: 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. -* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. * **tokenUserDisplayName**: 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. * **tokenUserPrincipalName**: 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. -## EventHubOutputDataSourceProperties +## ReferenceInputDataSource +* **Discriminator**: type + +### Base Properties +### BlobReferenceInputDataSource +#### Properties +* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + + +## ScalarFunctionConfiguration ### Properties -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. +* **inputs**: [FunctionInput](#functioninput)[]: A list of inputs describing the parameters of the function. +* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. + +## Serialization +* **Discriminator**: type + +### Base Properties +### AvroSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### CsvSerialization +#### Properties +* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. +* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### JsonSerialization +#### Properties +* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. +* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + ## ServiceBusQueueOutputDataSourceProperties ### Properties @@ -377,54 +375,61 @@ * **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. * **topicName**: string: The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests. -## AzureSqlDatabaseOutputDataSourceProperties -### Properties -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. - -## BlobOutputDataSourceProperties -### Properties -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. - -## DocumentDbOutputDataSourceProperties +## Sku ### Properties -* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. -* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. -* **collectionNamePattern**: 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. -* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. -* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. -* **partitionKey**: 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. +* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. -## AzureTableOutputDataSourceProperties +## StorageAccount ### Properties * **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. * **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **batchSize**: int: The number of rows to write to the Azure Table at a time. -* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. -* **partitionKey**: 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. -* **rowKey**: 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. -* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. -## PowerBIOutputDataSourceProperties +## StreamingJobProperties ### Properties -* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. -* **groupId**: string: The ID of the Power BI group. -* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. -* **refreshToken**: 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. -* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. -* **tokenUserDisplayName**: 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. -* **tokenUserPrincipalName**: 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. +* **compatibilityLevel**: '1.0' | string: Controls certain runtime behaviors of the streaming job. +* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. +* **dataLocale**: 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. +* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **eventsLateArrivalMaxDelayInSeconds**: int: 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. +* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. +* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. +* **functions**: [Function](#function)[]: 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. +* **inputs**: [Input](#input)[]: 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. +* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. +* **jobState**: string (ReadOnly): Describes the state of the streaming job. +* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. +* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). +* **outputs**: [Output](#output)[]: 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. +* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. +* **outputStartTime**: 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. +* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. +* **sku**: [Sku](#sku): The properties that are associated with a SKU. +* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. -## Sku +## StreamInputDataSource +* **Discriminator**: type + +### Base Properties +### IoTHubStreamInputDataSource +#### Properties +* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. +* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + +### EventHubStreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + +### BlobStreamInputDataSource +#### Properties +* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + + +## TrackedResourceTags ### Properties -* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. +### Additional Properties +* **Additional Properties Type**: string ## Transformation ### Properties @@ -439,8 +444,3 @@ * **query**: string: 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. * **streamingUnits**: int: Specifies the number of streaming units that the streaming job uses. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.md b/generated/streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.md index d81efb5355..296570d654 100644 --- a/generated/streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.md +++ b/generated/streamanalytics/microsoft.streamanalytics/2017-04-01-preview/types.md @@ -48,106 +48,46 @@ * **properties**: [TransformationProperties](#transformationproperties): The properties that are associated with a transformation. * **type**: 'Microsoft.StreamAnalytics/streamingjobs/transformations' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string -* **tenantId**: string -* **type**: string - -## StreamingJobProperties -### Properties -* **cluster**: [ClusterInfo](#clusterinfo): The properties associated with a Stream Analytics cluster. -* **compatibilityLevel**: '1.0' | string: Controls certain runtime behaviors of the streaming job. -* **contentStoragePolicy**: 'JobStorageAccount' | 'SystemAccount' | string: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. . -* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. -* **dataLocale**: 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. -* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **eventsLateArrivalMaxDelayInSeconds**: int: 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. -* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. -* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. -* **externals**: [External](#external): The storage account where the custom code artifacts are located. -* **functions**: [Function](#function)[]: 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. -* **inputs**: [Input](#input)[]: 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. -* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. -* **jobState**: string (ReadOnly): Describes the state of the streaming job. -* **jobStorageAccount**: [JobStorageAccount](#jobstorageaccount): The properties that are associated with an Azure Storage account with MSI -* **jobType**: 'Cloud' | 'Edge' | string: Describes the type of the job. Valid modes are `Cloud` and 'Edge'. -* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. -* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). -* **outputs**: [Output](#output)[]: 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. -* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. -* **outputStartTime**: 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. -* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. -* **sku**: [StreamingJobSku](#streamingjobsku): The properties that are associated with a SKU. -* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. - -## ClusterInfo +## AzureDataLakeStoreOutputDataSourceProperties ### Properties -* **id**: string: The resource id of cluster. +* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. +* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **refreshToken**: 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. +* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **tokenUserDisplayName**: 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. +* **tokenUserPrincipalName**: 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. -## External +## AzureFunctionOutputDataSourceProperties ### Properties -* **container**: string -* **path**: string -* **storageAccount**: [StorageAccount](#storageaccount): The properties that are associated with an Azure Storage account +* **apiKey**: string: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. +* **functionAppName**: string: The name of your Azure Functions app. +* **functionName**: string: The name of the function in your Azure Functions app. +* **maxBatchCount**: int: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. +* **maxBatchSize**: int: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). -## StorageAccount +## AzureMachineLearningServiceFunctionBindingProperties ### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **apiKey**: string: The API key used to authenticate with Request-Response endpoint. +* **batchSize**: int: Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. +* **endpoint**: string: The Request-Response execute endpoint of the Azure Machine Learning web service. +* **inputs**: [AzureMachineLearningServiceInputColumn](#azuremachinelearningserviceinputcolumn)[]: The inputs for the Azure Machine Learning web service endpoint. +* **numberOfParallelRequests**: int: The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1. +* **outputs**: [AzureMachineLearningServiceOutputColumn](#azuremachinelearningserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. -## Function +## AzureMachineLearningServiceInputColumn ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. -* **type**: string (ReadOnly): Resource type - -## FunctionProperties -* **Discriminator**: type - -### Base Properties -* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **properties**: [FunctionConfiguration](#functionconfiguration) -### AggregateFunctionProperties -#### Properties -* **type**: 'Aggregate' (Required): Indicates the type of function. - -### ScalarFunctionProperties -#### Properties -* **type**: 'Scalar' (Required): Indicates the type of function. - +* **dataType**: string: The (Azure Machine Learning supported) data type of the input column. +* **mapTo**: int: The zero based index of the function parameter this input maps to. +* **name**: string: The name of the input column. -## FunctionConfiguration +## AzureMachineLearningServiceOutputColumn ### Properties -* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. -* **inputs**: [FunctionInput](#functioninput)[]: Array of FunctionInput -* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. - -## FunctionBinding -* **Discriminator**: type - -### Base Properties -### AzureMachineLearningStudioFunctionBinding -#### Properties -* **properties**: [AzureMachineLearningStudioFunctionBindingProperties](#azuremachinelearningstudiofunctionbindingproperties): The binding properties associated with an Azure Machine learning Studio. -* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. - -### AzureMachineLearningServiceFunctionBinding -#### Properties -* **properties**: [AzureMachineLearningServiceFunctionBindingProperties](#azuremachinelearningservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. -* **type**: 'Microsoft.MachineLearningServices' (Required): Indicates the function binding type. - -### CSharpFunctionBinding -#### Properties -* **properties**: [CSharpFunctionBindingProperties](#csharpfunctionbindingproperties): The binding properties associated with a CSharp function. -* **type**: 'Microsoft.StreamAnalytics/CLRUdf' (Required): Indicates the function binding type. - -### JavaScriptFunctionBinding -#### Properties -* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. -* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. - +* **dataType**: string: The (Azure Machine Learning supported) data type of the output column. +* **mapTo**: int: The zero based index of the function parameter this input maps to. +* **name**: string: The name of the output column. ## AzureMachineLearningStudioFunctionBindingProperties ### Properties @@ -157,42 +97,98 @@ * **inputs**: [AzureMachineLearningStudioInputs](#azuremachinelearningstudioinputs): The inputs for the Azure Machine Learning Studio endpoint. * **outputs**: [AzureMachineLearningStudioOutputColumn](#azuremachinelearningstudiooutputcolumn)[]: A list of outputs from the Azure Machine Learning Studio endpoint execution. -## AzureMachineLearningStudioInputs -### Properties -* **columnNames**: [AzureMachineLearningStudioInputColumn](#azuremachinelearningstudioinputcolumn)[]: A list of input columns for the Azure Machine Learning Studio endpoint. -* **name**: string: The name of the input. This is the name provided while authoring the endpoint. - ## AzureMachineLearningStudioInputColumn ### Properties * **dataType**: string: 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 . * **mapTo**: int: The zero based index of the function parameter this input maps to. * **name**: string: The name of the input column. +## AzureMachineLearningStudioInputs +### Properties +* **columnNames**: [AzureMachineLearningStudioInputColumn](#azuremachinelearningstudioinputcolumn)[]: A list of input columns for the Azure Machine Learning Studio endpoint. +* **name**: string: The name of the input. This is the name provided while authoring the endpoint. + ## AzureMachineLearningStudioOutputColumn ### Properties * **dataType**: string: 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 . * **name**: string: The name of the output column. -## AzureMachineLearningServiceFunctionBindingProperties +## AzureSqlDatabaseOutputDataSourceProperties ### Properties -* **apiKey**: string: The API key used to authenticate with Request-Response endpoint. -* **batchSize**: int: Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. -* **endpoint**: string: The Request-Response execute endpoint of the Azure Machine Learning web service. -* **inputs**: [AzureMachineLearningServiceInputColumn](#azuremachinelearningserviceinputcolumn)[]: The inputs for the Azure Machine Learning web service endpoint. -* **numberOfParallelRequests**: int: The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1. -* **outputs**: [AzureMachineLearningServiceOutputColumn](#azuremachinelearningserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **maxBatchCount**: int: Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. +* **maxWriterCount**: int: Max Write r count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## AzureMachineLearningServiceInputColumn +## AzureSqlReferenceInputDataSourceProperties ### Properties -* **dataType**: string: The (Azure Machine Learning supported) data type of the input column. -* **mapTo**: int: The zero based index of the function parameter this input maps to. -* **name**: string: The name of the input column. +* **database**: string: This element is associated with the datasource element. This is the name of the database that output will be written to. +* **deltaSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. +* **fullSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch data from the sql database. +* **password**: string: This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. +* **refreshRate**: string: This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. +* **refreshType**: string: This element is associated with the datasource element. This element is of enum type. It indicates what kind of data refresh option do we want to use:Static/RefreshPeriodicallyWithFull/RefreshPeriodicallyWithDelta +* **server**: string: This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. +* **table**: string: This element is associated with the datasource element. The name of the table in the Azure SQL database.. +* **user**: string: This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. -## AzureMachineLearningServiceOutputColumn +## AzureSynapseOutputDataSourceProperties ### Properties -* **dataType**: string: The (Azure Machine Learning supported) data type of the output column. -* **mapTo**: int: The zero based index of the function parameter this input maps to. -* **name**: string: The name of the output column. +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. + +## AzureTableOutputDataSourceProperties +### Properties +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **batchSize**: int: The number of rows to write to the Azure Table at a time. +* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. +* **partitionKey**: 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. +* **rowKey**: 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. +* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. + +## BlobOutputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## BlobReferenceInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## BlobStreamInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## ClusterInfo +### Properties +* **id**: string: The resource id of cluster. + +## Compression +### Properties +* **type**: string (Required) ## CSharpFunctionBindingProperties ### Properties @@ -201,179 +197,153 @@ * **method**: string: The Csharp code containing a single function definition. * **script**: string: The Csharp code containing a single function definition. -## JavaScriptFunctionBindingProperties +## CsvSerializationProperties ### Properties -* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **fieldDelimiter**: 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. -## FunctionInput +## CustomClrSerializationProperties ### Properties -* **dataType**: string: 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 -* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. +* **serializationClassName**: string: The serialization class name. +* **serializationDllPath**: string: The serialization library path. -## FunctionOutput +## DiagnosticCondition ### Properties -* **dataType**: string: 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 +* **code**: string (ReadOnly): The opaque diagnostic code. +* **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. +* **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. -## Input +## Diagnostics ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. -* **type**: string (ReadOnly): Resource type - -## InputProperties -* **Discriminator**: type - -### Base Properties -* **compression**: [Compression](#compression): Describes how input data is compressed -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **partitionKey**: string: partitionKey Describes a key in the input data which is used for partitioning the input data -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -### ReferenceInputProperties -#### Properties -* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. -* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. +* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. -### StreamInputProperties -#### Properties -* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. -* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. +## DocumentDbOutputDataSourceProperties +### Properties +* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. +* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. +* **collectionNamePattern**: 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. +* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. +* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. +* **partitionKey**: 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. +## EventHubOutputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. +* **propertyColumns**: string[]: Array of EventHubOutputDataSourcePropertiesPropertyColumnsItem +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -## Compression +## EventHubStreamInputDataSourceProperties ### Properties -* **type**: string (Required) +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **consumerGroupName**: string: 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. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -## Diagnostics +## External ### Properties -* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. +* **container**: string +* **path**: string +* **storageAccount**: [StorageAccount](#storageaccount): The properties that are associated with an Azure Storage account -## DiagnosticCondition +## Function ### Properties -* **code**: string (ReadOnly): The opaque diagnostic code. -* **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. -* **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. +* **type**: string (ReadOnly): Resource type -## Serialization +## FunctionBinding * **Discriminator**: type ### Base Properties -### AvroSerialization -#### Properties -* **properties**: any: Any object -* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - -### CsvSerialization +### AzureMachineLearningStudioFunctionBinding #### Properties -* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. -* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [AzureMachineLearningStudioFunctionBindingProperties](#azuremachinelearningstudiofunctionbindingproperties): The binding properties associated with an Azure Machine learning Studio. +* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. -### CustomClrSerialization +### AzureMachineLearningServiceFunctionBinding #### Properties -* **properties**: [CustomClrSerializationProperties](#customclrserializationproperties): The properties that are associated with the CustomClr serialization type. -* **type**: 'CustomClr' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [AzureMachineLearningServiceFunctionBindingProperties](#azuremachinelearningservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. +* **type**: 'Microsoft.MachineLearningServices' (Required): Indicates the function binding type. -### JsonSerialization +### CSharpFunctionBinding #### Properties -* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. -* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [CSharpFunctionBindingProperties](#csharpfunctionbindingproperties): The binding properties associated with a CSharp function. +* **type**: 'Microsoft.StreamAnalytics/CLRUdf' (Required): Indicates the function binding type. -### ParquetSerialization +### JavaScriptFunctionBinding #### Properties -* **properties**: any: Any object -* **type**: 'Parquet' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. +* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. -## CsvSerializationProperties +## FunctionConfiguration ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **fieldDelimiter**: 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. +* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. +* **inputs**: [FunctionInput](#functioninput)[]: Array of FunctionInput +* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. -## CustomClrSerializationProperties +## FunctionInput ### Properties -* **serializationClassName**: string: The serialization class name. -* **serializationDllPath**: string: The serialization library path. +* **dataType**: string: 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 +* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. -## JsonSerializationProperties +## FunctionOutput ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **format**: 'Array' | 'LineSeparated' | string: 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. +* **dataType**: string: 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 -## ReferenceInputDataSource +## FunctionProperties * **Discriminator**: type ### Base Properties -### AzureSqlReferenceInputDataSource -#### Properties -* **properties**: [AzureSqlReferenceInputDataSourceProperties](#azuresqlreferenceinputdatasourceproperties): Describes Azure SQL database reference input data source properties. -* **type**: 'Microsoft.Sql/Server/Database' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. - -### BlobReferenceInputDataSource +* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **properties**: [FunctionConfiguration](#functionconfiguration) +### AggregateFunctionProperties #### Properties -* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Aggregate' (Required): Indicates the type of function. -### RawReferenceInputDataSource +### ScalarFunctionProperties #### Properties -* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. -* **type**: 'Raw' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. - +* **type**: 'Scalar' (Required): Indicates the type of function. -## AzureSqlReferenceInputDataSourceProperties -### Properties -* **database**: string: This element is associated with the datasource element. This is the name of the database that output will be written to. -* **deltaSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. -* **fullSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch data from the sql database. -* **password**: string: This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. -* **refreshRate**: string: This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. -* **refreshType**: string: This element is associated with the datasource element. This element is of enum type. It indicates what kind of data refresh option do we want to use:Static/RefreshPeriodicallyWithFull/RefreshPeriodicallyWithDelta -* **server**: string: This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. -* **table**: string: This element is associated with the datasource element. The name of the table in the Azure SQL database.. -* **user**: string: This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. -## BlobReferenceInputDataSourceProperties +## Identity ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **principalId**: string +* **tenantId**: string +* **type**: string -## RawInputDatasourceProperties +## Input ### Properties -* **payload**: string: The JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. -* **payloadUri**: string: The SAS URL to a blob containing the JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. +* **type**: string (ReadOnly): Resource type -## StreamInputDataSource +## InputProperties * **Discriminator**: type ### Base Properties -### IoTHubStreamInputDataSource -#### Properties -* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. -* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubV2StreamInputDataSource -#### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.EventHub/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubStreamInputDataSource -#### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### BlobStreamInputDataSource +* **compression**: [Compression](#compression): Describes how input data is compressed +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **partitionKey**: string: partitionKey Describes a key in the input data which is used for partitioning the input data +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +### ReferenceInputProperties #### Properties -* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. +* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. -### RawStreamInputDataSource +### StreamInputProperties #### Properties -* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. -* **type**: 'Raw' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. +* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. ## IoTHubStreamInputDataSourceProperties @@ -384,24 +354,9 @@ * **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. * **sharedAccessPolicyName**: 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. -## EventHubStreamInputDataSourceProperties -### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **consumerGroupName**: string: 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. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. - -## BlobStreamInputDataSourceProperties +## JavaScriptFunctionBindingProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' ## JobStorageAccount ### Properties @@ -409,6 +364,11 @@ * **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +## JsonSerializationProperties +### Properties +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **format**: 'Array' | 'LineSeparated' | string: 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. + ## Output ### Properties * **id**: string (ReadOnly): Resource Id @@ -416,15 +376,6 @@ * **properties**: [OutputProperties](#outputproperties): The properties that are associated with an output. * **type**: string (ReadOnly): Resource type -## OutputProperties -### Properties -* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -* **sizeWindow**: int -* **timeWindow**: string - ## OutputDataSource * **Discriminator**: type @@ -495,35 +446,84 @@ * **type**: 'Raw' (Required): Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. -## AzureFunctionOutputDataSourceProperties +## OutputProperties ### Properties -* **apiKey**: string: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. -* **functionAppName**: string: The name of your Azure Functions app. -* **functionName**: string: The name of the function in your Azure Functions app. -* **maxBatchCount**: int: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. -* **maxBatchSize**: int: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). +* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +* **sizeWindow**: int +* **timeWindow**: string -## AzureDataLakeStoreOutputDataSourceProperties +## PowerBIOutputDataSourceProperties ### Properties -* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. -* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. +* **groupId**: string: The ID of the Power BI group. +* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. * **refreshToken**: 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. -* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. * **tokenUserDisplayName**: 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. * **tokenUserPrincipalName**: 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. -## EventHubOutputDataSourceProperties +## RawInputDatasourceProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. -* **propertyColumns**: string[]: Array of EventHubOutputDataSourcePropertiesPropertyColumnsItem -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **payload**: string: The JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. +* **payloadUri**: string: The SAS URL to a blob containing the JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. + +## RawOutputDatasourceProperties +### Properties +* **payloadUri**: string: The SAS URL to a blob where the output should be written. If this property is not set, output data will be written into a temporary storage, and a SAS URL to that temporary storage will be included in the result. + +## ReferenceInputDataSource +* **Discriminator**: type + +### Base Properties +### AzureSqlReferenceInputDataSource +#### Properties +* **properties**: [AzureSqlReferenceInputDataSourceProperties](#azuresqlreferenceinputdatasourceproperties): Describes Azure SQL database reference input data source properties. +* **type**: 'Microsoft.Sql/Server/Database' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + +### BlobReferenceInputDataSource +#### Properties +* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + +### RawReferenceInputDataSource +#### Properties +* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. +* **type**: 'Raw' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + + +## Serialization +* **Discriminator**: type + +### Base Properties +### AvroSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### CsvSerialization +#### Properties +* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. +* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### CustomClrSerialization +#### Properties +* **properties**: [CustomClrSerializationProperties](#customclrserializationproperties): The properties that are associated with the CustomClr serialization type. +* **type**: 'CustomClr' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### JsonSerialization +#### Properties +* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. +* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### ParquetSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Parquet' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + ## ServiceBusQueueOutputDataSourceProperties ### Properties @@ -555,71 +555,76 @@ ### Additional Properties * **Additional Properties Type**: string -## AzureSqlDatabaseOutputDataSourceProperties +## StorageAccount ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **maxBatchCount**: int: Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. -* **maxWriterCount**: int: Max Write r count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -## AzureSynapseOutputDataSourceProperties +## StreamingJobProperties ### Properties -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **cluster**: [ClusterInfo](#clusterinfo): The properties associated with a Stream Analytics cluster. +* **compatibilityLevel**: '1.0' | string: Controls certain runtime behaviors of the streaming job. +* **contentStoragePolicy**: 'JobStorageAccount' | 'SystemAccount' | string: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. . +* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. +* **dataLocale**: 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. +* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **eventsLateArrivalMaxDelayInSeconds**: int: 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. +* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. +* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. +* **externals**: [External](#external): The storage account where the custom code artifacts are located. +* **functions**: [Function](#function)[]: 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. +* **inputs**: [Input](#input)[]: 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. +* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. +* **jobState**: string (ReadOnly): Describes the state of the streaming job. +* **jobStorageAccount**: [JobStorageAccount](#jobstorageaccount): The properties that are associated with an Azure Storage account with MSI +* **jobType**: 'Cloud' | 'Edge' | string: Describes the type of the job. Valid modes are `Cloud` and 'Edge'. +* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. +* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). +* **outputs**: [Output](#output)[]: 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. +* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. +* **outputStartTime**: 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. +* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. +* **sku**: [StreamingJobSku](#streamingjobsku): The properties that are associated with a SKU. +* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. -## BlobOutputDataSourceProperties +## StreamingJobSku ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. -## DocumentDbOutputDataSourceProperties -### Properties -* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. -* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. -* **collectionNamePattern**: 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. -* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. -* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. -* **partitionKey**: 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. +## StreamInputDataSource +* **Discriminator**: type -## AzureTableOutputDataSourceProperties -### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **batchSize**: int: The number of rows to write to the Azure Table at a time. -* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. -* **partitionKey**: 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. -* **rowKey**: 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. -* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. +### Base Properties +### IoTHubStreamInputDataSource +#### Properties +* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. +* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## PowerBIOutputDataSourceProperties -### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. -* **groupId**: string: The ID of the Power BI group. -* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. -* **refreshToken**: 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. -* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. -* **tokenUserDisplayName**: 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. -* **tokenUserPrincipalName**: 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. +### EventHubV2StreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.EventHub/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## RawOutputDatasourceProperties -### Properties -* **payloadUri**: string: The SAS URL to a blob where the output should be written. If this property is not set, output data will be written into a temporary storage, and a SAS URL to that temporary storage will be included in the result. +### EventHubStreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## StreamingJobSku +### BlobStreamInputDataSource +#### Properties +* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + +### RawStreamInputDataSource +#### Properties +* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. +* **type**: 'Raw' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + + +## TrackedResourceTags ### Properties -* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. +### Additional Properties +* **Additional Properties Type**: string ## Transformation ### Properties @@ -634,8 +639,3 @@ * **query**: string: 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. * **streamingUnits**: int: Specifies the number of streaming units that the streaming job uses. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.md b/generated/streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.md index d60626459f..b4e939d260 100644 --- a/generated/streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.md +++ b/generated/streamanalytics/microsoft.streamanalytics/2020-03-01-preview/types.md @@ -28,6 +28,17 @@ * **ApiVersion**: 2020-03-01-preview * **Output**: [ClusterJobListResult](#clusterjoblistresult) +## ClusterJob +### Properties +* **id**: string (ReadOnly): Resource ID of the streaming job. +* **jobState**: 'Created' | 'Degraded' | 'Deleting' | 'Failed' | 'Restarting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The current execution state of the streaming job. +* **streamingUnits**: int (ReadOnly): The number of streaming units that are used by the streaming job. + +## ClusterJobListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to fetch the next set of streaming jobs. +* **value**: [ClusterJob](#clusterjob)[] (ReadOnly): A list of streaming jobs. + ## ClusterProperties ### Properties * **capacityAllocated**: int (ReadOnly): Represents the number of streaming units currently being used on the cluster. @@ -41,16 +52,17 @@ * **capacity**: int: Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. * **name**: 'Default' | string: Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## PrivateEndpointProperties ### Properties * **createdDate**: string (ReadOnly): The date when this private endpoint was created. * **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A list of connections to the remote resource. Immutable after it is set. +## PrivateLinkConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: string (ReadOnly): Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service. + ## PrivateLinkServiceConnection ### Properties * **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Bag of properties defining a privatelinkServiceConnection. @@ -62,20 +74,8 @@ * **privateLinkServiceId**: string: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. * **requestMessage**: string (ReadOnly): A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. -## PrivateLinkConnectionState -### Properties -* **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: string (ReadOnly): Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service. - -## ClusterJobListResult -### Properties -* **nextLink**: string (ReadOnly): The URL to fetch the next set of streaming jobs. -* **value**: [ClusterJob](#clusterjob)[] (ReadOnly): A list of streaming jobs. - -## ClusterJob +## TrackedResourceTags ### Properties -* **id**: string (ReadOnly): Resource ID of the streaming job. -* **jobState**: 'Created' | 'Degraded' | 'Deleting' | 'Failed' | 'Restarting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The current execution state of the streaming job. -* **streamingUnits**: int (ReadOnly): The number of streaming units that are used by the streaming job. +### Additional Properties +* **Additional Properties Type**: string diff --git a/generated/streamanalytics/microsoft.streamanalytics/2020-03-01/types.md b/generated/streamanalytics/microsoft.streamanalytics/2020-03-01/types.md index 95c7ac2877..8f4af405a1 100644 --- a/generated/streamanalytics/microsoft.streamanalytics/2020-03-01/types.md +++ b/generated/streamanalytics/microsoft.streamanalytics/2020-03-01/types.md @@ -76,302 +76,277 @@ * **ApiVersion**: 2020-03-01 * **Output**: [ClusterJobListResult](#clusterjoblistresult) -## ClusterProperties +## AzureDataLakeStoreOutputDataSourceProperties ### Properties -* **capacityAllocated**: int (ReadOnly): Represents the number of streaming units currently being used on the cluster. -* **capacityAssigned**: int (ReadOnly): Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated. -* **clusterId**: string (ReadOnly): Unique identifier for the cluster. -* **createdDate**: string (ReadOnly): The date this cluster was created. -* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled +* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. +* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **refreshToken**: 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. +* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **tokenUserDisplayName**: 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. +* **tokenUserPrincipalName**: 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. -## ClusterSku +## AzureFunctionOutputDataSourceProperties ### Properties -* **capacity**: int: Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. -* **name**: 'Default' | string: Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. +* **apiKey**: string: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. +* **functionAppName**: string: The name of your Azure Functions app. +* **functionName**: string: The name of the function in your Azure Functions app. +* **maxBatchCount**: int: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. +* **maxBatchSize**: int: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). -## TrackedResourceTags +## AzureMachineLearningWebServiceFunctionBindingProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **apiKey**: string: The API key used to authenticate with Request-Response endpoint. +* **batchSize**: int: Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. +* **endpoint**: 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 +* **inputs**: [AzureMachineLearningWebServiceInputs](#azuremachinelearningwebserviceinputs): The inputs for the Azure Machine Learning web service endpoint. +* **outputs**: [AzureMachineLearningWebServiceOutputColumn](#azuremachinelearningwebserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. -## PrivateEndpointProperties +## AzureMachineLearningWebServiceInputColumn ### Properties -* **createdDate**: string (ReadOnly): The date when this private endpoint was created. -* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A list of connections to the remote resource. Immutable after it is set. +* **dataType**: string: 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 . +* **mapTo**: int: The zero based index of the function parameter this input maps to. +* **name**: string: The name of the input column. -## PrivateLinkServiceConnection +## AzureMachineLearningWebServiceInputs ### Properties -* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Bag of properties defining a privatelinkServiceConnection. +* **columnNames**: [AzureMachineLearningWebServiceInputColumn](#azuremachinelearningwebserviceinputcolumn)[]: A list of input columns for the Azure Machine Learning web service endpoint. +* **name**: string: The name of the input. This is the name provided while authoring the endpoint. -## PrivateLinkServiceConnectionProperties +## AzureMachineLearningWebServiceOutputColumn ### Properties -* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests. -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): A collection of read-only information about the state of the connection to the private remote resource. -* **privateLinkServiceId**: string: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. -* **requestMessage**: string (ReadOnly): A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. +* **dataType**: string: 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 . +* **name**: string: The name of the output column. -## PrivateLinkConnectionState +## AzureSqlDatabaseOutputDataSourceProperties ### Properties -* **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string (ReadOnly): The reason for approval/rejection of the connection. -* **status**: string (ReadOnly): Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **maxBatchCount**: int: Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. +* **maxWriterCount**: int: Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## Identity +## AzureSqlReferenceInputDataSourceProperties ### Properties -* **principalId**: string: The identity principal ID -* **tenantId**: string: The identity tenantId -* **type**: string: The identity type +* **database**: string: This element is associated with the datasource element. This is the name of the database that output will be written to. +* **deltaSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. +* **fullSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch data from the sql database. +* **password**: string: This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. +* **refreshRate**: string: This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. +* **refreshType**: 'RefreshPeriodicallyWithDelta' | 'RefreshPeriodicallyWithFull' | 'Static' | string: Indicates the type of data refresh option. +* **server**: string: This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. +* **table**: string: This element is associated with the datasource element. The name of the table in the Azure SQL database.. +* **user**: string: This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. -## StreamingJobProperties +## AzureSynapseOutputDataSourceProperties ### Properties -* **cluster**: [ClusterInfo](#clusterinfo): The properties associated with a Stream Analytics cluster. -* **compatibilityLevel**: '1.0' | '1.2' | string: Controls certain runtime behaviors of the streaming job. -* **contentStoragePolicy**: 'JobStorageAccount' | 'SystemAccount' | string: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. . -* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. -* **dataLocale**: 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. -* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **eventsLateArrivalMaxDelayInSeconds**: int: 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. -* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. -* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. -* **functions**: [Function](#function)[]: 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. -* **inputs**: [Input](#input)[]: 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. -* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. -* **jobState**: string (ReadOnly): Describes the state of the streaming job. -* **jobStorageAccount**: [JobStorageAccount](#jobstorageaccount): The properties that are associated with an Azure Storage account with MSI -* **jobType**: 'Cloud' | 'Edge' | string: Describes the type of the job. Valid modes are `Cloud` and 'Edge'. -* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. -* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). -* **outputs**: [Output](#output)[]: 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. -* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. -* **outputStartTime**: 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. -* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. -* **sku**: [Sku](#sku): The properties that are associated with a SKU. -* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## ClusterInfo +## AzureTableOutputDataSourceProperties ### Properties -* **id**: string: The resource id of cluster. +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **batchSize**: int: The number of rows to write to the Azure Table at a time. +* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. +* **partitionKey**: 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. +* **rowKey**: 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. +* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. -## Function +## BlobOutputDataSourceProperties ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. -* **type**: string (ReadOnly): Resource type - -## FunctionProperties -* **Discriminator**: type - -### Base Properties -* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **properties**: [FunctionConfiguration](#functionconfiguration) -### AggregateFunctionProperties -#### Properties -* **type**: 'Aggregate' (Required): Indicates the type of function. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. -### ScalarFunctionProperties -#### Properties -* **type**: 'Scalar' (Required): Indicates the type of function. +## BlobReferenceInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +## BlobStreamInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. -## FunctionConfiguration +## ClusterInfo ### Properties -* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. -* **inputs**: [FunctionInput](#functioninput)[]: Array of FunctionInput -* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. +* **id**: string: The resource id of cluster. -## FunctionBinding -* **Discriminator**: type +## ClusterJob +### Properties +* **id**: string (ReadOnly): Resource ID of the streaming job. +* **jobState**: 'Created' | 'Degraded' | 'Deleting' | 'Failed' | 'Restarting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The current execution state of the streaming job. +* **streamingUnits**: int (ReadOnly): The number of streaming units that are used by the streaming job. -### Base Properties -### AzureMachineLearningWebServiceFunctionBinding -#### Properties -* **properties**: [AzureMachineLearningWebServiceFunctionBindingProperties](#azuremachinelearningwebservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. -* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. +## ClusterJobListResult +### Properties +* **nextLink**: string (ReadOnly): The URL to fetch the next set of streaming jobs. +* **value**: [ClusterJob](#clusterjob)[] (ReadOnly): A list of streaming jobs. -### JavaScriptFunctionBinding -#### Properties -* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. -* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. +## ClusterProperties +### Properties +* **capacityAllocated**: int (ReadOnly): Represents the number of streaming units currently being used on the cluster. +* **capacityAssigned**: int (ReadOnly): Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated. +* **clusterId**: string (ReadOnly): Unique identifier for the cluster. +* **createdDate**: string (ReadOnly): The date this cluster was created. +* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled +## ClusterSku +### Properties +* **capacity**: int: Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. +* **name**: 'Default' | string: Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. -## AzureMachineLearningWebServiceFunctionBindingProperties +## Compression ### Properties -* **apiKey**: string: The API key used to authenticate with Request-Response endpoint. -* **batchSize**: int: Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. -* **endpoint**: 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 -* **inputs**: [AzureMachineLearningWebServiceInputs](#azuremachinelearningwebserviceinputs): The inputs for the Azure Machine Learning web service endpoint. -* **outputs**: [AzureMachineLearningWebServiceOutputColumn](#azuremachinelearningwebserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. +* **type**: 'Deflate' | 'GZip' | 'None' | string (Required): Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests. -## AzureMachineLearningWebServiceInputs +## CsvSerializationProperties ### Properties -* **columnNames**: [AzureMachineLearningWebServiceInputColumn](#azuremachinelearningwebserviceinputcolumn)[]: A list of input columns for the Azure Machine Learning web service endpoint. -* **name**: string: The name of the input. This is the name provided while authoring the endpoint. +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **fieldDelimiter**: 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. -## AzureMachineLearningWebServiceInputColumn +## DiagnosticCondition ### Properties -* **dataType**: string: 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 . -* **mapTo**: int: The zero based index of the function parameter this input maps to. -* **name**: string: The name of the input column. +* **code**: string (ReadOnly): The opaque diagnostic code. +* **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. +* **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. -## AzureMachineLearningWebServiceOutputColumn +## Diagnostics ### Properties -* **dataType**: string: 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 . -* **name**: string: The name of the output column. +* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. -## JavaScriptFunctionBindingProperties +## DocumentDbOutputDataSourceProperties ### Properties -* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' +* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. +* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. +* **collectionNamePattern**: 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. +* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. +* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. +* **partitionKey**: 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. -## FunctionInput +## EventHubOutputDataSourceProperties ### Properties -* **dataType**: string: 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 -* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. +* **propertyColumns**: string[]: The properties associated with this Event Hub output. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -## FunctionOutput +## EventHubStreamInputDataSourceProperties ### Properties -* **dataType**: string: 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 +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **consumerGroupName**: string: 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. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -## Input +## Function ### Properties * **id**: string (ReadOnly): Resource Id * **name**: string: Resource name -* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. +* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. * **type**: string (ReadOnly): Resource type -## InputProperties +## FunctionBinding * **Discriminator**: type ### Base Properties -* **compression**: [Compression](#compression): Describes how input data is compressed -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **partitionKey**: string: partitionKey Describes a key in the input data which is used for partitioning the input data -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -### ReferenceInputProperties +### AzureMachineLearningWebServiceFunctionBinding #### Properties -* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. -* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. +* **properties**: [AzureMachineLearningWebServiceFunctionBindingProperties](#azuremachinelearningwebservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. +* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. -### StreamInputProperties +### JavaScriptFunctionBinding #### Properties -* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. -* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. - - -## Compression -### Properties -* **type**: 'Deflate' | 'GZip' | 'None' | string (Required): Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. +* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. -## Diagnostics -### Properties -* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. -## DiagnosticCondition +## FunctionConfiguration ### Properties -* **code**: string (ReadOnly): The opaque diagnostic code. -* **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. -* **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. - -## Serialization -* **Discriminator**: type - -### Base Properties -### AvroSerialization -#### Properties -* **properties**: any: Any object -* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - -### CsvSerialization -#### Properties -* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. -* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - -### JsonSerialization -#### Properties -* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. -* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - -### ParquetSerialization -#### Properties -* **properties**: any: Any object -* **type**: 'Parquet' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - +* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. +* **inputs**: [FunctionInput](#functioninput)[]: Array of FunctionInput +* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. -## CsvSerializationProperties +## FunctionInput ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **fieldDelimiter**: 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. +* **dataType**: string: 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 +* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. -## JsonSerializationProperties +## FunctionOutput ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **format**: 'Array' | 'LineSeparated' | string: 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. +* **dataType**: string: 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 -## ReferenceInputDataSource +## FunctionProperties * **Discriminator**: type ### Base Properties -### AzureSqlReferenceInputDataSource +* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **properties**: [FunctionConfiguration](#functionconfiguration) +### AggregateFunctionProperties #### Properties -* **properties**: [AzureSqlReferenceInputDataSourceProperties](#azuresqlreferenceinputdatasourceproperties): The properties that are associated with SQL DB input containing reference data. Required on PUT (CreateOrReplace) requests. -* **type**: 'Microsoft.Sql/Server/Database' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Aggregate' (Required): Indicates the type of function. -### BlobReferenceInputDataSource +### ScalarFunctionProperties #### Properties -* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Scalar' (Required): Indicates the type of function. -## AzureSqlReferenceInputDataSourceProperties -### Properties -* **database**: string: This element is associated with the datasource element. This is the name of the database that output will be written to. -* **deltaSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. -* **fullSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch data from the sql database. -* **password**: string: This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. -* **refreshRate**: string: This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. -* **refreshType**: 'RefreshPeriodicallyWithDelta' | 'RefreshPeriodicallyWithFull' | 'Static' | string: Indicates the type of data refresh option. -* **server**: string: This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. -* **table**: string: This element is associated with the datasource element. The name of the table in the Azure SQL database.. -* **user**: string: This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. - -## BlobReferenceInputDataSourceProperties +## Identity ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **principalId**: string: The identity principal ID +* **tenantId**: string: The identity tenantId +* **type**: string: The identity type -## StorageAccount +## Input ### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. +* **type**: string (ReadOnly): Resource type -## StreamInputDataSource +## InputProperties * **Discriminator**: type ### Base Properties -### IoTHubStreamInputDataSource -#### Properties -* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. -* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubV2StreamInputDataSource -#### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.EventHub/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubStreamInputDataSource +* **compression**: [Compression](#compression): Describes how input data is compressed +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **partitionKey**: string: partitionKey Describes a key in the input data which is used for partitioning the input data +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +### ReferenceInputProperties #### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. +* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. -### BlobStreamInputDataSource +### StreamInputProperties #### Properties -* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. +* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. ## IoTHubStreamInputDataSourceProperties @@ -382,24 +357,9 @@ * **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. * **sharedAccessPolicyName**: 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. -## EventHubStreamInputDataSourceProperties -### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **consumerGroupName**: string: 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. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. - -## BlobStreamInputDataSourceProperties +## JavaScriptFunctionBindingProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' ## JobStorageAccount ### Properties @@ -407,6 +367,11 @@ * **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +## JsonSerializationProperties +### Properties +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **format**: 'Array' | 'LineSeparated' | string: 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. + ## Output ### Properties * **id**: string (ReadOnly): Resource Id @@ -414,15 +379,6 @@ * **properties**: [OutputProperties](#outputproperties): The properties that are associated with an output. * **type**: string (ReadOnly): Resource type -## OutputProperties -### Properties -* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -* **sizeWindow**: int: The size window to constrain a Stream Analytics output to. -* **timeWindow**: string: The time frame for filtering Stream Analytics job outputs. - ## OutputDataSource * **Discriminator**: type @@ -488,35 +444,87 @@ * **type**: 'PowerBI' (Required): Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. -## AzureFunctionOutputDataSourceProperties +## OutputProperties ### Properties -* **apiKey**: string: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. -* **functionAppName**: string: The name of your Azure Functions app. -* **functionName**: string: The name of the function in your Azure Functions app. -* **maxBatchCount**: int: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. -* **maxBatchSize**: int: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). +* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +* **sizeWindow**: int: The size window to constrain a Stream Analytics output to. +* **timeWindow**: string: The time frame for filtering Stream Analytics job outputs. -## AzureDataLakeStoreOutputDataSourceProperties +## PowerBIOutputDataSourceProperties ### Properties -* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. -* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. +* **groupId**: string: The ID of the Power BI group. +* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. * **refreshToken**: 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. -* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. * **tokenUserDisplayName**: 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. * **tokenUserPrincipalName**: 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. -## EventHubOutputDataSourceProperties +## PrivateEndpointProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. -* **propertyColumns**: string[]: The properties associated with this Event Hub output. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **createdDate**: string (ReadOnly): The date when this private endpoint was created. +* **manualPrivateLinkServiceConnections**: [PrivateLinkServiceConnection](#privatelinkserviceconnection)[]: A list of connections to the remote resource. Immutable after it is set. + +## PrivateLinkConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string (ReadOnly): The reason for approval/rejection of the connection. +* **status**: string (ReadOnly): Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service. + +## PrivateLinkServiceConnection +### Properties +* **properties**: [PrivateLinkServiceConnectionProperties](#privatelinkserviceconnectionproperties): Bag of properties defining a privatelinkServiceConnection. + +## PrivateLinkServiceConnectionProperties +### Properties +* **groupIds**: string[]: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests. +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): A collection of read-only information about the state of the connection to the private remote resource. +* **privateLinkServiceId**: string: The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. +* **requestMessage**: string (ReadOnly): A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. + +## ReferenceInputDataSource +* **Discriminator**: type + +### Base Properties +### AzureSqlReferenceInputDataSource +#### Properties +* **properties**: [AzureSqlReferenceInputDataSourceProperties](#azuresqlreferenceinputdatasourceproperties): The properties that are associated with SQL DB input containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Microsoft.Sql/Server/Database' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + +### BlobReferenceInputDataSource +#### Properties +* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + + +## Serialization +* **Discriminator**: type + +### Base Properties +### AvroSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### CsvSerialization +#### Properties +* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. +* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### JsonSerialization +#### Properties +* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. +* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### ParquetSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Parquet' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + ## ServiceBusQueueOutputDataSourceProperties ### Properties @@ -543,67 +551,75 @@ ### Additional Properties * **Additional Properties Type**: string -## AzureSqlDatabaseOutputDataSourceProperties +## Sku ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **maxBatchCount**: int: Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. -* **maxWriterCount**: int: Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. -## AzureSynapseOutputDataSourceProperties +## StorageAccount ### Properties -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -## BlobOutputDataSourceProperties +## StreamingJobProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **cluster**: [ClusterInfo](#clusterinfo): The properties associated with a Stream Analytics cluster. +* **compatibilityLevel**: '1.0' | '1.2' | string: Controls certain runtime behaviors of the streaming job. +* **contentStoragePolicy**: 'JobStorageAccount' | 'SystemAccount' | string: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. . +* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. +* **dataLocale**: 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. +* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **eventsLateArrivalMaxDelayInSeconds**: int: 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. +* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. +* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. +* **functions**: [Function](#function)[]: 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. +* **inputs**: [Input](#input)[]: 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. +* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. +* **jobState**: string (ReadOnly): Describes the state of the streaming job. +* **jobStorageAccount**: [JobStorageAccount](#jobstorageaccount): The properties that are associated with an Azure Storage account with MSI +* **jobType**: 'Cloud' | 'Edge' | string: Describes the type of the job. Valid modes are `Cloud` and 'Edge'. +* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. +* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). +* **outputs**: [Output](#output)[]: 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. +* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. +* **outputStartTime**: 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. +* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. +* **sku**: [Sku](#sku): The properties that are associated with a SKU. +* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. -## DocumentDbOutputDataSourceProperties -### Properties -* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. -* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. -* **collectionNamePattern**: 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. -* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. -* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. -* **partitionKey**: 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. +## StreamInputDataSource +* **Discriminator**: type -## AzureTableOutputDataSourceProperties -### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **batchSize**: int: The number of rows to write to the Azure Table at a time. -* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. -* **partitionKey**: 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. -* **rowKey**: 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. -* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. +### Base Properties +### IoTHubStreamInputDataSource +#### Properties +* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. +* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## PowerBIOutputDataSourceProperties +### EventHubV2StreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.EventHub/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + +### EventHubStreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + +### BlobStreamInputDataSource +#### Properties +* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + + +## TrackedResourceTags ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. -* **groupId**: string: The ID of the Power BI group. -* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. -* **refreshToken**: 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. -* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. -* **tokenUserDisplayName**: 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. -* **tokenUserPrincipalName**: 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. +### Additional Properties +* **Additional Properties Type**: string -## Sku +## TrackedResourceTags ### Properties -* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. +### Additional Properties +* **Additional Properties Type**: string ## Transformation ### Properties @@ -619,19 +635,3 @@ * **streamingUnits**: int: Specifies the number of streaming units that the streaming job uses. * **validStreamingUnits**: int[]: Specifies the valid streaming units a streaming job can scale to. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ClusterJobListResult -### Properties -* **nextLink**: string (ReadOnly): The URL to fetch the next set of streaming jobs. -* **value**: [ClusterJob](#clusterjob)[] (ReadOnly): A list of streaming jobs. - -## ClusterJob -### Properties -* **id**: string (ReadOnly): Resource ID of the streaming job. -* **jobState**: 'Created' | 'Degraded' | 'Deleting' | 'Failed' | 'Restarting' | 'Running' | 'Scaling' | 'Starting' | 'Stopped' | 'Stopping' | string (ReadOnly): The current execution state of the streaming job. -* **streamingUnits**: int (ReadOnly): The number of streaming units that are used by the streaming job. - diff --git a/generated/streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.md b/generated/streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.md index 1c862e0221..1cca8eb5f6 100644 --- a/generated/streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.md +++ b/generated/streamanalytics/microsoft.streamanalytics/2021-10-01-preview/types.md @@ -48,117 +48,48 @@ * **properties**: [TransformationProperties](#transformationproperties): The properties that are associated with a transformation. * **type**: 'Microsoft.StreamAnalytics/streamingjobs/transformations' (ReadOnly, DeployTimeConstant): The resource type -## Identity -### Properties -* **principalId**: string: The principalId of the identity. -* **tenantId**: string: The tenantId of the identity. -* **type**: string: The type of identity, can be SystemAssigned or UserAssigned. -* **userAssignedIdentities**: any: Any object - -## StreamingJobProperties -### Properties -* **cluster**: [ClusterInfo](#clusterinfo): The properties associated with a Stream Analytics cluster. -* **compatibilityLevel**: '1.0' | '1.2' | string: Controls certain runtime behaviors of the streaming job. -* **contentStoragePolicy**: 'JobStorageAccount' | 'SystemAccount' | string: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. . -* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. -* **dataLocale**: 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. -* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **eventsLateArrivalMaxDelayInSeconds**: int: 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. -* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. -* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. -* **externals**: [External](#external): The storage account where the custom code artifacts are located. -* **functions**: [Function](#function)[]: 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. -* **inputs**: [Input](#input)[]: 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. -* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. -* **jobState**: string (ReadOnly): Describes the state of the streaming job. -* **jobStorageAccount**: [JobStorageAccount](#jobstorageaccount): The properties that are associated with an Azure Storage account with MSI -* **jobType**: 'Cloud' | 'Edge' | string: Describes the type of the job. Valid modes are `Cloud` and 'Edge'. -* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. -* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). -* **outputs**: [Output](#output)[]: 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. -* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. -* **outputStartTime**: 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. -* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. -* **sku**: [Sku](#sku): The properties that are associated with a SKU. -* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. - -## ClusterInfo -### Properties -* **id**: string: The resource id of cluster. - -## External +## AzureDataLakeStoreOutputDataSourceProperties ### Properties -* **container**: string: The UserCustomCode container. -* **path**: string: The UserCustomCode path. -* **refreshConfiguration**: [RefreshConfiguration](#refreshconfiguration): The refresh parameters for any/all updatable user defined functions present in the job config. -* **storageAccount**: [StorageAccount](#storageaccount): The properties that are associated with an Azure Storage account +* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. +* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. +* **refreshToken**: 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. +* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. +* **tokenUserDisplayName**: 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. +* **tokenUserPrincipalName**: 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. -## RefreshConfiguration +## AzureFunctionOutputDataSourceProperties ### Properties -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **refreshInterval**: string: The refresh interval. -* **refreshType**: 'Blocking' | 'Nonblocking' | 'RefreshPeriodicallyWithDelta' | 'RefreshPeriodicallyWithFull' | 'Static' | string: Indicates the type of data refresh option. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **apiKey**: string: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. +* **functionAppName**: string: The name of your Azure Functions app. +* **functionName**: string: The name of the function in your Azure Functions app. +* **maxBatchCount**: int: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. +* **maxBatchSize**: int: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). -## StorageAccount +## AzureMachineLearningServiceFunctionBindingProperties ### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **apiKey**: string: The API key used to authenticate with Request-Response endpoint. +* **batchSize**: int: Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. +* **endpoint**: string: The Request-Response execute endpoint of the Azure Machine Learning web service. +* **inputRequestName**: string: Label for the input request object. +* **inputs**: [AzureMachineLearningServiceInputColumn](#azuremachinelearningserviceinputcolumn)[]: The inputs for the Azure Machine Learning web service endpoint. +* **numberOfParallelRequests**: int: The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1. +* **outputResponseName**: string: Label for the output request object. +* **outputs**: [AzureMachineLearningServiceOutputColumn](#azuremachinelearningserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. -## Function +## AzureMachineLearningServiceInputColumn ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. -* **type**: string (ReadOnly): Resource type - -## FunctionProperties -* **Discriminator**: type - -### Base Properties -* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **properties**: [FunctionConfiguration](#functionconfiguration) -### AggregateFunctionProperties -#### Properties -* **type**: 'Aggregate' (Required): Indicates the type of function. - -### ScalarFunctionProperties -#### Properties -* **type**: 'Scalar' (Required): Indicates the type of function. - +* **dataType**: string: The (Azure Machine Learning supported) data type of the input column. +* **mapTo**: int: The zero based index of the function parameter this input maps to. +* **name**: string: The name of the input column. -## FunctionConfiguration +## AzureMachineLearningServiceOutputColumn ### Properties -* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. -* **inputs**: [FunctionInput](#functioninput)[]: Array of FunctionInput -* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. - -## FunctionBinding -* **Discriminator**: type - -### Base Properties -### AzureMachineLearningStudioFunctionBinding -#### Properties -* **properties**: [AzureMachineLearningStudioFunctionBindingProperties](#azuremachinelearningstudiofunctionbindingproperties): The binding properties associated with an Azure Machine learning Studio. -* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. - -### AzureMachineLearningServiceFunctionBinding -#### Properties -* **properties**: [AzureMachineLearningServiceFunctionBindingProperties](#azuremachinelearningservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. -* **type**: 'Microsoft.MachineLearningServices' (Required): Indicates the function binding type. - -### CSharpFunctionBinding -#### Properties -* **properties**: [CSharpFunctionBindingProperties](#csharpfunctionbindingproperties): The binding properties associated with a CSharp function. -* **type**: 'Microsoft.StreamAnalytics/CLRUdf' (Required): Indicates the function binding type. - -### JavaScriptFunctionBinding -#### Properties -* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. -* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. - +* **dataType**: string: The (Azure Machine Learning supported) data type of the output column. +* **mapTo**: int: The zero based index of the function parameter this input maps to. +* **name**: string: The name of the output column. ## AzureMachineLearningStudioFunctionBindingProperties ### Properties @@ -168,44 +99,106 @@ * **inputs**: [AzureMachineLearningStudioInputs](#azuremachinelearningstudioinputs): The inputs for the Azure Machine Learning Studio endpoint. * **outputs**: [AzureMachineLearningStudioOutputColumn](#azuremachinelearningstudiooutputcolumn)[]: A list of outputs from the Azure Machine Learning Studio endpoint execution. -## AzureMachineLearningStudioInputs -### Properties -* **columnNames**: [AzureMachineLearningStudioInputColumn](#azuremachinelearningstudioinputcolumn)[]: A list of input columns for the Azure Machine Learning Studio endpoint. -* **name**: string: The name of the input. This is the name provided while authoring the endpoint. - ## AzureMachineLearningStudioInputColumn ### Properties * **dataType**: string: 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 . * **mapTo**: int: The zero based index of the function parameter this input maps to. * **name**: string: The name of the input column. +## AzureMachineLearningStudioInputs +### Properties +* **columnNames**: [AzureMachineLearningStudioInputColumn](#azuremachinelearningstudioinputcolumn)[]: A list of input columns for the Azure Machine Learning Studio endpoint. +* **name**: string: The name of the input. This is the name provided while authoring the endpoint. + ## AzureMachineLearningStudioOutputColumn ### Properties * **dataType**: string: 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 . * **name**: string: The name of the output column. -## AzureMachineLearningServiceFunctionBindingProperties +## AzureSqlDatabaseOutputDataSourceProperties ### Properties -* **apiKey**: string: The API key used to authenticate with Request-Response endpoint. -* **batchSize**: int: Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. -* **endpoint**: string: The Request-Response execute endpoint of the Azure Machine Learning web service. -* **inputRequestName**: string: Label for the input request object. -* **inputs**: [AzureMachineLearningServiceInputColumn](#azuremachinelearningserviceinputcolumn)[]: The inputs for the Azure Machine Learning web service endpoint. -* **numberOfParallelRequests**: int: The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1. -* **outputResponseName**: string: Label for the output request object. -* **outputs**: [AzureMachineLearningServiceOutputColumn](#azuremachinelearningserviceoutputcolumn)[]: A list of outputs from the Azure Machine Learning web service endpoint execution. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **maxBatchCount**: int: Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. +* **maxWriterCount**: int: Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## AzureMachineLearningServiceInputColumn +## AzureSqlReferenceInputDataSourceProperties ### Properties -* **dataType**: string: The (Azure Machine Learning supported) data type of the input column. -* **mapTo**: int: The zero based index of the function parameter this input maps to. -* **name**: string: The name of the input column. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **database**: string: This element is associated with the datasource element. This is the name of the database that output will be written to. +* **deltaSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. +* **fullSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch data from the sql database. +* **password**: string: This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. +* **refreshRate**: string: This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. +* **refreshType**: 'Blocking' | 'Nonblocking' | 'RefreshPeriodicallyWithDelta' | 'RefreshPeriodicallyWithFull' | 'Static' | string: Indicates the type of data refresh option. +* **server**: string: This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. +* **user**: string: This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. -## AzureMachineLearningServiceOutputColumn +## AzureSynapseOutputDataSourceProperties ### Properties -* **dataType**: string: The (Azure Machine Learning supported) data type of the output column. -* **mapTo**: int: The zero based index of the function parameter this input maps to. -* **name**: string: The name of the output column. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. + +## AzureTableOutputDataSourceProperties +### Properties +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **batchSize**: int: The number of rows to write to the Azure Table at a time. +* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. +* **partitionKey**: 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. +* **rowKey**: 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. +* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. + +## BlobOutputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **blobPathPrefix**: string: Blob path prefix. +* **blobWriteMode**: 'Append' | 'Once' | string: Determines whether blob blocks are either committed automatically or appended. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## BlobReferenceInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **blobName**: string: The name of the blob input. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **deltaPathPattern**: string: The path pattern of the delta snapshot. +* **deltaSnapshotRefreshRate**: string: The interval that the user generates a delta snapshot of this reference blob input data source. +* **fullSnapshotRefreshRate**: string: The refresh interval of the blob input data source. +* **pathPattern**: 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. +* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 256. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## BlobStreamInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **container**: string: 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. +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## ClusterInfo +### Properties +* **id**: string: The resource id of cluster. + +## Compression +### Properties +* **type**: 'Deflate' | 'GZip' | 'None' | string (Required): Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests. ## CSharpFunctionBindingProperties ### Properties @@ -214,204 +207,185 @@ * **method**: string: The Csharp code containing a single function definition. * **updateMode**: 'Refreshable' | 'Static' | string: Refresh modes for Stream Analytics functions. -## JavaScriptFunctionBindingProperties +## CsvSerializationProperties ### Properties -* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **fieldDelimiter**: 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. -## FunctionInput +## CustomClrSerializationProperties ### Properties -* **dataType**: string: 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 -* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. +* **serializationClassName**: string: The serialization class name. +* **serializationDllPath**: string: The serialization library path. -## FunctionOutput +## DiagnosticCondition ### Properties -* **dataType**: string: 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 +* **code**: string (ReadOnly): The opaque diagnostic code. +* **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. +* **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. -## Input +## Diagnostics ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. -* **type**: string (ReadOnly): Resource type +* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. -## InputProperties -* **Discriminator**: type +## DocumentDbOutputDataSourceProperties +### Properties +* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. +* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **collectionNamePattern**: 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. +* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. +* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. +* **partitionKey**: 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. -### Base Properties -* **compression**: [Compression](#compression): Describes how input data is compressed -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **partitionKey**: string: partitionKey Describes a key in the input data which is used for partitioning the input data -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -* **watermarkSettings**: [InputWatermarkProperties](#inputwatermarkproperties): Settings which determine whether to read watermark events. -### ReferenceInputProperties -#### Properties -* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. -* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. +## EventGridStreamInputDataSourceProperties +### Properties +* **eventTypes**: string[]: List of Event Types that are supported by the Event Grid adapter. +* **schema**: 'CloudEventSchema' | 'EventGridEventSchema' | string: Supported Event Grid schema types. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. +* **subscriber**: [EventHubV2StreamInputDataSource](#eventhubv2streaminputdatasource): Describes an Event Hub input data source that contains stream data. -### StreamInputProperties -#### Properties -* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. -* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. +## EventHubOutputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **partitionCount**: int: The partition count of the event hub data source. Range 1 - 256. +* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. +* **propertyColumns**: string[]: The properties associated with this Event Hub output. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +## EventHubStreamInputDataSourceProperties +### Properties +* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. +* **consumerGroupName**: string: 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. +* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. +* **partitionCount**: int: The partition count of the event hub data source. Range 1 - 256. +* **prefetchCount**: int: The number of messages that the message receiver can simultaneously request. +* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. +* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -## Compression +## EventHubV2StreamInputDataSource ### Properties -* **type**: 'Deflate' | 'GZip' | 'None' | string (Required): Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: string (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## Diagnostics +## External ### Properties -* **conditions**: [DiagnosticCondition](#diagnosticcondition)[] (ReadOnly): A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. +* **container**: string: The UserCustomCode container. +* **path**: string: The UserCustomCode path. +* **refreshConfiguration**: [RefreshConfiguration](#refreshconfiguration): The refresh parameters for any/all updatable user defined functions present in the job config. +* **storageAccount**: [StorageAccount](#storageaccount): The properties that are associated with an Azure Storage account -## DiagnosticCondition +## Function ### Properties -* **code**: string (ReadOnly): The opaque diagnostic code. -* **message**: string (ReadOnly): The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. -* **since**: string (ReadOnly): The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [FunctionProperties](#functionproperties): The properties that are associated with a function. +* **type**: string (ReadOnly): Resource type -## Serialization +## FunctionBinding * **Discriminator**: type ### Base Properties -### AvroSerialization -#### Properties -* **properties**: any: Any object -* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - -### CsvSerialization +### AzureMachineLearningStudioFunctionBinding #### Properties -* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. -* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [AzureMachineLearningStudioFunctionBindingProperties](#azuremachinelearningstudiofunctionbindingproperties): The binding properties associated with an Azure Machine learning Studio. +* **type**: 'Microsoft.MachineLearning/WebService' (Required): Indicates the function binding type. -### CustomClrSerialization +### AzureMachineLearningServiceFunctionBinding #### Properties -* **properties**: [CustomClrSerializationProperties](#customclrserializationproperties): The properties that are associated with the CustomClr serialization type. -* **type**: 'CustomClr' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [AzureMachineLearningServiceFunctionBindingProperties](#azuremachinelearningservicefunctionbindingproperties): The binding properties associated with an Azure Machine learning web service. +* **type**: 'Microsoft.MachineLearningServices' (Required): Indicates the function binding type. -### JsonSerialization +### CSharpFunctionBinding #### Properties -* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. -* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. +* **properties**: [CSharpFunctionBindingProperties](#csharpfunctionbindingproperties): The binding properties associated with a CSharp function. +* **type**: 'Microsoft.StreamAnalytics/CLRUdf' (Required): Indicates the function binding type. -### ParquetSerialization +### JavaScriptFunctionBinding #### Properties -* **properties**: any: Any object -* **type**: 'Parquet' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. - +* **properties**: [JavaScriptFunctionBindingProperties](#javascriptfunctionbindingproperties): The binding properties associated with a JavaScript function. +* **type**: 'Microsoft.StreamAnalytics/JavascriptUdf' (Required): Indicates the function binding type. -## CsvSerializationProperties -### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **fieldDelimiter**: 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. -## CustomClrSerializationProperties +## FunctionConfiguration ### Properties -* **serializationClassName**: string: The serialization class name. -* **serializationDllPath**: string: The serialization library path. +* **binding**: [FunctionBinding](#functionbinding): The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. +* **inputs**: [FunctionInput](#functioninput)[]: Array of FunctionInput +* **output**: [FunctionOutput](#functionoutput): Describes the output of a function. -## JsonSerializationProperties +## FunctionInput ### Properties -* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. -* **format**: 'Array' | 'LineSeparated' | string: 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. +* **dataType**: string: 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 +* **isConfigurationParameter**: bool: A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. -## InputWatermarkProperties +## FunctionOutput ### Properties -* **watermarkMode**: 'None' | 'ReadWatermark' | string: The input watermark mode. +* **dataType**: string: 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 -## ReferenceInputDataSource +## FunctionProperties * **Discriminator**: type ### Base Properties -### AzureSqlReferenceInputDataSource +* **etag**: string (ReadOnly): The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **properties**: [FunctionConfiguration](#functionconfiguration) +### AggregateFunctionProperties #### Properties -* **properties**: [AzureSqlReferenceInputDataSourceProperties](#azuresqlreferenceinputdatasourceproperties): The properties that are associated with SQL DB input containing reference data. Required on PUT (CreateOrReplace) requests. -* **type**: 'Microsoft.Sql/Server/Database' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Aggregate' (Required): Indicates the type of function. -### BlobReferenceInputDataSource +### ScalarFunctionProperties #### Properties -* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Scalar' (Required): Indicates the type of function. -### RawReferenceInputDataSource -#### Properties -* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. -* **type**: 'Raw' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. +## GatewayMessageBusOutputDataSourceProperties +### Properties +* **topic**: string: The name of the Service Bus topic. -## AzureSqlReferenceInputDataSourceProperties +## GatewayMessageBusStreamInputDataSourceProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **database**: string: This element is associated with the datasource element. This is the name of the database that output will be written to. -* **deltaSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. -* **fullSnapshotQuery**: string: This element is associated with the datasource element. This query is used to fetch data from the sql database. -* **password**: string: This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. -* **refreshRate**: string: This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. -* **refreshType**: 'Blocking' | 'Nonblocking' | 'RefreshPeriodicallyWithDelta' | 'RefreshPeriodicallyWithFull' | 'Static' | string: Indicates the type of data refresh option. -* **server**: string: This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. -* **user**: string: This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. +* **topic**: string: The name of the Service Bus topic. -## BlobReferenceInputDataSourceProperties +## Identity ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **blobName**: string: The name of the blob input. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **deltaPathPattern**: string: The path pattern of the delta snapshot. -* **deltaSnapshotRefreshRate**: string: The interval that the user generates a delta snapshot of this reference blob input data source. -* **fullSnapshotRefreshRate**: string: The refresh interval of the blob input data source. -* **pathPattern**: 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. -* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 256. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **principalId**: string: The principalId of the identity. +* **tenantId**: string: The tenantId of the identity. +* **type**: string: The type of identity, can be SystemAssigned or UserAssigned. +* **userAssignedIdentities**: any: Any object -## RawInputDatasourceProperties +## Input ### Properties -* **payload**: string: The JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. -* **payloadUri**: string: The SAS URL to a blob containing the JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [InputProperties](#inputproperties): The properties that are associated with an input. +* **type**: string (ReadOnly): Resource type -## StreamInputDataSource +## InputProperties * **Discriminator**: type ### Base Properties -### GatewayMessageBusStreamInputDataSource -#### Properties -* **properties**: [GatewayMessageBusStreamInputDataSourceProperties](#gatewaymessagebusstreaminputdatasourceproperties): The properties that are associated with a gateway message bus input containing stream data. -* **type**: 'GatewayMessageBus' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### IoTHubStreamInputDataSource -#### Properties -* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. -* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventGridStreamInputDataSource -#### Properties -* **properties**: [EventGridStreamInputDataSourceProperties](#eventgridstreaminputdatasourceproperties): The properties that are associated with an event grid input containing stream data. -* **type**: 'Microsoft.EventGrid/EventSubscriptions' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubV2StreamInputDataSource -#### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.EventHub/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### EventHubStreamInputDataSource -#### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -### BlobStreamInputDataSource +* **compression**: [Compression](#compression): Describes how input data is compressed +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **partitionKey**: string: partitionKey Describes a key in the input data which is used for partitioning the input data +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +* **watermarkSettings**: [InputWatermarkProperties](#inputwatermarkproperties): Settings which determine whether to read watermark events. +### ReferenceInputProperties #### Properties -* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. -* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [ReferenceInputDataSource](#referenceinputdatasource): Describes an input data source that contains reference data. +* **type**: 'Reference' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. -### RawStreamInputDataSource +### StreamInputProperties #### Properties -* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. -* **type**: 'Raw' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. +* **datasource**: [StreamInputDataSource](#streaminputdatasource): Describes an input data source that contains stream data. +* **type**: 'Stream' (Required): Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. -## GatewayMessageBusStreamInputDataSourceProperties +## InputWatermarkProperties ### Properties -* **topic**: string: The name of the Service Bus topic. +* **watermarkMode**: 'None' | 'ReadWatermark' | string: The input watermark mode. ## IoTHubStreamInputDataSourceProperties ### Properties @@ -421,38 +395,9 @@ * **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. * **sharedAccessPolicyName**: 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. -## EventGridStreamInputDataSourceProperties -### Properties -* **eventTypes**: string[]: List of Event Types that are supported by the Event Grid adapter. -* **schema**: 'CloudEventSchema' | 'EventGridEventSchema' | string: Supported Event Grid schema types. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **subscriber**: [EventHubV2StreamInputDataSource](#eventhubv2streaminputdatasource): Describes an Event Hub input data source that contains stream data. - -## EventHubV2StreamInputDataSource -### Properties -* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. -* **type**: string (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. - -## EventHubStreamInputDataSourceProperties -### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **consumerGroupName**: string: 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. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **partitionCount**: int: The partition count of the event hub data source. Range 1 - 256. -* **prefetchCount**: int: The number of messages that the message receiver can simultaneously request. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. - -## BlobStreamInputDataSourceProperties +## JavaScriptFunctionBindingProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **sourcePartitionCount**: int: The partition count of the blob input data source. Range 1 - 1024. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **script**: string: The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' ## JobStorageAccount ### Properties @@ -460,23 +405,22 @@ * **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -## Output +## JsonSerializationProperties ### Properties -* **id**: string (ReadOnly): Resource Id -* **name**: string: Resource name -* **properties**: [OutputProperties](#outputproperties): The properties that are associated with an output. -* **type**: string (ReadOnly): Resource type +* **encoding**: 'UTF8' | string: Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. +* **format**: 'Array' | 'LineSeparated' | string: 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. -## OutputProperties +## LastOutputEventTimestamp ### Properties -* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. -* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. -* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. -* **lastOutputEventTimestamps**: [LastOutputEventTimestamp](#lastoutputeventtimestamp)[] (ReadOnly): A list of the last output event times for each output partition. The index of the array corresponds to the partition number. -* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. -* **sizeWindow**: int: The size window to constrain a Stream Analytics output to. -* **timeWindow**: string: The time frame for filtering Stream Analytics job outputs. -* **watermarkSettings**: [OutputWatermarkProperties](#outputwatermarkproperties): Settings which determine whether to send watermarks to downstream. +* **lastOutputEventTime**: string: The last output event time. +* **lastUpdateTime**: string: The time that the last update happened. + +## Output +### Properties +* **id**: string (ReadOnly): Resource Id +* **name**: string: Resource name +* **properties**: [OutputProperties](#outputproperties): The properties that are associated with an output. +* **type**: string (ReadOnly): Resource type ## OutputDataSource * **Discriminator**: type @@ -558,29 +502,21 @@ * **type**: 'Raw' (Required): Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. -## GatewayMessageBusOutputDataSourceProperties -### Properties -* **topic**: string: The name of the Service Bus topic. - -## AzureFunctionOutputDataSourceProperties +## OutputProperties ### Properties -* **apiKey**: string: If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. -* **functionAppName**: string: The name of your Azure Functions app. -* **functionName**: string: The name of the function in your Azure Functions app. -* **maxBatchCount**: int: A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. -* **maxBatchSize**: int: A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). +* **datasource**: [OutputDataSource](#outputdatasource): Describes the data source that output will be written to. +* **diagnostics**: [Diagnostics](#diagnostics) (ReadOnly): Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. +* **etag**: string (ReadOnly): The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **lastOutputEventTimestamps**: [LastOutputEventTimestamp](#lastoutputeventtimestamp)[] (ReadOnly): A list of the last output event times for each output partition. The index of the array corresponds to the partition number. +* **serialization**: [Serialization](#serialization): Describes how data from an input is serialized or how data is serialized when written to an output. +* **sizeWindow**: int: The size window to constrain a Stream Analytics output to. +* **timeWindow**: string: The time frame for filtering Stream Analytics job outputs. +* **watermarkSettings**: [OutputWatermarkProperties](#outputwatermarkproperties): Settings which determine whether to send watermarks to downstream. -## AzureDataLakeStoreOutputDataSourceProperties +## OutputWatermarkProperties ### Properties -* **accountName**: string: The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **dateFormat**: string: The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. -* **filePathPrefix**: string: The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. -* **refreshToken**: 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. -* **tenantId**: string: The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. -* **tokenUserDisplayName**: 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. -* **tokenUserPrincipalName**: 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. +* **maxWatermarkDifferenceAcrossPartitions**: string: Describes the maximal delta between the fastest and slowest partitions, so the out of order window that catches all necessary events in downstream jobs is well defined. +* **watermarkMode**: 'None' | 'SendCurrentPartitionWatermark' | 'SendLowestWatermarkAcrossPartitions' | string: The output watermark mode. ## PostgreSQLOutputDataSourceProperties ### Properties @@ -592,16 +528,83 @@ * **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. * **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## EventHubOutputDataSourceProperties +## PowerBIOutputDataSourceProperties ### Properties * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **eventHubName**: string: The name of the Event Hub. Required on PUT (CreateOrReplace) requests. -* **partitionCount**: int: The partition count of the event hub data source. Range 1 - 256. -* **partitionKey**: string: The key/column that is used to determine to which partition to send event data. -* **propertyColumns**: string[]: The properties associated with this Event Hub output. -* **serviceBusNamespace**: string: The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyKey**: string: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. -* **sharedAccessPolicyName**: string: The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. +* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. +* **groupId**: string: The ID of the Power BI group. +* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. +* **refreshToken**: 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. +* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. +* **tokenUserDisplayName**: 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. +* **tokenUserPrincipalName**: 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. + +## RawInputDatasourceProperties +### Properties +* **payload**: string: The JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. +* **payloadUri**: string: The SAS URL to a blob containing the JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. + +## RawOutputDatasourceProperties +### Properties +* **payloadUri**: string: The SAS URL to a blob where the output should be written. If this property is not set, output data will be written into a temporary storage, and a SAS URL to that temporary storage will be included in the result. + +## ReferenceInputDataSource +* **Discriminator**: type + +### Base Properties +### AzureSqlReferenceInputDataSource +#### Properties +* **properties**: [AzureSqlReferenceInputDataSourceProperties](#azuresqlreferenceinputdatasourceproperties): The properties that are associated with SQL DB input containing reference data. Required on PUT (CreateOrReplace) requests. +* **type**: 'Microsoft.Sql/Server/Database' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + +### BlobReferenceInputDataSource +#### Properties +* **properties**: [BlobReferenceInputDataSourceProperties](#blobreferenceinputdatasourceproperties): The properties that are associated with a blob input containing reference data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + +### RawReferenceInputDataSource +#### Properties +* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. +* **type**: 'Raw' (Required): Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. + + +## RefreshConfiguration +### Properties +* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. +* **pathPattern**: 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. +* **refreshInterval**: string: The refresh interval. +* **refreshType**: 'Blocking' | 'Nonblocking' | 'RefreshPeriodicallyWithDelta' | 'RefreshPeriodicallyWithFull' | 'Static' | string: Indicates the type of data refresh option. +* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. + +## Serialization +* **Discriminator**: type + +### Base Properties +### AvroSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Avro' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### CsvSerialization +#### Properties +* **properties**: [CsvSerializationProperties](#csvserializationproperties): The properties that are associated with the CSV serialization type. +* **type**: 'Csv' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### CustomClrSerialization +#### Properties +* **properties**: [CustomClrSerializationProperties](#customclrserializationproperties): The properties that are associated with the CustomClr serialization type. +* **type**: 'CustomClr' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### JsonSerialization +#### Properties +* **properties**: [JsonSerializationProperties](#jsonserializationproperties): The properties that are associated with the JSON serialization type. +* **type**: 'Json' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + +### ParquetSerialization +#### Properties +* **properties**: any: Any object +* **type**: 'Parquet' (Required): Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. + ## ServiceBusQueueOutputDataSourceProperties ### Properties @@ -628,85 +631,87 @@ ### Additional Properties * **Additional Properties Type**: string -## AzureSqlDatabaseOutputDataSourceProperties +## Sku ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **maxBatchCount**: int: Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. -* **maxWriterCount**: int: Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. +* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. -## AzureSynapseOutputDataSourceProperties +## StorageAccount ### Properties +* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. +* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. * **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **database**: string: The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **password**: string: The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **server**: string: The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **table**: string: The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. -* **user**: string: The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. -## BlobOutputDataSourceProperties +## StreamingJobProperties ### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **blobPathPrefix**: string: Blob path prefix. -* **blobWriteMode**: 'Append' | 'Once' | string: Determines whether blob blocks are either committed automatically or appended. -* **container**: string: 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. -* **dateFormat**: string: The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. -* **pathPattern**: 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. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. -* **timeFormat**: string: The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. +* **cluster**: [ClusterInfo](#clusterinfo): The properties associated with a Stream Analytics cluster. +* **compatibilityLevel**: '1.0' | '1.2' | string: Controls certain runtime behaviors of the streaming job. +* **contentStoragePolicy**: 'JobStorageAccount' | 'SystemAccount' | string: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. . +* **createdDate**: string (ReadOnly): Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. +* **dataLocale**: 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. +* **etag**: string (ReadOnly): The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. +* **eventsLateArrivalMaxDelayInSeconds**: int: 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. +* **eventsOutOfOrderMaxDelayInSeconds**: int: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order. +* **eventsOutOfOrderPolicy**: 'Adjust' | 'Drop' | string: Indicates the policy to apply to events that arrive out of order in the input event stream. +* **externals**: [External](#external): The storage account where the custom code artifacts are located. +* **functions**: [Function](#function)[]: 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. +* **inputs**: [Input](#input)[]: 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. +* **jobId**: string (ReadOnly): A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. +* **jobState**: string (ReadOnly): Describes the state of the streaming job. +* **jobStorageAccount**: [JobStorageAccount](#jobstorageaccount): The properties that are associated with an Azure Storage account with MSI +* **jobType**: 'Cloud' | 'Edge' | string: Describes the type of the job. Valid modes are `Cloud` and 'Edge'. +* **lastOutputEventTime**: string (ReadOnly): Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. +* **outputErrorPolicy**: 'Drop' | 'Stop' | 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). +* **outputs**: [Output](#output)[]: 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. +* **outputStartMode**: 'CustomTime' | 'JobStartTime' | 'LastOutputEventTime' | string: 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. +* **outputStartTime**: 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. +* **provisioningState**: string (ReadOnly): Describes the provisioning status of the streaming job. +* **sku**: [Sku](#sku): The properties that are associated with a SKU. +* **transformation**: [Transformation](#transformation): A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. -## DocumentDbOutputDataSourceProperties -### Properties -* **accountId**: string: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. -* **accountKey**: string: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **collectionNamePattern**: 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. -* **database**: string: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. -* **documentId**: string: The name of the field in output events used to specify the primary key which insert or update operations are based on. -* **partitionKey**: 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. +## StreamInputDataSource +* **Discriminator**: type -## AzureTableOutputDataSourceProperties -### Properties -* **accountKey**: string: The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **accountName**: string: The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. -* **batchSize**: int: The number of rows to write to the Azure Table at a time. -* **columnsToRemove**: string[]: If specified, each item in the array is the name of a column to remove (if present) from output event entities. -* **partitionKey**: 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. -* **rowKey**: 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. -* **table**: string: The name of the Azure Table. Required on PUT (CreateOrReplace) requests. +### Base Properties +### GatewayMessageBusStreamInputDataSource +#### Properties +* **properties**: [GatewayMessageBusStreamInputDataSourceProperties](#gatewaymessagebusstreaminputdatasourceproperties): The properties that are associated with a gateway message bus input containing stream data. +* **type**: 'GatewayMessageBus' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## PowerBIOutputDataSourceProperties -### Properties -* **authenticationMode**: 'ConnectionString' | 'Msi' | 'UserToken' | string: Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'. -* **dataset**: string: The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. -* **groupId**: string: The ID of the Power BI group. -* **groupName**: string: The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. -* **refreshToken**: 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. -* **table**: string: The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. -* **tokenUserDisplayName**: 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. -* **tokenUserPrincipalName**: 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. +### IoTHubStreamInputDataSource +#### Properties +* **properties**: [IoTHubStreamInputDataSourceProperties](#iothubstreaminputdatasourceproperties): The properties that are associated with a IoT Hub input containing stream data. +* **type**: 'Microsoft.Devices/IotHubs' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## RawOutputDatasourceProperties -### Properties -* **payloadUri**: string: The SAS URL to a blob where the output should be written. If this property is not set, output data will be written into a temporary storage, and a SAS URL to that temporary storage will be included in the result. +### EventGridStreamInputDataSource +#### Properties +* **properties**: [EventGridStreamInputDataSourceProperties](#eventgridstreaminputdatasourceproperties): The properties that are associated with an event grid input containing stream data. +* **type**: 'Microsoft.EventGrid/EventSubscriptions' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## LastOutputEventTimestamp -### Properties -* **lastOutputEventTime**: string: The last output event time. -* **lastUpdateTime**: string: The time that the last update happened. +### EventHubV2StreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.EventHub/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## OutputWatermarkProperties -### Properties -* **maxWatermarkDifferenceAcrossPartitions**: string: Describes the maximal delta between the fastest and slowest partitions, so the out of order window that catches all necessary events in downstream jobs is well defined. -* **watermarkMode**: 'None' | 'SendCurrentPartitionWatermark' | 'SendLowestWatermarkAcrossPartitions' | string: The output watermark mode. +### EventHubStreamInputDataSource +#### Properties +* **properties**: [EventHubStreamInputDataSourceProperties](#eventhubstreaminputdatasourceproperties): The properties that are associated with a Event Hub input containing stream data. +* **type**: 'Microsoft.ServiceBus/EventHub' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. -## Sku +### BlobStreamInputDataSource +#### Properties +* **properties**: [BlobStreamInputDataSourceProperties](#blobstreaminputdatasourceproperties): The properties that are associated with a blob input containing stream data. +* **type**: 'Microsoft.Storage/Blob' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + +### RawStreamInputDataSource +#### Properties +* **properties**: [RawInputDatasourceProperties](#rawinputdatasourceproperties): The properties that are associated with a raw input. +* **type**: 'Raw' (Required): Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. + + +## TrackedResourceTags ### Properties -* **name**: 'Standard' | string: The name of the SKU. Required on PUT (CreateOrReplace) requests. +### Additional Properties +* **Additional Properties Type**: string ## Transformation ### Properties @@ -722,8 +727,3 @@ * **streamingUnits**: int: Specifies the number of streaming units that the streaming job uses. * **validStreamingUnits**: int[]: Specifies the valid streaming units a streaming job can scale to. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - diff --git a/generated/subscription/log.out b/generated/subscription/log.out index 260d40410f..6b19ba03cd 100644 --- a/generated/subscription/log.out +++ b/generated/subscription/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.subscription-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Location' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/subscriptions.json:163:5 @@ -25,18 +25,18 @@ warning | PreCheck/SchemaMissingType | The schema 'TenantIdDescription' with an warning | PreCheck/SchemaMissingType | The schema 'TenantListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/subscriptions.json:314:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 0ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.subscription-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 11ms info | Processing batch task - {"tag":"microsoft.subscription-2020-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CanceledSubscriptionId' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json:349:5 @@ -61,7 +61,7 @@ info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.subscription-2020-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CanceledSubscriptionId' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-01-01/subscriptions.json:412:5 @@ -88,7 +88,7 @@ info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.subscription-2019-10-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CanceledSubscriptionId' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json:562:5 @@ -119,11 +119,11 @@ warning | PreCheck/SchemaMissingType | The schema 'PutAliasResponseProperties' w warning | PreCheck/SchemaMissingType | The schema 'PutAliasListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json:854:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 1ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.subscription-2019-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CanceledSubscriptionId' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-03-01-preview/subscriptions.json:155:5 @@ -140,7 +140,7 @@ info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.subscription-2018-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubscriptionCreationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json:206:5 @@ -163,7 +163,7 @@ info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.subscription-2018-03-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-03-01-preview/operations.json:65:5 @@ -184,7 +184,7 @@ info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.subscription-2017-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubscriptionDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json:243:5 @@ -197,5 +197,5 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/subscription/resource-manager/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json:338:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms -info | Autorest completed in 15.85s. 8 files generated. +info | autorest.bicep took 1ms +info | Autorest completed in 16.13s. 8 files generated. diff --git a/generated/subscription/microsoft.subscription/2021-10-01/types.md b/generated/subscription/microsoft.subscription/2021-10-01/types.md index e66e5d1cb3..6d785d47fe 100644 --- a/generated/subscription/microsoft.subscription/2021-10-01/types.md +++ b/generated/subscription/microsoft.subscription/2021-10-01/types.md @@ -23,6 +23,18 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.Subscription/policies' (ReadOnly, DeployTimeConstant): The resource type +## PutAliasRequestAdditionalProperties +### Properties +* **managementGroupId**: string (WriteOnly): Management group Id for the subscription. +* **subscriptionOwnerId**: string (WriteOnly): Owner Id of the subscription +* **subscriptionTenantId**: string (WriteOnly): Tenant Id of the subscription +* **tags**: [PutAliasRequestAdditionalPropertiesTags](#putaliasrequestadditionalpropertiestags) (WriteOnly): Tags for the subscription + +## PutAliasRequestAdditionalPropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## PutAliasRequestProperties ### Properties * **acceptOwnershipState**: 'Completed' | 'Expired' | 'Pending' | string (ReadOnly): The accept ownership state of the resource. @@ -42,18 +54,6 @@ For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enroll * **tags**: [SubscriptionAliasResponsePropertiesTags](#subscriptionaliasresponsepropertiestags) (ReadOnly): Tags for the subscription * **workload**: 'DevTest' | 'Production' | string: The workload type of the subscription. It can be either Production or DevTest. -## PutAliasRequestAdditionalProperties -### Properties -* **managementGroupId**: string (WriteOnly): Management group Id for the subscription. -* **subscriptionOwnerId**: string (WriteOnly): Owner Id of the subscription -* **subscriptionTenantId**: string (WriteOnly): Tenant Id of the subscription -* **tags**: [PutAliasRequestAdditionalPropertiesTags](#putaliasrequestadditionalpropertiestags) (WriteOnly): Tags for the subscription - -## PutAliasRequestAdditionalPropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## SubscriptionAliasResponsePropertiesTags ### Properties ### Additional Properties diff --git a/generated/support/log.out b/generated/support/log.out index bae18e2c6f..fed10bade6 100644 --- a/generated/support/log.out +++ b/generated/support/log.out @@ -3,20 +3,20 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.support-2021-06-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json:118:5 warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json:142:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.support-2020-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/support.json:783:5 @@ -26,7 +26,7 @@ warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this info | autorest.bicep took 10ms info | Processing batch task - {"tag":"microsoft.support-2019-05-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'OperationsListResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json:769:5 @@ -34,4 +34,4 @@ warning | PreCheck/SchemaMissingType | The schema 'Operation-display' with an un - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json:790:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 3ms -info | Autorest completed in 8.49s. 4 files generated. +info | Autorest completed in 8.36s. 4 files generated. diff --git a/generated/support/microsoft.support/2019-05-01-preview/types.md b/generated/support/microsoft.support/2019-05-01-preview/types.md index 6d574212ef..1a639350f3 100644 --- a/generated/support/microsoft.support/2019-05-01-preview/types.md +++ b/generated/support/microsoft.support/2019-05-01-preview/types.md @@ -18,29 +18,14 @@ * **properties**: [CommunicationDetailsProperties](#communicationdetailsproperties): Describes the properties of a communication resource. * **type**: 'Microsoft.Support/supportTickets/communications' (ReadOnly, DeployTimeConstant): The resource type -## SupportTicketDetailsProperties +## CommunicationDetailsProperties ### Properties -* **contactDetails**: [ContactProfile](#contactprofile) (Required): Contact information associated with support ticket. -* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when support ticket was created. -* **description**: string (Required): Detailed description of the question or issue. -* **enrollmentId**: string (ReadOnly): Enrollment ID associated with the support ticket. -* **modifiedDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when support ticket was last modified. -* **problemClassificationDisplayName**: string (ReadOnly): Localized name of problem classification. -* **problemClassificationId**: string (Required): Each Azure service has its own set of issue category called problem classification that corresponds to the type of problem you're experiencing. This parameter is the resource id of ProblemClassification resource. -* **problemStartTime**: string: Time in UTC (ISO 8601 format) when the problem started. -* **productionOutage**: bool (ReadOnly): Indicates if this issue is a production outage. -* **quotaTicketDetails**: [QuotaTicketDetails](#quotaticketdetails): Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at Support quota request. -* **require24X7Response**: bool: Indicates if this requires a 24x7 response from Azure. -* **serviceDisplayName**: string (ReadOnly): Localized name of Azure service. -* **serviceId**: string (Required): This is the resource id of the Azure service resource associated with the support ticket. -* **serviceLevelAgreement**: [ServiceLevelAgreement](#servicelevelagreement): Service Level Agreement details for a support ticket. -* **severity**: 'critical' | 'minimal' | 'moderate' | string (Required): A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. -* **status**: string (ReadOnly): Status of the support ticket. -* **supportEngineer**: [SupportEngineer](#supportengineer): Support engineer information. -* **supportPlanType**: string (ReadOnly): Support plan type associated with the support ticket. -* **supportTicketId**: string: System generated support ticket id that is unique. -* **technicalTicketDetails**: [TechnicalTicketDetails](#technicalticketdetails): Additional information for technical support ticket. -* **title**: string (Required): Title of the support ticket. +* **body**: string (Required): Body of the communication +* **communicationDirection**: 'inbound' | 'outbound' | string (ReadOnly): Direction of communication +* **communicationType**: 'phone' | 'web' | string (ReadOnly): Communication type +* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the communication was created. +* **sender**: string: Email address of the sender +* **subject**: string (Required): Subject of the communication ## ContactProfile ### Properties @@ -54,17 +39,17 @@ * **preferredTimeZone**: string (Required): Time zone of the user. This is the name of the time zone from Microsoft Time Zone Index Values. * **primaryEmailAddress**: string (Required): Primary email address. +## QuotaChangeRequest +### Properties +* **payload**: string: Payload of the quota increase request. +* **region**: string: Region for which the quota increase request is being made. + ## QuotaTicketDetails ### Properties * **quotaChangeRequests**: [QuotaChangeRequest](#quotachangerequest)[]: This property is required for providing the region and new quota limits. * **quotaChangeRequestSubType**: string: Required for certain quota types when there is a sub type that you are requesting quota increase for. Example: Batch * **quotaChangeRequestVersion**: string: Quota change request version -## QuotaChangeRequest -### Properties -* **payload**: string: Payload of the quota increase request. -* **region**: string: Region for which the quota increase request is being made. - ## ServiceLevelAgreement ### Properties * **expirationTime**: string (ReadOnly): Time in UTC (ISO 8601 format) when service level agreement expires. @@ -75,16 +60,31 @@ ### Properties * **emailAddress**: string (ReadOnly): Email address of the Azure Support engineer assigned to the support ticket. -## TechnicalTicketDetails +## SupportTicketDetailsProperties ### Properties -* **resourceId**: string: This is the resource id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. +* **contactDetails**: [ContactProfile](#contactprofile) (Required): Contact information associated with support ticket. +* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when support ticket was created. +* **description**: string (Required): Detailed description of the question or issue. +* **enrollmentId**: string (ReadOnly): Enrollment ID associated with the support ticket. +* **modifiedDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when support ticket was last modified. +* **problemClassificationDisplayName**: string (ReadOnly): Localized name of problem classification. +* **problemClassificationId**: string (Required): Each Azure service has its own set of issue category called problem classification that corresponds to the type of problem you're experiencing. This parameter is the resource id of ProblemClassification resource. +* **problemStartTime**: string: Time in UTC (ISO 8601 format) when the problem started. +* **productionOutage**: bool (ReadOnly): Indicates if this issue is a production outage. +* **quotaTicketDetails**: [QuotaTicketDetails](#quotaticketdetails): Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at Support quota request. +* **require24X7Response**: bool: Indicates if this requires a 24x7 response from Azure. +* **serviceDisplayName**: string (ReadOnly): Localized name of Azure service. +* **serviceId**: string (Required): This is the resource id of the Azure service resource associated with the support ticket. +* **serviceLevelAgreement**: [ServiceLevelAgreement](#servicelevelagreement): Service Level Agreement details for a support ticket. +* **severity**: 'critical' | 'minimal' | 'moderate' | string (Required): A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. +* **status**: string (ReadOnly): Status of the support ticket. +* **supportEngineer**: [SupportEngineer](#supportengineer): Support engineer information. +* **supportPlanType**: string (ReadOnly): Support plan type associated with the support ticket. +* **supportTicketId**: string: System generated support ticket id that is unique. +* **technicalTicketDetails**: [TechnicalTicketDetails](#technicalticketdetails): Additional information for technical support ticket. +* **title**: string (Required): Title of the support ticket. -## CommunicationDetailsProperties +## TechnicalTicketDetails ### Properties -* **body**: string (Required): Body of the communication -* **communicationDirection**: 'inbound' | 'outbound' | string (ReadOnly): Direction of communication -* **communicationType**: 'phone' | 'web' | string (ReadOnly): Communication type -* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the communication was created. -* **sender**: string: Email address of the sender -* **subject**: string (Required): Subject of the communication +* **resourceId**: string: This is the resource id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. diff --git a/generated/support/microsoft.support/2020-04-01/types.md b/generated/support/microsoft.support/2020-04-01/types.md index a8d2ce209c..5aba29898b 100644 --- a/generated/support/microsoft.support/2020-04-01/types.md +++ b/generated/support/microsoft.support/2020-04-01/types.md @@ -18,28 +18,14 @@ * **properties**: [CommunicationDetailsProperties](#communicationdetailsproperties): Describes the properties of a communication resource. * **type**: 'Microsoft.Support/supportTickets/communications' (ReadOnly, DeployTimeConstant): The resource type -## SupportTicketDetailsProperties +## CommunicationDetailsProperties ### Properties -* **contactDetails**: [ContactProfile](#contactprofile) (Required): Contact information associated with the support ticket. -* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the support ticket was created. -* **description**: string (Required): Detailed description of the question or issue. -* **enrollmentId**: string (ReadOnly): Enrollment Id associated with the support ticket. -* **modifiedDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the support ticket was last modified. -* **problemClassificationDisplayName**: string (ReadOnly): Localized name of problem classification. -* **problemClassificationId**: string (Required): Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. -* **problemStartTime**: string: Time in UTC (ISO 8601 format) when the problem started. -* **quotaTicketDetails**: [QuotaTicketDetails](#quotaticketdetails): Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at [Support quota request](https://aka.ms/supportrpquotarequestpayload). -* **require24X7Response**: bool: Indicates if this requires a 24x7 response from Azure. -* **serviceDisplayName**: string (ReadOnly): Localized name of the Azure service. -* **serviceId**: string (Required): This is the resource Id of the Azure service resource associated with the support ticket. -* **serviceLevelAgreement**: [ServiceLevelAgreement](#servicelevelagreement): Service Level Agreement details for a support ticket. -* **severity**: 'critical' | 'highestcriticalimpact' | 'minimal' | 'moderate' | string (Required): A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. -* **status**: string (ReadOnly): Status of the support ticket. -* **supportEngineer**: [SupportEngineer](#supportengineer): Support engineer information. -* **supportPlanType**: string (ReadOnly): Support plan type associated with the support ticket. -* **supportTicketId**: string: System generated support ticket Id that is unique. -* **technicalTicketDetails**: [TechnicalTicketDetails](#technicalticketdetails): Additional information for technical support ticket. -* **title**: string (Required): Title of the support ticket. +* **body**: string (Required): Body of the communication. +* **communicationDirection**: 'inbound' | 'outbound' | string (ReadOnly): Direction of communication. +* **communicationType**: 'phone' | 'web' | string (ReadOnly): Communication type. +* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the communication was created. +* **sender**: string: Email address of the sender. This property is required if called by a service principal. +* **subject**: string (Required): Subject of the communication. ## ContactProfile ### Properties @@ -53,17 +39,17 @@ * **preferredTimeZone**: string (Required): Time zone of the user. This is the name of the time zone from [Microsoft Time Zone Index Values](https://support.microsoft.com/help/973627/microsoft-time-zone-index-values). * **primaryEmailAddress**: string (Required): Primary email address. +## QuotaChangeRequest +### Properties +* **payload**: string: Payload of the quota increase request. +* **region**: string: Region for which the quota increase request is being made. + ## QuotaTicketDetails ### Properties * **quotaChangeRequests**: [QuotaChangeRequest](#quotachangerequest)[]: This property is required for providing the region and new quota limits. * **quotaChangeRequestSubType**: string: Required for certain quota types when there is a sub type, such as Batch, for which you are requesting a quota increase. * **quotaChangeRequestVersion**: string: Quota change request version. -## QuotaChangeRequest -### Properties -* **payload**: string: Payload of the quota increase request. -* **region**: string: Region for which the quota increase request is being made. - ## ServiceLevelAgreement ### Properties * **expirationTime**: string (ReadOnly): Time in UTC (ISO 8601 format) when the service level agreement expires. @@ -74,16 +60,30 @@ ### Properties * **emailAddress**: string (ReadOnly): Email address of the Azure Support engineer assigned to the support ticket. -## TechnicalTicketDetails +## SupportTicketDetailsProperties ### Properties -* **resourceId**: string: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. +* **contactDetails**: [ContactProfile](#contactprofile) (Required): Contact information associated with the support ticket. +* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the support ticket was created. +* **description**: string (Required): Detailed description of the question or issue. +* **enrollmentId**: string (ReadOnly): Enrollment Id associated with the support ticket. +* **modifiedDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the support ticket was last modified. +* **problemClassificationDisplayName**: string (ReadOnly): Localized name of problem classification. +* **problemClassificationId**: string (Required): Each Azure service has its own set of issue categories, also known as problem classification. This parameter is the unique Id for the type of problem you are experiencing. +* **problemStartTime**: string: Time in UTC (ISO 8601 format) when the problem started. +* **quotaTicketDetails**: [QuotaTicketDetails](#quotaticketdetails): Additional set of information required for quota increase support ticket for certain quota types, e.g.: Virtual machine cores. Get complete details about Quota payload support request along with examples at [Support quota request](https://aka.ms/supportrpquotarequestpayload). +* **require24X7Response**: bool: Indicates if this requires a 24x7 response from Azure. +* **serviceDisplayName**: string (ReadOnly): Localized name of the Azure service. +* **serviceId**: string (Required): This is the resource Id of the Azure service resource associated with the support ticket. +* **serviceLevelAgreement**: [ServiceLevelAgreement](#servicelevelagreement): Service Level Agreement details for a support ticket. +* **severity**: 'critical' | 'highestcriticalimpact' | 'minimal' | 'moderate' | string (Required): A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers. +* **status**: string (ReadOnly): Status of the support ticket. +* **supportEngineer**: [SupportEngineer](#supportengineer): Support engineer information. +* **supportPlanType**: string (ReadOnly): Support plan type associated with the support ticket. +* **supportTicketId**: string: System generated support ticket Id that is unique. +* **technicalTicketDetails**: [TechnicalTicketDetails](#technicalticketdetails): Additional information for technical support ticket. +* **title**: string (Required): Title of the support ticket. -## CommunicationDetailsProperties +## TechnicalTicketDetails ### Properties -* **body**: string (Required): Body of the communication. -* **communicationDirection**: 'inbound' | 'outbound' | string (ReadOnly): Direction of communication. -* **communicationType**: 'phone' | 'web' | string (ReadOnly): Communication type. -* **createdDate**: string (ReadOnly): Time in UTC (ISO 8601 format) when the communication was created. -* **sender**: string: Email address of the sender. This property is required if called by a service principal. -* **subject**: string (Required): Subject of the communication. +* **resourceId**: string: This is the resource Id of the Azure service resource (For example: A virtual machine resource or an HDInsight resource) for which the support ticket is created. diff --git a/generated/synapse/log.out b/generated/synapse/log.out index 826936c821..de88c46f03 100644 --- a/generated/synapse/log.out +++ b/generated/synapse/log.out @@ -21,7 +21,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.synapse-2021-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -42,7 +42,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MetadataSyncConfig-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/sqlPool.json:5432:9 @@ -163,7 +163,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'LibraryResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/library.json:158:5 @@ -265,7 +265,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 43ms +info | autorest.bicep took 25ms info | Processing batch task - {"tag":"microsoft.synapse-2021-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -286,7 +286,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/integrationRuntime.json:1329:5 @@ -385,7 +385,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 17ms +info | autorest.bicep took 19ms info | Processing batch task - {"tag":"microsoft.synapse-2021-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -406,7 +406,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/integrationRuntime.json:1277:5 @@ -545,7 +545,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 26ms +info | autorest.bicep took 28ms info | Processing batch task - {"tag":"microsoft.synapse-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -566,7 +566,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/integrationRuntime.json:1329:5 @@ -661,7 +661,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 16ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.synapse-2019-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -682,7 +682,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MetadataSyncConfig-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json:5322:9 @@ -775,7 +775,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 14ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.synapse-2020-04-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -796,10 +796,10 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.synapse-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -820,7 +820,7 @@ warning | DeprecatedConfig | Using directive.15.suppress which is deprecated and warning | DeprecatedConfig | Using directive.16.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.17.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MetadataSyncConfig-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlPool.json:5392:9 @@ -915,5 +915,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 15ms -info | Autorest completed in 104.75s. 16 files generated. +info | autorest.bicep took 22ms +info | Autorest completed in 102.02s. 16 files generated. diff --git a/generated/synapse/microsoft.synapse/2019-06-01-preview/types.md b/generated/synapse/microsoft.synapse/2019-06-01-preview/types.md index 14b6e966be..3907f75179 100644 --- a/generated/synapse/microsoft.synapse/2019-06-01-preview/types.md +++ b/generated/synapse/microsoft.synapse/2019-06-01-preview/types.md @@ -287,145 +287,123 @@ * **ApiVersion**: 2019-06-01-preview * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## PrivateLinkHubProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state - -## PrivateEndpointConnectionForPrivateLinkHubBasic -### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentity +## AadAdminProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## WorkspaceProperties +## AutoPauseProperties ### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## WorkspacePropertiesConnectivityEndpoints +## AutoScaleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## DataLakeStorageAccountDetails +## BigDataPoolResourceProperties ### Properties -* **accountUrl**: string: Account URL -* **filesystem**: string: Filesystem name +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string: The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## EncryptionDetails +## CmdkeySetupTypeProperties ### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object ## CustomerManagedKeyDetails ### Properties * **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace * **status**: string (ReadOnly): The customer managed key status on the workspace -## WorkspaceKeyDetails -### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name +## CustomSetupBase +* **Discriminator**: type -## WorkspacePropertiesExtraProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. -## ManagedVirtualNetworkSettings -### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. -## PrivateEndpointConnection +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. + + +## DataLakeStorageAccountDetails ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **accountUrl**: string: Account URL +* **filesystem**: string: Filesystem name -## PurviewConfiguration +## DataMaskingPolicyProperties ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## VirtualNetworkProfile +## DataMaskingRuleProperties ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## WorkspaceRepositoryConfiguration +## DynamicExecutorAllocation ### Properties -* **accountName**: string: Account name -* **clientId**: string: GitHub bring your own app client id -* **clientSecret**: [GitHubClientSecret](#githubclientsecret): Client secret information for factory's bring your own app repository configuration -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -## GitHubClientSecret +## EncryptionDetails ### Properties -* **byoaSecretAkvUrl**: string: Bring your own app client secret AKV URL -* **byoaSecretName**: string: Bring your own app client secret name in AKV +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## TrackedResourceTags +## EntityReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## AadAdminProperties +## EnvironmentVariableSetupTypeProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -496,6 +474,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -509,64 +488,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string: The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string: The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -651,11 +573,15 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## GeoBackupPolicyProperties ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. + +## GitHubClientSecret +### Properties +* **byoaSecretAkvUrl**: string: Bring your own app client secret AKV URL +* **byoaSecretName**: string: Bring your own app client secret name in AKV ## IntegrationRuntime * **Discriminator**: type @@ -675,15 +601,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedVirtualNetworkReference -### Properties -* **referenceName**: string (Required): Reference ManagedVirtualNetwork name. -* **type**: 'ManagedVirtualNetworkReference' | string (Required): Managed Virtual Network reference type. - -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -696,6 +617,11 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **cleanup**: bool: 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. @@ -705,11 +631,18 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. + +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any @@ -724,86 +657,46 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString -### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - -## IntegrationRuntimeCustomSetupScriptProperties +## IpFirewallRuleProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeDataProxyProperties +## KeyProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -## EntityReference +## LibraryInfo ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. - -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string: The last update time of the library. -## CmdkeySetupTypeProperties +## LibraryRequirements ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type - -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -819,10 +712,21 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace ## ManagedIdentitySqlControlSettingsModelProperties ### Properties @@ -833,7 +737,80 @@ For more information, see [Auditing to storage using Managed Identity authentica * **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state * **desiredState**: 'Disabled' | 'Enabled' | string: Desired state -## ServerSecurityAlertPolicyProperties +## ManagedIntegrationRuntimeTypeProperties +### Properties +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. + +## ManagedVirtualNetworkReference +### Properties +* **referenceName**: string (Required): Reference ManagedVirtualNetwork name. +* **type**: 'ManagedVirtualNetworkReference' | string (Required): Managed Virtual Network reference type. + +## ManagedVirtualNetworkSettings +### Properties +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration + +## MetadataSyncConfigProperties +### Properties +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int: The Sync Interval in minutes. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionForPrivateLinkHubBasic +### Properties +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. + +## PrivateLinkHubProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PurviewConfiguration +### Properties +* **purviewResourceId**: string: Purview Resource ID + +## SecretBase +* **Discriminator**: type + +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString +### Properties +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + +## SecurityAlertPolicyProperties ### Properties * **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. * **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action @@ -844,38 +821,23 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## SqlPoolResourceProperties -### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 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. -* **creationDate**: string: Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseId**: string: Source database to create from -* **status**: string: Resource status - -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -946,35 +908,44 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1045,73 +1016,74 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string: Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseId**: string: Source database to create from +* **status**: string: Resource status + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int: The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## TrackedResourceTags ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +### Additional Properties +* **Additional Properties Type**: string -## SecurityAlertPolicyProperties +## TrackedResourceTags ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## VirtualNetworkProfile ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1119,13 +1091,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1136,24 +1109,51 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string + +## WorkspacePropertiesExtraProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceRepositoryConfiguration +### Properties +* **accountName**: string: Account name +* **clientId**: string: GitHub bring your own app client id +* **clientSecret**: [GitHubClientSecret](#githubclientsecret): Client secret information for factory's bring your own app repository configuration +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/synapse/microsoft.synapse/2020-04-01-preview/types.md b/generated/synapse/microsoft.synapse/2020-04-01-preview/types.md index 531cbd3ab0..2730d7e9aa 100644 --- a/generated/synapse/microsoft.synapse/2020-04-01-preview/types.md +++ b/generated/synapse/microsoft.synapse/2020-04-01-preview/types.md @@ -26,6 +26,16 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Synapse/workspaces/sqlPools' (ReadOnly, DeployTimeConstant): The resource type +## SkuV3 +### Properties +* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. +* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. + +## SqlDatabaseDataRetention +### Properties +* **dropRetentionPeriod**: string: Specifies the dropped database retention period (ISO8601 format). +* **retentionPeriod**: string: Specifies the data retention period (ISO8601 format). + ## SqlDatabaseProperties ### Properties * **collation**: string: The collation of the database. @@ -34,10 +44,15 @@ * **status**: 'AutoClosed' | 'Copying' | 'Creating' | 'Disabled' | 'EmergencyMode' | 'Inaccessible' | 'Offline' | 'OfflineChangingDwPerformanceTiers' | 'OfflineSecondary' | 'Online' | 'OnlineChangingDwPerformanceTiers' | 'Paused' | 'Pausing' | 'Recovering' | 'RecoveryPending' | 'Restoring' | 'Resuming' | 'Scaling' | 'Shutdown' | 'Standby' | 'Suspect' | string (ReadOnly): The status of the database. * **storageRedundancy**: 'Geo' | 'GeoZone' | 'Local' | 'Zone' | string: The storage redundancy of the database. -## SqlDatabaseDataRetention +## SqlPoolProperties ### Properties -* **dropRetentionPeriod**: string: Specifies the dropped database retention period (ISO8601 format). -* **retentionPeriod**: string: Specifies the data retention period (ISO8601 format). +* **autoPauseTimer**: int: The period of inactivity in minutes before automatically pausing the sql pool. +* **autoResume**: bool: Indicates whether the sql pool can automatically resume when connection attempts are made. +* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the sql pool. +* **maxServiceObjectiveName**: string: The max service level objective name of the sql pool. +* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the sql pool. +* **sqlPoolGuid**: string (ReadOnly): The Guid of the sql pool. +* **status**: 'Creating' | 'Dropping' | 'Error' | 'Inaccessible' | 'Invisible' | 'Offline' | 'Online' | 'Paused' | 'Pausing' | 'Resuming' | 'Scaling' | 'Unknown' | string (ReadOnly): The status of the sql pool. ## SystemData ### Properties @@ -53,21 +68,6 @@ ### Additional Properties * **Additional Properties Type**: string -## SqlPoolProperties -### Properties -* **autoPauseTimer**: int: The period of inactivity in minutes before automatically pausing the sql pool. -* **autoResume**: bool: Indicates whether the sql pool can automatically resume when connection attempts are made. -* **currentServiceObjectiveName**: string (ReadOnly): The current service level objective name of the sql pool. -* **maxServiceObjectiveName**: string: The max service level objective name of the sql pool. -* **requestedServiceObjectiveName**: string (ReadOnly): The requested service level objective name of the sql pool. -* **sqlPoolGuid**: string (ReadOnly): The Guid of the sql pool. -* **status**: 'Creating' | 'Dropping' | 'Error' | 'Inaccessible' | 'Invisible' | 'Offline' | 'Online' | 'Paused' | 'Pausing' | 'Resuming' | 'Scaling' | 'Unknown' | string (ReadOnly): The status of the sql pool. - -## SkuV3 -### Properties -* **name**: string (Required): The name of the SKU, typically, a letter + Number code, e.g. P3. -* **tier**: string: The tier or edition of the particular SKU, e.g. Basic, Premium. - ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/synapse/microsoft.synapse/2020-12-01/types.md b/generated/synapse/microsoft.synapse/2020-12-01/types.md index db476e3d7f..2ee688b3af 100644 --- a/generated/synapse/microsoft.synapse/2020-12-01/types.md +++ b/generated/synapse/microsoft.synapse/2020-12-01/types.md @@ -298,138 +298,131 @@ * **ApiVersion**: 2020-12-01 * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## PrivateLinkHubProperties +## AadAdminProperties ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## PrivateEndpointConnectionForPrivateLinkHubBasic +## AutoPauseProperties ### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## PrivateEndpointConnectionProperties +## AutoScaleProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## PrivateEndpoint +## BigDataPoolResourceProperties ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string: The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## PrivateLinkServiceConnectionState +## CmdkeySetupTypeProperties ### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object -## TrackedResourceTags +## CustomerManagedKeyDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace +* **status**: string (ReadOnly): The customer managed key status on the workspace -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace +## CustomSetupBase +* **Discriminator**: type -## WorkspaceProperties -### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. + +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. + +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. -## WorkspacePropertiesConnectivityEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string ## DataLakeStorageAccountDetails ### Properties * **accountUrl**: string: Account URL * **filesystem**: string: Filesystem name -## EncryptionDetails -### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled - -## CustomerManagedKeyDetails -### Properties -* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace -* **status**: string (ReadOnly): The customer managed key status on the workspace - -## WorkspaceKeyDetails -### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name - -## WorkspacePropertiesExtraProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## ManagedVirtualNetworkSettings +## DataMaskingPolicyProperties ### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## PrivateEndpointConnection +## DataMaskingRuleProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## PurviewConfiguration +## DynamicExecutorAllocation ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -## VirtualNetworkProfile +## EncryptionDetails ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## WorkspaceRepositoryConfiguration +## EncryptionProtectorProperties ### Properties -* **accountName**: string: Account name -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## TrackedResourceTags +## EntityReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## AadAdminProperties +## EnvironmentVariableSetupTypeProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -500,6 +493,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -513,72 +507,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string: The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -663,11 +592,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## GeoBackupPolicyProperties ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. ## IntegrationRuntime * **Discriminator**: type @@ -686,10 +614,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -702,6 +630,11 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. @@ -710,12 +643,18 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. + +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any @@ -730,86 +669,47 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString -### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - -## IntegrationRuntimeCustomSetupScriptProperties +## IpFirewallRuleProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeDataProxyProperties +## KeyProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -## EntityReference +## LibraryInfo ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. - -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. -## CmdkeySetupTypeProperties +## LibraryRequirements ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type - -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -825,10 +725,21 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace ## ManagedIdentitySqlControlSettingsModelProperties ### Properties @@ -839,7 +750,75 @@ For more information, see [Auditing to storage using Managed Identity authentica * **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state * **desiredState**: 'Disabled' | 'Enabled' | string: Desired state -## ServerSecurityAlertPolicyProperties +## ManagedIntegrationRuntimeTypeProperties +### Properties +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. + +## ManagedVirtualNetworkSettings +### Properties +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration + +## MetadataSyncConfigProperties +### Properties +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int: The Sync Interval in minutes. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionForPrivateLinkHubBasic +### Properties +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. + +## PrivateLinkHubProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PurviewConfiguration +### Properties +* **purviewResourceId**: string: Purview Resource ID + +## SecretBase +* **Discriminator**: type + +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString +### Properties +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + +## SecurityAlertPolicyProperties ### Properties * **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. * **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action @@ -850,39 +829,23 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## SqlPoolResourceProperties -### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 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. -* **creationDate**: string: Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseId**: string: Source database to create from -* **status**: string: Resource status -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. - -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -953,35 +916,44 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1052,73 +1024,75 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string: Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseId**: string: Source database to create from +* **status**: string: Resource status +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int: The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## TrackedResourceTags ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +### Additional Properties +* **Additional Properties Type**: string -## SecurityAlertPolicyProperties +## TrackedResourceTags ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## VirtualNetworkProfile ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1126,13 +1100,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1143,24 +1118,49 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string + +## WorkspacePropertiesExtraProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceRepositoryConfiguration +### Properties +* **accountName**: string: Account name +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/synapse/microsoft.synapse/2021-03-01/types.md b/generated/synapse/microsoft.synapse/2021-03-01/types.md index f5b7f53933..541faaf7b5 100644 --- a/generated/synapse/microsoft.synapse/2021-03-01/types.md +++ b/generated/synapse/microsoft.synapse/2021-03-01/types.md @@ -298,139 +298,131 @@ * **ApiVersion**: 2021-03-01 * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## PrivateLinkHubProperties +## AadAdminProperties ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## PrivateEndpointConnectionForPrivateLinkHubBasic +## AutoPauseProperties ### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## PrivateEndpointConnectionProperties +## AutoScaleProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## PrivateEndpoint +## BigDataPoolResourceProperties ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string: The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## PrivateLinkServiceConnectionState +## CmdkeySetupTypeProperties ### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object -## TrackedResourceTags +## CustomerManagedKeyDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace +* **status**: string (ReadOnly): The customer managed key status on the workspace -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace +## CustomSetupBase +* **Discriminator**: type -## WorkspaceProperties -### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. + +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. + +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. -## WorkspacePropertiesConnectivityEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string ## DataLakeStorageAccountDetails ### Properties * **accountUrl**: string: Account URL * **filesystem**: string: Filesystem name -## EncryptionDetails -### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled - -## CustomerManagedKeyDetails -### Properties -* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace -* **status**: string (ReadOnly): The customer managed key status on the workspace - -## WorkspaceKeyDetails -### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name - -## WorkspacePropertiesExtraProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## ManagedVirtualNetworkSettings +## DataMaskingPolicyProperties ### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## PrivateEndpointConnection +## DataMaskingRuleProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## PurviewConfiguration +## DynamicExecutorAllocation ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -## VirtualNetworkProfile +## EncryptionDetails ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## WorkspaceRepositoryConfiguration +## EncryptionProtectorProperties ### Properties -* **accountName**: string: Account name -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## TrackedResourceTags +## EntityReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## AadAdminProperties +## EnvironmentVariableSetupTypeProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -501,6 +493,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -514,72 +507,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string: The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -664,11 +592,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## GeoBackupPolicyProperties ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. ## IntegrationRuntime * **Discriminator**: type @@ -687,10 +614,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -703,6 +630,11 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. @@ -711,12 +643,18 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. + +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any @@ -731,86 +669,47 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString -### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - -## IntegrationRuntimeCustomSetupScriptProperties +## IpFirewallRuleProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeDataProxyProperties +## KeyProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -## EntityReference +## LibraryInfo ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. - -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. -## CmdkeySetupTypeProperties +## LibraryRequirements ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type - -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -826,10 +725,21 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace ## ManagedIdentitySqlControlSettingsModelProperties ### Properties @@ -840,7 +750,75 @@ For more information, see [Auditing to storage using Managed Identity authentica * **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state * **desiredState**: 'Disabled' | 'Enabled' | string: Desired state -## ServerSecurityAlertPolicyProperties +## ManagedIntegrationRuntimeTypeProperties +### Properties +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. + +## ManagedVirtualNetworkSettings +### Properties +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration + +## MetadataSyncConfigProperties +### Properties +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int: The Sync Interval in minutes. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionForPrivateLinkHubBasic +### Properties +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. + +## PrivateLinkHubProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PurviewConfiguration +### Properties +* **purviewResourceId**: string: Purview Resource ID + +## SecretBase +* **Discriminator**: type + +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString +### Properties +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + +## SecurityAlertPolicyProperties ### Properties * **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. * **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action @@ -851,39 +829,23 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## SqlPoolResourceProperties -### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | 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. -* **creationDate**: string: Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseId**: string: Source database to create from -* **status**: string: Resource status -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. - -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -954,35 +916,44 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1053,73 +1024,75 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string: Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseId**: string: Source database to create from +* **status**: string: Resource status +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int: The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## TrackedResourceTags ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +### Additional Properties +* **Additional Properties Type**: string -## SecurityAlertPolicyProperties +## TrackedResourceTags ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## VirtualNetworkProfile ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1127,13 +1100,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1144,24 +1118,50 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string + +## WorkspacePropertiesExtraProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceRepositoryConfiguration +### Properties +* **accountName**: string: Account name +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/synapse/microsoft.synapse/2021-04-01-preview/types.md b/generated/synapse/microsoft.synapse/2021-04-01-preview/types.md index b41ed3b073..4a4bd9c650 100644 --- a/generated/synapse/microsoft.synapse/2021-04-01-preview/types.md +++ b/generated/synapse/microsoft.synapse/2021-04-01-preview/types.md @@ -376,139 +376,184 @@ * **ApiVersion**: 2021-04-01-preview * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## PrivateLinkHubProperties +## AadAdminProperties ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## PrivateEndpointConnectionForPrivateLinkHubBasic +## AutoPauseProperties ### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## PrivateEndpointConnectionProperties +## AutoScaleProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## PrivateEndpoint +## AzureSku ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. +* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. -## PrivateLinkServiceConnectionState +## BigDataPoolResourceProperties ### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string: The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## TrackedResourceTags +## ClusterPrincipalProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal -## ManagedIdentity +## CmdkeySetupTypeProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object -## WorkspaceProperties +## CustomerManagedKeyDetails ### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace +* **status**: string (ReadOnly): The customer managed key status on the workspace -## WorkspacePropertiesConnectivityEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string +## CustomSetupBase +* **Discriminator**: type -## DataLakeStorageAccountDetails +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. + +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. + +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. + + +## DatabasePrincipalProperties ### Properties -* **accountUrl**: string: Account URL -* **filesystem**: string: Filesystem name +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal -## EncryptionDetails +## DatabaseStatistics ### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled +* **size**: int: The database size - the total size of compressed data and index in bytes. -## CustomerManagedKeyDetails +## DataLakeStorageAccountDetails ### Properties -* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace -* **status**: string (ReadOnly): The customer managed key status on the workspace +* **accountUrl**: string: Account URL +* **filesystem**: string: Filesystem name -## WorkspaceKeyDetails +## DataMaskingPolicyProperties ### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## WorkspacePropertiesExtraProperties +## DataMaskingRuleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## ManagedVirtualNetworkSettings +## DynamicExecutorAllocation ### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -## PrivateEndpointConnection +## EncryptionDetails ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## PurviewConfiguration +## EncryptionProtectorProperties ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## VirtualNetworkProfile +## EntityReference ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## WorkspaceRepositoryConfiguration +## EnvironmentVariableSetupTypeProperties ### Properties -* **accountName**: string: Account name -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## TrackedResourceTags +## EventGridConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. +* **consumerGroup**: string (Required): The event hub consumer group. +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventHubResourceId**: string (Required): The resource ID where the event grid is configured to send events. +* **ignoreFirstRecord**: bool: A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **storageAccountResourceId**: string (Required): The resource ID of the storage account where the data resides. +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## AadAdminProperties +## EventHubConnectionProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **compression**: 'GZip' | 'None' | string: The compression type +* **consumerGroup**: string (Required): The event hub consumer group. +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventHubResourceId**: string (Required): The resource ID of the event hub to be used to create a data connection. +* **eventSystemProperties**: string[]: System properties of the event hub +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -579,6 +624,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -592,72 +638,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string: The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -742,11 +723,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## GeoBackupPolicyProperties ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. ## IntegrationRuntime * **Discriminator**: type @@ -765,10 +745,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -781,6 +761,11 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. @@ -789,11 +774,18 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. + +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any @@ -808,86 +800,67 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString +## IotHubConnectionProperties ### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +* **consumerGroup**: string (Required): The iot hub consumer group. +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventSystemProperties**: string[]: System properties of the iot hub +* **iotHubResourceId**: string (Required): The resource ID of the Iot hub to be used to create a data connection. +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **sharedAccessPolicyName**: string (Required): The name of the share access policy +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## IntegrationRuntimeCustomSetupScriptProperties +## IpFirewallRuleProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeDataProxyProperties +## KeyProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -## EntityReference +## KustoPoolProperties ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. - -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - +* **dataIngestionUri**: string (ReadOnly): The Kusto Pool data ingestion URI. +* **engineType**: 'V2' | 'V3' | string: The engine type +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **state**: 'Creating' | 'Deleted' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | 'Unavailable' | 'Updating' | string (ReadOnly): The state of the resource. +* **stateReason**: string (ReadOnly): The reason for the Kusto Pool's current state. +* **uri**: string (ReadOnly): The Kusto Pool URI. +* **workspaceUid**: string: The workspace unique identifier. -## CmdkeySetupTypeProperties +## LibraryInfo ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type - -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. +## LibraryRequirements +### Properties +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -903,160 +876,135 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange -## KustoPoolProperties +## MaintenanceWindowTimeRange ### Properties -* **dataIngestionUri**: string (ReadOnly): The Kusto Pool data ingestion URI. -* **engineType**: 'V2' | 'V3' | string: The engine type -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **state**: 'Creating' | 'Deleted' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | 'Unavailable' | 'Updating' | string (ReadOnly): The state of the resource. -* **stateReason**: string (ReadOnly): The reason for the Kusto Pool's current state. -* **uri**: string (ReadOnly): The Kusto Pool URI. -* **workspaceUid**: string: The workspace unique identifier. +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. -## AzureSku +## ManagedIdentity ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Dev(No SLA)_Standard_D11_v2' | 'Dev(No SLA)_Standard_E2a_v4' | 'Standard_D11_v2' | 'Standard_D12_v2' | 'Standard_D13_v2' | 'Standard_D14_v2' | 'Standard_DS13_v2+1TB_PS' | 'Standard_DS13_v2+2TB_PS' | 'Standard_DS14_v2+3TB_PS' | 'Standard_DS14_v2+4TB_PS' | 'Standard_E16a_v4' | 'Standard_E16as_v4+3TB_PS' | 'Standard_E16as_v4+4TB_PS' | 'Standard_E2a_v4' | 'Standard_E4a_v4' | 'Standard_E64i_v3' | 'Standard_E80ids_v4' | 'Standard_E8a_v4' | 'Standard_E8as_v4+1TB_PS' | 'Standard_E8as_v4+2TB_PS' | 'Standard_L16s' | 'Standard_L16s_v2' | 'Standard_L4s' | 'Standard_L8s' | 'Standard_L8s_v2' | string (Required): SKU name. -* **tier**: 'Basic' | 'Standard' | string (Required): SKU tier. +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned': The type of managed identity for the workspace -## SystemData +## ManagedIdentitySqlControlSettingsModelProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **grantSqlControlToManagedIdentity**: [ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity](#managedidentitysqlcontrolsettingsmodelpropertiesgrantsqlcontroltomanagedidentity): Grant sql control to managed identity -## TrackedResourceTags +## ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state +* **desiredState**: 'Disabled' | 'Enabled' | string: Desired state -## ReadWriteDatabaseProperties +## ManagedIntegrationRuntimeTypeProperties ### Properties -* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. -* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. -* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. -## DatabaseStatistics +## ManagedVirtualNetworkSettings ### Properties -* **size**: int: The database size - the total size of compressed data and index in bytes. +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration -## EventGridConnectionProperties +## MetadataSyncConfigProperties ### Properties -* **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. -* **consumerGroup**: string (Required): The event hub consumer group. -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventHubResourceId**: string (Required): The resource ID where the event grid is configured to send events. -* **ignoreFirstRecord**: bool: A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **storageAccountResourceId**: string (Required): The resource ID of the storage account where the data resides. -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int: The Sync Interval in minutes. -## EventHubConnectionProperties +## PrivateEndpoint ### Properties -* **compression**: 'GZip' | 'None' | string: The compression type -* **consumerGroup**: string (Required): The event hub consumer group. -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventHubResourceId**: string (Required): The resource ID of the event hub to be used to create a data connection. -* **eventSystemProperties**: string[]: System properties of the event hub -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +* **id**: string (ReadOnly): Resource id of the private endpoint. -## IotHubConnectionProperties +## PrivateEndpointConnection ### Properties -* **consumerGroup**: string (Required): The iot hub consumer group. -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventSystemProperties**: string[]: System properties of the iot hub -* **iotHubResourceId**: string (Required): The resource ID of the Iot hub to be used to create a data connection. -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **sharedAccessPolicyName**: string (Required): The name of the share access policy -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## DatabasePrincipalProperties +## PrivateEndpointConnectionForPrivateLinkHubBasic ### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -## ClusterPrincipalProperties +## PrivateEndpointConnectionProperties ### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. -## ManagedIdentitySqlControlSettingsModelProperties +## PrivateLinkHubProperties ### Properties -* **grantSqlControlToManagedIdentity**: [ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity](#managedidentitysqlcontrolsettingsmodelpropertiesgrantsqlcontroltomanagedidentity): Grant sql control to managed identity +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state -## ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity +## PrivateLinkServiceConnectionState ### Properties -* **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state -* **desiredState**: 'Disabled' | 'Enabled' | string: Desired state +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. -## ServerSecurityAlertPolicyProperties +## PurviewConfiguration ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **purviewResourceId**: string: Purview Resource ID -## SqlPoolResourceProperties +## ReadWriteDatabaseProperties ### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. +* **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. +* **isFollowed**: bool (ReadOnly): Indicates whether the database is followed. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. +* **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -Default: regular sql pool creation. +## SecretBase +* **Discriminator**: type -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. +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. -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. -* **creationDate**: string: Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseId**: string: Source database to create from -* **status**: string: Resource status -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. +## SecureString +### Properties +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + +## SecurityAlertPolicyProperties +### Properties +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1127,35 +1075,44 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1226,73 +1183,89 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string: Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseId**: string: Source database to create from +* **status**: string: Resource status +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int: The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## SystemData ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## SecurityAlertPolicyProperties +## TrackedResourceTags ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## VirtualNetworkProfile ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1300,13 +1273,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1317,24 +1291,50 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string + +## WorkspacePropertiesExtraProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceRepositoryConfiguration +### Properties +* **accountName**: string: Account name +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/synapse/microsoft.synapse/2021-05-01/types.md b/generated/synapse/microsoft.synapse/2021-05-01/types.md index c6e9f17f25..edcaf1d918 100644 --- a/generated/synapse/microsoft.synapse/2021-05-01/types.md +++ b/generated/synapse/microsoft.synapse/2021-05-01/types.md @@ -298,161 +298,136 @@ * **ApiVersion**: 2021-05-01 * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## PrivateLinkHubProperties -### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state - -## PrivateEndpointConnectionForPrivateLinkHubBasic -### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. - -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. - -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. - -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedIdentity +## AadAdminProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned': The type of managed identity for the workspace -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## UserAssignedManagedIdentities +## AutoPauseProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## UserAssignedManagedIdentity +## AutoScaleProperties ### Properties -* **clientId**: string (ReadOnly): The client ID. -* **principalId**: string (ReadOnly): The principal ID. +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## WorkspaceProperties +## BigDataPoolResourceProperties ### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **cspWorkspaceAdminProperties**: [CspWorkspaceAdminProperties](#cspworkspaceadminproperties): Initial workspace AAD admin properties for a CSP subscription -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string: The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## WorkspacePropertiesConnectivityEndpoints +## CmdkeySetupTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object ## CspWorkspaceAdminProperties ### Properties * **initialWorkspaceAdminObjectId**: string: AAD object ID of initial workspace admin -## DataLakeStorageAccountDetails -### Properties -* **accountUrl**: string: Account URL -* **filesystem**: string: Filesystem name - -## EncryptionDetails -### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled - ## CustomerManagedKeyDetails ### Properties * **kekIdentity**: [KekIdentityProperties](#kekidentityproperties): Key encryption key properties * **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace * **status**: string (ReadOnly): The customer managed key status on the workspace -## KekIdentityProperties -### Properties -* **userAssignedIdentity**: string: User assigned identity resource Id -* **useSystemAssignedIdentity**: any: Anything +## CustomSetupBase +* **Discriminator**: type -## WorkspaceKeyDetails -### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. -## WorkspacePropertiesExtraProperties +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. + +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. + + +## DataLakeStorageAccountDetails ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **accountUrl**: string: Account URL +* **filesystem**: string: Filesystem name -## ManagedVirtualNetworkSettings +## DataMaskingPolicyProperties ### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## PrivateEndpointConnection +## DataMaskingRuleProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## PurviewConfiguration +## DynamicExecutorAllocation ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -## VirtualNetworkProfile +## EncryptionDetails ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## WorkspaceRepositoryConfiguration +## EncryptionProtectorProperties ### Properties -* **accountName**: string: Account name -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## TrackedResourceTags +## EntityReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## AadAdminProperties +## EnvironmentVariableSetupTypeProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -523,6 +498,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -536,72 +512,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string: The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## EncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -686,11 +597,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## GeoBackupPolicyProperties ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. ## IntegrationRuntime * **Discriminator**: type @@ -709,10 +619,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -725,6 +635,11 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. @@ -733,12 +648,18 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. + +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any @@ -753,86 +674,52 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString +## IpFirewallRuleProperties ### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeCustomSetupScriptProperties +## KekIdentityProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **userAssignedIdentity**: string: User assigned identity resource Id +* **useSystemAssignedIdentity**: any: Anything -## IntegrationRuntimeDataProxyProperties +## KeyProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -## EntityReference +## LibraryInfo ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. - -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. -## CmdkeySetupTypeProperties +## LibraryRequirements ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type - -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -848,10 +735,22 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned': The type of managed identity for the workspace +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. ## ManagedIdentitySqlControlSettingsModelProperties ### Properties @@ -862,50 +761,102 @@ For more information, see [Auditing to storage using Managed Identity authentica * **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state * **desiredState**: 'Disabled' | 'Enabled' | string: Desired state -## ServerSecurityAlertPolicyProperties +## ManagedIntegrationRuntimeTypeProperties ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. -## SqlPoolResourceProperties +## ManagedVirtualNetworkSettings ### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration -Default: regular sql pool creation. +## MetadataSyncConfigProperties +### Properties +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int: The Sync Interval in minutes. -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. +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. -Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -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. -* **creationDate**: string: Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseId**: string: Source database to create from -* **status**: string: Resource status -* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. +## PrivateEndpointConnectionForPrivateLinkHubBasic +### Properties +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. + +## PrivateLinkHubProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PurviewConfiguration +### Properties +* **purviewResourceId**: string: Purview Resource ID + +## SecretBase +* **Discriminator**: type + +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString +### Properties +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + +## SecurityAlertPolicyProperties +### Properties +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -976,35 +927,44 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1075,73 +1035,85 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string: Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string: Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseId**: string: Source database to create from +* **status**: string: Resource status +* **storageAccountType**: 'GRS' | 'LRS' | 'ZRS' | string: The storage account type used to store backups for this sql pool. + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int: The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## TrackedResourceTags ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +### Additional Properties +* **Additional Properties Type**: string -## SecurityAlertPolicyProperties +## TrackedResourceTags ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## UserAssignedManagedIdentities ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) + +## UserAssignedManagedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID. +* **principalId**: string (ReadOnly): The principal ID. + +## VirtualNetworkProfile +### Properties +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1149,13 +1121,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1166,24 +1139,51 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **cspWorkspaceAdminProperties**: [CspWorkspaceAdminProperties](#cspworkspaceadminproperties): Initial workspace AAD admin properties for a CSP subscription +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string + +## WorkspacePropertiesExtraProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceRepositoryConfiguration +### Properties +* **accountName**: string: Account name +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/synapse/microsoft.synapse/2021-06-01-preview/types.md b/generated/synapse/microsoft.synapse/2021-06-01-preview/types.md index 5ba9220ed8..4c05ec755d 100644 --- a/generated/synapse/microsoft.synapse/2021-06-01-preview/types.md +++ b/generated/synapse/microsoft.synapse/2021-06-01-preview/types.md @@ -421,86 +421,125 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [LanguageExtensionsList](#languageextensionslist) -## PrivateLinkHubProperties +## AadAdminProperties ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## PrivateEndpointConnectionForPrivateLinkHubBasic +## AttachedDatabaseConfigurationProperties ### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the kusto pool. +* **clusterResourceId**: string (Required): The resource id of the kusto pool where the databases you would like to attach reside. +* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. +* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database -## PrivateEndpointConnectionProperties +## AutoPauseProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## PrivateEndpoint +## AutoScaleProperties ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## PrivateLinkServiceConnectionState +## AzureADOnlyAuthenticationProperties ### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory Only Authentication enabled +* **creationDate**: string (ReadOnly): property configuration date +* **state**: 'Consistent' | 'InConsistent' | 'Updating' | string (ReadOnly): Azure Active Directory Only Authentication configuration state -## TrackedResourceTags +## AzureSku ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: The number of instances of the cluster. +* **name**: 'Compute optimized' | 'Storage optimized' | string (Required): SKU name. +* **size**: 'Extra small' | 'Large' | 'Medium' | 'Small' | string (Required): SKU size. -## ManagedIdentity +## BigDataPoolResourceProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned': The type of managed identity for the workspace -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string (ReadOnly): The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [SparkConfigProperties](#sparkconfigproperties): SparkConfig Properties for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## UserAssignedManagedIdentities +## ClusterPrincipalProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) +* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal -## UserAssignedManagedIdentity +## CmdkeySetupTypeProperties ### Properties -* **clientId**: string (ReadOnly): The client ID. -* **principalId**: string (ReadOnly): The principal ID. +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object -## WorkspaceProperties +## CspWorkspaceAdminProperties ### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **azureADOnlyAuthentication**: bool: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **cspWorkspaceAdminProperties**: [CspWorkspaceAdminProperties](#cspworkspaceadminproperties): Initial workspace AAD admin properties for a CSP subscription -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **settings**: [WorkspacePropertiesSettings](#workspacepropertiessettings) (ReadOnly): Workspace settings -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **trustedServiceBypassEnabled**: bool: Is trustedServiceBypassEnabled for the workspace -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +* **initialWorkspaceAdminObjectId**: string: AAD object ID of initial workspace admin -## WorkspacePropertiesConnectivityEndpoints +## CustomerManagedKeyDetails ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **kekIdentity**: [KekIdentityProperties](#kekidentityproperties): Key encryption key properties +* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace +* **status**: string (ReadOnly): The customer managed key status on the workspace -## CspWorkspaceAdminProperties +## CustomSetupBase +* **Discriminator**: type + +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. + +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. + +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. + + +## DatabasePrincipalProperties ### Properties -* **initialWorkspaceAdminObjectId**: string: AAD object ID of initial workspace admin +* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. +* **principalName**: string (ReadOnly): The principal name +* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. +* **tenantId**: string: The tenant id of the principal +* **tenantName**: string (ReadOnly): The tenant name of the principal + +## DatabaseStatistics +### Properties +* **size**: int: The database size - the total size of compressed data and index in bytes. ## DataLakeStorageAccountDetails ### Properties @@ -509,83 +548,86 @@ * **filesystem**: string: Filesystem name * **resourceId**: string: ARM resource Id of this storage account -## EncryptionDetails -### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled - -## CustomerManagedKeyDetails -### Properties -* **kekIdentity**: [KekIdentityProperties](#kekidentityproperties): Key encryption key properties -* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace -* **status**: string (ReadOnly): The customer managed key status on the workspace - -## KekIdentityProperties -### Properties -* **userAssignedIdentity**: string: User assigned identity resource Id -* **useSystemAssignedIdentity**: any: Anything - -## WorkspaceKeyDetails +## DataMaskingPolicyProperties ### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## WorkspacePropertiesExtraProperties +## DataMaskingRuleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## ManagedVirtualNetworkSettings +## DedicatedSQLminimalTlsSettingsProperties ### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +* **minimalTlsVersion**: string: The minimal tls version of the sql server. -## PrivateEndpointConnection +## DynamicExecutorAllocation ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. +* **maxExecutors**: int: The maximum number of executors alloted +* **minExecutors**: int: The minimum number of executors alloted -## PurviewConfiguration +## EncryptionDetails ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## WorkspacePropertiesSettings +## EncryptionProtectorProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## VirtualNetworkProfile +## EntityReference ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## WorkspaceRepositoryConfiguration +## EnvironmentVariableSetupTypeProperties ### Properties -* **accountName**: string: Account name -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## TrackedResourceTags +## EventGridConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. +* **consumerGroup**: string (Required): The event hub consumer group. +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventHubResourceId**: string (Required): The resource ID where the event grid is configured to send events. +* **ignoreFirstRecord**: bool: A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **storageAccountResourceId**: string (Required): The resource ID of the storage account where the data resides. +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## AadAdminProperties +## EventHubConnectionProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **compression**: 'GZip' | 'None' | string: The compression type +* **consumerGroup**: string (Required): The event hub consumer group. +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventHubResourceId**: string (Required): The resource ID of the event hub to be used to create a data connection. +* **eventSystemProperties**: string[]: System properties of the event hub +* **managedIdentityResourceId**: string: The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -656,6 +698,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -669,91 +712,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthenticationProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory Only Authentication enabled -* **creationDate**: string (ReadOnly): property configuration date -* **state**: 'Consistent' | 'InConsistent' | 'Updating' | string (ReadOnly): Azure Active Directory Only Authentication configuration state - -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string (ReadOnly): The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [SparkConfigProperties](#sparkconfigproperties): SparkConfig Properties for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string: The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -* **maxExecutors**: int: The maximum number of executors alloted -* **minExecutors**: int: The minimum number of executors alloted - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## SparkConfigProperties -### Properties -* **configurationType**: 'Artifact' | 'File' | string: The type of the spark config properties file. -* **content**: string: The spark config properties. -* **filename**: string: The filename of the spark config properties file. -* **time**: string (ReadOnly): The last update time of the spark config properties file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DedicatedSQLminimalTlsSettingsProperties -### Properties -* **minimalTlsVersion**: string: The minimal tls version of the sql server. - -## EncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -838,11 +797,20 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## FollowerDatabaseDefinition ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. +* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. +* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. + +## FollowerDatabaseListResult +### Properties +* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. + +## GeoBackupPolicyProperties +### Properties +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. ## IntegrationRuntime * **Discriminator**: type @@ -862,16 +830,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedIntegrationRuntimeManagedVirtualNetworkReference -### Properties -* **id**: string: The id of the managed virtual network. -* **referenceName**: string: The reference name of the managed virtual network. -* **type**: string: The type of the managed virtual network. - -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -884,6 +846,11 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **cleanup**: bool: 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. @@ -893,12 +860,18 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. + +## IntegrationRuntimeSsisCatalogInfo +### Properties +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. ### Additional Properties * **Additional Properties Type**: any @@ -913,86 +886,88 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString +## IotHubConnectionProperties ### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +* **consumerGroup**: string (Required): The iot hub consumer group. +* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. +* **eventSystemProperties**: string[]: System properties of the iot hub +* **iotHubResourceId**: string (Required): The resource ID of the Iot hub to be used to create a data connection. +* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **sharedAccessPolicyName**: string (Required): The name of the share access policy +* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. -## IntegrationRuntimeCustomSetupScriptProperties +## IpFirewallRuleProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeDataProxyProperties +## KekIdentityProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **userAssignedIdentity**: string: User assigned identity resource Id +* **useSystemAssignedIdentity**: any: Anything -## EntityReference +## KeyProperties ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. +## KustoPoolProperties +### Properties +* **dataIngestionUri**: string (ReadOnly): The Kusto Pool data ingestion URI. +* **enablePurge**: bool: A boolean value that indicates if the purge operations are enabled. +* **enableStreamingIngest**: bool: A boolean value that indicates if the streaming ingest is enabled. +* **languageExtensions**: [LanguageExtensionsList](#languageextensionslist) (ReadOnly): The list of language extension objects. +* **optimizedAutoscale**: [OptimizedAutoscale](#optimizedautoscale): A class that contains the optimized auto scale definition. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. +* **state**: 'Creating' | 'Deleted' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | 'Unavailable' | 'Updating' | string (ReadOnly): The state of the resource. +* **stateReason**: string (ReadOnly): The reason for the Kusto Pool's current state. +* **uri**: string (ReadOnly): The Kusto Pool URI. +* **workspaceUID**: string: The workspace unique identifier. +## LanguageExtension +### Properties +* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. -## CmdkeySetupTypeProperties +## LanguageExtensionsList ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. -## SecretBase -* **Discriminator**: type +## LanguageExtensionsList +### Properties +* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +## LibraryInfo +### Properties +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string: The last update time of the library. +## LibraryRequirements +### Properties +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -1008,31 +983,53 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange -## KustoPoolProperties +## MaintenanceWindowTimeRange ### Properties -* **dataIngestionUri**: string (ReadOnly): The Kusto Pool data ingestion URI. -* **enablePurge**: bool: A boolean value that indicates if the purge operations are enabled. -* **enableStreamingIngest**: bool: A boolean value that indicates if the streaming ingest is enabled. -* **languageExtensions**: [LanguageExtensionsList](#languageextensionslist) (ReadOnly): The list of language extension objects. -* **optimizedAutoscale**: [OptimizedAutoscale](#optimizedautoscale): A class that contains the optimized auto scale definition. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **state**: 'Creating' | 'Deleted' | 'Deleting' | 'Running' | 'Starting' | 'Stopped' | 'Stopping' | 'Unavailable' | 'Updating' | string (ReadOnly): The state of the resource. -* **stateReason**: string (ReadOnly): The reason for the Kusto Pool's current state. -* **uri**: string (ReadOnly): The Kusto Pool URI. -* **workspaceUID**: string: The workspace unique identifier. +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. -## LanguageExtensionsList +## ManagedIdentity ### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned': The type of managed identity for the workspace +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. -## LanguageExtension +## ManagedIdentitySqlControlSettingsModelProperties ### Properties -* **languageExtensionName**: 'PYTHON' | 'R' | string: Language extension that can run within KQL query. +* **grantSqlControlToManagedIdentity**: [ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity](#managedidentitysqlcontrolsettingsmodelpropertiesgrantsqlcontroltomanagedidentity): Grant sql control to managed identity + +## ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity +### Properties +* **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state +* **desiredState**: 'Disabled' | 'Enabled' | string: Desired state + +## ManagedIntegrationRuntimeManagedVirtualNetworkReference +### Properties +* **id**: string: The id of the managed virtual network. +* **referenceName**: string: The reference name of the managed virtual network. +* **type**: string: The type of the managed virtual network. + +## ManagedIntegrationRuntimeTypeProperties +### Properties +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. + +## ManagedVirtualNetworkSettings +### Properties +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration + +## MetadataSyncConfigProperties +### Properties +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int (ReadOnly): The Sync Interval in minutes. ## OptimizedAutoscale ### Properties @@ -1041,43 +1038,42 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minimum**: int (Required): Minimum allowed instances count. * **version**: int (Required): The version of the template defined, for instance 1. -## AzureSku +## PrivateEndpoint ### Properties -* **capacity**: int: The number of instances of the cluster. -* **name**: 'Compute optimized' | 'Storage optimized' | string (Required): SKU name. -* **size**: 'Extra small' | 'Large' | 'Medium' | 'Small' | string (Required): SKU size. +* **id**: string (ReadOnly): Resource id of the private endpoint. -## SystemData +## PrivateEndpointConnection ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" -## TrackedResourceTags +## PrivateEndpointConnectionForPrivateLinkHubBasic ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -## AttachedDatabaseConfigurationProperties +## PrivateEndpointConnectionProperties ### Properties -* **attachedDatabaseNames**: string[] (ReadOnly): The list of databases from the clusterResourceId which are currently attached to the kusto pool. -* **clusterResourceId**: string (Required): The resource id of the kusto pool where the databases you would like to attach reside. -* **databaseName**: string (Required): The name of the database which you would like to attach, use * if you want to follow all current and future databases. -* **defaultPrincipalsModificationKind**: 'None' | 'Replace' | 'Union' | string (Required): The default principals modification kind -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableLevelSharingProperties**: [TableLevelSharingProperties](#tablelevelsharingproperties): Tables that will be included and excluded in the follower database +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. -## TableLevelSharingProperties +## PrivateLinkHubProperties ### Properties -* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database -* **externalTablesToInclude**: string[]: List of external tables to include in the follower database -* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database -* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database -* **tablesToExclude**: string[]: List of tables to exclude from the follower database -* **tablesToInclude**: string[]: List of tables to include in the follower database +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PurviewConfiguration +### Properties +* **purviewResourceId**: string: Purview Resource ID ## ReadOnlyFollowingDatabaseProperties ### Properties @@ -1089,10 +1085,6 @@ For more information, see [Auditing to storage using Managed Identity authentica * **softDeletePeriod**: string (ReadOnly): The time the data should be kept before it stops being accessible to queries in TimeSpan. * **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## DatabaseStatistics -### Properties -* **size**: int: The database size - the total size of compressed data and index in bytes. - ## ReadWriteDatabaseProperties ### Properties * **hotCachePeriod**: string: The time the data should be kept in cache for fast queries in TimeSpan. @@ -1101,71 +1093,22 @@ For more information, see [Auditing to storage using Managed Identity authentica * **softDeletePeriod**: string: The time the data should be kept before it stops being accessible to queries in TimeSpan. * **statistics**: [DatabaseStatistics](#databasestatistics) (ReadOnly): A class that contains database statistics information. -## EventGridConnectionProperties -### Properties -* **blobStorageEventType**: 'Microsoft.Storage.BlobCreated' | 'Microsoft.Storage.BlobRenamed' | string: The name of blob storage event type to process. -* **consumerGroup**: string (Required): The event hub consumer group. -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventHubResourceId**: string (Required): The resource ID where the event grid is configured to send events. -* **ignoreFirstRecord**: bool: A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **storageAccountResourceId**: string (Required): The resource ID of the storage account where the data resides. -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. - -## EventHubConnectionProperties -### Properties -* **compression**: 'GZip' | 'None' | string: The compression type -* **consumerGroup**: string (Required): The event hub consumer group. -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventHubResourceId**: string (Required): The resource ID of the event hub to be used to create a data connection. -* **eventSystemProperties**: string[]: System properties of the event hub -* **managedIdentityResourceId**: string: The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. - -## IotHubConnectionProperties -### Properties -* **consumerGroup**: string (Required): The iot hub consumer group. -* **dataFormat**: 'APACHEAVRO' | 'AVRO' | 'CSV' | 'JSON' | 'MULTIJSON' | 'ORC' | 'PARQUET' | 'PSV' | 'RAW' | 'SCSV' | 'SINGLEJSON' | 'SOHSV' | 'TSV' | 'TSVE' | 'TXT' | 'W3CLOGFILE' | string: The data format of the message. Optionally the data format can be added to each message. -* **eventSystemProperties**: string[]: System properties of the iot hub -* **iotHubResourceId**: string (Required): The resource ID of the Iot hub to be used to create a data connection. -* **mappingRuleName**: string: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **sharedAccessPolicyName**: string (Required): The name of the share access policy -* **tableName**: string: The table where the data should be ingested. Optionally the table information can be added to each message. - -## DatabasePrincipalProperties -### Properties -* **principalId**: string (Required): The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'Admin' | 'Ingestor' | 'Monitor' | 'UnrestrictedViewer' | 'User' | 'Viewer' | string (Required): Database principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +## SecretBase +* **Discriminator**: type -## ClusterPrincipalProperties -### Properties -* **principalId**: string (Required): The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. -* **principalName**: string (ReadOnly): The principal name -* **principalType**: 'App' | 'Group' | 'User' | string (Required): Principal type. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | string (ReadOnly): The provisioned state of the resource. -* **role**: 'AllDatabasesAdmin' | 'AllDatabasesViewer' | string (Required): Cluster principal role. -* **tenantId**: string: The tenant id of the principal -* **tenantName**: string (ReadOnly): The tenant name of the principal +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. -## ManagedIdentitySqlControlSettingsModelProperties -### Properties -* **grantSqlControlToManagedIdentity**: [ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity](#managedidentitysqlcontrolsettingsmodelpropertiesgrantsqlcontroltomanagedidentity): Grant sql control to managed identity -## ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity +## SecureString ### Properties -* **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state -* **desiredState**: 'Disabled' | 'Enabled' | string: Desired state +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. -## ServerSecurityAlertPolicyProperties +## SecurityAlertPolicyProperties ### Properties * **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. * **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action @@ -1176,40 +1119,23 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## SqlPoolResourceProperties -### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseDeletionDate**: string: Specifies the time that the sql pool was deleted -* **sourceDatabaseId**: string (WriteOnly): Source database to create from -* **status**: string (ReadOnly): Resource status -* **storageAccountType**: 'GRS' | 'LRS' | string: The storage account type used to store backups for this sql pool. - -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1280,35 +1206,51 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SparkConfigProperties +### Properties +* **configurationType**: 'Artifact' | 'File' | string: The type of the spark config properties file. +* **content**: string: The spark config properties. +* **filename**: string: The filename of the spark config properties file. +* **time**: string (ReadOnly): The last update time of the spark config properties file. + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1379,73 +1321,109 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string (WriteOnly): Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string (ReadOnly): Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseDeletionDate**: string: Specifies the time that the sql pool was deleted +* **sourceDatabaseId**: string (WriteOnly): Source database to create from +* **status**: string (ReadOnly): Resource status +* **storageAccountType**: 'GRS' | 'LRS' | string: The storage account type used to store backups for this sql pool. + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int (ReadOnly): The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## SystemData ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## SecurityAlertPolicyProperties +## TableLevelSharingProperties ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +* **externalTablesToExclude**: string[]: List of external tables exclude from the follower database +* **externalTablesToInclude**: string[]: List of external tables to include in the follower database +* **materializedViewsToExclude**: string[]: List of materialized views exclude from the follower database +* **materializedViewsToInclude**: string[]: List of materialized views to include in the follower database +* **tablesToExclude**: string[]: List of tables to exclude from the follower database +* **tablesToInclude**: string[]: List of tables to include in the follower database + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## UserAssignedManagedIdentities ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) + +## UserAssignedManagedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID. +* **principalId**: string (ReadOnly): The principal ID. + +## VirtualNetworkProfile +### Properties +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1453,13 +1431,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1470,38 +1449,59 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **azureADOnlyAuthentication**: bool: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **cspWorkspaceAdminProperties**: [CspWorkspaceAdminProperties](#cspworkspaceadminproperties): Initial workspace AAD admin properties for a CSP subscription +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **settings**: [WorkspacePropertiesSettings](#workspacepropertiessettings) (ReadOnly): Workspace settings +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **trustedServiceBypassEnabled**: bool: Is trustedServiceBypassEnabled for the workspace +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string -## FollowerDatabaseListResult +## WorkspacePropertiesExtraProperties ### Properties -* **value**: [FollowerDatabaseDefinition](#followerdatabasedefinition)[] (ReadOnly): The list of follower database result. +### Additional Properties +* **Additional Properties Type**: any -## FollowerDatabaseDefinition +## WorkspacePropertiesSettings ### Properties -* **attachedDatabaseConfigurationName**: string (ReadOnly): Resource name of the attached database configuration in the follower cluster. -* **clusterResourceId**: string (ReadOnly): Resource id of the cluster that follows a database owned by this cluster. -* **databaseName**: string (ReadOnly): The database name owned by this cluster that was followed. * in case following all databases. +### Additional Properties +* **Additional Properties Type**: any -## LanguageExtensionsList +## WorkspaceRepositoryConfiguration ### Properties -* **value**: [LanguageExtension](#languageextension)[]: The list of language extensions. +* **accountName**: string: Account name +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/synapse/microsoft.synapse/2021-06-01/types.md b/generated/synapse/microsoft.synapse/2021-06-01/types.md index 92c1d5e14b..c1ecbe97e7 100644 --- a/generated/synapse/microsoft.synapse/2021-06-01/types.md +++ b/generated/synapse/microsoft.synapse/2021-06-01/types.md @@ -317,86 +317,86 @@ * **ApiVersion**: 2021-06-01 * **Output**: [IntegrationRuntimeAuthKeys](#integrationruntimeauthkeys) -## PrivateLinkHubProperties +## AadAdminProperties ### Properties -* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections -* **provisioningState**: string: PrivateLinkHub provisioning state +* **administratorType**: string: Workspace active directory administrator type +* **login**: string: Login of the workspace active directory administrator +* **sid**: string: Object ID of the workspace active directory administrator +* **tenantId**: string: Tenant ID of the workspace active directory administrator -## PrivateEndpointConnectionForPrivateLinkHubBasic +## AutoPauseProperties ### Properties -* **id**: string (ReadOnly): identifier -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. +* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. -## PrivateEndpointConnectionProperties +## AutoScaleProperties ### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint -* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. +* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. +* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. +* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. -## PrivateEndpoint +## AzureADOnlyAuthenticationProperties ### Properties -* **id**: string (ReadOnly): Resource id of the private endpoint. +* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. +* **creationDate**: string (ReadOnly): property configuration date +* **state**: 'Consistent' | 'InConsistent' | 'Updating' | string (ReadOnly): property configuration state -## PrivateLinkServiceConnectionState +## BigDataPoolResourceProperties ### Properties -* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. -* **description**: string: The private link service connection description. -* **status**: string: The private link service connection status. +* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark +* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark +* **cacheSize**: int: The cache size +* **creationDate**: string (ReadOnly): The time when the Big Data pool was created. +* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. +* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. +* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties +* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. +* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. +* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark +* **nodeCount**: int: The number of nodes in the Big Data pool. +* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. +* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. +* **provisioningState**: string: The state of the Big Data pool. +* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. +* **sparkConfigProperties**: [SparkConfigProperties](#sparkconfigproperties): SparkConfig Properties for a Big Data pool powered by Apache Spark +* **sparkEventsFolder**: string: The Spark events folder +* **sparkVersion**: string: The Apache Spark version. -## TrackedResourceTags +## CmdkeySetupTypeProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. +* **targetName**: any (Required): Any object +* **userName**: any (Required): Any object -## ManagedIdentity +## CspWorkspaceAdminProperties ### Properties -* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity -* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned': The type of managed identity for the workspace -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. +* **initialWorkspaceAdminObjectId**: string: AAD object ID of initial workspace admin -## UserAssignedManagedIdentities +## CustomerManagedKeyDetails ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) +* **kekIdentity**: [KekIdentityProperties](#kekidentityproperties): Key encryption key properties +* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace +* **status**: string (ReadOnly): The customer managed key status on the workspace -## UserAssignedManagedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID. -* **principalId**: string (ReadOnly): The principal ID. +## CustomSetupBase +* **Discriminator**: type -## WorkspaceProperties -### Properties -* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. -* **azureADOnlyAuthentication**: bool: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource -* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints -* **cspWorkspaceAdminProperties**: [CspWorkspaceAdminProperties](#cspworkspaceadminproperties): Initial workspace AAD admin properties for a CSP subscription -* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace -* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace -* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags -* **managedResourceGroupName**: 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 '.' -* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. -* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace -* **provisioningState**: string (ReadOnly): Resource provisioning state -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace -* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration -* **settings**: [WorkspacePropertiesSettings](#workspacepropertiessettings) (ReadOnly): Workspace settings -* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator -* **sqlAdministratorLoginPassword**: string: SQL administrator login password -* **trustedServiceBypassEnabled**: bool: Is trustedServiceBypassEnabled for the workspace -* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile -* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings -* **workspaceUID**: string (ReadOnly): The workspace unique identifier +### Base Properties +### CmdkeySetup +#### Properties +* **type**: 'CmdkeySetup' (Required): The type of custom setup. +* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. -## WorkspacePropertiesConnectivityEndpoints -### Properties -### Additional Properties -* **Additional Properties Type**: string +### ComponentSetup +#### Properties +* **type**: 'ComponentSetup' (Required): The type of custom setup. +* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. + +### EnvironmentVariableSetup +#### Properties +* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. +* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. -## CspWorkspaceAdminProperties -### Properties -* **initialWorkspaceAdminObjectId**: string: AAD object ID of initial workspace admin ## DataLakeStorageAccountDetails ### Properties @@ -405,83 +405,62 @@ * **filesystem**: string: Filesystem name * **resourceId**: string: ARM resource Id of this storage account -## EncryptionDetails -### Properties -* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace -* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled - -## CustomerManagedKeyDetails -### Properties -* **kekIdentity**: [KekIdentityProperties](#kekidentityproperties): Key encryption key properties -* **key**: [WorkspaceKeyDetails](#workspacekeydetails): Details of the customer managed key associated with the workspace -* **status**: string (ReadOnly): The customer managed key status on the workspace - -## KekIdentityProperties -### Properties -* **userAssignedIdentity**: string: User assigned identity resource Id -* **useSystemAssignedIdentity**: any: Anything - -## WorkspaceKeyDetails -### Properties -* **keyVaultUrl**: string: Workspace Key sub-resource key vault url -* **name**: string: Workspace Key sub-resource name - -## WorkspacePropertiesExtraProperties -### Properties -### Additional Properties -* **Additional Properties Type**: any - -## ManagedVirtualNetworkSettings +## DataMaskingPolicyProperties ### Properties -* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking -* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource -* **preventDataExfiltration**: bool: Prevent Data Exfiltration +* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. +* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. +* **exemptPrincipals**: 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. +* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. -## PrivateEndpointConnection +## DataMaskingRuleProperties ### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. +* **columnName**: string (Required): The column name on which the data masking rule is applied. +* **id**: string (ReadOnly): The rule Id. +* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. +* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. +* **prefixSize**: 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. +* **replacementString**: 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. +* **ruleState**: 'Disabled' | 'Enabled': 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. +* **schemaName**: string (Required): The schema name on which the data masking rule is applied. +* **suffixSize**: 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. +* **tableName**: string (Required): The table name on which the data masking rule is applied. -## PurviewConfiguration +## DedicatedSQLminimalTlsSettingsProperties ### Properties -* **purviewResourceId**: string: Purview Resource ID +* **minimalTlsVersion**: string: The minimal tls version of the sql server. -## WorkspacePropertiesSettings +## DynamicExecutorAllocation ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. +* **maxExecutors**: int: The maximum number of executors alloted +* **minExecutors**: int: The minimum number of executors alloted -## VirtualNetworkProfile +## EncryptionDetails ### Properties -* **computeSubnetId**: string: Subnet ID used for computes in workspace +* **cmk**: [CustomerManagedKeyDetails](#customermanagedkeydetails): Details of the customer managed key associated with the workspace +* **doubleEncryptionEnabled**: bool (ReadOnly): Double Encryption enabled -## WorkspaceRepositoryConfiguration +## EncryptionProtectorProperties ### Properties -* **accountName**: string: Account name -* **collaborationBranch**: string: Collaboration branch -* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com -* **lastCommitId**: string: The last commit ID -* **projectName**: string: VSTS project name -* **repositoryName**: string: Repository name -* **rootFolder**: string: Root folder to use in the repository -* **tenantId**: string: The VSTS tenant ID -* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration +* **serverKeyName**: string: The name of the server key. +* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. +* **subregion**: string (ReadOnly): Subregion of the encryption protector. +* **thumbprint**: string (ReadOnly): Thumbprint of the server key. +* **uri**: string (ReadOnly): The URI of the server key. -## TrackedResourceTags +## EntityReference ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **referenceName**: string: The name of this referenced entity. +* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. -## AadAdminProperties +## EnvironmentVariableSetupTypeProperties ### Properties -* **administratorType**: string: Workspace active directory administrator type -* **login**: string: Login of the workspace active directory administrator -* **sid**: string: Object ID of the workspace active directory administrator -* **tenantId**: string: Tenant ID of the workspace active directory administrator +* **variableName**: string (Required): The name of the environment variable. +* **variableValue**: string (Required): The value of the environment variable. -## ServerBlobAuditingPolicyProperties +## ExtendedServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -562,6 +541,7 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **predicateExpression**: string: Specifies condition of where clause when creating an audit. * **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. @@ -575,91 +555,7 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## AzureADOnlyAuthenticationProperties -### Properties -* **azureADOnlyAuthentication**: bool (Required): Azure Active Directory only Authentication enabled. -* **creationDate**: string (ReadOnly): property configuration date -* **state**: 'Consistent' | 'InConsistent' | 'Updating' | string (ReadOnly): property configuration state - -## BigDataPoolResourceProperties -### Properties -* **autoPause**: [AutoPauseProperties](#autopauseproperties): Auto-pausing properties of a Big Data pool powered by Apache Spark -* **autoScale**: [AutoScaleProperties](#autoscaleproperties): Auto-scaling properties of a Big Data pool powered by Apache Spark -* **cacheSize**: int: The cache size -* **creationDate**: string (ReadOnly): The time when the Big Data pool was created. -* **customLibraries**: [LibraryInfo](#libraryinfo)[]: List of custom libraries/packages associated with the spark pool. -* **defaultSparkLogFolder**: string: The default folder where Spark logs will be written. -* **dynamicExecutorAllocation**: [DynamicExecutorAllocation](#dynamicexecutorallocation): Dynamic Executor Allocation Properties -* **isComputeIsolationEnabled**: bool: Whether compute isolation is required or not. -* **lastSucceededTimestamp**: string (ReadOnly): The time when the Big Data pool was updated successfully. -* **libraryRequirements**: [LibraryRequirements](#libraryrequirements): Library requirements for a Big Data pool powered by Apache Spark -* **nodeCount**: int: The number of nodes in the Big Data pool. -* **nodeSize**: 'Large' | 'Medium' | 'None' | 'Small' | 'XLarge' | 'XXLarge' | 'XXXLarge' | string: The level of compute power that each node in the Big Data pool has. -* **nodeSizeFamily**: 'HardwareAcceleratedFPGA' | 'HardwareAcceleratedGPU' | 'MemoryOptimized' | 'None' | string: The kind of nodes that the Big Data pool provides. -* **provisioningState**: string: The state of the Big Data pool. -* **sessionLevelPackagesEnabled**: bool: Whether session level packages enabled. -* **sparkConfigProperties**: [SparkConfigProperties](#sparkconfigproperties): SparkConfig Properties for a Big Data pool powered by Apache Spark -* **sparkEventsFolder**: string: The Spark events folder -* **sparkVersion**: string: The Apache Spark version. - -## AutoPauseProperties -### Properties -* **delayInMinutes**: int: Number of minutes of idle time before the Big Data pool is automatically paused. -* **enabled**: bool: Whether auto-pausing is enabled for the Big Data pool. - -## AutoScaleProperties -### Properties -* **enabled**: bool: Whether automatic scaling is enabled for the Big Data pool. -* **maxNodeCount**: int: The maximum number of nodes the Big Data pool can support. -* **minNodeCount**: int: The minimum number of nodes the Big Data pool can support. - -## LibraryInfo -### Properties -* **containerName**: string: Storage blob container name. -* **creatorId**: string (ReadOnly): Creator Id of the library/package. -* **name**: string: Name of the library. -* **path**: string: Storage blob path of library. -* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. -* **type**: string: Type of the library. -* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. - -## DynamicExecutorAllocation -### Properties -* **enabled**: bool: Indicates whether Dynamic Executor Allocation is enabled or not. -* **maxExecutors**: int: The maximum number of executors alloted -* **minExecutors**: int: The minimum number of executors alloted - -## LibraryRequirements -### Properties -* **content**: string: The library requirements. -* **filename**: string: The filename of the library requirements file. -* **time**: string (ReadOnly): The last update time of the library requirements file. - -## SparkConfigProperties -### Properties -* **configurationType**: 'Artifact' | 'File' | string: The type of the spark config properties file. -* **content**: string: The spark config properties. -* **filename**: string: The filename of the spark config properties file. -* **time**: string (ReadOnly): The last update time of the spark config properties file. - -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## DedicatedSQLminimalTlsSettingsProperties -### Properties -* **minimalTlsVersion**: string: The minimal tls version of the sql server. - -## EncryptionProtectorProperties -### Properties -* **serverKeyName**: string: The name of the server key. -* **serverKeyType**: 'AzureKeyVault' | 'ServiceManaged' | string (Required): The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. -* **subregion**: string (ReadOnly): Subregion of the encryption protector. -* **thumbprint**: string (ReadOnly): Thumbprint of the server key. -* **uri**: string (ReadOnly): The URI of the server key. - -## ExtendedServerBlobAuditingPolicyProperties +## ExtendedSqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -727,16 +623,6 @@ Note that for server level audit you should use the 'master' database as {databa 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) -* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. -In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true - -When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. - -Diagnostic Settings URI format: -PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. @@ -754,11 +640,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## IpFirewallRuleProperties +## GeoBackupPolicyProperties ### Properties -* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress -* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state -* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format +* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. +* **storageType**: string (ReadOnly): The storage type of the geo backup policy. ## IntegrationRuntime * **Discriminator**: type @@ -778,17 +663,10 @@ For more information, see [Auditing to storage using Managed Identity authentica * **typeProperties**: [SelfHostedIntegrationRuntimeTypeProperties](#selfhostedintegrationruntimetypeproperties): The self-hosted integration runtime properties. -## ManagedIntegrationRuntimeManagedVirtualNetworkReference -### Properties -* **id**: string: The id of the managed virtual network. -* **referenceName**: string: The reference name of the managed virtual network -* **type**: string: The type of the managed virtual network. - -## ManagedIntegrationRuntimeTypeProperties +## IntegrationRuntimeAuthKeys ### Properties -* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. -* **customerVirtualNetwork**: [IntegrationRuntimeCustomerVirtualNetwork](#integrationruntimecustomervirtualnetwork): The definition and properties of virtual network to which Azure-SSIS integration runtime will join. -* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. +* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. +* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. ## IntegrationRuntimeComputeProperties ### Properties @@ -801,6 +679,15 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any +## IntegrationRuntimeCustomerVirtualNetwork +### Properties +* **subnetId**: string: The ID of subnet to which Azure-SSIS integration runtime will join. + +## IntegrationRuntimeCustomSetupScriptProperties +### Properties +* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. +* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. + ## IntegrationRuntimeDataFlowProperties ### Properties * **computeType**: 'ComputeOptimized' | 'General' | 'MemoryOptimized' | string: Compute type of the cluster which will execute data flow job. @@ -809,18 +696,20 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeVNetProperties +## IntegrationRuntimeDataProxyProperties ### Properties -* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. -* **subnet**: string: The name of the subnet this integration runtime will join. -* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. -* **vNetId**: string: The ID of the VNet that this integration runtime will join. -### Additional Properties -* **Additional Properties Type**: any +* **connectVia**: [EntityReference](#entityreference): The entity reference. +* **path**: string: The path to contain the staged data in the Blob storage. +* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. -## IntegrationRuntimeCustomerVirtualNetwork +## IntegrationRuntimeSsisCatalogInfo ### Properties -* **subnetId**: string: The ID of subnet to which Azure-SSIS integration runtime will join. +* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **catalogAdminUserName**: string: The administrator user name of catalog database. +* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ +* **catalogServerEndpoint**: string: The catalog database server URL. +### Additional Properties +* **Additional Properties Type**: any ## IntegrationRuntimeSsisProperties ### Properties @@ -833,86 +722,52 @@ For more information, see [Auditing to storage using Managed Identity authentica ### Additional Properties * **Additional Properties Type**: any -## IntegrationRuntimeSsisCatalogInfo +## IntegrationRuntimeVNetProperties ### Properties -* **catalogAdminPassword**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. -* **catalogAdminUserName**: string: The administrator user name of catalog database. -* **catalogPricingTier**: 'Basic' | 'Premium' | 'PremiumRS' | 'Standard' | 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/ -* **catalogServerEndpoint**: string: The catalog database server URL. +* **publicIPs**: string[]: Resource IDs of the public IP addresses that this integration runtime will use. +* **subnet**: string: The name of the subnet this integration runtime will join. +* **subnetId**: string: The ID of subnet, to which this Azure-SSIS integration runtime will be joined. +* **vNetId**: string: The ID of the VNet that this integration runtime will join. ### Additional Properties * **Additional Properties Type**: any -## SecureString +## IpFirewallRuleProperties ### Properties -* **type**: string (Required): Type of the secret. -* **value**: string (Required): Value of secure string. +* **endIpAddress**: string: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress +* **provisioningState**: 'DeleteError' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Resource provisioning state +* **startIpAddress**: string: The start IP address of the firewall rule. Must be IPv4 format -## IntegrationRuntimeCustomSetupScriptProperties +## KekIdentityProperties ### Properties -* **blobContainerUri**: string: The URI of the Azure blob container that contains the custom setup script. -* **sasToken**: [SecureString](#securestring): Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. +* **userAssignedIdentity**: string: User assigned identity resource Id +* **useSystemAssignedIdentity**: any: Anything -## IntegrationRuntimeDataProxyProperties +## KeyProperties ### Properties -* **connectVia**: [EntityReference](#entityreference): The entity reference. -* **path**: string: The path to contain the staged data in the Blob storage. -* **stagingLinkedService**: [EntityReference](#entityreference): The entity reference. +* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. +* **keyVaultUrl**: string: The Key Vault Url of the workspace key. -## EntityReference +## LibraryInfo ### Properties -* **referenceName**: string: The name of this referenced entity. -* **type**: 'IntegrationRuntimeReference' | 'LinkedServiceReference' | string: The type of this referenced entity. - -## CustomSetupBase -* **Discriminator**: type - -### Base Properties -### CmdkeySetup -#### Properties -* **type**: 'CmdkeySetup' (Required): The type of custom setup. -* **typeProperties**: [CmdkeySetupTypeProperties](#cmdkeysetuptypeproperties) (Required): Cmdkey command custom setup type properties. - -### ComponentSetup -#### Properties -* **type**: 'ComponentSetup' (Required): The type of custom setup. -* **typeProperties**: [LicensedComponentSetupTypeProperties](#licensedcomponentsetuptypeproperties) (Required): Installation of licensed component setup type properties. - -### EnvironmentVariableSetup -#### Properties -* **type**: 'EnvironmentVariableSetup' (Required): The type of custom setup. -* **typeProperties**: [EnvironmentVariableSetupTypeProperties](#environmentvariablesetuptypeproperties) (Required): Environment variable custom setup type properties. - +* **containerName**: string: Storage blob container name. +* **creatorId**: string (ReadOnly): Creator Id of the library/package. +* **name**: string: Name of the library. +* **path**: string: Storage blob path of library. +* **provisioningStatus**: string (ReadOnly): Provisioning status of the library/package. +* **type**: string: Type of the library. +* **uploadedTimestamp**: string (ReadOnly): The last update time of the library. -## CmdkeySetupTypeProperties +## LibraryRequirements ### Properties -* **password**: [SecretBase](#secretbase) (Required): The base definition of a secret type. -* **targetName**: any (Required): Any object -* **userName**: any (Required): Any object - -## SecretBase -* **Discriminator**: type - -### Base Properties -### SecureString -#### Properties -* **type**: 'SecureString' (Required): Type of the secret. -* **value**: string (Required): Value of secure string. - +* **content**: string: The library requirements. +* **filename**: string: The filename of the library requirements file. +* **time**: string (ReadOnly): The last update time of the library requirements file. ## LicensedComponentSetupTypeProperties ### Properties * **componentName**: string (Required): The name of the 3rd party component. * **licenseKey**: [SecretBase](#secretbase): The base definition of a secret type. -## EnvironmentVariableSetupTypeProperties -### Properties -* **variableName**: string (Required): The name of the environment variable. -* **variableValue**: string (Required): The value of the environment variable. - -## SelfHostedIntegrationRuntimeTypeProperties -### Properties -* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. - ## LinkedIntegrationRuntimeType * **Discriminator**: authorizationType @@ -928,10 +783,22 @@ For more information, see [Auditing to storage using Managed Identity authentica * **resourceId**: string (Required): The resource identifier of the integration runtime to be shared. -## KeyProperties +## MaintenanceWindowsProperties ### Properties -* **isActiveCMK**: bool: Used to activate the workspace after a customer managed key is provided. -* **keyVaultUrl**: string: The Key Vault Url of the workspace key. +* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange + +## MaintenanceWindowTimeRange +### Properties +* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. +* **duration**: string: Duration of maintenance window in minutes. +* **startTime**: string: Start time minutes offset from 12am. + +## ManagedIdentity +### Properties +* **principalId**: string (ReadOnly): The principal ID of the workspace managed identity +* **tenantId**: string (ReadOnly): The tenant ID of the workspace managed identity +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned': The type of managed identity for the workspace +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. ## ManagedIdentitySqlControlSettingsModelProperties ### Properties @@ -942,7 +809,82 @@ For more information, see [Auditing to storage using Managed Identity authentica * **actualState**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | 'Unknown' | string (ReadOnly): Actual state * **desiredState**: 'Disabled' | 'Enabled' | string: Desired state -## ServerSecurityAlertPolicyProperties +## ManagedIntegrationRuntimeManagedVirtualNetworkReference +### Properties +* **id**: string: The id of the managed virtual network. +* **referenceName**: string: The reference name of the managed virtual network +* **type**: string: The type of the managed virtual network. + +## ManagedIntegrationRuntimeTypeProperties +### Properties +* **computeProperties**: [IntegrationRuntimeComputeProperties](#integrationruntimecomputeproperties): The compute resource properties for managed integration runtime. +* **customerVirtualNetwork**: [IntegrationRuntimeCustomerVirtualNetwork](#integrationruntimecustomervirtualnetwork): The definition and properties of virtual network to which Azure-SSIS integration runtime will join. +* **ssisProperties**: [IntegrationRuntimeSsisProperties](#integrationruntimessisproperties): SSIS properties for managed integration runtime. + +## ManagedVirtualNetworkSettings +### Properties +* **allowedAadTenantIdsForLinking**: string[]: Allowed Aad Tenant Ids For Linking +* **linkedAccessCheckOnTargetResource**: bool: Linked Access Check On Target Resource +* **preventDataExfiltration**: bool: Prevent Data Exfiltration + +## MetadataSyncConfigProperties +### Properties +* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled +* **syncIntervalInMinutes**: int: The Sync Interval in minutes. + +## PrivateEndpoint +### Properties +* **id**: string (ReadOnly): Resource id of the private endpoint. + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionForPrivateLinkHubBasic +### Properties +* **id**: string (ReadOnly): identifier +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of a private endpoint connection. + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): Private endpoint details +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state details of the private endpoint +* **provisioningState**: string (ReadOnly): Provisioning state of the private endpoint connection. + +## PrivateLinkHubProperties +### Properties +* **privateEndpointConnections**: [PrivateEndpointConnectionForPrivateLinkHubBasic](#privateendpointconnectionforprivatelinkhubbasic)[] (ReadOnly): List of private endpoint connections +* **provisioningState**: string: PrivateLinkHub provisioning state + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string (ReadOnly): The actions required for private link service connection. +* **description**: string: The private link service connection description. +* **status**: string: The private link service connection status. + +## PurviewConfiguration +### Properties +* **purviewResourceId**: string: Purview Resource ID + +## SecretBase +* **Discriminator**: type + +### Base Properties +### SecureString +#### Properties +* **type**: 'SecureString' (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + + +## SecureString +### Properties +* **type**: string (Required): Type of the secret. +* **value**: string (Required): Value of secure string. + +## SecurityAlertPolicyProperties ### Properties * **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. * **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action @@ -953,40 +895,23 @@ For more information, see [Auditing to storage using Managed Identity authentica * **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. * **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## SqlPoolResourceProperties -### Properties -* **collation**: string: Collation mode -* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string (WriteOnly): 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. -* **creationDate**: string (ReadOnly): Date the SQL pool was created -* **maxSizeBytes**: int: Maximum size in bytes -* **provisioningState**: string: Resource state -* **recoverableDatabaseId**: string: Backup database to restore from -* **restorePointInTime**: string: Snapshot time to restore -* **sourceDatabaseDeletionDate**: string: Specifies the time that the sql pool was deleted -* **sourceDatabaseId**: string (WriteOnly): Source database to create from -* **status**: string (ReadOnly): Resource status -* **storageAccountType**: 'GRS' | 'LRS' | string: The storage account type used to store backups for this sql pool. - -## Sku +## SelfHostedIntegrationRuntimeTypeProperties ### Properties -* **capacity**: int: 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. -* **name**: string: The SKU name -* **tier**: string: The service tier +* **linkedInfo**: [LinkedIntegrationRuntimeType](#linkedintegrationruntimetype): The base definition of a linked integration runtime. -## TrackedResourceTags +## SensitivityLabelProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **columnName**: string (ReadOnly): The column name. +* **informationType**: string: The information type. +* **informationTypeId**: string: The information type ID. +* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. +* **labelId**: string: The label ID. +* **labelName**: string: The label name. +* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' +* **schemaName**: string (ReadOnly): The schema name. +* **tableName**: string (ReadOnly): The table name. -## SqlPoolBlobAuditingPolicyProperties +## ServerBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1054,38 +979,64 @@ Note that for server level audit you should use the 'master' database as {databa 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) +* **isDevopsAuditEnabled**: bool: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. +In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true + +When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. + +Diagnostic Settings URI format: +PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. +* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. +* **storageAccountAccessKey**: string (WriteOnly): 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) * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. -## DataMaskingPolicyProperties +## ServerSecurityAlertPolicyProperties ### Properties -* **applicationPrincipals**: string (ReadOnly): The list of the application principals. This is a legacy parameter and is no longer used. -* **dataMaskingState**: 'Disabled' | 'Enabled' (Required): The state of the data masking policy. -* **exemptPrincipals**: 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. -* **maskingLevel**: string (ReadOnly): The masking level. This is a legacy parameter and is no longer used. +* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. +* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action +* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. +* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. +* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. +* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. +* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. +* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. -## DataMaskingRuleProperties +## ServerVulnerabilityAssessmentProperties ### Properties -* **aliasName**: string: The alias name. This is a legacy parameter and is no longer used. -* **columnName**: string (Required): The column name on which the data masking rule is applied. -* **id**: string (ReadOnly): The rule Id. -* **maskingFunction**: 'CCN' | 'Default' | 'Email' | 'Number' | 'SSN' | 'Text' (Required): The masking function that is used for the data masking rule. -* **numberFrom**: string: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **numberTo**: string: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. -* **prefixSize**: 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. -* **replacementString**: 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. -* **ruleState**: 'Disabled' | 'Enabled': 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. -* **schemaName**: string (Required): The schema name on which the data masking rule is applied. -* **suffixSize**: 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. -* **tableName**: string (Required): The table name on which the data masking rule is applied. +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). +* **storageContainerSasKey**: string (WriteOnly): 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. -## ExtendedSqlPoolBlobAuditingPolicyProperties +## Sku +### Properties +* **capacity**: int: 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. +* **name**: string: The SKU name +* **tier**: string: The service tier + +## SparkConfigProperties +### Properties +* **configurationType**: 'Artifact' | 'File' | string: The type of the spark config properties file. +* **content**: string: The spark config properties. +* **filename**: string: The filename of the spark config properties file. +* **time**: string (ReadOnly): The last update time of the spark config properties file. + +## SqlPoolBlobAuditingPolicyProperties ### Properties * **auditActionsAndGroups**: string[]: Specifies the Actions-Groups and Actions to audit. @@ -1156,73 +1107,86 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ 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) * **isStorageSecondaryKeyInUse**: bool: Specifies whether storageAccountAccessKey value is the storage's secondary key. -* **predicateExpression**: string: Specifies condition of where clause when creating an audit. -* **queueDelayMs**: int: 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. * **retentionDays**: int: Specifies the number of days to keep in the audit logs in the storage account. * **state**: 'Disabled' | 'Enabled' (Required): Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. -* **storageAccountAccessKey**: string (WriteOnly): 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 (WriteOnly): Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required. * **storageAccountSubscriptionId**: string: Specifies the blob storage subscription Id. -* **storageEndpoint**: 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: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required. -## GeoBackupPolicyProperties +## SqlPoolResourceProperties ### Properties -* **state**: 'Disabled' | 'Enabled' (Required): The state of the geo backup policy. -* **storageType**: string (ReadOnly): The storage type of the geo backup policy. +* **collation**: string: Collation mode +* **createMode**: 'Default' | 'PointInTimeRestore' | 'Recovery' | 'Restore' | string (WriteOnly): Specifies the mode of sql pool creation. -## MaintenanceWindowsProperties +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. +* **creationDate**: string (ReadOnly): Date the SQL pool was created +* **maxSizeBytes**: int: Maximum size in bytes +* **provisioningState**: string: Resource state +* **recoverableDatabaseId**: string: Backup database to restore from +* **restorePointInTime**: string: Snapshot time to restore +* **sourceDatabaseDeletionDate**: string: Specifies the time that the sql pool was deleted +* **sourceDatabaseId**: string (WriteOnly): Source database to create from +* **status**: string (ReadOnly): Resource status +* **storageAccountType**: 'GRS' | 'LRS' | string: The storage account type used to store backups for this sql pool. + +## SqlPoolVulnerabilityAssessmentProperties ### Properties -* **timeRanges**: [MaintenanceWindowTimeRange](#maintenancewindowtimerange)[]: Array of MaintenanceWindowTimeRange +* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. +* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. +* **storageContainerPath**: string (WriteOnly): 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 +* **storageContainerSasKey**: string (WriteOnly): 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. -## MaintenanceWindowTimeRange +## SqlPoolVulnerabilityAssessmentRuleBaselineItem ### Properties -* **dayOfWeek**: 'Friday' | 'Monday' | 'Saturday' | 'Sunday' | 'Thursday' | 'Tuesday' | 'Wednesday' | string: Day of maintenance window. -* **duration**: string: Duration of maintenance window in minutes. -* **startTime**: string: Start time minutes offset from 12am. +* **result**: string[] (Required): The rule baseline result -## MetadataSyncConfigProperties +## SqlPoolVulnerabilityAssessmentRuleBaselineProperties ### Properties -* **enabled**: bool: Indicates whether the metadata sync is enabled or disabled -* **syncIntervalInMinutes**: int: The Sync Interval in minutes. +* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result -## SensitivityLabelProperties +## TrackedResourceTags ### Properties -* **columnName**: string (ReadOnly): The column name. -* **informationType**: string: The information type. -* **informationTypeId**: string: The information type ID. -* **isDisabled**: bool (ReadOnly): Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. -* **labelId**: string: The label ID. -* **labelName**: string: The label name. -* **rank**: 'Critical' | 'High' | 'Low' | 'Medium' | 'None' -* **schemaName**: string (ReadOnly): The schema name. -* **tableName**: string (ReadOnly): The table name. +### Additional Properties +* **Additional Properties Type**: string -## SecurityAlertPolicyProperties +## TrackedResourceTags ### Properties -* **creationTime**: string (ReadOnly): Specifies the UTC creation time of the policy. -* **disabledAlerts**: string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action -* **emailAccountAdmins**: bool: Specifies that the alert is sent to the account administrators. -* **emailAddresses**: string[]: Specifies an array of e-mail addresses to which the alert is sent. -* **retentionDays**: int: Specifies the number of days to keep in the Threat Detection audit logs. -* **state**: 'Disabled' | 'Enabled' | 'New' (Required): 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. -* **storageAccountAccessKey**: string: Specifies the identifier key of the Threat Detection audit storage account. -* **storageEndpoint**: string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TransparentDataEncryptionProperties ### Properties * **status**: 'Disabled' | 'Enabled': The status of the database transparent data encryption. -## SqlPoolVulnerabilityAssessmentProperties +## UserAssignedManagedIdentities ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (WriteOnly): 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 -* **storageContainerSasKey**: string (WriteOnly): 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. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) + +## UserAssignedManagedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID. +* **principalId**: string (ReadOnly): The principal ID. + +## VirtualNetworkProfile +### Properties +* **computeSubnetId**: string: Subnet ID used for computes in workspace ## VulnerabilityAssessmentRecurringScansProperties ### Properties @@ -1230,13 +1194,14 @@ For more information, see [Auditing to storage using Managed Identity authentica * **emailSubscriptionAdmins**: bool: Specifies that the schedule scan notification will be is sent to the subscription administrators. * **isEnabled**: bool: Recurring scans state. -## SqlPoolVulnerabilityAssessmentRuleBaselineProperties -### Properties -* **baselineResults**: [SqlPoolVulnerabilityAssessmentRuleBaselineItem](#sqlpoolvulnerabilityassessmentrulebaselineitem)[] (Required): The rule baseline result - -## SqlPoolVulnerabilityAssessmentRuleBaselineItem +## WorkloadClassifierProperties ### Properties -* **result**: string[] (Required): The rule baseline result +* **context**: string: The workload classifier context. +* **endTime**: string: The workload classifier end time for classification. +* **importance**: string: The workload classifier importance. +* **label**: string: The workload classifier label. +* **memberName**: string (Required): The workload classifier member name. +* **startTime**: string: The workload classifier start time for classification. ## WorkloadGroupProperties ### Properties @@ -1247,24 +1212,59 @@ For more information, see [Auditing to storage using Managed Identity authentica * **minResourcePercentPerRequest**: int (Required): The workload group request minimum grant percentage. * **queryExecutionTimeout**: int: The workload group query execution timeout. -## WorkloadClassifierProperties +## WorkspaceKeyDetails ### Properties -* **context**: string: The workload classifier context. -* **endTime**: string: The workload classifier end time for classification. -* **importance**: string: The workload classifier importance. -* **label**: string: The workload classifier label. -* **memberName**: string (Required): The workload classifier member name. -* **startTime**: string: The workload classifier start time for classification. +* **keyVaultUrl**: string: Workspace Key sub-resource key vault url +* **name**: string: Workspace Key sub-resource name -## ServerVulnerabilityAssessmentProperties +## WorkspaceProperties ### Properties -* **recurringScans**: [VulnerabilityAssessmentRecurringScansProperties](#vulnerabilityassessmentrecurringscansproperties): Properties of a Vulnerability Assessment recurring scans. -* **storageAccountAccessKey**: string (WriteOnly): Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. -* **storageContainerPath**: string (Required): A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). -* **storageContainerSasKey**: string (WriteOnly): 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. +* **adlaResourceId**: string (ReadOnly): The ADLA resource ID. +* **azureADOnlyAuthentication**: bool: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource +* **connectivityEndpoints**: [WorkspacePropertiesConnectivityEndpoints](#workspacepropertiesconnectivityendpoints): Connectivity endpoints +* **cspWorkspaceAdminProperties**: [CspWorkspaceAdminProperties](#cspworkspaceadminproperties): Initial workspace AAD admin properties for a CSP subscription +* **defaultDataLakeStorage**: [DataLakeStorageAccountDetails](#datalakestorageaccountdetails): Details of the data lake storage account associated with the workspace +* **encryption**: [EncryptionDetails](#encryptiondetails): Details of the encryption associated with the workspace +* **extraProperties**: [WorkspacePropertiesExtraProperties](#workspacepropertiesextraproperties) (ReadOnly): Workspace level configs and feature flags +* **managedResourceGroupName**: 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 '.' +* **managedVirtualNetwork**: string: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. +* **managedVirtualNetworkSettings**: [ManagedVirtualNetworkSettings](#managedvirtualnetworksettings): Managed Virtual Network Settings +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[]: Private endpoint connections to the workspace +* **provisioningState**: string (ReadOnly): Resource provisioning state +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Enable or Disable public network access to workspace +* **purviewConfiguration**: [PurviewConfiguration](#purviewconfiguration): Purview Configuration +* **settings**: [WorkspacePropertiesSettings](#workspacepropertiessettings) (ReadOnly): Workspace settings +* **sqlAdministratorLogin**: string: Login for workspace SQL active directory administrator +* **sqlAdministratorLoginPassword**: string: SQL administrator login password +* **trustedServiceBypassEnabled**: bool: Is trustedServiceBypassEnabled for the workspace +* **virtualNetworkProfile**: [VirtualNetworkProfile](#virtualnetworkprofile): Virtual Network Profile +* **workspaceRepositoryConfiguration**: [WorkspaceRepositoryConfiguration](#workspacerepositoryconfiguration): Git integration settings +* **workspaceUID**: string (ReadOnly): The workspace unique identifier -## IntegrationRuntimeAuthKeys +## WorkspacePropertiesConnectivityEndpoints ### Properties -* **authKey1**: string (ReadOnly): The primary integration runtime authentication key. -* **authKey2**: string (ReadOnly): The secondary integration runtime authentication key. +### Additional Properties +* **Additional Properties Type**: string + +## WorkspacePropertiesExtraProperties +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspacePropertiesSettings +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## WorkspaceRepositoryConfiguration +### Properties +* **accountName**: string: Account name +* **collaborationBranch**: string: Collaboration branch +* **hostName**: string: GitHub Enterprise host name. For example: https://github.mydomain.com +* **lastCommitId**: string: The last commit ID +* **projectName**: string: VSTS project name +* **repositoryName**: string: Repository name +* **rootFolder**: string: Root folder to use in the repository +* **tenantId**: string: The VSTS tenant ID +* **type**: string: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration diff --git a/generated/testbase/log.out b/generated/testbase/log.out index 7568a8c868..47215fe75e 100644 --- a/generated/testbase/log.out +++ b/generated/testbase/log.out @@ -4,11 +4,11 @@ https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.testbase-2020-12-16-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/testbase.json:2380:5 @@ -182,4 +182,4 @@ warning | PreCheck/SchemaMissingType | The schema 'DistributionGroupListReceiver - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/testbase.json:4507:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 13ms -info | Autorest completed in 7.2s. 2 files generated. +info | Autorest completed in 6.83s. 2 files generated. diff --git a/generated/testbase/microsoft.testbase/2020-12-16-preview/types.md b/generated/testbase/microsoft.testbase/2020-12-16-preview/types.md index 0af0d228f1..2f998456ea 100644 --- a/generated/testbase/microsoft.testbase/2020-12-16-preview/types.md +++ b/generated/testbase/microsoft.testbase/2020-12-16-preview/types.md @@ -46,43 +46,31 @@ * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: 'Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses' (ReadOnly, DeployTimeConstant): The resource type -## TestBaseAccountResourceProperties -### Properties -* **accessLevel**: string (ReadOnly): The access level of the Test Base Account. -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property -* **sku**: [TestBaseAccountSKU](#testbaseaccountsku) (Required): Describes a Test Base Account SKU. - -## TestBaseAccountSKU -### Properties -* **capabilities**: [TestBaseAccountSKUCapability](#testbaseaccountskucapability)[] (ReadOnly): The capabilities of a SKU. -* **locations**: string[]: The locations that the SKU is available. -* **name**: string (Required): The name of the SKU. This is typically a letter + number code, such as B0 or S0. -* **resourceType**: string: The type of resource the SKU applies to. -* **tier**: 'Standard' | string (Required): The tier of this particular SKU. - -## TestBaseAccountSKUCapability +## Command ### Properties -* **name**: string (Required): An invariant to describe the feature, such as 'SLA'. -* **value**: string (Required): An invariant if the feature is measured by quantity, such as 99.9%. +* **action**: 'Close' | 'Custom' | 'Install' | 'Launch' | 'Uninstall' | string (Required): The action of the command. +* **alwaysRun**: bool: Specifies whether to run the command even if a previous command is failed. +* **applyUpdateBefore**: bool: Specifies whether to apply update before the command. +* **content**: string (Required): The content of the command. The content depends on source type. +* **contentType**: 'File' | 'Inline' | 'Path' | string (Required): The type of command content. +* **maxRunTime**: int: Specifies the max run time of the command. +* **name**: string (Required): The name of the command. +* **restartAfter**: bool: Specifies whether to restart the VM after the command executed. +* **runAsInteractive**: bool: Specifies whether to run the command in interactive mode. +* **runElevated**: bool: Specifies whether to run the command as administrator. -## SystemData +## CustomerEventProperties ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The type of identity that last modified the resource. -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **eventName**: string (Required): The name of the event subscribed to. +* **receivers**: [NotificationEventReceiver](#notificationeventreceiver)[] (Required): The notification event receivers. -## Tags +## DistributionGroupListReceiverValue ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **distributionGroups**: string[]: The list of distribution groups. -## CustomerEventProperties +## FavoriteProcessProperties ### Properties -* **eventName**: string (Required): The name of the event subscribed to. -* **receivers**: [NotificationEventReceiver](#notificationeventreceiver)[] (Required): The notification event receivers. +* **actualProcessName**: string (Required): The actual name of the favorite process. It will be equal to resource name except for the scenario that the process name contains characters that are not allowed in the resource name. ## NotificationEventReceiver ### Properties @@ -95,20 +83,6 @@ * **subscriptionReceiverValue**: [SubscriptionReceiverValue](#subscriptionreceivervalue): The subscription role receiver value. * **userObjectReceiverValue**: [UserObjectReceiverValue](#userobjectreceivervalue): The user object receiver value. -## DistributionGroupListReceiverValue -### Properties -* **distributionGroups**: string[]: The list of distribution groups. - -## SubscriptionReceiverValue -### Properties -* **role**: string: The role of the notification receiver. -* **subscriptionId**: string: The subscription id of the notification receiver. -* **subscriptionName**: string: The subscription name of the notification receiver. - -## UserObjectReceiverValue -### Properties -* **userObjectIds**: string[]: user object ids. - ## PackageProperties ### Properties * **applicationName**: string (Required): Application name @@ -124,6 +98,37 @@ * **validationResults**: [PackageValidationResult](#packagevalidationresult)[] (ReadOnly): The validation results. There's validation on package when it's created or updated. * **version**: string (Required): Application version +## PackageValidationResult +### Properties +* **errors**: string[] (ReadOnly): Error information. +* **isValid**: bool (ReadOnly): Indicates whether the package passed the validation. +* **validationName**: string (ReadOnly): Validation name. + +## SubscriptionReceiverValue +### Properties +* **role**: string: The role of the notification receiver. +* **subscriptionId**: string: The subscription id of the notification receiver. +* **subscriptionName**: string: The subscription name of the notification receiver. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The type of identity that last modified the resource. +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Tags +### Properties +### Additional Properties +* **Additional Properties Type**: string + ## TargetOSInfo ### Properties * **osUpdateType**: string (Required): Specifies the OS update type to test against, e.g., 'Security updates' or 'Feature updates'. @@ -136,31 +141,26 @@ * **testType**: 'FunctionalTest' | 'OutOfBoxTest' | string (Required): The test type. * **validationRunStatus**: 'Failed' | 'Passed' | 'Pending' | 'Unknown' | string (ReadOnly): The status of the validation run of the package. -## Command +## TestBaseAccountResourceProperties ### Properties -* **action**: 'Close' | 'Custom' | 'Install' | 'Launch' | 'Uninstall' | string (Required): The action of the command. -* **alwaysRun**: bool: Specifies whether to run the command even if a previous command is failed. -* **applyUpdateBefore**: bool: Specifies whether to apply update before the command. -* **content**: string (Required): The content of the command. The content depends on source type. -* **contentType**: 'File' | 'Inline' | 'Path' | string (Required): The type of command content. -* **maxRunTime**: int: Specifies the max run time of the command. -* **name**: string (Required): The name of the command. -* **restartAfter**: bool: Specifies whether to restart the VM after the command executed. -* **runAsInteractive**: bool: Specifies whether to run the command in interactive mode. -* **runElevated**: bool: Specifies whether to run the command as administrator. +* **accessLevel**: string (ReadOnly): The access level of the Test Base Account. +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property +* **sku**: [TestBaseAccountSKU](#testbaseaccountsku) (Required): Describes a Test Base Account SKU. -## PackageValidationResult +## TestBaseAccountSKU ### Properties -* **errors**: string[] (ReadOnly): Error information. -* **isValid**: bool (ReadOnly): Indicates whether the package passed the validation. -* **validationName**: string (ReadOnly): Validation name. +* **capabilities**: [TestBaseAccountSKUCapability](#testbaseaccountskucapability)[] (ReadOnly): The capabilities of a SKU. +* **locations**: string[]: The locations that the SKU is available. +* **name**: string (Required): The name of the SKU. This is typically a letter + number code, such as B0 or S0. +* **resourceType**: string: The type of resource the SKU applies to. +* **tier**: 'Standard' | string (Required): The tier of this particular SKU. -## Tags +## TestBaseAccountSKUCapability ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string (Required): An invariant to describe the feature, such as 'SLA'. +* **value**: string (Required): An invariant if the feature is measured by quantity, such as 99.9%. -## FavoriteProcessProperties +## UserObjectReceiverValue ### Properties -* **actualProcessName**: string (Required): The actual name of the favorite process. It will be equal to resource name except for the scenario that the process name contains characters that are not allowed in the resource name. +* **userObjectIds**: string[]: user object ids. diff --git a/generated/trafficmanager/log.out b/generated/trafficmanager/log.out index 470e1d6ce5..d0dbbebcd9 100644 --- a/generated/trafficmanager/log.out +++ b/generated/trafficmanager/log.out @@ -13,7 +13,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.network-2018-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -26,7 +26,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-08-01/trafficmanager.json:957:5 @@ -76,7 +76,7 @@ warning | PreCheck/SchemaMissingType | The schema 'ProxyResource' with an undefi - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-08-01/trafficmanager.json:1584:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | Resource type microsoft.network/trafficmanagerusermetricskeys under path '/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default' has no body defined. -info | autorest.bicep took 21ms +info | autorest.bicep took 17ms info | Processing batch task - {"tag":"microsoft.network-2018-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -89,7 +89,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json:902:5 @@ -153,7 +153,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json:792:5 @@ -212,7 +212,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json:690:5 @@ -261,7 +261,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json:220:5 @@ -288,7 +288,7 @@ warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrafficManagerUserMetr warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrafficManagerUserMetricsKeyModel' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from TrafficManagerUserMetricsKeyModel warning | PreCheck/PropertyRedeclarationWarning | Schema 'TrafficManagerUserMetricsKeyModel' has a property 'type' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from TrafficManagerUserMetricsKeyModel warning | Skipping path '/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys': Found mismatch between type segments (1) and name segments (0) -info | autorest.bicep took 1ms +info | autorest.bicep took 0ms info | Processing batch task - {"tag":"microsoft.network-2017-05-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -301,7 +301,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-05-01/trafficmanager.json:690:5 @@ -350,7 +350,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'DeleteOperationResult' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-03-01/trafficmanager.json:624:5 @@ -397,7 +397,7 @@ warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'EndpointProperties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2015-11-01/trafficmanager.json:520:5 @@ -423,5 +423,5 @@ warning | PreCheck/SchemaMissingType | The schema 'SubResource' with an undefine - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2015-11-01/trafficmanager.json:744:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}': Parameter reference {endpointType} is not defined as an enum -info | autorest.bicep took 1ms -info | Autorest completed in 17.86s. 14 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 17.34s. 14 files generated. diff --git a/generated/trafficmanager/microsoft.network/2015-11-01/types.md b/generated/trafficmanager/microsoft.network/2015-11-01/types.md index 41cd82d3fc..ced21a2937 100644 --- a/generated/trafficmanager/microsoft.network/2015-11-01/types.md +++ b/generated/trafficmanager/microsoft.network/2015-11-01/types.md @@ -11,14 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Network/trafficmanagerprofiles' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: Gets or sets the list of endpoints in the Traffic Manager profile. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: string: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. -* **trafficRoutingMethod**: string: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. - ## DnsConfig ### Properties * **fqdn**: string: Gets or sets the fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -50,6 +42,14 @@ * **profileMonitorStatus**: string: Gets or sets the profile-level monitoring status of the Traffic Manager profile. * **protocol**: string: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. +## ProfileProperties +### Properties +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: Gets or sets the list of endpoints in the Traffic Manager profile. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: string: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. +* **trafficRoutingMethod**: string: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/trafficmanager/microsoft.network/2017-03-01/types.md b/generated/trafficmanager/microsoft.network/2017-03-01/types.md index 53979c54bd..e00da149ed 100644 --- a/generated/trafficmanager/microsoft.network/2017-03-01/types.md +++ b/generated/trafficmanager/microsoft.network/2017-03-01/types.md @@ -11,14 +11,6 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.Network/trafficmanagerprofiles' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: Gets or sets the list of endpoints in the Traffic Manager profile. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: string: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. -* **trafficRoutingMethod**: string: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', 'Priority' or 'Geographic'. - ## DnsConfig ### Properties * **fqdn**: string: Gets or sets the fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -51,6 +43,14 @@ * **profileMonitorStatus**: string: Gets or sets the profile-level monitoring status of the Traffic Manager profile. * **protocol**: string: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. +## ProfileProperties +### Properties +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: Gets or sets the list of endpoints in the Traffic Manager profile. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: string: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. +* **trafficRoutingMethod**: string: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', 'Priority' or 'Geographic'. + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/trafficmanager/microsoft.network/2017-05-01/types.md b/generated/trafficmanager/microsoft.network/2017-05-01/types.md index a2d456fc35..69d14ef4aa 100644 --- a/generated/trafficmanager/microsoft.network/2017-05-01/types.md +++ b/generated/trafficmanager/microsoft.network/2017-05-01/types.md @@ -11,14 +11,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Network/trafficmanagerprofiles' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. -* **trafficRoutingMethod**: 'Geographic' | 'Performance' | 'Priority' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. - ## DnsConfig ### Properties * **fqdn**: string (ReadOnly): The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -54,6 +46,14 @@ * **timeoutInSeconds**: int: 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. * **toleratedNumberOfFailures**: int: 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. +## ProfileProperties +### Properties +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. +* **trafficRoutingMethod**: 'Geographic' | 'Performance' | 'Priority' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/trafficmanager/microsoft.network/2018-02-01/types.md b/generated/trafficmanager/microsoft.network/2018-02-01/types.md index 7d365b9ac6..eb7f018fca 100644 --- a/generated/trafficmanager/microsoft.network/2018-02-01/types.md +++ b/generated/trafficmanager/microsoft.network/2018-02-01/types.md @@ -11,15 +11,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Network/trafficmanagerprofiles' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. -* **trafficRoutingMethod**: 'Geographic' | 'Performance' | 'Priority' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. -* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. - ## DnsConfig ### Properties * **fqdn**: string (ReadOnly): The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -55,6 +46,15 @@ * **timeoutInSeconds**: int: 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. * **toleratedNumberOfFailures**: int: 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. +## ProfileProperties +### Properties +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. +* **trafficRoutingMethod**: 'Geographic' | 'Performance' | 'Priority' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. +* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/trafficmanager/microsoft.network/2018-03-01/types.md b/generated/trafficmanager/microsoft.network/2018-03-01/types.md index 1159531418..9a3dacd9ef 100644 --- a/generated/trafficmanager/microsoft.network/2018-03-01/types.md +++ b/generated/trafficmanager/microsoft.network/2018-03-01/types.md @@ -11,15 +11,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.Network/trafficmanagerprofiles' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. -* **trafficRoutingMethod**: 'Geographic' | 'Performance' | 'Priority' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. -* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. - ## DnsConfig ### Properties * **fqdn**: string (ReadOnly): The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -73,6 +64,15 @@ * **max**: int: Max status code. * **min**: int: Min status code. +## ProfileProperties +### Properties +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. +* **trafficRoutingMethod**: 'Geographic' | 'Performance' | 'Priority' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. +* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/trafficmanager/microsoft.network/2018-04-01/types.md b/generated/trafficmanager/microsoft.network/2018-04-01/types.md index 28399bae69..3cc30d0cb7 100644 --- a/generated/trafficmanager/microsoft.network/2018-04-01/types.md +++ b/generated/trafficmanager/microsoft.network/2018-04-01/types.md @@ -20,16 +20,6 @@ * **properties**: [UserMetricsProperties](#usermetricsproperties) (ReadOnly): Class representing a Traffic Manager Real User Metrics key response. * **type**: 'Microsoft.Network/trafficManagerUserMetricsKeys' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. -* **maxReturn**: int: Maximum number of endpoints to be returned for MultiValue routing type. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. -* **trafficRoutingMethod**: 'Geographic' | 'MultiValue' | 'Performance' | 'Priority' | 'Subnet' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. -* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. - ## DnsConfig ### Properties * **fqdn**: string (ReadOnly): The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -90,6 +80,16 @@ * **max**: int: Max status code. * **min**: int: Min status code. +## ProfileProperties +### Properties +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. +* **maxReturn**: int: Maximum number of endpoints to be returned for MultiValue routing type. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. +* **trafficRoutingMethod**: 'Geographic' | 'MultiValue' | 'Performance' | 'Priority' | 'Subnet' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. +* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/trafficmanager/microsoft.network/2018-08-01/types.md b/generated/trafficmanager/microsoft.network/2018-08-01/types.md index e812cdfbcd..4e8edf783d 100644 --- a/generated/trafficmanager/microsoft.network/2018-08-01/types.md +++ b/generated/trafficmanager/microsoft.network/2018-08-01/types.md @@ -47,17 +47,6 @@ * **properties**: [UserMetricsProperties](#usermetricsproperties) (ReadOnly): Class representing a Traffic Manager Real User Metrics key response. * **type**: 'Microsoft.Network/trafficManagerUserMetricsKeys' (ReadOnly, DeployTimeConstant): The resource type -## ProfileProperties -### Properties -* **allowedEndpointRecordTypes**: 'Any' | 'DomainName' | 'IPv4Address' | 'IPv6Address' | string[]: The list of allowed endpoint record types. -* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. -* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. -* **maxReturn**: int: Maximum number of endpoints to be returned for MultiValue routing type. -* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. -* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. -* **trafficRoutingMethod**: 'Geographic' | 'MultiValue' | 'Performance' | 'Priority' | 'Subnet' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. -* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. - ## DnsConfig ### Properties * **fqdn**: string (ReadOnly): The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. @@ -120,6 +109,17 @@ * **max**: int: Max status code. * **min**: int: Min status code. +## ProfileProperties +### Properties +* **allowedEndpointRecordTypes**: 'Any' | 'DomainName' | 'IPv4Address' | 'IPv6Address' | string[]: The list of allowed endpoint record types. +* **dnsConfig**: [DnsConfig](#dnsconfig): Class containing DNS settings in a Traffic Manager profile. +* **endpoints**: [Endpoint](#endpoint)[]: The list of endpoints in the Traffic Manager profile. +* **maxReturn**: int: Maximum number of endpoints to be returned for MultiValue routing type. +* **monitorConfig**: [MonitorConfig](#monitorconfig): Class containing endpoint monitoring settings in a Traffic Manager profile. +* **profileStatus**: 'Disabled' | 'Enabled' | string: The status of the Traffic Manager profile. +* **trafficRoutingMethod**: 'Geographic' | 'MultiValue' | 'Performance' | 'Priority' | 'Subnet' | 'Weighted' | string: The traffic routing method of the Traffic Manager profile. +* **trafficViewEnrollmentStatus**: 'Disabled' | 'Enabled' | 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. + ## TrackedResourceTags ### Properties ### Additional Properties diff --git a/generated/vi/log.out b/generated/vi/log.out index be21d65fc8..2fe34f3a33 100644 --- a/generated/vi/log.out +++ b/generated/vi/log.out @@ -3,23 +3,23 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.videoindexer-2021-11-10-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 10ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.videoindexer-2021-10-27-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.videoindexer-2021-10-18-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 2ms -info | Autorest completed in 9.17s. 6 files generated. +info | Autorest completed in 9.21s. 6 files generated. diff --git a/generated/vi/microsoft.videoindexer/2021-10-18-preview/types.md b/generated/vi/microsoft.videoindexer/2021-10-18-preview/types.md index 1dc3b4e2f0..4a48954fe1 100644 --- a/generated/vi/microsoft.videoindexer/2021-10-18-preview/types.md +++ b/generated/vi/microsoft.videoindexer/2021-10-18-preview/types.md @@ -13,23 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.VideoIndexer/accounts' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - ## AccountPropertiesForPutRequest ### Properties * **accountId**: string: The account's data-plane ID @@ -38,6 +21,13 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called. * **tenantId**: string (ReadOnly): The account's tenant id +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. + ## MediaServicesForPutRequest ### Properties * **resourceId**: string: The media services resource id @@ -57,3 +47,13 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. + diff --git a/generated/vi/microsoft.videoindexer/2021-10-27-preview/types.md b/generated/vi/microsoft.videoindexer/2021-10-27-preview/types.md index 79f91a138b..ffc61a1403 100644 --- a/generated/vi/microsoft.videoindexer/2021-10-27-preview/types.md +++ b/generated/vi/microsoft.videoindexer/2021-10-27-preview/types.md @@ -13,23 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.VideoIndexer/accounts' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - ## AccountPropertiesForPutRequest ### Properties * **accountId**: string: The account's data-plane ID @@ -38,6 +21,13 @@ * **provisioningState**: 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | string (ReadOnly): Gets the status of the account at the time the operation was called. * **tenantId**: string (ReadOnly): The account's tenant id +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. + ## MediaServicesForPutRequest ### Properties * **resourceId**: string: The media services resource id @@ -57,3 +47,13 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. + diff --git a/generated/vi/microsoft.videoindexer/2021-11-10-preview/types.md b/generated/vi/microsoft.videoindexer/2021-11-10-preview/types.md index 275aaf6366..853348844c 100644 --- a/generated/vi/microsoft.videoindexer/2021-11-10-preview/types.md +++ b/generated/vi/microsoft.videoindexer/2021-11-10-preview/types.md @@ -13,23 +13,6 @@ * **tags**: [TrackedResourceTags](#trackedresourcetags): Resource tags. * **type**: 'Microsoft.VideoIndexer/accounts' (ReadOnly, DeployTimeConstant): The resource type -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). -* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. - -## UserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) - -## UserAssignedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID of the assigned identity. -* **principalId**: string (ReadOnly): The principal ID of the assigned identity. - ## AccountPropertiesForPutRequest ### Properties * **accountId**: string: The account's data-plane ID @@ -39,6 +22,13 @@ * **tenantId**: string (ReadOnly): The account's tenant id * **totalSecondsIndexed**: int (ReadOnly): An integer representing the total seconds that have been indexed on the account +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned,UserAssigned' | 'UserAssigned' | string (Required): Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +* **userAssignedIdentities**: [UserAssignedIdentities](#userassignedidentities): The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. + ## MediaServicesForPutRequest ### Properties * **resourceId**: string: The media services resource id @@ -58,3 +48,13 @@ ### Additional Properties * **Additional Properties Type**: string +## UserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID of the assigned identity. +* **principalId**: string (ReadOnly): The principal ID of the assigned identity. + diff --git a/generated/videoanalyzer/log.out b/generated/videoanalyzer/log.out index 310e6871e6..3e62ba2973 100644 --- a/generated/videoanalyzer/log.out +++ b/generated/videoanalyzer/log.out @@ -5,12 +5,12 @@ info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep- warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.media-2021-11-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'SourceNodeBase' has a property '@type' that is already declared the parent schema 'NodeBase' but isn't significantly different. The property has been removed from SourceNodeBase @@ -21,10 +21,10 @@ info | Processing batch task - {"tag":"microsoft.media-2021-05-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'VideoAnalyzerProperties' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/videoanalyzer/resource-manager/Microsoft.Media/preview/2021-05-01-preview/VideoAnalyzers.json:377:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 8ms -info | Autorest completed in 11.66s. 4 files generated. +info | autorest.bicep took 6ms +info | Autorest completed in 11.35s. 4 files generated. diff --git a/generated/videoanalyzer/microsoft.media/2021-05-01-preview/types.md b/generated/videoanalyzer/microsoft.media/2021-05-01-preview/types.md index 9909c6cea7..b156f23e2c 100644 --- a/generated/videoanalyzer/microsoft.media/2021-05-01-preview/types.md +++ b/generated/videoanalyzer/microsoft.media/2021-05-01-preview/types.md @@ -54,26 +54,10 @@ * **ApiVersion**: 2021-05-01-preview * **Output**: [VideoStreamingToken](#videostreamingtoken) -## VideoAnalyzerIdentity -### Properties -* **type**: string (Required): The identity type. -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. - -## UserAssignedManagedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) - -## UserAssignedManagedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID. -* **principalId**: string (ReadOnly): The principal ID. - -## VideoAnalyzerProperties +## AccessPolicyProperties ### Properties -* **encryption**: [AccountEncryption](#accountencryption): Defines how the Video Analyzer account is (optionally) encrypted. -* **endpoints**: [Endpoint](#endpoint)[] (ReadOnly): The list of endpoints associated with this resource. -* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. +* **authentication**: [AuthenticationBase](#authenticationbase): Base class for access policies authentication methods. +* **role**: 'Reader' | string: Defines the access level granted by this policy. ## AccountEncryption ### Properties @@ -82,20 +66,46 @@ * **status**: string (ReadOnly): The current status of the Key Vault mapping. * **type**: 'CustomerKey' | 'SystemKey' | string (Required): The type of key used to encrypt the Account Key. -## ResourceIdentity +## AuthenticationBase +* **Discriminator**: @type + +### Base Properties +### JwtAuthentication +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.JwtAuthentication' (Required): The discriminator for derived types. +* **audiences**: string[]: List of expected token audiences. Token audience is valid if it matches at least one of the given values. +* **claims**: [TokenClaim](#tokenclaim)[]: List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid. +* **issuers**: string[]: List of expected token issuers. Token issuer is valid if it matches at least one of the given values. +* **keys**: [TokenKey](#tokenkey)[]: List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key. + + +## EdgeModuleProperties ### Properties -* **userAssignedIdentity**: string (Required): The user assigned managed identity's resource identifier to use when accessing a resource. +* **edgeModuleId**: string (ReadOnly): Internal ID generated for the instance of the Video Analyzer edge module. -## KeyVaultProperties +## EdgeModuleProvisioningToken ### Properties -* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt Video Analyzer account, including the key version. -* **keyIdentifier**: string (Required): The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). +* **expirationDate**: string (ReadOnly): The expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. +* **token**: string (ReadOnly): The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module twin properties. ## Endpoint ### Properties * **endpointUrl**: string: The URL of the endpoint. * **type**: 'ClientApi' | string (Required): The type of the endpoint. +## KeyVaultProperties +### Properties +* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt Video Analyzer account, including the key version. +* **keyIdentifier**: string (Required): The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). + +## ListProvisioningTokenInput +### Properties +* **expirationDate**: string (Required, WriteOnly): The desired expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. + +## ResourceIdentity +### Properties +* **userAssignedIdentity**: string (Required): The user assigned managed identity's resource identifier to use when accessing a resource. + ## StorageAccount ### Properties * **id**: string: The ID of the storage account resource. Video Analyzer relies on tables, queues, and blobs. The primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). @@ -111,29 +121,6 @@ * **lastModifiedBy**: string: The identity that last modified the resource. * **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## TrackedResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AccessPolicyProperties -### Properties -* **authentication**: [AuthenticationBase](#authenticationbase): Base class for access policies authentication methods. -* **role**: 'Reader' | string: Defines the access level granted by this policy. - -## AuthenticationBase -* **Discriminator**: @type - -### Base Properties -### JwtAuthentication -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.JwtAuthentication' (Required): The discriminator for derived types. -* **audiences**: string[]: List of expected token audiences. Token audience is valid if it matches at least one of the given values. -* **claims**: [TokenClaim](#tokenclaim)[]: List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid. -* **issuers**: string[]: List of expected token issuers. Token issuer is valid if it matches at least one of the given values. -* **keys**: [TokenKey](#tokenkey)[]: List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key. - - ## TokenClaim ### Properties * **name**: string (Required): Name of the claim which must be present on the token. @@ -159,18 +146,31 @@ * **n**: string (Required): RSA public key modulus. -## EdgeModuleProperties +## TrackedResourceTags ### Properties -* **edgeModuleId**: string (ReadOnly): Internal ID generated for the instance of the Video Analyzer edge module. +### Additional Properties +* **Additional Properties Type**: string -## VideoProperties +## UserAssignedManagedIdentities ### Properties -* **description**: string: Optional video description provided by the user. Value can be up to 2048 characters long. -* **flags**: [VideoFlags](#videoflags) (ReadOnly): Video flags contain information about the available video actions and its dynamic properties based on the current video state. -* **mediaInfo**: [VideoMediaInfo](#videomediainfo) (ReadOnly): Contains information about the video and audio content. -* **streaming**: [VideoStreaming](#videostreaming) (ReadOnly): Video streaming holds information about video streaming URLs. -* **title**: string: Optional video title provided by the user. Value can be up to 256 characters long. -* **type**: 'Archive' | string (ReadOnly): Type of the video archive. Different archive formats provide different capabilities. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) + +## UserAssignedManagedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID. +* **principalId**: string (ReadOnly): The principal ID. + +## VideoAnalyzerIdentity +### Properties +* **type**: string (Required): The identity type. +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. + +## VideoAnalyzerProperties +### Properties +* **encryption**: [AccountEncryption](#accountencryption): Defines how the Video Analyzer account is (optionally) encrypted. +* **endpoints**: [Endpoint](#endpoint)[] (ReadOnly): The list of endpoints associated with this resource. +* **storageAccounts**: [StorageAccount](#storageaccount)[]: The storage accounts for this resource. ## VideoFlags ### Properties @@ -182,6 +182,15 @@ ### Properties * **segmentLength**: string (ReadOnly): Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. +## VideoProperties +### Properties +* **description**: string: Optional video description provided by the user. Value can be up to 2048 characters long. +* **flags**: [VideoFlags](#videoflags) (ReadOnly): Video flags contain information about the available video actions and its dynamic properties based on the current video state. +* **mediaInfo**: [VideoMediaInfo](#videomediainfo) (ReadOnly): Contains information about the video and audio content. +* **streaming**: [VideoStreaming](#videostreaming) (ReadOnly): Video streaming holds information about video streaming URLs. +* **title**: string: Optional video title provided by the user. Value can be up to 256 characters long. +* **type**: 'Archive' | string (ReadOnly): Type of the video archive. Different archive formats provide different capabilities. + ## VideoStreaming ### Properties * **archiveBaseUrl**: string: Video streaming base URL for the video archive. When present, archived video can be played through the Azure Video Analyzer player. Alternatively, this URL can be used with compatible DASH or HLS players by appending the following to the base URL: @@ -192,15 +201,6 @@ Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. -## ListProvisioningTokenInput -### Properties -* **expirationDate**: string (Required, WriteOnly): The desired expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. - -## EdgeModuleProvisioningToken -### Properties -* **expirationDate**: string (ReadOnly): The expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. -* **token**: string (ReadOnly): The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module twin properties. - ## VideoStreamingToken ### Properties * **expirationDate**: string (ReadOnly): The streaming token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z). diff --git a/generated/videoanalyzer/microsoft.media/2021-11-01-preview/types.md b/generated/videoanalyzer/microsoft.media/2021-11-01-preview/types.md index de2b07b6ac..8d700943d5 100644 --- a/generated/videoanalyzer/microsoft.media/2021-11-01-preview/types.md +++ b/generated/videoanalyzer/microsoft.media/2021-11-01-preview/types.md @@ -96,31 +96,10 @@ * **Input**: [ListProvisioningTokenInput](#listprovisioningtokeninput) * **Output**: [EdgeModuleProvisioningToken](#edgemoduleprovisioningtoken) -## VideoAnalyzerIdentity -### Properties -* **type**: string (Required): The identity type. -* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. - -## UserAssignedManagedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) - -## UserAssignedManagedIdentity -### Properties -* **clientId**: string (ReadOnly): The client ID. -* **principalId**: string (ReadOnly): The principal ID. - -## VideoAnalyzerProperties +## AccessPolicyProperties ### Properties -* **encryption**: [AccountEncryption](#accountencryption): Defines how the Video Analyzer account is (optionally) encrypted. -* **endpoints**: [Endpoint](#endpoint)[] (ReadOnly): The endpoints associated with this resource. -* **iotHubs**: [IotHub](#iothub)[]: The IoT Hubs for this resource. -* **networkAccessControl**: [NetworkAccessControl](#networkaccesscontrol): Network access control for video analyzer account. -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private Endpoint Connections created under Video Analyzer account. -* **provisioningState**: 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Video Analyzer account. -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for resources under the Video Analyzer account. -* **storageAccounts**: [StorageAccount](#storageaccount)[] (Required): The storage accounts for this resource. +* **authentication**: [AuthenticationBase](#authenticationbase): Base class for access policies authentication methods. +* **role**: 'Reader' | string: Defines the access level granted by this policy. ## AccountEncryption ### Properties @@ -129,126 +108,116 @@ * **status**: string (ReadOnly): The current status of the Key Vault mapping. * **type**: 'CustomerKey' | 'SystemKey' | string (Required): The type of key used to encrypt the Account Key. -## ResourceIdentity -### Properties -* **userAssignedIdentity**: string (Required): The user assigned managed identity's resource identifier to use when accessing a resource. +## AudioEncoderBase +* **Discriminator**: @type -## KeyVaultProperties -### Properties -* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt Video Analyzer account, including the key version. -* **keyIdentifier**: string (Required): The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). +### Base Properties +* **bitrateKbps**: string: Bitrate, in kilobits per second or Kbps, at which audio should be encoded (2-channel stereo audio at a sampling rate of 48 kHz). Allowed values are 96, 112, 128, 160, 192, 224, and 256. If omitted, the bitrate of the input audio is used. +### AudioEncoderAac +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.AudioEncoderAac' (Required): The discriminator for derived types. -## Endpoint -### Properties -* **endpointUrl**: string: The URL of the endpoint. -* **type**: 'ClientApi' | string (Required): The type of the endpoint. -## IotHub -### Properties -* **id**: string (Required): The IoT Hub resource identifier. -* **identity**: [ResourceIdentity](#resourceidentity) (Required): The user assigned managed identity to use when accessing a resource. -* **status**: string (ReadOnly): The current status of the Iot Hub mapping. +## AuthenticationBase +* **Discriminator**: @type -## NetworkAccessControl -### Properties -* **consumption**: [GroupLevelAccessControl](#grouplevelaccesscontrol): Group level network access control. -* **ingestion**: [GroupLevelAccessControl](#grouplevelaccesscontrol): Group level network access control. -* **integration**: [GroupLevelAccessControl](#grouplevelaccesscontrol): Group level network access control. +### Base Properties +### JwtAuthentication +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.JwtAuthentication' (Required): The discriminator for derived types. +* **audiences**: string[]: List of expected token audiences. Token audience is valid if it matches at least one of the given values. +* **claims**: [TokenClaim](#tokenclaim)[]: List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid. +* **issuers**: string[]: List of expected token issuers. Token issuer is valid if it matches at least one of the given values. +* **keys**: [TokenKey](#tokenkey)[]: List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key. -## GroupLevelAccessControl -### Properties -* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for resources under the Video Analyzer account. -## PrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} -* **name**: string (ReadOnly): The name of the resource -* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" +## CertificateSource +* **Discriminator**: @type -## PrivateEndpointConnectionProperties -### Properties -* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. -* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. -* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. +### Base Properties +### PemCertificateList +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.PemCertificateList' (Required): The discriminator for derived types. +* **certificates**: string[] (Required): PEM formatted public certificates. One certificate per entry. -## PrivateEndpoint -### Properties -* **id**: string (ReadOnly): The ARM identifier for Private Endpoint -## PrivateLinkServiceConnectionState -### Properties -* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. -* **description**: string: The reason for approval/rejection of the connection. -* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. +## CredentialsBase +* **Discriminator**: @type -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +### Base Properties +### UsernamePasswordCredentials +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.UsernamePasswordCredentials' (Required): The discriminator for derived types. +* **password**: string (Required): Password to be presented as part of the credentials. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests. +* **username**: string (Required): Username to be presented as part of the credentials. -## StorageAccount -### Properties -* **id**: string (Required): The ID of the storage account resource. Video Analyzer relies on tables, queues, and blobs. The primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). -* **identity**: [ResourceIdentity](#resourceidentity): The user assigned managed identity to use when accessing a resource. -* **status**: string (ReadOnly): The current status of the storage account mapping. -## TrackedResourceTags +## EdgeModuleProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **edgeModuleId**: string (ReadOnly): Internal ID generated for the instance of the Video Analyzer edge module. -## AccessPolicyProperties +## EdgeModuleProvisioningToken ### Properties -* **authentication**: [AuthenticationBase](#authenticationbase): Base class for access policies authentication methods. -* **role**: 'Reader' | string: Defines the access level granted by this policy. +* **expirationDate**: string (ReadOnly): The expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. +* **token**: string (ReadOnly): The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module twin properties. -## AuthenticationBase +## EncoderPresetBase * **Discriminator**: @type ### Base Properties -### JwtAuthentication +### EncoderCustomPreset #### Properties -* **@type**: '#Microsoft.VideoAnalyzer.JwtAuthentication' (Required): The discriminator for derived types. -* **audiences**: string[]: List of expected token audiences. Token audience is valid if it matches at least one of the given values. -* **claims**: [TokenClaim](#tokenclaim)[]: List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid. -* **issuers**: string[]: List of expected token issuers. Token issuer is valid if it matches at least one of the given values. -* **keys**: [TokenKey](#tokenkey)[]: List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key. +* **@type**: '#Microsoft.VideoAnalyzer.EncoderCustomPreset' (Required): The discriminator for derived types. +* **audioEncoder**: [AudioEncoderBase](#audioencoderbase): Base type for all audio encoder presets, which define the recipe or instructions on how audio should be processed. +* **videoEncoder**: [VideoEncoderBase](#videoencoderbase): Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed. +### EncoderSystemPreset +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.EncoderSystemPreset' (Required): The discriminator for derived types. +* **name**: 'SingleLayer_1080p_H264_AAC' | 'SingleLayer_2160p_H264_AAC' | 'SingleLayer_540p_H264_AAC' | 'SingleLayer_720p_H264_AAC' | string (Required): Name of the built-in encoding preset. -## TokenClaim + +## Endpoint ### Properties -* **name**: string (Required): Name of the claim which must be present on the token. -* **value**: string (Required): Expected value of the claim to be present on the token. +* **endpointUrl**: string: The URL of the endpoint. +* **type**: 'ClientApi' | string (Required): The type of the endpoint. -## TokenKey +## EndpointBase * **Discriminator**: @type ### Base Properties -* **kid**: string (Required): JWT token key id. Validation keys are looked up based on the key id present on the JWT token header. -### EccTokenKey +* **credentials**: [CredentialsBase](#credentialsbase) (Required): Base class for credential objects. +* **tunnel**: [TunnelBase](#tunnelbase): Base class for tunnel objects. +* **url**: string (Required): The endpoint URL for Video Analyzer to connect to. +### TlsEndpoint #### Properties -* **@type**: '#Microsoft.VideoAnalyzer.EccTokenKey' (Required): The discriminator for derived types. -* **alg**: 'ES256' | 'ES384' | 'ES512' | string (Required): Elliptical curve algorithm to be used: ES256, ES384 or ES512. -* **x**: string (Required): X coordinate. -* **y**: string (Required): Y coordinate. +* **@type**: '#Microsoft.VideoAnalyzer.TlsEndpoint' (Required): The discriminator for derived types. +* **trustedCertificates**: [CertificateSource](#certificatesource): Base class for certificate sources. +* **validationOptions**: [TlsValidationOptions](#tlsvalidationoptions): Options for controlling the validation of TLS endpoints. -### RsaTokenKey +### UnsecuredEndpoint #### Properties -* **@type**: '#Microsoft.VideoAnalyzer.RsaTokenKey' (Required): The discriminator for derived types. -* **alg**: 'RS256' | 'RS384' | 'RS512' | string (Required): RSA algorithm to be used: RS256, RS384 or RS512. -* **e**: string (Required): RSA public key exponent. -* **n**: string (Required): RSA public key modulus. +* **@type**: '#Microsoft.VideoAnalyzer.UnsecuredEndpoint' (Required): The discriminator for derived types. -## EdgeModuleProperties +## GroupLevelAccessControl ### Properties -* **edgeModuleId**: string (ReadOnly): Internal ID generated for the instance of the Video Analyzer edge module. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for resources under the Video Analyzer account. + +## IotHub +### Properties +* **id**: string (Required): The IoT Hub resource identifier. +* **identity**: [ResourceIdentity](#resourceidentity) (Required): The user assigned managed identity to use when accessing a resource. +* **status**: string (ReadOnly): The current status of the Iot Hub mapping. + +## KeyVaultProperties +### Properties +* **currentKeyIdentifier**: string (ReadOnly): The current key used to encrypt Video Analyzer account, including the key version. +* **keyIdentifier**: string (Required): The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). + +## ListProvisioningTokenInput +### Properties +* **expirationDate**: string (Required, WriteOnly): The desired expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. ## LivePipelineProperties ### Properties @@ -258,11 +227,33 @@ * **state**: 'Activating' | 'Active' | 'Deactivating' | 'Inactive' | string (ReadOnly): Current state of the pipeline (read-only). * **topologyName**: string (Required): The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. +## NetworkAccessControl +### Properties +* **consumption**: [GroupLevelAccessControl](#grouplevelaccesscontrol): Group level network access control. +* **ingestion**: [GroupLevelAccessControl](#grouplevelaccesscontrol): Group level network access control. +* **integration**: [GroupLevelAccessControl](#grouplevelaccesscontrol): Group level network access control. + +## NodeInput +### Properties +* **nodeName**: string (Required): The name of the upstream node in the pipeline which output is used as input of the current node. + +## ParameterDeclaration +### Properties +* **default**: string: The default value for the parameter to be used if the pipeline does not specify a value. +* **description**: string: Description of the parameter. +* **name**: string (Required): Name of the parameter. +* **type**: 'Bool' | 'Double' | 'Int' | 'SecretString' | 'String' | string (Required): Type of the parameter. + ## ParameterDefinition ### Properties * **name**: string (Required): Name of the parameter declared in the pipeline topology. * **value**: string: Parameter value to be applied on this specific pipeline. +## PipelineJobError +### Properties +* **code**: string: The error code. +* **message**: string: The error message. + ## PipelineJobProperties ### Properties * **description**: string: An optional description for the pipeline. @@ -272,11 +263,6 @@ * **state**: 'Canceled' | 'Completed' | 'Failed' | 'Processing' | string (ReadOnly): Current state of the pipeline (read-only). * **topologyName**: string (Required): Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. -## PipelineJobError -### Properties -* **code**: string: The error code. -* **message**: string: The error message. - ## PipelineTopologyProperties ### Properties * **description**: string: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. @@ -285,12 +271,29 @@ * **sinks**: [SinkNodeBase](#sinknodebase)[] (Required): List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. * **sources**: [SourceNodeBase](#sourcenodebase)[] (Required): List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. -## ParameterDeclaration +## PrivateEndpoint ### Properties -* **default**: string: The default value for the parameter to be used if the pipeline does not specify a value. -* **description**: string: Description of the parameter. -* **name**: string (Required): Name of the parameter. -* **type**: 'Bool' | 'Double' | 'Int' | 'SecretString' | 'String' | string (Required): Type of the parameter. +* **id**: string (ReadOnly): The ARM identifier for Private Endpoint + +## PrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} +* **name**: string (ReadOnly): The name of the resource +* **properties**: [PrivateEndpointConnectionProperties](#privateendpointconnectionproperties): Properties of the PrivateEndpointConnectProperties. +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + +## PrivateEndpointConnectionProperties +### Properties +* **privateEndpoint**: [PrivateEndpoint](#privateendpoint): The Private Endpoint resource. +* **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate) (Required): A collection of information about the state of the connection between service consumer and provider. +* **provisioningState**: 'Creating' | 'Deleting' | 'Failed' | 'Succeeded' | string (ReadOnly): The current provisioning state. + +## PrivateLinkServiceConnectionState +### Properties +* **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. +* **description**: string: The reason for approval/rejection of the connection. +* **status**: 'Approved' | 'Pending' | 'Rejected' | string: The private endpoint connection status. ## ProcessorNodeBase * **Discriminator**: @type @@ -304,53 +307,9 @@ * **preset**: [EncoderPresetBase](#encoderpresetbase) (Required): Base type for all encoder presets, which define the recipe or instructions on how the input content should be processed. -## NodeInput -### Properties -* **nodeName**: string (Required): The name of the upstream node in the pipeline which output is used as input of the current node. - -## EncoderPresetBase -* **Discriminator**: @type - -### Base Properties -### EncoderCustomPreset -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.EncoderCustomPreset' (Required): The discriminator for derived types. -* **audioEncoder**: [AudioEncoderBase](#audioencoderbase): Base type for all audio encoder presets, which define the recipe or instructions on how audio should be processed. -* **videoEncoder**: [VideoEncoderBase](#videoencoderbase): Base type for all video encoding presets, which define the recipe or instructions on how the input video should be processed. - -### EncoderSystemPreset -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.EncoderSystemPreset' (Required): The discriminator for derived types. -* **name**: 'SingleLayer_1080p_H264_AAC' | 'SingleLayer_2160p_H264_AAC' | 'SingleLayer_540p_H264_AAC' | 'SingleLayer_720p_H264_AAC' | string (Required): Name of the built-in encoding preset. - - -## AudioEncoderBase -* **Discriminator**: @type - -### Base Properties -* **bitrateKbps**: string: Bitrate, in kilobits per second or Kbps, at which audio should be encoded (2-channel stereo audio at a sampling rate of 48 kHz). Allowed values are 96, 112, 128, 160, 192, 224, and 256. If omitted, the bitrate of the input audio is used. -### AudioEncoderAac -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.AudioEncoderAac' (Required): The discriminator for derived types. - - -## VideoEncoderBase -* **Discriminator**: @type - -### Base Properties -* **bitrateKbps**: string: The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically to try and match the quality of the input video. -* **frameRate**: string: The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal to 300. If omitted, the encoder uses the average frame rate of the input video. -* **scale**: [VideoScale](#videoscale): The video scaling information. -### VideoEncoderH264 -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.VideoEncoderH264' (Required): The discriminator for derived types. - - -## VideoScale +## ResourceIdentity ### Properties -* **height**: string: The desired output video height. -* **mode**: 'Pad' | 'PreserveAspectRatio' | 'Stretch' | string: Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width and height must be specified. Else if the mode is 'PreserveAspectRatio' then only one of width or height need be provided. -* **width**: string: The desired output video width. +* **userAssignedIdentity**: string (Required): The user assigned managed identity's resource identifier to use when accessing a resource. ## SinkNodeBase * **Discriminator**: @type @@ -366,17 +325,10 @@ * **videoPublishingOptions**: [VideoPublishingOptions](#videopublishingoptions): Optional flags used to change how video is published. These are only allowed for topologies where "kind" is set to "live". -## VideoCreationProperties -### Properties -* **description**: string: Optional description provided by the user. Value can be up to 2048 characters long. -* **retentionPeriod**: string: Video retention period indicates how long the video is kept in storage. Value must be specified in ISO8601 duration format (i.e. "P1D" equals 1 day) and can vary between 1 day to 10 years, in 1 day increments. When absent (null), all video content is retained indefinitely. This property is only allowed for topologies where "kind" is set to "live". -* **segmentLength**: string: Segment length indicates the length of individual content files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the initial call to create the video resource can lead to errors when uploading content to the archive. Default value is 30 seconds. This property is only allowed for topologies where "kind" is set to "live". -* **title**: string: Optional title provided by the user. Value can be up to 256 characters long. - -## VideoPublishingOptions +## Sku ### Properties -* **disableArchive**: string: When set to 'true' content will not be archived or recorded. This is used, for example, when the topology is used only for low latency video streaming. Default is 'false'. If set to 'true', then "disableRtspPublishing" must be set to 'false'. -* **disableRtspPublishing**: string: When set to 'true' the RTSP playback URL will not be published, disabling low latency streaming. This is used, for example, when the topology is used only for archiving content. Default is 'false'. If set to 'true', then "disableArchive" must be set to 'false'. +* **name**: 'Batch_S1' | 'Live_S1' | string (Required): The SKU name. +* **tier**: 'Standard' | string (ReadOnly): The SKU tier. ## SourceNodeBase * **Discriminator**: @type @@ -396,34 +348,65 @@ * **videoName**: string (Required): Name of the Video Analyzer video resource to be used as the source. -## EndpointBase +## StorageAccount +### Properties +* **id**: string (Required): The ID of the storage account resource. Video Analyzer relies on tables, queues, and blobs. The primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). +* **identity**: [ResourceIdentity](#resourceidentity): The user assigned managed identity to use when accessing a resource. +* **status**: string (ReadOnly): The current status of the storage account mapping. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TimeSequenceBase * **Discriminator**: @type ### Base Properties -* **credentials**: [CredentialsBase](#credentialsbase) (Required): Base class for credential objects. -* **tunnel**: [TunnelBase](#tunnelbase): Base class for tunnel objects. -* **url**: string (Required): The endpoint URL for Video Analyzer to connect to. -### TlsEndpoint +### VideoSequenceAbsoluteTimeMarkers #### Properties -* **@type**: '#Microsoft.VideoAnalyzer.TlsEndpoint' (Required): The discriminator for derived types. -* **trustedCertificates**: [CertificateSource](#certificatesource): Base class for certificate sources. -* **validationOptions**: [TlsValidationOptions](#tlsvalidationoptions): Options for controlling the validation of TLS endpoints. +* **@type**: '#Microsoft.VideoAnalyzer.VideoSequenceAbsoluteTimeMarkers' (Required): The discriminator for derived types. +* **ranges**: string (Required): The sequence of datetime ranges. Example: '[["2021-10-05T03:30:00Z", "2021-10-05T03:40:00Z"]]'. -### UnsecuredEndpoint -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.UnsecuredEndpoint' (Required): The discriminator for derived types. +## TlsValidationOptions +### Properties +* **ignoreHostname**: string: When set to 'true' causes the certificate subject name validation to be skipped. Default is 'false'. +* **ignoreSignature**: string: When set to 'true' causes the certificate chain trust validation to be skipped. Default is 'false'. -## CredentialsBase +## TokenClaim +### Properties +* **name**: string (Required): Name of the claim which must be present on the token. +* **value**: string (Required): Expected value of the claim to be present on the token. + +## TokenKey * **Discriminator**: @type ### Base Properties -### UsernamePasswordCredentials +* **kid**: string (Required): JWT token key id. Validation keys are looked up based on the key id present on the JWT token header. +### EccTokenKey #### Properties -* **@type**: '#Microsoft.VideoAnalyzer.UsernamePasswordCredentials' (Required): The discriminator for derived types. -* **password**: string (Required): Password to be presented as part of the credentials. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests. -* **username**: string (Required): Username to be presented as part of the credentials. +* **@type**: '#Microsoft.VideoAnalyzer.EccTokenKey' (Required): The discriminator for derived types. +* **alg**: 'ES256' | 'ES384' | 'ES512' | string (Required): Elliptical curve algorithm to be used: ES256, ES384 or ES512. +* **x**: string (Required): X coordinate. +* **y**: string (Required): Y coordinate. +### RsaTokenKey +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.RsaTokenKey' (Required): The discriminator for derived types. +* **alg**: 'RS256' | 'RS384' | 'RS512' | string (Required): RSA algorithm to be used: RS256, RS384 or RS512. +* **e**: string (Required): RSA public key exponent. +* **n**: string (Required): RSA public key modulus. + + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## TunnelBase * **Discriminator**: @type @@ -436,50 +419,41 @@ * **iotHubName**: string (Required): Name of the IoT Hub. -## CertificateSource -* **Discriminator**: @type - -### Base Properties -### PemCertificateList -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.PemCertificateList' (Required): The discriminator for derived types. -* **certificates**: string[] (Required): PEM formatted public certificates. One certificate per entry. - - -## TlsValidationOptions +## UserAssignedManagedIdentities ### Properties -* **ignoreHostname**: string: When set to 'true' causes the certificate subject name validation to be skipped. Default is 'false'. -* **ignoreSignature**: string: When set to 'true' causes the certificate chain trust validation to be skipped. Default is 'false'. - -## TimeSequenceBase -* **Discriminator**: @type - -### Base Properties -### VideoSequenceAbsoluteTimeMarkers -#### Properties -* **@type**: '#Microsoft.VideoAnalyzer.VideoSequenceAbsoluteTimeMarkers' (Required): The discriminator for derived types. -* **ranges**: string (Required): The sequence of datetime ranges. Example: '[["2021-10-05T03:30:00Z", "2021-10-05T03:40:00Z"]]'. +### Additional Properties +* **Additional Properties Type**: [UserAssignedManagedIdentity](#userassignedmanagedidentity) +## UserAssignedManagedIdentity +### Properties +* **clientId**: string (ReadOnly): The client ID. +* **principalId**: string (ReadOnly): The principal ID. -## Sku +## VideoAnalyzerIdentity ### Properties -* **name**: 'Batch_S1' | 'Live_S1' | string (Required): The SKU name. -* **tier**: 'Standard' | string (ReadOnly): The SKU tier. +* **type**: string (Required): The identity type. +* **userAssignedIdentities**: [UserAssignedManagedIdentities](#userassignedmanagedidentities): The User Assigned Managed Identities. -## VideoProperties +## VideoAnalyzerProperties ### Properties -* **archival**: [VideoArchival](#videoarchival): Video archival properties. -* **contentUrls**: [VideoContentUrls](#videocontenturls) (ReadOnly): Set of URLs to the video content. -* **description**: string: Optional video description provided by the user. Value can be up to 2048 characters long. -* **flags**: [VideoFlags](#videoflags) (ReadOnly): Video flags contain information about the available video actions and its dynamic properties based on the current video state. -* **mediaInfo**: [VideoMediaInfo](#videomediainfo): Contains information about the video and audio content. -* **title**: string: Optional video title provided by the user. Value can be up to 256 characters long. -* **type**: 'Archive' | 'File' | string (ReadOnly): Video content type. Different content types are suitable for different applications and scenarios. +* **encryption**: [AccountEncryption](#accountencryption): Defines how the Video Analyzer account is (optionally) encrypted. +* **endpoints**: [Endpoint](#endpoint)[] (ReadOnly): The endpoints associated with this resource. +* **iotHubs**: [IotHub](#iothub)[]: The IoT Hubs for this resource. +* **networkAccessControl**: [NetworkAccessControl](#networkaccesscontrol): Network access control for video analyzer account. +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private Endpoint Connections created under Video Analyzer account. +* **provisioningState**: 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Video Analyzer account. +* **publicNetworkAccess**: 'Disabled' | 'Enabled' | string: Whether or not public network access is allowed for resources under the Video Analyzer account. +* **storageAccounts**: [StorageAccount](#storageaccount)[] (Required): The storage accounts for this resource. ## VideoArchival ### Properties * **retentionPeriod**: string: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. +## VideoContentToken +### Properties +* **expirationDate**: string (ReadOnly): The content token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z). +* **token**: string (ReadOnly): The content token value to be added to the video content URL as the value for the "token" query string parameter. The token is specific to a single video. + ## VideoContentUrls ### Properties * **archiveBaseUrl**: string: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: @@ -493,11 +467,24 @@ * **previewImageUrls**: [VideoPreviewImageUrls](#videopreviewimageurls): Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled. * **rtspTunnelUrl**: string: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. -## VideoPreviewImageUrls +## VideoCreationProperties ### Properties -* **large**: string: High resolution preview image URL. -* **medium**: string: Medium resolution preview image URL. -* **small**: string: Low resolution preview image URL. +* **description**: string: Optional description provided by the user. Value can be up to 2048 characters long. +* **retentionPeriod**: string: Video retention period indicates how long the video is kept in storage. Value must be specified in ISO8601 duration format (i.e. "P1D" equals 1 day) and can vary between 1 day to 10 years, in 1 day increments. When absent (null), all video content is retained indefinitely. This property is only allowed for topologies where "kind" is set to "live". +* **segmentLength**: string: Segment length indicates the length of individual content files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the initial call to create the video resource can lead to errors when uploading content to the archive. Default value is 30 seconds. This property is only allowed for topologies where "kind" is set to "live". +* **title**: string: Optional title provided by the user. Value can be up to 256 characters long. + +## VideoEncoderBase +* **Discriminator**: @type + +### Base Properties +* **bitrateKbps**: string: The maximum bitrate, in kilobits per second or Kbps, at which video should be encoded. If omitted, encoder sets it automatically to try and match the quality of the input video. +* **frameRate**: string: The frame rate (in frames per second) of the encoded video. The value must be greater than zero, and less than or equal to 300. If omitted, the encoder uses the average frame rate of the input video. +* **scale**: [VideoScale](#videoscale): The video scaling information. +### VideoEncoderH264 +#### Properties +* **@type**: '#Microsoft.VideoAnalyzer.VideoEncoderH264' (Required): The discriminator for derived types. + ## VideoFlags ### Properties @@ -509,17 +496,30 @@ ### Properties * **segmentLength**: string: Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. -## VideoContentToken +## VideoPreviewImageUrls ### Properties -* **expirationDate**: string (ReadOnly): The content token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z). -* **token**: string (ReadOnly): The content token value to be added to the video content URL as the value for the "token" query string parameter. The token is specific to a single video. +* **large**: string: High resolution preview image URL. +* **medium**: string: Medium resolution preview image URL. +* **small**: string: Low resolution preview image URL. -## ListProvisioningTokenInput +## VideoProperties ### Properties -* **expirationDate**: string (Required, WriteOnly): The desired expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. +* **archival**: [VideoArchival](#videoarchival): Video archival properties. +* **contentUrls**: [VideoContentUrls](#videocontenturls) (ReadOnly): Set of URLs to the video content. +* **description**: string: Optional video description provided by the user. Value can be up to 2048 characters long. +* **flags**: [VideoFlags](#videoflags) (ReadOnly): Video flags contain information about the available video actions and its dynamic properties based on the current video state. +* **mediaInfo**: [VideoMediaInfo](#videomediainfo): Contains information about the video and audio content. +* **title**: string: Optional video title provided by the user. Value can be up to 256 characters long. +* **type**: 'Archive' | 'File' | string (ReadOnly): Video content type. Different content types are suitable for different applications and scenarios. -## EdgeModuleProvisioningToken +## VideoPublishingOptions ### Properties -* **expirationDate**: string (ReadOnly): The expiration date of the registration token. The Azure Video Analyzer IoT edge module must be initialized and connected to the Internet prior to the token expiration date. -* **token**: string (ReadOnly): The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module twin properties. +* **disableArchive**: string: When set to 'true' content will not be archived or recorded. This is used, for example, when the topology is used only for low latency video streaming. Default is 'false'. If set to 'true', then "disableRtspPublishing" must be set to 'false'. +* **disableRtspPublishing**: string: When set to 'true' the RTSP playback URL will not be published, disabling low latency streaming. This is used, for example, when the topology is used only for archiving content. Default is 'false'. If set to 'true', then "disableArchive" must be set to 'false'. + +## VideoScale +### Properties +* **height**: string: The desired output video height. +* **mode**: 'Pad' | 'PreserveAspectRatio' | 'Stretch' | string: Describes the video scaling mode to be applied. Default mode is 'Pad'. If the mode is 'Pad' or 'Stretch' then both width and height must be specified. Else if the mode is 'PreserveAspectRatio' then only one of width or height need be provided. +* **width**: string: The desired output video width. diff --git a/generated/visualstudio/log.out b/generated/visualstudio/log.out index 02bca6943e..ff6ff0e98d 100644 --- a/generated/visualstudio/log.out +++ b/generated/visualstudio/log.out @@ -3,12 +3,12 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.visualstudio-2014-04-01-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Modeler/MissingType | The enum schema 'AccountResourceRequestOperationType' with an undefined type and enum values is ambiguous. This has been auto-corrected to 'type:string' -info | autorest.bicep took 16ms -info | Autorest completed in 4.9s. 2 files generated. +info | autorest.bicep took 12ms +info | Autorest completed in 4.85s. 2 files generated. diff --git a/generated/vmware/log.out b/generated/vmware/log.out index 25eb6351b5..bce4855ae3 100644 --- a/generated/vmware/log.out +++ b/generated/vmware/log.out @@ -42,7 +42,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.avs-2021-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -84,7 +84,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | Unrecognized property type: any-object. Returning 'any'. @@ -130,7 +130,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Trial' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/vmware.json:4599:5 @@ -362,7 +362,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Trial' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmware/resource-manager/Microsoft.AVS/preview/2021-01-01-preview/vmware.json:3686:5 @@ -511,7 +511,7 @@ warning | PreCheck/SchemaMissingType | The schema 'WorkloadNetworkDnsZone' with warning | PreCheck/SchemaMissingType | The schema 'WorkloadNetworkDnsZonesList' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmware/resource-manager/Microsoft.AVS/preview/2021-01-01-preview/vmware.json:5526:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.avs-2020-07-17-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -553,7 +553,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Trial' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmware/resource-manager/Microsoft.AVS/preview/2020-07-17-preview/vmware.json:3462:5 @@ -734,7 +734,7 @@ warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Trial' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/vmware.json:1196:5 @@ -797,4 +797,4 @@ warning | PreCheck/SchemaMissingType | The schema 'HcxEnterpriseSiteProperties' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'ClusterProperties' has a property 'provisioningState' that is already declared the parent schema 'ManagementCluster' but isn't significantly different. The property has been removed from ClusterProperties info | autorest.bicep took 3ms -info | Autorest completed in 23.68s. 10 files generated. +info | Autorest completed in 22.69s. 10 files generated. diff --git a/generated/vmware/microsoft.avs/2020-03-20/types.md b/generated/vmware/microsoft.avs/2020-03-20/types.md index 3abdf0c591..4ff52a0e60 100644 --- a/generated/vmware/microsoft.avs/2020-03-20/types.md +++ b/generated/vmware/microsoft.avs/2020-03-20/types.md @@ -45,22 +45,12 @@ * **ApiVersion**: 2020-03-20 * **Output**: [AdminCredentials](#admincredentials) -## PrivateCloudProperties +## AdminCredentials ### Properties -* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit -* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses -* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources -* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled -* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a default cluster -* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager -* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 -* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate -* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created -* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state -* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate -* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created -* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines +* **nsxtPassword**: string (ReadOnly): NSX-T Manager password +* **nsxtUsername**: string (ReadOnly): NSX-T Manager username +* **vcenterPassword**: string (ReadOnly): vCenter admin password +* **vcenterUsername**: string (ReadOnly): vCenter admin username ## Circuit ### Properties @@ -69,12 +59,30 @@ * **primarySubnet**: string (ReadOnly): CIDR of primary subnet * **secondarySubnet**: string (ReadOnly): CIDR of secondary subnet +## ClusterProperties +### Properties +* **clusterId**: int (ReadOnly): The identity +* **clusterSize**: int: The cluster size +* **hosts**: string[] (ReadOnly): The hosts +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning + ## Endpoints ### Properties * **hcxCloudManager**: string (ReadOnly): Endpoint for the HCX Cloud Manager * **nsxtManager**: string (ReadOnly): Endpoint for the NSX-T Data Center manager * **vcsa**: string (ReadOnly): Endpoint for Virtual Center Server Appliance +## ExpressRouteAuthorizationProperties +### Properties +* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization +* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## HcxEnterpriseSiteProperties +### Properties +* **activationKey**: string (ReadOnly): The activation key +* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site + ## IdentitySource ### Properties * **alias**: string: The domain's NetBIOS name @@ -95,6 +103,23 @@ * **hosts**: string[] (ReadOnly): The hosts * **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning +## PrivateCloudProperties +### Properties +* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit +* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses +* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources +* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled +* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a default cluster +* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager +* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 +* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate +* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created +* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state +* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate +* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created +* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines + ## Sku ### Properties * **name**: string (Required): The name of the SKU. @@ -104,28 +129,3 @@ ### Additional Properties * **Additional Properties Type**: string -## ExpressRouteAuthorizationProperties -### Properties -* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization -* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning - -## ClusterProperties -### Properties -* **clusterId**: int (ReadOnly): The identity -* **clusterSize**: int: The cluster size -* **hosts**: string[] (ReadOnly): The hosts -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning - -## HcxEnterpriseSiteProperties -### Properties -* **activationKey**: string (ReadOnly): The activation key -* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site - -## AdminCredentials -### Properties -* **nsxtPassword**: string (ReadOnly): NSX-T Manager password -* **nsxtUsername**: string (ReadOnly): NSX-T Manager username -* **vcenterPassword**: string (ReadOnly): vCenter admin password -* **vcenterUsername**: string (ReadOnly): vCenter admin username - diff --git a/generated/vmware/microsoft.avs/2020-07-17-preview/types.md b/generated/vmware/microsoft.avs/2020-07-17-preview/types.md index b6374b9ce6..abb4406665 100644 --- a/generated/vmware/microsoft.avs/2020-07-17-preview/types.md +++ b/generated/vmware/microsoft.avs/2020-07-17-preview/types.md @@ -117,22 +117,18 @@ * **ApiVersion**: 2020-07-17-preview * **Output**: [AdminCredentials](#admincredentials) -## PrivateCloudProperties +## AddonProperties ### Properties -* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit -* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses -* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources -* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled -* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster -* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager -* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 -* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate -* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created -* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state -* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate -* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created -* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines +* **addonType**: 'SRM' | 'VR' | string: The type of private cloud addon +* **licenseKey**: string: The SRM license +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the addon provisioning + +## AdminCredentials +### Properties +* **nsxtPassword**: string (ReadOnly): NSX-T Manager password +* **nsxtUsername**: string (ReadOnly): NSX-T Manager username +* **vcenterPassword**: string (ReadOnly): vCenter admin password +* **vcenterUsername**: string (ReadOnly): vCenter admin username ## Circuit ### Properties @@ -141,12 +137,38 @@ * **primarySubnet**: string (ReadOnly): CIDR of primary subnet * **secondarySubnet**: string (ReadOnly): CIDR of secondary subnet +## ClusterProperties +### Properties +* **clusterId**: int (ReadOnly): The identity +* **clusterSize**: int: The cluster size +* **hosts**: string[] (ReadOnly): The hosts +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning + ## Endpoints ### Properties * **hcxCloudManager**: string (ReadOnly): Endpoint for the HCX Cloud Manager * **nsxtManager**: string (ReadOnly): Endpoint for the NSX-T Data Center manager * **vcsa**: string (ReadOnly): Endpoint for Virtual Center Server Appliance +## ExpressRouteAuthorizationProperties +### Properties +* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization +* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## GlobalReachConnectionProperties +### Properties +* **addressPrefix**: string (ReadOnly): The network used for global reach carved out from the original network block provided for the private cloud +* **authorizationKey**: string: Authorization key from the peer express route used for the global reach connection +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): The connection status of the global reach connection +* **peerExpressRouteCircuit**: string: Identifier of the ExpressRoute Circuit to peer with in the global reach connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## HcxEnterpriseSiteProperties +### Properties +* **activationKey**: string (ReadOnly): The activation key +* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site + ## IdentitySource ### Properties * **alias**: string: The domain's NetBIOS name @@ -167,46 +189,31 @@ * **hosts**: string[] (ReadOnly): The hosts * **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning -## Sku +## PrivateCloudProperties ### Properties -* **name**: string (Required): The name of the SKU. +* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit +* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses +* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources +* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled +* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster +* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager +* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 +* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate +* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created +* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state +* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate +* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created +* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## AddonProperties -### Properties -* **addonType**: 'SRM' | 'VR' | string: The type of private cloud addon -* **licenseKey**: string: The SRM license -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the addon provisioning - -## ExpressRouteAuthorizationProperties -### Properties -* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization -* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning - -## ClusterProperties -### Properties -* **clusterId**: int (ReadOnly): The identity -* **clusterSize**: int: The cluster size -* **hosts**: string[] (ReadOnly): The hosts -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning - -## GlobalReachConnectionProperties -### Properties -* **addressPrefix**: string (ReadOnly): The network used for global reach carved out from the original network block provided for the private cloud -* **authorizationKey**: string: Authorization key from the peer express route used for the global reach connection -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): The connection status of the global reach connection -* **peerExpressRouteCircuit**: string: Identifier of the ExpressRoute Circuit to peer with in the global reach connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning - -## HcxEnterpriseSiteProperties +## Sku ### Properties -* **activationKey**: string (ReadOnly): The activation key -* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site +* **name**: string (Required): The name of the SKU. ## WorkloadNetworkDhcpEntity * **Discriminator**: dhcpType @@ -259,6 +266,10 @@ * **source**: string: Source VM Group. * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): Port Mirroring Status. +## WorkloadNetworkSegmentPortVif +### Properties +* **portName**: string: Name of port or VIF attached to segment. + ## WorkloadNetworkSegmentProperties ### Properties * **connectedGateway**: string: Gateway which to connect segment to. @@ -269,10 +280,6 @@ * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): Segment status. * **subnet**: [WorkloadNetworkSegmentSubnet](#workloadnetworksegmentsubnet): Subnet configuration for segment -## WorkloadNetworkSegmentPortVif -### Properties -* **portName**: string: Name of port or VIF attached to segment. - ## WorkloadNetworkSegmentSubnet ### Properties * **dhcpRanges**: string[]: DHCP Range assigned for subnet. @@ -286,10 +293,3 @@ * **revision**: int: NSX revision number. * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): VM Group status. -## AdminCredentials -### Properties -* **nsxtPassword**: string (ReadOnly): NSX-T Manager password -* **nsxtUsername**: string (ReadOnly): NSX-T Manager username -* **vcenterPassword**: string (ReadOnly): vCenter admin password -* **vcenterUsername**: string (ReadOnly): vCenter admin username - diff --git a/generated/vmware/microsoft.avs/2021-01-01-preview/types.md b/generated/vmware/microsoft.avs/2021-01-01-preview/types.md index 5c65ea5afa..dfbc696af4 100644 --- a/generated/vmware/microsoft.avs/2021-01-01-preview/types.md +++ b/generated/vmware/microsoft.avs/2021-01-01-preview/types.md @@ -126,22 +126,18 @@ * **ApiVersion**: 2021-01-01-preview * **Output**: [AdminCredentials](#admincredentials) -## PrivateCloudProperties +## AddonProperties ### Properties -* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit -* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses -* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources -* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled -* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster -* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager -* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 -* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate -* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created -* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state -* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate -* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created -* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines +* **addonType**: 'SRM' | 'VR' | string: The type of private cloud addon +* **licenseKey**: string: The SRM license +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the addon provisioning + +## AdminCredentials +### Properties +* **nsxtPassword**: string (ReadOnly): NSX-T Manager password +* **nsxtUsername**: string (ReadOnly): NSX-T Manager username +* **vcenterPassword**: string (ReadOnly): vCenter admin password +* **vcenterUsername**: string (ReadOnly): vCenter admin username ## Circuit ### Properties @@ -150,12 +146,49 @@ * **primarySubnet**: string (ReadOnly): CIDR of primary subnet * **secondarySubnet**: string (ReadOnly): CIDR of secondary subnet +## ClusterProperties +### Properties +* **clusterId**: int (ReadOnly): The identity +* **clusterSize**: int: The cluster size +* **hosts**: string[] (ReadOnly): The hosts +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning + +## DatastoreProperties +### Properties +* **diskPoolVolume**: [DiskPoolVolume](#diskpoolvolume): An iSCSI volume from Microsoft.StoragePool provider +* **netAppVolume**: [NetAppVolume](#netappvolume): An Azure NetApp Files volume from Microsoft.NetApp provider +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the datastore provisioning + +## DiskPoolVolume +### Properties +* **endpoints**: string[]: iSCSI provider target IP address list +* **lunName**: string: Name of the LUN to be used + ## Endpoints ### Properties * **hcxCloudManager**: string (ReadOnly): Endpoint for the HCX Cloud Manager * **nsxtManager**: string (ReadOnly): Endpoint for the NSX-T Data Center manager * **vcsa**: string (ReadOnly): Endpoint for Virtual Center Server Appliance +## ExpressRouteAuthorizationProperties +### Properties +* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization +* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## GlobalReachConnectionProperties +### Properties +* **addressPrefix**: string (ReadOnly): The network used for global reach carved out from the original network block provided for the private cloud +* **authorizationKey**: string: Authorization key from the peer express route used for the global reach connection +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): The connection status of the global reach connection +* **peerExpressRouteCircuit**: string: Identifier of the ExpressRoute Circuit to peer with in the global reach connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## HcxEnterpriseSiteProperties +### Properties +* **activationKey**: string (ReadOnly): The activation key +* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site + ## IdentitySource ### Properties * **alias**: string: The domain's NetBIOS name @@ -176,62 +209,36 @@ * **hosts**: string[] (ReadOnly): The hosts * **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning -## Sku -### Properties -* **name**: string (Required): The name of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AddonProperties -### Properties -* **addonType**: 'SRM' | 'VR' | string: The type of private cloud addon -* **licenseKey**: string: The SRM license -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the addon provisioning - -## ExpressRouteAuthorizationProperties -### Properties -* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization -* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning - -## ClusterProperties -### Properties -* **clusterId**: int (ReadOnly): The identity -* **clusterSize**: int: The cluster size -* **hosts**: string[] (ReadOnly): The hosts -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning - -## DatastoreProperties -### Properties -* **diskPoolVolume**: [DiskPoolVolume](#diskpoolvolume): An iSCSI volume from Microsoft.StoragePool provider -* **netAppVolume**: [NetAppVolume](#netappvolume): An Azure NetApp Files volume from Microsoft.NetApp provider -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the datastore provisioning - -## DiskPoolVolume -### Properties -* **endpoints**: string[]: iSCSI provider target IP address list -* **lunName**: string: Name of the LUN to be used - ## NetAppVolume ### Properties * **nfsFilePath**: string: File path through which the NFS volume is exposed by the provider * **nfsProviderIp**: string: IP address of the NFS provider -## GlobalReachConnectionProperties +## PrivateCloudProperties ### Properties -* **addressPrefix**: string (ReadOnly): The network used for global reach carved out from the original network block provided for the private cloud -* **authorizationKey**: string: Authorization key from the peer express route used for the global reach connection -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): The connection status of the global reach connection -* **peerExpressRouteCircuit**: string: Identifier of the ExpressRoute Circuit to peer with in the global reach connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning +* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit +* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses +* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources +* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled +* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster +* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager +* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 +* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate +* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created +* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state +* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate +* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created +* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines -## HcxEnterpriseSiteProperties +## ResourceTags ### Properties -* **activationKey**: string (ReadOnly): The activation key -* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site +### Additional Properties +* **Additional Properties Type**: string + +## Sku +### Properties +* **name**: string (Required): The name of the SKU. ## WorkloadNetworkDhcpEntity * **Discriminator**: dhcpType @@ -284,6 +291,10 @@ * **source**: string: Source VM Group. * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): Port Mirroring Status. +## WorkloadNetworkSegmentPortVif +### Properties +* **portName**: string: Name of port or VIF attached to segment. + ## WorkloadNetworkSegmentProperties ### Properties * **connectedGateway**: string: Gateway which to connect segment to. @@ -294,10 +305,6 @@ * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): Segment status. * **subnet**: [WorkloadNetworkSegmentSubnet](#workloadnetworksegmentsubnet): Subnet configuration for segment -## WorkloadNetworkSegmentPortVif -### Properties -* **portName**: string: Name of port or VIF attached to segment. - ## WorkloadNetworkSegmentSubnet ### Properties * **dhcpRanges**: string[]: DHCP Range assigned for subnet. @@ -311,10 +318,3 @@ * **revision**: int: NSX revision number. * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): VM Group status. -## AdminCredentials -### Properties -* **nsxtPassword**: string (ReadOnly): NSX-T Manager password -* **nsxtUsername**: string (ReadOnly): NSX-T Manager username -* **vcenterPassword**: string (ReadOnly): vCenter admin password -* **vcenterUsername**: string (ReadOnly): vCenter admin username - diff --git a/generated/vmware/microsoft.avs/2021-06-01/types.md b/generated/vmware/microsoft.avs/2021-06-01/types.md index 9d62ee11a1..a57073c343 100644 --- a/generated/vmware/microsoft.avs/2021-06-01/types.md +++ b/generated/vmware/microsoft.avs/2021-06-01/types.md @@ -153,66 +153,6 @@ * **ApiVersion**: 2021-06-01 * **Output**: [AdminCredentials](#admincredentials) -## PrivateCloudProperties -### Properties -* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit -* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses -* **externalCloudLinks**: string[] (ReadOnly): Array of cloud link IDs from other clouds that connect to this one -* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources -* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled -* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster -* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager -* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 -* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate -* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created -* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state -* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate -* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created -* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines - -## Circuit -### Properties -* **expressRouteID**: string (ReadOnly): Identifier of the ExpressRoute Circuit (Microsoft Colo only) -* **expressRoutePrivatePeeringID**: string (ReadOnly): ExpressRoute Circuit private peering identifier -* **primarySubnet**: string (ReadOnly): CIDR of primary subnet -* **secondarySubnet**: string (ReadOnly): CIDR of secondary subnet - -## Endpoints -### Properties -* **hcxCloudManager**: string (ReadOnly): Endpoint for the HCX Cloud Manager -* **nsxtManager**: string (ReadOnly): Endpoint for the NSX-T Data Center manager -* **vcsa**: string (ReadOnly): Endpoint for Virtual Center Server Appliance - -## IdentitySource -### Properties -* **alias**: string: The domain's NetBIOS name -* **baseGroupDN**: string: The base distinguished name for groups -* **baseUserDN**: string: The base distinguished name for users -* **domain**: string: The domain's dns name -* **name**: string: The name of the identity source -* **password**: string: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. -* **primaryServer**: string: Primary server URL -* **secondaryServer**: string: Secondary server URL -* **ssl**: 'Disabled' | 'Enabled' | string: Protect LDAP communication using SSL certificate (LDAPS) -* **username**: string: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group - -## ManagementCluster -### Properties -* **clusterId**: int (ReadOnly): The identity -* **clusterSize**: int: The cluster size -* **hosts**: string[] (ReadOnly): The hosts -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning - -## Sku -### Properties -* **name**: string (Required): The name of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## AddonProperties * **Discriminator**: addonType @@ -234,11 +174,19 @@ * **vrsCount**: int (Required): The vSphere Replication Server (VRS) count -## ExpressRouteAuthorizationProperties +## AdminCredentials ### Properties -* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization -* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning +* **nsxtPassword**: string (ReadOnly): NSX-T Manager password +* **nsxtUsername**: string (ReadOnly): NSX-T Manager username +* **vcenterPassword**: string (ReadOnly): vCenter admin password +* **vcenterUsername**: string (ReadOnly): vCenter admin username + +## Circuit +### Properties +* **expressRouteID**: string (ReadOnly): Identifier of the ExpressRoute Circuit (Microsoft Colo only) +* **expressRoutePrivatePeeringID**: string (ReadOnly): ExpressRoute Circuit private peering identifier +* **primarySubnet**: string (ReadOnly): CIDR of primary subnet +* **secondarySubnet**: string (ReadOnly): CIDR of secondary subnet ## CloudLinkProperties ### Properties @@ -265,9 +213,17 @@ * **path**: string (ReadOnly): Device path * **targetId**: string (Required): Azure resource ID of the iSCSI target -## NetAppVolume +## Endpoints ### Properties -* **id**: string (Required): Azure resource ID of the NetApp volume +* **hcxCloudManager**: string (ReadOnly): Endpoint for the HCX Cloud Manager +* **nsxtManager**: string (ReadOnly): Endpoint for the NSX-T Data Center manager +* **vcsa**: string (ReadOnly): Endpoint for Virtual Center Server Appliance + +## ExpressRouteAuthorizationProperties +### Properties +* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization +* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning ## GlobalReachConnectionProperties ### Properties @@ -282,23 +238,52 @@ * **activationKey**: string (ReadOnly): The activation key * **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site -## ScriptExecutionProperties +## IdentitySource ### Properties -* **errors**: string[] (ReadOnly): Standard error output stream from the powershell execution -* **failureReason**: string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception -* **finishedAt**: string (ReadOnly): Time the script execution was finished -* **hiddenParameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters that will be hidden/not visible to ARM, such as passwords and credentials -* **information**: string[] (ReadOnly): Standard information out stream from the powershell execution -* **namedOutputs**: [ScriptExecutionPropertiesNamedOutputs](#scriptexecutionpropertiesnamedoutputs): User-defined dictionary. -* **output**: string[]: Standard output stream from the powershell execution -* **parameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters the script will accept -* **provisioningState**: 'Cancelled' | 'Cancelling' | 'Deleting' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | string (ReadOnly): The state of the script execution resource -* **retention**: string: Time to live for the resource. If not provided, will be available for 60 days -* **scriptCmdletId**: string: A reference to the script cmdlet resource if user is running a AVS script -* **startedAt**: string (ReadOnly): Time the script execution was started -* **submittedAt**: string (ReadOnly): Time the script execution was submitted -* **timeout**: string (Required): Time limit for execution -* **warnings**: string[] (ReadOnly): Standard warning out stream from the powershell execution +* **alias**: string: The domain's NetBIOS name +* **baseGroupDN**: string: The base distinguished name for groups +* **baseUserDN**: string: The base distinguished name for users +* **domain**: string: The domain's dns name +* **name**: string: The name of the identity source +* **password**: string: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. +* **primaryServer**: string: Primary server URL +* **secondaryServer**: string: Secondary server URL +* **ssl**: 'Disabled' | 'Enabled' | string: Protect LDAP communication using SSL certificate (LDAPS) +* **username**: string: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group + +## ManagementCluster +### Properties +* **clusterId**: int (ReadOnly): The identity +* **clusterSize**: int: The cluster size +* **hosts**: string[] (ReadOnly): The hosts +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning + +## NetAppVolume +### Properties +* **id**: string (Required): Azure resource ID of the NetApp volume + +## PrivateCloudProperties +### Properties +* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit +* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses +* **externalCloudLinks**: string[] (ReadOnly): Array of cloud link IDs from other clouds that connect to this one +* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources +* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled +* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster +* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager +* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 +* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate +* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created +* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state +* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate +* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created +* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## ScriptExecutionParameter * **Discriminator**: type @@ -322,11 +307,33 @@ * **value**: string: The value for the passed parameter +## ScriptExecutionProperties +### Properties +* **errors**: string[] (ReadOnly): Standard error output stream from the powershell execution +* **failureReason**: string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception +* **finishedAt**: string (ReadOnly): Time the script execution was finished +* **hiddenParameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters that will be hidden/not visible to ARM, such as passwords and credentials +* **information**: string[] (ReadOnly): Standard information out stream from the powershell execution +* **namedOutputs**: [ScriptExecutionPropertiesNamedOutputs](#scriptexecutionpropertiesnamedoutputs): User-defined dictionary. +* **output**: string[]: Standard output stream from the powershell execution +* **parameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters the script will accept +* **provisioningState**: 'Cancelled' | 'Cancelling' | 'Deleting' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | string (ReadOnly): The state of the script execution resource +* **retention**: string: Time to live for the resource. If not provided, will be available for 60 days +* **scriptCmdletId**: string: A reference to the script cmdlet resource if user is running a AVS script +* **startedAt**: string (ReadOnly): Time the script execution was started +* **submittedAt**: string (ReadOnly): Time the script execution was submitted +* **timeout**: string (Required): Time limit for execution +* **warnings**: string[] (ReadOnly): Standard warning out stream from the powershell execution + ## ScriptExecutionPropertiesNamedOutputs ### Properties ### Additional Properties * **Additional Properties Type**: any +## Sku +### Properties +* **name**: string (Required): The name of the SKU. + ## WorkloadNetworkDhcpEntity * **Discriminator**: dhcpType @@ -385,6 +392,10 @@ * **provisioningState**: 'Building' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state * **publicIPBlock**: string (ReadOnly): CIDR Block of the Public IP Block. +## WorkloadNetworkSegmentPortVif +### Properties +* **portName**: string: Name of port or VIF attached to segment. + ## WorkloadNetworkSegmentProperties ### Properties * **connectedGateway**: string: Gateway which to connect segment to. @@ -395,10 +406,6 @@ * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): Segment status. * **subnet**: [WorkloadNetworkSegmentSubnet](#workloadnetworksegmentsubnet): Subnet configuration for segment -## WorkloadNetworkSegmentPortVif -### Properties -* **portName**: string: Name of port or VIF attached to segment. - ## WorkloadNetworkSegmentSubnet ### Properties * **dhcpRanges**: string[]: DHCP Range assigned for subnet. @@ -412,10 +419,3 @@ * **revision**: int: NSX revision number. * **status**: 'SUCCESS, FAILURE' | string (ReadOnly): VM Group status. -## AdminCredentials -### Properties -* **nsxtPassword**: string (ReadOnly): NSX-T Manager password -* **nsxtUsername**: string (ReadOnly): NSX-T Manager username -* **vcenterPassword**: string (ReadOnly): vCenter admin password -* **vcenterUsername**: string (ReadOnly): vCenter admin username - diff --git a/generated/vmware/microsoft.avs/2021-12-01/types.md b/generated/vmware/microsoft.avs/2021-12-01/types.md index 1847c6e680..a0d27b01e3 100644 --- a/generated/vmware/microsoft.avs/2021-12-01/types.md +++ b/generated/vmware/microsoft.avs/2021-12-01/types.md @@ -163,32 +163,33 @@ * **ApiVersion**: 2021-12-01 * **Output**: [AdminCredentials](#admincredentials) -## PrivateCloudIdentity -### Properties -* **principalId**: string (ReadOnly): The principal ID of private cloud identity. This property will only be provided for a system assigned identity. -* **tenantId**: string (ReadOnly): The tenant ID associated with the private cloud. This property will only be provided for a system assigned identity. -* **type**: 'None' | 'SystemAssigned' | string: The type of identity used for the private cloud. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Private Cloud. +## AddonProperties +* **Discriminator**: addonType -## PrivateCloudProperties +### Base Properties +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the addon provisioning +### AddonHcxProperties +#### Properties +* **addonType**: 'HCX' (Required): The type of private cloud addon +* **offer**: string (Required): The HCX offer, example VMware MaaS Cloud Provider (Enterprise) + +### AddonSrmProperties +#### Properties +* **addonType**: 'SRM' (Required): The type of private cloud addon +* **licenseKey**: string: The Site Recovery Manager (SRM) license + +### AddonVrProperties +#### Properties +* **addonType**: 'VR' (Required): The type of private cloud addon +* **vrsCount**: int (Required): The vSphere Replication Server (VRS) count + + +## AdminCredentials ### Properties -* **availability**: [AvailabilityProperties](#availabilityproperties): The properties describing private cloud availability zone distribution -* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit -* **encryption**: [Encryption](#encryption): The properties of customer managed encryption key -* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses -* **externalCloudLinks**: string[] (ReadOnly): Array of cloud link IDs from other clouds that connect to this one -* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources -* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled -* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster -* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager -* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 -* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate -* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created -* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state -* **secondaryCircuit**: [Circuit](#circuit): An ExpressRoute Circuit -* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate -* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created -* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines +* **nsxtPassword**: string (ReadOnly): NSX-T Manager password +* **nsxtUsername**: string (ReadOnly): NSX-T Manager username +* **vcenterPassword**: string (ReadOnly): vCenter admin password +* **vcenterUsername**: string (ReadOnly): vCenter admin username ## AvailabilityProperties ### Properties @@ -203,6 +204,32 @@ * **primarySubnet**: string (ReadOnly): CIDR of primary subnet * **secondarySubnet**: string (ReadOnly): CIDR of secondary subnet +## CloudLinkProperties +### Properties +* **linkedCloud**: string: Identifier of the other private cloud participating in the link. +* **status**: 'Active' | 'Building' | 'Deleting' | 'Disconnected' | 'Failed' | string (ReadOnly): The state of the cloud link. + +## ClusterProperties +### Properties +* **clusterId**: int (ReadOnly): The identity +* **clusterSize**: int: The cluster size +* **hosts**: string[]: The hosts +* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning + +## DatastoreProperties +### Properties +* **diskPoolVolume**: [DiskPoolVolume](#diskpoolvolume): An iSCSI volume from Microsoft.StoragePool provider +* **netAppVolume**: [NetAppVolume](#netappvolume): An Azure NetApp Files volume from Microsoft.NetApp provider +* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the datastore provisioning +* **status**: 'Accessible' | 'Attached' | 'DeadOrError' | 'Detached' | 'Inaccessible' | 'LostCommunication' | 'Unknown' | string (ReadOnly): The operational status of the datastore + +## DiskPoolVolume +### Properties +* **lunName**: string (Required): Name of the LUN to be used for datastore +* **mountOption**: 'ATTACH' | 'MOUNT' | string: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN +* **path**: string (ReadOnly): Device path +* **targetId**: string (Required): Azure resource ID of the iSCSI target + ## Encryption ### Properties * **keyVaultProperties**: [EncryptionKeyVaultProperties](#encryptionkeyvaultproperties): An Encryption Key @@ -222,6 +249,27 @@ * **nsxtManager**: string (ReadOnly): Endpoint for the NSX-T Data Center manager * **vcsa**: string (ReadOnly): Endpoint for Virtual Center Server Appliance +## ExpressRouteAuthorizationProperties +### Properties +* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization +* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization +* **expressRouteId**: string: The ID of the ExpressRoute Circuit +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## GlobalReachConnectionProperties +### Properties +* **addressPrefix**: string (ReadOnly): The network used for global reach carved out from the original network block provided for the private cloud +* **authorizationKey**: string: Authorization key from the peer express route used for the global reach connection +* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): The connection status of the global reach connection +* **expressRouteId**: string: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection +* **peerExpressRouteCircuit**: string: Identifier of the ExpressRoute Circuit to peer with in the global reach connection +* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning + +## HcxEnterpriseSiteProperties +### Properties +* **activationKey**: string (ReadOnly): The activation key +* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site + ## IdentitySource ### Properties * **alias**: string: The domain's NetBIOS name @@ -242,69 +290,6 @@ * **hosts**: string[]: The hosts * **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning -## Sku -### Properties -* **name**: string (Required): The name of the SKU. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AddonProperties -* **Discriminator**: addonType - -### Base Properties -* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the addon provisioning -### AddonHcxProperties -#### Properties -* **addonType**: 'HCX' (Required): The type of private cloud addon -* **offer**: string (Required): The HCX offer, example VMware MaaS Cloud Provider (Enterprise) - -### AddonSrmProperties -#### Properties -* **addonType**: 'SRM' (Required): The type of private cloud addon -* **licenseKey**: string: The Site Recovery Manager (SRM) license - -### AddonVrProperties -#### Properties -* **addonType**: 'VR' (Required): The type of private cloud addon -* **vrsCount**: int (Required): The vSphere Replication Server (VRS) count - - -## ExpressRouteAuthorizationProperties -### Properties -* **expressRouteAuthorizationId**: string (ReadOnly): The ID of the ExpressRoute Circuit Authorization -* **expressRouteAuthorizationKey**: string (ReadOnly): The key of the ExpressRoute Circuit Authorization -* **expressRouteId**: string: The ID of the ExpressRoute Circuit -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning - -## CloudLinkProperties -### Properties -* **linkedCloud**: string: Identifier of the other private cloud participating in the link. -* **status**: 'Active' | 'Building' | 'Deleting' | 'Disconnected' | 'Failed' | string (ReadOnly): The state of the cloud link. - -## ClusterProperties -### Properties -* **clusterId**: int (ReadOnly): The identity -* **clusterSize**: int: The cluster size -* **hosts**: string[]: The hosts -* **provisioningState**: 'Cancelled' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the cluster provisioning - -## DatastoreProperties -### Properties -* **diskPoolVolume**: [DiskPoolVolume](#diskpoolvolume): An iSCSI volume from Microsoft.StoragePool provider -* **netAppVolume**: [NetAppVolume](#netappvolume): An Azure NetApp Files volume from Microsoft.NetApp provider -* **provisioningState**: 'Cancelled' | 'Creating' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the datastore provisioning -* **status**: 'Accessible' | 'Attached' | 'DeadOrError' | 'Detached' | 'Inaccessible' | 'LostCommunication' | 'Unknown' | string (ReadOnly): The operational status of the datastore - -## DiskPoolVolume -### Properties -* **lunName**: string (Required): Name of the LUN to be used for datastore -* **mountOption**: 'ATTACH' | 'MOUNT' | string: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN -* **path**: string (ReadOnly): Device path -* **targetId**: string (Required): Azure resource ID of the iSCSI target - ## NetAppVolume ### Properties * **id**: string (Required): Azure resource ID of the NetApp volume @@ -330,37 +315,37 @@ * **vmMembers**: string[] (Required): Virtual machine members list -## GlobalReachConnectionProperties +## PrivateCloudIdentity ### Properties -* **addressPrefix**: string (ReadOnly): The network used for global reach carved out from the original network block provided for the private cloud -* **authorizationKey**: string: Authorization key from the peer express route used for the global reach connection -* **circuitConnectionStatus**: 'Connected' | 'Connecting' | 'Disconnected' | string (ReadOnly): The connection status of the global reach connection -* **expressRouteId**: string: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection -* **peerExpressRouteCircuit**: string: Identifier of the ExpressRoute Circuit to peer with in the global reach connection -* **provisioningState**: 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The state of the ExpressRoute Circuit Authorization provisioning +* **principalId**: string (ReadOnly): The principal ID of private cloud identity. This property will only be provided for a system assigned identity. +* **tenantId**: string (ReadOnly): The tenant ID associated with the private cloud. This property will only be provided for a system assigned identity. +* **type**: 'None' | 'SystemAssigned' | string: The type of identity used for the private cloud. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Private Cloud. -## HcxEnterpriseSiteProperties +## PrivateCloudProperties ### Properties -* **activationKey**: string (ReadOnly): The activation key -* **status**: 'Available' | 'Consumed' | 'Deactivated' | 'Deleted' | string (ReadOnly): The status of the HCX Enterprise Site +* **availability**: [AvailabilityProperties](#availabilityproperties): The properties describing private cloud availability zone distribution +* **circuit**: [Circuit](#circuit): An ExpressRoute Circuit +* **encryption**: [Encryption](#encryption): The properties of customer managed encryption key +* **endpoints**: [Endpoints](#endpoints) (ReadOnly): Endpoint addresses +* **externalCloudLinks**: string[] (ReadOnly): Array of cloud link IDs from other clouds that connect to this one +* **identitySources**: [IdentitySource](#identitysource)[]: vCenter Single Sign On Identity Sources +* **internet**: 'Disabled' | 'Enabled' | string: Connectivity to internet is enabled or disabled +* **managementCluster**: [ManagementCluster](#managementcluster): The properties of a management cluster +* **managementNetwork**: string (ReadOnly): Network used to access vCenter Server and NSX-T Manager +* **networkBlock**: string (Required): The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 +* **nsxtCertificateThumbprint**: string (ReadOnly): Thumbprint of the NSX-T Manager SSL certificate +* **nsxtPassword**: string: Optionally, set the NSX-T Manager password when the private cloud is created +* **provisioningNetwork**: string (ReadOnly): Used for virtual machine cold migration, cloning, and snapshot migration +* **provisioningState**: 'Building' | 'Cancelled' | 'Deleting' | 'Failed' | 'Pending' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state +* **secondaryCircuit**: [Circuit](#circuit): An ExpressRoute Circuit +* **vcenterCertificateThumbprint**: string (ReadOnly): Thumbprint of the vCenter Server SSL certificate +* **vcenterPassword**: string: Optionally, set the vCenter admin password when the private cloud is created +* **vmotionNetwork**: string (ReadOnly): Used for live migration of virtual machines -## ScriptExecutionProperties +## ResourceTags ### Properties -* **errors**: string[] (ReadOnly): Standard error output stream from the powershell execution -* **failureReason**: string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception -* **finishedAt**: string (ReadOnly): Time the script execution was finished -* **hiddenParameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters that will be hidden/not visible to ARM, such as passwords and credentials -* **information**: string[] (ReadOnly): Standard information out stream from the powershell execution -* **namedOutputs**: [ScriptExecutionPropertiesNamedOutputs](#scriptexecutionpropertiesnamedoutputs): User-defined dictionary. -* **output**: string[]: Standard output stream from the powershell execution -* **parameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters the script will accept -* **provisioningState**: 'Cancelled' | 'Cancelling' | 'Deleting' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | string (ReadOnly): The state of the script execution resource -* **retention**: string: Time to live for the resource. If not provided, will be available for 60 days -* **scriptCmdletId**: string: A reference to the script cmdlet resource if user is running a AVS script -* **startedAt**: string (ReadOnly): Time the script execution was started -* **submittedAt**: string (ReadOnly): Time the script execution was submitted -* **timeout**: string (Required): Time limit for execution -* **warnings**: string[] (ReadOnly): Standard warning out stream from the powershell execution +### Additional Properties +* **Additional Properties Type**: string ## ScriptExecutionParameter * **Discriminator**: type @@ -384,11 +369,33 @@ * **value**: string: The value for the passed parameter +## ScriptExecutionProperties +### Properties +* **errors**: string[] (ReadOnly): Standard error output stream from the powershell execution +* **failureReason**: string: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception +* **finishedAt**: string (ReadOnly): Time the script execution was finished +* **hiddenParameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters that will be hidden/not visible to ARM, such as passwords and credentials +* **information**: string[] (ReadOnly): Standard information out stream from the powershell execution +* **namedOutputs**: [ScriptExecutionPropertiesNamedOutputs](#scriptexecutionpropertiesnamedoutputs): User-defined dictionary. +* **output**: string[]: Standard output stream from the powershell execution +* **parameters**: [ScriptExecutionParameter](#scriptexecutionparameter)[]: Parameters the script will accept +* **provisioningState**: 'Cancelled' | 'Cancelling' | 'Deleting' | 'Failed' | 'Pending' | 'Running' | 'Succeeded' | string (ReadOnly): The state of the script execution resource +* **retention**: string: Time to live for the resource. If not provided, will be available for 60 days +* **scriptCmdletId**: string: A reference to the script cmdlet resource if user is running a AVS script +* **startedAt**: string (ReadOnly): Time the script execution was started +* **submittedAt**: string (ReadOnly): Time the script execution was submitted +* **timeout**: string (Required): Time limit for execution +* **warnings**: string[] (ReadOnly): Standard warning out stream from the powershell execution + ## ScriptExecutionPropertiesNamedOutputs ### Properties ### Additional Properties * **Additional Properties Type**: any +## Sku +### Properties +* **name**: string (Required): The name of the SKU. + ## WorkloadNetworkDhcpEntity * **Discriminator**: dhcpType @@ -447,6 +454,10 @@ * **provisioningState**: 'Building' | 'Deleting' | 'Failed' | 'Succeeded' | 'Updating' | string (ReadOnly): The provisioning state * **publicIPBlock**: string (ReadOnly): CIDR Block of the Public IP Block. +## WorkloadNetworkSegmentPortVif +### Properties +* **portName**: string: Name of port or VIF attached to segment. + ## WorkloadNetworkSegmentProperties ### Properties * **connectedGateway**: string: Gateway which to connect segment to. @@ -457,10 +468,6 @@ * **status**: 'FAILURE' | 'SUCCESS' | string (ReadOnly): Segment status. * **subnet**: [WorkloadNetworkSegmentSubnet](#workloadnetworksegmentsubnet): Subnet configuration for segment -## WorkloadNetworkSegmentPortVif -### Properties -* **portName**: string: Name of port or VIF attached to segment. - ## WorkloadNetworkSegmentSubnet ### Properties * **dhcpRanges**: string[]: DHCP Range assigned for subnet. @@ -474,10 +481,3 @@ * **revision**: int: NSX revision number. * **status**: 'FAILURE' | 'SUCCESS' | string (ReadOnly): VM Group status. -## AdminCredentials -### Properties -* **nsxtPassword**: string (ReadOnly): NSX-T Manager password -* **nsxtUsername**: string (ReadOnly): NSX-T Manager username -* **vcenterPassword**: string (ReadOnly): vCenter admin password -* **vcenterUsername**: string (ReadOnly): vCenter admin username - diff --git a/generated/vmwarecloudsimple/log.out b/generated/vmwarecloudsimple/log.out index f2f7cc43bd..7b59a6b7f1 100644 --- a/generated/vmwarecloudsimple/log.out +++ b/generated/vmwarecloudsimple/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.vmwarecloudsimple-2019-04-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AvailableOperation' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmwarecloudsimple/resource-manager/Microsoft.VMwareCloudSimple/stable/2019-04-01/vmwarecloudsimple.json:2095:5 @@ -101,5 +101,5 @@ warning | PreCheck/SchemaMissingType | The schema 'VirtualNetworkProperties' wit warning | PreCheck/SchemaMissingType | The schema 'VirtualNic' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/vmwarecloudsimple/resource-manager/Microsoft.VMwareCloudSimple/stable/2019-04-01/vmwarecloudsimple.json:3757:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 18ms -info | Autorest completed in 6.54s. 2 files generated. +info | autorest.bicep took 16ms +info | Autorest completed in 6.27s. 2 files generated. diff --git a/generated/vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.md b/generated/vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.md index 3b19d2137b..06b1a18c11 100644 --- a/generated/vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.md +++ b/generated/vmwarecloudsimple/microsoft.vmwarecloudsimple/2019-04-01/types.md @@ -51,10 +51,43 @@ * **status**: 'unused' | 'used' (ReadOnly): Node status, indicates is private cloud set up on this node or not * **vmwareClusterName**: string (ReadOnly): VMWare Cluster Name -## SkuDescription +## DedicatedCloudServiceProperties ### Properties -* **id**: string (Required): SKU's id -* **name**: string (Required): SKU's name +* **gatewaySubnet**: string (Required): gateway Subnet for the account. It will collect the subnet address and always treat it as /28 +* **isAccountOnboarded**: 'notOnBoarded' | 'onBoarded' | 'onBoarding' | 'onBoardingFailed' (ReadOnly): indicates whether account onboarded or not in a given region +* **nodes**: int (ReadOnly): total nodes purchased +* **serviceURL**: string (ReadOnly): link to a service management web portal + +## GuestOSCustomization +### Properties +* **dnsServers**: string[]: List of dns servers to use +* **hostName**: string: Virtual Machine hostname +* **password**: string: Password for login +* **policyId**: string: id of customization policy +* **username**: string: Username for login + +## GuestOsnicCustomization +### Properties +* **allocation**: 'dynamic' | 'static' | string: IP address allocation method +* **dnsServers**: string[]: List of dns servers to use +* **gateway**: string[]: Gateway addresses assigned to nic +* **ipAddress**: string +* **mask**: string +* **primaryWinsServer**: string +* **secondaryWinsServer**: string + +## ResourcePool +### Properties +* **id**: string (Required): resource pool id (privateCloudId:vsphereId) +* **location**: string (ReadOnly): Azure region +* **name**: string (ReadOnly): {ResourcePoolName} +* **privateCloudId**: string (ReadOnly): The Private Cloud Id +* **properties**: [ResourcePoolProperties](#resourcepoolproperties): Properties of resource pool +* **type**: string (ReadOnly): {resourceProviderNamespace}/{resourceType} + +## ResourcePoolProperties +### Properties +* **fullName**: string (ReadOnly): Hierarchical resource pool name ## Sku ### Properties @@ -64,23 +97,41 @@ * **name**: string (Required): The name of the SKU for VMWare CloudSimple Node * **tier**: string: The tier of the SKU +## SkuDescription +### Properties +* **id**: string (Required): SKU's id +* **name**: string (Required): SKU's name + ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DedicatedCloudServiceProperties +## Tags ### Properties -* **gatewaySubnet**: string (Required): gateway Subnet for the account. It will collect the subnet address and always treat it as /28 -* **isAccountOnboarded**: 'notOnBoarded' | 'onBoarded' | 'onBoarding' | 'onBoardingFailed' (ReadOnly): indicates whether account onboarded or not in a given region -* **nodes**: int (ReadOnly): total nodes purchased -* **serviceURL**: string (ReadOnly): link to a service management web portal +### Additional Properties +* **Additional Properties Type**: string ## Tags ### Properties ### Additional Properties * **Additional Properties Type**: string +## VirtualDisk +### Properties +* **controllerId**: string (Required): Disk's Controller id +* **independenceMode**: 'independent_nonpersistent' | 'independent_persistent' | 'persistent' (Required): Disk's independence mode type +* **totalSize**: int (Required): Disk's total size +* **virtualDiskId**: string: Disk's id +* **virtualDiskName**: string (ReadOnly): Disk's display name + +## VirtualDiskController +### Properties +* **id**: string (ReadOnly): Controller's id +* **name**: string (ReadOnly): The display name of Controller +* **subType**: string (ReadOnly): dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) +* **type**: string (ReadOnly): disk controller type (SCSI) + ## VirtualMachineProperties ### Properties * **amountOfRam**: int (Required): The amount of memory @@ -106,50 +157,6 @@ * **vmwaretools**: string (ReadOnly): VMware tools version * **vSphereNetworks**: string[]: The list of Virtual VSphere Networks -## VirtualDiskController -### Properties -* **id**: string (ReadOnly): Controller's id -* **name**: string (ReadOnly): The display name of Controller -* **subType**: string (ReadOnly): dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) -* **type**: string (ReadOnly): disk controller type (SCSI) - -## GuestOSCustomization -### Properties -* **dnsServers**: string[]: List of dns servers to use -* **hostName**: string: Virtual Machine hostname -* **password**: string: Password for login -* **policyId**: string: id of customization policy -* **username**: string: Username for login - -## VirtualDisk -### Properties -* **controllerId**: string (Required): Disk's Controller id -* **independenceMode**: 'independent_nonpersistent' | 'independent_persistent' | 'persistent' (Required): Disk's independence mode type -* **totalSize**: int (Required): Disk's total size -* **virtualDiskId**: string: Disk's id -* **virtualDiskName**: string (ReadOnly): Disk's display name - -## VirtualNic -### Properties -* **customization**: [GuestOsnicCustomization](#guestosniccustomization): Guest OS nic customization -* **ipAddresses**: string[]: NIC ip address -* **macAddress**: string: NIC MAC address -* **network**: [VirtualNetwork](#virtualnetwork) (Required): Virtual network model -* **nicType**: 'E1000' | 'E1000E' | 'PCNET32' | 'VMXNET' | 'VMXNET2' | 'VMXNET3' (Required): NIC type -* **powerOnBoot**: bool: Is NIC powered on/off on boot -* **virtualNicId**: string: NIC id -* **virtualNicName**: string (ReadOnly): NIC name - -## GuestOsnicCustomization -### Properties -* **allocation**: 'dynamic' | 'static' | string: IP address allocation method -* **dnsServers**: string[]: List of dns servers to use -* **gateway**: string[]: Gateway addresses assigned to nic -* **ipAddress**: string -* **mask**: string -* **primaryWinsServer**: string -* **secondaryWinsServer**: string - ## VirtualNetwork ### Properties * **assignable**: bool (ReadOnly): can be used in vm creation/deletion @@ -163,21 +170,14 @@ ### Properties * **privateCloudId**: string (ReadOnly): The Private Cloud id -## ResourcePool -### Properties -* **id**: string (Required): resource pool id (privateCloudId:vsphereId) -* **location**: string (ReadOnly): Azure region -* **name**: string (ReadOnly): {ResourcePoolName} -* **privateCloudId**: string (ReadOnly): The Private Cloud Id -* **properties**: [ResourcePoolProperties](#resourcepoolproperties): Properties of resource pool -* **type**: string (ReadOnly): {resourceProviderNamespace}/{resourceType} - -## ResourcePoolProperties -### Properties -* **fullName**: string (ReadOnly): Hierarchical resource pool name - -## Tags +## VirtualNic ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **customization**: [GuestOsnicCustomization](#guestosniccustomization): Guest OS nic customization +* **ipAddresses**: string[]: NIC ip address +* **macAddress**: string: NIC MAC address +* **network**: [VirtualNetwork](#virtualnetwork) (Required): Virtual network model +* **nicType**: 'E1000' | 'E1000E' | 'PCNET32' | 'VMXNET' | 'VMXNET2' | 'VMXNET3' (Required): NIC type +* **powerOnBoot**: bool: Is NIC powered on/off on boot +* **virtualNicId**: string: NIC id +* **virtualNicName**: string (ReadOnly): NIC name diff --git a/generated/web/log.out b/generated/web/log.out index b9aa78d04d..3e31aca883 100644 --- a/generated/web/log.out +++ b/generated/web/log.out @@ -1,9 +1,7 @@ -SourceMapConsumer.initialize is a no-op when running in node.js -AutoRest code generation utility [cli version: 3.5.1; node: v16.14.0] +AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] (C) 2018 Microsoft Corporation. https://aka.ms/autorest -SourceMapConsumer.initialize is a no-op when running in node.js -info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.7.6) +info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future. @@ -362,7 +360,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.certificateregistration-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -722,13 +720,10 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 15ms +info | autorest.bicep took 12ms info | Processing batch task - {"tag":"microsoft.domainregistration-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1088,15 +1083,12 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/transferOut': Found mismatch between type segments (2) and name segments (1) warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments -info | autorest.bicep took 8ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.web-2021-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1456,7 +1448,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/BinarySchema | 'The schema paths·15r2hnv·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-containerlogs·post·responses·200·content·application-octet_stream·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/WebApps.json:2567:11 @@ -1479,22 +1471,6 @@ warning | PreCheck/BinarySchema | 'The schema paths·43fep2·subscriptions-subsc warning | PreCheck/BinarySchema | 'The schema paths·tix4l6·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-slots-slot-publishxml·post·responses·200·content·application-xml·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/WebApps.json:17385:11 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -1506,7 +1482,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. -info | autorest.bicep took 61ms +info | autorest.bicep took 76ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2021-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -1866,13 +1842,10 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.domainregistration-2021-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -2232,12 +2205,9 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.web-2021-02-01"} . @@ -2599,7 +2569,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/BinarySchema | 'The schema paths·15r2hnv·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-containerlogs·post·responses·200·content·application-octet_stream·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-02-01/WebApps.json:2527:11 @@ -2622,20 +2592,6 @@ warning | PreCheck/BinarySchema | 'The schema paths·43fep2·subscriptions-subsc warning | PreCheck/BinarySchema | 'The schema paths·tix4l6·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-slots-slot-publishxml·post·responses·200·content·application-xml·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-02-01/WebApps.json:17217:11 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -2646,7 +2602,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. -info | autorest.bicep took 42ms +info | autorest.bicep took 64ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2021-01-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3006,13 +2962,10 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.domainregistration-2021-01-15"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -3372,12 +3325,9 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.web-2021-01-15"} . @@ -3739,7 +3689,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/BinarySchema | 'The schema paths·15r2hnv·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-containerlogs·post·responses·200·content·application-octet_stream·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-01-15/WebApps.json:2527:11 @@ -3762,20 +3712,6 @@ warning | PreCheck/BinarySchema | 'The schema paths·43fep2·subscriptions-subsc warning | PreCheck/BinarySchema | 'The schema paths·tix4l6·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-slots-slot-publishxml·post·responses·200·content·application-xml·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-01-15/WebApps.json:17217:11 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -3786,7 +3722,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. -info | autorest.bicep took 40ms +info | autorest.bicep took 62ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4146,7 +4082,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2021-01-01/AppServiceCertificateOrders.json:1019:9 @@ -4165,9 +4101,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DetectorResponse-properties' warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.domainregistration-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -4528,7 +4461,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-01-01/Domains.json:808:9 @@ -4542,11 +4475,8 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.web-2021-01-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -4906,7 +4836,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AddressResponse-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-01-01/AppServiceEnvironments.json:2157:9 @@ -5129,20 +5059,6 @@ warning | PreCheck/SchemaMissingType | The schema 'KubeEnvironment-properties' w warning | PreCheck/SchemaMissingType | The schema 'KubeEnvironmentPatchResource-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2021-01-01/KubeEnvironments.json:518:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -5153,7 +5069,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. -info | autorest.bicep took 58ms +info | autorest.bicep took 65ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -5513,7 +5429,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-12-01/AppServiceCertificateOrders.json:1019:9 @@ -5532,9 +5448,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DetectorResponse-properties' warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.domainregistration-2020-12-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -5895,7 +5808,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-12-01/Domains.json:808:9 @@ -5909,9 +5822,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.web-2020-12-01"} . @@ -6273,7 +6183,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-12-01/Certificates.json:319:9 @@ -6492,19 +6402,6 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionLimits-proper warning | PreCheck/SchemaMissingType | The schema 'ResourceHealthMetadata-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-12-01/ResourceHealthMetadata.json:320:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -6515,7 +6412,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. -info | autorest.bicep took 42ms +info | autorest.bicep took 59ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -6875,7 +6772,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/AppServiceCertificateOrders.json:1019:9 @@ -6893,8 +6790,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.domainregistration-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -7255,7 +7150,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/Domains.json:808:9 @@ -7269,11 +7164,8 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.web-2020-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -7633,7 +7525,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Certificates.json:312:9 @@ -7902,18 +7794,6 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionLimits-proper warning | PreCheck/SchemaMissingType | The schema 'ResourceHealthMetadata-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceHealthMetadata.json:320:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -7925,7 +7805,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/staticsites/customdomains under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}' has no body defined. -info | autorest.bicep took 70ms +info | autorest.bicep took 57ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2020-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -8285,7 +8165,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-09-01/AppServiceCertificateOrders.json:1019:9 @@ -8303,8 +8183,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.domainregistration-2020-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -8665,7 +8543,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-09-01/Domains.json:808:9 @@ -8679,11 +8557,8 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments -info | autorest.bicep took 4ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.web-2020-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -9043,7 +8918,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-09-01/Certificates.json:312:9 @@ -9308,18 +9183,6 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionLimits-proper warning | PreCheck/SchemaMissingType | The schema 'ResourceHealthMetadata-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-09-01/ResourceHealthMetadata.json:320:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -9331,7 +9194,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/staticsites/customdomains under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}' has no body defined. -info | autorest.bicep took 58ms +info | autorest.bicep took 46ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -9691,7 +9554,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-06-01/AppServiceCertificateOrders.json:1019:9 @@ -9709,8 +9572,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.domainregistration-2020-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -10071,7 +9932,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-06-01/Domains.json:808:9 @@ -10085,9 +9946,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.web-2020-06-01"} . @@ -10449,7 +10307,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-06-01/Certificates.json:312:9 @@ -10714,18 +10572,6 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionLimits-proper warning | PreCheck/SchemaMissingType | The schema 'ResourceHealthMetadata-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2020-06-01/ResourceHealthMetadata.json:320:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -10737,7 +10583,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/staticsites/customdomains under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}' has no body defined. -info | autorest.bicep took 49ms +info | autorest.bicep took 40ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -11097,7 +10943,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json:1019:9 @@ -11115,9 +10961,7 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 2ms +info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.domainregistration-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -11477,7 +11321,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2019-08-01/Domains.json:808:9 @@ -11491,11 +11335,8 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.web-2019-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -11855,7 +11696,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/Certificates.json:312:9 @@ -12056,18 +11897,6 @@ warning | PreCheck/SchemaMissingType | The schema 'HybridConnectionLimits-proper warning | PreCheck/SchemaMissingType | The schema 'ResourceHealthMetadata-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/ResourceHealthMetadata.json:320:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -12079,7 +11908,7 @@ warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/staticsites/customdomains under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}' has no body defined. -info | autorest.bicep took 38ms +info | autorest.bicep took 34ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -12439,7 +12268,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json:971:9 @@ -12457,9 +12286,7 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 2ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.domainregistration-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -12819,7 +12646,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/Domains.json:791:9 @@ -12833,9 +12660,6 @@ warning | PreCheck/SchemaMissingType | The schema 'DefaultErrorResponse-error-de warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.web-2018-11-01"} . @@ -13197,7 +13021,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2018-11-01/Certificates.json:306:9 @@ -13318,8 +13142,6 @@ warning | PreCheck/SchemaMissingType | The schema 'VnetGateway-properties' with warning | PreCheck/SchemaMissingType | The schema 'VnetInfo-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'VnetRoute-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. @@ -13327,7 +13149,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. -info | autorest.bicep took 22ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.web-2018-02-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -13687,7 +13509,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServicePlan-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json:277:9 @@ -13866,17 +13688,6 @@ warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with warning | PreCheck/SchemaMissingType | The schema 'CertificatePatchResource-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json:463:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}': Parameter reference {keyType} is not defined as an enum @@ -13887,7 +13698,7 @@ info | Resource type microsoft.web/sites/siteextensions under path '/subscrip info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 41ms +info | autorest.bicep took 42ms info | Processing batch task - {"tag":"microsoft.certificateregistration-2015-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -14247,7 +14058,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'AppServiceCertificateOrder-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json:899:9 @@ -14264,8 +14075,6 @@ warning | PreCheck/SchemaMissingType | The schema 'RenewCertificateOrderRequest- warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous info | autorest.bicep took 1ms info | Processing batch task - {"tag":"microsoft.domainregistration-2015-04-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. @@ -14626,7 +14435,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Domain-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/Domains.json:724:9 @@ -14641,11 +14450,8 @@ warning | PreCheck/SchemaMissingType | The schema 'TopLevelDomain-properties' wi warning | PreCheck/SchemaMissingType | The schema 'ProxyOnlyResource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments -info | autorest.bicep took 3ms +info | autorest.bicep took 2ms info | Processing batch task - {"tag":"microsoft.web-2016-03-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -15005,7 +14811,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Certificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Certificates.json:276:9 @@ -15074,18 +14880,10 @@ warning | PreCheck/SchemaMissingType | The schema 'VnetValidationFailureDetails- warning | PreCheck/SchemaMissingType | The schema 'VnetValidationTestFailure-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json:1117:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName': Unable to find type segments warning | Unrecognized property type: byte-array. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 2ms +info | autorest.bicep took 3ms info | Processing batch task - {"tag":"microsoft.web-2016-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -15445,7 +15243,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'BackupItem-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json:14924:9 @@ -15555,14 +15353,13 @@ warning | PreCheck/SchemaMissingType | The schema 'VnetGateway-properties' with warning | PreCheck/SchemaMissingType | The schema 'VnetInfo-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'VnetRoute-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate': Found mismatch between type segments (2) and name segments (1) warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: byte-array. Returning 'any'. info | Resource type microsoft.web/sites/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}' has no body defined. info | Resource type microsoft.web/sites/slots/siteextensions under path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}' has no body defined. warning | Unrecognized property type: byte-array. Returning 'any'. -info | autorest.bicep took 22ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.web-2016-09-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -15922,7 +15719,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'MetricDefinition-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json:1956:9 @@ -15945,9 +15742,7 @@ warning | PreCheck/SchemaMissingType | The schema 'VnetGateway-properties' with warning | PreCheck/SchemaMissingType | The schema 'VnetInfo-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/SchemaMissingType | The schema 'VnetRoute-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous -info | autorest.bicep took 4ms +info | autorest.bicep took 6ms info | Processing batch task - {"tag":"microsoft.web-2016-06-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16307,7 +16102,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ConnectionGatewayDefinition-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json:1243:9 @@ -16321,7 +16116,6 @@ warning | PreCheck/SchemaMissingType | The schema 'ConnectionError-properties' w - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json:2085:9 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. warning | PreCheck/PropertyRedeclarationWarning | Schema 'CustomApiReference' has a property 'name' that is already declared the parent schema 'ApiReference' but isn't significantly different. The property has been removed from CustomApiReference -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Modeler/MissingType | The schema 'paths·i5xihg·subscriptions-subscriptionid-providers-microsoft-web-locations-location-extractapidefinitionfromwsdl·post·responses·200·content·application-json·schema' has no type or format information whatsoever. Location: file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json#/components/schemas/paths·i5xihg·subscriptions-subscriptionid-providers-microsoft-web-locations-location-extractapidefinitionfromwsdl·post·responses·200·content·application-json·schema warning | Unrecognized property type: any-object. Returning 'any'. @@ -16330,7 +16124,7 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 5ms +info | autorest.bicep took 4ms info | Processing batch task - {"tag":"microsoft.web-2015-08-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -16690,7 +16484,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'CertificateOrderCertificate-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json:16555:9 @@ -16793,7 +16587,6 @@ warning | PreCheck/BinarySchema | 'The schema paths·tix4l6·subscriptions-subsc warning | PreCheck/BinarySchema | 'The schema paths·rxd8d5·subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsoft-web-sites-name-slots-slot-publishxml·post·responses·200·content·text-xml·schema with 'type: file', format: undefined' will be treated as a binary blob for binary media types. - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json:14649:11 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | PreNamer/DeduplicateName | Deduplicating schema name: 'SiteProperties' -> 'SitePropertiesAutoGenerated' warning | Skipping path '/subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials': Found mismatch between type segments (1) and name segments (0) warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots': Found mismatch between type segments (2) and name segments (1) @@ -16801,7 +16594,7 @@ warning | Skipping path '/subscriptions/{subscriptionId}/resourceGroups/{resourc warning | Skipping resource POST action path '/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations': Unable to find type segments warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 39ms +info | autorest.bicep took 26ms info | Processing batch task - {"tag":"microsoft.web-2015-08-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -17161,7 +16954,7 @@ warning | DeprecatedConfig | Using directive.24.suppress which is deprecated and warning | DeprecatedConfig | Using directive.25.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.26.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.22.3) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ApiEntity-properties' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json:456:9 @@ -17192,7 +16985,6 @@ warning | PreCheck/SchemaMissingType | The schema 'ConfirmConsentCodeInput-prope warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json:1233:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -warning | UnkownSecurityScheme | Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,AzureKey,Anonymous warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. @@ -17204,5 +16996,5 @@ warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. warning | Unrecognized property type: any-object. Returning 'any'. -info | autorest.bicep took 6ms -info | Generation Complete +info | autorest.bicep took 4ms +info | Autorest completed in 407.5s. 82 files generated. diff --git a/generated/web/microsoft.certificateregistration/2015-08-01/types.md b/generated/web/microsoft.certificateregistration/2015-08-01/types.md index 367042f929..eb6d78cdd1 100644 --- a/generated/web/microsoft.certificateregistration/2015-08-01/types.md +++ b/generated/web/microsoft.certificateregistration/2015-08-01/types.md @@ -24,6 +24,44 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## CertificateDetails +### Properties +* **id**: string: Resource Id +* **kind**: string: Kind of resource +* **location**: string (Required): Resource Location +* **name**: string: Resource Name +* **properties**: [CertificateDetailsProperties](#certificatedetailsproperties) +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string: Resource type + +## CertificateDetailsProperties +### Properties +* **issuer**: string: Issuer +* **notAfter**: string: Valid to +* **notBefore**: string: Valid from +* **rawData**: string: Raw certificate data +* **serialNumber**: string: Serial Number +* **signatureAlgorithm**: string: Signature Algorithm +* **subject**: string: Subject +* **thumbprint**: string: Thumbprint +* **version**: int: Version + +## CertificateOrderCertificate +### Properties +* **id**: string: Resource Id +* **kind**: string: Kind of resource +* **location**: string (Required): Resource Location +* **name**: string: Resource Name +* **properties**: [CertificateOrderCertificateProperties](#certificateordercertificateproperties) +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string: Resource type + +## CertificateOrderCertificateProperties +### Properties +* **keyVaultId**: string: Key Vault Csm resource Id +* **keyVaultSecretName**: string: Key Vault secret name +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder': Status of the Key Vault secret + ## CertificateOrderProperties ### Properties * **autoRenew**: bool: Auto renew @@ -48,49 +86,11 @@ ### Additional Properties * **Additional Properties Type**: [CertificateOrderCertificate](#certificateordercertificate) -## CertificateOrderCertificate -### Properties -* **id**: string: Resource Id -* **kind**: string: Kind of resource -* **location**: string (Required): Resource Location -* **name**: string: Resource Name -* **properties**: [CertificateOrderCertificateProperties](#certificateordercertificateproperties) -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string: Resource type - -## CertificateOrderCertificateProperties -### Properties -* **keyVaultId**: string: Key Vault Csm resource Id -* **keyVaultSecretName**: string: Key Vault secret name -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder': Status of the Key Vault secret - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## CertificateDetails -### Properties -* **id**: string: Resource Id -* **kind**: string: Kind of resource -* **location**: string (Required): Resource Location -* **name**: string: Resource Name -* **properties**: [CertificateDetailsProperties](#certificatedetailsproperties) -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string: Resource type - -## CertificateDetailsProperties -### Properties -* **issuer**: string: Issuer -* **notAfter**: string: Valid to -* **notBefore**: string: Valid from -* **rawData**: string: Raw certificate data -* **serialNumber**: string: Serial Number -* **signatureAlgorithm**: string: Signature Algorithm -* **subject**: string: Subject -* **thumbprint**: string: Thumbprint -* **version**: int: Version - ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/web/microsoft.certificateregistration/2018-02-01/types.json b/generated/web/microsoft.certificateregistration/2018-02-01/types.json index bcb3a37635..0f5a26a3a3 100644 --- a/generated/web/microsoft.certificateregistration/2018-02-01/types.json +++ b/generated/web/microsoft.certificateregistration/2018-02-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2018-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":54,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":55,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":57,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2018-02-01","ScopeType":8,"Body":56}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2018-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":54,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":55,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":57,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2018-02-01","ScopeType":8,"Body":56}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2018-02-01/types.md b/generated/web/microsoft.certificateregistration/2018-02-01/types.md index 5bd2049350..4ab827f36d 100644 --- a/generated/web/microsoft.certificateregistration/2018-02-01/types.md +++ b/generated/web/microsoft.certificateregistration/2018-02-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **csr**: string: Last CSR that was created for this order. @@ -51,12 +57,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. diff --git a/generated/web/microsoft.certificateregistration/2019-08-01/types.json b/generated/web/microsoft.certificateregistration/2019-08-01/types.json index e41db4f084..818bcd3aa4 100644 --- a/generated/web/microsoft.certificateregistration/2019-08-01/types.json +++ b/generated/web/microsoft.certificateregistration/2019-08-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2019-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":54,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":55,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":57,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2019-08-01","ScopeType":8,"Body":56}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2019-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":54,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":55,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":57,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2019-08-01","ScopeType":8,"Body":56}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2019-08-01/types.md b/generated/web/microsoft.certificateregistration/2019-08-01/types.md index df636e4df2..5e40222793 100644 --- a/generated/web/microsoft.certificateregistration/2019-08-01/types.md +++ b/generated/web/microsoft.certificateregistration/2019-08-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **csr**: string: Last CSR that was created for this order. @@ -51,12 +57,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. diff --git a/generated/web/microsoft.certificateregistration/2020-06-01/types.json b/generated/web/microsoft.certificateregistration/2020-06-01/types.json index 833212329d..9038371922 100644 --- a/generated/web/microsoft.certificateregistration/2020-06-01/types.json +++ b/generated/web/microsoft.certificateregistration/2020-06-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":54,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":55,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":57,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-06-01","ScopeType":8,"Body":56}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":54,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":55,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":57,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-06-01","ScopeType":8,"Body":56}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2020-06-01/types.md b/generated/web/microsoft.certificateregistration/2020-06-01/types.md index a697c411b0..5687b872db 100644 --- a/generated/web/microsoft.certificateregistration/2020-06-01/types.md +++ b/generated/web/microsoft.certificateregistration/2020-06-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **csr**: string: Last CSR that was created for this order. @@ -51,12 +57,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. diff --git a/generated/web/microsoft.certificateregistration/2020-09-01/types.json b/generated/web/microsoft.certificateregistration/2020-09-01/types.json index 817aabc76f..79f4ba7e53 100644 --- a/generated/web/microsoft.certificateregistration/2020-09-01/types.json +++ b/generated/web/microsoft.certificateregistration/2020-09-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":58,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":63,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[54,55,56,57]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[59,60,61,62]}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":65,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":66,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-09-01","ScopeType":8,"Body":67}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":58,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":63,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[54,55,56,57,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[59,60,61,62,4]}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":65,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":66,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-09-01","ScopeType":8,"Body":67}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2020-09-01/types.md b/generated/web/microsoft.certificateregistration/2020-09-01/types.md index befa4367b6..edde44ed6a 100644 --- a/generated/web/microsoft.certificateregistration/2020-09-01/types.md +++ b/generated/web/microsoft.certificateregistration/2020-09-01/types.md @@ -26,9 +26,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **csr**: string: Last CSR that was created for this order. @@ -53,12 +59,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -71,15 +71,6 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. - ## ResourceTags ### Properties ### Additional Properties @@ -90,3 +81,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/web/microsoft.certificateregistration/2020-10-01/types.json b/generated/web/microsoft.certificateregistration/2020-10-01/types.json index b805d66c20..414de04a17 100644 --- a/generated/web/microsoft.certificateregistration/2020-10-01/types.json +++ b/generated/web/microsoft.certificateregistration/2020-10-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":58,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":63,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[54,55,56,57]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[59,60,61,62]}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-10-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":65,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":66,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-10-01","ScopeType":8,"Body":67}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":52,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be between 1 and 3)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":58,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":63,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[54,55,56,57,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[59,60,61,62,4]}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-10-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":65,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":66,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":53,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-10-01","ScopeType":8,"Body":67}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2020-10-01/types.md b/generated/web/microsoft.certificateregistration/2020-10-01/types.md index 22ee686094..f4d9160d35 100644 --- a/generated/web/microsoft.certificateregistration/2020-10-01/types.md +++ b/generated/web/microsoft.certificateregistration/2020-10-01/types.md @@ -26,9 +26,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **csr**: string: Last CSR that was created for this order. @@ -53,12 +59,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -71,15 +71,6 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. - ## ResourceTags ### Properties ### Additional Properties @@ -90,3 +81,12 @@ ### Additional Properties * **Additional Properties Type**: string +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + diff --git a/generated/web/microsoft.certificateregistration/2020-12-01/types.json b/generated/web/microsoft.certificateregistration/2020-12-01/types.json index b5e5a4b6be..e9c5b80610 100644 --- a/generated/web/microsoft.certificateregistration/2020-12-01/types.json +++ b/generated/web/microsoft.certificateregistration/2020-12-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-12-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-12-01","ScopeType":8,"Body":57}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2020-12-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2020-12-01","ScopeType":8,"Body":57}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2020-12-01/types.md b/generated/web/microsoft.certificateregistration/2020-12-01/types.md index 3157dc2b2e..2bf477e25f 100644 --- a/generated/web/microsoft.certificateregistration/2020-12-01/types.md +++ b/generated/web/microsoft.certificateregistration/2020-12-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **contact**: [CertificateOrderContact](#certificateordercontact) (ReadOnly) @@ -52,19 +58,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - -## CertificateOrderContact -### Properties -* **email**: string -* **nameFirst**: string -* **nameLast**: string -* **phone**: string - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -77,6 +70,13 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. +## CertificateOrderContact +### Properties +* **email**: string +* **nameFirst**: string +* **nameLast**: string +* **phone**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/web/microsoft.certificateregistration/2021-01-01/types.json b/generated/web/microsoft.certificateregistration/2021-01-01/types.json index b0463f9363..79a222dda5 100644 --- a/generated/web/microsoft.certificateregistration/2021-01-01/types.json +++ b/generated/web/microsoft.certificateregistration/2021-01-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-01-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-01","ScopeType":8,"Body":57}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-01-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-01","ScopeType":8,"Body":57}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2021-01-01/types.md b/generated/web/microsoft.certificateregistration/2021-01-01/types.md index bdc6626bb3..9f73b4eefe 100644 --- a/generated/web/microsoft.certificateregistration/2021-01-01/types.md +++ b/generated/web/microsoft.certificateregistration/2021-01-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **contact**: [CertificateOrderContact](#certificateordercontact) (ReadOnly) @@ -52,19 +58,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - -## CertificateOrderContact -### Properties -* **email**: string -* **nameFirst**: string -* **nameLast**: string -* **phone**: string - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -77,6 +70,13 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. +## CertificateOrderContact +### Properties +* **email**: string +* **nameFirst**: string +* **nameLast**: string +* **phone**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/web/microsoft.certificateregistration/2021-01-15/types.json b/generated/web/microsoft.certificateregistration/2021-01-15/types.json index 5a7efc2532..2dea725394 100644 --- a/generated/web/microsoft.certificateregistration/2021-01-15/types.json +++ b/generated/web/microsoft.certificateregistration/2021-01-15/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-01-15","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-15","ScopeType":8,"Body":57}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-01-15","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-01-15","ScopeType":8,"Body":57}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2021-01-15/types.md b/generated/web/microsoft.certificateregistration/2021-01-15/types.md index 87f718483b..20e7489881 100644 --- a/generated/web/microsoft.certificateregistration/2021-01-15/types.md +++ b/generated/web/microsoft.certificateregistration/2021-01-15/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **contact**: [CertificateOrderContact](#certificateordercontact) (ReadOnly) @@ -52,19 +58,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - -## CertificateOrderContact -### Properties -* **email**: string -* **nameFirst**: string -* **nameLast**: string -* **phone**: string - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -77,6 +70,13 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. +## CertificateOrderContact +### Properties +* **email**: string +* **nameFirst**: string +* **nameLast**: string +* **phone**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/web/microsoft.certificateregistration/2021-02-01/types.json b/generated/web/microsoft.certificateregistration/2021-02-01/types.json index c0c7f819e9..9a9099cc65 100644 --- a/generated/web/microsoft.certificateregistration/2021-02-01/types.json +++ b/generated/web/microsoft.certificateregistration/2021-02-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-02-01","ScopeType":8,"Body":57}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-02-01","ScopeType":8,"Body":57}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2021-02-01/types.md b/generated/web/microsoft.certificateregistration/2021-02-01/types.md index 9c4b0eaec8..6e2d0fff27 100644 --- a/generated/web/microsoft.certificateregistration/2021-02-01/types.md +++ b/generated/web/microsoft.certificateregistration/2021-02-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **contact**: [CertificateOrderContact](#certificateordercontact) (ReadOnly) @@ -52,19 +58,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - -## CertificateOrderContact -### Properties -* **email**: string -* **nameFirst**: string -* **nameLast**: string -* **phone**: string - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -77,6 +70,13 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. +## CertificateOrderContact +### Properties +* **email**: string +* **nameFirst**: string +* **nameLast**: string +* **phone**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/web/microsoft.certificateregistration/2021-03-01/types.json b/generated/web/microsoft.certificateregistration/2021-03-01/types.json index ac9f7053f0..d0ec2c6916 100644 --- a/generated/web/microsoft.certificateregistration/2021-03-01/types.json +++ b/generated/web/microsoft.certificateregistration/2021-03-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-03-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-03-01","ScopeType":8,"Body":57}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"AppServiceCertificateOrder resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":53,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceCertificateOrderProperties","Properties":{"certificates":{"Type":25,"Flags":0,"Description":"State of the Key Vault secret."},"distinguishedName":{"Type":4,"Flags":0,"Description":"Certificate distinguished name."},"domainVerificationToken":{"Type":4,"Flags":2,"Description":"Domain verification token."},"validityInYears":{"Type":3,"Flags":0,"Description":"Duration in years (must be 1)."},"keySize":{"Type":3,"Flags":0,"Description":"Certificate key size."},"productType":{"Type":28,"Flags":1,"Description":"Certificate product type."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the certificate should be automatically renewed when it expires; otherwise, false."},"provisioningState":{"Type":34,"Flags":2,"Description":"Status of certificate order."},"status":{"Type":45,"Flags":2,"Description":"Current order status."},"signedCertificate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"csr":{"Type":4,"Flags":0,"Description":"Last CSR that was created for this order."},"intermediate":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"root":{"Type":46,"Flags":2,"Description":"SSL certificate details."},"serialNumber":{"Type":4,"Flags":2,"Description":"Current serial number of the certificate."},"lastCertificateIssuanceTime":{"Type":4,"Flags":2,"Description":"Certificate last issuance time."},"expirationTime":{"Type":4,"Flags":2,"Description":"Certificate expiration time."},"isPrivateKeyExternal":{"Type":2,"Flags":2,"Description":"true if private key is external; otherwise, false."},"appServiceCertificateNotRenewableReasons":{"Type":51,"Flags":2,"Description":"Reasons why App Service Certificate is not renewable at the current moment."},"nextAutoRenewalTimeStamp":{"Type":4,"Flags":2,"Description":"Time stamp when the certificate would be auto renewed next"},"contact":{"Type":52,"Flags":2}}}},{"2":{"Name":"AppServiceCertificate","Properties":{"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"provisioningState":{"Type":24,"Flags":2,"Description":"Status of the Key Vault secret."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[13,14,15,16,17,18,19,20,21,22,23]}},{"2":{"Name":"AppServiceCertificateOrderPropertiesCertificates","Properties":{},"AdditionalProperties":12}},{"6":{"Value":"StandardDomainValidatedSsl"}},{"6":{"Value":"StandardDomainValidatedWildCardSsl"}},{"5":{"Elements":[26,27]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32,33]}},{"6":{"Value":"Pendingissuance"}},{"6":{"Value":"Issued"}},{"6":{"Value":"Revoked"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Denied"}},{"6":{"Value":"Pendingrevocation"}},{"6":{"Value":"PendingRekey"}},{"6":{"Value":"Unused"}},{"6":{"Value":"Expired"}},{"6":{"Value":"NotSubmitted"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44]}},{"2":{"Name":"CertificateDetails","Properties":{"version":{"Type":3,"Flags":2,"Description":"Certificate Version."},"serialNumber":{"Type":4,"Flags":2,"Description":"Certificate Serial Number."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint."},"subject":{"Type":4,"Flags":2,"Description":"Certificate Subject."},"notBefore":{"Type":4,"Flags":2,"Description":"Date Certificate is valid from."},"notAfter":{"Type":4,"Flags":2,"Description":"Date Certificate is valid to."},"signatureAlgorithm":{"Type":4,"Flags":2,"Description":"Certificate Signature algorithm."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate Issuer."},"rawData":{"Type":4,"Flags":2,"Description":"Raw certificate data."}}}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[47,48,49,4]}},{"3":{"ItemType":50}},{"2":{"Name":"CertificateOrderContact","Properties":{"email":{"Type":4,"Flags":0},"nameFirst":{"Type":4,"Flags":0},"nameLast":{"Type":4,"Flags":0},"phone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders@2021-03-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.CertificateRegistration/certificateOrders/certificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":55,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":56,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"Key Vault container for a certificate that is purchased through Azure."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":58,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.CertificateRegistration/certificateOrders/certificates@2021-03-01","ScopeType":8,"Body":57}}] \ No newline at end of file diff --git a/generated/web/microsoft.certificateregistration/2021-03-01/types.md b/generated/web/microsoft.certificateregistration/2021-03-01/types.md index b3ba49575d..d2cd8d03bd 100644 --- a/generated/web/microsoft.certificateregistration/2021-03-01/types.md +++ b/generated/web/microsoft.certificateregistration/2021-03-01/types.md @@ -24,9 +24,15 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags. * **type**: 'Microsoft.CertificateRegistration/certificateOrders/certificates' (ReadOnly, DeployTimeConstant): The resource type +## AppServiceCertificate +### Properties +* **keyVaultId**: string: Key Vault resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. + ## AppServiceCertificateOrderProperties ### Properties -* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. +* **appServiceCertificateNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why App Service Certificate is not renewable at the current moment. * **autoRenew**: bool: true if the certificate should be automatically renewed when it expires; otherwise, false. * **certificates**: [AppServiceCertificateOrderPropertiesCertificates](#appservicecertificateorderpropertiescertificates): State of the Key Vault secret. * **contact**: [CertificateOrderContact](#certificateordercontact) (ReadOnly) @@ -52,19 +58,6 @@ ### Additional Properties * **Additional Properties Type**: [AppServiceCertificate](#appservicecertificate) -## AppServiceCertificate -### Properties -* **keyVaultId**: string: Key Vault resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **provisioningState**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. - -## CertificateOrderContact -### Properties -* **email**: string -* **nameFirst**: string -* **nameLast**: string -* **phone**: string - ## CertificateDetails ### Properties * **issuer**: string (ReadOnly): Certificate Issuer. @@ -77,6 +70,13 @@ * **thumbprint**: string (ReadOnly): Certificate Thumbprint. * **version**: int (ReadOnly): Certificate Version. +## CertificateOrderContact +### Properties +* **email**: string +* **nameFirst**: string +* **nameLast**: string +* **phone**: string + ## ResourceTags ### Properties ### Additional Properties diff --git a/generated/web/microsoft.domainregistration/2015-04-01/types.json b/generated/web/microsoft.domainregistration/2015-04-01/types.json index 5d3fdeb17a..fa33464760 100644 --- a/generated/web/microsoft.domainregistration/2015-04-01/types.json +++ b/generated/web/microsoft.domainregistration/2015-04-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2015-04-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2015-04-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2015-04-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2015-04-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2015-04-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2015-04-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2015-04-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2015-04-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2015-04-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2015-04-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2015-04-01/types.md b/generated/web/microsoft.domainregistration/2015-04-01/types.md index 14da8d3403..10c34b614b 100644 --- a/generated/web/microsoft.domainregistration/2015-04-01/types.md +++ b/generated/web/microsoft.domainregistration/2015-04-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2015-08-01/types.json b/generated/web/microsoft.domainregistration/2015-08-01/types.json index bc646b324b..254b10346f 100644 --- a/generated/web/microsoft.domainregistration/2015-08-01/types.json +++ b/generated/web/microsoft.domainregistration/2015-08-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2015-08-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource"},"location":{"Type":4,"Flags":1,"Description":"Resource Location"},"tags":{"Type":62,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":0,"Description":"Domain registration status"},"provisioningState":{"Type":41,"Flags":0,"Description":"Status of certificate order"},"nameServers":{"Type":42,"Flags":0,"Description":"Name servers"},"privacy":{"Type":2,"Flags":0,"Description":"If true then domain privacy is enabled for this domain"},"createdTime":{"Type":4,"Flags":0,"Description":"Domain creation timestamp"},"expirationTime":{"Type":4,"Flags":0,"Description":"Domain expiration timestamp"},"lastRenewedTime":{"Type":4,"Flags":0,"Description":"Timestamp when the domain was renewed last time"},"autoRenew":{"Type":2,"Flags":0,"Description":"If true then domain will renewed automatically"},"readyForDnsRecordManagement":{"Type":2,"Flags":0,"Description":"If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to"},"managedHostNames":{"Type":54,"Flags":0,"Description":"All hostnames derived from the domain and assigned to Azure resources"},"consent":{"Type":55,"Flags":0,"Description":"Domain purchase consent object representing acceptance of applicable legal agreements"},"domainNotRenewableReasons":{"Type":61,"Flags":0,"Description":"Reasons why domain is not renewable"}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration"},"email":{"Type":4,"Flags":0,"Description":"Email address"},"fax":{"Type":4,"Flags":0,"Description":"Fax number"},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title"},"nameFirst":{"Type":4,"Flags":0,"Description":"First name"},"nameLast":{"Type":4,"Flags":0,"Description":"Last name"},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name"},"organization":{"Type":4,"Flags":0,"Description":"Organization"},"phone":{"Type":4,"Flags":0,"Description":"Phone number"}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":0,"Description":"Address 1"},"address2":{"Type":4,"Flags":0,"Description":"Address 2"},"city":{"Type":4,"Flags":0,"Description":"City"},"country":{"Type":4,"Flags":0,"Description":"Country"},"postalCode":{"Type":4,"Flags":0,"Description":"Postal code"},"state":{"Type":4,"Flags":0,"Description":"State"}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname"},"siteNames":{"Type":44,"Flags":0,"Description":"List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager"},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name"},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to"},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the Dns record"},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource"},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address"},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2015-08-01","ScopeType":8,"Body":10}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true then the list of agreements will include agreements for domain privacy as well."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":67,"Flags":2,"Description":"Collection of resources"},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources"}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement"},"title":{"Type":4,"Flags":2,"Description":"Agreement title"},"content":{"Type":4,"Flags":2,"Description":"Agreement details"},"url":{"Type":4,"Flags":2,"Description":"Url where a copy of the agreement details is hosted"}}}},{"3":{"ItemType":66}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2015-08-01","Output":65,"Input":64}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2015-08-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource"},"location":{"Type":4,"Flags":1,"Description":"Resource Location"},"tags":{"Type":62,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":0,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":0,"Description":"Domain registration status"},"provisioningState":{"Type":41,"Flags":0,"Description":"Status of certificate order"},"nameServers":{"Type":42,"Flags":0,"Description":"Name servers"},"privacy":{"Type":2,"Flags":0,"Description":"If true then domain privacy is enabled for this domain"},"createdTime":{"Type":4,"Flags":0,"Description":"Domain creation timestamp"},"expirationTime":{"Type":4,"Flags":0,"Description":"Domain expiration timestamp"},"lastRenewedTime":{"Type":4,"Flags":0,"Description":"Timestamp when the domain was renewed last time"},"autoRenew":{"Type":2,"Flags":0,"Description":"If true then domain will renewed automatically"},"readyForDnsRecordManagement":{"Type":2,"Flags":0,"Description":"If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to"},"managedHostNames":{"Type":54,"Flags":0,"Description":"All hostnames derived from the domain and assigned to Azure resources"},"consent":{"Type":55,"Flags":0,"Description":"Domain purchase consent object representing acceptance of applicable legal agreements"},"domainNotRenewableReasons":{"Type":61,"Flags":0,"Description":"Reasons why domain is not renewable"}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration"},"email":{"Type":4,"Flags":0,"Description":"Email address"},"fax":{"Type":4,"Flags":0,"Description":"Fax number"},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title"},"nameFirst":{"Type":4,"Flags":0,"Description":"First name"},"nameLast":{"Type":4,"Flags":0,"Description":"Last name"},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name"},"organization":{"Type":4,"Flags":0,"Description":"Organization"},"phone":{"Type":4,"Flags":0,"Description":"Phone number"}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":0,"Description":"Address 1"},"address2":{"Type":4,"Flags":0,"Description":"Address 2"},"city":{"Type":4,"Flags":0,"Description":"City"},"country":{"Type":4,"Flags":0,"Description":"Country"},"postalCode":{"Type":4,"Flags":0,"Description":"Postal code"},"state":{"Type":4,"Flags":0,"Description":"State"}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname"},"siteNames":{"Type":44,"Flags":0,"Description":"List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager"},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name"},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to"},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the Dns record"},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource"},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address"},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted"}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2015-08-01","ScopeType":8,"Body":10}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true then the list of agreements will include agreements for domain privacy as well."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":67,"Flags":2,"Description":"Collection of resources"},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources"}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement"},"title":{"Type":4,"Flags":2,"Description":"Agreement title"},"content":{"Type":4,"Flags":2,"Description":"Agreement details"},"url":{"Type":4,"Flags":2,"Description":"Url where a copy of the agreement details is hosted"}}}},{"3":{"ItemType":66}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2015-08-01","Output":65,"Input":64}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2015-08-01/types.md b/generated/web/microsoft.domainregistration/2015-08-01/types.md index 5bda61c013..f1e337260b 100644 --- a/generated/web/microsoft.domainregistration/2015-08-01/types.md +++ b/generated/web/microsoft.domainregistration/2015-08-01/types.md @@ -18,6 +18,27 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string: Address 1 +* **address2**: string: Address 2 +* **city**: string: City +* **country**: string: Country +* **postalCode**: string: Postal code +* **state**: string: State + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration +* **email**: string: Email address +* **fax**: string: Fax number +* **jobTitle**: string: Job title +* **nameFirst**: string: First name +* **nameLast**: string: Last name +* **nameMiddle**: string: Middle name +* **organization**: string: Organization +* **phone**: string: Phone number + ## DomainProperties ### Properties * **autoRenew**: bool: If true then domain will renewed automatically @@ -27,7 +48,7 @@ * **contactRegistrant**: [Contact](#contact): Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements. * **contactTech**: [Contact](#contact): Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements. * **createdTime**: string: Domain creation timestamp -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[]: Reasons why domain is not renewable +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[]: Reasons why domain is not renewable * **expirationTime**: string: Domain expiration timestamp * **lastRenewedTime**: string: Timestamp when the domain was renewed last time * **managedHostNames**: [HostName](#hostname)[]: All hostnames derived from the domain and assigned to Azure resources @@ -43,27 +64,6 @@ * **agreedBy**: string: Client IP address * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration -* **email**: string: Email address -* **fax**: string: Fax number -* **jobTitle**: string: Job title -* **nameFirst**: string: First name -* **nameLast**: string: Last name -* **nameMiddle**: string: Middle name -* **organization**: string: Organization -* **phone**: string: Phone number - -## Address -### Properties -* **address1**: string: Address 1 -* **address2**: string: Address 2 -* **city**: string: City -* **country**: string: Country -* **postalCode**: string: Postal code -* **state**: string: State - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name @@ -78,19 +78,19 @@ ### Additional Properties * **Additional Properties Type**: string -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **includePrivacy**: bool (WriteOnly): If true then the list of agreements will include agreements for domain privacy as well. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement +* **content**: string (ReadOnly): Agreement details +* **title**: string (ReadOnly): Agreement title +* **url**: string (ReadOnly): Url where a copy of the agreement details is hosted ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement -* **content**: string (ReadOnly): Agreement details -* **title**: string (ReadOnly): Agreement title -* **url**: string (ReadOnly): Url where a copy of the agreement details is hosted +* **includePrivacy**: bool (WriteOnly): If true then the list of agreements will include agreements for domain privacy as well. diff --git a/generated/web/microsoft.domainregistration/2018-02-01/types.json b/generated/web/microsoft.domainregistration/2018-02-01/types.json index 5385360edd..c665a5c208 100644 --- a/generated/web/microsoft.domainregistration/2018-02-01/types.json +++ b/generated/web/microsoft.domainregistration/2018-02-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2018-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2018-02-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2018-02-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2018-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2018-02-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2018-02-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2018-02-01/types.md b/generated/web/microsoft.domainregistration/2018-02-01/types.md index 988f4288b3..95671925c3 100644 --- a/generated/web/microsoft.domainregistration/2018-02-01/types.md +++ b/generated/web/microsoft.domainregistration/2018-02-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2019-08-01/types.json b/generated/web/microsoft.domainregistration/2019-08-01/types.json index 5da0cbbd33..a47a319769 100644 --- a/generated/web/microsoft.domainregistration/2019-08-01/types.json +++ b/generated/web/microsoft.domainregistration/2019-08-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2019-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2019-08-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2019-08-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2019-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2019-08-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2019-08-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2019-08-01/types.md b/generated/web/microsoft.domainregistration/2019-08-01/types.md index 5e40ec72af..226d3fa25d 100644 --- a/generated/web/microsoft.domainregistration/2019-08-01/types.md +++ b/generated/web/microsoft.domainregistration/2019-08-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2020-06-01/types.json b/generated/web/microsoft.domainregistration/2020-06-01/types.json index a3d47185cd..d711dcf804 100644 --- a/generated/web/microsoft.domainregistration/2020-06-01/types.json +++ b/generated/web/microsoft.domainregistration/2020-06-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-06-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-06-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-06-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-06-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2020-06-01/types.md b/generated/web/microsoft.domainregistration/2020-06-01/types.md index 764ba3a27d..fd3e636ca7 100644 --- a/generated/web/microsoft.domainregistration/2020-06-01/types.md +++ b/generated/web/microsoft.domainregistration/2020-06-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2020-09-01/types.json b/generated/web/microsoft.domainregistration/2020-09-01/types.json index 757b781c10..c3c2f76e2f 100644 --- a/generated/web/microsoft.domainregistration/2020-09-01/types.json +++ b/generated/web/microsoft.domainregistration/2020-09-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":74,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":79,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[70,71,72,73]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[75,76,77,78]}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":81,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":82,"Flags":10,"Description":"The resource api version"},"properties":{"Type":84,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-09-01","ScopeType":8,"Body":83}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":89,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":88}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-09-01","Output":87,"Input":86}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":74,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":79,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[70,71,72,73,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[75,76,77,78,4]}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":81,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":82,"Flags":10,"Description":"The resource api version"},"properties":{"Type":84,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-09-01","ScopeType":8,"Body":83}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":89,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":88}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-09-01","Output":87,"Input":86}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2020-09-01/types.md b/generated/web/microsoft.domainregistration/2020-09-01/types.md index 299e2a2a39..5ca4e25878 100644 --- a/generated/web/microsoft.domainregistration/2020-09-01/types.md +++ b/generated/web/microsoft.domainregistration/2020-09-01/types.md @@ -30,6 +30,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -46,7 +71,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -64,27 +89,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -94,38 +98,34 @@ directories as per ICANN requirements. * **name**: string: Name of the hostname. * **siteNames**: string[]: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties +## SystemData ### Properties -* **ownershipId**: string: Ownership Id. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2020-10-01/types.json b/generated/web/microsoft.domainregistration/2020-10-01/types.json index f464afd04c..9aa56349ba 100644 --- a/generated/web/microsoft.domainregistration/2020-10-01/types.json +++ b/generated/web/microsoft.domainregistration/2020-10-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":74,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":79,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[70,71,72,73]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[75,76,77,78]}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-10-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":81,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":82,"Flags":10,"Description":"The resource api version"},"properties":{"Type":84,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-10-01","ScopeType":8,"Body":83}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":89,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":88}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-10-01","Output":87,"Input":86}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":74,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":79,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[70,71,72,73,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[75,76,77,78,4]}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-10-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":81,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":82,"Flags":10,"Description":"The resource api version"},"properties":{"Type":84,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":69,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-10-01","ScopeType":8,"Body":83}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":89,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":88}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-10-01","Output":87,"Input":86}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2020-10-01/types.md b/generated/web/microsoft.domainregistration/2020-10-01/types.md index 8a4fc940e8..24175a1213 100644 --- a/generated/web/microsoft.domainregistration/2020-10-01/types.md +++ b/generated/web/microsoft.domainregistration/2020-10-01/types.md @@ -30,6 +30,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -46,7 +71,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -64,27 +89,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -94,38 +98,34 @@ directories as per ICANN requirements. * **name**: string: Name of the hostname. * **siteNames**: string[]: List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. - ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties +## SystemData ### Properties -* **ownershipId**: string: Ownership Id. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2020-12-01/types.json b/generated/web/microsoft.domainregistration/2020-12-01/types.json index 3b9ec87d50..063acc1d05 100644 --- a/generated/web/microsoft.domainregistration/2020-12-01/types.json +++ b/generated/web/microsoft.domainregistration/2020-12-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-12-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-12-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-12-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2020-12-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2020-12-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2020-12-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2020-12-01/types.md b/generated/web/microsoft.domainregistration/2020-12-01/types.md index c87c26ba8a..24260e30c1 100644 --- a/generated/web/microsoft.domainregistration/2020-12-01/types.md +++ b/generated/web/microsoft.domainregistration/2020-12-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2021-01-01/types.json b/generated/web/microsoft.domainregistration/2021-01-01/types.json index 6baa2dfcb4..76221eeb47 100644 --- a/generated/web/microsoft.domainregistration/2021-01-01/types.json +++ b/generated/web/microsoft.domainregistration/2021-01-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-01-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-01-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-01-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-01-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2021-01-01/types.md b/generated/web/microsoft.domainregistration/2021-01-01/types.md index 1d8ff15669..b1c64e62b3 100644 --- a/generated/web/microsoft.domainregistration/2021-01-01/types.md +++ b/generated/web/microsoft.domainregistration/2021-01-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2021-01-15/types.json b/generated/web/microsoft.domainregistration/2021-01-15/types.json index fec9a764c7..36aaff89e0 100644 --- a/generated/web/microsoft.domainregistration/2021-01-15/types.json +++ b/generated/web/microsoft.domainregistration/2021-01-15/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-01-15","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-15","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-01-15","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-01-15","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-01-15","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-01-15","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2021-01-15/types.md b/generated/web/microsoft.domainregistration/2021-01-15/types.md index 6a5e15071b..5aa4d9840f 100644 --- a/generated/web/microsoft.domainregistration/2021-01-15/types.md +++ b/generated/web/microsoft.domainregistration/2021-01-15/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2021-02-01/types.json b/generated/web/microsoft.domainregistration/2021-02-01/types.json index c3c9e8bc8d..9fb04cf409 100644 --- a/generated/web/microsoft.domainregistration/2021-02-01/types.json +++ b/generated/web/microsoft.domainregistration/2021-02-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-02-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-02-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-02-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-02-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2021-02-01/types.md b/generated/web/microsoft.domainregistration/2021-02-01/types.md index e6ae366820..efd6063e62 100644 --- a/generated/web/microsoft.domainregistration/2021-02-01/types.md +++ b/generated/web/microsoft.domainregistration/2021-02-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.domainregistration/2021-03-01/types.json b/generated/web/microsoft.domainregistration/2021-03-01/types.json index 98343f68eb..e0f6fad86e 100644 --- a/generated/web/microsoft.domainregistration/2021-03-01/types.json +++ b/generated/web/microsoft.domainregistration/2021-03-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-03-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-03-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-03-01","Output":76,"Input":75}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.DomainRegistration/domains"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Domain resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":68,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"DomainProperties","Properties":{"contactAdmin":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactBilling":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactRegistrant":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"contactTech":{"Type":12,"Flags":5,"Description":"Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements."},"registrationStatus":{"Type":35,"Flags":2,"Description":"Domain registration status."},"provisioningState":{"Type":41,"Flags":2,"Description":"Domain provisioning state."},"nameServers":{"Type":42,"Flags":2,"Description":"Name servers."},"privacy":{"Type":2,"Flags":0,"Description":"true if domain privacy is enabled for this domain; otherwise, false."},"createdTime":{"Type":4,"Flags":2,"Description":"Domain creation timestamp."},"expirationTime":{"Type":4,"Flags":2,"Description":"Domain expiration timestamp."},"lastRenewedTime":{"Type":4,"Flags":2,"Description":"Timestamp when the domain was renewed last time."},"autoRenew":{"Type":2,"Flags":0,"Description":"true if the domain should be automatically renewed; otherwise, false."},"readyForDnsRecordManagement":{"Type":2,"Flags":2,"Description":"true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to."},"managedHostNames":{"Type":54,"Flags":2,"Description":"All hostnames derived from the domain and assigned to Azure resources."},"consent":{"Type":55,"Flags":5,"Description":"Domain purchase consent object, representing acceptance of applicable legal agreements."},"domainNotRenewableReasons":{"Type":61,"Flags":2,"Description":"Reasons why domain is not renewable."},"dnsType":{"Type":64,"Flags":0,"Description":"Current DNS type"},"dnsZoneId":{"Type":4,"Flags":0,"Description":"Azure DNS Zone to use"},"targetDnsType":{"Type":67,"Flags":0,"Description":"Current DNS type"},"authCode":{"Type":4,"Flags":0}}}},{"2":{"Name":"Contact","Properties":{"addressMailing":{"Type":13,"Flags":0,"Description":"Address information for domain registration."},"email":{"Type":4,"Flags":1,"Description":"Email address."},"fax":{"Type":4,"Flags":0,"Description":"Fax number."},"jobTitle":{"Type":4,"Flags":0,"Description":"Job title."},"nameFirst":{"Type":4,"Flags":1,"Description":"First name."},"nameLast":{"Type":4,"Flags":1,"Description":"Last name."},"nameMiddle":{"Type":4,"Flags":0,"Description":"Middle name."},"organization":{"Type":4,"Flags":0,"Description":"Organization contact belongs to."},"phone":{"Type":4,"Flags":1,"Description":"Phone number."}}}},{"2":{"Name":"Address","Properties":{"address1":{"Type":4,"Flags":1,"Description":"First line of an Address."},"address2":{"Type":4,"Flags":0,"Description":"The second line of the Address. Optional."},"city":{"Type":4,"Flags":1,"Description":"The city for the address."},"country":{"Type":4,"Flags":1,"Description":"The country for the address."},"postalCode":{"Type":4,"Flags":1,"Description":"The postal code for the address."},"state":{"Type":4,"Flags":1,"Description":"The state or province for the address."}}}},{"6":{"Value":"Active"}},{"6":{"Value":"Awaiting"}},{"6":{"Value":"Cancelled"}},{"6":{"Value":"Confiscated"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Excluded"}},{"6":{"Value":"Expired"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Held"}},{"6":{"Value":"Locked"}},{"6":{"Value":"Parked"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Reserved"}},{"6":{"Value":"Reverted"}},{"6":{"Value":"Suspended"}},{"6":{"Value":"Transferred"}},{"6":{"Value":"Unknown"}},{"6":{"Value":"Unlocked"}},{"6":{"Value":"Unparked"}},{"6":{"Value":"Updated"}},{"6":{"Value":"JsonConverterFailed"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[36,37,38,39,40]}},{"3":{"ItemType":4}},{"2":{"Name":"HostName","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the hostname."},"siteNames":{"Type":44,"Flags":0,"Description":"List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name."},"azureResourceType":{"Type":47,"Flags":0,"Description":"Type of the Azure resource the hostname is assigned to."},"customHostNameDnsRecordType":{"Type":50,"Flags":0,"Description":"Type of the DNS record."},"hostNameType":{"Type":53,"Flags":0,"Description":"Type of the hostname."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[45,46]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[48,49]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[51,52]}},{"3":{"ItemType":43}},{"2":{"Name":"DomainPurchaseConsent","Properties":{"agreementKeys":{"Type":56,"Flags":0,"Description":"List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource."},"agreedBy":{"Type":4,"Flags":0,"Description":"Client IP address."},"agreedAt":{"Type":4,"Flags":0,"Description":"Timestamp when the agreements were accepted."}}}},{"3":{"ItemType":4}},{"6":{"Value":"RegistrationStatusNotSupportedForRenewal"}},{"6":{"Value":"ExpirationNotInRenewalTimeRange"}},{"6":{"Value":"SubscriptionNotActive"}},{"5":{"Elements":[57,58,59,4]}},{"3":{"ItemType":60}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[62,63]}},{"6":{"Value":"AzureDns"}},{"6":{"Value":"DefaultDomainRegistrarDns"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.DomainRegistration/domains@2021-03-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"DomainOwnershipIdentifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DomainOwnershipIdentifierProperties","Properties":{"ownershipId":{"Type":4,"Flags":0,"Description":"Ownership Id."}}}},{"4":{"Name":"Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers@2021-03-01","ScopeType":8,"Body":72}},{"2":{"Name":"TopLevelDomainAgreementOption","Properties":{"includePrivacy":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false."},"forTransfer":{"Type":2,"Flags":4,"Description":"If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false."}}}},{"2":{"Name":"TldLegalAgreementCollection","Properties":{"value":{"Type":78,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"TldLegalAgreement","Properties":{"agreementKey":{"Type":4,"Flags":2,"Description":"Unique identifier for the agreement."},"title":{"Type":4,"Flags":2,"Description":"Agreement title."},"content":{"Type":4,"Flags":2,"Description":"Agreement details."},"url":{"Type":4,"Flags":2,"Description":"URL where a copy of the agreement details is hosted."}}}},{"3":{"ItemType":77}},{"8":{"Name":"listAgreements","ResourceType":"Microsoft.DomainRegistration/topLevelDomains","ApiVersion":"2021-03-01","Output":76,"Input":75}}] \ No newline at end of file diff --git a/generated/web/microsoft.domainregistration/2021-03-01/types.md b/generated/web/microsoft.domainregistration/2021-03-01/types.md index 3bbd7f38d8..1f3b8642bb 100644 --- a/generated/web/microsoft.domainregistration/2021-03-01/types.md +++ b/generated/web/microsoft.domainregistration/2021-03-01/types.md @@ -28,6 +28,31 @@ * **Input**: [TopLevelDomainAgreementOption](#topleveldomainagreementoption) * **Output**: [TldLegalAgreementCollection](#tldlegalagreementcollection) +## Address +### Properties +* **address1**: string (Required): First line of an Address. +* **address2**: string: The second line of the Address. Optional. +* **city**: string (Required): The city for the address. +* **country**: string (Required): The country for the address. +* **postalCode**: string (Required): The postal code for the address. +* **state**: string (Required): The state or province for the address. + +## Contact +### Properties +* **addressMailing**: [Address](#address): Address information for domain registration. +* **email**: string (Required): Email address. +* **fax**: string: Fax number. +* **jobTitle**: string: Job title. +* **nameFirst**: string (Required): First name. +* **nameLast**: string (Required): Last name. +* **nameMiddle**: string: Middle name. +* **organization**: string: Organization contact belongs to. +* **phone**: string (Required): Phone number. + +## DomainOwnershipIdentifierProperties +### Properties +* **ownershipId**: string: Ownership Id. + ## DomainProperties ### Properties * **authCode**: string @@ -44,7 +69,7 @@ directories as per ICANN requirements. * **createdTime**: string (ReadOnly): Domain creation timestamp. * **dnsType**: 'AzureDns' | 'DefaultDomainRegistrarDns': Current DNS type * **dnsZoneId**: string: Azure DNS Zone to use -* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive'[] (ReadOnly): Reasons why domain is not renewable. +* **domainNotRenewableReasons**: 'ExpirationNotInRenewalTimeRange' | 'RegistrationStatusNotSupportedForRenewal' | 'SubscriptionNotActive' | string[] (ReadOnly): Reasons why domain is not renewable. * **expirationTime**: string (ReadOnly): Domain expiration timestamp. * **lastRenewedTime**: string (ReadOnly): Timestamp when the domain was renewed last time. * **managedHostNames**: [HostName](#hostname)[] (ReadOnly): All hostnames derived from the domain and assigned to Azure resources. @@ -62,27 +87,6 @@ directories as per ICANN requirements. * **agreedBy**: string: Client IP address. * **agreementKeys**: string[]: List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource. -## Contact -### Properties -* **addressMailing**: [Address](#address): Address information for domain registration. -* **email**: string (Required): Email address. -* **fax**: string: Fax number. -* **jobTitle**: string: Job title. -* **nameFirst**: string (Required): First name. -* **nameLast**: string (Required): Last name. -* **nameMiddle**: string: Middle name. -* **organization**: string: Organization contact belongs to. -* **phone**: string (Required): Phone number. - -## Address -### Properties -* **address1**: string (Required): First line of an Address. -* **address2**: string: The second line of the Address. Optional. -* **city**: string (Required): The city for the address. -* **country**: string (Required): The country for the address. -* **postalCode**: string (Required): The postal code for the address. -* **state**: string (Required): The state or province for the address. - ## HostName ### Properties * **azureResourceName**: string: Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. @@ -97,24 +101,20 @@ directories as per ICANN requirements. ### Additional Properties * **Additional Properties Type**: string -## DomainOwnershipIdentifierProperties -### Properties -* **ownershipId**: string: Ownership Id. - -## TopLevelDomainAgreementOption +## TldLegalAgreement ### Properties -* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. -* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. +* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. +* **content**: string (ReadOnly): Agreement details. +* **title**: string (ReadOnly): Agreement title. +* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. ## TldLegalAgreementCollection ### Properties * **nextLink**: string (ReadOnly): Link to next page of resources. * **value**: [TldLegalAgreement](#tldlegalagreement)[] (ReadOnly): Collection of resources. -## TldLegalAgreement +## TopLevelDomainAgreementOption ### Properties -* **agreementKey**: string (ReadOnly): Unique identifier for the agreement. -* **content**: string (ReadOnly): Agreement details. -* **title**: string (ReadOnly): Agreement title. -* **url**: string (ReadOnly): URL where a copy of the agreement details is hosted. +* **forTransfer**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false. +* **includePrivacy**: bool (WriteOnly): If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false. diff --git a/generated/web/microsoft.web/2015-08-01-preview/types.md b/generated/web/microsoft.web/2015-08-01-preview/types.md index 0ec1f6cf1d..d8478ded1b 100644 --- a/generated/web/microsoft.web/2015-08-01-preview/types.md +++ b/generated/web/microsoft.web/2015-08-01-preview/types.md @@ -24,58 +24,6 @@ * **Input**: [ConsentLinkInput](#consentlinkinput) * **Output**: [ConsentLinkPayload](#consentlinkpayload) -## ConnectionProperties -### Properties -* **api**: [ExpandedParentApiEntity](#expandedparentapientity): expanded parent object for expansion -* **changedTime**: string: Timestamp of last connection change. -* **createdTime**: string: Timestamp of the connection creation -* **customParameterValues**: [ConnectionPropertiesCustomParameterValues](#connectionpropertiescustomparametervalues): Custom login setting values. -* **displayName**: string: display name -* **firstExpirationTime**: string: Time in UTC when the first expiration of OAuth tokens -* **keywords**: string[]: List of Keywords that tag the acl -* **metadata**: any: Any object -* **name**: string: connection name -* **nonSecretParameterValues**: [ConnectionPropertiesNonSecretParameterValues](#connectionpropertiesnonsecretparametervalues): Tokens/Claim -* **parameterValues**: [ConnectionPropertiesParameterValues](#connectionpropertiesparametervalues): Tokens/Claim -* **statuses**: [ConnectionStatus](#connectionstatus)[]: Status of the connection -* **tenantId**: string - -## ExpandedParentApiEntity -### Properties -* **id**: string: Resource Id -* **kind**: string: Kind of resource -* **location**: string (Required): Resource Location -* **name**: string: Resource Name -* **properties**: [ExpandedParentApiEntityProperties](#expandedparentapientityproperties) -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string: Resource type - -## ExpandedParentApiEntityProperties -### Properties -* **entity**: [ResponseMessageEnvelopeApiEntity](#responsemessageenvelopeapientity): Message envelope that contains the common Azure resource manager properties and the resource provider specific content -* **id**: string: Id of connection provider - -## ResponseMessageEnvelopeApiEntity -### Properties -* **id**: string: 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} -* **location**: string: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia -* **name**: string: Name of resource -* **plan**: [ArmPlan](#armplan): The plan object in an ARM, represents a marketplace plan -* **properties**: [ApiEntity](#apientity): API Management -* **sku**: [SkuDescription](#skudescription): Describes a sku for a scalable resource -* **tags**: [ResponseMessageEnvelopeApiEntityTags](#responsemessageenvelopeapientitytags): Tags associated with resource -* **type**: string: Type of resource e.g Microsoft.Web/sites - -## ArmPlan -### Properties -* **name**: string: The name -* **product**: string: The product -* **promotionCode**: string: The promotion code -* **publisher**: string: The publisher -* **version**: string: Version of product - ## ApiEntity ### Properties * **id**: string: Resource Id @@ -103,48 +51,11 @@ * **protocols**: string[]: Protocols supported by the front end - http/https * **runtimeUrls**: string[]: Read only property returning the runtime endpoints where the API can be called -## BackendServiceDefinition -### Properties -* **id**: string: Resource Id -* **kind**: string: Kind of resource -* **location**: string (Required): Resource Location -* **name**: string: Resource Name -* **properties**: [BackendServiceDefinitionProperties](#backendservicedefinitionproperties) -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string: Resource type - -## BackendServiceDefinitionProperties -### Properties -* **hostingEnvironmentServiceUrls**: [HostingEnvironmentServiceDescriptions](#hostingenvironmentservicedescriptions)[]: Service Urls per Hosting environment -* **serviceUrl**: string: Url from which the swagger payload will be fetched - -## HostingEnvironmentServiceDescriptions -### Properties -* **hostId**: string: Host Id -* **hostingEnvironmentId**: string: Hosting environment Id -* **serviceUrl**: string: service url to use -* **useInternalRouting**: bool: 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 - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiEntityPropertiesConnectionParameters ### Properties ### Additional Properties * **Additional Properties Type**: [ConnectionParameter](#connectionparameter) -## ConnectionParameter -### Properties -* **defaultValue**: any: Any object -* **oAuthSettings**: [ApiOAuthSettings](#apioauthsettings): OAuth settings for the connection provider -* **type**: 'array' | 'bool' | 'connection' | 'int' | 'oauthSetting' | 'object' | 'secureobject' | 'securestring' | 'string': Type of the parameter -* **uiDefinition**: any: Any object - ## ApiOAuthSettings ### Properties * **clientId**: string: Resource provider client id @@ -166,95 +77,155 @@ * **uiDefinition**: any: Any object * **value**: string: Value -## GeneralApiInformation +## ApiPolicies ### Properties * **id**: string: Resource Id * **kind**: string: Kind of resource * **location**: string (Required): Resource Location * **name**: string: Resource Name -* **properties**: [GeneralApiInformationProperties](#generalapiinformationproperties) +* **properties**: [ApiPoliciesProperties](#apipoliciesproperties) * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string: Resource type -## GeneralApiInformationProperties +## ApiPoliciesProperties ### Properties -* **connectionDisplayName**: string: DefaultConnectionNameTemplate -* **connectionPortalUrl**: any: Any object -* **description**: string: Description -* **displayName**: string: Display Name -* **iconUrl**: string: Icon Url -* **termsOfUseUrl**: string: a public accessible url of the Terms Of Use Url of this API +* **content**: string: Content of xml policy -## ResourceTags +## ArmPlan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name +* **product**: string: The product +* **promotionCode**: string: The promotion code +* **publisher**: string: The publisher +* **version**: string: Version of product -## ApiPolicies +## BackendServiceDefinition ### Properties * **id**: string: Resource Id * **kind**: string: Kind of resource * **location**: string (Required): Resource Location * **name**: string: Resource Name -* **properties**: [ApiPoliciesProperties](#apipoliciesproperties) +* **properties**: [BackendServiceDefinitionProperties](#backendservicedefinitionproperties) * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string: Resource type -## ApiPoliciesProperties +## BackendServiceDefinitionProperties ### Properties -* **content**: string: Content of xml policy +* **hostingEnvironmentServiceUrls**: [HostingEnvironmentServiceDescriptions](#hostingenvironmentservicedescriptions)[]: Service Urls per Hosting environment +* **serviceUrl**: string: Url from which the swagger payload will be fetched -## ResourceTags +## ConnectionError ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource Id +* **kind**: string: Kind of resource +* **location**: string (Required): Resource Location +* **name**: string: Resource Name +* **properties**: [ConnectionErrorProperties](#connectionerrorproperties) +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string: Resource type -## ResourceTags +## ConnectionErrorProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **code**: string: code of the status +* **message**: string: Description of the status -## SkuDescription +## ConnectionParameter ### Properties -* **capacity**: int: Current number of instances assigned to the resource -* **family**: string: Family code of the resource sku -* **name**: string: Name of the resource sku -* **size**: string: Size specifier of the resource sku -* **tier**: string: Service Tier of the resource sku +* **defaultValue**: any: Any object +* **oAuthSettings**: [ApiOAuthSettings](#apioauthsettings): OAuth settings for the connection provider +* **type**: 'array' | 'bool' | 'connection' | 'int' | 'oauthSetting' | 'object' | 'secureobject' | 'securestring' | 'string': Type of the parameter +* **uiDefinition**: any: Any object -## ResponseMessageEnvelopeApiEntityTags +## ConnectionProperties +### Properties +* **api**: [ExpandedParentApiEntity](#expandedparentapientity): expanded parent object for expansion +* **changedTime**: string: Timestamp of last connection change. +* **createdTime**: string: Timestamp of the connection creation +* **customParameterValues**: [ConnectionPropertiesCustomParameterValues](#connectionpropertiescustomparametervalues): Custom login setting values. +* **displayName**: string: display name +* **firstExpirationTime**: string: Time in UTC when the first expiration of OAuth tokens +* **keywords**: string[]: List of Keywords that tag the acl +* **metadata**: any: Any object +* **name**: string: connection name +* **nonSecretParameterValues**: [ConnectionPropertiesNonSecretParameterValues](#connectionpropertiesnonsecretparametervalues): Tokens/Claim +* **parameterValues**: [ConnectionPropertiesParameterValues](#connectionpropertiesparametervalues): Tokens/Claim +* **statuses**: [ConnectionStatus](#connectionstatus)[]: Status of the connection +* **tenantId**: string + +## ConnectionPropertiesCustomParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ParameterCustomLoginSettingValues](#parametercustomloginsettingvalues) -## ResourceTags +## ConnectionPropertiesNonSecretParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: any -## ConnectionPropertiesCustomParameterValues +## ConnectionPropertiesParameterValues ### Properties ### Additional Properties -* **Additional Properties Type**: [ParameterCustomLoginSettingValues](#parametercustomloginsettingvalues) +* **Additional Properties Type**: any -## ParameterCustomLoginSettingValues +## ConnectionSecrets +### Properties +* **connectionKey**: string (ReadOnly): Connection Key +* **parameterValues**: [ConnectionSecretsParameterValues](#connectionsecretsparametervalues) (ReadOnly): Tokens/Claim + +## ConnectionSecretsParameterValues +### Properties +### Additional Properties +* **Additional Properties Type**: any + +## ConnectionStatus ### Properties * **id**: string: Resource Id * **kind**: string: Kind of resource * **location**: string (Required): Resource Location * **name**: string: Resource Name -* **properties**: [ParameterCustomLoginSettingValuesProperties](#parametercustomloginsettingvaluesproperties) +* **properties**: [ConnectionStatusProperties](#connectionstatusproperties) * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string: Resource type -## ParameterCustomLoginSettingValuesProperties +## ConnectionStatusProperties ### Properties -* **customParameters**: [ParameterCustomLoginSettingValuesPropertiesCustomParameters](#parametercustomloginsettingvaluespropertiescustomparameters): Custom parameters. +* **error**: [ConnectionError](#connectionerror): Connection error +* **status**: string: Status +* **target**: string: Target of the error -## ParameterCustomLoginSettingValuesPropertiesCustomParameters +## ConsentLink ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomLoginSettingValue](#customloginsettingvalue) +* **displayName**: string (ReadOnly): Display Name of the parameter in the connection provider's oauthSettings +* **firstPartyLoginUri**: string (ReadOnly): Uri for first party login +* **link**: string (ReadOnly): Uri for the consent link +* **status**: 'Authenticated' | 'Error' | 'Unauthenticated' (ReadOnly): Status of the link + +## ConsentLinkInput +### Properties +* **id**: string (WriteOnly): Resource Id +* **kind**: string (WriteOnly): Kind of resource +* **location**: string (Required, WriteOnly): Resource Location +* **name**: string (WriteOnly): Resource Name +* **properties**: [ConsentLinkInputProperties](#consentlinkinputproperties) (WriteOnly) +* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags +* **type**: string (WriteOnly): Resource type + +## ConsentLinkInputParameter +### Properties +* **objectId**: string (WriteOnly): AAD OID (user or group) if the principal type is ActiveDirectory. + MSA PUID if the principal type is MicrosoftAccount. +* **parameterName**: string (WriteOnly): Name of the parameter in the connection provider's oauthSettings +* **principalType**: 'ActiveDirectory' | 'Connection' | 'MicrosoftAccount' (WriteOnly): Principal type +* **redirectUrl**: string (WriteOnly): Name of the parameter in the connection provider's oauthSettings +* **tenantId**: string (WriteOnly): Tenant Id + +## ConsentLinkInputProperties +### Properties +* **parameters**: [ConsentLinkInputParameter](#consentlinkinputparameter)[] (WriteOnly): Array of links + +## ConsentLinkPayload +### Properties +* **value**: [ConsentLink](#consentlink)[] (ReadOnly): Collection of resources ## CustomLoginSettingValue ### Properties @@ -270,56 +241,82 @@ ### Properties * **option**: string: Option selected for this custom login setting value -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ConnectionPropertiesNonSecretParameterValues +## ExpandedParentApiEntity ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **id**: string: Resource Id +* **kind**: string: Kind of resource +* **location**: string (Required): Resource Location +* **name**: string: Resource Name +* **properties**: [ExpandedParentApiEntityProperties](#expandedparentapientityproperties) +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string: Resource type -## ConnectionPropertiesParameterValues +## ExpandedParentApiEntityProperties ### Properties -### Additional Properties -* **Additional Properties Type**: any +* **entity**: [ResponseMessageEnvelopeApiEntity](#responsemessageenvelopeapientity): Message envelope that contains the common Azure resource manager properties and the resource provider specific content +* **id**: string: Id of connection provider -## ConnectionStatus +## GeneralApiInformation ### Properties * **id**: string: Resource Id * **kind**: string: Kind of resource * **location**: string (Required): Resource Location * **name**: string: Resource Name -* **properties**: [ConnectionStatusProperties](#connectionstatusproperties) +* **properties**: [GeneralApiInformationProperties](#generalapiinformationproperties) * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string: Resource type -## ConnectionStatusProperties +## GeneralApiInformationProperties ### Properties -* **error**: [ConnectionError](#connectionerror): Connection error -* **status**: string: Status -* **target**: string: Target of the error +* **connectionDisplayName**: string: DefaultConnectionNameTemplate +* **connectionPortalUrl**: any: Any object +* **description**: string: Description +* **displayName**: string: Display Name +* **iconUrl**: string: Icon Url +* **termsOfUseUrl**: string: a public accessible url of the Terms Of Use Url of this API -## ConnectionError +## HostingEnvironmentServiceDescriptions +### Properties +* **hostId**: string: Host Id +* **hostingEnvironmentId**: string: Hosting environment Id +* **serviceUrl**: string: service url to use +* **useInternalRouting**: bool: 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 + +## ListConnectionKeysInput +### Properties +* **id**: string (WriteOnly): Resource Id +* **kind**: string (WriteOnly): Kind of resource +* **location**: string (Required, WriteOnly): Resource Location +* **name**: string (WriteOnly): Resource Name +* **properties**: [ListConnectionKeysInputProperties](#listconnectionkeysinputproperties) (WriteOnly) +* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags +* **type**: string (WriteOnly): Resource type + +## ListConnectionKeysInputProperties +### Properties +* **validityTimeSpan**: string (WriteOnly): time span for how long the keys will be valid + +## ParameterCustomLoginSettingValues ### Properties * **id**: string: Resource Id * **kind**: string: Kind of resource * **location**: string (Required): Resource Location * **name**: string: Resource Name -* **properties**: [ConnectionErrorProperties](#connectionerrorproperties) +* **properties**: [ParameterCustomLoginSettingValuesProperties](#parametercustomloginsettingvaluesproperties) * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string: Resource type -## ConnectionErrorProperties +## ParameterCustomLoginSettingValuesProperties ### Properties -* **code**: string: code of the status -* **message**: string: Description of the status +* **customParameters**: [ParameterCustomLoginSettingValuesPropertiesCustomParameters](#parametercustomloginsettingvaluespropertiescustomparameters): Custom parameters. + +## ParameterCustomLoginSettingValuesPropertiesCustomParameters +### Properties +### Additional Properties +* **Additional Properties Type**: [CustomLoginSettingValue](#customloginsettingvalue) ## ResourceTags ### Properties @@ -336,71 +333,74 @@ ### Additional Properties * **Additional Properties Type**: string -## ListConnectionKeysInput +## ResourceTags ### Properties -* **id**: string (WriteOnly): Resource Id -* **kind**: string (WriteOnly): Kind of resource -* **location**: string (Required, WriteOnly): Resource Location -* **name**: string (WriteOnly): Resource Name -* **properties**: [ListConnectionKeysInputProperties](#listconnectionkeysinputproperties) (WriteOnly) -* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags -* **type**: string (WriteOnly): Resource type +### Additional Properties +* **Additional Properties Type**: string -## ListConnectionKeysInputProperties +## ResourceTags ### Properties -* **validityTimeSpan**: string (WriteOnly): time span for how long the keys will be valid +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionSecrets +## ResourceTags ### Properties -* **connectionKey**: string (ReadOnly): Connection Key -* **parameterValues**: [ConnectionSecretsParameterValues](#connectionsecretsparametervalues) (ReadOnly): Tokens/Claim +### Additional Properties +* **Additional Properties Type**: string -## ConnectionSecretsParameterValues +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: any +* **Additional Properties Type**: string -## ConsentLinkInput +## ResourceTags ### Properties -* **id**: string (WriteOnly): Resource Id -* **kind**: string (WriteOnly): Kind of resource -* **location**: string (Required, WriteOnly): Resource Location -* **name**: string (WriteOnly): Resource Name -* **properties**: [ConsentLinkInputProperties](#consentlinkinputproperties) (WriteOnly) -* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags -* **type**: string (WriteOnly): Resource type +### Additional Properties +* **Additional Properties Type**: string -## ConsentLinkInputProperties +## ResourceTags ### Properties -* **parameters**: [ConsentLinkInputParameter](#consentlinkinputparameter)[] (WriteOnly): Array of links +### Additional Properties +* **Additional Properties Type**: string -## ConsentLinkInputParameter +## ResourceTags ### Properties -* **objectId**: string (WriteOnly): AAD OID (user or group) if the principal type is ActiveDirectory. - MSA PUID if the principal type is MicrosoftAccount. -* **parameterName**: string (WriteOnly): Name of the parameter in the connection provider's oauthSettings -* **principalType**: 'ActiveDirectory' | 'Connection' | 'MicrosoftAccount' (WriteOnly): Principal type -* **redirectUrl**: string (WriteOnly): Name of the parameter in the connection provider's oauthSettings -* **tenantId**: string (WriteOnly): Tenant Id +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConsentLinkPayload +## ResponseMessageEnvelopeApiEntity ### Properties -* **value**: [ConsentLink](#consentlink)[] (ReadOnly): Collection of resources +* **id**: string: 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} +* **location**: string: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia +* **name**: string: Name of resource +* **plan**: [ArmPlan](#armplan): The plan object in an ARM, represents a marketplace plan +* **properties**: [ApiEntity](#apientity): API Management +* **sku**: [SkuDescription](#skudescription): Describes a sku for a scalable resource +* **tags**: [ResponseMessageEnvelopeApiEntityTags](#responsemessageenvelopeapientitytags): Tags associated with resource +* **type**: string: Type of resource e.g Microsoft.Web/sites -## ConsentLink +## ResponseMessageEnvelopeApiEntityTags ### Properties -* **displayName**: string (ReadOnly): Display Name of the parameter in the connection provider's oauthSettings -* **firstPartyLoginUri**: string (ReadOnly): Uri for first party login -* **link**: string (ReadOnly): Uri for the consent link -* **status**: 'Authenticated' | 'Error' | 'Unauthenticated' (ReadOnly): Status of the link +### Additional Properties +* **Additional Properties Type**: string + +## SkuDescription +### Properties +* **capacity**: int: Current number of instances assigned to the resource +* **family**: string: Family code of the resource sku +* **name**: string: Name of the resource sku +* **size**: string: Size specifier of the resource sku +* **tier**: string: Service Tier of the resource sku diff --git a/generated/web/microsoft.web/2015-08-01/types.md b/generated/web/microsoft.web/2015-08-01/types.md index b59ac58086..50a24f1cb6 100644 --- a/generated/web/microsoft.web/2015-08-01/types.md +++ b/generated/web/microsoft.web/2015-08-01/types.md @@ -702,6 +702,146 @@ * **Input**: [BackupRequest](#backuprequest) * **Output**: [BackupItem](#backupitem) +## ApiDefinitionInfo +### Properties +* **url**: string: The URL of the API definition. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to azure table storage configuration +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration + +## ArmPlan +### Properties +* **name**: string (WriteOnly): The name +* **product**: string (WriteOnly): The product +* **promotionCode**: string (WriteOnly): The promotion code +* **publisher**: string (WriteOnly): The publisher +* **version**: string (WriteOnly): Version of product + +## AutoHealActions +### Properties +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle' (Required): ActionType - predefined action to be taken +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): AutoHealCustomAction - Describes the custom action to be executed + when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: MinProcessExecutionTime - minimum time the process must execute + before taking the action + +## AutoHealCustomAction +### Properties +* **exe**: string: Executable to be run +* **parameters**: string: Parameters for the executable + +## AutoHealRules +### Properties +* **actions**: [AutoHealActions](#autohealactions): AutoHealActions - Describes the actions which can be + taken by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): AutoHealTriggers - describes the triggers for auto-heal. + +## AutoHealTriggers +### Properties +* **privateBytesInKB**: int: PrivateBytesInKB - Defines a rule based on private bytes +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): RequestsBasedTrigger +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): SlowRequestsBasedTrigger +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: StatusCodes - Defines a rule based on status codes + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level +* **retentionInDays**: int: Retention in days. + Remove blobs older than X days. + 0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: Enabled +* **retentionInDays**: int: Retention in days. + Remove blobs older than X days. + 0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions + +## AzureTableStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level +* **sasUrl**: string: SAS url to an azure table with add/query/delete permissions + +## BackupItem +### Properties +* **id**: string (ReadOnly): Resource Id +* **kind**: string (ReadOnly): Kind of resource +* **location**: string (ReadOnly): Resource Location +* **name**: string (ReadOnly): Resource Name +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly) +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type + +## BackupItem +### Properties +* **id**: string (ReadOnly): Resource Id +* **kind**: string (ReadOnly): Kind of resource +* **location**: string (ReadOnly): Resource Location +* **name**: string (ReadOnly): Resource Name +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly) +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type + +## BackupItemProperties +### Properties +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up + +## BackupRequest +### Properties +* **id**: string (WriteOnly): Resource Id +* **kind**: string (WriteOnly): Kind of resource +* **location**: string (Required, WriteOnly): Resource Location +* **name**: string (WriteOnly): Resource Name +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly) +* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags +* **type**: string (WriteOnly): Resource type + +## BackupRequest +### Properties +* **id**: string (WriteOnly): Resource Id +* **kind**: string (WriteOnly): Kind of resource +* **location**: string (Required, WriteOnly): Resource Location +* **name**: string (WriteOnly): Resource Name +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly) +* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags +* **type**: string (WriteOnly): Resource type + +## BackupRequestProperties +### Properties +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled +* **name**: string: Name of the backup +* **storageAccountUrl**: string: SAS URL to the container +* **type**: 'Clone' | 'Default' | 'Relocation' (Required): Type of the backup + +## BackupSchedule +### Properties +* **frequencyInterval**: int: 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string: The last time when this schedule was triggered +* **retentionPeriodInDays**: int: After how many days backups should be deleted +* **startTime**: string: When the schedule should start working + ## CertificateProperties ### Properties * **cerBlob**: string: Raw bytes of .cer file @@ -720,17 +860,55 @@ * **thumbprint**: string: Certificate thumbprint * **valid**: bool: Is the certificate valid? -## HostingEnvironmentProfile +## CloningInfo ### Properties -* **id**: string: Resource id of the hostingEnvironment (App Service Environment) -* **name**: string: Name of the hostingEnvironment (App Service Environment) (read only) -* **type**: string: Resource type of the hostingEnvironment (App Service Environment) (read only) +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: If true, clone custom hostnames from source web app +* **cloneSourceControl**: bool: Clone source control from source web app +* **configureLoadBalancing**: bool: If specified configure load balancing for source and clone site +* **correlationId**: string: Correlation Id of cloning operation. This id ties multiple cloning operations + together to use the same snapshot +* **hostingEnvironment**: string: Hosting environment +* **overwrite**: bool: Overwrite destination web app +* **sourceWebAppId**: 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 +* **trafficManagerProfileId**: 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} +* **trafficManagerProfileName**: string: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist -## ResourceTags +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties * **Additional Properties Type**: string +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnStringInfo +### Properties +* **connectionString**: string: Connection string value +* **name**: string: Name of connection string +* **type**: 'Custom' | 'MySql' | 'SQLAzure' | 'SQLServer' (Required): Type of database + +## ConnStringValueTypePair +### Properties +* **type**: 'Custom' | 'MySql' | 'SQLAzure' | 'SQLServer' (Required): Type of database +* **value**: string: Value of pair + +## CorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + ## CsrProperties ### Properties * **csrString**: string: Actual CSR string created @@ -741,10 +919,60 @@ * **pfxBlob**: string: PFX certificate of created certificate * **publicKeyHash**: string: Hash of the certificates public key -## ResourceTags +## DatabaseBackupSetting ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. + This is used during restore with overwrite connection strings options. +* **databaseType**: string: SqlAzure / MySql +* **name**: string + +## DeploymentProperties +### Properties +* **active**: bool: Active +* **author**: string: Author +* **author_email**: string: AuthorEmail +* **deployer**: string: Deployer +* **details**: string: Detail +* **end_time**: string: EndTime +* **id**: string: Id +* **message**: string: Message +* **start_time**: string: StartTime +* **status**: int: Status + +## EnabledConfig +### Properties +* **enabled**: bool: Enabled + +## Experiments +### Properties +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. + +## FileSystemApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: Enabled +* **retentionInDays**: int: Retention in days. + Remove files older than X days. + 0 or lower means no retention. +* **retentionInMb**: int: 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. + +## HandlerMapping +### Properties +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. + +## HostingEnvironmentProfile +### Properties +* **id**: string: Resource id of the hostingEnvironment (App Service Environment) +* **name**: string: Name of the hostingEnvironment (App Service Environment) (read only) +* **type**: string: Resource type of the hostingEnvironment (App Service Environment) (read only) ## HostingEnvironmentProperties ### Properties @@ -782,27 +1010,38 @@ * **vnetSubnetName**: string: Subnet of the hostingEnvironment's (App Service Environment) virtual network * **workerPools**: [WorkerPool](#workerpool)[]: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool -## NameValuePair +## HostNameBindingProperties ### Properties -* **name**: string: Pair name -* **value**: string: Pair value +* **azureResourceName**: string: Azure resource name +* **azureResourceType**: 'TrafficManager' | 'Website': Type of the Azure resource the hostname is assigned to +* **customHostNameDnsRecordType**: 'A' | 'CName': Type of the Dns record +* **domainId**: string: Fully qualified ARM domain resource URI +* **hostNameType**: 'Managed' | 'Verified': Type of the hostname +* **name**: string: Hostname +* **siteName**: string: Web app name -## StampCapacity +## HostNameSslState ### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...) -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared or dedicated web app hosting -* **excludeFromCapacityAllocation**: bool: If true it includes basic sites - Basic sites are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: Is capacity applicable for all sites? -* **name**: string: Name of the stamp -* **siteMode**: string: Shared or Dedicated -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...) -* **unit**: string: Name of the unit -* **workerSize**: 'Default' | 'Large' | 'Medium' | 'Small': Size of the machines -* **workerSizeId**: int: Size Id of machines: - 0 - Small - 1 - Medium - 2 - Large +* **name**: string: Host name +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled' (Required): SSL type +* **thumbprint**: string: SSL cert thumbprint +* **toUpdate**: bool: Set this flag to update existing host name +* **virtualIP**: string: Virtual IP address assigned to the host name if IP based SSL is enabled + +## HttpLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration + +## IpSecurityRestriction +### Properties +* **ipAddress**: string: IP address the security restriction is valid for +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for + +## NameValuePair +### Properties +* **name**: string: Pair name +* **value**: string: Pair value ## NetworkAccessControlEntry ### Properties @@ -811,46 +1050,44 @@ * **order**: int * **remoteSubnet**: string -## VirtualIPMapping +## PremierAddOnRequestTags ### Properties -* **internalHttpPort**: int: Internal HTTP port -* **internalHttpsPort**: int: Internal HTTPS port -* **inUse**: bool: Is VIP mapping in use -* **virtualIP**: string: Virtual IP address +### Additional Properties +* **Additional Properties Type**: string -## VirtualNetworkProfile +## PremierAddOnRequestTags ### Properties -* **id**: string: Resource id of the virtual network -* **name**: string: Name of the virtual network (read-only) -* **subnet**: string: Subnet within the virtual network -* **type**: string: Resource type of the virtual network (read-only) +### Additional Properties +* **Additional Properties Type**: string -## WorkerPool +## RampUpRule ### Properties -* **id**: string: Resource Id -* **kind**: string: Kind of resource -* **location**: string (Required): Resource Location -* **name**: string: Resource Name -* **properties**: [WorkerPoolProperties](#workerpoolproperties) -* **sku**: [SkuDescription](#skudescription): Describes a sku for a scalable resource -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string: Resource type +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage +* **changeStep**: int: [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} +* **maxReroutePercentage**: int: [Optional] Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: [Optional] Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} -## WorkerPoolProperties +## RelayServiceConnectionEntityProperties ### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared or dedicated web app hosting -* **instanceNames**: string[]: Names of all instances in the worker pool (read only) -* **workerCount**: int: Number of instances in the worker pool -* **workerSize**: string: VM size of the worker pool instances -* **workerSizeId**: int: Worker size id for referencing this worker pool +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## SkuDescription +## RequestsBasedTrigger ### Properties -* **capacity**: int: Current number of instances assigned to the resource -* **family**: string: Family code of the resource sku -* **name**: string: Name of the resource sku -* **size**: string: Size specifier of the resource sku -* **tier**: string: Service Tier of the resource sku +* **count**: int: Count +* **timeInterval**: string: TimeInterval ## ResourceTags ### Properties @@ -877,296 +1114,80 @@ ### Additional Properties * **Additional Properties Type**: string -## UserProperties +## ResourceTags ### Properties -* **name**: string: Username (internal) -* **publishingPassword**: string: Password used for publishing -* **publishingUserName**: string: Username used for publishing -* **scmUri**: string: Service Control Manager URI, including username and password +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ServerFarmWithRichSkuProperties +## ResourceTags ### Properties -* **adminSiteName**: string: App Service Plan administration site -* **geoRegion**: string (ReadOnly): Geographical location for the App Service Plan -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for a hostingEnvironment (App Service Environment) to use for this resource -* **maximumNumberOfWorkers**: int: Maximum number of instances that can be assigned to this App Service Plan -* **name**: string: Name for the App Service Plan -* **numberOfSites**: int (ReadOnly): Number of web apps assigned to this App Service Plan -* **perSiteScaling**: bool: 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 -* **reserved**: bool: Enables creation of a Linux App Service Plan -* **resourceGroup**: string (ReadOnly): Resource group of the server farm -* **status**: 'Pending' | 'Ready' (Required, ReadOnly): App Service Plan Status -* **subscription**: string (ReadOnly): App Service Plan Subscription -* **workerTierName**: string: Target worker tier assigned to the App Service Plan +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VnetGatewayProperties +## ResourceTags ### Properties -* **vnetName**: string: The VNET name. -* **vpnPackageUri**: string: The URI where the Vpn package can be downloaded +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## VnetRouteProperties +## ResourceTags ### Properties -* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **name**: string (WriteOnly): The name of this route. This is only returned by the server and does not need to be set by the client. -* **routeType**: string (WriteOnly): 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. -* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SiteProperties +## ResourceTags ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (Required, ReadOnly): Management information availability state for the web app. Possible values are Normal or Limited. - Normal means that the site is running correctly and that management information for the site is available. - Limited means that only partial management information for the site is available and that detailed site information is unavailable. -* **clientAffinityEnabled**: bool: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app -* **clientCertEnabled**: bool: Specifies if the client certificate is enabled for the web app -* **cloningInfo**: [CloningInfo](#cloninginfo): Represents information needed for cloning operation -* **containerSize**: int: Size of a function container -* **defaultHostName**: string (ReadOnly): Default hostname of the web app -* **enabled**: bool: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). -* **enabledHostNames**: string[] (ReadOnly): Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled - the app is not served on those hostnames -* **gatewaySiteName**: string: Name of gateway app associated with web app -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for a hostingEnvironment (App Service Environment) to use for this resource -* **hostNames**: string[] (ReadOnly): Hostnames associated with web app -* **hostNamesDisabled**: bool: Specifies if the public hostnames are disabled the web app. - If set to true the app is only accessible via API Management process -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for site's hostnames. -* **isDefaultContainer**: bool (ReadOnly): Site is a default container -* **lastModifiedTimeUtc**: string (ReadOnly): Last time web app was modified in UTC -* **maxNumberOfWorkers**: int: Maximum number of workers - This only applies to function container -* **microService**: string -* **name**: string: Name of web app -* **outboundIpAddresses**: string (ReadOnly): List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. -* **premiumAppDeployed**: bool (ReadOnly): If set indicates whether web app is deployed as a premium app -* **repositorySiteName**: string (ReadOnly): Name of repository site -* **resourceGroup**: string (ReadOnly): Resource group web app belongs to -* **scmSiteAlsoStopped**: bool: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. -* **serverFarmId**: string -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of Azure web site -* **state**: string (ReadOnly): State of the web app -* **targetSwapSlot**: string (ReadOnly): Read-only property that specifies which slot this app will swap into -* **trafficManagerHostNames**: string[] (ReadOnly): Read-only list of Azure Traffic manager hostnames associated with web app -* **usageState**: 'Exceeded' | 'Normal' (Required, ReadOnly): State indicating whether web app has exceeded its quota usage +### Additional Properties +* **Additional Properties Type**: string -## CloningInfo +## ResourceTags ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: If true, clone custom hostnames from source web app -* **cloneSourceControl**: bool: Clone source control from source web app -* **configureLoadBalancing**: bool: If specified configure load balancing for source and clone site -* **correlationId**: string: Correlation Id of cloning operation. This id ties multiple cloning operations - together to use the same snapshot -* **hostingEnvironment**: string: Hosting environment -* **overwrite**: bool: Overwrite destination web app -* **sourceWebAppId**: 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 -* **trafficManagerProfileId**: 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} -* **trafficManagerProfileName**: string: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist +### Additional Properties +* **Additional Properties Type**: string -## CloningInfoAppSettingsOverrides +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostNameSslState +## ResourceTags ### Properties -* **name**: string: Host name -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled' (Required): SSL type -* **thumbprint**: string: SSL cert thumbprint -* **toUpdate**: bool: Set this flag to update existing host name -* **virtualIP**: string: Virtual IP address assigned to the host name if IP based SSL is enabled +### Additional Properties +* **Additional Properties Type**: string -## SiteConfig +## ResourceTags ### Properties -* **id**: string: Resource Id -* **kind**: string: Kind of resource -* **location**: string (Required): Resource Location -* **name**: string: Resource Name -* **properties**: [SiteConfigProperties](#siteconfigproperties) -* **tags**: [ResourceTags](#resourcetags): Resource tags -* **type**: string: Resource type +### Additional Properties +* **Additional Properties Type**: string -## SiteConfigProperties +## ResourceTags ### Properties -* **alwaysOn**: bool: Always On -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the web app. -* **appCommandLine**: string: App Command Line to launch -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application Settings -* **autoHealEnabled**: bool: Auto heal enabled -* **autoHealRules**: [AutoHealRules](#autohealrules): AutoHealRules - describes the rules which can be defined for auto-heal -* **autoSwapSlotName**: string: Auto swap slot name -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the web app. -* **defaultDocuments**: string[]: Default documents -* **detailedErrorLoggingEnabled**: bool: Detailed error logging enabled -* **documentRoot**: string: Document root -* **experiments**: [Experiments](#experiments): Class containing Routing in production experiments -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings -* **httpLoggingEnabled**: bool: HTTP logging Enabled -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: Ip Security restrictions -* **javaContainer**: string: Java container -* **javaContainerVersion**: string: Java container version -* **javaVersion**: string: Java version -* **limits**: [SiteLimits](#sitelimits): Represents metric limits set on a web app. -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing -* **localMySqlEnabled**: bool: Local mysql enabled -* **logsDirectorySizeLimit**: int: HTTP Logs Directory size limit -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode -* **metadata**: [NameValuePair](#namevaluepair)[]: Site Metadata -* **netFrameworkVersion**: string: Net Framework Version -* **nodeVersion**: string: Version of Node -* **numberOfWorkers**: int: Number of workers -* **phpVersion**: string: Version of PHP -* **publishingPassword**: string: Publishing password -* **publishingUsername**: string: Publishing user name -* **pythonVersion**: string: Version of Python -* **remoteDebuggingEnabled**: bool: Remote Debugging Enabled -* **remoteDebuggingVersion**: string: Remote Debugging Version -* **requestTracingEnabled**: bool: Enable request tracing -* **requestTracingExpirationTime**: string: Request tracing expiration time -* **scmType**: string: SCM type -* **tracingOptions**: string: Tracing options -* **use32BitWorkerProcess**: bool: Use 32 bit worker process -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications -* **vnetName**: string: Vnet name -* **webSocketsEnabled**: bool: Web socket enabled. - -## ApiDefinitionInfo -### Properties -* **url**: string: The URL of the API definition. - -## AutoHealRules -### Properties -* **actions**: [AutoHealActions](#autohealactions): AutoHealActions - Describes the actions which can be - taken by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): AutoHealTriggers - describes the triggers for auto-heal. - -## AutoHealActions -### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle' (Required): ActionType - predefined action to be taken -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): AutoHealCustomAction - Describes the custom action to be executed - when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: MinProcessExecutionTime - minimum time the process must execute - before taking the action - -## AutoHealCustomAction -### Properties -* **exe**: string: Executable to be run -* **parameters**: string: Parameters for the executable - -## AutoHealTriggers -### Properties -* **privateBytesInKB**: int: PrivateBytesInKB - Defines a rule based on private bytes -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): RequestsBasedTrigger -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): SlowRequestsBasedTrigger -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: StatusCodes - Defines a rule based on status codes - -## RequestsBasedTrigger -### Properties -* **count**: int: Count -* **timeInterval**: string: TimeInterval - -## SlowRequestsBasedTrigger -### Properties -* **count**: int: Count -* **timeInterval**: string: TimeInterval -* **timeTaken**: string: TimeTaken - -## StatusCodesBasedTrigger -### Properties -* **count**: int: Count -* **status**: int: HTTP status code -* **subStatus**: int: SubStatus -* **timeInterval**: string: TimeInterval -* **win32Status**: int: Win32 error code - -## ConnStringInfo -### Properties -* **connectionString**: string: Connection string value -* **name**: string: Name of connection string -* **type**: 'Custom' | 'MySql' | 'SQLAzure' | 'SQLServer' (Required): Type of database - -## CorsSettings -### Properties -* **allowedOrigins**: string[]: 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. - -## Experiments -### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. - -## RampUpRule -### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: [Optional] Specifies interval in minutes to reevaluate ReroutePercentage -* **changeStep**: int: [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} -* **maxReroutePercentage**: int: [Optional] Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: [Optional] Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} - -## HandlerMapping -### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. - -## IpSecurityRestriction -### Properties -* **ipAddress**: string: IP address the security restriction is valid for -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for - -## SiteLimits -### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage - -## VirtualApplication -### Properties -* **physicalPath**: string -* **preloadEnabled**: bool -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Array of VirtualDirectory -* **virtualPath**: string +### Additional Properties +* **Additional Properties Type**: string -## VirtualDirectory +## ResourceTags ### Properties -* **physicalPath**: string -* **virtualPath**: string +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1178,33 +1199,22 @@ ### Additional Properties * **Additional Properties Type**: string -## RestoreRequestProperties +## ResourceTags ### Properties -* **adjustConnectionStrings**: bool: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site -* **blobName**: string: Name of a blob which contains the backup -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Collection of databases which should be restored. This list has to match the list of databases included in the backup. -* **hostingEnvironment**: string: App Service Environment name, if needed (only when restoring a site to an App Service Environment) -* **ignoreConflictingHostNames**: bool: 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. -* **operationType**: 'Clone' | 'Default' | 'Relocation' (Required): Type of the backup -* **overwrite**: bool: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. -* **siteName**: string: Name of a site (Web App) -* **storageAccountUrl**: string: SAS URL to the container +### Additional Properties +* **Additional Properties Type**: string -## DatabaseBackupSetting +## ResourceTags ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. - This is used during restore with overwrite connection strings options. -* **databaseType**: string: SqlAzure / MySql -* **name**: string +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionaryProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1214,107 +1224,87 @@ ### Additional Properties * **Additional Properties Type**: string -## BackupRequestProperties +## ResourceTags ### Properties -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled -* **name**: string: Name of the backup -* **storageAccountUrl**: string: SAS URL to the container -* **type**: 'Clone' | 'Default' | 'Relocation' (Required): Type of the backup +### Additional Properties +* **Additional Properties Type**: string -## BackupSchedule +## ResourceTags ### Properties -* **frequencyInterval**: int: 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string: The last time when this schedule was triggered -* **retentionPeriodInDays**: int: After how many days backups should be deleted -* **startTime**: string: When the schedule should start working +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## ConnectionStringDictionaryProperties +## ResourceTags ### Properties ### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **Additional Properties Type**: string -## ConnStringValueTypePair +## ResourceTags ### Properties -* **type**: 'Custom' | 'MySql' | 'SQLAzure' | 'SQLServer' (Required): Type of database -* **value**: string: Value of pair +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## SiteLogsConfigProperties +## ResourceTags ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration +### Additional Properties +* **Additional Properties Type**: string -## ApplicationLogsConfig +## ResourceTags ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to azure table storage configuration -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration +### Additional Properties +* **Additional Properties Type**: string -## AzureBlobStorageApplicationLogsConfig +## ResourceTags ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level -* **retentionInDays**: int: Retention in days. - Remove blobs older than X days. - 0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions +### Additional Properties +* **Additional Properties Type**: string -## AzureTableStorageApplicationLogsConfig +## ResourceTags ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level -* **sasUrl**: string: SAS url to an azure table with add/query/delete permissions +### Additional Properties +* **Additional Properties Type**: string -## FileSystemApplicationLogsConfig +## ResourceTags ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level +### Additional Properties +* **Additional Properties Type**: string -## EnabledConfig +## ResourceTags ### Properties -* **enabled**: bool: Enabled +### Additional Properties +* **Additional Properties Type**: string -## HttpLogsConfig +## ResourceTags ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration +### Additional Properties +* **Additional Properties Type**: string -## AzureBlobStorageHttpLogsConfig +## ResourceTags ### Properties -* **enabled**: bool: Enabled -* **retentionInDays**: int: Retention in days. - Remove blobs older than X days. - 0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions +### Additional Properties +* **Additional Properties Type**: string -## FileSystemHttpLogsConfig +## ResourceTags ### Properties -* **enabled**: bool: Enabled -* **retentionInDays**: int: Retention in days. - Remove files older than X days. - 0 or lower means no retention. -* **retentionInMb**: int: 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. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionaryProperties +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1324,10 +1314,10 @@ ### Additional Properties * **Additional Properties Type**: string -## SlotConfigNamesResourceProperties +## ResourceTags ### Properties -* **appSettingNames**: string[]: List of application settings names -* **connectionStringNames**: string[]: List of connection string names +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -1339,108 +1329,221 @@ ### Additional Properties * **Additional Properties Type**: string -## DeploymentProperties +## RestoreRequestProperties ### Properties -* **active**: bool: Active -* **author**: string: Author -* **author_email**: string: AuthorEmail -* **deployer**: string: Deployer -* **details**: string: Detail -* **end_time**: string: EndTime -* **id**: string: Id -* **message**: string: Message -* **start_time**: string: StartTime -* **status**: int: Status +* **adjustConnectionStrings**: bool: Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site +* **blobName**: string: Name of a blob which contains the backup +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Collection of databases which should be restored. This list has to match the list of databases included in the backup. +* **hostingEnvironment**: string: App Service Environment name, if needed (only when restoring a site to an App Service Environment) +* **ignoreConflictingHostNames**: bool: 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. +* **operationType**: 'Clone' | 'Default' | 'Relocation' (Required): Type of the backup +* **overwrite**: bool: True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. +* **siteName**: string: Name of a site (Web App) +* **storageAccountUrl**: string: SAS URL to the container -## ResourceTags +## ServerFarmWithRichSkuProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **adminSiteName**: string: App Service Plan administration site +* **geoRegion**: string (ReadOnly): Geographical location for the App Service Plan +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for a hostingEnvironment (App Service Environment) to use for this resource +* **maximumNumberOfWorkers**: int: Maximum number of instances that can be assigned to this App Service Plan +* **name**: string: Name for the App Service Plan +* **numberOfSites**: int (ReadOnly): Number of web apps assigned to this App Service Plan +* **perSiteScaling**: bool: 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 +* **reserved**: bool: Enables creation of a Linux App Service Plan +* **resourceGroup**: string (ReadOnly): Resource group of the server farm +* **status**: 'Pending' | 'Ready' (Required, ReadOnly): App Service Plan Status +* **subscription**: string (ReadOnly): App Service Plan Subscription +* **workerTierName**: string: Target worker tier assigned to the App Service Plan -## HostNameBindingProperties +## SiteConfig ### Properties -* **azureResourceName**: string: Azure resource name -* **azureResourceType**: 'TrafficManager' | 'Website': Type of the Azure resource the hostname is assigned to -* **customHostNameDnsRecordType**: 'A' | 'CName': Type of the Dns record -* **domainId**: string: Fully qualified ARM domain resource URI -* **hostNameType**: 'Managed' | 'Verified': Type of the hostname -* **name**: string: Hostname -* **siteName**: string: Web app name +* **id**: string: Resource Id +* **kind**: string: Kind of resource +* **location**: string (Required): Resource Location +* **name**: string: Resource Name +* **properties**: [SiteConfigProperties](#siteconfigproperties) +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string: Resource type -## ResourceTags +## SiteConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **alwaysOn**: bool: Always On +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the web app. +* **appCommandLine**: string: App Command Line to launch +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application Settings +* **autoHealEnabled**: bool: Auto heal enabled +* **autoHealRules**: [AutoHealRules](#autohealrules): AutoHealRules - describes the rules which can be defined for auto-heal +* **autoSwapSlotName**: string: Auto swap slot name +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the web app. +* **defaultDocuments**: string[]: Default documents +* **detailedErrorLoggingEnabled**: bool: Detailed error logging enabled +* **documentRoot**: string: Document root +* **experiments**: [Experiments](#experiments): Class containing Routing in production experiments +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings +* **httpLoggingEnabled**: bool: HTTP logging Enabled +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: Ip Security restrictions +* **javaContainer**: string: Java container +* **javaContainerVersion**: string: Java container version +* **javaVersion**: string: Java version +* **limits**: [SiteLimits](#sitelimits): Represents metric limits set on a web app. +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing +* **localMySqlEnabled**: bool: Local mysql enabled +* **logsDirectorySizeLimit**: int: HTTP Logs Directory size limit +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode +* **metadata**: [NameValuePair](#namevaluepair)[]: Site Metadata +* **netFrameworkVersion**: string: Net Framework Version +* **nodeVersion**: string: Version of Node +* **numberOfWorkers**: int: Number of workers +* **phpVersion**: string: Version of PHP +* **publishingPassword**: string: Publishing password +* **publishingUsername**: string: Publishing user name +* **pythonVersion**: string: Version of Python +* **remoteDebuggingEnabled**: bool: Remote Debugging Enabled +* **remoteDebuggingVersion**: string: Remote Debugging Version +* **requestTracingEnabled**: bool: Enable request tracing +* **requestTracingExpirationTime**: string: Request tracing expiration time +* **scmType**: string: SCM type +* **tracingOptions**: string: Tracing options +* **use32BitWorkerProcess**: bool: Use 32 bit worker process +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications +* **vnetName**: string: Vnet name +* **webSocketsEnabled**: bool: Web socket enabled. -## RelayServiceConnectionEntityProperties +## SiteLimits ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage -## ResourceTags +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (Required, ReadOnly): Management information availability state for the web app. Possible values are Normal or Limited. + Normal means that the site is running correctly and that management information for the site is available. + Limited means that only partial management information for the site is available and that detailed site information is unavailable. +* **clientAffinityEnabled**: bool: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app +* **clientCertEnabled**: bool: Specifies if the client certificate is enabled for the web app +* **cloningInfo**: [CloningInfo](#cloninginfo): Represents information needed for cloning operation +* **containerSize**: int: Size of a function container +* **defaultHostName**: string (ReadOnly): Default hostname of the web app +* **enabled**: bool: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). +* **enabledHostNames**: string[] (ReadOnly): Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled + the app is not served on those hostnames +* **gatewaySiteName**: string: Name of gateway app associated with web app +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for a hostingEnvironment (App Service Environment) to use for this resource +* **hostNames**: string[] (ReadOnly): Hostnames associated with web app +* **hostNamesDisabled**: bool: Specifies if the public hostnames are disabled the web app. + If set to true the app is only accessible via API Management process +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for site's hostnames. +* **isDefaultContainer**: bool (ReadOnly): Site is a default container +* **lastModifiedTimeUtc**: string (ReadOnly): Last time web app was modified in UTC +* **maxNumberOfWorkers**: int: Maximum number of workers + This only applies to function container +* **microService**: string +* **name**: string: Name of web app +* **outboundIpAddresses**: string (ReadOnly): List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. +* **premiumAppDeployed**: bool (ReadOnly): If set indicates whether web app is deployed as a premium app +* **repositorySiteName**: string (ReadOnly): Name of repository site +* **resourceGroup**: string (ReadOnly): Resource group web app belongs to +* **scmSiteAlsoStopped**: bool: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. +* **serverFarmId**: string +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of Azure web site +* **state**: string (ReadOnly): State of the web app +* **targetSwapSlot**: string (ReadOnly): Read-only property that specifies which slot this app will swap into +* **trafficManagerHostNames**: string[] (ReadOnly): Read-only list of Azure Traffic manager hostnames associated with web app +* **usageState**: 'Exceeded' | 'Normal' (Required, ReadOnly): State indicating whether web app has exceeded its quota usage -## ArmPlan +## SiteSourceControlProperties ### Properties -* **name**: string (WriteOnly): The name -* **product**: string (WriteOnly): The product -* **promotionCode**: string (WriteOnly): The promotion code -* **publisher**: string (WriteOnly): The publisher -* **version**: string (WriteOnly): Version of product +* **branch**: string: Name of branch to use for deployment +* **deploymentRollbackEnabled**: bool: Whether to manual or continuous integration +* **isManualIntegration**: bool: Whether to manual or continuous integration +* **isMercurial**: bool: Mercurial or Git repository type +* **repoUrl**: string: Repository or source control url -## PremierAddOnRequestTags +## SkuDescription ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **capacity**: int: Current number of instances assigned to the resource +* **family**: string: Family code of the resource sku +* **name**: string: Name of the resource sku +* **size**: string: Size specifier of the resource sku +* **tier**: string: Service Tier of the resource sku -## ResourceTags +## SlotConfigNamesResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appSettingNames**: string[]: List of application settings names +* **connectionStringNames**: string[]: List of connection string names -## ResourceTags +## SlowRequestsBasedTrigger ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **count**: int: Count +* **timeInterval**: string: TimeInterval +* **timeTaken**: string: TimeTaken -## StringDictionaryProperties +## SourceControlProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **expirationTime**: string: OAuth Token Expiration +* **name**: string: Name or Source Control Type +* **refreshToken**: string: OAuth Refresh Token +* **token**: string: OAuth Access Token +* **tokenSecret**: string: OAuth Access Token Secret -## ResourceTags +## StampCapacity ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...) +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared or dedicated web app hosting +* **excludeFromCapacityAllocation**: bool: If true it includes basic sites + Basic sites are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: Is capacity applicable for all sites? +* **name**: string: Name of the stamp +* **siteMode**: string: Shared or Dedicated +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...) +* **unit**: string: Name of the unit +* **workerSize**: 'Default' | 'Large' | 'Medium' | 'Small': Size of the machines +* **workerSizeId**: int: Size Id of machines: + 0 - Small + 1 - Medium + 2 - Large -## ResourceTags +## StatusCodesBasedTrigger ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **count**: int: Count +* **status**: int: HTTP status code +* **subStatus**: int: SubStatus +* **timeInterval**: string: TimeInterval +* **win32Status**: int: Win32 error code -## ConnectionStringDictionaryProperties +## StringDictionary ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **id**: string (ReadOnly): Resource Id +* **kind**: string (ReadOnly): Kind of resource +* **location**: string (ReadOnly): Resource Location +* **name**: string (ReadOnly): Resource Name +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type -## ResourceTags +## StringDictionary ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id +* **kind**: string (ReadOnly): Kind of resource +* **location**: string (ReadOnly): Resource Location +* **name**: string (ReadOnly): Resource Name +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings +* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags +* **type**: string (ReadOnly): Resource type -## ResourceTags +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1450,53 +1553,58 @@ ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## ResourceTags +## UserProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: Username (internal) +* **publishingPassword**: string: Password used for publishing +* **publishingUserName**: string: Username used for publishing +* **scmUri**: string: Service Control Manager URI, including username and password -## ResourceTags +## VirtualApplication ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **physicalPath**: string +* **preloadEnabled**: bool +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Array of VirtualDirectory +* **virtualPath**: string -## ResourceTags +## VirtualDirectory ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **physicalPath**: string +* **virtualPath**: string -## PremierAddOnRequestTags +## VirtualIPMapping ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **internalHttpPort**: int: Internal HTTP port +* **internalHttpsPort**: int: Internal HTTPS port +* **inUse**: bool: Is VIP mapping in use +* **virtualIP**: string: Virtual IP address -## SiteSourceControlProperties +## VirtualNetworkProfile ### Properties -* **branch**: string: Name of branch to use for deployment -* **deploymentRollbackEnabled**: bool: Whether to manual or continuous integration -* **isManualIntegration**: bool: Whether to manual or continuous integration -* **isMercurial**: bool: Mercurial or Git repository type -* **repoUrl**: string: Repository or source control url +* **id**: string: Resource id of the virtual network +* **name**: string: Name of the virtual network (read-only) +* **subnet**: string: Subnet within the virtual network +* **type**: string: Resource type of the virtual network (read-only) -## ResourceTags +## VnetGatewayProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **vnetName**: string: The VNET name. +* **vpnPackageUri**: string: The URI where the Vpn package can be downloaded ## VnetInfoProperties ### Properties @@ -1518,143 +1626,35 @@ * **tags**: [ResourceTags](#resourcetags): Resource tags * **type**: string: Resource type -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SourceControlProperties -### Properties -* **expirationTime**: string: OAuth Token Expiration -* **name**: string: Name or Source Control Type -* **refreshToken**: string: OAuth Refresh Token -* **token**: string: OAuth Access Token -* **tokenSecret**: string: OAuth Access Token Secret - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionary -### Properties -* **id**: string (ReadOnly): Resource Id -* **kind**: string (ReadOnly): Kind of resource -* **location**: string (ReadOnly): Resource Location -* **name**: string (ReadOnly): Resource Name -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionary -### Properties -* **id**: string (ReadOnly): Resource Id -* **kind**: string (ReadOnly): Kind of resource -* **location**: string (ReadOnly): Resource Location -* **name**: string (ReadOnly): Resource Name -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## BackupRequest -### Properties -* **id**: string (WriteOnly): Resource Id -* **kind**: string (WriteOnly): Kind of resource -* **location**: string (Required, WriteOnly): Resource Location -* **name**: string (WriteOnly): Resource Name -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly) -* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags -* **type**: string (WriteOnly): Resource type - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupItem -### Properties -* **id**: string (ReadOnly): Resource Id -* **kind**: string (ReadOnly): Kind of resource -* **location**: string (ReadOnly): Resource Location -* **name**: string (ReadOnly): Resource Name -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly) -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type - -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up - -## ResourceTags +## VnetRouteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **name**: string (WriteOnly): The name of this route. This is only returned by the server and does not need to be set by the client. +* **routeType**: string (WriteOnly): 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. +* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. -## BackupRequest +## WorkerPool ### Properties -* **id**: string (WriteOnly): Resource Id -* **kind**: string (WriteOnly): Kind of resource -* **location**: string (Required, WriteOnly): Resource Location -* **name**: string (WriteOnly): Resource Name -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly) -* **tags**: [ResourceTags](#resourcetags) (WriteOnly): Resource tags -* **type**: string (WriteOnly): Resource type +* **id**: string: Resource Id +* **kind**: string: Kind of resource +* **location**: string (Required): Resource Location +* **name**: string: Resource Name +* **properties**: [WorkerPoolProperties](#workerpoolproperties) +* **sku**: [SkuDescription](#skudescription): Describes a sku for a scalable resource +* **tags**: [ResourceTags](#resourcetags): Resource tags +* **type**: string: Resource type -## BackupItem +## WorkerPoolProperties ### Properties -* **id**: string (ReadOnly): Resource Id -* **kind**: string (ReadOnly): Kind of resource -* **location**: string (ReadOnly): Resource Location -* **name**: string (ReadOnly): Resource Name -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly) -* **tags**: [ResourceTags](#resourcetags) (ReadOnly): Resource tags -* **type**: string (ReadOnly): Resource type +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared or dedicated web app hosting +* **instanceNames**: string[]: Names of all instances in the worker pool (read only) +* **workerCount**: int: Number of instances in the worker pool +* **workerSize**: string: VM size of the worker pool instances +* **workerSizeId**: int: Worker size id for referencing this worker pool diff --git a/generated/web/microsoft.web/2016-03-01/types.md b/generated/web/microsoft.web/2016-03-01/types.md index b95647c7ef..41e6d6f03f 100644 --- a/generated/web/microsoft.web/2016-03-01/types.md +++ b/generated/web/microsoft.web/2016-03-01/types.md @@ -66,14 +66,6 @@ ### Additional Properties * **Additional Properties Type**: string -## UserProperties -### Properties -* **name**: string: Username -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. - ## SourceControlProperties ### Properties * **expirationTime**: string: OAuth token expiration. @@ -82,3 +74,11 @@ * **token**: string: OAuth access token. * **tokenSecret**: string: OAuth access token secret. +## UserProperties +### Properties +* **name**: string: Username +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. + diff --git a/generated/web/microsoft.web/2016-06-01/types.json b/generated/web/microsoft.web/2016-06-01/types.json index d9a3ae3e76..8fc760190d 100644 --- a/generated/web/microsoft.web/2016-06-01/types.json +++ b/generated/web/microsoft.web/2016-06-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/connectionGateways"}},{"6":{"Value":"2016-06-01"}},{"2":{"Name":"Microsoft.Web/connectionGateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":14,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"ConnectionGatewayDefinitionProperties","Properties":{"connectionGatewayInstallation":{"Type":12,"Flags":0,"Description":"The gateway installation reference"},"contactInformation":{"Type":13,"Flags":0,"Description":"The gateway admin"},"displayName":{"Type":4,"Flags":0,"Description":"The gateway display name"},"description":{"Type":4,"Flags":0,"Description":"The gateway description"},"machineName":{"Type":4,"Flags":0,"Description":"The machine name of the gateway"},"status":{"Type":0,"Flags":0,"Description":"Any object"},"backendUri":{"Type":4,"Flags":0,"Description":"The URI of the backend"}}}},{"2":{"Name":"ConnectionGatewayReference","Properties":{"location":{"Type":4,"Flags":0,"Description":"Resource reference location"},"name":{"Type":4,"Flags":0,"Description":"Resource reference name"},"id":{"Type":4,"Flags":0,"Description":"Resource reference id"},"type":{"Type":4,"Flags":0,"Description":"Resource reference type"}}}},{"3":{"ItemType":4}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/connectionGateways@2016-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.Web/customApis"}},{"6":{"Value":"2016-06-01"}},{"2":{"Name":"Microsoft.Web/customApis","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":16,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":17,"Flags":10,"Description":"The resource api version"},"properties":{"Type":19,"Flags":0,"Description":"Custom API properties"},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":51,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"CustomApiPropertiesDefinition","Properties":{"connectionParameters":{"Type":35,"Flags":0,"Description":"Connection parameters"},"runtimeUrls":{"Type":36,"Flags":0,"Description":"Runtime URLs"},"capabilities":{"Type":37,"Flags":0,"Description":"The custom API capabilities"},"swagger":{"Type":0,"Flags":0,"Description":"Any object"},"brandColor":{"Type":4,"Flags":0,"Description":"Brand color"},"description":{"Type":4,"Flags":0,"Description":"The custom API description"},"displayName":{"Type":4,"Flags":0,"Description":"The display name"},"iconUri":{"Type":4,"Flags":0,"Description":"The icon URI"},"backendService":{"Type":38,"Flags":0,"Description":"The API backend service"},"apiDefinitions":{"Type":39,"Flags":0,"Description":"API Definitions"},"apiType":{"Type":43,"Flags":0,"Description":"The API type"},"wsdlDefinition":{"Type":44,"Flags":0,"Description":"The WSDL definition"}}}},{"2":{"Name":"ConnectionParameter","Properties":{"type":{"Type":30,"Flags":0,"Description":"Type of the parameter"},"oAuthSettings":{"Type":31,"Flags":0,"Description":"OAuth settings for the connection provider"}}}},{"6":{"Value":"string"}},{"6":{"Value":"securestring"}},{"6":{"Value":"secureobject"}},{"6":{"Value":"int"}},{"6":{"Value":"bool"}},{"6":{"Value":"object"}},{"6":{"Value":"array"}},{"6":{"Value":"oauthSetting"}},{"6":{"Value":"connection"}},{"5":{"Elements":[21,22,23,24,25,26,27,28,29]}},{"2":{"Name":"ApiOAuthSettings","Properties":{"identityProvider":{"Type":4,"Flags":0,"Description":"Identity provider"},"clientId":{"Type":4,"Flags":0,"Description":"Resource provider client id"},"clientSecret":{"Type":4,"Flags":0,"Description":"Client Secret needed for OAuth"},"scopes":{"Type":32,"Flags":0,"Description":"OAuth scopes"},"redirectUrl":{"Type":4,"Flags":0,"Description":"Url"},"properties":{"Type":0,"Flags":0,"Description":"Any object"},"customParameters":{"Type":34,"Flags":0,"Description":"OAuth parameters key is the name of parameter"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ApiOAuthSettingsParameter","Properties":{"value":{"Type":4,"Flags":0,"Description":"Value of the setting"},"options":{"Type":0,"Flags":0,"Description":"Any object"},"uiDefinition":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"2":{"Name":"ApiOAuthSettingsCustomParameters","Properties":{},"AdditionalProperties":33}},{"2":{"Name":"CustomApiPropertiesDefinitionConnectionParameters","Properties":{},"AdditionalProperties":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ApiResourceBackendService","Properties":{"serviceUrl":{"Type":4,"Flags":0,"Description":"The service URL"}}}},{"2":{"Name":"ApiResourceDefinitions","Properties":{"originalSwaggerUrl":{"Type":4,"Flags":0,"Description":"The original swagger URL"},"modifiedSwaggerUrl":{"Type":4,"Flags":0,"Description":"The modified swagger URL"}}}},{"6":{"Value":"NotSpecified"}},{"6":{"Value":"Rest"}},{"6":{"Value":"Soap"}},{"5":{"Elements":[40,41,42]}},{"2":{"Name":"WsdlDefinition","Properties":{"url":{"Type":4,"Flags":0,"Description":"The WSDL URL"},"content":{"Type":4,"Flags":0,"Description":"The WSDL content"},"service":{"Type":45,"Flags":0,"Description":"The service with name and endpoint names"},"importMethod":{"Type":50,"Flags":0,"Description":"The WSDL import method"}}}},{"2":{"Name":"WsdlService","Properties":{"qualifiedName":{"Type":4,"Flags":1,"Description":"The service's qualified name"},"endpointQualifiedNames":{"Type":46,"Flags":0,"Description":"List of the endpoints' qualified names"}}}},{"3":{"ItemType":4}},{"6":{"Value":"NotSpecified"}},{"6":{"Value":"SoapToRest"}},{"6":{"Value":"SoapPassThrough"}},{"5":{"Elements":[47,48,49]}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/customApis@2016-06-01","ScopeType":8,"Body":18}},{"6":{"Value":"Microsoft.Web/connections"}},{"6":{"Value":"2016-06-01"}},{"2":{"Name":"Microsoft.Web/connections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":53,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":54,"Flags":10,"Description":"The resource api version"},"properties":{"Type":56,"Flags":0},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":68,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"ApiConnectionDefinitionProperties","Properties":{"displayName":{"Type":4,"Flags":0,"Description":"Display name"},"statuses":{"Type":61,"Flags":0,"Description":"Status of the connection"},"parameterValues":{"Type":62,"Flags":0,"Description":"Dictionary of parameter values"},"customParameterValues":{"Type":63,"Flags":0,"Description":"Dictionary of custom parameter values"},"nonSecretParameterValues":{"Type":64,"Flags":0,"Description":"Dictionary of nonsecret parameter values"},"createdTime":{"Type":4,"Flags":0,"Description":"Timestamp of the connection creation"},"changedTime":{"Type":4,"Flags":0,"Description":"Timestamp of last connection change"},"api":{"Type":65,"Flags":0},"testLinks":{"Type":67,"Flags":0,"Description":"Links to test the API connection"}}}},{"2":{"Name":"ConnectionStatusDefinition","Properties":{"status":{"Type":4,"Flags":0,"Description":"The gateway status"},"target":{"Type":4,"Flags":0,"Description":"Target of the error"},"error":{"Type":58,"Flags":0,"Description":"Connection error"}}}},{"2":{"Name":"ConnectionError","Properties":{"properties":{"Type":59,"Flags":0},"id":{"Type":4,"Flags":2,"Description":"Resource id"},"name":{"Type":4,"Flags":2,"Description":"Resource name"},"type":{"Type":4,"Flags":2,"Description":"Resource type"},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":60,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"ConnectionErrorProperties","Properties":{"code":{"Type":4,"Flags":0,"Description":"Code of the status"},"message":{"Type":4,"Flags":0,"Description":"Description of the status"}}}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":57}},{"2":{"Name":"ApiConnectionDefinitionPropertiesParameterValues","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ApiConnectionDefinitionPropertiesCustomParameterValues","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ApiConnectionDefinitionPropertiesNonSecretParameterValues","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ApiReference","Properties":{"swagger":{"Type":0,"Flags":0,"Description":"Any object"},"brandColor":{"Type":4,"Flags":0,"Description":"Brand color"},"description":{"Type":4,"Flags":0,"Description":"The custom API description"},"displayName":{"Type":4,"Flags":0,"Description":"The display name"},"iconUri":{"Type":4,"Flags":0,"Description":"The icon URI"},"name":{"Type":4,"Flags":0,"Description":"The name of the API"},"id":{"Type":4,"Flags":0,"Description":"Resource reference id"},"type":{"Type":4,"Flags":0,"Description":"Resource reference type"}}}},{"2":{"Name":"ApiConnectionTestLink","Properties":{"requestUri":{"Type":4,"Flags":0,"Description":"Test link request URI"},"method":{"Type":4,"Flags":0,"Description":"HTTP Method"}}}},{"3":{"ItemType":66}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/connections@2016-06-01","ScopeType":8,"Body":55}},{"2":{"Name":"WsdlServiceCollection","Properties":{"value":{"Type":71,"Flags":2,"Description":"Collection of WSDL interfaces"}}}},{"3":{"ItemType":45}},{"8":{"Name":"listWsdlInterfaces","ResourceType":"Microsoft.Web/locations","ApiVersion":"2016-06-01","Output":70,"Input":44}},{"2":{"Name":"ListConsentLinksDefinition","Properties":{"parameters":{"Type":75,"Flags":4,"Description":"Collection of resources"}}}},{"2":{"Name":"ConsentLinkParameterDefinition","Properties":{"parameterName":{"Type":4,"Flags":4,"Description":"Name of the parameter in the connection provider's OAuth settings"},"redirectUrl":{"Type":4,"Flags":4,"Description":"Name of the parameter in the connection provider's OAuth settings"},"objectId":{"Type":4,"Flags":4,"Description":"AAD OID (user or group) if the principal type is ActiveDirectory. MSA PUID if the principal type is MicrosoftAccount"},"tenantId":{"Type":4,"Flags":4,"Description":"The tenant id"}}}},{"3":{"ItemType":74}},{"2":{"Name":"ConsentLinkCollection","Properties":{"value":{"Type":82,"Flags":2,"Description":"Collection of resources"}}}},{"2":{"Name":"ConsentLinkDefinition","Properties":{"link":{"Type":4,"Flags":2,"Description":"URI for the consent link"},"firstPartyLoginUri":{"Type":4,"Flags":2,"Description":"URI for first party login"},"displayName":{"Type":4,"Flags":2,"Description":"Display name of the parameter in the connection provider's OAuth settings"},"status":{"Type":81,"Flags":2,"Description":"Status of the link"}}}},{"6":{"Value":"Unauthenticated"}},{"6":{"Value":"Authenticated"}},{"6":{"Value":"Error"}},{"5":{"Elements":[78,79,80]}},{"3":{"ItemType":77}},{"8":{"Name":"listConsentLinks","ResourceType":"Microsoft.Web/connections","ApiVersion":"2016-06-01","Output":76,"Input":73}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/connectionGateways"}},{"6":{"Value":"2016-06-01"}},{"2":{"Name":"Microsoft.Web/connectionGateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":14,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"ConnectionGatewayDefinitionProperties","Properties":{"connectionGatewayInstallation":{"Type":12,"Flags":0,"Description":"The gateway installation reference"},"contactInformation":{"Type":13,"Flags":0,"Description":"The gateway admin"},"displayName":{"Type":4,"Flags":0,"Description":"The gateway display name"},"description":{"Type":4,"Flags":0,"Description":"The gateway description"},"machineName":{"Type":4,"Flags":0,"Description":"The machine name of the gateway"},"status":{"Type":0,"Flags":0,"Description":"Any object"},"backendUri":{"Type":4,"Flags":0,"Description":"The URI of the backend"}}}},{"2":{"Name":"ConnectionGatewayReference","Properties":{"location":{"Type":4,"Flags":0,"Description":"Resource reference location"},"name":{"Type":4,"Flags":0,"Description":"Resource reference name"},"id":{"Type":4,"Flags":0,"Description":"Resource reference id"},"type":{"Type":4,"Flags":0,"Description":"Resource reference type"}}}},{"3":{"ItemType":4}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/connectionGateways@2016-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.Web/customApis"}},{"6":{"Value":"2016-06-01"}},{"2":{"Name":"Microsoft.Web/customApis","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":16,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":17,"Flags":10,"Description":"The resource api version"},"properties":{"Type":19,"Flags":0,"Description":"Custom API properties"},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":51,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"CustomApiPropertiesDefinition","Properties":{"connectionParameters":{"Type":35,"Flags":0,"Description":"Connection parameters"},"runtimeUrls":{"Type":36,"Flags":0,"Description":"Runtime URLs"},"capabilities":{"Type":37,"Flags":0,"Description":"The custom API capabilities"},"swagger":{"Type":0,"Flags":0,"Description":"Any object"},"brandColor":{"Type":4,"Flags":0,"Description":"Brand color"},"description":{"Type":4,"Flags":0,"Description":"The custom API description"},"displayName":{"Type":4,"Flags":0,"Description":"The display name"},"iconUri":{"Type":4,"Flags":0,"Description":"The icon URI"},"backendService":{"Type":38,"Flags":0,"Description":"The API backend service"},"apiDefinitions":{"Type":39,"Flags":0,"Description":"API Definitions"},"apiType":{"Type":43,"Flags":0,"Description":"The API type"},"wsdlDefinition":{"Type":44,"Flags":0,"Description":"The WSDL definition"}}}},{"2":{"Name":"ConnectionParameter","Properties":{"type":{"Type":30,"Flags":0,"Description":"Type of the parameter"},"oAuthSettings":{"Type":31,"Flags":0,"Description":"OAuth settings for the connection provider"}}}},{"6":{"Value":"string"}},{"6":{"Value":"securestring"}},{"6":{"Value":"secureobject"}},{"6":{"Value":"int"}},{"6":{"Value":"bool"}},{"6":{"Value":"object"}},{"6":{"Value":"array"}},{"6":{"Value":"oauthSetting"}},{"6":{"Value":"connection"}},{"5":{"Elements":[21,22,23,24,25,26,27,28,29]}},{"2":{"Name":"ApiOAuthSettings","Properties":{"identityProvider":{"Type":4,"Flags":0,"Description":"Identity provider"},"clientId":{"Type":4,"Flags":0,"Description":"Resource provider client id"},"clientSecret":{"Type":4,"Flags":0,"Description":"Client Secret needed for OAuth"},"scopes":{"Type":32,"Flags":0,"Description":"OAuth scopes"},"redirectUrl":{"Type":4,"Flags":0,"Description":"Url"},"properties":{"Type":0,"Flags":0,"Description":"Any object"},"customParameters":{"Type":34,"Flags":0,"Description":"OAuth parameters key is the name of parameter"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ApiOAuthSettingsParameter","Properties":{"value":{"Type":4,"Flags":0,"Description":"Value of the setting"},"options":{"Type":0,"Flags":0,"Description":"Any object"},"uiDefinition":{"Type":0,"Flags":0,"Description":"Any object"}}}},{"2":{"Name":"ApiOAuthSettingsCustomParameters","Properties":{},"AdditionalProperties":33}},{"2":{"Name":"CustomApiPropertiesDefinitionConnectionParameters","Properties":{},"AdditionalProperties":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ApiResourceBackendService","Properties":{"serviceUrl":{"Type":4,"Flags":0,"Description":"The service URL"}}}},{"2":{"Name":"ApiResourceDefinitions","Properties":{"originalSwaggerUrl":{"Type":4,"Flags":0,"Description":"The original swagger URL"},"modifiedSwaggerUrl":{"Type":4,"Flags":0,"Description":"The modified swagger URL"}}}},{"6":{"Value":"NotSpecified"}},{"6":{"Value":"Rest"}},{"6":{"Value":"Soap"}},{"5":{"Elements":[40,41,42,4]}},{"2":{"Name":"WsdlDefinition","Properties":{"url":{"Type":4,"Flags":0,"Description":"The WSDL URL"},"content":{"Type":4,"Flags":0,"Description":"The WSDL content"},"service":{"Type":45,"Flags":0,"Description":"The service with name and endpoint names"},"importMethod":{"Type":50,"Flags":0,"Description":"The WSDL import method"}}}},{"2":{"Name":"WsdlService","Properties":{"qualifiedName":{"Type":4,"Flags":1,"Description":"The service's qualified name"},"endpointQualifiedNames":{"Type":46,"Flags":0,"Description":"List of the endpoints' qualified names"}}}},{"3":{"ItemType":4}},{"6":{"Value":"NotSpecified"}},{"6":{"Value":"SoapToRest"}},{"6":{"Value":"SoapPassThrough"}},{"5":{"Elements":[47,48,49,4]}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/customApis@2016-06-01","ScopeType":8,"Body":18}},{"6":{"Value":"Microsoft.Web/connections"}},{"6":{"Value":"2016-06-01"}},{"2":{"Name":"Microsoft.Web/connections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":53,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":54,"Flags":10,"Description":"The resource api version"},"properties":{"Type":56,"Flags":0},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":68,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"ApiConnectionDefinitionProperties","Properties":{"displayName":{"Type":4,"Flags":0,"Description":"Display name"},"statuses":{"Type":61,"Flags":0,"Description":"Status of the connection"},"parameterValues":{"Type":62,"Flags":0,"Description":"Dictionary of parameter values"},"customParameterValues":{"Type":63,"Flags":0,"Description":"Dictionary of custom parameter values"},"nonSecretParameterValues":{"Type":64,"Flags":0,"Description":"Dictionary of nonsecret parameter values"},"createdTime":{"Type":4,"Flags":0,"Description":"Timestamp of the connection creation"},"changedTime":{"Type":4,"Flags":0,"Description":"Timestamp of last connection change"},"api":{"Type":65,"Flags":0},"testLinks":{"Type":67,"Flags":0,"Description":"Links to test the API connection"}}}},{"2":{"Name":"ConnectionStatusDefinition","Properties":{"status":{"Type":4,"Flags":0,"Description":"The gateway status"},"target":{"Type":4,"Flags":0,"Description":"Target of the error"},"error":{"Type":58,"Flags":0,"Description":"Connection error"}}}},{"2":{"Name":"ConnectionError","Properties":{"properties":{"Type":59,"Flags":0},"id":{"Type":4,"Flags":2,"Description":"Resource id"},"name":{"Type":4,"Flags":2,"Description":"Resource name"},"type":{"Type":4,"Flags":2,"Description":"Resource type"},"location":{"Type":4,"Flags":0,"Description":"Resource location"},"etag":{"Type":4,"Flags":0,"Description":"Resource ETag"},"tags":{"Type":60,"Flags":0,"Description":"Resource tags"}}}},{"2":{"Name":"ConnectionErrorProperties","Properties":{"code":{"Type":4,"Flags":0,"Description":"Code of the status"},"message":{"Type":4,"Flags":0,"Description":"Description of the status"}}}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":57}},{"2":{"Name":"ApiConnectionDefinitionPropertiesParameterValues","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ApiConnectionDefinitionPropertiesCustomParameterValues","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ApiConnectionDefinitionPropertiesNonSecretParameterValues","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ApiReference","Properties":{"swagger":{"Type":0,"Flags":0,"Description":"Any object"},"brandColor":{"Type":4,"Flags":0,"Description":"Brand color"},"description":{"Type":4,"Flags":0,"Description":"The custom API description"},"displayName":{"Type":4,"Flags":0,"Description":"The display name"},"iconUri":{"Type":4,"Flags":0,"Description":"The icon URI"},"name":{"Type":4,"Flags":0,"Description":"The name of the API"},"id":{"Type":4,"Flags":0,"Description":"Resource reference id"},"type":{"Type":4,"Flags":0,"Description":"Resource reference type"}}}},{"2":{"Name":"ApiConnectionTestLink","Properties":{"requestUri":{"Type":4,"Flags":0,"Description":"Test link request URI"},"method":{"Type":4,"Flags":0,"Description":"HTTP Method"}}}},{"3":{"ItemType":66}},{"2":{"Name":"TagsDictionary","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/connections@2016-06-01","ScopeType":8,"Body":55}},{"2":{"Name":"WsdlServiceCollection","Properties":{"value":{"Type":71,"Flags":2,"Description":"Collection of WSDL interfaces"}}}},{"3":{"ItemType":45}},{"8":{"Name":"listWsdlInterfaces","ResourceType":"Microsoft.Web/locations","ApiVersion":"2016-06-01","Output":70,"Input":44}},{"2":{"Name":"ListConsentLinksDefinition","Properties":{"parameters":{"Type":75,"Flags":4,"Description":"Collection of resources"}}}},{"2":{"Name":"ConsentLinkParameterDefinition","Properties":{"parameterName":{"Type":4,"Flags":4,"Description":"Name of the parameter in the connection provider's OAuth settings"},"redirectUrl":{"Type":4,"Flags":4,"Description":"Name of the parameter in the connection provider's OAuth settings"},"objectId":{"Type":4,"Flags":4,"Description":"AAD OID (user or group) if the principal type is ActiveDirectory. MSA PUID if the principal type is MicrosoftAccount"},"tenantId":{"Type":4,"Flags":4,"Description":"The tenant id"}}}},{"3":{"ItemType":74}},{"2":{"Name":"ConsentLinkCollection","Properties":{"value":{"Type":82,"Flags":2,"Description":"Collection of resources"}}}},{"2":{"Name":"ConsentLinkDefinition","Properties":{"link":{"Type":4,"Flags":2,"Description":"URI for the consent link"},"firstPartyLoginUri":{"Type":4,"Flags":2,"Description":"URI for first party login"},"displayName":{"Type":4,"Flags":2,"Description":"Display name of the parameter in the connection provider's OAuth settings"},"status":{"Type":81,"Flags":2,"Description":"Status of the link"}}}},{"6":{"Value":"Unauthenticated"}},{"6":{"Value":"Authenticated"}},{"6":{"Value":"Error"}},{"5":{"Elements":[78,79,80,4]}},{"3":{"ItemType":77}},{"8":{"Name":"listConsentLinks","ResourceType":"Microsoft.Web/connections","ApiVersion":"2016-06-01","Output":76,"Input":73}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2016-06-01/types.md b/generated/web/microsoft.web/2016-06-01/types.md index 37d7515408..5cc1f2e174 100644 --- a/generated/web/microsoft.web/2016-06-01/types.md +++ b/generated/web/microsoft.web/2016-06-01/types.md @@ -48,28 +48,6 @@ * **Input**: [WsdlDefinition](#wsdldefinition) * **Output**: [WsdlServiceCollection](#wsdlservicecollection) -## ConnectionGatewayDefinitionProperties -### Properties -* **backendUri**: string: The URI of the backend -* **connectionGatewayInstallation**: [ConnectionGatewayReference](#connectiongatewayreference): The gateway installation reference -* **contactInformation**: string[]: The gateway admin -* **description**: string: The gateway description -* **displayName**: string: The gateway display name -* **machineName**: string: The machine name of the gateway -* **status**: any: Any object - -## ConnectionGatewayReference -### Properties -* **id**: string: Resource reference id -* **location**: string: Resource reference location -* **name**: string: Resource reference name -* **type**: string: Resource reference type - -## TagsDictionary -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## ApiConnectionDefinitionProperties ### Properties * **api**: [ApiReference](#apireference) @@ -82,17 +60,6 @@ * **statuses**: [ConnectionStatusDefinition](#connectionstatusdefinition)[]: Status of the connection * **testLinks**: [ApiConnectionTestLink](#apiconnectiontestlink)[]: Links to test the API connection -## ApiReference -### Properties -* **brandColor**: string: Brand color -* **description**: string: The custom API description -* **displayName**: string: The display name -* **iconUri**: string: The icon URI -* **id**: string: Resource reference id -* **name**: string: The name of the API -* **swagger**: any: Any object -* **type**: string: Resource reference type - ## ApiConnectionDefinitionPropertiesCustomParameterValues ### Properties ### Additional Properties @@ -108,11 +75,51 @@ ### Additional Properties * **Additional Properties Type**: string -## ConnectionStatusDefinition +## ApiConnectionTestLink ### Properties -* **error**: [ConnectionError](#connectionerror): Connection error -* **status**: string: The gateway status -* **target**: string: Target of the error +* **method**: string: HTTP Method +* **requestUri**: string: Test link request URI + +## ApiOAuthSettings +### Properties +* **clientId**: string: Resource provider client id +* **clientSecret**: string: Client Secret needed for OAuth +* **customParameters**: [ApiOAuthSettingsCustomParameters](#apioauthsettingscustomparameters): OAuth parameters key is the name of parameter +* **identityProvider**: string: Identity provider +* **properties**: any: Any object +* **redirectUrl**: string: Url +* **scopes**: string[]: OAuth scopes + +## ApiOAuthSettingsCustomParameters +### Properties +### Additional Properties +* **Additional Properties Type**: [ApiOAuthSettingsParameter](#apioauthsettingsparameter) + +## ApiOAuthSettingsParameter +### Properties +* **options**: any: Any object +* **uiDefinition**: any: Any object +* **value**: string: Value of the setting + +## ApiReference +### Properties +* **brandColor**: string: Brand color +* **description**: string: The custom API description +* **displayName**: string: The display name +* **iconUri**: string: The icon URI +* **id**: string: Resource reference id +* **name**: string: The name of the API +* **swagger**: any: Any object +* **type**: string: Resource reference type + +## ApiResourceBackendService +### Properties +* **serviceUrl**: string: The service URL + +## ApiResourceDefinitions +### Properties +* **modifiedSwaggerUrl**: string: The modified swagger URL +* **originalSwaggerUrl**: string: The original swagger URL ## ConnectionError ### Properties @@ -129,25 +136,56 @@ * **code**: string: Code of the status * **message**: string: Description of the status -## TagsDictionary +## ConnectionGatewayDefinitionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **backendUri**: string: The URI of the backend +* **connectionGatewayInstallation**: [ConnectionGatewayReference](#connectiongatewayreference): The gateway installation reference +* **contactInformation**: string[]: The gateway admin +* **description**: string: The gateway description +* **displayName**: string: The gateway display name +* **machineName**: string: The machine name of the gateway +* **status**: any: Any object -## ApiConnectionTestLink +## ConnectionGatewayReference ### Properties -* **method**: string: HTTP Method -* **requestUri**: string: Test link request URI +* **id**: string: Resource reference id +* **location**: string: Resource reference location +* **name**: string: Resource reference name +* **type**: string: Resource reference type -## TagsDictionary +## ConnectionParameter ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **oAuthSettings**: [ApiOAuthSettings](#apioauthsettings): OAuth settings for the connection provider +* **type**: 'array' | 'bool' | 'connection' | 'int' | 'oauthSetting' | 'object' | 'secureobject' | 'securestring' | 'string': Type of the parameter + +## ConnectionStatusDefinition +### Properties +* **error**: [ConnectionError](#connectionerror): Connection error +* **status**: string: The gateway status +* **target**: string: Target of the error + +## ConsentLinkCollection +### Properties +* **value**: [ConsentLinkDefinition](#consentlinkdefinition)[] (ReadOnly): Collection of resources + +## ConsentLinkDefinition +### Properties +* **displayName**: string (ReadOnly): Display name of the parameter in the connection provider's OAuth settings +* **firstPartyLoginUri**: string (ReadOnly): URI for first party login +* **link**: string (ReadOnly): URI for the consent link +* **status**: 'Authenticated' | 'Error' | 'Unauthenticated' | string (ReadOnly): Status of the link + +## ConsentLinkParameterDefinition +### Properties +* **objectId**: string (WriteOnly): AAD OID (user or group) if the principal type is ActiveDirectory. MSA PUID if the principal type is MicrosoftAccount +* **parameterName**: string (WriteOnly): Name of the parameter in the connection provider's OAuth settings +* **redirectUrl**: string (WriteOnly): Name of the parameter in the connection provider's OAuth settings +* **tenantId**: string (WriteOnly): The tenant id ## CustomApiPropertiesDefinition ### Properties * **apiDefinitions**: [ApiResourceDefinitions](#apiresourcedefinitions): API Definitions -* **apiType**: 'NotSpecified' | 'Rest' | 'Soap': The API type +* **apiType**: 'NotSpecified' | 'Rest' | 'Soap' | string: The API type * **backendService**: [ApiResourceBackendService](#apiresourcebackendservice): The API backend service * **brandColor**: string: Brand color * **capabilities**: string[]: The custom API capabilities @@ -159,92 +197,54 @@ * **swagger**: any: Any object * **wsdlDefinition**: [WsdlDefinition](#wsdldefinition): The WSDL definition -## ApiResourceDefinitions -### Properties -* **modifiedSwaggerUrl**: string: The modified swagger URL -* **originalSwaggerUrl**: string: The original swagger URL - -## ApiResourceBackendService -### Properties -* **serviceUrl**: string: The service URL - ## CustomApiPropertiesDefinitionConnectionParameters ### Properties ### Additional Properties * **Additional Properties Type**: [ConnectionParameter](#connectionparameter) -## ConnectionParameter -### Properties -* **oAuthSettings**: [ApiOAuthSettings](#apioauthsettings): OAuth settings for the connection provider -* **type**: 'array' | 'bool' | 'connection' | 'int' | 'oauthSetting' | 'object' | 'secureobject' | 'securestring' | 'string': Type of the parameter - -## ApiOAuthSettings +## ListConsentLinksDefinition ### Properties -* **clientId**: string: Resource provider client id -* **clientSecret**: string: Client Secret needed for OAuth -* **customParameters**: [ApiOAuthSettingsCustomParameters](#apioauthsettingscustomparameters): OAuth parameters key is the name of parameter -* **identityProvider**: string: Identity provider -* **properties**: any: Any object -* **redirectUrl**: string: Url -* **scopes**: string[]: OAuth scopes +* **parameters**: [ConsentLinkParameterDefinition](#consentlinkparameterdefinition)[] (WriteOnly): Collection of resources -## ApiOAuthSettingsCustomParameters +## TagsDictionary ### Properties ### Additional Properties -* **Additional Properties Type**: [ApiOAuthSettingsParameter](#apioauthsettingsparameter) - -## ApiOAuthSettingsParameter -### Properties -* **options**: any: Any object -* **uiDefinition**: any: Any object -* **value**: string: Value of the setting - -## WsdlDefinition -### Properties -* **content**: string: The WSDL content -* **importMethod**: 'NotSpecified' | 'SoapPassThrough' | 'SoapToRest': The WSDL import method -* **service**: [WsdlService](#wsdlservice): The service with name and endpoint names -* **url**: string: The WSDL URL - -## WsdlService -### Properties -* **endpointQualifiedNames**: string[]: List of the endpoints' qualified names -* **qualifiedName**: string (Required): The service's qualified name +* **Additional Properties Type**: string ## TagsDictionary ### Properties ### Additional Properties * **Additional Properties Type**: string -## ListConsentLinksDefinition -### Properties -* **parameters**: [ConsentLinkParameterDefinition](#consentlinkparameterdefinition)[] (WriteOnly): Collection of resources - -## ConsentLinkParameterDefinition +## TagsDictionary ### Properties -* **objectId**: string (WriteOnly): AAD OID (user or group) if the principal type is ActiveDirectory. MSA PUID if the principal type is MicrosoftAccount -* **parameterName**: string (WriteOnly): Name of the parameter in the connection provider's OAuth settings -* **redirectUrl**: string (WriteOnly): Name of the parameter in the connection provider's OAuth settings -* **tenantId**: string (WriteOnly): The tenant id +### Additional Properties +* **Additional Properties Type**: string -## ConsentLinkCollection +## TagsDictionary ### Properties -* **value**: [ConsentLinkDefinition](#consentlinkdefinition)[] (ReadOnly): Collection of resources +### Additional Properties +* **Additional Properties Type**: string -## ConsentLinkDefinition +## WsdlDefinition ### Properties -* **displayName**: string (ReadOnly): Display name of the parameter in the connection provider's OAuth settings -* **firstPartyLoginUri**: string (ReadOnly): URI for first party login -* **link**: string (ReadOnly): URI for the consent link -* **status**: 'Authenticated' | 'Error' | 'Unauthenticated' (ReadOnly): Status of the link +* **content**: string: The WSDL content +* **importMethod**: 'NotSpecified' | 'SoapPassThrough' | 'SoapToRest' | string: The WSDL import method +* **service**: [WsdlService](#wsdlservice): The service with name and endpoint names +* **url**: string: The WSDL URL ## WsdlDefinition ### Properties * **content**: string: The WSDL content -* **importMethod**: 'NotSpecified' | 'SoapPassThrough' | 'SoapToRest': The WSDL import method +* **importMethod**: 'NotSpecified' | 'SoapPassThrough' | 'SoapToRest' | string: The WSDL import method * **service**: [WsdlService](#wsdlservice): The service with name and endpoint names * **url**: string: The WSDL URL +## WsdlService +### Properties +* **endpointQualifiedNames**: string[]: List of the endpoints' qualified names +* **qualifiedName**: string (Required): The service's qualified name + ## WsdlServiceCollection ### Properties * **value**: [WsdlService](#wsdlservice)[] (ReadOnly): Collection of WSDL interfaces diff --git a/generated/web/microsoft.web/2016-08-01/types.json b/generated/web/microsoft.web/2016-08-01/types.json index 0ff0031ba1..c9f444f4d1 100644 --- a/generated/web/microsoft.web/2016-08-01/types.json +++ b/generated/web/microsoft.web/2016-08-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":113,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":115,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":12,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":15,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":16,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":20,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":29,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":30,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":105,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":106,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":107,"Flags":4,"Description":"Information needed for cloning operation."},"snapshotInfo":{"Type":109,"Flags":4,"Description":"Details about app recovery operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":112,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[13,14]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[17,18,19]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":25,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":28,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[22,23,24]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[26,27]}},{"3":{"ItemType":21}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":31,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":33,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":47,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":48,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":50,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":64,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":67,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":71,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":77,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":78,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":81,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":82,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":94,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":96,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":98,"Flags":0,"Description":"Information about the formal API definition for the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"ipSecurityRestrictions":{"Type":100,"Flags":0,"Description":"IP security restrictions."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":104,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":32}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":46,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44,45]}},{"3":{"ItemType":34}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":49}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"5":{"Elements":[51,52,53,54,55,56,57,58,59,60,61,62,63]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":70,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":69}},{"3":{"ItemType":68}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[72,73,74,75,76]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":80,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"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."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":79}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":83,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":88,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":84,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":86,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":87,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":85}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":92,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":93,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[89,90,91]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":95,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":97,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":1,"Description":"IP address the security restriction is valid for."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."}}}},{"3":{"ItemType":99}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[101,102,103]}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":108,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."},"ignoreQuotas":{"Type":2,"Flags":0,"Description":"true if quotas should be ignored; otherwise, false."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SnapshotRecoveryRequest","Properties":{"properties":{"Type":110,"Flags":0,"Description":"SnapshotRecoveryRequest resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"SnapshotRecoveryRequestProperties","Properties":{"snapshotTime":{"Type":4,"Flags":0,"Description":"Point in time in which the app recovery should be attempted, formatted as a DateTime string."},"recoveryTarget":{"Type":111,"Flags":0,"Description":"Specifies the web app that snapshot contents will be written to."},"overwrite":{"Type":2,"Flags":1,"Description":"If true the recovery operation can overwrite source app; otherwise, false."},"recoverConfiguration":{"Type":2,"Flags":0,"Description":"If true, site configuration, in addition to content, will be reverted."},"ignoreConflictingHostNames":{"Type":2,"Flags":0,"Description":"If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled."}}}},{"2":{"Name":"SnapshotRecoveryTarget","Properties":{"location":{"Type":4,"Flags":0,"Description":"Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS"},"id":{"Type":4,"Flags":0,"Description":"ARM resource ID of the target app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."}}}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":114,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."}}}},{"6":{"Value":"SystemAssigned"}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2016-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"discover"}},{"6":{"Value":"Microsoft.Web/sites/backups"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/backups","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":117,"Flags":9,"Description":"The resource name"},"type":{"Type":118,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":119,"Flags":10,"Description":"The resource api version"},"properties":{"Type":121,"Flags":0,"Description":"RestoreRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RestoreRequestProperties","Properties":{"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"blobName":{"Type":4,"Flags":0,"Description":"Name of a blob which contains the backup."},"overwrite":{"Type":2,"Flags":1,"Description":"true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app."},"siteName":{"Type":4,"Flags":0,"Description":"Name of an app."},"databases":{"Type":128,"Flags":0,"Description":"Collection of databases which should be restored. This list has to match the list of databases included in the backup."},"ignoreConflictingHostNames":{"Type":2,"Flags":0,"Description":"Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation."},"ignoreDatabases":{"Type":2,"Flags":0,"Description":"Ignore the databases and only restore the site content"},"appServicePlan":{"Type":4,"Flags":0,"Description":"Specify app service plan that will own restored site."},"operationType":{"Type":133,"Flags":0,"Description":"Type of the backup."},"adjustConnectionStrings":{"Type":2,"Flags":0,"Description":"true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false."},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment name, if needed (only when restoring an app to an App Service Environment)."}}}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":127,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[123,124,125,126]}},{"3":{"ItemType":122}},{"6":{"Value":"Default"}},{"6":{"Value":"Clone"}},{"6":{"Value":"Relocation"}},{"6":{"Value":"Snapshot"}},{"5":{"Elements":[129,130,131,132]}},{"4":{"Name":"Microsoft.Web/sites/backups@2016-08-01","ScopeType":8,"Body":120}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":135,"Flags":9,"Description":"The resource name"},"type":{"Type":136,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":137,"Flags":10,"Description":"The resource api version"},"properties":{"Type":139,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":140,"Flags":9,"Description":"The resource name"},"type":{"Type":141,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":142,"Flags":10,"Description":"The resource api version"},"properties":{"Type":144,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":147,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":148,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":154,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"allowedAudiences":{"Type":155,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":156,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":157,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":158,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":159,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[145,146]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[149,150,151,152,153]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":160,"Flags":9,"Description":"The resource name"},"type":{"Type":161,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":162,"Flags":10,"Description":"The resource api version"},"properties":{"Type":164,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":165,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":169,"Flags":0,"Description":"Databases included in the backup."},"type":{"Type":174,"Flags":0,"Description":"Type of the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":168,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[166,167]}},{"3":{"ItemType":122}},{"6":{"Value":"Default"}},{"6":{"Value":"Clone"}},{"6":{"Value":"Relocation"}},{"6":{"Value":"Snapshot"}},{"5":{"Elements":[170,171,172,173]}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":175,"Flags":9,"Description":"The resource name"},"type":{"Type":176,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":177,"Flags":10,"Description":"The resource api version"},"properties":{"Type":192,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":191,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[180,181,182,183,184,185,186,187,188,189,190]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":179}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":193,"Flags":9,"Description":"The resource name"},"type":{"Type":194,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":195,"Flags":10,"Description":"The resource api version"},"properties":{"Type":197,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":198,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":220,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":223,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":223,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":199,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":206,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":213,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":205,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[200,201,202,203,204]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":212,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[207,208,209,210,211]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":219,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[214,215,216,217,218]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":221,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":222,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":224,"Flags":9,"Description":"The resource name"},"type":{"Type":225,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":226,"Flags":10,"Description":"The resource api version"},"properties":{"Type":228,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":229,"Flags":9,"Description":"The resource name"},"type":{"Type":230,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":231,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":233,"Flags":9,"Description":"The resource name"},"type":{"Type":234,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":235,"Flags":10,"Description":"The resource api version"},"properties":{"Type":237,"Flags":0,"Description":"Names for connection strings and application settings to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":238,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":239,"Flags":0,"Description":"List of application settings names."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":240,"Flags":9,"Description":"The resource name"},"type":{"Type":241,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":242,"Flags":10,"Description":"The resource api version"},"properties":{"Type":30,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":138,"authsettings":143,"backup":163,"connectionstrings":178,"logs":196,"metadata":227,"pushsettings":232,"slotConfigNames":236,"web":243}}},{"4":{"Name":"Microsoft.Web/sites/config@2016-08-01","ScopeType":8,"Body":244}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":246,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":247,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"Identifier for deployment."},"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"authorEmail":{"Type":4,"Flags":0,"Description":"Author email."},"startTime":{"Type":4,"Flags":0,"Description":"Start time."},"endTime":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2016-08-01","ScopeType":8,"Body":248}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":251,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":252,"Flags":10,"Description":"The resource api version"},"properties":{"Type":254,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2016-08-01","ScopeType":8,"Body":253}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":256,"Flags":9,"Description":"The resource name"},"type":{"Type":257,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":258,"Flags":10,"Description":"The resource api version"},"properties":{"Type":260,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":261,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":267,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[262,263,264,265,266]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2016-08-01","ScopeType":8,"Body":259}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":269,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":270,"Flags":10,"Description":"The resource api version"},"properties":{"Type":272,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"name":{"Type":4,"Flags":2,"Description":"Function name."},"functionAppId":{"Type":4,"Flags":2,"Description":"Function App ID."},"scriptRootPathHref":{"Type":4,"Flags":0,"Description":"Script root path URI."},"scriptHref":{"Type":4,"Flags":0,"Description":"Script URI."},"configHref":{"Type":4,"Flags":0,"Description":"Config URI."},"secretsFileHref":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":273,"Flags":0,"Description":"File list."},"testData":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2016-08-01","ScopeType":8,"Body":271}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":275,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":276,"Flags":10,"Description":"The resource api version"},"properties":{"Type":278,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":281,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":284,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":287,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":291,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[279,280]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[282,283]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[285,286]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[288,289,290]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2016-08-01","ScopeType":8,"Body":277}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":293,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":294,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2016-08-01","ScopeType":8,"Body":295}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":298,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":299,"Flags":10,"Description":"The resource api version"},"properties":{"Type":301,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2016-08-01","ScopeType":8,"Body":300}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":303,"Flags":9,"Description":"The resource name"},"type":{"Type":304,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":305,"Flags":10,"Description":"The resource api version"},"properties":{"Type":260,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2016-08-01","ScopeType":8,"Body":306}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":308,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":309,"Flags":10,"Description":"The resource api version"},"properties":{"Type":311,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":313,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"name":{"Type":4,"Flags":0,"Description":"Premier add on Name."},"location":{"Type":4,"Flags":0,"Description":"Premier add on Location."},"tags":{"Type":312,"Flags":0,"Description":"Premier add on Tags."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"PremierAddOnPropertiesTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2016-08-01","ScopeType":8,"Body":310}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":315,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":316,"Flags":10,"Description":"The resource api version"},"properties":{"Type":318,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":322,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[319,320,321]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2016-08-01","ScopeType":8,"Body":317}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":324,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":325,"Flags":10,"Description":"The resource api version"},"properties":{"Type":327,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2,"Description":"Site extension title."},"type":{"Type":330,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extensionUrl":{"Type":4,"Flags":2,"Description":"Extension URL."},"projectUrl":{"Type":4,"Flags":2,"Description":"Project URL."},"iconUrl":{"Type":4,"Flags":2,"Description":"Icon URL."},"licenseUrl":{"Type":4,"Flags":2,"Description":"License URL."},"feedUrl":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":331,"Flags":2,"Description":"List of authors."},"installationArgs":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"publishedDateTime":{"Type":4,"Flags":2,"Description":"Published timestamp."},"downloadCount":{"Type":3,"Flags":2,"Description":"Count of downloads."},"localIsLatestVersion":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"localPath":{"Type":4,"Flags":2,"Description":"Local path."},"installedDateTime":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[328,329]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2016-08-01","ScopeType":8,"Body":326}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":333,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":334,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":113,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":336,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2016-08-01","ScopeType":8,"Body":335}},{"6":{"Value":"discover"}},{"6":{"Value":"Microsoft.Web/sites/slots/backups"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/backups","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":338,"Flags":9,"Description":"The resource name"},"type":{"Type":339,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":340,"Flags":10,"Description":"The resource api version"},"properties":{"Type":121,"Flags":0,"Description":"RestoreRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/backups@2016-08-01","ScopeType":8,"Body":341}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":343,"Flags":9,"Description":"The resource name"},"type":{"Type":344,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":345,"Flags":10,"Description":"The resource api version"},"properties":{"Type":347,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":348,"Flags":9,"Description":"The resource name"},"type":{"Type":349,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":350,"Flags":10,"Description":"The resource api version"},"properties":{"Type":144,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":352,"Flags":9,"Description":"The resource name"},"type":{"Type":353,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":354,"Flags":10,"Description":"The resource api version"},"properties":{"Type":164,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":356,"Flags":9,"Description":"The resource name"},"type":{"Type":357,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":358,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":179}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":361,"Flags":9,"Description":"The resource name"},"type":{"Type":362,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":363,"Flags":10,"Description":"The resource api version"},"properties":{"Type":197,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":365,"Flags":9,"Description":"The resource name"},"type":{"Type":366,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":367,"Flags":10,"Description":"The resource api version"},"properties":{"Type":369,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":370,"Flags":9,"Description":"The resource name"},"type":{"Type":371,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":372,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":374,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":30,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":346,"authsettings":351,"backup":355,"connectionstrings":359,"logs":364,"metadata":368,"pushsettings":373,"web":377}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2016-08-01","ScopeType":8,"Body":378}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":380,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":381,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2016-08-01","ScopeType":8,"Body":382}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":384,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":385,"Flags":10,"Description":"The resource api version"},"properties":{"Type":254,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2016-08-01","ScopeType":8,"Body":386}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":388,"Flags":9,"Description":"The resource name"},"type":{"Type":389,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":390,"Flags":10,"Description":"The resource api version"},"properties":{"Type":260,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2016-08-01","ScopeType":8,"Body":391}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":393,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":394,"Flags":10,"Description":"The resource api version"},"properties":{"Type":272,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2016-08-01","ScopeType":8,"Body":395}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":397,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":398,"Flags":10,"Description":"The resource api version"},"properties":{"Type":278,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2016-08-01","ScopeType":8,"Body":399}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2016-08-01","ScopeType":8,"Body":403}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":405,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":406,"Flags":10,"Description":"The resource api version"},"properties":{"Type":301,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2016-08-01","ScopeType":8,"Body":407}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":409,"Flags":9,"Description":"The resource name"},"type":{"Type":410,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":411,"Flags":10,"Description":"The resource api version"},"properties":{"Type":260,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2016-08-01","ScopeType":8,"Body":412}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":414,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":415,"Flags":10,"Description":"The resource api version"},"properties":{"Type":311,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":417,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2016-08-01","ScopeType":8,"Body":416}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":419,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":420,"Flags":10,"Description":"The resource api version"},"properties":{"Type":318,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2016-08-01","ScopeType":8,"Body":421}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":423,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":424,"Flags":10,"Description":"The resource api version"},"properties":{"Type":327,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2016-08-01","ScopeType":8,"Body":425}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":427,"Flags":9,"Description":"The resource name"},"type":{"Type":428,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":429,"Flags":10,"Description":"The resource api version"},"properties":{"Type":431,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2016-08-01","ScopeType":8,"Body":430}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":433,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":434,"Flags":10,"Description":"The resource api version"},"properties":{"Type":436,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":0,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":443,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":438,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of this route. This is only returned by the server and does not need to be set by the client."},"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":442,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[439,440,441]}},{"3":{"ItemType":437}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2016-08-01","ScopeType":8,"Body":435}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":445,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":446,"Flags":10,"Description":"The resource api version"},"properties":{"Type":448,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2016-08-01","ScopeType":8,"Body":447}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":450,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":431,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2016-08-01","ScopeType":8,"Body":453}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":455,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":456,"Flags":10,"Description":"The resource api version"},"properties":{"Type":436,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2016-08-01","ScopeType":8,"Body":457}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":459,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":460,"Flags":10,"Description":"The resource api version"},"properties":{"Type":448,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2016-08-01","ScopeType":8,"Body":461}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":164,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":465,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":476,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":477,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[466,467,468,469,470,471,472,473,474,475]}},{"3":{"ItemType":122}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2016-08-01","Output":464,"Input":463}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":480,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2016-08-01","Output":479}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":483,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"triggerUrl":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2016-08-01","Output":482}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":486,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","ApiVersion":"2016-08-01","Output":485}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2016-08-01","Output":482}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2016-08-01","Output":464,"Input":463}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2016-08-01","Output":479}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2016-08-01","Output":482}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","ApiVersion":"2016-08-01","Output":485}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2016-08-01","Output":482}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":113,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":116,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":12,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":15,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":16,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":20,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":29,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":30,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":105,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":106,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":107,"Flags":4,"Description":"Information needed for cloning operation."},"snapshotInfo":{"Type":109,"Flags":4,"Description":"Details about app recovery operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":112,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[13,14]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[17,18,19]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":25,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":28,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[22,23,24]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[26,27]}},{"3":{"ItemType":21}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":31,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":33,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":47,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":48,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":50,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":64,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":67,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":71,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":77,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":78,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":81,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":82,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":94,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":96,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":98,"Flags":0,"Description":"Information about the formal API definition for the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"ipSecurityRestrictions":{"Type":100,"Flags":0,"Description":"IP security restrictions."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":104,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":32}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":46,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[35,36,37,38,39,40,41,42,43,44,45]}},{"3":{"ItemType":34}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":49}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"5":{"Elements":[51,52,53,54,55,56,57,58,59,60,61,62,63,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[65,66]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":70,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":69}},{"3":{"ItemType":68}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[72,73,74,75,76]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":80,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"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."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":79}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":83,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":88,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":84,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":86,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":87,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":85}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":92,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":93,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[89,90,91]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":95,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":97,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":1,"Description":"IP address the security restriction is valid for."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."}}}},{"3":{"ItemType":99}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[101,102,103,4]}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":108,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."},"ignoreQuotas":{"Type":2,"Flags":0,"Description":"true if quotas should be ignored; otherwise, false."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SnapshotRecoveryRequest","Properties":{"properties":{"Type":110,"Flags":0,"Description":"SnapshotRecoveryRequest resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"SnapshotRecoveryRequestProperties","Properties":{"snapshotTime":{"Type":4,"Flags":0,"Description":"Point in time in which the app recovery should be attempted, formatted as a DateTime string."},"recoveryTarget":{"Type":111,"Flags":0,"Description":"Specifies the web app that snapshot contents will be written to."},"overwrite":{"Type":2,"Flags":1,"Description":"If true the recovery operation can overwrite source app; otherwise, false."},"recoverConfiguration":{"Type":2,"Flags":0,"Description":"If true, site configuration, in addition to content, will be reverted."},"ignoreConflictingHostNames":{"Type":2,"Flags":0,"Description":"If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled."}}}},{"2":{"Name":"SnapshotRecoveryTarget","Properties":{"location":{"Type":4,"Flags":0,"Description":"Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS"},"id":{"Type":4,"Flags":0,"Description":"ARM resource ID of the target app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."}}}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":115,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."}}}},{"6":{"Value":"SystemAssigned"}},{"5":{"Elements":[114,4]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2016-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"discover"}},{"6":{"Value":"Microsoft.Web/sites/backups"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/backups","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":118,"Flags":9,"Description":"The resource name"},"type":{"Type":119,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":120,"Flags":10,"Description":"The resource api version"},"properties":{"Type":122,"Flags":0,"Description":"RestoreRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RestoreRequestProperties","Properties":{"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"blobName":{"Type":4,"Flags":0,"Description":"Name of a blob which contains the backup."},"overwrite":{"Type":2,"Flags":1,"Description":"true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app."},"siteName":{"Type":4,"Flags":0,"Description":"Name of an app."},"databases":{"Type":129,"Flags":0,"Description":"Collection of databases which should be restored. This list has to match the list of databases included in the backup."},"ignoreConflictingHostNames":{"Type":2,"Flags":0,"Description":"Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation."},"ignoreDatabases":{"Type":2,"Flags":0,"Description":"Ignore the databases and only restore the site content"},"appServicePlan":{"Type":4,"Flags":0,"Description":"Specify app service plan that will own restored site."},"operationType":{"Type":134,"Flags":0,"Description":"Type of the backup."},"adjustConnectionStrings":{"Type":2,"Flags":0,"Description":"true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false."},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment name, if needed (only when restoring an app to an App Service Environment)."}}}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":128,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[124,125,126,127,4]}},{"3":{"ItemType":123}},{"6":{"Value":"Default"}},{"6":{"Value":"Clone"}},{"6":{"Value":"Relocation"}},{"6":{"Value":"Snapshot"}},{"5":{"Elements":[130,131,132,133]}},{"4":{"Name":"Microsoft.Web/sites/backups@2016-08-01","ScopeType":8,"Body":121}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":136,"Flags":9,"Description":"The resource name"},"type":{"Type":137,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":138,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":141,"Flags":9,"Description":"The resource name"},"type":{"Type":142,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":143,"Flags":10,"Description":"The resource api version"},"properties":{"Type":145,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":148,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":149,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":155,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"allowedAudiences":{"Type":156,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":157,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":158,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":159,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":160,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[146,147]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[150,151,152,153,154]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":161,"Flags":9,"Description":"The resource name"},"type":{"Type":162,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":163,"Flags":10,"Description":"The resource api version"},"properties":{"Type":165,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":166,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":170,"Flags":0,"Description":"Databases included in the backup."},"type":{"Type":175,"Flags":0,"Description":"Type of the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":169,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[167,168]}},{"3":{"ItemType":123}},{"6":{"Value":"Default"}},{"6":{"Value":"Clone"}},{"6":{"Value":"Relocation"}},{"6":{"Value":"Snapshot"}},{"5":{"Elements":[171,172,173,174]}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":176,"Flags":9,"Description":"The resource name"},"type":{"Type":177,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":178,"Flags":10,"Description":"The resource api version"},"properties":{"Type":193,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":192,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[181,182,183,184,185,186,187,188,189,190,191]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":180}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":194,"Flags":9,"Description":"The resource name"},"type":{"Type":195,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":196,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":199,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":221,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":224,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":224,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":200,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":207,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":214,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":206,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[201,202,203,204,205]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":213,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[208,209,210,211,212]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":220,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[215,216,217,218,219]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":222,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":223,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":225,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":230,"Flags":9,"Description":"The resource name"},"type":{"Type":231,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":232,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":234,"Flags":9,"Description":"The resource name"},"type":{"Type":235,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":236,"Flags":10,"Description":"The resource api version"},"properties":{"Type":238,"Flags":0,"Description":"Names for connection strings and application settings to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":239,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":240,"Flags":0,"Description":"List of application settings names."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":241,"Flags":9,"Description":"The resource name"},"type":{"Type":242,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":243,"Flags":10,"Description":"The resource api version"},"properties":{"Type":30,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":139,"authsettings":144,"backup":164,"connectionstrings":179,"logs":197,"metadata":228,"pushsettings":233,"slotConfigNames":237,"web":244}}},{"4":{"Name":"Microsoft.Web/sites/config@2016-08-01","ScopeType":8,"Body":245}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":247,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":248,"Flags":10,"Description":"The resource api version"},"properties":{"Type":250,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"Identifier for deployment."},"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"authorEmail":{"Type":4,"Flags":0,"Description":"Author email."},"startTime":{"Type":4,"Flags":0,"Description":"Start time."},"endTime":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2016-08-01","ScopeType":8,"Body":249}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":252,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":253,"Flags":10,"Description":"The resource api version"},"properties":{"Type":255,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2016-08-01","ScopeType":8,"Body":254}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":257,"Flags":9,"Description":"The resource name"},"type":{"Type":258,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":259,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":262,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":268,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[263,264,265,266,267]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2016-08-01","ScopeType":8,"Body":260}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":270,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":271,"Flags":10,"Description":"The resource api version"},"properties":{"Type":273,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"name":{"Type":4,"Flags":2,"Description":"Function name."},"functionAppId":{"Type":4,"Flags":2,"Description":"Function App ID."},"scriptRootPathHref":{"Type":4,"Flags":0,"Description":"Script root path URI."},"scriptHref":{"Type":4,"Flags":0,"Description":"Script URI."},"configHref":{"Type":4,"Flags":0,"Description":"Config URI."},"secretsFileHref":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":274,"Flags":0,"Description":"File list."},"testData":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2016-08-01","ScopeType":8,"Body":272}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":276,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":277,"Flags":10,"Description":"The resource api version"},"properties":{"Type":279,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":282,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":285,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":288,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":292,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[280,281]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[283,284]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[286,287]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[289,290,291]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2016-08-01","ScopeType":8,"Body":278}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":294,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":295,"Flags":10,"Description":"The resource api version"},"properties":{"Type":297,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2016-08-01","ScopeType":8,"Body":296}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":299,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":300,"Flags":10,"Description":"The resource api version"},"properties":{"Type":302,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2016-08-01","ScopeType":8,"Body":301}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":304,"Flags":9,"Description":"The resource name"},"type":{"Type":305,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":306,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2016-08-01","ScopeType":8,"Body":307}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":309,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":310,"Flags":10,"Description":"The resource api version"},"properties":{"Type":312,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":314,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"name":{"Type":4,"Flags":0,"Description":"Premier add on Name."},"location":{"Type":4,"Flags":0,"Description":"Premier add on Location."},"tags":{"Type":313,"Flags":0,"Description":"Premier add on Tags."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"PremierAddOnPropertiesTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2016-08-01","ScopeType":8,"Body":311}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":316,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":317,"Flags":10,"Description":"The resource api version"},"properties":{"Type":319,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":323,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[320,321,322]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2016-08-01","ScopeType":8,"Body":318}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":325,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":326,"Flags":10,"Description":"The resource api version"},"properties":{"Type":328,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2,"Description":"Site extension title."},"type":{"Type":331,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extensionUrl":{"Type":4,"Flags":2,"Description":"Extension URL."},"projectUrl":{"Type":4,"Flags":2,"Description":"Project URL."},"iconUrl":{"Type":4,"Flags":2,"Description":"Icon URL."},"licenseUrl":{"Type":4,"Flags":2,"Description":"License URL."},"feedUrl":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":332,"Flags":2,"Description":"List of authors."},"installationArgs":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"publishedDateTime":{"Type":4,"Flags":2,"Description":"Published timestamp."},"downloadCount":{"Type":3,"Flags":2,"Description":"Count of downloads."},"localIsLatestVersion":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"localPath":{"Type":4,"Flags":2,"Description":"Local path."},"installedDateTime":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[329,330]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2016-08-01","ScopeType":8,"Body":327}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":334,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":335,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":113,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":337,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2016-08-01","ScopeType":8,"Body":336}},{"6":{"Value":"discover"}},{"6":{"Value":"Microsoft.Web/sites/slots/backups"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/backups","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":339,"Flags":9,"Description":"The resource name"},"type":{"Type":340,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":341,"Flags":10,"Description":"The resource api version"},"properties":{"Type":122,"Flags":0,"Description":"RestoreRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/backups@2016-08-01","ScopeType":8,"Body":342}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":344,"Flags":9,"Description":"The resource name"},"type":{"Type":345,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":346,"Flags":10,"Description":"The resource api version"},"properties":{"Type":348,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":349,"Flags":9,"Description":"The resource name"},"type":{"Type":350,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":351,"Flags":10,"Description":"The resource api version"},"properties":{"Type":145,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":353,"Flags":9,"Description":"The resource name"},"type":{"Type":354,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":355,"Flags":10,"Description":"The resource api version"},"properties":{"Type":165,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":357,"Flags":9,"Description":"The resource name"},"type":{"Type":358,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":359,"Flags":10,"Description":"The resource api version"},"properties":{"Type":361,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":180}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":362,"Flags":9,"Description":"The resource name"},"type":{"Type":363,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":364,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":366,"Flags":9,"Description":"The resource name"},"type":{"Type":367,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":368,"Flags":10,"Description":"The resource api version"},"properties":{"Type":370,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":371,"Flags":9,"Description":"The resource name"},"type":{"Type":372,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":373,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":375,"Flags":9,"Description":"The resource name"},"type":{"Type":376,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":377,"Flags":10,"Description":"The resource api version"},"properties":{"Type":30,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":347,"authsettings":352,"backup":356,"connectionstrings":360,"logs":365,"metadata":369,"pushsettings":374,"web":378}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2016-08-01","ScopeType":8,"Body":379}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":381,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":382,"Flags":10,"Description":"The resource api version"},"properties":{"Type":250,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2016-08-01","ScopeType":8,"Body":383}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":385,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":386,"Flags":10,"Description":"The resource api version"},"properties":{"Type":255,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2016-08-01","ScopeType":8,"Body":387}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2016-08-01","ScopeType":8,"Body":392}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":394,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":395,"Flags":10,"Description":"The resource api version"},"properties":{"Type":273,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2016-08-01","ScopeType":8,"Body":396}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":279,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2016-08-01","ScopeType":8,"Body":400}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":402,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":403,"Flags":10,"Description":"The resource api version"},"properties":{"Type":297,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2016-08-01","ScopeType":8,"Body":404}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":406,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":407,"Flags":10,"Description":"The resource api version"},"properties":{"Type":302,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2016-08-01","ScopeType":8,"Body":408}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":410,"Flags":9,"Description":"The resource name"},"type":{"Type":411,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":412,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2016-08-01","ScopeType":8,"Body":413}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":415,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":416,"Flags":10,"Description":"The resource api version"},"properties":{"Type":312,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":418,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2016-08-01","ScopeType":8,"Body":417}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":420,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":421,"Flags":10,"Description":"The resource api version"},"properties":{"Type":319,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2016-08-01","ScopeType":8,"Body":422}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":424,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":425,"Flags":10,"Description":"The resource api version"},"properties":{"Type":328,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2016-08-01","ScopeType":8,"Body":426}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2016-08-01","ScopeType":8,"Body":431}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":434,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":435,"Flags":10,"Description":"The resource api version"},"properties":{"Type":437,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":0,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":444,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":439,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of this route. This is only returned by the server and does not need to be set by the client."},"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":443,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[440,441,442,4]}},{"3":{"ItemType":438}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2016-08-01","ScopeType":8,"Body":436}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":446,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":447,"Flags":10,"Description":"The resource api version"},"properties":{"Type":449,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2016-08-01","ScopeType":8,"Body":448}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":451,"Flags":9,"Description":"The resource name"},"type":{"Type":452,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":453,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2016-08-01","ScopeType":8,"Body":454}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":456,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":457,"Flags":10,"Description":"The resource api version"},"properties":{"Type":437,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2016-08-01","ScopeType":8,"Body":458}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2016-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":460,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":461,"Flags":10,"Description":"The resource api version"},"properties":{"Type":449,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2016-08-01","ScopeType":8,"Body":462}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":165,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":466,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":477,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":478,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[467,468,469,470,471,472,473,474,475,476]}},{"3":{"ItemType":123}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2016-08-01","Output":465,"Input":464}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":481,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2016-08-01","Output":480}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":484,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"triggerUrl":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2016-08-01","Output":483}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":487,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","ApiVersion":"2016-08-01","Output":486}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2016-08-01","Output":483}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2016-08-01","Output":465,"Input":464}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2016-08-01","Output":480}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2016-08-01","Output":483}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","ApiVersion":"2016-08-01","Output":486}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2016-08-01","Output":483}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2016-08-01/types.md b/generated/web/microsoft.web/2016-08-01/types.md index 63f06ebb27..4be06398b5 100644 --- a/generated/web/microsoft.web/2016-08-01/types.md +++ b/generated/web/microsoft.web/2016-08-01/types.md @@ -548,50 +548,128 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2016-08-01 * **Output**: [FunctionSecrets](#functionsecrets) -## ManagedServiceIdentity +## ApiDefinitionInfo ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'SystemAssigned': Type of managed service identity. +* **url**: string: The URL of the API definition. -## SiteProperties +## ApplicationLogsConfig ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **snapshotInfo**: [SnapshotRecoveryRequest](#snapshotrecoveryrequest) (WriteOnly): Details about app recovery operation. -* **state**: string (ReadOnly): Current state of the app. -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AutoHealActions +### Properties +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action + +## AutoHealCustomAction +### Properties +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. + +## AutoHealRules +### Properties +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. + +## AutoHealTriggers +### Properties +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureTableStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. + +## BackupItem +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. + +## BackupItem +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. + +## BackupItemProperties +### Properties +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. + +## BackupRequest +### Properties +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. + +## BackupRequest +### Properties +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. + +## BackupRequestProperties +### Properties +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **name**: string (Required): Name of the backup. +* **storageAccountUrl**: string (Required): SAS URL to the container. +* **type**: 'Clone' | 'Default' | 'Relocation' | 'Snapshot': Type of the backup. + +## BackupSchedule +### Properties +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. ## CloningInfo ### Properties @@ -617,174 +695,266 @@ together to use the same snapshot. ### Additional Properties * **Additional Properties Type**: string -## HostingEnvironmentProfile +## ConnectionStringDictionaryProperties ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## HostNameSslState +## ConnectionStringDictionaryProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteConfig +## ConnStringInfo ### Properties -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. + +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CorsSettings +### Properties +* **allowedOrigins**: string[]: 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. + +## DatabaseBackupSetting +### Properties +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string + +## DeploymentProperties +### Properties +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **authorEmail**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **endTime**: string: End time. +* **id**: string: Identifier for deployment. +* **message**: string: Details about deployment status. +* **startTime**: string: Start time. +* **status**: int: Deployment status. + +## EnabledConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. + +## Experiments +### Properties +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. + +## FileSystemApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. + +## FunctionEnvelopeProperties +### Properties +* **config**: any: Any object +* **configHref**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **functionAppId**: string (ReadOnly): Function App ID. +* **href**: string: Function URI. +* **name**: string (ReadOnly): Function name. +* **scriptHref**: string: Script URI. +* **scriptRootPathHref**: string: Script root path URI. +* **secretsFileHref**: string: Secrets file URI. +* **testData**: string: Test data used when testing via the Azure Portal. + +## FunctionEnvelopePropertiesFiles +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## ApiDefinitionInfo +## FunctionSecretsProperties ### Properties -* **url**: string: The URL of the API definition. +* **key**: string (ReadOnly): Secret key. +* **triggerUrl**: string (ReadOnly): Trigger URL. -## NameValuePair +## HandlerMapping ### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## AutoHealRules +## HostingEnvironmentProfile ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## AutoHealActions +## HostNameBindingProperties ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AutoHealCustomAction +## HostNameSslState ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AutoHealTriggers +## HttpLogsConfig ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## RequestsBasedTrigger +## HybridConnectionKey ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## SlowRequestsBasedTrigger +## HybridConnectionKey ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## StatusCodesBasedTrigger +## HybridConnectionKeyProperties ### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## ConnStringInfo +## HybridConnectionProperties ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## CorsSettings +## IdentifierProperties ### Properties -* **allowedOrigins**: string[]: 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. +* **id**: string: String representation of the identity. -## Experiments +## IpSecurityRestriction ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **ipAddress**: string (Required): IP address the security restriction is valid for. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -## RampUpRule +## ManagedServiceIdentity ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'SystemAssigned' | string: Type of managed service identity. -## HandlerMapping +## MSDeployCore ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## IpSecurityRestriction +## MSDeployCoreSetParameters ### Properties -* **ipAddress**: string (Required): IP address the security restriction is valid for. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +### Additional Properties +* **Additional Properties Type**: string -## SiteLimits +## NameValuePair ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **name**: string: Pair name. +* **value**: string: Pair value. -## SiteMachineKey +## PremierAddOnProperties ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **location**: string: Premier add on Location. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **name**: string: Premier add on Name. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **tags**: [PremierAddOnPropertiesTags](#premieraddonpropertiestags): Premier add on Tags. +* **vendor**: string: Premier add on Vendor. + +## PremierAddOnPropertiesTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## PublicCertificateProperties +### Properties +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint ## PushSettings ### Properties @@ -804,47 +974,49 @@ Tags can consist of alphanumeric characters and the following: Validation should be performed at the PushRequestHandler. * **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## VirtualApplication +## RampUpRule ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. -## VirtualDirectory +## RelayServiceConnectionEntityProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## SlotSwapStatus +## RequestsBasedTrigger ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. -## SnapshotRecoveryRequest +## ResourceTags ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [SnapshotRecoveryRequestProperties](#snapshotrecoveryrequestproperties): SnapshotRecoveryRequest resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## SnapshotRecoveryRequestProperties +## ResourceTags ### Properties -* **ignoreConflictingHostNames**: bool: If true, custom hostname conflicts will be ignored when recovering to a target web app. -This setting is only necessary when RecoverConfiguration is enabled. -* **overwrite**: bool (Required): If true the recovery operation can overwrite source app; otherwise, false. -* **recoverConfiguration**: bool: If true, site configuration, in addition to content, will be reverted. -* **recoveryTarget**: [SnapshotRecoveryTarget](#snapshotrecoverytarget): Specifies the web app that snapshot contents will be written to. -* **snapshotTime**: string: Point in time in which the app recovery should be attempted, formatted as a DateTime string. +### Additional Properties +* **Additional Properties Type**: string -## SnapshotRecoveryTarget +## ResourceTags ### Properties -* **id**: string: 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. -* **location**: string: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties @@ -862,22 +1034,9 @@ This setting is only necessary when RecoverConfiguration is enabled. the app's object when it is being restored, but that might fail due to conflicts during the operation. * **ignoreDatabases**: bool: Ignore the databases and only restore the site content * **operationType**: 'Clone' | 'Default' | 'Relocation' | 'Snapshot': Type of the backup. -* **overwrite**: bool (Required): true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. -* **siteName**: string: Name of an app. -* **storageAccountUrl**: string (Required): SAS URL to the container. - -## DatabaseBackupSetting -### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **overwrite**: bool (Required): true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. +* **siteName**: string: Name of an app. +* **storageAccountUrl**: string (Required): SAS URL to the container. ## SiteAuthSettingsProperties ### Properties @@ -946,220 +1105,53 @@ This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in * **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -## BackupRequestProperties -### Properties -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **name**: string (Required): Name of the backup. -* **storageAccountUrl**: string (Required): SAS URL to the container. -* **type**: 'Clone' | 'Default' | 'Relocation' | 'Snapshot': Type of the backup. - -## BackupSchedule -### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. - -## ConnectionStringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) - -## ConnStringValueTypePair -### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. - -## SiteLogsConfigProperties -### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. - -## ApplicationLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. - -## AzureBlobStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. - -## AzureTableStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. - -## FileSystemApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. - -## EnabledConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. - -## HttpLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. - -## AzureBlobStorageHttpLogsConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. - -## FileSystemHttpLogsConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SlotConfigNames -### Properties -* **appSettingNames**: string[]: List of application settings names. -* **connectionStringNames**: string[]: List of connection string names. - -## DeploymentProperties -### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **authorEmail**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **endTime**: string: End time. -* **id**: string: Identifier for deployment. -* **message**: string: Details about deployment status. -* **startTime**: string: Start time. -* **status**: int: Deployment status. - -## IdentifierProperties -### Properties -* **id**: string: String representation of the identity. - -## MSDeployCore -### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation - -## MSDeployCoreSetParameters -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## FunctionEnvelopeProperties -### Properties -* **config**: any: Any object -* **configHref**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **functionAppId**: string (ReadOnly): Function App ID. -* **href**: string: Function URI. -* **name**: string (ReadOnly): Function name. -* **scriptHref**: string: Script URI. -* **scriptRootPathHref**: string: Script root path URI. -* **secretsFileHref**: string: Secrets file URI. -* **testData**: string: Test data used when testing via the Azure Portal. - -## FunctionEnvelopePropertiesFiles -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostNameBindingProperties -### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. - -## RelayServiceConnectionEntityProperties -### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string - -## HybridConnectionProperties -### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net - -## PremierAddOnProperties -### Properties -* **location**: string: Premier add on Location. -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **name**: string: Premier add on Name. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **tags**: [PremierAddOnPropertiesTags](#premieraddonpropertiestags): Premier add on Tags. -* **vendor**: string: Premier add on Vendor. - -## PremierAddOnPropertiesTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PublicCertificateProperties +## SiteConfig ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. ## SiteExtensionInfoProperties ### Properties @@ -1184,30 +1176,64 @@ normally, use the POST /listKeys API instead. * **type**: 'Gallery' | 'WebRoot' (ReadOnly): Site extension type. * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **snapshotInfo**: [SnapshotRecoveryRequest](#snapshotrecoveryrequest) (WriteOnly): Details about app recovery operation. +* **state**: string (ReadOnly): Current state of the app. +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -1217,74 +1243,63 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties +## SlotConfigNames ### Properties -* **certBlob**: any: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **appSettingNames**: string[]: List of application settings names. +* **connectionStringNames**: string[]: List of connection string names. -## VnetRoute +## SlotSwapStatus +### Properties +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. + +## SlowRequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. + +## SnapshotRecoveryRequest ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties +* **properties**: [SnapshotRecoveryRequestProperties](#snapshotrecoveryrequestproperties): SnapshotRecoveryRequest resource specific properties * **type**: string (ReadOnly): Resource type. -## VnetRouteProperties +## SnapshotRecoveryRequestProperties ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **name**: string: The name of this route. This is only returned by the server and does not need to be set by the client. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **ignoreConflictingHostNames**: bool: If true, custom hostname conflicts will be ignored when recovering to a target web app. +This setting is only necessary when RecoverConfiguration is enabled. +* **overwrite**: bool (Required): If true the recovery operation can overwrite source app; otherwise, false. +* **recoverConfiguration**: bool: If true, site configuration, in addition to content, will be reverted. +* **recoveryTarget**: [SnapshotRecoveryTarget](#snapshotrecoverytarget): Specifies the web app that snapshot contents will be written to. +* **snapshotTime**: string: Point in time in which the app recovery should be attempted, formatted as a DateTime string. -## VnetGatewayProperties +## SnapshotRecoveryTarget ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **id**: string: 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. +* **location**: string: Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS -## BackupRequest +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -1298,85 +1313,70 @@ These values will be used for syncing an app's routes with those from a Virtual ### Additional Properties * **Additional Properties Type**: string -## BackupRequest +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## BackupItem +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## VirtualApplication ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## HybridConnectionKey +## VirtualDirectory ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. -## FunctionSecrets +## VnetGatewayProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. -## FunctionSecretsProperties +## VnetInfoProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **triggerUrl**: string (ReadOnly): Trigger URL. +* **certBlob**: any: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. -## FunctionSecrets +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## VnetRouteProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **name**: string: The name of this route. This is only returned by the server and does not need to be set by the client. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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 -## FunctionSecrets -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +These values will be used for syncing an app's routes with those from a Virtual Network. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. diff --git a/generated/web/microsoft.web/2016-09-01/types.json b/generated/web/microsoft.web/2016-09-01/types.json index 8180e6c461..c5f87495af 100644 --- a/generated/web/microsoft.web/2016-09-01/types.json +++ b/generated/web/microsoft.web/2016-09-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":59,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":27,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":34,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":36,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":50,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":55,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":57,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":58,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"5":{"Elements":[24,25,26]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":32,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":33,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[29,30,31]}},{"3":{"ItemType":4}},{"3":{"ItemType":28}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."}}}},{"3":{"ItemType":35}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":41,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":49,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[38,39,40]}},{"6":{"Value":"Default"}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"5":{"Elements":[42,43,44,45,46,47,48]}},{"3":{"ItemType":37}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":54,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[52,53]}},{"3":{"ItemType":51}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":56}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2016-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":61,"Flags":9,"Description":"The resource name"},"type":{"Type":62,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":63,"Flags":10,"Description":"The resource api version"},"properties":{"Type":28,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":65,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":66,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":67,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":69,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":68}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2016-09-01","ScopeType":8,"Body":64}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":71,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":72,"Flags":10,"Description":"The resource api version"},"properties":{"Type":28,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":65,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2016-09-01","ScopeType":8,"Body":73}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":75,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":76,"Flags":10,"Description":"The resource api version"},"properties":{"Type":78,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":65,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":90,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name for the App Service plan."},"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":82,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"adminSiteName":{"Type":4,"Flags":0,"Description":"App Service plan administration site."},"hostingEnvironmentProfile":{"Type":83,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":89,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[79,80,81]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[84,85,86,87,88]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2016-09-01","ScopeType":8,"Body":77}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":92,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":93,"Flags":10,"Description":"The resource api version"},"properties":{"Type":95,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2016-09-01","ScopeType":8,"Body":94}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":97,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":98,"Flags":10,"Description":"The resource api version"},"properties":{"Type":100,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"name":{"Type":4,"Flags":4,"Description":"The name of this route. This is only returned by the server and does not need to be set by the client."},"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":104,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[101,102,103]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2016-09-01","ScopeType":8,"Body":99}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":107,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2016-09-01","Output":106}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":59,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":27,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":34,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":36,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":50,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":55,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":57,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":58,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"5":{"Elements":[24,25,26]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":32,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":33,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[29,30,31]}},{"3":{"ItemType":4}},{"3":{"ItemType":28}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."}}}},{"3":{"ItemType":35}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":41,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":49,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[38,39,40]}},{"6":{"Value":"Default"}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"5":{"Elements":[42,43,44,45,46,47,48]}},{"3":{"ItemType":37}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":54,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[52,53]}},{"3":{"ItemType":51}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":56}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2016-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":61,"Flags":9,"Description":"The resource name"},"type":{"Type":62,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":63,"Flags":10,"Description":"The resource api version"},"properties":{"Type":28,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":65,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":66,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":67,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":69,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":68}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2016-09-01","ScopeType":8,"Body":64}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":71,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":72,"Flags":10,"Description":"The resource api version"},"properties":{"Type":28,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":65,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2016-09-01","ScopeType":8,"Body":73}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":75,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":76,"Flags":10,"Description":"The resource api version"},"properties":{"Type":78,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":65,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":90,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name for the App Service plan."},"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":82,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"adminSiteName":{"Type":4,"Flags":0,"Description":"App Service plan administration site."},"hostingEnvironmentProfile":{"Type":83,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":89,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[79,80,81]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[84,85,86,87,88]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2016-09-01","ScopeType":8,"Body":77}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":92,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":93,"Flags":10,"Description":"The resource api version"},"properties":{"Type":95,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2016-09-01","ScopeType":8,"Body":94}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2016-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":97,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":98,"Flags":10,"Description":"The resource api version"},"properties":{"Type":100,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"name":{"Type":4,"Flags":4,"Description":"The name of this route. This is only returned by the server and does not need to be set by the client."},"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":104,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[101,102,103,4]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2016-09-01","ScopeType":8,"Body":99}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":107,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2016-09-01","Output":106}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2016-09-01/types.md b/generated/web/microsoft.web/2016-09-01/types.md index a3f53fd376..71e400a2a7 100644 --- a/generated/web/microsoft.web/2016-09-01/types.md +++ b/generated/web/microsoft.web/2016-09-01/types.md @@ -113,28 +113,57 @@ * **vnetSubnetName**: string: Subnet of the Virtual Network. * **workerPools**: [WorkerPool](#workerpool)[] (Required): Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. +## AppServicePlanProperties +### Properties +* **adminSiteName**: string: App Service plan administration site. +* **geoRegion**: string (ReadOnly): Geographical location for the App Service plan. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **isSpot**: bool: If true, this App Service Plan owns spot instances. +* **maximumNumberOfWorkers**: int (ReadOnly): Maximum number of instances that can be assigned to this App Service plan. +* **name**: string (Required): Name for the App Service plan. +* **numberOfSites**: int (ReadOnly): Number of apps assigned to this App Service plan. +* **perSiteScaling**: bool: 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. +* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' (ReadOnly): Provisioning state of the App Service Environment. +* **reserved**: bool: If Linux app service plan true, false otherwise. +* **resourceGroup**: string (ReadOnly): Resource group of the App Service plan. +* **spotExpirationTime**: string: The time when the server farm expires. Valid only if it is a spot server farm. +* **status**: 'Creating' | 'Pending' | 'Ready' (ReadOnly): App Service plan status. +* **subscription**: string (ReadOnly): App Service plan subscription. +* **targetWorkerCount**: int: Scaling worker count. +* **targetWorkerSizeId**: int: Scaling worker size ID. +* **workerTierName**: string: Target worker tier assigned to the App Service plan. + +## Capability +### Properties +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. + +## HostingEnvironmentProfile +### Properties +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. + +## HybridConnectionKey +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. + +## HybridConnectionKeyProperties +### Properties +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. + ## NameValuePair ### Properties * **name**: string: Pair name. * **value**: string: Pair value. -## StampCapacity -### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. -Basic apps are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. -* **name**: string: Name of the stamp. -* **siteMode**: string: Shared or Dedicated. -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). -* **unit**: string: Name of the unit. -* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'Small': Size of the machines. -* **workerSizeId**: int: Size ID of machines: -0 - Small -1 - Medium -2 - Large - ## NetworkAccessControlEntry ### Properties * **action**: 'Deny' | 'Permit': Action object. @@ -142,33 +171,23 @@ Basic apps are not used for capacity allocation. * **order**: int: Order of precedence. * **remoteSubnet**: string: Remote subnet. -## VirtualIPMapping -### Properties -* **internalHttpPort**: int: Internal HTTP port. -* **internalHttpsPort**: int: Internal HTTPS port. -* **inUse**: bool: Is virtual IP mapping in use. -* **virtualIP**: string: Virtual IP address. - -## VirtualNetworkProfile -### Properties -* **id**: string: Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## WorkerPool +## ResourceTags ### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## SkuCapacity +### Properties +* **default**: int: Default number of workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. + ## SkuDescription ### Properties * **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? @@ -180,50 +199,36 @@ Basic apps are not used for capacity allocation. * **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. * **tier**: string: Service tier of the resource SKU. -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## AppServicePlanProperties +## StampCapacity ### Properties -* **adminSiteName**: string: App Service plan administration site. -* **geoRegion**: string (ReadOnly): Geographical location for the App Service plan. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **isSpot**: bool: If true, this App Service Plan owns spot instances. -* **maximumNumberOfWorkers**: int (ReadOnly): Maximum number of instances that can be assigned to this App Service plan. -* **name**: string (Required): Name for the App Service plan. -* **numberOfSites**: int (ReadOnly): Number of apps assigned to this App Service plan. -* **perSiteScaling**: bool: 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. -* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' (ReadOnly): Provisioning state of the App Service Environment. -* **reserved**: bool: If Linux app service plan true, false otherwise. -* **resourceGroup**: string (ReadOnly): Resource group of the App Service plan. -* **spotExpirationTime**: string: The time when the server farm expires. Valid only if it is a spot server farm. -* **status**: 'Creating' | 'Pending' | 'Ready' (ReadOnly): App Service plan status. -* **subscription**: string (ReadOnly): App Service plan subscription. -* **targetWorkerCount**: int: Scaling worker count. -* **targetWorkerSizeId**: int: Scaling worker size ID. -* **workerTierName**: string: Target worker tier assigned to the App Service plan. +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. +Basic apps are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. +* **name**: string: Name of the stamp. +* **siteMode**: string: Shared or Dedicated. +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). +* **unit**: string: Name of the unit. +* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'Small': Size of the machines. +* **workerSizeId**: int: Size ID of machines: +0 - Small +1 - Medium +2 - Large -## HostingEnvironmentProfile +## VirtualIPMapping ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **internalHttpPort**: int: Internal HTTP port. +* **internalHttpsPort**: int: Internal HTTPS port. +* **inUse**: bool: Is virtual IP mapping in use. +* **virtualIP**: string: Virtual IP address. -## ResourceTags +## VirtualNetworkProfile ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). ## VnetGatewayProperties ### Properties @@ -234,7 +239,7 @@ If false, apps assigned to this App Service plan will scale to all ### Properties * **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. * **name**: string (WriteOnly): The name of this route. This is only returned by the server and does not need to be set by the client. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' (WriteOnly): The type of route this is: +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | string (WriteOnly): 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 @@ -242,16 +247,11 @@ 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. * **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. -## HybridConnectionKey -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. - -## HybridConnectionKeyProperties +## WorkerPool ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2018-02-01/types.json b/generated/web/microsoft.web/2018-02-01/types.json index fa67f8d09b..6e7feaeeef 100644 --- a/generated/web/microsoft.web/2018-02-01/types.json +++ b/generated/web/microsoft.web/2018-02-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":8,"Flags":9,"Description":"The resource name"},"type":{"Type":9,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":10,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2018-02-01","ScopeType":1,"Body":11}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":14,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":15,"Flags":10,"Description":"The resource api version"},"properties":{"Type":17,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2018-02-01","ScopeType":1,"Body":16}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":19,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":20,"Flags":10,"Description":"The resource api version"},"properties":{"Type":22,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":70,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":28,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":33,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":34,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":38,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":45,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":47,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":61,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":66,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":68,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":69,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[23,24,25,26,27]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"5":{"Elements":[35,36,37]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":43,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":44,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[40,41,42]}},{"3":{"ItemType":4}},{"3":{"ItemType":39}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."}}}},{"3":{"ItemType":46}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":52,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":60,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[49,50,51]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"Default"}},{"5":{"Elements":[53,54,55,56,57,58,59]}},{"3":{"ItemType":48}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":65,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[63,64]}},{"3":{"ItemType":62}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":67}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2018-02-01","ScopeType":8,"Body":21}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":72,"Flags":9,"Description":"The resource name"},"type":{"Type":73,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":74,"Flags":10,"Description":"The resource api version"},"properties":{"Type":39,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":76,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":77,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":78,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":80,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":79}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2018-02-01","ScopeType":8,"Body":75}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":82,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":83,"Flags":10,"Description":"The resource api version"},"properties":{"Type":39,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":76,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2018-02-01","ScopeType":8,"Body":84}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":86,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":87,"Flags":10,"Description":"The resource api version"},"properties":{"Type":89,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":76,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":101,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":93,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":94,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":100,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[90,91,92]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[95,96,97,98,99]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2018-02-01","ScopeType":8,"Body":88}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":103,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":104,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2018-02-01","ScopeType":8,"Body":105}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":108,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":109,"Flags":10,"Description":"The resource api version"},"properties":{"Type":111,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":115,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[112,113,114]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2018-02-01","ScopeType":8,"Body":110}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":117,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":118,"Flags":10,"Description":"The resource api version"},"properties":{"Type":120,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":242,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":250,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":121,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":124,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":125,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":129,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":138,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":139,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":230,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":94,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":231,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":233,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":239,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"geoDistributions":{"Type":241,"Flags":0,"Description":"GeoDistributions for this site"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[122,123]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[126,127,128]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":134,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":137,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[131,132,133]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[135,136]}},{"3":{"ItemType":130}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":140,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":141,"Flags":0,"Description":"Application settings."},"azureStorageAccounts":{"Type":150,"Flags":0,"Description":"User-provided Azure storage accounts."},"connectionStrings":{"Type":164,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":165,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":167,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":181,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":184,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":188,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":194,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":195,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":198,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":199,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":211,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":213,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":215,"Flags":0,"Description":"Information about the formal API definition for the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":220,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":221,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":225,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":229,"Flags":0,"Description":"State of FTP / FTPS service"},"reservedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of reserved instances.\nThis setting only applies to the Consumption Plan"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":67}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":145,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":149,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[143,144]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[146,147,148]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":142}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":163,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[152,153,154,155,156,157,158,159,160,161,162]}},{"3":{"ItemType":151}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":166}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"5":{"Elements":[168,169,170,171,172,173,174,175,176,177,178,179,180]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[182,183]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":187,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":186}},{"3":{"ItemType":185}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[189,190,191,192,193]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":197,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"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."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":196}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":200,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":205,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":201,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":203,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":204,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":202}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":209,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":210,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[206,207,208]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":212,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":214,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":219,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"5":{"Elements":[217,218]}},{"3":{"ItemType":216}},{"3":{"ItemType":216}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[222,223,224]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[226,227,228]}},{"3":{"ItemType":4}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":232,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[234,235,236,237,238]}},{"2":{"Name":"GeoDistribution","Properties":{"location":{"Type":4,"Flags":0,"Description":"Location."},"numberOfWorkers":{"Type":3,"Flags":0,"Description":"NumberOfWorkers."}}}},{"3":{"ItemType":240}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":247,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":249,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[243,244,245,246]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":248}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2018-02-01","ScopeType":8,"Body":119}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":252,"Flags":9,"Description":"The resource name"},"type":{"Type":253,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":254,"Flags":10,"Description":"The resource api version"},"properties":{"Type":256,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":257,"Flags":9,"Description":"The resource name"},"type":{"Type":258,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":259,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":264,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":265,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":271,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":272,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":273,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":274,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":275,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":276,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[262,263]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[266,267,268,269,270]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":277,"Flags":9,"Description":"The resource name"},"type":{"Type":278,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":279,"Flags":10,"Description":"The resource api version"},"properties":{"Type":281,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":142}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":282,"Flags":9,"Description":"The resource name"},"type":{"Type":283,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":284,"Flags":10,"Description":"The resource api version"},"properties":{"Type":286,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":287,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":297,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":290,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[288,289]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":296,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[292,293,294,295]}},{"3":{"ItemType":291}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":298,"Flags":9,"Description":"The resource name"},"type":{"Type":299,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":300,"Flags":10,"Description":"The resource api version"},"properties":{"Type":315,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":314,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[303,304,305,306,307,308,309,310,311,312,313]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":302}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":316,"Flags":9,"Description":"The resource name"},"type":{"Type":317,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":318,"Flags":10,"Description":"The resource api version"},"properties":{"Type":320,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":321,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":343,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":346,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":346,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":322,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":329,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":336,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":328,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[323,324,325,326,327]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":335,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[330,331,332,333,334]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":342,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[337,338,339,340,341]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":344,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":345,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":347,"Flags":9,"Description":"The resource name"},"type":{"Type":348,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":349,"Flags":10,"Description":"The resource api version"},"properties":{"Type":351,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":352,"Flags":9,"Description":"The resource name"},"type":{"Type":353,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":354,"Flags":10,"Description":"The resource api version"},"properties":{"Type":214,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":356,"Flags":9,"Description":"The resource name"},"type":{"Type":357,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":358,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":361,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":362,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":363,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":139,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":255,"authsettings":260,"azurestorageaccounts":280,"backup":285,"connectionstrings":301,"logs":319,"metadata":350,"pushsettings":355,"slotConfigNames":359,"web":367}}},{"4":{"Name":"Microsoft.Web/sites/config@2018-02-01","ScopeType":8,"Body":368}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":370,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":371,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2018-02-01","ScopeType":8,"Body":372}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-02-01","ScopeType":8,"Body":377}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":380,"Flags":9,"Description":"The resource name"},"type":{"Type":381,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":382,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":385,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":391,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[386,387,388,389,390]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2018-02-01","ScopeType":8,"Body":383}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":393,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":394,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":397,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2018-02-01","ScopeType":8,"Body":395}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":399,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":400,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2018-02-01","ScopeType":8,"Body":401}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":403,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":404,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":409,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":412,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":415,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":419,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[407,408]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[410,411]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[413,414]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[416,417,418]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2018-02-01","ScopeType":8,"Body":405}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":421,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":422,"Flags":10,"Description":"The resource api version"},"properties":{"Type":424,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-02-01","ScopeType":8,"Body":423}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":426,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":427,"Flags":10,"Description":"The resource api version"},"properties":{"Type":429,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2018-02-01","ScopeType":8,"Body":428}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":431,"Flags":9,"Description":"The resource name"},"type":{"Type":432,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":433,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2018-02-01","ScopeType":8,"Body":434}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":436,"Flags":9,"Description":"The resource name"},"type":{"Type":437,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":438,"Flags":10,"Description":"The resource api version"},"properties":{"Type":440,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2018-02-01","ScopeType":8,"Body":439}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":442,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":443,"Flags":10,"Description":"The resource api version"},"properties":{"Type":445,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":446,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2018-02-01","ScopeType":8,"Body":444}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":448,"Flags":9,"Description":"The resource name"},"type":{"Type":449,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":450,"Flags":10,"Description":"The resource api version"},"properties":{"Type":452,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":456,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":455,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":454}},{"3":{"ItemType":453}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2018-02-01","ScopeType":8,"Body":451}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":458,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":459,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":465,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[462,463,464]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2018-02-01","ScopeType":8,"Body":460}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":467,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":468,"Flags":10,"Description":"The resource api version"},"properties":{"Type":470,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":473,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":474,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[471,472]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2018-02-01","ScopeType":8,"Body":469}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":476,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":477,"Flags":10,"Description":"The resource api version"},"properties":{"Type":120,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":242,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":479,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2018-02-01","ScopeType":8,"Body":478}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":481,"Flags":9,"Description":"The resource name"},"type":{"Type":482,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":483,"Flags":10,"Description":"The resource api version"},"properties":{"Type":485,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":486,"Flags":9,"Description":"The resource name"},"type":{"Type":487,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":488,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":490,"Flags":9,"Description":"The resource name"},"type":{"Type":491,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":492,"Flags":10,"Description":"The resource api version"},"properties":{"Type":494,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":142}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":495,"Flags":9,"Description":"The resource name"},"type":{"Type":496,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":497,"Flags":10,"Description":"The resource api version"},"properties":{"Type":286,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":499,"Flags":9,"Description":"The resource name"},"type":{"Type":500,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":501,"Flags":10,"Description":"The resource api version"},"properties":{"Type":503,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":302}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":504,"Flags":9,"Description":"The resource name"},"type":{"Type":505,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":506,"Flags":10,"Description":"The resource api version"},"properties":{"Type":320,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":508,"Flags":9,"Description":"The resource name"},"type":{"Type":509,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":510,"Flags":10,"Description":"The resource api version"},"properties":{"Type":512,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":513,"Flags":9,"Description":"The resource name"},"type":{"Type":514,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":515,"Flags":10,"Description":"The resource api version"},"properties":{"Type":214,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":517,"Flags":9,"Description":"The resource name"},"type":{"Type":518,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":519,"Flags":10,"Description":"The resource api version"},"properties":{"Type":139,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":484,"authsettings":489,"azurestorageaccounts":493,"backup":498,"connectionstrings":502,"logs":507,"metadata":511,"pushsettings":516,"web":520}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2018-02-01","ScopeType":8,"Body":521}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":523,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":524,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2018-02-01","ScopeType":8,"Body":525}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":527,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":528,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-02-01","ScopeType":8,"Body":529}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":531,"Flags":9,"Description":"The resource name"},"type":{"Type":532,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":533,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2018-02-01","ScopeType":8,"Body":534}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":536,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":537,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2018-02-01","ScopeType":8,"Body":538}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":540,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":541,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2018-02-01","ScopeType":8,"Body":542}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":544,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":545,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2018-02-01","ScopeType":8,"Body":546}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":424,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-02-01","ScopeType":8,"Body":550}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":429,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2018-02-01","ScopeType":8,"Body":554}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2018-02-01","ScopeType":8,"Body":559}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":561,"Flags":9,"Description":"The resource name"},"type":{"Type":562,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":563,"Flags":10,"Description":"The resource api version"},"properties":{"Type":440,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2018-02-01","ScopeType":8,"Body":564}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":445,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":569,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2018-02-01","ScopeType":8,"Body":568}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":571,"Flags":9,"Description":"The resource name"},"type":{"Type":572,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":573,"Flags":10,"Description":"The resource api version"},"properties":{"Type":452,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2018-02-01","ScopeType":8,"Body":574}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":576,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":577,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2018-02-01","ScopeType":8,"Body":578}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":580,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":581,"Flags":10,"Description":"The resource api version"},"properties":{"Type":470,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2018-02-01","ScopeType":8,"Body":582}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":584,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"},"properties":{"Type":588,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2018-02-01","ScopeType":8,"Body":587}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":590,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":591,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":595,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":111,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":594}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-02-01","ScopeType":8,"Body":592}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":597,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":598,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-02-01","ScopeType":8,"Body":599}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":601,"Flags":9,"Description":"The resource name"},"type":{"Type":602,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":603,"Flags":10,"Description":"The resource api version"},"properties":{"Type":588,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2018-02-01","ScopeType":8,"Body":604}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":606,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":607,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2018-02-01","ScopeType":8,"Body":608}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":610,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":611,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-02-01","ScopeType":8,"Body":612}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":617,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":631,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":618,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":94,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":630,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[619,620,621,622,623,624,625,626,627,628,629]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2018-02-01","ScopeType":8,"Body":616}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":634,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2018-02-01","Output":633}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":286,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":638,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":649,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":650,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[639,640,641,642,643,644,645,646,647,648]}},{"3":{"ItemType":291}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2018-02-01","Output":637,"Input":636}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":653,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2018-02-01","Output":652}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2018-02-01","Output":652}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":657,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2018-02-01","Output":656}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":660,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":661,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2018-02-01","Output":659}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","ApiVersion":"2018-02-01","Output":633}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2018-02-01","Output":656}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2018-02-01","Output":637,"Input":636}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2018-02-01","Output":652}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2018-02-01","Output":652}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2018-02-01","Output":656}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2018-02-01","Output":659}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","ApiVersion":"2018-02-01","Output":633}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2018-02-01","Output":656}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":8,"Flags":9,"Description":"The resource name"},"type":{"Type":9,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":10,"Flags":10,"Description":"The resource api version"},"properties":{"Type":12,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2018-02-01","ScopeType":1,"Body":11}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":14,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":15,"Flags":10,"Description":"The resource api version"},"properties":{"Type":17,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2018-02-01","ScopeType":1,"Body":16}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":19,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":20,"Flags":10,"Description":"The resource api version"},"properties":{"Type":22,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":70,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":28,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":33,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":34,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":38,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":45,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":47,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":61,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":66,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":68,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":69,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[23,24,25,26,27]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[29,30,31,32]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"5":{"Elements":[35,36,37]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":43,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":44,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[40,41,42]}},{"3":{"ItemType":4}},{"3":{"ItemType":39}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."}}}},{"3":{"ItemType":46}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":52,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":60,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[49,50,51]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"Default"}},{"5":{"Elements":[53,54,55,56,57,58,59]}},{"3":{"ItemType":48}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":65,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[63,64]}},{"3":{"ItemType":62}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":67}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2018-02-01","ScopeType":8,"Body":21}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":72,"Flags":9,"Description":"The resource name"},"type":{"Type":73,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":74,"Flags":10,"Description":"The resource api version"},"properties":{"Type":39,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":76,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":77,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":78,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":80,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":79}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2018-02-01","ScopeType":8,"Body":75}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":82,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":83,"Flags":10,"Description":"The resource api version"},"properties":{"Type":39,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":76,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2018-02-01","ScopeType":8,"Body":84}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":86,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":87,"Flags":10,"Description":"The resource api version"},"properties":{"Type":89,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":76,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":101,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":93,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":94,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":100,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[90,91,92]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[95,96,97,98,99]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2018-02-01","ScopeType":8,"Body":88}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":103,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":104,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2018-02-01","ScopeType":8,"Body":105}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":108,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":109,"Flags":10,"Description":"The resource api version"},"properties":{"Type":111,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":115,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[112,113,114,4]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2018-02-01","ScopeType":8,"Body":110}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":117,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":118,"Flags":10,"Description":"The resource api version"},"properties":{"Type":120,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":242,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":250,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":121,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":124,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":125,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":129,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":138,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":139,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":230,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":94,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":231,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":233,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":239,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"geoDistributions":{"Type":241,"Flags":0,"Description":"GeoDistributions for this site"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[122,123]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[126,127,128]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":134,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":137,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[131,132,133]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[135,136]}},{"3":{"ItemType":130}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":140,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":141,"Flags":0,"Description":"Application settings."},"azureStorageAccounts":{"Type":150,"Flags":0,"Description":"User-provided Azure storage accounts."},"connectionStrings":{"Type":164,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":165,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":167,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":181,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":184,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":188,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":194,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":195,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":198,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":199,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":211,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":213,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":215,"Flags":0,"Description":"Information about the formal API definition for the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":220,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":221,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":225,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":229,"Flags":0,"Description":"State of FTP / FTPS service"},"reservedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of reserved instances.\nThis setting only applies to the Consumption Plan"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":67}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":145,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":149,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[143,144]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[146,147,148]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":142}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":163,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[152,153,154,155,156,157,158,159,160,161,162]}},{"3":{"ItemType":151}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":166}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"5":{"Elements":[168,169,170,171,172,173,174,175,176,177,178,179,180,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[182,183]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":187,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":186}},{"3":{"ItemType":185}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[189,190,191,192,193]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":197,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"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."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":196}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":200,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":205,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":201,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":203,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":204,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":202}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":209,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":210,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[206,207,208]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":212,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":214,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":219,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"5":{"Elements":[217,218]}},{"3":{"ItemType":216}},{"3":{"ItemType":216}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[222,223,224,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[226,227,228,4]}},{"3":{"ItemType":4}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":232,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[234,235,236,237,238]}},{"2":{"Name":"GeoDistribution","Properties":{"location":{"Type":4,"Flags":0,"Description":"Location."},"numberOfWorkers":{"Type":3,"Flags":0,"Description":"NumberOfWorkers."}}}},{"3":{"ItemType":240}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":247,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":249,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[243,244,245,246,4]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":248}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2018-02-01","ScopeType":8,"Body":119}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":252,"Flags":9,"Description":"The resource name"},"type":{"Type":253,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":254,"Flags":10,"Description":"The resource api version"},"properties":{"Type":256,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":257,"Flags":9,"Description":"The resource name"},"type":{"Type":258,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":259,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":264,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":265,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":271,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":272,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":273,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":274,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":275,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":276,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[262,263]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[266,267,268,269,270]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":277,"Flags":9,"Description":"The resource name"},"type":{"Type":278,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":279,"Flags":10,"Description":"The resource api version"},"properties":{"Type":281,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":142}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":282,"Flags":9,"Description":"The resource name"},"type":{"Type":283,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":284,"Flags":10,"Description":"The resource api version"},"properties":{"Type":286,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":287,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":297,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":290,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[288,289]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":296,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[292,293,294,295,4]}},{"3":{"ItemType":291}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":298,"Flags":9,"Description":"The resource name"},"type":{"Type":299,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":300,"Flags":10,"Description":"The resource api version"},"properties":{"Type":315,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":314,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[303,304,305,306,307,308,309,310,311,312,313]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":302}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":316,"Flags":9,"Description":"The resource name"},"type":{"Type":317,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":318,"Flags":10,"Description":"The resource api version"},"properties":{"Type":320,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":321,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":343,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":346,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":346,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":322,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":329,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":336,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":328,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[323,324,325,326,327]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":335,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[330,331,332,333,334]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":342,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[337,338,339,340,341]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":344,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":345,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":347,"Flags":9,"Description":"The resource name"},"type":{"Type":348,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":349,"Flags":10,"Description":"The resource api version"},"properties":{"Type":351,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":352,"Flags":9,"Description":"The resource name"},"type":{"Type":353,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":354,"Flags":10,"Description":"The resource api version"},"properties":{"Type":214,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":356,"Flags":9,"Description":"The resource name"},"type":{"Type":357,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":358,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":361,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":362,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":363,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":139,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":255,"authsettings":260,"azurestorageaccounts":280,"backup":285,"connectionstrings":301,"logs":319,"metadata":350,"pushsettings":355,"slotConfigNames":359,"web":367}}},{"4":{"Name":"Microsoft.Web/sites/config@2018-02-01","ScopeType":8,"Body":368}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":370,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":371,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2018-02-01","ScopeType":8,"Body":372}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-02-01","ScopeType":8,"Body":377}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":380,"Flags":9,"Description":"The resource name"},"type":{"Type":381,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":382,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":385,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":391,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[386,387,388,389,390]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2018-02-01","ScopeType":8,"Body":383}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":393,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":394,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":397,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2018-02-01","ScopeType":8,"Body":395}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":399,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":400,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2018-02-01","ScopeType":8,"Body":401}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":403,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":404,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":409,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":412,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":415,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":419,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[407,408]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[410,411]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[413,414]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[416,417,418]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2018-02-01","ScopeType":8,"Body":405}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":421,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":422,"Flags":10,"Description":"The resource api version"},"properties":{"Type":424,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-02-01","ScopeType":8,"Body":423}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":426,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":427,"Flags":10,"Description":"The resource api version"},"properties":{"Type":429,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2018-02-01","ScopeType":8,"Body":428}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":431,"Flags":9,"Description":"The resource name"},"type":{"Type":432,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":433,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2018-02-01","ScopeType":8,"Body":434}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":436,"Flags":9,"Description":"The resource name"},"type":{"Type":437,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":438,"Flags":10,"Description":"The resource api version"},"properties":{"Type":440,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2018-02-01","ScopeType":8,"Body":439}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":442,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":443,"Flags":10,"Description":"The resource api version"},"properties":{"Type":445,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":446,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2018-02-01","ScopeType":8,"Body":444}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":448,"Flags":9,"Description":"The resource name"},"type":{"Type":449,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":450,"Flags":10,"Description":"The resource api version"},"properties":{"Type":452,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":456,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":455,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":454}},{"3":{"ItemType":453}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2018-02-01","ScopeType":8,"Body":451}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":458,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":459,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":465,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[462,463,464]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2018-02-01","ScopeType":8,"Body":460}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":467,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":468,"Flags":10,"Description":"The resource api version"},"properties":{"Type":470,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":473,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":474,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[471,472]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2018-02-01","ScopeType":8,"Body":469}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":476,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":477,"Flags":10,"Description":"The resource api version"},"properties":{"Type":120,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":242,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":479,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2018-02-01","ScopeType":8,"Body":478}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":481,"Flags":9,"Description":"The resource name"},"type":{"Type":482,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":483,"Flags":10,"Description":"The resource api version"},"properties":{"Type":485,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":486,"Flags":9,"Description":"The resource name"},"type":{"Type":487,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":488,"Flags":10,"Description":"The resource api version"},"properties":{"Type":261,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":490,"Flags":9,"Description":"The resource name"},"type":{"Type":491,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":492,"Flags":10,"Description":"The resource api version"},"properties":{"Type":494,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":142}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":495,"Flags":9,"Description":"The resource name"},"type":{"Type":496,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":497,"Flags":10,"Description":"The resource api version"},"properties":{"Type":286,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":499,"Flags":9,"Description":"The resource name"},"type":{"Type":500,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":501,"Flags":10,"Description":"The resource api version"},"properties":{"Type":503,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":302}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":504,"Flags":9,"Description":"The resource name"},"type":{"Type":505,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":506,"Flags":10,"Description":"The resource api version"},"properties":{"Type":320,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":508,"Flags":9,"Description":"The resource name"},"type":{"Type":509,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":510,"Flags":10,"Description":"The resource api version"},"properties":{"Type":512,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":513,"Flags":9,"Description":"The resource name"},"type":{"Type":514,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":515,"Flags":10,"Description":"The resource api version"},"properties":{"Type":214,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":517,"Flags":9,"Description":"The resource name"},"type":{"Type":518,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":519,"Flags":10,"Description":"The resource api version"},"properties":{"Type":139,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":484,"authsettings":489,"azurestorageaccounts":493,"backup":498,"connectionstrings":502,"logs":507,"metadata":511,"pushsettings":516,"web":520}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2018-02-01","ScopeType":8,"Body":521}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":523,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":524,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2018-02-01","ScopeType":8,"Body":525}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":527,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":528,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-02-01","ScopeType":8,"Body":529}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":531,"Flags":9,"Description":"The resource name"},"type":{"Type":532,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":533,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2018-02-01","ScopeType":8,"Body":534}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":536,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":537,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2018-02-01","ScopeType":8,"Body":538}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":540,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":541,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2018-02-01","ScopeType":8,"Body":542}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":544,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":545,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2018-02-01","ScopeType":8,"Body":546}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":424,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-02-01","ScopeType":8,"Body":550}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":429,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2018-02-01","ScopeType":8,"Body":554}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":384,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2018-02-01","ScopeType":8,"Body":559}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":561,"Flags":9,"Description":"The resource name"},"type":{"Type":562,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":563,"Flags":10,"Description":"The resource api version"},"properties":{"Type":440,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2018-02-01","ScopeType":8,"Body":564}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":445,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":569,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2018-02-01","ScopeType":8,"Body":568}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":571,"Flags":9,"Description":"The resource name"},"type":{"Type":572,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":573,"Flags":10,"Description":"The resource api version"},"properties":{"Type":452,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2018-02-01","ScopeType":8,"Body":574}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":576,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":577,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2018-02-01","ScopeType":8,"Body":578}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":580,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":581,"Flags":10,"Description":"The resource api version"},"properties":{"Type":470,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2018-02-01","ScopeType":8,"Body":582}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":584,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"},"properties":{"Type":588,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2018-02-01","ScopeType":8,"Body":587}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":590,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":591,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":595,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":111,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":594}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-02-01","ScopeType":8,"Body":592}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":597,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":598,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-02-01","ScopeType":8,"Body":599}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":601,"Flags":9,"Description":"The resource name"},"type":{"Type":602,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":603,"Flags":10,"Description":"The resource api version"},"properties":{"Type":588,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2018-02-01","ScopeType":8,"Body":604}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":606,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":607,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2018-02-01","ScopeType":8,"Body":608}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":610,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":611,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-02-01","ScopeType":8,"Body":612}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2018-02-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":617,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":631,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":618,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":94,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":630,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[619,620,621,622,623,624,625,626,627,628,629]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2018-02-01","ScopeType":8,"Body":616}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":634,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2018-02-01","Output":633}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":286,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":638,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":649,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":650,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[639,640,641,642,643,644,645,646,647,648]}},{"3":{"ItemType":291}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2018-02-01","Output":637,"Input":636}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":653,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2018-02-01","Output":652}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2018-02-01","Output":652}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":657,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2018-02-01","Output":656}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":660,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":661,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2018-02-01","Output":659}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","ApiVersion":"2018-02-01","Output":633}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2018-02-01","Output":656}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2018-02-01","Output":637,"Input":636}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2018-02-01","Output":652}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2018-02-01","Output":652}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2018-02-01","Output":656}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2018-02-01","Output":659}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","ApiVersion":"2018-02-01","Output":633}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2018-02-01","Output":656}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2018-02-01/types.md b/generated/web/microsoft.web/2018-02-01/types.md index e939b66626..364538bdf6 100644 --- a/generated/web/microsoft.web/2018-02-01/types.md +++ b/generated/web/microsoft.web/2018-02-01/types.md @@ -729,38 +729,15 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2018-02-01 * **Output**: [FunctionSecrets](#functionsecrets) -## CertificateProperties -### Properties -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (Required, WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. - -## HostingEnvironmentProfile +## ApiDefinitionInfo ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **url**: string: The URL of the API definition. -## ResourceTags +## ApplicationLogsConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. ## AppServiceEnvironment ### Properties @@ -806,95 +783,6 @@ This is valid for all deployment slots in an app. * **vnetSubnetName**: string: Subnet of the Virtual Network. * **workerPools**: [WorkerPool](#workerpool)[] (Required): Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## StampCapacity -### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. -Basic apps are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. -* **isLinux**: bool: Is this a linux stamp capacity -* **name**: string: Name of the stamp. -* **siteMode**: string: Shared or Dedicated. -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). -* **unit**: string: Name of the unit. -* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'Small': Size of the machines. -* **workerSizeId**: int: Size ID of machines: -0 - Small -1 - Medium -2 - Large - -## NetworkAccessControlEntry -### Properties -* **action**: 'Deny' | 'Permit': Action object. -* **description**: string: Description of network access control entry. -* **order**: int: Order of precedence. -* **remoteSubnet**: string: Remote subnet. - -## VirtualIPMapping -### Properties -* **internalHttpPort**: int: Internal HTTP port. -* **internalHttpsPort**: int: Internal HTTPS port. -* **inUse**: bool: Is virtual IP mapping in use. -* **virtualIP**: string: Virtual IP address. - -## VirtualNetworkProfile -### Properties -* **id**: string: Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -918,244 +806,203 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## ResourceTags +## AutoHealActions ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## VnetGatewayProperties +## AutoHealCustomAction ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## VnetRouteProperties +## AutoHealRules ### Properties -* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' (WriteOnly): 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. -* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## ManagedServiceIdentity +## AutoHealTriggers ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -## ManagedServiceIdentityUserAssignedIdentities +## AzureBlobStorageApplicationLogsConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AzureBlobStorageHttpLogsConfig ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## SiteProperties +## AzureStorageInfoValue ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **geoDistributions**: [GeoDistribution](#geodistribution)[]: GeoDistributions for this site -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. -## CloningInfo +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## CloningInfoAppSettingsOverrides +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## GeoDistribution +## AzureTableStorageApplicationLogsConfig ### Properties -* **location**: string: Location. -* **numberOfWorkers**: int: NumberOfWorkers. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## HostNameSslState +## BackupItem ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## SiteConfig +## BackupItem ### Properties -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): User-provided Azure storage accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **reservedInstanceCount**: int: Number of reserved instances. -This setting only applies to the Consumption Plan -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## ApiDefinitionInfo +## BackupItemProperties ### Properties -* **url**: string: The URL of the API definition. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## AutoHealRules +## BackupRequest ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## AutoHealActions +## BackupRequest ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## AutoHealCustomAction +## BackupRequestProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## AutoHealTriggers +## BackupSchedule ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## RequestsBasedTrigger +## Capability ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. -## SlowRequestsBasedTrigger +## CertificateProperties ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (Required, WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. -## StatusCodesBasedTrigger +## CloningInfo ### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. -## SiteConfigAzureStorageAccounts +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## AzureStorageInfoValue +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) ## ConnStringInfo ### Properties @@ -1163,6 +1010,11 @@ before taking the action * **name**: string: Name of connection string. * **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + ## CorsSettings ### Properties * **allowedOrigins**: string[]: Gets or sets the list of origins that should be allowed to make cross-origin @@ -1171,299 +1023,244 @@ calls (for example: http://example.com:12345). Use "*" to allow all. https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. -## Experiments -### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. - -## RampUpRule -### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. - -## HandlerMapping -### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. - -## IpSecurityRestriction -### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag - -## SiteLimits +## DatabaseBackupSetting ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## SiteMachineKey +## DeploymentProperties ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## PushSettings +## EnabledConfig ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## PushSettingsProperties +## Experiments ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## VirtualApplication +## FileSystemApplicationLogsConfig ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -## VirtualDirectory +## FileSystemHttpLogsConfig ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. -## SlotSwapStatus +## FunctionEnvelopeProperties ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. -## ResourceTags +## FunctionEnvelopePropertiesFiles ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionaryProperties +## FunctionSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## SiteAuthSettingsProperties +## FunctionSecrets ### Properties -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookOAuthScopes**: 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 -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleOAuthScopes**: 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/ -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## AzureStoragePropertyDictionaryResourceProperties +## FunctionSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## BackupRequestProperties +## FunctionSecrets ### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## BackupSchedule +## FunctionSecretsProperties ### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## DatabaseBackupSetting +## GeoDistribution ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **location**: string: Location. +* **numberOfWorkers**: int: NumberOfWorkers. -## ConnectionStringDictionaryProperties +## HandlerMapping ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## ConnStringValueTypePair +## HostingEnvironmentProfile ### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## SiteLogsConfigProperties +## HostKeys ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## ApplicationLogsConfig +## HostKeys ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureBlobStorageApplicationLogsConfig +## HostKeysFunctionKeys ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +### Additional Properties +* **Additional Properties Type**: string -## AzureTableStorageApplicationLogsConfig +## HostKeysSystemKeys ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +### Additional Properties +* **Additional Properties Type**: string -## FileSystemApplicationLogsConfig +## HostNameBindingProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## EnabledConfig +## HostNameSslState ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. ## HttpLogsConfig ### Properties * **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. * **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## AzureBlobStorageHttpLogsConfig +## HybridConnectionKey ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## FileSystemHttpLogsConfig +## HybridConnectionKey ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## HybridConnectionKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## SlotConfigNames +## HybridConnectionKeyProperties ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## DeploymentProperties +## HybridConnectionProperties ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net ## IdentifierProperties ### Properties * **id**: string: String representation of the identity. +## IpSecurityRestriction +### Properties +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## ManagedServiceIdentity +### Properties +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} + +## ManagedServiceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) + ## MSDeployCore ### Properties * **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. @@ -1488,101 +1285,262 @@ Setting is false by default. ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## NameValuePair ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +* **name**: string: Pair name. +* **value**: string: Pair value. -## FunctionEnvelopePropertiesFiles +## NetworkAccessControlEntry ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Deny' | 'Permit': Action object. +* **description**: string: Description of network access control entry. +* **order**: int: Order of precedence. +* **remoteSubnet**: string: Remote subnet. -## HostNameBindingProperties +## PremierAddOnProperties ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. + +## PrivateAccessProperties +### Properties +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. + +## PrivateAccessSubnet +### Properties +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. + +## PrivateAccessVirtualNetwork +### Properties +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. + +## PublicCertificateProperties +### Properties +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint + +## PushSettings +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. + +## PushSettingsProperties +### Properties +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + +## RampUpRule +### Properties +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. + +## RelayServiceConnectionEntityProperties +### Properties +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string + +## RequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## RelayServiceConnectionEntityProperties +## ResourceTags ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionProperties +## ResourceTags ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +### Additional Properties +* **Additional Properties Type**: string -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResourceTags ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessVirtualNetwork +## SiteAuthSettingsProperties ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookOAuthScopes**: 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 +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleOAuthScopes**: 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/ +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PrivateAccessSubnet +## SiteConfig ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): User-provided Azure storage accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **reservedInstanceCount**: int: Number of reserved instances. +This setting only applies to the Consumption Plan +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id -## PublicCertificateProperties +## SiteConfigAzureStorageAccounts ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -1607,35 +1565,69 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **geoDistributions**: [GeoDistribution](#geodistribution)[]: GeoDistributions for this site +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -1645,24 +1637,41 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties +## SkuCapacity ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **default**: int: Default number of workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## VnetRoute +## SkuDescription ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. + +## SlotConfigNames +### Properties +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. + +## SlotSwapStatus +### Properties +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. + +## SlowRequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -1671,38 +1680,31 @@ Point-To-Site VPN connection. * **token**: string: OAuth access token. * **tokenSecret**: string: OAuth access token secret. -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StampCapacity ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties -* **type**: string (ReadOnly): Resource type. +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. +Basic apps are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. +* **isLinux**: bool: Is this a linux stamp capacity +* **name**: string: Name of the stamp. +* **siteMode**: string: Shared or Dedicated. +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). +* **unit**: string: Name of the unit. +* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'Small': Size of the machines. +* **workerSizeId**: int: Size ID of machines: +0 - Small +1 - Medium +2 - Large -## BackupItemProperties +## StatusCodesBasedTrigger ### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. ## StringDictionary ### Properties @@ -1712,25 +1714,12 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -1741,107 +1730,118 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKey +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKeyProperties +## StringDictionaryProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HybridConnectionKey +## SwiftVirtualNetworkProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## StringDictionary +## UserProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. -## HostKeys +## VirtualApplication ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## HybridConnectionKey +## VirtualDirectory ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. -## FunctionSecrets +## VirtualIPMapping ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **internalHttpPort**: int: Internal HTTP port. +* **internalHttpsPort**: int: Internal HTTPS port. +* **inUse**: bool: Is virtual IP mapping in use. +* **virtualIP**: string: Virtual IP address. -## FunctionSecretsProperties +## VirtualNetworkProfile ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **id**: string: Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). -## FunctionSecrets +## VnetGatewayProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. -## FunctionSecrets +## VnetInfoProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. -## FunctionSecrets +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. +## VnetRouteProperties +### Properties +* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | string (WriteOnly): 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. +* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. + diff --git a/generated/web/microsoft.web/2018-11-01/types.json b/generated/web/microsoft.web/2018-11-01/types.json index c1fd7fdd87..7b86f0a344 100644 --- a/generated/web/microsoft.web/2018-11-01/types.json +++ b/generated/web/microsoft.web/2018-11-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2018-11-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":28,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":29,"Flags":10,"Description":"The resource api version"},"properties":{"Type":31,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":154,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":162,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":32,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":35,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":36,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":40,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":49,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":50,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":142,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":143,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":145,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":151,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"geoDistributions":{"Type":153,"Flags":0,"Description":"GeoDistributions for this site"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[33,34]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[37,38,39]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":45,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":48,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[42,43,44]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[46,47]}},{"3":{"ItemType":41}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":51,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":53,"Flags":0,"Description":"Application settings."},"azureStorageAccounts":{"Type":62,"Flags":0,"Description":"User-provided Azure storage accounts."},"connectionStrings":{"Type":76,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":77,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":79,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":93,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":96,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":100,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":106,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":107,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":110,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":111,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":123,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":125,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":127,"Flags":0,"Description":"Information about the formal API definition for the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":132,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":133,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":137,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":141,"Flags":0,"Description":"State of FTP / FTPS service"},"reservedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of reserved instances.\nThis setting only applies to the Consumption Plan"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":52}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":57,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":61,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[55,56]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[58,59,60]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":54}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":75,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[64,65,66,67,68,69,70,71,72,73,74]}},{"3":{"ItemType":63}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":78}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"5":{"Elements":[80,81,82,83,84,85,86,87,88,89,90,91,92]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[94,95]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":99,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":98}},{"3":{"ItemType":97}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[101,102,103,104,105]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":109,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"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."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":108}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":112,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":117,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":113,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":115,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":116,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":114}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":121,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":122,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[118,119,120]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":124,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":126,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":131,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"5":{"Elements":[129,130]}},{"3":{"ItemType":128}},{"3":{"ItemType":128}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[134,135,136]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[138,139,140]}},{"3":{"ItemType":4}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":144,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[146,147,148,149,150]}},{"2":{"Name":"GeoDistribution","Properties":{"location":{"Type":4,"Flags":0,"Description":"Location."},"numberOfWorkers":{"Type":3,"Flags":0,"Description":"NumberOfWorkers."}}}},{"3":{"ItemType":152}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":159,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":161,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[155,156,157,158]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":160}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2018-11-01","ScopeType":8,"Body":30}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":164,"Flags":9,"Description":"The resource name"},"type":{"Type":165,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":166,"Flags":10,"Description":"The resource api version"},"properties":{"Type":168,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":169,"Flags":9,"Description":"The resource name"},"type":{"Type":170,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":171,"Flags":10,"Description":"The resource api version"},"properties":{"Type":173,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":176,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":177,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":183,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":184,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":185,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":186,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":187,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":188,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[174,175]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[178,179,180,181,182]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":189,"Flags":9,"Description":"The resource name"},"type":{"Type":190,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":191,"Flags":10,"Description":"The resource api version"},"properties":{"Type":193,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":54}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":194,"Flags":9,"Description":"The resource name"},"type":{"Type":195,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":196,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":199,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":209,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":202,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[200,201]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":208,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[204,205,206,207]}},{"3":{"ItemType":203}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":210,"Flags":9,"Description":"The resource name"},"type":{"Type":211,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":212,"Flags":10,"Description":"The resource api version"},"properties":{"Type":227,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":226,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[215,216,217,218,219,220,221,222,223,224,225]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":214}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":228,"Flags":9,"Description":"The resource name"},"type":{"Type":229,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":230,"Flags":10,"Description":"The resource api version"},"properties":{"Type":232,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":233,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":255,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":258,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":258,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":234,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":241,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":248,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":240,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[235,236,237,238,239]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":247,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[242,243,244,245,246]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":254,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[249,250,251,252,253]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":256,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":257,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":259,"Flags":9,"Description":"The resource name"},"type":{"Type":260,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":261,"Flags":10,"Description":"The resource api version"},"properties":{"Type":263,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":264,"Flags":9,"Description":"The resource name"},"type":{"Type":265,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":266,"Flags":10,"Description":"The resource api version"},"properties":{"Type":126,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":268,"Flags":9,"Description":"The resource name"},"type":{"Type":269,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":270,"Flags":10,"Description":"The resource api version"},"properties":{"Type":272,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":273,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":274,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":275,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":276,"Flags":9,"Description":"The resource name"},"type":{"Type":277,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":278,"Flags":10,"Description":"The resource api version"},"properties":{"Type":50,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":167,"authsettings":172,"azurestorageaccounts":192,"backup":197,"connectionstrings":213,"logs":231,"metadata":262,"pushsettings":267,"slotConfigNames":271,"web":279}}},{"4":{"Name":"Microsoft.Web/sites/config@2018-11-01","ScopeType":8,"Body":280}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":282,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":283,"Flags":10,"Description":"The resource api version"},"properties":{"Type":285,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2018-11-01","ScopeType":8,"Body":284}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":287,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":288,"Flags":10,"Description":"The resource api version"},"properties":{"Type":290,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-11-01","ScopeType":8,"Body":289}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":292,"Flags":9,"Description":"The resource name"},"type":{"Type":293,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":294,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":297,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":303,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[298,299,300,301,302]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2018-11-01","ScopeType":8,"Body":295}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":305,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":306,"Flags":10,"Description":"The resource api version"},"properties":{"Type":308,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":309,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2018-11-01","ScopeType":8,"Body":307}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":311,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":312,"Flags":10,"Description":"The resource api version"},"properties":{"Type":314,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":317,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":320,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":323,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":327,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[315,316]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[318,319]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[321,322]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[324,325,326]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2018-11-01","ScopeType":8,"Body":313}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":329,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":330,"Flags":10,"Description":"The resource api version"},"properties":{"Type":332,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-11-01","ScopeType":8,"Body":331}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":334,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":335,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2018-11-01","ScopeType":8,"Body":336}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":339,"Flags":9,"Description":"The resource name"},"type":{"Type":340,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":341,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2018-11-01","ScopeType":8,"Body":342}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":344,"Flags":9,"Description":"The resource name"},"type":{"Type":345,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":346,"Flags":10,"Description":"The resource api version"},"properties":{"Type":348,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2018-11-01","ScopeType":8,"Body":347}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":350,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":351,"Flags":10,"Description":"The resource api version"},"properties":{"Type":353,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":354,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2018-11-01","ScopeType":8,"Body":352}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":356,"Flags":9,"Description":"The resource name"},"type":{"Type":357,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":358,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":364,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":363,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":362}},{"3":{"ItemType":361}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2018-11-01","ScopeType":8,"Body":359}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":366,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":367,"Flags":10,"Description":"The resource api version"},"properties":{"Type":369,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":373,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[370,371,372]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2018-11-01","ScopeType":8,"Body":368}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":381,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":382,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[379,380]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2018-11-01","ScopeType":8,"Body":377}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":384,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":385,"Flags":10,"Description":"The resource api version"},"properties":{"Type":31,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":154,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":387,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2018-11-01","ScopeType":8,"Body":386}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":394,"Flags":9,"Description":"The resource name"},"type":{"Type":395,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":396,"Flags":10,"Description":"The resource api version"},"properties":{"Type":173,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":398,"Flags":9,"Description":"The resource name"},"type":{"Type":399,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":400,"Flags":10,"Description":"The resource api version"},"properties":{"Type":402,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":54}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":403,"Flags":9,"Description":"The resource name"},"type":{"Type":404,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":405,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":407,"Flags":9,"Description":"The resource name"},"type":{"Type":408,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":409,"Flags":10,"Description":"The resource api version"},"properties":{"Type":411,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":214}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":412,"Flags":9,"Description":"The resource name"},"type":{"Type":413,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":414,"Flags":10,"Description":"The resource api version"},"properties":{"Type":232,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":416,"Flags":9,"Description":"The resource name"},"type":{"Type":417,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":418,"Flags":10,"Description":"The resource api version"},"properties":{"Type":420,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":421,"Flags":9,"Description":"The resource name"},"type":{"Type":422,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":423,"Flags":10,"Description":"The resource api version"},"properties":{"Type":126,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":425,"Flags":9,"Description":"The resource name"},"type":{"Type":426,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":427,"Flags":10,"Description":"The resource api version"},"properties":{"Type":50,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":392,"authsettings":397,"azurestorageaccounts":401,"backup":406,"connectionstrings":410,"logs":415,"metadata":419,"pushsettings":424,"web":428}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2018-11-01","ScopeType":8,"Body":429}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":431,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":432,"Flags":10,"Description":"The resource api version"},"properties":{"Type":285,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2018-11-01","ScopeType":8,"Body":433}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":435,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":436,"Flags":10,"Description":"The resource api version"},"properties":{"Type":290,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-11-01","ScopeType":8,"Body":437}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":439,"Flags":9,"Description":"The resource name"},"type":{"Type":440,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":441,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2018-11-01","ScopeType":8,"Body":442}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":444,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":445,"Flags":10,"Description":"The resource api version"},"properties":{"Type":308,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2018-11-01","ScopeType":8,"Body":446}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":448,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":449,"Flags":10,"Description":"The resource api version"},"properties":{"Type":314,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2018-11-01","ScopeType":8,"Body":450}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":452,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":453,"Flags":10,"Description":"The resource api version"},"properties":{"Type":332,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-11-01","ScopeType":8,"Body":454}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":456,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":457,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2018-11-01","ScopeType":8,"Body":458}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":460,"Flags":9,"Description":"The resource name"},"type":{"Type":461,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":462,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2018-11-01","ScopeType":8,"Body":463}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":465,"Flags":9,"Description":"The resource name"},"type":{"Type":466,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":467,"Flags":10,"Description":"The resource api version"},"properties":{"Type":348,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2018-11-01","ScopeType":8,"Body":468}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":470,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":471,"Flags":10,"Description":"The resource api version"},"properties":{"Type":353,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":473,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2018-11-01","ScopeType":8,"Body":472}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":475,"Flags":9,"Description":"The resource name"},"type":{"Type":476,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":477,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2018-11-01","ScopeType":8,"Body":478}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":480,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":481,"Flags":10,"Description":"The resource api version"},"properties":{"Type":369,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2018-11-01","ScopeType":8,"Body":482}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":484,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":485,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2018-11-01","ScopeType":8,"Body":486}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":488,"Flags":9,"Description":"The resource name"},"type":{"Type":489,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":490,"Flags":10,"Description":"The resource api version"},"properties":{"Type":492,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2018-11-01","ScopeType":8,"Body":491}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":494,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":495,"Flags":10,"Description":"The resource api version"},"properties":{"Type":497,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":504,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":499,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":503,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[500,501,502]}},{"3":{"ItemType":498}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-11-01","ScopeType":8,"Body":496}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":506,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":507,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-11-01","ScopeType":8,"Body":508}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":511,"Flags":9,"Description":"The resource name"},"type":{"Type":512,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":513,"Flags":10,"Description":"The resource api version"},"properties":{"Type":492,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2018-11-01","ScopeType":8,"Body":514}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":516,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":517,"Flags":10,"Description":"The resource api version"},"properties":{"Type":497,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2018-11-01","ScopeType":8,"Body":518}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":520,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":521,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-11-01","ScopeType":8,"Body":522}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":198,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":526,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":537,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":538,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[527,528,529,530,531,532,533,534,535,536]}},{"3":{"ItemType":203}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2018-11-01","Output":525,"Input":524}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":541,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2018-11-01","Output":540}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":544,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2018-11-01","Output":543}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":547,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","ApiVersion":"2018-11-01","Output":546}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2018-11-01","Output":543}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2018-11-01","Output":525,"Input":524}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2018-11-01","Output":540}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2018-11-01","Output":543}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","ApiVersion":"2018-11-01","Output":546}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2018-11-01","Output":543}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2018-11-01","ScopeType":8,"Body":10}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":28,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":29,"Flags":10,"Description":"The resource api version"},"properties":{"Type":31,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":154,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":162,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":32,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":35,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":36,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":40,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":49,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":50,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":142,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":143,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":145,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":151,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"geoDistributions":{"Type":153,"Flags":0,"Description":"GeoDistributions for this site"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[33,34]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[37,38,39]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":45,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":48,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[42,43,44]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[46,47]}},{"3":{"ItemType":41}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":51,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":53,"Flags":0,"Description":"Application settings."},"azureStorageAccounts":{"Type":62,"Flags":0,"Description":"User-provided Azure storage accounts."},"connectionStrings":{"Type":76,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":77,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":79,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":93,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":96,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":100,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":106,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":107,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":110,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":111,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":123,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":125,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":127,"Flags":0,"Description":"Information about the formal API definition for the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":132,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":133,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":137,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":141,"Flags":0,"Description":"State of FTP / FTPS service"},"reservedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of reserved instances.\nThis setting only applies to the Consumption Plan"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":52}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":57,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":61,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[55,56]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[58,59,60]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":54}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":75,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[64,65,66,67,68,69,70,71,72,73,74]}},{"3":{"ItemType":63}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":78}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"5":{"Elements":[80,81,82,83,84,85,86,87,88,89,90,91,92,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[94,95]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":99,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":98}},{"3":{"ItemType":97}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[101,102,103,104,105]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":109,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"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."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":108}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":112,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":117,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":113,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":115,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":116,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":114}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":121,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":122,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[118,119,120]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":124,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":126,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":131,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"5":{"Elements":[129,130]}},{"3":{"ItemType":128}},{"3":{"ItemType":128}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[134,135,136,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[138,139,140,4]}},{"3":{"ItemType":4}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":144,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[146,147,148,149,150]}},{"2":{"Name":"GeoDistribution","Properties":{"location":{"Type":4,"Flags":0,"Description":"Location."},"numberOfWorkers":{"Type":3,"Flags":0,"Description":"NumberOfWorkers."}}}},{"3":{"ItemType":152}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":159,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":161,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[155,156,157,158,4]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":160}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2018-11-01","ScopeType":8,"Body":30}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":164,"Flags":9,"Description":"The resource name"},"type":{"Type":165,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":166,"Flags":10,"Description":"The resource api version"},"properties":{"Type":168,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":169,"Flags":9,"Description":"The resource name"},"type":{"Type":170,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":171,"Flags":10,"Description":"The resource api version"},"properties":{"Type":173,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":176,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":177,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":183,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":184,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":185,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":186,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":187,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":188,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[174,175]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[178,179,180,181,182]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":189,"Flags":9,"Description":"The resource name"},"type":{"Type":190,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":191,"Flags":10,"Description":"The resource api version"},"properties":{"Type":193,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":54}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":194,"Flags":9,"Description":"The resource name"},"type":{"Type":195,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":196,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":199,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":209,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":202,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[200,201]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":208,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[204,205,206,207,4]}},{"3":{"ItemType":203}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":210,"Flags":9,"Description":"The resource name"},"type":{"Type":211,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":212,"Flags":10,"Description":"The resource api version"},"properties":{"Type":227,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":226,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[215,216,217,218,219,220,221,222,223,224,225]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":214}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":228,"Flags":9,"Description":"The resource name"},"type":{"Type":229,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":230,"Flags":10,"Description":"The resource api version"},"properties":{"Type":232,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":233,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":255,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":258,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":258,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":234,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":241,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":248,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":240,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[235,236,237,238,239]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":247,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[242,243,244,245,246]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":254,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[249,250,251,252,253]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":256,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":257,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":259,"Flags":9,"Description":"The resource name"},"type":{"Type":260,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":261,"Flags":10,"Description":"The resource api version"},"properties":{"Type":263,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":264,"Flags":9,"Description":"The resource name"},"type":{"Type":265,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":266,"Flags":10,"Description":"The resource api version"},"properties":{"Type":126,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":268,"Flags":9,"Description":"The resource name"},"type":{"Type":269,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":270,"Flags":10,"Description":"The resource api version"},"properties":{"Type":272,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":273,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":274,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":275,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":276,"Flags":9,"Description":"The resource name"},"type":{"Type":277,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":278,"Flags":10,"Description":"The resource api version"},"properties":{"Type":50,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":167,"authsettings":172,"azurestorageaccounts":192,"backup":197,"connectionstrings":213,"logs":231,"metadata":262,"pushsettings":267,"slotConfigNames":271,"web":279}}},{"4":{"Name":"Microsoft.Web/sites/config@2018-11-01","ScopeType":8,"Body":280}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":282,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":283,"Flags":10,"Description":"The resource api version"},"properties":{"Type":285,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2018-11-01","ScopeType":8,"Body":284}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":287,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":288,"Flags":10,"Description":"The resource api version"},"properties":{"Type":290,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2018-11-01","ScopeType":8,"Body":289}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":292,"Flags":9,"Description":"The resource name"},"type":{"Type":293,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":294,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":297,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":303,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[298,299,300,301,302]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2018-11-01","ScopeType":8,"Body":295}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":305,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":306,"Flags":10,"Description":"The resource api version"},"properties":{"Type":308,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":309,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2018-11-01","ScopeType":8,"Body":307}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":311,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":312,"Flags":10,"Description":"The resource api version"},"properties":{"Type":314,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":317,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":320,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":323,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":327,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[315,316]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[318,319]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[321,322]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[324,325,326]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2018-11-01","ScopeType":8,"Body":313}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":329,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":330,"Flags":10,"Description":"The resource api version"},"properties":{"Type":332,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2018-11-01","ScopeType":8,"Body":331}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":334,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":335,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2018-11-01","ScopeType":8,"Body":336}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":339,"Flags":9,"Description":"The resource name"},"type":{"Type":340,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":341,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2018-11-01","ScopeType":8,"Body":342}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":344,"Flags":9,"Description":"The resource name"},"type":{"Type":345,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":346,"Flags":10,"Description":"The resource api version"},"properties":{"Type":348,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2018-11-01","ScopeType":8,"Body":347}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":350,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":351,"Flags":10,"Description":"The resource api version"},"properties":{"Type":353,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":354,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2018-11-01","ScopeType":8,"Body":352}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":356,"Flags":9,"Description":"The resource name"},"type":{"Type":357,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":358,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":364,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":363,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":362}},{"3":{"ItemType":361}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2018-11-01","ScopeType":8,"Body":359}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":366,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":367,"Flags":10,"Description":"The resource api version"},"properties":{"Type":369,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":373,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[370,371,372]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2018-11-01","ScopeType":8,"Body":368}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":381,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":382,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[379,380]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2018-11-01","ScopeType":8,"Body":377}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":384,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":385,"Flags":10,"Description":"The resource api version"},"properties":{"Type":31,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":154,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":387,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2018-11-01","ScopeType":8,"Body":386}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":394,"Flags":9,"Description":"The resource name"},"type":{"Type":395,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":396,"Flags":10,"Description":"The resource api version"},"properties":{"Type":173,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":398,"Flags":9,"Description":"The resource name"},"type":{"Type":399,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":400,"Flags":10,"Description":"The resource api version"},"properties":{"Type":402,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":54}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":403,"Flags":9,"Description":"The resource name"},"type":{"Type":404,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":405,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":407,"Flags":9,"Description":"The resource name"},"type":{"Type":408,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":409,"Flags":10,"Description":"The resource api version"},"properties":{"Type":411,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":214}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":412,"Flags":9,"Description":"The resource name"},"type":{"Type":413,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":414,"Flags":10,"Description":"The resource api version"},"properties":{"Type":232,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":416,"Flags":9,"Description":"The resource name"},"type":{"Type":417,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":418,"Flags":10,"Description":"The resource api version"},"properties":{"Type":420,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":421,"Flags":9,"Description":"The resource name"},"type":{"Type":422,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":423,"Flags":10,"Description":"The resource api version"},"properties":{"Type":126,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":425,"Flags":9,"Description":"The resource name"},"type":{"Type":426,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":427,"Flags":10,"Description":"The resource api version"},"properties":{"Type":50,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":392,"authsettings":397,"azurestorageaccounts":401,"backup":406,"connectionstrings":410,"logs":415,"metadata":419,"pushsettings":424,"web":428}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2018-11-01","ScopeType":8,"Body":429}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":431,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":432,"Flags":10,"Description":"The resource api version"},"properties":{"Type":285,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2018-11-01","ScopeType":8,"Body":433}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":435,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":436,"Flags":10,"Description":"The resource api version"},"properties":{"Type":290,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2018-11-01","ScopeType":8,"Body":437}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":439,"Flags":9,"Description":"The resource name"},"type":{"Type":440,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":441,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2018-11-01","ScopeType":8,"Body":442}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":444,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":445,"Flags":10,"Description":"The resource api version"},"properties":{"Type":308,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2018-11-01","ScopeType":8,"Body":446}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":448,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":449,"Flags":10,"Description":"The resource api version"},"properties":{"Type":314,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2018-11-01","ScopeType":8,"Body":450}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":452,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":453,"Flags":10,"Description":"The resource api version"},"properties":{"Type":332,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2018-11-01","ScopeType":8,"Body":454}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":456,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":457,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2018-11-01","ScopeType":8,"Body":458}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":460,"Flags":9,"Description":"The resource name"},"type":{"Type":461,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":462,"Flags":10,"Description":"The resource api version"},"properties":{"Type":296,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2018-11-01","ScopeType":8,"Body":463}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":465,"Flags":9,"Description":"The resource name"},"type":{"Type":466,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":467,"Flags":10,"Description":"The resource api version"},"properties":{"Type":348,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2018-11-01","ScopeType":8,"Body":468}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":470,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":471,"Flags":10,"Description":"The resource api version"},"properties":{"Type":353,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":473,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2018-11-01","ScopeType":8,"Body":472}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":475,"Flags":9,"Description":"The resource name"},"type":{"Type":476,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":477,"Flags":10,"Description":"The resource api version"},"properties":{"Type":360,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2018-11-01","ScopeType":8,"Body":478}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":480,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":481,"Flags":10,"Description":"The resource api version"},"properties":{"Type":369,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2018-11-01","ScopeType":8,"Body":482}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":484,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":485,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2018-11-01","ScopeType":8,"Body":486}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":488,"Flags":9,"Description":"The resource name"},"type":{"Type":489,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":490,"Flags":10,"Description":"The resource api version"},"properties":{"Type":492,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2018-11-01","ScopeType":8,"Body":491}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":494,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":495,"Flags":10,"Description":"The resource api version"},"properties":{"Type":497,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":504,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":499,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":503,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[500,501,502,4]}},{"3":{"ItemType":498}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2018-11-01","ScopeType":8,"Body":496}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":506,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":507,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2018-11-01","ScopeType":8,"Body":508}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":511,"Flags":9,"Description":"The resource name"},"type":{"Type":512,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":513,"Flags":10,"Description":"The resource api version"},"properties":{"Type":492,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2018-11-01","ScopeType":8,"Body":514}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":516,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":517,"Flags":10,"Description":"The resource api version"},"properties":{"Type":497,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2018-11-01","ScopeType":8,"Body":518}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2018-11-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":520,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":521,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2018-11-01","ScopeType":8,"Body":522}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":198,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":526,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":537,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":538,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[527,528,529,530,531,532,533,534,535,536]}},{"3":{"ItemType":203}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2018-11-01","Output":525,"Input":524}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":541,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2018-11-01","Output":540}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":544,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2018-11-01","Output":543}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":547,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","ApiVersion":"2018-11-01","Output":546}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2018-11-01","Output":543}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2018-11-01","Output":525,"Input":524}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2018-11-01","Output":540}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2018-11-01","Output":543}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","ApiVersion":"2018-11-01","Output":546}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2018-11-01","Output":543}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2018-11-01/types.md b/generated/web/microsoft.web/2018-11-01/types.md index 2156887b5b..6df3095496 100644 --- a/generated/web/microsoft.web/2018-11-01/types.md +++ b/generated/web/microsoft.web/2018-11-01/types.md @@ -599,6 +599,147 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2018-11-01 * **Output**: [FunctionSecrets](#functionsecrets) +## ApiDefinitionInfo +### Properties +* **url**: string: The URL of the API definition. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AutoHealActions +### Properties +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action + +## AutoHealCustomAction +### Properties +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. + +## AutoHealRules +### Properties +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. + +## AutoHealTriggers +### Properties +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureStorageInfoValue +### Properties +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. + +## AzureStoragePropertyDictionaryResourceProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) + +## AzureStoragePropertyDictionaryResourceProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) + +## AzureTableStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. + +## BackupItem +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. + +## BackupItem +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. + +## BackupItemProperties +### Properties +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. + +## BackupRequest +### Properties +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. + +## BackupRequest +### Properties +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. + +## BackupRequestProperties +### Properties +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. + +## BackupSchedule +### Properties +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. + ## CertificateProperties ### Properties * **cerBlob**: any (ReadOnly): Raw bytes of .cer file @@ -621,78 +762,6 @@ This is valid for all deployment slots in an app. * **thumbprint**: string (ReadOnly): Certificate thumbprint. * **valid**: bool (ReadOnly): Is the certificate valid?. -## HostingEnvironmentProfile -### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ManagedServiceIdentity -### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} - -## ManagedServiceIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) - -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties -### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity - -## SiteProperties -### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **geoDistributions**: [GeoDistribution](#geodistribution)[]: GeoDistributions for this site -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. - ## CloningInfo ### Properties * **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): Application setting overrides for cloned app. If specified, these settings override the settings cloned @@ -717,175 +786,140 @@ together to use the same snapshot. ### Additional Properties * **Additional Properties Type**: string -## GeoDistribution +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **location**: string: Location. -* **numberOfWorkers**: int: NumberOfWorkers. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity -## HostNameSslState +## ConnectionStringDictionaryProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteConfig +## ConnectionStringDictionaryProperties ### Properties -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): User-provided Azure storage accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **reservedInstanceCount**: int: Number of reserved instances. -This setting only applies to the Consumption Plan -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## ApiDefinitionInfo +## ConnStringInfo ### Properties -* **url**: string: The URL of the API definition. +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. -## NameValuePair +## ConnStringValueTypePair ### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. -## AutoHealRules +## CorsSettings ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## AutoHealActions +## DatabaseBackupSetting ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## AutoHealCustomAction +## DeploymentProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## AutoHealTriggers +## EnabledConfig ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## RequestsBasedTrigger +## Experiments ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## SlowRequestsBasedTrigger +## FileSystemApplicationLogsConfig ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -## StatusCodesBasedTrigger +## FileSystemHttpLogsConfig ### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. -## SiteConfigAzureStorageAccounts +## FunctionEnvelopeProperties +### Properties +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. + +## FunctionEnvelopePropertiesFiles ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## AzureStorageInfoValue +## FunctionSecrets ### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## ConnStringInfo +## FunctionSecrets ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## CorsSettings +## FunctionSecrets ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## Experiments +## FunctionSecrets ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. -## RampUpRule +## FunctionSecretsProperties ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## GeoDistribution +### Properties +* **location**: string: Location. +* **numberOfWorkers**: int: NumberOfWorkers. ## HandlerMapping ### Properties @@ -893,6 +927,75 @@ Custom decision algorithm can be provided in TiPCallback site extension which UR * **extension**: string: Requests with this extension will be handled using the specified FastCGI application. * **scriptProcessor**: string: The absolute path to the FastCGI application. +## HostingEnvironmentProfile +### Properties +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. + +## HostNameBindingProperties +### Properties +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. + +## HostNameSslState +### Properties +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. + +## HttpLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. + +## HybridConnectionKey +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. + +## HybridConnectionKey +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. + +## HybridConnectionKeyProperties +### Properties +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. + +## HybridConnectionProperties +### Properties +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net + +## IdentifierProperties +### Properties +* **id**: string: String representation of the identity. + ## IpSecurityRestriction ### Properties * **action**: string: Allow or Deny access for this IP range. @@ -909,18 +1012,77 @@ SubnetMask property must not be specified. * **vnetSubnetResourceId**: string: Virtual network resource id * **vnetTrafficTag**: int: (internal) Vnet traffic tag -## SiteLimits +## ManagedServiceIdentity ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned' | string: Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## SiteMachineKey +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) + +## MSDeployCore +### Properties +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation + +## MSDeployCoreSetParameters +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## NameValuePair +### Properties +* **name**: string: Pair name. +* **value**: string: Pair value. + +## PremierAddOnProperties +### Properties +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. + +## PrivateAccessProperties +### Properties +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. + +## PrivateAccessSubnet +### Properties +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. + +## PrivateAccessVirtualNetwork +### Properties +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. + +## PublicCertificateProperties +### Properties +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint ## PushSettings ### Properties @@ -940,30 +1102,56 @@ Tags can consist of alphanumeric characters and the following: Validation should be performed at the PushRequestHandler. * **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## VirtualApplication +## RampUpRule ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. -## VirtualDirectory +## RelayServiceConnectionEntityProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## SlotSwapStatus +## RequestsBasedTrigger ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionaryProperties +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -1038,245 +1226,67 @@ Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in * **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. * **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## AzureStoragePropertyDictionaryResourceProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) - -## BackupRequestProperties -### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. - -## BackupSchedule -### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. - -## DatabaseBackupSetting -### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string - -## ConnectionStringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) - -## ConnStringValueTypePair -### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. - -## SiteLogsConfigProperties -### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. - -## ApplicationLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. - -## AzureBlobStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. - -## AzureTableStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. - -## FileSystemApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. - -## EnabledConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. - -## HttpLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. - -## AzureBlobStorageHttpLogsConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. - -## FileSystemHttpLogsConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SlotConfigNames -### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. - -## DeploymentProperties -### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. - -## IdentifierProperties -### Properties -* **id**: string: String representation of the identity. - -## MSDeployCore -### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation - -## MSDeployCoreSetParameters -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## FunctionEnvelopeProperties -### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. - -## FunctionEnvelopePropertiesFiles -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostNameBindingProperties -### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. - -## RelayServiceConnectionEntityProperties -### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string - -## HybridConnectionProperties -### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net - -## SwiftVirtualNetworkProperties -### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. - -## PremierAddOnProperties -### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## PrivateAccessProperties -### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. - -## PrivateAccessVirtualNetwork -### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. - -## PrivateAccessSubnet +## SiteConfig ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): User-provided Azure storage accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **reservedInstanceCount**: int: Number of reserved instances. +This setting only applies to the Consumption Plan +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id -## PublicCertificateProperties +## SiteConfigAzureStorageAccounts ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -1301,35 +1311,69 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **geoDistributions**: [GeoDistribution](#geodistribution)[]: GeoDistributions for this site +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -1339,74 +1383,40 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties -### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. - -## VnetRoute +## SlotConfigNames ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. -## VnetRouteProperties +## SlotSwapStatus ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. -## VnetGatewayProperties +## SlowRequestsBasedTrigger ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. -## BackupRequest +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -1420,85 +1430,75 @@ These values will be used for syncing an app's routes with those from a Virtual ### Additional Properties * **Additional Properties Type**: string -## BackupRequest +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## BackupItem +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## SwiftVirtualNetworkProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## HybridConnectionKey +## VirtualApplication ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## FunctionSecrets +## VirtualDirectory ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. -## FunctionSecretsProperties +## VnetGatewayProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. -## FunctionSecrets +## VnetInfoProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. -## FunctionSecrets +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## VnetRouteProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. diff --git a/generated/web/microsoft.web/2019-08-01/types.json b/generated/web/microsoft.web/2019-08-01/types.json index 6d9fe8d599..10dd7320e3 100644 --- a/generated/web/microsoft.web/2019-08-01/types.json +++ b/generated/web/microsoft.web/2019-08-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2019-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":28,"Flags":9,"Description":"The resource name"},"type":{"Type":29,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":30,"Flags":10,"Description":"The resource api version"},"properties":{"Type":32,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2019-08-01","ScopeType":1,"Body":31}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":34,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":35,"Flags":10,"Description":"The resource api version"},"properties":{"Type":37,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2019-08-01","ScopeType":1,"Body":36}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":39,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":40,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":156,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":164,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":43,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":46,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":47,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":51,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":60,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":146,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":147,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":149,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":155,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[44,45]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[48,49,50]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":56,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":59,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[53,54,55]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[57,58]}},{"3":{"ItemType":52}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":62,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":64,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":78,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":79,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":81,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":96,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":99,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":103,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":109,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":110,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":113,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":114,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":126,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":128,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":130,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":131,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":136,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":137,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":141,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":145,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":63}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":77,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[66,67,68,69,70,71,72,73,74,75,76]}},{"3":{"ItemType":65}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":80}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[82,83,84,85,86,87,88,89,90,91,92,93,94,95]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[97,98]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":102,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[104,105,106,107,108]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":112,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":111}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":115,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":120,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":116,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":118,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":119,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":117}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":124,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":125,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[121,122,123]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":127,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":135,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"5":{"Elements":[133,134]}},{"3":{"ItemType":132}},{"3":{"ItemType":132}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[138,139,140]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[142,143,144]}},{"3":{"ItemType":4}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":148,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[150,151,152,153,154]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":161,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":163,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[157,158,159,160]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":162}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2019-08-01","ScopeType":8,"Body":41}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":166,"Flags":9,"Description":"The resource name"},"type":{"Type":167,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":168,"Flags":10,"Description":"The resource api version"},"properties":{"Type":170,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":171,"Flags":9,"Description":"The resource name"},"type":{"Type":172,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":173,"Flags":10,"Description":"The resource api version"},"properties":{"Type":170,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":169,"scm":174}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2019-08-01","ScopeType":8,"Body":175}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":177,"Flags":9,"Description":"The resource name"},"type":{"Type":178,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":179,"Flags":10,"Description":"The resource api version"},"properties":{"Type":181,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":182,"Flags":9,"Description":"The resource name"},"type":{"Type":183,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":184,"Flags":10,"Description":"The resource api version"},"properties":{"Type":186,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":189,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":190,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":196,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":197,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":198,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":199,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":200,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":201,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[187,188]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[191,192,193,194,195]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":202,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":214,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":209,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":213,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[207,208]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[210,211,212]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":206}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":215,"Flags":9,"Description":"The resource name"},"type":{"Type":216,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":217,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":220,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":230,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":223,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[221,222]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":229,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[225,226,227,228]}},{"3":{"ItemType":224}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":231,"Flags":9,"Description":"The resource name"},"type":{"Type":232,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":233,"Flags":10,"Description":"The resource api version"},"properties":{"Type":248,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":247,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[236,237,238,239,240,241,242,243,244,245,246]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":235}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":249,"Flags":9,"Description":"The resource name"},"type":{"Type":250,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":251,"Flags":10,"Description":"The resource api version"},"properties":{"Type":253,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":254,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":276,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":279,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":279,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":255,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":262,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":269,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":261,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[256,257,258,259,260]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":268,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[263,264,265,266,267]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":275,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[270,271,272,273,274]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":277,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":278,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":280,"Flags":9,"Description":"The resource name"},"type":{"Type":281,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":282,"Flags":10,"Description":"The resource api version"},"properties":{"Type":284,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":285,"Flags":9,"Description":"The resource name"},"type":{"Type":286,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":287,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":289,"Flags":9,"Description":"The resource name"},"type":{"Type":290,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":291,"Flags":10,"Description":"The resource api version"},"properties":{"Type":293,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":294,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":295,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":296,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":297,"Flags":9,"Description":"The resource name"},"type":{"Type":298,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":299,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":180,"authsettings":185,"azurestorageaccounts":205,"backup":218,"connectionstrings":234,"logs":252,"metadata":283,"pushsettings":288,"slotConfigNames":292,"web":300}}},{"4":{"Name":"Microsoft.Web/sites/config@2019-08-01","ScopeType":8,"Body":301}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":303,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":304,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2019-08-01","ScopeType":8,"Body":305}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":308,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":309,"Flags":10,"Description":"The resource api version"},"properties":{"Type":311,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2019-08-01","ScopeType":8,"Body":310}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":313,"Flags":9,"Description":"The resource name"},"type":{"Type":314,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":315,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":318,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":324,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[319,320,321,322,323]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2019-08-01","ScopeType":8,"Body":316}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":326,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":327,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":330,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2019-08-01","ScopeType":8,"Body":328}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":332,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":333,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2019-08-01","ScopeType":8,"Body":334}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":336,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":337,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":342,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":345,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":348,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":352,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[340,341]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[343,344]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[346,347]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[349,350,351]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2019-08-01","ScopeType":8,"Body":338}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":354,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":355,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2019-08-01","ScopeType":8,"Body":356}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":359,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":360,"Flags":10,"Description":"The resource api version"},"properties":{"Type":362,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2019-08-01","ScopeType":8,"Body":361}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2019-08-01","ScopeType":8,"Body":367}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":369,"Flags":9,"Description":"The resource name"},"type":{"Type":370,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":371,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2019-08-01","ScopeType":8,"Body":372}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":379,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2019-08-01","ScopeType":8,"Body":377}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":381,"Flags":9,"Description":"The resource name"},"type":{"Type":382,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":383,"Flags":10,"Description":"The resource api version"},"properties":{"Type":385,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":389,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":388,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":387}},{"3":{"ItemType":386}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2019-08-01","ScopeType":8,"Body":384}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":391,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":392,"Flags":10,"Description":"The resource api version"},"properties":{"Type":394,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":398,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[395,396,397]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2019-08-01","ScopeType":8,"Body":393}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":400,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":401,"Flags":10,"Description":"The resource api version"},"properties":{"Type":403,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":406,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":407,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[404,405]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2019-08-01","ScopeType":8,"Body":402}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":409,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":410,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":156,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":412,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2019-08-01","ScopeType":8,"Body":411}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":414,"Flags":9,"Description":"The resource name"},"type":{"Type":415,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":416,"Flags":10,"Description":"The resource api version"},"properties":{"Type":418,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":419,"Flags":9,"Description":"The resource name"},"type":{"Type":420,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":421,"Flags":10,"Description":"The resource api version"},"properties":{"Type":186,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":423,"Flags":9,"Description":"The resource name"},"type":{"Type":424,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":425,"Flags":10,"Description":"The resource api version"},"properties":{"Type":427,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":206}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":432,"Flags":9,"Description":"The resource name"},"type":{"Type":433,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":434,"Flags":10,"Description":"The resource api version"},"properties":{"Type":436,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":235}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":437,"Flags":9,"Description":"The resource name"},"type":{"Type":438,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":439,"Flags":10,"Description":"The resource api version"},"properties":{"Type":253,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":441,"Flags":9,"Description":"The resource name"},"type":{"Type":442,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":443,"Flags":10,"Description":"The resource api version"},"properties":{"Type":445,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":446,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":450,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":417,"authsettings":422,"azurestorageaccounts":426,"backup":431,"connectionstrings":435,"logs":440,"metadata":444,"pushsettings":449,"web":453}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2019-08-01","ScopeType":8,"Body":454}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":456,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":457,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2019-08-01","ScopeType":8,"Body":458}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":460,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":461,"Flags":10,"Description":"The resource api version"},"properties":{"Type":311,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2019-08-01","ScopeType":8,"Body":462}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":464,"Flags":9,"Description":"The resource name"},"type":{"Type":465,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":466,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2019-08-01","ScopeType":8,"Body":467}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2019-08-01","ScopeType":8,"Body":471}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":473,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":474,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2019-08-01","ScopeType":8,"Body":475}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":477,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":478,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2019-08-01","ScopeType":8,"Body":479}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":481,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":482,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2019-08-01","ScopeType":8,"Body":483}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":362,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2019-08-01","ScopeType":8,"Body":487}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":489,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2019-08-01","ScopeType":8,"Body":492}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":494,"Flags":9,"Description":"The resource name"},"type":{"Type":495,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":496,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2019-08-01","ScopeType":8,"Body":497}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":499,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":500,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":502,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2019-08-01","ScopeType":8,"Body":501}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":504,"Flags":9,"Description":"The resource name"},"type":{"Type":505,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":506,"Flags":10,"Description":"The resource api version"},"properties":{"Type":385,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2019-08-01","ScopeType":8,"Body":507}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":509,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":510,"Flags":10,"Description":"The resource api version"},"properties":{"Type":512,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":513,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":514,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2019-08-01","ScopeType":8,"Body":511}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":516,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":517,"Flags":10,"Description":"The resource api version"},"properties":{"Type":394,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2019-08-01","ScopeType":8,"Body":518}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":520,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":521,"Flags":10,"Description":"The resource api version"},"properties":{"Type":403,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2019-08-01","ScopeType":8,"Body":522}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":524,"Flags":9,"Description":"The resource name"},"type":{"Type":525,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":526,"Flags":10,"Description":"The resource api version"},"properties":{"Type":528,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2019-08-01","ScopeType":8,"Body":527}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":540,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":535,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":539,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[536,537,538]}},{"3":{"ItemType":534}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2019-08-01","ScopeType":8,"Body":532}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":542,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":543,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2019-08-01","ScopeType":8,"Body":544}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":528,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2019-08-01","ScopeType":8,"Body":550}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2019-08-01","ScopeType":8,"Body":554}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":556,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":557,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2019-08-01","ScopeType":8,"Body":558}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"A static site."},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":571,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":564,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":565,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":567,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":568,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":570,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":569}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2019-08-01","ScopeType":8,"Body":562}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":573,"Flags":9,"Description":"The resource name"},"type":{"Type":574,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":575,"Flags":10,"Description":"The resource api version"},"properties":{"Type":577,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2019-08-01","ScopeType":8,"Body":576}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":579,"Flags":9,"Description":"The resource name"},"type":{"Type":580,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":581,"Flags":10,"Description":"The resource api version"},"properties":{"Type":583,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2019-08-01","ScopeType":8,"Body":582}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2019-08-01","ScopeType":8,"Body":587}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":589,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":590,"Flags":10,"Description":"The resource api version"},"properties":{"Type":592,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":640,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":598,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":603,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":604,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":608,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":615,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":617,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":632,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":637,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":638,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":639,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[593,594,595,596,597]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[599,600,601,602]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"5":{"Elements":[605,606,607]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":613,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":614,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[610,611,612]}},{"3":{"ItemType":4}},{"3":{"ItemType":609}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":616}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":622,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":631,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[619,620,621]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[623,624,625,626,627,628,629,630]}},{"3":{"ItemType":618}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":636,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[634,635]}},{"3":{"ItemType":633}},{"3":{"ItemType":63}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2019-08-01","ScopeType":8,"Body":591}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":642,"Flags":9,"Description":"The resource name"},"type":{"Type":643,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":644,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2019-08-01","ScopeType":8,"Body":645}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":647,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":648,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2019-08-01","ScopeType":8,"Body":649}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":651,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":652,"Flags":10,"Description":"The resource api version"},"properties":{"Type":654,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":665,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":658,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":664,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[655,656,657]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[659,660,661,662,663]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2019-08-01","ScopeType":8,"Body":653}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2019-08-01","ScopeType":8,"Body":669}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":535,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2019-08-01","ScopeType":8,"Body":673}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":219,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":677,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":688,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":689,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[678,679,680,681,682,683,684,685,686,687]}},{"3":{"ItemType":224}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2019-08-01","Output":676,"Input":675}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":692,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2019-08-01","Output":691}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":696,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2019-08-01","Output":695}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":699,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":700,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2019-08-01","Output":698}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":703,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":676}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2019-08-01","Output":702}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2019-08-01","Output":695}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2019-08-01","Output":676,"Input":675}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2019-08-01","Output":695}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2019-08-01","Output":698}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2019-08-01","Output":702}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2019-08-01","Output":695}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":716,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":715,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":714}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2019-08-01","Output":713}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2019-08-01","Output":691}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":722,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2019-08-01","Output":721}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2019-08-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":28,"Flags":9,"Description":"The resource name"},"type":{"Type":29,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":30,"Flags":10,"Description":"The resource api version"},"properties":{"Type":32,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2019-08-01","ScopeType":1,"Body":31}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":34,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":35,"Flags":10,"Description":"The resource api version"},"properties":{"Type":37,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2019-08-01","ScopeType":1,"Body":36}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":39,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":40,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":156,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":164,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":43,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":46,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":47,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":51,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":60,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":146,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":147,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":149,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":155,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[44,45]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[48,49,50]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":56,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":59,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[53,54,55]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[57,58]}},{"3":{"ItemType":52}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":62,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":64,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":78,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":79,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":81,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":96,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":99,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":103,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":109,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":110,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":113,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":114,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"cors":{"Type":126,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":128,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":130,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":131,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":136,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":137,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":141,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":145,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":63}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":77,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[66,67,68,69,70,71,72,73,74,75,76]}},{"3":{"ItemType":65}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":80}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[82,83,84,85,86,87,88,89,90,91,92,93,94,95,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[97,98]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":102,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[104,105,106,107,108]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":112,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":111}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":115,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":120,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":116,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":118,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":119,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":117}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":124,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":125,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[121,122,123]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":127,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":135,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"5":{"Elements":[133,134]}},{"3":{"ItemType":132}},{"3":{"ItemType":132}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[138,139,140,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[142,143,144,4]}},{"3":{"ItemType":4}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":148,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[150,151,152,153,154]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":161,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":163,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[157,158,159,160]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":162}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2019-08-01","ScopeType":8,"Body":41}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":166,"Flags":9,"Description":"The resource name"},"type":{"Type":167,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":168,"Flags":10,"Description":"The resource api version"},"properties":{"Type":170,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":171,"Flags":9,"Description":"The resource name"},"type":{"Type":172,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":173,"Flags":10,"Description":"The resource api version"},"properties":{"Type":170,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":169,"scm":174}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2019-08-01","ScopeType":8,"Body":175}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":177,"Flags":9,"Description":"The resource name"},"type":{"Type":178,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":179,"Flags":10,"Description":"The resource api version"},"properties":{"Type":181,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":182,"Flags":9,"Description":"The resource name"},"type":{"Type":183,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":184,"Flags":10,"Description":"The resource api version"},"properties":{"Type":186,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":189,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":190,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":196,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":197,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":198,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleOAuthScopes":{"Type":199,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookOAuthScopes":{"Type":200,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountOAuthScopes":{"Type":201,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[187,188]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"5":{"Elements":[191,192,193,194,195]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":202,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":214,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":209,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":213,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[207,208]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[210,211,212]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":206}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":215,"Flags":9,"Description":"The resource name"},"type":{"Type":216,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":217,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":220,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":230,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":223,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[221,222]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":229,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[225,226,227,228,4]}},{"3":{"ItemType":224}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":231,"Flags":9,"Description":"The resource name"},"type":{"Type":232,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":233,"Flags":10,"Description":"The resource api version"},"properties":{"Type":248,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":247,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[236,237,238,239,240,241,242,243,244,245,246]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":235}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":249,"Flags":9,"Description":"The resource name"},"type":{"Type":250,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":251,"Flags":10,"Description":"The resource api version"},"properties":{"Type":253,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":254,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":276,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":279,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":279,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":255,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":262,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":269,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":261,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[256,257,258,259,260]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":268,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[263,264,265,266,267]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":275,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[270,271,272,273,274]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":277,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":278,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":280,"Flags":9,"Description":"The resource name"},"type":{"Type":281,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":282,"Flags":10,"Description":"The resource api version"},"properties":{"Type":284,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":285,"Flags":9,"Description":"The resource name"},"type":{"Type":286,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":287,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":289,"Flags":9,"Description":"The resource name"},"type":{"Type":290,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":291,"Flags":10,"Description":"The resource api version"},"properties":{"Type":293,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":294,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":295,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":296,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":297,"Flags":9,"Description":"The resource name"},"type":{"Type":298,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":299,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":180,"authsettings":185,"azurestorageaccounts":205,"backup":218,"connectionstrings":234,"logs":252,"metadata":283,"pushsettings":288,"slotConfigNames":292,"web":300}}},{"4":{"Name":"Microsoft.Web/sites/config@2019-08-01","ScopeType":8,"Body":301}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":303,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":304,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2019-08-01","ScopeType":8,"Body":305}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":308,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":309,"Flags":10,"Description":"The resource api version"},"properties":{"Type":311,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2019-08-01","ScopeType":8,"Body":310}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":313,"Flags":9,"Description":"The resource name"},"type":{"Type":314,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":315,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":318,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":324,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[319,320,321,322,323]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2019-08-01","ScopeType":8,"Body":316}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":326,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":327,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":330,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2019-08-01","ScopeType":8,"Body":328}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":332,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":333,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2019-08-01","ScopeType":8,"Body":334}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":336,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":337,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":342,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":345,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":348,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":352,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[340,341]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[343,344]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[346,347]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[349,350,351]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2019-08-01","ScopeType":8,"Body":338}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":354,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":355,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2019-08-01","ScopeType":8,"Body":356}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":359,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":360,"Flags":10,"Description":"The resource api version"},"properties":{"Type":362,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2019-08-01","ScopeType":8,"Body":361}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2019-08-01","ScopeType":8,"Body":367}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":369,"Flags":9,"Description":"The resource name"},"type":{"Type":370,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":371,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2019-08-01","ScopeType":8,"Body":372}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":375,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":376,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":379,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2019-08-01","ScopeType":8,"Body":377}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":381,"Flags":9,"Description":"The resource name"},"type":{"Type":382,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":383,"Flags":10,"Description":"The resource api version"},"properties":{"Type":385,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":389,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":388,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":387}},{"3":{"ItemType":386}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2019-08-01","ScopeType":8,"Body":384}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":391,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":392,"Flags":10,"Description":"The resource api version"},"properties":{"Type":394,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":398,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[395,396,397]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2019-08-01","ScopeType":8,"Body":393}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":400,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":401,"Flags":10,"Description":"The resource api version"},"properties":{"Type":403,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":406,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":407,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[404,405]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2019-08-01","ScopeType":8,"Body":402}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":409,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":410,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":156,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":412,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2019-08-01","ScopeType":8,"Body":411}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":414,"Flags":9,"Description":"The resource name"},"type":{"Type":415,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":416,"Flags":10,"Description":"The resource api version"},"properties":{"Type":418,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":419,"Flags":9,"Description":"The resource name"},"type":{"Type":420,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":421,"Flags":10,"Description":"The resource api version"},"properties":{"Type":186,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":423,"Flags":9,"Description":"The resource name"},"type":{"Type":424,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":425,"Flags":10,"Description":"The resource api version"},"properties":{"Type":427,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":206}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":432,"Flags":9,"Description":"The resource name"},"type":{"Type":433,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":434,"Flags":10,"Description":"The resource api version"},"properties":{"Type":436,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":235}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":437,"Flags":9,"Description":"The resource name"},"type":{"Type":438,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":439,"Flags":10,"Description":"The resource api version"},"properties":{"Type":253,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":441,"Flags":9,"Description":"The resource name"},"type":{"Type":442,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":443,"Flags":10,"Description":"The resource api version"},"properties":{"Type":445,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":446,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":450,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":417,"authsettings":422,"azurestorageaccounts":426,"backup":431,"connectionstrings":435,"logs":440,"metadata":444,"pushsettings":449,"web":453}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2019-08-01","ScopeType":8,"Body":454}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":456,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":457,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2019-08-01","ScopeType":8,"Body":458}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":460,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":461,"Flags":10,"Description":"The resource api version"},"properties":{"Type":311,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2019-08-01","ScopeType":8,"Body":462}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":464,"Flags":9,"Description":"The resource name"},"type":{"Type":465,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":466,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2019-08-01","ScopeType":8,"Body":467}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2019-08-01","ScopeType":8,"Body":471}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":473,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":474,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2019-08-01","ScopeType":8,"Body":475}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":477,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":478,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2019-08-01","ScopeType":8,"Body":479}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":481,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":482,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2019-08-01","ScopeType":8,"Body":483}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":362,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2019-08-01","ScopeType":8,"Body":487}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":489,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":317,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2019-08-01","ScopeType":8,"Body":492}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":494,"Flags":9,"Description":"The resource name"},"type":{"Type":495,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":496,"Flags":10,"Description":"The resource api version"},"properties":{"Type":373,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2019-08-01","ScopeType":8,"Body":497}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":499,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":500,"Flags":10,"Description":"The resource api version"},"properties":{"Type":378,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":502,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2019-08-01","ScopeType":8,"Body":501}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":504,"Flags":9,"Description":"The resource name"},"type":{"Type":505,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":506,"Flags":10,"Description":"The resource api version"},"properties":{"Type":385,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2019-08-01","ScopeType":8,"Body":507}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":509,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":510,"Flags":10,"Description":"The resource api version"},"properties":{"Type":512,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":513,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":514,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2019-08-01","ScopeType":8,"Body":511}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":516,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":517,"Flags":10,"Description":"The resource api version"},"properties":{"Type":394,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2019-08-01","ScopeType":8,"Body":518}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":520,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":521,"Flags":10,"Description":"The resource api version"},"properties":{"Type":403,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2019-08-01","ScopeType":8,"Body":522}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":524,"Flags":9,"Description":"The resource name"},"type":{"Type":525,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":526,"Flags":10,"Description":"The resource api version"},"properties":{"Type":528,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2019-08-01","ScopeType":8,"Body":527}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":540,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":535,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":539,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[536,537,538,4]}},{"3":{"ItemType":534}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2019-08-01","ScopeType":8,"Body":532}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":542,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":543,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2019-08-01","ScopeType":8,"Body":544}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":528,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2019-08-01","ScopeType":8,"Body":550}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2019-08-01","ScopeType":8,"Body":554}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":556,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":557,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2019-08-01","ScopeType":8,"Body":558}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"A static site."},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":571,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":564,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":565,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":567,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":568,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":570,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":569}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2019-08-01","ScopeType":8,"Body":562}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":573,"Flags":9,"Description":"The resource name"},"type":{"Type":574,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":575,"Flags":10,"Description":"The resource api version"},"properties":{"Type":577,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2019-08-01","ScopeType":8,"Body":576}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":579,"Flags":9,"Description":"The resource name"},"type":{"Type":580,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":581,"Flags":10,"Description":"The resource api version"},"properties":{"Type":583,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2019-08-01","ScopeType":8,"Body":582}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2019-08-01","ScopeType":8,"Body":587}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":589,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":590,"Flags":10,"Description":"The resource api version"},"properties":{"Type":592,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":640,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":598,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":603,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":604,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":608,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":615,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":617,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":632,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":637,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":638,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":639,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[593,594,595,596,597]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[599,600,601,602]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"5":{"Elements":[605,606,607]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":613,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":614,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[610,611,612]}},{"3":{"ItemType":4}},{"3":{"ItemType":609}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":616}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":622,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":631,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[619,620,621]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[623,624,625,626,627,628,629,630]}},{"3":{"ItemType":618}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":636,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[634,635]}},{"3":{"ItemType":633}},{"3":{"ItemType":63}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2019-08-01","ScopeType":8,"Body":591}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":642,"Flags":9,"Description":"The resource name"},"type":{"Type":643,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":644,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2019-08-01","ScopeType":8,"Body":645}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":647,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":648,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2019-08-01","ScopeType":8,"Body":649}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":651,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":652,"Flags":10,"Description":"The resource api version"},"properties":{"Type":654,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":566,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":665,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":658,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":664,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[655,656,657]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[659,660,661,662,663]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2019-08-01","ScopeType":8,"Body":653}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2019-08-01","ScopeType":8,"Body":669}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2019-08-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":535,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2019-08-01","ScopeType":8,"Body":673}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":219,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":677,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":688,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":689,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[678,679,680,681,682,683,684,685,686,687]}},{"3":{"ItemType":224}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2019-08-01","Output":676,"Input":675}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":692,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2019-08-01","Output":691}},{"2":{"Name":"FunctionSecrets","Properties":{"properties":{"Type":696,"Flags":2,"Description":"FunctionSecrets resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FunctionSecretsProperties","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2019-08-01","Output":695}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":699,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":700,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2019-08-01","Output":698}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":703,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":676}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2019-08-01","Output":702}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2019-08-01","Output":695}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2019-08-01","Output":676,"Input":675}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2019-08-01","Output":695}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2019-08-01","Output":698}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2019-08-01","Output":702}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2019-08-01","Output":695}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":716,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":715,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":714}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2019-08-01","Output":713}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2019-08-01","Output":691}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2019-08-01","Output":691}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":722,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2019-08-01","Output":721}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2019-08-01/types.md b/generated/web/microsoft.web/2019-08-01/types.md index 00fdc9238d..7487234855 100644 --- a/generated/web/microsoft.web/2019-08-01/types.md +++ b/generated/web/microsoft.web/2019-08-01/types.md @@ -824,39 +824,19 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2019-08-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## ApiDefinitionInfo ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (Required, WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **url**: string: The URL of the API definition. -## HostingEnvironmentProfile +## ApiManagementConfig ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **id**: string: APIM-Api Identifier. -## ResourceTags +## ApplicationLogsConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. ## AppServiceEnvironment ### Properties @@ -902,96 +882,6 @@ This is valid for all deployment slots in an app. * **vnetSubnetName**: string: Subnet of the Virtual Network. * **workerPools**: [WorkerPool](#workerpool)[] (Required): Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## StampCapacity -### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. -Basic apps are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. -* **isLinux**: bool: Is this a linux stamp capacity -* **name**: string: Name of the stamp. -* **siteMode**: string: Shared or Dedicated. -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). -* **unit**: string: Name of the unit. -* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. -* **workerSizeId**: int: Size ID of machines: -0 - Small -1 - Medium -2 - Large - -## NetworkAccessControlEntry -### Properties -* **action**: 'Deny' | 'Permit': Action object. -* **description**: string: Description of network access control entry. -* **order**: int: Order of precedence. -* **remoteSubnet**: string: Remote subnet. - -## VirtualIPMapping -### Properties -* **internalHttpPort**: int: Internal HTTP port. -* **internalHttpsPort**: int: Internal HTTPS port. -* **inUse**: bool: Is virtual IP mapping in use. -* **serviceName**: string: name of the service that virtual IP is assigned to -* **virtualIP**: string: Virtual IP address. - -## VirtualNetworkProfile -### Properties -* **id**: string: Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -1015,433 +905,133 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## AutoHealActions ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## VnetRouteProperties +## AutoHealCustomAction ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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 +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -These values will be used for syncing an app's routes with those from a Virtual Network. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +## AutoHealRules +### Properties +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## ManagedServiceIdentity +## AutoHealTriggers ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -## ManagedServiceIdentityUserAssignedIdentities +## AzureBlobStorageApplicationLogsConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AzureBlobStorageHttpLogsConfig ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## SiteProperties +## AzureStorageInfoValue ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. -## CloningInfo +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## CloningInfoAppSettingsOverrides +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## HostNameSslState +## AzureTableStorageApplicationLogsConfig ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. - -## SiteConfig -### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id - -## ApiDefinitionInfo -### Properties -* **url**: string: The URL of the API definition. - -## ApiManagementConfig -### Properties -* **id**: string: APIM-Api Identifier. - -## AutoHealRules -### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. - -## AutoHealActions -### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action - -## AutoHealCustomAction -### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. - -## AutoHealTriggers -### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. - -## RequestsBasedTrigger -### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. - -## SlowRequestsBasedTrigger -### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. - -## StatusCodesBasedTrigger -### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. - -## ConnStringInfo -### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. - -## CorsSettings -### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. - -## Experiments -### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. - -## RampUpRule -### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. - -## HandlerMapping -### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. - -## IpSecurityRestriction -### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag - -## SiteLimits -### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. - -## SiteMachineKey -### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## PushSettings +## BackupItem ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties * **type**: string (ReadOnly): Resource type. -## PushSettingsProperties -### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. - -## VirtualApplication -### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. - -## VirtualDirectory -### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. - -## SlotSwapStatus -### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. - -## ResourceTags +## BackupItem ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## CsmPublishingCredentialsPoliciesEntityProperties +## BackupItemCollection ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## StringDictionaryProperties +## BackupItemCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## SiteAuthSettingsProperties +## BackupItemProperties ### Properties -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookOAuthScopes**: 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 -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleOAuthScopes**: 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/ -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## AzureStoragePropertyDictionaryResourceProperties +## BackupRequest ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## AzureStorageInfoValue +## BackupRequest ### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. ## BackupRequestProperties ### Properties @@ -1460,107 +1050,313 @@ Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in * **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. * **startTime**: string: When the schedule should start working. -## DatabaseBackupSetting +## Capability ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. + +## CertificateProperties +### Properties +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (Required, WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. + +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + +## CloningInfoAppSettingsOverrides +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) ## ConnectionStringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +## ConnStringInfo +### Properties +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. + ## ConnStringValueTypePair ### Properties * **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. * **value**: string (Required): Value of pair. -## SiteLogsConfigProperties +## CorsSettings ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## ApplicationLogsConfig +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## AzureBlobStorageApplicationLogsConfig +## DatabaseBackupSetting +### Properties +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string + +## DeploymentProperties +### Properties +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. + +## EnabledConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. + +## Experiments +### Properties +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. + +## FileSystemApplicationLogsConfig ### Properties * **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. * **retentionInDays**: int: Retention in days. -Remove blobs older than X days. +Remove files older than X days. 0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **retentionInMb**: int: 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. -## AzureTableStorageApplicationLogsConfig +## FunctionEnvelopeProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. -## FileSystemApplicationLogsConfig +## FunctionEnvelopePropertiesFiles ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +### Additional Properties +* **Additional Properties Type**: string + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecrets +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties +* **type**: string (ReadOnly): Resource type. + +## FunctionSecretsProperties +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## HandlerMapping +### Properties +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. + +## HostingEnvironmentProfile +### Properties +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. + +## HostKeys +### Properties +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. + +## HostKeys +### Properties +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. + +## HostKeysFunctionKeys +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## HostKeysSystemKeys +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## HostNameBindingProperties +### Properties +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## EnabledConfig +## HostNameSslState ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. ## HttpLogsConfig ### Properties * **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. * **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## AzureBlobStorageHttpLogsConfig +## HybridConnectionKey ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## FileSystemHttpLogsConfig +## HybridConnectionKeyProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## StringDictionaryProperties +## HybridConnectionProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## SlotConfigNames +## IdentifierProperties ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **id**: string: String representation of the identity. -## DeploymentProperties +## IpSecurityRestriction ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag -## IdentifierProperties +## ManagedServiceIdentity ### Properties -* **id**: string: String representation of the identity. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} + +## ManagedServiceIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) ## MSDeployCore ### Properties @@ -1586,38 +1382,92 @@ Setting is false by default. ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## NameValuePair ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +* **name**: string: Pair name. +* **value**: string: Pair value. -## FunctionEnvelopePropertiesFiles +## NetworkAccessControlEntry ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **action**: 'Deny' | 'Permit': Action object. +* **description**: string: Description of network access control entry. +* **order**: int: Order of precedence. +* **remoteSubnet**: string: Remote subnet. -## HostNameBindingProperties +## PremierAddOnProperties ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. + +## PrivateAccessProperties +### Properties +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. + +## PrivateAccessSubnet +### Properties +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. + +## PrivateAccessVirtualNetwork +### Properties +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. + +## PrivateLinkConnectionApprovalRequest +### Properties +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) + +## PrivateLinkConnectionState +### Properties +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection + +## PublicCertificateProperties +### Properties +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint + +## PushSettings +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. + +## PushSettingsProperties +### Properties +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + +## RampUpRule +### Properties +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. ## RelayServiceConnectionEntityProperties ### Properties @@ -1629,74 +1479,181 @@ Setting is false by default. * **resourceConnectionString**: string * **resourceType**: string -## HybridConnectionProperties +## RequestsBasedTrigger ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResourceTags ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessVirtualNetwork +## ResourceTags ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessSubnet +## ResourceTags ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkConnectionApprovalRequest -### Properties -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## ArmIdWrapper +## ResourceTags ### Properties -* **id**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkConnectionState +## SiteAuthSettingsProperties ### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookOAuthScopes**: 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 +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleOAuthScopes**: 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/ +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PublicCertificateProperties +## SiteConfig ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id ## SiteExtensionInfoProperties ### Properties @@ -1721,35 +1678,68 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -1759,24 +1749,41 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties +## SkuCapacity ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **default**: int: Default number of workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## VnetRoute +## SkuDescription +### Properties +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. + +## SlotConfigNames +### Properties +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. + +## SlotSwapStatus +### Properties +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. + +## SlowRequestsBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -1785,6 +1792,24 @@ Point-To-Site VPN connection. * **token**: string: OAuth access token. * **tokenSecret**: string: OAuth access token secret. +## StampCapacity +### Properties +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. +Basic apps are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. +* **isLinux**: bool: Is this a linux stamp capacity +* **name**: string: Name of the stamp. +* **siteMode**: string: Shared or Dedicated. +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). +* **unit**: string: Name of the unit. +* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. +* **workerSizeId**: int: Size ID of machines: +0 - Small +1 - Medium +2 - Large + ## StaticSite ### Properties * **branch**: string: The target branch in the repository. @@ -1800,54 +1825,42 @@ Point-To-Site VPN connection. * **appArtifactLocation**: string: The path of the app artifacts after building. * **appLocation**: string: The path to the app code within the repository. -## ResourceTags +## StaticSiteUserARMResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## BackupRequest +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -1856,25 +1869,12 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -1885,16 +1885,6 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -1919,111 +1909,121 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## StringDictionaryProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +### Additional Properties +* **Additional Properties Type**: string -## FunctionSecrets +## SwiftVirtualNetworkProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## FunctionSecretsProperties +## UserProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. -## FunctionSecrets +## VirtualApplication ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## StringDictionary +## VirtualDirectory ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. -## FunctionSecrets +## VirtualIPMapping ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **internalHttpPort**: int: Internal HTTP port. +* **internalHttpsPort**: int: Internal HTTPS port. +* **inUse**: bool: Is virtual IP mapping in use. +* **serviceName**: string: name of the service that virtual IP is assigned to +* **virtualIP**: string: Virtual IP address. -## FunctionSecrets +## VirtualNetworkProfile ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FunctionSecretsProperties](#functionsecretsproperties) (ReadOnly): FunctionSecrets resource specific properties -* **type**: string (ReadOnly): Resource type. +* **id**: string: Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). -## StaticSiteUserCollection +## VnetGatewayProperties ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. -## StaticSiteUserARMResource +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2020-06-01/types.json b/generated/web/microsoft.web/2020-06-01/types.json index 74f3db15ef..73fd41f8a6 100644 --- a/generated/web/microsoft.web/2020-06-01/types.json +++ b/generated/web/microsoft.web/2020-06-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2020-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":28,"Flags":9,"Description":"The resource name"},"type":{"Type":29,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":30,"Flags":10,"Description":"The resource api version"},"properties":{"Type":32,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-06-01","ScopeType":1,"Body":31}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":34,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":35,"Flags":10,"Description":"The resource api version"},"properties":{"Type":37,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-06-01","ScopeType":1,"Body":36}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":39,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":40,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":166,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":174,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":43,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":46,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":47,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":51,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":60,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":153,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":156,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":157,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":159,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":165,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[44,45]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[48,49,50]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":56,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":59,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[53,54,55]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[57,58]}},{"3":{"ItemType":52}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":62,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":64,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":78,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":79,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":81,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":96,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":99,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":103,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":109,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":110,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":113,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":114,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":126,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":128,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":130,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":131,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":139,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":140,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":144,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":148,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":152,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":63}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":77,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[66,67,68,69,70,71,72,73,74,75,76]}},{"3":{"ItemType":65}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":80}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[82,83,84,85,86,87,88,89,90,91,92,93,94,95]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[97,98]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":102,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[104,105,106,107,108]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":112,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":111}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":115,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":120,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":116,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":118,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":119,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":117}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":124,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":125,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[121,122,123]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":127,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":136,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":138,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[133,134,135]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":137}},{"3":{"ItemType":132}},{"3":{"ItemType":132}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[141,142,143]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[145,146,147]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[149,150,151]}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"5":{"Elements":[154,155]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":158,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[160,161,162,163,164]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":171,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":173,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[167,168,169,170]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":172}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-06-01","ScopeType":8,"Body":41}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":176,"Flags":9,"Description":"The resource name"},"type":{"Type":177,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":178,"Flags":10,"Description":"The resource api version"},"properties":{"Type":180,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":181,"Flags":9,"Description":"The resource name"},"type":{"Type":182,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":183,"Flags":10,"Description":"The resource api version"},"properties":{"Type":180,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":179,"scm":184}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-06-01","ScopeType":8,"Body":185}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":187,"Flags":9,"Description":"The resource name"},"type":{"Type":188,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":189,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":192,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"properties":{"Type":196,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":199,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":200,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":207,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":208,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":209,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":210,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":211,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":212,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":213,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[197,198]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[201,202,203,204,205,206]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":214,"Flags":9,"Description":"The resource name"},"type":{"Type":215,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":216,"Flags":10,"Description":"The resource api version"},"properties":{"Type":218,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":219,"Flags":0},"globalValidation":{"Type":221,"Flags":0},"identityProviders":{"Type":229,"Flags":0},"login":{"Type":278,"Flags":0},"httpSettings":{"Type":296,"Flags":0}}}},{"2":{"Name":"AuthPlatform","Properties":{"properties":{"Type":220,"Flags":0,"Description":"AuthPlatform resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AuthPlatformProperties","Properties":{"enabled":{"Type":2,"Flags":0},"runtimeVersion":{"Type":4,"Flags":0},"configFilePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalValidation","Properties":{"properties":{"Type":222,"Flags":0,"Description":"GlobalValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"GlobalValidationProperties","Properties":{"requireAuthentication":{"Type":2,"Flags":0},"unauthenticatedClientAction":{"Type":227,"Flags":0},"redirectToProvider":{"Type":4,"Flags":0},"excludedPaths":{"Type":228,"Flags":0,"Description":"Array of GlobalValidationPropertiesExcludedPathsItem"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[223,224,225,226]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"properties":{"Type":230,"Flags":0,"Description":"IdentityProviders resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"IdentityProvidersProperties","Properties":{"azureActiveDirectory":{"Type":231,"Flags":0},"facebook":{"Type":245,"Flags":0},"gitHub":{"Type":252,"Flags":0},"google":{"Type":256,"Flags":0},"twitter":{"Type":261,"Flags":0},"customOpenIdConnectProviders":{"Type":277,"Flags":0,"Description":"Dictionary of "}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"properties":{"Type":232,"Flags":0,"Description":"AzureActiveDirectory resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":233,"Flags":0},"login":{"Type":235,"Flags":0},"validation":{"Type":238,"Flags":0},"isAutoProvisioned":{"Type":2,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"properties":{"Type":234,"Flags":0,"Description":"AzureActiveDirectoryRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryRegistrationProperties","Properties":{"openIdIssuer":{"Type":4,"Flags":0},"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"properties":{"Type":236,"Flags":0,"Description":"AzureActiveDirectoryLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryLoginProperties","Properties":{"disableWWWAuthenticate":{"Type":2,"Flags":0},"loginParameters":{"Type":237,"Flags":0,"Description":"Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"properties":{"Type":239,"Flags":0,"Description":"AzureActiveDirectoryValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryValidationProperties","Properties":{"jwtClaimChecks":{"Type":240,"Flags":0},"allowedAudiences":{"Type":244,"Flags":0,"Description":"Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem"}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"properties":{"Type":241,"Flags":0,"Description":"JwtClaimChecks resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"JwtClaimChecksProperties","Properties":{"allowedGroups":{"Type":242,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedGroupsItem"},"allowedClientApplications":{"Type":243,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"properties":{"Type":246,"Flags":0,"Description":"Facebook resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FacebookProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":247,"Flags":0},"graphApiVersion":{"Type":4,"Flags":0},"login":{"Type":249,"Flags":0}}}},{"2":{"Name":"AppRegistration","Properties":{"properties":{"Type":248,"Flags":0,"Description":"AppRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AppRegistrationProperties","Properties":{"appId":{"Type":4,"Flags":0},"appSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoginScopes","Properties":{"properties":{"Type":250,"Flags":0,"Description":"LoginScopes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"LoginScopesProperties","Properties":{"scopes":{"Type":251,"Flags":0,"Description":"Array of LoginScopesPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"properties":{"Type":253,"Flags":0,"Description":"GitHub resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"GitHubProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":254,"Flags":0},"login":{"Type":249,"Flags":0}}}},{"2":{"Name":"ClientRegistration","Properties":{"properties":{"Type":255,"Flags":0,"Description":"ClientRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"ClientRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Google","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Google resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"GoogleProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":254,"Flags":0},"login":{"Type":249,"Flags":0},"validation":{"Type":258,"Flags":0}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"properties":{"Type":259,"Flags":0,"Description":"AllowedAudiencesValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AllowedAudiencesValidationProperties","Properties":{"allowedAudiences":{"Type":260,"Flags":0,"Description":"Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Twitter","Properties":{"properties":{"Type":262,"Flags":0,"Description":"Twitter resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"TwitterProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":263,"Flags":0}}}},{"2":{"Name":"TwitterRegistration","Properties":{"properties":{"Type":264,"Flags":0,"Description":"TwitterRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"TwitterRegistrationProperties","Properties":{"consumerKey":{"Type":4,"Flags":0},"consumerSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"properties":{"Type":266,"Flags":0,"Description":"CustomOpenIdConnectProvider resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"CustomOpenIdConnectProviderProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":267,"Flags":0},"login":{"Type":274,"Flags":0}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"properties":{"Type":268,"Flags":0,"Description":"OpenIdConnectRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientCredential":{"Type":269,"Flags":0},"openIdConnectConfiguration":{"Type":272,"Flags":0}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"properties":{"Type":270,"Flags":0,"Description":"OpenIdConnectClientCredential resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectClientCredentialProperties","Properties":{"method":{"Type":271,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"properties":{"Type":273,"Flags":0,"Description":"OpenIdConnectConfig resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectConfigProperties","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0},"tokenEndpoint":{"Type":4,"Flags":0},"issuer":{"Type":4,"Flags":0},"certificationUri":{"Type":4,"Flags":0},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"properties":{"Type":275,"Flags":0,"Description":"OpenIdConnectLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectLoginProperties","Properties":{"nameClaimType":{"Type":4,"Flags":0},"scopes":{"Type":276,"Flags":0,"Description":"Array of OpenIdConnectLoginPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersPropertiesCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":265}},{"2":{"Name":"Login","Properties":{"properties":{"Type":279,"Flags":0,"Description":"Login resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"LoginProperties","Properties":{"routes":{"Type":280,"Flags":0},"tokenStore":{"Type":282,"Flags":0},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0},"allowedExternalRedirectUrls":{"Type":288,"Flags":0,"Description":"Array of LoginPropertiesAllowedExternalRedirectUrlsItem"},"cookieExpiration":{"Type":289,"Flags":0},"nonce":{"Type":294,"Flags":0}}}},{"2":{"Name":"LoginRoutes","Properties":{"properties":{"Type":281,"Flags":0,"Description":"LoginRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"LoginRoutesProperties","Properties":{"logoutEndpoint":{"Type":4,"Flags":0}}}},{"2":{"Name":"TokenStore","Properties":{"properties":{"Type":283,"Flags":0,"Description":"TokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"TokenStoreProperties","Properties":{"enabled":{"Type":2,"Flags":0},"tokenRefreshExtensionHours":{"Type":3,"Flags":0},"fileSystem":{"Type":284,"Flags":0},"azureBlobStorage":{"Type":286,"Flags":0}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"properties":{"Type":285,"Flags":0,"Description":"FileSystemTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FileSystemTokenStoreProperties","Properties":{"directory":{"Type":4,"Flags":0}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"properties":{"Type":287,"Flags":0,"Description":"BlobStorageTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BlobStorageTokenStoreProperties","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"properties":{"Type":290,"Flags":0,"Description":"CookieExpiration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"CookieExpirationProperties","Properties":{"convention":{"Type":293,"Flags":0},"timeToExpiration":{"Type":4,"Flags":0}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[291,292]}},{"2":{"Name":"Nonce","Properties":{"properties":{"Type":295,"Flags":0,"Description":"Nonce resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"NonceProperties","Properties":{"validateNonce":{"Type":2,"Flags":0},"nonceExpirationInterval":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpSettings","Properties":{"properties":{"Type":297,"Flags":0,"Description":"HttpSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HttpSettingsProperties","Properties":{"requireHttps":{"Type":2,"Flags":0},"routes":{"Type":298,"Flags":0},"forwardProxy":{"Type":300,"Flags":0}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"properties":{"Type":299,"Flags":0,"Description":"HttpSettingsRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HttpSettingsRoutesProperties","Properties":{"apiPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardProxy","Properties":{"properties":{"Type":301,"Flags":0,"Description":"ForwardProxy resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"ForwardProxyProperties","Properties":{"convention":{"Type":305,"Flags":0},"customHostHeaderName":{"Type":4,"Flags":0},"customProtoHeaderName":{"Type":4,"Flags":0}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[302,303,304]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":306,"Flags":9,"Description":"The resource name"},"type":{"Type":307,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":308,"Flags":10,"Description":"The resource api version"},"properties":{"Type":318,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":313,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":317,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[311,312]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[314,315,316]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":310}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":319,"Flags":9,"Description":"The resource name"},"type":{"Type":320,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":321,"Flags":10,"Description":"The resource api version"},"properties":{"Type":323,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":324,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":334,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":327,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[325,326]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":333,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[329,330,331,332]}},{"3":{"ItemType":328}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":335,"Flags":9,"Description":"The resource name"},"type":{"Type":336,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":337,"Flags":10,"Description":"The resource api version"},"properties":{"Type":352,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":351,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[340,341,342,343,344,345,346,347,348,349,350]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":339}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":353,"Flags":9,"Description":"The resource name"},"type":{"Type":354,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":355,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":358,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":380,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":383,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":383,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":359,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":366,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":373,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":365,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[360,361,362,363,364]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":372,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[367,368,369,370,371]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":379,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[374,375,376,377,378]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":381,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":382,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":384,"Flags":9,"Description":"The resource name"},"type":{"Type":385,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":386,"Flags":10,"Description":"The resource api version"},"properties":{"Type":388,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":393,"Flags":9,"Description":"The resource name"},"type":{"Type":394,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":395,"Flags":10,"Description":"The resource api version"},"properties":{"Type":397,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":398,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":399,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":400,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":401,"Flags":9,"Description":"The resource name"},"type":{"Type":402,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":403,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":190,"authsettings":195,"authsettingsV2":217,"azurestorageaccounts":309,"backup":322,"connectionstrings":338,"logs":356,"metadata":387,"pushsettings":392,"slotConfigNames":396,"web":404}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-06-01","ScopeType":8,"Body":405}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":407,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":408,"Flags":10,"Description":"The resource api version"},"properties":{"Type":410,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-06-01","ScopeType":8,"Body":409}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":412,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":413,"Flags":10,"Description":"The resource api version"},"properties":{"Type":415,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-06-01","ScopeType":8,"Body":414}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":417,"Flags":9,"Description":"The resource name"},"type":{"Type":418,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":419,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":422,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":428,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[423,424,425,426,427]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-06-01","ScopeType":8,"Body":420}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":430,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":431,"Flags":10,"Description":"The resource api version"},"properties":{"Type":433,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":434,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-06-01","ScopeType":8,"Body":432}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":436,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":437,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-06-01","ScopeType":8,"Body":438}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":440,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":441,"Flags":10,"Description":"The resource api version"},"properties":{"Type":443,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":446,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":449,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":452,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":456,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[444,445]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[447,448]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[450,451]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[453,454,455]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-06-01","ScopeType":8,"Body":442}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":458,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":459,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-06-01","ScopeType":8,"Body":460}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":463,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":464,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-06-01","ScopeType":8,"Body":465}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":468,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-06-01","ScopeType":8,"Body":471}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":473,"Flags":9,"Description":"The resource name"},"type":{"Type":474,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":475,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-06-01","ScopeType":8,"Body":476}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":479,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":480,"Flags":10,"Description":"The resource api version"},"properties":{"Type":482,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":483,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-06-01","ScopeType":8,"Body":481}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":485,"Flags":9,"Description":"The resource name"},"type":{"Type":486,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":487,"Flags":10,"Description":"The resource api version"},"properties":{"Type":489,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":493,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":492,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":491}},{"3":{"ItemType":490}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-06-01","ScopeType":8,"Body":488}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":495,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":496,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":502,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[499,500,501]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-06-01","ScopeType":8,"Body":497}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":504,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":505,"Flags":10,"Description":"The resource api version"},"properties":{"Type":507,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":510,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":511,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[508,509]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-06-01","ScopeType":8,"Body":506}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":513,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":514,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":166,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":516,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-06-01","ScopeType":8,"Body":515}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":518,"Flags":9,"Description":"The resource name"},"type":{"Type":519,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":520,"Flags":10,"Description":"The resource api version"},"properties":{"Type":522,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":523,"Flags":9,"Description":"The resource name"},"type":{"Type":524,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":525,"Flags":10,"Description":"The resource api version"},"properties":{"Type":196,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":527,"Flags":9,"Description":"The resource name"},"type":{"Type":528,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":529,"Flags":10,"Description":"The resource api version"},"properties":{"Type":218,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":531,"Flags":9,"Description":"The resource name"},"type":{"Type":532,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":533,"Flags":10,"Description":"The resource api version"},"properties":{"Type":535,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":310}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":536,"Flags":9,"Description":"The resource name"},"type":{"Type":537,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":538,"Flags":10,"Description":"The resource api version"},"properties":{"Type":323,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":540,"Flags":9,"Description":"The resource name"},"type":{"Type":541,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":542,"Flags":10,"Description":"The resource api version"},"properties":{"Type":544,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":339}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":545,"Flags":9,"Description":"The resource name"},"type":{"Type":546,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":547,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":549,"Flags":9,"Description":"The resource name"},"type":{"Type":550,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":551,"Flags":10,"Description":"The resource api version"},"properties":{"Type":553,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":554,"Flags":9,"Description":"The resource name"},"type":{"Type":555,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":556,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":558,"Flags":9,"Description":"The resource name"},"type":{"Type":559,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":560,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":521,"authsettings":526,"authsettingsV2":530,"azurestorageaccounts":534,"backup":539,"connectionstrings":543,"logs":548,"metadata":552,"pushsettings":557,"web":561}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-06-01","ScopeType":8,"Body":562}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":564,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":565,"Flags":10,"Description":"The resource api version"},"properties":{"Type":410,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-06-01","ScopeType":8,"Body":566}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":568,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":569,"Flags":10,"Description":"The resource api version"},"properties":{"Type":415,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-06-01","ScopeType":8,"Body":570}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":572,"Flags":9,"Description":"The resource name"},"type":{"Type":573,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":574,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-06-01","ScopeType":8,"Body":575}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":577,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":578,"Flags":10,"Description":"The resource api version"},"properties":{"Type":433,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-06-01","ScopeType":8,"Body":579}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":581,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":582,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-06-01","ScopeType":8,"Body":583}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"},"properties":{"Type":443,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-06-01","ScopeType":8,"Body":587}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":589,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":590,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-06-01","ScopeType":8,"Body":591}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":593,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":594,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-06-01","ScopeType":8,"Body":595}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":597,"Flags":9,"Description":"The resource name"},"type":{"Type":598,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":599,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-06-01","ScopeType":8,"Body":600}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":602,"Flags":9,"Description":"The resource name"},"type":{"Type":603,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":604,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2020-06-01","ScopeType":8,"Body":605}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":607,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":608,"Flags":10,"Description":"The resource api version"},"properties":{"Type":482,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":610,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-06-01","ScopeType":8,"Body":609}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":612,"Flags":9,"Description":"The resource name"},"type":{"Type":613,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":614,"Flags":10,"Description":"The resource api version"},"properties":{"Type":489,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-06-01","ScopeType":8,"Body":615}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":617,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":618,"Flags":10,"Description":"The resource api version"},"properties":{"Type":620,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":621,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":622,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-06-01","ScopeType":8,"Body":619}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":624,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":625,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-06-01","ScopeType":8,"Body":626}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":628,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":629,"Flags":10,"Description":"The resource api version"},"properties":{"Type":507,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-06-01","ScopeType":8,"Body":630}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":632,"Flags":9,"Description":"The resource name"},"type":{"Type":633,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":634,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-06-01","ScopeType":8,"Body":635}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":638,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":639,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":648,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":643,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":647,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[644,645,646]}},{"3":{"ItemType":642}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-06-01","ScopeType":8,"Body":640}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":650,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":651,"Flags":10,"Description":"The resource api version"},"properties":{"Type":653,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-06-01","ScopeType":8,"Body":652}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":655,"Flags":9,"Description":"The resource name"},"type":{"Type":656,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":657,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-06-01","ScopeType":8,"Body":658}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":660,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":661,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-06-01","ScopeType":8,"Body":662}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":664,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":665,"Flags":10,"Description":"The resource api version"},"properties":{"Type":653,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-06-01","ScopeType":8,"Body":666}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":668,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":669,"Flags":10,"Description":"The resource api version"},"properties":{"Type":671,"Flags":0,"Description":"A static site."},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":679,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":672,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":673,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":675,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":676,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":678,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":677}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-06-01","ScopeType":8,"Body":670}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":681,"Flags":9,"Description":"The resource name"},"type":{"Type":682,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":683,"Flags":10,"Description":"The resource api version"},"properties":{"Type":685,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-06-01","ScopeType":8,"Body":684}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":687,"Flags":9,"Description":"The resource name"},"type":{"Type":688,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":689,"Flags":10,"Description":"The resource api version"},"properties":{"Type":691,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-06-01","ScopeType":8,"Body":690}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-06-01","ScopeType":8,"Body":695}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":697,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":698,"Flags":10,"Description":"The resource api version"},"properties":{"Type":700,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":749,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":706,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":711,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":712,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":717,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":724,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":726,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":741,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":746,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":747,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":748,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[701,702,703,704,705]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[707,708,709,710]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web,Publishing"}},{"5":{"Elements":[713,714,715,716]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":722,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":723,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[719,720,721]}},{"3":{"ItemType":4}},{"3":{"ItemType":718}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":725}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":731,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":740,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[728,729,730]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[732,733,734,735,736,737,738,739]}},{"3":{"ItemType":727}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":745,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[743,744]}},{"3":{"ItemType":742}},{"3":{"ItemType":63}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-06-01","ScopeType":8,"Body":699}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":751,"Flags":9,"Description":"The resource name"},"type":{"Type":752,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":753,"Flags":10,"Description":"The resource api version"},"properties":{"Type":718,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-06-01","ScopeType":8,"Body":754}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":756,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":757,"Flags":10,"Description":"The resource api version"},"properties":{"Type":718,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-06-01","ScopeType":8,"Body":758}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":760,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":761,"Flags":10,"Description":"The resource api version"},"properties":{"Type":763,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":774,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":767,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":773,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[764,765,766]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[768,769,770,771,772]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-06-01","ScopeType":8,"Body":762}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":776,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":777,"Flags":10,"Description":"The resource api version"},"properties":{"Type":653,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-06-01","ScopeType":8,"Body":778}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":780,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":781,"Flags":10,"Description":"The resource api version"},"properties":{"Type":643,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-06-01","ScopeType":8,"Body":782}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":323,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":786,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":797,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":798,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[787,788,789,790,791,792,793,794,795,796]}},{"3":{"ItemType":328}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-06-01","Output":785,"Input":784}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":801,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-06-01","Output":800}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-06-01","Output":804}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":807,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":808,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-06-01","Output":806}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":811,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":785}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-06-01","Output":810}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-06-01","Output":804}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-06-01","Output":785,"Input":784}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-06-01","Output":804}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-06-01","Output":806}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-06-01","Output":810}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-06-01","Output":804}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":824,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":823,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":822}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-06-01","Output":821}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-06-01","Output":800}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":830,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-06-01","Output":829}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2020-06-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":28,"Flags":9,"Description":"The resource name"},"type":{"Type":29,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":30,"Flags":10,"Description":"The resource api version"},"properties":{"Type":32,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-06-01","ScopeType":1,"Body":31}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":34,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":35,"Flags":10,"Description":"The resource api version"},"properties":{"Type":37,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-06-01","ScopeType":1,"Body":36}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":39,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":40,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":166,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":174,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":43,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":46,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":47,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":51,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":60,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":153,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":156,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":157,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":159,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":165,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[44,45]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[48,49,50]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":56,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":59,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[53,54,55]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[57,58]}},{"3":{"ItemType":52}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":62,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":64,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":78,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":79,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":81,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":96,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":99,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":103,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":109,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":110,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":113,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":114,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":126,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":128,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":130,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":131,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":139,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":140,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":144,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":148,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":152,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":63}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":77,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[66,67,68,69,70,71,72,73,74,75,76]}},{"3":{"ItemType":65}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":80}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[82,83,84,85,86,87,88,89,90,91,92,93,94,95,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[97,98]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":102,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[104,105,106,107,108]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":112,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":111}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":115,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":120,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":116,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":118,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":119,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":117}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":124,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":125,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[121,122,123]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":127,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":136,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":138,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[133,134,135,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":137}},{"3":{"ItemType":132}},{"3":{"ItemType":132}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[141,142,143,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[145,146,147,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[149,150,151,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"5":{"Elements":[154,155]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":158,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[160,161,162,163,164]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":171,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":173,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[167,168,169,170]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":172}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-06-01","ScopeType":8,"Body":41}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":176,"Flags":9,"Description":"The resource name"},"type":{"Type":177,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":178,"Flags":10,"Description":"The resource api version"},"properties":{"Type":180,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":181,"Flags":9,"Description":"The resource name"},"type":{"Type":182,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":183,"Flags":10,"Description":"The resource api version"},"properties":{"Type":180,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":179,"scm":184}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-06-01","ScopeType":8,"Body":185}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":187,"Flags":9,"Description":"The resource name"},"type":{"Type":188,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":189,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":192,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"properties":{"Type":196,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":199,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":200,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":207,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":208,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":209,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":210,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":211,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":212,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":213,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[197,198]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[201,202,203,204,205,206]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":214,"Flags":9,"Description":"The resource name"},"type":{"Type":215,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":216,"Flags":10,"Description":"The resource api version"},"properties":{"Type":218,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":219,"Flags":0},"globalValidation":{"Type":221,"Flags":0},"identityProviders":{"Type":229,"Flags":0},"login":{"Type":278,"Flags":0},"httpSettings":{"Type":296,"Flags":0}}}},{"2":{"Name":"AuthPlatform","Properties":{"properties":{"Type":220,"Flags":0,"Description":"AuthPlatform resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AuthPlatformProperties","Properties":{"enabled":{"Type":2,"Flags":0},"runtimeVersion":{"Type":4,"Flags":0},"configFilePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalValidation","Properties":{"properties":{"Type":222,"Flags":0,"Description":"GlobalValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"GlobalValidationProperties","Properties":{"requireAuthentication":{"Type":2,"Flags":0},"unauthenticatedClientAction":{"Type":227,"Flags":0},"redirectToProvider":{"Type":4,"Flags":0},"excludedPaths":{"Type":228,"Flags":0,"Description":"Array of GlobalValidationPropertiesExcludedPathsItem"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[223,224,225,226]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"properties":{"Type":230,"Flags":0,"Description":"IdentityProviders resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"IdentityProvidersProperties","Properties":{"azureActiveDirectory":{"Type":231,"Flags":0},"facebook":{"Type":245,"Flags":0},"gitHub":{"Type":252,"Flags":0},"google":{"Type":256,"Flags":0},"twitter":{"Type":261,"Flags":0},"customOpenIdConnectProviders":{"Type":277,"Flags":0,"Description":"Dictionary of "}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"properties":{"Type":232,"Flags":0,"Description":"AzureActiveDirectory resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":233,"Flags":0},"login":{"Type":235,"Flags":0},"validation":{"Type":238,"Flags":0},"isAutoProvisioned":{"Type":2,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"properties":{"Type":234,"Flags":0,"Description":"AzureActiveDirectoryRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryRegistrationProperties","Properties":{"openIdIssuer":{"Type":4,"Flags":0},"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"properties":{"Type":236,"Flags":0,"Description":"AzureActiveDirectoryLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryLoginProperties","Properties":{"disableWWWAuthenticate":{"Type":2,"Flags":0},"loginParameters":{"Type":237,"Flags":0,"Description":"Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"properties":{"Type":239,"Flags":0,"Description":"AzureActiveDirectoryValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AzureActiveDirectoryValidationProperties","Properties":{"jwtClaimChecks":{"Type":240,"Flags":0},"allowedAudiences":{"Type":244,"Flags":0,"Description":"Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem"}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"properties":{"Type":241,"Flags":0,"Description":"JwtClaimChecks resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"JwtClaimChecksProperties","Properties":{"allowedGroups":{"Type":242,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedGroupsItem"},"allowedClientApplications":{"Type":243,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"properties":{"Type":246,"Flags":0,"Description":"Facebook resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FacebookProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":247,"Flags":0},"graphApiVersion":{"Type":4,"Flags":0},"login":{"Type":249,"Flags":0}}}},{"2":{"Name":"AppRegistration","Properties":{"properties":{"Type":248,"Flags":0,"Description":"AppRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AppRegistrationProperties","Properties":{"appId":{"Type":4,"Flags":0},"appSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoginScopes","Properties":{"properties":{"Type":250,"Flags":0,"Description":"LoginScopes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"LoginScopesProperties","Properties":{"scopes":{"Type":251,"Flags":0,"Description":"Array of LoginScopesPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"properties":{"Type":253,"Flags":0,"Description":"GitHub resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"GitHubProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":254,"Flags":0},"login":{"Type":249,"Flags":0}}}},{"2":{"Name":"ClientRegistration","Properties":{"properties":{"Type":255,"Flags":0,"Description":"ClientRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"ClientRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Google","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Google resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"GoogleProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":254,"Flags":0},"login":{"Type":249,"Flags":0},"validation":{"Type":258,"Flags":0}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"properties":{"Type":259,"Flags":0,"Description":"AllowedAudiencesValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"AllowedAudiencesValidationProperties","Properties":{"allowedAudiences":{"Type":260,"Flags":0,"Description":"Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Twitter","Properties":{"properties":{"Type":262,"Flags":0,"Description":"Twitter resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"TwitterProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":263,"Flags":0}}}},{"2":{"Name":"TwitterRegistration","Properties":{"properties":{"Type":264,"Flags":0,"Description":"TwitterRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"TwitterRegistrationProperties","Properties":{"consumerKey":{"Type":4,"Flags":0},"consumerSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"properties":{"Type":266,"Flags":0,"Description":"CustomOpenIdConnectProvider resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"CustomOpenIdConnectProviderProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":267,"Flags":0},"login":{"Type":274,"Flags":0}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"properties":{"Type":268,"Flags":0,"Description":"OpenIdConnectRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientCredential":{"Type":269,"Flags":0},"openIdConnectConfiguration":{"Type":272,"Flags":0}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"properties":{"Type":270,"Flags":0,"Description":"OpenIdConnectClientCredential resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectClientCredentialProperties","Properties":{"method":{"Type":271,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"properties":{"Type":273,"Flags":0,"Description":"OpenIdConnectConfig resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectConfigProperties","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0},"tokenEndpoint":{"Type":4,"Flags":0},"issuer":{"Type":4,"Flags":0},"certificationUri":{"Type":4,"Flags":0},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"properties":{"Type":275,"Flags":0,"Description":"OpenIdConnectLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"OpenIdConnectLoginProperties","Properties":{"nameClaimType":{"Type":4,"Flags":0},"scopes":{"Type":276,"Flags":0,"Description":"Array of OpenIdConnectLoginPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersPropertiesCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":265}},{"2":{"Name":"Login","Properties":{"properties":{"Type":279,"Flags":0,"Description":"Login resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"LoginProperties","Properties":{"routes":{"Type":280,"Flags":0},"tokenStore":{"Type":282,"Flags":0},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0},"allowedExternalRedirectUrls":{"Type":288,"Flags":0,"Description":"Array of LoginPropertiesAllowedExternalRedirectUrlsItem"},"cookieExpiration":{"Type":289,"Flags":0},"nonce":{"Type":294,"Flags":0}}}},{"2":{"Name":"LoginRoutes","Properties":{"properties":{"Type":281,"Flags":0,"Description":"LoginRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"LoginRoutesProperties","Properties":{"logoutEndpoint":{"Type":4,"Flags":0}}}},{"2":{"Name":"TokenStore","Properties":{"properties":{"Type":283,"Flags":0,"Description":"TokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"TokenStoreProperties","Properties":{"enabled":{"Type":2,"Flags":0},"tokenRefreshExtensionHours":{"Type":3,"Flags":0},"fileSystem":{"Type":284,"Flags":0},"azureBlobStorage":{"Type":286,"Flags":0}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"properties":{"Type":285,"Flags":0,"Description":"FileSystemTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"FileSystemTokenStoreProperties","Properties":{"directory":{"Type":4,"Flags":0}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"properties":{"Type":287,"Flags":0,"Description":"BlobStorageTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BlobStorageTokenStoreProperties","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"properties":{"Type":290,"Flags":0,"Description":"CookieExpiration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"CookieExpirationProperties","Properties":{"convention":{"Type":293,"Flags":0},"timeToExpiration":{"Type":4,"Flags":0}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[291,292]}},{"2":{"Name":"Nonce","Properties":{"properties":{"Type":295,"Flags":0,"Description":"Nonce resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"NonceProperties","Properties":{"validateNonce":{"Type":2,"Flags":0},"nonceExpirationInterval":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpSettings","Properties":{"properties":{"Type":297,"Flags":0,"Description":"HttpSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HttpSettingsProperties","Properties":{"requireHttps":{"Type":2,"Flags":0},"routes":{"Type":298,"Flags":0},"forwardProxy":{"Type":300,"Flags":0}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"properties":{"Type":299,"Flags":0,"Description":"HttpSettingsRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HttpSettingsRoutesProperties","Properties":{"apiPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardProxy","Properties":{"properties":{"Type":301,"Flags":0,"Description":"ForwardProxy resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"ForwardProxyProperties","Properties":{"convention":{"Type":305,"Flags":0},"customHostHeaderName":{"Type":4,"Flags":0},"customProtoHeaderName":{"Type":4,"Flags":0}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[302,303,304]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":306,"Flags":9,"Description":"The resource name"},"type":{"Type":307,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":308,"Flags":10,"Description":"The resource api version"},"properties":{"Type":318,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":313,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":317,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[311,312]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[314,315,316]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":310}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":319,"Flags":9,"Description":"The resource name"},"type":{"Type":320,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":321,"Flags":10,"Description":"The resource api version"},"properties":{"Type":323,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":324,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":334,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":327,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[325,326]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":333,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[329,330,331,332,4]}},{"3":{"ItemType":328}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":335,"Flags":9,"Description":"The resource name"},"type":{"Type":336,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":337,"Flags":10,"Description":"The resource api version"},"properties":{"Type":352,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":351,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[340,341,342,343,344,345,346,347,348,349,350]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":339}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":353,"Flags":9,"Description":"The resource name"},"type":{"Type":354,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":355,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":358,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":380,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":383,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":383,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":359,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":366,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":373,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":365,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[360,361,362,363,364]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":372,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[367,368,369,370,371]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":379,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[374,375,376,377,378]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":381,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":382,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":384,"Flags":9,"Description":"The resource name"},"type":{"Type":385,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":386,"Flags":10,"Description":"The resource api version"},"properties":{"Type":388,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":393,"Flags":9,"Description":"The resource name"},"type":{"Type":394,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":395,"Flags":10,"Description":"The resource api version"},"properties":{"Type":397,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":398,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":399,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":400,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":401,"Flags":9,"Description":"The resource name"},"type":{"Type":402,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":403,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":190,"authsettings":195,"authsettingsV2":217,"azurestorageaccounts":309,"backup":322,"connectionstrings":338,"logs":356,"metadata":387,"pushsettings":392,"slotConfigNames":396,"web":404}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-06-01","ScopeType":8,"Body":405}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":407,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":408,"Flags":10,"Description":"The resource api version"},"properties":{"Type":410,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-06-01","ScopeType":8,"Body":409}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":412,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":413,"Flags":10,"Description":"The resource api version"},"properties":{"Type":415,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-06-01","ScopeType":8,"Body":414}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":417,"Flags":9,"Description":"The resource name"},"type":{"Type":418,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":419,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":422,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":428,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[423,424,425,426,427]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-06-01","ScopeType":8,"Body":420}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":430,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":431,"Flags":10,"Description":"The resource api version"},"properties":{"Type":433,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":434,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-06-01","ScopeType":8,"Body":432}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":436,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":437,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-06-01","ScopeType":8,"Body":438}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":440,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":441,"Flags":10,"Description":"The resource api version"},"properties":{"Type":443,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":446,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":449,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":452,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":456,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[444,445]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[447,448]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[450,451]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[453,454,455]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-06-01","ScopeType":8,"Body":442}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":458,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":459,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-06-01","ScopeType":8,"Body":460}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":463,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":464,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-06-01","ScopeType":8,"Body":465}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":468,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-06-01","ScopeType":8,"Body":471}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":473,"Flags":9,"Description":"The resource name"},"type":{"Type":474,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":475,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-06-01","ScopeType":8,"Body":476}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":479,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":480,"Flags":10,"Description":"The resource api version"},"properties":{"Type":482,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":483,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-06-01","ScopeType":8,"Body":481}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":485,"Flags":9,"Description":"The resource name"},"type":{"Type":486,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":487,"Flags":10,"Description":"The resource api version"},"properties":{"Type":489,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":493,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":492,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":491}},{"3":{"ItemType":490}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-06-01","ScopeType":8,"Body":488}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":495,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":496,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":502,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[499,500,501]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-06-01","ScopeType":8,"Body":497}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":504,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":505,"Flags":10,"Description":"The resource api version"},"properties":{"Type":507,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":510,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":511,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[508,509]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-06-01","ScopeType":8,"Body":506}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":513,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":514,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":166,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":516,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-06-01","ScopeType":8,"Body":515}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":518,"Flags":9,"Description":"The resource name"},"type":{"Type":519,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":520,"Flags":10,"Description":"The resource api version"},"properties":{"Type":522,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":523,"Flags":9,"Description":"The resource name"},"type":{"Type":524,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":525,"Flags":10,"Description":"The resource api version"},"properties":{"Type":196,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":527,"Flags":9,"Description":"The resource name"},"type":{"Type":528,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":529,"Flags":10,"Description":"The resource api version"},"properties":{"Type":218,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":531,"Flags":9,"Description":"The resource name"},"type":{"Type":532,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":533,"Flags":10,"Description":"The resource api version"},"properties":{"Type":535,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":310}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":536,"Flags":9,"Description":"The resource name"},"type":{"Type":537,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":538,"Flags":10,"Description":"The resource api version"},"properties":{"Type":323,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":540,"Flags":9,"Description":"The resource name"},"type":{"Type":541,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":542,"Flags":10,"Description":"The resource api version"},"properties":{"Type":544,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":339}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":545,"Flags":9,"Description":"The resource name"},"type":{"Type":546,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":547,"Flags":10,"Description":"The resource api version"},"properties":{"Type":357,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":549,"Flags":9,"Description":"The resource name"},"type":{"Type":550,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":551,"Flags":10,"Description":"The resource api version"},"properties":{"Type":553,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":554,"Flags":9,"Description":"The resource name"},"type":{"Type":555,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":556,"Flags":10,"Description":"The resource api version"},"properties":{"Type":129,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":558,"Flags":9,"Description":"The resource name"},"type":{"Type":559,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":560,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":521,"authsettings":526,"authsettingsV2":530,"azurestorageaccounts":534,"backup":539,"connectionstrings":543,"logs":548,"metadata":552,"pushsettings":557,"web":561}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-06-01","ScopeType":8,"Body":562}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":564,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":565,"Flags":10,"Description":"The resource api version"},"properties":{"Type":410,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-06-01","ScopeType":8,"Body":566}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":568,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":569,"Flags":10,"Description":"The resource api version"},"properties":{"Type":415,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-06-01","ScopeType":8,"Body":570}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":572,"Flags":9,"Description":"The resource name"},"type":{"Type":573,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":574,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-06-01","ScopeType":8,"Body":575}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":577,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":578,"Flags":10,"Description":"The resource api version"},"properties":{"Type":433,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-06-01","ScopeType":8,"Body":579}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":581,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":582,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-06-01","ScopeType":8,"Body":583}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"},"properties":{"Type":443,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-06-01","ScopeType":8,"Body":587}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":589,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":590,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-06-01","ScopeType":8,"Body":591}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":593,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":594,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-06-01","ScopeType":8,"Body":595}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":597,"Flags":9,"Description":"The resource name"},"type":{"Type":598,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":599,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-06-01","ScopeType":8,"Body":600}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":602,"Flags":9,"Description":"The resource name"},"type":{"Type":603,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":604,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2020-06-01","ScopeType":8,"Body":605}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":607,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":608,"Flags":10,"Description":"The resource api version"},"properties":{"Type":482,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":610,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-06-01","ScopeType":8,"Body":609}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":612,"Flags":9,"Description":"The resource name"},"type":{"Type":613,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":614,"Flags":10,"Description":"The resource api version"},"properties":{"Type":489,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-06-01","ScopeType":8,"Body":615}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":617,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":618,"Flags":10,"Description":"The resource api version"},"properties":{"Type":620,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":621,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":622,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-06-01","ScopeType":8,"Body":619}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":624,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":625,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-06-01","ScopeType":8,"Body":626}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":628,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":629,"Flags":10,"Description":"The resource api version"},"properties":{"Type":507,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-06-01","ScopeType":8,"Body":630}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":632,"Flags":9,"Description":"The resource name"},"type":{"Type":633,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":634,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-06-01","ScopeType":8,"Body":635}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":638,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":639,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":648,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":643,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":647,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[644,645,646,4]}},{"3":{"ItemType":642}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-06-01","ScopeType":8,"Body":640}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":650,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":651,"Flags":10,"Description":"The resource api version"},"properties":{"Type":653,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-06-01","ScopeType":8,"Body":652}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":655,"Flags":9,"Description":"The resource name"},"type":{"Type":656,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":657,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-06-01","ScopeType":8,"Body":658}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":660,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":661,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-06-01","ScopeType":8,"Body":662}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":664,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":665,"Flags":10,"Description":"The resource api version"},"properties":{"Type":653,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-06-01","ScopeType":8,"Body":666}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":668,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":669,"Flags":10,"Description":"The resource api version"},"properties":{"Type":671,"Flags":0,"Description":"A static site."},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":679,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":672,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":673,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":675,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":676,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":678,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":677}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-06-01","ScopeType":8,"Body":670}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":681,"Flags":9,"Description":"The resource name"},"type":{"Type":682,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":683,"Flags":10,"Description":"The resource api version"},"properties":{"Type":685,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-06-01","ScopeType":8,"Body":684}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":687,"Flags":9,"Description":"The resource name"},"type":{"Type":688,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":689,"Flags":10,"Description":"The resource api version"},"properties":{"Type":691,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-06-01","ScopeType":8,"Body":690}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-06-01","ScopeType":8,"Body":695}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":697,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":698,"Flags":10,"Description":"The resource api version"},"properties":{"Type":700,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":749,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":706,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":711,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":712,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":717,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":724,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":726,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":741,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":746,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":747,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":748,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[701,702,703,704,705]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[707,708,709,710]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web,Publishing"}},{"5":{"Elements":[713,714,715,716,4]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":722,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":723,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[719,720,721]}},{"3":{"ItemType":4}},{"3":{"ItemType":718}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":725}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":731,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":740,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[728,729,730]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[732,733,734,735,736,737,738,739]}},{"3":{"ItemType":727}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":745,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[743,744]}},{"3":{"ItemType":742}},{"3":{"ItemType":63}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-06-01","ScopeType":8,"Body":699}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":751,"Flags":9,"Description":"The resource name"},"type":{"Type":752,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":753,"Flags":10,"Description":"The resource api version"},"properties":{"Type":718,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-06-01","ScopeType":8,"Body":754}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":756,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":757,"Flags":10,"Description":"The resource api version"},"properties":{"Type":718,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-06-01","ScopeType":8,"Body":758}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":760,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":761,"Flags":10,"Description":"The resource api version"},"properties":{"Type":763,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":674,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":774,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":767,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":773,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[764,765,766]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[768,769,770,771,772]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-06-01","ScopeType":8,"Body":762}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":776,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":777,"Flags":10,"Description":"The resource api version"},"properties":{"Type":653,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-06-01","ScopeType":8,"Body":778}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-06-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":780,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":781,"Flags":10,"Description":"The resource api version"},"properties":{"Type":643,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-06-01","ScopeType":8,"Body":782}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":323,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":786,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":797,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":798,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[787,788,789,790,791,792,793,794,795,796]}},{"3":{"ItemType":328}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-06-01","Output":785,"Input":784}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":801,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-06-01","Output":800}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-06-01","Output":804}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":807,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":808,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-06-01","Output":806}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":811,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":785}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-06-01","Output":810}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-06-01","Output":804}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-06-01","Output":785,"Input":784}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-06-01","Output":804}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-06-01","Output":806}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-06-01","Output":810}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-06-01","Output":804}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":824,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":823,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":822}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-06-01","Output":821}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-06-01","Output":800}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-06-01","Output":800}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":830,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-06-01","Output":829}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2020-06-01/types.md b/generated/web/microsoft.web/2020-06-01/types.md index 61252a37e4..f364cafa18 100644 --- a/generated/web/microsoft.web/2020-06-01/types.md +++ b/generated/web/microsoft.web/2020-06-01/types.md @@ -842,39 +842,44 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2020-06-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (Required, WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AllowedAudiencesValidationProperties](#allowedaudiencesvalidationproperties): AllowedAudiencesValidation resource specific properties +* **type**: string (ReadOnly): Resource type. -## HostingEnvironmentProfile +## AllowedAudiencesValidationProperties ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **allowedAudiences**: string[]: Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem -## ResourceTags +## ApiDefinitionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **url**: string: The URL of the API definition. + +## ApiManagementConfig +### Properties +* **id**: string: APIM-Api Identifier. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppRegistration +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AppRegistrationProperties](#appregistrationproperties): AppRegistration resource specific properties +* **type**: string (ReadOnly): Resource type. + +## AppRegistrationProperties +### Properties +* **appId**: string +* **appSecretSettingName**: string ## AppServiceEnvironment ### Properties @@ -893,7 +898,7 @@ This is valid for all deployment slots in an app. * **environmentStatus**: string (ReadOnly): Detailed message about with results of the last check of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool: Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web,Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web,Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **lastAction**: string (ReadOnly): Last deployment action on the App Service Environment. * **lastActionResult**: string (ReadOnly): Result of the last deployment action on the App Service Environment. @@ -920,96 +925,6 @@ This is valid for all deployment slots in an app. * **vnetSubnetName**: string: Subnet of the Virtual Network. * **workerPools**: [WorkerPool](#workerpool)[] (Required): Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## StampCapacity -### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. -Basic apps are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. -* **isLinux**: bool: Is this a linux stamp capacity -* **name**: string: Name of the stamp. -* **siteMode**: string: Shared or Dedicated. -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). -* **unit**: string: Name of the unit. -* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. -* **workerSizeId**: int: Size ID of machines: -0 - Small -1 - Medium -2 - Large - -## NetworkAccessControlEntry -### Properties -* **action**: 'Deny' | 'Permit': Action object. -* **description**: string: Description of network access control entry. -* **order**: int: Order of precedence. -* **remoteSubnet**: string: Remote subnet. - -## VirtualIPMapping -### Properties -* **internalHttpPort**: int: Internal HTTP port. -* **internalHttpsPort**: int: Internal HTTPS port. -* **inUse**: bool: Is virtual IP mapping in use. -* **serviceName**: string: name of the service that virtual IP is assigned to -* **virtualIP**: string: Virtual IP address. - -## VirtualNetworkProfile -### Properties -* **id**: string: Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -1033,814 +948,719 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## AuthPlatform ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AuthPlatformProperties](#authplatformproperties): AuthPlatform resource specific properties +* **type**: string (ReadOnly): Resource type. -## VnetRouteProperties +## AuthPlatformProperties ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **configFilePath**: string +* **enabled**: bool +* **runtimeVersion**: string -## ManagedServiceIdentity +## AutoHealActions ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealCustomAction ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoHealRules ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## SiteProperties +## AutoHealTriggers ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -## CloningInfo +## AzureActiveDirectory ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryProperties](#azureactivedirectoryproperties): AzureActiveDirectory resource specific properties +* **type**: string (ReadOnly): Resource type. -## CloningInfoAppSettingsOverrides +## AzureActiveDirectoryLogin ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryLoginProperties](#azureactivedirectoryloginproperties): AzureActiveDirectoryLogin resource specific properties +* **type**: string (ReadOnly): Resource type. -## HostNameSslState +## AzureActiveDirectoryLoginProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **disableWWWAuthenticate**: bool +* **loginParameters**: string[]: Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem -## SiteConfig +## AzureActiveDirectoryProperties ### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +* **enabled**: bool +* **isAutoProvisioned**: bool +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin) +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration) +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation) -## ApiDefinitionInfo +## AzureActiveDirectoryRegistration ### Properties -* **url**: string: The URL of the API definition. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryRegistrationProperties](#azureactivedirectoryregistrationproperties): AzureActiveDirectoryRegistration resource specific properties +* **type**: string (ReadOnly): Resource type. -## ApiManagementConfig +## AzureActiveDirectoryRegistrationProperties ### Properties -* **id**: string: APIM-Api Identifier. +* **clientId**: string +* **clientSecretCertificateThumbprint**: string +* **clientSecretSettingName**: string +* **openIdIssuer**: string -## AutoHealRules +## AzureActiveDirectoryValidation ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryValidationProperties](#azureactivedirectoryvalidationproperties): AzureActiveDirectoryValidation resource specific properties +* **type**: string (ReadOnly): Resource type. -## AutoHealActions +## AzureActiveDirectoryValidationProperties ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **allowedAudiences**: string[]: Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks) -## AutoHealCustomAction +## AzureBlobStorageApplicationLogsConfig ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## AutoHealTriggers +## AzureBlobStorageHttpLogsConfig ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## RequestsBasedTrigger +## AzureStorageInfoValue ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. -## SlowRequestsBasedTrigger +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## StatusCodesBasedTrigger +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## ConnStringInfo +## AzureTableStorageApplicationLogsConfig ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## CorsSettings +## BackupItem ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## Experiments +## BackupItem ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## RampUpRule +## BackupItemCollection ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## HandlerMapping +## BackupItemCollection ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## IpSecurityRestriction +## BackupItemProperties ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## BackupRequest +### Properties +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## IpSecurityRestrictionHeaders +## BackupRequest ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SiteLimits +## BackupRequestProperties ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## SiteMachineKey +## BackupSchedule ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## PushSettings +## BlobStorageTokenStore ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **properties**: [BlobStorageTokenStoreProperties](#blobstoragetokenstoreproperties): BlobStorageTokenStore resource specific properties * **type**: string (ReadOnly): Resource type. -## PushSettingsProperties +## BlobStorageTokenStoreProperties ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **sasUrlSettingName**: string -## VirtualApplication +## Capability ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. + +## CertificateProperties +### Properties +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (Required, WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. + +## ClientRegistration +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [ClientRegistrationProperties](#clientregistrationproperties): ClientRegistration resource specific properties +* **type**: string (ReadOnly): Resource type. -## VirtualDirectory +## ClientRegistrationProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **clientId**: string +* **clientSecretSettingName**: string -## SlotSwapStatus +## CloningInfo ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. -## ResourceTags +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties * **Additional Properties Type**: string -## CsmPublishingCredentialsPoliciesEntityProperties +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity -## StringDictionaryProperties +## ConnectionStringDictionaryProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteAuthSettingsProperties +## ConnectionStringDictionaryProperties ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteAuthSettingsV2Properties +## ConnStringInfo ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation) -* **httpSettings**: [HttpSettings](#httpsettings) -* **identityProviders**: [IdentityProviders](#identityproviders) -* **login**: [Login](#login) -* **platform**: [AuthPlatform](#authplatform) +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. -## GlobalValidation +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CookieExpiration ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GlobalValidationProperties](#globalvalidationproperties): GlobalValidation resource specific properties +* **properties**: [CookieExpirationProperties](#cookieexpirationproperties): CookieExpiration resource specific properties * **type**: string (ReadOnly): Resource type. -## GlobalValidationProperties +## CookieExpirationProperties ### Properties -* **excludedPaths**: string[]: Array of GlobalValidationPropertiesExcludedPathsItem -* **redirectToProvider**: string -* **requireAuthentication**: bool -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403' +* **convention**: 'FixedTime' | 'IdentityProviderDerived' +* **timeToExpiration**: string -## HttpSettings +## CorsSettings ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HttpSettingsProperties](#httpsettingsproperties): HttpSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## HttpSettingsProperties +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy) -* **requireHttps**: bool -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes) +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## ForwardProxy +## CustomOpenIdConnectProvider ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [ForwardProxyProperties](#forwardproxyproperties): ForwardProxy resource specific properties +* **properties**: [CustomOpenIdConnectProviderProperties](#customopenidconnectproviderproperties): CustomOpenIdConnectProvider resource specific properties * **type**: string (ReadOnly): Resource type. -## ForwardProxyProperties +## CustomOpenIdConnectProviderProperties ### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard' -* **customHostHeaderName**: string -* **customProtoHeaderName**: string +* **enabled**: bool +* **login**: [OpenIdConnectLogin](#openidconnectlogin) +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration) -## HttpSettingsRoutes +## DatabaseBackupSetting ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HttpSettingsRoutesProperties](#httpsettingsroutesproperties): HttpSettingsRoutes resource specific properties -* **type**: string (ReadOnly): Resource type. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## HttpSettingsRoutesProperties +## DeploymentProperties ### Properties -* **apiPrefix**: string +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## IdentityProviders +## EnabledConfig ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [IdentityProvidersProperties](#identityprovidersproperties): IdentityProviders resource specific properties -* **type**: string (ReadOnly): Resource type. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## IdentityProvidersProperties +## Experiments ### Properties -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory) -* **customOpenIdConnectProviders**: [IdentityProvidersPropertiesCustomOpenIdConnectProviders](#identityproviderspropertiescustomopenidconnectproviders): Dictionary of -* **facebook**: [Facebook](#facebook) -* **gitHub**: [GitHub](#github) -* **google**: [Google](#google) -* **twitter**: [Twitter](#twitter) +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## AzureActiveDirectory +## Facebook ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryProperties](#azureactivedirectoryproperties): AzureActiveDirectory resource specific properties +* **properties**: [FacebookProperties](#facebookproperties): Facebook resource specific properties * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryProperties +## FacebookProperties ### Properties * **enabled**: bool -* **isAutoProvisioned**: bool -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin) -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration) -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation) +* **graphApiVersion**: string +* **login**: [LoginScopes](#loginscopes) +* **registration**: [AppRegistration](#appregistration) -## AzureActiveDirectoryLogin +## FileSystemApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. + +## FileSystemTokenStore ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryLoginProperties](#azureactivedirectoryloginproperties): AzureActiveDirectoryLogin resource specific properties +* **properties**: [FileSystemTokenStoreProperties](#filesystemtokenstoreproperties): FileSystemTokenStore resource specific properties * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryLoginProperties +## FileSystemTokenStoreProperties ### Properties -* **disableWWWAuthenticate**: bool -* **loginParameters**: string[]: Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem +* **directory**: string -## AzureActiveDirectoryRegistration +## ForwardProxy ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryRegistrationProperties](#azureactivedirectoryregistrationproperties): AzureActiveDirectoryRegistration resource specific properties +* **properties**: [ForwardProxyProperties](#forwardproxyproperties): ForwardProxy resource specific properties * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryRegistrationProperties +## ForwardProxyProperties ### Properties -* **clientId**: string -* **clientSecretCertificateThumbprint**: string -* **clientSecretSettingName**: string -* **openIdIssuer**: string +* **convention**: 'Custom' | 'NoProxy' | 'Standard' +* **customHostHeaderName**: string +* **customProtoHeaderName**: string -## AzureActiveDirectoryValidation +## FunctionEnvelopeProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryValidationProperties](#azureactivedirectoryvalidationproperties): AzureActiveDirectoryValidation resource specific properties -* **type**: string (ReadOnly): Resource type. +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. -## AzureActiveDirectoryValidationProperties +## FunctionEnvelopePropertiesFiles ### Properties -* **allowedAudiences**: string[]: Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks) +### Additional Properties +* **Additional Properties Type**: string -## JwtClaimChecks +## FunctionSecrets ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [JwtClaimChecksProperties](#jwtclaimchecksproperties): JwtClaimChecks resource specific properties -* **type**: string (ReadOnly): Resource type. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## JwtClaimChecksProperties +## FunctionSecrets ### Properties -* **allowedClientApplications**: string[]: Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem -* **allowedGroups**: string[]: Array of JwtClaimChecksPropertiesAllowedGroupsItem +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## IdentityProvidersPropertiesCustomOpenIdConnectProviders +## FunctionSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## CustomOpenIdConnectProvider +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## GitHub ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [CustomOpenIdConnectProviderProperties](#customopenidconnectproviderproperties): CustomOpenIdConnectProvider resource specific properties +* **properties**: [GitHubProperties](#githubproperties): GitHub resource specific properties * **type**: string (ReadOnly): Resource type. -## CustomOpenIdConnectProviderProperties +## GitHubProperties ### Properties * **enabled**: bool -* **login**: [OpenIdConnectLogin](#openidconnectlogin) -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration) +* **login**: [LoginScopes](#loginscopes) +* **registration**: [ClientRegistration](#clientregistration) -## OpenIdConnectLogin +## GlobalValidation ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectLoginProperties](#openidconnectloginproperties): OpenIdConnectLogin resource specific properties +* **properties**: [GlobalValidationProperties](#globalvalidationproperties): GlobalValidation resource specific properties * **type**: string (ReadOnly): Resource type. -## OpenIdConnectLoginProperties +## GlobalValidationProperties ### Properties -* **nameClaimType**: string -* **scopes**: string[]: Array of OpenIdConnectLoginPropertiesScopesItem +* **excludedPaths**: string[]: Array of GlobalValidationPropertiesExcludedPathsItem +* **redirectToProvider**: string +* **requireAuthentication**: bool +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403' -## OpenIdConnectRegistration +## Google ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectRegistrationProperties](#openidconnectregistrationproperties): OpenIdConnectRegistration resource specific properties +* **properties**: [GoogleProperties](#googleproperties): Google resource specific properties * **type**: string (ReadOnly): Resource type. -## OpenIdConnectRegistrationProperties -### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential) -* **clientId**: string -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig) - -## OpenIdConnectClientCredential +## GoogleProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectClientCredentialProperties](#openidconnectclientcredentialproperties): OpenIdConnectClientCredential resource specific properties -* **type**: string (ReadOnly): Resource type. +* **enabled**: bool +* **login**: [LoginScopes](#loginscopes) +* **registration**: [ClientRegistration](#clientregistration) +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation) -## OpenIdConnectClientCredentialProperties +## HandlerMapping ### Properties -* **clientSecretSettingName**: string -* **method**: 'ClientSecretPost' +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## OpenIdConnectConfig +## HostingEnvironmentProfile ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectConfigProperties](#openidconnectconfigproperties): OpenIdConnectConfig resource specific properties -* **type**: string (ReadOnly): Resource type. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## OpenIdConnectConfigProperties +## HostKeys ### Properties -* **authorizationEndpoint**: string -* **certificationUri**: string -* **issuer**: string -* **tokenEndpoint**: string -* **wellKnownOpenIdConfiguration**: string +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## Facebook +## HostKeys ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FacebookProperties](#facebookproperties): Facebook resource specific properties -* **type**: string (ReadOnly): Resource type. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## FacebookProperties +## HostKeysFunctionKeys ### Properties -* **enabled**: bool -* **graphApiVersion**: string -* **login**: [LoginScopes](#loginscopes) -* **registration**: [AppRegistration](#appregistration) +### Additional Properties +* **Additional Properties Type**: string -## LoginScopes +## HostKeysSystemKeys ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginScopesProperties](#loginscopesproperties): LoginScopes resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## LoginScopesProperties +## HostNameBindingProperties ### Properties -* **scopes**: string[]: Array of LoginScopesPropertiesScopesItem +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AppRegistration +## HostNameSslState ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AppRegistrationProperties](#appregistrationproperties): AppRegistration resource specific properties -* **type**: string (ReadOnly): Resource type. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AppRegistrationProperties +## HttpLogsConfig ### Properties -* **appId**: string -* **appSecretSettingName**: string +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## GitHub +## HttpSettings ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GitHubProperties](#githubproperties): GitHub resource specific properties +* **properties**: [HttpSettingsProperties](#httpsettingsproperties): HttpSettings resource specific properties * **type**: string (ReadOnly): Resource type. -## GitHubProperties +## HttpSettingsProperties ### Properties -* **enabled**: bool -* **login**: [LoginScopes](#loginscopes) -* **registration**: [ClientRegistration](#clientregistration) +* **forwardProxy**: [ForwardProxy](#forwardproxy) +* **requireHttps**: bool +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes) -## ClientRegistration +## HttpSettingsRoutes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [ClientRegistrationProperties](#clientregistrationproperties): ClientRegistration resource specific properties +* **properties**: [HttpSettingsRoutesProperties](#httpsettingsroutesproperties): HttpSettingsRoutes resource specific properties * **type**: string (ReadOnly): Resource type. -## ClientRegistrationProperties +## HttpSettingsRoutesProperties ### Properties -* **clientId**: string -* **clientSecretSettingName**: string +* **apiPrefix**: string -## Google +## HybridConnectionKey ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GoogleProperties](#googleproperties): Google resource specific properties +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties * **type**: string (ReadOnly): Resource type. -## GoogleProperties +## HybridConnectionKeyProperties ### Properties -* **enabled**: bool -* **login**: [LoginScopes](#loginscopes) -* **registration**: [ClientRegistration](#clientregistration) -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation) +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## AllowedAudiencesValidation +## HybridConnectionProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AllowedAudiencesValidationProperties](#allowedaudiencesvalidationproperties): AllowedAudiencesValidation resource specific properties -* **type**: string (ReadOnly): Resource type. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## AllowedAudiencesValidationProperties +## IdentifierProperties ### Properties -* **allowedAudiences**: string[]: Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem +* **id**: string: String representation of the identity. -## Twitter +## IdentityProviders ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [TwitterProperties](#twitterproperties): Twitter resource specific properties +* **properties**: [IdentityProvidersProperties](#identityprovidersproperties): IdentityProviders resource specific properties * **type**: string (ReadOnly): Resource type. -## TwitterProperties +## IdentityProvidersProperties ### Properties -* **enabled**: bool -* **registration**: [TwitterRegistration](#twitterregistration) +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory) +* **customOpenIdConnectProviders**: [IdentityProvidersPropertiesCustomOpenIdConnectProviders](#identityproviderspropertiescustomopenidconnectproviders): Dictionary of +* **facebook**: [Facebook](#facebook) +* **gitHub**: [GitHub](#github) +* **google**: [Google](#google) +* **twitter**: [Twitter](#twitter) -## TwitterRegistration +## IdentityProvidersPropertiesCustomOpenIdConnectProviders +### Properties +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) + +## IpSecurityRestriction +### Properties +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders +### Properties +### Additional Properties +* **Additional Properties Type**: string[] + +## JwtClaimChecks ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [TwitterRegistrationProperties](#twitterregistrationproperties): TwitterRegistration resource specific properties +* **properties**: [JwtClaimChecksProperties](#jwtclaimchecksproperties): JwtClaimChecks resource specific properties * **type**: string (ReadOnly): Resource type. -## TwitterRegistrationProperties +## JwtClaimChecksProperties ### Properties -* **consumerKey**: string -* **consumerSecretSettingName**: string +* **allowedClientApplications**: string[]: Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem +* **allowedGroups**: string[]: Array of JwtClaimChecksPropertiesAllowedGroupsItem ## Login ### Properties @@ -1859,286 +1679,221 @@ application used for sign-in. * **routes**: [LoginRoutes](#loginroutes) * **tokenStore**: [TokenStore](#tokenstore) -## CookieExpiration +## LoginRoutes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [CookieExpirationProperties](#cookieexpirationproperties): CookieExpiration resource specific properties +* **properties**: [LoginRoutesProperties](#loginroutesproperties): LoginRoutes resource specific properties * **type**: string (ReadOnly): Resource type. -## CookieExpirationProperties +## LoginRoutesProperties ### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived' -* **timeToExpiration**: string +* **logoutEndpoint**: string -## Nonce +## LoginScopes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [NonceProperties](#nonceproperties): Nonce resource specific properties +* **properties**: [LoginScopesProperties](#loginscopesproperties): LoginScopes resource specific properties * **type**: string (ReadOnly): Resource type. -## NonceProperties +## LoginScopesProperties ### Properties -* **nonceExpirationInterval**: string -* **validateNonce**: bool +* **scopes**: string[]: Array of LoginScopesPropertiesScopesItem -## LoginRoutes +## ManagedServiceIdentity ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginRoutesProperties](#loginroutesproperties): LoginRoutes resource specific properties -* **type**: string (ReadOnly): Resource type. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## LoginRoutesProperties +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **logoutEndpoint**: string +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## TokenStore +## MSDeployCore ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [TokenStoreProperties](#tokenstoreproperties): TokenStore resource specific properties -* **type**: string (ReadOnly): Resource type. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## TokenStoreProperties +## MSDeployCoreSetParameters ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore) -* **enabled**: bool -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore) -* **tokenRefreshExtensionHours**: int +### Additional Properties +* **Additional Properties Type**: string -## BlobStorageTokenStore +## NameValuePair ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [BlobStorageTokenStoreProperties](#blobstoragetokenstoreproperties): BlobStorageTokenStore resource specific properties -* **type**: string (ReadOnly): Resource type. +* **name**: string: Pair name. +* **value**: string: Pair value. -## BlobStorageTokenStoreProperties +## NetworkAccessControlEntry ### Properties -* **sasUrlSettingName**: string +* **action**: 'Deny' | 'Permit': Action object. +* **description**: string: Description of network access control entry. +* **order**: int: Order of precedence. +* **remoteSubnet**: string: Remote subnet. -## FileSystemTokenStore +## Nonce ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [FileSystemTokenStoreProperties](#filesystemtokenstoreproperties): FileSystemTokenStore resource specific properties +* **properties**: [NonceProperties](#nonceproperties): Nonce resource specific properties * **type**: string (ReadOnly): Resource type. -## FileSystemTokenStoreProperties +## NonceProperties ### Properties -* **directory**: string +* **nonceExpirationInterval**: string +* **validateNonce**: bool -## AuthPlatform +## OpenIdConnectClientCredential ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AuthPlatformProperties](#authplatformproperties): AuthPlatform resource specific properties +* **properties**: [OpenIdConnectClientCredentialProperties](#openidconnectclientcredentialproperties): OpenIdConnectClientCredential resource specific properties * **type**: string (ReadOnly): Resource type. -## AuthPlatformProperties -### Properties -* **configFilePath**: string -* **enabled**: bool -* **runtimeVersion**: string - -## AzureStoragePropertyDictionaryResourceProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) - -## AzureStorageInfoValue -### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. - -## BackupRequestProperties -### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. - -## BackupSchedule -### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. - -## DatabaseBackupSetting -### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string - -## ConnectionStringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) - -## ConnStringValueTypePair -### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. - -## SiteLogsConfigProperties -### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. - -## ApplicationLogsConfig +## OpenIdConnectClientCredentialProperties ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **clientSecretSettingName**: string +* **method**: 'ClientSecretPost' -## AzureBlobStorageApplicationLogsConfig +## OpenIdConnectConfig ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [OpenIdConnectConfigProperties](#openidconnectconfigproperties): OpenIdConnectConfig resource specific properties +* **type**: string (ReadOnly): Resource type. -## AzureTableStorageApplicationLogsConfig +## OpenIdConnectConfigProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +* **authorizationEndpoint**: string +* **certificationUri**: string +* **issuer**: string +* **tokenEndpoint**: string +* **wellKnownOpenIdConfiguration**: string -## FileSystemApplicationLogsConfig +## OpenIdConnectLogin ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [OpenIdConnectLoginProperties](#openidconnectloginproperties): OpenIdConnectLogin resource specific properties +* **type**: string (ReadOnly): Resource type. -## EnabledConfig +## OpenIdConnectLoginProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **nameClaimType**: string +* **scopes**: string[]: Array of OpenIdConnectLoginPropertiesScopesItem -## HttpLogsConfig +## OpenIdConnectRegistration ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [OpenIdConnectRegistrationProperties](#openidconnectregistrationproperties): OpenIdConnectRegistration resource specific properties +* **type**: string (ReadOnly): Resource type. -## AzureBlobStorageHttpLogsConfig +## OpenIdConnectRegistrationProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential) +* **clientId**: string +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig) -## FileSystemHttpLogsConfig +## PremierAddOnProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## StringDictionaryProperties +## PrivateAccessProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## SlotConfigNames +## PrivateAccessSubnet ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## DeploymentProperties +## PrivateAccessVirtualNetwork ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## IdentifierProperties +## PrivateLinkConnectionApprovalRequest ### Properties -* **id**: string: String representation of the identity. +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## MSDeployCore +## PrivateLinkConnectionState ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## MSDeployCoreSetParameters +## PublicCertificateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FunctionEnvelopeProperties +## PushSettings ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. -## FunctionEnvelopePropertiesFiles +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## HostNameBindingProperties +## RampUpRule ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. ## RelayServiceConnectionEntityProperties ### Properties @@ -2150,74 +1905,213 @@ Setting is false by default. * **resourceConnectionString**: string * **resourceType**: string -## HybridConnectionProperties +## RequestsBasedTrigger ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResourceTags ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessVirtualNetwork +## ResourceTags ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessSubnet +## ResourceTags ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkConnectionApprovalRequest +## ResourceTags ### Properties -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## ArmIdWrapper +## ResourceTags ### Properties -* **id**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string + +## SiteAuthSettingsProperties +### Properties +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PrivateLinkConnectionState +## SiteAuthSettingsV2Properties ### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection +* **globalValidation**: [GlobalValidation](#globalvalidation) +* **httpSettings**: [HttpSettings](#httpsettings) +* **identityProviders**: [IdentityProviders](#identityproviders) +* **login**: [Login](#login) +* **platform**: [AuthPlatform](#authplatform) -## PublicCertificateProperties +## SiteConfig ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id ## SiteExtensionInfoProperties ### Properties @@ -2242,35 +2136,73 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -2281,24 +2213,41 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties +## SkuCapacity ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **default**: int: Default number of workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## VnetRoute +## SkuDescription ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. + +## SlotConfigNames +### Properties +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. + +## SlotSwapStatus +### Properties +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. + +## SlowRequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2307,6 +2256,24 @@ Point-To-Site VPN connection. * **token**: string: OAuth access token. * **tokenSecret**: string: OAuth access token secret. +## StampCapacity +### Properties +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. +Basic apps are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. +* **isLinux**: bool: Is this a linux stamp capacity +* **name**: string: Name of the stamp. +* **siteMode**: string: Shared or Dedicated. +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). +* **unit**: string: Name of the unit. +* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. +* **workerSizeId**: int: Size ID of machines: +0 - Small +1 - Medium +2 - Large + ## StaticSite ### Properties * **branch**: string: The target branch in the repository. @@ -2322,54 +2289,42 @@ Point-To-Site VPN connection. * **appArtifactLocation**: string: The path of the app artifacts after building. * **appLocation**: string: The path to the app code within the repository. -## ResourceTags +## StaticSiteUserARMResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## BackupRequest +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2378,25 +2333,12 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2407,16 +2349,6 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2441,94 +2373,162 @@ Point-To-Site VPN connection. * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SwiftVirtualNetworkProperties +### Properties +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. + +## TokenStore ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **properties**: [TokenStoreProperties](#tokenstoreproperties): TokenStore resource specific properties * **type**: string (ReadOnly): Resource type. -## HybridConnectionKeyProperties +## TokenStoreProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore) +* **enabled**: bool +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore) +* **tokenRefreshExtensionHours**: int -## FunctionSecrets +## Twitter ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [TwitterProperties](#twitterproperties): Twitter resource specific properties +* **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## TwitterProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **enabled**: bool +* **registration**: [TwitterRegistration](#twitterregistration) -## StringDictionary +## TwitterRegistration ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: [TwitterRegistrationProperties](#twitterregistrationproperties): TwitterRegistration resource specific properties * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## TwitterRegistrationProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **consumerKey**: string +* **consumerSecretSettingName**: string -## FunctionSecrets +## UserProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. -## StaticSiteUserCollection +## VirtualApplication ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## StaticSiteUserARMResource +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualIPMapping +### Properties +* **internalHttpPort**: int: Internal HTTP port. +* **internalHttpsPort**: int: Internal HTTPS port. +* **inUse**: bool: Is virtual IP mapping in use. +* **serviceName**: string: name of the service that virtual IP is assigned to +* **virtualIP**: string: Virtual IP address. + +## VirtualNetworkProfile +### Properties +* **id**: string: Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2020-09-01/types.json b/generated/web/microsoft.web/2020-09-01/types.json index 871cec1da0..8ac3828546 100644 --- a/generated/web/microsoft.web/2020-09-01/types.json +++ b/generated/web/microsoft.web/2020-09-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":32,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":37,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[28,29,30,31]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[33,34,35,36]}},{"4":{"Name":"Microsoft.Web/certificates@2020-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":39,"Flags":9,"Description":"The resource name"},"type":{"Type":40,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":41,"Flags":10,"Description":"The resource api version"},"properties":{"Type":43,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-09-01","ScopeType":1,"Body":42}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-09-01","ScopeType":1,"Body":47}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":50,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":51,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":185,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":54,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":57,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":58,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":62,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":71,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":164,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":167,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":168,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":170,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":176,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[55,56]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[59,60,61]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":67,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":70,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[64,65,66]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[68,69]}},{"3":{"ItemType":63}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":73,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":75,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":89,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":90,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":92,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":107,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":110,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":114,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":120,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":121,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":124,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":125,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":137,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":139,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":141,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":142,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":150,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":151,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":155,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":159,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":163,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":74}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":88,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[77,78,79,80,81,82,83,84,85,86,87]}},{"3":{"ItemType":76}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":91}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[93,94,95,96,97,98,99,100,101,102,103,104,105,106]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[108,109]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":113,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":112}},{"3":{"ItemType":111}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[115,116,117,118,119]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":123,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":122}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":126,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":131,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":127,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":129,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":130,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":128}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":135,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":136,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[132,133,134]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":138,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":147,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":149,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[144,145,146]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":148}},{"3":{"ItemType":143}},{"3":{"ItemType":143}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[152,153,154]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[156,157,158]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[160,161,162]}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"5":{"Elements":[165,166]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":169,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[171,172,173,174,175]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":182,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":184,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[178,179,180,181]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":183}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-09-01","ScopeType":8,"Body":52}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":187,"Flags":9,"Description":"The resource name"},"type":{"Type":188,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":189,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":192,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":190,"scm":195}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-09-01","ScopeType":8,"Body":196}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":198,"Flags":9,"Description":"The resource name"},"type":{"Type":199,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":200,"Flags":10,"Description":"The resource api version"},"properties":{"Type":202,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":203,"Flags":9,"Description":"The resource name"},"type":{"Type":204,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":205,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":210,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":211,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":218,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":219,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":220,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":221,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":222,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":223,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":224,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[208,209]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[212,213,214,215,216,217]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":225,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":230,"Flags":0},"globalValidation":{"Type":232,"Flags":0},"identityProviders":{"Type":240,"Flags":0},"login":{"Type":289,"Flags":0},"httpSettings":{"Type":307,"Flags":0}}}},{"2":{"Name":"AuthPlatform","Properties":{"properties":{"Type":231,"Flags":0,"Description":"AuthPlatform resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AuthPlatformProperties","Properties":{"enabled":{"Type":2,"Flags":0},"runtimeVersion":{"Type":4,"Flags":0},"configFilePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalValidation","Properties":{"properties":{"Type":233,"Flags":0,"Description":"GlobalValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GlobalValidationProperties","Properties":{"requireAuthentication":{"Type":2,"Flags":0},"unauthenticatedClientAction":{"Type":238,"Flags":0},"redirectToProvider":{"Type":4,"Flags":0},"excludedPaths":{"Type":239,"Flags":0,"Description":"Array of GlobalValidationPropertiesExcludedPathsItem"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[234,235,236,237]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"properties":{"Type":241,"Flags":0,"Description":"IdentityProviders resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentityProvidersProperties","Properties":{"azureActiveDirectory":{"Type":242,"Flags":0},"facebook":{"Type":256,"Flags":0},"gitHub":{"Type":263,"Flags":0},"google":{"Type":267,"Flags":0},"twitter":{"Type":272,"Flags":0},"customOpenIdConnectProviders":{"Type":288,"Flags":0,"Description":"Dictionary of "}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"properties":{"Type":243,"Flags":0,"Description":"AzureActiveDirectory resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":244,"Flags":0},"login":{"Type":246,"Flags":0},"validation":{"Type":249,"Flags":0},"isAutoProvisioned":{"Type":2,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"properties":{"Type":245,"Flags":0,"Description":"AzureActiveDirectoryRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryRegistrationProperties","Properties":{"openIdIssuer":{"Type":4,"Flags":0},"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"properties":{"Type":247,"Flags":0,"Description":"AzureActiveDirectoryLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryLoginProperties","Properties":{"disableWWWAuthenticate":{"Type":2,"Flags":0},"loginParameters":{"Type":248,"Flags":0,"Description":"Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"properties":{"Type":250,"Flags":0,"Description":"AzureActiveDirectoryValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryValidationProperties","Properties":{"jwtClaimChecks":{"Type":251,"Flags":0},"allowedAudiences":{"Type":255,"Flags":0,"Description":"Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem"}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"properties":{"Type":252,"Flags":0,"Description":"JwtClaimChecks resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"JwtClaimChecksProperties","Properties":{"allowedGroups":{"Type":253,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedGroupsItem"},"allowedClientApplications":{"Type":254,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Facebook resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FacebookProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":258,"Flags":0},"graphApiVersion":{"Type":4,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"AppRegistration","Properties":{"properties":{"Type":259,"Flags":0,"Description":"AppRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppRegistrationProperties","Properties":{"appId":{"Type":4,"Flags":0},"appSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoginScopes","Properties":{"properties":{"Type":261,"Flags":0,"Description":"LoginScopes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginScopesProperties","Properties":{"scopes":{"Type":262,"Flags":0,"Description":"Array of LoginScopesPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"properties":{"Type":264,"Flags":0,"Description":"GitHub resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GitHubProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"ClientRegistration","Properties":{"properties":{"Type":266,"Flags":0,"Description":"ClientRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ClientRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Google","Properties":{"properties":{"Type":268,"Flags":0,"Description":"Google resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GoogleProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0},"validation":{"Type":269,"Flags":0}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"properties":{"Type":270,"Flags":0,"Description":"AllowedAudiencesValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AllowedAudiencesValidationProperties","Properties":{"allowedAudiences":{"Type":271,"Flags":0,"Description":"Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Twitter","Properties":{"properties":{"Type":273,"Flags":0,"Description":"Twitter resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":274,"Flags":0}}}},{"2":{"Name":"TwitterRegistration","Properties":{"properties":{"Type":275,"Flags":0,"Description":"TwitterRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterRegistrationProperties","Properties":{"consumerKey":{"Type":4,"Flags":0},"consumerSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"properties":{"Type":277,"Flags":0,"Description":"CustomOpenIdConnectProvider resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CustomOpenIdConnectProviderProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":278,"Flags":0},"login":{"Type":285,"Flags":0}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"properties":{"Type":279,"Flags":0,"Description":"OpenIdConnectRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientCredential":{"Type":280,"Flags":0},"openIdConnectConfiguration":{"Type":283,"Flags":0}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"properties":{"Type":281,"Flags":0,"Description":"OpenIdConnectClientCredential resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectClientCredentialProperties","Properties":{"method":{"Type":282,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"properties":{"Type":284,"Flags":0,"Description":"OpenIdConnectConfig resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectConfigProperties","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0},"tokenEndpoint":{"Type":4,"Flags":0},"issuer":{"Type":4,"Flags":0},"certificationUri":{"Type":4,"Flags":0},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"properties":{"Type":286,"Flags":0,"Description":"OpenIdConnectLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectLoginProperties","Properties":{"nameClaimType":{"Type":4,"Flags":0},"scopes":{"Type":287,"Flags":0,"Description":"Array of OpenIdConnectLoginPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersPropertiesCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":276}},{"2":{"Name":"Login","Properties":{"properties":{"Type":290,"Flags":0,"Description":"Login resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginProperties","Properties":{"routes":{"Type":291,"Flags":0},"tokenStore":{"Type":293,"Flags":0},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0},"allowedExternalRedirectUrls":{"Type":299,"Flags":0,"Description":"Array of LoginPropertiesAllowedExternalRedirectUrlsItem"},"cookieExpiration":{"Type":300,"Flags":0},"nonce":{"Type":305,"Flags":0}}}},{"2":{"Name":"LoginRoutes","Properties":{"properties":{"Type":292,"Flags":0,"Description":"LoginRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginRoutesProperties","Properties":{"logoutEndpoint":{"Type":4,"Flags":0}}}},{"2":{"Name":"TokenStore","Properties":{"properties":{"Type":294,"Flags":0,"Description":"TokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TokenStoreProperties","Properties":{"enabled":{"Type":2,"Flags":0},"tokenRefreshExtensionHours":{"Type":3,"Flags":0},"fileSystem":{"Type":295,"Flags":0},"azureBlobStorage":{"Type":297,"Flags":0}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"properties":{"Type":296,"Flags":0,"Description":"FileSystemTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FileSystemTokenStoreProperties","Properties":{"directory":{"Type":4,"Flags":0}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"properties":{"Type":298,"Flags":0,"Description":"BlobStorageTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BlobStorageTokenStoreProperties","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"properties":{"Type":301,"Flags":0,"Description":"CookieExpiration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CookieExpirationProperties","Properties":{"convention":{"Type":304,"Flags":0},"timeToExpiration":{"Type":4,"Flags":0}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[302,303]}},{"2":{"Name":"Nonce","Properties":{"properties":{"Type":306,"Flags":0,"Description":"Nonce resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"NonceProperties","Properties":{"validateNonce":{"Type":2,"Flags":0},"nonceExpirationInterval":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpSettings","Properties":{"properties":{"Type":308,"Flags":0,"Description":"HttpSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsProperties","Properties":{"requireHttps":{"Type":2,"Flags":0},"routes":{"Type":309,"Flags":0},"forwardProxy":{"Type":311,"Flags":0}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"properties":{"Type":310,"Flags":0,"Description":"HttpSettingsRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsRoutesProperties","Properties":{"apiPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardProxy","Properties":{"properties":{"Type":312,"Flags":0,"Description":"ForwardProxy resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ForwardProxyProperties","Properties":{"convention":{"Type":316,"Flags":0},"customHostHeaderName":{"Type":4,"Flags":0},"customProtoHeaderName":{"Type":4,"Flags":0}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[313,314,315]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":317,"Flags":9,"Description":"The resource name"},"type":{"Type":318,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":319,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":324,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":328,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[322,323]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[325,326,327]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":330,"Flags":9,"Description":"The resource name"},"type":{"Type":331,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":332,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":335,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":345,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":338,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[336,337]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":344,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[340,341,342,343]}},{"3":{"ItemType":339}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":346,"Flags":9,"Description":"The resource name"},"type":{"Type":347,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":348,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":362,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[351,352,353,354,355,356,357,358,359,360,361]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":369,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":391,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":394,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":394,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":370,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":377,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":384,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":376,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[371,372,373,374,375]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":383,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[378,379,380,381,382]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":390,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[385,386,387,388,389]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":392,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":393,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":395,"Flags":9,"Description":"The resource name"},"type":{"Type":396,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":397,"Flags":10,"Description":"The resource api version"},"properties":{"Type":399,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":400,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":404,"Flags":9,"Description":"The resource name"},"type":{"Type":405,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":406,"Flags":10,"Description":"The resource api version"},"properties":{"Type":408,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":409,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":410,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":411,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":412,"Flags":9,"Description":"The resource name"},"type":{"Type":413,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":414,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":201,"authsettings":206,"authsettingsV2":228,"azurestorageaccounts":320,"backup":333,"connectionstrings":349,"logs":367,"metadata":398,"pushsettings":403,"slotConfigNames":407,"web":415}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-09-01","ScopeType":8,"Body":416}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":418,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":419,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-09-01","ScopeType":8,"Body":420}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":423,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":424,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-09-01","ScopeType":8,"Body":425}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":433,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":439,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[434,435,436,437,438]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-09-01","ScopeType":8,"Body":431}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":441,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":442,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":445,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-09-01","ScopeType":8,"Body":443}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-09-01","ScopeType":8,"Body":449}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":457,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":460,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":463,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":467,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[455,456]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[458,459]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[461,462]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[464,465,466]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-09-01","ScopeType":8,"Body":453}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01","ScopeType":8,"Body":471}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":474,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":475,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-09-01","ScopeType":8,"Body":476}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":479,"Flags":9,"Description":"The resource name"},"type":{"Type":480,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":481,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-09-01","ScopeType":8,"Body":482}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":484,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-09-01","ScopeType":8,"Body":487}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":494,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-09-01","ScopeType":8,"Body":492}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":496,"Flags":9,"Description":"The resource name"},"type":{"Type":497,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":498,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":504,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":503,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":502}},{"3":{"ItemType":501}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-09-01","ScopeType":8,"Body":499}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":506,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":507,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":513,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[510,511,512]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-09-01","ScopeType":8,"Body":508}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":515,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":516,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":521,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":522,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[519,520]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-09-01","ScopeType":8,"Body":517}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":524,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":525,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":527,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-09-01","ScopeType":8,"Body":526}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":529,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":534,"Flags":9,"Description":"The resource name"},"type":{"Type":535,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":536,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":538,"Flags":9,"Description":"The resource name"},"type":{"Type":539,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":540,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":542,"Flags":9,"Description":"The resource name"},"type":{"Type":543,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":544,"Flags":10,"Description":"The resource api version"},"properties":{"Type":546,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":551,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":555,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":560,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":565,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":569,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":532,"authsettings":537,"authsettingsV2":541,"azurestorageaccounts":545,"backup":550,"connectionstrings":554,"logs":559,"metadata":563,"pushsettings":568,"web":572}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-09-01","ScopeType":8,"Body":573}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":575,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":576,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-09-01","ScopeType":8,"Body":577}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":579,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":580,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-09-01","ScopeType":8,"Body":581}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":583,"Flags":9,"Description":"The resource name"},"type":{"Type":584,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":585,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-09-01","ScopeType":8,"Body":586}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":588,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":589,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-09-01","ScopeType":8,"Body":590}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":592,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":593,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-09-01","ScopeType":8,"Body":594}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":596,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":597,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-09-01","ScopeType":8,"Body":598}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":600,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":601,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-09-01","ScopeType":8,"Body":602}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":604,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":605,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-09-01","ScopeType":8,"Body":606}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":608,"Flags":9,"Description":"The resource name"},"type":{"Type":609,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":610,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-09-01","ScopeType":8,"Body":611}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":613,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2020-09-01","ScopeType":8,"Body":616}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":618,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":619,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":621,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-09-01","ScopeType":8,"Body":620}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":623,"Flags":9,"Description":"The resource name"},"type":{"Type":624,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":625,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-09-01","ScopeType":8,"Body":626}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":628,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":629,"Flags":10,"Description":"The resource api version"},"properties":{"Type":631,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":632,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":633,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-09-01","ScopeType":8,"Body":630}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":635,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":636,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-09-01","ScopeType":8,"Body":637}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":639,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":640,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-09-01","ScopeType":8,"Body":641}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":643,"Flags":9,"Description":"The resource name"},"type":{"Type":644,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":645,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-09-01","ScopeType":8,"Body":646}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":659,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":654,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":658,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[655,656,657]}},{"3":{"ItemType":653}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-09-01","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-09-01","ScopeType":8,"Body":663}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":666,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-09-01","ScopeType":8,"Body":669}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-09-01","ScopeType":8,"Body":673}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-09-01","ScopeType":8,"Body":677}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":679,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":680,"Flags":10,"Description":"The resource api version"},"properties":{"Type":682,"Flags":0,"Description":"A static site."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":690,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":683,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":684,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":686,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":687,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":689,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":688}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-09-01","ScopeType":8,"Body":681}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":692,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"},"properties":{"Type":696,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-09-01","ScopeType":8,"Body":695}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":698,"Flags":9,"Description":"The resource name"},"type":{"Type":699,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":700,"Flags":10,"Description":"The resource api version"},"properties":{"Type":702,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-09-01","ScopeType":8,"Body":701}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-09-01","ScopeType":8,"Body":706}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":760,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":717,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":722,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":723,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":728,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":735,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":737,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":752,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":757,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":758,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":759,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[712,713,714,715,716]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[718,719,720,721]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web,Publishing"}},{"5":{"Elements":[724,725,726,727]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":733,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":734,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[730,731,732]}},{"3":{"ItemType":4}},{"3":{"ItemType":729}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":736}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":742,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":751,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[739,740,741]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[743,744,745,746,747,748,749,750]}},{"3":{"ItemType":738}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":756,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[754,755]}},{"3":{"ItemType":753}},{"3":{"ItemType":74}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-09-01","ScopeType":8,"Body":710}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":762,"Flags":9,"Description":"The resource name"},"type":{"Type":763,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":764,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-09-01","ScopeType":8,"Body":765}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":767,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":768,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-09-01","ScopeType":8,"Body":769}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":771,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":772,"Flags":10,"Description":"The resource api version"},"properties":{"Type":774,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":785,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":778,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":784,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[775,776,777]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[779,780,781,782,783]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-09-01","ScopeType":8,"Body":773}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-09-01","ScopeType":8,"Body":789}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":791,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":792,"Flags":10,"Description":"The resource api version"},"properties":{"Type":654,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-09-01","ScopeType":8,"Body":793}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":334,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":797,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":808,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":809,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[798,799,800,801,802,803,804,805,806,807]}},{"3":{"ItemType":339}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-09-01","Output":796,"Input":795}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":812,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-09-01","Output":811}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-09-01","Output":815}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":818,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":819,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-09-01","Output":817}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":822,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":796}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-09-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-09-01","Output":815}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-09-01","Output":796,"Input":795}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-09-01","Output":815}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-09-01","Output":817}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-09-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-09-01","Output":815}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":835,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":834,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":833}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-09-01","Output":832}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-09-01","Output":811}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":841,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-09-01","Output":840}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":32,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":37,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[28,29,30,31,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[33,34,35,36,4]}},{"4":{"Name":"Microsoft.Web/certificates@2020-09-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":39,"Flags":9,"Description":"The resource name"},"type":{"Type":40,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":41,"Flags":10,"Description":"The resource api version"},"properties":{"Type":43,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-09-01","ScopeType":1,"Body":42}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-09-01","ScopeType":1,"Body":47}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":50,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":51,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":185,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":54,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":57,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":58,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":62,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":71,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":164,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":167,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":168,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":170,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":176,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[55,56]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[59,60,61]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":67,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":70,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[64,65,66]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[68,69]}},{"3":{"ItemType":63}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":73,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":75,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":89,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":90,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":92,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":107,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":110,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":114,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":120,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":121,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":124,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":125,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":137,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":139,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":141,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":142,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":150,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":151,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":155,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":159,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":163,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":74}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":88,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[77,78,79,80,81,82,83,84,85,86,87]}},{"3":{"ItemType":76}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":91}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[93,94,95,96,97,98,99,100,101,102,103,104,105,106,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[108,109]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":113,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":112}},{"3":{"ItemType":111}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[115,116,117,118,119]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":123,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":122}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":126,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":131,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":127,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":129,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":130,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":128}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":135,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":136,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[132,133,134]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":138,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":147,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":149,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[144,145,146,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":148}},{"3":{"ItemType":143}},{"3":{"ItemType":143}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[152,153,154,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[156,157,158,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[160,161,162,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"5":{"Elements":[165,166]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":169,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[171,172,173,174,175]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":182,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":184,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[178,179,180,181]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":183}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-09-01","ScopeType":8,"Body":52}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":187,"Flags":9,"Description":"The resource name"},"type":{"Type":188,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":189,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":192,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":190,"scm":195}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-09-01","ScopeType":8,"Body":196}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":198,"Flags":9,"Description":"The resource name"},"type":{"Type":199,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":200,"Flags":10,"Description":"The resource api version"},"properties":{"Type":202,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":203,"Flags":9,"Description":"The resource name"},"type":{"Type":204,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":205,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":210,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":211,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":218,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":219,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":220,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":221,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":222,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":223,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":224,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[208,209]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[212,213,214,215,216,217]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":225,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":230,"Flags":0},"globalValidation":{"Type":232,"Flags":0},"identityProviders":{"Type":240,"Flags":0},"login":{"Type":289,"Flags":0},"httpSettings":{"Type":307,"Flags":0}}}},{"2":{"Name":"AuthPlatform","Properties":{"properties":{"Type":231,"Flags":0,"Description":"AuthPlatform resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AuthPlatformProperties","Properties":{"enabled":{"Type":2,"Flags":0},"runtimeVersion":{"Type":4,"Flags":0},"configFilePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalValidation","Properties":{"properties":{"Type":233,"Flags":0,"Description":"GlobalValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GlobalValidationProperties","Properties":{"requireAuthentication":{"Type":2,"Flags":0},"unauthenticatedClientAction":{"Type":238,"Flags":0},"redirectToProvider":{"Type":4,"Flags":0},"excludedPaths":{"Type":239,"Flags":0,"Description":"Array of GlobalValidationPropertiesExcludedPathsItem"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[234,235,236,237]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"properties":{"Type":241,"Flags":0,"Description":"IdentityProviders resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentityProvidersProperties","Properties":{"azureActiveDirectory":{"Type":242,"Flags":0},"facebook":{"Type":256,"Flags":0},"gitHub":{"Type":263,"Flags":0},"google":{"Type":267,"Flags":0},"twitter":{"Type":272,"Flags":0},"customOpenIdConnectProviders":{"Type":288,"Flags":0,"Description":"Dictionary of "}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"properties":{"Type":243,"Flags":0,"Description":"AzureActiveDirectory resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":244,"Flags":0},"login":{"Type":246,"Flags":0},"validation":{"Type":249,"Flags":0},"isAutoProvisioned":{"Type":2,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"properties":{"Type":245,"Flags":0,"Description":"AzureActiveDirectoryRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryRegistrationProperties","Properties":{"openIdIssuer":{"Type":4,"Flags":0},"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"properties":{"Type":247,"Flags":0,"Description":"AzureActiveDirectoryLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryLoginProperties","Properties":{"disableWWWAuthenticate":{"Type":2,"Flags":0},"loginParameters":{"Type":248,"Flags":0,"Description":"Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"properties":{"Type":250,"Flags":0,"Description":"AzureActiveDirectoryValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryValidationProperties","Properties":{"jwtClaimChecks":{"Type":251,"Flags":0},"allowedAudiences":{"Type":255,"Flags":0,"Description":"Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem"}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"properties":{"Type":252,"Flags":0,"Description":"JwtClaimChecks resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"JwtClaimChecksProperties","Properties":{"allowedGroups":{"Type":253,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedGroupsItem"},"allowedClientApplications":{"Type":254,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Facebook resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FacebookProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":258,"Flags":0},"graphApiVersion":{"Type":4,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"AppRegistration","Properties":{"properties":{"Type":259,"Flags":0,"Description":"AppRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppRegistrationProperties","Properties":{"appId":{"Type":4,"Flags":0},"appSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoginScopes","Properties":{"properties":{"Type":261,"Flags":0,"Description":"LoginScopes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginScopesProperties","Properties":{"scopes":{"Type":262,"Flags":0,"Description":"Array of LoginScopesPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"properties":{"Type":264,"Flags":0,"Description":"GitHub resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GitHubProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"ClientRegistration","Properties":{"properties":{"Type":266,"Flags":0,"Description":"ClientRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ClientRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Google","Properties":{"properties":{"Type":268,"Flags":0,"Description":"Google resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GoogleProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0},"validation":{"Type":269,"Flags":0}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"properties":{"Type":270,"Flags":0,"Description":"AllowedAudiencesValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AllowedAudiencesValidationProperties","Properties":{"allowedAudiences":{"Type":271,"Flags":0,"Description":"Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Twitter","Properties":{"properties":{"Type":273,"Flags":0,"Description":"Twitter resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":274,"Flags":0}}}},{"2":{"Name":"TwitterRegistration","Properties":{"properties":{"Type":275,"Flags":0,"Description":"TwitterRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterRegistrationProperties","Properties":{"consumerKey":{"Type":4,"Flags":0},"consumerSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"properties":{"Type":277,"Flags":0,"Description":"CustomOpenIdConnectProvider resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CustomOpenIdConnectProviderProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":278,"Flags":0},"login":{"Type":285,"Flags":0}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"properties":{"Type":279,"Flags":0,"Description":"OpenIdConnectRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientCredential":{"Type":280,"Flags":0},"openIdConnectConfiguration":{"Type":283,"Flags":0}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"properties":{"Type":281,"Flags":0,"Description":"OpenIdConnectClientCredential resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectClientCredentialProperties","Properties":{"method":{"Type":282,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"properties":{"Type":284,"Flags":0,"Description":"OpenIdConnectConfig resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectConfigProperties","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0},"tokenEndpoint":{"Type":4,"Flags":0},"issuer":{"Type":4,"Flags":0},"certificationUri":{"Type":4,"Flags":0},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"properties":{"Type":286,"Flags":0,"Description":"OpenIdConnectLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectLoginProperties","Properties":{"nameClaimType":{"Type":4,"Flags":0},"scopes":{"Type":287,"Flags":0,"Description":"Array of OpenIdConnectLoginPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersPropertiesCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":276}},{"2":{"Name":"Login","Properties":{"properties":{"Type":290,"Flags":0,"Description":"Login resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginProperties","Properties":{"routes":{"Type":291,"Flags":0},"tokenStore":{"Type":293,"Flags":0},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0},"allowedExternalRedirectUrls":{"Type":299,"Flags":0,"Description":"Array of LoginPropertiesAllowedExternalRedirectUrlsItem"},"cookieExpiration":{"Type":300,"Flags":0},"nonce":{"Type":305,"Flags":0}}}},{"2":{"Name":"LoginRoutes","Properties":{"properties":{"Type":292,"Flags":0,"Description":"LoginRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginRoutesProperties","Properties":{"logoutEndpoint":{"Type":4,"Flags":0}}}},{"2":{"Name":"TokenStore","Properties":{"properties":{"Type":294,"Flags":0,"Description":"TokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TokenStoreProperties","Properties":{"enabled":{"Type":2,"Flags":0},"tokenRefreshExtensionHours":{"Type":3,"Flags":0},"fileSystem":{"Type":295,"Flags":0},"azureBlobStorage":{"Type":297,"Flags":0}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"properties":{"Type":296,"Flags":0,"Description":"FileSystemTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FileSystemTokenStoreProperties","Properties":{"directory":{"Type":4,"Flags":0}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"properties":{"Type":298,"Flags":0,"Description":"BlobStorageTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BlobStorageTokenStoreProperties","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"properties":{"Type":301,"Flags":0,"Description":"CookieExpiration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CookieExpirationProperties","Properties":{"convention":{"Type":304,"Flags":0},"timeToExpiration":{"Type":4,"Flags":0}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[302,303]}},{"2":{"Name":"Nonce","Properties":{"properties":{"Type":306,"Flags":0,"Description":"Nonce resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"NonceProperties","Properties":{"validateNonce":{"Type":2,"Flags":0},"nonceExpirationInterval":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpSettings","Properties":{"properties":{"Type":308,"Flags":0,"Description":"HttpSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsProperties","Properties":{"requireHttps":{"Type":2,"Flags":0},"routes":{"Type":309,"Flags":0},"forwardProxy":{"Type":311,"Flags":0}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"properties":{"Type":310,"Flags":0,"Description":"HttpSettingsRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsRoutesProperties","Properties":{"apiPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardProxy","Properties":{"properties":{"Type":312,"Flags":0,"Description":"ForwardProxy resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ForwardProxyProperties","Properties":{"convention":{"Type":316,"Flags":0},"customHostHeaderName":{"Type":4,"Flags":0},"customProtoHeaderName":{"Type":4,"Flags":0}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[313,314,315]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":317,"Flags":9,"Description":"The resource name"},"type":{"Type":318,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":319,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":324,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":328,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[322,323]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[325,326,327]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":330,"Flags":9,"Description":"The resource name"},"type":{"Type":331,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":332,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":335,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":345,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":338,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[336,337]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":344,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[340,341,342,343,4]}},{"3":{"ItemType":339}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":346,"Flags":9,"Description":"The resource name"},"type":{"Type":347,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":348,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":362,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[351,352,353,354,355,356,357,358,359,360,361]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":369,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":391,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":394,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":394,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":370,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":377,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":384,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":376,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[371,372,373,374,375]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":383,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[378,379,380,381,382]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":390,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[385,386,387,388,389]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":392,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":393,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":395,"Flags":9,"Description":"The resource name"},"type":{"Type":396,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":397,"Flags":10,"Description":"The resource api version"},"properties":{"Type":399,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":400,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":404,"Flags":9,"Description":"The resource name"},"type":{"Type":405,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":406,"Flags":10,"Description":"The resource api version"},"properties":{"Type":408,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":409,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":410,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":411,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":412,"Flags":9,"Description":"The resource name"},"type":{"Type":413,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":414,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":201,"authsettings":206,"authsettingsV2":228,"azurestorageaccounts":320,"backup":333,"connectionstrings":349,"logs":367,"metadata":398,"pushsettings":403,"slotConfigNames":407,"web":415}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-09-01","ScopeType":8,"Body":416}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":418,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":419,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-09-01","ScopeType":8,"Body":420}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":423,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":424,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-09-01","ScopeType":8,"Body":425}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":433,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":439,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[434,435,436,437,438]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-09-01","ScopeType":8,"Body":431}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":441,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":442,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":445,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-09-01","ScopeType":8,"Body":443}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-09-01","ScopeType":8,"Body":449}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":457,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":460,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":463,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":467,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[455,456]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[458,459]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[461,462]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[464,465,466]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-09-01","ScopeType":8,"Body":453}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01","ScopeType":8,"Body":471}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":474,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":475,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-09-01","ScopeType":8,"Body":476}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":479,"Flags":9,"Description":"The resource name"},"type":{"Type":480,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":481,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-09-01","ScopeType":8,"Body":482}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":484,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-09-01","ScopeType":8,"Body":487}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":494,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-09-01","ScopeType":8,"Body":492}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":496,"Flags":9,"Description":"The resource name"},"type":{"Type":497,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":498,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":504,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":503,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":502}},{"3":{"ItemType":501}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-09-01","ScopeType":8,"Body":499}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":506,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":507,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":513,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[510,511,512]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-09-01","ScopeType":8,"Body":508}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":515,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":516,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":521,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":522,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[519,520]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-09-01","ScopeType":8,"Body":517}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":524,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":525,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":527,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-09-01","ScopeType":8,"Body":526}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":529,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":534,"Flags":9,"Description":"The resource name"},"type":{"Type":535,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":536,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":538,"Flags":9,"Description":"The resource name"},"type":{"Type":539,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":540,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":542,"Flags":9,"Description":"The resource name"},"type":{"Type":543,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":544,"Flags":10,"Description":"The resource api version"},"properties":{"Type":546,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":551,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":555,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":560,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":565,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":569,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":532,"authsettings":537,"authsettingsV2":541,"azurestorageaccounts":545,"backup":550,"connectionstrings":554,"logs":559,"metadata":563,"pushsettings":568,"web":572}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-09-01","ScopeType":8,"Body":573}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":575,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":576,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-09-01","ScopeType":8,"Body":577}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":579,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":580,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-09-01","ScopeType":8,"Body":581}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":583,"Flags":9,"Description":"The resource name"},"type":{"Type":584,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":585,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-09-01","ScopeType":8,"Body":586}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":588,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":589,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-09-01","ScopeType":8,"Body":590}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":592,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":593,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-09-01","ScopeType":8,"Body":594}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":596,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":597,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-09-01","ScopeType":8,"Body":598}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":600,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":601,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-09-01","ScopeType":8,"Body":602}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":604,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":605,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-09-01","ScopeType":8,"Body":606}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":608,"Flags":9,"Description":"The resource name"},"type":{"Type":609,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":610,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-09-01","ScopeType":8,"Body":611}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":613,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2020-09-01","ScopeType":8,"Body":616}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":618,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":619,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":621,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-09-01","ScopeType":8,"Body":620}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":623,"Flags":9,"Description":"The resource name"},"type":{"Type":624,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":625,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-09-01","ScopeType":8,"Body":626}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":628,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":629,"Flags":10,"Description":"The resource api version"},"properties":{"Type":631,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":632,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":633,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-09-01","ScopeType":8,"Body":630}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":635,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":636,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-09-01","ScopeType":8,"Body":637}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":639,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":640,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-09-01","ScopeType":8,"Body":641}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":643,"Flags":9,"Description":"The resource name"},"type":{"Type":644,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":645,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-09-01","ScopeType":8,"Body":646}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":659,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":654,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":658,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[655,656,657,4]}},{"3":{"ItemType":653}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-09-01","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-09-01","ScopeType":8,"Body":663}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":666,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-09-01","ScopeType":8,"Body":669}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-09-01","ScopeType":8,"Body":673}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-09-01","ScopeType":8,"Body":677}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":679,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":680,"Flags":10,"Description":"The resource api version"},"properties":{"Type":682,"Flags":0,"Description":"A static site."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":690,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":683,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":684,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":686,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":687,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":689,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":688}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-09-01","ScopeType":8,"Body":681}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":692,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"},"properties":{"Type":696,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-09-01","ScopeType":8,"Body":695}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":698,"Flags":9,"Description":"The resource name"},"type":{"Type":699,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":700,"Flags":10,"Description":"The resource api version"},"properties":{"Type":702,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-09-01","ScopeType":8,"Body":701}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-09-01","ScopeType":8,"Body":706}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":760,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":717,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":722,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":723,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":728,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":735,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":737,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":752,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":757,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":758,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":759,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[712,713,714,715,716]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[718,719,720,721]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web,Publishing"}},{"5":{"Elements":[724,725,726,727,4]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":733,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":734,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[730,731,732]}},{"3":{"ItemType":4}},{"3":{"ItemType":729}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":736}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":742,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":751,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[739,740,741]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[743,744,745,746,747,748,749,750]}},{"3":{"ItemType":738}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":756,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[754,755]}},{"3":{"ItemType":753}},{"3":{"ItemType":74}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-09-01","ScopeType":8,"Body":710}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":762,"Flags":9,"Description":"The resource name"},"type":{"Type":763,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":764,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-09-01","ScopeType":8,"Body":765}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":767,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":768,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-09-01","ScopeType":8,"Body":769}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":771,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":772,"Flags":10,"Description":"The resource api version"},"properties":{"Type":774,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":785,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":778,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":784,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[775,776,777]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[779,780,781,782,783]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-09-01","ScopeType":8,"Body":773}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-09-01","ScopeType":8,"Body":789}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-09-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":791,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":792,"Flags":10,"Description":"The resource api version"},"properties":{"Type":654,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-09-01","ScopeType":8,"Body":793}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":334,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":797,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":808,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":809,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[798,799,800,801,802,803,804,805,806,807]}},{"3":{"ItemType":339}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-09-01","Output":796,"Input":795}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":812,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-09-01","Output":811}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-09-01","Output":815}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":818,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":819,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-09-01","Output":817}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":822,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":796}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-09-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-09-01","Output":815}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-09-01","Output":796,"Input":795}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-09-01","Output":815}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-09-01","Output":817}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-09-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-09-01","Output":815}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":835,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":834,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":833}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-09-01","Output":832}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-09-01","Output":811}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-09-01","Output":811}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":841,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-09-01","Output":840}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2020-09-01/types.md b/generated/web/microsoft.web/2020-09-01/types.md index 95ee12b0ed..45dc9d4c32 100644 --- a/generated/web/microsoft.web/2020-09-01/types.md +++ b/generated/web/microsoft.web/2020-09-01/types.md @@ -912,48 +912,46 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2020-09-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (Required, WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AllowedAudiencesValidationProperties](#allowedaudiencesvalidationproperties): AllowedAudiencesValidation resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## HostingEnvironmentProfile +## AllowedAudiencesValidationProperties ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **allowedAudiences**: string[]: Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem -## SystemData +## ApiDefinitionInfo ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. +* **url**: string: The URL of the API definition. -## ResourceTags +## ApiManagementConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: APIM-Api Identifier. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppRegistration +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AppRegistrationProperties](#appregistrationproperties): AppRegistration resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. + +## AppRegistrationProperties +### Properties +* **appId**: string +* **appSecretSettingName**: string ## AppServiceEnvironment ### Properties @@ -972,7 +970,7 @@ This is valid for all deployment slots in an app. * **environmentStatus**: string (ReadOnly): Detailed message about with results of the last check of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool: Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web,Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web,Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **lastAction**: string (ReadOnly): Last deployment action on the App Service Environment. * **lastActionResult**: string (ReadOnly): Result of the last deployment action on the App Service Environment. @@ -999,96 +997,6 @@ This is valid for all deployment slots in an app. * **vnetSubnetName**: string: Subnet of the Virtual Network. * **workerPools**: [WorkerPool](#workerpool)[] (Required): Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## StampCapacity -### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. -Basic apps are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. -* **isLinux**: bool: Is this a linux stamp capacity -* **name**: string: Name of the stamp. -* **siteMode**: string: Shared or Dedicated. -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). -* **unit**: string: Name of the unit. -* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. -* **workerSizeId**: int: Size ID of machines: -0 - Small -1 - Medium -2 - Large - -## NetworkAccessControlEntry -### Properties -* **action**: 'Deny' | 'Permit': Action object. -* **description**: string: Description of network access control entry. -* **order**: int: Order of precedence. -* **remoteSubnet**: string: Remote subnet. - -## VirtualIPMapping -### Properties -* **internalHttpPort**: int: Internal HTTP port. -* **internalHttpsPort**: int: Internal HTTPS port. -* **inUse**: bool: Is virtual IP mapping in use. -* **serviceName**: string: name of the service that virtual IP is assigned to -* **virtualIP**: string: Virtual IP address. - -## VirtualNetworkProfile -### Properties -* **id**: string: Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -1112,509 +1020,448 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## AuthPlatform ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AuthPlatformProperties](#authplatformproperties): AuthPlatform resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## VnetRouteProperties +## AuthPlatformProperties ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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 +* **configFilePath**: string +* **enabled**: bool +* **runtimeVersion**: string -These values will be used for syncing an app's routes with those from a Virtual Network. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +## AutoHealActions +### Properties +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## ManagedServiceIdentity +## AutoHealCustomAction ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealRules ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoHealTriggers ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -## SiteProperties +## AzureActiveDirectory ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryProperties](#azureactivedirectoryproperties): AzureActiveDirectory resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## CloningInfo +## AzureActiveDirectoryLogin ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryLoginProperties](#azureactivedirectoryloginproperties): AzureActiveDirectoryLogin resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## CloningInfoAppSettingsOverrides +## AzureActiveDirectoryLoginProperties +### Properties +* **disableWWWAuthenticate**: bool +* **loginParameters**: string[]: Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem + +## AzureActiveDirectoryProperties +### Properties +* **enabled**: bool +* **isAutoProvisioned**: bool +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin) +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration) +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation) + +## AzureActiveDirectoryRegistration +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryRegistrationProperties](#azureactivedirectoryregistrationproperties): AzureActiveDirectoryRegistration resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. + +## AzureActiveDirectoryRegistrationProperties +### Properties +* **clientId**: string +* **clientSecretCertificateThumbprint**: string +* **clientSecretSettingName**: string +* **openIdIssuer**: string + +## AzureActiveDirectoryValidation +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryValidationProperties](#azureactivedirectoryvalidationproperties): AzureActiveDirectoryValidation resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. + +## AzureActiveDirectoryValidationProperties +### Properties +* **allowedAudiences**: string[]: Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks) + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureStorageInfoValue +### Properties +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. + +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## HostNameSslState +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## SiteConfig +## AzureTableStorageApplicationLogsConfig ### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## ApiDefinitionInfo +## BackupItem ### Properties -* **url**: string: The URL of the API definition. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## ApiManagementConfig +## BackupItem ### Properties -* **id**: string: APIM-Api Identifier. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## AutoHealRules +## BackupItemCollection ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealActions +## BackupItemCollection ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealCustomAction +## BackupItemProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## AutoHealTriggers +## BackupRequest ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly, WriteOnly): Resource type. -## RequestsBasedTrigger +## BackupRequest ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SlowRequestsBasedTrigger +## BackupRequestProperties ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## StatusCodesBasedTrigger +## BackupSchedule ### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## ConnStringInfo +## BlobStorageTokenStore ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BlobStorageTokenStoreProperties](#blobstoragetokenstoreproperties): BlobStorageTokenStore resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## CorsSettings +## BlobStorageTokenStoreProperties ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +* **sasUrlSettingName**: string -## Experiments +## Capability ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. -## RampUpRule +## CertificateProperties ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (Required, WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. -## HandlerMapping +## ClientRegistration ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [ClientRegistrationProperties](#clientregistrationproperties): ClientRegistration resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## IpSecurityRestriction +## ClientRegistrationProperties ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **clientId**: string +* **clientSecretSettingName**: string -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. +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## CloningInfoAppSettingsOverrides +### Properties +### Additional Properties +* **Additional Properties Type**: string -## IpSecurityRestrictionHeaders +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## ConnectionStringDictionaryProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string[] +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteLimits +## ConnectionStringDictionaryProperties ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteMachineKey +## ConnStringInfo ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. -## PushSettings +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CookieExpiration ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **properties**: [CookieExpirationProperties](#cookieexpirationproperties): CookieExpiration resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## PushSettingsProperties +## CookieExpirationProperties ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **convention**: 'FixedTime' | 'IdentityProviderDerived' +* **timeToExpiration**: string -## VirtualApplication +## CorsSettings ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## VirtualDirectory +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## SlotSwapStatus +## CustomOpenIdConnectProvider ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [CustomOpenIdConnectProviderProperties](#customopenidconnectproviderproperties): CustomOpenIdConnectProvider resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## CustomOpenIdConnectProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool +* **login**: [OpenIdConnectLogin](#openidconnectlogin) +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration) -## CsmPublishingCredentialsPoliciesEntityProperties +## DatabaseBackupSetting ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## StringDictionaryProperties +## DeploymentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## SiteAuthSettingsProperties +## EnabledConfig ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## SiteAuthSettingsV2Properties +## Experiments ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation) -* **httpSettings**: [HttpSettings](#httpsettings) -* **identityProviders**: [IdentityProviders](#identityproviders) -* **login**: [Login](#login) -* **platform**: [AuthPlatform](#authplatform) +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## GlobalValidation +## Facebook ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GlobalValidationProperties](#globalvalidationproperties): GlobalValidation resource specific properties +* **properties**: [FacebookProperties](#facebookproperties): Facebook resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## GlobalValidationProperties +## FacebookProperties ### Properties -* **excludedPaths**: string[]: Array of GlobalValidationPropertiesExcludedPathsItem -* **redirectToProvider**: string -* **requireAuthentication**: bool -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403' +* **enabled**: bool +* **graphApiVersion**: string +* **login**: [LoginScopes](#loginscopes) +* **registration**: [AppRegistration](#appregistration) -## HttpSettings +## FileSystemApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. + +## FileSystemTokenStore ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HttpSettingsProperties](#httpsettingsproperties): HttpSettings resource specific properties +* **properties**: [FileSystemTokenStoreProperties](#filesystemtokenstoreproperties): FileSystemTokenStore resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## HttpSettingsProperties +## FileSystemTokenStoreProperties ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy) -* **requireHttps**: bool -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes) +* **directory**: string ## ForwardProxy ### Properties @@ -1631,352 +1478,377 @@ application used for sign-in. * **customHostHeaderName**: string * **customProtoHeaderName**: string -## HttpSettingsRoutes +## FunctionEnvelopeProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HttpSettingsRoutesProperties](#httpsettingsroutesproperties): HttpSettingsRoutes resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. -## HttpSettingsRoutesProperties +## FunctionEnvelopePropertiesFiles ### Properties -* **apiPrefix**: string +### Additional Properties +* **Additional Properties Type**: string -## IdentityProviders +## FunctionSecrets ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [IdentityProvidersProperties](#identityprovidersproperties): IdentityProviders resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## IdentityProvidersProperties +## FunctionSecrets ### Properties -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory) -* **customOpenIdConnectProviders**: [IdentityProvidersPropertiesCustomOpenIdConnectProviders](#identityproviderspropertiescustomopenidconnectproviders): Dictionary of -* **facebook**: [Facebook](#facebook) -* **gitHub**: [GitHub](#github) -* **google**: [Google](#google) -* **twitter**: [Twitter](#twitter) +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## AzureActiveDirectory +## GitHub ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryProperties](#azureactivedirectoryproperties): AzureActiveDirectory resource specific properties +* **properties**: [GitHubProperties](#githubproperties): GitHub resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryProperties +## GitHubProperties ### Properties * **enabled**: bool -* **isAutoProvisioned**: bool -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin) -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration) -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation) +* **login**: [LoginScopes](#loginscopes) +* **registration**: [ClientRegistration](#clientregistration) -## AzureActiveDirectoryLogin +## GlobalValidation ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryLoginProperties](#azureactivedirectoryloginproperties): AzureActiveDirectoryLogin resource specific properties +* **properties**: [GlobalValidationProperties](#globalvalidationproperties): GlobalValidation resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryLoginProperties +## GlobalValidationProperties ### Properties -* **disableWWWAuthenticate**: bool -* **loginParameters**: string[]: Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem +* **excludedPaths**: string[]: Array of GlobalValidationPropertiesExcludedPathsItem +* **redirectToProvider**: string +* **requireAuthentication**: bool +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403' -## AzureActiveDirectoryRegistration +## Google ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryRegistrationProperties](#azureactivedirectoryregistrationproperties): AzureActiveDirectoryRegistration resource specific properties +* **properties**: [GoogleProperties](#googleproperties): Google resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryRegistrationProperties +## GoogleProperties ### Properties -* **clientId**: string -* **clientSecretCertificateThumbprint**: string -* **clientSecretSettingName**: string -* **openIdIssuer**: string +* **enabled**: bool +* **login**: [LoginScopes](#loginscopes) +* **registration**: [ClientRegistration](#clientregistration) +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation) -## AzureActiveDirectoryValidation +## HandlerMapping ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryValidationProperties](#azureactivedirectoryvalidationproperties): AzureActiveDirectoryValidation resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## AzureActiveDirectoryValidationProperties +## HostingEnvironmentProfile ### Properties -* **allowedAudiences**: string[]: Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks) +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## JwtClaimChecks +## HostKeys ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [JwtClaimChecksProperties](#jwtclaimchecksproperties): JwtClaimChecks resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## JwtClaimChecksProperties +## HostKeys ### Properties -* **allowedClientApplications**: string[]: Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem -* **allowedGroups**: string[]: Array of JwtClaimChecksPropertiesAllowedGroupsItem +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## IdentityProvidersPropertiesCustomOpenIdConnectProviders +## HostKeysFunctionKeys ### Properties ### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **Additional Properties Type**: string -## CustomOpenIdConnectProvider +## HostKeysSystemKeys ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [CustomOpenIdConnectProviderProperties](#customopenidconnectproviderproperties): CustomOpenIdConnectProvider resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## CustomOpenIdConnectProviderProperties +## HostNameBindingProperties ### Properties -* **enabled**: bool -* **login**: [OpenIdConnectLogin](#openidconnectlogin) -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration) +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## OpenIdConnectLogin +## HostNameSslState ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectLoginProperties](#openidconnectloginproperties): OpenIdConnectLogin resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## OpenIdConnectLoginProperties +## HttpLogsConfig ### Properties -* **nameClaimType**: string -* **scopes**: string[]: Array of OpenIdConnectLoginPropertiesScopesItem +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## OpenIdConnectRegistration +## HttpSettings ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectRegistrationProperties](#openidconnectregistrationproperties): OpenIdConnectRegistration resource specific properties +* **properties**: [HttpSettingsProperties](#httpsettingsproperties): HttpSettings resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## OpenIdConnectRegistrationProperties +## HttpSettingsProperties ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential) -* **clientId**: string -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig) +* **forwardProxy**: [ForwardProxy](#forwardproxy) +* **requireHttps**: bool +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes) -## OpenIdConnectClientCredential +## HttpSettingsRoutes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectClientCredentialProperties](#openidconnectclientcredentialproperties): OpenIdConnectClientCredential resource specific properties +* **properties**: [HttpSettingsRoutesProperties](#httpsettingsroutesproperties): HttpSettingsRoutes resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## OpenIdConnectClientCredentialProperties +## HttpSettingsRoutesProperties ### Properties -* **clientSecretSettingName**: string -* **method**: 'ClientSecretPost' +* **apiPrefix**: string -## OpenIdConnectConfig +## HybridConnectionKey ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectConfigProperties](#openidconnectconfigproperties): OpenIdConnectConfig resource specific properties +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## OpenIdConnectConfigProperties +## HybridConnectionKeyProperties ### Properties -* **authorizationEndpoint**: string -* **certificationUri**: string -* **issuer**: string -* **tokenEndpoint**: string -* **wellKnownOpenIdConfiguration**: string +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## Facebook +## HybridConnectionProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FacebookProperties](#facebookproperties): Facebook resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## FacebookProperties +## IdentifierProperties ### Properties -* **enabled**: bool -* **graphApiVersion**: string -* **login**: [LoginScopes](#loginscopes) -* **registration**: [AppRegistration](#appregistration) +* **id**: string: String representation of the identity. -## LoginScopes +## IdentityProviders ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginScopesProperties](#loginscopesproperties): LoginScopes resource specific properties +* **properties**: [IdentityProvidersProperties](#identityprovidersproperties): IdentityProviders resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## LoginScopesProperties +## IdentityProvidersProperties ### Properties -* **scopes**: string[]: Array of LoginScopesPropertiesScopesItem +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory) +* **customOpenIdConnectProviders**: [IdentityProvidersPropertiesCustomOpenIdConnectProviders](#identityproviderspropertiescustomopenidconnectproviders): Dictionary of +* **facebook**: [Facebook](#facebook) +* **gitHub**: [GitHub](#github) +* **google**: [Google](#google) +* **twitter**: [Twitter](#twitter) -## AppRegistration +## IdentityProvidersPropertiesCustomOpenIdConnectProviders ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AppRegistrationProperties](#appregistrationproperties): AppRegistration resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## AppRegistrationProperties +## IpSecurityRestriction ### Properties -* **appId**: string -* **appSecretSettingName**: string +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## GitHub -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [GitHubProperties](#githubproperties): GitHub resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +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. -## GitHubProperties +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **enabled**: bool -* **login**: [LoginScopes](#loginscopes) -* **registration**: [ClientRegistration](#clientregistration) +### Additional Properties +* **Additional Properties Type**: string[] -## ClientRegistration +## JwtClaimChecks ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [ClientRegistrationProperties](#clientregistrationproperties): ClientRegistration resource specific properties +* **properties**: [JwtClaimChecksProperties](#jwtclaimchecksproperties): JwtClaimChecks resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## ClientRegistrationProperties +## JwtClaimChecksProperties ### Properties -* **clientId**: string -* **clientSecretSettingName**: string +* **allowedClientApplications**: string[]: Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem +* **allowedGroups**: string[]: Array of JwtClaimChecksPropertiesAllowedGroupsItem -## Google +## Login ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GoogleProperties](#googleproperties): Google resource specific properties +* **properties**: [LoginProperties](#loginproperties): Login resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## GoogleProperties +## LoginProperties ### Properties -* **enabled**: bool -* **login**: [LoginScopes](#loginscopes) -* **registration**: [ClientRegistration](#clientregistration) -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation) +* **allowedExternalRedirectUrls**: string[]: Array of LoginPropertiesAllowedExternalRedirectUrlsItem +* **cookieExpiration**: [CookieExpiration](#cookieexpiration) +* **nonce**: [Nonce](#nonce) +* **preserveUrlFragmentsForLogins**: bool +* **routes**: [LoginRoutes](#loginroutes) +* **tokenStore**: [TokenStore](#tokenstore) -## AllowedAudiencesValidation +## LoginRoutes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AllowedAudiencesValidationProperties](#allowedaudiencesvalidationproperties): AllowedAudiencesValidation resource specific properties +* **properties**: [LoginRoutesProperties](#loginroutesproperties): LoginRoutes resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AllowedAudiencesValidationProperties +## LoginRoutesProperties ### Properties -* **allowedAudiences**: string[]: Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem +* **logoutEndpoint**: string -## Twitter +## LoginScopes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [TwitterProperties](#twitterproperties): Twitter resource specific properties +* **properties**: [LoginScopesProperties](#loginscopesproperties): LoginScopes resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## TwitterProperties +## LoginScopesProperties ### Properties -* **enabled**: bool -* **registration**: [TwitterRegistration](#twitterregistration) +* **scopes**: string[]: Array of LoginScopesPropertiesScopesItem -## TwitterRegistration +## ManagedServiceIdentity ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [TwitterRegistrationProperties](#twitterregistrationproperties): TwitterRegistration resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## TwitterRegistrationProperties +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **consumerKey**: string -* **consumerSecretSettingName**: string +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## Login +## MSDeployCore ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginProperties](#loginproperties): Login resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## LoginProperties +## MSDeployCoreSetParameters ### Properties -* **allowedExternalRedirectUrls**: string[]: Array of LoginPropertiesAllowedExternalRedirectUrlsItem -* **cookieExpiration**: [CookieExpiration](#cookieexpiration) -* **nonce**: [Nonce](#nonce) -* **preserveUrlFragmentsForLogins**: bool -* **routes**: [LoginRoutes](#loginroutes) -* **tokenStore**: [TokenStore](#tokenstore) +### Additional Properties +* **Additional Properties Type**: string -## CookieExpiration +## NameValuePair ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [CookieExpirationProperties](#cookieexpirationproperties): CookieExpiration resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Pair name. +* **value**: string: Pair value. -## CookieExpirationProperties +## NetworkAccessControlEntry ### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived' -* **timeToExpiration**: string +* **action**: 'Deny' | 'Permit': Action object. +* **description**: string: Description of network access control entry. +* **order**: int: Order of precedence. +* **remoteSubnet**: string: Remote subnet. ## Nonce ### Properties @@ -1992,265 +1864,141 @@ application used for sign-in. * **nonceExpirationInterval**: string * **validateNonce**: bool -## LoginRoutes -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginRoutesProperties](#loginroutesproperties): LoginRoutes resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. - -## LoginRoutesProperties -### Properties -* **logoutEndpoint**: string - -## TokenStore +## OpenIdConnectClientCredential ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [TokenStoreProperties](#tokenstoreproperties): TokenStore resource specific properties +* **properties**: [OpenIdConnectClientCredentialProperties](#openidconnectclientcredentialproperties): OpenIdConnectClientCredential resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## TokenStoreProperties +## OpenIdConnectClientCredentialProperties ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore) -* **enabled**: bool -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore) -* **tokenRefreshExtensionHours**: int +* **clientSecretSettingName**: string +* **method**: 'ClientSecretPost' -## BlobStorageTokenStore +## OpenIdConnectConfig ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BlobStorageTokenStoreProperties](#blobstoragetokenstoreproperties): BlobStorageTokenStore resource specific properties +* **properties**: [OpenIdConnectConfigProperties](#openidconnectconfigproperties): OpenIdConnectConfig resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## BlobStorageTokenStoreProperties +## OpenIdConnectConfigProperties ### Properties -* **sasUrlSettingName**: string +* **authorizationEndpoint**: string +* **certificationUri**: string +* **issuer**: string +* **tokenEndpoint**: string +* **wellKnownOpenIdConfiguration**: string -## FileSystemTokenStore +## OpenIdConnectLogin ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [FileSystemTokenStoreProperties](#filesystemtokenstoreproperties): FileSystemTokenStore resource specific properties +* **properties**: [OpenIdConnectLoginProperties](#openidconnectloginproperties): OpenIdConnectLogin resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## FileSystemTokenStoreProperties +## OpenIdConnectLoginProperties ### Properties -* **directory**: string +* **nameClaimType**: string +* **scopes**: string[]: Array of OpenIdConnectLoginPropertiesScopesItem -## AuthPlatform +## OpenIdConnectRegistration ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AuthPlatformProperties](#authplatformproperties): AuthPlatform resource specific properties +* **properties**: [OpenIdConnectRegistrationProperties](#openidconnectregistrationproperties): OpenIdConnectRegistration resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AuthPlatformProperties -### Properties -* **configFilePath**: string -* **enabled**: bool -* **runtimeVersion**: string - -## AzureStoragePropertyDictionaryResourceProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) - -## AzureStorageInfoValue -### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. - -## BackupRequestProperties -### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. - -## BackupSchedule -### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. - -## DatabaseBackupSetting -### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string - -## ConnectionStringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) - -## ConnStringValueTypePair -### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. - -## SiteLogsConfigProperties -### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. - -## ApplicationLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. - -## AzureBlobStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. - -## AzureTableStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. - -## FileSystemApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. - -## EnabledConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. - -## HttpLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. - -## AzureBlobStorageHttpLogsConfig +## OpenIdConnectRegistrationProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential) +* **clientId**: string +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig) -## FileSystemHttpLogsConfig +## PremierAddOnProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## StringDictionaryProperties +## PrivateAccessProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## SlotConfigNames +## PrivateAccessSubnet ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## DeploymentProperties +## PrivateAccessVirtualNetwork ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## IdentifierProperties +## PrivateLinkConnectionApprovalRequest ### Properties -* **id**: string: String representation of the identity. +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## MSDeployCore +## PrivateLinkConnectionState ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## MSDeployCoreSetParameters +## PublicCertificateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FunctionEnvelopeProperties +## PushSettings ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## FunctionEnvelopePropertiesFiles +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## HostNameBindingProperties +## RampUpRule ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. ## RelayServiceConnectionEntityProperties ### Properties @@ -2262,74 +2010,213 @@ Setting is false by default. * **resourceConnectionString**: string * **resourceType**: string -## HybridConnectionProperties +## RequestsBasedTrigger ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResourceTags ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessVirtualNetwork +## ResourceTags ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessSubnet +## ResourceTags ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkConnectionApprovalRequest +## ResourceTags ### Properties -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## ArmIdWrapper +## ResourceTags ### Properties -* **id**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string + +## SiteAuthSettingsProperties +### Properties +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PrivateLinkConnectionState +## SiteAuthSettingsV2Properties ### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection +* **globalValidation**: [GlobalValidation](#globalvalidation) +* **httpSettings**: [HttpSettings](#httpsettings) +* **identityProviders**: [IdentityProviders](#identityproviders) +* **login**: [Login](#login) +* **platform**: [AuthPlatform](#authplatform) -## PublicCertificateProperties +## SiteConfig ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id ## SiteExtensionInfoProperties ### Properties @@ -2354,35 +2241,73 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -2393,25 +2318,41 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties +## SkuCapacity ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **default**: int: Default number of workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## VnetRoute +## SkuDescription ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. + +## SlotConfigNames +### Properties +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. + +## SlotSwapStatus +### Properties +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. + +## SlowRequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2420,6 +2361,24 @@ Point-To-Site VPN connection. * **token**: string: OAuth access token. * **tokenSecret**: string: OAuth access token secret. +## StampCapacity +### Properties +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. +Basic apps are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. +* **isLinux**: bool: Is this a linux stamp capacity +* **name**: string: Name of the stamp. +* **siteMode**: string: Shared or Dedicated. +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). +* **unit**: string: Name of the unit. +* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. +* **workerSizeId**: int: Size ID of machines: +0 - Small +1 - Medium +2 - Large + ## StaticSite ### Properties * **branch**: string: The target branch in the repository. @@ -2435,56 +2394,44 @@ Point-To-Site VPN connection. * **appArtifactLocation**: string: The path of the app artifacts after building. * **appLocation**: string: The path to the app code within the repository. -## ResourceTags +## StaticSiteUserARMResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## BackupRequest +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2494,26 +2441,12 @@ Point-To-Site VPN connection. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. @@ -2526,16 +2459,6 @@ Point-To-Site VPN connection. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2563,98 +2486,175 @@ Point-To-Site VPN connection. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SwiftVirtualNetworkProperties +### Properties +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TokenStore ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **properties**: [TokenStoreProperties](#tokenstoreproperties): TokenStore resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKeyProperties +## TokenStoreProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore) +* **enabled**: bool +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore) +* **tokenRefreshExtensionHours**: int -## FunctionSecrets +## Twitter ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [TwitterProperties](#twitterproperties): Twitter resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## TwitterProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **enabled**: bool +* **registration**: [TwitterRegistration](#twitterregistration) -## StringDictionary +## TwitterRegistration ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: [TwitterRegistrationProperties](#twitterregistrationproperties): TwitterRegistration resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## TwitterRegistrationProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **consumerKey**: string +* **consumerSecretSettingName**: string -## FunctionSecrets +## UserProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. -## StaticSiteUserCollection +## VirtualApplication ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## StaticSiteUserARMResource +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualIPMapping +### Properties +* **internalHttpPort**: int: Internal HTTP port. +* **internalHttpsPort**: int: Internal HTTPS port. +* **inUse**: bool: Is virtual IP mapping in use. +* **serviceName**: string: name of the service that virtual IP is assigned to +* **virtualIP**: string: Virtual IP address. + +## VirtualNetworkProfile +### Properties +* **id**: string: Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2020-10-01/types.json b/generated/web/microsoft.web/2020-10-01/types.json index 3fccda6761..8fd7c906c3 100644 --- a/generated/web/microsoft.web/2020-10-01/types.json +++ b/generated/web/microsoft.web/2020-10-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":32,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":37,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[28,29,30,31]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[33,34,35,36]}},{"4":{"Name":"Microsoft.Web/certificates@2020-10-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":39,"Flags":9,"Description":"The resource name"},"type":{"Type":40,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":41,"Flags":10,"Description":"The resource api version"},"properties":{"Type":43,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-10-01","ScopeType":1,"Body":42}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-10-01","ScopeType":1,"Body":47}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":50,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":51,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":185,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":54,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":57,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":58,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":62,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":71,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":164,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":167,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":168,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":170,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":176,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[55,56]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[59,60,61]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":67,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":70,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[64,65,66]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[68,69]}},{"3":{"ItemType":63}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":73,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":75,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":89,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":90,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":92,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":107,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":110,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":114,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":120,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":121,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":124,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":125,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":137,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":139,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":141,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":142,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":150,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":151,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":155,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":159,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":163,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":74}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":88,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[77,78,79,80,81,82,83,84,85,86,87]}},{"3":{"ItemType":76}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":91}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[93,94,95,96,97,98,99,100,101,102,103,104,105,106]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[108,109]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":113,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":112}},{"3":{"ItemType":111}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[115,116,117,118,119]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":123,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":122}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":126,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":131,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":127,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":129,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":130,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":128}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":135,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":136,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[132,133,134]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":138,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":147,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":149,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[144,145,146]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":148}},{"3":{"ItemType":143}},{"3":{"ItemType":143}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[152,153,154]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[156,157,158]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[160,161,162]}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"5":{"Elements":[165,166]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":169,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[171,172,173,174,175]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":182,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":184,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[178,179,180,181]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":183}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-10-01","ScopeType":8,"Body":52}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":187,"Flags":9,"Description":"The resource name"},"type":{"Type":188,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":189,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":192,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":190,"scm":195}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-10-01","ScopeType":8,"Body":196}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":198,"Flags":9,"Description":"The resource name"},"type":{"Type":199,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":200,"Flags":10,"Description":"The resource api version"},"properties":{"Type":202,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":203,"Flags":9,"Description":"The resource name"},"type":{"Type":204,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":205,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":210,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":211,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":218,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":219,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":220,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":221,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":222,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":223,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":224,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[208,209]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[212,213,214,215,216,217]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":225,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":230,"Flags":0},"globalValidation":{"Type":232,"Flags":0},"identityProviders":{"Type":240,"Flags":0},"login":{"Type":289,"Flags":0},"httpSettings":{"Type":307,"Flags":0}}}},{"2":{"Name":"AuthPlatform","Properties":{"properties":{"Type":231,"Flags":0,"Description":"AuthPlatform resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AuthPlatformProperties","Properties":{"enabled":{"Type":2,"Flags":0},"runtimeVersion":{"Type":4,"Flags":0},"configFilePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalValidation","Properties":{"properties":{"Type":233,"Flags":0,"Description":"GlobalValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GlobalValidationProperties","Properties":{"requireAuthentication":{"Type":2,"Flags":0},"unauthenticatedClientAction":{"Type":238,"Flags":0},"redirectToProvider":{"Type":4,"Flags":0},"excludedPaths":{"Type":239,"Flags":0,"Description":"Array of GlobalValidationPropertiesExcludedPathsItem"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[234,235,236,237]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"properties":{"Type":241,"Flags":0,"Description":"IdentityProviders resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentityProvidersProperties","Properties":{"azureActiveDirectory":{"Type":242,"Flags":0},"facebook":{"Type":256,"Flags":0},"gitHub":{"Type":263,"Flags":0},"google":{"Type":267,"Flags":0},"twitter":{"Type":272,"Flags":0},"customOpenIdConnectProviders":{"Type":288,"Flags":0,"Description":"Dictionary of "}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"properties":{"Type":243,"Flags":0,"Description":"AzureActiveDirectory resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":244,"Flags":0},"login":{"Type":246,"Flags":0},"validation":{"Type":249,"Flags":0},"isAutoProvisioned":{"Type":2,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"properties":{"Type":245,"Flags":0,"Description":"AzureActiveDirectoryRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryRegistrationProperties","Properties":{"openIdIssuer":{"Type":4,"Flags":0},"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"properties":{"Type":247,"Flags":0,"Description":"AzureActiveDirectoryLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryLoginProperties","Properties":{"disableWWWAuthenticate":{"Type":2,"Flags":0},"loginParameters":{"Type":248,"Flags":0,"Description":"Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"properties":{"Type":250,"Flags":0,"Description":"AzureActiveDirectoryValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryValidationProperties","Properties":{"jwtClaimChecks":{"Type":251,"Flags":0},"allowedAudiences":{"Type":255,"Flags":0,"Description":"Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem"}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"properties":{"Type":252,"Flags":0,"Description":"JwtClaimChecks resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"JwtClaimChecksProperties","Properties":{"allowedGroups":{"Type":253,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedGroupsItem"},"allowedClientApplications":{"Type":254,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Facebook resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FacebookProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":258,"Flags":0},"graphApiVersion":{"Type":4,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"AppRegistration","Properties":{"properties":{"Type":259,"Flags":0,"Description":"AppRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppRegistrationProperties","Properties":{"appId":{"Type":4,"Flags":0},"appSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoginScopes","Properties":{"properties":{"Type":261,"Flags":0,"Description":"LoginScopes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginScopesProperties","Properties":{"scopes":{"Type":262,"Flags":0,"Description":"Array of LoginScopesPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"properties":{"Type":264,"Flags":0,"Description":"GitHub resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GitHubProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"ClientRegistration","Properties":{"properties":{"Type":266,"Flags":0,"Description":"ClientRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ClientRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Google","Properties":{"properties":{"Type":268,"Flags":0,"Description":"Google resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GoogleProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0},"validation":{"Type":269,"Flags":0}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"properties":{"Type":270,"Flags":0,"Description":"AllowedAudiencesValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AllowedAudiencesValidationProperties","Properties":{"allowedAudiences":{"Type":271,"Flags":0,"Description":"Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Twitter","Properties":{"properties":{"Type":273,"Flags":0,"Description":"Twitter resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":274,"Flags":0}}}},{"2":{"Name":"TwitterRegistration","Properties":{"properties":{"Type":275,"Flags":0,"Description":"TwitterRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterRegistrationProperties","Properties":{"consumerKey":{"Type":4,"Flags":0},"consumerSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"properties":{"Type":277,"Flags":0,"Description":"CustomOpenIdConnectProvider resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CustomOpenIdConnectProviderProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":278,"Flags":0},"login":{"Type":285,"Flags":0}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"properties":{"Type":279,"Flags":0,"Description":"OpenIdConnectRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientCredential":{"Type":280,"Flags":0},"openIdConnectConfiguration":{"Type":283,"Flags":0}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"properties":{"Type":281,"Flags":0,"Description":"OpenIdConnectClientCredential resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectClientCredentialProperties","Properties":{"method":{"Type":282,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"properties":{"Type":284,"Flags":0,"Description":"OpenIdConnectConfig resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectConfigProperties","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0},"tokenEndpoint":{"Type":4,"Flags":0},"issuer":{"Type":4,"Flags":0},"certificationUri":{"Type":4,"Flags":0},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"properties":{"Type":286,"Flags":0,"Description":"OpenIdConnectLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectLoginProperties","Properties":{"nameClaimType":{"Type":4,"Flags":0},"scopes":{"Type":287,"Flags":0,"Description":"Array of OpenIdConnectLoginPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersPropertiesCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":276}},{"2":{"Name":"Login","Properties":{"properties":{"Type":290,"Flags":0,"Description":"Login resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginProperties","Properties":{"routes":{"Type":291,"Flags":0},"tokenStore":{"Type":293,"Flags":0},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0},"allowedExternalRedirectUrls":{"Type":299,"Flags":0,"Description":"Array of LoginPropertiesAllowedExternalRedirectUrlsItem"},"cookieExpiration":{"Type":300,"Flags":0},"nonce":{"Type":305,"Flags":0}}}},{"2":{"Name":"LoginRoutes","Properties":{"properties":{"Type":292,"Flags":0,"Description":"LoginRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginRoutesProperties","Properties":{"logoutEndpoint":{"Type":4,"Flags":0}}}},{"2":{"Name":"TokenStore","Properties":{"properties":{"Type":294,"Flags":0,"Description":"TokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TokenStoreProperties","Properties":{"enabled":{"Type":2,"Flags":0},"tokenRefreshExtensionHours":{"Type":3,"Flags":0},"fileSystem":{"Type":295,"Flags":0},"azureBlobStorage":{"Type":297,"Flags":0}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"properties":{"Type":296,"Flags":0,"Description":"FileSystemTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FileSystemTokenStoreProperties","Properties":{"directory":{"Type":4,"Flags":0}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"properties":{"Type":298,"Flags":0,"Description":"BlobStorageTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BlobStorageTokenStoreProperties","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"properties":{"Type":301,"Flags":0,"Description":"CookieExpiration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CookieExpirationProperties","Properties":{"convention":{"Type":304,"Flags":0},"timeToExpiration":{"Type":4,"Flags":0}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[302,303]}},{"2":{"Name":"Nonce","Properties":{"properties":{"Type":306,"Flags":0,"Description":"Nonce resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"NonceProperties","Properties":{"validateNonce":{"Type":2,"Flags":0},"nonceExpirationInterval":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpSettings","Properties":{"properties":{"Type":308,"Flags":0,"Description":"HttpSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsProperties","Properties":{"requireHttps":{"Type":2,"Flags":0},"routes":{"Type":309,"Flags":0},"forwardProxy":{"Type":311,"Flags":0}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"properties":{"Type":310,"Flags":0,"Description":"HttpSettingsRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsRoutesProperties","Properties":{"apiPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardProxy","Properties":{"properties":{"Type":312,"Flags":0,"Description":"ForwardProxy resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ForwardProxyProperties","Properties":{"convention":{"Type":316,"Flags":0},"customHostHeaderName":{"Type":4,"Flags":0},"customProtoHeaderName":{"Type":4,"Flags":0}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[313,314,315]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":317,"Flags":9,"Description":"The resource name"},"type":{"Type":318,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":319,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":324,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":328,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[322,323]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[325,326,327]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":330,"Flags":9,"Description":"The resource name"},"type":{"Type":331,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":332,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":335,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":345,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":338,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[336,337]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":344,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[340,341,342,343]}},{"3":{"ItemType":339}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":346,"Flags":9,"Description":"The resource name"},"type":{"Type":347,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":348,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":362,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[351,352,353,354,355,356,357,358,359,360,361]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":369,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":391,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":394,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":394,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":370,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":377,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":384,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":376,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[371,372,373,374,375]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":383,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[378,379,380,381,382]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":390,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[385,386,387,388,389]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":392,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":393,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":395,"Flags":9,"Description":"The resource name"},"type":{"Type":396,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":397,"Flags":10,"Description":"The resource api version"},"properties":{"Type":399,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":400,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":404,"Flags":9,"Description":"The resource name"},"type":{"Type":405,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":406,"Flags":10,"Description":"The resource api version"},"properties":{"Type":408,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":409,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":410,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":411,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":412,"Flags":9,"Description":"The resource name"},"type":{"Type":413,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":414,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":201,"authsettings":206,"authsettingsV2":228,"azurestorageaccounts":320,"backup":333,"connectionstrings":349,"logs":367,"metadata":398,"pushsettings":403,"slotConfigNames":407,"web":415}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-10-01","ScopeType":8,"Body":416}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":418,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":419,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-10-01","ScopeType":8,"Body":420}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":423,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":424,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-10-01","ScopeType":8,"Body":425}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":433,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":439,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[434,435,436,437,438]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-10-01","ScopeType":8,"Body":431}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":441,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":442,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":445,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-10-01","ScopeType":8,"Body":443}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-10-01","ScopeType":8,"Body":449}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":457,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":460,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":463,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":467,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[455,456]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[458,459]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[461,462]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[464,465,466]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-10-01","ScopeType":8,"Body":453}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-10-01","ScopeType":8,"Body":471}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":474,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":475,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-10-01","ScopeType":8,"Body":476}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":479,"Flags":9,"Description":"The resource name"},"type":{"Type":480,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":481,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-10-01","ScopeType":8,"Body":482}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":484,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-10-01","ScopeType":8,"Body":487}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":494,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-10-01","ScopeType":8,"Body":492}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":496,"Flags":9,"Description":"The resource name"},"type":{"Type":497,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":498,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":504,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":503,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":502}},{"3":{"ItemType":501}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-10-01","ScopeType":8,"Body":499}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":506,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":507,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":513,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[510,511,512]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-10-01","ScopeType":8,"Body":508}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":515,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":516,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":521,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":522,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[519,520]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-10-01","ScopeType":8,"Body":517}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":524,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":525,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":527,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-10-01","ScopeType":8,"Body":526}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":529,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":534,"Flags":9,"Description":"The resource name"},"type":{"Type":535,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":536,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":538,"Flags":9,"Description":"The resource name"},"type":{"Type":539,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":540,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":542,"Flags":9,"Description":"The resource name"},"type":{"Type":543,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":544,"Flags":10,"Description":"The resource api version"},"properties":{"Type":546,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":551,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":555,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":560,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":565,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":569,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":532,"authsettings":537,"authsettingsV2":541,"azurestorageaccounts":545,"backup":550,"connectionstrings":554,"logs":559,"metadata":563,"pushsettings":568,"web":572}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-10-01","ScopeType":8,"Body":573}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":575,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":576,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-10-01","ScopeType":8,"Body":577}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":579,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":580,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-10-01","ScopeType":8,"Body":581}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":583,"Flags":9,"Description":"The resource name"},"type":{"Type":584,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":585,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-10-01","ScopeType":8,"Body":586}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":588,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":589,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-10-01","ScopeType":8,"Body":590}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":592,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":593,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-10-01","ScopeType":8,"Body":594}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":596,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":597,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-10-01","ScopeType":8,"Body":598}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":600,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":601,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-10-01","ScopeType":8,"Body":602}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":604,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":605,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-10-01","ScopeType":8,"Body":606}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":608,"Flags":9,"Description":"The resource name"},"type":{"Type":609,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":610,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-10-01","ScopeType":8,"Body":611}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":613,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2020-10-01","ScopeType":8,"Body":616}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":618,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":619,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":621,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-10-01","ScopeType":8,"Body":620}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":623,"Flags":9,"Description":"The resource name"},"type":{"Type":624,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":625,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-10-01","ScopeType":8,"Body":626}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":628,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":629,"Flags":10,"Description":"The resource api version"},"properties":{"Type":631,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":632,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":633,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-10-01","ScopeType":8,"Body":630}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":635,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":636,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-10-01","ScopeType":8,"Body":637}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":639,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":640,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-10-01","ScopeType":8,"Body":641}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":643,"Flags":9,"Description":"The resource name"},"type":{"Type":644,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":645,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-10-01","ScopeType":8,"Body":646}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":659,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":654,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":658,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[655,656,657]}},{"3":{"ItemType":653}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-10-01","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-10-01","ScopeType":8,"Body":663}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":666,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-10-01","ScopeType":8,"Body":669}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-10-01","ScopeType":8,"Body":673}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-10-01","ScopeType":8,"Body":677}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":679,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":680,"Flags":10,"Description":"The resource api version"},"properties":{"Type":682,"Flags":0,"Description":"A static site."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":690,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":683,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":684,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":686,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":687,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":689,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":688}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-10-01","ScopeType":8,"Body":681}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":692,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"},"properties":{"Type":696,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-10-01","ScopeType":8,"Body":695}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":698,"Flags":9,"Description":"The resource name"},"type":{"Type":699,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":700,"Flags":10,"Description":"The resource api version"},"properties":{"Type":702,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-10-01","ScopeType":8,"Body":701}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-10-01","ScopeType":8,"Body":706}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":760,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":717,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":722,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":723,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":728,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":735,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":737,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":752,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":757,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":758,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":759,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[712,713,714,715,716]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[718,719,720,721]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web,Publishing"}},{"5":{"Elements":[724,725,726,727]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":733,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":734,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[730,731,732]}},{"3":{"ItemType":4}},{"3":{"ItemType":729}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":736}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":742,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":751,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[739,740,741]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[743,744,745,746,747,748,749,750]}},{"3":{"ItemType":738}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":756,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[754,755]}},{"3":{"ItemType":753}},{"3":{"ItemType":74}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-10-01","ScopeType":8,"Body":710}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":762,"Flags":9,"Description":"The resource name"},"type":{"Type":763,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":764,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-10-01","ScopeType":8,"Body":765}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":767,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":768,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-10-01","ScopeType":8,"Body":769}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":771,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":772,"Flags":10,"Description":"The resource api version"},"properties":{"Type":774,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":785,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":778,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":784,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[775,776,777]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[779,780,781,782,783]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-10-01","ScopeType":8,"Body":773}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-10-01","ScopeType":8,"Body":789}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":791,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":792,"Flags":10,"Description":"The resource api version"},"properties":{"Type":654,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-10-01","ScopeType":8,"Body":793}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":334,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":797,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":808,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":809,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[798,799,800,801,802,803,804,805,806,807]}},{"3":{"ItemType":339}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-10-01","Output":796,"Input":795}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":812,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-10-01","Output":811}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-10-01","Output":815}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":818,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":819,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-10-01","Output":817}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":822,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":796}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-10-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-10-01","Output":815}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-10-01","Output":796,"Input":795}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-10-01","Output":815}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-10-01","Output":817}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-10-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-10-01","Output":815}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":835,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":834,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":833}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-10-01","Output":832}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-10-01","Output":811}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":841,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-10-01","Output":840}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CertificateProperties","Properties":{"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"password":{"Type":4,"Flags":5,"Description":"Certificate password."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SystemData","Properties":{"createdBy":{"Type":4,"Flags":0,"Description":"The identity that created the resource."},"createdByType":{"Type":32,"Flags":0,"Description":"The type of identity that created the resource."},"createdAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource creation (UTC)."},"lastModifiedBy":{"Type":4,"Flags":0,"Description":"The identity that last modified the resource."},"lastModifiedByType":{"Type":37,"Flags":0,"Description":"The type of identity that created the resource."},"lastModifiedAt":{"Type":4,"Flags":0,"Description":"The timestamp of resource last modification (UTC)"}}}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[28,29,30,31,4]}},{"6":{"Value":"User"}},{"6":{"Value":"Application"}},{"6":{"Value":"ManagedIdentity"}},{"6":{"Value":"Key"}},{"5":{"Elements":[33,34,35,36,4]}},{"4":{"Name":"Microsoft.Web/certificates@2020-10-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":39,"Flags":9,"Description":"The resource name"},"type":{"Type":40,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":41,"Flags":10,"Description":"The resource api version"},"properties":{"Type":43,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-10-01","ScopeType":1,"Body":42}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-10-01","ScopeType":1,"Body":47}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":50,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":51,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":185,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":54,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":57,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":58,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":62,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":71,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":164,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":167,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":168,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":170,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":176,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[55,56]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[59,60,61]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":67,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":70,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[64,65,66]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[68,69]}},{"3":{"ItemType":63}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":73,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":75,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":89,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":90,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":92,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":107,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":110,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":114,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":120,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":121,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":124,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":125,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":137,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":139,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":141,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":142,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"ipSecurityRestrictions":{"Type":150,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":151,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":155,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":159,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":163,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":74}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":88,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[77,78,79,80,81,82,83,84,85,86,87]}},{"3":{"ItemType":76}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":91}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[93,94,95,96,97,98,99,100,101,102,103,104,105,106,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[108,109]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":113,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":112}},{"3":{"ItemType":111}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"5":{"Elements":[115,116,117,118,119]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":123,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":122}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":126,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":131,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":127,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":129,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":130,"Flags":0,"Description":"Trigger based on request execution time."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":128}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":135,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":136,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[132,133,134]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":138,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":147,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":149,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[144,145,146,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":148}},{"3":{"ItemType":143}},{"3":{"ItemType":143}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[152,153,154,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[156,157,158,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[160,161,162,4]}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"5":{"Elements":[165,166]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":169,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[171,172,173,174,175]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":182,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":184,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[178,179,180,181]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":183}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-10-01","ScopeType":8,"Body":52}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":187,"Flags":9,"Description":"The resource name"},"type":{"Type":188,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":189,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":192,"Flags":9,"Description":"The resource name"},"type":{"Type":193,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":194,"Flags":10,"Description":"The resource api version"},"properties":{"Type":191,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":190,"scm":195}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-10-01","ScopeType":8,"Body":196}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":198,"Flags":9,"Description":"The resource name"},"type":{"Type":199,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":200,"Flags":10,"Description":"The resource api version"},"properties":{"Type":202,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":203,"Flags":9,"Description":"The resource name"},"type":{"Type":204,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":205,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":210,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":211,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":218,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":219,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":220,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":221,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":222,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":223,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":224,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[208,209]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[212,213,214,215,216,217]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":225,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":230,"Flags":0},"globalValidation":{"Type":232,"Flags":0},"identityProviders":{"Type":240,"Flags":0},"login":{"Type":289,"Flags":0},"httpSettings":{"Type":307,"Flags":0}}}},{"2":{"Name":"AuthPlatform","Properties":{"properties":{"Type":231,"Flags":0,"Description":"AuthPlatform resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AuthPlatformProperties","Properties":{"enabled":{"Type":2,"Flags":0},"runtimeVersion":{"Type":4,"Flags":0},"configFilePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalValidation","Properties":{"properties":{"Type":233,"Flags":0,"Description":"GlobalValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GlobalValidationProperties","Properties":{"requireAuthentication":{"Type":2,"Flags":0},"unauthenticatedClientAction":{"Type":238,"Flags":0},"redirectToProvider":{"Type":4,"Flags":0},"excludedPaths":{"Type":239,"Flags":0,"Description":"Array of GlobalValidationPropertiesExcludedPathsItem"}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[234,235,236,237]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"properties":{"Type":241,"Flags":0,"Description":"IdentityProviders resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentityProvidersProperties","Properties":{"azureActiveDirectory":{"Type":242,"Flags":0},"facebook":{"Type":256,"Flags":0},"gitHub":{"Type":263,"Flags":0},"google":{"Type":267,"Flags":0},"twitter":{"Type":272,"Flags":0},"customOpenIdConnectProviders":{"Type":288,"Flags":0,"Description":"Dictionary of "}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"properties":{"Type":243,"Flags":0,"Description":"AzureActiveDirectory resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":244,"Flags":0},"login":{"Type":246,"Flags":0},"validation":{"Type":249,"Flags":0},"isAutoProvisioned":{"Type":2,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"properties":{"Type":245,"Flags":0,"Description":"AzureActiveDirectoryRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryRegistrationProperties","Properties":{"openIdIssuer":{"Type":4,"Flags":0},"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"properties":{"Type":247,"Flags":0,"Description":"AzureActiveDirectoryLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryLoginProperties","Properties":{"disableWWWAuthenticate":{"Type":2,"Flags":0},"loginParameters":{"Type":248,"Flags":0,"Description":"Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"properties":{"Type":250,"Flags":0,"Description":"AzureActiveDirectoryValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureActiveDirectoryValidationProperties","Properties":{"jwtClaimChecks":{"Type":251,"Flags":0},"allowedAudiences":{"Type":255,"Flags":0,"Description":"Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem"}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"properties":{"Type":252,"Flags":0,"Description":"JwtClaimChecks resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"JwtClaimChecksProperties","Properties":{"allowedGroups":{"Type":253,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedGroupsItem"},"allowedClientApplications":{"Type":254,"Flags":0,"Description":"Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"properties":{"Type":257,"Flags":0,"Description":"Facebook resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FacebookProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":258,"Flags":0},"graphApiVersion":{"Type":4,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"AppRegistration","Properties":{"properties":{"Type":259,"Flags":0,"Description":"AppRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppRegistrationProperties","Properties":{"appId":{"Type":4,"Flags":0},"appSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoginScopes","Properties":{"properties":{"Type":261,"Flags":0,"Description":"LoginScopes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginScopesProperties","Properties":{"scopes":{"Type":262,"Flags":0,"Description":"Array of LoginScopesPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"properties":{"Type":264,"Flags":0,"Description":"GitHub resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GitHubProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0}}}},{"2":{"Name":"ClientRegistration","Properties":{"properties":{"Type":266,"Flags":0,"Description":"ClientRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ClientRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Google","Properties":{"properties":{"Type":268,"Flags":0,"Description":"Google resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"GoogleProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":265,"Flags":0},"login":{"Type":260,"Flags":0},"validation":{"Type":269,"Flags":0}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"properties":{"Type":270,"Flags":0,"Description":"AllowedAudiencesValidation resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AllowedAudiencesValidationProperties","Properties":{"allowedAudiences":{"Type":271,"Flags":0,"Description":"Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Twitter","Properties":{"properties":{"Type":273,"Flags":0,"Description":"Twitter resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":274,"Flags":0}}}},{"2":{"Name":"TwitterRegistration","Properties":{"properties":{"Type":275,"Flags":0,"Description":"TwitterRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TwitterRegistrationProperties","Properties":{"consumerKey":{"Type":4,"Flags":0},"consumerSecretSettingName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"properties":{"Type":277,"Flags":0,"Description":"CustomOpenIdConnectProvider resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CustomOpenIdConnectProviderProperties","Properties":{"enabled":{"Type":2,"Flags":0},"registration":{"Type":278,"Flags":0},"login":{"Type":285,"Flags":0}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"properties":{"Type":279,"Flags":0,"Description":"OpenIdConnectRegistration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectRegistrationProperties","Properties":{"clientId":{"Type":4,"Flags":0},"clientCredential":{"Type":280,"Flags":0},"openIdConnectConfiguration":{"Type":283,"Flags":0}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"properties":{"Type":281,"Flags":0,"Description":"OpenIdConnectClientCredential resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectClientCredentialProperties","Properties":{"method":{"Type":282,"Flags":0},"clientSecretSettingName":{"Type":4,"Flags":0}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"properties":{"Type":284,"Flags":0,"Description":"OpenIdConnectConfig resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectConfigProperties","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0},"tokenEndpoint":{"Type":4,"Flags":0},"issuer":{"Type":4,"Flags":0},"certificationUri":{"Type":4,"Flags":0},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"properties":{"Type":286,"Flags":0,"Description":"OpenIdConnectLogin resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"OpenIdConnectLoginProperties","Properties":{"nameClaimType":{"Type":4,"Flags":0},"scopes":{"Type":287,"Flags":0,"Description":"Array of OpenIdConnectLoginPropertiesScopesItem"}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersPropertiesCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":276}},{"2":{"Name":"Login","Properties":{"properties":{"Type":290,"Flags":0,"Description":"Login resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginProperties","Properties":{"routes":{"Type":291,"Flags":0},"tokenStore":{"Type":293,"Flags":0},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0},"allowedExternalRedirectUrls":{"Type":299,"Flags":0,"Description":"Array of LoginPropertiesAllowedExternalRedirectUrlsItem"},"cookieExpiration":{"Type":300,"Flags":0},"nonce":{"Type":305,"Flags":0}}}},{"2":{"Name":"LoginRoutes","Properties":{"properties":{"Type":292,"Flags":0,"Description":"LoginRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"LoginRoutesProperties","Properties":{"logoutEndpoint":{"Type":4,"Flags":0}}}},{"2":{"Name":"TokenStore","Properties":{"properties":{"Type":294,"Flags":0,"Description":"TokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"TokenStoreProperties","Properties":{"enabled":{"Type":2,"Flags":0},"tokenRefreshExtensionHours":{"Type":3,"Flags":0},"fileSystem":{"Type":295,"Flags":0},"azureBlobStorage":{"Type":297,"Flags":0}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"properties":{"Type":296,"Flags":0,"Description":"FileSystemTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FileSystemTokenStoreProperties","Properties":{"directory":{"Type":4,"Flags":0}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"properties":{"Type":298,"Flags":0,"Description":"BlobStorageTokenStore resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BlobStorageTokenStoreProperties","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"properties":{"Type":301,"Flags":0,"Description":"CookieExpiration resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"CookieExpirationProperties","Properties":{"convention":{"Type":304,"Flags":0},"timeToExpiration":{"Type":4,"Flags":0}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[302,303]}},{"2":{"Name":"Nonce","Properties":{"properties":{"Type":306,"Flags":0,"Description":"Nonce resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"NonceProperties","Properties":{"validateNonce":{"Type":2,"Flags":0},"nonceExpirationInterval":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpSettings","Properties":{"properties":{"Type":308,"Flags":0,"Description":"HttpSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsProperties","Properties":{"requireHttps":{"Type":2,"Flags":0},"routes":{"Type":309,"Flags":0},"forwardProxy":{"Type":311,"Flags":0}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"properties":{"Type":310,"Flags":0,"Description":"HttpSettingsRoutes resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HttpSettingsRoutesProperties","Properties":{"apiPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardProxy","Properties":{"properties":{"Type":312,"Flags":0,"Description":"ForwardProxy resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ForwardProxyProperties","Properties":{"convention":{"Type":316,"Flags":0},"customHostHeaderName":{"Type":4,"Flags":0},"customProtoHeaderName":{"Type":4,"Flags":0}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[313,314,315]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":317,"Flags":9,"Description":"The resource name"},"type":{"Type":318,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":319,"Flags":10,"Description":"The resource api version"},"properties":{"Type":329,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":324,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":328,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[322,323]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"5":{"Elements":[325,326,327]}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":330,"Flags":9,"Description":"The resource name"},"type":{"Type":331,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":332,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":335,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":345,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":338,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[336,337]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":344,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[340,341,342,343,4]}},{"3":{"ItemType":339}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":346,"Flags":9,"Description":"The resource name"},"type":{"Type":347,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":348,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":362,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[351,352,353,354,355,356,357,358,359,360,361]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":369,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":391,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":394,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":394,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":370,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":377,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":384,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":376,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[371,372,373,374,375]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":383,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[378,379,380,381,382]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":390,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[385,386,387,388,389]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":392,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":393,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":395,"Flags":9,"Description":"The resource name"},"type":{"Type":396,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":397,"Flags":10,"Description":"The resource api version"},"properties":{"Type":399,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":400,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":404,"Flags":9,"Description":"The resource name"},"type":{"Type":405,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":406,"Flags":10,"Description":"The resource api version"},"properties":{"Type":408,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":409,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":410,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":411,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":412,"Flags":9,"Description":"The resource name"},"type":{"Type":413,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":414,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":201,"authsettings":206,"authsettingsV2":228,"azurestorageaccounts":320,"backup":333,"connectionstrings":349,"logs":367,"metadata":398,"pushsettings":403,"slotConfigNames":407,"web":415}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-10-01","ScopeType":8,"Body":416}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":418,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":419,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-10-01","ScopeType":8,"Body":420}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":423,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":424,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-10-01","ScopeType":8,"Body":425}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":428,"Flags":9,"Description":"The resource name"},"type":{"Type":429,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":430,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":433,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":439,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[434,435,436,437,438]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-10-01","ScopeType":8,"Body":431}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":441,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":442,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":445,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-10-01","ScopeType":8,"Body":443}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-10-01","ScopeType":8,"Body":449}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":451,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":452,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":457,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":460,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":463,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":467,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[455,456]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[458,459]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[461,462]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[464,465,466]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-10-01","ScopeType":8,"Body":453}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":469,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":470,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-10-01","ScopeType":8,"Body":471}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":474,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":475,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-10-01","ScopeType":8,"Body":476}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":479,"Flags":9,"Description":"The resource name"},"type":{"Type":480,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":481,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-10-01","ScopeType":8,"Body":482}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":484,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-10-01","ScopeType":8,"Body":487}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":494,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-10-01","ScopeType":8,"Body":492}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":496,"Flags":9,"Description":"The resource name"},"type":{"Type":497,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":498,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":504,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":503,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":502}},{"3":{"ItemType":501}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-10-01","ScopeType":8,"Body":499}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":506,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":507,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":513,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[510,511,512]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-10-01","ScopeType":8,"Body":508}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":515,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":516,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":521,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":522,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[519,520]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-10-01","ScopeType":8,"Body":517}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":524,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":525,"Flags":10,"Description":"The resource api version"},"properties":{"Type":53,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":177,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":527,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-10-01","ScopeType":8,"Body":526}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":529,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":534,"Flags":9,"Description":"The resource name"},"type":{"Type":535,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":536,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":538,"Flags":9,"Description":"The resource name"},"type":{"Type":539,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":540,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":542,"Flags":9,"Description":"The resource name"},"type":{"Type":543,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":544,"Flags":10,"Description":"The resource api version"},"properties":{"Type":546,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":321}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":334,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":551,"Flags":9,"Description":"The resource name"},"type":{"Type":552,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":553,"Flags":10,"Description":"The resource api version"},"properties":{"Type":555,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":350}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":560,"Flags":9,"Description":"The resource name"},"type":{"Type":561,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":562,"Flags":10,"Description":"The resource api version"},"properties":{"Type":564,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":565,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":140,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":569,"Flags":9,"Description":"The resource name"},"type":{"Type":570,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":571,"Flags":10,"Description":"The resource api version"},"properties":{"Type":72,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":532,"authsettings":537,"authsettingsV2":541,"azurestorageaccounts":545,"backup":550,"connectionstrings":554,"logs":559,"metadata":563,"pushsettings":568,"web":572}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-10-01","ScopeType":8,"Body":573}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":575,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":576,"Flags":10,"Description":"The resource api version"},"properties":{"Type":421,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-10-01","ScopeType":8,"Body":577}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":579,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":580,"Flags":10,"Description":"The resource api version"},"properties":{"Type":426,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-10-01","ScopeType":8,"Body":581}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":583,"Flags":9,"Description":"The resource name"},"type":{"Type":584,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":585,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-10-01","ScopeType":8,"Body":586}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":588,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":589,"Flags":10,"Description":"The resource api version"},"properties":{"Type":444,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-10-01","ScopeType":8,"Body":590}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":592,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":593,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-10-01","ScopeType":8,"Body":594}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":596,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":597,"Flags":10,"Description":"The resource api version"},"properties":{"Type":454,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-10-01","ScopeType":8,"Body":598}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":600,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":601,"Flags":10,"Description":"The resource api version"},"properties":{"Type":472,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-10-01","ScopeType":8,"Body":602}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":604,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":605,"Flags":10,"Description":"The resource api version"},"properties":{"Type":477,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-10-01","ScopeType":8,"Body":606}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":608,"Flags":9,"Description":"The resource name"},"type":{"Type":609,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":610,"Flags":10,"Description":"The resource api version"},"properties":{"Type":432,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-10-01","ScopeType":8,"Body":611}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":613,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2020-10-01","ScopeType":8,"Body":616}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":618,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":619,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":621,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-10-01","ScopeType":8,"Body":620}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":623,"Flags":9,"Description":"The resource name"},"type":{"Type":624,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":625,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-10-01","ScopeType":8,"Body":626}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":628,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":629,"Flags":10,"Description":"The resource api version"},"properties":{"Type":631,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":632,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":633,"Flags":2,"Description":"A wrapper for an ARM resource id"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-10-01","ScopeType":8,"Body":630}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":635,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":636,"Flags":10,"Description":"The resource api version"},"properties":{"Type":509,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-10-01","ScopeType":8,"Body":637}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":639,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":640,"Flags":10,"Description":"The resource api version"},"properties":{"Type":518,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-10-01","ScopeType":8,"Body":641}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":643,"Flags":9,"Description":"The resource name"},"type":{"Type":644,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":645,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-10-01","ScopeType":8,"Body":646}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":659,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":654,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":658,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[655,656,657,4]}},{"3":{"ItemType":653}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-10-01","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-10-01","ScopeType":8,"Body":663}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":666,"Flags":9,"Description":"The resource name"},"type":{"Type":667,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":668,"Flags":10,"Description":"The resource api version"},"properties":{"Type":647,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-10-01","ScopeType":8,"Body":669}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-10-01","ScopeType":8,"Body":673}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-10-01","ScopeType":8,"Body":677}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":679,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":680,"Flags":10,"Description":"The resource api version"},"properties":{"Type":682,"Flags":0,"Description":"A static site."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":690,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":683,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":684,"Flags":0,"Description":"Build properties for the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"The path of the app artifacts after building."}}}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":686,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":687,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":689,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":688}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-10-01","ScopeType":8,"Body":681}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":692,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"},"properties":{"Type":696,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-10-01","ScopeType":8,"Body":695}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":698,"Flags":9,"Description":"The resource name"},"type":{"Type":699,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":700,"Flags":10,"Description":"The resource api version"},"properties":{"Type":702,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-10-01","ScopeType":8,"Body":701}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"}}}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-10-01","ScopeType":8,"Body":706}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":760,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"name":{"Type":4,"Flags":1,"Description":"Name of the App Service Environment."},"location":{"Type":4,"Flags":1,"Description":"Location of the App Service Environment, e.g. \"West US\"."},"provisioningState":{"Type":717,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":722,"Flags":2,"Description":"Current status of the App Service Environment."},"vnetName":{"Type":4,"Flags":0,"Description":"Name of the Virtual Network for the App Service Environment."},"vnetResourceGroupName":{"Type":4,"Flags":0,"Description":"Resource group of the Virtual Network."},"vnetSubnetName":{"Type":4,"Flags":0,"Description":"Subnet of the Virtual Network."},"virtualNetwork":{"Type":723,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":728,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":0,"Description":"Number of front-end instances."},"workerPools":{"Type":735,"Flags":1,"Description":"Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"databaseEdition":{"Type":4,"Flags":2,"Description":"Edition of the metadata database for the App Service Environment, e.g. \"Standard\"."},"databaseServiceObjective":{"Type":4,"Flags":2,"Description":"Service objective of the metadata database for the App Service Environment, e.g. \"S0\"."},"upgradeDomains":{"Type":3,"Flags":2,"Description":"Number of upgrade domains of the App Service Environment."},"subscriptionId":{"Type":4,"Flags":2,"Description":"Subscription of the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"lastAction":{"Type":4,"Flags":2,"Description":"Last deployment action on the App Service Environment."},"lastActionResult":{"Type":4,"Flags":2,"Description":"Result of the last deployment action on the App Service Environment."},"allowedMultiSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for front-ends."},"allowedWorkerSizes":{"Type":4,"Flags":2,"Description":"List of comma separated strings describing which VM sizes are allowed for workers."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"vipMappings":{"Type":737,"Flags":2,"Description":"Description of IP SSL mapping for the App Service Environment."},"environmentCapacities":{"Type":752,"Flags":2,"Description":"Current total, used, and available worker capacities."},"networkAccessControlList":{"Type":757,"Flags":0,"Description":"Access control list for controlling traffic to the App Service Environment."},"environmentIsHealthy":{"Type":2,"Flags":2,"Description":"True/false indicating whether the App Service Environment is healthy."},"environmentStatus":{"Type":4,"Flags":2,"Description":"Detailed message about with results of the last check of the App Service Environment."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"defaultFrontEndScaleFactor":{"Type":3,"Flags":2,"Description":"Default Scale Factor for FrontEnds."},"apiManagementAccountId":{"Type":4,"Flags":0,"Description":"API Management Account associated with the App Service Environment."},"suspended":{"Type":2,"Flags":0,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"dynamicCacheEnabled":{"Type":2,"Flags":0,"Description":"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\n(most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":758,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":759,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":0,"Description":"Flag that displays whether an ASE has linux workers or not"},"sslCertKeyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault ID for ILB App Service Environment default SSL certificate"},"sslCertKeyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault Secret Name for ILB App Service Environment default SSL certificate"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[712,713,714,715,716]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[718,719,720,721]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web,Publishing"}},{"5":{"Elements":[724,725,726,727,4]}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":733,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":734,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[730,731,732]}},{"3":{"ItemType":4}},{"3":{"ItemType":729}},{"2":{"Name":"VirtualIPMapping","Properties":{"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address."},"internalHttpPort":{"Type":3,"Flags":0,"Description":"Internal HTTP port."},"internalHttpsPort":{"Type":3,"Flags":0,"Description":"Internal HTTPS port."},"inUse":{"Type":2,"Flags":0,"Description":"Is virtual IP mapping in use."},"serviceName":{"Type":4,"Flags":0,"Description":"name of the service that virtual IP is assigned to"}}}},{"3":{"ItemType":736}},{"2":{"Name":"StampCapacity","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the stamp."},"availableCapacity":{"Type":3,"Flags":0,"Description":"Available capacity (# of machines, bytes of storage etc...)."},"totalCapacity":{"Type":3,"Flags":0,"Description":"Total capacity (# of machines, bytes of storage etc...)."},"unit":{"Type":4,"Flags":0,"Description":"Name of the unit."},"computeMode":{"Type":742,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":751,"Flags":0,"Description":"Size of the machines."},"workerSizeId":{"Type":3,"Flags":0,"Description":"Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large"},"excludeFromCapacityAllocation":{"Type":2,"Flags":0,"Description":"If true, it includes basic apps.\nBasic apps are not used for capacity allocation."},"isApplicableForAllComputeModes":{"Type":2,"Flags":0,"Description":"true if capacity is applicable for all apps; otherwise, false."},"siteMode":{"Type":4,"Flags":0,"Description":"Shared or Dedicated."},"isLinux":{"Type":2,"Flags":0,"Description":"Is this a linux stamp capacity"}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[739,740,741]}},{"6":{"Value":"Small"}},{"6":{"Value":"Medium"}},{"6":{"Value":"Large"}},{"6":{"Value":"D1"}},{"6":{"Value":"D2"}},{"6":{"Value":"D3"}},{"6":{"Value":"NestedSmall"}},{"6":{"Value":"Default"}},{"5":{"Elements":[743,744,745,746,747,748,749,750]}},{"3":{"ItemType":738}},{"2":{"Name":"NetworkAccessControlEntry","Properties":{"action":{"Type":756,"Flags":0,"Description":"Action object."},"description":{"Type":4,"Flags":0,"Description":"Description of network access control entry."},"order":{"Type":3,"Flags":0,"Description":"Order of precedence."},"remoteSubnet":{"Type":4,"Flags":0,"Description":"Remote subnet."}}}},{"6":{"Value":"Permit"}},{"6":{"Value":"Deny"}},{"5":{"Elements":[754,755]}},{"3":{"ItemType":753}},{"3":{"ItemType":74}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-10-01","ScopeType":8,"Body":710}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":762,"Flags":9,"Description":"The resource name"},"type":{"Type":763,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":764,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-10-01","ScopeType":8,"Body":765}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":767,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":768,"Flags":10,"Description":"The resource api version"},"properties":{"Type":729,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-10-01","ScopeType":8,"Body":769}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":771,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":772,"Flags":10,"Description":"The resource api version"},"properties":{"Type":774,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":685,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":785,"Flags":0,"Description":"Resource tags."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":778,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":784,"Flags":2,"Description":"Provisioning state of the App Service Environment."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[775,776,777]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[779,780,781,782,783]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-10-01","ScopeType":8,"Body":773}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-10-01","ScopeType":8,"Body":789}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-10-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":791,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":792,"Flags":10,"Description":"The resource api version"},"properties":{"Type":654,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-10-01","ScopeType":8,"Body":793}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":334,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."},"systemData":{"Type":27,"Flags":6,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":797,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":808,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":809,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[798,799,800,801,802,803,804,805,806,807]}},{"3":{"ItemType":339}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-10-01","Output":796,"Input":795}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":812,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-10-01","Output":811}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-10-01","Output":815}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":818,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":819,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-10-01","Output":817}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":822,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":796}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-10-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-10-01","Output":815}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-10-01","Output":796,"Input":795}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-10-01","Output":815}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-10-01","Output":817}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-10-01","Output":821}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-10-01","Output":815}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":835,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":834,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":833}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-10-01","Output":832}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-10-01","Output":811}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-10-01","Output":811}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":841,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."},"systemData":{"Type":27,"Flags":2,"Description":"Metadata pertaining to creation and last modification of the resource."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-10-01","Output":840}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2020-10-01/types.md b/generated/web/microsoft.web/2020-10-01/types.md index ad31005189..8192ae5c04 100644 --- a/generated/web/microsoft.web/2020-10-01/types.md +++ b/generated/web/microsoft.web/2020-10-01/types.md @@ -912,48 +912,46 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2020-10-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (Required, WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AllowedAudiencesValidationProperties](#allowedaudiencesvalidationproperties): AllowedAudiencesValidation resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## HostingEnvironmentProfile +## AllowedAudiencesValidationProperties ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **allowedAudiences**: string[]: Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem -## SystemData +## ApiDefinitionInfo ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User': The type of identity that created the resource. +* **url**: string: The URL of the API definition. -## ResourceTags +## ApiManagementConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: APIM-Api Identifier. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppRegistration +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AppRegistrationProperties](#appregistrationproperties): AppRegistration resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. + +## AppRegistrationProperties +### Properties +* **appId**: string +* **appSecretSettingName**: string ## AppServiceEnvironment ### Properties @@ -972,7 +970,7 @@ This is valid for all deployment slots in an app. * **environmentStatus**: string (ReadOnly): Detailed message about with results of the last check of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool: Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web,Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web,Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **lastAction**: string (ReadOnly): Last deployment action on the App Service Environment. * **lastActionResult**: string (ReadOnly): Result of the last deployment action on the App Service Environment. @@ -999,96 +997,6 @@ This is valid for all deployment slots in an app. * **vnetSubnetName**: string: Subnet of the Virtual Network. * **workerPools**: [WorkerPool](#workerpool)[] (Required): Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## StampCapacity -### Properties -* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. -Basic apps are not used for capacity allocation. -* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. -* **isLinux**: bool: Is this a linux stamp capacity -* **name**: string: Name of the stamp. -* **siteMode**: string: Shared or Dedicated. -* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). -* **unit**: string: Name of the unit. -* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. -* **workerSizeId**: int: Size ID of machines: -0 - Small -1 - Medium -2 - Large - -## NetworkAccessControlEntry -### Properties -* **action**: 'Deny' | 'Permit': Action object. -* **description**: string: Description of network access control entry. -* **order**: int: Order of precedence. -* **remoteSubnet**: string: Remote subnet. - -## VirtualIPMapping -### Properties -* **internalHttpPort**: int: Internal HTTP port. -* **internalHttpsPort**: int: Internal HTTPS port. -* **inUse**: bool: Is virtual IP mapping in use. -* **serviceName**: string: name of the service that virtual IP is assigned to -* **virtualIP**: string: Virtual IP address. - -## VirtualNetworkProfile -### Properties -* **id**: string: Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -1112,510 +1020,448 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## AuthPlatform ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AuthPlatformProperties](#authplatformproperties): AuthPlatform resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## VnetRouteProperties +## AuthPlatformProperties ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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 +* **configFilePath**: string +* **enabled**: bool +* **runtimeVersion**: string -These values will be used for syncing an app's routes with those from a Virtual Network. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +## AutoHealActions +### Properties +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## ManagedServiceIdentity +## AutoHealCustomAction ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealRules ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoHealTriggers ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -## SiteProperties +## AzureActiveDirectory ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **storageAccountRequired**: bool: Checks if Customer provided storage account is required -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryProperties](#azureactivedirectoryproperties): AzureActiveDirectory resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## CloningInfo +## AzureActiveDirectoryLogin ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryLoginProperties](#azureactivedirectoryloginproperties): AzureActiveDirectoryLogin resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## CloningInfoAppSettingsOverrides +## AzureActiveDirectoryLoginProperties +### Properties +* **disableWWWAuthenticate**: bool +* **loginParameters**: string[]: Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem + +## AzureActiveDirectoryProperties +### Properties +* **enabled**: bool +* **isAutoProvisioned**: bool +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin) +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration) +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation) + +## AzureActiveDirectoryRegistration +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryRegistrationProperties](#azureactivedirectoryregistrationproperties): AzureActiveDirectoryRegistration resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. + +## AzureActiveDirectoryRegistrationProperties +### Properties +* **clientId**: string +* **clientSecretCertificateThumbprint**: string +* **clientSecretSettingName**: string +* **openIdIssuer**: string + +## AzureActiveDirectoryValidation +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [AzureActiveDirectoryValidationProperties](#azureactivedirectoryvalidationproperties): AzureActiveDirectoryValidation resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. + +## AzureActiveDirectoryValidationProperties +### Properties +* **allowedAudiences**: string[]: Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks) + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureStorageInfoValue +### Properties +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. + +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## HostNameSslState +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## SiteConfig +## AzureTableStorageApplicationLogsConfig ### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## ApiDefinitionInfo +## BackupItem ### Properties -* **url**: string: The URL of the API definition. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## ApiManagementConfig +## BackupItem ### Properties -* **id**: string: APIM-Api Identifier. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## AutoHealRules +## BackupItemCollection ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealActions +## BackupItemCollection ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealCustomAction +## BackupItemProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## AutoHealTriggers +## BackupRequest ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly, WriteOnly): Resource type. -## RequestsBasedTrigger +## BackupRequest ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SlowRequestsBasedTrigger +## BackupRequestProperties ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## StatusCodesBasedTrigger +## BackupSchedule ### Properties -* **count**: int: Request Count. -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## ConnStringInfo +## BlobStorageTokenStore ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BlobStorageTokenStoreProperties](#blobstoragetokenstoreproperties): BlobStorageTokenStore resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## CorsSettings +## BlobStorageTokenStoreProperties ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +* **sasUrlSettingName**: string -## Experiments +## Capability ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. -## RampUpRule +## CertificateProperties ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (Required, WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. -## HandlerMapping +## ClientRegistration ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [ClientRegistrationProperties](#clientregistrationproperties): ClientRegistration resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## IpSecurityRestriction +## ClientRegistrationProperties ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **clientId**: string +* **clientSecretSettingName**: string -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. +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## CloningInfoAppSettingsOverrides +### Properties +### Additional Properties +* **Additional Properties Type**: string -## IpSecurityRestrictionHeaders +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## ConnectionStringDictionaryProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string[] +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteLimits +## ConnectionStringDictionaryProperties ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteMachineKey +## ConnStringInfo ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. -## PushSettings +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CookieExpiration ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **properties**: [CookieExpirationProperties](#cookieexpirationproperties): CookieExpiration resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## PushSettingsProperties +## CookieExpirationProperties ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **convention**: 'FixedTime' | 'IdentityProviderDerived' +* **timeToExpiration**: string -## VirtualApplication +## CorsSettings ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## VirtualDirectory +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## SlotSwapStatus +## CustomOpenIdConnectProvider ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [CustomOpenIdConnectProviderProperties](#customopenidconnectproviderproperties): CustomOpenIdConnectProvider resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## CustomOpenIdConnectProviderProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool +* **login**: [OpenIdConnectLogin](#openidconnectlogin) +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration) -## CsmPublishingCredentialsPoliciesEntityProperties +## DatabaseBackupSetting ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## StringDictionaryProperties +## DeploymentProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## SiteAuthSettingsProperties +## EnabledConfig ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## SiteAuthSettingsV2Properties +## Experiments ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation) -* **httpSettings**: [HttpSettings](#httpsettings) -* **identityProviders**: [IdentityProviders](#identityproviders) -* **login**: [Login](#login) -* **platform**: [AuthPlatform](#authplatform) +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## GlobalValidation +## Facebook ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GlobalValidationProperties](#globalvalidationproperties): GlobalValidation resource specific properties +* **properties**: [FacebookProperties](#facebookproperties): Facebook resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## GlobalValidationProperties +## FacebookProperties ### Properties -* **excludedPaths**: string[]: Array of GlobalValidationPropertiesExcludedPathsItem -* **redirectToProvider**: string -* **requireAuthentication**: bool -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403' +* **enabled**: bool +* **graphApiVersion**: string +* **login**: [LoginScopes](#loginscopes) +* **registration**: [AppRegistration](#appregistration) -## HttpSettings +## FileSystemApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. + +## FileSystemTokenStore ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HttpSettingsProperties](#httpsettingsproperties): HttpSettings resource specific properties +* **properties**: [FileSystemTokenStoreProperties](#filesystemtokenstoreproperties): FileSystemTokenStore resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## HttpSettingsProperties +## FileSystemTokenStoreProperties ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy) -* **requireHttps**: bool -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes) +* **directory**: string ## ForwardProxy ### Properties @@ -1632,352 +1478,377 @@ application used for sign-in. * **customHostHeaderName**: string * **customProtoHeaderName**: string -## HttpSettingsRoutes +## FunctionEnvelopeProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HttpSettingsRoutesProperties](#httpsettingsroutesproperties): HttpSettingsRoutes resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. -## HttpSettingsRoutesProperties +## FunctionEnvelopePropertiesFiles ### Properties -* **apiPrefix**: string +### Additional Properties +* **Additional Properties Type**: string -## IdentityProviders +## FunctionSecrets ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [IdentityProvidersProperties](#identityprovidersproperties): IdentityProviders resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## IdentityProvidersProperties +## FunctionSecrets ### Properties -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory) -* **customOpenIdConnectProviders**: [IdentityProvidersPropertiesCustomOpenIdConnectProviders](#identityproviderspropertiescustomopenidconnectproviders): Dictionary of -* **facebook**: [Facebook](#facebook) -* **gitHub**: [GitHub](#github) -* **google**: [Google](#google) -* **twitter**: [Twitter](#twitter) +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## AzureActiveDirectory +## GitHub ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryProperties](#azureactivedirectoryproperties): AzureActiveDirectory resource specific properties +* **properties**: [GitHubProperties](#githubproperties): GitHub resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryProperties +## GitHubProperties ### Properties * **enabled**: bool -* **isAutoProvisioned**: bool -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin) -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration) -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation) +* **login**: [LoginScopes](#loginscopes) +* **registration**: [ClientRegistration](#clientregistration) -## AzureActiveDirectoryLogin +## GlobalValidation ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryLoginProperties](#azureactivedirectoryloginproperties): AzureActiveDirectoryLogin resource specific properties +* **properties**: [GlobalValidationProperties](#globalvalidationproperties): GlobalValidation resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryLoginProperties +## GlobalValidationProperties ### Properties -* **disableWWWAuthenticate**: bool -* **loginParameters**: string[]: Array of AzureActiveDirectoryLoginPropertiesLoginParametersItem +* **excludedPaths**: string[]: Array of GlobalValidationPropertiesExcludedPathsItem +* **redirectToProvider**: string +* **requireAuthentication**: bool +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403' -## AzureActiveDirectoryRegistration +## Google ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryRegistrationProperties](#azureactivedirectoryregistrationproperties): AzureActiveDirectoryRegistration resource specific properties +* **properties**: [GoogleProperties](#googleproperties): Google resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AzureActiveDirectoryRegistrationProperties +## GoogleProperties ### Properties -* **clientId**: string -* **clientSecretCertificateThumbprint**: string -* **clientSecretSettingName**: string -* **openIdIssuer**: string +* **enabled**: bool +* **login**: [LoginScopes](#loginscopes) +* **registration**: [ClientRegistration](#clientregistration) +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation) -## AzureActiveDirectoryValidation +## HandlerMapping ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AzureActiveDirectoryValidationProperties](#azureactivedirectoryvalidationproperties): AzureActiveDirectoryValidation resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## AzureActiveDirectoryValidationProperties +## HostingEnvironmentProfile ### Properties -* **allowedAudiences**: string[]: Array of AzureActiveDirectoryValidationPropertiesAllowedAudiencesItem -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks) +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## JwtClaimChecks +## HostKeys ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [JwtClaimChecksProperties](#jwtclaimchecksproperties): JwtClaimChecks resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## JwtClaimChecksProperties +## HostKeys ### Properties -* **allowedClientApplications**: string[]: Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem -* **allowedGroups**: string[]: Array of JwtClaimChecksPropertiesAllowedGroupsItem +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## IdentityProvidersPropertiesCustomOpenIdConnectProviders +## HostKeysFunctionKeys ### Properties ### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **Additional Properties Type**: string -## CustomOpenIdConnectProvider +## HostKeysSystemKeys ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [CustomOpenIdConnectProviderProperties](#customopenidconnectproviderproperties): CustomOpenIdConnectProvider resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## CustomOpenIdConnectProviderProperties +## HostNameBindingProperties ### Properties -* **enabled**: bool -* **login**: [OpenIdConnectLogin](#openidconnectlogin) -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration) +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## OpenIdConnectLogin +## HostNameSslState ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectLoginProperties](#openidconnectloginproperties): OpenIdConnectLogin resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## OpenIdConnectLoginProperties +## HttpLogsConfig ### Properties -* **nameClaimType**: string -* **scopes**: string[]: Array of OpenIdConnectLoginPropertiesScopesItem +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## OpenIdConnectRegistration +## HttpSettings ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectRegistrationProperties](#openidconnectregistrationproperties): OpenIdConnectRegistration resource specific properties +* **properties**: [HttpSettingsProperties](#httpsettingsproperties): HttpSettings resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## OpenIdConnectRegistrationProperties +## HttpSettingsProperties ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential) -* **clientId**: string -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig) +* **forwardProxy**: [ForwardProxy](#forwardproxy) +* **requireHttps**: bool +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes) -## OpenIdConnectClientCredential +## HttpSettingsRoutes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectClientCredentialProperties](#openidconnectclientcredentialproperties): OpenIdConnectClientCredential resource specific properties +* **properties**: [HttpSettingsRoutesProperties](#httpsettingsroutesproperties): HttpSettingsRoutes resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## OpenIdConnectClientCredentialProperties +## HttpSettingsRoutesProperties ### Properties -* **clientSecretSettingName**: string -* **method**: 'ClientSecretPost' +* **apiPrefix**: string -## OpenIdConnectConfig +## HybridConnectionKey ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [OpenIdConnectConfigProperties](#openidconnectconfigproperties): OpenIdConnectConfig resource specific properties +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## OpenIdConnectConfigProperties +## HybridConnectionKeyProperties ### Properties -* **authorizationEndpoint**: string -* **certificationUri**: string -* **issuer**: string -* **tokenEndpoint**: string -* **wellKnownOpenIdConfiguration**: string +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## Facebook +## HybridConnectionProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [FacebookProperties](#facebookproperties): Facebook resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## FacebookProperties +## IdentifierProperties ### Properties -* **enabled**: bool -* **graphApiVersion**: string -* **login**: [LoginScopes](#loginscopes) -* **registration**: [AppRegistration](#appregistration) +* **id**: string: String representation of the identity. -## LoginScopes +## IdentityProviders ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginScopesProperties](#loginscopesproperties): LoginScopes resource specific properties +* **properties**: [IdentityProvidersProperties](#identityprovidersproperties): IdentityProviders resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## LoginScopesProperties +## IdentityProvidersProperties ### Properties -* **scopes**: string[]: Array of LoginScopesPropertiesScopesItem +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory) +* **customOpenIdConnectProviders**: [IdentityProvidersPropertiesCustomOpenIdConnectProviders](#identityproviderspropertiescustomopenidconnectproviders): Dictionary of +* **facebook**: [Facebook](#facebook) +* **gitHub**: [GitHub](#github) +* **google**: [Google](#google) +* **twitter**: [Twitter](#twitter) -## AppRegistration +## IdentityProvidersPropertiesCustomOpenIdConnectProviders ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [AppRegistrationProperties](#appregistrationproperties): AppRegistration resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## AppRegistrationProperties +## IpSecurityRestriction ### Properties -* **appId**: string -* **appSecretSettingName**: string +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## GitHub -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [GitHubProperties](#githubproperties): GitHub resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +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. -## GitHubProperties +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **enabled**: bool -* **login**: [LoginScopes](#loginscopes) -* **registration**: [ClientRegistration](#clientregistration) +### Additional Properties +* **Additional Properties Type**: string[] -## ClientRegistration +## JwtClaimChecks ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [ClientRegistrationProperties](#clientregistrationproperties): ClientRegistration resource specific properties +* **properties**: [JwtClaimChecksProperties](#jwtclaimchecksproperties): JwtClaimChecks resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## ClientRegistrationProperties +## JwtClaimChecksProperties ### Properties -* **clientId**: string -* **clientSecretSettingName**: string +* **allowedClientApplications**: string[]: Array of JwtClaimChecksPropertiesAllowedClientApplicationsItem +* **allowedGroups**: string[]: Array of JwtClaimChecksPropertiesAllowedGroupsItem -## Google +## Login ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [GoogleProperties](#googleproperties): Google resource specific properties +* **properties**: [LoginProperties](#loginproperties): Login resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## GoogleProperties +## LoginProperties ### Properties -* **enabled**: bool -* **login**: [LoginScopes](#loginscopes) -* **registration**: [ClientRegistration](#clientregistration) -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation) +* **allowedExternalRedirectUrls**: string[]: Array of LoginPropertiesAllowedExternalRedirectUrlsItem +* **cookieExpiration**: [CookieExpiration](#cookieexpiration) +* **nonce**: [Nonce](#nonce) +* **preserveUrlFragmentsForLogins**: bool +* **routes**: [LoginRoutes](#loginroutes) +* **tokenStore**: [TokenStore](#tokenstore) -## AllowedAudiencesValidation +## LoginRoutes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AllowedAudiencesValidationProperties](#allowedaudiencesvalidationproperties): AllowedAudiencesValidation resource specific properties +* **properties**: [LoginRoutesProperties](#loginroutesproperties): LoginRoutes resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AllowedAudiencesValidationProperties +## LoginRoutesProperties ### Properties -* **allowedAudiences**: string[]: Array of AllowedAudiencesValidationPropertiesAllowedAudiencesItem +* **logoutEndpoint**: string -## Twitter +## LoginScopes ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [TwitterProperties](#twitterproperties): Twitter resource specific properties +* **properties**: [LoginScopesProperties](#loginscopesproperties): LoginScopes resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## TwitterProperties +## LoginScopesProperties ### Properties -* **enabled**: bool -* **registration**: [TwitterRegistration](#twitterregistration) +* **scopes**: string[]: Array of LoginScopesPropertiesScopesItem -## TwitterRegistration +## ManagedServiceIdentity ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [TwitterRegistrationProperties](#twitterregistrationproperties): TwitterRegistration resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## TwitterRegistrationProperties +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **consumerKey**: string -* **consumerSecretSettingName**: string +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## Login +## MSDeployCore ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginProperties](#loginproperties): Login resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## LoginProperties +## MSDeployCoreSetParameters ### Properties -* **allowedExternalRedirectUrls**: string[]: Array of LoginPropertiesAllowedExternalRedirectUrlsItem -* **cookieExpiration**: [CookieExpiration](#cookieexpiration) -* **nonce**: [Nonce](#nonce) -* **preserveUrlFragmentsForLogins**: bool -* **routes**: [LoginRoutes](#loginroutes) -* **tokenStore**: [TokenStore](#tokenstore) +### Additional Properties +* **Additional Properties Type**: string -## CookieExpiration +## NameValuePair ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [CookieExpirationProperties](#cookieexpirationproperties): CookieExpiration resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **name**: string: Pair name. +* **value**: string: Pair value. -## CookieExpirationProperties +## NetworkAccessControlEntry ### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived' -* **timeToExpiration**: string +* **action**: 'Deny' | 'Permit': Action object. +* **description**: string: Description of network access control entry. +* **order**: int: Order of precedence. +* **remoteSubnet**: string: Remote subnet. ## Nonce ### Properties @@ -1993,265 +1864,141 @@ application used for sign-in. * **nonceExpirationInterval**: string * **validateNonce**: bool -## LoginRoutes -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [LoginRoutesProperties](#loginroutesproperties): LoginRoutes resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. - -## LoginRoutesProperties -### Properties -* **logoutEndpoint**: string - -## TokenStore +## OpenIdConnectClientCredential ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [TokenStoreProperties](#tokenstoreproperties): TokenStore resource specific properties +* **properties**: [OpenIdConnectClientCredentialProperties](#openidconnectclientcredentialproperties): OpenIdConnectClientCredential resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## TokenStoreProperties +## OpenIdConnectClientCredentialProperties ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore) -* **enabled**: bool -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore) -* **tokenRefreshExtensionHours**: int +* **clientSecretSettingName**: string +* **method**: 'ClientSecretPost' -## BlobStorageTokenStore +## OpenIdConnectConfig ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BlobStorageTokenStoreProperties](#blobstoragetokenstoreproperties): BlobStorageTokenStore resource specific properties +* **properties**: [OpenIdConnectConfigProperties](#openidconnectconfigproperties): OpenIdConnectConfig resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## BlobStorageTokenStoreProperties +## OpenIdConnectConfigProperties ### Properties -* **sasUrlSettingName**: string +* **authorizationEndpoint**: string +* **certificationUri**: string +* **issuer**: string +* **tokenEndpoint**: string +* **wellKnownOpenIdConfiguration**: string -## FileSystemTokenStore +## OpenIdConnectLogin ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [FileSystemTokenStoreProperties](#filesystemtokenstoreproperties): FileSystemTokenStore resource specific properties +* **properties**: [OpenIdConnectLoginProperties](#openidconnectloginproperties): OpenIdConnectLogin resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## FileSystemTokenStoreProperties +## OpenIdConnectLoginProperties ### Properties -* **directory**: string +* **nameClaimType**: string +* **scopes**: string[]: Array of OpenIdConnectLoginPropertiesScopesItem -## AuthPlatform +## OpenIdConnectRegistration ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [AuthPlatformProperties](#authplatformproperties): AuthPlatform resource specific properties +* **properties**: [OpenIdConnectRegistrationProperties](#openidconnectregistrationproperties): OpenIdConnectRegistration resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## AuthPlatformProperties -### Properties -* **configFilePath**: string -* **enabled**: bool -* **runtimeVersion**: string - -## AzureStoragePropertyDictionaryResourceProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) - -## AzureStorageInfoValue -### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. - -## BackupRequestProperties -### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. - -## BackupSchedule -### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. - -## DatabaseBackupSetting -### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string - -## ConnectionStringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) - -## ConnStringValueTypePair -### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. - -## SiteLogsConfigProperties -### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. - -## ApplicationLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. - -## AzureBlobStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. - -## AzureTableStorageApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. - -## FileSystemApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. - -## EnabledConfig -### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. - -## HttpLogsConfig -### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. - -## AzureBlobStorageHttpLogsConfig +## OpenIdConnectRegistrationProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential) +* **clientId**: string +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig) -## FileSystemHttpLogsConfig +## PremierAddOnProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## StringDictionaryProperties +## PrivateAccessProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## SlotConfigNames +## PrivateAccessSubnet ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## DeploymentProperties +## PrivateAccessVirtualNetwork ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## IdentifierProperties +## PrivateLinkConnectionApprovalRequest ### Properties -* **id**: string: String representation of the identity. +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## MSDeployCore +## PrivateLinkConnectionState ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## MSDeployCoreSetParameters +## PublicCertificateProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FunctionEnvelopeProperties +## PushSettings ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## FunctionEnvelopePropertiesFiles +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## HostNameBindingProperties +## RampUpRule ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. ## RelayServiceConnectionEntityProperties ### Properties @@ -2263,74 +2010,213 @@ Setting is false by default. * **resourceConnectionString**: string * **resourceType**: string -## HybridConnectionProperties +## RequestsBasedTrigger ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResourceTags ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessVirtualNetwork +## ResourceTags ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessSubnet +## ResourceTags ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +### Additional Properties +* **Additional Properties Type**: string -## PrivateLinkConnectionApprovalRequest +## ResourceTags ### Properties -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string -## ArmIdWrapper +## ResourceTags ### Properties -* **id**: string (ReadOnly) +### Additional Properties +* **Additional Properties Type**: string + +## SiteAuthSettingsProperties +### Properties +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PrivateLinkConnectionState +## SiteAuthSettingsV2Properties ### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection +* **globalValidation**: [GlobalValidation](#globalvalidation) +* **httpSettings**: [HttpSettings](#httpsettings) +* **identityProviders**: [IdentityProviders](#identityproviders) +* **login**: [Login](#login) +* **platform**: [AuthPlatform](#authplatform) -## PublicCertificateProperties +## SiteConfig ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id ## SiteExtensionInfoProperties ### Properties @@ -2355,35 +2241,74 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **storageAccountRequired**: bool: Checks if Customer provided storage account is required +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. ## SiteSourceControlProperties ### Properties @@ -2394,25 +2319,41 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## VnetInfoProperties +## SkuCapacity ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **default**: int: Default number of workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## VnetRoute +## SkuDescription ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. + +## SlotConfigNames +### Properties +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. + +## SlotSwapStatus +### Properties +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. + +## SlowRequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2421,6 +2362,24 @@ Point-To-Site VPN connection. * **token**: string: OAuth access token. * **tokenSecret**: string: OAuth access token secret. +## StampCapacity +### Properties +* **availableCapacity**: int: Available capacity (# of machines, bytes of storage etc...). +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **excludeFromCapacityAllocation**: bool: If true, it includes basic apps. +Basic apps are not used for capacity allocation. +* **isApplicableForAllComputeModes**: bool: true if capacity is applicable for all apps; otherwise, false. +* **isLinux**: bool: Is this a linux stamp capacity +* **name**: string: Name of the stamp. +* **siteMode**: string: Shared or Dedicated. +* **totalCapacity**: int: Total capacity (# of machines, bytes of storage etc...). +* **unit**: string: Name of the unit. +* **workerSize**: 'D1' | 'D2' | 'D3' | 'Default' | 'Large' | 'Medium' | 'NestedSmall' | 'Small': Size of the machines. +* **workerSizeId**: int: Size ID of machines: +0 - Small +1 - Medium +2 - Large + ## StaticSite ### Properties * **branch**: string: The target branch in the repository. @@ -2436,56 +2395,44 @@ Point-To-Site VPN connection. * **appArtifactLocation**: string: The path of the app artifacts after building. * **appLocation**: string: The path to the app code within the repository. -## ResourceTags +## StaticSiteUserARMResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## BackupRequest +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2495,26 +2442,12 @@ Point-To-Site VPN connection. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **systemData**: [SystemData](#systemdata) (ReadOnly, WriteOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. @@ -2527,16 +2460,6 @@ Point-To-Site VPN connection. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2564,98 +2487,175 @@ Point-To-Site VPN connection. * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SwiftVirtualNetworkProperties +### Properties +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. + +## SystemData +### Properties +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TokenStore ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **properties**: [TokenStoreProperties](#tokenstoreproperties): TokenStore resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKeyProperties +## TokenStoreProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore) +* **enabled**: bool +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore) +* **tokenRefreshExtensionHours**: int -## FunctionSecrets +## Twitter ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [TwitterProperties](#twitterproperties): Twitter resource specific properties +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## TwitterProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **enabled**: bool +* **registration**: [TwitterRegistration](#twitterregistration) -## StringDictionary +## TwitterRegistration ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: [TwitterRegistrationProperties](#twitterregistrationproperties): TwitterRegistration resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## TwitterRegistrationProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **consumerKey**: string +* **consumerSecretSettingName**: string -## FunctionSecrets +## UserProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. -## StaticSiteUserCollection +## VirtualApplication ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. -## StaticSiteUserARMResource +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualIPMapping +### Properties +* **internalHttpPort**: int: Internal HTTP port. +* **internalHttpsPort**: int: Internal HTTPS port. +* **inUse**: bool: Is virtual IP mapping in use. +* **serviceName**: string: name of the service that virtual IP is assigned to +* **virtualIP**: string: Virtual IP address. + +## VirtualNetworkProfile +### Properties +* **id**: string: Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2020-12-01/types.json b/generated/web/microsoft.web/2020-12-01/types.json index 21bb89e558..844d3b666a 100644 --- a/generated/web/microsoft.web/2020-12-01/types.json +++ b/generated/web/microsoft.web/2020-12-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2020-12-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":28,"Flags":9,"Description":"The resource name"},"type":{"Type":29,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":30,"Flags":10,"Description":"The resource api version"},"properties":{"Type":32,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-12-01","ScopeType":1,"Body":31}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":34,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":35,"Flags":10,"Description":"The resource api version"},"properties":{"Type":37,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-12-01","ScopeType":1,"Body":36}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":39,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":40,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":189,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":43,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":46,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":47,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":51,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":60,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":167,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":171,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":172,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":174,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":180,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[44,45]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[48,49,50]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":56,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":59,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[53,54,55]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[57,58]}},{"3":{"ItemType":52}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":62,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":64,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":78,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":79,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":81,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":96,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":99,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":103,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":110,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":111,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":114,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":115,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":130,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":132,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":134,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":135,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":143,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":144,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":148,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":152,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":156,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":166,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":63}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":77,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[66,67,68,69,70,71,72,73,74,75,76]}},{"3":{"ItemType":65}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":80}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[82,83,84,85,86,87,88,89,90,91,92,93,94,95]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[97,98]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":102,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[104,105,106,107,108,109]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":113,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":112}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":116,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":124,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":117,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":119,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":120,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":121,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":123,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":118}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":120}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":122}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":128,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":129,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[125,126,127]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":131,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":133,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":140,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":142,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[137,138,139]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":141}},{"3":{"ItemType":136}},{"3":{"ItemType":136}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[145,146,147]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[149,150,151]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[153,154,155]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":160,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":165,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[158,159]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[161,162,163,164]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":157}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[168,169,170]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":173,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[175,176,177,178,179]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":186,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":188,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[182,183,184,185]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":187}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-12-01","ScopeType":8,"Body":41}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":191,"Flags":9,"Description":"The resource name"},"type":{"Type":192,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":193,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":196,"Flags":9,"Description":"The resource name"},"type":{"Type":197,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":198,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":194,"scm":199}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-12-01","ScopeType":8,"Body":200}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":202,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":206,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":207,"Flags":9,"Description":"The resource name"},"type":{"Type":208,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":209,"Flags":10,"Description":"The resource api version"},"properties":{"Type":211,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":214,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":215,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":222,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":223,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":224,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":225,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":226,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":227,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":228,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[212,213]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[216,217,218,219,220,221]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":229,"Flags":9,"Description":"The resource name"},"type":{"Type":230,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":231,"Flags":10,"Description":"The resource api version"},"properties":{"Type":233,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":234,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":235,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":242,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":276,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":287,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":240,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":241,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[236,237,238,239]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":243,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":252,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":256,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":258,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":261,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":262,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":264,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":266,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":275,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":244,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":245,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":247,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":246,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":248,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":251,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":249,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":250,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":253,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":255,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":257,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":257,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":259,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":260,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":257,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":259,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":263,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":265,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":267,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":269,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":273,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":270,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":272,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":271,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":274,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":268}},{"2":{"Name":"Login","Properties":{"routes":{"Type":277,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":278,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":281,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":282,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":286,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":279,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":280,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":285,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[283,284]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":288,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":289,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":293,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[290,291,292]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":294,"Flags":9,"Description":"The resource name"},"type":{"Type":295,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":296,"Flags":10,"Description":"The resource api version"},"properties":{"Type":298,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":157}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":299,"Flags":9,"Description":"The resource name"},"type":{"Type":300,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":301,"Flags":10,"Description":"The resource api version"},"properties":{"Type":303,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":304,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":314,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":307,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[305,306]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":313,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[309,310,311,312]}},{"3":{"ItemType":308}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":315,"Flags":9,"Description":"The resource name"},"type":{"Type":316,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":317,"Flags":10,"Description":"The resource api version"},"properties":{"Type":332,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":331,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[320,321,322,323,324,325,326,327,328,329,330]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":319}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":333,"Flags":9,"Description":"The resource name"},"type":{"Type":334,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":335,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":338,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":360,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":363,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":363,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":339,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":346,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":353,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":345,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[340,341,342,343,344]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":352,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[347,348,349,350,351]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":359,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[354,355,356,357,358]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":361,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":362,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":369,"Flags":9,"Description":"The resource name"},"type":{"Type":370,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":371,"Flags":10,"Description":"The resource api version"},"properties":{"Type":133,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":373,"Flags":9,"Description":"The resource name"},"type":{"Type":374,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":375,"Flags":10,"Description":"The resource api version"},"properties":{"Type":377,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":378,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":379,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":380,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":381,"Flags":9,"Description":"The resource name"},"type":{"Type":382,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":383,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":205,"authsettings":210,"authsettingsV2":232,"azurestorageaccounts":297,"backup":302,"connectionstrings":318,"logs":336,"metadata":367,"pushsettings":372,"slotConfigNames":376,"web":384}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-12-01","ScopeType":8,"Body":385}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":387,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":388,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-12-01","ScopeType":8,"Body":389}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":392,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":393,"Flags":10,"Description":"The resource api version"},"properties":{"Type":395,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-12-01","ScopeType":8,"Body":394}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":397,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":402,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":408,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[403,404,405,406,407]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-12-01","ScopeType":8,"Body":400}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":410,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":411,"Flags":10,"Description":"The resource api version"},"properties":{"Type":413,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":414,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-12-01","ScopeType":8,"Body":412}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":416,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":417,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-12-01","ScopeType":8,"Body":418}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":420,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":421,"Flags":10,"Description":"The resource api version"},"properties":{"Type":423,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":426,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":429,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":432,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":436,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[424,425]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[427,428]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[430,431]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[433,434,435]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-12-01","ScopeType":8,"Body":422}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":438,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":439,"Flags":10,"Description":"The resource api version"},"properties":{"Type":441,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-12-01","ScopeType":8,"Body":440}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":443,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":444,"Flags":10,"Description":"The resource api version"},"properties":{"Type":446,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-12-01","ScopeType":8,"Body":445}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":448,"Flags":9,"Description":"The resource name"},"type":{"Type":449,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":450,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-12-01","ScopeType":8,"Body":451}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":453,"Flags":9,"Description":"The resource name"},"type":{"Type":454,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":455,"Flags":10,"Description":"The resource api version"},"properties":{"Type":457,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-12-01","ScopeType":8,"Body":456}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":459,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":460,"Flags":10,"Description":"The resource api version"},"properties":{"Type":462,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":463,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-12-01","ScopeType":8,"Body":461}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":465,"Flags":9,"Description":"The resource name"},"type":{"Type":466,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":467,"Flags":10,"Description":"The resource api version"},"properties":{"Type":469,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":473,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":472,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":471}},{"3":{"ItemType":470}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-12-01","ScopeType":8,"Body":468}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":475,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":476,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":479,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":480,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":481,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":477}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":483,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":484,"Flags":10,"Description":"The resource api version"},"properties":{"Type":486,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":490,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[487,488,489]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-12-01","ScopeType":8,"Body":485}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":492,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":493,"Flags":10,"Description":"The resource api version"},"properties":{"Type":495,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":498,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":499,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[496,497]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-12-01","ScopeType":8,"Body":494}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":501,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":502,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":504,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-12-01","ScopeType":8,"Body":503}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":506,"Flags":9,"Description":"The resource name"},"type":{"Type":507,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":508,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":510,"Flags":9,"Description":"The resource name"},"type":{"Type":511,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":512,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":509,"scm":513}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2020-12-01","ScopeType":8,"Body":514}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":516,"Flags":9,"Description":"The resource name"},"type":{"Type":517,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":518,"Flags":10,"Description":"The resource api version"},"properties":{"Type":520,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":521,"Flags":9,"Description":"The resource name"},"type":{"Type":522,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":523,"Flags":10,"Description":"The resource api version"},"properties":{"Type":211,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":525,"Flags":9,"Description":"The resource name"},"type":{"Type":526,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":527,"Flags":10,"Description":"The resource api version"},"properties":{"Type":233,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":529,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":157}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":534,"Flags":9,"Description":"The resource name"},"type":{"Type":535,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":536,"Flags":10,"Description":"The resource api version"},"properties":{"Type":303,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":538,"Flags":9,"Description":"The resource name"},"type":{"Type":539,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":540,"Flags":10,"Description":"The resource api version"},"properties":{"Type":542,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":319}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":543,"Flags":9,"Description":"The resource name"},"type":{"Type":544,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":545,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":551,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":552,"Flags":9,"Description":"The resource name"},"type":{"Type":553,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":554,"Flags":10,"Description":"The resource api version"},"properties":{"Type":133,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":519,"authsettings":524,"authsettingsV2":528,"azurestorageaccounts":532,"backup":537,"connectionstrings":541,"logs":546,"metadata":550,"pushsettings":555,"web":559}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-12-01","ScopeType":8,"Body":560}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":562,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":563,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-12-01","ScopeType":8,"Body":564}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":395,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-12-01","ScopeType":8,"Body":568}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":570,"Flags":9,"Description":"The resource name"},"type":{"Type":571,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":572,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-12-01","ScopeType":8,"Body":573}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":575,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":576,"Flags":10,"Description":"The resource api version"},"properties":{"Type":413,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-12-01","ScopeType":8,"Body":577}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":579,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":580,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-12-01","ScopeType":8,"Body":581}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":583,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":584,"Flags":10,"Description":"The resource api version"},"properties":{"Type":423,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-12-01","ScopeType":8,"Body":585}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":587,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":588,"Flags":10,"Description":"The resource api version"},"properties":{"Type":441,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-12-01","ScopeType":8,"Body":589}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":591,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":592,"Flags":10,"Description":"The resource api version"},"properties":{"Type":446,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-12-01","ScopeType":8,"Body":593}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":595,"Flags":9,"Description":"The resource name"},"type":{"Type":596,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":597,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-12-01","ScopeType":8,"Body":598}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":600,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":601,"Flags":10,"Description":"The resource api version"},"properties":{"Type":462,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":603,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-12-01","ScopeType":8,"Body":602}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":605,"Flags":9,"Description":"The resource name"},"type":{"Type":606,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":607,"Flags":10,"Description":"The resource api version"},"properties":{"Type":469,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-12-01","ScopeType":8,"Body":608}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":610,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":611,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":612}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":486,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-12-01","ScopeType":8,"Body":616}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":618,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":619,"Flags":10,"Description":"The resource api version"},"properties":{"Type":495,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-12-01","ScopeType":8,"Body":620}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":622,"Flags":9,"Description":"The resource name"},"type":{"Type":623,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":624,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":627,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":628,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":629,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-12-01","ScopeType":8,"Body":625}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":631,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":632,"Flags":10,"Description":"The resource api version"},"properties":{"Type":634,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":641,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":636,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":640,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[637,638,639]}},{"3":{"ItemType":635}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-12-01","ScopeType":8,"Body":633}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":643,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":644,"Flags":10,"Description":"The resource api version"},"properties":{"Type":646,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-12-01","ScopeType":8,"Body":645}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":648,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-12-01","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":653,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":654,"Flags":10,"Description":"The resource api version"},"properties":{"Type":634,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-12-01","ScopeType":8,"Body":655}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":657,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":658,"Flags":10,"Description":"The resource api version"},"properties":{"Type":646,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-12-01","ScopeType":8,"Body":659}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"A static site."},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":690,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":665,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":666,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":682,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":685,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":686,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":689,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":668,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":669,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":670,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":678,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":681,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":671,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":480,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":479,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":672,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":674,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":675,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":677,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":676}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":679,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":680,"Flags":0,"Description":"Inner errors."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":678}},{"3":{"ItemType":4}},{"3":{"ItemType":667}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[683,684]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":688,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":687}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-12-01","ScopeType":8,"Body":663}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":692,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"},"properties":{"Type":696,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":697,"Flags":9,"Description":"The resource name"},"type":{"Type":698,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":699,"Flags":10,"Description":"The resource api version"},"properties":{"Type":701,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":695,"functionappsettings":700}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-12-01","ScopeType":8,"Body":702}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"},"properties":{"Type":707,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2020-12-01","ScopeType":8,"Body":706}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":709,"Flags":9,"Description":"The resource name"},"type":{"Type":710,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":711,"Flags":10,"Description":"The resource api version"},"properties":{"Type":713,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":714,"Flags":9,"Description":"The resource name"},"type":{"Type":715,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":716,"Flags":10,"Description":"The resource api version"},"properties":{"Type":718,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":712,"functionappsettings":717}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-12-01","ScopeType":8,"Body":719}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":724,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":731,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[725,726,727,728,729,730]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-12-01","ScopeType":8,"Body":723}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":733,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":734,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":735}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":737,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":738,"Flags":10,"Description":"The resource api version"},"properties":{"Type":707,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2020-12-01","ScopeType":8,"Body":739}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":741,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":742,"Flags":10,"Description":"The resource api version"},"properties":{"Type":744,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":764,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":750,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":755,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":756,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":761,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":762,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":763,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":2,"Description":"Dedicated Host Count"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[745,746,747,748,749]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[751,752,753,754]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[757,758,759,760]}},{"3":{"ItemType":63}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-12-01","ScopeType":8,"Body":743}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":766,"Flags":9,"Description":"The resource name"},"type":{"Type":767,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":768,"Flags":10,"Description":"The resource api version"},"properties":{"Type":770,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":771,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":772,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2020-12-01","ScopeType":8,"Body":769}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":774,"Flags":9,"Description":"The resource name"},"type":{"Type":775,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":776,"Flags":10,"Description":"The resource api version"},"properties":{"Type":778,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":782,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":783,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[779,780,781]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-12-01","ScopeType":8,"Body":777}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":785,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":786,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":787}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":789,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":790,"Flags":10,"Description":"The resource api version"},"properties":{"Type":778,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-12-01","ScopeType":8,"Body":791}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":793,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":794,"Flags":10,"Description":"The resource api version"},"properties":{"Type":796,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":808,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":800,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":806,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"kubeEnvironmentProfile":{"Type":807,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[797,798,799]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[801,802,803,804,805]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-12-01","ScopeType":8,"Body":795}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":810,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":811,"Flags":10,"Description":"The resource api version"},"properties":{"Type":646,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-12-01","ScopeType":8,"Body":812}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-12-01","ScopeType":8,"Body":816}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":303,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":820,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":831,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":832,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[821,822,823,824,825,826,827,828,829,830]}},{"3":{"ItemType":308}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-12-01","Output":819,"Input":818}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":835,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-12-01","Output":834}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-12-01","Output":838}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":841,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":842,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-12-01","Output":840}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":845,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":819}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-12-01","Output":844}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-12-01","Output":838}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-12-01","Output":819,"Input":818}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-12-01","Output":838}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-12-01","Output":840}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-12-01","Output":844}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-12-01","Output":838}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":858,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":857,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":856}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-12-01","Output":855}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":834}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":864,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":863}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":834}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":869,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-12-01","Output":868}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":26,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":12,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":13,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":25,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[14,15,16,17,18,19,20,21,22,23,24]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2020-12-01","ScopeType":8,"Body":10}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":28,"Flags":9,"Description":"The resource name"},"type":{"Type":29,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":30,"Flags":10,"Description":"The resource api version"},"properties":{"Type":32,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2020-12-01","ScopeType":1,"Body":31}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":34,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":35,"Flags":10,"Description":"The resource api version"},"properties":{"Type":37,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2020-12-01","ScopeType":1,"Body":36}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":39,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":40,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":189,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":43,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":46,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":47,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":51,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":60,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":167,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":171,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":172,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":174,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":180,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[44,45]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[48,49,50]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":56,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":59,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[53,54,55]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[57,58]}},{"3":{"ItemType":52}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":62,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":64,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":78,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":79,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":81,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":96,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":99,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":103,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":110,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":111,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":114,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":115,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":130,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":132,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":134,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":135,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":143,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":144,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":148,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":152,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":156,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":166,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":63}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":77,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[66,67,68,69,70,71,72,73,74,75,76]}},{"3":{"ItemType":65}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":80}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[82,83,84,85,86,87,88,89,90,91,92,93,94,95,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[97,98]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":102,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":101}},{"3":{"ItemType":100}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[104,105,106,107,108,109]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":113,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":112}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":116,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":124,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":117,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":119,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":120,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":121,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":123,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":118}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":120}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":122}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":128,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":129,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[125,126,127]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":131,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":133,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":140,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":142,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[137,138,139,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":141}},{"3":{"ItemType":136}},{"3":{"ItemType":136}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[145,146,147,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[149,150,151,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[153,154,155,4]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":160,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":165,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[158,159]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[161,162,163,164]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":157}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[168,169,170]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":173,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[175,176,177,178,179]}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":186,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":188,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[182,183,184,185]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":187}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2020-12-01","ScopeType":8,"Body":41}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":191,"Flags":9,"Description":"The resource name"},"type":{"Type":192,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":193,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":196,"Flags":9,"Description":"The resource name"},"type":{"Type":197,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":198,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":194,"scm":199}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2020-12-01","ScopeType":8,"Body":200}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":202,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":206,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":207,"Flags":9,"Description":"The resource name"},"type":{"Type":208,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":209,"Flags":10,"Description":"The resource api version"},"properties":{"Type":211,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":214,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":215,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":222,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":223,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":224,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":225,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":226,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":227,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":228,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[212,213]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[216,217,218,219,220,221]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":229,"Flags":9,"Description":"The resource name"},"type":{"Type":230,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":231,"Flags":10,"Description":"The resource api version"},"properties":{"Type":233,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":234,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":235,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":242,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":276,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":287,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":240,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":241,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[236,237,238,239]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":243,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":252,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":256,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":258,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":261,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":262,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":264,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":266,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":275,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":244,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":245,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":247,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":246,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":248,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":251,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":249,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":250,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":253,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":255,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":257,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":257,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":259,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":260,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":257,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":259,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":263,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":265,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":254,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":267,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":269,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":273,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":270,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":272,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":271,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":274,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":268}},{"2":{"Name":"Login","Properties":{"routes":{"Type":277,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":278,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":281,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":282,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":286,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":279,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":280,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":285,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[283,284]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":288,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":289,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":293,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[290,291,292]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":294,"Flags":9,"Description":"The resource name"},"type":{"Type":295,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":296,"Flags":10,"Description":"The resource api version"},"properties":{"Type":298,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":157}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":299,"Flags":9,"Description":"The resource name"},"type":{"Type":300,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":301,"Flags":10,"Description":"The resource api version"},"properties":{"Type":303,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":304,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":314,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":307,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[305,306]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":313,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[309,310,311,312,4]}},{"3":{"ItemType":308}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":315,"Flags":9,"Description":"The resource name"},"type":{"Type":316,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":317,"Flags":10,"Description":"The resource api version"},"properties":{"Type":332,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":331,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[320,321,322,323,324,325,326,327,328,329,330]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":319}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":333,"Flags":9,"Description":"The resource name"},"type":{"Type":334,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":335,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":338,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":360,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":363,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":363,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":339,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":346,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":353,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":345,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[340,341,342,343,344]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":352,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[347,348,349,350,351]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":359,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[354,355,356,357,358]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":361,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":362,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":368,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":369,"Flags":9,"Description":"The resource name"},"type":{"Type":370,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":371,"Flags":10,"Description":"The resource api version"},"properties":{"Type":133,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":373,"Flags":9,"Description":"The resource name"},"type":{"Type":374,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":375,"Flags":10,"Description":"The resource api version"},"properties":{"Type":377,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":378,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":379,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":380,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":381,"Flags":9,"Description":"The resource name"},"type":{"Type":382,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":383,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":205,"authsettings":210,"authsettingsV2":232,"azurestorageaccounts":297,"backup":302,"connectionstrings":318,"logs":336,"metadata":367,"pushsettings":372,"slotConfigNames":376,"web":384}}},{"4":{"Name":"Microsoft.Web/sites/config@2020-12-01","ScopeType":8,"Body":385}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":387,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":388,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2020-12-01","ScopeType":8,"Body":389}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":392,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":393,"Flags":10,"Description":"The resource api version"},"properties":{"Type":395,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2020-12-01","ScopeType":8,"Body":394}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":397,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":402,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":408,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[403,404,405,406,407]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2020-12-01","ScopeType":8,"Body":400}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":410,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":411,"Flags":10,"Description":"The resource api version"},"properties":{"Type":413,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":414,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2020-12-01","ScopeType":8,"Body":412}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":416,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":417,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2020-12-01","ScopeType":8,"Body":418}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":420,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":421,"Flags":10,"Description":"The resource api version"},"properties":{"Type":423,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":426,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":429,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":432,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":436,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[424,425]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[427,428]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[430,431]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[433,434,435]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2020-12-01","ScopeType":8,"Body":422}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":438,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":439,"Flags":10,"Description":"The resource api version"},"properties":{"Type":441,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-12-01","ScopeType":8,"Body":440}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":443,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":444,"Flags":10,"Description":"The resource api version"},"properties":{"Type":446,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2020-12-01","ScopeType":8,"Body":445}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":448,"Flags":9,"Description":"The resource name"},"type":{"Type":449,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":450,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2020-12-01","ScopeType":8,"Body":451}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":453,"Flags":9,"Description":"The resource name"},"type":{"Type":454,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":455,"Flags":10,"Description":"The resource api version"},"properties":{"Type":457,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2020-12-01","ScopeType":8,"Body":456}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":459,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":460,"Flags":10,"Description":"The resource api version"},"properties":{"Type":462,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":463,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2020-12-01","ScopeType":8,"Body":461}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":465,"Flags":9,"Description":"The resource name"},"type":{"Type":466,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":467,"Flags":10,"Description":"The resource api version"},"properties":{"Type":469,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":473,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":472,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":471}},{"3":{"ItemType":470}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2020-12-01","ScopeType":8,"Body":468}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":475,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":476,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":479,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":480,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":481,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":477}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":483,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":484,"Flags":10,"Description":"The resource api version"},"properties":{"Type":486,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":490,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[487,488,489]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2020-12-01","ScopeType":8,"Body":485}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":492,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":493,"Flags":10,"Description":"The resource api version"},"properties":{"Type":495,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":498,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":499,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[496,497]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2020-12-01","ScopeType":8,"Body":494}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":501,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":502,"Flags":10,"Description":"The resource api version"},"properties":{"Type":42,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":504,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2020-12-01","ScopeType":8,"Body":503}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":506,"Flags":9,"Description":"The resource name"},"type":{"Type":507,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":508,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":510,"Flags":9,"Description":"The resource name"},"type":{"Type":511,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":512,"Flags":10,"Description":"The resource api version"},"properties":{"Type":195,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":509,"scm":513}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2020-12-01","ScopeType":8,"Body":514}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":516,"Flags":9,"Description":"The resource name"},"type":{"Type":517,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":518,"Flags":10,"Description":"The resource api version"},"properties":{"Type":520,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":521,"Flags":9,"Description":"The resource name"},"type":{"Type":522,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":523,"Flags":10,"Description":"The resource api version"},"properties":{"Type":211,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":525,"Flags":9,"Description":"The resource name"},"type":{"Type":526,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":527,"Flags":10,"Description":"The resource api version"},"properties":{"Type":233,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":529,"Flags":9,"Description":"The resource name"},"type":{"Type":530,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":531,"Flags":10,"Description":"The resource api version"},"properties":{"Type":533,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":157}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":534,"Flags":9,"Description":"The resource name"},"type":{"Type":535,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":536,"Flags":10,"Description":"The resource api version"},"properties":{"Type":303,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":538,"Flags":9,"Description":"The resource name"},"type":{"Type":539,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":540,"Flags":10,"Description":"The resource api version"},"properties":{"Type":542,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":319}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":543,"Flags":9,"Description":"The resource name"},"type":{"Type":544,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":545,"Flags":10,"Description":"The resource api version"},"properties":{"Type":337,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":547,"Flags":9,"Description":"The resource name"},"type":{"Type":548,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":549,"Flags":10,"Description":"The resource api version"},"properties":{"Type":551,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":552,"Flags":9,"Description":"The resource name"},"type":{"Type":553,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":554,"Flags":10,"Description":"The resource api version"},"properties":{"Type":133,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":556,"Flags":9,"Description":"The resource name"},"type":{"Type":557,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":558,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":519,"authsettings":524,"authsettingsV2":528,"azurestorageaccounts":532,"backup":537,"connectionstrings":541,"logs":546,"metadata":550,"pushsettings":555,"web":559}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2020-12-01","ScopeType":8,"Body":560}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":562,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":563,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2020-12-01","ScopeType":8,"Body":564}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":395,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2020-12-01","ScopeType":8,"Body":568}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":570,"Flags":9,"Description":"The resource name"},"type":{"Type":571,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":572,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2020-12-01","ScopeType":8,"Body":573}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":575,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":576,"Flags":10,"Description":"The resource api version"},"properties":{"Type":413,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2020-12-01","ScopeType":8,"Body":577}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":579,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":580,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2020-12-01","ScopeType":8,"Body":581}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":583,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":584,"Flags":10,"Description":"The resource api version"},"properties":{"Type":423,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2020-12-01","ScopeType":8,"Body":585}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":587,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":588,"Flags":10,"Description":"The resource api version"},"properties":{"Type":441,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2020-12-01","ScopeType":8,"Body":589}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":591,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":592,"Flags":10,"Description":"The resource api version"},"properties":{"Type":446,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2020-12-01","ScopeType":8,"Body":593}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":595,"Flags":9,"Description":"The resource name"},"type":{"Type":596,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":597,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2020-12-01","ScopeType":8,"Body":598}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":600,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":601,"Flags":10,"Description":"The resource api version"},"properties":{"Type":462,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":603,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2020-12-01","ScopeType":8,"Body":602}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":605,"Flags":9,"Description":"The resource name"},"type":{"Type":606,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":607,"Flags":10,"Description":"The resource api version"},"properties":{"Type":469,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2020-12-01","ScopeType":8,"Body":608}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":610,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":611,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":612}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":614,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":615,"Flags":10,"Description":"The resource api version"},"properties":{"Type":486,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2020-12-01","ScopeType":8,"Body":616}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":618,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":619,"Flags":10,"Description":"The resource api version"},"properties":{"Type":495,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2020-12-01","ScopeType":8,"Body":620}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":622,"Flags":9,"Description":"The resource name"},"type":{"Type":623,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":624,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":627,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":628,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":629,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2020-12-01","ScopeType":8,"Body":625}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":631,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":632,"Flags":10,"Description":"The resource api version"},"properties":{"Type":634,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":641,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":636,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":0,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":0,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":640,"Flags":0,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[637,638,639,4]}},{"3":{"ItemType":635}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2020-12-01","ScopeType":8,"Body":633}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":643,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":644,"Flags":10,"Description":"The resource api version"},"properties":{"Type":646,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2020-12-01","ScopeType":8,"Body":645}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":648,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2020-12-01","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":653,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":654,"Flags":10,"Description":"The resource api version"},"properties":{"Type":634,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2020-12-01","ScopeType":8,"Body":655}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":657,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":658,"Flags":10,"Description":"The resource api version"},"properties":{"Type":646,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2020-12-01","ScopeType":8,"Body":659}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"A static site."},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":690,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":665,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":666,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":682,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":685,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":686,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":689,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":668,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":669,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":670,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":678,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":181,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":681,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":671,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":480,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":479,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":672,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":674,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":675,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":677,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":676}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":679,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":680,"Flags":0,"Description":"Inner errors."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":678}},{"3":{"ItemType":4}},{"3":{"ItemType":667}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[683,684]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":688,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":687}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2020-12-01","ScopeType":8,"Body":663}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":692,"Flags":9,"Description":"The resource name"},"type":{"Type":693,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":694,"Flags":10,"Description":"The resource api version"},"properties":{"Type":696,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":697,"Flags":9,"Description":"The resource name"},"type":{"Type":698,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":699,"Flags":10,"Description":"The resource api version"},"properties":{"Type":701,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":695,"functionappsettings":700}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2020-12-01","ScopeType":8,"Body":702}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":704,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":705,"Flags":10,"Description":"The resource api version"},"properties":{"Type":707,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2020-12-01","ScopeType":8,"Body":706}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":709,"Flags":9,"Description":"The resource name"},"type":{"Type":710,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":711,"Flags":10,"Description":"The resource api version"},"properties":{"Type":713,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":714,"Flags":9,"Description":"The resource name"},"type":{"Type":715,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":716,"Flags":10,"Description":"The resource api version"},"properties":{"Type":718,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":712,"functionappsettings":717}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2020-12-01","ScopeType":8,"Body":719}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":724,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":731,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[725,726,727,728,729,730,4]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2020-12-01","ScopeType":8,"Body":723}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":733,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":734,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":735}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":737,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":738,"Flags":10,"Description":"The resource api version"},"properties":{"Type":707,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2020-12-01","ScopeType":8,"Body":739}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":741,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":742,"Flags":10,"Description":"The resource api version"},"properties":{"Type":744,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":764,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":750,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"status":{"Type":755,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":756,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":761,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":762,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":763,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":2,"Description":"Dedicated Host Count"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[745,746,747,748,749]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[751,752,753,754]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[757,758,759,760,4]}},{"3":{"ItemType":63}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2020-12-01","ScopeType":8,"Body":743}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":766,"Flags":9,"Description":"The resource name"},"type":{"Type":767,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":768,"Flags":10,"Description":"The resource api version"},"properties":{"Type":770,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":771,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":772,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2020-12-01","ScopeType":8,"Body":769}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":774,"Flags":9,"Description":"The resource name"},"type":{"Type":775,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":776,"Flags":10,"Description":"The resource api version"},"properties":{"Type":778,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":782,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":783,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[779,780,781]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2020-12-01","ScopeType":8,"Body":777}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":785,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":786,"Flags":10,"Description":"The resource api version"},"properties":{"Type":478,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2020-12-01","ScopeType":8,"Body":787}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":789,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":790,"Flags":10,"Description":"The resource api version"},"properties":{"Type":778,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2020-12-01","ScopeType":8,"Body":791}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":793,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":794,"Flags":10,"Description":"The resource api version"},"properties":{"Type":796,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":673,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":808,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":800,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":13,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":806,"Flags":2,"Description":"Provisioning state of the App Service Environment."},"kubeEnvironmentProfile":{"Type":807,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[797,798,799]}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[801,802,803,804,805]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2020-12-01","ScopeType":8,"Body":795}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":810,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":811,"Flags":10,"Description":"The resource api version"},"properties":{"Type":646,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2020-12-01","ScopeType":8,"Body":812}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2020-12-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2020-12-01","ScopeType":8,"Body":816}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":303,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":820,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":831,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":832,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[821,822,823,824,825,826,827,828,829,830]}},{"3":{"ItemType":308}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2020-12-01","Output":819,"Input":818}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":835,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-12-01","Output":834}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2020-12-01","Output":838}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":841,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":842,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2020-12-01","Output":840}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":845,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":819}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-12-01","Output":844}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2020-12-01","Output":838}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2020-12-01","Output":819,"Input":818}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2020-12-01","Output":838}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2020-12-01","Output":840}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-12-01","Output":844}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2020-12-01","Output":838}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":858,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":857,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":856}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2020-12-01","Output":855}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":834}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":864,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":863}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":834}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2020-12-01","Output":834}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":869,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2020-12-01","Output":868}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2020-12-01/types.md b/generated/web/microsoft.web/2020-12-01/types.md index d40340ceaa..afdd51f26c 100644 --- a/generated/web/microsoft.web/2020-12-01/types.md +++ b/generated/web/microsoft.web/2020-12-01/types.md @@ -962,40 +962,39 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2020-12-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **domainValidationMethod**: string: Method of domain validation for free cert -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## HostingEnvironmentProfile +## ApiDefinitionInfo ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **url**: string: The URL of the API definition. -## ResourceTags +## ApiManagementConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: APIM-Api Identifier. + +## Apple +### Properties +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider + +## AppleRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppRegistration +### Properties +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. ## AppServiceEnvironment ### Properties @@ -1004,7 +1003,7 @@ This is valid for all deployment slots in an app. * **dnsSuffix**: string: DNS suffix of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool (ReadOnly): Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **maximumNumberOfMachines**: int (ReadOnly): Maximum number of VMs in the App Service Environment. * **multiRoleCount**: int (ReadOnly): Number of front-end instances. @@ -1016,87 +1015,6 @@ This is valid for all deployment slots in an app. * **userWhitelistedIpRanges**: string[]: User added ip ranges to whitelist on ASE db * **virtualNetwork**: [VirtualNetworkProfile](#virtualnetworkprofile) (Required): Specification for using a Virtual Network. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## VirtualNetworkProfile -### Properties -* **id**: string (Required): Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AseV3NetworkingConfigurationProperties -### Properties -* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE -* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem -* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## PrivateLinkConnectionApprovalRequest -### Properties -* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkConnectionState -### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -1121,277 +1039,122 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## KubeEnvironmentProfile +## ArmIdWrapper ### Properties -* **id**: string: Resource ID of the Kubernetes Environment. -* **name**: string (ReadOnly): Name of the Kubernetes Environment. -* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. +* **id**: string (ReadOnly) -## ResourceTags +## ArmPlan ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **name**: string: The name. +* **product**: string: The product. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher. +* **version**: string: Version of product. -## VnetGatewayProperties +## AseV3NetworkingConfigurationProperties ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE +* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem +* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem -## VnetRouteProperties +## AuthPlatform ### Properties -* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC': 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. -* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **configFilePath**: string: 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. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## ManagedServiceIdentity +## AutoHealActions ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealCustomAction ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoHealRules ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## SiteProperties +## AutoHealTriggers ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **storageAccountRequired**: bool: Checks if Customer provided storage account is required -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. -* **virtualNetworkSubnetId**: 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} +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. -## CloningInfo +## AzureActiveDirectory ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. - -## CloningInfoAppSettingsOverrides -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostNameSslState -### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. - -## SiteConfig -### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans -* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site -This setting only applies to the Elastic Plans -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publicNetworkAccess**: string: Property to allow or block all public traffic. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **websiteTimeZone**: 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 -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id - -## ApiDefinitionInfo -### Properties -* **url**: string: The URL of the API definition. - -## ApiManagementConfig -### Properties -* **id**: string: APIM-Api Identifier. - -## AutoHealRules -### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. - -## AutoHealActions -### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. -## AutoHealCustomAction +## AzureActiveDirectoryLogin ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". -## AutoHealTriggers +## AzureActiveDirectoryRegistration ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 -## RequestsBasedTrigger +## AzureActiveDirectoryValidation ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. -## SlowRequestsBasedTrigger +## AzureBlobStorageApplicationLogsConfig ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## StatusCodesBasedTrigger +## AzureBlobStorageHttpLogsConfig ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## StatusCodesRangeBasedTrigger +## AzureStaticWebApps ### Properties -* **count**: int: Request Count. -* **path**: string -* **statusCodes**: string: HTTP status code. -* **timeInterval**: string: Time interval. +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider -## SiteConfigAzureStorageAccounts +## AzureStaticWebAppsRegistration ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **clientId**: string: The Client ID of the app used for login. ## AzureStorageInfoValue ### Properties @@ -1402,259 +1165,270 @@ before taking the action * **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. * **type**: 'AzureBlob' | 'AzureFiles': Type of storage. -## ConnStringInfo +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## CorsSettings +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## Experiments +## AzureTableStorageApplicationLogsConfig ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## RampUpRule +## BackupItem ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## HandlerMapping +## BackupItem ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## IpSecurityRestriction +## BackupItemCollection ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -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. +## BackupItemCollection +### Properties +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## BackupItemProperties +### Properties +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## IpSecurityRestrictionHeaders +## BackupRequest ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SiteLimits +## BackupRequest ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SiteMachineKey +## BackupRequestProperties ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## PushSettings +## BackupSchedule ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## PushSettingsProperties +## BlobStorageTokenStore ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. -## VirtualApplication +## Capability ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. -## VirtualDirectory +## CertificateProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **domainValidationMethod**: string: Method of domain validation for free cert +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. -## SlotSwapStatus +## ClientRegistration ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. -## ResourceTags +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties * **Additional Properties Type**: string +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnStringInfo +### Properties +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. + +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CookieExpiration +### Properties +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. + +## CorsSettings +### Properties +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. + ## CsmPublishingCredentialsPoliciesEntityProperties ### Properties * **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## StringDictionaryProperties +## CustomOpenIdConnectProvider ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. -## SiteAuthSettingsProperties +## DatabaseBackupSetting ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **configVersion**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## SiteAuthSettingsV2Properties +## DeploymentProperties ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## GlobalValidation +## EnabledConfig ### Properties -* **excludedPaths**: string[]: The paths for which unauthenticated flow would not be redirected to the login page. -* **redirectToProvider**: 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". -* **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## HttpSettings +## ErrorEntity ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. -* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. +* **code**: string: Basic error code. +* **extendedCode**: string: Type of error. +* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. +* **message**: string: Any details of the error. +* **messageTemplate**: string: Message template. +* **parameters**: string[]: Parameters for the template. + +## Experiments +### Properties +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. + +## Facebook +### Properties +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets + +## FileSystemApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. + +## FileSystemHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. + +## FileSystemTokenStore +### Properties +* **directory**: string: The directory in which the tokens will be stored. ## ForwardProxy ### Properties @@ -1662,179 +1436,259 @@ action is set to "RedirectToLoginPage". * **customHostHeaderName**: string: The name of the header containing the host of the request. * **customProtoHeaderName**: string: The name of the header containing the scheme of the request. -## HttpSettingsRoutes +## FunctionEnvelopeProperties +### Properties +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. + +## FunctionEnvelopePropertiesFiles +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## FunctionSecrets +### Properties +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## GitHub +### Properties +* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets + +## GitHubActionCodeConfiguration +### Properties +* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. +* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. + +## GitHubActionConfiguration +### Properties +* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. +* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. +* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. +* **isLinux**: bool: This will help determine the workflow configuration to select. + +## GitHubActionContainerConfiguration ### Properties -* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. +* **imageName**: string: The image name for the build. +* **password**: string: The password used to upload the image to the container registry. +* **serverUrl**: string: The server URL for the container registry where the build will be hosted. +* **username**: string: The username used to upload the image to the container registry. -## IdentityProviders +## GlobalValidation ### Properties -* **apple**: [Apple](#apple): The configuration settings of the Apple provider. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. -* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. -* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. -* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. -* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. -* **google**: [Google](#google): The configuration settings of the Google provider. -* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. -* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. +* **excludedPaths**: string[]: The paths for which unauthenticated flow would not be redirected to the login page. +* **redirectToProvider**: 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". +* **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. -## Apple +## Google ### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. * **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## LoginScopes +## HandlerMapping ### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## AppleRegistration +## HostingEnvironmentProfile ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## AzureActiveDirectory +## HostKeys ### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureActiveDirectoryLogin +## HostKeys ### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureActiveDirectoryRegistration +## HostKeysFunctionKeys ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +### Additional Properties +* **Additional Properties Type**: string -## AzureActiveDirectoryValidation +## HostKeysSystemKeys ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +### Additional Properties +* **Additional Properties Type**: string -## JwtClaimChecks +## HostNameBindingProperties ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AzureStaticWebApps +## HostNameSslState ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AzureStaticWebAppsRegistration +## HttpLogsConfig ### Properties -* **clientId**: string: The Client ID of the app used for login. +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## IdentityProvidersCustomOpenIdConnectProviders +## HttpSettings ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. +* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## CustomOpenIdConnectProvider +## HttpSettingsRoutes ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. -## OpenIdConnectLogin +## HybridConnectionKey ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## OpenIdConnectRegistration +## HybridConnectionKeyProperties ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## OpenIdConnectClientCredential +## HybridConnectionProperties ### Properties -* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. -* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## OpenIdConnectConfig +## IdentifierProperties ### Properties -* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. -* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. -* **issuer**: string: The endpoint that issues the token. -* **tokenEndpoint**: string: The endpoint to be used to request a token. -* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. +* **id**: string: String representation of the identity. -## Facebook +## IdentityProviders ### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets +* **apple**: [Apple](#apple): The configuration settings of the Apple provider. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. +* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. +* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. +* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. +* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. +* **google**: [Google](#google): The configuration settings of the Google provider. +* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. +* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## AppRegistration +## IdentityProvidersCustomOpenIdConnectProviders ### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## GitHub +## IpSecurityRestriction ### Properties -* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## ClientRegistration +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. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +### Additional Properties +* **Additional Properties Type**: string[] -## Google +## JwtClaimChecks ### Properties -* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## AllowedAudiencesValidation +## KubeEnvironmentProfile ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **id**: string: Resource ID of the Kubernetes Environment. +* **name**: string (ReadOnly): Name of the Kubernetes Environment. +* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. ## LegacyMicrosoftAccount ### Properties * **enabled**: bool: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. * **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. - -## Twitter -### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. - -## TwitterRegistration -### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. ## Login ### Properties @@ -1847,288 +1701,432 @@ Note that URLs within the current domain are always implicitly allowed. * **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. * **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. -## CookieExpiration -### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. - -## Nonce -### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. - ## LoginRoutes ### Properties * **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## TokenStore +## LoginScopes ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. -* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. -* **tokenRefreshExtensionHours**: int: 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. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## BlobStorageTokenStore +## ManagedServiceIdentity ### Properties -* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## FileSystemTokenStore +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **directory**: string: The directory in which the tokens will be stored. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) -## AuthPlatform +## MSDeployCore ### Properties -* **configFilePath**: string: 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. -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## AzureStoragePropertyDictionaryResourceProperties +## MSDeployCoreSetParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## BackupRequestProperties +## NameValuePair ### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. +* **name**: string: Pair name. +* **value**: string: Pair value. -## BackupSchedule +## Nonce ### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. -## DatabaseBackupSetting +## OpenIdConnectClientCredential ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. +* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. -## ConnectionStringDictionaryProperties +## OpenIdConnectConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. +* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. +* **issuer**: string: The endpoint that issues the token. +* **tokenEndpoint**: string: The endpoint to be used to request a token. +* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## ConnStringValueTypePair +## OpenIdConnectLogin ### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## SiteLogsConfigProperties +## OpenIdConnectRegistration ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. -## ApplicationLogsConfig +## PremierAddOnProperties ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## AzureBlobStorageApplicationLogsConfig +## PrivateAccessProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## AzureTableStorageApplicationLogsConfig +## PrivateAccessSubnet ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## FileSystemApplicationLogsConfig +## PrivateAccessVirtualNetwork ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## EnabledConfig +## PrivateLinkConnectionApprovalRequest ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## HttpLogsConfig +## PrivateLinkConnectionState ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## AzureBlobStorageHttpLogsConfig +## PublicCertificateProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FileSystemHttpLogsConfig +## PushSettings ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## SlotConfigNames +## RampUpRule ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. -## DeploymentProperties +## RelayServiceConnectionEntityProperties ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## IdentifierProperties +## RemotePrivateEndpointConnection ### Properties -* **id**: string: String representation of the identity. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties +* **type**: string (ReadOnly): Resource type. -## MSDeployCore +## RemotePrivateEndpointConnectionProperties ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## MSDeployCoreSetParameters +## RequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## ResourceTags ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +### Additional Properties +* **Additional Properties Type**: string -## FunctionEnvelopePropertiesFiles +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostNameBindingProperties +## ResourceTags ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: string -## RelayServiceConnectionEntityProperties +## ResourceTags ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionProperties +## ResourceTags ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +### Additional Properties +* **Additional Properties Type**: string -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string -## ResourceTags +## ResponseMessageEnvelopeRemotePrivateEndpointConnection +### Properties +* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. +* **id**: string: 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} +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. +* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. +* **name**: string: Name of resource. +* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. +* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection +* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. +* **status**: string: Azure-AsyncOperation Status info. +* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. +* **type**: string: Type of resource e.g "Microsoft.Web/sites". +* **zones**: string[]: Logical Availability Zones the service is hosted in + +## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## SiteAuthSettingsProperties ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **configVersion**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PrivateAccessVirtualNetwork +## SiteAuthSettingsV2Properties ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. -## PrivateAccessSubnet +## SiteConfig ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans +* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site +This setting only applies to the Elastic Plans +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publicNetworkAccess**: string: Property to allow or block all public traffic. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **websiteTimeZone**: 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 +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id -## PublicCertificateProperties +## SiteConfigAzureStorageAccounts ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -2153,35 +2151,77 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **storageAccountRequired**: bool: Checks if Customer provided storage account is required +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **virtualNetworkSubnetId**: 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} ## SiteSourceControlProperties ### Properties @@ -2193,43 +2233,43 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## GitHubActionConfiguration +## SkuCapacity ### Properties -* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. -* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. -* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. -* **isLinux**: bool: This will help determine the workflow configuration to select. +* **default**: int: Default number of workers for this App Service plan SKU. +* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## GitHubActionCodeConfiguration +## SkuDescription ### Properties -* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. -* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. -## GitHubActionContainerConfiguration +## SlotConfigNames ### Properties -* **imageName**: string: The image name for the build. -* **password**: string: The password used to upload the image to the container registry. -* **serverUrl**: string: The server URL for the container registry where the build will be hosted. -* **username**: string: The username used to upload the image to the container registry. +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. -## VnetInfoProperties +## SlotSwapStatus ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. -## VnetRoute +## SlowRequestsBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **path**: string: Request Path. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2266,59 +2306,14 @@ Point-To-Site VPN connection. * **outputLocation**: string: The output path of the app after building. * **skipGithubActionWorkflowGeneration**: bool: Skip Github Action workflow generation. -## ResponseMessageEnvelopeRemotePrivateEndpointConnection -### Properties -* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. -* **id**: string: 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} -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. -* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. -* **name**: string: Name of resource. -* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. -* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection -* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. -* **status**: string: Azure-AsyncOperation Status info. -* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. -* **type**: string: Type of resource e.g "Microsoft.Web/sites". -* **zones**: string[]: Logical Availability Zones the service is hosted in - -## ErrorEntity -### Properties -* **code**: string: Basic error code. -* **extendedCode**: string: Type of error. -* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. -* **message**: string: Any details of the error. -* **messageTemplate**: string: Message template. -* **parameters**: string[]: Parameters for the template. - -## ArmPlan -### Properties -* **name**: string: The name. -* **product**: string: The product. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher. -* **version**: string: Version of product. - -## RemotePrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties -* **type**: string (ReadOnly): Resource type. - -## RemotePrivateEndpointConnectionProperties -### Properties -* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags +## StaticSiteCustomDomainRequestPropertiesARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. +* **domainName**: string (ReadOnly): The domain name for the static site custom domain. +* **errorMessage**: string (ReadOnly) +* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' | string (ReadOnly): The status of the custom domain +* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain +* **validationToken**: string (ReadOnly): The TXT record validation token ## StaticSiteTemplateOptions ### Properties @@ -2328,34 +2323,33 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **repositoryName**: string: Name of the newly generated repository. * **templateRepositoryUrl**: string: URL of the template repository. The newly generated repository will be based on this one. -## StaticSiteUserProvidedFunctionApp +## StaticSiteUserARMResource ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserProvidedFunctionAppProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. -* **functionAppRegion**: string: The region of the function app registered with the static site -* **functionAppResourceId**: string: The resource id of the function app registered with the static site - -## ResourceTags +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string +## StaticSiteUserProvidedFunctionApp +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **type**: string (ReadOnly): Resource type. ## StaticSiteUserProvidedFunctionAppARMResourceProperties ### Properties @@ -2363,57 +2357,27 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **functionAppRegion**: string: The region of the function app registered with the static site * **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StaticSiteCustomDomainRequestPropertiesARMResourceProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. -* **domainName**: string (ReadOnly): The domain name for the static site custom domain. -* **errorMessage**: string (ReadOnly) -* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' (ReadOnly): The status of the custom domain -* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain -* **validationToken**: string (ReadOnly): The TXT record validation token - -## BackupRequest +## StaticSiteUserProvidedFunctionAppProperties ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. +* **functionAppRegion**: string: The region of the function app registered with the static site +* **functionAppResourceId**: string: The resource id of the function app registered with the static site -## BackupItem +## StatusCodesBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **path**: string: Request Path +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupItemProperties +## StatusCodesRangeBasedTrigger ### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. +* **count**: int: Request Count. +* **path**: string +* **statusCodes**: string: HTTP status code. +* **timeInterval**: string: Time interval. ## StringDictionary ### Properties @@ -2423,25 +2387,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2468,22 +2419,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## StringList +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: string[] (ReadOnly): List of string resources. +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2510,94 +2451,153 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## StringDictionaryProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +### Additional Properties +* **Additional Properties Type**: string -## FunctionSecrets +## StringDictionaryProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +### Additional Properties +* **Additional Properties Type**: string -## FunctionSecrets +## StringDictionaryProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringList ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: string[] (ReadOnly): List of string resources. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## SwiftVirtualNetworkProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## FunctionSecrets +## TokenStore ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. +* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. +* **tokenRefreshExtensionHours**: int: 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. -## StaticSiteUserCollection +## Twitter ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## StaticSiteUserARMResource +## TwitterRegistration +### Properties +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. + +## UserProperties +### Properties +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. + +## VirtualApplication +### Properties +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. + +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualNetworkProfile +### Properties +* **id**: string (Required): Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | 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. +* **startAddress**: string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2021-01-01/types.json b/generated/web/microsoft.web/2021-01-01/types.json index c348baa33d..0885001428 100644 --- a/generated/web/microsoft.web/2021-01-01/types.json +++ b/generated/web/microsoft.web/2021-01-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":2,"Description":"Dedicated Host Count"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-01-01","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-01-01","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":42,"Flags":9,"Description":"The resource name"},"type":{"Type":43,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":44,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":50,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":51,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":53,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":54,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":56,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":55}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-01","ScopeType":8,"Body":45}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":58,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":59,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":64,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":60}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":66,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":67,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-01-01","ScopeType":8,"Body":68}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":87,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":77,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":84,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":85,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[74,75,76]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[79,80,81,82,83]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-01-01","ScopeType":8,"Body":72}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":89,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":90,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-01","ScopeType":8,"Body":91}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":94,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":95,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":101,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[98,99,100]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-01","ScopeType":8,"Body":96}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":103,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":104,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":120,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":107,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":78,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":119,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[108,109,110,111,112,113,114,115,116,117,118]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-01-01","ScopeType":8,"Body":105}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":122,"Flags":9,"Description":"The resource name"},"type":{"Type":123,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":124,"Flags":10,"Description":"The resource api version"},"properties":{"Type":126,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-01-01","ScopeType":1,"Body":125}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":128,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":129,"Flags":10,"Description":"The resource api version"},"properties":{"Type":131,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-01-01","ScopeType":1,"Body":130}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":133,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":134,"Flags":10,"Description":"The resource api version"},"properties":{"Type":136,"Flags":0,"Description":"A static site."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":165,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":137,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":138,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":157,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":160,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":161,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":164,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":140,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":141,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":142,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":145,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":156,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":143,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":144,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":146,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":147,"Flags":0,"Description":"Inner errors."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":145}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":153,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":155,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[149,150,151,152]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":154}},{"3":{"ItemType":4}},{"3":{"ItemType":139}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[158,159]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":163,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":162}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-01-01","ScopeType":8,"Body":135}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":167,"Flags":9,"Description":"The resource name"},"type":{"Type":168,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":169,"Flags":10,"Description":"The resource api version"},"properties":{"Type":171,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":172,"Flags":9,"Description":"The resource name"},"type":{"Type":173,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":174,"Flags":10,"Description":"The resource api version"},"properties":{"Type":176,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":170,"functionappsettings":175}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-01-01","ScopeType":8,"Body":177}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":179,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":180,"Flags":10,"Description":"The resource api version"},"properties":{"Type":182,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-01","ScopeType":8,"Body":181}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":184,"Flags":9,"Description":"The resource name"},"type":{"Type":185,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":186,"Flags":10,"Description":"The resource api version"},"properties":{"Type":188,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":189,"Flags":9,"Description":"The resource name"},"type":{"Type":190,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":191,"Flags":10,"Description":"The resource api version"},"properties":{"Type":193,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":187,"functionappsettings":192}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-01-01","ScopeType":8,"Body":194}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":196,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":197,"Flags":10,"Description":"The resource api version"},"properties":{"Type":199,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":206,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[200,201,202,203,204,205]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-01-01","ScopeType":8,"Body":198}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":208,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":209,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":210}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":212,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":213,"Flags":10,"Description":"The resource api version"},"properties":{"Type":182,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-01","ScopeType":8,"Body":214}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":216,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":217,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":357,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":220,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":223,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":224,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":228,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":237,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":238,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":343,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":347,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":348,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":350,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":356,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[221,222]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[225,226,227]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":233,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":236,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[230,231,232]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[234,235]}},{"3":{"ItemType":229}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":239,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":240,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":254,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":255,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":257,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":272,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":275,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":279,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":286,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":287,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":290,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":291,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":306,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":308,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":310,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":311,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":319,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":320,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":324,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":328,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":332,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":342,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":253,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[242,243,244,245,246,247,248,249,250,251,252]}},{"3":{"ItemType":241}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":256}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[258,259,260,261,262,263,264,265,266,267,268,269,270,271]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[273,274]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":278,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":277}},{"3":{"ItemType":276}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[280,281,282,283,284,285]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":289,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":288}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":292,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":300,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":293,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":295,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":296,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":297,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":299,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":294}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":296}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":298}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":304,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":305,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[301,302,303]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":307,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":309,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":316,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":318,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[313,314,315]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":317}},{"3":{"ItemType":312}},{"3":{"ItemType":312}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[321,322,323]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[325,326,327]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[329,330,331]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":336,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":341,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[334,335]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[337,338,339,340]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":333}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[344,345,346]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":349,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[351,352,353,354,355]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-01-01","ScopeType":8,"Body":218}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":359,"Flags":9,"Description":"The resource name"},"type":{"Type":360,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":361,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":362,"scm":367}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-01","ScopeType":8,"Body":368}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":370,"Flags":9,"Description":"The resource name"},"type":{"Type":371,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":372,"Flags":10,"Description":"The resource api version"},"properties":{"Type":374,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":375,"Flags":9,"Description":"The resource name"},"type":{"Type":376,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":377,"Flags":10,"Description":"The resource api version"},"properties":{"Type":379,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":382,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":383,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":390,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":391,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":392,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":393,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":394,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":395,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":396,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[380,381]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[384,385,386,387,388,389]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":397,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":402,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":403,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":410,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":444,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":455,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":408,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":409,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[404,405,406,407]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":411,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":420,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":424,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":426,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":429,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":430,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":432,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":434,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":443,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":412,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":413,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":415,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":414,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":416,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":419,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":417,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":418,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":421,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":423,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":425,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":425,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":427,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":428,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":425,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":427,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":431,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":433,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":435,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":437,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":441,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":438,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":440,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":439,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":442,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":436}},{"2":{"Name":"Login","Properties":{"routes":{"Type":445,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":446,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":449,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":450,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":454,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":447,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":448,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":453,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[451,452]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":456,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":457,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":461,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[458,459,460]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":462,"Flags":9,"Description":"The resource name"},"type":{"Type":463,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":464,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":333}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":467,"Flags":9,"Description":"The resource name"},"type":{"Type":468,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":469,"Flags":10,"Description":"The resource api version"},"properties":{"Type":471,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":472,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":482,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":475,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[473,474]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":481,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[477,478,479,480]}},{"3":{"ItemType":476}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":483,"Flags":9,"Description":"The resource name"},"type":{"Type":484,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":485,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":499,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[488,489,490,491,492,493,494,495,496,497,498]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":487}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":501,"Flags":9,"Description":"The resource name"},"type":{"Type":502,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":503,"Flags":10,"Description":"The resource api version"},"properties":{"Type":505,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":506,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":528,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":531,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":531,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":507,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":514,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":521,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":513,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[508,509,510,511,512]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":520,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[515,516,517,518,519]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":527,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[522,523,524,525,526]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":529,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":530,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":532,"Flags":9,"Description":"The resource name"},"type":{"Type":533,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":534,"Flags":10,"Description":"The resource api version"},"properties":{"Type":536,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":537,"Flags":9,"Description":"The resource name"},"type":{"Type":538,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":539,"Flags":10,"Description":"The resource api version"},"properties":{"Type":309,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":541,"Flags":9,"Description":"The resource name"},"type":{"Type":542,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":543,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":546,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":547,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":548,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":549,"Flags":9,"Description":"The resource name"},"type":{"Type":550,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":551,"Flags":10,"Description":"The resource api version"},"properties":{"Type":238,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":373,"authsettings":378,"authsettingsV2":400,"azurestorageaccounts":465,"backup":470,"connectionstrings":486,"logs":504,"metadata":535,"pushsettings":540,"slotConfigNames":544,"web":552}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-01-01","ScopeType":8,"Body":553}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":555,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":556,"Flags":10,"Description":"The resource api version"},"properties":{"Type":558,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-01-01","ScopeType":8,"Body":557}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-01","ScopeType":8,"Body":562}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":565,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":570,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":576,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[571,572,573,574,575]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-01-01","ScopeType":8,"Body":568}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":578,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":579,"Flags":10,"Description":"The resource api version"},"properties":{"Type":581,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":582,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-01-01","ScopeType":8,"Body":580}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":584,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":585,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-01-01","ScopeType":8,"Body":586}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":588,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":589,"Flags":10,"Description":"The resource api version"},"properties":{"Type":591,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":594,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":597,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":600,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":604,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[592,593]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[595,596]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[598,599]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[601,602,603]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-01-01","ScopeType":8,"Body":590}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":606,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":607,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-01","ScopeType":8,"Body":608}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":611,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":612,"Flags":10,"Description":"The resource api version"},"properties":{"Type":614,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-01-01","ScopeType":8,"Body":613}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":616,"Flags":9,"Description":"The resource name"},"type":{"Type":617,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":618,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-01-01","ScopeType":8,"Body":619}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":621,"Flags":9,"Description":"The resource name"},"type":{"Type":622,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":623,"Flags":10,"Description":"The resource api version"},"properties":{"Type":625,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-01-01","ScopeType":8,"Body":624}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":627,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":628,"Flags":10,"Description":"The resource api version"},"properties":{"Type":630,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":631,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-01-01","ScopeType":8,"Body":629}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":633,"Flags":9,"Description":"The resource name"},"type":{"Type":634,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":635,"Flags":10,"Description":"The resource api version"},"properties":{"Type":637,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":641,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":640,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":639}},{"3":{"ItemType":638}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-01-01","ScopeType":8,"Body":636}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":643,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":644,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":645}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":647,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":648,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":654,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[651,652,653]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-01-01","ScopeType":8,"Body":649}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":656,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":657,"Flags":10,"Description":"The resource api version"},"properties":{"Type":659,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":662,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":663,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[660,661]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-01-01","ScopeType":8,"Body":658}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":665,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":666,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":668,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-01-01","ScopeType":8,"Body":667}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":670,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":674,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":673,"scm":677}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-01","ScopeType":8,"Body":678}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":680,"Flags":9,"Description":"The resource name"},"type":{"Type":681,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":682,"Flags":10,"Description":"The resource api version"},"properties":{"Type":684,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":685,"Flags":9,"Description":"The resource name"},"type":{"Type":686,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":687,"Flags":10,"Description":"The resource api version"},"properties":{"Type":379,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":689,"Flags":9,"Description":"The resource name"},"type":{"Type":690,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":691,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":693,"Flags":9,"Description":"The resource name"},"type":{"Type":694,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":695,"Flags":10,"Description":"The resource api version"},"properties":{"Type":697,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":333}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":698,"Flags":9,"Description":"The resource name"},"type":{"Type":699,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":700,"Flags":10,"Description":"The resource api version"},"properties":{"Type":471,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":702,"Flags":9,"Description":"The resource name"},"type":{"Type":703,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":704,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":487}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":707,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":505,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":711,"Flags":9,"Description":"The resource name"},"type":{"Type":712,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":713,"Flags":10,"Description":"The resource api version"},"properties":{"Type":715,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":716,"Flags":9,"Description":"The resource name"},"type":{"Type":717,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":718,"Flags":10,"Description":"The resource api version"},"properties":{"Type":309,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":720,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":238,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":683,"authsettings":688,"authsettingsV2":692,"azurestorageaccounts":696,"backup":701,"connectionstrings":705,"logs":710,"metadata":714,"pushsettings":719,"web":723}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-01-01","ScopeType":8,"Body":724}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":726,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":727,"Flags":10,"Description":"The resource api version"},"properties":{"Type":558,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-01-01","ScopeType":8,"Body":728}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":730,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":731,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-01","ScopeType":8,"Body":732}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":734,"Flags":9,"Description":"The resource name"},"type":{"Type":735,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":736,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-01-01","ScopeType":8,"Body":737}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":739,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":740,"Flags":10,"Description":"The resource api version"},"properties":{"Type":581,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-01-01","ScopeType":8,"Body":741}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":743,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":744,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-01-01","ScopeType":8,"Body":745}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":747,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":748,"Flags":10,"Description":"The resource api version"},"properties":{"Type":591,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-01-01","ScopeType":8,"Body":749}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":751,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":752,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-01","ScopeType":8,"Body":753}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":755,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":756,"Flags":10,"Description":"The resource api version"},"properties":{"Type":614,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-01-01","ScopeType":8,"Body":757}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":759,"Flags":9,"Description":"The resource name"},"type":{"Type":760,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":761,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-01-01","ScopeType":8,"Body":762}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":764,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":765,"Flags":10,"Description":"The resource api version"},"properties":{"Type":630,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":767,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-01-01","ScopeType":8,"Body":766}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":769,"Flags":9,"Description":"The resource name"},"type":{"Type":770,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":771,"Flags":10,"Description":"The resource api version"},"properties":{"Type":637,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-01-01","ScopeType":8,"Body":772}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":774,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":775,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":776}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-01-01","ScopeType":8,"Body":780}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":782,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":783,"Flags":10,"Description":"The resource api version"},"properties":{"Type":659,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-01-01","ScopeType":8,"Body":784}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":786,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":790,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":791,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":792,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":793,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-01-01","ScopeType":8,"Body":789}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":795,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":796,"Flags":10,"Description":"The resource api version"},"properties":{"Type":798,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":800,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":97,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":799}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-01","ScopeType":8,"Body":797}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":802,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":803,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-01","ScopeType":8,"Body":804}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":806,"Flags":9,"Description":"The resource name"},"type":{"Type":807,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":808,"Flags":10,"Description":"The resource api version"},"properties":{"Type":790,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-01-01","ScopeType":8,"Body":809}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":811,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":812,"Flags":10,"Description":"The resource api version"},"properties":{"Type":798,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-01-01","ScopeType":8,"Body":813}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":815,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":816,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-01","ScopeType":8,"Body":817}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":819,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":820,"Flags":10,"Description":"The resource api version"},"properties":{"Type":822,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":844,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":833,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"arcConfiguration":{"Type":834,"Flags":0},"appLogsConfiguration":{"Type":842,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[823,824,825,826,827,828,829,830,831,832]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":837,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":838,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[835,836]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":841,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[839,840]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":843,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-01-01","ScopeType":8,"Body":821}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":847,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-01-01","Output":846}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":852,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":851,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":850}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-01-01","Output":849}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":855,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":854}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":860,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":859}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":854}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":471,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":866,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":877,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":878,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[867,868,869,870,871,872,873,874,875,876]}},{"3":{"ItemType":476}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-01-01","Output":865,"Input":864}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-01","Output":854}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-01","Output":882}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":885,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":886,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-01-01","Output":884}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":889,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":865}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-01","Output":888}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-01","Output":882}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-01-01","Output":865,"Input":864}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-01","Output":882}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-01-01","Output":884}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-01","Output":888}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-01","Output":882}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":2,"Description":"Dedicated Host Count"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27,4]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-01-01","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-01-01","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":42,"Flags":9,"Description":"The resource name"},"type":{"Type":43,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":44,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":50,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":51,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":53,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":54,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":56,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":55}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-01","ScopeType":8,"Body":45}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":58,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":59,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":64,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":60}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":66,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":67,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-01-01","ScopeType":8,"Body":68}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":87,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":77,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":84,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":85,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[74,75,76]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[79,80,81,82,83]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-01-01","ScopeType":8,"Body":72}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":89,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":90,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-01","ScopeType":8,"Body":91}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":94,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":95,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":101,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[98,99,100,4]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-01","ScopeType":8,"Body":96}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":103,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":104,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":120,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":107,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":78,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":119,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[108,109,110,111,112,113,114,115,116,117,118]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-01-01","ScopeType":8,"Body":105}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":122,"Flags":9,"Description":"The resource name"},"type":{"Type":123,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":124,"Flags":10,"Description":"The resource api version"},"properties":{"Type":126,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-01-01","ScopeType":1,"Body":125}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":128,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":129,"Flags":10,"Description":"The resource api version"},"properties":{"Type":131,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-01-01","ScopeType":1,"Body":130}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":133,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":134,"Flags":10,"Description":"The resource api version"},"properties":{"Type":136,"Flags":0,"Description":"A static site."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":165,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":137,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":138,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":157,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":160,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":161,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":164,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":140,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":141,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":142,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":145,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":156,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":143,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":144,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":146,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":147,"Flags":0,"Description":"Inner errors."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":145}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":153,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":155,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[149,150,151,152]}},{"2":{"Name":"Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":154}},{"3":{"ItemType":4}},{"3":{"ItemType":139}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[158,159]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":163,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":162}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-01-01","ScopeType":8,"Body":135}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":167,"Flags":9,"Description":"The resource name"},"type":{"Type":168,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":169,"Flags":10,"Description":"The resource api version"},"properties":{"Type":171,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":172,"Flags":9,"Description":"The resource name"},"type":{"Type":173,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":174,"Flags":10,"Description":"The resource api version"},"properties":{"Type":176,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":170,"functionappsettings":175}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-01-01","ScopeType":8,"Body":177}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":179,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":180,"Flags":10,"Description":"The resource api version"},"properties":{"Type":182,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-01","ScopeType":8,"Body":181}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":184,"Flags":9,"Description":"The resource name"},"type":{"Type":185,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":186,"Flags":10,"Description":"The resource api version"},"properties":{"Type":188,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":189,"Flags":9,"Description":"The resource name"},"type":{"Type":190,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":191,"Flags":10,"Description":"The resource api version"},"properties":{"Type":193,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":187,"functionappsettings":192}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-01-01","ScopeType":8,"Body":194}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":196,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":197,"Flags":10,"Description":"The resource api version"},"properties":{"Type":199,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":206,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[200,201,202,203,204,205,4]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-01-01","ScopeType":8,"Body":198}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":208,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":209,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":210}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":212,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":213,"Flags":10,"Description":"The resource api version"},"properties":{"Type":182,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-01","ScopeType":8,"Body":214}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":216,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":217,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":357,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":220,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":223,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":224,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":228,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":237,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":238,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":343,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":347,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":348,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":350,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":356,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[221,222]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[225,226,227]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":233,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":236,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[230,231,232]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[234,235]}},{"3":{"ItemType":229}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":239,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":240,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":254,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":255,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":257,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":272,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":275,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":279,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":286,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":287,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":290,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":291,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":306,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":308,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":310,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":311,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":319,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":320,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":324,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":328,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":332,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":342,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":253,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[242,243,244,245,246,247,248,249,250,251,252]}},{"3":{"ItemType":241}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":256}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[258,259,260,261,262,263,264,265,266,267,268,269,270,271,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[273,274]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":278,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":277}},{"3":{"ItemType":276}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[280,281,282,283,284,285]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":289,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":288}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":292,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":300,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":293,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":295,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":296,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":297,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":299,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":294}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":296}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":298}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":304,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":305,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[301,302,303]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":307,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":309,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":316,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":318,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[313,314,315,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":317}},{"3":{"ItemType":312}},{"3":{"ItemType":312}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[321,322,323,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[325,326,327,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[329,330,331,4]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":336,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":341,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[334,335]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[337,338,339,340]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":333}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[344,345,346]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":349,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[351,352,353,354,355]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-01-01","ScopeType":8,"Body":218}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":359,"Flags":9,"Description":"The resource name"},"type":{"Type":360,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":361,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":364,"Flags":9,"Description":"The resource name"},"type":{"Type":365,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":366,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":362,"scm":367}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-01","ScopeType":8,"Body":368}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":370,"Flags":9,"Description":"The resource name"},"type":{"Type":371,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":372,"Flags":10,"Description":"The resource api version"},"properties":{"Type":374,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":375,"Flags":9,"Description":"The resource name"},"type":{"Type":376,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":377,"Flags":10,"Description":"The resource api version"},"properties":{"Type":379,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":382,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":383,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":390,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":391,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":392,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":393,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":394,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":395,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":396,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[380,381]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[384,385,386,387,388,389]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":397,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":402,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":403,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":410,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":444,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":455,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":408,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":409,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[404,405,406,407]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":411,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":420,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":424,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":426,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":429,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":430,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":432,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":434,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":443,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":412,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":413,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":415,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":414,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":416,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":419,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":417,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":418,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":421,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":423,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":425,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":425,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":427,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":428,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":425,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":427,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":431,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":433,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":422,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":435,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":437,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":441,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":438,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":440,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":439,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":442,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":436}},{"2":{"Name":"Login","Properties":{"routes":{"Type":445,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":446,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":449,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":450,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":454,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":447,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":448,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":453,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[451,452]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":456,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":457,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":461,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[458,459,460]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":462,"Flags":9,"Description":"The resource name"},"type":{"Type":463,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":464,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":333}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":467,"Flags":9,"Description":"The resource name"},"type":{"Type":468,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":469,"Flags":10,"Description":"The resource api version"},"properties":{"Type":471,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":472,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":482,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":475,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[473,474]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":481,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[477,478,479,480,4]}},{"3":{"ItemType":476}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":483,"Flags":9,"Description":"The resource name"},"type":{"Type":484,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":485,"Flags":10,"Description":"The resource api version"},"properties":{"Type":500,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":499,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[488,489,490,491,492,493,494,495,496,497,498]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":487}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":501,"Flags":9,"Description":"The resource name"},"type":{"Type":502,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":503,"Flags":10,"Description":"The resource api version"},"properties":{"Type":505,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":506,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":528,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":531,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":531,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":507,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":514,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":521,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":513,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[508,509,510,511,512]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":520,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[515,516,517,518,519]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":527,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[522,523,524,525,526]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":529,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":530,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":532,"Flags":9,"Description":"The resource name"},"type":{"Type":533,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":534,"Flags":10,"Description":"The resource api version"},"properties":{"Type":536,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":537,"Flags":9,"Description":"The resource name"},"type":{"Type":538,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":539,"Flags":10,"Description":"The resource api version"},"properties":{"Type":309,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":541,"Flags":9,"Description":"The resource name"},"type":{"Type":542,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":543,"Flags":10,"Description":"The resource api version"},"properties":{"Type":545,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":546,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":547,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":548,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":549,"Flags":9,"Description":"The resource name"},"type":{"Type":550,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":551,"Flags":10,"Description":"The resource api version"},"properties":{"Type":238,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":373,"authsettings":378,"authsettingsV2":400,"azurestorageaccounts":465,"backup":470,"connectionstrings":486,"logs":504,"metadata":535,"pushsettings":540,"slotConfigNames":544,"web":552}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-01-01","ScopeType":8,"Body":553}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":555,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":556,"Flags":10,"Description":"The resource api version"},"properties":{"Type":558,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-01-01","ScopeType":8,"Body":557}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-01","ScopeType":8,"Body":562}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":565,"Flags":9,"Description":"The resource name"},"type":{"Type":566,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":567,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":570,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":576,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[571,572,573,574,575]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-01-01","ScopeType":8,"Body":568}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":578,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":579,"Flags":10,"Description":"The resource api version"},"properties":{"Type":581,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":582,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-01-01","ScopeType":8,"Body":580}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":584,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":585,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-01-01","ScopeType":8,"Body":586}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":588,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":589,"Flags":10,"Description":"The resource api version"},"properties":{"Type":591,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":594,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":597,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":600,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":604,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[592,593]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[595,596]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[598,599]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[601,602,603]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-01-01","ScopeType":8,"Body":590}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":606,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":607,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-01","ScopeType":8,"Body":608}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":611,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":612,"Flags":10,"Description":"The resource api version"},"properties":{"Type":614,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-01-01","ScopeType":8,"Body":613}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":616,"Flags":9,"Description":"The resource name"},"type":{"Type":617,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":618,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-01-01","ScopeType":8,"Body":619}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":621,"Flags":9,"Description":"The resource name"},"type":{"Type":622,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":623,"Flags":10,"Description":"The resource api version"},"properties":{"Type":625,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-01-01","ScopeType":8,"Body":624}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":627,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":628,"Flags":10,"Description":"The resource api version"},"properties":{"Type":630,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":631,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-01-01","ScopeType":8,"Body":629}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":633,"Flags":9,"Description":"The resource name"},"type":{"Type":634,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":635,"Flags":10,"Description":"The resource api version"},"properties":{"Type":637,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":641,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":640,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":639}},{"3":{"ItemType":638}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-01-01","ScopeType":8,"Body":636}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":643,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":644,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":645}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":647,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":648,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":654,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[651,652,653]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-01-01","ScopeType":8,"Body":649}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":656,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":657,"Flags":10,"Description":"The resource api version"},"properties":{"Type":659,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":662,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":663,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[660,661]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-01-01","ScopeType":8,"Body":658}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":665,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":666,"Flags":10,"Description":"The resource api version"},"properties":{"Type":219,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":148,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":668,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-01-01","ScopeType":8,"Body":667}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":670,"Flags":9,"Description":"The resource name"},"type":{"Type":671,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":672,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":674,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":363,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":673,"scm":677}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-01","ScopeType":8,"Body":678}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":680,"Flags":9,"Description":"The resource name"},"type":{"Type":681,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":682,"Flags":10,"Description":"The resource api version"},"properties":{"Type":684,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":685,"Flags":9,"Description":"The resource name"},"type":{"Type":686,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":687,"Flags":10,"Description":"The resource api version"},"properties":{"Type":379,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":689,"Flags":9,"Description":"The resource name"},"type":{"Type":690,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":691,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":693,"Flags":9,"Description":"The resource name"},"type":{"Type":694,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":695,"Flags":10,"Description":"The resource api version"},"properties":{"Type":697,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":333}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":698,"Flags":9,"Description":"The resource name"},"type":{"Type":699,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":700,"Flags":10,"Description":"The resource api version"},"properties":{"Type":471,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":702,"Flags":9,"Description":"The resource name"},"type":{"Type":703,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":704,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":487}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":707,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":505,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":711,"Flags":9,"Description":"The resource name"},"type":{"Type":712,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":713,"Flags":10,"Description":"The resource api version"},"properties":{"Type":715,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":716,"Flags":9,"Description":"The resource name"},"type":{"Type":717,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":718,"Flags":10,"Description":"The resource api version"},"properties":{"Type":309,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":720,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":238,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":683,"authsettings":688,"authsettingsV2":692,"azurestorageaccounts":696,"backup":701,"connectionstrings":705,"logs":710,"metadata":714,"pushsettings":719,"web":723}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-01-01","ScopeType":8,"Body":724}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":726,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":727,"Flags":10,"Description":"The resource api version"},"properties":{"Type":558,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-01-01","ScopeType":8,"Body":728}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":730,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":731,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-01","ScopeType":8,"Body":732}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":734,"Flags":9,"Description":"The resource name"},"type":{"Type":735,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":736,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-01-01","ScopeType":8,"Body":737}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":739,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":740,"Flags":10,"Description":"The resource api version"},"properties":{"Type":581,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-01-01","ScopeType":8,"Body":741}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":743,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":744,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-01-01","ScopeType":8,"Body":745}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":747,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":748,"Flags":10,"Description":"The resource api version"},"properties":{"Type":591,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-01-01","ScopeType":8,"Body":749}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":751,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":752,"Flags":10,"Description":"The resource api version"},"properties":{"Type":609,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-01","ScopeType":8,"Body":753}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":755,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":756,"Flags":10,"Description":"The resource api version"},"properties":{"Type":614,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-01-01","ScopeType":8,"Body":757}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":759,"Flags":9,"Description":"The resource name"},"type":{"Type":760,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":761,"Flags":10,"Description":"The resource api version"},"properties":{"Type":569,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-01-01","ScopeType":8,"Body":762}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":764,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":765,"Flags":10,"Description":"The resource api version"},"properties":{"Type":630,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":767,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-01-01","ScopeType":8,"Body":766}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":769,"Flags":9,"Description":"The resource name"},"type":{"Type":770,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":771,"Flags":10,"Description":"The resource api version"},"properties":{"Type":637,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-01-01","ScopeType":8,"Body":772}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":774,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":775,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-01","ScopeType":8,"Body":776}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-01-01","ScopeType":8,"Body":780}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":782,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":783,"Flags":10,"Description":"The resource api version"},"properties":{"Type":659,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-01-01","ScopeType":8,"Body":784}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":786,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":790,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":791,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":792,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":793,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-01-01","ScopeType":8,"Body":789}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":795,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":796,"Flags":10,"Description":"The resource api version"},"properties":{"Type":798,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":800,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":97,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":799}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-01","ScopeType":8,"Body":797}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":802,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":803,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-01","ScopeType":8,"Body":804}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":806,"Flags":9,"Description":"The resource name"},"type":{"Type":807,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":808,"Flags":10,"Description":"The resource api version"},"properties":{"Type":790,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-01-01","ScopeType":8,"Body":809}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":811,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":812,"Flags":10,"Description":"The resource api version"},"properties":{"Type":798,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-01-01","ScopeType":8,"Body":813}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":815,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":816,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-01","ScopeType":8,"Body":817}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-01-01"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":819,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":820,"Flags":10,"Description":"The resource api version"},"properties":{"Type":822,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":844,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":833,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"arcConfiguration":{"Type":834,"Flags":0},"appLogsConfiguration":{"Type":842,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[823,824,825,826,827,828,829,830,831,832]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":837,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":838,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[835,836]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":841,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[839,840]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":843,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-01-01","ScopeType":8,"Body":821}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":847,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-01-01","Output":846}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":852,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":851,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":850}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-01-01","Output":849}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":855,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":854}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":860,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":859}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-01","Output":854}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":471,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":866,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":877,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":878,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[867,868,869,870,871,872,873,874,875,876]}},{"3":{"ItemType":476}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-01-01","Output":865,"Input":864}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-01","Output":854}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-01","Output":882}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":885,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":886,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-01-01","Output":884}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":889,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":865}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-01","Output":888}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-01","Output":882}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-01-01","Output":865,"Input":864}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-01","Output":854}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-01","Output":882}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-01-01","Output":884}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-01","Output":888}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-01","Output":882}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2021-01-01/types.md b/generated/web/microsoft.web/2021-01-01/types.md index 800a2b205a..de4f03932a 100644 --- a/generated/web/microsoft.web/2021-01-01/types.md +++ b/generated/web/microsoft.web/2021-01-01/types.md @@ -978,40 +978,44 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2021-01-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **domainValidationMethod**: string: Method of domain validation for free cert -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## HostingEnvironmentProfile +## ApiDefinitionInfo ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **url**: string: The URL of the API definition. -## ResourceTags +## ApiManagementConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: APIM-Api Identifier. + +## Apple +### Properties +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider + +## AppleRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppLogsConfiguration +### Properties +* **destination**: string +* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) + +## AppRegistration +### Properties +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. ## AppServiceEnvironment ### Properties @@ -1020,7 +1024,7 @@ This is valid for all deployment slots in an app. * **dnsSuffix**: string: DNS suffix of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool (ReadOnly): Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **maximumNumberOfMachines**: int (ReadOnly): Maximum number of VMs in the App Service Environment. * **multiRoleCount**: int (ReadOnly): Number of front-end instances. @@ -1032,132 +1036,6 @@ This is valid for all deployment slots in an app. * **userWhitelistedIpRanges**: string[]: User added ip ranges to whitelist on ASE db * **virtualNetwork**: [VirtualNetworkProfile](#virtualnetworkprofile) (Required): Specification for using a Virtual Network. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## VirtualNetworkProfile -### Properties -* **id**: string (Required): Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AseV3NetworkingConfigurationProperties -### Properties -* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE -* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem -* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## PrivateLinkConnectionApprovalRequest -### Properties -* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkConnectionState -### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection - -## ExtendedLocation -### Properties -* **name**: string: Name of extended location. -* **type**: string (ReadOnly): Type of extended location. - -## KubeEnvironmentProperties -### Properties -* **aksResourceID**: string -* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) -* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) -* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster -* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation -* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet -* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. -* **staticIp**: string: Static IP of the KubeEnvironment - -## AppLogsConfiguration -### Properties -* **destination**: string -* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) - -## LogAnalyticsConfiguration -### Properties -* **customerId**: string -* **sharedKey**: string (WriteOnly) - -## ArcConfiguration -### Properties -* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' -* **artifactStorageAccessMode**: string -* **artifactStorageClassName**: string -* **artifactStorageMountPath**: string -* **artifactStorageNodeName**: string -* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) -* **kubeConfig**: string (WriteOnly) - -## FrontEndConfiguration -### Properties -* **kind**: 'LoadBalancer' | 'NodePort' - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **freeOfferExpirationTime**: string: The time when the server farm free offer expires. @@ -1182,236 +1060,60 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## KubeEnvironmentProfile +## ArcConfiguration ### Properties -* **id**: string: Resource ID of the Kubernetes Environment. -* **name**: string (ReadOnly): Name of the Kubernetes Environment. -* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. +* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' +* **artifactStorageAccessMode**: string +* **artifactStorageClassName**: string +* **artifactStorageMountPath**: string +* **artifactStorageNodeName**: string +* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) +* **kubeConfig**: string (WriteOnly) -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## ArmPlan ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **name**: string: The name. +* **product**: string: The product. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher. +* **version**: string: Version of product. -## VnetRouteProperties +## AseV3NetworkingConfigurationProperties ### Properties -* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' (WriteOnly): 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. -* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE +* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem +* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem -## ManagedServiceIdentity +## AuthPlatform ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **configFilePath**: string: 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. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealActions ### Properties -### Additional Properties -* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties +## AutoHealCustomAction ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## SiteProperties -### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **storageAccountRequired**: bool: Checks if Customer provided storage account is required -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. -* **virtualNetworkSubnetId**: 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} - -## CloningInfo -### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. - -## CloningInfoAppSettingsOverrides -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## HostNameSslState -### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. - -## SiteConfig -### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans -* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site -This setting only applies to the Elastic Plans -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publicNetworkAccess**: string: Property to allow or block all public traffic. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **websiteTimeZone**: 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 -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id - -## ApiDefinitionInfo -### Properties -* **url**: string: The URL of the API definition. - -## ApiManagementConfig -### Properties -* **id**: string: APIM-Api Identifier. - -## AutoHealRules +## AutoHealRules ### Properties * **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. * **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## AutoHealActions -### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action - -## AutoHealCustomAction -### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. - ## AutoHealTriggers ### Properties * **privateBytesInKB**: int: A rule based on private bytes. @@ -1421,38 +1123,69 @@ before taking the action * **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. * **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. -## RequestsBasedTrigger +## AzureActiveDirectory ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. -## SlowRequestsBasedTrigger +## AzureActiveDirectoryLogin ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". -## StatusCodesBasedTrigger +## AzureActiveDirectoryRegistration ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 -## StatusCodesRangeBasedTrigger +## AzureActiveDirectoryValidation ### Properties -* **count**: int: Request Count. -* **path**: string -* **statusCodes**: string: HTTP status code. -* **timeInterval**: string: Time interval. +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. -## SiteConfigAzureStorageAccounts +## AzureBlobStorageApplicationLogsConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureStaticWebApps +### Properties +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider + +## AzureStaticWebAppsRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. ## AzureStorageInfoValue ### Properties @@ -1463,397 +1196,326 @@ before taking the action * **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. * **type**: 'AzureBlob' | 'AzureFiles': Type of storage. -## ConnStringInfo +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## CorsSettings +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## Experiments +## AzureTableStorageApplicationLogsConfig ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## RampUpRule +## BackupItem ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## HandlerMapping +## BackupItem ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## IpSecurityRestriction +## BackupItemCollection ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -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. +## BackupItemCollection +### Properties +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## BackupItemProperties +### Properties +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## IpSecurityRestrictionHeaders +## BackupRequest ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SiteLimits +## BackupRequest ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SiteMachineKey +## BackupRequestProperties ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## PushSettings +## BackupSchedule ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## PushSettingsProperties +## BlobStorageTokenStore ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. -## VirtualApplication +## Capability ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. -## VirtualDirectory +## CertificateProperties ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **domainValidationMethod**: string: Method of domain validation for free cert +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. -## SlotSwapStatus +## ClientRegistration ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. -## ResourceTags +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties * **Additional Properties Type**: string -## CsmPublishingCredentialsPoliciesEntityProperties +## Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity -## StringDictionaryProperties +## ConnectionStringDictionaryProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteAuthSettingsProperties +## ConnectionStringDictionaryProperties ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **configVersion**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## SiteAuthSettingsV2Properties +## ConnStringInfo ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. -## GlobalValidation +## ConnStringValueTypePair ### Properties -* **excludedPaths**: string[]: The paths for which unauthenticated flow would not be redirected to the login page. -* **redirectToProvider**: 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". -* **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. -## HttpSettings +## CookieExpiration ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. -* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. -## ForwardProxy +## CorsSettings ### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. -* **customHostHeaderName**: string: The name of the header containing the host of the request. -* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## HttpSettingsRoutes +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## IdentityProviders +## CustomOpenIdConnectProvider ### Properties -* **apple**: [Apple](#apple): The configuration settings of the Apple provider. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. -* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. -* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. -* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. -* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. -* **google**: [Google](#google): The configuration settings of the Google provider. -* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. -* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. -## Apple +## DatabaseBackupSetting ### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## LoginScopes +## DeploymentProperties ### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## AppleRegistration +## EnabledConfig ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -## AzureActiveDirectory +## ErrorEntity ### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. +* **code**: string: Basic error code. +* **extendedCode**: string: Type of error. +* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. +* **message**: string: Any details of the error. +* **messageTemplate**: string: Message template. +* **parameters**: string[]: Parameters for the template. -## AzureActiveDirectoryLogin +## Experiments ### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## AzureActiveDirectoryRegistration +## ExtendedLocation ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +* **name**: string: Name of extended location. +* **type**: string (ReadOnly): Type of extended location. -## AzureActiveDirectoryValidation +## Facebook ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets -## JwtClaimChecks +## FileSystemApplicationLogsConfig ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -## AzureStaticWebApps +## FileSystemHttpLogsConfig ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. -## AzureStaticWebAppsRegistration +## FileSystemTokenStore ### Properties -* **clientId**: string: The Client ID of the app used for login. +* **directory**: string: The directory in which the tokens will be stored. -## IdentityProvidersCustomOpenIdConnectProviders +## ForwardProxy ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. +* **customHostHeaderName**: string: The name of the header containing the host of the request. +* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. -## CustomOpenIdConnectProvider +## FrontEndConfiguration ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **kind**: 'LoadBalancer' | 'NodePort' -## OpenIdConnectLogin +## FunctionEnvelopeProperties ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. -## OpenIdConnectRegistration +## FunctionEnvelopePropertiesFiles ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +### Additional Properties +* **Additional Properties Type**: string -## OpenIdConnectClientCredential +## FunctionSecrets ### Properties -* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. -* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## OpenIdConnectConfig +## FunctionSecrets ### Properties -* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. -* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. -* **issuer**: string: The endpoint that issues the token. -* **tokenEndpoint**: string: The endpoint to be used to request a token. -* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## Facebook +## FunctionSecrets ### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## AppRegistration +## FunctionSecrets ### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. ## GitHub ### Properties @@ -1861,10 +1523,33 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. * **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -## ClientRegistration +## GitHubActionCodeConfiguration ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. +* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. + +## GitHubActionConfiguration +### Properties +* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. +* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. +* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. +* **isLinux**: bool: This will help determine the workflow configuration to select. + +## GitHubActionContainerConfiguration +### Properties +* **imageName**: string: The image name for the build. +* **password**: string: The password used to upload the image to the container registry. +* **serverUrl**: string: The server URL for the container registry where the build will be hosted. +* **username**: string: The username used to upload the image to the container registry. + +## GlobalValidation +### Properties +* **excludedPaths**: string[]: The paths for which unauthenticated flow would not be redirected to the login page. +* **redirectToProvider**: 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". +* **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. ## Google ### Properties @@ -1873,203 +1558,224 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets * **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## AllowedAudiencesValidation +## HandlerMapping ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## LegacyMicrosoftAccount +## HostingEnvironmentProfile ### Properties -* **enabled**: bool: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## Twitter +## HostKeys ### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## TwitterRegistration +## HostKeys ### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## Login +## HostKeysFunctionKeys ### Properties -* **allowedExternalRedirectUrls**: 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. -* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. -* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. -* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. -* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. -* **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. +### Additional Properties +* **Additional Properties Type**: string -## CookieExpiration +## HostKeysSystemKeys ### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. +### Additional Properties +* **Additional Properties Type**: string -## Nonce +## HostNameBindingProperties ### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## LoginRoutes +## HostNameSslState ### Properties -* **logoutEndpoint**: string: The endpoint at which a logout request should be made. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## TokenStore +## HttpLogsConfig ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. -* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. -* **tokenRefreshExtensionHours**: int: 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. +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## BlobStorageTokenStore +## HttpSettings ### Properties -* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. +* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. +* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## FileSystemTokenStore +## HttpSettingsRoutes ### Properties -* **directory**: string: The directory in which the tokens will be stored. +* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. -## AuthPlatform +## HybridConnectionKey ### Properties -* **configFilePath**: string: 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. -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## AzureStoragePropertyDictionaryResourceProperties +## HybridConnectionKeyProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## BackupRequestProperties +## HybridConnectionProperties ### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## BackupSchedule +## IdentifierProperties ### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. +* **id**: string: String representation of the identity. -## DatabaseBackupSetting +## IdentityProviders ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **apple**: [Apple](#apple): The configuration settings of the Apple provider. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. +* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. +* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. +* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. +* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. +* **google**: [Google](#google): The configuration settings of the Google provider. +* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. +* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## ConnectionStringDictionaryProperties +## IdentityProvidersCustomOpenIdConnectProviders ### Properties ### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## ConnStringValueTypePair +## IpSecurityRestriction ### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## SiteLogsConfigProperties -### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +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. -## ApplicationLogsConfig +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +### Additional Properties +* **Additional Properties Type**: string[] -## AzureBlobStorageApplicationLogsConfig +## JwtClaimChecks ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## AzureTableStorageApplicationLogsConfig +## KubeEnvironmentProfile ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. - -## FileSystemApplicationLogsConfig -### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **id**: string: Resource ID of the Kubernetes Environment. +* **name**: string (ReadOnly): Name of the Kubernetes Environment. +* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. -## EnabledConfig +## KubeEnvironmentProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **aksResourceID**: string +* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) +* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) +* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster +* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation +* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet +* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. +* **staticIp**: string: Static IP of the KubeEnvironment -## HttpLogsConfig +## LegacyMicrosoftAccount ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. +* **enabled**: bool: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## AzureBlobStorageHttpLogsConfig +## LogAnalyticsConfiguration ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **customerId**: string +* **sharedKey**: string (WriteOnly) -## FileSystemHttpLogsConfig +## Login ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **allowedExternalRedirectUrls**: 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. +* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. +* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. +* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. +* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. +* **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. -## StringDictionaryProperties +## LoginRoutes ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## SlotConfigNames +## LoginScopes ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## DeploymentProperties +## ManagedServiceIdentity ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## IdentifierProperties +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **id**: string: String representation of the identity. +### Additional Properties +* **Additional Properties Type**: [Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties](#components1jq1t4ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties) ## MSDeployCore ### Properties @@ -2095,65 +1801,39 @@ Setting is false by default. ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## NameValuePair ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +* **name**: string: Pair name. +* **value**: string: Pair value. -## FunctionEnvelopePropertiesFiles +## Nonce ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. -## HostNameBindingProperties +## OpenIdConnectClientCredential ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. +* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. -## RelayServiceConnectionEntityProperties +## OpenIdConnectConfig ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. +* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. +* **issuer**: string: The endpoint that issues the token. +* **tokenEndpoint**: string: The endpoint to be used to request a token. +* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## HybridConnectionProperties +## OpenIdConnectLogin ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## SwiftVirtualNetworkProperties +## OpenIdConnectRegistration ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. ## PremierAddOnProperties ### Properties @@ -2163,16 +1843,16 @@ normally, use the POST /listKeys API instead. * **sku**: string: Premier add on SKU. * **vendor**: string: Premier add on Vendor. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - ## PrivateAccessProperties ### Properties * **enabled**: bool: Whether private access is enabled or not. * **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +## PrivateAccessSubnet +### Properties +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. + ## PrivateAccessVirtualNetwork ### Properties * **key**: int: The key (ID) of the Virtual Network. @@ -2180,16 +1860,334 @@ normally, use the POST /listKeys API instead. * **resourceId**: string: The ARM uri of the Virtual Network * **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## PrivateAccessSubnet +## PrivateLinkConnectionApprovalRequest ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) + +## PrivateLinkConnectionState +### Properties +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection + +## PublicCertificateProperties +### Properties +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint + +## PushSettings +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. + +## PushSettingsProperties +### Properties +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. + +## RampUpRule +### Properties +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. + +## RelayServiceConnectionEntityProperties +### Properties +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string + +## RemotePrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties +* **type**: string (ReadOnly): Resource type. + +## RemotePrivateEndpointConnectionProperties +### Properties +* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) + +## RequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## ResponseMessageEnvelopeRemotePrivateEndpointConnection +### Properties +* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. +* **id**: string: 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} +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. +* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. +* **name**: string: Name of resource. +* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. +* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection +* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. +* **status**: string: Azure-AsyncOperation Status info. +* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. +* **type**: string: Type of resource e.g "Microsoft.Web/sites". +* **zones**: string[]: Logical Availability Zones the service is hosted in + +## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## SiteAuthSettingsProperties +### Properties +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **configVersion**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. + +## SiteAuthSettingsV2Properties +### Properties +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. + +## SiteConfig +### Properties +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans +* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site +This setting only applies to the Elastic Plans +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publicNetworkAccess**: string: Property to allow or block all public traffic. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **websiteTimeZone**: 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 +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id -## PublicCertificateProperties +## SiteConfigAzureStorageAccounts ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -2214,35 +2212,77 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **storageAccountRequired**: bool: Checks if Customer provided storage account is required +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **virtualNetworkSubnetId**: 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} ## SiteSourceControlProperties ### Properties @@ -2254,43 +2294,43 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## GitHubActionConfiguration +## SkuCapacity ### Properties -* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. -* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. -* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. -* **isLinux**: bool: This will help determine the workflow configuration to select. +* **default**: int: Default number of workers for this App Service plan SKU. +* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## GitHubActionCodeConfiguration +## SkuDescription ### Properties -* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. -* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. -## GitHubActionContainerConfiguration +## SlotConfigNames ### Properties -* **imageName**: string: The image name for the build. -* **password**: string: The password used to upload the image to the container registry. -* **serverUrl**: string: The server URL for the container registry where the build will be hosted. -* **username**: string: The username used to upload the image to the container registry. +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. -## VnetInfoProperties +## SlotSwapStatus ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. -## VnetRoute +## SlowRequestsBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **path**: string: Request Path. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2327,59 +2367,14 @@ Point-To-Site VPN connection. * **outputLocation**: string: The output path of the app after building. * **skipGithubActionWorkflowGeneration**: bool: Skip Github Action workflow generation. -## ResponseMessageEnvelopeRemotePrivateEndpointConnection -### Properties -* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. -* **id**: string: 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} -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. -* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. -* **name**: string: Name of resource. -* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. -* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection -* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. -* **status**: string: Azure-AsyncOperation Status info. -* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. -* **type**: string: Type of resource e.g "Microsoft.Web/sites". -* **zones**: string[]: Logical Availability Zones the service is hosted in - -## ErrorEntity -### Properties -* **code**: string: Basic error code. -* **extendedCode**: string: Type of error. -* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. -* **message**: string: Any details of the error. -* **messageTemplate**: string: Message template. -* **parameters**: string[]: Parameters for the template. - -## ArmPlan -### Properties -* **name**: string: The name. -* **product**: string: The product. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher. -* **version**: string: Version of product. - -## RemotePrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties -* **type**: string (ReadOnly): Resource type. - -## RemotePrivateEndpointConnectionProperties -### Properties -* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags +## StaticSiteCustomDomainRequestPropertiesARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. +* **domainName**: string (ReadOnly): The domain name for the static site custom domain. +* **errorMessage**: string (ReadOnly) +* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' | string (ReadOnly): The status of the custom domain +* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain +* **validationToken**: string (ReadOnly): The TXT record validation token ## StaticSiteTemplateOptions ### Properties @@ -2389,34 +2384,33 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **repositoryName**: string: Name of the newly generated repository. * **templateRepositoryUrl**: string: URL of the template repository. The newly generated repository will be based on this one. -## StaticSiteUserProvidedFunctionApp +## StaticSiteUserARMResource ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserProvidedFunctionAppProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. -* **functionAppRegion**: string: The region of the function app registered with the static site -* **functionAppResourceId**: string: The resource id of the function app registered with the static site - -## ResourceTags +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string +## StaticSiteUserProvidedFunctionApp +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **type**: string (ReadOnly): Resource type. ## StaticSiteUserProvidedFunctionAppARMResourceProperties ### Properties @@ -2424,58 +2418,36 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **functionAppRegion**: string: The region of the function app registered with the static site * **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties +## StaticSiteUserProvidedFunctionAppProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. +* **functionAppRegion**: string: The region of the function app registered with the static site +* **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StaticSiteCustomDomainRequestPropertiesARMResourceProperties +## StatusCodesBasedTrigger ### Properties -* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. -* **domainName**: string (ReadOnly): The domain name for the static site custom domain. -* **errorMessage**: string (ReadOnly) -* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' (ReadOnly): The status of the custom domain -* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain -* **validationToken**: string (ReadOnly): The TXT record validation token +* **count**: int: Request Count. +* **path**: string: Request Path +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupRequest +## StatusCodesRangeBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **path**: string +* **statusCodes**: string: HTTP status code. +* **timeInterval**: string: Time interval. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2484,25 +2456,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2529,22 +2488,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## StringList +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: string[] (ReadOnly): List of string resources. +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2563,102 +2512,153 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## StringDictionaryProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringList ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: string[] (ReadOnly): List of string resources. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## SwiftVirtualNetworkProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## FunctionSecrets +## TokenStore ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. +* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. +* **tokenRefreshExtensionHours**: int: 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. -## FunctionSecrets +## Twitter ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## FunctionSecrets +## TwitterRegistration ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. -## StaticSiteUserCollection +## UserProperties ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. -## StaticSiteUserARMResource +## VirtualApplication +### Properties +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. + +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualNetworkProfile +### Properties +* **id**: string (Required): Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | string (WriteOnly): 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. +* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2021-01-15/types.json b/generated/web/microsoft.web/2021-01-15/types.json index fc0cf47024..83784757cf 100644 --- a/generated/web/microsoft.web/2021-01-15/types.json +++ b/generated/web/microsoft.web/2021-01-15/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":2,"Description":"Dedicated Host Count"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-01-15","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-01-15","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":42,"Flags":9,"Description":"The resource name"},"type":{"Type":43,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":44,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":50,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":51,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":53,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":54,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":56,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":55}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-15","ScopeType":8,"Body":45}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":58,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":59,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":64,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":60}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":66,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":67,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-01-15","ScopeType":8,"Body":68}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":87,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":77,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"elasticScaleEnabled":{"Type":2,"Flags":0,"Description":"ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":84,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":85,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[74,75,76]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[79,80,81,82,83]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-01-15","ScopeType":8,"Body":72}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":89,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":90,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-15","ScopeType":8,"Body":91}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":94,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":95,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":101,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[98,99,100]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-15","ScopeType":8,"Body":96}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":103,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":104,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":120,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":107,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":78,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":119,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[108,109,110,111,112,113,114,115,116,117,118]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-01-15","ScopeType":8,"Body":105}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":122,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":123,"Flags":10,"Description":"The resource api version"},"properties":{"Type":125,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":147,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":136,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"arcConfiguration":{"Type":137,"Flags":0},"appLogsConfiguration":{"Type":145,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[126,127,128,129,130,131,132,133,134,135]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":140,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":141,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[138,139]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":144,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[142,143]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":146,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-01-15","ScopeType":8,"Body":124}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":149,"Flags":9,"Description":"The resource name"},"type":{"Type":150,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":151,"Flags":10,"Description":"The resource api version"},"properties":{"Type":153,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-01-15","ScopeType":1,"Body":152}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":155,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":156,"Flags":10,"Description":"The resource api version"},"properties":{"Type":158,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-01-15","ScopeType":1,"Body":157}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":160,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":161,"Flags":10,"Description":"The resource api version"},"properties":{"Type":163,"Flags":0,"Description":"A static site."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":192,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":164,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":165,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":184,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":187,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":188,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":191,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":167,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":168,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":169,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":172,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":183,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":170,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":171,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":173,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":174,"Flags":0,"Description":"Inner errors."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":172}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":180,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":182,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[176,177,178,179]}},{"2":{"Name":"UserAssignedIdentity","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":181}},{"3":{"ItemType":4}},{"3":{"ItemType":166}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[185,186]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":190,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":189}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-01-15","ScopeType":8,"Body":162}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":194,"Flags":9,"Description":"The resource name"},"type":{"Type":195,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":196,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":199,"Flags":9,"Description":"The resource name"},"type":{"Type":200,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":201,"Flags":10,"Description":"The resource api version"},"properties":{"Type":203,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":197,"functionappsettings":202}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-01-15","ScopeType":8,"Body":204}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":206,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":207,"Flags":10,"Description":"The resource api version"},"properties":{"Type":209,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-15","ScopeType":8,"Body":208}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":211,"Flags":9,"Description":"The resource name"},"type":{"Type":212,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":213,"Flags":10,"Description":"The resource api version"},"properties":{"Type":215,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":216,"Flags":9,"Description":"The resource name"},"type":{"Type":217,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":218,"Flags":10,"Description":"The resource api version"},"properties":{"Type":220,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":214,"functionappsettings":219}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-01-15","ScopeType":8,"Body":221}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":223,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":224,"Flags":10,"Description":"The resource api version"},"properties":{"Type":226,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":233,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[227,228,229,230,231,232]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-01-15","ScopeType":8,"Body":225}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":235,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":236,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":237}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":239,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":240,"Flags":10,"Description":"The resource api version"},"properties":{"Type":209,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-15","ScopeType":8,"Body":241}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":243,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":244,"Flags":10,"Description":"The resource api version"},"properties":{"Type":246,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":384,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":247,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":250,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":251,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":255,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":264,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":265,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":370,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":374,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":375,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":377,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":383,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[248,249]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[252,253,254]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":260,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":263,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[257,258,259]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[261,262]}},{"3":{"ItemType":256}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":266,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":267,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":281,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":282,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":284,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":299,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":302,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":306,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":313,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":314,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":317,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":318,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":333,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":335,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":337,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":338,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":346,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":347,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":351,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":355,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":359,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":369,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":280,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[269,270,271,272,273,274,275,276,277,278,279]}},{"3":{"ItemType":268}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":283}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[285,286,287,288,289,290,291,292,293,294,295,296,297,298]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[300,301]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":305,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":304}},{"3":{"ItemType":303}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[307,308,309,310,311,312]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":316,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":315}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":319,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":327,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":320,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":322,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":323,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":324,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":326,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":321}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":323}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":325}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":331,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":332,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[328,329,330]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":334,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":336,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":343,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":345,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[340,341,342]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":344}},{"3":{"ItemType":339}},{"3":{"ItemType":339}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[348,349,350]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[352,353,354]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[356,357,358]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":363,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":368,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[361,362]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[364,365,366,367]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":360}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[371,372,373]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":376,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[378,379,380,381,382]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-01-15","ScopeType":8,"Body":245}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":386,"Flags":9,"Description":"The resource name"},"type":{"Type":387,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":388,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":391,"Flags":9,"Description":"The resource name"},"type":{"Type":392,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":393,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":389,"scm":394}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-15","ScopeType":8,"Body":395}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":397,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":402,"Flags":9,"Description":"The resource name"},"type":{"Type":403,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":404,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":409,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":410,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":417,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":418,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":419,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":420,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":421,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":422,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":423,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[407,408]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[411,412,413,414,415,416]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":424,"Flags":9,"Description":"The resource name"},"type":{"Type":425,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":426,"Flags":10,"Description":"The resource api version"},"properties":{"Type":428,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":429,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":430,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":437,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":471,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":482,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":435,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":436,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[431,432,433,434]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":438,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":447,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":451,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":453,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":456,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":457,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":459,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":461,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":470,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":439,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":440,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":442,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":441,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":443,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":446,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":444,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":445,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":448,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":450,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":452,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":452,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":454,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":455,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":452,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":454,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":458,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":462,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":464,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":468,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":465,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":467,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":466,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":469,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":463}},{"2":{"Name":"Login","Properties":{"routes":{"Type":472,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":473,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":476,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":477,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":481,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":474,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":475,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":480,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[478,479]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":483,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":484,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":488,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[485,486,487]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":489,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":360}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":494,"Flags":9,"Description":"The resource name"},"type":{"Type":495,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":496,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":499,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":509,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":502,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[500,501]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":508,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[504,505,506,507]}},{"3":{"ItemType":503}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":510,"Flags":9,"Description":"The resource name"},"type":{"Type":511,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":512,"Flags":10,"Description":"The resource api version"},"properties":{"Type":527,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":526,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[515,516,517,518,519,520,521,522,523,524,525]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":514}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":528,"Flags":9,"Description":"The resource name"},"type":{"Type":529,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":530,"Flags":10,"Description":"The resource api version"},"properties":{"Type":532,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":533,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":555,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":558,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":558,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":534,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":541,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":548,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":540,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[535,536,537,538,539]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":547,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[542,543,544,545,546]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":554,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[549,550,551,552,553]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":556,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":557,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":559,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":564,"Flags":9,"Description":"The resource name"},"type":{"Type":565,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":566,"Flags":10,"Description":"The resource api version"},"properties":{"Type":336,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":568,"Flags":9,"Description":"The resource name"},"type":{"Type":569,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":570,"Flags":10,"Description":"The resource api version"},"properties":{"Type":572,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":573,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":574,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":575,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":576,"Flags":9,"Description":"The resource name"},"type":{"Type":577,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":578,"Flags":10,"Description":"The resource api version"},"properties":{"Type":265,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":400,"authsettings":405,"authsettingsV2":427,"azurestorageaccounts":492,"backup":497,"connectionstrings":513,"logs":531,"metadata":562,"pushsettings":567,"slotConfigNames":571,"web":579}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-01-15","ScopeType":8,"Body":580}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":582,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":583,"Flags":10,"Description":"The resource api version"},"properties":{"Type":585,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-01-15","ScopeType":8,"Body":584}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":587,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":588,"Flags":10,"Description":"The resource api version"},"properties":{"Type":590,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-15","ScopeType":8,"Body":589}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":592,"Flags":9,"Description":"The resource name"},"type":{"Type":593,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":594,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":597,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":603,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[598,599,600,601,602]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-01-15","ScopeType":8,"Body":595}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":605,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":606,"Flags":10,"Description":"The resource api version"},"properties":{"Type":608,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":609,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-01-15","ScopeType":8,"Body":607}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":611,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":612,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-01-15","ScopeType":8,"Body":613}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":615,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":616,"Flags":10,"Description":"The resource api version"},"properties":{"Type":618,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":621,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":624,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":627,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":631,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[619,620]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[622,623]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[625,626]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[628,629,630]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-01-15","ScopeType":8,"Body":617}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":633,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":634,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-15","ScopeType":8,"Body":635}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":638,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":639,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-01-15","ScopeType":8,"Body":640}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":643,"Flags":9,"Description":"The resource name"},"type":{"Type":644,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":645,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-01-15","ScopeType":8,"Body":646}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":648,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-01-15","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":654,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":655,"Flags":10,"Description":"The resource api version"},"properties":{"Type":657,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":658,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-01-15","ScopeType":8,"Body":656}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":660,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":668,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":667,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":666}},{"3":{"ItemType":665}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-01-15","ScopeType":8,"Body":663}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":670,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":671,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":672}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":674,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":675,"Flags":10,"Description":"The resource api version"},"properties":{"Type":677,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":681,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[678,679,680]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-01-15","ScopeType":8,"Body":676}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":683,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":684,"Flags":10,"Description":"The resource api version"},"properties":{"Type":686,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":689,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":690,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[687,688]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-01-15","ScopeType":8,"Body":685}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":692,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":693,"Flags":10,"Description":"The resource api version"},"properties":{"Type":246,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":695,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-01-15","ScopeType":8,"Body":694}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":697,"Flags":9,"Description":"The resource name"},"type":{"Type":698,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":699,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":701,"Flags":9,"Description":"The resource name"},"type":{"Type":702,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":703,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":700,"scm":704}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-15","ScopeType":8,"Body":705}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":707,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":712,"Flags":9,"Description":"The resource name"},"type":{"Type":713,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":714,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":716,"Flags":9,"Description":"The resource name"},"type":{"Type":717,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":718,"Flags":10,"Description":"The resource api version"},"properties":{"Type":428,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":720,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":724,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":360}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":725,"Flags":9,"Description":"The resource name"},"type":{"Type":726,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":727,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":729,"Flags":9,"Description":"The resource name"},"type":{"Type":730,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":731,"Flags":10,"Description":"The resource api version"},"properties":{"Type":733,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":514}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":734,"Flags":9,"Description":"The resource name"},"type":{"Type":735,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":736,"Flags":10,"Description":"The resource api version"},"properties":{"Type":532,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":738,"Flags":9,"Description":"The resource name"},"type":{"Type":739,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":740,"Flags":10,"Description":"The resource api version"},"properties":{"Type":742,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":743,"Flags":9,"Description":"The resource name"},"type":{"Type":744,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":745,"Flags":10,"Description":"The resource api version"},"properties":{"Type":336,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":747,"Flags":9,"Description":"The resource name"},"type":{"Type":748,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":749,"Flags":10,"Description":"The resource api version"},"properties":{"Type":265,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":710,"authsettings":715,"authsettingsV2":719,"azurestorageaccounts":723,"backup":728,"connectionstrings":732,"logs":737,"metadata":741,"pushsettings":746,"web":750}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-01-15","ScopeType":8,"Body":751}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":753,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":754,"Flags":10,"Description":"The resource api version"},"properties":{"Type":585,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-01-15","ScopeType":8,"Body":755}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":757,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":758,"Flags":10,"Description":"The resource api version"},"properties":{"Type":590,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-15","ScopeType":8,"Body":759}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":761,"Flags":9,"Description":"The resource name"},"type":{"Type":762,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":763,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-01-15","ScopeType":8,"Body":764}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":766,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":767,"Flags":10,"Description":"The resource api version"},"properties":{"Type":608,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-01-15","ScopeType":8,"Body":768}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":770,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":771,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-01-15","ScopeType":8,"Body":772}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":774,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":775,"Flags":10,"Description":"The resource api version"},"properties":{"Type":618,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-01-15","ScopeType":8,"Body":776}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-15","ScopeType":8,"Body":780}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":782,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":783,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-01-15","ScopeType":8,"Body":784}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":786,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-01-15","ScopeType":8,"Body":789}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":791,"Flags":9,"Description":"The resource name"},"type":{"Type":792,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":793,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2021-01-15","ScopeType":8,"Body":794}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":796,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":797,"Flags":10,"Description":"The resource api version"},"properties":{"Type":657,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":799,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-01-15","ScopeType":8,"Body":798}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":801,"Flags":9,"Description":"The resource name"},"type":{"Type":802,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":803,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-01-15","ScopeType":8,"Body":804}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":806,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":807,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":808}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":810,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":811,"Flags":10,"Description":"The resource api version"},"properties":{"Type":677,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-01-15","ScopeType":8,"Body":812}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":686,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-01-15","ScopeType":8,"Body":816}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":818,"Flags":9,"Description":"The resource name"},"type":{"Type":819,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":820,"Flags":10,"Description":"The resource api version"},"properties":{"Type":822,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":823,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":824,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":825,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-01-15","ScopeType":8,"Body":821}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":827,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":828,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":832,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":97,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":831}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-15","ScopeType":8,"Body":829}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":834,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":835,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-15","ScopeType":8,"Body":836}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":838,"Flags":9,"Description":"The resource name"},"type":{"Type":839,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":840,"Flags":10,"Description":"The resource api version"},"properties":{"Type":822,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-01-15","ScopeType":8,"Body":841}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":843,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":844,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-01-15","ScopeType":8,"Body":845}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":847,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":848,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-15","ScopeType":8,"Body":849}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":852,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-01-15","Output":851}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":857,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":856,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":855}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-01-15","Output":854}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":860,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":859}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":865,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":864}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":859}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":498,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":871,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":882,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":883,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[872,873,874,875,876,877,878,879,880,881]}},{"3":{"ItemType":503}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-01-15","Output":870,"Input":869}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-15","Output":859}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-15","Output":887}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":890,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":891,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-01-15","Output":889}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":894,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":870}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-15","Output":893}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-15","Output":887}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-01-15","Output":870,"Input":869}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-15","Output":887}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-01-15","Output":889}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-15","Output":893}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-15","Output":887}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":2,"Description":"Dedicated Host Count"}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27,4]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-01-15","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-01-15","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":42,"Flags":9,"Description":"The resource name"},"type":{"Type":43,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":44,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":50,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":51,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[47,48,49]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":53,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":54,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":56,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":55}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-01-15","ScopeType":8,"Body":45}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":58,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":59,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":64,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":60}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":66,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":67,"Flags":10,"Description":"The resource api version"},"properties":{"Type":46,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-01-15","ScopeType":8,"Body":68}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":70,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":71,"Flags":10,"Description":"The resource api version"},"properties":{"Type":73,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":87,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":77,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"elasticScaleEnabled":{"Type":2,"Flags":0,"Description":"ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":84,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":85,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[74,75,76]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[79,80,81,82,83]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-01-15","ScopeType":8,"Body":72}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":89,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":90,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-01-15","ScopeType":8,"Body":91}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":94,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":95,"Flags":10,"Description":"The resource api version"},"properties":{"Type":97,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":101,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[98,99,100,4]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-01-15","ScopeType":8,"Body":96}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":103,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":104,"Flags":10,"Description":"The resource api version"},"properties":{"Type":106,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":120,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":107,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":78,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":119,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert. Possible values include: 'CNameValidationValue', 'HttpTokenValidationValue'"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[108,109,110,111,112,113,114,115,116,117,118]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-01-15","ScopeType":8,"Body":105}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":122,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":123,"Flags":10,"Description":"The resource api version"},"properties":{"Type":125,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":147,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":136,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"arcConfiguration":{"Type":137,"Flags":0},"appLogsConfiguration":{"Type":145,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[126,127,128,129,130,131,132,133,134,135]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":140,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":141,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[138,139]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":144,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[142,143]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":146,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-01-15","ScopeType":8,"Body":124}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":149,"Flags":9,"Description":"The resource name"},"type":{"Type":150,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":151,"Flags":10,"Description":"The resource api version"},"properties":{"Type":153,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-01-15","ScopeType":1,"Body":152}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":155,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":156,"Flags":10,"Description":"The resource api version"},"properties":{"Type":158,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-01-15","ScopeType":1,"Body":157}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":160,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":161,"Flags":10,"Description":"The resource api version"},"properties":{"Type":163,"Flags":0,"Description":"A static site."},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":192,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":164,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":165,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":184,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":187,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":188,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":191,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":167,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":168,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":169,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":52,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":172,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":183,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":170,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":63,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":62,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":171,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":173,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":174,"Flags":0,"Description":"Inner errors."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":172}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":180,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":182,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[176,177,178,179]}},{"2":{"Name":"UserAssignedIdentity","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":181}},{"3":{"ItemType":4}},{"3":{"ItemType":166}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[185,186]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":190,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":189}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-01-15","ScopeType":8,"Body":162}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":194,"Flags":9,"Description":"The resource name"},"type":{"Type":195,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":196,"Flags":10,"Description":"The resource api version"},"properties":{"Type":198,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":199,"Flags":9,"Description":"The resource name"},"type":{"Type":200,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":201,"Flags":10,"Description":"The resource api version"},"properties":{"Type":203,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":197,"functionappsettings":202}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-01-15","ScopeType":8,"Body":204}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":206,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":207,"Flags":10,"Description":"The resource api version"},"properties":{"Type":209,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-01-15","ScopeType":8,"Body":208}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":211,"Flags":9,"Description":"The resource name"},"type":{"Type":212,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":213,"Flags":10,"Description":"The resource api version"},"properties":{"Type":215,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":216,"Flags":9,"Description":"The resource name"},"type":{"Type":217,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":218,"Flags":10,"Description":"The resource api version"},"properties":{"Type":220,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":214,"functionappsettings":219}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-01-15","ScopeType":8,"Body":221}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":223,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":224,"Flags":10,"Description":"The resource api version"},"properties":{"Type":226,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":233,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[227,228,229,230,231,232,4]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-01-15","ScopeType":8,"Body":225}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":235,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":236,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":237}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":239,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":240,"Flags":10,"Description":"The resource api version"},"properties":{"Type":209,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-01-15","ScopeType":8,"Body":241}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":243,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":244,"Flags":10,"Description":"The resource api version"},"properties":{"Type":246,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":384,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":247,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":250,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":251,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":255,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":264,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":265,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":370,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":78,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":374,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":375,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":377,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":383,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[248,249]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[252,253,254]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":260,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":263,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[257,258,259]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[261,262]}},{"3":{"ItemType":256}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":266,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":267,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":281,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":282,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":284,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":299,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":302,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":306,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":313,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":314,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":317,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":318,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":333,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":335,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":337,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":338,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":346,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":347,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":351,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":355,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":359,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":369,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":280,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[269,270,271,272,273,274,275,276,277,278,279]}},{"3":{"ItemType":268}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":283}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[285,286,287,288,289,290,291,292,293,294,295,296,297,298,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[300,301]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":305,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":304}},{"3":{"ItemType":303}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[307,308,309,310,311,312]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":316,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":315}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":319,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":327,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":320,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":322,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":323,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":324,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":326,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":321}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":323}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":325}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":331,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":332,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[328,329,330]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":334,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":336,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":343,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":345,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[340,341,342,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":344}},{"3":{"ItemType":339}},{"3":{"ItemType":339}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[348,349,350,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[352,353,354,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[356,357,358,4]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":363,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":368,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[361,362]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[364,365,366,367]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":360}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[371,372,373]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":376,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[378,379,380,381,382]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-01-15","ScopeType":8,"Body":245}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":386,"Flags":9,"Description":"The resource name"},"type":{"Type":387,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":388,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":391,"Flags":9,"Description":"The resource name"},"type":{"Type":392,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":393,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":389,"scm":394}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-01-15","ScopeType":8,"Body":395}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":397,"Flags":9,"Description":"The resource name"},"type":{"Type":398,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":399,"Flags":10,"Description":"The resource api version"},"properties":{"Type":401,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":402,"Flags":9,"Description":"The resource name"},"type":{"Type":403,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":404,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":409,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":410,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":417,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":418,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":419,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":420,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":421,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":422,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":423,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[407,408]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[411,412,413,414,415,416]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":424,"Flags":9,"Description":"The resource name"},"type":{"Type":425,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":426,"Flags":10,"Description":"The resource api version"},"properties":{"Type":428,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":429,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":430,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":437,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":471,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":482,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":435,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":436,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[431,432,433,434]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":438,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":447,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":451,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":453,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":456,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":457,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":459,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":461,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":470,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":439,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":440,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":442,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":441,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":443,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":446,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":444,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":445,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":448,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":450,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":452,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":452,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":454,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":455,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":452,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":454,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":458,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":449,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":462,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":464,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":468,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":465,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":467,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":466,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":469,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":463}},{"2":{"Name":"Login","Properties":{"routes":{"Type":472,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":473,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":476,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":477,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":481,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":474,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":475,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":480,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[478,479]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":483,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":484,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":488,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[485,486,487]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":489,"Flags":9,"Description":"The resource name"},"type":{"Type":490,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":491,"Flags":10,"Description":"The resource api version"},"properties":{"Type":493,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":360}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":494,"Flags":9,"Description":"The resource name"},"type":{"Type":495,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":496,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":499,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":509,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":502,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[500,501]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":508,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[504,505,506,507,4]}},{"3":{"ItemType":503}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":510,"Flags":9,"Description":"The resource name"},"type":{"Type":511,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":512,"Flags":10,"Description":"The resource api version"},"properties":{"Type":527,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":526,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[515,516,517,518,519,520,521,522,523,524,525]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":514}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":528,"Flags":9,"Description":"The resource name"},"type":{"Type":529,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":530,"Flags":10,"Description":"The resource api version"},"properties":{"Type":532,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":533,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":555,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":558,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":558,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":534,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":541,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":548,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":540,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[535,536,537,538,539]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":547,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[542,543,544,545,546]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":554,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[549,550,551,552,553]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":556,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":557,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":559,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":564,"Flags":9,"Description":"The resource name"},"type":{"Type":565,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":566,"Flags":10,"Description":"The resource api version"},"properties":{"Type":336,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":568,"Flags":9,"Description":"The resource name"},"type":{"Type":569,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":570,"Flags":10,"Description":"The resource api version"},"properties":{"Type":572,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":573,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":574,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":575,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":576,"Flags":9,"Description":"The resource name"},"type":{"Type":577,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":578,"Flags":10,"Description":"The resource api version"},"properties":{"Type":265,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":400,"authsettings":405,"authsettingsV2":427,"azurestorageaccounts":492,"backup":497,"connectionstrings":513,"logs":531,"metadata":562,"pushsettings":567,"slotConfigNames":571,"web":579}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-01-15","ScopeType":8,"Body":580}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":582,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":583,"Flags":10,"Description":"The resource api version"},"properties":{"Type":585,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-01-15","ScopeType":8,"Body":584}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":587,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":588,"Flags":10,"Description":"The resource api version"},"properties":{"Type":590,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-01-15","ScopeType":8,"Body":589}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":592,"Flags":9,"Description":"The resource name"},"type":{"Type":593,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":594,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":597,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":603,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[598,599,600,601,602]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-01-15","ScopeType":8,"Body":595}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":605,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":606,"Flags":10,"Description":"The resource api version"},"properties":{"Type":608,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":609,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-01-15","ScopeType":8,"Body":607}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":611,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":612,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-01-15","ScopeType":8,"Body":613}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":615,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":616,"Flags":10,"Description":"The resource api version"},"properties":{"Type":618,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":621,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":624,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":627,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":631,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[619,620]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[622,623]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[625,626]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[628,629,630]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-01-15","ScopeType":8,"Body":617}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":633,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":634,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-01-15","ScopeType":8,"Body":635}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":638,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":639,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-01-15","ScopeType":8,"Body":640}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":643,"Flags":9,"Description":"The resource name"},"type":{"Type":644,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":645,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-01-15","ScopeType":8,"Body":646}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":648,"Flags":9,"Description":"The resource name"},"type":{"Type":649,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":650,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-01-15","ScopeType":8,"Body":651}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":654,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":655,"Flags":10,"Description":"The resource api version"},"properties":{"Type":657,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":658,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-01-15","ScopeType":8,"Body":656}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":660,"Flags":9,"Description":"The resource name"},"type":{"Type":661,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":662,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":668,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":667,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":666}},{"3":{"ItemType":665}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-01-15","ScopeType":8,"Body":663}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":670,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":671,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":672}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":674,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":675,"Flags":10,"Description":"The resource api version"},"properties":{"Type":677,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":681,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[678,679,680]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-01-15","ScopeType":8,"Body":676}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":683,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":684,"Flags":10,"Description":"The resource api version"},"properties":{"Type":686,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":689,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":690,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[687,688]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-01-15","ScopeType":8,"Body":685}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":692,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":693,"Flags":10,"Description":"The resource api version"},"properties":{"Type":246,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":175,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":86,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":695,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-01-15","ScopeType":8,"Body":694}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":697,"Flags":9,"Description":"The resource name"},"type":{"Type":698,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":699,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":701,"Flags":9,"Description":"The resource name"},"type":{"Type":702,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":703,"Flags":10,"Description":"The resource api version"},"properties":{"Type":390,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":700,"scm":704}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-01-15","ScopeType":8,"Body":705}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":707,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":712,"Flags":9,"Description":"The resource name"},"type":{"Type":713,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":714,"Flags":10,"Description":"The resource api version"},"properties":{"Type":406,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":716,"Flags":9,"Description":"The resource name"},"type":{"Type":717,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":718,"Flags":10,"Description":"The resource api version"},"properties":{"Type":428,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":720,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":724,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":360}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":725,"Flags":9,"Description":"The resource name"},"type":{"Type":726,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":727,"Flags":10,"Description":"The resource api version"},"properties":{"Type":498,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":729,"Flags":9,"Description":"The resource name"},"type":{"Type":730,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":731,"Flags":10,"Description":"The resource api version"},"properties":{"Type":733,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":514}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":734,"Flags":9,"Description":"The resource name"},"type":{"Type":735,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":736,"Flags":10,"Description":"The resource api version"},"properties":{"Type":532,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":738,"Flags":9,"Description":"The resource name"},"type":{"Type":739,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":740,"Flags":10,"Description":"The resource api version"},"properties":{"Type":742,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":743,"Flags":9,"Description":"The resource name"},"type":{"Type":744,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":745,"Flags":10,"Description":"The resource api version"},"properties":{"Type":336,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":747,"Flags":9,"Description":"The resource name"},"type":{"Type":748,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":749,"Flags":10,"Description":"The resource api version"},"properties":{"Type":265,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":710,"authsettings":715,"authsettingsV2":719,"azurestorageaccounts":723,"backup":728,"connectionstrings":732,"logs":737,"metadata":741,"pushsettings":746,"web":750}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-01-15","ScopeType":8,"Body":751}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":753,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":754,"Flags":10,"Description":"The resource api version"},"properties":{"Type":585,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-01-15","ScopeType":8,"Body":755}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":757,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":758,"Flags":10,"Description":"The resource api version"},"properties":{"Type":590,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-01-15","ScopeType":8,"Body":759}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":761,"Flags":9,"Description":"The resource name"},"type":{"Type":762,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":763,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-01-15","ScopeType":8,"Body":764}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":766,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":767,"Flags":10,"Description":"The resource api version"},"properties":{"Type":608,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-01-15","ScopeType":8,"Body":768}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":770,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":771,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-01-15","ScopeType":8,"Body":772}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":774,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":775,"Flags":10,"Description":"The resource api version"},"properties":{"Type":618,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-01-15","ScopeType":8,"Body":776}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"properties":{"Type":636,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-01-15","ScopeType":8,"Body":780}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":782,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":783,"Flags":10,"Description":"The resource api version"},"properties":{"Type":641,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-01-15","ScopeType":8,"Body":784}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":786,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":596,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-01-15","ScopeType":8,"Body":789}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":791,"Flags":9,"Description":"The resource name"},"type":{"Type":792,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":793,"Flags":10,"Description":"The resource api version"},"properties":{"Type":652,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2021-01-15","ScopeType":8,"Body":794}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":796,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":797,"Flags":10,"Description":"The resource api version"},"properties":{"Type":657,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":799,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-01-15","ScopeType":8,"Body":798}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":801,"Flags":9,"Description":"The resource name"},"type":{"Type":802,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":803,"Flags":10,"Description":"The resource api version"},"properties":{"Type":664,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-01-15","ScopeType":8,"Body":804}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":806,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":807,"Flags":10,"Description":"The resource api version"},"properties":{"Type":61,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-01-15","ScopeType":8,"Body":808}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":810,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":811,"Flags":10,"Description":"The resource api version"},"properties":{"Type":677,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-01-15","ScopeType":8,"Body":812}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":686,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-01-15","ScopeType":8,"Body":816}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":818,"Flags":9,"Description":"The resource name"},"type":{"Type":819,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":820,"Flags":10,"Description":"The resource api version"},"properties":{"Type":822,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":823,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":824,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":825,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-01-15","ScopeType":8,"Body":821}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":827,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":828,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfoProperties","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":832,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":97,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":831}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-01-15","ScopeType":8,"Body":829}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":834,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":835,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-01-15","ScopeType":8,"Body":836}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":838,"Flags":9,"Description":"The resource name"},"type":{"Type":839,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":840,"Flags":10,"Description":"The resource api version"},"properties":{"Type":822,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-01-15","ScopeType":8,"Body":841}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":843,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":844,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"VnetInfo resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-01-15","ScopeType":8,"Body":845}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-01-15"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":847,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":848,"Flags":10,"Description":"The resource api version"},"properties":{"Type":92,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-01-15","ScopeType":8,"Body":849}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":852,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-01-15","Output":851}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":857,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":856,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":855}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-01-15","Output":854}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":860,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":859}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":865,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":864}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-01-15","Output":859}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":498,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":871,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":882,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":883,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[872,873,874,875,876,877,878,879,880,881]}},{"3":{"ItemType":503}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-01-15","Output":870,"Input":869}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-15","Output":859}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-01-15","Output":887}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":890,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":891,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-01-15","Output":889}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":894,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":870}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-15","Output":893}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-01-15","Output":887}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-01-15","Output":870,"Input":869}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-15","Output":859}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-01-15","Output":887}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-01-15","Output":889}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-15","Output":893}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-01-15","Output":887}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2021-01-15/types.md b/generated/web/microsoft.web/2021-01-15/types.md index 116d999bf6..ddde9cee0d 100644 --- a/generated/web/microsoft.web/2021-01-15/types.md +++ b/generated/web/microsoft.web/2021-01-15/types.md @@ -988,40 +988,44 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2021-01-15 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **domainValidationMethod**: string: Method of domain validation for free cert -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## HostingEnvironmentProfile +## ApiDefinitionInfo ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **url**: string: The URL of the API definition. -## ResourceTags +## ApiManagementConfig ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string: APIM-Api Identifier. + +## Apple +### Properties +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider + +## AppleRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppLogsConfiguration +### Properties +* **destination**: string +* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) + +## AppRegistration +### Properties +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. ## AppServiceEnvironment ### Properties @@ -1030,7 +1034,7 @@ This is valid for all deployment slots in an app. * **dnsSuffix**: string: DNS suffix of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool (ReadOnly): Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **maximumNumberOfMachines**: int (ReadOnly): Maximum number of VMs in the App Service Environment. * **multiRoleCount**: int (ReadOnly): Number of front-end instances. @@ -1042,132 +1046,6 @@ This is valid for all deployment slots in an app. * **userWhitelistedIpRanges**: string[]: User added ip ranges to whitelist on ASE db * **virtualNetwork**: [VirtualNetworkProfile](#virtualnetworkprofile) (Required): Specification for using a Virtual Network. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## VirtualNetworkProfile -### Properties -* **id**: string (Required): Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AseV3NetworkingConfigurationProperties -### Properties -* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE -* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem -* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## PrivateLinkConnectionApprovalRequest -### Properties -* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkConnectionState -### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection - -## ExtendedLocation -### Properties -* **name**: string: Name of extended location. -* **type**: string (ReadOnly): Type of extended location. - -## KubeEnvironmentProperties -### Properties -* **aksResourceID**: string -* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) -* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) -* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster -* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation -* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet -* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. -* **staticIp**: string: Static IP of the KubeEnvironment - -## AppLogsConfiguration -### Properties -* **destination**: string -* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) - -## LogAnalyticsConfiguration -### Properties -* **customerId**: string -* **sharedKey**: string (WriteOnly) - -## ArcConfiguration -### Properties -* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' -* **artifactStorageAccessMode**: string -* **artifactStorageClassName**: string -* **artifactStorageMountPath**: string -* **artifactStorageNodeName**: string -* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) -* **kubeConfig**: string (WriteOnly) - -## FrontEndConfiguration -### Properties -* **kind**: 'LoadBalancer' | 'NodePort' - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **elasticScaleEnabled**: bool: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku @@ -1193,286 +1071,305 @@ If false, apps assigned to this App Service plan will scale to all * **targetWorkerSizeId**: int: Scaling worker size ID. * **workerTierName**: string: Target worker tier assigned to the App Service plan. -## KubeEnvironmentProfile +## ArcConfiguration ### Properties -* **id**: string: Resource ID of the Kubernetes Environment. -* **name**: string (ReadOnly): Name of the Kubernetes Environment. -* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. +* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' +* **artifactStorageAccessMode**: string +* **artifactStorageClassName**: string +* **artifactStorageMountPath**: string +* **artifactStorageNodeName**: string +* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) +* **kubeConfig**: string (WriteOnly) -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## ArmPlan ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **name**: string: The name. +* **product**: string: The product. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher. +* **version**: string: Version of product. -## VnetRouteProperties +## AseV3NetworkingConfigurationProperties ### Properties -* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' (WriteOnly): 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 +* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE +* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem +* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem -These values will be used for syncing an app's routes with those from a Virtual Network. -* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +## AuthPlatform +### Properties +* **configFilePath**: string: 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. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## ManagedServiceIdentity +## AutoHealActions ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealCustomAction ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## UserAssignedIdentity +## AutoHealRules ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## SiteProperties +## AutoHealTriggers ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **storageAccountRequired**: bool: Checks if Customer provided storage account is required -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. -* **virtualNetworkSubnetId**: 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} +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. -## CloningInfo +## AzureActiveDirectory ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. -## CloningInfoAppSettingsOverrides +## AzureActiveDirectoryLogin +### Properties +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". + +## AzureActiveDirectoryRegistration +### Properties +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 + +## AzureActiveDirectoryValidation +### Properties +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureStaticWebApps +### Properties +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider + +## AzureStaticWebAppsRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. + +## AzureStorageInfoValue +### Properties +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. + +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## HostNameSslState +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## SiteConfig +## AzureTableStorageApplicationLogsConfig ### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans -* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site -This setting only applies to the Elastic Plans -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publicNetworkAccess**: string: Property to allow or block all public traffic. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **websiteTimeZone**: 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 -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## ApiDefinitionInfo +## BackupItem ### Properties -* **url**: string: The URL of the API definition. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## ApiManagementConfig +## BackupItem ### Properties -* **id**: string: APIM-Api Identifier. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## AutoHealRules +## BackupItemCollection ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealActions +## BackupItemCollection ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealCustomAction +## BackupItemProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## AutoHealTriggers +## BackupRequest ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## RequestsBasedTrigger +## BackupRequest ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SlowRequestsBasedTrigger +## BackupRequestProperties ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## StatusCodesBasedTrigger +## BackupSchedule ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## StatusCodesRangeBasedTrigger +## BlobStorageTokenStore ### Properties -* **count**: int: Request Count. -* **path**: string -* **statusCodes**: string: HTTP status code. -* **timeInterval**: string: Time interval. +* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. -## SiteConfigAzureStorageAccounts +## Capability +### Properties +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. + +## CertificateProperties +### Properties +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **domainValidationMethod**: string: Method of domain validation for free cert. Possible values include: 'CNameValidationValue', 'HttpTokenValidationValue' +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. + +## ClientRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## AzureStorageInfoValue +## ConnectionStringDictionaryProperties ### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) ## ConnStringInfo ### Properties @@ -1480,6 +1377,16 @@ before taking the action * **name**: string: Name of connection string. * **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CookieExpiration +### Properties +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. + ## CorsSettings ### Properties * **allowedOrigins**: string[]: Gets or sets the list of origins that should be allowed to make cross-origin @@ -1488,230 +1395,158 @@ calls (for example: http://example.com:12345). Use "*" to allow all. https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. -## Experiments +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## RampUpRule +## CustomOpenIdConnectProvider ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. -## HandlerMapping +## DatabaseBackupSetting ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## IpSecurityRestriction +## DeploymentProperties ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -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. +## EnabledConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## ErrorEntity +### Properties +* **code**: string: Basic error code. +* **extendedCode**: string: Type of error. +* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. +* **message**: string: Any details of the error. +* **messageTemplate**: string: Message template. +* **parameters**: string[]: Parameters for the template. -## IpSecurityRestrictionHeaders +## Experiments ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## SiteLimits +## ExtendedLocation ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **name**: string: Name of extended location. +* **type**: string (ReadOnly): Type of extended location. -## SiteMachineKey +## Facebook ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets -## PushSettings +## FileSystemApplicationLogsConfig ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -## PushSettingsProperties +## FileSystemHttpLogsConfig ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. -## VirtualApplication +## FileSystemTokenStore ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **directory**: string: The directory in which the tokens will be stored. -## VirtualDirectory +## ForwardProxy ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. +* **customHostHeaderName**: string: The name of the header containing the host of the request. +* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. -## SlotSwapStatus +## FrontEndConfiguration ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **kind**: 'LoadBalancer' | 'NodePort' -## ResourceTags +## FunctionEnvelopeProperties +### Properties +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. + +## FunctionEnvelopePropertiesFiles ### Properties ### Additional Properties * **Additional Properties Type**: string -## CsmPublishingCredentialsPoliciesEntityProperties +## FunctionSecrets ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## StringDictionaryProperties +## FunctionSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## SiteAuthSettingsProperties +## FunctionSecrets ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **configVersion**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## SiteAuthSettingsV2Properties +## FunctionSecrets ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## GitHub +### Properties +* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets + +## GitHubActionCodeConfiguration +### Properties +* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. +* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. + +## GitHubActionConfiguration +### Properties +* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. +* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. +* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. +* **isLinux**: bool: This will help determine the workflow configuration to select. + +## GitHubActionContainerConfiguration +### Properties +* **imageName**: string: The image name for the build. +* **password**: string: The password used to upload the image to the container registry. +* **serverUrl**: string: The server URL for the container registry where the build will be hosted. +* **username**: string: The username used to upload the image to the container registry. ## GlobalValidation ### Properties @@ -1722,171 +1557,188 @@ action is set to "RedirectToLoginPage". * **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. * **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. -## HttpSettings -### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. -* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. - -## ForwardProxy -### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. -* **customHostHeaderName**: string: The name of the header containing the host of the request. -* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. - -## HttpSettingsRoutes -### Properties -* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. - -## IdentityProviders +## Google ### Properties -* **apple**: [Apple](#apple): The configuration settings of the Apple provider. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. -* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. -* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. -* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. -* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. -* **google**: [Google](#google): The configuration settings of the Google provider. -* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. -* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. +* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## Apple +## HandlerMapping ### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## LoginScopes +## HostingEnvironmentProfile ### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## AppleRegistration +## HostKeys ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureActiveDirectory +## HostKeys ### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureActiveDirectoryLogin +## HostKeysFunctionKeys ### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". +### Additional Properties +* **Additional Properties Type**: string -## AzureActiveDirectoryRegistration +## HostKeysSystemKeys ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +### Additional Properties +* **Additional Properties Type**: string -## AzureActiveDirectoryValidation +## HostNameBindingProperties ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## JwtClaimChecks +## HostNameSslState ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AzureStaticWebApps +## HttpLogsConfig ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## AzureStaticWebAppsRegistration +## HttpSettings ### Properties -* **clientId**: string: The Client ID of the app used for login. +* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. +* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## IdentityProvidersCustomOpenIdConnectProviders +## HttpSettingsRoutes ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. -## CustomOpenIdConnectProvider +## HybridConnectionKey ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## OpenIdConnectLogin +## HybridConnectionKeyProperties ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## OpenIdConnectRegistration +## HybridConnectionProperties ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## OpenIdConnectClientCredential +## IdentifierProperties ### Properties -* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. -* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. +* **id**: string: String representation of the identity. -## OpenIdConnectConfig +## IdentityProviders ### Properties -* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. -* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. -* **issuer**: string: The endpoint that issues the token. -* **tokenEndpoint**: string: The endpoint to be used to request a token. -* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. +* **apple**: [Apple](#apple): The configuration settings of the Apple provider. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. +* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. +* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. +* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. +* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. +* **google**: [Google](#google): The configuration settings of the Google provider. +* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. +* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## Facebook +## IdentityProvidersCustomOpenIdConnectProviders ### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## AppRegistration +## IpSecurityRestriction ### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## GitHub +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. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +### Additional Properties +* **Additional Properties Type**: string[] -## ClientRegistration +## JwtClaimChecks ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## Google +## KubeEnvironmentProfile ### Properties -* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **id**: string: Resource ID of the Kubernetes Environment. +* **name**: string (ReadOnly): Name of the Kubernetes Environment. +* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. -## AllowedAudiencesValidation +## KubeEnvironmentProperties ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **aksResourceID**: string +* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) +* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) +* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster +* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation +* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet +* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. +* **staticIp**: string: Static IP of the KubeEnvironment ## LegacyMicrosoftAccount ### Properties @@ -1895,312 +1747,453 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets * **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## Twitter -### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. - -## TwitterRegistration +## LogAnalyticsConfiguration ### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **customerId**: string +* **sharedKey**: string (WriteOnly) ## Login ### Properties * **allowedExternalRedirectUrls**: 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. -* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. -* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. -* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. -* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. -* **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. - -## CookieExpiration -### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. - -## Nonce -### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. +Note that URLs within the current domain are always implicitly allowed. +* **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. +* **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. +* **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. +* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. +* **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. ## LoginRoutes ### Properties * **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## TokenStore +## LoginScopes ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. -* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. -* **tokenRefreshExtensionHours**: int: 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. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## BlobStorageTokenStore +## ManagedServiceIdentity ### Properties -* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## FileSystemTokenStore +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **directory**: string: The directory in which the tokens will be stored. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## AuthPlatform +## MSDeployCore ### Properties -* **configFilePath**: string: 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. -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## AzureStoragePropertyDictionaryResourceProperties +## MSDeployCoreSetParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## BackupRequestProperties +## NameValuePair ### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. +* **name**: string: Pair name. +* **value**: string: Pair value. -## BackupSchedule +## Nonce ### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. -## DatabaseBackupSetting +## OpenIdConnectClientCredential ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. +* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. -## ConnectionStringDictionaryProperties +## OpenIdConnectConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. +* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. +* **issuer**: string: The endpoint that issues the token. +* **tokenEndpoint**: string: The endpoint to be used to request a token. +* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## ConnStringValueTypePair +## OpenIdConnectLogin ### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## SiteLogsConfigProperties +## OpenIdConnectRegistration ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. -## ApplicationLogsConfig +## PremierAddOnProperties ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## AzureBlobStorageApplicationLogsConfig +## PrivateAccessProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## AzureTableStorageApplicationLogsConfig +## PrivateAccessSubnet ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## FileSystemApplicationLogsConfig +## PrivateAccessVirtualNetwork ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## EnabledConfig +## PrivateLinkConnectionApprovalRequest ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## HttpLogsConfig +## PrivateLinkConnectionState ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## AzureBlobStorageHttpLogsConfig +## PublicCertificateProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FileSystemHttpLogsConfig +## PushSettings ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## SlotConfigNames +## RampUpRule ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. -## DeploymentProperties +## RelayServiceConnectionEntityProperties ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## IdentifierProperties +## RemotePrivateEndpointConnection ### Properties -* **id**: string: String representation of the identity. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties +* **type**: string (ReadOnly): Resource type. -## MSDeployCore +## RemotePrivateEndpointConnectionProperties ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## MSDeployCoreSetParameters +## RequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## ResourceTags ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +### Additional Properties +* **Additional Properties Type**: string -## FunctionEnvelopePropertiesFiles +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostNameBindingProperties +## ResourceTags ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: string -## RelayServiceConnectionEntityProperties +## ResourceTags ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionProperties +## ResourceTags ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +### Additional Properties +* **Additional Properties Type**: string -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResponseMessageEnvelopeRemotePrivateEndpointConnection ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. +* **id**: string: 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} +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. +* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. +* **name**: string: Name of resource. +* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. +* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection +* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. +* **status**: string: Azure-AsyncOperation Status info. +* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. +* **type**: string: Type of resource e.g "Microsoft.Web/sites". +* **zones**: string[]: Logical Availability Zones the service is hosted in -## PrivateAccessVirtualNetwork +## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessSubnet +## SiteAuthSettingsProperties ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **configVersion**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. + +## SiteAuthSettingsV2Properties +### Properties +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. + +## SiteConfig +### Properties +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans +* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site +This setting only applies to the Elastic Plans +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publicNetworkAccess**: string: Property to allow or block all public traffic. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **websiteTimeZone**: 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 +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id -## PublicCertificateProperties +## SiteConfigAzureStorageAccounts ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -2225,35 +2218,77 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **storageAccountRequired**: bool: Checks if Customer provided storage account is required +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **virtualNetworkSubnetId**: 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} ## SiteSourceControlProperties ### Properties @@ -2265,43 +2300,43 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## GitHubActionConfiguration +## SkuCapacity ### Properties -* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. -* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. -* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. -* **isLinux**: bool: This will help determine the workflow configuration to select. +* **default**: int: Default number of workers for this App Service plan SKU. +* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## GitHubActionCodeConfiguration +## SkuDescription ### Properties -* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. -* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. -## GitHubActionContainerConfiguration +## SlotConfigNames ### Properties -* **imageName**: string: The image name for the build. -* **password**: string: The password used to upload the image to the container registry. -* **serverUrl**: string: The server URL for the container registry where the build will be hosted. -* **username**: string: The username used to upload the image to the container registry. +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. -## VnetInfoProperties +## SlotSwapStatus ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. -## VnetRoute +## SlowRequestsBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **path**: string: Request Path. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2338,59 +2373,14 @@ Point-To-Site VPN connection. * **outputLocation**: string: The output path of the app after building. * **skipGithubActionWorkflowGeneration**: bool: Skip Github Action workflow generation. -## ResponseMessageEnvelopeRemotePrivateEndpointConnection -### Properties -* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. -* **id**: string: 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} -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. -* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. -* **name**: string: Name of resource. -* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. -* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection -* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. -* **status**: string: Azure-AsyncOperation Status info. -* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. -* **type**: string: Type of resource e.g "Microsoft.Web/sites". -* **zones**: string[]: Logical Availability Zones the service is hosted in - -## ErrorEntity -### Properties -* **code**: string: Basic error code. -* **extendedCode**: string: Type of error. -* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. -* **message**: string: Any details of the error. -* **messageTemplate**: string: Message template. -* **parameters**: string[]: Parameters for the template. - -## ArmPlan -### Properties -* **name**: string: The name. -* **product**: string: The product. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher. -* **version**: string: Version of product. - -## RemotePrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties -* **type**: string (ReadOnly): Resource type. - -## RemotePrivateEndpointConnectionProperties -### Properties -* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags +## StaticSiteCustomDomainRequestPropertiesARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. +* **domainName**: string (ReadOnly): The domain name for the static site custom domain. +* **errorMessage**: string (ReadOnly) +* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' | string (ReadOnly): The status of the custom domain +* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain +* **validationToken**: string (ReadOnly): The TXT record validation token ## StaticSiteTemplateOptions ### Properties @@ -2400,34 +2390,33 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **repositoryName**: string: Name of the newly generated repository. * **templateRepositoryUrl**: string: URL of the template repository. The newly generated repository will be based on this one. -## StaticSiteUserProvidedFunctionApp +## StaticSiteUserARMResource ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserProvidedFunctionAppProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. -* **functionAppRegion**: string: The region of the function app registered with the static site -* **functionAppResourceId**: string: The resource id of the function app registered with the static site - -## ResourceTags +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## StringDictionaryProperties +## StaticSiteUserProvidedFunctionApp ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **type**: string (ReadOnly): Resource type. ## StaticSiteUserProvidedFunctionAppARMResourceProperties ### Properties @@ -2435,58 +2424,36 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **functionAppRegion**: string: The region of the function app registered with the static site * **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties +## StaticSiteUserProvidedFunctionAppProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. +* **functionAppRegion**: string: The region of the function app registered with the static site +* **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StaticSiteCustomDomainRequestPropertiesARMResourceProperties +## StatusCodesBasedTrigger ### Properties -* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. -* **domainName**: string (ReadOnly): The domain name for the static site custom domain. -* **errorMessage**: string (ReadOnly) -* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' (ReadOnly): The status of the custom domain -* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain -* **validationToken**: string (ReadOnly): The TXT record validation token +* **count**: int: Request Count. +* **path**: string: Request Path +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupRequest +## StatusCodesRangeBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **path**: string +* **statusCodes**: string: HTTP status code. +* **timeInterval**: string: Time interval. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2495,25 +2462,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2540,22 +2494,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## StringList +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: string[] (ReadOnly): List of string resources. +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2574,102 +2518,158 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## StringDictionaryProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringList ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: string[] (ReadOnly): List of string resources. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## SwiftVirtualNetworkProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## FunctionSecrets +## TokenStore ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. +* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. +* **tokenRefreshExtensionHours**: int: 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. -## FunctionSecrets +## Twitter ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## FunctionSecrets +## TwitterRegistration ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. -## StaticSiteUserCollection +## UserAssignedIdentity ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity -## StaticSiteUserARMResource +## UserProperties +### Properties +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. + +## VirtualApplication +### Properties +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. + +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualNetworkProfile +### Properties +* **id**: string (Required): Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfoProperties +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | string (WriteOnly): 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. +* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2021-02-01/types.json b/generated/web/microsoft.web/2021-02-01/types.json index 974806d009..e78f40c00e 100644 --- a/generated/web/microsoft.web/2021-02-01/types.json +++ b/generated/web/microsoft.web/2021-02-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":0,"Description":"Dedicated Host Count"},"zoneRedundant":{"Type":2,"Flags":0,"Description":"Whether or not this App Service Environment is zone-redundant."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"externalInboundIpAddresses":{"Type":41,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesExternalInboundIpAddressesItem"},"internalInboundIpAddresses":{"Type":42,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesInternalInboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-02-01","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":44,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":52,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":53,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[49,50,51]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":55,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":56,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":58,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":57}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-02-01","ScopeType":8,"Body":47}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":60,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":61,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":66,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":62}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":68,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":69,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-02-01","ScopeType":8,"Body":70}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":89,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":79,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"elasticScaleEnabled":{"Type":2,"Flags":0,"Description":"ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":86,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":87,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."},"zoneRedundant":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[76,77,78]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[81,82,83,84,85]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-02-01","ScopeType":8,"Body":74}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":91,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":92,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-02-01","ScopeType":8,"Body":93}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":96,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":97,"Flags":10,"Description":"The resource api version"},"properties":{"Type":99,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":103,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[100,101,102]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-02-01","ScopeType":8,"Body":98}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":105,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":106,"Flags":10,"Description":"The resource api version"},"properties":{"Type":108,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":122,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":109,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":80,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":121,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[110,111,112,113,114,115,116,117,118,119,120]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-02-01","ScopeType":8,"Body":107}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":124,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":125,"Flags":10,"Description":"The resource api version"},"properties":{"Type":127,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":149,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":138,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"arcConfiguration":{"Type":139,"Flags":0},"appLogsConfiguration":{"Type":147,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[128,129,130,131,132,133,134,135,136,137]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":142,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":143,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[140,141]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":146,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[144,145]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":148,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-02-01","ScopeType":8,"Body":126}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":151,"Flags":9,"Description":"The resource name"},"type":{"Type":152,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":153,"Flags":10,"Description":"The resource api version"},"properties":{"Type":155,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-02-01","ScopeType":1,"Body":154}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":157,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":158,"Flags":10,"Description":"The resource api version"},"properties":{"Type":160,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-02-01","ScopeType":1,"Body":159}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":162,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":163,"Flags":10,"Description":"The resource api version"},"properties":{"Type":165,"Flags":0,"Description":"A static site."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":195,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":166,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":167,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":187,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":190,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":191,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":194,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":169,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":170,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":171,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":174,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":186,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":172,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":173,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":175,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":176,"Flags":0,"Description":"Inner errors."},"details":{"Type":177,"Flags":0,"Description":"Error Details."},"target":{"Type":4,"Flags":0,"Description":"The error target."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":174}},{"3":{"ItemType":174}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":183,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":185,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[179,180,181,182]}},{"2":{"Name":"UserAssignedIdentity","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":184}},{"3":{"ItemType":4}},{"3":{"ItemType":168}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[188,189]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":193,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":192}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-02-01","ScopeType":8,"Body":164}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":197,"Flags":9,"Description":"The resource name"},"type":{"Type":198,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":199,"Flags":10,"Description":"The resource api version"},"properties":{"Type":201,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":202,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":206,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":200,"functionappsettings":205}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-02-01","ScopeType":8,"Body":207}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":209,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":210,"Flags":10,"Description":"The resource api version"},"properties":{"Type":212,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-02-01","ScopeType":8,"Body":211}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":214,"Flags":9,"Description":"The resource name"},"type":{"Type":215,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":216,"Flags":10,"Description":"The resource api version"},"properties":{"Type":218,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":219,"Flags":9,"Description":"The resource name"},"type":{"Type":220,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":221,"Flags":10,"Description":"The resource api version"},"properties":{"Type":223,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":217,"functionappsettings":222}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-02-01","ScopeType":8,"Body":224}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":236,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[230,231,232,233,234,235]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-02-01","ScopeType":8,"Body":228}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":238,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":239,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":240}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":242,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":243,"Flags":10,"Description":"The resource api version"},"properties":{"Type":212,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-02-01","ScopeType":8,"Body":244}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":246,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":247,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":387,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":250,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":253,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":254,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":258,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":267,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":268,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":373,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":377,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":378,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":380,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":386,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[251,252]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[255,256,257]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":263,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":266,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[260,261,262]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[264,265]}},{"3":{"ItemType":259}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":269,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":270,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":284,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":285,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":287,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":302,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":305,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":309,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":316,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":317,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":320,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":321,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":336,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":338,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":340,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":341,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":349,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":350,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":354,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":358,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":362,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":372,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":283,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[272,273,274,275,276,277,278,279,280,281,282]}},{"3":{"ItemType":271}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":286}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[288,289,290,291,292,293,294,295,296,297,298,299,300,301]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[303,304]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":308,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":307}},{"3":{"ItemType":306}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[310,311,312,313,314,315]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":319,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":318}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":322,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":330,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":323,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":325,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":326,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":327,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":329,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":324}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":326}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":328}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":334,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":335,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[331,332,333]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":337,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":339,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":346,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":348,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[343,344,345]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":347}},{"3":{"ItemType":342}},{"3":{"ItemType":342}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[351,352,353]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[355,356,357]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[359,360,361]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":366,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":371,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[364,365]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[367,368,369,370]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":363}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[374,375,376]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":379,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[381,382,383,384,385]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-02-01","ScopeType":8,"Body":248}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":394,"Flags":9,"Description":"The resource name"},"type":{"Type":395,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":396,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":392,"scm":397}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-02-01","ScopeType":8,"Body":398}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":400,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":404,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":405,"Flags":9,"Description":"The resource name"},"type":{"Type":406,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":407,"Flags":10,"Description":"The resource api version"},"properties":{"Type":409,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":412,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":413,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":420,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":421,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":422,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":423,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":424,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":425,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":426,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[410,411]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[414,415,416,417,418,419]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":427,"Flags":9,"Description":"The resource name"},"type":{"Type":428,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":429,"Flags":10,"Description":"The resource api version"},"properties":{"Type":431,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":432,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":433,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":440,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":479,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":490,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":438,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":439,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[434,435,436,437]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":441,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":455,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":459,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":461,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":464,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":465,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":467,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":469,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":478,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":442,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":443,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":445,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":444,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":446,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":449,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."},"defaultAuthorizationPolicy":{"Type":450,"Flags":0,"Description":"The configuration settings of the Azure Active Directory default authorization policy."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":447,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":448,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"DefaultAuthorizationPolicy","Properties":{"allowedPrincipals":{"Type":451,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed principals."},"allowedApplications":{"Type":454,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed applications."}}}},{"2":{"Name":"AllowedPrincipals","Properties":{"groups":{"Type":452,"Flags":0,"Description":"The list of the allowed groups."},"identities":{"Type":453,"Flags":0,"Description":"The list of the allowed identities."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":456,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":458,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":462,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":463,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":462,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":466,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":468,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":470,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":472,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":476,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":473,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":475,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":474,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":477,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":471}},{"2":{"Name":"Login","Properties":{"routes":{"Type":480,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":481,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":484,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":485,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":489,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":482,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":483,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":488,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[486,487]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":491,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":492,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":496,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[493,494,495]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":497,"Flags":9,"Description":"The resource name"},"type":{"Type":498,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":499,"Flags":10,"Description":"The resource api version"},"properties":{"Type":501,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":363}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":502,"Flags":9,"Description":"The resource name"},"type":{"Type":503,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":504,"Flags":10,"Description":"The resource api version"},"properties":{"Type":506,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":507,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":517,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":510,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[508,509]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":516,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[512,513,514,515]}},{"3":{"ItemType":511}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":518,"Flags":9,"Description":"The resource name"},"type":{"Type":519,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":520,"Flags":10,"Description":"The resource api version"},"properties":{"Type":535,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":534,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[523,524,525,526,527,528,529,530,531,532,533]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":522}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":536,"Flags":9,"Description":"The resource name"},"type":{"Type":537,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":538,"Flags":10,"Description":"The resource api version"},"properties":{"Type":540,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":541,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":563,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":566,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":566,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":542,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":549,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":556,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":548,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[543,544,545,546,547]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":555,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[550,551,552,553,554]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":562,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[557,558,559,560,561]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":564,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":565,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":567,"Flags":9,"Description":"The resource name"},"type":{"Type":568,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":569,"Flags":10,"Description":"The resource api version"},"properties":{"Type":571,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":572,"Flags":9,"Description":"The resource name"},"type":{"Type":573,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":574,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":576,"Flags":9,"Description":"The resource name"},"type":{"Type":577,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":578,"Flags":10,"Description":"The resource api version"},"properties":{"Type":580,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":581,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":582,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":583,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":584,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"},"properties":{"Type":268,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":403,"authsettings":408,"authsettingsV2":430,"azurestorageaccounts":500,"backup":505,"connectionstrings":521,"logs":539,"metadata":570,"pushsettings":575,"slotConfigNames":579,"web":587}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-02-01","ScopeType":8,"Body":588}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":590,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":591,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-02-01","ScopeType":8,"Body":592}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":595,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":596,"Flags":10,"Description":"The resource api version"},"properties":{"Type":598,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-02-01","ScopeType":8,"Body":597}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":600,"Flags":9,"Description":"The resource name"},"type":{"Type":601,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":602,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":605,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":611,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[606,607,608,609,610]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-02-01","ScopeType":8,"Body":603}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":613,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":614,"Flags":10,"Description":"The resource api version"},"properties":{"Type":616,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":617,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-02-01","ScopeType":8,"Body":615}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":619,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":620,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-02-01","ScopeType":8,"Body":621}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":623,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":624,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":629,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":632,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":635,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":639,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[627,628]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[630,631]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[633,634]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[636,637,638]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-02-01","ScopeType":8,"Body":625}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":641,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":642,"Flags":10,"Description":"The resource api version"},"properties":{"Type":644,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-02-01","ScopeType":8,"Body":643}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":646,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":647,"Flags":10,"Description":"The resource api version"},"properties":{"Type":649,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-02-01","ScopeType":8,"Body":648}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":651,"Flags":9,"Description":"The resource name"},"type":{"Type":652,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":653,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-02-01","ScopeType":8,"Body":654}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":656,"Flags":9,"Description":"The resource name"},"type":{"Type":657,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":658,"Flags":10,"Description":"The resource api version"},"properties":{"Type":660,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-02-01","ScopeType":8,"Body":659}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":662,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":663,"Flags":10,"Description":"The resource api version"},"properties":{"Type":665,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":666,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-02-01","ScopeType":8,"Body":664}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":668,"Flags":9,"Description":"The resource name"},"type":{"Type":669,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":670,"Flags":10,"Description":"The resource api version"},"properties":{"Type":672,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":676,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":675,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":674}},{"3":{"ItemType":673}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-02-01","ScopeType":8,"Body":671}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":678,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":679,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":680}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":682,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":683,"Flags":10,"Description":"The resource api version"},"properties":{"Type":685,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":689,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[686,687,688]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-02-01","ScopeType":8,"Body":684}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":691,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":692,"Flags":10,"Description":"The resource api version"},"properties":{"Type":694,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":697,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":698,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[695,696]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-02-01","ScopeType":8,"Body":693}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":700,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":701,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":703,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-02-01","ScopeType":8,"Body":702}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":705,"Flags":9,"Description":"The resource name"},"type":{"Type":706,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":707,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":709,"Flags":9,"Description":"The resource name"},"type":{"Type":710,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":711,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":708,"scm":712}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-02-01","ScopeType":8,"Body":713}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":715,"Flags":9,"Description":"The resource name"},"type":{"Type":716,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":717,"Flags":10,"Description":"The resource api version"},"properties":{"Type":719,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":720,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":409,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":724,"Flags":9,"Description":"The resource name"},"type":{"Type":725,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":726,"Flags":10,"Description":"The resource api version"},"properties":{"Type":431,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":728,"Flags":9,"Description":"The resource name"},"type":{"Type":729,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":730,"Flags":10,"Description":"The resource api version"},"properties":{"Type":732,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":363}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":733,"Flags":9,"Description":"The resource name"},"type":{"Type":734,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":735,"Flags":10,"Description":"The resource api version"},"properties":{"Type":506,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":737,"Flags":9,"Description":"The resource name"},"type":{"Type":738,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":739,"Flags":10,"Description":"The resource api version"},"properties":{"Type":741,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":522}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":742,"Flags":9,"Description":"The resource name"},"type":{"Type":743,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":744,"Flags":10,"Description":"The resource api version"},"properties":{"Type":540,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":746,"Flags":9,"Description":"The resource name"},"type":{"Type":747,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":748,"Flags":10,"Description":"The resource api version"},"properties":{"Type":750,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":751,"Flags":9,"Description":"The resource name"},"type":{"Type":752,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":753,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":755,"Flags":9,"Description":"The resource name"},"type":{"Type":756,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":757,"Flags":10,"Description":"The resource api version"},"properties":{"Type":268,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":718,"authsettings":723,"authsettingsV2":727,"azurestorageaccounts":731,"backup":736,"connectionstrings":740,"logs":745,"metadata":749,"pushsettings":754,"web":758}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-02-01","ScopeType":8,"Body":759}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":761,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":762,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-02-01","ScopeType":8,"Body":763}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":765,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":766,"Flags":10,"Description":"The resource api version"},"properties":{"Type":598,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-02-01","ScopeType":8,"Body":767}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":769,"Flags":9,"Description":"The resource name"},"type":{"Type":770,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":771,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-02-01","ScopeType":8,"Body":772}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":774,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":775,"Flags":10,"Description":"The resource api version"},"properties":{"Type":616,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-02-01","ScopeType":8,"Body":776}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-02-01","ScopeType":8,"Body":780}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":782,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":783,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-02-01","ScopeType":8,"Body":784}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":786,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":787,"Flags":10,"Description":"The resource api version"},"properties":{"Type":644,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-02-01","ScopeType":8,"Body":788}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":790,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":791,"Flags":10,"Description":"The resource api version"},"properties":{"Type":649,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-02-01","ScopeType":8,"Body":792}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":794,"Flags":9,"Description":"The resource name"},"type":{"Type":795,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":796,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-02-01","ScopeType":8,"Body":797}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":799,"Flags":9,"Description":"The resource name"},"type":{"Type":800,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":801,"Flags":10,"Description":"The resource api version"},"properties":{"Type":660,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2021-02-01","ScopeType":8,"Body":802}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":804,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":805,"Flags":10,"Description":"The resource api version"},"properties":{"Type":665,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":807,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-02-01","ScopeType":8,"Body":806}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":809,"Flags":9,"Description":"The resource name"},"type":{"Type":810,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":811,"Flags":10,"Description":"The resource api version"},"properties":{"Type":672,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-02-01","ScopeType":8,"Body":812}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":816}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":818,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":819,"Flags":10,"Description":"The resource api version"},"properties":{"Type":685,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-02-01","ScopeType":8,"Body":820}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":822,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":823,"Flags":10,"Description":"The resource api version"},"properties":{"Type":694,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-02-01","ScopeType":8,"Body":824}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":826,"Flags":9,"Description":"The resource name"},"type":{"Type":827,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":828,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":831,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":832,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":833,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-02-01","ScopeType":8,"Body":829}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":835,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":836,"Flags":10,"Description":"The resource api version"},"properties":{"Type":838,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfo","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":840,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":99,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":839}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-02-01","ScopeType":8,"Body":837}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":842,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":843,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-02-01","ScopeType":8,"Body":844}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":846,"Flags":9,"Description":"The resource name"},"type":{"Type":847,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":848,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-02-01","ScopeType":8,"Body":849}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":851,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":852,"Flags":10,"Description":"The resource api version"},"properties":{"Type":838,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-02-01","ScopeType":8,"Body":853}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":855,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":856,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-02-01","ScopeType":8,"Body":857}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":860,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-02-01","Output":859}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":865,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":864,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":863}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-02-01","Output":862}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":868,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":867}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":873,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":872}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":867}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":506,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":879,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":890,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":891,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[880,881,882,883,884,885,886,887,888,889]}},{"3":{"ItemType":511}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-02-01","Output":878,"Input":877}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-02-01","Output":867}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-02-01","Output":895}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":898,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":899,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-02-01","Output":897}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":902,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":878}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-02-01","Output":901}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-02-01","Output":895}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-02-01","Output":878,"Input":877}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-02-01","Output":895}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-02-01","Output":897}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-02-01","Output":901}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-02-01","Output":895}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":0,"Description":"Dedicated Host Count"},"zoneRedundant":{"Type":2,"Flags":0,"Description":"Whether or not this App Service Environment is zone-redundant."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27,4]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-02-01","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"externalInboundIpAddresses":{"Type":41,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesExternalInboundIpAddressesItem"},"internalInboundIpAddresses":{"Type":42,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesInternalInboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-02-01","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":44,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":52,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":53,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[49,50,51]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":55,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":56,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":58,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":57}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-02-01","ScopeType":8,"Body":47}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":60,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":61,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":66,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":62}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":68,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":69,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-02-01","ScopeType":8,"Body":70}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":89,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":79,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"elasticScaleEnabled":{"Type":2,"Flags":0,"Description":"ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":86,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":87,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."},"zoneRedundant":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[76,77,78]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[81,82,83,84,85]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-02-01","ScopeType":8,"Body":74}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":91,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":92,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-02-01","ScopeType":8,"Body":93}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":96,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":97,"Flags":10,"Description":"The resource api version"},"properties":{"Type":99,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":103,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[100,101,102,4]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-02-01","ScopeType":8,"Body":98}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":105,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":106,"Flags":10,"Description":"The resource api version"},"properties":{"Type":108,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":122,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":109,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":80,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":121,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[110,111,112,113,114,115,116,117,118,119,120]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-02-01","ScopeType":8,"Body":107}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":124,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":125,"Flags":10,"Description":"The resource api version"},"properties":{"Type":127,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":149,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":138,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"arcConfiguration":{"Type":139,"Flags":0},"appLogsConfiguration":{"Type":147,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[128,129,130,131,132,133,134,135,136,137]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":142,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":143,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[140,141]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":146,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[144,145]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":148,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-02-01","ScopeType":8,"Body":126}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":151,"Flags":9,"Description":"The resource name"},"type":{"Type":152,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":153,"Flags":10,"Description":"The resource api version"},"properties":{"Type":155,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-02-01","ScopeType":1,"Body":154}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":157,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":158,"Flags":10,"Description":"The resource api version"},"properties":{"Type":160,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-02-01","ScopeType":1,"Body":159}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":162,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":163,"Flags":10,"Description":"The resource api version"},"properties":{"Type":165,"Flags":0,"Description":"A static site."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":195,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":166,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":167,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":187,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":190,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":191,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":194,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":2,"Description":"The provider that submitted the last deployment to the primary environment of the static site."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":169,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":170,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":171,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":174,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":186,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":172,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":173,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":175,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":176,"Flags":0,"Description":"Inner errors."},"details":{"Type":177,"Flags":0,"Description":"Error Details."},"target":{"Type":4,"Flags":0,"Description":"The error target."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":174}},{"3":{"ItemType":174}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":183,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":185,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[179,180,181,182]}},{"2":{"Name":"UserAssignedIdentity","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":184}},{"3":{"ItemType":4}},{"3":{"ItemType":168}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[188,189]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":193,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":192}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-02-01","ScopeType":8,"Body":164}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":197,"Flags":9,"Description":"The resource name"},"type":{"Type":198,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":199,"Flags":10,"Description":"The resource api version"},"properties":{"Type":201,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":202,"Flags":9,"Description":"The resource name"},"type":{"Type":203,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":204,"Flags":10,"Description":"The resource api version"},"properties":{"Type":206,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":200,"functionappsettings":205}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-02-01","ScopeType":8,"Body":207}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":209,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":210,"Flags":10,"Description":"The resource api version"},"properties":{"Type":212,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-02-01","ScopeType":8,"Body":211}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":214,"Flags":9,"Description":"The resource name"},"type":{"Type":215,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":216,"Flags":10,"Description":"The resource api version"},"properties":{"Type":218,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":219,"Flags":9,"Description":"The resource name"},"type":{"Type":220,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":221,"Flags":10,"Description":"The resource api version"},"properties":{"Type":223,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":217,"functionappsettings":222}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-02-01","ScopeType":8,"Body":224}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":226,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":227,"Flags":10,"Description":"The resource api version"},"properties":{"Type":229,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":236,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[230,231,232,233,234,235,4]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-02-01","ScopeType":8,"Body":228}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":238,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":239,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":240}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":242,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":243,"Flags":10,"Description":"The resource api version"},"properties":{"Type":212,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-02-01","ScopeType":8,"Body":244}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":246,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":247,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":387,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":250,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":253,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":254,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":258,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":267,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":268,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":373,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":377,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":378,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":380,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":386,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[251,252]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[255,256,257]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":263,"Flags":0,"Description":"SSL type."},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":266,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[260,261,262]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[264,265]}},{"3":{"ItemType":259}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":269,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":270,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":284,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":285,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":287,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":302,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":305,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":309,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":316,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":317,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":320,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":321,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":336,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":338,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":340,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":341,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":349,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":350,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":354,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":358,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":362,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":372,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":283,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[272,273,274,275,276,277,278,279,280,281,282]}},{"3":{"ItemType":271}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":286}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[288,289,290,291,292,293,294,295,296,297,298,299,300,301,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[303,304]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":308,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":307}},{"3":{"ItemType":306}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[310,311,312,313,314,315]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":319,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":318}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":322,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":330,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":323,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":325,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":326,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":327,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":329,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":324}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":326}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":328}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":334,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":335,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[331,332,333]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":337,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":339,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":346,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":348,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[343,344,345,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":347}},{"3":{"ItemType":342}},{"3":{"ItemType":342}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[351,352,353,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[355,356,357,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[359,360,361,4]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":366,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":371,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[364,365]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[367,368,369,370]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":363}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[374,375,376]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":379,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[381,382,383,384,385]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-02-01","ScopeType":8,"Body":248}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":389,"Flags":9,"Description":"The resource name"},"type":{"Type":390,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":391,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":394,"Flags":9,"Description":"The resource name"},"type":{"Type":395,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":396,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":392,"scm":397}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-02-01","ScopeType":8,"Body":398}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":400,"Flags":9,"Description":"The resource name"},"type":{"Type":401,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":402,"Flags":10,"Description":"The resource api version"},"properties":{"Type":404,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":405,"Flags":9,"Description":"The resource name"},"type":{"Type":406,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":407,"Flags":10,"Description":"The resource api version"},"properties":{"Type":409,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":412,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":413,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":420,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":421,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":422,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":423,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":424,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":425,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":426,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[410,411]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[414,415,416,417,418,419]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":427,"Flags":9,"Description":"The resource name"},"type":{"Type":428,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":429,"Flags":10,"Description":"The resource api version"},"properties":{"Type":431,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":432,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":433,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":440,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":479,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":490,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":438,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":439,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[434,435,436,437]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":441,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":455,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":459,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":461,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":464,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":465,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":467,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":469,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":478,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":442,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":443,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":445,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":444,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":446,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":449,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."},"defaultAuthorizationPolicy":{"Type":450,"Flags":0,"Description":"The configuration settings of the Azure Active Directory default authorization policy."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":447,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":448,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"DefaultAuthorizationPolicy","Properties":{"allowedPrincipals":{"Type":451,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed principals."},"allowedApplications":{"Type":454,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed applications."}}}},{"2":{"Name":"AllowedPrincipals","Properties":{"groups":{"Type":452,"Flags":0,"Description":"The list of the allowed groups."},"identities":{"Type":453,"Flags":0,"Description":"The list of the allowed identities."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":456,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":458,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":462,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":463,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":460,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":462,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":466,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":468,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":457,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":470,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":472,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":476,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":473,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":475,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":474,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":477,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":471}},{"2":{"Name":"Login","Properties":{"routes":{"Type":480,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":481,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":484,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":485,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":489,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":482,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":483,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":488,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[486,487]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":491,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":492,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":496,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[493,494,495]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":497,"Flags":9,"Description":"The resource name"},"type":{"Type":498,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":499,"Flags":10,"Description":"The resource api version"},"properties":{"Type":501,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":363}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":502,"Flags":9,"Description":"The resource name"},"type":{"Type":503,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":504,"Flags":10,"Description":"The resource api version"},"properties":{"Type":506,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":507,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":517,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":510,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[508,509]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":516,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[512,513,514,515,4]}},{"3":{"ItemType":511}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":518,"Flags":9,"Description":"The resource name"},"type":{"Type":519,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":520,"Flags":10,"Description":"The resource api version"},"properties":{"Type":535,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":534,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[523,524,525,526,527,528,529,530,531,532,533]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":522}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":536,"Flags":9,"Description":"The resource name"},"type":{"Type":537,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":538,"Flags":10,"Description":"The resource api version"},"properties":{"Type":540,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":541,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":563,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":566,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":566,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":542,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":549,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":556,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":548,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[543,544,545,546,547]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":555,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[550,551,552,553,554]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":562,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[557,558,559,560,561]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":564,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":565,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":567,"Flags":9,"Description":"The resource name"},"type":{"Type":568,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":569,"Flags":10,"Description":"The resource api version"},"properties":{"Type":571,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":572,"Flags":9,"Description":"The resource name"},"type":{"Type":573,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":574,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":576,"Flags":9,"Description":"The resource name"},"type":{"Type":577,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":578,"Flags":10,"Description":"The resource api version"},"properties":{"Type":580,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":581,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":582,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":583,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":584,"Flags":9,"Description":"The resource name"},"type":{"Type":585,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":586,"Flags":10,"Description":"The resource api version"},"properties":{"Type":268,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":403,"authsettings":408,"authsettingsV2":430,"azurestorageaccounts":500,"backup":505,"connectionstrings":521,"logs":539,"metadata":570,"pushsettings":575,"slotConfigNames":579,"web":587}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-02-01","ScopeType":8,"Body":588}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":590,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":591,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-02-01","ScopeType":8,"Body":592}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":595,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":596,"Flags":10,"Description":"The resource api version"},"properties":{"Type":598,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-02-01","ScopeType":8,"Body":597}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":600,"Flags":9,"Description":"The resource name"},"type":{"Type":601,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":602,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":605,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":611,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[606,607,608,609,610]}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-02-01","ScopeType":8,"Body":603}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":613,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":614,"Flags":10,"Description":"The resource api version"},"properties":{"Type":616,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":617,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-02-01","ScopeType":8,"Body":615}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":619,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":620,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-02-01","ScopeType":8,"Body":621}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":623,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":624,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":629,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":632,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":635,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":639,"Flags":0,"Description":"SSL type."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[627,628]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[630,631]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[633,634]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[636,637,638]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-02-01","ScopeType":8,"Body":625}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":641,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":642,"Flags":10,"Description":"The resource api version"},"properties":{"Type":644,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-02-01","ScopeType":8,"Body":643}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":646,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":647,"Flags":10,"Description":"The resource api version"},"properties":{"Type":649,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-02-01","ScopeType":8,"Body":648}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":651,"Flags":9,"Description":"The resource name"},"type":{"Type":652,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":653,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-02-01","ScopeType":8,"Body":654}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":656,"Flags":9,"Description":"The resource name"},"type":{"Type":657,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":658,"Flags":10,"Description":"The resource api version"},"properties":{"Type":660,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-02-01","ScopeType":8,"Body":659}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":662,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":663,"Flags":10,"Description":"The resource api version"},"properties":{"Type":665,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":666,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-02-01","ScopeType":8,"Body":664}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":668,"Flags":9,"Description":"The resource name"},"type":{"Type":669,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":670,"Flags":10,"Description":"The resource api version"},"properties":{"Type":672,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":676,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":675,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":674}},{"3":{"ItemType":673}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-02-01","ScopeType":8,"Body":671}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":678,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":679,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":680}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":682,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":683,"Flags":10,"Description":"The resource api version"},"properties":{"Type":685,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":689,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[686,687,688]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-02-01","ScopeType":8,"Body":684}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":691,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":692,"Flags":10,"Description":"The resource api version"},"properties":{"Type":694,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":697,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":698,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[695,696]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-02-01","ScopeType":8,"Body":693}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":700,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":701,"Flags":10,"Description":"The resource api version"},"properties":{"Type":249,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":178,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":703,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-02-01","ScopeType":8,"Body":702}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":705,"Flags":9,"Description":"The resource name"},"type":{"Type":706,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":707,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":709,"Flags":9,"Description":"The resource name"},"type":{"Type":710,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":711,"Flags":10,"Description":"The resource api version"},"properties":{"Type":393,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":708,"scm":712}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-02-01","ScopeType":8,"Body":713}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":715,"Flags":9,"Description":"The resource name"},"type":{"Type":716,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":717,"Flags":10,"Description":"The resource api version"},"properties":{"Type":719,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":720,"Flags":9,"Description":"The resource name"},"type":{"Type":721,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":722,"Flags":10,"Description":"The resource api version"},"properties":{"Type":409,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":724,"Flags":9,"Description":"The resource name"},"type":{"Type":725,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":726,"Flags":10,"Description":"The resource api version"},"properties":{"Type":431,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":728,"Flags":9,"Description":"The resource name"},"type":{"Type":729,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":730,"Flags":10,"Description":"The resource api version"},"properties":{"Type":732,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":363}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":733,"Flags":9,"Description":"The resource name"},"type":{"Type":734,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":735,"Flags":10,"Description":"The resource api version"},"properties":{"Type":506,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":737,"Flags":9,"Description":"The resource name"},"type":{"Type":738,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":739,"Flags":10,"Description":"The resource api version"},"properties":{"Type":741,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":522}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":742,"Flags":9,"Description":"The resource name"},"type":{"Type":743,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":744,"Flags":10,"Description":"The resource api version"},"properties":{"Type":540,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":746,"Flags":9,"Description":"The resource name"},"type":{"Type":747,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":748,"Flags":10,"Description":"The resource api version"},"properties":{"Type":750,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":751,"Flags":9,"Description":"The resource name"},"type":{"Type":752,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":753,"Flags":10,"Description":"The resource api version"},"properties":{"Type":339,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":755,"Flags":9,"Description":"The resource name"},"type":{"Type":756,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":757,"Flags":10,"Description":"The resource api version"},"properties":{"Type":268,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":718,"authsettings":723,"authsettingsV2":727,"azurestorageaccounts":731,"backup":736,"connectionstrings":740,"logs":745,"metadata":749,"pushsettings":754,"web":758}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-02-01","ScopeType":8,"Body":759}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":761,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":762,"Flags":10,"Description":"The resource api version"},"properties":{"Type":593,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-02-01","ScopeType":8,"Body":763}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":765,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":766,"Flags":10,"Description":"The resource api version"},"properties":{"Type":598,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-02-01","ScopeType":8,"Body":767}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":769,"Flags":9,"Description":"The resource name"},"type":{"Type":770,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":771,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-02-01","ScopeType":8,"Body":772}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":774,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":775,"Flags":10,"Description":"The resource api version"},"properties":{"Type":616,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-02-01","ScopeType":8,"Body":776}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-02-01","ScopeType":8,"Body":780}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":782,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":783,"Flags":10,"Description":"The resource api version"},"properties":{"Type":626,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-02-01","ScopeType":8,"Body":784}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":786,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":787,"Flags":10,"Description":"The resource api version"},"properties":{"Type":644,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-02-01","ScopeType":8,"Body":788}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":790,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":791,"Flags":10,"Description":"The resource api version"},"properties":{"Type":649,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-02-01","ScopeType":8,"Body":792}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":794,"Flags":9,"Description":"The resource name"},"type":{"Type":795,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":796,"Flags":10,"Description":"The resource api version"},"properties":{"Type":604,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-02-01","ScopeType":8,"Body":797}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":799,"Flags":9,"Description":"The resource name"},"type":{"Type":800,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":801,"Flags":10,"Description":"The resource api version"},"properties":{"Type":660,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2021-02-01","ScopeType":8,"Body":802}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":804,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":805,"Flags":10,"Description":"The resource api version"},"properties":{"Type":665,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":807,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-02-01","ScopeType":8,"Body":806}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":809,"Flags":9,"Description":"The resource name"},"type":{"Type":810,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":811,"Flags":10,"Description":"The resource api version"},"properties":{"Type":672,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-02-01","ScopeType":8,"Body":812}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-02-01","ScopeType":8,"Body":816}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":818,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":819,"Flags":10,"Description":"The resource api version"},"properties":{"Type":685,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-02-01","ScopeType":8,"Body":820}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":822,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":823,"Flags":10,"Description":"The resource api version"},"properties":{"Type":694,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-02-01","ScopeType":8,"Body":824}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":826,"Flags":9,"Description":"The resource name"},"type":{"Type":827,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":828,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":831,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":832,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":833,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-02-01","ScopeType":8,"Body":829}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":835,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":836,"Flags":10,"Description":"The resource api version"},"properties":{"Type":838,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfo","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":840,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":99,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":839}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-02-01","ScopeType":8,"Body":837}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":842,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":843,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-02-01","ScopeType":8,"Body":844}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":846,"Flags":9,"Description":"The resource name"},"type":{"Type":847,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":848,"Flags":10,"Description":"The resource api version"},"properties":{"Type":830,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-02-01","ScopeType":8,"Body":849}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":851,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":852,"Flags":10,"Description":"The resource api version"},"properties":{"Type":838,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-02-01","ScopeType":8,"Body":853}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-02-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":855,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":856,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-02-01","ScopeType":8,"Body":857}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":860,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-02-01","Output":859}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":865,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":864,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":863}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-02-01","Output":862}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":868,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":867}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":873,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":872}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-02-01","Output":867}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":506,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":879,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":890,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":891,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[880,881,882,883,884,885,886,887,888,889]}},{"3":{"ItemType":511}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-02-01","Output":878,"Input":877}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-02-01","Output":867}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-02-01","Output":895}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":898,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":899,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-02-01","Output":897}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":902,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":878}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-02-01","Output":901}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-02-01","Output":895}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-02-01","Output":878,"Input":877}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-02-01","Output":867}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-02-01","Output":895}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-02-01","Output":897}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-02-01","Output":901}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-02-01","Output":895}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2021-02-01/types.md b/generated/web/microsoft.web/2021-02-01/types.md index 9bf26c991c..d9cd9aebee 100644 --- a/generated/web/microsoft.web/2021-02-01/types.md +++ b/generated/web/microsoft.web/2021-02-01/types.md @@ -988,40 +988,49 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2021-02-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties +## AllowedAudiencesValidation ### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **domainValidationMethod**: string: Method of domain validation for free cert -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## HostingEnvironmentProfile +## AllowedPrincipals ### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. +* **groups**: string[]: The list of the allowed groups. +* **identities**: string[]: The list of the allowed identities. -## ResourceTags +## ApiDefinitionInfo ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **url**: string: The URL of the API definition. + +## ApiManagementConfig +### Properties +* **id**: string: APIM-Api Identifier. + +## Apple +### Properties +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider + +## AppleRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## ApplicationLogsConfig +### Properties +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. + +## AppLogsConfiguration +### Properties +* **destination**: string +* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) + +## AppRegistration +### Properties +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. ## AppServiceEnvironment ### Properties @@ -1030,7 +1039,7 @@ This is valid for all deployment slots in an app. * **dnsSuffix**: string: DNS suffix of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool (ReadOnly): Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **maximumNumberOfMachines**: int (ReadOnly): Maximum number of VMs in the App Service Environment. * **multiRoleCount**: int (ReadOnly): Number of front-end instances. @@ -1043,134 +1052,6 @@ This is valid for all deployment slots in an app. * **virtualNetwork**: [VirtualNetworkProfile](#virtualnetworkprofile) (Required): Specification for using a Virtual Network. * **zoneRedundant**: bool: Whether or not this App Service Environment is zone-redundant. -## NameValuePair -### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. - -## VirtualNetworkProfile -### Properties -* **id**: string (Required): Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AseV3NetworkingConfigurationProperties -### Properties -* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE -* **externalInboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesExternalInboundIpAddressesItem -* **internalInboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesInternalInboundIpAddressesItem -* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem -* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem - -## WorkerPool -### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. - -## SkuDescription -### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. - -## Capability -### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. - -## SkuCapacity -### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. - -## PrivateLinkConnectionApprovalRequest -### Properties -* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ArmIdWrapper -### Properties -* **id**: string (ReadOnly) - -## PrivateLinkConnectionState -### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection - -## ExtendedLocation -### Properties -* **name**: string: Name of extended location. -* **type**: string (ReadOnly): Type of extended location. - -## KubeEnvironmentProperties -### Properties -* **aksResourceID**: string -* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) -* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) -* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster -* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation -* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet -* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. -* **staticIp**: string: Static IP of the KubeEnvironment - -## AppLogsConfiguration -### Properties -* **destination**: string -* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) - -## LogAnalyticsConfiguration -### Properties -* **customerId**: string -* **sharedKey**: string (WriteOnly) - -## ArcConfiguration -### Properties -* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' -* **artifactStorageAccessMode**: string -* **artifactStorageClassName**: string -* **artifactStorageMountPath**: string -* **artifactStorageNodeName**: string -* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) -* **kubeConfig**: string (WriteOnly) - -## FrontEndConfiguration -### Properties -* **kind**: 'LoadBalancer' | 'NodePort' - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## UserProperties -### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. - ## AppServicePlanProperties ### Properties * **elasticScaleEnabled**: bool: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku @@ -1198,286 +1079,308 @@ If false, apps assigned to this App Service plan will scale to all * **zoneRedundant**: bool: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing. -## KubeEnvironmentProfile +## ArcConfiguration ### Properties -* **id**: string: Resource ID of the Kubernetes Environment. -* **name**: string (ReadOnly): Name of the Kubernetes Environment. -* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. +* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' +* **artifactStorageAccessMode**: string +* **artifactStorageClassName**: string +* **artifactStorageMountPath**: string +* **artifactStorageNodeName**: string +* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) +* **kubeConfig**: string (WriteOnly) -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) -## VnetGatewayProperties +## ArmPlan ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **name**: string: The name. +* **product**: string: The product. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher. +* **version**: string: Version of product. -## VnetRouteProperties +## AseV3NetworkingConfigurationProperties ### Properties -* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' (WriteOnly): 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. -* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **allowNewPrivateEndpointConnections**: bool: Property to enable and disable new private endpoint connection creation on ASE +* **externalInboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesExternalInboundIpAddressesItem +* **internalInboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesInternalInboundIpAddressesItem +* **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem +* **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem -## ManagedServiceIdentity +## AuthPlatform ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **configFilePath**: string: 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. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## ManagedServiceIdentityUserAssignedIdentities +## AutoHealActions ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## UserAssignedIdentity +## AutoHealCustomAction ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## SiteProperties +## AutoHealRules ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **storageAccountRequired**: bool: Checks if Customer provided storage account is required -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. -* **virtualNetworkSubnetId**: 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} +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## CloningInfo +## AutoHealTriggers ### Properties -* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. -* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. -* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. -* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. -* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations -together to use the same snapshot. -* **hostingEnvironment**: string: App Service Environment. -* **overwrite**: bool: true to overwrite destination app; otherwise, false. -* **sourceWebAppId**: string (Required): 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. -* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe -* **trafficManagerProfileId**: 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}. -* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. -## CloningInfoAppSettingsOverrides +## AzureActiveDirectory +### Properties +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. + +## AzureActiveDirectoryLogin +### Properties +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". + +## AzureActiveDirectoryRegistration +### Properties +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 + +## AzureActiveDirectoryValidation +### Properties +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. + +## AzureBlobStorageApplicationLogsConfig +### Properties +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureBlobStorageHttpLogsConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. + +## AzureStaticWebApps +### Properties +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider + +## AzureStaticWebAppsRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. + +## AzureStorageInfoValue +### Properties +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. + +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## HostNameSslState +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## SiteConfig +## AzureTableStorageApplicationLogsConfig ### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans -* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site -This setting only applies to the Elastic Plans -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publicNetworkAccess**: string: Property to allow or block all public traffic. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **websiteTimeZone**: 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 -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## ApiDefinitionInfo +## BackupItem ### Properties -* **url**: string: The URL of the API definition. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## ApiManagementConfig +## BackupItem ### Properties -* **id**: string: APIM-Api Identifier. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## AutoHealRules +## BackupItemCollection ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealActions +## BackupItemCollection ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## AutoHealCustomAction +## BackupItemProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## AutoHealTriggers +## BackupRequest ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## RequestsBasedTrigger +## BackupRequest ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SlowRequestsBasedTrigger +## BackupRequestProperties ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. -## StatusCodesBasedTrigger +## BackupSchedule ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. -## StatusCodesRangeBasedTrigger +## BlobStorageTokenStore ### Properties -* **count**: int: Request Count. -* **path**: string -* **statusCodes**: string: HTTP status code. -* **timeInterval**: string: Time interval. +* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. -## SiteConfigAzureStorageAccounts +## Capability +### Properties +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. + +## CertificateProperties +### Properties +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **domainValidationMethod**: string: Method of domain validation for free cert +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. + +## ClientRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. + +## CloningInfo +### Properties +* **appSettingsOverrides**: [CloningInfoAppSettingsOverrides](#cloninginfoappsettingsoverrides): 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. +* **cloneCustomHostNames**: bool: true to clone custom hostnames from source app; otherwise, false. +* **cloneSourceControl**: bool: true to clone source control from source app; otherwise, false. +* **configureLoadBalancing**: bool: true to configure load balancing for source and destination app. +* **correlationId**: string: Correlation ID of cloning operation. This ID ties multiple cloning operations +together to use the same snapshot. +* **hostingEnvironment**: string: App Service Environment. +* **overwrite**: bool: true to overwrite destination app; otherwise, false. +* **sourceWebAppId**: string (Required): 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. +* **sourceWebAppLocation**: string: Location of source app ex: West US or North Europe +* **trafficManagerProfileId**: 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}. +* **trafficManagerProfileName**: string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. + +## CloningInfoAppSettingsOverrides ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## AzureStorageInfoValue +## ConnectionStringDictionaryProperties ### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) + +## ConnectionStringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) ## ConnStringInfo ### Properties @@ -1485,6 +1388,16 @@ before taking the action * **name**: string: Name of connection string. * **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +## ConnStringValueTypePair +### Properties +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. + +## CookieExpiration +### Properties +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. + ## CorsSettings ### Properties * **allowedOrigins**: string[]: Gets or sets the list of origins that should be allowed to make cross-origin @@ -1493,416 +1406,357 @@ calls (for example: http://example.com:12345). Use "*" to allow all. https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. -## Experiments +## CsmPublishingCredentialsPoliciesEntityProperties ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. -## RampUpRule +## CustomOpenIdConnectProvider ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. -## HandlerMapping +## DatabaseBackupSetting ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## IpSecurityRestriction +## DefaultAuthorizationPolicy ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. +* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. -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. +## DeploymentProperties +### Properties +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## EnabledConfig +### Properties +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. + +## ErrorEntity +### Properties +* **code**: string: Basic error code. +* **details**: [ErrorEntity](#errorentity)[]: Error Details. +* **extendedCode**: string: Type of error. +* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. +* **message**: string: Any details of the error. +* **messageTemplate**: string: Message template. +* **parameters**: string[]: Parameters for the template. +* **target**: string: The error target. -## IpSecurityRestrictionHeaders +## Experiments ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## SiteLimits +## ExtendedLocation ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **name**: string: Name of extended location. +* **type**: string (ReadOnly): Type of extended location. -## SiteMachineKey +## Facebook ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets -## PushSettings +## FileSystemApplicationLogsConfig ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -## PushSettingsProperties +## FileSystemHttpLogsConfig ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. -## VirtualApplication +## FileSystemTokenStore ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **directory**: string: The directory in which the tokens will be stored. -## VirtualDirectory +## ForwardProxy ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. +* **customHostHeaderName**: string: The name of the header containing the host of the request. +* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. -## SlotSwapStatus +## FrontEndConfiguration ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **kind**: 'LoadBalancer' | 'NodePort' -## ResourceTags +## FunctionEnvelopeProperties +### Properties +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. + +## FunctionEnvelopePropertiesFiles ### Properties ### Additional Properties * **Additional Properties Type**: string -## CsmPublishingCredentialsPoliciesEntityProperties +## FunctionSecrets ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## StringDictionaryProperties +## FunctionSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## SiteAuthSettingsProperties +## FunctionSecrets ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **configVersion**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## SiteAuthSettingsV2Properties +## FunctionSecrets ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## GlobalValidation +## GitHub ### Properties -* **excludedPaths**: string[]: The paths for which unauthenticated flow would not be redirected to the login page. -* **redirectToProvider**: 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". -* **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. +* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -## HttpSettings +## GitHubActionCodeConfiguration ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. -* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. +* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. +* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. -## ForwardProxy +## GitHubActionConfiguration ### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. -* **customHostHeaderName**: string: The name of the header containing the host of the request. -* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. +* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. +* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. +* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. +* **isLinux**: bool: This will help determine the workflow configuration to select. -## HttpSettingsRoutes +## GitHubActionContainerConfiguration ### Properties -* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. +* **imageName**: string: The image name for the build. +* **password**: string: The password used to upload the image to the container registry. +* **serverUrl**: string: The server URL for the container registry where the build will be hosted. +* **username**: string: The username used to upload the image to the container registry. -## IdentityProviders +## GlobalValidation ### Properties -* **apple**: [Apple](#apple): The configuration settings of the Apple provider. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. -* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. -* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. -* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. -* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. -* **google**: [Google](#google): The configuration settings of the Google provider. -* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. -* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. +* **excludedPaths**: string[]: The paths for which unauthenticated flow would not be redirected to the login page. +* **redirectToProvider**: 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". +* **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. -## Apple +## Google ### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. * **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## LoginScopes +## HandlerMapping ### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## AppleRegistration +## HostingEnvironmentProfile ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## AzureActiveDirectory +## HostKeys ### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureActiveDirectoryLogin +## HostKeys ### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## AzureActiveDirectoryRegistration +## HostKeysFunctionKeys ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +### Additional Properties +* **Additional Properties Type**: string -## AzureActiveDirectoryValidation +## HostKeysSystemKeys ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +### Additional Properties +* **Additional Properties Type**: string -## DefaultAuthorizationPolicy +## HostNameBindingProperties ### Properties -* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. -* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AllowedPrincipals +## HostNameSslState ### Properties -* **groups**: string[]: The list of the allowed groups. -* **identities**: string[]: The list of the allowed identities. +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## JwtClaimChecks +## HttpLogsConfig ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## AzureStaticWebApps +## HttpSettings ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. +* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## AzureStaticWebAppsRegistration +## HttpSettingsRoutes ### Properties -* **clientId**: string: The Client ID of the app used for login. +* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. -## IdentityProvidersCustomOpenIdConnectProviders +## HybridConnectionKey ### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## CustomOpenIdConnectProvider +## HybridConnectionKeyProperties ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## OpenIdConnectLogin +## HybridConnectionProperties ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## OpenIdConnectRegistration +## IdentifierProperties ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +* **id**: string: String representation of the identity. -## OpenIdConnectClientCredential +## IdentityProviders ### Properties -* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. -* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. +* **apple**: [Apple](#apple): The configuration settings of the Apple provider. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. +* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. +* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. +* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. +* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. +* **google**: [Google](#google): The configuration settings of the Google provider. +* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. +* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## OpenIdConnectConfig +## IdentityProvidersCustomOpenIdConnectProviders ### Properties -* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. -* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. -* **issuer**: string: The endpoint that issues the token. -* **tokenEndpoint**: string: The endpoint to be used to request a token. -* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## Facebook +## IpSecurityRestriction ### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## AppRegistration -### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. +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. -## GitHub +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +### Additional Properties +* **Additional Properties Type**: string[] -## ClientRegistration +## JwtClaimChecks ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## Google +## KubeEnvironmentProfile ### Properties -* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **id**: string: Resource ID of the Kubernetes Environment. +* **name**: string (ReadOnly): Name of the Kubernetes Environment. +* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. -## AllowedAudiencesValidation +## KubeEnvironmentProperties ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **aksResourceID**: string +* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) +* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) +* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster +* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation +* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet +* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. +* **staticIp**: string: Static IP of the KubeEnvironment ## LegacyMicrosoftAccount ### Properties @@ -1911,18 +1765,10 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets * **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## Twitter -### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. - -## TwitterRegistration +## LogAnalyticsConfiguration ### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **customerId**: string +* **sharedKey**: string (WriteOnly) ## Login ### Properties @@ -1932,291 +1778,440 @@ Note that URLs within the current domain are always implicitly allowed. * **cookieExpiration**: [CookieExpiration](#cookieexpiration): The configuration settings of the session cookie's expiration. * **nonce**: [Nonce](#nonce): The configuration settings of the nonce used in the login flow. * **preserveUrlFragmentsForLogins**: bool: true if the fragments from the request are preserved after the login request is made; otherwise, false. -* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. -* **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. - -## CookieExpiration -### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. - -## Nonce -### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. +* **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. +* **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. ## LoginRoutes ### Properties * **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## TokenStore +## LoginScopes ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. -* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. -* **tokenRefreshExtensionHours**: int: 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. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## BlobStorageTokenStore +## ManagedServiceIdentity ### Properties -* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## FileSystemTokenStore +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **directory**: string: The directory in which the tokens will be stored. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## AuthPlatform +## MSDeployCore ### Properties -* **configFilePath**: string: 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. -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## AzureStoragePropertyDictionaryResourceProperties +## MSDeployCoreSetParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## BackupRequestProperties +## NameValuePair ### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. +* **name**: string: Pair name. +* **value**: string: Pair value. -## BackupSchedule +## Nonce ### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. -## DatabaseBackupSetting +## OpenIdConnectClientCredential ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. +* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. -## ConnectionStringDictionaryProperties +## OpenIdConnectConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. +* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. +* **issuer**: string: The endpoint that issues the token. +* **tokenEndpoint**: string: The endpoint to be used to request a token. +* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## ConnStringValueTypePair +## OpenIdConnectLogin ### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## SiteLogsConfigProperties +## OpenIdConnectRegistration ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. -## ApplicationLogsConfig +## PremierAddOnProperties ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## AzureBlobStorageApplicationLogsConfig +## PrivateAccessProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## AzureTableStorageApplicationLogsConfig +## PrivateAccessSubnet ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## FileSystemApplicationLogsConfig +## PrivateAccessVirtualNetwork ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## EnabledConfig +## PrivateLinkConnectionApprovalRequest ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## HttpLogsConfig +## PrivateLinkConnectionState ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## AzureBlobStorageHttpLogsConfig +## PublicCertificateProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FileSystemHttpLogsConfig +## PushSettings ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## SlotConfigNames +## RampUpRule ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. -## DeploymentProperties +## RelayServiceConnectionEntityProperties ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## IdentifierProperties +## RemotePrivateEndpointConnection ### Properties -* **id**: string: String representation of the identity. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties +* **type**: string (ReadOnly): Resource type. -## MSDeployCore +## RemotePrivateEndpointConnectionProperties ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) + +## RequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. + +## ResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string -## MSDeployCoreSetParameters +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## ResourceTags ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +### Additional Properties +* **Additional Properties Type**: string -## FunctionEnvelopePropertiesFiles +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostNameBindingProperties +## ResourceTags ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type. -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: string -## RelayServiceConnectionEntityProperties +## ResourceTags ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionProperties +## ResourceTags ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +### Additional Properties +* **Additional Properties Type**: string -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string -## ResourceTags +## ResponseMessageEnvelopeRemotePrivateEndpointConnection +### Properties +* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. +* **id**: string: 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} +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. +* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. +* **name**: string: Name of resource. +* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. +* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection +* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. +* **status**: string: Azure-AsyncOperation Status info. +* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. +* **type**: string: Type of resource e.g "Microsoft.Web/sites". +* **zones**: string[]: Logical Availability Zones the service is hosted in + +## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## SiteAuthSettingsProperties ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **configVersion**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. -## PrivateAccessVirtualNetwork +## SiteAuthSettingsV2Properties ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. -## PrivateAccessSubnet +## SiteConfig ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans +* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site +This setting only applies to the Elastic Plans +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publicNetworkAccess**: string: Property to allow or block all public traffic. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **websiteTimeZone**: 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 +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id -## PublicCertificateProperties +## SiteConfigAzureStorageAccounts ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -2241,35 +2236,77 @@ normally, use the POST /listKeys API instead. * **title**: string (ReadOnly) * **version**: string (ReadOnly): Version information. -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **storageAccountRequired**: bool: Checks if Customer provided storage account is required +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **virtualNetworkSubnetId**: 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} ## SiteSourceControlProperties ### Properties @@ -2281,43 +2318,43 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## GitHubActionConfiguration +## SkuCapacity ### Properties -* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. -* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. -* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. -* **isLinux**: bool: This will help determine the workflow configuration to select. +* **default**: int: Default number of workers for this App Service plan SKU. +* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## GitHubActionCodeConfiguration +## SkuDescription ### Properties -* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. -* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. -## GitHubActionContainerConfiguration +## SlotConfigNames ### Properties -* **imageName**: string: The image name for the build. -* **password**: string: The password used to upload the image to the container registry. -* **serverUrl**: string: The server URL for the container registry where the build will be hosted. -* **username**: string: The username used to upload the image to the container registry. +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. -## VnetInfo +## SlotSwapStatus ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. -## VnetRoute +## SlowRequestsBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **path**: string: Request Path. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2354,61 +2391,14 @@ Point-To-Site VPN connection. * **outputLocation**: string: The output path of the app after building. * **skipGithubActionWorkflowGeneration**: bool: Skip Github Action workflow generation. -## ResponseMessageEnvelopeRemotePrivateEndpointConnection -### Properties -* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. -* **id**: string: 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} -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. -* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. -* **name**: string: Name of resource. -* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. -* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection -* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. -* **status**: string: Azure-AsyncOperation Status info. -* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. -* **type**: string: Type of resource e.g "Microsoft.Web/sites". -* **zones**: string[]: Logical Availability Zones the service is hosted in - -## ErrorEntity -### Properties -* **code**: string: Basic error code. -* **details**: [ErrorEntity](#errorentity)[]: Error Details. -* **extendedCode**: string: Type of error. -* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. -* **message**: string: Any details of the error. -* **messageTemplate**: string: Message template. -* **parameters**: string[]: Parameters for the template. -* **target**: string: The error target. - -## ArmPlan -### Properties -* **name**: string: The name. -* **product**: string: The product. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher. -* **version**: string: Version of product. - -## RemotePrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties -* **type**: string (ReadOnly): Resource type. - -## RemotePrivateEndpointConnectionProperties -### Properties -* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags +## StaticSiteCustomDomainRequestPropertiesARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. +* **domainName**: string (ReadOnly): The domain name for the static site custom domain. +* **errorMessage**: string (ReadOnly) +* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' | string (ReadOnly): The status of the custom domain +* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain +* **validationToken**: string (ReadOnly): The TXT record validation token ## StaticSiteTemplateOptions ### Properties @@ -2418,34 +2408,33 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **repositoryName**: string: Name of the newly generated repository. * **templateRepositoryUrl**: string: URL of the template repository. The newly generated repository will be based on this one. -## StaticSiteUserProvidedFunctionApp +## StaticSiteUserARMResource ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserProvidedFunctionAppProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. -* **functionAppRegion**: string: The region of the function app registered with the static site -* **functionAppResourceId**: string: The resource id of the function app registered with the static site - -## ResourceTags +## StaticSiteUserARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## StringDictionaryProperties +## StaticSiteUserCollection ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## StringDictionaryProperties +## StaticSiteUserProvidedFunctionApp ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **type**: string (ReadOnly): Resource type. ## StaticSiteUserProvidedFunctionAppARMResourceProperties ### Properties @@ -2453,58 +2442,36 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **functionAppRegion**: string: The region of the function app registered with the static site * **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties +## StaticSiteUserProvidedFunctionAppProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. +* **functionAppRegion**: string: The region of the function app registered with the static site +* **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StaticSiteCustomDomainRequestPropertiesARMResourceProperties +## StatusCodesBasedTrigger ### Properties -* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. -* **domainName**: string (ReadOnly): The domain name for the static site custom domain. -* **errorMessage**: string (ReadOnly) -* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' (ReadOnly): The status of the custom domain -* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain -* **validationToken**: string (ReadOnly): The TXT record validation token +* **count**: int: Request Count. +* **path**: string: Request Path +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupRequest +## StatusCodesRangeBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **path**: string +* **statusCodes**: string: HTTP status code. +* **timeInterval**: string: Time interval. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemProperties -### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2513,25 +2480,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## BackupRequest -### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. - -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2558,22 +2512,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## StringList +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: string[] (ReadOnly): List of string resources. +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2592,102 +2536,158 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKey +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionKeyProperties +## StringDictionaryProperties ### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringList ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: string[] (ReadOnly): List of string resources. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## SwiftVirtualNetworkProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## FunctionSecrets +## TokenStore ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. +* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. +* **tokenRefreshExtensionHours**: int: 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. -## FunctionSecrets +## Twitter ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## FunctionSecrets +## TwitterRegistration ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. -## StaticSiteUserCollection +## UserAssignedIdentity ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity -## StaticSiteUserARMResource +## UserProperties +### Properties +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. + +## VirtualApplication +### Properties +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. + +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualNetworkProfile +### Properties +* **id**: string (Required): Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfo +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | string (WriteOnly): 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. +* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/web/microsoft.web/2021-03-01/types.json b/generated/web/microsoft.web/2021-03-01/types.json index f78b805f41..cba5527bc5 100644 --- a/generated/web/microsoft.web/2021-03-01/types.json +++ b/generated/web/microsoft.web/2021-03-01/types.json @@ -1 +1 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":0,"Description":"Dedicated Host Count"},"zoneRedundant":{"Type":2,"Flags":0,"Description":"Whether or not this App Service Environment is zone-redundant."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-03-01","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"externalInboundIpAddresses":{"Type":41,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesExternalInboundIpAddressesItem"},"internalInboundIpAddresses":{"Type":42,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesInternalInboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-03-01","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":44,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":52,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":53,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[49,50,51]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":55,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":56,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":58,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":57}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-03-01","ScopeType":8,"Body":47}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":60,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":61,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":66,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":62}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":68,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":69,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-03-01","ScopeType":8,"Body":70}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":89,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":79,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"elasticScaleEnabled":{"Type":2,"Flags":0,"Description":"ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":86,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":87,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."},"zoneRedundant":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[76,77,78]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[81,82,83,84,85]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-03-01","ScopeType":8,"Body":74}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":91,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":92,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-03-01","ScopeType":8,"Body":93}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":96,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":97,"Flags":10,"Description":"The resource api version"},"properties":{"Type":99,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":103,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[100,101,102]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01","ScopeType":8,"Body":98}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":105,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":106,"Flags":10,"Description":"The resource api version"},"properties":{"Type":108,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":122,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":109,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":80,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":121,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[110,111,112,113,114,115,116,117,118,119,120]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-03-01","ScopeType":8,"Body":107}},{"6":{"Value":"Microsoft.Web/containerApps"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/containerApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":124,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":125,"Flags":10,"Description":"The resource api version"},"properties":{"Type":127,"Flags":0,"Description":"ContainerApp resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":173,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ContainerAppProperties","Properties":{"provisioningState":{"Type":132,"Flags":2,"Description":"Provisioning state of the Container App."},"kubeEnvironmentId":{"Type":4,"Flags":0,"Description":"Resource ID of the Container App's KubeEnvironment."},"latestRevisionName":{"Type":4,"Flags":2,"Description":"Name of the latest revision of the Container App."},"latestRevisionFqdn":{"Type":4,"Flags":2,"Description":"Fully Qualified Domain Name of the latest revision of the Container App."},"configuration":{"Type":133,"Flags":0,"Description":"Non versioned Container App configuration properties that define the mutable settings of a Container app"},"template":{"Type":148,"Flags":0,"Description":"Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created"}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"5":{"Elements":[128,129,130,131]}},{"2":{"Name":"Configuration","Properties":{"secrets":{"Type":135,"Flags":0,"Description":"Collection of secrets used by a Container app"},"activeRevisionsMode":{"Type":138,"Flags":0,"Description":"ActiveRevisionsMode controls how active revisions are handled for the Container app:\nMultiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode"},"ingress":{"Type":139,"Flags":0,"Description":"Container App Ingress configuration."},"registries":{"Type":147,"Flags":0,"Description":"Collection of private container registry credentials for containers used by the Container app"}}}},{"2":{"Name":"Secret","Properties":{"name":{"Type":4,"Flags":0,"Description":"Secret Name."},"value":{"Type":4,"Flags":4,"Description":"Secret Value."}}}},{"3":{"ItemType":134}},{"6":{"Value":"multiple"}},{"6":{"Value":"single"}},{"5":{"Elements":[136,137]}},{"2":{"Name":"Ingress","Properties":{"fqdn":{"Type":4,"Flags":2,"Description":"Hostname."},"external":{"Type":2,"Flags":0,"Description":"Bool indicating if app exposes an external http endpoint"},"targetPort":{"Type":3,"Flags":0,"Description":"Target Port in containers for traffic from ingress"},"transport":{"Type":143,"Flags":0,"Description":"Ingress transport protocol"},"traffic":{"Type":145,"Flags":0,"Description":"Array of TrafficWeight"},"allowInsecure":{"Type":2,"Flags":0,"Description":"Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections"}}}},{"6":{"Value":"auto"}},{"6":{"Value":"http"}},{"6":{"Value":"http2"}},{"5":{"Elements":[140,141,142]}},{"2":{"Name":"TrafficWeight","Properties":{"revisionName":{"Type":4,"Flags":0,"Description":"Name of a revision"},"weight":{"Type":3,"Flags":0,"Description":"Traffic weight assigned to a revision"},"latestRevision":{"Type":2,"Flags":0,"Description":"Indicates that the traffic weight belongs to a latest stable revision"}}}},{"3":{"ItemType":144}},{"2":{"Name":"RegistryCredentials","Properties":{"server":{"Type":4,"Flags":0,"Description":"Container Registry Server"},"username":{"Type":4,"Flags":0,"Description":"Container Registry Username"},"passwordSecretRef":{"Type":4,"Flags":0,"Description":"The name of the Secret that contains the registry login password"}}}},{"3":{"ItemType":146}},{"2":{"Name":"Template","Properties":{"revisionSuffix":{"Type":4,"Flags":0,"Description":"User friendly suffix that is appended to the revision name"},"containers":{"Type":155,"Flags":0,"Description":"List of container definitions for the Container App."},"scale":{"Type":156,"Flags":0,"Description":"Container App scaling configurations."},"dapr":{"Type":168,"Flags":0,"Description":"Container App Dapr configuration."}}}},{"2":{"Name":"Container","Properties":{"image":{"Type":4,"Flags":0,"Description":"Container image tag."},"name":{"Type":4,"Flags":0,"Description":"Custom container name."},"command":{"Type":150,"Flags":0,"Description":"Container start command."},"args":{"Type":151,"Flags":0,"Description":"Container start command arguments."},"env":{"Type":153,"Flags":0,"Description":"Container environment variables."},"resources":{"Type":154,"Flags":0,"Description":"Container App container resource requirements."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"EnvironmentVar","Properties":{"name":{"Type":4,"Flags":0,"Description":"Environment variable name."},"value":{"Type":4,"Flags":0,"Description":"Non-secret environment variable value."},"secretRef":{"Type":4,"Flags":0,"Description":"Name of the Container App secret from which to pull the environment variable value."}}}},{"3":{"ItemType":152}},{"2":{"Name":"ContainerResources","Properties":{"cpu":{"Type":3,"Flags":0,"Description":"Required CPU in cores, e.g. 0.5"},"memory":{"Type":4,"Flags":0,"Description":"Required memory, e.g. \"250Mb\""}}}},{"3":{"ItemType":149}},{"2":{"Name":"Scale","Properties":{"minReplicas":{"Type":3,"Flags":0,"Description":"Optional. Minimum number of container replicas."},"maxReplicas":{"Type":3,"Flags":0,"Description":"Optional. Maximum number of container replicas. Defaults to 10 if not set."},"rules":{"Type":167,"Flags":0,"Description":"Scaling rules."}}}},{"2":{"Name":"ScaleRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"Scale Rule Name"},"azureQueue":{"Type":158,"Flags":0,"Description":"Container App container Azure Queue based scaling rule."},"custom":{"Type":161,"Flags":0,"Description":"Container App container Custom scaling rule."},"http":{"Type":164,"Flags":0,"Description":"Container App container Custom scaling rule."}}}},{"2":{"Name":"QueueScaleRule","Properties":{"queueName":{"Type":4,"Flags":0,"Description":"Queue name."},"queueLength":{"Type":3,"Flags":0,"Description":"Queue length."},"auth":{"Type":160,"Flags":0,"Description":"Authentication secrets for the queue scale rule."}}}},{"2":{"Name":"ScaleRuleAuth","Properties":{"secretRef":{"Type":4,"Flags":0,"Description":"Name of the Container App secret from which to pull the auth params."},"triggerParameter":{"Type":4,"Flags":0,"Description":"Trigger Parameter that uses the secret"}}}},{"3":{"ItemType":159}},{"2":{"Name":"CustomScaleRule","Properties":{"type":{"Type":4,"Flags":0,"Description":"Type of the custom scale rule\neg: azure-servicebus, redis etc."},"metadata":{"Type":162,"Flags":0,"Description":"Metadata properties to describe custom scale rule."},"auth":{"Type":163,"Flags":0,"Description":"Authentication secrets for the custom scale rule."}}}},{"2":{"Name":"CustomScaleRuleMetadata","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":159}},{"2":{"Name":"HttpScaleRule","Properties":{"metadata":{"Type":165,"Flags":0,"Description":"Metadata properties to describe http scale rule."},"auth":{"Type":166,"Flags":0,"Description":"Authentication secrets for the custom scale rule."}}}},{"2":{"Name":"HttpScaleRuleMetadata","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":159}},{"3":{"ItemType":157}},{"2":{"Name":"Dapr","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Boolean indicating if the Dapr side car is enabled"},"appId":{"Type":4,"Flags":0,"Description":"Dapr application identifier"},"appPort":{"Type":3,"Flags":0,"Description":"Port on which the Dapr side car"},"components":{"Type":172,"Flags":0,"Description":"Collection of Dapr components"}}}},{"2":{"Name":"DaprComponent","Properties":{"name":{"Type":4,"Flags":0,"Description":"Component name"},"type":{"Type":4,"Flags":0,"Description":"Component type"},"version":{"Type":4,"Flags":0,"Description":"Component version"},"metadata":{"Type":171,"Flags":0,"Description":"Component metadata"}}}},{"2":{"Name":"DaprMetadata","Properties":{"name":{"Type":4,"Flags":0,"Description":"Metadata property name."},"value":{"Type":4,"Flags":0,"Description":"Metadata property value."},"secretRef":{"Type":4,"Flags":0,"Description":"Name of the Container App secret from which to pull the metadata property value."}}}},{"3":{"ItemType":170}},{"3":{"ItemType":169}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/containerApps@2021-03-01","ScopeType":8,"Body":126}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":175,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":176,"Flags":10,"Description":"The resource api version"},"properties":{"Type":178,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":201,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":189,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"environmentType":{"Type":4,"Flags":0,"Description":"Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed"},"arcConfiguration":{"Type":190,"Flags":0},"appLogsConfiguration":{"Type":198,"Flags":0},"containerAppsConfiguration":{"Type":200,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[179,180,181,182,183,184,185,186,187,188]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":193,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":194,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[191,192]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":197,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[195,196]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":199,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ContainerAppsConfiguration","Properties":{"daprAIInstrumentationKey":{"Type":4,"Flags":0,"Description":"Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry"},"platformReservedCidr":{"Type":4,"Flags":0,"Description":"IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges."},"platformReservedDnsIP":{"Type":4,"Flags":0,"Description":"An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server"},"controlPlaneSubnetResourceId":{"Type":4,"Flags":0,"Description":"Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined."},"appSubnetResourceId":{"Type":4,"Flags":0,"Description":"Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined."},"dockerBridgeCidr":{"Type":4,"Flags":0,"Description":"CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-03-01","ScopeType":8,"Body":177}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":203,"Flags":9,"Description":"The resource name"},"type":{"Type":204,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":205,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-03-01","ScopeType":1,"Body":206}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":209,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":210,"Flags":10,"Description":"The resource api version"},"properties":{"Type":212,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-03-01","ScopeType":1,"Body":211}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":214,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":215,"Flags":10,"Description":"The resource api version"},"properties":{"Type":217,"Flags":0,"Description":"A static site."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":252,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":218,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":219,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":239,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":242,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":243,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":246,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":0,"Description":"The provider that submitted the last deployment to the primary environment of the static site."},"enterpriseGradeCdnStatus":{"Type":251,"Flags":0,"Description":"State indicating the status of the enterprise grade CDN serving traffic to the static web app."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":221,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":222,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":223,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":226,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":238,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":224,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":225,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":227,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":228,"Flags":0,"Description":"Inner errors."},"details":{"Type":229,"Flags":0,"Description":"Error Details."},"target":{"Type":4,"Flags":0,"Description":"The error target."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":226}},{"3":{"ItemType":226}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":235,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":237,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[231,232,233,234]}},{"2":{"Name":"UserAssignedIdentity","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":236}},{"3":{"ItemType":4}},{"3":{"ItemType":220}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[240,241]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":245,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":244}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Enabling"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Disabling"}},{"5":{"Elements":[247,248,249,250]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-03-01","ScopeType":8,"Body":216}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":254,"Flags":9,"Description":"The resource name"},"type":{"Type":255,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":256,"Flags":10,"Description":"The resource api version"},"properties":{"Type":258,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":259,"Flags":9,"Description":"The resource name"},"type":{"Type":260,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":261,"Flags":10,"Description":"The resource api version"},"properties":{"Type":263,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":257,"functionappsettings":262}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-03-01","ScopeType":8,"Body":264}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":266,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":267,"Flags":10,"Description":"The resource api version"},"properties":{"Type":269,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-03-01","ScopeType":8,"Body":268}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":271,"Flags":9,"Description":"The resource name"},"type":{"Type":272,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":273,"Flags":10,"Description":"The resource api version"},"properties":{"Type":275,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":276,"Flags":9,"Description":"The resource name"},"type":{"Type":277,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":278,"Flags":10,"Description":"The resource api version"},"properties":{"Type":280,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":274,"functionappsettings":279}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-03-01","ScopeType":8,"Body":281}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":283,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":284,"Flags":10,"Description":"The resource api version"},"properties":{"Type":286,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":293,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[287,288,289,290,291,292]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-03-01","ScopeType":8,"Body":285}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":295,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":296,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":297}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":299,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":300,"Flags":10,"Description":"The resource api version"},"properties":{"Type":269,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-03-01","ScopeType":8,"Body":301}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":303,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":304,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":444,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":307,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":310,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":311,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":315,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":324,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":325,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":430,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":434,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":435,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":437,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":443,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[308,309]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[312,313,314]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":320,"Flags":0,"Description":"SSL type"},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":323,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[317,318,319]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[321,322]}},{"3":{"ItemType":316}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":326,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":327,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":341,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":342,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":344,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":359,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":362,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":366,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":373,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":374,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":377,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":378,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":393,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":395,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":397,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":398,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":406,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":407,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":411,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":415,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":419,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":429,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":340,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[329,330,331,332,333,334,335,336,337,338,339]}},{"3":{"ItemType":328}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":343}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[345,346,347,348,349,350,351,352,353,354,355,356,357,358]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[360,361]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":365,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":364}},{"3":{"ItemType":363}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[367,368,369,370,371,372]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":376,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":375}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":379,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":387,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":380,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":382,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":383,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":384,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":386,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":381}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":383}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":385}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":391,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":392,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[388,389,390]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":394,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":396,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":403,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":405,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[400,401,402]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":404}},{"3":{"ItemType":399}},{"3":{"ItemType":399}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[408,409,410]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[412,413,414]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[416,417,418]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":423,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":428,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[421,422]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[424,425,426,427]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":420}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[431,432,433]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":436,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[438,439,440,441,442]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-03-01","ScopeType":8,"Body":305}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":446,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":451,"Flags":9,"Description":"The resource name"},"type":{"Type":452,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":453,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":449,"scm":454}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-03-01","ScopeType":8,"Body":455}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":457,"Flags":9,"Description":"The resource name"},"type":{"Type":458,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":459,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":462,"Flags":9,"Description":"The resource name"},"type":{"Type":463,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":464,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":469,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":470,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":477,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":478,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":479,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":480,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":481,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":482,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":483,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[467,468]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[471,472,473,474,475,476]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":484,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":489,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":490,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":497,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":536,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":547,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":495,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":496,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[491,492,493,494]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":498,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":512,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":516,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":518,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":521,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":522,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":524,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":526,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":535,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":499,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":500,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":502,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":501,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":503,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":506,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."},"defaultAuthorizationPolicy":{"Type":507,"Flags":0,"Description":"The configuration settings of the Azure Active Directory default authorization policy."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":504,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":505,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"DefaultAuthorizationPolicy","Properties":{"allowedPrincipals":{"Type":508,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed principals."},"allowedApplications":{"Type":511,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed applications."}}}},{"2":{"Name":"AllowedPrincipals","Properties":{"groups":{"Type":509,"Flags":0,"Description":"The list of the allowed groups."},"identities":{"Type":510,"Flags":0,"Description":"The list of the allowed identities."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":513,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":515,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":517,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":517,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":519,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":520,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":517,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":519,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":523,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":525,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":527,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":529,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":533,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":530,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":532,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":531,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":534,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":528}},{"2":{"Name":"Login","Properties":{"routes":{"Type":537,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":538,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":541,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":542,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":546,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":539,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":540,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":545,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[543,544]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":548,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":549,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":553,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[550,551,552]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":554,"Flags":9,"Description":"The resource name"},"type":{"Type":555,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":556,"Flags":10,"Description":"The resource api version"},"properties":{"Type":558,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":420}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":559,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":564,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":574,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":567,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[565,566]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":573,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[569,570,571,572]}},{"3":{"ItemType":568}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":575,"Flags":9,"Description":"The resource name"},"type":{"Type":576,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":577,"Flags":10,"Description":"The resource api version"},"properties":{"Type":592,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":591,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[580,581,582,583,584,585,586,587,588,589,590]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":579}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":593,"Flags":9,"Description":"The resource name"},"type":{"Type":594,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":595,"Flags":10,"Description":"The resource api version"},"properties":{"Type":597,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":598,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":620,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":623,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":623,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":599,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":606,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":613,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":605,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[600,601,602,603,604]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":612,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[607,608,609,610,611]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":619,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[614,615,616,617,618]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":621,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":622,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":624,"Flags":9,"Description":"The resource name"},"type":{"Type":625,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":626,"Flags":10,"Description":"The resource api version"},"properties":{"Type":628,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":629,"Flags":9,"Description":"The resource name"},"type":{"Type":630,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":631,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":633,"Flags":9,"Description":"The resource name"},"type":{"Type":634,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":635,"Flags":10,"Description":"The resource api version"},"properties":{"Type":637,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":638,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":639,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":640,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":641,"Flags":9,"Description":"The resource name"},"type":{"Type":642,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":643,"Flags":10,"Description":"The resource api version"},"properties":{"Type":325,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":460,"authsettings":465,"authsettingsV2":487,"azurestorageaccounts":557,"backup":562,"connectionstrings":578,"logs":596,"metadata":627,"pushsettings":632,"slotConfigNames":636,"web":644}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-03-01","ScopeType":8,"Body":645}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":647,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":648,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-03-01","ScopeType":8,"Body":649}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":652,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":653,"Flags":10,"Description":"The resource api version"},"properties":{"Type":655,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-03-01","ScopeType":8,"Body":654}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":657,"Flags":9,"Description":"The resource name"},"type":{"Type":658,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":659,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":662,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":668,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[663,664,665,666,667]}},{"6":{"Value":"onedeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":669,"Flags":9,"Description":"The resource name"},"type":{"Type":670,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":671,"Flags":10,"Description":"The resource api version"}}}},{"7":{"Name":"microsoft.web/sites/extensions","Discriminator":"name","BaseProperties":{},"Elements":{"MSDeploy":660,"onedeploy":672}}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-03-01","ScopeType":8,"Body":673}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":678,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":679,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-03-01","ScopeType":8,"Body":677}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":681,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":682,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-03-01","ScopeType":8,"Body":683}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":685,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":686,"Flags":10,"Description":"The resource api version"},"properties":{"Type":688,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":691,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":694,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":697,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":701,"Flags":0,"Description":"SSL type"},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[689,690]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[692,693]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[695,696]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[698,699,700]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-03-01","ScopeType":8,"Body":687}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":703,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":704,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-03-01","ScopeType":8,"Body":705}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-03-01","ScopeType":8,"Body":710}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":713,"Flags":9,"Description":"The resource name"},"type":{"Type":714,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":715,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-03-01","ScopeType":8,"Body":716}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":718,"Flags":9,"Description":"The resource name"},"type":{"Type":719,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":720,"Flags":10,"Description":"The resource api version"},"properties":{"Type":722,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-03-01","ScopeType":8,"Body":721}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":724,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":725,"Flags":10,"Description":"The resource api version"},"properties":{"Type":727,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":728,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-03-01","ScopeType":8,"Body":726}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":730,"Flags":9,"Description":"The resource name"},"type":{"Type":731,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":732,"Flags":10,"Description":"The resource api version"},"properties":{"Type":734,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":738,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":737,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":736}},{"3":{"ItemType":735}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-03-01","ScopeType":8,"Body":733}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":740,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":741,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":742}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":744,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":745,"Flags":10,"Description":"The resource api version"},"properties":{"Type":747,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":751,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[748,749,750]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-03-01","ScopeType":8,"Body":746}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":753,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":754,"Flags":10,"Description":"The resource api version"},"properties":{"Type":756,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":759,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":760,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[757,758]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-03-01","ScopeType":8,"Body":755}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":762,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":763,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":765,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-03-01","ScopeType":8,"Body":764}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":767,"Flags":9,"Description":"The resource name"},"type":{"Type":768,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":769,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":771,"Flags":9,"Description":"The resource name"},"type":{"Type":772,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":773,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":770,"scm":774}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-03-01","ScopeType":8,"Body":775}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":777,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"properties":{"Type":781,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":782,"Flags":9,"Description":"The resource name"},"type":{"Type":783,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":784,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":786,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":790,"Flags":9,"Description":"The resource name"},"type":{"Type":791,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":792,"Flags":10,"Description":"The resource api version"},"properties":{"Type":794,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":420}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":795,"Flags":9,"Description":"The resource name"},"type":{"Type":796,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":797,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":799,"Flags":9,"Description":"The resource name"},"type":{"Type":800,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":801,"Flags":10,"Description":"The resource api version"},"properties":{"Type":803,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":579}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":804,"Flags":9,"Description":"The resource name"},"type":{"Type":805,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":806,"Flags":10,"Description":"The resource api version"},"properties":{"Type":597,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":808,"Flags":9,"Description":"The resource name"},"type":{"Type":809,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":810,"Flags":10,"Description":"The resource api version"},"properties":{"Type":812,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":813,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":817,"Flags":9,"Description":"The resource name"},"type":{"Type":818,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":819,"Flags":10,"Description":"The resource api version"},"properties":{"Type":325,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":780,"authsettings":785,"authsettingsV2":789,"azurestorageaccounts":793,"backup":798,"connectionstrings":802,"logs":807,"metadata":811,"pushsettings":816,"web":820}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-03-01","ScopeType":8,"Body":821}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":823,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":824,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-03-01","ScopeType":8,"Body":825}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":827,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":828,"Flags":10,"Description":"The resource api version"},"properties":{"Type":655,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-03-01","ScopeType":8,"Body":829}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":831,"Flags":9,"Description":"The resource name"},"type":{"Type":832,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":833,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-03-01","ScopeType":8,"Body":834}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":836,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":837,"Flags":10,"Description":"The resource api version"},"properties":{"Type":678,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-03-01","ScopeType":8,"Body":838}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":840,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":841,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-03-01","ScopeType":8,"Body":842}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":844,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":845,"Flags":10,"Description":"The resource api version"},"properties":{"Type":688,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-03-01","ScopeType":8,"Body":846}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":848,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":849,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-03-01","ScopeType":8,"Body":850}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":852,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":853,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-03-01","ScopeType":8,"Body":854}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":856,"Flags":9,"Description":"The resource name"},"type":{"Type":857,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":858,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-03-01","ScopeType":8,"Body":859}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":861,"Flags":9,"Description":"The resource name"},"type":{"Type":862,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":863,"Flags":10,"Description":"The resource api version"},"properties":{"Type":722,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2021-03-01","ScopeType":8,"Body":864}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":866,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":867,"Flags":10,"Description":"The resource api version"},"properties":{"Type":727,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":869,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-03-01","ScopeType":8,"Body":868}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":871,"Flags":9,"Description":"The resource name"},"type":{"Type":872,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":873,"Flags":10,"Description":"The resource api version"},"properties":{"Type":734,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-03-01","ScopeType":8,"Body":874}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":876,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":877,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":878}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":880,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":881,"Flags":10,"Description":"The resource api version"},"properties":{"Type":747,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-03-01","ScopeType":8,"Body":882}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":884,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":885,"Flags":10,"Description":"The resource api version"},"properties":{"Type":756,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-03-01","ScopeType":8,"Body":886}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":888,"Flags":9,"Description":"The resource name"},"type":{"Type":889,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":890,"Flags":10,"Description":"The resource api version"},"properties":{"Type":892,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":893,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":894,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":895,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-03-01","ScopeType":8,"Body":891}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":897,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":898,"Flags":10,"Description":"The resource api version"},"properties":{"Type":900,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfo","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":902,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":99,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":901}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-03-01","ScopeType":8,"Body":899}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":904,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":905,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-03-01","ScopeType":8,"Body":906}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":908,"Flags":9,"Description":"The resource name"},"type":{"Type":909,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":910,"Flags":10,"Description":"The resource api version"},"properties":{"Type":892,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-03-01","ScopeType":8,"Body":911}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":913,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":914,"Flags":10,"Description":"The resource api version"},"properties":{"Type":900,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-03-01","ScopeType":8,"Body":915}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":917,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":918,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-03-01","ScopeType":8,"Body":919}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":922,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-03-01","Output":921}},{"2":{"Name":"SecretsCollection","Properties":{"value":{"Type":926,"Flags":2,"Description":"Collection of resources."}}}},{"2":{"Name":"ContainerAppSecret","Properties":{"name":{"Type":4,"Flags":2,"Description":"Secret Name."},"value":{"Type":4,"Flags":2,"Description":"Secret Value."}}}},{"3":{"ItemType":925}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/containerApps","ApiVersion":"2021-03-01","Output":924}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":931,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":930,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":929}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-03-01","Output":928}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":934,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":933}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":939,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":938}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":933}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":563,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":945,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":956,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":957,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[946,947,948,949,950,951,952,953,954,955]}},{"3":{"ItemType":568}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-03-01","Output":944,"Input":943}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-03-01","Output":933}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-03-01","Output":961}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":964,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":965,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-03-01","Output":963}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":968,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":944}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-03-01","Output":967}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-03-01","Output":961}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-03-01","Output":944,"Input":943}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-03-01","Output":961}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-03-01","Output":963}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-03-01","Output":967}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-03-01","Output":961}}] \ No newline at end of file +[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"6":{"Value":"Microsoft.Web/hostingEnvironments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":8,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":9,"Flags":10,"Description":"The resource api version"},"properties":{"Type":11,"Flags":0,"Description":"Description of an App Service Environment."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":32,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServiceEnvironment","Properties":{"provisioningState":{"Type":17,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"status":{"Type":22,"Flags":2,"Description":"Current status of the App Service Environment."},"virtualNetwork":{"Type":23,"Flags":1,"Description":"Specification for using a Virtual Network."},"internalLoadBalancingMode":{"Type":28,"Flags":0,"Description":"Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."},"multiSize":{"Type":4,"Flags":0,"Description":"Front-end VM size, e.g. \"Medium\", \"Large\"."},"multiRoleCount":{"Type":3,"Flags":2,"Description":"Number of front-end instances."},"ipsslAddressCount":{"Type":3,"Flags":0,"Description":"Number of IP SSL addresses reserved for the App Service Environment."},"dnsSuffix":{"Type":4,"Flags":0,"Description":"DNS suffix of the App Service Environment."},"maximumNumberOfMachines":{"Type":3,"Flags":2,"Description":"Maximum number of VMs in the App Service Environment."},"frontEndScaleFactor":{"Type":3,"Flags":0,"Description":"Scale factor for front-ends."},"suspended":{"Type":2,"Flags":2,"Description":"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\n (most likely because NSG blocked the incoming traffic)."},"clusterSettings":{"Type":30,"Flags":0,"Description":"Custom settings for changing the behavior of the App Service Environment."},"userWhitelistedIpRanges":{"Type":31,"Flags":0,"Description":"User added ip ranges to whitelist on ASE db"},"hasLinuxWorkers":{"Type":2,"Flags":2,"Description":"Flag that displays whether an ASE has linux workers or not"},"dedicatedHostCount":{"Type":3,"Flags":0,"Description":"Dedicated Host Count"},"zoneRedundant":{"Type":2,"Flags":0,"Description":"Whether or not this App Service Environment is zone-redundant."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[12,13,14,15,16]}},{"6":{"Value":"Preparing"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Scaling"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[18,19,20,21]}},{"2":{"Name":"VirtualNetworkProfile","Properties":{"id":{"Type":4,"Flags":1,"Description":"Resource id of the Virtual Network."},"name":{"Type":4,"Flags":2,"Description":"Name of the Virtual Network (read-only)."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Virtual Network (read-only)."},"subnet":{"Type":4,"Flags":0,"Description":"Subnet within the Virtual Network."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Web"}},{"6":{"Value":"Publishing"}},{"6":{"Value":"Web, Publishing"}},{"5":{"Elements":[24,25,26,27,4]}},{"2":{"Name":"NameValuePair","Properties":{"name":{"Type":4,"Flags":0,"Description":"Pair name."},"value":{"Type":4,"Flags":0,"Description":"Pair value."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments@2021-03-01","ScopeType":8,"Body":10}},{"6":{"Value":"networking"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/configurations"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/configurations","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":34,"Flags":9,"Description":"The resource name"},"type":{"Type":35,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":36,"Flags":10,"Description":"The resource api version"},"properties":{"Type":38,"Flags":0,"Description":"AseV3NetworkingConfiguration resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AseV3NetworkingConfigurationProperties","Properties":{"windowsOutboundIpAddresses":{"Type":39,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem"},"linuxOutboundIpAddresses":{"Type":40,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem"},"externalInboundIpAddresses":{"Type":41,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesExternalInboundIpAddressesItem"},"internalInboundIpAddresses":{"Type":42,"Flags":2,"Description":"Array of AseV3NetworkingConfigurationPropertiesInternalInboundIpAddressesItem"},"allowNewPrivateEndpointConnections":{"Type":2,"Flags":0,"Description":"Property to enable and disable new private endpoint connection creation on ASE"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/configurations@2021-03-01","ScopeType":8,"Body":37}},{"6":{"Value":"default"}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/multiRolePools"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":44,"Flags":9,"Description":"The resource name"},"type":{"Type":45,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":46,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"WorkerPool","Properties":{"workerSizeId":{"Type":3,"Flags":0,"Description":"Worker size ID for referencing this worker pool."},"computeMode":{"Type":52,"Flags":0,"Description":"Shared/dedicated workers."},"workerSize":{"Type":4,"Flags":0,"Description":"VM size of the worker pool instances."},"workerCount":{"Type":3,"Flags":0,"Description":"Number of instances in the worker pool."},"instanceNames":{"Type":53,"Flags":2,"Description":"Names of all instances in the worker pool (read only)."}}}},{"6":{"Value":"Shared"}},{"6":{"Value":"Dedicated"}},{"6":{"Value":"Dynamic"}},{"5":{"Elements":[49,50,51]}},{"3":{"ItemType":4}},{"2":{"Name":"SkuDescription","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the resource SKU."},"tier":{"Type":4,"Flags":0,"Description":"Service tier of the resource SKU."},"size":{"Type":4,"Flags":0,"Description":"Size specifier of the resource SKU."},"family":{"Type":4,"Flags":0,"Description":"Family code of the resource SKU."},"capacity":{"Type":3,"Flags":0,"Description":"Current number of instances assigned to the resource."},"skuCapacity":{"Type":55,"Flags":0,"Description":"Description of the App Service plan scale options."},"locations":{"Type":56,"Flags":0,"Description":"Locations of the SKU."},"capabilities":{"Type":58,"Flags":0,"Description":"Capabilities of the SKU, e.g., is traffic manager enabled?"}}}},{"2":{"Name":"SkuCapacity","Properties":{"minimum":{"Type":3,"Flags":0,"Description":"Minimum number of workers for this App Service plan SKU."},"maximum":{"Type":3,"Flags":0,"Description":"Maximum number of workers for this App Service plan SKU."},"elasticMaximum":{"Type":3,"Flags":0,"Description":"Maximum number of Elastic workers for this App Service plan SKU."},"default":{"Type":3,"Flags":0,"Description":"Default number of workers for this App Service plan SKU."},"scaleType":{"Type":4,"Flags":0,"Description":"Available scale configurations for an App Service plan."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of the SKU capability."},"value":{"Type":4,"Flags":0,"Description":"Value of the SKU capability."},"reason":{"Type":4,"Flags":0,"Description":"Reason of the SKU capability."}}}},{"3":{"ItemType":57}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/multiRolePools@2021-03-01","ScopeType":8,"Body":47}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":60,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":61,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateLinkConnectionApprovalRequest","Properties":{"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":2,"Description":"A wrapper for an ARM resource id"},"ipAddresses":{"Type":66,"Flags":2,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"2":{"Name":"PrivateLinkConnectionState","Properties":{"status":{"Type":4,"Flags":0,"Description":"Status of a private link connection"},"description":{"Type":4,"Flags":0,"Description":"Description of a private link connection"},"actionsRequired":{"Type":4,"Flags":0,"Description":"ActionsRequired for a private link connection"}}}},{"2":{"Name":"ArmIdWrapper","Properties":{"id":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":62}},{"6":{"Value":"Microsoft.Web/hostingEnvironments/workerPools"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/hostingEnvironments/workerPools","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":68,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":69,"Flags":10,"Description":"The resource api version"},"properties":{"Type":48,"Flags":0,"Description":"Worker pool of an App Service Environment."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/hostingEnvironments/workerPools@2021-03-01","ScopeType":8,"Body":70}},{"6":{"Value":"Microsoft.Web/serverfarms"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/serverfarms","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":72,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":73,"Flags":10,"Description":"The resource api version"},"properties":{"Type":75,"Flags":0,"Description":"AppServicePlan resource specific properties"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":89,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"AppServicePlanProperties","Properties":{"workerTierName":{"Type":4,"Flags":0,"Description":"Target worker tier assigned to the App Service plan."},"status":{"Type":79,"Flags":2,"Description":"App Service plan status."},"subscription":{"Type":4,"Flags":2,"Description":"App Service plan subscription."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"maximumNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of instances that can be assigned to this App Service plan."},"geoRegion":{"Type":4,"Flags":2,"Description":"Geographical location for the App Service plan."},"perSiteScaling":{"Type":2,"Flags":0,"Description":"If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."},"elasticScaleEnabled":{"Type":2,"Flags":0,"Description":"ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"},"maximumElasticWorkerCount":{"Type":3,"Flags":0,"Description":"Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"},"numberOfSites":{"Type":3,"Flags":2,"Description":"Number of apps assigned to this App Service plan."},"isSpot":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan owns spot instances."},"spotExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm expires. Valid only if it is a spot server farm."},"freeOfferExpirationTime":{"Type":4,"Flags":0,"Description":"The time when the server farm free offer expires."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Resource group of the App Service plan."},"reserved":{"Type":2,"Flags":0,"Description":"If Linux app service plan true, false otherwise."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: If Hyper-V container app service plan true, false otherwise."},"hyperV":{"Type":2,"Flags":0,"Description":"If Hyper-V container app service plan true, false otherwise."},"targetWorkerCount":{"Type":3,"Flags":0,"Description":"Scaling worker count."},"targetWorkerSizeId":{"Type":3,"Flags":0,"Description":"Scaling worker size ID."},"provisioningState":{"Type":86,"Flags":2,"Description":"Provisioning state of the App Service Plan."},"kubeEnvironmentProfile":{"Type":87,"Flags":0,"Description":"Specification for a Kubernetes Environment to use for this resource."},"zoneRedundant":{"Type":2,"Flags":0,"Description":"If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing."}}}},{"6":{"Value":"Ready"}},{"6":{"Value":"Pending"}},{"6":{"Value":"Creating"}},{"5":{"Elements":[76,77,78]}},{"2":{"Name":"HostingEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the App Service Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the App Service Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the App Service Environment."}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[81,82,83,84,85]}},{"2":{"Name":"KubeEnvironmentProfile","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource ID of the Kubernetes Environment."},"name":{"Type":4,"Flags":2,"Description":"Name of the Kubernetes Environment."},"type":{"Type":4,"Flags":2,"Description":"Resource type of the Kubernetes Environment."}}}},{"2":{"Name":"ExtendedLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of extended location."},"type":{"Type":4,"Flags":2,"Description":"Type of extended location."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/serverfarms@2021-03-01","ScopeType":8,"Body":74}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":91,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":92,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetGatewayProperties","Properties":{"vnetName":{"Type":4,"Flags":0,"Description":"The Virtual Network name."},"vpnPackageUri":{"Type":4,"Flags":5,"Description":"The URI where the VPN package can be downloaded."}}}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/gateways@2021-03-01","ScopeType":8,"Body":93}},{"6":{"Value":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":96,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":97,"Flags":10,"Description":"The resource api version"},"properties":{"Type":99,"Flags":4,"Description":"VnetRoute resource specific properties"},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetRouteProperties","Properties":{"startAddress":{"Type":4,"Flags":4,"Description":"The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."},"endAddress":{"Type":4,"Flags":4,"Description":"The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."},"routeType":{"Type":103,"Flags":4,"Description":"The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."}}}},{"6":{"Value":"DEFAULT"}},{"6":{"Value":"INHERITED"}},{"6":{"Value":"STATIC"}},{"5":{"Elements":[100,101,102,4]}},{"4":{"Name":"Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01","ScopeType":8,"Body":98}},{"6":{"Value":"Microsoft.Web/certificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/certificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":105,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":106,"Flags":10,"Description":"The resource api version"},"properties":{"Type":108,"Flags":0,"Description":"Certificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":122,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"CertificateProperties","Properties":{"password":{"Type":4,"Flags":4,"Description":"Certificate password."},"friendlyName":{"Type":4,"Flags":2,"Description":"Friendly name of the certificate."},"subjectName":{"Type":4,"Flags":2,"Description":"Subject name of the certificate."},"hostNames":{"Type":109,"Flags":0,"Description":"Host names the certificate applies to."},"pfxBlob":{"Type":0,"Flags":0,"Description":"Pfx blob."},"siteName":{"Type":4,"Flags":2,"Description":"App name."},"selfLink":{"Type":4,"Flags":2,"Description":"Self link."},"issuer":{"Type":4,"Flags":2,"Description":"Certificate issuer."},"issueDate":{"Type":4,"Flags":2,"Description":"Certificate issue Date."},"expirationDate":{"Type":4,"Flags":2,"Description":"Certificate expiration date."},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate thumbprint."},"valid":{"Type":2,"Flags":2,"Description":"Is the certificate valid?."},"cerBlob":{"Type":0,"Flags":2,"Description":"Raw bytes of .cer file"},"publicKeyHash":{"Type":4,"Flags":2,"Description":"Public key hash."},"hostingEnvironmentProfile":{"Type":80,"Flags":2,"Description":"Specification for an App Service Environment to use for this resource."},"keyVaultId":{"Type":4,"Flags":0,"Description":"Key Vault Csm resource Id."},"keyVaultSecretName":{"Type":4,"Flags":0,"Description":"Key Vault secret name."},"keyVaultSecretStatus":{"Type":121,"Flags":2,"Description":"Status of the Key Vault secret."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"canonicalName":{"Type":4,"Flags":0,"Description":"CNAME of the certificate to be issued via free certificate"},"domainValidationMethod":{"Type":4,"Flags":0,"Description":"Method of domain validation for free cert"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Initialized"}},{"6":{"Value":"WaitingOnCertificateOrder"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"CertificateOrderFailed"}},{"6":{"Value":"OperationNotPermittedOnKeyVault"}},{"6":{"Value":"AzureServiceUnauthorizedToAccessKeyVault"}},{"6":{"Value":"KeyVaultDoesNotExist"}},{"6":{"Value":"KeyVaultSecretDoesNotExist"}},{"6":{"Value":"UnknownError"}},{"6":{"Value":"ExternalPrivateKey"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[110,111,112,113,114,115,116,117,118,119,120]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/certificates@2021-03-01","ScopeType":8,"Body":107}},{"6":{"Value":"Microsoft.Web/containerApps"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/containerApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":124,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":125,"Flags":10,"Description":"The resource api version"},"properties":{"Type":127,"Flags":0,"Description":"ContainerApp resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":173,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ContainerAppProperties","Properties":{"provisioningState":{"Type":132,"Flags":2,"Description":"Provisioning state of the Container App."},"kubeEnvironmentId":{"Type":4,"Flags":0,"Description":"Resource ID of the Container App's KubeEnvironment."},"latestRevisionName":{"Type":4,"Flags":2,"Description":"Name of the latest revision of the Container App."},"latestRevisionFqdn":{"Type":4,"Flags":2,"Description":"Fully Qualified Domain Name of the latest revision of the Container App."},"configuration":{"Type":133,"Flags":0,"Description":"Non versioned Container App configuration properties that define the mutable settings of a Container app"},"template":{"Type":148,"Flags":0,"Description":"Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created"}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"5":{"Elements":[128,129,130,131,4]}},{"2":{"Name":"Configuration","Properties":{"secrets":{"Type":135,"Flags":0,"Description":"Collection of secrets used by a Container app"},"activeRevisionsMode":{"Type":138,"Flags":0,"Description":"ActiveRevisionsMode controls how active revisions are handled for the Container app:\nMultiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode"},"ingress":{"Type":139,"Flags":0,"Description":"Container App Ingress configuration."},"registries":{"Type":147,"Flags":0,"Description":"Collection of private container registry credentials for containers used by the Container app"}}}},{"2":{"Name":"Secret","Properties":{"name":{"Type":4,"Flags":0,"Description":"Secret Name."},"value":{"Type":4,"Flags":4,"Description":"Secret Value."}}}},{"3":{"ItemType":134}},{"6":{"Value":"multiple"}},{"6":{"Value":"single"}},{"5":{"Elements":[136,137,4]}},{"2":{"Name":"Ingress","Properties":{"fqdn":{"Type":4,"Flags":2,"Description":"Hostname."},"external":{"Type":2,"Flags":0,"Description":"Bool indicating if app exposes an external http endpoint"},"targetPort":{"Type":3,"Flags":0,"Description":"Target Port in containers for traffic from ingress"},"transport":{"Type":143,"Flags":0,"Description":"Ingress transport protocol"},"traffic":{"Type":145,"Flags":0,"Description":"Array of TrafficWeight"},"allowInsecure":{"Type":2,"Flags":0,"Description":"Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections"}}}},{"6":{"Value":"auto"}},{"6":{"Value":"http"}},{"6":{"Value":"http2"}},{"5":{"Elements":[140,141,142,4]}},{"2":{"Name":"TrafficWeight","Properties":{"revisionName":{"Type":4,"Flags":0,"Description":"Name of a revision"},"weight":{"Type":3,"Flags":0,"Description":"Traffic weight assigned to a revision"},"latestRevision":{"Type":2,"Flags":0,"Description":"Indicates that the traffic weight belongs to a latest stable revision"}}}},{"3":{"ItemType":144}},{"2":{"Name":"RegistryCredentials","Properties":{"server":{"Type":4,"Flags":0,"Description":"Container Registry Server"},"username":{"Type":4,"Flags":0,"Description":"Container Registry Username"},"passwordSecretRef":{"Type":4,"Flags":0,"Description":"The name of the Secret that contains the registry login password"}}}},{"3":{"ItemType":146}},{"2":{"Name":"Template","Properties":{"revisionSuffix":{"Type":4,"Flags":0,"Description":"User friendly suffix that is appended to the revision name"},"containers":{"Type":155,"Flags":0,"Description":"List of container definitions for the Container App."},"scale":{"Type":156,"Flags":0,"Description":"Container App scaling configurations."},"dapr":{"Type":168,"Flags":0,"Description":"Container App Dapr configuration."}}}},{"2":{"Name":"Container","Properties":{"image":{"Type":4,"Flags":0,"Description":"Container image tag."},"name":{"Type":4,"Flags":0,"Description":"Custom container name."},"command":{"Type":150,"Flags":0,"Description":"Container start command."},"args":{"Type":151,"Flags":0,"Description":"Container start command arguments."},"env":{"Type":153,"Flags":0,"Description":"Container environment variables."},"resources":{"Type":154,"Flags":0,"Description":"Container App container resource requirements."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"EnvironmentVar","Properties":{"name":{"Type":4,"Flags":0,"Description":"Environment variable name."},"value":{"Type":4,"Flags":0,"Description":"Non-secret environment variable value."},"secretRef":{"Type":4,"Flags":0,"Description":"Name of the Container App secret from which to pull the environment variable value."}}}},{"3":{"ItemType":152}},{"2":{"Name":"ContainerResources","Properties":{"cpu":{"Type":3,"Flags":0,"Description":"Required CPU in cores, e.g. 0.5"},"memory":{"Type":4,"Flags":0,"Description":"Required memory, e.g. \"250Mb\""}}}},{"3":{"ItemType":149}},{"2":{"Name":"Scale","Properties":{"minReplicas":{"Type":3,"Flags":0,"Description":"Optional. Minimum number of container replicas."},"maxReplicas":{"Type":3,"Flags":0,"Description":"Optional. Maximum number of container replicas. Defaults to 10 if not set."},"rules":{"Type":167,"Flags":0,"Description":"Scaling rules."}}}},{"2":{"Name":"ScaleRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"Scale Rule Name"},"azureQueue":{"Type":158,"Flags":0,"Description":"Container App container Azure Queue based scaling rule."},"custom":{"Type":161,"Flags":0,"Description":"Container App container Custom scaling rule."},"http":{"Type":164,"Flags":0,"Description":"Container App container Custom scaling rule."}}}},{"2":{"Name":"QueueScaleRule","Properties":{"queueName":{"Type":4,"Flags":0,"Description":"Queue name."},"queueLength":{"Type":3,"Flags":0,"Description":"Queue length."},"auth":{"Type":160,"Flags":0,"Description":"Authentication secrets for the queue scale rule."}}}},{"2":{"Name":"ScaleRuleAuth","Properties":{"secretRef":{"Type":4,"Flags":0,"Description":"Name of the Container App secret from which to pull the auth params."},"triggerParameter":{"Type":4,"Flags":0,"Description":"Trigger Parameter that uses the secret"}}}},{"3":{"ItemType":159}},{"2":{"Name":"CustomScaleRule","Properties":{"type":{"Type":4,"Flags":0,"Description":"Type of the custom scale rule\neg: azure-servicebus, redis etc."},"metadata":{"Type":162,"Flags":0,"Description":"Metadata properties to describe custom scale rule."},"auth":{"Type":163,"Flags":0,"Description":"Authentication secrets for the custom scale rule."}}}},{"2":{"Name":"CustomScaleRuleMetadata","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":159}},{"2":{"Name":"HttpScaleRule","Properties":{"metadata":{"Type":165,"Flags":0,"Description":"Metadata properties to describe http scale rule."},"auth":{"Type":166,"Flags":0,"Description":"Authentication secrets for the custom scale rule."}}}},{"2":{"Name":"HttpScaleRuleMetadata","Properties":{},"AdditionalProperties":4}},{"3":{"ItemType":159}},{"3":{"ItemType":157}},{"2":{"Name":"Dapr","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Boolean indicating if the Dapr side car is enabled"},"appId":{"Type":4,"Flags":0,"Description":"Dapr application identifier"},"appPort":{"Type":3,"Flags":0,"Description":"Port on which the Dapr side car"},"components":{"Type":172,"Flags":0,"Description":"Collection of Dapr components"}}}},{"2":{"Name":"DaprComponent","Properties":{"name":{"Type":4,"Flags":0,"Description":"Component name"},"type":{"Type":4,"Flags":0,"Description":"Component type"},"version":{"Type":4,"Flags":0,"Description":"Component version"},"metadata":{"Type":171,"Flags":0,"Description":"Component metadata"}}}},{"2":{"Name":"DaprMetadata","Properties":{"name":{"Type":4,"Flags":0,"Description":"Metadata property name."},"value":{"Type":4,"Flags":0,"Description":"Metadata property value."},"secretRef":{"Type":4,"Flags":0,"Description":"Name of the Container App secret from which to pull the metadata property value."}}}},{"3":{"ItemType":170}},{"3":{"ItemType":169}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/containerApps@2021-03-01","ScopeType":8,"Body":126}},{"6":{"Value":"Microsoft.Web/kubeEnvironments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/kubeEnvironments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":175,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":176,"Flags":10,"Description":"The resource api version"},"properties":{"Type":178,"Flags":0,"Description":"KubeEnvironment resource specific properties"},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":201,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"KubeEnvironmentProperties","Properties":{"provisioningState":{"Type":189,"Flags":2,"Description":"Provisioning state of the Kubernetes Environment."},"deploymentErrors":{"Type":4,"Flags":2,"Description":"Any errors that occurred during deployment or deployment validation"},"internalLoadBalancerEnabled":{"Type":2,"Flags":0,"Description":"Only visible within Vnet/Subnet"},"defaultDomain":{"Type":4,"Flags":2,"Description":"Default Domain Name for the cluster"},"staticIp":{"Type":4,"Flags":0,"Description":"Static IP of the KubeEnvironment"},"environmentType":{"Type":4,"Flags":0,"Description":"Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed"},"arcConfiguration":{"Type":190,"Flags":0},"appLogsConfiguration":{"Type":198,"Flags":0},"containerAppsConfiguration":{"Type":200,"Flags":0},"aksResourceID":{"Type":4,"Flags":0}}}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Canceled"}},{"6":{"Value":"Waiting"}},{"6":{"Value":"InitializationInProgress"}},{"6":{"Value":"InfrastructureSetupInProgress"}},{"6":{"Value":"InfrastructureSetupComplete"}},{"6":{"Value":"ScheduledForDelete"}},{"6":{"Value":"UpgradeRequested"}},{"6":{"Value":"UpgradeFailed"}},{"5":{"Elements":[179,180,181,182,183,184,185,186,187,188]}},{"2":{"Name":"ArcConfiguration","Properties":{"artifactsStorageType":{"Type":193,"Flags":0},"artifactStorageClassName":{"Type":4,"Flags":0},"artifactStorageMountPath":{"Type":4,"Flags":0},"artifactStorageNodeName":{"Type":4,"Flags":0},"artifactStorageAccessMode":{"Type":4,"Flags":0},"frontEndServiceConfiguration":{"Type":194,"Flags":0},"kubeConfig":{"Type":4,"Flags":4}}}},{"6":{"Value":"LocalNode"}},{"6":{"Value":"NetworkFileSystem"}},{"5":{"Elements":[191,192]}},{"2":{"Name":"FrontEndConfiguration","Properties":{"kind":{"Type":197,"Flags":0}}}},{"6":{"Value":"NodePort"}},{"6":{"Value":"LoadBalancer"}},{"5":{"Elements":[195,196]}},{"2":{"Name":"AppLogsConfiguration","Properties":{"destination":{"Type":4,"Flags":0},"logAnalyticsConfiguration":{"Type":199,"Flags":0}}}},{"2":{"Name":"LogAnalyticsConfiguration","Properties":{"customerId":{"Type":4,"Flags":0},"sharedKey":{"Type":4,"Flags":4}}}},{"2":{"Name":"ContainerAppsConfiguration","Properties":{"daprAIInstrumentationKey":{"Type":4,"Flags":0,"Description":"Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry"},"platformReservedCidr":{"Type":4,"Flags":0,"Description":"IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges."},"platformReservedDnsIP":{"Type":4,"Flags":0,"Description":"An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server"},"controlPlaneSubnetResourceId":{"Type":4,"Flags":0,"Description":"Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined."},"appSubnetResourceId":{"Type":4,"Flags":0,"Description":"Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined."},"dockerBridgeCidr":{"Type":4,"Flags":0,"Description":"CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/kubeEnvironments@2021-03-01","ScopeType":8,"Body":177}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/publishingUsers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/publishingUsers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":203,"Flags":9,"Description":"The resource name"},"type":{"Type":204,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":205,"Flags":10,"Description":"The resource api version"},"properties":{"Type":207,"Flags":0,"Description":"User resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"UserProperties","Properties":{"publishingUserName":{"Type":4,"Flags":1,"Description":"Username used for publishing."},"publishingPassword":{"Type":4,"Flags":0,"Description":"Password used for publishing."},"publishingPasswordHash":{"Type":4,"Flags":0,"Description":"Password hash used for publishing."},"publishingPasswordHashSalt":{"Type":4,"Flags":0,"Description":"Password hash salt used for publishing."},"scmUri":{"Type":4,"Flags":0,"Description":"Url of SCM site."}}}},{"4":{"Name":"Microsoft.Web/publishingUsers@2021-03-01","ScopeType":1,"Body":206}},{"6":{"Value":"Microsoft.Web/sourcecontrols"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":209,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":210,"Flags":10,"Description":"The resource api version"},"properties":{"Type":212,"Flags":0,"Description":"SourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SourceControlProperties","Properties":{"token":{"Type":4,"Flags":0,"Description":"OAuth access token."},"tokenSecret":{"Type":4,"Flags":0,"Description":"OAuth access token secret."},"refreshToken":{"Type":4,"Flags":0,"Description":"OAuth refresh token."},"expirationTime":{"Type":4,"Flags":0,"Description":"OAuth token expiration."}}}},{"4":{"Name":"Microsoft.Web/sourcecontrols@2021-03-01","ScopeType":1,"Body":211}},{"6":{"Value":"Microsoft.Web/staticSites"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":214,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":215,"Flags":10,"Description":"The resource api version"},"properties":{"Type":217,"Flags":0,"Description":"A static site."},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":252,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"StaticSite","Properties":{"defaultHostname":{"Type":4,"Flags":2,"Description":"The default autogenerated hostname for the static site."},"repositoryUrl":{"Type":4,"Flags":0,"Description":"URL for the repository of the static site."},"branch":{"Type":4,"Flags":0,"Description":"The target branch in the repository."},"customDomains":{"Type":218,"Flags":2,"Description":"The custom domains associated with this static site."},"repositoryToken":{"Type":4,"Flags":0,"Description":"A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."},"buildProperties":{"Type":219,"Flags":0,"Description":"Build properties for the static site."},"privateEndpointConnections":{"Type":239,"Flags":2,"Description":"Private endpoint connections"},"stagingEnvironmentPolicy":{"Type":242,"Flags":0,"Description":"State indicating whether staging environments are allowed or not allowed for a static web app."},"allowConfigFileUpdates":{"Type":2,"Flags":0,"Description":"false if config file is locked for this static web app; otherwise, true."},"templateProperties":{"Type":243,"Flags":0,"Description":"Template Options for the static site."},"contentDistributionEndpoint":{"Type":4,"Flags":2,"Description":"The content distribution endpoint for the static site."},"keyVaultReferenceIdentity":{"Type":4,"Flags":2,"Description":"Identity to use for Key Vault Reference authentication."},"userProvidedFunctionApps":{"Type":246,"Flags":2,"Description":"User provided function apps registered with the static site"},"provider":{"Type":4,"Flags":0,"Description":"The provider that submitted the last deployment to the primary environment of the static site."},"enterpriseGradeCdnStatus":{"Type":251,"Flags":0,"Description":"State indicating the status of the enterprise grade CDN serving traffic to the static web app."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StaticSiteBuildProperties","Properties":{"appLocation":{"Type":4,"Flags":0,"Description":"The path to the app code within the repository."},"apiLocation":{"Type":4,"Flags":0,"Description":"The path to the api code within the repository."},"appArtifactLocation":{"Type":4,"Flags":0,"Description":"Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"},"outputLocation":{"Type":4,"Flags":0,"Description":"The output path of the app after building."},"appBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the static content application."},"apiBuildCommand":{"Type":4,"Flags":0,"Description":"A custom command to run during deployment of the Azure Functions API application."},"skipGithubActionWorkflowGeneration":{"Type":2,"Flags":0,"Description":"Skip Github Action workflow generation."},"githubActionSecretNameOverride":{"Type":4,"Flags":0,"Description":"Github Action secret name override."}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnection","Properties":{"id":{"Type":4,"Flags":0,"Description":"Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"},"name":{"Type":4,"Flags":0,"Description":"Name of resource."},"type":{"Type":4,"Flags":0,"Description":"Type of resource e.g \"Microsoft.Web/sites\"."},"location":{"Type":4,"Flags":0,"Description":"Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."},"tags":{"Type":221,"Flags":0,"Description":"Tags associated with resource."},"plan":{"Type":222,"Flags":0,"Description":"The plan object in Azure Resource Manager, represents a marketplace plan."},"properties":{"Type":223,"Flags":0,"Description":"A remote private endpoint connection"},"sku":{"Type":54,"Flags":0,"Description":"Description of a SKU for a scalable resource."},"status":{"Type":4,"Flags":0,"Description":"Azure-AsyncOperation Status info."},"error":{"Type":226,"Flags":0,"Description":"Body of the error response returned from the API."},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"zones":{"Type":238,"Flags":0,"Description":"Logical Availability Zones the service is hosted in"}}}},{"2":{"Name":"ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"ArmPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name."},"publisher":{"Type":4,"Flags":0,"Description":"The publisher."},"product":{"Type":4,"Flags":0,"Description":"The product."},"promotionCode":{"Type":4,"Flags":0,"Description":"The promotion code."},"version":{"Type":4,"Flags":0,"Description":"Version of product."}}}},{"2":{"Name":"RemotePrivateEndpointConnection","Properties":{"properties":{"Type":224,"Flags":0,"Description":"RemotePrivateEndpointConnection resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"RemotePrivateEndpointConnectionProperties","Properties":{"provisioningState":{"Type":4,"Flags":2},"privateEndpoint":{"Type":65,"Flags":0,"Description":"A wrapper for an ARM resource id"},"privateLinkServiceConnectionState":{"Type":64,"Flags":0,"Description":"The state of a private link connection"},"ipAddresses":{"Type":225,"Flags":0,"Description":"Private IPAddresses mapped to the remote private endpoint"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ErrorEntity","Properties":{"extendedCode":{"Type":4,"Flags":0,"Description":"Type of error."},"messageTemplate":{"Type":4,"Flags":0,"Description":"Message template."},"parameters":{"Type":227,"Flags":0,"Description":"Parameters for the template."},"innerErrors":{"Type":228,"Flags":0,"Description":"Inner errors."},"details":{"Type":229,"Flags":0,"Description":"Error Details."},"target":{"Type":4,"Flags":0,"Description":"The error target."},"code":{"Type":4,"Flags":0,"Description":"Basic error code."},"message":{"Type":4,"Flags":0,"Description":"Any details of the error."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":226}},{"3":{"ItemType":226}},{"2":{"Name":"ManagedServiceIdentity","Properties":{"type":{"Type":235,"Flags":0,"Description":"Type of managed service identity."},"tenantId":{"Type":4,"Flags":2,"Description":"Tenant of managed service identity."},"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of managed service identity."},"userAssignedIdentities":{"Type":237,"Flags":0,"Description":"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}"}}}},{"6":{"Value":"SystemAssigned"}},{"6":{"Value":"UserAssigned"}},{"6":{"Value":"SystemAssigned, UserAssigned"}},{"6":{"Value":"None"}},{"5":{"Elements":[231,232,233,234]}},{"2":{"Name":"UserAssignedIdentity","Properties":{"principalId":{"Type":4,"Flags":2,"Description":"Principal Id of user assigned identity"},"clientId":{"Type":4,"Flags":2,"Description":"Client Id of user assigned identity"}}}},{"2":{"Name":"ManagedServiceIdentityUserAssignedIdentities","Properties":{},"AdditionalProperties":236}},{"3":{"ItemType":4}},{"3":{"ItemType":220}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[240,241]}},{"2":{"Name":"StaticSiteTemplateOptions","Properties":{"templateRepositoryUrl":{"Type":4,"Flags":0,"Description":"URL of the template repository. The newly generated repository will be based on this one."},"owner":{"Type":4,"Flags":0,"Description":"Owner of the newly generated repository."},"repositoryName":{"Type":4,"Flags":0,"Description":"Name of the newly generated repository."},"description":{"Type":4,"Flags":0,"Description":"Description of the newly generated repository."},"isPrivate":{"Type":2,"Flags":0,"Description":"Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionApp","Properties":{"properties":{"Type":245,"Flags":0,"Description":"StaticSiteUserProvidedFunctionApp resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"3":{"ItemType":244}},{"6":{"Value":"Enabled"}},{"6":{"Value":"Enabling"}},{"6":{"Value":"Disabled"}},{"6":{"Value":"Disabling"}},{"5":{"Elements":[247,248,249,250,4]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/staticSites@2021-03-01","ScopeType":8,"Body":216}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":254,"Flags":9,"Description":"The resource name"},"type":{"Type":255,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":256,"Flags":10,"Description":"The resource api version"},"properties":{"Type":258,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/builds/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":259,"Flags":9,"Description":"The resource name"},"type":{"Type":260,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":261,"Flags":10,"Description":"The resource api version"},"properties":{"Type":263,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/builds/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":257,"functionappsettings":262}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/config@2021-03-01","ScopeType":8,"Body":264}},{"6":{"Value":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":266,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":267,"Flags":10,"Description":"The resource api version"},"properties":{"Type":269,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteUserProvidedFunctionAppARMResourceProperties","Properties":{"functionAppResourceId":{"Type":4,"Flags":0,"Description":"The resource id of the function app registered with the static site"},"functionAppRegion":{"Type":4,"Flags":0,"Description":"The region of the function app registered with the static site"},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the function app was registered with the static site."}}}},{"4":{"Name":"Microsoft.Web/staticSites/builds/userProvidedFunctionApps@2021-03-01","ScopeType":8,"Body":268}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":271,"Flags":9,"Description":"The resource name"},"type":{"Type":272,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":273,"Flags":10,"Description":"The resource api version"},"properties":{"Type":275,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"functionappsettings"}},{"6":{"Value":"Microsoft.Web/staticSites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":276,"Flags":9,"Description":"The resource name"},"type":{"Type":277,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":278,"Flags":10,"Description":"The resource api version"},"properties":{"Type":280,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"7":{"Name":"microsoft.web/staticsites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":274,"functionappsettings":279}}},{"4":{"Name":"Microsoft.Web/staticSites/config@2021-03-01","ScopeType":8,"Body":281}},{"6":{"Value":"Microsoft.Web/staticSites/customDomains"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/customDomains","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":283,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":284,"Flags":10,"Description":"The resource api version"},"properties":{"Type":286,"Flags":0,"Description":"StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StaticSiteCustomDomainRequestPropertiesARMResourceProperties","Properties":{"validationMethod":{"Type":4,"Flags":4,"Description":"Validation method for adding a custom domain"},"domainName":{"Type":4,"Flags":2,"Description":"The domain name for the static site custom domain."},"createdOn":{"Type":4,"Flags":2,"Description":"The date and time on which the custom domain was created for the static site."},"status":{"Type":293,"Flags":2,"Description":"The status of the custom domain"},"validationToken":{"Type":4,"Flags":2,"Description":"The TXT record validation token"},"errorMessage":{"Type":4,"Flags":2}}}},{"6":{"Value":"RetrievingValidationToken"}},{"6":{"Value":"Validating"}},{"6":{"Value":"Adding"}},{"6":{"Value":"Ready"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Deleting"}},{"5":{"Elements":[287,288,289,290,291,292,4]}},{"4":{"Name":"Microsoft.Web/staticSites/customDomains@2021-03-01","ScopeType":8,"Body":285}},{"6":{"Value":"Microsoft.Web/staticSites/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":295,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":296,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":297}},{"6":{"Value":"Microsoft.Web/staticSites/userProvidedFunctionApps"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":299,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":300,"Flags":10,"Description":"The resource api version"},"properties":{"Type":269,"Flags":0,"Description":"StaticSiteUserProvidedFunctionAppARMResource resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/staticSites/userProvidedFunctionApps@2021-03-01","ScopeType":8,"Body":301}},{"6":{"Value":"Microsoft.Web/sites"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":303,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":304,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":444,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"SiteProperties","Properties":{"state":{"Type":4,"Flags":2,"Description":"Current state of the app."},"hostNames":{"Type":307,"Flags":2,"Description":"Hostnames associated with the app."},"repositorySiteName":{"Type":4,"Flags":2,"Description":"Name of the repository site."},"usageState":{"Type":310,"Flags":2,"Description":"State indicating whether the app has exceeded its quota usage. Read-only."},"enabled":{"Type":2,"Flags":0,"Description":"true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."},"enabledHostNames":{"Type":311,"Flags":2,"Description":"Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames."},"availabilityState":{"Type":315,"Flags":2,"Description":"Management information availability state for the app."},"hostNameSslStates":{"Type":324,"Flags":0,"Description":"Hostname SSL states are used to manage the SSL bindings for app's hostnames."},"serverFarmId":{"Type":4,"Flags":0,"Description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."},"reserved":{"Type":2,"Flags":0,"Description":"true if reserved; otherwise, false."},"isXenon":{"Type":2,"Flags":0,"Description":"Obsolete: Hyper-V sandbox."},"hyperV":{"Type":2,"Flags":0,"Description":"Hyper-V sandbox."},"lastModifiedTimeUtc":{"Type":4,"Flags":2,"Description":"Last time the app was modified, in UTC. Read-only."},"siteConfig":{"Type":325,"Flags":0,"Description":"Configuration of an App Service app."},"trafficManagerHostNames":{"Type":430,"Flags":2,"Description":"Azure Traffic Manager hostnames associated with the app. Read-only."},"scmSiteAlsoStopped":{"Type":2,"Flags":0,"Description":"true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false."},"targetSwapSlot":{"Type":4,"Flags":2,"Description":"Specifies which deployment slot this app will swap into. Read-only."},"hostingEnvironmentProfile":{"Type":80,"Flags":0,"Description":"Specification for an App Service Environment to use for this resource."},"clientAffinityEnabled":{"Type":2,"Flags":0,"Description":"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."},"clientCertEnabled":{"Type":2,"Flags":0,"Description":"true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."},"clientCertMode":{"Type":434,"Flags":0,"Description":"This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."},"clientCertExclusionPaths":{"Type":4,"Flags":0,"Description":"client certificate authentication comma-separated exclusion paths"},"hostNamesDisabled":{"Type":2,"Flags":0,"Description":"true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process."},"customDomainVerificationId":{"Type":4,"Flags":0,"Description":"Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."},"outboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only."},"possibleOutboundIpAddresses":{"Type":4,"Flags":2,"Description":"List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only."},"containerSize":{"Type":3,"Flags":0,"Description":"Size of the function container."},"dailyMemoryTimeQuota":{"Type":3,"Flags":0,"Description":"Maximum allowed daily memory-time quota (applicable on dynamic apps only)."},"suspendedTill":{"Type":4,"Flags":2,"Description":"App suspended till in case memory-time quota is exceeded."},"maxNumberOfWorkers":{"Type":3,"Flags":2,"Description":"Maximum number of workers.\nThis only applies to Functions container."},"cloningInfo":{"Type":435,"Flags":4,"Description":"Information needed for cloning operation."},"resourceGroup":{"Type":4,"Flags":2,"Description":"Name of the resource group the app belongs to. Read-only."},"isDefaultContainer":{"Type":2,"Flags":2,"Description":"true if the app is a default container; otherwise, false."},"defaultHostName":{"Type":4,"Flags":2,"Description":"Default hostname of the app. Read-only."},"slotSwapStatus":{"Type":437,"Flags":2,"Description":"The status of the last successful slot swap operation."},"httpsOnly":{"Type":2,"Flags":0,"Description":"HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"},"redundancyMode":{"Type":443,"Flags":0,"Description":"Site redundancy mode"},"inProgressOperationId":{"Type":4,"Flags":2,"Description":"Specifies an operation id if this site has a pending operation."},"storageAccountRequired":{"Type":2,"Flags":0,"Description":"Checks if Customer provided storage account is required"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"virtualNetworkSubnetId":{"Type":4,"Flags":0,"Description":"Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"}}}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Exceeded"}},{"5":{"Elements":[308,309]}},{"3":{"ItemType":4}},{"6":{"Value":"Normal"}},{"6":{"Value":"Limited"}},{"6":{"Value":"DisasterRecoveryMode"}},{"5":{"Elements":[312,313,314]}},{"2":{"Name":"HostNameSslState","Properties":{"name":{"Type":4,"Flags":0,"Description":"Hostname."},"sslState":{"Type":320,"Flags":0,"Description":"SSL type"},"virtualIP":{"Type":4,"Flags":0,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint."},"toUpdate":{"Type":2,"Flags":0,"Description":"Set to true to update existing hostname."},"hostType":{"Type":323,"Flags":0,"Description":"Indicates whether the hostname is a standard or repository hostname."}}}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[317,318,319]}},{"6":{"Value":"Standard"}},{"6":{"Value":"Repository"}},{"5":{"Elements":[321,322]}},{"3":{"ItemType":316}},{"2":{"Name":"SiteConfig","Properties":{"numberOfWorkers":{"Type":3,"Flags":0,"Description":"Number of workers."},"defaultDocuments":{"Type":326,"Flags":0,"Description":"Default documents."},"netFrameworkVersion":{"Type":4,"Flags":0,"Description":".NET Framework version."},"phpVersion":{"Type":4,"Flags":0,"Description":"Version of PHP."},"pythonVersion":{"Type":4,"Flags":0,"Description":"Version of Python."},"nodeVersion":{"Type":4,"Flags":0,"Description":"Version of Node.js."},"powerShellVersion":{"Type":4,"Flags":0,"Description":"Version of PowerShell."},"linuxFxVersion":{"Type":4,"Flags":0,"Description":"Linux App Framework and version"},"windowsFxVersion":{"Type":4,"Flags":0,"Description":"Xenon App Framework and version"},"requestTracingEnabled":{"Type":2,"Flags":0,"Description":"true if request tracing is enabled; otherwise, false."},"requestTracingExpirationTime":{"Type":4,"Flags":0,"Description":"Request tracing expiration time."},"remoteDebuggingEnabled":{"Type":2,"Flags":0,"Description":"true if remote debugging is enabled; otherwise, false."},"remoteDebuggingVersion":{"Type":4,"Flags":0,"Description":"Remote debugging version."},"httpLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if HTTP logging is enabled; otherwise, false."},"acrUseManagedIdentityCreds":{"Type":2,"Flags":0,"Description":"Flag to use Managed Identity Creds for ACR pull"},"acrUserManagedIdentityID":{"Type":4,"Flags":0,"Description":"If using user managed identity, the user managed identity ClientId"},"logsDirectorySizeLimit":{"Type":3,"Flags":0,"Description":"HTTP logs directory size limit."},"detailedErrorLoggingEnabled":{"Type":2,"Flags":0,"Description":"true if detailed error logging is enabled; otherwise, false."},"publishingUsername":{"Type":4,"Flags":0,"Description":"Publishing user name."},"appSettings":{"Type":327,"Flags":0,"Description":"Application settings."},"connectionStrings":{"Type":341,"Flags":0,"Description":"Connection strings."},"machineKey":{"Type":342,"Flags":2,"Description":"MachineKey of an app."},"handlerMappings":{"Type":344,"Flags":0,"Description":"Handler mappings."},"documentRoot":{"Type":4,"Flags":0,"Description":"Document root."},"scmType":{"Type":359,"Flags":0,"Description":"SCM type."},"use32BitWorkerProcess":{"Type":2,"Flags":0,"Description":"true to use 32-bit worker process; otherwise, false."},"webSocketsEnabled":{"Type":2,"Flags":0,"Description":"true if WebSocket is enabled; otherwise, false."},"alwaysOn":{"Type":2,"Flags":0,"Description":"true if Always On is enabled; otherwise, false."},"javaVersion":{"Type":4,"Flags":0,"Description":"Java version."},"javaContainer":{"Type":4,"Flags":0,"Description":"Java container."},"javaContainerVersion":{"Type":4,"Flags":0,"Description":"Java container version."},"appCommandLine":{"Type":4,"Flags":0,"Description":"App command line to launch."},"managedPipelineMode":{"Type":362,"Flags":0,"Description":"Managed pipeline mode."},"virtualApplications":{"Type":366,"Flags":0,"Description":"Virtual applications."},"loadBalancing":{"Type":373,"Flags":0,"Description":"Site load balancing."},"experiments":{"Type":374,"Flags":0,"Description":"Routing rules in production experiments."},"limits":{"Type":377,"Flags":0,"Description":"Metric limits set on an app."},"autoHealEnabled":{"Type":2,"Flags":0,"Description":"true if Auto Heal is enabled; otherwise, false."},"autoHealRules":{"Type":378,"Flags":0,"Description":"Rules that can be defined for auto-heal."},"tracingOptions":{"Type":4,"Flags":0,"Description":"Tracing options."},"vnetName":{"Type":4,"Flags":0,"Description":"Virtual Network name."},"vnetRouteAllEnabled":{"Type":2,"Flags":0,"Description":"Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."},"vnetPrivatePortsCount":{"Type":3,"Flags":0,"Description":"The number of private ports assigned to this app. These will be assigned dynamically on runtime."},"cors":{"Type":393,"Flags":0,"Description":"Cross-Origin Resource Sharing (CORS) settings for the app."},"push":{"Type":395,"Flags":0,"Description":"Push settings for the App."},"apiDefinition":{"Type":397,"Flags":0,"Description":"Information about the formal API definition for the app."},"apiManagementConfig":{"Type":398,"Flags":0,"Description":"Azure API management (APIM) configuration linked to the app."},"autoSwapSlotName":{"Type":4,"Flags":0,"Description":"Auto-swap slot name."},"localMySqlEnabled":{"Type":2,"Flags":0,"Description":"true to enable local MySQL; otherwise, false."},"managedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Managed Service Identity Id"},"xManagedServiceIdentityId":{"Type":3,"Flags":0,"Description":"Explicit Managed Service Identity Id"},"keyVaultReferenceIdentity":{"Type":4,"Flags":0,"Description":"Identity to use for Key Vault Reference authentication."},"ipSecurityRestrictions":{"Type":406,"Flags":0,"Description":"IP security restrictions for main."},"scmIpSecurityRestrictions":{"Type":407,"Flags":0,"Description":"IP security restrictions for scm."},"scmIpSecurityRestrictionsUseMain":{"Type":2,"Flags":0,"Description":"IP security restrictions for scm to use main."},"http20Enabled":{"Type":2,"Flags":0,"Description":"Http20Enabled: configures a web site to allow clients to connect over http2.0"},"minTlsVersion":{"Type":411,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"scmMinTlsVersion":{"Type":415,"Flags":0,"Description":"MinTlsVersion: configures the minimum version of TLS required for SSL requests"},"ftpsState":{"Type":419,"Flags":0,"Description":"State of FTP / FTPS service"},"preWarmedInstanceCount":{"Type":3,"Flags":0,"Description":"Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans"},"functionAppScaleLimit":{"Type":3,"Flags":0,"Description":"Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans"},"healthCheckPath":{"Type":4,"Flags":0,"Description":"Health check path"},"functionsRuntimeScaleMonitoringEnabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."},"websiteTimeZone":{"Type":4,"Flags":0,"Description":"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"},"minimumElasticInstanceCount":{"Type":3,"Flags":0,"Description":"Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans"},"azureStorageAccounts":{"Type":429,"Flags":0,"Description":"List of Azure Storage Accounts."},"publicNetworkAccess":{"Type":4,"Flags":0,"Description":"Property to allow or block all public traffic."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"ConnStringInfo","Properties":{"name":{"Type":4,"Flags":0,"Description":"Name of connection string."},"connectionString":{"Type":4,"Flags":0,"Description":"Connection string value."},"type":{"Type":340,"Flags":0,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[329,330,331,332,333,334,335,336,337,338,339]}},{"3":{"ItemType":328}},{"2":{"Name":"SiteMachineKey","Properties":{"validation":{"Type":4,"Flags":0,"Description":"MachineKey validation."},"validationKey":{"Type":4,"Flags":0,"Description":"Validation key."},"decryption":{"Type":4,"Flags":0,"Description":"Algorithm used for decryption."},"decryptionKey":{"Type":4,"Flags":0,"Description":"Decryption key."}}}},{"2":{"Name":"HandlerMapping","Properties":{"extension":{"Type":4,"Flags":0,"Description":"Requests with this extension will be handled using the specified FastCGI application."},"scriptProcessor":{"Type":4,"Flags":0,"Description":"The absolute path to the FastCGI application."},"arguments":{"Type":4,"Flags":0,"Description":"Command-line arguments to be passed to the script processor."}}}},{"3":{"ItemType":343}},{"6":{"Value":"None"}},{"6":{"Value":"Dropbox"}},{"6":{"Value":"Tfs"}},{"6":{"Value":"LocalGit"}},{"6":{"Value":"GitHub"}},{"6":{"Value":"CodePlexGit"}},{"6":{"Value":"CodePlexHg"}},{"6":{"Value":"BitbucketGit"}},{"6":{"Value":"BitbucketHg"}},{"6":{"Value":"ExternalGit"}},{"6":{"Value":"ExternalHg"}},{"6":{"Value":"OneDrive"}},{"6":{"Value":"VSO"}},{"6":{"Value":"VSTSRM"}},{"5":{"Elements":[345,346,347,348,349,350,351,352,353,354,355,356,357,358,4]}},{"6":{"Value":"Integrated"}},{"6":{"Value":"Classic"}},{"5":{"Elements":[360,361]}},{"2":{"Name":"VirtualApplication","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Virtual path."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."},"preloadEnabled":{"Type":2,"Flags":0,"Description":"true if preloading is enabled; otherwise, false."},"virtualDirectories":{"Type":365,"Flags":0,"Description":"Virtual directories for virtual application."}}}},{"2":{"Name":"VirtualDirectory","Properties":{"virtualPath":{"Type":4,"Flags":0,"Description":"Path to virtual application."},"physicalPath":{"Type":4,"Flags":0,"Description":"Physical path."}}}},{"3":{"ItemType":364}},{"3":{"ItemType":363}},{"6":{"Value":"WeightedRoundRobin"}},{"6":{"Value":"LeastRequests"}},{"6":{"Value":"LeastResponseTime"}},{"6":{"Value":"WeightedTotalTraffic"}},{"6":{"Value":"RequestHash"}},{"6":{"Value":"PerSiteRoundRobin"}},{"5":{"Elements":[367,368,369,370,371,372]}},{"2":{"Name":"Experiments","Properties":{"rampUpRules":{"Type":376,"Flags":0,"Description":"List of ramp-up rules."}}}},{"2":{"Name":"RampUpRule","Properties":{"actionHostName":{"Type":4,"Flags":0,"Description":"Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."},"reroutePercentage":{"Type":3,"Flags":0,"Description":"Percentage of the traffic which will be redirected to ActionHostName."},"changeStep":{"Type":3,"Flags":0,"Description":"In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."},"changeIntervalInMinutes":{"Type":3,"Flags":0,"Description":"Specifies interval in minutes to reevaluate ReroutePercentage."},"minReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies lower boundary above which ReroutePercentage will stay."},"maxReroutePercentage":{"Type":3,"Flags":0,"Description":"Specifies upper boundary below which ReroutePercentage will stay."},"changeDecisionCallbackUrl":{"Type":4,"Flags":0,"Description":"Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/"},"name":{"Type":4,"Flags":0,"Description":"Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."}}}},{"3":{"ItemType":375}},{"2":{"Name":"SiteLimits","Properties":{"maxPercentageCpu":{"Type":3,"Flags":0,"Description":"Maximum allowed CPU usage percentage."},"maxMemoryInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed memory usage in MB."},"maxDiskSizeInMb":{"Type":3,"Flags":0,"Description":"Maximum allowed disk size usage in MB."}}}},{"2":{"Name":"AutoHealRules","Properties":{"triggers":{"Type":379,"Flags":0,"Description":"Triggers for auto-heal."},"actions":{"Type":387,"Flags":0,"Description":"Actions which to take by the auto-heal module when a rule is triggered."}}}},{"2":{"Name":"AutoHealTriggers","Properties":{"requests":{"Type":380,"Flags":0,"Description":"Trigger based on total requests."},"privateBytesInKB":{"Type":3,"Flags":0,"Description":"A rule based on private bytes."},"statusCodes":{"Type":382,"Flags":0,"Description":"A rule based on status codes."},"slowRequests":{"Type":383,"Flags":0,"Description":"Trigger based on request execution time."},"slowRequestsWithPath":{"Type":384,"Flags":0,"Description":"A rule based on multiple Slow Requests Rule with path"},"statusCodesRange":{"Type":386,"Flags":0,"Description":"A rule based on status codes ranges."}}}},{"2":{"Name":"RequestsBasedTrigger","Properties":{"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"2":{"Name":"StatusCodesBasedTrigger","Properties":{"status":{"Type":3,"Flags":0,"Description":"HTTP status code."},"subStatus":{"Type":3,"Flags":0,"Description":"Request Sub Status."},"win32Status":{"Type":3,"Flags":0,"Description":"Win32 error code."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."},"path":{"Type":4,"Flags":0,"Description":"Request Path"}}}},{"3":{"ItemType":381}},{"2":{"Name":"SlowRequestsBasedTrigger","Properties":{"timeTaken":{"Type":4,"Flags":0,"Description":"Time taken."},"path":{"Type":4,"Flags":0,"Description":"Request Path."},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":383}},{"2":{"Name":"StatusCodesRangeBasedTrigger","Properties":{"statusCodes":{"Type":4,"Flags":0,"Description":"HTTP status code."},"path":{"Type":4,"Flags":0},"count":{"Type":3,"Flags":0,"Description":"Request Count."},"timeInterval":{"Type":4,"Flags":0,"Description":"Time interval."}}}},{"3":{"ItemType":385}},{"2":{"Name":"AutoHealActions","Properties":{"actionType":{"Type":391,"Flags":0,"Description":"Predefined action to be taken."},"customAction":{"Type":392,"Flags":0,"Description":"Custom action to be executed\nwhen an auto heal rule is triggered."},"minProcessExecutionTime":{"Type":4,"Flags":0,"Description":"Minimum time the process must execute\nbefore taking the action"}}}},{"6":{"Value":"Recycle"}},{"6":{"Value":"LogEvent"}},{"6":{"Value":"CustomAction"}},{"5":{"Elements":[388,389,390]}},{"2":{"Name":"AutoHealCustomAction","Properties":{"exe":{"Type":4,"Flags":0,"Description":"Executable to be run."},"parameters":{"Type":4,"Flags":0,"Description":"Parameters for the executable."}}}},{"2":{"Name":"CorsSettings","Properties":{"allowedOrigins":{"Type":394,"Flags":0,"Description":"Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all."},"supportCredentials":{"Type":2,"Flags":0,"Description":"Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PushSettings","Properties":{"properties":{"Type":396,"Flags":0,"Description":"PushSettings resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"PushSettingsProperties","Properties":{"isPushEnabled":{"Type":2,"Flags":1,"Description":"Gets or sets a flag indicating whether the Push endpoint is enabled."},"tagWhitelistJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."},"tagsRequiringAuth":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."},"dynamicTagsJson":{"Type":4,"Flags":0,"Description":"Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."}}}},{"2":{"Name":"ApiDefinitionInfo","Properties":{"url":{"Type":4,"Flags":0,"Description":"The URL of the API definition."}}}},{"2":{"Name":"ApiManagementConfig","Properties":{"id":{"Type":4,"Flags":0,"Description":"APIM-Api Identifier."}}}},{"2":{"Name":"IpSecurityRestriction","Properties":{"ipAddress":{"Type":4,"Flags":0,"Description":"IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."},"subnetMask":{"Type":4,"Flags":0,"Description":"Subnet mask for the range of IP addresses the restriction is valid for."},"vnetSubnetResourceId":{"Type":4,"Flags":0,"Description":"Virtual network resource id"},"vnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Vnet traffic tag"},"subnetTrafficTag":{"Type":3,"Flags":0,"Description":"(internal) Subnet traffic tag"},"action":{"Type":4,"Flags":0,"Description":"Allow or Deny access for this IP range."},"tag":{"Type":403,"Flags":0,"Description":"Defines what this IP filter will be used for. This is to support IP filtering on proxies."},"priority":{"Type":3,"Flags":0,"Description":"Priority of IP restriction rule."},"name":{"Type":4,"Flags":0,"Description":"IP restriction rule name."},"description":{"Type":4,"Flags":0,"Description":"IP restriction rule description."},"headers":{"Type":405,"Flags":0,"Description":"IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match."}}}},{"6":{"Value":"Default"}},{"6":{"Value":"XffProxy"}},{"6":{"Value":"ServiceTag"}},{"5":{"Elements":[400,401,402,4]}},{"3":{"ItemType":4}},{"2":{"Name":"IpSecurityRestrictionHeaders","Properties":{},"AdditionalProperties":404}},{"3":{"ItemType":399}},{"3":{"ItemType":399}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[408,409,410,4]}},{"6":{"Value":"1.0"}},{"6":{"Value":"1.1"}},{"6":{"Value":"1.2"}},{"5":{"Elements":[412,413,414,4]}},{"6":{"Value":"AllAllowed"}},{"6":{"Value":"FtpsOnly"}},{"6":{"Value":"Disabled"}},{"5":{"Elements":[416,417,418,4]}},{"2":{"Name":"AzureStorageInfoValue","Properties":{"type":{"Type":423,"Flags":0,"Description":"Type of storage."},"accountName":{"Type":4,"Flags":0,"Description":"Name of the storage account."},"shareName":{"Type":4,"Flags":0,"Description":"Name of the file share (container name, for Blob storage)."},"accessKey":{"Type":4,"Flags":0,"Description":"Access key for the storage account."},"mountPath":{"Type":4,"Flags":0,"Description":"Path to mount the storage within the site's runtime environment."},"state":{"Type":428,"Flags":2,"Description":"State of the storage account."}}}},{"6":{"Value":"AzureFiles"}},{"6":{"Value":"AzureBlob"}},{"5":{"Elements":[421,422]}},{"6":{"Value":"Ok"}},{"6":{"Value":"InvalidCredentials"}},{"6":{"Value":"InvalidShare"}},{"6":{"Value":"NotValidated"}},{"5":{"Elements":[424,425,426,427]}},{"2":{"Name":"SiteConfigAzureStorageAccounts","Properties":{},"AdditionalProperties":420}},{"3":{"ItemType":4}},{"6":{"Value":"Required"}},{"6":{"Value":"Optional"}},{"6":{"Value":"OptionalInteractiveUser"}},{"5":{"Elements":[431,432,433]}},{"2":{"Name":"CloningInfo","Properties":{"correlationId":{"Type":4,"Flags":0,"Description":"Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."},"overwrite":{"Type":2,"Flags":0,"Description":"true to overwrite destination app; otherwise, false."},"cloneCustomHostNames":{"Type":2,"Flags":0,"Description":"true to clone custom hostnames from source app; otherwise, false."},"cloneSourceControl":{"Type":2,"Flags":0,"Description":"true to clone source control from source app; otherwise, false."},"sourceWebAppId":{"Type":4,"Flags":1,"Description":"ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."},"sourceWebAppLocation":{"Type":4,"Flags":0,"Description":"Location of source app ex: West US or North Europe"},"hostingEnvironment":{"Type":4,"Flags":0,"Description":"App Service Environment."},"appSettingsOverrides":{"Type":436,"Flags":0,"Description":"Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained."},"configureLoadBalancing":{"Type":2,"Flags":0,"Description":"true to configure load balancing for source and destination app."},"trafficManagerProfileId":{"Type":4,"Flags":0,"Description":"ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."},"trafficManagerProfileName":{"Type":4,"Flags":0,"Description":"Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."}}}},{"2":{"Name":"CloningInfoAppSettingsOverrides","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"SlotSwapStatus","Properties":{"timestampUtc":{"Type":4,"Flags":2,"Description":"The time the last successful slot swap completed."},"sourceSlotName":{"Type":4,"Flags":2,"Description":"The source slot of the last swap operation."},"destinationSlotName":{"Type":4,"Flags":2,"Description":"The destination slot of the last swap operation."}}}},{"6":{"Value":"None"}},{"6":{"Value":"Manual"}},{"6":{"Value":"Failover"}},{"6":{"Value":"ActiveActive"}},{"6":{"Value":"GeoRedundant"}},{"5":{"Elements":[438,439,440,441,442]}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites@2021-03-01","ScopeType":8,"Body":305}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":446,"Flags":9,"Description":"The resource name"},"type":{"Type":447,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":448,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"CsmPublishingCredentialsPoliciesEntityProperties","Properties":{"allow":{"Type":2,"Flags":1,"Description":"true to allow access to a publishing method; otherwise, false."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":451,"Flags":9,"Description":"The resource name"},"type":{"Type":452,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":453,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":449,"scm":454}}},{"4":{"Name":"Microsoft.Web/sites/basicPublishingCredentialsPolicies@2021-03-01","ScopeType":8,"Body":455}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":457,"Flags":9,"Description":"The resource name"},"type":{"Type":458,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":459,"Flags":10,"Description":"The resource api version"},"properties":{"Type":461,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":462,"Flags":9,"Description":"The resource name"},"type":{"Type":463,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":464,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"unauthenticatedClientAction":{"Type":469,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"tokenStoreEnabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"allowedExternalRedirectUrls":{"Type":470,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"defaultProvider":{"Type":477,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"issuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"validateIssuer":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."},"allowedAudiences":{"Type":478,"Flags":0,"Description":"Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting."},"additionalLoginParams":{"Type":479,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"aadClaimsAuthorization":{"Type":4,"Flags":0,"Description":"Gets a JSON string containing the Azure AD Acl settings."},"googleClientId":{"Type":4,"Flags":0,"Description":"The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecret":{"Type":4,"Flags":0,"Description":"The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"googleClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret associated with \nthe Google web application."},"googleOAuthScopes":{"Type":480,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"},"facebookAppId":{"Type":4,"Flags":0,"Description":"The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecret":{"Type":4,"Flags":0,"Description":"The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"facebookAppSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret used for Facebook Login."},"facebookOAuthScopes":{"Type":481,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"},"gitHubClientId":{"Type":4,"Flags":0,"Description":"The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"},"gitHubClientSecret":{"Type":4,"Flags":0,"Description":"The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."},"gitHubClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the Github\napp used for GitHub Login."},"gitHubOAuthScopes":{"Type":482,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional"},"twitterConsumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecret":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"twitterConsumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."},"microsoftAccountClientId":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecret":{"Type":4,"Flags":0,"Description":"The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"},"microsoftAccountClientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."},"microsoftAccountOAuthScopes":{"Type":483,"Flags":0,"Description":"The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx"},"isAuthFromFile":{"Type":4,"Flags":0,"Description":"\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"},"authFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."},"configVersion":{"Type":4,"Flags":0,"Description":"The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"5":{"Elements":[467,468]}},{"3":{"ItemType":4}},{"6":{"Value":"AzureActiveDirectory"}},{"6":{"Value":"Facebook"}},{"6":{"Value":"Google"}},{"6":{"Value":"MicrosoftAccount"}},{"6":{"Value":"Twitter"}},{"6":{"Value":"Github"}},{"5":{"Elements":[471,472,473,474,475,476]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":484,"Flags":9,"Description":"The resource name"},"type":{"Type":485,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":486,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteAuthSettingsV2Properties","Properties":{"platform":{"Type":489,"Flags":0,"Description":"The configuration settings of the platform of App Service Authentication/Authorization."},"globalValidation":{"Type":490,"Flags":0,"Description":"The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."},"identityProviders":{"Type":497,"Flags":0,"Description":"The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."},"login":{"Type":536,"Flags":0,"Description":"The configuration settings of the login flow of users using App Service Authentication/Authorization."},"httpSettings":{"Type":547,"Flags":0,"Description":"The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."}}}},{"2":{"Name":"AuthPlatform","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."},"configFilePath":{"Type":4,"Flags":0,"Description":"The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."}}}},{"2":{"Name":"GlobalValidation","Properties":{"requireAuthentication":{"Type":2,"Flags":0,"Description":"true if the authentication flow is required any request is made; otherwise, false."},"unauthenticatedClientAction":{"Type":495,"Flags":0,"Description":"The action to take when an unauthenticated client attempts to access the app."},"redirectToProvider":{"Type":4,"Flags":0,"Description":"The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."},"excludedPaths":{"Type":496,"Flags":0,"Description":"The paths for which unauthenticated flow would not be redirected to the login page."}}}},{"6":{"Value":"RedirectToLoginPage"}},{"6":{"Value":"AllowAnonymous"}},{"6":{"Value":"Return401"}},{"6":{"Value":"Return403"}},{"5":{"Elements":[491,492,493,494]}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProviders","Properties":{"azureActiveDirectory":{"Type":498,"Flags":0,"Description":"The configuration settings of the Azure Active directory provider."},"facebook":{"Type":512,"Flags":0,"Description":"The configuration settings of the Facebook provider."},"gitHub":{"Type":516,"Flags":0,"Description":"The configuration settings of the GitHub provider."},"google":{"Type":518,"Flags":0,"Description":"The configuration settings of the Google provider."},"legacyMicrosoftAccount":{"Type":521,"Flags":0,"Description":"The configuration settings of the legacy Microsoft Account provider."},"twitter":{"Type":522,"Flags":0,"Description":"The configuration settings of the Twitter provider."},"apple":{"Type":524,"Flags":0,"Description":"The configuration settings of the Apple provider."},"azureStaticWebApps":{"Type":526,"Flags":0,"Description":"The configuration settings of the Azure Static Web Apps provider."},"customOpenIdConnectProviders":{"Type":535,"Flags":0,"Description":"The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider."}}}},{"2":{"Name":"AzureActiveDirectory","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":499,"Flags":0,"Description":"The configuration settings of the Azure Active Directory app registration."},"login":{"Type":500,"Flags":0,"Description":"The configuration settings of the Azure Active Directory login flow."},"validation":{"Type":502,"Flags":0,"Description":"The configuration settings of the Azure Active Directory token validation flow."},"isAutoProvisioned":{"Type":2,"Flags":0,"Description":"Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."}}}},{"2":{"Name":"AzureActiveDirectoryRegistration","Properties":{"openIdIssuer":{"Type":4,"Flags":0,"Description":"The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"},"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret of the relying party application."},"clientSecretCertificateThumbprint":{"Type":4,"Flags":0,"Description":"An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."},"clientSecretCertificateSubjectAlternativeName":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."},"clientSecretCertificateIssuer":{"Type":4,"Flags":0,"Description":"An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."}}}},{"2":{"Name":"AzureActiveDirectoryLogin","Properties":{"loginParameters":{"Type":501,"Flags":0,"Description":"Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"."},"disableWWWAuthenticate":{"Type":2,"Flags":0,"Description":"true if the www-authenticate provider should be omitted from the request; otherwise, false."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AzureActiveDirectoryValidation","Properties":{"jwtClaimChecks":{"Type":503,"Flags":0,"Description":"The configuration settings of the checks that should be made while validating the JWT Claims."},"allowedAudiences":{"Type":506,"Flags":0,"Description":"The list of audiences that can make successful authentication/authorization requests."},"defaultAuthorizationPolicy":{"Type":507,"Flags":0,"Description":"The configuration settings of the Azure Active Directory default authorization policy."}}}},{"2":{"Name":"JwtClaimChecks","Properties":{"allowedGroups":{"Type":504,"Flags":0,"Description":"The list of the allowed groups."},"allowedClientApplications":{"Type":505,"Flags":0,"Description":"The list of the allowed client applications."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"DefaultAuthorizationPolicy","Properties":{"allowedPrincipals":{"Type":508,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed principals."},"allowedApplications":{"Type":511,"Flags":0,"Description":"The configuration settings of the Azure Active Directory allowed applications."}}}},{"2":{"Name":"AllowedPrincipals","Properties":{"groups":{"Type":509,"Flags":0,"Description":"The list of the allowed groups."},"identities":{"Type":510,"Flags":0,"Description":"The list of the allowed identities."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Facebook","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Facebook provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":513,"Flags":0,"Description":"The configuration settings of the app registration for providers that have app ids and app secrets"},"graphApiVersion":{"Type":4,"Flags":0,"Description":"The version of the Facebook api to be used while logging in."},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppRegistration","Properties":{"appId":{"Type":4,"Flags":0,"Description":"The App ID of the app used for login."},"appSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the app secret."}}}},{"2":{"Name":"LoginScopes","Properties":{"scopes":{"Type":515,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"GitHub","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the GitHub provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":517,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"ClientRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"Google","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Google provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":517,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":519,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"AllowedAudiencesValidation","Properties":{"allowedAudiences":{"Type":520,"Flags":0,"Description":"The configuration settings of the allowed list of audiences from which to validate the JWT token."}}}},{"3":{"ItemType":4}},{"2":{"Name":"LegacyMicrosoftAccount","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":517,"Flags":0,"Description":"The configuration settings of the app registration for providers that have client ids and client secrets"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."},"validation":{"Type":519,"Flags":0,"Description":"The configuration settings of the Allowed Audiences validation flow."}}}},{"2":{"Name":"Twitter","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Twitter provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":523,"Flags":0,"Description":"The configuration settings of the app registration for the Twitter provider."}}}},{"2":{"Name":"TwitterRegistration","Properties":{"consumerKey":{"Type":4,"Flags":0,"Description":"The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"},"consumerSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."}}}},{"2":{"Name":"Apple","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Apple provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":525,"Flags":0,"Description":"The configuration settings of the registration for the Apple provider"},"login":{"Type":514,"Flags":0,"Description":"The configuration settings of the login flow, including the scopes that should be requested."}}}},{"2":{"Name":"AppleRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting name that contains the client secret."}}}},{"2":{"Name":"AzureStaticWebApps","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."},"registration":{"Type":527,"Flags":0,"Description":"The configuration settings of the registration for the Azure Static Web Apps provider"}}}},{"2":{"Name":"AzureStaticWebAppsRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The Client ID of the app used for login."}}}},{"2":{"Name":"CustomOpenIdConnectProvider","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"false if the custom Open ID provider provider should not be enabled; otherwise, true."},"registration":{"Type":529,"Flags":0,"Description":"The configuration settings of the app registration for the custom Open ID Connect provider."},"login":{"Type":533,"Flags":0,"Description":"The configuration settings of the login flow of the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectRegistration","Properties":{"clientId":{"Type":4,"Flags":0,"Description":"The client id of the custom Open ID Connect provider."},"clientCredential":{"Type":530,"Flags":0,"Description":"The authentication client credentials of the custom Open ID Connect provider."},"openIdConnectConfiguration":{"Type":532,"Flags":0,"Description":"The configuration settings of the endpoints used for the custom Open ID Connect provider."}}}},{"2":{"Name":"OpenIdConnectClientCredential","Properties":{"method":{"Type":531,"Flags":0,"Description":"The method that should be used to authenticate the user."},"clientSecretSettingName":{"Type":4,"Flags":0,"Description":"The app setting that contains the client secret for the custom Open ID Connect provider."}}}},{"6":{"Value":"ClientSecretPost"}},{"2":{"Name":"OpenIdConnectConfig","Properties":{"authorizationEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to make an authorization request."},"tokenEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint to be used to request a token."},"issuer":{"Type":4,"Flags":0,"Description":"The endpoint that issues the token."},"certificationUri":{"Type":4,"Flags":0,"Description":"The endpoint that provides the keys necessary to validate the token."},"wellKnownOpenIdConfiguration":{"Type":4,"Flags":0,"Description":"The endpoint that contains all the configuration endpoints for the provider."}}}},{"2":{"Name":"OpenIdConnectLogin","Properties":{"nameClaimType":{"Type":4,"Flags":0,"Description":"The name of the claim that contains the users name."},"scopes":{"Type":534,"Flags":0,"Description":"A list of the scopes that should be requested while authenticating."}}}},{"3":{"ItemType":4}},{"2":{"Name":"IdentityProvidersCustomOpenIdConnectProviders","Properties":{},"AdditionalProperties":528}},{"2":{"Name":"Login","Properties":{"routes":{"Type":537,"Flags":0,"Description":"The routes that specify the endpoints used for login and logout requests."},"tokenStore":{"Type":538,"Flags":0,"Description":"The configuration settings of the token store."},"preserveUrlFragmentsForLogins":{"Type":2,"Flags":0,"Description":"true if the fragments from the request are preserved after the login request is made; otherwise, false."},"allowedExternalRedirectUrls":{"Type":541,"Flags":0,"Description":"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.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed."},"cookieExpiration":{"Type":542,"Flags":0,"Description":"The configuration settings of the session cookie's expiration."},"nonce":{"Type":546,"Flags":0,"Description":"The configuration settings of the nonce used in the login flow."}}}},{"2":{"Name":"LoginRoutes","Properties":{"logoutEndpoint":{"Type":4,"Flags":0,"Description":"The endpoint at which a logout request should be made."}}}},{"2":{"Name":"TokenStore","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false."},"tokenRefreshExtensionHours":{"Type":3,"Flags":0,"Description":"The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."},"fileSystem":{"Type":539,"Flags":0,"Description":"The configuration settings of the storage of the tokens if a file system is used."},"azureBlobStorage":{"Type":540,"Flags":0,"Description":"The configuration settings of the storage of the tokens if blob storage is used."}}}},{"2":{"Name":"FileSystemTokenStore","Properties":{"directory":{"Type":4,"Flags":0,"Description":"The directory in which the tokens will be stored."}}}},{"2":{"Name":"BlobStorageTokenStore","Properties":{"sasUrlSettingName":{"Type":4,"Flags":0,"Description":"The name of the app setting containing the SAS URL of the blob storage containing the tokens."}}}},{"3":{"ItemType":4}},{"2":{"Name":"CookieExpiration","Properties":{"convention":{"Type":545,"Flags":0,"Description":"The convention used when determining the session cookie's expiration."},"timeToExpiration":{"Type":4,"Flags":0,"Description":"The time after the request is made when the session cookie should expire."}}}},{"6":{"Value":"FixedTime"}},{"6":{"Value":"IdentityProviderDerived"}},{"5":{"Elements":[543,544]}},{"2":{"Name":"Nonce","Properties":{"validateNonce":{"Type":2,"Flags":0,"Description":"false if the nonce should not be validated while completing the login flow; otherwise, true."},"nonceExpirationInterval":{"Type":4,"Flags":0,"Description":"The time after the request is made when the nonce should expire."}}}},{"2":{"Name":"HttpSettings","Properties":{"requireHttps":{"Type":2,"Flags":0,"Description":"false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."},"routes":{"Type":548,"Flags":0,"Description":"The configuration settings of the paths HTTP requests."},"forwardProxy":{"Type":549,"Flags":0,"Description":"The configuration settings of a forward proxy used to make the requests."}}}},{"2":{"Name":"HttpSettingsRoutes","Properties":{"apiPrefix":{"Type":4,"Flags":0,"Description":"The prefix that should precede all the authentication/authorization paths."}}}},{"2":{"Name":"ForwardProxy","Properties":{"convention":{"Type":553,"Flags":0,"Description":"The convention used to determine the url of the request made."},"customHostHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the host of the request."},"customProtoHeaderName":{"Type":4,"Flags":0,"Description":"The name of the header containing the scheme of the request."}}}},{"6":{"Value":"NoProxy"}},{"6":{"Value":"Standard"}},{"6":{"Value":"Custom"}},{"5":{"Elements":[550,551,552]}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":554,"Flags":9,"Description":"The resource name"},"type":{"Type":555,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":556,"Flags":10,"Description":"The resource api version"},"properties":{"Type":558,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":420}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":559,"Flags":9,"Description":"The resource name"},"type":{"Type":560,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":561,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"BackupRequestProperties","Properties":{"backupName":{"Type":4,"Flags":0,"Description":"Name of the backup."},"enabled":{"Type":2,"Flags":0,"Description":"True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."},"storageAccountUrl":{"Type":4,"Flags":1,"Description":"SAS URL to the container."},"backupSchedule":{"Type":564,"Flags":0,"Description":"Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy."},"databases":{"Type":574,"Flags":0,"Description":"Databases included in the backup."}}}},{"2":{"Name":"BackupSchedule","Properties":{"frequencyInterval":{"Type":3,"Flags":1,"Description":"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)"},"frequencyUnit":{"Type":567,"Flags":1,"Description":"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)"},"keepAtLeastOneBackup":{"Type":2,"Flags":1,"Description":"True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise."},"retentionPeriodInDays":{"Type":3,"Flags":1,"Description":"After how many days backups should be deleted."},"startTime":{"Type":4,"Flags":0,"Description":"When the schedule should start working."},"lastExecutionTime":{"Type":4,"Flags":2,"Description":"Last time when this schedule was triggered."}}}},{"6":{"Value":"Day"}},{"6":{"Value":"Hour"}},{"5":{"Elements":[565,566]}},{"2":{"Name":"DatabaseBackupSetting","Properties":{"databaseType":{"Type":573,"Flags":1,"Description":"Database type (e.g. SqlAzure / MySql)."},"name":{"Type":4,"Flags":0},"connectionStringName":{"Type":4,"Flags":0,"Description":"Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."},"connectionString":{"Type":4,"Flags":0,"Description":"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."}}}},{"6":{"Value":"SqlAzure"}},{"6":{"Value":"MySql"}},{"6":{"Value":"LocalMySql"}},{"6":{"Value":"PostgreSql"}},{"5":{"Elements":[569,570,571,572,4]}},{"3":{"ItemType":568}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":575,"Flags":9,"Description":"The resource name"},"type":{"Type":576,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":577,"Flags":10,"Description":"The resource api version"},"properties":{"Type":592,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnStringValueTypePair","Properties":{"value":{"Type":4,"Flags":1,"Description":"Value of pair."},"type":{"Type":591,"Flags":1,"Description":"Type of database."}}}},{"6":{"Value":"MySql"}},{"6":{"Value":"SQLServer"}},{"6":{"Value":"SQLAzure"}},{"6":{"Value":"Custom"}},{"6":{"Value":"NotificationHub"}},{"6":{"Value":"ServiceBus"}},{"6":{"Value":"EventHub"}},{"6":{"Value":"ApiHub"}},{"6":{"Value":"DocDb"}},{"6":{"Value":"RedisCache"}},{"6":{"Value":"PostgreSQL"}},{"5":{"Elements":[580,581,582,583,584,585,586,587,588,589,590]}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":579}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":593,"Flags":9,"Description":"The resource name"},"type":{"Type":594,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":595,"Flags":10,"Description":"The resource api version"},"properties":{"Type":597,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteLogsConfigProperties","Properties":{"applicationLogs":{"Type":598,"Flags":0,"Description":"Application logs configuration."},"httpLogs":{"Type":620,"Flags":0,"Description":"Http logs configuration."},"failedRequestsTracing":{"Type":623,"Flags":0,"Description":"Enabled configuration."},"detailedErrorMessages":{"Type":623,"Flags":0,"Description":"Enabled configuration."}}}},{"2":{"Name":"ApplicationLogsConfig","Properties":{"fileSystem":{"Type":599,"Flags":0,"Description":"Application logs to file system configuration."},"azureTableStorage":{"Type":606,"Flags":0,"Description":"Application logs to Azure table storage configuration."},"azureBlobStorage":{"Type":613,"Flags":0,"Description":"Application logs azure blob storage configuration."}}}},{"2":{"Name":"FileSystemApplicationLogsConfig","Properties":{"level":{"Type":605,"Flags":0,"Description":"Log level."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[600,601,602,603,604]}},{"2":{"Name":"AzureTableStorageApplicationLogsConfig","Properties":{"level":{"Type":612,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":1,"Description":"SAS URL to an Azure table with add/query/delete permissions."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[607,608,609,610,611]}},{"2":{"Name":"AzureBlobStorageApplicationLogsConfig","Properties":{"level":{"Type":619,"Flags":0,"Description":"Log level."},"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."}}}},{"6":{"Value":"Off"}},{"6":{"Value":"Verbose"}},{"6":{"Value":"Information"}},{"6":{"Value":"Warning"}},{"6":{"Value":"Error"}},{"5":{"Elements":[614,615,616,617,618]}},{"2":{"Name":"HttpLogsConfig","Properties":{"fileSystem":{"Type":621,"Flags":0,"Description":"Http logs to file system configuration."},"azureBlobStorage":{"Type":622,"Flags":0,"Description":"Http logs to azure blob storage configuration."}}}},{"2":{"Name":"FileSystemHttpLogsConfig","Properties":{"retentionInMb":{"Type":3,"Flags":0,"Description":"Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove files older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"AzureBlobStorageHttpLogsConfig","Properties":{"sasUrl":{"Type":4,"Flags":0,"Description":"SAS url to a azure blob container with read/write/list/delete permissions."},"retentionInDays":{"Type":3,"Flags":0,"Description":"Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."},"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"2":{"Name":"EnabledConfig","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"True if configuration is enabled, false if it is disabled and null if configuration is not set."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":624,"Flags":9,"Description":"The resource name"},"type":{"Type":625,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":626,"Flags":10,"Description":"The resource api version"},"properties":{"Type":628,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":629,"Flags":9,"Description":"The resource name"},"type":{"Type":630,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":631,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"slotConfigNames"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":633,"Flags":9,"Description":"The resource name"},"type":{"Type":634,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":635,"Flags":10,"Description":"The resource api version"},"properties":{"Type":637,"Flags":0,"Description":"Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SlotConfigNames","Properties":{"connectionStringNames":{"Type":638,"Flags":0,"Description":"List of connection string names."},"appSettingNames":{"Type":639,"Flags":0,"Description":"List of application settings names."},"azureStorageConfigNames":{"Type":640,"Flags":0,"Description":"List of external Azure storage account identifiers."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":641,"Flags":9,"Description":"The resource name"},"type":{"Type":642,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":643,"Flags":10,"Description":"The resource api version"},"properties":{"Type":325,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":460,"authsettings":465,"authsettingsV2":487,"azurestorageaccounts":557,"backup":562,"connectionstrings":578,"logs":596,"metadata":627,"pushsettings":632,"slotConfigNames":636,"web":644}}},{"4":{"Name":"Microsoft.Web/sites/config@2021-03-01","ScopeType":8,"Body":645}},{"6":{"Value":"Microsoft.Web/sites/deployments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":647,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":648,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"DeploymentProperties","Properties":{"status":{"Type":3,"Flags":0,"Description":"Deployment status."},"message":{"Type":4,"Flags":0,"Description":"Details about deployment status."},"author":{"Type":4,"Flags":0,"Description":"Who authored the deployment."},"deployer":{"Type":4,"Flags":0,"Description":"Who performed the deployment."},"author_email":{"Type":4,"Flags":0,"Description":"Author email."},"start_time":{"Type":4,"Flags":0,"Description":"Start time."},"end_time":{"Type":4,"Flags":0,"Description":"End time."},"active":{"Type":2,"Flags":0,"Description":"True if deployment is currently active, false if completed and null if not started."},"details":{"Type":4,"Flags":0,"Description":"Details on deployment."}}}},{"4":{"Name":"Microsoft.Web/sites/deployments@2021-03-01","ScopeType":8,"Body":649}},{"6":{"Value":"Microsoft.Web/sites/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":652,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":653,"Flags":10,"Description":"The resource api version"},"properties":{"Type":655,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"IdentifierProperties","Properties":{"id":{"Type":4,"Flags":0,"Description":"String representation of the identity."}}}},{"4":{"Name":"Microsoft.Web/sites/domainOwnershipIdentifiers@2021-03-01","ScopeType":8,"Body":654}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":657,"Flags":9,"Description":"The resource name"},"type":{"Type":658,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":659,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"MSDeployCore","Properties":{"packageUri":{"Type":4,"Flags":4,"Description":"Package URI"},"connectionString":{"Type":4,"Flags":4,"Description":"SQL Connection String"},"dbType":{"Type":4,"Flags":4,"Description":"Database Type"},"setParametersXmlFileUri":{"Type":4,"Flags":4,"Description":"URI of MSDeploy Parameters file. Must not be set if SetParameters is used."},"setParameters":{"Type":662,"Flags":4,"Description":"MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used."},"skipAppData":{"Type":2,"Flags":4,"Description":"Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."},"appOffline":{"Type":2,"Flags":4,"Description":"Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."},"deployer":{"Type":4,"Flags":2,"Description":"Username of deployer"},"provisioningState":{"Type":668,"Flags":2,"Description":"Provisioning state"},"startTime":{"Type":4,"Flags":2,"Description":"Start time of deploy operation"},"endTime":{"Type":4,"Flags":2,"Description":"End time of deploy operation"},"complete":{"Type":2,"Flags":2,"Description":"Whether the deployment operation has completed"}}}},{"2":{"Name":"MSDeployCoreSetParameters","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"accepted"}},{"6":{"Value":"running"}},{"6":{"Value":"succeeded"}},{"6":{"Value":"failed"}},{"6":{"Value":"canceled"}},{"5":{"Elements":[663,664,665,666,667]}},{"6":{"Value":"onedeploy"}},{"6":{"Value":"Microsoft.Web/sites/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":669,"Flags":9,"Description":"The resource name"},"type":{"Type":670,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":671,"Flags":10,"Description":"The resource api version"}}}},{"7":{"Name":"microsoft.web/sites/extensions","Discriminator":"name","BaseProperties":{},"Elements":{"MSDeploy":660,"onedeploy":672}}},{"4":{"Name":"Microsoft.Web/sites/extensions@2021-03-01","ScopeType":8,"Body":673}},{"6":{"Value":"Microsoft.Web/sites/functions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":675,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":676,"Flags":10,"Description":"The resource api version"},"properties":{"Type":678,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"FunctionEnvelopeProperties","Properties":{"function_app_id":{"Type":4,"Flags":0,"Description":"Function App ID."},"script_root_path_href":{"Type":4,"Flags":0,"Description":"Script root path URI."},"script_href":{"Type":4,"Flags":0,"Description":"Script URI."},"config_href":{"Type":4,"Flags":0,"Description":"Config URI."},"test_data_href":{"Type":4,"Flags":0,"Description":"Test data URI."},"secrets_file_href":{"Type":4,"Flags":0,"Description":"Secrets file URI."},"href":{"Type":4,"Flags":0,"Description":"Function URI."},"config":{"Type":0,"Flags":0,"Description":"Any object"},"files":{"Type":679,"Flags":0,"Description":"File list."},"test_data":{"Type":4,"Flags":0,"Description":"Test data used when testing via the Azure Portal."},"invoke_url_template":{"Type":4,"Flags":0,"Description":"The invocation URL"},"language":{"Type":4,"Flags":0,"Description":"The function language"},"isDisabled":{"Type":2,"Flags":0,"Description":"Gets or sets a value indicating whether the function is disabled"}}}},{"2":{"Name":"FunctionEnvelopePropertiesFiles","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/functions@2021-03-01","ScopeType":8,"Body":677}},{"6":{"Value":"Microsoft.Web/sites/functions/keys"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":681,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":682,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/functions/keys@2021-03-01","ScopeType":8,"Body":683}},{"6":{"Value":"Microsoft.Web/sites/hostNameBindings"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":685,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":686,"Flags":10,"Description":"The resource api version"},"properties":{"Type":688,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HostNameBindingProperties","Properties":{"siteName":{"Type":4,"Flags":0,"Description":"App Service app name."},"domainId":{"Type":4,"Flags":0,"Description":"Fully qualified ARM domain resource URI."},"azureResourceName":{"Type":4,"Flags":0,"Description":"Azure resource name."},"azureResourceType":{"Type":691,"Flags":0,"Description":"Azure resource type."},"customHostNameDnsRecordType":{"Type":694,"Flags":0,"Description":"Custom DNS record type."},"hostNameType":{"Type":697,"Flags":0,"Description":"Hostname type."},"sslState":{"Type":701,"Flags":0,"Description":"SSL type"},"thumbprint":{"Type":4,"Flags":0,"Description":"SSL certificate thumbprint"},"virtualIP":{"Type":4,"Flags":2,"Description":"Virtual IP address assigned to the hostname if IP based SSL is enabled."}}}},{"6":{"Value":"Website"}},{"6":{"Value":"TrafficManager"}},{"5":{"Elements":[689,690]}},{"6":{"Value":"CName"}},{"6":{"Value":"A"}},{"5":{"Elements":[692,693]}},{"6":{"Value":"Verified"}},{"6":{"Value":"Managed"}},{"5":{"Elements":[695,696]}},{"6":{"Value":"Disabled"}},{"6":{"Value":"SniEnabled"}},{"6":{"Value":"IpBasedEnabled"}},{"5":{"Elements":[698,699,700]}},{"4":{"Name":"Microsoft.Web/sites/hostNameBindings@2021-03-01","ScopeType":8,"Body":687}},{"6":{"Value":"Microsoft.Web/sites/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":703,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":704,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"HybridConnectionProperties","Properties":{"serviceBusNamespace":{"Type":4,"Flags":0,"Description":"The name of the Service Bus namespace."},"relayName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus relay."},"relayArmUri":{"Type":4,"Flags":0,"Description":"The ARM URI to the Service Bus relay."},"hostname":{"Type":4,"Flags":0,"Description":"The hostname of the endpoint."},"port":{"Type":3,"Flags":0,"Description":"The port of the endpoint."},"sendKeyName":{"Type":4,"Flags":0,"Description":"The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."},"sendKeyValue":{"Type":4,"Flags":0,"Description":"The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."},"serviceBusSuffix":{"Type":4,"Flags":0,"Description":"The suffix for the service bus endpoint. By default this is .servicebus.windows.net"}}}},{"4":{"Name":"Microsoft.Web/sites/hybridConnectionNamespaces/relays@2021-03-01","ScopeType":8,"Body":705}},{"6":{"Value":"Microsoft.Web/sites/hybridconnection"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":708,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":709,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"RelayServiceConnectionEntityProperties","Properties":{"entityName":{"Type":4,"Flags":0},"entityConnectionString":{"Type":4,"Flags":0},"resourceType":{"Type":4,"Flags":0},"resourceConnectionString":{"Type":4,"Flags":0},"hostname":{"Type":4,"Flags":0},"port":{"Type":3,"Flags":0},"biztalkUri":{"Type":4,"Flags":0}}}},{"4":{"Name":"Microsoft.Web/sites/hybridconnection@2021-03-01","ScopeType":8,"Body":710}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/instances/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":713,"Flags":9,"Description":"The resource name"},"type":{"Type":714,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":715,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/instances/extensions@2021-03-01","ScopeType":8,"Body":716}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/networkConfig"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":718,"Flags":9,"Description":"The resource name"},"type":{"Type":719,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":720,"Flags":10,"Description":"The resource api version"},"properties":{"Type":722,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SwiftVirtualNetworkProperties","Properties":{"subnetResourceId":{"Type":4,"Flags":0,"Description":"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."},"swiftSupported":{"Type":2,"Flags":0,"Description":"A flag that specifies if the scale unit this Web App is on supports Swift integration."}}}},{"4":{"Name":"Microsoft.Web/sites/networkConfig@2021-03-01","ScopeType":8,"Body":721}},{"6":{"Value":"Microsoft.Web/sites/premieraddons"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":724,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":725,"Flags":10,"Description":"The resource api version"},"properties":{"Type":727,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":728,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"PremierAddOnProperties","Properties":{"sku":{"Type":4,"Flags":0,"Description":"Premier add on SKU."},"product":{"Type":4,"Flags":0,"Description":"Premier add on Product."},"vendor":{"Type":4,"Flags":0,"Description":"Premier add on Vendor."},"marketplacePublisher":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace publisher."},"marketplaceOffer":{"Type":4,"Flags":0,"Description":"Premier add on Marketplace offer."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/premieraddons@2021-03-01","ScopeType":8,"Body":726}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/privateAccess"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":730,"Flags":9,"Description":"The resource name"},"type":{"Type":731,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":732,"Flags":10,"Description":"The resource api version"},"properties":{"Type":734,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PrivateAccessProperties","Properties":{"enabled":{"Type":2,"Flags":0,"Description":"Whether private access is enabled or not."},"virtualNetworks":{"Type":738,"Flags":0,"Description":"The Virtual Networks (and subnets) allowed to access the site privately."}}}},{"2":{"Name":"PrivateAccessVirtualNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the Virtual Network."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the Virtual Network."},"resourceId":{"Type":4,"Flags":0,"Description":"The ARM uri of the Virtual Network"},"subnets":{"Type":737,"Flags":0,"Description":"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."}}}},{"2":{"Name":"PrivateAccessSubnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"The name of the subnet."},"key":{"Type":3,"Flags":0,"Description":"The key (ID) of the subnet."}}}},{"3":{"ItemType":736}},{"3":{"ItemType":735}},{"4":{"Name":"Microsoft.Web/sites/privateAccess@2021-03-01","ScopeType":8,"Body":733}},{"6":{"Value":"Microsoft.Web/sites/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":740,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":741,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":742}},{"6":{"Value":"Microsoft.Web/sites/publicCertificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":744,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":745,"Flags":10,"Description":"The resource api version"},"properties":{"Type":747,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"PublicCertificateProperties","Properties":{"blob":{"Type":0,"Flags":0,"Description":"Public Certificate byte array"},"publicCertificateLocation":{"Type":751,"Flags":0,"Description":"Public Certificate Location"},"thumbprint":{"Type":4,"Flags":2,"Description":"Certificate Thumbprint"}}}},{"6":{"Value":"CurrentUserMy"}},{"6":{"Value":"LocalMachineMy"}},{"6":{"Value":"Unknown"}},{"5":{"Elements":[748,749,750]}},{"4":{"Name":"Microsoft.Web/sites/publicCertificates@2021-03-01","ScopeType":8,"Body":746}},{"6":{"Value":"Microsoft.Web/sites/siteextensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":753,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":754,"Flags":10,"Description":"The resource api version"},"properties":{"Type":756,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteExtensionInfoProperties","Properties":{"extension_id":{"Type":4,"Flags":2,"Description":"Site extension ID."},"title":{"Type":4,"Flags":2},"extension_type":{"Type":759,"Flags":2,"Description":"Site extension type."},"summary":{"Type":4,"Flags":2,"Description":"Summary description."},"description":{"Type":4,"Flags":2,"Description":"Detailed description."},"version":{"Type":4,"Flags":2,"Description":"Version information."},"extension_url":{"Type":4,"Flags":2,"Description":"Extension URL."},"project_url":{"Type":4,"Flags":2,"Description":"Project URL."},"icon_url":{"Type":4,"Flags":2,"Description":"Icon URL."},"license_url":{"Type":4,"Flags":2,"Description":"License URL."},"feed_url":{"Type":4,"Flags":2,"Description":"Feed URL."},"authors":{"Type":760,"Flags":2,"Description":"List of authors."},"installer_command_line_params":{"Type":4,"Flags":2,"Description":"Installer command line parameters."},"published_date_time":{"Type":4,"Flags":2,"Description":"Published timestamp."},"download_count":{"Type":3,"Flags":2,"Description":"Count of downloads."},"local_is_latest_version":{"Type":2,"Flags":2,"Description":"true if the local version is the latest version; false otherwise."},"local_path":{"Type":4,"Flags":2,"Description":"Local path."},"installed_date_time":{"Type":4,"Flags":2,"Description":"Installed timestamp."},"provisioningState":{"Type":4,"Flags":2,"Description":"Provisioning state."},"comment":{"Type":4,"Flags":2,"Description":"Site Extension comment."}}}},{"6":{"Value":"Gallery"}},{"6":{"Value":"WebRoot"}},{"5":{"Elements":[757,758]}},{"3":{"ItemType":4}},{"4":{"Name":"Microsoft.Web/sites/siteextensions@2021-03-01","ScopeType":8,"Body":755}},{"6":{"Value":"Microsoft.Web/sites/slots"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":762,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":763,"Flags":10,"Description":"The resource api version"},"properties":{"Type":306,"Flags":0,"Description":"Site resource specific properties"},"identity":{"Type":230,"Flags":0,"Description":"Managed service identity."},"extendedLocation":{"Type":88,"Flags":0,"Description":"Extended Location."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":765,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots@2021-03-01","ScopeType":8,"Body":764}},{"6":{"Value":"ftp"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":767,"Flags":9,"Description":"The resource name"},"type":{"Type":768,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":769,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"scm"}},{"6":{"Value":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":771,"Flags":9,"Description":"The resource name"},"type":{"Type":772,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":773,"Flags":10,"Description":"The resource api version"},"properties":{"Type":450,"Flags":0,"Description":"CsmPublishingCredentialsPoliciesEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/basicpublishingcredentialspolicies","Discriminator":"name","BaseProperties":{},"Elements":{"ftp":770,"scm":774}}},{"4":{"Name":"Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies@2021-03-01","ScopeType":8,"Body":775}},{"6":{"Value":"appsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":777,"Flags":9,"Description":"The resource name"},"type":{"Type":778,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":779,"Flags":10,"Description":"The resource api version"},"properties":{"Type":781,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"authsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":782,"Flags":9,"Description":"The resource name"},"type":{"Type":783,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":784,"Flags":10,"Description":"The resource api version"},"properties":{"Type":466,"Flags":0,"Description":"SiteAuthSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"authsettingsV2"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":786,"Flags":9,"Description":"The resource name"},"type":{"Type":787,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":788,"Flags":10,"Description":"The resource api version"},"properties":{"Type":488,"Flags":0,"Description":"SiteAuthSettingsV2 resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"azurestorageaccounts"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":790,"Flags":9,"Description":"The resource name"},"type":{"Type":791,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":792,"Flags":10,"Description":"The resource api version"},"properties":{"Type":794,"Flags":0,"Description":"Azure storage accounts."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"AzureStoragePropertyDictionaryResourceProperties","Properties":{},"AdditionalProperties":420}},{"6":{"Value":"backup"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":795,"Flags":9,"Description":"The resource name"},"type":{"Type":796,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":797,"Flags":10,"Description":"The resource api version"},"properties":{"Type":563,"Flags":0,"Description":"BackupRequest resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"connectionstrings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":799,"Flags":9,"Description":"The resource name"},"type":{"Type":800,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":801,"Flags":10,"Description":"The resource api version"},"properties":{"Type":803,"Flags":0,"Description":"Connection strings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"ConnectionStringDictionaryProperties","Properties":{},"AdditionalProperties":579}},{"6":{"Value":"logs"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":804,"Flags":9,"Description":"The resource name"},"type":{"Type":805,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":806,"Flags":10,"Description":"The resource api version"},"properties":{"Type":597,"Flags":0,"Description":"SiteLogsConfig resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"metadata"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":808,"Flags":9,"Description":"The resource name"},"type":{"Type":809,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":810,"Flags":10,"Description":"The resource api version"},"properties":{"Type":812,"Flags":0,"Description":"Settings."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"6":{"Value":"pushsettings"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":813,"Flags":9,"Description":"The resource name"},"type":{"Type":814,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":815,"Flags":10,"Description":"The resource api version"},"properties":{"Type":396,"Flags":0,"Description":"PushSettings resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/config"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/config","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":817,"Flags":9,"Description":"The resource name"},"type":{"Type":818,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":819,"Flags":10,"Description":"The resource api version"},"properties":{"Type":325,"Flags":0,"Description":"Configuration of an App Service app."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"7":{"Name":"microsoft.web/sites/slots/config","Discriminator":"name","BaseProperties":{},"Elements":{"appsettings":780,"authsettings":785,"authsettingsV2":789,"azurestorageaccounts":793,"backup":798,"connectionstrings":802,"logs":807,"metadata":811,"pushsettings":816,"web":820}}},{"4":{"Name":"Microsoft.Web/sites/slots/config@2021-03-01","ScopeType":8,"Body":821}},{"6":{"Value":"Microsoft.Web/sites/slots/deployments"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/deployments","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":823,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":824,"Flags":10,"Description":"The resource api version"},"properties":{"Type":650,"Flags":0,"Description":"Deployment resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/deployments@2021-03-01","ScopeType":8,"Body":825}},{"6":{"Value":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":827,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":828,"Flags":10,"Description":"The resource api version"},"properties":{"Type":655,"Flags":0,"Description":"Identifier resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/domainOwnershipIdentifiers@2021-03-01","ScopeType":8,"Body":829}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":831,"Flags":9,"Description":"The resource name"},"type":{"Type":832,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":833,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/extensions@2021-03-01","ScopeType":8,"Body":834}},{"6":{"Value":"Microsoft.Web/sites/slots/functions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":836,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":837,"Flags":10,"Description":"The resource api version"},"properties":{"Type":678,"Flags":0,"Description":"FunctionEnvelope resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions@2021-03-01","ScopeType":8,"Body":838}},{"6":{"Value":"Microsoft.Web/sites/slots/functions/keys"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/functions/keys","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":840,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":841,"Flags":10,"Description":"The resource api version"},"value":{"Type":4,"Flags":0,"Description":"Key value"}}}},{"4":{"Name":"Microsoft.Web/sites/slots/functions/keys@2021-03-01","ScopeType":8,"Body":842}},{"6":{"Value":"Microsoft.Web/sites/slots/hostNameBindings"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hostNameBindings","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":844,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":845,"Flags":10,"Description":"The resource api version"},"properties":{"Type":688,"Flags":0,"Description":"HostNameBinding resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hostNameBindings@2021-03-01","ScopeType":8,"Body":846}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":848,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":849,"Flags":10,"Description":"The resource api version"},"properties":{"Type":706,"Flags":0,"Description":"HybridConnection resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays@2021-03-01","ScopeType":8,"Body":850}},{"6":{"Value":"Microsoft.Web/sites/slots/hybridconnection"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/hybridconnection","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":852,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":853,"Flags":10,"Description":"The resource api version"},"properties":{"Type":711,"Flags":0,"Description":"RelayServiceConnectionEntity resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/hybridconnection@2021-03-01","ScopeType":8,"Body":854}},{"6":{"Value":"MSDeploy"}},{"6":{"Value":"Microsoft.Web/sites/slots/instances/extensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/instances/extensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":856,"Flags":9,"Description":"The resource name"},"type":{"Type":857,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":858,"Flags":10,"Description":"The resource api version"},"properties":{"Type":661,"Flags":0,"Description":"MSDeploy ARM PUT core information"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/instances/extensions@2021-03-01","ScopeType":8,"Body":859}},{"6":{"Value":"virtualNetwork"}},{"6":{"Value":"Microsoft.Web/sites/slots/networkConfig"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/networkConfig","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":861,"Flags":9,"Description":"The resource name"},"type":{"Type":862,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":863,"Flags":10,"Description":"The resource api version"},"properties":{"Type":722,"Flags":0,"Description":"SwiftVirtualNetwork resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/networkConfig@2021-03-01","ScopeType":8,"Body":864}},{"6":{"Value":"Microsoft.Web/sites/slots/premieraddons"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/premieraddons","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":866,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":867,"Flags":10,"Description":"The resource api version"},"properties":{"Type":727,"Flags":0,"Description":"PremierAddOn resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"location":{"Type":4,"Flags":1,"Description":"Resource Location."},"tags":{"Type":869,"Flags":0,"Description":"Resource tags."}}}},{"2":{"Name":"ResourceTags","Properties":{},"AdditionalProperties":4}},{"4":{"Name":"Microsoft.Web/sites/slots/premieraddons@2021-03-01","ScopeType":8,"Body":868}},{"6":{"Value":"virtualNetworks"}},{"6":{"Value":"Microsoft.Web/sites/slots/privateAccess"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateAccess","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":871,"Flags":9,"Description":"The resource name"},"type":{"Type":872,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":873,"Flags":10,"Description":"The resource api version"},"properties":{"Type":734,"Flags":0,"Description":"PrivateAccess resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateAccess@2021-03-01","ScopeType":8,"Body":874}},{"6":{"Value":"Microsoft.Web/sites/slots/privateEndpointConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":876,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":877,"Flags":10,"Description":"The resource api version"},"properties":{"Type":63,"Flags":0,"Description":"A request to approve or reject a private endpoint connection"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/privateEndpointConnections@2021-03-01","ScopeType":8,"Body":878}},{"6":{"Value":"Microsoft.Web/sites/slots/publicCertificates"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/publicCertificates","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":880,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":881,"Flags":10,"Description":"The resource api version"},"properties":{"Type":747,"Flags":0,"Description":"PublicCertificate resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/publicCertificates@2021-03-01","ScopeType":8,"Body":882}},{"6":{"Value":"Microsoft.Web/sites/slots/siteextensions"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/siteextensions","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":884,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":885,"Flags":10,"Description":"The resource api version"},"properties":{"Type":756,"Flags":2,"Description":"SiteExtensionInfo resource specific properties"},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/siteextensions@2021-03-01","ScopeType":8,"Body":886}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/slots/sourcecontrols"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":888,"Flags":9,"Description":"The resource name"},"type":{"Type":889,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":890,"Flags":10,"Description":"The resource api version"},"properties":{"Type":892,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"SiteSourceControlProperties","Properties":{"repoUrl":{"Type":4,"Flags":0,"Description":"Repository or source control URL."},"branch":{"Type":4,"Flags":0,"Description":"Name of branch to use for deployment."},"isManualIntegration":{"Type":2,"Flags":0,"Description":"true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub)."},"isGitHubAction":{"Type":2,"Flags":0,"Description":"true if this is deployed via GitHub action."},"deploymentRollbackEnabled":{"Type":2,"Flags":0,"Description":"true to enable deployment rollback; otherwise, false."},"isMercurial":{"Type":2,"Flags":0,"Description":"true for a Mercurial repository; false for a Git repository."},"gitHubActionConfiguration":{"Type":893,"Flags":0,"Description":"The GitHub action configuration."}}}},{"2":{"Name":"GitHubActionConfiguration","Properties":{"codeConfiguration":{"Type":894,"Flags":0,"Description":"The GitHub action code configuration."},"containerConfiguration":{"Type":895,"Flags":0,"Description":"The GitHub action container configuration."},"isLinux":{"Type":2,"Flags":0,"Description":"This will help determine the workflow configuration to select."},"generateWorkflowFile":{"Type":2,"Flags":0,"Description":"Workflow option to determine whether the workflow file should be generated and written to the repository."}}}},{"2":{"Name":"GitHubActionCodeConfiguration","Properties":{"runtimeStack":{"Type":4,"Flags":0,"Description":"Runtime stack is used to determine the workflow file content for code base apps."},"runtimeVersion":{"Type":4,"Flags":0,"Description":"Runtime version is used to determine what build version to set in the workflow file."}}}},{"2":{"Name":"GitHubActionContainerConfiguration","Properties":{"serverUrl":{"Type":4,"Flags":0,"Description":"The server URL for the container registry where the build will be hosted."},"imageName":{"Type":4,"Flags":0,"Description":"The image name for the build."},"username":{"Type":4,"Flags":0,"Description":"The username used to upload the image to the container registry."},"password":{"Type":4,"Flags":0,"Description":"The password used to upload the image to the container registry."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/sourcecontrols@2021-03-01","ScopeType":8,"Body":891}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":897,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":898,"Flags":10,"Description":"The resource api version"},"properties":{"Type":900,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"2":{"Name":"VnetInfo","Properties":{"vnetResourceId":{"Type":4,"Flags":0,"Description":"The Virtual Network's resource ID."},"certThumbprint":{"Type":4,"Flags":2,"Description":"The client certificate thumbprint."},"certBlob":{"Type":4,"Flags":0,"Description":"A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection."},"routes":{"Type":902,"Flags":2,"Description":"The routes that this Virtual Network connection uses."},"resyncRequired":{"Type":2,"Flags":2,"Description":"true if a resync is required; otherwise, false."},"dnsServers":{"Type":4,"Flags":0,"Description":"DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."},"isSwift":{"Type":2,"Flags":0,"Description":"Flag that is used to denote if this is VNET injection"}}}},{"2":{"Name":"VnetRoute","Properties":{"properties":{"Type":99,"Flags":0,"Description":"VnetRoute resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":901}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections@2021-03-01","ScopeType":8,"Body":899}},{"6":{"Value":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":904,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":905,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/slots/virtualNetworkConnections/gateways@2021-03-01","ScopeType":8,"Body":906}},{"6":{"Value":"web"}},{"6":{"Value":"Microsoft.Web/sites/sourcecontrols"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/sourcecontrols","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":908,"Flags":9,"Description":"The resource name"},"type":{"Type":909,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":910,"Flags":10,"Description":"The resource api version"},"properties":{"Type":892,"Flags":0,"Description":"SiteSourceControl resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/sourcecontrols@2021-03-01","ScopeType":8,"Body":911}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":913,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":914,"Flags":10,"Description":"The resource api version"},"properties":{"Type":900,"Flags":0,"Description":"Virtual Network information contract."},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections@2021-03-01","ScopeType":8,"Body":915}},{"6":{"Value":"Microsoft.Web/sites/virtualNetworkConnections/gateways"}},{"6":{"Value":"2021-03-01"}},{"2":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways","Properties":{"id":{"Type":4,"Flags":10,"Description":"The resource id"},"name":{"Type":4,"Flags":9,"Description":"The resource name"},"type":{"Type":917,"Flags":10,"Description":"The resource type"},"apiVersion":{"Type":918,"Flags":10,"Description":"The resource api version"},"properties":{"Type":94,"Flags":0,"Description":"VnetGateway resource specific properties"},"kind":{"Type":4,"Flags":0,"Description":"Kind of resource."}}}},{"4":{"Name":"Microsoft.Web/sites/virtualNetworkConnections/gateways@2021-03-01","ScopeType":8,"Body":919}},{"2":{"Name":"HybridConnectionKey","Properties":{"properties":{"Type":922,"Flags":2,"Description":"HybridConnectionKey resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"HybridConnectionKeyProperties","Properties":{"sendKeyName":{"Type":4,"Flags":2,"Description":"The name of the send key."},"sendKeyValue":{"Type":4,"Flags":2,"Description":"The value of the send key."}}}},{"8":{"Name":"listKeys","ResourceType":"Microsoft.Web/serverfarms/hybridConnectionNamespaces/relays","ApiVersion":"2021-03-01","Output":921}},{"2":{"Name":"SecretsCollection","Properties":{"value":{"Type":926,"Flags":2,"Description":"Collection of resources."}}}},{"2":{"Name":"ContainerAppSecret","Properties":{"name":{"Type":4,"Flags":2,"Description":"Secret Name."},"value":{"Type":4,"Flags":2,"Description":"Secret Value."}}}},{"3":{"ItemType":925}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/containerApps","ApiVersion":"2021-03-01","Output":924}},{"2":{"Name":"StaticSiteUserCollection","Properties":{"value":{"Type":931,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"2":{"Name":"StaticSiteUserARMResource","Properties":{"properties":{"Type":930,"Flags":2,"Description":"StaticSiteUserARMResource resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StaticSiteUserARMResourceProperties","Properties":{"provider":{"Type":4,"Flags":2,"Description":"The identity provider for the static site user."},"userId":{"Type":4,"Flags":2,"Description":"The user id for the static site user."},"displayName":{"Type":4,"Flags":2,"Description":"The display name for the static site user."},"roles":{"Type":4,"Flags":2,"Description":"The roles for the static site user, in free-form string format"}}}},{"3":{"ItemType":929}},{"8":{"Name":"listUsers","ResourceType":"Microsoft.Web/staticSites/authproviders","ApiVersion":"2021-03-01","Output":928}},{"2":{"Name":"StringDictionary","Properties":{"properties":{"Type":934,"Flags":2,"Description":"Settings."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"StringDictionaryProperties","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites/builds","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":933}},{"2":{"Name":"StringList","Properties":{"properties":{"Type":939,"Flags":2,"Description":"List of string resources."},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"3":{"ItemType":4}},{"8":{"Name":"listConfiguredRoles","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":938}},{"8":{"Name":"listFunctionAppSettings","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listSecrets","ResourceType":"Microsoft.Web/staticSites","ApiVersion":"2021-03-01","Output":933}},{"2":{"Name":"BackupRequest","Properties":{"properties":{"Type":563,"Flags":4,"Description":"BackupRequest resource specific properties"},"id":{"Type":4,"Flags":6,"Description":"Resource Id."},"name":{"Type":4,"Flags":6,"Description":"Resource Name."},"kind":{"Type":4,"Flags":4,"Description":"Kind of resource."},"type":{"Type":4,"Flags":6,"Description":"Resource type."}}}},{"2":{"Name":"BackupItem","Properties":{"properties":{"Type":945,"Flags":2,"Description":"BackupItem resource specific properties"},"id":{"Type":4,"Flags":2,"Description":"Resource Id."},"name":{"Type":4,"Flags":2,"Description":"Resource Name."},"kind":{"Type":4,"Flags":2,"Description":"Kind of resource."},"type":{"Type":4,"Flags":2,"Description":"Resource type."}}}},{"2":{"Name":"BackupItemProperties","Properties":{"id":{"Type":3,"Flags":2,"Description":"Id of the backup."},"storageAccountUrl":{"Type":4,"Flags":2,"Description":"SAS URL for the storage account container which contains this backup."},"blobName":{"Type":4,"Flags":2,"Description":"Name of the blob which contains data for this backup."},"name":{"Type":4,"Flags":2,"Description":"Name of this backup."},"status":{"Type":956,"Flags":2,"Description":"Backup status."},"sizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the backup in bytes."},"created":{"Type":4,"Flags":2,"Description":"Timestamp of the backup creation."},"log":{"Type":4,"Flags":2,"Description":"Details regarding this backup. Might contain an error message."},"databases":{"Type":957,"Flags":2,"Description":"List of databases included in the backup."},"scheduled":{"Type":2,"Flags":2,"Description":"True if this backup has been created due to a schedule being triggered."},"lastRestoreTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp of a last restore operation which used this backup."},"finishedTimeStamp":{"Type":4,"Flags":2,"Description":"Timestamp when this backup finished."},"correlationId":{"Type":4,"Flags":2,"Description":"Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support."},"websiteSizeInBytes":{"Type":3,"Flags":2,"Description":"Size of the original web app which has been backed up."}}}},{"6":{"Value":"InProgress"}},{"6":{"Value":"Failed"}},{"6":{"Value":"Succeeded"}},{"6":{"Value":"TimedOut"}},{"6":{"Value":"Created"}},{"6":{"Value":"Skipped"}},{"6":{"Value":"PartiallySucceeded"}},{"6":{"Value":"DeleteInProgress"}},{"6":{"Value":"DeleteFailed"}},{"6":{"Value":"Deleted"}},{"5":{"Elements":[946,947,948,949,950,951,952,953,954,955]}},{"3":{"ItemType":568}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/backups","ApiVersion":"2021-03-01","Output":944,"Input":943}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/config","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-03-01","Output":933}},{"2":{"Name":"FunctionSecrets","Properties":{"key":{"Type":4,"Flags":2,"Description":"Secret key."},"trigger_url":{"Type":4,"Flags":2,"Description":"Trigger URL."}}}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/functions","ApiVersion":"2021-03-01","Output":961}},{"2":{"Name":"HostKeys","Properties":{"masterKey":{"Type":4,"Flags":2,"Description":"Secret key."},"functionKeys":{"Type":964,"Flags":2,"Description":"Host level function keys."},"systemKeys":{"Type":965,"Flags":2,"Description":"System keys."}}}},{"2":{"Name":"HostKeysFunctionKeys","Properties":{},"AdditionalProperties":4}},{"2":{"Name":"HostKeysSystemKeys","Properties":{},"AdditionalProperties":4}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/host","ApiVersion":"2021-03-01","Output":963}},{"2":{"Name":"BackupItemCollection","Properties":{"value":{"Type":968,"Flags":2,"Description":"Collection of resources."},"nextLink":{"Type":4,"Flags":2,"Description":"Link to next page of resources."}}}},{"3":{"ItemType":944}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-03-01","Output":967}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites","ApiVersion":"2021-03-01","Output":961}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/backups","ApiVersion":"2021-03-01","Output":944,"Input":943}},{"8":{"Name":"list","ResourceType":"Microsoft.Web/sites/slots/config","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-03-01","Output":933}},{"8":{"Name":"listsecrets","ResourceType":"Microsoft.Web/sites/slots/functions","ApiVersion":"2021-03-01","Output":961}},{"8":{"Name":"listkeys","ResourceType":"Microsoft.Web/sites/slots/host","ApiVersion":"2021-03-01","Output":963}},{"8":{"Name":"listbackups","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-03-01","Output":967}},{"8":{"Name":"listsyncfunctiontriggerstatus","ResourceType":"Microsoft.Web/sites/slots","ApiVersion":"2021-03-01","Output":961}}] \ No newline at end of file diff --git a/generated/web/microsoft.web/2021-03-01/types.md b/generated/web/microsoft.web/2021-03-01/types.md index 68a7183233..63cd371567 100644 --- a/generated/web/microsoft.web/2021-03-01/types.md +++ b/generated/web/microsoft.web/2021-03-01/types.md @@ -1017,183 +1017,49 @@ This is valid for all deployment slots in an app. * **ApiVersion**: 2021-03-01 * **Output**: [StaticSiteUserCollection](#staticsiteusercollection) -## CertificateProperties -### Properties -* **canonicalName**: string: CNAME of the certificate to be issued via free certificate -* **cerBlob**: any (ReadOnly): Raw bytes of .cer file -* **domainValidationMethod**: string: Method of domain validation for free cert -* **expirationDate**: string (ReadOnly): Certificate expiration date. -* **friendlyName**: string (ReadOnly): Friendly name of the certificate. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[]: Host names the certificate applies to. -* **issueDate**: string (ReadOnly): Certificate issue Date. -* **issuer**: string (ReadOnly): Certificate issuer. -* **keyVaultId**: string: Key Vault Csm resource Id. -* **keyVaultSecretName**: string: Key Vault secret name. -* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. -* **password**: string (WriteOnly): Certificate password. -* **pfxBlob**: any: Pfx blob. -* **publicKeyHash**: string (ReadOnly): Public key hash. -* **selfLink**: string (ReadOnly): Self link. -* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteName**: string (ReadOnly): App name. -* **subjectName**: string (ReadOnly): Subject name of the certificate. -* **thumbprint**: string (ReadOnly): Certificate thumbprint. -* **valid**: bool (ReadOnly): Is the certificate valid?. - -## HostingEnvironmentProfile -### Properties -* **id**: string: Resource ID of the App Service Environment. -* **name**: string (ReadOnly): Name of the App Service Environment. -* **type**: string (ReadOnly): Resource type of the App Service Environment. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## ContainerAppProperties -### Properties -* **configuration**: [Configuration](#configuration): Non versioned Container App configuration properties that define the mutable settings of a Container app -* **kubeEnvironmentId**: string: Resource ID of the Container App's KubeEnvironment. -* **latestRevisionFqdn**: string (ReadOnly): Fully Qualified Domain Name of the latest revision of the Container App. -* **latestRevisionName**: string (ReadOnly): Name of the latest revision of the Container App. -* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' (ReadOnly): Provisioning state of the Container App. -* **template**: [Template](#template): Container App versioned application definition. -Defines the desired state of an immutable revision. -Any changes to this section Will result in a new revision being created - -## Configuration -### Properties -* **activeRevisionsMode**: 'multiple' | 'single': ActiveRevisionsMode controls how active revisions are handled for the Container app: -Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode -* **ingress**: [Ingress](#ingress): Container App Ingress configuration. -* **registries**: [RegistryCredentials](#registrycredentials)[]: Collection of private container registry credentials for containers used by the Container app -* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Container app - -## Ingress -### Properties -* **allowInsecure**: bool: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections -* **external**: bool: Bool indicating if app exposes an external http endpoint -* **fqdn**: string (ReadOnly): Hostname. -* **targetPort**: int: Target Port in containers for traffic from ingress -* **traffic**: [TrafficWeight](#trafficweight)[]: Array of TrafficWeight -* **transport**: 'auto' | 'http' | 'http2': Ingress transport protocol - -## TrafficWeight -### Properties -* **latestRevision**: bool: Indicates that the traffic weight belongs to a latest stable revision -* **revisionName**: string: Name of a revision -* **weight**: int: Traffic weight assigned to a revision - -## RegistryCredentials -### Properties -* **passwordSecretRef**: string: The name of the Secret that contains the registry login password -* **server**: string: Container Registry Server -* **username**: string: Container Registry Username - -## Secret -### Properties -* **name**: string: Secret Name. -* **value**: string (WriteOnly): Secret Value. - -## Template -### Properties -* **containers**: [Container](#container)[]: List of container definitions for the Container App. -* **dapr**: [Dapr](#dapr): Container App Dapr configuration. -* **revisionSuffix**: string: User friendly suffix that is appended to the revision name -* **scale**: [Scale](#scale): Container App scaling configurations. - -## Container -### Properties -* **args**: string[]: Container start command arguments. -* **command**: string[]: Container start command. -* **env**: [EnvironmentVar](#environmentvar)[]: Container environment variables. -* **image**: string: Container image tag. -* **name**: string: Custom container name. -* **resources**: [ContainerResources](#containerresources): Container App container resource requirements. - -## EnvironmentVar -### Properties -* **name**: string: Environment variable name. -* **secretRef**: string: Name of the Container App secret from which to pull the environment variable value. -* **value**: string: Non-secret environment variable value. - -## ContainerResources -### Properties -* **cpu**: int: Required CPU in cores, e.g. 0.5 -* **memory**: string: Required memory, e.g. "250Mb" - -## Dapr -### Properties -* **appId**: string: Dapr application identifier -* **appPort**: int: Port on which the Dapr side car -* **components**: [DaprComponent](#daprcomponent)[]: Collection of Dapr components -* **enabled**: bool: Boolean indicating if the Dapr side car is enabled - -## DaprComponent -### Properties -* **metadata**: [DaprMetadata](#daprmetadata)[]: Component metadata -* **name**: string: Component name -* **type**: string: Component type -* **version**: string: Component version - -## DaprMetadata -### Properties -* **name**: string: Metadata property name. -* **secretRef**: string: Name of the Container App secret from which to pull the metadata property value. -* **value**: string: Metadata property value. - -## Scale +## AllowedAudiencesValidation ### Properties -* **maxReplicas**: int: Optional. Maximum number of container replicas. Defaults to 10 if not set. -* **minReplicas**: int: Optional. Minimum number of container replicas. -* **rules**: [ScaleRule](#scalerule)[]: Scaling rules. +* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. -## ScaleRule +## AllowedPrincipals ### Properties -* **azureQueue**: [QueueScaleRule](#queuescalerule): Container App container Azure Queue based scaling rule. -* **custom**: [CustomScaleRule](#customscalerule): Container App container Custom scaling rule. -* **http**: [HttpScaleRule](#httpscalerule): Container App container Custom scaling rule. -* **name**: string: Scale Rule Name +* **groups**: string[]: The list of the allowed groups. +* **identities**: string[]: The list of the allowed identities. -## QueueScaleRule +## ApiDefinitionInfo ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the queue scale rule. -* **queueLength**: int: Queue length. -* **queueName**: string: Queue name. +* **url**: string: The URL of the API definition. -## ScaleRuleAuth +## ApiManagementConfig ### Properties -* **secretRef**: string: Name of the Container App secret from which to pull the auth params. -* **triggerParameter**: string: Trigger Parameter that uses the secret +* **id**: string: APIM-Api Identifier. -## CustomScaleRule +## Apple ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. -* **metadata**: [CustomScaleRuleMetadata](#customscalerulemetadata): Metadata properties to describe custom scale rule. -* **type**: string: Type of the custom scale rule -eg: azure-servicebus, redis etc. +* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider -## CustomScaleRuleMetadata +## AppleRegistration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. -## HttpScaleRule +## ApplicationLogsConfig ### Properties -* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. -* **metadata**: [HttpScaleRuleMetadata](#httpscalerulemetadata): Metadata properties to describe http scale rule. +* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. +* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. +* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. -## HttpScaleRuleMetadata +## AppLogsConfiguration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **destination**: string +* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) -## ResourceTags +## AppRegistration ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **appId**: string: The App ID of the app used for login. +* **appSecretSettingName**: string: The app setting name that contains the app secret. ## AppServiceEnvironment ### Properties @@ -1202,7 +1068,7 @@ eg: azure-servicebus, redis etc. * **dnsSuffix**: string: DNS suffix of the App Service Environment. * **frontEndScaleFactor**: int: Scale factor for front-ends. * **hasLinuxWorkers**: bool (ReadOnly): Flag that displays whether an ASE has linux workers or not -* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing': Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. +* **internalLoadBalancingMode**: 'None' | 'Publishing' | 'Web' | 'Web, Publishing' | string: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. * **ipsslAddressCount**: int: Number of IP SSL addresses reserved for the App Service Environment. * **maximumNumberOfMachines**: int (ReadOnly): Maximum number of VMs in the App Service Environment. * **multiRoleCount**: int (ReadOnly): Number of front-end instances. @@ -1215,22 +1081,54 @@ eg: azure-servicebus, redis etc. * **virtualNetwork**: [VirtualNetworkProfile](#virtualnetworkprofile) (Required): Specification for using a Virtual Network. * **zoneRedundant**: bool: Whether or not this App Service Environment is zone-redundant. -## NameValuePair +## AppServicePlanProperties ### Properties -* **name**: string: Pair name. -* **value**: string: Pair value. +* **elasticScaleEnabled**: bool: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku +* **freeOfferExpirationTime**: string: The time when the server farm free offer expires. +* **geoRegion**: string (ReadOnly): Geographical location for the App Service plan. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hyperV**: bool: If Hyper-V container app service plan true, false otherwise. +* **isSpot**: bool: If true, this App Service Plan owns spot instances. +* **isXenon**: bool: Obsolete: If Hyper-V container app service plan true, false otherwise. +* **kubeEnvironmentProfile**: [KubeEnvironmentProfile](#kubeenvironmentprofile): Specification for a Kubernetes Environment to use for this resource. +* **maximumElasticWorkerCount**: int: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan +* **maximumNumberOfWorkers**: int (ReadOnly): Maximum number of instances that can be assigned to this App Service plan. +* **numberOfSites**: int (ReadOnly): Number of apps assigned to this App Service plan. +* **perSiteScaling**: bool: 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. +* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' (ReadOnly): Provisioning state of the App Service Plan. +* **reserved**: bool: If Linux app service plan true, false otherwise. +* **resourceGroup**: string (ReadOnly): Resource group of the App Service plan. +* **spotExpirationTime**: string: The time when the server farm expires. Valid only if it is a spot server farm. +* **status**: 'Creating' | 'Pending' | 'Ready' (ReadOnly): App Service plan status. +* **subscription**: string (ReadOnly): App Service plan subscription. +* **targetWorkerCount**: int: Scaling worker count. +* **targetWorkerSizeId**: int: Scaling worker size ID. +* **workerTierName**: string: Target worker tier assigned to the App Service plan. +* **zoneRedundant**: bool: If true, this App Service Plan will perform availability zone balancing. +If false, this App Service Plan will not perform availability zone balancing. -## VirtualNetworkProfile +## ArcConfiguration ### Properties -* **id**: string (Required): Resource id of the Virtual Network. -* **name**: string (ReadOnly): Name of the Virtual Network (read-only). -* **subnet**: string: Subnet within the Virtual Network. -* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). +* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' +* **artifactStorageAccessMode**: string +* **artifactStorageClassName**: string +* **artifactStorageMountPath**: string +* **artifactStorageNodeName**: string +* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) +* **kubeConfig**: string (WriteOnly) -## ResourceTags +## ArmIdWrapper ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly) + +## ArmPlan +### Properties +* **name**: string: The name. +* **product**: string: The product. +* **promotionCode**: string: The promotion code. +* **publisher**: string: The publisher. +* **version**: string: Version of product. ## AseV3NetworkingConfigurationProperties ### Properties @@ -1240,242 +1138,244 @@ eg: azure-servicebus, redis etc. * **linuxOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesLinuxOutboundIpAddressesItem * **windowsOutboundIpAddresses**: string[] (ReadOnly): Array of AseV3NetworkingConfigurationPropertiesWindowsOutboundIpAddressesItem -## WorkerPool +## AuthPlatform ### Properties -* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. -* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). -* **workerCount**: int: Number of instances in the worker pool. -* **workerSize**: string: VM size of the worker pool instances. -* **workerSizeId**: int: Worker size ID for referencing this worker pool. +* **configFilePath**: string: 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. +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **runtimeVersion**: 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. -## SkuDescription +## AutoHealActions ### Properties -* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? -* **capacity**: int: Current number of instances assigned to the resource. -* **family**: string: Family code of the resource SKU. -* **locations**: string[]: Locations of the SKU. -* **name**: string: Name of the resource SKU. -* **size**: string: Size specifier of the resource SKU. -* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. -* **tier**: string: Service tier of the resource SKU. +* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. +* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed +when an auto heal rule is triggered. +* **minProcessExecutionTime**: string: Minimum time the process must execute +before taking the action -## Capability +## AutoHealCustomAction ### Properties -* **name**: string: Name of the SKU capability. -* **reason**: string: Reason of the SKU capability. -* **value**: string: Value of the SKU capability. +* **exe**: string: Executable to be run. +* **parameters**: string: Parameters for the executable. -## SkuCapacity +## AutoHealRules ### Properties -* **default**: int: Default number of workers for this App Service plan SKU. -* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. -* **maximum**: int: Maximum number of workers for this App Service plan SKU. -* **minimum**: int: Minimum number of workers for this App Service plan SKU. -* **scaleType**: string: Available scale configurations for an App Service plan. +* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. +* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. -## PrivateLinkConnectionApprovalRequest +## AutoHealTriggers ### Properties -* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) +* **privateBytesInKB**: int: A rule based on private bytes. +* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. +* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. +* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path +* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. +* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. -## ArmIdWrapper +## AzureActiveDirectory ### Properties -* **id**: string (ReadOnly) +* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. +* **isAutoProvisioned**: bool: 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. +* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. +* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. +* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. -## PrivateLinkConnectionState +## AzureActiveDirectoryLogin ### Properties -* **actionsRequired**: string: ActionsRequired for a private link connection -* **description**: string: Description of a private link connection -* **status**: string: Status of a private link connection +* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. +* **loginParameters**: 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". -## ExtendedLocation +## AzureActiveDirectoryRegistration ### Properties -* **name**: string: Name of extended location. -* **type**: string (ReadOnly): Type of extended location. +* **clientId**: 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 +* **clientSecretCertificateIssuer**: 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. +* **clientSecretCertificateSubjectAlternativeName**: 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. +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **openIdIssuer**: 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 -## KubeEnvironmentProperties +## AzureActiveDirectoryValidation ### Properties -* **aksResourceID**: string -* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) -* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) -* **containerAppsConfiguration**: [ContainerAppsConfiguration](#containerappsconfiguration) -* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster -* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation -* **environmentType**: string: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed -* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet -* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. -* **staticIp**: string: Static IP of the KubeEnvironment +* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. +* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. +* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. -## AppLogsConfiguration +## AzureBlobStorageApplicationLogsConfig ### Properties -* **destination**: string -* **logAnalyticsConfiguration**: [LogAnalyticsConfiguration](#loganalyticsconfiguration) +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## LogAnalyticsConfiguration +## AzureBlobStorageHttpLogsConfig ### Properties -* **customerId**: string -* **sharedKey**: string (WriteOnly) +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove blobs older than X days. +0 or lower means no retention. +* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. -## ArcConfiguration +## AzureStaticWebApps ### Properties -* **artifactsStorageType**: 'LocalNode' | 'NetworkFileSystem' -* **artifactStorageAccessMode**: string -* **artifactStorageClassName**: string -* **artifactStorageMountPath**: string -* **artifactStorageNodeName**: string -* **frontEndServiceConfiguration**: [FrontEndConfiguration](#frontendconfiguration) -* **kubeConfig**: string (WriteOnly) +* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider -## FrontEndConfiguration +## AzureStaticWebAppsRegistration ### Properties -* **kind**: 'LoadBalancer' | 'NodePort' +* **clientId**: string: The Client ID of the app used for login. -## ContainerAppsConfiguration +## AzureStorageInfoValue ### Properties -* **appSubnetResourceId**: string: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. -* **controlPlaneSubnetResourceId**: string: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. -* **daprAIInstrumentationKey**: string: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry -* **dockerBridgeCidr**: string: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. -* **platformReservedCidr**: string: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. -* **platformReservedDnsIP**: string: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server +* **accessKey**: string: Access key for the storage account. +* **accountName**: string: Name of the storage account. +* **mountPath**: string: Path to mount the storage within the site's runtime environment. +* **shareName**: string: Name of the file share (container name, for Blob storage). +* **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. +* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. -## ResourceTags +## AzureStoragePropertyDictionaryResourceProperties ### Properties ### Additional Properties -* **Additional Properties Type**: string +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## UserProperties +## AzureStoragePropertyDictionaryResourceProperties ### Properties -* **publishingPassword**: string: Password used for publishing. -* **publishingPasswordHash**: string: Password hash used for publishing. -* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. -* **publishingUserName**: string (Required): Username used for publishing. -* **scmUri**: string: Url of SCM site. +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) -## AppServicePlanProperties +## AzureTableStorageApplicationLogsConfig ### Properties -* **elasticScaleEnabled**: bool: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku -* **freeOfferExpirationTime**: string: The time when the server farm free offer expires. -* **geoRegion**: string (ReadOnly): Geographical location for the App Service plan. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hyperV**: bool: If Hyper-V container app service plan true, false otherwise. -* **isSpot**: bool: If true, this App Service Plan owns spot instances. -* **isXenon**: bool: Obsolete: If Hyper-V container app service plan true, false otherwise. -* **kubeEnvironmentProfile**: [KubeEnvironmentProfile](#kubeenvironmentprofile): Specification for a Kubernetes Environment to use for this resource. -* **maximumElasticWorkerCount**: int: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan -* **maximumNumberOfWorkers**: int (ReadOnly): Maximum number of instances that can be assigned to this App Service plan. -* **numberOfSites**: int (ReadOnly): Number of apps assigned to this App Service plan. -* **perSiteScaling**: bool: 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. -* **provisioningState**: 'Canceled' | 'Deleting' | 'Failed' | 'InProgress' | 'Succeeded' (ReadOnly): Provisioning state of the App Service Plan. -* **reserved**: bool: If Linux app service plan true, false otherwise. -* **resourceGroup**: string (ReadOnly): Resource group of the App Service plan. -* **spotExpirationTime**: string: The time when the server farm expires. Valid only if it is a spot server farm. -* **status**: 'Creating' | 'Pending' | 'Ready' (ReadOnly): App Service plan status. -* **subscription**: string (ReadOnly): App Service plan subscription. -* **targetWorkerCount**: int: Scaling worker count. -* **targetWorkerSizeId**: int: Scaling worker size ID. -* **workerTierName**: string: Target worker tier assigned to the App Service plan. -* **zoneRedundant**: bool: If true, this App Service Plan will perform availability zone balancing. -If false, this App Service Plan will not perform availability zone balancing. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. -## KubeEnvironmentProfile +## BackupItem ### Properties -* **id**: string: Resource ID of the Kubernetes Environment. -* **name**: string (ReadOnly): Name of the Kubernetes Environment. -* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## ResourceTags +## BackupItem ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **type**: string (ReadOnly): Resource type. -## VnetGatewayProperties +## BackupItemCollection ### Properties -* **vnetName**: string: The Virtual Network name. -* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## VnetRouteProperties +## BackupItemCollection ### Properties -* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. -* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' (WriteOnly): 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. -* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. -## ManagedServiceIdentity +## BackupItemProperties ### Properties -* **principalId**: string (ReadOnly): Principal Id of managed service identity. -* **tenantId**: string (ReadOnly): Tenant of managed service identity. -* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. -* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} +* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. +* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. +* **created**: string (ReadOnly): Timestamp of the backup creation. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. +* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. +* **id**: int (ReadOnly): Id of the backup. +* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. +* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. +* **name**: string (ReadOnly): Name of this backup. +* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. +* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. +* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. +* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. +* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. -## ManagedServiceIdentityUserAssignedIdentities +## BackupRequest ### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## UserAssignedIdentity +## BackupRequest ### Properties -* **clientId**: string (ReadOnly): Client Id of user assigned identity -* **principalId**: string (ReadOnly): Principal Id of user assigned identity +* **id**: string (ReadOnly, WriteOnly): Resource Id. +* **kind**: string (WriteOnly): Kind of resource. +* **name**: string (ReadOnly, WriteOnly): Resource Name. +* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties +* **type**: string (ReadOnly, WriteOnly): Resource type. -## SiteProperties +## BackupRequestProperties ### Properties -* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. -* **clientAffinityEnabled**: bool: 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. -* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. -* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths -* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. -* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. -* **containerSize**: int: Size of the function container. -* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. -* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). -* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. -* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). -* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. -* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. -* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. -* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. - If true, the app is only accessible via API management process. -* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. -* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests -* **hyperV**: bool: Hyper-V sandbox. -* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. -* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. -* **isXenon**: bool: Obsolete: Hyper-V sandbox. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. -* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. -This only applies to Functions container. -* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. -* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. -* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode -* **repositorySiteName**: string (ReadOnly): Name of the repository site. -* **reserved**: bool: true if reserved; otherwise, false. -* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. -* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **backupName**: string: Name of the backup. +* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. +* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. +* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. +* **storageAccountUrl**: string (Required): SAS URL to the container. + +## BackupSchedule +### Properties +* **frequencyInterval**: int (Required): 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) +* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) +* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. +* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. +* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. +* **startTime**: string: When the schedule should start working. + +## BlobStorageTokenStore +### Properties +* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. + +## Capability +### Properties +* **name**: string: Name of the SKU capability. +* **reason**: string: Reason of the SKU capability. +* **value**: string: Value of the SKU capability. + +## CertificateProperties +### Properties +* **canonicalName**: string: CNAME of the certificate to be issued via free certificate +* **cerBlob**: any (ReadOnly): Raw bytes of .cer file +* **domainValidationMethod**: string: Method of domain validation for free cert +* **expirationDate**: string (ReadOnly): Certificate expiration date. +* **friendlyName**: string (ReadOnly): Friendly name of the certificate. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile) (ReadOnly): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[]: Host names the certificate applies to. +* **issueDate**: string (ReadOnly): Certificate issue Date. +* **issuer**: string (ReadOnly): Certificate issuer. +* **keyVaultId**: string: Key Vault Csm resource Id. +* **keyVaultSecretName**: string: Key Vault secret name. +* **keyVaultSecretStatus**: 'AzureServiceUnauthorizedToAccessKeyVault' | 'CertificateOrderFailed' | 'ExternalPrivateKey' | 'Initialized' | 'KeyVaultDoesNotExist' | 'KeyVaultSecretDoesNotExist' | 'OperationNotPermittedOnKeyVault' | 'Succeeded' | 'Unknown' | 'UnknownError' | 'WaitingOnCertificateOrder' (ReadOnly): Status of the Key Vault secret. +* **password**: string (WriteOnly): Certificate password. +* **pfxBlob**: any: Pfx blob. +* **publicKeyHash**: string (ReadOnly): Public key hash. +* **selfLink**: string (ReadOnly): Self link. * **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". -* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. -* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. -* **state**: string (ReadOnly): Current state of the app. -* **storageAccountRequired**: bool: Checks if Customer provided storage account is required -* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. -* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. -* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. -* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. -* **virtualNetworkSubnetId**: 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} +* **siteName**: string (ReadOnly): App name. +* **subjectName**: string (ReadOnly): Subject name of the certificate. +* **thumbprint**: string (ReadOnly): Certificate thumbprint. +* **valid**: bool (ReadOnly): Is the certificate valid?. + +## ClientRegistration +### Properties +* **clientId**: string: The Client ID of the app used for login. +* **clientSecretSettingName**: string: The app setting name that contains the client secret. ## CloningInfo ### Properties @@ -1501,405 +1401,284 @@ together to use the same snapshot. ### Additional Properties * **Additional Properties Type**: string -## HostNameSslState +## Configuration ### Properties -* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. -* **name**: string: Hostname. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type -* **thumbprint**: string: SSL certificate thumbprint. -* **toUpdate**: bool: Set to true to update existing hostname. -* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. +* **activeRevisionsMode**: 'multiple' | 'single' | string: ActiveRevisionsMode controls how active revisions are handled for the Container app: +Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode +* **ingress**: [Ingress](#ingress): Container App Ingress configuration. +* **registries**: [RegistryCredentials](#registrycredentials)[]: Collection of private container registry credentials for containers used by the Container app +* **secrets**: [Secret](#secret)[]: Collection of secrets used by a Container app -## SiteConfig +## ConnectionStringDictionaryProperties ### Properties -* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull -* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId -* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. -* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. -* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. -* **appCommandLine**: string: App command line to launch. -* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. -* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. -* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. -* **autoSwapSlotName**: string: Auto-swap slot name. -* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. -* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. -* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. -* **defaultDocuments**: string[]: Default documents. -* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. -* **documentRoot**: string: Document root. -* **experiments**: [Experiments](#experiments): Routing rules in production experiments. -* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly': State of FTP / FTPS service -* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans -* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. -* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. -* **healthCheckPath**: string: Health check path -* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 -* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. -* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. -* **javaContainer**: string: Java container. -* **javaContainerVersion**: string: Java container version. -* **javaVersion**: string: Java version. -* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. -* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. -* **linuxFxVersion**: string: Linux App Framework and version -* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. -* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. -* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. -* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. -* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. -* **managedServiceIdentityId**: int: Managed Service Identity Id -* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site -This setting only applies to the Elastic Plans -* **minTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **netFrameworkVersion**: string: .NET Framework version. -* **nodeVersion**: string: Version of Node.js. -* **numberOfWorkers**: int: Number of workers. -* **phpVersion**: string: Version of PHP. -* **powerShellVersion**: string: Version of PowerShell. -* **preWarmedInstanceCount**: int: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans -* **publicNetworkAccess**: string: Property to allow or block all public traffic. -* **publishingUsername**: string: Publishing user name. -* **push**: [PushSettings](#pushsettings): Push settings for the App. -* **pythonVersion**: string: Version of Python. -* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. -* **remoteDebuggingVersion**: string: Remote debugging version. -* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. -* **requestTracingExpirationTime**: string: Request tracing expiration time. -* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. -* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. -* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2': MinTlsVersion: configures the minimum version of TLS required for SSL requests -* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM': SCM type. -* **tracingOptions**: string: Tracing options. -* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. -* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. -* **vnetName**: string: Virtual Network name. -* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. -* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. -* **websiteTimeZone**: 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 -* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. -* **windowsFxVersion**: string: Xenon App Framework and version -* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## ApiDefinitionInfo +## ConnectionStringDictionaryProperties ### Properties -* **url**: string: The URL of the API definition. +### Additional Properties +* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) -## ApiManagementConfig +## ConnStringInfo ### Properties -* **id**: string: APIM-Api Identifier. +* **connectionString**: string: Connection string value. +* **name**: string: Name of connection string. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. -## AutoHealRules +## ConnStringValueTypePair ### Properties -* **actions**: [AutoHealActions](#autohealactions): Actions which to take by the auto-heal module when a rule is triggered. -* **triggers**: [AutoHealTriggers](#autohealtriggers): Triggers for auto-heal. +* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. +* **value**: string (Required): Value of pair. -## AutoHealActions +## Container ### Properties -* **actionType**: 'CustomAction' | 'LogEvent' | 'Recycle': Predefined action to be taken. -* **customAction**: [AutoHealCustomAction](#autohealcustomaction): Custom action to be executed -when an auto heal rule is triggered. -* **minProcessExecutionTime**: string: Minimum time the process must execute -before taking the action +* **args**: string[]: Container start command arguments. +* **command**: string[]: Container start command. +* **env**: [EnvironmentVar](#environmentvar)[]: Container environment variables. +* **image**: string: Container image tag. +* **name**: string: Custom container name. +* **resources**: [ContainerResources](#containerresources): Container App container resource requirements. -## AutoHealCustomAction +## ContainerAppProperties ### Properties -* **exe**: string: Executable to be run. -* **parameters**: string: Parameters for the executable. +* **configuration**: [Configuration](#configuration): Non versioned Container App configuration properties that define the mutable settings of a Container app +* **kubeEnvironmentId**: string: Resource ID of the Container App's KubeEnvironment. +* **latestRevisionFqdn**: string (ReadOnly): Fully Qualified Domain Name of the latest revision of the Container App. +* **latestRevisionName**: string (ReadOnly): Name of the latest revision of the Container App. +* **provisioningState**: 'Canceled' | 'Failed' | 'InProgress' | 'Succeeded' | string (ReadOnly): Provisioning state of the Container App. +* **template**: [Template](#template): Container App versioned application definition. +Defines the desired state of an immutable revision. +Any changes to this section Will result in a new revision being created -## AutoHealTriggers +## ContainerAppsConfiguration ### Properties -* **privateBytesInKB**: int: A rule based on private bytes. -* **requests**: [RequestsBasedTrigger](#requestsbasedtrigger): Trigger based on total requests. -* **slowRequests**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger): Trigger based on request execution time. -* **slowRequestsWithPath**: [SlowRequestsBasedTrigger](#slowrequestsbasedtrigger)[]: A rule based on multiple Slow Requests Rule with path -* **statusCodes**: [StatusCodesBasedTrigger](#statuscodesbasedtrigger)[]: A rule based on status codes. -* **statusCodesRange**: [StatusCodesRangeBasedTrigger](#statuscodesrangebasedtrigger)[]: A rule based on status codes ranges. +* **appSubnetResourceId**: string: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. +* **controlPlaneSubnetResourceId**: string: Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. +* **daprAIInstrumentationKey**: string: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry +* **dockerBridgeCidr**: string: CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. +* **platformReservedCidr**: string: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. +* **platformReservedDnsIP**: string: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server -## RequestsBasedTrigger +## ContainerAppSecret ### Properties -* **count**: int: Request Count. -* **timeInterval**: string: Time interval. +* **name**: string (ReadOnly): Secret Name. +* **value**: string (ReadOnly): Secret Value. -## SlowRequestsBasedTrigger +## ContainerResources ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path. -* **timeInterval**: string: Time interval. -* **timeTaken**: string: Time taken. +* **cpu**: int: Required CPU in cores, e.g. 0.5 +* **memory**: string: Required memory, e.g. "250Mb" -## StatusCodesBasedTrigger +## CookieExpiration ### Properties -* **count**: int: Request Count. -* **path**: string: Request Path -* **status**: int: HTTP status code. -* **subStatus**: int: Request Sub Status. -* **timeInterval**: string: Time interval. -* **win32Status**: int: Win32 error code. +* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. +* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. -## StatusCodesRangeBasedTrigger +## CorsSettings ### Properties -* **count**: int: Request Count. -* **path**: string -* **statusCodes**: string: HTTP status code. -* **timeInterval**: string: Time interval. +* **allowedOrigins**: string[]: 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. +* **supportCredentials**: bool: 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. -## SiteConfigAzureStorageAccounts +## CsmPublishingCredentialsPoliciesEntityProperties +### Properties +* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. + +## CustomOpenIdConnectProvider +### Properties +* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. +* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. +* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. + +## CustomScaleRule +### Properties +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. +* **metadata**: [CustomScaleRuleMetadata](#customscalerulemetadata): Metadata properties to describe custom scale rule. +* **type**: string: Type of the custom scale rule +eg: azure-servicebus, redis etc. + +## CustomScaleRuleMetadata ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## AzureStorageInfoValue +## Dapr ### Properties -* **accessKey**: string: Access key for the storage account. -* **accountName**: string: Name of the storage account. -* **mountPath**: string: Path to mount the storage within the site's runtime environment. -* **shareName**: string: Name of the file share (container name, for Blob storage). -* **state**: 'InvalidCredentials' | 'InvalidShare' | 'NotValidated' | 'Ok' (ReadOnly): State of the storage account. -* **type**: 'AzureBlob' | 'AzureFiles': Type of storage. +* **appId**: string: Dapr application identifier +* **appPort**: int: Port on which the Dapr side car +* **components**: [DaprComponent](#daprcomponent)[]: Collection of Dapr components +* **enabled**: bool: Boolean indicating if the Dapr side car is enabled -## ConnStringInfo +## DaprComponent ### Properties -* **connectionString**: string: Connection string value. -* **name**: string: Name of connection string. -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus': Type of database. +* **metadata**: [DaprMetadata](#daprmetadata)[]: Component metadata +* **name**: string: Component name +* **type**: string: Component type +* **version**: string: Component version -## CorsSettings +## DaprMetadata ### Properties -* **allowedOrigins**: string[]: 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. -* **supportCredentials**: bool: 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. +* **name**: string: Metadata property name. +* **secretRef**: string: Name of the Container App secret from which to pull the metadata property value. +* **value**: string: Metadata property value. -## Experiments +## DatabaseBackupSetting ### Properties -* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. +* **connectionString**: string: 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. +* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. +This is used during restore with overwrite connection strings options. +* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' | string (Required): Database type (e.g. SqlAzure / MySql). +* **name**: string -## RampUpRule +## DefaultAuthorizationPolicy ### Properties -* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. -* **changeDecisionCallbackUrl**: 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/ -* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. -* **changeStep**: int: 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. -* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. -* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. -* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. -* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. +* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. +* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. -## HandlerMapping +## DeploymentProperties ### Properties -* **arguments**: string: Command-line arguments to be passed to the script processor. -* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. -* **scriptProcessor**: string: The absolute path to the FastCGI application. +* **active**: bool: True if deployment is currently active, false if completed and null if not started. +* **author**: string: Who authored the deployment. +* **author_email**: string: Author email. +* **deployer**: string: Who performed the deployment. +* **details**: string: Details on deployment. +* **end_time**: string: End time. +* **message**: string: Details about deployment status. +* **start_time**: string: Start time. +* **status**: int: Deployment status. -## IpSecurityRestriction +## EnabledConfig ### Properties -* **action**: string: Allow or Deny access for this IP range. -* **description**: string: IP restriction rule description. -* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -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. +## EnvironmentVar +### Properties +* **name**: string: Environment variable name. +* **secretRef**: string: Name of the Container App secret from which to pull the environment variable value. +* **value**: string: Non-secret environment variable value. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. -* **ipAddress**: 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. -* **name**: string: IP restriction rule name. -* **priority**: int: Priority of IP restriction rule. -* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. -* **subnetTrafficTag**: int: (internal) Subnet traffic tag -* **tag**: 'Default' | 'ServiceTag' | 'XffProxy': Defines what this IP filter will be used for. This is to support IP filtering on proxies. -* **vnetSubnetResourceId**: string: Virtual network resource id -* **vnetTrafficTag**: int: (internal) Vnet traffic tag +## ErrorEntity +### Properties +* **code**: string: Basic error code. +* **details**: [ErrorEntity](#errorentity)[]: Error Details. +* **extendedCode**: string: Type of error. +* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. +* **message**: string: Any details of the error. +* **messageTemplate**: string: Message template. +* **parameters**: string[]: Parameters for the template. +* **target**: string: The error target. -## IpSecurityRestrictionHeaders +## Experiments ### Properties -### Additional Properties -* **Additional Properties Type**: string[] +* **rampUpRules**: [RampUpRule](#rampuprule)[]: List of ramp-up rules. -## SiteLimits +## ExtendedLocation ### Properties -* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. -* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. -* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. +* **name**: string: Name of extended location. +* **type**: string (ReadOnly): Type of extended location. -## SiteMachineKey +## Facebook ### Properties -* **decryption**: string: Algorithm used for decryption. -* **decryptionKey**: string: Decryption key. -* **validation**: string: MachineKey validation. -* **validationKey**: string: Validation key. +* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. +* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets -## PushSettings +## FileSystemApplicationLogsConfig ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties -* **type**: string (ReadOnly): Resource type. +* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -## PushSettingsProperties +## FileSystemHttpLogsConfig ### Properties -* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. -* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. -* **tagsRequiringAuth**: 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. -* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. +* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **retentionInDays**: int: Retention in days. +Remove files older than X days. +0 or lower means no retention. +* **retentionInMb**: int: 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. -## VirtualApplication +## FileSystemTokenStore ### Properties -* **physicalPath**: string: Physical path. -* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. -* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. -* **virtualPath**: string: Virtual path. +* **directory**: string: The directory in which the tokens will be stored. -## VirtualDirectory +## ForwardProxy ### Properties -* **physicalPath**: string: Physical path. -* **virtualPath**: string: Path to virtual application. +* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. +* **customHostHeaderName**: string: The name of the header containing the host of the request. +* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. -## SlotSwapStatus +## FrontEndConfiguration ### Properties -* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. -* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. -* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. +* **kind**: 'LoadBalancer' | 'NodePort' -## ResourceTags +## FunctionEnvelopeProperties +### Properties +* **config**: any: Any object +* **config_href**: string: Config URI. +* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. +* **function_app_id**: string: Function App ID. +* **href**: string: Function URI. +* **invoke_url_template**: string: The invocation URL +* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled +* **language**: string: The function language +* **script_href**: string: Script URI. +* **script_root_path_href**: string: Script root path URI. +* **secrets_file_href**: string: Secrets file URI. +* **test_data**: string: Test data used when testing via the Azure Portal. +* **test_data_href**: string: Test data URI. + +## FunctionEnvelopePropertiesFiles ### Properties ### Additional Properties * **Additional Properties Type**: string -## CsmPublishingCredentialsPoliciesEntityProperties +## FunctionSecrets ### Properties -* **allow**: bool (Required): true to allow access to a publishing method; otherwise, false. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## StringDictionaryProperties +## FunctionSecrets ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## SiteAuthSettingsProperties +## FunctionSecrets ### Properties -* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. -* **additionalLoginParams**: 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". -* **allowedAudiences**: 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. -* **allowedExternalRedirectUrls**: 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. -* **authFilePath**: string: The path of the config file containing auth settings. -If the path is relative, base will the site's root directory. -* **clientId**: 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 -* **clientSecret**: 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 -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **configVersion**: 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. -* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **facebookAppId**: 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 -* **facebookAppSecret**: 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 -* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. -* **facebookOAuthScopes**: 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 -* **gitHubClientId**: string: The Client Id of the GitHub app used for login. -This setting is required for enabling Github login -* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. -This setting is required for enabling Github login. -* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github -app used for GitHub Login. -* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. -This setting is optional -* **googleClientId**: 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/ -* **googleClientSecret**: 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/ -* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with -the Google web application. -* **googleOAuthScopes**: 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/ -* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, -"false" otherwise -* **issuer**: 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 -* **microsoftAccountClientId**: 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 -* **microsoftAccountClientSecret**: 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 -* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the -app used for authentication. -* **microsoftAccountOAuthScopes**: 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 -* **runtimeVersion**: 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. -* **tokenRefreshExtensionHours**: int: 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. -* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **twitterConsumerKey**: 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 -* **twitterConsumerSecret**: 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 -* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. -* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. -* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. -## SiteAuthSettingsV2Properties +## FunctionSecrets ### Properties -* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. -* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. -* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. -* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. -* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. +* **key**: string (ReadOnly): Secret key. +* **trigger_url**: string (ReadOnly): Trigger URL. + +## GitHub +### Properties +* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets + +## GitHubActionCodeConfiguration +### Properties +* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. +* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. + +## GitHubActionConfiguration +### Properties +* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. +* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. +* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. +* **isLinux**: bool: This will help determine the workflow configuration to select. + +## GitHubActionContainerConfiguration +### Properties +* **imageName**: string: The image name for the build. +* **password**: string: The password used to upload the image to the container registry. +* **serverUrl**: string: The server URL for the container registry where the build will be hosted. +* **username**: string: The username used to upload the image to the container registry. ## GlobalValidation ### Properties @@ -1910,182 +1689,209 @@ action is set to "RedirectToLoginPage". * **requireAuthentication**: bool: true if the authentication flow is required any request is made; otherwise, false. * **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage' | 'Return401' | 'Return403': The action to take when an unauthenticated client attempts to access the app. -## HttpSettings +## Google ### Properties -* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. -* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. -* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. +* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. +* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. +* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## ForwardProxy +## HandlerMapping ### Properties -* **convention**: 'Custom' | 'NoProxy' | 'Standard': The convention used to determine the url of the request made. -* **customHostHeaderName**: string: The name of the header containing the host of the request. -* **customProtoHeaderName**: string: The name of the header containing the scheme of the request. +* **arguments**: string: Command-line arguments to be passed to the script processor. +* **extension**: string: Requests with this extension will be handled using the specified FastCGI application. +* **scriptProcessor**: string: The absolute path to the FastCGI application. -## HttpSettingsRoutes +## HostingEnvironmentProfile ### Properties -* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. +* **id**: string: Resource ID of the App Service Environment. +* **name**: string (ReadOnly): Name of the App Service Environment. +* **type**: string (ReadOnly): Resource type of the App Service Environment. -## IdentityProviders +## HostKeys ### Properties -* **apple**: [Apple](#apple): The configuration settings of the Apple provider. -* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. -* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. -* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. -* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. -* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. -* **google**: [Google](#google): The configuration settings of the Google provider. -* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. -* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## Apple +## HostKeys ### Properties -* **enabled**: bool: false if the Apple provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppleRegistration](#appleregistration): The configuration settings of the registration for the Apple provider +* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. +* **masterKey**: string (ReadOnly): Secret key. +* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. -## LoginScopes +## HostKeysFunctionKeys ### Properties -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +### Additional Properties +* **Additional Properties Type**: string -## AppleRegistration +## HostKeysSystemKeys ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +### Additional Properties +* **Additional Properties Type**: string -## AzureActiveDirectory +## HostNameBindingProperties ### Properties -* **enabled**: bool: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. -* **isAutoProvisioned**: bool: 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. -* **login**: [AzureActiveDirectoryLogin](#azureactivedirectorylogin): The configuration settings of the Azure Active Directory login flow. -* **registration**: [AzureActiveDirectoryRegistration](#azureactivedirectoryregistration): The configuration settings of the Azure Active Directory app registration. -* **validation**: [AzureActiveDirectoryValidation](#azureactivedirectoryvalidation): The configuration settings of the Azure Active Directory token validation flow. +* **azureResourceName**: string: Azure resource name. +* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. +* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. +* **domainId**: string: Fully qualified ARM domain resource URI. +* **hostNameType**: 'Managed' | 'Verified': Hostname type. +* **siteName**: string: App Service app name. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type +* **thumbprint**: string: SSL certificate thumbprint +* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AzureActiveDirectoryLogin +## HostNameSslState ### Properties -* **disableWWWAuthenticate**: bool: true if the www-authenticate provider should be omitted from the request; otherwise, false. -* **loginParameters**: 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". +* **hostType**: 'Repository' | 'Standard': Indicates whether the hostname is a standard or repository hostname. +* **name**: string: Hostname. +* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type +* **thumbprint**: string: SSL certificate thumbprint. +* **toUpdate**: bool: Set to true to update existing hostname. +* **virtualIP**: string: Virtual IP address assigned to the hostname if IP based SSL is enabled. -## AzureActiveDirectoryRegistration +## HttpLogsConfig ### Properties -* **clientId**: 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 -* **clientSecretCertificateIssuer**: 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. -* **clientSecretCertificateSubjectAlternativeName**: 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. -* **clientSecretCertificateThumbprint**: 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. -* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. -* **openIdIssuer**: 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 +* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. +* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. -## AzureActiveDirectoryValidation +## HttpScaleRule ### Properties -* **allowedAudiences**: string[]: The list of audiences that can make successful authentication/authorization requests. -* **defaultAuthorizationPolicy**: [DefaultAuthorizationPolicy](#defaultauthorizationpolicy): The configuration settings of the Azure Active Directory default authorization policy. -* **jwtClaimChecks**: [JwtClaimChecks](#jwtclaimchecks): The configuration settings of the checks that should be made while validating the JWT Claims. +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the custom scale rule. +* **metadata**: [HttpScaleRuleMetadata](#httpscalerulemetadata): Metadata properties to describe http scale rule. -## DefaultAuthorizationPolicy +## HttpScaleRuleMetadata ### Properties -* **allowedApplications**: string[]: The configuration settings of the Azure Active Directory allowed applications. -* **allowedPrincipals**: [AllowedPrincipals](#allowedprincipals): The configuration settings of the Azure Active Directory allowed principals. +### Additional Properties +* **Additional Properties Type**: string -## AllowedPrincipals +## HttpSettings ### Properties -* **groups**: string[]: The list of the allowed groups. -* **identities**: string[]: The list of the allowed identities. +* **forwardProxy**: [ForwardProxy](#forwardproxy): The configuration settings of a forward proxy used to make the requests. +* **requireHttps**: bool: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. +* **routes**: [HttpSettingsRoutes](#httpsettingsroutes): The configuration settings of the paths HTTP requests. -## JwtClaimChecks +## HttpSettingsRoutes ### Properties -* **allowedClientApplications**: string[]: The list of the allowed client applications. -* **allowedGroups**: string[]: The list of the allowed groups. +* **apiPrefix**: string: The prefix that should precede all the authentication/authorization paths. -## AzureStaticWebApps +## HybridConnectionKey ### Properties -* **enabled**: bool: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [AzureStaticWebAppsRegistration](#azurestaticwebappsregistration): The configuration settings of the registration for the Azure Static Web Apps provider +* **id**: string (ReadOnly): Resource Id. +* **kind**: string (ReadOnly): Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **type**: string (ReadOnly): Resource type. -## AzureStaticWebAppsRegistration +## HybridConnectionKeyProperties ### Properties -* **clientId**: string: The Client ID of the app used for login. - -## IdentityProvidersCustomOpenIdConnectProviders -### Properties -### Additional Properties -* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) +* **sendKeyName**: string (ReadOnly): The name of the send key. +* **sendKeyValue**: string (ReadOnly): The value of the send key. -## CustomOpenIdConnectProvider +## HybridConnectionProperties ### Properties -* **enabled**: bool: false if the custom Open ID provider provider should not be enabled; otherwise, true. -* **login**: [OpenIdConnectLogin](#openidconnectlogin): The configuration settings of the login flow of the custom Open ID Connect provider. -* **registration**: [OpenIdConnectRegistration](#openidconnectregistration): The configuration settings of the app registration for the custom Open ID Connect provider. +* **hostname**: string: The hostname of the endpoint. +* **port**: int: The port of the endpoint. +* **relayArmUri**: string: The ARM URI to the Service Bus relay. +* **relayName**: string: The name of the Service Bus relay. +* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. +* **sendKeyValue**: 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. +* **serviceBusNamespace**: string: The name of the Service Bus namespace. +* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net -## OpenIdConnectLogin +## IdentifierProperties ### Properties -* **nameClaimType**: string: The name of the claim that contains the users name. -* **scopes**: string[]: A list of the scopes that should be requested while authenticating. +* **id**: string: String representation of the identity. -## OpenIdConnectRegistration +## IdentityProviders ### Properties -* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. -* **clientId**: string: The client id of the custom Open ID Connect provider. -* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. +* **apple**: [Apple](#apple): The configuration settings of the Apple provider. +* **azureActiveDirectory**: [AzureActiveDirectory](#azureactivedirectory): The configuration settings of the Azure Active directory provider. +* **azureStaticWebApps**: [AzureStaticWebApps](#azurestaticwebapps): The configuration settings of the Azure Static Web Apps provider. +* **customOpenIdConnectProviders**: [IdentityProvidersCustomOpenIdConnectProviders](#identityproviderscustomopenidconnectproviders): 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. +* **facebook**: [Facebook](#facebook): The configuration settings of the Facebook provider. +* **gitHub**: [GitHub](#github): The configuration settings of the GitHub provider. +* **google**: [Google](#google): The configuration settings of the Google provider. +* **legacyMicrosoftAccount**: [LegacyMicrosoftAccount](#legacymicrosoftaccount): The configuration settings of the legacy Microsoft Account provider. +* **twitter**: [Twitter](#twitter): The configuration settings of the Twitter provider. -## OpenIdConnectClientCredential +## IdentityProvidersCustomOpenIdConnectProviders ### Properties -* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. -* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. +### Additional Properties +* **Additional Properties Type**: [CustomOpenIdConnectProvider](#customopenidconnectprovider) -## OpenIdConnectConfig +## Ingress ### Properties -* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. -* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. -* **issuer**: string: The endpoint that issues the token. -* **tokenEndpoint**: string: The endpoint to be used to request a token. -* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. +* **allowInsecure**: bool: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections +* **external**: bool: Bool indicating if app exposes an external http endpoint +* **fqdn**: string (ReadOnly): Hostname. +* **targetPort**: int: Target Port in containers for traffic from ingress +* **traffic**: [TrafficWeight](#trafficweight)[]: Array of TrafficWeight +* **transport**: 'auto' | 'http' | 'http2' | string: Ingress transport protocol -## Facebook +## IpSecurityRestriction ### Properties -* **enabled**: bool: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. -* **graphApiVersion**: string: The version of the Facebook api to be used while logging in. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [AppRegistration](#appregistration): The configuration settings of the app registration for providers that have app ids and app secrets +* **action**: string: Allow or Deny access for this IP range. +* **description**: string: IP restriction rule description. +* **headers**: [IpSecurityRestrictionHeaders](#ipsecurityrestrictionheaders): 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. -## AppRegistration -### Properties -* **appId**: string: The App ID of the app used for login. -* **appSecretSettingName**: string: The app setting name that contains the app secret. +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. -## GitHub +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. +* **ipAddress**: 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. +* **name**: string: IP restriction rule name. +* **priority**: int: Priority of IP restriction rule. +* **subnetMask**: string: Subnet mask for the range of IP addresses the restriction is valid for. +* **subnetTrafficTag**: int: (internal) Subnet traffic tag +* **tag**: 'Default' | 'ServiceTag' | 'XffProxy' | string: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +* **vnetSubnetResourceId**: string: Virtual network resource id +* **vnetTrafficTag**: int: (internal) Vnet traffic tag + +## IpSecurityRestrictionHeaders ### Properties -* **enabled**: bool: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets +### Additional Properties +* **Additional Properties Type**: string[] -## ClientRegistration +## JwtClaimChecks ### Properties -* **clientId**: string: The Client ID of the app used for login. -* **clientSecretSettingName**: string: The app setting name that contains the client secret. +* **allowedClientApplications**: string[]: The list of the allowed client applications. +* **allowedGroups**: string[]: The list of the allowed groups. -## Google +## KubeEnvironmentProfile ### Properties -* **enabled**: bool: false if the Google provider should not be enabled despite the set registration; otherwise, true. -* **login**: [LoginScopes](#loginscopes): The configuration settings of the login flow, including the scopes that should be requested. -* **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets -* **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. +* **id**: string: Resource ID of the Kubernetes Environment. +* **name**: string (ReadOnly): Name of the Kubernetes Environment. +* **type**: string (ReadOnly): Resource type of the Kubernetes Environment. -## AllowedAudiencesValidation +## KubeEnvironmentProperties ### Properties -* **allowedAudiences**: string[]: The configuration settings of the allowed list of audiences from which to validate the JWT token. +* **aksResourceID**: string +* **appLogsConfiguration**: [AppLogsConfiguration](#applogsconfiguration) +* **arcConfiguration**: [ArcConfiguration](#arcconfiguration) +* **containerAppsConfiguration**: [ContainerAppsConfiguration](#containerappsconfiguration) +* **defaultDomain**: string (ReadOnly): Default Domain Name for the cluster +* **deploymentErrors**: string (ReadOnly): Any errors that occurred during deployment or deployment validation +* **environmentType**: string: Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed +* **internalLoadBalancerEnabled**: bool: Only visible within Vnet/Subnet +* **provisioningState**: 'Canceled' | 'Failed' | 'InfrastructureSetupComplete' | 'InfrastructureSetupInProgress' | 'InitializationInProgress' | 'ScheduledForDelete' | 'Succeeded' | 'UpgradeFailed' | 'UpgradeRequested' | 'Waiting' (ReadOnly): Provisioning state of the Kubernetes Environment. +* **staticIp**: string: Static IP of the KubeEnvironment ## LegacyMicrosoftAccount ### Properties @@ -2094,18 +1900,10 @@ More information on OpenID Connect Discovery: http://openid.net/specs/openid-con * **registration**: [ClientRegistration](#clientregistration): The configuration settings of the app registration for providers that have client ids and client secrets * **validation**: [AllowedAudiencesValidation](#allowedaudiencesvalidation): The configuration settings of the Allowed Audiences validation flow. -## Twitter -### Properties -* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. -* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. - -## TwitterRegistration +## LogAnalyticsConfiguration ### Properties -* **consumerKey**: 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 -* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter -application used for sign-in. +* **customerId**: string +* **sharedKey**: string (WriteOnly) ## Login ### Properties @@ -2118,288 +1916,481 @@ Note that URLs within the current domain are always implicitly allowed. * **routes**: [LoginRoutes](#loginroutes): The routes that specify the endpoints used for login and logout requests. * **tokenStore**: [TokenStore](#tokenstore): The configuration settings of the token store. -## CookieExpiration -### Properties -* **convention**: 'FixedTime' | 'IdentityProviderDerived': The convention used when determining the session cookie's expiration. -* **timeToExpiration**: string: The time after the request is made when the session cookie should expire. - -## Nonce -### Properties -* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. -* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. - ## LoginRoutes ### Properties * **logoutEndpoint**: string: The endpoint at which a logout request should be made. -## TokenStore +## LoginScopes ### Properties -* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. -* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. - The default is false. -* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. -* **tokenRefreshExtensionHours**: int: 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. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## BlobStorageTokenStore +## ManagedServiceIdentity ### Properties -* **sasUrlSettingName**: string: The name of the app setting containing the SAS URL of the blob storage containing the tokens. +* **principalId**: string (ReadOnly): Principal Id of managed service identity. +* **tenantId**: string (ReadOnly): Tenant of managed service identity. +* **type**: 'None' | 'SystemAssigned' | 'SystemAssigned, UserAssigned' | 'UserAssigned': Type of managed service identity. +* **userAssignedIdentities**: [ManagedServiceIdentityUserAssignedIdentities](#managedserviceidentityuserassignedidentities): 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} -## FileSystemTokenStore +## ManagedServiceIdentityUserAssignedIdentities ### Properties -* **directory**: string: The directory in which the tokens will be stored. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentity](#userassignedidentity) -## AuthPlatform +## MSDeployCore ### Properties -* **configFilePath**: string: 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. -* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. -* **runtimeVersion**: 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. +* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. +Setting is false by default. +* **complete**: bool (ReadOnly): Whether the deployment operation has completed +* **connectionString**: string (WriteOnly): SQL Connection String +* **dbType**: string (WriteOnly): Database Type +* **deployer**: string (ReadOnly): Username of deployer +* **endTime**: string (ReadOnly): End time of deploy operation +* **packageUri**: string (WriteOnly): Package URI +* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state +* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. +* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. +* **skipAppData**: bool (WriteOnly): 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. +* **startTime**: string (ReadOnly): Start time of deploy operation -## AzureStoragePropertyDictionaryResourceProperties +## MSDeployCoreSetParameters ### Properties ### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **Additional Properties Type**: string -## BackupRequestProperties +## NameValuePair ### Properties -* **backupName**: string: Name of the backup. -* **backupSchedule**: [BackupSchedule](#backupschedule): Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[]: Databases included in the backup. -* **enabled**: bool: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. -* **storageAccountUrl**: string (Required): SAS URL to the container. +* **name**: string: Pair name. +* **value**: string: Pair value. -## BackupSchedule +## Nonce ### Properties -* **frequencyInterval**: int (Required): 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) -* **frequencyUnit**: 'Day' | 'Hour' (Required): 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) -* **keepAtLeastOneBackup**: bool (Required): True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. -* **lastExecutionTime**: string (ReadOnly): Last time when this schedule was triggered. -* **retentionPeriodInDays**: int (Required): After how many days backups should be deleted. -* **startTime**: string: When the schedule should start working. +* **nonceExpirationInterval**: string: The time after the request is made when the nonce should expire. +* **validateNonce**: bool: false if the nonce should not be validated while completing the login flow; otherwise, true. -## DatabaseBackupSetting +## OpenIdConnectClientCredential ### Properties -* **connectionString**: string: 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. -* **connectionStringName**: string: Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. -This is used during restore with overwrite connection strings options. -* **databaseType**: 'LocalMySql' | 'MySql' | 'PostgreSql' | 'SqlAzure' (Required): Database type (e.g. SqlAzure / MySql). -* **name**: string +* **clientSecretSettingName**: string: The app setting that contains the client secret for the custom Open ID Connect provider. +* **method**: 'ClientSecretPost': The method that should be used to authenticate the user. -## ConnectionStringDictionaryProperties +## OpenIdConnectConfig ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **authorizationEndpoint**: string: The endpoint to be used to make an authorization request. +* **certificationUri**: string: The endpoint that provides the keys necessary to validate the token. +* **issuer**: string: The endpoint that issues the token. +* **tokenEndpoint**: string: The endpoint to be used to request a token. +* **wellKnownOpenIdConfiguration**: string: The endpoint that contains all the configuration endpoints for the provider. -## ConnStringValueTypePair +## OpenIdConnectLogin ### Properties -* **type**: 'ApiHub' | 'Custom' | 'DocDb' | 'EventHub' | 'MySql' | 'NotificationHub' | 'PostgreSQL' | 'RedisCache' | 'SQLAzure' | 'SQLServer' | 'ServiceBus' (Required): Type of database. -* **value**: string (Required): Value of pair. +* **nameClaimType**: string: The name of the claim that contains the users name. +* **scopes**: string[]: A list of the scopes that should be requested while authenticating. -## SiteLogsConfigProperties +## OpenIdConnectRegistration ### Properties -* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. -* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. -* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. +* **clientCredential**: [OpenIdConnectClientCredential](#openidconnectclientcredential): The authentication client credentials of the custom Open ID Connect provider. +* **clientId**: string: The client id of the custom Open ID Connect provider. +* **openIdConnectConfiguration**: [OpenIdConnectConfig](#openidconnectconfig): The configuration settings of the endpoints used for the custom Open ID Connect provider. -## ApplicationLogsConfig +## PremierAddOnProperties ### Properties -* **azureBlobStorage**: [AzureBlobStorageApplicationLogsConfig](#azureblobstorageapplicationlogsconfig): Application logs azure blob storage configuration. -* **azureTableStorage**: [AzureTableStorageApplicationLogsConfig](#azuretablestorageapplicationlogsconfig): Application logs to Azure table storage configuration. -* **fileSystem**: [FileSystemApplicationLogsConfig](#filesystemapplicationlogsconfig): Application logs to file system configuration. +* **marketplaceOffer**: string: Premier add on Marketplace offer. +* **marketplacePublisher**: string: Premier add on Marketplace publisher. +* **product**: string: Premier add on Product. +* **sku**: string: Premier add on SKU. +* **vendor**: string: Premier add on Vendor. -## AzureBlobStorageApplicationLogsConfig +## PrivateAccessProperties ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **enabled**: bool: Whether private access is enabled or not. +* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. -## AzureTableStorageApplicationLogsConfig +## PrivateAccessSubnet ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. -* **sasUrl**: string (Required): SAS URL to an Azure table with add/query/delete permissions. +* **key**: int: The key (ID) of the subnet. +* **name**: string: The name of the subnet. -## FileSystemApplicationLogsConfig +## PrivateAccessVirtualNetwork ### Properties -* **level**: 'Error' | 'Information' | 'Off' | 'Verbose' | 'Warning': Log level. +* **key**: int: The key (ID) of the Virtual Network. +* **name**: string: The name of the Virtual Network. +* **resourceId**: string: The ARM uri of the Virtual Network +* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. -## EnabledConfig +## PrivateLinkConnectionApprovalRequest ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. +* **ipAddresses**: string[] (ReadOnly): Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper) (ReadOnly): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) -## HttpLogsConfig +## PrivateLinkConnectionState ### Properties -* **azureBlobStorage**: [AzureBlobStorageHttpLogsConfig](#azureblobstoragehttplogsconfig): Http logs to azure blob storage configuration. -* **fileSystem**: [FileSystemHttpLogsConfig](#filesystemhttplogsconfig): Http logs to file system configuration. +* **actionsRequired**: string: ActionsRequired for a private link connection +* **description**: string: Description of a private link connection +* **status**: string: Status of a private link connection -## AzureBlobStorageHttpLogsConfig +## PublicCertificateProperties ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove blobs older than X days. -0 or lower means no retention. -* **sasUrl**: string: SAS url to a azure blob container with read/write/list/delete permissions. +* **blob**: any: Public Certificate byte array +* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location +* **thumbprint**: string (ReadOnly): Certificate Thumbprint -## FileSystemHttpLogsConfig +## PushSettings ### Properties -* **enabled**: bool: True if configuration is enabled, false if it is disabled and null if configuration is not set. -* **retentionInDays**: int: Retention in days. -Remove files older than X days. -0 or lower means no retention. -* **retentionInMb**: int: 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. +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [PushSettingsProperties](#pushsettingsproperties): PushSettings resource specific properties +* **type**: string (ReadOnly): Resource type. -## StringDictionaryProperties +## PushSettingsProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **dynamicTagsJson**: string: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. +* **isPushEnabled**: bool (Required): Gets or sets a flag indicating whether the Push endpoint is enabled. +* **tagsRequiringAuth**: 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. +* **tagWhitelistJson**: string: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. -## SlotConfigNames +## QueueScaleRule ### Properties -* **appSettingNames**: string[]: List of application settings names. -* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. -* **connectionStringNames**: string[]: List of connection string names. +* **auth**: [ScaleRuleAuth](#scaleruleauth)[]: Authentication secrets for the queue scale rule. +* **queueLength**: int: Queue length. +* **queueName**: string: Queue name. -## DeploymentProperties +## RampUpRule ### Properties -* **active**: bool: True if deployment is currently active, false if completed and null if not started. -* **author**: string: Who authored the deployment. -* **author_email**: string: Author email. -* **deployer**: string: Who performed the deployment. -* **details**: string: Details on deployment. -* **end_time**: string: End time. -* **message**: string: Details about deployment status. -* **start_time**: string: Start time. -* **status**: int: Deployment status. +* **actionHostName**: string: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. +* **changeDecisionCallbackUrl**: 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/ +* **changeIntervalInMinutes**: int: Specifies interval in minutes to reevaluate ReroutePercentage. +* **changeStep**: int: 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. +* **maxReroutePercentage**: int: Specifies upper boundary below which ReroutePercentage will stay. +* **minReroutePercentage**: int: Specifies lower boundary above which ReroutePercentage will stay. +* **name**: string: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. +* **reroutePercentage**: int: Percentage of the traffic which will be redirected to ActionHostName. -## IdentifierProperties +## RegistryCredentials ### Properties -* **id**: string: String representation of the identity. +* **passwordSecretRef**: string: The name of the Secret that contains the registry login password +* **server**: string: Container Registry Server +* **username**: string: Container Registry Username -## MSDeployCore +## RelayServiceConnectionEntityProperties ### Properties -* **appOffline**: bool (WriteOnly): Sets the AppOffline rule while the MSDeploy operation executes. -Setting is false by default. -* **complete**: bool (ReadOnly): Whether the deployment operation has completed -* **connectionString**: string (WriteOnly): SQL Connection String -* **dbType**: string (WriteOnly): Database Type -* **deployer**: string (ReadOnly): Username of deployer -* **endTime**: string (ReadOnly): End time of deploy operation -* **packageUri**: string (WriteOnly): Package URI -* **provisioningState**: 'accepted' | 'canceled' | 'failed' | 'running' | 'succeeded' (ReadOnly): Provisioning state -* **setParameters**: [MSDeployCoreSetParameters](#msdeploycoresetparameters) (WriteOnly): MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. -* **setParametersXmlFileUri**: string (WriteOnly): URI of MSDeploy Parameters file. Must not be set if SetParameters is used. -* **skipAppData**: bool (WriteOnly): 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. -* **startTime**: string (ReadOnly): Start time of deploy operation +* **biztalkUri**: string +* **entityConnectionString**: string +* **entityName**: string +* **hostname**: string +* **port**: int +* **resourceConnectionString**: string +* **resourceType**: string -## MSDeployCoreSetParameters +## RemotePrivateEndpointConnection +### Properties +* **id**: string (ReadOnly): Resource Id. +* **kind**: string: Kind of resource. +* **name**: string (ReadOnly): Resource Name. +* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties +* **type**: string (ReadOnly): Resource type. + +## RemotePrivateEndpointConnectionProperties +### Properties +* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint +* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id +* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection +* **provisioningState**: string (ReadOnly) + +## RequestsBasedTrigger +### Properties +* **count**: int: Request Count. +* **timeInterval**: string: Time interval. + +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## FunctionEnvelopeProperties +## ResourceTags ### Properties -* **config**: any: Any object -* **config_href**: string: Config URI. -* **files**: [FunctionEnvelopePropertiesFiles](#functionenvelopepropertiesfiles): File list. -* **function_app_id**: string: Function App ID. -* **href**: string: Function URI. -* **invoke_url_template**: string: The invocation URL -* **isDisabled**: bool: Gets or sets a value indicating whether the function is disabled -* **language**: string: The function language -* **script_href**: string: Script URI. -* **script_root_path_href**: string: Script root path URI. -* **secrets_file_href**: string: Secrets file URI. -* **test_data**: string: Test data used when testing via the Azure Portal. -* **test_data_href**: string: Test data URI. +### Additional Properties +* **Additional Properties Type**: string -## FunctionEnvelopePropertiesFiles +## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostNameBindingProperties +## ResourceTags ### Properties -* **azureResourceName**: string: Azure resource name. -* **azureResourceType**: 'TrafficManager' | 'Website': Azure resource type. -* **customHostNameDnsRecordType**: 'A' | 'CName': Custom DNS record type. -* **domainId**: string: Fully qualified ARM domain resource URI. -* **hostNameType**: 'Managed' | 'Verified': Hostname type. -* **siteName**: string: App Service app name. -* **sslState**: 'Disabled' | 'IpBasedEnabled' | 'SniEnabled': SSL type -* **thumbprint**: string: SSL certificate thumbprint -* **virtualIP**: string (ReadOnly): Virtual IP address assigned to the hostname if IP based SSL is enabled. +### Additional Properties +* **Additional Properties Type**: string -## RelayServiceConnectionEntityProperties +## ResourceTags ### Properties -* **biztalkUri**: string -* **entityConnectionString**: string -* **entityName**: string -* **hostname**: string -* **port**: int -* **resourceConnectionString**: string -* **resourceType**: string +### Additional Properties +* **Additional Properties Type**: string -## HybridConnectionProperties +## ResourceTags ### Properties -* **hostname**: string: The hostname of the endpoint. -* **port**: int: The port of the endpoint. -* **relayArmUri**: string: The ARM URI to the Service Bus relay. -* **relayName**: string: The name of the Service Bus relay. -* **sendKeyName**: string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. -* **sendKeyValue**: 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. -* **serviceBusNamespace**: string: The name of the Service Bus namespace. -* **serviceBusSuffix**: string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net +### Additional Properties +* **Additional Properties Type**: string -## SwiftVirtualNetworkProperties +## ResourceTags ### Properties -* **subnetResourceId**: string: 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. -* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. +### Additional Properties +* **Additional Properties Type**: string -## PremierAddOnProperties +## ResourceTags ### Properties -* **marketplaceOffer**: string: Premier add on Marketplace offer. -* **marketplacePublisher**: string: Premier add on Marketplace publisher. -* **product**: string: Premier add on Product. -* **sku**: string: Premier add on SKU. -* **vendor**: string: Premier add on Vendor. +### Additional Properties +* **Additional Properties Type**: string ## ResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string -## PrivateAccessProperties +## ResourceTags ### Properties -* **enabled**: bool: Whether private access is enabled or not. -* **virtualNetworks**: [PrivateAccessVirtualNetwork](#privateaccessvirtualnetwork)[]: The Virtual Networks (and subnets) allowed to access the site privately. +### Additional Properties +* **Additional Properties Type**: string -## PrivateAccessVirtualNetwork +## ResponseMessageEnvelopeRemotePrivateEndpointConnection ### Properties -* **key**: int: The key (ID) of the Virtual Network. -* **name**: string: The name of the Virtual Network. -* **resourceId**: string: The ARM uri of the Virtual Network -* **subnets**: [PrivateAccessSubnet](#privateaccesssubnet)[]: 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. +* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. +* **id**: string: 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} +* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. +* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. +* **name**: string: Name of resource. +* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. +* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection +* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. +* **status**: string: Azure-AsyncOperation Status info. +* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. +* **type**: string: Type of resource e.g "Microsoft.Web/sites". +* **zones**: string[]: Logical Availability Zones the service is hosted in -## PrivateAccessSubnet +## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags ### Properties -* **key**: int: The key (ID) of the subnet. -* **name**: string: The name of the subnet. +### Additional Properties +* **Additional Properties Type**: string -## PublicCertificateProperties +## Scale ### Properties -* **blob**: any: Public Certificate byte array -* **publicCertificateLocation**: 'CurrentUserMy' | 'LocalMachineMy' | 'Unknown': Public Certificate Location -* **thumbprint**: string (ReadOnly): Certificate Thumbprint +* **maxReplicas**: int: Optional. Maximum number of container replicas. Defaults to 10 if not set. +* **minReplicas**: int: Optional. Minimum number of container replicas. +* **rules**: [ScaleRule](#scalerule)[]: Scaling rules. + +## ScaleRule +### Properties +* **azureQueue**: [QueueScaleRule](#queuescalerule): Container App container Azure Queue based scaling rule. +* **custom**: [CustomScaleRule](#customscalerule): Container App container Custom scaling rule. +* **http**: [HttpScaleRule](#httpscalerule): Container App container Custom scaling rule. +* **name**: string: Scale Rule Name + +## ScaleRuleAuth +### Properties +* **secretRef**: string: Name of the Container App secret from which to pull the auth params. +* **triggerParameter**: string: Trigger Parameter that uses the secret + +## Secret +### Properties +* **name**: string: Secret Name. +* **value**: string (WriteOnly): Secret Value. + +## SecretsCollection +### Properties +* **value**: [ContainerAppSecret](#containerappsecret)[] (ReadOnly): Collection of resources. + +## SiteAuthSettingsProperties +### Properties +* **aadClaimsAuthorization**: string: Gets a JSON string containing the Azure AD Acl settings. +* **additionalLoginParams**: 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". +* **allowedAudiences**: 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. +* **allowedExternalRedirectUrls**: 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. +* **authFilePath**: string: The path of the config file containing auth settings. +If the path is relative, base will the site's root directory. +* **clientId**: 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 +* **clientSecret**: 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 +* **clientSecretCertificateThumbprint**: 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. +* **clientSecretSettingName**: string: The app setting name that contains the client secret of the relying party application. +* **configVersion**: 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. +* **defaultProvider**: 'AzureActiveDirectory' | 'Facebook' | 'Github' | 'Google' | 'MicrosoftAccount' | 'Twitter': 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". +* **enabled**: bool: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. +* **facebookAppId**: 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 +* **facebookAppSecret**: 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 +* **facebookAppSecretSettingName**: string: The app setting name that contains the app secret used for Facebook Login. +* **facebookOAuthScopes**: 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 +* **gitHubClientId**: string: The Client Id of the GitHub app used for login. +This setting is required for enabling Github login +* **gitHubClientSecret**: string: The Client Secret of the GitHub app used for Github Login. +This setting is required for enabling Github login. +* **gitHubClientSecretSettingName**: string: The app setting name that contains the client secret of the Github +app used for GitHub Login. +* **gitHubOAuthScopes**: string[]: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. +This setting is optional +* **googleClientId**: 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/ +* **googleClientSecret**: 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/ +* **googleClientSecretSettingName**: string: The app setting name that contains the client secret associated with +the Google web application. +* **googleOAuthScopes**: 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/ +* **isAuthFromFile**: string: "true" if the auth config settings should be read from a file, +"false" otherwise +* **issuer**: 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 +* **microsoftAccountClientId**: 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 +* **microsoftAccountClientSecret**: 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 +* **microsoftAccountClientSecretSettingName**: string: The app setting name containing the OAuth 2.0 client secret that was created for the +app used for authentication. +* **microsoftAccountOAuthScopes**: 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 +* **runtimeVersion**: 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. +* **tokenRefreshExtensionHours**: int: 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. +* **tokenStoreEnabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **twitterConsumerKey**: 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 +* **twitterConsumerSecret**: 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 +* **twitterConsumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. +* **unauthenticatedClientAction**: 'AllowAnonymous' | 'RedirectToLoginPage': The action to take when an unauthenticated client attempts to access the app. +* **validateIssuer**: bool: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. + +## SiteAuthSettingsV2Properties +### Properties +* **globalValidation**: [GlobalValidation](#globalvalidation): The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. +* **httpSettings**: [HttpSettings](#httpsettings): The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. +* **identityProviders**: [IdentityProviders](#identityproviders): The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. +* **login**: [Login](#login): The configuration settings of the login flow of users using App Service Authentication/Authorization. +* **platform**: [AuthPlatform](#authplatform): The configuration settings of the platform of App Service Authentication/Authorization. + +## SiteConfig +### Properties +* **acrUseManagedIdentityCreds**: bool: Flag to use Managed Identity Creds for ACR pull +* **acrUserManagedIdentityID**: string: If using user managed identity, the user managed identity ClientId +* **alwaysOn**: bool: true if Always On is enabled; otherwise, false. +* **apiDefinition**: [ApiDefinitionInfo](#apidefinitioninfo): Information about the formal API definition for the app. +* **apiManagementConfig**: [ApiManagementConfig](#apimanagementconfig): Azure API management (APIM) configuration linked to the app. +* **appCommandLine**: string: App command line to launch. +* **appSettings**: [NameValuePair](#namevaluepair)[]: Application settings. +* **autoHealEnabled**: bool: true if Auto Heal is enabled; otherwise, false. +* **autoHealRules**: [AutoHealRules](#autohealrules): Rules that can be defined for auto-heal. +* **autoSwapSlotName**: string: Auto-swap slot name. +* **azureStorageAccounts**: [SiteConfigAzureStorageAccounts](#siteconfigazurestorageaccounts): List of Azure Storage Accounts. +* **connectionStrings**: [ConnStringInfo](#connstringinfo)[]: Connection strings. +* **cors**: [CorsSettings](#corssettings): Cross-Origin Resource Sharing (CORS) settings for the app. +* **defaultDocuments**: string[]: Default documents. +* **detailedErrorLoggingEnabled**: bool: true if detailed error logging is enabled; otherwise, false. +* **documentRoot**: string: Document root. +* **experiments**: [Experiments](#experiments): Routing rules in production experiments. +* **ftpsState**: 'AllAllowed' | 'Disabled' | 'FtpsOnly' | string: State of FTP / FTPS service +* **functionAppScaleLimit**: int: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans +* **functionsRuntimeScaleMonitoringEnabled**: bool: 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. +* **handlerMappings**: [HandlerMapping](#handlermapping)[]: Handler mappings. +* **healthCheckPath**: string: Health check path +* **http20Enabled**: bool: Http20Enabled: configures a web site to allow clients to connect over http2.0 +* **httpLoggingEnabled**: bool: true if HTTP logging is enabled; otherwise, false. +* **ipSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for main. +* **javaContainer**: string: Java container. +* **javaContainerVersion**: string: Java container version. +* **javaVersion**: string: Java version. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **limits**: [SiteLimits](#sitelimits): Metric limits set on an app. +* **linuxFxVersion**: string: Linux App Framework and version +* **loadBalancing**: 'LeastRequests' | 'LeastResponseTime' | 'PerSiteRoundRobin' | 'RequestHash' | 'WeightedRoundRobin' | 'WeightedTotalTraffic': Site load balancing. +* **localMySqlEnabled**: bool: true to enable local MySQL; otherwise, false. +* **logsDirectorySizeLimit**: int: HTTP logs directory size limit. +* **machineKey**: [SiteMachineKey](#sitemachinekey) (ReadOnly): MachineKey of an app. +* **managedPipelineMode**: 'Classic' | 'Integrated': Managed pipeline mode. +* **managedServiceIdentityId**: int: Managed Service Identity Id +* **minimumElasticInstanceCount**: int: Number of minimum instance count for a site +This setting only applies to the Elastic Plans +* **minTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **netFrameworkVersion**: string: .NET Framework version. +* **nodeVersion**: string: Version of Node.js. +* **numberOfWorkers**: int: Number of workers. +* **phpVersion**: string: Version of PHP. +* **powerShellVersion**: string: Version of PowerShell. +* **preWarmedInstanceCount**: int: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans +* **publicNetworkAccess**: string: Property to allow or block all public traffic. +* **publishingUsername**: string: Publishing user name. +* **push**: [PushSettings](#pushsettings): Push settings for the App. +* **pythonVersion**: string: Version of Python. +* **remoteDebuggingEnabled**: bool: true if remote debugging is enabled; otherwise, false. +* **remoteDebuggingVersion**: string: Remote debugging version. +* **requestTracingEnabled**: bool: true if request tracing is enabled; otherwise, false. +* **requestTracingExpirationTime**: string: Request tracing expiration time. +* **scmIpSecurityRestrictions**: [IpSecurityRestriction](#ipsecurityrestriction)[]: IP security restrictions for scm. +* **scmIpSecurityRestrictionsUseMain**: bool: IP security restrictions for scm to use main. +* **scmMinTlsVersion**: '1.0' | '1.1' | '1.2' | string: MinTlsVersion: configures the minimum version of TLS required for SSL requests +* **scmType**: 'BitbucketGit' | 'BitbucketHg' | 'CodePlexGit' | 'CodePlexHg' | 'Dropbox' | 'ExternalGit' | 'ExternalHg' | 'GitHub' | 'LocalGit' | 'None' | 'OneDrive' | 'Tfs' | 'VSO' | 'VSTSRM' | string: SCM type. +* **tracingOptions**: string: Tracing options. +* **use32BitWorkerProcess**: bool: true to use 32-bit worker process; otherwise, false. +* **virtualApplications**: [VirtualApplication](#virtualapplication)[]: Virtual applications. +* **vnetName**: string: Virtual Network name. +* **vnetPrivatePortsCount**: int: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +* **vnetRouteAllEnabled**: bool: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. +* **websiteTimeZone**: 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 +* **webSocketsEnabled**: bool: true if WebSocket is enabled; otherwise, false. +* **windowsFxVersion**: string: Xenon App Framework and version +* **xManagedServiceIdentityId**: int: Explicit Managed Service Identity Id + +## SiteConfigAzureStorageAccounts +### Properties +### Additional Properties +* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) ## SiteExtensionInfoProperties ### Properties @@ -2421,38 +2412,80 @@ normally, use the POST /listKeys API instead. * **provisioningState**: string (ReadOnly): Provisioning state. * **published_date_time**: string (ReadOnly): Published timestamp. * **summary**: string (ReadOnly): Summary description. -* **title**: string (ReadOnly) -* **version**: string (ReadOnly): Version information. - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string +* **title**: string (ReadOnly) +* **version**: string (ReadOnly): Version information. -## AzureStoragePropertyDictionaryResourceProperties +## SiteLimits ### Properties -### Additional Properties -* **Additional Properties Type**: [AzureStorageInfoValue](#azurestorageinfovalue) +* **maxDiskSizeInMb**: int: Maximum allowed disk size usage in MB. +* **maxMemoryInMb**: int: Maximum allowed memory usage in MB. +* **maxPercentageCpu**: int: Maximum allowed CPU usage percentage. -## ConnectionStringDictionaryProperties +## SiteLogsConfigProperties ### Properties -### Additional Properties -* **Additional Properties Type**: [ConnStringValueTypePair](#connstringvaluetypepair) +* **applicationLogs**: [ApplicationLogsConfig](#applicationlogsconfig): Application logs configuration. +* **detailedErrorMessages**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **failedRequestsTracing**: [EnabledConfig](#enabledconfig): Enabled configuration. +* **httpLogs**: [HttpLogsConfig](#httplogsconfig): Http logs configuration. -## StringDictionaryProperties +## SiteMachineKey ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **decryption**: string: Algorithm used for decryption. +* **decryptionKey**: string: Decryption key. +* **validation**: string: MachineKey validation. +* **validationKey**: string: Validation key. -## ResourceTags +## SiteProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **availabilityState**: 'DisasterRecoveryMode' | 'Limited' | 'Normal' (ReadOnly): Management information availability state for the app. +* **clientAffinityEnabled**: bool: 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. +* **clientCertEnabled**: bool: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. +* **clientCertExclusionPaths**: string: client certificate authentication comma-separated exclusion paths +* **clientCertMode**: 'Optional' | 'OptionalInteractiveUser' | 'Required': 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. +* **cloningInfo**: [CloningInfo](#cloninginfo) (WriteOnly): Information needed for cloning operation. +* **containerSize**: int: Size of the function container. +* **customDomainVerificationId**: string: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. +* **dailyMemoryTimeQuota**: int: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +* **defaultHostName**: string (ReadOnly): Default hostname of the app. Read-only. +* **enabled**: bool: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). +* **enabledHostNames**: string[] (ReadOnly): Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. +* **hostingEnvironmentProfile**: [HostingEnvironmentProfile](#hostingenvironmentprofile): Specification for an App Service Environment to use for this resource. +* **hostNames**: string[] (ReadOnly): Hostnames associated with the app. +* **hostNamesDisabled**: bool: true to disable the public hostnames of the app; otherwise, false. + If true, the app is only accessible via API management process. +* **hostNameSslStates**: [HostNameSslState](#hostnamesslstate)[]: Hostname SSL states are used to manage the SSL bindings for app's hostnames. +* **httpsOnly**: bool: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests +* **hyperV**: bool: Hyper-V sandbox. +* **inProgressOperationId**: string (ReadOnly): Specifies an operation id if this site has a pending operation. +* **isDefaultContainer**: bool (ReadOnly): true if the app is a default container; otherwise, false. +* **isXenon**: bool: Obsolete: Hyper-V sandbox. +* **keyVaultReferenceIdentity**: string: Identity to use for Key Vault Reference authentication. +* **lastModifiedTimeUtc**: string (ReadOnly): Last time the app was modified, in UTC. Read-only. +* **maxNumberOfWorkers**: int (ReadOnly): Maximum number of workers. +This only applies to Functions container. +* **outboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. +* **possibleOutboundIpAddresses**: string (ReadOnly): List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. +* **redundancyMode**: 'ActiveActive' | 'Failover' | 'GeoRedundant' | 'Manual' | 'None': Site redundancy mode +* **repositorySiteName**: string (ReadOnly): Name of the repository site. +* **reserved**: bool: true if reserved; otherwise, false. +* **resourceGroup**: string (ReadOnly): Name of the resource group the app belongs to. Read-only. +* **scmSiteAlsoStopped**: bool: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. +* **serverFarmId**: string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". +* **siteConfig**: [SiteConfig](#siteconfig): Configuration of an App Service app. +* **slotSwapStatus**: [SlotSwapStatus](#slotswapstatus) (ReadOnly): The status of the last successful slot swap operation. +* **state**: string (ReadOnly): Current state of the app. +* **storageAccountRequired**: bool: Checks if Customer provided storage account is required +* **suspendedTill**: string (ReadOnly): App suspended till in case memory-time quota is exceeded. +* **targetSwapSlot**: string (ReadOnly): Specifies which deployment slot this app will swap into. Read-only. +* **trafficManagerHostNames**: string[] (ReadOnly): Azure Traffic Manager hostnames associated with the app. Read-only. +* **usageState**: 'Exceeded' | 'Normal' (ReadOnly): State indicating whether the app has exceeded its quota usage. Read-only. +* **virtualNetworkSubnetId**: 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} ## SiteSourceControlProperties ### Properties @@ -2464,43 +2497,43 @@ normally, use the POST /listKeys API instead. * **isMercurial**: bool: true for a Mercurial repository; false for a Git repository. * **repoUrl**: string: Repository or source control URL. -## GitHubActionConfiguration +## SkuCapacity ### Properties -* **codeConfiguration**: [GitHubActionCodeConfiguration](#githubactioncodeconfiguration): The GitHub action code configuration. -* **containerConfiguration**: [GitHubActionContainerConfiguration](#githubactioncontainerconfiguration): The GitHub action container configuration. -* **generateWorkflowFile**: bool: Workflow option to determine whether the workflow file should be generated and written to the repository. -* **isLinux**: bool: This will help determine the workflow configuration to select. +* **default**: int: Default number of workers for this App Service plan SKU. +* **elasticMaximum**: int: Maximum number of Elastic workers for this App Service plan SKU. +* **maximum**: int: Maximum number of workers for this App Service plan SKU. +* **minimum**: int: Minimum number of workers for this App Service plan SKU. +* **scaleType**: string: Available scale configurations for an App Service plan. -## GitHubActionCodeConfiguration +## SkuDescription ### Properties -* **runtimeStack**: string: Runtime stack is used to determine the workflow file content for code base apps. -* **runtimeVersion**: string: Runtime version is used to determine what build version to set in the workflow file. +* **capabilities**: [Capability](#capability)[]: Capabilities of the SKU, e.g., is traffic manager enabled? +* **capacity**: int: Current number of instances assigned to the resource. +* **family**: string: Family code of the resource SKU. +* **locations**: string[]: Locations of the SKU. +* **name**: string: Name of the resource SKU. +* **size**: string: Size specifier of the resource SKU. +* **skuCapacity**: [SkuCapacity](#skucapacity): Description of the App Service plan scale options. +* **tier**: string: Service tier of the resource SKU. -## GitHubActionContainerConfiguration +## SlotConfigNames ### Properties -* **imageName**: string: The image name for the build. -* **password**: string: The password used to upload the image to the container registry. -* **serverUrl**: string: The server URL for the container registry where the build will be hosted. -* **username**: string: The username used to upload the image to the container registry. +* **appSettingNames**: string[]: List of application settings names. +* **azureStorageConfigNames**: string[]: List of external Azure storage account identifiers. +* **connectionStringNames**: string[]: List of connection string names. -## VnetInfo +## SlotSwapStatus ### Properties -* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a -Point-To-Site VPN connection. -* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. -* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. -* **isSwift**: bool: Flag that is used to denote if this is VNET injection -* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. -* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. -* **vnetResourceId**: string: The Virtual Network's resource ID. +* **destinationSlotName**: string (ReadOnly): The destination slot of the last swap operation. +* **sourceSlotName**: string (ReadOnly): The source slot of the last swap operation. +* **timestampUtc**: string (ReadOnly): The time the last successful slot swap completed. -## VnetRoute +## SlowRequestsBasedTrigger ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties -* **type**: string (ReadOnly): Resource type. +* **count**: int: Request Count. +* **path**: string: Request Path. +* **timeInterval**: string: Time interval. +* **timeTaken**: string: Time taken. ## SourceControlProperties ### Properties @@ -2517,7 +2550,7 @@ Point-To-Site VPN connection. * **contentDistributionEndpoint**: string (ReadOnly): The content distribution endpoint for the static site. * **customDomains**: string[] (ReadOnly): The custom domains associated with this static site. * **defaultHostname**: string (ReadOnly): The default autogenerated hostname for the static site. -* **enterpriseGradeCdnStatus**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling': State indicating the status of the enterprise grade CDN serving traffic to the static web app. +* **enterpriseGradeCdnStatus**: 'Disabled' | 'Disabling' | 'Enabled' | 'Enabling' | string: State indicating the status of the enterprise grade CDN serving traffic to the static web app. * **keyVaultReferenceIdentity**: string (ReadOnly): Identity to use for Key Vault Reference authentication. * **privateEndpointConnections**: [ResponseMessageEnvelopeRemotePrivateEndpointConnection](#responsemessageenveloperemoteprivateendpointconnection)[] (ReadOnly): Private endpoint connections * **provider**: string: The provider that submitted the last deployment to the primary environment of the static site. @@ -2538,61 +2571,14 @@ Point-To-Site VPN connection. * **outputLocation**: string: The output path of the app after building. * **skipGithubActionWorkflowGeneration**: bool: Skip Github Action workflow generation. -## ResponseMessageEnvelopeRemotePrivateEndpointConnection -### Properties -* **error**: [ErrorEntity](#errorentity): Body of the error response returned from the API. -* **id**: string: 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} -* **identity**: [ManagedServiceIdentity](#managedserviceidentity): Managed service identity. -* **location**: string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. -* **name**: string: Name of resource. -* **plan**: [ArmPlan](#armplan): The plan object in Azure Resource Manager, represents a marketplace plan. -* **properties**: [RemotePrivateEndpointConnection](#remoteprivateendpointconnection): A remote private endpoint connection -* **sku**: [SkuDescription](#skudescription): Description of a SKU for a scalable resource. -* **status**: string: Azure-AsyncOperation Status info. -* **tags**: [ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags](#responsemessageenveloperemoteprivateendpointconnectiontags): Tags associated with resource. -* **type**: string: Type of resource e.g "Microsoft.Web/sites". -* **zones**: string[]: Logical Availability Zones the service is hosted in - -## ErrorEntity -### Properties -* **code**: string: Basic error code. -* **details**: [ErrorEntity](#errorentity)[]: Error Details. -* **extendedCode**: string: Type of error. -* **innerErrors**: [ErrorEntity](#errorentity)[]: Inner errors. -* **message**: string: Any details of the error. -* **messageTemplate**: string: Message template. -* **parameters**: string[]: Parameters for the template. -* **target**: string: The error target. - -## ArmPlan -### Properties -* **name**: string: The name. -* **product**: string: The product. -* **promotionCode**: string: The promotion code. -* **publisher**: string: The publisher. -* **version**: string: Version of product. - -## RemotePrivateEndpointConnection -### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [RemotePrivateEndpointConnectionProperties](#remoteprivateendpointconnectionproperties): RemotePrivateEndpointConnection resource specific properties -* **type**: string (ReadOnly): Resource type. - -## RemotePrivateEndpointConnectionProperties -### Properties -* **ipAddresses**: string[]: Private IPAddresses mapped to the remote private endpoint -* **privateEndpoint**: [ArmIdWrapper](#armidwrapper): A wrapper for an ARM resource id -* **privateLinkServiceConnectionState**: [PrivateLinkConnectionState](#privatelinkconnectionstate): The state of a private link connection -* **provisioningState**: string (ReadOnly) - -## ResponseMessageEnvelopeRemotePrivateEndpointConnectionTags +## StaticSiteCustomDomainRequestPropertiesARMResourceProperties ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. +* **domainName**: string (ReadOnly): The domain name for the static site custom domain. +* **errorMessage**: string (ReadOnly) +* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' | string (ReadOnly): The status of the custom domain +* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain +* **validationToken**: string (ReadOnly): The TXT record validation token ## StaticSiteTemplateOptions ### Properties @@ -2602,120 +2588,68 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **repositoryName**: string: Name of the newly generated repository. * **templateRepositoryUrl**: string: URL of the template repository. The newly generated repository will be based on this one. -## StaticSiteUserProvidedFunctionApp +## StaticSiteUserARMResource ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string: Kind of resource. +* **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties +* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserProvidedFunctionAppProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. -* **functionAppRegion**: string: The region of the function app registered with the static site -* **functionAppResourceId**: string: The resource id of the function app registered with the static site - -## ResourceTags -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StaticSiteUserProvidedFunctionAppARMResourceProperties -### Properties -* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. -* **functionAppRegion**: string: The region of the function app registered with the static site -* **functionAppResourceId**: string: The resource id of the function app registered with the static site - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StringDictionaryProperties -### Properties -### Additional Properties -* **Additional Properties Type**: string - -## StaticSiteCustomDomainRequestPropertiesARMResourceProperties +## StaticSiteUserARMResourceProperties ### Properties -* **createdOn**: string (ReadOnly): The date and time on which the custom domain was created for the static site. -* **domainName**: string (ReadOnly): The domain name for the static site custom domain. -* **errorMessage**: string (ReadOnly) -* **status**: 'Adding' | 'Deleting' | 'Failed' | 'Ready' | 'RetrievingValidationToken' | 'Validating' (ReadOnly): The status of the custom domain -* **validationMethod**: string (WriteOnly): Validation method for adding a custom domain -* **validationToken**: string (ReadOnly): The TXT record validation token +* **displayName**: string (ReadOnly): The display name for the static site user. +* **provider**: string (ReadOnly): The identity provider for the static site user. +* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format +* **userId**: string (ReadOnly): The user id for the static site user. -## BackupRequest +## StaticSiteUserCollection ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **nextLink**: string (ReadOnly): Link to next page of resources. +* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. -## BackupItem +## StaticSiteUserProvidedFunctionApp ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StaticSiteUserProvidedFunctionAppProperties](#staticsiteuserprovidedfunctionappproperties): StaticSiteUserProvidedFunctionApp resource specific properties * **type**: string (ReadOnly): Resource type. -## BackupItemProperties +## StaticSiteUserProvidedFunctionAppARMResourceProperties ### Properties -* **blobName**: string (ReadOnly): Name of the blob which contains data for this backup. -* **correlationId**: string (ReadOnly): Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. -* **created**: string (ReadOnly): Timestamp of the backup creation. -* **databases**: [DatabaseBackupSetting](#databasebackupsetting)[] (ReadOnly): List of databases included in the backup. -* **finishedTimeStamp**: string (ReadOnly): Timestamp when this backup finished. -* **id**: int (ReadOnly): Id of the backup. -* **lastRestoreTimeStamp**: string (ReadOnly): Timestamp of a last restore operation which used this backup. -* **log**: string (ReadOnly): Details regarding this backup. Might contain an error message. -* **name**: string (ReadOnly): Name of this backup. -* **scheduled**: bool (ReadOnly): True if this backup has been created due to a schedule being triggered. -* **sizeInBytes**: int (ReadOnly): Size of the backup in bytes. -* **status**: 'Created' | 'DeleteFailed' | 'DeleteInProgress' | 'Deleted' | 'Failed' | 'InProgress' | 'PartiallySucceeded' | 'Skipped' | 'Succeeded' | 'TimedOut' (ReadOnly): Backup status. -* **storageAccountUrl**: string (ReadOnly): SAS URL for the storage account container which contains this backup. -* **websiteSizeInBytes**: int (ReadOnly): Size of the original web app which has been backed up. +* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. +* **functionAppRegion**: string: The region of the function app registered with the static site +* **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StringDictionary +## StaticSiteUserProvidedFunctionAppProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +* **createdOn**: string (ReadOnly): The date and time on which the function app was registered with the static site. +* **functionAppRegion**: string: The region of the function app registered with the static site +* **functionAppResourceId**: string: The resource id of the function app registered with the static site -## StringDictionaryProperties +## StatusCodesBasedTrigger ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **count**: int: Request Count. +* **path**: string: Request Path +* **status**: int: HTTP status code. +* **subStatus**: int: Request Sub Status. +* **timeInterval**: string: Time interval. +* **win32Status**: int: Win32 error code. -## BackupRequest +## StatusCodesRangeBasedTrigger ### Properties -* **id**: string (ReadOnly, WriteOnly): Resource Id. -* **kind**: string (WriteOnly): Kind of resource. -* **name**: string (ReadOnly, WriteOnly): Resource Name. -* **properties**: [BackupRequestProperties](#backuprequestproperties) (WriteOnly): BackupRequest resource specific properties -* **type**: string (ReadOnly, WriteOnly): Resource type. +* **count**: int: Request Count. +* **path**: string +* **statusCodes**: string: HTTP status code. +* **timeInterval**: string: Time interval. -## BackupItem +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [BackupItemProperties](#backupitemproperties) (ReadOnly): BackupItem resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2742,22 +2676,12 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## BackupItemCollection -### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [BackupItem](#backupitem)[] (ReadOnly): Collection of resources. - -## StringList +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: string[] (ReadOnly): List of string resources. +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. ## StringDictionary @@ -2776,19 +2700,14 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKey +## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [HybridConnectionKeyProperties](#hybridconnectionkeyproperties) (ReadOnly): HybridConnectionKey resource specific properties +* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HybridConnectionKeyProperties -### Properties -* **sendKeyName**: string (ReadOnly): The name of the send key. -* **sendKeyValue**: string (ReadOnly): The value of the send key. - ## StringDictionary ### Properties * **id**: string (ReadOnly): Resource Id. @@ -2797,90 +2716,171 @@ For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/pr * **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. * **type**: string (ReadOnly): Resource type. -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## HostKeysFunctionKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## HostKeysSystemKeys +## StringDictionaryProperties ### Properties ### Additional Properties * **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties ### Properties -* **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. -* **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. -* **type**: string (ReadOnly): Resource type. +### Additional Properties +* **Additional Properties Type**: string -## HostKeys +## StringDictionaryProperties ### Properties -* **functionKeys**: [HostKeysFunctionKeys](#hostkeysfunctionkeys) (ReadOnly): Host level function keys. -* **masterKey**: string (ReadOnly): Secret key. -* **systemKeys**: [HostKeysSystemKeys](#hostkeyssystemkeys) (ReadOnly): System keys. +### Additional Properties +* **Additional Properties Type**: string -## SecretsCollection +## StringDictionaryProperties ### Properties -* **value**: [ContainerAppSecret](#containerappsecret)[] (ReadOnly): Collection of resources. +### Additional Properties +* **Additional Properties Type**: string -## ContainerAppSecret +## StringDictionaryProperties ### Properties -* **name**: string (ReadOnly): Secret Name. -* **value**: string (ReadOnly): Secret Value. +### Additional Properties +* **Additional Properties Type**: string -## StringDictionary +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringDictionaryProperties +### Properties +### Additional Properties +* **Additional Properties Type**: string + +## StringList ### Properties * **id**: string (ReadOnly): Resource Id. * **kind**: string (ReadOnly): Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StringDictionaryProperties](#stringdictionaryproperties) (ReadOnly): Settings. +* **properties**: string[] (ReadOnly): List of string resources. * **type**: string (ReadOnly): Resource type. -## FunctionSecrets +## SwiftVirtualNetworkProperties ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **subnetResourceId**: string: 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. +* **swiftSupported**: bool: A flag that specifies if the scale unit this Web App is on supports Swift integration. -## FunctionSecrets +## Template ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **containers**: [Container](#container)[]: List of container definitions for the Container App. +* **dapr**: [Dapr](#dapr): Container App Dapr configuration. +* **revisionSuffix**: string: User friendly suffix that is appended to the revision name +* **scale**: [Scale](#scale): Container App scaling configurations. -## FunctionSecrets +## TokenStore ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **azureBlobStorage**: [BlobStorageTokenStore](#blobstoragetokenstore): The configuration settings of the storage of the tokens if blob storage is used. +* **enabled**: bool: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. + The default is false. +* **fileSystem**: [FileSystemTokenStore](#filesystemtokenstore): The configuration settings of the storage of the tokens if a file system is used. +* **tokenRefreshExtensionHours**: int: 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. -## FunctionSecrets +## TrafficWeight ### Properties -* **key**: string (ReadOnly): Secret key. -* **trigger_url**: string (ReadOnly): Trigger URL. +* **latestRevision**: bool: Indicates that the traffic weight belongs to a latest stable revision +* **revisionName**: string: Name of a revision +* **weight**: int: Traffic weight assigned to a revision -## StaticSiteUserCollection +## Twitter ### Properties -* **nextLink**: string (ReadOnly): Link to next page of resources. -* **value**: [StaticSiteUserARMResource](#staticsiteuserarmresource)[] (ReadOnly): Collection of resources. +* **enabled**: bool: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. +* **registration**: [TwitterRegistration](#twitterregistration): The configuration settings of the app registration for the Twitter provider. -## StaticSiteUserARMResource +## TwitterRegistration +### Properties +* **consumerKey**: 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 +* **consumerSecretSettingName**: string: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. + +## UserAssignedIdentity +### Properties +* **clientId**: string (ReadOnly): Client Id of user assigned identity +* **principalId**: string (ReadOnly): Principal Id of user assigned identity + +## UserProperties +### Properties +* **publishingPassword**: string: Password used for publishing. +* **publishingPasswordHash**: string: Password hash used for publishing. +* **publishingPasswordHashSalt**: string: Password hash salt used for publishing. +* **publishingUserName**: string (Required): Username used for publishing. +* **scmUri**: string: Url of SCM site. + +## VirtualApplication +### Properties +* **physicalPath**: string: Physical path. +* **preloadEnabled**: bool: true if preloading is enabled; otherwise, false. +* **virtualDirectories**: [VirtualDirectory](#virtualdirectory)[]: Virtual directories for virtual application. +* **virtualPath**: string: Virtual path. + +## VirtualDirectory +### Properties +* **physicalPath**: string: Physical path. +* **virtualPath**: string: Path to virtual application. + +## VirtualNetworkProfile +### Properties +* **id**: string (Required): Resource id of the Virtual Network. +* **name**: string (ReadOnly): Name of the Virtual Network (read-only). +* **subnet**: string: Subnet within the Virtual Network. +* **type**: string (ReadOnly): Resource type of the Virtual Network (read-only). + +## VnetGatewayProperties +### Properties +* **vnetName**: string: The Virtual Network name. +* **vpnPackageUri**: string (Required, WriteOnly): The URI where the VPN package can be downloaded. + +## VnetInfo +### Properties +* **certBlob**: string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a +Point-To-Site VPN connection. +* **certThumbprint**: string (ReadOnly): The client certificate thumbprint. +* **dnsServers**: string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. +* **isSwift**: bool: Flag that is used to denote if this is VNET injection +* **resyncRequired**: bool (ReadOnly): true if a resync is required; otherwise, false. +* **routes**: [VnetRoute](#vnetroute)[] (ReadOnly): The routes that this Virtual Network connection uses. +* **vnetResourceId**: string: The Virtual Network's resource ID. + +## VnetRoute ### Properties * **id**: string (ReadOnly): Resource Id. -* **kind**: string (ReadOnly): Kind of resource. +* **kind**: string: Kind of resource. * **name**: string (ReadOnly): Resource Name. -* **properties**: [StaticSiteUserARMResourceProperties](#staticsiteuserarmresourceproperties) (ReadOnly): StaticSiteUserARMResource resource specific properties +* **properties**: [VnetRouteProperties](#vnetrouteproperties): VnetRoute resource specific properties * **type**: string (ReadOnly): Resource type. -## StaticSiteUserARMResourceProperties +## VnetRouteProperties ### Properties -* **displayName**: string (ReadOnly): The display name for the static site user. -* **provider**: string (ReadOnly): The identity provider for the static site user. -* **roles**: string (ReadOnly): The roles for the static site user, in free-form string format -* **userId**: string (ReadOnly): The user id for the static site user. +* **endAddress**: string (WriteOnly): The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. +* **routeType**: 'DEFAULT' | 'INHERITED' | 'STATIC' | string (WriteOnly): 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. +* **startAddress**: string (WriteOnly): The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. + +## WorkerPool +### Properties +* **computeMode**: 'Dedicated' | 'Dynamic' | 'Shared': Shared/dedicated workers. +* **instanceNames**: string[] (ReadOnly): Names of all instances in the worker pool (read only). +* **workerCount**: int: Number of instances in the worker pool. +* **workerSize**: string: VM size of the worker pool instances. +* **workerSizeId**: int: Worker size ID for referencing this worker pool. diff --git a/generated/webpubsub/log.out b/generated/webpubsub/log.out index c3ce5b386c..fca18a8adb 100644 --- a/generated/webpubsub/log.out +++ b/generated/webpubsub/log.out @@ -9,7 +9,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.signalrservice-2021-10-01"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -18,10 +18,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 15ms +info | autorest.bicep took 23ms info | Processing batch task - {"tag":"microsoft.signalrservice-2021-09-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -30,10 +30,10 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 5ms +info | autorest.bicep took 7ms info | Processing batch task - {"tag":"microsoft.signalrservice-2021-06-01-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future. @@ -42,7 +42,7 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms @@ -54,8 +54,8 @@ warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 4ms -info | Autorest completed in 13.13s. 8 files generated. +info | Autorest completed in 13.25s. 8 files generated. diff --git a/generated/webpubsub/microsoft.signalrservice/2021-04-01-preview/types.md b/generated/webpubsub/microsoft.signalrservice/2021-04-01-preview/types.md index a3a659761a..9335bdb943 100644 --- a/generated/webpubsub/microsoft.signalrservice/2021-04-01-preview/types.md +++ b/generated/webpubsub/microsoft.signalrservice/2021-04-01-preview/types.md @@ -39,48 +39,6 @@ * **ApiVersion**: 2021-04-01-preview * **Output**: [WebPubSubKeys](#webpubsubkeys) -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. -Only be used in response. -* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. -Only be used in response -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None -* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities - -## ManagedIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) - -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## WebPubSubProperties -### Properties -* **eventHandler**: [EventHandlerSettings](#eventhandlersettings): The settings for event handler in webpubsub service -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **features**: [WebPubSubFeature](#webpubsubfeature)[]: List of the featureFlags. - -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, its globally default value will be used -But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - ## EventHandlerSettings ### Properties * **items**: [EventHandlerSettingsItems](#eventhandlersettingsitems): Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate. @@ -105,35 +63,33 @@ There are 3 kind of patterns supported: 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. The single event name, for example, "event1", it matches "event1" -## UpstreamAuthSettings +## ManagedIdentity ### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. +* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. +Only be used in response. +* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. +Only be used in response +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None +* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities ## ManagedIdentitySettings ### Properties * **resource**: string: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. -## WebPubSubFeature +## ManagedIdentityUserAssignedIdentities ### Properties -* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | string (Required): FeatureFlags is the supported features of Azure SignalR service. - - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. - - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. - - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. -* **properties**: [WebPubSubFeatureProperties](#webpubsubfeatureproperties): Optional properties related to this feature. -* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## WebPubSubFeatureProperties +## NetworkACL ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -## WebPubSubNetworkACLs +## PrivateEndpoint ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **id**: string: Full qualified Id of the private endpoint ## PrivateEndpointACL ### Properties @@ -141,11 +97,6 @@ It also appears in the aud (audience) claim of the issued token. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **name**: string (Required): Name of the private endpoint connection -## NetworkACL -### Properties -* **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. - ## PrivateEndpointConnection ### Properties * **id**: string (ReadOnly): Fully qualified resource Id for the resource. @@ -160,24 +111,27 @@ It also appears in the aud (audience) claim of the issued token. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData +## ResourceSku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. ## SharedPrivateLinkResource ### Properties @@ -195,27 +149,40 @@ It also appears in the aud (audience) claim of the issued token. * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource -## WebPubSubTlsSettings +## SystemData ### Properties -* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -## ResourceSku +## TrackedResourceTags ### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. +### Additional Properties +* **Additional Properties Type**: string -## TrackedResourceTags +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. + +## UserAssignedIdentityProperty +### Properties +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity + +## WebPubSubFeature +### Properties +* **flag**: 'EnableConnectivityLogs' | 'EnableLiveTrace' | 'EnableMessagingLogs' | string (Required): FeatureFlags is the supported features of Azure SignalR service. + - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. + - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. + - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. +* **properties**: [WebPubSubFeatureProperties](#webpubsubfeatureproperties): Optional properties related to this feature. +* **value**: string (Required): Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. + +## WebPubSubFeatureProperties ### Properties ### Additional Properties * **Additional Properties Type**: string @@ -227,3 +194,36 @@ Allowed values: Standard_S1, Free_F1 * **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## WebPubSubNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## WebPubSubProperties +### Properties +* **eventHandler**: [EventHandlerSettings](#eventhandlersettings): The settings for event handler in webpubsub service +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **features**: [WebPubSubFeature](#webpubsubfeature)[]: List of the featureFlags. + +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, its globally default value will be used +But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + +## WebPubSubTlsSettings +### Properties +* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled + diff --git a/generated/webpubsub/microsoft.signalrservice/2021-06-01-preview/types.md b/generated/webpubsub/microsoft.signalrservice/2021-06-01-preview/types.md index 8b15da5e3c..586f5253ef 100644 --- a/generated/webpubsub/microsoft.signalrservice/2021-06-01-preview/types.md +++ b/generated/webpubsub/microsoft.signalrservice/2021-06-01-preview/types.md @@ -39,49 +39,6 @@ * **ApiVersion**: 2021-06-01-preview * **Output**: [WebPubSubKeys](#webpubsubkeys) -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. -Only be used in response. -* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. -Only be used in response -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None -* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities - -## ManagedIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) - -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## WebPubSubProperties -### Properties -* **diagnosticConfiguration**: [DiagnosticConfiguration](#diagnosticconfiguration): Diagnostic configuration of a Microsoft.SignalRService resource. Used together with Azure monitor DiagnosticSettings. -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **eventHandler**: [EventHandlerSettings](#eventhandlersettings): The settings for event handler in webpubsub service -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - ## DiagnosticConfiguration ### Properties * **enableConnectivityLogs**: string: Indicate whether or not enable Connectivity logs. @@ -119,32 +76,39 @@ There are 3 kind of patterns supported: 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. The single event name, for example, "event1", it matches "event1" -## UpstreamAuthSettings +## ManagedIdentity ### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. +* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. +Only be used in response. +* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. +Only be used in response +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None +* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities ## ManagedIdentitySettings ### Properties * **resource**: string: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token. -## WebPubSubNetworkACLs +## ManagedIdentityUserAssignedIdentities ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) -## PrivateEndpointACL +## NetworkACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **name**: string (Required): Name of the private endpoint connection -## NetworkACL +## PrivateEndpoint +### Properties +* **id**: string: Full qualified Id of the private endpoint + +## PrivateEndpointACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **name**: string (Required): Name of the private endpoint connection ## PrivateEndpointConnection ### Properties @@ -160,24 +124,27 @@ It also appears in the aud (audience) claim of the issued token. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData +## ResourceSku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. ## SharedPrivateLinkResource ### Properties @@ -195,31 +162,30 @@ It also appears in the aud (audience) claim of the issued token. * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource -## WebPubSubTlsSettings -### Properties -* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled - -## ResourceSku +## SystemData ### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. + +## UserAssignedIdentityProperty +### Properties +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity + ## WebPubSubKeys ### Properties * **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey @@ -227,3 +193,37 @@ Allowed values: Standard_S1, Free_F1 * **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## WebPubSubNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## WebPubSubProperties +### Properties +* **diagnosticConfiguration**: [DiagnosticConfiguration](#diagnosticconfiguration): Diagnostic configuration of a Microsoft.SignalRService resource. Used together with Azure monitor DiagnosticSettings. +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **eventHandler**: [EventHandlerSettings](#eventhandlersettings): The settings for event handler in webpubsub service +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + +## WebPubSubTlsSettings +### Properties +* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled + diff --git a/generated/webpubsub/microsoft.signalrservice/2021-09-01-preview/types.md b/generated/webpubsub/microsoft.signalrservice/2021-09-01-preview/types.md index 0aa330ec07..105e373621 100644 --- a/generated/webpubsub/microsoft.signalrservice/2021-09-01-preview/types.md +++ b/generated/webpubsub/microsoft.signalrservice/2021-09-01-preview/types.md @@ -39,49 +39,6 @@ * **ApiVersion**: 2021-09-01-preview * **Output**: [WebPubSubKeys](#webpubsubkeys) -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. -Only be used in response. -* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. -Only be used in response -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None -* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities - -## ManagedIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) - -## UserAssignedIdentityProperty -### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity - -## WebPubSubProperties -### Properties -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **eventHandler**: [EventHandlerSettings](#eventhandlersettings): The settings for event handler in webpubsub service -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **liveTraceConfiguration**: [LiveTraceConfiguration](#livetraceconfiguration): Live trace configuration of a Microsoft.SignalRService resource. -* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. - ## EventHandlerSettings ### Properties * **items**: [EventHandlerSettingsItems](#eventhandlersettingsitems): Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate. @@ -106,15 +63,14 @@ There are 3 kind of patterns supported: 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. The single event name, for example, "event1", it matches "event1" -## UpstreamAuthSettings -### Properties -* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. -* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. - -## ManagedIdentitySettings +## LiveTraceCategory ### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. +* **enabled**: string: Indicates whether or the log category is enabled. +Available values: true, false. +Case insensitive. +* **name**: string: Gets or sets the log category's name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. ## LiveTraceConfiguration ### Properties @@ -125,31 +81,39 @@ Otherwise, live trace client can't connect to the service, so that you are unabl Available values: true, false. Case insensitive. -## LiveTraceCategory +## ManagedIdentity ### Properties -* **enabled**: string: Indicates whether or the log category is enabled. -Available values: true, false. -Case insensitive. -* **name**: string: Gets or sets the log category's name. -Available values: ConnectivityLogs, MessagingLogs. -Case insensitive. +* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. +Only be used in response. +* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. +Only be used in response +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represent the identity type: systemAssigned, userAssigned, None +* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities -## WebPubSubNetworkACLs +## ManagedIdentitySettings ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. -## PrivateEndpointACL +## ManagedIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) + +## NetworkACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **name**: string (Required): Name of the private endpoint connection -## NetworkACL +## PrivateEndpoint +### Properties +* **id**: string: Full qualified Id of the private endpoint + +## PrivateEndpointACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **name**: string (Required): Name of the private endpoint connection ## PrivateEndpointConnection ### Properties @@ -165,24 +129,27 @@ Case insensitive. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData +## ResourceSku ### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. + +If present, following values are allowed: + Free: 1 + Standard: 1,2,5,10,20,50,100 +* **family**: string (ReadOnly): Not used. Retained for future use. +* **name**: string (Required): The name of the SKU. Required. + +Allowed values: Standard_S1, Free_F1 +* **size**: string (ReadOnly): Not used. Retained for future use. +* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. + +`Basic` is deprecated, use `Standard` instead. ## SharedPrivateLinkResource ### Properties @@ -200,31 +167,30 @@ Case insensitive. * **requestMessage**: string: The request message for requesting approval of the shared private link resource * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource -## WebPubSubTlsSettings -### Properties -* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled - -## ResourceSku +## SystemData ### Properties -* **capacity**: int: Optional, integer. The unit count of the resource. 1 by default. - -If present, following values are allowed: - Free: 1 - Standard: 1,2,5,10,20,50,100 -* **family**: string (ReadOnly): Not used. Retained for future use. -* **name**: string (Required): The name of the SKU. Required. - -Allowed values: Standard_S1, Free_F1 -* **size**: string (ReadOnly): Not used. Retained for future use. -* **tier**: 'Basic' | 'Free' | 'Premium' | 'Standard' | string: Optional tier of this particular SKU. 'Standard' or 'Free'. - -`Basic` is deprecated, use `Standard` instead. +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. ## TrackedResourceTags ### Properties ### Additional Properties * **Additional Properties Type**: string +## UpstreamAuthSettings +### Properties +* **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. +* **type**: 'ManagedIdentity' | 'None' | string: Gets or sets the type of auth. None or ManagedIdentity is supported now. + +## UserAssignedIdentityProperty +### Properties +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity + ## WebPubSubKeys ### Properties * **primaryConnectionString**: string (ReadOnly): Connection string constructed via the primaryKey @@ -232,3 +198,37 @@ Allowed values: Standard_S1, Free_F1 * **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## WebPubSubNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Default action when no other rule matches +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## WebPubSubProperties +### Properties +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **eventHandler**: [EventHandlerSettings](#eventhandlersettings): The settings for event handler in webpubsub service +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **liveTraceConfiguration**: [LiveTraceConfiguration](#livetraceconfiguration): Live trace configuration of a Microsoft.SignalRService resource. +* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + +## WebPubSubTlsSettings +### Properties +* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled + diff --git a/generated/webpubsub/microsoft.signalrservice/2021-10-01/types.md b/generated/webpubsub/microsoft.signalrservice/2021-10-01/types.md index 55253dca61..d7010b14f2 100644 --- a/generated/webpubsub/microsoft.signalrservice/2021-10-01/types.md +++ b/generated/webpubsub/microsoft.signalrservice/2021-10-01/types.md @@ -49,49 +49,26 @@ * **ApiVersion**: 2021-10-01 * **Output**: [WebPubSubKeys](#webpubsubkeys) -## ManagedIdentity -### Properties -* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. -Only be used in response. -* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. -Only be used in response -* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represents the identity type: systemAssigned, userAssigned, None -* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities - -## ManagedIdentityUserAssignedIdentities -### Properties -### Additional Properties -* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) - -## UserAssignedIdentityProperty +## EventHandler ### Properties -* **clientId**: string (ReadOnly): Get the client id for the user assigned identity -* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity +* **auth**: [UpstreamAuthSettings](#upstreamauthsettings): Upstream auth settings. If not set, no auth is used for upstream messages. +* **systemEvents**: string[]: Gets ot sets the list of system events. +* **urlTemplate**: string (Required): Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. +For example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters. +* **userEventPattern**: string: Gets or sets the matching pattern for event names. +There are 3 kind of patterns supported: + 1. "*", it to matches any event name + 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" + 3. The single event name, for example, "event1", it matches "event1" -## WebPubSubProperties +## LiveTraceCategory ### Properties -* **disableAadAuth**: bool: DisableLocalAuth -Enable or disable aad auth -When set as true, connection with AuthType=aad won't work. -* **disableLocalAuth**: bool: DisableLocalAuth -Enable or disable local auth with AccessKey -When set as true, connection with AccessKey=xxx won't work. -* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. -* **hostName**: string (ReadOnly): FQDN of the service instance. -* **hostNamePrefix**: string (ReadOnly): Deprecated. -* **liveTraceConfiguration**: [LiveTraceConfiguration](#livetraceconfiguration): Live trace configuration of a Microsoft.SignalRService resource. -* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource -* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". -When it's Enabled, network ACLs still apply. -When it's Disabled, public network access is always disabled no matter what you set in network ACLs. -* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. -* **resourceLogConfiguration**: [ResourceLogConfiguration](#resourcelogconfiguration): Resource log configuration of a Microsoft.SignalRService resource. -* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. -* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. -* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource -* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. +* **enabled**: string: Indicates whether or the live trace category is enabled. +Available values: true, false. +Case insensitive. +* **name**: string: Gets or sets the live trace category's name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. ## LiveTraceConfiguration ### Properties @@ -102,31 +79,39 @@ Otherwise, live trace client can't connect to the service, so that you are unabl Available values: true, false. Case insensitive. -## LiveTraceCategory +## ManagedIdentity ### Properties -* **enabled**: string: Indicates whether or the live trace category is enabled. -Available values: true, false. -Case insensitive. -* **name**: string: Gets or sets the live trace category's name. -Available values: ConnectivityLogs, MessagingLogs. -Case insensitive. +* **principalId**: string (ReadOnly): Get the principal id for the system assigned identity. +Only be used in response. +* **tenantId**: string (ReadOnly): Get the tenant id for the system assigned identity. +Only be used in response +* **type**: 'None' | 'SystemAssigned' | 'UserAssigned' | string: Represents the identity type: systemAssigned, userAssigned, None +* **userAssignedIdentities**: [ManagedIdentityUserAssignedIdentities](#managedidentityuserassignedidentities): Get or set the user assigned identities -## WebPubSubNetworkACLs +## ManagedIdentitySettings ### Properties -* **defaultAction**: 'Allow' | 'Deny' | string: Azure Networking ACL Action. -* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints -* **publicNetwork**: [NetworkACL](#networkacl): Network ACL +* **resource**: string: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. -## PrivateEndpointACL +## ManagedIdentityUserAssignedIdentities +### Properties +### Additional Properties +* **Additional Properties Type**: [UserAssignedIdentityProperty](#userassignedidentityproperty) + +## NetworkACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. -* **name**: string (Required): Name of the private endpoint connection -## NetworkACL +## PrivateEndpoint +### Properties +* **id**: string: Full qualified Id of the private endpoint + +## PrivateEndpointACL ### Properties * **allow**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. * **deny**: 'ClientConnection' | 'RESTAPI' | 'ServerConnection' | 'Trace' | string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. +* **name**: string (Required): Name of the private endpoint connection ## PrivateEndpointConnection ### Properties @@ -143,29 +128,12 @@ Case insensitive. * **privateLinkServiceConnectionState**: [PrivateLinkServiceConnectionState](#privatelinkserviceconnectionstate): Connection state of the private endpoint connection * **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -## PrivateEndpoint -### Properties -* **id**: string: Full qualified Id of the private endpoint - ## PrivateLinkServiceConnectionState ### Properties * **actionsRequired**: string: A message indicating if changes on the service provider require any updates on the consumer. * **description**: string: The reason for approval/rejection of the connection. * **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. -## SystemData -### Properties -* **createdAt**: string: The timestamp of resource creation (UTC). -* **createdBy**: string: The identity that created the resource. -* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. -* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) -* **lastModifiedBy**: string: The identity that last modified the resource. -* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. - -## ResourceLogConfiguration -### Properties -* **categories**: [ResourceLogCategory](#resourcelogcategory)[]: Gets or sets the list of category configurations. - ## ResourceLogCategory ### Properties * **enabled**: string: Indicates whether or the resource log category is enabled. @@ -175,25 +143,9 @@ Case insensitive. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. -## SharedPrivateLinkResource -### Properties -* **id**: string (ReadOnly): Fully qualified resource Id for the resource. -* **name**: string (ReadOnly): The name of the resource. -* **properties**: [SharedPrivateLinkResourceProperties](#sharedprivatelinkresourceproperties): Describes the properties of an existing Shared Private Link Resource -* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. -* **type**: string (ReadOnly): The type of the resource - e.g. "Microsoft.SignalRService/SignalR" - -## SharedPrivateLinkResourceProperties -### Properties -* **groupId**: string (Required): The group id from the provider of resource the shared private link resource is for -* **privateLinkResourceId**: string (Required): The resource id of the resource the shared private link resource is for -* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. -* **requestMessage**: string: The request message for requesting approval of the shared private link resource -* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource - -## WebPubSubTlsSettings +## ResourceLogConfiguration ### Properties -* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled +* **categories**: [ResourceLogCategory](#resourcelogcategory)[]: Gets or sets the list of category configurations. ## ResourceSku ### Properties @@ -211,37 +163,50 @@ Allowed values: Standard_S1, Free_F1 `Basic` is deprecated, use `Standard` instead. -## TrackedResourceTags +## SharedPrivateLinkResource ### Properties -### Additional Properties -* **Additional Properties Type**: string +* **id**: string (ReadOnly): Fully qualified resource Id for the resource. +* **name**: string (ReadOnly): The name of the resource. +* **properties**: [SharedPrivateLinkResourceProperties](#sharedprivatelinkresourceproperties): Describes the properties of an existing Shared Private Link Resource +* **systemData**: [SystemData](#systemdata) (ReadOnly): Metadata pertaining to creation and last modification of the resource. +* **type**: string (ReadOnly): The type of the resource - e.g. "Microsoft.SignalRService/SignalR" -## WebPubSubHubProperties +## SharedPrivateLinkResourceProperties ### Properties -* **anonymousConnectPolicy**: string: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". -* **eventHandlers**: [EventHandler](#eventhandler)[]: Event handler of a hub. +* **groupId**: string (Required): The group id from the provider of resource the shared private link resource is for +* **privateLinkResourceId**: string (Required): The resource id of the resource the shared private link resource is for +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **requestMessage**: string: The request message for requesting approval of the shared private link resource +* **status**: 'Approved' | 'Disconnected' | 'Pending' | 'Rejected' | 'Timeout' | string (ReadOnly): Status of the shared private link resource -## EventHandler +## SystemData ### Properties -* **auth**: [UpstreamAuthSettings](#upstreamauthsettings): Upstream auth settings. If not set, no auth is used for upstream messages. -* **systemEvents**: string[]: Gets ot sets the list of system events. -* **urlTemplate**: string (Required): Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. -For example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters. -* **userEventPattern**: string: Gets or sets the matching pattern for event names. -There are 3 kind of patterns supported: - 1. "*", it to matches any event name - 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" - 3. The single event name, for example, "event1", it matches "event1" +* **createdAt**: string: The timestamp of resource creation (UTC). +* **createdBy**: string: The identity that created the resource. +* **createdByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. +* **lastModifiedAt**: string: The timestamp of resource last modification (UTC) +* **lastModifiedBy**: string: The identity that last modified the resource. +* **lastModifiedByType**: 'Application' | 'Key' | 'ManagedIdentity' | 'User' | string: The type of identity that created the resource. + +## TrackedResourceTags +### Properties +### Additional Properties +* **Additional Properties Type**: string ## UpstreamAuthSettings ### Properties * **managedIdentity**: [ManagedIdentitySettings](#managedidentitysettings): Managed identity settings for upstream. * **type**: 'ManagedIdentity' | 'None' | string: Upstream auth type enum. -## ManagedIdentitySettings +## UserAssignedIdentityProperty ### Properties -* **resource**: string: The Resource indicating the App ID URI of the target resource. -It also appears in the aud (audience) claim of the issued token. +* **clientId**: string (ReadOnly): Get the client id for the user assigned identity +* **principalId**: string (ReadOnly): Get the principal id for the user assigned identity + +## WebPubSubHubProperties +### Properties +* **anonymousConnectPolicy**: string: The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". +* **eventHandlers**: [EventHandler](#eventhandler)[]: Event handler of a hub. ## WebPubSubKeys ### Properties @@ -250,3 +215,38 @@ It also appears in the aud (audience) claim of the issued token. * **secondaryConnectionString**: string (ReadOnly): Connection string constructed via the secondaryKey * **secondaryKey**: string (ReadOnly): The secondary access key. +## WebPubSubNetworkACLs +### Properties +* **defaultAction**: 'Allow' | 'Deny' | string: Azure Networking ACL Action. +* **privateEndpoints**: [PrivateEndpointACL](#privateendpointacl)[]: ACLs for requests from private endpoints +* **publicNetwork**: [NetworkACL](#networkacl): Network ACL + +## WebPubSubProperties +### Properties +* **disableAadAuth**: bool: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won't work. +* **disableLocalAuth**: bool: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won't work. +* **externalIP**: string (ReadOnly): The publicly accessible IP of the resource. +* **hostName**: string (ReadOnly): FQDN of the service instance. +* **hostNamePrefix**: string (ReadOnly): Deprecated. +* **liveTraceConfiguration**: [LiveTraceConfiguration](#livetraceconfiguration): Live trace configuration of a Microsoft.SignalRService resource. +* **networkACLs**: [WebPubSubNetworkACLs](#webpubsubnetworkacls): Network ACLs for the resource +* **privateEndpointConnections**: [PrivateEndpointConnection](#privateendpointconnection)[] (ReadOnly): Private endpoint connections to the resource. +* **provisioningState**: 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Moving' | 'Running' | 'Succeeded' | 'Unknown' | 'Updating' | string (ReadOnly): Provisioning state of the resource. +* **publicNetworkAccess**: string: Enable or disable public network access. Default to "Enabled". +When it's Enabled, network ACLs still apply. +When it's Disabled, public network access is always disabled no matter what you set in network ACLs. +* **publicPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for browser/client side usage. +* **resourceLogConfiguration**: [ResourceLogConfiguration](#resourcelogconfiguration): Resource log configuration of a Microsoft.SignalRService resource. +* **serverPort**: int (ReadOnly): The publicly accessible port of the resource which is designed for customer server side usage. +* **sharedPrivateLinkResources**: [SharedPrivateLinkResource](#sharedprivatelinkresource)[] (ReadOnly): The list of shared private link resources. +* **tls**: [WebPubSubTlsSettings](#webpubsubtlssettings): TLS settings for the resource +* **version**: string (ReadOnly): Version of the resource. Probably you need the same or higher version of client SDKs. + +## WebPubSubTlsSettings +### Properties +* **clientCertEnabled**: bool: Request client certificate during TLS handshake if enabled + diff --git a/generated/windowsesu/log.out b/generated/windowsesu/log.out index 978563562c..a274652e97 100644 --- a/generated/windowsesu/log.out +++ b/generated/windowsesu/log.out @@ -3,15 +3,15 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.windowsesu-2019-09-16-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'ErrorResponse' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/windowsesu/resource-manager/Microsoft.WindowsESU/preview/2019-09-16-preview/windowsesu.json:532:5 warning | PreCheck/SchemaMissingType | The schema 'ErrorDefinition' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/windowsesu/resource-manager/Microsoft.WindowsESU/preview/2019-09-16-preview/windowsesu.json:541:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms -info | Autorest completed in 4.54s. 2 files generated. +info | autorest.bicep took 8ms +info | Autorest completed in 4.7s. 2 files generated. diff --git a/generated/windowsiot/log.out b/generated/windowsiot/log.out index 2c36ba74e0..d95a55102e 100644 --- a/generated/windowsiot/log.out +++ b/generated/windowsiot/log.out @@ -3,10 +3,10 @@ AutoRest code generation utility [cli version: 3.6.1; node: v16.15.0] https://aka.ms/autorest info | Loading AutoRest core '/home/runner/work/bicep-types-az/bicep-types-az/src/generator/node_modules/@autorest/core/dist' (3.8.4) info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.windowsiot-2019-06-01"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json:465:5 @@ -19,10 +19,10 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json:586:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 9ms +info | autorest.bicep took 8ms info | Processing batch task - {"tag":"microsoft.windowsiot-2018-02-16-preview"} . info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'Resource' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json:454:5 @@ -35,5 +35,5 @@ warning | PreCheck/SchemaMissingType | The schema 'OperationListResult' with an warning | PreCheck/SchemaMissingType | The schema 'ErrorDetails' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json:567:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. -info | autorest.bicep took 3ms -info | Autorest completed in 5.95s. 4 files generated. +info | autorest.bicep took 2ms +info | Autorest completed in 6.04s. 4 files generated. diff --git a/generated/workloadmonitor/log.out b/generated/workloadmonitor/log.out index e38f9d4da0..2b9bb1dfc3 100644 --- a/generated/workloadmonitor/log.out +++ b/generated/workloadmonitor/log.out @@ -6,13 +6,13 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) info | Processing batch task - {"tag":"microsoft.workloadmonitor-2018-08-31-preview"} . warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 8ms @@ -21,10 +21,10 @@ warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future. info | Loading local AutoRest extension '@autorest/bicep' (/home/runner/work/bicep-types-az/bicep-types-az/src/autorest.bicep) -info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.5) +info | Loading AutoRest extension '@autorest/modelerfour' (*->4.23.6) warning | SkippedSemanticValidation | Semantic validation was skipped. warning | PreCheck/SchemaMissingType | The schema 'HealthMonitor' with an undefined type and declared properties is a bit ambiguous. This has been auto-corrected to 'type:object' - file:///home/runner/work/bicep-types-az/bicep-types-az/workflow-temp/azure-rest-api-specs/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2020-01-13-preview/Microsoft.WorkloadMonitor.json:444:5 warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail. info | autorest.bicep took 0ms -info | Autorest completed in 8.41s. 2 files generated. +info | Autorest completed in 8.75s. 2 files generated.